diff --git a/.changeset/cuddly-cups-sip.md b/.changeset/cuddly-cups-sip.md new file mode 100644 index 00000000000..f7163dd98ae --- /dev/null +++ b/.changeset/cuddly-cups-sip.md @@ -0,0 +1,5 @@ +--- +'@clerk/tanstack-start': patch +--- + +Added a warning message to inform users that the package has been renamed from `@clerk/tanstack-start` to `@clerk/tanstack-react-start`. This change aligns our package naming with TanStack Start's conventions. Users should update their dependencies to use the new package name, as this is the last release under the old name. diff --git a/packages/tanstack-start/src/errors.ts b/packages/tanstack-start/src/errors.ts index 9548c1104db..8ae902cdec9 100644 --- a/packages/tanstack-start/src/errors.ts +++ b/packages/tanstack-start/src/errors.ts @@ -1,3 +1,7 @@ +import { warnPackageRenaming } from './utils/errors'; + +warnPackageRenaming(); + export { isClerkAPIResponseError, isEmailLinkError, diff --git a/packages/tanstack-start/src/index.ts b/packages/tanstack-start/src/index.ts index ae6c08cceee..f7b1a210c0a 100644 --- a/packages/tanstack-start/src/index.ts +++ b/packages/tanstack-start/src/index.ts @@ -1,3 +1,7 @@ +import { warnPackageRenaming } from './utils/errors'; + +warnPackageRenaming(); + export * from './client/index'; // Override Clerk React error thrower to show that errors come from @clerk/tanstack-start diff --git a/packages/tanstack-start/src/server/index.ts b/packages/tanstack-start/src/server/index.ts index 4a56c1e5c15..28ec67a97cb 100644 --- a/packages/tanstack-start/src/server/index.ts +++ b/packages/tanstack-start/src/server/index.ts @@ -1,3 +1,7 @@ +import { warnPackageRenaming } from '../utils/errors'; + +warnPackageRenaming(); + export * from './middlewareHandler'; export * from './getAuth'; diff --git a/packages/tanstack-start/src/utils/errors.ts b/packages/tanstack-start/src/utils/errors.ts index 9a656d20138..0ac9124ad9f 100644 --- a/packages/tanstack-start/src/utils/errors.ts +++ b/packages/tanstack-start/src/utils/errors.ts @@ -24,3 +24,9 @@ To fix this, make sure you have the \`clerkHandler()\` configure in you SSR entr For more info, check out the docs: https://github.com/clerk/javascript/tree/main/packages/tanstack-start#setup-clerkhandler-in-the-ssr-entrypoint, `); + +export const warnPackageRenaming = () => { + console.warn( + '[@clerk/tanstack-start] Warning: This package has moved to @clerk/tanstack-react-start. Please switch to the new package, as this is the last release under this package name.', + ); +};