@bigid/apps-infrastructure-node-js 0.1.0 → 1.180.0

package/.github/workflows/bigid_config

@@ -0,0 +1,3 @@
+registry = https://artifactory.bigid-integrations.net/artifactory/api/npm/NPM-Private/
+//artifactory.bigid-integrations.net/artifactory/api/npm/NPM-Private/:_authToken = ${TOKEN}
+always-auth = true

package/.github/workflows/npmjs_config

@@ -0,0 +1,3 @@
+registry = https://registry.npmjs.org/
+//registry.npmjs.org/:_authToken = ${TOKEN}
+always-auth = true

package/.github/workflows/private-registry-publish.yml

@@ -0,0 +1,16 @@
+name: Upload to private registry
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+jobs:
+  Upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.1.1
+      - run: npm i
+      - run: tsc
+      - run: npm publish --userconfig .github/workflows/bigid_config
+        env:
+          TOKEN: ${{ secrets.TOKEN }}

package/.github/workflows/public-registry-publish.yml

@@ -0,0 +1,14 @@
+name: Upload to public registry - npmjs
+on:
+  workflow_dispatch:
+
+jobs:
+  Upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.1.1
+      - run: npm i
+      - run: tsc
+      - run: npm publish --userconfig .github/workflows/npmjs_config
+        env:
+          TOKEN: ${{ secrets.NPMJS_TOKEN }}

package/CODEOWNERS

@@ -0,0 +1 @@
+* @bigexchange/app_admins

package/README.md

@@ -3,9 +3,38 @@ The applications infrastructure for node.js is a wrapper for node application.
 
 This wrapper handles all the necessary endpoints for communicate with bigid, provide dtos and logger for quick application development.
 
-### HOW TO USE?
+## HOW TO USE?
 First get the package from npm.
 
 ```npm install @bigid/apps-infrastructure-node-js```
 
-After the package installed - implement all the providers in your application and in your root app file use ```deployServer()``` for creating the server.
+After the package installed - implement all the providers in your application and in your root app file use ```deployServer()``` for creating the server.
+
+## How to use sdk's scheduler service?
+If you have any function that needs to be running for each of the tenants that uses the application in any time period 
+you can use the sdk's scheduler service.
+
+First import the schedule function
+
+```const { scheduleFunction } = require('apps-infrastructure-node-js');```
+
+Then call it with the necessary params
+
+```scheduleFunction('dailyInsightUniqueName', '* * * * *', callbackToExecute)```
+
+But before you are running your application please make sure you configure the next environment variables
+depends where the application was deployed
+
+###Single tenant mode
+BIGID_BASE_URL - bigid url
+
+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/jsdoc.json

@@ -0,0 +1,14 @@
+{
+  "source": {
+    "include": [
+      "./lib"
+    ],
+    "includePattern": ".js$"
+  },
+  "opts": {
+    "encoding": "utf8",
+    "readme": "./readme.md",
+    "destination": "docs/",
+    "recurse": true
+  }
+}

package/lib/abstractProviders/configureProvider.d.ts

@@ -0,0 +1,10 @@
+import { Request, Response } from 'express';
+export type ConfigurePayload = {
+    tenantId: string;
+    bigidBaseUrl?: string;
+    isDeleted?: boolean;
+};
+export declare const handleTenantConfigure: (req: Request, res: Response, configureProvider: ConfigureProvider) => Promise<void>;
+export declare abstract class ConfigureProvider {
+    abstract configureTenant(configurePayload: ConfigurePayload, res: Response): Promise<void> | void;
+}

package/lib/{routes/router.js → abstractProviders/configureProvider.js}

@@ -9,7 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.router = void 0;
-const router = () => __awaiter(void 0, void 0, void 0, function* () {
+exports.ConfigureProvider = exports.handleTenantConfigure = void 0;
+const handleTenantConfigure = (req, res, configureProvider) => __awaiter(void 0, void 0, void 0, function* () {
+    yield configureProvider.configureTenant(req.body, res);
 });
-exports.router = router;
+exports.handleTenantConfigure = handleTenantConfigure;
+class ConfigureProvider {
+}
+exports.ConfigureProvider = ConfigureProvider;

package/lib/abstractProviders/executionProvider.d.ts

@@ -1,4 +1,5 @@
 import { Request, Response } from 'express';
+import { ExecutionContext } from '../dto';
 export declare const StatusEnum: {
     COMPLETED: string;
     IN_PROGRESS: string;
@@ -6,8 +7,8 @@ export declare const StatusEnum: {
 };
 export declare const handleExecution: (req: Request, res: Response, executionProvider: ExecutionProvider) => Promise<void>;
 export declare abstract class ExecutionProvider {
-    abstract executeAction(req: Request, res: Response): Promise<void>;
+    abstract executeAction(executionContext: ExecutionContext, res: Response): Promise<void>;
     generateSyncSuccessMessage: (res: Response, executionId: string, message: string) => Response<any, Record<string, any>>;
     generateAsyncSuccessMessage: (res: Response, executionId: string, message: string) => Response<any, Record<string, any>>;
-    generateFailedResponse: (res: Response, executionId: string, e: Error) => Response<any, Record<string, any>>;
+    generateFailedResponse: (res: Response, executionId: string, errorMessage: string) => Response<any, Record<string, any>>;
 }

package/lib/abstractProviders/executionProvider.js

@@ -10,26 +10,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExecutionProvider = exports.handleExecution = exports.StatusEnum = void 0;
-const actionResponseDetails_1 = require("../dto/actionResponseDetails");
-const services_1 = require("../services");
+const dto_1 = require("../dto");
 exports.StatusEnum = {
     COMPLETED: 'COMPLETED',
     IN_PROGRESS: 'IN_PROGRESS',
     ERROR: 'ERROR',
 };
 const handleExecution = (req, res, executionProvider) => __awaiter(void 0, void 0, void 0, function* () {
-    (0, services_1.setValuesForBigIDProxy)(req.body);
-    yield executionProvider.executeAction(req, res);
+    yield executionProvider.executeAction(req.body, res);
 });
 exports.handleExecution = handleExecution;
 class ExecutionProvider {
     constructor() {
-        this.generateSyncSuccessMessage = (res, executionId, message) => res.status(200)
-            .json(new actionResponseDetails_1.ActionResponseDetails(executionId, exports.StatusEnum.COMPLETED, 1, message));
-        this.generateAsyncSuccessMessage = (res, executionId, message) => res.status(202)
-            .json(new actionResponseDetails_1.ActionResponseDetails(executionId, exports.StatusEnum.IN_PROGRESS, 0, message));
-        this.generateFailedResponse = (res, executionId, e) => res.status(400)
-            .json(new actionResponseDetails_1.ActionResponseDetails(executionId, exports.StatusEnum.ERROR, 0, e.message));
+        this.generateSyncSuccessMessage = (res, executionId, message) => res.status(200).json(new dto_1.ActionResponseDetails(executionId, exports.StatusEnum.COMPLETED, 1, message));
+        this.generateAsyncSuccessMessage = (res, executionId, message) => res.status(202).json(new dto_1.ActionResponseDetails(executionId, exports.StatusEnum.IN_PROGRESS, 0, message));
+        this.generateFailedResponse = (res, executionId, errorMessage) => res.status(400).json(new dto_1.ActionResponseDetails(executionId, exports.StatusEnum.ERROR, 0, errorMessage));
     }
 }
 exports.ExecutionProvider = ExecutionProvider;

package/lib/abstractProviders/index.d.ts

@@ -1,3 +1,4 @@
 export { ManifestProvider } from './manifestProvider';
 export { IconsProviders } from './iconsProviders';
 export { ExecutionProvider, StatusEnum } from './executionProvider';
+export { ConfigureProvider, ConfigurePayload } from './configureProvider';

package/lib/abstractProviders/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatusEnum = exports.ExecutionProvider = exports.IconsProviders = exports.ManifestProvider = void 0;
+exports.ConfigureProvider = exports.StatusEnum = exports.ExecutionProvider = exports.IconsProviders = exports.ManifestProvider = void 0;
 var manifestProvider_1 = require("./manifestProvider");
 Object.defineProperty(exports, "ManifestProvider", { enumerable: true, get: function () { return manifestProvider_1.ManifestProvider; } });
 var iconsProviders_1 = require("./iconsProviders");
@@ -8,3 +8,5 @@ Object.defineProperty(exports, "IconsProviders", { enumerable: true, get: functi
 var executionProvider_1 = require("./executionProvider");
 Object.defineProperty(exports, "ExecutionProvider", { enumerable: true, get: function () { return executionProvider_1.ExecutionProvider; } });
 Object.defineProperty(exports, "StatusEnum", { enumerable: true, get: function () { return executionProvider_1.StatusEnum; } });
+var configureProvider_1 = require("./configureProvider");
+Object.defineProperty(exports, "ConfigureProvider", { enumerable: true, get: function () { return configureProvider_1.ConfigureProvider; } });

package/lib/abstractProviders/logsProvider.js

@@ -3,5 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchLogs = void 0;
 const fs_1 = require("fs");
 const constants_1 = require("../utils/constants");
-const fetchLogs = (req, res) => (0, fs_1.createReadStream)(constants_1.LOGS_PATH).pipe(res);
+const fetchLogs = (req, res) => {
+    const tenantId = req.headers.tenantid;
+    const data = (0, fs_1.readFileSync)(constants_1.LOGS_PATH, { encoding: 'utf8' });
+    const lines = data.split('\n');
+    const tenantLogLines = lines
+        .filter(line => line.includes(`[tenantId: ${tenantId}`) || !line.includes('[tenantId: '))
+        .join('\n');
+    return res.send(tenantLogLines);
+};
 exports.fetchLogs = fetchLogs;

package/lib/abstractProviders/manifestProvider.d.ts

@@ -1,3 +1,4 @@
+import { Response, Request } from 'express';
 export declare abstract class ManifestProvider {
-    abstract getManifest(req: any, res: any): string;
+    abstract getManifest(req: Request, res: Response): Response;
 }

package/lib/dto/actionResponseDetails.d.ts

@@ -1,8 +1,10 @@
+import { SubExecutionItem } from "./subExecutionItem";
 export declare class ActionResponseDetails {
     executionId: string;
     statusEnum: string;
     progress: number;
     message: string;
     additionalData?: any;
-    constructor(executionId: string, statusEnum: string, progress: number, message: string, additionalData?: any);
+    subExecutionItems?: SubExecutionItem[];
+    constructor(executionId: string, statusEnum: string, progress: number, message: string, additionalData?: any, subExecutionItems?: SubExecutionItem[]);
 }

package/lib/dto/actionResponseDetails.js

@@ -2,12 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionResponseDetails = void 0;
 class ActionResponseDetails {
-    constructor(executionId, statusEnum, progress, message, additionalData) {
+    constructor(executionId, statusEnum, progress, message, additionalData, subExecutionItems) {
         this.executionId = executionId;
         this.statusEnum = statusEnum;
         this.progress = progress;
         this.message = message;
         this.additionalData = additionalData;
+        this.subExecutionItems = subExecutionItems;
     }
 }
 exports.ActionResponseDetails = ActionResponseDetails;

package/lib/dto/executionContext.d.ts

@@ -1,11 +1,14 @@
-export declare class ExecutionContext {
+export type ExecutionContext = {
     actionName: string;
     executionId: string;
-    globalParams: Record<string, string>;
-    actionParams: Record<string, string>;
+    globalParams: Array<GeneralParam>;
+    actionParams: Array<GeneralParam>;
     bigidBaseUrl: string;
     bigidToken: string;
     updateResultCallback: any;
     tpaId: string;
-    constructor(actionName: string, executionId: string, globalParams: Record<string, string>, actionParams: Record<string, string>, bigidBaseUrl: string, bigidToken: string, updateResultCallback: any, tpaId: string);
-}
+};
+export type GeneralParam = {
+    paramName: string;
+    paramValue: string;
+};

package/lib/dto/executionContext.js

@@ -1,16 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecutionContext = void 0;
-class ExecutionContext {
-    constructor(actionName, executionId, globalParams, actionParams, bigidBaseUrl, bigidToken, updateResultCallback, tpaId) {
-        this.actionName = actionName;
-        this.executionId = executionId;
-        this.globalParams = globalParams;
-        this.actionParams = actionParams;
-        this.bigidBaseUrl = bigidBaseUrl;
-        this.bigidToken = bigidToken;
-        this.updateResultCallback = updateResultCallback;
-        this.tpaId = tpaId;
-    }
-}
-exports.ExecutionContext = ExecutionContext;

package/lib/dto/index.d.ts

@@ -1,2 +1,2 @@
-export { ExecutionContext } from './executionContext';
+export { ExecutionContext, GeneralParam } from './executionContext';
 export { ActionResponseDetails } from './actionResponseDetails';

package/lib/dto/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionResponseDetails = exports.ExecutionContext = void 0;
-var executionContext_1 = require("./executionContext");
-Object.defineProperty(exports, "ExecutionContext", { enumerable: true, get: function () { return executionContext_1.ExecutionContext; } });
+exports.ActionResponseDetails = void 0;
 var actionResponseDetails_1 = require("./actionResponseDetails");
 Object.defineProperty(exports, "ActionResponseDetails", { enumerable: true, get: function () { return actionResponseDetails_1.ActionResponseDetails; } });

package/lib/dto/subExecutionItem.d.ts

@@ -0,0 +1,7 @@
+export declare class SubExecutionItem {
+    name: string;
+    statusEnum: string;
+    message?: string;
+    errorCode?: string;
+    constructor(name: string, statusEnum: string, message?: string, errorCode?: string);
+}

package/lib/dto/subExecutionItem.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubExecutionItem = void 0;
+class SubExecutionItem {
+    constructor(name, statusEnum, message, errorCode) {
+        this.name = name;
+        this.statusEnum = statusEnum;
+        this.message = message;
+        this.errorCode = errorCode;
+    }
+}
+exports.SubExecutionItem = SubExecutionItem;

package/lib/dto/tenantRegistration.d.ts

@@ -0,0 +1,5 @@
+export type TenantRegistration = {
+    tenantId: string;
+    tenantDomain: string;
+    companyName: string;
+};

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export * from './abstractProviders';
 export * from './dto';
 export * from './utils';
-export { updateActionStatusToBigID, uploadAttachment, getValueFromAppStorage, saveInStorage, executeHttpGet } from './services';
+export { updateActionStatusToBigID, uploadAttachment, getValueFromAppStorage, saveInStorage, executeHttpGet, scheduleFunction, unscheduleFunction, unscheduleAllFunctions, deleteKeyFromAppStorage, sendBiEvent, getCommandsRegistrations, executeCommand, getExecutionStatus, registerActionAsCommand, fetchDataSourceCredentials, } from './services';
 export { deployServer, ServerInit } from './server';

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,7 +14,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.deployServer = exports.executeHttpGet = exports.saveInStorage = exports.getValueFromAppStorage = exports.uploadAttachment = exports.updateActionStatusToBigID = void 0;
+exports.deployServer = exports.fetchDataSourceCredentials = exports.registerActionAsCommand = exports.getExecutionStatus = exports.executeCommand = exports.getCommandsRegistrations = exports.sendBiEvent = exports.deleteKeyFromAppStorage = exports.unscheduleAllFunctions = exports.unscheduleFunction = exports.scheduleFunction = exports.executeHttpGet = exports.saveInStorage = exports.getValueFromAppStorage = exports.uploadAttachment = exports.updateActionStatusToBigID = void 0;
 __exportStar(require("./abstractProviders"), exports);
 __exportStar(require("./dto"), exports);
 __exportStar(require("./utils"), exports);
@@ -20,5 +24,15 @@ Object.defineProperty(exports, "uploadAttachment", { enumerable: true, get: func
 Object.defineProperty(exports, "getValueFromAppStorage", { enumerable: true, get: function () { return services_1.getValueFromAppStorage; } });
 Object.defineProperty(exports, "saveInStorage", { enumerable: true, get: function () { return services_1.saveInStorage; } });
 Object.defineProperty(exports, "executeHttpGet", { enumerable: true, get: function () { return services_1.executeHttpGet; } });
+Object.defineProperty(exports, "scheduleFunction", { enumerable: true, get: function () { return services_1.scheduleFunction; } });
+Object.defineProperty(exports, "unscheduleFunction", { enumerable: true, get: function () { return services_1.unscheduleFunction; } });
+Object.defineProperty(exports, "unscheduleAllFunctions", { enumerable: true, get: function () { return services_1.unscheduleAllFunctions; } });
+Object.defineProperty(exports, "deleteKeyFromAppStorage", { enumerable: true, get: function () { return services_1.deleteKeyFromAppStorage; } });
+Object.defineProperty(exports, "sendBiEvent", { enumerable: true, get: function () { return services_1.sendBiEvent; } });
+Object.defineProperty(exports, "getCommandsRegistrations", { enumerable: true, get: function () { return services_1.getCommandsRegistrations; } });
+Object.defineProperty(exports, "executeCommand", { enumerable: true, get: function () { return services_1.executeCommand; } });
+Object.defineProperty(exports, "getExecutionStatus", { enumerable: true, get: function () { return services_1.getExecutionStatus; } });
+Object.defineProperty(exports, "registerActionAsCommand", { enumerable: true, get: function () { return services_1.registerActionAsCommand; } });
+Object.defineProperty(exports, "fetchDataSourceCredentials", { enumerable: true, get: function () { return services_1.fetchDataSourceCredentials; } });
 var server_1 = require("./server");
 Object.defineProperty(exports, "deployServer", { enumerable: true, get: function () { return server_1.deployServer; } });

package/lib/server.d.ts

@@ -1,10 +1,14 @@
-import { ManifestProvider } from "./abstractProviders/manifestProvider";
-import { IconsProviders } from "./abstractProviders/iconsProviders";
-import { ExecutionProvider } from "./abstractProviders/executionProvider";
-export interface ServerInit {
+import { Express } from 'express';
+import { ManifestProvider } from './abstractProviders';
+import { IconsProviders } from './abstractProviders';
+import { ExecutionProvider } from './abstractProviders/executionProvider';
+import { ConfigureProvider } from './abstractProviders/configureProvider';
+export type ServerInit = {
     manifestController: ManifestProvider;
     iconsController: IconsProviders;
-    executionController: ExecutionProvider;
+    executionController?: ExecutionProvider;
+    configureController?: ConfigureProvider;
     serverPort?: number;
-}
-export declare const deployServer: (serverInit: ServerInit) => void;
+    additionalEndpoints?: (app: Express) => void;
+};
+export declare const deployServer: ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, }: ServerInit) => void;

package/lib/server.js

@@ -14,34 +14,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployServer = void 0;
 const express_1 = __importDefault(require("express"));
-const appLogger_1 = require("./utils/appLogger");
+const utils_1 = require("./utils");
 const executionProvider_1 = require("./abstractProviders/executionProvider");
 const logsProvider_1 = require("./abstractProviders/logsProvider");
 const http_errors_1 = __importDefault(require("http-errors"));
-;
+const configureProvider_1 = require("./abstractProviders/configureProvider");
 const app = (0, express_1.default)();
-const deployServer = (serverInit) => {
+const deployServer = ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, }) => {
     app.use(express_1.default.json());
     app.use(express_1.default.urlencoded({ extended: false }));
-    app.get('/assets/icon', (req, res) => res.sendFile(serverInit.iconsController.getIconPath()));
-    app.get('/assets/sideBarIcon', (req, res) => res.sendFile(serverInit.iconsController.getSideBarIconPath()));
-    app.get('/manifest', serverInit.manifestController.getManifest);
-    app.post('/execute', (req, res) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, executionProvider_1.handleExecution)(req, res, serverInit.executionController); }));
-    app.get('/logs', logsProvider_1.fetchLogs);
-    app.listen(serverInit.serverPort || process.env.PORT, () => appLogger_1.appLogger.info(`Started server at port ${serverInit.serverPort || process.env.PORT}`));
+    app.get('/assets/icon', (req, res) => res.sendFile(iconsController.getIconPath()));
+    app.get('/assets/sideBarIcon', (req, res) => res.sendFile(iconsController.getSideBarIconPath()));
+    app.get('/manifest', manifestController.getManifest);
+    app.get('/logs', (req, res) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, logsProvider_1.fetchLogs)(req, res); }));
+    executionController &&
+        app.post('/execute', (req, res) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, executionProvider_1.handleExecution)(req, res, executionController); }));
+    configureController &&
+        app.post('/configure', (req, res) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, configureProvider_1.handleTenantConfigure)(req, res, configureController); }));
+    additionalEndpoints && additionalEndpoints(app);
+    app.listen(process.env.PORT || serverPort, () => (0, utils_1.logInfo)(`Started server at port ${process.env.PORT || serverPort}`));
     // catch 404 and forward to error handler
     app.use((req, res, next) => next((0, http_errors_1.default)(404)));
     // error handler
     app.use((err, req, res, next) => {
         const { message, status } = err;
-        appLogger_1.appLogger.error(err);
+        (0, utils_1.logError)(err);
         res.locals.message = message;
         res.locals.error = req.app.get('env') === 'development' ? err : {};
         res.status(status || 500);
         res.json({
-            status: "error",
+            status: 'error',
             statusCode: status || 500,
-            message
+            message,
         });
     });
 };

package/lib/services/actionsHubService.d.ts

@@ -0,0 +1,45 @@
+export type Param = {
+    name: string;
+    value: string;
+};
+export type Command = {
+    actionName: string;
+    command: string;
+    params: Param[];
+    id: string;
+};
+/**
+ * use this method to get the currently registered action-center commands.
+ * the method is building an execution context for the api call, so you must provide REFRESH_TOKEN and BIGID_BASE_URL as ENV variables
+ *
+ * @return {Promise<Command[]>} array of the action-center register commands
+ */
+export declare const getCommandsRegistrations: () => 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.
+ * the execution id can be used to poll the current execution status of the executed command.
+ *
+ * @param {string} actionName - the action name to be executed.
+ * @param {string} command    - the command to be executed.
+ * @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.
+ * @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>;
+/**
+ * use this method to poll an execution status from the action-center.
+ *
+ * @param {string} execution - the execution id to poll status for.
+ * @return object with the updated status details.
+ */
+export declare const getExecutionStatus: (executionId: 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.
+ */
+export declare const registerActionAsCommand: (applicationName: string, actionName: string, command: string) => Promise<void>;

package/lib/services/actionsHubService.js

@@ -0,0 +1,105 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerActionAsCommand = exports.getExecutionStatus = exports.executeCommand = exports.getCommandsRegistrations = void 0;
+const bigidProxyService_1 = require("./bigidProxyService");
+const tokenUtil_1 = require("../utils/tokenUtil");
+const REFRESH_TOKEN = process.env.BIGID_REFRESH_TOKEN;
+const getBigidAccessToken = () => __awaiter(void 0, void 0, void 0, function* () {
+    if (!REFRESH_TOKEN) {
+        throw new Error('BIGID_REFRESH_TOKEN must be supplied as an ENV var in order to call bigid actions hub');
+    }
+    return yield (0, tokenUtil_1.getAccessTokenFromRefreshToken)(REFRESH_TOKEN);
+});
+/**
+ * use this method to get the currently registered action-center commands.
+ * the method is building an execution context for the api call, so you must provide REFRESH_TOKEN and BIGID_BASE_URL as ENV variables
+ *
+ * @return {Promise<Command[]>} array of the action-center register commands
+ */
+const getCommandsRegistrations = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const bigidToken = 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;
+    }
+    catch (e) {
+        throw new Error(`Could not get commands registrations from bigid: ${e}`);
+    }
+});
+exports.getCommandsRegistrations = getCommandsRegistrations;
+/**
+ * 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.
+ * the execution id can be used to poll the current execution status of the executed command.
+ *
+ * @param {string} actionName - the action name to be executed.
+ * @param {string} command    - the command to be executed.
+ * @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.
+ * @return {Promise<string>} execution id of the executed action.
+ */
+const executeCommand = (actionName, command, requestorAppName, webhookEndpoint, params) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const bigidToken = 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
+                ? {
+                    requestorAppName,
+                    requestorFeedbackEndpoint: webhookEndpoint,
+                }
+                : null }, (params && { params })));
+        return executionId;
+    }
+    catch (e) {
+        throw new Error(`Could not execute ${command}: ${e}`);
+    }
+});
+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.
+ * @return object with the updated status details.
+ */
+const getExecutionStatus = (executionId) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const bigidToken = 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;
+    }
+    catch (e) {
+        throw new Error(`Could not get status for execution id ${executionId}: ${e}`);
+    }
+});
+exports.getExecutionStatus = getExecutionStatus;
+/**
+ * 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.
+ */
+const registerActionAsCommand = (applicationName, actionName, command) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const bigidToken = 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,
+            command,
+        });
+    }
+    catch (e) {
+        throw new Error(`Could not register ${command}: ${e}`);
+    }
+});
+exports.registerActionAsCommand = registerActionAsCommand;

package/lib/services/batchProcessManager.d.ts

@@ -0,0 +1,2 @@
+export type BatchFunction = (tenantId: string, tenantDomain: string, tenantToken: string) => void;
+export declare const handleBatchProcess: (callback: BatchFunction) => Promise<void>;