ofsc-utility 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 export * as OauthTokenService from './oauthTokenService';
+export * as WorkZone from './workZones';
 export * from './types';
 export { getOAuthToken } from './oauthTokenService';
+export { downloadWorkZoneCSV } from './workZones';
 declare const OfscUtility: {
     getOAuthToken: any;
+    downloadWorkZoneCSV: any;
 };
 export default OfscUtility;

package/dist/index.js

@@ -36,17 +36,21 @@ 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.getOAuthToken = exports.OauthTokenService = void 0;
+exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.OauthTokenService = void 0;
 // Export all methods grouped by category
 exports.OauthTokenService = __importStar(require("./oauthTokenService"));
+exports.WorkZone = __importStar(require("./workZones"));
 // Export types
 __exportStar(require("./types"), exports);
 // Export individual popular methods for convenience
 var oauthTokenService_1 = require("./oauthTokenService");
 Object.defineProperty(exports, "getOAuthToken", { enumerable: true, get: function () { return oauthTokenService_1.getOAuthToken; } });
+var workZones_1 = require("./workZones");
+Object.defineProperty(exports, "downloadWorkZoneCSV", { enumerable: true, get: function () { return workZones_1.downloadWorkZoneCSV; } });
 // Default export with all functionality
 const OfscUtility = {
     // Case converters
     getOAuthToken: require('./oauthTokenService').getOAuthToken,
+    downloadWorkZoneCSV: require('./workZones').downloadWorkZoneCSV,
 };
 exports.default = OfscUtility;

package/dist/types.d.ts

@@ -1,4 +1,13 @@
-export interface StringValidationResult {
-    isValid: boolean;
-    message?: string;
+export interface WorkZoneItem {
+    workZoneLabel: string;
+    workZoneName: string;
+    status: string;
+    travelArea: string;
+    keys: string[];
+}
+export interface WorkZoneResponse {
+    items: WorkZoneItem[];
+    hasMore: boolean;
+    offset: number;
+    totalResults: number;
 }

package/dist/workZones/index.d.ts

@@ -0,0 +1 @@
+export declare function downloadWorkZoneCSV(clientId: string, clientSecret: string, instanceUrl: string): Promise<void>;

package/dist/workZones/index.js

@@ -0,0 +1,96 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadWorkZoneCSV = downloadWorkZoneCSV;
+const fs = __importStar(require("fs"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const index_1 = require("../oauthTokenService/index");
+async function downloadWorkZoneCSV(clientId, clientSecret, instanceUrl) {
+    const startTime = Date.now();
+    let offset = 0;
+    const limit = 100;
+    let totalWorkZones = 0;
+    let totalKeys = 0;
+    let csvRows = [
+        "workZoneLabel,workZoneName,key,status,travelArea"
+    ];
+    while (true) {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones?offset=${offset}&limit=${limit}`;
+        let token = await (0, index_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+        const res = await (0, node_fetch_1.default)(url, {
+            method: "GET",
+            headers: {
+                Authorization: `Bearer ${token}`,
+                Accept: "application/json"
+            }
+        });
+        if (!res.ok) {
+            throw new Error(`Failed to fetch work zones: ${res.status} ${res.statusText}`);
+        }
+        const data = (await res.json());
+        totalWorkZones += data.items.length;
+        for (const item of data.items) {
+            // Normalize keys (ensure it's always an array)
+            const keys = Array.isArray(item.keys)
+                ? item.keys
+                : item.keys
+                    ? [item.keys]
+                    : [];
+            totalKeys += keys.length;
+            for (const key of keys) {
+                csvRows.push(`${item.workZoneLabel},${item.workZoneName},${key},${item.status},${item.travelArea}`);
+            }
+        }
+        if (!data.hasMore)
+            break;
+        offset = data.offset + limit;
+    }
+    const csv = csvRows.join("\n");
+    const filePath = "./workzones.csv";
+    fs.writeFileSync(filePath, csv);
+    const endTime = Date.now();
+    const durationSec = ((endTime - startTime) / 1000).toFixed(2);
+    // --- Summary ---
+    console.log("\n=== Work Zone Extraction Summary ===");
+    console.log(`Total Work Zones Processed : ${totalWorkZones}`);
+    console.log(`Total Keys Extracted       : ${totalKeys}`);
+    console.log(`CSV Saved To               : ${filePath}`);
+    console.log(`Time Taken                 : ${durationSec} sec`);
+    console.log("====================================\n");
+    console.log("✔ Work Zone CSV download completed.");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A wrapper for Oracle Field Service REST API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,11 +29,15 @@
     "url": "https://github.com/mailtodanish/ofsc-utility"
   },
   "devDependencies": {
-    "typescript": "^5.0.0",
+    "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
-    "ts-node": "^10.9.0",
+    "@types/node-fetch": "^2.6.13",
     "jest": "^29.0.0",
-    "@types/jest": "^29.0.0",
-    "ts-jest": "^29.0.0"
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "node-fetch": "^2.7.0"
   }
-}
+}

package/readme.md

@@ -17,6 +17,12 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 npm install ofsc-utility
 ```
 
+## Functions implemented
+
+### Download
+    downloadWorkZoneCSV(clientId, clientSecret, instanceId)
+    getOAuthToken(clientId, clientSecret, instanceId)
+
 ## Usage
 
 ### CommonJS
@@ -33,10 +39,17 @@ ofs.getOAuthToken("clientId", "clientSecret", "instanceId")
   });
 ```
 
-## Parameters
 
-  Parameter      Type     Description
-  -------------- -------- ------------------------------
-  clientId       string   OFSC OAuth client ID
-  clientSecret   string   OFSC OAuth client secret
-  instanceId     string   OFSC environment/instance ID
+``` js
+const ofs = require('ofsc-utility');
+
+ofs.WorkZone.downloadWorkZoneCSV("clientId", "clientSecret", "instanceId").then((token) => {
+    console.log(token);
+});
+```
+
+## License
+
+MIT
+
+