feat(clerk-js): Introduce Organization.getInvitations and deprecate…

… `getPendingInvitations`

.changeset/three-carrots-remain.md

@@ -0,0 +1,7 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Introduces a new method for fetching organization invitations called `Organization.getInvitations`.
+Deprecate `Organization.getPendingInvitations`

packages/clerk-js/src/core/resources/Organization.ts

@@ -4,6 +4,7 @@ import type {
   ClerkResourceReloadParams,
   CreateOrganizationParams,
   GetDomainsParams,
+  GetInvitationsParams,
   GetMembershipRequestParams,
   GetMemberships,
   GetPendingInvitationsParams,
@@ -12,6 +13,7 @@ import type {
   OrganizationDomainJSON,
   OrganizationDomainResource,
   OrganizationInvitationJSON,
+  OrganizationInvitationResource,
   OrganizationJSON,
   OrganizationMembershipJSON,
   OrganizationMembershipRequestJSON,
@@ -205,6 +207,29 @@ export class Organization extends BaseResource implements OrganizationResource {
       .catch(() => []);
   };
 
+  getInvitations = async (
+    getInvitationsParams?: GetInvitationsParams,
+  ): Promise<ClerkPaginatedResponse<OrganizationInvitationResource>> => {
+    return await BaseResource._fetch({
+      path: `/organizations/${this.id}/invitations`,
+      method: 'GET',
+      search: convertPageToOffset(getInvitationsParams) as any,
+    })
+      .then(res => {
+        const { data: requests, total_count } =
+          res?.response as unknown as ClerkPaginatedResponse<OrganizationInvitationJSON>;
+
+        return {
+          total_count,
+          data: requests.map(request => new OrganizationInvitation(request)),
+        };
+      })
+      .catch(() => ({
+        total_count: 0,
+        data: [],
+      }));
+  };
+
   addMember = async ({ userId, role }: AddMemberParams) => {
     const newMember = await BaseResource._fetch({
       method: 'POST',

packages/types/src/organization.ts

@@ -44,7 +44,11 @@ export interface OrganizationResource extends ClerkResource {
   updatedAt: Date;
   update: (params: UpdateOrganizationParams) => Promise<OrganizationResource>;
   getMemberships: GetMemberships;
+  /**
+   * @deprecated Use `getInvitations` instead
+   */
   getPendingInvitations: (params?: GetPendingInvitationsParams) => Promise<OrganizationInvitationResource[]>;
+  getInvitations: (params?: GetInvitationsParams) => Promise<ClerkPaginatedResponse<OrganizationInvitationResource>>;
   getDomains: (params?: GetDomainsParams) => Promise<ClerkPaginatedResponse<OrganizationDomainResource>>;
   getMembershipRequests: (
     params?: GetMembershipRequestParams,
@@ -80,6 +84,9 @@ export type GetMembersParams = {
   role?: MembershipRole[];
 };
 
+/**
+ * @deprecated use `getInvitations` instead
+ */
 export type GetPendingInvitationsParams = ClerkPaginationParams;
 export type GetDomainsParams = {
   /**
@@ -94,6 +101,19 @@ export type GetDomainsParams = {
   enrollmentMode?: OrganizationEnrollmentMode;
 };
 
+export type GetInvitationsParams = {
+  /**
+   * This is the starting point for your fetched results. The initial value persists between re-renders
+   */
+  initialPage?: number;
+  /**
+   * Maximum number of items returned per request. The initial value persists between re-renders
+   */
+  pageSize?: number;
+
+  status?: OrganizationInvitationStatus[];
+};
+
 export type GetMembershipRequestParams = {
   /**
    * This is the starting point for your fetched results. The initial value persists between re-renders