@keragon/connector-cli 0.0.4 → 0.0.6

package/README.md

@@ -1,91 +1,23 @@
-# Keragon monorepo
+# Keragon Connector CLI
 
-Welcome to Keragon's monorepo! Please read below for more info and instructions on how to use. 
+The official command-line interface (CLI) for building, testing, and managing connectors on the Keragon platform.
 
-- [Local development setup guide](https://www.notion.so/keragon/Keragon-Local-Development-Guide-160d9e88eb8e46bdad51d8b33a865f3d)
-- [App configuration setup](https://www.notion.so/App-Config-b7f62c2df4324b329cf9e41412b2f3de)
+## Installation
 
-## 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`.
+```bash
+npm install -g @keragon/connector-cli
+```
 
 ## 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...]`
+Run the following command to display a list of all available commands:
 
-### Options
+```bash
+kc --help
+```
 
-- `-h`, `--help`: Display the help message and exit.
+Each command supports its own help flag for detailed usage information. For example:
 
+```bash
+kc login --help
+```

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

@@ -3,13 +3,11 @@
   "title": "<%= title %>",
   "description": "<%= desc %>",
   "type": "trigger",
-  "sdkVersion": "0.0.1"
-  <% if (alert) { %>
-  ,"alerts": [{
+  "sdkVersion": "0.0.1"<% if (alert) { %>,
+  "alerts": [{
     "type": "info",
-    "content": "Due to vendor limitations you can have only one polling trigger"
-  }]
-  <% } %>,
+    "content": "TODO: Add alert message. You can change the type to 'warning' or 'error' if needed."
+  }]<% } %>,
   "poll": {
     "schedule": {
       "cron": "*/5 * * * *"
@@ -23,15 +21,12 @@
       "processInputs": "${ { event: .event } }",
       "processOutputs": "${ . | sort_by(.created_time) | reverse }"
     }
-  }
-  <% if (inputs) { %>
-  ,"inputs": {
+  }<% if (inputs) { %>,
+  "inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",
     "additionalProperties": false,
-    "required": [
-      "event"
-    ],
+    "required": ["event"],
     "properties": {
       "event": {
         "type": "string",
@@ -43,6 +38,5 @@
         }
       }
     }
-  }
-  <% } %>
+  }<% } %>
 }

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

@@ -3,29 +3,22 @@
   "title": "<%= title %>",
   "description": "<%= desc %>",
   "type": "trigger",
-  "sdkVersion": "0.0.1"
-  <% if (alert) { %>
-  ,"alerts": [{
+  "sdkVersion": "0.0.1"<% if (alert) { %>,
+  "alerts": [{
     "type": "info",
-    "content": "Please follow the [article](https://go.keragon.com/<%= componentName %>) to set up the trigger"
-  }]
-  <% } %>
-  <% if (http) { %>
-  ,"request": {
+    "content": "TODO: Add alert message. You can change the type to 'warning' or 'error' if needed."
+  }]<% } %><% if (http) { %>,
+  "request": {
     "config": {
       "method": "get",
       "url": "/"
     }
-  }
-  <% } %>
-  <% if (inputs) { %>
-  ,"inputs": {
+  }<% } %><% if (inputs) { %>,
+  "inputs": {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",
     "additionalProperties": false,
-    "required": [
-      "event"
-    ],
+    "required": ["event"],
     "properties": {
       "event": {
         "type": "string",
@@ -37,6 +30,5 @@
         }
       }
     }
-  }
-  <% } %>
+  }<% } %>
 }

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

@@ -8,27 +8,22 @@ import {
   <%= http ? 'HttpComponent' : 'Component' %>,
 } from '@keragon/connector-sdk';
 
-const WEBHOOK_ID = 'webhookID';
-const WEBHOOK_URL = 'webhookURL';
-
 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(WEBHOOK_ID)) {
+    if (this.store.get('webhookID')) {
       await this.deactivate();
     }
     const configuredInputs = await super.configure(inputs);
     const url = new URL(webhookURL);
     url.pathname = url.pathname.replace('/v1/', '/v2/');
     url.searchParams.set('triggerId', this.definition.id.toLowerCase());
-    this.store.set(WEBHOOK_URL, url.toString());
-    this.store.set(WEBHOOK_URL, url.toString());
+    this.store.set('webhookURL', url.toString());
     
     const client = await this.app.getClient();
     try {
       const { data: { id } } = await client.post('/', {});
-      this.store.set(WEBHOOK_URL, webhookURL);
-      this.store.set(WEBHOOK_ID, id);
+      this.store.set('webhookID', id);
       return configuredInputs;
     } catch (error) {
       throw new Error(`Failed to configure ${this.definition.id} because ${extractErrorMessage(error)}.`);
@@ -45,7 +40,9 @@ export default class <%= firstLetterUpperCase(componentName) %> extends <%- http
 
   override async deactivate() {
     try {
-      this.store.delete(WEBHOOK_URL);
+      this.store.delete('webhookURL');
+      this.store.delete('webhookID');
+      // TODO: delete webhook from API
     } catch (error) {
       throw new Error(`Failed to deactivate "${this.definition.id}" because ${extractErrorMessage(error)}`);
     }