@clerk/upgrade 0.2.1 → 0.4.0

package/dist/versions/{v5 → core-2}/backend/httpoptions-removed.md

@@ -2,6 +2,7 @@
 title: '`httpOptions` parameter removed'
 matcher: "\\([\\s\\S]*?httpOptions:\\s\\S]*?\\)"
 matcherFlags: 'm'
+category: 'skip'
 ---
 
 The `httpOptions` parameter was removed from the internal `buildRequest` function but it is used by most public facing APIs. Hence you were able to pass `httpOptions` to some functions which is not possible anymore. If you're currently relying on this functionality and wish to update, please reach out to Clerk's support.
@@ -9,7 +10,7 @@ The `httpOptions` parameter was removed from the internal `buildRequest` functio
 The internal change looks like this:
 
 ```diff
-- const r = buildRequest({ httpsOptions: { headers: {} }})
+- const r = buildRequest({ httpOptions: { headers: {} }})
 + const request = buildRequest()
 + request({ headerParams: {} })
 ```

package/dist/versions/{v5 → core-2}/backend/organizationjson-logourl.md

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

package/dist/versions/{v5 → core-2}/backend/organizationmembershippublicuserdatajson-profileimageurl.md

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

package/dist/versions/{v5 → core-2}/backend/redirect-import-path-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/signjwt-import-path-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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

package/dist/versions/{v5 → core-2}/backend/signjwterror-import-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/tokenverificationerror-import-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/tokenverificationerroraction-import-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/tokenverificationerrorcode-import-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/tokenverificationerrorreason-import-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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:

package/dist/versions/{v5 → core-2}/backend/userjson-profileimageurl.md

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

package/dist/versions/{v5 → core-2}/backend/verifyjwt-import-path-move.md

@@ -3,6 +3,7 @@ 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'
+category: 'import-paths'
 ---
 
 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

package/dist/versions/{v5/chromeExtension → core-2/chrome-extension}/clerkprovider-tokencache.md

@@ -2,25 +2,23 @@
 title: '`tokenCache` -> `storageCache` as `<ClerkProvider>` props'
 matcher: "<ClerkProvider[\\s\\S]*?tokenCache=[\\s\\S]*?>"
 matcherFlags: 'm'
+category: 'skip'
 ---
 
 The `tokenCache` prop has been renamed to `storageCache` in order to accomodate the new [WebSSO feature](https://github.com/clerk/javascript/pull/2277). With the prop change from `tokenCache` to `storageCache`, the interface has been expanded to allow for more flexibility. The new interface is as follows:
 
 ```ts
 type StorageCache = {
-	createKey: (...keys: string[]) => string;
-	get: <T = any>(key: string) => Promise<T>;
-	remove: (key: string) => Promise<void>;
-	set: (key: string, value: string) => Promise<void>;
+  createKey: (...keys: string[]) => string;
+  get: <T = any>(key: string) => Promise<T>;
+  remove: (key: string) => Promise<void>;
+  set: (key: string, value: string) => Promise<void>;
 };
 ```
 
 And here's a full before/after example:
 
-```jsx
-// before
-<ClerkProvider tokenCache={/* ... */}>
-
-// after
-<ClerkProvider storageCache={/* ... */}>
+```diff
+- <ClerkProvider tokenCache={/* ... */}>
++ <ClerkProvider storageCache={/* ... */}>
 ```

package/dist/versions/{v5 → core-2}/common/afterswitchorganizationurl.md

@@ -1,6 +1,7 @@
 ---
 title: '`afterSwitchOrganizationUrl` -> `afterSelectOrganizationUrl` in `OrganizationSwitcher`'
 matcher: "<OrganizationSwitcher[\\s\\S]*?(afterSwitchOrganizationUrl)=[\\s\\S]*?>"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 replaceWithString: 'afterSelectOrganizationUrl'
 ---

package/dist/versions/{v5 → core-2}/common/alternativemethods-backlink.md

@@ -1,5 +1,6 @@
 ---
 title: 'Back button customization ids change on alternative 2fa methods page'
+category: 'appearance'
 image: true
 matcherFlags: 'm'
 matcher:

package/dist/versions/{v5 → core-2}/common/api-key-to-secret-key.md

@@ -1,5 +1,6 @@
 ---
 title: '`CLERK_API_KEY` replaced by `CLERK_SECRET_KEY`'
+category: 'deprecation-removal'
 matcher: 'CLERK_API_KEY'
 ---
 

package/dist/versions/{v5 → core-2}/common/appearance-organizationpreview-organizationswitcher.md

@@ -2,6 +2,7 @@
 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'
+category: 'appearance'
 replaceWithString: 'organizationPreview__organizationSwitcherTrigger'
 ---
 

package/dist/versions/core-2/common/appearance-variables-breaking-changes.md

@@ -0,0 +1,15 @@
+---
+title: 'Breaking Changes to appearance variables'
+matcherFlags: 'm'
+category: 'appearance'
+matcher:
+  - "variables:\\s+{[\\s\\S]*?fontSmoothing:"
+  - "variables:\\s+{[\\s\\S]*?shadowShimmer:"
+  - "variables:\\s+{[\\s\\S]*?colorAlphaShade:"
+---
+
+Several appearance variables have been removed or renamed. If you were using these variables in your application, you will need to update your code to use the new variables.
+
+- The `fontSmoothing` variable has been removed.
+- The `shadowShimmer` variable has been removed.
+- The `colorAlphaShade` variable has been renamed to `colorNeutral`.

package/dist/versions/{v5 → core-2}/common/button-to-organizationlistcreateorganizationactionbutton.md

@@ -2,6 +2,7 @@
 title: '`button` -> `organizationListCreateOrganizationActionButton` customization id'
 image: true
 replaceWithString: 'organizationListCreateOrganizationActionButton'
+category: 'appearance'
 matcherFlags: 'm'
 matcher:
   - "\\.cl-(button)"

package/dist/versions/{v5 → core-2}/common/card-changes.md

@@ -1,14 +1,15 @@
 ---
 title: 'Changes to the `card` customization id'
 warning: true
+category: 'appearance'
 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.
+The `card` customization id in the previous major version was the main and only container element for components. Outside the `card` element, a new `cardBox` id was introduced 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`.
+A `footerItem` id was also added for more targeted styling of items inside the `footer`.

package/dist/versions/core-2/common/changed-localization-keys.md

@@ -0,0 +1,180 @@
+---
+title: 'Localization keys changed'
+matcherFlags: 'm'
+category: 'localization'
+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]*?start:\\s+{[\\s\\S]*?headerTitle__account:"
+  - "userProfile:\\s+{[\\s\\S]*?start:\\s+{[\\s\\S]*?emailAddressesSection:\\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]*?phoneNumbersSection:\\s+{[\\s\\S]*?primaryButton:"
+  - "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]*?profilePage:\\s+{[\\s\\S]*?fileDropAreaHint:"
+  - "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]*?primaryButton__addPhoneNumber:"
+  - "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]*?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: {
+    start: {
+      headerTitle__account: 'Profile details',
+      emailAddressesSection: {
+        primaryButton: 'Add email address',
+        detailsAction__unverified: 'Verify',
+        destructiveAction: 'Remove email',
+      },
+      phoneNumbersSection: {
+        primaryButton: 'Add phone number',
+      },
+      mfaSection: {
+        phoneCode: {
+          destructiveActionLabel: 'Remove',
+        },
+        backupCodes: {
+          actionLabel__regenerate: 'Regenerate',
+        },
+      },
+      dangerSection: {
+        title: 'Delete account',
+        deleteAccountButton: 'Delete account',
+      },
+    },
+    profilePage: {
+      imageFormSubtitle: 'Upload',
+      imageFormDestructiveActionSubtitle: 'Remove',
+      fileDropAreaHint: 'Recommended size 1:1, up to 10MB.',
+    },
+    phoneNumberPage: {
+      infoText:
+        'A text message containing a verification code will be sent to this phone number. Message and data rates may apply.',
+    },
+    connectedAccountPage: {
+      socialButtonsBlockButton: '{{provider|titleize}}',
+    },
+    mfaPhoneCodePage: {
+      primaryButton__addPhoneNumber: 'Add phone number',
+      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: {
+        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 → core-2}/common/clerkprovider-frontendapi-2.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as prop to `ClerkProvider`'
 matcher: "<ClerkProvider[\\s\\S]*?frontendApi=[\\s\\S]*?>"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5 → core-2}/common/clerkprovideroptionswrapper-dropped.md

@@ -1,5 +1,6 @@
 ---
 title: '`ClerkProviderOptionsWrapper` type removed'
+category: 'deprecation-removal'
 matcher: 'ClerkProviderOptionsWrapper'
 ---
 

package/dist/versions/{v5 → core-2}/common/connected-accounts-dropdown.md

@@ -1,6 +1,7 @@
 ---
 title: 'Within `<UserProfile />`, Connected Accounts Added via Dropdown'
 matcher: '(?:<UserProfile|<UserButton)'
+category: 'appearance'
 warning: true
 image: true
 ---

package/dist/versions/{v5 → core-2}/common/emaillinkerrorcode-import-change.md

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

package/dist/versions/{v5/js/external-account-avatarurl.md → core-2/common/externalaccount-avatarurl.md}

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

package/dist/versions/{v5/backend → core-2/common}/externalaccount-picture.md

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

package/dist/versions/{v5/backend → core-2/common}/externalaccountjson-avatarurl.md

@@ -1,6 +1,7 @@
 ---
 title: '`ExternalAccountJSON.avatar_url` -> `.imageUrl`'
 matcher: "\\.avatar_url"
+category: 'image-url-backend'
 ---
 
 The `avatarUrl` property of any `ExternalAcccountJSON` object has been changed to `imageUrl`.

package/dist/versions/{v5 → core-2}/common/frontend-api-to-publishable-key.md

@@ -1,5 +1,6 @@
 ---
 title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
+category: 'deprecation-removal'
 matcher: 'CLERK_FRONTEND_API'
 ---
 

package/dist/versions/{v5/backend → core-2/common}/getorganizationinvitationlist-return-signature.md

@@ -1,6 +1,7 @@
 ---
 title: '`Users.getOrganizationInvitationList` return signature changed'
 matcher: "\\.users\\.getOrganizationInvitationList\\("
+category: 'pagination-return'
 warning: true
 ---
 

package/dist/versions/{v5 → core-2}/common/getorganizationinvitationlist-return-type-change.md

@@ -1,14 +1,17 @@
 ---
-title: '`Organization.getOrganizationInvitationList()` return type changed'
+title: '`Organizations.getOrganizationInvitationList` return type changed'
 matcher: "\\.getOrganizationInvitationList\\("
+category: 'pagination-return'
+warning: true
 ---
 
 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:
 
 ```diff
-  const { organization } = useOrganization()
-  const inviteList = organization.getOrganizationInvitationList()
+  const data = await clerkClient.organizations.getOrganizationInvitationList({
+    organizationId: "...",
+  })
 
-- inviteList.forEach(() => {})
-+ inviteList.data.forEach(() => {})
+- data.forEach(() => {})
++ data.data.forEach(() => {})
 ```

package/dist/versions/{v5/backend → core-2/common}/getorganizationlist-return-signature.md

@@ -1,6 +1,7 @@
 ---
 title: '`Users.getOrganizationList` return signature changed'
 matcher: "\\.users\\.getOrganizationList\\("
+category: 'pagination-return'
 warning: true
 ---
 

package/dist/versions/{v5 → core-2}/common/getorganizationlist-return-type-change.md

@@ -1,6 +1,7 @@
 ---
-title: '`Organization.getOrganizationList()` return type changed'
+title: '`Organization.getOrganizationList` return type changed'
 matcher: "\\.getOrganizationList\\("
+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 → core-2}/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 → core-2}/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 → core-2}/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 → core-2}/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/core-2/common/ismetamaskerror-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`isMetamaskError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isMetamaskError[\\s\\S]*?from\\s+['\"]@clerk\\/(react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'error-imports'
+replaceWithString: 'react/errors'
+---
+
+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/react"
++ import { isMetamaskError } from "@clerk/react/errors"
+```

package/dist/versions/{v5 → core-2}/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 → core-2}/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 → core-2}/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 → core-2}/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'
 ---