@contrail/cli 1.0.2 → 1.0.3

package/src/deploy-app/interfaces.ts

@@ -1,43 +1,78 @@
-/** 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; // should be a public link
+  eventWorkflowTriggerKeyMapping: string;
+  configProperties?: ConfigProperty[];
+  triggerKeyDefinitions?: TriggerKeyDefinition[];
+}
+
+export 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 class TriggerKeyDefinition {
+	name: string;
+	description?: string;
+	triggerKey: string;
+  external?: boolean;
+}

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,42 +1,54 @@
-appIdentifier: "@your-co/app-name"
-appName: "Your App Name"
-appDescription: "Your app description."
-visibility: public
-publisher: "Your company name"
-version: 1.0
-
-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."
-
-triggers: 
-  trigger1: 
-    key: product|create
-    name: "Produt Created"
-
-workflows: 
-  workflow1: 
-    name: "Update item on product creation"
-    triggerKey: product|create
-    paths:
-      path1: 
-        conditional: "{retailPrice} > 10"
-        actions: 
-          updateItem: 
-            actionId: updateItem
-            configuration:
-
-
+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"
+
+# TODO - This is not read
+workflows: 
+  workflow1: 
+    name: "Update item on product creation"
+    triggerKey: product|create
+    paths:
+      path1: 
+        conditional: "{retailPrice} > 10"
+        actions: 
+          updateItem: 
+            actionId: updateItem
+            configuration:
+
+

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/javascript/set_auth.bat

@@ -0,0 +1,3 @@
+set CONTRAIL_CLI_EMAIL=
+set CONTRAIL_CLI_PASSWORD=
+set CONTRAIL_CLI_ORGSLUG=

package/templates/javascript/set_auth.sh

@@ -0,0 +1,3 @@
+export CONTRAIL_CLI_EMAIL=
+export CONTRAIL_CLI_PASSWORD=
+export CONTRAIL_CLI_ORGSLUG=

package/templates/typescript/actions/exampleAction.ts

@@ -0,0 +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!');        
+  }    
+}

package/templates/typescript/app.yml

@@ -0,0 +1,56 @@
+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 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
+    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"
+
+# TODO - This is not read
+workflows: 
+  workflow1: 
+    name: "Update item on product creation"
+    triggerKey: product|create
+    paths:
+      path1: 
+        conditional: "{retailPrice} > 10"
+        actions: 
+          updateItem: 
+            actionId: updateItem
+            configuration:
+
+

package/templates/typescript/package.json

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

package/templates/typescript/set_auth.bat

@@ -0,0 +1,3 @@
+set CONTRAIL_CLI_EMAIL=
+set CONTRAIL_CLI_PASSWORD=
+set CONTRAIL_CLI_ORGSLUG=

package/templates/typescript/set_auth.sh

@@ -0,0 +1,3 @@
+export CONTRAIL_CLI_EMAIL=
+export CONTRAIL_CLI_PASSWORD=
+export CONTRAIL_CLI_ORGSLUG=

package/templates/typescript/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "commonjs",
+    "declaration": true,
+    "esModuleInterop": true,
+    "outDir": "./actions",
+    "strict": false,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "noImplicitAny": false,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "lib": [
+      "es5",
+      "ES2015",
+      "ES2016",
+      "ES2017",
+      "dom",
+      "esnext.asynciterable"
+    ],
+  },
+  "include": [
+    "actions"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/*"
+  ]
+}

package/tsconfig.json

@@ -1,23 +1,23 @@
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-    "declaration": true,
-    "esModuleInterop": true,
-    "outDir": "./lib",
-    "strict": false,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "emitDecoratorMetadata": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node"
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "node_modules",
-    "**/__tests__/*"
-  ]
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "declaration": true,
+    "esModuleInterop": true,
+    "outDir": "./lib",
+    "strict": false,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "noImplicitAny": false,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/*"
+  ]
 }