@ps-aux/api-client-axios 0.7.0-rc.3 → 0.7.0-rc.5

package/dist/browser.cjs

@@ -160,21 +160,34 @@ class HttpClientHelper {
   }
 }
 
+const noOpInterceptor = () => (context, next) => next(context);
+
+const HTTP_CLIENT_FIELD = "http";
+const unwrap = (api) => {
+  const candidate = api[HTTP_CLIENT_FIELD];
+  if (!candidate || typeof candidate !== "object" || typeof candidate.request !== "function") {
+    throw new TypeError(
+      "Expected a generated API instance backed by a PromiseHttpClient"
+    );
+  }
+  return candidate;
+};
+
 const createHttpClient$1 = (axios, opts) => {
   const { querySerializer } = opts;
   const helper = new HttpClientHelper();
   return {
     request: (req) => {
       helper.validateRequest(req);
-      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const { query, contentType, body, headers: reqHeaders } = req;
       const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
-      const isBlobResponse = req.format === "document";
+      const isBlobResponse = req.responseFormat === "document";
       const headers = { ...reqHeaders || {} };
       let data = body;
-      if (requestContentType === "multipart/form-data") {
+      if (contentType === "multipart/form-data") {
         data = helper.convertToFormData(body);
-      } else if (requestContentType) {
-        headers["Content-Type"] = requestContentType;
+      } else if (contentType) {
+        headers["Content-Type"] = contentType;
       }
       return axios.request({
         method: req.method,
@@ -237,3 +250,5 @@ const createHttpClient = (axios, opts) => {
 };
 
 exports.createHttpClient = createHttpClient;
+exports.noOpInterceptor = noOpInterceptor;
+exports.unwrap = unwrap;

package/dist/browser.d.cts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/browser.d.mts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/browser.d.ts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/browser.mjs

@@ -158,21 +158,34 @@ class HttpClientHelper {
   }
 }
 
+const noOpInterceptor = () => (context, next) => next(context);
+
+const HTTP_CLIENT_FIELD = "http";
+const unwrap = (api) => {
+  const candidate = api[HTTP_CLIENT_FIELD];
+  if (!candidate || typeof candidate !== "object" || typeof candidate.request !== "function") {
+    throw new TypeError(
+      "Expected a generated API instance backed by a PromiseHttpClient"
+    );
+  }
+  return candidate;
+};
+
 const createHttpClient$1 = (axios, opts) => {
   const { querySerializer } = opts;
   const helper = new HttpClientHelper();
   return {
     request: (req) => {
       helper.validateRequest(req);
-      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const { query, contentType, body, headers: reqHeaders } = req;
       const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
-      const isBlobResponse = req.format === "document";
+      const isBlobResponse = req.responseFormat === "document";
       const headers = { ...reqHeaders || {} };
       let data = body;
-      if (requestContentType === "multipart/form-data") {
+      if (contentType === "multipart/form-data") {
         data = helper.convertToFormData(body);
-      } else if (requestContentType) {
-        headers["Content-Type"] = requestContentType;
+      } else if (contentType) {
+        headers["Content-Type"] = contentType;
       }
       return axios.request({
         method: req.method,
@@ -234,4 +247,4 @@ const createHttpClient = (axios, opts) => {
   });
 };
 
-export { createHttpClient };
+export { createHttpClient, noOpInterceptor, unwrap };

package/dist/node.cjs

@@ -160,21 +160,34 @@ class HttpClientHelper {
   }
 }
 
+const noOpInterceptor = () => (context, next) => next(context);
+
+const HTTP_CLIENT_FIELD = "http";
+const unwrap = (api) => {
+  const candidate = api[HTTP_CLIENT_FIELD];
+  if (!candidate || typeof candidate !== "object" || typeof candidate.request !== "function") {
+    throw new TypeError(
+      "Expected a generated API instance backed by a PromiseHttpClient"
+    );
+  }
+  return candidate;
+};
+
 const createHttpClient$1 = (axios, opts) => {
   const { querySerializer } = opts;
   const helper = new HttpClientHelper();
   return {
     request: (req) => {
       helper.validateRequest(req);
-      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const { query, contentType, body, headers: reqHeaders } = req;
       const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
-      const isBlobResponse = req.format === "document";
+      const isBlobResponse = req.responseFormat === "document";
       const headers = { ...reqHeaders || {} };
       let data = body;
-      if (requestContentType === "multipart/form-data") {
+      if (contentType === "multipart/form-data") {
         data = helper.convertToFormData(body);
-      } else if (requestContentType) {
-        headers["Content-Type"] = requestContentType;
+      } else if (contentType) {
+        headers["Content-Type"] = contentType;
       }
       return axios.request({
         method: req.method,
@@ -237,3 +250,5 @@ const createHttpClient = (axios, opts) => {
 };
 
 exports.createHttpClient = createHttpClient;
+exports.noOpInterceptor = noOpInterceptor;
+exports.unwrap = unwrap;

package/dist/node.d.cts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.d.mts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.d.ts

@@ -4,14 +4,14 @@ type KnownRequestContentType = 'application/json' | 'multipart/form-data' | 'app
 type RequestContentType = KnownRequestContentType | string;
 type QueryValue = string | number | boolean | null | undefined | QueryValue[] | Record<string, any> | unknown;
 type QueryParams = Record<string, QueryValue>;
-type Request = {
+type HttpRequest = {
     path: string;
     method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json' | 'document';
+    responseFormat?: 'json' | 'document';
     headers?: Record<string, string>;
     query?: QueryParams;
     body?: any;
-    requestContentType?: RequestContentType;
+    contentType?: RequestContentType;
 };
 type HttpResponse<Data> = {
     body: Data;
@@ -21,9 +21,18 @@ type HttpResponse<Data> = {
 type QuerySerializer = (params: QueryParams) => string;
 
 type HttpClient<RequestParams = never> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<HttpResponse<Data>>;
+    request: <Data>(req: HttpRequest, params?: RequestParams) => Promise<HttpResponse<Data>>;
 };
 
+type HttpClientInterceptorContext<P = never> = {
+    request: HttpRequest;
+    params?: P;
+};
+type HttpClientInterceptor<P = never> = <D>(ctx: HttpClientInterceptorContext<P>, next: (ctx: HttpClientInterceptorContext<P>) => Promise<HttpResponse<D>>) => Promise<HttpResponse<D>>;
+declare const noOpInterceptor: <P = never>() => HttpClientInterceptor<P>;
+
+declare const unwrap: <RequestParams = never>(api: object) => HttpClient<RequestParams>;
+
 /// <reference lib="esnext.asynciterable" />
 
 /**
@@ -40,5 +49,5 @@ declare const createHttpClient: (axios: AxiosInstance, opts: {
     querySerializer: QuerySerializer | null;
 }) => HttpClient;
 
-export { createHttpClient };
-export type { HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };
+export { createHttpClient, noOpInterceptor, unwrap };
+export type { HttpClientInterceptor, HttpClientInterceptorContext, HttpRequest, HttpResponse, HttpClient as PromiseHttpClient, QuerySerializer };

package/dist/node.mjs

@@ -158,21 +158,34 @@ class HttpClientHelper {
   }
 }
 
+const noOpInterceptor = () => (context, next) => next(context);
+
+const HTTP_CLIENT_FIELD = "http";
+const unwrap = (api) => {
+  const candidate = api[HTTP_CLIENT_FIELD];
+  if (!candidate || typeof candidate !== "object" || typeof candidate.request !== "function") {
+    throw new TypeError(
+      "Expected a generated API instance backed by a PromiseHttpClient"
+    );
+  }
+  return candidate;
+};
+
 const createHttpClient$1 = (axios, opts) => {
   const { querySerializer } = opts;
   const helper = new HttpClientHelper();
   return {
     request: (req) => {
       helper.validateRequest(req);
-      const { query, requestContentType, body, headers: reqHeaders } = req;
+      const { query, contentType, body, headers: reqHeaders } = req;
       const paramsSerializer = querySerializer ? (r) => helper.serializeQuery(r, querySerializer) : void 0;
-      const isBlobResponse = req.format === "document";
+      const isBlobResponse = req.responseFormat === "document";
       const headers = { ...reqHeaders || {} };
       let data = body;
-      if (requestContentType === "multipart/form-data") {
+      if (contentType === "multipart/form-data") {
         data = helper.convertToFormData(body);
-      } else if (requestContentType) {
-        headers["Content-Type"] = requestContentType;
+      } else if (contentType) {
+        headers["Content-Type"] = contentType;
       }
       return axios.request({
         method: req.method,
@@ -234,4 +247,4 @@ const createHttpClient = (axios, opts) => {
   });
 };
 
-export { createHttpClient };
+export { createHttpClient, noOpInterceptor, unwrap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ps-aux/api-client-axios",
-  "version": "0.7.0-rc.3",
+  "version": "0.7.0-rc.5",
   "main": "dist/node.cjs",
   "type": "module",
   "scripts": {
@@ -15,10 +15,10 @@
   "author": "psaux",
   "license": "MIT",
   "peerDependencies": {
-    "axios": "^1.13.5"
+    "axios": "^1.16.0"
   },
   "devDependencies": {
-    "axios": "^1.5.0"
+    "axios": "^1.16.0"
   },
   "description": "Axios-based HTTP client for OpenAPI-generated APIs (Node and browser builds).",
   "keywords": [