@bigid/apps-infrastructure-node-js 1.213.0 → 1.218.0

package/lib/dto/appsConfigurationsManagement.d.ts

@@ -0,0 +1,20 @@
+import { ExecutionContext } from "./executionContext";
+export interface TokenOptions {
+    executionContext?: ExecutionContext;
+    accessToken?: string;
+}
+export interface AppConfigurationsParams {
+    key: string;
+    executionContext?: ExecutionContext;
+    accessToken?: string;
+    bigidUrl?: string;
+}
+export type CacheEntry = {
+    value: string | null;
+    expiry: number;
+};
+export type AppsConfigurationsManagement = {
+    appName: string;
+    shouldInitAppConfigurationsPollingFromBigID?: boolean;
+    manifest: Record<string, any>;
+};

package/lib/dto/appsConfigurationsManagement.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/dto/executionContext.d.ts

@@ -7,6 +7,7 @@ export type ExecutionContext = {
     bigidToken: string;
     updateResultCallback: any;
     tpaId: string;
+    tpaName: string;
 };
 export type GeneralParam = {
     paramName: 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, scheduleFunction, unscheduleFunction, unscheduleAllFunctions, deleteKeyFromAppStorage, sendBiEvent, getCommandsRegistrations, executeCommand, getExecutionStatus, registerActionAsCommand, fetchDataSourceCredentials, } from './services';
+export { updateActionStatusToBigID, uploadAttachment, getValueFromAppStorage, saveInStorage, executeHttpGet, scheduleFunction, unscheduleFunction, unscheduleAllFunctions, deleteKeyFromAppStorage, sendBiEvent, getCommandsRegistrations, executeCommand, getExecutionStatus, registerActionAsCommand, fetchDataSourceCredentials, getAppConfiguration, } from './services';
 export { deployServer, ServerInit } from './server';

package/lib/index.js

@@ -14,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.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;
+exports.deployServer = exports.getAppConfiguration = 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);
@@ -34,5 +34,6 @@ Object.defineProperty(exports, "executeCommand", { enumerable: true, get: functi
 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; } });
+Object.defineProperty(exports, "getAppConfiguration", { enumerable: true, get: function () { return services_1.getAppConfiguration; } });
 var server_1 = require("./server");
 Object.defineProperty(exports, "deployServer", { enumerable: true, get: function () { return server_1.deployServer; } });

package/lib/server.d.ts

@@ -3,6 +3,7 @@ import { ManifestProvider } from './abstractProviders';
 import { IconsProviders } from './abstractProviders';
 import { ExecutionProvider } from './abstractProviders/executionProvider';
 import { ConfigureProvider } from './abstractProviders/configureProvider';
+import { AppsConfigurationsManagement } from './dto/appsConfigurationsManagement';
 export type ServerInit = {
     manifestController: ManifestProvider;
     iconsController: IconsProviders;
@@ -13,5 +14,6 @@ export type ServerInit = {
     expressBodyLimit?: string;
     signatureValidationEnabled?: boolean;
     baseUrl?: string;
+    appConfigurationsManagement?: AppsConfigurationsManagement;
 };
-export declare const deployServer: ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, expressBodyLimit, signatureValidationEnabled, baseUrl, }: ServerInit) => void;
+export declare const deployServer: ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, expressBodyLimit, signatureValidationEnabled, baseUrl, appConfigurationsManagement, }: ServerInit) => void;

package/lib/server.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {
@@ -44,13 +54,26 @@ const logsProvider_1 = require("./abstractProviders/logsProvider");
 const http_errors_1 = __importDefault(require("http-errors"));
 const configureProvider_1 = require("./abstractProviders/configureProvider");
 const signatureValidationInterceptor_1 = require("./interceptor/signatureValidationInterceptor");
+const appsConfigurationsManagementService_1 = require("./services/appsConfigurationsManagementService");
 const app = (0, express_1.default)();
-const deployServer = ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, expressBodyLimit, signatureValidationEnabled = false, baseUrl, }) => {
+const deployServer = ({ manifestController, iconsController, executionController, serverPort, configureController, additionalEndpoints, expressBodyLimit, signatureValidationEnabled = false, baseUrl, appConfigurationsManagement, }) => {
+    if (appConfigurationsManagement) {
+        (0, appsConfigurationsManagementService_1.initAppConfigurationsManagement)(appConfigurationsManagement)
+            .then(() => (0, utils_1.logInfo)('App configurations management initialized successfully'))
+            .catch(err => (0, utils_1.logError)('Failed to initialize App configurations management, err:', err));
+    }
     app.use(express_1.default.urlencoded({ extended: false }));
     app.use(bodyParser.json({ limit: expressBodyLimit || '5mb' }));
     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('/manifest', (req, res) => {
+        const originalSend = res.send.bind(res);
+        res.send = (manifestString) => {
+            const enrichedBody = (0, appsConfigurationsManagementService_1.enrichManifestWithEnvConfigurations)(manifestString);
+            return originalSend(enrichedBody);
+        };
+        manifestController.getManifest(req, res);
+    });
     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', signatureValidationEnabled ? (0, signatureValidationInterceptor_1.signatureValidationInterceptor)(baseUrl) : (req, res, next) => next(), (req, res) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, executionProvider_1.handleExecution)(req, res, executionController); }));

package/lib/services/actionsHubService.js

@@ -12,13 +12,6 @@ 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
@@ -27,7 +20,7 @@ const getBigidAccessToken = () => __awaiter(void 0, void 0, void 0, function* ()
  */
 const getCommandsRegistrations = (accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = accessToken || (yield getBigidAccessToken());
+        const bigidToken = accessToken || (yield (0, tokenUtil_1.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;
     }
@@ -51,7 +44,7 @@ exports.getCommandsRegistrations = getCommandsRegistrations;
  */
 const executeCommand = (actionName, command, requestorAppName, webhookEndpoint, params, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = accessToken || (yield getBigidAccessToken());
+        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
                 ? {
@@ -75,7 +68,7 @@ exports.executeCommand = executeCommand;
  */
 const getExecutionStatus = (executionId, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = accessToken || (yield getBigidAccessToken());
+        const bigidToken = accessToken || (yield (0, tokenUtil_1.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;
     }
@@ -94,7 +87,7 @@ exports.getExecutionStatus = getExecutionStatus;
  */
 const registerActionAsCommand = (applicationName, actionName, command, accessToken) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const bigidToken = accessToken || (yield getBigidAccessToken());
+        const bigidToken = accessToken || (yield (0, tokenUtil_1.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/appsConfigurationsManagementService.d.ts

@@ -0,0 +1,4 @@
+import { AppsConfigurationsManagement, AppConfigurationsParams } from '../dto/appsConfigurationsManagement';
+export declare const initAppConfigurationsManagement: (appsConfigurationsManagement: AppsConfigurationsManagement) => Promise<void>;
+export declare const getAppConfiguration: (appConfigurationsParams: AppConfigurationsParams) => Promise<string | null>;
+export declare const enrichManifestWithEnvConfigurations: (originalManifestString: string) => string;

package/lib/services/appsConfigurationsManagementService.js

@@ -0,0 +1,154 @@
+"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.enrichManifestWithEnvConfigurations = exports.getAppConfiguration = exports.initAppConfigurationsManagement = void 0;
+const bigidProxyService_1 = require("./bigidProxyService");
+const tokenUtil_1 = require("../utils/tokenUtil");
+const tokenUtil_2 = require("../utils/tokenUtil");
+const schedulerService_1 = require("./schedulerService");
+const batchProcessManager_1 = require("./batchProcessManager");
+const utils_1 = require("../utils");
+const APP_CONFIGURATIONS_CACHE_TTL = 10 * 1000;
+const appConfigurationsCache = new Map();
+let appConfigurationsManagementParams;
+const initAppConfigurationsManagement = (appsConfigurationsManagement) => __awaiter(void 0, void 0, void 0, function* () {
+    setAppConfigurationsManagementParams(appsConfigurationsManagement);
+    const { shouldInitAppConfigurationsPollingFromBigID: shouldInitAppConfigurationsPollingFromBigID, appName } = appsConfigurationsManagement;
+    if (process.env.BIGID_BASE_URL && appName) {
+        yield initApplicationConfigurationInConfigServer();
+        if (shouldInitAppConfigurationsPollingFromBigID) {
+            (0, schedulerService_1.scheduleFunction)('AppConfigurationsInCachePerTenant', '* * * * *', updateAppConfigurationsInCache);
+        }
+    }
+});
+exports.initAppConfigurationsManagement = initAppConfigurationsManagement;
+const setAppConfigurationsManagementParams = (AppConfigurationsManagement) => {
+    appConfigurationsManagementParams = AppConfigurationsManagement;
+};
+const initApplicationConfigurationInConfigServer = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        if ((0, schedulerService_1.isMultiTenantMode)()) {
+            yield (0, batchProcessManager_1.handleBatchProcess)(setApplicationConfigurationInConfigServer);
+        }
+        else {
+            const token = yield (0, tokenUtil_1.getBigidAccessToken)();
+            const decodedToken = (0, tokenUtil_2.decodeToken)(token);
+            const tenantId = (decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.tenantId) || 'SINGLE_TENANT';
+            yield setApplicationConfigurationInConfigServer(tenantId, '', token);
+        }
+    }
+    catch (e) {
+        throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+    }
+});
+const setApplicationConfigurationInConfigServer = (tenantId, url, token) => __awaiter(void 0, void 0, void 0, function* () {
+    const baseUrl = url || process.env.BIGID_BASE_URL;
+    if (!baseUrl || !(appConfigurationsManagementParams === null || appConfigurationsManagementParams === void 0 ? void 0 : appConfigurationsManagementParams.manifest)) {
+        throw new Error(`url and manifest must be provided`);
+    }
+    try {
+        const initAppConfigurationsEndPoint = createUrl(baseUrl, generateTpaConfigurationEndpoint(appConfigurationsManagementParams.appName));
+        const manifestString = JSON.stringify(appConfigurationsManagementParams.manifest);
+        const enrichedManifestString = (0, exports.enrichManifestWithEnvConfigurations)(manifestString);
+        const manifest = JSON.parse(enrichedManifestString);
+        yield (0, bigidProxyService_1.doCallToUrl)(token, bigidProxyService_1.RequestMethod.POST, initAppConfigurationsEndPoint, { manifest });
+    }
+    catch (e) {
+        throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+    }
+});
+const updateAppConfigurationsInCache = (tenantId, url, token) => __awaiter(void 0, void 0, void 0, function* () {
+    const decodedToken = (0, tokenUtil_2.decodeToken)(token);
+    const primaryKey = (decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.tenantId) || tenantId || token;
+    try {
+        const allAppConfigurations = yield fetchAppConfigurations(token, url);
+        updateAppConfigurationInCache(primaryKey, allAppConfigurations);
+    }
+    catch (e) {
+        throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+    }
+});
+const getAppConfiguration = (appConfigurationsParams) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const { key, executionContext, accessToken, bigidUrl } = appConfigurationsParams;
+    if (!(appConfigurationsManagementParams === null || appConfigurationsManagementParams === void 0 ? void 0 : appConfigurationsManagementParams.appName)) {
+        throw new Error('The appName parameter must be provided to the deployServer function to enable calling the getAppConfiguration function.');
+    }
+    const token = (executionContext === null || executionContext === void 0 ? void 0 : executionContext.bigidToken) || accessToken || (yield (0, tokenUtil_1.getBigidAccessToken)());
+    const decodedToken = (0, tokenUtil_2.decodeToken)(token);
+    const url = (_a = ((executionContext === null || executionContext === void 0 ? void 0 : executionContext.bigidBaseUrl) || bigidUrl || process.env.BIGID_BASE_URL)) === null || _a === void 0 ? void 0 : _a.replace('/api/v1', '');
+    if (!url || !token) {
+        throw new Error(`url and token must be provided`);
+    }
+    const primaryKey = (decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.tenantId) || token;
+    const secondaryKey = key;
+    const cachedValue = getAppConfigurationFromCache(primaryKey, secondaryKey);
+    if (cachedValue !== null) {
+        return cachedValue;
+    }
+    try {
+        const appConfigurationsValues = yield fetchAppConfigurations(token, url, executionContext === null || executionContext === void 0 ? void 0 : executionContext.tpaName);
+        const appConfigurationValue = appConfigurationsValues[key];
+        updateAppConfigurationInCache(primaryKey, appConfigurationsValues);
+        return appConfigurationValue;
+    }
+    catch (e) {
+        throw new Error(`Could not get app configuration: ${key} from BigID: ${e}`);
+    }
+});
+exports.getAppConfiguration = getAppConfiguration;
+const fetchAppConfigurations = (token, url, appNameFromExecutionContext) => __awaiter(void 0, void 0, void 0, function* () {
+    const appConfigurationsEndPoint = createUrl(url, generateTpaConfigurationEndpoint(appNameFromExecutionContext !== null && appNameFromExecutionContext !== void 0 ? appNameFromExecutionContext : appConfigurationsManagementParams.appName));
+    const { data = {} } = yield (0, bigidProxyService_1.doCallToUrl)(token, bigidProxyService_1.RequestMethod.GET, appConfigurationsEndPoint);
+    return data;
+});
+const updateAppConfigurationInCache = (primaryKey, appConfigurationsRecord) => {
+    const expiry = Date.now() + APP_CONFIGURATIONS_CACHE_TTL;
+    let existingSecondaryCache = appConfigurationsCache.get(primaryKey);
+    if (!existingSecondaryCache) {
+        existingSecondaryCache = new Map();
+        appConfigurationsCache.set(primaryKey, existingSecondaryCache);
+    }
+    for (const [secondaryKey, value] of Object.entries(appConfigurationsRecord)) {
+        existingSecondaryCache.set(secondaryKey, { value, expiry });
+    }
+};
+const getAppConfigurationFromCache = (primaryKey, secondaryKey) => {
+    const secondaryCache = appConfigurationsCache.get(primaryKey);
+    if (!secondaryCache) {
+        return null;
+    }
+    const entry = secondaryCache.get(secondaryKey);
+    if (entry && entry.expiry > Date.now()) {
+        return entry.value;
+    }
+    secondaryCache.delete(secondaryKey);
+    if (secondaryCache.size === 0) {
+        appConfigurationsCache.delete(primaryKey);
+    }
+    return null;
+};
+const createUrl = (baseUrl, path) => {
+    const normalizedBaseUrl = baseUrl.startsWith('http') ? baseUrl : `https://${baseUrl}`;
+    return new URL(path, normalizedBaseUrl).href;
+};
+const enrichManifestWithEnvConfigurations = (originalManifestString) => {
+    const manifestJson = JSON.parse(originalManifestString);
+    if (manifestJson['app_configurations']) {
+        manifestJson['app_configurations'].env = process.env;
+    }
+    (0, utils_1.logInfo)(`App manifest was enriched with env vars for app_configurations section`);
+    return JSON.stringify(manifestJson);
+};
+exports.enrichManifestWithEnvConfigurations = enrichManifestWithEnvConfigurations;
+const generateTpaConfigurationEndpoint = (appName) => {
+    return `api/v1/tpa/app-configurations/${appName}`;
+};

package/lib/services/encryptionService.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decryptWithKey = exports.decrypt = void 0;
 const crypto = __importStar(require("crypto"));

package/lib/services/index.d.ts

@@ -2,3 +2,4 @@ export * from './bigidProxyService';
 export * from './dataSourceService';
 export * from './actionsHubService';
 export { scheduleFunction, unscheduleAllFunctions, unscheduleFunction } from './schedulerService';
+export { getAppConfiguration } from './appsConfigurationsManagementService';

package/lib/services/index.js

@@ -14,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.unscheduleFunction = exports.unscheduleAllFunctions = exports.scheduleFunction = void 0;
+exports.getAppConfiguration = exports.unscheduleFunction = exports.unscheduleAllFunctions = exports.scheduleFunction = void 0;
 __exportStar(require("./bigidProxyService"), exports);
 __exportStar(require("./dataSourceService"), exports);
 __exportStar(require("./actionsHubService"), exports);
@@ -22,3 +22,5 @@ var schedulerService_1 = require("./schedulerService");
 Object.defineProperty(exports, "scheduleFunction", { enumerable: true, get: function () { return schedulerService_1.scheduleFunction; } });
 Object.defineProperty(exports, "unscheduleAllFunctions", { enumerable: true, get: function () { return schedulerService_1.unscheduleAllFunctions; } });
 Object.defineProperty(exports, "unscheduleFunction", { enumerable: true, get: function () { return schedulerService_1.unscheduleFunction; } });
+var appsConfigurationsManagementService_1 = require("./appsConfigurationsManagementService");
+Object.defineProperty(exports, "getAppConfiguration", { enumerable: true, get: function () { return appsConfigurationsManagementService_1.getAppConfiguration; } });

package/lib/services/schedulerService.d.ts

@@ -9,3 +9,4 @@ import { BatchFunction } from './batchProcessManager';
 export declare const scheduleFunction: (batchUN: string, cronExpression: string, callback: BatchFunction) => void;
 export declare const unscheduleFunction: (batchUN: string) => void;
 export declare const unscheduleAllFunctions: () => void;
+export declare const isMultiTenantMode: () => boolean;

package/lib/services/schedulerService.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unscheduleAllFunctions = exports.unscheduleFunction = exports.scheduleFunction = void 0;
+exports.isMultiTenantMode = exports.unscheduleAllFunctions = exports.unscheduleFunction = exports.scheduleFunction = void 0;
 const batchProcessManager_1 = require("./batchProcessManager");
 const node_schedule_1 = require("node-schedule");
 const tokenUtil_1 = require("../utils/tokenUtil");
@@ -27,7 +27,7 @@ const scheduleSingleTenantProcess = (batchUN, cronExpression, callback) => __awa
  * @param callback - the function that will be called.
  */
 const scheduleFunction = (batchUN, cronExpression, callback) => {
-    process.env.MULTI_TENANT_MODE
+    (0, exports.isMultiTenantMode)()
         ? (0, node_schedule_1.scheduleJob)(batchUN, cronExpression, () => (0, batchProcessManager_1.handleBatchProcess)(callback))
         : scheduleSingleTenantProcess(batchUN, cronExpression, callback);
 };
@@ -39,3 +39,7 @@ const unscheduleFunction = (batchUN) => {
 exports.unscheduleFunction = unscheduleFunction;
 const unscheduleAllFunctions = () => Object.keys(node_schedule_1.scheduledJobs).forEach(jobName => node_schedule_1.scheduledJobs[jobName].cancel());
 exports.unscheduleAllFunctions = unscheduleAllFunctions;
+const isMultiTenantMode = () => {
+    return [true, 'true'].includes(process.env.MULTI_TENANT_MODE || '');
+};
+exports.isMultiTenantMode = isMultiTenantMode;

package/lib/utils/tokenUtil.d.ts

@@ -1,4 +1,7 @@
+import { JwtPayload } from 'jsonwebtoken';
+export declare const getBigidAccessToken: () => Promise<string>;
 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>;
+export declare const decodeToken: (token: string) => JwtPayload;

package/lib/utils/tokenUtil.js

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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) {
@@ -12,11 +45,12 @@ 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.getTokenByUsernameAndPassword = exports.getAccessTokenFromRefreshToken = void 0;
+exports.decodeToken = exports.tokenExchange = exports.getAuth0Token = exports.getTokenByUsernameAndPassword = exports.getAccessTokenFromRefreshToken = exports.getBigidAccessToken = void 0;
 const axios_1 = __importDefault(require("axios"));
 const https_1 = require("https");
 const services_1 = require("../services");
 const appLogger_1 = require("./appLogger");
+const jwt = __importStar(require("jsonwebtoken"));
 const auth0Payload = {
     client_id: process.env.CLIENT_ID,
     client_secret: process.env.CLIENT_SECRET,
@@ -25,6 +59,14 @@ const auth0Payload = {
 };
 let auth0Token;
 let accessToken;
+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, exports.getAccessTokenFromRefreshToken)(REFRESH_TOKEN);
+});
+exports.getBigidAccessToken = getBigidAccessToken;
 const getAccessTokenFromRefreshToken = (refreshToken) => __awaiter(void 0, void 0, void 0, function* () {
     if (canUseLocalToken(accessToken))
         return accessToken;
@@ -78,3 +120,8 @@ const canUseLocalToken = (token) => {
     const { exp } = getTokenPayloadAsJson(token);
     return Date.now() < exp * 1000;
 };
+const decodeToken = (token) => {
+    const decodedToken = jwt.decode(token);
+    return decodedToken;
+};
+exports.decodeToken = decodeToken;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigid/apps-infrastructure-node-js",
-  "version": "1.213.0",
+  "version": "1.218.0",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -31,11 +31,13 @@
     "typescript": "^4.5.2"
   },
   "dependencies": {
+    "@types/jsonwebtoken": "^9.0.7",
     "axios": "1.7.4",
     "express": "4.21.0",
     "follow-redirects": "1.15.6",
     "form-data": "^4.0.0",
     "http-errors": "^1.8.1",
+    "jsonwebtoken": "^9.0.2",
     "log4js": "^6.4.0",
     "minimatch": "3.0.5",
     "mocha": "10.2.0",

package/src/dto/appsConfigurationsManagement.ts

@@ -0,0 +1,24 @@
+import { ExecutionContext } from "./executionContext";
+
+export interface TokenOptions {
+  executionContext?: ExecutionContext;
+  accessToken?: string;
+}
+
+export interface AppConfigurationsParams {
+  key: string;
+  executionContext?: ExecutionContext;
+  accessToken?: string;
+  bigidUrl?: string;
+}
+
+export type CacheEntry = {
+  value: string | null;
+  expiry: number;
+};
+
+export type AppsConfigurationsManagement = {
+  appName: string;
+  shouldInitAppConfigurationsPollingFromBigID?: boolean;
+  manifest: Record<string, any>;
+};

package/src/dto/executionContext.ts

@@ -7,6 +7,7 @@ export type ExecutionContext = {
   bigidToken: string;
   updateResultCallback: any;
   tpaId: string;
+  tpaName: string;
 };
 
 export type GeneralParam = {

package/src/index.ts

@@ -17,5 +17,6 @@ export {
   getExecutionStatus,
   registerActionAsCommand,
   fetchDataSourceCredentials,
+  getAppConfiguration,
 } from './services';
 export { deployServer, ServerInit } from './server';

package/src/server.ts

@@ -8,6 +8,11 @@ import { fetchLogs } from './abstractProviders/logsProvider';
 import createError from 'http-errors';
 import { ConfigureProvider, handleTenantConfigure } from './abstractProviders/configureProvider';
 import { signatureValidationInterceptor } from './interceptor/signatureValidationInterceptor';
+import { AppsConfigurationsManagement } from './dto/appsConfigurationsManagement';
+import {
+  enrichManifestWithEnvConfigurations,
+  initAppConfigurationsManagement,
+} from './services/appsConfigurationsManagementService';
 
 export type ServerInit = {
   manifestController: ManifestProvider;
@@ -19,6 +24,7 @@ export type ServerInit = {
   expressBodyLimit?: string;
   signatureValidationEnabled?: boolean;
   baseUrl?: string;
+  appConfigurationsManagement?: AppsConfigurationsManagement;
 };
 
 const app = express();
@@ -33,13 +39,28 @@ export const deployServer = ({
   expressBodyLimit,
   signatureValidationEnabled = false,
   baseUrl,
+  appConfigurationsManagement,
 }: ServerInit): void => {
+  if (appConfigurationsManagement) {
+    initAppConfigurationsManagement(appConfigurationsManagement)
+      .then(() => logInfo('App configurations management initialized successfully'))
+      .catch(err => logError('Failed to initialize App configurations management, err:', err));
+  }
   app.use(express.urlencoded({ extended: false }));
   app.use(bodyParser.json({ limit: expressBodyLimit || '5mb' }));
 
   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('/manifest', (req, res) => {
+    const originalSend = res.send.bind(res);
+    res.send = (manifestString: string) => {
+      const enrichedBody = enrichManifestWithEnvConfigurations(manifestString);
+      return originalSend(enrichedBody);
+    };
+    manifestController.getManifest(req, res);
+  });
+
   app.get('/logs', async (req: Request, res: Response) => await fetchLogs(req, res));
 
   executionController &&

package/src/services/actionsHubService.ts

@@ -1,15 +1,5 @@
 import { doCallToUrl, RequestMethod } from './bigidProxyService';
-import { getAccessTokenFromRefreshToken } from '../utils/tokenUtil';
-
-const REFRESH_TOKEN = process.env.BIGID_REFRESH_TOKEN;
-
-const getBigidAccessToken = async (): Promise<string> => {
-  if (!REFRESH_TOKEN) {
-    throw new Error('BIGID_REFRESH_TOKEN must be supplied as an ENV var in order to call bigid actions hub');
-  }
-
-  return await getAccessTokenFromRefreshToken(REFRESH_TOKEN);
-};
+import { getBigidAccessToken } from '../utils/tokenUtil';
 
 export type Param = {
   name: string;

package/src/services/appsConfigurationsManagementService.ts

@@ -0,0 +1,168 @@
+import { doCallToUrl, RequestMethod } from './bigidProxyService';
+import { getBigidAccessToken } from '../utils/tokenUtil';
+import { CacheEntry, AppsConfigurationsManagement, AppConfigurationsParams } from '../dto/appsConfigurationsManagement';
+import { decodeToken } from '../utils/tokenUtil';
+import { isMultiTenantMode, scheduleFunction } from './schedulerService';
+import { handleBatchProcess } from './batchProcessManager';
+import { logInfo } from '../utils';
+
+const APP_CONFIGURATIONS_CACHE_TTL = 10 * 1000;
+
+const appConfigurationsCache: Map<string, Map<string, CacheEntry>> = new Map();
+let appConfigurationsManagementParams: AppsConfigurationsManagement;
+
+export const initAppConfigurationsManagement = async (
+  appsConfigurationsManagement: AppsConfigurationsManagement,
+): Promise<void> => {
+  setAppConfigurationsManagementParams(appsConfigurationsManagement);
+  const { shouldInitAppConfigurationsPollingFromBigID: shouldInitAppConfigurationsPollingFromBigID, appName } =
+    appsConfigurationsManagement;
+  if (process.env.BIGID_BASE_URL && appName) {
+    await initApplicationConfigurationInConfigServer();
+    if (shouldInitAppConfigurationsPollingFromBigID) {
+      scheduleFunction('AppConfigurationsInCachePerTenant', '* * * * *', updateAppConfigurationsInCache);
+    }
+  }
+};
+
+const setAppConfigurationsManagementParams = (AppConfigurationsManagement: AppsConfigurationsManagement): void => {
+  appConfigurationsManagementParams = AppConfigurationsManagement;
+};
+
+const initApplicationConfigurationInConfigServer = async (): Promise<void> => {
+  try {
+    if (isMultiTenantMode()) {
+      await handleBatchProcess(setApplicationConfigurationInConfigServer);
+    } else {
+      const token = await getBigidAccessToken();
+      const decodedToken = decodeToken(token);
+      const tenantId = decodedToken?.tenantId || 'SINGLE_TENANT';
+      await setApplicationConfigurationInConfigServer(tenantId, '', token);
+    }
+  } catch (e) {
+    throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+  }
+};
+
+const setApplicationConfigurationInConfigServer = async (
+  tenantId: string,
+  url: string,
+  token: string,
+): Promise<void> => {
+  const baseUrl = url || process.env.BIGID_BASE_URL;
+  if (!baseUrl || !appConfigurationsManagementParams?.manifest) {
+    throw new Error(`url and manifest must be provided`);
+  }
+  try {
+    const initAppConfigurationsEndPoint = createUrl(
+      baseUrl,
+      generateTpaConfigurationEndpoint(appConfigurationsManagementParams.appName),
+    );
+    const manifestString = JSON.stringify(appConfigurationsManagementParams.manifest);
+    const enrichedManifestString = enrichManifestWithEnvConfigurations(manifestString);
+    const manifest = JSON.parse(enrichedManifestString);
+    await doCallToUrl(token, RequestMethod.POST, initAppConfigurationsEndPoint, { manifest });
+  } catch (e) {
+    throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+  }
+};
+
+const updateAppConfigurationsInCache = async (tenantId: string, url: string, token: string): Promise<void> => {
+  const decodedToken = decodeToken(token);
+  const primaryKey = decodedToken?.tenantId || tenantId || token;
+  try {
+    const allAppConfigurations = await fetchAppConfigurations(token, url);
+    updateAppConfigurationInCache(primaryKey, allAppConfigurations);
+  } catch (e) {
+    throw new Error(`Could not get/update app configurations from BigID: ${e}`);
+  }
+};
+
+export const getAppConfiguration = async (appConfigurationsParams: AppConfigurationsParams): Promise<string | null> => {
+  const { key, executionContext, accessToken, bigidUrl } = appConfigurationsParams;
+  if (!appConfigurationsManagementParams?.appName) {
+    throw new Error(
+      'The appName parameter must be provided to the deployServer function to enable calling the getAppConfiguration function.',
+    );
+  }
+  const token = executionContext?.bigidToken || accessToken || (await getBigidAccessToken());
+  const decodedToken = decodeToken(token);
+  const url = (executionContext?.bigidBaseUrl || bigidUrl || process.env.BIGID_BASE_URL)?.replace('/api/v1', '');
+  if (!url || !token) {
+    throw new Error(`url and token must be provided`);
+  }
+  const primaryKey = decodedToken?.tenantId || token;
+  const secondaryKey = key;
+  const cachedValue = getAppConfigurationFromCache(primaryKey, secondaryKey);
+  if (cachedValue !== null) {
+    return cachedValue;
+  }
+  try {
+    const appConfigurationsValues = await fetchAppConfigurations(token, url, executionContext?.tpaName);
+    const appConfigurationValue = appConfigurationsValues[key];
+    updateAppConfigurationInCache(primaryKey, appConfigurationsValues);
+    return appConfigurationValue;
+  } catch (e) {
+    throw new Error(`Could not get app configuration: ${key} from BigID: ${e}`);
+  }
+};
+
+const fetchAppConfigurations = async (
+  token: string,
+  url: string,
+  appNameFromExecutionContext?: string,
+): Promise<Record<string, any>> => {
+  const appConfigurationsEndPoint = createUrl(
+    url,
+    generateTpaConfigurationEndpoint(appNameFromExecutionContext ?? appConfigurationsManagementParams.appName),
+  );
+  const { data = {} } = await doCallToUrl(token!, RequestMethod.GET, appConfigurationsEndPoint);
+  return data;
+};
+
+const updateAppConfigurationInCache = (primaryKey: string, appConfigurationsRecord: Record<string, any>) => {
+  const expiry = Date.now() + APP_CONFIGURATIONS_CACHE_TTL;
+  let existingSecondaryCache = appConfigurationsCache.get(primaryKey);
+  if (!existingSecondaryCache) {
+    existingSecondaryCache = new Map<string, CacheEntry>();
+    appConfigurationsCache.set(primaryKey, existingSecondaryCache);
+  }
+  for (const [secondaryKey, value] of Object.entries(appConfigurationsRecord)) {
+    existingSecondaryCache.set(secondaryKey, { value, expiry });
+  }
+};
+
+const getAppConfigurationFromCache = (primaryKey: string, secondaryKey: string): string | null => {
+  const secondaryCache = appConfigurationsCache.get(primaryKey);
+  if (!secondaryCache) {
+    return null;
+  }
+  const entry = secondaryCache.get(secondaryKey);
+  if (entry && entry.expiry > Date.now()) {
+    return entry.value;
+  }
+
+  secondaryCache.delete(secondaryKey);
+  if (secondaryCache.size === 0) {
+    appConfigurationsCache.delete(primaryKey);
+  }
+  return null;
+};
+
+const createUrl = (baseUrl: string, path: string): string => {
+  const normalizedBaseUrl = baseUrl.startsWith('http') ? baseUrl : `https://${baseUrl}`;
+  return new URL(path, normalizedBaseUrl).href;
+};
+
+export const enrichManifestWithEnvConfigurations = (originalManifestString: string): string => {
+  const manifestJson = JSON.parse(originalManifestString);
+  if (manifestJson['app_configurations']) {
+    manifestJson['app_configurations'].env = process.env;
+  }
+  logInfo(`App manifest was enriched with env vars for app_configurations section`);
+  return JSON.stringify(manifestJson);
+};
+
+const generateTpaConfigurationEndpoint = (appName: string) => {
+  return `api/v1/tpa/app-configurations/${appName}`;
+};

package/src/services/index.ts

@@ -3,3 +3,4 @@ export * from './dataSourceService';
 export * from './actionsHubService';
 
 export { scheduleFunction, unscheduleAllFunctions, unscheduleFunction } from './schedulerService';
+export { getAppConfiguration } from './appsConfigurationsManagementService';

package/src/services/schedulerService.ts

@@ -25,7 +25,7 @@ const scheduleSingleTenantProcess = async (
  * @param callback - the function that will be called.
  */
 export const scheduleFunction = (batchUN: string, cronExpression: string, callback: BatchFunction): void => {
-  process.env.MULTI_TENANT_MODE
+  isMultiTenantMode()
     ? scheduleJob(batchUN, cronExpression, () => handleBatchProcess(callback))
     : scheduleSingleTenantProcess(batchUN, cronExpression, callback);
 };
@@ -37,3 +37,7 @@ export const unscheduleFunction = (batchUN: string): void => {
 
 export const unscheduleAllFunctions = (): void =>
   Object.keys(scheduledJobs).forEach(jobName => scheduledJobs[jobName].cancel());
+
+export const isMultiTenantMode = (): boolean => {
+  return [true, 'true'].includes(process.env.MULTI_TENANT_MODE || '');
+}

package/src/utils/tokenUtil.ts

@@ -2,6 +2,8 @@ import axios from 'axios';
 import { Agent } from 'https';
 import { doCallToUrl, executePost, RequestMethod } from '../services';
 import { logError, logInfo } from './appLogger';
+import * as jwt from 'jsonwebtoken';
+import { JwtPayload } from 'jsonwebtoken';
 
 const auth0Payload = {
   client_id: process.env.CLIENT_ID,
@@ -13,6 +15,16 @@ const auth0Payload = {
 let auth0Token: string;
 let accessToken: string;
 
+const REFRESH_TOKEN = process.env.BIGID_REFRESH_TOKEN;
+
+export const getBigidAccessToken = async (): Promise<string> => {
+  if (!REFRESH_TOKEN) {
+    throw new Error('BIGID_REFRESH_TOKEN must be supplied as an ENV var in order to call bigid actions hub');
+  }
+
+  return await getAccessTokenFromRefreshToken(REFRESH_TOKEN);
+};
+
 export const getAccessTokenFromRefreshToken = async (refreshToken: string) => {
   if (canUseLocalToken(accessToken)) return accessToken;
   const bigidBaseUrl = process.env.BIGID_BASE_URL;
@@ -79,3 +91,8 @@ const canUseLocalToken = (token: string): boolean => {
   const { exp } = getTokenPayloadAsJson(token);
   return Date.now() < exp * 1000;
 };
+
+export const decodeToken = (token: string): JwtPayload => {
+  const decodedToken = jwt.decode(token);
+  return <JwtPayload>decodedToken;
+};