@solidjs/web 2.0.0-beta.3 → 2.0.0-beta.30

package/types/frames/frame-sink.d.ts

@@ -0,0 +1,168 @@
+import { FrameChunk } from "./frame-client.js";
+
+/** Addresses a frame stream: the boundary id and this response's version. */
+export interface FrameAddress {
+  id: string;
+  version: number;
+}
+
+/**
+ * The emission surface `renderToStream` routes through when producing a
+ * frame stream instead of a document (see the `sink` render option). Each
+ * method emits transport-agnostic chunks; `emit` is the envelope boundary.
+ * @internal Compiler/renderer wiring — use `renderToFrameStream` or
+ * `renderServerComponent` instead.
+ */
+export function createFrameSink(
+  emit: (chunk: FrameChunk) => void,
+  frame: FrameAddress
+): Record<string, (...args: any[]) => void>;
+
+/** Options shared by the frame producers. */
+export interface FrameStreamOptions {
+  /** Boundary address; defaults to `{ id: "", version: 1 }`. */
+  frame?: { id?: string; version?: number };
+  /** Remaining `renderToStream` options (plugins, onError, manifest, ...). */
+  [key: string]: unknown;
+}
+
+/** A produced frame stream: pipe chunks, or await the collected array. */
+export interface FrameStream extends PromiseLike<FrameChunk[]> {
+  pipe(writable: { write(chunk: FrameChunk): void; end?(): void }): void;
+}
+
+/**
+ * Render to a FrameChunk stream: the same render core as `renderToStream`
+ * with emission swapped to the frame sink and the document writable replaced
+ * by a chunk envelope (`start` up front, `complete` at stream end). Data
+ * records default to the keyed JSON codec (decode with
+ * `createJSONDataTable`).
+ */
+export function renderToFrameStream(code: () => unknown, options?: FrameStreamOptions): FrameStream;
+
+/**
+ * Render a **server component** — a `props => JSX` function, typically
+ * returned from a server function — to a FrameChunk stream. `props` is a
+ * slot-props proxy, not data:
+ *
+ * - reading a prop as a child emits a marker range the client fills;
+ * - calling a prop as a render function emits a `slot` chunk for a fresh
+ *   occurrence (a primitive `$key` arg names it, so client state follows the
+ *   entity across responses — the slot-level analogue of For's `keyed`
+ *   function; positional otherwise, which is the right default for most
+ *   flows);
+ * - primitive args ride the chunk; server JSX args stream as nested regions
+ *   (`{$frame}` — html once, never data); other values serialize as `{$ref}`
+ *   data records with referential dedupe.
+ *
+ * The props a *client* passes never reach the server — server inputs are the
+ * function's arguments.
+ */
+export function renderServerComponent(
+  component: (props: Record<string, any>) => unknown,
+  options?: FrameStreamOptions
+): FrameStream;
+
+/**
+ * The slot props proxy used by `renderServerComponent`. Every key
+ * virtually exists (`in` is always true — a prop is a position the client
+ * may fill), enumeration is empty by design, and serialization goes through
+ * the live render context, so it must only be used during the frame's
+ * render.
+ * @internal Exposed for framework bindings composing their own producers.
+ */
+export function createSlotProps(
+  sink: ReturnType<typeof createFrameSink>,
+  frame: FrameAddress
+): Record<string, any>;
+
+/**
+ * A server component as an HTTP Response: the chunk stream framed with the
+ * server-function wire convention, tagged `X-Frame-Stream: <frame id>` for
+ * the client and `X-Content-Raw` so the server-function handler forwards it
+ * untouched. `init` (headers/status, e.g. from a `respond()` envelope)
+ * merges in; the frame tags win on conflict.
+ */
+export function serverComponentResponse(
+  component: (props: Record<string, any>) => unknown,
+  options?: FrameStreamOptions,
+  init?: { headers?: HeadersInit; status?: number }
+): Response;
+
+/**
+ * The server-component convention as a `transformResult` policy for
+ * `handleServerFunctionRequest`: a function result — or a `respond()`
+ * envelope whose value is a function — becomes a frame-stream Response,
+ * with the frame id defaulting to the server function's id so repeat calls
+ * target the same client boundary. Everything else passes through.
+ *
+ * @example
+ * ```ts
+ * handleServerFunctionRequest(request, {
+ *   transformResult: frameTransformResult,
+ *   provideEvent
+ * });
+ * ```
+ */
+export function frameTransformResult(event: unknown, result: unknown): unknown;
+
+// === Document SSR (t = 0) ===
+
+/**
+ * Document-mode slot props — the t = 0 counterpart of
+ * `createSlotProps`: the server component renders INLINE in the
+ * document and the client's real props render server-side inside its
+ * positions (the one hydration-time exception), wrapped in the same marker
+ * dialect the chunk producer emits so the adopting client binds slots and
+ * regions onto the server-rendered ranges.
+ */
+export function createDocumentSlotProps(
+  clientProps: Record<string, unknown>,
+  frameId: string
+): Record<string, unknown>;
+
+/**
+ * The in-process mirror of `frameTransformResult` for DOCUMENT SSR: install
+ * as `configureServerFunctionsServer({ transformDirectResult })` and a
+ * direct (same-process) server-function result that is a function comes back
+ * as an inline-renderable server component (frame markers + document
+ * slot props), branded with its function id and the call's wire address.
+ * Non-function results pass through.
+ */
+export function frameTransformDirectResult<T>(
+  value: T,
+  options: { id: string; args?: unknown[] }
+): T;
+
+/**
+ * The frame half of single-flight, as a `transformFlightResult` policy for
+ * `handleServerFunctionRequest`: when part of what a mutation invalidated is
+ * markup (a component-valued flight-data entry), the frame stream carries
+ * the whole payload — each component's content as a region addressed by its
+ * call, the `{ value, data }` envelope as `outcome` chunks with the
+ * component entries serialized as flight references. Returns `undefined`
+ * when nothing invalidated is markup (the response stays the plain
+ * single-flight envelope).
+ */
+export function frameTransformFlightResult(
+  event: unknown,
+  outcome: { value: unknown; data: unknown },
+  context?: unknown
+): Promise<Response | undefined>;
+
+// The brands and the codec plugin live with the transport (client bundles
+// resolve flight references against the live registry); re-exported here for
+// server integrations importing the document-SSR surface.
+export {
+  SERVER_COMPONENT,
+  SERVER_COMPONENT_ADDRESS,
+  SERVER_COMPONENT_SOURCE,
+  ServerComponentPlugin
+} from "./frame-transport.js";
+
+/**
+ * Inline bootstrap for the document shell: installs the `self._$SC`
+ * placeholder registry the hydration references resolve through; the client
+ * upgrades it via `installServerComponents()`.
+ */
+export const SERVER_COMPONENT_BOOTSTRAP: string;

package/types/frames/frame-transport.d.ts

@@ -0,0 +1,196 @@
+import { FrameChunk, FrameHost } from "./frame-client.js";
+import { JSONCodecOptions } from "./serializer.js";
+
+// Structural mirror of server-functions/shared.js's FlightDataConsumer:
+// this file may only reference siblings that ship with it when integrations
+// copy the frames declaration set (solid-web's types build), and the
+// server-functions declarations are copied to a different root.
+type FlightConsumer = (data: unknown, context: { response: Response }) => void | Promise<void>;
+
+/**
+ * Header tagging a Response as a frame stream; its value is the producing
+ * frame's id. Frame-owned wire contract — deliberately not a server-function
+ * `BodyFormat` entry, since the body is frame chunks, not a serialized value.
+ */
+export const FRAME_STREAM_HEADER: "X-Frame-Stream";
+
+/** Whether a fetch Response carries a frame stream. */
+export function isFrameStreamResponse(response: Response): boolean;
+
+/** Options for `applyFrameResponse`. */
+export interface ApplyFrameResponseOptions {
+  /**
+   * Remap the producer's root frame id onto a local one — the id your
+   * insertable/frame registered under — so navigations to the same boundary
+   * reuse the same frame regardless of what the server called it. Boundary
+   * identity belongs to the client.
+   */
+  as?: string;
+  /**
+   * Restamp every chunk of the response with this version (one response IS
+   * one version). Versions belong to the client too: the producer cannot
+   * know how many streams a boundary has consumed, so pass the Nth-response
+   * counter to make policy A's stale-guard real across navigations. A
+   * single-flight response addresses several boundaries, each with its own
+   * history — pass a function and it is called once per frame in the
+   * response.
+   */
+  version?: number | ((frameId: string) => number);
+  /**
+   * Remap any frame id other than the response's own root onto a local one
+   * — how a consumer resolves the addresses a single-flight response uses
+   * for the regions it refreshed.
+   */
+  route?(id: string): string;
+  /**
+   * Receives the payload text of each `outcome` chunk — the response-scoped
+   * single-flight envelope, the caller's result rather than anything the
+   * host renders.
+   */
+  onOutcome?(payload: string): void;
+}
+
+/**
+ * Reads a frame-stream Response to completion, applying every chunk to
+ * `host`. Chunks are length-prefixed JSON over the server-function wire
+ * framing. Resolves with the id the chunks were applied under once the
+ * stream ends; rejects on a malformed or errored stream.
+ *
+ * @example
+ * ```ts
+ * const response = await getStory(id); // frame-tagged server function result
+ * if (isFrameStreamResponse(response)) {
+ *   await applyFrameResponse(response, host, { as: "story-pane" });
+ * }
+ * ```
+ */
+export function applyFrameResponse(
+  response: Response,
+  host: FrameHost,
+  options?: ApplyFrameResponseOptions
+): Promise<string>;
+
+/** Brands an inline-rendered server component with its function id. */
+export const SERVER_COMPONENT: unique symbol;
+
+/** The unwrapped server component behind an inline-render wrap. */
+export const SERVER_COMPONENT_SOURCE: unique symbol;
+
+/** The call's wire address (`frameAddress`), for regions to be emitted under. */
+export const SERVER_COMPONENT_ADDRESS: unique symbol;
+
+/**
+ * The handoff contract on components the transport resolves: `{ fnId,
+ * frameId, take(prev) }`. A reader whose source resolved a NEW component
+ * while a previous one is mounted offers the old one — `take` rebinds the
+ * live mount when both are boundaries of the same function (the element and
+ * its slot state stay; the incoming stream morphs it), and the reader keeps
+ * its previous value instead of remounting. `Symbol.for`, so frameworks can
+ * honor it without importing this module.
+ */
+export const COMPONENT_HANDOFF: unique symbol;
+
+/** The value under `COMPONENT_HANDOFF` on a transport-resolved component. */
+export interface ComponentHandoff {
+  /** The server function id both peers derive the boundary's calls from. */
+  fnId: string;
+  /** The frame id this component's fresh mounts register under. */
+  frameId: string;
+  /**
+   * Offer `prev` (the reader's current value) to this component. Returns
+   * true when the reader should KEEP prev — the mounted frame was rebound
+   * to this component's id (or already showed it); false means swap
+   * normally (different function, unbranded prev, or nothing mounted).
+   */
+  take(prev: unknown): boolean;
+}
+
+/**
+ * Seroval plugin for a server component crossing a serialization boundary:
+ * a branded component serializes as a REFERENCE — a per-function document
+ * placeholder in the hydration serializer, a live-registry lookup by call
+ * address in the JSON codec (single-flight envelopes) — its markup never
+ * rides as data.
+ */
+export const ServerComponentPlugin: unknown;
+
+/**
+ * The codec options for a single-flight envelope: `codec` plus
+ * `ServerComponentPlugin` (deduped by tag). Injected by the protocol on both
+ * legs; exported for integrations composing their own flight carriers.
+ */
+export function flightCodec(codec?: JSONCodecOptions): JSONCodecOptions;
+
+/** Options for `createServerComponentHandler`. */
+export interface ServerComponentHandlerOptions<C = unknown> {
+  host: FrameHost;
+  /**
+   * Builds the framework's mountable component for a boundary. Invoked once
+   * per boundary and cached; every mount of the returned component is its
+   * own frame instance under the boundary id (multi-mount fans out).
+   */
+  component(frameId: string): C;
+  /**
+   * A new response is about to stream into a boundary: rotate
+   * response-scoped state (codec data tables) here. `version` is the
+   * client-owned stream counter the chunks will be stamped with.
+   */
+  onStream?(frameId: string, version: number, response: Response): void;
+  /**
+   * Document-SSR adoption: given a boundary id the page already carries
+   * (server-rendered between `frame:<id>` markers), return the component
+   * that adopts that range — or `undefined` to stream normally. Consulted
+   * once per boundary, before any fetch.
+   */
+  documentComponent?(frameId: string): C | undefined;
+  /**
+   * Answer a call SYNCHRONOUSLY before any request is made (t = 0 local
+   * answers — e.g. a boundary the document already carries). Returning a
+   * non-undefined value resolves the call with it; a hydrating consumer
+   * never observes a pending beat.
+   */
+  intercept?(info: { id: string; meta: unknown; args: unknown[] }): C | undefined;
+  /**
+   * Reads the registered single-flight consumer at delivery time. The
+   * consumer is module state in the server-function client's SHARED
+   * instance; pass a getter reading that instance when your bundling gives
+   * this module a private copy. Defaults to the local copy's reader.
+   */
+  consumer?(): FlightConsumer | undefined;
+  /**
+   * Reads the configured codec options at decode time — same instance-
+   * identity contract as `consumer`. Defaults to the local copy's reader.
+   */
+  codec?(): JSONCodecOptions | undefined;
+}
+
+/**
+ * The client mirror of `frameTransformResult`, shaped for the server-function
+ * client's `responseHandler` seam: frame-stream responses resolve the call
+ * with a **stable component** instead of data, so an equals-gated consumer
+ * (Solid's `dynamic`) never remounts across refetches — the response streams
+ * into the boundary underneath as the only observable effect.
+ *
+ * Boundary identity is derived, never declared: every call keys by its
+ * intrinsic (function, arguments) address — the query cache's per-args rule,
+ * so cached components and boundaries stay one-to-one. Same-args calls
+ * resolve the identical component and morph in place; an args switch swaps
+ * boundaries, re-materialized from the host's retained state.
+ */
+export function createServerComponentHandler<C>(options: ServerComponentHandlerOptions<C>): {
+  intercept?(info: { id: string; meta: unknown; args: unknown[] }): C | undefined;
+  handle(
+    response: Response,
+    ctx: { id: string; meta: unknown; args: unknown[]; context: unknown }
+  ): C | undefined;
+  /**
+   * Declares that the document is showing a call: hydration-data references
+   * carry their call's address (`_$SC.r(id, address)`) but never travel
+   * through the transport, so the integration forwards those records here —
+   * they are how a post-load call for the same (function, arguments) finds
+   * its way back to the adopted boundary. `component` must be the exact
+   * reference the integration's cache holds for the call (the per-function
+   * placeholder), or readers' equals-gates fail into remounts.
+   */
+  showing(address: string, functionId: string, component: C): void;
+};

package/types/frames/serializer.d.ts

@@ -0,0 +1,157 @@
+import { Plugin, Serializer, SerovalNode } from "seroval";
+
+/**
+ * Seroval's node shape — the intermediate representation `serializeJSON`
+ * emits and `createJSONDeserializer` consumes. Safe to `JSON.stringify`.
+ */
+export type { SerovalNode };
+
+/**
+ * A Seroval plugin usable with the web serializers — teaches the codec how
+ * to encode/decode a custom value type. Supply matching plugins on both
+ * peers of a transport.
+ */
+export type SerializerPlugin = Plugin<any, any>;
+
+/**
+ * Baseline plugin set for serializing web-platform values (AbortSignal,
+ * Event, FormData, Headers, ReadableStream, Request, Response, URL, ...).
+ * Applied by every serializer in this module; custom plugins compose ahead
+ * of it via `resolveSerializerPlugins`.
+ */
+export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
+
+/**
+ * Composes custom plugins with `DEFAULT_WEB_PLUGINS`. Custom plugins come
+ * first so they can shadow a default for values both would match. Returns a
+ * fresh array; the defaults are never mutated. Useful when handing a full
+ * plugin list to another serialization layer.
+ */
+export function resolveSerializerPlugins(customPlugins?: SerializerPlugin[]): SerializerPlugin[];
+
+/** Options for `createSerializer`. */
+export interface WebSerializerOptions {
+  /** Name of the global object the emitted scripts write resolved values into. */
+  globalIdentifier: string;
+  /** Cross-reference scope id, for isolating multiple streams on one page. */
+  scopeId?: string;
+  /**
+   * Seroval feature bitflags to exclude from output. Defaults to disabling
+   * post-ES2017 features (AggregateError, BigInt typed arrays). Outside
+   * development, `Error.prototype.stack` is additionally stripped on top of
+   * any override — serialized stacks leak server paths to the client.
+   */
+  disabledFeatures?: number;
+  /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. */
+  plugins?: SerializerPlugin[];
+  /** Receives each emitted script chunk. */
+  onData: (result: string) => void;
+  onError?: (error: unknown) => void;
+  /** Fires once all async values have settled. */
+  onDone?: () => void;
+}
+
+/**
+ * Creates a streaming Seroval serializer preconfigured with the web plugin
+ * set and the default feature policy. Emits JavaScript chunks (through
+ * `onData`) that reconstruct the values under `globalIdentifier` when
+ * evaluated — the script-injection form of serialization renderers build
+ * on. For a JSON-based wire codec (no eval on the receiving side), use
+ * `serializeJSON` / `createJSONDeserializer` instead.
+ */
+export function createSerializer(options: WebSerializerOptions): Serializer;
+
+/**
+ * Options for `createHydrationSerializer` — `WebSerializerOptions` minus
+ * the knobs hydration pins (`globalIdentifier`, `disabledFeatures`).
+ * @internal
+ */
+export type HydrationSerializerOptions = Omit<
+  WebSerializerOptions,
+  "globalIdentifier" | "disabledFeatures"
+>;
+
+/**
+ * Renderer primitive — the serializer SSR uses for hydration output. Pins
+ * the hydration global (`_$HY.r`) and feature policy; only the wiring
+ * options (callbacks, scope, extra plugins) are configurable. Not meant
+ * for hand-written code — custom serialization should use
+ * `createSerializer` or the JSON codec.
+ * @internal
+ */
+export function createHydrationSerializer(options: HydrationSerializerOptions): Serializer;
+
+/**
+ * Renderer primitive — returns the cross-reference bootstrap script SSR
+ * emits ahead of hydration data for a render scope. Not meant for
+ * hand-written code.
+ * @internal
+ */
+export function getLocalHeaderScript(id?: string): string;
+
+// ---- JSON codec (server function transports) ----
+
+/**
+ * Options shared by both halves of the JSON codec. All of them must match
+ * on the serializing and deserializing peer or payloads will not
+ * round-trip — for server functions, set them once through the
+ * client/server `codec` config option.
+ */
+export interface JSONCodecOptions {
+  /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. Must match on both peers. */
+  plugins?: SerializerPlugin[];
+  /**
+   * Seroval feature bitflags to exclude. Defaults to disabling `RegExp`
+   * (payloads may come from an untrusted peer). Must match on both peers.
+   * Outside development, the encoding side additionally strips
+   * `Error.prototype.stack` on top of any override — serialized stacks leak
+   * server paths to the client. Decoding stays permissive, so payloads from
+   * a development peer still round-trip.
+   */
+  disabledFeatures?: number;
+  /** Maximum parse/deserialize depth. Defaults to 64. Must match on both peers. */
+  depthLimit?: number;
+}
+
+/** Options for `serializeJSON`. */
+export interface JSONSerializeOptions extends JSONCodecOptions {
+  /**
+   * Receives each serialized node; `initial` is true for the first chunk
+   * (the source value itself). Async values produce additional chunks as
+   * they resolve.
+   */
+  onParse: (node: SerovalNode, initial: boolean) => void;
+  onError?: (error: unknown) => void;
+  /** Fires once all async values have settled. */
+  onDone?: () => void;
+}
+
+/**
+ * Serializes `value` as SerovalNode chunks delivered through `onParse` —
+ * the encoding half of the eval-free JSON codec (RPC-style transports;
+ * the deserializing peer needs no script evaluation, so CSP-safe). Wire
+ * framing of the nodes is the transport's concern. Returns a cancel
+ * function that aborts pending async serialization.
+ */
+export function serializeJSON(value: unknown, options: JSONSerializeOptions): () => void;
+
+/**
+ * Creates the decoding counterpart of `serializeJSON`. Cross-references
+ * between chunks resolve through state shared across calls, so all chunks
+ * from one stream must go through the same deserializer instance. The first
+ * chunk's return value is the decoded source value; feeding later chunks
+ * settles the async values referenced inside it.
+ */
+export function createJSONDeserializer(options?: JSONCodecOptions): <T>(node: SerovalNode) => T;
+
+/**
+ * A resident, response-scoped decode table over the keyed JSON codec: apply
+ * each frame `data` chunk with `apply`, resolve `{ $ref }` slot args with
+ * `resolve`. The frames client host wires one per response
+ * (`applyData: c => table.apply(c)`).
+ */
+export interface JSONDataTable {
+  apply(chunk: { key?: string; node?: unknown; initial?: boolean }): void;
+  resolve<T = unknown>(ref: { $ref: string }): T;
+}
+export function createJSONDataTable(options?: JSONCodecOptions): JSONDataTable;

package/types/frames/server.d.ts

@@ -0,0 +1,30 @@
+import type { Element as SolidElement } from "solid-js";
+/**
+ * A client position in a server component: a prop the server renders (as JSX
+ * or by calling it) where client-owned markup belongs. `P` is the client
+ * component's own props, so a server component can reference the client
+ * component's type directly instead of restating it.
+ *
+ * Arguments are classified by VALUE, not by name — any prop may carry any of
+ * these:
+ *
+ * - primitives ride the chunk;
+ * - server JSX streams as a nested region (html once, never data);
+ * - anything else serializes as a data record.
+ *
+ * Async server JSX in an argument needs its own boundary: the region is
+ * emitted as one finished string, so a bare async read has no fallback to
+ * show and no fragment to reveal into.
+ *
+ * `$key` names the occurrence so client state follows an entity across
+ * responses rather than being positional — the slot-level analogue of `For`'s
+ * `keyed`, for when references can't carry identity because every response
+ * re-creates everything. It is occurrence identity, not client data: it is
+ * stripped before the client component sees its props. Positional identity is
+ * the right default; `$key` matters when a live list reorders.
+ */
+export type Slot<P = {}> = (props: P & {
+    $key?: string | number;
+}) => SolidElement;
+export { renderToFrameStream, renderServerComponent, serverComponentResponse, frameTransformResult, frameTransformFlightResult, createFrameSink, frameTransformDirectResult, ServerComponentPlugin, SERVER_COMPONENT_BOOTSTRAP } from "./frame-sink.js";
+export { FRAME_STREAM_HEADER, isFrameStreamResponse } from "./frame-transport.js";