@moku-labs/web 1.15.1 → 1.16.0

package/dist/index.d.cts

@@ -872,7 +872,7 @@ type Api$4 = {
   composeTitle(head: HeadConfig | undefined): string;
 };
 declare namespace types_d_exports$7 {
-  export { COMPONENT_HOOK_NAMES, ComponentContext, ComponentDef, ComponentHooks, ComponentInstance, ExtractApi$1 as ExtractApi, PageData, ResolvedSpaConfig, SpaApi, SpaConfig, SpaContext, SpaDataReader, SpaEmitFunction, SpaEvents, SpaKernel, SpaKernelDeps, SpaRequire, SpaState };
+  export { COMPONENT_HOOK_NAMES, ComponentContext, ComponentDef, ComponentEventHandler, ComponentEvents, ComponentHooks, ComponentInstance, ComponentRender, ComponentRouteSlice, ComponentSpec, ComponentSpecExtras, ComponentStateFactory, ExtractApi$1 as ExtractApi, PageData, RenderResult, ResolvedSpaConfig, SpaApi, SpaConfig, SpaContext, SpaDataReader, SpaEmitFunction, SpaEvents, SpaKernel, SpaKernelDeps, SpaRequire, SpaState };
 }
 /** Payload map for the events `spa` emits, used to type the kernel's `emit` closure. */
 type SpaEvents = {
@@ -973,12 +973,77 @@ interface ResolvedSpaConfig {
   components: ComponentDef[];
 }
 /**
- * Context handed to every component lifecycle hook — the bound element + page data,
- * plus the matched route's `params`/`meta`/`locale` and a link builder, so an island
- * can read its route context (e.g. a `card` route's `ctx.meta.focus` + `ctx.params.id`)
- * directly, without the page bridging it through `data-*` attributes.
+ * What a component's `render` may return:
+ * - a Preact `VNode` — committed into the host through the lazy Preact gate (`commitVNode`);
+ * - a `Node` — replaces the host's children;
+ * - a `string` — set as the host's `innerHTML`;
+ * - `void`/`undefined` — the render mutated the DOM itself (DOM-only islands → no Preact loaded).
  */
-interface ComponentContext {
+type RenderResult = import("preact").VNode | Node | string | void;
+/**
+ * Factory that builds a component's typed per-instance state (mirrors a plugin's
+ * `createState`). Called ONCE at mount; the returned object is stored on the
+ * {@link ComponentInstance} and exposed read-only as `ctx.state`.
+ *
+ * @param ctx - The component context for this instance (state is not yet set).
+ * @returns The initial per-instance state.
+ * @example
+ * state: (ctx): BoardState => ({ boardId: ctx.params.id ?? "", cards: [] })
+ */
+type ComponentStateFactory<S extends object> = (ctx: ComponentContext<S>) => S;
+/**
+ * Pure render of `(state, ctx)` → {@link RenderResult}. Called after mount-state-init
+ * and again (microtask-batched) after every `ctx.set`. Must be free of side effects
+ * beyond producing its result.
+ *
+ * @param state - The current per-instance state (read-only).
+ * @param ctx - The component context for this instance.
+ * @returns The render result to commit into the host.
+ * @example
+ * render: (state) => h(BoardView, { snapshot: state.snapshot })
+ */
+type ComponentRender<S extends object> = (state: Readonly<S>, ctx: ComponentContext<S>) => RenderResult;
+/**
+ * A delegated DOM event handler. `target` is the element matched by the key's selector
+ * (already resolved via `closest` — no `instanceof`/`closest` ceremony in the body).
+ *
+ * Typed `void` for ergonomics (the void-return rule accepts async handlers returning
+ * `Promise<void>` too); the kernel ignores any returned value.
+ *
+ * @param ctx - The component context (carries the live per-instance `state`).
+ * @param event - The raw DOM event.
+ * @param target - The element matched by the selector (the host when no selector).
+ * @returns void (a returned promise is ignored by the kernel).
+ * @example
+ * (ctx, event, button) => { event.preventDefault(); ctx.set({ open: true }); }
+ */
+type ComponentEventHandler<S extends object> = (ctx: ComponentContext<S>, event: Event, target: Element) => void;
+/**
+ * Declarative delegated event map. Each key is `"<type> <selector>"` (the selector is
+ * optional → a host-level listener). ONE real listener per event TYPE is attached to
+ * the host; dispatch walks `event.target.closest(selector)` within the host. All
+ * listeners are auto-removed on destroy.
+ *
+ * @example
+ * events: {
+ *   "click [data-action='delete']": (ctx, _e, btn) => ctx.set(removeCard(ctx.state, btn)),
+ *   "submit [data-add]": (ctx, e) => { e.preventDefault(); add(ctx); }
+ * }
+ */
+type ComponentEvents<S extends object> = Record<string, ComponentEventHandler<S>>;
+/**
+ * Context handed to every component lifecycle hook, render, and event handler — the
+ * bound element + page data, plus the matched route's `params`/`meta`/`locale` and a
+ * link builder, so an island can read its route context (e.g. a `card` route's
+ * `ctx.meta.focus` + `ctx.params.id`) directly, without the page bridging it through
+ * `data-*` attributes.
+ *
+ * Generic over the per-instance state `S` (default `undefined` so every existing
+ * hooks-only island still type-checks). The additive members (`state`/`set`/`flush`/
+ * `cleanup`/`component`) are ALWAYS-PRESENT functions — never optional keys — so they
+ * never trip `exactOptionalPropertyTypes`.
+ */
+interface ComponentContext<S = undefined> {
   /** The element the component instance is bound to. */
   el: Element;
   /** Page data extracted from the `script#__DATA__` payload. */
@@ -991,9 +1056,52 @@ interface ComponentContext {
   readonly locale: string;
   /** Build a link to a named route by pattern substitution (same output as `app.router.toUrl`). */
   readonly url: (name: string, params?: Record<string, string>) => string;
+  /** The live per-instance state (the object returned by `spec.state`). `undefined` for legacy hooks-only islands. */
+  readonly state: S;
+  /**
+   * Merge a patch into the per-instance state, then schedule ONE batched render.
+   * Accepts a partial object or an updater `(prev) => partial`. A no-op for legacy
+   * islands with no `state`/`render`.
+   *
+   * @param patch - A partial state object, or an updater returning one.
+   * @returns void
+   * @example
+   * ctx.set({ open: true });
+   * ctx.set(prev => ({ count: prev.count + 1 }));
+   */
+  set(patch: Partial<S> | ((prev: Readonly<S>) => Partial<S>)): void;
+  /**
+   * Force a synchronous render now (drains any pending scheduled render). Rarely
+   * needed in app code — `ctx.set` already schedules one; mainly a test seam.
+   *
+   * @returns void
+   * @example
+   * ctx.flush();
+   */
+  flush(): void;
+  /**
+   * Register a disposer run on `onDestroy` (subscriptions, timers, manual/global
+   * listeners the declarative `events` map cannot cover). Disposers run LIFO.
+   *
+   * @param dispose - The teardown function.
+   * @returns void
+   * @example
+   * ctx.cleanup(onPatch(p => applyPatch(ctx, p)));
+   */
+  cleanup(dispose: () => void): void;
+  /**
+   * Resolve another island's registered `api` by name. Returns `undefined` when no
+   * provider is registered (optional-dependency semantics, mirroring `ctx.has`).
+   *
+   * @param name - The provider island's component name.
+   * @returns The provider's api, or `undefined`.
+   * @example
+   * ctx.component<LightboxApi>("lightbox")?.open(slides, index);
+   */
+  component<T = unknown>(name: string): T | undefined;
 }
-/** Lifecycle hooks a component may implement. */
-interface ComponentHooks {
+/** Lifecycle hooks a component may implement. Generic over the per-instance state `S`. */
+interface ComponentHooks<S = undefined> {
   /**
    * Called once when the instance is created (before DOM attach).
    *
@@ -1002,7 +1110,7 @@ interface ComponentHooks {
    * @example
    * onCreate({ el }) { el.dataset.ready = "1"; }
    */
-  onCreate?(ctx: ComponentContext): void;
+  onCreate?(ctx: ComponentContext<S>): void;
   /**
    * Called after the instance is attached to its element.
    *
@@ -1010,8 +1118,10 @@ interface ComponentHooks {
    * @returns void
    * @example
    * onMount({ el }) { el.textContent = "0"; }
+   * @example
+   * async onMount(ctx) { ctx.set({ items: await load() }); } // async is allowed; the harness awaits it via settle()
    */
-  onMount?(ctx: ComponentContext): void;
+  onMount?(ctx: ComponentContext<S>): void;
   /**
    * Called when a navigation begins while this instance is mounted.
    *
@@ -1020,7 +1130,7 @@ interface ComponentHooks {
    * @example
    * onNavStart({ el }) { el.dataset.loading = ""; }
    */
-  onNavStart?(ctx: ComponentContext): void;
+  onNavStart?(ctx: ComponentContext<S>): void;
   /**
    * Called when a navigation completes while this instance is mounted.
    *
@@ -1029,7 +1139,7 @@ interface ComponentHooks {
    * @example
    * onNavEnd({ el }) { delete el.dataset.loading; }
    */
-  onNavEnd?(ctx: ComponentContext): void;
+  onNavEnd?(ctx: ComponentContext<S>): void;
   /**
    * Called before the instance is detached from its element.
    *
@@ -1038,7 +1148,7 @@ interface ComponentHooks {
    * @example
    * onUnMount({ el }) { el.replaceChildren(); }
    */
-  onUnMount?(ctx: ComponentContext): void;
+  onUnMount?(ctx: ComponentContext<S>): void;
   /**
    * Called once when the instance is destroyed (after detach).
    *
@@ -1047,17 +1157,60 @@ interface ComponentHooks {
    * @example
    * onDestroy({ el }) { delete el.dataset.ready; }
    */
-  onDestroy?(ctx: ComponentContext): void;
+  onDestroy?(ctx: ComponentContext<S>): void;
 }
 /** Allowed hook names — single source of truth for fail-fast validation. */
 declare const COMPONENT_HOOK_NAMES: readonly ["onCreate", "onMount", "onNavStart", "onNavEnd", "onUnMount", "onDestroy"];
-/** A registered component definition. */
+/**
+ * The plugin-mirror authoring form for {@link createComponent}: typed per-instance
+ * `state`, `render`, declarative `events`, and a cross-island `api` on top of the
+ * lifecycle hooks. All keys optional + additive; the presence of any spec-only key
+ * (`state`/`render`/`events`/`api`) selects the spec overload of `createComponent`.
+ *
+ * @example
+ * createComponent<{ boards: Board[] }>("board-list", {
+ *   state: () => ({ boards: [] }),
+ *   async onMount(ctx) { ctx.set({ boards: await ctx.component<Api>("api")!.list() }); },
+ *   render: (s) => h(BoardList, { boards: s.boards }),
+ *   events: { "submit [data-create]": (ctx, e) => { e.preventDefault(); create(ctx); } }
+ * });
+ */
+interface ComponentSpec<S extends object = object, A = unknown> extends ComponentHooks<S> {
+  /** Build typed per-instance state at mount (stored on the instance, not a module WeakMap). */
+  state?: ComponentStateFactory<S>;
+  /** Pure render re-invoked (microtask-batched) on every `ctx.set`. */
+  render?: ComponentRender<S>;
+  /** Declarative delegated DOM events with auto-teardown. */
+  events?: ComponentEvents<S>;
+  /** Public api factory — registered under the component name; reached via `app.spa.component(name)`. */
+  api?: (ctx: ComponentContext<S>) => A;
+}
+/**
+ * The spec extras carried on a {@link ComponentDef}, type-erased to `object` state
+ * (authors keep full `S` inference at the `createComponent` call site; the registry
+ * stores the runtime-only erased form). Absent for legacy `(name, hooks)` defs.
+ */
+interface ComponentSpecExtras {
+  /** Per-instance state factory. */
+  state?: ComponentStateFactory<object>;
+  /** Render called on mount + after every `ctx.set`. */
+  render?: ComponentRender<object>;
+  /** Declarative delegated events. */
+  events?: ComponentEvents<object>;
+  /** Public api factory registered under the component name. */
+  api?: (ctx: ComponentContext<object>) => unknown;
+}
+/** A registered component definition (an opaque token; author inference lives on `createComponent`). */
 interface ComponentDef {
   /** Unique component name (matched against `data-component`). */
   name: string;
-  /** Lifecycle hooks. */
-  hooks: ComponentHooks;
+  /** Lifecycle hooks (the subset shared with the legacy form). */
+  hooks: ComponentHooks<object>;
+  /** Plugin-mirror extras (state/render/events/api). Absent for legacy `(name, hooks)` defs. */
+  spec?: ComponentSpecExtras;
 }
+/** The matched-route slice carried on a live instance (params/meta/locale + link builder). */
+type ComponentRouteSlice = Pick<ComponentContext, "params" | "meta" | "locale" | "url">;
 /** A live, mounted component instance. */
 interface ComponentInstance {
   /** The definition this instance was created from. */
@@ -1070,6 +1223,26 @@ interface ComponentInstance {
    * page-specific: full unmount/destroy on every navigation.
    */
   persistent: boolean;
+  /** The single per-instance context reused by every hook, event handler, and render. */
+  ctx: ComponentContext<object>;
+  /** Live per-instance state (the object returned by `spec.state`), or undefined for hooks-only islands. */
+  state: object | undefined;
+  /** This instance's public api (the object returned by `spec.api`), or undefined when none declared. */
+  api: unknown;
+  /** Current matched-route slice (updated on navigation; read by `ctx.params/meta/locale/url`). */
+  route: ComponentRouteSlice;
+  /** Current page data payload (updated on navigation; read by `ctx.data`). */
+  data: PageData;
+  /** Disposers from `ctx.cleanup` + the declarative `events` listeners — run LIFO on destroy. */
+  cleanups: Array<() => void>;
+  /** Synchronously drain a pending render (the `ctx.flush` implementation). */
+  flush: () => void;
+  /** True while a render is queued for the next microtask — coalesces multiple `set` calls. */
+  renderScheduled: boolean;
+  /** Re-entrancy depth guard for the render scheduler (a render that calls `ctx.set`). */
+  renderDepth: number;
+  /** onMount's returned promise (+ render-module load) — awaited by the test harness's `settle()`. */
+  mountPromise: Promise<void> | undefined;
 }
 /** Page data payload parsed from the inline `script#__DATA__` element. */
 type PageData = Record<string, unknown>;
@@ -1153,6 +1326,8 @@ interface SpaState {
   registeredComponents: Map<string, ComponentDef>;
   /** Live component instances keyed by their bound element. */
   instances: Map<Element, ComponentInstance>;
+  /** Registered island apis by component name (the cross-island `ctx.component`/`app.spa.component` seam). */
+  componentApis: Map<string, unknown>;
   /** The current resolved URL (pathname + search). */
   currentUrl: string;
   /** Teardown handle for the attached router listeners (null when detached). */
@@ -1190,6 +1365,16 @@ type SpaApi = {
    * const url = app.spa.current(); // "/about"
    */
   current(): string;
+  /**
+   * Resolve a registered island's api by name (the cross-island seam). Returns
+   * `undefined` when no provider with that name is currently registered.
+   *
+   * @param name - The provider island's component name.
+   * @returns The provider's api, or `undefined`.
+   * @example
+   * app.spa.component<LightboxApi>("lightbox")?.open(slides, 0);
+   */
+  component<T = unknown>(name: string): T | undefined;
 };
 declare namespace types_d_exports {
   export { Api$3 as Api, BuildCacheEntry, BuildEvents, BuildResult, BuildRunOverrides, Config$3 as Config, ExtractApi, OgFont, OgImageConfig, PhaseContext, PhaseEmit, PhaseLog, PhaseName, PhaseRequire, RenderCacheEntry, RichOgInput, RunOptions, State$3 as State };
@@ -3315,21 +3500,26 @@ declare const sitePlugin: import("@moku-labs/core").PluginInstance<"site", Confi
 //#endregion
 //#region src/plugins/spa/components.d.ts
 /**
- * Create a validated component definition. Validates hook names at registration
- * for fail-fast typo detection (e.g. `onMout` throws immediately) and asserts
- * each provided hook is a function.
+ * Create a validated component definition. Accepts either the legacy hooks-only form
+ * (`createComponent("counter", { onMount() {} })`) or the plugin-mirror spec form
+ * (`createComponent("board", { state, render, events, api, ...hooks })`). Spec-only
+ * keys (`state`/`render`/`events`/`api`) are partitioned out before hook-name
+ * validation, so a real typo (e.g. `onMout`) still throws immediately while the spec
+ * keys are accepted.
  *
  * @param name - Unique component name.
- * @param hooks - Lifecycle hook implementations.
+ * @param spec - Lifecycle hooks, or the `{ state, render, events, api, ...hooks }` spec.
  * @returns A `ComponentDef` ready to `register`.
- * @throws {Error} If `name` is empty, any hook key is not in
- *   `COMPONENT_HOOK_NAMES`, or any provided hook value is not a function.
+ * @throws {Error} If `name` is empty, a hook key is unknown, or an extra/hook value has the wrong shape.
+ * @example
+ * const counter = createComponent("counter", { onMount({ el }) { el.textContent = "0"; } });
  * @example
- * const counter = createComponent("counter", {
- *   onMount({ el }) { el.textContent = "0"; }
+ * const list = createComponent<{ items: string[] }>("list", {
+ *   state: () => ({ items: [] }),
+ *   render: (s) => h(List, { items: s.items })
  * });
  */
-declare function createComponent(name: string, hooks: ComponentHooks): ComponentDef;
+declare function createComponent<S extends object = object, A = unknown>(name: string, spec: ComponentSpec<S, A>): ComponentDef;
 //#endregion
 //#region src/plugins/spa/lazy-embed.d.ts
 /**