@tanstack/router-core 1.121.33 → 1.121.39

package/dist/esm/ssr/transformStreamWithRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformStreamWithRouter.js","sources":["../../../src/ssr/transformStreamWithRouter.ts"],"sourcesContent":["import { ReadableStream } from 'node:stream/web'\nimport { Readable } from 'node:stream'\nimport { createControlledPromise } from '../utils'\nimport type { AnyRouter } from '../router'\n\nexport function transformReadableStreamWithRouter(\n  router: AnyRouter,\n  routerStream: ReadableStream,\n) {\n  return transformStreamWithRouter(router, routerStream)\n}\n\nexport function transformPipeableStreamWithRouter(\n  router: AnyRouter,\n  routerStream: Readable,\n) {\n  return Readable.fromWeb(\n    transformStreamWithRouter(router, Readable.toWeb(routerStream)),\n  )\n}\n\n// regex pattern for matching closing body and html tags\nconst patternBodyStart = /(<body)/\nconst patternBodyEnd = /(<\\/body>)/\nconst patternHtmlEnd = /(<\\/html>)/\nconst patternHeadStart = /(<head.*?>)/\n// regex pattern for matching closing tags\nconst patternClosingTag = /(<\\/[a-zA-Z][\\w:.-]*?>)/g\n\nconst textDecoder = new TextDecoder()\n\ntype ReadablePassthrough = {\n  stream: ReadableStream\n  write: (chunk: string) => void\n  end: (chunk?: string) => void\n  destroy: (error: unknown) => void\n  destroyed: boolean\n}\n\nfunction createPassthrough() {\n  let controller: ReadableStreamDefaultController<any>\n  const encoder = new TextEncoder()\n  const stream = new ReadableStream({\n    start(c) {\n      controller = c\n    },\n  })\n\n  const res: ReadablePassthrough = {\n    stream,\n    write: (chunk) => {\n      controller.enqueue(encoder.encode(chunk))\n    },\n    end: (chunk) => {\n      if (chunk) {\n        controller.enqueue(encoder.encode(chunk))\n      }\n      controller.close()\n      res.destroyed = true\n    },\n    destroy: (error) => {\n      controller.error(error)\n    },\n    destroyed: false,\n  }\n\n  return res\n}\n\nasync function readStream(\n  stream: ReadableStream,\n  opts: {\n    onData?: (chunk: ReadableStreamReadValueResult<any>) => void\n    onEnd?: () => void\n    onError?: (error: unknown) => void\n  },\n) {\n  try {\n    const reader = stream.getReader()\n    let chunk\n    while (!(chunk = await reader.read()).done) {\n      opts.onData?.(chunk)\n    }\n    opts.onEnd?.()\n  } catch (error) {\n    opts.onError?.(error)\n  }\n}\n\nexport function transformStreamWithRouter(\n  router: AnyRouter,\n  appStream: ReadableStream,\n) {\n  const finalPassThrough = createPassthrough()\n\n  let isAppRendering = true as boolean\n  let routerStreamBuffer = ''\n  let pendingClosingTags = ''\n  let bodyStarted = false as boolean\n  let headStarted = false as boolean\n  let leftover = ''\n  let leftoverHtml = ''\n\n  function getBufferedRouterStream() {\n    const html = routerStreamBuffer\n    routerStreamBuffer = ''\n    return html\n  }\n\n  function decodeChunk(chunk: unknown): string {\n    if (chunk instanceof Uint8Array) {\n      return textDecoder.decode(chunk)\n    }\n    return String(chunk)\n  }\n\n  const injectedHtmlDonePromise = createControlledPromise<void>()\n\n  let processingCount = 0\n\n  // Process any already-injected HTML\n  router.serverSsr!.injectedHtml.forEach((promise) => {\n    handleInjectedHtml(promise)\n  })\n\n  // Listen for any new injected HTML\n  const stopListeningToInjectedHtml = router.subscribe(\n    'onInjectedHtml',\n    (e) => {\n      handleInjectedHtml(e.promise)\n    },\n  )\n\n  function handleInjectedHtml(promise: Promise<string>) {\n    processingCount++\n\n    promise\n      .then((html) => {\n        if (!bodyStarted) {\n          routerStreamBuffer += html\n        } else {\n          finalPassThrough.write(html)\n        }\n      })\n      .catch(injectedHtmlDonePromise.reject)\n      .finally(() => {\n        processingCount--\n\n        if (!isAppRendering && processingCount === 0) {\n          stopListeningToInjectedHtml()\n          injectedHtmlDonePromise.resolve()\n        }\n      })\n  }\n\n  injectedHtmlDonePromise\n    .then(() => {\n      const finalHtml =\n        leftoverHtml + getBufferedRouterStream() + pendingClosingTags\n\n      finalPassThrough.end(finalHtml)\n    })\n    .catch((err) => {\n      console.error('Error reading routerStream:', err)\n      finalPassThrough.destroy(err)\n    })\n\n  // Transform the appStream\n  readStream(appStream, {\n    onData: (chunk) => {\n      const text = decodeChunk(chunk.value)\n\n      let chunkString = leftover + text\n      const bodyEndMatch = chunkString.match(patternBodyEnd)\n      const htmlEndMatch = chunkString.match(patternHtmlEnd)\n\n      if (!bodyStarted) {\n        const bodyStartMatch = chunkString.match(patternBodyStart)\n        if (bodyStartMatch) {\n          bodyStarted = true\n        }\n      }\n\n      if (!headStarted) {\n        const headStartMatch = chunkString.match(patternHeadStart)\n        if (headStartMatch) {\n          headStarted = true\n          const index = headStartMatch.index!\n          const headTag = headStartMatch[0]\n          const remaining = chunkString.slice(index + headTag.length)\n          finalPassThrough.write(\n            chunkString.slice(0, index) + headTag + getBufferedRouterStream(),\n          )\n          // make sure to only write `remaining` until the next closing tag\n          chunkString = remaining\n        }\n      }\n\n      if (!bodyStarted) {\n        finalPassThrough.write(chunkString)\n        leftover = ''\n        return\n      }\n\n      // If either the body end or html end is in the chunk,\n      // We need to get all of our data in asap\n      if (\n        bodyEndMatch &&\n        htmlEndMatch &&\n        bodyEndMatch.index! < htmlEndMatch.index!\n      ) {\n        const bodyEndIndex = bodyEndMatch.index!\n        pendingClosingTags = chunkString.slice(bodyEndIndex)\n\n        finalPassThrough.write(\n          chunkString.slice(0, bodyEndIndex) + getBufferedRouterStream(),\n        )\n\n        leftover = ''\n        return\n      }\n\n      let result: RegExpExecArray | null\n      let lastIndex = 0\n      while ((result = patternClosingTag.exec(chunkString)) !== null) {\n        lastIndex = result.index + result[0].length\n      }\n\n      if (lastIndex > 0) {\n        const processed =\n          chunkString.slice(0, lastIndex) +\n          getBufferedRouterStream() +\n          leftoverHtml\n\n        finalPassThrough.write(processed)\n        leftover = chunkString.slice(lastIndex)\n      } else {\n        leftover = chunkString\n        leftoverHtml += getBufferedRouterStream()\n      }\n    },\n    onEnd: () => {\n      // Mark the app as done rendering\n      isAppRendering = false\n\n      // If there are no pending promises, resolve the injectedHtmlDonePromise\n      if (processingCount === 0) {\n        injectedHtmlDonePromise.resolve()\n      }\n    },\n    onError: (error) => {\n      console.error('Error reading appStream:', error)\n      finalPassThrough.destroy(error)\n    },\n  })\n\n  return finalPassThrough.stream\n}\n"],"names":[],"mappings":";;;AAKgB,SAAA,kCACd,QACA,cACA;AACO,SAAA,0BAA0B,QAAQ,YAAY;AACvD;AAEgB,SAAA,kCACd,QACA,cACA;AACA,SAAO,SAAS;AAAA,IACd,0BAA0B,QAAQ,SAAS,MAAM,YAAY,CAAC;AAAA,EAChE;AACF;AAGA,MAAM,mBAAmB;AACzB,MAAM,iBAAiB;AACvB,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AAEzB,MAAM,oBAAoB;AAE1B,MAAM,cAAc,IAAI,YAAY;AAUpC,SAAS,oBAAoB;AACvB,MAAA;AACE,QAAA,UAAU,IAAI,YAAY;AAC1B,QAAA,SAAS,IAAI,eAAe;AAAA,IAChC,MAAM,GAAG;AACM,mBAAA;AAAA,IAAA;AAAA,EACf,CACD;AAED,QAAM,MAA2B;AAAA,IAC/B;AAAA,IACA,OAAO,CAAC,UAAU;AAChB,iBAAW,QAAQ,QAAQ,OAAO,KAAK,CAAC;AAAA,IAC1C;AAAA,IACA,KAAK,CAAC,UAAU;AACd,UAAI,OAAO;AACT,mBAAW,QAAQ,QAAQ,OAAO,KAAK,CAAC;AAAA,MAAA;AAE1C,iBAAW,MAAM;AACjB,UAAI,YAAY;AAAA,IAClB;AAAA,IACA,SAAS,CAAC,UAAU;AAClB,iBAAW,MAAM,KAAK;AAAA,IACxB;AAAA,IACA,WAAW;AAAA,EACb;AAEO,SAAA;AACT;AAEA,eAAe,WACb,QACA,MAKA;;AACI,MAAA;AACI,UAAA,SAAS,OAAO,UAAU;AAC5B,QAAA;AACJ,WAAO,EAAE,QAAQ,MAAM,OAAO,KAAA,GAAQ,MAAM;AAC1C,iBAAK,WAAL,8BAAc;AAAA,IAAK;AAErB,eAAK,UAAL;AAAA,WACO,OAAO;AACd,eAAK,YAAL,8BAAe;AAAA,EAAK;AAExB;AAEgB,SAAA,0BACd,QACA,WACA;AACA,QAAM,mBAAmB,kBAAkB;AAE3C,MAAI,iBAAiB;AACrB,MAAI,qBAAqB;AACzB,MAAI,qBAAqB;AACzB,MAAI,cAAc;AAClB,MAAI,cAAc;AAClB,MAAI,WAAW;AACf,MAAI,eAAe;AAEnB,WAAS,0BAA0B;AACjC,UAAM,OAAO;AACQ,yBAAA;AACd,WAAA;AAAA,EAAA;AAGT,WAAS,YAAY,OAAwB;AAC3C,QAAI,iBAAiB,YAAY;AACxB,aAAA,YAAY,OAAO,KAAK;AAAA,IAAA;AAEjC,WAAO,OAAO,KAAK;AAAA,EAAA;AAGrB,QAAM,0BAA0B,wBAA8B;AAE9D,MAAI,kBAAkB;AAGtB,SAAO,UAAW,aAAa,QAAQ,CAAC,YAAY;AAClD,uBAAmB,OAAO;AAAA,EAAA,CAC3B;AAGD,QAAM,8BAA8B,OAAO;AAAA,IACzC;AAAA,IACA,CAAC,MAAM;AACL,yBAAmB,EAAE,OAAO;AAAA,IAAA;AAAA,EAEhC;AAEA,WAAS,mBAAmB,SAA0B;AACpD;AAGG,YAAA,KAAK,CAAC,SAAS;AACd,UAAI,CAAC,aAAa;AACM,8BAAA;AAAA,MAAA,OACjB;AACL,yBAAiB,MAAM,IAAI;AAAA,MAAA;AAAA,IAE9B,CAAA,EACA,MAAM,wBAAwB,MAAM,EACpC,QAAQ,MAAM;AACb;AAEI,UAAA,CAAC,kBAAkB,oBAAoB,GAAG;AAChB,oCAAA;AAC5B,gCAAwB,QAAQ;AAAA,MAAA;AAAA,IAClC,CACD;AAAA,EAAA;AAGL,0BACG,KAAK,MAAM;AACJ,UAAA,YACJ,eAAe,wBAAA,IAA4B;AAE7C,qBAAiB,IAAI,SAAS;AAAA,EAAA,CAC/B,EACA,MAAM,CAAC,QAAQ;AACN,YAAA,MAAM,+BAA+B,GAAG;AAChD,qBAAiB,QAAQ,GAAG;AAAA,EAAA,CAC7B;AAGH,aAAW,WAAW;AAAA,IACpB,QAAQ,CAAC,UAAU;AACX,YAAA,OAAO,YAAY,MAAM,KAAK;AAEpC,UAAI,cAAc,WAAW;AACvB,YAAA,eAAe,YAAY,MAAM,cAAc;AAC/C,YAAA,eAAe,YAAY,MAAM,cAAc;AAErD,UAAI,CAAC,aAAa;AACV,cAAA,iBAAiB,YAAY,MAAM,gBAAgB;AACzD,YAAI,gBAAgB;AACJ,wBAAA;AAAA,QAAA;AAAA,MAChB;AAGF,UAAI,CAAC,aAAa;AACV,cAAA,iBAAiB,YAAY,MAAM,gBAAgB;AACzD,YAAI,gBAAgB;AACJ,wBAAA;AACd,gBAAM,QAAQ,eAAe;AACvB,gBAAA,UAAU,eAAe,CAAC;AAChC,gBAAM,YAAY,YAAY,MAAM,QAAQ,QAAQ,MAAM;AACzC,2BAAA;AAAA,YACf,YAAY,MAAM,GAAG,KAAK,IAAI,UAAU,wBAAwB;AAAA,UAClE;AAEc,wBAAA;AAAA,QAAA;AAAA,MAChB;AAGF,UAAI,CAAC,aAAa;AAChB,yBAAiB,MAAM,WAAW;AACvB,mBAAA;AACX;AAAA,MAAA;AAKF,UACE,gBACA,gBACA,aAAa,QAAS,aAAa,OACnC;AACA,cAAM,eAAe,aAAa;AACb,6BAAA,YAAY,MAAM,YAAY;AAElC,yBAAA;AAAA,UACf,YAAY,MAAM,GAAG,YAAY,IAAI,wBAAwB;AAAA,QAC/D;AAEW,mBAAA;AACX;AAAA,MAAA;AAGE,UAAA;AACJ,UAAI,YAAY;AAChB,cAAQ,SAAS,kBAAkB,KAAK,WAAW,OAAO,MAAM;AAC9D,oBAAY,OAAO,QAAQ,OAAO,CAAC,EAAE;AAAA,MAAA;AAGvC,UAAI,YAAY,GAAG;AACjB,cAAM,YACJ,YAAY,MAAM,GAAG,SAAS,IAC9B,4BACA;AAEF,yBAAiB,MAAM,SAAS;AACrB,mBAAA,YAAY,MAAM,SAAS;AAAA,MAAA,OACjC;AACM,mBAAA;AACX,wBAAgB,wBAAwB;AAAA,MAAA;AAAA,IAE5C;AAAA,IACA,OAAO,MAAM;AAEM,uBAAA;AAGjB,UAAI,oBAAoB,GAAG;AACzB,gCAAwB,QAAQ;AAAA,MAAA;AAAA,IAEpC;AAAA,IACA,SAAS,CAAC,UAAU;AACV,cAAA,MAAM,4BAA4B,KAAK;AAC/C,uBAAiB,QAAQ,KAAK;AAAA,IAAA;AAAA,EAChC,CACD;AAED,SAAO,iBAAiB;AAC1B;"}

package/dist/esm/ssr/tsrScript.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/ssr/tsrScript.js

@@ -0,0 +1,5 @@
+const minifiedTsrBootStrapScript = 'const __TSR_SSR__={matches:[],streamedValues:{},initMatch:o=>(__TSR_SSR__.matches.push(o),o.extracted?.forEach(l=>{if(l.type==="stream"){let r;l.value=new ReadableStream({start(e){r={enqueue:t=>{try{e.enqueue(t)}catch{}},close:()=>{try{e.close()}catch{}}}}}),l.value.controller=r}else{let r,e;l.value=new Promise((t,n)=>{e=n,r=t}),l.value.reject=e,l.value.resolve=r}}),!0),resolvePromise:({matchId:o,id:l,promiseState:r})=>{const e=__TSR_SSR__.matches.find(t=>t.id===o);if(e){const t=e.extracted?.[l];if(t&&t.type==="promise"&&t.value&&r.status==="success")return t.value.resolve(r.data),!0}return!1},injectChunk:({matchId:o,id:l,chunk:r})=>{const e=__TSR_SSR__.matches.find(t=>t.id===o);if(e){const t=e.extracted?.[l];if(t&&t.type==="stream"&&t.value?.controller)return t.value.controller.enqueue(new TextEncoder().encode(r.toString())),!0}return!1},closeStream:({matchId:o,id:l})=>{const r=__TSR_SSR__.matches.find(e=>e.id===o);if(r){const e=r.extracted?.[l];if(e&&e.type==="stream"&&e.value?.controller)return e.value.controller.close(),!0}return!1},cleanScripts:()=>{document.querySelectorAll(".tsr-once").forEach(o=>{o.remove()})}};window.__TSR_SSR__=__TSR_SSR__;\n';
+export {
+  minifiedTsrBootStrapScript as default
+};
+//# sourceMappingURL=tsrScript.js.map

package/dist/esm/ssr/tsrScript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsrScript.js","sources":["../../../src/ssr/tsrScript.ts?script-string"],"sourcesContent":["import type { ControllablePromise } from '../router'\nimport type { TsrSsrGlobal } from './ssr-client'\n\nconst __TSR_SSR__: TsrSsrGlobal = {\n  matches: [],\n  streamedValues: {},\n  initMatch: (match) => {\n    __TSR_SSR__.matches.push(match)\n\n    match.extracted?.forEach((ex) => {\n      if (ex.type === 'stream') {\n        let controller\n        ex.value = new ReadableStream({\n          start(c) {\n            controller = {\n              enqueue: (chunk: unknown) => {\n                try {\n                  c.enqueue(chunk)\n                } catch {}\n              },\n              close: () => {\n                try {\n                  c.close()\n                } catch {}\n              },\n            }\n          },\n        })\n        ex.value.controller = controller\n      } else {\n        let resolve: ControllablePromise['reject'] | undefined\n        let reject: ControllablePromise['reject'] | undefined\n\n        ex.value = new Promise((_resolve, _reject) => {\n          reject = _reject\n          resolve = _resolve\n        }) as ControllablePromise\n        ex.value.reject = reject!\n        ex.value.resolve = resolve!\n      }\n    })\n\n    return true\n  },\n  resolvePromise: ({ matchId, id, promiseState }) => {\n    const match = __TSR_SSR__.matches.find((m) => m.id === matchId)\n    if (match) {\n      const ex = match.extracted?.[id]\n      if (\n        ex &&\n        ex.type === 'promise' &&\n        ex.value &&\n        promiseState.status === 'success'\n      ) {\n        ex.value.resolve(promiseState.data)\n        return true\n      }\n    }\n    return false\n  },\n  injectChunk: ({ matchId, id, chunk }) => {\n    const match = __TSR_SSR__.matches.find((m) => m.id === matchId)\n\n    if (match) {\n      const ex = match.extracted?.[id]\n      if (ex && ex.type === 'stream' && ex.value?.controller) {\n        ex.value.controller.enqueue(new TextEncoder().encode(chunk.toString()))\n        return true\n      }\n    }\n    return false\n  },\n  closeStream: ({ matchId, id }) => {\n    const match = __TSR_SSR__.matches.find((m) => m.id === matchId)\n    if (match) {\n      const ex = match.extracted?.[id]\n      if (ex && ex.type === 'stream' && ex.value?.controller) {\n        ex.value.controller.close()\n        return true\n      }\n    }\n    return false\n  },\n  cleanScripts: () => {\n    document.querySelectorAll('.tsr-once').forEach((el) => {\n      el.remove()\n    })\n  },\n}\n\nwindow.__TSR_SSR__ = __TSR_SSR__\n"],"names":[],"mappings":"AAAA,MAAA,6BAAe;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/router-core",
-  "version": "1.121.33",
+  "version": "1.121.39",
   "description": "Modern and scalable routing for React applications",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -33,6 +33,26 @@
         "default": "./dist/cjs/index.cjs"
       }
     },
+    "./ssr/server": {
+      "import": {
+        "types": "./dist/esm/ssr/server.d.ts",
+        "default": "./dist/esm/ssr/server.js"
+      },
+      "require": {
+        "types": "./dist/cjs/ssr/server.d.cts",
+        "default": "./dist/cjs/ssr/server.cjs"
+      }
+    },
+    "./ssr/client": {
+      "import": {
+        "types": "./dist/esm/ssr/client.d.ts",
+        "default": "./dist/esm/ssr/client.js"
+      },
+      "require": {
+        "types": "./dist/cjs/ssr/client.d.cts",
+        "default": "./dist/cjs/ssr/client.cjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,
@@ -45,8 +65,15 @@
   },
   "dependencies": {
     "@tanstack/store": "^0.7.0",
+    "cookie-es": "^1.2.2",
+    "jsesc": "^3.1.0",
     "tiny-invariant": "^1.3.3",
-    "@tanstack/history": "1.121.21"
+    "tiny-warning": "^1.0.3",
+    "@tanstack/history": "1.121.34"
+  },
+  "devDependencies": {
+    "@types/jsesc": "^3.0.3",
+    "esbuild": "^0.25.0"
   },
   "scripts": {}
 }

package/src/index.ts

@@ -66,6 +66,7 @@ export type {
 } from './fileRoute'
 
 export type {
+  TsrSerializer,
   StartSerializer,
   Serializable,
   SerializerParse,

package/src/router.ts

@@ -77,7 +77,7 @@ import type {
   NavigateFn,
 } from './RouterProvider'
 import type { Manifest } from './manifest'
-import type { StartSerializer } from './serializer'
+import type { TsrSerializer } from './serializer'
 import type { AnySchema, AnyValidator } from './validators'
 import type { NavigateOptions, ResolveRelativePath, ToOptions } from './link'
 import type { NotFoundError } from './not-found'
@@ -1016,7 +1016,8 @@ export class RouterCore<
     if (__tempLocation && (!__tempKey || __tempKey === this.tempLocationKey)) {
       // Sync up the location keys
       const parsedTempLocation = parse(__tempLocation) as any
-      parsedTempLocation.state.key = location.state.key
+      parsedTempLocation.state.key = location.state.key // TODO: Remove in v2 - use __TSR_key instead
+      parsedTempLocation.state.__TSR_key = location.state.__TSR_key
 
       delete parsedTempLocation.state.__tempLocation
 
@@ -1616,7 +1617,8 @@ export class RouterCore<
       // temporarily add the previous values to the next state so they don't affect
       // the comparison
       const ignoredProps = [
-        'key',
+        'key', // TODO: Remove in v2 - use __TSR_key instead
+        '__TSR_key',
         '__TSR_index',
         '__hashScrollIntoViewOptions',
       ] as const
@@ -1657,7 +1659,8 @@ export class RouterCore<
                 ...nextHistory.state,
                 __tempKey: undefined!,
                 __tempLocation: undefined!,
-                key: undefined!,
+                __TSR_key: undefined!,
+                key: undefined!, // TODO: Remove in v2 - use __TSR_key instead
               },
             },
           },
@@ -2854,7 +2857,7 @@ export class RouterCore<
 
   ssr?: {
     manifest: Manifest | undefined
-    serializer: StartSerializer
+    serializer: TsrSerializer
   }
 
   serverSsr?: {

package/src/scroll-restoration.ts

@@ -79,7 +79,7 @@ export const scrollRestorationCache = createScrollRestorationCache()
  */
 
 export const defaultGetScrollRestorationKey = (location: ParsedLocation) => {
-  return location.state.key! || location.href
+  return location.state.__TSR_key! || location.href
 }
 
 export function getCssSelector(el: any): string {

package/src/serializer.ts

@@ -1,10 +1,17 @@
-export interface StartSerializer {
+import { isPlainObject } from './utils'
+
+export interface TsrSerializer {
   stringify: (obj: unknown) => string
   parse: (str: string) => unknown
   encode: <T>(value: T) => T
   decode: <T>(value: T) => T
 }
 
+/**
+ * @deprecated This is re-export of TsrSerializer which is the generic Router serializer interface. Going forward StartSerializer will be used specifically as a Tanstack Start serializer interface.
+ */
+export interface StartSerializer extends TsrSerializer {}
+
 export type SerializerStringifyBy<T, TSerializable> = T extends TSerializable
   ? T
   : T extends (...args: Array<any>) => any
@@ -30,3 +37,169 @@ export type Serializable = Date | undefined | Error | FormData | bigint
 export type SerializerStringify<T> = SerializerStringifyBy<T, Serializable>
 
 export type SerializerParse<T> = SerializerParseBy<T, Serializable>
+export const tsrSerializer: TsrSerializer = {
+  stringify: (value: any) =>
+    JSON.stringify(value, function replacer(key, val) {
+      const ogVal = this[key]
+      const serializer = serializers.find((t) => t.stringifyCondition(ogVal))
+
+      if (serializer) {
+        return serializer.stringify(ogVal)
+      }
+
+      return val
+    }),
+  parse: (value: string) =>
+    JSON.parse(value, function parser(key, val) {
+      const ogVal = this[key]
+      if (isPlainObject(ogVal)) {
+        const serializer = serializers.find((t) => t.parseCondition(ogVal))
+
+        if (serializer) {
+          return serializer.parse(ogVal)
+        }
+      }
+
+      return val
+    }),
+  encode: (value: any) => {
+    // When encoding, dive first
+    if (Array.isArray(value)) {
+      return value.map((v) => tsrSerializer.encode(v))
+    }
+
+    if (isPlainObject(value)) {
+      return Object.fromEntries(
+        Object.entries(value).map(([key, v]) => [key, tsrSerializer.encode(v)]),
+      )
+    }
+
+    const serializer = serializers.find((t) => t.stringifyCondition(value))
+    if (serializer) {
+      return serializer.stringify(value)
+    }
+
+    return value
+  },
+  decode: (value: any) => {
+    // Attempt transform first
+    if (isPlainObject(value)) {
+      const serializer = serializers.find((t) => t.parseCondition(value))
+      if (serializer) {
+        return serializer.parse(value)
+      }
+    }
+
+    if (Array.isArray(value)) {
+      return value.map((v) => tsrSerializer.decode(v))
+    }
+
+    if (isPlainObject(value)) {
+      return Object.fromEntries(
+        Object.entries(value).map(([key, v]) => [key, tsrSerializer.decode(v)]),
+      )
+    }
+
+    return value
+  },
+}
+const createSerializer = <TKey extends string, TInput, TSerialized>(
+  key: TKey,
+  check: (value: any) => value is TInput,
+  toValue: (value: TInput) => TSerialized,
+  fromValue: (value: TSerialized) => TInput,
+) => ({
+  key,
+  stringifyCondition: check,
+  stringify: (value: any) => ({ [`$${key}`]: toValue(value) }),
+  parseCondition: (value: any) => Object.hasOwn(value, `$${key}`),
+  parse: (value: any) => fromValue(value[`$${key}`]),
+})
+// Keep these ordered by predicted frequency
+// Make sure to keep DefaultSerializable in sync with these serializers
+// Also, make sure that they are unit tested in serializer.test.tsx
+const serializers = [
+  createSerializer(
+    // Key
+    'undefined',
+    // Check
+    (v): v is undefined => v === undefined,
+    // To
+    () => 0,
+    // From
+    () => undefined,
+  ),
+  createSerializer(
+    // Key
+    'date',
+    // Check
+    (v): v is Date => v instanceof Date,
+    // To
+    (v) => v.toISOString(),
+    // From
+    (v) => new Date(v),
+  ),
+  createSerializer(
+    // Key
+    'error',
+    // Check
+    (v): v is Error => v instanceof Error,
+    // To
+    (v) => ({
+      ...v,
+      message: v.message,
+      stack: process.env.NODE_ENV === 'development' ? v.stack : undefined,
+      cause: v.cause,
+    }),
+    // From
+    (v) => Object.assign(new Error(v.message), v),
+  ),
+  createSerializer(
+    // Key
+    'formData',
+    // Check
+    (v): v is FormData => v instanceof FormData,
+    // To
+    (v) => {
+      const entries: Record<
+        string,
+        Array<FormDataEntryValue> | FormDataEntryValue
+      > = {}
+      v.forEach((value, key) => {
+        const entry = entries[key]
+        if (entry !== undefined) {
+          if (Array.isArray(entry)) {
+            entry.push(value)
+          } else {
+            entries[key] = [entry, value]
+          }
+        } else {
+          entries[key] = value
+        }
+      })
+      return entries
+    },
+    // From
+    (v) => {
+      const formData = new FormData()
+      Object.entries(v).forEach(([key, value]) => {
+        if (Array.isArray(value)) {
+          value.forEach((val) => formData.append(key, val))
+        } else {
+          formData.append(key, value)
+        }
+      })
+      return formData
+    },
+  ),
+  createSerializer(
+    // Key
+    'bigint',
+    // Check
+    (v): v is bigint => typeof v === 'bigint',
+    // To
+    (v) => v.toString(),
+    // From
+    (v) => BigInt(v),
+  ),
+] as const

package/src/ssr/client.ts

@@ -0,0 +1,15 @@
+export { mergeHeaders, headersInitToObject } from './headers'
+export { json } from './json'
+export type { JsonResponse } from './json'
+export { hydrate } from './ssr-client'
+export type {
+  DehydratedRouter,
+  ClientExtractedBaseEntry,
+  TsrSsrGlobal,
+  ClientExtractedEntry,
+  SsrMatch,
+  ClientExtractedPromise,
+  ClientExtractedStream,
+  ResolvePromiseState,
+} from './ssr-client'
+export { tsrSerializer } from '../serializer'

package/src/ssr/createRequestHandler.ts

@@ -0,0 +1,74 @@
+import { createMemoryHistory } from '@tanstack/history'
+import { mergeHeaders } from './headers'
+import { attachRouterServerSsrUtils, dehydrateRouter } from './ssr-server'
+import type { HandlerCallback } from './handlerCallback'
+import type { AnyRouter } from '../router'
+import type { Manifest } from '../manifest'
+
+export type RequestHandler<TRouter extends AnyRouter> = (
+  cb: HandlerCallback<TRouter>,
+) => Promise<Response>
+
+export function createRequestHandler<TRouter extends AnyRouter>({
+  createRouter,
+  request,
+  getRouterManifest,
+}: {
+  createRouter: () => TRouter
+  request: Request
+  getRouterManifest?: () => Manifest | Promise<Manifest>
+}): RequestHandler<TRouter> {
+  return async (cb) => {
+    const router = createRouter()
+
+    attachRouterServerSsrUtils(router, await getRouterManifest?.())
+
+    const url = new URL(request.url, 'http://localhost')
+
+    const href = url.href.replace(url.origin, '')
+
+    // Create a history for the router
+    const history = createMemoryHistory({
+      initialEntries: [href],
+    })
+
+    // Update the router with the history and context
+    router.update({
+      history,
+    })
+
+    await router.load()
+
+    dehydrateRouter(router)
+
+    const responseHeaders = getRequestHeaders({
+      router,
+    })
+
+    return cb({
+      request,
+      router,
+      responseHeaders,
+    } as any)
+  }
+}
+
+function getRequestHeaders(opts: { router: AnyRouter }): Headers {
+  let headers = mergeHeaders(
+    {
+      'Content-Type': 'text/html; charset=UTF-8',
+    },
+    ...opts.router.state.matches.map((match) => {
+      return match.headers
+    }),
+  )
+
+  // Handle Redirects
+  const { redirect } = opts.router.state
+
+  if (redirect) {
+    headers = mergeHeaders(headers, redirect.headers)
+  }
+
+  return headers
+}

package/src/ssr/handlerCallback.ts

@@ -0,0 +1,15 @@
+import type { AnyRouter } from '../router'
+
+export interface HandlerCallback<TRouter extends AnyRouter> {
+  (ctx: {
+    request: Request
+    router: TRouter
+    responseHeaders: Headers
+  }): Response | Promise<Response>
+}
+
+export function defineHandlerCallback<TRouter extends AnyRouter>(
+  handler: HandlerCallback<TRouter>,
+): HandlerCallback<TRouter> {
+  return handler
+}

package/src/ssr/headers.ts

@@ -0,0 +1,51 @@
+import { splitSetCookieString } from 'cookie-es'
+import type { OutgoingHttpHeaders } from 'node:http2'
+
+// A utility function to turn HeadersInit into an object
+export function headersInitToObject(
+  headers: HeadersInit,
+): Record<keyof OutgoingHttpHeaders, string> {
+  const obj: Record<keyof OutgoingHttpHeaders, string> = {}
+  const headersInstance = new Headers(headers)
+  for (const [key, value] of headersInstance.entries()) {
+    obj[key] = value
+  }
+  return obj
+}
+
+type AnyHeaders =
+  | Headers
+  | HeadersInit
+  | Record<string, string>
+  | Array<[string, string]>
+  | OutgoingHttpHeaders
+  | undefined
+
+// Helper function to convert various HeaderInit types to a Headers instance
+function toHeadersInstance(init: AnyHeaders) {
+  if (init instanceof Headers) {
+    return new Headers(init)
+  } else if (Array.isArray(init)) {
+    return new Headers(init)
+  } else if (typeof init === 'object') {
+    return new Headers(init as HeadersInit)
+  } else {
+    return new Headers()
+  }
+}
+
+// Function to merge headers with proper overrides
+export function mergeHeaders(...headers: Array<AnyHeaders>) {
+  return headers.reduce((acc: Headers, header) => {
+    const headersInstance = toHeadersInstance(header)
+    for (const [key, value] of headersInstance.entries()) {
+      if (key === 'set-cookie') {
+        const splitCookies = splitSetCookieString(value)
+        splitCookies.forEach((cookie) => acc.append('set-cookie', cookie))
+      } else {
+        acc.set(key, value)
+      }
+    }
+    return acc
+  }, new Headers())
+}

package/src/ssr/json.ts

@@ -0,0 +1,18 @@
+import { mergeHeaders } from './headers'
+
+export interface JsonResponse<TData> extends Response {
+  json: () => Promise<TData>
+}
+
+export function json<TData>(
+  payload: TData,
+  init?: ResponseInit,
+): JsonResponse<TData> {
+  return new Response(JSON.stringify(payload), {
+    ...init,
+    headers: mergeHeaders(
+      { 'content-type': 'application/json' },
+      init?.headers,
+    ),
+  })
+}

package/src/ssr/server.ts

@@ -0,0 +1,23 @@
+export { createRequestHandler } from './createRequestHandler'
+export type { RequestHandler } from './createRequestHandler'
+export { defineHandlerCallback } from './handlerCallback'
+export type { HandlerCallback } from './handlerCallback'
+export {
+  transformPipeableStreamWithRouter,
+  transformStreamWithRouter,
+  transformReadableStreamWithRouter,
+} from './transformStreamWithRouter'
+export {
+  attachRouterServerSsrUtils,
+  dehydrateRouter,
+  extractAsyncLoaderData,
+  onMatchSettled,
+  replaceBy,
+} from './ssr-server'
+export type {
+  ServerExtractedBaseEntry,
+  ServerExtractedEntry,
+  ServerExtractedPromise,
+  ServerExtractedStream,
+} from './ssr-server'
+export * from './tsrScript'