@stepflowjs/trigger-stream 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+import { Trigger, TriggerHandler } from '@stepflowjs/core';
+
+interface StreamTriggerConfig<T = unknown> {
+    /** Identifier for the stream source */
+    source: string;
+    /** The async iterable to consume */
+    stream: AsyncIterable<T>;
+    /** Optional transform function to apply to each item */
+    transform?: (item: T) => unknown;
+}
+/**
+ * Generic async iterable stream trigger for Stepflow workflows
+ *
+ * Consumes items from an AsyncIterable and creates trigger events for each item.
+ * This is a base class for custom stream-based triggers (e.g., Kafka, NATS, message queues).
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with async generator
+ * async function* numberStream() {
+ *   for (let i = 0; i < 10; i++) {
+ *     yield i;
+ *   }
+ * }
+ *
+ * const trigger = new StreamTrigger({
+ *   source: 'number-stream',
+ *   stream: numberStream(),
+ *   transform: (n) => ({ value: n, squared: n * n }),
+ * });
+ *
+ * await trigger.start(async (event) => {
+ *   await stepflow.trigger('process-number', event.data);
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using the helper function
+ * const trigger = createStreamTrigger(
+ *   'events',
+ *   eventStream,
+ *   (event) => ({ ...event, processed: true })
+ * );
+ * ```
+ */
+declare class StreamTrigger<T = unknown> implements Trigger<StreamTriggerConfig<T>> {
+    readonly config: StreamTriggerConfig<T>;
+    readonly type = "stream";
+    private handler?;
+    private abortController?;
+    private running;
+    private consumePromise?;
+    constructor(config: StreamTriggerConfig<T>);
+    /**
+     * Start the trigger with a handler function
+     * @param handler Function to call when stream items are received
+     */
+    start(handler: TriggerHandler): Promise<void>;
+    /**
+     * Consume items from the stream and create trigger events
+     * @private
+     */
+    private consumeStream;
+    /**
+     * Stop the trigger and cancel stream consumption
+     */
+    stop(): Promise<void>;
+    /**
+     * Health check - returns true if trigger is running
+     */
+    healthCheck(): Promise<boolean>;
+}
+/**
+ * Create a stream trigger from an async iterable
+ *
+ * @param source Identifier for the stream source
+ * @param stream The async iterable to consume
+ * @param transform Optional transform function to apply to each item
+ * @returns A new StreamTrigger instance
+ *
+ * @example
+ * ```typescript
+ * const trigger = createStreamTrigger(
+ *   'kafka-topic',
+ *   kafkaConsumer,
+ *   (msg) => JSON.parse(msg.value)
+ * );
+ * ```
+ */
+declare function createStreamTrigger<T>(source: string, stream: AsyncIterable<T>, transform?: (item: T) => unknown): StreamTrigger<T>;
+
+export { StreamTrigger, type StreamTriggerConfig, createStreamTrigger };

package/dist/index.js

@@ -0,0 +1,79 @@
+// src/index.ts
+var StreamTrigger = class {
+  constructor(config) {
+    this.config = config;
+  }
+  type = "stream";
+  handler;
+  abortController;
+  running = false;
+  consumePromise;
+  /**
+   * Start the trigger with a handler function
+   * @param handler Function to call when stream items are received
+   */
+  async start(handler) {
+    if (this.running) {
+      throw new Error("StreamTrigger is already running");
+    }
+    this.handler = handler;
+    this.abortController = new AbortController();
+    this.running = true;
+    this.consumePromise = this.consumeStream().catch((error) => {
+      if (error.name !== "AbortError") {
+        console.error("Stream error:", error);
+      }
+    });
+  }
+  /**
+   * Consume items from the stream and create trigger events
+   * @private
+   */
+  async consumeStream() {
+    try {
+      for await (const item of this.config.stream) {
+        if (!this.running) break;
+        const data = this.config.transform ? this.config.transform(item) : item;
+        const event = {
+          id: crypto.randomUUID(),
+          type: this.type,
+          source: this.config.source,
+          data,
+          metadata: {},
+          timestamp: /* @__PURE__ */ new Date()
+        };
+        await this.handler?.(event);
+      }
+    } catch (error) {
+      if (this.running) {
+        throw error;
+      }
+    }
+  }
+  /**
+   * Stop the trigger and cancel stream consumption
+   */
+  async stop() {
+    this.running = false;
+    this.abortController?.abort();
+    this.handler = void 0;
+    if (this.consumePromise) {
+      await this.consumePromise.catch(() => {
+      });
+    }
+  }
+  /**
+   * Health check - returns true if trigger is running
+   */
+  async healthCheck() {
+    return this.running;
+  }
+};
+function createStreamTrigger(source, stream, transform) {
+  return new StreamTrigger({ source, stream, transform });
+}
+export {
+  StreamTrigger,
+  createStreamTrigger
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Trigger, TriggerHandler, TriggerEvent } from \"@stepflowjs/core\";\n\n// ============================================================================\n// Types\n// ============================================================================\n\nexport interface StreamTriggerConfig<T = unknown> {\n  /** Identifier for the stream source */\n  source: string;\n  /** The async iterable to consume */\n  stream: AsyncIterable<T>;\n  /** Optional transform function to apply to each item */\n  transform?: (item: T) => unknown;\n}\n\n// ============================================================================\n// StreamTrigger Implementation\n// ============================================================================\n\n/**\n * Generic async iterable stream trigger for Stepflow workflows\n *\n * Consumes items from an AsyncIterable and creates trigger events for each item.\n * This is a base class for custom stream-based triggers (e.g., Kafka, NATS, message queues).\n *\n * @example\n * ```typescript\n * // Basic usage with async generator\n * async function* numberStream() {\n *   for (let i = 0; i < 10; i++) {\n *     yield i;\n *   }\n * }\n *\n * const trigger = new StreamTrigger({\n *   source: 'number-stream',\n *   stream: numberStream(),\n *   transform: (n) => ({ value: n, squared: n * n }),\n * });\n *\n * await trigger.start(async (event) => {\n *   await stepflow.trigger('process-number', event.data);\n * });\n * ```\n *\n * @example\n * ```typescript\n * // Using the helper function\n * const trigger = createStreamTrigger(\n *   'events',\n *   eventStream,\n *   (event) => ({ ...event, processed: true })\n * );\n * ```\n */\nexport class StreamTrigger<T = unknown> implements Trigger<\n  StreamTriggerConfig<T>\n> {\n  readonly type = \"stream\";\n  private handler?: TriggerHandler;\n  private abortController?: AbortController;\n  private running = false;\n  private consumePromise?: Promise<void>;\n\n  constructor(readonly config: StreamTriggerConfig<T>) {}\n\n  /**\n   * Start the trigger with a handler function\n   * @param handler Function to call when stream items are received\n   */\n  async start(handler: TriggerHandler): Promise<void> {\n    if (this.running) {\n      throw new Error(\"StreamTrigger is already running\");\n    }\n\n    this.handler = handler;\n    this.abortController = new AbortController();\n    this.running = true;\n\n    // Start consuming the stream in the background\n    this.consumePromise = this.consumeStream().catch((error) => {\n      if (error.name !== \"AbortError\") {\n        console.error(\"Stream error:\", error);\n      }\n    });\n  }\n\n  /**\n   * Consume items from the stream and create trigger events\n   * @private\n   */\n  private async consumeStream(): Promise<void> {\n    try {\n      for await (const item of this.config.stream) {\n        if (!this.running) break;\n\n        const data = this.config.transform ? this.config.transform(item) : item;\n\n        const event: TriggerEvent = {\n          id: crypto.randomUUID(),\n          type: this.type,\n          source: this.config.source,\n          data,\n          metadata: {},\n          timestamp: new Date(),\n        };\n\n        await this.handler?.(event);\n      }\n    } catch (error) {\n      if (this.running) {\n        throw error;\n      }\n    }\n  }\n\n  /**\n   * Stop the trigger and cancel stream consumption\n   */\n  async stop(): Promise<void> {\n    this.running = false;\n    this.abortController?.abort();\n    this.handler = undefined;\n\n    // Wait for stream consumption to complete\n    if (this.consumePromise) {\n      await this.consumePromise.catch(() => {\n        // Ignore errors during shutdown\n      });\n    }\n  }\n\n  /**\n   * Health check - returns true if trigger is running\n   */\n  async healthCheck(): Promise<boolean> {\n    return this.running;\n  }\n}\n\n// ============================================================================\n// Helper Functions\n// ============================================================================\n\n/**\n * Create a stream trigger from an async iterable\n *\n * @param source Identifier for the stream source\n * @param stream The async iterable to consume\n * @param transform Optional transform function to apply to each item\n * @returns A new StreamTrigger instance\n *\n * @example\n * ```typescript\n * const trigger = createStreamTrigger(\n *   'kafka-topic',\n *   kafkaConsumer,\n *   (msg) => JSON.parse(msg.value)\n * );\n * ```\n */\nexport function createStreamTrigger<T>(\n  source: string,\n  stream: AsyncIterable<T>,\n  transform?: (item: T) => unknown,\n): StreamTrigger<T> {\n  return new StreamTrigger({ source, stream, transform });\n}\n"],"mappings":";AAuDO,IAAM,gBAAN,MAEL;AAAA,EAOA,YAAqB,QAAgC;AAAhC;AAAA,EAAiC;AAAA,EAN7C,OAAO;AAAA,EACR;AAAA,EACA;AAAA,EACA,UAAU;AAAA,EACV;AAAA;AAAA;AAAA;AAAA;AAAA,EAQR,MAAM,MAAM,SAAwC;AAClD,QAAI,KAAK,SAAS;AAChB,YAAM,IAAI,MAAM,kCAAkC;AAAA,IACpD;AAEA,SAAK,UAAU;AACf,SAAK,kBAAkB,IAAI,gBAAgB;AAC3C,SAAK,UAAU;AAGf,SAAK,iBAAiB,KAAK,cAAc,EAAE,MAAM,CAAC,UAAU;AAC1D,UAAI,MAAM,SAAS,cAAc;AAC/B,gBAAQ,MAAM,iBAAiB,KAAK;AAAA,MACtC;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,gBAA+B;AAC3C,QAAI;AACF,uBAAiB,QAAQ,KAAK,OAAO,QAAQ;AAC3C,YAAI,CAAC,KAAK,QAAS;AAEnB,cAAM,OAAO,KAAK,OAAO,YAAY,KAAK,OAAO,UAAU,IAAI,IAAI;AAEnE,cAAM,QAAsB;AAAA,UAC1B,IAAI,OAAO,WAAW;AAAA,UACtB,MAAM,KAAK;AAAA,UACX,QAAQ,KAAK,OAAO;AAAA,UACpB;AAAA,UACA,UAAU,CAAC;AAAA,UACX,WAAW,oBAAI,KAAK;AAAA,QACtB;AAEA,cAAM,KAAK,UAAU,KAAK;AAAA,MAC5B;AAAA,IACF,SAAS,OAAO;AACd,UAAI,KAAK,SAAS;AAChB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAsB;AAC1B,SAAK,UAAU;AACf,SAAK,iBAAiB,MAAM;AAC5B,SAAK,UAAU;AAGf,QAAI,KAAK,gBAAgB;AACvB,YAAM,KAAK,eAAe,MAAM,MAAM;AAAA,MAEtC,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,cAAgC;AACpC,WAAO,KAAK;AAAA,EACd;AACF;AAuBO,SAAS,oBACd,QACA,QACA,WACkB;AAClB,SAAO,IAAI,cAAc,EAAE,QAAQ,QAAQ,UAAU,CAAC;AACxD;","names":[]}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@stepflowjs/trigger-stream",
+  "version": "0.0.1",
+  "description": "Generic async iterable stream trigger for Stepflow",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@stepflowjs/core": "0.0.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "vitest": "^4.0.17"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "license": "MIT",
+  "author": "Stepflow Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://stepflow-production.up.railway.app",
+    "directory": "packages/triggers/stream"
+  },
+  "homepage": "https://stepflow-production.up.railway.app",
+  "bugs": {
+    "url": "https://stepflow-production.up.railway.app"
+  },
+  "keywords": [
+    "stepflow",
+    "trigger",
+    "stream",
+    "async-iterable",
+    "workflow",
+    "orchestration"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "clean": "rm -rf dist"
+  }
+}