@solidjs/web 2.0.0-rc.4 → 2.0.0-rc.6

package/types-cjs/server-functions/server.d.cts

@@ -1,8 +1,9 @@
-export { ERROR_HEADER, FLASH_COOKIE, INSTANCE_HEADER, SERVER_FUNCTION_INVOKE, SINGLE_FLIGHT_HEADER, clearFlashCookie, decodeErrorHeaderValue, decodeResponse, decodeResponsePayload, encodeErrorHeaderValue, getServerFunctionMetadata, hasFlashCookie, invoke, isServerFunction, subscribeFlightData, withMeta } from "./shared.cjs";
+export { ERROR_HEADER, FLASH_COOKIE, INSTANCE_HEADER, REDIRECT_HEADER, SERVER_FUNCTION_INVOKE, SINGLE_FLIGHT_HEADER, UNKNOWN_HEADER, clearFlashCookie, decodeErrorHeaderValue, decodeRedirectHeaderValue, decodeResponse, decodeResponsePayload, encodeErrorHeaderValue, getServerFunctionMetadata, hasFlashCookie, invoke, isServerFunction, subscribeFlightData, withMeta } from "./shared.cjs";
 export { decodeFlashCookie, encodeFlashCookie } from "./flash.cjs";
 import { ResponseEnvelope } from "../response.cjs";
 import { JSONCodecOptions } from "../serializer-decode.cjs";
 import { RequestEvent } from "../server.cjs";
+import type { ServerFunction, ServerFunctionMetadata } from "./shared.cjs";
 export type { FlightDataConsumer, FlightDataContext, InvokeOptions, ServerFunction, ServerFunctionInvoker, ServerFunctionMetadata, SingleFlightPayload } from "./shared.cjs";
 export type { FlashSubmission } from "./flash.cjs";
 /**
@@ -130,6 +131,18 @@ export interface ServerFunctionCSRFOptions {
      * @default false
      */
     allowRequestsWithoutOriginCheck?: boolean;
+    /**
+     * Applies the origin gate to GET-declared reads as well. By default the
+     * gate is skipped for declared reads: same-origin policy already keeps a
+     * cross-site caller from READING the response, and the gate's `Vary`
+     * fragments (or, on CDNs that ignore Vary, poisons) the shared-cache
+     * entries the `GET` helper exists to enable (#3071). The premise that
+     * skip rests on is `GET()`'s safety contract — declared reads are safe
+     * to EXECUTE from any origin (#3114). A deployment that does not rely
+     * on shared caches can enable this to gate its reads too.
+     * @default false
+     */
+    protectDeclaredReads?: boolean;
 }
 /** Options for `configureServerFunctionsServer`. */
 export interface ServerFunctionsServerConfig {
@@ -150,10 +163,13 @@ export interface ServerFunctionsServerConfig {
      */
     wrapInvocation?: WrapInvocationHook;
     /**
-     * The single-flight hook: produces the data payload folded into
+     * The unnamed single-flight hook: produces the data payload folded into
      * responses of calls that opted in (see `CollectFlightDataHook`).
      * Registered once by the integration that owns data production (a
-     * router); per-handler `collectFlightData` options override it.
+     * router); per-handler `collectFlightData` options override it. Other
+     * integrations contribute additively through
+     * `registerFlightDataSource(id, hook)` instead of competing for this
+     * slot.
      */
     collectFlightData?: CollectFlightDataHook;
     /**
@@ -225,9 +241,29 @@ export interface ServerFunctionsServerConfig {
     /**
      * Codec options (extra plugins etc.) for decoding arguments and encoding
      * results — must match the client's. Stored in the shared layer, so
-     * `decodeResponse` sees them too.
+     * `decodeResponse` sees them too. When `serializeErrorStacks` is omitted,
+     * the server-function boundary defaults it from this module's compiled
+     * development variant.
      */
     codec?: JSONCodecOptions;
+    /**
+     * Upper bound, in bytes, on a call's argument payload — the POST body,
+     * or the `?args=` query encoding. The payload is buffered and decoded
+     * before dispatch, so its cost is paid before application code can
+     * decline it; the bound is enforced up front and a request over it is
+     * refused with `413` before any decoding (#3115). Raise it for functions
+     * that accept large uploads, or set `Infinity` to remove the bound.
+     * @default 1_048_576 (1 MiB)
+     */
+    bodySizeLimit?: number;
+    /**
+     * Upper bound on the number of arguments a call may carry. The decoded
+     * argument array is spread into the function call, so an unbounded list
+     * forces a range error out of any function regardless of what it does;
+     * past the bound the request is refused with `400` (#3115).
+     * @default 1000
+     */
+    maxArguments?: number;
 }
 /**
  * A registered server function: its build-stable id paired with the
@@ -347,6 +383,16 @@ export interface HandleServerFunctionOptions {
     csrf?: boolean | ServerFunctionCSRFOptions;
     /** Overrides the configured codec options for this handler. */
     codec?: JSONCodecOptions;
+    /**
+     * Overrides the configured argument payload bound for this handler (see
+     * `ServerFunctionsServerConfig.bodySizeLimit`).
+     */
+    bodySizeLimit?: number;
+    /**
+     * Overrides the configured argument count bound for this handler (see
+     * `ServerFunctionsServerConfig.maxArguments`).
+     */
+    maxArguments?: number;
 }
 export interface ServerFunctionRequestCall {
     type: "request";
@@ -366,6 +412,7 @@ export interface ServerFunctionResponseCall {
 }
 export type ServerFunctionCall = ServerFunctionRequestCall | ServerFunctionResponseCall;
 export declare function configureServerFunctionsServer(config?: ServerFunctionsServerConfig): void;
+export declare function registerFlightDataSource(source: string, hook: CollectFlightDataHook): () => void;
 export declare function registerServerFunction<T extends any[], R>(id: string, callback: (...args: T) => R): (...args: T) => R;
 export declare function getServerFunction<T extends any[], R>(id: string): (...args: T) => R;
 export declare function registerServerReference<T extends any[], R>(id: string, fn: (...args: T) => R, name?: string): ServerFunctionReference<T, R>;
@@ -376,6 +423,8 @@ export declare function getServerFunctionInvocation(): ServerFunctionInvocation
 export declare function getEventServerFunctionInvocation(event: RequestEvent | undefined): ServerFunctionInvocation | undefined;
 export declare function foldSetCookies(headers: Headers, setCookies: readonly string[]): Headers;
 export declare function createNoJSHandler(options?: NoJSHandlerOptions): (result: unknown, request: Request, args: unknown[], thrown?: boolean) => Response;
+/** @internal */
+export declare function guardFailures(value: any, state: any): any;
 /**
  * The response-side codec stream: `serializeStream` (shared.js) hardened
  * with request-lifetime teardown. Server-only on purpose — the shared half
@@ -384,14 +433,16 @@ export declare function createNoJSHandler(options?: NoJSHandlerOptions): (result
  * An abort of `signal` (the platform fires request.signal when the caller's
  * fetch aborts or the tab goes away) or the consumer cancelling the
  * ReadableStream (how platforms surface a dropped connection to the body)
- * stops pending serialization and tears down a top-level async-iterable
- * value — the producer's `iterator.return()` runs, so generator `finally`
- * blocks execute instead of the server pumping a stream nobody is reading.
- * Top-level only: that is the value-tier shape ("return a stream from the
- * server function"); iterables nested inside user objects are consumed by
- * the codec directly and stay untouched.
+ * stops pending serialization and tears down EVERY async-iterable or
+ * ReadableStream source in the result graph, nested ones included (#3125) —
+ * each producer's `iterator.return()` / `reader.cancel()` runs, so
+ * generator `finally` blocks execute instead of the server pumping streams
+ * nobody is reading. The wiring rides guardFailures' walk: it already wraps
+ * every channel before the codec sees the value, so the demand gate and the
+ * teardown registry are threaded through its state (`{ items: rows() }` —
+ * a cursor beside a total — gets the same two guarantees as `return rows()`).
  */
-export declare function serializeResponseStream(value: any, codecOptions: any, signal: any): ReadableStream<any>;
+export declare function serializeResponseStream(value: any, codecOptions: any, signal: any, scope: any): ReadableStream<any>;
 /** Message a sanitized (production) server error carries on the wire. */
 export declare const GENERIC_SERVER_ERROR_MESSAGE = "Internal Server Error";
 export declare function setServerFunctionsDev(dev: boolean): void;
@@ -399,4 +450,73 @@ export declare function sanitizeServerError(value: unknown): unknown;
 export declare function observeServerFunctionCalls(observer: (call: ServerFunctionCall) => void): () => void;
 export declare function serverFunctionUrl(id: string, boundArgs?: readonly unknown[]): string;
 export declare function parseServerFunctionUrl(url: string): string | null;
+/**
+ * Web-standard HTTP handler for server function calls: resolves the
+ * function id from the request, enforces the method allowlist (POST always
+ * dispatches; GET and HEAD dispatch only to functions that declared `GET`,
+ * with HEAD returning the equivalent GET's status and headers minus the
+ * body; every other method answers 405), decodes arguments, runs the
+ * function under a request-event scope, and encodes the result (forwarding
+ * redirect/revalidation metadata through headers). Mount it on the endpoint
+ * the client transport targets (default `/_server`); platform adapters (h3,
+ * express, ...) convert their request shape to a web `Request` around it.
+ *
+ * Requests are same-origin by default. The handler accepts browser requests
+ * proven by `Sec-Fetch-Site`, `Origin`, or `Referer`, and rejects requests
+ * without usable metadata unless explicitly configured otherwise. GET/HEAD
+ * requests to `GET`-declared functions skip this gate: they are reads by
+ * contract, cross-site response READING is already blocked by same-origin
+ * policy, and skipping it keeps the `Vary: Sec-Fetch-Site, Origin, Referer`
+ * it would impose off the responses shared caches are meant to store.
+ *
+ * Every response leaves with `Cache-Control: no-store` unless the function
+ * set its own cache policy (via `respond()` headers or a returned
+ * `Response`) — caching is opt-in on the wire, not just in prose.
+ *
+ * When the event carries a `response` head stub (`event.response`, see the
+ * server entry's `ResponseStub`), the handler folds it onto every outgoing
+ * response as the head freezes — its `Set-Cookie` values (cookies appended
+ * during the call) append cookie-by-cookie alongside the result's own,
+ * other stub headers fill gaps (the call's response metadata wins; the
+ * protocol-owned family — the error/format/single-flight tags, `Location`,
+ * `X-Revalidate` — never fills, and neither does `Content-Type`/`Content-
+ * Length` onto a bodiless response) — and marks the stub `committed`, so
+ * later cookie/header writes report instead of silently missing the wire.
+ *
+ * ## Thrown-error sanitization (security default)
+ *
+ * A thrown `Response`/envelope (`redirect`/`reload`/`respond`) is intentional
+ * control flow and is forwarded untouched. A *plain* thrown value (a bare
+ * `Error`, string, or object) is different: serialized verbatim it would ship
+ * its `message` and every own-property to the client — a driver/ORM error's
+ * failing query, connection string, or bound parameters included. So outside
+ * the dev build a plain thrown value is replaced with a generic `Error`
+ * before serialization; the client still receives *an* `Error` (the shape
+ * `submission.error` etc. expect), just with no leaked content. The dev
+ * build keeps full fidelity (message, stack, own-props) for DX and the dev
+ * toolbar inspector. Dev/prod is the BUILD VARIANT, not `NODE_ENV`:
+ * `@solidjs/web` publishes a dev copy of this entry behind the
+ * `development` export condition (what Vite dev resolves) and the default
+ * resolution sanitizes — as does importing the runtime source directly with
+ * no bundler signal (fail-safe).
+ *
+ * Escape hatch: brand the value with `markSafeError` (`Symbol.for(
+ * "solid.SafeError")`) to send its content intact in every environment.
+ * A `wrapInvocation`/`transformResult` override that maps errors expresses
+ * intent the same way — throw a `Response`/envelope, or brand the mapped
+ * error safe; an unbranded plain error it lets propagate is sanitized like
+ * any other, so a framework onError policy must brand its result to keep a
+ * custom client-facing message in production.
+ *
+ * @example
+ * ```ts
+ * import { handleServerFunctionRequest } from "@solidjs/web/server-functions";
+ * import "virtual:solid-server-function-manifest";
+ *
+ * // in the server's request handling:
+ * if (url.pathname.startsWith("/_server")) {
+ *   return handleServerFunctionRequest(request);
+ * }
+ * ```
+ */
 export declare function handleServerFunctionRequest(request: Request, options?: HandleServerFunctionOptions): Promise<Response>;

package/types-cjs/server-functions/shared.d.cts

@@ -8,19 +8,22 @@ import { JSONCodecOptions } from "../serializer-decode.cjs";
  * HTTP handler. Integrations decoding passthrough responses themselves (no
  * registered consumer) see this shape from `decodeResponse`. The top level
  * is reserved for the protocol — integration payload lives entirely under
- * `data`, which can be any codec-serializable value.
+ * `data`, the envelope keyed by source id (the unnamed registration's
+ * slice rides under the reserved id "true"); each slice can be any
+ * codec-serializable value.
  */
 export interface SingleFlightPayload<T = unknown, D = unknown> {
     /** The server function's return (or thrown) value. */
     value: T;
-    /** The integration-produced data payload. */
+    /** The integration-produced data payload, keyed by source id. */
     data: D;
 }
 /**
  * Envelope context delivered alongside single-flight data: the transport
- * response, whose headers carry the integration metadata (`Location` for
- * redirect-with-data, `X-Revalidate` keys) and status. The body is already
- * consumed — read `data` and `value` from the delivery, not from here.
+ * response, whose headers carry the integration metadata (the redirect
+ * carrier for redirect-with-data, `X-Revalidate` keys) and status. The
+ * body is already consumed — read `data` and `value` from the delivery,
+ * not from here.
  */
 export interface FlightDataContext {
     /** The HTTP response the data arrived on (metadata only). */
@@ -131,11 +134,27 @@ export interface ServerFunctionRPC {
 export type BodyFormatValue = (typeof BodyFormat)[keyof typeof BodyFormat];
 export declare function configureServerFunctionsCodec(codec: JSONCodecOptions | undefined): void;
 export declare function getServerFunctionsCodec(): JSONCodecOptions | undefined;
+/**
+ * Validates a flight data source id (both registration halves share the
+ * rule): ids travel the `SINGLE_FLIGHT_HEADER` as a comma-separated list,
+ * so they cannot be empty or contain commas, and "true" is reserved for
+ * the unnamed registration.
+ *
+ * Transport building block; not meant for hand-written code.
+ * @internal
+ */
+export declare function assertFlightSource(source: string): void;
 export declare function subscribeFlightData<D = unknown>(consumer: FlightDataConsumer<D>): () => void;
-export declare function getFlightDataConsumer(): FlightDataConsumer | undefined;
+export declare function subscribeFlightData<D = unknown>(source: string, consumer: FlightDataConsumer<D>): () => void;
+export declare function getFlightDataConsumer(source?: string): FlightDataConsumer | undefined;
+export declare function getFlightDataSourceIds(): string[];
 export declare function frameAddress(id: string, args?: readonly unknown[]): string;
 export declare function serverFunctionAddress(endpoint: string, id: string): string;
-export declare function parseServerFunctionAddress(pathname: string, endpoint: string): string | null;
+export declare function serverFunctionDataAddress(endpoint: string, id: string): string;
+export declare function parseServerFunctionAddress(pathname: string, endpoint: string): {
+    id: string;
+    data: boolean;
+} | null;
 /**
  * Response header marking a thrown server-function error. The value is the
  * error's message (the structured error itself travels in the body); `"true"`
@@ -151,6 +170,51 @@ export declare function decodeErrorHeaderValue(value: string): string;
 export declare const INSTANCE_HEADER = "X-Server-Function-Instance";
 /** Header carrying the body format tag (a `BodyFormat` value). */
 export declare const BODY_FORMAT_HEADER = "X-Server-Function-Format";
+/**
+ * Header labelling the unknown-id 404: the address was well-formed but its
+ * id is not registered in the deployment that answered (#3110). This is the
+ * ordinary shape of version skew — a tab holding the previous build's ids
+ * across a deploy — and the label is what lets an integration recover
+ * (e.g. reload the document) instead of surfacing a generic failed call.
+ * Nothing distinguishes it otherwise: a CDN 404 and a skew 404 look alike.
+ */
+export declare const UNKNOWN_HEADER = "X-Server-Function-Unknown";
+/**
+ * Header carrying a redirect to scripted callers. fetch FOLLOWS redirect
+ * statuses before the transport can read them, so a scripted answer masks
+ * the 3xx to 200 and this header carries what the mask erases: the author's
+ * status and the target RESOLVED against the request url — exactly the
+ * meaning HTTP assigns the `Location` a form post would have received.
+ * Value: `<status> <absolute-url>`, decode with `decodeRedirectHeaderValue`.
+ *
+ * Carrying the resolved absolute form is the point (#3102, #3107): the
+ * reader never guesses navigation strategy from how the author spelled the
+ * target — `redirect("/")` and `redirect(new URL("/", url).href)` arrive
+ * identical by construction, and same-origin vs cross-origin is a real URL
+ * comparison, not a `startsWith("http")` coin toss. `Location` itself never
+ * rides a masked answer: on a 200 it has no HTTP meaning, and it collided
+ * with authored Locations on statuses that forward (a 201's created-at is
+ * data, not navigation).
+ */
+export declare const REDIRECT_HEADER = "X-Server-Function-Redirect";
+/**
+ * Decodes a `REDIRECT_HEADER` value into the author's status and the
+ * resolved absolute target. Integration plumbing for readers of the header
+ * (routers); the wire format is the runtime's own, not a contract to parse
+ * by hand.
+ *
+ * The documented output — a resolved ABSOLUTE http(s) target and a redirect
+ * status — is enforced, not assumed (#3175): the absoluteness used to be a
+ * property of the server having resolved it, and a hostile or buggy peer
+ * could ride a `javascript:` target straight into the `location.href =
+ * decoded.url` an integration reasonably writes. A value that does not
+ * parse as an absolute http(s) url, or whose status is not one the runtime
+ * masks, decodes to `undefined` — the same answer a missing header gives.
+ */
+export declare function decodeRedirectHeaderValue(value: string | null | undefined): {
+    status: number;
+    url: string;
+} | undefined;
 /**
  * Header driving the single-flight protocol on both legs: on the request it
  * opts the call into flight-data collection (the integration sends it on
@@ -200,15 +264,14 @@ export declare class ChunkReader {
         value: string;
     }>;
     drain(interpret: any): Promise<void>;
-} /**
- * Serializes a value as a stream of length-prefixed SerovalNode chunks.
- * Async values (promises, streams) keep the stream open until they settle,
- * so one connection carries incremental results. Codec options must match
- * the deserializing peer.
- *
- * Transport building block; not meant for hand-written code.
+}
+/**
+ * Encodes a terminal error-trailer frame payload. The value is expected to
+ * be already sanitized by the caller; only `name` and `message` travel.
+ * Transport wire detail; not meant for hand-written code.
  * @internal
  */
+export declare function encodeErrorTrailer(error: unknown): string;
 export declare function serializeStream(value: unknown, codecOptions?: JSONCodecOptions): ReadableStream<Uint8Array>;
 export declare function serializeString(value: unknown, codecOptions?: JSONCodecOptions): Promise<string>;
 export declare function deserializeStream<T = unknown>(source: Request | Response, codecOptions?: JSONCodecOptions): Promise<T>;

package/types-cjs/server-mock.d.cts

@@ -1,10 +1,23 @@
 import type { RequestEvent, RequestEventLocals, ResponseStub } from "./client.cjs";
+import type { JSX } from "./jsx.cjs";
+/** An explicit `<link rel="preload">` emitted by the SSR asset pipeline. */
+export type PreloadLink = {
+    href: string;
+    as: JSX.HTMLPreloadAs;
+    type?: string;
+    crossorigin?: JSX.HTMLCrossorigin;
+    integrity?: string;
+    referrerpolicy?: JSX.HTMLReferrerPolicy;
+    fetchpriority?: JSX.HTMLFetchPriority;
+    media?: string;
+};
 /** Static asset manifest produced by a build (e.g. parsed Vite manifest.json). */
 export type AssetManifest = Record<string, {
     file: string;
     css?: string[];
     isEntry?: boolean;
     imports?: string[];
+    preloads?: PreloadLink[];
 }> & {
     _base?: string;
 };
@@ -17,6 +30,7 @@ export type InlineStyleAsset = {
 export type ResolvedAssets = {
     js: string[];
     css: (string | InlineStyleAsset)[];
+    preloads?: PreloadLink[];
 };
 /**
  * Resolver form of the manifest option — the primitive a dev server
@@ -24,8 +38,9 @@ export type ResolvedAssets = {
  * normalized into a sync resolver internally). `resolve` may return a
  * promise (async resolvers require streaming rendering); CSS entries may be
  * URL strings (emitted as load-gated `<link>` tags) or inline-style
- * descriptors (emitted as `<style>` tags). A bare `resolve`-shaped function
- * is accepted as shorthand for `{ resolve }`.
+ * descriptors (emitted as `<style>` tags), and `preloads` carries explicit
+ * preload links selected by the integration. A bare `resolve`-shaped
+ * function is accepted as shorthand for `{ resolve }`.
  */
 export type AssetResolver = {
     resolve(key: string): ResolvedAssets | null | undefined | Promise<ResolvedAssets | null | undefined>;

package/types-cjs/server.d.cts

@@ -5,12 +5,24 @@ export { clearFlashCookie, hasFlashCookie } from "./cookies.cjs";
 export { getServerFunctionMetadata, getServerFunctionRPC, isServerFunction } from "./server-functions/registry.cjs";
 import { JSX } from "./jsx.cjs";
 import { SerializerPlugin } from "./serializer-decode.cjs";
+/** An explicit `<link rel="preload">` emitted by the SSR asset pipeline. */
+export type PreloadLink = {
+    href: string;
+    as: JSX.HTMLPreloadAs;
+    type?: string;
+    crossorigin?: JSX.HTMLCrossorigin;
+    integrity?: string;
+    referrerpolicy?: JSX.HTMLReferrerPolicy;
+    fetchpriority?: JSX.HTMLFetchPriority;
+    media?: string;
+};
 /** Static asset manifest produced by a build (e.g. parsed Vite manifest.json). */
 export type AssetManifest = Record<string, {
     file: string;
     css?: string[];
     isEntry?: boolean;
     imports?: string[];
+    preloads?: PreloadLink[];
 }> & {
     _base?: string;
 };
@@ -23,6 +35,7 @@ export type InlineStyleAsset = {
 export type ResolvedAssets = {
     js: string[];
     css: (string | InlineStyleAsset)[];
+    preloads?: PreloadLink[];
 };
 /**
  * Resolver form of the manifest option — the primitive a dev server
@@ -30,8 +43,9 @@ export type ResolvedAssets = {
  * normalized into a sync resolver internally). `resolve` may return a
  * promise (async resolvers require streaming rendering); CSS entries may be
  * URL strings (emitted as load-gated `<link>` tags) or inline-style
- * descriptors (emitted as `<style>` tags). A bare `resolve`-shaped function
- * is accepted as shorthand for `{ resolve }`.
+ * descriptors (emitted as `<style>` tags), and `preloads` carries explicit
+ * preload links selected by the integration. A bare `resolve`-shaped
+ * function is accepted as shorthand for `{ resolve }`.
  */
 export type AssetResolver = {
     resolve(key: string): ResolvedAssets | null | undefined | Promise<ResolvedAssets | null | undefined>;