@gravito/ripple 4.0.1 → 4.0.3

package/dist/core/src/ffi/cbor-fallback.d.ts

@@ -0,0 +1,96 @@
+/**
+ * JavaScript CBOR 回退實現
+ * 用於非 Bun 環境或 FFI 不可用的情況
+ * 符合 RFC 7049 規範
+ */
+import type { CborAccelerator } from './types';
+/**
+ * CBOR 編碼器
+ * 將 JavaScript 物件編碼為 CBOR 二進制格式
+ */
+export declare class CborFallbackEncoder implements CborAccelerator {
+    private static readonly DEFAULT_BUFFER_SIZE;
+    private static readonly MAX_DEPTH;
+    private static readonly MAX_BUFFER_SIZE;
+    private buffer;
+    private offset;
+    constructor();
+    /**
+     * 編碼 JavaScript 物件為 CBOR 格式
+     */
+    encode(data: Record<string, unknown>): Uint8Array;
+    /**
+     * 解碼 CBOR 二進制為 JavaScript 物件
+     */
+    decode(bytes: Uint8Array): Record<string, unknown>;
+    /**
+     * 確保 buffer 有足夠空間
+     */
+    private ensureCapacity;
+    /**
+     * 編寫一個位元組
+     */
+    private writeByte;
+    /**
+     * 編寫多個位元組
+     */
+    private writeBytes;
+    /**
+     * 編寫 CBOR 長度（Major Type + Additional Info）
+     */
+    private writeLength;
+    /**
+     * 遞迴編碼值
+     */
+    private encodeValue;
+    /**
+     * 編碼整數或浮點數
+     * 對於超過 uint32 範圍的整數，使用 float64 編碼（JavaScript 精度限制）
+     */
+    private encodeNumber;
+    /**
+     * 編碼字串
+     */
+    private encodeString;
+    /**
+     * 編碼位元組陣列
+     */
+    private encodeBytes;
+    /**
+     * 編碼陣列
+     */
+    private encodeArray;
+    /**
+     * 編碼物件（Map）
+     */
+    private encodeMap;
+}
+/**
+ * CBOR 解碼器
+ */
+export declare class CborFallbackDecoder {
+    private static readonly MAX_DEPTH;
+    private data;
+    private offset;
+    constructor(data: Uint8Array);
+    /**
+     * 解碼 CBOR 資料
+     */
+    decode(): unknown;
+    /**
+     * 讀取一個位元組
+     */
+    private readByte;
+    /**
+     * 讀取固定長度的位元組
+     */
+    private readBytes;
+    /**
+     * 讀取 CBOR 長度
+     */
+    private readLength;
+    /**
+     * 遞迴解碼值
+     */
+    private decodeValue;
+}

package/dist/core/src/ffi/hash-fallback.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 雜湊加速器 JavaScript 回退實現
+ * 基於 node:crypto 標準庫
+ *
+ * 使用場景：
+ * - 非 Bun 環境（Node.js、Deno 等）
+ * - Bun CryptoHasher 不可用的情況
+ *
+ * 性能特性：
+ * - 短 key (<100 bytes)：~1-2x 慢於 Bun.CryptoHasher（N-API 橋接開銷）
+ * - 長 payload：差異較小（主要計算時間）
+ * - 一致性：與 node:crypto 標準行為完全相同
+ */
+import type { HashAccelerator } from './types';
+/**
+ * Node.js crypto 回退實現
+ * 適用於非 Bun 環境
+ */
+export declare class HashFallback implements HashAccelerator {
+    /**
+     * SHA-256 計算（回退實現）
+     * @param input - 輸入（字串或 Uint8Array）
+     * @returns 十六進制編碼的 SHA-256 雜湊值
+     */
+    sha256(input: string | Uint8Array): string;
+    /**
+     * HMAC-SHA256 計算（回退實現）
+     * @param key - 密鑰
+     * @param data - 要雜湊的數據
+     * @returns 十六進制編碼的 HMAC-SHA256 值
+     */
+    hmacSha256(key: string, data: string): string;
+}

package/dist/core/src/ffi/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * FFI (Foreign Function Interface) 模組導出
+ * 提供原生加速層支持（CBOR 編碼/解碼、雜湊計算）
+ */
+export { CborFallbackDecoder, CborFallbackEncoder } from './cbor-fallback';
+export { HashFallback } from './hash-fallback';
+export { NativeAccelerator } from './NativeAccelerator';
+export { NativeHasher } from './NativeHasher';
+export type { CborAccelerator, FfiConfig, HashAccelerator, NativeAcceleratorStatus, NativeHasherStatus, } from './types';
+export { CBOR_LENGTH_ENCODING, CBOR_MAJOR_TYPES, CBOR_SIMPLE_VALUES, } from './types';

package/dist/core/src/ffi/types.d.ts

@@ -0,0 +1,135 @@
+/**
+ * FFI (Foreign Function Interface) 類型定義
+ * 支持 bun:ffi 的原生加速層
+ */
+/**
+ * CBOR 編碼/解碼加速器介面
+ * 可由原生 C 實現或 JavaScript 回退實現
+ */
+export interface CborAccelerator {
+    /**
+     * 將任意 JavaScript 物件編碼為 CBOR 二進制格式
+     * @param data - 要編碼的物件（支援：map、string、uint、float64、bytes、null、boolean）
+     * @returns CBOR 編碼的二進制資料
+     */
+    encode(data: Record<string, unknown>): Uint8Array;
+    /**
+     * 將 CBOR 二進制格式解碼為 JavaScript 物件
+     * @param bytes - CBOR 編碼的二進制資料
+     * @returns 解碼後的物件
+     */
+    decode(bytes: Uint8Array): Record<string, unknown>;
+}
+/**
+ * FFI 加速層狀態報告
+ */
+export interface NativeAcceleratorStatus {
+    /**
+     * 原生 FFI 加速是否可用
+     */
+    readonly available: boolean;
+    /**
+     * 當前使用的運行時實現
+     * - 'bun-ffi': Bun C 編譯器（bun:ffi 的 cc()）
+     * - 'js-fallback': 手寫 JavaScript CBOR 實現
+     * - 'cborg': npm 的 cborg 套件（已棄用，僅用於向後相容）
+     */
+    readonly runtime: 'bun-ffi' | 'js-fallback' | 'cborg';
+    /**
+     * 運行時版本或詳細資訊
+     */
+    readonly version: string;
+}
+/**
+ * FFI 層配置選項
+ */
+export interface FfiConfig {
+    /**
+     * 啟用調試日誌
+     * @default false
+     */
+    readonly debug?: boolean;
+    /**
+     * 最大 buffer 大小（位元組）
+     * @default 1048576 (1MB)
+     */
+    readonly maxBufferSize?: number;
+    /**
+     * 強制使用特定的加速器實現
+     * - undefined: 自動選擇（優先 bun-ffi，降級到 js-fallback）
+     * - 'bun-ffi': 只使用原生 C 實現
+     * - 'js-fallback': 只使用 JavaScript 實現
+     */
+    readonly forceImplementation?: 'bun-ffi' | 'js-fallback';
+}
+/**
+ * CBOR Major Type 常數
+ * 符合 RFC 7049 規範
+ */
+export declare const CBOR_MAJOR_TYPES: {
+    readonly UINT: 0;
+    readonly NEGINT: 1;
+    readonly BYTES: 2;
+    readonly TEXT: 3;
+    readonly ARRAY: 4;
+    readonly MAP: 5;
+    readonly TAG: 6;
+    readonly SIMPLE: 7;
+};
+/**
+ * CBOR 簡單值常數
+ */
+export declare const CBOR_SIMPLE_VALUES: {
+    readonly FALSE: 20;
+    readonly TRUE: 21;
+    readonly NULL: 22;
+    readonly UNDEFINED: 23;
+};
+/**
+ * CBOR 長度編碼的附加資訊
+ */
+export declare const CBOR_LENGTH_ENCODING: {
+    readonly SMALL_RANGE_END: 23;
+    readonly UINT8: 24;
+    readonly UINT16: 25;
+    readonly UINT32: 26;
+    readonly UINT64: 27;
+    readonly FLOAT16: 25;
+    readonly FLOAT32: 26;
+    readonly FLOAT64: 27;
+    readonly INDEFINITE: 31;
+};
+/**
+ * 雜湊加速器介面
+ * 可由 Bun 原生實現或 Node.js 回退實現
+ */
+export interface HashAccelerator {
+    /**
+     * SHA-256 雜湊計算
+     * @param input - 輸入（字串或二進制）
+     * @returns 十六進制編碼的 SHA-256 雜湊值（64 字元）
+     */
+    sha256(input: string | Uint8Array): string;
+    /**
+     * HMAC-SHA256 計算
+     * @param key - 密鑰
+     * @param data - 要雜湊的數據
+     * @returns 十六進制編碼的 HMAC-SHA256 值（64 字元）
+     */
+    hmacSha256(key: string, data: string): string;
+}
+/**
+ * 雜湊加速器狀態報告
+ */
+export interface NativeHasherStatus {
+    /**
+     * 雜湊加速層是否可用
+     */
+    readonly available: boolean;
+    /**
+     * 當前使用的運行時實現
+     * - 'bun-crypto-hasher': Bun 原生 CryptoHasher（C 實現，推薦）
+     * - 'node-crypto': node:crypto 回退實現
+     */
+    readonly runtime: 'bun-crypto-hasher' | 'node-crypto';
+}

package/dist/core/src/helpers/Str.d.ts

@@ -18,6 +18,21 @@ export declare const Str: {
     readonly limit: (value: string, limit: number, end?: string) => string;
     readonly slug: (value: string, separator?: string) => string;
     readonly uuid: () => string;
+    /**
+     * 生成 UUID v7（單調遞增，內含時間戳）。
+     *
+     * Bun 環境使用原生 Bun.randomUUIDv7() (C++ 實作)。
+     * Node.js/Deno 環境使用 RFC 9562 的 JavaScript polyfill。
+     *
+     * UUID v7 的優勢：
+     * - 資料庫主鍵天然有序 → B-tree 索引性能提升 2-10x
+     * - 可從 UUID 提取毫秒級時間戳
+     * - 仍保持全域唯一性
+     *
+     * @returns UUID v7 字串
+     * @public
+     */
+    readonly uuidv7: () => string;
     readonly random: (length?: number) => string;
 };
 export {};

package/dist/core/src/hooks/ActionManager.d.ts

@@ -0,0 +1,132 @@
+import type { EventBackend } from '../events/EventBackend';
+import type { EventOptions } from '../events/EventOptions';
+import type { AsyncDetector } from './AsyncDetector';
+import type { MigrationWarner } from './MigrationWarner';
+import type { ActionCallback, HookManagerConfig, ListenerInfo, ListenerOptions } from './types';
+/**
+ * 管理 action hook 的登記與執行。
+ *
+ * Action hook 用於觸發副作用（例如發送 email、記錄日誌）。
+ * 支援同步和非同步執行模式，以及透過 EventPriorityQueue 的優先級佇列處理。
+ *
+ * @internal
+ */
+export declare class ActionManager {
+    /**
+     * 儲存所有已登記的 action callbacks。
+     */
+    private actions;
+    private backend;
+    private idempotencyCache;
+    private config;
+    private asyncDetector;
+    private migrationWarner;
+    private aggregationManager?;
+    constructor(backend: EventBackend, config: HookManagerConfig, asyncDetector: AsyncDetector, migrationWarner: MigrationWarner);
+    /**
+     * 更新設定。
+     */
+    updateConfig(config: HookManagerConfig): void;
+    /**
+     * 更新 backend。
+     */
+    setBackend(backend: EventBackend): void;
+    /**
+     * Register an action hook.
+     *
+     * Actions are used to trigger side effects (e.g., logging, sending emails)
+     * at specific points in the application lifecycle.
+     *
+     * @template TArgs - The type of arguments passed to the action.
+     * @param hook - The unique name of the hook.
+     * @param callback - The callback function to execute.
+     * @param options - Optional listener options (type override, circuit breaker).
+     *
+     * @example
+     * ```typescript
+     * actionManager.addAction('user_registered', async (user: User) => {
+     *   await sendWelcomeEmail(user)
+     * })
+     * ```
+     */
+    addAction<TArgs = unknown>(hook: string, callback: ActionCallback<TArgs>, options?: ListenerOptions): void;
+    /**
+     * 判斷是否需要使用非同步 dispatch，並在需要時發出遷移警告。
+     *
+     * 此方法僅判斷 dispatch 模式和發出警告，不執行實際的 dispatch。
+     * 實際執行由 HookManager.doAction 負責，以確保 ObservableHookManager 等子類別
+     * 的多型覆寫（override）能正確攔截 doActionSync / doActionAsync 呼叫。
+     *
+     * @param hook - Hook name
+     * @param args - Event args (unused here, kept for API consistency)
+     * @param options - Event options
+     * @returns 'async' if async dispatch should be used, 'sync' otherwise
+     */
+    resolveDispatchMode<TArgs = unknown>(hook: string, _args: TArgs, options?: EventOptions): 'async' | 'sync';
+    /**
+     * Run all registered actions synchronously (legacy mode).
+     *
+     * @template TArgs - The type of arguments passed to the action.
+     * @param hook - The name of the hook.
+     * @param args - The arguments to pass to the callbacks.
+     */
+    doActionSync<TArgs = unknown>(hook: string, args: TArgs): Promise<void>;
+    /**
+     * Run all registered actions asynchronously via priority queue.
+     *
+     * 透過 EventPriorityQueue 進行非同步 dispatch，支援：
+     * - 優先級處理（high > normal > low）
+     * - 超時處理
+     * - 順序保證（strict、partition、none）
+     * - 冪等性
+     *
+     * @template TArgs - The type of arguments passed to the action.
+     * @param hook - The name of the hook.
+     * @param args - The arguments to pass to the callbacks.
+     * @param options - Event options for async dispatch.
+     */
+    doActionAsync<TArgs = unknown>(hook: string, args: TArgs, options?: EventOptions): Promise<void>;
+    /**
+     * Determine if async dispatch should be used.
+     *
+     * @param callbacks - Callbacks to check
+     * @param options - Event options
+     * @returns True if async dispatch should be used
+     */
+    shouldUseAsyncDispatch(callbacks: ActionCallback[], options?: EventOptions): boolean;
+    /**
+     * Determine the dispatch mode for an event.
+     *
+     * @param hook - Hook name
+     * @param options - Optional event options
+     * @returns The dispatch mode: 'sync' or 'async'
+     */
+    detectMode(hook: string, options?: EventOptions): 'sync' | 'async';
+    /**
+     * Check if any listener for a hook is async (including type overrides).
+     *
+     * @param hook - Hook name
+     * @returns True if any listener is async
+     */
+    hasAsyncListeners(hook: string): boolean;
+    /**
+     * Get detailed information about all listeners for a hook.
+     *
+     * @param hook - Hook name
+     * @returns Array of listener info objects
+     */
+    getListenerInfo(hook: string): ListenerInfo[];
+    /**
+     * Get all registered listeners for a hook.
+     *
+     * @param hook - Hook name
+     * @returns Array of callbacks
+     */
+    getListeners(hook: string): ActionCallback[];
+    /**
+     * Remove all listeners for a specific action hook.
+     *
+     * @param hook - Hook name
+     */
+    removeAction(hook: string): void;
+}

package/dist/core/src/hooks/AsyncDetector.d.ts

@@ -0,0 +1,84 @@
+import type { ActionCallback } from './types';
+/**
+ * 負責偵測 callback 函數是否為非同步（async）。
+ *
+ * 提供靜態偵測（透過函數簽名）和運行時偵測（透過執行函數）兩種方式，
+ * 並包含快取機制以提升重複偵測的性能。
+ *
+ * @internal
+ */
+export declare class AsyncDetector {
+    /**
+     * 快取非同步偵測結果（WeakMap 以自動垃圾回收）。
+     */
+    private asyncDetectionCache;
+    /**
+     * 快取中的項目計數（供測試/偵錯使用）。
+     */
+    private asyncDetectionCacheCount;
+    /**
+     * 儲存 listener type override（callback -> type）。
+     */
+    private listenerTypeOverrides;
+    /**
+     * 設定 listener 的 type override。
+     *
+     * @param callback - 目標 callback
+     * @param type - Type override 值
+     */
+    setTypeOverride(callback: ActionCallback, type: 'sync' | 'async' | 'auto'): void;
+    /**
+     * 取得 listener 的 type override。
+     *
+     * @param callback - 目標 callback
+     * @returns Type override 或 undefined
+     */
+    getTypeOverride(callback: ActionCallback): 'sync' | 'async' | 'auto' | undefined;
+    /**
+     * Check if a callback is an async function (with caching).
+     *
+     * Detection methods:
+     * 1. Check cache first
+     * 2. Check type override
+     * 3. Check constructor.name === 'AsyncFunction'
+     * 4. Fallback: Check function string representation
+     *
+     * @param callback - The callback to check
+     * @returns True if the callback is async
+     * @public
+     */
+    isAsyncListener(callback: ActionCallback): boolean;
+    /**
+     * Check if a listener is effectively async (considering type override).
+     *
+     * @param callback - The callback to check
+     * @returns True if the listener should be treated as async
+     */
+    isEffectivelyAsync(callback: ActionCallback): boolean;
+    /**
+     * Runtime detection for functions that return Promises but aren't declared async.
+     *
+     * 此方法會實際執行 callback 來檢查是否回傳 Promise，請謹慎使用。
+     *
+     * @param callback - The callback to check
+     * @param testArgs - Arguments to pass to the callback for testing
+     * @returns True if the callback returns a Promise
+     * @public
+     */
+    isAsyncListenerRuntime<TArgs = unknown>(callback: ActionCallback<TArgs>, testArgs: TArgs): Promise<boolean>;
+    /**
+     * Get the size of the async detection cache (for testing/debugging).
+     *
+     * @returns Number of cached detection results
+     */
+    getCacheSize(): number;
+    /**
+     * Clear the async detection cache.
+     */
+    clearCache(): void;
+    /**
+     * 快取非同步偵測結果。
+     * @internal
+     */
+    private cacheResult;
+}

package/dist/core/src/hooks/FilterManager.d.ts

@@ -0,0 +1,71 @@
+import type { FilterCallback } from './types';
+/**
+ * 管理 filter hook 的登記與執行。
+ *
+ * Filter hook 用於轉換數值：每個 callback 接收前一個 callback 的回傳值，
+ * 並返回新的轉換後數值。所有 callback 按登記順序依次執行。
+ *
+ * @internal
+ */
+export declare class FilterManager {
+    /**
+     * 儲存所有已登記的 filter callbacks。
+     * Map key 為 hook 名稱，value 為 callback 陣列。
+     */
+    private filters;
+    /**
+     * Register a filter hook.
+     *
+     * Filters are used to transform a value (input/output) through a chain of
+     * callbacks. Each callback must return the modified value.
+     *
+     * @template T - The type of value being filtered.
+     * @param hook - The unique name of the hook.
+     * @param callback - The callback function to execute.
+     *
+     * @example
+     * ```typescript
+     * filterManager.addFilter('content', async (content: string) => {
+     *   return content.toUpperCase()
+     * })
+     * ```
+     */
+    addFilter<T = unknown>(hook: string, callback: FilterCallback<T>): void;
+    /**
+     * Apply all registered filters sequentially.
+     *
+     * Each callback receives the previous callback's return value.
+     *
+     * @template T - The type of value being filtered.
+     * @param hook - The name of the hook.
+     * @param initialValue - The initial value to filter.
+     * @param args - Additional arguments to pass to the callbacks.
+     * @returns The final filtered value.
+     *
+     * @example
+     * ```typescript
+     * const content = await filterManager.applyFilters('content', 'hello world')
+     * ```
+     */
+    applyFilters<T = unknown>(hook: string, initialValue: T, ...args: unknown[]): Promise<T>;
+    /**
+     * Check if any filters are registered for a hook.
+     *
+     * @param hook - Hook name
+     * @returns True if at least one filter is registered
+     */
+    hasFilters(hook: string): boolean;
+    /**
+     * Get count of registered filters for a hook.
+     *
+     * @param hook - Hook name
+     * @returns Number of registered filters
+     */
+    getFilterCount(hook: string): number;
+    /**
+     * Remove all filters for a specific hook.
+     *
+     * @param hook - Hook name
+     */
+    removeFilters(hook: string): void;
+}

package/dist/core/src/hooks/MigrationWarner.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Migration warning manager for deprecation warnings.
+ *
+ * 管理遷移警告訊息，支援透過環境變數抑制特定事件的警告。
+ *
+ * @internal
+ */
+export declare class MigrationWarner {
+    private suppressedWarnings;
+    constructor();
+    /**
+     * 發出遷移警告訊息。
+     *
+     * @param eventName - 事件名稱
+     * @param message - 警告訊息
+     */
+    warn(eventName: string, message: string): void;
+    /**
+     * 抑制特定事件的遷移警告。
+     *
+     * @param eventName - 要抑制警告的事件名稱
+     */
+    suppress(eventName: string): void;
+}

package/dist/core/src/hooks/dlq-operations.d.ts

@@ -0,0 +1,60 @@
+import type { DeadLetterQueue } from '../events/DeadLetterQueue';
+import type { EventOptions } from '../events/EventOptions';
+import type { DeadLetterQueueManager } from '../reliability/DeadLetterQueueManager';
+/**
+ * DLQ 操作輔助函式模組。
+ *
+ * 提取自 HookManager 的 DLQ 管理邏輯，以降低 HookManager 複雜度。
+ * 這些函式接受所需依賴作為參數，便於測試與重用。
+ *
+ * @internal
+ */
+/**
+ * 重新加入單一 DLQ 項目到事件佇列。
+ *
+ * @param dlqEntryId - DLQ 項目 ID
+ * @param dlq - 記憶體內 DLQ 實例
+ * @param requeue - 重新加入佇列的回調函式
+ * @returns 是否成功重新加入
+ */
+export declare function requeueDLQEntry(dlqEntryId: string, dlq: DeadLetterQueue, requeue: (eventName: string, payload: unknown, options: EventOptions) => Promise<void>): Promise<boolean>;
+/**
+ * 批次重新加入指定事件名稱的所有 DLQ 項目。
+ *
+ * @param eventName - 事件名稱
+ * @param dlq - 記憶體內 DLQ 實例
+ * @param requeue - 重新加入佇列的回調函式
+ * @returns 成功重新加入的項目數
+ */
+export declare function requeueDLQBatch(eventName: string, dlq: DeadLetterQueue, requeue: (entryId: string) => Promise<boolean>): Promise<number>;
+/**
+ * 建立 EventPriorityQueue 持久化 DLQ 處理器。
+ *
+ * @param persistentDlqManager - 持久化 DLQ 管理器
+ * @returns 持久化 DLQ 處理器函式
+ */
+export declare function createPersistentDLQHandler(persistentDlqManager: DeadLetterQueueManager): (hook: string, args: unknown, options: EventOptions, error: Error, retryCount: number, _firstFailedAt: number) => Promise<void>;
+/**
+ * 重新加入持久化 DLQ 單一項目到事件佇列。
+ *
+ * @param dlqId - 持久化 DLQ 項目 UUID
+ * @param persistentDlqManager - 持久化 DLQ 管理器
+ * @param doActionAsync - 重新加入佇列的回調函式
+ * @returns 是否成功重新加入
+ */
+export declare function requeuePersistentDLQEntry(dlqId: string, persistentDlqManager: DeadLetterQueueManager, doActionAsync: (event: string, args: unknown, options: EventOptions) => Promise<void>): Promise<boolean>;
+/**
+ * 批次重新加入持久化 DLQ 項目。
+ *
+ * @param filter - 過濾條件
+ * @param persistentDlqManager - 持久化 DLQ 管理器
+ * @returns 批次操作結果統計
+ */
+export declare function requeuePersistentDLQBatch(filter: {
+    eventName?: string;
+    status?: 'pending' | 'requeued' | 'resolved' | 'abandoned';
+} | undefined, persistentDlqManager: DeadLetterQueueManager): Promise<{
+    total: number;
+    succeeded: number;
+    failed: number;
+}>;