@contrail/cli 3.4.0 → 3.4.2-alpha.1

package/dist/helpers/app/actions-deployer.js

@@ -1,123 +1,123 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionsDeployer = exports.deleteAction = exports.getActionDeclarationIdentifier = exports.getActionsForAppVersion = void 0;
-const tslib_1 = require("tslib");
-const sdk_1 = require("@contrail/sdk");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const app_template_parsers_1 = require("./app-template-parsers");
-const common_1 = require("../../common");
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const logger_1 = tslib_1.__importDefault(require("../../logger"));
-async function getActionsForAppVersion(app) {
-    return await new sdk_1.Entities().get({
-        entityName: 'event-workflow-action-definition',
-        criteria: { ownerKey: `appVersion:${app.latestAppVersionId}` },
-    });
-}
-exports.getActionsForAppVersion = getActionsForAppVersion;
-function getActionDeclarationIdentifier(actionKey, app) {
-    return `${app.identifier}@${app.latestAppVersionId}:${actionKey}`;
-}
-exports.getActionDeclarationIdentifier = getActionDeclarationIdentifier;
-async function deleteAction(actionId) {
-    return await new sdk_1.Entities().delete({
-        entityName: 'event-workflow-action-definition',
-        id: actionId,
-    });
-}
-exports.deleteAction = deleteAction;
-class ActionsDeployer {
-    async deployActions(appDeclaration, app) {
-        // FETCH ALL ACTIONS FROM THE API.
-        const existingActions = await getActionsForAppVersion(app);
-        // UPSERT / DELETE BASED ON ACTION IDENTIFIER
-        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} \tDeploying actions.`);
-        if (appDeclaration.actions) {
-            const localActionKeys = Object.keys(appDeclaration.actions);
-            if (localActionKeys?.length > 0) {
-                for (const actionKey of localActionKeys) {
-                    await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
-                }
-            }
-        }
-    }
-    async deployAction(actionKey, actionDeclaration, app, existingActions) {
-        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} \tDeploying action: ${actionKey}`);
-        const identifier = getActionDeclarationIdentifier(actionKey, app);
-        const existingDefinition = existingActions.find((ad) => ad.identifier === identifier);
-        if (!existingDefinition) {
-            await this.createNewActionDefinition(actionKey, actionDeclaration, app);
-        }
-        else {
-            await this.updateActionDefinition(existingDefinition, actionDeclaration, app);
-        }
-    }
-    async createNewActionDefinition(actionKey, actionDeclaration, app) {
-        let configProperties;
-        if (actionDeclaration?.actionConfiguration) {
-            configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
-        }
-        const newObject = {
-            identifier: getActionDeclarationIdentifier(actionKey, app),
-            name: actionDeclaration.name,
-            internal: actionDeclaration.internal,
-            ownerKey: `appVersion:${app.latestAppVersionId}`,
-            public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
-            configProperties,
-            async: actionDeclaration.async,
-        };
-        const functionString = await this.getFunction(actionDeclaration);
-        if (functionString) {
-            newObject.executeFunctionString = functionString;
-        }
-        const actionDefinition = await new sdk_1.Entities().create({
-            entityName: 'event-workflow-action-definition',
-            object: newObject,
-        });
-        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} Created new action definition: ${actionKey}`);
-        return actionDefinition;
-    }
-    async updateActionDefinition(existingActionDefinition, actionDeclaration, app) {
-        let configProperties;
-        if (actionDeclaration?.actionConfiguration) {
-            configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
-        }
-        else if (!actionDeclaration?.actionConfiguration &&
-            existingActionDefinition.configProperties) {
-            configProperties = null;
-        }
-        const updates = {
-            name: actionDeclaration.name,
-            internal: actionDeclaration.internal,
-            ownerKey: `appVersion:${app.latestAppVersionId}`,
-            public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
-            configProperties,
-            async: actionDeclaration.async,
-        };
-        const functionString = await this.getFunction(actionDeclaration);
-        if (functionString) {
-            updates.executeFunctionString = functionString;
-        }
-        const actionDefinition = await new sdk_1.Entities().update({
-            entityName: 'event-workflow-action-definition',
-            id: existingActionDefinition.id,
-            object: updates,
-        });
-        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} Updated existing action definition: ${actionDefinition.identifier}`);
-        return actionDefinition;
-    }
-    async getFunction(actionDeclaration) {
-        if (!actionDeclaration.handler) {
-            return;
-        }
-        if (!actionDeclaration.handler.endsWith('.js')) {
-            throw new Error('Action handler must be a .js file.');
-        }
-        const CURRENT_DIR = process.cwd();
-        const separator = (0, common_1.getSeparatorByPlatform)();
-        const functionLocation = CURRENT_DIR + separator + actionDeclaration.handler;
-        const content = fs_1.default.readFileSync(functionLocation);
-        return content.toString();
-    }
-}
-exports.ActionsDeployer = ActionsDeployer;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionsDeployer = exports.deleteAction = exports.getActionDeclarationIdentifier = exports.getActionsForAppVersion = void 0;
+const tslib_1 = require("tslib");
+const sdk_1 = require("@contrail/sdk");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const app_template_parsers_1 = require("./app-template-parsers");
+const common_1 = require("../../common");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+async function getActionsForAppVersion(app) {
+    return await new sdk_1.Entities().get({
+        entityName: 'event-workflow-action-definition',
+        criteria: { ownerKey: `appVersion:${app.latestAppVersionId}` },
+    });
+}
+exports.getActionsForAppVersion = getActionsForAppVersion;
+function getActionDeclarationIdentifier(actionKey, app) {
+    return `${app.identifier}@${app.latestAppVersionId}:${actionKey}`;
+}
+exports.getActionDeclarationIdentifier = getActionDeclarationIdentifier;
+async function deleteAction(actionId) {
+    return await new sdk_1.Entities().delete({
+        entityName: 'event-workflow-action-definition',
+        id: actionId,
+    });
+}
+exports.deleteAction = deleteAction;
+class ActionsDeployer {
+    async deployActions(appDeclaration, app) {
+        // FETCH ALL ACTIONS FROM THE API.
+        const existingActions = await getActionsForAppVersion(app);
+        // UPSERT / DELETE BASED ON ACTION IDENTIFIER
+        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} \tDeploying actions.`);
+        if (appDeclaration.actions) {
+            const localActionKeys = Object.keys(appDeclaration.actions);
+            if (localActionKeys?.length > 0) {
+                for (const actionKey of localActionKeys) {
+                    await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
+                }
+            }
+        }
+    }
+    async deployAction(actionKey, actionDeclaration, app, existingActions) {
+        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} \tDeploying action: ${actionKey}`);
+        const identifier = getActionDeclarationIdentifier(actionKey, app);
+        const existingDefinition = existingActions.find((ad) => ad.identifier === identifier);
+        if (!existingDefinition) {
+            await this.createNewActionDefinition(actionKey, actionDeclaration, app);
+        }
+        else {
+            await this.updateActionDefinition(existingDefinition, actionDeclaration, app);
+        }
+    }
+    async createNewActionDefinition(actionKey, actionDeclaration, app) {
+        let configProperties;
+        if (actionDeclaration?.actionConfiguration) {
+            configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
+        }
+        const newObject = {
+            identifier: getActionDeclarationIdentifier(actionKey, app),
+            name: actionDeclaration.name,
+            internal: actionDeclaration.internal,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
+            public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
+            configProperties,
+            async: actionDeclaration.async,
+        };
+        const functionString = await this.getFunction(actionDeclaration);
+        if (functionString) {
+            newObject.executeFunctionString = functionString;
+        }
+        const actionDefinition = await new sdk_1.Entities().create({
+            entityName: 'event-workflow-action-definition',
+            object: newObject,
+        });
+        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} Created new action definition: ${actionKey}`);
+        return actionDefinition;
+    }
+    async updateActionDefinition(existingActionDefinition, actionDeclaration, app) {
+        let configProperties;
+        if (actionDeclaration?.actionConfiguration) {
+            configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration);
+        }
+        else if (!actionDeclaration?.actionConfiguration &&
+            existingActionDefinition.configProperties) {
+            configProperties = null;
+        }
+        const updates = {
+            name: actionDeclaration.name,
+            internal: actionDeclaration.internal,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
+            public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
+            configProperties,
+            async: actionDeclaration.async,
+        };
+        const functionString = await this.getFunction(actionDeclaration);
+        if (functionString) {
+            updates.executeFunctionString = functionString;
+        }
+        const actionDefinition = await new sdk_1.Entities().update({
+            entityName: 'event-workflow-action-definition',
+            id: existingActionDefinition.id,
+            object: updates,
+        });
+        logger_1.default.info(`${chalk_1.default.yellow.bold('ACTION')} Updated existing action definition: ${actionDefinition.identifier}`);
+        return actionDefinition;
+    }
+    async getFunction(actionDeclaration) {
+        if (!actionDeclaration.handler) {
+            return;
+        }
+        if (!actionDeclaration.handler.endsWith('.js')) {
+            throw new Error('Action handler must be a .js file.');
+        }
+        const CURRENT_DIR = process.cwd();
+        const separator = (0, common_1.getSeparatorByPlatform)();
+        const functionLocation = CURRENT_DIR + separator + actionDeclaration.handler;
+        const content = fs_1.default.readFileSync(functionLocation);
+        return content.toString();
+    }
+}
+exports.ActionsDeployer = ActionsDeployer;

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

@@ -1,22 +1,22 @@
-import { AppDeclaration } from '../../interfaces';
-export interface AppConfigValidationError {
-    errors: string[];
-    warnings: string[];
-}
-export declare const ERROR_MESSAGES: {
-    missingVersionField: string;
-    invalidVersionField: string;
-    invalidAppVersion: string;
-    accessGrantsArray: string;
-    invalidOrgSlug: string;
-    emptyPermissionsArray: string;
-    invalidVisibility: string;
-    deprecatedHiddenField: string;
-    ignoredAccessGrants: string;
-    invalidPermission: (permission: string) => string;
-    invalidAccessGrants: (error: string) => string;
-};
-export declare function validateAppConfig(appConfig: AppDeclaration): void;
-export declare function appVersionValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
-export declare function visibilityValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
-export declare function validateAccessGrants(appDeclaration: AppDeclaration): AppConfigValidationError;
+import { AppDeclaration } from '../../interfaces';
+export interface AppConfigValidationError {
+    errors: string[];
+    warnings: string[];
+}
+export declare const ERROR_MESSAGES: {
+    missingVersionField: string;
+    invalidVersionField: string;
+    invalidAppVersion: string;
+    accessGrantsArray: string;
+    invalidOrgSlug: string;
+    emptyPermissionsArray: string;
+    invalidVisibility: string;
+    deprecatedHiddenField: string;
+    ignoredAccessGrants: string;
+    invalidPermission: (permission: string) => string;
+    invalidAccessGrants: (error: string) => string;
+};
+export declare function validateAppConfig(appConfig: AppDeclaration): void;
+export declare function appVersionValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
+export declare function visibilityValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
+export declare function validateAccessGrants(appDeclaration: AppDeclaration): AppConfigValidationError;

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

@@ -1,100 +1,100 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAccessGrants = exports.visibilityValidator = exports.appVersionValidator = exports.validateAppConfig = 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];
-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.',
-    invalidAppVersion: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
-    accessGrantsArray: 'accessGrants must be an array.',
-    invalidOrgSlug: 'Invalid or missing orgSlug in one of the accessGrants objects.',
-    emptyPermissionsArray: 'Permissions must be a non-empty array in one of the accessGrants objects.',
-    invalidVisibility: 'Invalid visibility. Visibility must be "public" or "private".',
-    deprecatedHiddenField: 'The "hidden" field is deprecated.',
-    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}`,
-};
-function validateAppConfig(appConfig) {
-    const errors = [];
-    const warnings = [];
-    for (const validator of VALIDATORS) {
-        const validation = validator(appConfig);
-        errors.push(...validation.errors);
-        warnings.push(...validation.warnings);
-    }
-    if (warnings.length) {
-        logger_1.default.warn(warnings);
-    }
-    if (errors.length) {
-        throw new Error(`Invalid app config: \n ${errors.map((x) => x.error).join('\n')}`);
-    }
-}
-exports.validateAppConfig = validateAppConfig;
-function appVersionValidator(appDeclaration) {
-    const errors = [];
-    const warnings = [];
-    if (!appDeclaration.version) {
-        errors.push(exports.ERROR_MESSAGES.missingVersionField);
-        return { errors, warnings };
-    }
-    if (typeof appDeclaration.version !== 'string') {
-        errors.push(exports.ERROR_MESSAGES.invalidVersionField);
-        return { errors, warnings };
-    }
-    const parts = appDeclaration.version.split('.');
-    if (parts.length !== 3) {
-        errors.push(exports.ERROR_MESSAGES.invalidAppVersion);
-    }
-    return { errors, warnings };
-}
-exports.appVersionValidator = appVersionValidator;
-function visibilityValidator(appDeclaration) {
-    const errors = [];
-    const warnings = [];
-    if (!['public', 'private'].includes(appDeclaration.visibility)) {
-        errors.push(exports.ERROR_MESSAGES.invalidVisibility);
-    }
-    if (appDeclaration.hasOwnProperty('hidden')) {
-        warnings.push(exports.ERROR_MESSAGES.deprecatedHiddenField);
-    }
-    return { errors, warnings };
-}
-exports.visibilityValidator = visibilityValidator;
-function validateAccessGrants(appDeclaration) {
-    const errors = [];
-    const warnings = [];
-    if (appDeclaration.visibility === 'public' && appDeclaration.hasOwnProperty('accessGrants')) {
-        warnings.push(exports.ERROR_MESSAGES.ignoredAccessGrants);
-    }
-    if (appDeclaration.visibility === 'private' && appDeclaration.hasOwnProperty('accessGrants')) {
-        const accessGrantsArray = appDeclaration.accessGrants;
-        if (!Array.isArray(accessGrantsArray)) {
-            errors.push(exports.ERROR_MESSAGES.accessGrantsArray);
-            return { errors, warnings };
-        }
-        for (const accessGrants of accessGrantsArray) {
-            if (!accessGrants?.orgSlug || accessGrants?.orgSlug.trim() === '') {
-                errors.push(exports.ERROR_MESSAGES.invalidOrgSlug);
-            }
-            if (!Array.isArray(accessGrants?.permissions) || accessGrants?.permissions.length === 0) {
-                errors.push(exports.ERROR_MESSAGES.emptyPermissionsArray);
-            }
-            if (Array.isArray(accessGrants?.permissions)) {
-                for (const permission of accessGrants.permissions) {
-                    if (!isValidPermission(permission)) {
-                        errors.push(exports.ERROR_MESSAGES.invalidPermission(permission));
-                    }
-                }
-            }
-        }
-    }
-    return { errors, warnings };
-}
-exports.validateAccessGrants = validateAccessGrants;
-function isValidPermission(permission) {
-    return Object.values(interfaces_1.AppAccessPermission).includes(permission);
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAccessGrants = exports.visibilityValidator = exports.appVersionValidator = exports.validateAppConfig = 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];
+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.',
+    invalidAppVersion: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+    accessGrantsArray: 'accessGrants must be an array.',
+    invalidOrgSlug: 'Invalid or missing orgSlug in one of the accessGrants objects.',
+    emptyPermissionsArray: 'Permissions must be a non-empty array in one of the accessGrants objects.',
+    invalidVisibility: 'Invalid visibility. Visibility must be "public" or "private".',
+    deprecatedHiddenField: 'The "hidden" field is deprecated.',
+    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}`,
+};
+function validateAppConfig(appConfig) {
+    const errors = [];
+    const warnings = [];
+    for (const validator of VALIDATORS) {
+        const validation = validator(appConfig);
+        errors.push(...validation.errors);
+        warnings.push(...validation.warnings);
+    }
+    if (warnings.length) {
+        logger_1.default.warn(warnings);
+    }
+    if (errors.length) {
+        throw new Error(`Invalid app config: \n ${errors.map((x) => x.error).join('\n')}`);
+    }
+}
+exports.validateAppConfig = validateAppConfig;
+function appVersionValidator(appDeclaration) {
+    const errors = [];
+    const warnings = [];
+    if (!appDeclaration.version) {
+        errors.push(exports.ERROR_MESSAGES.missingVersionField);
+        return { errors, warnings };
+    }
+    if (typeof appDeclaration.version !== 'string') {
+        errors.push(exports.ERROR_MESSAGES.invalidVersionField);
+        return { errors, warnings };
+    }
+    const parts = appDeclaration.version.split('.');
+    if (parts.length !== 3) {
+        errors.push(exports.ERROR_MESSAGES.invalidAppVersion);
+    }
+    return { errors, warnings };
+}
+exports.appVersionValidator = appVersionValidator;
+function visibilityValidator(appDeclaration) {
+    const errors = [];
+    const warnings = [];
+    if (!['public', 'private'].includes(appDeclaration.visibility)) {
+        errors.push(exports.ERROR_MESSAGES.invalidVisibility);
+    }
+    if (appDeclaration.hasOwnProperty('hidden')) {
+        warnings.push(exports.ERROR_MESSAGES.deprecatedHiddenField);
+    }
+    return { errors, warnings };
+}
+exports.visibilityValidator = visibilityValidator;
+function validateAccessGrants(appDeclaration) {
+    const errors = [];
+    const warnings = [];
+    if (appDeclaration.visibility === 'public' && appDeclaration.hasOwnProperty('accessGrants')) {
+        warnings.push(exports.ERROR_MESSAGES.ignoredAccessGrants);
+    }
+    if (appDeclaration.visibility === 'private' && appDeclaration.hasOwnProperty('accessGrants')) {
+        const accessGrantsArray = appDeclaration.accessGrants;
+        if (!Array.isArray(accessGrantsArray)) {
+            errors.push(exports.ERROR_MESSAGES.accessGrantsArray);
+            return { errors, warnings };
+        }
+        for (const accessGrants of accessGrantsArray) {
+            if (!accessGrants?.orgSlug || accessGrants?.orgSlug.trim() === '') {
+                errors.push(exports.ERROR_MESSAGES.invalidOrgSlug);
+            }
+            if (!Array.isArray(accessGrants?.permissions) || accessGrants?.permissions.length === 0) {
+                errors.push(exports.ERROR_MESSAGES.emptyPermissionsArray);
+            }
+            if (Array.isArray(accessGrants?.permissions)) {
+                for (const permission of accessGrants.permissions) {
+                    if (!isValidPermission(permission)) {
+                        errors.push(exports.ERROR_MESSAGES.invalidPermission(permission));
+                    }
+                }
+            }
+        }
+    }
+    return { errors, warnings };
+}
+exports.validateAccessGrants = validateAccessGrants;
+function isValidPermission(permission) {
+    return Object.values(interfaces_1.AppAccessPermission).includes(permission);
+}

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

@@ -1 +1 @@
-export {};
+export {};