@crowdin/app-project-module 0.16.2 → 0.16.3

package/README.md

@@ -519,6 +519,42 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
+Also custom file format module can support strings export.
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+const convert = require('xml-js');
+
+const configuration = {
+    baseUrl: 'https://123.ngrok.io',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    name: 'Sample App',
+    identifier: 'sample-app',
+    description: 'Sample App description',
+    dbFolder: __dirname,
+    imagePath: __dirname + '/' + 'logo.png',
+    customFileFormat: {
+        type: 'type-xyz',
+        stringsExport: true,
+        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;
+            //export logic
+            return { contentFile: {} }
+        }
+    }
+};
+
+crowdinModule.createApp(configuration);
+```
+
 ### Custom MT
 
 Example of [custom mt module](https://support.crowdin.com/crowdin-apps-modules/#custom-mt-machine-translation-module).

package/out/handlers/manifest.js

@@ -15,14 +15,28 @@ function handle(config) {
         ];
     }
     if (config.customFileFormat) {
-        modules['custom-file-format'] = [
-            {
-                key: config.identifier + '-ff',
-                type: config.customFileFormat.type,
-                signaturePatterns: config.customFileFormat.signaturePatterns,
-                url: '/process',
-            },
-        ];
+        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',
+                },
+            ];
+        }
     }
     if (config.customMT) {
         modules['custom-mt'] = [

package/out/models/index.d.ts

@@ -390,6 +390,14 @@ export interface CustomFileFormatLogic {
      * Flag to automatically upload translations
      */
     autoUploadTranslations?: boolean;
+    /**
+     * Enable strings export
+     */
+    stringsExport?: boolean;
+    /**
+     * File extensions (used for strings export)
+     */
+    extensions?: string[];
     /**
      * Used for initial source file upload, source file update, and translation upload
      */
@@ -397,7 +405,7 @@ export interface CustomFileFormatLogic {
     /**
      * Used for translation download
      */
-    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -414,6 +422,7 @@ export interface ProcessFileRequest {
 export interface ProcessFileRecord {
     content?: string;
     contentUrl?: string;
+    path?: string;
 }
 export declare enum ProcessFileJobType {
     PARSE_FILE = "parse-file",

package/package.json

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