@crowdin/app-project-module 0.18.1 → 0.18.2

package/README.md

@@ -573,6 +573,15 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
+By default custom file format will use `filesFolder` as a temporary folder to store huge responses. But it can be overridden:
+
+```javascript
+configuration.customFileFormat.storeFile = (content) => {
+    //logic to store file, e.g. put it to AWS S3
+    return '<url-to-download>';
+};
+```
+
 ### Custom MT
 
 Example of [custom mt module](https://support.crowdin.com/crowdin-apps-modules/#custom-mt-machine-translation-module).

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

@@ -57,8 +57,15 @@ function handleBuildFile(baseUrl, dataFolder, config, req, client, context, proj
             response.content = contentFileEncoded;
         }
         else {
-            const storedFile = yield storeFile(res.contentFile, dataFolder);
-            response.contentUrl = `${baseUrl}?file=${storedFile}`;
+            let url;
+            if (config.storeFile) {
+                url = yield config.storeFile(res.contentFile);
+            }
+            else {
+                const storedFile = yield storeFile(res.contentFile, dataFolder);
+                url = `${baseUrl}?file=${storedFile}`;
+            }
+            response.contentUrl = url;
         }
         return { response, error: res.error };
     });
@@ -80,8 +87,15 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                 response.preview = previewFileEncoded;
             }
             else {
-                const storedFile = yield storeFile(res.previewFile, dataFolder);
-                response.previewUrl = `${baseUrl}?file=${storedFile}`;
+                let url;
+                if (config.storeFile) {
+                    url = yield config.storeFile(res.previewFile);
+                }
+                else {
+                    const storedFile = yield storeFile(res.previewFile, dataFolder);
+                    url = `${baseUrl}?file=${storedFile}`;
+                }
+                response.previewUrl = url;
             }
         }
         if (res.strings) {
@@ -100,8 +114,15 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                 response.strings = strings;
             }
             else {
-                const storedFile = yield storeFile(stringsJson, dataFolder);
-                response.stringsUrl = `${baseUrl}?file=${storedFile}`;
+                let url;
+                if (config.storeFile) {
+                    url = yield config.storeFile(stringsJson);
+                }
+                else {
+                    const storedFile = yield storeFile(stringsJson, dataFolder);
+                    url = `${baseUrl}?file=${storedFile}`;
+                }
+                response.stringsUrl = url;
             }
         }
         return { response, error: res.error };

package/out/models/index.d.ts

@@ -433,6 +433,10 @@ export interface CustomFileFormatLogic {
      * Used for strings export
      */
     exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    /**
+     * Override to store huge responses (by default they will be stored in fs)
+     */
+    storeFile?: (content: string) => Promise<string>;
 }
 export interface SignaturePatterns {
     fileName?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.18.1",
+  "version": "0.18.2",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -28,7 +28,6 @@
     "@types/express-handlebars": "^5.3.1",
     "@types/node": "^12.0.10",
     "@types/node-cron": "^3.0.0",
-    "@types/sqlite3": "^3.1.7",
     "@typescript-eslint/eslint-plugin": "^2.3.1",
     "@typescript-eslint/parser": "^2.3.1",
     "eslint": "^6.4.0",