chore: Use shared type helper

wobsoriano · wobsoriano · commit 40cf986e44b9 · 2025-10-07T12:19:12.000-07:00
diff --git a/.changeset/spotty-cooks-march.md b/.changeset/spotty-cooks-march.md
@@ -2,4 +2,69 @@
 "@clerk/tanstack-react-start": minor
 ---
 
-placeholder trigger test
+Added support for [TanStack Start v1 RC](https://tanstack.com/blog/announcing-tanstack-start-v1)! Includes a new `clerkMiddleware()` global middleware replacing the custom server handler.
+
+Usage:
+
+1. Create a `src/start.ts` file and add `clerkMiddleware()` to the list of request middlewares:
+
+```ts
+// src/start.ts
+import { clerkMiddleware } from '@clerk/tanstack-react-start/server'
+import { createStart } from '@tanstack/react-start'
+
+export const startInstance = createStart(() => {
+  return {
+    requestMiddleware: [clerkMiddleware()],
+  }
+})
+```
+
+2. Add `<ClerkProvider>` to your root route
+
+```tsx
+// src/routes/__root.tsx
+import { ClerkProvider } from '@clerk/tanstack-react-start'
+
+export const Route = createRootRoute({...})
+
+function RootDocument({ children }: { children: React.ReactNode }) {
+  return (
+    <ClerkProvider>
+      <html>
+        <head>
+          <HeadContent />
+        </head>
+        <body>
+          {children}
+          <Scripts />
+        </body>
+      </html>
+    </ClerkProvider>
+  )
+}
+```
+
+The `getAuth()` helper can now be called within server routes and functions, without passing a Request object:
+
+```ts
+const authStateFn = createServerFn().handler(async () => {
+  const { userId } = await getAuth()
+
+  if (!userId) {
+    throw redirect({
+      to: '/sign-in',
+    })
+  }
+
+  return { userId }
+})
+
+export const Route = createFileRoute('/')({
+  component: Home,
+  beforeLoad: async () => await authStateFn(),
+  loader: async ({ context }) => {
+    return { userId: context.userId }
+  },
+})
+```
diff --git a/integration/templates/tanstack-react-start/src/routes/user.tsx b/integration/templates/tanstack-react-start/src/routes/user.tsx
@@ -1,10 +1,9 @@
 import { createFileRoute, redirect } from '@tanstack/react-router';
 import { createServerFn } from '@tanstack/react-start';
 import { getAuth } from '@clerk/tanstack-react-start/server';
-import { getRequest } from '@tanstack/react-start/server';
 
 const fetchClerkAuth = createServerFn({ method: 'GET' }).handler(async () => {
-  const { userId } = await getAuth(getRequest());
+  const { userId } = await getAuth();
 
   return {
     userId,
diff --git a/packages/tanstack-react-start/src/server/getAuth.ts b/packages/tanstack-react-start/src/server/getAuth.ts
@@ -1,10 +1,12 @@
+import type { SessionAuthObject } from '@clerk/backend';
 import type { AuthOptions, GetAuthFnNoRequest } from '@clerk/backend/internal';
 import { getAuthObjectForAcceptedToken } from '@clerk/backend/internal';
 import { getGlobalStartContext } from '@tanstack/react-start';
 
-import { clerkMiddlewareNotConfigured, noFetchFnCtxPassedInGetAuth } from '../utils/errors';
+import { errorThrower } from '../utils';
+import { clerkMiddlewareNotConfigured } from '../utils/errors';
 
-export const getAuth: GetAuthFnNoRequest<{}, true> = (async (opts?: AuthOptions) => {
+export const getAuth: GetAuthFnNoRequest<SessionAuthObject, true> = (async (opts?: AuthOptions) => {
   // @ts-expect-error: Untyped internal Clerk start context
   const authObjectFn = getGlobalStartContext().auth;
 
@@ -16,4 +18,4 @@ export const getAuth: GetAuthFnNoRequest<{}, true> = (async (opts?: AuthOptions)
   const authObject = await Promise.resolve(authObjectFn({ treatPendingAsSignedOut: opts?.treatPendingAsSignedOut }));
 
   return getAuthObjectForAcceptedToken({ authObject, acceptsToken: opts?.acceptsToken });
-}) as GetAuthFn<Request, true>;
+}) as GetAuthFnNoRequest<SessionAuthObject, true>;
