feat(clerk-js): Support Paginated response in OrganizationMembership.…

…retrieve
clerk · Aug 16, 2023 · c78d028 · c78d028
1 parent 0783e62
commit c78d028
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 12 deletions.
diff --git a/packages/clerk-js/src/core/clerk.ts b/packages/clerk-js/src/core/clerk.ts
@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
     return Organization.create({ name, slug });
   };
 
+  /**
+   * @deprecated use User.getOrganizationMemberships
+   */
   public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
     return await OrganizationMembership.retrieve();
   };

diff --git a/packages/clerk-js/src/core/resources/OrganizationMembership.ts b/packages/clerk-js/src/core/resources/OrganizationMembership.ts
@@ -1,12 +1,15 @@
 import type {
+  ClerkPaginatedResponse,
   ClerkResourceReloadParams,
+  GetUserOrganizationMembershipParams,
   MembershipRole,
   OrganizationMembershipJSON,
   OrganizationMembershipResource,
   PublicUserData,
 } from '@clerk/types';
 
 import { unixEpochToDate } from '../../utils/date';
+import { convertPageToOffset } from '../../utils/pagesToOffset';
 import { BaseResource, Organization } from './internal';
 
 export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
     this.fromJSON(data);
   }
 
-  static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
+  static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
+    const isDeprecatedParams =
+      typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
     return await BaseResource._fetch({
       path: '/me/organization_memberships',
       method: 'GET',
-      search: retrieveMembershipsParams as any,
+      search: isDeprecatedParams
+        ? retrieveMembershipsParams
+        : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
     })
       .then(res => {
-        const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
-        return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
+        if (isDeprecatedParams) {
+          const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
+          return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
+        }
+
+        const { data: suggestions, total_count } =
+          res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;
+
+        return {
+          total_count,
+          data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
+        } as any;
       })
-      .catch(() => []);
-  }
+      .catch(() => {
+        if (isDeprecatedParams) {
+          return [];
+        }
+        return {
+          total_count: 0,
+          data: [],
+        };
+      });
+  };
 
   destroy = async (): Promise<OrganizationMembership> => {
     // TODO: Revise the return type of _baseDelete
@@ -100,7 +125,19 @@ export type UpdateOrganizationMembershipParams = {
   role: MembershipRole;
 };
 
+/**
+ * @deprecated
+ */
 export type RetrieveMembershipsParams = {
   limit?: number;
   offset?: number;
 };
+
+type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
+  paginated?: boolean;
+};
+export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
+  params?: T,
+) => T['paginated'] extends true
+  ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
+  : Promise<OrganizationMembership[]>;
diff --git a/packages/clerk-js/src/core/resources/User.ts b/packages/clerk-js/src/core/resources/User.ts
@@ -10,6 +10,7 @@ import type {
   EmailAddressResource,
   ExternalAccountJSON,
   ExternalAccountResource,
+  GetOrganizationMemberships,
   GetUserOrganizationInvitationsParams,
   GetUserOrganizationSuggestionsParams,
   ImageResource,
@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
 import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
 import { getFullName } from '../../utils/user';
 import { BackupCode } from './BackupCode';
-import type { RetrieveMembershipsParams } from './internal';
 import {
   BaseResource,
   DeletedObject,
@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
     return OrganizationSuggestion.retrieve(params);
   };
 
-  getOrganizationMemberships = async (
-    retrieveMembership: RetrieveMembershipsParams,
-  ): Promise<OrganizationMembership[]> => {
-    return await OrganizationMembership.retrieve(retrieveMembership);
-  };
+  getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
+    OrganizationMembership.retrieve(retrieveMembership);
 
   get verifiedExternalAccounts() {
     return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');

diff --git a/packages/types/src/user.ts b/packages/types/src/user.ts
@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
   getSessions: () => Promise<SessionWithActivitiesResource[]>;
   setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
   createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
+  getOrganizationMemberships: GetOrganizationMemberships;
   getOrganizationInvitations: (
     params?: GetUserOrganizationInvitationsParams,
   ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {
 
   status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
 };
+
+type GetUserOrganizationMembershipOldParams = {
+  limit?: number;
+  offset?: number;
+};
+
+export type GetUserOrganizationMembershipParams = {
+  /**
+   * This 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;
+};
+
+type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
+  paginated?: boolean;
+};
+
+export type GetOrganizationMemberships = <T extends MembershipParams>(
+  params?: T,
+) => T['paginated'] extends true
+  ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
+  : Promise<OrganizationMembershipResource[]>;