@crowdin/app-project-module 2.4.0 → 2.5.1

package/out/modules/ai-request-processors/types.d.ts

@@ -2,14 +2,14 @@ import { CrowdinContextInfo, ModuleKey } from '../../types';
 import Crowdin from '@crowdin/crowdin-api-client';
 export interface AiRequestProcessorModule extends ModuleKey {
     /**
-     * updates request data
+     * updates request data; the returned value is sent back as the processed request
      */
     processRequest: (options: {
         requestData: any;
         requestContext: any;
         client: Crowdin;
         context: CrowdinContextInfo;
-    }) => Promise<never>;
+    }) => Promise<any>;
 }
 export interface AiStreamProcessorModule extends AiRequestProcessorModule {
     /**

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

@@ -1,5 +1,11 @@
 import { CrowdinContextInfo, Environments, ModuleKey, UiModule } from '../../types';
 import Crowdin, { SourceFilesModel, ProjectsGroupsModel, LanguagesModel, SourceStringsModel, StringTranslationsModel } from '@crowdin/crowdin-api-client';
+export interface QaCheckTranslation extends StringTranslationsModel.StringTranslation {
+    /**
+     * id of the source string this translation belongs to
+     */
+    stringId: number;
+}
 export interface ExternalQaCheckModule extends Environments, ModuleKey {
     /**
      * module description
@@ -20,7 +26,7 @@ export interface ExternalQaCheckModule extends Environments, ModuleKey {
         sourceLanguage: LanguagesModel.Language;
         strings: SourceStringsModel.String[];
         targetLanguage: LanguagesModel.Language;
-        translations: StringTranslationsModel.StringTranslation[];
+        translations: QaCheckTranslation[];
         context: CrowdinContextInfo;
     }) => Promise<ExternalQaCheckResponse>;
     /**
@@ -34,7 +40,7 @@ export interface ExternalQaCheckRequest {
     sourceLanguage: LanguagesModel.Language;
     strings: SourceStringsModel.String[];
     targetLanguage: LanguagesModel.Language;
-    translations: StringTranslationsModel.StringTranslation[];
+    translations: QaCheckTranslation[];
 }
 interface SuggestedFix {
     indexStart: number;

package/out/modules/file-processing/handlers/custom-file-format.d.ts

@@ -1,9 +1,10 @@
 import { Response } from 'express';
 import { CrowdinClientRequest, FileStore } from '../../../types';
 import { CustomFileFormatLogic } from '../types';
-export default function handle({ baseUrl, folder, config, fileStore, }: {
+export default function handle({ baseUrl, folder, config, fileStore, clientSecret, }: {
     baseUrl: string;
     folder: string;
     config: CustomFileFormatLogic;
     fileStore?: FileStore;
+    clientSecret: string;
 }): (req: import("express").Request | CrowdinClientRequest, res: Response, next: Function) => void;

package/out/modules/file-processing/handlers/custom-file-format.js

@@ -17,8 +17,9 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const util_1 = require("../../../util");
 const files_1 = require("../util/files");
+const signed_url_1 = require("../util/signed-url");
 const types_1 = require("../types");
-function handle({ baseUrl, folder, config, fileStore, }) {
+function handle({ baseUrl, folder, config, fileStore, clientSecret, }) {
     if (!fileStore) {
         if (!fs_1.default.existsSync(path_1.default.join(folder, 'custom-file-format'))) {
             fs_1.default.mkdirSync(path_1.default.join(folder, 'custom-file-format'), { recursive: true });
@@ -56,6 +57,7 @@ function handle({ baseUrl, folder, config, fileStore, }) {
                     projectId: req.crowdinContext.jwtPayload.context.project_id,
                     file,
                     fileStore,
+                    clientSecret,
                 });
                 response = buildFileResult.response;
                 error = buildFileResult.error;
@@ -71,6 +73,7 @@ function handle({ baseUrl, folder, config, fileStore, }) {
                     projectId: req.crowdinContext.jwtPayload.context.project_id,
                     file,
                     fileStore,
+                    clientSecret,
                 });
                 response = parseFileResult.response;
                 error = parseFileResult.error;
@@ -82,7 +85,7 @@ function handle({ baseUrl, folder, config, fileStore, }) {
     }));
 }
 function handleBuildFile(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ baseUrl, dataFolder, config, req, client, context, projectId, file, fileStore, }) {
+    return __awaiter(this, arguments, void 0, function* ({ baseUrl, dataFolder, config, req, client, context, projectId, file, fileStore, clientSecret, }) {
         const response = {};
         if (!req.strings && !req.stringsUrl) {
             throw new Error('Bad payload received: No strings found');
@@ -112,7 +115,7 @@ function handleBuildFile(_a) {
             let url;
             if (fileStore) {
                 const fileRef = yield fileStore.storeFile(res.contentFile);
-                url = `${baseUrl}?file=${fileRef}`;
+                url = (0, signed_url_1.signDownloadUrl)(baseUrl, fileRef, clientSecret);
             }
             else {
                 if (config.storeFile) {
@@ -120,7 +123,7 @@ function handleBuildFile(_a) {
                 }
                 else {
                     const storedFile = yield (0, files_1.storeFile)(res.contentFile, path_1.default.join(dataFolder, 'custom-file-format'));
-                    url = `${baseUrl}?file=${storedFile}`;
+                    url = (0, signed_url_1.signDownloadUrl)(baseUrl, storedFile, clientSecret);
                 }
             }
             response.contentUrl = url;
@@ -129,7 +132,7 @@ function handleBuildFile(_a) {
     });
 }
 function handleParseFile(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ baseUrl, dataFolder, config, req, client, context, projectId, file, fileStore, }) {
+    return __awaiter(this, arguments, void 0, function* ({ baseUrl, dataFolder, config, req, client, context, projectId, file, fileStore, clientSecret, }) {
         const response = {};
         if (!config.parseFile || !file) {
             return { response };
@@ -147,7 +150,7 @@ function handleParseFile(_a) {
                 let url;
                 if (fileStore) {
                     const fileRef = yield fileStore.storeFile(res.previewFile);
-                    url = `${baseUrl}?file=${fileRef}`;
+                    url = (0, signed_url_1.signDownloadUrl)(baseUrl, fileRef, clientSecret);
                 }
                 else {
                     if (config.storeFile) {
@@ -155,7 +158,7 @@ function handleParseFile(_a) {
                     }
                     else {
                         const storedFile = yield (0, files_1.storeFile)(res.previewFile, path_1.default.join(dataFolder, 'custom-file-format'));
-                        url = `${baseUrl}?file=${storedFile}`;
+                        url = (0, signed_url_1.signDownloadUrl)(baseUrl, storedFile, clientSecret);
                     }
                 }
                 response.previewUrl = url;
@@ -181,7 +184,7 @@ function handleParseFile(_a) {
                 let url;
                 if (fileStore) {
                     const fileRef = yield fileStore.storeFile(bufferData);
-                    url = `${baseUrl}?file=${fileRef}`;
+                    url = (0, signed_url_1.signDownloadUrl)(baseUrl, fileRef, clientSecret);
                 }
                 else {
                     if (config.storeFile) {
@@ -189,7 +192,7 @@ function handleParseFile(_a) {
                     }
                     else {
                         const storedFile = yield (0, files_1.storeFile)(bufferData, path_1.default.join(dataFolder, 'custom-file-format'));
-                        url = `${baseUrl}?file=${storedFile}`;
+                        url = (0, signed_url_1.signDownloadUrl)(baseUrl, storedFile, clientSecret);
                     }
                 }
                 response.stringsUrl = url;

package/out/modules/file-processing/handlers/file-download.js

@@ -18,15 +18,23 @@ const path_1 = __importDefault(require("path"));
 const util_1 = require("../../../util");
 const logger_1 = require("../../../util/logger");
 const folder_1 = require("../util/folder");
+const signed_url_1 = require("../util/signed-url");
 function handle(config, processingConfig, folderName) {
     const folder = (0, folder_1.resolveModuleFilesFolder)(config.dbFolder, processingConfig.filesFolder);
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const fileRef = req.query.file;
+        const expires = req.query.expires;
+        const sig = req.query.sig;
+        if (!fileRef || !expires || !sig || !(0, signed_url_1.verifySignedDownloadUrl)(fileRef, expires, sig, config.clientSecret)) {
+            res.sendStatus(403);
+            return;
+        }
         if (config.fileStore) {
-            const fileContent = yield config.fileStore.getFile(req.query.file);
+            const fileContent = yield config.fileStore.getFile(fileRef);
             res.send(fileContent);
             return;
         }
-        const filePath = path_1.default.join(folder, folderName, req.query.file);
+        const filePath = path_1.default.join(folder, folderName, path_1.default.basename(fileRef));
         (0, logger_1.log)(`Downloading file ${filePath}`);
         res.download(filePath, function (err) {
             if (err) {

package/out/modules/file-processing/handlers/pre-post-process.js

@@ -19,6 +19,7 @@ const util_1 = require("../../../util");
 const types_1 = require("../types");
 const folder_1 = require("../util/folder");
 const files_1 = require("../util/files");
+const signed_url_1 = require("../util/signed-url");
 function handle(baseConfig, config, folderName) {
     const folderPath = (0, folder_1.resolveModuleFilesFolder)(baseConfig.dbFolder, config.filesFolder);
     if (!baseConfig.fileStore) {
@@ -84,7 +85,7 @@ function handle(baseConfig, config, folderName) {
                         let url;
                         if (baseConfig.fileStore) {
                             const fileRef = yield baseConfig.fileStore.storeFile(contentFile);
-                            url = `${baseFilesUrl}?file=${fileRef}`;
+                            url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, fileRef, baseConfig.clientSecret);
                         }
                         else {
                             if (config.storeFile) {
@@ -92,7 +93,7 @@ function handle(baseConfig, config, folderName) {
                             }
                             else {
                                 const storedFile = yield (0, files_1.storeFile)(contentFile, path_1.default.join(folderPath, folderName));
-                                url = `${baseFilesUrl}?file=${storedFile}`;
+                                url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, storedFile, baseConfig.clientSecret);
                             }
                         }
                         response.contentUrl = url;
@@ -121,7 +122,7 @@ function handle(baseConfig, config, folderName) {
                         let url;
                         if (baseConfig.fileStore) {
                             const fileRef = yield baseConfig.fileStore.storeFile(previewFile);
-                            url = `${baseFilesUrl}?file=${fileRef}`;
+                            url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, fileRef, baseConfig.clientSecret);
                         }
                         else {
                             if (config.storeFile) {
@@ -129,7 +130,7 @@ function handle(baseConfig, config, folderName) {
                             }
                             else {
                                 const storedFile = yield (0, files_1.storeFile)(previewFile, path_1.default.join(folderPath, folderName));
-                                url = `${baseFilesUrl}?file=${storedFile}`;
+                                url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, storedFile, baseConfig.clientSecret);
                             }
                         }
                         response.previewUrl = url;
@@ -145,7 +146,7 @@ function handle(baseConfig, config, folderName) {
                         let url;
                         if (baseConfig.fileStore) {
                             const fileRef = yield baseConfig.fileStore.storeFile(bufferData);
-                            url = `${baseFilesUrl}?file=${fileRef}`;
+                            url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, fileRef, baseConfig.clientSecret);
                         }
                         else {
                             if (config.storeFile) {
@@ -153,7 +154,7 @@ function handle(baseConfig, config, folderName) {
                             }
                             else {
                                 const storedFile = yield (0, files_1.storeFile)(bufferData, path_1.default.join(folderPath, folderName));
-                                url = `${baseFilesUrl}?file=${storedFile}`;
+                                url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, storedFile, baseConfig.clientSecret);
                             }
                         }
                         response.stringsUrl = url;

package/out/modules/file-processing/handlers/translations-alignment.js

@@ -18,6 +18,7 @@ const path_1 = __importDefault(require("path"));
 const util_1 = require("../../../util");
 const folder_1 = require("../util/folder");
 const files_1 = require("../util/files");
+const signed_url_1 = require("../util/signed-url");
 function handle(baseConfig, config, folderName) {
     const folderPath = (0, folder_1.resolveModuleFilesFolder)(baseConfig.dbFolder, config.filesFolder);
     if (!fs_1.default.existsSync(path_1.default.join(folderPath, folderName))) {
@@ -65,12 +66,16 @@ function handle(baseConfig, config, folderName) {
         }
         else {
             let url;
-            if (config.storeFile) {
+            if (baseConfig.fileStore) {
+                const fileRef = yield baseConfig.fileStore.storeFile(bufferData);
+                url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, fileRef, baseConfig.clientSecret);
+            }
+            else 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}`;
+                url = (0, signed_url_1.signDownloadUrl)(baseFilesUrl, storedFile, baseConfig.clientSecret);
             }
             response.translationsUrl = url;
         }

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

@@ -39,6 +39,7 @@ function registerCustomFileFormat({ config, app }) {
             folder: (0, folder_1.resolveModuleFilesFolder)(config.dbFolder, ff.filesFolder),
             config: ff,
             fileStore: config.fileStore,
+            clientSecret: config.clientSecret,
         }));
         app.get(isSingle ? '/file/download' : `/file/${key}/download`, (0, file_download_1.default)(config, ff, 'custom-file-format'));
     }
@@ -54,6 +55,7 @@ function registerCustomFileFormat({ config, app }) {
             folder: (0, folder_1.resolveModuleFilesFolder)(config.dbFolder, ff.filesFolder),
             config: ff,
             fileStore: config.fileStore,
+            clientSecret: config.clientSecret,
         }));
         // END TEMPORARY CODE
     }

package/out/modules/file-processing/util/files.js

@@ -17,11 +17,12 @@ exports.storeFile = storeFile;
 exports.getFileContent = getFileContent;
 exports.getFileStrings = getFileStrings;
 const axios_1 = __importDefault(require("axios"));
+const crypto_1 = require("crypto");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 exports.MAX_BODY_SIZE = 4.9 * 1024 * 1024; //4.9mb
 function storeFile(fileContent, folder) {
-    const fileName = `file${Date.now()}`;
+    const fileName = (0, crypto_1.randomBytes)(16).toString('hex');
     return new Promise((res, rej) => fs_1.default.writeFile(path_1.default.join(folder, fileName), fileContent, (err) => {
         if (err) {
             rej(err);

package/out/modules/file-processing/util/signed-url.d.ts

@@ -0,0 +1,2 @@
+export declare function signDownloadUrl(baseUrl: string, fileRef: string, secret: string, expiresInMs?: number): string;
+export declare function verifySignedDownloadUrl(fileRef: string, expires: string, sig: string, secret: string): boolean;

package/out/modules/file-processing/util/signed-url.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signDownloadUrl = signDownloadUrl;
+exports.verifySignedDownloadUrl = verifySignedDownloadUrl;
+const crypto_1 = require("crypto");
+const DEFAULT_EXPIRY_MS = 60 * 60 * 1000; // 1 hour
+function signDownloadUrl(baseUrl, fileRef, secret, expiresInMs = DEFAULT_EXPIRY_MS) {
+    const expires = Date.now() + expiresInMs;
+    const sig = computeHmac(fileRef, expires, secret);
+    return `${baseUrl}?file=${encodeURIComponent(fileRef)}&expires=${expires}&sig=${sig}`;
+}
+function verifySignedDownloadUrl(fileRef, expires, sig, secret) {
+    const expiresMs = parseInt(expires, 10);
+    if (isNaN(expiresMs) || Date.now() > expiresMs) {
+        return false;
+    }
+    const expected = computeHmac(fileRef, expiresMs, secret);
+    const expectedBuf = Buffer.from(expected, 'hex');
+    const sigBuf = Buffer.from(sig, 'hex');
+    if (expectedBuf.length !== sigBuf.length) {
+        return false;
+    }
+    return (0, crypto_1.timingSafeEqual)(expectedBuf, sigBuf);
+}
+function computeHmac(fileRef, expires, secret) {
+    return (0, crypto_1.createHmac)('sha256', secret).update(`${fileRef}:${expires}`).digest('hex');
+}

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

@@ -16,6 +16,7 @@ exports.filterFilesFromIntegrationRequest = filterFilesFromIntegrationRequest;
 exports.createOrUpdateSyncSettings = createOrUpdateSyncSettings;
 exports.removeFinishedJobs = removeFinishedJobs;
 const storage_1 = require("../../../storage");
+const util_1 = require("../../../util");
 const token_1 = require("../../../util/app-functions/token");
 const connection_1 = require("../../../util/connection");
 const logger_1 = require("../../../util/logger");
@@ -486,14 +487,25 @@ function getAllNewFiles(_a) {
 function getNewFoldersFile(folders, snapshotFiles) {
     let files = [];
     for (const folder of folders) {
-        const folderFiles = snapshotFiles.filter((file) => Number(file.parentId) === Number(folder.id));
+        const folderFiles = snapshotFiles.filter((file) => isSameFolder(file.parentId, folder.id));
         if (folderFiles.length) {
             files = files.concat(folderFiles);
         }
     }
-    files = files.filter((file) => 'type' in file);
+    files = (0, util_1.uniqBy)(files, 'id').filter((file) => Boolean(file.type));
     return files;
 }
+function isSameFolder(parentId, folderId) {
+    if (parentId === null || parentId === undefined || folderId === null || folderId === undefined) {
+        return false;
+    }
+    const numParentId = Number(parentId);
+    const numFolderId = Number(folderId);
+    if (!Number.isNaN(numParentId) && !Number.isNaN(numFolderId)) {
+        return numParentId === numFolderId;
+    }
+    return String(parentId) === String(folderId) || String(parentId).startsWith(`${folderId}/`);
+}
 function getOnlyTranslatedOrApprovedFiles(_a) {
     return __awaiter(this, arguments, void 0, function* ({ projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated, context, integration, }) {
         const deletedFiles = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -37,6 +37,7 @@
     }
   },
   "scripts": {
+    "sandbox": "vite --config sandbox/vite.config.ts",
     "build": "npm run build-css && npm run build-main && npm run build-ui",
     "build-css": "tailwindcss -i ./ui/styles/tailwind.css -o ./static/css/styles.css --minify",
     "build-main": "tsc -p ./ && cp -R static out && cp logo.png out && npm run copy-migrations",
@@ -121,6 +122,7 @@
     "@types/swagger-jsdoc": "^6.0.4",
     "@typescript-eslint/eslint-plugin": "^8.56.0",
     "@typescript-eslint/parser": "^8.56.0",
+    "@vitejs/plugin-react": "^4.7.0",
     "auto-changelog": "^2.5.0",
     "drizzle-kit": "^0.31.10",
     "eslint": "^10.0.1",
@@ -132,7 +134,8 @@
     "rollup": "^4.59.0",
     "tailwindcss": "^4.3.2",
     "ts-jest": "^29.4.6",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vite": "^6.4.3"
   },
   "repository": {
     "type": "git",