@clerk/upgrade 0.0.2 → 0.1.0

package/dist/versions/v5/backend/membershiprole.md

@@ -0,0 +1,21 @@
+---
+title: '`MembershipRole` type replaced by `OrganizationCustomRoleKey` type'
+matcher: "(?:\\.orgRole|\\.org_role)"
+---
+
+The `MembershipRole` type was replaced with `OrganizationCustomRoleKey` (related to [roles and permissions](https://clerk.com/docs/organizations/roles-permissions)). An example of where this type might be found:
+
+```js
+import { useAuth } from '@clerk/clerk-react';
+
+const { orgRole } = useAuth();
+```
+
+To support the existing roles `admin`, `basic_member`, and `guest_member` apply interface merging using the following snippet:
+
+```js
+interface ClerkAuthorization {
+  permission: ''
+  role: 'admin' | 'basic_member' | 'guest_member'
+}
+```

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

@@ -0,0 +1,6 @@
+---
+title: '`Organization.logoUrl` -> `.imageUrl`'
+matcher: "\\.logoUrl"
+---
+
+The `logoUrl` property of any `Organization` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/organizationjson-logourl.md

@@ -0,0 +1,6 @@
+---
+title: '`OrganizationJSON.logo_url` -> `.imageUrl`'
+matcher: "\\.logo_url"
+---
+
+The `logo_url` property of any `OrganizationJSON` object has been changed to `imageUrl`.

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

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

package/dist/versions/v5/backend/organizationmembershippublicuserdatajson-profileimageurl.md

@@ -0,0 +1,6 @@
+---
+title: '`OrganizationMembershipPublicUserDataJSON.profile_image_url` -> `.imageUrl`'
+matcher: "\\.profile_image_url"
+---
+
+The `profile_image_url` property of any `OrganizationMembershipPublicUserDataJSON` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/pkgversion.md

@@ -0,0 +1,15 @@
+---
+title: '`pkgVersion` -> `clerkJSVersion`'
+matcher:
+  - "loadInterstitialFromLocal\\([\\s\\S]*?pkgVersion:"
+  - "loadInterstitialFromBAPI\\([\\s\\S]*?pkgVersion:"
+  - "buildPublicInterstitialUrl\\([\\s\\S]*?pkgVersion:"
+matcherFlags: 'm'
+---
+
+The `pkgVersion` parameter was removed from the `loadInterstitialFromLocal`, `loadInterstitialFromBAPI`, and `buildPublicInterstitialUrl` functions. Use `clerkJSVersion` instead. Example:
+
+```diff
+- loadInterstitialFromLocal({ pkgVersion: "..." })
++ loadInterstitialFromLocal({ clerkJSVersion: "..." })
+```

package/dist/versions/v5/backend/redirect-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`redirect` import moved to `@clerk/backend/internal`'
+matcher: "import\\s+{[\\s\\S]*?redirect[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/internal'
+---
+
+The `redirect` import path has changed from `@clerk/backend` to `@clerk/backend/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { redirect } from "@clerk/backend"
++ import { redirect } from "@clerk/backend/internal"
+```

package/dist/versions/v5/backend/return-signature-change.md

@@ -0,0 +1,14 @@
+---
+title: '`Users.getOrganizationMembershipList` return signature changed'
+matcher: "\\.users\\.getOrganizationMembershipList\\("
+warning: true
+---
+
+The response payload of `Users.getOrganizationMembershipList` was changed as part of the v5 release. Rather than directly returning ` data`, the return signature is now `{ data, totalCount }`. Since backend API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
+
+Here's an example of how the response shape would change with this modification:
+
+```diff
+- const data = await clerkClient.users.getOrganizationMembershipList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationMembershipList()
+```

package/dist/versions/v5/backend/signjwt-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`signJwt` import moved to `@clerk/backend/tokens`'
+matcher: "import\\s+{[\\s\\S]*?signJwt[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/tokens'
+---
+
+The `signJwt` import path has changed from `@clerk/backend` to `@clerk/backend/tokens`. 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 { signJwt } from "@clerk/backend"
++ import { signJwt } from "@clerk/backend/tokens"
+```

package/dist/versions/v5/backend/signjwterror-import-move.md

@@ -0,0 +1,13 @@
+---
+title: '`SignJWTError` import moved to `@clerk/backend/errors`'
+matcher: "import\\s+{[\\s\\S]*?SignJWTError[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/errors'
+---
+
+The `SignJWTError` import path has changed from `@clerk/backend` to `@clerk/backend/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 { SignJWTError } from "@clerk/backend"
++ import { SignJWTError } from "@clerk/backend/errors"
+```

package/dist/versions/v5/backend/tokenverificationerror-import-move.md

@@ -0,0 +1,13 @@
+---
+title: '`TokenVerificationError` import moved to `@clerk/backend/errors`'
+matcher: "import\\s+{[\\s\\S]*?TokenVerificationError[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/errors'
+---
+
+The `TokenVerificationError` import path has changed from `@clerk/backend` to `@clerk/backend/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 { TokenVerificationError } from "@clerk/backend"
++ import { TokenVerificationError } from "@clerk/backend/errors"
+```

package/dist/versions/v5/backend/tokenverificationerroraction-import-move.md

@@ -0,0 +1,13 @@
+---
+title: '`TokenVerificationErrorAction` import moved to `@clerk/backend/errors`'
+matcher: "import\\s+{[\\s\\S]*?TokenVerificationErrorAction[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/errors'
+---
+
+The `TokenVerificationErrorAction` import path has changed from `@clerk/backend` to `@clerk/backend/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 { TokenVerificationErrorAction } from "@clerk/backend"
++ import { TokenVerificationErrorAction } from "@clerk/backend/errors"
+```

package/dist/versions/v5/backend/tokenverificationerrorcode-import-move.md

@@ -0,0 +1,13 @@
+---
+title: '`TokenVerificationErrorCode` import moved to `@clerk/backend/errors`'
+matcher: "import\\s+{[\\s\\S]*?TokenVerificationErrorCode[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/errors'
+---
+
+The `TokenVerificationErrorCode` import path has changed from `@clerk/backend` to `@clerk/backend/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 { TokenVerificationErrorCode } from "@clerk/backend"
++ import { TokenVerificationErrorCode } from "@clerk/backend/errors"
+```

package/dist/versions/v5/backend/tokenverificationerrorreason-import-move.md

@@ -0,0 +1,13 @@
+---
+title: '`TokenVerificationErrorReason` import moved to `@clerk/backend/errors`'
+matcher: "import\\s+{[\\s\\S]*?TokenVerificationErrorReason[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/errors'
+---
+
+The `TokenVerificationErrorReason` import path has changed from `@clerk/backend` to `@clerk/backend/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 { TokenVerificationErrorReason } from "@clerk/backend"
++ import { TokenVerificationErrorReason } from "@clerk/backend/errors"
+```

package/dist/versions/v5/backend/user-profileimageurl.md

@@ -0,0 +1,6 @@
+---
+title: '`User.profileImageUrl` -> `.imageUrl`'
+matcher: "\\.profileImageUrl"
+---
+
+The `profileImageUrl` property of any `User` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/userjson-profileimageurl.md

@@ -0,0 +1,6 @@
+---
+title: '`UserJSON.profile_image_url` -> `.imageUrl`'
+matcher: "\\.profile_image_url"
+---
+
+The `profile_image_url` property of any `UserJSON` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/verifyjwt-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`verifyJwt` import moved to `@clerk/backend/tokens`'
+matcher: "import\\s+{[\\s\\S]*?verifyJwt[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/tokens'
+---
+
+The `verifyJwt` import path has changed from `@clerk/backend` to `@clerk/backend/tokens`. 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 { verifyJwt } from "@clerk/backend"
++ import { verifyJwt } from "@clerk/backend/tokens"
+```

package/dist/versions/v5/common/aftersigninouturl-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignOutUrl` prop behavior change'
+matcher: 'afterSignOutUrl='
+warning: true
+---
+
+The default value of `afterSignOutUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://docs-preview-605.clerkpreview.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/common/aftersigninurl-behavior-change

@@ -0,0 +1,7 @@
+---
+title: '`afterSignInUrl` prop behavior change'
+matcher: 'afterSignInUrl='
+warning: true
+---
+
+The default value of `afterSignInUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://docs-preview-605.clerkpreview.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/common/aftersigninurl-behavior-change-2.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignInUrl` prop behavior change'
+matcher: 'afterSignInUrl='
+warning: true
+---
+
+The default value of `afterSignInUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://clerk.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/common/aftersigninurl-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignInUrl` prop behavior change'
+matcher: 'afterSignInUrl='
+warning: true
+---
+
+The default value of `afterSignInUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://clerk.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/common/aftersignouturl-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignOutUrl` prop behavior change'
+matcher: 'afterSignOutUrl='
+warning: true
+---
+
+The default value of `afterSignOutUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://clerk.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults. If you are setting the value to `/`, you can remove the prop entirely.

package/dist/versions/v5/common/aftersignupurl-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignUpUrl` prop behavior change'
+matcher: 'afterSignUpUrl='
+warning: true
+---
+
+The default value of `afterSignUpUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://clerk.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/common/afterswitchorganizationurl.md

@@ -0,0 +1,16 @@
+---
+title: '`afterSwitchOrganizationUrl` -> `afterSelectOrganizationUrl` in `OrganizationSwitcher`'
+matcher: "<OrganizationSwitcher[\\s\\S]*?(afterSwitchOrganizationUrl)=[\\s\\S]*?>"
+matcherFlags: 'm'
+replaceWithString: 'afterSelectOrganizationUrl'
+---
+
+The `afterSwitchOrganizationUrl` prop on the `<OrganizationSwitcher />` component has been renamed to `afterSelectOrganizationUrl`. This is a quick and simple rename.
+
+```js
+// before
+<OrganizationSwitcher afterSwitchOrganizationUrl='...' />
+
+// after
+<OrganizationSwitcher afterSelectOrganizationUrl='...' />
+```

package/dist/versions/v5/common/alternativemethods-backlink.md

@@ -0,0 +1,18 @@
+---
+title: 'Back button customization ids change on alternative 2fa methods page'
+image: true
+matcherFlags: 'm'
+matcher:
+  - "\\.cl-headerBackIcon"
+  - "\\.cl-headerBackRow"
+  - "\\.cl-headerBackLink"
+  - "elements:\\s+{[\\s\\S]*?headerBackIcon:[\\s\\S]*?}"
+  - "elements:\\s+{[\\s\\S]*?headerBackRow:[\\s\\S]*?}"
+  - "elements:\\s+{[\\s\\S]*?headerBackLink:[\\s\\S]*?}"
+---
+
+The "back" button on the panel within `<SignIn />` that lists out alternative two factor auth methods has changed location, and there have been some changes to the ids as a result of this:
+
+- `headerBackIcon` has been removed, as there is no longer an associated icon
+- `headerBackRow` has been renamed to `backRow` as it's no longer in the header
+- `headerBackLink` has been renamed to `backLink` as it's no longer in the header

package/dist/versions/v5/common/api-key-to-secret-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_API_KEY` replaced by `CLERK_SECRET_KEY`'
-matcher: '[^_]CLERK_API_KEY'
+matcher: 'CLERK_API_KEY'
 ---
 
 The `CLERK_API_KEY` environment variable was renamed to `CLERK_SECRET_KEY`. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production).

package/dist/versions/v5/common/appearance-organizationpreview-organizationswitcher.md

@@ -0,0 +1,8 @@
+---
+title: '`elements.organizationPreview__organizationSwitcher` -> `elements.organizationPreview__organizationSwitcherTrigger` in `<OrganizationSwitcher />` appearance prop'
+matcher: "<OrganizationSwitcher[\\s\\S]*?appearance={\\s*{\\s*elements:\\s*{\\s*(organizationPreview__organizationSwitcher)[\\s\\S]*?>"
+matcherFlags: 'm'
+replaceWithString: 'organizationPreview__organizationSwitcherTrigger'
+---
+
+If you are using `organizationPreview__organizationSwitcher` as an [appearance prop](https://clerk.com/docs/components/customization/overview#appearance-prop) value to the [`<OrganizationSwitcher />` component](https://clerk.com/docs/references/javascript/clerk/organization-switcher#organization-switcher-component), it must be updated to `organizationPreview__organizationSwitcherTrigger` instead. This is a simple text replacement. However, it should be noted that component designs have been updated as part of v5, so you may need to make adjustments to any appearance prop customizations that have been implemented as a whole.

package/dist/versions/v5/common/button-to-organizationlistcreateorganizationactionbutton.md

@@ -0,0 +1,11 @@
+---
+title: '`button` -> `organizationListCreateOrganizationActionButton` customization id'
+image: true
+replaceWithString: 'organizationListCreateOrganizationActionButton'
+matcherFlags: 'm'
+matcher:
+  - "\\.cl-(button)"
+  - "elements:\\s+{[\\s\\S]*?(button):[\\s\\S]*?}"
+---
+
+The `button` customization id was used only in one place, for a button to create a new organization in the `<OrganizationList />` component. This id has been removed and replaced by the more appropriately named `organizationListCreateOrganizationActionButton` customization id instead.

package/dist/versions/v5/common/card-changes.md

@@ -0,0 +1,14 @@
+---
+title: 'Changes to the `card` customization id'
+warning: true
+matcherFlags: 'm'
+matcher:
+  - "\\.cl-card"
+  - "elements:\\s+{[\\s\\S]*?card:[\\s\\S]*?}"
+---
+
+The `card` customization id in the previous major version was the main and only container element for components Outside the `card` element we introduced a new `cardBox` id that allows more fine-grained style customization.
+
+As a note, if you are changing the background color of `card`, you will also need to also apply the same color on the `footer` id as well. The `footer` now gray by default, and it’s located outside `card`, but inside `cardBox`.
+
+We also added a `footerItem` id for more targeted styling of items inside the `footer`.

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

@@ -0,0 +1,179 @@
+---
+title: 'Localization keys changed'
+matcherFlags: 'm'
+matcher:
+  - 'formFieldLabel__organizationName:'
+  - 'formFieldLabel__organizationSlug:'
+  - 'formFieldInputPlaceholder__emailAddresses:'
+  - 'formFieldInputPlaceholder__organizationSlug:'
+  - "signUp:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?subtitle:"
+  - "signUp:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?actionText:"
+  - "signUp:\\s+{[\\s\\S]*?emailCode:\\s+{[\\s\\S]*?subtitle:"
+  - "signUp:\\s+{[\\s\\S]*?phoneCode:\\s+{[\\s\\S]*?subtitle:"
+  - "signUp:\\s+{[\\s\\S]*?continue:\\s+{[\\s\\S]*?subtitle:"
+  - "signUp:\\s+{[\\s\\S]*?continue:\\s+{[\\s\\S]*?actionText:"
+  - "signIn:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?title:"
+  - "signIn:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?subtitle:"
+  - "signIn:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?actionText:"
+  - "signIn:\\s+{[\\s\\S]*?password:\\s+{[\\s\\S]*?subtitle:"
+  - "signIn:\\s+{[\\s\\S]*?forgotPasswordAlternativeMethods:\\s+{[\\s\\S]*?label__alternativeMethods:"
+  - "signIn:\\s+{[\\s\\S]*?resetPassword:\\s+{[\\s\\S]*?title:"
+  - "signIn:\\s+{[\\s\\S]*?phoneCodeMfa:\\s+{[\\s\\S]*?subtitle:"
+  - "signIn:\\s+{[\\s\\S]*?totpMfa:\\s+{[\\s\\S]*?subtitle:"
+  - "signIn:\\s+{[\\s\\S]*?backupCodeMfa:\\s+{[\\s\\S]*?subtitle:"
+  - "userProfile:\\s+{[\\s\\S]*?formButtonPrimary__continue:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?headerTitle__account"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?profileSection:\\s+{[\\s\\S]*?primaryButton:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?emailAddressesSection:\\s+{[\\s\\S]*?detailsAction__unverified:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?emailAddressesSection:\\s+{[\\s\\S]*?destructiveAction:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?mfaSection:\\s+{[\\s\\S]*?phoneCode:\\s+{[\\s\\S]*?destructiveActionLabel:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?mfaSection:\\s+{[\\s\\S]*?backupCodes:\\s+{[\\s\\S]*?actionLabel__regenerate:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?dangerSection:\\s+{[\\s\\S]*?title:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?dangerSection:\\s+{[\\s\\S]*?deleteAccountButton:"
+  - "userProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?imageFormSubtitle:"
+  - "userProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?imageFormDestructiveActionSubtitle:"
+  - "userProfile:\\s+{[\\s\\S]*?phoneNumberPage:\\s+{[\\s\\S]*?title:"
+  - "userProfile:\\s+{[\\s\\S]*?phoneNumberPage:\\s+{[\\s\\S]*?infoText:"
+  - "userProfile:\\s+{[\\s\\S]*?connectedAccountPage:\\s+{[\\s\\S]*?socialButtonsBlockButton:"
+  - "userProfile:\\s+{[\\s\\S]*?mfaPhoneCodePage:\\s+{[\\s\\S]*?subtitle__availablePhoneNumbers:"
+  - "userProfile:\\s+{[\\s\\S]*?mfaPhoneCodePage:\\s+{[\\s\\S]*?subtitle__unavailablePhoneNumbers:"
+  - "userProfile:\\s+{[\\s\\S]*?deletePage:\\s+{[\\s\\S]*?actionDescription:"
+  - "organizationSwitcher:\\s+{[\\s\\S]*?action__createOrganization:"
+  - "organizationSwitcher:\\s+{[\\s\\S]*?action__manageOrganization:"
+  - "organizationProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?title:"
+  - "organizationProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?dangerSection:\\s+{[\\s\\S]*?title:"
+  - "organizationProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?dangerSection:\\s+{[\\s\\S]*?leaveOrganization:\\s+{[\\s\\S]*?actionDescription:"
+  - "organizationProfile:\\s+{[\\s\\S]*?profilePage:\\s+{[\\s\\S]*?dangerSection:\\s+{[\\s\\S]*?deleteOrganization:\\s+{[\\s\\S]*?actionDescription:"
+  - "organizationProfile:\\s+{[\\s\\S]*?invitePage:\\s+{[\\s\\S]*?title:"
+  - "organizationProfile:\\s+{[\\s\\S]*?invitePage:\\s+{[\\s\\S]*?subtitle:"
+  - "createOrganization:\\s+{[\\s\\S]*?title:"
+  - "organizationList:\\s+{[\\s\\S]*?title:"
+  - "organizationList:\\s+{[\\s\\S]*?titleWithoutPersonal:"
+---
+
+The values of some keys have been changed on the default [en-US localization object](https://github.com/clerk/javascript/blob/main/packages/localizations/src/en-US.ts). The list below shows you the new defaults (as of writing this guide) which you can either use or overwrite. If you have overridden these values, make sure to double check so you can be sure that your modifications are appropriate.
+
+```js
+const changedValues = {
+	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/clerkprovider-frontendapi-2.md

@@ -0,0 +1,7 @@
+---
+title: '`frontendApi` -> `publishableKey` as prop to `ClerkProvider`'
+matcher: "<ClerkProvider[\\s\\S]*?frontendApi=[\\s\\S]*?>"
+matcherFlags: 'm'
+---
+
+The `frontendApi` prop passed to `<ClerkProvider>` was renamed to `publishableKey`. **Note:** The values are different, so this is not just a key replacement. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production). [More information](/docs/deployments/overview#api-keys-and-environment-variables).

package/dist/versions/v5/common/clerkprovideroptionswrapper-dropped.md

@@ -0,0 +1,6 @@
+---
+title: '`ClerkProviderOptionsWrapper` type removed'
+matcher: 'ClerkProviderOptionsWrapper'
+---
+
+This type was extending `ClerkProviderProps` with but was not necessary. This type is typically used internally and is not required to be imported and used directly. If needed, import and use `ClerkProviderProps` instead.

package/dist/versions/v5/common/connected-accounts-dropdown.md

@@ -0,0 +1,15 @@
+---
+title: 'Within `<UserProfile />`, Connected Accounts Added via Dropdown'
+matcher: '(?:<UserProfile|<UserButton)'
+warning: true
+image: true
+---
+
+Within the `<UserProfile />` component (which is also rendered by `<UserButton />`), adding a connected account is now rendered as a dropdown instead of a modal. If you were relying on the modal for any sort of customizations, these customizations will need to be adjusted to the new form factor.
+
+New appearance prop keys were added to aid with customization, if desired:
+
+- `cl-menuList__connectedAccounts` for styling the list of connected account addition options
+- `cl-menuItem__connectedAccounts` for styling individual items in the connected account options list
+- `cl-menuList__web3Wallets` for styling the list of web3 wallet addition options
+- `cl-menuItem__web3Wallets` for styling individual items in the web3 wallets options list

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

@@ -0,0 +1,13 @@
+---
+title: '`EmailLinkErrorCode` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?EmailLinkErrorCode[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'clerk-react/errors'
+---
+
+The `EmailLinkErrorCode` import path has changed from `@clerk/clerk-react` to `@clerk/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 { EmailLinkErrorCode } from "@clerk/clerk-react"
++ import { EmailLinkErrorCode } from "@clerk/clerk-react/errors"
+```

package/dist/versions/v5/common/external-account-avatarurl.md

@@ -0,0 +1,7 @@
+---
+title: '`ExternalAccount.avatarUrl` -> `ExternalAccount.imageUrl`'
+matcher: "\\.avatarUrl"
+replaceWithString: '.imageUrl'
+---
+
+The `avatarUrl` property of any [`ExternalAcccount` object](https://clerk.com/docs/references/javascript/external-account) has been changed to `imageUrl`.

package/dist/versions/v5/common/frontend-api-to-publishable-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
-matcher: '[^_]CLERK_FRONTEND_API'
+matcher: 'CLERK_FRONTEND_API'
 ---
 
 The `CLERK_FRONTEND_API` environment variable was renamed to `CLERK_PUBLISHABLE_KEY`. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production). **Note:** The values are different, so this is not just a key replacement. [More information](/docs/deployments/overview#api-keys-and-environment-variables).

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

@@ -0,0 +1,13 @@
+---
+title: '`isClerkAPIResponseError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isClerkAPIResponseError[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'clerk-react/errors'
+---
+
+The `isClerkAPIResponseError` import path has changed from `@clerk/clerk-react` to `@clerk/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 { isClerkAPIResponseError } from "@clerk/clerk-react"
++ import { isClerkAPIResponseError } from "@clerk/clerk-react/errors"
+```

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

@@ -0,0 +1,13 @@
+---
+title: '`isEmailLinkError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isEmailLinkError[\\s\\S]*?from\\s+['\"]@clerk\\/(clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'clerk-react/errors'
+---
+
+The `isEmailLinkError` import path has changed from `@clerk/clerk-react` to `@clerk/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 { isEmailLinkError } from "@clerk/clerk-react"
++ import { isEmailLinkError } from "@clerk/clerk-react/errors"
+```