chore(nextjs): Apply deprecation warnings

.changeset/spicy-toys-change.md

@@ -0,0 +1,5 @@
+---
+'@clerk/nextjs': patch
+---
+
+Warn about deprecations that will be dropped in next major version

packages/nextjs/src/server/clerkClient.ts

@@ -1,23 +1,7 @@
 /* eslint-disable turbo/no-undeclared-env-vars */
 import { Clerk } from '@clerk/backend';
 
-/**
- * @deprecated
- */
-export const JS_VERSION = process.env.CLERK_JS_VERSION || '';
-export const CLERK_JS_VERSION = process.env.NEXT_PUBLIC_CLERK_JS_VERSION || '';
-export const CLERK_JS_URL = process.env.NEXT_PUBLIC_CLERK_JS || '';
-export const API_URL = process.env.CLERK_API_URL || 'https://api.clerk.dev';
-export const API_VERSION = process.env.CLERK_API_VERSION || 'v1';
-export const API_KEY = process.env.CLERK_API_KEY || '';
-export const SECRET_KEY = process.env.CLERK_SECRET_KEY || '';
-export const FRONTEND_API = process.env.NEXT_PUBLIC_CLERK_FRONTEND_API || '';
-export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
-export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
-export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
-export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
-export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
-export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';
+import { API_KEY, API_URL, API_VERSION, DOMAIN, IS_SATELLITE, PROXY_URL, SECRET_KEY } from './constants';
 
 const clerkClient = Clerk({
   apiKey: API_KEY,
@@ -36,3 +20,8 @@ const createClerkClient = Clerk;
 export { clerkClient, createClerkClient, Clerk };
 
 export * from '@clerk/backend';
+
+/**
+ * @deprecated Don't export the constants. Should be marked as internal
+ */
+export * from './constants';

packages/nextjs/src/server/constants.ts

@@ -0,0 +1,34 @@
+import { deprecated } from '@clerk/shared';
+
+/**
+ * @deprecated Use `CLERK_JS_VERSION` instead.
+ */
+export const JS_VERSION = process.env.CLERK_JS_VERSION || '';
+if (JS_VERSION) {
+  deprecated('CLERK_JS_VERSION', 'Use `NEXT_PUBLIC_CLERK_JS_VERSION` environment variable instead.');
+}
+export const CLERK_JS_VERSION = process.env.NEXT_PUBLIC_CLERK_JS_VERSION || '';
+export const CLERK_JS_URL = process.env.NEXT_PUBLIC_CLERK_JS || '';
+export const API_URL = process.env.CLERK_API_URL || 'https://api.clerk.dev';
+export const API_VERSION = process.env.CLERK_API_VERSION || 'v1';
+/**
+ * @deprecated Use `CLERK_SECRET_KEY` instead.
+ */
+export const API_KEY = process.env.CLERK_API_KEY || '';
+if (API_KEY) {
+  deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` environment variable instead.');
+}
+export const SECRET_KEY = process.env.CLERK_SECRET_KEY || '';
+/**
+ * @deprecated Use `PUBLISHABLE_KEY` instead.
+ */
+export const FRONTEND_API = process.env.NEXT_PUBLIC_CLERK_FRONTEND_API || '';
+if (FRONTEND_API) {
+  deprecated('NEXT_PUBLIC_CLERK_FRONTEND_API', 'Use `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` environment variable instead.');
+}
+export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
+export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
+export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
+export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
+export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
+export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

packages/nextjs/src/server/withClerkMiddleware.ts

@@ -1,5 +1,6 @@
 import type { RequestState } from '@clerk/backend';
 import { constants, debugRequestState } from '@clerk/backend';
+import { deprecated } from '@clerk/shared';
 import type { NextFetchEvent, NextMiddleware, NextRequest } from 'next/server';
 import { NextResponse } from 'next/server';
 
@@ -36,6 +37,11 @@ export const withClerkMiddleware: WithClerkMiddleware = (...args: unknown[]) =>
   const noop = () => undefined;
   const [handler = noop, opts = {}] = args as [NextMiddleware, WithAuthOptions] | [];
 
+  deprecated(
+    'withClerkMiddleware',
+    'Use `authMiddleware` instead.\nFor more details, consult the middleware documentation: https://clerk.com/docs/nextjs/middleware',
+  );
+
   return async (req: NextRequest, event: NextFetchEvent) => {
     const { isSatellite, domain, signInUrl, proxyUrl } = handleMultiDomainAndProxy(req, opts);
 

packages/nextjs/src/ssr/withServerSideAuth.ts

@@ -1,5 +1,6 @@
 import type { RequestState } from '@clerk/backend';
 import { constants, debugRequestState } from '@clerk/backend';
+import { deprecated } from '@clerk/shared';
 import type { ServerResponse } from 'http';
 import type { GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
 
@@ -43,6 +44,10 @@ const decorateResponseWithObservabilityHeaders = (res: ServerResponse, requestSt
 export const withServerSideAuth: WithServerSideAuth = (cbOrOptions: any, options?: any): any => {
   const cb = typeof cbOrOptions === 'function' ? cbOrOptions : undefined;
   const opts = (options ? options : typeof cbOrOptions !== 'function' ? cbOrOptions : {}) || {};
+  deprecated(
+    'withServerSideAuth',
+    'Use `authMiddleware` instead.\nFor more details, consult the middleware documentation: https://clerk.com/docs/nextjs/middleware',
+  );
 
   // Support both loadOrganization and the older loadOrg option without breaking changes
   // TODO: Remove pre v5

turbo.json

@@ -11,7 +11,26 @@
     "tsconfig.json",
     "tsconfig.*.json"
   ],
-  "globalEnv": ["NODE_VERSION", "NPM_VERSION", "NODE_ENV", "VERCEL"],
+  "globalEnv": [
+    "NODE_VERSION",
+    "NPM_VERSION",
+    "NODE_ENV",
+    "VERCEL",
+    "CLERK_JS_VERSION",
+    "CLERK_API_URL",
+    "CLERK_API_VERSION",
+    "CLERK_API_KEY",
+    "CLERK_SECRET_KEY",
+    "NEXT_PUBLIC_CLERK_JS_VERSION",
+    "NEXT_PUBLIC_CLERK_JS",
+    "NEXT_PUBLIC_CLERK_FRONTEND_API",
+    "NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY",
+    "NEXT_PUBLIC_CLERK_DOMAIN",
+    "NEXT_PUBLIC_CLERK_PROXY_URL",
+    "NEXT_PUBLIC_CLERK_IS_SATELLITE",
+    "NEXT_PUBLIC_CLERK_SIGN_IN_URL",
+    "NEXT_PUBLIC_CLERK_SIGN_UP_URL"
+  ],
   "pipeline": {
     "build": {
       "dependsOn": ["^build"],