feat(shared-types): implement shared API response envelopes#205
Merged
therealjhay merged 2 commits intoJun 30, 2026
Conversation
|
@TheBigWealth89 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Kindly resolve conflict |
Contributor
Author
I have resolved all conflict |
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.
Closes #107
feat(shared-types): Implement shared API response envelopes
Description
This PR standardizes the API response structure across the BettaPay monorepo by introducing strongly-typed response envelopes. This ensures that all services provide a consistent contract to frontends and API consumers, cleanly delineating successful data payloads from standardized error formats.
Changes Made
shared/types/index.ts):ApiResponse<T>to wrap single resource payloads and handle errors using the standardErrorResponseschema.PaginatedResponse<T>to standardize list queries, encapsulating the list withindataand appending strictpaginationmetadata (total, limit, offset, hasMore).api-gateway: UpdatedGET /api/merchants/:idto explicitly returnPromise<ApiResponse<Merchant>>. Used the existingcreateErrorResponse()logic to mapNOT_FOUNDevents directly into the{ error: ErrorResponse }envelope without changing core business logic. Added missing@bettapay/shared-typesdependency.settlement-engine: UpdatedGET /api/settlementsto explicitly returnPromise<PaginatedResponse<SettlementRecord>>and structured the list logic to populate the pagination metadata appropriately.indexer/src/index.tsand addressed alatestLedgerCursorundefined calculation that was disrupting workspace builds.Type-Safety & Tests
pnpm -r type-checkpnpm -r buildpasses locally