@marianmeres/http-utils 2.7.0 → 2.8.0

package/AGENTS.md

@@ -4,7 +4,7 @@
 
 ```yaml
 name: "@marianmeres/http-utils"
-version: "2.5.1"
+version: "2.8.0"
 license: MIT
 runtime: deno, node
 type: library
@@ -13,7 +13,10 @@ category: http-client
 
 ## Purpose
 
-Lightweight, opinionated HTTP client wrapper for the native `fetch` API. Provides type-safe HTTP errors mapped to specific error classes (e.g., 404 → NotFound), convenient defaults (auto JSON parsing, Bearer token support, base URLs), and flexible three-tier error message extraction.
+Lightweight, opinionated HTTP client wrapper for the native `fetch` API. Provides
+type-safe HTTP errors mapped to specific error classes (e.g., 404 → NotFound), convenient
+defaults (auto JSON parsing, Bearer token support, base URLs), and flexible three-tier
+error message extraction.
 
 ## Architecture
 
@@ -31,121 +34,137 @@ src/
 
 ```typescript
 function createHttpApi(
-  base?: string | null,
-  defaults?: Partial<FetchParams> | (() => Promise<Partial<FetchParams>>),
-  factoryErrorMessageExtractor?: ErrorMessageExtractor | null
-): HttpApi
+	base?: string | null,
+	defaults?: Partial<FetchParams> | (() => Promise<Partial<FetchParams>>),
+	factoryErrorMessageExtractor?: ErrorMessageExtractor | null,
+): HttpApi;
 ```
 
 ### HttpApi Methods
 
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| `get` | `get(path, options?: GetOptions): Promise<unknown>` | GET request |
-| `post` | `post(path, options?: DataOptions): Promise<unknown>` | POST request |
-| `put` | `put(path, options?: DataOptions): Promise<unknown>` | PUT request |
-| `patch` | `patch(path, options?: DataOptions): Promise<unknown>` | PATCH request |
-| `del` | `del(path, options?: DataOptions): Promise<unknown>` | DELETE request |
-| `url` | `url(path: string): string` | Build full URL (base trailing slash + path leading slash normalized) |
-| `base` | `get/set base: string \| null` | Base URL property |
-| `onRequest` | `onRequest(i: RequestInterceptor \| null): this` | Register request interceptor |
-| `onResponse` | `onResponse(i: ResponseInterceptor \| null): this` | Register response interceptor |
+| Method       | Signature                                              | Description                                                          |
+| ------------ | ------------------------------------------------------ | -------------------------------------------------------------------- |
+| `get`        | `get(path, options?: GetOptions): Promise<unknown>`    | GET request                                                          |
+| `post`       | `post(path, options?: DataOptions): Promise<unknown>`  | POST request                                                         |
+| `put`        | `put(path, options?: DataOptions): Promise<unknown>`   | PUT request                                                          |
+| `patch`      | `patch(path, options?: DataOptions): Promise<unknown>` | PATCH request                                                        |
+| `del`        | `del(path, options?: DataOptions): Promise<unknown>`   | DELETE request                                                       |
+| `url`        | `url(path: string): string`                            | Build full URL (base trailing slash + path leading slash normalized) |
+| `base`       | `get/set base: string \| null`                         | Base URL property                                                    |
+| `onRequest`  | `onRequest(i: RequestInterceptor \| null): this`       | Register request interceptor                                         |
+| `onResponse` | `onResponse(i: ResponseInterceptor \| null): this`     | Register response interceptor                                        |
 
 ### Exported Types
 
 ```typescript
 type RequestData =
-  | Record<string, unknown>
-  | unknown[]
-  | FormData
-  | Blob
-  | ArrayBuffer
-  | ArrayBufferView
-  | URLSearchParams
-  | ReadableStream
-  | string
-  | number
-  | boolean
-  | null;
+	| Record<string, unknown>
+	| unknown[]
+	| FormData
+	| Blob
+	| ArrayBuffer
+	| ArrayBufferView
+	| URLSearchParams
+	| ReadableStream
+	| string
+	| number
+	| boolean
+	| null;
 
 type QueryValue =
-  | string | number | boolean
-  | (string | number | boolean)[]
-  | null | undefined;
+	| string
+	| number
+	| boolean
+	| (string | number | boolean)[]
+	| null
+	| undefined;
 
 interface FetchParams {
-  data?: RequestData;
-  token?: string | null;
-  headers?: HeadersInit | null;
-  signal?: AbortSignal;
-  timeout?: number | null;               // ms
-  query?: Record<string, QueryValue> | null;
-  credentials?: 'omit' | 'same-origin' | 'include' | null;
-  raw?: boolean | null;
-  assert?: boolean | null;
+	data?: RequestData;
+	token?: string | null;
+	headers?: HeadersInit | null;
+	signal?: AbortSignal;
+	timeout?: number | null; // ms
+	query?: Record<string, QueryValue> | null;
+	credentials?: "omit" | "same-origin" | "include" | null;
+	raw?: boolean | null;
+	assert?: boolean | null;
 }
 
 interface GetOptions {
-  params?: FetchParams;
-  respHeaders?: ResponseHeaders | null;
-  errorExtractor?: ErrorMessageExtractor | null;
+	params?: FetchParams;
+	respHeaders?: ResponseHeaders | null;
+	errorExtractor?: ErrorMessageExtractor | null;
 }
 
 interface DataOptions {
-  data?: RequestData;
-  params?: FetchParams;
-  respHeaders?: ResponseHeaders | null;
-  errorExtractor?: ErrorMessageExtractor | null;
+	data?: RequestData;
+	params?: FetchParams;
+	respHeaders?: ResponseHeaders | null;
+	errorExtractor?: ErrorMessageExtractor | null;
 }
 
 type ErrorMessageExtractor = (body: unknown, response: Response) => string;
 type ResponseHeaders = Record<string, string | number>;
 
 type RequestInterceptor = (
-  init: RequestInit,
-  ctx: { method: string; url: string }
+	init: RequestInit,
+	ctx: { method: string; url: string },
 ) => RequestInit | void | Promise<RequestInit | void>;
 
 type ResponseInterceptor = (
-  response: Response,
-  ctx: { method: string; url: string }
+	response: Response,
+	ctx: { method: string; url: string },
 ) => Response | void | Promise<Response | void>;
 ```
 
 ### Error Classes (HTTP_ERROR namespace)
 
 ```typescript
-HTTP_ERROR.HttpError        // Base class (default 500)
-HTTP_ERROR.BadRequest       // 400
-HTTP_ERROR.Unauthorized     // 401
-HTTP_ERROR.Forbidden        // 403
-HTTP_ERROR.NotFound         // 404
-HTTP_ERROR.MethodNotAllowed // 405
-HTTP_ERROR.RequestTimeout   // 408
-HTTP_ERROR.Conflict         // 409
-HTTP_ERROR.Gone             // 410
-HTTP_ERROR.LengthRequired   // 411
-HTTP_ERROR.ImATeapot        // 418
-HTTP_ERROR.UnprocessableContent // 422
-HTTP_ERROR.TooManyRequests  // 429
-HTTP_ERROR.InternalServerError // 500
-HTTP_ERROR.NotImplemented   // 501
-HTTP_ERROR.BadGateway       // 502
-HTTP_ERROR.ServiceUnavailable // 503
+HTTP_ERROR.HttpError; // Base class (default 500)
+HTTP_ERROR.BadRequest; // 400
+HTTP_ERROR.Unauthorized; // 401
+HTTP_ERROR.Forbidden; // 403
+HTTP_ERROR.NotFound; // 404
+HTTP_ERROR.MethodNotAllowed; // 405
+HTTP_ERROR.RequestTimeout; // 408
+HTTP_ERROR.Conflict; // 409
+HTTP_ERROR.Gone; // 410
+HTTP_ERROR.LengthRequired; // 411
+HTTP_ERROR.ImATeapot; // 418
+HTTP_ERROR.UnprocessableContent; // 422
+HTTP_ERROR.TooManyRequests; // 429
+HTTP_ERROR.InternalServerError; // 500
+HTTP_ERROR.NotImplemented; // 501
+HTTP_ERROR.BadGateway; // 502
+HTTP_ERROR.ServiceUnavailable; // 503
+HTTP_ERROR.NetworkError; // 0 (transport-level failure: DNS/refused/timeout/unreachable; extends HttpError, cause = underlying error)
 ```
 
 ### Helper Functions
 
 ```typescript
 // Marks options object for options-based API (vs legacy positional API)
-function opts<T extends GetOptions | DataOptions>(options: T): T
+function opts<T extends GetOptions | DataOptions>(options: T): T;
 ```
 
 ### Utility Functions
 
 ```typescript
-function createHttpError(code: number | string, message?: string | null, body?: unknown, cause?: unknown): HttpError
-function getErrorMessage(e: unknown, stripErrorPrefix?: boolean): string
+function createHttpError(
+	code: number | string,
+	message?: string | null,
+	body?: unknown,
+	cause?: unknown,
+): HttpError;
+function getErrorMessage(e: unknown, stripErrorPrefix?: boolean): string;
+// Wraps fetch; on transport failure throws NetworkError("<what> unreachable (<url>): <reason>", { cause }).
+// AbortError/TimeoutError pass through untouched. Used internally by HttpApi.
+function fetchOrThrow(
+	input: string | URL | Request,
+	init?: RequestInit,
+	what?: string,
+): Promise<Response>;
 ```
 
 ### HTTP Status Codes
@@ -169,23 +188,35 @@ class HTTP_STATUS {
 
 ## Key Behaviors
 
-1. **Auto JSON parsing**: Response bodies are parsed as JSON if possible; empty bodies (204/205) return `null`
+1. **Auto JSON parsing**: Response bodies are parsed as JSON if possible; empty bodies
+   (204/205) return `null`
 2. **Bearer token**: `token` param auto-adds `Authorization: Bearer {token}` header
-3. **Error throwing**: By default, non-OK responses throw HttpError (disable with `assert: false`)
-4. **Response headers**: Pass `respHeaders: {}` to capture response headers (mutated in place)
-5. **Raw response**: Use `raw: true` to get raw Response object; the caller must consume the body
-6. **Error priority**: per-request extractor → per-instance → global → built-in fallback; a throwing extractor falls through to the next priority rather than crashing
-7. **URL normalization**: `#url(path)` strips trailing `/` from base and ensures leading `/` on path, so `base + path` never produces `//` or missing `/`
-8. **Timeout**: `params.timeout` (ms) aborts via `AbortSignal.timeout`; composed with `params.signal` via `AbortSignal.any`
-9. **Query**: `params.query` object appended as URL search params; `null`/`undefined` skipped, arrays → repeated keys
+3. **Error throwing**: By default, non-OK responses throw HttpError (disable with
+   `assert: false`)
+4. **Response headers**: Pass `respHeaders: {}` to capture response headers (mutated in
+   place)
+5. **Raw response**: Use `raw: true` to get raw Response object; the caller must consume
+   the body
+6. **Error priority**: per-request extractor → per-instance → global → built-in fallback;
+   a throwing extractor falls through to the next priority rather than crashing
+7. **URL normalization**: `#url(path)` strips trailing `/` from base and ensures leading
+   `/` on path, so `base + path` never produces `//` or missing `/`
+8. **Timeout**: `params.timeout` (ms) aborts via `AbortSignal.timeout`; composed with
+   `params.signal` via `AbortSignal.any`
+9. **Query**: `params.query` object appended as URL search params; `null`/`undefined`
+   skipped, arrays → repeated keys
+10. **Transport errors**: connectivity failures (DNS, refused connection, unreachable
+    host) throw `HTTP_ERROR.NetworkError` (status 0) via `fetchOrThrow`, with the real
+    reason in the message and the underlying error as `cause` — never an opaque "fetch
+    failed". Deliberate `AbortError`/`TimeoutError` are not wrapped.
 
 ## Request Body Serialization
 
-| Runtime type | Sent as | Content-Type set |
-|---|---|---|
-| `null` / `undefined` | No body | — |
-| `string` | raw | caller-controlled |
-| `number` / `boolean` / plain object / array | `JSON.stringify` | `application/json` only if not already set |
+| Runtime type                                                                         | Sent as                   | Content-Type set                                         |
+| ------------------------------------------------------------------------------------ | ------------------------- | -------------------------------------------------------- |
+| `null` / `undefined`                                                                 | No body                   | —                                                        |
+| `string`                                                                             | raw                       | caller-controlled                                        |
+| `number` / `boolean` / plain object / array                                          | `JSON.stringify`          | `application/json` only if not already set               |
 | `FormData`, `URLSearchParams`, `Blob`, `ArrayBuffer`, typed arrays, `ReadableStream` | passed to fetch unchanged | fetch handles (e.g. multipart boundary, form-urlencoded) |
 
 User-provided `Content-Type` header is always preserved.
@@ -206,14 +237,14 @@ deno task publish     # Publish to JSR and NPM
 
 ## File Locations
 
-| Purpose | Path |
-|---------|------|
-| Entry point | `src/mod.ts` |
-| HttpApi implementation | `src/api.ts` |
-| Error classes | `src/error.ts` |
-| Status codes | `src/status.ts` |
-| Tests | `tests/*.test.ts` |
-| NPM output | `.npm-dist/` |
+| Purpose                | Path              |
+| ---------------------- | ----------------- |
+| Entry point            | `src/mod.ts`      |
+| HttpApi implementation | `src/api.ts`      |
+| Error classes          | `src/error.ts`    |
+| Status codes           | `src/status.ts`   |
+| Tests                  | `tests/*.test.ts` |
+| NPM output             | `.npm-dist/`      |
 
 ## Common Patterns
 
@@ -223,7 +254,7 @@ deno task publish     # Publish to JSR and NPM
 import { createHttpApi, opts } from "@marianmeres/http-utils";
 
 const api = createHttpApi("https://api.example.com", {
-  headers: { "Authorization": "Bearer token" }
+	headers: { "Authorization": "Bearer token" },
 });
 
 // Legacy API (default - object is request body)
@@ -238,11 +269,11 @@ await api.post("/users", opts({ data: { name: "John" }, params: { token: "abc" }
 
 ```typescript
 try {
-  await api.get("/resource");
+	await api.get("/resource");
 } catch (error) {
-  if (error instanceof HTTP_ERROR.NotFound) {
-    // Handle 404
-  }
+	if (error instanceof HTTP_ERROR.NotFound) {
+		// Handle 404
+	}
 }
 ```
 
@@ -250,6 +281,6 @@ try {
 
 ```typescript
 const api = createHttpApi("https://api.example.com", async () => ({
-  headers: { "Authorization": `Bearer ${await getToken()}` }
+	headers: { "Authorization": `Bearer ${await getToken()}` },
 }));
 ```