@tanstack/react-start-server 1.111.10

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 (74) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +33 -0
  3. package/dist/cjs/StartServer.cjs +9 -0
  4. package/dist/cjs/StartServer.cjs.map +1 -0
  5. package/dist/cjs/StartServer.d.cts +4 -0
  6. package/dist/cjs/createRequestHandler.cjs +52 -0
  7. package/dist/cjs/createRequestHandler.cjs.map +1 -0
  8. package/dist/cjs/createRequestHandler.d.cts +8 -0
  9. package/dist/cjs/createStartHandler.cjs +56 -0
  10. package/dist/cjs/createStartHandler.cjs.map +1 -0
  11. package/dist/cjs/createStartHandler.d.cts +8 -0
  12. package/dist/cjs/defaultRenderHandler.cjs +29 -0
  13. package/dist/cjs/defaultRenderHandler.cjs.map +1 -0
  14. package/dist/cjs/defaultRenderHandler.d.cts +1 -0
  15. package/dist/cjs/defaultStreamHandler.cjs +69 -0
  16. package/dist/cjs/defaultStreamHandler.cjs.map +1 -0
  17. package/dist/cjs/defaultStreamHandler.d.cts +1 -0
  18. package/dist/cjs/handlerCallback.cjs +7 -0
  19. package/dist/cjs/handlerCallback.cjs.map +1 -0
  20. package/dist/cjs/handlerCallback.d.cts +10 -0
  21. package/dist/cjs/index.cjs +410 -0
  22. package/dist/cjs/index.cjs.map +1 -0
  23. package/dist/cjs/index.d.cts +112 -0
  24. package/dist/cjs/ssr-server.cjs +246 -0
  25. package/dist/cjs/ssr-server.cjs.map +1 -0
  26. package/dist/cjs/ssr-server.d.cts +30 -0
  27. package/dist/cjs/transformStreamWithRouter.cjs +183 -0
  28. package/dist/cjs/transformStreamWithRouter.cjs.map +1 -0
  29. package/dist/cjs/transformStreamWithRouter.d.cts +6 -0
  30. package/dist/cjs/tsrScript.cjs +4 -0
  31. package/dist/cjs/tsrScript.cjs.map +1 -0
  32. package/dist/cjs/tsrScript.d.cts +1 -0
  33. package/dist/esm/StartServer.d.ts +4 -0
  34. package/dist/esm/StartServer.js +9 -0
  35. package/dist/esm/StartServer.js.map +1 -0
  36. package/dist/esm/createRequestHandler.d.ts +8 -0
  37. package/dist/esm/createRequestHandler.js +52 -0
  38. package/dist/esm/createRequestHandler.js.map +1 -0
  39. package/dist/esm/createStartHandler.d.ts +8 -0
  40. package/dist/esm/createStartHandler.js +56 -0
  41. package/dist/esm/createStartHandler.js.map +1 -0
  42. package/dist/esm/defaultRenderHandler.d.ts +1 -0
  43. package/dist/esm/defaultRenderHandler.js +29 -0
  44. package/dist/esm/defaultRenderHandler.js.map +1 -0
  45. package/dist/esm/defaultStreamHandler.d.ts +1 -0
  46. package/dist/esm/defaultStreamHandler.js +69 -0
  47. package/dist/esm/defaultStreamHandler.js.map +1 -0
  48. package/dist/esm/handlerCallback.d.ts +10 -0
  49. package/dist/esm/handlerCallback.js +7 -0
  50. package/dist/esm/handlerCallback.js.map +1 -0
  51. package/dist/esm/index.d.ts +112 -0
  52. package/dist/esm/index.js +297 -0
  53. package/dist/esm/index.js.map +1 -0
  54. package/dist/esm/ssr-server.d.ts +30 -0
  55. package/dist/esm/ssr-server.js +246 -0
  56. package/dist/esm/ssr-server.js.map +1 -0
  57. package/dist/esm/transformStreamWithRouter.d.ts +6 -0
  58. package/dist/esm/transformStreamWithRouter.js +183 -0
  59. package/dist/esm/transformStreamWithRouter.js.map +1 -0
  60. package/dist/esm/tsrScript.d.ts +1 -0
  61. package/dist/esm/tsrScript.js +5 -0
  62. package/dist/esm/tsrScript.js.map +1 -0
  63. package/package.json +73 -0
  64. package/src/StartServer.tsx +9 -0
  65. package/src/createRequestHandler.ts +75 -0
  66. package/src/createStartHandler.ts +82 -0
  67. package/src/defaultRenderHandler.tsx +25 -0
  68. package/src/defaultStreamHandler.tsx +80 -0
  69. package/src/handlerCallback.ts +22 -0
  70. package/src/index.tsx +508 -0
  71. package/src/ssr-server.ts +346 -0
  72. package/src/transformStreamWithRouter.ts +258 -0
  73. package/src/tsrScript.ts +91 -0
  74. package/src/vite-env.d.ts +4 -0
package/package.json ADDED
@@ -0,0 +1,73 @@
1
+ {
2
+ "name": "@tanstack/react-start-server",
3
+ "version": "1.111.10",
4
+ "description": "Modern and scalable routing for React applications",
5
+ "author": "Tanner Linsley",
6
+ "license": "MIT",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/TanStack/router.git",
10
+ "directory": "packages/react-start-server"
11
+ },
12
+ "homepage": "https://tanstack.com/start",
13
+ "funding": {
14
+ "type": "github",
15
+ "url": "https://github.com/sponsors/tannerlinsley"
16
+ },
17
+ "keywords": [
18
+ "react",
19
+ "location",
20
+ "router",
21
+ "routing",
22
+ "async",
23
+ "async router",
24
+ "typescript"
25
+ ],
26
+ "type": "module",
27
+ "types": "dist/esm/index.d.ts",
28
+ "exports": {
29
+ ".": {
30
+ "import": {
31
+ "types": "./dist/esm/index.d.ts",
32
+ "default": "./dist/esm/index.js"
33
+ },
34
+ "require": {
35
+ "types": "./dist/cjs/index.d.cts",
36
+ "default": "./dist/cjs/index.cjs"
37
+ }
38
+ },
39
+ "./package.json": "./package.json"
40
+ },
41
+ "sideEffects": false,
42
+ "files": [
43
+ "dist",
44
+ "src"
45
+ ],
46
+ "engines": {
47
+ "node": ">=12"
48
+ },
49
+ "dependencies": {
50
+ "tiny-warning": "^1.0.3",
51
+ "h3": "1.13.0",
52
+ "isbot": "^5.1.22",
53
+ "jsesc": "^3.1.0",
54
+ "unctx": "^2.4.1",
55
+ "@tanstack/history": "^1.99.13",
56
+ "@tanstack/router-core": "^1.111.7",
57
+ "@tanstack/react-router": "^1.111.7",
58
+ "@tanstack/react-start-client": "^1.111.10"
59
+ },
60
+ "devDependencies": {
61
+ "@vitejs/plugin-react": "^4.3.4",
62
+ "@types/jsesc": "^3.0.3",
63
+ "esbuild": "^0.25.0",
64
+ "react": "^19.0.0",
65
+ "react-dom": "^19.0.0",
66
+ "typescript": "^5.7.2"
67
+ },
68
+ "peerDependencies": {
69
+ "react": ">=18.0.0 || >=19.0.0",
70
+ "react-dom": ">=18.0.0 || >=19.0.0"
71
+ },
72
+ "scripts": {}
73
+ }
@@ -0,0 +1,9 @@
1
+ import * as React from 'react'
2
+ import { RouterProvider } from '@tanstack/react-router'
3
+ import type { AnyRouter } from '@tanstack/react-router'
4
+
5
+ export function StartServer<TRouter extends AnyRouter>(props: {
6
+ router: TRouter
7
+ }) {
8
+ return <RouterProvider router={props.router} />
9
+ }
@@ -0,0 +1,75 @@
1
+ import { createMemoryHistory } from '@tanstack/history'
2
+ import { mergeHeaders } from '@tanstack/react-start-client'
3
+ import { attachRouterServerSsrUtils, dehydrateRouter } from './ssr-server'
4
+ import type { HandlerCallback } from './handlerCallback'
5
+ import type { AnyRouter, Manifest } from '@tanstack/react-router'
6
+
7
+ export type RequestHandler<TRouter extends AnyRouter> = (
8
+ cb: HandlerCallback<TRouter>,
9
+ ) => Promise<Response>
10
+
11
+ export function createRequestHandler<TRouter extends AnyRouter>({
12
+ createRouter,
13
+ request,
14
+ getRouterManifest,
15
+ }: {
16
+ createRouter: () => TRouter
17
+ request: Request
18
+ getRouterManifest?: () => Manifest | Promise<Manifest>
19
+ }): RequestHandler<TRouter> {
20
+ return async (cb) => {
21
+ const router = createRouter()
22
+
23
+ attachRouterServerSsrUtils(router, await getRouterManifest?.())
24
+
25
+ const url = new URL(request.url, 'http://localhost')
26
+
27
+ const href = url.href.replace(url.origin, '')
28
+
29
+ // Create a history for the router
30
+ const history = createMemoryHistory({
31
+ initialEntries: [href],
32
+ })
33
+
34
+ // Update the router with the history and context
35
+ router.update({
36
+ history,
37
+ })
38
+
39
+ await router.load()
40
+
41
+ dehydrateRouter(router)
42
+
43
+ const responseHeaders = getRequestHeaders({
44
+ router,
45
+ })
46
+
47
+ return cb({
48
+ request,
49
+ router,
50
+ responseHeaders,
51
+ } as any)
52
+ }
53
+ }
54
+
55
+ function getRequestHeaders(opts: { router: AnyRouter }): Headers {
56
+ let headers = mergeHeaders(
57
+ {
58
+ 'Content-Type': 'text/html; charset=UTF-8',
59
+ },
60
+ ...opts.router.state.matches.map((match) => {
61
+ return match.headers
62
+ }),
63
+ )
64
+
65
+ // Handle Redirects
66
+ const { redirect } = opts.router.state
67
+
68
+ if (redirect) {
69
+ headers = mergeHeaders(headers, redirect.headers, {
70
+ Location: redirect.href,
71
+ })
72
+ }
73
+
74
+ return headers
75
+ }
@@ -0,0 +1,82 @@
1
+ import { createMemoryHistory } from '@tanstack/history'
2
+ import { mergeHeaders } from '@tanstack/react-start-client'
3
+ import { eventHandler, getResponseHeaders, toWebRequest } from 'h3'
4
+ import { attachRouterServerSsrUtils, dehydrateRouter } from './ssr-server'
5
+ import type { HandlerCallback } from './handlerCallback'
6
+ import type { EventHandlerResponse, H3Event } from 'h3'
7
+ import type { AnyRouter, Manifest } from '@tanstack/react-router'
8
+
9
+ export type CustomizeStartHandler<
10
+ TRouter extends AnyRouter,
11
+ TResponse extends EventHandlerResponse = EventHandlerResponse,
12
+ > = (cb: HandlerCallback<TRouter, TResponse>) => ReturnType<typeof eventHandler>
13
+
14
+ export function createStartHandler<
15
+ TRouter extends AnyRouter,
16
+ TResponse extends EventHandlerResponse = EventHandlerResponse,
17
+ >({
18
+ createRouter,
19
+ getRouterManifest,
20
+ }: {
21
+ createRouter: () => TRouter
22
+ getRouterManifest?: () => Manifest | Promise<Manifest>
23
+ }): CustomizeStartHandler<TRouter, TResponse> {
24
+ return (cb) => {
25
+ return eventHandler(async (event) => {
26
+ const request = toWebRequest(event)
27
+
28
+ const url = new URL(request.url)
29
+ const href = url.href.replace(url.origin, '')
30
+
31
+ // Create a history for the router
32
+ const history = createMemoryHistory({
33
+ initialEntries: [href],
34
+ })
35
+
36
+ const router = createRouter()
37
+
38
+ attachRouterServerSsrUtils(router, await getRouterManifest?.())
39
+
40
+ // Update the router with the history and context
41
+ router.update({
42
+ history,
43
+ })
44
+
45
+ await router.load()
46
+
47
+ dehydrateRouter(router)
48
+
49
+ const responseHeaders = getStartResponseHeaders({ event, router })
50
+ const response = await cb({
51
+ request,
52
+ router,
53
+ responseHeaders,
54
+ })
55
+
56
+ return response
57
+ })
58
+ }
59
+ }
60
+
61
+ function getStartResponseHeaders(opts: { event: H3Event; router: AnyRouter }) {
62
+ let headers = mergeHeaders(
63
+ getResponseHeaders(opts.event),
64
+ (opts.event as any).___ssrRpcResponseHeaders,
65
+ {
66
+ 'Content-Type': 'text/html; charset=UTF-8',
67
+ },
68
+ ...opts.router.state.matches.map((match) => {
69
+ return match.headers
70
+ }),
71
+ )
72
+
73
+ // Handle Redirects
74
+ const { redirect } = opts.router.state
75
+
76
+ if (redirect) {
77
+ headers = mergeHeaders(headers, redirect.headers, {
78
+ Location: redirect.href,
79
+ })
80
+ }
81
+ return headers
82
+ }
@@ -0,0 +1,25 @@
1
+ import ReactDOMServer from 'react-dom/server'
2
+ import { StartServer } from './StartServer'
3
+ import { defineHandlerCallback } from './handlerCallback'
4
+
5
+ export const defaultRenderHandler = defineHandlerCallback(
6
+ async ({ router, responseHeaders }) => {
7
+ try {
8
+ let html = ReactDOMServer.renderToString(<StartServer router={router} />)
9
+ const injectedHtml = await Promise.all(
10
+ router.serverSsr!.injectedHtml,
11
+ ).then((htmls) => htmls.join(''))
12
+ html = html.replace(`</body>`, `${injectedHtml}</body>`)
13
+ return new Response(`<!DOCTYPE html>${html}`, {
14
+ status: router.state.statusCode,
15
+ headers: responseHeaders,
16
+ })
17
+ } catch (error) {
18
+ console.error('Render to string error:', error)
19
+ return new Response('Internal Server Error', {
20
+ status: 500,
21
+ headers: responseHeaders,
22
+ })
23
+ }
24
+ },
25
+ )
@@ -0,0 +1,80 @@
1
+ import { PassThrough } from 'node:stream'
2
+ import { isbot } from 'isbot'
3
+ import ReactDOMServer from 'react-dom/server'
4
+
5
+ import { StartServer } from './StartServer'
6
+
7
+ import {
8
+ transformPipeableStreamWithRouter,
9
+ transformReadableStreamWithRouter,
10
+ } from './transformStreamWithRouter'
11
+
12
+ import { defineHandlerCallback } from './handlerCallback'
13
+ import type { ReadableStream } from 'node:stream/web'
14
+
15
+ export const defaultStreamHandler = defineHandlerCallback(
16
+ async ({ request, router, responseHeaders }) => {
17
+ if (typeof ReactDOMServer.renderToReadableStream === 'function') {
18
+ const stream = await ReactDOMServer.renderToReadableStream(
19
+ <StartServer router={router} />,
20
+ {
21
+ signal: request.signal,
22
+ },
23
+ )
24
+
25
+ if (isbot(request.headers.get('User-Agent'))) {
26
+ await stream.allReady
27
+ }
28
+
29
+ const responseStream = transformReadableStreamWithRouter(
30
+ router,
31
+ stream as unknown as ReadableStream,
32
+ )
33
+ return new Response(responseStream as any, {
34
+ status: router.state.statusCode,
35
+ headers: responseHeaders,
36
+ })
37
+ }
38
+
39
+ if (typeof ReactDOMServer.renderToPipeableStream === 'function') {
40
+ const reactAppPassthrough = new PassThrough()
41
+
42
+ try {
43
+ const pipeable = ReactDOMServer.renderToPipeableStream(
44
+ <StartServer router={router} />,
45
+ {
46
+ ...(isbot(request.headers.get('User-Agent'))
47
+ ? {
48
+ onAllReady() {
49
+ pipeable.pipe(reactAppPassthrough)
50
+ },
51
+ }
52
+ : {
53
+ onShellReady() {
54
+ pipeable.pipe(reactAppPassthrough)
55
+ },
56
+ }),
57
+ onError: (error, info) => {
58
+ console.error('Error in renderToPipeableStream:', error, info)
59
+ },
60
+ },
61
+ )
62
+ } catch (e) {
63
+ console.error('Error in renderToPipeableStream:', e)
64
+ }
65
+
66
+ const responseStream = transformPipeableStreamWithRouter(
67
+ router,
68
+ reactAppPassthrough,
69
+ )
70
+ return new Response(responseStream as any, {
71
+ status: router.state.statusCode,
72
+ headers: responseHeaders,
73
+ })
74
+ }
75
+
76
+ throw new Error(
77
+ 'No renderToReadableStream or renderToPipeableStream found in react-dom/server. Ensure you are using a version of react-dom that supports streaming.',
78
+ )
79
+ },
80
+ )
@@ -0,0 +1,22 @@
1
+ import type { EventHandlerResponse } from 'h3'
2
+ import type { AnyRouter } from '@tanstack/react-router'
3
+
4
+ export interface HandlerCallback<
5
+ TRouter extends AnyRouter,
6
+ TResponse extends EventHandlerResponse = EventHandlerResponse,
7
+ > {
8
+ (ctx: {
9
+ request: Request
10
+ router: TRouter
11
+ responseHeaders: Headers
12
+ }): TResponse
13
+ }
14
+
15
+ export function defineHandlerCallback<
16
+ TRouter extends AnyRouter,
17
+ TResponse = EventHandlerResponse,
18
+ >(
19
+ handler: HandlerCallback<TRouter, TResponse>,
20
+ ): HandlerCallback<TRouter, TResponse> {
21
+ return handler
22
+ }