node-honest 0.0.7 → 0.1.0

package/dist/interfaces/honest-options.interface.d.ts

@@ -1,121 +0,0 @@
-import type { Context } from 'hono';
-import type { VERSION_NEUTRAL } from '../constants';
-import type { FilterType, GuardType, ILogger, MiddlewareType, PipeType, PluginEntry } from '../interfaces';
-import type { DiContainer } from './di-container.interface';
-/**
- * Options for configuring the Honest application
- */
-export interface HonestOptions {
-    /**
-     * Emit actionable startup guidance when initialization fails.
-     * - `true` enables concise hints
-     * - object form enables verbose hints with additional context
-     */
-    startupGuide?: boolean | {
-        verbose?: boolean;
-    };
-    /**
-     * Enable debug logging for startup diagnostics.
-     * - `true` enables all debug logs
-     * - object form enables specific categories
-     */
-    debug?: boolean | {
-        routes?: boolean;
-        plugins?: boolean;
-        pipeline?: boolean;
-        di?: boolean;
-        startup?: boolean;
-    };
-    /**
-     * Optional logger for structured framework events.
-     */
-    logger?: ILogger;
-    /**
-     * Optional strict-mode checks for startup validation.
-     */
-    strict?: {
-        /**
-         * When enabled, startup fails if no routes were registered.
-         */
-        requireRoutes?: boolean;
-    };
-    /**
-     * Optional warnings for unstable/deprecated behavior.
-     */
-    deprecations?: {
-        /**
-         * Print pre-v1 instability warning during startup.
-         */
-        printPreV1Warning?: boolean;
-    };
-    /**
-     * Container instance for dependency injection
-     */
-    container?: DiContainer;
-    /**
-     * Hono-specific options
-     */
-    hono?: {
-        /**
-         * Whether to use strict matching for routes
-         */
-        strict?: boolean;
-        /**
-         * Custom router to use
-         */
-        router?: any;
-        /**
-         * Function to extract path from request
-         */
-        getPath?: (request: Request, options?: any) => string;
-    };
-    /**
-     * Global routing options
-     */
-    routing?: {
-        /**
-         * Global API prefix to apply to all routes (e.g. /api)
-         */
-        prefix?: string;
-        /**
-         * Global API version to apply to all routes (e.g. 1 becomes /v1)
-         * Set to VERSION_NEUTRAL to make routes accessible both with and without version prefix
-         * Set to an array of numbers to make routes available at multiple versions
-         */
-        version?: number | typeof VERSION_NEUTRAL | number[];
-    };
-    /**
-     * Global components to apply to all routes
-     */
-    components?: {
-        /**
-         * Global middleware to apply to all routes
-         */
-        middleware?: MiddlewareType[];
-        /**
-         * Global guards to apply to all routes
-         */
-        guards?: GuardType[];
-        /**
-         * Global pipes to apply to all routes
-         */
-        pipes?: PipeType[];
-        /**
-         * Global exception filters to apply to all routes
-         */
-        filters?: FilterType[];
-    };
-    /**
-     * Plugins for extending the application functionality.
-     * Each entry can be a plain plugin or an object with plugin and optional pre/post processors.
-     */
-    plugins?: PluginEntry[];
-    /**
-     * Default exception handler to use when no filter matches
-     */
-    onError?: (error: unknown, context: Context) => Response | Promise<Response>;
-    /**
-     * Default not found handler for routes that don't match any pattern
-     */
-    notFound?: (context: Context) => Response | Promise<Response>;
-}

package/dist/interfaces/honest-options.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/http-method-options.interface.d.ts

@@ -1,38 +0,0 @@
-import type { VERSION_NEUTRAL } from '../constants';
-/**
- * Options for HTTP method decorators (@Get, @Post, @Put, @Delete, etc.)
- *
- * @example
- * ```typescript
- * @Get('users', { prefix: 'api', version: 2 })
- * getUsers() {
- *   // ...
- * }
- * ```
- */
-export interface HttpMethodOptions {
-    /**
-     * Optional prefix for this specific route, overrides controller and global prefix.
-     * Set to null to explicitly remove any prefix for this route.
-     *
-     * @example
-     * ```typescript
-     * @Get('users', { prefix: 'api' })     // -> /api/users
-     * @Get('users', { prefix: null })      // -> /users (no prefix)
-     * @Get('users', { prefix: 'v2/api' })  // -> /v2/api/users
-     * ```
-     */
-    prefix?: string | null;
-    /**
-     * API version for this specific route, overrides controller and global version.
-     *
-     * @example
-     * ```typescript
-     * @Get('users', { version: 1 })           // -> /v1/users
-     * @Get('users', { version: null })        // -> /users (no version)
-     * @Get('users', { version: VERSION_NEUTRAL }) // -> Both /users and /v1/users
-     * @Get('users', { version: [1, 2] })     // -> Both /v1/users and /v2/users
-     * ```
-     */
-    version?: number | null | typeof VERSION_NEUTRAL | number[];
-}

package/dist/interfaces/http-method-options.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/index.d.ts

@@ -1,21 +0,0 @@
-export * from './application-context.interface';
-export * from './controller-options.interface';
-export * from './di-container.interface';
-export * from './logger.interface';
-export * from './error-response.interface';
-export * from './filter.interface';
-export * from './guard.interface';
-export * from './handler-invocation.interface';
-export * from './honest-options.interface';
-export * from './http-method-options.interface';
-export * from './metadata-repository.interface';
-export * from './middleware.interface';
-export * from './module-options.interface';
-export * from './parameter-metadata.interface';
-export * from './parameter-resolution.interface';
-export * from './pipeline-context.interface';
-export * from './pipe.interface';
-export * from './plugin.interface';
-export * from './route-definition.interface';
-export * from './route-info.interface';
-export * from './service-registry.interface';

package/dist/interfaces/index.js

@@ -1,21 +0,0 @@
-export * from './application-context.interface';
-export * from './controller-options.interface';
-export * from './di-container.interface';
-export * from './logger.interface';
-export * from './error-response.interface';
-export * from './filter.interface';
-export * from './guard.interface';
-export * from './handler-invocation.interface';
-export * from './honest-options.interface';
-export * from './http-method-options.interface';
-export * from './metadata-repository.interface';
-export * from './middleware.interface';
-export * from './module-options.interface';
-export * from './parameter-metadata.interface';
-export * from './parameter-resolution.interface';
-export * from './pipeline-context.interface';
-export * from './pipe.interface';
-export * from './plugin.interface';
-export * from './route-definition.interface';
-export * from './route-info.interface';
-export * from './service-registry.interface';

package/dist/interfaces/logger.interface.d.ts

@@ -1,23 +0,0 @@
-/**
- * Log level.
- */
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-/**
- * Log category used to filter or route events.
- */
-export type LogCategory = 'startup' | 'routes' | 'plugins' | 'deprecations' | 'pipeline' | 'di' | 'errors';
-/**
- * Structured log event emitted by Honest runtime components.
- */
-export interface LogEvent {
-    level: LogLevel;
-    category: LogCategory;
-    message: string;
-    details?: Record<string, unknown>;
-}
-/**
- * Logger contract.
- */
-export interface ILogger {
-    emit(event: LogEvent): void;
-}

package/dist/interfaces/logger.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/metadata-repository.interface.d.ts

@@ -1,30 +0,0 @@
-import type { ControllerOptions } from './controller-options.interface';
-import type { FilterType } from './filter.interface';
-import type { GuardType } from './guard.interface';
-import type { MiddlewareType } from './middleware.interface';
-import type { ModuleOptions } from './module-options.interface';
-import type { ParameterMetadata } from './parameter-metadata.interface';
-import type { PipeType } from './pipe.interface';
-import type { RouteDefinition } from './route-definition.interface';
-import type { Constructor } from '../types';
-export type MetadataComponentType = 'middleware' | 'guard' | 'pipe' | 'filter';
-export interface MetadataComponentTypeMap {
-    middleware: MiddlewareType;
-    guard: GuardType;
-    pipe: PipeType;
-    filter: FilterType;
-}
-/**
- * Runtime metadata access contract used by framework managers.
- */
-export interface IMetadataRepository {
-    hasController(controller: Constructor): boolean;
-    getControllerPath(controller: Constructor): string;
-    getControllerOptions(controller: Constructor): ControllerOptions;
-    getRoutes(controller: Constructor): RouteDefinition[];
-    getParameters(controller: Constructor): Map<string | symbol, ParameterMetadata[]>;
-    getContextIndices(controller: Constructor): Map<string | symbol, number>;
-    getModuleOptions(module: Constructor): ModuleOptions | undefined;
-    getControllerComponents<T extends MetadataComponentType>(type: T, controller: Constructor): MetadataComponentTypeMap[T][];
-    getHandlerComponents<T extends MetadataComponentType>(type: T, controller: Constructor, handlerName: string | symbol): MetadataComponentTypeMap[T][];
-}

package/dist/interfaces/metadata-repository.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/middleware.interface.d.ts

@@ -1,22 +0,0 @@
-import type { Context, Next } from 'hono';
-import type { Constructor } from '../types';
-/**
- * Interface for HTTP middleware components
- * Middleware can process requests before they reach the route handler
- * and modify both the request and response
- */
-export interface IMiddleware {
-    /**
-     * Processes an HTTP request/response
-     * @param c - The Hono context containing request and response information
-     * @param next - Function to call the next middleware in the chain
-     * @returns A Promise that resolves to a Response or void
-     * @throws {Error} If middleware processing fails
-     */
-    use(c: Context, next: Next): Promise<Response | void>;
-}
-/**
- * Type for middleware implementations
- * Can be either a class implementing IMiddleware or an instance of IMiddleware
- */
-export type MiddlewareType = Constructor<IMiddleware> | IMiddleware;

package/dist/interfaces/middleware.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/module-options.interface.d.ts

@@ -1,18 +0,0 @@
-import type { Constructor } from '../types';
-/**
- * Options for configuring a module
- */
-export interface ModuleOptions {
-    /**
-     * List of controller classes
-     */
-    controllers?: Constructor[];
-    /**
-     * List of service classes
-     */
-    services?: Constructor[];
-    /**
-     * List of imported modules
-     */
-    imports?: Constructor[];
-}

package/dist/interfaces/module-options.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/parameter-metadata.interface.d.ts

@@ -1,27 +0,0 @@
-import type { Constructor } from '../types';
-import type { Context } from 'hono';
-/**
- * Metadata for route parameters
- */
-export interface ParameterMetadata {
-    /**
-     * Parameter index
-     */
-    index: number;
-    /**
-     * Parameter name (body, param, query, etc.)
-     */
-    name: string;
-    /**
-     * Additional parameter data (e.g., param name)
-     */
-    data?: unknown;
-    /**
-     * Optional factory function to transform the data
-     */
-    factory: (data: unknown, ctx: Context) => unknown | Promise<unknown>;
-    /**
-     * The class type of the parameter
-     */
-    metatype?: Constructor<unknown>;
-}

package/dist/interfaces/parameter-metadata.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/parameter-resolution.interface.d.ts

@@ -1,14 +0,0 @@
-import type { Context } from 'hono';
-import type { IPipe } from './pipe.interface';
-import type { ParameterMetadata } from './parameter-metadata.interface';
-/**
- * Input contract for route-parameter resolution.
- */
-export interface ParameterResolutionInput {
-    controllerName: string;
-    handlerName: string | symbol;
-    handlerArity: number;
-    handlerParams: ReadonlyArray<ParameterMetadata>;
-    handlerPipes: ReadonlyArray<IPipe>;
-    context: Context;
-}

package/dist/interfaces/parameter-resolution.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/pipe.interface.d.ts

@@ -1,37 +0,0 @@
-import type { Constructor } from '../types';
-/**
- * Metadata about an argument being processed by a pipe
- */
-export interface ArgumentMetadata {
-    /**
-     * The type of argument (body, query, param, header, request, response, context, variable, or custom)
-     */
-    type: 'body' | 'query' | 'param' | 'header' | 'request' | 'response' | 'context' | 'variable' | string;
-    /**
-     * The class type of the argument
-     */
-    metatype?: Constructor<unknown>;
-    /**
-     * Additional data about the argument
-     */
-    data?: string;
-}
-/**
- * Interface for transformation pipes
- * Pipes transform input data before it reaches the route handler
- */
-export interface IPipe {
-    /**
-     * Transforms the input value according to the pipe's logic
-     * @param value - The value to transform
-     * @param metadata - Metadata about the argument being transformed
-     * @returns The transformed value, which can be synchronous or asynchronous
-     * @throws {Error} If the transformation fails or validation fails
-     */
-    transform(value: unknown, metadata: ArgumentMetadata): Promise<unknown> | unknown;
-}
-/**
- * Type for pipe implementations
- * Can be either a class implementing IPipe or an instance of IPipe
- */
-export type PipeType = Constructor<IPipe> | IPipe;

package/dist/interfaces/pipe.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/pipeline-context.interface.d.ts

@@ -1,9 +0,0 @@
-import type { Constructor } from '../types';
-/**
- * Request-scoped keys used by the framework pipeline.
- */
-export interface PipelineContextValues {
-    controllerClass?: Constructor;
-    handlerName?: string;
-    bodyCache?: unknown;
-}

package/dist/interfaces/pipeline-context.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/plugin.interface.d.ts

@@ -1,74 +0,0 @@
-import type { Hono } from 'hono';
-import type { Application } from '../application';
-import type { IApplicationContext } from './application-context.interface';
-import type { ILogger } from './logger.interface';
-import type { Constructor } from '../types';
-/**
- * Processor callback for plugin pre/post hooks.
- * Receives app, hono, and the application context (registry) for sharing pipeline data.
- */
-export type PluginProcessor = (app: Application, hono: Hono, ctx: IApplicationContext) => void | Promise<void>;
-/**
- * Optional metadata for plugin diagnostics.
- */
-export interface PluginMeta {
-    /**
-     * Stable plugin name used for diagnostics.
-     */
-    name?: string;
-}
-/**
- * Object form of a plugin entry with optional pre/post processors.
- * Processors run before (pre) or after (post) the plugin's lifecycle hooks.
- */
-export interface PluginEntryObject {
-    plugin: IPlugin | Constructor<IPlugin>;
-    /**
-     * Optional stable plugin name for diagnostics.
-     * Takes precedence over plugin.meta.name.
-     */
-    name?: string;
-    preProcessors?: PluginProcessor[];
-    postProcessors?: PluginProcessor[];
-}
-/**
- * Interface for Honest framework plugins
- * Plugins can extend the framework's functionality by hooking into
- * different stages of the application lifecycle
- */
-export interface IPlugin {
-    /**
-     * Optional metadata for plugin diagnostics.
-     */
-    meta?: PluginMeta;
-    /**
-     * Application logger, injected by the framework before lifecycle hooks run.
-     * Use this to emit structured log events from within plugin code.
-     */
-    logger?: ILogger;
-    /**
-     * Hook that runs before module registration begins.
-     * Use this to set up plugin functionality that modules might depend on.
-     * @param app - The Honest application instance
-     * @param hono - The underlying Hono application instance
-     */
-    beforeModulesRegistered?: (app: Application, hono: Hono) => void | Promise<void>;
-    /**
-     * Hook that runs after all modules have been registered.
-     * Use this to perform cleanup or setup that requires all modules to be ready.
-     * @param app - The Honest application instance
-     * @param hono - The underlying Hono application instance
-     */
-    afterModulesRegistered?: (app: Application, hono: Hono) => void | Promise<void>;
-}
-/**
- * Type for plugin implementations
- * Can be either a class implementing IPlugin or an instance of IPlugin
- */
-export type PluginType = Constructor<IPlugin> | IPlugin;
-/**
- * Plugin entry: either a plain plugin or an object wrapping a plugin with optional processors.
- * Use the object form to attach preProcessors (run before lifecycle hooks) and postProcessors
- * (run after). Processors receive (app, hono, ctx) where ctx is the application context.
- */
-export type PluginEntry = PluginType | PluginEntryObject;

package/dist/interfaces/plugin.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/route-definition.interface.d.ts

@@ -1,51 +0,0 @@
-import type { VERSION_NEUTRAL } from '../constants';
-/**
- * Internal metadata for defining a route. This interface is used by the framework
- * to store route information collected from decorators.
- *
- * @example
- * ```typescript
- * // Internal representation of:
- * @Controller('users')
- * class UsersController {
- *   @Get(':id')
- *   getUser(@Param('id') id: string) {}
- * }
- * ```
- */
-export interface RouteDefinition {
-    /**
-     * Route path relative to the controller's base path.
-     * Supports path parameters using colon syntax.
-     *
-     * @example ':id' | 'users/:userId/posts/:postId' | ''
-     */
-    path: string;
-    /**
-     * HTTP method for the route (GET, POST, PUT, DELETE, etc.)
-     */
-    method: string;
-    /**
-     * Name of the method in the controller class that handles this route
-     */
-    handlerName: string | symbol;
-    /**
-     * Route-specific API version, overrides controller and global version.
-     *
-     * @example
-     * ```typescript
-     * version: 1              // -> /v1/...
-     * version: null          // -> /... (no version)
-     * version: VERSION_NEUTRAL // -> Both /... and /v1/...
-     * version: [1, 2]       // -> Both /v1/... and /v2/...
-     * ```
-     */
-    version?: number | null | typeof VERSION_NEUTRAL | number[];
-    /**
-     * Route-specific prefix that overrides controller and global prefix.
-     * Set to null to explicitly remove any prefix.
-     *
-     * @example 'api' | 'v2/api' | null
-     */
-    prefix?: string | null;
-}

package/dist/interfaces/route-definition.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/route-info.interface.d.ts

@@ -1,42 +0,0 @@
-import type { ParameterMetadata } from './parameter-metadata.interface';
-/**
- * Route information for registered routes
- */
-export interface RouteInfo {
-    /**
-     * Controller name
-     */
-    controller: string | symbol;
-    /**
-     * Handler method name
-     */
-    handler: string | symbol;
-    /**
-     * HTTP method
-     */
-    method: string;
-    /**
-     * Effective prefix
-     */
-    prefix: string;
-    /**
-     * Effective version
-     */
-    version?: string;
-    /**
-     * Controller route path
-     */
-    route: string;
-    /**
-     * Method path
-     */
-    path: string;
-    /**
-     * Complete path (prefix + version + route + path)
-     */
-    fullPath: string;
-    /**
-     * Parameter metadata for the handler
-     */
-    parameters: ParameterMetadata[];
-}

package/dist/interfaces/route-info.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/interfaces/service-registry.interface.d.ts

@@ -1,7 +0,0 @@
-import type { Constructor } from '../types';
-/**
- * Contract for checking whether classes are registered as injectable services.
- */
-export interface IServiceRegistry {
-    isService(service: Constructor): boolean;
-}

package/dist/interfaces/service-registry.interface.js

@@ -1 +0,0 @@
-export {};

package/dist/loggers/console.logger.d.ts

@@ -1,7 +0,0 @@
-import type { LogEvent, ILogger } from '../interfaces';
-/**
- * Default logger that writes structured events to console.
- */
-export declare class ConsoleLogger implements ILogger {
-    emit(event: LogEvent): void;
-}

package/dist/loggers/console.logger.js

@@ -1,21 +0,0 @@
-/**
- * Default logger that writes structured events to console.
- */
-export class ConsoleLogger {
-    emit(event) {
-        const prefix = `[HonestJS:${event.category}]`;
-        const payload = event.details ? [prefix, event.message, event.details] : [prefix, event.message];
-        switch (event.level) {
-            case 'debug':
-            case 'info':
-                console.info(...payload);
-                break;
-            case 'warn':
-                console.warn(...payload);
-                break;
-            case 'error':
-                console.error(...payload);
-                break;
-        }
-    }
-}

package/dist/loggers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './console.logger';
-export * from './noop.logger';

package/dist/loggers/index.js

@@ -1,2 +0,0 @@
-export * from './console.logger';
-export * from './noop.logger';

package/dist/loggers/noop.logger.d.ts

@@ -1,7 +0,0 @@
-import type { LogEvent, ILogger } from '../interfaces';
-/**
- * Logger implementation that intentionally does nothing.
- */
-export declare class NoopLogger implements ILogger {
-    emit(_event: LogEvent): void;
-}