feat: add dedicated methods for cursor based pagination [CAPI-2357] by ebefarooqui · Pull Request #2824 · contentful/contentful-management.js

Ebrahem Farooqui (ebefarooqui) · 2025-11-21T10:19:56Z

Summary

Introduces three dedicated cursor pagination methods, one per each relevant entity:

getAssetsWithCursor
getContentTypesWithCursor
getEntriesWithCursor

Description

These changes expose three new dedicated methods in the plain client for cursor based pagination. These methods map to the getMany endpoint per each entity and are wrapped accordingly with the appropriate cursor pagination collection. Relevant unit and integration tests are also included.

Motivation and Context

Previously we tried to provide correct typing for cma.js by checking the cursor parameter to be true. As the type system of cma.js is already quite complex, this introduced a bug we were not able to foresee. As a result, this was rolled back and the decision was taken to introduce dedicated methods for cursor-based pagination.

PR Checklist

I have read the CONTRIBUTING.md file
All commits follow conventional commits
Documentation is updated (if necessary)
PR doesn't contain any sensitive information
There are no breaking changes

…ods for entry, asset, and content-type [CAPI-2357] Adds getManyWithCursor as a dedicated cursor based method for entry, asset, and content-type and getPublishedWithCursor for only the asset and entry entities

…response and params and building utilities to do so [CAPI-2357] * fix: getPublished does not currently support cursor based pagination, removing relevant methods for entities * fix: normalize pagination params to filter prevPage and prevNext if falsey * fix: normalize pagination response to parse next, prev tokens if present

… for getManyWithCursor for content-type, asset, and entry entities [CAPI-2357]

…API-2357]

wiz-inc-38d59fb8d7 · 2025-11-21T10:20:37Z

Wiz Scan Summary

Scanner	Findings
Vulnerabilities	-
Sensitive Data	-
Secrets	-
IaC Misconfigurations	-
SAST Findings	-

Total	-

View scan details in Wiz

To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension.

lib/adapters/REST/make-request.ts

lib/common-utils.ts

test/unit/test-creators/static-entity-methods.ts

lib/common-utils.ts

README.md

test/integration/asset-integration.test.ts

…console statements, adding cbp to toc in readme [CAPI-2357]

…2819) Co-authored-by: Ely Lucas <ely.lucas@contentful.com>

…ased-pagination

…etManyWithCursor methods [CAPI-2357]

lib/entities/entry.ts

lib/common-utils.ts

…[CAPI-2357]

ethan ozelius (ethan-ozelius-contentful) · 2025-11-25T21:14:09Z

lib/common-types.ts

 }

 export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 'skip'> {
+  skip?: never


Isn't this skip unnecessary given the Omit above?

Why is this type used in all the non cursor based functions as signature? 🤔

ethan ozelius (@ethan-ozelius-contentful) It's there because unless strictly forbidden, the value can still be passed in at runtime. I wanted to make sure to have a type error there just in case.

Marco Link (@marcolink) Could you point to where that is the case? I'm not sure I follow right now, apologies

Here for example:

https://github.com/contentful/contentful-management.js/pull/2824/files#diff-5d65b07a85ecfbaae4af51feabd68aefb18ecbf40d80f8076768882c66d01b73L947

(not changed in this PR)

I see. I'm not sure why, but can investigate. I was using the same type to idiomatically match how we were using it elsewhere.

Unfortunately, changing that now would likely create a breaking change ...

Agreed, we can make a point to investigate what's happening here and if need be spin up another ticket?

Not blocking, but we have a new major version coming up which would allow to "fix" it.

ethan ozelius (ethan-ozelius-contentful) · 2025-11-25T21:30:00Z

lib/create-environment-api.ts

    },
+
+    /**
+     * Gets a collection of Content Types with cursor based pagination


These two URLs listed in this param should probably point to the follow URL right?

https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/cursor-pagination?

ethan ozelius (ethan-ozelius-contentful)

Left 1-2 non-blocking questions, but otherwise looks good.

README.md

Marco Link (marcolink) · 2025-11-26T08:13:39Z

lib/common-types.ts

 }

 export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 'skip'> {
+  skip?: never


Why is this type used in all the non cursor based functions as signature? 🤔

…nation example to readme [CAPI-2357]

…ased-pagination

README.md

…ased-pagination

Ebrahem Farooqui (ebefarooqui) added 4 commits November 19, 2025 14:46

feat: add dedicated getManyWithCursor and getPublishedWithCursor meth…

cd8d735

…ods for entry, asset, and content-type [CAPI-2357] Adds getManyWithCursor as a dedicated cursor based method for entry, asset, and content-type and getPublishedWithCursor for only the asset and entry entities

test: add unit tests for create-environment-api and integration tests…

de2e56c

… for getManyWithCursor for content-type, asset, and entry entities [CAPI-2357]

chore: updating README.md to reflect new cursor pagination methods [C…

84d693a

…API-2357]

Ebrahem Farooqui (ebefarooqui) requested a review from a team as a code owner November 21, 2025 10:19

Ebrahem Farooqui (ebefarooqui) requested review from Marco Link (marcolink) and Laurence (mrlaessig) November 21, 2025 10:20

chore: fix linting errors in new test suites and lib/

790f711

Balaganesh Damodaran (asleepysamurai) reviewed Nov 21, 2025

View reviewed changes

lib/adapters/REST/make-request.ts Outdated Show resolved Hide resolved

Balaganesh Damodaran (asleepysamurai) reviewed Nov 21, 2025

View reviewed changes

lib/common-utils.ts Show resolved Hide resolved

chore: removing unused console.debug line [CAPI-2357]

a2a540e

Pavel Mareev (pavel-mareev) reviewed Nov 21, 2025

View reviewed changes

test/unit/test-creators/static-entity-methods.ts Outdated Show resolved Hide resolved

lib/common-utils.ts Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

test/integration/asset-integration.test.ts Show resolved Hide resolved

fix: enforcing no skip param for query options, removing uneccessary …

09e8e07

…console statements, adding cbp to toc in readme [CAPI-2357]

Ebrahem Farooqui (ebefarooqui) force-pushed the feature/add-dedicated-methods-for-cursor-based-pagination branch from 2ac557b to 09e8e07 Compare November 21, 2025 15:43

Ely Lucas (elylucasctfl) and others added 4 commits November 21, 2025 16:48

chore: update readme badge and change to master branch in workflow (#…

0603508

…2819) Co-authored-by: Ely Lucas <ely.lucas@contentful.com>

chore: fixing linting errors in asset-integration-test [CAPI-2357]

725fc0d

Merge branch 'master' into feature/add-dedicated-methods-for-cursor-b…

4810416

…ased-pagination

fix: fixing typing to include CursorBasedParams not QueryParams for g…

5fc9db5

…etManyWithCursor methods [CAPI-2357]

Laurence (mrlaessig) reviewed Nov 24, 2025

View reviewed changes

lib/entities/entry.ts Outdated Show resolved Hide resolved

lib/common-utils.ts Show resolved Hide resolved

lib/common-utils.ts Show resolved Hide resolved

fix: infer typing for cursor pagination collection method per entity …

fa0dca8

…[CAPI-2357]

ethan ozelius (ethan-ozelius-contentful) reviewed Nov 25, 2025

View reviewed changes

ethan ozelius (ethan-ozelius-contentful) previously approved these changes Nov 25, 2025

View reviewed changes

Marco Link (marcolink) reviewed Nov 26, 2025

View reviewed changes

chore: updating param comment to reflect appropriate url, adding pagi…

49dbd1e

…nation example to readme [CAPI-2357]

Ebrahem Farooqui (ebefarooqui) dismissed ethan ozelius (ethan-ozelius-contentful)’s stale review via 49dbd1e November 26, 2025 15:48

Merge branch 'master' into feature/add-dedicated-methods-for-cursor-b…

5999613

…ased-pagination

Laurence (mrlaessig) approved these changes Dec 2, 2025

View reviewed changes

Merge branch 'master' into feature/add-dedicated-methods-for-cursor-b…

178da7f

…ased-pagination

Marco Link (marcolink) reviewed Dec 4, 2025

View reviewed changes

README.md Show resolved Hide resolved

Ebrahem Farooqui (ebefarooqui) added 2 commits December 5, 2025 14:10

Merge branch 'master' into feature/add-dedicated-methods-for-cursor-b…

79c8d46

…ased-pagination

Merge branch 'master' into feature/add-dedicated-methods-for-cursor-b…

a749617

…ased-pagination

Marco Link (marcolink) approved these changes Dec 9, 2025

View reviewed changes

Michael Pham (michaelphamcf) approved these changes Dec 9, 2025

View reviewed changes

Ebrahem Farooqui (ebefarooqui) merged commit 9148fc9 into master Dec 9, 2025
14 checks passed

Ebrahem Farooqui (ebefarooqui) deleted the feature/add-dedicated-methods-for-cursor-based-pagination branch December 9, 2025 17:26

Conversation

Ebrahem Farooqui (ebefarooqui) commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Description

Motivation and Context

PR Checklist

Uh oh!

wiz-inc-38d59fb8d7 bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Wiz Scan Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ebrahem Farooqui (ebefarooqui) Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ethan ozelius (ethan-ozelius-contentful) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Ebrahem Farooqui (ebefarooqui) commented Nov 21, 2025 •

edited

Loading

wiz-inc-38d59fb8d7 bot commented Nov 21, 2025 •

edited

Loading

Ebrahem Farooqui (ebefarooqui) Nov 26, 2025 •

edited

Loading