@walkeros/server-destination-kafka 3.4.0-next-1776749829492

package/README.md

@@ -0,0 +1,105 @@
+# @walkeros/server-destination-kafka
+
+Apache Kafka server destination for
+[walkerOS](https://github.com/elbwalker/walkerOS). Forwards events to Kafka
+topics via [kafkajs](https://kafka.js.org/) with JSON serialization and
+configurable compression.
+
+## Installation
+
+```bash
+npm install @walkeros/server-destination-kafka
+```
+
+## Quick Start
+
+```json
+{
+  "destinations": {
+    "kafka": {
+      "package": "@walkeros/server-destination-kafka",
+      "config": {
+        "settings": {
+          "kafka": {
+            "brokers": ["kafka1:9092", "kafka2:9092"],
+            "topic": "walkeros-events"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Settings
+
+| Setting                  | Type             | Required | Default      | Description                                                  |
+| ------------------------ | ---------------- | -------- | ------------ | ------------------------------------------------------------ |
+| `brokers`                | string[]         | Yes      | --           | Kafka broker addresses (host:port)                           |
+| `topic`                  | string           | Yes      | --           | Target Kafka topic                                           |
+| `clientId`               | string           | No       | `'walkeros'` | Kafka client identifier                                      |
+| `ssl`                    | boolean / object | No       | --           | TLS config (`true` for default TLS)                          |
+| `sasl`                   | object           | No       | --           | SASL auth (plain, scram, aws, oauthbearer)                   |
+| `acks`                   | number           | No       | `-1`         | `-1` all replicas, `0` fire-and-forget, `1` leader           |
+| `compression`            | string           | No       | `'gzip'`     | `none`, `gzip`, `snappy`, `lz4`, `zstd`                      |
+| `key`                    | string           | No       | event name   | Mapping path for message key derivation                      |
+| `headers`                | Record           | No       | --           | Static headers on every message                              |
+| `idempotent`             | boolean          | No       | `false`      | Exactly-once delivery                                        |
+| `allowAutoTopicCreation` | boolean          | No       | `false`      | Auto-create topics                                           |
+| `retry`                  | object           | No       | --           | Retry config (`retries`, `maxRetryTime`, `initialRetryTime`) |
+
+## Per-rule mapping settings
+
+| Setting | Description                                                       |
+| ------- | ----------------------------------------------------------------- |
+| `key`   | Override message key mapping path for this rule                   |
+| `topic` | Route this rule to a different topic than the destination default |
+
+## Authentication
+
+### Confluent Cloud
+
+```json
+{
+  "kafka": {
+    "brokers": ["pkc-xxxxx.us-east-1.aws.confluent.cloud:9092"],
+    "topic": "walkeros-events",
+    "ssl": true,
+    "sasl": {
+      "mechanism": "plain",
+      "username": "$env.CONFLUENT_API_KEY",
+      "password": "$env.CONFLUENT_API_SECRET"
+    }
+  }
+}
+```
+
+### AWS MSK (IAM)
+
+```json
+{
+  "kafka": {
+    "brokers": ["broker.msk.us-east-1.amazonaws.com:9098"],
+    "topic": "walkeros-events",
+    "ssl": true,
+    "sasl": {
+      "mechanism": "aws",
+      "accessKeyId": "$env.AWS_ACCESS_KEY",
+      "secretAccessKey": "$env.AWS_SECRET_KEY"
+    }
+  }
+}
+```
+
+## Message format
+
+Events are serialized as JSON. When a mapping transforms `data`, only the mapped
+payload is sent; otherwise the full walkerOS event is sent. The message key
+defaults to the event name (spaces replaced with `_`) for partition-based
+ordering. Configure `key` (destination-level) or `mapping.settings.key`
+(per-rule) to use any event property path.
+
+## Shutdown
+
+The destination implements `destroy()` calling `producer.disconnect()` to close
+persistent TCP connections on flow hot-swap or server shutdown.

package/dist/dev.d.mts

@@ -0,0 +1,276 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { Flow } from '@walkeros/core';
+
+declare const KafkaSettingsSchema: z.ZodObject<{
+    brokers: z.ZodArray<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    ssl: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+    sasl: z.ZodOptional<z.ZodObject<{
+        mechanism: z.ZodEnum<{
+            plain: "plain";
+            "scram-sha-256": "scram-sha-256";
+            "scram-sha-512": "scram-sha-512";
+            aws: "aws";
+            oauthbearer: "oauthbearer";
+        }>;
+        username: z.ZodOptional<z.ZodString>;
+        password: z.ZodOptional<z.ZodString>;
+        accessKeyId: z.ZodOptional<z.ZodString>;
+        secretAccessKey: z.ZodOptional<z.ZodString>;
+        sessionToken: z.ZodOptional<z.ZodString>;
+        authorizationIdentity: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    connectionTimeout: z.ZodOptional<z.ZodNumber>;
+    requestTimeout: z.ZodOptional<z.ZodNumber>;
+    topic: z.ZodString;
+    acks: z.ZodOptional<z.ZodNumber>;
+    timeout: z.ZodOptional<z.ZodNumber>;
+    compression: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        gzip: "gzip";
+        snappy: "snappy";
+        lz4: "lz4";
+        zstd: "zstd";
+    }>>;
+    idempotent: z.ZodOptional<z.ZodBoolean>;
+    allowAutoTopicCreation: z.ZodOptional<z.ZodBoolean>;
+    key: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    retry: z.ZodOptional<z.ZodObject<{
+        maxRetryTime: z.ZodOptional<z.ZodNumber>;
+        initialRetryTime: z.ZodOptional<z.ZodNumber>;
+        retries: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const SettingsSchema: z.ZodObject<{
+    kafka: z.ZodObject<{
+        brokers: z.ZodArray<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        ssl: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+        sasl: z.ZodOptional<z.ZodObject<{
+            mechanism: z.ZodEnum<{
+                plain: "plain";
+                "scram-sha-256": "scram-sha-256";
+                "scram-sha-512": "scram-sha-512";
+                aws: "aws";
+                oauthbearer: "oauthbearer";
+            }>;
+            username: z.ZodOptional<z.ZodString>;
+            password: z.ZodOptional<z.ZodString>;
+            accessKeyId: z.ZodOptional<z.ZodString>;
+            secretAccessKey: z.ZodOptional<z.ZodString>;
+            sessionToken: z.ZodOptional<z.ZodString>;
+            authorizationIdentity: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        connectionTimeout: z.ZodOptional<z.ZodNumber>;
+        requestTimeout: z.ZodOptional<z.ZodNumber>;
+        topic: z.ZodString;
+        acks: z.ZodOptional<z.ZodNumber>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+        compression: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            gzip: "gzip";
+            snappy: "snappy";
+            lz4: "lz4";
+            zstd: "zstd";
+        }>>;
+        idempotent: z.ZodOptional<z.ZodBoolean>;
+        allowAutoTopicCreation: z.ZodOptional<z.ZodBoolean>;
+        key: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        retry: z.ZodOptional<z.ZodObject<{
+            maxRetryTime: z.ZodOptional<z.ZodNumber>;
+            initialRetryTime: z.ZodOptional<z.ZodNumber>;
+            retries: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    key: z.ZodOptional<z.ZodString>;
+    topic: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_KafkaSettingsSchema: typeof KafkaSettingsSchema;
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { index$1_KafkaSettingsSchema as KafkaSettingsSchema, type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+/**
+ * Mock-friendly Producer interface used by the destination.
+ * Tests provide this via env.Kafka; production creates a real
+ * kafkajs Producer and adapts it through settings._producer.
+ */
+interface KafkaProducerMock {
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    send: (record: ProducerRecord) => Promise<unknown>;
+}
+/**
+ * Mock-friendly Kafka client interface (subset of kafkajs.Kafka).
+ */
+interface KafkaClientMock {
+    producer: (config?: ProducerConfig) => KafkaProducerMock;
+}
+/**
+ * Constructor signature for the Kafka client. Accepts a config
+ * object and returns a client with producer() factory.
+ */
+type KafkaClientConstructor = new (config: KafkaClientConfig) => KafkaClientMock;
+interface KafkaClientConfig {
+    clientId?: string;
+    brokers: string[];
+    ssl?: boolean | Record<string, unknown>;
+    sasl?: SASLConfig;
+    connectionTimeout?: number;
+    requestTimeout?: number;
+    retry?: RetryConfig;
+}
+interface ProducerConfig {
+    allowAutoTopicCreation?: boolean;
+    idempotent?: boolean;
+}
+interface ProducerRecord {
+    topic: string;
+    messages: ProducerMessage[];
+    acks?: number;
+    compression?: number;
+    timeout?: number;
+}
+interface ProducerMessage {
+    key?: string;
+    value: string;
+    headers?: Record<string, string>;
+    timestamp?: string;
+    partition?: number;
+}
+interface CompressionTypesMap {
+    None: number;
+    GZIP: number;
+    Snappy: number;
+    LZ4: number;
+    ZSTD: number;
+}
+type CompressionType = 'none' | 'gzip' | 'snappy' | 'lz4' | 'zstd';
+interface SASLConfig {
+    mechanism: 'plain' | 'scram-sha-256' | 'scram-sha-512' | 'aws' | 'oauthbearer';
+    username?: string;
+    password?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
+    authorizationIdentity?: string;
+}
+interface RetryConfig {
+    maxRetryTime?: number;
+    initialRetryTime?: number;
+    retries?: number;
+}
+interface KafkaSettings {
+    brokers: string[];
+    clientId?: string;
+    ssl?: boolean | Record<string, unknown>;
+    sasl?: SASLConfig;
+    connectionTimeout?: number;
+    requestTimeout?: number;
+    topic: string;
+    acks?: number;
+    timeout?: number;
+    compression?: CompressionType;
+    idempotent?: boolean;
+    allowAutoTopicCreation?: boolean;
+    key?: string;
+    headers?: Record<string, string>;
+    retry?: RetryConfig;
+    _producer?: KafkaProducerMock;
+}
+interface Settings {
+    kafka: KafkaSettings;
+}
+/**
+ * Env -- optional Kafka SDK override. Production leaves this undefined
+ * and the destination creates real Kafka client instances. Tests provide
+ * mocks via env.Kafka.
+ */
+interface Env extends DestinationServer.Env {
+    Kafka?: {
+        Kafka: KafkaClientConstructor;
+        CompressionTypes: CompressionTypesMap;
+    };
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type KafkaStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event -- full WalkerOS.Event serialized as JSON to the configured
+ * topic. Message key defaults to entity_action when no key path is set.
+ */
+declare const defaultEvent: KafkaStepExample;
+/**
+ * Mapped event name -- rule.name renames the event, which also changes the
+ * default message key when no key mapping is configured.
+ */
+declare const mappedEventName: KafkaStepExample;
+/**
+ * Mapped data -- data.map transforms the event payload. Value is the mapped
+ * object serialized as JSON.
+ */
+declare const mappedData: KafkaStepExample;
+/**
+ * Key from user -- settings.kafka.key path resolves the message key from
+ * the event (here user.id).
+ */
+declare const keyFromUser: KafkaStepExample;
+/**
+ * Topic override -- rule.settings.topic routes this rule to a different
+ * topic than the destination default.
+ */
+declare const topicOverride: KafkaStepExample;
+/**
+ * Ignored event -- mapping.ignore: true produces no producer.send call.
+ */
+declare const ignoredEvent: KafkaStepExample;
+
+type step_KafkaStepExample = KafkaStepExample;
+declare const step_defaultEvent: typeof defaultEvent;
+declare const step_ignoredEvent: typeof ignoredEvent;
+declare const step_keyFromUser: typeof keyFromUser;
+declare const step_mappedData: typeof mappedData;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_topicOverride: typeof topicOverride;
+declare namespace step {
+  export { type step_KafkaStepExample as KafkaStepExample, step_defaultEvent as defaultEvent, step_ignoredEvent as ignoredEvent, step_keyFromUser as keyFromUser, step_mappedData as mappedData, step_mappedEventName as mappedEventName, step_topicOverride as topicOverride };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,276 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { DestinationServer } from '@walkeros/server-core';
+import { Flow } from '@walkeros/core';
+
+declare const KafkaSettingsSchema: z.ZodObject<{
+    brokers: z.ZodArray<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    ssl: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+    sasl: z.ZodOptional<z.ZodObject<{
+        mechanism: z.ZodEnum<{
+            plain: "plain";
+            "scram-sha-256": "scram-sha-256";
+            "scram-sha-512": "scram-sha-512";
+            aws: "aws";
+            oauthbearer: "oauthbearer";
+        }>;
+        username: z.ZodOptional<z.ZodString>;
+        password: z.ZodOptional<z.ZodString>;
+        accessKeyId: z.ZodOptional<z.ZodString>;
+        secretAccessKey: z.ZodOptional<z.ZodString>;
+        sessionToken: z.ZodOptional<z.ZodString>;
+        authorizationIdentity: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    connectionTimeout: z.ZodOptional<z.ZodNumber>;
+    requestTimeout: z.ZodOptional<z.ZodNumber>;
+    topic: z.ZodString;
+    acks: z.ZodOptional<z.ZodNumber>;
+    timeout: z.ZodOptional<z.ZodNumber>;
+    compression: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        gzip: "gzip";
+        snappy: "snappy";
+        lz4: "lz4";
+        zstd: "zstd";
+    }>>;
+    idempotent: z.ZodOptional<z.ZodBoolean>;
+    allowAutoTopicCreation: z.ZodOptional<z.ZodBoolean>;
+    key: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    retry: z.ZodOptional<z.ZodObject<{
+        maxRetryTime: z.ZodOptional<z.ZodNumber>;
+        initialRetryTime: z.ZodOptional<z.ZodNumber>;
+        retries: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const SettingsSchema: z.ZodObject<{
+    kafka: z.ZodObject<{
+        brokers: z.ZodArray<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        ssl: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+        sasl: z.ZodOptional<z.ZodObject<{
+            mechanism: z.ZodEnum<{
+                plain: "plain";
+                "scram-sha-256": "scram-sha-256";
+                "scram-sha-512": "scram-sha-512";
+                aws: "aws";
+                oauthbearer: "oauthbearer";
+            }>;
+            username: z.ZodOptional<z.ZodString>;
+            password: z.ZodOptional<z.ZodString>;
+            accessKeyId: z.ZodOptional<z.ZodString>;
+            secretAccessKey: z.ZodOptional<z.ZodString>;
+            sessionToken: z.ZodOptional<z.ZodString>;
+            authorizationIdentity: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        connectionTimeout: z.ZodOptional<z.ZodNumber>;
+        requestTimeout: z.ZodOptional<z.ZodNumber>;
+        topic: z.ZodString;
+        acks: z.ZodOptional<z.ZodNumber>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+        compression: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            gzip: "gzip";
+            snappy: "snappy";
+            lz4: "lz4";
+            zstd: "zstd";
+        }>>;
+        idempotent: z.ZodOptional<z.ZodBoolean>;
+        allowAutoTopicCreation: z.ZodOptional<z.ZodBoolean>;
+        key: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        retry: z.ZodOptional<z.ZodObject<{
+            maxRetryTime: z.ZodOptional<z.ZodNumber>;
+            initialRetryTime: z.ZodOptional<z.ZodNumber>;
+            retries: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    key: z.ZodOptional<z.ZodString>;
+    topic: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_KafkaSettingsSchema: typeof KafkaSettingsSchema;
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { index$1_KafkaSettingsSchema as KafkaSettingsSchema, type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+/**
+ * Mock-friendly Producer interface used by the destination.
+ * Tests provide this via env.Kafka; production creates a real
+ * kafkajs Producer and adapts it through settings._producer.
+ */
+interface KafkaProducerMock {
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    send: (record: ProducerRecord) => Promise<unknown>;
+}
+/**
+ * Mock-friendly Kafka client interface (subset of kafkajs.Kafka).
+ */
+interface KafkaClientMock {
+    producer: (config?: ProducerConfig) => KafkaProducerMock;
+}
+/**
+ * Constructor signature for the Kafka client. Accepts a config
+ * object and returns a client with producer() factory.
+ */
+type KafkaClientConstructor = new (config: KafkaClientConfig) => KafkaClientMock;
+interface KafkaClientConfig {
+    clientId?: string;
+    brokers: string[];
+    ssl?: boolean | Record<string, unknown>;
+    sasl?: SASLConfig;
+    connectionTimeout?: number;
+    requestTimeout?: number;
+    retry?: RetryConfig;
+}
+interface ProducerConfig {
+    allowAutoTopicCreation?: boolean;
+    idempotent?: boolean;
+}
+interface ProducerRecord {
+    topic: string;
+    messages: ProducerMessage[];
+    acks?: number;
+    compression?: number;
+    timeout?: number;
+}
+interface ProducerMessage {
+    key?: string;
+    value: string;
+    headers?: Record<string, string>;
+    timestamp?: string;
+    partition?: number;
+}
+interface CompressionTypesMap {
+    None: number;
+    GZIP: number;
+    Snappy: number;
+    LZ4: number;
+    ZSTD: number;
+}
+type CompressionType = 'none' | 'gzip' | 'snappy' | 'lz4' | 'zstd';
+interface SASLConfig {
+    mechanism: 'plain' | 'scram-sha-256' | 'scram-sha-512' | 'aws' | 'oauthbearer';
+    username?: string;
+    password?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
+    authorizationIdentity?: string;
+}
+interface RetryConfig {
+    maxRetryTime?: number;
+    initialRetryTime?: number;
+    retries?: number;
+}
+interface KafkaSettings {
+    brokers: string[];
+    clientId?: string;
+    ssl?: boolean | Record<string, unknown>;
+    sasl?: SASLConfig;
+    connectionTimeout?: number;
+    requestTimeout?: number;
+    topic: string;
+    acks?: number;
+    timeout?: number;
+    compression?: CompressionType;
+    idempotent?: boolean;
+    allowAutoTopicCreation?: boolean;
+    key?: string;
+    headers?: Record<string, string>;
+    retry?: RetryConfig;
+    _producer?: KafkaProducerMock;
+}
+interface Settings {
+    kafka: KafkaSettings;
+}
+/**
+ * Env -- optional Kafka SDK override. Production leaves this undefined
+ * and the destination creates real Kafka client instances. Tests provide
+ * mocks via env.Kafka.
+ */
+interface Env extends DestinationServer.Env {
+    Kafka?: {
+        Kafka: KafkaClientConstructor;
+        CompressionTypes: CompressionTypesMap;
+    };
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type KafkaStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event -- full WalkerOS.Event serialized as JSON to the configured
+ * topic. Message key defaults to entity_action when no key path is set.
+ */
+declare const defaultEvent: KafkaStepExample;
+/**
+ * Mapped event name -- rule.name renames the event, which also changes the
+ * default message key when no key mapping is configured.
+ */
+declare const mappedEventName: KafkaStepExample;
+/**
+ * Mapped data -- data.map transforms the event payload. Value is the mapped
+ * object serialized as JSON.
+ */
+declare const mappedData: KafkaStepExample;
+/**
+ * Key from user -- settings.kafka.key path resolves the message key from
+ * the event (here user.id).
+ */
+declare const keyFromUser: KafkaStepExample;
+/**
+ * Topic override -- rule.settings.topic routes this rule to a different
+ * topic than the destination default.
+ */
+declare const topicOverride: KafkaStepExample;
+/**
+ * Ignored event -- mapping.ignore: true produces no producer.send call.
+ */
+declare const ignoredEvent: KafkaStepExample;
+
+type step_KafkaStepExample = KafkaStepExample;
+declare const step_defaultEvent: typeof defaultEvent;
+declare const step_ignoredEvent: typeof ignoredEvent;
+declare const step_keyFromUser: typeof keyFromUser;
+declare const step_mappedData: typeof mappedData;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_topicOverride: typeof topicOverride;
+declare namespace step {
+  export { type step_KafkaStepExample as KafkaStepExample, step_defaultEvent as defaultEvent, step_ignoredEvent as ignoredEvent, step_keyFromUser as keyFromUser, step_mappedData as mappedData, step_mappedEventName as mappedEventName, step_topicOverride as topicOverride };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.js

@@ -0,0 +1 @@
+"use strict";var e,t=Object.defineProperty,a=Object.getOwnPropertyDescriptor,o=Object.getOwnPropertyNames,s=Object.prototype.hasOwnProperty,r=(e,a)=>{for(var o in a)t(e,o,{get:a[o],enumerable:!0})},i={};r(i,{examples:()=>f,schemas:()=>n}),module.exports=(e=i,((e,r,i,n)=>{if(r&&"object"==typeof r||"function"==typeof r)for(let c of o(r))s.call(e,c)||c===i||t(e,c,{get:()=>r[c],enumerable:!(n=a(r,c))||n.enumerable});return e})(t({},"__esModule",{value:!0}),e));var n={};r(n,{KafkaSettingsSchema:()=>l,MappingSchema:()=>b,SettingsSchema:()=>u,mapping:()=>v,settings:()=>k});var c=require("@walkeros/core/dev"),p=require("@walkeros/core/dev"),m=p.z.object({mechanism:p.z.enum(["plain","scram-sha-256","scram-sha-512","aws","oauthbearer"]).describe("SASL authentication mechanism."),username:p.z.string().optional().describe("Username for plain/scram mechanisms."),password:p.z.string().optional().describe("Password for plain/scram mechanisms."),accessKeyId:p.z.string().optional().describe("AWS access key ID for IAM auth (mechanism: aws)."),secretAccessKey:p.z.string().optional().describe("AWS secret access key for IAM auth (mechanism: aws)."),sessionToken:p.z.string().optional().describe("AWS session token for temporary credentials (mechanism: aws)."),authorizationIdentity:p.z.string().optional().describe("AWS authorization identity (mechanism: aws).")}),d=p.z.object({maxRetryTime:p.z.number().int().positive().optional().describe("Max total retry wait in ms. Default: 30000."),initialRetryTime:p.z.number().int().positive().optional().describe("First retry delay in ms. Default: 300."),retries:p.z.number().int().min(0).optional().describe("Max retry count. Default: 5.")}),l=p.z.object({brokers:p.z.array(p.z.string().min(1)).min(1).describe("Kafka broker addresses (host:port). At least one required."),clientId:p.z.string().optional().describe("Kafka client ID. Default: walkeros."),ssl:p.z.union([p.z.boolean(),p.z.record(p.z.string(),p.z.unknown())]).optional().describe("TLS configuration. Set true for default TLS, or provide a tls.ConnectionOptions object for mTLS."),sasl:m.optional().describe("SASL authentication config. Required for Confluent Cloud, AWS MSK with IAM, etc."),connectionTimeout:p.z.number().int().positive().optional().describe("Connection timeout in ms. Default: 1000."),requestTimeout:p.z.number().int().positive().optional().describe("Request timeout in ms. Default: 30000."),topic:p.z.string().min(1).describe("Target Kafka topic name."),acks:p.z.number().int().min(-1).max(1).optional().describe("Acknowledgement level. -1 = all replicas, 0 = fire-and-forget, 1 = leader only. Default: -1."),timeout:p.z.number().int().positive().optional().describe("Broker response timeout in ms. Default: 30000."),compression:p.z.enum(["none","gzip","snappy","lz4","zstd"]).optional().describe("Message compression codec. Default: gzip. Snappy/LZ4/ZSTD require additional npm packages."),idempotent:p.z.boolean().optional().describe("Enable idempotent producer for exactly-once delivery. Default: false."),allowAutoTopicCreation:p.z.boolean().optional().describe("Allow auto-creation of topics on the broker. Default: false."),key:p.z.string().optional().describe("Mapping value path for message key derivation (e.g. user.id, data.userId). Default: entity_action."),headers:p.z.record(p.z.string(),p.z.string()).optional().describe("Static headers added to every message."),retry:d.optional().describe("Retry configuration for transient failures.")}),u=p.z.object({kafka:l.describe("Kafka connection and producer settings.")}),g=require("@walkeros/core/dev"),b=g.z.object({key:g.z.string().optional().describe("Override message key mapping path for this rule (e.g. data.id). Takes precedence over settings.kafka.key."),topic:g.z.string().optional().describe("Override Kafka topic for this rule. Takes precedence over settings.kafka.topic.")}),k=(0,c.zodToSchema)(u),v=(0,c.zodToSchema)(b),f={};r(f,{env:()=>y,step:()=>T});var y={};r(y,{push:()=>j,simulation:()=>D});var z=()=>Promise.resolve(),h=()=>Promise.resolve(),w=()=>Promise.resolve([]);var S=()=>({connect:z,disconnect:h,send:w}),j={Kafka:{Kafka:class{constructor(e){}producer(e){return S()}},CompressionTypes:{None:0,GZIP:1,Snappy:2,LZ4:3,ZSTD:4}}},D=["call:producer.send"],T={};r(T,{defaultEvent:()=>O,ignoredEvent:()=>q,keyFromUser:()=>I,mappedData:()=>K,mappedEventName:()=>E,topicOverride:()=>M});var A=require("@walkeros/core"),O={in:(0,A.getEvent)("page view",{timestamp:1700000100}),out:[["producer.send",{topic:"walkeros-events",messages:[{key:"page_view",value:"json:event",headers:{"content-type":"application/json"},timestamp:"1700000100"}],acks:-1,compression:1}]]},E={in:(0,A.getEvent)("order complete",{timestamp:1700000101}),mapping:{name:"purchase"},out:[["producer.send",{topic:"walkeros-events",messages:[{key:"purchase",value:"json:event",headers:{"content-type":"application/json"},timestamp:"1700000101"}],acks:-1,compression:1}]]},K={in:(0,A.getEvent)("order complete",{timestamp:1700000102,data:{id:"ORD-400",total:99.99,currency:"EUR"}}),mapping:{name:"purchase",data:{map:{order_id:"data.id",revenue:"data.total",currency:"data.currency"}}},out:[["producer.send",{topic:"walkeros-events",messages:[{key:"purchase",value:"json:data",headers:{"content-type":"application/json"},timestamp:"1700000102"}],acks:-1,compression:1}]]},I={in:(0,A.getEvent)("user signup",{timestamp:1700000103,user:{id:"usr-789"},data:{plan:"pro"}}),settings:{kafka:{brokers:["localhost:9092"],topic:"walkeros-events",key:"user.id"}},out:[["producer.send",{topic:"walkeros-events",messages:[{key:"usr-789",value:"json:event",headers:{"content-type":"application/json"},timestamp:"1700000103"}],acks:-1,compression:1}]]},M={in:(0,A.getEvent)("order complete",{timestamp:1700000104,data:{id:"ORD-500",total:42}}),mapping:{settings:{topic:"orders-stream"}},out:[["producer.send",{topic:"orders-stream",messages:[{key:"order_complete",value:"json:event",headers:{"content-type":"application/json"},timestamp:"1700000104"}],acks:-1,compression:1}]]},q={in:(0,A.getEvent)("debug noise",{timestamp:1700000105}),mapping:{ignore:!0},out:[]};//# sourceMappingURL=dev.js.map