@crowdin/app-project-module 0.7.0 → 0.8.0

package/README.md

@@ -30,6 +30,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Background tasks](#background-tasks)
 - [Error propagation](#error-propagation)
 - [Custom File Format](#custom-file-format)
+- [Custom MT](#custom-mt)
 - [Contributing](#contributing)
 - [Seeking Assistance](#seeking-assistance)
 - [License](#license)
@@ -377,7 +378,7 @@ configuration.integrartion.getIntegrationFiles = async (credentials, appSettings
 
 ## Custom File Format
 
-There is also a possibility to declare [custom file format module](https://support.crowdin.com/crowdin-apps-modules/#custom-file-format-module).
+Example of [custom file format module](https://support.crowdin.com/crowdin-apps-modules/#custom-file-format-module).
 
 ```javascript
 const crowdinModule = require('@crowdin/app-project-module');
@@ -425,6 +426,34 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
+## Custom MT (Machine Translation)
+
+Example of [custom mt module](https://support.crowdin.com/crowdin-apps-modules/#custom-mt-machine-translation-module).
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+
+const configuration = {
+    baseUrl: 'https://123.ngrok.io',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    name: 'Sample App',
+    identifier: 'sample-app',
+    description: 'Sample App description',
+    dbFolder: __dirname,
+    imagePath: __dirname + '/' + 'logo.png',
+    customMT: {
+        translate: async (client, source, target, strings) => {
+            //translate strings
+            const translations = ['hello', 'world'];
+            return translations;
+        }
+    }
+};
+
+crowdinModule.createApp(configuration);
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/custom-mt/translate.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CustomMTLogic } from '../../models';
+export default function handle(config: CustomMTLogic): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;

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

@@ -0,0 +1,30 @@
+"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 });
+const util_1 = require("../../util");
+function handle(config) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const source = req.query.source;
+        const target = req.query.target;
+        const body = req.body;
+        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, source, target, body.strings);
+            res.send({ data: { translations } });
+        }
+    }));
+}
+exports.default = handle;

package/out/handlers/manifest.js

@@ -23,6 +23,15 @@ function handle(config) {
             },
         ];
     }
+    if (config.customMT) {
+        modules['custom-mt'] = [
+            {
+                key: config.identifier,
+                name: config.name,
+                url: '/translate',
+            },
+        ];
+    }
     return (_req, res) => {
         const manifest = {
             identifier: config.identifier,

package/out/index.js

@@ -33,6 +33,7 @@ const crowdin_project_1 = __importDefault(require("./handlers/crowdin-project"))
 const crowdin_update_1 = __importDefault(require("./handlers/crowdin-update"));
 const download_1 = __importDefault(require("./handlers/custom-file-format/download"));
 const process_1 = __importDefault(require("./handlers/custom-file-format/process"));
+const translate_1 = __importDefault(require("./handlers/custom-mt/translate"));
 const install_1 = __importDefault(require("./handlers/install"));
 const integration_data_1 = __importDefault(require("./handlers/integration-data"));
 const integration_login_1 = __importDefault(require("./handlers/integration-login"));
@@ -96,6 +97,9 @@ function addCrowdinEndpoints(app, config) {
         app.post('/process', (0, process_1.default)(config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
         app.get('/file/download', (0, download_1.default)(config.customFileFormat.filesFolder || config.dbFolder));
     }
+    if (config.customMT) {
+        app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config.customMT));
+    }
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
 function createApp(config) {

package/out/middlewares/crowdin-client.js

@@ -14,10 +14,8 @@ const storage_1 = require("../storage");
 const util_1 = require("../util");
 function handle(config, optional = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        const origin = req.query.origin;
-        const clientId = req.query.client_id;
-        const tokenJwt = req.query.tokenJwt;
-        if (!origin || !clientId || !tokenJwt || clientId !== config.clientId) {
+        const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
+        if (!tokenJwt) {
             return res.status(403).send({ error: 'Access denied' });
         }
         try {

package/out/models/index.d.ts

@@ -46,6 +46,10 @@ export interface Config {
      * custom file format module logic
      */
     customFileFormat?: CustomFileFormatLogic;
+    /**
+     * custom MT module logic
+     */
+    customMT?: CustomMTLogic;
 }
 export interface IntegrationLogic {
     /**
@@ -345,3 +349,10 @@ export interface ProcessFileString {
     text: string | SourceStringsModel.PluralText;
     translations?: any;
 }
+export interface CustomMTLogic {
+    translate: (client: Crowdin, source: string, target: string, strings: string[]) => Promise<string[]>;
+    validate?: (client: Crowdin) => Promise<void>;
+}
+export interface CustomMTRequest {
+    strings: string[];
+}

package/package.json

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