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

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 (73) hide show
  1. package/README.md +1 -6
  2. package/dist/dev.cjs +285 -60
  3. package/dist/dev.js +267 -57
  4. package/dist/server.cjs +1148 -176
  5. package/dist/server.js +1133 -175
  6. package/dist/web.cjs +285 -60
  7. package/dist/web.js +267 -57
  8. package/frames/dist/client.cjs +397 -175
  9. package/frames/dist/client.dev.cjs +401 -175
  10. package/frames/dist/client.dev.js +399 -173
  11. package/frames/dist/client.js +395 -173
  12. package/frames/dist/server.cjs +1424 -277
  13. package/frames/dist/server.js +1426 -280
  14. package/package.json +69 -7
  15. package/serialization/decode/package.json +20 -0
  16. package/serialization/dist/decode.cjs +110 -0
  17. package/serialization/dist/decode.js +104 -0
  18. package/serialization/dist/serialization.cjs +106 -43
  19. package/serialization/dist/serialization.js +100 -44
  20. package/serialization/types/index.d.ts +85 -60
  21. package/serialization/types/serializer-decode.d.ts +182 -0
  22. package/serialization/types-cjs/index.d.cts +85 -60
  23. package/serialization/types-cjs/serializer-decode.d.cts +182 -0
  24. package/server-functions/dist/client.cjs +131 -98
  25. package/server-functions/dist/client.js +131 -99
  26. package/server-functions/dist/rich-args.cjs +11 -0
  27. package/server-functions/dist/rich-args.js +9 -0
  28. package/server-functions/dist/server.cjs +367 -194
  29. package/server-functions/dist/server.dev.cjs +1077 -0
  30. package/server-functions/dist/server.dev.js +1045 -0
  31. package/server-functions/dist/server.js +365 -195
  32. package/server-functions/package.json +10 -0
  33. package/server-functions/rich-args/package.json +20 -0
  34. package/storage/types/index.d.ts +1 -1
  35. package/storage/types-cjs/index.d.cts +1 -1
  36. package/types/client.d.ts +149 -6
  37. package/types/cookies.d.ts +93 -0
  38. package/types/core.d.ts +4 -2
  39. package/types/frames/client.d.ts +15 -1
  40. package/types/frames/frame-client.d.ts +63 -7
  41. package/types/frames/frame-sink.d.ts +26 -3
  42. package/types/frames/frame-transport.d.ts +40 -8
  43. package/types/frames/serializer.d.ts +85 -60
  44. package/types/frames/server.d.ts +22 -0
  45. package/types/index.d.ts +2 -3
  46. package/types/response.d.ts +45 -0
  47. package/types/serializer-decode.d.ts +182 -0
  48. package/types/serializer.d.ts +85 -60
  49. package/types/server-functions/client.d.ts +2 -1
  50. package/types/server-functions/rich-args.d.ts +10 -0
  51. package/types/server-functions/server.d.ts +99 -1
  52. package/types/server-functions/shared.d.ts +79 -1
  53. package/types/server-mock.d.ts +171 -59
  54. package/types/server.d.ts +209 -37
  55. package/types-cjs/client.d.cts +149 -6
  56. package/types-cjs/cookies.d.cts +93 -0
  57. package/types-cjs/core.d.cts +4 -2
  58. package/types-cjs/frames/client.d.cts +15 -1
  59. package/types-cjs/frames/frame-client.d.cts +63 -7
  60. package/types-cjs/frames/frame-sink.d.cts +26 -3
  61. package/types-cjs/frames/frame-transport.d.cts +40 -8
  62. package/types-cjs/frames/serializer.d.cts +85 -60
  63. package/types-cjs/frames/server.d.cts +22 -0
  64. package/types-cjs/index.d.cts +2 -3
  65. package/types-cjs/response.d.cts +45 -0
  66. package/types-cjs/serializer-decode.d.cts +182 -0
  67. package/types-cjs/serializer.d.cts +85 -60
  68. package/types-cjs/server-functions/client.d.cts +2 -1
  69. package/types-cjs/server-functions/rich-args.d.cts +10 -0
  70. package/types-cjs/server-functions/server.d.cts +99 -1
  71. package/types-cjs/server-functions/shared.d.cts +79 -1
  72. package/types-cjs/server-mock.d.cts +171 -59
  73. package/types-cjs/server.d.cts +209 -37
@@ -17,6 +17,16 @@
17
17
  "default": "./dist/client.cjs"
18
18
  }
19
19
  },
20
+ "development": {
21
+ "import": {
22
+ "types": "../types/server-functions/server.d.ts",
23
+ "default": "./dist/server.dev.js"
24
+ },
25
+ "require": {
26
+ "types": "../types-cjs/server-functions/server.d.cts",
27
+ "default": "./dist/server.dev.cjs"
28
+ }
29
+ },
20
30
  "import": {
21
31
  "types": "../types/server-functions/server.d.ts",
22
32
  "default": "./dist/server.js"
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@solidjs/web/server-functions/rich-args",
3
+ "main": "../dist/rich-args.cjs",
4
+ "module": "../dist/rich-args.js",
5
+ "types": "../../types/server-functions/rich-args.d.ts",
6
+ "type": "module",
7
+ "sideEffects": false,
8
+ "exports": {
9
+ ".": {
10
+ "import": {
11
+ "types": "../../types/server-functions/rich-args.d.ts",
12
+ "default": "../dist/rich-args.js"
13
+ },
14
+ "require": {
15
+ "types": "../../types-cjs/server-functions/rich-args.d.cts",
16
+ "default": "../dist/rich-args.cjs"
17
+ }
18
+ }
19
+ }
20
+ }
@@ -15,7 +15,7 @@ import type { RequestEvent } from "@solidjs/web";
15
15
  *
16
16
  * async function handler(request: Request) {
17
17
  * return provideRequestEvent({ request, locals: {} }, () =>
18
- * renderToStringAsync(() => <App />)
18
+ * renderToStream(() => <App />)
19
19
  * );
20
20
  * }
21
21
  * ```
@@ -15,7 +15,7 @@ import type { RequestEvent } from "@solidjs/web";
15
15
  *
16
16
  * async function handler(request: Request) {
17
17
  * return provideRequestEvent({ request, locals: {} }, () =>
18
- * renderToStringAsync(() => <App />)
18
+ * renderToStream(() => <App />)
19
19
  * );
20
20
  * }
21
21
  * ```
package/types/client.d.ts CHANGED
@@ -1,12 +1,24 @@
1
1
  import { JSX } from "./jsx.js";
2
+ import type { RequestEventLocals } from "./server.js";
3
+ // Element/property classification tables consumed by the JSX compiler and
4
+ // custom renderers. Compiler/tooling surface; not for hand-written code.
5
+ /** Compiler/tooling table; not for hand-written code. @internal */
2
6
  export const DOMWithState: Record<string, Record<string, 1 | 2>>;
7
+ /** Compiler/tooling table; not for hand-written code. @internal */
3
8
  export const ChildProperties: Set<string>;
9
+ /** Compiler/tooling table; not for hand-written code. @internal */
4
10
  export const DelegatedEvents: Set<string>;
11
+ /** Compiler/tooling table; not for hand-written code. @internal */
5
12
  export const DOMElements: Set<string>;
13
+ /** Compiler/tooling table; not for hand-written code. @internal */
6
14
  export const SVGElements: Set<string>;
15
+ /** Compiler/tooling table; not for hand-written code. @internal */
7
16
  export const MathMLElements: Set<string>;
17
+ /** Compiler/tooling table; not for hand-written code. @internal */
8
18
  export const VoidElements: Set<string>;
19
+ /** Compiler/tooling table; not for hand-written code. @internal */
9
20
  export const RawTextElements: Set<string>;
21
+ /** Compiler/tooling table; not for hand-written code. @internal */
10
22
  export const Namespaces: Record<string, string>;
11
23
 
12
24
  type MountableElement = Element | Document | ShadowRoot | DocumentFragment | Node;
@@ -17,16 +29,30 @@ export function render(
17
29
  options?: { owner?: unknown }
18
30
  ): () => void;
19
31
  /**
32
+ * Compiler-emitted primitive; not for hand-written code.
20
33
  * @param flag
21
34
  * - `undefined` — clone the template as-is (uses `cloneNode`).
22
35
  * - `1` — use `document.importNode` instead of `cloneNode`.
23
36
  * - `2` — the template html is wrapped; the outer tag is stripped at clone time.
37
+ * @internal
24
38
  */
25
39
  export function template(html: string, flag?: 1 | 2): () => Element;
40
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
26
41
  export function scope<T extends () => any>(fn: T): T;
42
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
27
43
  export function effect<T>(fn: (prev?: T) => T, effect: (value: T, prev?: T) => void): void;
44
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
28
45
  export function memo<T>(fn: () => T, equal: boolean): () => T;
46
+ /**
47
+ * Compiler-emitted primitive; not for hand-written code — import `untrack`
48
+ * from `solid-js` instead.
49
+ * @internal
50
+ */
29
51
  export function untrack<T>(fn: () => T): T;
52
+ /**
53
+ * Compiler-emitted primitive; not for hand-written code.
54
+ * @internal
55
+ */
30
56
  export function insert<T>(
31
57
  parent: MountableElement,
32
58
  accessor: (() => T) | T,
@@ -43,20 +69,29 @@ export function insert<T>(
43
69
  schedule?: boolean;
44
70
  }
45
71
  ): JSX.Element;
72
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
46
73
  export function createComponent<T>(Comp: (props: T) => JSX.Element, props: T): JSX.Element;
74
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
47
75
  export function delegateEvents(eventNames: string[]): void;
76
+ /** Event-delegation plumbing (Portal/custom-root wiring). Integration plumbing. @internal */
48
77
  export function registerDelegatedRoot(root: MountableElement): void;
78
+ /** Event-delegation plumbing (Portal/custom-root wiring). Integration plumbing. @internal */
49
79
  export function unregisterDelegatedRoot(root: MountableElement): void;
80
+ /** Event-delegation plumbing (Portal/custom-root wiring). Integration plumbing. @internal */
50
81
  export function registerDelegatedContainer(
51
82
  container: MountableElement,
52
83
  owner?: MountableElement
53
84
  ): void;
85
+ /** Event-delegation plumbing (Portal/custom-root wiring). Integration plumbing. @internal */
54
86
  export function unregisterDelegatedContainer(
55
87
  container: MountableElement,
56
88
  owner?: MountableElement
57
89
  ): void;
90
+ /** Event-delegation plumbing (Portal/custom-root wiring). Integration plumbing. @internal */
58
91
  export function getDelegatedRoot(node: MountableElement): MountableElement | undefined;
92
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
59
93
  export function spread<T>(node: Element, accessor: T, skipChildren?: Boolean): void;
94
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
60
95
  export function assign(
61
96
  node: Element,
62
97
  props: any,
@@ -64,7 +99,9 @@ export function assign(
64
99
  prevProps?: any,
65
100
  skipRef?: Boolean
66
101
  ): void;
102
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
67
103
  export function setAttribute(node: Element, name: string, value: string): void;
104
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
68
105
  export function setAttributeNS(node: Element, namespace: string, name: string, value: string): void;
69
106
  /**
70
107
  * Register a consumer for compiler-emitted element claims. Compiled DOM
@@ -77,11 +114,16 @@ export function setAttributeNS(node: Element, namespace: string, name: string, v
77
114
  * cleanup through your own reactive system. Dormant until registered —
78
115
  * without a handler the emitted claims are null checks. Returns an
79
116
  * unregister function.
117
+ *
118
+ * Integration plumbing (routers register the consumer); not meant for
119
+ * application code.
120
+ * @internal
80
121
  */
81
122
  export function registerElementClaim(handler: (element: Element) => void): () => void;
82
123
  /**
83
124
  * Claim `node` for registered consumers (see `registerElementClaim`).
84
125
  * Emitted by the compiler at element creation; idempotent by contract.
126
+ * @internal
85
127
  */
86
128
  export function claimElement<T extends Element>(node: T): T;
87
129
  /**
@@ -90,29 +132,50 @@ export function claimElement<T extends Element>(node: T): T;
90
132
  * compiled output emits, for content that becomes live DOM without compiled
91
133
  * creation code (frame streams, adopted SSR ranges). Dormant without a
92
134
  * registered consumer.
135
+ *
136
+ * Integration plumbing; not meant for application code.
137
+ * @internal
93
138
  */
94
139
  export function claimElementTree<T extends Node>(root: T): T;
140
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
95
141
  export function className(node: Element, value: JSX.ClassValue, prev?: JSX.ClassValue): void;
142
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
96
143
  export function setProperty(node: Element, name: string, value: any): void;
144
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
97
145
  export function setStyleProperty(node: Element, name: string, value: any): void;
146
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
98
147
  export function addEvent(
99
148
  node: Element,
100
149
  name: string,
101
150
  handler: EventListener | EventListenerObject | (EventListenerObject & AddEventListenerOptions),
102
151
  delegate: boolean
103
152
  ): void;
153
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
104
154
  export function style(
105
155
  node: Element,
106
156
  value: { [k: string]: string },
107
157
  prev?: { [k: string]: string }
108
158
  ): void;
159
+ /**
160
+ * Compiler-emitted primitive; not for hand-written code — import `getOwner`
161
+ * from `solid-js` instead.
162
+ * @internal
163
+ */
109
164
  export function getOwner(): unknown;
165
+ /**
166
+ * Compiler-emitted prop-spread helper; not for hand-written code — import
167
+ * `merge` from `solid-js` instead.
168
+ * @internal
169
+ */
110
170
  export function mergeProps(...sources: unknown[]): unknown;
171
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
111
172
  export function dynamicProperty(props: unknown, key: string): unknown;
173
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
112
174
  export function applyRef<T extends Element = Element>(
113
175
  r: ((element: NoInfer<T>) => void) | ((element: NoInfer<T>) => void)[],
114
176
  element: T
115
177
  ): void;
178
+ /** Compiler-emitted primitive; not for hand-written code. @internal */
116
179
  export function ref(
117
180
  fn: () => ((element: Element) => void) | ((element: Element) => void)[],
118
181
  element: Element
@@ -123,18 +186,25 @@ export function hydrate(
123
186
  node: MountableElement,
124
187
  options?: { renderId?: string; owner?: unknown }
125
188
  ): () => void;
189
+ /** Hydration-walk primitive; not for hand-written code. @internal */
126
190
  export function getHydrationKey(): string | undefined;
191
+ /** Hydration-walk primitive; not for hand-written code. @internal */
127
192
  export function getNextElement(template?: () => Element): Element;
193
+ /** Hydration-walk primitive; not for hand-written code. @internal */
128
194
  export function getNextMatch(start: Node, elementName: string): Element;
195
+ /** Hydration-walk primitive; not for hand-written code. @internal */
129
196
  export function getNextMarker(start: Node): [Node, Array<Node>];
130
- /** @deprecated Use `useHead` — removed before `0.50.0` stable. */
131
- export function useAssets(fn: () => JSX.Element): void;
132
- /** @deprecated Use `useHead` — removed before `0.50.0` stable. */
133
- export function getAssets(): string;
134
197
  /**
135
198
  * A head tag descriptor. Props values may be getters (reactive on the
136
199
  * client); `children` is the text body. `key` overrides the built-in dedupe
137
200
  * identity (`title` is a hard singleton that `key` cannot fork).
201
+ *
202
+ * Getters must be plain reads: they evaluate inside registry-owned
203
+ * computations here and at flush time on the server, so a getter that
204
+ * allocates a reactive owner (`createMemo`, a `children()` helper) consumes
205
+ * a hydration id slot on one side only and desyncs every id allocated after
206
+ * the `useHead` call. Create such helpers eagerly at component position and
207
+ * read them from the getter. See docs/head-management-rfc.md.
138
208
  */
139
209
  export type HeadTag = {
140
210
  tag: "title" | "meta" | "link" | "style" | "script" | "base";
@@ -163,13 +233,41 @@ export interface ExclusiveAssetDescriptor<T> {
163
233
  get(): T;
164
234
  set(value: T): void;
165
235
  }
236
+ /**
237
+ * @internal Ref-counted client asset ownership: acquire adopts or mounts the
238
+ * asset, the returned release follows the owner (with a grace period for
239
+ * back-and-forth navigation). Internal machinery, not a public CSS-lifecycle
240
+ * API — per the head-management RFC (docs/head-management-rfc.md), ambient
241
+ * bundler-injected CSS is never lifecycle-managed, and the head registry
242
+ * owns the lifecycle of directly-mounted stylesheets outright. This keeps
243
+ * its non-head roles (exclusive slots, owner-following DOM ownership).
244
+ */
166
245
  export function acquireAsset(descriptor: AssetDescriptor): () => void;
246
+ /**
247
+ * Registry entry returned by `warmAsset`. Stylesheet entries carry load
248
+ * tracking for the client reveal gate (docs/client-css-reveal-gating.md):
249
+ * `loadPromise` resolves on load OR error (never rejects) — an errored
250
+ * sheet releases the gate, parity with the server gate.
251
+ */
252
+ export interface AssetEntry {
253
+ loadState?: "pending" | "loaded" | "errored";
254
+ loadPromise?: Promise<void>;
255
+ }
256
+ /**
257
+ * @internal Warm half of `acquireAsset`: idempotent and refcount-free,
258
+ * callable from a compute phase so the fetch starts at discovery and
259
+ * overlaps a transition's data wait. Stylesheets warm as
260
+ * `rel="preload" as="style"` and are flipped live by `acquireAsset` at
261
+ * commit — a branch superseded before it commits leaks only an inert
262
+ * preload, never an applied sheet. Only link-backed descriptors warm;
263
+ * inline styles and exclusive slots return `undefined`.
264
+ */
265
+ export function warmAsset(descriptor: AssetDescriptor): AssetEntry | undefined;
167
266
  export function HydrationScript(props?: { nonce?: string; eventNames?: string[] }): JSX.Element;
168
267
  export function generateHydrationScript(options?: {
169
268
  nonce?: string;
170
269
  eventNames?: string[];
171
270
  }): string;
172
- export function Assets(props: { children?: JSX.Element }): JSX.Element;
173
271
  /**
174
272
  * See the server entry's `ResponseStub` — the shape of the mutable response
175
273
  * head integrations expose as `event.response` via module augmentation.
@@ -185,10 +283,55 @@ export interface ResponseStub {
185
283
  */
186
284
  committed?: boolean;
187
285
  }
286
+ /**
287
+ * See the server entry's `RequestEventLocals` — the augmentable type of
288
+ * `RequestEvent.locals`. Re-exported (not re-declared) so both entries
289
+ * share ONE interface identity and a single augmentation reaches every
290
+ * `locals`, whichever entry typed the event.
291
+ */
292
+ export { RequestEventLocals } from "./server.js";
188
293
  export interface RequestEvent {
189
294
  request: Request;
190
- locals: Record<string | number | symbol, any>;
295
+ locals: RequestEventLocals;
191
296
  }
297
+ /**
298
+ * Registered symbol (`Symbol.for("solid.RequestContext")`) naming the global
299
+ * slot where `provideRequestEvent` parks the AsyncLocalStorage scoping
300
+ * request events. Integration plumbing — read the event through
301
+ * `getRequestEvent()` instead.
302
+ * @internal
303
+ */
192
304
  export declare const RequestContext: unique symbol;
193
305
  export function getRequestEvent(): RequestEvent | undefined;
306
+ /**
307
+ * The cookie codec (the platform-gap primitives — see cookies.d.ts for the
308
+ * blessed patterns): the real implementation on both entries, never a
309
+ * stub — a pure value transformer has legitimate browser uses
310
+ * (`document.cookie`). Tree-shakes away when unused.
311
+ */
312
+ export { parseCookieHeader, serializeCookie } from "./cookies.js";
313
+ export type { CookieOptions } from "./cookies.js";
314
+ /**
315
+ * The flash cookie's isomorphic half (name/detection/clearing — cookie
316
+ * utilities living beside the cookie codec) and the codec-free
317
+ * server-function layer (reference detection + the late-bound RPC seam).
318
+ * On the core entries so integrations consuming them eagerly (routers)
319
+ * never import the server-functions entry — whose client half is the
320
+ * transport + codec — from their eager graph. Declared through
321
+ * server-functions/shared.d.ts, the declaration home published-types
322
+ * layouts ship.
323
+ */
324
+ export {
325
+ clearFlashCookie,
326
+ getServerFunctionMetadata,
327
+ getServerFunctionRPC,
328
+ hasFlashCookie,
329
+ isServerFunction
330
+ } from "./server-functions/shared.js";
331
+ export type {
332
+ ServerFunction,
333
+ ServerFunctionMetadata,
334
+ ServerFunctionRPC
335
+ } from "./server-functions/shared.js";
336
+ /** Hydration-walk primitive; not for hand-written code. @internal */
194
337
  export function runHydrationEvents(): void;
@@ -0,0 +1,93 @@
1
+ // Cookie wire format: the platform-gap primitives, and ALL of core's
2
+ // cookie surface — core owns the exchange (the request's headers in, the
3
+ // response stub's headers out) and the codec, nothing ambient. Blessed
4
+ // patterns:
5
+ //
6
+ // parseCookieHeader(event.request.headers.get("cookie"))
7
+ // event.response.headers.append("set-cookie", serializeCookie(name, value, options))
8
+ //
9
+ // Dependency-free and isomorphic (exported from both entries — real
10
+ // implementation, never a stub); integrity/confidentiality layers
11
+ // (sessions) belong to the caller, on top of these primitives.
12
+
13
+ /**
14
+ * Attributes for a `Set-Cookie` header, mirroring RFC 6265. `path`
15
+ * defaults to `/`; nothing else is defaulted.
16
+ */
17
+ export interface CookieOptions {
18
+ /** Cookie `Path` attribute. Defaults to `/`. */
19
+ path?: string;
20
+ /** Cookie `Domain` attribute. Emitted only when provided. */
21
+ domain?: string;
22
+ /** Cookie `Max-Age` attribute, in seconds (truncated to an integer). */
23
+ maxAge?: number;
24
+ /** Cookie `Expires` attribute. */
25
+ expires?: Date;
26
+ /** Emit the `HttpOnly` attribute. */
27
+ httpOnly?: boolean;
28
+ /** Emit the `Secure` attribute. */
29
+ secure?: boolean;
30
+ /** Cookie `SameSite` attribute, any case. */
31
+ sameSite?: "lax" | "strict" | "none" | "Lax" | "Strict" | "None";
32
+ }
33
+
34
+ /**
35
+ * Parses a `Cookie` request header into a name → value map. Names and
36
+ * values are `decodeURIComponent`-decoded (falling back to the raw text
37
+ * when decoding throws); a quoted value keeps its content. `null`/empty
38
+ * input parses to an empty map.
39
+ *
40
+ * The read half of the platform gap — the blessed request-cookie read is
41
+ * `parseCookieHeader(event.request.headers.get("cookie"))`.
42
+ */
43
+ export function parseCookieHeader(header: string | null | undefined): Record<string, string>;
44
+
45
+ /**
46
+ * Serializes a cookie to a `Set-Cookie` header value. The name and value
47
+ * are `encodeURIComponent`-encoded (the parser decodes symmetrically);
48
+ * `path` defaults to `/` and every other attribute is emitted exactly
49
+ * when the caller asked for it.
50
+ *
51
+ * The write half of the platform gap — the blessed response-cookie write
52
+ * is `event.response.headers.append("set-cookie", serializeCookie(name,
53
+ * value, options))`, which every head materialization path carries to the
54
+ * wire entry-by-entry.
55
+ */
56
+ export function serializeCookie(name: string, value: string, options?: CookieOptions): string;
57
+
58
+ /**
59
+ * Name of the cookie carrying the outcome of a server function call made
60
+ * without the client runtime (`"flash"`). A no-JS form post has no way to
61
+ * receive a value — the browser follows the redirect and renders the next
62
+ * page — so the handler stashes the outcome here for the render after it
63
+ * to pick up, which is how a form submitted without JavaScript still shows
64
+ * its result.
65
+ *
66
+ * The name, detection and clearing are cookie utilities and isomorphic
67
+ * (integrations read the cookie from code that also ships to the browser);
68
+ * the codec that fills and decodes it is server-only and lives behind the
69
+ * server-functions server entry.
70
+ */
71
+ export const FLASH_COOKIE: string;
72
+
73
+ /**
74
+ * Whether a Cookie header carries a flash cookie, readable or not. Cheap
75
+ * enough to call on every render so the clear can be queued before the
76
+ * response headers flush.
77
+ */
78
+ export function hasFlashCookie(cookieHeader: string | null): boolean;
79
+
80
+ /**
81
+ * The `Set-Cookie` value clearing the flash cookie. The outcome is
82
+ * one-shot: append this as soon as the cookie is detected, whether or not
83
+ * it decodes, so a stale outcome cannot resurface on a later request.
84
+ */
85
+ export function clearFlashCookie(): string;
86
+
87
+ /**
88
+ * The raw encoded flash payload out of a Cookie header, if present — the
89
+ * codec's own accessor.
90
+ *
91
+ * @internal
92
+ */
93
+ export function matchFlashCookie(cookieHeader: string | null): string | undefined;
package/types/core.d.ts CHANGED
@@ -1,4 +1,6 @@
1
- export { getOwner, runWithOwner, createComponent, createRoot as root, sharedConfig, untrack, merge as mergeProps, flatten, ssrHandleError, ssrScope, NoHydration, Hydration, runInServerComponentScope } from "solid-js";
2
- export declare const effect: (fn: any, effectFn: any, options: any) => void;
1
+ export { getOwner, runWithOwner, createComponent, createRoot as root, sharedConfig, untrack, merge as mergeProps, flatten, ssrHandleError, ssrScope, NoHydration, Hydration, runInServerComponentScope, creationStamp, inServerComponentScope } from "solid-js";
2
+ export declare const effect: (fn: any, effectFn: any, options?: any) => void;
3
3
  export declare const memo: (fn: any) => import("solid-js").SourceAccessor<any>;
4
4
  export declare const runWithHydrationScope: (id: any, fn: any) => unknown;
5
+ export declare const ssrAsyncValue: (value: any) => import("solid-js").SourceAccessor<any>;
6
+ export declare const waitAsset: (promise: any) => void;
@@ -1,7 +1,20 @@
1
1
  export { createFrame, createFrameHost, createFrameElement, FRAME_APPLIED_EVENT } from "./frame-client.js";
2
2
  export { FRAME_STREAM_HEADER, applyFrameResponse, isFrameStreamResponse, createServerComponentHandler } from "./frame-transport.js";
3
- export { createJSONDataTable } from "./serializer.js";
4
3
  export type { Slot } from "./server.js";
4
+ /**
5
+ * Client-condition twin of the server face's `asyncArg` (DR-2 value tier):
6
+ * the identity that types an async value crossing the slot border as its
7
+ * settled value. Server component modules are authored in universal code and
8
+ * may resolve under the browser condition at typecheck/bundle time — the
9
+ * call never runs here (the `"use server"` body executes server-side), but
10
+ * the symbol must exist.
11
+ */
12
+ export declare function asyncArg<T>(value: PromiseLike<T> | AsyncIterable<T>): T;
13
+ /**
14
+ * The app-wide shared frame host (created lazily): one chunk router with
15
+ * per-response codec data tables.
16
+ * @experimental
17
+ */
5
18
  export declare function getFrameHost(): any;
6
19
  /**
7
20
  * Installs the server-component transport policy on the server-function
@@ -18,5 +31,6 @@ export declare function getFrameHost(): any;
18
31
  * Call once in the client entry (an explicit call — the package is
19
32
  * `sideEffects: false`, so a bare import would be tree-shaken away);
20
33
  * call again to rebind to a custom host.
34
+ * @experimental
21
35
  */
22
36
  export declare function installServerComponents(host?: any): void;
@@ -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;
@@ -170,6 +186,10 @@ export interface FrameHost {
170
186
  serialize(value: unknown): { $ref: string };
171
187
  /** `frameId` is the resolving frame's id — route to its stream's table. */
172
188
  resolve(ref: { $ref: string }, frameId?: string): unknown;
189
+ /** See FrameHostOptions.revive. */
190
+ revive?(value: unknown): unknown;
191
+ /** See FrameHostOptions.isContainer. */
192
+ isContainer?(value: unknown): boolean;
173
193
  }
174
194
 
175
195
  /**
@@ -180,10 +200,14 @@ export interface FrameHost {
180
200
  * boundary (nested region frames dispatch too); use it to re-apply
181
201
  * client-owned decorations on server-owned markup (router affordance
182
202
  * reflection, e.g. `aria-current`) without a MutationObserver.
203
+ * @experimental
183
204
  */
184
205
  export const FRAME_APPLIED_EVENT: "frame:applied";
185
206
 
186
- /** Options for `createFrameHost`. */
207
+ /**
208
+ * Options for `createFrameHost`.
209
+ * @experimental
210
+ */
187
211
  export interface FrameHostOptions {
188
212
  /**
189
213
  * Backs `{$ref}` slot args (typically a codec data table's `resolve`).
@@ -199,11 +223,37 @@ export interface FrameHostOptions {
199
223
  * `applyData: c => table.apply(c)` (see `createJSONDataTable`).
200
224
  */
201
225
  applyData?(chunk: Extract<FrameChunk, { type: "data" }>): void;
226
+ /**
227
+ * A lazily-loaded deserializer's load, awaited by the transport before it
228
+ * delivers a `data` chunk — `applyData`/`resolve` can assume the codec is
229
+ * resident once data has arrived. Keeps codec weight out of the eager
230
+ * client graph for responses that never carry serialized data.
231
+ */
232
+ prepareData?(): Promise<unknown>;
233
+ /**
234
+ * Revive protocol markers inside LITERAL slot args (values that are
235
+ * neither `{$ref}` nor `{$frame}`) at arg-resolution time. Document-face
236
+ * container traces ride this way — inline in the record, revived by the
237
+ * integration (`reviveContainerTraces`) into live local containers.
238
+ */
239
+ revive?(value: unknown): unknown;
240
+ /**
241
+ * Whether a resolved arg value is a LIVE CONTAINER (a materialized trace —
242
+ * see `isMaterializedContainer`). The record-dedupe compare must know: a
243
+ * pending container's property reads throw not-ready, so async probes and
244
+ * serialization compares would detonate it. Containers compare by
245
+ * identity only.
246
+ */
247
+ isContainer?(value: unknown): boolean;
202
248
  }
203
249
 
250
+ /** @experimental */
204
251
  export function createFrameHost(options?: FrameHostOptions): FrameHost;
205
252
 
206
- /** Options for `createFrame` / `createFrameElement`. */
253
+ /**
254
+ * Options for `createFrame` / `createFrameElement`.
255
+ * @experimental
256
+ */
207
257
  export interface FrameOptions {
208
258
  /** Register with this host under `id`, receiving routed/buffered chunks. */
209
259
  host?: FrameHost;
@@ -217,7 +267,7 @@ export interface FrameOptions {
217
267
  */
218
268
  adopt?: boolean;
219
269
  /** Called after each apply flush (tests/telemetry). */
220
- onApply?(info: { version: number; reason: "materialize" | "morph" | "reveal" }): void;
270
+ onApply?(info: { version: number; reason: "materialize" | "morph" | "reveal" | "error" }): void;
221
271
  /**
222
272
  * Wraps element-claim sweeps (`a[href]`/`form[action]` in materialized
223
273
  * server content — and only those) so claim consumers register their
@@ -259,12 +309,17 @@ export interface FrameOptions {
259
309
  * so the first apply morphs against it and slots sync immediately (hydration
260
310
  * attach), claiming their server-rendered DOM — a document boot needs no
261
311
  * chunk.
312
+ * @experimental
262
313
  */
263
314
  export function createFrame(boundary: Element, options?: FrameOptions): Frame;
264
315
 
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. */
316
+ /**
317
+ * The default boundary/region element tag and its id attribute — the DOM
318
+ * contract the producer emits at t=0 and the consumer creates/adopts.
319
+ * @experimental
320
+ */
267
321
  export const FRAME_TAG: "dx-frame";
322
+ /** @experimental */
268
323
  export const FRAME_ID_ATTR: "data-fid";
269
324
 
270
325
  /**
@@ -274,6 +329,7 @@ export const FRAME_ID_ATTR: "data-fid";
274
329
  * returned `element` in any position — single, array, or fragment — with no
275
330
  * special-casing. One frame per element; lifecycle belongs to the creator via
276
331
  * `dispose()` (register it with your owner's cleanup).
332
+ * @experimental
277
333
  */
278
334
  export function createFrameElement(options: FrameOptions): {
279
335
  readonly element: Element;