@crowdin/app-project-module 1.7.1 → 1.8.0

package/out/modules/organization-menu/index.js

@@ -8,15 +8,27 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.organizationMenu) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.organizationMenu);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/logo/organization-menu', (0, util_2.serveLogo)(config, config.organizationMenu));
-    app.use('/organization-menu', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.organizationMenu.key }), (0, render_ui_module_1.default)(config.organizationMenu, config));
-    // TEMPORARY CODE: it needs to support old path
-    app.use('/logo/resources', (0, util_2.serveLogo)(config, config.organizationMenu));
-    app.use('/resources', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(config.organizationMenu, config));
-    // END TEMPORARY CODE
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({ identifier: config.identifier, suffix: 'resources', item, index, isSingle });
+        const basePath = isSingle ? '/organization-menu' : `/organization-menu-${key}`;
+        const logoPath = isSingle ? '/logo/organization-menu' : `/logo/organization-menu-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
+    if (isSingle) {
+        const item = items[0];
+        // TEMPORARY CODE: it needs to support old path
+        app.use('/logo/resources', (0, util_2.serveLogo)(config, item));
+        app.use('/resources', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(item, config));
+        // END TEMPORARY CODE
+    }
 }

package/out/modules/organization-settings-menu/index.js

@@ -8,15 +8,33 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.organizationSettingsMenu) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.organizationSettingsMenu);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/logo/organization-settings', (0, util_2.serveLogo)(config, config.organizationSettingsMenu));
-    app.use('/organization-settings', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.organizationSettingsMenu.key }), (0, render_ui_module_1.default)(config.organizationSettingsMenu, config));
-    // TEMPORARY CODE: it needs to support old path
-    app.use('/logo/settings', (0, util_2.serveLogo)(config, config.organizationSettingsMenu));
-    app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(config.organizationSettingsMenu, config));
-    // END TEMPORARY CODE
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({
+            identifier: config.identifier,
+            suffix: 'organization-settings-menu',
+            item,
+            index,
+            isSingle,
+        });
+        const basePath = isSingle ? '/organization-settings' : `/organization-settings-${key}`;
+        const logoPath = isSingle ? '/logo/organization-settings' : `/logo/organization-settings-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
+    if (isSingle) {
+        const item = items[0];
+        // TEMPORARY CODE: it needs to support old path
+        app.use('/logo/settings', (0, util_2.serveLogo)(config, item));
+        app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(item, config));
+        // END TEMPORARY CODE
+    }
 }

package/out/modules/profile-resources-menu/index.js

@@ -8,15 +8,33 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.profileResourcesMenu) {
         return;
     }
-    app.use('/logo/profile-resources', (0, util_2.serveLogo)(config, config.profileResourcesMenu));
+    const items = (0, normalize_module_1.normalizeToArray)(config.profileResourcesMenu);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/profile-resources', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.profileResourcesMenu.key }), (0, render_ui_module_1.default)(config.profileResourcesMenu, config));
-    // TEMPORARY CODE: it needs to support old path
-    app.use('/logo/resources', (0, util_2.serveLogo)(config, config.profileResourcesMenu));
-    app.use('/resources', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(config.profileResourcesMenu, config));
-    // END TEMPORARY CODE
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({
+            identifier: config.identifier,
+            suffix: 'profile-resources-menu',
+            item,
+            index,
+            isSingle,
+        });
+        const basePath = isSingle ? '/profile-resources' : `/profile-resources-${key}`;
+        const logoPath = isSingle ? '/logo/profile-resources' : `/logo/profile-resources-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
+    if (isSingle) {
+        const item = items[0];
+        // TEMPORARY CODE: it needs to support old path
+        app.use('/logo/resources', (0, util_2.serveLogo)(config, item));
+        app.use('/resources', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(item, config));
+        // END TEMPORARY CODE
+    }
 }

package/out/modules/profile-settings-menu/index.js

@@ -8,15 +8,33 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.profileSettingsMenu) {
         return;
     }
-    app.use('/logo/profile-settings', (0, util_2.serveLogo)(config, config.profileSettingsMenu));
+    const items = (0, normalize_module_1.normalizeToArray)(config.profileSettingsMenu);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/profile-settings', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.profileSettingsMenu.key }), (0, render_ui_module_1.default)(config.profileSettingsMenu, config));
-    // TEMPORARY CODE: it needs to support old path
-    app.use('/logo/settings', (0, util_2.serveLogo)(config, config.profileSettingsMenu));
-    app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(config.profileSettingsMenu, config));
-    // END TEMPORARY CODE
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({
+            identifier: config.identifier,
+            suffix: 'profile-settings-menu',
+            item,
+            index,
+            isSingle,
+        });
+        const basePath = isSingle ? '/profile-settings' : `/profile-settings-${key}`;
+        const logoPath = isSingle ? '/logo/profile-settings' : `/logo/profile-settings-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
+    if (isSingle) {
+        const item = items[0];
+        // TEMPORARY CODE: it needs to support old path
+        app.use('/logo/settings', (0, util_2.serveLogo)(config, item));
+        app.use('/settings', (0, ui_module_1.default)({ config, allowUnauthorized }), (0, render_ui_module_1.default)(item, config));
+        // END TEMPORARY CODE
+    }
 }

package/out/modules/project-menu/index.js

@@ -7,10 +7,18 @@ exports.register = register;
 const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.projectMenu) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.projectMenu);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/project-menu', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.projectMenu.key }), (0, render_ui_module_1.default)(config.projectMenu, config));
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({ identifier: config.identifier, suffix: 'project-menu', item, index, isSingle });
+        const basePath = isSingle ? '/project-menu' : `/project-menu-${key}`;
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
 }

package/out/modules/project-menu-crowdsource/index.js

@@ -7,10 +7,24 @@ exports.register = register;
 const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-module"));
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.projectMenuCrowdsource) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.projectMenuCrowdsource);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/project-menu-crowdsource', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.projectMenuCrowdsource.key }), (0, render_ui_module_1.default)(config.projectMenuCrowdsource, config));
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({
+            identifier: config.identifier,
+            suffix: 'project-menu-crowdsource',
+            item,
+            index,
+            isSingle,
+        });
+        const basePath = isSingle ? '/project-menu-crowdsource' : `/project-menu-crowdsource-${key}`;
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
 }

package/out/modules/project-reports/index.js

@@ -8,11 +8,20 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.projectReports) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.projectReports);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/logo/reports', (0, util_2.serveLogo)(config, config.projectReports));
-    app.use('/reports', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.projectReports.key }), (0, render_ui_module_1.default)(config.projectReports, config));
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({ identifier: config.identifier, suffix: 'project-reports', item, index, isSingle });
+        const basePath = isSingle ? '/reports' : `/reports-${key}`;
+        const logoPath = isSingle ? '/logo/reports' : `/logo/reports-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
 }

package/out/modules/project-tools/index.js

@@ -8,11 +8,20 @@ const render_ui_module_1 = __importDefault(require("../../middlewares/render-ui-
 const ui_module_1 = __importDefault(require("../../middlewares/ui-module"));
 const util_1 = require("../../util");
 const util_2 = require("../../util");
+const normalize_module_1 = require("../../util/normalize-module");
 function register({ config, app }) {
+    var _a;
     if (!config.projectTools) {
         return;
     }
+    const items = (0, normalize_module_1.normalizeToArray)(config.projectTools);
+    const isSingle = items.length === 1;
     const allowUnauthorized = !(0, util_1.isAuthorizedConfig)(config);
-    app.use('/logo/tools', (0, util_2.serveLogo)(config, config.projectTools));
-    app.use('/tools', (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: config.projectTools.key }), (0, render_ui_module_1.default)(config.projectTools, config));
+    for (const [index, item] of items.entries()) {
+        const key = (_a = item.key) !== null && _a !== void 0 ? _a : (0, normalize_module_1.resolveInstanceKey)({ identifier: config.identifier, suffix: 'tools', item, index, isSingle });
+        const basePath = isSingle ? '/tools' : `/tools-${key}`;
+        const logoPath = isSingle ? '/logo/tools' : `/logo/tools-${key}`;
+        app.use(logoPath, (0, util_2.serveLogo)(config, item));
+        app.use(basePath, (0, ui_module_1.default)({ config, allowUnauthorized, moduleType: key }), (0, render_ui_module_1.default)(item, config));
+    }
 }

package/out/types.d.ts

@@ -127,47 +127,47 @@ export interface ClientConfig extends ImagePath {
     /**
      * custom file format module logic
      */
-    customFileFormat?: CustomFileFormatLogic;
+    customFileFormat?: OneOrMany<CustomFileFormatLogic>;
     /**
      * custom MT module logic
      */
-    customMT?: CustomMTLogic & ImagePath & Environments;
+    customMT?: OneOrMany<CustomMTLogic & ImagePath & Environments>;
     /**
      * resources module
      */
-    profileResourcesMenu?: UiModule & ImagePath & Environments;
+    profileResourcesMenu?: OneOrMany<UiModule & ImagePath & Environments>;
     /**
      * profile-settings-menu module
      */
-    profileSettingsMenu?: UiModule & ImagePath & Environments;
+    profileSettingsMenu?: OneOrMany<UiModule & ImagePath & Environments>;
     /**
      * organization-menu module
      */
-    organizationMenu?: UiModule & ImagePath;
+    organizationMenu?: OneOrMany<UiModule & ImagePath>;
     /**
      * organization-settings-menu module
      */
-    organizationSettingsMenu?: UiModule & ImagePath;
+    organizationSettingsMenu?: OneOrMany<UiModule & ImagePath>;
     /**
      * editor-right-panel module
      */
-    editorRightPanel?: EditorPanels & Environments;
+    editorRightPanel?: OneOrMany<EditorPanels & Environments>;
     /**
      * project menu module
      */
-    projectMenu?: UiModule & Environments;
+    projectMenu?: OneOrMany<UiModule & Environments>;
     /**
      * project menu crowdsource module
      */
-    projectMenuCrowdsource?: UiModule;
+    projectMenuCrowdsource?: OneOrMany<UiModule>;
     /**
      * tools module
      */
-    projectTools?: UiModule & ImagePath & Environments;
+    projectTools?: OneOrMany<UiModule & ImagePath & Environments>;
     /**
      * reports module
      */
-    projectReports?: UiModule & ImagePath;
+    projectReports?: OneOrMany<UiModule & ImagePath>;
     /**
      * API module
      */
@@ -175,11 +175,11 @@ export interface ClientConfig extends ImagePath {
     /**
      * context menu module
      */
-    contextMenu?: ContextModule | ContextModule[];
+    contextMenu?: OneOrMany<ContextModule>;
     /**
      * modal module
      */
-    modal?: ModalModule | ModalModule[];
+    modal?: OneOrMany<ModalModule>;
     /**
      * Install hook
      */
@@ -225,11 +225,11 @@ export interface ClientConfig extends ImagePath {
      * Configuration of app pricing
      */
     pricing?: Pricing;
-    filePreImport?: FilePreImportLogic;
-    filePostImport?: FilePostImportLogic;
-    filePreExport?: FilePreExportLogic;
-    filePostExport?: FilePostExportLogic;
-    fileTranslationsAlignmentExport?: TranslationsAlignmentLogic;
+    filePreImport?: OneOrMany<FilePreImportLogic>;
+    filePostImport?: OneOrMany<FilePostImportLogic>;
+    filePreExport?: OneOrMany<FilePreExportLogic>;
+    filePostExport?: OneOrMany<FilePostExportLogic>;
+    fileTranslationsAlignmentExport?: OneOrMany<TranslationsAlignmentLogic>;
     /**
      * Disable formatting logs
      */
@@ -240,51 +240,51 @@ export interface ClientConfig extends ImagePath {
      * Not necessary to configure if environment variables AWS_REGION and AWS_TMP_BUCKET_NAME are properly set.
      */
     awsConfig?: AWSConfig;
-    customSpellchecker?: CustomSpellcheckerModule;
+    customSpellchecker?: OneOrMany<CustomSpellcheckerModule>;
     /**
      * ai provider module
      */
-    aiProvider?: AiProviderModule & ImagePath;
+    aiProvider?: OneOrMany<AiProviderModule & ImagePath>;
     /**
      * ai prompt provider module
      */
-    aiPromptProvider?: AiPromptProviderModule & ImagePath;
+    aiPromptProvider?: OneOrMany<AiPromptProviderModule & ImagePath>;
     /**
      * ai request pre-compile processor module
      */
-    aiRequestPreCompile?: AiRequestProcessorModule;
+    aiRequestPreCompile?: OneOrMany<AiRequestProcessorModule>;
     /**
      * ai request post-compile processor module
      */
-    aiRequestPostCompile?: AiRequestProcessorModule;
+    aiRequestPostCompile?: OneOrMany<AiRequestProcessorModule>;
     /**
      * ai request pre-parse processor module
      */
-    aiRequestPreParse?: AiStreamProcessorModule;
+    aiRequestPreParse?: OneOrMany<AiStreamProcessorModule>;
     /**
      * ai request post-parse processor module
      */
-    aiRequestPostParse?: AiRequestProcessorModule;
+    aiRequestPostParse?: OneOrMany<AiRequestProcessorModule>;
     /**
      * AI tool_calls modules
      */
-    aiTools?: AiTool | AiTool[];
+    aiTools?: OneOrMany<AiTool>;
     /**
      * AI tool_calls modules with UI widgets
      */
-    aiToolsWidget?: AiToolWidget | AiToolWidget[];
+    aiToolsWidget?: OneOrMany<AiToolWidget>;
     /**
      * qa check module
      */
-    externalQaCheck?: ExternalQaCheckModule & ImagePath;
+    externalQaCheck?: OneOrMany<ExternalQaCheckModule & ImagePath>;
     /**
      * webhook modules
      */
-    webhooks?: Webhook | Webhook[];
+    webhooks?: OneOrMany<Webhook>;
     /**
      * workflow step modules
      */
-    workflowStepType?: WorkflowStepTypeModule | WorkflowStepTypeModule[];
+    workflowStepType?: OneOrMany<WorkflowStepTypeModule>;
     /**
      * property that tells backend that AiProvider and AiPromptProvider modules can cooperate only with each one
      */
@@ -296,11 +296,11 @@ export interface ClientConfig extends ImagePath {
     /**
      * Automation action module
      */
-    automationAction?: AutomationActionModule | AutomationActionModule[];
+    automationAction?: OneOrMany<AutomationActionModule>;
     /**
      * Auth guard module for custom authentication/authorization checks
      */
-    authGuard?: AuthGuardModule | AuthGuardModule[];
+    authGuard?: OneOrMany<AuthGuardModule>;
     /**
      * custom file storage
      */
@@ -317,7 +317,7 @@ export interface AssetsConfig {
     fetcher: Fetcher;
 }
 export interface Environments {
-    environments?: Environment | Environment[];
+    environments?: OneOrMany<Environment>;
 }
 type Environment = 'crowdin' | 'crowdin-enterprise';
 export type Config = ClientConfig & {
@@ -519,6 +519,7 @@ export interface ModuleKey {
      */
     key?: string;
 }
+export type OneOrMany<T> = T | T[];
 export interface ImagePath {
     /**
      * path to app logo (e.g. {@example join(__dirname, 'logo.png')})

package/out/util/normalize-module.d.ts

@@ -0,0 +1,11 @@
+export declare function normalizeToArray<T>(value: T | T[]): T[];
+export declare function resolveInstanceKey({ identifier, suffix, item, index, isSingle, }: {
+    identifier: string;
+    suffix: string;
+    item: {
+        key?: string;
+        name?: string;
+    };
+    index: number;
+    isSingle: boolean;
+}): string;

package/out/util/normalize-module.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeToArray = normalizeToArray;
+exports.resolveInstanceKey = resolveInstanceKey;
+const index_1 = require("./index");
+function normalizeToArray(value) {
+    return Array.isArray(value) ? value : [value];
+}
+function resolveInstanceKey({ identifier, suffix, item, index, isSingle, }) {
+    if (isSingle) {
+        return identifier + '-' + suffix;
+    }
+    if (item.key) {
+        return item.key;
+    }
+    if (item.name) {
+        return identifier + '-' + (0, index_1.kebabCase)(item.name);
+    }
+    return identifier + '-' + suffix + '-' + index;
+}

package/package.json

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