feat: expose response headers from query composables#144
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR exposes response headers from the most recent successful query execution via a new responseHeaders shallowRef on both query composables’ return types, enabling consumers to read metadata such as pagination headers.
Changes:
- Captures axios response headers inside
buildQueryFnand surfaces them onuseEndpointQuery/useEndpointLazyQuery. - Extends
QueryReturn/LazyQueryReturntypes withresponseHeaders. - Adds unit tests covering header exposure and updates package version + changelog entries.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/response-headers.test.ts | Adds tests validating responseHeaders behavior for query and lazy query flows. |
| src/openapi-query.ts | Implements header capture via headersSink and returns responseHeaders from composables/types. |
| src/index.ts | Re-exports ShallowRef type for consumers. |
| package.json | Bumps package version. |
| package-lock.json | Updates lockfile version fields to match package version bump. |
| CHANGELOG.md | Adds release notes for the new responseHeaders API. |
…g, add no-headers test
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.
Adds
responseHeadersshallowRef toQueryReturnandLazyQueryReturntypes, allowing consumers to access response headers (e.g.,X-Paginationfor pagination metadata) from the last successful query.Changes
buildQueryFnaccepts optionalheadersSinkparameter to capture response headersuseEndpointQuerycreates and returns aresponseHeadersshallowRefuseEndpointLazyQueryexposesresponseHeaderspopulated onfetch()QueryReturnandLazyQueryReturntypes updated withresponseHeaders: ShallowRef<Record<string, string>>tests/unit/response-headers.test.ts(8 tests)