ofsc-utility-browser 1.0.2 → 1.0.4

package/dist/resources/index.js

@@ -0,0 +1,132 @@
+import { fetchWithRetry, patchWithRetry } from "../utilities";
+/**
+ * Fetches all resources from the OFSC instance.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} [initialToken] - The OAuth token to use. If not provided, a new token will be fetched.
+ *
+ * @returns {Promise<any[]>} A promise which resolves to an array of resource objects.
+ */
+export async function AllResources(clientId, clientSecret, instanceUrl, 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;
+    /**
+     * 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 fetchResources = 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/?offset=${offset}&limit=100`;
+        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})`);
+        if (offset + totalFetched >= totalResults) {
+            return items;
+        }
+        const nextItems = await fetchResources(offset + totalFetched, res.token);
+        return [...items, ...nextItems];
+    };
+    return fetchResources(0, initialToken);
+}
+/**
+ * Updates a resource with the given payload.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} resourceId - The ID of the resource to update.
+ * @param {any} payload - The data to update the resource with.
+ * @param {string} [token] - The OAuth token to use. If not provided, a new token will be fetched.
+ * @returns {Promise<any>} A promise which resolves to the updated resource data.
+ */
+export async function updateResource(clientId, clientSecret, instanceUrl, resourceId, payload, token = "") {
+    return patchWithRetry(`https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/${resourceId}`, clientId, clientSecret, instanceUrl, token, payload);
+}
+/**
+ * Resets the email addresses of all resources to the given domain.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} [newdomain] - The new domain to update the resource emails to. Defaults to "noreply".
+ * @param {string} [token] - The OAuth token to use. If not provided, a new token will be fetched.
+ * @returns {Promise<any[]>} A promise which resolves to an array of objects containing the resource ID, original email, new email, and a comment.
+ */
+export async function resetResourcesEmail(clientId, clientSecret, instanceUrl, newdomain = "noreply.com", token = "") {
+    const resources = await AllResources(clientId, clientSecret, instanceUrl, token);
+    const resourcesWithEmails = resources.filter((resource) => resource.email);
+    const updatedResources = [];
+    const BATCH_SIZE = 200; // Update in batches of 200 to avoid server rate limits
+    const DELAY_MS = 10000; // Wait 10 seconds between batches
+    for (let i = 0; i < resourcesWithEmails.length; i += BATCH_SIZE) {
+        const batch = resourcesWithEmails.slice(i, i + BATCH_SIZE);
+        for (const resource of batch) {
+            console.log(`Total : ${resourcesWithEmails.length}`, `Total updated: ${updatedResources.length}`);
+            if (!resource.email)
+                continue;
+            if (!resource.resourceId) {
+                console.warn(`⚠️ Resource ID not found for ${JSON.stringify(resource)}`);
+                continue;
+            }
+            let email = resource.email;
+            if (!email.includes("@")) {
+                email = email.replace(newdomain, `@${newdomain}`);
+            }
+            if (email.includes(newdomain)) {
+                updatedResources.push({
+                    id: resource.resourceId,
+                    email: resource.email,
+                    newEmail: "",
+                    comment: "Email already updated"
+                });
+                continue;
+            }
+            email = resource.email.replace(/@.*/, `@${newdomain}`);
+            console.log(`Updating email for ${resource.resourceId} (${resource.email} -> ${email}) on ${instanceUrl}`);
+            const payload = {
+                email: email
+            };
+            const response = await updateResource(clientId, clientSecret, instanceUrl, resource.resourceId, payload, token);
+            token = response.token;
+            updatedResources.push({
+                id: response.data.resourceId,
+                email: resource.email,
+                newEmail: response.data.email
+            });
+        }
+        if (i + BATCH_SIZE < resourcesWithEmails.length) {
+            console.warn("⏳ Waiting 10 seconds before next batch...to avoid server rate limits.");
+            await new Promise(resolve => setTimeout(resolve, DELAY_MS));
+        }
+    }
+    return updatedResources;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/users/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Fetches all users from the OFSC instance.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} [initialToken] - The OAuth token to use. If not provided, a new token will be fetched.
+ *
+ * @returns {Promise<any[]>} A promise which resolves to an array of resource objects.
+ */
+export declare function AllUsers(clientId: string, clientSecret: string, instanceUrl: string, initialToken?: string): Promise<any[]>;

package/dist/users/index.js

@@ -0,0 +1,59 @@
+import { fetchWithRetry } from "../utilities";
+/**
+ * Fetches all users from the OFSC instance.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} [initialToken] - The OAuth token to use. If not provided, a new token will be fetched.
+ *
+ * @returns {Promise<any[]>} A promise which resolves to an array of resource objects.
+ */
+export async function AllUsers(clientId, clientSecret, instanceUrl, 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;
+    /**
+     * 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 fetchAllUsers = 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/users/?offset=${offset}&limit=100`;
+        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})`);
+        if (offset + totalFetched >= totalResults) {
+            return items;
+        }
+        const nextItems = await fetchAllUsers(offset + totalFetched, res.token);
+        return [...items, ...nextItems];
+    };
+    return fetchAllUsers(0, initialToken);
+}

package/dist/utilities/index.js

@@ -0,0 +1,148 @@
+import { DOMParser } from "xmldom";
+import { getOAuthToken } from "../oauthTokenService";
+/**
+ * Fetches a URL with retry logic for expired tokens.
+ *
+ * @param {string} url - The URL to fetch.
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} token - The current OAuth token.
+ *
+ * @returns {Promise<{ data: any; token: string }>} A promise which resolves to an object containing the parsed JSON data and the latest OAuth token.
+ */
+export const patchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, payload) => {
+    const doPost = async (bearer) => {
+        return fetch(url, {
+            method: "PATCH",
+            headers: {
+                Authorization: `Bearer ${bearer}`,
+                Accept: "application/json",
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify(payload)
+        });
+    };
+    let response = await doPost(token);
+    /* ---------- 401: refresh token ONCE per call ---------- */
+    if (response.status === 401) {
+        console.warn("⚠️ Token expired — renewing token…");
+        token = await getOAuthToken(clientId, clientSecret, instanceUrl);
+        response = await doPost(token);
+    }
+    if (!response.ok) {
+        throw new Error(`HTTP ${response.status}: ${await response.text()}`);
+    }
+    return {
+        data: await response.json(),
+        token
+    };
+};
+export const fetchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, retries = 5, baseDelay = 500) => {
+    const doFetch = async (bearer) => {
+        return fetch(url, {
+            method: "GET",
+            headers: {
+                Authorization: `Bearer ${bearer}`,
+                Accept: "application/json"
+            }
+        });
+    };
+    // Try with the current token
+    let res = await doFetch(token);
+    /* ---------- 401: refresh token ONCE per call ---------- */
+    if (res.status === 401) {
+        console.warn("⚠️ Token expired — renewing token…");
+        token = await getOAuthToken(clientId, clientSecret, instanceUrl);
+        res = await doFetch(token);
+    }
+    /* ---------- 429: retry with backoff ---------- */
+    if (res.status === 429 && retries > 0) {
+        const retryAfter = res.headers.get("Retry-After");
+        console.log("⚠️ 429 received. Retrying...", retryAfter);
+        const delay = retryAfter ? Number(retryAfter) * 1000 : baseDelay;
+        console.warn(`⚠️ 429 received. Retrying in ${delay}ms... (${retries} left)`);
+        await new Promise(r => setTimeout(r, delay));
+        return fetchWithRetry(url, clientId, clientSecret, instanceUrl, token, retries - 1, baseDelay * 2);
+    }
+    // If still not OK → fail
+    if (!res.ok) {
+        const body = await res.text();
+        throw new Error(`❌ Request failed: ${res.status} ${res.statusText}\n${body}`);
+    }
+    // Return parsed JSON + latest token
+    return {
+        data: await res.json(),
+        token
+    };
+};
+export function stringCsv(rows) {
+    if (!rows || rows.length === 0) {
+        throw new Error("CSV creation failed: no rows provided.");
+    }
+    // Collect all unique headers from all rows
+    const headerSet = new Set();
+    rows.forEach(row => {
+        Object.keys(row).forEach(key => headerSet.add(key));
+    });
+    const headers = Array.from(headerSet);
+    // Build CSV content
+    const csvLines = [
+        headers.join(","), // header row
+        ...rows.map(row => headers.map(h => escapeCsvValue(row[h])).join(","))
+    ];
+    return csvLines.join("\n");
+}
+// Simple CSV escaping
+function escapeCsvValue(value) {
+    if (value == null)
+        return "";
+    const str = String(value);
+    // Escape quotes
+    if (str.includes('"') || str.includes(',') || str.includes('\n')) {
+        return `"${str.replace(/"/g, '""')}"`;
+    }
+    return str;
+}
+export function xmlNodeToObjects(xmlString, parentNodeName) {
+    const parser = new DOMParser();
+    const xml = parser.parseFromString(xmlString, "application/xml");
+    const nodes = Array.from(xml.getElementsByTagName(parentNodeName));
+    if (nodes.length === 0) {
+        throw new Error(`No <${parentNodeName}> nodes found`);
+    }
+    return nodes.map(node => {
+        var _a, _b;
+        const obj = {};
+        const fields = Array.from(node.getElementsByTagName("Field"));
+        for (const field of fields) {
+            const key = field.getAttribute("name");
+            if (!key)
+                continue;
+            obj[key] = (_b = (_a = field.textContent) === null || _a === void 0 ? void 0 : _a.trim()) !== null && _b !== void 0 ? _b : "";
+        }
+        return obj;
+    });
+}
+/**
+ * Download an array of objects as a CSV file
+ * @param csvData Array of objects representing CSV rows
+ */
+export const downloadCSV = (csvData) => {
+    if (!csvData.length) {
+        showStatus('No data to download', 'error');
+        return;
+    }
+    const csvContent = stringCsv(csvData);
+    // Create Blob and download link
+    const blob = new Blob([csvContent], { type: 'text/csv;charset=utf-8;' });
+    const link = document.createElement('a');
+    link.href = URL.createObjectURL(blob);
+    link.download = `data_${Date.now()}.csv`;
+    link.click();
+    // Clean up object URL after download
+    setTimeout(() => URL.revokeObjectURL(link.href), 100);
+};
+function showStatus(message, type) {
+    console.log(`[${type.toUpperCase()}] ${message}`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility-browser",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "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

@@ -29,6 +29,7 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
     - getActivitybyId( clientId: string, clientSecret: string,instanceUrl: string, activityId: number, token: string=")
     - updateResource(clientId: string, clientSecret: string, instanceUrl: string, resourceId: string, payload: any, token: string = "")
     - AllResources(clientId: string,clientSecret: string,instanceUrl: string,initialToken = "")
+    - AllUsers(clientId: string,clientSecret: string,instanceUrl: string,initialToken = "")
   
   ### Post Clone
      - resetResourcesEmail(clientId: string,clientSecret: string,instanceUrl: string,newdomain: string = "noreply",token: string = "")
@@ -94,6 +95,18 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 </script>
 ```
 
+```js
+// Download all Resources
+const res = await window.OFSC.Resources.AllResources(
+        clientID,
+        clientSecret,
+        instanceId,
+        ""
+      );
+      
+      window.OFSC.Utilities.downloadCSV(res);
+```
+
 ## License
 
 MIT