@kaleido-io/workflow-engine-sdk 0.9.2 → 0.9.4

package/template/package.json

@@ -16,6 +16,7 @@
     },
     "private": true,
     "devDependencies": {
+        "@types/js-yaml": "^4.0.9",
         "@vitest/coverage-v8": "^4.0.16",
         "tsx": "^4.21.0",
         "typescript": "^5.9.3",
@@ -28,9 +29,10 @@
         "README.md"
     ],
     "dependencies": {
-        "@kaleido-io/workflow-engine-sdk": "^1.0.0",
+        "@kaleido-io/workflow-engine-sdk": "^0.9.4",
         "dotenv": "^17.2.3",
+        "js-yaml": "^4.1.1",
         "web3": "^4.16.0",
         "ws": "^8.18.0"
     }
-}
+}

package/template/src/connect.ts

@@ -14,45 +14,43 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 import {
   newDirectedTransactionHandler,
-  WorkflowEngineClient,
-} from '@kaleido-io/workflow-engine-sdk';
-import dotenv from 'dotenv';
-
-import provider from './provider.js';
-
-import { actionMap as helloActionMap } from './samples/hello/handlers.js';
-import { actionMap as httpInvokeActionMap } from './samples/http-invoke/handlers.js';
-import { eventSource } from './samples/event-source/event-source.js';
-import { actionMap as snapActionMap } from './samples/snap/snap-handler.js';
-import { echoEventProcessor } from './samples/event-source/event-processor.js';
-import { eventSource as dealerEventSource } from './samples/snap/event-source.js';
+  NewWorkflowEngineClient,
+  HandlerSetFor,
+} from "@kaleido-io/workflow-engine-sdk";
+import dotenv from "dotenv";
+
+import { actionMap as helloActionMap } from "./samples/hello/handlers.js";
+import { actionMap as httpInvokeActionMap } from "./samples/http-invoke/handlers.js";
+import { eventSource } from "./samples/event-source/event-source.js";
+import { actionMap as snapActionMap } from "./samples/snap/snap-handler.js";
+import { echoEventProcessor } from "./samples/event-source/event-processor.js";
+import { eventSource as dealerEventSource } from "./samples/snap/event-source.js";
 
 dotenv.config();
-const wsUrl = `wss://${process.env.ACCOUNT}/endpoint/${process.env.ENVIRONMENT}/${process.env.WORKFLOW_ENGINE}/rest/ws`;
-const client = new WorkflowEngineClient({
-  url: wsUrl,
-  authHeaderName: 'Authorization',
-  authToken: `basic ${Buffer.from(`${process.env.KEY_NAME}:${process.env.KEY_VALUE}`).toString("base64")}`,
-  providerName: provider.name,
-  providerMetadata: provider.metadata ?? {},
-  reconnectDelay: 2000,
-});
-
-const helloHandler = newDirectedTransactionHandler('hello', helloActionMap);
-client.registerTransactionHandler('hello', helloHandler);
-
-const httpInvokeHandler = newDirectedTransactionHandler('http-invoke', httpInvokeActionMap);
-client.registerTransactionHandler('http-invoke', httpInvokeHandler);
-
-client.registerEventProcessor('echo', echoEventProcessor);
-client.registerEventSource('my-listener', eventSource);
-
-const snapHandler = newDirectedTransactionHandler('snap-watcher', snapActionMap);
-client.registerTransactionHandler('snap-watcher', snapHandler);
-
-client.registerEventSource('snap-dealer', dealerEventSource);
 
-await client.connect();
+const helloHandler = newDirectedTransactionHandler("hello", helloActionMap);
+const httpInvokeHandler = newDirectedTransactionHandler(
+  "http-invoke",
+  httpInvokeActionMap,
+);
+const snapHandler = newDirectedTransactionHandler(
+  "snap-watcher",
+  snapActionMap,
+);
+
+const client = await NewWorkflowEngineClient(
+  HandlerSetFor(
+    helloHandler,
+    httpInvokeHandler,
+    echoEventProcessor,
+    eventSource,
+    snapHandler,
+    dealerEventSource,
+  ),
+  process.env.WFE_CONFIG_FILE ?? "./config/wfe-config.yaml",
+);
+
+process.on("SIGINT", () => client.disconnect());
+process.on("SIGTERM", () => client.disconnect());

package/template/src/provider.ts

@@ -16,9 +16,9 @@
 
 
 export default {
-    "name": "example-provider",
-    "metadata": {
-        "displayName": "Example provider",
-        "description": "An example provider for the Kaleido Workflow Engine"
+    'name': 'example-provider',
+    'metadata': {
+        'displayName': 'Example provider',
+        'description': 'An example provider for the Kaleido Workflow Engine'
     }
 }

package/template/src/samples/event-source/echo-handler.ts

@@ -15,7 +15,7 @@
 // limitations under the License.
 
 
-import { BasicStageDirector, DirectedActionConfig, EvalResult, InvocationMode, WithStageDirector, WSEvaluateTransaction } from "@kaleido-io/workflow-engine-sdk";
+import { BasicStageDirector, DirectedActionConfig, EvalResult, InvocationMode, WithStageDirector, WSEvaluateTransaction } from '@kaleido-io/workflow-engine-sdk';
 
 class MyHandlerInput implements WithStageDirector {
     public stageDirector: BasicStageDirector;
@@ -43,7 +43,7 @@ class MyHandlerInput implements WithStageDirector {
 }
 
 const map: Map<string, DirectedActionConfig<MyHandlerInput>> = new Map([
-    ["echo", {
+    ['echo', {
         invocationMode: InvocationMode.PARALLEL, handler: async (transaction: WSEvaluateTransaction) => {
             if (transaction.state?.input?.data === undefined || transaction.state?.input?.data?.message === undefined) {
                 return {

package/template/src/samples/event-source/event-processor.ts

@@ -14,7 +14,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { EngineAPI, WSEventProcessorBatchRequest, WSEventProcessorBatchResult } from "@kaleido-io/workflow-engine-sdk";
+import { EngineAPI, WSEventProcessorBatchRequest, WSEventProcessorBatchResult } from '@kaleido-io/workflow-engine-sdk';
 
 export class MyEventProcessor {
 

package/template/src/samples/event-source/event-source.ts

@@ -15,7 +15,7 @@
 // limitations under the License.
 
 
-import { EventSourceConf, EventSourceEvent, newEventSource, newLogger, WSEventStreamInfo } from "@kaleido-io/workflow-engine-sdk";
+import { EventSourceConf, EventSourceEvent, newEventSource, newLogger, WSEventStreamInfo } from '@kaleido-io/workflow-engine-sdk';
 
 const log = newLogger('event-source');
 

package/template/src/samples/event-source/stream.ts

@@ -18,17 +18,17 @@
 import provider from '../../provider.js';
 
 export const stream = {
-    "name": "event-echo-stream",
-    "description": "Listen for events from the custom event source and pass them to the echo event processor",
-    "type": "event_stream",
-    "config": {
-        "pollingInterval": "2s"
+    'name': 'event-echo-stream',
+    'description': 'Listen for events from the custom event source and pass them to the echo event processor',
+    'type': 'event_stream',
+    'config': {
+        'pollingInterval': '2s'
     },
-    "listenerHandler": "my-listener",
-    "listenerHandlerProvider": provider.name,
-    "eventHandler": "echo",
-    "eventHandlerProvider": provider.name,
-    "postFilter": {
-        "jsonata": "true"
+    'listenerHandler': 'my-listener',
+    'listenerHandlerProvider': provider.name,
+    'eventHandler': 'echo',
+    'eventHandlerProvider': provider.name,
+    'postFilter': {
+        'jsonata': 'true'
     }
 }

package/template/src/samples/hello/flow.ts

@@ -17,58 +17,58 @@
 
 import provider from '../../provider.js';
 export const flow = {
-  "name": "hello-flow",
-  "description": "",
-  "labels": {},
-  "handlerBindings": {
-    "hello": {
-      "provider": provider.name,
-      "providerHandler": "hello"
+  'name': 'hello-flow',
+  'description': '',
+  'labels': {},
+  'handlerBindings': {
+    'hello': {
+      'provider': provider.name,
+      'providerHandler': 'hello'
     }
   },
-  "version": "1.0.0",
-  "operations": [
+  'version': '1.0.0',
+  'operations': [
     {
-      "name": "hello",
-      "description": "Hello",
-      "type": "asynchronous",
-      "stage": "my-beginning-state",
-      "stateUpdates": null,
-      "inputSchema": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": [
-              "string"
+      'name': 'hello',
+      'description': 'Hello',
+      'type': 'asynchronous',
+      'stage': 'my-beginning-state',
+      'stateUpdates': null,
+      'inputSchema': {
+        'type': 'object',
+        'properties': {
+          'name': {
+            'type': [
+              'string'
             ]
           }
         },
-        "required": [
-          "name"
+        'required': [
+          'name'
         ],
-        "additionalProperties": false
+        'additionalProperties': false
       }
     }
   ],
-  "stages": [
+  'stages': [
     {
-      "name": "my-beginning-state",
-      "type": "pending",
-      "handler": "hello",
-      "inputMap": {
-        "jsonata": "{\n    \"action\": \"hello\",\n    \"invoke\": {\n      \"input\": state.input\n    },\n    \"nextStage\": \"end\",\n    \"failureStage\": \"failure\",\n    \"outputPath\": \"/output\"\n}\n"
+      'name': 'my-beginning-state',
+      'type': 'pending',
+      'handler': 'hello',
+      'inputMap': {
+        'jsonata': '{\n    "action": "hello",\n    "invoke": {\n      "input": state.input\n    },\n    "nextStage": "end",\n    "failureStage": "failure",\n    "outputPath": "/output"\n}\n'
       },
-      "fullState": true
+      'fullState': true
     },
     {
-      "name": "end",
-      "type": "success",
-      "handler": ""
+      'name': 'end',
+      'type': 'success',
+      'handler': ''
     },
     {
-      "name": "failure",
-      "type": "failure",
-      "handler": ""
+      'name': 'failure',
+      'type': 'failure',
+      'handler': ''
     }
   ]
 }

package/template/src/samples/hello/handlers.ts

@@ -15,7 +15,7 @@
 // limitations under the License.
 
 
-import { BasicStageDirector, DirectedActionConfig, EvalResult, InvocationMode, WithStageDirector, WSEvaluateTransaction } from "@kaleido-io/workflow-engine-sdk";
+import { BasicStageDirector, DirectedActionConfig, EvalResult, InvocationMode, WithStageDirector, WSEvaluateTransaction } from '@kaleido-io/workflow-engine-sdk';
 
 class MyHandlerInput implements WithStageDirector {
     public stageDirector: BasicStageDirector;
@@ -43,7 +43,7 @@ class MyHandlerInput implements WithStageDirector {
 }
 
 const map: Map<string, DirectedActionConfig<MyHandlerInput>> = new Map([
-    ["hello", {
+    ['hello', {
         invocationMode: InvocationMode.PARALLEL, handler: async (transaction: WSEvaluateTransaction) => {
             if (transaction.state?.input?.name === undefined) {
                 return {

package/template/src/samples/hello/transaction.ts

@@ -16,9 +16,9 @@
 
 
 export const transaction = {
-    "input": {
-      "name": "workflow engine developer"
+    'input': {
+      'name': 'workflow engine developer'
     },
-    "operation": "hello",
-    "workflow": "hello-flow"
+    'operation': 'hello',
+    'workflow': 'hello-flow'
   }

package/template/src/samples/http-invoke/flow.ts

@@ -17,47 +17,47 @@
 
 import provider from '../../provider.js';
 export const flow = {
-  "name": "http-invoke-flow",
-  "description": "",
-  "labels": {},
-  "handlerBindings": {
-    "http-invoke": {
-      "provider": provider.name,
-      "providerHandler": "http-invoke"
+  'name': 'http-invoke-flow',
+  'description': '',
+  'labels': {},
+  'handlerBindings': {
+    'http-invoke': {
+      'provider': provider.name,
+      'providerHandler': 'http-invoke'
     }
   },
-  "version": "1.0.0",
-  "operations": [
+  'version': '1.0.0',
+  'operations': [
     {
-      "name": "http-invoke",
-      "description": "HTTP Invoke",
-      "type": "asynchronous",
-      "stage": "start",
-      "inputSchema": {
-        "type": "object",
-        "additionalProperties": true
+      'name': 'http-invoke',
+      'description': 'HTTP Invoke',
+      'type': 'asynchronous',
+      'stage': 'start',
+      'inputSchema': {
+        'type': 'object',
+        'additionalProperties': true
       }
     }
   ],
-  "stages": [
+  'stages': [
     {
-      "name": "start",
-      "type": "pending",
-      "handler": "http-invoke",
-      "inputMap": {
-        "jsonata": "{\n    \"action\": \"http-invoke\",\n    \"invoke\": {\n      \"input\": state.input\n    },\n    \"nextStage\": \"end\",\n    \"failureStage\": \"failure\",\n    \"outputPath\": \"/output\"\n}\n"
+      'name': 'start',
+      'type': 'pending',
+      'handler': 'http-invoke',
+      'inputMap': {
+        'jsonata': '{\n    "action": "http-invoke",\n    "invoke": {\n      "input": state.input\n    },\n    "nextStage": "end",\n    "failureStage": "failure",\n    "outputPath": "/output"\n}\n'
       },
-      "fullState": true
+      'fullState': true
     },
     {
-      "name": "end",
-      "type": "success",
-      "handler": ""
+      'name': 'end',
+      'type': 'success',
+      'handler': ''
     },
     {
-      "name": "failure",
-      "type": "failure",
-      "handler": ""
+      'name': 'failure',
+      'type': 'failure',
+      'handler': ''
     }
   ]
 }

package/template/src/samples/http-invoke/handlers.ts

@@ -14,53 +14,102 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import * as fs from 'fs';
+import * as path from 'path';
+import yaml from 'js-yaml';
+import {
+  BasicStageDirector,
+  DirectedActionConfig,
+  EvalResult,
+  InvocationMode,
+  WithStageDirector,
+} from '@kaleido-io/workflow-engine-sdk';
 
-import { BasicStageDirector, DirectedActionConfig, EvalResult, InvocationMode, WithStageDirector } from "@kaleido-io/workflow-engine-sdk";
+export interface HTTPInvokeConfig {
+  url: string;
+  invocationMode: keyof typeof InvocationMode;
+  apiKeyHeader: string;
+}
+
+function resolveAppConfigPath(): string | undefined {
+  const fromEnv = process.env.CONFIG_FILE?.trim();
+  const candidates = [
+    fromEnv,
+    path.join(process.cwd(), 'src', 'config', 'config.yaml'),
+    path.join(process.cwd(), 'config', 'config.yaml'),
+  ].filter(Boolean) as string[];
+  for (const p of candidates) {
+    if (fs.existsSync(p)) {
+      return p;
+    }
+  }
+  return undefined;
+}
+
+function loadAppConfig(): { httpInvoke?: HTTPInvokeConfig } {
+  const configPath = resolveAppConfigPath();
+  if (!configPath) {
+    return {};
+  }
+  const raw = fs.readFileSync(configPath, 'utf8');
+  return yaml.load(raw) as { httpInvoke?: HTTPInvokeConfig };
+}
 
 class HTTPInvokeHandlerInput implements WithStageDirector {
-    public stageDirector: BasicStageDirector;
-    public action1?: { inputA: string };
-    public action2?: { inputB: string };
-    public customData?: any;
+  public stageDirector: BasicStageDirector;
+  public action1?: { inputA: string };
+  public action2?: { inputB: string };
+  public customData?: any;
 
-    constructor(data: any) {
-        this.stageDirector = new BasicStageDirector(
-            data.action || 'http-invoke',
-            data.outputPath || '/output',
-            data.nextStage || 'end',
-            data.failureStage || 'failed'
-        );
-        this.customData = data.customData;
-    }
+  constructor(data: any) {
+    this.stageDirector = new BasicStageDirector(
+      data.action || 'http-invoke',
+      data.outputPath || '/output',
+      data.nextStage || 'end',
+      data.failureStage || 'failed',
+    );
+    this.customData = data.customData;
+  }
 
-    getStageDirector(): BasicStageDirector {
-        return this.stageDirector;
-    }
+  getStageDirector(): BasicStageDirector {
+    return this.stageDirector;
+  }
 
-    name(): string {
-        return 'hello';
-    }
+  name(): string {
+    return 'hello';
+  }
 }
 
-const url = 'https://httpbin.org/get';
+const appConfig = loadAppConfig();
+const httpInvoke = appConfig.httpInvoke ?? {
+  url: 'https://httpbin.org/get',
+  invocationMode: 'PARALLEL' as const,
+  apiKeyHeader: 'X-API-KEY',
+};
+
 const map: Map<string, DirectedActionConfig<HTTPInvokeHandlerInput>> = new Map([
-    ["http-invoke", {
-        invocationMode: InvocationMode.PARALLEL, handler: async () => {
-            const response = await fetch(url, {
-                headers: {
-                    'X-API-KEY': process.env.API_KEY ?? '',
-                },
-            });
-            const body = await response.json();
-            return {
-                result: EvalResult.COMPLETE,
-                output: {
-                    body,
-                    status: response.status,
-                },
-            }
-        }
-    }],
+  [
+    'http-invoke',
+    {
+      invocationMode:
+        InvocationMode[httpInvoke.invocationMode] ?? InvocationMode.PARALLEL,
+      handler: async () => {
+        const response = await fetch(httpInvoke.url, {
+          headers: {
+            [httpInvoke.apiKeyHeader]: process.env.API_KEY ?? '',
+          },
+        });
+        const body = await response.json();
+        return {
+          result: EvalResult.COMPLETE,
+          output: {
+            body,
+            status: response.status,
+          },
+        };
+      },
+    },
+  ],
 ]);
 
-export const actionMap = map;
+export const actionMap = map;

package/template/src/samples/http-invoke/transaction.ts

@@ -16,7 +16,7 @@
 
 
 export const transaction = {
-    "input": {},
-    "operation": "http-invoke",
-    "workflow": "http-invoke-flow"
+    'input': {},
+    'operation': 'http-invoke',
+    'workflow': 'http-invoke-flow'
 }

package/template/src/samples/snap/event-source.ts

@@ -14,7 +14,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { EventSourceConf, newEventSource, newLogger, WSEventStreamInfo } from "@kaleido-io/workflow-engine-sdk";
+import { EventSourceConf, newEventSource, newLogger, WSEventStreamInfo } from '@kaleido-io/workflow-engine-sdk';
 
 const log = newLogger('dealer-event-source');