Revert "feat: add TS support cursor based pagination [CAPI-2270] (#2792)" (#2805)

Author: mrlaessig

README.md

@@ -53,7 +53,6 @@
   - [Authentication](#authentication)
   - [Using ES6 import](#using-es6-import)
   - [Your first Request](#your-first-request)
-  - [Cursor based pagination](#cursor-based-pagination)
   - [Alternative plain API](#alternative-plain-api)
 - [App Framework](#app-framework)
 - [Troubleshooting](#troubleshooting)
@@ -228,18 +227,6 @@ The benefits of using the "plain" version of the client, over the legacy version
 - The ability to scope CMA client instance to a specific `spaceId`, `environmentId`, and `organizationId` when initializing the client.
   - You can pass a concrete values to `defaults` and omit specifying these params in actual CMA methods calls.
 
-## Cursor Based Pagination
-
-Cursor-based pagination is supported on collection endpoints for content types, entries, and assets. To use cursor-based pagination, pass the `cursor: true` parameter in your query:
-
-```js
-const response = await environment.getEntries({ cursor: true, limit: 10 });
-console.log(response.items); // Array of items
-console.log(response.pages?.next); // Cursor for next page
-```
-
-Use the value from `response.pages.next` to fetch the next page.
-
 ## Legacy Client Interface
 
 The following code snippet is an example of the legacy client interface, which reads and writes data as a sequence of nested requests:

lib/common-types.ts

@@ -368,15 +368,6 @@ interface CursorPaginationBase {
   limit?: number
 }
 
-export type OptionalCursorApi<P, T, TPlain> = {
-  (
-    query: P & CursorBasedParams['query'] & { cursor: true; skip?: never },
-  ): Promise<CursorPaginatedCollection<T, TPlain>>
-  (query?: P & { cursor?: false | undefined | never }): Promise<Collection<T, TPlain>>
-  (query?: P): Promise<Collection<T, TPlain>>
-}
-
-type WithCursorPagination<O> = O & { params: { query: { cursor: true } } }
 // Interfaces for each “exclusive” shape
 interface CursorPaginationPageNext extends CursorPaginationBase {
   pageNext: string
@@ -495,13 +486,7 @@ type MRInternal<UA extends boolean> = {
     opts: MROpts<'AppInstallation', 'getForOrganization', UA>,
   ): MRReturn<'AppInstallation', 'getForOrganization'>
 
-  (
-    opts: WithCursorPagination<MROpts<'Asset', 'getMany', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<AssetProps>>
   (opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>
-  (
-    opts: WithCursorPagination<MROpts<'Asset', 'getPublished', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<AssetProps>>
   (opts: MROpts<'Asset', 'getPublished', UA>): MRReturn<'Asset', 'getPublished'>
   (opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>
   (opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>
@@ -581,9 +566,6 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>
 
   (opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>
-  (
-    opts: WithCursorPagination<MROpts<'ContentType', 'getMany', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<ConceptProps>>
   (opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>
   (opts: MROpts<'ContentType', 'update', UA>): MRReturn<'ContentType', 'update'>
   (opts: MROpts<'ContentType', 'create', UA>): MRReturn<'ContentType', 'create'>
@@ -593,9 +575,6 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'ContentType', 'unpublish', UA>): MRReturn<'ContentType', 'unpublish'>
 
   (opts: MROpts<'EditorInterface', 'get', UA>): MRReturn<'EditorInterface', 'get'>
-  (
-    opts: WithCursorPagination<MROpts<'EditorInterface', 'getMany', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<EditorInterfaceProps>>
   (opts: MROpts<'EditorInterface', 'getMany', UA>): MRReturn<'EditorInterface', 'getMany'>
   (opts: MROpts<'EditorInterface', 'update', UA>): MRReturn<'EditorInterface', 'update'>
 
@@ -636,13 +615,7 @@ type MRInternal<UA extends boolean> = {
     opts: MROpts<'EnvironmentTemplateInstallation', 'getForEnvironment', UA>,
   ): MRReturn<'EnvironmentTemplateInstallation', 'getForEnvironment'>
 
-  (
-    opts: WithCursorPagination<MROpts<'Entry', 'getMany', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<EntryProps>>
   (opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>
-  (
-    opts: WithCursorPagination<MROpts<'Entry', 'getPublished', UA>>,
-  ): Promise<CursorPaginatedCollectionProp<EntryProps>>
   (opts: MROpts<'Entry', 'getPublished', UA>): MRReturn<'Entry', 'getPublished'>
   (opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>
   (opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>

lib/common-utils.ts

@@ -8,7 +8,6 @@ import type {
   CursorPaginatedCollection,
   CursorPaginatedCollectionProp,
   MakeRequest,
-  OptionalCursorApi,
 } from './common-types'
 
 /**
@@ -24,20 +23,6 @@ export const wrapCollection =
     return collectionData
   }
 
-/**
- * @private
- * Function for endpoints allowing `?cursor=true` wrapping the call
- * to ensure the correct return type for cursor based pagination
- * when `cursor: true`.
- */
-export const withOptionalCursorApi = <P, T, TPlain>(
-  fn: OptionalCursorApi<P, T, TPlain>,
-): OptionalCursorApi<P, T, TPlain> => {
-  return function (args) {
-    return fn.call(this, args)
-  }
-}
-
 export const wrapCursorPaginatedCollection =
   <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) =>
   (

lib/create-environment-api.ts

@@ -61,7 +61,6 @@ import type { CreateAppAccessTokenProps } from './entities/app-access-token'
 import type { ResourceQueryOptions } from './entities/resource'
 import type { AiActionInvocationType } from './entities/ai-action-invocation'
 import { wrapAiActionInvocation } from './entities/ai-action-invocation'
-import { withOptionalCursorApi } from './common-utils'
 
 /**
  * @private
@@ -481,7 +480,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * .catch(console.error)
      * ```
      */
-    getContentTypes: withOptionalCursorApi(function (query: QueryOptions = {}) {
+    getContentTypes(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       return makeRequest({
         entityType: 'ContentType',
@@ -492,7 +491,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
           query: createRequestConfig({ query }).params,
         },
       }).then((data) => wrapContentTypeCollection(makeRequest, data))
-    }),
+    },
     /**
      * Creates a Content Type
      * @param data - Object representation of the Content Type to be created
@@ -728,7 +727,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * .catch(console.error)
      * ```
      */
-    getEntries: withOptionalCursorApi(function (query: QueryOptions = {}) {
+    getEntries(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       return makeRequest({
         entityType: 'Entry',
@@ -739,7 +738,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
           query: createRequestConfig({ query: query }).params,
         },
       }).then((data) => wrapEntryCollection(makeRequest, data))
-    }),
+    },
 
     /**
      * Gets a collection of published Entries
@@ -759,7 +758,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * .catch(console.error)
      * ```
      */
-    getPublishedEntries: withOptionalCursorApi(function (query: QueryOptions = {}) {
+    getPublishedEntries(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       return makeRequest({
         entityType: 'Entry',
@@ -770,7 +769,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
           query: createRequestConfig({ query: query }).params,
         },
       }).then((data) => wrapEntryCollection(makeRequest, data))
-    }),
+    },
 
     /**
      * Creates a Entry
@@ -944,7 +943,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * .catch(console.error)
      * ```
      */
-    getAssets: withOptionalCursorApi(function (query: QueryOptions = {}) {
+    getAssets(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       return makeRequest({
         entityType: 'Asset',
@@ -955,7 +954,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
           query: createRequestConfig({ query: query }).params,
         },
       }).then((data) => wrapAssetCollection(makeRequest, data))
-    }),
+    },
     /**
      * Gets a collection of published Assets
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -974,7 +973,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * .catch(console.error)
      * ```
      */
-    getPublishedAssets: withOptionalCursorApi(function (query: QueryOptions = {}) {
+    getPublishedAssets(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       return makeRequest({
         entityType: 'Asset',
@@ -985,7 +984,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
           query: createRequestConfig({ query: query }).params,
         },
       }).then((data) => wrapAssetCollection(makeRequest, data))
-    }),
+    },
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.

lib/plain/common-types.ts

@@ -140,8 +140,6 @@ import type { FunctionLogPlainClientAPI } from './entities/function-log'
 import type { AiActionPlainClientAPI } from './entities/ai-action'
 import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation'
 
-type WithCursorBasedPagination<T> = T & { query: { cursor: true } }
-
 export type PlainClientAPI = {
   raw: {
     getDefaultParams(): DefaultParams | undefined
@@ -226,6 +224,7 @@ export type PlainClientAPI = {
         environmentTemplateId: string
         organizationId: string
         spaceId?: string
+        latestOnly?: boolean
       },
       headers?: RawAxiosRequestHeaders,
     ): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>
@@ -272,9 +271,6 @@ export type PlainClientAPI = {
   conceptScheme: ConceptSchemePlainClientAPI
   contentType: {
     get(params: OptionalDefaults<GetContentTypeParams & QueryParams>): Promise<ContentTypeProps>
-    getMany(
-      params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>,
-    ): Promise<CursorPaginatedCollectionProp<ContentTypeProps>>
     getMany(
       params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>,
     ): Promise<CollectionProp<ContentTypeProps>>
@@ -305,29 +301,16 @@ export type PlainClientAPI = {
   }
   user: UserPlainClientAPI
   entry: {
-    getPublished<T extends KeyValueMap = KeyValueMap>(
-      params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>,
-      rawData?: unknown,
-      headers?: RawAxiosRequestHeaders,
-    ): Promise<CursorPaginatedCollectionProp<EntryProps<T>>>
     getPublished<T extends KeyValueMap = KeyValueMap>(
       params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>,
       rawData?: unknown,
       headers?: RawAxiosRequestHeaders,
     ): Promise<CollectionProp<EntryProps<T>>>
-    getMany<T extends KeyValueMap = KeyValueMap>(
-      params: WithCursorBasedPagination<
-        OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }>
-      >,
-      rawData?: unknown,
-      headers?: RawAxiosRequestHeaders,
-    ): Promise<CursorPaginatedCollectionProp<EntryProps<T>>>
     getMany<T extends KeyValueMap = KeyValueMap>(
       params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }>,
       rawData?: unknown,
       headers?: RawAxiosRequestHeaders,
     ): Promise<CollectionProp<EntryProps<T>>>
-
     get<T extends KeyValueMap = KeyValueMap>(
       params: OptionalDefaults<GetSpaceEnvironmentParams & { entryId: string; releaseId?: string }>,
       rawData?: unknown,
@@ -382,23 +365,11 @@ export type PlainClientAPI = {
     ): Promise<EntryReferenceProps>
   }
   asset: {
-    getPublished(
-      params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>,
-      rawData?: unknown,
-      headers?: RawAxiosRequestHeaders,
-    ): Promise<CursorPaginatedCollectionProp<AssetProps>>
     getPublished(
       params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>,
       rawData?: unknown,
       headers?: RawAxiosRequestHeaders,
     ): Promise<CollectionProp<AssetProps>>
-    getMany(
-      params: WithCursorBasedPagination<
-        OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }>
-      >,
-      rawData?: unknown,
-      headers?: RawAxiosRequestHeaders,
-    ): Promise<CursorPaginatedCollectionProp<AssetProps>>
     getMany(
       params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }>,
       rawData?: unknown,

lib/plain/plain-client.ts

@@ -216,11 +216,7 @@ export const createPlainClient = (
     },
     contentType: {
       get: wrap(wrapParams, 'ContentType', 'get'),
-      getMany: wrap(
-        wrapParams,
-        'ContentType',
-        'getMany',
-      ) as PlainClientAPI['contentType']['getMany'],
+      getMany: wrap(wrapParams, 'ContentType', 'getMany'),
       update: wrap(wrapParams, 'ContentType', 'update'),
       delete: wrap(wrapParams, 'ContentType', 'delete'),
       publish: wrap(wrapParams, 'ContentType', 'publish'),
@@ -249,12 +245,8 @@ export const createPlainClient = (
       delete: wrap(wrapParams, 'Task', 'delete'),
     },
     entry: {
-      getPublished: wrap(
-        wrapParams,
-        'Entry',
-        'getPublished',
-      ) as PlainClientAPI['entry']['getPublished'],
-      getMany: wrap(wrapParams, 'Entry', 'getMany') as PlainClientAPI['entry']['getMany'],
+      getPublished: wrap(wrapParams, 'Entry', 'getPublished'),
+      getMany: wrap(wrapParams, 'Entry', 'getMany'),
       get: wrap(wrapParams, 'Entry', 'get'),
       update: wrap(wrapParams, 'Entry', 'update'),
       patch: wrap(wrapParams, 'Entry', 'patch'),
@@ -268,12 +260,8 @@ export const createPlainClient = (
       references: wrap(wrapParams, 'Entry', 'references'),
     },
     asset: {
-      getPublished: wrap(
-        wrapParams,
-        'Asset',
-        'getPublished',
-      ) as PlainClientAPI['asset']['getPublished'],
-      getMany: wrap(wrapParams, 'Asset', 'getMany') as PlainClientAPI['asset']['getMany'],
+      getPublished: wrap(wrapParams, 'Asset', 'getPublished'),
+      getMany: wrap(wrapParams, 'Asset', 'getMany'),
       get: wrap(wrapParams, 'Asset', 'get'),
       update: wrap(wrapParams, 'Asset', 'update'),
       delete: wrap(wrapParams, 'Asset', 'delete'),

test/integration/asset-integration.test.ts

@@ -11,7 +11,6 @@ import {
   getTestOrganizationId,
 } from '../helpers'
 import type { ConceptProps, Environment, PlainClientAPI, Space } from '../../lib/export-types'
-import { TestDefaults } from '../defaults'
 
 describe('Asset API - Read', () => {
   let space: Space
@@ -44,43 +43,6 @@ describe('Asset API - Read', () => {
     const response = await environment.getPublishedAssets()
     expect(response.items).toBeTruthy()
   })
-
-  test('Gets assets cursor', async () => {
-    const response = await environment.getAssets({ cursor: true, limit: 1 })
-    expect(response.items).toBeTruthy()
-    expect(response.pages?.next).to.be.string
-  })
-
-  test('Gets published assets cursor', async () => {
-    const response = await environment.getPublishedAssets({ cursor: true, limit: 1 })
-    expect(response.items).toBeTruthy()
-    expect(response.pages?.next).to.be.string
-  })
-})
-
-describe('read plainClientApi', () => {
-  const createEntryClient = initPlainClient({
-    environmentId: TestDefaults.environmentId,
-    spaceId: TestDefaults.spaceId,
-  })
-
-  test('getMany cursor', async () => {
-    const response = await createEntryClient.asset.getMany({ query: { cursor: true, limit: 1 } })
-    expect(response.items).lengthOf(1)
-    expect(response.pages?.next).to.be.string
-  })
-
-  test('getMany published cursor', async () => {
-    const response = await createEntryClient.asset.getPublished({
-      query: {
-        cursor: true,
-        limit: 1,
-      },
-    })
-
-    expect(response.items).lengthOf(1)
-    expect(response.pages?.next).to.be.string
-  })
 })
 
 describe('Asset API - Write', { concurrent: true }, () => {