@eighty4/dank 0.0.5-2 → 0.0.5-4

package/lib_js/registry.js

@@ -11,6 +11,7 @@ class WebsiteRegistry extends EventEmitter {
   #copiedAssets = null;
   // map of entrypoints to their output path
   #entrypointHrefs = {};
+  #otherOutputs = null;
   #pages = {};
   #resolver;
   #workers = null;
@@ -28,6 +29,13 @@ class WebsiteRegistry extends EventEmitter {
   get htmlEntrypoints() {
     return Object.values(this.#pages).map((p) => p.html);
   }
+  async manifest() {
+    return {
+      buildTag: await this.#c.buildTag(),
+      files: this.files(),
+      pageUrls: Object.keys(this.#pages)
+    };
+  }
   get pageUrls() {
     return Object.keys(this.#pages);
   }
@@ -71,6 +79,18 @@ class WebsiteRegistry extends EventEmitter {
   get workers() {
     return this.#workers;
   }
+  // add a build output that does is manually injected into build output,
+  // not from HTML processing, public directory, or esbuild entrypoints
+  async addBuildOutput(url, content) {
+    if (this.#pages[url] || this.#bundles.has(url) || this.#otherOutputs?.has(url) || this.#copiedAssets?.has(url)) {
+      throw Error("build already has a " + url);
+    }
+    if (this.#otherOutputs === null)
+      this.#otherOutputs = /* @__PURE__ */ new Set();
+    this.#otherOutputs.add(url);
+    const outputPath = join(this.#c.dirs.projectRootAbs, this.#c.dirs.buildDist, url);
+    await writeFile(outputPath, content);
+  }
   buildRegistry() {
     return new BuildRegistry(this.#c.dirs, this.#resolver, this.#onBuildManifest);
   }
@@ -86,7 +106,10 @@ class WebsiteRegistry extends EventEmitter {
     if (this.#copiedAssets)
       for (const f of this.#copiedAssets)
         files.add(f);
-    return files;
+    if (this.#otherOutputs)
+      for (const f of this.#otherOutputs)
+        files.add(f);
+    return Array.from(files);
   }
   mappedHref(lookup) {
     const found = this.#entrypointHrefs[lookup];
@@ -96,13 +119,9 @@ class WebsiteRegistry extends EventEmitter {
       throw Error(`mapped href for ${lookup} not found`);
     }
   }
-  async writeManifest(buildTag) {
-    const manifest = this.#manifest(buildTag);
-    await writeFile(join(this.#c.dirs.projectRootAbs, this.#c.dirs.buildRoot, "website.json"), JSON.stringify({
-      buildTag,
-      files: Array.from(manifest.files),
-      pageUrls: Array.from(manifest.pageUrls)
-    }, null, 4));
+  async writeManifest() {
+    const manifest = await this.#manifest();
+    await writeFile(join(this.#c.dirs.projectRootAbs, this.#c.dirs.buildRoot, "website.json"), JSON.stringify(manifest, null, 4));
     return manifest;
   }
   #configDiff() {
@@ -155,16 +174,16 @@ class WebsiteRegistry extends EventEmitter {
     registration.html.removeAllListeners();
     delete this.#pages[urlPath];
   }
-  #manifest(buildTag) {
+  async #manifest() {
     return {
-      buildTag,
+      buildTag: await this.#c.buildTag(),
       files: this.files(),
-      pageUrls: new Set(Object.keys(this.#pages))
+      pageUrls: Object.keys(this.#pages)
     };
   }
   #onBuildManifest = (build) => {
     for (const [outPath, entrypoint] of Object.entries(build.bundles)) {
-      this.#bundles.add(outPath);
+      this.#bundles.add(ensurePath(outPath));
       if (entrypoint) {
         this.#entrypointHrefs[entrypoint] = outPath;
       }
@@ -229,7 +248,7 @@ class BuildRegistry {
   completeBuild(result) {
     const bundles = {};
     for (const [outPath, output] of Object.entries(result.metafile.outputs)) {
-      bundles[outPath.replace(/^build[/\\]dist/, "")] = output.entryPoint || null;
+      bundles[outPath.replace(/^build[/\\](dist|watch)/, "")] = output.entryPoint || null;
     }
     let workers = null;
     if (this.#workers) {
@@ -254,6 +273,13 @@ class BuildRegistry {
     });
   }
 }
+function ensurePath(path) {
+  if (path.startsWith("/")) {
+    return path;
+  } else {
+    throw Error(`expect build dist path ${path} to start with /`);
+  }
+}
 export {
   BuildRegistry,
   WebsiteRegistry

package/lib_js/service_worker.js

@@ -0,0 +1,47 @@
+import { join } from "node:path";
+import esbuild from "esbuild";
+async function createServiceWorker(caching) {
+  return {
+    outputs: [
+      {
+        content: await buildServiceWorkerBackend(caching),
+        url: "/sw.js"
+      }
+    ]
+  };
+}
+async function buildServiceWorkerBackend(caching) {
+  const result = await esbuild.build({
+    logLevel: "silent",
+    absWorkingDir: join(import.meta.dirname, "../client"),
+    entryPoints: ["ServiceWorker.ts"],
+    treeShaking: true,
+    target: "ES2022",
+    bundle: true,
+    minify: true,
+    format: "iife",
+    platform: "browser",
+    write: false,
+    metafile: true,
+    plugins: [
+      {
+        name: "DANK:sw",
+        setup(build) {
+          build.onResolve({ filter: /DANK:sw/ }, () => {
+            return {
+              path: join(import.meta.dirname, "DANK.sw.json")
+            };
+          });
+          build.onLoad({ filter: /DANK\.sw\.json$/, namespace: "file" }, async () => ({
+            contents: JSON.stringify(caching),
+            loader: "json"
+          }));
+        }
+      }
+    ]
+  });
+  return new TextDecoder().decode(result.outputFiles[0].contents);
+}
+export {
+  createServiceWorker
+};

package/lib_types/dank.d.ts

@@ -1,12 +1,18 @@
 import type { Plugin as EsbuildPlugin } from 'esbuild';
 export type DankConfig = {
+    buildTag?: string | BuildTagBuilder;
     esbuild?: EsbuildConfig;
     pages: Record<`/${string}`, `${string}.html` | PageMapping>;
     devPages?: Record<`/__${string}`, `${string}.html` | DevPageMapping>;
     port?: number;
     previewPort?: number;
     services?: Array<DevService>;
+    serviceWorker?: ServiceWorkerBuilder;
 };
+export type BuildTagParams = {
+    production: boolean;
+};
+export type BuildTagBuilder = (build: BuildTagParams) => Promise<string> | string;
 export type PageMapping = {
     pattern?: RegExp;
     webpage: `${string}.html`;
@@ -37,3 +43,19 @@ export type DankDetails = {
 export type DankConfigFunction = (dank: DankDetails) => Partial<DankConfig> | Promise<Partial<DankConfig>>;
 export declare function defineConfig(config: Partial<DankConfig>): Partial<DankConfig>;
 export declare function defineConfig(config: DankConfigFunction): DankConfigFunction;
+export type WebsiteManifest = {
+    buildTag: string;
+    files: Array<`/${string}`>;
+    pageUrls: Array<`/${string}`>;
+};
+export type ServiceWorkerParams = {
+    website: WebsiteManifest;
+};
+export type ServiceWorkerBuild = {
+    outputs: Array<{
+        url: `/${string}.js`;
+        content: string;
+    }>;
+};
+export type ServiceWorkerBuilder = (params: ServiceWorkerParams) => ServiceWorkerBuild | Promise<ServiceWorkerBuild>;
+export { createServiceWorker, type ServiceWorkerCaching, } from './service_worker.ts';

package/lib_types/service_worker.d.ts

@@ -0,0 +1,10 @@
+import type { ServiceWorkerBuild } from './dank.ts';
+export type ServiceWorkerCaching = {
+    cacheKey: string;
+    bypassCache?: {
+        hosts?: Array<string>;
+        paths?: Array<`/${string}`>;
+    };
+    files: Array<`/${string}`>;
+};
+export declare function createServiceWorker(caching: ServiceWorkerCaching): Promise<ServiceWorkerBuild>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eighty4/dank",
-  "version": "0.0.5-2",
+  "version": "0.0.5-4",
   "type": "module",
   "license": "MIT",
   "author": "Adam McKee Bennett <adam.be.g84d@gmail.com>",
@@ -38,6 +38,7 @@
   },
   "files": [
     "client/client.js",
+    "client/ServiceWorker.ts",
     "lib/*.ts",
     "lib_js/*.js",
     "lib_types/*.d.ts"
@@ -45,7 +46,7 @@
   "scripts": {
     "build": "pnpm build:client && pnpm build:lib",
     "build:client": "node scripts/build_client.ts",
-    "build:lib": "tsc && tsc -p tsconfig.exports.json",
+    "build:lib": "tsc && tsc -p tsconfig.exports.json && tsc -p tsconfig.sw.json",
     "build:release": "pnpm build && node scripts/prepare_release.ts",
     "fmt": "prettier --write .",
     "fmtcheck": "prettier --check .",