ofsc-utility 1.0.47 → 1.0.49

package/CHANGELOG.md

@@ -10,6 +10,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 - version 1.0.46
 
 ### Added
+- add user management methods for standalone OFSC
+- Update version and add resource management APIs
+- version 1.0.47 and add resource APIs
 - release v1.0.44 with getResource function and updated keywords
 - version 1.0.43 with built-in resilience and exponential backoff
 - Add -c flag to skip CHANGELOG updates and auto-update logic

package/dist/resources/index.d.ts

@@ -6,3 +6,4 @@ export declare function getworkSkillsOfResource(clientId: string, clientSecret:
     data: any;
 }>;
 export declare function getResourcebyId(resourceId: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken?: string): Promise<ResourceResponse>;
+export declare function updateResourcebyId(resourceId: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken: string | undefined, payload: {}): Promise<ResourceResponse>;

package/dist/resources/index.js

@@ -40,6 +40,7 @@ exports.downloadAllResourcesCSV = downloadAllResourcesCSV;
 exports.AllResources = AllResources;
 exports.getworkSkillsOfResource = getworkSkillsOfResource;
 exports.getResourcebyId = getResourcebyId;
+exports.updateResourcebyId = updateResourcebyId;
 const fs = __importStar(require("fs"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const index_1 = require("../oauthTokenService/index");
@@ -149,3 +150,11 @@ async function getResourcebyId(resourceId, clientId, clientSecret, instanceUrl,
     };
     return fetchResources(0, initialToken);
 }
+async function updateResourcebyId(resourceId, clientId, clientSecret, instanceUrl, initialToken = "", payload) {
+    const fetchResources = async (offset, token) => {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/${encodeURIComponent(resourceId)}`;
+        const res = await (0, utilities_1.fetchPatchWithRetry)(url, clientId, clientSecret, instanceUrl, token, payload);
+        return res.data;
+    };
+    return fetchResources(0, initialToken);
+}

package/dist/users/index.d.ts

@@ -1,3 +1,4 @@
+import { ResourceResponse } from "../types";
 export declare function downloadAllUsersCSV(clientId: string, clientSecret: string, instanceUrl: string): Promise<void>;
 export { generateUsersCollaborationCSV } from './collaborationGroups';
 declare const OfscUserUtility: {
@@ -5,7 +6,10 @@ declare const OfscUserUtility: {
     downloadAllUsersCSV: typeof downloadAllUsersCSV;
     downloadAllInactiveUsersCSV: typeof downloadAllInactiveUsersCSV;
     downloadAllInactiveUsers: typeof downloadAllInactiveUsers;
+    getUserByLogin: typeof getUserByLogin;
 };
 export declare function downloadAllInactiveUsersCSV(clientId: string, clientSecret: string, instanceUrl: string, inactivityThresholdDays?: number): Promise<void>;
 export declare function downloadAllInactiveUsers(clientId: string, clientSecret: string, instanceUrl: string, inactivityThresholdDays?: number): Promise<Record<string, any>[]>;
+export declare function getUserByLogin(login: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken?: string): Promise<any>;
+export declare function updateUserbyLogin(login: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken: string | undefined, payload: {}): Promise<ResourceResponse>;
 export default OfscUserUtility;

package/dist/users/index.js

@@ -40,6 +40,8 @@ exports.generateUsersCollaborationCSV = void 0;
 exports.downloadAllUsersCSV = downloadAllUsersCSV;
 exports.downloadAllInactiveUsersCSV = downloadAllInactiveUsersCSV;
 exports.downloadAllInactiveUsers = downloadAllInactiveUsers;
+exports.getUserByLogin = getUserByLogin;
+exports.updateUserbyLogin = updateUserbyLogin;
 const fs = __importStar(require("fs"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const index_1 = require("../oauthTokenService/index");
@@ -123,7 +125,8 @@ const OfscUserUtility = {
     generateUsersCollaborationCSV: require('./collaborationGroups').generateUsersCollaborationCSV,
     downloadAllUsersCSV,
     downloadAllInactiveUsersCSV,
-    downloadAllInactiveUsers
+    downloadAllInactiveUsers,
+    getUserByLogin
 };
 /**
  * Returns true if the user is "inactive":
@@ -292,4 +295,21 @@ async function downloadAllInactiveUsers(clientId, clientSecret, instanceUrl, ina
     console.log("-------------------------------------");
     return result;
 }
+// /rest/ofscCore/v1/users/{login}
+async function getUserByLogin(login, clientId, clientSecret, instanceUrl, initialToken = "") {
+    const fetchUser = async (offset, token) => {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/${encodeURIComponent(login)}?offset=${offset}&limit=100`;
+        const res = await (0, index_2.fetchWithRetry)(url, clientId, clientSecret, instanceUrl, token);
+        return res.data;
+    };
+    return fetchUser(0, initialToken);
+}
+async function updateUserbyLogin(login, clientId, clientSecret, instanceUrl, initialToken = "", payload) {
+    const fetchUser = async (offset, token) => {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/${encodeURIComponent(login)}`;
+        const res = await (0, index_2.fetchPatchWithRetry)(url, clientId, clientSecret, instanceUrl, token, payload);
+        return res.data;
+    };
+    return fetchUser(0, initialToken);
+}
 exports.default = OfscUserUtility;

package/dist/utilities/index.d.ts

@@ -13,6 +13,14 @@ export declare const fetchWithRetry: (url: string, clientId: string, clientSecre
     data: any;
     token: string;
 }>;
+export declare const fetchPatchWithRetry: (url: string, clientId: string, clientSecret: string, instanceUrl: string, token: string, body: any, retries?: number, baseDelay?: number) => Promise<{
+    data: any;
+    token: string;
+}>;
+export declare const fetchPostWithRetry: (url: string, clientId: string, clientSecret: string, instanceUrl: string, token: string, body: any, retries?: number, baseDelay?: number) => Promise<{
+    data: any;
+    token: string;
+}>;
 export declare function saveCsv<T extends Record<string, any>>(rows: T[], filePath: string): void;
 export declare function xmlNodeToObjects(xmlString: string, parentNodeName: string): Record<string, string>[];
 type SheetRow = Record<string, unknown>;

package/dist/utilities/index.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchWithRetry = void 0;
+exports.fetchPostWithRetry = exports.fetchPatchWithRetry = exports.fetchWithRetry = void 0;
 exports.saveCsv = saveCsv;
 exports.xmlNodeToObjects = xmlNodeToObjects;
 exports.createExcelFile = createExcelFile;
@@ -122,6 +122,138 @@ const fetchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, r
     }
 };
 exports.fetchWithRetry = fetchWithRetry;
+const fetchPatchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, body, retries = 5, baseDelay = 500) => {
+    const doFetch = async (bearer) => {
+        return fetch(url, {
+            method: "PATCH",
+            headers: {
+                Authorization: `Bearer ${bearer}`,
+                Accept: "application/json",
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify(body)
+        });
+    };
+    console.log(`Patching ${url}`);
+    let currentToken = token;
+    let tokenRefreshed = false;
+    let remainingRetries = retries;
+    let delay = baseDelay;
+    while (true) {
+        let res = await doFetch(currentToken);
+        if (res.status === 401 && !tokenRefreshed) {
+            console.warn("Token expired — renewing token…");
+            currentToken = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+            tokenRefreshed = true;
+            continue;
+        }
+        const responseText = await res.text();
+        const isNoRouteToHost = res.status === 400 &&
+            responseText.includes("NoRouteToHostException");
+        const isRetryableStatus = res.status === 400 ||
+            res.status === 429 ||
+            res.status === 502 ||
+            res.status === 503 ||
+            res.status === 504;
+        if ((isRetryableStatus || isNoRouteToHost) &&
+            remainingRetries > 0) {
+            const retryAfter = res.headers.get("Retry-After");
+            let retryDelay = delay;
+            if (retryAfter) {
+                const retryAfterSeconds = Number(retryAfter);
+                if (!Number.isNaN(retryAfterSeconds)) {
+                    retryDelay = retryAfterSeconds * 1000;
+                }
+            }
+            console.warn(`Retrying in ${retryDelay}ms... (${remainingRetries} retries left)`);
+            await new Promise(resolve => setTimeout(resolve, retryDelay));
+            remainingRetries--;
+            delay *= 2;
+            continue;
+        }
+        if (!res.ok) {
+            throw new Error(`Request failed: ${res.status} ${res.statusText}\n${responseText}`);
+        }
+        let data;
+        try {
+            data = JSON.parse(responseText);
+        }
+        catch {
+            throw new Error(`Invalid JSON response from ${url}\n${responseText}`);
+        }
+        return {
+            data,
+            token: currentToken
+        };
+    }
+};
+exports.fetchPatchWithRetry = fetchPatchWithRetry;
+const fetchPostWithRetry = async (url, clientId, clientSecret, instanceUrl, token, body, retries = 5, baseDelay = 500) => {
+    const doFetch = async (bearer) => {
+        return fetch(url, {
+            method: "POST",
+            headers: {
+                Authorization: `Bearer ${bearer}`,
+                Accept: "application/json",
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify(body)
+        });
+    };
+    console.log(`Posting ${url}`);
+    let currentToken = token;
+    let tokenRefreshed = false;
+    let remainingRetries = retries;
+    let delay = baseDelay;
+    while (true) {
+        let res = await doFetch(currentToken);
+        if (res.status === 401 && !tokenRefreshed) {
+            console.warn("Token expired — renewing token…");
+            currentToken = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+            tokenRefreshed = true;
+            continue;
+        }
+        const responseText = await res.text();
+        const isNoRouteToHost = res.status === 400 &&
+            responseText.includes("NoRouteToHostException");
+        const isRetryableStatus = res.status === 400 ||
+            res.status === 429 ||
+            res.status === 502 ||
+            res.status === 503 ||
+            res.status === 504;
+        if ((isRetryableStatus || isNoRouteToHost) &&
+            remainingRetries > 0) {
+            const retryAfter = res.headers.get("Retry-After");
+            let retryDelay = delay;
+            if (retryAfter) {
+                const retryAfterSeconds = Number(retryAfter);
+                if (!Number.isNaN(retryAfterSeconds)) {
+                    retryDelay = retryAfterSeconds * 1000;
+                }
+            }
+            console.warn(`Retrying in ${retryDelay}ms... (${remainingRetries} retries left)`);
+            await new Promise(resolve => setTimeout(resolve, retryDelay));
+            remainingRetries--;
+            delay *= 2;
+            continue;
+        }
+        if (!res.ok) {
+            throw new Error(`Request failed: ${res.status} ${res.statusText}\n${responseText}`);
+        }
+        let data;
+        try {
+            data = JSON.parse(responseText);
+        }
+        catch {
+            throw new Error(`Invalid JSON response from ${url}\n${responseText}`);
+        }
+        return {
+            data,
+            token: currentToken
+        };
+    }
+};
+exports.fetchPostWithRetry = fetchPostWithRetry;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 function saveCsv(rows, filePath) {

package/package.json

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

@@ -8,6 +8,11 @@ This package exposes grouped API helpers for common OFSC operations, including:
 - export/download helpers
 - inventory and activity records
 - metadata file generation
+- user and resource operations for standalone OFSC environments
+
+> Note: User and resource-related methods are applicable exclusively to standalone OFSC environments and are not supported in Fusion OFSC.
+
+This library is intended for OFSC integrations where the standard OFSC REST APIs are available. The user and resource-related methods are designed for standalone OFSC deployments and should not be relied on for Fusion OFSC environments, where the underlying APIs and behavior can differ.
 
 ### Built-in resilience for OFSC's server errors
 
@@ -172,6 +177,210 @@ await ofs.downloadAllInactiveUsersCSV(
 );
 ```
 
+### Resource APIs
+
+The resource helpers let you export, paginate, inspect, and update OFSC resources.
+
+#### `downloadAllResourcesCSV`
+
+Exports every resource in the OFSC resource collection to a local `./resources.csv` file.
+
+```js
+await ofs.downloadAllResourcesCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+```
+
+What it does:
+
+- Calls the OFSC `/resources` endpoint in pages of 100 records.
+- Aggregates all returned items across all pages.
+- Builds a union of all field names from the API payloads.
+- Excludes nested relationship fields such as `links`, `inventories`, `users`,
+  `workZones`, `workSkills`, and `workSchedules` from the header set.
+- Writes the result to `./resources.csv` in the current working directory.
+- Serializes arrays under the `keys` field as pipe-delimited strings and JSON-serializes object values for CSV compatibility.
+
+Signature:
+
+```ts
+downloadAllResourcesCSV(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+): Promise<void>
+```
+
+#### `AllResources`
+
+Fetches all resources across all pages and returns them as a single flattened array.
+
+```js
+const resources = await ofs.AllResources(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(`Found ${resources.length} resources`);
+```
+
+This helper is useful when you need to iterate through every resource object in memory, for analytics, reporting, or bulk transformations.
+
+Signature:
+
+```ts
+AllResources(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<ResourceResponse[]>
+```
+
+Notes:
+
+- It paginates automatically until all results are fetched.
+- It returns the flattened `items` collection from every page rather than the raw API wrapper object.
+- The optional `initialToken` parameter can be supplied if you already have a valid bearer token available and want to reuse it.
+
+#### `getworkSkillsOfResource`
+
+Retrieves all work skills assigned to a specific resource.
+
+```js
+const result = await ofs.getworkSkillsOfResource(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  12345,
+);
+
+console.log(result.data);
+console.log(result.token);
+```
+
+
+Signature:
+
+```ts
+getworkSkillsOfResource(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  resourceId: number,
+  token?: string,
+): Promise<{ token: string; data: any }>
+```
+
+Return shape:
+
+```ts
+{
+  token: string,
+  data: any
+}
+```
+
+The `data` value is the `items` array returned by OFSC for the resource's work skills.
+
+#### `getResourcebyId`
+
+Fetches a single resource by its ID.
+
+```js
+const resource = await ofs.getResourcebyId(
+  "resource-123",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(resource);
+```
+
+
+
+Signature:
+
+```ts
+getResourcebyId(
+  resourceId: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<ResourceResponse>
+```
+
+The response is the raw OFSC resource payload returned by the API, so you can inspect its `items`, `totalResults`, and related metadata with the same structure returned by OFSC.
+
+#### `updateResourcebyId`
+
+Updates a resource record by ID using a PATCH request.
+
+```js
+const payload = {
+  name: "Updated Resource Name",
+  status: "ACTIVE",
+};
+
+const response = await ofs.updateResourcebyId(
+  "resource-123",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "",
+  payload,
+);
+
+console.log(response);
+```
+
+Signature:
+
+```ts
+updateResourcebyId(
+  resourceId: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+  payload: object,
+): Promise<ResourceResponse>
+```
+
+Notes:
+
+- The payload is sent as a PATCH body to the OFSC resource update endpoint.
+- It uses the same retry-wrapper logic as the other OFSC API methods so transient gateway and 5xx failures are retried automatically.
+- The returned value is the API response payload from OFSC.
+
+#### Example: working with a resource and its work skills
+
+```js
+const resourceId = "resource-123";
+
+const resource = await ofs.getResourcebyId(
+  resourceId,
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+const workSkills = await ofs.getworkSkillsOfResource(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  Number(resourceId),
+);
+
+console.log("Resource:", resource);
+console.log("Work skills:", workSkills.data);
+```
+
 #### Download inactive users
 
 `downloadAllInactiveUsersCSV` downloads all users from the OFSC Users API, filters
@@ -333,8 +542,177 @@ node scripts/test-download-inactive-users-data.js
 
 `INACTIVITY_THRESHOLD_DAYS` is optional in the test script and defaults to `14`.
 
+#### Get user by login
+
+`getUserByLogin` fetches a single user record by login name and returns the raw OFSC response payload.
+
+```js
+const user = await ofs.getUserByLogin(
+  "user@example.com",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(user);
+```
+
+**Function signature**
+
+```ts
+getUserByLogin(
+  login: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<any>
+```
+
+Notes:
+
+- This method is intended for standalone OFSC environments.
+- The response is the raw OFSC user payload returned by the API.
+- `initialToken` is optional and can be reused if a bearer token is already available.
+
+#### Update user by login
+
+`updateUserbyLogin` updates a user record by login using a PATCH request.
+
+```js
+const payload = {
+  firstName: "Updated",
+  lastName: "User",
+  status: "ACTIVE",
+};
+
+const response = await ofs.updateUserbyLogin(
+  "user@example.com",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "",
+  payload,
+);
+
+console.log(response);
+```
+
+**Function signature**
+
+```ts
+updateUserbyLogin(
+  login: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+  payload: object,
+): Promise<ResourceResponse>
+```
+
+Notes:
+
+- The payload is sent as a PATCH body to the OFSC user update endpoint.
+- It uses the same retry wrapper as the other OFSC API helpers.
+- This method is also intended for standalone OFSC usage and may not behave the same in Fusion OFSC.
+
 ### Resource related methods
 
+> Note: User and resource-related methods are applicable exclusively to standalone OFSC environments and are not supported in Fusion OFSC.
+
+These methods are for standalone OFSC environments only. If you are connecting to Fusion OFSC, the user- and resource-based APIs may not behave the same way, and the request/response structure may not match the standalone endpoints.
+
+#### Get all resources
+
+`AllResources` retrieves all resources from the OFSC Resources API. Results are
+fetched in pages of 100 records until every resource has been returned.
+
+```js
+const resources = await ofs.AllResources(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(`Loaded ${resources.length} resources`);
+```
+
+**Function signature**
+
+```ts
+AllResources(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<ResourceResponse[]>
+```
+
+`initialToken` is optional. The helper refreshes the token as needed while
+requesting subsequent pages.
+
+#### Get a resource by ID
+
+`getResourcebyId` fetches a single resource by its resource ID and returns the
+OFSC response envelope.
+
+```js
+const resource = await ofs.getResourcebyId(
+  "5457",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(resource.items);
+```
+
+**Function signature**
+
+```ts
+getResourcebyId(
+  resourceId: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<ResourceResponse>
+```
+
+The returned response contains `items`, `offset`, `limit`, and `totalResults`.
+`initialToken` is optional.
+
+#### Get resource work skills
+
+`getworkSkillsOfResource` retrieves the work skills assigned to a resource.
+The result includes the token returned by the request and the skills in `data`.
+
+```js
+const workSkills = await ofs.getworkSkillsOfResource(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  5457,
+);
+
+console.log(workSkills.data);
+```
+
+**Function signature**
+
+```ts
+getworkSkillsOfResource(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  resourceId: number,
+  token?: string,
+): Promise<{ token: string; data: any }>
+```
+
+`token` is optional. `data` contains the work-skill items returned by OFSC.
+
 ```js
 await ofs.generateAllOnHandInventoryOfAllResourcesCSV(
   process.env.CLIENT_ID,