Merge pull request #31 from oracle-samples/feature_extensions

Feature extensions

Author: miquelgall

package-lock.json

@@ -5,7 +5,7 @@
     ],
     "name": "@ofs-users/proxy",
     "type": "module",
-    "version": "1.11.0",
+    "version": "1.13.0",
     "description": "A Javascript proxy to access Oracle Field Service via REST API",
     "main": "dist/ofs.es.js",
     "module": "dist/ofs.es.js",

package.json

@@ -14,6 +14,7 @@ import {
     OFSPropertyListResponse,
     OFSGetPropertiesParams,
     OFSTimeslotsResponse,
+    OFSGetActivitiesParams,
 } from "./model";
 
 export * from "./model";
@@ -49,8 +50,8 @@ export class OFS {
     public get instance(): string {
         return this.credentials.instance || "";
     }
-    public get baseURL(): string {
-        return this.credentials.baseURL || "";
+    public get baseURL(): URL {
+        return this._baseURL || "";
     }
     private static authenticateUser(credentials: OFSCredentials): string {
         if ("token" in credentials && credentials.token != "") {
@@ -347,11 +348,56 @@ export class OFS {
     }
 
     // Core: Subscription Management
-    async getSubscriptions(): Promise<OFSSubscriptionResponse> {
+    async getSubscriptions(
+        all: boolean = false
+    ): Promise<OFSSubscriptionResponse> {
         const partialURL = "/rest/ofscCore/v1/events/subscriptions";
+        return this._get(partialURL, { allSubscriptions: all });
+    }
+
+    async createSubscription(data: any): Promise<OFSResponse> {
+        const partialURL = "/rest/ofscCore/v1/events/subscriptions/";
+        return this._post(partialURL, data);
+    }
+
+    async deleteSubscription(sid: string): Promise<OFSResponse> {
+        const partialURL = `/rest/ofscCore/v1/events/subscriptions/${sid}`;
+        return this._delete(partialURL);
+    }
+
+    async getSubscriptionDetails(sid: string): Promise<OFSResponse> {
+        const partialURL = `/rest/ofscCore/v1/events/subscriptions/${sid}`;
         return this._get(partialURL);
     }
 
+    // Core: Event Management
+    async getEvents(
+        sid: string,
+        page: string = "lastRequested",
+        since = null,
+        limit: number = 1000
+    ): Promise<OFSResponse> {
+        var params: {
+            subscriptionId: string;
+            page?: string;
+            limit: number;
+            since?: string | null;
+        } = {
+            subscriptionId: sid,
+            page: page,
+            limit: limit,
+            since: since,
+        };
+        if (since == null) {
+            delete params.since;
+        } else {
+            delete params.page;
+        }
+
+        const partialURL = "/rest/ofscCore/v1/events";
+        return this._get(partialURL, params);
+    }
+
     // Core: Activity Management
     async createActivity(data: any): Promise<OFSResponse> {
         const partialURL = "/rest/ofscCore/v1/activities";
@@ -521,6 +567,20 @@ export class OFS {
         return this._get(partialURL);
     }
 
+    // Core: Activities Management
+    async getActivities(
+        params: OFSGetActivitiesParams,
+        offset: number = 0,
+        limit: number = 100
+    ): Promise<OFSResponse> {
+        const partialURL = "/rest/ofscCore/v1/activities";
+        return this._get(partialURL, {
+            ...params,
+            offset: offset,
+            limit: limit,
+        });
+    }
+
     // Metadata: Plugin Management
     async importPlugins(file?: PathLike, data?: string): Promise<OFSResponse> {
         const partialURL =

src/OFS.ts

@@ -163,3 +163,13 @@ export class OFSPropertyListResponse extends OFSResponse {
 export class OFSTimeslotsResponse extends OFSResponse {
     data: OFSTimeslotsList = new OFSTimeslotsList();
 }
+
+export interface OFSGetActivitiesParams {
+    resources: string;
+    dateFrom?: string;
+    dateTo?: string;
+    fields?: string;
+    includeChildren?: string;
+    includeNonScheduled?: boolean;
+    q?: string;
+}

src/model.ts

@@ -277,3 +277,60 @@ test("Get File Property (Full Binary)", async () => {
         throw error;
     }
 });
+
+test("Get Activities", async () => {
+    var result = await myProxy.getActivities(
+        {
+            resources: "SUNRISE",
+            dateFrom: "2025-02-01",
+            dateTo: "2025-03-02",
+        },
+        0,
+        100
+    );
+    if (result.status !== 200) {
+        console.log(result);
+    }
+    expect(result.status).toBe(200);
+    expect(result.data.items.length).toBeGreaterThan(0);
+    expect(result.data.items[0].activityId).toBeGreaterThan(0);
+});
+
+test("Get Activities with includeChildren", async () => {
+    var result = await myProxy.getActivities(
+        {
+            resources: "SUNRISE",
+            dateFrom: "2025-02-01",
+            dateTo: "2025-03-02",
+            includeChildren: "all",
+        },
+        0,
+        100
+    );
+    if (result.status !== 200) {
+        console.log(result);
+    }
+    expect(result.status).toBe(200);
+    expect(result.data.items.length).toBeGreaterThan(0);
+    expect(result.data.items[0].activityId).toBeGreaterThan(0);
+});
+
+test("Get Activities with all the parameters", async () => {
+    var result = await myProxy.getActivities(
+        {
+            resources: "SUNRISE",
+            dateFrom: "2025-02-01",
+            dateTo: "2025-03-02",
+            includeChildren: "all",
+            includeNonScheduled: true,
+        },
+        0,
+        100
+    );
+    if (result.status !== 200) {
+        console.log(result);
+    }
+    expect(result.status).toBe(200);
+    expect(result.data.items.length).toBeGreaterThan(0);
+    expect(result.data.items[0].activityId).toBeGreaterThan(0);
+});