chore(clerk-js): Drop deprecations #2082

dimkl · 2023-11-08T12:53:48Z

Description

This PR contains also changes in react, expo, chrome-extension, types, shared, nextjs packages due to types being changed or to code being exported or re-used by other packages.

Drop deprecations. Migration steps:

use publishableKey instead of frontendApi
use Clerk.handleEmailLinkVerification() instead of Clerk.handleMagicLinkVerification()
use EmailLinkError instead of MagicLinkError
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()

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Packages affected

changeset-bot · 2023-11-08T12:53:52Z

🦋 Changeset detected

Latest commit: c195500

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages

Name	Type
@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
@clerk/backend	Patch
@clerk/fastify	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch
gatsby-plugin-clerk	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

dimkl · 2023-11-08T12:57:49Z

@panteliselef The only deprecations still in the clerk-js package are related to the following components:

Form.tsx: Control is deprecated in favor of Form.PlainInput
RadioGroup.tsx: RadioGroup and RadioGroupItem are being deprecated
FormControl.tsx: FormControl is deprecated in favor of Field.Root
useFormControl.tsx: has some deprecations

How should we proceed with those?

panteliselef · 2023-11-08T15:06:36Z

@panteliselef The only deprecations still in the clerk-js package are related to the following components:

Form.tsx: Control is deprecated in favor of Form.PlainInput

RadioGroup.tsx: RadioGroup and RadioGroupItem are being deprecated

FormControl.tsx: FormControl is deprecated in favor of Field.Root

useFormControl.tsx: has some deprecations

How should we proceed with those?

@dimkl you are correct, these are marked as deprecated as removing them completely and introducing new ones would result an a PR with a lot of changes what would make the reviewal process almost impossible.

I hope i will tackle this by end of this week, but also want to mention that this does not really affect external APIs, and anything that you listed as deprecated is for internal use only

packages/clerk-js/src/core/clerk.redirects.test.ts

packages/clerk-js/src/core/clerk.ts

packages/clerk-js/src/core/fapiClient.test.ts

packages/clerk-js/src/core/resources/Organization.ts

panteliselef · 2023-11-09T13:05:19Z

packages/types/src/jwt.ts

@@ -11,7 +11,7 @@ export interface JWTHeader {
  alg: string | Algorithm;
  typ?: string;
  cty?: string;
-  crit?: Array<string | Exclude<keyof JWTHeader, 'crit'>>;
+  crit?: Array<string | Exclude<JWTHeader, 'crit'>>;


Does this mean previously this was broken ?

@panteliselef based on the RFC: https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1.11
The crit header parameter

should NOT be an empty array

should not include crit (not sure about this but it's already defined)

The above change does not fix it, so i will update it to crit: NonEmptyArray<Exclude<keyof JWTHeader, 'crit'>>; to resolve this. I did some tests and it passes.

PS: type NonEmptyArray<T> = [T, ...T[]];

packages/clerk-js/src/ui/components/UserProfile/__tests__/ProfilePage.test.tsx

packages/clerk-js/src/ui/components/UserButton/useMultisessionActions.tsx

LekoArts · 2023-11-09T13:25:27Z

packages/clerk-js/src/core/resources/Organization.test.ts

@@ -8,8 +8,8 @@ describe('Organization', () => {
      name: 'test_name',
      public_metadata: { public: 'metadata' },
      slug: 'test_slug',
-      logo_url: 'https://url-for-logo.png',
-      image_url: 'https://clerk.com',
+      image_url:


Nit: Formatting

This change is made by the npm run format script based on our rules.

Seems weird 🤔

packages/clerk-js/README.md

packages/clerk-js/src/core/resources/OrganizationMembership.test.ts

packages/clerk-js/src/ui/utils/test/fixtures.ts

packages/shared/src/keys.ts

dimkl · 2023-11-09T17:40:58Z

@LekoArts , @panteliselef i have addressed your comments. PTAL (also review & resolve the comments)

- `ExternalAccount.avatarUrl` - `ExternalAccountJSON.avatar_url` - `Organization.logoUrl` - `OrganizationJSON.logo_url` - `User.profileImageUrl` - `UserJSON.profile_image_url` - `OrganizationMembershipPublicUserData.profileImageUrl` - `OrganizationMembershipPublicUserDataJSON.profile_image_url`

…t` params deprecations

…rom matchMedia return

…points

LekoArts

Did not run/test this locally but looking over the changes in GitHub this LGTM

dimkl added the v5-release label Nov 8, 2023

dimkl self-assigned this Nov 8, 2023

dimkl requested a review from a team as a code owner November 8, 2023 12:53

clerk-cookie added types clerk-js nextjs react expo chrome-extension labels Nov 8, 2023

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch from 1e4821b to 879bf78 Compare November 8, 2023 13:01

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch 2 times, most recently from 95213c4 to 85aec82 Compare November 9, 2023 09:37

clerk-cookie added the remix label Nov 9, 2023

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch from 85aec82 to c735882 Compare November 9, 2023 10:54

panteliselef reviewed Nov 9, 2023

View reviewed changes

LekoArts reviewed Nov 9, 2023

View reviewed changes

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch from c735882 to fda0693 Compare November 9, 2023 17:40

dimkl enabled auto-merge November 9, 2023 17:40

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch 2 times, most recently from 8231284 to 0ebecdf Compare November 9, 2023 19:18

dimkl mentioned this pull request Nov 9, 2023

chore(shared): Drop deprecations #2102

Merged

24 tasks

dimkl requested review from panteliselef and LekoArts November 10, 2023 08:49

dimkl added 2 commits November 10, 2023 10:50

chore(clerk-react): Drop frontendApi

19bb275

chore(clerk-react,chrome-extension): Drop *MagicLink* related exports

bafa9a4

dimkl added 19 commits November 10, 2023 10:50

chore(types): Drop *MagicLink* related exports

fa10b24

chore(clerk-js): Drop orgs claim

22d4acb

chore(clerk-js,types): Drop afterSwitchOrganizationUrl claim

5fac548

chore(clerk-js): Drop support for frontendApi as parameter

60f6857

chore(clerk-js,types): Drop *captcha related methods from Clerk

77103d9

chore(clerk-js,types): Drop Organization related deprecations

af93de6

chore(*): Drop useOrganizations

d7ccdab

chore(clerk-js,types): Drop appearance.userProfile

b00a5b8

chore(clerk-js,clerk-react): Drop membershipList and `invitationLis…

730e044

…t` params deprecations

chore(clerk-js,types): Drop Clerk.setSession

e8a74d4

chore(clerk-js,types): Drop redirect_url deprecations

c92c48c

chore(clerk-js,types): Drop GetMembershipsParams

2dc560a

chore(clerk-js): Drop generateSignature

750ba6c

chore(clerk-js,types): Drop password

1039bd2

chore(clerk-js,types): Drop deprecated addListener/removeListener f…

418ba18

…rom matchMedia return

chore(repo): Add word spelling in vscode workspace + fix typos

0444da0

chore(clerk-js,types): Use paginated responses in get memberships end…

1093fd6

…points

chore(repo): Add changeset

07a9238

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch from 0ebecdf to defbbd0 Compare November 10, 2023 08:53

chore(clerk-js,types): Address PR comments

c195500

dimkl force-pushed the sdk-782-drop-deprecations-clerk-js branch from defbbd0 to c195500 Compare November 10, 2023 08:57

LekoArts approved these changes Nov 10, 2023

View reviewed changes

dimkl added this pull request to the merge queue Nov 10, 2023

Merged via the queue into main with commit 7f833da Nov 10, 2023
6 checks passed

dimkl deleted the sdk-782-drop-deprecations-clerk-js branch November 10, 2023 10:10

panteliselef approved these changes Nov 10, 2023

View reviewed changes

clerk-cookie mentioned this pull request Nov 10, 2023

Version Packages (alpha-v5) #2065

Merged

dimkl mentioned this pull request Nov 29, 2023

chore(types): Drop unused SetSession type #2231

Merged

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(clerk-js): Drop deprecations #2082

chore(clerk-js): Drop deprecations #2082

dimkl commented Nov 8, 2023 •

edited

Loading

changeset-bot bot commented Nov 8, 2023 •

edited

Loading

dimkl commented Nov 8, 2023

panteliselef commented Nov 8, 2023

panteliselef Nov 9, 2023

dimkl Nov 9, 2023

LekoArts Nov 9, 2023

dimkl Nov 9, 2023

LekoArts Nov 10, 2023

dimkl commented Nov 9, 2023

LekoArts left a comment

chore(clerk-js): Drop deprecations #2082

chore(clerk-js): Drop deprecations #2082

Conversation

dimkl commented Nov 8, 2023 • edited Loading

Description

Checklist

Type of change

Packages affected

changeset-bot bot commented Nov 8, 2023 • edited Loading

🦋 Changeset detected

dimkl commented Nov 8, 2023

panteliselef commented Nov 8, 2023

panteliselef Nov 9, 2023

Choose a reason for hiding this comment

dimkl Nov 9, 2023

Choose a reason for hiding this comment

LekoArts Nov 9, 2023

Choose a reason for hiding this comment

dimkl Nov 9, 2023

Choose a reason for hiding this comment

LekoArts Nov 10, 2023

Choose a reason for hiding this comment

dimkl commented Nov 9, 2023

LekoArts left a comment

Choose a reason for hiding this comment

dimkl commented Nov 8, 2023 •

edited

Loading

changeset-bot bot commented Nov 8, 2023 •

edited

Loading