@solidjs/web 2.0.0-beta.31 → 2.0.0-beta.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +1 -6
  2. package/dist/dev.cjs +234 -45
  3. package/dist/dev.js +221 -42
  4. package/dist/server.cjs +456 -123
  5. package/dist/server.js +445 -120
  6. package/dist/web.cjs +234 -45
  7. package/dist/web.js +221 -42
  8. package/frames/dist/client.cjs +217 -112
  9. package/frames/dist/client.dev.cjs +217 -112
  10. package/frames/dist/client.dev.js +218 -113
  11. package/frames/dist/client.js +218 -113
  12. package/frames/dist/server.cjs +488 -177
  13. package/frames/dist/server.js +489 -179
  14. package/package.json +55 -4
  15. package/serialization/dist/serialization.cjs +8 -0
  16. package/serialization/dist/serialization.js +1 -0
  17. package/serialization/types/index.d.ts +173 -6
  18. package/serialization/types-cjs/index.d.cts +173 -6
  19. package/server-functions/dist/client.cjs +46 -9
  20. package/server-functions/dist/client.js +47 -11
  21. package/server-functions/dist/rich-args.cjs +11 -0
  22. package/server-functions/dist/rich-args.js +9 -0
  23. package/server-functions/dist/server.cjs +275 -126
  24. package/server-functions/dist/server.dev.cjs +1053 -0
  25. package/server-functions/dist/server.dev.js +1021 -0
  26. package/server-functions/dist/server.js +273 -127
  27. package/server-functions/package.json +10 -0
  28. package/server-functions/rich-args/package.json +20 -0
  29. package/storage/types/index.d.ts +1 -1
  30. package/storage/types-cjs/index.d.cts +1 -1
  31. package/types/client.d.ts +127 -6
  32. package/types/core.d.ts +3 -1
  33. package/types/frames/client.d.ts +15 -1
  34. package/types/frames/frame-client.d.ts +37 -7
  35. package/types/frames/frame-sink.d.ts +26 -3
  36. package/types/frames/frame-transport.d.ts +39 -7
  37. package/types/frames/serializer.d.ts +173 -6
  38. package/types/frames/server.d.ts +22 -0
  39. package/types/index.d.ts +2 -3
  40. package/types/response.d.ts +45 -0
  41. package/types/serializer.d.ts +173 -6
  42. package/types/server-functions/client.d.ts +1 -0
  43. package/types/server-functions/rich-args.d.ts +10 -0
  44. package/types/server-functions/server.d.ts +98 -0
  45. package/types/server-functions/shared.d.ts +22 -0
  46. package/types/server-mock.d.ts +171 -59
  47. package/types/server.d.ts +188 -36
  48. package/types-cjs/client.d.cts +127 -6
  49. package/types-cjs/core.d.cts +3 -1
  50. package/types-cjs/frames/client.d.cts +15 -1
  51. package/types-cjs/frames/frame-client.d.cts +37 -7
  52. package/types-cjs/frames/frame-sink.d.cts +26 -3
  53. package/types-cjs/frames/frame-transport.d.cts +39 -7
  54. package/types-cjs/frames/serializer.d.cts +173 -6
  55. package/types-cjs/frames/server.d.cts +22 -0
  56. package/types-cjs/index.d.cts +2 -3
  57. package/types-cjs/response.d.cts +45 -0
  58. package/types-cjs/serializer.d.cts +173 -6
  59. package/types-cjs/server-functions/client.d.cts +1 -0
  60. package/types-cjs/server-functions/rich-args.d.cts +10 -0
  61. package/types-cjs/server-functions/server.d.cts +98 -0
  62. package/types-cjs/server-functions/shared.d.cts +22 -0
  63. package/types-cjs/server-mock.d.cts +171 -59
  64. package/types-cjs/server.d.cts +188 -36
@@ -6,9 +6,17 @@
6
6
  * inside the boundary are preserved across server updates — the
7
7
  * version is a stale-guard only ("policy A"): newer content morphs in
8
8
  * place, and teardown is `dispose()`, never a version bump.
9
+ *
10
+ * EXPERIMENTAL — the frames/server-components surface ships as an
11
+ * experimental preview, excluded from the 2.0 stability guarantee: API
12
+ * shapes and the wire format may change between prereleases (RFC 11).
13
+ * Every export in this module is `@experimental`.
9
14
  */
10
15
 
11
- /** One transport chunk of a frame stream, addressed by frame `id`. */
16
+ /**
17
+ * One transport chunk of a frame stream, addressed by frame `id`.
18
+ * @experimental
19
+ */
12
20
  export type FrameChunk =
13
21
  | { type: "start"; id: string; version: number }
14
22
  | { type: "html"; id: string; version: number; html: string }
@@ -48,6 +56,7 @@ export type FrameChunk =
48
56
  * Maps a wire chunk onto resident-store record writes. `data` chunks map to
49
57
  * no records — they are response-scoped and the host applies them through
50
58
  * its data hook.
59
+ * @experimental
51
60
  */
52
61
  export function chunkToRecords(chunk: FrameChunk): Record<string, unknown>;
53
62
 
@@ -55,13 +64,17 @@ export function chunkToRecords(chunk: FrameChunk): Record<string, unknown>;
55
64
  * One store write applied to a frame: `r` maps record keys to values
56
65
  * (`chunkToRecords` produces these from wire chunks) and `version` is the
57
66
  * stream stamp — an older version than the frame's current one is ignored.
67
+ * @experimental
58
68
  */
59
69
  export interface FrameWrite {
60
70
  version: number;
61
71
  r: Record<string, unknown>;
62
72
  }
63
73
 
64
- /** Context passed to a slot callback. */
74
+ /**
75
+ * Context passed to a slot callback.
76
+ * @experimental
77
+ */
65
78
  export interface SlotContext {
66
79
  /**
67
80
  * True only for the hydration-attach invocation of an adopted
@@ -117,9 +130,11 @@ export interface SlotContext {
117
130
  * resolved args (primitives literal, `{$ref}` data resolved through the
118
131
  * host, `{$frame}` regions as marker-range fragments). Return nodes to fill
119
132
  * the range, or `undefined` to claim `ctx.existing` untouched.
133
+ * @experimental
120
134
  */
121
135
  export type Slot = (props: Record<string, unknown>, ctx: SlotContext) => Node | Node[] | undefined;
122
136
 
137
+ /** @experimental */
123
138
  export interface Frame {
124
139
  /** Merge a write into the store and flush (morph/reveal/slot sync). */
125
140
  apply(write: FrameWrite): void;
@@ -159,6 +174,7 @@ export interface Frame {
159
174
  * An id may have several frames (the same server component mounted more
160
175
  * than once): chunks fan out to all of them, and a frame registering after
161
176
  * delivery is seeded from a sibling's store.
177
+ * @experimental
162
178
  */
163
179
  export interface FrameHost {
164
180
  register(id: string, frame: Frame): void;
@@ -180,10 +196,14 @@ export interface FrameHost {
180
196
  * boundary (nested region frames dispatch too); use it to re-apply
181
197
  * client-owned decorations on server-owned markup (router affordance
182
198
  * reflection, e.g. `aria-current`) without a MutationObserver.
199
+ * @experimental
183
200
  */
184
201
  export const FRAME_APPLIED_EVENT: "frame:applied";
185
202
 
186
- /** Options for `createFrameHost`. */
203
+ /**
204
+ * Options for `createFrameHost`.
205
+ * @experimental
206
+ */
187
207
  export interface FrameHostOptions {
188
208
  /**
189
209
  * Backs `{$ref}` slot args (typically a codec data table's `resolve`).
@@ -201,9 +221,13 @@ export interface FrameHostOptions {
201
221
  applyData?(chunk: Extract<FrameChunk, { type: "data" }>): void;
202
222
  }
203
223
 
224
+ /** @experimental */
204
225
  export function createFrameHost(options?: FrameHostOptions): FrameHost;
205
226
 
206
- /** Options for `createFrame` / `createFrameElement`. */
227
+ /**
228
+ * Options for `createFrame` / `createFrameElement`.
229
+ * @experimental
230
+ */
207
231
  export interface FrameOptions {
208
232
  /** Register with this host under `id`, receiving routed/buffered chunks. */
209
233
  host?: FrameHost;
@@ -217,7 +241,7 @@ export interface FrameOptions {
217
241
  */
218
242
  adopt?: boolean;
219
243
  /** Called after each apply flush (tests/telemetry). */
220
- onApply?(info: { version: number; reason: "materialize" | "morph" | "reveal" }): void;
244
+ onApply?(info: { version: number; reason: "materialize" | "morph" | "reveal" | "error" }): void;
221
245
  /**
222
246
  * Wraps element-claim sweeps (`a[href]`/`form[action]` in materialized
223
247
  * server content — and only those) so claim consumers register their
@@ -259,12 +283,17 @@ export interface FrameOptions {
259
283
  * so the first apply morphs against it and slots sync immediately (hydration
260
284
  * attach), claiming their server-rendered DOM — a document boot needs no
261
285
  * chunk.
286
+ * @experimental
262
287
  */
263
288
  export function createFrame(boundary: Element, options?: FrameOptions): Frame;
264
289
 
265
- /** The default boundary/region element tag and its id attribute — the DOM
266
- * contract the producer emits at t=0 and the consumer creates/adopts. */
290
+ /**
291
+ * The default boundary/region element tag and its id attribute — the DOM
292
+ * contract the producer emits at t=0 and the consumer creates/adopts.
293
+ * @experimental
294
+ */
267
295
  export const FRAME_TAG: "dx-frame";
296
+ /** @experimental */
268
297
  export const FRAME_ID_ATTR: "data-fid";
269
298
 
270
299
  /**
@@ -274,6 +303,7 @@ export const FRAME_ID_ATTR: "data-fid";
274
303
  * returned `element` in any position — single, array, or fragment — with no
275
304
  * special-casing. One frame per element; lifecycle belongs to the creator via
276
305
  * `dispose()` (register it with your owner's cleanup).
306
+ * @experimental
277
307
  */
278
308
  export function createFrameElement(options: FrameOptions): {
279
309
  readonly element: Element;
@@ -1,6 +1,13 @@
1
+ // EXPERIMENTAL — the frames/server-components surface ships as an
2
+ // experimental preview, excluded from the 2.0 stability guarantee: API
3
+ // shapes and the wire format may change between prereleases (RFC 11).
4
+ // Every export in this module is @experimental.
1
5
  import { FrameChunk } from "./frame-client.cjs";
2
6
 
3
- /** Addresses a frame stream: the boundary id and this response's version. */
7
+ /**
8
+ * Addresses a frame stream: the boundary id and this response's version.
9
+ * @experimental
10
+ */
4
11
  export interface FrameAddress {
5
12
  id: string;
6
13
  version: number;
@@ -12,13 +19,17 @@ export interface FrameAddress {
12
19
  * method emits transport-agnostic chunks; `emit` is the envelope boundary.
13
20
  * @internal Compiler/renderer wiring — use `renderToFrameStream` or
14
21
  * `renderServerComponent` instead.
22
+ * @experimental
15
23
  */
16
24
  export function createFrameSink(
17
25
  emit: (chunk: FrameChunk) => void,
18
26
  frame: FrameAddress
19
27
  ): Record<string, (...args: any[]) => void>;
20
28
 
21
- /** Options shared by the frame producers. */
29
+ /**
30
+ * Options shared by the frame producers.
31
+ * @experimental
32
+ */
22
33
  export interface FrameStreamOptions {
23
34
  /** Boundary address; defaults to `{ id: "", version: 1 }`. */
24
35
  frame?: { id?: string; version?: number };
@@ -26,7 +37,10 @@ export interface FrameStreamOptions {
26
37
  [key: string]: unknown;
27
38
  }
28
39
 
29
- /** A produced frame stream: pipe chunks, or await the collected array. */
40
+ /**
41
+ * A produced frame stream: pipe chunks, or await the collected array.
42
+ * @experimental
43
+ */
30
44
  export interface FrameStream extends PromiseLike<FrameChunk[]> {
31
45
  pipe(writable: { write(chunk: FrameChunk): void; end?(): void }): void;
32
46
  }
@@ -37,6 +51,7 @@ export interface FrameStream extends PromiseLike<FrameChunk[]> {
37
51
  * by a chunk envelope (`start` up front, `complete` at stream end). Data
38
52
  * records default to the keyed JSON codec (decode with
39
53
  * `createJSONDataTable`).
54
+ * @experimental
40
55
  */
41
56
  export function renderToFrameStream(code: () => unknown, options?: FrameStreamOptions): FrameStream;
42
57
 
@@ -57,6 +72,7 @@ export function renderToFrameStream(code: () => unknown, options?: FrameStreamOp
57
72
  *
58
73
  * The props a *client* passes never reach the server — server inputs are the
59
74
  * function's arguments.
75
+ * @experimental
60
76
  */
61
77
  export function renderServerComponent(
62
78
  component: (props: Record<string, any>) => unknown,
@@ -70,6 +86,7 @@ export function renderServerComponent(
70
86
  * the live render context, so it must only be used during the frame's
71
87
  * render.
72
88
  * @internal Exposed for framework bindings composing their own producers.
89
+ * @experimental
73
90
  */
74
91
  export function createSlotProps(
75
92
  sink: ReturnType<typeof createFrameSink>,
@@ -82,6 +99,7 @@ export function createSlotProps(
82
99
  * the client and `X-Content-Raw` so the server-function handler forwards it
83
100
  * untouched. `init` (headers/status, e.g. from a `respond()` envelope)
84
101
  * merges in; the frame tags win on conflict.
102
+ * @experimental
85
103
  */
86
104
  export function serverComponentResponse(
87
105
  component: (props: Record<string, any>) => unknown,
@@ -103,6 +121,7 @@ export function serverComponentResponse(
103
121
  * provideEvent
104
122
  * });
105
123
  * ```
124
+ * @experimental
106
125
  */
107
126
  export function frameTransformResult(event: unknown, result: unknown): unknown;
108
127
 
@@ -115,6 +134,7 @@ export function frameTransformResult(event: unknown, result: unknown): unknown;
115
134
  * positions (the one hydration-time exception), wrapped in the same marker
116
135
  * dialect the chunk producer emits so the adopting client binds slots and
117
136
  * regions onto the server-rendered ranges.
137
+ * @experimental
118
138
  */
119
139
  export function createDocumentSlotProps(
120
140
  clientProps: Record<string, unknown>,
@@ -128,6 +148,7 @@ export function createDocumentSlotProps(
128
148
  * as an inline-renderable server component (frame markers + document
129
149
  * slot props), branded with its function id and the call's wire address.
130
150
  * Non-function results pass through.
151
+ * @experimental
131
152
  */
132
153
  export function frameTransformDirectResult<T>(
133
154
  value: T,
@@ -143,6 +164,7 @@ export function frameTransformDirectResult<T>(
143
164
  * component entries serialized as flight references. Returns `undefined`
144
165
  * when nothing invalidated is markup (the response stays the plain
145
166
  * single-flight envelope).
167
+ * @experimental
146
168
  */
147
169
  export function frameTransformFlightResult(
148
170
  event: unknown,
@@ -167,5 +189,6 @@ export {
167
189
  * self-bootstraps the registry. Kept for integrations still installing it
168
190
  * document-wide; the client upgrades the registry via
169
191
  * `installServerComponents()`.
192
+ * @experimental
170
193
  */
171
194
  export const SERVER_COMPONENT_BOOTSTRAP: string;
@@ -1,3 +1,7 @@
1
+ // EXPERIMENTAL — the frames/server-components surface ships as an
2
+ // experimental preview, excluded from the 2.0 stability guarantee: API
3
+ // shapes and the wire format may change between prereleases (RFC 11).
4
+ // Every export in this module is @experimental.
1
5
  import { FrameChunk, FrameHost } from "./frame-client.cjs";
2
6
  import { JSONCodecOptions } from "./serializer.cjs";
3
7
 
@@ -11,13 +15,20 @@ type FlightConsumer = (data: unknown, context: { response: Response }) => void |
11
15
  * Header tagging a Response as a frame stream; its value is the producing
12
16
  * frame's id. Frame-owned wire contract — deliberately not a server-function
13
17
  * `BodyFormat` entry, since the body is frame chunks, not a serialized value.
18
+ * @experimental
14
19
  */
15
20
  export const FRAME_STREAM_HEADER: "X-Frame-Stream";
16
21
 
17
- /** Whether a fetch Response carries a frame stream. */
22
+ /**
23
+ * Whether a fetch Response carries a frame stream.
24
+ * @experimental
25
+ */
18
26
  export function isFrameStreamResponse(response: Response): boolean;
19
27
 
20
- /** Options for `applyFrameResponse`. */
28
+ /**
29
+ * Options for `applyFrameResponse`.
30
+ * @experimental
31
+ */
21
32
  export interface ApplyFrameResponseOptions {
22
33
  /**
23
34
  * Remap the producer's root frame id onto a local one — the id your
@@ -57,6 +68,7 @@ export interface ApplyFrameResponseOptions {
57
68
  * await applyFrameResponse(response, host, { as: "story-pane" });
58
69
  * }
59
70
  * ```
71
+ * @experimental
60
72
  */
61
73
  export function applyFrameResponse(
62
74
  response: Response,
@@ -64,13 +76,22 @@ export function applyFrameResponse(
64
76
  options?: ApplyFrameResponseOptions
65
77
  ): Promise<string>;
66
78
 
67
- /** Brands an inline-rendered server component with its function id. */
79
+ /**
80
+ * Brands an inline-rendered server component with its function id.
81
+ * @experimental
82
+ */
68
83
  export const SERVER_COMPONENT: unique symbol;
69
84
 
70
- /** The unwrapped server component behind an inline-render wrap. */
85
+ /**
86
+ * The unwrapped server component behind an inline-render wrap.
87
+ * @experimental
88
+ */
71
89
  export const SERVER_COMPONENT_SOURCE: unique symbol;
72
90
 
73
- /** The call's wire address (`frameAddress`), for regions to be emitted under. */
91
+ /**
92
+ * The call's wire address (`frameAddress`), for regions to be emitted under.
93
+ * @experimental
94
+ */
74
95
  export const SERVER_COMPONENT_ADDRESS: unique symbol;
75
96
 
76
97
  /**
@@ -81,10 +102,14 @@ export const SERVER_COMPONENT_ADDRESS: unique symbol;
81
102
  * instance, new binding" — keep the mounted instance and deliver the new
82
103
  * address into it; a different function swaps normally. `Symbol.for`, so
83
104
  * frameworks can honor it without importing this module.
105
+ * @experimental
84
106
  */
85
107
  export const COMPONENT_BINDING: unique symbol;
86
108
 
87
- /** The value under `COMPONENT_BINDING` on a transport-resolved binding. */
109
+ /**
110
+ * The value under `COMPONENT_BINDING` on a transport-resolved binding.
111
+ * @experimental
112
+ */
88
113
  export interface ComponentBinding<C = unknown> {
89
114
  /** The per-function mount component (the equals-gate identity). */
90
115
  component: C;
@@ -98,6 +123,7 @@ export interface ComponentBinding<C = unknown> {
98
123
  * placeholder in the hydration serializer, a live-registry lookup by call
99
124
  * address in the JSON codec (single-flight envelopes) — its markup never
100
125
  * rides as data.
126
+ * @experimental
101
127
  */
102
128
  export const ServerComponentPlugin: unknown;
103
129
 
@@ -108,6 +134,7 @@ export const ServerComponentPlugin: unknown;
108
134
  * on a script's first reference, a bare read after). Loaded document-SSR
109
135
  * modules install this (see frame-sink); client bundles never carry the
110
136
  * bootstrap text.
137
+ * @experimental
111
138
  */
112
139
  export function setServerComponentBootstrap(resolve: (ctx: unknown) => string): void;
113
140
 
@@ -115,10 +142,14 @@ export function setServerComponentBootstrap(resolve: (ctx: unknown) => string):
115
142
  * The codec options for a single-flight envelope: `codec` plus
116
143
  * `ServerComponentPlugin` (deduped by tag). Injected by the protocol on both
117
144
  * legs; exported for integrations composing their own flight carriers.
145
+ * @experimental
118
146
  */
119
147
  export function flightCodec(codec?: JSONCodecOptions): JSONCodecOptions;
120
148
 
121
- /** Options for `createServerComponentHandler`. */
149
+ /**
150
+ * Options for `createServerComponentHandler`.
151
+ * @experimental
152
+ */
122
153
  export interface ServerComponentHandlerOptions<C = unknown> {
123
154
  host: FrameHost;
124
155
  /**
@@ -170,6 +201,7 @@ export interface ServerComponentHandlerOptions<C = unknown> {
170
201
  * per-args entries — while mounts are per-SITE, rendering the per-function
171
202
  * component and following delivered addresses. An address nothing is bound
172
203
  * to warms its store (preload isolation is the default, not a rule).
204
+ * @experimental
173
205
  */
174
206
  export function createServerComponentHandler<C>(options: ServerComponentHandlerOptions<C>): {
175
207
  intercept?(info: { id: string; meta: unknown; args: unknown[] }): unknown;
@@ -1,23 +1,142 @@
1
- import { Plugin, Serializer, SerovalNode } from "seroval";
1
+ // Serialization surface (published as `@solidjs/web/serialization`): the
2
+ // runtime's Seroval machinery, exposed for the runtime's own entries and
3
+ // for integrations building transports on the same codec. This is
4
+ // INTEGRATION-FACING plumbing, not application API — it is exempt from the
5
+ // 2.0 stability guarantee and may change between releases. Application and
6
+ // router code should configure `codec` on the server-function entries
7
+ // instead of importing from here.
8
+ import { Serializer, SerovalNode } from "seroval";
2
9
 
3
10
  /**
4
11
  * Seroval's node shape — the intermediate representation `serializeJSON`
5
12
  * emits and `createJSONDeserializer` consumes. Safe to `JSON.stringify`.
13
+ *
14
+ * Integration-facing; may change (see the entry banner).
6
15
  */
7
16
  export type { SerovalNode };
8
17
 
18
+ // ---- Plugin authoring ----
19
+ //
20
+ // Unlike the rest of this entry, plugin authoring is APPLICATION-FACING —
21
+ // it is the supported way to feed the serializers' `plugins` options and
22
+ // the server-function entries' `codec.plugins`. The values re-export
23
+ // seroval's own (`createPlugin`, `OpaqueReference` — see serializer.js);
24
+ // the TYPES are declared here by hand, like everything else in this file,
25
+ // because seroval's published d.ts use extensionless ESM-relative imports
26
+ // that `moduleResolution: "nodenext"` cannot follow — a bare type
27
+ // re-export would silently degrade the whole authoring surface to `any`
28
+ // under skipLibCheck. The declarations mirror seroval ~1.5 exactly; the
29
+ // `~` pin is what makes mirroring safe.
30
+
31
+ /** Per-plugin bookkeeping seroval hands each plugin callback. */
32
+ export interface PluginData {
33
+ id: number;
34
+ }
35
+
36
+ /**
37
+ * The shape of a plugin's parsed payload: a map of `SerovalNode`s produced
38
+ * by the parse contexts, consumed by `serialize`/`deserialize`.
39
+ */
40
+ export type PluginInfo = { [key: string]: SerovalNode };
41
+
42
+ /** Parse context for `parse.sync`: turns child values into nodes. */
43
+ export interface SyncParsePluginContext {
44
+ parse<T>(current: T): SerovalNode;
45
+ }
46
+
47
+ /** Parse context for `parse.async`: like sync, but child parses await. */
48
+ export interface AsyncParsePluginContext {
49
+ parse<T>(current: T): Promise<SerovalNode>;
50
+ }
51
+
52
+ /**
53
+ * Parse context for `parse.stream`: sync parsing plus the streaming
54
+ * lifecycle (pending-state tracking, late node emission, cleanup).
55
+ */
56
+ export interface StreamParsePluginContext {
57
+ parse<T>(current: T): SerovalNode;
58
+ parseWithError<T>(current: T): SerovalNode | undefined;
59
+ isAlive(): boolean;
60
+ pushPendingState(): void;
61
+ popPendingState(): void;
62
+ onParse(node: SerovalNode): void;
63
+ onError(error: unknown): void;
64
+ addCleanup(callback: () => void): void;
65
+ }
66
+
67
+ /** Serialize context: renders child nodes to JS source. */
68
+ export interface SerializePluginContext {
69
+ serialize(node: SerovalNode): string;
70
+ }
71
+
72
+ /** Deserialize context: revives child nodes to runtime values. */
73
+ export interface DeserializePluginContext {
74
+ deserialize<T>(node: SerovalNode): T;
75
+ }
76
+
9
77
  /**
10
78
  * A Seroval plugin usable with the web serializers — teaches the codec how
11
- * to encode/decode a custom value type. Supply matching plugins on both
12
- * peers of a transport.
79
+ * to encode/decode a custom value type (`Value` is the value it matches,
80
+ * `Info` its parsed payload). Supply matching plugins on both peers of a
81
+ * transport. Bare `SerializerPlugin` (both parameters defaulted to `any`)
82
+ * is the list-element type every `plugins` option accepts.
83
+ *
84
+ * Integration-facing; may change (see the entry banner).
13
85
  */
14
- export type SerializerPlugin = Plugin<any, any>;
86
+ export interface SerializerPlugin<Value = any, Info extends PluginInfo = any> {
87
+ /** A unique string identifying the plugin — namespace it (`"app/Thing"`). */
88
+ tag: string;
89
+ /** Dependency plugins, resolved ahead of this one. */
90
+ extends?: SerializerPlugin[];
91
+ /** Whether `value` is this plugin's to encode. */
92
+ test(value: unknown): boolean;
93
+ /** Parsing modes — provide the ones the transports you target use. */
94
+ parse: {
95
+ sync?: (value: Value, ctx: SyncParsePluginContext, data: PluginData) => Info;
96
+ async?: (value: Value, ctx: AsyncParsePluginContext, data: PluginData) => Promise<Info>;
97
+ stream?: (value: Value, ctx: StreamParsePluginContext, data: PluginData) => Info;
98
+ };
99
+ /** Renders the parsed payload as JS source (script-injection form). */
100
+ serialize(node: Info, ctx: SerializePluginContext, data: PluginData): string;
101
+ /** Revives the parsed payload back into the runtime value. */
102
+ deserialize(node: Info, ctx: DeserializePluginContext, data: PluginData): Value;
103
+ }
104
+
105
+ /**
106
+ * Builds a `SerializerPlugin` — seroval's `createPlugin`, re-exported so
107
+ * plugin authors stay on the exact seroval instance/version the runtime
108
+ * serializes with. Import it from HERE, not from your own `seroval`
109
+ * dependency: a plugin built against a different copy/version would not
110
+ * fail the build — it would emit nodes the other peer can't interpret.
111
+ *
112
+ * Application-facing (see the plugin-authoring banner above).
113
+ */
114
+ export function createPlugin<Value, Info extends PluginInfo>(
115
+ plugin: SerializerPlugin<Value, Info>
116
+ ): SerializerPlugin<Value, Info>;
117
+
118
+ /**
119
+ * Seroval's `OpaqueReference`, re-exported from the runtime's own instance
120
+ * (an `OpaqueReference` from another seroval copy fails the serializer's
121
+ * instanceof check and serializes as a plain value): wraps a value so it
122
+ * crosses the wire as its `replacement` (default `undefined`) while
123
+ * staying readable in-process through `.value`.
124
+ *
125
+ * Application-facing (see the plugin-authoring banner above).
126
+ */
127
+ export class OpaqueReference<V, R = undefined> {
128
+ readonly value: V;
129
+ readonly replacement?: R;
130
+ constructor(value: V, replacement?: R);
131
+ }
15
132
 
16
133
  /**
17
134
  * Baseline plugin set for serializing web-platform values (AbortSignal,
18
135
  * Event, FormData, Headers, ReadableStream, Request, Response, URL, ...).
19
136
  * Applied by every serializer in this module; custom plugins compose ahead
20
137
  * of it via `resolveSerializerPlugins`.
138
+ *
139
+ * Integration-facing; may change (see the entry banner).
21
140
  */
22
141
  export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
23
142
 
@@ -26,10 +145,16 @@ export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
26
145
  * first so they can shadow a default for values both would match. Returns a
27
146
  * fresh array; the defaults are never mutated. Useful when handing a full
28
147
  * plugin list to another serialization layer.
148
+ *
149
+ * Integration-facing; may change (see the entry banner).
29
150
  */
30
151
  export function resolveSerializerPlugins(customPlugins?: SerializerPlugin[]): SerializerPlugin[];
31
152
 
32
- /** Options for `createSerializer`. */
153
+ /**
154
+ * Options for `createSerializer`.
155
+ *
156
+ * Integration-facing; may change (see the entry banner).
157
+ */
33
158
  export interface WebSerializerOptions {
34
159
  /** Name of the global object the emitted scripts write resolved values into. */
35
160
  globalIdentifier: string;
@@ -58,6 +183,8 @@ export interface WebSerializerOptions {
58
183
  * evaluated — the script-injection form of serialization renderers build
59
184
  * on. For a JSON-based wire codec (no eval on the receiving side), use
60
185
  * `serializeJSON` / `createJSONDeserializer` instead.
186
+ *
187
+ * Integration-facing; may change (see the entry banner).
61
188
  */
62
189
  export function createSerializer(options: WebSerializerOptions): Serializer;
63
190
 
@@ -96,6 +223,8 @@ export function getLocalHeaderScript(id?: string): string;
96
223
  * on the serializing and deserializing peer or payloads will not
97
224
  * round-trip — for server functions, set them once through the
98
225
  * client/server `codec` config option.
226
+ *
227
+ * Integration-facing; may change (see the entry banner).
99
228
  */
100
229
  export interface JSONCodecOptions {
101
230
  /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. Must match on both peers. */
@@ -113,7 +242,11 @@ export interface JSONCodecOptions {
113
242
  depthLimit?: number;
114
243
  }
115
244
 
116
- /** Options for `serializeJSON`. */
245
+ /**
246
+ * Options for `serializeJSON`.
247
+ *
248
+ * Integration-facing; may change (see the entry banner).
249
+ */
117
250
  export interface JSONSerializeOptions extends JSONCodecOptions {
118
251
  /**
119
252
  * Receives each serialized node; `initial` is true for the first chunk
@@ -132,6 +265,8 @@ export interface JSONSerializeOptions extends JSONCodecOptions {
132
265
  * the deserializing peer needs no script evaluation, so CSP-safe). Wire
133
266
  * framing of the nodes is the transport's concern. Returns a cancel
134
267
  * function that aborts pending async serialization.
268
+ *
269
+ * Integration-facing; may change (see the entry banner).
135
270
  */
136
271
  export function serializeJSON(value: unknown, options: JSONSerializeOptions): () => void;
137
272
 
@@ -141,14 +276,46 @@ export function serializeJSON(value: unknown, options: JSONSerializeOptions): ()
141
276
  * from one stream must go through the same deserializer instance. The first
142
277
  * chunk's return value is the decoded source value; feeding later chunks
143
278
  * settles the async values referenced inside it.
279
+ *
280
+ * Integration-facing; may change (see the entry banner).
144
281
  */
145
282
  export function createJSONDeserializer(options?: JSONCodecOptions): <T>(node: SerovalNode) => T;
146
283
 
284
+ /** Options for `createJSONSerializer`. */
285
+ export interface JSONSerializerOptions extends JSONCodecOptions {
286
+ /**
287
+ * Receives each keyed record — `initial` is true for a key's first node
288
+ * (the written value itself); async values patch through later records
289
+ * under the same key. The decoding peer is `createJSONDataTable`.
290
+ */
291
+ onData: (record: { key: string; node: SerovalNode; initial: boolean }) => void;
292
+ onError?: (error: unknown) => void;
293
+ /** Fires once `flush()` has been called and every pending value settled. */
294
+ onDone?: () => void;
295
+ }
296
+
297
+ /**
298
+ * The keyed, streaming encoder of the eval-free JSON codec — the render
299
+ * stream's data serializer (frames default to it). Each `write(key, value)`
300
+ * shares one reference space, so cross-record identity holds; `flush()`
301
+ * marks the write set complete (writes after it are dropped, mirroring the
302
+ * hydration serializer); `close()` aborts pending async serialization.
303
+ */
304
+ export function createJSONSerializer(options: JSONSerializerOptions): {
305
+ write(key: string, value: unknown): void;
306
+ flush(): void;
307
+ close(): void;
308
+ };
309
+
147
310
  /**
148
311
  * A resident, response-scoped decode table over the keyed JSON codec: apply
149
312
  * each frame `data` chunk with `apply`, resolve `{ $ref }` slot args with
150
313
  * `resolve`. The frames client host wires one per response
151
314
  * (`applyData: c => table.apply(c)`).
315
+ *
316
+ * Integration-facing; may change (see the entry banner). This serialization
317
+ * entry is the single home of the data table — the frames client consumes
318
+ * it internally rather than re-exporting it.
152
319
  */
153
320
  export interface JSONDataTable {
154
321
  apply(chunk: { key?: string; node?: unknown; initial?: boolean }): void;
@@ -22,9 +22,31 @@ import type { Element as SolidElement } from "solid-js";
22
22
  * re-creates everything. It is occurrence identity, not client data: it is
23
23
  * stripped before the client component sees its props. Positional identity is
24
24
  * the right default; `$key` matters when a live list reorders.
25
+ * @experimental
25
26
  */
26
27
  export type Slot<P = {}> = (props: P & {
27
28
  $key?: string | number;
28
29
  }) => SolidElement;
30
+ /**
31
+ * Types an async value crossing the slot border (DR-2, value tier). What you
32
+ * pass is what ships — the promise / async iterable itself rides the data
33
+ * channel — but the client's prop READ settles: it suspends into the covering
34
+ * boundary until first arrival (a promise's resolution, an iterable's first
35
+ * yield), then reads as the settled value, updating per yield for iterables.
36
+ *
37
+ * `asyncArg` is the type-level statement of that contract: identity at
38
+ * runtime, settled type at the border, so `Slot<P>` keeps the fill's props
39
+ * truthful to what its reads actually return.
40
+ *
41
+ * Slots render as JSX — the compiler wraps each prop in a getter so the read
42
+ * defers to the slot border, where the runtime owns it. A call form
43
+ * (`props.status({ … })`) evaluates its args eagerly in the component body —
44
+ * a top-level read, an error in most cases.
45
+ *
46
+ * ```tsx
47
+ * <props.status progress={asyncArg(gen.progress)} stats={asyncArg(gen.stats)} />
48
+ * ```
49
+ */
50
+ export declare function asyncArg<T>(value: PromiseLike<T> | AsyncIterable<T>): T;
29
51
  export { renderToFrameStream, renderServerComponent, serverComponentResponse, frameTransformResult, frameTransformFlightResult, createFrameSink, frameTransformDirectResult, ServerComponentPlugin, SERVER_COMPONENT_BOOTSTRAP } from "./frame-sink.cjs";
30
52
  export { FRAME_STREAM_HEADER, isFrameStreamResponse } from "./frame-transport.cjs";
@@ -96,9 +96,8 @@ export declare function render(code: () => JSX.Element, element: MountableElemen
96
96
  * and reactive bindings without reconstructing the DOM. Returns a `dispose`
97
97
  * function that tears down reactive scopes (DOM nodes are left in place).
98
98
  *
99
- * Use this when the page HTML was produced by `renderToString`,
100
- * `renderToStringAsync`, or `renderToStream`. For client-only apps, use
101
- * `render` instead.
99
+ * Use this when the page HTML was produced by `renderToString` or
100
+ * `renderToStream`. For client-only apps, use `render` instead.
102
101
  *
103
102
  * Pass `options.renderId` to hydrate one of multiple roots emitted by a
104
103
  * server render that used the same id.