@crowdin/app-project-module 0.26.6 → 0.27.0

package/README.md

@@ -129,6 +129,28 @@ const configuration = {
                 stopPagination: true, //send if no next files page
             };
         },
+        getFileProgress: async (projectId, client, fileId) => { //Use this function if you require a customized translation progress.
+            return {
+                [fileId]: [
+                    {
+                        languageId: 'uk',
+                        eTag: '49a76a1632973b00175dac942976f7c6',
+                        words: {
+                            total: 180,
+                            translated: 0,
+                            approved: 0
+                        },
+                        phrases: {
+                            total: 6,
+                            translated: 0,
+                            approved: 0
+                        },
+                        translationProgress: 100,
+                        approvalProgress: 0
+                    }
+                ]
+            }
+        },
         updateCrowdin: async (projectId, client, credentials, request, rootFolder, appSettings) => {
             //here you need to get data from integration and upload it to Crowdin
             console.log(`Request for updating data in Crowdin ${JSON.stringify(request)}`);

package/out/handlers/crowdin-file-progress.d.ts

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

@@ -10,13 +10,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const fileId = Number(req.params.fileId);
         (0, util_1.log)(`Loading translation progress for file ${fileId}`, config.logger);
-        const progress = yield req.crowdinApiClient.translationStatusApi.getFileProgress(req.crowdinContext.jwtPayload.context.project_id, fileId);
-        (0, util_1.log)(`Translation progress for file ${fileId} ${JSON.stringify(progress.data, null, 2)}`, config.logger);
-        res.send({ [fileId]: progress.data.map((e) => e.data) });
+        if (integration.getFileProgress) {
+            const progress = yield integration.getFileProgress(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, fileId);
+            (0, util_1.log)(`Translation progress for file ${fileId} ${JSON.stringify(progress, null, 2)}`, config.logger);
+            res.send(progress);
+        }
+        else {
+            res.send({});
+        }
     }), config.onError);
 }
 exports.default = handle;

package/out/index.js

@@ -115,7 +115,7 @@ function addCrowdinEndpoints(app, plainConfig) {
         app.post('/api/logout', (0, crowdin_client_1.default)(config, false, false), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_logout_1.default)(config, integrationLogic));
         app.get('/api/crowdin/files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, crowdin_files_1.default)(config, integrationLogic));
         app.get('/api/crowdin/project', json_response_1.default, (0, crowdin_client_1.default)(config), (0, crowdin_project_1.default)(config));
-        app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)(config));
+        app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)(config, integrationLogic));
         app.get('/api/integration/data', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_data_1.default)(config, integrationLogic));
         app.post('/api/crowdin/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, crowdin_update_1.default)(config, integrationLogic));
         app.post('/api/integration/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_update_1.default)(config, integrationLogic));

package/out/models/index.d.ts

@@ -1,4 +1,4 @@
-import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel } from '@crowdin/crowdin-api-client';
+import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel, TranslationStatusModel } from '@crowdin/crowdin-api-client';
 import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
 import { MySQLStorageConfig } from '../storage/mysql';
@@ -235,6 +235,12 @@ export interface IntegrationLogic {
      * Enable integration next page event
      */
     integrationPagination?: boolean;
+    /**
+     * function to get crowdin file translation progress
+     */
+    getFileProgress?: (projectId: number, client: Crowdin, fileId: number) => Promise<{
+        [key: number]: TranslationStatusModel.LanguageProgress[];
+    }>;
 }
 export declare type FormEntity = FormField | FormDelimeter;
 export interface FormDelimeter {

package/out/util/defaults.js

@@ -118,6 +118,12 @@ function applyDefaults(config, integration) {
             return res;
         });
     }
+    if (!integration.getFileProgress) {
+        integration.getFileProgress = (projectId, client, fileId) => __awaiter(this, void 0, void 0, function* () {
+            const progress = yield client.translationStatusApi.getFileProgress(projectId, fileId);
+            return { [fileId]: progress.data.map((e) => e.data) };
+        });
+    }
     if (!integration.loginForm) {
         integration.loginForm = {
             fields: [

package/package.json

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