@contrail/cli 1.0.71 → 2.0.1

package/{templates → dist/templates}/typescript/app.yml

@@ -1,50 +1,50 @@
-appIdentifier: "@your-co/app-name"  # Change to be your company root domain and the name of the app
-appName: "Your App Name" # Give your app a name
-appDescription: "Your app description." # Give your app a description
-visibility: private  # This should be private unless you want to develop an app for all VibeIQ customers to use
-publisher: "Your company name" # Your company name, used for public apps
-version: 1.0
-dockerImageRef: CHANGE_ME  # For VibeIQ Deployment... for use by VibeIQ employees only
-
-# Properties you can configure when you install the app.
-# These property values will be available to all of your actions when they run
-appConfiguration:
-  apiHost:
-    label: "API Host"
-    propertyType: "string"
-
-
-# Action declarations.  You define actions here.  The 'slug' for the action
-# should match the name of a 'handler' in the /actions folder.
-# See documentation on how to implement actions.
-actions:
-  logItem:
-    name: "Log Item"
-    description: "Fetches an item from the API and returns it to the log."
-    async: false
-    actionConfiguration:
-      message:
-        label: "Additional message to log."
-        propertyType: "string"
-
-workflows:
-  logItemUpdate:
-    name: "Item Update -> Log"
-    triggerKey: item|update
-    isActive: true
-    public: true
-    workflowDefinition:
-      paths:
-        - conditional: "true"
-          actionDefinitionConfigs:
-            - action: logItem
-              name: Log Item
-
-
-# This is an advanced feature that can 'derive' a trigger key for external events.
-# External events are events sent to the VibeIQ API's /external-events end point from another system
-# Here, you can define a string based on properties from the event payloads (which are custom to your payload)
-# i.e. an event {details: {eventType: 'apparel'}, actionType: 'create'} can be parsed to apparel|create with the following
-# When this is defined, any event coming from your app's credentials will define a trigger key using this logic.
-# You can then define workflows to run based on those external events, based on this triggger key definition.
+appIdentifier: "@your-co/app-name"  # Change to be your company root domain and the name of the app
+appName: "Your App Name" # Give your app a name
+appDescription: "Your app description." # Give your app a description
+visibility: private  # This should be private unless you want to develop an app for all VibeIQ customers to use
+publisher: "Your company name" # Your company name, used for public apps
+version: 1.0
+dockerImageRef: CHANGE_ME  # For VibeIQ Deployment... for use by VibeIQ employees only
+
+# Properties you can configure when you install the app.
+# These property values will be available to all of your actions when they run
+appConfiguration:
+  apiHost:
+    label: "API Host"
+    propertyType: "string"
+
+
+# Action declarations.  You define actions here.  The 'slug' for the action
+# should match the name of a 'handler' in the /actions folder.
+# See documentation on how to implement actions.
+actions:
+  logItem:
+    name: "Log Item"
+    description: "Fetches an item from the API and returns it to the log."
+    async: false
+    actionConfiguration:
+      message:
+        label: "Additional message to log."
+        propertyType: "string"
+
+workflows:
+  logItemUpdate:
+    name: "Item Update -> Log"
+    triggerKey: item|update
+    isActive: true
+    public: true
+    workflowDefinition:
+      paths:
+        - conditional: "true"
+          actionDefinitionConfigs:
+            - action: logItem
+              name: Log Item
+
+
+# This is an advanced feature that can 'derive' a trigger key for external events.
+# External events are events sent to the VibeIQ API's /external-events end point from another system
+# Here, you can define a string based on properties from the event payloads (which are custom to your payload)
+# i.e. an event {details: {eventType: 'apparel'}, actionType: 'create'} can be parsed to apparel|create with the following
+# When this is defined, any event coming from your app's credentials will define a trigger key using this logic.
+# You can then define workflows to run based on those external events, based on this triggger key definition.
 eventWorkflowTriggerKeyMapping: "{details.eventType}|{actionType}"

package/{templates → dist/templates}/typescript/docker_deploy.bat

@@ -1 +1 @@
-npm run docker-ecr-login:win && npm version patch && npm run docker-build:win && npm run docker-tag:win && npm run docker-push:win
+npm run docker-ecr-login:win && npm version patch && npm run docker-build:win && npm run docker-tag:win && npm run docker-push:win

package/{templates → dist/templates}/typescript/package.json

@@ -1,54 +1,54 @@
-{
-  "name": "test-app",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "bin": {
-    "@contrail/contrail-cli": "bin/init",
-    "contrail": "bin/init"
-  },
-  "config": {
-    "wf": "/workflow-actions-prod"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "nodemon --watch \"src/**/*.ts\" --exec ts-node src/framework/mock-server.ts",
-    "debug": "nodemon -r ts-node/register --inspect=127.0.0.1:60002 --watch 'actions/**/*.ts' --exec node src/framework/mock-server.ts",
-    "lint": "eslint . --fix",
-    "test": "jest",
-    "test-watch": "jest --watch",
-    "docker-build": "docker build . -t \"${npm_package_name}:${npm_package_version}\"",
-    "docker-build:win": "docker build . -t \"%npm_package_name%:%npm_package_version%\"",
-    "docker-run-entry": "docker run -it --entrypoint=/bin/bash \"${npm_package_name}:${npm_package_version}\"",
-    "docker-run-entry:win": "docker run -it --entrypoint=/bin/bash \"%npm_package_name%:%npm_package_version%\"",
-    "docker-run": "docker run --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"${npm_package_name}:${npm_package_version}\"",
-    "docker-run:win": "docker run  --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"%npm_package_name%:%npm_package_version%\"",
-    "docker-ecr-login": "aws ecr get-login-password | docker login --username AWS --password-stdin ${AWS_REGISTRY}",
-    "docker-ecr-login:win": "aws ecr get-login-password | docker login --username AWS --password-stdin %AWS_REGISTRY%",
-    "docker-tag": "docker tag ${npm_package_name}:${npm_package_version} \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
-    "docker-tag:win": "docker tag %npm_package_name%:%npm_package_version% %AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%",
-    "docker-push": "docker push \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
-    "docker-push:win": "docker push \"%AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%\""
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@contrail/sdk": "^1.1.54",
-    "chalk": "^4.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^18.14.6",
-    "body-parser": "^1.20.2",
-    "express": "^4.18.2",
-    "jest": "^29.2.2",
-    "js-yaml": "^4.1.0",
-    "nodemon": "^1.19.4",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^7.0.1",
-    "typescript": "^4.7.4"
-  }
-}
+{
+  "name": "test-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "bin": {
+    "@contrail/contrail-cli": "bin/init",
+    "contrail": "bin/init"
+  },
+  "config": {
+    "wf": "/workflow-actions-prod"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "nodemon --watch \"src/**/*.ts\" --exec ts-node src/framework/mock-server.ts",
+    "debug": "nodemon -r ts-node/register --inspect=127.0.0.1:60002 --watch 'actions/**/*.ts' --exec node src/framework/mock-server.ts",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test-watch": "jest --watch",
+    "docker-build": "docker build . -t \"${npm_package_name}:${npm_package_version}\"",
+    "docker-build:win": "docker build . -t \"%npm_package_name%:%npm_package_version%\"",
+    "docker-run-entry": "docker run -it --entrypoint=/bin/bash \"${npm_package_name}:${npm_package_version}\"",
+    "docker-run-entry:win": "docker run -it --entrypoint=/bin/bash \"%npm_package_name%:%npm_package_version%\"",
+    "docker-run": "docker run --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"${npm_package_name}:${npm_package_version}\"",
+    "docker-run:win": "docker run  --env CONTRAIL_CLI_ENV=DEV -p 9000:8080 \"%npm_package_name%:%npm_package_version%\"",
+    "docker-ecr-login": "aws ecr get-login-password | docker login --username AWS --password-stdin ${AWS_REGISTRY}",
+    "docker-ecr-login:win": "aws ecr get-login-password | docker login --username AWS --password-stdin %AWS_REGISTRY%",
+    "docker-tag": "docker tag ${npm_package_name}:${npm_package_version} \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
+    "docker-tag:win": "docker tag %npm_package_name%:%npm_package_version% %AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%",
+    "docker-push": "docker push \"${AWS_REGISTRY}${npm_package_config_wf}:${npm_package_name}.${npm_package_version}\"",
+    "docker-push:win": "docker push \"%AWS_REGISTRY%%npm_package_config_wf%:%npm_package_name%.%npm_package_version%\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@contrail/sdk": "^1.1.54",
+    "chalk": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.14.6",
+    "body-parser": "^1.20.2",
+    "express": "^4.18.2",
+    "jest": "^29.2.2",
+    "js-yaml": "^4.1.0",
+    "nodemon": "^1.19.4",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^7.0.1",
+    "typescript": "^4.7.4"
+  }
+}

package/{templates → dist/templates}/typescript/src/actions/logItem.ts

@@ -1,26 +1,26 @@
-import { login, Entities, setAppCredentials } from "@contrail/sdk";
-import { AppActionCallBack, AppActionCallbackStatus } from "../framework";
-import { Logger } from "../framework/logger";
-
-export async function execute(event, config: any, logger: Logger): Promise<AppActionCallBack> {
-  logger.log('Starting Example Action');
-
-
-  logger.log('Loggin in');
-  // Fetch items from the SDK
-  await setAppCredentials(config.apiKey, config.orgSlug);
-  logger.log('Getting item from SDK');
-
-  const item = await new Entities().get({
-    entityName: 'item',
-    id: event.id,
-  })
-  logger.log('Got item: ', item);  
-
-  return {
-    output: {
-      item,
-    },
-    status: AppActionCallbackStatus.SUCCESS
-  };
+import { login, Entities, setAppCredentials } from "@contrail/sdk";
+import { AppActionCallBack, AppActionCallbackStatus } from "../framework";
+import { Logger } from "../framework/logger";
+
+export async function execute(event, config: any, logger: Logger): Promise<AppActionCallBack> {
+  logger.log('Starting Example Action');
+
+
+  logger.log('Loggin in');
+  // Fetch items from the SDK
+  await setAppCredentials(config.apiKey, config.orgSlug);
+  logger.log('Getting item from SDK');
+
+  const item = await new Entities().get({
+    entityName: 'item',
+    id: event.id,
+  })
+  logger.log('Got item: ', item);  
+
+  return {
+    output: {
+      item,
+    },
+    status: AppActionCallbackStatus.SUCCESS
+  };
 }

package/{templates → dist/templates}/typescript/src/framework/action-dispatcher.ts

@@ -1,90 +1,90 @@
-/** 
- * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
- * for VibeIQ app actions.
- */
-
-
-import { setAppCredentials } from "@contrail/sdk";
-import { loadAppConfig } from "./app-config";
-import { AppActionCallbackStatus, AppActionRequest, AppActionResponse } from "./interfaces";
-import { Logger } from "./logger";
-
-const APP_CONFIG = loadAppConfig();
-const appName = APP_CONFIG.appIdentifier;
-
-export class ActionDispatcher {
-  
-  public static async dispatchActionRequest(data: AppActionRequest) : Promise<AppActionResponse> {
-    // Sets the auth creds on the SDK
-    await setAppCredentials(data.apiKey, data.orgSlug);
-
-    const logger = new Logger();
-    const event = (typeof data.event === 'string')
-      ? JSON.parse(data.event)
-      : data.event;
-
-    return ActionDispatcher.delegateToHandler(event, data, logger);
-  }
-
-  private static async delegateToHandler(event, data: AppActionRequest, logger: Logger) : Promise<AppActionResponse>{ 
-    try {
-      const handler = ActionDispatcher.getActionHandler(data);
-      let actionResults = await handler(event, data, logger)
-      let body: any = {
-        logs: logger.allEntries,
-        taskId: data.taskId,
-        status: AppActionCallbackStatus.SUCCESS,
-      };
-
-      if(typeof actionResults === 'string'){
-        body.output = { message: actionResults }
-      } else if(typeof actionResults === 'object'){
-        if(actionResults.output){
-          body.output = actionResults.output;
-        }
-        if(actionResults.status) {
-          body.status = actionResults.status;
-        }
-      } 
-      return {
-        statusCode: 200,
-        body
-      }    
-    } catch (error) {
-      console.log("Error caught in handling action: ", error)
-      return {
-        statusCode: 500,
-        body: {
-          output: {
-            errorMessage: error.message,
-          },
-          taskId: data.taskId,
-          logs: logger.allEntries,
-          status: AppActionCallbackStatus.FAILURE,
-        }
-      }    
-    }
-  }
-
-  /** Retrives the handler function for the requested action 
-  */
-  private static getActionHandler(data: AppActionRequest): (event, data, logger) => any {
-    try {
-      const actionPath = data.action;
-      const actionName = actionPath.substring(appName.length + 1, actionPath.length);
-      console.log('action: ',  actionPath, actionName);
-      const handlerFile = require(`../actions/${actionName}`);
-      if(!handlerFile) {
-        throw new Error(`Handler file could not be located for action : ${data.action}`);  
-      }   
-      const handlerFunction = handlerFile.execute;
-      if(!handlerFunction) {
-        throw new Error(`Handler function 'execute' could not be located for action : ${data.action}`);  
-      }
-      return handlerFunction;
-    } catch (error) {
-      console.log("Error caught in getActionHandler: ", error)
-      throw new Error(`Could not locate handler function for requested action: ${data.action}`);
-    }
-  }
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import { setAppCredentials } from "@contrail/sdk";
+import { loadAppConfig } from "./app-config";
+import { AppActionCallbackStatus, AppActionRequest, AppActionResponse } from "./interfaces";
+import { Logger } from "./logger";
+
+const APP_CONFIG = loadAppConfig();
+const appName = APP_CONFIG.appIdentifier;
+
+export class ActionDispatcher {
+  
+  public static async dispatchActionRequest(data: AppActionRequest) : Promise<AppActionResponse> {
+    // Sets the auth creds on the SDK
+    await setAppCredentials(data.apiKey, data.orgSlug);
+
+    const logger = new Logger();
+    const event = (typeof data.event === 'string')
+      ? JSON.parse(data.event)
+      : data.event;
+
+    return ActionDispatcher.delegateToHandler(event, data, logger);
+  }
+
+  private static async delegateToHandler(event, data: AppActionRequest, logger: Logger) : Promise<AppActionResponse>{ 
+    try {
+      const handler = ActionDispatcher.getActionHandler(data);
+      let actionResults = await handler(event, data, logger)
+      let body: any = {
+        logs: logger.allEntries,
+        taskId: data.taskId,
+        status: AppActionCallbackStatus.SUCCESS,
+      };
+
+      if(typeof actionResults === 'string'){
+        body.output = { message: actionResults }
+      } else if(typeof actionResults === 'object'){
+        if(actionResults.output){
+          body.output = actionResults.output;
+        }
+        if(actionResults.status) {
+          body.status = actionResults.status;
+        }
+      } 
+      return {
+        statusCode: 200,
+        body
+      }    
+    } catch (error) {
+      console.log("Error caught in handling action: ", error)
+      return {
+        statusCode: 500,
+        body: {
+          output: {
+            errorMessage: error.message,
+          },
+          taskId: data.taskId,
+          logs: logger.allEntries,
+          status: AppActionCallbackStatus.FAILURE,
+        }
+      }    
+    }
+  }
+
+  /** Retrives the handler function for the requested action 
+  */
+  private static getActionHandler(data: AppActionRequest): (event, data, logger) => any {
+    try {
+      const actionPath = data.action;
+      const actionName = actionPath.substring(appName.length + 1, actionPath.length);
+      console.log('action: ',  actionPath, actionName);
+      const handlerFile = require(`../actions/${actionName}`);
+      if(!handlerFile) {
+        throw new Error(`Handler file could not be located for action : ${data.action}`);  
+      }   
+      const handlerFunction = handlerFile.execute;
+      if(!handlerFunction) {
+        throw new Error(`Handler function 'execute' could not be located for action : ${data.action}`);  
+      }
+      return handlerFunction;
+    } catch (error) {
+      console.log("Error caught in getActionHandler: ", error)
+      throw new Error(`Could not locate handler function for requested action: ${data.action}`);
+    }
+  }
 }

package/{templates → dist/templates}/typescript/src/framework/app-config.ts

@@ -1,27 +1,27 @@
-/** 
- * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
- * for VibeIQ app actions.
- */
-
-
-import fs from 'fs';
-const yaml = require('js-yaml');
-
-export function loadAppConfig(){
-  const TARGET_DIR = process.cwd();
-  console.log("TARGET_DIR: ", TARGET_DIR)
-  try {
-    const separator = getSeparatorByPlatform();
-    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'app.yml', 'utf8'));
-    console.log(doc);
-    return doc;
-  } catch (e) {
-    throw new Error(`ERROR PARSING YAML: ${e}`);
-  }
-}
-
-export function getSeparatorByPlatform() {
-  const isWin = process.platform === 'win32';
-  const separator = isWin ? '\\' : '/';
-  return separator;
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import fs from 'fs';
+const yaml = require('js-yaml');
+
+export function loadAppConfig(){
+  const TARGET_DIR = process.cwd();
+  console.log("TARGET_DIR: ", TARGET_DIR)
+  try {
+    const separator = getSeparatorByPlatform();
+    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'app.yml', 'utf8'));
+    console.log(doc);
+    return doc;
+  } catch (e) {
+    throw new Error(`ERROR PARSING YAML: ${e}`);
+  }
+}
+
+export function getSeparatorByPlatform() {
+  const isWin = process.platform === 'win32';
+  const separator = isWin ? '\\' : '/';
+  return separator;
 }

package/{templates → dist/templates}/typescript/src/framework/handler.ts

@@ -1,11 +1,11 @@
-/** 
- * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
- * for VibeIQ app actions.
- */
-
-
-import { AppActionRequest, AppActionResponse, ActionDispatcher } from '.';
-
-export async function execute(data: AppActionRequest): Promise<AppActionResponse> {
-  return ActionDispatcher.dispatchActionRequest(data);
-}
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+import { AppActionRequest, AppActionResponse, ActionDispatcher } from '.';
+
+export async function execute(data: AppActionRequest): Promise<AppActionResponse> {
+  return ActionDispatcher.dispatchActionRequest(data);
+}

package/{templates → dist/templates}/typescript/src/framework/index.ts

@@ -1,3 +1,3 @@
-export * from './interfaces';
-export * from './action-dispatcher';
+export * from './interfaces';
+export * from './action-dispatcher';
 export * from './logger';

package/{templates → dist/templates}/typescript/src/framework/interfaces.ts

@@ -1,32 +1,32 @@
-/** 
- * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
- * for VibeIQ app actions.
- */
-
-export interface AppActionRequest {
-  action: string;
-  apiKey: string;
-  orgSlug: string;
-  taskId: string; 
-  event: any;
-  [key:string] : any;
-}
-
-
-export interface AppActionResponse {
-  statusCode: number;
-  body: AppActionCallBack;
-}
-
-export interface AppActionCallBack {
-  output?: any;
-  status?: AppActionCallbackStatus;
-  logs?: Array<string>;
-  taskId?: string;
-}
-
-
-export enum AppActionCallbackStatus {
-  FAILURE = 'FAILURE',
-  SUCCESS = 'SUCCESS'
-}
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+export interface AppActionRequest {
+  action: string;
+  apiKey: string;
+  orgSlug: string;
+  taskId: string; 
+  event: any;
+  [key:string] : any;
+}
+
+
+export interface AppActionResponse {
+  statusCode: number;
+  body: AppActionCallBack;
+}
+
+export interface AppActionCallBack {
+  output?: any;
+  status?: AppActionCallbackStatus;
+  logs?: Array<string>;
+  taskId?: string;
+}
+
+
+export enum AppActionCallbackStatus {
+  FAILURE = 'FAILURE',
+  SUCCESS = 'SUCCESS'
+}

package/{templates → dist/templates}/typescript/src/framework/logger.ts

@@ -1,21 +1,21 @@
-/** 
- * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
- * for VibeIQ app actions.
- */
-
-
-export class Logger {
-  allEntries : Array<string> = [];
-  public log(...args){
-    console.log(...args);
-    this.allEntries.push(new Date().toISOString() + ': ' + args.join(''));
-  }
-
-  public getEntries(){
-    return this.allEntries.join('\n');
-  }
-
-  public clearEntries(){
-    this.allEntries = [];
-  }
-}
+/** 
+ * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
+ * for VibeIQ app actions.
+ */
+
+
+export class Logger {
+  allEntries : Array<string> = [];
+  public log(...args){
+    console.log(...args);
+    this.allEntries.push(new Date().toISOString() + ': ' + args.join(''));
+  }
+
+  public getEntries(){
+    return this.allEntries.join('\n');
+  }
+
+  public clearEntries(){
+    this.allEntries = [];
+  }
+}