@clerk/upgrade 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/app.js +136 -0
- package/dist/cli.js +50 -0
- package/dist/constants/sdks.js +46 -0
- package/dist/constants/versions.js +7 -0
- package/dist/scan.js +103 -0
- package/dist/test.js +100 -0
- package/dist/util/expandable-list.js +143 -0
- package/dist/util/generate-changelog.js +28 -0
- package/dist/util/get-clerk-version.js +7 -0
- package/dist/util/guess-framework.js +22 -0
- package/dist/util/load-change.js +31 -0
- package/dist/util/step-sequencer.js +31 -0
- package/dist/util/test.js +100 -0
- package/dist/versions/v5/backend/clerk-import.md +15 -0
- package/dist/versions/v5/backend/clockskewinseconds.md +7 -0
- package/dist/versions/v5/backend/createclerkclient-apikey.md +21 -0
- package/dist/versions/v5/backend/createclerkclient-frontendapi.md +21 -0
- package/dist/versions/v5/backend/externalaccount-picture.md +0 -0
- package/dist/versions/v5/backend/externalaccountjson-avatarurl.md +0 -0
- package/dist/versions/v5/backend/getpendingorganizationinvitationlist.md +12 -0
- package/dist/versions/v5/backend/organization-logourl.md +0 -0
- package/dist/versions/v5/backend/organizationjson-logourl.md +0 -0
- package/dist/versions/v5/backend/organizationmembershippublicuserdata-profileimageurl.md +0 -0
- package/dist/versions/v5/backend/organizationmembershippublicuserdatajson-profileimageurl.md +0 -0
- package/dist/versions/v5/backend/pkgversion.md +0 -0
- package/dist/versions/v5/backend/user-profileimageurl.md +0 -0
- package/dist/versions/v5/backend/userjson-profileimageurl.md +0 -0
- package/dist/versions/v5/chromeExtension/clerkprovider-tokencache.md +26 -0
- package/dist/versions/v5/common/api-key-to-secret-key.md +6 -0
- package/dist/versions/v5/common/clerkprovider-frontendapi.md +7 -0
- package/dist/versions/v5/common/frontend-api-to-publishable-key.md +6 -0
- package/dist/versions/v5/common/handlemagiclinkverification.md +7 -0
- package/dist/versions/v5/common/ismagiclinkerror.md +7 -0
- package/dist/versions/v5/common/magiclinkerror.md +7 -0
- package/dist/versions/v5/common/magiclinkerrorcode.md +7 -0
- package/dist/versions/v5/common/navigate-to-routerpush-routerreplace.md +16 -0
- package/dist/versions/v5/common/setsession.md +32 -0
- package/dist/versions/v5/common/usemagiclink.md +7 -0
- package/dist/versions/v5/expo/apikey-to-publishable-key.md +6 -0
- package/dist/versions/v5/expo/clerkprovider-frontendapi.md +17 -0
- package/dist/versions/v5/fastify/api-url-value-change.md +6 -0
- package/dist/versions/v5/fastify/clerkplugin-frontendapi.md +17 -0
- package/dist/versions/v5/fastify/createclerkclient-apikey.md +17 -0
- package/dist/versions/v5/fastify/createclerkclient-frontendapi.md +17 -0
- package/dist/versions/v5/gatsby/api-url-value-change.md +6 -0
- package/dist/versions/v5/gatsby/apikey-to-publishable-key.md +6 -0
- package/dist/versions/v5/gatsby/createclerkclient-apikey.md +17 -0
- package/dist/versions/v5/gatsby/createclerkclient-frontendapi.md +17 -0
- package/dist/versions/v5/gatsby/withserverauth-return-type.md +43 -0
- package/dist/versions/v5/index.js +63 -0
- package/dist/versions/v5/js/afterswitchorganizationurl.md +15 -0
- package/dist/versions/v5/js/appearance-organizationpreview-organizationswitcher.md +8 -0
- package/dist/versions/v5/js/experimental-canusecaptcha.md +6 -0
- package/dist/versions/v5/js/experimental-captchasitekey.md +6 -0
- package/dist/versions/v5/js/experimental-captchaurl.md +6 -0
- package/dist/versions/v5/js/external-account-avatarurl.md +7 -0
- package/dist/versions/v5/js/getorganizationmemberships.md +14 -0
- package/dist/versions/v5/js/lastorganizationinvitation-member.md +6 -0
- package/dist/versions/v5/js/organization-create-string.md +15 -0
- package/dist/versions/v5/js/organization-getpendinginvitations.md +14 -0
- package/dist/versions/v5/js/organization-logourl.md +7 -0
- package/dist/versions/v5/js/redirecttohome.md +13 -0
- package/dist/versions/v5/js/signup-attemptweb3walletverification-generatedsignature.md +20 -0
- package/dist/versions/v5/js/unstable-invitationupdate.md +6 -0
- package/dist/versions/v5/js/unstable-membershipupdate.md +6 -0
- package/dist/versions/v5/js/useorganization-invitationlist.md +25 -0
- package/dist/versions/v5/js/useorganization-membershiplist.md +24 -0
- package/dist/versions/v5/js/useorganizations.md +26 -0
- package/dist/versions/v5/js/user-createexternalaccount-redirecturl.md +7 -0
- package/dist/versions/v5/js/user-orgpublicdata-profileimageurl.md +7 -0
- package/dist/versions/v5/js/user-update-password.md +19 -0
- package/dist/versions/v5/js/userprofile-prop.md +7 -0
- package/dist/versions/v5/next/api-url-value-change.md +6 -0
- package/dist/versions/v5/next/auth-middleware-deprecated.md +10 -0
- package/dist/versions/v5/next/authmiddleware-apikey.md +17 -0
- package/dist/versions/v5/next/authmiddleware-frontendapi.md +9 -0
- package/dist/versions/v5/next/clerk-js-version-next-public.md +8 -0
- package/dist/versions/v5/next/createclerkclient-apikey.md +17 -0
- package/dist/versions/v5/next/createclerkclient-frontendapi.md +17 -0
- package/dist/versions/v5/next/getauth-apikey.md +9 -0
- package/dist/versions/v5/next/import-api-url.md +7 -0
- package/dist/versions/v5/next/import-api-version.md +7 -0
- package/dist/versions/v5/next/import-clerk-js-url.md +7 -0
- package/dist/versions/v5/next/import-clerk-js-version.md +7 -0
- package/dist/versions/v5/next/import-domain.md +7 -0
- package/dist/versions/v5/next/import-is-satellite.md +7 -0
- package/dist/versions/v5/next/import-nextjs-api.md +22 -0
- package/dist/versions/v5/next/import-nextjs-app-beta.md +10 -0
- package/dist/versions/v5/next/import-nextjs-edge-middleware.md +6 -0
- package/dist/versions/v5/next/import-nextjs-edge-middlewarefiles.md +6 -0
- package/dist/versions/v5/next/import-nextjs-ssr.md +7 -0
- package/dist/versions/v5/next/import-proxy-url.md +7 -0
- package/dist/versions/v5/next/import-publishable-key.md +7 -0
- package/dist/versions/v5/next/import-secret-key.md +7 -0
- package/dist/versions/v5/next/import-sign-in-url.md +7 -0
- package/dist/versions/v5/next/import-sign-up-url.md +6 -0
- package/dist/versions/v5/next/with-clerk-middleware-removed.md +10 -0
- package/dist/versions/v5/node/api-url-value-change.md +6 -0
- package/dist/versions/v5/node/cjs-esm-instance.md +16 -0
- package/dist/versions/v5/node/clerkexpressrequireauth-apikey.md +17 -0
- package/dist/versions/v5/node/clerkexpressrequireauth-frontendapi.md +17 -0
- package/dist/versions/v5/node/clerkexpresswithauth-apikey.md +17 -0
- package/dist/versions/v5/node/clerkexpresswithauth-frontendapi.md +17 -0
- package/dist/versions/v5/node/createclerkclient-apikey.md +17 -0
- package/dist/versions/v5/node/createclerkclient-frontendapi.md +17 -0
- package/dist/versions/v5/node/createclerkexpressrequireauth-apikey.md +17 -0
- package/dist/versions/v5/node/createclerkexpressrequireauth-frontendapi.md +17 -0
- package/dist/versions/v5/node/createclerkexpresswithauth-apikey.md +17 -0
- package/dist/versions/v5/node/createclerkexpresswithauth-frontendapi.md +17 -0
- package/dist/versions/v5/node/package-rename.md +6 -0
- package/dist/versions/v5/node/setclerkapikey.md +17 -0
- package/dist/versions/v5/node/setclerkapiversion.md +17 -0
- package/dist/versions/v5/node/setclerkhttpoptions.md +17 -0
- package/dist/versions/v5/node/setclerkserverapiurl.md +20 -0
- package/dist/versions/v5/react/api-url-value-change.md +6 -0
- package/dist/versions/v5/shared/buildrequesturl.md +14 -0
- package/dist/versions/v5/shared/organizationcontext.md +7 -0
- package/dist/versions/v5/shared/useorganizationlist-organizationlist.md +19 -0
- package/package.json +63 -0
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`SIGN_UP_URL` constant removed'
|
|
3
|
+
matcher: "SIGN_UP_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
This deprecated constant has been removed as an export from `@clerk/nextjs`. We recommend setting the `NEXT_PUBLIC_CLERK_SIGN_UP_URL` environment variable and using this instead.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'withClerkMiddleware removed'
|
|
3
|
+
matcher: 'withClerkMiddleware'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
`withClerkMiddleware` has been deprecated and is now removed in v5. We recommend moving to `clerkMiddleware` instead. Here’s an example of how the code would look before and after:
|
|
7
|
+
|
|
8
|
+
```js
|
|
9
|
+
// TODO
|
|
10
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`API_URL` value has changed'
|
|
3
|
+
matcher: "API_URL.*?from\\s['\"]@clerk\\/clerk-sdk-node['\"]"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
- The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`cjs/instance` and `esm/instance` imports no longer needed'
|
|
3
|
+
matcher: "@clerk\\/clerk-sdk-node\\/(?:cjs|esm)\\/instance"
|
|
4
|
+
replaceWithString: '@clerk/clerk-sdk-node'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
If you are using either of these import paths, they are no longer necessary and you can import directly from the top level `@clerk/express` path.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
// before
|
|
11
|
+
import { ... } from "@clerk/clerk-sdk-node/esm/instance";
|
|
12
|
+
import { ... } from "@clerk/clerk-sdk-node/cjs/instance";
|
|
13
|
+
|
|
14
|
+
// after
|
|
15
|
+
import { ... } from "@clerk/clerk-sdk-node";
|
|
16
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`apiKey` -> `secretKey` as param to ClerkExpressRequireAuth'
|
|
3
|
+
matcher: "ClerkExpressRequireAuth\\({.*?apiKey:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `apiKey` argument passed to `ClerkExpressRequireAuth` must be changed to `secretKey`.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { ClerkExpressRequireAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
ClerkExpressRequireAuth({ apiKey: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
ClerkExpressRequireAuth({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`frontendApi` -> `publishableKey` as param to ClerkExpressRequireAuth'
|
|
3
|
+
matcher: "ClerkExpressRequireAuth\\({.*?frontendApi:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `frontendApi` argument passed to `ClerkExpressRequireAuth` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { ClerkExpressRequireAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
ClerkExpressRequireAuth({ frontendApi: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
ClerkExpressRequireAuth({ publishableKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`apiKey` -> `secretKey` as param to ClerkExpressWithAuth'
|
|
3
|
+
matcher: "ClerkExpressWithAuth\\({.*?apiKey:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `apiKey` argument passed to `ClerkExpressWithAuth` must be changed to `secretKey`.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { ClerkExpressWithAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
ClerkExpressWithAuth({ apiKey: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
ClerkExpressWithAuth({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`frontendApi` -> `publishableKey` as param to ClerkExpressWithAuth'
|
|
3
|
+
matcher: "ClerkExpressWithAuth\\({.*?frontendApi:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `frontendApi` argument passed to `ClerkExpressWithAuth` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { ClerkExpressWithAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
ClerkExpressWithAuth({ frontendApi: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
ClerkExpressWithAuth({ publishableKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`apiKey` -> `secretKey` as param to createClerkClient'
|
|
3
|
+
matcher: "createClerkClient\\({.*?apiKey:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkClient } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkClient({ apiKey: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkClient({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
|
|
3
|
+
matcher: "createClerkClient\\({.*?frontendApi:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `frontendApi` argument passed to `createClerkClient` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkClient } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkClient({ frontendApi: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkClient({ publishableKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`apiKey` -> `secretKey` as param to createClerkExpressRequireAuth'
|
|
3
|
+
matcher: "createClerkExpressRequireAuth\\({.*?apiKey:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `apiKey` argument passed to `createClerkExpressRequireAuth` must be changed to `secretKey`.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkExpressRequireAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkExpressRequireAuth({ apiKey: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkExpressRequireAuth({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`frontendApi` -> `publishableKey` as param to createClerkExpressRequireAuth'
|
|
3
|
+
matcher: "createClerkExpressRequireAuth\\({.*?frontendApi:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `frontendApi` argument passed to `createClerkExpressRequireAuth` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkExpressRequireAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkExpressRequireAuth({ frontendApi: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkExpressRequireAuth({ publishableKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`apiKey` -> `secretKey` as param to createClerkExpressWithAuth'
|
|
3
|
+
matcher: "createClerkExpressWithAuth\\({.*?apiKey:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `apiKey` argument passed to `createClerkExpressWithAuth` must be changed to `secretKey`.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkExpressWithAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkExpressWithAuth({ apiKey: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkExpressWithAuth({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`frontendApi` -> `publishableKey` as param to createClerkExpressWithAuth'
|
|
3
|
+
matcher: "createClerkExpressWithAuth\\({.*?frontendApi:.*?}\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `frontendApi` argument passed to `createClerkExpressWithAuth` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import { createClerkExpressWithAuth } from '@clerk/clerk-sdk-node';
|
|
11
|
+
|
|
12
|
+
// before
|
|
13
|
+
createClerkExpressWithAuth({ frontendApi: '...' });
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
createClerkExpressWithAuth({ publishableKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`@clerk/clerk-sdk-node` renamed to `@clerk/express`'
|
|
3
|
+
matcher: "@clerk\\/clerk-sdk-node"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
This package has been renamed to `@clerk/express` and the `@clerk/clerk-sdk-node` package is now deprecated. Note that any other changes listed under the node sdk describe steps needed to migrate to `@clerk/express`, rather than changes needed for `@clerk/clerk-sdk-node`, which will not change aside from security updates from here forward.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`setClerkApiKey` removed, pass `secretKey` to `createClerkClient` instead'
|
|
3
|
+
matcher: "setClerkApiKey\\("
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail. Note that the name `apiKey` should now be `secretKey` as well.
|
|
7
|
+
|
|
8
|
+
```js
|
|
9
|
+
import { createClerkClient, setClerkApiKey } from '@clerk/clerk-sdk-node';
|
|
10
|
+
|
|
11
|
+
// Before
|
|
12
|
+
const clerkClient = createClerkClient({ apiKey: '...' });
|
|
13
|
+
setClerkApiKey('...');
|
|
14
|
+
|
|
15
|
+
// After
|
|
16
|
+
const clerkClient = createClerkClient({ secretKey: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`setClerkApiVersion` removed, pass options to `createClerkClient` instead'
|
|
3
|
+
matcher: "setClerkApiVersion\\("
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.
|
|
7
|
+
|
|
8
|
+
```js
|
|
9
|
+
import { clerkClient, setClerkApiKey } from '@clerk/clerk-sdk-node';
|
|
10
|
+
|
|
11
|
+
// Before
|
|
12
|
+
const clerkClient = createClerkClient({ apiKey: '...' });
|
|
13
|
+
setClerkApiVersion('...');
|
|
14
|
+
|
|
15
|
+
// After
|
|
16
|
+
const clerkClient = createClerkClient({ secretKey: '...', apiVersion: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`setClerkHttpOptions` removed, pass options to `createClerkClient` instead'
|
|
3
|
+
matcher: "setClerkHttpOptions\\("
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.
|
|
7
|
+
|
|
8
|
+
```js
|
|
9
|
+
import { clerkClient, setClerkApiKey } from '@clerk/clerk-sdk-node';
|
|
10
|
+
|
|
11
|
+
// Before
|
|
12
|
+
const clerkClient = createClerkClient({ apiKey: '...' });
|
|
13
|
+
setClerkHttpOptions('...');
|
|
14
|
+
|
|
15
|
+
// After
|
|
16
|
+
const clerkClient = createClerkClient({ secretKey: '...', httpOptions: '...' });
|
|
17
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`setClerkServerApiUrl` removed, pass options to `createClerkClient` instead'
|
|
3
|
+
matcher: "setClerkServerApiUrl\\("
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.
|
|
7
|
+
|
|
8
|
+
```js
|
|
9
|
+
import { clerkClient, setClerkApiKey } from '@clerk/clerk-sdk-node';
|
|
10
|
+
|
|
11
|
+
// Before
|
|
12
|
+
const clerkClient = createClerkClient({ apiKey: '...' });
|
|
13
|
+
setClerkServerApiUrl('...');
|
|
14
|
+
|
|
15
|
+
// After
|
|
16
|
+
const clerkClient = createClerkClient({
|
|
17
|
+
secretKey: '...',
|
|
18
|
+
serverApiURL: '...',
|
|
19
|
+
});
|
|
20
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`API_URL` value has changed'
|
|
3
|
+
matcher: "API_URL.*?from\\s['\"]@clerk\\/clerk-react['\"]"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
- The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`getRequestUrl` -> `buildRequestUrl` from `@clerk/backend`'
|
|
3
|
+
matcher: "getRequestUrl\\("
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
```js
|
|
7
|
+
// before
|
|
8
|
+
import { getRequestUrl } from '@clerk/shared/proxy';
|
|
9
|
+
const url = getRequestUrl(req, '/your/path');
|
|
10
|
+
|
|
11
|
+
// after
|
|
12
|
+
import { buildRequestUrl } from '@clerk/backend';
|
|
13
|
+
const url = buildRequestUrl(/* ??? */);
|
|
14
|
+
```
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`OrganizationContext` -> `OrganizationProvider`'
|
|
3
|
+
matcher: 'OrganizationContext'
|
|
4
|
+
replaceWithString: 'OrganizationProvider'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The name of the `OrganizationContext` provider has been changed to `OrganizationProvider` to more accurately reflect its functionality. There are no changes in functionality, just a name change, this can safely be treated as a text replacement.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '`organizationList` -> `userMemberships` as param to `useOrganizationList`'
|
|
3
|
+
matcher: "useOrganizationList\\(\\s*{[\\s\\S]*?organizationList:[\\s\\S]*?\\)"
|
|
4
|
+
matcherFlags: 'm'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The deprecated `organizationList` param to `useOrganizationList` has been removed. Instead, use the `userMemberships` param. Note that the values to be passed to the param and the return value have also changed.
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
// before
|
|
11
|
+
const { organizationList } = useOrganizationList({
|
|
12
|
+
organizationList: { limit: 10, offset: 1 },
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
// after
|
|
16
|
+
const { memberships } = useOrganizationList({
|
|
17
|
+
userMemberships: { initialPage: 1, pageSize: 10 },
|
|
18
|
+
});
|
|
19
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@clerk/upgrade",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": "dist/cli.js",
|
|
7
|
+
"files": [
|
|
8
|
+
"dist"
|
|
9
|
+
],
|
|
10
|
+
"scripts": {
|
|
11
|
+
"build": "babel --out-dir=dist source --copy-files",
|
|
12
|
+
"dev": "babel --out-dir=dist --watch source --copy-files",
|
|
13
|
+
"test": "prettier --check . && xo && ava"
|
|
14
|
+
},
|
|
15
|
+
"babel": {
|
|
16
|
+
"presets": [
|
|
17
|
+
"@babel/preset-react"
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
"ava": {
|
|
21
|
+
"environmentVariables": {
|
|
22
|
+
"NODE_NO_WARNINGS": "1"
|
|
23
|
+
},
|
|
24
|
+
"nodeArguments": [
|
|
25
|
+
"--loader=import-jsx"
|
|
26
|
+
]
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@inkjs/ui": "^1.0.0",
|
|
30
|
+
"globby": "^14.0.0",
|
|
31
|
+
"gray-matter": "^4.0.3",
|
|
32
|
+
"index-to-position": "^0.1.2",
|
|
33
|
+
"ink": "^4.4.1",
|
|
34
|
+
"ink-big-text": "^2.0.0",
|
|
35
|
+
"ink-gradient": "^3.0.0",
|
|
36
|
+
"ink-link": "^3.0.0",
|
|
37
|
+
"ink-markdown": "jescalan/ink-markdown#release",
|
|
38
|
+
"marked": "^11.1.1",
|
|
39
|
+
"meow": "^11.0.0",
|
|
40
|
+
"react": "^18.2.0",
|
|
41
|
+
"read-pkg": "^9.0.1",
|
|
42
|
+
"semver-regex": "^4.0.5"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@babel/cli": "^7.21.0",
|
|
46
|
+
"@babel/preset-react": "^7.18.6",
|
|
47
|
+
"@vdemedes/prettier-config": "^2.0.1",
|
|
48
|
+
"ava": "^5.2.0",
|
|
49
|
+
"chalk": "^5.2.0",
|
|
50
|
+
"eslint-config-xo-react": "^0.27.0",
|
|
51
|
+
"eslint-plugin-react": "^7.32.2",
|
|
52
|
+
"eslint-plugin-react-hooks": "^4.6.0",
|
|
53
|
+
"import-jsx": "^5.0.0",
|
|
54
|
+
"ink-testing-library": "^3.0.0",
|
|
55
|
+
"prettier": "^2.8.7"
|
|
56
|
+
},
|
|
57
|
+
"engines": {
|
|
58
|
+
"node": ">=16"
|
|
59
|
+
},
|
|
60
|
+
"publishConfig": {
|
|
61
|
+
"access": "public"
|
|
62
|
+
}
|
|
63
|
+
}
|