refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

refactor(router-core): begin migrating types from react-router and solid-router to router-core - #3538

Merged
chorobin merged 9 commits into
mainfrom
types-migrate-to-core
Feb 23, 2025
Merged

refactor(router-core): begin migrating types from react-router and solid-router to router-core#3538
chorobin merged 9 commits into
mainfrom
types-migrate-to-core

Conversation

@chorobin

Copy link
Copy Markdown
Contributor

Migrates many types over but there is still a lot to do D:

@nx-cloud

nx-cloudBot commented Feb 23, 2025

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 86e9ae7.

CommandStatusDurationResult
nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded4m 57sView ↗
nx run-many --target=build --exclude=examples/*...✅ Succeeded1m 21sView ↗

☁️ Nx Cloud last updated this comment at 2025-02-23 22:09:24 UTC

@pkg-pr-new

pkg-pr-newBot commented Feb 23, 2025

Copy link
Copy Markdown

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3538

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3538

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/@tanstack/directive-functions-plugin@3538

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3538

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3538

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3538

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3538

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3538

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3538

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3538

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@3538

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3538

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3538

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3538

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@3538

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3538

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/@tanstack/server-functions-plugin@3538

@tanstack/solid-cross-context

npm i https://pkg.pr.new/@tanstack/solid-cross-context@3538

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@3538

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3538

@tanstack/start-api-routes

npm i https://pkg.pr.new/@tanstack/start-api-routes@3538

@tanstack/start-client

npm i https://pkg.pr.new/@tanstack/start-client@3538

@tanstack/start-config

npm i https://pkg.pr.new/@tanstack/start-config@3538

@tanstack/start-plugin

npm i https://pkg.pr.new/@tanstack/start-plugin@3538

@tanstack/start-router-manifest

npm i https://pkg.pr.new/@tanstack/start-router-manifest@3538

@tanstack/start-server

npm i https://pkg.pr.new/@tanstack/start-server@3538

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/@tanstack/start-server-functions-client@3538

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/@tanstack/start-server-functions-fetcher@3538

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/@tanstack/start-server-functions-handler@3538

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/@tanstack/start-server-functions-server@3538

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/@tanstack/start-server-functions-ssr@3538

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3538

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3538

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3538

commit: 86e9ae7

Constrain,
ConstrainLiteral,
RootRoute as CoreRootRoute,
Route as CoreRoute,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow this and prefix all of these imports from router-core with Core? or is the DX without adding this prefix fine?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbh this was just a way for me to alias the Route type in core but keep the current Route class in this file

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping to settle this in a later pr because I am still not sure how the runtime will end up in core. We might still need a class in react-router and core, I really do not know

const protectedRoute = createFileRoute('/(auth)/protected')()

declare module '../src/fileRoute' {
declare module '@tanstack/router-core' {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why don't we move the type test to router-core as well?

@chorobinchorobinFeb 23, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can in another pr. atm I don't want to change them too much because I want to rely on them to check I haven't broken anything

@schiller-manuelschiller-manuelFeb 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries, just trying to understand where you are heading
i just hope we can limit duplication to the absolut minimum, and this also includes tests

@chorobin
chorobin merged commit 72b505c into mainFeb 23, 2025
@chorobin
chorobin deleted the types-migrate-to-core branch February 23, 2025 22:18
@SimenB

SimenB commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Presumably this change is the reason for this error?

node_modules/@tanstack/react-router/dist/esm/fileRoute.d.ts:45:120 - error TS2344: Type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>' does not satisfy the constraint 'AnyRoute'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown> | Route<RootRoute<undefined, { queryClient: QueryClient; }, ... 5 more ..., unknown>, ... 12 more ..., unknown> | Route<...> | Route<...> | Route<...> | Route<...>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any>'.
The types returned by 'update(...)' are incompatible between these types.
Type 'RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, unknown, unknown>' is not assignable to type 'RouteById<RootRoute<undefined, { queryClient: QueryClient; }, AnyContext, AnyContext, {}, undefined, RootRouteChildren, FileRouteTypes>, TId>'.
45 export declare function createLazyRoute<TId extends RouteIds<RegisteredRouter['routeTree']>, TRoute extends AnyRoute = RouteById<RegisteredRouter['routeTree'], TId>>(id: TId): (opts: LazyRouteOptions) => LazyRoute<TRoute>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We do

createRootRouteWithContext<{queryClient: QueryClient}>()({component: Root,wrapInSuspense: true,},);

removing the context generic "fixes" the problem.

Keeping @tanstack/react-router at 1.109.2 works, even if @tanstack/router-* is at 1.111.3

@schiller-manuel

Copy link
Copy Markdown
Collaborator

@SimenB can you please open a new GitHub issue and attach a minimal example? our tests and examples did not hit that issue so we need to have a look at what you are doing differently

@SimenB

Copy link
Copy Markdown
Contributor

The basic example fails if you remove skipLibCheck: true: https://tanstack.com/router/v1/docs/framework/react/examples/basic-react-query

image

@SimenB

Copy link
Copy Markdown
Contributor

Seems to be fixed in 1.111.7 👍

@birkskyumbirkskyum mentioned this pull request Feb 25, 2025
10 tasks
schiller-manuel pushed a commit that referenced this pull request Mar 1, 2025
This PR introduce support for Solid to be used with TanStack Start.
There are several ongoing refactors that can influence the timing of
when it's most feasible to merge this.
### Status (build and run e2e/solid-start/basic)
- [X] SSR
- [x] API Routes
- [x] Server Functions
- [x] HMR
- [x] Streaming (/stream route)
- [X] Timely hydration
### Ongoing refactors
Refactor to make router packages (aka. client-only features) more
agnostic:
- #3552
- #3540
- #3538
- #3171
Refactor to make start packages (aka. server features) more agnostic:
- #3546 - #3563 - #3565 ### Upstream changes to solid-router
- #3592
- #3591
- #3589
- #3616 ### Passing E2E test suites
- [x] basic
- [x] website
- [x] scroll-restoration
- [x] server-functions
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
Co-authored-by: Iha Shin <me@xiniha.dev>
Co-authored-by: Brenley Dueck <brenley@crowdbotics.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@chorobin@SimenB@schiller-manuel@SeanCassiere