feat: fix types and wrapper

Author: cpesket

lib/common-types.ts

@@ -2356,8 +2356,8 @@ export type MRActions = {
   Space: {
     get: { params: GetSpaceParams; return: SpaceProps }
     getMany: {
-      params: QueryParams & { organizationId?: string }
-      return: CollectionProp<SpaceProps>
+      params: (QueryParams | BasicCursorPaginationOptions) & { organizationId?: string }
+      return: CollectionProp<SpaceProps> | CursorPaginatedCollectionProp<SpaceProps>
     }
     getManyForOrganization: {
       params: GetOrganizationParams & QueryParams

lib/create-contentful-api.ts

@@ -1,6 +1,8 @@
 import { createRequestConfig } from 'contentful-sdk-core'
 import type {
   Collection,
+  CollectionProp,
+  CursorPaginatedCollectionProp,
   MakeRequest,
   PaginationQueryParams,
   QueryOptions,
@@ -12,7 +14,12 @@ import type {
   GetOAuthApplicationParams,
   GetUserParams,
 } from './common-types'
-import { wrapSpace, wrapSpaceCollection } from './entities/space'
+import { normalizeCursorPaginationResponse } from './common-utils'
+import {
+  wrapSpace,
+  wrapSpaceCollection,
+  wrapSpaceCursorPaginatedCollection,
+} from './entities/space'
 import { wrapUser } from './entities/user'
 import {
   wrapPersonalAccessToken,
@@ -172,11 +179,19 @@ export default function createClientApi(makeRequest: MakeRequest) {
       query: (QueryOptions | BasicCursorPaginationOptions) & { cursor?: boolean } = {},
       organizationId?: string,
     ): Promise<Collection<Space, SpaceProps> | CursorPaginatedCollection<Space, SpaceProps>> {
+      const { cursor } = query
       return makeRequest({
         entityType: 'Space',
         action: 'getMany',
         params: { query: createRequestConfig({ query }).params, organizationId },
-      }).then((data) => wrapSpaceCollection(makeRequest, data))
+      }).then((data) =>
+        cursor
+          ? wrapSpaceCursorPaginatedCollection(
+              makeRequest,
+              normalizeCursorPaginationResponse(data as CursorPaginatedCollectionProp<SpaceProps>),
+            )
+          : wrapSpaceCollection(makeRequest, data as CollectionProp<SpaceProps>),
+      )
     },
 
     /**

lib/entities/space.ts

@@ -1,7 +1,7 @@
 import { freezeSys, toPlainObject } from 'contentful-sdk-core'
 import copy from 'fast-copy'
 import type { BasicMetaSysProps, DefaultElements, MakeRequest } from '../common-types'
-import { wrapCollection } from '../common-utils'
+import { wrapCollection, wrapCursorPaginatedCollection } from '../common-utils'
 import type { ContentfulSpaceAPI } from '../create-space-api'
 import createSpaceApi from '../create-space-api'
 import enhanceWithMethods from '../enhance-with-methods'
@@ -40,3 +40,4 @@ export function wrapSpace(makeRequest: MakeRequest, data: SpaceProps): Space {
  * @internal
  */
 export const wrapSpaceCollection = wrapCollection(wrapSpace)
+export const wrapSpaceCursorPaginatedCollection = wrapCursorPaginatedCollection(wrapSpace)

lib/plain/entities/space.ts

@@ -3,6 +3,8 @@ import type {
   GetSpaceParams,
   QueryParams,
   CollectionProp,
+  CursorPaginatedCollectionProp,
+  BasicCursorPaginationOptions,
   GetOrganizationParams,
 } from '../../common-types'
 import type { OptionalDefaults } from '../wrappers/wrap'
@@ -34,7 +36,11 @@ export type SpacePlainClientAPI = {
    * });
    * ```
    */
-  getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<SpaceProps>>
+  getMany(
+    params: OptionalDefaults<
+      (QueryParams | BasicCursorPaginationOptions) & { organizationId?: string }
+    >,
+  ): Promise<CollectionProp<SpaceProps> | CursorPaginatedCollectionProp<SpaceProps>>
   /**
    * Fetches all the spaces in the given organization
    * @param params the organization ID and query parameters

test/unit/create-contentful-api.test.ts

@@ -65,48 +65,57 @@ describe('createClientApi', () => {
       ).rejects.toEqual(error)
     })
 
-    test('getSpaces calls getMany with query', async () => {
-      const { api, makeRequest } = setup(
-        Promise.resolve({ sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }),
-      )
+    const collectionResponse = { sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }
+    const cursorCollectionResponse = { sys: { type: 'Array' }, limit: 100, items: [], pages: {} }
+
+    test('getSpaces calls getMany', async () => {
+      const { api, makeRequest } = setup(Promise.resolve(collectionResponse))
       await api.getSpaces({ limit: 10 })
       expect(makeRequest).toHaveBeenCalledWith(
         expect.objectContaining({ entityType: 'Space', action: 'getMany' }),
       )
     })
 
     test('getSpaces with cursor:true passes cursor in query', async () => {
-      const { api, makeRequest } = setup(
-        Promise.resolve({ sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }),
-      )
+      const { api, makeRequest } = setup(Promise.resolve(cursorCollectionResponse))
       await api.getSpaces({ cursor: true, limit: 10 })
       const [call] = makeRequest.mock.calls
       expect(call[0].action).toBe('getMany')
       expect(call[0].params.query).toMatchObject({ cursor: true, limit: 10 })
     })
 
     test('getSpaces with cursor:true and pageNext passes pageNext in query', async () => {
-      const { api, makeRequest } = setup(
-        Promise.resolve({ sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }),
-      )
+      const { api, makeRequest } = setup(Promise.resolve(cursorCollectionResponse))
       await api.getSpaces({ cursor: true, pageNext: 'next-token' })
       const [call] = makeRequest.mock.calls
       expect(call[0].params.query).toMatchObject({ cursor: true, pageNext: 'next-token' })
     })
 
-    test('getSpaces with organizationId passes it in params', async () => {
-      const { api, makeRequest } = setup(
-        Promise.resolve({ sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }),
+    test('getSpaces with cursor:true returns cursor paginated collection', async () => {
+      const { api } = setup(
+        Promise.resolve({ ...cursorCollectionResponse, pages: { next: 'pageNext=abc' } }),
       )
+      const result = await api.getSpaces({ cursor: true })
+      expect(result).toHaveProperty('pages')
+      expect(result).not.toHaveProperty('total')
+    })
+
+    test('getSpaces without cursor returns regular collection', async () => {
+      const { api } = setup(Promise.resolve(collectionResponse))
+      const result = await api.getSpaces()
+      expect(result).toHaveProperty('total')
+      expect(result).not.toHaveProperty('pages')
+    })
+
+    test('getSpaces with organizationId passes it in params', async () => {
+      const { api, makeRequest } = setup(Promise.resolve(collectionResponse))
       await api.getSpaces({}, 'test-org')
       const [call] = makeRequest.mock.calls
       expect(call[0].params.organizationId).toBe('test-org')
     })
 
     test('getSpaces without organizationId omits it from params', async () => {
-      const { api, makeRequest } = setup(
-        Promise.resolve({ sys: { type: 'Array' }, total: 0, skip: 0, limit: 100, items: [] }),
-      )
+      const { api, makeRequest } = setup(Promise.resolve(collectionResponse))
       await api.getSpaces()
       const [call] = makeRequest.mock.calls
       expect(call[0].params.organizationId).toBeUndefined()