@warlock.js/core 4.0.18 → 4.0.21

package/esm/dev2-server/file-manager.d.ts

@@ -1,135 +1,384 @@
 import { type FileOperations } from "./file-operations";
 import type { FileManifest, FileState, FileType, LayerType } from "./types";
+/**
+ * Options for the process() method
+ */
+export interface ProcessOptions {
+    /**
+     * Force reprocessing even if file hasn't changed
+     * @default false
+     */
+    force?: boolean;
+    /**
+     * Whether to transform imports to cache paths
+     * Set to false during batch operations where imports are transformed later
+     * @default true
+     */
+    transformImports?: boolean;
+    /**
+     * Whether to save to cache after processing
+     * Set to false if you need to do additional transformations before saving
+     * @default true
+     */
+    saveToCache?: boolean;
+}
+/**
+ * FileManager - Manages the lifecycle of a single source file
+ *
+ * ## Lifecycle States
+ *
+ * ```
+ * idle → loading → parsed → transpiled → ready
+ *   ↑                                      │
+ *   └──────────── (file changed) ──────────┘
+ * ```
+ *
+ * ## Processing Pipeline
+ *
+ * All file processing flows through a unified pipeline:
+ * 1. **Load** - Read source from disk
+ * 2. **Hash** - Calculate content hash for change detection
+ * 3. **Parse** - Discover imports and dependencies
+ * 4. **Transpile** - Convert TypeScript to JavaScript
+ * 5. **Transform** - Rewrite import paths to cache locations
+ * 6. **Save** - Write transformed code to cache (ONCE)
+ *
+ * ## Usage Examples
+ *
+ * ```typescript
+ * // Standard processing (full pipeline)
+ * const file = new FileManager(absolutePath, filesMap, fileOps);
+ * await file.process();
+ *
+ * // Batch processing (parse first, complete later)
+ * await file.parse();
+ * // ... after dependencies are ready ...
+ * await file.complete();
+ *
+ * // Check for changes and reprocess if needed
+ * const changed = await file.process(); // returns false if unchanged
+ *
+ * // Force reprocessing
+ * await file.process({ force: true });
+ * ```
+ *
+ * @class FileManager
+ */
 export declare class FileManager {
     readonly absolutePath: string;
     files: Map<string, FileManager>;
     fileOperations: FileOperations;
     /**
-     * Relative path to root directory
+     * Relative path from the project root directory
+     * Used as the primary identifier for files throughout the system
+     * @example "src/app/users/controllers/get-user.controller.ts"
      */
     relativePath: string;
     /**
-     * Last modified timestamp
+     * Unix timestamp of the last modification time
+     * Used with hash for change detection
      */
     lastModified: number;
     /**
-     * Hash of the file content
+     * SHA-256 hash of the source content
+     * Primary mechanism for detecting file changes
      */
     hash: string;
     /**
-     * Source code of the file
+     * Original TypeScript/JavaScript source code
+     * Loaded from disk during processing
      */
     source: string;
     /**
-     * Transpiled code of the file
+     * Transpiled JavaScript code with transformed imports
+     * This is the final output that gets saved to cache and loaded at runtime
      */
     transpiled: string;
     /**
-     * Dependencies of the file (relative paths)
+     * Set of relative paths that this file depends on (imports)
+     * Used to build the dependency graph for HMR invalidation
+     * @example Set(["src/app/users/models/user.model.ts", "src/config/database.ts"])
      */
     dependencies: Set<string>;
     /**
-     * Import map: original import path -> resolved absolute path
-     * Used for import transformation
+     * Map of original import specifiers to resolved absolute paths
+     * Key: the exact import string from source (e.g., "./user.model")
+     * Value: resolved absolute path (e.g., "D:/project/src/app/users/models/user.model.ts")
+     *
+     * Used during import transformation to rewrite paths to cache locations
      */
     importMap: Map<string, string>;
     /**
-     * Dependents of the file
+     * Set of relative paths that depend on this file
+     * Populated from the dependency graph after initial processing
+     * Used to determine what needs reloading when this file changes
      */
     dependents: Set<string>;
     /**
-     * Version of the file
+     * Version number incremented on each change
+     * Used for cache busting in dynamic imports
      */
     version: number;
     /**
-     * Type of the file
+     * Semantic type of the file based on its path/content
+     * Used to determine reload behavior and special handling
      */
     type: FileType | undefined;
     /**
-     * Layer of the file
+     * Reload layer: HMR (hot module replacement) or FSR (full server restart)
+     * Determines how changes to this file are applied at runtime
      */
     layer: LayerType | undefined;
     /**
-     * Cache path of the file
+     * Path to the cached transpiled file (relative to .warlock/cache/)
+     * @example "src-app-users-controllers-get-user.controller.js"
      */
     cachePath: string;
     /**
-     * File cleanup function
+     * Cleanup function called before the file is unloaded
+     * Set by module loader for files that export cleanup handlers
      */
     cleanup?: () => void;
     /**
      * Whether imports have been transformed to cache paths
+     * Prevents double transformation and tracks processing state
      */
     importsTransformed: boolean;
     /**
      * Whether this file contains only type definitions (no runtime code)
-     * Used to exclude from circular dependency detection
+     * Type-only files are excluded from circular dependency detection
      */
     isTypeOnlyFile: boolean;
     /**
-     * File state
+     * Current processing state of the file
+     *
+     * - `idle`: Initial state, no processing started
+     * - `loading`: Reading source from disk
+     * - `parsed`: Source loaded and imports discovered
+     * - `transpiled`: TypeScript compiled to JavaScript
+     * - `ready`: Fully processed and available for use
+     * - `updating`: Being reprocessed after a change
+     * - `deleted`: File has been removed from disk
      */
     state: FileState;
     /**
-     * Constructor
+     * Creates a new FileManager instance
+     *
+     * @param absolutePath - Full filesystem path to the source file
+     * @param files - Map of all tracked files (for import resolution)
+     * @param fileOperations - FileOperations instance (for adding missing dependencies)
+     *
+     * @example
+     * ```typescript
+     * const fileManager = new FileManager(
+     *   "D:/project/src/app/users/controllers/get-user.controller.ts",
+     *   filesMap,
+     *   fileOperations
+     * );
+     * ```
      */
     constructor(absolutePath: string, files: Map<string, FileManager>, fileOperations: FileOperations);
     /**
-     * Initialize the file manager
-     * @param fileManifest Optional manifest data from previous build
-     * @param filesMap Optional map of all FileManager instances (for import transformation)
+     * Initialize the file manager from disk or manifest cache
+     *
+     * This is the primary entry point for file initialization.
+     * If manifest data is provided, it will attempt to use cached data
+     * and only reprocess if the file has changed.
+     *
+     * @param fileManifest - Optional cached manifest data from previous build
+     *
+     * @example
+     * ```typescript
+     * // Fresh initialization (no cache)
+     * await fileManager.init();
+     *
+     * // Initialize with cached manifest data
+     * await fileManager.init(manifestEntry);
+     * ```
      */
     init(fileManifest?: Partial<FileManifest>): Promise<void>;
     /**
-     * Get cached file path ready for dynamic import
+     * Get the cache path as a file:// URL for dynamic import
+     * Includes cache busting query parameter based on version
+     *
+     * @returns File URL ready for dynamic import, or empty string if no cache
+     *
+     * @example
+     * ```typescript
+     * const module = await import(fileManager.cachePathUrl);
+     * ```
      */
     get cachePathUrl(): string;
     /**
-     * Load file with manifest data (check if changed)
-     */
-    protected loadFromManifest(fileManifest: Partial<FileManifest>): Promise<void>;
-    /**
-     * Load file from disk (fresh, no manifest)
+     * Process the file through the unified pipeline
+     *
+     * This is the core method that handles all file processing.
+     * It implements a single-pass pipeline that:
+     * 1. Loads source from disk
+     * 2. Checks if content changed (skip if unchanged)
+     * 3. Parses imports to discover dependencies
+     * 4. Ensures all dependencies exist
+     * 5. Transpiles TypeScript to JavaScript
+     * 6. Transforms imports to cache paths
+     * 7. Saves to cache (ONCE - no duplicate writes)
+     *
+     * @param options - Processing options
+     * @param options.force - Force reprocessing even if unchanged
+     * @param options.transformImports - Whether to transform import paths (default: true)
+     * @param options.saveToCache - Whether to save to cache file (default: true)
+     *
+     * @returns True if file was processed, false if unchanged and skipped
+     *
+     * @example
+     * ```typescript
+     * // Normal processing
+     * const changed = await fileManager.process();
+     *
+     * // Force reprocess
+     * await fileManager.process({ force: true });
+     *
+     * // Batch mode: transform imports later
+     * await fileManager.process({ transformImports: false });
+     * ```
      */
-    protected loadFromDisk(): Promise<void>;
+    process(options?: ProcessOptions): Promise<boolean>;
     /**
-     * Process file: parse imports first, then transpile
+     * Parse the file to discover dependencies (Phase 1 of batch processing)
+     *
+     * This method only performs the first half of processing:
+     * - Loads source from disk
+     * - Calculates hash
+     * - Parses imports to discover dependencies
+     * - Sets up file metadata
+     *
+     * Use this for batch file operations where you need to know
+     * dependencies before deciding processing order.
+     *
+     * **Important**: After calling parse(), you must call complete()
+     * to finish processing and make the file usable.
+     *
+     * @example
+     * ```typescript
+     * // Batch processing pattern
+     * const files = await Promise.all(
+     *   paths.map(async (path) => {
+     *     const file = new FileManager(path, filesMap, fileOps);
+     *     await file.parse();
+     *     return file;
+     *   })
+     * );
+     *
+     * // Order by dependencies, then complete
+     * for (const file of orderedFiles) {
+     *   await file.complete();
+     * }
+     * ```
      */
-    protected processFile(): Promise<void>;
+    parse(): Promise<void>;
     /**
-     * Phase 1: Parse the file to discover dependencies
-     * Does NOT write cache yet - used for batch file processing
-     * to determine processing order
+     * Complete file processing after parse() (Phase 2 of batch processing)
+     *
+     * This method completes the processing pipeline:
+     * - Ensures dependencies exist
+     * - Transpiles TypeScript to JavaScript
+     * - Transforms imports to cache paths
+     * - Saves to cache
+     *
+     * **Important**: This must be called after parse() to finish processing.
+     * The file is not usable until complete() has been called.
+     *
+     * @example
+     * ```typescript
+     * await file.parse();
+     * // ... after dependencies are ready ...
+     * await file.complete();
+     * // File is now ready for use
+     * ```
      */
-    parseOnly(): Promise<void>;
+    complete(): Promise<void>;
     /**
-     * Phase 2: Complete processing (transpile, transform, write cache)
-     * Called after dependencies are ready
-     */
-    finalize(): Promise<void>;
-    /**
-     * Detect file type and layer based on path
-     */
-    protected detectFileTypeAndLayer(): void;
-    /**
-     * Update file when changed during development
+     * Update the file after a change during development
+     *
+     * This is a convenience method that delegates to process().
+     * It checks if the file has actually changed and only reprocesses if needed.
+     *
+     * @returns True if file was reprocessed, false if unchanged
+     *
+     * @example
+     * ```typescript
+     * // Called by file watcher
+     * const changed = await fileManager.update();
+     * if (changed) {
+     *   console.log("File was updated");
+     * }
+     * ```
      */
     update(): Promise<boolean>;
     /**
-     * Force reprocess file even if source hasn't changed
-     * Useful when dependencies become available (e.g., missing file is added back)
+     * Force reprocess the file regardless of hash match
+     *
+     * Use this when:
+     * - A dependency that was previously missing is now available
+     * - Import transformation needs to be redone
+     * - Cache is corrupted or missing
+     *
+     * @example
+     * ```typescript
+     * // After a missing dependency is added
+     * await fileManager.forceReprocess();
+     * ```
      */
     forceReprocess(): Promise<void>;
     /**
-     * Transform imports in transpiled code to use cache paths
+     * Initialize from cached manifest data
+     *
+     * Attempts to use cached data from a previous build.
+     * If the file has changed (hash mismatch) or cache is missing,
+     * falls back to full processing.
+     *
+     * @param fileManifest - Cached manifest entry
+     * @internal
+     */
+    protected initFromManifest(fileManifest: Partial<FileManifest>): Promise<void>;
+    /**
+     * Detect the file type and reload layer based on path patterns
+     *
+     * File types determine special handling:
+     * - `main`: Application entry point
+     * - `config`: Configuration files
+     * - `route`: Route definitions
+     * - `controller`: HTTP controllers
+     * - `service`: Business logic services
+     * - `model`: Database models
+     * - `event`: Event handlers
+     * - `other`: Everything else
+     *
+     * Layers determine reload behavior:
+     * - `HMR`: Hot module replacement (instant reload)
+     * - `FSR`: Full server restart (required for some changes)
+     *
+     * @internal
      */
-    transformImports(): Promise<void>;
+    protected detectFileTypeAndLayer(): void;
     /**
-     * Export file data as manifest entry
-     * Note: source and transpiled code are NOT stored in manifest
-     * - Source code is in the original file
-     * - Transpiled code is in .warlock/cache/
-     * - Hash is used to detect changes
+     * Export file data as a manifest entry for caching
+     *
+     * The manifest stores metadata about each file to enable:
+     * - Fast startup by skipping unchanged files
+     * - Dependency tracking across restarts
+     * - Cache validation via hash comparison
+     *
+     * Note: Source code and transpiled output are NOT stored in manifest.
+     * - Source is always read from disk
+     * - Transpiled code is stored in .warlock/cache/
+     *
+     * @returns Manifest entry for this file
+     *
+     * @example
+     * ```typescript
+     * const entry = fileManager.toManifest();
+     * manifest.setFile(fileManager.relativePath, entry);
+     * ```
      */
     toManifest(): FileManifest;
 }

package/esm/dev2-server/file-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-manager.d.ts","sourceRoot":"","sources":["../../src/dev2-server/file-manager.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKxD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAG5E,qBAAa,WAAW;aA2EJ,YAAY,EAAE,MAAM;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;IAC/B,cAAc,EAAE,cAAc;IA5EvC;;OAEG;IACI,YAAY,SAAM;IACzB;;OAEG;IACI,YAAY,SAAK;IACxB;;OAEG;IACI,IAAI,SAAM;IACjB;;OAEG;IACI,MAAM,SAAM;IACnB;;OAEG;IACI,UAAU,SAAM;IACvB;;OAEG;IACI,YAAY,cAAqB;IACxC;;;OAGG;IACI,SAAS,sBAA6B;IAC7C;;OAEG;IACI,UAAU,cAAqB;IACtC;;OAEG;IACI,OAAO,SAAK;IACnB;;OAEG;IACI,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC;;OAEG;IACI,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;IACpC;;OAEG;IACI,SAAS,SAAM;IACtB;;OAEG;IACI,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAE5B;;OAEG;IACI,kBAAkB,UAAS;IAElC;;;OAGG;IACI,cAAc,UAAS;IAE9B;;OAEG;IACI,KAAK,EAAE,SAAS,CAAU;IAEjC;;OAEG;gBAEe,YAAY,EAAE,MAAM,EAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAC/B,cAAc,EAAE,cAAc;IAGvC;;;;OAIG;IACU,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAiBtD;;OAEG;IACH,IAAW,YAAY,WAItB;IAED;;OAEG;cACa,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;IAsDpE;;OAEG;cACa,YAAY;IAkB5B;;OAEG;cACa,WAAW;IAgC3B;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBvC;;;OAGG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAiCtC;;OAEG;IACH,SAAS,CAAC,sBAAsB;IAuDhC;;OAEG;IACU,MAAM;IA8BnB;;;OAGG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB5C;;OAEG;IACU,gBAAgB;IAsB7B;;;;;;OAMG;IACI,UAAU,IAAI,YAAY;CAclC"}
+{"version":3,"file":"file-manager.d.ts","sourceRoot":"","sources":["../../src/dev2-server/file-manager.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKxD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAG5E;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,WAAW;aA+HJ,YAAY,EAAE,MAAM;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;IAC/B,cAAc,EAAE,cAAc;IAhIvC;;;;OAIG;IACI,YAAY,SAAM;IAEzB;;;OAGG;IACI,YAAY,SAAK;IAExB;;;OAGG;IACI,IAAI,SAAM;IAEjB;;;OAGG;IACI,MAAM,SAAM;IAEnB;;;OAGG;IACI,UAAU,SAAM;IAEvB;;;;OAIG;IACI,YAAY,cAAqB;IAExC;;;;;;OAMG;IACI,SAAS,sBAA6B;IAE7C;;;;OAIG;IACI,UAAU,cAAqB;IAEtC;;;OAGG;IACI,OAAO,SAAK;IAEnB;;;OAGG;IACI,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAElC;;;OAGG;IACI,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;IAEpC;;;OAGG;IACI,SAAS,SAAM;IAEtB;;;OAGG;IACI,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAE5B;;;OAGG;IACI,kBAAkB,UAAS;IAElC;;;OAGG;IACI,cAAc,UAAS;IAE9B;;;;;;;;;;OAUG;IACI,KAAK,EAAE,SAAS,CAAU;IAEjC;;;;;;;;;;;;;;;OAeG;gBAEe,YAAY,EAAE,MAAM,EAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EAC/B,cAAc,EAAE,cAAc;IAGvC;;;;;;;;;;;;;;;;;OAiBG;IACU,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IActE;;;;;;;;;;OAUG;IACH,IAAW,YAAY,IAAI,MAAM,CAGhC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IA0EpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBnC;;;;;;;;;;;;;;;;;;;OAmBG;IACU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BtC;;;;;;;;;;;;;;;;OAgBG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAIvC;;;;;;;;;;;;;OAaG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;;;;;;OASG;cACa,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA6CpF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAuDxC;;;;;;;;;;;;;;;;;;;OAmBG;IACI,UAAU,IAAI,YAAY;CAclC"}