@keragon/connector-cli 0.0.6 → 0.0.9

package/assets/templates/add/action/src/components/{<%= componentName %>/<%= componentName %>.definition.json.ejs → [%= componentName %]/[%= componentName %].definition.json.ejs }

@@ -1,4 +1,4 @@
-<%
+[%
   function formatComponentTitle(str) {
     const spaced = str?.replace(/([A-Z])/g, ' $1')?.toLowerCase();
     return spaced?.charAt(0).toUpperCase() + spaced?.slice(1);
@@ -22,8 +22,8 @@
   if (http) {
     obj.request = {
       config: {
-        method: "get",
-        url: "/"
+        method: (typeof method === 'string' && method) ? method.toLowerCase() : "get",
+        url: (typeof url === 'string' && url) ? url : "/"
       },
     };
   }
@@ -96,8 +96,8 @@
   if (outputs) {
     obj.outputs = {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
-      type: "array",
-      title: "Items",
+      type: "object",
+      title: "Item",
       properties: {
         id: {
           type: "string",
@@ -110,5 +110,4 @@
       }
     };
   }
-%>
-<%- JSON.stringify(obj, null, 2) %>
+%][%- JSON.stringify(obj, null, 2) %]

package/assets/templates/add/action/src/components/[%= componentName %]/index.ts.ejs

@@ -0,0 +1,5 @@
+import definition from './[%= componentName %].definition.json';
+
+export default {
+  definition,
+};

package/assets/templates/add/implementation/component/__tests__/[%= name %].test.ts.ejs

@@ -0,0 +1,36 @@
+import { 
+  Credentials
+} from '@keragon/connector-sdk';
+import app from '../src';
+import [%= className %] from '../src/components/[%= name %]/[%= name %]';
+const { definition, ctor: [%= firstLetterUpperCase(connectorName) %] } = app;
+
+const setupTest = ({
+  credentials = {
+    authScheme: {
+      id: 'com.keragon.[%= connectorName %].environments.prod.authSchemes.custom',
+    },
+  }
+}: {
+  credentials?: Credentials
+}) => {
+  const [%= connectorName %] = new [%= firstLetterUpperCase(connectorName) %]({
+    definition, credentials,
+  });
+  const component = [%= connectorName %].constructComponent({ componentId: 'com.keragon.[%= connectorName %].[%= name %]' }) as [%= className %];
+
+  return { [%= connectorName %], component, credentials }
+};
+
+describe('Component: [%= className %] should', () => {
+  it('implement run', async () => {
+    // Arrange
+    const { component } = setupTest({});
+
+    // Act
+    const outputs = await component.run({});
+
+    // Assert
+    expect(outputs).toBe({});
+  });
+});

package/assets/templates/add/implementation/component/src/components/{<%= name %>/<%= name %>.ts.ejs → [%= name %]/[%= name %].ts.ejs }

@@ -1,12 +1,12 @@
 import {
-  <%= isHttp ? 'HttpApp, HttpComponent,' : 'App, Component,' %>
+  [%= isHttp ? 'HttpApp, HttpComponent,' : 'App, Component,' %]
   RunFunctionArgs,
   RunFunctionReturnType,
 } from "@keragon/connector-sdk";
-<%- isHttp ? "import { AxiosRequestConfig } from 'axios';" : '' %>
+[%- isHttp ? "import { AxiosRequestConfig } from 'axios';" : '' %]
 
-export default class <%= className %> extends <%= isHttp ? 'HttpComponent' : 'Component' %><<%= isHttp ? 'HttpApp' : 'App' %>> {
-  <%_ if (isHttp) { _%>
+export default class [%= className %] extends [%= isHttp ? 'HttpComponent' : 'Component' %]<[%= isHttp ? 'HttpApp' : 'App' %]> {
+  [%_ if (isHttp) { _%]
   override async onRequest({
     requestConfig,
   }: {
@@ -25,10 +25,10 @@ export default class <%= className %> extends <%= isHttp ? 'HttpComponent' : 'Co
       },
     };
   }
-  <%_ } else { _%>
+  [%_ } else { _%]
   override async run({ inputs }: RunFunctionArgs): Promise<RunFunctionReturnType> {
     if (!inputs) throw new Error(`Component ${this.definition.id} run() received no inputs`);
     throw new Error('Change default implementation of run() method');
   }
-  <%_ } _%>
+  [%_ } _%]
 }

package/assets/templates/add/implementation/connector/__tests__/[%= name %].test.ts.ejs

@@ -0,0 +1,28 @@
+import { 
+  Credentials
+} from '@keragon/connector-sdk';
+import app from '../src';
+const { definition, ctor: [%= firstLetterUpperCase(name) %] } = app;
+
+const setupTest = ({
+  credentials = {
+    authScheme: {
+      id: 'com.keragon.[%= name %].environments.prod.authSchemes.custom',
+    },
+  }
+}: {
+  credentials?: Credentials
+}) => {
+  const [%= name %] = new [%= firstLetterUpperCase(name) %]({
+    definition, credentials,
+  });
+  return { [%= name %], credentials }
+};
+
+describe('Connector: [%= firstLetterUpperCase(name) %] should', () => {
+  it('construct connector', async () => {
+    const { [%= name %] } = setupTest({});
+
+    expect([%= name %]).toBeDefined();
+  });
+});

package/assets/templates/add/implementation/connector/src/{<%= name %>.ts.ejs → [%= name %].ts.ejs }

@@ -1,9 +1,9 @@
 import {
   ConfigureCredentialsArgs, 
-  <%= isHttp ? 'HttpApp' : 'App' %>,
+  [%= isHttp ? 'HttpApp' : 'App' %],
 } from '@keragon/connector-sdk';
 
-export default class <%= firstLetterUpperCase(name) %> extends <%= isHttp ? 'HttpApp' : 'App' %> {
+export default class [%= firstLetterUpperCase(name) %] extends [%= isHttp ? 'HttpApp' : 'App' %] {
   // TODO: default implementation
   override async configureCredentials(args: ConfigureCredentialsArgs) {
     const configuredCredentials = await super.configureCredentials(args);

package/assets/templates/add/pollingtrigger/__tests__/{<%= componentName %>.test.ts.ejs → [%= componentName %].test.ts.ejs }

@@ -1,7 +1,7 @@
 import { CloudEventData } from '@keragon/types';
 import { CloudEvent } from 'cloudevents';
 import app from '../src';
-const { definition, ctor: <%= firstLetterUpperCase(connectorId) %> } = app;
+const { definition, ctor: [%= firstLetterUpperCase(connectorId) %] } = app;
 
 const mockAxiosGet = jest.fn();
 const mockAxiosPost = jest.fn();
@@ -28,22 +28,22 @@ const setUpTest = ({
 }: {
   store?: Record<string, unknown>;
 }) => {
-  const <%= connectorId %>: InstanceType<typeof <%= firstLetterUpperCase(connectorId) %>> = new <%= firstLetterUpperCase(connectorId) %>({
+  const [%= connectorId %]: InstanceType<typeof [%= firstLetterUpperCase(connectorId) %]> = new [%= firstLetterUpperCase(connectorId) %]({
     definition,
     credentials: {
       key: 'mockKey',
       authScheme: {
         // TODO authScheme
-        id: '<%= connectorId %>.environments.prod.authSchemes.apiKey',
+        id: '[%= connectorId %].environments.prod.authSchemes.apiKey',
       },
     }
   });
 
-  const trigger = <%= connectorId %>.constructComponent({ componentId: '<%= componentId %>', store });
-  return { <%= connectorId %>, trigger, webhookUrl: 'https://test.com/v1/' };
+  const trigger = [%= connectorId %].constructComponent({ componentId: '[%= componentId %]', store });
+  return { [%= connectorId %], trigger, webhookUrl: 'https://test.com/v1/' };
 };
 
-describe('Component: Trigger <%= componentId %> should', () => {
+describe('Component: Trigger [%= componentId %] should', () => {
 
   it('.generateSampleEvents returns sample', async () => {
     // Arrange
@@ -61,7 +61,7 @@ describe('Component: Trigger <%= componentId %> should', () => {
 
     // Assert
     expect(mockGetDynamicValue).toHaveBeenCalledWith({
-      componentId: '<%= connectorId %>.getItems',
+      componentId: '[%= connectorId %].getItems',
       processInputs: '${ {} }',
       processOutputs: '${ }',
     });

package/assets/templates/add/pollingtrigger/src/components/{<%= componentName %>/<%= componentName %>.definition.json.ejs → [%= componentName %]/[%= componentName %].definition.json.ejs }

@@ -1,13 +1,13 @@
 {
-  "id": "<%= componentId %>",
-  "title": "<%= title %>",
-  "description": "<%= desc %>",
+  "id": "[%= componentId %]",
+  "title": "[%= title %]",
+  "description": "[%= desc %]",
   "type": "trigger",
-  "sdkVersion": "0.0.1"<% if (alert) { %>,
+  "sdkVersion": "0.0.1"[% if (alert) { %],
   "alerts": [{
     "type": "info",
     "content": "TODO: Add alert message. You can change the type to 'warning' or 'error' if needed."
-  }]<% } %>,
+  }][% } %],
   "poll": {
     "schedule": {
       "cron": "*/5 * * * *"
@@ -17,11 +17,11 @@
       "getDedupValue": "${ .item.created_time }"
     },
     "poller": {
-      "componentId": "<%= connectorId %>.getItems<TODO set correct component>",
+      "componentId": "[%= connectorId %].getItems<TODO set correct component>",
       "processInputs": "${ { event: .event } }",
       "processOutputs": "${ . | sort_by(.created_time) | reverse }"
     }
-  }<% if (inputs) { %>,
+  }[% if (inputs) { %],
   "inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",
@@ -32,11 +32,11 @@
         "type": "string",
         "title": "Event",
         "dynamicEnum": {
-          "componentId": "<%= connectorId %>.get",
+          "componentId": "[%= connectorId %].get",
           "processInputs": "${ }",
           "processOutputs": "${ [.[] | {label: .name, value: .type}] }"
         }
       }
     }
-  }<% } %>
+  }[% } %]
 }

package/assets/templates/add/pollingtrigger/src/components/{<%= componentName %>/<%= componentName %>.ts.ejs → [%= componentName %]/[%= componentName %].ts.ejs }

@@ -5,12 +5,12 @@ import {
   App,
 } from '@keragon/connector-sdk';
 
-export default class <%= firstLetterUpperCase(componentName) %> extends PollingTrigger<App> implements HasSampleEvents {
+export default class [%= firstLetterUpperCase(componentName) %] extends PollingTrigger<App> implements HasSampleEvents {
 
   async generateSampleEvents({ store: _, ...inputs }: Record<string, unknown>): Promise<SampleEvent[]> {
     const { a, b, c } = this.validateInputs(inputs);
     const items = await this.getDynamicValue({
-      componentId: '<%= connectorId %>.getItems<TODO set correct component>',
+      componentId: '[%= connectorId %].getItems<TODO set correct component>',
       processInputs: `\${ ${JSON.stringify({ a, b, c })} }`,
       processOutputs: '${ sort_by(.date) | reverse }'
     });

package/assets/templates/add/pollingtrigger/src/components/[%= componentName %]/index.ts.ejs

@@ -0,0 +1,7 @@
+import definition from './[%= componentName %].definition.json';
+import [%= firstLetterUpperCase(componentName) %] from './[%= componentName %]';
+
+export default {
+  ctor: [%= firstLetterUpperCase(componentName) %],
+  definition,
+};

package/assets/templates/add/trigger/__tests__/{<%= componentName %>.test.ts.ejs → [%= componentName %].test.ts.ejs }

@@ -1,7 +1,7 @@
 import { CloudEventData } from '@keragon/types';
 import { CloudEvent } from 'cloudevents';
 import app from '../src';
-const { definition, ctor: <%= firstLetterUpperCase(connectorId) %> } = app;
+const { definition, ctor: [%= firstLetterUpperCase(connectorId) %] } = app;
 
 const mockAxiosGet = jest.fn();
 const mockAxiosPost = jest.fn();
@@ -28,22 +28,22 @@ const setUpTest = ({
 }: {
   store?: Record<string, unknown>;
 }) => {
-  const <%= connectorId %>: InstanceType<typeof <%= firstLetterUpperCase(connectorId) %>> = new <%= firstLetterUpperCase(connectorId) %>({
+  const [%= connectorId %]: InstanceType<typeof [%= firstLetterUpperCase(connectorId) %]> = new [%= firstLetterUpperCase(connectorId) %]({
     definition,
     credentials: {
       key: 'mockKey',
       authScheme: {
         // TODO authScheme
-        id: '<%= connectorId %>.environments.prod.authSchemes.apiKey',
+        id: '[%= connectorId %].environments.prod.authSchemes.apiKey',
       },
     }
   });
 
-  const trigger = <%= connectorId %>.constructComponent({ componentId: '<%= componentId %>', store });
-  return { <%= connectorId %>, trigger, webhookUrl: 'https://test.com/v1/' };
+  const trigger = [%= connectorId %].constructComponent({ componentId: '[%= componentId %]', store });
+  return { [%= connectorId %], trigger, webhookUrl: 'https://test.com/v1/' };
 };
 
-describe('Component: Trigger <%= componentId %> should', () => {
+describe('Component: Trigger [%= componentId %] should', () => {
 
   describe('implement configure() and', () => {
 
@@ -66,7 +66,7 @@ describe('Component: Trigger <%= componentId %> should', () => {
       });
 
       // Assert that the webhook id, url and secret were stored
-      expect(trigger.store.get('webhookURL')).toEqual('https://test.com/v2/?triggerId=<%= componentId %>');
+      expect(trigger.store.get('webhookURL')).toEqual('https://test.com/v2/?triggerId=[%= componentId %]');
       expect(trigger.store.get('webhookID')).toEqual('mockWebhookId');
 
       // Assert that the configured inputs are returned
@@ -107,7 +107,7 @@ describe('Component: Trigger <%= componentId %> should', () => {
 
       const event = {} as CloudEvent<CloudEventData>;
 
-      await expect(trigger.run({ event })).rejects.toThrow('Component <%= componentId %> run() received no event payload');
+      await expect(trigger.run({ event })).rejects.toThrow('Component [%= componentId %] run() received no event payload');
     });
 
     it('return passed events', async () => {

package/assets/templates/add/trigger/src/components/{<%= componentName %>/<%= componentName %>.definition.json.ejs → [%= componentName %]/[%= componentName %].definition.json.ejs }

@@ -1,19 +1,19 @@
 {
-  "id": "<%= componentId %>",
-  "title": "<%= title %>",
-  "description": "<%= desc %>",
+  "id": "[%= componentId %]",
+  "title": "[%= title %]",
+  "description": "[%= desc %]",
   "type": "trigger",
-  "sdkVersion": "0.0.1"<% if (alert) { %>,
+  "sdkVersion": "0.0.1"[% if (alert) { %],
   "alerts": [{
     "type": "info",
     "content": "TODO: Add alert message. You can change the type to 'warning' or 'error' if needed."
-  }]<% } %><% if (http) { %>,
+  }][% } %][% if (http) { %],
   "request": {
     "config": {
       "method": "get",
       "url": "/"
     }
-  }<% } %><% if (inputs) { %>,
+  }[% } %][% if (inputs) { %],
   "inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",
@@ -24,11 +24,11 @@
         "type": "string",
         "title": "Event",
         "dynamicEnum": {
-          "componentId": "<%= connectorId %>.get",
+          "componentId": "[%= connectorId %].get",
           "processInputs": "${ }",
           "processOutputs": "${ [.[] | {label: .name, value: .type}] }"
         }
       }
     }
-  }<% } %>
+  }[% } %]
 }

package/assets/templates/add/trigger/src/components/{<%= componentName %>/<%= componentName %>.ts.ejs → [%= componentName %]/[%= componentName %].ts.ejs }

@@ -4,11 +4,11 @@ import {
   extractErrorMessage,
   RunFunctionReturnType,
   RunFunctionArgs,
-  <%= http ? 'HttpApp' : 'App' %>,
-  <%= http ? 'HttpComponent' : 'Component' %>,
+  [%= http ? 'HttpApp' : 'App' %],
+  [%= http ? 'HttpComponent' : 'Component' %],
 } from '@keragon/connector-sdk';
 
-export default class <%= firstLetterUpperCase(componentName) %> extends <%- http ? 'HttpComponent<HttpApp>' : 'Component<App>' %> implements HasSampleEvents {
+export default class [%= firstLetterUpperCase(componentName) %] extends [%- http ? 'HttpComponent<HttpApp>' : 'Component<App>' %] implements HasSampleEvents {
 
   override async configure(inputs: Record<string, unknown> = {}, webhookURL: string, ..._rest: string[]) {
     if (this.store.get('webhookID')) {
@@ -51,7 +51,7 @@ export default class <%= firstLetterUpperCase(componentName) %> extends <%- http
   async generateSampleEvents({ store: _, ...inputs }: Record<string, unknown>): Promise<SampleEvent[]> {
     const { a, b, c } = this.validateInputs(inputs);
     const items = await this.getDynamicValue({
-      componentId: '<%= connectorId %>.getItems<TODO set correct component>',
+      componentId: '[%= connectorId %].getItems<TODO set correct component>',
       processInputs: `\${ ${JSON.stringify({ a, b, c })} }`,
       processOutputs: '${ sort_by(.date) | reverse }'
     });

package/assets/templates/add/trigger/src/components/[%= componentName %]/index.ts.ejs

@@ -0,0 +1,7 @@
+import definition from './[%= componentName %].definition.json';
+import [%= firstLetterUpperCase(componentName) %] from './[%= componentName %]';
+
+export default {
+  ctor: [%= firstLetterUpperCase(componentName) %],
+  definition,
+};

package/assets/templates/create/connector/README.md.ejs

@@ -1 +1 @@
-# <%= name %> connector
+# [%= name %] connector

package/assets/templates/create/connector/keragon.json.ejs

@@ -1,3 +1,3 @@
 {
-  "name": "<%= name %>"
-}
+  "name": "[%= name %]"
+}

package/assets/templates/create/connector/package.json.ejs

@@ -1,7 +1,7 @@
 {
-  "name": "@keragonhq/<%= name %>",
+  "name": "@keragonhq/[%= name %]",
   "version": "0.0.1",
-  "description": "Keragon's built-in <%= firstLetterUpperCase(name) %> app",
+  "description": "Keragon's built-in [%= firstLetterUpperCase(name) %] app",
   "main": "index.js",
   "publishConfig": {
     "registry": "https://npm.pkg.github.com",

package/assets/templates/create/connector/src/[%= name %].definition.json.ejs

@@ -0,0 +1,19 @@
+{
+  "id": "com.keragon.[%= name %]",
+  "title": "[%= firstLetterUpperCase(name) %]",
+  "tags": [%- JSON.stringify(tags ?? []) %],
+  "icon": "/assets/[%= name %].svg",
+  "description": "[%= desc %]",
+  "version": "0.0.1",
+  "environments": [
+    {
+      "id": "com.keragon.[%= name %].environments.prod",
+      "title": "Production",
+      "description": "Production environment"[% if (http) { %],
+      "requestDefaults": {
+        "baseURL": "[%= baseUrl ? baseUrl : '<Replace with base URL>' %]"
+      },
+      "supportedAuthSchemes": [][% } %]
+    }
+  ]
+}

package/assets/templates/create/connector/src/index.ts.ejs

@@ -1,9 +1,9 @@
 import {
-  <%= http ? 'createHttpAppDescriptor' : 'createAppDescriptor' %>
+  [%= http ? 'createHttpAppDescriptor' : 'createAppDescriptor' %]
 } from '@keragon/connector-sdk';
 import components from './components';
-import definition from './<%= name %>.definition.json';
+import definition from './[%= name %].definition.json';
 
-export default <%= http ? 'createHttpAppDescriptor' : 'createAppDescriptor' %> ({
+export default [%= http ? 'createHttpAppDescriptor' : 'createAppDescriptor' %] ({
   definition: { ...definition, components },
 });