ocpp-ws-io 2.1.7 → 2.1.8

package/dist/index-C0mn42-8.d.mts

@@ -0,0 +1,161 @@
+import { E as EventAdapterInterface } from './types-BZXEmDQ1.mjs';
+
+interface RedisLikeClient {
+    publish(channel: string, message: string): Promise<number | unknown | undefined>;
+    subscribe(channel: string, ...args: unknown[]): Promise<unknown | undefined>;
+    unsubscribe(channel: string, ...args: unknown[]): Promise<unknown | undefined>;
+    on?(event: "message", callback: (channel: string, message: string) => void): unknown;
+    disconnect?(): Promise<void> | void;
+    quit?(): Promise<unknown> | undefined;
+    isOpen?: boolean;
+}
+interface StreamMessage {
+    id: string;
+    data: Record<string, string>;
+}
+interface StreamEntry {
+    stream: string;
+    messages: StreamMessage[];
+}
+interface RedisPubSubDriver {
+    publish(channel: string, message: string): Promise<void>;
+    subscribe(channel: string, handler: (message: string) => void): Promise<void>;
+    unsubscribe(channel: string): Promise<void>;
+    disconnect(): Promise<void>;
+    set(key: string, value: string, ttlSeconds?: number): Promise<void>;
+    get(key: string): Promise<string | null>;
+    mget(keys: string[]): Promise<(string | null)[]>;
+    del(key: string): Promise<void>;
+    /**
+     * Batch set multiple presence keys with TTL in a single pipeline.
+     * Falls back to sequential sets if pipelining is unavailable.
+     */
+    setPresenceBatch(entries: {
+        key: string;
+        value: string;
+        ttlSeconds: number;
+    }[]): Promise<void>;
+    /**
+     * Set a TTL on an existing key (for ephemeral stream channel leases).
+     */
+    expire(key: string, ttlSeconds: number): Promise<void>;
+    /**
+     * Subscribe to connection error events for rehydration.
+     * Returns an unsubscribe function.
+     */
+    onError?(handler: (err: Error) => void): () => void;
+    /**
+     * Subscribe to reconnection events.
+     * Returns an unsubscribe function.
+     */
+    onReconnect?(handler: () => void): () => void;
+    xadd(stream: string, args: Record<string, string>, maxLen?: number): Promise<string>;
+    xaddBatch(messages: {
+        stream: string;
+        args: Record<string, string>;
+    }[], maxLen?: number): Promise<void>;
+    xread(streams: {
+        key: string;
+        id: string;
+    }[], count?: number, block?: number): Promise<StreamEntry[] | null>;
+    xlen(stream: string): Promise<number>;
+}
+
+interface RedisAdapterOptions {
+    /** Redis client for publishing */
+    pubClient: RedisLikeClient;
+    /** Redis client for subscribing (must be a separate connection) */
+    subClient: RedisLikeClient;
+    /** Redis client for blocking stream operations (recommended for reliability) */
+    blockingClient?: RedisLikeClient;
+    /** Optional key prefix for channels (default: 'ocpp-ws-io:') */
+    prefix?: string;
+    /** StreamMaxLen for trimming (default: 1000) */
+    streamMaxLen?: number;
+    /**
+     * TTL in seconds for ephemeral stream keys (default: 300).
+     * Prevents abandoned channel keys from leaking memory in Redis.
+     */
+    streamTtlSeconds?: number;
+    /**
+     * Presence TTL in seconds (default: 300).
+     * Used for batch presence heartbeat pipeline.
+     */
+    presenceTtlSeconds?: number;
+    /**
+     * Number of Redis connections to pool for write operations (default: 1).
+     * Higher values distribute load via round-robin, eliminating TCP head-of-line blocking.
+     * Pub/Sub subscriptions always use the primary driver (pool index 0).
+     * - `1` = current single-connection behavior (backward compatible)
+     * - `N` = round-robin across N connections for xadd/set/publish
+     *
+     * When poolSize > 1, additional pub/blocking clients are created by the factory.
+     * Provide `driverFactory` to control how additional drivers are created.
+     */
+    poolSize?: number;
+    /**
+     * Factory function to create additional driver instances for the pool.
+     * Each call should return a fresh, independent set of Redis connections.
+     * Required when `poolSize > 1`.
+     */
+    driverFactory?: () => RedisPubSubDriver;
+}
+/**
+ * Redis adapter for cross-process event distribution.
+ *
+ * Supports `ioredis` and `node-redis` (v4+).
+ * Uses Redis Streams for reliable unicast (node-to-node) and Pub/Sub for broadcast.
+ */
+declare class RedisAdapter implements EventAdapterInterface {
+    private _driver;
+    private _prefix;
+    private _streamMaxLen;
+    private _streamTtlSeconds;
+    private _presenceTtlSeconds;
+    private _handlers;
+    private _streamOffsets;
+    private _streams;
+    private _polling;
+    private _closed;
+    private _sequenceCounters;
+    private _unsubError?;
+    private _unsubReconnect?;
+    private _presenceCache;
+    private _driverPool;
+    private _nextPoolIndex;
+    constructor(options: RedisAdapterOptions);
+    /** Get the next driver from the pool (round-robin) */
+    private _getPoolDriver;
+    publish(channel: string, data: unknown): Promise<void>;
+    publishBatch(messages: {
+        channel: string;
+        data: unknown;
+    }[]): Promise<void>;
+    subscribe(channel: string, handler: (data: unknown) => void): Promise<void>;
+    unsubscribe(channel: string): Promise<void>;
+    disconnect(): Promise<void>;
+    private _handleMessage;
+    private _ensurePolling;
+    private _pollLoop;
+    setPresence(identity: string, nodeId: string, ttl: number): Promise<void>;
+    getPresence(identity: string): Promise<string | null>;
+    getPresenceBatch(identities: string[]): Promise<(string | null)[]>;
+    removePresence(identity: string): Promise<void>;
+    metrics(): Promise<Record<string, unknown>>;
+    /**
+     * Set multiple presence entries in a single Redis pipeline.
+     * Reduces N network round-trips to 1 for bulk presence updates.
+     */
+    setPresenceBatch(entries: {
+        identity: string;
+        nodeId: string;
+        ttl?: number;
+    }[]): Promise<void>;
+    /**
+     * Re-syncs all cached presence entries to Redis after a reconnection.
+     * Called automatically when the Redis client reconnects.
+     */
+    private _rehydratePresence;
+}
+
+export { type RedisPubSubDriver as R, type StreamEntry as S, RedisAdapter as a, type RedisAdapterOptions as b };

package/dist/index-s9f97CmV.d.ts

@@ -0,0 +1,161 @@
+import { E as EventAdapterInterface } from './types-BZXEmDQ1.js';
+
+interface RedisLikeClient {
+    publish(channel: string, message: string): Promise<number | unknown | undefined>;
+    subscribe(channel: string, ...args: unknown[]): Promise<unknown | undefined>;
+    unsubscribe(channel: string, ...args: unknown[]): Promise<unknown | undefined>;
+    on?(event: "message", callback: (channel: string, message: string) => void): unknown;
+    disconnect?(): Promise<void> | void;
+    quit?(): Promise<unknown> | undefined;
+    isOpen?: boolean;
+}
+interface StreamMessage {
+    id: string;
+    data: Record<string, string>;
+}
+interface StreamEntry {
+    stream: string;
+    messages: StreamMessage[];
+}
+interface RedisPubSubDriver {
+    publish(channel: string, message: string): Promise<void>;
+    subscribe(channel: string, handler: (message: string) => void): Promise<void>;
+    unsubscribe(channel: string): Promise<void>;
+    disconnect(): Promise<void>;
+    set(key: string, value: string, ttlSeconds?: number): Promise<void>;
+    get(key: string): Promise<string | null>;
+    mget(keys: string[]): Promise<(string | null)[]>;
+    del(key: string): Promise<void>;
+    /**
+     * Batch set multiple presence keys with TTL in a single pipeline.
+     * Falls back to sequential sets if pipelining is unavailable.
+     */
+    setPresenceBatch(entries: {
+        key: string;
+        value: string;
+        ttlSeconds: number;
+    }[]): Promise<void>;
+    /**
+     * Set a TTL on an existing key (for ephemeral stream channel leases).
+     */
+    expire(key: string, ttlSeconds: number): Promise<void>;
+    /**
+     * Subscribe to connection error events for rehydration.
+     * Returns an unsubscribe function.
+     */
+    onError?(handler: (err: Error) => void): () => void;
+    /**
+     * Subscribe to reconnection events.
+     * Returns an unsubscribe function.
+     */
+    onReconnect?(handler: () => void): () => void;
+    xadd(stream: string, args: Record<string, string>, maxLen?: number): Promise<string>;
+    xaddBatch(messages: {
+        stream: string;
+        args: Record<string, string>;
+    }[], maxLen?: number): Promise<void>;
+    xread(streams: {
+        key: string;
+        id: string;
+    }[], count?: number, block?: number): Promise<StreamEntry[] | null>;
+    xlen(stream: string): Promise<number>;
+}
+
+interface RedisAdapterOptions {
+    /** Redis client for publishing */
+    pubClient: RedisLikeClient;
+    /** Redis client for subscribing (must be a separate connection) */
+    subClient: RedisLikeClient;
+    /** Redis client for blocking stream operations (recommended for reliability) */
+    blockingClient?: RedisLikeClient;
+    /** Optional key prefix for channels (default: 'ocpp-ws-io:') */
+    prefix?: string;
+    /** StreamMaxLen for trimming (default: 1000) */
+    streamMaxLen?: number;
+    /**
+     * TTL in seconds for ephemeral stream keys (default: 300).
+     * Prevents abandoned channel keys from leaking memory in Redis.
+     */
+    streamTtlSeconds?: number;
+    /**
+     * Presence TTL in seconds (default: 300).
+     * Used for batch presence heartbeat pipeline.
+     */
+    presenceTtlSeconds?: number;
+    /**
+     * Number of Redis connections to pool for write operations (default: 1).
+     * Higher values distribute load via round-robin, eliminating TCP head-of-line blocking.
+     * Pub/Sub subscriptions always use the primary driver (pool index 0).
+     * - `1` = current single-connection behavior (backward compatible)
+     * - `N` = round-robin across N connections for xadd/set/publish
+     *
+     * When poolSize > 1, additional pub/blocking clients are created by the factory.
+     * Provide `driverFactory` to control how additional drivers are created.
+     */
+    poolSize?: number;
+    /**
+     * Factory function to create additional driver instances for the pool.
+     * Each call should return a fresh, independent set of Redis connections.
+     * Required when `poolSize > 1`.
+     */
+    driverFactory?: () => RedisPubSubDriver;
+}
+/**
+ * Redis adapter for cross-process event distribution.
+ *
+ * Supports `ioredis` and `node-redis` (v4+).
+ * Uses Redis Streams for reliable unicast (node-to-node) and Pub/Sub for broadcast.
+ */
+declare class RedisAdapter implements EventAdapterInterface {
+    private _driver;
+    private _prefix;
+    private _streamMaxLen;
+    private _streamTtlSeconds;
+    private _presenceTtlSeconds;
+    private _handlers;
+    private _streamOffsets;
+    private _streams;
+    private _polling;
+    private _closed;
+    private _sequenceCounters;
+    private _unsubError?;
+    private _unsubReconnect?;
+    private _presenceCache;
+    private _driverPool;
+    private _nextPoolIndex;
+    constructor(options: RedisAdapterOptions);
+    /** Get the next driver from the pool (round-robin) */
+    private _getPoolDriver;
+    publish(channel: string, data: unknown): Promise<void>;
+    publishBatch(messages: {
+        channel: string;
+        data: unknown;
+    }[]): Promise<void>;
+    subscribe(channel: string, handler: (data: unknown) => void): Promise<void>;
+    unsubscribe(channel: string): Promise<void>;
+    disconnect(): Promise<void>;
+    private _handleMessage;
+    private _ensurePolling;
+    private _pollLoop;
+    setPresence(identity: string, nodeId: string, ttl: number): Promise<void>;
+    getPresence(identity: string): Promise<string | null>;
+    getPresenceBatch(identities: string[]): Promise<(string | null)[]>;
+    removePresence(identity: string): Promise<void>;
+    metrics(): Promise<Record<string, unknown>>;
+    /**
+     * Set multiple presence entries in a single Redis pipeline.
+     * Reduces N network round-trips to 1 for bulk presence updates.
+     */
+    setPresenceBatch(entries: {
+        identity: string;
+        nodeId: string;
+        ttl?: number;
+    }[]): Promise<void>;
+    /**
+     * Re-syncs all cached presence entries to Redis after a reconnection.
+     * Called automatically when the Redis client reconnects.
+     */
+    private _rehydratePresence;
+}
+
+export { type RedisPubSubDriver as R, type StreamEntry as S, RedisAdapter as a, type RedisAdapterOptions as b };