@crowdin/app-project-module 0.16.3 → 0.16.4

package/README.md

@@ -173,9 +173,6 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
-
-
-
 ## Payment
 
 By default App does not have any subscription and it's free to use. But you can override this.
@@ -540,14 +537,10 @@ const configuration = {
         extensions: [
             '.resx'
         ],
-        parseFile: async (file, req, client, context, projectId) => {
-            //parse logic
-            return { strings: [] };
-        },
-        buildFile: async (file, req, strings, client, context, projectId) => {
-            const isStringsExport = !!req.file.path;
+        exportStrings: async (req, strings, client, context, projectId) => {
+            const file = req.file;
             //export logic
-            return { contentFile: {} }
+            return { contentFile: '' }
         }
     }
 };

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

@@ -29,7 +29,7 @@ function storeFile(fileContent, folder) {
         }
     }));
 }
-function handleBuildFile(baseUrl, dataFolder, config, file, req, client, context, projectId) {
+function handleBuildFile(baseUrl, dataFolder, config, req, client, context, projectId, file) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = {};
         if (!req.strings && !req.stringsUrl) {
@@ -42,7 +42,16 @@ function handleBuildFile(baseUrl, dataFolder, config, file, req, client, context
         else {
             strings = (yield axios_1.default.get(req.stringsUrl)).data;
         }
-        const res = yield config.buildFile(file, req, strings, client, context, projectId);
+        let res;
+        if ((req.file.id || !file) && config.exportStrings) {
+            res = yield config.exportStrings(req, strings, client, context, projectId);
+        }
+        else if (file && config.buildFile) {
+            res = yield config.buildFile(file, req, strings, client, context, projectId);
+        }
+        else {
+            return response;
+        }
         const contentFileEncoded = Buffer.from(res.contentFile).toString('base64');
         if (Buffer.byteLength(contentFileEncoded, 'utf8') < MAX_BODY_SIZE) {
             response.content = contentFileEncoded;
@@ -54,9 +63,12 @@ function handleBuildFile(baseUrl, dataFolder, config, file, req, client, context
         return response;
     });
 }
-function handleParseFile(baseUrl, dataFolder, config, file, req, client, context, projectId) {
+function handleParseFile(baseUrl, dataFolder, config, req, client, context, projectId, file) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = {};
+        if (!config.parseFile || !file) {
+            return response;
+        }
         const res = yield config.parseFile(file, req, client, context, projectId);
         if (res.previewFile) {
             const previewFileEncoded = Buffer.from(res.previewFile).toString('base64');
@@ -103,16 +115,16 @@ function handle(baseConfig, baseUrl, folder, config) {
         if (body.file.content) {
             file = Buffer.from(body.file.content, 'base64').toString();
         }
-        else {
-            file = (yield axios_1.default.get(body.file.contentUrl || '')).data;
+        else if (body.file.contentUrl) {
+            file = (yield axios_1.default.get(body.file.contentUrl)).data;
         }
         let response = {};
         switch (body.jobType) {
             case models_1.ProcessFileJobType.BUILD_FILE:
-                response = yield handleBuildFile(baseFilesUrl, folder, config, file, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
+                response = yield handleBuildFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
                 break;
             case models_1.ProcessFileJobType.PARSE_FILE:
-                response = yield handleParseFile(baseFilesUrl, folder, config, file, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
+                response = yield handleParseFile(baseFilesUrl, folder, config, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id, file);
                 break;
         }
         (0, util_1.log)(`Returning response from process file action ${JSON.stringify(response, null, 2)}`, baseConfig.logger);

package/out/handlers/manifest.js

@@ -15,28 +15,17 @@ function handle(config) {
         ];
     }
     if (config.customFileFormat) {
-        if (config.customFileFormat.stringsExport) {
-            modules['custom-file-format'] = [
-                {
-                    key: config.identifier + '-ff',
-                    type: config.customFileFormat.type,
-                    stringsExport: true,
-                    extensions: config.customFileFormat.extensions,
-                    url: '/process',
-                },
-            ];
-        }
-        else {
-            modules['custom-file-format'] = [
-                {
-                    key: config.identifier + '-ff',
-                    type: config.customFileFormat.type,
-                    multilingual: !!config.customFileFormat.multilingual,
-                    signaturePatterns: config.customFileFormat.signaturePatterns,
-                    url: '/process',
-                },
-            ];
-        }
+        modules['custom-file-format'] = [
+            {
+                key: config.identifier + '-ff',
+                type: config.customFileFormat.type,
+                stringsExport: !!config.customFileFormat.stringsExport,
+                multilingual: !!config.customFileFormat.multilingual,
+                extensions: config.customFileFormat.extensions,
+                signaturePatterns: config.customFileFormat.signaturePatterns,
+                url: '/process',
+            },
+        ];
     }
     if (config.customMT) {
         modules['custom-mt'] = [

package/out/models/index.d.ts

@@ -401,11 +401,15 @@ export interface CustomFileFormatLogic {
     /**
      * Used for initial source file upload, source file update, and translation upload
      */
-    parseFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    parseFile?: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
     /**
      * Used for translation download
      */
-    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    buildFile?: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    /**
+     * Used for strings export
+     */
+    exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -423,6 +427,8 @@ export interface ProcessFileRecord {
     content?: string;
     contentUrl?: string;
     path?: string;
+    id?: number;
+    name?: string;
 }
 export declare enum ProcessFileJobType {
     PARSE_FILE = "parse-file",

package/package.json

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