ofsc-utility-browser 1.0.19 → 1.0.21

package/dist/resources/index.d.ts

@@ -37,3 +37,4 @@ export declare function getworkSkillsOfResource(clientId: string, clientSecret:
     data: any;
 }>;
 export declare function getAllResourcesWorkSkills(clientId: string, clientSecret: string, instanceUrl: string, token?: string, filterByresourceType?: string): Promise<any[]>;
+export declare function AllDescendantsOfResource(clientId: string, clientSecret: string, instanceUrl: string, resourceId: string, initialToken?: string): Promise<any[]>;

package/dist/resources/index.js

@@ -48,7 +48,7 @@ export async function AllResources(clientId, clientSecret, instanceUrl, filterBy
         const res = await fetchWithRetry(url, clientId, clientSecret, instanceUrl, token);
         const { items, totalResults } = res.data;
         const totalFetched = items.length;
-        console.log(`Received ${totalFetched} items (Total: ${offset + totalFetched})`);
+        console.log(`Resources: Received ${totalFetched} items (Total: ${offset + totalFetched})`);
         if (offset + totalFetched >= totalResults) {
             return items;
         }
@@ -184,3 +184,54 @@ export async function getAllResourcesWorkSkills(clientId, clientSecret, instance
     }
     return csv;
 }
+export async function AllDescendantsOfResource(clientId, clientSecret, instanceUrl, resourceId, initialToken = "") {
+    /**
+     * The number of API calls made so far.
+     * Used to determine if we should wait 10 seconds to avoid server rate limits.
+     */
+    let apiCallCount = 0;
+    if (!resourceId) {
+        throw new Error("Resource ID is required");
+    }
+    /**
+     * The number of API calls after which we should wait 10 seconds.
+     */
+    const WAIT_AFTER_CALLS = 20;
+    /**
+     * The delay in milliseconds to wait after reaching the API call limit.
+     */
+    const DELAY_MS = 10000; // 10 seconds
+    /**
+     * Sleeps for the given amount of milliseconds.
+     *
+     * @param {number} ms - The amount of milliseconds to sleep.
+     * @returns {Promise<void>} A promise which resolves when the sleep is over.
+     */
+    const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+    /**
+     * Fetches resources from the OFSC instance.
+     *
+     * @param {number} offset - The offset from which to fetch resources.
+     * @param {string} token - The OAuth token to use.
+     * @returns {Promise<ResourceResponse[]>} A promise which resolves to an array of resource responses.
+     */
+    const fetchResourcesDescendants = async (offset, token) => {
+        apiCallCount++;
+        // Wait 10 seconds after 20 API calls to avoid server rate limits.
+        if (apiCallCount % WAIT_AFTER_CALLS === 0) {
+            console.warn(` Waiting 10 seconds after ${apiCallCount} API calls to avoid server rate limits.`);
+            await sleep(DELAY_MS);
+        }
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/${resourceId}/descendants?offset=${offset}&limit=100`;
+        const res = await fetchWithRetry(url, clientId, clientSecret, instanceUrl, token);
+        const { items, totalResults } = res.data;
+        const totalFetched = items.length;
+        console.log(`Resources: Received ${totalFetched} items (Total: ${offset + totalFetched})`);
+        if (offset + totalFetched >= totalResults) {
+            return items;
+        }
+        const nextItems = await fetchResourcesDescendants(offset + totalFetched, res.token);
+        return [...items, ...nextItems];
+    };
+    return fetchResourcesDescendants(0, initialToken);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility-browser",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "A wrapper for Oracle Field Service REST API for browser cdn for html",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -33,6 +33,8 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
     - AllResources(clientId: string,clientSecret: string,instanceUrl: string,filterByresourceType="",initialToken = "")
     - AllUsers(clientId: string,clientSecret: string,instanceUrl: string,initialToken = "")
     - getAllResourcesWorkSkills(clientId: string,clientSecret: string,instanceUrl: string,initialToken = "")
+    - resourcePositionHistoryRange( clientID,clientSecret,instanceId,resourceId,fromDate,toDate); // GPS Locations of a technician
+    - AllDescendantsOfResource(clientId: string,clientSecret: string,instanceUrl: string,resourceId:string, initialToken = "")
 
 ### Post Clone
 
@@ -99,6 +101,18 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 </script>
 ```
 
+```js
+// Download all GPS Locations
+const res = await window.OFSC.GPS.resourcePositionHistoryRange(clientID,
+            clientSecret,
+            instanceId,
+            resourceId,
+            fromDate,
+            toDate);
+
+window.OFSC.Utilities.downloadCSV(res);
+```
+
 ```js
 // Download all Resources
 const res = await window.OFSC.Resources.AllResources(clientID, clientSecret, instanceId,"Technician", "");