@veloxts/core 0.7.1 → 0.7.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @veloxts/core
 
+## 0.7.3
+
+### Patch Changes
+
+- feat(cli): auto-populate Zod schemas from Prisma model fields
+
+## 0.7.2
+
+### Patch Changes
+
+- fix(core): type error handler generic as Error to fix IDE null warning
+- chore(core): mark `velox` as deprecated in favor of `veloxApp`
+- simplify code for clarity and maintainability
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/app.d.ts

@@ -79,20 +79,12 @@ export declare class VeloxApp {
      */
     get address(): string | null;
     /**
-     * Async initialization (called by factory function)
-     *
-     * @internal - This method is public for factory access but should not be called directly.
-     * Use createVeloxApp() instead.
-     */
-    initialize(): Promise<void>;
-    /**
-     * Sets up request context decorator
-     *
-     * Adds `request.context` property to all requests via onRequest hook
+     * Async initialization hook for factory function.
+     * Empty because Fastify's ready() must be called in start() after plugin registration.
      *
      * @internal
      */
-    private _setupContext;
+    initialize(): Promise<void>;
     /**
      * Sets up global error handling
      *
@@ -101,12 +93,6 @@ export declare class VeloxApp {
      * @internal
      */
     private _setupErrorHandling;
-    /**
-     * Sets up graceful shutdown handlers for process signals
-     *
-     * @internal
-     */
-    private _setupGracefulShutdown;
     /**
      * Registers a plugin with the application
      *
@@ -293,5 +279,6 @@ export declare function veloxApp(config?: VeloxAppConfig): Promise<VeloxApp>;
  *
  * const app = await velox({ port: 3030 });
  * ```
+ * @deprecated Use veloxApp() instead.
  */
 export declare const velox: typeof veloxApp;

package/dist/app.js

@@ -48,25 +48,18 @@ export class VeloxApp {
      * @internal
      */
     constructor(config) {
-        // Merge user config with defaults and validate
         const merged = mergeConfig(config);
-        // Validate and freeze configuration
         this._config = validateConfig(merged);
-        // Create Fastify instance
-        const fastifyOptions = {
+        this._server = fastify({
             logger: this._config.logger,
             ...this._config.fastify,
-        };
-        this._server = fastify(fastifyOptions);
-        // Initialize lifecycle manager
+        });
         this._lifecycle = new LifecycleManager();
-        // Set up context decorator
-        this._setupContext();
-        // Set up error handling
+        setupContextHook(this._server);
         this._setupErrorHandling();
-        // Set up graceful shutdown
-        this._setupGracefulShutdown();
-        // Register request logger if enabled via environment
+        this._lifecycle.setupSignalHandlers(async () => {
+            await this.stop();
+        });
         if (process.env.VELOX_REQUEST_LOGGING === 'true') {
             this._server.register(requestLogger);
         }
@@ -110,24 +103,13 @@ export class VeloxApp {
         return this._address;
     }
     /**
-     * Async initialization (called by factory function)
-     *
-     * @internal - This method is public for factory access but should not be called directly.
-     * Use createVeloxApp() instead.
-     */
-    async initialize() {
-        // Keep empty - ready() must be called in start() after plugins are registered
-        // This is a Fastify constraint: plugins must be registered before ready()
-    }
-    /**
-     * Sets up request context decorator
-     *
-     * Adds `request.context` property to all requests via onRequest hook
+     * Async initialization hook for factory function.
+     * Empty because Fastify's ready() must be called in start() after plugin registration.
      *
      * @internal
      */
-    _setupContext() {
-        setupContextHook(this._server);
+    async initialize() {
+        // Intentionally empty - ready() is called in start()
     }
     /**
      * Sets up global error handling
@@ -139,8 +121,7 @@ export class VeloxApp {
     _setupErrorHandling() {
         this._server.setErrorHandler(async (error, request, reply) => {
             try {
-                // Handle ZodError (validation errors) - return 400
-                if (error instanceof Error && error.name === 'ZodError' && 'issues' in error) {
+                if (error.name === 'ZodError' && 'issues' in error) {
                     const zodError = error;
                     return reply.status(400).send({
                         error: 'ValidationError',
@@ -152,9 +133,7 @@ export class VeloxApp {
                         })),
                     });
                 }
-                // Handle Prisma unique constraint errors - return 409 Conflict
-                if (error instanceof Error &&
-                    error.name === 'PrismaClientKnownRequestError' &&
+                if (error.name === 'PrismaClientKnownRequestError' &&
                     'code' in error &&
                     error.code === 'P2002') {
                     const prismaError = error;
@@ -165,22 +144,21 @@ export class VeloxApp {
                         statusCode: 409,
                     });
                 }
-                // Only log server errors (5xx), not client errors (4xx)
-                const statusCode = isVeloxError(error)
-                    ? error.statusCode
-                    : typeof error === 'object' && error !== null && 'statusCode' in error
-                        ? error.statusCode
-                        : 500;
+                let statusCode = 500;
+                if (isVeloxError(error)) {
+                    statusCode = error.statusCode;
+                }
+                else if (typeof error === 'object' && error !== null && 'statusCode' in error) {
+                    statusCode = error.statusCode;
+                }
                 if (statusCode >= 500) {
                     request.log.error(error);
                 }
-                // Handle VeloxError instances (fast path - most common case)
                 if (isVeloxError(error)) {
                     return reply.status(error.statusCode).send(error.toJSON());
                 }
-                // Handle other errors
-                const message = error instanceof Error ? error.message : 'Internal Server Error';
-                const name = error instanceof Error ? error.name : 'Error';
+                const message = error.message ?? 'Internal Server Error';
+                const name = error.name ?? 'Error';
                 return reply.status(statusCode).send({
                     error: name,
                     message,
@@ -188,7 +166,6 @@ export class VeloxApp {
                 });
             }
             catch (handlerError) {
-                // Last resort error handling - prevents unhandled rejections
                 log.error('Critical error in error handler:', handlerError);
                 if (!reply.sent) {
                     return reply.status(500).send({
@@ -200,16 +177,6 @@ export class VeloxApp {
             }
         });
     }
-    /**
-     * Sets up graceful shutdown handlers for process signals
-     *
-     * @internal
-     */
-    _setupGracefulShutdown() {
-        this._lifecycle.setupSignalHandlers(async () => {
-            await this.stop();
-        });
-    }
     /**
      * Registers a plugin with the application
      *
@@ -239,17 +206,13 @@ export class VeloxApp {
      * ```
      */
     async register(plugin, options) {
-        // Handle VeloxPlugin objects (with name, version, register)
         if (isVeloxPlugin(plugin)) {
-            // Validate plugin metadata
             validatePluginMetadata(plugin);
-            // Wrap plugin with fastify-plugin for proper encapsulation
             const wrappedPlugin = fp(plugin.register, {
                 name: plugin.name,
                 dependencies: plugin.dependencies,
                 fastify: '5.x',
             });
-            // Register with Fastify
             try {
                 await this._server.register(wrappedPlugin, options ?? {});
             }
@@ -258,7 +221,6 @@ export class VeloxApp {
             }
             return;
         }
-        // Handle FastifyPluginAsync functions (standard Fastify plugins)
         if (isFastifyPlugin(plugin)) {
             try {
                 await this._server.register(plugin, options ?? {});
@@ -268,7 +230,6 @@ export class VeloxApp {
             }
             return;
         }
-        // Invalid plugin type
         throw new VeloxError('Invalid plugin: must be a VeloxPlugin object or FastifyPluginAsync function', 500, 'INVALID_PLUGIN_TYPE');
     }
     /**
@@ -356,16 +317,13 @@ export class VeloxApp {
         }
         const startTime = performance.now();
         try {
-            // Ensure Fastify is ready before listening (must be after plugin registration)
             await this._server.ready();
-            // Start listening
             const address = await this._server.listen({
                 port: this._config.port,
                 host: this._config.host,
             });
             this._isRunning = true;
             this._address = address;
-            // Print startup banner unless silent
             if (!options.silent) {
                 printBanner(this._server, {
                     address,
@@ -399,11 +357,8 @@ export class VeloxApp {
             throw new VeloxError('Server is not running', 500, 'SERVER_NOT_RUNNING');
         }
         try {
-            // Execute shutdown handlers
             await this._lifecycle.executeShutdownHandlers();
-            // Clean up signal handlers to prevent memory leaks in tests
             this._lifecycle.cleanupSignalHandlers();
-            // Close server
             await this._server.close();
             this._isRunning = false;
             this._address = null;
@@ -485,5 +440,6 @@ export async function veloxApp(config = {}) {
  *
  * const app = await velox({ port: 3030 });
  * ```
+ * @deprecated Use veloxApp() instead.
  */
 export const velox = veloxApp;

package/dist/context.js

@@ -38,17 +38,13 @@ export function createContext(request, reply) {
  * ```
  */
 export function isContext(value) {
-    // Early return for non-objects
     if (typeof value !== 'object' || value === null) {
         return false;
     }
-    // Check properties exist using 'in' operator
     if (!('request' in value) || !('reply' in value)) {
         return false;
     }
-    // After 'in' checks, safely access properties
     const ctx = value;
-    // Verify request and reply are non-null objects
     return (typeof ctx.request === 'object' &&
         ctx.request !== null &&
         typeof ctx.reply === 'object' &&
@@ -65,12 +61,7 @@ export function isContext(value) {
  * @internal
  */
 export function setupContextHook(server) {
-    // Create context for each request via direct assignment
-    // TypeScript's declaration merging provides type safety
     server.addHook('onRequest', async (request, reply) => {
-        // Direct assignment is ~100-400ns faster than Object.defineProperty
-        // We use a mutable type assertion here because this is the framework's
-        // initialization code - the readonly constraint is for user code safety
         request.context = createContext(request, reply);
     });
 }

package/dist/errors/fail.d.ts

@@ -33,6 +33,17 @@ export type ErrorCode = keyof typeof ERROR_CATALOG;
  * Variables for template interpolation
  */
 export type InterpolationVars = Record<string, string | number | boolean | undefined>;
+/**
+ * JSON representation of a VeloxFailure for API responses
+ */
+interface VeloxFailureJson {
+    error: string;
+    message: string;
+    statusCode: number;
+    code: string;
+    fix?: string;
+    docs?: string;
+}
 /**
  * Fluent error builder that provides catalog-driven errors
  * with optional customization.
@@ -111,14 +122,7 @@ export declare class VeloxFailure extends Error {
     /**
      * Convert to JSON for API responses
      */
-    toJSON(): {
-        error: string;
-        message: string;
-        statusCode: number;
-        code: string;
-        fix?: string;
-        docs?: string;
-    };
+    toJSON(): VeloxFailureJson;
     /**
      * Interpolate variables into a template string
      */
@@ -161,3 +165,4 @@ export declare function fail(code: string, vars?: InterpolationVars): VeloxFailu
  * @returns true if error is a VeloxFailure
  */
 export declare function isVeloxFailure(error: unknown): error is VeloxFailure;
+export {};

package/dist/errors/fail.js

@@ -54,7 +54,6 @@ export class VeloxFailure extends Error {
         this.code = code;
         this.statusCode = entry.statusCode;
         this.entry = entry;
-        // Maintains proper stack trace
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, VeloxFailure);
         }
@@ -142,11 +141,9 @@ export class VeloxFailure extends Error {
             statusCode: this.statusCode,
             code: this.code,
         };
-        // Include fix in development
         if (process.env.NODE_ENV !== 'production' && this.suggestion) {
             json.fix = this.suggestion;
         }
-        // Always include docs URL
         if (this.docsUrl) {
             json.docs = this.docsUrl;
         }

package/dist/errors/formatter.js

@@ -262,15 +262,12 @@ export function formatErrorForApi(error, catalogCode) {
         statusCode: error.statusCode ?? entry?.statusCode ?? 500,
         code: catalogCode ?? error.code,
     };
-    // Include field errors for validation
     if (error.fields) {
         response.fields = error.fields;
     }
-    // Include fix suggestion in development
     if (process.env.NODE_ENV !== 'production' && entry?.fix) {
         response.fix = entry.fix.suggestion;
     }
-    // Include docs link
     if (entry?.docsUrl) {
         response.docs = entry.docsUrl;
     }

package/dist/errors/index.js

@@ -9,9 +9,6 @@
  *
  * @module errors
  */
-// Re-export catalog
 export { ERROR_CATALOG, ERROR_DOMAINS, getDocsUrl, getErrorEntry, getErrorsByDomain, isKnownErrorCode, } from './catalog.js';
-// Re-export fail() - the elegant error creation API
 export { fail, isVeloxFailure, VeloxFailure, } from './fail.js';
-// Re-export formatter
 export { extractErrorLocation, formatError, formatErrorForApi, formatErrorOneLine, logDeprecation, logError, logWarning, } from './formatter.js';

package/dist/errors.js

@@ -3,12 +3,10 @@
  * Provides base error classes with HTTP status codes and discriminated unions
  * @module errors
  */
-// Import catalog for use in error classes
 import { ERROR_CATALOG } from './errors/catalog.js';
 import { formatError as _formatError } from './errors/formatter.js';
 import { createLogger } from './utils/logger.js';
 const log = createLogger('core');
-// Re-export the enhanced error catalog, formatter, and fail()
 export { ERROR_CATALOG, ERROR_DOMAINS, extractErrorLocation, fail, formatError, formatErrorForApi, formatErrorOneLine, getDocsUrl, getErrorEntry, getErrorsByDomain, isKnownErrorCode, isVeloxFailure, logDeprecation, logError, logWarning, VeloxFailure, } from './errors/index.js';
 /**
  * Type guard for validation error responses
@@ -81,7 +79,6 @@ export class VeloxError extends Error {
         this.name = 'VeloxError';
         this.statusCode = statusCode;
         this.code = code;
-        // Look up catalog entry for enhanced error info
         if (code != null && String(code).startsWith('VELOX-')) {
             const entry = ERROR_CATALOG[code];
             if (entry) {
@@ -89,7 +86,6 @@ export class VeloxError extends Error {
                 this.docsUrl = entry.docsUrl;
             }
         }
-        // Maintains proper stack trace for where error was thrown (V8 only)
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, VeloxError);
         }
@@ -106,11 +102,9 @@ export class VeloxError extends Error {
             statusCode: this.statusCode,
             code: this.code,
         };
-        // Include fix suggestion in development only
         if (process.env.NODE_ENV !== 'production' && this.fix) {
             response.fix = this.fix;
         }
-        // Always include docs URL if available
         if (this.docsUrl) {
             response.docs = this.docsUrl;
         }
@@ -298,7 +292,7 @@ export class NotFoundError extends VeloxError {
  * ```
  */
 export function isVeloxError(error) {
-    return error != null && error instanceof VeloxError;
+    return error instanceof VeloxError;
 }
 /**
  * Type guard to check if an error is a ValidationError

package/dist/index.js

@@ -15,19 +15,13 @@
  * @module @veloxts/core
  */
 import { createRequire } from 'node:module';
-// Read version from package.json dynamically
 const require = createRequire(import.meta.url);
 const packageJson = require('../package.json');
 /** VeloxTS framework version */
 export const VELOX_VERSION = packageJson.version ?? '0.0.0-unknown';
 export { VeloxApp, velox, veloxApp } from './app.js';
 export { createContext, isContext, setupContextHook, setupTestContext } from './context.js';
-export { assertNever, ConfigurationError, 
-// Elegant error creation API
-fail, isConfigurationError, isNotFoundError, isNotFoundErrorResponse, isValidationError, isValidationErrorResponse, isVeloxError, isVeloxFailure, 
-// Developer experience utilities
-logDeprecation, logWarning, NotFoundError, ValidationError, VeloxError, VeloxFailure, } from './errors.js';
-// Plugin system
+export { assertNever, ConfigurationError, fail, isConfigurationError, isNotFoundError, isNotFoundErrorResponse, isValidationError, isValidationErrorResponse, isVeloxError, isVeloxFailure, logDeprecation, logWarning, NotFoundError, ValidationError, VeloxError, VeloxFailure, } from './errors.js';
 export { definePlugin, isFastifyPlugin, isVeloxPlugin, validatePluginMetadata } from './plugin.js';
 export { isValidHost, isValidPort } from './utils/config.js';
 export { registerStatic } from './plugins/static.js';

package/dist/plugin.js

@@ -78,7 +78,6 @@ export function validatePluginMetadata(plugin) {
     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');
@@ -110,7 +109,6 @@ 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 &&

package/dist/plugins/request-logger.js

@@ -93,17 +93,13 @@ function formatDuration(ms) {
  * @param server - Fastify instance
  */
 async function requestLoggerPlugin(server) {
-    // Skip if request logging not enabled via environment
     if (process.env.VELOX_REQUEST_LOGGING !== 'true') {
         return;
     }
-    // Track request start time
     server.addHook('onRequest', async (request) => {
         request._veloxStartTime = performance.now();
     });
-    // Log on response with timing
     server.addHook('onResponse', async (request, reply) => {
-        // Wrap in try-catch to ensure logging never breaks request handling
         try {
             const startTime = request._veloxStartTime;
             const duration = startTime ? performance.now() - startTime : 0;
@@ -115,7 +111,7 @@ async function requestLoggerPlugin(server) {
             console.log(`${COLORS.dim}${timestamp}${COLORS.reset}  ${color}${method}${COLORS.reset} ${url} ${color}${status}${COLORS.reset} ${COLORS.dim}${formatDuration(duration)}${COLORS.reset}`);
         }
         catch {
-            // Silently fail - logging should never affect application behavior
+            // Logging failures must not affect request handling
         }
     });
 }

package/dist/plugins/static.js

@@ -83,9 +83,7 @@ function buildCacheControl(options) {
  */
 export async function registerStatic(server, path, options = {}) {
     const { spa = false, prefix = '/', cache = {}, exclude = [], index = 'index.html' } = options;
-    // Resolve to absolute path
     const absoluteRoot = resolve(process.cwd(), path);
-    // Dynamically import @fastify/static (optional peer dependency)
     let fastifyStatic;
     try {
         const module = await import('@fastify/static');
@@ -94,9 +92,7 @@ export async function registerStatic(server, path, options = {}) {
     catch {
         throw new Error('To serve static files, please install @fastify/static:\n\n  pnpm add @fastify/static');
     }
-    // Build cache control header
     const cacheControl = buildCacheControl(cache);
-    // Register static plugin
     await server.register(fastifyStatic, {
         root: absoluteRoot,
         prefix,
@@ -106,10 +102,8 @@ export async function registerStatic(server, path, options = {}) {
             res.setHeader('Cache-Control', cacheControl);
         },
     });
-    // SPA fallback: serve index.html for non-file routes
     if (spa) {
         server.setNotFoundHandler(async (request, reply) => {
-            // Skip excluded paths (API routes, etc.)
             for (const excludePath of exclude) {
                 if (request.url.startsWith(excludePath)) {
                     return reply.status(404).send({
@@ -119,7 +113,6 @@ export async function registerStatic(server, path, options = {}) {
                     });
                 }
             }
-            // Skip requests for files (have extensions)
             if (/\.\w+$/.test(request.url)) {
                 return reply.status(404).send({
                     error: 'NotFound',
@@ -127,7 +120,6 @@ export async function registerStatic(server, path, options = {}) {
                     statusCode: 404,
                 });
             }
-            // Serve index.html for SPA routes
             return reply.sendFile(index, absoluteRoot);
         });
     }

package/dist/utils/banner.js

@@ -17,11 +17,9 @@ export function printBanner(server, options) {
     const { address, env, startTime } = options;
     const elapsed = Math.round(performance.now() - startTime);
     if (env === 'production') {
-        // Production: single line, minimal, machine-parseable
         console.log(`  VeloxTS v${VELOX_VERSION} | ${env} | ${address}`);
         return;
     }
-    // Development: detailed banner with route information
     const routes = collectRoutes(server);
     console.log('');
     console.log(`  ${pc.bold('VeloxTS')} v${VELOX_VERSION}`);
@@ -62,11 +60,7 @@ function formatMethod(method) {
  */
 function collectRoutes(server) {
     const routes = [];
-    // Fastify exposes routes via printRoutes or we can iterate
-    // Using the internal routes map after ready()
     const routesList = server.printRoutes({ commonPrefix: false });
-    // Parse the route tree output
-    // Format: "└── /api (GET, HEAD)\n    └── /users (GET, POST, HEAD)"
     const lines = routesList.split('\n');
     for (const line of lines) {
         const match = line.match(/([/][^\s(]*)\s*\(([^)]+)\)/);

package/dist/utils/config.js

@@ -38,7 +38,7 @@ export function isValidPort(port) {
  * @returns true if host is valid (non-empty string), narrowing to ValidHost
  */
 export function isValidHost(host) {
-    return typeof host === 'string' && host.length > 0;
+    return host.length > 0;
 }
 // ============================================================================
 // Configuration Functions
@@ -88,10 +88,9 @@ export function validateConfig(config) {
     if (!isValidHost(config.host)) {
         throw new Error('Host must be a non-empty string.');
     }
-    // Return frozen config with branded types
     return Object.freeze({
-        port: config.port, // Already narrowed to ValidPort by isValidPort
-        host: config.host, // Already narrowed to ValidHost by isValidHost
+        port: config.port,
+        host: config.host,
         logger: config.logger,
         fastify: config.fastify,
     });

package/dist/utils/lifecycle.js

@@ -34,12 +34,10 @@ export class LifecycleManager {
      * ```
      */
     addShutdownHandler(handler) {
-        // Prevent memory leaks from unbounded growth
         if (this.shutdownHandlers.size >= LifecycleManager.MAX_SHUTDOWN_HANDLERS) {
             throw new Error(`Maximum number of shutdown handlers (${LifecycleManager.MAX_SHUTDOWN_HANDLERS}) exceeded. ` +
                 'This may indicate a memory leak.');
         }
-        // Set automatically prevents duplicates
         this.shutdownHandlers.add(handler);
     }
     /**
@@ -87,7 +85,7 @@ export class LifecycleManager {
      */
     setupSignalHandlers(onShutdown) {
         const signals = ['SIGINT', 'SIGTERM'];
-        signals.forEach((signal) => {
+        for (const signal of signals) {
             const handler = async () => {
                 log.info(`\nReceived ${signal}, initiating graceful shutdown...`);
                 try {
@@ -100,10 +98,9 @@ export class LifecycleManager {
                     process.exit(1);
                 }
             };
-            // Store handler reference so it can be removed later
             this.signalHandlers.set(signal, handler);
             process.once(signal, handler);
-        });
+        }
     }
     /**
      * Removes all signal handlers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/core",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Fastify wrapper and plugin system for VeloxTS framework",
   "type": "module",
   "main": "dist/index.js",