@crowdin/app-project-module 0.18.1 → 0.19.0

package/README.md

@@ -87,7 +87,9 @@ const configuration = {
             crowdin: true,
             integration: true,
         },
-        getIntegrationFiles: async (credentials, appSettings) => {
+        integrationOneLevelFetching: true, //turn on request when opening a directory and pass its id
+        integrationSearchListener: true, //turn on search listener and pass search string
+        getIntegrationFiles: async (credentials, appSettings, parentId, search) => {
             //here you need to fetch files/objects from integration
             return [
                 {
@@ -573,6 +575,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/handlers/integration-data.js

@@ -12,8 +12,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
 function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const { parent_id: parentId, search } = req.query;
         (0, util_1.log)('Recieved request to get integration data', config.logger);
-        const files = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings);
+        const files = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings, parentId, search);
         (0, util_1.log)(`Integration data response ${JSON.stringify(files, null, 2)}`, config.logger);
         res.send(files);
     }), config.onError);

package/out/handlers/main.js

@@ -56,6 +56,8 @@ function handle(config, integration) {
         options.infoModal = integration.infoModal;
         options.withCronSync = integration.withCronSync;
         options.withWebhookSync = integration.withWebhookSync;
+        options.integrationOneLevelFetching = integration.integrationOneLevelFetching;
+        options.integrationSearchListener = integration.integrationSearchListener;
         options.checkSubscription = !(0, connection_1.isAppFree)(config);
         (0, util_1.log)(`Routing user to ${view} view`, config.logger);
         return res.render(view, options);

package/out/models/index.d.ts

@@ -152,7 +152,7 @@ export interface IntegrationLogic {
     /**
      * function to get data from integration
      */
-    getIntegrationFiles: (apiCredentials: any, config?: any) => Promise<TreeItem[]>;
+    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any) => Promise<TreeItem[]>;
     /**
      * function to update crowdin files (e.g. pull integration data to crowdin source files)
      */
@@ -188,6 +188,14 @@ export interface IntegrationLogic {
         crowdin: boolean;
         integration: boolean;
     };
+    /**
+     * Enable integration folder open event
+     */
+    integrationOneLevelFetching?: boolean;
+    /**
+     * Enable integration search event
+     */
+    integrationSearchListener?: boolean;
 }
 export declare type ConfigurationModalEntity = ConfigurationField | ConfigurationDelimeter;
 export interface ConfigurationField {
@@ -433,6 +441,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/out/views/main.handlebars

@@ -34,6 +34,12 @@
                 {{#if withCronSync.integration}}
                     integration-schedule="true"
                 {{/if}}
+                {{#if integrationOneLevelFetching}}
+                    integration-one-level-fetching="true"
+                {{/if}}
+                {{#if integrationSearchListener}}
+                    allow-filter-change-listener="true"
+                {{/if}}
                 integration-name="{{name}}"
                 integration-logo="logo.png"
         >
@@ -136,10 +142,19 @@
         if (event.detail.componentId === 'crowdin-files' && event.detail.isOpen && event.detail.type === '1') {
             getFileProgress(event.detail.id);
         }
+        {{#if integrationOneLevelFetching}}
+            if (event.detail.componentId === 'integration-files' && event.detail.isOpen) {
+                getIntegrationData(event.detail.id);
+            }
+        {{/if}}
     });
     document.body.addEventListener('uploadFilesToCrowdin', uploadFilesToCrowdin);
     document.body.addEventListener('uploadFilesToIntegration', uploadFilesToIntegration);
-
+    {{#if integrationSearchListener}}
+        document.body.addEventListener("integrationFilterChange", (event) => {
+            getIntegrationData(0, event.detail);
+        })
+    {{/if}}
     const appComponent = document.querySelector('crowdin-simple-integration');
     const subscriptionModal = document.getElementById('subscription-modal');
 
@@ -197,10 +212,10 @@
             .finally(() => (appComponent.setAttribute('is-crowdin-loading', false)));
     }
 
-    function getIntegrationData() {
+    function getIntegrationData(parentId = null, search = '') {
         appComponent.setAttribute('is-integration-loading', true);
         checkOrigin()
-            .then(restParams => fetch('api/integration/data' + restParams))
+            .then(restParams => fetch(`api/integration/data${restParams}&parent_id=${parentId}&search=${search}`))
             .then(checkResponse)
             .then((res) => {
                 const tree = res.map(e => {
@@ -217,7 +232,11 @@
                     }
                     return item;
                 });
-                appComponent.setIntegrationFilesData(tree);
+                appComponent.pushIntegrationFilesData(tree);
+                if (search) {
+                    const openIds = res.filter(e => !e.type).map(e => e.id);
+                    appComponent.setIntegrationOpenedFolders(openIds);
+                }
             })
             {{#if withCronSync}}
                 .then(() => getSyncSettings('integration'))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "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",