@async/framework 0.8.0 → 0.10.0

package/src/boundary-receiver.js

@@ -0,0 +1,302 @@
+const defaultRecentLimit = 50;
+
+export function createBoundaryReceiver(options = {}) {
+  const loader = options.loader;
+  const signals = options.signals ?? loader?.signals;
+  const cache = options.cache ?? loader?.cache;
+  const scheduler = options.scheduler ?? loader?.scheduler;
+  const router = options.router ?? loader?.router;
+  const recentLimit = options.recentLimit ?? defaultRecentLimit;
+  const throwOnError = options.throwOnError === true;
+  const onApply = typeof options.onApply === "function" ? options.onApply : undefined;
+  const onIgnore = typeof options.onIgnore === "function" ? options.onIgnore : undefined;
+  const onError = typeof options.onError === "function" ? options.onError : undefined;
+  const isScopeDestroyed = typeof options.isScopeDestroyed === "function"
+    ? options.isScopeDestroyed
+    : (scope) => scheduler?.isScopeDestroyed?.(scope) ?? scheduler?.inspectDestroyed?.(scope) ?? false;
+
+  if (!loader || typeof loader.swap !== "function") {
+    throw new TypeError("createBoundaryReceiver(...) requires a loader with swap(boundary, html).");
+  }
+  if (!Number.isInteger(recentLimit) || recentLimit < 0) {
+    throw new TypeError("createBoundaryReceiver(...) recentLimit must be a non-negative integer.");
+  }
+
+  const boundaries = new Map();
+  const recent = [];
+  let destroyed = false;
+
+  const receiver = {
+    async apply(patch) {
+      if (destroyed) {
+        throw new Error("Boundary receiver has been destroyed.");
+      }
+
+      const normalized = validatePatch(patch);
+      const record = boundaryRecord(normalized.boundary);
+      if (normalized.seq <= record.lastSeq) {
+        const result = {
+          status: "ignored-stale",
+          boundary: normalized.boundary,
+          seq: normalized.seq,
+          lastSeq: record.lastSeq
+        };
+        record.ignored += 1;
+        record.lastStatus = result.status;
+        remember(result);
+        onIgnore?.(result, patch);
+        return result;
+      }
+
+      if (normalized.parentScope !== undefined && isScopeDestroyed(normalized.parentScope)) {
+        const result = {
+          status: "ignored-destroyed",
+          boundary: normalized.boundary,
+          seq: normalized.seq,
+          parentScope: normalized.parentScope
+        };
+        record.ignored += 1;
+        record.lastStatus = result.status;
+        remember(result);
+        onIgnore?.(result, patch);
+        return result;
+      }
+
+      record.lastSeq = normalized.seq;
+
+      if (Object.hasOwn(normalized, "error")) {
+        const error = toStableError(normalized.error);
+        const result = {
+          status: "errored",
+          boundary: normalized.boundary,
+          seq: normalized.seq,
+          error
+        };
+        record.errored += 1;
+        record.lastStatus = result.status;
+        remember(result);
+        onError?.(error, result, patch);
+        if (throwOnError) {
+          throw error;
+        }
+        return result;
+      }
+
+      if (normalized.signals) {
+        if (!signals || typeof signals.set !== "function") {
+          throw new Error("Boundary patch includes signals, but no signal registry is available.");
+        }
+        for (const [path, value] of Object.entries(normalized.signals)) {
+          signals.set(path, value);
+        }
+      }
+
+      if (normalized.cache?.browser) {
+        if (!cache || typeof cache.restore !== "function") {
+          throw new Error("Boundary patch includes browser cache, but no cache registry is available.");
+        }
+        cache.restore(normalized.cache.browser);
+      }
+
+      if (normalized.html != null) {
+        loader.swap(normalized.boundary, normalized.html);
+      }
+
+      await flushScheduler(scheduler, normalized.scope);
+
+      if (normalized.redirect) {
+        await followRedirect(normalized.redirect, router, loader);
+        const result = {
+          status: "redirected",
+          boundary: normalized.boundary,
+          seq: normalized.seq,
+          redirect: normalized.redirect
+        };
+        record.applied += 1;
+        record.lastStatus = result.status;
+        remember(result);
+        onApply?.(result, patch);
+        return result;
+      }
+
+      const result = {
+        status: "applied",
+        boundary: normalized.boundary,
+        seq: normalized.seq
+      };
+      record.applied += 1;
+      record.lastStatus = result.status;
+      remember(result);
+      onApply?.(result, patch);
+      return result;
+    },
+
+    inspect() {
+      const snapshot = {};
+      for (const [boundary, record] of boundaries) {
+        snapshot[boundary] = {
+          lastSeq: record.lastSeq,
+          applied: record.applied,
+          ignored: record.ignored,
+          lastStatus: record.lastStatus
+        };
+        if (record.errored > 0) {
+          snapshot[boundary].errored = record.errored;
+        }
+      }
+      return {
+        destroyed,
+        boundaries: snapshot,
+        recent: recent.map((entry) => ({ ...entry }))
+      };
+    },
+
+    reset(boundary) {
+      if (boundary === undefined) {
+        boundaries.clear();
+        recent.length = 0;
+        return receiver;
+      }
+      assertBoundary(boundary);
+      boundaries.delete(boundary);
+      for (let index = recent.length - 1; index >= 0; index -= 1) {
+        if (recent[index].boundary === boundary) {
+          recent.splice(index, 1);
+        }
+      }
+      return receiver;
+    },
+
+    destroy() {
+      destroyed = true;
+      boundaries.clear();
+      recent.length = 0;
+    }
+  };
+
+  return receiver;
+
+  function boundaryRecord(boundary) {
+    if (!boundaries.has(boundary)) {
+      boundaries.set(boundary, {
+        lastSeq: -Infinity,
+        applied: 0,
+        ignored: 0,
+        errored: 0,
+        lastStatus: undefined
+      });
+    }
+    return boundaries.get(boundary);
+  }
+
+  function remember(result) {
+    if (recentLimit === 0) {
+      return;
+    }
+    recent.push(toRecentEntry(result));
+    while (recent.length > recentLimit) {
+      recent.shift();
+    }
+  }
+}
+
+function validatePatch(patch) {
+  if (!patch || typeof patch !== "object" || Array.isArray(patch)) {
+    throw new TypeError("receiver.apply(patch) requires a boundary patch object.");
+  }
+
+  assertBoundary(patch.boundary);
+  if (typeof patch.seq !== "number" || !Number.isFinite(patch.seq)) {
+    throw new TypeError("Boundary patch seq must be a finite number.");
+  }
+
+  if (patch.signals !== undefined && !isPlainObject(patch.signals)) {
+    throw new TypeError("Boundary patch signals must be an object.");
+  }
+  if (patch.cache !== undefined && !isPlainObject(patch.cache)) {
+    throw new TypeError("Boundary patch cache must be an object.");
+  }
+  if (patch.cache?.browser !== undefined && !isPlainObject(patch.cache.browser)) {
+    throw new TypeError("Boundary patch cache.browser must be an object.");
+  }
+  if (patch.redirect !== undefined && (typeof patch.redirect !== "string" || patch.redirect.length === 0)) {
+    throw new TypeError("Boundary patch redirect must be a non-empty string.");
+  }
+  if (patch.parentScope !== undefined && typeof patch.parentScope !== "string") {
+    throw new TypeError("Boundary patch parentScope must be a string.");
+  }
+  if (patch.scope !== undefined && typeof patch.scope !== "string") {
+    throw new TypeError("Boundary patch scope must be a string.");
+  }
+
+  const hasHtml = Object.hasOwn(patch, "html") && patch.html != null;
+  const hasSignals = patch.signals && Object.keys(patch.signals).length > 0;
+  const hasBrowserCache = patch.cache?.browser && Object.keys(patch.cache.browser).length > 0;
+  const hasRedirect = Boolean(patch.redirect);
+  const hasError = Object.hasOwn(patch, "error");
+  if (!hasHtml && !hasSignals && !hasBrowserCache && !hasRedirect && !hasError) {
+    throw new TypeError("Boundary patch must include html, signals, cache.browser, redirect, or error.");
+  }
+
+  return patch;
+}
+
+function assertBoundary(boundary) {
+  if (typeof boundary !== "string" || boundary.length === 0) {
+    throw new TypeError("Boundary patch boundary must be a non-empty string.");
+  }
+}
+
+async function flushScheduler(scheduler, scope) {
+  if (!scheduler) {
+    return;
+  }
+  if (scope !== undefined && typeof scheduler.flushScope === "function") {
+    await scheduler.flushScope(scope);
+    return;
+  }
+  if (typeof scheduler.flush === "function") {
+    await scheduler.flush();
+  }
+}
+
+async function followRedirect(redirect, router, loader) {
+  if (router && typeof router.navigate === "function") {
+    await router.navigate(redirect);
+    return;
+  }
+  const location = loader?.root?.ownerDocument?.defaultView?.location ?? globalThis.location;
+  location?.assign?.(redirect);
+}
+
+function toStableError(value) {
+  if (value instanceof Error) {
+    return value;
+  }
+  if (value && typeof value === "object" && typeof value.message === "string") {
+    return Object.assign(new Error(value.message), value);
+  }
+  return new Error(String(value));
+}
+
+function toRecentEntry(result) {
+  const entry = {
+    boundary: result.boundary,
+    seq: result.seq,
+    status: result.status
+  };
+  if (result.status === "ignored-stale") {
+    entry.lastSeq = result.lastSeq;
+  }
+  if (result.status === "ignored-destroyed" && result.parentScope !== undefined) {
+    entry.parentScope = result.parentScope;
+  }
+  if (result.status === "redirected") {
+    entry.redirect = result.redirect;
+  }
+  return entry;
+}
+
+function isPlainObject(value) {
+  return Boolean(value && typeof value === "object" && !Array.isArray(value));
+}

package/src/browser.js

@@ -1,11 +1,14 @@
 export { asyncSignal } from "./async-signal.js";
 export { Async, createApp, defineApp, readSnapshot } from "./app.js";
 export { attributeName, defineAttributeConfig } from "./attributes.js";
+export { createBoundaryReceiver } from "./boundary-receiver.js";
 export { createCacheRegistry, defineCache } from "./cache.js";
 export { component, createComponentRegistry, defineComponent } from "./component.js";
 export { delay } from "./delay.js";
+export { defineAsyncContainerElement, defineAsyncSuspenseElement } from "./elements.js";
 export { createHandlerRegistry } from "./handlers.js";
 export { html } from "./html.js";
+export { createLazyRegistry, defineRegistrySnapshot } from "./lazy-registry.js";
 export { Loader, AsyncLoader } from "./loader.js";
 export { createPartialRegistry } from "./partials.js";
 export { createRegistryStore } from "./registry-store.js";

package/src/component.js

@@ -1,6 +1,7 @@
 import { attributeName } from "./attributes.js";
 import { escapeHtml, rawHtml, renderTemplate } from "./html.js";
 import { attachRegistryInspection, createRegistryStore } from "./registry-store.js";
+import { createLazyRegistry, isLazyDescriptor } from "./lazy-registry.js";
 
 const componentKind = Symbol.for("@async/framework.component");
 let componentCounter = 0;
@@ -22,13 +23,15 @@ export function createComponentRegistry(initialMap = {}, options = {}) {
   const registryStore = options.registry ?? createRegistryStore();
   const type = options.type ?? "component";
   const entries = registryStore._map(type);
+  const lazyRegistry = options.lazyRegistry ?? createLazyRegistry(options);
+  const lazyComponents = new Map();
 
   const registry = attachRegistryInspection({
     register(id, Component) {
       if (typeof id !== "string" || id.length === 0) {
         throw new TypeError("Component id must be a non-empty string.");
       }
-      if (!isComponent(Component) && typeof Component !== "function") {
+      if (!isComponent(Component) && typeof Component !== "function" && !isLazyDescriptor(Component)) {
         throw new TypeError(`Component "${id}" must be a component function.`);
       }
       if (entries.has(id)) {
@@ -49,6 +52,7 @@ export function createComponentRegistry(initialMap = {}, options = {}) {
       if (typeof id !== "string" || id.length === 0) {
         throw new TypeError("Component id must be a non-empty string.");
       }
+      lazyComponents.delete(id);
       return entries.delete(id);
     },
 
@@ -56,7 +60,20 @@ export function createComponentRegistry(initialMap = {}, options = {}) {
       if (typeof id !== "string" || id.length === 0) {
         throw new TypeError("Component id must be a non-empty string.");
       }
-      return entries.get(id);
+      const Component = entries.get(id);
+      if (!isLazyDescriptor(Component)) {
+        return Component;
+      }
+      if (!lazyComponents.has(id)) {
+        lazyComponents.set(id, async function LazyComponent(...args) {
+          const resolved = await lazyRegistry.resolve(type, id, Component);
+          if (typeof resolved !== "function") {
+            throw new TypeError(`Component "${id}" did not resolve to a function.`);
+          }
+          return resolved.apply(this, args);
+        });
+      }
+      return lazyComponents.get(id);
     },
 
     _adoptMany() {

package/src/elements.js

@@ -0,0 +1,63 @@
+import { Async } from "./app.js";
+
+export function defineAsyncContainerElement(options = {}) {
+  const tagName = options.tagName ?? "async-container";
+  const registry = options.customElements ?? globalThis.customElements;
+  if (!registry) {
+    throw new Error("defineAsyncContainerElement(...) requires customElements.");
+  }
+  const existing = registry.get(tagName);
+  if (existing) {
+    return existing;
+  }
+  const app = options.app ?? options.Async ?? Async;
+  const HTMLElementBase = options.HTMLElement ?? options.window?.HTMLElement ?? globalThis.HTMLElement;
+  if (!HTMLElementBase) {
+    throw new Error("defineAsyncContainerElement(...) requires HTMLElement.");
+  }
+
+  class AsyncContainerElement extends HTMLElementBase {
+    connectedCallback() {
+      if (this.__asyncAttached) {
+        return;
+      }
+      const runtime = app.runtime ?? app.start?.();
+      runtime?.attachRoot?.(this);
+      this.__asyncRuntime = runtime;
+      this.__asyncAttached = true;
+    }
+
+    disconnectedCallback() {
+      if (!this.__asyncAttached) {
+        return;
+      }
+      this.__asyncRuntime?.detachRoot?.(this);
+      this.__asyncRuntime = undefined;
+      this.__asyncAttached = false;
+    }
+  }
+
+  registry.define(tagName, AsyncContainerElement);
+  return AsyncContainerElement;
+}
+
+export function defineAsyncSuspenseElement(options = {}) {
+  const tagName = options.tagName ?? "async-suspense";
+  const registry = options.customElements ?? globalThis.customElements;
+  if (!registry) {
+    throw new Error("defineAsyncSuspenseElement(...) requires customElements.");
+  }
+  const existing = registry.get(tagName);
+  if (existing) {
+    return existing;
+  }
+  const HTMLElementBase = options.HTMLElement ?? options.window?.HTMLElement ?? globalThis.HTMLElement;
+  if (!HTMLElementBase) {
+    throw new Error("defineAsyncSuspenseElement(...) requires HTMLElement.");
+  }
+
+  class AsyncSuspenseElement extends HTMLElementBase {}
+
+  registry.define(tagName, AsyncSuspenseElement);
+  return AsyncSuspenseElement;
+}

package/src/handlers.js

@@ -5,6 +5,7 @@ import {
   unwrapServerResult
 } from "./server.js";
 import { attachRegistryInspection, createRegistryStore } from "./registry-store.js";
+import { createLazyRegistry, isLazyDescriptor } from "./lazy-registry.js";
 
 const builtInTokens = new Set(["prevent", "preventDefault", "stopPropagation", "stopImmediatePropagation"]);
 const builtInHandlers = {
@@ -26,11 +27,13 @@ export function createHandlerRegistry(initialMap = {}, options = {}) {
   const registryStore = options.registry ?? createRegistryStore();
   const type = options.type ?? "handler";
   const handlers = registryStore._map(type);
+  const lazyRegistry = options.lazyRegistry ?? createLazyRegistry(options);
+  const lazyHandlers = new Map();
 
   const registry = attachRegistryInspection({
     register(id, fn) {
       assertId(id);
-      if (typeof fn !== "function") {
+      if (typeof fn !== "function" && !isLazyDescriptor(fn)) {
         throw new TypeError(`Handler "${id}" must be a function.`);
       }
       if (handlers.has(id)) {
@@ -49,12 +52,26 @@ export function createHandlerRegistry(initialMap = {}, options = {}) {
 
     unregister(id) {
       assertId(id);
+      lazyHandlers.delete(id);
       return handlers.delete(id);
     },
 
     resolve(id) {
       assertId(id);
-      return handlers.get(id);
+      const handler = handlers.get(id);
+      if (!isLazyDescriptor(handler)) {
+        return handler;
+      }
+      if (!lazyHandlers.has(id)) {
+        lazyHandlers.set(id, async function runLazyHandler(...args) {
+          const resolved = await lazyRegistry.resolve(type, id, handler);
+          if (typeof resolved !== "function") {
+            throw new TypeError(`Handler "${id}" did not resolve to a function.`);
+          }
+          return resolved.apply(this, args);
+        });
+      }
+      return lazyHandlers.get(id);
     },
 
     async run(ref, context = {}) {

package/src/index.js

@@ -1,11 +1,14 @@
 export { asyncSignal } from "./async-signal.js";
 export { Async, createApp, defineApp, readSnapshot } from "./server-entry.js";
 export { attributeName, defineAttributeConfig } from "./attributes.js";
+export { createBoundaryReceiver } from "./boundary-receiver.js";
 export { createCacheRegistry, defineCache } from "./cache.js";
 export { component, createComponentRegistry, defineComponent } from "./component.js";
 export { delay } from "./delay.js";
+export { defineAsyncContainerElement, defineAsyncSuspenseElement } from "./elements.js";
 export { createHandlerRegistry } from "./handlers.js";
 export { html } from "./html.js";
+export { createLazyRegistry, defineRegistrySnapshot } from "./lazy-registry.js";
 export { Loader, AsyncLoader } from "./loader.js";
 export { createPartialRegistry } from "./partials.js";
 export { createRegistryStore } from "./registry-store.js";