chore(remix): Drop deprecations

.changeset/many-weeks-march.md

@@ -0,0 +1,10 @@
+---
+'@clerk/remix': major
+---
+
+Drop deprecations. Migration steps:
+
+- use `CLERK_SECRET_KEY` instead of `CLERK_API_KEY` env variable
+- use `secretKey` instead of `apiKey`
+- use `CLERK_PUBLISHABLE_KEY` instead of `CLERK_FRONTEND_API` env variable
+- use `publishableKey` instead of `frontendApi`

packages/remix/src/client/RemixClerkProvider.tsx

@@ -45,7 +45,6 @@ export function ClerkProvider({ children, ...rest }: RemixClerkProviderProps): J
   assertValidClerkState(clerkState);
   const {
     __clerk_ssr_state,
-    __frontendApi,
     __publishableKey,
     __proxyUrl,
     __domain,
@@ -68,7 +67,6 @@ export function ClerkProvider({ children, ...rest }: RemixClerkProviderProps): J
   }, []);
 
   const mergedProps = {
-    frontendApi: __frontendApi as any,
     publishableKey: __publishableKey as any,
     proxyUrl: __proxyUrl as any,
     domain: __domain as any,

packages/remix/src/client/types.ts

@@ -7,7 +7,6 @@ export type ClerkState = {
   __internal_clerk_state: {
     __clerk_ssr_interstitial: string;
     __clerk_ssr_state: InitialState;
-    __frontendApi: string | undefined;
     __publishableKey: string | undefined;
     __proxyUrl: string | undefined;
     __domain: string | undefined;

packages/remix/src/errors.ts

@@ -70,8 +70,8 @@ export const loader: LoaderFunction = args => rootAuthLoader(args, ({ auth }) =>
 `);
 
 export const noSecretKeyOrApiKeyError = createErrorMessage(`
-A secretKey or apiKey must be provided in order to use SSR and the exports from @clerk/remix/api.');
-If your runtime supports environment variables, you can add a CLERK_SECRET_KEY or CLERK_API_KEY variable to your config.
+A secretKey must be provided in order to use SSR and the exports from @clerk/remix/api.');
+If your runtime supports environment variables, you can add a CLERK_SECRET_KEY variable to your config.
 Otherwise, you can pass a secretKey parameter to rootAuthLoader or getAuth.
 `);
 

packages/remix/src/ssr/authenticateRequest.ts

@@ -1,7 +1,7 @@
 import type { RequestState } from '@clerk/backend';
 import { buildRequestUrl, Clerk } from '@clerk/backend';
-import { deprecated } from '@clerk/shared/deprecated';
 import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
+import { isDevelopmentFromApiKey } from '@clerk/shared/keys';
 import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
 import { isTruthy } from '@clerk/shared/underscore';
 
@@ -13,10 +13,6 @@ import {
 import { getEnvVariable } from '../utils';
 import type { LoaderFunctionArgs, RootAuthLoaderOptions } from './types';
 
-function isDevelopmentFromApiKey(apiKey: string): boolean {
-  return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
-}
-
 /**
  * @internal
  */
@@ -31,28 +27,11 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
   // 3. Then try from globalThis (Cloudflare Workers).
   // 4. Then from loader context (Cloudflare Pages).
   const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
-  const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
-  if (apiKey) {
-    if (getEnvVariable('CLERK_API_KEY', context)) {
-      deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
-    } else {
-      deprecated('apiKey', 'Use `secretKey` instead.');
-    }
-  }
 
-  if (!secretKey && !apiKey) {
+  if (!secretKey) {
     throw new Error(noSecretKeyOrApiKeyError);
   }
 
-  const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
-  if (frontendApi) {
-    if (getEnvVariable('CLERK_FRONTEND_API', context)) {
-      deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
-    } else {
-      deprecated('frontendApi', 'Use `publishableKey` instead.');
-    }
-  }
-
   const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';
 
   const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);
@@ -93,16 +72,14 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
     throw new Error(satelliteAndMissingProxyUrlAndDomain);
   }
 
-  if (isSatellite && !isHttpOrHttps(signInUrl) && isDevelopmentFromApiKey(secretKey || apiKey)) {
+  if (isSatellite && !isHttpOrHttps(signInUrl) && isDevelopmentFromApiKey(secretKey)) {
     throw new Error(satelliteAndMissingSignInUrl);
   }
 
-  return Clerk({ apiUrl, apiKey, secretKey, jwtKey, proxyUrl, isSatellite, domain }).authenticateRequest({
-    apiKey,
+  return Clerk({ apiUrl, secretKey, jwtKey, proxyUrl, isSatellite, domain }).authenticateRequest({
     audience,
     secretKey,
     jwtKey,
-    frontendApi,
     publishableKey,
     loadUser,
     loadSession,

packages/remix/src/ssr/getAuth.ts

@@ -5,7 +5,7 @@ import { authenticateRequest } from './authenticateRequest';
 import type { GetAuthReturn, LoaderFunctionArgs, RootAuthLoaderOptions } from './types';
 import { interstitialJsonResponse, unknownResponse } from './utils';
 
-type GetAuthOptions = Pick<RootAuthLoaderOptions, 'apiKey' | 'secretKey'>;
+type GetAuthOptions = Pick<RootAuthLoaderOptions, 'secretKey'>;
 
 export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions): GetAuthReturn {
   if (!args || (args && (!args.request || !args.context))) {

packages/remix/src/ssr/types.ts

@@ -5,16 +5,8 @@ import type { DataFunctionArgs, LoaderFunction } from '@remix-run/server-runtime
 export type GetAuthReturn = Promise<AuthObject>;
 
 export type RootAuthLoaderOptions = {
-  /**
-   * @deprecated Use `publishableKey` instead.
-   */
-  frontendApi?: string;
   publishableKey?: string;
   jwtKey?: string;
-  /**
-   * @deprecated Use `secretKey` instead.
-   */
-  apiKey?: string;
   secretKey?: string;
   loadUser?: boolean;
   loadSession?: boolean;

packages/remix/src/ssr/utils.ts

@@ -86,7 +86,8 @@ export const interstitialJsonResponse = (
       __loader: opts.loader,
       __clerk_ssr_interstitial_html: loadInterstitialFromLocal({
         debugData: debugRequestState(requestState),
-        frontendApi: requestState.frontendApi,
+        // TODO(@dimkl): use empty string for frontendApi until type is fixed in @clerk/backend to drop it
+        frontendApi: '',
         publishableKey: requestState.publishableKey,
         // TODO: This needs to be the version of clerk/remix not clerk/react
         // pkgVersion: LIB_VERSION,
@@ -107,7 +108,6 @@ export const injectRequestStateIntoResponse = async (
   requestState: RequestState,
   context: AppLoadContext,
 ) => {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const clone = response.clone();
   const data = await clone.json();
 
@@ -151,11 +151,9 @@ export function injectRequestStateIntoDeferredData(
  * @internal
  */
 export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
   const clerkState = wrapWithClerkState({
     __clerk_ssr_state: rest.toAuth(),
-    __frontendApi: requestState.frontendApi,
     __publishableKey: requestState.publishableKey,
     __proxyUrl: requestState.proxyUrl,
     __domain: requestState.domain,