@eighty4/dank 0.0.5-4 → 0.0.5-6

package/lib/config.ts

@@ -3,6 +3,7 @@ import { createBuildTag } from './build_tag.ts'
 import type {
     DankConfig,
     DankDetails,
+    DevPageMapping,
     EsbuildConfig,
     PageMapping,
     ServiceWorkerBuilder,
@@ -33,12 +34,16 @@ export type ResolvedDankConfig = {
     get esbuildPort(): number
     get esbuild(): Readonly<Omit<EsbuildConfig, 'port'>> | undefined
     get pages(): Readonly<Record<`/${string}`, PageMapping>>
-    get devPages(): Readonly<DankConfig['devPages']>
+    get devPages(): Readonly<
+        Record<`/${string}`, Omit<DevPageMapping & PageMapping, 'pattern'>>
+    >
     get services(): Readonly<DankConfig['services']>
     get serviceWorkerBuilder(): DankConfig['serviceWorker']
 
     buildTag(): Promise<string>
 
+    pageMappings(): Record<`/${string}`, PageMapping>
+
     reload(): Promise<void>
 }
 
@@ -77,7 +82,7 @@ class DankConfigInternal implements ResolvedDankConfig {
     #esbuildPort: number = DEFAULT_ESBUILD_PORT
     #esbuild: Readonly<Omit<EsbuildConfig, 'port'>> | undefined
     #pages: Readonly<Record<`/${string}`, PageMapping>> = {}
-    #devPages: Readonly<DankConfig['devPages']>
+    #devPages: Readonly<ResolvedDankConfig['devPages']> = {}
     #services: Readonly<DankConfig['services']>
 
     constructor(
@@ -119,7 +124,7 @@ class DankConfigInternal implements ResolvedDankConfig {
         return this.#pages
     }
 
-    get devPages(): Readonly<DankConfig['devPages']> {
+    get devPages(): Readonly<ResolvedDankConfig['devPages']> {
         return this.#devPages
     }
 
@@ -142,6 +147,17 @@ class DankConfigInternal implements ResolvedDankConfig {
         return this.#buildTag
     }
 
+    pageMappings(): ResolvedDankConfig['pages'] {
+        if (this.#mode === 'serve') {
+            return {
+                ...this.#pages,
+                ...this.#devPages,
+            }
+        } else {
+            return this.#pages
+        }
+    }
+
     async reload() {
         const userConfig = await resolveConfig(
             this.#modulePath,
@@ -153,7 +169,7 @@ class DankConfigInternal implements ResolvedDankConfig {
         this.#esbuildPort = resolveEsbuildPort(this.#flags, userConfig)
         this.#esbuild = Object.freeze(userConfig.esbuild)
         this.#pages = Object.freeze(normalizePages(userConfig.pages))
-        this.#devPages = Object.freeze(userConfig.devPages)
+        this.#devPages = Object.freeze(normalizeDevPages(userConfig.devPages))
         this.#services = Object.freeze(userConfig.services)
         this.#serviceWorkerBuilder = userConfig.serviceWorker
     }
@@ -433,3 +449,27 @@ function normalizePages(
     }
     return result
 }
+
+function normalizeDevPages(
+    pages: DankConfig['devPages'],
+): Record<string, Omit<DevPageMapping & PageMapping, 'pattern'>> {
+    if (pages) {
+        const result: Record<
+            string,
+            Omit<DevPageMapping & PageMapping, 'pattern'>
+        > = {}
+        for (const [url, mapping] of Object.entries(pages)) {
+            if (typeof mapping === 'string') {
+                result[url] = {
+                    label: '',
+                    webpage: mapping,
+                }
+            } else {
+                result[url] = mapping
+            }
+        }
+        return result
+    } else {
+        return {}
+    }
+}

package/lib/dirs.ts

@@ -60,29 +60,62 @@ export class Resolver {
         return join(this.#dirs.projectRootAbs, ...p)
     }
 
-    // `p` is expected to be a relative path resolvable from the project dir
-    isProjectSubpathInPagesDir(p: string): boolean {
-        return resolve(join(this.#dirs.projectRootAbs, p)).startsWith(
+    isPagesSubpathResolvedToPagesDirSubpath(p: string): boolean {
+        return verifySubpathInRoot(this.#dirs.pagesAbs, this.#dirs.pagesAbs, p)
+    }
+
+    isPagesSubpathResolvedToProjectDirSubpath(p: string): boolean {
+        return verifySubpathInRoot(
+            this.#dirs.pagesAbs,
+            this.#dirs.projectRootAbs,
+            p,
+        )
+    }
+
+    isProjectSubpathResolvedToPagesDirSubpath(p: string): boolean {
+        return verifySubpathInRoot(
+            this.#dirs.projectRootAbs,
             this.#dirs.pagesAbs,
+            p,
         )
     }
 
-    // `p` is expected to be a relative path resolvable from the pages dir
-    isPagesSubpathInPagesDir(p: string): boolean {
-        return this.isProjectSubpathInPagesDir(join(this.#dirs.pages, p))
+    isProjectSubpathResolvedToProjectDirSubpath(p: string): boolean {
+        return verifySubpathInRoot(
+            this.#dirs.projectRootAbs,
+            this.#dirs.projectRootAbs,
+            p,
+        )
     }
 
     projectPathFromAbsolute(p: string) {
         return p.replace(this.#dirs.projectRootAbs, '').substring(1)
     }
 
-    // resolve a pages subpath from a resource within the pages directory by a relative href
     // `from` is expected to be a pages resource fs path starting with `pages/` and ending with filename
-    // the result will be a pages subpath and will not have the pages dir prefix
-    // returns 'outofbounds' if the relative path does not resolve to a file within the pages dir
-    resolveHrefInPagesDir(from: string, href: string): string | ResolveError {
+    // `href` is a source relative path to another source used by a script src, link href or Worker ctor URL
+    // returns 'outofbounds' if the resolved path is not in the pages directory
+    resolvePagesRelativeHrefInPagesDir(
+        from: string,
+        href: string,
+    ): string | ResolveError {
         const p = join(dirname(from), href)
-        if (this.isProjectSubpathInPagesDir(p)) {
+        if (this.isProjectSubpathResolvedToPagesDirSubpath(p)) {
+            return p
+        } else {
+            return 'outofbounds'
+        }
+    }
+
+    // `from` is expected to be a pages resource fs path starting with `pages/` and ending with filename
+    // `href` is a source relative path to another source used by a script src, link href or Worker ctor URL
+    // returns 'outofbounds' if the resolved path is not in the project directory
+    resolvePagesRelativeHrefInProjectDir(
+        from: string,
+        href: string,
+    ): string | ResolveError {
+        const p = join(dirname(from), href)
+        if (this.isProjectSubpathResolvedToProjectDirSubpath(p)) {
             return p
         } else {
             return 'outofbounds'
@@ -90,6 +123,14 @@ export class Resolver {
     }
 }
 
+function verifySubpathInRoot(
+    resolveFrom: string,
+    expectWithin: string,
+    testSubpath: string,
+): boolean {
+    return resolve(join(resolveFrom, testSubpath)).startsWith(expectWithin)
+}
+
 class WindowsResolver extends Resolver {
     constructor(dirs: DankDirectories) {
         super(dirs)
@@ -99,7 +140,21 @@ class WindowsResolver extends Resolver {
         return super.projectPathFromAbsolute(p).replaceAll('\\', '/')
     }
 
-    resolveHrefInPagesDir(from: string, href: string): string | ResolveError {
-        return super.resolveHrefInPagesDir(from, href).replaceAll('\\', '/')
+    resolvePagesRelativeHrefInPagesDir(
+        from: string,
+        href: string,
+    ): string | ResolveError {
+        return super
+            .resolvePagesRelativeHrefInPagesDir(from, href)
+            .replaceAll('\\', '/')
+    }
+
+    resolvePagesRelativeHrefInProjectDir(
+        from: string,
+        href: string,
+    ): string | ResolveError {
+        return super
+            .resolvePagesRelativeHrefInProjectDir(from, href)
+            .replaceAll('\\', '/')
     }
 }

package/lib/esbuild.ts

@@ -156,10 +156,11 @@ export function workersPlugin(r: BuildRegistry): Plugin {
                         1,
                         workerCtorMatch.groups!.url.length - 1,
                     )
-                    const workerEntryPoint = r.resolver.resolveHrefInPagesDir(
-                        clientScript,
-                        workerUrl,
-                    )
+                    const workerEntryPoint =
+                        r.resolver.resolvePagesRelativeHrefInProjectDir(
+                            clientScript,
+                            workerUrl,
+                        )
                     if (workerEntryPoint === 'outofbounds') {
                         if (!errors) errors = []
                         errors.push(
@@ -256,7 +257,7 @@ function outofboundsWorkerUrlCtorArg(
 ): PartialMessage {
     return {
         id: 'worker-url-outofbounds',
-        text: `The ${workerCtorMatch.groups!.ctor} constructor URL arg \`${workerCtorMatch.groups!.url}\` cannot resolve to a path outside of the pages directory`,
+        text: `The ${workerCtorMatch.groups!.ctor} constructor URL arg \`${workerCtorMatch.groups!.url}\` cannot resolve to a path outside of the project directory`,
         location,
     }
 }

package/lib/html.ts

@@ -237,7 +237,11 @@ export class HtmlEntrypoint extends EventEmitter<HtmlEntrypointEvents> {
                     )
                     return false
                 }
-                if (!this.#resolver.isPagesSubpathInPagesDir(p.fsPath)) {
+                if (
+                    !this.#resolver.isPagesSubpathResolvedToPagesDirSubpath(
+                        p.fsPath,
+                    )
+                ) {
                     this.#error(
                         `partials cannot be referenced from outside the pages dir like \`${p.specifier}\` in webpage \`${join(this.#c.dirs.pages, this.#fsPath)}\``,
                     )
@@ -395,7 +399,7 @@ export class HtmlEntrypoint extends EventEmitter<HtmlEntrypointEvents> {
         elem: Element,
     ): ImportedScript {
         const inPath = join(this.#c.dirs.pages, dirname(this.#fsPath), href)
-        if (!this.#resolver.isProjectSubpathInPagesDir(inPath)) {
+        if (!this.#resolver.isPagesSubpathResolvedToPagesDirSubpath(inPath)) {
             throw new DankError(
                 `href \`${href}\` in webpage \`${join(this.#c.dirs.pages, this.#fsPath)}\` cannot reference sources outside of the pages directory`,
             )

package/lib/registry.ts

@@ -231,11 +231,10 @@ export class WebsiteRegistry extends EventEmitter<WebsiteRegistryEvents> {
     }
 
     #configDiff() {
-        const updatePages: ResolvedDankConfig['pages'] = this.#c.devPages
-            ? { ...this.#c.pages, ...this.#c.devPages }
-            : { ...this.#c.pages }
         const prevPages = new Set(Object.keys(this.#pages))
-        for (const [urlPath, mapping] of Object.entries(updatePages)) {
+        for (const [urlPath, mapping] of Object.entries(
+            this.#c.pageMappings(),
+        )) {
             const existingPage = prevPages.delete(urlPath as `/${string}`)
             if (existingPage) {
                 this.#configPageUpdate(urlPath as `/${string}`, mapping)

package/lib_js/config.js

@@ -36,7 +36,7 @@ class DankConfigInternal {
   #esbuildPort = DEFAULT_ESBUILD_PORT;
   #esbuild;
   #pages = {};
-  #devPages;
+  #devPages = {};
   #services;
   constructor(mode, modulePath, dirs) {
     this.#dirs = dirs;
@@ -80,6 +80,16 @@ class DankConfigInternal {
     }
     return this.#buildTag;
   }
+  pageMappings() {
+    if (this.#mode === "serve") {
+      return {
+        ...this.#pages,
+        ...this.#devPages
+      };
+    } else {
+      return this.#pages;
+    }
+  }
   async reload() {
     const userConfig = await resolveConfig(this.#modulePath, resolveDankDetails(this.#mode, this.#flags));
     this.#buildTag = null;
@@ -88,7 +98,7 @@ class DankConfigInternal {
     this.#esbuildPort = resolveEsbuildPort(this.#flags, userConfig);
     this.#esbuild = Object.freeze(userConfig.esbuild);
     this.#pages = Object.freeze(normalizePages(userConfig.pages));
-    this.#devPages = Object.freeze(userConfig.devPages);
+    this.#devPages = Object.freeze(normalizeDevPages(userConfig.devPages));
     this.#services = Object.freeze(userConfig.services);
     this.#serviceWorkerBuilder = userConfig.serviceWorker;
   }
@@ -280,6 +290,24 @@ function normalizePages(pages) {
   }
   return result;
 }
+function normalizeDevPages(pages) {
+  if (pages) {
+    const result = {};
+    for (const [url, mapping] of Object.entries(pages)) {
+      if (typeof mapping === "string") {
+        result[url] = {
+          label: "",
+          webpage: mapping
+        };
+      } else {
+        result[url] = mapping;
+      }
+    }
+    return result;
+  } else {
+    return {};
+  }
+}
 export {
   loadConfig
 };

package/lib_js/dirs.js

@@ -38,30 +38,47 @@ class Resolver {
   absProjectPath(...p) {
     return join(this.#dirs.projectRootAbs, ...p);
   }
-  // `p` is expected to be a relative path resolvable from the project dir
-  isProjectSubpathInPagesDir(p) {
-    return resolve(join(this.#dirs.projectRootAbs, p)).startsWith(this.#dirs.pagesAbs);
+  isPagesSubpathResolvedToPagesDirSubpath(p) {
+    return verifySubpathInRoot(this.#dirs.pagesAbs, this.#dirs.pagesAbs, p);
   }
-  // `p` is expected to be a relative path resolvable from the pages dir
-  isPagesSubpathInPagesDir(p) {
-    return this.isProjectSubpathInPagesDir(join(this.#dirs.pages, p));
+  isPagesSubpathResolvedToProjectDirSubpath(p) {
+    return verifySubpathInRoot(this.#dirs.pagesAbs, this.#dirs.projectRootAbs, p);
+  }
+  isProjectSubpathResolvedToPagesDirSubpath(p) {
+    return verifySubpathInRoot(this.#dirs.projectRootAbs, this.#dirs.pagesAbs, p);
+  }
+  isProjectSubpathResolvedToProjectDirSubpath(p) {
+    return verifySubpathInRoot(this.#dirs.projectRootAbs, this.#dirs.projectRootAbs, p);
   }
   projectPathFromAbsolute(p) {
     return p.replace(this.#dirs.projectRootAbs, "").substring(1);
   }
-  // resolve a pages subpath from a resource within the pages directory by a relative href
   // `from` is expected to be a pages resource fs path starting with `pages/` and ending with filename
-  // the result will be a pages subpath and will not have the pages dir prefix
-  // returns 'outofbounds' if the relative path does not resolve to a file within the pages dir
-  resolveHrefInPagesDir(from, href) {
+  // `href` is a source relative path to another source used by a script src, link href or Worker ctor URL
+  // returns 'outofbounds' if the resolved path is not in the pages directory
+  resolvePagesRelativeHrefInPagesDir(from, href) {
     const p = join(dirname(from), href);
-    if (this.isProjectSubpathInPagesDir(p)) {
+    if (this.isProjectSubpathResolvedToPagesDirSubpath(p)) {
+      return p;
+    } else {
+      return "outofbounds";
+    }
+  }
+  // `from` is expected to be a pages resource fs path starting with `pages/` and ending with filename
+  // `href` is a source relative path to another source used by a script src, link href or Worker ctor URL
+  // returns 'outofbounds' if the resolved path is not in the project directory
+  resolvePagesRelativeHrefInProjectDir(from, href) {
+    const p = join(dirname(from), href);
+    if (this.isProjectSubpathResolvedToProjectDirSubpath(p)) {
       return p;
     } else {
       return "outofbounds";
     }
   }
 }
+function verifySubpathInRoot(resolveFrom, expectWithin, testSubpath) {
+  return resolve(join(resolveFrom, testSubpath)).startsWith(expectWithin);
+}
 class WindowsResolver extends Resolver {
   constructor(dirs) {
     super(dirs);
@@ -69,8 +86,11 @@ class WindowsResolver extends Resolver {
   projectPathFromAbsolute(p) {
     return super.projectPathFromAbsolute(p).replaceAll("\\", "/");
   }
-  resolveHrefInPagesDir(from, href) {
-    return super.resolveHrefInPagesDir(from, href).replaceAll("\\", "/");
+  resolvePagesRelativeHrefInPagesDir(from, href) {
+    return super.resolvePagesRelativeHrefInPagesDir(from, href).replaceAll("\\", "/");
+  }
+  resolvePagesRelativeHrefInProjectDir(from, href) {
+    return super.resolvePagesRelativeHrefInProjectDir(from, href).replaceAll("\\", "/");
   }
 }
 export {

package/lib_js/esbuild.js

@@ -99,7 +99,7 @@ function workersPlugin(r) {
             clientScript = r.resolver.projectPathFromAbsolute(args.path);
           }
           const workerUrl = workerCtorMatch.groups.url.substring(1, workerCtorMatch.groups.url.length - 1);
-          const workerEntryPoint = r.resolver.resolveHrefInPagesDir(clientScript, workerUrl);
+          const workerEntryPoint = r.resolver.resolvePagesRelativeHrefInProjectDir(clientScript, workerUrl);
           if (workerEntryPoint === "outofbounds") {
             if (!errors)
               errors = [];
@@ -159,7 +159,7 @@ function locationFromMatch(args, contents, match) {
 function outofboundsWorkerUrlCtorArg(location, workerCtorMatch) {
   return {
     id: "worker-url-outofbounds",
-    text: `The ${workerCtorMatch.groups.ctor} constructor URL arg \`${workerCtorMatch.groups.url}\` cannot resolve to a path outside of the pages directory`,
+    text: `The ${workerCtorMatch.groups.ctor} constructor URL arg \`${workerCtorMatch.groups.url}\` cannot resolve to a path outside of the project directory`,
     location
   };
 }

package/lib_js/html.js

@@ -115,7 +115,7 @@ class HtmlEntrypoint extends EventEmitter {
         this.#error(`partials cannot be referenced with an absolute path like \`${p.specifier}\` in webpage \`${join(this.#c.dirs.pages, this.#fsPath)}\``);
         return false;
       }
-      if (!this.#resolver.isPagesSubpathInPagesDir(p.fsPath)) {
+      if (!this.#resolver.isPagesSubpathResolvedToPagesDirSubpath(p.fsPath)) {
         this.#error(`partials cannot be referenced from outside the pages dir like \`${p.specifier}\` in webpage \`${join(this.#c.dirs.pages, this.#fsPath)}\``);
         return false;
       }
@@ -222,7 +222,7 @@ class HtmlEntrypoint extends EventEmitter {
   }
   #parseImport(type, href, elem) {
     const inPath = join(this.#c.dirs.pages, dirname(this.#fsPath), href);
-    if (!this.#resolver.isProjectSubpathInPagesDir(inPath)) {
+    if (!this.#resolver.isPagesSubpathResolvedToPagesDirSubpath(inPath)) {
       throw new DankError(`href \`${href}\` in webpage \`${join(this.#c.dirs.pages, this.#fsPath)}\` cannot reference sources outside of the pages directory`);
     }
     let outPath = join(dirname(this.#fsPath), href);

package/lib_js/registry.js

@@ -125,9 +125,8 @@ class WebsiteRegistry extends EventEmitter {
     return manifest;
   }
   #configDiff() {
-    const updatePages = this.#c.devPages ? { ...this.#c.pages, ...this.#c.devPages } : { ...this.#c.pages };
     const prevPages = new Set(Object.keys(this.#pages));
-    for (const [urlPath, mapping] of Object.entries(updatePages)) {
+    for (const [urlPath, mapping] of Object.entries(this.#c.pageMappings())) {
       const existingPage = prevPages.delete(urlPath);
       if (existingPage) {
         this.#configPageUpdate(urlPath, mapping);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eighty4/dank",
-  "version": "0.0.5-4",
+  "version": "0.0.5-6",
   "type": "module",
   "license": "MIT",
   "author": "Adam McKee Bennett <adam.be.g84d@gmail.com>",