@contrail/cli 1.0.63 → 1.0.65

package/lib/cli.js

@@ -325,6 +325,10 @@ const helpSections = [
                 name: 'install',
                 summary: 'Install an app to your org.'
             },
+            {
+                name: 'upgrade',
+                summary: 'Upgrades or downgrades an existing app in your org.'
+            },
             {
                 name: 'uninstall',
                 summary: 'Uninstall an app from your org.'

package/lib/types/types-extractor.d.ts

@@ -8,49 +8,20 @@ export interface DataHolder {
     typePropertyPolicies: any[];
     typePropertyPolicyLinks: any[];
 }
+export interface ReducedDataHolder {
+    reducedTypes: any[];
+    reducedOptionSets: any[];
+    reducedOptionSetHierarchies: any[];
+    reducedRuleSets: any[];
+    reducedRuleSetLinks: any[];
+    reducedUsageInfo: any[];
+    reducedTypePropertyPolicies: any[];
+    reducedTypePropertyPolicyLinks: any[];
+}
 export declare function getAll(args: any): Promise<void>;
 /**
  *  stores reduced option sets and returns full option sets */
 export declare function getOptionSets(): Promise<any>;
 export declare function getTypes(): Promise<any[]>;
 export declare function reduceTypes(dataHolder: DataHolder): any[];
-export declare function reduceData(data: DataHolder): {
-    reducedTypes: any[];
-    reducedOptionSets: {
-        name: any;
-        isArchived: any;
-        optionSet: any;
-    }[];
-    reducedOptionSetHierarchies: {
-        hierarchy: any;
-        options: any;
-        name: any;
-    }[];
-    reducedRuleSets: {
-        ruleSet: any;
-        name: any;
-    }[];
-    reducedRuleSetLinks: any[];
-    reducedUsageInfo: {
-        used: any;
-        editable: any;
-        formulaFunction: any;
-        validationFunction: any;
-        numberFormat: any;
-        defaultValue: any;
-        label: any;
-        typeSlug: any;
-        typePropertySlug: any;
-    }[];
-    reducedTypePropertyPolicies: {
-        label: any;
-        policy: {
-            version: any;
-            statements: any;
-        };
-    }[];
-    reducedTypePropertyPolicyLinks: {
-        typePropertySlug: any;
-        typePropertyPolicyLabel: any;
-    }[];
-};
+export declare function reduceData(data: DataHolder): ReducedDataHolder;

package/lib/types/types-extractor.js

@@ -247,9 +247,38 @@ export function reduceData(data) {
         reducedTypePropertyPolicyLinks: reduceTypePropertyPolicyLinks(data),
     };
 }
+const saveTypesFunction = function (data, dir) {
+    const roots = {};
+    for (const type of data.reducedTypes) {
+        const typePathParts = type.typePath.split(':');
+        if (!typePathParts) {
+            console.warn('skipping bad type with no path', type);
+        }
+        const root = typePathParts[0];
+        if (roots[root]) {
+            roots[root].push(type);
+        }
+        else {
+            roots[root] = [type];
+        }
+    }
+    for (const [root, types] of Object.entries(roots)) {
+        const CURRENT_DIR = process.cwd();
+        const subDir = path.join(CURRENT_DIR, dir, 'types');
+        if (!fs.existsSync(subDir)) {
+            fs.mkdirSync(subDir);
+        }
+        const yamlStr = yaml.dump(types);
+        const fileLabel = root;
+        if (!fileLabel) {
+            console.warn('skipping bad type root:', root);
+        }
+        fs.writeFileSync(path.join(subDir, `${removeSlash(fileLabel)}.yml`), yamlStr, 'utf8');
+    }
+};
 function saveData(reducedData, dir) {
     const propertyToFolderMap = {
-        reducedTypes: { filename: 'types', split: true, fileLabel: 'slug' },
+        reducedTypes: { filename: 'types', split: false, fileLabel: 'slug', saveFunction: saveTypesFunction },
         reducedOptionSets: { filename: 'option-sets', split: true, fileLabel: 'name' },
         reducedOptionSetHierarchies: { filename: 'option-set-hierarchies', split: true, fileLabel: 'name' },
         reducedRuleSets: { filename: 'rule-sets', split: true, fileLabel: 'name' },
@@ -260,7 +289,10 @@ function saveData(reducedData, dir) {
     };
     for (const [key, folder] of Object.entries(propertyToFolderMap)) {
         const CURRENT_DIR = process.cwd();
-        if (folder.split) {
+        if (folder['saveFunction']) {
+            folder['saveFunction'](reducedData, dir);
+        }
+        else if (folder.split) {
             const subDir = path.join(CURRENT_DIR, dir, folder.filename);
             if (!fs.existsSync(subDir)) {
                 fs.mkdirSync(subDir);

package/lib/types/types-uploader.js

@@ -25,7 +25,7 @@ function loadReducedTypes() {
         const files = fs.readdirSync(path.join(TARGET_DIR, 'types'));
         const types = [];
         for (const file of files) {
-            types.push(yaml.load(fs.readFileSync(path.join(TARGET_DIR, 'types', file), 'utf8')));
+            types.push(...yaml.load(fs.readFileSync(path.join(TARGET_DIR, 'types', file), 'utf8')));
         }
         return types;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "1.0.63",
+  "version": "1.0.65",
   "description": "VibeIQ's Contrail Platform CLI.",
   "main": "lib/index.js",
   "bin": {

package/src/cli.ts

@@ -340,6 +340,10 @@ const helpSections = [
         name: 'install',
         summary: 'Install an app to your org.'
       },
+      {
+        name: 'upgrade',
+        summary: 'Upgrades or downgrades an existing app in your org.'
+      },
       {
         name: 'uninstall',
         summary: 'Uninstall an app from your org.'

package/src/types/types-extractor.ts

@@ -8,6 +8,10 @@ import pLimit from 'p-limit';
 const limit = pLimit(30);
 
 const yaml = require('js-yaml');
+interface StoreFunction
+{
+    (data: ReducedDataHolder, dir: string): void;
+}
 
 export interface DataHolder {
   types: any[],
@@ -20,6 +24,17 @@ export interface DataHolder {
   typePropertyPolicyLinks: any[],
 }
 
+export interface ReducedDataHolder {
+  reducedTypes: any[],
+  reducedOptionSets: any[],
+  reducedOptionSetHierarchies: any[],
+  reducedRuleSets: any[],
+  reducedRuleSetLinks: any[],
+  reducedUsageInfo: any[],
+  reducedTypePropertyPolicies: any[],
+  reducedTypePropertyPolicyLinks: any[],
+}
+
 export async function getAll(args) {
   try {
     const userConfig = await authUser();
@@ -268,7 +283,7 @@ export function reduceTypes(dataHolder: DataHolder) {
   return reducedTypes;
 }
 
-export function reduceData(data: DataHolder) {
+export function reduceData(data: DataHolder): ReducedDataHolder {
   return {
     reducedTypes: reduceTypes(data),
     reducedOptionSets: reduceOptionSets(data),
@@ -281,10 +296,40 @@ export function reduceData(data: DataHolder) {
   };
 }
 
+const saveTypesFunction: StoreFunction = function (data: ReducedDataHolder, dir: string) {
+  const roots = {};
+  for(const type of data.reducedTypes) {
+    const typePathParts = type.typePath.split(':');
+    if(!typePathParts) {
+      console.warn('skipping bad type with no path', type);
+    }
+    const root = typePathParts[0];
+    if(roots[root]) {
+      roots[root].push(type);
+    } else {
+      roots[root] = [type];
+    }
+  }
+  for(const [root, types] of Object.entries(roots)) {
+    const CURRENT_DIR = process.cwd();
+    const subDir = path.join(CURRENT_DIR, dir, 'types');
+    if(!fs.existsSync(subDir)) {
+      fs.mkdirSync(subDir);
+    }
+    const yamlStr = yaml.dump(types);
+    const fileLabel = root;
+    if(!fileLabel) {
+      console.warn('skipping bad type root:', root);
+    }
+    fs.writeFileSync(path.join(subDir, `${removeSlash(fileLabel)}.yml`), yamlStr, 'utf8');
+  }
+
+};
+
 function saveData(reducedData, dir: string) {
 
   const propertyToFolderMap = {
-    reducedTypes: { filename: 'types', split: true, fileLabel: 'slug' },
+    reducedTypes: { filename: 'types', split: false, fileLabel: 'slug', saveFunction:  saveTypesFunction},
     reducedOptionSets: { filename: 'option-sets', split: true, fileLabel: 'name' },
     reducedOptionSetHierarchies: { filename: 'option-set-hierarchies', split: true, fileLabel: 'name' },
     reducedRuleSets: { filename: 'rule-sets', split: true, fileLabel: 'name' },
@@ -295,7 +340,9 @@ function saveData(reducedData, dir: string) {
   };
   for(const [key, folder] of Object.entries(propertyToFolderMap)) {
     const CURRENT_DIR = process.cwd();
-    if(folder.split) {
+    if(folder['saveFunction']) {
+      folder['saveFunction'](reducedData, dir);
+    } else if(folder.split) {
       const subDir = path.join(CURRENT_DIR, dir, folder.filename);
       if(!fs.existsSync(subDir)) {
         fs.mkdirSync(subDir);

package/src/types/types-uploader.ts

@@ -32,7 +32,7 @@ function loadReducedTypes(){
     const files = fs.readdirSync(path.join(TARGET_DIR, 'types'));
     const types = [];
     for(const file of files) {
-      types.push(yaml.load(fs.readFileSync(path.join(TARGET_DIR, 'types', file), 'utf8')));
+      types.push(...yaml.load(fs.readFileSync(path.join(TARGET_DIR, 'types', file), 'utf8')));
     }
     return types;
   } catch (e) {

package/templates/typescript/Dockerfile

@@ -0,0 +1,14 @@
+# 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"]

package/templates/typescript/README.md

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

package/templates/typescript/actions/handler.ts

@@ -0,0 +1,65 @@
+import { login } from '@contrail/sdk';
+import { Logger } from './utils/logger';
+
+export async function execute(data) {
+  const logger = new Logger();
+  logger.log(JSON.stringify(data))
+  const event = (typeof data.event === 'string')
+    ? JSON.parse(data.event)
+    : data.event;
+  data = JSON.parse(JSON.stringify(data));
+  const config = data.config;
+  if (!config.apiHost || !config.userName || !config.password) {
+    const message = 'This action requires an api host, a username, and a password to run';
+    const body = {
+      message,
+      logs: [message]
+    };
+    return {
+      statusCode: 400,
+      body
+    };
+  }
+
+  try {
+    login({ apiKey: config.apiKey, orgSlug: config.orgSlug });
+    const results = {};
+
+    logger.log('Sending message: ', event);
+    const response = await fetch(config.url, {
+      method: 'POST',
+      body: event,
+      headers: { 'Content-Type': 'application/json' }
+    });
+    if (!response.ok) {
+      logger.log('Webhook event failed to publish');
+      logger.log('Response: ', JSON.stringify(response));
+    }
+    else {
+      logger.log('Published!');
+    }
+
+    results['logs'] = logger.getEntries();
+    results['config'] = config;
+
+    logger.log('returning: ' + JSON.stringify(results));
+    return {
+      statusCode: 200,
+      body: JSON.stringify(results)
+    };
+
+  } catch (e) {
+    logger.log('returning failure: ' + e.message);
+    const body = {
+      message: 'failed',
+      error: e.message,
+      logs: logger.getEntries()
+    };
+
+    return {
+      statusCode: 400,
+      body: JSON.stringify(body),
+    };
+  }
+
+}

package/templates/typescript/actions/utils/logger.ts

@@ -0,0 +1,15 @@
+export class Logger {
+  allEntries = [];
+  public log(...args){
+    console.log(args);
+    this.allEntries.push(args);
+  }
+
+  public getEntries(){
+    return this.allEntries;
+  }
+
+  public clearEntries(){
+    this.allEntries = [];
+  }
+}

package/templates/typescript/app.yml

@@ -4,54 +4,51 @@ appDescription: "Your app description."
 visibility: public
 publisher: "Your company name"
 version: 1.0
-# dockerImageRef: repo/name:tag
+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}" 
+eventWorkflowTriggerKeyMapping: "{details.eventType}|{actionType}"
 
-appConfiguration: 
-  apiHost: 
+appConfiguration:
+  apiHost:
     label: "API Host"
     propertyType: "string"
-  userName: 
+  userName:
     label: "User Name"
     propertyType: "string"
-  password: 
+  password:
     label: "Password"
     propertyType: "string"
 
 # Actions can be written in .ts but must be compiled to .js before deployment.
-# Ensure the handler points to a .js file
-actions: 
-  updateProduct: 
-    handler: actions/exampleAction.js
+actions:
+  updateProduct:
     name: "Update Product"
     description: "Updates a product in the destination system."
-    actionConfiguration: 
-      email: 
+    async: false # default is false
+    actionConfiguration:
+      email:
         label: "Email Address"
         propertyType: "string"
 
-triggers: 
-  trigger1: 
+triggers:
+  trigger1:
     key: product|create
     name: "External Product Created"
     external: true
     description: "Triggers on externally created products"
 
-# TODO - This is not read
-workflows: 
-  workflow1: 
+workflows:
+  workflow1:
     name: "Update item on product creation"
     triggerKey: product|create
-    paths:
-      path1: 
-        conditional: "{retailPrice} > 10"
-        actions: 
-          updateItem: 
-            actionId: updateItem
-            configuration:
-
-
+    isActive: true
+    public: true
+    workflowDefinition:
+      paths:
+        - conditional: "{retailPrice} > 10"
+          actionDefinitionConfigs:
+            - action: updateProduct
+              name: Update Product

package/templates/typescript/package.json

@@ -7,20 +7,40 @@
     "@contrail/contrail-cli": "bin/init",
     "contrail": "bin/init"
   },
+  "config": {
+    "wf": "/workflow-actions-prod"
+  },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "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.53",
     "chalk": "^4.0.0"
   },
   "devDependencies": {
+    "jest": "^29.2.2",
+    "ts-jest": "^29.0.3",
     "typescript": "^4.7.4"
   }
 }

package/templates/typescript/tsconfig.json

@@ -4,7 +4,7 @@
     "module": "commonjs",
     "declaration": true,
     "esModuleInterop": true,
-    "outDir": "./actions",
+    "outDir": "dist",
     "strict": false,
     "experimentalDecorators": true,
     "strictPropertyInitialization": false,

package/templates/typescript/actions/exampleAction.ts

@@ -1,39 +0,0 @@
-export { }; // Leave empty export - This allows for multiple files with a function named execute.
-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!');
-  }
-}