@crowdin/app-project-module 0.27.0 → 0.28.0-10

package/out/handlers/crowdin-update.js

@@ -14,12 +14,13 @@ const defaults_1 = require("../util/defaults");
 function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const projectId = req.crowdinContext.jwtPayload.context.project_id;
-        (0, util_1.log)(`Upading crowdin project ${projectId}`, config.logger);
+        const uploadTranslations = req.query.uploadTranslations === 'true';
+        (0, util_1.log)(`Updating crowdin project ${projectId}`, config.logger);
         const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, req.crowdinApiClient, projectId);
         if (rootFolder) {
-            (0, util_1.log)(`Upading crowdin files under folder ${rootFolder.id}`, config.logger);
+            (0, util_1.log)(`Updating crowdin files under folder ${rootFolder.id}`, config.logger);
         }
-        const result = yield integration.updateCrowdin(projectId, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
+        const result = yield integration.updateCrowdin(projectId, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings, uploadTranslations);
         let message;
         if ((0, util_1.isExtendedResultType)(result)) {
             message = result.message;

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

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Config, IntegrationLogic } from '../models';
+import { Request, Response } from 'express';
+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/crowdin-webhook.js

@@ -0,0 +1,43 @@
+"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");
+const webhooks_1 = require("../util/webhooks");
+function handle(config, integration) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const urlParam = (_a = integration.webhooks) === null || _a === void 0 ? void 0 : _a.urlParam;
+        const webhookUrlParam = req.query[urlParam];
+        let filesToSync;
+        if (webhookUrlParam) {
+            const { projectId, crowdinClient, preparedIntegrationCredentials, rootFolder, appSettings, syncSettings } = yield (0, webhooks_1.prepareWebhookData)(config, integration, webhookUrlParam, 'crowdin');
+            if (!crowdinClient) {
+                return res.status(403).send({ error: 'Access denied' });
+            }
+            if (!syncSettings) {
+                return res.status(200).send({ message: 'Sync is not configured' });
+            }
+            if ((_b = integration.webhooks) === null || _b === void 0 ? void 0 : _b.crowdinWebhookInterceptor) {
+                filesToSync = yield integration.webhooks.crowdinWebhookInterceptor(projectId, crowdinClient.client, rootFolder, appSettings, syncSettings, req.body);
+            }
+            else {
+                filesToSync = (0, webhooks_1.filterSyncFiles)(req.body.events, JSON.parse(syncSettings.files));
+            }
+            const result = yield integration.updateIntegration(projectId, crowdinClient.client, preparedIntegrationCredentials, filesToSync, rootFolder, appSettings);
+            let message;
+            if ((0, util_1.isExtendedResultType)(result)) {
+                message = result.message;
+            }
+            res.send({ message });
+        }
+    }), config.onError);
+}
+exports.default = handle;

package/out/handlers/form-data-display.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+export default function handle(): (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/form-data-display.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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");
+const storage = __importStar(require("../storage"));
+function handle() {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const id = req.query.id;
+        const data = (yield storage.getStorage().getMetadata(id)) || {};
+        return res.send({
+            formData: data,
+        });
+    }));
+}
+exports.default = handle;

package/out/handlers/form-data-save.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+export default function handle(): (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/form-data-save.js

@@ -0,0 +1,56 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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");
+const storage = __importStar(require("../storage"));
+function handle() {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const id = req.query.id;
+        const metadata = req.body.data;
+        const existing = yield storage.getStorage().getMetadata(id);
+        try {
+            if (!!existing) {
+                yield storage.getStorage().updateMetadata(id, metadata);
+            }
+            else {
+                yield storage.getStorage().saveMetadata(id, metadata);
+            }
+        }
+        catch (e) {
+            res.status(500).end();
+        }
+        res.status(204).end();
+    }));
+}
+exports.default = handle;

package/out/handlers/integration-logout.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
+const webhooks_1 = require("../util/webhooks");
 function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         (0, util_1.log)('Received integration logout request', config.logger);
@@ -22,6 +23,9 @@ function handle(config, integration) {
         (0, util_1.log)(`Deleting integration credentials for ${req.crowdinContext.clientId} client`, config.logger);
         yield (0, storage_1.getStorage)().deleteIntegrationCredentials(req.crowdinContext.clientId);
         (0, connection_1.clearCache)(req.crowdinContext.crowdinId);
+        if (integration.webhooks) {
+            yield (0, webhooks_1.unregisterWebhooks)(config, integration, req.crowdinApiClient, req.crowdinContext, req.integrationCredentials, req.integrationSettings);
+        }
         res.status(204).end();
     }), config.onError);
 }

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

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Config, IntegrationLogic } from '../models';
+import { Request, Response } from 'express';
+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/integration-webhook.js

@@ -0,0 +1,39 @@
+"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");
+const webhooks_1 = require("../util/webhooks");
+function handle(config, integration) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const urlParam = (_a = integration.webhooks) === null || _a === void 0 ? void 0 : _a.urlParam;
+        const webhookUrlParam = req.query[urlParam];
+        if (((_b = integration.webhooks) === null || _b === void 0 ? void 0 : _b.integrationWebhookInterceptor) && webhookUrlParam) {
+            const webhookData = yield (0, webhooks_1.prepareWebhookData)(config, integration, webhookUrlParam, 'integration');
+            if (!webhookData.crowdinClient) {
+                return res.status(403).send({ error: 'Access denied' });
+            }
+            if (!webhookData.syncSettings) {
+                return res.status(200).send({ message: 'Sync is not configured' });
+            }
+            const result = yield (0, webhooks_1.updateCrowdinFromWebhookRequest)(integration, webhookData, req);
+            let message;
+            if ((0, util_1.isExtendedResultType)(result)) {
+                message = result.message;
+            }
+            res.send({ message });
+        }
+        else {
+            return res.status(403).send({ error: 'Access denied' });
+        }
+    }), config.onError);
+}
+exports.default = handle;

package/out/handlers/main.js

@@ -45,10 +45,16 @@ function handle(config, integration) {
         }
         options.infoModal = integration.infoModal;
         options.withCronSync = integration.withCronSync;
-        options.withWebhookSync = integration.withWebhookSync;
+        options.webhooks = integration.webhooks
+            ? {
+                crowdin: true,
+                integration: !!integration.webhooks.integrationWebhookInterceptor,
+            }
+            : {};
         options.integrationOneLevelFetching = integration.integrationOneLevelFetching;
         options.integrationSearchListener = integration.integrationSearchListener;
         options.checkSubscription = !(0, connection_1.isAppFree)(config);
+        options.uploadTranslations = integration.uploadTranslations;
         (0, util_1.log)(`Routing user to ${view} view`, config.logger);
         return res.render(view, options);
     }), config.onError);

package/out/handlers/settings-save.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/settings-save.js

@@ -11,10 +11,15 @@ 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) {
+const webhooks_1 = require("../util/webhooks");
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        (0, util_1.log)(`Saving settings ${JSON.stringify(req.body.config, null, 2)}`, config.logger);
-        yield (0, storage_1.getStorage)().updateIntegrationConfig(req.crowdinContext.clientId, JSON.stringify(req.body.config));
+        const appSettings = req.body.config;
+        (0, util_1.log)(`Saving settings ${JSON.stringify(appSettings, null, 2)}`, config.logger);
+        yield (0, storage_1.getStorage)().updateIntegrationConfig(req.crowdinContext.clientId, JSON.stringify(appSettings));
+        if (integration.webhooks) {
+            yield (0, webhooks_1.registerWebhooks)(config, integration, req.crowdinApiClient, req.crowdinContext, req.integrationCredentials, appSettings);
+        }
         res.status(204).end();
     }), config.onError);
 }

package/out/handlers/uninstall.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
+const webhooks_1 = require("../util/webhooks");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const event = req.body;
@@ -35,6 +36,9 @@ function handle(config) {
             yield config.onUninstall(organization, allCredentials);
         }
         if (projectIntegration) {
+            if (projectIntegration.webhooks) {
+                yield (0, webhooks_1.unregisterAllCrowdinWebhooks)(config, projectIntegration, organization);
+            }
             (0, util_1.log)(`Deleting all integration credentials for ${organization} organization`, config.logger);
             yield (0, storage_1.getStorage)().deleteAllIntegrationCredentials(organization);
         }

package/out/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -40,6 +44,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 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"));
@@ -53,6 +59,8 @@ 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"));
@@ -62,14 +70,17 @@ 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 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 _a, _b, _c;
     if (!plainConfig.disableGlobalErrorHandling) {
         handleUncaughtErrors(plainConfig);
     }
@@ -94,6 +105,15 @@ function addCrowdinEndpoints(app, plainConfig) {
                 }
                 return options.inverse(this);
             },
+            in: function (a, b, options) {
+                if (a.includes(b)) {
+                    return options.fn(this);
+                }
+                return options.inverse(this);
+            },
+            or: function (a, b, options) {
+                return a || b ? options.fn(this) : options.inverse(this);
+            },
         },
     }));
     app.set('view engine', 'handlebars');
@@ -110,7 +130,7 @@ function addCrowdinEndpoints(app, plainConfig) {
         app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
         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));
+        app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)(config, integrationLogic));
         app.post('/api/login', (0, crowdin_client_1.default)(config, false, false), (0, integration_login_1.default)(config, integrationLogic));
         app.post('/api/logout', (0, crowdin_client_1.default)(config, false, false), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_logout_1.default)(config, integrationLogic));
         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));
@@ -137,6 +157,19 @@ function addCrowdinEndpoints(app, plainConfig) {
             cron.schedule('0 */12 * * *', () => (0, cron_1.filesCron)(config, integrationLogic, '12').catch(console.error));
             cron.schedule('0 0 * * *', () => (0, cron_1.filesCron)(config, integrationLogic, '24').catch(console.error));
         }
+        if (integrationLogic.webhooks) {
+            app.post(`${integrationLogic.webhooks.crowdinWebhookUrl
+                ? integrationLogic.webhooks.crowdinWebhookUrl
+                : '/api/crowdin/webhook'}`, json_response_1.default, (0, crowdin_webhook_1.default)(config, integrationLogic));
+            if (((_a = integrationLogic.webhooks) === null || _a === void 0 ? void 0 : _a.integrationWebhookInterceptor) && !((_b = integrationLogic.webhooks) === null || _b === void 0 ? void 0 : _b.queueUrl)) {
+                app.post(`${integrationLogic.webhooks.integrationWebhookUrl
+                    ? integrationLogic.webhooks.integrationWebhookUrl
+                    : '/api/integration/webhook'}`, (0, integration_webhook_1.default)(config, integrationLogic));
+            }
+            if ((_c = integrationLogic.webhooks) === null || _c === void 0 ? void 0 : _c.queueUrl) {
+                (0, webhooks_1.listenQueueMessage)(config, integrationLogic, integrationLogic.webhooks.queueUrl, config.identifier);
+            }
+        }
     }
     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));
@@ -148,28 +181,35 @@ function addCrowdinEndpoints(app, plainConfig) {
     }
     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.use('/resources', (0, ui_module_1.default)(config, config.profileResourcesMenu.allowUnauthorized), express_1.default.static(config.profileResourcesMenu.uiPath));
+        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.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), express_1.default.static(config.organizationMenu.uiPath));
+        app.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.organizationMenu));
     }
     if (config.editorRightPanel) {
-        app.use('/editor-panels', (0, ui_module_1.default)(config, config.editorRightPanel.allowUnauthorized), express_1.default.static(config.editorRightPanel.uiPath));
+        app.use('/editor-panels', (0, ui_module_1.default)(config, config.editorRightPanel.allowUnauthorized), (0, render_ui_module_1.default)(config, config.editorRightPanel));
     }
     if (config.projectMenu) {
-        app.use('/project-menu', (0, ui_module_1.default)(config, config.projectMenu.allowUnauthorized), express_1.default.static(config.projectMenu.uiPath));
+        app.use('/project-menu', (0, ui_module_1.default)(config, config.projectMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectMenu));
     }
     if (config.projectMenuCrowdsource) {
-        app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config, config.projectMenuCrowdsource.allowUnauthorized), express_1.default.static(config.projectMenuCrowdsource.uiPath));
+        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.use('/tools', (0, ui_module_1.default)(config, config.projectTools.allowUnauthorized), express_1.default.static(config.projectTools.uiPath));
+        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.use('/reports', (0, ui_module_1.default)(config, config.projectReports.allowUnauthorized), express_1.default.static(config.projectReports.uiPath));
+        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) => {
+        const moduleConfig = config[moduleKey];
+        return typeof moduleConfig === 'object' && moduleConfig.hasOwnProperty('formSchema');
+    })) {
+        app.get('/api/form-data', json_response_1.default, (0, crowdin_client_1.default)(config), (0, form_data_display_1.default)());
+        app.post('/api/form-data', (0, crowdin_client_1.default)(config), (0, form_data_save_1.default)());
     }
     return {
         getMetadata: storage.getStorage().getMetadata.bind(storage.getStorage()),

package/out/middlewares/render-ui-module.d.ts

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

package/out/middlewares/render-ui-module.js

@@ -0,0 +1,33 @@
+"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 express_1 = __importDefault(require("express"));
+const util_1 = require("../util");
+function handle(config, moduleConfig) {
+    return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        if (moduleConfig.formSchema) {
+            return res.render('form', {
+                formGetDataUrl: moduleConfig.formGetDataUrl ? moduleConfig.formGetDataUrl : '/api/form-data',
+                formPostDataUrl: moduleConfig.formPostDataUrl ? moduleConfig.formPostDataUrl : '/api/form-data',
+                formSchema: JSON.stringify(moduleConfig.formSchema),
+                formUiSchema: moduleConfig.formUiSchema ? JSON.stringify(moduleConfig.formUiSchema) : '{}',
+            });
+        }
+        if (moduleConfig.uiPath) {
+            return express_1.default.static(moduleConfig.uiPath)(req, res, next);
+        }
+        throw new Error('uiPath or formSchema should be provided for module');
+    }), config.onError);
+}
+exports.default = handle;

package/out/models/index.d.ts

@@ -187,7 +187,7 @@ export interface IntegrationLogic {
     /**
      * function to update crowdin files (e.g. pull integration data to crowdin source files)
      */
-    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | ExtendedResult<void>>;
+    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any, uploadTranslations?: boolean) => Promise<void | ExtendedResult<void>>;
     /**
      * function to update integration content (e.g. load crowdin translations and push them to integration service)
      */
@@ -235,14 +235,22 @@ export interface IntegrationLogic {
      * Enable integration next page event
      */
     integrationPagination?: boolean;
+    /**
+     * Enable the option to upload translations to crowdin that are already present in the integration.
+     */
+    uploadTranslations?: boolean;
     /**
      * function to get crowdin file translation progress
      */
     getFileProgress?: (projectId: number, client: Crowdin, fileId: number) => Promise<{
         [key: number]: TranslationStatusModel.LanguageProgress[];
     }>;
+    /**
+     * Register Crowdin webhook to get notified when translations are ready
+     */
+    webhooks?: Webhooks;
 }
-export declare type FormEntity = FormField | FormDelimeter;
+export type FormEntity = FormField | FormDelimeter;
 export interface FormDelimeter {
     label: string;
 }
@@ -364,7 +372,7 @@ export interface FormField {
     helpText?: string;
     helpTextHtml?: string;
     label: string;
-    type?: 'text' | 'password' | 'checkbox' | 'select';
+    type?: 'text' | 'password' | 'checkbox' | 'select' | 'textarea' | 'file';
     defaultValue?: any;
     /**
      * only for select
@@ -381,19 +389,27 @@ export interface FormField {
         label: string;
         value: string;
     }[];
+    /**
+     * only for type file
+     */
+    accept?: string;
+    /**
+     * field dependency settings
+     */
+    dependencySettings?: string;
 }
 export interface ExtendedResult<T> {
     data?: T;
     message?: string;
     stopPagination?: boolean;
 }
-export declare type TreeItem = File | Folder;
+export type TreeItem = File | Folder;
 /**
  * 0 - folder
  * 1 - file
  * 2 - branch
  */
-declare type IntegrationTreeElementType = '0' | '1' | '2';
+type IntegrationTreeElementType = '0' | '1' | '2';
 export interface File {
     id: string;
     name: string;
@@ -580,10 +596,29 @@ export interface CustomMTRequest {
     strings: string[];
 }
 export interface UiModule {
+    /**
+     * Form schema for react-jsonschema-doc to be used as front-end
+     * https://rjsf-team.github.io/react-jsonschema-form/docs
+     */
+    formSchema?: object;
+    /**
+     * URL to custom endpoint that can be used instead of default one to save form data.
+     * Endpoint should accept POST requests.
+     */
+    formPostDataUrl?: string;
+    /**
+     * URL to custom endpoint that can be used instead of default one to retrieve form data.
+     * Endpoint should accept GET requests.
+     */
+    formGetDataUrl?: string;
+    /**
+     * Additional attributes for react-jsonschema-doc
+     */
+    formUiSchema?: object;
     /**
      * path to ui folder (e.g. {@example join(__dirname, 'public')})
      */
-    uiPath: string;
+    uiPath?: string;
     /**
      * page name (default index.html)
      */
@@ -643,4 +678,35 @@ export interface Pricing {
     cachingSeconds?: number;
     infoDisplayDaysThreshold?: number;
 }
+export interface Webhooks {
+    crowdinWebhookUrl?: string;
+    integrationWebhookUrl?: string;
+    urlParam?: string;
+    crowdinWebhooks?: (client: Crowdin, projectId: number, available: boolean, config?: any) => Promise<void>;
+    integrationWebhooks?: (apiCredentials: any, urlParam: string, available: boolean, config?: any, syncSettings?: any) => Promise<void>;
+    crowdinWebhookInterceptor?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<UpdateIntegrationRequest>;
+    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<IntegrationFile[]>;
+    queueUrl: string;
+}
+export declare enum SyncCondition {
+    ALL = 0,
+    TRANSLATED = 1,
+    APPROVED = 2
+}
+export declare enum SyncType {
+    NONE = 0,
+    SCHEDULE = 1,
+    WEBHOOKS = 2
+}
+export type Payload = {
+    event: string;
+    projectId: string;
+    language: string;
+    fileId: string;
+};
+export type WebhookUrlParams = {
+    projectId: number;
+    crowdinId: string;
+    clientId: string;
+};
 export {};