ofsc-utility 1.0.38 → 1.0.39

package/dist/users/index.d.ts

@@ -6,4 +6,5 @@ declare const OfscUserUtility: {
     downloadAllInactiveUsersCSV: typeof downloadAllInactiveUsersCSV;
 };
 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>[]>;
 export default OfscUserUtility;

package/dist/users/index.js

@@ -39,6 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateUsersCollaborationCSV = void 0;
 exports.downloadAllUsersCSV = downloadAllUsersCSV;
 exports.downloadAllInactiveUsersCSV = downloadAllInactiveUsersCSV;
+exports.downloadAllInactiveUsers = downloadAllInactiveUsers;
 const fs = __importStar(require("fs"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const index_1 = require("../oauthTokenService/index");
@@ -48,12 +49,12 @@ async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
     const limit = 100;
     let allItems = [];
     let totalFetched = 0;
-    console.log("🚀 Starting users download...");
+    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}`);
+        console.log(`Fetching offset=${offset} limit=${limit}`);
         const res = await (0, node_fetch_1.default)(url, {
             method: "GET",
             headers: {
@@ -62,18 +63,18 @@ async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
             }
         });
         if (!res.ok) {
-            throw new Error(`❌ Fetch failed: ${res.status} ${res.statusText}`);
+            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})`);
+        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...");
+    console.log("Collecting all unique properties...");
     // Collect union of all properties
     const allProperties = new Set();
     for (const item of allItems) {
@@ -84,7 +85,7 @@ async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
         }
     }
     const headers = Array.from(allProperties);
-    console.log(`📝 Total unique fields: ${headers.length}`);
+    console.log(`Total unique fields: ${headers.length}`);
     // Build CSV rows
     const csvRows = [];
     csvRows.push(headers.join(","));
@@ -109,11 +110,11 @@ async function downloadAllUsersCSV(clientId, clientSecret, instanceUrl) {
     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("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("-------------------------------------");
 }
 var collaborationGroups_1 = require("./collaborationGroups");
@@ -141,12 +142,12 @@ async function downloadAllInactiveUsersCSV(clientId, clientSecret, instanceUrl,
     const limit = 100;
     let allItems = [];
     let totalFetched = 0;
-    console.log("🚀 Starting users download...");
+    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}`);
+        console.log(`Fetching offset=${offset} limit=${limit}`);
         const res = await (0, node_fetch_1.default)(url, {
             method: "GET",
             headers: {
@@ -155,23 +156,23 @@ async function downloadAllInactiveUsersCSV(clientId, clientSecret, instanceUrl,
             }
         });
         if (!res.ok) {
-            throw new Error(`❌ Fetch failed: ${res.status} ${res.statusText}`);
+            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})`);
+        console.log(`   Received ${data.items.length} items (Total: ${totalFetched})`);
         if (offset + limit >= data.totalResults)
             break;
         offset += limit;
     }
     console.log("-------------------------------------");
-    console.log(`🔎 Filtering inactive users (no login in last ${inactivityThresholdDays} days)...`);
+    console.log(`Filtering inactive users (no login in last ${inactivityThresholdDays} days)...`);
     const now = new Date();
     const inactiveItems = allItems.filter(item => isInactiveUser(item, inactivityThresholdDays, now));
-    console.log(`   ✔ ${inactiveItems.length} of ${allItems.length} users are inactive`);
+    console.log(`   ${inactiveItems.length} of ${allItems.length} users are inactive`);
     console.log("-------------------------------------");
-    console.log("🧩 Collecting all unique properties...");
+    console.log("Collecting all unique properties...");
     // Collect union of all properties (from inactive users only)
     const allProperties = new Set();
     for (const item of inactiveItems) {
@@ -182,7 +183,7 @@ async function downloadAllInactiveUsersCSV(clientId, clientSecret, instanceUrl,
         }
     }
     const headers = Array.from(allProperties);
-    console.log(`📝 Total unique fields: ${headers.length}`);
+    console.log(`Total unique fields: ${headers.length}`);
     // Build CSV rows
     const csvRows = [];
     csvRows.push(headers.join(","));
@@ -207,12 +208,87 @@ async function downloadAllInactiveUsersCSV(clientId, clientSecret, instanceUrl,
     const filePath = "./inactive_users.csv";
     fs.writeFileSync(filePath, csvRows.join("\n"));
     console.log("-------------------------------------");
-    console.log("✅ Inactive Users CSV Created Successfully!");
-    console.log(`📁 File: ${filePath}`);
-    console.log(`📦 Total Fetched: ${totalFetched}`);
-    console.log(`🚫 Inactive Records (>${inactivityThresholdDays} days): ${inactiveItems.length}`);
-    console.log(`🧩 Total Columns (Dynamic): ${headers.length}`);
-    console.log(`🧩 Date Time: ${new Date()}`);
+    console.log("Inactive Users CSV Created Successfully!");
+    console.log(`File: ${filePath}`);
+    console.log(`Total Fetched: ${totalFetched}`);
+    console.log(`Inactive Records (>${inactivityThresholdDays} days): ${inactiveItems.length}`);
+    console.log(`Total Columns (Dynamic): ${headers.length}`);
+    console.log(`Date Time: ${new Date()}`);
     console.log("-------------------------------------");
 }
+async function downloadAllInactiveUsers(clientId, clientSecret, instanceUrl, inactivityThresholdDays = 14) {
+    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(`Filtering inactive users (no login in last ${inactivityThresholdDays} days)...`);
+    const now = new Date();
+    // Skip users with blank/missing lastLoginTime (never-login users are ignored entirely)
+    const usersWithLogin = allItems.filter(item => !!(0, index_2.parseOFSCDate)(item.lastLoginTime));
+    const skippedNeverLoggedIn = allItems.length - usersWithLogin.length;
+    const inactiveItems = usersWithLogin.filter(item => isInactiveUser(item, inactivityThresholdDays, now));
+    console.log(`   Skipped (never logged in / blank lastLoginTime): ${skippedNeverLoggedIn}`);
+    console.log(`   ${inactiveItems.length} of ${usersWithLogin.length} users with login history are inactive`);
+    console.log("-------------------------------------");
+    console.log("Collecting all unique properties...");
+    // Collect union of all properties (from inactive users only)
+    const allProperties = new Set();
+    for (const item of inactiveItems) {
+        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 array of plain objects (one per inactive user)
+    const result = inactiveItems.map(item => {
+        const obj = {};
+        for (const field of headers) {
+            let value = item[field];
+            if (field === "keys") {
+                obj[field] = Array.isArray(value) ? value.join("|") : (value ?? "");
+                continue;
+            }
+            // Keep objects as objects (no JSON-stringify/escaping needed since this isn't CSV)
+            obj[field] = value !== undefined ? value : null;
+        }
+        return obj;
+    });
+    console.log("-------------------------------------");
+    console.log("Inactive Users Collected Successfully!");
+    console.log(`Total Fetched: ${totalFetched}`);
+    console.log(`Skipped (never logged in): ${skippedNeverLoggedIn}`);
+    console.log(`Inactive Records (>${inactivityThresholdDays} days): ${result.length}`);
+    console.log(`Total Columns (Dynamic): ${headers.length}`);
+    console.log(`Date Time: ${new Date()}`);
+    console.log("-------------------------------------");
+    return result;
+}
 exports.default = OfscUserUtility;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility",
-  "version": "1.0.38",
+  "version": "1.0.39",
   "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

@@ -144,8 +144,163 @@ await ofs.downloadAllUsersCSV(
   process.env.CLIENT_SECRET,
   process.env.INSTANCE_NAME,
 );
+
+await ofs.downloadAllInactiveUsersCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  14,
+);
+```
+
+#### Download inactive users
+
+`downloadAllInactiveUsersCSV` downloads all users from the OFSC Users API, filters
+the results, and writes the matching users to `./inactive_users.csv`.
+
+A user is considered inactive when either:
+
+- `lastLoginTime` is missing or cannot be parsed, or
+- the time since `lastLoginTime` is greater than `inactivityThresholdDays`
+
+The threshold defaults to `14` days. The comparison uses the current date and
+time when the function runs. A user whose last login is exactly at the threshold
+is not included because the function uses a strictly greater-than comparison.
+
+```js
+const ofs = require("ofsc-utility");
+
+async function downloadInactiveUsers() {
+  const clientId = process.env.CLIENT_ID;
+  const clientSecret = process.env.CLIENT_SECRET;
+  const instanceUrl = process.env.INSTANCE_NAME;
+
+  if (!clientId || !clientSecret || !instanceUrl) {
+    throw new Error(
+      "Set CLIENT_ID, CLIENT_SECRET and INSTANCE_NAME before running this example",
+    );
+  }
+
+  await ofs.downloadAllInactiveUsersCSV(
+    clientId,
+    clientSecret,
+    instanceUrl,
+    14,
+  );
+}
+
+downloadInactiveUsers().catch((error) => {
+  console.error("Failed to download inactive users:", error);
+  process.exit(1);
+});
 ```
 
+**Function signature**
+
+```ts
+downloadAllInactiveUsersCSV(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  inactivityThresholdDays?: number,
+): Promise<void>
+```
+
+**Parameters**
+
+- `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`.
+- `inactivityThresholdDays`: optional non-negative number of days. Defaults to
+  `14`.
+
+**Output**
+
+- File: `./inactive_users.csv`, relative to the process working directory.
+- The CSV contains one row per inactive user.
+- Nested fields such as `resources`, `collaborationGroups`,
+  `resourceInternalIds`, and `links` are excluded.
+- The remaining columns are generated dynamically from the fields returned by
+  the API. `keys` arrays are joined with `|`; other objects are serialized as
+  JSON strings.
+
+The helper retrieves users in pages of 100 records and requires valid OFSC API
+credentials. It does not return the CSV contents; successful completion resolves
+to `void`.
+
+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
+export INACTIVITY_THRESHOLD_DAYS=14
+node scripts/test-download-inactive-users.js
+```
+
+`INACTIVITY_THRESHOLD_DAYS` is optional in the test script and defaults to `14`.
+
+#### Collect inactive users
+
+`downloadAllInactiveUsers` downloads users from the OFSC Users API, filters out
+users whose last login is within the inactivity threshold, and returns the
+matching users as an array of plain objects. It does not create a CSV file.
+
+Unlike `downloadAllInactiveUsersCSV`, users with a blank(never loggedin)
+`lastLoginTime` are skipped. The threshold defaults to `14` days, and a user is
+included only when the time since the last login is strictly greater than the
+threshold.
+
+```js
+const ofs = require("ofsc-utility");
+
+async function collectInactiveUsers() {
+  const users = await ofs.User.downloadAllInactiveUsers(
+    process.env.CLIENT_ID,
+    process.env.CLIENT_SECRET,
+    process.env.INSTANCE_NAME,
+    14,
+  );
+
+  console.log(`Collected ${users.length} inactive users`);
+  console.log(users[0]);
+}
+
+collectInactiveUsers().catch((error) => {
+  console.error("Failed to collect inactive users:", error);
+  process.exit(1);
+});
+```
+
+**Function signature**
+
+```ts
+downloadAllInactiveUsers(
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  inactivityThresholdDays?: number,
+): Promise<Record<string, 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`.
+- `inactivityThresholdDays`: optional non-negative number of days. Defaults to
+  `14`.
+- The returned array contains one object per inactive user.
+- Nested fields such as `resources`, `collaborationGroups`,
+  `resourceInternalIds`, and `links` are excluded.
+- `keys` arrays are joined with `|`; other object values remain objects.
+
+The helper retrieves users in pages of 100 records and requires valid OFSC API
+credentials.
+
 ### Resource related methods
 
 ```js
@@ -285,6 +440,7 @@ Top-level exports include:
 - `downloadWorkZoneCSV`
 - `downloadAllResourcesCSV`
 - `downloadAllUsersCSV`
+- `downloadAllInactiveUsersCSV`
 - `generateAllOnHandInventoryOfAllResourcesCSV`
 - `generateAllOnHandInventoryOfAllResources`
 - `downloadAllInventoryTypesCSV`