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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/config.ts","../src/push.ts","../src/types/index.ts"],"sourcesContent":["import type {\n  Destination,\n  Settings,\n  Env,\n  RedisClientMock,\n  RedisClientConstructor,\n  RedisClientOptions,\n} from './types';\nimport { getConfig, isRedisEnv } from './config';\nimport { push } from './push';\n\n// Types re-export\nexport * as DestinationRedis from './types';\n\nexport const destinationRedis: Destination = {\n  type: 'redis',\n\n  config: {},\n\n  async init({ config: partialConfig, logger, env }) {\n    const config = getConfig(partialConfig, logger);\n    const settings = config.settings as Settings;\n    const redis = settings.redis;\n\n    // Skip creation if a client has already been wired in (testing).\n    if (redis._client) return config;\n\n    let Constructor: RedisClientConstructor | undefined;\n\n    // Prefer env-injected constructor (testing, dependency injection).\n    if (isRedisEnv(env)) {\n      const envTyped = env as Env;\n      Constructor = envTyped.Redis?.Client;\n    }\n\n    // Production path: load real ioredis SDK.\n    if (!Constructor) {\n      try {\n        // Use dynamic require to allow tests to mock via jest.mock('ioredis').\n        const ioredis = require('ioredis') as {\n          default?: RedisClientConstructor;\n          Redis?: RedisClientConstructor;\n        };\n        // ioredis exports the class as default (ESM) and as named Redis export.\n        Constructor = ioredis.default ?? ioredis.Redis;\n      } catch (err) {\n        logger.throw(`Failed to load ioredis: ${String(err)}`);\n        return config;\n      }\n    }\n\n    if (!Constructor) {\n      logger.throw('ioredis constructor not found');\n      return config;\n    }\n\n    let client: RedisClientMock;\n    if (redis.url) {\n      client = new Constructor(redis.url);\n    } else {\n      client = new Constructor(redis.options ?? ({} as RedisClientOptions));\n    }\n\n    redis._client = client;\n    redis._ownedClient = true;\n\n    return config;\n  },\n\n  async push(event, context) {\n    return await push(event, context);\n  },\n\n  async destroy({ config }) {\n    const settings = config?.settings as Settings | undefined;\n    const redis = settings?.redis;\n    if (!redis) return;\n\n    const client = redis._client;\n    // Only close clients the destination created (not user-provided)\n    if (client && redis._ownedClient) {\n      try {\n        await client.quit();\n      } finally {\n        redis._client = undefined;\n        redis._ownedClient = undefined;\n      }\n    }\n  },\n};\n\nexport default destinationRedis;\n","import type {\n  Config,\n  Settings,\n  RedisSettings,\n  PartialConfig,\n  Env,\n} from './types';\nimport type { Logger } from '@walkeros/core';\nimport { isObject } from '@walkeros/core';\n\nexport function getConfig(\n  partialConfig: PartialConfig = {},\n  logger: Logger.Instance,\n): Config {\n  const raw = (partialConfig.settings ?? {}) as Partial<Settings>;\n  const redis: Partial<RedisSettings> =\n    raw.redis ?? ({} as Partial<RedisSettings>);\n\n  if (!redis.streamKey) {\n    logger.throw('Config settings redis.streamKey missing');\n  }\n\n  const redisSettings: RedisSettings = {\n    ...redis,\n    streamKey: redis.streamKey as string,\n    serialization: redis.serialization ?? 'json',\n  };\n\n  const settings: Settings = { redis: redisSettings };\n\n  return { ...partialConfig, settings };\n}\n\nexport function isRedisEnv(env: unknown): env is Env {\n  if (!isObject(env)) return false;\n  const maybe = env as { Redis?: { Client?: unknown } };\n  return typeof maybe.Redis?.Client === 'function';\n}\n","import type {\n  PushFn,\n  RedisSettings,\n  RedisClientMock,\n  XaddArg,\n  SerializationMode,\n} from './types';\nimport { isString } from '@walkeros/core';\n\nexport const push: PushFn = async function (event, { config, rule, logger }) {\n  const settings = config.settings as { redis?: RedisSettings } | undefined;\n  const redis: RedisSettings | undefined = settings?.redis;\n\n  if (!redis) {\n    logger.warn('Redis settings missing');\n    return;\n  }\n\n  const client = redis._client;\n  if (!client) {\n    logger.warn('Redis client not initialized');\n    return;\n  }\n\n  // Derive stream key: rule override -> destination default\n  const ruleSettings = rule?.settings ?? {};\n  const streamKey = isString(ruleSettings.streamKey)\n    ? ruleSettings.streamKey\n    : redis.streamKey;\n\n  const serialization: SerializationMode = redis.serialization ?? 'json';\n\n  // Serialize event\n  const fields: string[] =\n    serialization === 'flat'\n      ? flattenEvent(event as unknown as Record<string, unknown>)\n      : ['event', JSON.stringify(event)];\n\n  // Build XADD arguments\n  const args: XaddArg[] = [streamKey];\n\n  // Optional MAXLEN trimming\n  if (redis.maxLen) {\n    args.push('MAXLEN');\n    if (!redis.exactTrimming) args.push('~');\n    args.push(redis.maxLen);\n  }\n\n  args.push('*'); // Auto-generate entry ID\n  args.push(...fields); // Field-value pairs\n\n  logger.debug('Redis XADD', { stream: streamKey });\n\n  try {\n    const entryId = await (client as RedisClientMock).xadd(...args);\n    logger.debug('Redis XADD complete', { stream: streamKey, entryId });\n  } catch (error) {\n    logger.error('Redis XADD failed', {\n      stream: streamKey,\n      error: error instanceof Error ? error.message : String(error),\n    });\n  }\n};\n\nfunction flattenEvent(event: Record<string, unknown>): string[] {\n  const fields: string[] = [];\n  for (const [key, value] of Object.entries(event)) {\n    fields.push(\n      key,\n      typeof value === 'object' && value !== null\n        ? JSON.stringify(value)\n        : String(value),\n    );\n  }\n  return fields;\n}\n","import type { Destination as CoreDestination } from '@walkeros/core';\nimport type { DestinationServer } from '@walkeros/server-core';\n\n/**\n * Arguments passed to Redis XADD. Strings or numbers (for MAXLEN counts).\n */\nexport type XaddArg = string | number;\n\n/**\n * Mock-friendly Redis pipeline interface. Accumulates commands and\n * executes them with a single round-trip via exec().\n */\nexport interface RedisPipelineMock {\n  xadd: (...args: XaddArg[]) => RedisPipelineMock;\n  exec: () => Promise<Array<[Error | null, unknown]> | null>;\n}\n\n/**\n * Mock-friendly Redis client interface used by the destination.\n * Tests provide this via env.Redis; production creates a real ioredis\n * client and uses it directly.\n */\nexport interface RedisClientMock {\n  xadd: (...args: XaddArg[]) => Promise<string | null>;\n  pipeline: () => RedisPipelineMock;\n  quit: () => Promise<string>;\n  on?: (event: string, listener: (...args: unknown[]) => void) => unknown;\n}\n\n/**\n * Constructor signature for the Redis client. Accepts either a URL\n * string or an options object, matching ioredis's dual signature.\n */\nexport interface RedisClientConstructor {\n  new (url: string): RedisClientMock;\n  new (options: RedisClientOptions): RedisClientMock;\n}\n\n/**\n * Minimal ioredis options subset the destination passes through.\n * Unknown options are preserved for the SDK to handle.\n */\nexport interface RedisClientOptions {\n  host?: string;\n  port?: number;\n  username?: string;\n  password?: string;\n  db?: number;\n  tls?: boolean | Record<string, unknown>;\n  connectTimeout?: number;\n  commandTimeout?: number;\n  [key: string]: unknown;\n}\n\nexport type SerializationMode = 'json' | 'flat';\n\nexport interface RedisSettings {\n  /** Redis stream key name (e.g. 'walkeros:events'). */\n  streamKey: string;\n  /** Redis connection URL (e.g. 'redis://localhost:6379' or 'rediss://...'). */\n  url?: string;\n  /** ioredis connection options (used if no url provided). */\n  options?: RedisClientOptions;\n  /**\n   * Maximum stream length. Enables MAXLEN trimming on every XADD.\n   * Uses approximate (~) trimming by default for performance.\n   * Omit for unlimited stream length.\n   */\n  maxLen?: number;\n  /**\n   * Use exact MAXLEN instead of approximate (~).\n   * Not recommended for production -- significantly slower.\n   * Default: false (approximate trimming).\n   */\n  exactTrimming?: boolean;\n  /**\n   * Serialization mode for the event payload.\n   * - 'json': Single 'event' field with JSON string (default)\n   * - 'flat': Top-level event fields as separate stream fields\n   */\n  serialization?: SerializationMode;\n\n  // Runtime -- set during init, not user-facing\n  _client?: RedisClientMock;\n  _ownedClient?: boolean;\n}\n\nexport interface Settings {\n  redis: RedisSettings;\n}\n\nexport type InitSettings = Partial<Settings>;\n\nexport interface Mapping {\n  /** Override stream key for this rule. */\n  streamKey?: string;\n}\n\n/**\n * Env -- optional Redis SDK override. Production leaves this undefined\n * and the destination creates real ioredis client instances. Tests provide\n * mocks via env.Redis.\n */\nexport interface Env extends DestinationServer.Env {\n  Redis?: {\n    Client: RedisClientConstructor;\n  };\n}\n\nexport type Types = CoreDestination.Types<Settings, Mapping, Env, InitSettings>;\n\nexport interface Destination extends DestinationServer.Destination<Types> {\n  init: DestinationServer.InitFn<Types>;\n}\n\nexport type Config = {\n  settings: Settings;\n} & DestinationServer.Config<Types>;\n\nexport type InitFn = DestinationServer.InitFn<Types>;\nexport type PushFn = DestinationServer.PushFn<Types>;\nexport type PartialConfig = DestinationServer.PartialConfig<Types>;\nexport type PushEvents = DestinationServer.PushEvents<Mapping>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQA,kBAAyB;AAElB,SAAS,UACd,gBAA+B,CAAC,GAChC,QACQ;AAbV;AAcE,QAAM,OAAO,mBAAc,aAAd,YAA0B,CAAC;AACxC,QAAM,SACJ,SAAI,UAAJ,YAAc,CAAC;AAEjB,MAAI,CAAC,MAAM,WAAW;AACpB,WAAO,MAAM,yCAAyC;AAAA,EACxD;AAEA,QAAM,gBAA+B;AAAA,IACnC,GAAG;AAAA,IACH,WAAW,MAAM;AAAA,IACjB,gBAAe,WAAM,kBAAN,YAAuB;AAAA,EACxC;AAEA,QAAM,WAAqB,EAAE,OAAO,cAAc;AAElD,SAAO,EAAE,GAAG,eAAe,SAAS;AACtC;AAEO,SAAS,WAAW,KAA0B;AAjCrD;AAkCE,MAAI,KAAC,sBAAS,GAAG,EAAG,QAAO;AAC3B,QAAM,QAAQ;AACd,SAAO,SAAO,WAAM,UAAN,mBAAa,YAAW;AACxC;;;AC9BA,IAAAA,eAAyB;AAElB,IAAM,OAAe,eAAgB,OAAO,EAAE,QAAQ,MAAM,OAAO,GAAG;AAT7E;AAUE,QAAM,WAAW,OAAO;AACxB,QAAM,QAAmC,qCAAU;AAEnD,MAAI,CAAC,OAAO;AACV,WAAO,KAAK,wBAAwB;AACpC;AAAA,EACF;AAEA,QAAM,SAAS,MAAM;AACrB,MAAI,CAAC,QAAQ;AACX,WAAO,KAAK,8BAA8B;AAC1C;AAAA,EACF;AAGA,QAAM,gBAAe,kCAAM,aAAN,YAAkB,CAAC;AACxC,QAAM,gBAAY,uBAAS,aAAa,SAAS,IAC7C,aAAa,YACb,MAAM;AAEV,QAAM,iBAAmC,WAAM,kBAAN,YAAuB;AAGhE,QAAM,SACJ,kBAAkB,SACd,aAAa,KAA2C,IACxD,CAAC,SAAS,KAAK,UAAU,KAAK,CAAC;AAGrC,QAAM,OAAkB,CAAC,SAAS;AAGlC,MAAI,MAAM,QAAQ;AAChB,SAAK,KAAK,QAAQ;AAClB,QAAI,CAAC,MAAM,cAAe,MAAK,KAAK,GAAG;AACvC,SAAK,KAAK,MAAM,MAAM;AAAA,EACxB;AAEA,OAAK,KAAK,GAAG;AACb,OAAK,KAAK,GAAG,MAAM;AAEnB,SAAO,MAAM,cAAc,EAAE,QAAQ,UAAU,CAAC;AAEhD,MAAI;AACF,UAAM,UAAU,MAAO,OAA2B,KAAK,GAAG,IAAI;AAC9D,WAAO,MAAM,uBAAuB,EAAE,QAAQ,WAAW,QAAQ,CAAC;AAAA,EACpE,SAAS,OAAO;AACd,WAAO,MAAM,qBAAqB;AAAA,MAChC,QAAQ;AAAA,MACR,OAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,IAC9D,CAAC;AAAA,EACH;AACF;AAEA,SAAS,aAAa,OAA0C;AAC9D,QAAM,SAAmB,CAAC;AAC1B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,WAAO;AAAA,MACL;AAAA,MACA,OAAO,UAAU,YAAY,UAAU,OACnC,KAAK,UAAU,KAAK,IACpB,OAAO,KAAK;AAAA,IAClB;AAAA,EACF;AACA,SAAO;AACT;;;AC3EA;;;AHcO,IAAM,mBAAgC;AAAA,EAC3C,MAAM;AAAA,EAEN,QAAQ,CAAC;AAAA,EAET,MAAM,KAAK,EAAE,QAAQ,eAAe,QAAQ,IAAI,GAAG;AAnBrD;AAoBI,UAAM,SAAS,UAAU,eAAe,MAAM;AAC9C,UAAM,WAAW,OAAO;AACxB,UAAM,QAAQ,SAAS;AAGvB,QAAI,MAAM,QAAS,QAAO;AAE1B,QAAI;AAGJ,QAAI,WAAW,GAAG,GAAG;AACnB,YAAM,WAAW;AACjB,qBAAc,cAAS,UAAT,mBAAgB;AAAA,IAChC;AAGA,QAAI,CAAC,aAAa;AAChB,UAAI;AAEF,cAAM,UAAU,QAAQ,SAAS;AAKjC,uBAAc,aAAQ,YAAR,YAAmB,QAAQ;AAAA,MAC3C,SAAS,KAAK;AACZ,eAAO,MAAM,2BAA2B,OAAO,GAAG,CAAC,EAAE;AACrD,eAAO;AAAA,MACT;AAAA,IACF;AAEA,QAAI,CAAC,aAAa;AAChB,aAAO,MAAM,+BAA+B;AAC5C,aAAO;AAAA,IACT;AAEA,QAAI;AACJ,QAAI,MAAM,KAAK;AACb,eAAS,IAAI,YAAY,MAAM,GAAG;AAAA,IACpC,OAAO;AACL,eAAS,IAAI,aAAY,WAAM,YAAN,YAAkB,CAAC,CAAwB;AAAA,IACtE;AAEA,UAAM,UAAU;AAChB,UAAM,eAAe;AAErB,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,KAAK,OAAO,SAAS;AACzB,WAAO,MAAM,KAAK,OAAO,OAAO;AAAA,EAClC;AAAA,EAEA,MAAM,QAAQ,EAAE,OAAO,GAAG;AACxB,UAAM,WAAW,iCAAQ;AACzB,UAAM,QAAQ,qCAAU;AACxB,QAAI,CAAC,MAAO;AAEZ,UAAM,SAAS,MAAM;AAErB,QAAI,UAAU,MAAM,cAAc;AAChC,UAAI;AACF,cAAM,OAAO,KAAK;AAAA,MACpB,UAAE;AACA,cAAM,UAAU;AAChB,cAAM,eAAe;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":["import_core"]}

package/dist/index.mjs

@@ -0,0 +1 @@
+var e=(e=>"undefined"!=typeof require?require:"undefined"!=typeof Proxy?new Proxy(e,{get:(e,i)=>("undefined"!=typeof require?require:e)[i]}):e)(function(e){if("undefined"!=typeof require)return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});import{isObject as i}from"@walkeros/core";import{isString as n}from"@walkeros/core";var t=async function(e,{config:i,rule:t,logger:r}){var s,o;const l=i.settings,u=null==l?void 0:l.redis;if(!u)return void r.warn("Redis settings missing");const a=u._client;if(!a)return void r.warn("Redis client not initialized");const d=null!=(s=null==t?void 0:t.settings)?s:{},c=n(d.streamKey)?d.streamKey:u.streamKey,f="flat"===(null!=(o=u.serialization)?o:"json")?function(e){const i=[];for(const[n,t]of Object.entries(e))i.push(n,"object"==typeof t&&null!==t?JSON.stringify(t):String(t));return i}(e):["event",JSON.stringify(e)],y=[c];u.maxLen&&(y.push("MAXLEN"),u.exactTrimming||y.push("~"),y.push(u.maxLen)),y.push("*"),y.push(...f),r.debug("Redis XADD",{stream:c});try{const e=await a.xadd(...y);r.debug("Redis XADD complete",{stream:c,entryId:e})}catch(e){r.error("Redis XADD failed",{stream:c,error:e instanceof Error?e.message:String(e)})}};var r={},s={type:"redis",config:{},async init({config:n,logger:t,env:r}){var s,o,l;const u=function(e={},i){var n,t,r;const s=null!=(t=(null!=(n=e.settings)?n:{}).redis)?t:{};s.streamKey||i.throw("Config settings redis.streamKey missing");const o={redis:{...s,streamKey:s.streamKey,serialization:null!=(r=s.serialization)?r:"json"}};return{...e,settings:o}}(n,t),a=u.settings.redis;if(a._client)return u;let d,c;if(function(e){var n;return!!i(e)&&"function"==typeof(null==(n=e.Redis)?void 0:n.Client)}(r)){d=null==(s=r.Redis)?void 0:s.Client}if(!d)try{const i=e("ioredis");d=null!=(o=i.default)?o:i.Redis}catch(e){return t.throw(`Failed to load ioredis: ${String(e)}`),u}return d?(c=a.url?new d(a.url):new d(null!=(l=a.options)?l:{}),a._client=c,a._ownedClient=!0,u):(t.throw("ioredis constructor not found"),u)},push:async(e,i)=>await t(e,i),async destroy({config:e}){const i=null==e?void 0:e.settings,n=null==i?void 0:i.redis;if(!n)return;const t=n._client;if(t&&n._ownedClient)try{await t.quit()}finally{n._client=void 0,n._ownedClient=void 0}}},o=s;export{r as DestinationRedis,o as default,s as destinationRedis};//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config.ts","../src/push.ts","../src/types/index.ts","../src/index.ts"],"sourcesContent":["import type {\n  Config,\n  Settings,\n  RedisSettings,\n  PartialConfig,\n  Env,\n} from './types';\nimport type { Logger } from '@walkeros/core';\nimport { isObject } from '@walkeros/core';\n\nexport function getConfig(\n  partialConfig: PartialConfig = {},\n  logger: Logger.Instance,\n): Config {\n  const raw = (partialConfig.settings ?? {}) as Partial<Settings>;\n  const redis: Partial<RedisSettings> =\n    raw.redis ?? ({} as Partial<RedisSettings>);\n\n  if (!redis.streamKey) {\n    logger.throw('Config settings redis.streamKey missing');\n  }\n\n  const redisSettings: RedisSettings = {\n    ...redis,\n    streamKey: redis.streamKey as string,\n    serialization: redis.serialization ?? 'json',\n  };\n\n  const settings: Settings = { redis: redisSettings };\n\n  return { ...partialConfig, settings };\n}\n\nexport function isRedisEnv(env: unknown): env is Env {\n  if (!isObject(env)) return false;\n  const maybe = env as { Redis?: { Client?: unknown } };\n  return typeof maybe.Redis?.Client === 'function';\n}\n","import type {\n  PushFn,\n  RedisSettings,\n  RedisClientMock,\n  XaddArg,\n  SerializationMode,\n} from './types';\nimport { isString } from '@walkeros/core';\n\nexport const push: PushFn = async function (event, { config, rule, logger }) {\n  const settings = config.settings as { redis?: RedisSettings } | undefined;\n  const redis: RedisSettings | undefined = settings?.redis;\n\n  if (!redis) {\n    logger.warn('Redis settings missing');\n    return;\n  }\n\n  const client = redis._client;\n  if (!client) {\n    logger.warn('Redis client not initialized');\n    return;\n  }\n\n  // Derive stream key: rule override -> destination default\n  const ruleSettings = rule?.settings ?? {};\n  const streamKey = isString(ruleSettings.streamKey)\n    ? ruleSettings.streamKey\n    : redis.streamKey;\n\n  const serialization: SerializationMode = redis.serialization ?? 'json';\n\n  // Serialize event\n  const fields: string[] =\n    serialization === 'flat'\n      ? flattenEvent(event as unknown as Record<string, unknown>)\n      : ['event', JSON.stringify(event)];\n\n  // Build XADD arguments\n  const args: XaddArg[] = [streamKey];\n\n  // Optional MAXLEN trimming\n  if (redis.maxLen) {\n    args.push('MAXLEN');\n    if (!redis.exactTrimming) args.push('~');\n    args.push(redis.maxLen);\n  }\n\n  args.push('*'); // Auto-generate entry ID\n  args.push(...fields); // Field-value pairs\n\n  logger.debug('Redis XADD', { stream: streamKey });\n\n  try {\n    const entryId = await (client as RedisClientMock).xadd(...args);\n    logger.debug('Redis XADD complete', { stream: streamKey, entryId });\n  } catch (error) {\n    logger.error('Redis XADD failed', {\n      stream: streamKey,\n      error: error instanceof Error ? error.message : String(error),\n    });\n  }\n};\n\nfunction flattenEvent(event: Record<string, unknown>): string[] {\n  const fields: string[] = [];\n  for (const [key, value] of Object.entries(event)) {\n    fields.push(\n      key,\n      typeof value === 'object' && value !== null\n        ? JSON.stringify(value)\n        : String(value),\n    );\n  }\n  return fields;\n}\n","import type { Destination as CoreDestination } from '@walkeros/core';\nimport type { DestinationServer } from '@walkeros/server-core';\n\n/**\n * Arguments passed to Redis XADD. Strings or numbers (for MAXLEN counts).\n */\nexport type XaddArg = string | number;\n\n/**\n * Mock-friendly Redis pipeline interface. Accumulates commands and\n * executes them with a single round-trip via exec().\n */\nexport interface RedisPipelineMock {\n  xadd: (...args: XaddArg[]) => RedisPipelineMock;\n  exec: () => Promise<Array<[Error | null, unknown]> | null>;\n}\n\n/**\n * Mock-friendly Redis client interface used by the destination.\n * Tests provide this via env.Redis; production creates a real ioredis\n * client and uses it directly.\n */\nexport interface RedisClientMock {\n  xadd: (...args: XaddArg[]) => Promise<string | null>;\n  pipeline: () => RedisPipelineMock;\n  quit: () => Promise<string>;\n  on?: (event: string, listener: (...args: unknown[]) => void) => unknown;\n}\n\n/**\n * Constructor signature for the Redis client. Accepts either a URL\n * string or an options object, matching ioredis's dual signature.\n */\nexport interface RedisClientConstructor {\n  new (url: string): RedisClientMock;\n  new (options: RedisClientOptions): RedisClientMock;\n}\n\n/**\n * Minimal ioredis options subset the destination passes through.\n * Unknown options are preserved for the SDK to handle.\n */\nexport interface RedisClientOptions {\n  host?: string;\n  port?: number;\n  username?: string;\n  password?: string;\n  db?: number;\n  tls?: boolean | Record<string, unknown>;\n  connectTimeout?: number;\n  commandTimeout?: number;\n  [key: string]: unknown;\n}\n\nexport type SerializationMode = 'json' | 'flat';\n\nexport interface RedisSettings {\n  /** Redis stream key name (e.g. 'walkeros:events'). */\n  streamKey: string;\n  /** Redis connection URL (e.g. 'redis://localhost:6379' or 'rediss://...'). */\n  url?: string;\n  /** ioredis connection options (used if no url provided). */\n  options?: RedisClientOptions;\n  /**\n   * Maximum stream length. Enables MAXLEN trimming on every XADD.\n   * Uses approximate (~) trimming by default for performance.\n   * Omit for unlimited stream length.\n   */\n  maxLen?: number;\n  /**\n   * Use exact MAXLEN instead of approximate (~).\n   * Not recommended for production -- significantly slower.\n   * Default: false (approximate trimming).\n   */\n  exactTrimming?: boolean;\n  /**\n   * Serialization mode for the event payload.\n   * - 'json': Single 'event' field with JSON string (default)\n   * - 'flat': Top-level event fields as separate stream fields\n   */\n  serialization?: SerializationMode;\n\n  // Runtime -- set during init, not user-facing\n  _client?: RedisClientMock;\n  _ownedClient?: boolean;\n}\n\nexport interface Settings {\n  redis: RedisSettings;\n}\n\nexport type InitSettings = Partial<Settings>;\n\nexport interface Mapping {\n  /** Override stream key for this rule. */\n  streamKey?: string;\n}\n\n/**\n * Env -- optional Redis SDK override. Production leaves this undefined\n * and the destination creates real ioredis client instances. Tests provide\n * mocks via env.Redis.\n */\nexport interface Env extends DestinationServer.Env {\n  Redis?: {\n    Client: RedisClientConstructor;\n  };\n}\n\nexport type Types = CoreDestination.Types<Settings, Mapping, Env, InitSettings>;\n\nexport interface Destination extends DestinationServer.Destination<Types> {\n  init: DestinationServer.InitFn<Types>;\n}\n\nexport type Config = {\n  settings: Settings;\n} & DestinationServer.Config<Types>;\n\nexport type InitFn = DestinationServer.InitFn<Types>;\nexport type PushFn = DestinationServer.PushFn<Types>;\nexport type PartialConfig = DestinationServer.PartialConfig<Types>;\nexport type PushEvents = DestinationServer.PushEvents<Mapping>;\n","import type {\n  Destination,\n  Settings,\n  Env,\n  RedisClientMock,\n  RedisClientConstructor,\n  RedisClientOptions,\n} from './types';\nimport { getConfig, isRedisEnv } from './config';\nimport { push } from './push';\n\n// Types re-export\nexport * as DestinationRedis from './types';\n\nexport const destinationRedis: Destination = {\n  type: 'redis',\n\n  config: {},\n\n  async init({ config: partialConfig, logger, env }) {\n    const config = getConfig(partialConfig, logger);\n    const settings = config.settings as Settings;\n    const redis = settings.redis;\n\n    // Skip creation if a client has already been wired in (testing).\n    if (redis._client) return config;\n\n    let Constructor: RedisClientConstructor | undefined;\n\n    // Prefer env-injected constructor (testing, dependency injection).\n    if (isRedisEnv(env)) {\n      const envTyped = env as Env;\n      Constructor = envTyped.Redis?.Client;\n    }\n\n    // Production path: load real ioredis SDK.\n    if (!Constructor) {\n      try {\n        // Use dynamic require to allow tests to mock via jest.mock('ioredis').\n        const ioredis = require('ioredis') as {\n          default?: RedisClientConstructor;\n          Redis?: RedisClientConstructor;\n        };\n        // ioredis exports the class as default (ESM) and as named Redis export.\n        Constructor = ioredis.default ?? ioredis.Redis;\n      } catch (err) {\n        logger.throw(`Failed to load ioredis: ${String(err)}`);\n        return config;\n      }\n    }\n\n    if (!Constructor) {\n      logger.throw('ioredis constructor not found');\n      return config;\n    }\n\n    let client: RedisClientMock;\n    if (redis.url) {\n      client = new Constructor(redis.url);\n    } else {\n      client = new Constructor(redis.options ?? ({} as RedisClientOptions));\n    }\n\n    redis._client = client;\n    redis._ownedClient = true;\n\n    return config;\n  },\n\n  async push(event, context) {\n    return await push(event, context);\n  },\n\n  async destroy({ config }) {\n    const settings = config?.settings as Settings | undefined;\n    const redis = settings?.redis;\n    if (!redis) return;\n\n    const client = redis._client;\n    // Only close clients the destination created (not user-provided)\n    if (client && redis._ownedClient) {\n      try {\n        await client.quit();\n      } finally {\n        redis._client = undefined;\n        redis._ownedClient = undefined;\n      }\n    }\n  },\n};\n\nexport default destinationRedis;\n"],"mappings":";;;;;;;;AAQA,SAAS,gBAAgB;AAElB,SAAS,UACd,gBAA+B,CAAC,GAChC,QACQ;AAbV;AAcE,QAAM,OAAO,mBAAc,aAAd,YAA0B,CAAC;AACxC,QAAM,SACJ,SAAI,UAAJ,YAAc,CAAC;AAEjB,MAAI,CAAC,MAAM,WAAW;AACpB,WAAO,MAAM,yCAAyC;AAAA,EACxD;AAEA,QAAM,gBAA+B;AAAA,IACnC,GAAG;AAAA,IACH,WAAW,MAAM;AAAA,IACjB,gBAAe,WAAM,kBAAN,YAAuB;AAAA,EACxC;AAEA,QAAM,WAAqB,EAAE,OAAO,cAAc;AAElD,SAAO,EAAE,GAAG,eAAe,SAAS;AACtC;AAEO,SAAS,WAAW,KAA0B;AAjCrD;AAkCE,MAAI,CAAC,SAAS,GAAG,EAAG,QAAO;AAC3B,QAAM,QAAQ;AACd,SAAO,SAAO,WAAM,UAAN,mBAAa,YAAW;AACxC;;;AC9BA,SAAS,gBAAgB;AAElB,IAAM,OAAe,eAAgB,OAAO,EAAE,QAAQ,MAAM,OAAO,GAAG;AAT7E;AAUE,QAAM,WAAW,OAAO;AACxB,QAAM,QAAmC,qCAAU;AAEnD,MAAI,CAAC,OAAO;AACV,WAAO,KAAK,wBAAwB;AACpC;AAAA,EACF;AAEA,QAAM,SAAS,MAAM;AACrB,MAAI,CAAC,QAAQ;AACX,WAAO,KAAK,8BAA8B;AAC1C;AAAA,EACF;AAGA,QAAM,gBAAe,kCAAM,aAAN,YAAkB,CAAC;AACxC,QAAM,YAAY,SAAS,aAAa,SAAS,IAC7C,aAAa,YACb,MAAM;AAEV,QAAM,iBAAmC,WAAM,kBAAN,YAAuB;AAGhE,QAAM,SACJ,kBAAkB,SACd,aAAa,KAA2C,IACxD,CAAC,SAAS,KAAK,UAAU,KAAK,CAAC;AAGrC,QAAM,OAAkB,CAAC,SAAS;AAGlC,MAAI,MAAM,QAAQ;AAChB,SAAK,KAAK,QAAQ;AAClB,QAAI,CAAC,MAAM,cAAe,MAAK,KAAK,GAAG;AACvC,SAAK,KAAK,MAAM,MAAM;AAAA,EACxB;AAEA,OAAK,KAAK,GAAG;AACb,OAAK,KAAK,GAAG,MAAM;AAEnB,SAAO,MAAM,cAAc,EAAE,QAAQ,UAAU,CAAC;AAEhD,MAAI;AACF,UAAM,UAAU,MAAO,OAA2B,KAAK,GAAG,IAAI;AAC9D,WAAO,MAAM,uBAAuB,EAAE,QAAQ,WAAW,QAAQ,CAAC;AAAA,EACpE,SAAS,OAAO;AACd,WAAO,MAAM,qBAAqB;AAAA,MAChC,QAAQ;AAAA,MACR,OAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,IAC9D,CAAC;AAAA,EACH;AACF;AAEA,SAAS,aAAa,OAA0C;AAC9D,QAAM,SAAmB,CAAC;AAC1B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,WAAO;AAAA,MACL;AAAA,MACA,OAAO,UAAU,YAAY,UAAU,OACnC,KAAK,UAAU,KAAK,IACpB,OAAO,KAAK;AAAA,IAClB;AAAA,EACF;AACA,SAAO;AACT;;;AC3EA;;;ACcO,IAAM,mBAAgC;AAAA,EAC3C,MAAM;AAAA,EAEN,QAAQ,CAAC;AAAA,EAET,MAAM,KAAK,EAAE,QAAQ,eAAe,QAAQ,IAAI,GAAG;AAnBrD;AAoBI,UAAM,SAAS,UAAU,eAAe,MAAM;AAC9C,UAAM,WAAW,OAAO;AACxB,UAAM,QAAQ,SAAS;AAGvB,QAAI,MAAM,QAAS,QAAO;AAE1B,QAAI;AAGJ,QAAI,WAAW,GAAG,GAAG;AACnB,YAAM,WAAW;AACjB,qBAAc,cAAS,UAAT,mBAAgB;AAAA,IAChC;AAGA,QAAI,CAAC,aAAa;AAChB,UAAI;AAEF,cAAM,UAAU,UAAQ,SAAS;AAKjC,uBAAc,aAAQ,YAAR,YAAmB,QAAQ;AAAA,MAC3C,SAAS,KAAK;AACZ,eAAO,MAAM,2BAA2B,OAAO,GAAG,CAAC,EAAE;AACrD,eAAO;AAAA,MACT;AAAA,IACF;AAEA,QAAI,CAAC,aAAa;AAChB,aAAO,MAAM,+BAA+B;AAC5C,aAAO;AAAA,IACT;AAEA,QAAI;AACJ,QAAI,MAAM,KAAK;AACb,eAAS,IAAI,YAAY,MAAM,GAAG;AAAA,IACpC,OAAO;AACL,eAAS,IAAI,aAAY,WAAM,YAAN,YAAkB,CAAC,CAAwB;AAAA,IACtE;AAEA,UAAM,UAAU;AAChB,UAAM,eAAe;AAErB,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,KAAK,OAAO,SAAS;AACzB,WAAO,MAAM,KAAK,OAAO,OAAO;AAAA,EAClC;AAAA,EAEA,MAAM,QAAQ,EAAE,OAAO,GAAG;AACxB,UAAM,WAAW,iCAAQ;AACzB,UAAM,QAAQ,qCAAU;AACxB,QAAI,CAAC,MAAO;AAEZ,UAAM,SAAS,MAAM;AAErB,QAAI,UAAU,MAAM,cAAc;AAChC,UAAI;AACF,cAAM,OAAO,KAAK;AAAA,MACpB,UAAE;AACA,cAAM,UAAU;AAChB,cAAM,eAAe;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":[]}

package/dist/walkerOS.json

@@ -0,0 +1,611 @@
+{
+  "$meta": {
+    "package": "@walkeros/server-destination-redis",
+    "version": "3.4.0-next-1776749829492",
+    "type": "destination",
+    "platform": [
+      "server"
+    ],
+    "docs": "https://www.walkeros.io/docs/destinations/server/redis",
+    "source": "https://github.com/elbwalker/walkerOS/tree/main/packages/server/destinations/redis/src"
+  },
+  "schemas": {
+    "mapping": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "streamKey": {
+          "description": "Override Redis stream key for this rule. Takes precedence over settings.redis.streamKey.",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "redis": {
+          "type": "object",
+          "properties": {
+            "streamKey": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Redis stream key name (like 'walkeros:events'). All events are appended to this stream via XADD."
+            },
+            "url": {
+              "type": "string",
+              "description": "Redis connection URL (like 'redis://localhost:6379' or 'rediss://:password@host:6380'). Supports redis:// and rediss:// (TLS) protocols."
+            },
+            "options": {
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {},
+              "description": "ioredis connection options. Used when url is not provided. Supports host, port, password, db, tls, and all other ioredis options."
+            },
+            "maxLen": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Maximum stream length. Enables approximate MAXLEN trimming on every XADD to bound memory usage (like 50000)."
+            },
+            "exactTrimming": {
+              "type": "boolean",
+              "description": "Use exact MAXLEN instead of approximate (~). Not recommended for production. Default: false."
+            },
+            "serialization": {
+              "type": "string",
+              "enum": [
+                "json",
+                "flat"
+              ],
+              "description": "Serialization mode. 'json' stores the full event as a single 'event' field (default). 'flat' stores top-level event fields as separate stream entry fields."
+            }
+          },
+          "required": [
+            "streamKey"
+          ],
+          "additionalProperties": false,
+          "description": "Redis Streams configuration (like { streamKey: 'walkeros:events', url: 'redis://localhost:6379' })"
+        }
+      },
+      "required": [
+        "redis"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "examples": {
+    "env": {
+      "push": {
+        "Redis": {
+          "Client": {
+            "$code": "class{constructor(e){this.xadd=v,this.quit=u}pipeline(){return function(){const e={xadd:()=>e,exec:()=>Promise.resolve([])};return e}()}on(){return this}}"
+          }
+        }
+      },
+      "simulation": [
+        "call:client.xadd"
+      ]
+    },
+    "step": {
+      "ignoredEvent": {
+        "in": {
+          "name": "debug noise",
+          "data": {
+            "string": "foo",
+            "number": 1,
+            "boolean": true,
+            "array": [
+              0,
+              "text",
+              false
+            ]
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "lang": "elb"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000105-gr0up-1",
+          "trigger": "test",
+          "entity": "debug",
+          "action": "noise",
+          "timestamp": 1700000105,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "ignore": true
+        },
+        "out": []
+      },
+      "jsonDefault": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000100-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000100,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          [
+            "client.xadd",
+            [
+              "walkeros:events",
+              "*",
+              "event",
+              "json:event"
+            ]
+          ]
+        ]
+      },
+      "orderComplete": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "ORD-400",
+            "total": 99.99,
+            "currency": "EUR"
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000101-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000101,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "out": [
+          [
+            "client.xadd",
+            [
+              "walkeros:events",
+              "*",
+              "event",
+              "json:event"
+            ]
+          ]
+        ]
+      },
+      "streamKeyOverride": {
+        "in": {
+          "name": "order complete",
+          "data": {
+            "id": "ORD-500",
+            "total": 42
+          },
+          "context": {
+            "shopping": [
+              "complete",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "product",
+              "data": {
+                "id": "ers",
+                "name": "Everyday Ruck Snack",
+                "color": "black",
+                "size": "l",
+                "price": 420
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "product",
+              "data": {
+                "id": "cc",
+                "name": "Cool Cap",
+                "size": "one size",
+                "price": 42
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            },
+            {
+              "entity": "gift",
+              "data": {
+                "name": "Surprise"
+              },
+              "context": {
+                "shopping": [
+                  "complete",
+                  0
+                ]
+              },
+              "nested": []
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000104-gr0up-1",
+          "trigger": "load",
+          "entity": "order",
+          "action": "complete",
+          "timestamp": 1700000104,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "mapping": {
+          "settings": {
+            "streamKey": "walkeros:orders"
+          }
+        },
+        "out": [
+          [
+            "client.xadd",
+            [
+              "walkeros:orders",
+              "*",
+              "event",
+              "json:event"
+            ]
+          ]
+        ]
+      },
+      "withExactTrim": {
+        "in": {
+          "name": "page view",
+          "data": {
+            "domain": "www.example.com",
+            "title": "walkerOS documentation",
+            "referrer": "https://www.walkeros.io/",
+            "search": "?foo=bar",
+            "hash": "#hash",
+            "id": "/docs/"
+          },
+          "context": {
+            "dev": [
+              "test",
+              1
+            ]
+          },
+          "globals": {
+            "pagegroup": "docs"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [
+            {
+              "entity": "child",
+              "data": {
+                "is": "subordinated"
+              },
+              "nested": [],
+              "context": {
+                "element": [
+                  "child",
+                  0
+                ]
+              }
+            }
+          ],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000103-gr0up-1",
+          "trigger": "load",
+          "entity": "page",
+          "action": "view",
+          "timestamp": 1700000103,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "redis": {
+            "streamKey": "walkeros:events",
+            "maxLen": 5000,
+            "exactTrimming": true
+          }
+        },
+        "out": [
+          [
+            "client.xadd",
+            [
+              "walkeros:events",
+              "MAXLEN",
+              5000,
+              "*",
+              "event",
+              "json:event"
+            ]
+          ]
+        ]
+      },
+      "withMaxLen": {
+        "in": {
+          "name": "product view",
+          "data": {
+            "id": "SKU-123",
+            "name": "Widget"
+          },
+          "context": {
+            "shopping": [
+              "detail",
+              0
+            ]
+          },
+          "globals": {
+            "pagegroup": "shop"
+          },
+          "custom": {
+            "completely": "random"
+          },
+          "user": {
+            "id": "us3r",
+            "device": "c00k13",
+            "session": "s3ss10n"
+          },
+          "nested": [],
+          "consent": {
+            "functional": true
+          },
+          "id": "1700000102-gr0up-1",
+          "trigger": "load",
+          "entity": "product",
+          "action": "view",
+          "timestamp": 1700000102,
+          "timing": 3.14,
+          "group": "gr0up",
+          "count": 1,
+          "version": {
+            "source": "3.4.0-next-1776749829492",
+            "tagging": 1
+          },
+          "source": {
+            "type": "web",
+            "id": "https://localhost:80",
+            "previous_id": "http://remotehost:9001"
+          }
+        },
+        "settings": {
+          "redis": {
+            "streamKey": "walkeros:events",
+            "maxLen": 50000
+          }
+        },
+        "out": [
+          [
+            "client.xadd",
+            [
+              "walkeros:events",
+              "MAXLEN",
+              "~",
+              50000,
+              "*",
+              "event",
+              "json:event"
+            ]
+          ]
+        ]
+      }
+    }
+  }
+}