32 getallactivities method (#33)

Author: miquelgall

README.md

@@ -26,6 +26,8 @@ In order to use this library you need to have access to an Oracle Field Service
 
 `getActivities()`: Get existing activities
 
+`getAllActivities()`: Get ALL existing activities
+
 `createActivity(activityData)`: Create activity
 
 `deleteActivity(activityId)`: Delete activity

package-lock.json

@@ -5,7 +5,7 @@
     ],
     "name": "@ofs-users/proxy",
     "type": "module",
-    "version": "1.13.0",
+    "version": "1.14.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

@@ -580,7 +580,40 @@ export class OFS {
             limit: limit,
         });
     }
-
+    /**
+     * Retrieves all activities from the OFS API.
+     * @returns An object containing all activities.
+     */
+    async getAllActivities(params: OFSGetActivitiesParams) {
+        const partialURL = "/rest/ofscCore/v1/activities";
+        // Start with offset 0 and keep getting results until we get less than 100
+        var offset = 0;
+        var limit = 100;
+        var result: any = undefined;
+        var allResults: any = { status: 200, totalResults: 0, items: [] };
+        do {
+            result = await this._get(partialURL, {
+                ...params,
+                offset: offset,
+                limit: limit,
+            });
+            if (result.status < 400) {
+                if (allResults.totalResults == 0) {
+                    allResults = result.data;
+                    allResults.status = 200;
+                } else {
+                    allResults.items = allResults.items.concat(
+                        result.data.items
+                    );
+                    allResults.totalResults = allResults.items.length;
+                }
+                offset += limit;
+            } else {
+                return result;
+            }
+        } while (result.data.items.length == limit);
+        return allResults;
+    }
     // Metadata: Plugin Management
     async importPlugins(file?: PathLike, data?: string): Promise<OFSResponse> {
         const partialURL =

src/OFS.ts

@@ -334,3 +334,20 @@ test("Get Activities with all the parameters", async () => {
     expect(result.data.items.length).toBeGreaterThan(0);
     expect(result.data.items[0].activityId).toBeGreaterThan(0);
 });
+
+test("Get All Activities with all the parameters", async () => {
+    var result = await myProxy.getAllActivities({
+        resources: "FLUSA",
+        dateFrom: "2025-02-01",
+        dateTo: "2025-02-01",
+        includeChildren: "all",
+        includeNonScheduled: true,
+    });
+    if (result.status !== 200) {
+        console.log(result);
+    }
+    expect(result.status).toBe(200);
+    expect(result.totalResults).toBeGreaterThan(0);
+    expect(result.items.length).toBeGreaterThan(0);
+    expect(result.items[0].activityId).toBeGreaterThan(0);
+});