@bigid/apps-infrastructure-node-js 1.220.1 → 1.226.1

package/README.md

@@ -32,9 +32,6 @@ BIGID_REFRESH_TOKEN - refresh token that will be used to execute api calls
 
 ###Multi tenant mode
 BIGID_BASE_URL - bigid url
-
 AUTH0_DOMAIN - auth0 domain where the application configured - will be provided by BigID's application framework team
-
 CLIENT_ID - client id of the application in auth0 - will be provided by BigID's application framework team
-
 CLIENT_SECRET - client secret of the application - will be provided by BigID's application framework team

package/lib/services/actionsHubService.d.ts

@@ -22,13 +22,14 @@ export declare const getCommandsRegistrations: (accessToken?: string) => Promise
  *
  * @param {string} actionName - the action name to be executed.
  * @param {string} command    - the command to be executed.
+ * @param {string} applicationName - the application name that the command to be triggered belongs to
  * @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>[], accessToken?: string) => Promise<string>;
+export declare const executeCommand: (actionName: string, command: string, applicationName?: 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.
  *

package/lib/services/actionsHubService.js

@@ -36,17 +36,19 @@ exports.getCommandsRegistrations = getCommandsRegistrations;
  *
  * @param {string} actionName - the action name to be executed.
  * @param {string} command    - the command to be executed.
+ * @param {string} applicationName - the application name that the command to be triggered belongs to
  * @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, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
+const executeCommand = (actionName, command, applicationName, requestorAppName, webhookEndpoint, params, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const bigidToken = accessToken || (yield (0, tokenUtil_1.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
+            command,
+            applicationName, feedbackRequestorDetails: requestorAppName && webhookEndpoint
                 ? {
                     requestorAppName,
                     requestorFeedbackEndpoint: webhookEndpoint,

package/lib/services/bigidProxyService.d.ts

@@ -38,7 +38,7 @@ export declare const executeHttpDelete: (executionContext: ExecutionContext, end
 export declare const executePost: (requestMethod: RequestMethod, baseUrl: string | undefined, bodyJson: Record<string, any>, additionalHeaderFields?: Record<string, any>) => Promise<any>;
 export declare const uploadAttachment: (executionContext: ExecutionContext, filePathToUpload: string) => Promise<import("axios").AxiosResponse<any, any>>;
 export declare const getAppStorage: (executionContext: ExecutionContext) => Promise<any>;
-export declare const getValueFromAppStorage: (executionContext: ExecutionContext, key: string) => Promise<string>;
+export declare const getValueFromAppStorage: (executionContext: ExecutionContext, key: string) => Promise<string | null>;
 export declare const deleteKeyFromAppStorage: (executionContext: ExecutionContext, key: string) => Promise<void>;
 export declare const sendBiEvent: (executionContext: ExecutionContext, eventType: string, data: Object) => Promise<any>;
 export declare const saveInStorage: (executionContext: ExecutionContext, keyToStore: any, valueToStore: any) => Promise<void>;

package/lib/services/bigidProxyService.js

@@ -74,7 +74,7 @@ function callBigIdApi(executionContext, requestMethod, endpoint, options) {
 const updateActionStatusToBigID = (executionContext, actionResponseDetails) => __awaiter(void 0, void 0, void 0, function* () {
     return yield callBigIdApi(executionContext, RequestMethod.PUT, executionContext.updateResultCallback, {
         bodyJson: actionResponseDetails,
-        useEndpointWithoutBigIdBasePath: true
+        useEndpointWithoutBigIdBasePath: true,
     });
 });
 exports.updateActionStatusToBigID = updateActionStatusToBigID;

package/log/app.log

@@ -1,8 +1,8 @@
-[2025-01-23T09:45:58.982] [INFO] default - --> bigid-proxy::callBigIdApi: [get] endpoint: https://bigid-ui:9090/api/v1/id_connections
-[2025-01-23T09:45:58.995] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
-[2025-01-23T09:45:58.998] [INFO] default - --> bigid-proxy::callBigIdApi: [post] endpoint: https://bigid-ui:9090/api/v1/id_connections
-[2025-01-23T09:45:59.002] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
-[2025-01-23T09:45:59.003] [INFO] default - --> bigid-proxy::callBigIdApi: [put] endpoint: https://bigid-ui:9090/api/v1/id_connections
-[2025-01-23T09:45:59.006] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
-[2025-01-23T09:45:59.007] [INFO] default - --> bigid-proxy::callBigIdApi: [delete] endpoint: https://bigid-ui:9090/api/v1/id_connections
-[2025-01-23T09:45:59.011] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
+[2025-04-23T11:04:36.805] [INFO] default - --> bigid-proxy::callBigIdApi: [get] endpoint: https://bigid-ui:9090/api/v1/id_connections
+[2025-04-23T11:04:36.819] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
+[2025-04-23T11:04:36.822] [INFO] default - --> bigid-proxy::callBigIdApi: [post] endpoint: https://bigid-ui:9090/api/v1/id_connections
+[2025-04-23T11:04:36.826] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
+[2025-04-23T11:04:36.827] [INFO] default - --> bigid-proxy::callBigIdApi: [put] endpoint: https://bigid-ui:9090/api/v1/id_connections
+[2025-04-23T11:04:36.831] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success
+[2025-04-23T11:04:36.832] [INFO] default - --> bigid-proxy::callBigIdApi: [delete] endpoint: https://bigid-ui:9090/api/v1/id_connections
+[2025-04-23T11:04:36.834] [INFO] default - <-- bigid-proxy::callBigIdApi: https://bigid-ui:9090/api/v1/id_connections success

package/package.json

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

package/src/services/actionsHubService.ts

@@ -42,6 +42,7 @@ export const getCommandsRegistrations = async (accessToken?: string): Promise<Co
  *
  * @param {string} actionName - the action name to be executed.
  * @param {string} command    - the command to be executed.
+ * @param {string} applicationName - the application name that the command to be triggered belongs to
  * @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.
@@ -51,6 +52,7 @@ export const getCommandsRegistrations = async (accessToken?: string): Promise<Co
 export const executeCommand = async (
   actionName: string,
   command: string,
+  applicationName?: string,
   requestorAppName?: string,
   webhookEndpoint?: string,
   params?: Record<string, any>[],
@@ -67,6 +69,7 @@ export const executeCommand = async (
       {
         actionName,
         command,
+        applicationName,
         feedbackRequestorDetails:
           requestorAppName && webhookEndpoint
             ? {

package/src/services/bigidProxyService.ts

@@ -82,7 +82,13 @@ async function callBigIdApi(
   options: BigIdApiRequestOptions,
 ) {
   const url = options?.useEndpointWithoutBigIdBasePath ? endpoint : executionContext.bigidBaseUrl + endpoint;
-  return await doCallToUrl(executionContext.bigidToken, requestMethod, url, options?.bodyJson, options?.additionalHeaderFields);
+  return await doCallToUrl(
+    executionContext.bigidToken,
+    requestMethod,
+    url,
+    options?.bodyJson,
+    options?.additionalHeaderFields,
+  );
 }
 
 /**
@@ -95,15 +101,10 @@ export const updateActionStatusToBigID = async (
   executionContext: ExecutionContext,
   actionResponseDetails: ActionResponseDetails,
 ) =>
-  await callBigIdApi(
-    executionContext,
-    RequestMethod.PUT,
-    executionContext.updateResultCallback,
-    {
-      bodyJson: actionResponseDetails,
-      useEndpointWithoutBigIdBasePath: true
-    }
-  );
+  await callBigIdApi(executionContext, RequestMethod.PUT, executionContext.updateResultCallback, {
+    bodyJson: actionResponseDetails,
+    useEndpointWithoutBigIdBasePath: true,
+  });
 
 /**
  *
@@ -111,32 +112,46 @@ export const updateActionStatusToBigID = async (
  * @param endpoint - the endpoint in BigID, used for GET request. e.g - {BigIDBaseUrl}/ds_connections
  * @return - String containing the response from BigID
  */
-export const executeHttpGet = async (executionContext: ExecutionContext, endpoint: string, additionalHeaderFields?: Record<string, any>) =>
-  await callBigIdApi(executionContext, RequestMethod.GET, endpoint, { additionalHeaderFields });
+export const executeHttpGet = async (
+  executionContext: ExecutionContext,
+  endpoint: string,
+  additionalHeaderFields?: Record<string, any>,
+) => await callBigIdApi(executionContext, RequestMethod.GET, endpoint, { additionalHeaderFields });
 
 /**
  * the endpoint in BigID, used for POST requests. e.g - {BigIDBaseUrl}/scan
  */
-export const executeHttpPost = async (executionContext: ExecutionContext, endpoint: string, obj: any, additionalHeaderFields?: Record<string, any>) =>
-  await callBigIdApi(executionContext, RequestMethod.POST, endpoint, { bodyJson: obj, additionalHeaderFields });
+export const executeHttpPost = async (
+  executionContext: ExecutionContext,
+  endpoint: string,
+  obj: any,
+  additionalHeaderFields?: Record<string, any>,
+) => await callBigIdApi(executionContext, RequestMethod.POST, endpoint, { bodyJson: obj, additionalHeaderFields });
 
 /**
  * the endpoint in BigID, used for POST requests. e.g - {BigIDBaseUrl}/scan
  */
-export const executeHttpPut = async (executionContext: ExecutionContext, endpoint: string, obj: any, additionalHeaderFields?: Record<string, any>) =>
-  await callBigIdApi(executionContext, RequestMethod.PUT, endpoint, { bodyJson: obj, additionalHeaderFields });
+export const executeHttpPut = async (
+  executionContext: ExecutionContext,
+  endpoint: string,
+  obj: any,
+  additionalHeaderFields?: Record<string, any>,
+) => await callBigIdApi(executionContext, RequestMethod.PUT, endpoint, { bodyJson: obj, additionalHeaderFields });
 
 /**
  * the endpoint in BigID, used for DELETE requests.
  */
-export const executeHttpDelete = async (executionContext: ExecutionContext, endpoint: string, additionalHeaderFields?: Record<string, any>) =>
-  await callBigIdApi(executionContext, RequestMethod.DELETE, endpoint, { additionalHeaderFields });
+export const executeHttpDelete = async (
+  executionContext: ExecutionContext,
+  endpoint: string,
+  additionalHeaderFields?: Record<string, any>,
+) => await callBigIdApi(executionContext, RequestMethod.DELETE, endpoint, { additionalHeaderFields });
 
 export const executePost = async (
   requestMethod: RequestMethod,
   baseUrl: string | undefined,
   bodyJson: Record<string, any>,
-  additionalHeaderFields?: Record<string, any>
+  additionalHeaderFields?: Record<string, any>,
 ) => {
   try {
     const url = baseUrl + 'api/v1/sessions';
@@ -188,7 +203,10 @@ export const uploadAttachment = (executionContext: ExecutionContext, filePathToU
 export const getAppStorage = (executionContext: ExecutionContext) =>
   executeHttpGet(executionContext, `tpa/${executionContext.tpaId}/storage`);
 
-export const getValueFromAppStorage = async (executionContext: ExecutionContext, key: string): Promise<string> => {
+export const getValueFromAppStorage = async (
+  executionContext: ExecutionContext,
+  key: string,
+): Promise<string | null> => {
   const { data } = await executeHttpGet(executionContext, `tpa/${executionContext.tpaId}/storage/key/${key}`);
   return data === 'Key not found' ? null : data?.value;
 };