@crowdin/app-project-module 0.26.2 → 0.26.4

package/README.md

@@ -722,7 +722,8 @@ const configuration = {
     imagePath: __dirname + '/' + 'logo.png',
     profileResourcesMenu: {
       fileName: 'setup.html',
-      uiPath: __dirname + '/' + 'public'
+      uiPath: __dirname + '/' + 'public',
+      environments: 'crowdin-enterprise',
     },
 };
 
@@ -748,7 +749,8 @@ const configuration = {
     imagePath: __dirname + '/' + 'logo.png',
     profileResourcesMenu: {
       fileName: 'setup.html',
-      uiPath: __dirname + '/' + 'public'
+      uiPath: __dirname + '/' + 'public',
+      environments: 'crowdin',
     },
     customMT: {
         translate,
@@ -842,6 +844,16 @@ configuration.jwtValidationOptions = {
 configuration.authenticationType = 'authorization_code'; //default is "crowdin_app"
 ```
 
+### Disable global error handling
+
+This module will handle all `unhandledRejection` and `uncaughtException` errors, log them and not kill the Node process.  
+Usually this means that code was not properly designed and contains unsafe places. And not always this built in behaviour will be suitable.  
+Therefore you can disable it:
+
+```js
+configuration.disableGlobalErrorHandling = true;
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/manifest.js

@@ -12,6 +12,7 @@ function handle(config) {
                 description: config.description,
                 logo: '/logo/integration/logo.png',
                 url: '/',
+                environments: config.projectIntegration.environments,
             },
         ];
     }
@@ -36,6 +37,7 @@ function handle(config) {
                 name: config.name,
                 logo: '/logo/mt/logo.png',
                 url: '/translate',
+                environments: config.customMT.environments,
             },
         ];
     }
@@ -56,6 +58,7 @@ function handle(config) {
                 name: config.name,
                 url: '/resources/' + (config.profileResourcesMenu.fileName || 'index.html'),
                 icon: '/logo/resources/logo.png',
+                environments: config.profileResourcesMenu.environments,
             },
         ];
     }
@@ -66,6 +69,7 @@ function handle(config) {
                 name: config.name,
                 url: '/editor-panels/' + (config.editorRightPanel.fileName || 'index.html'),
                 modes: config.editorRightPanel.modes,
+                environments: config.editorRightPanel.environments,
             },
         ];
     }
@@ -75,6 +79,7 @@ function handle(config) {
                 key: config.identifier + '-project-menu',
                 name: config.name,
                 url: '/project-menu/' + (config.projectMenu.fileName || 'index.html'),
+                environments: config.projectMenu.environments,
             },
         ];
     }
@@ -95,6 +100,7 @@ function handle(config) {
                 description: config.description,
                 logo: '/logo/tools/logo.png',
                 url: '/tools/' + (config.projectTools.fileName || 'index.html'),
+                environments: config.projectTools.environments,
             },
         ];
     }

package/out/index.js

@@ -63,12 +63,16 @@ const integration_credentials_1 = __importDefault(require("./middlewares/integra
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
 const ui_module_1 = __importDefault(require("./middlewares/ui-module"));
 const storage = __importStar(require("./storage"));
+const util_1 = require("./util");
 const connection_1 = require("./util/connection");
 const cron_1 = require("./util/cron");
 const defaults_1 = require("./util/defaults");
 var models_1 = require("./models");
 Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
 function addCrowdinEndpoints(app, plainConfig) {
+    if (!plainConfig.disableGlobalErrorHandling) {
+        handleUncaughtErrors(plainConfig);
+    }
     const config = Object.assign(Object.assign({}, plainConfig), { baseUrl: plainConfig.baseUrl.endsWith('/') ? plainConfig.baseUrl.slice(0, -1) : plainConfig.baseUrl });
     storage.initialize(config);
     app.use(express_1.default.json({ limit: '50mb' }));
@@ -196,3 +200,14 @@ function createApp(config) {
     app.listen(config.port || 3000, () => console.log(`App started on port ${config.port || 3000}`));
 }
 exports.createApp = createApp;
+function handleUncaughtErrors(config) {
+    process
+        .on('unhandledRejection', (reason) => {
+        const error = `Unhandled Rejection. Reason: ${reason.stack || reason}`;
+        (0, util_1.logError)(error, config.onError);
+    })
+        .on('uncaughtException', (reason) => {
+        const error = `Uncaught Exception. Reason: ${reason.stack || reason}`;
+        (0, util_1.logError)(error, config.onError);
+    });
+}

package/out/models/index.d.ts

@@ -67,7 +67,7 @@ export interface Config extends ImagePath {
     /**
      * integration module logic
      */
-    projectIntegration?: IntegrationLogic & ImagePath;
+    projectIntegration?: IntegrationLogic & ImagePath & Environments;
     /**
      * custom file format module logic
      */
@@ -75,11 +75,11 @@ export interface Config extends ImagePath {
     /**
      * custom MT module logic
      */
-    customMT?: CustomMTLogic & ImagePath;
+    customMT?: CustomMTLogic & ImagePath & Environments;
     /**
      * resources module
      */
-    profileResourcesMenu?: UiModule & ImagePath;
+    profileResourcesMenu?: UiModule & ImagePath & Environments;
     /**
      * organization-menu module
      */
@@ -87,11 +87,11 @@ export interface Config extends ImagePath {
     /**
      * editor-right-panel module
      */
-    editorRightPanel?: EditorPanels;
+    editorRightPanel?: EditorPanels & Environments;
     /**
      * project menu module
      */
-    projectMenu?: UiModule;
+    projectMenu?: UiModule & Environments;
     /**
      * project menu crowdsource module
      */
@@ -99,7 +99,7 @@ export interface Config extends ImagePath {
     /**
      * tools module
      */
-    projectTools?: UiModule & ImagePath;
+    projectTools?: UiModule & ImagePath & Environments;
     /**
      * reports module
      */
@@ -115,6 +115,10 @@ export interface Config extends ImagePath {
      * Error interceptor (can be used to log error in centralized place)
      */
     onError?: (error: any) => void;
+    /**
+     * Disable global error handling of unhandledRejection and uncaughtException events
+     */
+    disableGlobalErrorHandling?: boolean;
     /**
      * Configuration to log everything that are happening in the app
      */
@@ -346,6 +350,9 @@ export interface OAuthLogin {
      */
     performRefreshTokenRequest?: (currentCredentials: any) => Promise<any>;
 }
+export interface Environments {
+    environments: 'crowdin' | 'crowdin-enterprise';
+}
 export interface FormField {
     key: string;
     helpText?: string;

package/out/util/index.d.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { Config, Logger, ExtendedResult } from '../models';
+import { Config, ExtendedResult, Logger } from '../models';
 export declare class CodeError extends Error {
     code: number | undefined;
     constructor(message: string, code?: number);
@@ -7,6 +7,7 @@ export declare class CodeError extends Error {
 export declare function log(message: string, logger?: Logger): void;
 export declare function getMessage(err: any): any;
 export declare function runAsyncWrapper(callback: Function, onError?: (e: any) => void): (req: Request, res: Response, next: Function) => void;
+export declare function logError(e: any, onError?: (e: any) => void): void;
 export declare function encryptData(config: Config, data: string): string;
 export declare function decryptData(config: Config, data: string): string;
 export declare function executeWithRetry<T>(func: () => Promise<T>, numOfRetries?: number): Promise<T>;

package/out/util/index.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExtendedResultType = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.getMessage = exports.log = exports.CodeError = void 0;
+exports.isExtendedResultType = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.logError = exports.runAsyncWrapper = exports.getMessage = exports.log = exports.CodeError = void 0;
 const crypto = __importStar(require("crypto-js"));
 const storage_1 = require("../storage");
 class CodeError extends Error {
@@ -84,17 +84,21 @@ function handleError(err, req, res) {
 function runAsyncWrapper(callback, onError) {
     return (req, res, next) => {
         callback(req, res, next).catch((e) => {
-            if (onError) {
-                onError(e);
-            }
-            else {
-                console.error(e);
-            }
+            logError(e, onError);
             handleError(e, req, res);
         });
     };
 }
 exports.runAsyncWrapper = runAsyncWrapper;
+function logError(e, onError) {
+    if (onError) {
+        onError(e);
+    }
+    else {
+        console.error(e);
+    }
+}
+exports.logError = logError;
 function encryptData(config, data) {
     return crypto.AES.encrypt(data, config.cryptoSecret || config.clientSecret).toString();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.26.2",
+  "version": "0.26.4",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",