chore(backend): Replace Clerk with createClerkClient [SDK-1058]

Author: tmilewski

.changeset/fuzzy-years-taste.md

@@ -0,0 +1,37 @@
+---
+'@clerk/backend': major
+'@clerk/gatsby-plugin-clerk': major
+'@clerk/nextjs': major
+'@clerk/remix': major
+---
+
+## Breaking Changes
+
+### @clerk/backend
+
+Replace `Clerk` with `createClerkClient` [SDK-1058]
+
+
+```js
+import { Clerk } from '@clerk/backend';
+const clerk = Clerk({ secretKey: '...' });
+```
+
+now becomes:
+
+```js
+import { createClerkClient } from '@clerk/backend';
+const clerk = createClerkClient({ secretKey: '...' });
+```
+
+### @clerk/gatsby-plugin-clerk
+
+No longer returning `Clerk`. Please replace with `createClerkClient`
+
+### @clerk/nextjs
+
+No longer returning `Clerk`. Please replace with `createClerkClient`
+
+### @clerk/remix
+
+No longer returning `Clerk`. Please replace with `createClerkClient`

packages/backend/README.md

@@ -55,23 +55,23 @@ npm install @clerk/backend
 ```
 
 ```
-import { Clerk } from '@clerk/backend';
+import { createClerkClient } from '@clerk/backend';
 
-const clerk = Clerk({ secretKey: '...' });
+const clerk = createClerkClient({ secretKey: '...' });
 
 await clerk.users.getUser("user_...");
 ```
 
 ### API
 
-#### Clerk(options: ClerkOptions)
+#### createClerkClient(options: ClerkOptions)
 
 Create Clerk SDK that includes an HTTP Rest client for the Backend API and session verification helpers. The clerk object contains the following APIs and methods:
 
 ```js
-import { Clerk } from '@clerk/backend';
+import { createClerkClient } from '@clerk/backend';
 
-const clerk = Clerk({ secretKey: '...' });
+const clerk = createClerkClient({ secretKey: '...' });
 
 await clerk.users.getUser('user_...');
 

packages/backend/src/api/endpoints/InvitationApi.ts

@@ -19,8 +19,8 @@ type GetInvitationListParams = {
    * @example
    * get all revoked invitations
    *
-   * import { Clerk } from '@clerk/backend';
-   * const clerkClient = Clerk(...)
+   * import { createClerkClient } from '@clerk/backend';
+   * const clerkClient = createClerkClient(...)
    * await clerkClient.invitations.getInvitationList({ status: 'revoked })
    *
    */

packages/backend/src/exports.test.ts

@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
       const exportedApiKeys = [
         'AllowlistIdentifier',
         'AuthStatus',
-        'Clerk',
         'Client',
         'DeletedObject',
         'Email',
@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
         'buildRequestUrl',
         'constants',
         'createAuthenticateRequest',
+        'createClerkClient',
         'createIsomorphicRequest',
         'debugRequestState',
         'decodeJwt',

packages/backend/src/index.ts

@@ -25,7 +25,7 @@ export type ClerkOptions = CreateBackendApiOptions &
     >
   > & { sdkMetadata?: SDKMetadata; telemetry?: Pick<TelemetryCollectorOptions, 'disabled' | 'debug'> };
 
-export function Clerk(options: ClerkOptions) {
+export function createClerkClient(options: ClerkOptions) {
   const opts = { ...options };
   const apiClient = createBackendApiClient(opts);
   const requestState = createAuthenticateRequest({ options: opts, apiClient });

packages/fastify/src/clerkClient.test.ts

@@ -1,11 +1,11 @@
-const ClerkMock = jest.fn(() => {
+const createClerkClientMock = jest.fn(() => {
   return 'clerkClient';
 });
 
 jest.mock('@clerk/backend', () => {
   return {
     ...jest.requireActual('@clerk/backend'),
-    Clerk: ClerkMock,
+    createClerkClient: createClerkClientMock,
   };
 });
 
@@ -17,7 +17,7 @@ describe('clerk', () => {
   });
 
   test('initializes clerk with constants', () => {
-    expect(ClerkMock.mock.calls).toMatchSnapshot();
+    expect(createClerkClientMock.mock.calls).toMatchSnapshot();
     expect(clerkClient).toEqual('clerkClient');
   });
 });

packages/fastify/src/clerkClient.ts

@@ -1,8 +1,8 @@
-import { Clerk } from '@clerk/backend';
+import { createClerkClient } from '@clerk/backend';
 
 import { API_URL, API_VERSION, JWT_KEY, SDK_METADATA, SECRET_KEY } from './constants';
 
-export const createClerkClient = Clerk;
+export { createClerkClient };
 
 export const clerkClient = createClerkClient({
   secretKey: SECRET_KEY,

packages/fastify/src/withClerkMiddleware.test.ts

@@ -9,7 +9,7 @@ const localInterstitialMock = jest.fn();
 jest.mock('@clerk/backend', () => {
   return {
     ...jest.requireActual('@clerk/backend'),
-    Clerk: () => {
+    createClerkClient: () => {
       return {
         authenticateRequest: (...args: any) => authenticateRequestMock(...args),
         localInterstitial: (...args: any) => localInterstitialMock(...args),

packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts

@@ -1,8 +1,8 @@
-import { Clerk } from '@clerk/backend';
+import { createClerkClient } from '@clerk/backend';
 
 import { API_URL, API_VERSION, SDK_METADATA, SECRET_KEY, TELEMETRY_DEBUG, TELEMETRY_DISABLED } from '../constants';
 
-const clerkClient = Clerk({
+const clerkClient = createClerkClient({
   secretKey: SECRET_KEY,
   apiUrl: API_URL,
   apiVersion: API_VERSION,
@@ -15,10 +15,5 @@ const clerkClient = Clerk({
   },
 });
 
-const createClerkClient = Clerk;
-
-// eslint-disable-next-line import/export
-export { Clerk, clerkClient, createClerkClient };
-
-// eslint-disable-next-line import/export
+export { clerkClient };
 export * from '@clerk/backend';

packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
 [
   "AllowlistIdentifier",
   "AuthStatus",
-  "Clerk",
   "Client",
   "DeletedObject",
   "Email",

packages/nextjs/src/server/clerkClient.ts

@@ -1,4 +1,4 @@
-import { Clerk } from '@clerk/backend';
+import { createClerkClient } from '@clerk/backend';
 
 import {
   API_URL,
@@ -12,7 +12,7 @@ import {
   TELEMETRY_DISABLED,
 } from './constants';
 
-const clerkClient = Clerk({
+const clerkClient = createClerkClient({
   secretKey: SECRET_KEY,
   apiUrl: API_URL,
   apiVersion: API_VERSION,
@@ -28,10 +28,5 @@ const clerkClient = Clerk({
   },
 });
 
-const createClerkClient = Clerk;
-
-// eslint-disable-next-line import/export
-export { Clerk, clerkClient, createClerkClient };
-
-// eslint-disable-next-line import/export
+export { clerkClient };
 export * from '@clerk/backend';

packages/remix/src/api/index.ts

@@ -1,7 +1 @@
-import { Clerk } from '@clerk/backend';
-
-const createClerkClient = Clerk;
-
-export { createClerkClient };
-
 export * from '@clerk/backend';

packages/remix/src/ssr/authenticateRequest.ts

@@ -1,5 +1,5 @@
 import type { RequestState } from '@clerk/backend';
-import { buildRequestUrl, Clerk } from '@clerk/backend';
+import { buildRequestUrl, createClerkClient } from '@clerk/backend';
 import { apiUrlFromPublishableKey } from '@clerk/shared/apiUrlFromPublishableKey';
 import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
 import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
@@ -73,7 +73,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
     throw new Error(satelliteAndMissingSignInUrl);
   }
 
-  return Clerk({ apiUrl, secretKey, jwtKey, proxyUrl, isSatellite, domain }).authenticateRequest({
+  return createClerkClient({ apiUrl, secretKey, jwtKey, proxyUrl, isSatellite, domain }).authenticateRequest({
     audience,
     secretKey,
     jwtKey,

packages/sdk-node/src/clerkClient.ts

@@ -1,11 +1,11 @@
 import type { ClerkOptions, VerifyTokenOptions } from '@clerk/backend';
-import { Clerk as _Clerk, verifyToken as _verifyToken } from '@clerk/backend';
+import { createClerkClient, verifyToken as _verifyToken } from '@clerk/backend';
 
 import { createClerkExpressRequireAuth } from './clerkExpressRequireAuth';
 import { createClerkExpressWithAuth } from './clerkExpressWithAuth';
 import { loadApiEnv, loadClientEnv } from './utils';
 
-type ExtendedClerk = ReturnType<typeof _Clerk> & {
+type ExtendedClerk = ReturnType<typeof createClerkClient> & {
   expressWithAuth: ReturnType<typeof createClerkExpressWithAuth>;
   expressRequireAuth: ReturnType<typeof createClerkExpressRequireAuth>;
   verifyToken: (token: string, verifyOpts?: Parameters<typeof _verifyToken>[1]) => ReturnType<typeof _verifyToken>;
@@ -17,7 +17,7 @@ type ExtendedClerk = ReturnType<typeof _Clerk> & {
  * Arrow functions can never be called with the new keyword because they do not have the [[Construct]] method
  */
 export function Clerk(options: ClerkOptions): ExtendedClerk {
-  const clerkClient = _Clerk(options);
+  const clerkClient = createClerkClient(options);
   const expressWithAuth = createClerkExpressWithAuth({ ...options, clerkClient });
   const expressRequireAuth = createClerkExpressRequireAuth({ ...options, clerkClient });
   const verifyToken = (token: string, verifyOpts?: VerifyTokenOptions) => {
@@ -32,26 +32,26 @@ export function Clerk(options: ClerkOptions): ExtendedClerk {
   });
 }
 
-export const createClerkClient = Clerk;
+export { createClerkClient } from '@clerk/backend';
 
 let clerkClientSingleton = {} as unknown as ReturnType<typeof Clerk>;
 
 export const clerkClient = new Proxy(clerkClientSingleton, {
   get(_target, property) {
     const hasBeenInitialised = !!clerkClientSingleton.authenticateRequest;
     if (hasBeenInitialised) {
-      // @ts-expect-error
+      // @ts-expect-error - Element implicitly has an 'any' type because expression of type 'string | symbol' can't be used to index type 'ExtendedClerk'.
       return clerkClientSingleton[property];
     }
 
     const env = { ...loadApiEnv(), ...loadClientEnv() };
     if (env.secretKey) {
       clerkClientSingleton = Clerk({ ...env, userAgent: '@clerk/clerk-sdk-node' });
-      // @ts-expect-error
+      // @ts-expect-error - Element implicitly has an 'any' type because expression of type 'string | symbol' can't be used to index type 'ExtendedClerk'.
       return clerkClientSingleton[property];
     }
 
-    // @ts-expect-error
+    // @ts-expect-error - Element implicitly has an 'any' type because expression of type 'string | symbol' can't be used to index type 'ExtendedClerk'.
     return Clerk({ ...env, userAgent: '@clerk/clerk-sdk-node' })[property];
   },
   set() {

packages/sdk-node/src/clerkExpressRequireAuth.ts

@@ -1,4 +1,4 @@
-import type { Clerk } from '@clerk/backend';
+import type { createClerkClient } from '@clerk/backend';
 
 import {
   authenticateRequest,
@@ -10,7 +10,7 @@ import {
 import type { ClerkMiddlewareOptions, MiddlewareRequireAuthProp, RequireAuthProp } from './types';
 
 export type CreateClerkExpressMiddlewareOptions = {
-  clerkClient: ReturnType<typeof Clerk>;
+  clerkClient: ReturnType<typeof createClerkClient>;
   /* Secret Key */
   secretKey?: string;
   publishableKey?: string;

packages/sdk-node/src/types.ts

@@ -1,4 +1,4 @@
-import type { AuthenticateRequestOptions, AuthObject, Clerk, SignedInAuthObject } from '@clerk/backend';
+import type { AuthenticateRequestOptions, AuthObject, createClerkClient, SignedInAuthObject } from '@clerk/backend';
 import type { MultiDomainAndOrProxy } from '@clerk/types';
 import type { NextFunction, Request, Response } from 'express';
 import type { IncomingMessage } from 'http';
@@ -36,7 +36,7 @@ export type ClerkMiddlewareOptions = {
   signInUrl?: string;
 } & MultiDomainAndOrProxy;
 
-export type ClerkClient = ReturnType<typeof Clerk>;
+export type ClerkClient = ReturnType<typeof createClerkClient>;
 
 export type AuthenticateRequestParams = {
   clerkClient: ClerkClient;