@contrail/cli 1.0.67 → 1.0.69

package/src/workflow-templates/workflow-template-commands.ts

@@ -1,59 +1,59 @@
-
-import chalk from 'chalk';
-import fs from 'fs';
-import { authUser } from '../auth/login';
-import { WorkflowTemplateDeclaration } from '../interfaces';
-import { getSeparatorByPlatform } from '../common';
-const yaml = require('js-yaml');
-import { LocalWorkflowTemplateDeployer } from './local-workflow-template-deployer';
-import { WorkflowTemplateDeployer } from './workflow-template-deployer';
-
-export async function deleteWorkflowTemplates() {
-  await authUser();
-  await new WorkflowTemplateDeployer().deleteWorkflowTemplates();
-}
-
-export async function localDeleteWorkflowTemplate() {
-  let wtDeclaration: WorkflowTemplateDeclaration;
-  try {
-    wtDeclaration = loadTemplateConfig();
-  }
-  catch (e) {
-    console.log(`%s Workflow Deletion Failed. ${e}`, chalk.red.bold('FAIL'));
-    return;
-  }
-
-  await authUser();
-  await new LocalWorkflowTemplateDeployer().deleteWorkflowTemplates(wtDeclaration);
-}
-
-export async function localDeployWorkflowTemplate() {
-  let wtDeclaration: WorkflowTemplateDeclaration;
-  try {
-    wtDeclaration = loadTemplateConfig();
-  }
-  catch (e) {
-    console.log(`%s Workflow Deletion Failed. ${e}`, chalk.red.bold('FAIL'));
-    return;
-  }
-
-  await authUser();
-  await new LocalWorkflowTemplateDeployer().deployWorkflows(wtDeclaration);
-}
-
-export async function listWorkflowTemplate() {
-  await authUser();
-  return await new WorkflowTemplateDeployer().listExistingWorkflowTemplates();
-}
-
-function loadTemplateConfig() {
-  const TARGET_DIR = process.cwd();
-  try {
-    const separator = getSeparatorByPlatform();
-    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'workflow.yml', 'utf8'));
-    console.log(doc);
-    return doc;
-  } catch (e) {
-    throw new Error(`ERROR PARSING YAML: ${e}`);
-  }
-}
+
+import chalk from 'chalk';
+import fs from 'fs';
+import { authUser } from '../auth/login';
+import { WorkflowTemplateDeclaration } from '../interfaces';
+import { getSeparatorByPlatform } from '../common';
+const yaml = require('js-yaml');
+import { LocalWorkflowTemplateDeployer } from './local-workflow-template-deployer';
+import { WorkflowTemplateDeployer } from './workflow-template-deployer';
+
+export async function deleteWorkflowTemplates() {
+  await authUser();
+  await new WorkflowTemplateDeployer().deleteWorkflowTemplates();
+}
+
+export async function localDeleteWorkflowTemplate() {
+  let wtDeclaration: WorkflowTemplateDeclaration;
+  try {
+    wtDeclaration = loadTemplateConfig();
+  }
+  catch (e) {
+    console.log(`%s Workflow Deletion Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  await authUser();
+  await new LocalWorkflowTemplateDeployer().deleteWorkflowTemplates(wtDeclaration);
+}
+
+export async function localDeployWorkflowTemplate() {
+  let wtDeclaration: WorkflowTemplateDeclaration;
+  try {
+    wtDeclaration = loadTemplateConfig();
+  }
+  catch (e) {
+    console.log(`%s Workflow Deletion Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  await authUser();
+  await new LocalWorkflowTemplateDeployer().deployWorkflows(wtDeclaration);
+}
+
+export async function listWorkflowTemplate() {
+  await authUser();
+  return await new WorkflowTemplateDeployer().listExistingWorkflowTemplates();
+}
+
+function loadTemplateConfig() {
+  const TARGET_DIR = process.cwd();
+  try {
+    const separator = getSeparatorByPlatform();
+    const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'workflow.yml', 'utf8'));
+    console.log(doc);
+    return doc;
+  } catch (e) {
+    throw new Error(`ERROR PARSING YAML: ${e}`);
+  }
+}

package/src/workflow-templates/workflow-template-deployer.ts

@@ -1,30 +1,30 @@
-import chalk from 'chalk';
-import inquirer from 'inquirer';
-import { deleteWorkflowTemplate as apiDeleteWorkflowTemplate } from '../api/event-workflow-templates';
-import { getExistingWorkflowTemplates } from '../api/event-workflow-templates';
-
-export class WorkflowTemplateDeployer {
-
-  async deleteWorkflowTemplates() {
-
-    // FETCH ALL WORKFLOWS FROM THE API.
-    const existingWorkflows = await getExistingWorkflowTemplates();
-    const answers = await inquirer.prompt([{
-      type: 'checkbox',
-      name: 'wfTemplatesToDelete',
-      message: 'Which templates would you like to delete (one or more)?',
-      choices: existingWorkflows.map(x => { return { value: x.id, name: `(${x.createdOn}) ${x.name}` }; })
-    }]);
-    for (const idToDelete of answers.wfTemplatesToDelete) {
-      await apiDeleteWorkflowTemplate(idToDelete);
-    }
-    console.log('%s \tDeleted workflow templates!', chalk.green.bold('WORKFLOW TEMPLATES'));
-  }
-
-  public async listExistingWorkflowTemplates() {
-    const templates = await getExistingWorkflowTemplates();
-    console.log('(Date Created) (active) workflow name');
-    console.log('------------------------');
-    console.log(chalk.green.bold(templates.map(x => `(${x.createdOn}) (${x.isActive? 'active': 'inactive'}) ${x.name} `).join('\n')));
-  }
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { deleteWorkflowTemplate as apiDeleteWorkflowTemplate } from '../api/event-workflow-templates';
+import { getExistingWorkflowTemplates } from '../api/event-workflow-templates';
+
+export class WorkflowTemplateDeployer {
+
+  async deleteWorkflowTemplates() {
+
+    // FETCH ALL WORKFLOWS FROM THE API.
+    const existingWorkflows = await getExistingWorkflowTemplates();
+    const answers = await inquirer.prompt([{
+      type: 'checkbox',
+      name: 'wfTemplatesToDelete',
+      message: 'Which templates would you like to delete (one or more)?',
+      choices: existingWorkflows.map(x => { return { value: x.id, name: `(${x.createdOn}) ${x.name}` }; })
+    }]);
+    for (const idToDelete of answers.wfTemplatesToDelete) {
+      await apiDeleteWorkflowTemplate(idToDelete);
+    }
+    console.log('%s \tDeleted workflow templates!', chalk.green.bold('WORKFLOW TEMPLATES'));
+  }
+
+  public async listExistingWorkflowTemplates() {
+    const templates = await getExistingWorkflowTemplates();
+    console.log('(Date Created) (active) workflow name');
+    console.log('------------------------');
+    console.log(chalk.green.bold(templates.map(x => `(${x.createdOn}) (${x.isActive? 'active': 'inactive'}) ${x.name} `).join('\n')));
+  }
 }

package/templates/docker_deploy.bat

@@ -0,0 +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

package/templates/javascript/actions/example/action.js

@@ -1,38 +1,38 @@
-async function execute(config, event, Functions) {
-  const getBodyFromEvent = (config, event) => {
-    let body = Functions.stringUtil.parseVariables(config.message, event);
-    console.log('body: ', body);
-    if (config.sendDetails) {
-      const data = event;
-      const properties = {};
-      let addedProperty = false;
-      for (const property of config.fieldsToForward) {
-        const variableLevels = property.split('.');
-        let replacementValue = data;
-        for (let i = 0; i < variableLevels.length; i++) {
-          replacementValue = replacementValue[variableLevels[i]];
-        }
-        properties[property] = replacementValue;
-        addedProperty = true;
-      }
-      if (addedProperty) {
-        body = body + ' Properties: ' + JSON.stringify(properties) + '.';
-      }
-    }
-    return JSON.stringify({ text: body });
-  };
-  const body = getBodyFromEvent(config, event);
-  console.log('Sending message: ', body);
-  const response = await Functions.fetch(config.url, {
-    method: 'POST',
-    body: body,
-    headers: { 'Content-Type': 'application/json' }
-  });
-  if (!response.ok) {
-    console.log('Webhook event failed to publish');
-    console.log('Response: ', JSON.stringify(response));
-  }
-  else {
-    console.log('Published!');
-  }
+async function execute(config, event, Functions) {
+  const getBodyFromEvent = (config, event) => {
+    let body = Functions.stringUtil.parseVariables(config.message, event);
+    console.log('body: ', body);
+    if (config.sendDetails) {
+      const data = event;
+      const properties = {};
+      let addedProperty = false;
+      for (const property of config.fieldsToForward) {
+        const variableLevels = property.split('.');
+        let replacementValue = data;
+        for (let i = 0; i < variableLevels.length; i++) {
+          replacementValue = replacementValue[variableLevels[i]];
+        }
+        properties[property] = replacementValue;
+        addedProperty = true;
+      }
+      if (addedProperty) {
+        body = body + ' Properties: ' + JSON.stringify(properties) + '.';
+      }
+    }
+    return JSON.stringify({ text: body });
+  };
+  const body = getBodyFromEvent(config, event);
+  console.log('Sending message: ', body);
+  const response = await Functions.fetch(config.url, {
+    method: 'POST',
+    body: body,
+    headers: { 'Content-Type': 'application/json' }
+  });
+  if (!response.ok) {
+    console.log('Webhook event failed to publish');
+    console.log('Response: ', JSON.stringify(response));
+  }
+  else {
+    console.log('Published!');
+  }
 }

package/templates/javascript/app.yml

@@ -1,53 +1,53 @@
-appIdentifier: "@your-co/app-name"
-appName: "Your App Name"
-appDescription: "Your app description."
-visibility: public
-publisher: "Your company name"
-version: 1.0
-
-# eventWorkflowTriggerKeyMapping will be used to parse an incoming event into a key that can trigger workflows
-# {} indicates a field on the event. You can use nested fields by separating the levels with a '.'
-# i.e. an event {details: {eventType: 'apparel'}, actionType: 'create'} can be parsed to apparel|create with the following
-eventWorkflowTriggerKeyMapping: "{details.eventType}|{actionType}" 
-
-appConfiguration: 
-  apiHost: 
-    label: "API Host"
-    propertyType: "string"
-  userName: 
-    label: "User Name"
-    propertyType: "string"
-  password: 
-    label: "Password"
-    propertyType: "string"
-
-actions: 
-  updateProduct: 
-    handler: actions/example/action.js
-    name: "Update Product"
-    description: "Updates a product in the destination system."
-    actionConfiguration: 
-      email: 
-        label: "Email Address"
-        propertyType: "string"
-
-triggers: 
-  trigger1: 
-    key: product|create
-    name: "External Product Created"
-    external: true
-    description: "Triggers on externally created products"
-
-# workflows:
-#   workflow1:
-#     triggerKey: item|update
-#     isActive: true
-#     name: test wf from cli
-#     workflowDefinition:
-#       paths:
-#         - conditional: "true"
-#           actionDefinitionConfigs:
-#             - action: updateProduct
-#               name: handle product update
-#               config:
+appIdentifier: "@your-co/app-name"
+appName: "Your App Name"
+appDescription: "Your app description."
+visibility: public
+publisher: "Your company name"
+version: 1.0
+
+# eventWorkflowTriggerKeyMapping will be used to parse an incoming event into a key that can trigger workflows
+# {} indicates a field on the event. You can use nested fields by separating the levels with a '.'
+# i.e. an event {details: {eventType: 'apparel'}, actionType: 'create'} can be parsed to apparel|create with the following
+eventWorkflowTriggerKeyMapping: "{details.eventType}|{actionType}" 
+
+appConfiguration: 
+  apiHost: 
+    label: "API Host"
+    propertyType: "string"
+  userName: 
+    label: "User Name"
+    propertyType: "string"
+  password: 
+    label: "Password"
+    propertyType: "string"
+
+actions: 
+  updateProduct: 
+    handler: actions/example/action.js
+    name: "Update Product"
+    description: "Updates a product in the destination system."
+    actionConfiguration: 
+      email: 
+        label: "Email Address"
+        propertyType: "string"
+
+triggers: 
+  trigger1: 
+    key: product|create
+    name: "External Product Created"
+    external: true
+    description: "Triggers on externally created products"
+
+# workflows:
+#   workflow1:
+#     triggerKey: item|update
+#     isActive: true
+#     name: test wf from cli
+#     workflowDefinition:
+#       paths:
+#         - conditional: "true"
+#           actionDefinitionConfigs:
+#             - action: updateProduct
+#               name: handle product update
+#               config:
 #                 message: "hello world"

package/templates/javascript/package.json

@@ -1,23 +1,23 @@
-{
-  "name": "test-app",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "bin": {
-    "@contrail/contrail-cli": "bin/init",
-    "contrail": "bin/init"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-  ],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "chalk": "^4.0.0"
-  }
-}
+{
+  "name": "test-app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "bin": {
+    "@contrail/contrail-cli": "bin/init",
+    "contrail": "bin/init"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^4.0.0"
+  }
+}

package/templates/typescript/Dockerfile

@@ -1,14 +1,15 @@
-# docker build -t app-name .
-# docker run -p 9000:8080 app-name
-FROM public.ecr.aws/lambda/nodejs:16
-
-# Install NPM dependencies for function
-COPY package* ${LAMBDA_TASK_ROOT}
-RUN npm install
-
-COPY tsconfig.json  ${LAMBDA_TASK_ROOT}
-COPY actions/       ${LAMBDA_TASK_ROOT}/actions
-
-RUN npm run build
-
-CMD ["dist/handler.execute"]
+# docker build -t app-name .
+# docker run -p 9000:8080 app-name
+FROM public.ecr.aws/lambda/nodejs:16
+
+# Install NPM dependencies for function
+COPY package* ${LAMBDA_TASK_ROOT}
+COPY app.yml  ${LAMBDA_TASK_ROOT}
+RUN npm install
+
+COPY tsconfig.json  ${LAMBDA_TASK_ROOT}
+COPY src/       ${LAMBDA_TASK_ROOT}/src
+
+RUN npm run build
+
+CMD ["dist/framework/handler.execute"]

package/templates/typescript/README.md

@@ -1,10 +1,10 @@
-### building and uploading docker image to ECR
-1. set AWS_REGISTRY  environment variable to be able to tag  and/or push to ECR
-### Example: xxx.dkr.ecr.us-east-1.amazonaws.com
-1. To build, run, tag, and push using docker, there are npm scripts that can be used.
-2. The npm scripts use the npm package name, version, and config fields to set the appropriate values
-3. OPTIONAL: if you want to inspect the container you can run `npm run docker-run-entry`
-4. OPTIONAL: if you want to run this locally using port 9000, you can run `npm run docker-run`
-5. To tag the image for pushing to ECR `npm run docker-tag`
-6. To push the image to ECR `npm run docker-push`
-7. All the npm scripts have a ':win" version to run on windows
+### building and uploading docker image to ECR
+1. set AWS_REGISTRY  environment variable to be able to tag  and/or push to ECR
+### Example: xxx.dkr.ecr.us-east-1.amazonaws.com
+1. To build, run, tag, and push using docker, there are npm scripts that can be used.
+2. The npm scripts use the npm package name, version, and config fields to set the appropriate values
+3. OPTIONAL: if you want to inspect the container you can run `npm run docker-run-entry`
+4. OPTIONAL: if you want to run this locally using port 9000, you can run `npm run docker-run`
+5. To tag the image for pushing to ECR `npm run docker-tag`
+6. To push the image to ECR `npm run docker-push`
+7. All the npm scripts have a ':win" version to run on windows

package/templates/typescript/app.yml

@@ -1,54 +1,50 @@
-appIdentifier: "@your-co/app-name"
-appName: "Your App Name"
-appDescription: "Your app description."
-visibility: public
-publisher: "Your company name"
-version: 1.0
-dockerImageRef: CHANGE_ME
-
-# eventWorkflowTriggerKeyMapping will be used to parse an incoming event into a key that can trigger workflows
-# {} indicates a field on the event. You can use nested fields by separating the levels with a '.'
-# i.e. an event {details: {eventType: 'apparel'}, actionType: 'create'} can be parsed to apparel|create with the following
-eventWorkflowTriggerKeyMapping: "{details.eventType}|{actionType}"
-
-appConfiguration:
-  apiHost:
-    label: "API Host"
-    propertyType: "string"
-  userName:
-    label: "User Name"
-    propertyType: "string"
-  password:
-    label: "Password"
-    propertyType: "string"
-
-# Actions can be written in .ts but must be compiled to .js before deployment.
-actions:
-  updateProduct:
-    name: "Update Product"
-    description: "Updates a product in the destination system."
-    async: false # default is false
-    actionConfiguration:
-      email:
-        label: "Email Address"
-        propertyType: "string"
-
-triggers:
-  trigger1:
-    key: product|create
-    name: "External Product Created"
-    external: true
-    description: "Triggers on externally created products"
-
-workflows:
-  workflow1:
-    name: "Update item on product creation"
-    triggerKey: product|create
-    isActive: true
-    public: true
-    workflowDefinition:
-      paths:
-        - conditional: "{retailPrice} > 10"
-          actionDefinitionConfigs:
-            - action: updateProduct
-              name: Update Product
+appIdentifier: "@your-co/app-name"
+appName: "Your App Name"
+appDescription: "Your app description."
+visibility: private
+publisher: "Your company name"
+version: 1.0
+dockerImageRef: CHANGE_ME
+
+# 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:
+  exampleAction:
+    name: "Log Item"
+    description: "Fetches an item from the API and returns it to the log."
+    async: false
+    actionConfiguration:
+      message:
+        label: "Additinoal 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/typescript/package-lock.json

@@ -1,14 +1,14 @@
-{
-  "name": "test-app",
-  "version": "1.0.0",
-  "lockfileVersion": 1,
-  "requires": true,
-  "dependencies": {
-    "typescript": {
-      "version": "4.7.4",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
-      "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
-      "dev": true
-    }
-  }
-}
+{
+  "name": "test-app",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "typescript": {
+      "version": "4.7.4",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
+      "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
+      "dev": true
+    }
+  }
+}