@molecule/app-http-axios 1.2.2 → 1.2.4

package/README.md

@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
 Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
 Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
 To change this document, edit the module-level JSDoc in src/index.ts.
-Generated: 2026-10-31T21:25:08.360Z
+Generated: 2026-11-08T06:05:40.595Z
 -->
 
 # @molecule/app-http-axios
@@ -128,54 +128,65 @@ interface HttpClient {
    * Base URL for all requests.
    */
   baseURL: string
+
   /**
    * Default headers for all requests.
    */
   defaultHeaders: Record<string, string>
+
   /**
    * Makes a generic HTTP request. `data` is a field of THIS config object — the same body
    * `post(url, data, config)` takes as its second argument.
    */
   request<T = unknown>(config: FullRequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a GET request.
    */
   get<T = unknown>(url: string, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a POST request. `data` is the request BODY, not a config object: the wire body is
    * `data` itself, so `post(url, { data: body })` sends `{"data":body}` — pass `body` directly.
    * A config (headers, params) is the THIRD argument.
    */
   post<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a PUT request. `data` is the request BODY (second argument) — never `{ data: body }`,
    * which sends `{"data":body}`; a config is the THIRD argument.
    */
   put<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a PATCH request. `data` is the request BODY (second argument) — never `{ data: body }`,
    * which sends `{"data":body}`; a config is the THIRD argument.
    */
   patch<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a DELETE request.
    */
   delete<T = unknown>(url: string, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Adds a request interceptor.
    * Returns a function to remove the interceptor.
    */
   addRequestInterceptor(interceptor: RequestInterceptor): () => void
+
   /**
    * Adds a response interceptor.
    * Returns a function to remove the interceptor.
    */
   addResponseInterceptor(interceptor: ResponseInterceptor): () => void
+
   /**
    * Adds an error interceptor.
    * Returns a function to remove the interceptor.
    */
   addErrorInterceptor(interceptor: ErrorInterceptor): () => void
+
   /**
    * Sets the authorization token.
    *
@@ -187,11 +198,13 @@ interface HttpClient {
    * the resolver is removed, the static token is sent again.
    */
   setAuthToken(token: string | null): void
+
   /**
    * Returns the token the client applies to its next request: the resolver's answer when one
    * is registered, else the static token from `setAuthToken`.
    */
   getAuthToken(): string | null
+
   /**
    * Registers the LIVE token resolver every request of this client reads, or clears it with
    * `null`.
@@ -222,6 +235,7 @@ interface HttpClient {
    * @param resolver - Returns the current access token (or null/undefined), or `null` to clear.
    */
   setAuthTokenResolver?(resolver: AuthTokenResolver | null): void
+
   /**
    * Registers a handler for authentication errors (401).
    *
@@ -244,18 +258,22 @@ interface HttpClientConfig {
    * `//cdn…`) is requested as written.
    */
   baseURL?: string
+
   /**
    * Default headers for all requests.
    */
   defaultHeaders?: Record<string, string>
+
   /**
    * Default timeout in milliseconds.
    */
   timeout?: number
+
   /**
    * Whether to include credentials by default.
    */
   withCredentials?: boolean
+
   /**
    * The scheme of the `Authorization` header the auth token is sent with:
    * `Bearer` (default), or what your API expects, e.g. `Token` for an API that
@@ -265,6 +283,7 @@ interface HttpClientConfig {
    * it returns.
    */
   authScheme?: string
+
   /**
    * Default retry policy for every request this client makes, or `false` to
    * disable retries. A request's own `retry` overrides it.
@@ -283,18 +302,22 @@ interface RequestConfig {
    * Request headers.
    */
   headers?: Record<string, string>
+
   /**
    * Query parameters.
    */
   params?: Record<string, string | number | boolean | undefined>
+
   /**
    * Request timeout in milliseconds.
    */
   timeout?: number
+
   /**
    * Whether to include credentials (cookies).
    */
   withCredentials?: boolean
+
   /**
    * Send this request WITHOUT waiting for the session restore (the auth gate).
    *
@@ -319,14 +342,17 @@ interface RequestConfig {
    * directly.
    */
   skipAuthGate?: boolean
+
   /**
    * Response type.
    */
   responseType?: 'json' | 'text' | 'blob' | 'arraybuffer'
+
   /**
    * Abort signal for cancellation.
    */
   signal?: AbortSignal
+
   /**
    * Request body data, as a field of THIS config object — the `request({ method, url, data })`
    * form. The verb methods take the body as their SECOND argument: `post(url, data, config)`,
@@ -335,10 +361,12 @@ interface RequestConfig {
    * sees none of the fields at its top level.
    */
   data?: unknown
+
   /**
    * Custom request options (implementation-specific).
    */
   options?: Record<string, unknown>
+
   /**
    * Retry policy for this request, or `false` to disable retries.
    *
@@ -362,10 +390,12 @@ interface FullRequestConfig extends RequestConfig {
    * HTTP method.
    */
   method: HttpMethod
+
   /**
    * Request URL (can be relative or absolute).
    */
   url: string
+
   /**
    * Request body data — a field of this config object, never a second argument here.
    */
@@ -383,18 +413,22 @@ interface HttpResponse<T = unknown> {
    * Response data.
    */
   data: T
+
   /**
    * HTTP status code.
    */
   status: number
+
   /**
    * HTTP status text.
    */
   statusText: string
+
   /**
    * Response headers.
    */
   headers: Record<string, string>
+
   /**
    * Original request config.
    */
@@ -464,6 +498,11 @@ type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTION
 
 HTTP error with response details.
 
+`instanceof HttpError` also recognizes compatible failures carrying the shared
+`Symbol.for('@molecule/app-http/HttpError')` brand, including non-ok auth responses
+and errors from duplicated package copies. Branded producers must provide this
+class's instance fields. Subclasses retain ordinary prototype-based checks.
+
 Request metadata on `config` and `response.config` is limited to method, a
 credential-redacted URL, and the two boolean notification-suppression controls
 (`molSilentErrorNotification` and `molSilentRateLimitNotification`). Request bodies,
@@ -480,17 +519,29 @@ session. The correct check is {@link isAuthFailure} (`status === 401 || status =
 `isNoResponse` (`status === 0`) identifies this case.
 
 ```typescript
-declare class HttpError extends Error {
-  status: number
-  response?: HttpResponse | undefined
-  config?: FullRequestConfig | undefined
-  errorKey?: string | undefined
-  aborted: boolean
+class HttpError extends Error {
+  /**
+   * Recognizes the shared failed-request contract without widening subclass checks.
+   *
+   * @param value - Any value to test.
+   * @returns True for a prototype instance, or a compatible branded value checked against the base class.
+   */
+  static [Symbol.hasInstance](value: unknown): boolean {
+    return (
+      Function.prototype[Symbol.hasInstance].call(this, value) ||
+      (this === HttpError &&
+        typeof value === 'object' &&
+        value !== null &&
+        (value as Record<symbol, unknown>)[HTTP_ERROR_BRAND] === true)
+    )
+  }
+
   /**
    * Redacts URL userinfo and credential query/fragment values while preserving the path and
    * non-secret parameters. Shared by compatible HTTP and auth error/log views.
    */
-  static readonly redactUrlCredentials: (value: string) => string
+  static readonly redactUrlCredentials = redactUrlCredentials
+
   /**
    * Builds a failed-request error.
    *
@@ -510,12 +561,18 @@ declare class HttpError extends Error {
    */
   constructor(
     message: string,
-    status: number,
-    response?: HttpResponse | undefined,
-    config?: FullRequestConfig | undefined,
-    errorKey?: string | undefined,
-    aborted?: boolean,
-  )
+    public status: number,
+    public response?: HttpResponse,
+    public config?: FullRequestConfig,
+    public errorKey?: string,
+    public aborted = false,
+  ) {
+    super(snapshotCredentials(message))
+    this.name = 'HttpError'
+    this.response = response ? errorResponse(response) : undefined
+    this.config = config ? errorRequestConfig(config) : undefined
+    Object.defineProperty(this, HTTP_ERROR_BRAND, { value: true })
+  }
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/app-http-axios",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Axios HTTP client provider for @molecule/app-http",
   "type": "module",
   "main": "dist/index.js",
@@ -25,7 +25,7 @@
     "axios": "^1.6.0"
   },
   "devDependencies": {
-    "@molecule/app-logger": "1.0.5",
+    "@molecule/app-logger": "1.0.6",
     "@types/node": "26.6.5",
     "axios": "1.20.0",
     "typescript": "6.0.3",