@keragon/connector-cli 0.0.1 → 0.0.2

package/assets/templates/add/action/src/components/<%= componentName %>/<%= componentName %>.definition.json.ejs

@@ -7,19 +7,19 @@
   const obj = {
     id: componentId,
     title: formatComponentTitle(componentName),
-    description: desc,
+    description: desc ?? "",
     type: "action",
     sdkVersion: "0.0.1"
   };
 
-  if (typeof alert !== 'undefined') {
+  if (alert) {
     obj.alerts = [{
       type: "info",
       content: `More info in [article](https://go.keragon.com/${componentName})`
     }];
   }
 
-  if (typeof http !== 'undefined') {
+  if (http) {
     obj.request = {
       config: {
         method: "get",
@@ -28,7 +28,7 @@
     };
   }
 
-  if (typeof pagination !== 'undefined') {
+  if (pagination) {
     obj.pagination = {
       strategy: pagination,
       maxItems: "${ .inputs.maxItems // 250 }"
@@ -54,7 +54,7 @@
     }
   }
 
-  if (typeof errorHandler !== 'undefined') {
+  if (errorHandler) {
     obj.response = {
       errorHandlers: [{
         condition: "${ .response.status != 200 }",
@@ -64,7 +64,7 @@
     };
   }
 
-  if (typeof inputs !== 'undefined') {
+  if (inputs) {
     obj.inputs = {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       type: "object",
@@ -83,7 +83,7 @@
       }
     };
 
-    if (typeof pagination !== 'undefined') {
+    if (pagination) {
       obj.inputs.properties.maxItems = {
         type: "number",
         title: "Max items",
@@ -92,7 +92,7 @@
     }
   }
 
-  if (typeof outputs !== 'undefined') {
+  if (outputs) {
     obj.outputs = {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       type: "array",

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

@@ -0,0 +1,34 @@
+import {
+  <%= isHttp ? 'HttpApp, HttpComponent,' : 'App, Component,' %>
+  RunFunctionArgs,
+  RunFunctionReturnType,
+} from "@keragon/connector-sdk";
+<%- isHttp ? "import { AxiosRequestConfig } from 'axios';" : '' %>
+
+export default class <%= className %> extends <%= isHttp ? 'HttpComponent' : 'Component' %><<%= isHttp ? 'HttpApp' : 'App' %>> {
+  <%_ if (isHttp) { _%>
+  override async onRequest({
+    requestConfig,
+  }: {
+    requestConfig: AxiosRequestConfig;
+  }): Promise<AxiosRequestConfig> {
+    const { method, url, headers, data: inputData } = await super.onRequest({ requestConfig });
+
+    throw new Error('Change default implementation of onRequest() method');
+
+    return {
+      method,
+      url,
+      headers,
+      data: {
+        ...inputData,
+      },
+    };
+  }
+  <%_ } 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/pollingtrigger/src/components/<%= componentName %>/<%= componentName %>.definition.json.ejs

@@ -4,7 +4,7 @@
   "description": "<%= desc %>",
   "type": "trigger",
   "sdkVersion": "0.0.1"
-  <% if (typeof alert !== 'undefined') { %>
+  <% if (alert) { %>
   ,"alerts": [{
     "type": "info",
     "content": "Due to vendor limitations you can have only one polling trigger"
@@ -24,7 +24,7 @@
       "processOutputs": "${ . | sort_by(.created_time) | reverse }"
     }
   }
-  <% if (typeof inputs !== 'undefined') { %>
+  <% if (inputs) { %>
   ,"inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",

package/assets/templates/add/trigger/src/components/<%= componentName %>/<%= componentName %>.definition.json.ejs

@@ -4,13 +4,13 @@
   "description": "<%= desc %>",
   "type": "trigger",
   "sdkVersion": "0.0.1"
-  <% if (typeof alert !== 'undefined') { %>
+  <% if (alert) { %>
   ,"alerts": [{
     "type": "info",
     "content": "Please follow the [article](https://go.keragon.com/<%= componentName %>) to set up the trigger"
   }]
   <% } %>
-  <% if (typeof http !== 'undefined') { %>
+  <% if (http) { %>
   ,"request": {
     "config": {
       "method": "get",
@@ -18,7 +18,7 @@
     }
   }
   <% } %>
-  <% if (typeof inputs !== 'undefined') { %>
+  <% if (inputs) { %>
   ,"inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",