@keragon/connector-cli 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,91 @@
+# Keragon monorepo
+
+Welcome to Keragon's monorepo! Please read below for more info and instructions on how to use. 
+
+- [Local development setup guide](https://www.notion.so/keragon/Keragon-Local-Development-Guide-160d9e88eb8e46bdad51d8b33a865f3d)
+- [App configuration setup](https://www.notion.so/App-Config-b7f62c2df4324b329cf9e41412b2f3de)
+
+## Nx
+
+Keragon uses [Nx](https://nx.dev/) to build, maintain and grow our codebase.
+
+**Why Nx?** 
+
+- Code generation / scaffolding — generators generate applications, components, standard pieces of code (like cookie-cutters) — they also help you migrate across versions. This helps to maintain consistency as we grow.
+- Dependency graph and code change analysis — only build/test/lint projects that are affected by a code change — Nx understands your workspace, and makes optimizations — it also visualizes the dependencies with the dependency graph
+- Speed — computation caching will ensure that when you rerun the same command, the results will be fetched from the cache — together with the affected command and distributed task execution and Nx Cloud you never build/test/lint the same code twice
+- Nx CLI — Integrated environment with consistent syntax for executing commands.
+- Plugins — for modern web technologies and tools include their own executors and generators which will help you develop projects using the tools you like
+- IDE integration — Nx Editor Plugins give you access to all that the Nx CLI can do, but from a GUI. 
+
+[Source](https://blog.nrwl.io/build-your-design-system-with-storybook-nx-e3bde4087ad8)
+
+## Packages
+
+This monorepo contains the following packages:
+
+| Subfolder                                                                          | Description                                                                                                              |
+|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
+| [`apps/api/`](apps/api/)                                                           | This package hosts Keragon's API
+| [`apps/billing`](apps/billing/)                                                    | Billing service (temporal worker billing)
+| [`apps/dashboard/`](apps/dashboard)                                                | A web app for building workflows visually                                             |
+| [`apps/dsl-runtime/`](apps/dsl-runtime)                                            | This package is used to run workflows and manage their runtime                                             |
+| [`packages/catalog-client`](packages/catalog-client)                               | Connector catalog client as source of truth for available connectors in Keragon
+| [`packages/dsl-sdk/`](packages/dsl-sdk)                                            | The DSL SDK is used to build and manipulate Keragon's workflow DSL                                             |
+| [`packages/authentications/`](packages/authentications)                            | This package manages 3rd party app authorizations                                         |
+| [`packages/connector-sdk/`](packages/connector-sdk/)                               | This is the SDK for building new connectors.
+| [`packages/connectors/`](packages/connectors/)                                     | This package hosts all the Keragon built-in connectors.
+| [`packages/copilot`](packages/copilot/) | A Langgraph implementation of our Copilot
+| [`packages/fixtures/`](packages/fixtures/)                                         | This package hosts fixtures reused in tests across Keragon. This is the central place with the latest DSL configuration too.
+| [`packages/secrets-manager/`](packages/secrets-manager/)                           | A wrapper around AWS Secrets Manager and KMS clients to be reused across the monorepo. 
+| [`packages/jq-parser/`](packages/jq-parser/)                           | Parses JQ expressions into easily parsable structures. 
+| [`packages/dashboard-auth/`](packages/dashboard-auth/)                                       | React components related to the auth flow in the dashboard.
+| [`packages/shared/ui/`](packages/shared/ui/)                                       | Keragon's reusable React components.
+| [`packages/shared/util-credentials/`](packages/shared/util-credentials/)           | Credentials related utility methods that are reused across the monorepo.
+| [`packages/shared/types/`](packages/shared/types/)                                 | Typescript types/interfaces/classes that are reused across the monorepo.
+| [`packages/shared/util-dsl/`](packages/shared/util-dsl/)           | Utilities to work with the specific way we use the Serverless DSL in Keragon. 
+| [`packages/shared/util-jsonschema`](packages/shared/util-jsonschema/) | Utilities to work with json schema that are not available out there eg. `evalSchema`
+
+## Main commands
+
+### Installing dependencies in workspaces
+
+`npm install <dep-name> -w @keragon/<package-name>`
+
+### Building packages 
+
+- `nx run-many --target=build` (build all) 
+- `nx run <prohect-name:>build` (build only the specified package)
+
+### Running tests
+
+- `nx run-many --target=test` (build all) 
+
+### Running eslint
+
+- `nx run-many --target=lint` 
+
+### Bootstraping packages
+
+`npm install`
+
+## How to create a new package
+
+Use an Nx app or library generator. See [docs](https://nx.dev/packages/workspace/generators/new)
+
+You can install Nx Console in your editor (if suppported) to run these commands from the UI.
+
+# Service Starter Script
+
+This script is designed to simplify the process of starting various services in a development environment, including an `ngrok` tunnel and services like `api`, `processor`, `dsl-runtime`, `dashboard`, and `lambda`.
+
+## Usage
+
+To use the script, you may specify one or more services you wish to start. If no services are specified, all available services will be started by default.
+
+`./start-services.sh [options] [services...]`
+
+### Options
+
+- `-h`, `--help`: Display the help message and exit.
+

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",
@@ -74,6 +74,7 @@
         id: {
           type: "string",
           title: "ID",
+          description: "ID of the item to retrieve",
           dynamicEnum: {
             componentId: `${connectorId}.get`,
             processInputs: "${ }",
@@ -83,7 +84,7 @@
       }
     };
 
-    if (typeof pagination !== 'undefined') {
+    if (pagination) {
       obj.inputs.properties.maxItems = {
         type: "number",
         title: "Max items",
@@ -92,7 +93,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",