@bigid/apps-infrastructure-node-js 1.181.1 → 1.181.3

package/lib/services/actionsHubService.d.ts

@@ -14,7 +14,7 @@ export type Command = {
  *
  * @return {Promise<Command[]>} array of the action-center register commands
  */
-export declare const getCommandsRegistrations: () => Promise<Command[]>;
+export declare const getCommandsRegistrations: (accessToken?: string) => Promise<Command[]>;
 /**
  * use this method to execute an action-center commands.
  * this method is used without endpoint for getting status messages, but rather return an execution id.
@@ -25,21 +25,24 @@ export declare const getCommandsRegistrations: () => Promise<Command[]>;
  * @param {string} requestorAppName - the app name of the execution requestor.
  * @param {string} webhookEndpoint - the endpoint of the requestor app to receive execution status messages.
  * @param {Record<string, any>} params - the relevant params of the action to be executed.
+ * @param {string} accessToken -- the access token from BigId.
  * @return {Promise<string>} execution id of the executed action.
  */
-export declare const executeCommand: (actionName: string, command: string, requestorAppName?: string, webhookEndpoint?: string, params?: Record<string, any>[]) => Promise<string>;
+export declare const executeCommand: (actionName: string, command: string, requestorAppName?: string, webhookEndpoint?: string, params?: Record<string, any>[], accessToken?: string) => Promise<string>;
 /**
  * use this method to poll an execution status from the action-center.
  *
- * @param {string} execution - the execution id to poll status for.
+ * @param {string} executionId - the execution id to poll status for.
+ * @param {string} accessToken - the access token from BigId.
  * @return object with the updated status details.
  */
-export declare const getExecutionStatus: (executionId: string) => Promise<any>;
+export declare const getExecutionStatus: (executionId: string, accessToken?: string) => Promise<any>;
 /**
  * use this method to register application action as an action center command.
  *
  * @param {string} applicationName - the application name of the command to be registered.
  * @param {string} actionName - the action name of the command to be registered.
  * @param {string} command - the command to be registered.
+ * @param {string} accessToken - - the access token from BigId.
  */
-export declare const registerActionAsCommand: (applicationName: string, actionName: string, command: string) => Promise<void>;
+export declare const registerActionAsCommand: (applicationName: string, actionName: string, command: string, accessToken?: string) => Promise<void>;

package/lib/services/actionsHubService.js

@@ -25,9 +25,9 @@ const getBigidAccessToken = () => __awaiter(void 0, void 0, void 0, function* ()
  *
  * @return {Promise<Command[]>} array of the action-center register commands
  */
-const getCommandsRegistrations = () => __awaiter(void 0, void 0, void 0, function* () {
+const getCommandsRegistrations = (accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = yield getBigidAccessToken();
+        const bigidToken = accessToken || (yield getBigidAccessToken());
         const { data: { commands }, } = yield (0, bigidProxyService_1.doCallToUrl)(bigidToken, bigidProxyService_1.RequestMethod.GET, `${process.env.BIGID_BASE_URL}/api/v1/action-center/general-commands`);
         return commands;
     }
@@ -46,11 +46,12 @@ exports.getCommandsRegistrations = getCommandsRegistrations;
  * @param {string} requestorAppName - the app name of the execution requestor.
  * @param {string} webhookEndpoint - the endpoint of the requestor app to receive execution status messages.
  * @param {Record<string, any>} params - the relevant params of the action to be executed.
+ * @param {string} accessToken -- the access token from BigId.
  * @return {Promise<string>} execution id of the executed action.
  */
-const executeCommand = (actionName, command, requestorAppName, webhookEndpoint, params) => __awaiter(void 0, void 0, void 0, function* () {
+const executeCommand = (actionName, command, requestorAppName, webhookEndpoint, params, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = yield getBigidAccessToken();
+        const bigidToken = accessToken || (yield getBigidAccessToken());
         const { data: { executionId }, } = yield (0, bigidProxyService_1.doCallToUrl)(bigidToken, bigidProxyService_1.RequestMethod.POST, `${process.env.BIGID_BASE_URL}/api/v1/action-center/general-commands/execute`, Object.assign({ actionName,
             command, feedbackRequestorDetails: requestorAppName && webhookEndpoint
                 ? {
@@ -68,12 +69,13 @@ exports.executeCommand = executeCommand;
 /**
  * use this method to poll an execution status from the action-center.
  *
- * @param {string} execution - the execution id to poll status for.
+ * @param {string} executionId - the execution id to poll status for.
+ * @param {string} accessToken - the access token from BigId.
  * @return object with the updated status details.
  */
-const getExecutionStatus = (executionId) => __awaiter(void 0, void 0, void 0, function* () {
+const getExecutionStatus = (executionId, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = yield getBigidAccessToken();
+        const bigidToken = accessToken || (yield getBigidAccessToken());
         const { data } = yield (0, bigidProxyService_1.doCallToUrl)(bigidToken, bigidProxyService_1.RequestMethod.GET, `${process.env.BIGID_BASE_URL}/api/v1/action-center/general-commands/execute/${executionId}`);
         return data;
     }
@@ -88,10 +90,11 @@ exports.getExecutionStatus = getExecutionStatus;
  * @param {string} applicationName - the application name of the command to be registered.
  * @param {string} actionName - the action name of the command to be registered.
  * @param {string} command - the command to be registered.
+ * @param {string} accessToken - - the access token from BigId.
  */
-const registerActionAsCommand = (applicationName, actionName, command) => __awaiter(void 0, void 0, void 0, function* () {
+const registerActionAsCommand = (applicationName, actionName, command, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = yield getBigidAccessToken();
+        const bigidToken = accessToken || (yield getBigidAccessToken());
         yield (0, bigidProxyService_1.doCallToUrl)(bigidToken, bigidProxyService_1.RequestMethod.POST, `${process.env.BIGID_BASE_URL}/api/v1/action-center/general-commands/register`, {
             applicationName,
             actionName,

package/lib/services/bigidProxyService.d.ts

@@ -35,6 +35,7 @@ export declare const executeHttpPut: (executionContext: ExecutionContext, endpoi
  * the endpoint in BigID, used for DELETE requests.
  */
 export declare const executeHttpDelete: (executionContext: ExecutionContext, endpoint: string) => Promise<any>;
+export declare const executePost: (requestMethod: RequestMethod, baseUrl: string | undefined, bodyJson: Record<string, any>) => Promise<any>;
 export declare const uploadAttachment: (executionContext: ExecutionContext, filePathToUpload: string) => import("axios").AxiosPromise<any>;
 export declare const getAppStorage: (executionContext: ExecutionContext) => Promise<any>;
 export declare const getValueFromAppStorage: (executionContext: ExecutionContext, key: string) => Promise<string>;

package/lib/services/bigidProxyService.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveInStorage = exports.sendBiEvent = exports.deleteKeyFromAppStorage = exports.getValueFromAppStorage = exports.getAppStorage = exports.uploadAttachment = exports.executeHttpDelete = exports.executeHttpPut = exports.executeHttpPost = exports.executeHttpGet = exports.updateActionStatusToBigID = exports.doCallToUrl = exports.getTenantRegistrations = exports.RequestMethod = void 0;
+exports.saveInStorage = exports.sendBiEvent = exports.deleteKeyFromAppStorage = exports.getValueFromAppStorage = exports.getAppStorage = exports.uploadAttachment = exports.executePost = exports.executeHttpDelete = exports.executeHttpPut = exports.executeHttpPost = exports.executeHttpGet = exports.updateActionStatusToBigID = exports.doCallToUrl = exports.getTenantRegistrations = exports.RequestMethod = void 0;
 const fs_1 = require("fs");
 const https_1 = require("https");
 const form_data_1 = __importDefault(require("form-data"));
@@ -100,6 +100,33 @@ exports.executeHttpPut = executeHttpPut;
  */
 const executeHttpDelete = (executionContext, endpoint) => __awaiter(void 0, void 0, void 0, function* () { return yield callBigIdApi(executionContext, RequestMethod.DELETE, endpoint); });
 exports.executeHttpDelete = executeHttpDelete;
+const executePost = (requestMethod, baseUrl, bodyJson) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e, _f;
+    try {
+        const url = baseUrl + 'api/v1/sessions';
+        const headers = {
+            Accept: 'application/json',
+            'Content-type': 'application/json',
+        };
+        const requestObj = {
+            method: requestMethod,
+            url: url,
+            headers: headers,
+        };
+        if (bodyJson && (Object === null || Object === void 0 ? void 0 : Object.keys(bodyJson).length) > 0) {
+            requestObj.data = bodyJson;
+        }
+        const res = yield (0, axios_1.default)(requestObj);
+        (0, utils_1.logInfo)(`<-- bigid-proxy::executePost: ${baseUrl} success`);
+        return res;
+    }
+    catch (error) {
+        (0, utils_1.logError)(`<-- bigid-proxy::executePost: error calling: ${baseUrl}, error: ${error}`);
+        (0, utils_1.logError)((_c = (_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) === null || _c === void 0 ? void 0 : _c.toString());
+        return (_f = (_e = (_d = error.response) === null || _d === void 0 ? void 0 : _d.data) === null || _e === void 0 ? void 0 : _e.message) === null || _f === void 0 ? void 0 : _f.toString();
+    }
+});
+exports.executePost = executePost;
 const uploadAttachment = (executionContext, filePathToUpload) => {
     const formData = new form_data_1.default();
     formData.append('file', (0, fs_1.createReadStream)(filePathToUpload));

package/lib/utils/tokenUtil.d.ts

@@ -1,3 +1,4 @@
 export declare const getAccessTokenFromRefreshToken: (refreshToken: string) => Promise<string>;
+export declare const getTokenByUsernameAndPassword: (username?: string, password?: string) => Promise<string>;
 export declare const getAuth0Token: () => Promise<string>;
 export declare const tokenExchange: (auth0Token: string, tenantId?: string) => Promise<string>;

package/lib/utils/tokenUtil.js

@@ -12,10 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenExchange = exports.getAuth0Token = exports.getAccessTokenFromRefreshToken = void 0;
+exports.tokenExchange = exports.getAuth0Token = exports.getTokenByUsernameAndPassword = exports.getAccessTokenFromRefreshToken = void 0;
 const axios_1 = __importDefault(require("axios"));
 const https_1 = require("https");
 const services_1 = require("../services");
+const appLogger_1 = require("./appLogger");
 const auth0Payload = {
     client_id: process.env.CLIENT_ID,
     client_secret: process.env.CLIENT_SECRET,
@@ -33,11 +34,28 @@ const getAccessTokenFromRefreshToken = (refreshToken) => __awaiter(void 0, void
     return accessToken;
 });
 exports.getAccessTokenFromRefreshToken = getAccessTokenFromRefreshToken;
+const getTokenByUsernameAndPassword = (username, password) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e;
+    try {
+        const requestBody = {
+            username: username || process.env.USERNAME,
+            password: password || process.env.PASSWORD,
+        };
+        const res = yield (0, services_1.executePost)(services_1.RequestMethod.POST, process.env.BIGID_BASE_URL, requestBody);
+        return (_b = (_a = res.data) === null || _a === void 0 ? void 0 : _a.auth_token) === null || _b === void 0 ? void 0 : _b.toString();
+    }
+    catch (error) {
+        const errorMessage = (_e = (_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.message) === null || _e === void 0 ? void 0 : _e.toString();
+        (0, appLogger_1.logError)(errorMessage);
+        return errorMessage;
+    }
+});
+exports.getTokenByUsernameAndPassword = getTokenByUsernameAndPassword;
 const getAuth0Token = () => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
+    var _f;
     if (canUseLocalToken(auth0Token))
         return auth0Token;
-    const auth0Domain = (_a = process.env.AUTH0_DOMAIN) === null || _a === void 0 ? void 0 : _a.replace(/\/$/, '');
+    const auth0Domain = (_f = process.env.AUTH0_DOMAIN) === null || _f === void 0 ? void 0 : _f.replace(/\/$/, '');
     const { data: { access_token }, } = yield axios_1.default.post(`${auth0Domain}/oauth/token`, auth0Payload);
     auth0Token = access_token;
     return access_token;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigid/apps-infrastructure-node-js",
-  "version": "1.181.1",
+  "version": "1.181.3",
   "description": "",
   "main": "lib/index.js",
   "scripts": {

package/src/services/actionsHubService.ts

@@ -29,9 +29,9 @@ export type Command = {
  *
  * @return {Promise<Command[]>} array of the action-center register commands
  */
-export const getCommandsRegistrations = async (): Promise<Command[]> => {
+export const getCommandsRegistrations = async (accessToken?: string): Promise<Command[]> => {
   try {
-    const bigidToken = await getBigidAccessToken();
+    const bigidToken = accessToken || (await getBigidAccessToken());
     const {
       data: { commands },
     } = await doCallToUrl(
@@ -55,6 +55,7 @@ export const getCommandsRegistrations = async (): Promise<Command[]> => {
  * @param {string} requestorAppName - the app name of the execution requestor.
  * @param {string} webhookEndpoint - the endpoint of the requestor app to receive execution status messages.
  * @param {Record<string, any>} params - the relevant params of the action to be executed.
+ * @param {string} accessToken -- the access token from BigId.
  * @return {Promise<string>} execution id of the executed action.
  */
 export const executeCommand = async (
@@ -63,9 +64,10 @@ export const executeCommand = async (
   requestorAppName?: string,
   webhookEndpoint?: string,
   params?: Record<string, any>[],
+  accessToken?: string,
 ): Promise<string> => {
   try {
-    const bigidToken = await getBigidAccessToken();
+    const bigidToken = accessToken || (await getBigidAccessToken());
     const {
       data: { executionId },
     } = await doCallToUrl(
@@ -78,9 +80,9 @@ export const executeCommand = async (
         feedbackRequestorDetails:
           requestorAppName && webhookEndpoint
             ? {
-              requestorAppName,
-              requestorFeedbackEndpoint: webhookEndpoint,
-            }
+                requestorAppName,
+                requestorFeedbackEndpoint: webhookEndpoint,
+              }
             : null,
         ...(params && { params }),
       },
@@ -94,12 +96,13 @@ export const executeCommand = async (
 /**
  * use this method to poll an execution status from the action-center.
  *
- * @param {string} execution - the execution id to poll status for.
+ * @param {string} executionId - the execution id to poll status for.
+ * @param {string} accessToken - the access token from BigId.
  * @return object with the updated status details.
  */
-export const getExecutionStatus = async (executionId: string): Promise<any> => {
+export const getExecutionStatus = async (executionId: string, accessToken?: string): Promise<any> => {
   try {
-    const bigidToken = await getBigidAccessToken();
+    const bigidToken = accessToken || (await getBigidAccessToken());
     const { data } = await doCallToUrl(
       bigidToken,
       RequestMethod.GET,
@@ -117,14 +120,16 @@ export const getExecutionStatus = async (executionId: string): Promise<any> => {
  * @param {string} applicationName - the application name of the command to be registered.
  * @param {string} actionName - the action name of the command to be registered.
  * @param {string} command - the command to be registered.
+ * @param {string} accessToken - - the access token from BigId.
  */
 export const registerActionAsCommand = async (
   applicationName: string,
   actionName: string,
   command: string,
+  accessToken?: string,
 ): Promise<void> => {
   try {
-    const bigidToken = await getBigidAccessToken();
+    const bigidToken = accessToken || (await getBigidAccessToken());
     await doCallToUrl(
       bigidToken,
       RequestMethod.POST,

package/src/services/bigidProxyService.ts

@@ -121,6 +121,37 @@ export const executeHttpPut = async (executionContext: ExecutionContext, endpoin
 export const executeHttpDelete = async (executionContext: ExecutionContext, endpoint: string) =>
   await callBigIdApi(executionContext, RequestMethod.DELETE, endpoint);
 
+export const executePost = async (
+  requestMethod: RequestMethod,
+  baseUrl: string | undefined,
+  bodyJson: Record<string, any>,
+) => {
+  try {
+    const url = baseUrl + 'api/v1/sessions';
+    const headers = {
+      Accept: 'application/json',
+      'Content-type': 'application/json',
+    };
+    const requestObj: Record<string, any> = {
+      method: requestMethod,
+      url: url,
+      headers: headers,
+    };
+    if (bodyJson && Object?.keys(bodyJson).length > 0) {
+      requestObj.data = bodyJson;
+    }
+
+    const res = await axios(requestObj);
+
+    logInfo(`<-- bigid-proxy::executePost: ${baseUrl} success`);
+    return res;
+  } catch (error: any) {
+    logError(`<-- bigid-proxy::executePost: error calling: ${baseUrl}, error: ${error}`);
+    logError(error.response?.data?.message?.toString());
+    return error.response?.data?.message?.toString();
+  }
+};
+
 export const uploadAttachment = (executionContext: ExecutionContext, filePathToUpload: string) => {
   const formData = new FormData();
   formData.append('file', createReadStream(filePathToUpload));
@@ -169,4 +200,4 @@ export const saveInStorage = async (
         value: valueToStore,
       },
     ],
-  });
+  });

package/src/utils/tokenUtil.ts

@@ -1,6 +1,7 @@
 import axios from 'axios';
 import { Agent } from 'https';
-import { doCallToUrl, RequestMethod } from '../services';
+import { doCallToUrl, executePost, RequestMethod } from '../services';
+import { logError, logInfo } from './appLogger';
 
 const auth0Payload = {
   client_id: process.env.CLIENT_ID,
@@ -27,6 +28,21 @@ export const getAccessTokenFromRefreshToken = async (refreshToken: string) => {
   return accessToken;
 };
 
+export const getTokenByUsernameAndPassword = async (username?: string, password?: string): Promise<string> => {
+  try {
+    const requestBody = {
+      username: username || process.env.USERNAME,
+      password: password || process.env.PASSWORD,
+    };
+    const res = await executePost(RequestMethod.POST, process.env.BIGID_BASE_URL, requestBody);
+    return res.data?.auth_token?.toString();
+  } catch (error: any) {
+    const errorMessage = error.response?.data?.message?.toString();
+    logError(errorMessage);
+    return errorMessage;
+  }
+};
+
 export const getAuth0Token = async (): Promise<string> => {
   if (canUseLocalToken(auth0Token)) return auth0Token;
   const auth0Domain = process.env.AUTH0_DOMAIN?.replace(/\/$/, '');