@crowdin/app-project-module 0.57.1 → 0.58.1

package/out/index.js

@@ -65,6 +65,7 @@ const aiPromptProvider = __importStar(require("./modules/ai-prompt-provider"));
 const aiTools = __importStar(require("./modules/ai-tools"));
 const editorRightPanelApp = __importStar(require("./modules/editor-right-panel"));
 const editorThemesApp = __importStar(require("./modules/editor-themes"));
+const externalQaCheck = __importStar(require("./modules/external-qa-check"));
 const fileProcessingApps = __importStar(require("./modules/file-processing"));
 const integrationApp = __importStar(require("./modules/integration"));
 const modalApp = __importStar(require("./modules/modal"));
@@ -170,6 +171,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     aiPromptProvider.register({ config, app });
     aiTools.registerAiTools({ config, app });
     aiTools.registerAiToolWidgets({ config, app });
+    externalQaCheck.register({ config, app });
     addFormSchema({ config, app });
     return Object.assign(Object.assign({}, exports.metadataStore), { establishCrowdinConnection: (authRequest) => {
             let jwtToken = '';

package/out/modules/external-qa-check/handlers/validate.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CrowdinClientRequest } from '../../../types';
+import { ExternalQaCheckModule } from '../types';
+export default function handle(externalQaCheck: ExternalQaCheckModule): (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/external-qa-check/handlers/validate.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../../util");
+const logger_1 = require("../../../util/logger");
+function handle(externalQaCheck) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const body = req.body.data;
+        (0, logger_1.log)('Received request for external qa check');
+        (0, logger_1.log)(`Payload ${JSON.stringify(body, null, 2)}`);
+        try {
+            const response = yield externalQaCheck.validate({
+                client: req.crowdinApiClient,
+                file: body.file,
+                project: body.project,
+                sourceLanguage: body.sourceLanguage,
+                strings: body.strings,
+                targetLanguage: body.targetLanguage,
+                translations: body.translations,
+                context: req.crowdinContext,
+            });
+            res.send({
+                data: { validations: response.validations },
+                error: response.error ? { message: response.error } : undefined,
+            });
+        }
+        catch (e) {
+            if (req.logError) {
+                req.logError(e);
+            }
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

package/out/modules/external-qa-check/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/external-qa-check/index.js

@@ -0,0 +1,27 @@
+"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 ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
+const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
+const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
+const validate_1 = __importDefault(require("./handlers/validate"));
+function register({ config, app }) {
+    const qaCheck = config.externalQaCheck;
+    if (!qaCheck) {
+        return;
+    }
+    if (qaCheck === null || qaCheck === void 0 ? void 0 : qaCheck.batchSize) {
+        app.use('/batch-size', json_response_1.default, (req, res) => {
+            res.send({ data: { size: qaCheck.batchSize } });
+        });
+    }
+    app.use('/validate', json_response_1.default, (0, crowdin_client_1.default)(config), (0, validate_1.default)(qaCheck));
+    if (qaCheck.settingsUiModule) {
+        app.use('/settings', (0, ui_module_1.default)(config, true), (0, render_ui_module_1.default)(qaCheck.settingsUiModule));
+    }
+}
+exports.register = register;

package/out/modules/external-qa-check/types.d.ts

@@ -0,0 +1,57 @@
+import { CrowdinContextInfo, Environments, UiModule } from '../../types';
+import Crowdin, { SourceFilesModel, ProjectsGroupsModel, LanguagesModel, SourceStringsModel, StringTranslationsModel } from '@crowdin/crowdin-api-client';
+export interface ExternalQaCheckModule extends Environments {
+    /**
+     * module description
+     */
+    description?: string;
+    /**
+     * module name
+     */
+    name?: string;
+    /**
+     * jobs chunk size
+     */
+    batchSize?: number;
+    validate: ({ client, file, project, sourceLanguage, strings, targetLanguage, translations, context, }: {
+        client?: Crowdin;
+        file?: SourceFilesModel.File;
+        project?: ProjectsGroupsModel.Project;
+        sourceLanguage: LanguagesModel.Language;
+        strings: SourceStringsModel.String[];
+        targetLanguage: LanguagesModel.Language;
+        translations: StringTranslationsModel.StringTranslation[];
+        context: CrowdinContextInfo;
+    }) => Promise<ExternalQaCheckResponse>;
+    /**
+     * Settings UI module
+     */
+    settingsUiModule?: UiModule;
+}
+export interface ExternalQaCheckRequest {
+    file: SourceFilesModel.File;
+    project: ProjectsGroupsModel.Project;
+    sourceLanguage: LanguagesModel.Language;
+    strings: SourceStringsModel.String[];
+    targetLanguage: LanguagesModel.Language;
+    translations: StringTranslationsModel.StringTranslation[];
+}
+interface SuggestedFix {
+    indexStart: number;
+    indexEnd: number;
+    replacement: string;
+}
+interface ValidationError {
+    message: string;
+    suggestedFixes?: SuggestedFix[];
+}
+interface Validation {
+    translationId: number;
+    passed: boolean;
+    error?: ValidationError;
+}
+export interface ExternalQaCheckResponse {
+    validations: Validation[];
+    error?: string;
+}
+export {};

package/out/modules/external-qa-check/types.js

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

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

@@ -241,6 +241,12 @@ function filesCron({ config, integration, period, }) {
                     });
                 }
                 catch (e) {
+                    yield (0, logger_1.handleUserError)({
+                        action: 'Auto sync files to External Service',
+                        error: e,
+                        crowdinId: syncSettings.crowdinId,
+                        clientId: syncSettings.integrationId,
+                    });
                     (0, logger_1.logError)(e, context);
                     continue;
                 }
@@ -285,6 +291,12 @@ function filesCron({ config, integration, period, }) {
                     });
                 }
                 catch (e) {
+                    yield (0, logger_1.handleUserError)({
+                        action: 'Auto sync files to Crowdin',
+                        error: e,
+                        crowdinId: syncSettings.crowdinId,
+                        clientId: syncSettings.integrationId,
+                    });
                     (0, logger_1.logError)(e, context);
                     continue;
                 }

package/out/modules/manifest.js

@@ -207,6 +207,12 @@ function handle(config) {
             })));
         }
     }
+    if (config.externalQaCheck) {
+        const uiModule = config.externalQaCheck.settingsUiModule;
+        modules['external-qa-check'] = [
+            Object.assign(Object.assign({ key: config.identifier + '-qa-check', name: config.externalQaCheck.name || config.name, description: config.externalQaCheck.description || config.description, runQaCheckUrl: '/validate' }, (config.externalQaCheck.batchSize ? { getBatchSizeUrl: '/batch-size' } : {})), (uiModule ? { url: '/settings/' + (uiModule.fileName || 'index.html') } : {})),
+        ];
+    }
     const events = {
         installed: '/installed',
         uninstall: '/uninstall',

package/out/types.d.ts

@@ -15,6 +15,7 @@ import { LogErrorFunction, LogFunction } from './util/logger';
 import { AiProviderModule } from './modules/ai-provider/types';
 import { AiPromptProviderModule } from './modules/ai-prompt-provider/types';
 import { AiTool, AiToolWidget } from './modules/ai-tools/types';
+import { ExternalQaCheckModule } from './modules/external-qa-check/types';
 export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app", "crowdin_agent". Default: "crowdin_app"
@@ -198,6 +199,10 @@ export interface ClientConfig extends ImagePath {
      * AI tool_calls modules with UI widgets
      */
     aiToolsWidget?: AiToolWidget | AiToolWidget[];
+    /**
+     * qa check module
+     */
+    externalQaCheck?: ExternalQaCheckModule & ImagePath;
 }
 export interface Environments {
     environments?: Environment | Environment[];

package/out/util/logger.js

@@ -221,7 +221,7 @@ function storeUserError({ action, error, crowdinId, clientId, }) {
         if (error instanceof AppModuleError && error.appData) {
             data.appData = error.appData;
         }
-        yield (0, storage_1.getStorage)().saveUserError(action, error.message, JSON.stringify(data), `${Date.now()}`, crowdinId, clientId);
+        yield (0, storage_1.getStorage)().saveUserError(action, (error === null || error === void 0 ? void 0 : error.message) || JSON.stringify(error, null, 2), JSON.stringify(data), `${Date.now()}`, crowdinId, clientId);
     });
 }
 function clearOldUserErrors(crowdinId, clientId) {

package/out/views/main.handlebars

@@ -1141,12 +1141,25 @@
         document.getElementById('user-errors').classList.add('hidden');
     }
 
+    function isJSON(string) {
+      try {
+        JSON.parse(string);
+        return true;
+      } catch (e) {
+        return false;
+      }
+    }
+
     function getUserErrorDetail(error) {
       const data = JSON.parse(error.data);
 
       let html = '<div class="error-detail-table"><table>';
       html += `<tr><td>Action</td><td>${sanitizeHTML(error.action)}</td></tr>`;
-      html += `<tr><td>Message</td><td>${sanitizeHTML(error.message)}</td></tr>`;
+      if (isJSON(error.message)) {
+        html += `<tr><td>Message</td><td><pre>${sanitizeHTML(error.message)}<pre></td></tr>`;
+      } else {
+        html += `<tr><td>Message</td><td>${sanitizeHTML(error.message)}</td></tr>`;
+      }
       html += `<tr><td>Date/time</td><td>${sanitizeHTML(error.createdAt)}</td></tr>`;
 
       if (data.requestParams) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.57.1",
+  "version": "0.58.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",