@crowdin/app-project-module 0.17.6 → 0.17.8

package/out/index.js

@@ -0,0 +1,191 @@
+"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]; } });
+}) : (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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApp = exports.addCrowdinEndpoints = exports.Scope = void 0;
+const express_1 = __importDefault(require("express"));
+const express_handlebars_1 = __importDefault(require("express-handlebars"));
+const cron = __importStar(require("node-cron"));
+const path_1 = require("path");
+const crowdin_file_progress_1 = __importDefault(require("./handlers/crowdin-file-progress"));
+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 translate_1 = __importDefault(require("./handlers/custom-mt/translate"));
+const install_1 = __importDefault(require("./handlers/install"));
+const integration_data_1 = __importDefault(require("./handlers/integration-data"));
+const integration_login_1 = __importDefault(require("./handlers/integration-login"));
+const integration_logout_1 = __importDefault(require("./handlers/integration-logout"));
+const integration_update_1 = __importDefault(require("./handlers/integration-update"));
+const main_1 = __importDefault(require("./handlers/main"));
+const manifest_1 = __importDefault(require("./handlers/manifest"));
+const oauth_login_1 = __importDefault(require("./handlers/oauth-login"));
+const settings_save_1 = __importDefault(require("./handlers/settings-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"));
+const sync_settings_save_1 = __importDefault(require("./handlers/sync-settings-save"));
+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 storage = __importStar(require("./storage"));
+const connection_1 = require("./util/connection");
+const cron_1 = require("./util/cron");
+const defaults_1 = require("./util/defaults");
+var models_1 = require("./models");
+Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
+function addCrowdinEndpoints(app, config) {
+    storage.connect(config.dbFolder);
+    app.use(express_1.default.json({ limit: '50mb' }));
+    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)({
+        layoutsDir: '',
+        defaultLayout: '',
+        helpers: {
+            ifeq: function (a, b, options) {
+                if (a === b) {
+                    return options.fn(this);
+                }
+                return options.inverse(this);
+            },
+            checkLength: function (a, b, options) {
+                if (a.length > b) {
+                    return options.fn(this);
+                }
+                return options.inverse(this);
+            },
+        },
+    }));
+    app.set('view engine', 'handlebars');
+    app.get('/logo.png', (req, res) => res.sendFile(config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
+    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));
+    if (!(0, connection_1.isAppFree)(config)) {
+        app.post('/subscription-paid', (0, subscription_paid_1.default)(config));
+    }
+    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')));
+        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/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_logout_1.default)(config));
+        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)(config));
+        app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)(config));
+        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)(config, 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));
+        app.get('/api/sync-settings/:provider', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, sync_settings_1.default)(config));
+        app.post('/api/sync-settings', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, sync_settings_save_1.default)(config));
+        if (integrationLogic.oauthLogin) {
+            app.get((0, defaults_1.getOauthRoute)(integrationLogic), (0, oauth_login_1.default)(config, integrationLogic));
+        }
+        if (integrationLogic.cronJobs) {
+            integrationLogic.cronJobs.forEach(job => {
+                cron.schedule(job.expression, () => (0, cron_1.runJob)(config, integrationLogic, job).catch(console.error));
+            });
+        }
+        if (integrationLogic.withCronSync) {
+            cron.schedule('0 * * * *', () => (0, cron_1.filesCron)(config, integrationLogic, '1').catch(console.error));
+            cron.schedule('0 */3 * * *', () => (0, cron_1.filesCron)(config, integrationLogic, '3').catch(console.error));
+            cron.schedule('0 */6 * * *', () => (0, cron_1.filesCron)(config, integrationLogic, '6').catch(console.error));
+            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 (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));
+    }
+    if (config.customMT) {
+        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.use('/resources', (0, ui_module_1.default)(config), express_1.default.static(config.profileResourcesMenu.uiPath));
+    }
+    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), express_1.default.static(config.organizationMenu.uiPath));
+    }
+    if (config.editorRightPanel) {
+        app.use('/editor-panels', (0, ui_module_1.default)(config), express_1.default.static(config.editorRightPanel.uiPath));
+    }
+    if (config.projectMenu) {
+        app.use('/project-menu', (0, ui_module_1.default)(config), express_1.default.static(config.projectMenu.uiPath));
+    }
+    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), express_1.default.static(config.projectTools.uiPath));
+    }
+    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), express_1.default.static(config.projectReports.uiPath));
+    }
+    return {
+        getMetadata: storage.getMetadata,
+        saveMetadata: (id, metadata) => __awaiter(this, void 0, void 0, function* () {
+            const existing = yield storage.getMetadata(id);
+            if (existing) {
+                yield storage.updateMetadata(id, metadata);
+            }
+            else {
+                yield storage.saveMetadata(id, metadata);
+            }
+        }),
+        deleteMetadata: storage.deleteMetadata,
+        getUserSettings: (clientId) => __awaiter(this, void 0, void 0, function* () {
+            const integrationCredentials = yield storage.getIntegrationCredentials(clientId);
+            if (integrationCredentials === null || integrationCredentials === void 0 ? void 0 : integrationCredentials.config) {
+                return JSON.parse(integrationCredentials.config);
+            }
+        }),
+        establishCrowdinConnection: jwtToken => (0, crowdin_client_1.prepareCrowdinRequest)(jwtToken, config),
+    };
+}
+exports.addCrowdinEndpoints = addCrowdinEndpoints;
+function createApp(config) {
+    const app = (0, express_1.default)();
+    addCrowdinEndpoints(app, config);
+    /* eslint no-console: "off" */
+    app.listen(config.port || 3000, () => console.log(`App started on port ${config.port || 3000}`));
+}
+exports.createApp = createApp;

package/out/middlewares/crowdin-client.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="qs" />
+import Crowdin from '@crowdin/crowdin-api-client';
+import { Response } from 'express';
+import { Config, CrowdinContextInfo, SubscriptionInfo } from '../models';
+export declare function prepareCrowdinRequest(jwtToken: string, config: Config, optional?: boolean, checkSubscriptionExpiration?: boolean): Promise<{
+    context: CrowdinContextInfo;
+    client?: Crowdin;
+    subscriptionInfo?: SubscriptionInfo;
+}>;
+export default function handle(config: Config, optional?: boolean, checkSubscriptionExpiration?: 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/crowdin-client.js

@@ -0,0 +1,88 @@
+"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 });
+exports.prepareCrowdinRequest = void 0;
+const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
+const storage_1 = require("../storage");
+const util_1 = require("../util");
+const connection_1 = require("../util/connection");
+function getToken(req) {
+    const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
+    if (tokenJwt) {
+        return tokenJwt;
+    }
+    if (req.headers.authorization) {
+        if (req.headers.authorization.startsWith('Bearer ') || req.headers.authorization.startsWith('bearer ')) {
+            return req.headers.authorization.substring(7);
+        }
+    }
+}
+function prepareCrowdinRequest(jwtToken, config, optional = false, checkSubscriptionExpiration = true) {
+    return __awaiter(this, void 0, void 0, function* () {
+        (0, util_1.log)('Validating jwt token from incoming request', config.logger);
+        const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(jwtToken, config.clientSecret);
+        const context = {
+            jwtPayload,
+            clientId: (0, crowdin_apps_functions_1.constructCrowdinIdFromJwtPayload)(jwtPayload),
+            crowdinId: `${jwtPayload.domain || jwtPayload.context.organization_id}`,
+        };
+        (0, util_1.log)('Loading crowdin credentials', config.logger);
+        const credentials = yield (0, storage_1.getCrowdinCredentials)(context.crowdinId);
+        if (!credentials) {
+            if (optional) {
+                return { context };
+            }
+            throw new Error("Can't find organization by id");
+        }
+        (0, util_1.log)('Building crowdin client instance', config.logger);
+        const { client, token } = yield (0, connection_1.prepareCrowdinClient)(config, credentials);
+        let subscriptionInfo;
+        if (checkSubscriptionExpiration) {
+            subscriptionInfo = yield (0, connection_1.checkSubscription)(config, token, credentials.id, credentials.type);
+            if (subscriptionInfo.expired) {
+                throw new util_1.CodeError(subscriptionInfo.subscribeLink || '', 402);
+            }
+        }
+        return { context, client, subscriptionInfo };
+    });
+}
+exports.prepareCrowdinRequest = prepareCrowdinRequest;
+function handle(config, optional = false, checkSubscriptionExpiration = true) {
+    return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        const tokenJwt = getToken(req);
+        if (!tokenJwt) {
+            return res.status(403).send({ error: 'Access denied' });
+        }
+        try {
+            const data = yield prepareCrowdinRequest(tokenJwt, config, optional, checkSubscriptionExpiration);
+            req.crowdinContext = data.context;
+            if (data.client) {
+                req.crowdinApiClient = data.client;
+            }
+            req.subscriptionInfo = data.subscriptionInfo;
+            next();
+        }
+        catch (e) {
+            if (e instanceof util_1.CodeError) {
+                throw e;
+            }
+            if (config.onError) {
+                config.onError(e);
+            }
+            else {
+                console.error(e);
+            }
+            const message = typeof e === 'string' ? e : e.message;
+            return res.status(403).send({ error: message || 'Error' });
+        }
+    }), config.onError);
+}
+exports.default = handle;

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

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+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

@@ -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 storage_1 = require("../storage");
+const util_1 = require("../util");
+const connection_1 = require("../util/connection");
+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;
+        (0, util_1.log)(`Loading integration credentials for client ${clientId}`, config.logger);
+        const integrationCredentials = yield (0, storage_1.getIntegrationCredentials)(clientId);
+        if (!integrationCredentials) {
+            if (optional) {
+                return next();
+            }
+            return res.status(403).send({ error: 'Access denied' });
+        }
+        if (integrationCredentials.config) {
+            req.integrationSettings = JSON.parse(integrationCredentials.config);
+        }
+        try {
+            req.integrationCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+        }
+        catch (e) {
+            console.error(e);
+            throw new util_1.CodeError('Credentials to integration either exprired or invalid', 401);
+        }
+        next();
+    }), config.onError);
+}
+exports.default = handle;

package/out/middlewares/json-response.d.ts

@@ -0,0 +1,2 @@
+import { Request, Response } from 'express';
+export default function handle(_req: Request, res: Response, next: Function): void;

package/out/middlewares/json-response.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function handle(_req, res, next) {
+    res.header('Content-Type', 'application/json');
+    next();
+}
+exports.default = handle;

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

@@ -0,0 +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;

package/out/middlewares/ui-module.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 crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
+const storage_1 = require("../storage");
+const util_1 = require("../util");
+const connection_1 = require("../util/connection");
+function handle(config) {
+    return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        const tokenJwt = req.query.tokenJwt;
+        if (!tokenJwt) {
+            return res.status(403).send({ error: 'Access denied' });
+        }
+        (0, util_1.log)('Validating jwt token from incoming request', config.logger);
+        const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(tokenJwt, config.clientSecret);
+        const id = `${jwtPayload.domain || jwtPayload.context.organization_id}`;
+        (0, util_1.log)('Loading crowdin credentials', config.logger);
+        const credentials = yield (0, storage_1.getCrowdinCredentials)(id);
+        if (!credentials) {
+            throw new Error("Can't find organization by id");
+        }
+        (0, util_1.log)('Building crowdin client instance', config.logger);
+        const { token } = yield (0, connection_1.prepareCrowdinClient)(config, credentials);
+        const { expired, subscribeLink } = yield (0, connection_1.checkSubscription)(config, token, credentials.id, credentials.type);
+        if (expired) {
+            return res.render('subscription', { subscribeLink });
+        }
+        next();
+    }), config.onError);
+}
+exports.default = handle;