@clerk/upgrade 0.2.0 → 0.3.0

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

@@ -1,6 +1,7 @@
 ---
 title: 'Removed localization keys'
 matcherFlags: 'm'
+category: 'localization'
 matcher:
   - "signIn:\\s+{[\\s\\S]*?forgotPassword:\\s+{[\\s\\S]*?title_email:"
   - "signIn:\\s+{[\\s\\S]*?forgotPassword:\\s+{[\\s\\S]*?title_phone:"
@@ -81,79 +82,79 @@ As part of the redesign of Clerk's components, a number of localization keys hav
 
 ```js
 const deletedKeys = [
-	'signIn.forgotPassword.title_email',
-	'signIn.forgotPassword.title_phone',
-	'signIn.forgotPassword.formSubtitle_email',
-	'signIn.forgotPassword.formSubtitle_phone',
-	'signIn.emailCode.formSubtitle',
-	'signIn.phoneCode.formSubtitle',
-	'signIn.phoneCodeMfa.formSubtitle',
-	'signIn.totpMfa.formSubtitle',
-	'signIn.backupCodeMfa.formTitle',
-	'signIn.backupCodeMfa.formSubtitle',
-	'userProfile.start.emailAddressesSection.detailsTitle__primary',
-	'userProfile.start.emailAddressesSection.detailsSubtitle__primary',
-	'userProfile.start.emailAddressesSection.detailsTitle__nonPrimary',
-	'userProfile.start.emailAddressesSection.detailsSubtitle__nonPrimary',
-	'userProfile.start.emailAddressesSection.detailsTitle__unverified',
-	'userProfile.start.emailAddressesSection.detailsSubtitle__unverified',
-	'userProfile.start.emailAddressesSection.destructiveActionTitle',
-	'userProfile.start.emailAddressesSection.destructiveActionSubtitle',
-	'userProfile.start.phoneNumbersSection.detailsTitle__primary',
-	'userProfile.start.phoneNumbersSection.detailsSubtitle__primary',
-	'userProfile.start.phoneNumbersSection.detailsTitle__nonPrimary',
-	'userProfile.start.phoneNumbersSection.detailsSubtitle__nonPrimary',
-	'userProfile.start.phoneNumbersSection.detailsTitle__unverified',
-	'userProfile.start.phoneNumbersSection.detailsSubtitle__unverified',
-	'userProfile.start.phoneNumbersSection.destructiveActionTitle',
-	'userProfile.start.phoneNumbersSection.destructiveActionSubtitle',
-	'userProfile.start.connectedAccountsSection.title__conectionFailed',
-	'userProfile.start.connectedAccountsSection.title__connectionFailed',
-	'userProfile.start.connectedAccountsSection.title__reauthorize',
-	'userProfile.start.connectedAccountsSection.subtitle__reauthorize',
-	'userProfile.start.connectedAccountsSection.actionLabel__conectionFailed',
-	'userProfile.start.connectedAccountsSection.destructiveActionSubtitle',
-	'userProfile.start.connectedAccountsSection.destructiveActionAccordionSubtitle',
-	'userProfile.start.mfaSection.phoneCode.destructiveActionTitle',
-	'userProfile.start.mfaSection.phoneCode.destructiveActionSubtitle',
-	'userProfile.start.mfaSection.phoneCode.title__default',
-	'userProfile.start.mfaSection.phoneCode.title__setDefault',
-	'userProfile.start.mfaSection.phoneCode.subtitle__default',
-	'userProfile.start.mfaSection.phoneCode.subtitle__setDefault',
-	'userProfile.start.mfaSection.totp.title',
-	'userProfile.start.mfaSection.totp.subtitle',
-	'userProfile.start.mfaSection.totp.destructiveActionSubtitle',
-	'userProfile.start.mfaSection.totp.destructiveActionLabel',
-	'userProfile.start.activeDevicesSection.primaryButton',
-	'userProfile.start.activeDevicesSection.detailsTitle',
-	'userProfile.start.activeDevicesSection.detailsSubtitle',
-	'userProfile.start.activeDevicesSection.destructiveActionTitle',
-	'userProfile.start.activeDevicesSection.destructiveActionSubtitle',
-	'userProfile.start.web3WalletsSection.destructiveActionTitle',
-	'userProfile.start.web3WalletsSection.destructiveActionSubtitle',
-	'userProfile.start.dangerSection.deleteAccountTitle',
-	'userProfile.start.dangerSection.deleteAccountDescription',
-	'userProfile.start.headerSubtitle__account',
-	'userProfile.start.headerSubtitle__security',
-	'organizationProfile.start.headerTitle__settings',
-	'organizationProfile.start.headerSubtitle__members',
-	'organizationProfile.start.headerSubtitle__settings',
-	'organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__verify',
-	'organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__remove',
-	'organizationProfile.profilePage.subtitle',
-	'organizationProfile.membersPage.start.headerTitle__active',
-	'organizationProfile.membersPage.start.headerTitle__invited',
-	'createOrganization.subtitle',
-	'formFieldLabel__emailAddress_phoneNumber',
-	'formFieldLabel__phoneNumber_username',
-	'formFieldLabel__emailAddress_phoneNumber_username',
-	'formFieldInputPlaceholder__emailAddress_phoneNumber',
-	'formFieldInputPlaceholder__phoneNumber_username',
-	'formFieldInputPlaceholder__emailAddress_phoneNumber_username',
-	'userProfile.phoneNumberPage.infoText__secondary',
-	'userProfile.mfaPhoneCodePage.successMessage',
-	'userProfile.profilePage.fileDropAreaTitle',
-	'userProfile.profilePage.fileDropAreaAction',
+  'signIn.forgotPassword.title_email',
+  'signIn.forgotPassword.title_phone',
+  'signIn.forgotPassword.formSubtitle_email',
+  'signIn.forgotPassword.formSubtitle_phone',
+  'signIn.emailCode.formSubtitle',
+  'signIn.phoneCode.formSubtitle',
+  'signIn.phoneCodeMfa.formSubtitle',
+  'signIn.totpMfa.formSubtitle',
+  'signIn.backupCodeMfa.formTitle',
+  'signIn.backupCodeMfa.formSubtitle',
+  'userProfile.start.emailAddressesSection.detailsTitle__primary',
+  'userProfile.start.emailAddressesSection.detailsSubtitle__primary',
+  'userProfile.start.emailAddressesSection.detailsTitle__nonPrimary',
+  'userProfile.start.emailAddressesSection.detailsSubtitle__nonPrimary',
+  'userProfile.start.emailAddressesSection.detailsTitle__unverified',
+  'userProfile.start.emailAddressesSection.detailsSubtitle__unverified',
+  'userProfile.start.emailAddressesSection.destructiveActionTitle',
+  'userProfile.start.emailAddressesSection.destructiveActionSubtitle',
+  'userProfile.start.phoneNumbersSection.detailsTitle__primary',
+  'userProfile.start.phoneNumbersSection.detailsSubtitle__primary',
+  'userProfile.start.phoneNumbersSection.detailsTitle__nonPrimary',
+  'userProfile.start.phoneNumbersSection.detailsSubtitle__nonPrimary',
+  'userProfile.start.phoneNumbersSection.detailsTitle__unverified',
+  'userProfile.start.phoneNumbersSection.detailsSubtitle__unverified',
+  'userProfile.start.phoneNumbersSection.destructiveActionTitle',
+  'userProfile.start.phoneNumbersSection.destructiveActionSubtitle',
+  'userProfile.start.connectedAccountsSection.title__conectionFailed',
+  'userProfile.start.connectedAccountsSection.title__connectionFailed',
+  'userProfile.start.connectedAccountsSection.title__reauthorize',
+  'userProfile.start.connectedAccountsSection.subtitle__reauthorize',
+  'userProfile.start.connectedAccountsSection.actionLabel__conectionFailed',
+  'userProfile.start.connectedAccountsSection.destructiveActionSubtitle',
+  'userProfile.start.connectedAccountsSection.destructiveActionAccordionSubtitle',
+  'userProfile.start.mfaSection.phoneCode.destructiveActionTitle',
+  'userProfile.start.mfaSection.phoneCode.destructiveActionSubtitle',
+  'userProfile.start.mfaSection.phoneCode.title__default',
+  'userProfile.start.mfaSection.phoneCode.title__setDefault',
+  'userProfile.start.mfaSection.phoneCode.subtitle__default',
+  'userProfile.start.mfaSection.phoneCode.subtitle__setDefault',
+  'userProfile.start.mfaSection.totp.title',
+  'userProfile.start.mfaSection.totp.subtitle',
+  'userProfile.start.mfaSection.totp.destructiveActionSubtitle',
+  'userProfile.start.mfaSection.totp.destructiveActionLabel',
+  'userProfile.start.activeDevicesSection.primaryButton',
+  'userProfile.start.activeDevicesSection.detailsTitle',
+  'userProfile.start.activeDevicesSection.detailsSubtitle',
+  'userProfile.start.activeDevicesSection.destructiveActionTitle',
+  'userProfile.start.activeDevicesSection.destructiveActionSubtitle',
+  'userProfile.start.web3WalletsSection.destructiveActionTitle',
+  'userProfile.start.web3WalletsSection.destructiveActionSubtitle',
+  'userProfile.start.dangerSection.deleteAccountTitle',
+  'userProfile.start.dangerSection.deleteAccountDescription',
+  'userProfile.start.headerSubtitle__account',
+  'userProfile.start.headerSubtitle__security',
+  'organizationProfile.start.headerTitle__settings',
+  'organizationProfile.start.headerSubtitle__members',
+  'organizationProfile.start.headerSubtitle__settings',
+  'organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__verify',
+  'organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__remove',
+  'organizationProfile.profilePage.subtitle',
+  'organizationProfile.membersPage.start.headerTitle__active',
+  'organizationProfile.membersPage.start.headerTitle__invited',
+  'createOrganization.subtitle',
+  'formFieldLabel__emailAddress_phoneNumber',
+  'formFieldLabel__phoneNumber_username',
+  'formFieldLabel__emailAddress_phoneNumber_username',
+  'formFieldInputPlaceholder__emailAddress_phoneNumber',
+  'formFieldInputPlaceholder__phoneNumber_username',
+  'formFieldInputPlaceholder__emailAddress_phoneNumber_username',
+  'userProfile.phoneNumberPage.infoText__secondary',
+  'userProfile.mfaPhoneCodePage.successMessage',
+  'userProfile.profilePage.fileDropAreaTitle',
+  'userProfile.profilePage.fileDropAreaAction',
 ];
 ```
 

package/dist/versions/v5/common/user-getorganizationinvitations-arguments-chanaged.md

@@ -1,6 +1,7 @@
 ---
 title: '`User.getOrganizationInvitations` arguments changed'
 matcher: "\\.getOrganizationInvitations\\("
+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/user-getorganizationinvitations-arguments-changed.md

@@ -0,0 +1,16 @@
+---
+title: '`User.getOrganizationInvitations` arguments changed'
+matcher: "\\.getOrganizationInvitations\\("
+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:
+
+```diff
+  const { data } = await user.getOrganizationInvitations({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/common/user-getorganizationmemberships-arguments-chanaged.md

@@ -1,6 +1,7 @@
 ---
 title: '`User.getOrganizationMemberships` arguments changed'
 matcher: "\\.getOrganizationMemberships\\("
+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/user-getorganizationmemberships-arguments-changed.md

@@ -0,0 +1,16 @@
+---
+title: '`User.getOrganizationMemberships` arguments changed'
+matcher: "\\.getOrganizationMemberships\\("
+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:
+
+```diff
+  const { data } = await user.getOrganizationMemberships({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/common/user-getorganizationsuggestions-arguments-chanaged.md

@@ -1,6 +1,7 @@
 ---
 title: '`User.getOrganizationSuggestions` arguments changed'
 matcher: "\\.getOrganizationSuggestions\\("
+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/user-getorganizationsuggestions-arguments-changed.md

@@ -0,0 +1,16 @@
+---
+title: '`User.getOrganizationSuggestions` arguments changed'
+matcher: "\\.getOrganizationSuggestions\\("
+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:
+
+```diff
+  const { data } = await user.getOrganizationSuggestions({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

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

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

package/dist/versions/v5/common/user-update-password.md

@@ -0,0 +1,18 @@
+---
+title: "`User.update({ password: 'x' })` -> `User.updatePassword('x')`"
+matcher: "\\.update\\([\\s\\S]*?password:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
+matcherFlags: 'm'
+---
+
+If you are updating a user's password via the [`User.update` method](https://clerk.com/docs/references/javascript/user/user#update), it must be changed to [`User.updatePassword`](https://clerk.com/docs/references/javascript/user/password-management#update-password) instead. This method will require the current password as well as the desired new password. We made this update to improve the security of password changes. Example below:
+
+```diff
+- user.update({ password: 'foo' });
+
++ user.updatePassword({
++   currentPassword: 'bar',
++   newPassword: 'foo',
++   signOutOfOtherSessions: true,
++ });
+```

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

@@ -1,6 +1,7 @@
 ---
 title: '`userButtonPopoverActionButtonText` customization id removed'
 image: true
+category: 'appearance'
 matcher:
   - "\\.cl-userButtonPopoverActionButtonText"
   - "\\.cl-userButtonPopoverActionButtonText__signOut"

package/dist/versions/v5/common/userbuttontrigger-userbuttonbox-invert.md

@@ -1,6 +1,7 @@
 ---
 title: '`userButtonBox` is now a child of `userButtonTrigger`'
 warning: true
+category: 'appearance'
 matcher:
   - "\\.cl-userButtonTrigger"
   - "\\.cl-userButtonBox"
@@ -9,4 +10,4 @@ matcher:
 matcherFlags: 'm'
 ---
 
-We have swapped the parent-child relationship of the two elements `userButtonTrigger` and `userButtonBox`. Previously, `userButtonTrigger` was nested inside of `userButtonBox`, and now `userButtonBox` is nested inside of `userButtonTrigger`. This change resolves [some usability issues](https://github.com/clerk/javascript/issues/1625) in `<UserButton />. If you are applying style customization to either of these elements, your customizations may need to be adjusted.
+The parent-child relationship of the two elements `userButtonTrigger` and `userButtonBox` has been swapped. Previously, `userButtonTrigger` was nested inside of `userButtonBox`, and now `userButtonBox` is nested inside of `userButtonTrigger`. This change resolves [some usability issues](https://github.com/clerk/javascript/issues/1625) in `<UserButton />`. If you are applying style customization to either of these elements, your customizations may need to be adjusted.

package/dist/versions/v5/common/userprofile-security.md

@@ -1,6 +1,7 @@
 ---
 title: 'Within `<UserProfile />`, Account and Security Pages Separated'
 matcher: '(?:<UserProfile|<UserButton)'
+category: 'appearance'
 warning: true
 image: true
 ---

package/dist/versions/v5/common/withclerk-hof-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`withClerk` function removed'
 matcher: "import\\s+{[\\s\\S]*?withClerk[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
@@ -8,22 +9,22 @@ The `withClerk` higher order function has been removed. If you would still like
 
 ```js
 function withClerk(Component, displayName) {
-	displayName = displayName || Component.displayName || Component.name || 'Component';
-	Component.displayName = displayName;
-	const HOC = props => {
-		const clerk = useIsomorphicClerkContext();
+  displayName = displayName || Component.displayName || Component.name || 'Component';
+  Component.displayName = displayName;
+  const HOC = props => {
+    const clerk = useIsomorphicClerkContext();
 
-		if (!clerk.loaded) return null;
+    if (!clerk.loaded) return null;
 
-		return (
-			<Component
-				{...props}
-				clerk={clerk}
-			/>
-		);
-	};
+    return (
+      <Component
+        {...props}
+        clerk={clerk}
+      />
+    );
+  };
 
-	HOC.displayName = `withClerk(${displayName})`;
-	return HOC;
+  HOC.displayName = `withClerk(${displayName})`;
+  return HOC;
 }
 ```

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

@@ -1,6 +1,7 @@
 ---
 title: '`WithClerk` component removed'
 matcher: "import\\s+{[\\s\\S]*?WithClerk[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/common/withsession-hof-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`withSession` function removed'
 matcher: "import\\s+{[\\s\\S]*?withSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
@@ -8,22 +9,22 @@ The `withSession` higher order function has been removed. If you would still lik
 
 ```js
 function withSession(Component, displayName) {
-	displayName = displayName || Component.displayName || Component.name || 'Component';
-	Component.displayName = displayName;
-	const HOC = props => {
-		const session = useSessionContext();
+  displayName = displayName || Component.displayName || Component.name || 'Component';
+  Component.displayName = displayName;
+  const HOC = props => {
+    const session = useSessionContext();
 
-		if (!session) return null;
+    if (!session) return null;
 
-		return (
-			<Component
-				{...props}
-				session={session}
-			/>
-		);
-	};
+    return (
+      <Component
+        {...props}
+        session={session}
+      />
+    );
+  };
 
-	HOC.displayName = `withSession(${displayName})`;
-	return HOC;
+  HOC.displayName = `withSession(${displayName})`;
+  return HOC;
 }
 ```

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

@@ -1,6 +1,7 @@
 ---
 title: '`WithSession` component removed'
 matcher: "import\\s+{[\\s\\S]*?WithSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/common/withuser-hof-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`withUser` function removed'
 matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
@@ -8,22 +9,22 @@ The `withUser` higher order function has been removed. If you would still like t
 
 ```js
 function withUser(Component, displayName) {
-	displayName = displayName || Component.displayName || Component.name || 'Component';
-	Component.displayName = displayName;
-	const HOC = props => {
-		const clerk = useUserContext();
+  displayName = displayName || Component.displayName || Component.name || 'Component';
+  Component.displayName = displayName;
+  const HOC = props => {
+    const clerk = useUserContext();
 
-		if (!user) return null;
+    if (!user) return null;
 
-		return (
-			<Component
-				{...props}
-				user={user}
-			/>
-		);
-	};
+    return (
+      <Component
+        {...props}
+        user={user}
+      />
+    );
+  };
 
-	HOC.displayName = `withUser(${displayName})`;
-	return HOC;
+  HOC.displayName = `withUser(${displayName})`;
+  return HOC;
 }
 ```

package/dist/versions/v5/common/withuser-removed-2.md

@@ -1,11 +1,10 @@
 ---
 title: '`WithUser` component removed'
 matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
-<!-- why is this called withuser-removed-2 you may ask? if you remove the "-2", it doesn't load, depsite identical content. Truly, this is baffling -->
-
 The `WithUser` higher order component has been removed. If you would still like to use this function in the way its implemented, it can be created quickly using Clerk's [custom hooks](https://clerk.com/docs/references/react/overview). An example of how to do so is below:
 
 ```js

package/dist/versions/v5/expo/apikey-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/expo/clerkprovider-frontendapi.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/fastify/clerkplugin-frontendapi.md

@@ -1,7 +1,8 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to clerkPlugin'
-matcher: "fastify\\.register\\(clerkPlugin,.*?{.*?frontendApi:.*?}\\)"
+matcher: "fastify\\.register\\(clerkPlugin,[\\s\\S]*?{[\\s\\S]*?frontendApi:[\\s\\S]*?}\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `frontendApi` argument passed to `clerkPlugin` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.

package/dist/versions/v5/fastify/createclerkclient-apikey.md

@@ -2,6 +2,7 @@
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.

package/dist/versions/v5/fastify/createclerkclient-frontendapi.md

@@ -2,6 +2,7 @@
 title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `frontendApi` argument passed to `createClerkClient` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.

package/dist/versions/v5/gatsby/api-url-value-change.md

@@ -5,4 +5,4 @@ matcherFlags: 'm'
 warning: true
 ---
 
-- The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.
+The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.

package/dist/versions/v5/gatsby/apikey-to-publishable-key.md

@@ -1,5 +1,6 @@
 ---
 title: '`GASTBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
+category: 'deprecation-removal'
 matcher: 'GATSBY_CLERK_FRONTEND_API'
 ---
 

package/dist/versions/v5/gatsby/createclerkclient-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/gatsby/createclerkclient-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/gatsby/withserverauth-return-type.md

@@ -3,41 +3,33 @@ title: '`withServerAuth` props.auth return type changed'
 matcher: "withServerAuth\\("
 ---
 
-When utilizing the `withServerAuth` helper in Gatsby, it expects a callback function that is called with props from Clerk internals. The `.auth` property on the returned object from the callback has seen a substantial change in its return type. Note specifically that the property `auth.claims` was changed to `auth.sessionClaims` in addition to the other typing changes. A full example of how this looks and how the types differ can be seen below:
+When utilizing the `withServerAuth` helper in Gatsby, it expects a callback function that is called with props from Clerk internals. The `.auth` property on the returned object from the callback has seen a substantial change in its return type. Below is a code example of where the `auth` prop might be found:
 
 ```js
 import { withServerAuth } from 'gatsby-plugin-clerk/ssr';
 
 export const getServerData: GetServerData<any> = withServerAuth(async props => {
-	return { props: { data: '1', auth: props.auth } };
+  return { props: { data: '...', auth: props.auth } };
 });
-// props.auth : v4 exported type
-/*
-{
-  sessionId: string | null;
-  userId: string | null;
-  actor: ActJWTClaim | null;
-  getToken: ServerGetToken;
-  claims: ClerkJWTClaims | null;
-};
-*/
+```
+
+And here's a diff of the changes in the return type. The breaking change here specifically is that the property `auth.claims` was changed to `auth.sessionClaims`. Additionally, there is more information on the response that can be utilized if helpful.
 
-// props.auth : v5 exported type
-/*
-{
-  sessionClaims: JwtPayload;
-  sessionId: string | null;
-  session: Session | undefined | null;
-  actor: ActClaim | undefined | null;
-  userId: string | null;
-  user: User | undefined | null;
-  orgId: string | undefined | null;
-  orgRole: string | undefined | null;
-  orgSlug: string | undefined | null;
-  organization: Organization | undefined | null;
-  getToken: ServerGetToken;
-  experimental__has: experimental__CheckAuthorizationWithoutPermission;
-  debug: AuthObjectDebug;
-};
-*/
+```diff
+ // return type diff
+ {
+   sessionId: string | null;
+   userId: string | null;
+   actor: ActJWTClaim | null;
+   getToken: ServerGetToken;
+-  claims: ClerkJWTClaims | null;
++  sessionClaims: JwtPayload;
++  session: Session | undefined | null;
++  user: User | undefined | null;
++  orgId: string | undefined | null;
++  orgRole: string | undefined | null;
++  orgSlug: string | undefined | null;
++  organization: Organization | undefined | null;
++  debug: AuthObjectDebug;
+ };
 ```