@contrail/cli 1.0.2 → 1.0.3

package/lib/deploy-app/actions-deployer.js

@@ -1,75 +1,86 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import fs from 'fs';
-export class ActionsDeployer {
-    async deployActions(appDeclaration, app) {
-        // FETCH ALL ACTIONS FROM THE API.
-        const existingActions = await this.getActionsForApp(app);
-        // UPSERT / DELETE BASED ON ACTION IDENTIFIER
-        console.log('%s \tDeploying actions.', chalk.yellow.bold('ACTION'));
-        for (const actionKey of Object.keys(appDeclaration.actions)) {
-            await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
-        }
-    }
-    async getActionsForApp(app) {
-        return await new Entities().get({ entityName: 'event-workflow-action-definition',
-            criteria: { ownerKey: `app:${app.id}` } });
-    }
-    async deployAction(actionKey, actionDeclaration, app, existingActions) {
-        console.log(`%s \tDeploying action: ${actionKey}`, chalk.yellow.bold('ACTION'));
-        const identifier = this.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);
-        }
-    }
-    async createNewActionDefinition(actionKey, actionDeclaration, app) {
-        const newObject = {
-            identifier: this.getActionDeclarationIdentifier(actionKey, app),
-            name: actionDeclaration.name,
-            ownerKey: `app:${app.id}`,
-            public: !app.private,
-        };
-        const functionString = await this.getFunction(actionDeclaration);
-        if (functionString) {
-            newObject.executeFunctionString = functionString;
-        }
-        const actionDefinition = await new Entities().create({
-            entityName: 'event-workflow-action-definition',
-            object: newObject
-        });
-        console.log(`%s      Created new action defintion: ${actionKey}`, chalk.yellow.bold('APP'));
-        return actionDefinition;
-    }
-    async updateActionDefinition(existingActionDefinition, actionDeclaration) {
-        const updates = {
-            name: actionDeclaration.name,
-        };
-        const functionString = await this.getFunction(actionDeclaration);
-        if (functionString) {
-            updates.executeFunctionString = functionString;
-        }
-        const actionDefinition = await new Entities().update({
-            entityName: 'event-workflow-action-definition',
-            id: existingActionDefinition.id,
-            object: updates
-        });
-        console.log(`%s      Updated existingaction defintion: ${actionDefinition.identifier}`, chalk.yellow.bold('APP'));
-        return actionDefinition;
-    }
-    getActionDeclarationIdentifier(actionKey, app) {
-        return app.identifier + ':' + actionKey;
-    }
-    async getFunction(actionDeclaration) {
-        if (!actionDeclaration.handler) {
-            return;
-        }
-        const CURRENT_DIR = process.cwd();
-        const functionLocaiton = CURRENT_DIR + '\\' + actionDeclaration.handler;
-        const content = fs.readFileSync(functionLocaiton);
-        return content.toString();
-    }
-}
+import { Entities } from '@contrail/sdk';
+import chalk from 'chalk';
+import { ConfigPropertiesParser } from './app-template-parsers';
+import fs from 'fs';
+export class ActionsDeployer {
+    async deployActions(appDeclaration, app) {
+        // FETCH ALL ACTIONS FROM THE API.
+        const existingActions = await this.getActionsForApp(app);
+        // UPSERT / DELETE BASED ON ACTION IDENTIFIER
+        console.log('%s \tDeploying actions.', chalk.yellow.bold('ACTION'));
+        for (const actionKey of Object.keys(appDeclaration.actions)) {
+            await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
+        }
+    }
+    async getActionsForApp(app) {
+        return await new Entities().get({
+            entityName: 'event-workflow-action-definition',
+            criteria: { ownerKey: `app:${app.id}` },
+        });
+    }
+    async deployAction(actionKey, actionDeclaration, app, existingActions) {
+        console.log(`%s \tDeploying action: ${actionKey}`, chalk.yellow.bold('ACTION'));
+        const identifier = this.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);
+        }
+    }
+    async createNewActionDefinition(actionKey, actionDeclaration, app) {
+        const newObject = {
+            identifier: this.getActionDeclarationIdentifier(actionKey, app),
+            name: actionDeclaration.name,
+            ownerKey: `app:${app.id}`,
+            public: app.public,
+            configProperties: ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration),
+        };
+        const functionString = await this.getFunction(actionDeclaration);
+        if (functionString) {
+            newObject.executeFunctionString = functionString;
+        }
+        const actionDefinition = await new Entities().create({
+            entityName: 'event-workflow-action-definition',
+            object: newObject,
+        });
+        console.log(`%s      Created new action definition: ${actionKey}`, chalk.yellow.bold('APP'));
+        return actionDefinition;
+    }
+    async updateActionDefinition(existingActionDefinition, actionDeclaration) {
+        const updates = {
+            name: actionDeclaration.name,
+            // public: actionDeclaration.public, // TODO - an actions visibility is allowed to change
+            configProperties: ConfigPropertiesParser.getConfigProperties(actionDeclaration.actionConfiguration),
+        };
+        const functionString = await this.getFunction(actionDeclaration);
+        if (functionString) {
+            updates.executeFunctionString = functionString;
+        }
+        const actionDefinition = await new Entities().update({
+            entityName: 'event-workflow-action-definition',
+            id: existingActionDefinition.id,
+            object: updates,
+        });
+        console.log(`%s      Updated existingaction defintion: ${actionDefinition.identifier}`, chalk.yellow.bold('APP'));
+        return actionDefinition;
+    }
+    getActionDeclarationIdentifier(actionKey, app) {
+        return app.identifier + ':' + actionKey;
+    }
+    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 isWin = process.platform === 'win32';
+        const separator = isWin ? '\\' : '/';
+        const functionLocaiton = CURRENT_DIR + separator + actionDeclaration.handler;
+        const content = fs.readFileSync(functionLocaiton);
+        return content.toString();
+    }
+}

package/lib/deploy-app/app-deployer.d.ts

@@ -1,10 +1,8 @@
-import { AppDeclartion } from './interfaces';
-export declare class AppDeployer {
-    private app;
-    deploy(appDeclaration: AppDeclartion): Promise<void>;
-    remove(appDeclaration: AppDeclartion): Promise<void>;
-    getExistingApp(appDeclaration: AppDeclartion): Promise<any>;
-    updateExistingApp(appDeclaration: AppDeclartion, existingApp: any): Promise<any>;
-    private createNewApp;
-    private getAppConfigProperties;
-}
+import { App, AppDeclaration } from './interfaces';
+export declare class AppDeployer {
+    deploy(appDeclaration: AppDeclaration): Promise<void>;
+    getExistingApp(appDeclaration: AppDeclaration): Promise<App>;
+    private createNewApp;
+    updateExistingApp(appDeclaration: AppDeclaration, existingApp: any): Promise<any>;
+    remove(appDeclaration: AppDeclaration): Promise<void>;
+}

package/lib/deploy-app/app-deployer.js

@@ -1,84 +1,79 @@
-import { Entities } from '@contrail/sdk';
-import chalk from 'chalk';
-import { Auth } from '../auth/auth';
-import { ActionsDeployer } from './actions-deployer';
-export class AppDeployer {
-    async deploy(appDeclaration) {
-        let app = await this.getExistingApp(appDeclaration);
-        if (!app) {
-            app = await this.createNewApp(appDeclaration);
-        }
-        else {
-            app = await this.updateExistingApp(appDeclaration, app);
-        }
-        this.app = app;
-        await new ActionsDeployer().deployActions(appDeclaration, this.app);
-    }
-    async remove(appDeclaration) {
-        let app = await this.getExistingApp(appDeclaration);
-        if (app) {
-            app = await new Entities().delete({ entityName: 'app', id: app.id });
-            console.log(`%s      Deleted app: ${app.name}`, chalk.yellow.bold('APP'));
-        }
-        else {
-            console.log(`%s      App not found. Can not remove`, chalk.red.bold('APP'));
-        }
-    }
-    async getExistingApp(appDeclaration) {
-        const orgId = Auth.config.orgId;
-        const apps = await new Entities().get({ entityName: 'app', criteria: {
-                orgId,
-                private: (appDeclaration.visibility === 'private')
-            },
-        });
-        //    console.log('Existing: ', apps);
-        return apps.find(app => app.identifier === appDeclaration.appIdentifier);
-    }
-    async updateExistingApp(appDeclaration, existingApp) {
-        const updates = {
-            name: appDeclaration.appName,
-            public: appDeclaration.visibility === 'public',
-            description: appDeclaration.appDescription,
-            publisher: appDeclaration.publisher,
-            thumbnail: appDeclaration.thumbnail,
-            eventWorkflowTriggerKeyMapping: 'NONE',
-            keywords: appDeclaration.keywords,
-            configProperties: this.getAppConfigProperties(appDeclaration),
-        };
-        const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
-        console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));
-        return app;
-    }
-    async createNewApp(appDeclaration) {
-        const newApp = {
-            identifier: appDeclaration.appIdentifier,
-            name: appDeclaration.appName,
-            public: appDeclaration.visibility === 'public',
-            description: appDeclaration.appDescription,
-            publisher: appDeclaration.publisher,
-            thumbnail: appDeclaration.thumbnail,
-            eventWorkflowTriggerKeyMapping: 'NONE',
-            keywords: appDeclaration.keywords,
-            configProperties: this.getAppConfigProperties(appDeclaration),
-        };
-        const app = await new Entities().create({ entityName: 'app', object: newApp });
-        console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
-        return app;
-    }
-    getAppConfigProperties(appDeclaration) {
-        const appConfiguration = [];
-        for (const configKey of Object.keys(appDeclaration.appConfiguration)) {
-            const declaration = appDeclaration.appConfiguration[configKey];
-            const config = {
-                label: declaration.label,
-                slug: configKey,
-                propertyType: declaration.propertyType,
-            };
-            if (declaration.options) {
-                config.options = declaration.options;
-            }
-            appConfiguration.push(config);
-        }
-        return appConfiguration;
-    }
-}
+import { Entities } from '@contrail/sdk';
+import chalk from 'chalk';
+import { Auth } from '../auth/auth';
+import { ActionsDeployer } from './actions-deployer';
+import { TriggerKeyDefinitionParser, ConfigPropertiesParser } from './app-template-parsers';
+export class AppDeployer {
+    async deploy(appDeclaration) {
+        let app = await this.getExistingApp(appDeclaration);
+        if (!app) {
+            app = await this.createNewApp(appDeclaration);
+        }
+        else {
+            app = await this.updateExistingApp(appDeclaration, app);
+        }
+        await new ActionsDeployer().deployActions(appDeclaration, app);
+    }
+    async getExistingApp(appDeclaration) {
+        const orgId = Auth.config.orgId;
+        const apps = [];
+        apps.push(...await new Entities().get({
+            entityName: 'app',
+            criteria: {
+                orgId,
+                private: true,
+            },
+        }));
+        apps.push(...await new Entities().get({
+            entityName: 'app',
+            criteria: {
+                orgId,
+                private: false,
+            },
+        }));
+        return apps.find(app => app.identifier === appDeclaration.appIdentifier);
+    }
+    async createNewApp(appDeclaration) {
+        const newApp = {
+            identifier: appDeclaration.appIdentifier,
+            name: appDeclaration.appName,
+            public: appDeclaration.visibility === 'public',
+            description: appDeclaration.appDescription,
+            publisher: appDeclaration.publisher,
+            thumbnail: appDeclaration.thumbnail,
+            eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
+            keywords: appDeclaration.keywords,
+            configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
+            triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+        };
+        const app = await new Entities().create({ entityName: 'app', object: newApp });
+        console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
+        return app;
+    }
+    async updateExistingApp(appDeclaration, existingApp) {
+        const updates = {
+            name: appDeclaration.appName,
+            public: appDeclaration.visibility === 'public',
+            description: appDeclaration.appDescription,
+            publisher: appDeclaration.publisher,
+            thumbnail: appDeclaration.thumbnail,
+            eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
+            keywords: appDeclaration.keywords,
+            configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
+            triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+        };
+        const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
+        console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));
+        return app;
+    }
+    async remove(appDeclaration) {
+        let app = await this.getExistingApp(appDeclaration);
+        if (app) {
+            app = await new Entities().delete({ entityName: 'app', id: app.id });
+            console.log(`%s      Deleted app: ${app.name}`, chalk.yellow.bold('APP'));
+        }
+        else {
+            throw new Error('App not found.');
+        }
+    }
+}

package/lib/deploy-app/app-template-parsers.d.ts

@@ -0,0 +1,7 @@
+import { AppDeclaration, TriggerKeyDefinition, ConfigPropertyElements } from './interfaces';
+export declare class TriggerKeyDefinitionParser {
+    static buildTriggersArray(appDeclaration: AppDeclaration): Array<TriggerKeyDefinition>;
+}
+export declare class ConfigPropertiesParser {
+    static getConfigProperties(configPropertyElements: ConfigPropertyElements): any[];
+}

package/lib/deploy-app/app-template-parsers.js

@@ -0,0 +1,37 @@
+export class TriggerKeyDefinitionParser {
+    static buildTriggersArray(appDeclaration) {
+        const triggers = [];
+        for (const triggerName of Object.keys(appDeclaration.triggers)) {
+            const triggerDeclaration = appDeclaration.triggers[triggerName];
+            const triggerDefinition = {
+                triggerKey: triggerDeclaration.external ? `${appDeclaration.appIdentifier}:${triggerDeclaration.key}` : triggerDeclaration.key,
+                name: triggerDeclaration.name,
+                external: triggerDeclaration.external,
+                description: triggerDeclaration.description,
+            };
+            if (!triggerDefinition.triggerKey || !triggerDefinition.name) {
+                throw new Error('Illegal trigger declaration: must have key and name');
+            }
+            triggers.push(triggerDefinition);
+        }
+        return triggers;
+    }
+}
+export class ConfigPropertiesParser {
+    static getConfigProperties(configPropertyElements) {
+        const appConfiguration = [];
+        for (const configKey of Object.keys(configPropertyElements)) {
+            const declaration = configPropertyElements[configKey];
+            const config = {
+                label: declaration.label,
+                slug: configKey,
+                propertyType: declaration.propertyType,
+            };
+            if (declaration.options) {
+                config.options = declaration.options;
+            }
+            appConfiguration.push(config);
+        }
+        return appConfiguration;
+    }
+}

package/lib/deploy-app/deploy.d.ts

@@ -1,2 +1,2 @@
-export declare function deployApp(args: any): Promise<void>;
-export declare function removeApp(args: any): Promise<void>;
+export declare function deployApp(args: any): Promise<void>;
+export declare function removeApp(args: any): Promise<void>;

package/lib/deploy-app/deploy.js

@@ -1,30 +1,56 @@
-import chalk from 'chalk';
-import fs from 'fs';
-import { authUser } from '../auth/login';
-import { AppDeployer } from './app-deployer';
-const yaml = require('js-yaml');
-function loadAppConfig() {
-    const TARGET_DIR = process.cwd();
-    try {
-        const doc = yaml.load(fs.readFileSync(TARGET_DIR + '/app.yml', 'utf8'));
-        console.log(doc);
-        return doc;
-    }
-    catch (e) {
-        console.log('ERROR PARSING YAML: ', e);
-    }
-}
-export async function deployApp(args) {
-    const appDeclaration = loadAppConfig();
-    console.log(`%s Deploying application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
-    const user = await authUser();
-    await new AppDeployer().deploy(appDeclaration);
-    console.log('%s Deployment complete.', chalk.green.bold('COMPLETE'));
-}
-export async function removeApp(args) {
-    const appDeclaration = loadAppConfig();
-    console.log(`%s Removing application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
-    await authUser();
-    await new AppDeployer().remove(appDeclaration);
-    console.log('%s Removing complete.', chalk.green.bold('COMPLETE'));
-}
+import chalk from 'chalk';
+import fs from 'fs';
+import { authUser } from '../auth/login';
+import { AppDeployer } from './app-deployer';
+const yaml = require('js-yaml');
+function loadAppConfig() {
+    const TARGET_DIR = process.cwd();
+    try {
+        const doc = yaml.load(fs.readFileSync(TARGET_DIR + '/app.yml', 'utf8'));
+        console.log(doc);
+        return doc;
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING YAML: ${e}`);
+    }
+}
+export async function deployApp(args) {
+    let appDeclaration;
+    try {
+        appDeclaration = loadAppConfig();
+    }
+    catch (e) {
+        console.log(`%s Application Deployment Failed. ${e}`, chalk.red.bold('FAIL'));
+        return;
+    }
+    console.log(`%s Deploying Application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
+    try {
+        await authUser();
+        await new AppDeployer().deploy(appDeclaration);
+    }
+    catch (e) {
+        console.log(`%s Application Deployment Failed. ${e}`, chalk.red.bold('FAIL'));
+        return;
+    }
+    console.log('%s Deployment Complete.', chalk.green.bold('COMPLETE'));
+}
+export async function removeApp(args) {
+    let appDeclaration;
+    try {
+        appDeclaration = loadAppConfig();
+    }
+    catch (e) {
+        console.log(`%s Application Removal Failed. ${e}`, chalk.red.bold('FAIL'));
+        return;
+    }
+    console.log(`%s Removing Application. ${appDeclaration.appIdentifier}`, chalk.blue.bold('START'));
+    try {
+        await authUser();
+        await new AppDeployer().remove(appDeclaration);
+    }
+    catch (e) {
+        console.log(`%s Application Removal Failed. ${e}`, chalk.red.bold('FAIL'));
+        return;
+    }
+    console.log('%s Application Removal Complete.', chalk.green.bold('COMPLETE'));
+}

package/lib/deploy-app/interfaces.d.ts

@@ -1,43 +1,74 @@
-/** Describes the derivative JSON / object represented
- * in app.yml file.
- */
-export interface AppDeclartion {
-    appIdentifier: string;
-    appName: string;
-    appDescription?: string;
-    visibility: 'private' | 'public';
-    publisher: string;
-    version: string;
-    thumbnail?: string;
-    keywords?: Array<string>;
-    actions?: {
-        [key: string]: AppActionDeclaration;
-    };
-    appConfiguration: {
-        [key: string]: AppConfigurationElement;
-    };
-}
-export interface AppConfigurationElement {
-    propertyType: string;
-    options?: any[];
-    label: string;
-}
-export interface AppActionDeclaration {
-    handler: string;
-    name: string;
-    description?: string;
-}
-export interface App {
-    id: string;
-    identifier: string;
-    name: string;
-    private: boolean;
-}
-export interface EventWorkflowActionDefinition {
-    id?: string;
-    identifier?: string;
-    name?: string;
-    executeFunctionString?: string;
-    ownerKey?: string;
-    public?: boolean;
-}
+/** Describes the derivative JSON / object represented
+ * in app.yml file.
+ */
+export interface AppDeclaration {
+    appIdentifier: string;
+    appName: string;
+    appDescription?: string;
+    visibility: 'private' | 'public';
+    publisher: string;
+    version: string;
+    eventWorkflowTriggerKeyMapping: string;
+    thumbnail?: string;
+    keywords?: Array<string>;
+    actions?: {
+        [key: string]: AppActionDeclaration;
+    };
+    appConfiguration: ConfigPropertyElements;
+    triggers: {
+        [key: string]: AppTriggerDeclaration;
+    };
+}
+export interface ConfigPropertyElements {
+    [key: string]: ConfigPropertyElement;
+}
+export interface ConfigPropertyElement {
+    propertyType: string;
+    options?: any[];
+    label: string;
+}
+export interface AppActionDeclaration {
+    handler: string;
+    name: string;
+    description?: string;
+    actionConfiguration: ConfigPropertyElements;
+}
+export interface AppTriggerDeclaration {
+    key: string;
+    name: string;
+    external?: boolean;
+    description?: string;
+}
+export interface App {
+    id: string;
+    identifier: string;
+    name: string;
+    public: boolean;
+    description?: string;
+    publisher: string;
+    thumbnail: string;
+    eventWorkflowTriggerKeyMapping: string;
+    configProperties?: ConfigProperty[];
+    triggerKeyDefinitions?: TriggerKeyDefinition[];
+}
+export declare class ConfigProperty {
+    slug: string;
+    propertyType: string;
+    options?: any[];
+    label: string;
+}
+export interface EventWorkflowActionDefinition {
+    id?: string;
+    identifier?: string;
+    name?: string;
+    executeFunctionString?: string;
+    ownerKey?: string;
+    public?: boolean;
+    configProperties?: ConfigProperty[];
+}
+export declare class TriggerKeyDefinition {
+    name: string;
+    description?: string;
+    triggerKey: string;
+    external?: boolean;
+}

package/lib/deploy-app/interfaces.js

@@ -0,0 +1,4 @@
+export class ConfigProperty {
+}
+export class TriggerKeyDefinition {
+}