@solidjs/web 2.0.0-experimental.8 → 2.0.0-rc.0

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

@@ -0,0 +1,222 @@
+// EXPERIMENTAL — the frames/server-components surface ships as an
+// experimental preview, excluded from the 2.0 stability guarantee: API
+// shapes and the wire format may change between prereleases (RFC 11).
+// Every export in this module is @experimental.
+import { FrameChunk, FrameHost } from "./frame-client.js";
+import { JSONCodecOptions } from "./serializer-decode.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.
+ * @experimental
+ */
+export const FRAME_STREAM_HEADER: "X-Frame-Stream";
+
+/**
+ * Whether a fetch Response carries a frame stream.
+ * @experimental
+ */
+export function isFrameStreamResponse(response: Response): boolean;
+
+/**
+ * Options for `applyFrameResponse`.
+ * @experimental
+ */
+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);
+  /**
+   * 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" });
+ * }
+ * ```
+ * @experimental
+ */
+export function applyFrameResponse(
+  response: Response,
+  host: FrameHost,
+  options?: ApplyFrameResponseOptions
+): Promise<string>;
+
+/**
+ * Brands an inline-rendered server component with its function id.
+ * @experimental
+ */
+export const SERVER_COMPONENT: unique symbol;
+
+/**
+ * The unwrapped server component behind an inline-render wrap.
+ * @experimental
+ */
+export const SERVER_COMPONENT_SOURCE: unique symbol;
+
+/**
+ * The call's wire address (`frameAddress`), for regions to be emitted under.
+ * @experimental
+ */
+export const SERVER_COMPONENT_ADDRESS: unique symbol;
+
+/**
+ * The binding brand on values the transport resolves: `{ component, address }`
+ * — the identity split (DR-1). `component` is the mount identity, one per
+ * server function; `address` names the call's content store. An equals-gated
+ * reader compares `component` across resolutions: same function means "same
+ * instance, new binding" — keep the mounted instance and deliver the new
+ * address into it; a different function swaps normally. `Symbol.for`, so
+ * frameworks can honor it without importing this module.
+ * @experimental
+ */
+export const COMPONENT_BINDING: unique symbol;
+
+/**
+ * The value under `COMPONENT_BINDING` on a transport-resolved binding.
+ * @experimental
+ */
+export interface ComponentBinding<C = unknown> {
+  /** The per-function mount component (the equals-gate identity). */
+  component: C;
+  /** The call's intrinsic (function, arguments) address — its store's key. */
+  address: string;
+}
+
+/**
+ * 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.
+ * @experimental
+ */
+export const ServerComponentPlugin: unknown;
+
+/**
+ * Installs the hydration-serializer registry prefix: given the emitted
+ * script's serializer context, returns the expression the next serialized
+ * reference reads the `_$SC` registry through (the self-bootstrapping form
+ * on a script's first reference, a bare read after). Loaded document-SSR
+ * modules install this (see frame-sink); client bundles never carry the
+ * bootstrap text.
+ * @experimental
+ */
+export function setServerComponentBootstrap(resolve: (ctx: unknown) => string): void;
+
+/**
+ * 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.
+ * @experimental
+ */
+export function flightCodec(codec?: JSONCodecOptions): JSONCodecOptions;
+
+/**
+ * Options for `createServerComponentHandler`.
+ * @experimental
+ */
+export interface ServerComponentHandlerOptions<C = unknown> {
+  host: FrameHost;
+  /**
+   * Builds the framework's mount component for a server FUNCTION. Invoked
+   * once per function and cached — this is the equals-gate identity every
+   * call of the function resolves through. The component is CALLED (by the
+   * binding wrapper or a gated reader), receiving its current address as a
+   * second argument (`() => string`); it should (re-)bind its frame's pull
+   * to that address's store. Multi-mount fans out per site.
+   */
+  component(fnId: string): C;
+  /**
+   * A new response is about to stream into an address: rotate
+   * response-scoped state (codec data tables) here. `version` is the
+   * client-owned stream counter the chunks will be stamped with.
+   */
+  onStream?(address: string, version: number, response: Response): void;
+  /**
+   * 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 **binding** — a callable wrapper branded `COMPONENT_BINDING` — so
+ * an equals-gated consumer (Solid's `dynamic`) never remounts across
+ * refetches or argument changes; the response streams into the address's
+ * resident store as the only observable effect.
+ *
+ * The identity split (DR-1): stores are keyed per-ADDRESS — the call's
+ * intrinsic (function, arguments) name, one-to-one with a query cache's
+ * per-args entries — while mounts are per-SITE, rendering the per-function
+ * component and following delivered addresses. An address nothing is bound
+ * to warms its store (preload isolation is the default, not a rule).
+ * @experimental
+ */
+export function createServerComponentHandler<C>(options: ServerComponentHandlerOptions<C>): {
+  intercept?(info: { id: string; meta: unknown; args: unknown[] }): unknown;
+  handle(
+    response: Response,
+    ctx: { id: string; meta: unknown; args: unknown[]; context: unknown }
+  ): unknown;
+  /**
+   * 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.
+   * Mints the call's binding (a post-load refetch then resolves a value
+   * whose component matches what the document mounted) and brands the
+   * per-function component so cache-seeded readers deliver instead of
+   * remounting when their site later switches calls.
+   */
+  showing(address: string, functionId: string): void;
+};

package/types/frames/serializer.d.ts

@@ -0,0 +1,182 @@
+// Serialization surface (published as `@solidjs/web/serialization`): the
+// runtime's Seroval machinery, exposed for the runtime's own entries and
+// for integrations building transports on the same codec. This is
+// INTEGRATION-FACING plumbing, not application API — it is exempt from the
+// 2.0 stability guarantee and may change between releases. Application and
+// router code should configure `codec` on the server-function entries
+// instead of importing from here.
+import type { Serializer } from "seroval";
+import {
+  JSONCodecOptions,
+  PluginInfo,
+  SerializerPlugin,
+  SerovalNode
+} from "./serializer-decode.js";
+
+// The decode half — `SerovalNode`, the plugin TYPES, `DEFAULT_WEB_PLUGINS`,
+// `resolveSerializerPlugins`, `JSONCodecOptions`, `createJSONDeserializer`,
+// `createJSONDataTable` — is declared in serializer-decode.d.ts (published
+// as `@solidjs/web/serialization/decode`, the module lazy client consumers
+// load) and re-exported here so this remains the full surface.
+export * from "./serializer-decode.js";
+
+// ---- Plugin authoring ----
+//
+// Unlike the rest of this entry, plugin authoring is APPLICATION-FACING —
+// it is the supported way to feed the serializers' `plugins` options and
+// the server-function entries' `codec.plugins`. The values re-export
+// seroval's own (`createPlugin`, `OpaqueReference` — see serializer.js);
+// the plugin TYPES live in serializer-decode.d.ts (hand-declared there —
+// see its banner for why).
+
+/**
+ * Builds a `SerializerPlugin` — seroval's `createPlugin`, re-exported so
+ * plugin authors stay on the exact seroval instance/version the runtime
+ * serializes with. Import it from HERE, not from your own `seroval`
+ * dependency: a plugin built against a different copy/version would not
+ * fail the build — it would emit nodes the other peer can't interpret.
+ *
+ * Application-facing (see the plugin-authoring banner above).
+ */
+export function createPlugin<Value, Info extends PluginInfo>(
+  plugin: SerializerPlugin<Value, Info>
+): SerializerPlugin<Value, Info>;
+
+/**
+ * Seroval's `OpaqueReference`, re-exported from the runtime's own instance
+ * (an `OpaqueReference` from another seroval copy fails the serializer's
+ * instanceof check and serializes as a plain value): wraps a value so it
+ * crosses the wire as its `replacement` (default `undefined`) while
+ * staying readable in-process through `.value`.
+ *
+ * Application-facing (see the plugin-authoring banner above).
+ */
+export class OpaqueReference<V, R = undefined> {
+  readonly value: V;
+  readonly replacement?: R;
+  constructor(value: V, replacement?: R);
+}
+
+/**
+ * Options for `createSerializer`.
+ *
+ * Integration-facing; may change (see the entry banner).
+ */
+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.
+ *
+ * Integration-facing; may change (see the entry banner).
+ */
+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) ----
+// (`JSONCodecOptions` and the decode half are declared in
+// serializer-decode.d.ts and re-exported above.)
+
+/**
+ * Options for `serializeJSON`.
+ *
+ * Integration-facing; may change (see the entry banner).
+ */
+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.
+ *
+ * Integration-facing; may change (see the entry banner).
+ */
+export function serializeJSON(value: unknown, options: JSONSerializeOptions): () => void;
+
+/** Options for `createJSONSerializer`. */
+export interface JSONSerializerOptions extends JSONCodecOptions {
+  /**
+   * Receives each keyed record — `initial` is true for a key's first node
+   * (the written value itself); async values patch through later records
+   * under the same key. The decoding peer is `createJSONDataTable`.
+   */
+  onData: (record: { key: string; node: SerovalNode; initial: boolean }) => void;
+  onError?: (error: unknown) => void;
+  /** Fires once `flush()` has been called and every pending value settled. */
+  onDone?: () => void;
+}
+
+/**
+ * The keyed, streaming encoder of the eval-free JSON codec — the render
+ * stream's data serializer (frames default to it). Each `write(key, value)`
+ * shares one reference space, so cross-record identity holds; `flush()`
+ * marks the write set complete (writes after it are dropped, mirroring the
+ * hydration serializer); `close()` aborts pending async serialization.
+ */
+export function createJSONSerializer(options: JSONSerializerOptions): {
+  write(key: string, value: unknown): void;
+  flush(): void;
+  close(): void;
+};

package/types/frames/server.d.ts

@@ -0,0 +1,52 @@
+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.
+ * @experimental
+ */
+export type Slot<P = {}> = (props: P & {
+    $key?: string | number;
+}) => SolidElement;
+/**
+ * Types an async value crossing the slot border (DR-2, value tier). What you
+ * pass is what ships — the promise / async iterable itself rides the data
+ * channel — but the client's prop READ settles: it suspends into the covering
+ * boundary until first arrival (a promise's resolution, an iterable's first
+ * yield), then reads as the settled value, updating per yield for iterables.
+ *
+ * `asyncArg` is the type-level statement of that contract: identity at
+ * runtime, settled type at the border, so `Slot<P>` keeps the fill's props
+ * truthful to what its reads actually return.
+ *
+ * Slots render as JSX — the compiler wraps each prop in a getter so the read
+ * defers to the slot border, where the runtime owns it. A call form
+ * (`props.status({ … })`) evaluates its args eagerly in the component body —
+ * a top-level read, an error in most cases.
+ *
+ * ```tsx
+ * <props.status progress={asyncArg(gen.progress)} stats={asyncArg(gen.stats)} />
+ * ```
+ */
+export declare function asyncArg<T>(value: PromiseLike<T> | AsyncIterable<T>): T;
+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";