@crowdin/app-project-module 0.68.0 → 0.69.0

package/out/index.js

@@ -79,6 +79,7 @@ const projectMenuApp = __importStar(require("./modules/project-menu"));
 const projectMenuCrowdsourceApp = __importStar(require("./modules/project-menu-crowdsource"));
 const projectReportsApp = __importStar(require("./modules/project-reports"));
 const projectToolsApp = __importStar(require("./modules/project-tools"));
+const webhooks = __importStar(require("./modules/webhooks"));
 const subscription_1 = require("./util/subscription");
 var types_2 = require("./types");
 Object.defineProperty(exports, "ProjectPermissions", { enumerable: true, get: function () { return types_2.ProjectPermissions; } });
@@ -175,6 +176,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     aiTools.registerAiTools({ config, app });
     aiTools.registerAiToolWidgets({ config, app });
     externalQaCheck.register({ config, app });
+    webhooks.register({ config, app });
     addFormSchema({ config, app });
     return Object.assign(Object.assign({}, exports.metadataStore), { establishCrowdinConnection: (authRequest, moduleKey) => {
             let jwtToken = '';
@@ -240,6 +242,9 @@ function convertClientConfig(clientConfig) {
             throw new Error('Missing [clientId, clientSecret] parameters');
         }
     }
+    if (clientConfig.projectIntegration) {
+        clientConfig.api = Object.assign({ default: true }, clientConfig.api);
+    }
     return Object.assign(Object.assign({}, clientConfig), { baseUrl: baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl, clientId,
         clientSecret, awsConfig: {
             tmpBucketName,

package/out/modules/api/api.js

@@ -462,7 +462,7 @@ function addDefaultApiEndpoints(app, config) {
 }
 exports.addDefaultApiEndpoints = addDefaultApiEndpoints;
 function addSwagerApiDocumentation(app, config) {
-    var _a, _b;
+    var _a, _b, _c;
     const options = {
         swaggerDefinition: {
             openapi: '3.0.0',
@@ -492,16 +492,16 @@ function addSwagerApiDocumentation(app, config) {
                 },
             ],
         },
-        apis: config.projectIntegration
+        apis: config.projectIntegration && ((_a = config.api) === null || _a === void 0 ? void 0 : _a.default)
             ? [path_1.default.resolve(__dirname, './base.js'), path_1.default.resolve(__dirname, './components.js'), __filename]
             : [],
     };
-    if ((_a = config.api) === null || _a === void 0 ? void 0 : _a.docFile) {
+    if ((_b = config.api) === null || _b === void 0 ? void 0 : _b.docFile) {
         options.apis.push(config.api.docFile);
     }
     const swaggerSpec = (0, swagger_jsdoc_1.default)(options);
     // remove Login info from doc
-    if (config.projectIntegration && !((_b = config.projectIntegration) === null || _b === void 0 ? void 0 : _b.loginForm)) {
+    if (config.projectIntegration && !((_c = config.projectIntegration) === null || _c === void 0 ? void 0 : _c.loginForm)) {
         delete swaggerSpec.paths['/login'];
         delete swaggerSpec.paths['/login-fields'];
         delete swaggerSpec.components.schemas['Login'];

package/out/modules/integration/handlers/crowdin-update.js

@@ -43,6 +43,7 @@ function handle(config, integration) {
             projectId: projectId,
             client: req.crowdinApiClient,
             jobType: types_1.JobClientType.MANUAL,
+            jobStoreType: integration.jobStoreType,
             jobCallback: (job) => __awaiter(this, void 0, void 0, function* () {
                 var _c;
                 if (req.body && ((_c = req.body) === null || _c === void 0 ? void 0 : _c.length)) {

package/out/modules/integration/handlers/integration-update.js

@@ -37,6 +37,7 @@ function handle(config, integration) {
             projectId: req.crowdinContext.jwtPayload.context.project_id,
             client: req.crowdinApiClient,
             jobType: types_1.JobClientType.MANUAL,
+            jobStoreType: integration.jobStoreType,
             jobCallback: (job) => __awaiter(this, void 0, void 0, function* () {
                 const result = yield integration.updateIntegration({
                     projectId: req.crowdinContext.jwtPayload.context.project_id,

package/out/modules/integration/handlers/sync-settings-save.js

@@ -36,6 +36,7 @@ function handle(config, integration) {
             projectId: req.crowdinContext.jwtPayload.context.project_id,
             client: req.crowdinApiClient,
             jobType: types_1.JobClientType.MANUAL,
+            jobStoreType: integration.jobStoreType,
             jobCallback: () => __awaiter(this, void 0, void 0, function* () {
                 if (Array.isArray(expandIntegrationFolders) && expandIntegrationFolders.length) {
                     const allFiles = (yield (0, files_1.expandFilesTree)(expandIntegrationFolders, req, integration)).map((node) => ({

package/out/modules/integration/types.d.ts

@@ -1,7 +1,7 @@
 import Crowdin, { SourceFilesModel, TranslationStatusModel } from '@crowdin/crowdin-api-client';
 import { Request } from 'express';
 import { CrowdinClientRequest, ModuleKey } from '../../types';
-import { JobClient } from './util/types';
+import { JobClient, JobStoreType } from './util/types';
 export interface IntegrationLogic extends ModuleKey {
     /**
      * Customize your app login form
@@ -56,6 +56,10 @@ export interface IntegrationLogic extends ModuleKey {
         appSettings?: any;
         job: JobClient;
     }) => Promise<void | ExtendedResult<void>>;
+    /**
+     * Store to use for memorizing job data
+     */
+    jobStoreType?: JobStoreType;
     /**
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */

package/out/modules/integration/util/cron.js

@@ -93,6 +93,7 @@ function runUpdateProviderJob({ integrationId, crowdinId, type, title, payload,
                 projectId,
                 client,
                 reRunJobId,
+                jobStoreType: integration.jobStoreType,
                 jobCallback: (job) => __awaiter(this, void 0, void 0, function* () {
                     const updateParams = {
                         projectId,
@@ -174,6 +175,8 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     user_id: crowdinCredentials.userId,
                 },
             },
+            crowdinId: crowdinCredentials.id,
+            clientId: integrationCredentials.id,
         };
         try {
             const preparedCrowdinClient = yield (0, connection_1.prepareCrowdinClient)({
@@ -186,7 +189,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
             crowdinClient = preparedCrowdinClient.client;
         }
         catch (e) {
-            (0, logger_1.logError)(e);
+            (0, logger_1.logError)(e, context);
             return;
         }
         const { expired } = yield (0, subscription_1.checkSubscription)({
@@ -204,7 +207,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                 .data;
         }
         catch (e) {
-            (0, logger_1.logError)(e);
+            (0, logger_1.logError)(e, context);
             return;
         }
         // eslint-disable-next-line @typescript-eslint/camelcase
@@ -228,7 +231,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                 });
             }
             catch (e) {
-                (0, logger_1.logError)(e);
+                (0, logger_1.logError)(e, context);
                 return;
             }
         }
@@ -267,6 +270,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     crowdinClient,
                     onlyApproved,
                     onlyTranslated,
+                    context,
                 });
             if (Object.keys(filesToProcess).length <= 0) {
                 return;
@@ -409,7 +413,7 @@ function getNewFoldersFile(folders, snapshotFiles) {
     files = files.filter((file) => 'type' in file);
     return files;
 }
-function getOnlyTranslatedOrApprovedFiles({ projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated, }) {
+function getOnlyTranslatedOrApprovedFiles({ projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated, context, }) {
     return __awaiter(this, void 0, void 0, function* () {
         (0, logger_1.log)(`Filtering files to process only ${onlyApproved ? 'approved' : 'translated'} files`);
         const filesInfo = yield Promise.all(Object.keys(crowdinFiles).map((fileId) => __awaiter(this, void 0, void 0, function* () {
@@ -424,7 +428,7 @@ function getOnlyTranslatedOrApprovedFiles({ projectId, crowdinFiles, crowdinClie
             }
             catch (e) {
                 delete crowdinFiles[fileId];
-                (0, logger_1.logError)(e);
+                (0, logger_1.logError)(e, context);
             }
         })));
         const filteredFiles = {};

package/out/modules/integration/util/defaults.js

@@ -258,6 +258,7 @@ function applyIntegrationModuleDefaults(config, integration) {
     if (!integration.userErrorLifetimeDays) {
         integration.userErrorLifetimeDays = 30;
     }
+    integration.jobStoreType = integration.jobStoreType || 'db';
 }
 exports.applyIntegrationModuleDefaults = applyIntegrationModuleDefaults;
 function constructOauthUrl({ config, integration, clientId, loginForm, }) {

package/out/modules/integration/util/job.d.ts

@@ -1,8 +1,8 @@
-import { JobClient, JobClientType, JobType } from './types';
+import { JobClient, JobClientType, JobStoreType, JobType } from './types';
 import { Response } from 'express';
 import Crowdin from '@crowdin/crowdin-api-client';
 import { Config } from '../../../types';
-export declare function runAsJob({ integrationId, crowdinId, type, title, payload, res, projectId, client, jobType, jobCallback, onError, reRunJobId, }: {
+export declare function runAsJob({ integrationId, crowdinId, type, title, payload, res, projectId, client, jobType, jobStoreType, jobCallback, onError, reRunJobId, }: {
     integrationId: string;
     crowdinId: string;
     type: JobType;
@@ -12,6 +12,7 @@ export declare function runAsJob({ integrationId, crowdinId, type, title, payloa
     projectId: number;
     client: Crowdin;
     jobType: JobClientType;
+    jobStoreType: JobStoreType;
     jobCallback: (arg1: JobClient) => Promise<any>;
     onError?: (e: any) => Promise<void>;
     reRunJobId?: string;

package/out/modules/integration/util/job.js

@@ -47,7 +47,8 @@ const blockingJobs = {
     [types_1.JobType.INTEGRATION_SYNC_SETTINGS_SAVE]: [types_1.JobType.INTEGRATION_SYNC_SETTINGS_SAVE],
 };
 const maxAttempts = 3;
-function runAsJob({ integrationId, crowdinId, type, title, payload, res, projectId, client, jobType, jobCallback, onError, reRunJobId, }) {
+const store = {};
+function runAsJob({ integrationId, crowdinId, type, title, payload, res, projectId, client, jobType, jobStoreType, jobCallback, onError, reRunJobId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         let jobId;
         const storage = (0, storage_1.getStorage)();
@@ -77,6 +78,7 @@ function runAsJob({ integrationId, crowdinId, type, title, payload, res, project
         if (res) {
             res.status(202).send({ jobId });
         }
+        const isDbStore = jobStoreType === 'db';
         const job = {
             get: function getJob() {
                 return __awaiter(this, void 0, void 0, function* () {
@@ -102,14 +104,37 @@ function runAsJob({ integrationId, crowdinId, type, title, payload, res, project
             },
             type: jobType,
             fetchTranslation: ({ fileId, languageId }) => __awaiter(this, void 0, void 0, function* () {
-                const translationCache = yield storage.getFileTranslationCacheByLanguage({
-                    integrationId,
-                    crowdinId,
-                    fileId,
-                    languageId,
-                });
+                var _a, _b, _c;
+                const translationCache = isDbStore
+                    ? yield storage.getFileTranslationCacheByLanguage({
+                        integrationId,
+                        crowdinId,
+                        fileId,
+                        languageId,
+                    })
+                    : (_c = (_b = (_a = store[integrationId]) === null || _a === void 0 ? void 0 : _a[crowdinId]) === null || _b === void 0 ? void 0 : _b[fileId]) === null || _c === void 0 ? void 0 : _c[languageId];
                 if (!translationCache) {
-                    yield storage.saveTranslationCache({ integrationId, crowdinId, fileId, languageId });
+                    if (isDbStore) {
+                        yield storage.saveTranslationCache({ integrationId, crowdinId, fileId, languageId });
+                    }
+                    else {
+                        if (!store[integrationId]) {
+                            store[integrationId] = {};
+                        }
+                        if (!store[integrationId][crowdinId]) {
+                            store[integrationId] = {
+                                [crowdinId]: {},
+                            };
+                        }
+                        if (!store[integrationId][crowdinId][fileId]) {
+                            store[integrationId] = {
+                                [crowdinId]: {
+                                    [fileId]: {},
+                                },
+                            };
+                        }
+                        store[integrationId][crowdinId][fileId][languageId] = {};
+                    }
                 }
                 let translation = null;
                 try {
@@ -126,6 +151,10 @@ function runAsJob({ integrationId, crowdinId, type, title, payload, res, project
             }),
             // translationUploaded: async ({ fileId, languageId, etag }) => {
             translationUploaded: ({ fileId, translationParams }) => __awaiter(this, void 0, void 0, function* () {
+                if (!isDbStore) {
+                    translationParams.forEach(({ languageId, etag }) => (store[integrationId][crowdinId][fileId][languageId] = { etag }));
+                    return;
+                }
                 const translationCache = (yield storage.getFileTranslationCache({
                     integrationId,
                     crowdinId,

package/out/modules/integration/util/types.d.ts

@@ -21,6 +21,7 @@ export declare enum JobClientType {
     MANUAL = "manual",
     RERUN = "rerun"
 }
+export type JobStoreType = 'db' | 'in-memory';
 export interface Job {
     id: string;
     integrationId: string;

package/out/modules/integration/util/webhooks.js

@@ -36,6 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.listenQueueMessage = exports.updateCrowdinFromWebhookRequest = exports.prepareWebhookData = exports.unregisterAllCrowdinWebhooks = exports.unregisterWebhooks = exports.registerWebhooks = exports.HookEvents = void 0;
+const logsFormatter = __importStar(require("@crowdin/logs-formatter"));
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
 const amqplib_1 = __importDefault(require("amqplib"));
 const types_1 = require("../types");
@@ -265,8 +266,7 @@ function prepareWebhookData({ config, integration, provider, webhookUrlParam, })
         if (!crowdinCredentials) {
             return { projectId, crowdinClient, rootFolder, appSettings, syncSettings, preparedIntegrationCredentials };
         }
-        const context = {
-            jwtPayload: {
+        const context = Object.assign({ jwtPayload: {
                 context: {
                     // eslint-disable-next-line @typescript-eslint/camelcase
                     project_id: projectId,
@@ -275,8 +275,9 @@ function prepareWebhookData({ config, integration, provider, webhookUrlParam, })
                     // eslint-disable-next-line @typescript-eslint/camelcase
                     user_id: crowdinCredentials === null || crowdinCredentials === void 0 ? void 0 : crowdinCredentials.userId,
                 },
-            },
-        };
+            }, crowdinId: crowdinCredentials.id }, ((integrationCredentials === null || integrationCredentials === void 0 ? void 0 : integrationCredentials.id) && { clientId: integrationCredentials.id }));
+        logsFormatter.resetContext();
+        logsFormatter.setContext(context);
         crowdinClient = yield (0, connection_1.prepareCrowdinClient)({
             config,
             credentials: crowdinCredentials,

package/out/modules/manifest.js

@@ -225,6 +225,18 @@ function handle(config) {
             })));
         }
     }
+    if (config.webhooks) {
+        const webhooks = Array.isArray(config.webhooks) ? config.webhooks : [config.webhooks];
+        modules['webhook'] = [];
+        for (let i = 0; i < webhooks.length; i++) {
+            webhooks[i].key = config.identifier + '-' + 'webhook-' + i;
+            modules['webhook'].push({
+                key: webhooks[i].key,
+                url: '/webhooks',
+                events: webhooks[i].events,
+            });
+        }
+    }
     if (config.externalQaCheck) {
         config.externalQaCheck.key = config.identifier + '-qa-check';
         const uiModule = config.externalQaCheck.settingsUiModule;

package/out/modules/webhooks/handlers/webhook-handler.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="qs" />
+import { CrowdinClientRequest } from '../../../types';
+import { Response } from 'express';
+import { Webhook } from '../types';
+export declare function webhookHandler(webhooks: Webhook[]): (req: CrowdinClientRequest | 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/modules/webhooks/handlers/webhook-handler.js

@@ -0,0 +1,75 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webhookHandler = void 0;
+const util_1 = require("../../../util");
+const lodash_isstring_1 = __importDefault(require("lodash.isstring"));
+const crypto = __importStar(require("node:crypto"));
+const storage = __importStar(require("../../../storage"));
+function webhookHandler(webhooks) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const domain = req.headers['x-crowdin-domain'];
+        const organizationId = req.headers['x-crowdin-organization-id'];
+        const signature = req.headers['x-crowdin-signature'];
+        const moduleKey = req.headers['x-application-webhook-key'];
+        if (!(0, lodash_isstring_1.default)(domain) || !(0, lodash_isstring_1.default)(organizationId) || !(0, lodash_isstring_1.default)(signature) || !(0, lodash_isstring_1.default)(moduleKey)) {
+            res.status(400).send({ error: 'Invalid request' });
+            return;
+        }
+        const crowdinId = domain || organizationId;
+        const credentials = yield storage.getStorage().getCrowdinCredentials(crowdinId);
+        if (!credentials) {
+            throw new Error('Failed to find Crowdin credentials');
+        }
+        const hmac = crypto.createHmac('sha256', credentials.appSecret);
+        hmac.update(JSON.stringify(req.body).replace(/\//g, '\\/'));
+        const generatedSignature = hmac.digest('hex');
+        if (generatedSignature !== signature.replace('sha256=', '')) {
+            res.status(403).send({ error: 'Invalid signature' });
+            return;
+        }
+        res.status(200).send();
+        for (const webhook of webhooks) {
+            if (webhook.key === moduleKey) {
+                for (const event of req.body.payload.events) {
+                    yield webhook.callback({ credentials, event });
+                }
+            }
+        }
+    }));
+}
+exports.webhookHandler = webhookHandler;

package/out/modules/webhooks/index.d.ts

@@ -0,0 +1,6 @@
+import { Config } from '../../types';
+import { Express } from 'express';
+export declare function register({ config, app }: {
+    config: Config;
+    app: Express;
+}): void;

package/out/modules/webhooks/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = void 0;
+const json_response_1 = __importDefault(require("../../middlewares/json-response"));
+const webhook_handler_1 = require("./handlers/webhook-handler");
+function register({ config, app }) {
+    if (!config.webhooks) {
+        return;
+    }
+    const webhooks = Array.isArray(config.webhooks) ? config.webhooks : [config.webhooks];
+    if (webhooks.length) {
+        app.post('/webhooks', json_response_1.default, (0, webhook_handler_1.webhookHandler)(webhooks));
+    }
+}
+exports.register = register;