depflow 3.0.0-dev.1 → 3.0.0-dev.11

package/dist/resolve/PathResolver.js

@@ -0,0 +1,133 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Path resolution with Local/CDN support and dual path fixing.
+ * @license Apache-2.0
+ */
+import FS, { promises as FSP } from 'node:fs';
+import { Async, File, Path } from '@netfeez/common-node';
+import { Logger } from "@netfeez/vterm";
+import PathRewriter from './PathRewriter.js';
+import AliasCompiler from './AliasCompiler.js';
+export class PathResolver {
+    options;
+    /** The extensions of the built files the resolver owns, in any mode. */
+    static EXTENSIONS = ['.js', '.ts', '.jsx', '.tsx', '.cjs', '.mjs'];
+    logger;
+    rewriter;
+    outDir;
+    aliases;
+    constructor(data, projectRoot, options = {}) {
+        this.options = options;
+        this.logger = options.logger || new Logger({ name: 'PATH-RW' });
+        const outDir = data.outDir;
+        this.outDir = !Path.isAbsolute(outDir)
+            ? Path.resolve(projectRoot, outDir)
+            : outDir;
+        this.aliases = new AliasCompiler(projectRoot).compile(data);
+        this.rewriter = new PathRewriter(this.aliases);
+    }
+    /**
+     * The pattern that matches the built files the resolver owns, derived from the extensions it does.
+     * @returns The glob pattern of the files to rewrite.
+     **/
+    static get filter() {
+        return `**/*{${PathResolver.EXTENSIONS.map(extension => extension.slice(1)).join(',')}}`;
+    }
+    /**
+     * Resolves and rewrites paths in built files based on the provided mode (local or CDN).
+     * It processes all files in the output directory, rewriting import paths according to the configured aliases.
+     * @param mode - The resolution mode ('local' or 'cdn') to determine which target paths to use.
+     * @throws { Error } When any of the files could not be rewritten, reporting all of them.
+     *
+     * @remarks A file that cannot be rewritten is not a file that was left alone: a build that reports
+     * success while some of its files still point at the source tree is a build that cannot be
+     * deployed, so the failure travels up to whoever asked for the resolution.
+     */
+    async rewritePaths(mode) {
+        this.logger.log(`&C2Starting path resolver in &C3${mode} &C2mode for ${this.outDir}...`);
+        if (!await File.exists(this.outDir))
+            return void this.logger.warn(`Directory &C4${this.outDir}&R not found.`);
+        const files = await File.glob(PathResolver.filter, { cwd: this.outDir, absolute: false });
+        let rewrittenCount = 0;
+        const failed = [];
+        const limiter = Async.currencyLimiter(16);
+        await Promise.all(files.map((file) => limiter(async () => {
+            try {
+                if (await this.processFile(Path.join(this.outDir, file), mode))
+                    rewrittenCount += 1;
+            }
+            catch (error) {
+                failed.push(`${file}: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        })));
+        if (failed.length > 0)
+            throw new Error(`Path resolver failed to rewrite ${failed.length} of ${files.length} file(s):\n${failed.join('\n')}`);
+        this.logger.log(`&C2Path aliases resolved in &C3${rewrittenCount} &C2files.`);
+    }
+    /**
+     * Processes a single file, rewriting import paths based on the configured aliases and the specified mode (local or CDN).
+     * It reads the file content, applies the path rewriting logic, and writes the updated content back to the file system if any changes were made.
+     * @param file - The path of the file to process.
+     * @param mode - The resolution mode ('local' or 'cdn') to determine which target paths to use for rewriting.
+     * @returns A boolean indicating whether the file was modified (true if rewritten, false if no changes were made).
+     * @throws { Error } When the file cannot be read, rewritten or written.
+     */
+    async processFile(file, mode) {
+        const content = await FSP.readFile(file, 'utf8');
+        const newContent = this.rewriter.rewrite(content, file, mode);
+        if (content === newContent)
+            return false;
+        await FSP.writeFile(file, newContent, 'utf8');
+        return true;
+    }
+    /**
+     * Watches the output directory for changes and automatically rewrites paths in modified files based on the configured aliases and specified mode (local or CDN).
+     * It sets up a file system watcher that listens for changes in the output directory, and when a relevant file is modified, it triggers the path rewriting process for that file.
+     * The method includes debouncing to prevent excessive processing during rapid file changes, ensuring efficient handling of updates while maintaining responsiveness.
+     * @param mode - The resolution mode ('local' or 'cdn') to determine which target paths to use for rewriting when changes are detected.
+     * @returns A promise that resolves when the watcher is set up and running, allowing the application to continue monitoring for changes indefinitely until manually stopped.
+     * @throws Will throw an error if there is an issue setting up the file system watcher or processing files, which can be caught by the caller to handle it appropriately.
+     */
+    async watch(mode) {
+        await this.rewritePaths(mode);
+        this.logger.log(`&C2Watching for changes in &C4${this.outDir}...`);
+        const debouncedProcessor = PathResolver.debounce(async (fullPath, filename) => {
+            try {
+                if (await this.processFile(fullPath, mode)) {
+                    this.logger.log(`&C2File &C4${filename}&C2 updated.`);
+                }
+            }
+            catch (error) {
+                this.logger.error(`Failed to process file &C4${filename}&C7: &C1${error instanceof Error ? error.message : String(error)}`);
+            }
+        }, 300);
+        FS.watch(this.outDir, { recursive: true }, (eventType, filename) => {
+            if (!filename)
+                return;
+            const isTargetExtension = PathResolver.EXTENSIONS.some(ext => filename.endsWith(ext));
+            if (!isTargetExtension)
+                return;
+            const fullPath = Path.join(this.outDir, filename);
+            debouncedProcessor(fullPath, filename);
+        });
+    }
+    /**
+     * Debounces a function so it only executes after the specified delay has passed since the last invocation.
+     * @param fn - The function to debounce.
+     * @param delay - The number of milliseconds to wait before executing the function.
+     * @returns A debounced version of the function that delays its execution.
+     */
+    static debounce(fn, delay) {
+        let timeoutId = null;
+        return function (...args) {
+            if (timeoutId)
+                clearTimeout(timeoutId);
+            timeoutId = setTimeout(() => {
+                fn.apply(this, args);
+                timeoutId = null;
+            }, delay);
+        };
+    }
+}
+export default PathResolver;
+//# sourceMappingURL=PathResolver.js.map

package/dist/resolve/PathResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathResolver.js","sourceRoot":"","sources":["../../src/resolve/PathResolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,EAAE,EAAE,QAAQ,IAAI,GAAG,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAG/C,MAAM,OAAO,YAAY;IAYD,OAAO;IAX3B,wEAAwE;IACjE,MAAM,CAAU,UAAU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhE,MAAM,CAAS;IACf,QAAQ,CAAe;IACvB,MAAM,CAAS;IAClB,OAAO,CAAgC;IAEvD,YACI,IAAmB,EACnB,WAAmB,EACH,OAAO,GAAyB,EAAE;uBAAlC,OAAO;QAEvB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAEhE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAClC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC;YACnC,CAAC,CAAC,MAAM,CAAC;QAEb,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC;IACD;;;QAGI;IACI,MAAM,KAAK,MAAM;QACrB,OAAO,QAAQ,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7F,CAAC;IACD;;;;;;;;;OASG;IACI,KAAK,CAAC,YAAY,CAAC,IAAuB;QAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mCAAmC,IAAI,gBAAgB,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;QAEzF,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,eAAe,CAAC,CAAC;QAE9G,MAAM,KAAK,GAAa,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEpG,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,IAAI,CAAC;gBACD,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC;oBAAE,cAAc,IAAI,CAAC,CAAC;YACxF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtF,CAAC;QACL,CAAC,CAAC,CAAC,CAAC,CAAC;QAEL,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,MAAM,OAAO,KAAK,CAAC,MAAM,cAAc,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7I,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kCAAkC,cAAc,YAAY,CAAC,CAAC;IAClF,CAAC;IACD;;;;;;;OAOG;IACO,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,IAAuB;QAC7D,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAE9D,IAAI,OAAO,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAEzC,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAAC,IAAuB;QACtC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;QAEnE,MAAM,kBAAkB,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAgB,EAAE,QAAgB,EAAE,EAAE;YAC1F,IAAI,CAAC;gBACD,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;oBACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,QAAQ,cAAc,CAAC,CAAC;gBAC1D,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,QAAQ,WAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAChI,CAAC;QACL,CAAC,EAAE,GAAG,CAAC,CAAC;QAER,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;YAC/D,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAEtB,MAAM,iBAAiB,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACtF,IAAI,CAAC,iBAAiB;gBAAE,OAAO;YAE/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAClD,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACP,CAAC;IACD;;;;;OAKG;IACK,MAAM,CAAC,QAAQ,CACnB,EAA2B,EAC3B,KAAa;QAEb,IAAI,SAAS,GAA0B,IAAI,CAAC;QAC5C,OAAO,UAAoB,GAAG,IAAU;YACpC,IAAI,SAAS;gBAAE,YAAY,CAAC,SAAS,CAAC,CAAC;YACvC,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBACxB,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACrB,SAAS,GAAG,IAAI,CAAC;YACrB,CAAC,EAAE,KAAK,CAAC,CAAC;QACd,CAAC,CAAC;IACN,CAAC;CACJ;AAOD,eAAe,YAAY,CAAC"}

package/dist/resolve/PathRewriter.d.ts

@@ -0,0 +1,24 @@
+import AliasCompiler from "./AliasCompiler.js";
+export declare class PathRewriter {
+    private readonly aliases;
+    static readonly IMPORT_REGEX: RegExp;
+    constructor(aliases: AliasCompiler.CompiledAlias[]);
+    /**
+     * Rewrites import paths in the given content based on the configured aliases.
+     * It detects import statements and replaces alias paths with their resolved targets.
+     * @param content - The file content to rewrite.
+     * @param filePath - The path of the file being processed (used for relative path calculations).
+     * @param mode - The resolution mode ('local' or 'cdn') to determine which target to use.
+     * @returns The rewritten content with resolved import paths.
+     */
+    rewrite(content: string, filePath: string, mode: 'local' | 'cdn'): string;
+    /**
+     * The specifier of an import, which is never a file system path: the separator it is written with
+     * is the one of the module system, not the one of the machine that wrote it.
+     * @param target - The target of the import, as the file system spells it.
+     * @returns The target written with the separator an import is written with.
+     **/
+    protected static posix(target: string): string;
+}
+export declare namespace PathRewriter { }
+export default PathRewriter;

package/{build/support/PathResolver → dist/resolve}/PathRewriter.js

@@ -1,19 +1,21 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Rewrites import statements in file content using compiled aliases.
+ * @license Apache-2.0
+ */
 import PATH from "node:path";
-import { Path } from "@netfeez/common-node";
 export class PathRewriter {
     aliases;
-    projectRoot;
     static IMPORT_REGEX = /(from\s+['"])([^'"]+)(['"])/g;
-    constructor(aliases, projectRoot) {
+    constructor(aliases) {
         this.aliases = aliases;
-        this.projectRoot = projectRoot;
     }
     /**
      * Rewrites import paths in the given content based on the configured aliases.
      * It detects import statements and replaces alias paths with their resolved targets.
-     * @param content The file content to rewrite.
-     * @param filePath The path of the file being processed (used for relative path calculations).
-     * @param mode The resolution mode ('local' or 'cdn') to determine which target to use.
+     * @param content - The file content to rewrite.
+     * @param filePath - The path of the file being processed (used for relative path calculations).
+     * @param mode - The resolution mode ('local' or 'cdn') to determine which target to use.
      * @returns The rewritten content with resolved import paths.
      */
     rewrite(content, filePath, mode) {
@@ -36,12 +38,20 @@ export class PathRewriter {
             if (isCDN)
                 return `${prefix}${resolvedPath}${suffix}`;
             const currentFileDir = PATH.dirname(filePath);
-            let relativeTarget = PATH.relative(currentFileDir, resolvedPath);
-            if (!relativeTarget.startsWith('.'))
-                relativeTarget = `./${relativeTarget}`;
-            return `${prefix}${Path.normalize(relativeTarget)}${suffix}`;
+            const relative = PATH.relative(currentFileDir, resolvedPath);
+            const relativeTarget = relative.startsWith('.') ? relative : `./${relative}`;
+            return `${prefix}${PathRewriter.posix(relativeTarget)}${suffix}`;
         });
     }
+    /**
+     * The specifier of an import, which is never a file system path: the separator it is written with
+     * is the one of the module system, not the one of the machine that wrote it.
+     * @param target - The target of the import, as the file system spells it.
+     * @returns The target written with the separator an import is written with.
+     **/
+    static posix(target) {
+        return target.split(PATH.sep).join('/');
+    }
 }
 export default PathRewriter;
 //# sourceMappingURL=PathRewriter.js.map

package/dist/resolve/PathRewriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathRewriter.js","sourceRoot":"","sources":["../../src/resolve/PathRewriter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,IAAI,MAAM,WAAW,CAAC;AAI7B,MAAM,OAAO,YAAY;IAGA,OAAO;IAFrB,MAAM,CAAU,YAAY,GAAG,8BAA8B,CAAC;IACrE,YACqB,OAAsC;uBAAtC,OAAO;IACzB,CAAC;IACJ;;;;;;;OAOG;IACI,OAAO,CAAC,OAAe,EAAE,QAAgB,EAAE,IAAqB;QACnE,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE;YACpF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;YAEtH,IAAI,CAAC,QAAQ;gBAAE,OAAO,KAAK,CAAC;YAE5B,MAAM,KAAK,GAAG,IAAI,KAAK,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC;YACrD,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;YAE1E,IAAI,YAAoB,CAAC;YACzB,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACtB,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAChE,YAAY,GAAG,KAAK;oBAChB,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,OAAO,EAAE;oBAC/C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACJ,YAAY,GAAG,UAAU,CAAC;YAC9B,CAAC;YAED,IAAI,KAAK;gBAAE,OAAO,GAAG,MAAM,GAAG,YAAY,GAAG,MAAM,EAAE,CAAC;YAEtD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YAE7E,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,MAAM,EAAE,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC;IACD;;;;;QAKI;IACM,MAAM,CAAC,KAAK,CAAC,MAAc;QACjC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;CACJ;AAED,eAAe,YAAY,CAAC"}