diff --git a/.changeset/fast-games-hide.md b/.changeset/fast-games-hide.md new file mode 100644 index 0000000000..e4c04b3602 --- /dev/null +++ b/.changeset/fast-games-hide.md @@ -0,0 +1,39 @@ +--- +'@clerk/chrome-extension': major +'@clerk/clerk-js': major +'@clerk/nextjs': major +'@clerk/shared': major +'@clerk/clerk-react': major +'@clerk/types': major +'@clerk/clerk-expo': major +--- + +Drop deprecations. Migration steps: +- use `publishableKey` instead of `frontendApi` +- use `Clerk.handleEmailLinkVerification()` instead of `Clerk.handleMagicLinkVerification()` +- use `isEmailLinkError` instead of `isMagicLinkError` +- use `EmailLinkErrorCode` instead of `MagicLinkErrorCode` +- use `useEmailLink` instead of `useMagicLink` +- drop `orgs` jwt claim from session token +- use `ExternalAccount.imageUrl` instead of `ExternalAccount.avatarUrl` +- use `Organization.imageUrl` instead of `Organization.logoUrl` +- use `User.imageUrl` instead of `User.profileImageUrl` +- use `OrganizationMembershipPublicUserData.imageUrl` instead of `OrganizationMembershipPublicUserData.profileImageUrl` +- use `useOrganizationList` instead of `useOrganizations` +- use `userProfileProps` instead of `userProfile` in `Appearance` +- use `Clerk.setActive()` instead of `Clerk.setSession()` +- drop `password` param in `User.update()` +- use `afterSelectOrganizationUrl` instead of `afterSwitchOrganizationUrl` in `OrganizationSwitcher` +- drop `Clerk.experimental_canUseCaptcha` / `Clerk.Clerk.experimental_captchaSiteKey` / `Clerk.experimental_captchaURL` (were meant for internal use) +- use `User.getOrganizationMemberships()` instead of `Clerk.getOrganizationMemberships()` +- drop `lastOrganizationInvitation` / `lastOrganizationMember` from Clerk emitted events +- drop `Clerk.__unstable__invitationUpdate` / `Clerk.__unstable__membershipUpdate` +- drop support for string param in `Organization.create()` +- use `Organization.getInvitations()` instead of `Organization.getPendingInvitations()` +- use `pageSize` instead of `limit` in `OrganizationMembership.retrieve()` +- use `initialPage` instead of `offset` in `OrganizationMembership.retrieve()` +- drop `lastOrganizationInvitation` / `lastOrganizationMember` from ClerkProvider +- use `invitations` instead of `invitationList` in `useOrganization` +- use `memberships` instead of `membershipList` in `useOrganization` +- use `redirectUrl` instead of `redirect_url` in `User.createExternalAccount()` +- use `signature` instead of `generatedSignature` in `Signup.attemptWeb3WalletVerification()` diff --git a/.vscode/settings.json b/.vscode/settings.json index ca332e07ee..87589341d8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,5 +5,24 @@ "editor.codeActionsOnSave": { "source.fixAll.eslint": true, }, - "eslint.workingDirectories": [{ "mode": "auto" }], + "eslint.workingDirectories": [ + { + "mode": "auto" + } + ], + "cSpell.words": [ + "accountsstage", + "adduser", + "arethetypeswrong", + "attw", + "BAPI", + "citty", + "execa", + "FAPI", + "jwks", + "lclclerk", + "lclstage", + "nextjs", + "publint" + ], } diff --git a/packages/chrome-extension/src/__snapshots__/exports.test.ts.snap b/packages/chrome-extension/src/__snapshots__/exports.test.ts.snap index 5a4bbc8806..5850b5cf88 100644 --- a/packages/chrome-extension/src/__snapshots__/exports.test.ts.snap +++ b/packages/chrome-extension/src/__snapshots__/exports.test.ts.snap @@ -41,7 +41,6 @@ exports[`public exports should not include a breaking change 1`] = ` "useEmailLink", "useOrganization", "useOrganizationList", - "useOrganizations", "useSession", "useSessionList", "useSignIn", diff --git a/packages/clerk-js/README.md b/packages/clerk-js/README.md index 8bdf9b8a95..d0a3a3d6bb 100644 --- a/packages/clerk-js/README.md +++ b/packages/clerk-js/README.md @@ -44,13 +44,13 @@ There are two ways you can include ClerkJS in your project. You can either [impo npm install @clerk/clerk-js ``` -Once you have installed the package, you will need to import the ClerkJS object constructor into your code and pass it your [Frontend API](https://dashboard.clerk.com/last-active?path=api-keys) as a parameter. +Once you have installed the package, you will need to import the ClerkJS object constructor into your code and pass it your [Publishable Key](https://dashboard.clerk.com/last-active?path=api-keys) as a parameter. ```js import Clerk from '@clerk/clerk-js'; -const clerkFrontendApi = 'pk_[publishable_key]'; -const clerk = new Clerk(clerkFrontendApi); +const clerkPublishableKey = 'pk_[publishable_key]'; +const clerk = new Clerk(clerkPublishableKey); await clerk.load({ // Set load options here... }); @@ -65,14 +65,13 @@ Add the following script to your site's `
` element: ```html