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

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 (52) hide show
  1. package/dist/dev.cjs +58 -16
  2. package/dist/dev.js +54 -17
  3. package/dist/server.cjs +714 -75
  4. package/dist/server.js +711 -78
  5. package/dist/web.cjs +58 -16
  6. package/dist/web.js +54 -17
  7. package/frames/dist/client.cjs +181 -64
  8. package/frames/dist/client.dev.cjs +185 -64
  9. package/frames/dist/client.dev.js +183 -62
  10. package/frames/dist/client.js +179 -62
  11. package/frames/dist/server.cjs +972 -136
  12. package/frames/dist/server.js +974 -138
  13. package/package.json +17 -6
  14. package/serialization/decode/package.json +20 -0
  15. package/serialization/dist/decode.cjs +110 -0
  16. package/serialization/dist/decode.js +104 -0
  17. package/serialization/dist/serialization.cjs +98 -43
  18. package/serialization/dist/serialization.js +99 -44
  19. package/serialization/types/index.d.ts +18 -160
  20. package/serialization/types/serializer-decode.d.ts +182 -0
  21. package/serialization/types-cjs/index.d.cts +18 -160
  22. package/serialization/types-cjs/serializer-decode.d.cts +182 -0
  23. package/server-functions/dist/client.cjs +101 -105
  24. package/server-functions/dist/client.js +101 -105
  25. package/server-functions/dist/server.cjs +131 -107
  26. package/server-functions/dist/server.dev.cjs +131 -107
  27. package/server-functions/dist/server.dev.js +132 -108
  28. package/server-functions/dist/server.js +132 -108
  29. package/types/client.d.ts +23 -1
  30. package/types/cookies.d.ts +93 -0
  31. package/types/core.d.ts +1 -1
  32. package/types/frames/frame-client.d.ts +26 -0
  33. package/types/frames/frame-transport.d.ts +1 -1
  34. package/types/frames/serializer.d.ts +18 -160
  35. package/types/serializer-decode.d.ts +182 -0
  36. package/types/serializer.d.ts +18 -160
  37. package/types/server-functions/client.d.ts +1 -1
  38. package/types/server-functions/server.d.ts +1 -1
  39. package/types/server-functions/shared.d.ts +57 -1
  40. package/types/server.d.ts +21 -1
  41. package/types-cjs/client.d.cts +23 -1
  42. package/types-cjs/cookies.d.cts +93 -0
  43. package/types-cjs/core.d.cts +1 -1
  44. package/types-cjs/frames/frame-client.d.cts +26 -0
  45. package/types-cjs/frames/frame-transport.d.cts +1 -1
  46. package/types-cjs/frames/serializer.d.cts +18 -160
  47. package/types-cjs/serializer-decode.d.cts +182 -0
  48. package/types-cjs/serializer.d.cts +18 -160
  49. package/types-cjs/server-functions/client.d.cts +1 -1
  50. package/types-cjs/server-functions/server.d.cts +1 -1
  51. package/types-cjs/server-functions/shared.d.cts +57 -1
  52. package/types-cjs/server.d.cts +21 -1
@@ -5,15 +5,20 @@
5
5
  // 2.0 stability guarantee and may change between releases. Application and
6
6
  // router code should configure `codec` on the server-function entries
7
7
  // instead of importing from here.
8
- import { Serializer, SerovalNode } from "seroval";
9
-
10
- /**
11
- * Seroval's node shape — the intermediate representation `serializeJSON`
12
- * emits and `createJSONDeserializer` consumes. Safe to `JSON.stringify`.
13
- *
14
- * Integration-facing; may change (see the entry banner).
15
- */
16
- export type { SerovalNode };
8
+ import type { Serializer } from "seroval";
9
+ import {
10
+ JSONCodecOptions,
11
+ PluginInfo,
12
+ SerializerPlugin,
13
+ SerovalNode
14
+ } from "./serializer-decode.js";
15
+
16
+ // The decode half — `SerovalNode`, the plugin TYPES, `DEFAULT_WEB_PLUGINS`,
17
+ // `resolveSerializerPlugins`, `JSONCodecOptions`, `createJSONDeserializer`,
18
+ // `createJSONDataTable` — is declared in serializer-decode.d.ts (published
19
+ // as `@solidjs/web/serialization/decode`, the module lazy client consumers
20
+ // load) and re-exported here so this remains the full surface.
21
+ export * from "./serializer-decode.js";
17
22
 
18
23
  // ---- Plugin authoring ----
19
24
  //
@@ -21,86 +26,8 @@ export type { SerovalNode };
21
26
  // it is the supported way to feed the serializers' `plugins` options and
22
27
  // the server-function entries' `codec.plugins`. The values re-export
23
28
  // 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
-
77
- /**
78
- * A Seroval plugin usable with the web serializers — teaches the codec how
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).
85
- */
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
- }
29
+ // the plugin TYPES live in serializer-decode.d.ts (hand-declared there
30
+ // see its banner for why).
104
31
 
105
32
  /**
106
33
  * Builds a `SerializerPlugin` — seroval's `createPlugin`, re-exported so
@@ -130,26 +57,6 @@ export class OpaqueReference<V, R = undefined> {
130
57
  constructor(value: V, replacement?: R);
131
58
  }
132
59
 
133
- /**
134
- * Baseline plugin set for serializing web-platform values (AbortSignal,
135
- * Event, FormData, Headers, ReadableStream, Request, Response, URL, ...).
136
- * Applied by every serializer in this module; custom plugins compose ahead
137
- * of it via `resolveSerializerPlugins`.
138
- *
139
- * Integration-facing; may change (see the entry banner).
140
- */
141
- export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
142
-
143
- /**
144
- * Composes custom plugins with `DEFAULT_WEB_PLUGINS`. Custom plugins come
145
- * first so they can shadow a default for values both would match. Returns a
146
- * fresh array; the defaults are never mutated. Useful when handing a full
147
- * plugin list to another serialization layer.
148
- *
149
- * Integration-facing; may change (see the entry banner).
150
- */
151
- export function resolveSerializerPlugins(customPlugins?: SerializerPlugin[]): SerializerPlugin[];
152
-
153
60
  /**
154
61
  * Options for `createSerializer`.
155
62
  *
@@ -217,30 +124,8 @@ export function createHydrationSerializer(options: HydrationSerializerOptions):
217
124
  export function getLocalHeaderScript(id?: string): string;
218
125
 
219
126
  // ---- JSON codec (server function transports) ----
220
-
221
- /**
222
- * Options shared by both halves of the JSON codec. All of them must match
223
- * on the serializing and deserializing peer or payloads will not
224
- * round-trip — for server functions, set them once through the
225
- * client/server `codec` config option.
226
- *
227
- * Integration-facing; may change (see the entry banner).
228
- */
229
- export interface JSONCodecOptions {
230
- /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. Must match on both peers. */
231
- plugins?: SerializerPlugin[];
232
- /**
233
- * Seroval feature bitflags to exclude. Defaults to disabling `RegExp`
234
- * (payloads may come from an untrusted peer). Must match on both peers.
235
- * Outside development, the encoding side additionally strips
236
- * `Error.prototype.stack` on top of any override — serialized stacks leak
237
- * server paths to the client. Decoding stays permissive, so payloads from
238
- * a development peer still round-trip.
239
- */
240
- disabledFeatures?: number;
241
- /** Maximum parse/deserialize depth. Defaults to 64. Must match on both peers. */
242
- depthLimit?: number;
243
- }
127
+ // (`JSONCodecOptions` and the decode half are declared in
128
+ // serializer-decode.d.ts and re-exported above.)
244
129
 
245
130
  /**
246
131
  * Options for `serializeJSON`.
@@ -270,17 +155,6 @@ export interface JSONSerializeOptions extends JSONCodecOptions {
270
155
  */
271
156
  export function serializeJSON(value: unknown, options: JSONSerializeOptions): () => void;
272
157
 
273
- /**
274
- * Creates the decoding counterpart of `serializeJSON`. Cross-references
275
- * between chunks resolve through state shared across calls, so all chunks
276
- * from one stream must go through the same deserializer instance. The first
277
- * chunk's return value is the decoded source value; feeding later chunks
278
- * settles the async values referenced inside it.
279
- *
280
- * Integration-facing; may change (see the entry banner).
281
- */
282
- export function createJSONDeserializer(options?: JSONCodecOptions): <T>(node: SerovalNode) => T;
283
-
284
158
  /** Options for `createJSONSerializer`. */
285
159
  export interface JSONSerializerOptions extends JSONCodecOptions {
286
160
  /**
@@ -306,19 +180,3 @@ export function createJSONSerializer(options: JSONSerializerOptions): {
306
180
  flush(): void;
307
181
  close(): void;
308
182
  };
309
-
310
- /**
311
- * A resident, response-scoped decode table over the keyed JSON codec: apply
312
- * each frame `data` chunk with `apply`, resolve `{ $ref }` slot args with
313
- * `resolve`. The frames client host wires one per response
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.
319
- */
320
- export interface JSONDataTable {
321
- apply(chunk: { key?: string; node?: unknown; initial?: boolean }): void;
322
- resolve<T = unknown>(ref: { $ref: string }): T;
323
- }
324
- export function createJSONDataTable(options?: JSONCodecOptions): JSONDataTable;
@@ -0,0 +1,182 @@
1
+ // The DECODE half of the serialization surface (published as
2
+ // `@solidjs/web/serialization/decode`): what reading a serialized payload
3
+ // needs — `fromCrossJSON`-backed deserializers and the shared plugin set —
4
+ // with none of the encode machinery. Lazy client consumers (the frames
5
+ // data tables, `deserializeStream`) load this module so the encode half
6
+ // never ships to a browser that only reads. The full serializer.d.ts
7
+ // re-exports everything here; see its banner for the stability contract
8
+ // (integration-facing, exempt from the 2.0 stability guarantee).
9
+ // ---- Plugin types ----
10
+ //
11
+ // Declared here by hand (seroval's published d.ts use extensionless
12
+ // ESM-relative imports that `moduleResolution: "nodenext"` cannot follow —
13
+ // a bare type re-export would silently degrade the surface to `any` under
14
+ // skipLibCheck, and an import would make every entry whose types reach
15
+ // this module — the MAIN client entry included, via the server-function
16
+ // seam's `JSONCodecOptions` — unimportable from a strict Node16 CJS
17
+ // consumer). The declarations mirror seroval ~1.5 exactly; the `~` pin is
18
+ // what makes mirroring safe. Plugin AUTHORING (`createPlugin`,
19
+ // `OpaqueReference`) lives on the full serialization entry.
20
+
21
+ /**
22
+ * Seroval's node shape — the intermediate representation `serializeJSON`
23
+ * emits and `createJSONDeserializer` consumes. Safe to `JSON.stringify`.
24
+ * Declared by hand like the plugin types below (same rationale): the
25
+ * observable envelope — a numeric type tag, an optional reference id —
26
+ * with the rest owned by the codec. Real seroval nodes satisfy it; treat
27
+ * it as an opaque token.
28
+ *
29
+ * Integration-facing; may change (see the entry banner).
30
+ */
31
+ export interface SerovalNode {
32
+ /** Node type tag (seroval-internal enum). */
33
+ t: number;
34
+ /** Reference id, when the node participates in cross-referencing. */
35
+ i?: number | undefined;
36
+ [key: string]: unknown;
37
+ }
38
+
39
+ /** Per-plugin bookkeeping seroval hands each plugin callback. */
40
+ export interface PluginData {
41
+ id: number;
42
+ }
43
+
44
+ /**
45
+ * The shape of a plugin's parsed payload: a map of `SerovalNode`s produced
46
+ * by the parse contexts, consumed by `serialize`/`deserialize`.
47
+ */
48
+ export type PluginInfo = { [key: string]: SerovalNode };
49
+
50
+ /** Parse context for `parse.sync`: turns child values into nodes. */
51
+ export interface SyncParsePluginContext {
52
+ parse<T>(current: T): SerovalNode;
53
+ }
54
+
55
+ /** Parse context for `parse.async`: like sync, but child parses await. */
56
+ export interface AsyncParsePluginContext {
57
+ parse<T>(current: T): Promise<SerovalNode>;
58
+ }
59
+
60
+ /**
61
+ * Parse context for `parse.stream`: sync parsing plus the streaming
62
+ * lifecycle (pending-state tracking, late node emission, cleanup).
63
+ */
64
+ export interface StreamParsePluginContext {
65
+ parse<T>(current: T): SerovalNode;
66
+ parseWithError<T>(current: T): SerovalNode | undefined;
67
+ isAlive(): boolean;
68
+ pushPendingState(): void;
69
+ popPendingState(): void;
70
+ onParse(node: SerovalNode): void;
71
+ onError(error: unknown): void;
72
+ addCleanup(callback: () => void): void;
73
+ }
74
+
75
+ /** Serialize context: renders child nodes to JS source. */
76
+ export interface SerializePluginContext {
77
+ serialize(node: SerovalNode): string;
78
+ }
79
+
80
+ /** Deserialize context: revives child nodes to runtime values. */
81
+ export interface DeserializePluginContext {
82
+ deserialize<T>(node: SerovalNode): T;
83
+ }
84
+
85
+ /**
86
+ * A Seroval plugin usable with the web serializers — teaches the codec how
87
+ * to encode/decode a custom value type (`Value` is the value it matches,
88
+ * `Info` its parsed payload). Supply matching plugins on both peers of a
89
+ * transport. Bare `SerializerPlugin` (both parameters defaulted to `any`)
90
+ * is the list-element type every `plugins` option accepts.
91
+ *
92
+ * Integration-facing; may change (see the entry banner).
93
+ */
94
+ export interface SerializerPlugin<Value = any, Info extends PluginInfo = any> {
95
+ /** A unique string identifying the plugin — namespace it (`"app/Thing"`). */
96
+ tag: string;
97
+ /** Dependency plugins, resolved ahead of this one. */
98
+ extends?: SerializerPlugin[];
99
+ /** Whether `value` is this plugin's to encode. */
100
+ test(value: unknown): boolean;
101
+ /** Parsing modes — provide the ones the transports you target use. */
102
+ parse: {
103
+ sync?: (value: Value, ctx: SyncParsePluginContext, data: PluginData) => Info;
104
+ async?: (value: Value, ctx: AsyncParsePluginContext, data: PluginData) => Promise<Info>;
105
+ stream?: (value: Value, ctx: StreamParsePluginContext, data: PluginData) => Info;
106
+ };
107
+ /** Renders the parsed payload as JS source (script-injection form). */
108
+ serialize(node: Info, ctx: SerializePluginContext, data: PluginData): string;
109
+ /** Revives the parsed payload back into the runtime value. */
110
+ deserialize(node: Info, ctx: DeserializePluginContext, data: PluginData): Value;
111
+ }
112
+
113
+ /**
114
+ * Baseline plugin set for serializing web-platform values (AbortSignal,
115
+ * Event, FormData, Headers, ReadableStream, Request, Response, URL, ...).
116
+ * Applied by every serializer in this module; custom plugins compose ahead
117
+ * of it via `resolveSerializerPlugins`.
118
+ *
119
+ * Integration-facing; may change (see the entry banner).
120
+ */
121
+ export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
122
+
123
+ /**
124
+ * Composes custom plugins with `DEFAULT_WEB_PLUGINS`. Custom plugins come
125
+ * first so they can shadow a default for values both would match. Returns a
126
+ * fresh array; the defaults are never mutated. Useful when handing a full
127
+ * plugin list to another serialization layer.
128
+ *
129
+ * Integration-facing; may change (see the entry banner).
130
+ */
131
+ export function resolveSerializerPlugins(customPlugins?: SerializerPlugin[]): SerializerPlugin[];
132
+
133
+ /**
134
+ * Options shared by both halves of the JSON codec. All of them must match
135
+ * on the serializing and deserializing peer or payloads will not
136
+ * round-trip — for server functions, set them once through the
137
+ * client/server `codec` config option.
138
+ *
139
+ * Integration-facing; may change (see the entry banner).
140
+ */
141
+ export interface JSONCodecOptions {
142
+ /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. Must match on both peers. */
143
+ plugins?: SerializerPlugin[];
144
+ /**
145
+ * Seroval feature bitflags to exclude. Defaults to disabling `RegExp`
146
+ * (payloads may come from an untrusted peer). Must match on both peers.
147
+ * Outside development, the encoding side additionally strips
148
+ * `Error.prototype.stack` on top of any override — serialized stacks leak
149
+ * server paths to the client. Decoding stays permissive, so payloads from
150
+ * a development peer still round-trip.
151
+ */
152
+ disabledFeatures?: number;
153
+ /** Maximum parse/deserialize depth. Defaults to 64. Must match on both peers. */
154
+ depthLimit?: number;
155
+ }
156
+
157
+ /**
158
+ * Creates the decoding counterpart of `serializeJSON`. Cross-references
159
+ * between chunks resolve through state shared across calls, so all chunks
160
+ * from one stream must go through the same deserializer instance. The first
161
+ * chunk's return value is the decoded source value; feeding later chunks
162
+ * settles the async values referenced inside it.
163
+ *
164
+ * Integration-facing; may change (see the entry banner).
165
+ */
166
+ export function createJSONDeserializer(options?: JSONCodecOptions): <T>(node: SerovalNode) => T;
167
+
168
+ /**
169
+ * A resident, response-scoped decode table over the keyed JSON codec: apply
170
+ * each frame `data` chunk with `apply`, resolve `{ $ref }` slot args with
171
+ * `resolve`. The frames client host wires one per response
172
+ * (`applyData: c => table.apply(c)`).
173
+ *
174
+ * Integration-facing; may change (see the entry banner). This serialization
175
+ * entry is the single home of the data table — the frames client consumes
176
+ * it internally rather than re-exporting it.
177
+ */
178
+ export interface JSONDataTable {
179
+ apply(chunk: { key?: string; node?: unknown; initial?: boolean }): void;
180
+ resolve<T = unknown>(ref: { $ref: string }): T;
181
+ }
182
+ export function createJSONDataTable(options?: JSONCodecOptions): JSONDataTable;
@@ -5,15 +5,20 @@
5
5
  // 2.0 stability guarantee and may change between releases. Application and
6
6
  // router code should configure `codec` on the server-function entries
7
7
  // instead of importing from here.
8
- import { Serializer, SerovalNode } from "seroval";
9
-
10
- /**
11
- * Seroval's node shape — the intermediate representation `serializeJSON`
12
- * emits and `createJSONDeserializer` consumes. Safe to `JSON.stringify`.
13
- *
14
- * Integration-facing; may change (see the entry banner).
15
- */
16
- export type { SerovalNode };
8
+ import type { Serializer } from "seroval";
9
+ import {
10
+ JSONCodecOptions,
11
+ PluginInfo,
12
+ SerializerPlugin,
13
+ SerovalNode
14
+ } from "./serializer-decode.cjs";
15
+
16
+ // The decode half — `SerovalNode`, the plugin TYPES, `DEFAULT_WEB_PLUGINS`,
17
+ // `resolveSerializerPlugins`, `JSONCodecOptions`, `createJSONDeserializer`,
18
+ // `createJSONDataTable` — is declared in serializer-decode.d.ts (published
19
+ // as `@solidjs/web/serialization/decode`, the module lazy client consumers
20
+ // load) and re-exported here so this remains the full surface.
21
+ export * from "./serializer-decode.cjs";
17
22
 
18
23
  // ---- Plugin authoring ----
19
24
  //
@@ -21,86 +26,8 @@ export type { SerovalNode };
21
26
  // it is the supported way to feed the serializers' `plugins` options and
22
27
  // the server-function entries' `codec.plugins`. The values re-export
23
28
  // 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
-
77
- /**
78
- * A Seroval plugin usable with the web serializers — teaches the codec how
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).
85
- */
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
- }
29
+ // the plugin TYPES live in serializer-decode.d.ts (hand-declared there
30
+ // see its banner for why).
104
31
 
105
32
  /**
106
33
  * Builds a `SerializerPlugin` — seroval's `createPlugin`, re-exported so
@@ -130,26 +57,6 @@ export class OpaqueReference<V, R = undefined> {
130
57
  constructor(value: V, replacement?: R);
131
58
  }
132
59
 
133
- /**
134
- * Baseline plugin set for serializing web-platform values (AbortSignal,
135
- * Event, FormData, Headers, ReadableStream, Request, Response, URL, ...).
136
- * Applied by every serializer in this module; custom plugins compose ahead
137
- * of it via `resolveSerializerPlugins`.
138
- *
139
- * Integration-facing; may change (see the entry banner).
140
- */
141
- export const DEFAULT_WEB_PLUGINS: readonly SerializerPlugin[];
142
-
143
- /**
144
- * Composes custom plugins with `DEFAULT_WEB_PLUGINS`. Custom plugins come
145
- * first so they can shadow a default for values both would match. Returns a
146
- * fresh array; the defaults are never mutated. Useful when handing a full
147
- * plugin list to another serialization layer.
148
- *
149
- * Integration-facing; may change (see the entry banner).
150
- */
151
- export function resolveSerializerPlugins(customPlugins?: SerializerPlugin[]): SerializerPlugin[];
152
-
153
60
  /**
154
61
  * Options for `createSerializer`.
155
62
  *
@@ -217,30 +124,8 @@ export function createHydrationSerializer(options: HydrationSerializerOptions):
217
124
  export function getLocalHeaderScript(id?: string): string;
218
125
 
219
126
  // ---- JSON codec (server function transports) ----
220
-
221
- /**
222
- * Options shared by both halves of the JSON codec. All of them must match
223
- * on the serializing and deserializing peer or payloads will not
224
- * round-trip — for server functions, set them once through the
225
- * client/server `codec` config option.
226
- *
227
- * Integration-facing; may change (see the entry banner).
228
- */
229
- export interface JSONCodecOptions {
230
- /** Extra plugins, composed ahead of `DEFAULT_WEB_PLUGINS`. Must match on both peers. */
231
- plugins?: SerializerPlugin[];
232
- /**
233
- * Seroval feature bitflags to exclude. Defaults to disabling `RegExp`
234
- * (payloads may come from an untrusted peer). Must match on both peers.
235
- * Outside development, the encoding side additionally strips
236
- * `Error.prototype.stack` on top of any override — serialized stacks leak
237
- * server paths to the client. Decoding stays permissive, so payloads from
238
- * a development peer still round-trip.
239
- */
240
- disabledFeatures?: number;
241
- /** Maximum parse/deserialize depth. Defaults to 64. Must match on both peers. */
242
- depthLimit?: number;
243
- }
127
+ // (`JSONCodecOptions` and the decode half are declared in
128
+ // serializer-decode.d.ts and re-exported above.)
244
129
 
245
130
  /**
246
131
  * Options for `serializeJSON`.
@@ -270,17 +155,6 @@ export interface JSONSerializeOptions extends JSONCodecOptions {
270
155
  */
271
156
  export function serializeJSON(value: unknown, options: JSONSerializeOptions): () => void;
272
157
 
273
- /**
274
- * Creates the decoding counterpart of `serializeJSON`. Cross-references
275
- * between chunks resolve through state shared across calls, so all chunks
276
- * from one stream must go through the same deserializer instance. The first
277
- * chunk's return value is the decoded source value; feeding later chunks
278
- * settles the async values referenced inside it.
279
- *
280
- * Integration-facing; may change (see the entry banner).
281
- */
282
- export function createJSONDeserializer(options?: JSONCodecOptions): <T>(node: SerovalNode) => T;
283
-
284
158
  /** Options for `createJSONSerializer`. */
285
159
  export interface JSONSerializerOptions extends JSONCodecOptions {
286
160
  /**
@@ -306,19 +180,3 @@ export function createJSONSerializer(options: JSONSerializerOptions): {
306
180
  flush(): void;
307
181
  close(): void;
308
182
  };
309
-
310
- /**
311
- * A resident, response-scoped decode table over the keyed JSON codec: apply
312
- * each frame `data` chunk with `apply`, resolve `{ $ref }` slot args with
313
- * `resolve`. The frames client host wires one per response
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.
319
- */
320
- export interface JSONDataTable {
321
- apply(chunk: { key?: string; node?: unknown; initial?: boolean }): void;
322
- resolve<T = unknown>(ref: { $ref: string }): T;
323
- }
324
- export function createJSONDataTable(options?: JSONCodecOptions): JSONDataTable;