ofsc-utility 1.0.7 → 1.0.8

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/index.d.ts

@@ -1,3 +1,4 @@
+export * as Activity from './activities';
 export * as InventoryType from './inventoryTypes';
 export * as OauthTokenService from './oauthTokenService';
 export * as Resource from './resources';
@@ -9,6 +10,7 @@ export { downloadWorkZoneCSV } from './workZones';
 export { downloadAllResourcesCSV } from './resources';
 export { downloadAllUsersCSV } from './users';
 export { downloadAllInventoryTypesCSV, getInventoryTypesDetail, updateCreateInventoryType } from './inventoryTypes';
+export { getAllActivities } from './activities';
 declare const OfscUtility: {
     getOAuthToken: any;
     downloadWorkZoneCSV: any;
@@ -17,5 +19,6 @@ declare const OfscUtility: {
     downloadAllInventoryTypesCSV: any;
     getInventoryTypesDetail: any;
     updateInventoryType: any;
+    getAllActivities: any;
 };
 export default OfscUtility;

package/dist/index.js

@@ -36,8 +36,9 @@ 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.getAllActivities = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.downloadAllUsersCSV = exports.downloadAllResourcesCSV = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.User = exports.Resource = exports.OauthTokenService = exports.InventoryType = exports.Activity = void 0;
 // Export all methods grouped by category
+exports.Activity = __importStar(require("./activities"));
 exports.InventoryType = __importStar(require("./inventoryTypes"));
 exports.OauthTokenService = __importStar(require("./oauthTokenService"));
 exports.Resource = __importStar(require("./resources"));
@@ -58,6 +59,8 @@ 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; } });
 // Default export with all functionality
 const OfscUtility = {
     // Case converters
@@ -67,6 +70,7 @@ const OfscUtility = {
     downloadAllUsersCSV: require('./resources').downloadAllUsersCSV,
     downloadAllInventoryTypesCSV: require('./inventoryTypes').downloadAllInventoryTypesCSV,
     getInventoryTypesDetail: require('./inventoryTypes').getInventoryTypesDetail,
-    updateInventoryType: require('./inventoryTypes').updateInventoryType
+    updateInventoryType: require('./inventoryTypes').updateInventoryType,
+    getAllActivities: require('./activities').getAllActivities
 };
 exports.default = OfscUtility;

package/package.json

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

package/readme.md

@@ -21,6 +21,8 @@ npm install ofsc-utility
 
 ### Download
 
+  Please see the code snippet below.
+
   #### csv
 
     downloadWorkZoneCSV("clientId", "clientSecret", "instanceId")
@@ -33,6 +35,8 @@ npm install ofsc-utility
 
     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")
 
     
 
@@ -146,6 +150,30 @@ 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();
+```
+
 ## License
 
 MIT