@clerk/upgrade 0.2.0 → 0.3.0

package/dist/versions/v5/common/getorganizationmembershiplist-return-type-change.md

@@ -1,6 +1,7 @@
 ---
-title: '`User.getOrganizationMembershipList()` return type changed'
+title: '`User.getOrganizationMembershipList` return type changed'
 matcher: "\\.getOrganizationMembershipList\\("
+category: 'pagination-return'
 ---
 
 The return type for this function was previously `[Items]` but has now been updated to `{ data: [Items], totalCount: number }`. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:

package/dist/versions/v5/common/isclerkapiresponserror-import-change.md

@@ -2,6 +2,7 @@
 title: '`isClerkAPIResponseError` import moved under `/errors`'
 matcher: "import\\s+{[\\s\\S]*?isClerkAPIResponseError[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'error-imports'
 replaceWithString: 'clerk-react/errors'
 ---
 

package/dist/versions/v5/common/isemaillinkerror-import-change.md

@@ -2,6 +2,7 @@
 title: '`isEmailLinkError` import moved under `/errors`'
 matcher: "import\\s+{[\\s\\S]*?isEmailLinkError[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'error-imports'
 replaceWithString: 'clerk-react/errors'
 ---
 

package/dist/versions/v5/common/isknownerror-import-change.md

@@ -2,6 +2,7 @@
 title: '`isKnownError` import moved under `/errors`'
 matcher: "import\\s+{[\\s\\S]*?isKnownError[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'error-imports'
 replaceWithString: 'clerk-react/errors'
 ---
 

package/dist/versions/v5/common/ismetamaskerror-import-change.md

@@ -1,13 +1,14 @@
 ---
 title: '`isMetamaskError` import moved under `/errors`'
-matcher: "import\\s+{[\\s\\S]*?isMetamaskError[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?isMetamaskError[\\s\\S]*?from\\s+['\"]@clerk\\/(react)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
-replaceWithString: 'nextjs/errors'
+category: 'error-imports'
+replaceWithString: 'react/errors'
 ---
 
-The `isMetamaskError` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/errors`. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+The `isMetamaskError` import path has changed from `@clerk/react` to `@clerk/react/errors`. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
 
 ```diff
-- import { isMetamaskError } from "@clerk/nextjs"
-+ import { isMetamaskError } from "@clerk/nextjs/errors"
+- import { isMetamaskError } from "@clerk/react"
++ import { isMetamaskError } from "@clerk/react/errors"
 ```

package/dist/versions/v5/common/mfa-dropdown.md

@@ -2,6 +2,7 @@
 title: 'Within `<UserProfile />`, Multi-Factor Auth is Added via Dropdown'
 matcher: '(?:<UserProfile|<UserButton)'
 matcherFlags: 'm'
+category: 'appearance'
 warning: true
 image: true
 ---

package/dist/versions/v5/common/min-react-version.md

@@ -1,6 +1,8 @@
 ---
 title: 'Upgrade react to v18 or higher'
+category: 'version'
 matcher: "dependencies\":\\s*{[\\s\\S]*?\"react\":\\s*\"(?:^|~|>|=|\\s)*(?:12|13|14|15|16|17)\\..*?"
+matcherFlags: 'm'
 ---
 
 If you're using `react`, you will need to update your Next.js project to `v18` or later to ensure that the latest version of Clerk's SDKs work properly.

package/dist/versions/v5/common/multisessionappsupport-import-change.md

@@ -4,7 +4,7 @@ matcher: "import\\s+{[\\s\\S]*?MutliSessionAppSupport[\\s\\S]*?from\\s+['\"]@cle
 matcherFlags: 'm'
 ---
 
-`MultiSessionAppSupport` is a component that handles the intermediate “undefined” state for multisession apps by unmounting and remounting the components during the session switch (` setActive`` call) in order to solve theoretical edge-cases that can arise while switching sessions. It is undocumented and intended only for internal use, so it has been moved to an  `/internal` import path. Please note that internal imports are not intended for public use, and are outside the scope of semver.
+`MultiSessionAppSupport` is a component that handles the intermediate “undefined” state for multisession apps by unmounting and remounting the components during the session switch (`setActive` call) in order to solve theoretical edge-cases that can arise while switching sessions. It is undocumented and intended only for internal use, so it has been moved to an `/internal` import path. Please note that internal imports are not intended for public use, and are outside the scope of semver.
 
 ```diff
 - import { MultiSessionAppSupport } from '@clerk/clerk-react'

package/dist/versions/v5/common/navigate-to-routerpush-routerreplace.md

@@ -1,6 +1,7 @@
 ---
 title: '`navigate` prop to `ClerkProvider` replaced by `routerPush` and `routerReplace`'
 matcher: "<ClerkProvider[\\s\\S]*?navigate=[\\s\\S]*?>"
+category: 'routerpush-replace'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/common/new-localization-keys.md

@@ -2,6 +2,7 @@
 title: 'New localization keys added'
 matcher: "<ClerkProvider[\\s\\S]*?localization=[\\s\\S]*?>"
 matcherFlags: 'm'
+category: 'localization'
 warning: true
 ---
 
@@ -9,125 +10,125 @@ As part of the redesign of Clerk's components, a number of new localization keys
 
 ```js
 const newValues = {
-	formFieldLabel__organizationName: 'Name',
-	formFieldLabel__organizationSlug: 'Slug',
-	formFieldInputPlaceholder__emailAddresses: 'example@email.com, example2@email.com',
-	formFieldInputPlaceholder__organizationSlug: 'my-org',
-	signUp: {
-		start: {
-			subtitle: 'Welcome! Please fill in the details to get started.',
-			actionText: 'Already have an account?',
-		},
-		emailCode: {
-			subtitle: 'Enter the verification code sent to your email',
-		},
-		phoneCode: {
-			subtitle: 'Enter the verification code sent to your phone',
-		},
-		continue: {
-			subtitle: 'Please fill in the remaining details to continue.',
-			actionText: 'Already have an account?',
-		},
-	},
-	signIn: {
-		start: {
-			title: 'Sign in to {{applicationName}}',
-			subtitle: 'Welcome back! Please sign in to continue',
-			actionText: 'Don’t have an account?',
-		},
-		password: {
-			subtitle: 'Enter the password associated with your account',
-		},
-		forgotPasswordAlternativeMethods: {
-			label__alternativeMethods: 'Or, sign in with another method',
-		},
-		resetPassword: {
-			title: 'Set new password',
-		},
-		phoneCodeMfa: {
-			subtitle: 'To continue, please enter the verification code sent to your phone',
-		},
-		totpMfa: {
-			subtitle: 'To continue, please enter the verification code generated by your authenticator app',
-		},
-		backupCodeMfa: {
-			subtitle: 'Your backup code is the one you got when setting up two-step authentication.',
-		},
-	},
-	userProfile: {
-		formButtonPrimary__continue: 'Save',
-		start: {
-			headerTitle__account: 'Profile details',
-			profileSection: {
-				primaryButton: 'Edit profile',
-			},
-			emailAddressesSection: {
-				detailsAction__unverified: 'Verify',
-				destructiveAction: 'Remove email',
-			},
-			mfaSection: {
-				phoneCode: {
-					destructiveActionLabel: 'Remove',
-				},
-				backupCodes: {
-					actionLabel__regenerate: 'Regenerate',
-				},
-			},
-			dangerSection: {
-				title: 'Account termination',
-				deleteAccountButton: 'Delete account',
-			},
-		},
-		profilePage: {
-			imageFormSubtitle: 'Upload',
-			imageFormDestructiveActionSubtitle: 'Remove',
-		},
-		phoneNumberPage: {
-			title: 'Add a phone number',
-			infoText:
-				'A text message containing a verification link will be sent to this phone number. Message and data rates may apply.',
-		},
-		connectedAccountPage: {
-			socialButtonsBlockButton: '{{provider|titleize}}',
-		},
-		mfaPhoneCodePage: {
-			subtitle__availablePhoneNumbers:
-				'Select an existing phone number to register for SMS code two-step verification or add a new one.',
-			subtitle__unavailablePhoneNumbers:
-				'There are no available phone numbers to register for SMS code two-step verification, please add a new one.',
-		},
-		deletePage: {
-			actionDescription: 'Type "Delete account" below to continue.',
-		},
-	},
-	organizationSwitcher: {
-		action__createOrganization: 'Create organization',
-		action__manageOrganization: 'Manage',
-	},
-	organizationProfile: {
-		profilePage: {
-			title: 'Update Profile',
-			dangerSection: {
-				title: 'Danger',
-				leaveOrganization: {
-					actionDescription: 'Type "{{organizationName}}" below to continue.',
-				},
-				deleteOrganization: {
-					actionDescription: 'Type "{{organizationName}}" below to continue.',
-				},
-			},
-		},
-		invitePage: {
-			title: 'Invite new members',
-			subtitle: 'Enter or paste one or more email addresses, separated by spaces or commas.',
-		},
-	},
-	createOrganization: {
-		title: 'Create organization',
-	},
-	organizationList: {
-		title: 'Choose an account',
-		titleWithoutPersonal: 'Choose an organization',
-	},
+  formFieldLabel__organizationName: 'Name',
+  formFieldLabel__organizationSlug: 'Slug',
+  formFieldInputPlaceholder__emailAddresses: 'example@email.com, example2@email.com',
+  formFieldInputPlaceholder__organizationSlug: 'my-org',
+  signUp: {
+    start: {
+      subtitle: 'Welcome! Please fill in the details to get started.',
+      actionText: 'Already have an account?',
+    },
+    emailCode: {
+      subtitle: 'Enter the verification code sent to your email',
+    },
+    phoneCode: {
+      subtitle: 'Enter the verification code sent to your phone',
+    },
+    continue: {
+      subtitle: 'Please fill in the remaining details to continue.',
+      actionText: 'Already have an account?',
+    },
+  },
+  signIn: {
+    start: {
+      title: 'Sign in to {{applicationName}}',
+      subtitle: 'Welcome back! Please sign in to continue',
+      actionText: 'Don’t have an account?',
+    },
+    password: {
+      subtitle: 'Enter the password associated with your account',
+    },
+    forgotPasswordAlternativeMethods: {
+      label__alternativeMethods: 'Or, sign in with another method',
+    },
+    resetPassword: {
+      title: 'Set new password',
+    },
+    phoneCodeMfa: {
+      subtitle: 'To continue, please enter the verification code sent to your phone',
+    },
+    totpMfa: {
+      subtitle: 'To continue, please enter the verification code generated by your authenticator app',
+    },
+    backupCodeMfa: {
+      subtitle: 'Your backup code is the one you got when setting up two-step authentication.',
+    },
+  },
+  userProfile: {
+    formButtonPrimary__continue: 'Save',
+    start: {
+      headerTitle__account: 'Profile details',
+      profileSection: {
+        primaryButton: 'Edit profile',
+      },
+      emailAddressesSection: {
+        detailsAction__unverified: 'Verify',
+        destructiveAction: 'Remove email',
+      },
+      mfaSection: {
+        phoneCode: {
+          destructiveActionLabel: 'Remove',
+        },
+        backupCodes: {
+          actionLabel__regenerate: 'Regenerate',
+        },
+      },
+      dangerSection: {
+        title: 'Account termination',
+        deleteAccountButton: 'Delete account',
+      },
+    },
+    profilePage: {
+      imageFormSubtitle: 'Upload',
+      imageFormDestructiveActionSubtitle: 'Remove',
+    },
+    phoneNumberPage: {
+      title: 'Add a phone number',
+      infoText:
+        'A text message containing a verification link will be sent to this phone number. Message and data rates may apply.',
+    },
+    connectedAccountPage: {
+      socialButtonsBlockButton: '{{provider|titleize}}',
+    },
+    mfaPhoneCodePage: {
+      subtitle__availablePhoneNumbers:
+        'Select an existing phone number to register for SMS code two-step verification or add a new one.',
+      subtitle__unavailablePhoneNumbers:
+        'There are no available phone numbers to register for SMS code two-step verification, please add a new one.',
+    },
+    deletePage: {
+      actionDescription: 'Type "Delete account" below to continue.',
+    },
+  },
+  organizationSwitcher: {
+    action__createOrganization: 'Create organization',
+    action__manageOrganization: 'Manage',
+  },
+  organizationProfile: {
+    profilePage: {
+      title: 'Update Profile',
+      dangerSection: {
+        title: 'Danger',
+        leaveOrganization: {
+          actionDescription: 'Type "{{organizationName}}" below to continue.',
+        },
+        deleteOrganization: {
+          actionDescription: 'Type "{{organizationName}}" below to continue.',
+        },
+      },
+    },
+    invitePage: {
+      title: 'Invite new members',
+      subtitle: 'Enter or paste one or more email addresses, separated by spaces or commas.',
+    },
+  },
+  createOrganization: {
+    title: 'Create organization',
+  },
+  organizationList: {
+    title: 'Choose an account',
+    titleWithoutPersonal: 'Choose an organization',
+  },
 };
 ```

package/dist/versions/v5/common/organization-create-string.md

@@ -0,0 +1,12 @@
+---
+title: "`Organization.create('x')` -> `Organization.create({ name: 'x' })`"
+matcher: "Organization\\.create\\(\\s*[\"']"
+matcherFlags: 'm'
+---
+
+Passing a string as an argument to `Organization.create` is no longer possible - instead, pass an object with the `name` property.
+
+```diff
+- Organization.create('...');
++ Organization.create({ name: '...' });
+```

package/dist/versions/v5/common/organization-getdomains-arguments-change.md

@@ -1,6 +1,7 @@
 ---
 title: '`Organization.getDomains` arguments changed'
 matcher: "\\.getDomains\\("
+category: 'pagination-args'
 ---
 
 There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:

package/dist/versions/v5/common/organization-getinvitations-arguments-changed.md

@@ -1,6 +1,7 @@
 ---
 title: '`Organization.getInvitations` arguments changed'
 matcher: "\\.getInvitations\\("
+category: 'pagination-args'
 ---
 
 There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:

package/dist/versions/v5/common/organization-getmembershiprequests-arguments-changed.md

@@ -1,6 +1,7 @@
 ---
 title: '`Organization.getMembershipRequests` arguments changed'
 matcher: "\\.getMembershipRequests\\("
+category: 'pagination-args'
 ---
 
 There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:

package/dist/versions/v5/common/organization-getmemberships-arguments-changed.md

@@ -1,6 +1,7 @@
 ---
 title: '`Organization.getMemberships` arguments changed'
 matcher: "\\.getMemberships\\("
+category: 'pagination-args'
 ---
 
 There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:

package/dist/versions/v5/common/organization-getpendinginvitations.md

@@ -0,0 +1,11 @@
+---
+title: "`Organization.getPendingInvitations()` -> `Organization.getInvitations({ status: 'pending' })`"
+matcher: "\\.getPendingInvitations\\("
+---
+
+The `Organization.getPendingInvitations()` method has been removed. You can use `Organization.getInvitations` instead.
+
+```diff
+- Organization.getPendingInvitations();
++ Organization.getInvitations({ status: 'pending' });
+```

package/dist/versions/v5/common/organization-getroles-arguments-changed.md

@@ -1,6 +1,7 @@
 ---
 title: '`Organization.getRoles` arguments changed'
 matcher: "\\.getRoles\\("
+category: 'pagination-args'
 ---
 
 There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:

package/dist/versions/v5/common/organization-logourl.md

@@ -0,0 +1,8 @@
+---
+title: '`Organization.logoUrl` -> `Organization.imageUrl`'
+matcher: "\\.logoUrl"
+category: 'image-url'
+replaceWithString: '.imageUrl'
+---
+
+The `logoUrl` property of any [`Organization` object](https://clerk.com/docs/references/javascript/organization/organization#organization) has been changed to `imageUrl`.

package/dist/versions/v5/common/organizationmembershippublicuserdata-profileimageurl.md

@@ -0,0 +1,7 @@
+---
+title: '`OrganizationMembershipPublicUserData.profileImageUrl` -> `.imageUrl`'
+matcher: "\\.profileImageUrl"
+category: 'image-url'
+---
+
+The `profileImageUrl` property of any `OrganizationMembershipPublicUserData` object has been changed to `imageUrl`.

package/dist/versions/v5/common/organizationprofile-settings.md

@@ -2,6 +2,7 @@
 title: '`Settings` -> `General` tab in `OrganizationProfile`'
 matcher: '<OrganizationProfile'
 warning: true
+category: 'appearance'
 image: true
 ---
 

package/dist/versions/v5/common/organizationswitcherpopoveractionbuttontext-removed.md

@@ -2,6 +2,7 @@
 title: '`organizationSwitcherPopoverActionButtonText` customization id removed'
 image: true
 matcherFlags: 'm'
+category: 'appearance'
 matcher:
   - "\\.cl-organizationSwitcherPopoverActionButtonText"
   - "\\.cl-organizationSwitcherPopoverActionButtonText__manageOrganization"

package/dist/versions/v5/common/remove-identitypreview-avatar.md

@@ -2,6 +2,7 @@
 title: 'Identity preview avatar customization ids removed'
 image: true
 matcherFlags: 'm'
+category: 'appearance'
 matcher:
   - "\\.cl-identityPreviewAvatarBox"
   - "\\.cl-identityPreviewAvatarImage"

package/dist/versions/v5/common/remove-socialbuttonsblockbuttonarrow.md

@@ -2,6 +2,7 @@
 title: '`socialButtonsBlockButtonArrow` customization id removed'
 image: true
 matcherFlags: 'm'
+category: 'appearance'
 matcher:
   - "\\.cl-socialButtonsBlockButtonArrow"
   - "elements:\\s+{[\\s\\S]*?socialButtonsBlockButtonArrow:[\\s\\S]*?}"