ofsc-utility 1.0.7 → 1.0.9

package/dist/activities/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Fetches all activities 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} [q] - The query string to filter activities.
+ * @param {string} [resources] - The resources to filter activities by. Required.
+ * @param {string} [fields] - The fields to include in the response.
+ * @param {string} [dateFrom] - The date from which to filter activities.
+ * @param {string} [dateTo] - The date to which to filter activities.
+ * @returns {Promise<any[]>} A promise which resolves to an array of activity objects.
+ * @throws {Error} If the date format is invalid or if the resources parameter is missing.
+ */
+export declare function getAllActivities(clientId: string, clientSecret: string, instanceUrl: string, resources: string, dateFrom: string, dateTo: string, q?: string, fields?: string): Promise<any[]>;

package/dist/activities/index.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllActivities = getAllActivities;
+const oauthTokenService_1 = require("../oauthTokenService");
+// Validate YYYY-MM-DD format
+const isValidDate = (date) => /^\d{4}-\d{2}-\d{2}$/.test(date);
+/**
+ * Fetches all activities 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} [q] - The query string to filter activities.
+ * @param {string} [resources] - The resources to filter activities by. Required.
+ * @param {string} [fields] - The fields to include in the response.
+ * @param {string} [dateFrom] - The date from which to filter activities.
+ * @param {string} [dateTo] - The date to which to filter activities.
+ * @returns {Promise<any[]>} A promise which resolves to an array of activity objects.
+ * @throws {Error} If the date format is invalid or if the resources parameter is missing.
+ */
+async function getAllActivities(clientId, clientSecret, instanceUrl, resources, dateFrom, dateTo, q, fields) {
+    // Validate date inputs
+    if (!isValidDate(dateFrom) || !isValidDate(dateTo)) {
+        throw new Error(`❌ Invalid date format. Expected YYYY-MM-DD.`);
+    }
+    const limit = 100;
+    let offset = 0;
+    const allItems = [];
+    // Prepare reusable token
+    const token = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+    while (true) {
+        // Build URL cleanly
+        const params = new URLSearchParams({
+            offset: offset.toString(),
+            limit: limit.toString()
+        });
+        if (q)
+            params.append("q", q);
+        if (resources)
+            params.append("resources", resources);
+        if (fields)
+            params.append("fields", fields);
+        if (dateFrom)
+            params.append("dateFrom", dateFrom);
+        if (dateTo)
+            params.append("dateTo", dateTo);
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/?${params.toString()}`;
+        console.error(url);
+        console.log(`➡️ Fetching offset=${offset}, limit=${limit}`);
+        const res = await fetch(url, {
+            method: "GET",
+            headers: {
+                Authorization: `Bearer ${token}`,
+                Accept: "application/json"
+            }
+        });
+        if (!res.ok) {
+            const data = (await res.json());
+            throw new Error(`❌ Fetch failed: ${res.status} ${res.statusText}\n` +
+                `Response: ${JSON.stringify(data, null, 2)}`);
+        }
+        const data = (await res.json());
+        if (!data.items || data.items.length === 0) {
+            console.log("✔ No more items found. Stopping pagination.");
+            break;
+        }
+        allItems.push(...data.items);
+        console.log(`   ✔ Received ${data.items.length} items (Total: ${allItems.length})`);
+        offset += limit;
+    }
+    return allItems;
+}

package/dist/activityInventories/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Fetches all customer inventories related to the given activity.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} activityId - The ID of the activity to fetch customer inventories for.
+ *
+ * @returns {Promise<any[]>} A promise which resolves to an array of customer inventory objects.
+ */
+export declare function getActivityCustomerInventories(clientId: string, clientSecret: string, instanceUrl: string, activityId: string): Promise<any[]>;
+/**
+ * Creates a new customer inventory related to the given activity.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} activityId - The ID of the activity to create a customer inventory for.
+ * @param {object} payload - The customer inventory payload.
+ *
+ * @returns {Promise<object>} A promise which resolves to the created customer inventory object.
+ */
+export declare function createActivityCustomerInventories(clientId: string, clientSecret: string, instanceUrl: string, activityId: string, payload: {}): Promise<{}>;

package/dist/activityInventories/index.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getActivityCustomerInventories = getActivityCustomerInventories;
+exports.createActivityCustomerInventories = createActivityCustomerInventories;
+const oauthTokenService_1 = require("../oauthTokenService");
+const utilities_1 = require("../utilities");
+/**
+ * Fetches all customer inventories related to the given activity.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} activityId - The ID of the activity to fetch customer inventories for.
+ *
+ * @returns {Promise<any[]>} A promise which resolves to an array of customer inventory objects.
+ */
+async function getActivityCustomerInventories(clientId, clientSecret, instanceUrl, activityId) {
+    const limit = 100;
+    let offset = 0;
+    let token = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+    const allItems = [];
+    const fetchCustomerInventories = async (offset) => {
+        const params = new URLSearchParams({
+            offset: offset.toString(),
+            limit: limit.toString()
+        });
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/${activityId}/customerInventories?${params}`;
+        console.log(`➡️ Fetching offset=${offset}, limit=${limit}`);
+        const response = await (0, utilities_1.fetchWithRetry)(url, clientId, clientSecret, instanceUrl, token);
+        token = response.token;
+        const data = response.data;
+        if (!data.items || data.items.length === 0) {
+            // console.log("✔ No more items found. Stopping pagination.");
+            return;
+        }
+        allItems.push(...data.items);
+        console.log(`   ✔ Received ${data.items.length} items (Total: ${allItems.length}) for activity ${activityId}`);
+        await fetchCustomerInventories(offset + limit);
+    };
+    await fetchCustomerInventories(offset);
+    return allItems;
+}
+/**
+ * Creates a new customer inventory related to the given activity.
+ *
+ * @param {string} clientId - The OFSC client ID.
+ * @param {string} clientSecret - The OFSC client secret.
+ * @param {string} instanceUrl - The OFSC instance URL.
+ * @param {string} activityId - The ID of the activity to create a customer inventory for.
+ * @param {object} payload - The customer inventory payload.
+ *
+ * @returns {Promise<object>} A promise which resolves to the created customer inventory object.
+ */
+async function createActivityCustomerInventories(clientId, clientSecret, instanceUrl, activityId, payload) {
+    const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/${activityId}/customerInventories`;
+    const token = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+    const res = await fetch(url, {
+        method: "POST",
+        headers: {
+            Authorization: `Bearer ${token}`,
+            Accept: "application/json",
+            "Content-Type": "application/json"
+        },
+        body: JSON.stringify(payload)
+    });
+    if (!res.ok) {
+        throw new Error(`❌ POST failed: ${res.status} ${res.statusText}`);
+    }
+    return await res.json();
+}

package/dist/index.d.ts

@@ -1,7 +1,10 @@
+export * as Activity from './activities';
+export * as ActivityInventories from './activityInventories';
 export * as InventoryType from './inventoryTypes';
 export * as OauthTokenService from './oauthTokenService';
 export * as Resource from './resources';
 export * as User from './users';
+export * as CSV from './utilities';
 export * as WorkZone from './workZones';
 export * from './types';
 export { getOAuthToken } from './oauthTokenService';
@@ -9,6 +12,8 @@ export { downloadWorkZoneCSV } from './workZones';
 export { downloadAllResourcesCSV } from './resources';
 export { downloadAllUsersCSV } from './users';
 export { downloadAllInventoryTypesCSV, getInventoryTypesDetail, updateCreateInventoryType } from './inventoryTypes';
+export { getAllActivities } from './activities';
+export { createActivityCustomerInventories, getActivityCustomerInventories } from './activityInventories';
 declare const OfscUtility: {
     getOAuthToken: any;
     downloadWorkZoneCSV: any;
@@ -17,5 +22,8 @@ declare const OfscUtility: {
     downloadAllInventoryTypesCSV: any;
     getInventoryTypesDetail: any;
     updateInventoryType: any;
+    getAllActivities: any;
+    getActivityCustomerInventories: any;
+    createActivityCustomerInventories: any;
 };
 export default OfscUtility;

package/dist/index.js

@@ -36,12 +36,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.downloadAllUsersCSV = exports.downloadAllResourcesCSV = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.User = exports.Resource = exports.OauthTokenService = exports.InventoryType = void 0;
+exports.getActivityCustomerInventories = exports.createActivityCustomerInventories = exports.getAllActivities = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.downloadAllUsersCSV = exports.downloadAllResourcesCSV = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.CSV = exports.User = exports.Resource = exports.OauthTokenService = exports.InventoryType = exports.ActivityInventories = exports.Activity = void 0;
 // Export all methods grouped by category
+exports.Activity = __importStar(require("./activities"));
+exports.ActivityInventories = __importStar(require("./activityInventories"));
 exports.InventoryType = __importStar(require("./inventoryTypes"));
 exports.OauthTokenService = __importStar(require("./oauthTokenService"));
 exports.Resource = __importStar(require("./resources"));
 exports.User = __importStar(require("./users"));
+exports.CSV = __importStar(require("./utilities"));
 exports.WorkZone = __importStar(require("./workZones"));
 // Export types
 __exportStar(require("./types"), exports);
@@ -58,15 +61,22 @@ var inventoryTypes_1 = require("./inventoryTypes");
 Object.defineProperty(exports, "downloadAllInventoryTypesCSV", { enumerable: true, get: function () { return inventoryTypes_1.downloadAllInventoryTypesCSV; } });
 Object.defineProperty(exports, "getInventoryTypesDetail", { enumerable: true, get: function () { return inventoryTypes_1.getInventoryTypesDetail; } });
 Object.defineProperty(exports, "updateCreateInventoryType", { enumerable: true, get: function () { return inventoryTypes_1.updateCreateInventoryType; } });
+var activities_1 = require("./activities");
+Object.defineProperty(exports, "getAllActivities", { enumerable: true, get: function () { return activities_1.getAllActivities; } });
+var activityInventories_1 = require("./activityInventories");
+Object.defineProperty(exports, "createActivityCustomerInventories", { enumerable: true, get: function () { return activityInventories_1.createActivityCustomerInventories; } });
+Object.defineProperty(exports, "getActivityCustomerInventories", { enumerable: true, get: function () { return activityInventories_1.getActivityCustomerInventories; } });
 // Default export with all functionality
 const OfscUtility = {
-    // Case converters
     getOAuthToken: require('./oauthTokenService').getOAuthToken,
     downloadWorkZoneCSV: require('./workZones').downloadWorkZoneCSV,
     downloadAllResourcesCSV: require('./resources').downloadAllResourcesCSV,
     downloadAllUsersCSV: require('./resources').downloadAllUsersCSV,
     downloadAllInventoryTypesCSV: require('./inventoryTypes').downloadAllInventoryTypesCSV,
     getInventoryTypesDetail: require('./inventoryTypes').getInventoryTypesDetail,
-    updateInventoryType: require('./inventoryTypes').updateInventoryType
+    updateInventoryType: require('./inventoryTypes').updateInventoryType,
+    getAllActivities: require('./activities').getAllActivities,
+    getActivityCustomerInventories: require('./activityInventories').getActivityCustomerInventories,
+    createActivityCustomerInventories: require('./activityInventories').createActivityCustomerInventories
 };
 exports.default = OfscUtility;

package/dist/utilities/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 declare const fetchWithRetry: (url: string, clientId: string, clientSecret: string, instanceUrl: string, token: string) => Promise<{
+    data: any;
+    token: string;
+}>;
+export declare function saveCsv<T extends Record<string, any>>(rows: T[], filePath: string): void;

package/dist/utilities/index.js

@@ -1 +1,83 @@
 "use strict";
+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.saveCsv = saveCsv;
+const oauthTokenService_1 = require("../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.
+ */
+const fetchWithRetry = async (url, clientId, clientSecret, instanceUrl, token) => {
+    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);
+    // If 401 → renew and retry
+    if (res.status === 401) {
+        console.warn("⚠️ Token expired — renewing token…");
+        token = await (0, oauthTokenService_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+        res = await doFetch(token);
+    }
+    // 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
+    };
+};
+exports.fetchWithRetry = fetchWithRetry;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function saveCsv(rows, filePath) {
+    if (!rows || rows.length === 0) {
+        throw new Error("CSV creation failed: no rows provided.");
+    }
+    // Extract headers from the first row
+    const headers = Object.keys(rows[0]);
+    // Build CSV content
+    const csvLines = [
+        headers.join(","), // header row
+        ...rows.map(row => headers.map(h => escapeCsvValue(row[h])).join(","))
+    ];
+    const csvContent = csvLines.join("\n");
+    // Ensure directory exists
+    const dir = path_1.default.dirname(filePath);
+    if (!fs_1.default.existsSync(dir)) {
+        fs_1.default.mkdirSync(dir, { recursive: true });
+    }
+    // Write the file
+    fs_1.default.writeFileSync(filePath, csvContent);
+    console.log(`CSV saved: ${filePath}`);
+}
+// Escape CSV fields
+function escapeCsvValue(value) {
+    if (value == null)
+        return "";
+    const str = String(value);
+    // Wrap in quotes if needed
+    if (str.includes(",") || str.includes('"') || str.includes("\n")) {
+        return `"${str.replace(/"/g, '""')}"`;
+    }
+    return str;
+}

package/package.json

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

package/readme.md

@@ -21,37 +21,36 @@ npm install ofsc-utility
 
 ### Download
 
-  #### csv
+Please see the code snippet below.
+
+#### csv
 
     downloadWorkZoneCSV("clientId", "clientSecret", "instanceId")
     downloadAllResourcesCSV("clientId", "clientSecret", "instanceId")
     downloadAllUsersCSV("clientId", "clientSecret", "instanceId")
     downloadAllInventoryTypesCSV("clientId", "clientSecret", "instanceId")
-    
-  
-  #### records
+
+#### records
 
     getOAuthToken("clientId", "clientSecret", "instanceId")
     getInventoryTypesDetail("clientId", "clientSecret", "instanceId"."inventory_label")
-
-    
+    updateCreateInventoryType("clientId", "clientSecret", "instanceId"."inventory_label")
+    getAllActivities("clientId", "clientSecret", "instanceId"."resources","dateFrom","dateTo","q","fields")
+    getActivityCustomerInventories("clientId", "clientSecret", "instanceId"."activityId")
+    createActivityCustomerInventories( "clientId", "clientSecret", "instanceId"."activityId","payload")
 
 ## Usage
 
-  downloadWorkZoneCSV("bot", "XXXXXXXXX", "compXXX.test")
+downloadWorkZoneCSV("bot", "XXXXXXXXX", "compXXX.test")
 
 ### CommonJS
 
 ```js
-
-async function  run (){
-let data = await ofs.InventoryType.getInventoryTypesDetail(
-    "clientId", "clientSecret", "instanceId", "inventory_label");
-console.error(data);
+async function run() {
+  let data = await ofs.InventoryType.getInventoryTypesDetail("clientId", "clientSecret", "instanceId", "inventory_label");
+  console.error(data);
 }
 run();
-
-
 ```
 
 ```js
@@ -106,44 +105,67 @@ ofs
 ```
 
 ```js
-const ofs = require('ofsc-utility');
+const ofs = require("ofsc-utility");
 
 async function run() {
-    const payload = {
-        label: "inventory_label",
+  const payload = {
+    label: "inventory_label",
+    name: "Ordered Part",
+    unitOfMeasurement: "ea",
+    active: true,
+    nonSerialized: true,
+    modelProperty: "part_item_number_rev",
+    quantityPrecision: 0,
+    translations: [
+      {
+        language: "en",
         name: "Ordered Part",
         unitOfMeasurement: "ea",
-        active: true,
-        nonSerialized: true,
-        modelProperty: "part_item_number_rev",
-        quantityPrecision: 0,
-        translations: [
-            {
-                language: "en",
-                name: "Ordered Part",
-                unitOfMeasurement: "ea",
-                languageISO: "en-US"
-            }
-        ]
-    };
-
-    try {
-        const result = await updateCreateInventoryType(
-            "CLIENT_ID",
-            "CLIENT_SECRET",
-            "INSTANCE_URL",
-            "inventory_label",
-            payload
-        );
-
-        console.log("Updated:", result);
-    } catch (err) {
-        console.error(err);
-    }
+        languageISO: "en-US",
+      },
+    ],
+  };
+
+  try {
+    const result = await updateCreateInventoryType("CLIENT_ID", "CLIENT_SECRET", "INSTANCE_URL", "inventory_label", payload);
+
+    console.log("Updated:", result);
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+run();
+```
+
+```js
+const ofs = require("ofsc-utility");
+async function run() {
+  try {
+    const result = await ofs.getAllActivities(
+      (clientId = "CLIENT_ID"),
+      (clientSecret = "CLIENT_SECRET"),
+      (instanceUrl = "INSTANCE_URL"),
+      (resources = "US"),
+      (dateFrom = "2025-11-05"),
+      (dateTo = "2025-12-05"),
+      (q = "status=='pending' and ACTIVITY_NOTES!=''"),
+      (fields = "ACTIVITY_NOTES,status,activityId,activityType,date,resourceId")
+    );
+
+    console.log("Updated:", result);
+  } catch (err) {
+    console.error(err);
+  }
 }
 
 run();
+```
 
+```js
+ofs.getActivityCustomerInventories("CLIENT_ID", "CLIENT_SECRET", "INSTANCE_URL", "activityId").then((data) => {
+  console.log(data);
+});
 ```
 
 ## License