@crowdin/app-project-module 0.6.4 → 0.7.0

package/README.md

@@ -29,6 +29,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Info window](#info-window)
 - [Background tasks](#background-tasks)
 - [Error propagation](#error-propagation)
+- [Custom File Format](#custom-file-format)
 - [Contributing](#contributing)
 - [Seeking Assistance](#seeking-assistance)
 - [License](#license)
@@ -153,7 +154,7 @@ By default login page for your app will require only to  enter `apiToken` to com
 But there is also a possibility to customize it.
 
 ```javascript
-configuration.loginForm = {
+configuration.integration.loginForm = {
     fields: [
         {
             key: 'username',
@@ -181,7 +182,7 @@ In case if third party service uses OAuth2 for authorization use `oauthLogin` fi
 Github example:
 
 ```javascript
-configuration.oauthLogin = {
+configuration.integration.oauthLogin = {
     authorizationUrl: 'https://github.com/login/oauth/authorize',
     clientId: 'github_app_client_id',
     clientSecret: 'github_app_client_secret',
@@ -192,7 +193,7 @@ configuration.oauthLogin = {
 Google example:
 
 ```javascript
-configuration.oauthLogin = {
+configuration.integration.oauthLogin = {
     scope: 'https%3A//www.googleapis.com/auth/userinfo.email',
     authorizationUrl: 'https://accounts.google.com/o/oauth2/v2/auth',
     clientId: 'google_web_app_client_id',
@@ -239,7 +240,7 @@ const clientId = 'client_id';
 const clientSecret = 'client_secret';
 const tokenUrl = 'https://services.mailup.com/Authorization/OAuth/Token';
 
-configuration.oauthLogin = {
+configuration.integration.oauthLogin = {
     authorizationUrl: 'https://services.mailup.com/Authorization/OAuth/LogOn',
     clientId,
     clientSecret,
@@ -374,6 +375,56 @@ 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).
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+const convert = require('xml-js');
+
+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',
+    customFileFormat: {
+        type: 'type-xyz',
+        multilingual: false,
+        signaturePatterns: {
+            fileName: '^.+\.xml$'
+        },
+        parseFile: async (file, req) => {
+            const xml = convert.xml2json(file, { compact: true, spaces: 4 });
+            const fileContent = JSON.parse(xml);
+            //parse logic
+            const strings = [];
+            return { strings };
+        },
+        buildFile: async (file, req, strings) => {
+            const xml = convert.xml2json(file, { compact: true, spaces: 4 });
+            const fileContent = JSON.parse(xml);
+            //build logic
+            const contentFile = convert.json2xml(
+                fileContent,
+                {
+                    compact: true,
+                    ignoreComment: false,
+                    spaces: 4
+                }
+            );
+            return { contentFile }
+        }
+    }
+};
+
+crowdinModule.createApp(configuration);
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/crowdin-files.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (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/crowdin-files.js

@@ -10,12 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        if (config.integration.getCrowdinFiles) {
-            const rootFolder = yield (0, util_1.getRootFolder)(config, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
-            const files = config.integration.getCrowdinFiles
-                ? yield config.integration.getCrowdinFiles(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, rootFolder, req.integrationSettings)
+        if (integration.getCrowdinFiles) {
+            const rootFolder = yield (0, util_1.getRootFolder)(config, integration, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
+            const files = integration.getCrowdinFiles
+                ? yield integration.getCrowdinFiles(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, rootFolder, req.integrationSettings)
                 : [];
             res.send(files);
         }

package/out/handlers/crowdin-update.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (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/crowdin-update.js

@@ -10,10 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const rootFolder = yield (0, util_1.getRootFolder)(config, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
-        yield config.integration.updateCrowdin(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
+        const rootFolder = yield (0, util_1.getRootFolder)(config, integration, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
+        yield integration.updateCrowdin(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
         res.status(204).end();
     }));
 }

package/out/handlers/custom-file-format/download.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="qs" />
+import { Request, Response } from 'express';
+export default function handle(folder: string): (req: 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-file-format/download.js

@@ -0,0 +1,31 @@
+"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 });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const util_1 = require("../../util");
+function handle(folder) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const filePath = path_1.default.join(folder, 'custom-file-format', req.query.file);
+        res.download(filePath, function (err) {
+            if (err) {
+                console.error(err);
+            }
+            else {
+                fs_1.default.unlinkSync(filePath);
+            }
+        });
+    }));
+}
+exports.default = handle;

package/out/handlers/custom-file-format/process.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Request, Response } from 'express';
+import { CustomFileFormatLogic } from '../../models';
+export default function handle(baseUrl: string, folder: string, config: CustomFileFormatLogic): (req: 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-file-format/process.js

@@ -0,0 +1,110 @@
+"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 });
+const axios_1 = __importDefault(require("axios"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const models_1 = require("../../models");
+const util_1 = require("../../util");
+const MAX_BODY_SIZE = 5 * 1024 * 1024; //5mb
+function storeFile(fileContent, folder) {
+    const fileName = `file${Date.now()}`;
+    return new Promise((res, rej) => fs_1.default.writeFile(path_1.default.join(folder, 'custom-file-format', fileName), fileContent, err => {
+        if (err) {
+            rej(err);
+        }
+        else {
+            res(fileName);
+        }
+    }));
+}
+function handleBuildFile(baseUrl, dataFolder, config, file, req) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = {};
+        if (!req.strings && !req.stringsUrl) {
+            throw new Error('Bad payload received: No strings found');
+        }
+        let strings;
+        if (req.strings) {
+            strings = req.strings;
+        }
+        else {
+            strings = (yield axios_1.default.get(req.stringsUrl)).data;
+        }
+        const res = yield config.buildFile(file, req, strings);
+        const contentFileEncoded = Buffer.from(res.contentFile).toString('base64');
+        if (Buffer.byteLength(contentFileEncoded, 'utf8') < MAX_BODY_SIZE) {
+            response.content = contentFileEncoded;
+        }
+        else {
+            const storedFile = yield storeFile(res.contentFile, dataFolder);
+            response.contentUrl = `${baseUrl}?file=${storedFile}`;
+        }
+        return response;
+    });
+}
+function handleParseFile(baseUrl, dataFolder, config, file, req) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = {};
+        const res = yield config.parseFile(file, req);
+        if (res.previewFile) {
+            const previewFileEncoded = Buffer.from(res.previewFile).toString('base64');
+            if (Buffer.byteLength(previewFileEncoded, 'utf8') < MAX_BODY_SIZE) {
+                response.preview = previewFileEncoded;
+            }
+            else {
+                const storedFile = yield storeFile(res.previewFile, dataFolder);
+                response.previewUrl = `${baseUrl}?file=${storedFile}`;
+            }
+        }
+        if (res.strings) {
+            const stringsJson = JSON.stringify(res.strings);
+            if (Buffer.byteLength(stringsJson, 'utf8') < MAX_BODY_SIZE) {
+                response.strings = res.strings;
+            }
+            else {
+                const storedFile = yield storeFile(stringsJson, dataFolder);
+                response.stringsUrl = `${baseUrl}?file=${storedFile}`;
+            }
+        }
+        return response;
+    });
+}
+function handle(baseUrl, folder, config) {
+    if (!fs_1.default.existsSync(path_1.default.join(folder, 'custom-file-format'))) {
+        fs_1.default.mkdirSync(path_1.default.join(folder, 'custom-file-format'), { recursive: true });
+    }
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const baseFilesUrl = `${baseUrl}/file/download`;
+        const body = req.body;
+        let file;
+        if (body.file.content) {
+            file = Buffer.from(body.file.content, 'base64').toString();
+        }
+        else {
+            file = (yield axios_1.default.get(body.file.contentUrl || '')).data;
+        }
+        let response = {};
+        switch (body.jobType) {
+            case models_1.ProcessFileJobType.BUILD_FILE:
+                response = yield handleBuildFile(baseFilesUrl, folder, config, file, body);
+                break;
+            case models_1.ProcessFileJobType.PARSE_FILE:
+                response = yield handleParseFile(baseFilesUrl, folder, config, file, body);
+                break;
+        }
+        res.send({ data: response });
+    }));
+}
+exports.default = handle;

package/out/handlers/integration-data.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { IntegrationLogic } from '../models';
+export default function handle(integration: IntegrationLogic): (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/integration-data.js

@@ -10,9 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function handle(config) {
+function handle(integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const files = yield config.integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings);
+        const files = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings);
         res.send(files);
     }));
 }

package/out/handlers/integration-login.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (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/integration-login.js

@@ -11,10 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        if (config.integration.checkConnection) {
-            yield config.integration.checkConnection(req.body.credentials);
+        if (integration.checkConnection) {
+            yield integration.checkConnection(req.body.credentials);
         }
         yield (0, storage_1.saveIntegrationCredentials)(req.crowdinContext.clientId, (0, util_1.encryptData)(config.clientSecret, JSON.stringify(req.body.credentials)), req.crowdinContext.crowdinId);
         res.status(204).end();

package/out/handlers/integration-update.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (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/integration-update.js

@@ -10,10 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const rootFolder = yield (0, util_1.getRootFolder)(config, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
-        yield config.integration.updateIntegration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
+        const rootFolder = yield (0, util_1.getRootFolder)(config, integration, req.crowdinApiClient, req.crowdinContext.jwtPayload.context.project_id);
+        yield integration.updateIntegration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
         res.status(204).end();
     }));
 }

package/out/handlers/main.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (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/main.js

@@ -10,12 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function constructOauthUrl(config) {
+function constructOauthUrl(config, integration) {
     var _a, _b, _c;
-    const oauth = config.oauthLogin;
+    const oauth = integration.oauthLogin;
     let url = (oauth === null || oauth === void 0 ? void 0 : oauth.authorizationUrl) || '';
     url += `?${((_a = oauth === null || oauth === void 0 ? void 0 : oauth.fieldsMapping) === null || _a === void 0 ? void 0 : _a.clientId) || 'client_id'}=${oauth === null || oauth === void 0 ? void 0 : oauth.clientId}`;
-    url += `&${((_b = oauth === null || oauth === void 0 ? void 0 : oauth.fieldsMapping) === null || _b === void 0 ? void 0 : _b.redirectUri) || 'redirect_uri'}=${config.baseUrl}${(0, util_1.getOauthRoute)(config)}`;
+    url += `&${((_b = oauth === null || oauth === void 0 ? void 0 : oauth.fieldsMapping) === null || _b === void 0 ? void 0 : _b.redirectUri) || 'redirect_uri'}=${config.baseUrl}${(0, util_1.getOauthRoute)(integration)}`;
     if (oauth === null || oauth === void 0 ? void 0 : oauth.scope) {
         url += `&${((_c = oauth === null || oauth === void 0 ? void 0 : oauth.fieldsMapping) === null || _c === void 0 ? void 0 : _c.scope) || 'scope'}=${oauth === null || oauth === void 0 ? void 0 : oauth.scope}`;
     }
@@ -24,7 +24,7 @@ function constructOauthUrl(config) {
     }
     return url;
 }
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         var _a;
         const installed = !!req.crowdinApiClient;
@@ -38,17 +38,17 @@ function handle(config) {
         }
         else if (!loggedIn) {
             view = 'login';
-            options.loginFields = (_a = config.loginForm) === null || _a === void 0 ? void 0 : _a.fields;
-            if (config.oauthLogin) {
-                options.oauthUrl = constructOauthUrl(config);
+            options.loginFields = (_a = integration.loginForm) === null || _a === void 0 ? void 0 : _a.fields;
+            if (integration.oauthLogin) {
+                options.oauthUrl = constructOauthUrl(config, integration);
             }
         }
-        else if (config.integration.getConfiguration) {
-            const configurationFields = yield config.integration.getConfiguration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials);
+        else if (integration.getConfiguration) {
+            const configurationFields = yield integration.getConfiguration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials);
             options.configurationFields = configurationFields;
             options.config = JSON.stringify(req.integrationSettings || {});
         }
-        options.infoModal = config.integration.infoModal;
+        options.infoModal = integration.infoModal;
         return res.render(view, options);
     }));
 }

package/out/handlers/manifest.js

@@ -1,6 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 function handle(config) {
+    const modules = {};
+    if (config.integration) {
+        modules.integrations = [
+            {
+                key: config.identifier,
+                name: config.name,
+                description: config.description,
+                logo: '/logo.png',
+                url: '/',
+            },
+        ];
+    }
+    if (config.customFileFormat) {
+        modules['custom-file-format'] = [
+            {
+                key: config.identifier,
+                type: config.customFileFormat.type,
+                signaturePatterns: config.customFileFormat.signaturePatterns,
+                url: '/process',
+            },
+        ];
+    }
     return (_req, res) => {
         const manifest = {
             identifier: config.identifier,
@@ -16,17 +38,7 @@ function handle(config) {
                 uninstall: '/uninstall',
             },
             scopes: ['project'],
-            modules: {
-                integrations: [
-                    {
-                        key: config.identifier,
-                        name: config.name,
-                        description: config.description,
-                        logo: '/logo.png',
-                        url: '/',
-                    },
-                ],
-            },
+            modules,
         };
         res.send(manifest);
     };

package/out/handlers/oauth-login.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (req: 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/oauth-login.js

@@ -14,26 +14,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-        const code = req.query[((_b = (_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.fieldsMapping) === null || _b === void 0 ? void 0 : _b.code) || 'code'];
-        const oauthLogin = config.oauthLogin;
+        const code = req.query[((_b = (_a = integration.oauthLogin) === null || _a === void 0 ? void 0 : _a.fieldsMapping) === null || _b === void 0 ? void 0 : _b.code) || 'code'];
+        const oauthLogin = integration.oauthLogin;
         let credentials;
         if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.performGetTokenRequest) {
             credentials = yield oauthLogin.performGetTokenRequest(code);
         }
         else {
             const request = {};
-            const oauthLogin = config.oauthLogin;
+            const oauthLogin = integration.oauthLogin;
             request[((_c = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _c === void 0 ? void 0 : _c.code) || 'code'] = code;
             request[((_d = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _d === void 0 ? void 0 : _d.clientId) || 'client_id'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientId;
             request[((_e = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _e === void 0 ? void 0 : _e.clientSecret) || 'client_secret'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientSecret;
-            request[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.redirectUri) || 'redirect_uri'] = `${config.baseUrl}${(0, util_1.getOauthRoute)(config)}`;
+            request[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.redirectUri) || 'redirect_uri'] = `${config.baseUrl}${(0, util_1.getOauthRoute)(integration)}`;
             if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters) {
                 Object.entries(oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters).forEach(([key, value]) => (request[key] = value));
             }
-            credentials = (yield axios_1.default.post(((_g = config.oauthLogin) === null || _g === void 0 ? void 0 : _g.accessTokenUrl) || '', request, {
+            credentials = (yield axios_1.default.post(((_g = integration.oauthLogin) === null || _g === void 0 ? void 0 : _g.accessTokenUrl) || '', request, {
                 headers: { Accept: 'application/json' },
             })).data;
         }

package/out/index.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApp = exports.addCrowdinEndpoints = void 0;
-const express_1 = __importStar(require("express"));
+const express_1 = __importDefault(require("express"));
 const express_handlebars_1 = __importDefault(require("express-handlebars"));
 const cron = __importStar(require("node-cron"));
 const path_1 = require("path");
@@ -31,6 +31,8 @@ const crowdin_file_progress_1 = __importDefault(require("./handlers/crowdin-file
 const crowdin_files_1 = __importDefault(require("./handlers/crowdin-files"));
 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 install_1 = __importDefault(require("./handlers/install"));
 const integration_data_1 = __importDefault(require("./handlers/integration-data"));
 const integration_login_1 = __importDefault(require("./handlers/integration-login"));
@@ -47,9 +49,8 @@ const json_response_1 = __importDefault(require("./middlewares/json-response"));
 const storage_1 = require("./storage");
 const util_1 = require("./util");
 function addCrowdinEndpoints(app, config) {
-    (0, util_1.applyDefaults)(config);
     (0, storage_1.connect)(config.dbFolder);
-    app.use((0, express_1.json)());
+    app.use(express_1.default.json({ limit: '50mb' }));
     app.use('/assets', express_1.default.static((0, path_1.join)(__dirname, 'static')));
     app.set('views', (0, path_1.join)(__dirname, 'views'));
     app.engine('handlebars', (0, express_handlebars_1.default)({
@@ -66,26 +67,34 @@ function addCrowdinEndpoints(app, config) {
     }));
     app.set('view engine', 'handlebars');
     app.get('/logo.png', (req, res) => res.sendFile(config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
-    if (config.oauthLogin) {
-        app.get((0, util_1.getOauthRoute)(config), (0, oauth_login_1.default)(config));
-    }
-    app.get('/', (0, crowdin_client_1.default)(config, true), (0, integration_credentials_1.default)(config, true), (0, main_1.default)(config));
-    app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)());
-    app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, settings_save_1.default)());
-    app.post('/api/login', (0, crowdin_client_1.default)(config), (0, integration_login_1.default)(config));
-    app.post('/api/logout', (0, crowdin_client_1.default)(config), (0, integration_logout_1.default)());
-    app.get('/api/crowdin/files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, crowdin_files_1.default)(config));
-    app.get('/api/crowdin/project', json_response_1.default, (0, crowdin_client_1.default)(config), (0, crowdin_project_1.default)());
-    app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)());
-    app.get('/api/integration/data', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, integration_data_1.default)(config));
-    app.post('/api/crowdin/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, crowdin_update_1.default)(config));
-    app.post('/api/integration/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, integration_update_1.default)(config));
-    if (config.integration.cronJobs) {
-        config.integration.cronJobs.forEach(job => {
-            cron.schedule(job.expression, () => (0, util_1.runJob)(config, job).catch(console.error));
-        });
+    app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
+    const integrationLogic = config.integration;
+    if (integrationLogic) {
+        (0, util_1.applyDefaults)(config, integrationLogic);
+        app.get('/', (0, crowdin_client_1.default)(config, true), (0, integration_credentials_1.default)(config, integrationLogic, true), (0, main_1.default)(config, integrationLogic));
+        app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)());
+        app.post('/api/login', (0, crowdin_client_1.default)(config), (0, integration_login_1.default)(config, integrationLogic));
+        app.post('/api/logout', (0, crowdin_client_1.default)(config), (0, integration_logout_1.default)());
+        app.get('/api/crowdin/files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, crowdin_files_1.default)(config, integrationLogic));
+        app.get('/api/crowdin/project', json_response_1.default, (0, crowdin_client_1.default)(config), (0, crowdin_project_1.default)());
+        app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)());
+        app.get('/api/integration/data', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_data_1.default)(integrationLogic));
+        app.post('/api/crowdin/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, crowdin_update_1.default)(config, integrationLogic));
+        app.post('/api/integration/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_update_1.default)(config, integrationLogic));
+        if (integrationLogic.oauthLogin) {
+            app.get((0, util_1.getOauthRoute)(integrationLogic), (0, oauth_login_1.default)(config, integrationLogic));
+        }
+        if (integrationLogic.cronJobs) {
+            integrationLogic.cronJobs.forEach(job => {
+                cron.schedule(job.expression, () => (0, util_1.runJob)(config, integrationLogic, job).catch(console.error));
+            });
+        }
+    }
+    if (config.customFileFormat) {
+        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));
     }
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;

package/out/middlewares/integration-credentials.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config, optional?: boolean): (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;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic, optional?: boolean): (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/middlewares/integration-credentials.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
-function handle(config, optional = false) {
+function handle(config, integration, optional = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
         const clientId = req.crowdinContext.clientId;
         const integrationCredentials = yield (0, storage_1.getIntegrationCredentials)(clientId);
@@ -25,7 +25,7 @@ function handle(config, optional = false) {
             req.integrationSettings = JSON.parse(integrationCredentials.config);
         }
         try {
-            req.integrationCredentials = yield (0, util_1.prepareIntegrationCredentials)(config, integrationCredentials);
+            req.integrationCredentials = yield (0, util_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
         }
         catch (e) {
             console.error(e);

package/out/models/index.d.ts

@@ -1,4 +1,4 @@
-import Crowdin, { SourceFilesModel } from '@crowdin/crowdin-api-client';
+import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel } from '@crowdin/crowdin-api-client';
 import { JwtPayload } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
 export interface Config {
@@ -39,9 +39,15 @@ export interface Config {
      */
     imagePath?: string;
     /**
-     * integration logic
+     * integration module logic
      */
-    integration: IntegrationLogic;
+    integration?: IntegrationLogic;
+    /**
+     * custom file format module logic
+     */
+    customFileFormat?: CustomFileFormatLogic;
+}
+export interface IntegrationLogic {
     /**
      * Customize your app login form
      */
@@ -50,8 +56,6 @@ export interface Config {
      * Define login process via OAuth2 protocol
      */
     oauthLogin?: OAuthLogin;
-}
-export interface IntegrationLogic {
     /**
      * name of the root folder in Crowdin where files from integration will be stored, default your app name, will be ignored in case if {@link withRootFolder} is false
      */
@@ -275,3 +279,69 @@ export interface CronJob {
     task: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
     expression: string;
 }
+export interface CustomFileFormatLogic {
+    /**
+     * The type parameter value for a custom file format. Used for a custom format file upload via API.
+     */
+    type: string;
+    /**
+     * Folder where larger file will be temporary stored (default "{@link dbFolder}/custom-file-format")
+     */
+    filesFolder?: string;
+    /**
+     * This parameter is used to combine the content of multiple languages into one request when uploading and downloading translations in your Crowdin project.
+     */
+    multilingual?: boolean;
+    /**
+     *  Contains fileName and/or fileContent regular expressions used to detect file type when uploading a new source file via UI (or via API without specified type parameter). If the file matches regular expressions, it's labeled as a custom format file.
+     */
+    signaturePatterns?: SignaturePatterns;
+    /**
+     * Used for initial source file upload, source file update, and translation upload
+     */
+    parseFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>) => Promise<ParseFileResponse>;
+    /**
+     * Used for translation download
+     */
+    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[]) => Promise<BuildFileResponse>;
+}
+export interface SignaturePatterns {
+    fileName?: string;
+    fileContent?: string;
+}
+export interface ProcessFileRequest {
+    jobType: ProcessFileJobType;
+    file: ProcessFileRecord;
+    sourceLanguage: LanguagesModel.Language;
+    targetLanguages: LanguagesModel.Language[];
+    strings: ProcessFileString[];
+    stringsUrl: string;
+}
+export interface ProcessFileRecord {
+    content?: string;
+    contentUrl?: string;
+}
+export declare enum ProcessFileJobType {
+    PARSE_FILE = "parse-file",
+    BUILD_FILE = "build-file"
+}
+export interface ParseFileResponse {
+    previewFile?: string;
+    strings?: ProcessFileString[];
+}
+export interface BuildFileResponse {
+    contentFile: string;
+}
+export interface ProcessFileString {
+    previewId?: number;
+    id: number;
+    identifier: string;
+    context?: string;
+    customData?: string;
+    maxLength?: number;
+    isHidden?: boolean;
+    hasPlurals?: boolean;
+    labels?: string[];
+    text: string | SourceStringsModel.PluralText;
+    translations?: any;
+}

package/out/models/index.js

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccountType = void 0;
+exports.ProcessFileJobType = exports.AccountType = void 0;
 var AccountType;
 (function (AccountType) {
     AccountType["NORMAL"] = "normal";
     AccountType["ENTERPRISE"] = "enterprise";
 })(AccountType = exports.AccountType || (exports.AccountType = {}));
+var ProcessFileJobType;
+(function (ProcessFileJobType) {
+    ProcessFileJobType["PARSE_FILE"] = "parse-file";
+    ProcessFileJobType["BUILD_FILE"] = "build-file";
+})(ProcessFileJobType = exports.ProcessFileJobType || (exports.ProcessFileJobType = {}));

package/out/util/index.d.ts

@@ -1,6 +1,6 @@
 import Crowdin, { SourceFilesModel } from '@crowdin/crowdin-api-client';
 import { Request, Response } from 'express';
-import { Config, CronJob, CrowdinCredentials, IntegrationCredentials } from '../models';
+import { Config, CronJob, CrowdinCredentials, IntegrationCredentials, IntegrationLogic } from '../models';
 export declare class CodeError extends Error {
     code: number | undefined;
     constructor(message: string, code?: number);
@@ -8,9 +8,9 @@ export declare class CodeError extends Error {
 export declare function runAsyncWrapper(callback: Function): (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;
-export declare function getOauthRoute(config: Config): string;
-export declare function getRootFolder(config: Config, client: Crowdin, projectId: number): Promise<SourceFilesModel.Directory | undefined>;
-export declare function applyDefaults(config: Config): void;
+export declare function getOauthRoute(integration: IntegrationLogic): string;
+export declare function getRootFolder(config: Config, integration: IntegrationLogic, client: Crowdin, projectId: number): Promise<SourceFilesModel.Directory | undefined>;
+export declare function applyDefaults(config: Config, integration: IntegrationLogic): void;
 export declare function prepareCrowdinClient(config: Config, credentials: CrowdinCredentials): Promise<Crowdin>;
-export declare function prepareIntegrationCredentials(config: Config, integrationCredentials: IntegrationCredentials): Promise<any>;
-export declare function runJob(config: Config, job: CronJob): Promise<void>;
+export declare function prepareIntegrationCredentials(config: Config, integration: IntegrationLogic, integrationCredentials: IntegrationCredentials): Promise<any>;
+export declare function runJob(config: Config, integration: IntegrationLogic, job: CronJob): Promise<void>;

package/out/util/index.js

@@ -79,26 +79,26 @@ function decryptData(secret, data) {
     return crypto.AES.decrypt(data, secret).toString(crypto.enc.Utf8);
 }
 exports.decryptData = decryptData;
-function getOauthRoute(config) {
+function getOauthRoute(integration) {
     var _a;
-    return ((_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.redirectUriRoute) || '/oauth/code';
+    return ((_a = integration.oauthLogin) === null || _a === void 0 ? void 0 : _a.redirectUriRoute) || '/oauth/code';
 }
 exports.getOauthRoute = getOauthRoute;
-function getRootFolder(config, client, projectId) {
+function getRootFolder(config, integration, client, projectId) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!config.integration.withRootFolder) {
+        if (!integration.withRootFolder) {
             return;
         }
-        const folder = config.integration.appFolderName || config.name;
+        const folder = integration.appFolderName || config.name;
         const directories = (yield client.sourceFilesApi.withFetchAll().listProjectDirectories(projectId)).data.map(d => d.data);
         const { folder: rootFolder } = yield crowdinAppFunctions.getOrCreateFolder(directories, client, projectId, folder);
         return rootFolder;
     });
 }
 exports.getRootFolder = getRootFolder;
-function applyDefaults(config) {
-    if (!config.integration.getCrowdinFiles) {
-        config.integration.getCrowdinFiles = (projectId, client, rootFolder) => __awaiter(this, void 0, void 0, function* () {
+function applyDefaults(config, integration) {
+    if (!integration.getCrowdinFiles) {
+        integration.getCrowdinFiles = (projectId, client, rootFolder) => __awaiter(this, void 0, void 0, function* () {
             let allDirectories;
             if (rootFolder) {
                 allDirectories = (yield client.sourceFilesApi
@@ -138,8 +138,8 @@ function applyDefaults(config) {
             return res;
         });
     }
-    if (!config.loginForm) {
-        config.loginForm = {
+    if (!integration.loginForm) {
+        integration.loginForm = {
             fields: [
                 {
                     helpText: 'You need to create standard api key',
@@ -178,12 +178,12 @@ function prepareCrowdinClient(config, credentials) {
     });
 }
 exports.prepareCrowdinClient = prepareCrowdinClient;
-function prepareIntegrationCredentials(config, integrationCredentials) {
+function prepareIntegrationCredentials(config, integration, integrationCredentials) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return __awaiter(this, void 0, void 0, function* () {
         const credentials = JSON.parse(decryptData(config.clientSecret, integrationCredentials.credentials));
-        if ((_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.refresh) {
-            const oauthLogin = config.oauthLogin;
+        if ((_a = integration.oauthLogin) === null || _a === void 0 ? void 0 : _a.refresh) {
+            const oauthLogin = integration.oauthLogin;
             const { expireIn } = credentials;
             //2 min as an extra buffer
             const isExpired = expireIn + 120 < Date.now() / 1000;
@@ -218,7 +218,7 @@ function prepareIntegrationCredentials(config, integrationCredentials) {
     });
 }
 exports.prepareIntegrationCredentials = prepareIntegrationCredentials;
-function runJob(config, job) {
+function runJob(config, integration, job) {
     return __awaiter(this, void 0, void 0, function* () {
         const crowdinCredentialsList = yield (0, storage_1.getAllCrowdinCredentials)();
         yield Promise.all(crowdinCredentialsList.map((crowdinCredentials) => __awaiter(this, void 0, void 0, function* () {
@@ -226,8 +226,8 @@ function runJob(config, job) {
             const integrationCredentialsList = yield (0, storage_1.getAllIntegrationCredentials)(crowdinCredentials.id);
             yield Promise.all(integrationCredentialsList.map((integrationCredentials) => __awaiter(this, void 0, void 0, function* () {
                 const projectId = crowdinAppFunctions.getProjectId(integrationCredentials.id);
-                const apiCredentials = yield prepareIntegrationCredentials(config, integrationCredentials);
-                const rootFolder = yield getRootFolder(config, crowdinClient, projectId);
+                const apiCredentials = yield prepareIntegrationCredentials(config, integration, integrationCredentials);
+                const rootFolder = yield getRootFolder(config, integration, crowdinClient, projectId);
                 const intConfig = integrationCredentials.config
                     ? JSON.parse(integrationCredentials.config)
                     : undefined;

package/package.json

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