@gravito/ripple 3.1.0 → 4.0.0

package/dist/atlas/src/utils/levenshtein.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Calculate Levenshtein distance between two strings
+ * Used for "Did you mean?" suggestions
+ */
+export declare function levenshtein(a: string, b: string): number;
+/**
+ * Find similar strings from a list
+ */
+export declare function findSimilar(target: string, candidates: string[], maxDistance?: number, maxResults?: number): string[];

package/dist/core/src/CommandKernel.d.ts

@@ -0,0 +1,33 @@
+import type { Container } from './Container';
+/**
+ * CommandHandler type for custom CLI commands.
+ */
+export type CommandHandler = (args: string[], container: Container) => Promise<void> | void;
+/**
+ * CommandKernel - Structured CLI Command handling.
+ *
+ * Manages registration and execution of custom CLI commands that can
+ * reuse the application container and providers.
+ *
+ * @example
+ * ```typescript
+ * const kernel = new CommandKernel(container);
+ * kernel.register('greet', (args) => console.log('Hello', args[0]));
+ * await kernel.handle(['greet', 'Universe']);
+ * ```
+ */
+export declare class CommandKernel {
+    private container;
+    private commands;
+    constructor(container: Container);
+    /**
+     * Register a new command handler.
+     */
+    register(name: string, handler: CommandHandler): void;
+    /**
+     * Handle an incoming CLI command.
+     *
+     * @param argv - Array of command line arguments (e.g. process.argv.slice(2))
+     */
+    handle(argv: string[]): Promise<void>;
+}

package/dist/core/src/Container.d.ts

@@ -2,7 +2,26 @@
  * Factory type for creating service instances
  */
 export type Factory<T> = (container: Container) => T;
-export type BindingKey = string | symbol;
+/**
+ * ServiceMap interface for type-safe IoC resolution.
+ *
+ * Extend this interface via module augmentation to get type inference:
+ * @example
+ * ```typescript
+ * declare module '@gravito/core' {
+ *   interface ServiceMap {
+ *     logger: Logger
+ *     db: DatabaseConnection
+ *   }
+ * }
+ * ```
+ */
+export type ServiceMap = {};
+/**
+ * ServiceKey represents the allowed keys for service resolution.
+ * Includes keys from ServiceMap, generic strings, or symbols.
+ */
+export type ServiceKey = keyof ServiceMap | (string & {}) | symbol;
 /**
  * Container - Simple Dependency Injection Container.
  * Manages service bindings and singleton instances.
@@ -11,6 +30,7 @@ export type BindingKey = string | symbol;
 export declare class Container {
     private bindings;
     private instances;
+    private resolutionStack;
     /**
      * Bind a service to the container.
      *
@@ -26,7 +46,7 @@ export declare class Container {
      * container.bind('logger', (c) => new ConsoleLogger());
      * ```
      */
-    bind<T>(key: BindingKey, factory: Factory<T>): void;
+    bind<T>(key: ServiceKey, factory: Factory<T>): void;
     /**
      * Bind a shared service to the container (Singleton).
      *
@@ -42,11 +62,14 @@ export declare class Container {
      * container.singleton('db', (c) => new DatabaseConnection());
      * ```
      */
-    singleton<T>(key: BindingKey, factory: Factory<T>): void;
+    singleton<T>(key: ServiceKey, factory: Factory<T>): void;
     /**
-     * Register an existing instance as shared service.
+     * Register an existing instance as a shared service.
+     *
+     * @param key - The unique identifier for the service.
+     * @param instance - The instance to register.
      */
-    instance<T>(key: BindingKey, instance: T): void;
+    instance<T>(key: ServiceKey, instance: T): void;
     /**
      * Resolve a service instance from the container.
      *
@@ -62,17 +85,24 @@ export declare class Container {
      * const logger = container.make<Logger>('logger');
      * ```
      */
-    make<T>(key: BindingKey): T;
+    make<K extends keyof ServiceMap>(key: K): ServiceMap[K];
+    make<T>(key: ServiceKey): T;
     /**
-     * Check if a service is bound.
+     * Check if a service is bound or has an instance in the container.
+     *
+     * @param key - The service key to check.
+     * @returns True if the service exists.
      */
-    has(key: BindingKey): boolean;
+    has(key: ServiceKey): boolean;
     /**
-     * Flush all instances and bindings.
+     * Flush all instances and bindings from the container.
+     * Resets the container to an empty state.
      */
     flush(): void;
     /**
-     * Forget a specific instance (but keep binding)
+     * Forget a specific instance while keeping its binding.
+     *
+     * @param key - The service key to forget.
      */
-    forget(key: BindingKey): void;
+    forget(key: ServiceKey): void;
 }

package/dist/core/src/HookManager.d.ts

@@ -1,3 +1,10 @@
+import type { ConnectionContract } from '@gravito/atlas';
+import { type CircuitBreakerOptions } from './events/CircuitBreaker';
+import { DeadLetterQueue } from './events/DeadLetterQueue';
+import type { EventBackend } from './events/EventBackend';
+import type { EventOptions } from './events/EventOptions';
+import { EventPriorityQueue, type EventQueueConfig } from './events/EventPriorityQueue';
+import { DeadLetterQueueManager } from './reliability/DeadLetterQueueManager';
 /**
  * Callback function for filters (transforms values).
  * @public
@@ -9,12 +16,115 @@ export type FilterCallback<T = unknown> = (value: T, ...args: unknown[]) => Prom
  */
 export type ActionCallback<TArgs = unknown> = (args: TArgs) => Promise<void> | void;
 /**
- * Manager for WordPress-style hooks (actions and filters).
+ * Options for listener registration.
  * @public
  */
+export interface ListenerOptions {
+    /**
+     * Explicitly specify the listener type.
+     * - 'sync': Force synchronous dispatch for this listener
+     * - 'async': Force asynchronous dispatch for this listener
+     * - 'auto': Auto-detect based on function signature (default)
+     * @default 'auto'
+     */
+    type?: 'sync' | 'async' | 'auto';
+    /**
+     * Circuit breaker configuration for this listener.
+     */
+    circuitBreaker?: CircuitBreakerOptions;
+}
+/**
+ * Information about a registered listener.
+ * @public
+ */
+export interface ListenerInfo {
+    /**
+     * The callback function.
+     */
+    callback: ActionCallback;
+    /**
+     * Whether the listener is considered async.
+     */
+    isAsync: boolean;
+    /**
+     * The explicit type override, if any.
+     */
+    typeOverride?: 'sync' | 'async' | 'auto';
+}
+/**
+ * Configuration for HookManager.
+ * @public
+ */
+export interface HookManagerConfig {
+    /**
+     * Enable async event dispatch by default.
+     * When true, doAction() will automatically use async dispatch if any listener is async.
+     * @default false
+     */
+    asyncByDefault?: boolean;
+    /**
+     * Migration mode for backward compatibility.
+     * - 'sync': All events use synchronous dispatch (legacy mode)
+     * - 'hybrid': Auto-detect and use async for async listeners (recommended)
+     * - 'async': All events use async dispatch (future mode)
+     * @default 'sync'
+     */
+    migrationMode?: 'sync' | 'hybrid' | 'async';
+    /**
+     * Enable deprecation warnings for synchronous event dispatch.
+     * @default false
+     */
+    showDeprecationWarnings?: boolean;
+    /**
+     * Enable Dead Letter Queue for failed events.
+     * @default true
+     */
+    enableDLQ?: boolean;
+    /**
+     * Configuration for the event priority queue (Backpressure).
+     */
+    queue?: EventQueueConfig;
+    /**
+     * Custom event backend for distributed processing.
+     */
+    backend?: EventBackend;
+    /**
+     * Database connection for persistent DLQ (optional).
+     * If provided, failed events after max retries will be persisted to database.
+     */
+    db?: ConnectionContract;
+    /**
+     * Enable persistent DLQ for failed events (requires db).
+     * @default false
+     */
+    enablePersistentDLQ?: boolean;
+}
 export declare class HookManager {
     private filters;
     private actions;
+    private eventQueue;
+    private backend;
+    private dlq?;
+    private persistentDlqManager?;
+    private idempotencyCache;
+    private config;
+    private migrationWarner;
+    /**
+     * Cache for async detection results (WeakMap for automatic garbage collection).
+     * @internal
+     */
+    private asyncDetectionCache;
+    /**
+     * Count of items in the async detection cache (for testing/debugging).
+     * @internal
+     */
+    private asyncDetectionCacheCount;
+    /**
+     * Map of listener type overrides (callback -> type).
+     * @internal
+     */
+    private listenerTypeOverrides;
+    constructor(config?: HookManagerConfig);
     /**
      * Register a filter hook.
      *
@@ -59,26 +169,328 @@ export declare class HookManager {
      * @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
      * core.hooks.addAction('user_registered', async (user: User) => {
      *   await sendWelcomeEmail(user);
      * });
+     *
+     * // With explicit type override
+     * core.hooks.addAction('sync_handler', handler, { type: 'async' });
      * ```
      */
-    addAction<TArgs = unknown>(hook: string, callback: ActionCallback<TArgs>): void;
+    addAction<TArgs = unknown>(hook: string, callback: ActionCallback<TArgs>, options?: ListenerOptions): void;
     /**
-     * Run all registered actions sequentially.
+     * Run all registered actions.
+     *
+     * This method supports both synchronous and asynchronous dispatch based on configuration.
+     * In hybrid mode, it auto-detects async listeners and uses async dispatch.
      *
      * @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 - Optional event options for async dispatch.
      *
      * @example
      * ```typescript
      * await core.hooks.doAction('user_registered', user);
      * ```
      */
-    doAction<TArgs = unknown>(hook: string, args: TArgs): Promise<void>;
+    doAction<TArgs = unknown>(hook: string, args: TArgs, options?: EventOptions): Promise<void>;
+    /**
+     * 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.
+     * @internal
+     */
+    doActionSync<TArgs = unknown>(hook: string, args: TArgs): Promise<void>;
+    /**
+     * Run all registered actions asynchronously via priority queue.
+     *
+     * This method uses EventPriorityQueue for async dispatch with support for:
+     * - Priority-based processing (high > normal > low)
+     * - Timeout handling
+     * - Ordering guarantees (strict, partition, none)
+     * - Idempotency
+     *
+     * @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.
+     *
+     * @example
+     * ```typescript
+     * await core.hooks.doActionAsync('order:created', order, {
+     *   priority: 'high',
+     *   ordering: 'partition',
+     *   partitionKey: order.id,
+     *   timeout: 5000,
+     * });
+     * ```
+     */
+    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
+     * @internal
+     */
+    /**
+     * Determine the dispatch mode for an event.
+     *
+     * @param eventName - The name of the event
+     * @param options - Optional event options
+     * @returns The dispatch mode: 'sync' or 'async'
+     * @public
+     */
+    detectMode(eventName: string, options?: EventOptions): 'sync' | 'async';
+    /**
+     * 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;
+    /**
+     * Cache async detection result.
+     * @internal
+     */
+    private cacheAsyncResult;
+    /**
+     * Runtime detection for functions that return Promises but aren't declared async.
+     *
+     * This method executes the callback with test args and checks if the result is a Promise.
+     * Use with caution as it actually invokes the callback.
+     *
+     * @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
+     * @public
+     */
+    getAsyncDetectionCacheSize(): number;
+    /**
+     * Clear the async detection cache.
+     *
+     * @public
+     */
+    clearAsyncDetectionCache(): void;
+    /**
+     * Check if any listener for a hook is async (including type overrides).
+     *
+     * @param hook - Hook name
+     * @returns True if any listener is async
+     * @public
+     */
+    hasAsyncListeners(hook: string): 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
+     * @internal
+     */
+    private isListenerEffectivelyAsync;
+    /**
+     * Get detailed information about all listeners for a hook.
+     *
+     * @param hook - Hook name
+     * @returns Array of listener info objects
+     * @public
+     */
+    getListenerInfo(hook: string): ListenerInfo[];
+    private shouldUseAsyncDispatch;
+    /**
+     * Get the current event queue depth.
+     *
+     * @returns Total number of events in the queue
+     */
+    getQueueDepth(): number;
+    /**
+     * Get the event queue depth for a specific priority.
+     *
+     * @param priority - Priority level
+     * @returns Number of events in the specified priority queue
+     */
+    getQueueDepthByPriority(priority: 'high' | 'normal' | 'low'): number;
+    /**
+     * Get the EventPriorityQueue instance.
+     *
+     * @returns EventPriorityQueue instance
+     * @protected
+     */
+    protected getEventQueue(): EventPriorityQueue;
+    /**
+     * Get all registered listeners for a hook.
+     *
+     * @param hook - Hook name
+     * @returns Array of callbacks
+     * @internal
+     */
+    getListeners(hook: string): ActionCallback[];
+    /**
+     * Update HookManager configuration.
+     *
+     * @param config - New configuration
+     */
+    configure(config: Partial<HookManagerConfig>): void;
+    /**
+     * Get current configuration.
+     *
+     * @returns Current configuration
+     */
+    getConfig(): HookManagerConfig;
+    /**
+     * Suppress migration warnings for a specific event.
+     *
+     * @param eventName - The name of the event to suppress warnings for
+     * @public
+     */
+    suppressMigrationWarning(eventName: string): void;
+    /**
+     * Set the event backend for distributed processing.
+     *
+     * @param backend - Event backend instance
+     */
+    setBackend(backend: EventBackend): void;
+    /**
+     * Get the Dead Letter Queue instance.
+     *
+     * @returns Dead Letter Queue
+     */
+    getDLQ(): DeadLetterQueue | undefined;
+    /**
+     * Requeue a failed event from the Dead Letter Queue.
+     *
+     * @param dlqEntryId - DLQ entry ID
+     * @returns True if requeued successfully, false if entry not found
+     */
+    requeueDLQEntry(dlqEntryId: string): Promise<boolean>;
+    /**
+     * Requeue all failed events for a specific event name.
+     *
+     * @param eventName - Event name to requeue
+     * @returns Number of events requeued
+     */
+    requeueDLQBatch(eventName: string): Promise<number>;
+    /**
+     * Get Dead Letter Queue entries with optional filtering.
+     *
+     * @param filter - Filter options
+     * @returns Array of DLQ entries
+     */
+    getDLQEntries(filter?: {
+        eventName?: string;
+        from?: number;
+        to?: number;
+        limit?: number;
+    }): import("@gravito/core").DLQEntry[];
+    /**
+     * Get count of Dead Letter Queue entries for an event.
+     *
+     * @param eventName - Event name
+     * @returns Count of entries
+     */
+    getDLQCount(eventName: string): number;
+    /**
+     * Delete a DLQ entry.
+     *
+     * @param entryId - DLQ entry ID
+     * @returns True if deleted, false if not found
+     */
+    deleteDLQEntry(entryId: string): boolean;
+    /**
+     * Get circuit breaker statistics for all events.
+     *
+     * @returns Array of circuit breaker statistics
+     */
+    getCircuitBreakerStats(): Array<{
+        eventName: string;
+        state: string;
+        failureCount: number;
+        successCount: number;
+        lastFailureAt?: Date;
+        lastSuccessAt?: Date;
+        openedAt?: Date;
+        totalRequests: number;
+        totalFailures: number;
+        totalSuccesses: number;
+    }>;
+    /**
+     * Reset a circuit breaker for an event.
+     *
+     * @param eventName - Event name
+     * @returns True if reset, false if circuit breaker not found
+     */
+    resetCircuitBreaker(eventName: string): boolean;
+    /**
+     * Remove all listeners for a specific action hook.
+     *
+     * @param hook - Hook name
+     */
+    removeAction(hook: string): void;
+    /**
+     * Get the persistent DLQ manager instance.
+     *
+     * @returns DeadLetterQueueManager or undefined if not configured
+     * @public
+     */
+    getPersistentDLQManager(): DeadLetterQueueManager | undefined;
+    /**
+     * Create a handler function for persistent DLQ.
+     * This handler is used by EventPriorityQueue to persist failed events.
+     *
+     * @returns Handler function
+     * @internal
+     */
+    private createPersistentDLQHandler;
+    /**
+     * Requeue a failed event from the persistent DLQ.
+     *
+     * @param dlqId - DLQ entry UUID
+     * @returns True if requeued successfully
+     * @public
+     */
+    requeuePersistentDLQEntry(dlqId: string): Promise<boolean>;
+    /**
+     * Requeue multiple events from persistent DLQ.
+     *
+     * @param filter - Filter criteria
+     * @returns Result statistics
+     * @public
+     */
+    requeuePersistentDLQBatch(filter?: {
+        eventName?: string;
+        status?: 'pending' | 'requeued' | 'resolved' | 'abandoned';
+    }): Promise<{
+        total: number;
+        succeeded: number;
+        failed: number;
+    }>;
+    /**
+     * Get persistent DLQ statistics.
+     *
+     * @returns Statistics object with total, byEvent, and byStatus counts
+     * @public
+     */
+    getPersistentDLQStats(): Promise<import("@gravito/core").DLQStats | undefined>;
 }

package/dist/core/src/Router.d.ts

@@ -125,7 +125,7 @@ export declare class Router {
         path: string;
         domain?: string;
     }>;
-    private controllers;
+    private dispatcher;
     private namedRoutes;
     private bindings;
     /**
@@ -268,10 +268,6 @@ export declare class Router {
      * Internal Request Registration
      */
     req(method: HttpMethod, path: string, requestOrHandlerOrMiddleware: FormRequestClass | RouteHandler | GravitoMiddleware | GravitoMiddleware[], handler?: RouteHandler, options?: RouteOptions): Route;
-    /**
-     * Resolve Controller Instance and Method
-     */
-    private resolveControllerHandler;
 }
 /**
  * Standard RESTful resource action names.

package/dist/core/src/adapters/GravitoEngineAdapter.d.ts

@@ -23,4 +23,5 @@ export declare class GravitoEngineAdapter<V extends GravitoVariables = GravitoVa
     fetch: (request: Request, _server?: unknown) => Response | Promise<Response>;
     warmup(paths: string[]): Promise<void>;
     createContext(_request: Request): GravitoContext<V>;
+    useScoped(scope: string, path: string, ...middleware: GravitoMiddleware<V>[]): void;
 }

package/dist/core/src/adapters/PhotonAdapter.d.ts

@@ -136,6 +136,7 @@ export declare class PhotonAdapter<V extends GravitoVariables = GravitoVariables
     routes(routes: RouteDefinition[]): void;
     use(path: string, ...middleware: GravitoMiddleware<V>[]): void;
     useGlobal(...middleware: GravitoMiddleware<V>[]): void;
+    useScoped(scope: string, path: string, ...middleware: GravitoMiddleware<V>[]): void;
     mount(path: string, subAdapter: HttpAdapter<V>): void;
     onError(handler: GravitoErrorHandler<V>): void;
     onNotFound(handler: GravitoNotFoundHandler<V>): void;

package/dist/core/src/adapters/bun/BunNativeAdapter.d.ts

@@ -17,6 +17,7 @@ export declare class BunNativeAdapter implements HttpAdapter {
     routes(routes: RouteDefinition[]): void;
     use(path: string, ...middleware: GravitoMiddleware[]): void;
     useGlobal(...middleware: GravitoMiddleware[]): void;
+    useScoped(scope: string, path: string, ...middleware: GravitoMiddleware[]): void;
     mount(path: string, subAdapter: HttpAdapter): void;
     createContext(request: Request): GravitoContext;
     onError(handler: GravitoErrorHandler): void;

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

@@ -115,6 +115,33 @@ export interface HttpAdapter<V extends GravitoVariables = GravitoVariables> {
      * @param middleware - Middleware function
      */
     useGlobal(...middleware: GravitoMiddleware<V>[]): void;
+    /**
+     * Register a scoped middleware for Orbit-level isolation
+     *
+     * Unlike regular `use()`, this method enforces stricter scoping rules:
+     * - REJECTS '*' wildcard paths (prevents global middleware in Orbits)
+     * - ENFORCES that all middleware paths must include the scope prefix
+     * - Throws error if attempting to register global middleware within an Orbit scope
+     *
+     * This is designed to prevent accidental middleware cross-contamination
+     * when multiple Orbits are mounted to a single PlanetCore instance.
+     *
+     * @param scope - The scope/path prefix (e.g., '/api', '/blog')
+     * @param path - Path pattern to match (cannot be '*')
+     * @param middleware - One or more middleware functions
+     * @throws {Error} If path is '*' when in Orbit scope
+     * @since 2.3.0
+     *
+     * @example
+     * ```typescript
+     * // Correct: Scoped to specific path
+     * adapter.useScoped('/api', '/users/*', authMiddleware)
+     *
+     * // Error: Cannot use wildcard in Orbit scope
+     * adapter.useScoped('/api', '*', loggerMiddleware)
+     * ```
+     */
+    useScoped(scope: string, path: string, ...middleware: GravitoMiddleware<V>[]): void;
     /**
      * Mount a sub-adapter at a path
      *