This website requires JavaScript.
About
Status
₊˚⊹Discord
Explore
Register
Sign in
Reference in a new issue
Blame
Copy permalink
Reference in a new issue
Copy permalink
TanStack
/
router
Star
0
Fork
You've already forked router
0
mirror of
https://github.com/TanStack/router.git
synced
2026-11-16 19:38:07 +00:00
Code
Issues
Releases
Packages
Activity
codex/memory-flag-bytecode-only
router
/
docs
/
start
/
framework
/
react
/
guide
/
authentication-overview.md
243 lines
9.2 KiB
Raw
Permalink
Normal View
History
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: clarify auth data boundaries (#7537)
2026-06-03 12:48:48 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: clarify auth data boundaries (#7537)
2026-06-03 12:48:48 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs(skills): address 8 agent failure modes from user feedback (#7314) * docs(skills): address 8 agent failure modes from external feedback Adds new start-core/auth-server-primitives skill (sessions, cookies, OAuth+PKCE, password-reset enumeration defense, CSRF, rate limiting, session rotation) and updates 8 existing skills + matching docs to fix patterns where agents produce insecure or wrong-framework output. Skill changes: - new: start-core/auth-server-primitives (server half of auth) - router-core/auth-and-guards: route guard != RPC guard - start-core/server-functions: wrong import path, RPC auth required, Cache-Control public is a cross-tenant leak, wrong-framework patterns - start-core/middleware: wrong import path, sendContext shape vs access (3-layer wrong/still-wrong/correct), authMiddleware framing - start-core/execution-model: file markers (server-only/client-only), module-level process.env is undefined under Worker SSR - start-core/deployment: cloudflare env-at-request-time - router-core/ssr: wrong file structures (next.js, react-router-dom) - router-core/type-safety: wrong-framework imports + structures Docs updated to mirror each skill change so source-of-truth and the intent-indexed skill stay in sync. New authentication-server-primitives guide is the long-form companion to the new skill. intent validate: 30 skill files pass (was 29). * ci: apply automated fixes * docs(skills): address coderabbit review feedback - Fix internal docs links to use correct relative paths instead of an absolute /start/latest/... URL and missing one ../ segment - Remove blank line inside auth-and-guards blockquote (markdownlint MD028) - Restore overload pattern in type-safety ValidateNavigateOptions and ValidateRedirectOptions examples; the casts I had introduced stripped generic context and contradicted the skill's own no-cast rule - Add db.sessions.revokeAllForUser before create in login rotation snippets so the example matches the prose - Soften useServerFn guidance: it's required only when the server function throws redirect/notFound; plain-data calls work directly and via useMutation/useQuery * ci: apply automated fixes * docs(skills): compress type-safety to stay under 500-line cap Prettier's autofix expanded my single-line overload signatures across multiple lines, pushing the file over the 500-line limit. Drop the redundant fetchOrRedirect example (same pattern as useDelayedNavigate) and describe ValidateRedirectOptions usage in prose instead. * docs(skills): CSRF origin check should compare full origin, not host alone Comparing only new URL(origin).host against APP_HOST silently accepts a mismatched scheme — http://example.com would pass a check meant for https://example.com. Compare the full origin (scheme + host + port) against APP_ORIGIN instead. Same fix in skill and docs. * docs(skills): make useDelayedNavigate callback truly return void The callback returned the result of setTimeout (a timer handle), not void as the public overload's return type implied. Wrap in a block so the example matches the declared return type. Skipped the related nitpick to add a separate redirect example — the existing prose already describes the same overload pattern, and a duplicate example would push the file close to the 500-line cap that prettier autofix has been bumping us against. * docs(skills): fix two real bugs in auth-server-primitives examples 1. Cookie parser truncated values containing '='. Signed cookies, JWTs, and base64-padded values all use '='. Use indexOf to split on the FIRST '=' only. 2. Login example short-circuited verifyPasswordHash on user-not-found, contradicting the prose's "same time, same error" claim — the no-user branch returned instantly while wrong-password spent ~100ms hashing, leaking account existence over the wire. Always verify against a hash; use a precomputed DUMMY_PASSWORD_HASH when the user is missing, then combine with the user-exists bit for the final ok. Same fixes in the SKILL.md and the docs companion. * docs(skills): address manuel's review on react-specific guides - middleware.md, server-functions.md: drop cross-framework <framework> placeholders; this is the React-specific guide, just say @tanstack/react-start - execution-model.md: drop the same trailing line about solid-start / vue-start paths - hosting.md: remove the Cloudflare env-handling subsection — the general per-request rule lives in environment-variables.md and doesn't need to be repeated under a specific host - environment-variables.md: mention the cloudflare:workers env binding as the canonical Cloudflare way to read env (including module scope), per Manuel's link to the Cloudflare docs - deployment skill: same upgrade — show the cloudflare:workers env pattern alongside the per-request handler approach * docs(skills): drop redundant server-only marker in session example The file already imports from @tanstack/react-start/server, which is on import protection's default client-deny specifier list. The side-effect marker is redundant — drop it. Same fix in skill and docs. * docs(skills): drop wrong-import-path mistakes — TS already catches them Manuel pointed out that TypeScript catches both common wrong paths: '@tanstack/react-router' has no exported member createServerFn / createMiddleware, and '@tanstack/start' is "Cannot find module". Skill space is precious; the items don't earn their slot if tsc handles them. Removed: - Common Mistake "Wrong import path" from server-functions and middleware skills (renumbered the remaining mistakes) - The matching top-of-file CRITICAL line in both skills - The "Import path" callouts in the middleware and server-functions docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-05-02 23:11:30 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs(skills): address 8 agent failure modes from user feedback (#7314) * docs(skills): address 8 agent failure modes from external feedback Adds new start-core/auth-server-primitives skill (sessions, cookies, OAuth+PKCE, password-reset enumeration defense, CSRF, rate limiting, session rotation) and updates 8 existing skills + matching docs to fix patterns where agents produce insecure or wrong-framework output. Skill changes: - new: start-core/auth-server-primitives (server half of auth) - router-core/auth-and-guards: route guard != RPC guard - start-core/server-functions: wrong import path, RPC auth required, Cache-Control public is a cross-tenant leak, wrong-framework patterns - start-core/middleware: wrong import path, sendContext shape vs access (3-layer wrong/still-wrong/correct), authMiddleware framing - start-core/execution-model: file markers (server-only/client-only), module-level process.env is undefined under Worker SSR - start-core/deployment: cloudflare env-at-request-time - router-core/ssr: wrong file structures (next.js, react-router-dom) - router-core/type-safety: wrong-framework imports + structures Docs updated to mirror each skill change so source-of-truth and the intent-indexed skill stay in sync. New authentication-server-primitives guide is the long-form companion to the new skill. intent validate: 30 skill files pass (was 29). * ci: apply automated fixes * docs(skills): address coderabbit review feedback - Fix internal docs links to use correct relative paths instead of an absolute /start/latest/... URL and missing one ../ segment - Remove blank line inside auth-and-guards blockquote (markdownlint MD028) - Restore overload pattern in type-safety ValidateNavigateOptions and ValidateRedirectOptions examples; the casts I had introduced stripped generic context and contradicted the skill's own no-cast rule - Add db.sessions.revokeAllForUser before create in login rotation snippets so the example matches the prose - Soften useServerFn guidance: it's required only when the server function throws redirect/notFound; plain-data calls work directly and via useMutation/useQuery * ci: apply automated fixes * docs(skills): compress type-safety to stay under 500-line cap Prettier's autofix expanded my single-line overload signatures across multiple lines, pushing the file over the 500-line limit. Drop the redundant fetchOrRedirect example (same pattern as useDelayedNavigate) and describe ValidateRedirectOptions usage in prose instead. * docs(skills): CSRF origin check should compare full origin, not host alone Comparing only new URL(origin).host against APP_HOST silently accepts a mismatched scheme — http://example.com would pass a check meant for https://example.com. Compare the full origin (scheme + host + port) against APP_ORIGIN instead. Same fix in skill and docs. * docs(skills): make useDelayedNavigate callback truly return void The callback returned the result of setTimeout (a timer handle), not void as the public overload's return type implied. Wrap in a block so the example matches the declared return type. Skipped the related nitpick to add a separate redirect example — the existing prose already describes the same overload pattern, and a duplicate example would push the file close to the 500-line cap that prettier autofix has been bumping us against. * docs(skills): fix two real bugs in auth-server-primitives examples 1. Cookie parser truncated values containing '='. Signed cookies, JWTs, and base64-padded values all use '='. Use indexOf to split on the FIRST '=' only. 2. Login example short-circuited verifyPasswordHash on user-not-found, contradicting the prose's "same time, same error" claim — the no-user branch returned instantly while wrong-password spent ~100ms hashing, leaking account existence over the wire. Always verify against a hash; use a precomputed DUMMY_PASSWORD_HASH when the user is missing, then combine with the user-exists bit for the final ok. Same fixes in the SKILL.md and the docs companion. * docs(skills): address manuel's review on react-specific guides - middleware.md, server-functions.md: drop cross-framework <framework> placeholders; this is the React-specific guide, just say @tanstack/react-start - execution-model.md: drop the same trailing line about solid-start / vue-start paths - hosting.md: remove the Cloudflare env-handling subsection — the general per-request rule lives in environment-variables.md and doesn't need to be repeated under a specific host - environment-variables.md: mention the cloudflare:workers env binding as the canonical Cloudflare way to read env (including module scope), per Manuel's link to the Cloudflare docs - deployment skill: same upgrade — show the cloudflare:workers env pattern alongside the per-request handler approach * docs(skills): drop redundant server-only marker in session example The file already imports from @tanstack/react-start/server, which is on import protection's default client-deny specifier list. The side-effect marker is redundant — drop it. Same fix in skill and docs. * docs(skills): drop wrong-import-path mistakes — TS already catches them Manuel pointed out that TypeScript catches both common wrong paths: '@tanstack/react-router' has no exported member createServerFn / createMiddleware, and '@tanstack/start' is "Cannot find module". Skill space is precious; the items don't earn their slot if tsc handles them. Removed: - Common Mistake "Wrong import path" from server-functions and middleware skills (renumbered the remaining mistakes) - The matching top-of-file CRITICAL line in both skills - The "Import path" callouts in the middleware and server-functions docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-05-02 23:11:30 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
fix workos logo
2026-01-06 11:11:49 -07:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: clarify auth data boundaries (#7537)
2026-06-03 12:48:48 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: clarify auth data boundaries (#7537)
2026-06-03 12:48:48 -06:00
rename inputValidator to validator (#7566) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-06-06 23:05:56 +02:00
docs: clarify auth data boundaries (#7537)
2026-06-03 12:48:48 -06:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: correct local relative links (#6027) * docs: correct local relative links * Missing fixes * Fix lockfile
2025-12-05 22:39:47 +11:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs(skills): address 8 agent failure modes from user feedback (#7314) * docs(skills): address 8 agent failure modes from external feedback Adds new start-core/auth-server-primitives skill (sessions, cookies, OAuth+PKCE, password-reset enumeration defense, CSRF, rate limiting, session rotation) and updates 8 existing skills + matching docs to fix patterns where agents produce insecure or wrong-framework output. Skill changes: - new: start-core/auth-server-primitives (server half of auth) - router-core/auth-and-guards: route guard != RPC guard - start-core/server-functions: wrong import path, RPC auth required, Cache-Control public is a cross-tenant leak, wrong-framework patterns - start-core/middleware: wrong import path, sendContext shape vs access (3-layer wrong/still-wrong/correct), authMiddleware framing - start-core/execution-model: file markers (server-only/client-only), module-level process.env is undefined under Worker SSR - start-core/deployment: cloudflare env-at-request-time - router-core/ssr: wrong file structures (next.js, react-router-dom) - router-core/type-safety: wrong-framework imports + structures Docs updated to mirror each skill change so source-of-truth and the intent-indexed skill stay in sync. New authentication-server-primitives guide is the long-form companion to the new skill. intent validate: 30 skill files pass (was 29). * ci: apply automated fixes * docs(skills): address coderabbit review feedback - Fix internal docs links to use correct relative paths instead of an absolute /start/latest/... URL and missing one ../ segment - Remove blank line inside auth-and-guards blockquote (markdownlint MD028) - Restore overload pattern in type-safety ValidateNavigateOptions and ValidateRedirectOptions examples; the casts I had introduced stripped generic context and contradicted the skill's own no-cast rule - Add db.sessions.revokeAllForUser before create in login rotation snippets so the example matches the prose - Soften useServerFn guidance: it's required only when the server function throws redirect/notFound; plain-data calls work directly and via useMutation/useQuery * ci: apply automated fixes * docs(skills): compress type-safety to stay under 500-line cap Prettier's autofix expanded my single-line overload signatures across multiple lines, pushing the file over the 500-line limit. Drop the redundant fetchOrRedirect example (same pattern as useDelayedNavigate) and describe ValidateRedirectOptions usage in prose instead. * docs(skills): CSRF origin check should compare full origin, not host alone Comparing only new URL(origin).host against APP_HOST silently accepts a mismatched scheme — http://example.com would pass a check meant for https://example.com. Compare the full origin (scheme + host + port) against APP_ORIGIN instead. Same fix in skill and docs. * docs(skills): make useDelayedNavigate callback truly return void The callback returned the result of setTimeout (a timer handle), not void as the public overload's return type implied. Wrap in a block so the example matches the declared return type. Skipped the related nitpick to add a separate redirect example — the existing prose already describes the same overload pattern, and a duplicate example would push the file close to the 500-line cap that prettier autofix has been bumping us against. * docs(skills): fix two real bugs in auth-server-primitives examples 1. Cookie parser truncated values containing '='. Signed cookies, JWTs, and base64-padded values all use '='. Use indexOf to split on the FIRST '=' only. 2. Login example short-circuited verifyPasswordHash on user-not-found, contradicting the prose's "same time, same error" claim — the no-user branch returned instantly while wrong-password spent ~100ms hashing, leaking account existence over the wire. Always verify against a hash; use a precomputed DUMMY_PASSWORD_HASH when the user is missing, then combine with the user-exists bit for the final ok. Same fixes in the SKILL.md and the docs companion. * docs(skills): address manuel's review on react-specific guides - middleware.md, server-functions.md: drop cross-framework <framework> placeholders; this is the React-specific guide, just say @tanstack/react-start - execution-model.md: drop the same trailing line about solid-start / vue-start paths - hosting.md: remove the Cloudflare env-handling subsection — the general per-request rule lives in environment-variables.md and doesn't need to be repeated under a specific host - environment-variables.md: mention the cloudflare:workers env binding as the canonical Cloudflare way to read env (including module scope), per Manuel's link to the Cloudflare docs - deployment skill: same upgrade — show the cloudflare:workers env pattern alongside the per-request handler approach * docs(skills): drop redundant server-only marker in session example The file already imports from @tanstack/react-start/server, which is on import protection's default client-deny specifier list. The side-effect marker is redundant — drop it. Same fix in skill and docs. * docs(skills): drop wrong-import-path mistakes — TS already catches them Manuel pointed out that TypeScript catches both common wrong paths: '@tanstack/react-router' has no exported member createServerFn / createMiddleware, and '@tanstack/start' is "Cannot find module". Skill space is precious; the items don't earn their slot if tsc handles them. Removed: - Common Mistake "Wrong import path" from server-functions and middleware skills (renumbered the remaining mistakes) - The matching top-of-file CRITICAL line in both skills - The "Import path" callouts in the middleware and server-functions docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-05-02 23:11:30 -06:00
docs: correct local relative links (#6027) * docs: correct local relative links * Missing fixes * Fix lockfile
2025-12-05 22:39:47 +11:00
docs(start): fix authenticated routes doc URL (#7214)
2026-04-17 23:09:32 +05:30
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs: correct local relative links (#6027) * docs: correct local relative links * Missing fixes * Fix lockfile
2025-12-05 22:39:47 +11:00
docs: Start overhaul # Conflicts: # docs/start/config.json # docs/start/framework/react/hosting.md # docs/start/framework/react/learn-the-basics.md # docs/start/framework/react/middleware.md # docs/start/framework/react/overview.md # docs/start/framework/react/server-functions.md # docs/start/framework/react/server-routes.md # docs/start/framework/solid/build-from-scratch.md # docs/start/framework/solid/hosting.md # docs/start/framework/solid/learn-the-basics.md # docs/start/framework/solid/selective-ssr.md
2025-09-23 13:33:51 -06:00
docs(start): fix broken links (#5197) corrects broken links in the start docs <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated numerous cross‑reference links across React start guides (authentication, execution model, server functions, environment variables, middleware, router guides, migration) to point to correct locations. * Hosting guide: added a Netlify section with setup example; updated Cloudflare Workers and Railway/Node.js anchors for clarity. * Authentication docs: minor formatting tweaks. * Server routes: removed merge conflict markers and cleaned content. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-24 03:18:36 +02:00