@crowdin/app-project-module 0.68.1 → 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/util/cron.js

@@ -175,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)({
@@ -187,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)({
@@ -205,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
@@ -229,7 +231,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                 });
             }
             catch (e) {
-                (0, logger_1.logError)(e);
+                (0, logger_1.logError)(e, context);
                 return;
             }
         }
@@ -268,6 +270,7 @@ function processSyncSettings({ config, integration, period, syncSettings, }) {
                     crowdinClient,
                     onlyApproved,
                     onlyTranslated,
+                    context,
                 });
             if (Object.keys(filesToProcess).length <= 0) {
                 return;
@@ -410,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* () {
@@ -425,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/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;

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

@@ -0,0 +1,292 @@
+import { CrowdinCredentials, ModuleKey } from '../../types';
+export interface Webhook extends ModuleKey {
+    /**
+     * Events that the webhook should listen to
+     */
+    events: string[];
+    /**
+     * handle function
+     */
+    callback: (data: {
+        credentials: CrowdinCredentials;
+        event: Event;
+    }) => Promise<void>;
+}
+interface EventPayload {
+    event: string;
+}
+interface BranchPayload {
+    id: number;
+}
+interface FilePayload {
+    id: number;
+    name: string;
+    title: string | null;
+    type: string;
+    path: string;
+    status: string;
+    revision: number;
+    branchId: number | null;
+    directoryId: number | null;
+    project?: ProjectPayload;
+}
+interface GroupPayload {
+    id: number;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    description: string | null;
+    parentId: number;
+    userId: number;
+    organizationId: number;
+}
+interface LanguagePayload {
+    id: string;
+    name: string;
+    editorCode: string;
+    twoLettersCode: string;
+    threeLettersCode: string;
+    locale: string;
+    androidCode: string;
+    osxCode: string;
+    osxLocale: string;
+    textDirection: string;
+    dialectOf: string;
+}
+interface ProjectBuildPayload {
+    id: number;
+    downloadUrl: string;
+    project: ProjectPayload;
+}
+interface ProjectPayload {
+    id: number;
+    userId: number;
+    sourceLanguageId: string;
+    targetLanguageIds: string[];
+    identifier: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+    lastActivity: string;
+    description: string;
+    url: string;
+    cname: string | null;
+    languageAccessPolicy?: string;
+    visibility?: string;
+    publicDownloads?: boolean;
+    logo?: string;
+    isExternal?: boolean;
+    externalType?: string | null;
+    hasCrowdsourcing?: boolean;
+}
+interface StepPayload {
+    name: string;
+}
+interface SuggestionPayload {
+    id: number;
+    text: string;
+    pluralCategoryName: string | null;
+    rating: number;
+    provider: string | null;
+    isPreTranslated: boolean;
+    createdAt: string;
+    step?: StepPayload | null;
+}
+interface NewSuggestionPayload {
+    user: UserPayload | null;
+    targetLanguage: LanguagePayload | null;
+    string: TranslationPayload | null;
+}
+interface TaskPayload {
+    id: number;
+    type: number;
+    vendor?: string | null;
+    status?: string | null;
+    title: string;
+    assignees: TaskAssigneeUserPayload[];
+    assignedTeams: TaskAssigneeTeamPayload[];
+    fileIds?: number[];
+    branchIds?: number[];
+    progress: {
+        total: number;
+        done: number;
+        percent: number;
+    };
+    description: string;
+    translationUrl: string | null;
+    wordsCount: number;
+    filesCount?: number;
+    commentsCount: number;
+    deadline: string;
+    timeRange: string | null;
+    workflowStepId: number;
+    buyUrl: string;
+    createdAt: string;
+    updatedAt: string;
+    oldStatus: string | null;
+    newStatus: string | null;
+    sourceLanguage: LanguagePayload;
+    targetLanguage: LanguagePayload | null;
+    project: ProjectPayload;
+    taskCreator: UserPayload;
+}
+interface TranslationDiscussionsPayload {
+    id: number;
+    text: string;
+    type: string;
+    issueType: string;
+    issueStatus: string;
+    resolvedAt: string;
+    createdAt: string;
+    string: TranslationPayload;
+    targetLanguage: LanguagePayload;
+    user: UserPayload;
+    commentResolver: UserPayload;
+}
+interface TranslationPayload {
+    id: number;
+    identifier: string;
+    key: string;
+    text: string;
+    type: string;
+    context: string;
+    maxLength: number;
+    isHidden: boolean;
+    isDuplicate: boolean;
+    masterStringId: number;
+    revision?: number;
+    hasPlurals: boolean;
+    labelIds: number[];
+    url: string;
+    createdAt: string;
+    updatedAt: string;
+    file?: FilePayload;
+    branch?: BranchPayload;
+    project: ProjectPayload;
+}
+interface UserPayload {
+    id: number;
+    username: string;
+    fullName: string;
+    avatarUrl: string;
+}
+interface TaskAssigneeUserPayload extends UserPayload {
+    worksCount: number;
+    wordsLeft: number;
+}
+interface TaskAssigneeTeamPayload {
+    id: number;
+    wordsCount: number;
+}
+export interface FileTranslatedEvent extends EventPayload {
+    file: FilePayload;
+    targetLanguage: LanguagePayload;
+    step?: StepPayload;
+}
+export interface FileApprovedEvent extends EventPayload {
+    file: FilePayload;
+    targetLanguage: LanguagePayload;
+    step?: StepPayload;
+}
+export interface FileAddedEvent extends EventPayload {
+    file: FilePayload;
+    user: UserPayload;
+}
+export interface FileUpdatedEvent extends EventPayload {
+    file: FilePayload;
+    user: UserPayload;
+}
+export interface FileRevertedEvent extends EventPayload {
+    file: FilePayload;
+    user: UserPayload;
+}
+export interface FileDeletedEvent extends EventPayload {
+    file: FilePayload;
+    user: UserPayload;
+}
+export interface ProjectTranslatedEvent extends EventPayload {
+    project: ProjectPayload;
+    targetLanguage: LanguagePayload;
+    workflowStep: StepPayload;
+}
+export interface ProjectApprovedEvent extends EventPayload {
+    project: ProjectPayload;
+    targetLanguage: LanguagePayload;
+    workflowStep: StepPayload;
+}
+export interface ProjectBuiltEvent extends EventPayload {
+    build: ProjectBuildPayload;
+}
+export interface TopSuggestionUpdatedEvent extends EventPayload {
+    oldTranslation: SuggestionPayload;
+    newTranslation: NewSuggestionPayload;
+}
+export interface SuggestionAddedEvent extends EventPayload {
+    translation: TranslationPayload;
+}
+export interface SuggestionUpdatedEvent extends EventPayload {
+    translation: TranslationPayload;
+}
+export interface SuggestionDeletedEvent extends EventPayload {
+    translation: TranslationPayload;
+}
+export interface SuggestionApprovedEvent extends EventPayload {
+    translation: TranslationPayload;
+}
+export interface SuggestionDisapprovedEvent extends EventPayload {
+    translation: TranslationPayload;
+}
+export interface StringAddedEvent extends EventPayload {
+    string: TranslationPayload;
+    user: UserPayload;
+}
+export interface StringUpdatedEvent extends EventPayload {
+    string: TranslationPayload;
+    user: UserPayload;
+}
+export interface StringDeletedEvent extends EventPayload {
+    string: TranslationPayload;
+    user: UserPayload;
+}
+export interface TranslationDiscussionsCreatedEvent extends EventPayload {
+    comment: TranslationDiscussionsPayload;
+}
+export interface TranslationDiscussionsUpdatedEvent extends EventPayload {
+    comment: TranslationDiscussionsPayload;
+}
+export interface TranslationDiscussionsDeletedEvent extends EventPayload {
+    comment: TranslationDiscussionsPayload;
+}
+export interface TranslationDiscussionsRestoredEvent extends EventPayload {
+    comment: TranslationDiscussionsPayload;
+}
+export interface TaskAddedEvent extends EventPayload {
+    task: TaskPayload;
+}
+export interface TaskStatusChangedEvent extends EventPayload {
+    task: TaskPayload;
+}
+export interface TaskDeletedEvent extends EventPayload {
+    task: TaskPayload;
+}
+export interface TaskUpdatedEvent extends EventPayload {
+    task: TaskPayload;
+}
+export interface ProjectCreatedEvent extends EventPayload {
+    project: ProjectPayload;
+    user: UserPayload;
+}
+export interface ProjectDeletedEvent extends EventPayload {
+    project: ProjectPayload;
+    user: UserPayload;
+}
+export interface GroupCreatedEvent extends EventPayload {
+    group: GroupPayload;
+    user: UserPayload;
+}
+export interface GroupDeletedEvent extends EventPayload {
+    group: GroupPayload;
+    user: UserPayload;
+}
+export type Event = FileTranslatedEvent | FileApprovedEvent | FileAddedEvent | FileUpdatedEvent | FileRevertedEvent | FileDeletedEvent | ProjectTranslatedEvent | ProjectApprovedEvent | ProjectBuiltEvent | TopSuggestionUpdatedEvent | SuggestionAddedEvent | SuggestionUpdatedEvent | SuggestionDeletedEvent | SuggestionApprovedEvent | SuggestionDisapprovedEvent | StringAddedEvent | StringUpdatedEvent | StringDeletedEvent | TranslationDiscussionsCreatedEvent | TranslationDiscussionsUpdatedEvent | TranslationDiscussionsDeletedEvent | TranslationDiscussionsRestoredEvent | TaskAddedEvent | TaskStatusChangedEvent | TaskDeletedEvent | TaskUpdatedEvent | ProjectCreatedEvent | ProjectDeletedEvent | GroupCreatedEvent | GroupDeletedEvent;
+export {};

package/out/modules/webhooks/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });