@clerk/upgrade 0.2.0 → 0.3.0

package/dist/versions/v5/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/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/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/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/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/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/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/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/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/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/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/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/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/common/aftersigninurl-behavior-change-2.md

@@ -1,6 +1,7 @@
 ---
 title: '`afterSignInUrl` prop behavior change'
 matcher: 'afterSignInUrl='
+category: 'after-sign-x-handling'
 warning: true
 ---
 

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

@@ -1,6 +1,7 @@
 ---
 title: '`afterSignOutUrl` prop behavior change'
 matcher: 'afterSignOutUrl='
+category: 'after-sign-x-handling'
 warning: true
 ---
 

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

@@ -1,6 +1,7 @@
 ---
 title: '`afterSignUpUrl` prop behavior change'
 matcher: 'afterSignUpUrl='
+category: 'after-sign-x-handling'
 warning: true
 ---
 

package/dist/versions/v5/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/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/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/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/v5/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/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/v5/common/changed-localization-keys.md

@@ -1,6 +1,7 @@
 ---
 title: 'Localization keys changed'
 matcherFlags: 'm'
+category: 'localization'
 matcher:
   - 'formFieldLabel__organizationName:'
   - 'formFieldLabel__organizationSlug:'
@@ -55,125 +56,125 @@ The values of some keys have been changed on the default [en-US localization obj
 
 ```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',
-	},
+  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

@@ -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/common/clerkprovideroptionswrapper-dropped.md

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

package/dist/versions/v5/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/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/common/externalaccount-avatarurl.md

@@ -0,0 +1,7 @@
+---
+title: '`ExternalAccount.avatarUrl` -> `.imageUrl`'
+matcher: "\\.avatarUrl"
+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/common/externalaccount-picture.md

@@ -0,0 +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/common/externalaccountjson-avatarurl.md

@@ -0,0 +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/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/common/getorganizationinvitationlist-return-signature.md

@@ -0,0 +1,15 @@
+---
+title: '`Users.getOrganizationInvitationList` return signature changed'
+matcher: "\\.users\\.getOrganizationInvitationList\\("
+category: 'pagination-return'
+warning: true
+---
+
+The response payload of `Users.getOrganizationInvitationList` 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.getOrganizationInvitationList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationInvitationList()
+```

package/dist/versions/v5/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/common/getorganizationlist-return-signature.md

@@ -0,0 +1,15 @@
+---
+title: '`Users.getOrganizationList` return signature changed'
+matcher: "\\.users\\.getOrganizationList\\("
+category: 'pagination-return'
+warning: true
+---
+
+The response payload of `Users.getOrganizationList` 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.getOrganizationList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationList()
+```

package/dist/versions/v5/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: