@zairakai/js-http-client 1.0.15 → 1.0.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stanislas Poisson (Zairakai)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,8 @@
-# @zairakai/js-http-client
+# JS HTTP Client
+
+![JS HTTP Client](https://gitlab.com/zairakai/npm-packages/js-http-client/-/raw/main/assets/banner.png)
+
+`@zairakai/js-http-client`
 
 [![Main][pipeline-main-badge]][pipeline-main-link]
 [![Develop][pipeline-develop-badge]][pipeline-develop-link]
@@ -12,6 +16,8 @@
 [![Node.js][node-badge]][node]
 [![ESLint][eslint-badge]][eslint]
 [![Prettier][prettier-badge]][prettier]
+[![Vitest][vitest-badge]][vitest]
+[![Knip][knip-badge]][knip]
 
 Axios-based HTTP client with request tracking, interceptor management, and Laravel CSRF support.
 
@@ -41,6 +47,17 @@ The documentation site has this guide and the reference of the API generated fro
 npm install @zairakai/js-http-client
 ```
 
+### In the browser
+
+The library is made for the web: ESM and CommonJS builds, no Node.js built-ins, `"sideEffects": false`, and `axios` stays external (your bundler picks it up as a dependency). A bundler keeps only what you import (the tests of this repository check it with esbuild): a project that imports `createRequestTracker` alone gets a few hundred bytes, and the interceptors have their own entry point:
+
+```js
+import { createHttpClient } from '@zairakai/js-http-client'
+import { createAuthInterceptor } from '@zairakai/js-http-client/interceptors'
+```
+
+There is no minimum browser version.
+
 ---
 
 ## Usage
@@ -150,6 +167,10 @@ make test-all      # vitest + bats + coverage
 [eslint]: https://eslint.org
 [prettier-badge]: https://img.shields.io/badge/formatter-prettier-F7B93E.svg?logo=prettier
 [prettier]: https://prettier.io
+[vitest-badge]: https://img.shields.io/badge/test-vitest-6E9F18.svg?logo=vitest
+[vitest]: https://vitest.dev
+[knip-badge]: https://img.shields.io/badge/dead%20code-knip-EC4899.svg
+[knip]: https://knip.dev
 [ecosystem]: https://gitlab.com/zairakai
 [docs]: https://js-http-client-eb9079.gitlab.io
 [docs-badge]: https://img.shields.io/badge/docs-online-blue

package/dist/{chunk-SSH6WKEL.js → chunk-NWOTSCRW.js}

@@ -18,7 +18,7 @@ var createTrackingInterceptors = (tracker) => ({
   }
 });
 var createCSRFInterceptor = (tokenSource) => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["X-CSRF-TOKEN"] = token;
@@ -26,7 +26,7 @@ var createCSRFInterceptor = (tokenSource) => (config) => {
   return config;
 };
 var createAuthInterceptor = (tokenSource, type = "Bearer") => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["Authorization"] = `${type} ${token}`;

package/dist/index.cjs

@@ -68,7 +68,7 @@ var createTrackingInterceptors = (tracker) => ({
   }
 });
 var createCSRFInterceptor = (tokenSource) => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["X-CSRF-TOKEN"] = token;
@@ -76,7 +76,7 @@ var createCSRFInterceptor = (tokenSource) => (config) => {
   return config;
 };
 var createAuthInterceptor = (tokenSource, type = "Bearer") => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["Authorization"] = `${type} ${token}`;
@@ -125,7 +125,7 @@ var createRequestTracker = () => {
       nbrInternal = Math.max(0, val);
     },
     get isActive() {
-      return 0 < nbrInternal;
+      return nbrInternal > 0;
     },
     increment() {
       nbrInternal++;
@@ -162,7 +162,7 @@ var createHttpClient = (options = {}) => {
     withCredentials: config.withCredentials,
     headers: config.headers
   });
-  const tracker = false !== config.trackRequests ? createRequestTracker() : null;
+  const tracker = config.trackRequests !== false ? createRequestTracker() : null;
   if (tracker) {
     const trackingInterceptors = createTrackingInterceptors(tracker);
     client.interceptors.request.use(trackingInterceptors.request, trackingInterceptors.requestError);
@@ -177,21 +177,19 @@ var createHttpClient = (options = {}) => {
   if (config.timeout !== DEFAULT_CONFIG.timeout) {
     client.interceptors.request.use(createTimeoutInterceptor(config.timeout));
   }
-  if (false !== config.enableErrorLogging) {
+  if (config.enableErrorLogging !== false) {
     client.interceptors.response.use((response) => response, createErrorLoggerInterceptor(config.logger));
   }
-  if (config.retries && 0 < config.retries) {
+  if (config.retries && config.retries > 0) {
     client.interceptors.request.use((reqConfig) => {
-      ;
-      reqConfig._axios = client;
-      return reqConfig;
+      return Object.assign(reqConfig, { _axios: client });
     });
     client.interceptors.response.use(
       (response) => response,
       createRetryInterceptor(config.retries, config.retryDelay, config.shouldRetry)
     );
   }
-  if (false !== config.laravel) {
+  if (config.laravel !== false) {
     client.defaults.headers.common["X-Requested-With"] = "XMLHttpRequest";
   }
   return {

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 export { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, Method as HttpMethod, default as axios } from 'axios';
-import { R as RequestTracker, T as TokenSource, L as Logger, S as ShouldRetryFunction } from './interceptors-Pv-t9Hbf.cjs';
-export { a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, e as createRequestTracker, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors, i as globalRequestTracker } from './interceptors-Pv-t9Hbf.cjs';
+import { R as RequestTracker, T as TokenSource, L as Logger, S as ShouldRetryFunction } from './interceptors-CDlYhrao.cjs';
+export { a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, e as createRequestTracker, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors, i as globalRequestTracker } from './interceptors-CDlYhrao.cjs';
 
 /**
  * HTTP client factory with configurable options
@@ -77,4 +77,5 @@ declare const createLaravelClient: (options?: HttpClientOptions) => HttpClient;
  */
 declare const createApiClient: (options?: HttpClientOptions) => HttpClient;
 
-export { type HttpClient, type HttpClientOptions, Logger, RequestTracker, ShouldRetryFunction, TokenSource, createApiClient, createHttpClient, createLaravelClient };
+export { Logger, RequestTracker, ShouldRetryFunction, TokenSource, createApiClient, createHttpClient, createLaravelClient };
+export type { HttpClient, HttpClientOptions };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 export { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, Method as HttpMethod, default as axios } from 'axios';
-import { R as RequestTracker, T as TokenSource, L as Logger, S as ShouldRetryFunction } from './interceptors-Pv-t9Hbf.js';
-export { a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, e as createRequestTracker, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors, i as globalRequestTracker } from './interceptors-Pv-t9Hbf.js';
+import { R as RequestTracker, T as TokenSource, L as Logger, S as ShouldRetryFunction } from './interceptors-CDlYhrao.js';
+export { a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, e as createRequestTracker, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors, i as globalRequestTracker } from './interceptors-CDlYhrao.js';
 
 /**
  * HTTP client factory with configurable options
@@ -77,4 +77,5 @@ declare const createLaravelClient: (options?: HttpClientOptions) => HttpClient;
  */
 declare const createApiClient: (options?: HttpClientOptions) => HttpClient;
 
-export { type HttpClient, type HttpClientOptions, Logger, RequestTracker, ShouldRetryFunction, TokenSource, createApiClient, createHttpClient, createLaravelClient };
+export { Logger, RequestTracker, ShouldRetryFunction, TokenSource, createApiClient, createHttpClient, createLaravelClient };
+export type { HttpClient, HttpClientOptions };

package/dist/index.js

@@ -5,7 +5,7 @@ import {
   createRetryInterceptor,
   createTimeoutInterceptor,
   createTrackingInterceptors
-} from "./chunk-SSH6WKEL.js";
+} from "./chunk-NWOTSCRW.js";
 
 // src/client.ts
 import axios from "axios";
@@ -21,7 +21,7 @@ var createRequestTracker = () => {
       nbrInternal = Math.max(0, val);
     },
     get isActive() {
-      return 0 < nbrInternal;
+      return nbrInternal > 0;
     },
     increment() {
       nbrInternal++;
@@ -58,7 +58,7 @@ var createHttpClient = (options = {}) => {
     withCredentials: config.withCredentials,
     headers: config.headers
   });
-  const tracker = false !== config.trackRequests ? createRequestTracker() : null;
+  const tracker = config.trackRequests !== false ? createRequestTracker() : null;
   if (tracker) {
     const trackingInterceptors = createTrackingInterceptors(tracker);
     client.interceptors.request.use(trackingInterceptors.request, trackingInterceptors.requestError);
@@ -73,21 +73,19 @@ var createHttpClient = (options = {}) => {
   if (config.timeout !== DEFAULT_CONFIG.timeout) {
     client.interceptors.request.use(createTimeoutInterceptor(config.timeout));
   }
-  if (false !== config.enableErrorLogging) {
+  if (config.enableErrorLogging !== false) {
     client.interceptors.response.use((response) => response, createErrorLoggerInterceptor(config.logger));
   }
-  if (config.retries && 0 < config.retries) {
+  if (config.retries && config.retries > 0) {
     client.interceptors.request.use((reqConfig) => {
-      ;
-      reqConfig._axios = client;
-      return reqConfig;
+      return Object.assign(reqConfig, { _axios: client });
     });
     client.interceptors.response.use(
       (response) => response,
       createRetryInterceptor(config.retries, config.retryDelay, config.shouldRetry)
     );
   }
-  if (false !== config.laravel) {
+  if (config.laravel !== false) {
     client.defaults.headers.common["X-Requested-With"] = "XMLHttpRequest";
   }
   return {

package/dist/{interceptors-Pv-t9Hbf.d.cts → interceptors-CDlYhrao.d.cts}

@@ -88,6 +88,7 @@ declare const createTimeoutInterceptor: (timeout: number) => (config: InternalAx
  * @param shouldRetry - Function to determine if request should be retried
  * @returns Response error interceptor
  */
-declare const createRetryInterceptor: (retries?: number, delay?: number, shouldRetry?: ShouldRetryFunction) => (error: AxiosError) => Promise<any>;
+declare const createRetryInterceptor: (retries?: number, delay?: number, shouldRetry?: ShouldRetryFunction) => (error: AxiosError) => Promise<AxiosResponse>;
 
-export { type Logger as L, type RequestTracker as R, type ShouldRetryFunction as S, type TokenSource as T, type TrackingInterceptors as a, createCSRFInterceptor as b, createAuthInterceptor as c, createErrorLoggerInterceptor as d, createRequestTracker as e, createRetryInterceptor as f, createTimeoutInterceptor as g, createTrackingInterceptors as h, globalRequestTracker as i };
+export { createCSRFInterceptor as b, createAuthInterceptor as c, createErrorLoggerInterceptor as d, createRequestTracker as e, createRetryInterceptor as f, createTimeoutInterceptor as g, createTrackingInterceptors as h, globalRequestTracker as i };
+export type { Logger as L, RequestTracker as R, ShouldRetryFunction as S, TokenSource as T, TrackingInterceptors as a };

package/dist/{interceptors-Pv-t9Hbf.d.ts → interceptors-CDlYhrao.d.ts}

@@ -88,6 +88,7 @@ declare const createTimeoutInterceptor: (timeout: number) => (config: InternalAx
  * @param shouldRetry - Function to determine if request should be retried
  * @returns Response error interceptor
  */
-declare const createRetryInterceptor: (retries?: number, delay?: number, shouldRetry?: ShouldRetryFunction) => (error: AxiosError) => Promise<any>;
+declare const createRetryInterceptor: (retries?: number, delay?: number, shouldRetry?: ShouldRetryFunction) => (error: AxiosError) => Promise<AxiosResponse>;
 
-export { type Logger as L, type RequestTracker as R, type ShouldRetryFunction as S, type TokenSource as T, type TrackingInterceptors as a, createCSRFInterceptor as b, createAuthInterceptor as c, createErrorLoggerInterceptor as d, createRequestTracker as e, createRetryInterceptor as f, createTimeoutInterceptor as g, createTrackingInterceptors as h, globalRequestTracker as i };
+export { createCSRFInterceptor as b, createAuthInterceptor as c, createErrorLoggerInterceptor as d, createRequestTracker as e, createRetryInterceptor as f, createTimeoutInterceptor as g, createTrackingInterceptors as h, globalRequestTracker as i };
+export type { Logger as L, RequestTracker as R, ShouldRetryFunction as S, TokenSource as T, TrackingInterceptors as a };

package/dist/interceptors.cjs

@@ -57,7 +57,7 @@ var createTrackingInterceptors = (tracker) => ({
   }
 });
 var createCSRFInterceptor = (tokenSource) => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["X-CSRF-TOKEN"] = token;
@@ -65,7 +65,7 @@ var createCSRFInterceptor = (tokenSource) => (config) => {
   return config;
 };
 var createAuthInterceptor = (tokenSource, type = "Bearer") => (config) => {
-  const token = "function" === typeof tokenSource ? tokenSource() : tokenSource;
+  const token = typeof tokenSource === "function" ? tokenSource() : tokenSource;
   if (token) {
     config.headers = config.headers ?? {};
     config.headers["Authorization"] = `${type} ${token}`;

package/dist/interceptors.d.cts

@@ -1,2 +1,2 @@
 import 'axios';
-export { L as Logger, S as ShouldRetryFunction, T as TokenSource, a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors } from './interceptors-Pv-t9Hbf.cjs';
+export { L as Logger, S as ShouldRetryFunction, T as TokenSource, a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors } from './interceptors-CDlYhrao.cjs';

package/dist/interceptors.d.ts

@@ -1,2 +1,2 @@
 import 'axios';
-export { L as Logger, S as ShouldRetryFunction, T as TokenSource, a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors } from './interceptors-Pv-t9Hbf.js';
+export { L as Logger, S as ShouldRetryFunction, T as TokenSource, a as TrackingInterceptors, c as createAuthInterceptor, b as createCSRFInterceptor, d as createErrorLoggerInterceptor, f as createRetryInterceptor, g as createTimeoutInterceptor, h as createTrackingInterceptors } from './interceptors-CDlYhrao.js';

package/dist/interceptors.js

@@ -5,7 +5,7 @@ import {
   createRetryInterceptor,
   createTimeoutInterceptor,
   createTrackingInterceptors
-} from "./chunk-SSH6WKEL.js";
+} from "./chunk-NWOTSCRW.js";
 export {
   createAuthInterceptor,
   createCSRFInterceptor,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zairakai/js-http-client",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "Configurable HTTP client built on axios with request tracking, Laravel CSRF support, and interceptor management",
   "keywords": [
     "http",
@@ -85,14 +85,15 @@
   },
   "devDependencies": {
     "@types/node": "^26.6.6",
-    "@vitest/coverage-v8": "^5.0.5",
-    "@zairakai/js-dev-tools": "^3.19.0",
-    "knip": "^6.44.1",
+    "@vitest/coverage-v8": "^5.1.0",
+    "@zairakai/js-dev-tools": "^3.21.0",
+    "esbuild": "^0.28.1",
+    "knip": "^6.44.2",
     "sort-package-json": "^4.1.0",
-    "tsup": "^8.5.1",
+    "tsup": "^9.0.0",
     "typedoc": "^0.28.20",
     "typescript": "^6.0.3",
-    "vitest": "^5.0.5"
+    "vitest": "^5.1.0"
   },
   "peerDependenciesMeta": {
     "axios": {
@@ -104,5 +105,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "sideEffects": false
 }

package/src/client.ts

@@ -106,7 +106,7 @@ export const createHttpClient = (options: HttpClientOptions = {}): HttpClient =>
   })
 
   // Create request tracker if enabled
-  const tracker = false !== config.trackRequests ? createRequestTracker() : null
+  const tracker = config.trackRequests !== false ? createRequestTracker() : null
 
   // Add request tracking interceptors
   if (tracker) {
@@ -131,26 +131,25 @@ export const createHttpClient = (options: HttpClientOptions = {}): HttpClient =>
   }
 
   // Add error logging interceptor
-  if (false !== config.enableErrorLogging) {
+  if (config.enableErrorLogging !== false) {
     client.interceptors.response.use((response) => response, createErrorLoggerInterceptor(config.logger))
   }
 
   // Add retry interceptor
-  if (config.retries && 0 < config.retries) {
+  if (config.retries && config.retries > 0) {
     // Add the client instance to configs for retry handling
     client.interceptors.request.use((reqConfig) => {
-      ;(reqConfig as any)._axios = client
-      return reqConfig
+      return Object.assign(reqConfig, { _axios: client })
     })
 
     client.interceptors.response.use(
       (response) => response,
-      createRetryInterceptor(config.retries, config.retryDelay, config.shouldRetry)
+      createRetryInterceptor(config.retries, config.retryDelay, config.shouldRetry),
     )
   }
 
   // Add Laravel-style headers if not disabled
-  if (false !== config.laravel) {
+  if (config.laravel !== false) {
     client.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest'
   }
 

package/src/interceptors.ts

@@ -2,7 +2,7 @@
  * Common interceptors for HTTP clients
  */
 
-import axios, { AxiosError, AxiosResponse, InternalAxiosRequestConfig } from 'axios'
+import axios, { AxiosError, AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from 'axios'
 import { RequestTracker } from './request-tracker.js'
 
 /**
@@ -64,7 +64,7 @@ export const createTrackingInterceptors = (tracker: RequestTracker): TrackingInt
 export const createCSRFInterceptor =
   (tokenSource: TokenSource) =>
   (config: InternalAxiosRequestConfig): InternalAxiosRequestConfig => {
-    const token = 'function' === typeof tokenSource ? tokenSource() : tokenSource
+    const token = typeof tokenSource === 'function' ? tokenSource() : tokenSource
 
     if (token) {
       config.headers = config.headers ?? {}
@@ -83,7 +83,7 @@ export const createCSRFInterceptor =
 export const createAuthInterceptor =
   (tokenSource: TokenSource, type: string = 'Bearer') =>
   (config: InternalAxiosRequestConfig): InternalAxiosRequestConfig => {
-    const token = 'function' === typeof tokenSource ? tokenSource() : tokenSource
+    const token = typeof tokenSource === 'function' ? tokenSource() : tokenSource
 
     if (token) {
       config.headers = config.headers ?? {}
@@ -130,6 +130,7 @@ export const createTimeoutInterceptor =
  */
 interface RetryConfig extends InternalAxiosRequestConfig {
   __retryCount?: number
+  _axios?: AxiosInstance
 }
 
 /**
@@ -142,9 +143,9 @@ interface RetryConfig extends InternalAxiosRequestConfig {
 export const createRetryInterceptor = (
   retries: number = 3,
   delay: number = 1000,
-  shouldRetry: ShouldRetryFunction = () => true
+  shouldRetry: ShouldRetryFunction = () => true,
 ) => {
-  return async (error: AxiosError): Promise<any> => {
+  return async (error: AxiosError): Promise<AxiosResponse> => {
     const config = error.config as RetryConfig | undefined
 
     if (!config || (config.__retryCount ?? 0) >= retries) {
@@ -161,7 +162,7 @@ export const createRetryInterceptor = (
 
     // Try to use the instance from the error, otherwise fall back to axios
     /* c8 ignore next */
-    const axiosInstance = (config as any)._axios ?? axios
+    const axiosInstance: AxiosInstance = config._axios ?? axios
     return axiosInstance.request(config)
   }
 }

package/src/request-tracker.ts

@@ -35,7 +35,7 @@ export const createRequestTracker = (): RequestTracker => {
     },
 
     get isActive(): boolean {
-      return 0 < nbrInternal
+      return nbrInternal > 0
     },
 
     increment(): void {