@crowdin/app-project-module 0.12.1 → 0.12.3

package/README.md

@@ -591,6 +591,7 @@ const configuration = {
     dbFolder: __dirname,
     imagePath: __dirname + '/' + 'logo.png',
     reports: { //can be editorPanels, projectMenu, tools
+      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)
     },

package/out/handlers/manifest.js

@@ -2,13 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 function handle(config) {
     const modules = {};
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.integration) {
         modules.integrations = [
             {
                 key: config.identifier + '-int',
                 name: config.name,
                 description: config.description,
-                logo: '/logo.png',
+                logo: '/logo/integration/logo.png',
+                url: '/',
+            },
+        ];
+    }
+    // END OF TEMPORARY CODE
+    if (config.projectIntegration) {
+        modules['project-integrations'] = [
+            {
+                key: config.identifier + '-int',
+                name: config.name,
+                description: config.description,
+                logo: '/logo/integration/logo.png',
                 url: '/',
             },
         ];
@@ -32,13 +45,14 @@ function handle(config) {
             },
         ];
     }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.resources) {
         modules['organization-menu'] = [
             {
                 key: config.identifier + '-resources',
                 name: config.name,
                 url: '/resources/' + (config.resources.fileName || 'index.html'),
-                icon: '/logo.png',
+                icon: '/logo/resources/logo.png',
             },
         ];
         modules['resources'] = [
@@ -46,10 +60,32 @@ function handle(config) {
                 key: config.identifier + '-resources',
                 name: config.name,
                 url: '/resources/' + (config.resources.fileName || 'index.html'),
-                icon: '/logo.png',
+                icon: '/logo/resources/logo.png',
+            },
+        ];
+    }
+    // END OF TEMPORARY CODE
+    if (config.organizationMenu) {
+        modules['organization-menu'] = [
+            {
+                key: config.identifier + '-resources',
+                name: config.name,
+                url: '/resources/' + (config.organizationMenu.fileName || 'index.html'),
+                icon: '/logo/resources/logo.png',
+            },
+        ];
+    }
+    if (config.profileResourcesMenu) {
+        modules['profile-resources-menu'] = [
+            {
+                key: config.identifier + '-profile-resources-menu',
+                name: config.name,
+                url: '/resources/' + (config.profileResourcesMenu.fileName || 'index.html'),
+                icon: '/logo/resources/logo.png',
             },
         ];
     }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.editorPanels) {
         modules['editor-panels'] = [
             {
@@ -61,6 +97,17 @@ function handle(config) {
             },
         ];
     }
+    // END OF TEMPORARY CODE
+    if (config.editorRightPanel) {
+        modules['editor-right-panel'] = [
+            {
+                key: config.identifier + '-editor-panels',
+                name: config.name,
+                url: '/editor-panels/' + (config.editorRightPanel.fileName || 'index.html'),
+                modes: config.editorRightPanel.modes,
+            },
+        ];
+    }
     if (config.projectMenu) {
         modules['project-menu'] = [
             {
@@ -70,28 +117,54 @@ function handle(config) {
             },
         ];
     }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.tools) {
         modules['tools'] = [
             {
                 key: config.identifier + '-tools',
                 name: config.name,
                 description: config.description,
-                logo: '/logo.png',
-                icon: '/logo.png',
+                logo: '/logo/tools/logo.png',
                 url: '/tools/' + (config.tools.fileName || 'index.html'),
             },
         ];
     }
+    // END OF TEMPORARY CODE
+    if (config.projectTools) {
+        modules['project-tools'] = [
+            {
+                key: config.identifier + '-tools',
+                name: config.name,
+                description: config.description,
+                logo: '/logo/tools/logo.png',
+                url: '/tools/' + (config.projectTools.fileName || 'index.html'),
+            },
+        ];
+    }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.reports) {
         modules['reports'] = [
             {
                 key: config.identifier + '-reports',
                 name: config.name,
                 description: config.description,
+                logo: '/logo/reports/logo.png',
                 url: '/reports/' + (config.reports.fileName || 'index.html'),
             },
         ];
     }
+    // END OF TEMPORARY CODE
+    if (config.projectReports) {
+        modules['project-reports'] = [
+            {
+                key: config.identifier + '-project-reports',
+                name: config.name,
+                description: config.description,
+                logo: '/logo/reports/logo.png',
+                url: '/reports/' + (config.projectReports.fileName || 'index.html'),
+            },
+        ];
+    }
     return (_req, res) => {
         const manifest = {
             identifier: config.identifier,

package/out/index.js

@@ -88,9 +88,10 @@ function addCrowdinEndpoints(app, config) {
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)(config));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
-    const integrationLogic = config.integration;
+    const integrationLogic = config.integration || config.projectIntegration;
     if (integrationLogic) {
         (0, util_1.applyDefaults)(config, integrationLogic);
+        app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
         app.get('/', (0, crowdin_client_1.default)(config, true), (0, integration_credentials_1.default)(config, integrationLogic, true), (0, main_1.default)(config, integrationLogic));
         app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)(config));
         app.post('/api/login', (0, crowdin_client_1.default)(config), (0, integration_login_1.default)(config, integrationLogic));
@@ -126,21 +127,51 @@ function addCrowdinEndpoints(app, config) {
     if (config.customMT) {
         app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config, config.customMT));
     }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.resources) {
+        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.resources) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
         app.use('/resources', express_1.default.static(config.resources.uiPath));
     }
+    // END OF TEMPORARY CODE
+    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', 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', express_1.default.static(config.organizationMenu.uiPath));
+    }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.editorPanels) {
         app.use('/editor-panels', express_1.default.static(config.editorPanels.uiPath));
     }
+    // END OF TEMPORARY CODE
+    if (config.editorRightPanel) {
+        app.use('/editor-panels', express_1.default.static(config.editorRightPanel.uiPath));
+    }
     if (config.projectMenu) {
         app.use('/project-menu', express_1.default.static(config.projectMenu.uiPath));
     }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.tools) {
+        app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.tools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
         app.use('/tools', express_1.default.static(config.tools.uiPath));
     }
+    // END OF TEMPORARY CODE
+    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', express_1.default.static(config.projectTools.uiPath));
+    }
+    // TEMPORARY CODE drop on step 3 of CN-30453
     if (config.reports) {
+        app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.reports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
         app.use('/reports', express_1.default.static(config.reports.uiPath));
     }
+    // END OF TEMPORARY CODE
+    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', express_1.default.static(config.projectReports.uiPath));
+    }
     return {
         getMetadata: storage.getMetadata,
         saveMetadata: (id, metadata) => __awaiter(this, void 0, void 0, function* () {

package/out/models/index.d.ts

@@ -1,7 +1,7 @@
 import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel } from '@crowdin/crowdin-api-client';
 import { JwtPayload } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
-export interface Config {
+export interface Config extends ImagePath {
     /**
      * client id that we received when registering the app
      */
@@ -35,13 +35,13 @@ export interface Config {
      */
     dbFolder: string;
     /**
-     * path to app logo (e.g. {@example join(__dirname, 'logo.png')})
+     * integration module logic
      */
-    imagePath?: string;
+    integration?: IntegrationLogic & ImagePath;
     /**
      * integration module logic
      */
-    integration?: IntegrationLogic;
+    projectIntegration?: IntegrationLogic & ImagePath;
     /**
      * custom file format module logic
      */
@@ -53,11 +53,23 @@ export interface Config {
     /**
      * resources module
      */
-    resources?: UiModule;
+    resources?: UiModule & ImagePath;
+    /**
+     * resources module
+     */
+    profileResourcesMenu?: UiModule & ImagePath;
+    /**
+     * organization-menu module
+     */
+    organizationMenu?: UiModule & ImagePath;
     /**
      * editor-panels module
      */
     editorPanels?: EditorPanels;
+    /**
+     * editor-right-panel module
+     */
+    editorRightPanel?: EditorPanels;
     /**
      * project menu module
      */
@@ -65,11 +77,19 @@ export interface Config {
     /**
      * tools module
      */
-    tools?: UiModule;
+    tools?: UiModule & ImagePath;
+    /**
+     * tools module
+     */
+    projectTools?: UiModule & ImagePath;
+    /**
+     * reports module
+     */
+    reports?: UiModule & ImagePath;
     /**
      * reports module
      */
-    reports?: UiModule;
+    projectReports?: UiModule & ImagePath;
     /**
      * Uninstall hook for cleanup logic
      */
@@ -439,3 +459,10 @@ export interface IntegrationSyncSettings {
     crowdinId: string;
     provider: string;
 }
+interface ImagePath {
+    /**
+     * path to app logo (e.g. {@example join(__dirname, 'logo.png')})
+     */
+    imagePath?: string;
+}
+export {};

package/package.json

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