@crowdin/app-project-module 0.28.0-9 → 0.28.1

package/out/handlers/{custom-file-format/process.js → file-processing/custom-file-format.js}

@@ -12,12 +12,11 @@ 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 = 4.9 * 1024 * 1024; //4.9mb
+const files_1 = require("../../util/files");
 function handle(baseConfig, 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 });
@@ -38,7 +37,7 @@ function handle(baseConfig, baseUrl, folder, config) {
             file = Buffer.from(body.file.content, 'base64').toString();
         }
         else if (body.file.contentUrl) {
-            file = (yield axios_1.default.get(body.file.contentUrl)).data;
+            file = yield (0, files_1.getFileContent)(body.file.contentUrl);
         }
         let response = {};
         let error;
@@ -71,10 +70,7 @@ function handleBuildFile(baseUrl, dataFolder, config, req, client, context, proj
             strings = req.strings;
         }
         else {
-            // the response is presented in the ndjson format
-            const response = (yield axios_1.default.get(req.stringsUrl)).data;
-            const jsonRows = response.split(/\n|\n\r/).filter(Boolean);
-            strings = jsonRows.map((jsonStringRow) => JSON.parse(jsonStringRow));
+            strings = yield (0, files_1.getFileContent)(req.stringsUrl, true);
         }
         let res;
         if ((req.file.id || !file) && config.exportStrings) {
@@ -87,7 +83,7 @@ function handleBuildFile(baseUrl, dataFolder, config, req, client, context, proj
             return { response };
         }
         const contentFileEncoded = Buffer.from(res.contentFile).toString('base64');
-        if (Buffer.byteLength(contentFileEncoded, 'utf8') < MAX_BODY_SIZE) {
+        if (Buffer.byteLength(contentFileEncoded, 'utf8') < files_1.MAX_BODY_SIZE) {
             response.content = contentFileEncoded;
         }
         else {
@@ -96,7 +92,7 @@ function handleBuildFile(baseUrl, dataFolder, config, req, client, context, proj
                 url = yield config.storeFile(res.contentFile);
             }
             else {
-                const storedFile = yield storeFile(res.contentFile, dataFolder);
+                const storedFile = yield (0, files_1.storeFile)(res.contentFile, path_1.default.join(dataFolder, 'custom-file-format'));
                 url = `${baseUrl}?file=${storedFile}`;
             }
             response.contentUrl = url;
@@ -111,7 +107,7 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
             return { response };
         }
         const res = yield config.parseFile(file, req, client, context, projectId);
-        let maxSize = MAX_BODY_SIZE;
+        let maxSize = files_1.MAX_BODY_SIZE;
         if (res.strings && res.previewFile) {
             maxSize = maxSize / 2;
         }
@@ -126,7 +122,7 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                     url = yield config.storeFile(res.previewFile);
                 }
                 else {
-                    const storedFile = yield storeFile(res.previewFile, dataFolder);
+                    const storedFile = yield (0, files_1.storeFile)(res.previewFile, path_1.default.join(dataFolder, 'custom-file-format'));
                     url = `${baseUrl}?file=${storedFile}`;
                 }
                 response.previewUrl = url;
@@ -153,7 +149,7 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                     url = yield config.storeFile(stringsNDJson);
                 }
                 else {
-                    const storedFile = yield storeFile(stringsNDJson, dataFolder);
+                    const storedFile = yield (0, files_1.storeFile)(stringsNDJson, path_1.default.join(dataFolder, 'custom-file-format'));
                     url = `${baseUrl}?file=${storedFile}`;
                 }
                 response.stringsUrl = url;
@@ -162,14 +158,3 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
         return { response, error: res.error };
     });
 }
-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);
-        }
-    }));
-}

package/out/handlers/file-processing/file-download.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Request, Response } from 'express';
+import { Config, FileProcessLogic } from '../../models';
+export default function handle(config: Config, processingConfig: FileProcessLogic, folderName: 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 → file-processing/file-download.js}

@@ -15,9 +15,10 @@ 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(config, folder) {
+function handle(config, processingConfig, folderName) {
+    const folder = processingConfig.filesFolder || config.dbFolder;
     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);
+        const filePath = path_1.default.join(folder, folderName, req.query.file);
         (0, util_1.log)(`Downloading file ${filePath}`, config.logger);
         res.download(filePath, function (err) {
             if (err) {

package/out/handlers/file-processing/pre-post-process.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { Config, FileImportExportLogic } from '../../models';
+export default function handle(baseConfig: Config, config: FileImportExportLogic, folderName: string): (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/file-processing/pre-post-process.js

@@ -0,0 +1,99 @@
+"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 models_1 = require("../../models");
+const util_1 = require("../../util");
+const files_1 = require("../../util/files");
+function handle(baseConfig, config, folderName) {
+    const folderPath = config.filesFolder || baseConfig.dbFolder;
+    if (!fs_1.default.existsSync(path_1.default.join(folderPath, folderName))) {
+        fs_1.default.mkdirSync(path_1.default.join(folderPath, folderName), { recursive: true });
+    }
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const response = {};
+        const baseFilesUrl = `${baseConfig.baseUrl}/file/download/${folderName}`;
+        const body = req.body;
+        let processingError;
+        let fileContent;
+        if (body.stringsUrl) {
+            fileContent = yield (0, files_1.getFileContent)(body.stringsUrl, true);
+        }
+        else if (body.strings) {
+            fileContent = body.strings;
+        }
+        else if (body.file.contentUrl) {
+            fileContent = yield (0, files_1.getFileContent)(body.file.contentUrl);
+        }
+        else if (body.file.content) {
+            fileContent = Buffer.from(body.file.content, 'base64').toString();
+        }
+        const fileProcessResult = yield config.fileProcess(body, fileContent, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
+        switch (body.jobType) {
+            case models_1.ProcessFileJobType.PRE_IMPORT:
+            case models_1.ProcessFileJobType.POST_EXPORT:
+                const { contentFile, base64EncodedContent, fileName, fileType, error: contentFileError, } = fileProcessResult;
+                if (contentFile) {
+                    const contentFileEncoded = base64EncodedContent || Buffer.from(contentFile).toString('base64');
+                    if (Buffer.byteLength(contentFileEncoded, 'utf8') < files_1.MAX_BODY_SIZE) {
+                        response.content = contentFileEncoded;
+                    }
+                    else {
+                        let url;
+                        if (config.storeFile) {
+                            url = yield config.storeFile(contentFile);
+                        }
+                        else {
+                            const storedFile = yield (0, files_1.storeFile)(contentFile, path_1.default.join(folderPath, folderName));
+                            url = `${baseFilesUrl}?file=${storedFile}`;
+                        }
+                        response.contentUrl = url;
+                    }
+                }
+                if (fileName) {
+                    response.fileName = fileName;
+                }
+                if (fileType) {
+                    response.fileType = fileType;
+                }
+                processingError = contentFileError;
+                break;
+            case models_1.ProcessFileJobType.POST_IMPORT:
+            case models_1.ProcessFileJobType.PRE_EXPORT:
+                const { strings, error: stringsFileError } = fileProcessResult;
+                if (strings) {
+                    const stringsNDJson = strings.map((s) => JSON.stringify(s)).join('\n\r');
+                    if (Buffer.byteLength(stringsNDJson, 'utf8') < files_1.MAX_BODY_SIZE) {
+                        response.strings = strings;
+                    }
+                    else {
+                        let url;
+                        if (config.storeFile) {
+                            url = yield config.storeFile(stringsNDJson);
+                        }
+                        else {
+                            const storedFile = yield (0, files_1.storeFile)(stringsNDJson, path_1.default.join(folderPath, folderName));
+                            url = `${baseFilesUrl}?file=${storedFile}`;
+                        }
+                        response.stringsUrl = url;
+                    }
+                }
+                processingError = stringsFileError;
+                break;
+        }
+        res.send({ data: response, error: processingError ? { message: processingError } : undefined });
+    }), baseConfig.onError);
+}
+exports.default = handle;

package/out/handlers/manifest.js

@@ -31,6 +31,42 @@ function handle(config) {
             },
         ];
     }
+    if (config.filePreImport) {
+        modules['file-pre-import'] = [
+            {
+                key: config.identifier + '-pri',
+                signaturePatterns: config.filePreImport.signaturePatterns,
+                url: '/pre-import',
+            },
+        ];
+    }
+    if (config.filePostImport) {
+        modules['file-post-import'] = [
+            {
+                key: config.identifier + '-poi',
+                signaturePatterns: config.filePostImport.signaturePatterns,
+                url: '/post-import',
+            },
+        ];
+    }
+    if (config.filePreExport) {
+        modules['file-pre-export'] = [
+            {
+                key: config.identifier + '-pre',
+                signaturePatterns: config.filePreExport.signaturePatterns,
+                url: '/pre-export',
+            },
+        ];
+    }
+    if (config.filePostExport) {
+        modules['file-post-export'] = [
+            {
+                key: config.identifier + '-poe',
+                signaturePatterns: config.filePostExport.signaturePatterns,
+                url: '/post-export',
+            },
+        ];
+    }
     if (config.customMT) {
         modules['custom-mt'] = [
             {
@@ -116,6 +152,33 @@ function handle(config) {
             },
         ];
     }
+    if (config.modal) {
+        modules['modal'] = [
+            {
+                key: config.identifier + '-modal',
+                name: config.name,
+                url: config.modal.url,
+                environments: config.modal.environments,
+            },
+        ];
+    }
+    if (config.contextMenu) {
+        modules['context-menu'] = [
+            {
+                key: config.identifier + '-context-menu',
+                name: config.name,
+                description: config.description,
+                options: Object.assign(Object.assign({ location: config.contextMenu.location, type: config.contextMenu.type }, (config.contextMenu.module
+                    ? {
+                        module: {
+                            [config.contextMenu.module]: modules[config.contextMenu.module][0].key,
+                        },
+                    }
+                    : {})), { url: config.contextMenu.url }),
+                environments: config.contextMenu.environments,
+            },
+        ];
+    }
     const events = {
         installed: '/installed',
         uninstall: '/uninstall',

package/out/index.d.ts

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

package/out/index.js

@@ -45,22 +45,23 @@ 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 crowdin_webhook_1 = __importDefault(require("./handlers/crowdin-webhook"));
-const integration_webhook_1 = __importDefault(require("./handlers/integration-webhook"));
-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 custom_file_format_1 = __importDefault(require("./handlers/file-processing/custom-file-format"));
+const file_download_1 = __importDefault(require("./handlers/file-processing/file-download"));
+const pre_post_process_1 = __importDefault(require("./handlers/file-processing/pre-post-process"));
+const form_data_display_1 = __importDefault(require("./handlers/form-data-display"));
+const form_data_save_1 = __importDefault(require("./handlers/form-data-save"));
 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"));
 const integration_logout_1 = __importDefault(require("./handlers/integration-logout"));
 const integration_update_1 = __importDefault(require("./handlers/integration-update"));
+const integration_webhook_1 = __importDefault(require("./handlers/integration-webhook"));
 const main_1 = __importDefault(require("./handlers/main"));
 const manifest_1 = __importDefault(require("./handlers/manifest"));
 const oauth_login_1 = __importDefault(require("./handlers/oauth-login"));
 const oauth_url_1 = __importDefault(require("./handlers/oauth-url"));
 const settings_save_1 = __importDefault(require("./handlers/settings-save"));
-const form_data_display_1 = __importDefault(require("./handlers/form-data-display"));
-const form_data_save_1 = __importDefault(require("./handlers/form-data-save"));
 const subscription_info_1 = __importDefault(require("./handlers/subscription-info"));
 const subscription_paid_1 = __importDefault(require("./handlers/subscription-paid"));
 const sync_settings_1 = __importDefault(require("./handlers/sync-settings"));
@@ -69,22 +70,23 @@ const uninstall_1 = __importDefault(require("./handlers/uninstall"));
 const crowdin_client_1 = __importStar(require("./middlewares/crowdin-client"));
 const integration_credentials_1 = __importDefault(require("./middlewares/integration-credentials"));
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
-const ui_module_1 = __importDefault(require("./middlewares/ui-module"));
 const render_ui_module_1 = __importDefault(require("./middlewares/render-ui-module"));
+const ui_module_1 = __importDefault(require("./middlewares/ui-module"));
+const models_1 = require("./models");
 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");
 const webhooks_1 = require("./util/webhooks");
-var models_1 = require("./models");
-Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
-function addCrowdinEndpoints(app, plainConfig) {
+var models_2 = require("./models");
+Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_2.Scope; } });
+function addCrowdinEndpoints(app, clientConfig) {
     var _a, _b, _c;
-    if (!plainConfig.disableGlobalErrorHandling) {
-        handleUncaughtErrors(plainConfig);
+    const config = (0, defaults_1.convertClientConfig)(clientConfig);
+    if (!config.disableGlobalErrorHandling) {
+        handleUncaughtErrors(config);
     }
-    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' }));
     app.use('/assets', express_1.default.static((0, path_1.join)(__dirname, 'static')));
@@ -117,7 +119,7 @@ function addCrowdinEndpoints(app, plainConfig) {
         },
     }));
     app.set('view engine', 'handlebars');
-    app.get('/logo.png', (req, res) => res.sendFile(config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
+    app.get('/logo.png', (req, res) => res.sendFile(config.imagePath));
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)(config));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
@@ -126,8 +128,8 @@ function addCrowdinEndpoints(app, plainConfig) {
     }
     const integrationLogic = config.projectIntegration;
     if (integrationLogic) {
-        (0, defaults_1.applyDefaults)(config, integrationLogic);
-        app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
+        (0, defaults_1.applyIntegrationModuleDefaults)(config, integrationLogic);
+        app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath));
         app.get('/', (0, crowdin_client_1.default)(config, true, false), (0, integration_credentials_1.default)(config, integrationLogic, true), (0, main_1.default)(config, integrationLogic));
         app.get('/api/subscription-info', json_response_1.default, (0, crowdin_client_1.default)(config), (0, subscription_info_1.default)(config));
         app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)(config, integrationLogic));
@@ -172,19 +174,35 @@ function addCrowdinEndpoints(app, plainConfig) {
         }
     }
     if (config.customFileFormat) {
-        app.post('/process', (0, crowdin_client_1.default)(config), (0, process_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder || '/', config.customFileFormat));
-        app.get('/file/download', (0, download_1.default)(config, config.customFileFormat.filesFolder || config.dbFolder || '/'));
+        app.post('/process', (0, crowdin_client_1.default)(config), (0, custom_file_format_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
+        app.get('/file/download', (0, file_download_1.default)(config, config.customFileFormat, 'custom-file-format'));
+    }
+    if (config.filePreImport) {
+        app.post('/pre-import', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePreImport, models_1.ProcessFileJobType.PRE_IMPORT));
+        app.get(`/file/download/${models_1.ProcessFileJobType.PRE_IMPORT}`, (0, file_download_1.default)(config, config.filePreImport, models_1.ProcessFileJobType.PRE_IMPORT));
+    }
+    if (config.filePostImport) {
+        app.post('/post-import', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePostImport, models_1.ProcessFileJobType.POST_IMPORT));
+        app.get(`/file/download/${models_1.ProcessFileJobType.POST_IMPORT}`, (0, file_download_1.default)(config, config.filePostImport, models_1.ProcessFileJobType.POST_IMPORT));
+    }
+    if (config.filePreExport) {
+        app.post('/pre-export', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePreExport, models_1.ProcessFileJobType.PRE_EXPORT));
+        app.get(`/file/download/${models_1.ProcessFileJobType.PRE_EXPORT}`, (0, file_download_1.default)(config, config.filePreExport, models_1.ProcessFileJobType.PRE_EXPORT));
+    }
+    if (config.filePostExport) {
+        app.post('/post-export', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePostExport, models_1.ProcessFileJobType.POST_EXPORT));
+        app.get(`/file/download/${models_1.ProcessFileJobType.POST_EXPORT}`, (0, file_download_1.default)(config, config.filePostExport, models_1.ProcessFileJobType.POST_EXPORT));
     }
     if (config.customMT) {
-        app.get('/logo/mt/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.customMT) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/mt/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.customMT) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config, config.customMT));
     }
     if (config.profileResourcesMenu) {
-        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/resources', (0, ui_module_1.default)(config, config.profileResourcesMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.profileResourcesMenu));
     }
     if (config.organizationMenu) {
-        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.organizationMenu));
     }
     if (config.editorRightPanel) {
@@ -197,11 +215,11 @@ function addCrowdinEndpoints(app, plainConfig) {
         app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config, config.projectMenuCrowdsource.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectMenuCrowdsource));
     }
     if (config.projectTools) {
-        app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/tools', (0, ui_module_1.default)(config, config.projectTools.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectTools));
     }
     if (config.projectReports) {
-        app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/reports', (0, ui_module_1.default)(config, config.projectReports.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectReports));
     }
     if (Object.keys(config).some((moduleKey) => {
@@ -233,11 +251,12 @@ function addCrowdinEndpoints(app, plainConfig) {
     };
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
-function createApp(config) {
+function createApp(clientConfig) {
     const app = (0, express_1.default)();
+    const config = (0, defaults_1.convertClientConfig)(clientConfig);
     addCrowdinEndpoints(app, config);
     /* eslint no-console: "off" */
-    app.listen(config.port || 3000, () => console.log(`App started on port ${config.port || 3000}`));
+    app.listen(config.port, () => console.log(`App started on port ${config.port}`));
 }
 exports.createApp = createApp;
 function handleUncaughtErrors(config) {

package/out/models/index.d.ts

@@ -3,7 +3,7 @@ import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
 import { MySQLStorageConfig } from '../storage/mysql';
 import { PostgreStorageConfig } from '../storage/postgre';
-export interface Config extends ImagePath {
+export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
      */
@@ -11,11 +11,11 @@ export interface Config extends ImagePath {
     /**
      * client id that we received when registering the app
      */
-    clientId: string;
+    clientId?: string;
     /**
      * client secret that we received when registering the app
      */
-    clientSecret: string;
+    clientSecret?: string;
     /**
      * Secret to encrypt/decrypt credentials (by default @clientSecret will be used)
      */
@@ -27,7 +27,7 @@ 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;
+    baseUrl?: string;
     /**
      * define custom Crowdin urls (e.g. to work against local Crowdin server)
      */
@@ -104,6 +104,14 @@ export interface Config extends ImagePath {
      * reports module
      */
     projectReports?: UiModule & ImagePath;
+    /**
+     * context menu module
+     */
+    contextMenu?: ContextModule & ModuleContent & Environments;
+    /**
+     * modal module
+     */
+    modal?: ModuleContent & Environments;
     /**
      * Uninstall hook for cleanup logic
      */
@@ -127,7 +135,19 @@ export interface Config extends ImagePath {
      * Configuration of app pricing
      */
     pricing?: Pricing;
+    filePreImport?: FilePreImportLogic;
+    filePostImport?: FilePostImportLogic;
+    filePreExport?: FilePreExportLogic;
+    filePostExport?: FilePostExportLogic;
 }
+export type Config = ClientConfig & {
+    baseUrl: string;
+    clientId: string;
+    clientSecret: string;
+    port: number;
+    dbFolder: string;
+    imagePath: string;
+};
 export declare enum AuthenticationType {
     CODE = "authorization_code",
     APP = "crowdin_app"
@@ -484,23 +504,29 @@ 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;
+export interface FileProcessLogic {
     /**
      * 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;
+    /**
+     * Override to store huge responses (by default they will be stored in fs)
+     */
+    storeFile?: (content: string) => Promise<string>;
+}
+export interface CustomFileFormatLogic extends FileProcessLogic {
+    /**
+     * The type parameter value for a custom file format. Used for a custom format file upload via API.
+     */
+    type: 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;
     /**
      * Flag to automatically upload translations
      */
@@ -533,10 +559,19 @@ export interface CustomFileFormatLogic {
      * Used for strings export
      */
     exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
-    /**
-     * Override to store huge responses (by default they will be stored in fs)
-     */
-    storeFile?: (content: string) => Promise<string>;
+}
+export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
+export interface FilePreImportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+}
+export interface FilePostImportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+}
+export interface FilePreExportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+}
+export interface FilePostExportLogic extends FileProcessLogic {
+    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -559,7 +594,11 @@ export interface ProcessFileRecord {
 }
 export declare enum ProcessFileJobType {
     PARSE_FILE = "parse-file",
-    BUILD_FILE = "build-file"
+    BUILD_FILE = "build-file",
+    PRE_IMPORT = "pre-import-file",
+    POST_IMPORT = "post-import-file",
+    PRE_EXPORT = "pre-export-file",
+    POST_EXPORT = "post-export-file"
 }
 export interface ParseFileResponse {
     previewFile?: string;
@@ -568,7 +607,10 @@ export interface ParseFileResponse {
 }
 export interface BuildFileResponse {
     contentFile: string;
+    base64EncodedContent?: string;
     error?: string;
+    fileName?: string;
+    fileType?: string;
 }
 export interface ProcessFileString {
     previewId?: number;
@@ -582,6 +624,7 @@ export interface ProcessFileString {
     labels?: string[];
     text: string | SourceStringsModel.PluralText;
     translations?: StringTranslations;
+    uniqId?: string;
 }
 export interface StringTranslations {
     [language: string]: {
@@ -640,6 +683,30 @@ export declare enum EditorPanelsMode {
     TRANSLATE = "TRANSLATE",
     PROOFREAD = "proofread"
 }
+interface ModuleContent {
+    /**
+     * relative URL to the content page of the module
+     */
+    url?: string;
+}
+export interface ContextModule {
+    location: ContextOptionsLocations;
+    type: ContextOptionsTypes;
+    module: string;
+}
+export declare enum ContextOptionsLocations {
+    TM = "tm",
+    GLOSSARY = "glossary",
+    LANGUAGE = "language",
+    SCREENSHOT = "screenshot",
+    SOURCE_FILE = "source_file",
+    TRANSLATED_FILE = "translated_file"
+}
+export declare enum ContextOptionsTypes {
+    MODAL = "modal",
+    NEW_TAB = "new_tab",
+    REDIRECT = "redirect"
+}
 export interface CrowdinAppUtilities {
     saveMetadata: (id: string, metadata: any) => Promise<void>;
     getMetadata: (id: string) => Promise<any | undefined>;