fix(@plone/types): Add Batching type to querystring-search and search responses #7798
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the
Batchingtype to theQuerystringSearchResponseandSearchResponseinterfaces in the Volto types package. Previously, the batching information returned by the Plone REST API was missing in TypeScript definitions, which caused incomplete type safety when consuming paginated results from the API.Changes include:
Batchinginterface incommon.d.tswith@id,first,last, and optionalprevandnextproperties.QuerystringSearchResponseandSearchResponseto optionally include abatchingproperty.Batchingdefinitions inregistry.d.tsand other service files.This ensures TypeScript correctly recognizes API responses containing batching metadata, improving type safety when working with paginated query results.
Files updated:
packages/types/src/services/common.d.tspackages/types/src/services/querystring-search.d.tspackages/types/src/services/search.d.tspackages/types/src/services/registry.d.tsCloses #6267