@bigid/apps-infrastructure-node-js 0.1.0

package/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+      "eslint:recommended",
+      "plugin:prettier/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier/@typescript-eslint",
+      "plugin:prettier/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 13,
+        "sourceType": "module"
+    },
+    "plugins": ["@typescript-eslint", "no-only-tests"],
+    "rules": {
+      "camel-case": 0,
+      "no-console": "off",
+      "no-use-before-define": 0,
+      "@typescript-eslint/camelcase": 0,
+      "@typescript-eslint/no-empty-function": 0,
+      "@typescript-eslint/no-use-before-define": 0,
+      "@typescript-eslint/explicit-function-return-type": 0,
+      "@typescript-eslint/explicit-member-accessibility": 0,
+      "@typescript-eslint/no-this-alias": 1,
+      "@typescript-eslint/no-empty-interface": 0,
+      "@typescript-eslint/no-var-requires": 0,
+      "no-only-tests/no-only-tests": "error"
+    }
+}

package/.idea/apps-infrastructure-node-js.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/apps-infrastructure-node-js.iml" filepath="$PROJECT_DIR$/.idea/apps-infrastructure-node-js.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myRunOnSave" value="true" />
+    <option name="myRunOnReformat" value="true" />
+  </component>
+</project>

package/.idea/runConfigurations.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RunConfigurationProducerService">
+    <option name="ignoredProducers">
+      <set>
+        <option value="com.android.tools.idea.compose.preview.runconfiguration.ComposePreviewRunConfigurationProducer" />
+      </set>
+    </option>
+  </component>
+</project>

package/.idea/snyk.project.settings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="SnykProjectSettingsState">
+    <option name="additionalParameters" value="" />
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 2,
+  "arrowParens": "avoid"
+}

package/README.md

@@ -0,0 +1,11 @@
+# apps-infrastructure-node-js
+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?
+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.

package/lib/abstractProviders/executionProvider.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response } from 'express';
+export declare const StatusEnum: {
+    COMPLETED: string;
+    IN_PROGRESS: string;
+    ERROR: string;
+};
+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>;
+    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>>;
+}

package/lib/abstractProviders/executionProvider.js

@@ -0,0 +1,35 @@
+"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.ExecutionProvider = exports.handleExecution = exports.StatusEnum = void 0;
+const actionResponseDetails_1 = require("../dto/actionResponseDetails");
+const services_1 = require("../services");
+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);
+});
+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));
+    }
+}
+exports.ExecutionProvider = ExecutionProvider;

package/lib/abstractProviders/iconsProviders.d.ts

@@ -0,0 +1,4 @@
+export declare abstract class IconsProviders {
+    abstract getIconPath(): string;
+    abstract getSideBarIconPath(): string;
+}

package/lib/abstractProviders/iconsProviders.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IconsProviders = void 0;
+class IconsProviders {
+}
+exports.IconsProviders = IconsProviders;

package/lib/abstractProviders/index.d.ts

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

package/lib/abstractProviders/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+Object.defineProperty(exports, "IconsProviders", { enumerable: true, get: function () { return iconsProviders_1.IconsProviders; } });
+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; } });

package/lib/abstractProviders/logsProvider.d.ts

@@ -0,0 +1,2 @@
+import { Request, Response } from 'express';
+export declare const fetchLogs: (req: Request, res: Response) => Response<any, Record<string, any>>;

package/lib/abstractProviders/logsProvider.js

@@ -0,0 +1,7 @@
+"use strict";
+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);
+exports.fetchLogs = fetchLogs;

package/lib/abstractProviders/manifestProvider.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class ManifestProvider {
+    abstract getManifest(req: any, res: any): string;
+}

package/lib/abstractProviders/manifestProvider.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestProvider = void 0;
+class ManifestProvider {
+}
+exports.ManifestProvider = ManifestProvider;

package/lib/appTypes/actionResponseDetails.d.ts

@@ -0,0 +1,6 @@
+export interface ActionResponseDetails {
+    executionId: string;
+    statusEnum: string;
+    progress: number;
+    message: string;
+}

package/lib/appTypes/actionResponseDetails.js

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

package/lib/appTypes/executionContext.d.ts

@@ -0,0 +1,10 @@
+export interface ExecutionContext {
+    actionName: string;
+    executionId: string;
+    globalParams: any;
+    actionParams: any;
+    bigidBaseUrl: string;
+    bigidToken: string;
+    updateResultCallback: any;
+    tpaId: string;
+}

package/lib/appTypes/executionContext.js

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

package/lib/appTypes/index.d.ts

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

package/lib/appTypes/index.js

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

package/lib/dto/actionResponseDetails.d.ts

@@ -0,0 +1,8 @@
+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);
+}

package/lib/dto/actionResponseDetails.js

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

package/lib/dto/executionContext.d.ts

@@ -0,0 +1,11 @@
+export declare class ExecutionContext {
+    actionName: string;
+    executionId: string;
+    globalParams: Record<string, string>;
+    actionParams: Record<string, string>;
+    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);
+}

package/lib/dto/executionContext.js

@@ -0,0 +1,16 @@
+"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

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

package/lib/dto/index.js

@@ -0,0 +1,7 @@
+"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; } });
+var actionResponseDetails_1 = require("./actionResponseDetails");
+Object.defineProperty(exports, "ActionResponseDetails", { enumerable: true, get: function () { return actionResponseDetails_1.ActionResponseDetails; } });

package/lib/dto/keysValuesToStore.d.ts

@@ -0,0 +1,5 @@
+declare class KeysValuesToStore {
+    constructor(key: any, paramValue: any);
+    addKeyValue(key: any, value: any): void;
+    getValue(key: any): any;
+}

package/lib/dto/keysValuesToStore.js

@@ -0,0 +1,19 @@
+"use strict";
+class KeysValuesToStore {
+    constructor(key, paramValue) {
+        this.keysValues = [];
+        this.addKeyValue(key, paramValue);
+    }
+    addKeyValue(key, value) {
+        this.keysValues.push(new KeyValue(key, value));
+    }
+    getValue(key) {
+        for (const keyValue of keysValues) {
+            if (keyValue.key === key) {
+                return keyValue.value;
+            }
+        }
+        return '';
+    }
+}
+module.exports = KeysValuesToStore;

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './abstractProviders';
+export * from './dto';
+export * from './utils';
+export { updateActionStatusToBigID, uploadAttachment, getValueFromAppStorage, saveInStorage, executeHttpGet } from './services';
+export { deployServer, ServerInit } from './server';

package/lib/index.js

@@ -0,0 +1,24 @@
+"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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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;
+__exportStar(require("./abstractProviders"), exports);
+__exportStar(require("./dto"), exports);
+__exportStar(require("./utils"), exports);
+var services_1 = require("./services");
+Object.defineProperty(exports, "updateActionStatusToBigID", { enumerable: true, get: function () { return services_1.updateActionStatusToBigID; } });
+Object.defineProperty(exports, "uploadAttachment", { enumerable: true, get: function () { return services_1.uploadAttachment; } });
+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; } });
+var server_1 = require("./server");
+Object.defineProperty(exports, "deployServer", { enumerable: true, get: function () { return server_1.deployServer; } });

package/lib/routes/router.d.ts

@@ -0,0 +1 @@
+export declare const router: () => Promise<void>;

package/lib/routes/router.js

@@ -0,0 +1,15 @@
+"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.router = void 0;
+const router = () => __awaiter(void 0, void 0, void 0, function* () {
+});
+exports.router = router;

package/lib/server.d.ts

@@ -0,0 +1,10 @@
+import { ManifestProvider } from "./abstractProviders/manifestProvider";
+import { IconsProviders } from "./abstractProviders/iconsProviders";
+import { ExecutionProvider } from "./abstractProviders/executionProvider";
+export interface ServerInit {
+    manifestController: ManifestProvider;
+    iconsController: IconsProviders;
+    executionController: ExecutionProvider;
+    serverPort?: number;
+}
+export declare const deployServer: (serverInit: ServerInit) => void;

package/lib/server.js

@@ -0,0 +1,48 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployServer = void 0;
+const express_1 = __importDefault(require("express"));
+const appLogger_1 = require("./utils/appLogger");
+const executionProvider_1 = require("./abstractProviders/executionProvider");
+const logsProvider_1 = require("./abstractProviders/logsProvider");
+const http_errors_1 = __importDefault(require("http-errors"));
+;
+const app = (0, express_1.default)();
+const deployServer = (serverInit) => {
+    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}`));
+    // 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);
+        res.locals.message = message;
+        res.locals.error = req.app.get('env') === 'development' ? err : {};
+        res.status(status || 500);
+        res.json({
+            status: "error",
+            statusCode: status || 500,
+            message
+        });
+    });
+};
+exports.deployServer = deployServer;

package/lib/services/bigidProxyService.d.ts

@@ -0,0 +1,28 @@
+import { ExecutionContext } from "../dto";
+import { ActionResponseDetails } from '../dto/actionResponseDetails';
+export declare const initBigIDProxy: (bigIdUrl: string, callBackUrl: string, bigIdToken: string, tpaId: string) => void;
+/**
+ * This method receives a message object to update BigID regarding the current state of the action execution
+ * (should be used in case of an async actions)
+ * @param actionResponseDetailsParam
+ */
+export declare const updateActionStatusToBigID: (actionResponseDetails: ActionResponseDetails) => Promise<any>;
+/**
+ *
+ * @param endpoint - the endpoint in BigID, used for GET request. e.g - {BigIDBaseUrl}/ds_connections
+ * @return - String containing the response from BigID
+ */
+export declare const executeHttpGet: (endpoint: string) => Promise<any>;
+/**
+ * the endpoint in BigID, used for POST requests. e.g - {BigIDBaseUrl}/scan
+ */
+export declare const executeHttpPost: (endpoint: string, actionResponseDetails: ActionResponseDetails) => Promise<any>;
+/**
+ * the endpoint in BigID, used for POST requests. e.g - {BigIDBaseUrl}/scan
+ */
+export declare const executeHttpPut: (endpoint: string, obj: any) => Promise<any>;
+export declare const uploadAttachment: (filePathToUpload: string) => import("axios").AxiosPromise<any>;
+export declare const getAppStorage: () => Promise<any>;
+export declare const getValueFromAppStorage: (key: string) => Promise<any>;
+export declare const saveInStorage: (keyToStore: any, valueToStore: any) => Promise<any>;
+export declare const setValuesForBigIDProxy: (executionContext: ExecutionContext) => void;