@gravito/echo 3.0.0 → 3.1.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/Application.d.ts

@@ -0,0 +1,215 @@
+/**
+ * @fileoverview Application - Enterprise Application Container
+ *
+ * A high-level application class that orchestrates the entire framework.
+ * Provides a centralized entry point for enterprise applications with
+ * auto-discovery of providers, config loading, and lifecycle management.
+ *
+ * @module @gravito/core
+ * @since 2.0.0
+ */
+import { ConfigManager } from './ConfigManager';
+import { Container } from './Container';
+import type { EventManager } from './EventManager';
+import type { Logger } from './Logger';
+import { PlanetCore } from './PlanetCore';
+import type { ServiceProvider } from './ServiceProvider';
+/**
+ * Application Config options for the Application class.
+ * @public
+ */
+export interface ApplicationConfig {
+    /**
+     * Base path of the application
+     */
+    basePath: string;
+    /**
+     * Path to the config directory (relative to basePath)
+     * @default 'config'
+     */
+    configPath?: string;
+    /**
+     * Path to the providers directory (relative to basePath)
+     * @default 'src/Providers'
+     */
+    providersPath?: string;
+    /**
+     * Environment (development, production, testing)
+     */
+    env?: 'development' | 'production' | 'testing';
+    /**
+     * Logger instance
+     */
+    logger?: Logger;
+    /**
+     * Initial configuration values
+     */
+    config?: Record<string, unknown>;
+    /**
+     * Service providers to register
+     */
+    providers?: ServiceProvider[];
+    /**
+     * Whether to auto-discover providers from providersPath
+     * @default true
+     */
+    autoDiscoverProviders?: boolean;
+}
+/**
+ * Application - Enterprise-grade application container.
+ *
+ * Provides a higher-level abstraction over PlanetCore for building
+ * enterprise applications with convention-over-configuration patterns.
+ *
+ * @example
+ * ```typescript
+ * // Create application
+ * const app = new Application({
+ *   basePath: import.meta.dir,
+ *   env: process.env.NODE_ENV as 'development' | 'production',
+ * });
+ *
+ * // Boot the application
+ * await app.boot();
+ *
+ * // Access core
+ * export default app.core.liftoff();
+ * ```
+ */
+export declare class Application {
+    /**
+     * The underlying PlanetCore instance.
+     */
+    readonly core: PlanetCore;
+    /**
+     * The IoC container.
+     */
+    readonly container: Container;
+    /**
+     * The configuration manager.
+     */
+    readonly config: ConfigManager;
+    /**
+     * The event manager.
+     */
+    readonly events: EventManager;
+    /**
+     * The logger instance.
+     */
+    readonly logger: Logger;
+    /**
+     * Application base path.
+     */
+    readonly basePath: string;
+    /**
+     * Environment mode.
+     */
+    readonly env: 'development' | 'production' | 'testing';
+    /**
+     * Configuration options.
+     */
+    private readonly options;
+    /**
+     * Whether the application has been booted.
+     */
+    private booted;
+    constructor(options: ApplicationConfig);
+    /**
+     * Boot the application and its dependencies.
+     *
+     * This method orchestrates the full application lifecycle:
+     * 1. Configuration: Loads all config files from the config directory.
+     * 2. Discovery: Auto-discovers ServiceProviders from the providers directory.
+     * 3. Registration: Registers all discovered and explicit providers.
+     * 4. Bootstrapping: Triggers the PlanetCore bootstrap sequence.
+     *
+     * @returns Promise that resolves to the application instance for chaining.
+     *
+     * @example
+     * ```typescript
+     * const app = new Application({ basePath: import.meta.dir });
+     * await app.boot();
+     * ```
+     */
+    boot(): Promise<this>;
+    /**
+     * Load configuration files from the config directory.
+     *
+     * @internal
+     */
+    private loadConfiguration;
+    /**
+     * Discover and register providers from the providers directory.
+     *
+     * @internal
+     */
+    private discoverProviders;
+    /**
+     * Resolve a service instance from the IoC container.
+     *
+     * This is a convenience wrapper around `container.make()`.
+     *
+     * @template T - The expected type of the service.
+     * @param key - The unique identifier or class name of the service.
+     * @returns The resolved service instance.
+     * @throws Error if the service is not bound in the container.
+     *
+     * @example
+     * ```typescript
+     * const db = app.make<Database>('db');
+     * ```
+     */
+    make<T>(key: string): T;
+    /**
+     * Check if a service is bound.
+     *
+     * @param key - The service key
+     * @returns True if bound
+     */
+    has(key: string): boolean;
+    /**
+     * Retrieve a configuration value using dot notation.
+     *
+     * @template T - The expected type of the configuration value.
+     * @param key - The configuration key (e.g., 'app.name', 'database.connections.mysql').
+     * @param defaultValue - Optional value to return if the key is not found.
+     * @returns The configuration value or the default value.
+     *
+     * @example
+     * ```typescript
+     * const port = app.getConfig<number>('app.port', 3000);
+     * ```
+     */
+    getConfig<T>(key: string, defaultValue?: T): T;
+    /**
+     * Resolve an absolute path relative to the application base path.
+     *
+     * @param segments - Path segments to join with the base path.
+     * @returns The absolute path string.
+     *
+     * @example
+     * ```typescript
+     * const storagePath = app.path('storage', 'logs');
+     * ```
+     */
+    path(...segments: string[]): string;
+    /**
+     * Get the config path.
+     *
+     * @param segments - Additional path segments
+     * @returns Absolute path to config directory
+     */
+    configPath(...segments: string[]): string;
+    /**
+     * Check if running in production.
+     */
+    isProduction(): boolean;
+    /**
+     * Check if running in development.
+     */
+    isDevelopment(): boolean;
+    /**
+     * Check if running in testing.
+     */
+    isTesting(): boolean;
+}

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/ConfigManager.d.ts

@@ -0,0 +1,26 @@
+/**
+ * ConfigManager - Central configuration store.
+ * Supports loading from environment variables and initial objects.
+ * @public
+ */
+export declare class ConfigManager {
+    private config;
+    constructor(initialConfig?: Record<string, unknown>);
+    /**
+     * Load all environment variables from the active runtime.
+     */
+    private loadEnv;
+    /**
+     * Get a configuration value (generic return type supported).
+     * Supports dot notation for deep access (e.g. 'app.name').
+     */
+    get<T = unknown>(key: string, defaultValue?: T): T;
+    /**
+     * Set a configuration value.
+     */
+    set(key: string, value: unknown): void;
+    /**
+     * Check whether a key exists.
+     */
+    has(key: string): boolean;
+}

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

@@ -0,0 +1,108 @@
+/**
+ * Factory type for creating service instances
+ */
+export type Factory<T> = (container: Container) => T;
+/**
+ * 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.
+ * @public
+ */
+export declare class Container {
+    private bindings;
+    private instances;
+    private resolutionStack;
+    /**
+     * Bind a service to the container.
+     *
+     * A new instance will be created by the factory function every time the
+     * service is resolved from the container.
+     *
+     * @template T - The type of the service being bound.
+     * @param key - The unique identifier for the service.
+     * @param factory - The factory function that creates the service instance.
+     *
+     * @example
+     * ```typescript
+     * container.bind('logger', (c) => new ConsoleLogger());
+     * ```
+     */
+    bind<T>(key: ServiceKey, factory: Factory<T>): void;
+    /**
+     * Bind a shared service to the container (Singleton).
+     *
+     * The factory function will be called only once, and the same instance
+     * will be returned on every subsequent resolution.
+     *
+     * @template T - The type of the service being bound.
+     * @param key - The unique identifier for the service.
+     * @param factory - The factory function that creates the service instance.
+     *
+     * @example
+     * ```typescript
+     * container.singleton('db', (c) => new DatabaseConnection());
+     * ```
+     */
+    singleton<T>(key: ServiceKey, factory: Factory<T>): void;
+    /**
+     * 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: ServiceKey, instance: T): void;
+    /**
+     * Resolve a service instance from the container.
+     *
+     * Automatically handles singleton caching and factory execution.
+     *
+     * @template T - The expected type of the service.
+     * @param key - The unique identifier for the service.
+     * @returns The resolved service instance.
+     * @throws Error if the service key is not found in the container.
+     *
+     * @example
+     * ```typescript
+     * const logger = container.make<Logger>('logger');
+     * ```
+     */
+    make<K extends keyof ServiceMap>(key: K): ServiceMap[K];
+    make<T>(key: ServiceKey): T;
+    /**
+     * 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: ServiceKey): boolean;
+    /**
+     * Flush all instances and bindings from the container.
+     * Resets the container to an empty state.
+     */
+    flush(): void;
+    /**
+     * Forget a specific instance while keeping its binding.
+     *
+     * @param key - The service key to forget.
+     */
+    forget(key: ServiceKey): void;
+}

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

@@ -0,0 +1,63 @@
+/**
+ * @fileoverview ErrorHandler - Centralized Error Handling for Gravito Framework
+ *
+ * Extracted from PlanetCore to follow Single Responsibility Principle.
+ * Handles HTTP errors, validation errors, and error rendering.
+ *
+ * @module @gravito/core
+ * @since 1.3.0
+ */
+import type { HookManager } from './HookManager';
+import type { GravitoContext } from './http/types';
+import type { Logger } from './Logger';
+/**
+ * HTTP Status Code to Error Code mapping
+ */
+export declare function codeFromStatus(status: number): string;
+/**
+ * HTTP Status Code to Message mapping
+ */
+export declare function messageFromStatus(status: number): string;
+/**
+ * Dependencies injected into ErrorHandler
+ * @public
+ */
+export interface ErrorHandlerDeps {
+    logger: Logger;
+    hooks: HookManager;
+    getCore: () => unknown;
+}
+/**
+ * ErrorHandler - Centralized error handling logic
+ *
+ * @example
+ * ```typescript
+ * const handler = new ErrorHandler({ logger, hooks, getCore: () => core })
+ * adapter.onError(handler.handleError.bind(handler))
+ * adapter.onNotFound(handler.handleNotFound.bind(handler))
+ * ```
+ */
+export declare class ErrorHandler {
+    private deps;
+    constructor(deps: ErrorHandlerDeps);
+    /**
+     * Handle application errors
+     */
+    handleError(err: unknown, c: GravitoContext): Promise<Response>;
+    /**
+     * Handle 404 Not Found errors
+     */
+    handleNotFound(c: GravitoContext): Promise<Response>;
+    /**
+     * Handle validation error redirect for HTML requests
+     */
+    private handleValidationRedirect;
+    /**
+     * Log error based on context settings
+     */
+    private logError;
+    /**
+     * Render error response (HTML or JSON)
+     */
+    private renderErrorResponse;
+}

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

@@ -0,0 +1,5 @@
+/**
+ * Event base class and related types.
+ */
+export type { Channel, ShouldBroadcast } from './types/events';
+export { Event } from './types/events';

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

@@ -0,0 +1,123 @@
+import { Event } from './Event';
+import type { Listener } from './Listener';
+import type { PlanetCore } from './PlanetCore';
+/**
+ * Listener registration metadata.
+ */
+interface ListenerRegistration<TEvent extends Event = Event> {
+    listener: Listener<TEvent> | (new () => Listener<TEvent>);
+    queue?: string;
+    connection?: string;
+    delay?: number;
+}
+/**
+ * Event manager.
+ *
+ * Provides type-safe event dispatching and listener registration.
+ * Supports both synchronous listeners and asynchronous (queued) listeners.
+ *
+ * @example
+ * ```typescript
+ * class UserRegistered extends Event {
+ *   constructor(public user: User) {
+ *     super()
+ *   }
+ * }
+ *
+ * class SendWelcomeEmail implements Listener<UserRegistered> {
+ *   async handle(event: UserRegistered): Promise<void> {
+ *     // send welcome email
+ *   }
+ * }
+ *
+ * // Register listener
+ * core.events.listen(UserRegistered, SendWelcomeEmail)
+ *
+ * // Dispatch event
+ * await core.events.dispatch(new UserRegistered(user))
+ * ```
+ */
+export declare class EventManager {
+    private core;
+    /**
+     * Listener registry.
+     * Key: event class or event name
+     * Value: listener registrations
+     */
+    private listeners;
+    /**
+     * Broadcast manager (optional, injected by `orbit-broadcasting`).
+     */
+    private broadcastManager;
+    /**
+     * Queue manager (optional, injected by `orbit-queue`).
+     */
+    private queueManager;
+    constructor(core: PlanetCore);
+    /**
+     * Register the broadcast manager (called by `orbit-broadcasting`).
+     */
+    setBroadcastManager(manager: EventManager['broadcastManager']): void;
+    /**
+     * Register the queue manager (called by `orbit-queue`).
+     */
+    setQueueManager(manager: EventManager['queueManager']): void;
+    /**
+     * Register an event listener.
+     *
+     * @param event - Event class or event name
+     * @param listener - Listener instance or listener class
+     * @param options - Optional queue options
+     *
+     * @example
+     * ```typescript
+     * // Synchronous listener
+     * core.events.listen(UserRegistered, SendWelcomeEmail)
+     *
+     * // Queued listener (async)
+     * core.events.listen(UserRegistered, SendWelcomeEmail, {
+     *   queue: 'emails',
+     *   delay: 60
+     * })
+     * ```
+     */
+    listen<TEvent extends Event>(event: string | (new (...args: unknown[]) => TEvent), listener: Listener<TEvent> | (new () => Listener<TEvent>), options?: {
+        queue?: string;
+        connection?: string;
+        delay?: number;
+    }): void;
+    /**
+     * Remove an event listener.
+     *
+     * @param event - Event class or event name
+     * @param listener - Listener to remove
+     */
+    unlisten<TEvent extends Event>(event: string | (new (...args: unknown[]) => TEvent), listener: Listener<TEvent> | (new () => Listener<TEvent>)): void;
+    /**
+     * Dispatch an event.
+     *
+     * Runs all registered listeners. If a listener implements `ShouldQueue` or
+     * has queue options, the listener will be pushed to the queue for async execution.
+     *
+     * @param event - Event instance
+     *
+     * @example
+     * ```typescript
+     * await core.events.dispatch(new UserRegistered(user))
+     * ```
+     */
+    dispatch<TEvent extends Event>(event: TEvent): Promise<void>;
+    /**
+     * Serialize an event (for queueing).
+     */
+    private serializeEvent;
+    /**
+     * Get all registered listeners.
+     */
+    getListeners(event?: string | (new () => Event)): ListenerRegistration[];
+    /**
+     * Clear all listeners.
+     */
+    clear(): void;
+}
+export {};

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

@@ -0,0 +1,47 @@
+import type { Logger } from './Logger';
+import type { PlanetCore } from './PlanetCore';
+/**
+ * Type of process-level error
+ * @public
+ */
+export type GlobalProcessErrorKind = 'unhandledRejection' | 'uncaughtException';
+/**
+ * Context payload for global error handler filters/actions
+ * @public
+ */
+export type GlobalProcessErrorHandlerContext = {
+    core?: PlanetCore;
+    kind: GlobalProcessErrorKind;
+    error: unknown;
+    isProduction: boolean;
+    timestamp: number;
+    logLevel?: 'error' | 'warn' | 'info' | 'none';
+    logMessage?: string;
+    exit?: boolean;
+    exitCode?: number;
+    gracePeriodMs?: number;
+};
+/**
+ * Error handling strategy
+ * @public
+ */
+export type GlobalErrorHandlersMode = 'log' | 'exit' | 'exitInProduction';
+/**
+ * Options for registering global handlers
+ * @public
+ */
+export type RegisterGlobalErrorHandlersOptions = {
+    core?: PlanetCore;
+    logger?: Logger;
+    mode?: GlobalErrorHandlersMode;
+    exitCode?: number;
+    gracePeriodMs?: number;
+};
+/**
+ * Register process-level error handlers (`unhandledRejection` / `uncaughtException`).
+ *
+ * - `mode: "log"`: only log/report
+ * - `mode: "exit"`: report then `process.exit(exitCode)`
+ * - `mode: "exitInProduction"`: exit only when `NODE_ENV=production` (default)
+ */
+export declare function registerGlobalErrorHandlers(options?: RegisterGlobalErrorHandlersOptions): () => void;

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

@@ -0,0 +1,28 @@
+import { type GravitoConfig, PlanetCore } from './PlanetCore';
+/**
+ * Manifest describing a Gravito application structure.
+ * @public
+ */
+export interface GravitoManifest {
+    name: string;
+    version?: string;
+    modules: string[];
+    config?: GravitoConfig;
+}
+/**
+ * Function type for asynchronous module resolution.
+ * @public
+ */
+export type ModuleResolver = () => Promise<any>;
+/**
+ * Gravito 核心啟動引擎 (已解耦)
+ */
+export declare class GravitoServer {
+    /**
+     * 一鍵建立並組裝伺服器
+     * @param manifest 站點描述清單
+     * @param resolvers 模組解析器字典
+     * @param baseOrbits 基礎軌道模組 (例如 OrbitMonolith)
+     */
+    static create(manifest: GravitoManifest, resolvers: Record<string, ModuleResolver>, baseOrbits?: any[]): Promise<PlanetCore>;
+}