chore(backend,types): Re-use ClerkPaginationRequest as base paginatio…

…n type
clerk · Nov 24, 2023 · 7a06e22 · 7a06e22
1 parent 6e1cb81
commit 7a06e22
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 34 deletions.
diff --git a/packages/backend/src/api/endpoints/OrganizationApi.ts b/packages/backend/src/api/endpoints/OrganizationApi.ts
@@ -1,3 +1,5 @@
+import type { ClerkPaginationRequest } from '@clerk/types';
+
 import runtime from '../../runtime';
 import { joinPaths } from '../../util/path';
 import type {
@@ -16,12 +18,10 @@ type MetadataParams<TPublic = OrganizationPublicMetadata, TPrivate = Organizatio
   privateMetadata?: TPrivate;
 };
 
-type GetOrganizationListParams = {
-  limit?: number;
-  offset?: number;
+type GetOrganizationListParams = ClerkPaginationRequest<{
   includeMembersCount?: boolean;
   query?: string;
-};
+}>;
 
 type CreateParams = {
   name: string;
@@ -46,11 +46,9 @@ type UpdateLogoParams = {
 
 type UpdateMetadataParams = MetadataParams;
 
-type GetOrganizationMembershipListParams = {
+type GetOrganizationMembershipListParams = ClerkPaginationRequest<{
   organizationId: string;
-  limit?: number;
-  offset?: number;
-};
+}>;
 
 type CreateOrganizationMembershipParams = {
   organizationId: string;
@@ -79,12 +77,10 @@ type CreateOrganizationInvitationParams = {
   publicMetadata?: OrganizationInvitationPublicMetadata;
 };
 
-type GetOrganizationInvitationListParams = {
+type GetOrganizationInvitationListParams = ClerkPaginationRequest<{
   organizationId: string;
   status?: OrganizationInvitationStatus[];
-  limit?: number;
-  offset?: number;
-};
+}>;
 
 type GetOrganizationInvitationParams = {
   organizationId: string;

diff --git a/packages/backend/src/api/endpoints/OrganizationPermissionApi.ts b/packages/backend/src/api/endpoints/OrganizationPermissionApi.ts
@@ -1,15 +1,15 @@
+import type { ClerkPaginationRequest } from '@clerk/types';
+
 import { joinPaths } from '../../util/path';
 import type { DeletedObject, Permission } from '../resources';
 import { AbstractAPI } from './AbstractApi';
 
 const basePath = '/organizations_permissions';
 
-type GetOrganizationPermissionListParams = {
-  limit?: number;
-  offset?: number;
+type GetOrganizationPermissionListParams = ClerkPaginationRequest<{
   query?: string;
   orderBy?: string;
-};
+}>;
 
 type CreateParams = {
   name: string;

diff --git a/packages/backend/src/api/endpoints/OrganizationRoleApi.ts b/packages/backend/src/api/endpoints/OrganizationRoleApi.ts
@@ -1,15 +1,15 @@
+import type { ClerkPaginationRequest } from '@clerk/types';
+
 import { joinPaths } from '../../util/path';
 import type { DeletedObject, Role } from '../resources';
 import { AbstractAPI } from './AbstractApi';
 
 const basePath = '/organizations_roles';
 
-type GetRoleListParams = {
-  limit?: number;
-  offset?: number;
+type GetRoleListParams = ClerkPaginationRequest<{
   query?: string;
   order_by?: string;
-};
+}>;
 
 type CreateParams = {
   /**

diff --git a/packages/backend/src/api/endpoints/UserApi.ts b/packages/backend/src/api/endpoints/UserApi.ts
@@ -1,4 +1,4 @@
-import type { OAuthProvider } from '@clerk/types';
+import type { ClerkPaginationRequest, OAuthProvider } from '@clerk/types';
 
 import runtime from '../../runtime';
 import { joinPaths } from '../../util/path';
@@ -17,11 +17,11 @@ type UserCountParams = {
   externalId?: string[];
 };
 
-type UserListParams = UserCountParams & {
-  limit?: number;
-  offset?: number;
-  orderBy?: 'created_at' | 'updated_at' | '+created_at' | '+updated_at' | '-created_at' | '-updated_at';
-};
+type UserListParams = ClerkPaginationRequest<
+  UserCountParams & {
+    orderBy?: 'created_at' | 'updated_at' | '+created_at' | '+updated_at' | '-created_at' | '-updated_at';
+  }
+>;
 
 type UserMetadataParams = {
   publicMetadata?: UserPublicMetadata;
@@ -77,11 +77,9 @@ interface UpdateUserParams extends UserMetadataParams {
   createdAt?: Date;
 }
 
-type GetOrganizationMembershipListParams = {
+type GetOrganizationMembershipListParams = ClerkPaginationRequest<{
   userId: string;
-  limit?: number;
-  offset?: number;
-};
+}>;
 
 type VerifyPasswordParams = {
   userId: string;

diff --git a/packages/types/src/pagination.ts b/packages/types/src/pagination.ts
@@ -1,10 +1,16 @@
 /**
  * Pagination params in request
  */
-export interface ClerkPaginationRequest {
+export type ClerkPaginationRequest<T = any> = {
+  /**
+   * Maximum number of items returned per request.
+   */
   limit?: number;
+  /**
+   * This is the starting point for your fetched results.
+   */
   offset?: number;
-}
+} & T;
 
 /**
  * Pagination params in response
@@ -19,11 +25,11 @@ export interface ClerkPaginatedResponse<T> {
  */
 export type ClerkPaginationParams<T = any> = {
   /**
-   * This is the starting point for your fetched results. The initial value persists between re-renders
+   * This is the starting point for your fetched results.
    */
   initialPage?: number;
   /**
-   * Maximum number of items returned per request. The initial value persists between re-renders
+   * Maximum number of items returned per request.
    */
   pageSize?: number;
 } & T;