Open History to see the last commit
1import { renderToReadableStream } from 'virtual:tanstack-rsc-runtime'
2import { getStartContext } from '@tanstack/start-storage-context'
3import { ReplayableStream } from './ReplayableStream'
4import { RENDERABLE_RSC, SERVER_COMPONENT_STREAM } from './ServerComponentTypes'
5import { createRscCssEnvelope } from './rscCssEnvelope'
6import type {
7 AnyRenderableServerComponent,
8 RenderableServerComponentBuilder,
9 ServerComponentStream,
10 ValidateRenderableServerComponent,
11} from './ServerComponentTypes'
12import type { RscCssEnvelopeOptions } from './rscCssEnvelope'
13β
14import './rscSsrHandler'
15// Import for global declaration side effect
16export type { RscSsrHandler, RscDecodeResult } from './rscSsrHandler'
17β
18/**
19 * Renderable RSC handle type - used for serialization detection.
20 */
21β
22/**
23 * Type guard for renderable RSC handle.
24 */
25export function isRenderableRscHandle(
26 value: unknown,
27): value is AnyRenderableServerComponent {
28 return (
29 typeof value === 'function' &&
30 SERVER_COMPONENT_STREAM in value &&
31 RENDERABLE_RSC in value &&
32 (value as any)[RENDERABLE_RSC] === true
33 )
34}
35β
36/**
37 * Renders a React element to an RSC Flight stream.
38 *
39 * Returns a "renderable proxy" that can be:
40 * - Rendered directly as `{data}` in JSX
41 * - Accessed for nested selections: `{data.foo.bar.Hello}`
42 *
43 * No slot support - for slots use `createCompositeComponent`.
44 *
45 * @example
46 * ```tsx
47 * // In a loader or server function
48 * const data = await renderServerComponent(<MyServerComponent foo="bar" />)
49 *
50 * // In the route component
51 * return (
52 * <div>
53 * {data}
54 * {data.sidebar.Menu}
55 * </div>
56 * )
57 * ```
58 */
59export async function renderServerComponent<TNode>(
60 node: ValidateRenderableServerComponent<TNode>,
61 options?: RscCssEnvelopeOptions,
62): Promise<RenderableServerComponentBuilder<TNode>> {
63 const flightStream = renderToReadableStream(
64 createRscCssEnvelope(node, options),
65 )
66β
67 // Check if this is an SSR request (router) or a direct server function call
68 const ctx = getStartContext({ throwIfNotFound: false })
69 const isRouterRequest = ctx?.handlerType === 'router'
70 const ssrHandler = globalThis.__RSC_SSR__
71β
72 // SSR path: buffer stream for replay, pre-decode for synchronous rendering
73 if (isRouterRequest && ssrHandler) {
74 const signal = ctx.request.signal
75 const stream = new ReplayableStream(flightStream, { signal })
76β
77 // Pre-decode during loader phase for synchronous SSR rendering
78 const decoded = await ssrHandler.decode(stream)
79 return ssrHandler.createRenderableProxy(
80 stream,
81 decoded,
82 ) as RenderableServerComponentBuilder<TNode>
83 }
84β
85 // Server function call path: return a handle for serialization
86 return createRenderableHandle(
87 flightStream,
88 ) as unknown as RenderableServerComponentBuilder<TNode>
89}
90β
91/**
92 * Creates a renderable handle for server function responses.
93 * Tagged with RENDERABLE_RSC for the serialization adapter.
94 */
95function createRenderableHandle(
96 flightStream: ReadableStream<Uint8Array>,
97): AnyRenderableServerComponent {
98 const streamWrapper: ServerComponentStream = {
99 createReplayStream: () => flightStream,
100 }
101β
102 const stub = function RenderableRscStub(): never {
103 throw new Error(
104 'Renderable RSC from server function cannot be rendered on server. ' +
105 'It should be serialized and sent to the client.',
106 )
107 }
108β
109 ;(stub as any)[SERVER_COMPONENT_STREAM] = streamWrapper
110 ;(stub as any)[RENDERABLE_RSC] = true
111 return stub as unknown as AnyRenderableServerComponent
112}