@crowdin/app-project-module 0.22.2 → 0.22.4

package/README.md

@@ -93,7 +93,7 @@ const configuration = {
         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 [
+            const res = [
                 {
                     id: '12',
                     name: 'File from integration',
@@ -122,6 +122,10 @@ const configuration = {
                     nodeType: '2'
                 },
             ];
+            return {
+                data: res,
+                message: 'Test',
+            };
         },
         updateCrowdin: async (projectId, client, credentials, request, rootFolder, appSettings) => {
             //here you need to get data from integration and upload it to Crowdin
@@ -149,6 +153,9 @@ const configuration = {
                 fileContent,
                 files.find((f) => f.name === 'integration.json'),
             );
+            return {
+                message: 'Some message',
+            };
         },
         updateIntegration: async (projectId, client, credentials, request, rootFolder, appSettings) => {
             //here should be logic to get translations from Crowdin and upload them to integration
@@ -443,6 +450,8 @@ configuration.projectIntegration.getConfiguration = (projectId, crowdinClient, i
             key: 'option',
             label: 'Select',
             type: 'select',
+            isSearchable: true, //allow to search for option(s), default is `false`
+            isMulti: true, //allow to select multiple options, default is `false`
             options: [
                 {
                     value: '12',

package/out/handlers/crowdin-update.js

@@ -19,8 +19,12 @@ function handle(config, integration) {
         if (rootFolder) {
             (0, util_1.log)(`Upading crowdin files under folder ${rootFolder.id}`, config.logger);
         }
-        yield integration.updateCrowdin(projectId, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
-        res.status(204).end();
+        const result = yield integration.updateCrowdin(projectId, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
+        let message;
+        if ((0, util_1.isMessageResultType)(result)) {
+            message = result.message;
+        }
+        res.send({ message });
     }), config.onError);
 }
 exports.default = handle;

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

@@ -112,17 +112,17 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                     return Object.assign(Object.assign({}, string), { translations });
                 });
             }
-            const stringsJson = JSON.stringify(strings);
-            if (Buffer.byteLength(stringsJson, 'utf8') < maxSize) {
+            const stringsNDJson = strings.map(s => JSON.stringify(s)).join('\n\r');
+            if (Buffer.byteLength(stringsNDJson, 'utf8') < maxSize) {
                 response.strings = strings;
             }
             else {
                 let url;
                 if (config.storeFile) {
-                    url = yield config.storeFile(stringsJson);
+                    url = yield config.storeFile(stringsNDJson);
                 }
                 else {
-                    const storedFile = yield storeFile(stringsJson, dataFolder);
+                    const storedFile = yield storeFile(stringsNDJson, dataFolder);
                     url = `${baseUrl}?file=${storedFile}`;
                 }
                 response.stringsUrl = url;

package/out/handlers/integration-data.js

@@ -14,9 +14,18 @@ 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, parentId, search);
+        const result = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings, parentId, search);
+        let message;
+        let files;
+        if ((0, util_1.isMessageResultType)(result)) {
+            files = result.data;
+            message = result.message;
+        }
+        else {
+            files = result;
+        }
         (0, util_1.log)(`Integration data response ${JSON.stringify(files, null, 2)}`, config.logger);
-        res.send(files);
+        res.send({ data: files, message });
     }), config.onError);
 }
 exports.default = handle;

package/out/handlers/integration-update.js

@@ -18,8 +18,12 @@ function handle(config, integration) {
         if (rootFolder) {
             (0, util_1.log)(`Upading integration data for crowding root folder ${rootFolder.id}`, config.logger);
         }
-        yield integration.updateIntegration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
-        res.status(204).end();
+        const result = yield integration.updateIntegration(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
+        let message;
+        if ((0, util_1.isMessageResultType)(result)) {
+            message = result.message;
+        }
+        res.send({ message });
     }), config.onError);
 }
 exports.default = handle;

package/out/models/index.d.ts

@@ -172,15 +172,15 @@ export interface IntegrationLogic {
     /**
      * function to get data from integration
      */
-    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any) => Promise<TreeItem[]>;
+    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any) => Promise<TreeItem[] | MessageResult<TreeItem[]>>;
     /**
      * function to update crowdin files (e.g. pull integration data to crowdin source files)
      */
-    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
+    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | MessageResult<void>>;
     /**
      * function to update integration content (e.g. load crowdin translations and push them to integration service)
      */
-    updateIntegration: (projectId: number, client: Crowdin, apiCredentials: any, request: UpdateIntegrationRequest, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
+    updateIntegration: (projectId: number, client: Crowdin, apiCredentials: any, request: UpdateIntegrationRequest, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | MessageResult<void>>;
     /**
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */
@@ -379,6 +379,10 @@ export interface FormField {
         value: string;
     }[];
 }
+export interface MessageResult<T> {
+    data?: T;
+    message?: string;
+}
 export declare type TreeItem = File | Folder;
 export interface File {
     id: string;

package/out/static/js/main.js

@@ -69,6 +69,9 @@ function checkResponse(response) {
         if (![200, 201, 304].includes(response.status)) {
           reject(res);
         } else {
+          if (res.message) {
+            showToast(res.message);
+          }
           resolve(res);
         }
       })

package/out/util/index.d.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { Config, Logger } from '../models';
+import { Config, Logger, MessageResult } from '../models';
 export declare class CodeError extends Error {
     code: number | undefined;
     constructor(message: string, code?: number);
@@ -10,3 +10,4 @@ export declare function runAsyncWrapper(callback: Function, onError?: (e: any) =
 export declare function encryptData(config: Config, data: string): string;
 export declare function decryptData(config: Config, data: string): string;
 export declare function executeWithRetry<T>(func: () => Promise<T>, numOfRetries?: number): Promise<T>;
+export declare function isMessageResultType<T>(data?: T | MessageResult<T>): data is MessageResult<T>;

package/out/util/index.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.getMessage = exports.log = exports.CodeError = void 0;
+exports.isMessageResultType = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.getMessage = exports.log = exports.CodeError = void 0;
 const crypto = __importStar(require("crypto-js"));
 const storage_1 = require("../storage");
 class CodeError extends Error {
@@ -120,3 +120,8 @@ function executeWithRetry(func, numOfRetries = 2) {
     });
 }
 exports.executeWithRetry = executeWithRetry;
+function isMessageResultType(data) {
+    const dataTyped = data;
+    return !!(dataTyped === null || dataTyped === void 0 ? void 0 : dataTyped.data) || !!(dataTyped === null || dataTyped === void 0 ? void 0 : dataTyped.message);
+}
+exports.isMessageResultType = isMessageResultType;

package/out/views/main.handlebars

@@ -222,7 +222,8 @@
             .then(restParams => fetch(`api/integration/data${restParams}&parent_id=${parentId}&search=${search}`))
             .then(checkResponse)
             .then((res) => {
-                const tree = res.map(e => {
+                const files = res.data;
+                const tree = files.map(e => {
                     const item = {
                         parent_id: e.parentId ? e.parentId : '0',
                         name: e.name,
@@ -243,7 +244,7 @@
                     appComponent.pushIntegrationFilesData(tree);
                 }
                 if (search) {
-                    const openIds = res.filter(e => !e.type).map(e => e.id);
+                    const openIds = files.filter(e => !e.type).map(e => e.id);
                     appComponent.setIntegrationOpenedFolders(openIds);
                 }
             })

package/package.json

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