@crowdin/app-project-module 0.99.0 → 0.100.1

package/out/index.js

@@ -210,6 +210,7 @@ function addCrowdinEndpoints(app, clientConfig) {
     fileProcessingApps.registerFilePostImport({ config, app });
     fileProcessingApps.registerFilePreExport({ config, app });
     fileProcessingApps.registerFilePostExport({ config, app });
+    fileProcessingApps.registerFileTranslationsAlignmentExport({ config, app });
     apiApp.register({ config, app });
     aiProvider.register({ config, app });
     aiPromptProvider.register({ config, app });

package/out/modules/file-processing/handlers/translations-alignment.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { Config, CrowdinClientRequest } from '../../../types';
+import { TranslationsAlignmentLogic } from '../types';
+export default function handle(baseConfig: Config, config: TranslationsAlignmentLogic, folderName: string): (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/file-processing/handlers/translations-alignment.js

@@ -0,0 +1,72 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const util_1 = require("../../../util");
+const files_1 = require("../util/files");
+function handle(baseConfig, config, folderName) {
+    const folderPath = config.filesFolder || baseConfig.dbFolder;
+    if (!fs_1.default.existsSync(path_1.default.join(folderPath, folderName))) {
+        fs_1.default.mkdirSync(path_1.default.join(folderPath, folderName), { recursive: true });
+    }
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const response = {};
+        const baseFilesUrl = `${baseConfig.baseUrl}/file/download/${folderName}`;
+        const body = req.body;
+        // Skip assets (e.g., images, videos, or other media files) as they typically don't need to be processed
+        if (((_a = body === null || body === void 0 ? void 0 : body.file) === null || _a === void 0 ? void 0 : _a.type) === 'assets' && !('processAssets' in config && config.processAssets)) {
+            res.sendStatus(415);
+            return;
+        }
+        const fileSourceStringsContent = body.sourceStringsUrl
+            ? (yield (0, files_1.getFileStrings)(body.sourceStringsUrl))
+            : body.sourceStrings;
+        const fileTranslationsContent = body.translationStringsUrl
+            ? (yield (0, files_1.getFileStrings)(body.translationStringsUrl))
+            : body.translationStrings;
+        const fileProcessResult = yield config.fileProcess(body, {
+            sourceStrings: fileSourceStringsContent,
+            translations: fileTranslationsContent,
+        }, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
+        const { strings, error: processingErrorMessage } = fileProcessResult;
+        if (!strings) {
+            response.translations = [];
+            res.send({
+                data: response,
+                error: processingErrorMessage ? { message: processingErrorMessage } : undefined,
+            });
+            return;
+        }
+        const stringsNDJson = strings.map((s) => JSON.stringify(s)).join('\n\r');
+        const bufferData = Buffer.from(stringsNDJson, 'utf-8');
+        if (Buffer.byteLength(bufferData) < files_1.MAX_BODY_SIZE) {
+            response.translations = strings;
+        }
+        else {
+            let url;
+            if (config.storeFile) {
+                url = yield config.storeFile(bufferData);
+            }
+            else {
+                const storedFile = yield (0, files_1.storeFile)(bufferData, path_1.default.join(folderPath, folderName));
+                url = `${baseFilesUrl}?file=${storedFile}`;
+            }
+            response.translationsUrl = url;
+        }
+        res.send({ data: response, error: processingErrorMessage ? { message: processingErrorMessage } : undefined });
+    }));
+}
+exports.default = handle;

package/out/modules/file-processing/index.d.ts

@@ -20,3 +20,7 @@ export declare function registerFilePostExport({ config, app }: {
     config: Config;
     app: Express;
 }): void;
+export declare function registerFileTranslationsAlignmentExport({ config, app }: {
+    config: Config;
+    app: Express;
+}): void;

package/out/modules/file-processing/index.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerFilePostExport = exports.registerFilePreExport = exports.registerFilePostImport = exports.registerFilePreImport = exports.registerCustomFileFormat = void 0;
+exports.registerFileTranslationsAlignmentExport = exports.registerFilePostExport = exports.registerFilePreExport = exports.registerFilePostImport = exports.registerFilePreImport = exports.registerCustomFileFormat = void 0;
 const crowdin_client_1 = __importDefault(require("../../middlewares/crowdin-client"));
 const custom_file_format_1 = __importDefault(require("./handlers/custom-file-format"));
 const file_download_1 = __importDefault(require("./handlers/file-download"));
 const pre_post_process_1 = __importDefault(require("./handlers/pre-post-process"));
+const translations_alignment_1 = __importDefault(require("./handlers/translations-alignment"));
 const types_1 = require("./types");
 const defaults_1 = require("./util/defaults");
 function registerCustomFileFormat({ config, app }) {
@@ -87,3 +88,17 @@ function registerFilePostExport({ config, app }) {
     app.get(`/file/download/${types_1.ProcessFileJobType.POST_EXPORT}`, (0, file_download_1.default)(config, config.filePostExport, types_1.ProcessFileJobType.POST_EXPORT));
 }
 exports.registerFilePostExport = registerFilePostExport;
+function registerFileTranslationsAlignmentExport({ config, app }) {
+    if (!config.fileTranslationsAlignmentExport) {
+        return;
+    }
+    (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.fileTranslationsAlignmentExport);
+    app.post('/translations-alignment', (0, crowdin_client_1.default)({
+        config,
+        optional: false,
+        checkSubscriptionExpiration: true,
+        moduleKey: config.fileTranslationsAlignmentExport.key,
+    }), (0, translations_alignment_1.default)(config, config.fileTranslationsAlignmentExport, types_1.ProcessFileJobType.TRANSLATIONS_ALIGNMENT));
+    app.get(`/file/download/${types_1.ProcessFileJobType.POST_EXPORT}`, (0, file_download_1.default)(config, config.fileTranslationsAlignmentExport, types_1.ProcessFileJobType.TRANSLATIONS_ALIGNMENT));
+}
+exports.registerFileTranslationsAlignmentExport = registerFileTranslationsAlignmentExport;

package/out/modules/file-processing/types.d.ts

@@ -60,9 +60,17 @@ export interface CustomFileFormatLogic extends FileProcessLogic {
 }
 export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
 export type FileImportExportContent = ProcessFileString[] | Buffer | undefined;
+export type TranslationAlignmentContent = TranslationAlignmentString[] | Buffer | undefined;
+export interface FileTranslationAlignmentContent {
+    sourceStrings: TranslationAlignmentContent;
+    translations: TranslationAlignmentContent;
+}
 export interface BaseFileProcessLogic<T> {
     fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<T>;
 }
+export interface TranslationAlignmentProcessLogin<T> {
+    fileProcess: (req: ProcessTranslationAlignmentRequest, content: FileTranslationAlignmentContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<T>;
+}
 export interface FilePreImportLogic extends FileProcessLogic, BaseFileProcessLogic<ContentFileResponse> {
     /**
      * Set to `true` to enable asset processing in the application.
@@ -79,6 +87,19 @@ export interface FilePostExportLogic extends FileProcessLogic, BaseFileProcessLo
      */
     processAssets?: boolean;
 }
+export interface TranslationsAlignmentLogic extends FileProcessLogic, TranslationAlignmentProcessLogin<TranslationAlignmentResponse> {
+}
+export interface ProcessTranslationAlignmentRequest {
+    jobType: ProcessFileJobType;
+    file: ProcessFileRecord;
+    sourceLanguage: LanguagesModel.Language;
+    targetLanguages: LanguagesModel.Language[];
+    sourceStrings: TranslationAlignmentString[];
+    sourceStringsUrl: string;
+    translationStrings: TranslationAlignmentString[];
+    translationStringsUrl: string;
+    getRawContent?: (encoding: BufferEncoding) => Promise<string | Buffer>;
+}
 export interface ProcessFileRequest {
     jobType: ProcessFileJobType;
     file: ProcessFileRecord;
@@ -102,7 +123,8 @@ export declare enum ProcessFileJobType {
     PRE_IMPORT = "pre-import-file",
     POST_IMPORT = "post-import-file",
     PRE_EXPORT = "pre-export-file",
-    POST_EXPORT = "post-export-file"
+    POST_EXPORT = "post-export-file",
+    TRANSLATIONS_ALIGNMENT = "translations-alignment-file"
 }
 export interface ParseFileResponse {
     previewFile?: Buffer;
@@ -121,6 +143,14 @@ export interface StringsFileResponse extends ParseFileResponse {
 export interface ContentFileResponse extends BuildFileResponse {
     notModified?: boolean;
 }
+export interface TranslationAlignmentResponse {
+    strings?: TranslationAlignmentResult[];
+    error?: string;
+}
+export interface TranslationAlignmentResult {
+    sourceStringId: number;
+    text: string | SourceStringsModel.PluralText;
+}
 export interface ProcessFileString {
     previewId?: number;
     id: number;
@@ -135,6 +165,11 @@ export interface ProcessFileString {
     translations?: StringTranslations;
     uniqId?: string;
 }
+export interface TranslationAlignmentString {
+    id: number | null;
+    text: string | SourceStringsModel.PluralText;
+    context: string;
+}
 export interface StringTranslations {
     [language: string]: {
         text: string | SourceStringsModel.PluralText;

package/out/modules/file-processing/types.js

@@ -9,4 +9,5 @@ var ProcessFileJobType;
     ProcessFileJobType["POST_IMPORT"] = "post-import-file";
     ProcessFileJobType["PRE_EXPORT"] = "pre-export-file";
     ProcessFileJobType["POST_EXPORT"] = "post-export-file";
+    ProcessFileJobType["TRANSLATIONS_ALIGNMENT"] = "translations-alignment-file";
 })(ProcessFileJobType = exports.ProcessFileJobType || (exports.ProcessFileJobType = {}));

package/out/modules/manifest.js

@@ -86,6 +86,17 @@ function handle(config) {
             },
         ];
     }
+    if (config.fileTranslationsAlignmentExport) {
+        // prevent possible overrides of the other modules
+        config.fileTranslationsAlignmentExport = Object.assign(Object.assign({}, config.fileTranslationsAlignmentExport), { key: config.identifier + '-ftae' });
+        modules['file-translations-alignment'] = [
+            {
+                key: config.fileTranslationsAlignmentExport.key,
+                signaturePatterns: config.fileTranslationsAlignmentExport.signaturePatterns,
+                url: '/translations-alignment',
+            },
+        ];
+    }
     if (config.customMT) {
         // prevent possible overrides of the other modules
         config.customMT = Object.assign(Object.assign({}, config.customMT), { key: config.identifier + '-mt' });

package/out/types.d.ts

@@ -5,7 +5,7 @@ import { ContextContent } from './modules/context-menu/types';
 import { CustomMTLogic } from './modules/custom-mt/types';
 import { CustomSpellcheckerModule } from './modules/custom-spell-check/types';
 import { EditorPanels } from './modules/editor-right-panel/types';
-import { CustomFileFormatLogic, FilePostExportLogic, FilePostImportLogic, FilePreExportLogic, FilePreImportLogic } from './modules/file-processing/types';
+import { CustomFileFormatLogic, FilePostExportLogic, FilePostImportLogic, FilePreExportLogic, FilePreImportLogic, TranslationsAlignmentLogic } from './modules/file-processing/types';
 import { IntegrationLogic } from './modules/integration/types';
 import { Storage } from './storage';
 import { MySQLStorageConfig } from './storage/mysql';
@@ -203,6 +203,7 @@ export interface ClientConfig extends ImagePath {
     filePostImport?: FilePostImportLogic;
     filePreExport?: FilePreExportLogic;
     filePostExport?: FilePostExportLogic;
+    fileTranslationsAlignmentExport?: TranslationsAlignmentLogic;
     /**
      * Disable formatting logs
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.99.0",
+  "version": "0.100.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -13,7 +13,8 @@
     "prettier": "prettier --config .prettierrc src/**/*.ts --write",
     "lint-ci": "eslint \"{src,tests}/**/*.{js,ts}\"",
     "test-coverage": "jest --ci --reporters=jest-junit --reporters=default --coverage --coverageReporters=cobertura --coverageReporters=html",
-    "test": "jest"
+    "test": "jest",
+    "postinstall": "patch-package"
   },
   "files": [
     "out/**/*"
@@ -89,7 +90,8 @@
     "rollup": "^3.29.4",
     "rollup-plugin-delete": "^2.1.0",
     "ts-jest": "^29.2.5",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "patch-package": "^8.0.0"
   },
   "repository": {
     "type": "git",