@veloxts/core 0.1.0 → 0.2.0

package/dist/errors.js

@@ -1,294 +0,0 @@
-/**
- * Error handling foundation for VeloxTS framework
- * Provides base error classes with HTTP status codes and discriminated unions
- * @module errors
- */
-/**
- * Type guard for validation error responses
- */
-export function isValidationErrorResponse(response) {
-    return response.error === 'ValidationError';
-}
-/**
- * Type guard for not found error responses
- */
-export function isNotFoundErrorResponse(response) {
-    return response.error === 'NotFoundError';
-}
-// ============================================================================
-// Error Classes
-// ============================================================================
-/**
- * Base error class for all VeloxTS framework errors
- *
- * Extends the standard Error class with HTTP status code and optional error code.
- * All framework errors should extend this class for consistent error handling.
- *
- * @template TCode - The error code type (defaults to VeloxErrorCode)
- *
- * @example
- * ```typescript
- * throw new VeloxError('Something went wrong', 500);
- * ```
- *
- * @example
- * ```typescript
- * throw new VeloxError('Database connection failed', 503, 'DB_CONNECTION_ERROR');
- * ```
- */
-export class VeloxError extends Error {
-    /**
-     * HTTP status code for the error
-     */
-    statusCode;
-    /**
-     * Optional error code for programmatic error handling
-     */
-    code;
-    /**
-     * Creates a new VeloxError instance
-     *
-     * @param message - Human-readable error message
-     * @param statusCode - HTTP status code (default: 500)
-     * @param code - Optional error code for programmatic handling
-     */
-    constructor(message, statusCode = 500, code) {
-        super(message);
-        this.name = 'VeloxError';
-        this.statusCode = statusCode;
-        this.code = code;
-        // Maintains proper stack trace for where error was thrown (V8 only)
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, VeloxError);
-        }
-    }
-    /**
-     * Converts error to JSON format for API responses
-     *
-     * @returns Error response object
-     */
-    toJSON() {
-        return {
-            error: this.name,
-            message: this.message,
-            statusCode: this.statusCode,
-            code: this.code,
-        };
-    }
-}
-/**
- * Validation error for invalid user input
- *
- * Used when request data fails validation (e.g., missing required fields,
- * invalid format, type mismatches, etc.)
- *
- * @example
- * ```typescript
- * throw new ValidationError('Invalid email format', {
- *   email: 'Must be a valid email address'
- * });
- * ```
- *
- * @example
- * ```typescript
- * throw new ValidationError('Missing required fields', {
- *   name: 'Name is required',
- *   email: 'Email is required'
- * });
- * ```
- */
-export class ValidationError extends VeloxError {
-    /**
-     * Field-specific validation errors
-     * Maps field names to error messages
-     */
-    fields;
-    /**
-     * Creates a new ValidationError instance
-     *
-     * @param message - General validation error message
-     * @param fields - Optional object mapping field names to specific error messages
-     */
-    constructor(message, fields) {
-        super(message, 400, 'VALIDATION_ERROR');
-        this.name = 'ValidationError';
-        this.fields = fields;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, ValidationError);
-        }
-    }
-    /**
-     * Converts validation error to JSON format with field details
-     *
-     * @returns Validation error response with field-specific errors
-     */
-    toJSON() {
-        return {
-            error: 'ValidationError',
-            message: this.message,
-            statusCode: 400,
-            code: 'VALIDATION_ERROR',
-            fields: this.fields,
-        };
-    }
-}
-/**
- * Configuration error for framework setup issues
- *
- * Used when the framework is misconfigured or used incorrectly.
- * These errors indicate developer mistakes rather than runtime issues.
- *
- * @example
- * ```typescript
- * throw new ConfigurationError('VeloxApp must be started before registering routes');
- * ```
- *
- * @example
- * ```typescript
- * throw new ConfigurationError('Missing required plugin: @veloxts/orm');
- * ```
- */
-export class ConfigurationError extends VeloxError {
-    /**
-     * Creates a new ConfigurationError instance
-     *
-     * @param message - Human-readable error message explaining the configuration issue
-     */
-    constructor(message) {
-        super(message, 500, 'CONFIGURATION_ERROR');
-        this.name = 'ConfigurationError';
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, ConfigurationError);
-        }
-    }
-}
-/**
- * Not found error for missing resources
- *
- * Used when a requested resource (user, post, file, etc.) doesn't exist
- *
- * @example
- * ```typescript
- * throw new NotFoundError('User');
- * // Message: "User not found"
- * ```
- *
- * @example
- * ```typescript
- * throw new NotFoundError('Post', '123');
- * // Message: "Post with id 123 not found"
- * ```
- */
-export class NotFoundError extends VeloxError {
-    /**
-     * Type of resource that was not found
-     */
-    resource;
-    /**
-     * Optional identifier of the resource that was not found
-     */
-    resourceId;
-    /**
-     * Creates a new NotFoundError instance
-     *
-     * @param resource - Type of resource (e.g., "User", "Post", "File")
-     * @param resourceId - Optional identifier of the specific resource
-     */
-    constructor(resource, resourceId) {
-        const message = resourceId
-            ? `${resource} with id ${resourceId} not found`
-            : `${resource} not found`;
-        super(message, 404, 'NOT_FOUND');
-        this.name = 'NotFoundError';
-        this.resource = resource;
-        this.resourceId = resourceId;
-        if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, NotFoundError);
-        }
-    }
-    /**
-     * Converts not found error to JSON format with resource details
-     *
-     * @returns Not found error response with resource information
-     */
-    toJSON() {
-        return {
-            error: 'NotFoundError',
-            message: this.message,
-            statusCode: 404,
-            code: 'NOT_FOUND',
-            resource: this.resource,
-            resourceId: this.resourceId,
-        };
-    }
-}
-// ============================================================================
-// Type Guards
-// ============================================================================
-/**
- * Type guard to check if an error is a VeloxError
- *
- * @param error - Error to check
- * @returns true if error is a VeloxError instance
- *
- * @example
- * ```typescript
- * try {
- *   // ... some code
- * } catch (error) {
- *   if (isVeloxError(error)) {
- *     console.log('Status code:', error.statusCode);
- *   }
- * }
- * ```
- */
-export function isVeloxError(error) {
-    return error != null && error instanceof VeloxError;
-}
-/**
- * Type guard to check if an error is a ValidationError
- *
- * @param error - Error to check
- * @returns true if error is a ValidationError instance
- */
-export function isValidationError(error) {
-    return error instanceof ValidationError;
-}
-/**
- * Type guard to check if an error is a NotFoundError
- *
- * @param error - Error to check
- * @returns true if error is a NotFoundError instance
- */
-export function isNotFoundError(error) {
-    return error instanceof NotFoundError;
-}
-/**
- * Type guard to check if an error is a ConfigurationError
- *
- * @param error - Error to check
- * @returns true if error is a ConfigurationError instance
- */
-export function isConfigurationError(error) {
-    return error instanceof ConfigurationError;
-}
-// ============================================================================
-// Utility Types
-// ============================================================================
-/**
- * Helper to ensure exhaustive handling of error types
- * Throws at compile time if a case is not handled
- *
- * @example
- * ```typescript
- * function handleError(error: VeloxError): string {
- *   if (isValidationError(error)) return 'validation';
- *   if (isNotFoundError(error)) return 'not found';
- *   return 'generic';
- * }
- * ```
- */
-export function assertNever(value) {
-    throw new Error(`Unhandled value: ${JSON.stringify(value)}`);
-}
-//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA8GH;;GAEG;AACH,MAAM,UAAU,yBAAyB,CACvC,QAAuB;IAEvB,OAAO,QAAQ,CAAC,KAAK,KAAK,iBAAiB,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAuB;IAEvB,OAAO,QAAQ,CAAC,KAAK,KAAK,eAAe,CAAC;AAC5C,CAAC;AAED,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,UAA0C,SAAQ,KAAK;IAClE;;OAEG;IACa,UAAU,CAAS;IAEnC;;OAEG;IACa,IAAI,CAAS;IAE7B;;;;;;OAMG;IACH,YAAY,OAAe,EAAE,aAAqB,GAAG,EAAE,IAAY;QACjE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,oEAAoE;QACpE,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,IAAI;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,eAAgB,SAAQ,UAA8B;IACjE;;;OAGG;IACa,MAAM,CAA0B;IAEhD;;;;;OAKG;IACH,YAAY,OAAe,EAAE,MAA+B;QAC1D,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACM,MAAM;QACb,OAAO;YACL,KAAK,EAAE,iBAAiB;YACxB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,kBAAmB,SAAQ,UAAiC;IACvE;;;;OAIG;IACH,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,qBAAqB,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QAEjC,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAuB;IACxD;;OAEG;IACa,QAAQ,CAAS;IAEjC;;OAEG;IACa,UAAU,CAAU;IAEpC;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,UAAmB;QAC/C,MAAM,OAAO,GAAG,UAAU;YACxB,CAAC,CAAC,GAAG,QAAQ,YAAY,UAAU,YAAY;YAC/C,CAAC,CAAC,GAAG,QAAQ,YAAY,CAAC;QAE5B,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACM,MAAM;QACb,OAAO;YACL,KAAK,EAAE,eAAe;YACtB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,YAAY,UAAU,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,YAAY,eAAe,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,OAAO,KAAK,YAAY,aAAa,CAAC;AACxC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,KAAK,YAAY,kBAAkB,CAAC;AAC7C,CAAC;AAED,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY;IACtC,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/D,CAAC"}

package/dist/index.d.ts

@@ -1,28 +0,0 @@
-/**
- * @veloxts/core - Foundation package for the VeloxTS framework
- *
- * Provides the core Fastify wrapper, plugin system, and base context
- * that all other framework packages build upon.
- *
- * @example
- * ```typescript
- * import { createVeloxApp, definePlugin } from '@veloxts/core';
- *
- * const app = await createVeloxApp({ port: 3000 });
- * await app.start();
- * ```
- *
- * @module @veloxts/core
- */
-export declare const VELOX_VERSION: "0.1.0";
-export { createVeloxApp, VeloxApp } from './app.js';
-export type { BaseContext } from './context.js';
-export { createContext, isContext } from './context.js';
-export type { ErrorResponse, GenericErrorResponse, NotFoundErrorResponse, ValidationErrorResponse, VeloxCoreErrorCode, VeloxErrorCode, VeloxErrorCodeRegistry, } from './errors.js';
-export { assertNever, ConfigurationError, isConfigurationError, isNotFoundError, isNotFoundErrorResponse, isValidationError, isValidationErrorResponse, isVeloxError, NotFoundError, ValidationError, VeloxError, } from './errors.js';
-export type { InferPluginOptions, PluginMetadata, PluginOptions, VeloxPlugin } from './plugin.js';
-export { definePlugin, isVeloxPlugin, validatePluginMetadata } from './plugin.js';
-export type { AsyncHandler, JsonArray, JsonObject, JsonPrimitive, JsonValue, LifecycleHook, ShutdownHandler, SyncHandler, } from './types.js';
-export type { FrozenVeloxAppConfig, ValidHost, ValidPort, VeloxAppConfig, VeloxFastifyOptions, } from './utils/config.js';
-export { isValidHost, isValidPort } from './utils/config.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,eAAO,MAAM,aAAa,EAAG,OAAgB,CAAC;AAG9C,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpD,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAExD,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,sBAAsB,GACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAElG,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAElF,YAAY,EACV,YAAY,EACZ,SAAS,EACT,UAAU,EACV,aAAa,EACb,SAAS,EACT,aAAa,EACb,eAAe,EACf,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,YAAY,EACV,oBAAoB,EACpB,SAAS,EACT,SAAS,EACT,cAAc,EACd,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -1,26 +0,0 @@
-/**
- * @veloxts/core - Foundation package for the VeloxTS framework
- *
- * Provides the core Fastify wrapper, plugin system, and base context
- * that all other framework packages build upon.
- *
- * @example
- * ```typescript
- * import { createVeloxApp, definePlugin } from '@veloxts/core';
- *
- * const app = await createVeloxApp({ port: 3000 });
- * await app.start();
- * ```
- *
- * @module @veloxts/core
- */
-// Version constant
-export const VELOX_VERSION = '0.1.0';
-// App creation and types
-export { createVeloxApp, VeloxApp } from './app.js';
-export { createContext, isContext } from './context.js';
-export { assertNever, ConfigurationError, isConfigurationError, isNotFoundError, isNotFoundErrorResponse, isValidationError, isValidationErrorResponse, isVeloxError, NotFoundError, ValidationError, VeloxError, } from './errors.js';
-// Plugin system
-export { definePlugin, isVeloxPlugin, validatePluginMetadata } from './plugin.js';
-export { isValidHost, isValidPort } from './utils/config.js';
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,mBAAmB;AACnB,MAAM,CAAC,MAAM,aAAa,GAAG,OAAgB,CAAC;AAE9C,yBAAyB;AACzB,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAWxD,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,UAAU,GACX,MAAM,aAAa,CAAC;AAErB,gBAAgB;AAChB,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAoBlF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/plugin.d.ts

@@ -1,182 +0,0 @@
-/**
- * Plugin system for VeloxTS framework
- * Wraps Fastify's plugin architecture with metadata and validation
- * @module plugin
- */
-import type { FastifyPluginAsync, FastifyPluginOptions } from 'fastify';
-/**
- * Plugin options type
- * Generic record allowing plugins to define custom options
- */
-export type PluginOptions = FastifyPluginOptions;
-/**
- * Plugin metadata interface
- *
- * Provides information about the plugin for registration and dependency resolution
- */
-export interface PluginMetadata {
-    /**
-     * Unique plugin name
-     * Used for identification and dependency resolution
-     */
-    name: string;
-    /**
-     * Plugin version (semantic versioning recommended)
-     */
-    version: string;
-    /**
-     * Optional list of plugin names this plugin depends on
-     *
-     * Fastify handles the ordering - plugins listed here should be
-     * registered before this plugin
-     *
-     * @example
-     * ```typescript
-     * dependencies: ['@veloxts/orm', '@veloxts/validation']
-     * ```
-     */
-    dependencies?: string[];
-}
-/**
- * VeloxTS plugin definition
- *
- * Wraps a Fastify plugin with metadata for better developer experience
- *
- * @template Options - Type of options the plugin accepts
- *
- * @example
- * ```typescript
- * interface MyPluginOptions {
- *   apiKey: string;
- *   timeout?: number;
- * }
- *
- * const myPlugin: VeloxPlugin<MyPluginOptions> = {
- *   name: 'my-plugin',
- *   version: '1.0.0',
- *   async register(server, options) {
- *     // Plugin implementation
- *     server.get('/api', async () => {
- *       return { message: 'Hello from plugin' };
- *     });
- *   }
- * };
- * ```
- */
-export interface VeloxPlugin<Options extends PluginOptions = PluginOptions> extends PluginMetadata {
-    /**
-     * Plugin registration function
-     *
-     * Called when the plugin is registered with the VeloxTS app.
-     * This is a standard Fastify plugin function.
-     *
-     * @param server - Fastify server instance
-     * @param options - Plugin options provided during registration
-     */
-    register: FastifyPluginAsync<Options>;
-}
-/**
- * Defines a VeloxTS plugin with metadata and type-safe options
- *
- * This is a helper function that provides better TypeScript inference
- * and validates plugin metadata at definition time.
- *
- * @template Options - Type of options the plugin accepts
- * @param plugin - Plugin definition with metadata and register function
- * @returns The same plugin object with proper types
- *
- * @throws {VeloxError} If plugin metadata is invalid
- *
- * @example
- * ```typescript
- * export const databasePlugin = definePlugin({
- *   name: '@myapp/database',
- *   version: '1.0.0',
- *   dependencies: ['@veloxts/orm'],
- *   async register(server, options) {
- *     const db = await createDatabase(options.connectionString);
- *
- *     // Decorate server with database client
- *     server.decorate('db', db);
- *
- *     // Add shutdown hook
- *     server.addHook('onClose', async () => {
- *       await db.disconnect();
- *     });
- *   }
- * });
- * ```
- *
- * @example
- * ```typescript
- * // Plugin with typed options
- * interface AuthOptions {
- *   secret: string;
- *   expiresIn?: string;
- * }
- *
- * export const authPlugin = definePlugin<AuthOptions>({
- *   name: '@myapp/auth',
- *   version: '1.0.0',
- *   async register(server, options) {
- *     // options is properly typed as AuthOptions
- *     const { secret, expiresIn = '1h' } = options;
- *     // ... implementation
- *   }
- * });
- * ```
- */
-export declare function definePlugin<Options extends PluginOptions = PluginOptions>(plugin: VeloxPlugin<Options>): VeloxPlugin<Options>;
-/**
- * Validates plugin metadata
- *
- * @param plugin - Plugin to validate
- * @throws {VeloxError} If metadata is invalid
- *
- * @internal
- */
-export declare function validatePluginMetadata(plugin: Partial<PluginMetadata> & {
-    register?: unknown;
-}): void;
-/**
- * Type guard to check if a value is a valid VeloxPlugin
- *
- * Uses the `in` operator for safe property access without type assertions.
- *
- * @param value - Value to check
- * @returns true if value is a valid VeloxPlugin
- *
- * @example
- * ```typescript
- * if (isVeloxPlugin(someValue)) {
- *   console.log('Plugin name:', someValue.name);
- *   await app.register(someValue);
- * }
- * ```
- */
-export declare function isVeloxPlugin(value: unknown): value is VeloxPlugin;
-/**
- * Infers the options type from a VeloxPlugin
- *
- * Useful for extracting the options type when you have a plugin instance
- * and need to reference its options type elsewhere.
- *
- * @template T - Plugin type to extract options from
- *
- * @example
- * ```typescript
- * const myPlugin = definePlugin<{ apiKey: string }>({
- *   name: 'my-plugin',
- *   version: '1.0.0',
- *   async register(server, options) {
- *     // options is { apiKey: string }
- *   }
- * });
- *
- * // Extract the options type
- * type MyPluginOptions = InferPluginOptions<typeof myPlugin>;
- * // MyPluginOptions = { apiKey: string }
- * ```
- */
-export type InferPluginOptions<T> = T extends VeloxPlugin<infer O> ? O : never;
-//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAIxE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,oBAAoB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,cAAc;IAChG;;;;;;;;OAQG;IACH,QAAQ,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,wBAAgB,YAAY,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,EACxE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAC3B,WAAW,CAAC,OAAO,CAAC,CAKtB;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GACvD,IAAI,CAyCN;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAclE;AAMD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC"}

package/dist/plugin.js

@@ -1,121 +0,0 @@
-/**
- * Plugin system for VeloxTS framework
- * Wraps Fastify's plugin architecture with metadata and validation
- * @module plugin
- */
-import { VeloxError } from './errors.js';
-/**
- * Defines a VeloxTS plugin with metadata and type-safe options
- *
- * This is a helper function that provides better TypeScript inference
- * and validates plugin metadata at definition time.
- *
- * @template Options - Type of options the plugin accepts
- * @param plugin - Plugin definition with metadata and register function
- * @returns The same plugin object with proper types
- *
- * @throws {VeloxError} If plugin metadata is invalid
- *
- * @example
- * ```typescript
- * export const databasePlugin = definePlugin({
- *   name: '@myapp/database',
- *   version: '1.0.0',
- *   dependencies: ['@veloxts/orm'],
- *   async register(server, options) {
- *     const db = await createDatabase(options.connectionString);
- *
- *     // Decorate server with database client
- *     server.decorate('db', db);
- *
- *     // Add shutdown hook
- *     server.addHook('onClose', async () => {
- *       await db.disconnect();
- *     });
- *   }
- * });
- * ```
- *
- * @example
- * ```typescript
- * // Plugin with typed options
- * interface AuthOptions {
- *   secret: string;
- *   expiresIn?: string;
- * }
- *
- * export const authPlugin = definePlugin<AuthOptions>({
- *   name: '@myapp/auth',
- *   version: '1.0.0',
- *   async register(server, options) {
- *     // options is properly typed as AuthOptions
- *     const { secret, expiresIn = '1h' } = options;
- *     // ... implementation
- *   }
- * });
- * ```
- */
-export function definePlugin(plugin) {
-    // Validate plugin metadata
-    validatePluginMetadata(plugin);
-    return plugin;
-}
-/**
- * Validates plugin metadata
- *
- * @param plugin - Plugin to validate
- * @throws {VeloxError} If metadata is invalid
- *
- * @internal
- */
-export function validatePluginMetadata(plugin) {
-    if (!plugin.name || typeof plugin.name !== 'string' || plugin.name.trim() === '') {
-        throw new VeloxError('Plugin must have a non-empty name', 500, 'INVALID_PLUGIN_METADATA');
-    }
-    if (!plugin.version || typeof plugin.version !== 'string' || plugin.version.trim() === '') {
-        throw new VeloxError(`Plugin "${plugin.name}" must have a version`, 500, 'INVALID_PLUGIN_METADATA');
-    }
-    if (!plugin.register || typeof plugin.register !== 'function') {
-        throw new VeloxError(`Plugin "${plugin.name}" must have a register function`, 500, 'INVALID_PLUGIN_METADATA');
-    }
-    // Validate dependencies array if provided
-    if (plugin.dependencies !== undefined) {
-        if (!Array.isArray(plugin.dependencies)) {
-            throw new VeloxError(`Plugin "${plugin.name}" dependencies must be an array`, 500, 'INVALID_PLUGIN_METADATA');
-        }
-        for (const dep of plugin.dependencies) {
-            if (typeof dep !== 'string' || dep.trim() === '') {
-                throw new VeloxError(`Plugin "${plugin.name}" has invalid dependency: dependencies must be non-empty strings`, 500, 'INVALID_PLUGIN_METADATA');
-            }
-        }
-    }
-}
-/**
- * Type guard to check if a value is a valid VeloxPlugin
- *
- * Uses the `in` operator for safe property access without type assertions.
- *
- * @param value - Value to check
- * @returns true if value is a valid VeloxPlugin
- *
- * @example
- * ```typescript
- * if (isVeloxPlugin(someValue)) {
- *   console.log('Plugin name:', someValue.name);
- *   await app.register(someValue);
- * }
- * ```
- */
-export function isVeloxPlugin(value) {
-    if (typeof value !== 'object' || value === null) {
-        return false;
-    }
-    // Use 'in' operator for safe property access without type assertions
-    return ('name' in value &&
-        'version' in value &&
-        'register' in value &&
-        typeof value.name === 'string' &&
-        typeof value.version === 'string' &&
-        typeof value.register === 'function');
-}
-//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AA8EzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,UAAU,YAAY,CAC1B,MAA4B;IAE5B,2BAA2B;IAC3B,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAwD;IAExD,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjF,MAAM,IAAI,UAAU,CAAC,mCAAmC,EAAE,GAAG,EAAE,yBAAyB,CAAC,CAAC;IAC5F,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC1F,MAAM,IAAI,UAAU,CAClB,WAAW,MAAM,CAAC,IAAI,uBAAuB,EAC7C,GAAG,EACH,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC9D,MAAM,IAAI,UAAU,CAClB,WAAW,MAAM,CAAC,IAAI,iCAAiC,EACvD,GAAG,EACH,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,UAAU,CAClB,WAAW,MAAM,CAAC,IAAI,iCAAiC,EACvD,GAAG,EACH,yBAAyB,CAC1B,CAAC;QACJ,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACtC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACjD,MAAM,IAAI,UAAU,CAClB,WAAW,MAAM,CAAC,IAAI,kEAAkE,EACxF,GAAG,EACH,yBAAyB,CAC1B,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qEAAqE;IACrE,OAAO,CACL,MAAM,IAAI,KAAK;QACf,SAAS,IAAI,KAAK;QAClB,UAAU,IAAI,KAAK;QACnB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;QACjC,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,CACrC,CAAC;AACJ,CAAC"}