@contrail/cli 3.5.4-alpha.f60c4df → 3.5.5-alpha.177136f

package/dist/commands/users/export.js

@@ -2,11 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exportUsers = exports.DEFAULT_FILE_LOCATION = void 0;
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
 const login_1 = require("../../auth/login");
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const core_1 = require("@oclif/core");
 const file_helpers_1 = require("../../helpers/file-helpers");
 const users_1 = require("../../api/users");
@@ -63,15 +60,6 @@ async function exportUsers(fileLocation, overwrite) {
         });
     }
     users = users.sort((one, two) => (one.email < two.email ? -1 : 1));
-    await saveData(users, fileLocation, overwrite);
+    await (0, file_helpers_1.saveData)(users, fileLocation, overwrite);
 }
 exports.exportUsers = exportUsers;
-async function saveData(data, fileLocation, overwrite) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    const pathToWrite = path.resolve(path.join(CURRENT_DIR, fileLocation));
-    if (fs_1.default.existsSync(pathToWrite)) {
-        await (0, file_helpers_1.safeFileOverwrite)(pathToWrite, overwrite);
-    }
-    fs_1.default.writeFileSync(pathToWrite, yamlStr, 'utf8');
-}

package/dist/commands/users/import.js

@@ -2,13 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadUsers = void 0;
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
 const sdk_1 = require("@contrail/sdk");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
 const login_1 = require("../../auth/login");
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const core_1 = require("@oclif/core");
+const file_helpers_1 = require("../../helpers/file-helpers");
 const basecommand_1 = require("../../basecommand");
 class ImportUsers extends basecommand_1.BaseCommand {
     static description = 'Import all users in the users.yml file';
@@ -38,19 +36,8 @@ class ImportUsers extends basecommand_1.BaseCommand {
     }
 }
 exports.default = ImportUsers;
-function getUsersFile(fileLocation) {
-    const CURRENT_DIR = process.cwd();
-    try {
-        const fullPath = path.join(CURRENT_DIR, fileLocation);
-        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(fullPath, 'utf8'));
-        return doc;
-    }
-    catch (e) {
-        throw new Error(`ERROR PARSING YAML: ${e}`);
-    }
-}
 async function uploadUsers(fileLocation) {
-    const users = getUsersFile(fileLocation);
+    const users = (0, file_helpers_1.loadData)(fileLocation);
     for (const user of users) {
         const role = user.role;
         const email = user.email;

package/dist/commands/workflow-templates/export.d.ts

@@ -1,15 +1,14 @@
 import { BaseCommand } from '../../basecommand';
+export declare const DEFAULT_FILE_LOCATION = "workflows.yml";
 export default class ExportWorkflows extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
         outFile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        dir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         overwrite: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     run(): Promise<void>;
 }
-export declare function exportWorkflowsByApp(outputDir: string, overwrite: boolean): Promise<void>;
-export declare function exportWorkflowsToFile(fileLocation: string, overwrite: boolean): Promise<void>;
+export declare function exportWorkflows(fileLocation: string, overwrite: boolean): Promise<void>;

package/dist/commands/workflow-templates/export.js

@@ -1,39 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportWorkflowsToFile = exports.exportWorkflowsByApp = void 0;
+exports.exportWorkflows = exports.DEFAULT_FILE_LOCATION = void 0;
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const login_1 = require("../../auth/login");
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const core_1 = require("@oclif/core");
 const file_helpers_1 = require("../../helpers/file-helpers");
 const event_workflow_templates_1 = require("../../api/event-workflow-templates");
-const schedules_1 = require("../../api/schedules");
-const apps_1 = require("../../api/apps");
 const helper_1 = require("../../helpers/workflow-templates/helper");
 const basecommand_1 = require("../../basecommand");
+exports.DEFAULT_FILE_LOCATION = 'workflows.yml';
 class ExportWorkflows extends basecommand_1.BaseCommand {
-    static description = 'Export all workflows in the org. By default exports one file per app to the current directory.';
+    static description = 'Export all workflows in the org.';
     static examples = [
-        '$ contrail workflow-templates export',
-        '$ contrail workflow-templates export --dir ./workflows',
-        '$ contrail workflow-templates export --outFile workflows.yml',
+        `$ contrail workflow-templates export
+`,
     ];
     static flags = {
         ...basecommand_1.BaseCommand.baseFlags,
         outFile: core_1.Flags.string({
             char: 'f',
-            description: 'Export all workflows to a single file at this path (overrides per-app export)',
+            description: 'The location for the file to be saved',
             required: false,
-        }),
-        dir: core_1.Flags.string({
-            char: 'd',
-            description: 'Directory to write per-app workflow files',
-            required: false,
-            default: '.',
+            default: exports.DEFAULT_FILE_LOCATION,
         }),
         overwrite: core_1.Flags.boolean({
             description: 'Replaces existing files if they exist',
@@ -45,12 +35,7 @@ class ExportWorkflows extends basecommand_1.BaseCommand {
         try {
             await (0, login_1.authUser)();
             this.log(`${chalk_1.default.blue.bold('START')} Getting Workflows.`);
-            if (this.flags.outFile) {
-                await exportWorkflowsToFile(this.flags.outFile, this.flags.overwrite);
-            }
-            else {
-                await exportWorkflowsByApp(this.flags.dir ?? '.', this.flags.overwrite);
-            }
+            await exportWorkflows(this.flags.outFile ?? exports.DEFAULT_FILE_LOCATION, this.flags.overwrite);
             this.log(`${chalk_1.default.yellow.bold('WORKFLOWS')} Done`);
         }
         catch (e) {
@@ -61,106 +46,22 @@ class ExportWorkflows extends basecommand_1.BaseCommand {
     }
 }
 exports.default = ExportWorkflows;
-async function exportWorkflowsByApp(outputDir, overwrite) {
-    const [allWorkflowsInOrg, allSchedules, installedApps] = await Promise.all([
-        (0, event_workflow_templates_1.getExistingWorkflowTemplates)(),
-        (0, schedules_1.getExistingSchedules)(),
-        (0, apps_1.getInstalledApps)(),
-    ]);
-    const appIdToIdentifier = new Map(installedApps
-        .filter((appOrg) => appOrg.appId && appOrg.app?.identifier)
-        .map((appOrg) => [appOrg.appId, appOrg.app.identifier]));
-    const workflowsByApp = new Map();
-    const unassigned = [];
-    for (const workflow of allWorkflowsInOrg) {
-        let appIdentifier = workflow.supportingAppId
-            ? appIdToIdentifier.get(workflow.supportingAppId)
-            : undefined;
-        // If no supportingAppId, try to extract app identifier from workflow identifier
-        // Format: @{appIdentifier}@{randomId}:{workflowName}
-        if (!appIdentifier && workflow.identifier) {
-            const match = workflow.identifier.match(/^@([^@]+)@/);
-            if (match) {
-                // Keep the @ prefix in the appIdentifier
-                appIdentifier = `@${match[1]}`;
-            }
-        }
-        if (appIdentifier) {
-            if (!workflowsByApp.has(appIdentifier)) {
-                workflowsByApp.set(appIdentifier, []);
-            }
-            const workflows = workflowsByApp.get(appIdentifier);
-            if (workflows) {
-                workflows.push(workflow);
-            }
-        }
-        else {
-            unassigned.push(workflow);
-        }
-    }
-    const resolvedDir = path.resolve(process.cwd(), outputDir);
-    for (const [appIdentifier, workflows] of workflowsByApp.entries()) {
-        const exportObj = { appIdentifier, workflows: [] };
-        for (const workflow of workflows) {
-            exportObj.workflows.push(await buildExportWorkflow(workflow, allSchedules, appIdentifier));
-        }
-        const safeAppIdentifier = appIdentifier.replace(/[\\/]/g, '-');
-        const filePath = path.join(resolvedDir, `workflows-${safeAppIdentifier}.yml`);
-        await writeYamlFile(exportObj, filePath, overwrite);
-        console.log(`${chalk_1.default.green('EXPORTED')} ${filePath}`);
-    }
-    if (unassigned.length > 0) {
-        const unassignedObj = { workflows: [] };
-        for (const workflow of unassigned) {
-            unassignedObj.workflows.push(await buildExportWorkflow(workflow, allSchedules));
-        }
-        const unassignedFilePath = path.join(resolvedDir, 'workflows-unassigned.yml');
-        await writeYamlFile(unassignedObj, unassignedFilePath, overwrite);
-        console.log(`${chalk_1.default.yellow('EXPORTED')} ${unassignedFilePath} (unassigned workflows)`);
-    }
-}
-exports.exportWorkflowsByApp = exportWorkflowsByApp;
-async function exportWorkflowsToFile(fileLocation, overwrite) {
-    const [allWorkflowsInOrg, allSchedules] = await Promise.all([
-        (0, event_workflow_templates_1.getExistingWorkflowTemplates)(),
-        (0, schedules_1.getExistingSchedules)(),
-    ]);
+async function exportWorkflows(fileLocation, overwrite) {
+    const allWorkflowsInOrg = await (0, event_workflow_templates_1.getExistingWorkflowTemplates)();
     const workflowsObj = { workflows: [] };
     for (const workflow of allWorkflowsInOrg) {
-        workflowsObj.workflows.push(await buildExportWorkflow(workflow, allSchedules));
-    }
-    const pathToWrite = path.resolve(process.cwd(), fileLocation);
-    await writeYamlFile(workflowsObj, pathToWrite, overwrite);
-}
-exports.exportWorkflowsToFile = exportWorkflowsToFile;
-async function buildExportWorkflow(workflow, allSchedules, appIdentifier) {
-    const exportWorkflow = lodash_1.default.pick(workflow, [
-        'identifier',
-        'name',
-        'triggerKey',
-        'isActive',
-        'messageGroup',
-        'dynamicMessageGroupId',
-        'parallelWorkerCount',
-        'workflowDefinition',
-    ]);
-    const schedules = allSchedules.filter((s) => s.ownerReference === `event-workflow-template:${workflow.id}`);
-    if (schedules.length > 0) {
-        exportWorkflow.crons = schedules.map((s) => ({ name: s.name, cron: s.cron }));
-    }
-    await (0, helper_1.populateActionIdentifiers)(exportWorkflow);
-    // Shortened keys can only be resolved back to a full action identifier on
-    // import if an appIdentifier is known. Without one (e.g. unassigned
-    // workflows), keep the full identifier so the workflow stays re-importable.
-    if (appIdentifier) {
-        (0, helper_1.extractShortActionKeys)(exportWorkflow);
-    }
-    return exportWorkflow;
-}
-async function writeYamlFile(data, absolutePath, overwrite) {
-    if (fs_1.default.existsSync(absolutePath)) {
-        await (0, file_helpers_1.safeFileOverwrite)(absolutePath, overwrite);
+        const exportWorkflow = lodash_1.default.pick(workflow, [
+            'triggerKey',
+            'workflowDefinition',
+            'name',
+            'isActive',
+            'identifier',
+            'messageGroup',
+            'dynamicMessageGroupId',
+        ]);
+        await (0, helper_1.populateActionIdentifiers)(exportWorkflow);
+        workflowsObj.workflows.push(exportWorkflow);
     }
-    fs_1.default.mkdirSync(path.dirname(absolutePath), { recursive: true });
-    fs_1.default.writeFileSync(absolutePath, js_yaml_1.default.dump(data), 'utf8');
+    await (0, file_helpers_1.saveData)(workflowsObj, fileLocation, overwrite);
 }
+exports.exportWorkflows = exportWorkflows;

package/dist/commands/workflow-templates/load.d.ts

@@ -3,7 +3,6 @@ export default class LoadWorkflowTemplates extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        dir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
@@ -12,4 +11,3 @@ export default class LoadWorkflowTemplates extends BaseCommand {
     };
     run(): Promise<void>;
 }
-export declare function importWorkflowsBySelection(dir: string): Promise<void>;

package/dist/commands/workflow-templates/load.js

@@ -1,84 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.importWorkflowsBySelection = void 0;
-const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const core_1 = require("@oclif/core");
 const login_1 = require("../../auth/login");
 const helper_1 = require("../../helpers/workflow-templates/helper");
 const basecommand_1 = require("../../basecommand");
 class LoadWorkflowTemplates extends basecommand_1.BaseCommand {
-    static description = 'Load workflow templates from a file or scan a directory for per-app workflow files';
+    static description = 'Loads your workflow from a local file';
     static examples = [
-        '$ contrail workflow-templates load <FILE_LOCATION>',
-        '$ contrail workflow-templates load',
-        '$ contrail workflow-templates load --dir ./workflows',
+        `$ contrail workflow-templates load <FILE_LOCATION>
+`,
     ];
     static flags = {
         ...basecommand_1.BaseCommand.baseFlags,
-        dir: core_1.Flags.string({
-            char: 'd',
-            description: 'Directory to scan for workflow files when no file argument is given',
-            required: false,
-            default: '.',
-        }),
     };
     static args = {
         fileLocation: core_1.Args.string({
-            description: 'A specific workflow template file to load',
-            required: false,
+            description: 'The workflow template file to load',
+            required: true,
         }),
     };
     async run() {
         await (0, login_1.authUser)();
-        if (this.args.fileLocation) {
-            await (0, helper_1.localDeployWorkflowTemplate)(this.args.fileLocation);
-        }
-        else {
-            await importWorkflowsBySelection(this.flags.dir ?? '.');
-        }
+        await (0, helper_1.localDeployWorkflowTemplate)(this.args.fileLocation);
     }
 }
 exports.default = LoadWorkflowTemplates;
-async function importWorkflowsBySelection(dir) {
-    const resolvedDir = path.resolve(process.cwd(), dir);
-    const files = fs_1.default
-        .readdirSync(resolvedDir)
-        .filter((f) => f.startsWith('workflows-') && f.endsWith('.yml'))
-        .sort();
-    if (files.length === 0) {
-        console.log(chalk_1.default.yellow(`No workflow files found in ${resolvedDir}`));
-        return;
-    }
-    const choices = files.map((f) => ({
-        name: f,
-        value: f,
-        checked: true,
-    }));
-    const { selectedFiles } = await inquirer_1.default.prompt([
-        {
-            type: 'checkbox',
-            name: 'selectedFiles',
-            message: 'Select workflow files to import (space to toggle, enter to confirm):',
-            choices,
-        },
-    ]);
-    if (selectedFiles.length === 0) {
-        console.log(chalk_1.default.yellow('No files selected — nothing imported.'));
-        return;
-    }
-    //log selected file
-    console.log(chalk_1.default.blue.bold('SELECTED WORKFLOW FILES:'));
-    selectedFiles.forEach((file) => {
-        console.log(` - ${file}`);
-    });
-    for (const file of selectedFiles) {
-        console.log(`\n${chalk_1.default.blue.bold('IMPORTING')} ${file}`);
-        await (0, helper_1.localDeployWorkflowTemplate)(path.join(dir, file));
-        console.log(`${chalk_1.default.green.bold('DONE')} ${file}`);
-    }
-}
-exports.importWorkflowsBySelection = importWorkflowsBySelection;

package/dist/helpers/app/app-config-validators.d.ts

@@ -15,7 +15,12 @@ export declare const ERROR_MESSAGES: {
     ignoredAccessGrants: string;
     invalidPermission: (permission: string) => string;
     invalidAccessGrants: (error: string) => string;
+    invalidExtensionIcon: (identifier: string) => string;
+    invalidAppliesTo: (identifier: string, problem: string) => string;
 };
+export declare function isValidExtensionIcon(icon: unknown): boolean;
+/** Icons and appliesTo are checked here, since the apps service stores what it is given. */
+export declare function validateExtensionPlacement(appDeclaration: AppDeclaration): AppConfigValidationError;
 export declare function validateAppConfig(appConfig: AppDeclaration): void;
 export declare function appVersionValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
 export declare function visibilityValidator(appDeclaration: AppDeclaration): AppConfigValidationError;

package/dist/helpers/app/app-config-validators.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAccessGrants = exports.visibilityValidator = exports.appVersionValidator = exports.validateAppConfig = exports.ERROR_MESSAGES = void 0;
+exports.validateAccessGrants = exports.visibilityValidator = exports.appVersionValidator = exports.validateAppConfig = exports.validateExtensionPlacement = exports.isValidExtensionIcon = exports.ERROR_MESSAGES = void 0;
 const tslib_1 = require("tslib");
 const interfaces_1 = require("../../interfaces");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const VALIDATORS = [appVersionValidator, visibilityValidator, validateAccessGrants];
+const VALIDATORS = [
+    appVersionValidator,
+    visibilityValidator,
+    validateAccessGrants,
+    validateExtensionPlacement,
+];
 exports.ERROR_MESSAGES = {
     missingVersionField: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
     invalidVersionField: '"version" field is not a string. Expecting a version like "1.0.0". Manually update the "version" field to be a string in the app.yml file.',
@@ -17,7 +22,101 @@ exports.ERROR_MESSAGES = {
     ignoredAccessGrants: 'App is set to public. accessGrants will be ignored.',
     invalidPermission: (permission) => `Invalid permission found in one of the accessGrants objects: ${permission}.`,
     invalidAccessGrants: (error) => `Invalid accessGrants. ${error}`,
+    invalidExtensionIcon: (identifier) => `Extension ${identifier}: icon must be a default icon name (like "line-builder"), { material: <icon name> } or { url: <SVG path or http(s) URL> }.`,
+    invalidAppliesTo: (identifier, problem) => `Extension ${identifier}: appliesTo ${problem}.`,
 };
+const STRING_LIST_FIELDS = ['typePaths', 'excludeTypePaths', 'roles'];
+const RULE_FIELDS = [...STRING_LIST_FIELDS, 'minSelected', 'maxSelected', 'label'];
+const APPLIES_TO_FIELDS = [...RULE_FIELDS, 'target', 'inputs'];
+function isValidExtensionIcon(icon) {
+    if (icon === undefined || icon === null) {
+        return true;
+    }
+    if (typeof icon === 'string') {
+        return /^[a-z0-9-]+$/.test(icon);
+    }
+    if (typeof icon !== 'object' || Array.isArray(icon) || Object.keys(icon).length !== 1) {
+        return false;
+    }
+    const { material, url } = icon;
+    if ('material' in icon) {
+        return typeof material === 'string' && /^[a-z0-9_]+$/.test(material);
+    }
+    if ('url' in icon) {
+        return typeof url === 'string' && url.length > 0 && !/^(javascript|data):/i.test(url.trim());
+    }
+    return false;
+}
+exports.isValidExtensionIcon = isValidExtensionIcon;
+function appliesToProblem(appliesTo) {
+    const problem = ruleProblem(appliesTo, APPLIES_TO_FIELDS);
+    if (problem) {
+        return problem;
+    }
+    const { target, inputs } = appliesTo;
+    if (target !== undefined) {
+        const targetProblem = ruleProblem(target, RULE_FIELDS);
+        if (targetProblem) {
+            return `target ${targetProblem}`;
+        }
+    }
+    if (inputs !== undefined) {
+        if (!Array.isArray(inputs)) {
+            return 'inputs must be a list';
+        }
+        for (const [index, input] of inputs.entries()) {
+            const inputProblem = ruleProblem(input, RULE_FIELDS);
+            if (inputProblem) {
+                return `inputs[${index}] ${inputProblem}`;
+            }
+        }
+    }
+    return undefined;
+}
+function ruleProblem(rule, allowedFields) {
+    if (typeof rule !== 'object' || rule === null || Array.isArray(rule)) {
+        return 'must be an object';
+    }
+    const fields = rule;
+    const unknownField = Object.keys(fields).find((field) => !allowedFields.includes(field));
+    if (unknownField) {
+        return `has an unknown field "${unknownField}" (use ${allowedFields.join(', ')})`;
+    }
+    for (const field of STRING_LIST_FIELDS) {
+        const value = fields[field];
+        if (value !== undefined &&
+            (!Array.isArray(value) || value.some((entry) => typeof entry !== 'string'))) {
+            return `${field} must be a list of strings`;
+        }
+    }
+    for (const [field, min] of [
+        ['minSelected', 0],
+        ['maxSelected', 1],
+    ]) {
+        const value = fields[field];
+        if (value !== undefined && (!Number.isInteger(value) || value < min)) {
+            return `${field} must be a whole number of at least ${min}`;
+        }
+    }
+    return undefined;
+}
+/** Icons and appliesTo are checked here, since the apps service stores what it is given. */
+function validateExtensionPlacement(appDeclaration) {
+    const errors = [];
+    for (const extension of appDeclaration?.extensions ?? []) {
+        if (!isValidExtensionIcon(extension.icon)) {
+            errors.push(exports.ERROR_MESSAGES.invalidExtensionIcon(extension.identifier));
+        }
+        if (extension.appliesTo !== undefined) {
+            const problem = appliesToProblem(extension.appliesTo);
+            if (problem) {
+                errors.push(exports.ERROR_MESSAGES.invalidAppliesTo(extension.identifier, problem));
+            }
+        }
+    }
+    return { errors, warnings: [] };
+}
+exports.validateExtensionPlacement = validateExtensionPlacement;
 function validateAppConfig(appConfig) {
     const errors = [];
     const warnings = [];
@@ -30,7 +129,7 @@ function validateAppConfig(appConfig) {
         logger_1.default.warn(warnings);
     }
     if (errors.length) {
-        throw new Error(`Invalid app config: \n ${errors.map((x) => x.error).join('\n')}`);
+        throw new Error(`Invalid app config: \n ${errors.map((x) => x?.error ?? x).join('\n')}`);
     }
 }
 exports.validateAppConfig = validateAppConfig;

package/dist/helpers/app/app-config-validators.spec.js

@@ -308,3 +308,49 @@ describe('validateAccessGrants', () => {
         expect(validationResult).toEqual(expectedError);
     });
 });
+describe('validateExtensionPlacement', () => {
+    const declarationWith = (extension) => ({
+        extensions: [{ identifier: 'line-builder', name: 'Line builder', ...extension }],
+    });
+    it('should accept default, Material and SVG icons, appliesTo, and extensions with neither', () => {
+        for (const icon of [
+            'line-builder',
+            { material: 'grid_on' },
+            { url: 'assets/icons/line-builder.svg' },
+            undefined,
+        ]) {
+            expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ icon }))).toEqual(validResult);
+        }
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({
+            appliesTo: {
+                typePaths: ['custom-entity:silhouette', 'item:product'],
+                excludeTypePaths: ['item:material'],
+                roles: ['family'],
+                maxSelected: 20,
+                label: 'Designs or BOMs',
+            },
+        }))).toEqual(validResult);
+    });
+    it('should name the extension whose icon or appliesTo is wrong', () => {
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ icon: { url: 'javascript:alert(1)' } })).errors).toEqual([app_config_validators_1.ERROR_MESSAGES.invalidExtensionIcon('line-builder')]);
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ appliesTo: { typePath: 'item' } })).errors[0]).toContain('unknown field "typePath"');
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ appliesTo: { maxSelected: 0 } })).errors[0]).toContain('maxSelected must be a whole number of at least 1');
+    });
+    it('should check a target and its inputs', () => {
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({
+            appliesTo: {
+                target: { typePaths: ['custom-entity:silhouette'], maxSelected: 1, label: 'a Design' },
+                inputs: [{ typePaths: ['color'], maxSelected: 30, label: 'colors' }],
+            },
+        }))).toEqual(validResult);
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ appliesTo: { inputs: [{ typePath: 'color' }] } })).errors[0]).toContain('inputs[0] has an unknown field "typePath"');
+        expect((0, app_config_validators_1.validateExtensionPlacement)(declarationWith({ appliesTo: { target: { inputs: [] } } }))
+            .errors[0]).toContain('target has an unknown field "inputs"');
+    });
+    it('should show the message when validation fails', () => {
+        expect(() => (0, app_config_validators_1.validateAppConfig)({
+            version: '1.0.0',
+            ...declarationWith({ icon: 'Bad Icon' }),
+        })).toThrow(app_config_validators_1.ERROR_MESSAGES.invalidExtensionIcon('line-builder'));
+    });
+});

package/dist/helpers/app/extensions-deployer.d.ts

@@ -1,9 +1,17 @@
 import { AppExtensionDefinition } from '@contrail/entity-types';
-import { App, AppDeclaration, ExtensionDefinitionDeclaration } from '../../interfaces';
+import { App, AppDeclaration, ExtensionAppliesToDeclaration, ExtensionDefinitionDeclaration, ExtensionIconDeclaration } from '../../interfaces';
 export declare function getExtensionDefinitionsForAppVersion(app: App): Promise<AppExtensionDefinition[]>;
+/** Entity-types' definition plus placement, which the apps service stores as declared. */
+export type PlacedExtensionDefinition = AppExtensionDefinition & {
+    icon?: ExtensionIconDeclaration;
+    appliesTo?: ExtensionAppliesToDeclaration;
+    group?: string;
+};
+/** The definition published for an app.yml extension, for a new version or an update alike. */
+export declare function buildExtensionDefinition(extension: ExtensionDefinitionDeclaration, app: App, appName?: string): PlacedExtensionDefinition;
 export declare class ExtensionsDeployer {
     deployExtensions(appDeclaration: AppDeclaration, app: App): Promise<void>;
-    deployExtension(extension: ExtensionDefinitionDeclaration, app: App, existingExtensions: Array<any>): Promise<void>;
+    deployExtension(extension: ExtensionDefinitionDeclaration, app: App, existingExtensions: Array<any>, appName?: string): Promise<void>;
     private createNewExtensionDefinition;
     private updateActionDefinition;
 }