ofsc-utility 1.0.4 → 1.0.5

package/dist/index.d.ts

@@ -1,13 +1,16 @@
 export * as OauthTokenService from './oauthTokenService';
 export * as Resource from './resources';
+export * as User from './users';
 export * as WorkZone from './workZones';
 export * from './types';
 export { getOAuthToken } from './oauthTokenService';
 export { downloadWorkZoneCSV } from './workZones';
 export { downloadAllResourcesCSV } from './resources';
+export { downloadAllUsersCSV } from './users';
 declare const OfscUtility: {
     getOAuthToken: any;
     downloadWorkZoneCSV: any;
     downloadAllResourcesCSV: any;
+    downloadAllUsersCSV: any;
 };
 export default OfscUtility;

package/dist/index.js

@@ -36,10 +36,11 @@ 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.downloadAllResourcesCSV = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.Resource = exports.OauthTokenService = void 0;
+exports.downloadAllUsersCSV = exports.downloadAllResourcesCSV = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.WorkZone = exports.User = exports.Resource = exports.OauthTokenService = void 0;
 // Export all methods grouped by category
 exports.OauthTokenService = __importStar(require("./oauthTokenService"));
 exports.Resource = __importStar(require("./resources"));
+exports.User = __importStar(require("./users"));
 exports.WorkZone = __importStar(require("./workZones"));
 // Export types
 __exportStar(require("./types"), exports);
@@ -50,11 +51,14 @@ var workZones_1 = require("./workZones");
 Object.defineProperty(exports, "downloadWorkZoneCSV", { enumerable: true, get: function () { return workZones_1.downloadWorkZoneCSV; } });
 var resources_1 = require("./resources");
 Object.defineProperty(exports, "downloadAllResourcesCSV", { enumerable: true, get: function () { return resources_1.downloadAllResourcesCSV; } });
+var users_1 = require("./users");
+Object.defineProperty(exports, "downloadAllUsersCSV", { enumerable: true, get: function () { return users_1.downloadAllUsersCSV; } });
 // Default export with all functionality
 const OfscUtility = {
     // Case converters
     getOAuthToken: require('./oauthTokenService').getOAuthToken,
     downloadWorkZoneCSV: require('./workZones').downloadWorkZoneCSV,
-    downloadAllResourcesCSV: require('./resources').downloadAllResourcesCSV
+    downloadAllResourcesCSV: require('./resources').downloadAllResourcesCSV,
+    downloadAllUsersCSV: require('./resources').downloadAllUsersCSV
 };
 exports.default = OfscUtility;

package/dist/users/index.d.ts

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

package/dist/users/index.js

@@ -0,0 +1,115 @@
+"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.downloadAllUsersCSV = downloadAllUsersCSV;
+const fs = __importStar(require("fs"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const index_1 = require("../oauthTokenService/index");
+async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
+    let offset = 0;
+    const limit = 100;
+    let allItems = [];
+    let totalFetched = 0;
+    console.log("🚀 Starting users download...");
+    console.log("-------------------------------------");
+    while (true) {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/?offset=${offset}&limit=${limit}`;
+        const token = await (0, index_1.getOAuthToken)(clientId, clientSecret, instanceUrl);
+        console.log(`➡️ Fetching offset=${offset} limit=${limit}`);
+        const res = await (0, node_fetch_1.default)(url, {
+            method: "GET",
+            headers: {
+                Authorization: `Bearer ${token}`,
+                Accept: "application/json"
+            }
+        });
+        if (!res.ok) {
+            throw new Error(`❌ Fetch failed: ${res.status} ${res.statusText}`);
+        }
+        const data = (await res.json());
+        allItems.push(...data.items);
+        totalFetched += data.items.length;
+        console.log(`   ✔ Received ${data.items.length} items (Total: ${totalFetched})`);
+        if (offset + limit >= data.totalResults)
+            break;
+        offset += limit;
+    }
+    console.log("-------------------------------------");
+    console.log("🧩 Collecting all unique properties...");
+    // Collect union of all properties
+    const allProperties = new Set();
+    for (const item of allItems) {
+        for (const key of Object.keys(item)) {
+            if (!["resources", "collaborationGroups", "resourceInternalIds", "links"].includes(key)) {
+                allProperties.add(key);
+            }
+        }
+    }
+    const headers = Array.from(allProperties);
+    console.log(`📝 Total unique fields: ${headers.length}`);
+    // Build CSV rows
+    const csvRows = [];
+    csvRows.push(headers.join(","));
+    for (const item of allItems) {
+        const row = headers.map(field => {
+            let value = item[field];
+            if (field === "keys") {
+                if (Array.isArray(value))
+                    return `"${value.join("|")}"`;
+                if (value)
+                    return `"${String(value)}"`;
+                return "";
+            }
+            // Objects → JSON-safe string
+            if (typeof value === "object" && value !== null) {
+                return `"${JSON.stringify(value).replace(/"/g, "'")}"`;
+            }
+            return value !== undefined ? `"${String(value).replace(/"/g, "'")}"` : "";
+        });
+        csvRows.push(row.join(","));
+    }
+    const filePath = "./users.csv";
+    fs.writeFileSync(filePath, csvRows.join("\n"));
+    console.log("-------------------------------------");
+    console.log("✅ Users CSV Created Successfully!");
+    console.log(`📁 File: ${filePath}`);
+    console.log(`📦 Total Records: ${totalFetched}`);
+    console.log(`🧩 Total Columns (Dynamic): ${headers.length}`);
+    console.log(`🧩 Date Time: ${new Date()}`);
+    console.log("-------------------------------------");
+}

package/package.json

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

package/readme.md

@@ -4,7 +4,7 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 
 ## Features
 
-- 🚀 **40+ utility methods** 
+- 🚀 **40+ utility methods**
 - 📚 **Written in TypeScript** with full type definitions
 - 🧪 **Completely tested** with Jest
 - 📦 **Zero dependencies**
@@ -13,53 +13,76 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 
 ## Installation
 
-``` bash
+```bash
 npm install ofsc-utility
 ```
 
 ## Functions implemented
 
 ### Download
-    downloadWorkZoneCSV(clientId, clientSecret, instanceId)
-    downloadAllResourcesCSV(clientId, clientSecret, instanceId)
-    getOAuthToken(clientId, clientSecret, instanceId)
-    
+
+    downloadWorkZoneCSV("clientId", "clientSecret", "instanceId")
+    downloadAllResourcesCSV("clientId", "clientSecret", "instanceId")
+    downloadAllUsersCSV("clientId", "clientSecret", "instanceId")
+    getOAuthToken("clientId", "clientSecret", "instanceId")
 
 ## Usage
 
+  downloadWorkZoneCSV("bot", "XXXXXXXXX", "compXXX.test")
+
 ### CommonJS
 
-``` js
-const ofs = require('ofsc-utility');
+```js
+const ofs = require("ofsc-utility");
 
-ofs.getOAuthToken("clientId", "clientSecret", "instanceId")
+ofs
+  .getOAuthToken("clientId", "clientSecret", "instanceId")
   .then((token) => {
-      console.log(token);
+    console.log(token);
   })
   .catch((err) => {
-      console.error("Error fetching token:", err);
+    console.error("Error fetching token:", err);
   });
 ```
 
+```js
+const ofs = require("ofsc-utility");
 
-``` js
-const ofs = require('ofsc-utility');
+ofs.WorkZone.downloadWorkZoneCSV("clientId", "clientSecret", "instanceId")
+  .then(() => {
+    console.log("successful");
+  })
+  .catch((err) => {
+    console.error("Error:", err);
+  });
+```
 
-ofs.WorkZone.downloadWorkZoneCSV("clientId", "clientSecret", "instanceId").then((token) => {
-    console.log(token);
-});
+```js
+const ofs = require("ofsc-utility");
+
+ofs
+  .downloadAllResourcesCSV("clientId", "clientSecret", "instanceId")
+  .then(() => {
+    console.log("successful");
+  })
+  .catch((err) => {
+    console.error("Error:", err);
+  });
 ```
 
-``` js
-const ofs = require('ofsc-utility');
+```js
+const ofs = require("ofsc-utility");
 
-ofs.downloadAllResourcesCSV("clientId", "clientSecret", "instanceId").then((token) => {
-    console.log(token);
-});
+ofs
+  .downloadAllUsersCSV("clientId", "clientSecret", "instanceId")
+  .then(() => {
+    console.log("successful");
+  })
+  .catch((err) => {
+    console.error("Error:", err);
+  });
 ```
 
 ## License
 
 MIT
-
-