@crowdin/app-project-module 0.13.0 → 0.13.2

package/README.md

@@ -67,6 +67,10 @@ const configuration = {
     baseUrl: 'https://123.ngrok.io',
     clientId: 'clientId',
     clientSecret: 'clientSecret',
+    scopes: [
+        crowdinModule.Scope.PROJECTS,
+        crowdinModule.Scope.TRANSLATION_MEMORIES
+    ],
     name: 'Sample App',
     identifier: 'sample-app',
     description: 'Sample App description',
@@ -479,6 +483,9 @@ const configuration = {
         translate: async (client, context, projectId, source, target, strings) => {
             //translate strings
             const translations = ['hello', 'world'];
+            if (source === 'fr') {
+                throw 'Source language is not supported by the model';
+            }
             return translations;
         }
     }

package/out/handlers/custom-mt/translate.js

@@ -16,15 +16,23 @@ function handle(baseConfig, config) {
         const target = req.query.target;
         const body = req.body;
         const projectId = Number(req.query.project_id);
-        if (source === 'en' && target === 'de' && body.strings && body.strings[0] === 'validation') {
-            if (config.validate) {
-                yield config.validate(req.crowdinApiClient);
+        try {
+            if (source === 'en' && target === 'de' && body.strings && body.strings[0] === 'validation') {
+                if (config.validate) {
+                    yield config.validate(req.crowdinApiClient);
+                }
+                res.send({ data: { translations: [] } });
+            }
+            else {
+                const translations = yield config.translate(req.crowdinApiClient, req.crowdinContext, projectId, source, target, body.strings);
+                res.send({ data: { translations } });
             }
-            res.send({ data: { translations: [] } });
         }
-        else {
-            const translations = yield config.translate(req.crowdinApiClient, req.crowdinContext, projectId, source, target, body.strings);
-            res.send({ data: { translations } });
+        catch (e) {
+            const message = (0, util_1.getMessage)(e);
+            res.send({
+                error: { message },
+            });
         }
     }), baseConfig.onError);
 }

package/out/handlers/manifest.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const models_1 = require("../models");
 function handle(config) {
     const modules = {};
     // TEMPORARY CODE drop on step 3 of CN-30453
@@ -179,7 +180,7 @@ function handle(config) {
                 installed: '/installed',
                 uninstall: '/uninstall',
             },
-            scopes: ['project'],
+            scopes: config.scopes ? config.scopes : [models_1.Scope.PROJECTS],
             modules,
         };
         res.send(manifest);

package/out/index.d.ts

@@ -1,4 +1,5 @@
 import { Express } from 'express';
 import { Config, CrowdinAppUtilities } from './models';
+export { Scope } from './models';
 export declare function addCrowdinEndpoints(app: Express, config: Config): CrowdinAppUtilities;
 export declare function createApp(config: Config): void;

package/out/index.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createApp = exports.addCrowdinEndpoints = void 0;
+exports.createApp = exports.addCrowdinEndpoints = exports.Scope = void 0;
 const express_1 = __importDefault(require("express"));
 const express_handlebars_1 = __importDefault(require("express-handlebars"));
 const cron = __importStar(require("node-cron"));
@@ -60,6 +60,8 @@ const integration_credentials_1 = __importDefault(require("./middlewares/integra
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
 const storage = __importStar(require("./storage"));
 const util_1 = require("./util");
+var models_1 = require("./models");
+Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
 function addCrowdinEndpoints(app, config) {
     storage.connect(config.dbFolder);
     app.use(express_1.default.json({ limit: '50mb' }));

package/out/models/index.d.ts

@@ -14,6 +14,10 @@ export interface Config extends ImagePath {
      * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
      */
     baseUrl: string;
+    /**
+     * Set of scopes requested by this app (default 'project')
+     */
+    scopes?: Scope[];
     /**
      * app name
      */
@@ -99,6 +103,21 @@ export interface Config extends ImagePath {
      */
     onError?: (error: any) => void;
 }
+export declare enum Scope {
+    ALL_SCOPES = "all",
+    NOTIFICATIONS = "notification",
+    TRANSLATION_MEMORIES = "tm",
+    MACHINE_TRANSLATION_ENGINES = "mt",
+    GLOSSARIES = "glossary",
+    PROJECTS = "project",
+    TASKS = "project.task",
+    REPORTS = "project.report",
+    TRANSLATION_STATUS = "project.status",
+    SOURCE_FILES_AND_STRINGS = "project.source",
+    WEBHOOKS = "project.webhook",
+    TRANSLATIONS = "project.translation",
+    SCREENSHOTS = "project.screenshot"
+}
 export interface IntegrationLogic {
     /**
      * Customize your app login form

package/out/models/index.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = void 0;
+exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = exports.Scope = void 0;
+var Scope;
+(function (Scope) {
+    Scope["ALL_SCOPES"] = "all";
+    Scope["NOTIFICATIONS"] = "notification";
+    Scope["TRANSLATION_MEMORIES"] = "tm";
+    Scope["MACHINE_TRANSLATION_ENGINES"] = "mt";
+    Scope["GLOSSARIES"] = "glossary";
+    Scope["PROJECTS"] = "project";
+    Scope["TASKS"] = "project.task";
+    Scope["REPORTS"] = "project.report";
+    Scope["TRANSLATION_STATUS"] = "project.status";
+    Scope["SOURCE_FILES_AND_STRINGS"] = "project.source";
+    Scope["WEBHOOKS"] = "project.webhook";
+    Scope["TRANSLATIONS"] = "project.translation";
+    Scope["SCREENSHOTS"] = "project.screenshot";
+})(Scope = exports.Scope || (exports.Scope = {}));
 var AccountType;
 (function (AccountType) {
     AccountType["NORMAL"] = "normal";

package/out/util/index.d.ts

@@ -5,6 +5,7 @@ export declare class CodeError extends Error {
     code: number | undefined;
     constructor(message: string, code?: number);
 }
+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 encryptData(secret: string, data: string): string;
 export declare function decryptData(secret: string, data: string): string;

package/out/util/index.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filesCron = exports.runJob = exports.prepareIntegrationCredentials = exports.prepareCrowdinClient = exports.applyDefaults = exports.getRootFolder = exports.getOauthRoute = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.CodeError = void 0;
+exports.filesCron = exports.runJob = exports.prepareIntegrationCredentials = exports.prepareCrowdinClient = exports.applyDefaults = exports.getRootFolder = exports.getOauthRoute = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.getMessage = exports.CodeError = void 0;
 const crowdin_api_client_1 = __importDefault(require("@crowdin/crowdin-api-client"));
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
 const axios_1 = __importDefault(require("axios"));
@@ -48,6 +48,20 @@ exports.CodeError = CodeError;
 function isCrowdinClientRequest(req) {
     return req.crowdinContext;
 }
+function getMessage(err) {
+    let message;
+    if (typeof err === 'string') {
+        message = err;
+    }
+    else if (err.message) {
+        message = err.message;
+    }
+    else {
+        message = JSON.stringify(err);
+    }
+    return message;
+}
+exports.getMessage = getMessage;
 function handleError(err, req, res) {
     return __awaiter(this, void 0, void 0, function* () {
         const code = err.code ? err.code : 500;
@@ -58,17 +72,7 @@ function handleError(err, req, res) {
             res.redirect('/');
             return;
         }
-        let message;
-        if (typeof err === 'string') {
-            message = err;
-        }
-        else if (err.message) {
-            message = err.message;
-        }
-        else {
-            message = JSON.stringify(err);
-        }
-        res.status(code).send({ message, code });
+        res.status(code).send({ message: getMessage(err), code });
     });
 }
 function runAsyncWrapper(callback, onError) {

package/package.json

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