docs: add jsdoc comments to plugin/generator types

.github/labeler.yml

@@ -14,26 +14,12 @@
   - 'packages/react-router-with-query/**/*'
 'package: react-start':
   - 'packages/react-start/**/*'
-'package: start-api-routes':
-  - 'packages/start-api-routes/**/*'
 'package: react-start-client':
   - 'packages/react-start-client/**/*'
-'package: react-start-config':
-  - 'packages/react-start-config/**/*'
 'package: react-start-plugin':
   - 'packages/react-start-plugin/**/*'
-'package: react-start-router-manifest':
-  - 'packages/react-start-router-manifest/**/*'
 'package: react-start-server':
   - 'packages/react-start-server/**/*'
-'package: start-server-functions-client':
-  - 'packages/start-server-functions-client/**/*'
-'package: start-server-functions-fetcher':
-  - 'packages/start-server-functions-fetcher/**/*'
-'package: start-server-functions-handler':
-  - 'packages/start-server-functions-handler/**/*'
-'package: start-server-functions-ssr':
-  - 'packages/start-server-functions-ssr/**/*'
 'package: router-cli':
   - 'packages/router-cli/**/*'
 'package: router-core':
@@ -60,18 +46,20 @@
   - 'packages/solid-start/**/*'
 'package: solid-start-client':
   - 'packages/solid-start-client/**/*'
-'package: solid-start-config':
-  - 'packages/solid-start-config/**/*'
 'package: solid-start-plugin':
   - 'packages/solid-start-plugin/**/*'
-'package: solid-start-router-manifest':
-  - 'packages/solid-start-router-manifest/**/*'
 'package: solid-start-server':
   - 'packages/solid-start-server/**/*'
-'package: start':
-  - 'packages/start/**/*'
-'package: start-config':
-  - 'packages/start-config/**/*'
+'package: start-client-core':
+  - 'packages/start-client-core/**/*'
+'package: start-plugin-core':
+  - 'packages/start-plugin-core/**/*'
+'package: start-server-core':
+  - 'packages/start-server-core/**/*'
+'package: start-server-functions-client':
+  - 'packages/start-server-functions-client/**/*'
+'package: start-server-functions-fetcher':
+  - 'packages/start-server-functions-fetcher/**/*'
 'package: start-server-functions-server':
   - 'packages/start-server-functions-server/**/*'
 'package: valibot-adapter':

.gitignore

@@ -60,20 +60,18 @@ nx-cloud.env
 
 gpt/db.json
 
-app.config.timestamp-*
+vite.config.timestamp-*
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
-app.config.js.timestamp-*
-app.config.ts.timestamp-*
 
-app.config.timestamp_*
+vite.config.timestamp_*
 vite.config.js.timestamp_*
 vite.config.ts.timestamp_*
-app.config.js.timestamp_*
-app.config.ts.timestamp_*
+
 .idea
 *.vitest-temp.json
 
 # Handling VSCode settings
 /.vscode/
-!/examples/react/**/.vscode/settings.json
+!/examples/react/**/.vscode/settings.json
+**/.tanstack-start/build

.prettierignore

@@ -7,7 +7,6 @@
 pnpm-lock.yaml
 **/snapshots
 **/.vercel
-**/.vinxi
 **/.output
 **/node_modules
 node_modules

README.md

@@ -87,4 +87,4 @@ Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [React Quer
 
 To run example React projects with Tanstack Router, see [CONTRIBUTING.md](./CONTRIBUTING.md)
 
-<!-- Use the force, Luke!!!! -->
+<!-- Use the force, Luke!!! -->

docs/router/api/file-based-routing.md

@@ -132,19 +132,6 @@ By default, this value is set to `false`.
 > [!TIP]
 > You should ignore the path of your generated route tree file from your linter and formatter to avoid conflicts.
 
-### `apiBase`
-
-As a framework, [TanStack Start](/start) supports the concept of API routes. This option configures the base path for API routes.
-
-By default, this value is set to `/api`.
-
-This means that all API routes will be prefixed with `/api`.
-
-This configuration value is only useful if you are using TanStack Start.
-
-> [!IMPORTANT]
-> This default value may conflict with your own project's routing if you planned on having a normal route with the same base path. You can change this value to avoid conflicts.
-
 ### `autoCodeSplitting`
 
 This feature is only available is you are using the TanStack Router Bundler Plugin.

docs/router/eslint/create-route-property-order.md

@@ -29,7 +29,7 @@ Examples of **incorrect** code for this rule:
 /* eslint "@tanstack/router/create-route-property-order": "warn" */
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/foo/bar/$id')({
+export const Route = createFileRoute({
   loader: async ({context}) => {
     await context.queryClient.ensureQueryData(getQueryOptions(context.hello)),
   },
@@ -43,7 +43,7 @@ Examples of **correct** code for this rule:
 /* eslint "@tanstack/router/create-route-property-order": "warn" */
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/foo/bar/$id')({
+export const Route = createFileRoute({
   beforeLoad: () => ({hello: 'world'}),
   loader: async ({context}) => {
     await context.queryClient.ensureQueryData(getQueryOptions(context.hello)),

docs/router/framework/react/api/router/createFileRouteFunction.md

@@ -26,7 +26,7 @@ A new function that accepts a single argument of type [`RouteOptions`](./RouteOp
 ```tsx
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/')({
+export const Route = createFileRoute({
   loader: () => {
     return 'Hello World'
   },

docs/router/framework/react/api/router/retainSearchParamsFunction.md

@@ -39,7 +39,7 @@ const searchSchema = z.object({
   two: z.string().optional(),
 })
 
-export const Route = createFileRoute('/hello')({
+export const Route = createFileRoute({
   validateSearch: zodValidator(searchSchema),
   search: {
     middlewares: [retainSearchParams(true)],

docs/router/framework/react/api/router/stripSearchParamsFunction.md

@@ -30,7 +30,7 @@ const searchSchema = z.object({
   two: z.string().default(defaultValues.two),
 })
 
-export const Route = createFileRoute('/hello')({
+export const Route = createFileRoute({
   validateSearch: zodValidator(searchSchema),
   search: {
     // strip default values
@@ -68,7 +68,7 @@ const searchSchema = z.object({
   two: z.string().default('xyz'),
 })
 
-export const Route = createFileRoute('/hello')({
+export const Route = createFileRoute({
   validateSearch: zodValidator(searchSchema),
   search: {
     // remove all search params

docs/router/framework/react/comparison.md

@@ -10,8 +10,8 @@ Before you commit to a new tool, it's always nice to know how it stacks up again
 Feature/Capability Key:
 
 - ✅ 1st-class, built-in, and ready to use with no added configuration or code
-- 🔵 Supported via addon package
 - 🟡 Partial Support (on a scale of 5)
+- 🟠 Supported via addon/community package
 - 🔶 Possible, but requires custom code/implementation/casting
 - 🛑 Not officially supported
 
@@ -39,9 +39,9 @@ Feature/Capability Key:
 | Ranked Routes                                  | ✅                                               | ✅                                                    | ✅                                                    |
 | Active Link Customization                      | ✅                                               | ✅                                                    | ✅                                                    |
 | Optimistic UI                                  | ✅                                               | ✅                                                    | 🔶                                                    |
-| Typesafe Absolute + Relative Navigation        | ✅                                               | 🛑                                                    | 🛑                                                    |
+| Typesafe Absolute + Relative Navigation        | ✅                                               | 🟡 (1/5 via `buildHref` util)                         | 🟠 (IDE plugin)                                       |
 | Route Mount/Transition/Unmount Events          | ✅                                               | 🛑                                                    | 🛑                                                    |
-| Devtools                                       | ✅                                               | 🛑                                                    | 🛑                                                    |
+| Devtools                                       | ✅                                               | 🟠                                                    | 🛑                                                    |
 | Basic Search Params                            | ✅                                               | ✅                                                    | ✅                                                    |
 | Search Param Hooks                             | ✅                                               | ✅                                                    | ✅                                                    |
 | `<Link/>`/`useNavigate` Search Param API       | ✅                                               | 🟡 (search-string only via the `to`/`search` options) | 🟡 (search-string only via the `to`/`search` options) |
@@ -54,7 +54,7 @@ Feature/Capability Key:
 | Suspense Route Elements                        | ✅                                               | ✅                                                    | ✅                                                    |
 | Route Error Elements                           | ✅                                               | ✅                                                    | ✅                                                    |
 | Route Pending Elements                         | ✅                                               | ✅                                                    | ✅                                                    |
-| `<Block>`/`useBlocker`                         | ✅                                               | 🔶                                                    | ❓                                                    |
+| `<Block>`/`useBlocker`                         | ✅                                               | 🔶 (no hard reloads or cross-origin navigation)       | 🛑                                                    |
 | Deferred Primitives                            | ✅                                               | ✅                                                    | ✅                                                    |
 | Navigation Scroll Restoration                  | ✅                                               | ✅                                                    | ❓                                                    |
 | ElementScroll Restoration                      | ✅                                               | 🛑                                                    | 🛑                                                    |
@@ -72,7 +72,7 @@ Feature/Capability Key:
 | React Server Function Middleware               | ✅                                               | 🛑                                                    | 🛑                                                    |
 | API Routes                                     | ✅                                               | ✅                                                    | ✅                                                    |
 | API Middleware                                 | ✅                                               | 🛑                                                    | ✅                                                    |
-| React Server Components                        | 🛑                                               | 🛑                                                    | ✅                                                    |
+| React Server Components                        | 🛑                                               | 🟡 (Experimental)                                     | ✅                                                    |
 | `<Form>` API                                   | 🛑                                               | ✅                                                    | ✅                                                    |
 
 [bp-tanstack-router]: https://badgen.net/bundlephobia/minzip/@tanstack/react-router

docs/router/framework/react/decisions-on-dx.md

@@ -225,7 +225,7 @@ Let's take a look at how the route configuration for the previous example would
 // src/routes/posts/index.ts
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/posts/')({
+export const Route = createFileRoute({
   component: () => 'Posts index component goes here!!!',
 })
 ```

docs/router/framework/react/guide/code-splitting.md

@@ -81,11 +81,11 @@ To enable automatic code-splitting, you just need to add the following to the co
 // vite.config.ts
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
-import { TanStackRouterVite } from '@tanstack/router-plugin/vite'
+import { tanstackRouter } from '@tanstack/router-plugin/vite'
 
 export default defineConfig({
   plugins: [
-    TanStackRouterVite({
+    tanstackRouter({
       // ...
       autoCodeSplitting: true,
     }),

docs/router/framework/react/guide/external-data-loading.md

@@ -48,7 +48,7 @@ Here is a naive illustration (don't do this) of using a Route's `loader` option
 // src/routes/posts.tsx
 let postsCache = []
 
-export const Route = createFileRoute('/posts')({
+export const Route = createFileRoute({
   loader: async () => {
     postsCache = await fetchPosts()
   },
@@ -80,7 +80,7 @@ const postsQueryOptions = queryOptions({
   queryFn: () => fetchPosts(),
 })
 
-export const Route = createFileRoute('/posts')({
+export const Route = createFileRoute({
   // Use the `loader` option to ensure that the data is loaded
   loader: () => queryClient.ensureQueryData(postsQueryOptions),
   component: () => {
@@ -105,7 +105,7 @@ export const Route = createFileRoute('/posts')({
 When an error occurs while using `suspense` with `Tanstack Query`, you'll need to let queries know that you want to try again when re-rendering. This can be done by using the `reset` function provided by the `useQueryErrorResetBoundary` hook. We can invoke this function in an effect as soon as the error component mounts. This will make sure that the query is reset and will try to fetch data again when the route component is rendered again. This will also cover cases where users navigate away from our route instead of clicking the `retry` button.
 
 ```tsx
-export const Route = createFileRoute('/posts')({
+export const Route = createFileRoute({
   loader: () => queryClient.ensureQueryData(postsQueryOptions),
   errorComponent: ({ error, reset }) => {
     const router = useRouter()

docs/router/framework/react/guide/not-found-errors.md

@@ -16,7 +16,7 @@ There are 2 uses for not-found errors in TanStack Router:
     - Attempting to access `/posts/1/edit` when the route tree only handles `/posts/$postId`
 - **Missing resources**: When a resource cannot be found, such as a post with a given ID or any asynchronous data that is not available or does not exist
   - **You, the developer** must throw a not-found error when a resource cannot be found. This can be done in the `beforeLoad` or `loader` functions using the `notFound` utility.
-  - Will be handled by the nearest parent route with a `notFoundComponent` or the root route
+  - Will be handled by the nearest parent route with a `notFoundComponent` (when `notFound` is called within `loader`) or the root route.
   - Examples:
     - Attempting to access `/posts/1` when the post with ID 1 does not exist
     - Attempting to access `/docs/path/to/document` when the document does not exist

docs/router/framework/react/guide/router-context.md

@@ -92,7 +92,7 @@ Once you have defined the router context type, you can use it in your route defi
 
 ```tsx
 // src/routes/todos.tsx
-export const Route = createFileRoute('/todos')({
+export const Route = createFileRoute({
   component: Todos,
   loader: ({ context }) => fetchTodosByUserId(context.user.id),
 })
@@ -122,7 +122,7 @@ Then, in your route:
 
 ```tsx
 // src/routes/todos.tsx
-export const Route = createFileRoute('/todos')({
+export const Route = createFileRoute({
   component: Todos,
   loader: ({ context }) => context.fetchTodosByUserId(context.userId),
 })
@@ -158,7 +158,7 @@ Then, in your route:
 
 ```tsx
 // src/routes/todos.tsx
-export const Route = createFileRoute('/todos')({
+export const Route = createFileRoute({
   component: Todos,
   loader: async ({ context }) => {
     await context.queryClient.ensureQueryData({
@@ -234,7 +234,7 @@ So, now in our route's `loader` function, we can access the `networkStrength` ho
 ```tsx
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/posts')({
+export const Route = createFileRoute({
   component: Posts,
   loader: ({ context }) => {
     if (context.networkStrength === 'STRONG') {
@@ -282,7 +282,7 @@ const router = createRouter({
 ```tsx
 import { createFileRoute } from '@tanstack/react-router'
 
-export const Route = createFileRoute('/todos')({
+export const Route = createFileRoute({
   component: Todos,
   beforeLoad: () => {
     return {

docs/router/framework/react/guide/scroll-restoration.md

@@ -177,12 +177,12 @@ function Component() {
 
 ## Scroll Behavior
 
-To control the scroll behavior when navigating between pages, you can use the `scrollBehavior` option. This allows you to make the transition between pages instant instead of a smooth scroll. The global configuration of scroll restoration behavior has the same options as those supported by the browser, which are `smooth`, `instant`, and `auto` (see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView#behavior) for more information).
+To control the scroll behavior when navigating between pages, you can use the `scrollRestorationBehavior` option. This allows you to make the transition between pages instant instead of a smooth scroll. The global configuration of scroll restoration behavior has the same options as those supported by the browser, which are `smooth`, `instant`, and `auto` (see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView#behavior) for more information).
 
 ```tsx
 import { createRouter } from '@tanstack/react-router'
 
 const router = createRouter({
-  scrollBehavior: 'instant',
+  scrollRestorationBehavior: 'instant',
 })
 ```