Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eight-badgers-speak.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-sdk-node': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/clerk-sdk-node` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/clerk-sdk-node` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/clerk-sdk-node';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/clerk-sdk-node';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/fuzzy-years-taste.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
Comment thread
tmilewski marked this conversation as resolved.
'@clerk/backend': major
---

Remove the named `Clerk` import from `@clerk/backend` and import `createClerkClient` instead. The latter is a factory method that will create a Clerk client instance for you. This aligns usage across our SDKs and will enable us to better ship DX improvements in the future.


Inside your code, search for occurrences like these:

```js
import { Clerk } from '@clerk/backend';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/backend';
const clerk = createClerkClient({ secretKey: '...' });
```
19 changes: 19 additions & 0 deletions .changeset/metal-ears-cheat.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'gatsby-plugin-clerk': major
---

Remove the named `Clerk` import from `gatsby-plugin-clerk` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

Inside your code, search for occurrences like these:

```js
import { Clerk } from 'gatsby-plugin-clerk';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from 'gatsby-plugin-clerk';
const clerk = createClerkClient({ secretKey: '...' });
```
20 changes: 20 additions & 0 deletions .changeset/shiny-pumas-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/remix': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/remix` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/remix` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/remix';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/remix';
const clerk = createClerkClient({ secretKey: '...' });
```

21 changes: 21 additions & 0 deletions .changeset/small-cats-check.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
'@clerk/fastify': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/fastify` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/fastify` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.


```js
import { Clerk } from '@clerk/fastify';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/fastify';
const clerk = createClerkClient({ secretKey: '...' });
```

20 changes: 20 additions & 0 deletions .changeset/sour-avocados-sin.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
---
'@clerk/nextjs': major
---

(Note: This is only relevant if, in the unlikely case, you are using `Clerk` from `@clerk/nextjs` directly. If not, you can safely ignore this change.)

Remove the named `Clerk` import from `@clerk/nextjs` and import `createClerkClient` instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

```js
import { Clerk } from '@clerk/nextjs';
const clerk = Clerk({ secretKey: '...' });
```

You need to rename the import from `Clerk` to `createClerkClient` and change its usage:

```js
import { createClerkClient } from '@clerk/nextjs';
const clerk = createClerkClient({ secretKey: '...' });
```

4 changes: 2 additions & 2 deletions integration/cleanup/cleanup.setup.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { User } from '@clerk/backend';
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';
import { test as setup } from '@playwright/test';

import { appConfigs } from '../presets/';
Expand All@@ -13,7 +13,7 @@ setup('cleanup instances ', async () => {

for (const secretKey of secretKeys) {
console.log(`Cleanup for ${secretKey.replace(/(sk_test_)(.+)(...)/, '$1***$3')}`);
const clerkClient = Clerk({ secretKey });
const clerkClient = createClerkClient({ secretKey });
const { data: users, errors } = await clerkClient.users.getUserList({
orderBy: '-created_at',
query: 'clerkcookie',
Expand Down
4 changes: 2 additions & 2 deletions integration/testUtils/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient as backendCreateClerkClient } from '@clerk/backend';
import type { Browser, BrowserContext, Page } from '@playwright/test';

import type { Application } from '../models/application';
Expand All@@ -13,7 +13,7 @@ import { createUserService } from './usersService';

export type { FakeUser };
const createClerkClient = (app: Application) => {
return Clerk({
return backendCreateClerkClient({
secretKey: app.env.privateVariables.get('CLERK_SECRET_KEY'),
publishableKey: app.env.publicVariables.get('CLERK_PUBLISHABLE_KEY'),
});
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -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_...');

Expand Down
4 changes: 2 additions & 2 deletions packages/backend/src/api/endpoints/InvitationApi.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 })
*
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@ export default (QUnit: QUnit) => {
const exportedApiKeys = [
'AllowlistIdentifier',
'AuthStatus',
'Clerk',
'Client',
'DeletedObject',
'Email',
Expand All@@ -37,6 +36,7 @@ export default (QUnit: QUnit) => {
'buildRequestUrl',
'constants',
'createAuthenticateRequest',
'createClerkClient',
'createIsomorphicRequest',
'debugRequestState',
'decodeJwt',
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 });
Expand Down
6 changes: 3 additions & 3 deletions packages/fastify/src/clerkClient.test.ts
Original file line numberDiff line numberDiff line change
@@ -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,
};
});

Expand All@@ -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');
});
});
4 changes: 2 additions & 2 deletions packages/fastify/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/fastify/src/withClerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -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),
Expand Down
11 changes: 3 additions & 8 deletions packages/gatsby-plugin-clerk/src/ssr/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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';
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
[
"AllowlistIdentifier",
"AuthStatus",
"Clerk",
"Client",
"DeletedObject",
"Email",
Expand Down
11 changes: 3 additions & 8 deletions packages/nextjs/src/server/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { Clerk } from '@clerk/backend';
import { createClerkClient } from '@clerk/backend';

import {
API_URL,
Expand All@@ -12,7 +12,7 @@ import {
TELEMETRY_DISABLED,
} from './constants';

const clerkClient = Clerk({
const clerkClient = createClerkClient({
secretKey: SECRET_KEY,
apiUrl: API_URL,
apiVersion: API_VERSION,
Expand All@@ -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';
6 changes: 0 additions & 6 deletions packages/remix/src/api/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
import { Clerk } from '@clerk/backend';

const createClerkClient = Clerk;

export { createClerkClient };

export * from '@clerk/backend';
4 changes: 2 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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,
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk-node/src/clerkClient.ts
Original file line numberDiff line numberDiff line change
@@ -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>;
Expand All@@ -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) => {
Expand All@@ -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() {
Expand Down
Loading