@qualisero/openapi-endpoint 0.20.1 → 0.21.1

package/dist/index.d.ts

@@ -5,6 +5,6 @@ export type { QueryReturn, LazyQueryReturn } from './openapi-query';
 export type { MutationReturn } from './openapi-mutation';
 export type { EndpointConfig, QueryOptions, LazyQueryFetchOptions, MutationOptions, MutationVars, CacheInvalidationOptions, Refetchable, MutateFn, MutateAsyncFn, MutateAsyncReturn, ReactiveOr, NoExcessReturn, AxiosRequestConfigExtended, ApiResponse, ApiResponseStrict, ApiRequest, ApiPathParams, ApiPathParamsInput, ApiQueryParams, } from './types';
 export { HttpMethod, QUERY_METHODS, MUTATION_METHODS, isQueryMethod, isMutationMethod } from './types';
-export type { Ref, ComputedRef } from 'vue';
+export type { Ref, ComputedRef, ShallowRef } from 'vue';
 export type { MaybeRefOrGetter } from '@vue/reactivity';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAKtD,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACnE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKxD,YAAY,EAEV,cAAc,EAGd,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,YAAY,EAGZ,wBAAwB,EACxB,WAAW,EAGX,QAAQ,EACR,aAAa,EACb,iBAAiB,EAGjB,UAAU,EACV,cAAc,EAGd,0BAA0B,EAG1B,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,cAAc,GACf,MAAM,SAAS,CAAA;AAKhB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAKtG,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAC3C,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAKtD,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACnE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKxD,YAAY,EAEV,cAAc,EAGd,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,YAAY,EAGZ,wBAAwB,EACxB,WAAW,EAGX,QAAQ,EACR,aAAa,EACb,iBAAiB,EAGjB,UAAU,EACV,cAAc,EAGd,0BAA0B,EAG1B,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,cAAc,GACf,MAAM,SAAS,CAAA;AAKhB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAKtG,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACvD,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/openapi-query.d.ts

@@ -1,4 +1,4 @@
-import { type ComputedRef } from 'vue';
+import { type ComputedRef, type ShallowRef } from 'vue';
 import type { MaybeRefOrGetter } from '@vue/reactivity';
 import { type UseQueryReturnType } from '@tanstack/vue-query';
 import { type EndpointConfig, type QueryOptions, type LazyQueryFetchOptions } from './types';
@@ -26,6 +26,8 @@ export type QueryReturn<TResponse, TPathParams extends Record<string, unknown> =
     pathParams: ComputedRef<TPathParams>;
     /** Register a callback for when data loads successfully for the first time. */
     onLoad: (callback: (data: TResponse) => void) => void;
+    /** Response headers from the last successful query. */
+    responseHeaders: ShallowRef<Record<string, string>>;
 };
 /**
  * Return type of `useLazyQuery`.
@@ -40,7 +42,7 @@ export type QueryReturn<TResponse, TPathParams extends Record<string, unknown> =
  *
  * @group Types
  */
-export type LazyQueryReturn<TResponse, TPathParams extends Record<string, unknown> = Record<string, never>, TQueryParams extends Record<string, unknown> = Record<string, never>> = Pick<QueryReturn<TResponse, TPathParams>, 'data' | 'isPending' | 'isSuccess' | 'isError' | 'error' | 'isEnabled' | 'pathParams' | 'queryKey'> & {
+export type LazyQueryReturn<TResponse, TPathParams extends Record<string, unknown> = Record<string, never>, TQueryParams extends Record<string, unknown> = Record<string, never>> = Pick<QueryReturn<TResponse, TPathParams>, 'data' | 'isPending' | 'isSuccess' | 'isError' | 'error' | 'isEnabled' | 'pathParams' | 'queryKey' | 'responseHeaders'> & {
     /**
      * Execute a query imperatively.
      *

package/dist/openapi-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,KAAK,WAAW,EAAE,MAAM,KAAK,CAAA;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAY,KAAK,kBAAkB,EAAoB,MAAM,qBAAqB,CAAA;AAGzF,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAG3B,MAAM,SAAS,CAAA;AA6ChB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,CAAC,SAAS,EAAE,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAC5G,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,EAIpC,MAAM,GAAG,WAAW,CACrB,GAAG;IACF,kDAAkD;IAClD,IAAI,EAAE,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACxC,8CAA8C;IAC9C,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,8BAA8B;IAC9B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,CAAA;IACtD,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IACpC,+EAA+E;IAC/E,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,KAAK,IAAI,CAAA;CACtD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,CACzB,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,IAAI,CACN,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,EACnC,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,CACnG,GAAG;IACF;;;;;;;;;;OAUG;IACH,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7E,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,GAC9C,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CA0FrC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC,GAC1F,eAAe,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CA2EvD"}
+{"version":3,"file":"openapi-query.d.ts","sourceRoot":"","sources":["../src/openapi-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,KAAK,CAAA;AAC7F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAY,KAAK,kBAAkB,EAAoB,MAAM,qBAAqB,CAAA;AAGzF,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAG3B,MAAM,SAAS,CAAA;AA0DhB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,CAAC,SAAS,EAAE,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAC5G,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,EAIpC,MAAM,GAAG,WAAW,CACrB,GAAG;IACF,kDAAkD;IAClD,IAAI,EAAE,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IACxC,8CAA8C;IAC9C,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,8BAA8B;IAC9B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,CAAA;IACtD,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IACpC,+EAA+E;IAC/E,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,KAAK,IAAI,CAAA;IACrD,uDAAuD;IACvD,eAAe,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACpD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,CACzB,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAClE,IAAI,CACN,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,EACnC,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,iBAAiB,CACvH,GAAG;IACF;;;;;;;;;;OAUG;IACH,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7E,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,GAC9C,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CA8FrC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EACT,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACnE,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAEpE,MAAM,EAAE,cAAc,EACtB,UAAU,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,EAC7F,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC,GAC1F,eAAe,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CA+EvD"}

package/dist/openapi-query.js

@@ -1,4 +1,4 @@
-import { computed, watch, toValue } from 'vue';
+import { computed, shallowRef, watch, toValue } from 'vue';
 import { useQuery } from '@tanstack/vue-query';
 import { isAxiosError } from 'axios';
 import { isQueryMethod, } from './types.js';
@@ -8,7 +8,7 @@ import { normalizeParamsOptions, useResolvedOperation, generateQueryKey } from '
  * Extracted to avoid duplicating axios call logic and error handling.
  * @internal
  */
-function buildQueryFn(config, getResolvedPath, getQueryParams, hookAxiosOptions, callAxiosOptions, errorHandler) {
+function buildQueryFn(config, getResolvedPath, getQueryParams, hookAxiosOptions, callAxiosOptions, errorHandler, headersSink) {
     return async () => {
         try {
             const response = await config.axios({
@@ -26,6 +26,20 @@ function buildQueryFn(config, getResolvedPath, getQueryParams, hookAxiosOptions,
                     ...(callAxiosOptions?.headers || {}),
                 },
             });
+            if (headersSink) {
+                const raw = response.headers;
+                if (raw && typeof raw === 'object') {
+                    const plain = {};
+                    for (const [k, v] of Object.entries(raw)) {
+                        if (v != null)
+                            plain[k] = String(v);
+                    }
+                    headersSink.value = plain;
+                }
+                else {
+                    headersSink.value = {};
+                }
+            }
             return response.data;
         }
         catch (error) {
@@ -65,9 +79,10 @@ export function useEndpointQuery(config, pathParams, options) {
         const baseEnabled = enabledInit !== undefined ? toValue(enabledInit) : true;
         return baseEnabled && isResolved.value;
     });
+    const responseHeaders = shallowRef({});
     const queryOptions = {
         queryKey: queryKey,
-        queryFn: buildQueryFn(config, () => resolvedPath.value, () => resolvedQueryParams.value, axiosOptions, undefined, errorHandler),
+        queryFn: buildQueryFn(config, () => resolvedPath.value, () => resolvedQueryParams.value, axiosOptions, undefined, errorHandler, responseHeaders),
         enabled: isEnabled,
         staleTime: 1000 * 60,
         retry: (_failureCount, error) => {
@@ -110,6 +125,7 @@ export function useEndpointQuery(config, pathParams, options) {
         queryKey,
         onLoad,
         pathParams: resolvedPathParams,
+        responseHeaders,
     };
 }
 /**
@@ -145,6 +161,7 @@ export function useEndpointLazyQuery(config, pathParams, options) {
         enabled: false,
         staleTime: useQueryOptions?.staleTime ?? Infinity,
     });
+    const responseHeaders = shallowRef({});
     const fetch = async (fetchOptions) => {
         if (!isResolved.value) {
             throw new Error(`Cannot fetch '${config.path}': path parameters not resolved. ` + `Resolved path: '${resolvedPath.value}'`);
@@ -155,7 +172,7 @@ export function useEndpointLazyQuery(config, pathParams, options) {
             : generateQueryKey(resolvedPath.value);
         return config.queryClient.fetchQuery({
             queryKey: fetchQueryKey,
-            queryFn: buildQueryFn(config, () => resolvedPath.value, () => (qParams ?? {}), axiosOptions, fetchOptions?.axiosOptions, errorHandler),
+            queryFn: buildQueryFn(config, () => resolvedPath.value, () => (qParams ?? {}), axiosOptions, fetchOptions?.axiosOptions, errorHandler, responseHeaders),
             staleTime: useQueryOptions?.staleTime ?? Infinity,
         });
     };
@@ -168,6 +185,7 @@ export function useEndpointLazyQuery(config, pathParams, options) {
         isEnabled: query.isEnabled,
         pathParams: resolvedPathParams,
         queryKey: queryKey,
+        responseHeaders,
         fetch,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualisero/openapi-endpoint",
-  "version": "0.20.1",
+  "version": "0.21.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/qualisero/openapi-endpoint.git"