ofsc-utility 1.0.48 → 1.0.50

package/CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 - version 1.0.46
 
 ### Added
+- add user management methods for standalone OFSC
 - Update version and add resource management APIs
 - version 1.0.47 and add resource APIs
 - release v1.0.44 with getResource function and updated keywords

package/dist/index.d.ts

@@ -13,8 +13,8 @@ export * from './types';
 export { generateAllOnHandInventoryOfAllResources, generateAllOnHandInventoryOfAllResourcesCSV } from './inventory';
 export { getOAuthToken } from './oauthTokenService';
 export { downloadWorkZoneCSV } from './workZones';
-export { AllResources, downloadAllResourcesCSV, getResourcebyId, getworkSkillsOfResource } from './resources';
-export { downloadAllInactiveUsers, downloadAllInactiveUsersCSV, downloadAllUsersCSV, generateUsersCollaborationCSV } from './users';
+export { AllResources, downloadAllResourcesCSV, getResourcebyId, getworkSkillsOfResource, updateResourcebyId } from './resources';
+export { downloadAllInactiveUsers, downloadAllInactiveUsersCSV, downloadAllUsersCSV, generateUsersCollaborationCSV, getUserByLogin, updateUserbyLogin } from './users';
 export { downloadAllInventoryTypesCSV, getInventoryTypesDetail, updateCreateInventoryType } from './inventoryTypes';
 export { getActivitybyId, getAllActivities } 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.getAllActivities = exports.getActivitybyId = exports.updateCreateInventoryType = exports.getInventoryTypesDetail = exports.downloadAllInventoryTypesCSV = exports.generateUsersCollaborationCSV = exports.downloadAllUsersCSV = exports.downloadAllInactiveUsersCSV = exports.downloadAllInactiveUsers = 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.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;
 // Export all methods grouped by category
 exports.Activity = __importStar(require("./activities"));
 exports.ActivityInventories = __importStar(require("./activityInventories"));
@@ -63,11 +63,14 @@ Object.defineProperty(exports, "AllResources", { enumerable: true, get: function
 Object.defineProperty(exports, "downloadAllResourcesCSV", { enumerable: true, get: function () { return resources_1.downloadAllResourcesCSV; } });
 Object.defineProperty(exports, "getResourcebyId", { enumerable: true, get: function () { return resources_1.getResourcebyId; } });
 Object.defineProperty(exports, "getworkSkillsOfResource", { enumerable: true, get: function () { return resources_1.getworkSkillsOfResource; } });
+Object.defineProperty(exports, "updateResourcebyId", { enumerable: true, get: function () { return resources_1.updateResourcebyId; } });
 var users_1 = require("./users");
 Object.defineProperty(exports, "downloadAllInactiveUsers", { enumerable: true, get: function () { return users_1.downloadAllInactiveUsers; } });
 Object.defineProperty(exports, "downloadAllInactiveUsersCSV", { enumerable: true, get: function () { return users_1.downloadAllInactiveUsersCSV; } });
 Object.defineProperty(exports, "downloadAllUsersCSV", { enumerable: true, get: function () { return users_1.downloadAllUsersCSV; } });
 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; } });
 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,3 +1,4 @@
+import { ResourceResponse } from "../types";
 export declare function downloadAllUsersCSV(clientId: string, clientSecret: string, instanceUrl: string): Promise<void>;
 export { generateUsersCollaborationCSV } from './collaborationGroups';
 declare const OfscUserUtility: {
@@ -5,7 +6,10 @@ declare const OfscUserUtility: {
     downloadAllUsersCSV: typeof downloadAllUsersCSV;
     downloadAllInactiveUsersCSV: typeof downloadAllInactiveUsersCSV;
     downloadAllInactiveUsers: typeof downloadAllInactiveUsers;
+    getUserByLogin: typeof getUserByLogin;
 };
 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 declare function getUserByLogin(login: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken?: string): Promise<any>;
+export declare function updateUserbyLogin(login: string, clientId: string, clientSecret: string, instanceUrl: string, initialToken: string | undefined, payload: {}): Promise<ResourceResponse>;
 export default OfscUserUtility;

package/dist/users/index.js

@@ -40,6 +40,8 @@ exports.generateUsersCollaborationCSV = void 0;
 exports.downloadAllUsersCSV = downloadAllUsersCSV;
 exports.downloadAllInactiveUsersCSV = downloadAllInactiveUsersCSV;
 exports.downloadAllInactiveUsers = downloadAllInactiveUsers;
+exports.getUserByLogin = getUserByLogin;
+exports.updateUserbyLogin = updateUserbyLogin;
 const fs = __importStar(require("fs"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const index_1 = require("../oauthTokenService/index");
@@ -123,7 +125,8 @@ const OfscUserUtility = {
     generateUsersCollaborationCSV: require('./collaborationGroups').generateUsersCollaborationCSV,
     downloadAllUsersCSV,
     downloadAllInactiveUsersCSV,
-    downloadAllInactiveUsers
+    downloadAllInactiveUsers,
+    getUserByLogin
 };
 /**
  * Returns true if the user is "inactive":
@@ -292,4 +295,21 @@ async function downloadAllInactiveUsers(clientId, clientSecret, instanceUrl, ina
     console.log("-------------------------------------");
     return result;
 }
+// /rest/ofscCore/v1/users/{login}
+async function getUserByLogin(login, clientId, clientSecret, instanceUrl, initialToken = "") {
+    const fetchUser = async (offset, token) => {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/${encodeURIComponent(login)}?offset=${offset}&limit=100`;
+        const res = await (0, index_2.fetchWithRetry)(url, clientId, clientSecret, instanceUrl, token);
+        return res.data;
+    };
+    return fetchUser(0, initialToken);
+}
+async function updateUserbyLogin(login, clientId, clientSecret, instanceUrl, initialToken = "", payload) {
+    const fetchUser = async (offset, token) => {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscCore/v1/users/${encodeURIComponent(login)}`;
+        const res = await (0, index_2.fetchPatchWithRetry)(url, clientId, clientSecret, instanceUrl, token, payload);
+        return res.data;
+    };
+    return fetchUser(0, initialToken);
+}
 exports.default = OfscUserUtility;

package/package.json

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

@@ -8,6 +8,11 @@ This package exposes grouped API helpers for common OFSC operations, including:
 - export/download helpers
 - inventory and activity records
 - metadata file generation
+- user and resource operations for standalone OFSC environments
+
+> Note: User and resource-related methods are applicable exclusively to standalone OFSC environments and are not supported in Fusion OFSC.
+
+This library is intended for OFSC integrations where the standard OFSC REST APIs are available. The user and resource-related methods are designed for standalone OFSC deployments and should not be relied on for Fusion OFSC environments, where the underlying APIs and behavior can differ.
 
 ### Built-in resilience for OFSC's server errors
 
@@ -537,8 +542,87 @@ node scripts/test-download-inactive-users-data.js
 
 `INACTIVITY_THRESHOLD_DAYS` is optional in the test script and defaults to `14`.
 
+#### Get user by login
+
+`getUserByLogin` fetches a single user record by login name and returns the raw OFSC response payload.
+
+```js
+const user = await ofs.getUserByLogin(
+  "user@example.com",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+console.log(user);
+```
+
+**Function signature**
+
+```ts
+getUserByLogin(
+  login: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+): Promise<any>
+```
+
+Notes:
+
+- This method is intended for standalone OFSC environments.
+- The response is the raw OFSC user payload returned by the API.
+- `initialToken` is optional and can be reused if a bearer token is already available.
+
+#### Update user by login
+
+`updateUserbyLogin` updates a user record by login using a PATCH request.
+
+```js
+const payload = {
+  firstName: "Updated",
+  lastName: "User",
+  status: "ACTIVE",
+};
+
+const response = await ofs.updateUserbyLogin(
+  "user@example.com",
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "",
+  payload,
+);
+
+console.log(response);
+```
+
+**Function signature**
+
+```ts
+updateUserbyLogin(
+  login: string,
+  clientId: string,
+  clientSecret: string,
+  instanceUrl: string,
+  initialToken?: string,
+  payload: object,
+): Promise<ResourceResponse>
+```
+
+Notes:
+
+- The payload is sent as a PATCH body to the OFSC user update endpoint.
+- It uses the same retry wrapper as the other OFSC API helpers.
+- This method is also intended for standalone OFSC usage and may not behave the same in Fusion OFSC.
+
 ### Resource related methods
 
+> Note: User and resource-related methods are applicable exclusively to standalone OFSC environments and are not supported in Fusion OFSC.
+
+These methods are for standalone OFSC environments only. If you are connecting to Fusion OFSC, the user- and resource-based APIs may not behave the same way, and the request/response structure may not match the standalone endpoints.
+
 #### Get all resources
 
 `AllResources` retrieves all resources from the OFSC Resources API. Results are