@crowdin/app-project-module 0.23.2 → 0.23.4

package/out/handlers/custom-file-format/process.js

@@ -18,17 +18,48 @@ const path_1 = __importDefault(require("path"));
 const models_1 = require("../../models");
 const util_1 = require("../../util");
 const MAX_BODY_SIZE = 4.9 * 1024 * 1024; //4.9mb
-function storeFile(fileContent, folder) {
-    const fileName = `file${Date.now()}`;
-    return new Promise((res, rej) => fs_1.default.writeFile(path_1.default.join(folder, 'custom-file-format', fileName), fileContent, err => {
-        if (err) {
-            rej(err);
+function handle(baseConfig, baseUrl, folder, config) {
+    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 });
+    }
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const baseFilesUrl = `${baseUrl}/file/download`;
+        const body = req.body;
+        let logData;
+        if (body.strings) {
+            logData = Object.assign({}, body, { strings: body.strings.slice(0, 5) });
         }
         else {
-            res(fileName);
+            logData = body;
         }
-    }));
+        (0, util_1.log)(`Received request to process file ${JSON.stringify(logData, null, 2)}`, baseConfig.logger);
+        let file;
+        if (body.file.content) {
+            file = Buffer.from(body.file.content, 'base64').toString();
+        }
+        else if (body.file.contentUrl) {
+            file = (yield axios_1.default.get(body.file.contentUrl)).data;
+        }
+        let response = {};
+        let error;
+        switch (body.jobType) {
+            case models_1.ProcessFileJobType.BUILD_FILE:
+                const buildFileResult = yield handleBuildFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
+                response = buildFileResult.response;
+                error = buildFileResult.error;
+                break;
+            case models_1.ProcessFileJobType.PARSE_FILE:
+                const parseFileResult = yield handleParseFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
+                response = parseFileResult.response;
+                error = parseFileResult.error;
+                break;
+        }
+        const responseLength = Buffer.byteLength(JSON.stringify(response), 'utf8');
+        (0, util_1.log)(`Returning response (${responseLength} bytes) from process file action`, baseConfig.logger);
+        res.send({ data: response, error: error ? { message: error } : undefined });
+    }), baseConfig.onError);
 }
+exports.default = handle;
 function handleBuildFile(baseUrl, dataFolder, config, req, client, context, projectId, file) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = {};
@@ -131,45 +162,14 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
         return { response, error: res.error };
     });
 }
-function handle(baseConfig, baseUrl, folder, config) {
-    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 });
-    }
-    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        const baseFilesUrl = `${baseUrl}/file/download`;
-        const body = req.body;
-        let logData;
-        if (body.strings) {
-            logData = Object.assign({}, body, { strings: body.strings.slice(0, 5) });
+function storeFile(fileContent, folder) {
+    const fileName = `file${Date.now()}`;
+    return new Promise((res, rej) => fs_1.default.writeFile(path_1.default.join(folder, 'custom-file-format', fileName), fileContent, err => {
+        if (err) {
+            rej(err);
         }
         else {
-            logData = body;
-        }
-        (0, util_1.log)(`Received request to process file ${JSON.stringify(logData, null, 2)}`, baseConfig.logger);
-        let file;
-        if (body.file.content) {
-            file = Buffer.from(body.file.content, 'base64').toString();
-        }
-        else if (body.file.contentUrl) {
-            file = (yield axios_1.default.get(body.file.contentUrl)).data;
-        }
-        let response = {};
-        let error;
-        switch (body.jobType) {
-            case models_1.ProcessFileJobType.BUILD_FILE:
-                const buildFileResult = yield handleBuildFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
-                response = buildFileResult.response;
-                error = buildFileResult.error;
-                break;
-            case models_1.ProcessFileJobType.PARSE_FILE:
-                const parseFileResult = yield handleParseFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
-                response = parseFileResult.response;
-                error = parseFileResult.error;
-                break;
+            res(fileName);
         }
-        const responseLength = Buffer.byteLength(JSON.stringify(response), 'utf8');
-        (0, util_1.log)(`Returning response (${responseLength} bytes) from process file action`, baseConfig.logger);
-        res.send({ data: response, error: error ? { message: error } : undefined });
-    }), baseConfig.onError);
+    }));
 }
-exports.default = handle;

package/out/middlewares/crowdin-client.js

@@ -14,17 +14,6 @@ const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
-function getToken(req) {
-    const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
-    if (tokenJwt) {
-        return tokenJwt;
-    }
-    if (req.headers.authorization) {
-        if (req.headers.authorization.startsWith('Bearer ') || req.headers.authorization.startsWith('bearer ')) {
-            return req.headers.authorization.substring(7);
-        }
-    }
-}
 function prepareCrowdinRequest(jwtToken, config, optional = false, checkSubscriptionExpiration = true) {
     return __awaiter(this, void 0, void 0, function* () {
         (0, util_1.log)('Validating jwt token from incoming request', config.logger);
@@ -86,3 +75,14 @@ function handle(config, optional = false, checkSubscriptionExpiration = true) {
     }), config.onError);
 }
 exports.default = handle;
+function getToken(req) {
+    const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
+    if (tokenJwt) {
+        return tokenJwt;
+    }
+    if (req.headers.authorization) {
+        if (req.headers.authorization.startsWith('Bearer ') || req.headers.authorization.startsWith('bearer ')) {
+            return req.headers.authorization.substring(7);
+        }
+    }
+}

package/out/util/cron.js

@@ -34,6 +34,12 @@ const _1 = require(".");
 const storage_1 = require("../storage");
 const connection_1 = require("./connection");
 const defaults_1 = require("./defaults");
+var SyncCondition;
+(function (SyncCondition) {
+    SyncCondition["ALL"] = "0";
+    SyncCondition["TRANSLATED"] = "1";
+    SyncCondition["APPROVED"] = "2";
+})(SyncCondition || (SyncCondition = {}));
 function runJob(config, integration, job) {
     return __awaiter(this, void 0, void 0, function* () {
         (0, _1.log)(`Starting cron job with expression [${job.expression}]`, config.logger);
@@ -70,34 +76,104 @@ function filesCron(config, integration, period) {
             const files = JSON.parse(syncSettings.files);
             const crowdinCredentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(syncSettings.crowdinId);
             const integrationCredentials = yield (0, storage_1.getStorage)().getIntegrationCredentials(syncSettings.integrationId);
-            if (crowdinCredentials && integrationCredentials) {
-                const intConfig = integrationCredentials.config
-                    ? JSON.parse(integrationCredentials.config)
-                    : { schedule: '0' };
-                if (period === intConfig.schedule) {
-                    const projectId = crowdinAppFunctions.getProjectId(integrationCredentials.id);
-                    const { client: crowdinClient, token } = yield (0, connection_1.prepareCrowdinClient)(config, crowdinCredentials);
-                    const { expired } = yield (0, connection_1.checkSubscription)(config, token, crowdinCredentials.id, crowdinCredentials.type);
-                    if (expired) {
-                        (0, _1.log)(`Subscription expired. Skipping job [${period}] for organization ${crowdinCredentials.id}`);
+            if (!crowdinCredentials || !integrationCredentials || !files) {
+                return;
+            }
+            const intConfig = integrationCredentials.config
+                ? JSON.parse(integrationCredentials.config)
+                : { schedule: '0', condition: '0' };
+            if (period !== intConfig.schedule) {
+                return;
+            }
+            const projectId = crowdinAppFunctions.getProjectId(integrationCredentials.id);
+            const { client: crowdinClient, token } = yield (0, connection_1.prepareCrowdinClient)(config, crowdinCredentials);
+            const { expired } = yield (0, connection_1.checkSubscription)(config, token, crowdinCredentials.id, crowdinCredentials.type);
+            if (expired) {
+                (0, _1.log)(`Subscription expired. Skipping job [${period}] for organization ${crowdinCredentials.id}`);
+                return;
+            }
+            const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+            const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
+            if (syncSettings.provider === 'crowdin') {
+                const crowdinFiles = files;
+                const onlyTranslated = intConfig.condition === SyncCondition.TRANSLATED;
+                const onlyApproved = intConfig.condition === SyncCondition.APPROVED;
+                const all = intConfig.condition === SyncCondition.ALL;
+                (0, _1.log)(`Executing updateIntegration task for files cron job with period [${period}] for project ${projectId} and request ${JSON.stringify(files, null, 2)}`, config.logger);
+                if (all) {
+                    yield integration.updateIntegration(projectId, crowdinClient, apiCredentials, crowdinFiles, rootFolder, intConfig);
+                }
+                else {
+                    const filteredFiles = yield getOnlyTranslatedOrApprovedFiles(config, projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated);
+                    if (Object.keys(filteredFiles).length === 0) {
+                        (0, _1.log)(`There is no ${onlyApproved ? 'approved' : 'translated'} file`, config.logger);
                         return;
                     }
-                    const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
-                    const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
-                    if (syncSettings.provider === 'crowdin') {
-                        (0, _1.log)(`Executing updateIntegration task for files cron job with period [${period}] for project ${projectId} and request ${JSON.stringify(files, null, 2)}`, config.logger);
-                        yield integration.updateIntegration(projectId, crowdinClient, apiCredentials, files, rootFolder, intConfig);
-                        (0, _1.log)(`updateIntegration task for files cron job with period [${period}] for project ${projectId} completed`, config.logger);
-                    }
-                    else {
-                        (0, _1.log)(`Executing updateCrowdin task for files cron job with period [${period}] for project ${projectId} and request ${JSON.stringify(files, null, 2)}`, config.logger);
-                        yield integration.updateCrowdin(projectId, crowdinClient, apiCredentials, files, rootFolder, intConfig);
-                        (0, _1.log)(`updateCrowdin task for files cron job with period [${period}] for project ${projectId} completed`, config.logger);
-                    }
+                    yield integration.updateIntegration(projectId, crowdinClient, apiCredentials, filteredFiles, rootFolder, intConfig);
                 }
+                (0, _1.log)(`updateIntegration task for files cron job with period [${period}] for project ${projectId} completed`, config.logger);
+            }
+            else {
+                const intFiles = files;
+                (0, _1.log)(`Executing updateCrowdin task for files cron job with period [${period}] for project ${projectId} and request ${JSON.stringify(files, null, 2)}`, config.logger);
+                yield integration.updateCrowdin(projectId, crowdinClient, apiCredentials, intFiles, rootFolder, intConfig);
+                (0, _1.log)(`updateCrowdin task for files cron job with period [${period}] for project ${projectId} completed`, config.logger);
             }
         })));
         (0, _1.log)(`Files cron job with period [${period}] completed`, config.logger);
     });
 }
 exports.filesCron = filesCron;
+function getOnlyTranslatedOrApprovedFiles(config, projectId, crowdinFiles, crowdinClient, onlyApproved, onlyTranslated) {
+    return __awaiter(this, void 0, void 0, function* () {
+        (0, _1.log)(`Filtering files to process only ${onlyApproved ? 'approved' : 'translated'} files`, config.logger);
+        const filesInfo = yield Promise.all(Object.keys(crowdinFiles).map((fileId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield crowdinClient.translationStatusApi
+                .withFetchAll()
+                .getFileProgress(projectId, Number(fileId));
+            return {
+                id: fileId,
+                info: res.data.map(e => e.data),
+            };
+        })));
+        const filteredFiles = {};
+        Object.keys(crowdinFiles).forEach(fileId => {
+            const fileInfo = filesInfo.find(info => info.id === fileId);
+            if (!fileInfo) {
+                return;
+            }
+            const languages = crowdinFiles[fileId];
+            languages.forEach(language => {
+                const languageInfo = fileInfo.info.find(info => info.languageId === language);
+                if (!languageInfo) {
+                    return;
+                }
+                if (onlyTranslated) {
+                    if (languageInfo.translationProgress === 100) {
+                        (0, _1.log)(`File ${fileId} is fully translated for language ${language}`, config.logger);
+                        if (!filteredFiles[fileId]) {
+                            filteredFiles[fileId] = [];
+                        }
+                        filteredFiles[fileId].push(language);
+                    }
+                    else {
+                        (0, _1.log)(`File ${fileId} is not fully translated for language ${language}, progress ${languageInfo.translationProgress}`, config.logger);
+                    }
+                }
+                if (onlyApproved) {
+                    if (languageInfo.approvalProgress === 100) {
+                        (0, _1.log)(`File ${fileId} is fully approved for language ${language}`, config.logger);
+                        if (!filteredFiles[fileId]) {
+                            filteredFiles[fileId] = [];
+                        }
+                        filteredFiles[fileId].push(language);
+                    }
+                    else {
+                        (0, _1.log)(`File ${fileId} is not fully approved for language ${language}, progress ${languageInfo.approvalProgress}`, config.logger);
+                    }
+                }
+            });
+        });
+        return filteredFiles;
+    });
+}

package/out/util/defaults.js

@@ -141,7 +141,24 @@ function applyDefaults(config, integration) {
                     ],
                 },
                 {
-                    label: "To avoid downloading partially translated files, we recommend enabling the 'Skip untranslated files' option in your Crowdin project.",
+                    key: 'condition',
+                    label: 'Files export settings',
+                    type: 'select',
+                    defaultValue: '0',
+                    options: [
+                        {
+                            value: '0',
+                            label: 'Export all',
+                        },
+                        {
+                            value: '1',
+                            label: 'Export translated only',
+                        },
+                        {
+                            value: '2',
+                            label: 'Export approved only',
+                        },
+                    ],
                 },
                 ...fields,
             ];

package/package.json

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