feat(sdk): expose typed pagination and error helpers - #494
Open
emma646620-lgtm wants to merge 41 commits into
Open
feat(sdk): expose typed pagination and error helpers#494emma646620-lgtm wants to merge 41 commits into
emma646620-lgtm wants to merge 41 commits into
Conversation
|
@emma646620-lgtm is attempting to deploy a commit to the Cankat's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
This PR adds typed pagination and error helpers to the TypeScript SDK so API consumers can work with list endpoints and actionable API errors. It introduces a
Page<T>wrapper with cursor metadata, normalizes non-2xx and malformed responses into a documentedApiErrorwith status and request ID, and keeps all new exports additive to the existingTalosClientsurface.Related Issue
Changes
📦 SDK Typed Pagination and Error Helpers
[ADD]
packages/sdk/src/types.tsPage<T>result wrapper withdata,nextCursor,hasMore, andtotal.PageParamsfor cursor-based list requests.[ADD]
packages/sdk/src/errors.tsApiErrorwithstatus,requestId,message, anddetails.isApiErrortype guard andnormalizeErrorhelper for non-2xx responses, malformed JSON bodies, and network failures.[MODIFY]
packages/sdk/src/generated-types.ts,packages/sdk/src/client.ts,packages/sdk/src/index.tsPage<T>and include cursor metadata.TalosClientlist methods returnPromise<Page<T>>while preserving source compatibility via thedataaccessor.Page,PageParams,ApiError, andisApiErrorwithout changing existingTalosClientimports.[MODIFY]
packages/sdk/README.md[ADD]
packages/sdk/src/__tests__/paginationAndErrors.test.tsVerification Results
npm run buildpasses forpackages/sdkTalosClientimport surface unchanged; new exports are additivePage<T>success and empty page cases passApiErrornormalization handles both casesCloses #401