feat: cursor based pagination [CAPI-2342]

Author: pavel-mareev

lib/create-contentful-api.ts

@@ -29,6 +29,10 @@ import type {
   Concept,
   ConceptScheme,
   ConceptSchemeCollection,
+  AssetCursorPaginatedCollection,
+  CollectionForQuery,
+  EntryCursorPaginatedCollection,
+  Entry,
 } from './types/index.js'
 import normalizeSearchParameters from './utils/normalize-search-parameters.js'
 import normalizeSelect from './utils/normalize-select.js'
@@ -44,6 +48,8 @@ import {
 } from './utils/validate-params.js'
 import validateSearchParameters from './utils/validate-search-parameters.js'
 import { getTimelinePreviewParams } from './utils/timeline-preview-helpers.js'
+import { normalizeCursorPaginationParameters } from './utils/normalize-cursor-pagination-parameters.js'
+import { normalizeCursorPaginationResponse } from './utils/normalize-cursor-pagination-response.js'
 
 const ASSET_KEY_MAX_LIFETIME = 48 * 60 * 60
 
@@ -210,6 +216,13 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     return makeGetEntries(query, options)
   }
 
+  async function getEntriesCursor(
+    query = {},
+  ): Promise<EntryCursorPaginatedCollection<EntrySkeletonType>> {
+    const response = await makeGetEntries(normalizeCursorPaginationParameters(query), options)
+    return normalizeCursorPaginationResponse(response)
+  }
+
   async function makeGetEntry<EntrySkeleton extends EntrySkeletonType>(
     id: string,
     query,
@@ -242,10 +255,12 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
       throw notFoundError(id)
     }
     try {
-      const response = await internalGetEntries<EntrySkeletonType<EntrySkeleton>, Locales, Options>(
-        { 'sys.id': id, ...maybeEnableSourceMaps(query) },
-        options,
-      )
+      const response = await internalGetEntries<
+        EntrySkeletonType<EntrySkeleton>,
+        Locales,
+        Options,
+        Record<string, unknown>
+      >({ 'sys.id': id, ...maybeEnableSourceMaps(query) }, options)
       if (response.items.length > 0) {
         return response.items[0]
       } else {
@@ -256,8 +271,11 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     }
   }
 
-  async function makeGetEntries<EntrySkeleton extends EntrySkeletonType>(
-    query,
+  async function makeGetEntries<
+    EntrySkeleton extends EntrySkeletonType,
+    Query extends Record<string, unknown>,
+  >(
+    query: Query,
     options: ChainOptions = {
       withAllLocales: false,
       withoutLinkResolution: false,
@@ -271,7 +289,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     validateRemoveUnresolvedParam(query)
     validateSearchParameters(query)
 
-    return internalGetEntries<EntrySkeleton, any, Extract<ChainOptions, typeof options>>(
+    return internalGetEntries<EntrySkeleton, any, Extract<ChainOptions, typeof options>, Query>(
       withAllLocales
         ? {
             ...query,
@@ -293,10 +311,13 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     EntrySkeleton extends EntrySkeletonType,
     Locales extends LocaleCode,
     Options extends ChainOptions,
+    Query extends Record<string, unknown>,
   >(
-    query: Record<string, any>,
+    query: Query,
     options: Options,
-  ): Promise<EntryCollection<EntrySkeleton, ModifiersFromOptions<Options>, Locales>> {
+  ): Promise<
+    CollectionForQuery<Entry<EntrySkeleton, ModifiersFromOptions<Options>, Locales>, Query>
+  > {
     const { withoutLinkResolution, withoutUnresolvableLinks } = options
     try {
       const entries = await get({
@@ -324,8 +345,15 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     return makeGetAssets(query, options)
   }
 
-  async function makeGetAssets(
-    query: Record<string, any>,
+  async function getAssetsCursor(
+    query: Record<string, any> = {},
+  ): Promise<AssetCursorPaginatedCollection> {
+    const response = await makeGetAssets(normalizeCursorPaginationParameters(query), options)
+    return normalizeCursorPaginationResponse(response)
+  }
+
+  async function makeGetAssets<Query extends Record<string, any>>(
+    query: Query,
     options: ChainOptions = {
       withAllLocales: false,
       withoutLinkResolution: false,
@@ -339,7 +367,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
 
     const localeSpecificQuery = withAllLocales ? { ...query, locale: '*' } : query
 
-    return internalGetAssets<any, Extract<ChainOptions, typeof options>>(localeSpecificQuery)
+    return internalGetAssets<any, Extract<ChainOptions, typeof options>, Query>(localeSpecificQuery)
   }
 
   async function internalGetAsset<Locales extends LocaleCode, Options extends ChainOptions>(
@@ -376,9 +404,13 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     return internalGetAsset<any, Extract<ChainOptions, typeof options>>(id, localeSpecificQuery)
   }
 
-  async function internalGetAssets<Locales extends LocaleCode, Options extends ChainOptions>(
-    query: Record<string, any>,
-  ): Promise<AssetCollection<ModifiersFromOptions<Options>, Locales>> {
+  async function internalGetAssets<
+    Locales extends LocaleCode,
+    Options extends ChainOptions,
+    Query extends Record<string, any>,
+  >(
+    query: Query,
+  ): Promise<CollectionForQuery<Asset<ModifiersFromOptions<Options>, Locales>, Query>> {
     try {
       return get({
         context: 'environment',
@@ -657,6 +689,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
 
     getAsset,
     getAssets,
+    getAssetsCursor,
 
     getTag,
     getTags,
@@ -667,6 +700,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
 
     getEntry,
     getEntries,
+    getEntriesCursor,
 
     getConceptScheme,
     getConceptSchemes,

lib/types/asset.ts

@@ -1,4 +1,4 @@
-import type { ContentfulCollection } from './collection.js'
+import type { ContentfulCollection, CursorPaginatedCollection } from './collection.js'
 import type { LocaleCode } from './locale.js'
 import type { Metadata } from './metadata.js'
 import type { EntitySys } from './sys.js'
@@ -85,6 +85,18 @@ export type AssetCollection<
   Locales extends LocaleCode = LocaleCode,
 > = ContentfulCollection<Asset<Modifiers, Locales>>
 
+/**
+ * A cursor paginated collection of assets
+ * @category Asset
+ * @typeParam Modifiers - The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for asset field values.
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets | Documentation}
+ */
+export type AssetCursorPaginatedCollection<
+  Modifiers extends ChainModifiers = ChainModifiers,
+  Locales extends LocaleCode = LocaleCode,
+> = CursorPaginatedCollection<Asset<Modifiers, Locales>>
+
 /**
  * System managed metadata for assets
  * @category Asset

lib/types/client.ts

@@ -4,19 +4,26 @@ import type { LocaleCode, LocaleCollection } from './locale.js'
 import type {
   AssetQueries,
   AssetsQueries,
+  AssetsQueriesCursor,
   ConceptAncestorsDescendantsQueries,
   ConceptSchemesQueries,
   ConceptsQueries,
   EntriesQueries,
+  EntriesQueriesCursor,
   EntryQueries,
   EntrySkeletonType,
   TagQueries,
 } from './query/index.js'
 import type { SyncCollection, SyncOptions, SyncQuery } from './sync.js'
 import type { Tag, TagCollection } from './tag.js'
 import type { AssetKey } from './asset-key.js'
-import type { Entry, EntryCollection } from './entry.js'
-import type { Asset, AssetCollection, AssetFields } from './asset.js'
+import type { Entry, EntryCollection, EntryCursorPaginatedCollection } from './entry.js'
+import type {
+  Asset,
+  AssetCollection,
+  AssetCursorPaginatedCollection,
+  AssetFields,
+} from './asset.js'
 import type { Concept, ConceptCollection } from './concept.js'
 import type { ConceptScheme, ConceptSchemeCollection } from './concept-scheme.js'
 
@@ -407,6 +414,36 @@ export interface ContentfulClientApi<Modifiers extends ChainModifiers> {
     query?: EntriesQueries<EntrySkeleton, Modifiers>,
   ): Promise<EntryCollection<EntrySkeleton, Modifiers, Locales>>
 
+  /**
+   * Fetches a cursor paginated collection of Entries
+   * @param pagination - Object with cursor pagination options
+   * @param query - Object with search parameters
+   * @returns Promise for a cursor paginated collection of Entries
+   * @typeParam EntrySkeleton - Shape of entry fields used to calculate dynamic keys
+   * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for entry field values.
+   * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/cursor-pagination | REST API cursor pagination reference}
+   * @see {@link https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters | JS SDK tutorial}
+   * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters | REST API reference}
+   * @example
+   * ```typescript
+   * const contentful = require('contentful')
+   *
+   * const client = contentful.createClient({
+   *   space: '<space_id>',
+   *   accessToken: '<content_delivery_api_key>'
+   * })
+   *
+   * const response = await client.getEntriesCursor()
+   * console.log(response.items)
+   * ```
+   */
+  getEntriesCursor<
+    EntrySkeleton extends EntrySkeletonType = EntrySkeletonType,
+    Locales extends LocaleCode = LocaleCode,
+  >(
+    query?: EntriesQueriesCursor<EntrySkeleton, Modifiers>,
+  ): Promise<EntryCursorPaginatedCollection<EntrySkeleton, Modifiers, Locales>>
+
   /**
    * Parse raw json data into a collection of entries. objects.Links will be resolved also
    * @param data - json data
@@ -495,6 +532,30 @@ export interface ContentfulClientApi<Modifiers extends ChainModifiers> {
     query?: AssetsQueries<AssetFields, Modifiers>,
   ): Promise<AssetCollection<Modifiers, Locales>>
 
+  /**
+   * Fetches a cursor paginated collection of assets
+   * @param pagination - Object with cursor pagination options
+   * @param query - Object with search parameters
+   * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/cursor-pagination | REST API cursor pagination reference}
+   * @see {@link https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters | JS SDK tutorial}
+   * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters | REST API reference}
+   * @returns Promise for a cursor paginated collection of Assets
+   * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for asset field values.
+   * @example
+   * const contentful = require('contentful')
+   *
+   * const client = contentful.createClient({
+   *   space: '<space_id>',
+   *   accessToken: '<content_delivery_api_key>'
+   * })
+   *
+   * const response = await client.getAssetsCursor()
+   * console.log(response.items)
+   */
+  getAssetsCursor<Locales extends LocaleCode = LocaleCode>(
+    query?: AssetsQueriesCursor<AssetFields, Modifiers>,
+  ): Promise<AssetCursorPaginatedCollection<Modifiers, Locales>>
+
   /**
    * A client that will fetch assets and entries with all locales. Only available if not already enabled.
    */

lib/types/collection.ts

@@ -1,16 +1,50 @@
-import type { AssetSys } from './asset.js'
-import type { EntrySys } from './entry.js'
+export type CollectionBase<T> = {
+  limit: number
+  items: Array<T>
+  sys?: {
+    type: 'Array'
+  }
+}
+
+export type OffsetPagination = {
+  total: number
+  skip: number
+}
+
+export type CursorPagination = {
+  pages: {
+    next?: string
+    prev?: string
+  }
+}
 
 /**
  * A wrapper object containing additional information for
- * a collection of Contentful resources
+ * an offset paginated collection of Contentful resources
  * @category Entity
  * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination | Documentation}
  */
-export interface ContentfulCollection<T> {
-  total: number
-  skip: number
-  limit: number
-  items: Array<T>
-  sys?: AssetSys | EntrySys
-}
+export type OffsetPaginatedCollection<T = unknown> = CollectionBase<T> & OffsetPagination
+
+/**
+ * A wrapper object containing additional information for
+ * an offset paginated collection of Contentful resources
+ * @category Entity
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination | Documentation}
+ */
+export interface ContentfulCollection<T = unknown> extends OffsetPaginatedCollection<T> {}
+
+/**
+ * A wrapper object containing additional information for
+ * a curisor paginated collection of Contentful resources
+ * @category Entity
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/cursor-pagination | Documentation}
+ */
+export type CursorPaginatedCollection<T = unknown> = CollectionBase<T> & CursorPagination
+
+export type WithCursorPagination = { cursor: true }
+
+export type CollectionForQuery<
+  T = unknown,
+  Query extends Record<string, unknown> = Record<string, unknown>,
+> = Query extends WithCursorPagination ? CursorPaginatedCollection<T> : OffsetPaginatedCollection<T>

lib/types/concept-scheme.ts

@@ -1,3 +1,4 @@
+import type { CursorPaginatedCollection } from './collection'
 import type { UnresolvedLink } from './link'
 import type { LocaleCode } from './locale'
 
@@ -27,14 +28,6 @@ export interface ConceptScheme<Locales extends LocaleCode> {
   totalConcepts: number
 }
 
-export type ConceptSchemeCollection<Locale extends LocaleCode> = {
-  sys: {
-    type: 'Array'
-  }
-  items: ConceptScheme<Locale>[]
-  limit: number
-  pages?: {
-    prev?: string
-    next?: string
-  }
-}
+export type ConceptSchemeCollection<Locale extends LocaleCode> = CursorPaginatedCollection<
+  ConceptScheme<Locale>
+>

lib/types/concept.ts

@@ -1,3 +1,4 @@
+import type { CursorPaginatedCollection } from './collection'
 import type { UnresolvedLink } from './link'
 import type { LocaleCode } from './locale'
 
@@ -64,14 +65,6 @@ export interface Concept<Locales extends LocaleCode> {
   conceptSchemes?: UnresolvedLink<'TaxonomyConceptScheme'>[]
 }
 
-export type ConceptCollection<Locale extends LocaleCode> = {
-  sys: {
-    type: 'Array'
-  }
-  items: Concept<Locale>[]
-  limit: number
-  pages?: {
-    prev?: string
-    next?: string
-  }
-}
+export type ConceptCollection<Locale extends LocaleCode> = CursorPaginatedCollection<
+  Concept<Locale>
+>