Skip to content

Commit ee432df

Browse files
authored
chore(clerk-sdk-node): Drop deprecations (clerk#2021)
* chore(clerk-sdk-node): Drop `CLERK_API_KEY` and `apiKey` * chore(clerk-sdk-node): Drop `verifySessionToken` hotfix for Redwood * chore(clerk-sdk-node): Drop `CLERK_FRONTEND_API` and `frontendApi` * chore(clerk-sdk-node): Drop clerkClient exposed setters The dropped setters: `setClerkApiVersion`, `setClerkHttpOptions`, `setClerkServerApiUrl` * chore(clerk-sdk-node): Move tests under __tests__ directory for consistency * fix(clerk-sdk-node): Fix package exports Changes: - drop subpath exports of /esm|cjs/instance * chore(clerk-sdk-node): Drop unused info script - replaced by tsup * chore(repo): Add changeset
1 parent d1b524f commit ee432df

22 files changed

Lines changed: 67 additions & 207 deletions

.changeset/popular-singers-sort.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
'@clerk/clerk-sdk-node': major
3+
---
4+
5+
Drop deprecations. Migration steps:
6+
7+
- use `CLERK_SECRET_KEY` instead of `CLERK_API_KEY` env variable
8+
- use `secretKey` instead of `apiKey`
9+
- use `CLERK_PUBLISHABLE_KEY` instead of `CLERK_FRONTEND_API` env variable
10+
- use `publishableKey` instead of `frontendApi`
11+
- drop Redwood hotfix (upgrade to latest version)
12+
- use `createClerkClient` with options to create a new clerkClient instead of using
13+
the following setters:
14+
- `setClerkApiVersion`
15+
- `setClerkHttpOptions`
16+
- `setClerkServerApiUrl`
17+
- `setClerkApiKey`
18+
- use `@clerk/clerk-sdk-node` instead of `@clerk/clerk-sdk-node/{cjs|esm}/instance`
19+
20+
Extra:
21+
- bundle only index.ts and instance.ts

packages/sdk-node/cjs/instance.d.ts

Lines changed: 0 additions & 2 deletions
This file was deleted.

packages/sdk-node/cjs/instance.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/sdk-node/esm/instance.d.ts

Lines changed: 0 additions & 2 deletions
This file was deleted.

packages/sdk-node/esm/instance.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/sdk-node/examples/node/src/allowlistIdentifiers.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
// Usage:
22
// From examples/node, run files with "npm test ./src/allowlistIdentifiers.ts"
3-
import {
4-
allowlistIdentifiers,
5-
setClerkServerApiUrl,
6-
} from '@clerk/clerk-sdk-node';
7-
8-
const serverApiUrl = process.env.CLERK_API_URL || '';
9-
10-
setClerkServerApiUrl(serverApiUrl);
3+
import { allowlistIdentifiers } from '@clerk/clerk-sdk-node';
114

125
// Add an allowlist identifier
136
await allowlistIdentifiers.createAllowlistIdentifier({

packages/sdk-node/examples/node/src/clients.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ try {
3131

3232
try {
3333
console.log('Get client list with invalid API key');
34-
clerk.apiKey = 'snafu';
34+
clerk.secretKey = 'snafu';
3535
const invalidClients = await clerk.clients.getClientList();
3636
console.log(invalidClients);
3737
} catch (error) {

packages/sdk-node/jest.setup.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
process.env.CLERK_API_KEY = 'TEST_API_KEY';
2-
process.env.CLERK_SECRET_KEY = 'TEST_API_KEY';
1+
process.env.CLERK_SECRET_KEY = 'TEST_SECRET_KEY';

packages/sdk-node/package.json

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,25 @@
2424
},
2525
"exports": {
2626
".": {
27-
"types": "./dist/types/index.d.ts",
28-
"require": "./dist/cjs/index.js",
29-
"import": "./dist/esm/index.mjs",
30-
"default": "./dist/cjs/index.js"
27+
"import": {
28+
"types": "./dist/index.d.mts",
29+
"default": "./dist/index.mjs"
30+
},
31+
"require": {
32+
"types": "./dist/index.d.ts",
33+
"default": "./dist/index.js"
34+
}
3135
},
32-
"./esm/instance": {
33-
"types": "./dist/types/instance.d.ts",
34-
"require": "./dist/cjs/instance.js",
35-
"import": "./dist/esm/instance.mjs",
36-
"default": "./dist/cjs/instance.js"
37-
},
38-
"./cjs/instance": {
39-
"types": "./dist/types/instance.d.ts",
40-
"require": "./dist/cjs/instance.js",
41-
"import": "./dist/esm/instance.mjs",
42-
"default": "./dist/cjs/instance.js"
43-
}
36+
"./package.json": "./package.json"
4437
},
45-
"main": "./dist/cjs/index.js",
46-
"module": "./dist/esm/index.mjs",
47-
"types": "./dist/types/index.d.ts",
38+
"main": "./dist/index.js",
4839
"files": [
49-
"dist",
50-
"esm",
51-
"cjs"
40+
"dist"
5241
],
5342
"scripts": {
5443
"build": "npm run clean && tsup",
5544
"dev": "tsup --watch",
5645
"dev:publish": "npm run dev -- --env.publish",
57-
"build:declarations": "tsc -p tsconfig.declarations.json",
5846
"publish:local": "npx yalc push --replace --sig",
5947
"clean": "rimraf ./dist",
6048
"lint": "eslint src/",

packages/sdk-node/scripts/info.js

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)