@futdevpro/nts-dynamo 1.15.68 → 1.15.70

package/build/_services/route/routing-module.service.js

@@ -1,251 +1,251 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DyNTS_RoutingModule = void 0;
-const express_1 = require("express");
-const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
-const global_settings_const_1 = require("../../_collections/global-settings.const");
-const route_security_enum_1 = require("../../_enums/route-security.enum");
-/**
- * Routing Module
- * Handling route setup and control
- *
- * (You'll need to add them to a {@link DyNTS_App} through the {@link DyNTS_App.getRoutingModules} method)
- *
- * You can add routes and controllers for them
- * @example
- *   // Setting up Routes
- *   setupRoutingModules(): void {
- *     this.httpPort = env.port;
-
- *     this.routingModules = [
- *       new DyNTS_RoutingModule({
- *         route: '/user',
- *         controllers: [
- *           UserController.getInstance(),
- *           UserDataController.getInstance(),
- *           UserOptionsController.getInstance(),
- *           UserStatisticsController.getInstance(),
- *           UserAchievementsController.getInstance(),
- *           UserNotificationsController.getInstance()
- *         ]
- *       }),
- *       new DyNTS_RoutingModule({
- *         route: '/match',
- *         controllers: [
- *           MatchController.getInstance(),
- *           MatchDistributionController.getInstance(),
- *           MatchStatisticsController.getInstance(),
- *         ]
- *       }),
- *       new DyNTS_RoutingModule({
- *         route: '/server',
- *         controllers: [
- *           ServerController.getInstance(),
- *         ]
- *       }),
-
- *       getTestRoutingModule(),
- *       getUsageRoutingModule()
- *     ];
- *   }
- */
-class DyNTS_RoutingModule {
-    /* serviceName: string; */
-    security;
-    route;
-    controllers;
-    endpoints = [];
-    openRouter = (0, express_1.Router)();
-    secureRouter = (0, express_1.Router)();
-    stackLocation;
-    get logSetup() {
-        return global_settings_const_1.DyNTS_global_settings.log_settings.setup;
-    }
-    defaultErrorUserMsg = `We encountered an uncaught BackEnd Build Error, ` +
-        `\nplease contact the responsible development team.`;
-    constructor(set) {
-        try {
-            /* this.serviceName = set.route.replace('/', '') + 'RoutingModule'; */
-            this.route = global_settings_const_1.DyNTS_global_settings.baseUrl + set.route;
-            this.controllers = set.controllers ?? [];
-            this.stackLocation = (0, fsm_dynamo_1.DyFM_getConstructionStackLocation)();
-            this.setupRoutes();
-            this.mountRoutes(set.securityOverride);
-            if (this.logSetup)
-                console.log(`routing module setup done: ${this.route} security: ${this.security}\n`);
-        }
-        catch (error) {
-            /* if (
-              DyNTS_global_settings.log_settings.highDetailedLogs ||
-              !(error instanceof DyFM_Error)
-            ) {
-              DyFM_Log.H_error(
-                `Routing module setup failed (${this.route}).`,
-                `\n    ERROR:`, error
-              );
-            } else {
-              error.logSimple(
-                `Routing module setup failed (${this.route}).` +
-                '\nmessages:\n' + error._messages.join('        \n')
-              );
-            } */
-            /* DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
-            throw new fsm_dynamo_1.DyFM_Error({
-                ...this.getDefaultErrorSettings('DyNTS_RoutingModule.constructor', error),
-                message: `Routing module setup failed (${this.route}).`,
-                errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-000`,
-                __localStack: this.stackLocation,
-                additionalContent: set,
-            });
-        }
-    }
-    /**
-     * You must setup endpoints and required services for this function
-     */
-    setupRoutes() {
-        this.controllers.forEach((controller) => {
-            try {
-                controller.setupEndpoints();
-            }
-            catch (error) {
-                throw new fsm_dynamo_1.DyFM_Error({
-                    ...this.getDefaultErrorSettings('setupRoutes', error),
-                    message: `DyNTS_Controller setup failed. (${controller?.constructor?.name}) ` +
-                        `Please check the setupEndpoints() method.`,
-                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-SR1`,
-                    level: fsm_dynamo_1.DyFM_ErrorLevel.critical,
-                });
-            }
-            if (controller?.endpoints?.length) {
-                this.endpoints.push(...controller.endpoints);
-            }
-        });
-    }
-    /**
-     *
-     * @param securityOverride
-     */
-    mountRoutes(securityOverride) {
-        if (securityOverride) {
-            this.security = securityOverride;
-        }
-        this.endpoints.forEach((endpoint) => {
-            if (securityOverride) {
-                endpoint.security = securityOverride;
-            }
-            else {
-                if (!endpoint.security) {
-                    fsm_dynamo_1.DyFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
-                }
-                else if (!this.security) {
-                    this.security = endpoint.security;
-                }
-                else if (this.security !== endpoint.security) {
-                    this.security = route_security_enum_1.DyNTS_RouteSecurity.both;
-                }
-            }
-            if (this.logSetup)
-                console.log(`endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`);
-            const existingEndPoints = this.endpoints.filter((e_params) => e_params.endpoint === endpoint.endpoint &&
-                e_params.type === endpoint.type);
-            if (1 < existingEndPoints.length) {
-                const error = new Error(`ENDPOINT DUPLICATION: ${endpoint.endpoint}`);
-                const errorStack = error.stack.split('\n');
-                errorStack.splice(1, 4);
-                error.stack = errorStack.join('\n');
-                throw error;
-            }
-            try {
-                if (endpoint.security !== route_security_enum_1.DyNTS_RouteSecurity.secure) {
-                    this.mountOpenRoute(endpoint);
-                }
-                if (endpoint.security !== route_security_enum_1.DyNTS_RouteSecurity.open) {
-                    this.mountSecureRoute(endpoint);
-                }
-            }
-            catch (error) {
-                fsm_dynamo_1.DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
-                throw new fsm_dynamo_1.DyFM_Error({
-                    ...this.getDefaultErrorSettings('mountRoutes', new Error(`DYNAMO-NTS ERROR: Failed to mount routes.`)),
-                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-100`,
-                });
-            }
-        });
-    }
-    /**
-     *
-     * @param endpointParams
-     */
-    mountOpenRoute(endpointParams) {
-        switch (endpointParams.type) {
-            case fsm_dynamo_1.DyFM_HttpCallType.get:
-                this.openRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.post:
-                this.openRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.put:
-                this.openRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.patch:
-                this.openRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.delete:
-                this.openRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            default:
-                fsm_dynamo_1.DyFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
-                throw new fsm_dynamo_1.DyFM_Error({
-                    ...this.getDefaultErrorSettings('mountOpenRoute', new Error(`DYNAMO-NTS ERROR: INVALID route type: ` +
-                        `${endpointParams.type} - ${endpointParams.name}`)),
-                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-200`,
-                });
-        }
-    }
-    /**
-     *
-     * @param endpointParams
-     */
-    mountSecureRoute(endpointParams) {
-        switch (endpointParams.type) {
-            case fsm_dynamo_1.DyFM_HttpCallType.get:
-                this.secureRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.post:
-                this.secureRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.put:
-                this.secureRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.patch:
-                this.secureRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            case fsm_dynamo_1.DyFM_HttpCallType.delete:
-                this.secureRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
-                break;
-            default:
-                fsm_dynamo_1.DyFM_Log.error(`DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
-                throw new fsm_dynamo_1.DyFM_Error({
-                    ...this.getDefaultErrorSettings('mountSecureRoute', new Error(`DYNAMO-NTS ERROR: INVALID route type: ` +
-                        `${endpointParams.type} - ${endpointParams.name}`)),
-                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-300`,
-                });
-        }
-    }
-    getDefaultErrorSettings(fnName, error) {
-        return {
-            status: 500,
-            message: error?.message ??
-                error?._message ??
-                `${fnName} was UNSUCCESSFUL (NTS)`,
-            userMessage: error?.__userMessage ??
-                this.defaultErrorUserMsg,
-            addECToUserMsg: true,
-            error: error,
-            issuerService: this.constructor?.name,
-            systemVersion: global_settings_const_1.DyNTS_global_settings.systemVersion,
-        };
-    }
-}
-exports.DyNTS_RoutingModule = DyNTS_RoutingModule;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DyNTS_RoutingModule = void 0;
+const express_1 = require("express");
+const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
+const global_settings_const_1 = require("../../_collections/global-settings.const");
+const route_security_enum_1 = require("../../_enums/route-security.enum");
+/**
+ * Routing Module
+ * Handling route setup and control
+ *
+ * (You'll need to add them to a {@link DyNTS_App} through the {@link DyNTS_App.getRoutingModules} method)
+ *
+ * You can add routes and controllers for them
+ * @example
+ *   // Setting up Routes
+ *   setupRoutingModules(): void {
+ *     this.httpPort = env.port;
+
+ *     this.routingModules = [
+ *       new DyNTS_RoutingModule({
+ *         route: '/user',
+ *         controllers: [
+ *           UserController.getInstance(),
+ *           UserDataController.getInstance(),
+ *           UserOptionsController.getInstance(),
+ *           UserStatisticsController.getInstance(),
+ *           UserAchievementsController.getInstance(),
+ *           UserNotificationsController.getInstance()
+ *         ]
+ *       }),
+ *       new DyNTS_RoutingModule({
+ *         route: '/match',
+ *         controllers: [
+ *           MatchController.getInstance(),
+ *           MatchDistributionController.getInstance(),
+ *           MatchStatisticsController.getInstance(),
+ *         ]
+ *       }),
+ *       new DyNTS_RoutingModule({
+ *         route: '/server',
+ *         controllers: [
+ *           ServerController.getInstance(),
+ *         ]
+ *       }),
+
+ *       getTestRoutingModule(),
+ *       getUsageRoutingModule()
+ *     ];
+ *   }
+ */
+class DyNTS_RoutingModule {
+    /* serviceName: string; */
+    security;
+    route;
+    controllers;
+    endpoints = [];
+    openRouter = (0, express_1.Router)();
+    secureRouter = (0, express_1.Router)();
+    stackLocation;
+    get logSetup() {
+        return global_settings_const_1.DyNTS_global_settings.log_settings.setup;
+    }
+    defaultErrorUserMsg = `We encountered an uncaught BackEnd Build Error, ` +
+        `\nplease contact the responsible development team.`;
+    constructor(set) {
+        try {
+            /* this.serviceName = set.route.replace('/', '') + 'RoutingModule'; */
+            this.route = global_settings_const_1.DyNTS_global_settings.baseUrl + set.route;
+            this.controllers = set.controllers ?? [];
+            this.stackLocation = (0, fsm_dynamo_1.DyFM_getConstructionStackLocation)();
+            this.setupRoutes();
+            this.mountRoutes(set.securityOverride);
+            if (this.logSetup)
+                console.log(`routing module setup done: ${this.route} security: ${this.security}\n`);
+        }
+        catch (error) {
+            /* if (
+              DyNTS_global_settings.log_settings.highDetailedLogs ||
+              !(error instanceof DyFM_Error)
+            ) {
+              DyFM_Log.H_error(
+                `Routing module setup failed (${this.route}).`,
+                `\n    ERROR:`, error
+              );
+            } else {
+              error.logSimple(
+                `Routing module setup failed (${this.route}).` +
+                '\nmessages:\n' + error._messages.join('        \n')
+              );
+            } */
+            /* DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
+            throw new fsm_dynamo_1.DyFM_Error({
+                ...this.getDefaultErrorSettings('DyNTS_RoutingModule.constructor', error),
+                message: `Routing module setup failed (${this.route}).`,
+                errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-000`,
+                __localStack: this.stackLocation,
+                additionalContent: set,
+            });
+        }
+    }
+    /**
+     * You must setup endpoints and required services for this function
+     */
+    setupRoutes() {
+        this.controllers.forEach((controller) => {
+            try {
+                controller.setupEndpoints();
+            }
+            catch (error) {
+                throw new fsm_dynamo_1.DyFM_Error({
+                    ...this.getDefaultErrorSettings('setupRoutes', error),
+                    message: `DyNTS_Controller setup failed. (${controller?.constructor?.name}) ` +
+                        `Please check the setupEndpoints() method.`,
+                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-SR1`,
+                    level: fsm_dynamo_1.DyFM_ErrorLevel.critical,
+                });
+            }
+            if (controller?.endpoints?.length) {
+                this.endpoints.push(...controller.endpoints);
+            }
+        });
+    }
+    /**
+     *
+     * @param securityOverride
+     */
+    mountRoutes(securityOverride) {
+        if (securityOverride) {
+            this.security = securityOverride;
+        }
+        this.endpoints.forEach((endpoint) => {
+            if (securityOverride) {
+                endpoint.security = securityOverride;
+            }
+            else {
+                if (!endpoint.security) {
+                    fsm_dynamo_1.DyFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
+                }
+                else if (!this.security) {
+                    this.security = endpoint.security;
+                }
+                else if (this.security !== endpoint.security) {
+                    this.security = route_security_enum_1.DyNTS_RouteSecurity.both;
+                }
+            }
+            if (this.logSetup)
+                console.log(`endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`);
+            const existingEndPoints = this.endpoints.filter((e_params) => e_params.endpoint === endpoint.endpoint &&
+                e_params.type === endpoint.type);
+            if (1 < existingEndPoints.length) {
+                const error = new Error(`ENDPOINT DUPLICATION: ${endpoint.endpoint}`);
+                const errorStack = error.stack.split('\n');
+                errorStack.splice(1, 4);
+                error.stack = errorStack.join('\n');
+                throw error;
+            }
+            try {
+                if (endpoint.security !== route_security_enum_1.DyNTS_RouteSecurity.secure) {
+                    this.mountOpenRoute(endpoint);
+                }
+                if (endpoint.security !== route_security_enum_1.DyNTS_RouteSecurity.open) {
+                    this.mountSecureRoute(endpoint);
+                }
+            }
+            catch (error) {
+                fsm_dynamo_1.DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
+                throw new fsm_dynamo_1.DyFM_Error({
+                    ...this.getDefaultErrorSettings('mountRoutes', new Error(`DYNAMO-NTS ERROR: Failed to mount routes.`)),
+                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-100`,
+                });
+            }
+        });
+    }
+    /**
+     *
+     * @param endpointParams
+     */
+    mountOpenRoute(endpointParams) {
+        switch (endpointParams.type) {
+            case fsm_dynamo_1.DyFM_HttpCallType.get:
+                this.openRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.post:
+                this.openRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.put:
+                this.openRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.patch:
+                this.openRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.delete:
+                this.openRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            default:
+                fsm_dynamo_1.DyFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
+                throw new fsm_dynamo_1.DyFM_Error({
+                    ...this.getDefaultErrorSettings('mountOpenRoute', new Error(`DYNAMO-NTS ERROR: INVALID route type: ` +
+                        `${endpointParams.type} - ${endpointParams.name}`)),
+                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-200`,
+                });
+        }
+    }
+    /**
+     *
+     * @param endpointParams
+     */
+    mountSecureRoute(endpointParams) {
+        switch (endpointParams.type) {
+            case fsm_dynamo_1.DyFM_HttpCallType.get:
+                this.secureRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.post:
+                this.secureRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.put:
+                this.secureRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.patch:
+                this.secureRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            case fsm_dynamo_1.DyFM_HttpCallType.delete:
+                this.secureRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
+                break;
+            default:
+                fsm_dynamo_1.DyFM_Log.error(`DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
+                throw new fsm_dynamo_1.DyFM_Error({
+                    ...this.getDefaultErrorSettings('mountSecureRoute', new Error(`DYNAMO-NTS ERROR: INVALID route type: ` +
+                        `${endpointParams.type} - ${endpointParams.name}`)),
+                    errorCode: `${global_settings_const_1.DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-300`,
+                });
+        }
+    }
+    getDefaultErrorSettings(fnName, error) {
+        return {
+            status: 500,
+            message: error?.message ??
+                error?._message ??
+                `${fnName} was UNSUCCESSFUL (NTS)`,
+            userMessage: error?.__userMessage ??
+                this.defaultErrorUserMsg,
+            addECToUserMsg: true,
+            error: error,
+            issuerService: this.constructor?.name,
+            systemVersion: global_settings_const_1.DyNTS_global_settings.systemVersion,
+        };
+    }
+}
+exports.DyNTS_RoutingModule = DyNTS_RoutingModule;
 //# sourceMappingURL=routing-module.service.js.map