@tanstack/start-client-core 1.132.0-alpha.0 → 1.132.0-alpha.10

package/src/index.tsx

@@ -5,18 +5,6 @@ export type {
 
 export { hydrate, json, mergeHeaders } from '@tanstack/router-core/ssr/client'
 
-export { startSerializer } from './serializer'
-
-export type {
-  StartSerializer,
-  Serializable,
-  SerializerParse,
-  SerializerParseBy,
-  SerializerStringify,
-  SerializerStringifyBy,
-  SerializerExtensions,
-} from './serializer'
-
 export {
   createIsomorphicFn,
   type IsomorphicFn,
@@ -24,7 +12,7 @@ export {
   type ClientOnlyFn,
   type IsomorphicFnBase,
 } from './createIsomorphicFn'
-export { serverOnly, clientOnly } from './envOnly'
+export { createServerOnlyFn, createClientOnlyFn } from './envOnly'
 export { createServerFn } from './createServerFn'
 export {
   createMiddleware,
@@ -68,7 +56,6 @@ export type {
   FetcherBaseOptions,
   ServerFn,
   ServerFnCtx,
-  ServerFnResponseType,
   MiddlewareFn,
   ServerFnMiddlewareOptions,
   ServerFnMiddlewareResult,
@@ -83,7 +70,16 @@ export {
   applyMiddleware,
   execValidator,
   serverFnBaseToMiddleware,
-  extractFormDataContext,
   flattenMiddlewares,
   executeMiddleware,
 } from './createServerFn'
+
+export { createClientRpc } from './createClientRpc'
+
+export { getDefaultSerovalPlugins } from './serializer/getDefaultSerovalPlugins'
+
+export {
+  TSS_FORMDATA_CONTEXT,
+  TSS_SERVER_FUNCTION,
+  X_TSS_SERIALIZED,
+} from './constants'

package/src/serializer/ServerFunctionSerializationAdapter.ts

@@ -0,0 +1,16 @@
+import { createSerializationAdapter } from '@tanstack/router-core'
+import { createClientRpc } from '../createClientRpc'
+import { TSS_SERVER_FUNCTION } from '../constants'
+
+export const ServerFunctionSerializationAdapter = createSerializationAdapter({
+  key: '$TSS/serverfn',
+  test: (v): v is { functionId: string } => {
+    if (typeof v !== 'object' || v === null) return false
+
+    if (!(TSS_SERVER_FUNCTION in v)) return false
+
+    return !!v[TSS_SERVER_FUNCTION]
+  },
+  toSerializable: ({ functionId }) => ({ functionId }),
+  fromSerializable: ({ functionId }) => createClientRpc(functionId),
+})

package/src/serializer/getClientSerovalPlugins.ts

@@ -0,0 +1,10 @@
+import { makeSerovalPlugin } from '@tanstack/router-core'
+import { getDefaultSerovalPlugins } from './getDefaultSerovalPlugins'
+import { ServerFunctionSerializationAdapter } from './ServerFunctionSerializationAdapter'
+
+export function getClientSerovalPlugins() {
+  return [
+    ...getDefaultSerovalPlugins(),
+    makeSerovalPlugin(ServerFunctionSerializationAdapter),
+  ]
+}

package/src/serializer/getDefaultSerovalPlugins.ts

@@ -0,0 +1,19 @@
+import invariant from 'tiny-invariant'
+import {
+  makeSerovalPlugin,
+  defaultSerovalPlugins as routerDefaultSerovalPlugins,
+} from '@tanstack/router-core'
+import { getRouterInstance } from '../getRouterInstance'
+import type { AnySerializationAdapter } from '@tanstack/router-core'
+
+export function getDefaultSerovalPlugins() {
+  const router = getRouterInstance()
+  invariant(router, 'Expected router instance to be available')
+  const adapters = router.options.serializationAdapters as
+    | Array<AnySerializationAdapter>
+    | undefined
+  return [
+    ...(adapters?.map(makeSerovalPlugin) ?? []),
+    ...routerDefaultSerovalPlugins,
+  ]
+}

package/src/serverFnFetcher.ts

@@ -0,0 +1,299 @@
+import {
+  encode,
+  isNotFound,
+  isPlainObject,
+  parseRedirect,
+} from '@tanstack/router-core'
+import { fromCrossJSON, toJSONAsync } from 'seroval'
+import invariant from 'tiny-invariant'
+import { getClientSerovalPlugins } from './serializer/getClientSerovalPlugins'
+import { TSS_FORMDATA_CONTEXT, X_TSS_SERIALIZED } from './constants'
+import type { FunctionMiddlewareClientFnOptions } from './createMiddleware'
+import type { Plugin as SerovalPlugin } from 'seroval'
+
+let serovalPlugins: Array<SerovalPlugin<any, any>> | null = null
+
+export async function serverFnFetcher(
+  url: string,
+  args: Array<any>,
+  handler: (url: string, requestInit: RequestInit) => Promise<Response>,
+) {
+  if (!serovalPlugins) {
+    serovalPlugins = getClientSerovalPlugins()
+  }
+  const _first = args[0]
+
+  // If createServerFn was used to wrap the fetcher,
+  // We need to handle the arguments differently
+  if (isPlainObject(_first) && _first.method) {
+    const first = _first as FunctionMiddlewareClientFnOptions<
+      any,
+      any,
+      any,
+      any
+    > & {
+      headers: HeadersInit
+    }
+    const type = first.data instanceof FormData ? 'formData' : 'payload'
+
+    // Arrange the headers
+    const headers = new Headers({
+      'x-tsr-redirect': 'manual',
+      ...(type === 'payload'
+        ? {
+            'content-type': 'application/json',
+            accept: 'application/x-ndjson, application/json',
+          }
+        : {}),
+      ...(first.headers instanceof Headers
+        ? Object.fromEntries(first.headers.entries())
+        : first.headers),
+    })
+
+    // If the method is GET, we need to move the payload to the query string
+    if (first.method === 'GET') {
+      if (type === 'formData') {
+        throw new Error('FormData is not supported with GET requests')
+      }
+      const encodedPayload = encode({
+        payload: await serializePayload(first),
+      })
+
+      if (encodedPayload) {
+        if (url.includes('?')) {
+          url += `&${encodedPayload}`
+        } else {
+          url += `?${encodedPayload}`
+        }
+      }
+    }
+
+    if (url.includes('?')) {
+      url += `&createServerFn`
+    } else {
+      url += `?createServerFn`
+    }
+
+    return await getResponse(async () =>
+      handler(url, {
+        method: first.method,
+        headers,
+        signal: first.signal,
+        ...(await getFetcherRequestOptions(first)),
+      }),
+    )
+  }
+
+  // If not a custom fetcher, it was probably
+  // a `use server` function, so just proxy the arguments
+  // through as a POST request
+  return await getResponse(() =>
+    handler(url, {
+      method: 'POST',
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(args),
+    }),
+  )
+}
+
+async function serializePayload(
+  opts: FunctionMiddlewareClientFnOptions<any, any, any, any>,
+) {
+  const payloadToSerialize: any = {}
+  if (opts.data) {
+    payloadToSerialize['data'] = opts.data
+  }
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  if (opts.context && Object.keys(opts.context).length > 0) {
+    payloadToSerialize['context'] = opts.context
+  }
+
+  return serialize(payloadToSerialize)
+}
+
+async function serialize(data: any) {
+  return JSON.stringify(
+    await Promise.resolve(toJSONAsync(data, { plugins: serovalPlugins! })),
+  )
+}
+
+async function getFetcherRequestOptions(
+  opts: FunctionMiddlewareClientFnOptions<any, any, any, any>,
+) {
+  if (opts.method === 'POST') {
+    if (opts.data instanceof FormData) {
+      opts.data.set(TSS_FORMDATA_CONTEXT, await serialize(opts.context))
+      return {
+        body: opts.data,
+      }
+    }
+
+    return {
+      body: await serializePayload(opts),
+    }
+  }
+
+  return {}
+}
+
+/**
+ * Retrieves a response from a given function and manages potential errors
+ * and special response types including redirects and not found errors.
+ *
+ * @param fn - The function to execute for obtaining the response.
+ * @returns The processed response from the function.
+ * @throws If the response is invalid or an error occurs during processing.
+ */
+async function getResponse(fn: () => Promise<Response>) {
+  const response = await (async () => {
+    try {
+      return await fn()
+    } catch (error) {
+      if (error instanceof Response) {
+        return error
+      }
+
+      throw error
+    }
+  })()
+
+  const contentType = response.headers.get('content-type')
+  invariant(contentType, 'expected content-type header to be set')
+  const serializedByStart = !!response.headers.get(X_TSS_SERIALIZED)
+  // If the response is not ok, throw an error
+  if (!response.ok) {
+    if (serializedByStart && contentType.includes('application/json')) {
+      const jsonPayload = await response.json()
+      const result = fromCrossJSON(jsonPayload, { plugins: serovalPlugins! })
+      throw result
+    }
+
+    throw new Error(await response.text())
+  }
+
+  if (serializedByStart) {
+    let result
+    if (contentType.includes('application/x-ndjson')) {
+      const refs = new Map()
+      result = await processServerFnResponse({
+        response,
+        onMessage: (msg) =>
+          fromCrossJSON(msg, { refs, plugins: serovalPlugins! }),
+        onError(msg, error) {
+          // TODO how could we notify consumer that an error occurred?
+          console.error(msg, error)
+        },
+      })
+    }
+    if (contentType.includes('application/json')) {
+      const jsonPayload = await response.json()
+      result = fromCrossJSON(jsonPayload, { plugins: serovalPlugins! })
+    }
+    invariant(result, 'expected result to be resolved')
+    if (result instanceof Error) {
+      throw result
+    }
+    return result
+  }
+
+  if (contentType.includes('application/json')) {
+    const jsonPayload = await response.json()
+    const redirect = parseRedirect(jsonPayload)
+    if (redirect) {
+      throw redirect
+    }
+    if (isNotFound(jsonPayload)) {
+      throw jsonPayload
+    }
+    return jsonPayload
+  }
+
+  return response
+}
+
+async function processServerFnResponse({
+  response,
+  onMessage,
+  onError,
+}: {
+  response: Response
+  onMessage: (msg: any) => any
+  onError?: (msg: string, error?: any) => void
+}) {
+  if (!response.body) {
+    throw new Error('No response body')
+  }
+
+  const reader = response.body.pipeThrough(new TextDecoderStream()).getReader()
+
+  let buffer = ''
+  let firstRead = false
+  let firstObject
+
+  while (!firstRead) {
+    const { value, done } = await reader.read()
+    if (value) buffer += value
+
+    if (buffer.length === 0 && done) {
+      throw new Error('Stream ended before first object')
+    }
+
+    // common case: buffer ends with newline
+    if (buffer.endsWith('\n')) {
+      const lines = buffer.split('\n').filter(Boolean)
+      const firstLine = lines[0]
+      if (!firstLine) throw new Error('No JSON line in the first chunk')
+      firstObject = JSON.parse(firstLine)
+      firstRead = true
+      buffer = lines.slice(1).join('\n')
+    } else {
+      // fallback: wait for a newline to parse first object safely
+      const newlineIndex = buffer.indexOf('\n')
+      if (newlineIndex >= 0) {
+        const line = buffer.slice(0, newlineIndex).trim()
+        buffer = buffer.slice(newlineIndex + 1)
+        if (line.length > 0) {
+          firstObject = JSON.parse(line)
+          firstRead = true
+        }
+      }
+    }
+  }
+
+  // process rest of the stream asynchronously
+  ;(async () => {
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      while (true) {
+        const { value, done } = await reader.read()
+        if (value) buffer += value
+
+        const lastNewline = buffer.lastIndexOf('\n')
+        if (lastNewline >= 0) {
+          const chunk = buffer.slice(0, lastNewline)
+          buffer = buffer.slice(lastNewline + 1)
+          const lines = chunk.split('\n').filter(Boolean)
+
+          for (const line of lines) {
+            try {
+              onMessage(JSON.parse(line))
+            } catch (e) {
+              onError?.(`Invalid JSON line: ${line}`, e)
+            }
+          }
+        }
+
+        if (done) {
+          break
+        }
+      }
+    } catch (err) {
+      onError?.('Stream processing error:', err)
+    }
+  })()
+
+  return onMessage(firstObject)
+}