@crowdin/app-project-module 0.25.0 → 0.26.0

package/README.md

@@ -89,9 +89,10 @@ const configuration = {
             crowdin: true,
             integration: true,
         },
+        integrationPagination: true, //enable pagination on integration files list
         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) => {
+        getIntegrationFiles: async (credentials, appSettings, parentId, search, page) => {
             //here you need to fetch files/objects from integration
             const res = [
                 {
@@ -125,6 +126,7 @@ const configuration = {
             return {
                 data: res,
                 message: 'Test',
+                stopPagination: true, //send if no next files page
             };
         },
         updateCrowdin: async (projectId, client, credentials, request, rootFolder, appSettings) => {
@@ -816,7 +818,8 @@ const configuration = {
     projectReports: { //can be editorRightPanel, projectMenu, projectTools, projectMenuCrowdsource
       imagePath: __dirname + '/' + 'reports.png',
       fileName: 'reports.html', //optional, only needed if file is not index.html
-      uiPath: __dirname + '/' + 'public' // folder where UI of the module is located (js, html, css files)
+      uiPath: __dirname + '/' + 'public', // folder where UI of the module is located (js, html, css files)
+      allowUnauthorized: true //make module publicly available without crowdin context
     },
 };
 

package/out/handlers/crowdin-update.js

@@ -21,7 +21,7 @@ function handle(config, integration) {
         }
         const result = yield integration.updateCrowdin(projectId, req.crowdinApiClient, req.integrationCredentials, req.body, rootFolder, req.integrationSettings);
         let message;
-        if ((0, util_1.isMessageResultType)(result)) {
+        if ((0, util_1.isExtendedResultType)(result)) {
             message = result.message;
         }
         res.send({ message });

package/out/handlers/integration-data.js

@@ -12,20 +12,22 @@ 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;
+        const { parent_id: parentId, search, page } = req.query;
         (0, util_1.log)('Recieved request to get integration data', config.logger);
-        const result = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings, parentId, search);
+        const result = yield integration.getIntegrationFiles(req.integrationCredentials, req.integrationSettings, parentId, search, page);
         let message;
+        let stopPagination;
         let files;
-        if ((0, util_1.isMessageResultType)(result)) {
+        if ((0, util_1.isExtendedResultType)(result)) {
             files = result.data;
             message = result.message;
+            stopPagination = result.stopPagination;
         }
         else {
             files = result;
         }
         (0, util_1.log)(`Integration data response ${JSON.stringify(files, null, 2)}`, config.logger);
-        res.send({ data: files, message });
+        res.send({ data: files, message, stopPagination });
     }), config.onError);
 }
 exports.default = handle;

package/out/handlers/integration-update.js

@@ -20,7 +20,7 @@ function handle(config, integration) {
         }
         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)) {
+        if ((0, util_1.isExtendedResultType)(result)) {
             message = result.message;
         }
         res.send({ message });

package/out/handlers/main.js

@@ -40,6 +40,7 @@ function handle(config, integration) {
             options.configurationFields = configurationFields;
             options.config = JSON.stringify(req.integrationSettings || {});
             options.reloadOnConfigSave = !!integration.reloadOnConfigSave;
+            options.integrationPagination = integration.integrationPagination;
             (0, util_1.log)(`Adding configuration fields ${JSON.stringify(configurationFields, null, 2)}`, config.logger);
         }
         options.infoModal = integration.infoModal;

package/out/index.js

@@ -143,28 +143,28 @@ function addCrowdinEndpoints(app, config) {
     }
     if (config.profileResourcesMenu) {
         app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/resources', (0, ui_module_1.default)(config), express_1.default.static(config.profileResourcesMenu.uiPath));
+        app.use('/resources', (0, ui_module_1.default)(config, config.profileResourcesMenu.allowUnauthorized), express_1.default.static(config.profileResourcesMenu.uiPath));
     }
     if (config.organizationMenu) {
         app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/resources', (0, ui_module_1.default)(config), express_1.default.static(config.organizationMenu.uiPath));
+        app.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), express_1.default.static(config.organizationMenu.uiPath));
     }
     if (config.editorRightPanel) {
-        app.use('/editor-panels', (0, ui_module_1.default)(config), express_1.default.static(config.editorRightPanel.uiPath));
+        app.use('/editor-panels', (0, ui_module_1.default)(config, config.editorRightPanel.allowUnauthorized), express_1.default.static(config.editorRightPanel.uiPath));
     }
     if (config.projectMenu) {
-        app.use('/project-menu', (0, ui_module_1.default)(config), express_1.default.static(config.projectMenu.uiPath));
+        app.use('/project-menu', (0, ui_module_1.default)(config, config.projectMenu.allowUnauthorized), express_1.default.static(config.projectMenu.uiPath));
     }
     if (config.projectMenuCrowdsource) {
-        app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config), express_1.default.static(config.projectMenuCrowdsource.uiPath));
+        app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config, config.projectMenuCrowdsource.allowUnauthorized), express_1.default.static(config.projectMenuCrowdsource.uiPath));
     }
     if (config.projectTools) {
         app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/tools', (0, ui_module_1.default)(config), express_1.default.static(config.projectTools.uiPath));
+        app.use('/tools', (0, ui_module_1.default)(config, config.projectTools.allowUnauthorized), express_1.default.static(config.projectTools.uiPath));
     }
     if (config.projectReports) {
         app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/reports', (0, ui_module_1.default)(config), express_1.default.static(config.projectReports.uiPath));
+        app.use('/reports', (0, ui_module_1.default)(config, config.projectReports.allowUnauthorized), express_1.default.static(config.projectReports.uiPath));
     }
     return {
         getMetadata: storage.getStorage().getMetadata.bind(storage.getStorage()),

package/out/middlewares/ui-module.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
 import { Config } from '../models';
-export default function handle(config: Config): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+export default function handle(config: Config, allowUnauthorized?: boolean): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/middlewares/ui-module.js

@@ -13,8 +13,12 @@ const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
-function handle(config) {
+function handle(config, allowUnauthorized = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        if (allowUnauthorized) {
+            next();
+            return;
+        }
         const tokenJwt = req.query.tokenJwt;
         if (!tokenJwt) {
             return res.status(403).send({ error: 'Access denied' });

package/out/models/index.d.ts

@@ -179,15 +179,15 @@ export interface IntegrationLogic {
     /**
      * function to get data from integration
      */
-    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any) => Promise<TreeItem[] | MessageResult<TreeItem[]>>;
+    getIntegrationFiles: (apiCredentials: any, config?: any, parentId?: any, search?: any, page?: any) => Promise<TreeItem[] | ExtendedResult<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 | MessageResult<void>>;
+    updateCrowdin: (projectId: number, client: Crowdin, apiCredentials: any, request: IntegrationFile[], appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | ExtendedResult<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 | MessageResult<void>>;
+    updateIntegration: (projectId: number, client: Crowdin, apiCredentials: any, request: UpdateIntegrationRequest, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void | ExtendedResult<void>>;
     /**
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */
@@ -227,6 +227,10 @@ export interface IntegrationLogic {
      * Enable integration search event
      */
     integrationSearchListener?: boolean;
+    /**
+     * Enable integration next page event
+     */
+    integrationPagination?: boolean;
 }
 export declare type ConfigurationModalEntity = FormField | ConfigurationDelimeter;
 export interface ConfigurationDelimeter {
@@ -365,9 +369,10 @@ export interface FormField {
         value: string;
     }[];
 }
-export interface MessageResult<T> {
+export interface ExtendedResult<T> {
     data?: T;
     message?: string;
+    stopPagination?: boolean;
 }
 export declare type TreeItem = File | Folder;
 /**
@@ -566,6 +571,10 @@ export interface UiModule {
      * page name (default index.html)
      */
     fileName?: string;
+    /**
+     * make module publicly available without crowdin context
+     */
+    allowUnauthorized?: boolean;
 }
 export interface EditorPanels extends UiModule {
     /**

package/out/util/index.d.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { Config, Logger, MessageResult } from '../models';
+import { Config, Logger, ExtendedResult } from '../models';
 export declare class CodeError extends Error {
     code: number | undefined;
     constructor(message: string, code?: number);
@@ -10,4 +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>;
+export declare function isExtendedResultType<T>(data?: T | ExtendedResult<T>): data is ExtendedResult<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.isMessageResultType = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.getMessage = exports.log = exports.CodeError = void 0;
+exports.isExtendedResultType = 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,8 +120,8 @@ function executeWithRetry(func, numOfRetries = 2) {
     });
 }
 exports.executeWithRetry = executeWithRetry;
-function isMessageResultType(data) {
+function isExtendedResultType(data) {
     const dataTyped = data;
-    return !!(dataTyped === null || dataTyped === void 0 ? void 0 : dataTyped.data) || !!(dataTyped === null || dataTyped === void 0 ? void 0 : dataTyped.message);
+    return !Array.isArray(dataTyped);
 }
-exports.isMessageResultType = isMessageResultType;
+exports.isExtendedResultType = isExtendedResultType;

package/out/views/main.handlebars

@@ -40,6 +40,9 @@
                 {{#if integrationSearchListener}}
                     allow-filter-change-listener="true"
                 {{/if}}
+                {{#if integrationPagination}}
+                    integration-load-more-files="true"
+                {{/if}}
                 integration-name="{{name}}"
                 integration-logo="logo.png"
         >
@@ -229,13 +232,14 @@
             .finally(() => (appComponent.setAttribute('is-crowdin-loading', false)));
     }
 
-    function getIntegrationData(hardReload = false, parentId = '', search = '',) {
+    function getIntegrationData(hardReload = false, parentId = '', search = '', page = 0) {
         appComponent.setAttribute('is-integration-loading', true);
         checkOrigin()
-            .then(restParams => fetch(`api/integration/data${restParams}&parent_id=${parentId}&search=${search}`))
+            .then(restParams => fetch(`api/integration/data${restParams}&parent_id=${parentId}&search=${search}&page=${page}`))
             .then(checkResponse)
             .then((res) => {
                 const files = res.data;
+                const stopPagination = res.stopPagination;
                 const tree = files.map(e => {
                     const item = {
                         parent_id: e.parentId ? e.parentId : '0',
@@ -256,6 +260,13 @@
                 } else {
                     appComponent.pushIntegrationFilesData(tree);
                 }
+                {{#if integrationPagination}}
+                    if (stopPagination) {
+                        appComponent.querySelector('#integration-files').setAttribute('load-more-disabled', true);
+                    } else {
+                        appComponent.querySelector('#integration-files').setAttribute('load-more-disabled', false);
+                    }
+                {{/if}}
                 if (search) {
                     const openIds = files.filter(e => !e.type).map(e => e.id);
                     appComponent.setIntegrationOpenedFolders(openIds);
@@ -422,6 +433,7 @@
 
     document.addEventListener('keydown', (event) => {
         if (event.keyCode == 27) {
+
             if (infoModal) {
                 infoModal.close();
             }
@@ -431,6 +443,12 @@
         }
     });
 
+    {{#if integrationPagination}}
+        document.body.addEventListener('fileListEnd', (e) => {
+            getIntegrationData(false, 0, '', e.detail.page)
+        })
+    {{/if}}
+
     {{#if withCronSync}}
         document.body.addEventListener('integrationScheduleSync', setIntegrationScheduleSync);
         document.body.addEventListener('crowdinScheduleSync', setCrowdinScheduleSync);

package/out/views/partials/head.handlebars

@@ -5,9 +5,9 @@
         <title></title>
         <link rel="stylesheet" href="assets/css/styles.css">
         <script type="module"
-                src="https://crowdin-web-components.s3.amazonaws.com/crowdin-web-components/crowdin-web-components.esm.js"></script>
+            src="https://crowdin-web-components.s3.amazonaws.com/crowdin-web-components/crowdin-web-components.esm.js"></script>
         <script nomodule=""
-                src="https://crowdin-web-components.s3.amazonaws.com/crowdin-web-components/crowdin-web-components.js"></script>
+            src="https://crowdin-web-components.s3.amazonaws.com/crowdin-web-components/crowdin-web-components.js"></script>
         <script type="text/javascript" src="https://cdn.crowdin.com/apps/dist/iframe.js"></script>
         <script type="text/javascript" src="assets/js/polyfills/promise.js"></script>
         <script type="text/javascript" src="assets/js/polyfills/fetch.js"></script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -13,7 +13,7 @@
     "test": "jest --config jestconfig.json"
   },
   "dependencies": {
-    "@crowdin/crowdin-apps-functions": "0.3.0",
+    "@crowdin/crowdin-apps-functions": "0.3.1",
     "@types/pg": "^8.6.5",
     "crypto-js": "^4.0.0",
     "express": "4.17.1",