ofsc-utility 1.0.40 → 1.0.43

package/dist/oauthTokenService/index.d.ts

@@ -1 +1,13 @@
-export declare function getOAuthToken(clientId: string, clientSecret: string, instanceUrl: string): Promise<any>;
+interface OAuthTokenOptions {
+    /** Max retry attempts for transient (5xx) failures. Default: 2 */
+    maxRetries?: number;
+    /** Base delay in ms between retries (exponential backoff). Default: 1000 */
+    retryDelayMs?: number;
+    /** Request timeout in ms. Default: 10000 */
+    timeoutMs?: number;
+}
+/**
+ * Fetches an OAuth access token from OFSC.
+ */
+export declare function getOAuthToken(clientId: string, clientSecret: string, instanceUrl: string, options?: OAuthTokenOptions): Promise<string>;
+export {};

package/dist/oauthTokenService/index.js

@@ -1,30 +1,63 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOAuthToken = getOAuthToken;
-async function getOAuthToken(clientId, clientSecret, instanceUrl) {
+/**
+ * Fetches an OAuth access token from OFSC.
+ */
+async function getOAuthToken(clientId, clientSecret, instanceUrl, options = {}) {
+    const { maxRetries = 3, retryDelayMs = 1000, timeoutMs = 10000 } = options;
     const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/oauthTokenService/v2/token`;
     const credentials = btoa(`${clientId}@${instanceUrl}:${clientSecret}`);
     const headers = {
         'Content-Type': 'application/x-www-form-urlencoded',
-        'Authorization': `Basic ${credentials}`
+        'Authorization': `Basic ${credentials}`,
     };
-    const body = new URLSearchParams({
-        'grant_type': 'client_credentials'
-    });
-    try {
-        const response = await fetch(url, {
-            method: 'POST',
-            headers: headers,
-            body: body
-        });
-        if (!response.ok) {
-            throw new Error(`HTTP error! status: ${response.status}`);
+    const body = new URLSearchParams({ grant_type: 'client_credentials' });
+    let lastError;
+    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+        //AbortController is a built-in browser/Node API for cancelling async operations 
+        // controller.signal & controller.abort() are used to cancel the fetch request if it takes too long
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), timeoutMs);
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body,
+                signal: controller.signal,
+            });
+            clearTimeout(timeout);
+            if (response.ok) {
+                const data = (await response.json());
+                if (!data.access_token) {
+                    throw new Error('OAuth response did not contain an access_token');
+                }
+                return data.access_token;
+            }
+            // Retry only on server-side / transient errors
+            if (response.status >= 500 && response.status < 600 && attempt < maxRetries) {
+                lastError = new Error(`OAuth token request failed with status ${response.status}`);
+                await delay(retryDelayMs * 2 ** attempt);
+                continue;
+            }
+            // Non-retriable (4xx) or out of retries — fail fast
+            const bodyText = await response.text().catch(() => '');
+            throw new Error(`OAuth token request failed: ${response.status} ${response.statusText}${bodyText ? ` - ${bodyText}` : ''}`);
+        }
+        catch (error) {
+            clearTimeout(timeout);
+            lastError = error;
+            const isAbort = error instanceof Error && error.name === 'AbortError';
+            const isNetworkError = error instanceof TypeError;
+            if ((isAbort || isNetworkError) && attempt < maxRetries) {
+                await delay(retryDelayMs * 2 ** attempt);
+                continue;
+            }
+            throw new Error(`Failed to fetch OAuth token after ${attempt + 1} attempt(s): ${error instanceof Error ? error.message : String(error)}`);
         }
-        const data = await response.json();
-        return data.access_token;
-    }
-    catch (error) {
-        console.error('Error fetching OAuth token:', error);
-        throw error;
     }
+    throw lastError instanceof Error ? lastError : new Error('Failed to fetch OAuth token');
+}
+function delay(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
 }

package/dist/utilities/index.js

@@ -78,7 +78,7 @@ const fetchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, r
         res = await doFetch(token);
     }
     /* ---------- 429: retry with backoff ---------- */
-    if ((res.status === 429 || res.status === 400) && retries > 0) {
+    if ((res.status === 429 || res.status === 502 || res.status === 503 || res.status === 504) && retries > 0) {
         const retryAfter = res.headers.get("Retry-After");
         console.log("⚠️ 429 received. Retrying...", retryAfter);
         const delay = retryAfter ? Number(retryAfter) * 1000 : baseDelay;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility",
-  "version": "1.0.40",
+  "version": "1.0.43",
   "description": "TypeScript helpers for Oracle Field Service Cloud (OFSC): events, resources, inventories, metadata and CSV/Excel utilities.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -9,10 +9,29 @@ This package exposes grouped API helpers for common OFSC operations, including:
 - inventory and activity records
 - metadata file generation
 
+### Built-in resilience for OFSC's server errors
+
+OFSC's REST API sits behind Oracle's gateway infrastructure, which means calls can occasionally fail with transient errors that have nothing to do with your request — the gateway losing its connection to the backend, a brief service restart, or normal rate limiting under load. This package handles those cases automatically so your integration doesn't fail on a blip that would have succeeded a second later.
+
+### Exponential backoff
+
+Retries don't hammer the API at a fixed interval — each attempt waits longer than the last (starting at a small base delay and doubling each time), unless OFSC explicitly tells us how long to wait via Retry-After. This gives Oracle's backend room to recover instead of adding to the load that likely caused the error in the first place.
+
+### Why this matters for OFSC specifically
+
+OFSC's gateway is known to return 503s and connection resets during normal operation — not just outages — especially under sustained polling or bulk export workloads (events, activities, inventory).Handling these
+transparently means:
+
+- Scheduled jobs don't die on a single flaky response and require manual re-runs
+- Token expiry mid-session is handled without the caller needing to track token lifetimes
+- You get clear, real error messages (with the response body attached) for
+  genuine failures, instead of noisy retries on errors that were never going
+  to succeed
+
 ## Installation
 
 ```bash
-npm install ofsc-utility
+npm install ofsc-utility@latest
 ```
 
 ## Getting Started