fix(nextjs): Deprecate user, session, organization from auth() (#1960)

clerk · Oct 31, 2023 · 146831a · 146831a
1 parent aff394e
commit 146831a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/.changeset/three-rings-wash.md b/.changeset/three-rings-wash.md
@@ -0,0 +1,5 @@
+---
+'@clerk/nextjs': patch
+---
+
+Deprecate `user`, `session`, and `organization` resources from the returned value of `auth()`.
diff --git a/packages/nextjs/src/server/getAuth.ts b/packages/nextjs/src/server/getAuth.ts
@@ -8,6 +8,7 @@ import {
   signedInAuthObject,
   signedOutAuthObject,
 } from '@clerk/backend';
+import { deprecatedObjectProperty } from '@clerk/shared';
 import type { SecretKeyOrApiKey } from '@clerk/types';
 
 import { withLogger } from '../utils/debugLogger';
@@ -66,7 +67,22 @@ export const createGetAuth = ({
 
       const jwt = parseJwt(req);
       logger.debug('JWT debug', jwt.raw.text);
-      return signedInAuthObject(jwt.payload, { ...options, token: jwt.raw.text });
+
+      const signedIn = signedInAuthObject(jwt.payload, { ...options, token: jwt.raw.text });
+
+      if (signedIn.user) {
+        deprecatedObjectProperty(signedIn, 'user', 'Use `clerkClient.users.getUser` instead.');
+      }
+
+      if (signedIn.organization) {
+        deprecatedObjectProperty(signedIn, 'organization', 'Use `clerkClient.organizations.getOrganization` instead.');
+      }
+
+      if (signedIn.session) {
+        deprecatedObjectProperty(signedIn, 'session', 'Use `clerkClient.sessions.getSession` instead.');
+      }
+
+      return signedIn;
     };
   });