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

package/README.md

@@ -0,0 +1,67 @@
+# @walkeros/server-destination-redis
+
+Server-side Redis Streams destination for
+[walkerOS](https://github.com/elbwalker/walkerOS). Appends events to a Redis
+Stream via `ioredis` XADD, with optional MAXLEN trimming, JSON or flat
+serialization, and graceful shutdown.
+
+## Installation
+
+```bash
+npm install @walkeros/server-destination-redis
+```
+
+## Quick Start
+
+```json
+{
+  "destinations": {
+    "redis": {
+      "package": "@walkeros/server-destination-redis",
+      "config": {
+        "settings": {
+          "redis": {
+            "streamKey": "walkeros:events",
+            "url": "redis://localhost:6379"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Settings
+
+| Setting               | Type                 | Required | Default  | Description                                                     |
+| --------------------- | -------------------- | -------- | -------- | --------------------------------------------------------------- |
+| `redis.streamKey`     | `string`             | Yes      | --       | Redis stream key name                                           |
+| `redis.url`           | `string`             | No       | --       | Redis connection URL (`redis://` or `rediss://`)                |
+| `redis.options`       | `RedisClientOptions` | No       | --       | ioredis connection options (host, port, password, db, tls, ...) |
+| `redis.maxLen`        | `number`             | No       | --       | Max stream length (approximate MAXLEN trimming)                 |
+| `redis.exactTrimming` | `boolean`            | No       | `false`  | Use exact MAXLEN instead of approximate                         |
+| `redis.serialization` | `'json' \| 'flat'`   | No       | `'json'` | Event serialization mode                                        |
+
+## Per-rule mapping overrides
+
+| Setting                      | Type     | Description                       |
+| ---------------------------- | -------- | --------------------------------- |
+| `mapping.settings.streamKey` | `string` | Override stream key for this rule |
+
+## Serialization Modes
+
+- **`json`** (default): Stores the full event as a single `event` field with a
+  JSON string value. Preserves nested structure, easy to deserialize downstream.
+- **`flat`**: Stores top-level event fields as separate stream entry fields.
+  Nested objects are JSON-encoded. Useful for XREAD filtering on specific
+  fields.
+
+## Shutdown
+
+The destination calls `quit()` on the Redis client during `destroy()`, ensuring
+all in-flight XADD commands complete. User-provided clients are not closed.
+
+## Providers
+
+Works with any Redis 5.0+ server supporting Streams: Redis Cloud, Upstash,
+ElastiCache, MemoryDB, Azure Cache, Memorystore, self-hosted.

package/dist/dev.d.mts

@@ -0,0 +1,196 @@
+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 RedisSettingsSchema: z.ZodObject<{
+    streamKey: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    maxLen: z.ZodOptional<z.ZodNumber>;
+    exactTrimming: z.ZodOptional<z.ZodBoolean>;
+    serialization: z.ZodOptional<z.ZodEnum<{
+        json: "json";
+        flat: "flat";
+    }>>;
+}, z.core.$strip>;
+declare const SettingsSchema: z.ZodObject<{
+    redis: z.ZodObject<{
+        streamKey: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        maxLen: z.ZodOptional<z.ZodNumber>;
+        exactTrimming: z.ZodOptional<z.ZodBoolean>;
+        serialization: z.ZodOptional<z.ZodEnum<{
+            json: "json";
+            flat: "flat";
+        }>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    streamKey: 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;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_RedisSettingsSchema: typeof RedisSettingsSchema;
+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 { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, index$1_RedisSettingsSchema as RedisSettingsSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+/**
+ * Arguments passed to Redis XADD. Strings or numbers (for MAXLEN counts).
+ */
+type XaddArg = string | number;
+/**
+ * Mock-friendly Redis pipeline interface. Accumulates commands and
+ * executes them with a single round-trip via exec().
+ */
+interface RedisPipelineMock {
+    xadd: (...args: XaddArg[]) => RedisPipelineMock;
+    exec: () => Promise<Array<[Error | null, unknown]> | null>;
+}
+/**
+ * Mock-friendly Redis client interface used by the destination.
+ * Tests provide this via env.Redis; production creates a real ioredis
+ * client and uses it directly.
+ */
+interface RedisClientMock {
+    xadd: (...args: XaddArg[]) => Promise<string | null>;
+    pipeline: () => RedisPipelineMock;
+    quit: () => Promise<string>;
+    on?: (event: string, listener: (...args: unknown[]) => void) => unknown;
+}
+/**
+ * Constructor signature for the Redis client. Accepts either a URL
+ * string or an options object, matching ioredis's dual signature.
+ */
+interface RedisClientConstructor {
+    new (url: string): RedisClientMock;
+    new (options: RedisClientOptions): RedisClientMock;
+}
+/**
+ * Minimal ioredis options subset the destination passes through.
+ * Unknown options are preserved for the SDK to handle.
+ */
+interface RedisClientOptions {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    db?: number;
+    tls?: boolean | Record<string, unknown>;
+    connectTimeout?: number;
+    commandTimeout?: number;
+    [key: string]: unknown;
+}
+type SerializationMode = 'json' | 'flat';
+interface RedisSettings {
+    /** Redis stream key name (e.g. 'walkeros:events'). */
+    streamKey: string;
+    /** Redis connection URL (e.g. 'redis://localhost:6379' or 'rediss://...'). */
+    url?: string;
+    /** ioredis connection options (used if no url provided). */
+    options?: RedisClientOptions;
+    /**
+     * Maximum stream length. Enables MAXLEN trimming on every XADD.
+     * Uses approximate (~) trimming by default for performance.
+     * Omit for unlimited stream length.
+     */
+    maxLen?: number;
+    /**
+     * Use exact MAXLEN instead of approximate (~).
+     * Not recommended for production -- significantly slower.
+     * Default: false (approximate trimming).
+     */
+    exactTrimming?: boolean;
+    /**
+     * Serialization mode for the event payload.
+     * - 'json': Single 'event' field with JSON string (default)
+     * - 'flat': Top-level event fields as separate stream fields
+     */
+    serialization?: SerializationMode;
+    _client?: RedisClientMock;
+    _ownedClient?: boolean;
+}
+interface Settings {
+    redis: RedisSettings;
+}
+/**
+ * Env -- optional Redis SDK override. Production leaves this undefined
+ * and the destination creates real ioredis client instances. Tests provide
+ * mocks via env.Redis.
+ */
+interface Env extends DestinationServer.Env {
+    Redis?: {
+        Client: RedisClientConstructor;
+    };
+}
+
+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 RedisStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default JSON serialization -- single 'event' field with full event JSON.
+ */
+declare const jsonDefault: RedisStepExample;
+/**
+ * Order event -- verifies different event types pass through correctly.
+ */
+declare const orderComplete: RedisStepExample;
+/**
+ * With MAXLEN approximate trimming -- trimming args inserted before '*'.
+ */
+declare const withMaxLen: RedisStepExample;
+/**
+ * Exact MAXLEN trimming -- no '~' between MAXLEN and the count.
+ */
+declare const withExactTrim: RedisStepExample;
+/**
+ * Stream key override per rule -- routes this event to a dedicated stream.
+ */
+declare const streamKeyOverride: RedisStepExample;
+/**
+ * Ignored event -- mapping.ignore: true produces no xadd call.
+ */
+declare const ignoredEvent: RedisStepExample;
+
+type step_RedisStepExample = RedisStepExample;
+declare const step_ignoredEvent: typeof ignoredEvent;
+declare const step_jsonDefault: typeof jsonDefault;
+declare const step_orderComplete: typeof orderComplete;
+declare const step_streamKeyOverride: typeof streamKeyOverride;
+declare const step_withExactTrim: typeof withExactTrim;
+declare const step_withMaxLen: typeof withMaxLen;
+declare namespace step {
+  export { type step_RedisStepExample as RedisStepExample, step_ignoredEvent as ignoredEvent, step_jsonDefault as jsonDefault, step_orderComplete as orderComplete, step_streamKeyOverride as streamKeyOverride, step_withExactTrim as withExactTrim, step_withMaxLen as withMaxLen };
+}
+
+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,196 @@
+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 RedisSettingsSchema: z.ZodObject<{
+    streamKey: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    maxLen: z.ZodOptional<z.ZodNumber>;
+    exactTrimming: z.ZodOptional<z.ZodBoolean>;
+    serialization: z.ZodOptional<z.ZodEnum<{
+        json: "json";
+        flat: "flat";
+    }>>;
+}, z.core.$strip>;
+declare const SettingsSchema: z.ZodObject<{
+    redis: z.ZodObject<{
+        streamKey: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        maxLen: z.ZodOptional<z.ZodNumber>;
+        exactTrimming: z.ZodOptional<z.ZodBoolean>;
+        serialization: z.ZodOptional<z.ZodEnum<{
+            json: "json";
+            flat: "flat";
+        }>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    streamKey: 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;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_RedisSettingsSchema: typeof RedisSettingsSchema;
+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 { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, index$1_RedisSettingsSchema as RedisSettingsSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+/**
+ * Arguments passed to Redis XADD. Strings or numbers (for MAXLEN counts).
+ */
+type XaddArg = string | number;
+/**
+ * Mock-friendly Redis pipeline interface. Accumulates commands and
+ * executes them with a single round-trip via exec().
+ */
+interface RedisPipelineMock {
+    xadd: (...args: XaddArg[]) => RedisPipelineMock;
+    exec: () => Promise<Array<[Error | null, unknown]> | null>;
+}
+/**
+ * Mock-friendly Redis client interface used by the destination.
+ * Tests provide this via env.Redis; production creates a real ioredis
+ * client and uses it directly.
+ */
+interface RedisClientMock {
+    xadd: (...args: XaddArg[]) => Promise<string | null>;
+    pipeline: () => RedisPipelineMock;
+    quit: () => Promise<string>;
+    on?: (event: string, listener: (...args: unknown[]) => void) => unknown;
+}
+/**
+ * Constructor signature for the Redis client. Accepts either a URL
+ * string or an options object, matching ioredis's dual signature.
+ */
+interface RedisClientConstructor {
+    new (url: string): RedisClientMock;
+    new (options: RedisClientOptions): RedisClientMock;
+}
+/**
+ * Minimal ioredis options subset the destination passes through.
+ * Unknown options are preserved for the SDK to handle.
+ */
+interface RedisClientOptions {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    db?: number;
+    tls?: boolean | Record<string, unknown>;
+    connectTimeout?: number;
+    commandTimeout?: number;
+    [key: string]: unknown;
+}
+type SerializationMode = 'json' | 'flat';
+interface RedisSettings {
+    /** Redis stream key name (e.g. 'walkeros:events'). */
+    streamKey: string;
+    /** Redis connection URL (e.g. 'redis://localhost:6379' or 'rediss://...'). */
+    url?: string;
+    /** ioredis connection options (used if no url provided). */
+    options?: RedisClientOptions;
+    /**
+     * Maximum stream length. Enables MAXLEN trimming on every XADD.
+     * Uses approximate (~) trimming by default for performance.
+     * Omit for unlimited stream length.
+     */
+    maxLen?: number;
+    /**
+     * Use exact MAXLEN instead of approximate (~).
+     * Not recommended for production -- significantly slower.
+     * Default: false (approximate trimming).
+     */
+    exactTrimming?: boolean;
+    /**
+     * Serialization mode for the event payload.
+     * - 'json': Single 'event' field with JSON string (default)
+     * - 'flat': Top-level event fields as separate stream fields
+     */
+    serialization?: SerializationMode;
+    _client?: RedisClientMock;
+    _ownedClient?: boolean;
+}
+interface Settings {
+    redis: RedisSettings;
+}
+/**
+ * Env -- optional Redis SDK override. Production leaves this undefined
+ * and the destination creates real ioredis client instances. Tests provide
+ * mocks via env.Redis.
+ */
+interface Env extends DestinationServer.Env {
+    Redis?: {
+        Client: RedisClientConstructor;
+    };
+}
+
+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 RedisStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default JSON serialization -- single 'event' field with full event JSON.
+ */
+declare const jsonDefault: RedisStepExample;
+/**
+ * Order event -- verifies different event types pass through correctly.
+ */
+declare const orderComplete: RedisStepExample;
+/**
+ * With MAXLEN approximate trimming -- trimming args inserted before '*'.
+ */
+declare const withMaxLen: RedisStepExample;
+/**
+ * Exact MAXLEN trimming -- no '~' between MAXLEN and the count.
+ */
+declare const withExactTrim: RedisStepExample;
+/**
+ * Stream key override per rule -- routes this event to a dedicated stream.
+ */
+declare const streamKeyOverride: RedisStepExample;
+/**
+ * Ignored event -- mapping.ignore: true produces no xadd call.
+ */
+declare const ignoredEvent: RedisStepExample;
+
+type step_RedisStepExample = RedisStepExample;
+declare const step_ignoredEvent: typeof ignoredEvent;
+declare const step_jsonDefault: typeof jsonDefault;
+declare const step_orderComplete: typeof orderComplete;
+declare const step_streamKeyOverride: typeof streamKeyOverride;
+declare const step_withExactTrim: typeof withExactTrim;
+declare const step_withMaxLen: typeof withMaxLen;
+declare namespace step {
+  export { type step_RedisStepExample as RedisStepExample, step_ignoredEvent as ignoredEvent, step_jsonDefault as jsonDefault, step_orderComplete as orderComplete, step_streamKeyOverride as streamKeyOverride, step_withExactTrim as withExactTrim, step_withMaxLen as withMaxLen };
+}
+
+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,r=Object.getOwnPropertyDescriptor,s=Object.getOwnPropertyNames,o=Object.prototype.hasOwnProperty,i=(e,r)=>{for(var s in r)t(e,s,{get:r[s],enumerable:!0})},n={};i(n,{examples:()=>w,schemas:()=>a}),module.exports=(e=n,((e,i,n,a)=>{if(i&&"object"==typeof i||"function"==typeof i)for(let d of s(i))o.call(e,d)||d===n||t(e,d,{get:()=>i[d],enumerable:!(a=r(i,d))||a.enumerable});return e})(t({},"__esModule",{value:!0}),e));var a={};i(a,{MappingSchema:()=>v,RedisSettingsSchema:()=>m,SettingsSchema:()=>c,mapping:()=>g,settings:()=>u});var d=require("@walkeros/core/dev"),l=require("@walkeros/core/dev"),m=l.z.object({streamKey:l.z.string().min(1).describe("Redis stream key name (like 'walkeros:events'). All events are appended to this stream via XADD."),url:l.z.string().describe("Redis connection URL (like 'redis://localhost:6379' or 'rediss://:password@host:6380'). Supports redis:// and rediss:// (TLS) protocols.").optional(),options:l.z.record(l.z.string(),l.z.unknown()).describe("ioredis connection options. Used when url is not provided. Supports host, port, password, db, tls, and all other ioredis options.").optional(),maxLen:l.z.number().int().positive().describe("Maximum stream length. Enables approximate MAXLEN trimming on every XADD to bound memory usage (like 50000).").optional(),exactTrimming:l.z.boolean().describe("Use exact MAXLEN instead of approximate (~). Not recommended for production. Default: false.").optional(),serialization:l.z.enum(["json","flat"]).describe("Serialization mode. 'json' stores the full event as a single 'event' field (default). 'flat' stores top-level event fields as separate stream entry fields.").optional()}),c=l.z.object({redis:m.describe("Redis Streams configuration (like { streamKey: 'walkeros:events', url: 'redis://localhost:6379' })")}),p=require("@walkeros/core/dev"),v=p.z.object({streamKey:p.z.string().optional().describe("Override Redis stream key for this rule. Takes precedence over settings.redis.streamKey.")}),u=(0,d.zodToSchema)(c),g=(0,d.zodToSchema)(v),w={};i(w,{env:()=>b,step:()=>y});var b={};i(b,{push:()=>k,simulation:()=>x});var f=()=>Promise.resolve("1700000100000-0"),h=()=>Promise.resolve("OK");var k={Redis:{Client:class{constructor(e){this.xadd=f,this.quit=h}pipeline(){return function(){const e={xadd:()=>e,exec:()=>Promise.resolve([])};return e}()}on(){return this}}}},x=["call:client.xadd"],y={};i(y,{ignoredEvent:()=>L,jsonDefault:()=>z,orderComplete:()=>E,streamKeyOverride:()=>K,withExactTrim:()=>O,withMaxLen:()=>S});var j=require("@walkeros/core"),z={in:(0,j.getEvent)("page view",{timestamp:1700000100}),out:[["client.xadd",["walkeros:events","*","event","json:event"]]]},E={in:(0,j.getEvent)("order complete",{timestamp:1700000101,data:{id:"ORD-400",total:99.99,currency:"EUR"}}),out:[["client.xadd",["walkeros:events","*","event","json:event"]]]},S={in:(0,j.getEvent)("product view",{timestamp:1700000102,data:{id:"SKU-123",name:"Widget"}}),settings:{redis:{streamKey:"walkeros:events",maxLen:5e4}},out:[["client.xadd",["walkeros:events","MAXLEN","~",5e4,"*","event","json:event"]]]},O={in:(0,j.getEvent)("page view",{timestamp:1700000103}),settings:{redis:{streamKey:"walkeros:events",maxLen:5e3,exactTrimming:!0}},out:[["client.xadd",["walkeros:events","MAXLEN",5e3,"*","event","json:event"]]]},K={in:(0,j.getEvent)("order complete",{timestamp:1700000104,data:{id:"ORD-500",total:42}}),mapping:{settings:{streamKey:"walkeros:orders"}},out:[["client.xadd",["walkeros:orders","*","event","json:event"]]]},L={in:(0,j.getEvent)("debug noise",{timestamp:1700000105}),mapping:{ignore:!0},out:[]};//# sourceMappingURL=dev.js.map

package/dist/dev.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["export * as schemas from './schemas';\nexport * as examples from './examples';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, RedisSettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const RedisSettingsSchema = z.object({\n  streamKey: z\n    .string()\n    .min(1)\n    .describe(\n      \"Redis stream key name (like 'walkeros:events'). All events are appended to this stream via XADD.\",\n    ),\n  url: z\n    .string()\n    .describe(\n      \"Redis connection URL (like 'redis://localhost:6379' or 'rediss://:password@host:6380'). Supports redis:// and rediss:// (TLS) protocols.\",\n    )\n    .optional(),\n  options: z\n    .record(z.string(), z.unknown())\n    .describe(\n      'ioredis connection options. Used when url is not provided. Supports host, port, password, db, tls, and all other ioredis options.',\n    )\n    .optional(),\n  maxLen: z\n    .number()\n    .int()\n    .positive()\n    .describe(\n      'Maximum stream length. Enables approximate MAXLEN trimming on every XADD to bound memory usage (like 50000).',\n    )\n    .optional(),\n  exactTrimming: z\n    .boolean()\n    .describe(\n      'Use exact MAXLEN instead of approximate (~). Not recommended for production. Default: false.',\n    )\n    .optional(),\n  serialization: z\n    .enum(['json', 'flat'])\n    .describe(\n      \"Serialization mode. 'json' stores the full event as a single 'event' field (default). 'flat' stores top-level event fields as separate stream entry fields.\",\n    )\n    .optional(),\n});\n\nexport const SettingsSchema = z.object({\n  redis: RedisSettingsSchema.describe(\n    \"Redis Streams configuration (like { streamKey: 'walkeros:events', url: 'redis://localhost:6379' })\",\n  ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\nexport const MappingSchema = z.object({\n  streamKey: z\n    .string()\n    .optional()\n    .describe(\n      'Override Redis stream key for this rule. Takes precedence over settings.redis.streamKey.',\n    ),\n});\n\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type {\n  Env,\n  RedisClientConstructor,\n  RedisClientMock,\n  RedisPipelineMock,\n  XaddArg,\n} from '../types';\n\n// Narrow helper type aliases so the mock SDK is typed explicitly without `any`.\ntype XaddFn = (...args: XaddArg[]) => Promise<string | null>;\ntype QuitFn = () => Promise<string>;\n\nconst asyncXadd: XaddFn = () => Promise.resolve('1700000100000-0');\nconst asyncQuit: QuitFn = () => Promise.resolve('OK');\n\nfunction createMockPipeline(): RedisPipelineMock {\n  const pipeline: RedisPipelineMock = {\n    xadd: () => pipeline,\n    exec: () => Promise.resolve([]),\n  };\n  return pipeline;\n}\n\nclass MockRedisClient implements RedisClientMock {\n  constructor(_urlOrOptions: string | Record<string, unknown>) {}\n  xadd: XaddFn = asyncXadd;\n  pipeline(): RedisPipelineMock {\n    return createMockPipeline();\n  }\n  quit: QuitFn = asyncQuit;\n  on(): unknown {\n    return this;\n  }\n}\n\nconst MockRedisConstructor: RedisClientConstructor = MockRedisClient;\n\nexport const push: Env = {\n  Redis: {\n    Client: MockRedisConstructor,\n  },\n};\n\nexport const simulation = ['call:client.xadd'];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\nimport type { Settings } from '../types';\n\n/**\n * Extended step example that may carry destination-level settings overrides.\n */\nexport type RedisStepExample = Flow.StepExample & {\n  settings?: Partial<Settings>;\n};\n\n/**\n * Default JSON serialization -- single 'event' field with full event JSON.\n */\nexport const jsonDefault: RedisStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000100,\n  }),\n  out: [['client.xadd', ['walkeros:events', '*', 'event', 'json:event']]],\n};\n\n/**\n * Order event -- verifies different event types pass through correctly.\n */\nexport const orderComplete: RedisStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000101,\n    data: { id: 'ORD-400', total: 99.99, currency: 'EUR' },\n  }),\n  out: [['client.xadd', ['walkeros:events', '*', 'event', 'json:event']]],\n};\n\n/**\n * With MAXLEN approximate trimming -- trimming args inserted before '*'.\n */\nexport const withMaxLen: RedisStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000102,\n    data: { id: 'SKU-123', name: 'Widget' },\n  }),\n  settings: {\n    redis: {\n      streamKey: 'walkeros:events',\n      maxLen: 50000,\n    },\n  },\n  out: [\n    [\n      'client.xadd',\n      ['walkeros:events', 'MAXLEN', '~', 50000, '*', 'event', 'json:event'],\n    ],\n  ],\n};\n\n/**\n * Exact MAXLEN trimming -- no '~' between MAXLEN and the count.\n */\nexport const withExactTrim: RedisStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000103,\n  }),\n  settings: {\n    redis: {\n      streamKey: 'walkeros:events',\n      maxLen: 5000,\n      exactTrimming: true,\n    },\n  },\n  out: [\n    [\n      'client.xadd',\n      ['walkeros:events', 'MAXLEN', 5000, '*', 'event', 'json:event'],\n    ],\n  ],\n};\n\n/**\n * Stream key override per rule -- routes this event to a dedicated stream.\n */\nexport const streamKeyOverride: RedisStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000104,\n    data: { id: 'ORD-500', total: 42 },\n  }),\n  mapping: {\n    settings: {\n      streamKey: 'walkeros:orders',\n    },\n  },\n  out: [['client.xadd', ['walkeros:orders', '*', 'event', 'json:event']]],\n};\n\n/**\n * Ignored event -- mapping.ignore: true produces no xadd call.\n */\nexport const ignoredEvent: RedisStepExample = {\n  in: getEvent('debug noise', {\n    timestamp: 1700000105,\n  }),\n  mapping: { ignore: true },\n  out: [],\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,iBAAkB;AAEX,IAAM,sBAAsB,aAAE,OAAO;AAAA,EAC1C,WAAW,aACR,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AAAA,EACF,KAAK,aACF,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,SAAS,aACN,OAAO,aAAE,OAAO,GAAG,aAAE,QAAQ,CAAC,EAC9B;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,QAAQ,aACL,OAAO,EACP,IAAI,EACJ,SAAS,EACT;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,eAAe,aACZ,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,eAAe,aACZ,KAAK,CAAC,QAAQ,MAAM,CAAC,EACrB;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AAEM,IAAM,iBAAiB,aAAE,OAAO;AAAA,EACrC,OAAO,oBAAoB;AAAA,IACzB;AAAA,EACF;AACF,CAAC;;;AC/CD,IAAAC,cAAkB;AAEX,IAAM,gBAAgB,cAAE,OAAO;AAAA,EACpC,WAAW,cACR,OAAO,EACP,SAAS,EACT;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;AFDM,IAAM,eAAW,yBAAY,cAAc;AAC3C,IAAM,cAAU,yBAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAYA,IAAM,YAAoB,MAAM,QAAQ,QAAQ,iBAAiB;AACjE,IAAM,YAAoB,MAAM,QAAQ,QAAQ,IAAI;AAEpD,SAAS,qBAAwC;AAC/C,QAAM,WAA8B;AAAA,IAClC,MAAM,MAAM;AAAA,IACZ,MAAM,MAAM,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAChC;AACA,SAAO;AACT;AAEA,IAAM,kBAAN,MAAiD;AAAA,EAC/C,YAAY,eAAiD;AAC7D,gBAAe;AAIf,gBAAe;AAAA,EAL+C;AAAA,EAE9D,WAA8B;AAC5B,WAAO,mBAAmB;AAAA,EAC5B;AAAA,EAEA,KAAc;AACZ,WAAO;AAAA,EACT;AACF;AAEA,IAAM,uBAA+C;AAE9C,IAAM,OAAY;AAAA,EACvB,OAAO;AAAA,IACL,QAAQ;AAAA,EACV;AACF;AAEO,IAAM,aAAa,CAAC,kBAAkB;;;AC3C7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,kBAAyB;AAalB,IAAM,cAAgC;AAAA,EAC3C,QAAI,sBAAS,aAAa;AAAA,IACxB,WAAW;AAAA,EACb,CAAC;AAAA,EACD,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,gBAAkC;AAAA,EAC7C,QAAI,sBAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,OAAO,OAAO,UAAU,MAAM;AAAA,EACvD,CAAC;AAAA,EACD,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,aAA+B;AAAA,EAC1C,QAAI,sBAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,MAAM,SAAS;AAAA,EACxC,CAAC;AAAA,EACD,UAAU;AAAA,IACR,OAAO;AAAA,MACL,WAAW;AAAA,MACX,QAAQ;AAAA,IACV;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA,CAAC,mBAAmB,UAAU,KAAK,KAAO,KAAK,SAAS,YAAY;AAAA,IACtE;AAAA,EACF;AACF;AAKO,IAAM,gBAAkC;AAAA,EAC7C,QAAI,sBAAS,aAAa;AAAA,IACxB,WAAW;AAAA,EACb,CAAC;AAAA,EACD,UAAU;AAAA,IACR,OAAO;AAAA,MACL,WAAW;AAAA,MACX,QAAQ;AAAA,MACR,eAAe;AAAA,IACjB;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA,CAAC,mBAAmB,UAAU,KAAM,KAAK,SAAS,YAAY;AAAA,IAChE;AAAA,EACF;AACF;AAKO,IAAM,oBAAsC;AAAA,EACjD,QAAI,sBAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,OAAO,GAAG;AAAA,EACnC,CAAC;AAAA,EACD,SAAS;AAAA,IACP,UAAU;AAAA,MACR,WAAW;AAAA,IACb;AAAA,EACF;AAAA,EACA,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,eAAiC;AAAA,EAC5C,QAAI,sBAAS,eAAe;AAAA,IAC1B,WAAW;AAAA,EACb,CAAC;AAAA,EACD,SAAS,EAAE,QAAQ,KAAK;AAAA,EACxB,KAAK,CAAC;AACR;","names":["import_dev","import_dev"]}

package/dist/dev.mjs

@@ -0,0 +1 @@
+var e=Object.defineProperty,t=(t,s)=>{for(var r in s)e(t,r,{get:s[r],enumerable:!0})},s={};t(s,{MappingSchema:()=>d,RedisSettingsSchema:()=>i,SettingsSchema:()=>a,mapping:()=>m,settings:()=>l});import{zodToSchema as r}from"@walkeros/core/dev";import{z as o}from"@walkeros/core/dev";var i=o.object({streamKey:o.string().min(1).describe("Redis stream key name (like 'walkeros:events'). All events are appended to this stream via XADD."),url:o.string().describe("Redis connection URL (like 'redis://localhost:6379' or 'rediss://:password@host:6380'). Supports redis:// and rediss:// (TLS) protocols.").optional(),options:o.record(o.string(),o.unknown()).describe("ioredis connection options. Used when url is not provided. Supports host, port, password, db, tls, and all other ioredis options.").optional(),maxLen:o.number().int().positive().describe("Maximum stream length. Enables approximate MAXLEN trimming on every XADD to bound memory usage (like 50000).").optional(),exactTrimming:o.boolean().describe("Use exact MAXLEN instead of approximate (~). Not recommended for production. Default: false.").optional(),serialization:o.enum(["json","flat"]).describe("Serialization mode. 'json' stores the full event as a single 'event' field (default). 'flat' stores top-level event fields as separate stream entry fields.").optional()}),a=o.object({redis:i.describe("Redis Streams configuration (like { streamKey: 'walkeros:events', url: 'redis://localhost:6379' })")});import{z as n}from"@walkeros/core/dev";var d=n.object({streamKey:n.string().optional().describe("Override Redis stream key for this rule. Takes precedence over settings.redis.streamKey.")}),l=r(a),m=r(d),p={};t(p,{env:()=>c,step:()=>k});var c={};t(c,{push:()=>g,simulation:()=>w});var v=()=>Promise.resolve("1700000100000-0"),u=()=>Promise.resolve("OK");var g={Redis:{Client:class{constructor(e){this.xadd=v,this.quit=u}pipeline(){return function(){const e={xadd:()=>e,exec:()=>Promise.resolve([])};return e}()}on(){return this}}}},w=["call:client.xadd"],k={};t(k,{ignoredEvent:()=>S,jsonDefault:()=>f,orderComplete:()=>h,streamKeyOverride:()=>j,withExactTrim:()=>y,withMaxLen:()=>b});import{getEvent as x}from"@walkeros/core";var f={in:x("page view",{timestamp:1700000100}),out:[["client.xadd",["walkeros:events","*","event","json:event"]]]},h={in:x("order complete",{timestamp:1700000101,data:{id:"ORD-400",total:99.99,currency:"EUR"}}),out:[["client.xadd",["walkeros:events","*","event","json:event"]]]},b={in:x("product view",{timestamp:1700000102,data:{id:"SKU-123",name:"Widget"}}),settings:{redis:{streamKey:"walkeros:events",maxLen:5e4}},out:[["client.xadd",["walkeros:events","MAXLEN","~",5e4,"*","event","json:event"]]]},y={in:x("page view",{timestamp:1700000103}),settings:{redis:{streamKey:"walkeros:events",maxLen:5e3,exactTrimming:!0}},out:[["client.xadd",["walkeros:events","MAXLEN",5e3,"*","event","json:event"]]]},j={in:x("order complete",{timestamp:1700000104,data:{id:"ORD-500",total:42}}),mapping:{settings:{streamKey:"walkeros:orders"}},out:[["client.xadd",["walkeros:orders","*","event","json:event"]]]},S={in:x("debug noise",{timestamp:1700000105}),mapping:{ignore:!0},out:[]};export{p as examples,s as schemas};//# sourceMappingURL=dev.mjs.map

package/dist/dev.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, RedisSettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const RedisSettingsSchema = z.object({\n  streamKey: z\n    .string()\n    .min(1)\n    .describe(\n      \"Redis stream key name (like 'walkeros:events'). All events are appended to this stream via XADD.\",\n    ),\n  url: z\n    .string()\n    .describe(\n      \"Redis connection URL (like 'redis://localhost:6379' or 'rediss://:password@host:6380'). Supports redis:// and rediss:// (TLS) protocols.\",\n    )\n    .optional(),\n  options: z\n    .record(z.string(), z.unknown())\n    .describe(\n      'ioredis connection options. Used when url is not provided. Supports host, port, password, db, tls, and all other ioredis options.',\n    )\n    .optional(),\n  maxLen: z\n    .number()\n    .int()\n    .positive()\n    .describe(\n      'Maximum stream length. Enables approximate MAXLEN trimming on every XADD to bound memory usage (like 50000).',\n    )\n    .optional(),\n  exactTrimming: z\n    .boolean()\n    .describe(\n      'Use exact MAXLEN instead of approximate (~). Not recommended for production. Default: false.',\n    )\n    .optional(),\n  serialization: z\n    .enum(['json', 'flat'])\n    .describe(\n      \"Serialization mode. 'json' stores the full event as a single 'event' field (default). 'flat' stores top-level event fields as separate stream entry fields.\",\n    )\n    .optional(),\n});\n\nexport const SettingsSchema = z.object({\n  redis: RedisSettingsSchema.describe(\n    \"Redis Streams configuration (like { streamKey: 'walkeros:events', url: 'redis://localhost:6379' })\",\n  ),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\nexport const MappingSchema = z.object({\n  streamKey: z\n    .string()\n    .optional()\n    .describe(\n      'Override Redis stream key for this rule. Takes precedence over settings.redis.streamKey.',\n    ),\n});\n\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type {\n  Env,\n  RedisClientConstructor,\n  RedisClientMock,\n  RedisPipelineMock,\n  XaddArg,\n} from '../types';\n\n// Narrow helper type aliases so the mock SDK is typed explicitly without `any`.\ntype XaddFn = (...args: XaddArg[]) => Promise<string | null>;\ntype QuitFn = () => Promise<string>;\n\nconst asyncXadd: XaddFn = () => Promise.resolve('1700000100000-0');\nconst asyncQuit: QuitFn = () => Promise.resolve('OK');\n\nfunction createMockPipeline(): RedisPipelineMock {\n  const pipeline: RedisPipelineMock = {\n    xadd: () => pipeline,\n    exec: () => Promise.resolve([]),\n  };\n  return pipeline;\n}\n\nclass MockRedisClient implements RedisClientMock {\n  constructor(_urlOrOptions: string | Record<string, unknown>) {}\n  xadd: XaddFn = asyncXadd;\n  pipeline(): RedisPipelineMock {\n    return createMockPipeline();\n  }\n  quit: QuitFn = asyncQuit;\n  on(): unknown {\n    return this;\n  }\n}\n\nconst MockRedisConstructor: RedisClientConstructor = MockRedisClient;\n\nexport const push: Env = {\n  Redis: {\n    Client: MockRedisConstructor,\n  },\n};\n\nexport const simulation = ['call:client.xadd'];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\nimport type { Settings } from '../types';\n\n/**\n * Extended step example that may carry destination-level settings overrides.\n */\nexport type RedisStepExample = Flow.StepExample & {\n  settings?: Partial<Settings>;\n};\n\n/**\n * Default JSON serialization -- single 'event' field with full event JSON.\n */\nexport const jsonDefault: RedisStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000100,\n  }),\n  out: [['client.xadd', ['walkeros:events', '*', 'event', 'json:event']]],\n};\n\n/**\n * Order event -- verifies different event types pass through correctly.\n */\nexport const orderComplete: RedisStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000101,\n    data: { id: 'ORD-400', total: 99.99, currency: 'EUR' },\n  }),\n  out: [['client.xadd', ['walkeros:events', '*', 'event', 'json:event']]],\n};\n\n/**\n * With MAXLEN approximate trimming -- trimming args inserted before '*'.\n */\nexport const withMaxLen: RedisStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000102,\n    data: { id: 'SKU-123', name: 'Widget' },\n  }),\n  settings: {\n    redis: {\n      streamKey: 'walkeros:events',\n      maxLen: 50000,\n    },\n  },\n  out: [\n    [\n      'client.xadd',\n      ['walkeros:events', 'MAXLEN', '~', 50000, '*', 'event', 'json:event'],\n    ],\n  ],\n};\n\n/**\n * Exact MAXLEN trimming -- no '~' between MAXLEN and the count.\n */\nexport const withExactTrim: RedisStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000103,\n  }),\n  settings: {\n    redis: {\n      streamKey: 'walkeros:events',\n      maxLen: 5000,\n      exactTrimming: true,\n    },\n  },\n  out: [\n    [\n      'client.xadd',\n      ['walkeros:events', 'MAXLEN', 5000, '*', 'event', 'json:event'],\n    ],\n  ],\n};\n\n/**\n * Stream key override per rule -- routes this event to a dedicated stream.\n */\nexport const streamKeyOverride: RedisStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000104,\n    data: { id: 'ORD-500', total: 42 },\n  }),\n  mapping: {\n    settings: {\n      streamKey: 'walkeros:orders',\n    },\n  },\n  out: [['client.xadd', ['walkeros:orders', '*', 'event', 'json:event']]],\n};\n\n/**\n * Ignored event -- mapping.ignore: true produces no xadd call.\n */\nexport const ignoredEvent: RedisStepExample = {\n  in: getEvent('debug noise', {\n    timestamp: 1700000105,\n  }),\n  mapping: { ignore: true },\n  out: [],\n};\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,SAAS;AAEX,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,WAAW,EACR,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AAAA,EACF,KAAK,EACF,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,SAAS,EACN,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAC9B;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,QAAQ,EACL,OAAO,EACP,IAAI,EACJ,SAAS,EACT;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,eAAe,EACZ,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,eAAe,EACZ,KAAK,CAAC,QAAQ,MAAM,CAAC,EACrB;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AAEM,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,OAAO,oBAAoB;AAAA,IACzB;AAAA,EACF;AACF,CAAC;;;AC/CD,SAAS,KAAAA,UAAS;AAEX,IAAM,gBAAgBA,GAAE,OAAO;AAAA,EACpC,WAAWA,GACR,OAAO,EACP,SAAS,EACT;AAAA,IACC;AAAA,EACF;AACJ,CAAC;;;AFDM,IAAM,WAAW,YAAY,cAAc;AAC3C,IAAM,UAAU,YAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAYA,IAAM,YAAoB,MAAM,QAAQ,QAAQ,iBAAiB;AACjE,IAAM,YAAoB,MAAM,QAAQ,QAAQ,IAAI;AAEpD,SAAS,qBAAwC;AAC/C,QAAM,WAA8B;AAAA,IAClC,MAAM,MAAM;AAAA,IACZ,MAAM,MAAM,QAAQ,QAAQ,CAAC,CAAC;AAAA,EAChC;AACA,SAAO;AACT;AAEA,IAAM,kBAAN,MAAiD;AAAA,EAC/C,YAAY,eAAiD;AAC7D,gBAAe;AAIf,gBAAe;AAAA,EAL+C;AAAA,EAE9D,WAA8B;AAC5B,WAAO,mBAAmB;AAAA,EAC5B;AAAA,EAEA,KAAc;AACZ,WAAO;AAAA,EACT;AACF;AAEA,IAAM,uBAA+C;AAE9C,IAAM,OAAY;AAAA,EACvB,OAAO;AAAA,IACL,QAAQ;AAAA,EACV;AACF;AAEO,IAAM,aAAa,CAAC,kBAAkB;;;AC3C7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,SAAS,gBAAgB;AAalB,IAAM,cAAgC;AAAA,EAC3C,IAAI,SAAS,aAAa;AAAA,IACxB,WAAW;AAAA,EACb,CAAC;AAAA,EACD,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,gBAAkC;AAAA,EAC7C,IAAI,SAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,OAAO,OAAO,UAAU,MAAM;AAAA,EACvD,CAAC;AAAA,EACD,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,aAA+B;AAAA,EAC1C,IAAI,SAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,MAAM,SAAS;AAAA,EACxC,CAAC;AAAA,EACD,UAAU;AAAA,IACR,OAAO;AAAA,MACL,WAAW;AAAA,MACX,QAAQ;AAAA,IACV;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA,CAAC,mBAAmB,UAAU,KAAK,KAAO,KAAK,SAAS,YAAY;AAAA,IACtE;AAAA,EACF;AACF;AAKO,IAAM,gBAAkC;AAAA,EAC7C,IAAI,SAAS,aAAa;AAAA,IACxB,WAAW;AAAA,EACb,CAAC;AAAA,EACD,UAAU;AAAA,IACR,OAAO;AAAA,MACL,WAAW;AAAA,MACX,QAAQ;AAAA,MACR,eAAe;AAAA,IACjB;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA,CAAC,mBAAmB,UAAU,KAAM,KAAK,SAAS,YAAY;AAAA,IAChE;AAAA,EACF;AACF;AAKO,IAAM,oBAAsC;AAAA,EACjD,IAAI,SAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,WAAW,OAAO,GAAG;AAAA,EACnC,CAAC;AAAA,EACD,SAAS;AAAA,IACP,UAAU;AAAA,MACR,WAAW;AAAA,IACb;AAAA,EACF;AAAA,EACA,KAAK,CAAC,CAAC,eAAe,CAAC,mBAAmB,KAAK,SAAS,YAAY,CAAC,CAAC;AACxE;AAKO,IAAM,eAAiC;AAAA,EAC5C,IAAI,SAAS,eAAe;AAAA,IAC1B,WAAW;AAAA,EACb,CAAC;AAAA,EACD,SAAS,EAAE,QAAQ,KAAK;AAAA,EACxB,KAAK,CAAC;AACR;","names":["z"]}

package/dist/examples/index.d.mts

@@ -0,0 +1,144 @@
+import { DestinationServer } from '@walkeros/server-core';
+import { Flow } from '@walkeros/core';
+
+/**
+ * Arguments passed to Redis XADD. Strings or numbers (for MAXLEN counts).
+ */
+type XaddArg = string | number;
+/**
+ * Mock-friendly Redis pipeline interface. Accumulates commands and
+ * executes them with a single round-trip via exec().
+ */
+interface RedisPipelineMock {
+    xadd: (...args: XaddArg[]) => RedisPipelineMock;
+    exec: () => Promise<Array<[Error | null, unknown]> | null>;
+}
+/**
+ * Mock-friendly Redis client interface used by the destination.
+ * Tests provide this via env.Redis; production creates a real ioredis
+ * client and uses it directly.
+ */
+interface RedisClientMock {
+    xadd: (...args: XaddArg[]) => Promise<string | null>;
+    pipeline: () => RedisPipelineMock;
+    quit: () => Promise<string>;
+    on?: (event: string, listener: (...args: unknown[]) => void) => unknown;
+}
+/**
+ * Constructor signature for the Redis client. Accepts either a URL
+ * string or an options object, matching ioredis's dual signature.
+ */
+interface RedisClientConstructor {
+    new (url: string): RedisClientMock;
+    new (options: RedisClientOptions): RedisClientMock;
+}
+/**
+ * Minimal ioredis options subset the destination passes through.
+ * Unknown options are preserved for the SDK to handle.
+ */
+interface RedisClientOptions {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    db?: number;
+    tls?: boolean | Record<string, unknown>;
+    connectTimeout?: number;
+    commandTimeout?: number;
+    [key: string]: unknown;
+}
+type SerializationMode = 'json' | 'flat';
+interface RedisSettings {
+    /** Redis stream key name (e.g. 'walkeros:events'). */
+    streamKey: string;
+    /** Redis connection URL (e.g. 'redis://localhost:6379' or 'rediss://...'). */
+    url?: string;
+    /** ioredis connection options (used if no url provided). */
+    options?: RedisClientOptions;
+    /**
+     * Maximum stream length. Enables MAXLEN trimming on every XADD.
+     * Uses approximate (~) trimming by default for performance.
+     * Omit for unlimited stream length.
+     */
+    maxLen?: number;
+    /**
+     * Use exact MAXLEN instead of approximate (~).
+     * Not recommended for production -- significantly slower.
+     * Default: false (approximate trimming).
+     */
+    exactTrimming?: boolean;
+    /**
+     * Serialization mode for the event payload.
+     * - 'json': Single 'event' field with JSON string (default)
+     * - 'flat': Top-level event fields as separate stream fields
+     */
+    serialization?: SerializationMode;
+    _client?: RedisClientMock;
+    _ownedClient?: boolean;
+}
+interface Settings {
+    redis: RedisSettings;
+}
+/**
+ * Env -- optional Redis SDK override. Production leaves this undefined
+ * and the destination creates real ioredis client instances. Tests provide
+ * mocks via env.Redis.
+ */
+interface Env extends DestinationServer.Env {
+    Redis?: {
+        Client: RedisClientConstructor;
+    };
+}
+
+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 RedisStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default JSON serialization -- single 'event' field with full event JSON.
+ */
+declare const jsonDefault: RedisStepExample;
+/**
+ * Order event -- verifies different event types pass through correctly.
+ */
+declare const orderComplete: RedisStepExample;
+/**
+ * With MAXLEN approximate trimming -- trimming args inserted before '*'.
+ */
+declare const withMaxLen: RedisStepExample;
+/**
+ * Exact MAXLEN trimming -- no '~' between MAXLEN and the count.
+ */
+declare const withExactTrim: RedisStepExample;
+/**
+ * Stream key override per rule -- routes this event to a dedicated stream.
+ */
+declare const streamKeyOverride: RedisStepExample;
+/**
+ * Ignored event -- mapping.ignore: true produces no xadd call.
+ */
+declare const ignoredEvent: RedisStepExample;
+
+type step_RedisStepExample = RedisStepExample;
+declare const step_ignoredEvent: typeof ignoredEvent;
+declare const step_jsonDefault: typeof jsonDefault;
+declare const step_orderComplete: typeof orderComplete;
+declare const step_streamKeyOverride: typeof streamKeyOverride;
+declare const step_withExactTrim: typeof withExactTrim;
+declare const step_withMaxLen: typeof withMaxLen;
+declare namespace step {
+  export { type step_RedisStepExample as RedisStepExample, step_ignoredEvent as ignoredEvent, step_jsonDefault as jsonDefault, step_orderComplete as orderComplete, step_streamKeyOverride as streamKeyOverride, step_withExactTrim as withExactTrim, step_withMaxLen as withMaxLen };
+}
+
+export { env, step };