Added getAllUsers (#13)

Author: btoron

package-lock.json

@@ -5,20 +5,20 @@
     ],
     "name": "@ofs-users/proxy",
     "type": "module",
-    "version": "1.6.0",
+    "version": "1.7.2",
     "description": "A Javascript proxy to access Oracle Field Service via REST API",
     "main": "dist/ofs.es.js",
     "module": "dist/ofs.es.js",
     "types": "dist/OFS.d.ts",
     "repository": {
-        "url": "https://github.com/oracle-samples/ofs-proxy-js"
+        "url": "git+https://github.com/oracle-samples/ofs-proxy-js.git"
     },
     "scripts": {
         "build": "tsc",
         "start": "ts-node src/index.ts",
         "test": "jest",
         "dist": "rollup --config rollup.config.mjs",
-        "prepare": "npm run dist"
+        "prepare": "rollup --config rollup.config.mjs"
     },
     "keywords": [
         "ofsc",
@@ -66,4 +66,4 @@
     "dependencies": {
         "tslib": "^2.4.1"
     }
-}
+}

package.json

@@ -287,6 +287,38 @@ export class OFS {
         return this._get(partialURL, { offset: offset, limit: limit });
     }
 
+    /**
+     * Retrieves all users from the OFS API.
+     * @returns An object containing all users.
+     */
+    async getAllUsers() {
+        const partialURL = "/rest/ofscCore/v1/users";
+        // 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 = { totalResults: 0, items: [] };
+        do {
+            result = await this._get(partialURL, {
+                offset: offset,
+                limit: limit,
+            });
+            if (result.status < 400) {
+                if (allResults.totalResults == 0) {
+                    allResults = result.data;
+                } else {
+                    allResults.items = allResults.items.concat(
+                        result.data.items
+                    );
+                }
+                offset += limit;
+            } else {
+                return result;
+            }
+        } while (result.data.items.length == limit);
+        return allResults;
+    }
+
     async getUserDetails(uname: string): Promise<OFSResponse> {
         const partialURL = `/rest/ofscCore/v1/users/${uname}`;
         return this._get(partialURL);

src/OFS.ts

@@ -140,3 +140,10 @@ test("Get User Details", async () => {
     expect(result.data.login).toBe("admin");
     console.log(result.data);
 });
+
+test("Get all Users", async () => {
+    var result = await myProxy.getAllUsers();
+    expect(result.totalResults).toBeGreaterThan(200);
+    expect(result.items.length).toEqual(result.totalResults);
+    expect(result.items[0].login).toBe("admin");
+});