ofsc-utility 1.0.30 → 1.0.32

package/dist/events/index.d.ts

@@ -56,4 +56,13 @@ export declare function generateHash(item: {
  * @returns
  */
 export declare function downloadAllEventsOfDLastTwoMinutes(clientId: string, clientSecret: string, instanceUrl: string, subscriptionId: string): Promise<any[]>;
+/**
+ *  Events of last one hour
+ * @param clientId
+ * @param clientSecret
+ * @param instanceUrl
+ * @param subscriptionId
+ * @returns
+ */
+export declare function downloadAllEventsOfLastOneHour(clientId: string, clientSecret: string, instanceUrl: string, subscriptionId: string): Promise<any[]>;
 export {};

package/dist/events/index.js

@@ -8,6 +8,7 @@ exports.downloadAllEventsOfDay = downloadAllEventsOfDay;
 exports.downloadAllEventsOfDayCSV = downloadAllEventsOfDayCSV;
 exports.generateHash = generateHash;
 exports.downloadAllEventsOfDLastTwoMinutes = downloadAllEventsOfDLastTwoMinutes;
+exports.downloadAllEventsOfLastOneHour = downloadAllEventsOfLastOneHour;
 const node_crypto_1 = __importDefault(require("node:crypto"));
 const path_1 = __importDefault(require("path"));
 const index_1 = require("../oauthTokenService/index");
@@ -363,3 +364,92 @@ async function downloadAllEventsOfDLastTwoMinutes(clientId, clientSecret, instan
     }
     return events;
 }
+/**
+ *  Events of last one hour
+ * @param clientId
+ * @param clientSecret
+ * @param instanceUrl
+ * @param subscriptionId
+ * @returns
+ */
+async function downloadAllEventsOfLastOneHour(clientId, clientSecret, instanceUrl, subscriptionId) {
+    /**
+     * Download events from the last ~180 seconds and return them as an
+     * array.
+     *
+     * Differences from `downloadAllEventsOfDayCSV`:
+     * - The `since` timestamp is computed using `getTimeBefore180SecondsAlt`.
+     * - Validates the generated timestamp with `validateDateTimeStrict`.
+     * - For each fetched item, this function attaches a `uniqueId` field
+     *   generated by `generateHash` (used for deduplication or tracing).
+     *
+     * Usage: lightweight polling helper to retrieve recent events for
+     * short-lived processing or monitoring.
+     *
+     * @param clientId - OAuth client id.
+     * @param clientSecret - OAuth client secret.
+     * @param instanceUrl - Instance host.
+     * @param subscriptionId - Subscription id for events.
+     * @returns Array of recent event objects.
+     */
+    // All collected events
+    const events = [];
+    const since = (0, utilities_1.getTimeBefore3600SecondsAlt)();
+    let isValidate = (0, index_2.validateDateTimeStrict)(since);
+    if (!isValidate.isValid) {
+        throw new Error(isValidate.error);
+    }
+    // Build initial request URL
+    const baseUrl = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/events`;
+    const initialUrl = `${baseUrl}?subscriptionId=${encodeURIComponent(subscriptionId)}&since=${encodeURIComponent(since)}`;
+    console.log("sinceDate", since);
+    let token = await (0, index_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+    // Get first page
+    let firstPage = await fetchEventsPage(initialUrl, token, clientId, clientSecret, instanceUrl);
+    token = firstPage.token;
+    let nextPage = firstPage.data.nextPage;
+    let found = firstPage.data.found;
+    // Controls infinite loop
+    let lastSeenPage = nextPage;
+    let repeatedPageCount = 0;
+    // Loop through pages
+    while (found && nextPage) {
+        const pageUrl = new URL(baseUrl);
+        pageUrl.search = new URLSearchParams({
+            subscriptionId,
+            page: nextPage,
+            limit: "1000",
+        }).toString();
+        const finalUrl = pageUrl.toString();
+        const result = await fetchEventsPage(finalUrl, token, clientId, clientSecret, instanceUrl);
+        token = result.token;
+        const page = result.data;
+        found = page.found;
+        nextPage = page.nextPage;
+        console.error("nextPage", nextPage, "Records:", page.items?.length, "Time:", page.items?.[0]?.time);
+        // Prevent infinite looping
+        if (nextPage === lastSeenPage) {
+            repeatedPageCount++;
+            if (repeatedPageCount > 15) {
+                console.warn("⚠️ Pagination repeating same page more than 15 times. Stopping.");
+                break;
+            }
+        }
+        else {
+            lastSeenPage = nextPage;
+            repeatedPageCount = 0;
+        }
+        // Add events
+        if (!page.items) {
+            console.warn("⚠️ No items found in page. Stopping.");
+            break;
+        }
+        for (let k of page.items) {
+            k["uniqueId"] = generateHash(k);
+            k["Change"] = k.activityChanges || k.inventoryChanges || k.requestChanges || k.userChanges || {};
+            k["Id"] = k.activityDetails?.activityId || k.resourceDetails?.resourceId || `${k.userDetails?.login}(${k.userDetails?.status})` || '-';
+            events.push(k);
+        }
+    }
+    return events;
+}

package/dist/index.d.ts

@@ -18,7 +18,7 @@ export { downloadAllUsersCSV, generateUsersCollaborationCSV } from './users';
 export { downloadAllInventoryTypesCSV, getInventoryTypesDetail, updateCreateInventoryType } from './inventoryTypes';
 export { getActivitybyId, getAllActivities } from './activities';
 export { createActivityCustomerInventories, getActivityCustomerInventories } from './activityInventories';
-export { downloadAllEventsOfDay, downloadAllEventsOfDayCSV } from './events';
+export { downloadAllEventsOfDay, downloadAllEventsOfDayCSV, downloadAllEventsOfLastOneHour } from './events';
 export { createExcelFile } from './utilities';
 export { createConfigurationFile } from './metadata';
 declare const OfscUtility: {
@@ -50,6 +50,7 @@ declare const OfscUtility: {
     };
     downloadAllEventsOfDayCSV: any;
     downloadAllEventsOfDay: any;
+    downloadAllEventsOfLastOneHour: any;
     generateUsersCollaborationCSV: any;
     generateAllOnHandInventoryOfAllResourcesCSV: any;
     getActivitybyId: any;

package/dist/index.js

@@ -36,7 +36,7 @@ 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.createConfigurationFile = exports.createExcelFile = exports.downloadAllEventsOfDayCSV = exports.downloadAllEventsOfDay = exports.getActivityCustomerInventories = exports.createActivityCustomerInventories = exports.getAllActivities = exports.getActivitybyId = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.generateUsersCollaborationCSV = exports.downloadAllUsersCSV = exports.getworkSkillsOfResource = exports.downloadAllResourcesCSV = exports.AllResources = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.generateAllOnHandInventoryOfAllResourcesCSV = exports.WorkZone = exports.Utilities = exports.User = exports.Resource = exports.OauthTokenService = exports.CreateConfigurationFile = exports.InventoryType = exports.Inventory = exports.Events = exports.ActivityInventories = exports.Activity = void 0;
+exports.createConfigurationFile = exports.createExcelFile = exports.downloadAllEventsOfLastOneHour = exports.downloadAllEventsOfDayCSV = exports.downloadAllEventsOfDay = exports.getActivityCustomerInventories = exports.createActivityCustomerInventories = exports.getAllActivities = exports.getActivitybyId = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.generateUsersCollaborationCSV = exports.downloadAllUsersCSV = exports.getworkSkillsOfResource = exports.downloadAllResourcesCSV = exports.AllResources = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.generateAllOnHandInventoryOfAllResourcesCSV = exports.WorkZone = exports.Utilities = exports.User = exports.Resource = exports.OauthTokenService = exports.CreateConfigurationFile = exports.InventoryType = exports.Inventory = exports.Events = exports.ActivityInventories = exports.Activity = void 0;
 // Export all methods grouped by category
 exports.Activity = __importStar(require("./activities"));
 exports.ActivityInventories = __importStar(require("./activityInventories"));
@@ -77,6 +77,7 @@ Object.defineProperty(exports, "getActivityCustomerInventories", { enumerable: t
 var events_1 = require("./events");
 Object.defineProperty(exports, "downloadAllEventsOfDay", { enumerable: true, get: function () { return events_1.downloadAllEventsOfDay; } });
 Object.defineProperty(exports, "downloadAllEventsOfDayCSV", { enumerable: true, get: function () { return events_1.downloadAllEventsOfDayCSV; } });
+Object.defineProperty(exports, "downloadAllEventsOfLastOneHour", { enumerable: true, get: function () { return events_1.downloadAllEventsOfLastOneHour; } });
 var utilities_1 = require("./utilities");
 Object.defineProperty(exports, "createExcelFile", { enumerable: true, get: function () { return utilities_1.createExcelFile; } });
 var metadata_1 = require("./metadata");
@@ -111,6 +112,7 @@ const OfscUtility = {
     },
     downloadAllEventsOfDayCSV: require('./events').downloadAllEventsOfDayCSV,
     downloadAllEventsOfDay: require('./events').downloadAllEventsOfDay,
+    downloadAllEventsOfLastOneHour: require('./events').downloadAllEventsOfLastOneHour,
     generateUsersCollaborationCSV: require('./users').generateUsersCollaborationCSV,
     generateAllOnHandInventoryOfAllResourcesCSV: require('./inventory').generateAllOnHandInventoryOfAllResourcesCSV,
     getActivitybyId: require('./activities').getActivitybyId,

package/dist/utilities/index.d.ts

@@ -29,4 +29,5 @@ interface ValidationResult {
  */
 export declare function validateDateTimeStrict(dateTimeStr: string): ValidationResult;
 export declare function getTimeBefore180SecondsAlt(): string;
+export declare function getTimeBefore3600SecondsAlt(): string;
 export {};

package/dist/utilities/index.js

@@ -42,6 +42,7 @@ exports.xmlNodeToObjects = xmlNodeToObjects;
 exports.createExcelFile = createExcelFile;
 exports.validateDateTimeStrict = validateDateTimeStrict;
 exports.getTimeBefore180SecondsAlt = getTimeBefore180SecondsAlt;
+exports.getTimeBefore3600SecondsAlt = getTimeBefore3600SecondsAlt;
 const XLSX = __importStar(require("xlsx-js-style"));
 const xmldom_1 = require("xmldom");
 const oauthTokenService_1 = require("../oauthTokenService");
@@ -76,7 +77,7 @@ const fetchWithRetry = async (url, clientId, clientSecret, instanceUrl, token, r
         res = await doFetch(token);
     }
     /* ---------- 429: retry with backoff ---------- */
-    if (res.status === 429 && retries > 0) {
+    if ((res.status === 429 || res.status === 400) && retries > 0) {
         const retryAfter = res.headers.get("Retry-After");
         console.log("⚠️ 429 received. Retrying...", retryAfter);
         const delay = retryAfter ? Number(retryAfter) * 1000 : baseDelay;
@@ -310,3 +311,10 @@ function getTimeBefore180SecondsAlt() {
         .replace('T', ' ')
         .substring(0, 19);
 }
+function getTimeBefore3600SecondsAlt() {
+    const timeBefore = new Date(Date.now() - 3600000); // 3600 * 1000 = 3600000
+    // Convert to ISO string and format
+    return timeBefore.toISOString()
+        .replace('T', ' ')
+        .substring(0, 19);
+}

package/package.json

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

package/readme.md

@@ -282,6 +282,29 @@ The `metadata` object exposes metadata helpers such as:
 - `getWorkZonesMetaData`
 - `createConfigurationFile`
 
+### Properties metadata note
+
+The `getPropertiesMetaData` helper fetches OFSC property definitions and then builds:
+
+- `Properties Overview`: one row per property, including label, name, type, entity, GUI, clone flag, and deduplicated comments
+- `Properties Enumerations`: combined enumeration dropdown values for any properties whose data type is `enumeration`
+
+This function requires an `allUsedPropes` array to identify which properties are referenced by other metadata types and to collect comments for the overview.
+
+```js
+const allPropes = [];
+
+const propertiesSheet = await ofs.metadata.getPropertiesMetaData(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  allPropes,
+);
+
+console.log(propertiesSheet["Properties Overview"]);
+console.log(propertiesSheet["Properties Enumerations"]);
+```
+
 ## Notes
 
 - `instanceUrl` is the OFSC instance name only, not the full URL. For example: `mycompany` for `mycompany.fs.ocs.oraclecloud.com`.