diff --git a/.changeset/auth-misimport-runtime-error.md b/.changeset/auth-misimport-runtime-error.md new file mode 100644 index 00000000000..7fd05b556a3 --- /dev/null +++ b/.changeset/auth-misimport-runtime-error.md @@ -0,0 +1,5 @@ +--- +"@clerk/nextjs": patch +--- + +Improved developer experience when `auth` is accidentally imported from `@clerk/nextjs` instead of `@clerk/nextjs/server`. The `auth` export now includes a `@deprecated` JSDoc tag with a clear message guiding developers to the correct import path, visible on hover in IDEs. diff --git a/packages/nextjs/src/index.ts b/packages/nextjs/src/index.ts index 283a7935cfc..adf5fca7751 100644 --- a/packages/nextjs/src/index.ts +++ b/packages/nextjs/src/index.ts @@ -85,7 +85,7 @@ export const ClerkProvider = ComponentsModule.ClerkProvider as ServerComponentsS export const Show = ComponentsModule.Show as ServerComponentsServerModuleTypes['Show']; /** - * `auth` is not available from this import path. + * @deprecated `auth()` must be imported from `@clerk/nextjs/server`, not `@clerk/nextjs`. * * **To fix this error:** * ```diff