opticore-webapp 1.0.71 → 1.0.73

package/dist/index.d.cts

@@ -5,6 +5,7 @@ import { TDependency } from 'opticore-dependency-inject';
 import { express } from 'opticore-express';
 import { LoggerCore } from 'opticore-logger';
 import { CorsOptions } from 'cors';
+import { HotReloadConfig } from 'opticore-watcher';
 
 interface WebServerConstructorInterface {
     app: express.Application;
@@ -12,6 +13,16 @@ interface WebServerConstructorInterface {
     localLanguage: string;
     environmentPath: any;
     corsOriginOptions?: Partial<CorsOptions> | null;
+    /**
+     * Enable hot reload in development mode.
+     * - true          → use all defaults
+     * - HotReloadConfig → custom configuration
+     * The watcher starts automatically when onStartServer() is called.
+     * On code changes the HTTP server is closed gracefully and the process
+     * exits (code 0) so your external runner restarts it:
+     *   tsx --watch src/index.ts  |  nodemon  |  node --watch dist/index.js
+     */
+    hotReload?: boolean | HotReloadConfig;
 }
 
 declare class WebServerCore {
@@ -25,6 +36,7 @@ declare class WebServerCore {
     private readonly environmentPath;
     private serverListenEvent;
     private dependenciesRegistered;
+    private readonly hotReloadCfg;
     constructor(paramsConstructor: WebServerConstructorInterface);
     /**
      *
@@ -53,6 +65,32 @@ declare class WebServerCore {
      * @private
      */
     private loadTranslationFiles;
+    /**
+     * Resolve the final HotReloadConfig by merging constructor config with
+     * HMR environment variables.
+     *
+     * Priority (highest → lowest):
+     *   1. Constructor hotReload properties  (explicit code-level config)
+     *   2. HMR_* env variables               (runtime / per-environment config)
+     *   3. HotReloadWatcher internal defaults (built-in fallbacks)
+     *
+     * The watcher starts when:
+     *   - constructor passed hotReload: true | HotReloadConfig
+     *   - OR HMR_ENABLED=true in the .env file
+     */
+    private resolveHotReloadConfig;
+    /**
+     * Extract file extensions from glob patterns such as "src/** /*.ts".
+     * "src/** /*.ts"
+     * ".env"     skipped, handled natively by the watcher
+     */
+    private hmrExtractExtensions;
+    /**
+     * Extract ignore names from glob patterns such as "node_modules/**".
+     * "node_modules/**" → "node_modules"
+     * "dist/**"         → "dist"
+     */
+    private hmrExtractIgnore;
     /**
      *
      * @param allFeatureRoutes
@@ -73,164 +111,6 @@ declare class WebServerCore {
 
 declare const envPath: string;
 
-interface HotReloadConfig {
-    /**
-     * Entry point file to run (e.g. 'dist/index.js' or 'src/index.ts')
-     */
-    entry: string;
-    /**
-     * Runtime to use for spawning the child process.
-     * - 'node'    : compiled JS only, supports IPC hot reload for .env
-     * - 'tsx'     : runs TypeScript directly via tsx
-     * - 'ts-node' : runs TypeScript directly via ts-node
-     * @default 'node'
-     */
-    runtime?: 'node' | 'tsx' | 'ts-node';
-    /**
-     * Extra arguments passed to the runtime before the entry file.
-     * Example: ['--experimental-specifier-resolution=node']
-     */
-    runtimeArgs?: string[];
-    /**
-     * Root directory to watch for file changes.
-     * @default process.cwd()
-     */
-    rootDir?: string;
-    /**
-     * Additional directories or glob patterns to watch.
-     * Merged with the default watched extensions (.ts, .js, .env, .json).
-     * Example: ['config', 'locales']
-     */
-    watchDirs?: string[];
-    /**
-     * File extensions to watch.
-     * @default ['.ts', '.js', '.mjs', '.cjs', '.json', '.env']
-     */
-    watchExtensions?: string[];
-    /**
-     * Patterns / file names to ignore in addition to the built-in ignores.
-     * Built-in ignores: node_modules, dist, .git, package.json, package-lock.json
-     * Example: ['coverage', 'tmp', 'myIgnored.json']
-     */
-    ignore?: string[];
-    /**
-     * Path to the .env file that should be hot-reloaded without restarting.
-     * @default '.env'
-     */
-    envFile?: string;
-    /**
-     * File extensions that support in-process hot reload (no server restart).
-     * All other watched extensions trigger a full server restart.
-     * @default ['.env', '.json']
-     */
-    hotReloadExtensions?: string[];
-    /**
-     * Milliseconds to wait after the last change before acting (debounce).
-     * Prevents rapid successive restarts when many files change at once.
-     * @default 300
-     */
-    debounceMs?: number;
-    /**
-     * Automatically restart the child process if it exits unexpectedly.
-     * @default true
-     */
-    restartOnCrash?: boolean;
-    /**
-     * Maximum number of automatic restarts on crash before giving up.
-     * @default 5
-     */
-    maxCrashRestarts?: number;
-}
-
-declare class HotReloadWatcher {
-    private readonly cfg;
-    private child;
-    private watchers;
-    private debounceTimer;
-    private isRestarting;
-    private crashRestartCount;
-    private started;
-    private restartStart;
-    constructor(config: HotReloadConfig);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private spawnChild;
-    private killChild;
-    private setupWatchers;
-    private watchDirectoryRecursive;
-    private onFileChange;
-    private doHotReload;
-    private scheduleRestart;
-    private sendIpc;
-    private shouldIgnoreDir;
-    private shouldIgnoreFile;
-    private isWatchedFile;
-    private isHotReloadable;
-    private isEnvFile;
-    private strip;
-    private ts;
-    /**
-     * Startup banner — mirrors the infoServer() box style from CoreService.
-     *
-     *   ╔══════════════════════════════════════════╗
-     *   gradient title
-     *   ╔══ bgGreen box ════════════════════════╗
-     *    entry    dist/index.js
-     *    runtime  node  (IPC enabled)
-     *    root     ./src
-     *    watching .ts  .js  .json  .env
-     *    debounce 300ms
-     *   ╚══════════════════════════════════════════╝
-     */
-    private printBanner;
-    /**
-     * HOT event — in-process reload, no server restart.
-     *
-     *   ✔  [ HOT ]  14:23:45  |  .env                →  env variables reloaded
-     */
-    private printHot;
-    /**
-     * RELOAD event — server restart triggered.
-     *
-     *   ⚡  [ RELOAD ]  14:24:03  |  src/routes/user.ts   →  restarting server...
-     */
-    private printReloading;
-    /**
-     * READY event — server successfully restarted.
-     * Uses the same full-width bgGreen border as infoServer().
-     *
-     *   ════════════════════════════════════════════
-     *    READY   server restarted in 245ms
-     *   ════════════════════════════════════════════
-     */
-    private printReady;
-    /**
-     * CRASH event — unexpected child process exit.
-     *
-     *   ✘  [ CRASH ]  14:24:10  |  server exited with code 1
-     */
-    private printCrash;
-    /**
-     * RETRY event — auto-restart after crash.
-     *
-     *   ↺  [ RETRY ]  14:24:11  |  attempt 1 / 5
-     */
-    private printCrashRetry;
-    /**
-     * LIMIT reached — give up restarting.
-     */
-    private printCrashLimit;
-    /**
-     * Error — miscellaneous internal error.
-     */
-    private printError;
-    /**
-     * Stopped — watcher shut down.
-     */
-    private printStopped;
-    private setupProcessSignals;
-}
-
 type KernelModuleType = [any[], () => void];
 
-export { type HotReloadConfig, HotReloadWatcher, type KernelModuleType, WebServerCore as WebServer, envPath };
+export { type KernelModuleType, WebServerCore as WebServer, envPath };

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { TDependency } from 'opticore-dependency-inject';
 import { express } from 'opticore-express';
 import { LoggerCore } from 'opticore-logger';
 import { CorsOptions } from 'cors';
+import { HotReloadConfig } from 'opticore-watcher';
 
 interface WebServerConstructorInterface {
     app: express.Application;
@@ -12,6 +13,16 @@ interface WebServerConstructorInterface {
     localLanguage: string;
     environmentPath: any;
     corsOriginOptions?: Partial<CorsOptions> | null;
+    /**
+     * Enable hot reload in development mode.
+     * - true          → use all defaults
+     * - HotReloadConfig → custom configuration
+     * The watcher starts automatically when onStartServer() is called.
+     * On code changes the HTTP server is closed gracefully and the process
+     * exits (code 0) so your external runner restarts it:
+     *   tsx --watch src/index.ts  |  nodemon  |  node --watch dist/index.js
+     */
+    hotReload?: boolean | HotReloadConfig;
 }
 
 declare class WebServerCore {
@@ -25,6 +36,7 @@ declare class WebServerCore {
     private readonly environmentPath;
     private serverListenEvent;
     private dependenciesRegistered;
+    private readonly hotReloadCfg;
     constructor(paramsConstructor: WebServerConstructorInterface);
     /**
      *
@@ -53,6 +65,32 @@ declare class WebServerCore {
      * @private
      */
     private loadTranslationFiles;
+    /**
+     * Resolve the final HotReloadConfig by merging constructor config with
+     * HMR environment variables.
+     *
+     * Priority (highest → lowest):
+     *   1. Constructor hotReload properties  (explicit code-level config)
+     *   2. HMR_* env variables               (runtime / per-environment config)
+     *   3. HotReloadWatcher internal defaults (built-in fallbacks)
+     *
+     * The watcher starts when:
+     *   - constructor passed hotReload: true | HotReloadConfig
+     *   - OR HMR_ENABLED=true in the .env file
+     */
+    private resolveHotReloadConfig;
+    /**
+     * Extract file extensions from glob patterns such as "src/** /*.ts".
+     * "src/** /*.ts"
+     * ".env"     skipped, handled natively by the watcher
+     */
+    private hmrExtractExtensions;
+    /**
+     * Extract ignore names from glob patterns such as "node_modules/**".
+     * "node_modules/**" → "node_modules"
+     * "dist/**"         → "dist"
+     */
+    private hmrExtractIgnore;
     /**
      *
      * @param allFeatureRoutes
@@ -73,164 +111,6 @@ declare class WebServerCore {
 
 declare const envPath: string;
 
-interface HotReloadConfig {
-    /**
-     * Entry point file to run (e.g. 'dist/index.js' or 'src/index.ts')
-     */
-    entry: string;
-    /**
-     * Runtime to use for spawning the child process.
-     * - 'node'    : compiled JS only, supports IPC hot reload for .env
-     * - 'tsx'     : runs TypeScript directly via tsx
-     * - 'ts-node' : runs TypeScript directly via ts-node
-     * @default 'node'
-     */
-    runtime?: 'node' | 'tsx' | 'ts-node';
-    /**
-     * Extra arguments passed to the runtime before the entry file.
-     * Example: ['--experimental-specifier-resolution=node']
-     */
-    runtimeArgs?: string[];
-    /**
-     * Root directory to watch for file changes.
-     * @default process.cwd()
-     */
-    rootDir?: string;
-    /**
-     * Additional directories or glob patterns to watch.
-     * Merged with the default watched extensions (.ts, .js, .env, .json).
-     * Example: ['config', 'locales']
-     */
-    watchDirs?: string[];
-    /**
-     * File extensions to watch.
-     * @default ['.ts', '.js', '.mjs', '.cjs', '.json', '.env']
-     */
-    watchExtensions?: string[];
-    /**
-     * Patterns / file names to ignore in addition to the built-in ignores.
-     * Built-in ignores: node_modules, dist, .git, package.json, package-lock.json
-     * Example: ['coverage', 'tmp', 'myIgnored.json']
-     */
-    ignore?: string[];
-    /**
-     * Path to the .env file that should be hot-reloaded without restarting.
-     * @default '.env'
-     */
-    envFile?: string;
-    /**
-     * File extensions that support in-process hot reload (no server restart).
-     * All other watched extensions trigger a full server restart.
-     * @default ['.env', '.json']
-     */
-    hotReloadExtensions?: string[];
-    /**
-     * Milliseconds to wait after the last change before acting (debounce).
-     * Prevents rapid successive restarts when many files change at once.
-     * @default 300
-     */
-    debounceMs?: number;
-    /**
-     * Automatically restart the child process if it exits unexpectedly.
-     * @default true
-     */
-    restartOnCrash?: boolean;
-    /**
-     * Maximum number of automatic restarts on crash before giving up.
-     * @default 5
-     */
-    maxCrashRestarts?: number;
-}
-
-declare class HotReloadWatcher {
-    private readonly cfg;
-    private child;
-    private watchers;
-    private debounceTimer;
-    private isRestarting;
-    private crashRestartCount;
-    private started;
-    private restartStart;
-    constructor(config: HotReloadConfig);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private spawnChild;
-    private killChild;
-    private setupWatchers;
-    private watchDirectoryRecursive;
-    private onFileChange;
-    private doHotReload;
-    private scheduleRestart;
-    private sendIpc;
-    private shouldIgnoreDir;
-    private shouldIgnoreFile;
-    private isWatchedFile;
-    private isHotReloadable;
-    private isEnvFile;
-    private strip;
-    private ts;
-    /**
-     * Startup banner — mirrors the infoServer() box style from CoreService.
-     *
-     *   ╔══════════════════════════════════════════╗
-     *   gradient title
-     *   ╔══ bgGreen box ════════════════════════╗
-     *    entry    dist/index.js
-     *    runtime  node  (IPC enabled)
-     *    root     ./src
-     *    watching .ts  .js  .json  .env
-     *    debounce 300ms
-     *   ╚══════════════════════════════════════════╝
-     */
-    private printBanner;
-    /**
-     * HOT event — in-process reload, no server restart.
-     *
-     *   ✔  [ HOT ]  14:23:45  |  .env                →  env variables reloaded
-     */
-    private printHot;
-    /**
-     * RELOAD event — server restart triggered.
-     *
-     *   ⚡  [ RELOAD ]  14:24:03  |  src/routes/user.ts   →  restarting server...
-     */
-    private printReloading;
-    /**
-     * READY event — server successfully restarted.
-     * Uses the same full-width bgGreen border as infoServer().
-     *
-     *   ════════════════════════════════════════════
-     *    READY   server restarted in 245ms
-     *   ════════════════════════════════════════════
-     */
-    private printReady;
-    /**
-     * CRASH event — unexpected child process exit.
-     *
-     *   ✘  [ CRASH ]  14:24:10  |  server exited with code 1
-     */
-    private printCrash;
-    /**
-     * RETRY event — auto-restart after crash.
-     *
-     *   ↺  [ RETRY ]  14:24:11  |  attempt 1 / 5
-     */
-    private printCrashRetry;
-    /**
-     * LIMIT reached — give up restarting.
-     */
-    private printCrashLimit;
-    /**
-     * Error — miscellaneous internal error.
-     */
-    private printError;
-    /**
-     * Stopped — watcher shut down.
-     */
-    private printStopped;
-    private setupProcessSignals;
-}
-
 type KernelModuleType = [any[], () => void];
 
-export { type HotReloadConfig, HotReloadWatcher, type KernelModuleType, WebServerCore as WebServer, envPath };
+export { type KernelModuleType, WebServerCore as WebServer, envPath };