diff --git a/.gitignore b/.gitignore index 8fa5c69404..42217cf108 100644 --- a/.gitignore +++ b/.gitignore @@ -140,10 +140,12 @@ packages/js/* packages/react/* packages/next/* packages/stack/* +packages/tanstack-start/* !packages/js/package.json !packages/react/package.json !packages/next/package.json !packages/stack/package.json +!packages/tanstack-start/package.json # claude code .claude/scheduled_tasks.lock diff --git a/apps/dashboard/public/tanstack-start-logo.png b/apps/dashboard/public/tanstack-start-logo.png new file mode 100644 index 0000000000..41443b6c22 Binary files /dev/null and b/apps/dashboard/public/tanstack-start-logo.png differ diff --git a/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx b/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx index 4bad9d7ec0..7585de4646 100644 --- a/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx +++ b/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx @@ -1,7 +1,7 @@ 'use client'; import { CodeBlock } from '@/components/code-block'; -import { APIEnvKeys, NextJsEnvKeys } from '@/components/env-keys'; +import { APIEnvKeys, NextJsEnvKeys, ViteEnvKeys } from '@/components/env-keys'; import { InlineCode } from '@/components/inline-code'; import { StyledLink } from '@/components/link'; import { CopyPromptButton, Tabs, TabsContent, TabsList, TabsTrigger, Typography, cn } from "@/components/ui"; @@ -27,22 +27,58 @@ const nameClasses = "text-green-600 dark:text-green-500"; const INSTALL_COMMAND_BY_FRAMEWORK = { nextjs: 'npx @stackframe/stack-cli@latest init', + tanstackStart: 'npm install @stackframe/tanstack-start', react: 'npm install @stackframe/react', javascript: 'npm install @stackframe/js', python: 'pip install requests', } as const; -const buildInstallPrompt = (command: string) => deindent` +type SetupFramework = keyof typeof INSTALL_COMMAND_BY_FRAMEWORK; + +const TANSTACK_START_SETUP_PROMPT = deindent` + Please set up Stack Auth in my TanStack Start app. + + 1. Install the alpha TanStack Start package: + + npm install @stackframe/tanstack-start + + 2. Configure the app with these environment variables: + + VITE_STACK_PROJECT_ID= + STACK_SECRET_SERVER_KEY= + + 3. Create a StackClientApp using @stackframe/tanstack-start with: + - projectId: import.meta.env.VITE_STACK_PROJECT_ID + - tokenStore: "cookie" + - redirectMethod: "window" + + 4. Wrap the TanStack Start root route with StackProvider and StackTheme. + + 5. Add a /handler/$ route using StackHandler. The handler route must set ssr: false and pass location={pathname} from useLocation(). + + Use only the environment variables listed above. + + After it finishes, verify that the Stack Auth MCP server is registered in your AI client config — name: \`stack-auth\`, transport: \`http\`, URL: \`https://mcp.stack-auth.com/\`. If it is not registered, please add it manually so you have live access to Stack Auth docs and APIs. +`; + +const buildInstallPrompt = (framework: SetupFramework) => { + if (framework === "tanstackStart") { + return TANSTACK_START_SETUP_PROMPT; + } + + const command = INSTALL_COMMAND_BY_FRAMEWORK[framework]; + return deindent` Please run the following command in my project's terminal: ${command} After it finishes, verify that the Stack Auth MCP server is registered in your AI client config — name: \`stack-auth\`, transport: \`http\`, URL: \`https://mcp.stack-auth.com/mcp\`. The command above should handle this automatically; if for any reason it didn't, please add the MCP server manually so you have live access to Stack Auth docs and APIs. `; +}; export default function SetupPage(props: { toMetrics: () => void }) { const adminApp = useAdminApp(); - const [selectedFramework, setSelectedFramework] = useState<'nextjs' | 'react' | 'javascript' | 'python'>('nextjs'); + const [selectedFramework, setSelectedFramework] = useState<'nextjs' | 'tanstackStart' | 'react' | 'javascript' | 'python'>('nextjs'); const [keys, setKeys] = useState<{ projectId: string, publishableClientKey?: string, secretServerKey: string } | null>(null); const projectConfig = adminApp.useProject().useConfig(); const requirePublishableClientKey = projectConfig.project.requirePublishableClientKey; @@ -220,6 +256,142 @@ export default function SetupPage(props: { toMetrics: () => void }) { } ]; + const tanstackStartSteps = [ + { + step: 2, + title: "Install Stack Auth", + content: <> + + In a new or existing TanStack Start project, install the alpha Stack Auth package: + + + npm install @stackframe/tanstack-start + + } + title="Terminal" + icon="terminal" + /> + + }, + { + step: 3, + title: "Create Keys", + content: <> + + Put these keys in your TanStack Start environment file. + + + + }, + { + step: 4, + title: "Create stack/client.ts file", + content: <> + + Create a new file called src/stack/client.ts and initialize Stack Auth with cookie storage. + + + + }, + { + step: 5, + title: "Update the root route", + content: <> + + Wrap your TanStack Start root route with StackProvider and StackTheme. + + + + + + + ); + } + + function RootDocument({ children }: { children: React.ReactNode }) { + return ( + + + + + + {children} + + + + ); + } + `} + title="src/routes/__root.tsx" + icon="code" + /> + + }, + { + step: 6, + title: "Add the handler route", + content: <> + + Create a splat route for Stack Auth's built-in auth pages. + + ; + } + `} + title="src/routes/handler/$.tsx" + icon="code" + /> + + If you start your TanStack Start app and navigate to http://localhost:3000/handler/sign-up, you will see the sign-up page. + + + }, + ]; + const javascriptSteps = [ { step: 2, @@ -480,7 +652,7 @@ export default function SetupPage(props: { toMetrics: () => void }) { Copy prompt @@ -500,6 +672,11 @@ export default function SetupPage(props: { toMetrics: () => void }) { name: 'Next.js', reverseIfDark: true, imgSrc: '/next-logo.svg', + }, { + id: 'tanstackStart', + name: 'TanStack Start', + reverseIfDark: false, + imgSrc: '/tanstack-start-logo.png', }, { id: 'react', name: 'React', @@ -538,6 +715,7 @@ export default function SetupPage(props: { toMetrics: () => void }) { , }, ...(selectedFramework === 'nextjs' ? nextJsSteps : []), + ...(selectedFramework === 'tanstackStart' ? tanstackStartSteps : []), ...(selectedFramework === 'react' ? reactSteps : []), ...(selectedFramework === 'javascript' ? javascriptSteps : []), ...(selectedFramework === 'python' ? pythonSteps : []), @@ -638,7 +816,7 @@ function GlobeIllustrationInner() { function StackAuthKeys(props: { keys: { projectId: string, publishableClientKey?: string, secretServerKey: string } | null, onGenerateKeys: () => Promise, - type: 'next' | 'raw', + type: 'next' | 'vite' | 'raw', }) { return (
@@ -650,6 +828,11 @@ function StackAuthKeys(props: { publishableClientKey={props.keys.publishableClientKey} secretServerKey={props.keys.secretServerKey} /> + ) : props.type === 'vite' ? ( + ) : ( { - router.push(subAppDestinationPath ?? appPath); + if (documentationHref != null) { + window.location.href = documentationHref; + } else { + router.push(subAppDestinationPath ?? appDestination); + } }; const handleDisable = async () => { diff --git a/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/sidebar-layout.tsx b/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/sidebar-layout.tsx index 6c395bd636..a7098614a7 100644 --- a/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/sidebar-layout.tsx +++ b/apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/sidebar-layout.tsx @@ -58,9 +58,11 @@ type AppSection = { items: { name: string, href: string, + external?: boolean, match: (fullUrl: URL) => boolean, }[], firstItemHref?: string, + firstItemExternal?: boolean, }; type BottomItem = { @@ -209,6 +211,7 @@ function NavItem({ if (isCollapsed) { // For sections, navigate to the first item when collapsed const collapsedHref = isSection && item.firstItemHref ? item.firstItemHref : href; + const collapsedTarget = isSection && item.firstItemExternal ? "_blank" : undefined; return (
@@ -226,7 +229,7 @@ function NavItem({ : "hover:bg-white/40 dark:hover:bg-background/60 text-muted-foreground hover:text-foreground" )} > - + @@ -351,6 +354,7 @@ function NavSubItem({ return ( ({ name: navItem.displayName, href: getItemPath(projectId, navigableFrontend, navItem), + external: navItem.external, match: (fullUrl: URL) => testItemPath(projectId, navigableFrontend, navItem, fullUrl), })); return { @@ -413,6 +418,7 @@ function AppNavItem({ href: getAppPath(projectId, appFrontend), icon: appFrontend.icon, firstItemHref: items[0]?.href, + firstItemExternal: items[0]?.external, }; }, [app.displayName, appId, appFrontend, projectId]); diff --git a/apps/dashboard/src/components/app-square.tsx b/apps/dashboard/src/components/app-square.tsx index 09537c2b72..5758d1ef0a 100644 --- a/apps/dashboard/src/components/app-square.tsx +++ b/apps/dashboard/src/components/app-square.tsx @@ -1,7 +1,7 @@ import { useAdminApp, useProjectId } from "@/app/(main)/(protected)/projects/[projectId]/use-admin-app"; import { useRouter } from "@/components/router"; import { Button, cn, DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from "@/components/ui"; -import { ALL_APPS_FRONTEND, AppFrontend, getAppPath, isSubApp } from "@/lib/apps-frontend"; +import { ALL_APPS_FRONTEND, AppFrontend, getAppPath, getDocumentationHref, isSubApp } from "@/lib/apps-frontend"; import { isAppEnabled } from "@/lib/apps-utils"; import { useUpdateConfig } from "@/lib/config-update"; import { CheckIcon, DotsThreeVerticalIcon } from "@phosphor-icons/react"; @@ -220,6 +220,7 @@ export function AppListItem({ const isEnabled = isAppEnabled(config.apps.installed, appId); const appPath = getAppPath(project.id, appFrontend); + const appDestinationPath = getDocumentationHref(appFrontend) ?? appPath; const appDetailsPath = `/projects/${project.id}/apps/${appId}`; const router = useRouter(); const parentAppId = isSubApp(appFrontend) ? appFrontend.parentAppId : null; @@ -249,7 +250,7 @@ export function AppListItem({ return ( (null); @@ -154,7 +155,7 @@ export function AppStoreEntry({ className="px-8 bg-blue-600 hover:bg-blue-700 dark:bg-blue-500 dark:hover:bg-blue-600 text-white font-medium shadow-lg shadow-blue-500/20" > - Open App + {isDocumentationBackedApp ? "Open Docs" : "Open App"} {onDisable && (
); } - diff --git a/examples/tanstack-start-demo/.env.development b/examples/tanstack-start-demo/.env.development new file mode 100644 index 0000000000..881f07c4b1 --- /dev/null +++ b/examples/tanstack-start-demo/.env.development @@ -0,0 +1,3 @@ +VITE_STACK_API_URL=http://localhost:${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}02 +VITE_STACK_PROJECT_ID=internal +VITE_STACK_PUBLISHABLE_CLIENT_KEY=this-publishable-client-key-is-for-local-development-only diff --git a/examples/tanstack-start-demo/.eslintrc.cjs b/examples/tanstack-start-demo/.eslintrc.cjs new file mode 100644 index 0000000000..1a4ae3fdbe --- /dev/null +++ b/examples/tanstack-start-demo/.eslintrc.cjs @@ -0,0 +1,4 @@ +module.exports = { + extends: ["../../configs/eslint/defaults.js"], + ignorePatterns: ["/*", "!/src"], +}; diff --git a/examples/tanstack-start-demo/.gitignore b/examples/tanstack-start-demo/.gitignore new file mode 100644 index 0000000000..d121322a72 --- /dev/null +++ b/examples/tanstack-start-demo/.gitignore @@ -0,0 +1,4 @@ +.output +.tanstack +dist +node_modules diff --git a/examples/tanstack-start-demo/package.json b/examples/tanstack-start-demo/package.json new file mode 100644 index 0000000000..3f735963db --- /dev/null +++ b/examples/tanstack-start-demo/package.json @@ -0,0 +1,40 @@ +{ + "name": "@stackframe/example-tanstack-start-demo", + "version": "2.8.86", + "repository": "https://github.com/stack-auth/stack-auth", + "description": "TanStack Start demo app for Stack Auth", + "private": true, + "type": "module", + "scripts": { + "typecheck": "tsc --noEmit", + "clean": "rimraf .output && rimraf node_modules", + "dev": "vite dev --port ${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}43", + "build": "vite build", + "start": "node .output/server/index.mjs", + "lint": "eslint --ext .ts,.tsx ." + }, + "dependencies": { + "@stackframe/stack-shared": "workspace:*", + "@stackframe/stack-ui": "workspace:*", + "@stackframe/tanstack-start": "workspace:*", + "@tanstack/react-router": "^1.168.23", + "@tanstack/react-start": "^1.167.42", + "nitro": "^3.0.0", + "react": "19.2.1", + "react-dom": "19.2.1" + }, + "devDependencies": { + "@types/node": "^22.13.0", + "@types/react": "19.2.1", + "@types/react-dom": "19.2.1", + "@vitejs/plugin-react": "^5.0.0", + "autoprefixer": "^10.4.20", + "postcss": "^8.4.47", + "rimraf": "^5.0.10", + "tailwindcss": "^3.4.14", + "typescript": "5.9.3", + "vite": "^7.0.0", + "vite-tsconfig-paths": "^4.3.2" + }, + "packageManager": "pnpm@10.23.0" +} diff --git a/examples/tanstack-start-demo/postcss.config.js b/examples/tanstack-start-demo/postcss.config.js new file mode 100644 index 0000000000..2aa7205d4b --- /dev/null +++ b/examples/tanstack-start-demo/postcss.config.js @@ -0,0 +1,6 @@ +export default { + plugins: { + tailwindcss: {}, + autoprefixer: {}, + }, +}; diff --git a/examples/tanstack-start-demo/src/client.tsx b/examples/tanstack-start-demo/src/client.tsx new file mode 100644 index 0000000000..51b520a484 --- /dev/null +++ b/examples/tanstack-start-demo/src/client.tsx @@ -0,0 +1,12 @@ +import { StartClient } from "@tanstack/react-start/client"; +import { StrictMode, startTransition } from "react"; +import { hydrateRoot } from "react-dom/client"; + +startTransition(() => { + hydrateRoot( + document, + + + , + ); +}); diff --git a/examples/tanstack-start-demo/src/components/header.tsx b/examples/tanstack-start-demo/src/components/header.tsx new file mode 100644 index 0000000000..b8e292cba4 --- /dev/null +++ b/examples/tanstack-start-demo/src/components/header.tsx @@ -0,0 +1,33 @@ +import { Link } from "@tanstack/react-router"; +import { UserButton } from "@stackframe/tanstack-start"; +import { useEffect, useState } from "react"; + +export function Header() { + return ( + <> +
+
+ + +
+
+
+ + ); +} + +function ClientMountedUserButton() { + const [isMounted, setIsMounted] = useState(false); + useEffect(() => { + setIsMounted(true); + }, []); + + return isMounted ? :
; +} diff --git a/examples/tanstack-start-demo/src/routeTree.gen.ts b/examples/tanstack-start-demo/src/routeTree.gen.ts new file mode 100644 index 0000000000..7a987f7e3d --- /dev/null +++ b/examples/tanstack-start-demo/src/routeTree.gen.ts @@ -0,0 +1,104 @@ +/* eslint-disable */ + +// @ts-nocheck + +// noinspection JSUnusedGlobalSymbols + +// This file was automatically generated by TanStack Router. +// You should NOT make any changes in this file as it will be overwritten. +// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified. + +import { Route as rootRouteImport } from './routes/__root' +import { Route as ProtectedRouteImport } from './routes/protected' +import { Route as IndexRouteImport } from './routes/index' +import { Route as HandlerSplatRouteImport } from './routes/handler/$' + +const ProtectedRoute = ProtectedRouteImport.update({ + id: '/protected', + path: '/protected', + getParentRoute: () => rootRouteImport, +} as any) +const IndexRoute = IndexRouteImport.update({ + id: '/', + path: '/', + getParentRoute: () => rootRouteImport, +} as any) +const HandlerSplatRoute = HandlerSplatRouteImport.update({ + id: '/handler/$', + path: '/handler/$', + getParentRoute: () => rootRouteImport, +} as any) + +export interface FileRoutesByFullPath { + '/': typeof IndexRoute + '/protected': typeof ProtectedRoute + '/handler/$': typeof HandlerSplatRoute +} +export interface FileRoutesByTo { + '/': typeof IndexRoute + '/protected': typeof ProtectedRoute + '/handler/$': typeof HandlerSplatRoute +} +export interface FileRoutesById { + __root__: typeof rootRouteImport + '/': typeof IndexRoute + '/protected': typeof ProtectedRoute + '/handler/$': typeof HandlerSplatRoute +} +export interface FileRouteTypes { + fileRoutesByFullPath: FileRoutesByFullPath + fullPaths: '/' | '/protected' | '/handler/$' + fileRoutesByTo: FileRoutesByTo + to: '/' | '/protected' | '/handler/$' + id: '__root__' | '/' | '/protected' | '/handler/$' + fileRoutesById: FileRoutesById +} +export interface RootRouteChildren { + IndexRoute: typeof IndexRoute + ProtectedRoute: typeof ProtectedRoute + HandlerSplatRoute: typeof HandlerSplatRoute +} + +declare module '@tanstack/react-router' { + interface FileRoutesByPath { + '/protected': { + id: '/protected' + path: '/protected' + fullPath: '/protected' + preLoaderRoute: typeof ProtectedRouteImport + parentRoute: typeof rootRouteImport + } + '/': { + id: '/' + path: '/' + fullPath: '/' + preLoaderRoute: typeof IndexRouteImport + parentRoute: typeof rootRouteImport + } + '/handler/$': { + id: '/handler/$' + path: '/handler/$' + fullPath: '/handler/$' + preLoaderRoute: typeof HandlerSplatRouteImport + parentRoute: typeof rootRouteImport + } + } +} + +const rootRouteChildren: RootRouteChildren = { + IndexRoute: IndexRoute, + ProtectedRoute: ProtectedRoute, + HandlerSplatRoute: HandlerSplatRoute, +} +export const routeTree = rootRouteImport + ._addFileChildren(rootRouteChildren) + ._addFileTypes() + +import type { getRouter } from './router.tsx' +import type { createStart } from '@tanstack/react-start' +declare module '@tanstack/react-start' { + interface Register { + ssr: true + router: Awaited> + } +} diff --git a/examples/tanstack-start-demo/src/router.tsx b/examples/tanstack-start-demo/src/router.tsx new file mode 100644 index 0000000000..9edcb7fb20 --- /dev/null +++ b/examples/tanstack-start-demo/src/router.tsx @@ -0,0 +1,18 @@ +import { createRouter } from "@tanstack/react-router"; +import { routeTree } from "./routeTree.gen"; + +export function getRouter() { + return createRouter({ + routeTree, + scrollRestoration: true, + defaultNotFoundComponent: () => ( +
+
+

404

+

Page not found

+

This route is not part of the TanStack Start demo.

+
+
+ ), + }); +} diff --git a/examples/tanstack-start-demo/src/routes/__root.tsx b/examples/tanstack-start-demo/src/routes/__root.tsx new file mode 100644 index 0000000000..25adb8163c --- /dev/null +++ b/examples/tanstack-start-demo/src/routes/__root.tsx @@ -0,0 +1,58 @@ +/// +import "../styles.css"; + +import { StackProvider, StackTheme } from "@stackframe/tanstack-start"; +import { createRootRoute, HeadContent, Outlet, Scripts } from "@tanstack/react-router"; +import type { ReactNode } from "react"; +import { Suspense, useMemo } from "react"; +import { Header } from "~/components/header"; +import { createStackApp } from "~/stack"; + +export const Route = createRootRoute({ + head: () => ({ + meta: [ + { charSet: "utf-8" }, + { name: "viewport", content: "width=device-width, initial-scale=1" }, + { title: "Stack Auth TanStack Start Demo" }, + { + name: "description", + content: "TanStack Start demo application using Stack Auth.", + }, + ], + }), + shellComponent: RootDocument, + component: RootComponent, +}); + +function RootDocument({ children }: { children: ReactNode }) { + return ( + + + + + + {children} + + + + ); +} + +function RootComponent() { + const stackApp = useMemo(() => createStackApp(), []); + + return ( + + +
+
+
+ + + +
+
+
+
+ ); +} diff --git a/examples/tanstack-start-demo/src/routes/handler/$.tsx b/examples/tanstack-start-demo/src/routes/handler/$.tsx new file mode 100644 index 0000000000..e3b97ca859 --- /dev/null +++ b/examples/tanstack-start-demo/src/routes/handler/$.tsx @@ -0,0 +1,12 @@ +import { StackHandler } from "@stackframe/tanstack-start"; +import { createFileRoute, useLocation } from "@tanstack/react-router"; + +export const Route = createFileRoute("/handler/$")({ + ssr: false, + component: HandlerPage, +}); + +function HandlerPage() { + const { pathname } = useLocation(); + return ; +} diff --git a/examples/tanstack-start-demo/src/routes/index.tsx b/examples/tanstack-start-demo/src/routes/index.tsx new file mode 100644 index 0000000000..a434dfb08a --- /dev/null +++ b/examples/tanstack-start-demo/src/routes/index.tsx @@ -0,0 +1,76 @@ +import { runAsynchronouslyWithAlert } from "@stackframe/stack-shared/dist/utils/promises"; +import { UserAvatar, useStackApp, useUser } from "@stackframe/tanstack-start"; +import { createFileRoute } from "@tanstack/react-router"; + +export const Route = createFileRoute("/")({ + component: HomePage, +}); + +function HomePage() { + const user = useUser({ includeRestricted: true }); + const app = useStackApp(); + + if (!user) { + return ( +
+
+

TanStack Start alpha

+

Welcome to the Stack demo app.

+

+ This example uses @stackframe/tanstack-start with file-based routes and Stack Auth handler pages. +

+
+ + +
+
+
+ ); + } + + return ( +
+
+
+ +
+

Signed in as

+

{user.displayName ?? user.primaryEmail ?? user.id}

+ {user.isRestricted && ( + + Restricted + + )} +
+
+ +
+
+
User ID
+
{user.id}
+
+ {user.primaryEmail && ( +
+
Email
+
{user.primaryEmail}
+
+ )} +
+
Restricted
+
{user.isRestricted ? `Yes${user.restrictedReason ? ` (${user.restrictedReason.type})` : ""}` : "No"}
+
+
+ +
+ +
+
+
+ ); +} diff --git a/examples/tanstack-start-demo/src/routes/protected.tsx b/examples/tanstack-start-demo/src/routes/protected.tsx new file mode 100644 index 0000000000..9cceb955eb --- /dev/null +++ b/examples/tanstack-start-demo/src/routes/protected.tsx @@ -0,0 +1,23 @@ +import { useUser } from "@stackframe/tanstack-start"; +import { createFileRoute } from "@tanstack/react-router"; + +export const Route = createFileRoute("/protected")({ + ssr: false, + component: ProtectedPage, +}); + +function ProtectedPage() { + const user = useUser({ or: "redirect" }); + + return ( +
+
+

Protected route

+

You can see this because you are signed in.

+

+ TanStack Start rendered this route with Stack Auth session state for {user.displayName ?? user.primaryEmail ?? user.id}. +

+
+
+ ); +} diff --git a/examples/tanstack-start-demo/src/stack.ts b/examples/tanstack-start-demo/src/stack.ts new file mode 100644 index 0000000000..a6b315a362 --- /dev/null +++ b/examples/tanstack-start-demo/src/stack.ts @@ -0,0 +1,29 @@ +import { StackClientApp } from "@stackframe/tanstack-start"; + +function getPortPrefix(): string { + return import.meta.env.NEXT_PUBLIC_STACK_PORT_PREFIX ?? "81"; +} + +function replaceStackPortPrefix(value: string): string { + return value.replace(/\$\{NEXT_PUBLIC_STACK_PORT_PREFIX:-81\}/g, getPortPrefix()); +} + +function getStackApiUrl(): string { + const configured = import.meta.env.VITE_STACK_API_URL as string | undefined; + return configured ? replaceStackPortPrefix(configured) : `http://localhost:${getPortPrefix()}02`; +} + +export function createStackApp() { + return new StackClientApp({ + projectId: import.meta.env.VITE_STACK_PROJECT_ID ?? "internal", + publishableClientKey: import.meta.env.VITE_STACK_PUBLISHABLE_CLIENT_KEY ?? "this-publishable-client-key-is-for-local-development-only", + baseUrl: getStackApiUrl(), + tokenStore: "cookie", + redirectMethod: "window", + urls: { + afterSignIn: "/protected", + afterSignUp: "/protected", + afterSignOut: "/", + }, + }); +} diff --git a/examples/tanstack-start-demo/src/styles.css b/examples/tanstack-start-demo/src/styles.css new file mode 100644 index 0000000000..06b4c37556 --- /dev/null +++ b/examples/tanstack-start-demo/src/styles.css @@ -0,0 +1,24 @@ +/* stylelint-disable scss/at-rule-no-unknown */ +@tailwind base; +@tailwind components; +@tailwind utilities; +/* stylelint-enable scss/at-rule-no-unknown */ + +:root { + color-scheme: light; + background: rgb(244 244 245); +} + +html:has(head > [data-stack-theme="dark"]) { + color-scheme: dark; + background: rgb(9 9 11); +} + +body { + margin: 0; +} + +button, +a { + -webkit-tap-highlight-color: transparent; +} diff --git a/examples/tanstack-start-demo/tailwind.config.js b/examples/tanstack-start-demo/tailwind.config.js new file mode 100644 index 0000000000..4c91f98879 --- /dev/null +++ b/examples/tanstack-start-demo/tailwind.config.js @@ -0,0 +1,12 @@ +/** @type {import('tailwindcss').Config} */ +export default { + darkMode: ["selector", 'html:has(head > [data-stack-theme="dark"])'], + content: [ + "./src/**/*.{js,ts,jsx,tsx}", + "../../packages/stack-ui/src/**/*.{ts,tsx}", + ], + theme: { + extend: {}, + }, + plugins: [], +}; diff --git a/examples/tanstack-start-demo/tsconfig.json b/examples/tanstack-start-demo/tsconfig.json new file mode 100644 index 0000000000..8578865f20 --- /dev/null +++ b/examples/tanstack-start-demo/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "target": "ES2022", + "lib": ["DOM", "DOM.Iterable", "ES2022"], + "module": "ESNext", + "moduleResolution": "Bundler", + "strict": true, + "skipLibCheck": true, + "isolatedModules": true, + "noEmit": true, + "resolveJsonModule": true, + "esModuleInterop": true, + "baseUrl": ".", + "paths": { + "~/*": ["./src/*"] + } + }, + "include": ["src", "vite.config.ts"] +} diff --git a/examples/tanstack-start-demo/vite.config.ts b/examples/tanstack-start-demo/vite.config.ts new file mode 100644 index 0000000000..39c84c2450 --- /dev/null +++ b/examples/tanstack-start-demo/vite.config.ts @@ -0,0 +1,94 @@ +import fs from "node:fs"; +import path from "node:path"; +import { fileURLToPath } from "node:url"; +import { tanstackStart } from "@tanstack/react-start/plugin/vite"; +import viteReact from "@vitejs/plugin-react"; +import { defineConfig, type Plugin } from "vite"; +import { nitro } from "nitro/vite"; +import tsConfigPaths from "vite-tsconfig-paths"; + +const stackAuthRootPath = fileURLToPath(new URL("../..", import.meta.url)); + +function watchNodeModules(modules: string[]): Plugin { + return { + name: "watch-node-modules", + config() { + return { + server: { + watch: { + ignored: modules.map((moduleName) => `!**/node_modules/${moduleName}/**`), + }, + }, + }; + }, + }; +} + +function waitForWorkspacePackages(packages: string[]): Plugin { + const packageDistEntries = packages.map((pkg) => ({ + name: pkg, + entry: path.resolve(__dirname, "node_modules", pkg, "dist", "esm", "index.js"), + })); + + async function waitForFile(filePath: string, timeoutMs = 60_000): Promise { + if (fs.existsSync(filePath)) return; + const start = performance.now(); + return await new Promise((resolve, reject) => { + const interval = setInterval(() => { + if (fs.existsSync(filePath)) { + clearInterval(interval); + resolve(); + } else if (performance.now() - start > timeoutMs) { + clearInterval(interval); + reject(new Error(`Timed out waiting for ${filePath} to exist`)); + } + }, 500); + }); + } + + return { + name: "wait-for-workspace-packages", + enforce: "pre", + async buildStart() { + const missing = packageDistEntries.filter((pkg) => !fs.existsSync(pkg.entry)); + if (missing.length === 0) return; + console.log(`Waiting for workspace packages to build: ${missing.map((pkg) => pkg.name).join(", ")}`); + await Promise.all(missing.map((pkg) => waitForFile(pkg.entry))); + console.log("All workspace packages are ready."); + }, + }; +} + +export default defineConfig(({ mode }) => { + const isVitest = mode === "test" || process.env.VITEST === "true"; + + return { + server: { + port: Number(`${process.env.NEXT_PUBLIC_STACK_PORT_PREFIX || "81"}43`), + fs: { + allow: [stackAuthRootPath], + }, + }, + resolve: { + dedupe: ["react", "react-dom"], + }, + ssr: { + noExternal: [/^@stackframe\//, /^@radix-ui\//], + }, + optimizeDeps: { + include: ["@stackframe/stack-shared", "@stackframe/stack-shared/config"], + }, + plugins: [ + ...(isVitest ? [] : [ + waitForWorkspacePackages(["@stackframe/tanstack-start", "@stackframe/stack-shared", "@stackframe/stack-ui"]), + watchNodeModules(["@stackframe/tanstack-start", "@stackframe/stack-shared", "@stackframe/stack-ui"]), + ]), + tsConfigPaths(), + ...(isVitest ? [] : [ + tanstackStart(), + nitro(), + ]), + viteReact(), + ], + }; +}); diff --git a/package.json b/package.json index 48f37dabc4..c65a24acb8 100644 --- a/package.json +++ b/package.json @@ -51,8 +51,8 @@ "db:migrate": "pnpm pre && pnpm run --filter=@stackframe/backend db:migrate", "fern": "pnpm pre && pnpm run --filter=@stackframe/docs fern", "dev:full": "pnpm pre && concurrently -k \"pnpm run generate-sdks:watch\" \"pnpm run generate-setup-prompt-docs:watch\" \"turbo run dev --concurrency 99999\"", - "dev": "pnpm pre && concurrently -k \"pnpm run generate-sdks:watch\" \"pnpm run generate-openapi-docs:watch\" \"pnpm run generate-setup-prompt-docs:watch\" \"turbo run dev --concurrency 99999 --filter=./apps/* --filter=@stackframe/docs-mintlify --filter=@stackframe/stack-docs --filter=./packages/* --filter=./examples/demo \"", - "dev:tui": "pnpm pre && (trap 'kill 0' EXIT; pnpm run generate-sdks:watch & pnpm run generate-openapi-docs:watch & pnpm run generate-setup-prompt-docs:watch & turbo run dev --ui tui --concurrency 99999 --filter=./apps/* --filter=@stackframe/stack-docs --filter=./packages/* --filter=./examples/demo)", + "dev": "pnpm pre && concurrently -k \"pnpm run generate-sdks:watch\" \"pnpm run generate-openapi-docs:watch\" \"pnpm run generate-setup-prompt-docs:watch\" \"turbo run dev --concurrency 99999 --filter=./apps/* --filter=@stackframe/docs-mintlify --filter=@stackframe/stack-docs --filter=./packages/* --filter=./examples/demo --filter=./examples/tanstack-start-demo \"", + "dev:tui": "pnpm pre && (trap 'kill 0' EXIT; pnpm run generate-sdks:watch & pnpm run generate-openapi-docs:watch & pnpm run generate-setup-prompt-docs:watch & turbo run dev --ui tui --concurrency 99999 --filter=./apps/* --filter=@stackframe/stack-docs --filter=./packages/* --filter=./examples/demo --filter=./examples/tanstack-start-demo)", "dev:inspect": "pnpm pre && STACK_BACKEND_DEV_EXTRA_ARGS=\"--inspect\" pnpm run dev", "dev:profile": "pnpm pre && STACK_BACKEND_DEV_EXTRA_ARGS=\"--experimental-cpu-prof\" pnpm run dev", "dev:basic": "pnpm pre && concurrently -k \"pnpm run generate-sdks:watch\" \"turbo run dev --concurrency 99999 --filter=@stackframe/backend --filter=@stackframe/mcp --filter=@stackframe/dashboard --filter=@stackframe/mock-oauth-server\"", diff --git a/packages/js/package.json b/packages/js/package.json index 2a434455ea..e3b4bf8160 100644 --- a/packages/js/package.json +++ b/packages/js/package.json @@ -85,4 +85,4 @@ "tsdown": "^0.20.3", "convex": "^1.27.0" } -} \ No newline at end of file +} diff --git a/packages/react/package.json b/packages/react/package.json index e18282d96a..3f6f0823cd 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -114,4 +114,4 @@ "tsdown": "^0.20.3", "convex": "^1.27.0" } -} \ No newline at end of file +} diff --git a/packages/stack-shared/src/apps/apps-config.ts b/packages/stack-shared/src/apps/apps-config.ts index 92a5cb9726..63db82190e 100644 --- a/packages/stack-shared/src/apps/apps-config.ts +++ b/packages/stack-shared/src/apps/apps-config.ts @@ -150,6 +150,12 @@ export const ALL_APPS = { tags: ["integration", "developers"], stage: "stable", }, + "tanstack-start": { + displayName: "TanStack Start", + subtitle: "Use Stack Auth in TanStack Start apps", + tags: ["integration", "developers"], + stage: "alpha", + }, "analytics": { displayName: "Analytics", subtitle: "View and explore analytics data", diff --git a/packages/stack/package.json b/packages/stack/package.json index 0f9ed3ba88..1b44f88b2f 100644 --- a/packages/stack/package.json +++ b/packages/stack/package.json @@ -122,4 +122,4 @@ "tsdown": "^0.20.3", "convex": "^1.27.0" } -} \ No newline at end of file +} diff --git a/packages/tanstack-start/package.json b/packages/tanstack-start/package.json new file mode 100644 index 0000000000..35b2441603 --- /dev/null +++ b/packages/tanstack-start/package.json @@ -0,0 +1,132 @@ +{ + "//": "THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY, INSTEAD EDIT THE CORRESPONDING FILE IN packages/template (FOR package.json FILES, PLEASE EDIT package-template.json)", + "name": "@stackframe/tanstack-start", + "version": "2.8.88", + "repository": "https://github.com/hexclave/stack-auth", + "sideEffects": false, + "main": "./dist/index.js", + "types": "./dist/index.d.ts", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": { + "default": "./dist/esm/index.js" + }, + "require": { + "default": "./dist/index.js" + } + }, + "./tanstack-start-server-context": { + "types": "./dist/tanstack-start-server-context.combined.d.ts", + "import": { + "browser": "./dist/esm/tanstack-start-server-context.default.js", + "default": "./dist/esm/tanstack-start-server-context.server.js" + }, + "require": { + "browser": "./dist/tanstack-start-server-context.default.js", + "default": "./dist/tanstack-start-server-context.server.js" + } + }, + "./convex.config": { + "types": "./dist/integrations/convex/component/convex.config.d.ts", + "import": { + "default": "./dist/esm/integrations/convex/component/convex.config.js" + }, + "require": { + "default": "./dist/integrations/convex/component/convex.config.js" + } + }, + "./convex-auth.config": { + "types": "./dist/integrations/convex.d.ts", + "import": { + "default": "./dist/esm/integrations/convex.js" + }, + "require": { + "default": "./dist/integrations/convex.js" + } + } + }, + "homepage": "https://stack-auth.com", + "scripts": { + "typecheck": "tsc --noEmit", + "clean": "rimraf dist && rimraf node_modules", + "lint": "eslint --ext .tsx,.ts .", + "build": "rimraf dist && pnpm run css && tsdown", + "dev": "concurrently -n \"build,codegen\" -k \"tsdown --watch\" \"pnpm run codegen:watch\"", + "codegen": "pnpm run css", + "codegen:watch": "pnpm run css:watch", + "css": "pnpm run css-tw && pnpm run css-sc", + "css:watch": "concurrently -n \"tw,sc\" -k \"pnpm run css-tw:watch\" \"pnpm run css-sc:watch\"", + "css-tw:watch": "tailwindcss -i ./src/global.css -o ./src/generated/tailwind.css --watch", + "css-tw": "tailwindcss -i ./src/global.css -o ./src/generated/tailwind.css", + "css-sc": "tsx ./scripts/process-css.ts ./src/generated/tailwind.css ./src/generated/global-css.ts", + "css-sc:watch": "chokidar --silent './src/generated/tailwind.css' -c 'pnpm run css-sc' --throttle 2000" + }, + "files": [ + "README.md", + "dist", + "CHANGELOG.md", + "LICENSE" + ], + "dependencies": { + "@ai-sdk/react": "^3.0.72", + "ai": "^6.0.0", + "@hookform/resolvers": "^5.2.2", + "@stripe/react-stripe-js": "^3.8.1", + "@stripe/stripe-js": "^7.7.0", + "@simplewebauthn/browser": "^13.2.2", + "@stackframe/stack-shared": "workspace:*", + "@stackframe/stack-ui": "workspace:*", + "@tanstack/react-table": "^8.21.3", + "browser-image-compression": "^2.0.2", + "color": "^5.0.3", + "cookie": "^1.1.1", + "jose": "^6.1.3", + "js-cookie": "^3.0.5", + "lucide-react": "^0.378.0", + "oauth4webapi": "^3.8.3", + "@oslojs/otp": "^1.1.0", + "qrcode": "^1.5.4", + "react-easy-crop": "^5.5.6", + "react-hook-form": "^7.70.0", + "tailwindcss-animate": "^1.0.7", + "rrweb": "^1.1.3", + "tsx": "^4.21.0", + "yup": "^1.7.1" + }, + "peerDependencies": { + "@types/react": ">=18.3.0", + "@tanstack/react-router": ">=1.100.0", + "@tanstack/react-start": ">=1.100.0", + "react": ">=18.3.0" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + } + }, + "devDependencies": { + "@quetzallabs/i18n": "^0.1.19", + "@types/color": "^3.0.6", + "@types/cookie": "^0.6.0", + "@types/js-cookie": "^3.0.6", + "@types/qrcode": "^1.5.5", + "@types/react-avatar-editor": "^13.0.3", + "autoprefixer": "^10.4.17", + "chokidar-cli": "^3.0.0", + "esbuild": "^0.20.2", + "i18next": "^23.14.0", + "i18next-parser": "^9.0.2", + "@tanstack/react-router": "^1.167.4", + "@tanstack/react-start": "^1.166.15", + "postcss": "^8.4.38", + "postcss-nested": "^6.0.1", + "react": "^19.0.0", + "@types/react-dom": "^19.0.0", + "react-dom": "^19.0.0", + "rimraf": "^6.1.2", + "tailwindcss": "^3.4.4", + "tsdown": "^0.20.3", + "convex": "^1.27.0" + } +} diff --git a/packages/template/package-template.json b/packages/template/package-template.json index 9a9e280152..01195b431b 100644 --- a/packages/template/package-template.json +++ b/packages/template/package-template.json @@ -5,6 +5,8 @@ "name": "@stackframe/js", "//": "ELSE_IF_PLATFORM next", "name": "@stackframe/stack", + "//": "ELSE_IF_PLATFORM tanstack-start", + "name": "@stackframe/tanstack-start", "//": "ELSE_IF_PLATFORM react", "name": "@stackframe/react", "//": "END_PLATFORM", @@ -26,6 +28,19 @@ "default": "./dist/index.js" } }, + "//": "IF_PLATFORM tanstack-start", + "./tanstack-start-server-context": { + "types": "./dist/tanstack-start-server-context.combined.d.ts", + "import": { + "browser": "./dist/esm/tanstack-start-server-context.default.js", + "default": "./dist/esm/tanstack-start-server-context.server.js" + }, + "require": { + "browser": "./dist/tanstack-start-server-context.default.js", + "default": "./dist/tanstack-start-server-context.server.js" + } + }, + "//": "END_PLATFORM", "./convex.config": { "types": "./dist/integrations/convex/component/convex.config.d.ts", "import": { @@ -131,6 +146,10 @@ "react-dom": ">=18.3.0", "next": ">=14.1 || >=15.0.0-canary.0 || >=15.0.0-rc.0", "//": "END_PLATFORM", + "//": "IF_PLATFORM tanstack-start", + "@tanstack/react-router": ">=1.100.0", + "@tanstack/react-start": ">=1.100.0", + "//": "END_PLATFORM", "react": ">=18.3.0" }, "//": "END_PLATFORM", @@ -160,6 +179,10 @@ "i18next-parser": "^9.0.2", "//": "NEXT_LINE_PLATFORM next", "next": "^14.2.35", + "//": "NEXT_LINE_PLATFORM template tanstack-start", + "@tanstack/react-router": "^1.167.4", + "//": "NEXT_LINE_PLATFORM template tanstack-start", + "@tanstack/react-start": "^1.166.15", "postcss": "^8.4.38", "postcss-nested": "^6.0.1", "react": "^19.0.0", diff --git a/packages/template/package.json b/packages/template/package.json index 739730b049..3a23e55b33 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -17,6 +17,17 @@ "default": "./dist/index.js" } }, + "./tanstack-start-server-context": { + "types": "./dist/tanstack-start-server-context.combined.d.ts", + "import": { + "browser": "./dist/esm/tanstack-start-server-context.default.js", + "default": "./dist/esm/tanstack-start-server-context.server.js" + }, + "require": { + "browser": "./dist/tanstack-start-server-context.default.js", + "default": "./dist/tanstack-start-server-context.server.js" + } + }, "./convex.config": { "types": "./dist/integrations/convex/component/convex.config.d.ts", "import": { @@ -94,6 +105,8 @@ "@types/react-dom": ">=18.3.0", "react-dom": ">=18.3.0", "next": ">=14.1 || >=15.0.0-canary.0 || >=15.0.0-rc.0", + "@tanstack/react-router": ">=1.100.0", + "@tanstack/react-start": ">=1.100.0", "react": ">=18.3.0" }, "peerDependenciesMeta": { @@ -117,6 +130,8 @@ "i18next": "^23.14.0", "i18next-parser": "^9.0.2", "next": "^14.2.35", + "@tanstack/react-router": "^1.167.4", + "@tanstack/react-start": "^1.166.15", "postcss": "^8.4.38", "postcss-nested": "^6.0.1", "react": "^19.0.0", @@ -127,4 +142,4 @@ "tsdown": "^0.20.3", "convex": "^1.27.0" } -} \ No newline at end of file +} diff --git a/packages/template/src/components-page/stack-handler-client.tsx b/packages/template/src/components-page/stack-handler-client.tsx index 55cfe9fe06..dcb929f96a 100644 --- a/packages/template/src/components-page/stack-handler-client.tsx +++ b/packages/template/src/components-page/stack-handler-client.tsx @@ -236,8 +236,8 @@ export function StackHandlerClient(props: BaseHandlerProps & Partial const navigate = stackApp.useNavigate(); const navigateRef = useRef(navigate); navigateRef.current = navigate; - const currentLocation = props.location ?? window.location.pathname; - const searchParamsSource = new URLSearchParams(window.location.search); + const currentLocation = props.location ?? (typeof window === "undefined" ? new URL(stackApp.urls.handler, placeholderOrigin).pathname : window.location.pathname); + const searchParamsSource = new URLSearchParams(typeof window === "undefined" ? "" : window.location.search); const redirectTargets: (string | undefined)[] = []; END_PLATFORM */ diff --git a/packages/template/src/lib/cookie.ts b/packages/template/src/lib/cookie.ts index 5d7b7a779c..7171731de3 100644 --- a/packages/template/src/lib/cookie.ts +++ b/packages/template/src/lib/cookie.ts @@ -1,6 +1,7 @@ import { cookies as rscCookies, headers as rscHeaders } from '@stackframe/stack-sc/force-react-server'; // THIS_LINE_PLATFORM next import { isBrowserLike } from '@stackframe/stack-shared/dist/utils/env'; import { StackAssertionError } from '@stackframe/stack-shared/dist/utils/errors'; +import * as tanstackStartServerContext from "@stackframe/tanstack-start/tanstack-start-server-context"; // THIS_LINE_PLATFORM tanstack-start import Cookies from "js-cookie"; import { calculatePKCECodeChallenge, generateRandomCodeVerifier, generateRandomState } from "oauth4webapi"; @@ -67,6 +68,49 @@ import { calculatePKCECodeChallenge, generateRandomCodeVerifier, generateRandomS type SetCookieOptions = { maxAge: number | "session", noOpIfServerComponent?: boolean, domain?: string, secure?: boolean }; type DeleteCookieOptions = { noOpIfServerComponent?: boolean, domain?: string }; +// IF_PLATFORM tanstack-start +let tanStackStartCookieHelperPromise: Promise | null = null; + +function getTanStackStartServerContext() { + const { + deleteCookie, + getCookie, + getCookies, + getRequestHeader, + setCookie, + } = tanstackStartServerContext; + if ( + deleteCookie == null + || getCookie == null + || getCookies == null + || getRequestHeader == null + || setCookie == null + ) { + throw new StackAssertionError("TanStack Start server context is only available during server rendering"); + } + return { + deleteCookie, + getCookie, + getCookies, + getRequestHeader, + setCookie, + }; +} + +declare global { + // eslint-disable-next-line @typescript-eslint/consistent-type-definitions + interface ImportMetaEnv { + SSR: boolean, + } + + // eslint-disable-next-line @typescript-eslint/consistent-type-definitions + interface ImportMeta { + readonly env: ImportMetaEnv, + } +} + +// END_PLATFORM + function ensureClient() { if (!isBrowserLike()) { throw new Error("cookieClient functions can only be called in a browser environment, yet window is undefined"); @@ -95,6 +139,16 @@ export async function createPlaceholderCookieHelper(): Promise { }; } +function requiresSecureAttribute(name: string): boolean { + return name.startsWith("__Host-"); +} + +function validateCookieOptions(name: string, options: DeleteCookieOptions | SetCookieOptions) { + if (requiresSecureAttribute(name) && options.domain !== undefined) { + throw new StackAssertionError("__Host- cookies must not specify a Domain attribute"); + } +} + export async function createCookieHelper(): Promise { if (isBrowserLike()) { return createBrowserCookieHelper(); @@ -104,12 +158,90 @@ export async function createCookieHelper(): Promise { await rscCookies(), await rscHeaders(), ); + // ELSE_IF_PLATFORM tanstack-start + if (import.meta.env.SSR) { + const cookieHelperPromise = tanStackStartCookieHelperPromise + ?? Promise.resolve(createTanStackStartCookieHelper(getTanStackStartServerContext())); + tanStackStartCookieHelperPromise = cookieHelperPromise; + return await cookieHelperPromise; + } + return await createPlaceholderCookieHelper(); // ELSE_PLATFORM return await createPlaceholderCookieHelper(); // END_PLATFORM } } +export function createCookieHelperSync(): CookieHelper { + if (isBrowserLike()) { + return createBrowserCookieHelper(); + } + function throwError(): never { + throw new StackAssertionError("Synchronous server cookie helpers are not available on this platform"); + } + return { + get: throwError, + getAll: throwError, + set: throwError, + setOrDelete: throwError, + delete: throwError, + }; +} + +// IF_PLATFORM tanstack-start +function determineSecureFromTanStackStartContext(api: ReturnType): boolean { + return api.getRequestHeader("x-forwarded-proto") === "https" + || (api.getCookie("stack-is-https") !== undefined); +} + +function refreshTanStackStartIsHttpsCookie(api: ReturnType) { + api.setCookie("stack-is-https", "true", { + secure: true, + maxAge: 60 * 60 * 24 * 365, + sameSite: "lax", + path: "/", + }); +} + +function createTanStackStartCookieHelper(api: ReturnType): CookieHelper { + const helper: CookieHelper = { + get: (name: string) => { + const all = helper.getAll(); + return all[name] ?? null; + }, + getAll: () => { + // set a helper cookie, see comment in `NextCookieHelper.set` below + refreshTanStackStartIsHttpsCookie(api); + return api.getCookies(); + }, + set: (name: string, value: string, options: SetCookieOptions) => { + validateCookieOptions(name, options); + api.setCookie(name, value, { + secure: requiresSecureAttribute(name) || (options.secure ?? determineSecureFromTanStackStartContext(api)), + maxAge: options.maxAge === "session" ? undefined : options.maxAge, + domain: options.domain, + sameSite: "lax", + path: "/", + }); + }, + setOrDelete: (name, value, options) => { + if (value === null) helper.delete(name, options); + else helper.set(name, value, options); + }, + delete: (name: string, options: DeleteCookieOptions) => { + validateCookieOptions(name, options); + const secure = requiresSecureAttribute(name) || determineSecureFromTanStackStartContext(api); + api.deleteCookie(name, { + secure, + domain: options.domain, + path: "/", + }); + }, + }; + return helper; +} +// END_PLATFORM + export function createBrowserCookieHelper(): CookieHelper { return { get: getCookieClient, @@ -166,6 +298,7 @@ function createNextCookieHelper( }, {} as Record); }, set: (name: string, value: string, options: SetCookieOptions) => { + validateCookieOptions(name, options); // Whenever the client is on HTTPS, we want to set the Secure flag on the cookie. // // This is not easy to find out on a Next.js server, so see the algorithm at the top of this file. @@ -177,10 +310,11 @@ function createNextCookieHelper( try { rscCookiesAwaited.set(name, value, { - secure: isSecureCookie, + secure: requiresSecureAttribute(name) || isSecureCookie, maxAge: options.maxAge === "session" ? undefined : options.maxAge, domain: options.domain, sameSite: "lax", + path: "/", }); } catch (e) { handleCookieError(e, options); @@ -195,10 +329,11 @@ function createNextCookieHelper( }, delete(name: string, options: DeleteCookieOptions) { try { + validateCookieOptions(name, options); if (options.domain !== undefined) { - rscCookiesAwaited.delete({ name, domain: options.domain }); + rscCookiesAwaited.delete({ name, domain: options.domain, path: "/" }); } else { - rscCookiesAwaited.delete(name); + rscCookiesAwaited.delete({ name, path: "/" }); } } catch (e) { handleCookieError(e, options); @@ -232,6 +367,10 @@ export async function isSecure(): Promise { } // IF_PLATFORM next return determineSecureFromServerContext(await rscCookies(), await rscHeaders()); + // ELSE_IF_PLATFORM tanstack-start + if (import.meta.env.SSR) { + return determineSecureFromTanStackStartContext(getTanStackStartServerContext()); + } // END_PLATFORM return false; } @@ -299,12 +438,14 @@ function _internalShouldSetPartitionedClient() { } function setCookieClientInternal(name: string, value: string, options: SetCookieOptions) { - const secure = options.secure ?? determineSecureFromClientContext(); + validateCookieOptions(name, options); + const secure = requiresSecureAttribute(name) || (options.secure ?? determineSecureFromClientContext()); const partitioned = shouldSetPartitionedClient(); Cookies.set(name, value, { expires: options.maxAge === "session" ? undefined : new Date(Date.now() + (options.maxAge) * 1000), domain: options.domain, secure, + path: "/", sameSite: "Lax", ...(partitioned ? { partitioned, @@ -314,11 +455,12 @@ function setCookieClientInternal(name: string, value: string, options: SetCookie } function deleteCookieClientInternal(name: string, options: DeleteCookieOptions) { + validateCookieOptions(name, options); for (const partitioned of [true, false]) { if (options.domain !== undefined) { - Cookies.remove(name, { domain: options.domain, secure: determineSecureFromClientContext(), partitioned }); + Cookies.remove(name, { domain: options.domain, secure: determineSecureFromClientContext(), partitioned, path: "/" }); } - Cookies.remove(name, { secure: determineSecureFromClientContext(), partitioned }); + Cookies.remove(name, { secure: requiresSecureAttribute(name) || determineSecureFromClientContext(), partitioned, path: "/" }); } } diff --git a/packages/template/src/lib/stack-app/apps/implementations/client-app-impl.ts b/packages/template/src/lib/stack-app/apps/implementations/client-app-impl.ts index 8eccf1644f..1f2133b5ea 100644 --- a/packages/template/src/lib/stack-app/apps/implementations/client-app-impl.ts +++ b/packages/template/src/lib/stack-app/apps/implementations/client-app-impl.ts @@ -36,6 +36,8 @@ import { BotChallengeExecutionFailedError, BotChallengeUserCancelledError, withB import type { TurnstileAction } from "@stackframe/stack-shared/dist/utils/turnstile"; import { isRelative } from "@stackframe/stack-shared/dist/utils/urls"; import { generateUuid } from "@stackframe/stack-shared/dist/utils/uuids"; +import * as tanstackStartServerContext from "@stackframe/tanstack-start/tanstack-start-server-context"; // THIS_LINE_PLATFORM tanstack-start +import * as TanStackRouter from "@tanstack/react-router"; // THIS_LINE_PLATFORM tanstack-start import * as cookie from "cookie"; import * as NextNavigationUnscrambled from "next/navigation"; // import the entire module to get around some static compiler warnings emitted by Next.js in some cases | THIS_LINE_PLATFORM next import React, { useCallback, useMemo } from "react"; // THIS_LINE_PLATFORM react-like @@ -152,6 +154,26 @@ function getHeaderValueFromRequestLikeHeaders(headers: RequestLike["headers"], n return null; } +// IF_PLATFORM tanstack-start +function getTanStackStartRequestHeader(name: string): string | null { + const { getRequestHeader } = tanstackStartServerContext; + if (getRequestHeader == null) { + throw new StackAssertionError("TanStack Start request headers are only available during server rendering"); + } + return getRequestHeader(name) ?? null; +} +// END_PLATFORM + +async function getServerRequestHost(): Promise { + // IF_PLATFORM next + return (await sc.headers?.())?.get("host") ?? null; + // ELSE_IF_PLATFORM tanstack-start + return getTanStackStartRequestHeader("host"); + // ELSE_PLATFORM + return null; + // END_PLATFORM +} + type StackClientAppImplConstructorOptionsResolved = StackClientAppConstructorOptions & { inheritsFrom?: undefined }; export class _StackClientAppImplIncomplete implements StackClientApp { @@ -608,6 +630,7 @@ export class _StackClientAppImplIncomplete { + // IF_PLATFORM tanstack-start + if (!isBrowserLike()) { + return this._getOrCreateTokenStore(use(createCookieHelper()), overrideTokenStoreInit); + } + // END_PLATFORM suspendIfSsr(); const cookieHelper = createBrowserCookieHelper(); const tokenStore = this._getOrCreateTokenStore(cookieHelper, overrideTokenStoreInit); @@ -2520,6 +2550,10 @@ export class _StackClientAppImplIncomplete router.push(to); // END_PLATFORM + // IF_PLATFORM tanstack-start + } else if (this._redirectMethod === "tanstack-start") { + return (to: string) => window.location.assign(to); + // END_PLATFORM } else { return (to: string) => { }; } @@ -2589,6 +2627,20 @@ export class _StackClientAppImplIncomplete>>(); export function useAsyncCache(cache: AsyncCache>, dependencies: D, caller: string): T { // we explicitly don't want to run this hook in SSR + // IF_PLATFORM tanstack-start + if (!isBrowserLike()) { + const result = use(cache.getOrWait(dependencies, "read-write")); + if (result.status === "error") { + throw result.error; + } + return result.data; + } + // ELSE_PLATFORM suspendIfSsr(caller); + // END_PLATFORM // on the dashboard, we do some perf monitoring for pre-fetching which should hook right in here const asyncCacheHooks: any[] = getGlobal("use-async-cache-execution-hooks") ?? []; @@ -220,7 +230,7 @@ export function useAsyncCache(cache: AsyncCache const promise = React.useSyncExternalStore( subscribe, getSnapshot, - () => throwErr(new Error("getServerSnapshot should never be called in useAsyncCache because we restrict to CSR earlier")) + getSnapshot, ); const result = use(promise); diff --git a/packages/template/src/lib/stack-app/common.ts b/packages/template/src/lib/stack-app/common.ts index 293f654ec3..a2f66cbe9d 100644 --- a/packages/template/src/lib/stack-app/common.ts +++ b/packages/template/src/lib/stack-app/common.ts @@ -30,6 +30,7 @@ export type EmailConfig = { export type RedirectMethod = "window" | "nextjs" // THIS_LINE_PLATFORM next + | "tanstack-start" // THIS_LINE_PLATFORM tanstack-start | "none" | { useNavigate: () => (to: string) => void, diff --git a/packages/template/src/providers/stack-provider.tsx b/packages/template/src/providers/stack-provider.tsx index cb985cd318..38f60c7699 100644 --- a/packages/template/src/providers/stack-provider.tsx +++ b/packages/template/src/providers/stack-provider.tsx @@ -31,6 +31,35 @@ function NextStackProvider({ ); } +// ELSE_IF_PLATFORM tanstack-start +function TanStackStartStackProvider({ + children, + app, + lang, + translationOverrides, +}: { + lang?: React.ComponentProps['lang'], + /** + * A mapping of English translations to translated equivalents. + * + * These will take priority over the translations from the language specified in the `lang` property. Note that the + * keys are case-sensitive. + */ + translationOverrides?: Record, + children: React.ReactNode, + // list all three types of apps even though server and admin are subclasses of client so it's clear that you can pass any + app: StackClientApp, +}) { + return ( + + + + {children} + + + + ); +} // ELSE_PLATFORM function ReactStackProvider({ children, @@ -63,6 +92,8 @@ function ReactStackProvider({ // IF_PLATFORM next export default NextStackProvider; -/* ELSE_PLATFORM +/* ELSE_IF_PLATFORM tanstack-start +export default TanStackStartStackProvider; +ELSE_PLATFORM export default ReactStackProvider; END_PLATFORM */ diff --git a/packages/template/src/tanstack-start-server-context.combined.ts b/packages/template/src/tanstack-start-server-context.combined.ts new file mode 100644 index 0000000000..1dfffe7aa3 --- /dev/null +++ b/packages/template/src/tanstack-start-server-context.combined.ts @@ -0,0 +1,8 @@ +import * as browserContext from "./tanstack-start-server-context.default"; +import * as serverContext from "./tanstack-start-server-context.server"; + +export declare const getCookie: typeof serverContext.getCookie | typeof browserContext.getCookie; +export declare const getCookies: typeof serverContext.getCookies | typeof browserContext.getCookies; +export declare const setCookie: typeof serverContext.setCookie | typeof browserContext.setCookie; +export declare const deleteCookie: typeof serverContext.deleteCookie | typeof browserContext.deleteCookie; +export declare const getRequestHeader: typeof serverContext.getRequestHeader | typeof browserContext.getRequestHeader; diff --git a/packages/template/src/tanstack-start-server-context.d.ts b/packages/template/src/tanstack-start-server-context.d.ts new file mode 100644 index 0000000000..e183d95ef6 --- /dev/null +++ b/packages/template/src/tanstack-start-server-context.d.ts @@ -0,0 +1,9 @@ +declare module "@stackframe/tanstack-start/tanstack-start-server-context" { + type TanStackStartServerContext = typeof import("@tanstack/react-start/server"); + + export const deleteCookie: TanStackStartServerContext["deleteCookie"] | undefined; + export const getCookie: TanStackStartServerContext["getCookie"] | undefined; + export const getCookies: TanStackStartServerContext["getCookies"] | undefined; + export const getRequestHeader: TanStackStartServerContext["getRequestHeader"] | undefined; + export const setCookie: TanStackStartServerContext["setCookie"] | undefined; +} diff --git a/packages/template/src/tanstack-start-server-context.default.ts b/packages/template/src/tanstack-start-server-context.default.ts new file mode 100644 index 0000000000..87afea609e --- /dev/null +++ b/packages/template/src/tanstack-start-server-context.default.ts @@ -0,0 +1,5 @@ +export const getCookie = undefined; +export const getCookies = undefined; +export const setCookie = undefined; +export const deleteCookie = undefined; +export const getRequestHeader = undefined; diff --git a/packages/template/src/tanstack-start-server-context.server.ts b/packages/template/src/tanstack-start-server-context.server.ts new file mode 100644 index 0000000000..9ca5b20179 --- /dev/null +++ b/packages/template/src/tanstack-start-server-context.server.ts @@ -0,0 +1,7 @@ +export { + deleteCookie, + getCookie, + getCookies, + getRequestHeader, + setCookie, +} from "@tanstack/react-start/server"; diff --git a/packages/template/vitest.config.ts b/packages/template/vitest.config.ts index f505050f79..39f0ccca27 100644 --- a/packages/template/vitest.config.ts +++ b/packages/template/vitest.config.ts @@ -3,6 +3,8 @@ import { fileURLToPath } from 'node:url' import { defineConfig, mergeConfig } from 'vitest/config' import sharedConfig from '../../vitest.shared' +const tanstackStartServerContextStub = fileURLToPath(new URL('./src/tanstack-start-server-context.default.ts', import.meta.url)) // THIS_LINE_PLATFORM template + const SOURCE_FILE_PATTERN = /\.(jsx?|tsx?)$/; const CLIENT_VERSION_SENTINEL = "STACK_COMPILE_TIME_CLIENT_PACKAGE_VERSION_SENTINEL"; const ENFORCE_PRE: "pre" = "pre"; @@ -45,6 +47,11 @@ const replaceCompileTimeClientVersion = () => { export default mergeConfig( sharedConfig, defineConfig({ + resolve: { + alias: { + "@stackframe/tanstack-start/tanstack-start-server-context": tanstackStartServerContextStub, // THIS_LINE_PLATFORM template + }, + }, plugins: [replaceCompileTimeClientVersion()], }), ) diff --git a/scripts/generate-sdks.ts b/scripts/generate-sdks.ts index ad6eed7ec6..864ccbcb70 100644 --- a/scripts/generate-sdks.ts +++ b/scripts/generate-sdks.ts @@ -54,7 +54,7 @@ function generateFromTemplate(options: { // If the resulting file is package.json, add a comment field to the JSON. if (path.basename(relativePath) === "package.json") { const jsonObj = JSON.parse(newContent); - newContent = JSON.stringify({ "//": COMMENT_LINE, ...jsonObj }, null, 2); + newContent = JSON.stringify({ "//": COMMENT_LINE, ...jsonObj }, null, 2) + "\n"; } return newContent; @@ -109,7 +109,7 @@ function processPackageJson(path: string, content: string) { } catch (error) { throw new Error(`Failed to parse package.json at ${path}`, { cause: error }); } - return JSON.stringify({ "//": `${COMMENT_LINE} (FOR package.json FILES, PLEASE EDIT package-template.json)`, ...jsonObj }, null, 2); + return JSON.stringify({ "//": `${COMMENT_LINE} (FOR package.json FILES, PLEASE EDIT package-template.json)`, ...jsonObj }, null, 2) + "\n"; } function baseEditFn(options: { @@ -131,6 +131,14 @@ function baseEditFn(options: { withGeneratorLock(async () => { const baseDir = path.resolve(__dirname, "..", "packages"); const srcDir = path.resolve(baseDir, "template"); + const tanstackStartOnlyTemplateFiles = new Set([ + "src/tanstack-start-server-context.combined.ts", + "src/tanstack-start-server-context.default.ts", + "src/tanstack-start-server-context.server.ts", + ]); + const templateOnlyFiles = new Set([ + "src/tanstack-start-server-context.d.ts", + ]); // Copy package-template.json to package.json in the template, // applying macros and adding a comment field. @@ -168,7 +176,9 @@ withGeneratorLock(async () => { "src/global.d.ts", ]; - if (ignores.some((ignorePath) => relativePath.startsWith(ignorePath)) || relativePath.endsWith(".tsx")) { + if (tanstackStartOnlyTemplateFiles.has(relativePath) || templateOnlyFiles.has(relativePath)) { + return false; + } else if (ignores.some((ignorePath) => relativePath.startsWith(ignorePath)) || relativePath.endsWith(".tsx")) { return false; } else { return true; @@ -182,6 +192,7 @@ withGeneratorLock(async () => { editFn: (relativePath, content) => { return baseEditFn({ relativePath, content, platforms: PLATFORMS["next"] }); }, + filterFn: (relativePath) => !tanstackStartOnlyTemplateFiles.has(relativePath), }); generateFromTemplate({ @@ -190,6 +201,16 @@ withGeneratorLock(async () => { editFn: (relativePath, content) => { return baseEditFn({ relativePath, content, platforms: PLATFORMS["react"] }); }, + filterFn: (relativePath) => !tanstackStartOnlyTemplateFiles.has(relativePath), + }); + + generateFromTemplate({ + src: srcDir, + dest: path.resolve(baseDir, "tanstack-start"), + editFn: (relativePath, content) => { + return baseEditFn({ relativePath, content, platforms: PLATFORMS["tanstack-start"] }); + }, + filterFn: (relativePath) => !templateOnlyFiles.has(relativePath), }); }).catch((error) => { console.error(error); diff --git a/scripts/utils.ts b/scripts/utils.ts index 3e33e5428b..72e05c995a 100644 --- a/scripts/utils.ts +++ b/scripts/utils.ts @@ -9,7 +9,8 @@ export const PLATFORMS = { "next": ['next', 'react-like', 'js-like'], "js": ['js', 'js-like'], "react": ['react', 'react-like', 'js-like'], - "template": ['template', 'react-like', 'next', 'js', 'js-like', 'python-like'], + "tanstack-start": ['tanstack-start', 'react', 'react-like', 'js-like'], + "template": ['template', 'react-like', 'next', 'js', 'js-like', 'python-like', 'tanstack-start'], "python": ['python', 'python-like'], } diff --git a/turbo.json b/turbo.json index 6e882d284d..5a392d98cc 100644 --- a/turbo.json +++ b/turbo.json @@ -4,6 +4,7 @@ "STACK_*", "CRON_SECRET", "NEXT_PUBLIC_*", + "VITE_*", "NEXT_PUBLIC_SENTRY_*", "SENTRY_*", "VERCEL_GIT_COMMIT_SHA",