@crowdin/app-project-module 0.73.2 → 0.75.0

package/out/modules/api/api.js

@@ -14,6 +14,8 @@ const crowdin_file_progress_1 = __importDefault(require("../integration/handlers
 const crowdin_files_1 = __importDefault(require("../integration/handlers/crowdin-files"));
 const crowdin_update_1 = __importDefault(require("../integration/handlers/crowdin-update"));
 const integration_data_1 = __importDefault(require("../integration/handlers/integration-data"));
+const job_info_1 = __importDefault(require("../integration/handlers/job-info"));
+const job_cancel_1 = __importDefault(require("../integration/handlers/job-cancel"));
 const integration_login_1 = __importDefault(require("../integration/handlers/integration-login"));
 const integration_update_1 = __importDefault(require("../integration/handlers/integration-update"));
 const settings_1 = __importDefault(require("../integration/handlers/settings"));
@@ -55,7 +57,7 @@ function getDefaultApiEndpointsManifest(config) {
             description: 'Get a list of synced files',
             documentationUrl: '/api-docs#tag/Files/operation/crowdin.files',
         }, {
-            key: 'crowdin-files-api',
+            key: 'file-translation-progress-api',
             name: 'File Translation Progress',
             url: '/file-progress',
             method: types_1.RequestMethods.GET,
@@ -82,6 +84,20 @@ function getDefaultApiEndpointsManifest(config) {
             method: types_1.RequestMethods.POST,
             description: 'Update integration data',
             documentationUrl: '/api-docs#tag/Files/operation/integration.update',
+        }, {
+            key: 'job-get-api',
+            name: 'Job Status',
+            url: '/jobs',
+            method: types_1.RequestMethods.GET,
+            description: 'Get Job Info',
+            documentationUrl: '/api-docs#tag/Jobs/operation/job.get',
+        }, {
+            key: 'job-cancel-api',
+            name: 'Job Status',
+            url: '/jobs',
+            method: types_1.RequestMethods.DELETE,
+            description: 'Cancel Job',
+            documentationUrl: '/api-docs#tag/Jobs/operation/job.cancel',
         }, {
             key: 'settings-api',
             name: 'Get App Settings',
@@ -191,7 +207,7 @@ function addDefaultApiEndpoints(app, config) {
          *         name: fileId
          *         in: query
          *         required: true
-         *         description: 'Filter branch by name. Get via [List Crowdin Files](#operation/crowdin.files)'
+         *         description: 'Get via [List Crowdin Files](#operation/crowdin.files)'
          *         schema:
          *           type: integer
          *           example: 102
@@ -294,6 +310,62 @@ function addDefaultApiEndpoints(app, config) {
             checkSubscriptionExpiration: true,
             moduleKey: config.projectIntegration.key,
         }), (0, integration_credentials_1.default)(config, config.projectIntegration), (0, integration_update_1.default)(config, config.projectIntegration));
+        /**
+         * @openapi
+         * /jobs:
+         *   get:
+         *     tags:
+         *       - 'Jobs'
+         *     summary: 'Get Job Info'
+         *     operationId: job.get
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *       - name: jobId
+         *         in: query
+         *         required: false
+         *         schema:
+         *           type: string
+         *           example: 067da473-fc0b-43e3-b0a2-09d26af130c1
+         *     responses:
+         *       200:
+         *         description: 'Job information retrieved successfully'
+         *         content:
+         *           application/json:
+         *             schema:
+         *               $ref: '#/components/schemas/JobResponse'
+         */
+        app.get('/jobs', json_response_1.default, (0, crowdin_client_1.default)({
+            config,
+            optional: false,
+            checkSubscriptionExpiration: true,
+            moduleKey: config.projectIntegration.key,
+        }), (0, job_info_1.default)(config));
+        /**
+         * @openapi
+         * /jobs:
+         *   delete:
+         *     tags:
+         *       - 'Jobs'
+         *     summary: 'Cancel Job'
+         *     operationId: job.cancel
+         *     parameters:
+         *       - $ref: '#/components/parameters/ProjectId'
+         *       - name: jobId
+         *         in: query
+         *         required: false
+         *         schema:
+         *           type: string
+         *           example: 067da473-fc0b-43e3-b0a2-09d26af130c1
+         *     responses:
+         *       204:
+         *         description: 'Job canceled successfully'
+         */
+        app.delete('/jobs', json_response_1.default, (0, crowdin_client_1.default)({
+            config,
+            optional: false,
+            checkSubscriptionExpiration: true,
+            moduleKey: config.projectIntegration.key,
+        }), (0, job_cancel_1.default)(config));
         /**
          * @openapi
          * /settings:
@@ -413,7 +485,7 @@ function addDefaultApiEndpoints(app, config) {
              *     operationId: integration.fields
              *     responses:
              *      200:
-             *        description: 'File translation progress'
+             *        description: 'Login Form Fields'
              *        content:
              *          application/json:
              *            schema:

package/out/modules/api/components.d.ts

@@ -70,25 +70,32 @@
  *        - files
  *      properties:
  *        projectId:
- *          description: 'Project Identifier. Get via [List Projects](https://developer.crowdin.com/api/v2/#operation/api.projects.getMany)'
+ *          description: 'Project Id. Get via [List Projects](https://developer.crowdin.com/api/v2/#operation/api.projects.getMany)'
  *          type: integer
  *          example: 12
  *        files:
+ *          example: { 102: ['de', 'fr'], 999: ['uk'] }
  *          type: object
- *          example:
- *            102: ['uk', 'de']
- *          additionalProperties:
- *            type: array
- *            items:
- *              type: string
+ *          description: |
+ *            - **{fileId}** _(integer)_: Crowdin File Id. Get via [List Crowdin Files](#operation/crowdin.files)
+ *            - **[{languageCode}]** _(array of strings)_: List Of  Language Id. Get via [List Supported Languages](https://support.crowdin.com/developer/api/v2/#tag/Languages/operation/api.languages.getMany)
+ *
+ *            **Example:**
+ *              ```json
+ *              {
+ *               102: ["de", "fr"],
+ *               999: ["uk"]
+ *              }
+ *              ```
  *    UpdateResponse:
  *      type: object
- *      items:
- *        anyOf:
- *          - properties:
- *            message:
- *              type: string
- *              example: 'File 102 Not Found'
+ *      properties:
+ *        jobId:
+ *          type: string
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        message:
+ *          type: string
+ *          example: 'Another sync is running'
  *    SettingsData:
  *      type: object
  *      example: {schedule: 0, condition: 0}
@@ -195,8 +202,17 @@
  *          type: integer
  *          example: 86
  *    LoginFieldsResponse:
- *      example: [{ name: 'email', description: 'User email' }, { name: 'password', description: 'User password' }]
- *      type: object
+ *      type: array
+ *      items:
+ *        type: object
+ *        properties:
+ *          key:
+ *            type: string
+ *            example: 'apiKey'
+ *          name:
+ *            type: string
+ *            example: 'Service API key'
+ *      example: [{ key: 'email', name: 'User email' }, { key: 'password', name: 'User password' }]
  *    Login:
  *      title: 'Login'
  *      required:
@@ -211,9 +227,34 @@
  *          $ref: '#/components/schemas/LoginData'
  *    LoginData:
  *      type: object
+ *      description: 'Login Form Fields. Get via [Integration Login Form Fields](#operation/integration.fields)'
  *      example: { email: 'user@crowdin.com', password: 'password' }
- *      additionalProperties:
- *        type: string
+ *    Job:
+ *      type: object
+ *      properties:
+ *        id:
+ *          type: string
+ *          description: 'The Unique Identifier For The Job.'
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        progress:
+ *          type: integer
+ *          description: 'The Progress Of The Job.'
+ *          example: 94
+ *        status:
+ *          type: string
+ *          description: 'The Current Status Of The Job.'
+ *          example: 'inProgress'
+ *        title:
+ *          type: string
+ *          description: 'The Title Of The Job.'
+ *          example: 'Sync files to Crowdin'
+ *    JobResponse:
+ *      type: object
+ *      properties:
+ *        data:
+ *          type: array
+ *          items:
+ *            $ref: '#/components/schemas/Job'
  *
  *  parameters:
  *    ProjectId:

package/out/modules/api/components.js

@@ -71,25 +71,32 @@
  *        - files
  *      properties:
  *        projectId:
- *          description: 'Project Identifier. Get via [List Projects](https://developer.crowdin.com/api/v2/#operation/api.projects.getMany)'
+ *          description: 'Project Id. Get via [List Projects](https://developer.crowdin.com/api/v2/#operation/api.projects.getMany)'
  *          type: integer
  *          example: 12
  *        files:
+ *          example: { 102: ['de', 'fr'], 999: ['uk'] }
  *          type: object
- *          example:
- *            102: ['uk', 'de']
- *          additionalProperties:
- *            type: array
- *            items:
- *              type: string
+ *          description: |
+ *            - **{fileId}** _(integer)_: Crowdin File Id. Get via [List Crowdin Files](#operation/crowdin.files)
+ *            - **[{languageCode}]** _(array of strings)_: List Of  Language Id. Get via [List Supported Languages](https://support.crowdin.com/developer/api/v2/#tag/Languages/operation/api.languages.getMany)
+ *
+ *            **Example:**
+ *              ```json
+ *              {
+ *               102: ["de", "fr"],
+ *               999: ["uk"]
+ *              }
+ *              ```
  *    UpdateResponse:
  *      type: object
- *      items:
- *        anyOf:
- *          - properties:
- *            message:
- *              type: string
- *              example: 'File 102 Not Found'
+ *      properties:
+ *        jobId:
+ *          type: string
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        message:
+ *          type: string
+ *          example: 'Another sync is running'
  *    SettingsData:
  *      type: object
  *      example: {schedule: 0, condition: 0}
@@ -196,8 +203,17 @@
  *          type: integer
  *          example: 86
  *    LoginFieldsResponse:
- *      example: [{ name: 'email', description: 'User email' }, { name: 'password', description: 'User password' }]
- *      type: object
+ *      type: array
+ *      items:
+ *        type: object
+ *        properties:
+ *          key:
+ *            type: string
+ *            example: 'apiKey'
+ *          name:
+ *            type: string
+ *            example: 'Service API key'
+ *      example: [{ key: 'email', name: 'User email' }, { key: 'password', name: 'User password' }]
  *    Login:
  *      title: 'Login'
  *      required:
@@ -212,9 +228,34 @@
  *          $ref: '#/components/schemas/LoginData'
  *    LoginData:
  *      type: object
+ *      description: 'Login Form Fields. Get via [Integration Login Form Fields](#operation/integration.fields)'
  *      example: { email: 'user@crowdin.com', password: 'password' }
- *      additionalProperties:
- *        type: string
+ *    Job:
+ *      type: object
+ *      properties:
+ *        id:
+ *          type: string
+ *          description: 'The Unique Identifier For The Job.'
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        progress:
+ *          type: integer
+ *          description: 'The Progress Of The Job.'
+ *          example: 94
+ *        status:
+ *          type: string
+ *          description: 'The Current Status Of The Job.'
+ *          example: 'inProgress'
+ *        title:
+ *          type: string
+ *          description: 'The Title Of The Job.'
+ *          example: 'Sync files to Crowdin'
+ *    JobResponse:
+ *      type: object
+ *      properties:
+ *        data:
+ *          type: array
+ *          items:
+ *            $ref: '#/components/schemas/Job'
  *
  *  parameters:
  *    ProjectId:

package/out/modules/context-menu/types.d.ts

@@ -10,7 +10,7 @@ export interface ContextModule {
     /**
      * Support fileName pattern only. Contains fileName field regular expressions used to detect the file type. If the file name matches any of the regular expressions, the context menu will be displayed.
      */
-    signaturePatterns?: SignaturePatterns;
+    signaturePatterns?: ContextSignaturePatterns;
 }
 export declare enum ContextOptionsLocations {
     TM = "tm",
@@ -25,3 +25,7 @@ export declare enum ContextOptionsTypes {
     NEW_TAB = "new_tab",
     REDIRECT = "redirect"
 }
+export type ElementNodeType = 0 | 1 | 2;
+export type ContextSignaturePatterns = SignaturePatterns & {
+    nodeType?: ElementNodeType[];
+};

package/out/modules/integration/handlers/job-cancel.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-export default function handle(): (req: import("../../../types").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;
+import { Config } from '../../../types';
+export default function handle(config: Config): (req: import("../../../types").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/integration/handlers/job-cancel.js

@@ -12,9 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const types_1 = require("../util/types");
 const util_1 = require("../../../util");
 const storage_1 = require("../../../storage");
-function handle() {
+function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const id = req.query.job_id || req.body.job_id;
+        var _a;
+        const id = req.query.jobId || req.body.jobId;
+        const isApi = (0, util_1.isApiRequest)(req, config);
+        if (isApi && !((_a = req.body) === null || _a === void 0 ? void 0 : _a.projectId)) {
+            res.send({
+                error: 'Project id is require',
+            });
+            return;
+        }
         if (!id) {
             req.logInfo('Job id is absent');
             res.status(400).send('Job id is required');

package/out/modules/integration/handlers/job-info.js

@@ -35,13 +35,33 @@ function getHumanETA(ms) {
 }
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const id = req.query.job_id || req.body.job_id;
+        var _a;
+        const id = req.query.jobId || req.body.jobId;
+        const isApi = (0, util_1.isApiRequest)(req, config);
+        if (isApi && !((_a = req.body) === null || _a === void 0 ? void 0 : _a.projectId)) {
+            res.send({
+                error: 'Project id is require',
+            });
+            return;
+        }
         if (!id) {
             req.logInfo('Get active jobs');
             const jobs = yield (0, storage_1.getStorage)().getActiveJobs({
                 integrationId: req.crowdinContext.clientId,
                 crowdinId: req.crowdinContext.crowdinId,
             });
+            if (isApi && jobs) {
+                const filteredJobs = jobs.map((job) => ({
+                    id: job.id,
+                    progress: job.progress,
+                    status: job.status,
+                    title: job.title,
+                }));
+                req.logInfo(`Returning active filtered jobs info ${JSON.stringify(filteredJobs, null, 2)}`);
+                res.send(filteredJobs);
+                return;
+            }
+            req.logInfo(`Returning active jobs info ${JSON.stringify(jobs, null, 2)}`);
             res.send(jobs);
             return;
         }
@@ -51,6 +71,17 @@ function handle(config) {
             job.eta = ((Date.now() - job.createdAt) / job.progress) * (100 - job.progress);
             job.info = getHumanETA(job.eta) + (job.info ? `\n${job.info}` : '');
         }
+        if (isApi && job) {
+            const filteredJob = {
+                id: job.id,
+                progress: job.progress,
+                status: job.status,
+                title: job.title,
+            };
+            req.logInfo(`Returning filtered job info ${JSON.stringify(filteredJob, null, 2)}`);
+            res.send([filteredJob]);
+            return;
+        }
         if (job && (job === null || job === void 0 ? void 0 : job.updatedAt) && Date.now() - job.updatedAt >= MINUTES * 60 * 1000) {
             const context = req.crowdinContext;
             const projectId = context.jwtPayload.context.project_id;

package/out/modules/integration/index.js

@@ -99,7 +99,7 @@ function register({ config, app }) {
         optional: false,
         checkSubscriptionExpiration: true,
         moduleKey: integrationLogic.key,
-    }), (0, job_cancel_1.default)());
+    }), (0, job_cancel_1.default)(config));
     app.post('/api/settings', (0, crowdin_client_1.default)({
         config,
         optional: false,

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

@@ -45,8 +45,8 @@ const connection_1 = require("../../../util/connection");
 const defaults_1 = require("./defaults");
 const index_1 = require("../../../util/index");
 const logger_1 = require("../../../util/logger");
-const prefetchCount = 20;
-const forceProcessDelay = 5000;
+const prefetchCount = 10;
+const forceProcessDelay = 10000;
 exports.HookEvents = {
     fileAdded: 'file.added',
     fileDeleted: 'file.deleted',
@@ -407,7 +407,7 @@ function consumer({ channel, config, integration, }) {
                     webhooksInfo[clientId].data.push(data);
                 }
                 if (messagesCounter < prefetchCount) {
-                    // if all messages are not received, wait 5 seconds to force process messages
+                    // if all messages are not received, wait 10 seconds to force process messages
                     timeoutId = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
                         yield processMessages({
                             webhooksData,
@@ -436,16 +436,22 @@ function consumer({ channel, config, integration, }) {
 }
 function processMessages({ channel, msg, webhooksData, webhooksInfo, }) {
     return __awaiter(this, void 0, void 0, function* () {
-        yield Promise.all(webhooksData);
-        for (const { data, integration, webhookData } of Object.values(webhooksInfo)) {
-            if (webhookData && webhookData.crowdinClient) {
-                yield updateCrowdinFromWebhookRequest({
-                    integration: integration,
-                    webhookData: webhookData,
-                    req: data,
-                });
+        try {
+            yield Promise.all(webhooksData);
+            for (const { data, integration, webhookData } of Object.values(webhooksInfo)) {
+                if (webhookData && webhookData.crowdinClient) {
+                    yield updateCrowdinFromWebhookRequest({
+                        integration: integration,
+                        webhookData: webhookData,
+                        req: data,
+                    });
+                }
             }
+            channel.ack(msg, true);
+        }
+        catch (e) {
+            (0, logger_1.logError)(e);
+            channel.nack(msg, false, false);
         }
-        channel.ack(msg, true);
     });
 }

package/out/modules/manifest.js

@@ -275,7 +275,7 @@ function handle(config) {
                 workflowStep.key = config.identifier + '-' + (0, util_3.getWorkflowStepKey)(workflowStep);
             }
             const uiModule = ((_a = workflowStep === null || workflowStep === void 0 ? void 0 : workflowStep.settingsUiModule) === null || _a === void 0 ? void 0 : _a.formSchema) || ((_b = workflowStep === null || workflowStep === void 0 ? void 0 : workflowStep.settingsUiModule) === null || _b === void 0 ? void 0 : _b.fileName);
-            modules['workflow-step-type'].push(Object.assign(Object.assign(Object.assign({ key: workflowStep.key, name: workflowStep.name || config.name, description: workflowStep.description || config.description, boundaries: workflowStep.boundaries }, (workflowStep.editorMode ? { editorMode: workflowStep.editorMode } : {})), { updateSettingsUrl: (0, util_3.getWorkflowStepUrl)('/settings', workflowStep), deleteSettingsUrl: (0, util_3.getWorkflowStepUrl)('/delete', workflowStep) }), (uiModule ? { url: (0, util_3.getWorkflowStepUrl)('/workflow-step', workflowStep) } : {})));
+            modules['workflow-step-type'].push(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ key: workflowStep.key, name: workflowStep.name || config.name }, ((workflowStep === null || workflowStep === void 0 ? void 0 : workflowStep.imagePath) ? { logo: (0, util_1.getLogoUrl)(workflowStep, `-${workflowStep.key}`) } : {})), { description: workflowStep.description || config.description, boundaries: workflowStep.boundaries }), (workflowStep.editorMode ? { editorMode: workflowStep.editorMode } : {})), { updateSettingsUrl: (0, util_3.getWorkflowStepUrl)('/settings', workflowStep), deleteSettingsUrl: (0, util_3.getWorkflowStepUrl)('/delete', workflowStep) }), (uiModule ? { url: (0, util_3.getWorkflowStepUrl)('/workflow-step', workflowStep) } : {})));
         }
     }
     const events = {

package/out/modules/webhooks/handlers/webhook-handler.js

@@ -47,11 +47,11 @@ function webhookHandler(config, webhooks) {
         const organizationId = req.headers['x-crowdin-id'];
         const signature = req.headers['x-crowdin-signature'];
         const moduleKey = req.headers['x-module-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)) {
+        if (!(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 crowdinId = domain && (0, lodash_isstring_1.default)(domain) ? domain : organizationId;
         const credentials = yield storage.getStorage().getCrowdinCredentials(crowdinId);
         if (!credentials) {
             throw new Error('Failed to find Crowdin credentials');

package/out/modules/workflow-step-type/index.js

@@ -10,6 +10,7 @@ const util_1 = require("./util");
 const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
 const step_settings_save_1 = __importDefault(require("./handlers/step-settings-save"));
 const delete_step_1 = __importDefault(require("./handlers/delete-step"));
+const util_2 = require("../../util");
 function register({ config, app }) {
     if (!config.workflowStepType) {
         return;
@@ -28,6 +29,9 @@ function register({ config, app }) {
             checkSubscriptionExpiration: false,
             moduleKey: workflowStep.key,
         }), (0, delete_step_1.default)(workflowStep));
+        if (workflowStep.imagePath) {
+            app.get((0, util_2.getLogoUrl)(workflowStep, `-${workflowStep.key}`), (req, res) => res.sendFile(workflowStep.imagePath || config.imagePath));
+        }
         if (workflowStep.settingsUiModule) {
             app.use((0, util_1.getWorkflowStepUrl)('/workflow-step', workflowStep), (0, ui_module_1.default)({ config, moduleType: workflowStep.key }), (0, render_ui_module_1.default)(workflowStep.settingsUiModule));
         }

package/out/modules/workflow-step-type/types.d.ts

@@ -1,4 +1,4 @@
-import { CrowdinContextInfo, ModuleKey, UiModule } from '../../types';
+import { CrowdinContextInfo, ImagePath, ModuleKey, UiModule } from '../../types';
 import Crowdin from '@crowdin/crowdin-api-client';
 interface Boundaries {
     input: Input;
@@ -13,7 +13,7 @@ interface Output {
     port: Port;
 }
 type Port = 'customCodeFalse' | 'customCodeTrue' | 'untranslated' | 'translated' | 'approved' | 'skipped' | 'all';
-export interface WorkflowStepTypeModule extends ModuleKey {
+export interface WorkflowStepTypeModule extends ModuleKey, ImagePath {
     /**
      * module name
      */