ofsc-utility 1.0.57 → 1.0.58

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export { generateAllOnHandInventoryOfAllResources, generateAllOnHandInventoryOfA
 export { getOAuthToken } from './oauthTokenService';
 export { downloadWorkZoneCSV } from './workZones';
 export { AllResources, downloadAllResourcesCSV, getResourcebyId, getworkSkillsOfResource, updateResourcebyId } from './resources';
-export { downloadAllInactiveUsers, downloadAllInactiveUsersCSV, downloadAllUsersCSV, generateUsersCollaborationCSV, getUserByLogin, updateUserbyLogin } from './users';
+export { downloadAllInactiveUsers, downloadAllInactiveUsersCSV, downloadAllUsersCSV, generateUsersCollaborationCSV, getUserByLogin, updateUserbyLogin, downloadAllUsers } from './users';
 export { downloadAllInventoryTypesCSV, getInventoryTypesDetail, updateCreateInventoryType } from './inventoryTypes';
 export { getActivitybyId, getAllActivities, getAllScheduledActivities, startActivity, cancelActivity, completeActivity, deleteActivity, getAllNonScheduledActivities } from './activities';
 export { createActivityCustomerInventories, getActivityCustomerInventories } from './activityInventories';

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.downloadAllEventsOfLastOneHour = exports.downloadAllEventsOfDLastTwoMinutes = exports.downloadAllEventsOfDayCSV = exports.downloadAllEventsOfDay = exports.getActivityCustomerInventories = exports.createActivityCustomerInventories = exports.getAllNonScheduledActivities = exports.deleteActivity = exports.completeActivity = exports.cancelActivity = exports.startActivity = exports.getAllScheduledActivities = exports.getAllActivities = exports.getActivitybyId = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.updateUserbyLogin = exports.getUserByLogin = exports.generateUsersCollaborationCSV = exports.downloadAllUsersCSV = exports.downloadAllInactiveUsersCSV = exports.downloadAllInactiveUsers = exports.updateResourcebyId = exports.getworkSkillsOfResource = exports.getResourcebyId = exports.downloadAllResourcesCSV = exports.AllResources = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.generateAllOnHandInventoryOfAllResourcesCSV = exports.generateAllOnHandInventoryOfAllResources = 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.downloadAllEventsOfDLastTwoMinutes = exports.downloadAllEventsOfDayCSV = exports.downloadAllEventsOfDay = exports.getActivityCustomerInventories = exports.createActivityCustomerInventories = exports.getAllNonScheduledActivities = exports.deleteActivity = exports.completeActivity = exports.cancelActivity = exports.startActivity = exports.getAllScheduledActivities = exports.getAllActivities = exports.getActivitybyId = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.downloadAllUsers = exports.updateUserbyLogin = exports.getUserByLogin = exports.generateUsersCollaborationCSV = exports.downloadAllUsersCSV = exports.downloadAllInactiveUsersCSV = exports.downloadAllInactiveUsers = exports.updateResourcebyId = exports.getworkSkillsOfResource = exports.getResourcebyId = exports.downloadAllResourcesCSV = exports.AllResources = exports.downloadWorkZoneCSV = exports.getOAuthToken = exports.generateAllOnHandInventoryOfAllResourcesCSV = exports.generateAllOnHandInventoryOfAllResources = 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"));
@@ -71,6 +71,7 @@ Object.defineProperty(exports, "downloadAllUsersCSV", { enumerable: true, get: f
 Object.defineProperty(exports, "generateUsersCollaborationCSV", { enumerable: true, get: function () { return users_1.generateUsersCollaborationCSV; } });
 Object.defineProperty(exports, "getUserByLogin", { enumerable: true, get: function () { return users_1.getUserByLogin; } });
 Object.defineProperty(exports, "updateUserbyLogin", { enumerable: true, get: function () { return users_1.updateUserbyLogin; } });
+Object.defineProperty(exports, "downloadAllUsers", { enumerable: true, get: function () { return users_1.downloadAllUsers; } });
 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; } });

package/dist/users/index.d.ts

@@ -1,5 +1,6 @@
 import { ResourceResponse } from "../types";
 export declare function downloadAllUsersCSV(clientId: string, clientSecret: string, instanceUrl: string): Promise<void>;
+export declare function downloadAllUsers(clientId: string, clientSecret: string, instanceUrl: string): Promise<any[]>;
 export { generateUsersCollaborationCSV } from './collaborationGroups';
 declare const OfscUserUtility: {
     generateUsersCollaborationCSV: any;
@@ -7,6 +8,7 @@ declare const OfscUserUtility: {
     downloadAllInactiveUsersCSV: typeof downloadAllInactiveUsersCSV;
     downloadAllInactiveUsers: typeof downloadAllInactiveUsers;
     getUserByLogin: typeof getUserByLogin;
+    downloadAllUsers: typeof downloadAllUsers;
 };
 export declare function downloadAllInactiveUsersCSV(clientId: string, clientSecret: string, instanceUrl: string, inactivityThresholdDays?: number): Promise<void>;
 export declare function downloadAllInactiveUsers(clientId: string, clientSecret: string, instanceUrl: string, inactivityThresholdDays?: number): Promise<Record<string, any>[]>;

package/dist/users/index.js

@@ -38,6 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateUsersCollaborationCSV = void 0;
 exports.downloadAllUsersCSV = downloadAllUsersCSV;
+exports.downloadAllUsers = downloadAllUsers;
 exports.downloadAllInactiveUsersCSV = downloadAllInactiveUsersCSV;
 exports.downloadAllInactiveUsers = downloadAllInactiveUsers;
 exports.getUserByLogin = getUserByLogin;
@@ -119,6 +120,37 @@ async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
     console.log(`Date Time: ${new Date()}`);
     console.log("-------------------------------------");
 }
+async function downloadAllUsers(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;
+    }
+    return allItems;
+}
 var collaborationGroups_1 = require("./collaborationGroups");
 Object.defineProperty(exports, "generateUsersCollaborationCSV", { enumerable: true, get: function () { return collaborationGroups_1.generateUsersCollaborationCSV; } });
 const OfscUserUtility = {
@@ -126,7 +158,8 @@ const OfscUserUtility = {
     downloadAllUsersCSV,
     downloadAllInactiveUsersCSV,
     downloadAllInactiveUsers,
-    getUserByLogin
+    getUserByLogin,
+    downloadAllUsers
 };
 /**
  * Returns true if the user is "inactive":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility",
-  "version": "1.0.57",
+  "version": "1.0.58",
   "description": "TypeScript helpers for Oracle Field Service Cloud (OFSC): events, resources, inventories, metadata and CSV/Excel utilities.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -117,6 +117,7 @@ The package exposes both top-level helpers and grouped namespaces. This list is
 - `getResourcebyId`
 - `getworkSkillsOfResource`
 - `updateResourcebyId`
+- `downloadAllUsers`
 - `downloadAllUsersCSV`
 - `downloadAllInactiveUsersCSV`
 - `downloadAllInactiveUsers`
@@ -182,6 +183,7 @@ The module-level namespace exports are:
   - `getworkSkillsOfResource`
   - `updateResourcebyId`
 - `ofs.User`
+  - `downloadAllUsers`
   - `downloadAllUsersCSV`
   - `downloadAllInactiveUsersCSV`
   - `downloadAllInactiveUsers`
@@ -473,6 +475,75 @@ console.log("Resource:", resource);
 console.log("Work skills:", workSkills.data);
 ```
 
+#### Download all users
+
+`downloadAllUsers` retrieves every user from the OFSC Users API and returns the
+results as an array of plain objects. The method automatically follows the API
+pagination and does not create a CSV file.
+
+```js
+const ofs = require("ofsc-utility");
+
+async function downloadUsers() {
+  const users = await ofs.downloadAllUsers(
+    process.env.CLIENT_ID,
+    process.env.CLIENT_SECRET,
+    process.env.INSTANCE_URL,
+  );
+
+  console.log(`Downloaded ${users.length} users.`);
+  console.log(users[0]);
+}
+
+downloadUsers().catch((error) => {
+  console.error("Failed to download users:", error);
+  process.exit(1);
+});
+```
+
+Or, use the grouped namespace:
+
+```js
+const users = await ofs.User.downloadAllUsers(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_URL,
+);
+```
+
+**Function signature**
+
+```ts
+downloadAllUsers(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+): Promise<any[]>
+```
+
+**Parameters and result**
+
+- `clientId`: OFSC OAuth client ID.
+- `clientSecret`: OFSC OAuth client secret.
+- `instanceUrl`: OFSC instance name only, such as `mycompany`. Do not include
+  `https://` or `.fs.ocs.oraclecloud.com`.
+- The returned array contains every user returned by the API pages. Each user is
+  represented as a plain object.
+
+The helper retrieves users in pages of 100 records and requires valid OFSC API
+credentials. It obtains an OAuth token for each page and returns the combined
+results after the final page is reached.
+
+To run the repository test script against a built distribution:
+
+```bash
+npm run build
+export CLIENT_ID=yourClientId
+export CLIENT_SECRET=yourClientSecret
+export INSTANCE_URL=yourInstanceName
+node scripts/test-download-all-users.js
+```
+
 #### Download inactive users
 
 `downloadAllInactiveUsersCSV` downloads all users from the OFSC Users API, filters