@backendkit-labs/http-client 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,184 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and the Work's derivative works.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and subsequently
+      incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, and
+      distribute Your modifications, or for such Derivative Works as a
+      whole, subject to the terms and conditions of this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024-2026 Mairon José Cuello Martí­nez
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,328 +1,328 @@
-# @backendkit-labs/http-client
-
-[![npm version](https://img.shields.io/npm/v/@backendkit-labs/http-client?style=flat-square&color=cb3837)](https://www.npmjs.com/package/@backendkit-labs/http-client)
-[![CI](https://img.shields.io/github/actions/workflow/status/backendkit-dev/backendkit-monorepo/ci.yml?style=flat-square&label=CI)](https://github.com/backendkit-dev/backendkit-monorepo/actions/workflows/ci.yml)
-[![License](https://img.shields.io/npm/l/@backendkit-labs/http-client?style=flat-square)](LICENSE)
-[![Node](https://img.shields.io/node/v/@backendkit-labs/http-client?style=flat-square)](package.json)
-
-> Production-grade HTTP client for Node.js — built on axios with circuit breaker, retry with exponential backoff, typed `Result<T, E>` responses, request cancellation, pre-request pipeline middleware, and optional NestJS DI integration.
-
-Every method returns `Result<HttpResponse<T>, HttpClientError>` — no try/catch needed, no unhandled rejections, always typed.
-
----
-
-## Installation
-
-```bash
-npm install @backendkit-labs/http-client axios
-```
-
-NestJS peer dependencies (only for the `/nestjs` subpath):
-
-```bash
-npm install @nestjs/common @nestjs/core rxjs
-```
-
----
-
-## TypeScript Configuration
-
-### Subpath exports (`/nestjs`)
-
-This package uses the `exports` field in `package.json` to expose the `/nestjs` subpath. TypeScript's ability to resolve it depends on the `moduleResolution` setting in your `tsconfig.json`.
-
-**Modern resolution (recommended) — no extra config needed:**
-
-```json
-{
-  "compilerOptions": {
-    "moduleResolution": "bundler"
-  }
-}
-```
-
-`"bundler"`, `"node16"`, and `"nodenext"` all understand the `exports` field natively.
-
-**Legacy resolution (`"node"`) — add `paths` aliases:**
-
-```json
-{
-  "compilerOptions": {
-    "moduleResolution": "node",
-    "paths": {
-      "@backendkit-labs/http-client/nestjs": [
-        "./node_modules/@backendkit-labs/http-client/dist/nestjs/index.d.ts"
-      ]
-    }
-  }
-}
-```
-
-**NestJS decorator support:**
-
-```json
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}
-```
-
-And in your `main.ts`, before anything else:
-
-```typescript
-import 'reflect-metadata';
-```
-
----
-
-## Quick Start
-
-```typescript
-import { HttpClient } from '@backendkit-labs/http-client';
-
-const client = new HttpClient({
-  baseURL: 'https://api.example.com',
-  timeout: 5_000,
-});
-
-// All methods return Result<HttpResponse<T>, HttpClientError>
-const result = await client.get<User[]>('/users');
-
-if (result.ok) {
-  console.log(result.value.data);   // User[]
-  console.log(result.value.status); // 200
-} else {
-  console.error(result.error.type);   // 'http' | 'network' | 'timeout' | 'cancelled' | 'circuit-open'
-  console.error(result.error.status); // 404, 500, etc. (for 'http' type)
-}
-```
-
----
-
-## Configuration
-
-```typescript
-const client = new HttpClient({
-  baseURL:  'https://api.example.com',
-  timeout:  10_000,          // default: 10 000 ms
-  headers:  { 'X-API-Key': 'secret' },
-
-  // Retry with exponential backoff + jitter
-  retry: {
-    attempts:    3,           // retries after first failure
-    delayMs:     100,
-    maxDelayMs:  5_000,
-    jitter:      true,
-    shouldRetry: (err) => err.type === 'network' || err.type === 'timeout',
-  },
-
-  // Circuit breaker
-  circuitBreaker: {
-    failureThreshold:  50,    // % of calls that must fail to open the circuit
-    minimumCalls:      5,     // minimum calls before evaluating thresholds
-    slidingWindowSize: 10,
-    openTimeoutMs:     30_000,
-  },
-
-  // Pre-request middleware steps
-  steps: [authStep, correlationIdStep],
-});
-```
-
----
-
-## HTTP Methods
-
-All methods accept an optional `RequestConfig`:
-
-```typescript
-interface RequestConfig {
-  headers?:       Record<string, string>;
-  params?:        Record<string, unknown>;   // query string parameters
-  timeout?:       number;                    // per-request override
-  cancelKey?:     string;                    // key to cancel this request
-  correlationId?: string;
-}
-```
-
-```typescript
-client.get<T>(url, config?)
-client.post<T>(url, data?, config?)
-client.put<T>(url, data?, config?)
-client.patch<T>(url, data?, config?)
-client.delete<T>(url, config?)
-```
-
----
-
-## Error Types
-
-```typescript
-type HttpErrorType = 'http' | 'network' | 'timeout' | 'cancelled' | 'circuit-open';
-
-interface HttpClientError {
-  type:     HttpErrorType;
-  message:  string;
-  status?:  number;   // only for 'http'
-  data?:    unknown;  // response body, only for 'http'
-  cause?:   unknown;  // original axios error
-}
-```
-
----
-
-## Request Cancellation
-
-Register a `cancelKey` on the request and cancel by key at any time:
-
-```typescript
-const promise = client.get('/long-poll', { cancelKey: 'my-poll' });
-
-// Cancel a specific request
-client.cancelRequest('my-poll');
-
-// Cancel all in-flight requests
-client.cancelAll();
-
-const result = await promise;
-if (!result.ok && result.error.type === 'cancelled') {
-  // handle cancellation
-}
-```
-
----
-
-## Pipeline Middleware
-
-Pre-request middleware steps transform the `HttpCtx` before each request. Steps are powered by `@backendkit-labs/pipeline`.
-
-```typescript
-import type { PipelineStep, StepResult } from '@backendkit-labs/pipeline';
-import { Ok } from '@backendkit-labs/pipeline';
-import type { HttpCtx, HttpClientError } from '@backendkit-labs/http-client';
-
-const authStep: PipelineStep<HttpCtx, HttpClientError> = {
-  stepName: 'auth',
-  async handle(ctx): Promise<StepResult<HttpCtx, HttpClientError>> {
-    const token = await tokenStore.get();
-    return Ok({ ...ctx, headers: { ...ctx.headers, Authorization: `Bearer ${token}` } });
-  },
-};
-
-const client = new HttpClient({ steps: [authStep] });
-```
-
-A step can abort the request by returning `Err(...)`:
-
-```typescript
-import { Err } from '@backendkit-labs/pipeline';
-
-const rateLimitStep: PipelineStep<HttpCtx, HttpClientError> = {
-  stepName: 'rate-limit',
-  async handle(ctx): Promise<StepResult<HttpCtx, HttpClientError>> {
-    if (await rateLimiter.isExceeded()) {
-      return Err({ type: 'network', message: 'Rate limit exceeded' });
-    }
-    return Ok(ctx);
-  },
-};
-```
-
----
-
-## Observability
-
-```typescript
-// Snapshot of lifetime counters
-client.getMetrics();
-// → { requests, success, failed, cancelled, circuitOpen, retried }
-
-// Circuit breaker state and counters
-client.getCircuitBreakerState();   // 'closed' | 'open' | 'half_open' | undefined
-client.getCircuitBreakerMetrics(); // detailed metrics or undefined
-```
-
----
-
-## NestJS Integration
-
-### Module registration
-
-```typescript
-// Define typed injection tokens
-export const PRIMARY_API   = defineHttpClient('primary-api');
-export const PAYMENTS_API  = defineHttpClient('payments-api');
-```
-
-```typescript
-import { HttpClientModule } from '@backendkit-labs/http-client/nestjs';
-import { PRIMARY_API, PAYMENTS_API } from './tokens';
-
-@Module({
-  imports: [
-    HttpClientModule.forRoot({
-      clients: [
-        { token: PRIMARY_API,  config: { baseURL: 'https://api.example.com',     retry: { attempts: 3, delayMs: 100 } } },
-        { token: PAYMENTS_API, config: { baseURL: 'https://payments.example.com', circuitBreaker: { failureThreshold: 40, minimumCalls: 3 } } },
-      ],
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-### Injection
-
-```typescript
-import { InjectHttpClient } from '@backendkit-labs/http-client/nestjs';
-import { PRIMARY_API } from './tokens';
-
-@Injectable()
-export class UserService {
-  constructor(
-    @InjectHttpClient(PRIMARY_API) private readonly http: HttpClient,
-  ) {}
-
-  async getUsers(): Promise<User[]> {
-    const result = await this.http.get<User[]>('/users');
-    if (!result.ok) throw new Error(result.error.message);
-    return result.value.data;
-  }
-}
-```
-
-### Async module registration
-
-```typescript
-HttpClientModule.forRootAsync({
-  imports: [ConfigModule],
-  inject:  [ConfigService],
-  useFactory: (config: ConfigService) => ({
-    clients: [{
-      token:  PRIMARY_API,
-      config: { baseURL: config.get('API_URL'), timeout: config.get('API_TIMEOUT') },
-    }],
-  }),
-}),
-```
-
----
-
-## Named Clients
-
-```typescript
-import { defineHttpClient, HttpClientToken } from '@backendkit-labs/http-client';
-
-export const GITHUB_API: HttpClientToken = defineHttpClient('github-api');
-
-// Provides the token's symbol as the NestJS DI token:
-// Inject with @InjectHttpClient(GITHUB_API)
-```
-
----
-
-## License
-
-MIT
+# @backendkit-labs/http-client
+
+[![npm version](https://img.shields.io/npm/v/@backendkit-labs/http-client?style=flat-square&color=cb3837)](https://www.npmjs.com/package/@backendkit-labs/http-client)
+[![CI](https://img.shields.io/github/actions/workflow/status/backendkit-dev/backendkit-monorepo/ci.yml?style=flat-square&label=CI)](https://github.com/backendkit-dev/backendkit-monorepo/actions/workflows/ci.yml)
+[![License](https://img.shields.io/npm/l/@backendkit-labs/http-client?style=flat-square)](LICENSE)
+[![Node](https://img.shields.io/node/v/@backendkit-labs/http-client?style=flat-square)](package.json)
+
+> Production-grade HTTP client for Node.js — built on axios with circuit breaker, retry with exponential backoff, typed `Result<T, E>` responses, request cancellation, pre-request pipeline middleware, and optional NestJS DI integration.
+
+Every method returns `Result<HttpResponse<T>, HttpClientError>` — no try/catch needed, no unhandled rejections, always typed.
+
+---
+
+## Installation
+
+```bash
+npm install @backendkit-labs/http-client axios
+```
+
+NestJS peer dependencies (only for the `/nestjs` subpath):
+
+```bash
+npm install @nestjs/common @nestjs/core rxjs
+```
+
+---
+
+## TypeScript Configuration
+
+### Subpath exports (`/nestjs`)
+
+This package uses the `exports` field in `package.json` to expose the `/nestjs` subpath. TypeScript's ability to resolve it depends on the `moduleResolution` setting in your `tsconfig.json`.
+
+**Modern resolution (recommended) — no extra config needed:**
+
+```json
+{
+  "compilerOptions": {
+    "moduleResolution": "bundler"
+  }
+}
+```
+
+`"bundler"`, `"node16"`, and `"nodenext"` all understand the `exports` field natively.
+
+**Legacy resolution (`"node"`) — add `paths` aliases:**
+
+```json
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "paths": {
+      "@backendkit-labs/http-client/nestjs": [
+        "./node_modules/@backendkit-labs/http-client/dist/nestjs/index.d.ts"
+      ]
+    }
+  }
+}
+```
+
+**NestJS decorator support:**
+
+```json
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  }
+}
+```
+
+And in your `main.ts`, before anything else:
+
+```typescript
+import 'reflect-metadata';
+```
+
+---
+
+## Quick Start
+
+```typescript
+import { HttpClient } from '@backendkit-labs/http-client';
+
+const client = new HttpClient({
+  baseURL: 'https://api.example.com',
+  timeout: 5_000,
+});
+
+// All methods return Result<HttpResponse<T>, HttpClientError>
+const result = await client.get<User[]>('/users');
+
+if (result.ok) {
+  console.log(result.value.data);   // User[]
+  console.log(result.value.status); // 200
+} else {
+  console.error(result.error.type);   // 'http' | 'network' | 'timeout' | 'cancelled' | 'circuit-open'
+  console.error(result.error.status); // 404, 500, etc. (for 'http' type)
+}
+```
+
+---
+
+## Configuration
+
+```typescript
+const client = new HttpClient({
+  baseURL:  'https://api.example.com',
+  timeout:  10_000,          // default: 10 000 ms
+  headers:  { 'X-API-Key': 'secret' },
+
+  // Retry with exponential backoff + jitter
+  retry: {
+    attempts:    3,           // retries after first failure
+    delayMs:     100,
+    maxDelayMs:  5_000,
+    jitter:      true,
+    shouldRetry: (err) => err.type === 'network' || err.type === 'timeout',
+  },
+
+  // Circuit breaker
+  circuitBreaker: {
+    failureThreshold:  50,    // % of calls that must fail to open the circuit
+    minimumCalls:      5,     // minimum calls before evaluating thresholds
+    slidingWindowSize: 10,
+    openTimeoutMs:     30_000,
+  },
+
+  // Pre-request middleware steps
+  steps: [authStep, correlationIdStep],
+});
+```
+
+---
+
+## HTTP Methods
+
+All methods accept an optional `RequestConfig`:
+
+```typescript
+interface RequestConfig {
+  headers?:       Record<string, string>;
+  params?:        Record<string, unknown>;   // query string parameters
+  timeout?:       number;                    // per-request override
+  cancelKey?:     string;                    // key to cancel this request
+  correlationId?: string;
+}
+```
+
+```typescript
+client.get<T>(url, config?)
+client.post<T>(url, data?, config?)
+client.put<T>(url, data?, config?)
+client.patch<T>(url, data?, config?)
+client.delete<T>(url, config?)
+```
+
+---
+
+## Error Types
+
+```typescript
+type HttpErrorType = 'http' | 'network' | 'timeout' | 'cancelled' | 'circuit-open';
+
+interface HttpClientError {
+  type:     HttpErrorType;
+  message:  string;
+  status?:  number;   // only for 'http'
+  data?:    unknown;  // response body, only for 'http'
+  cause?:   unknown;  // original axios error
+}
+```
+
+---
+
+## Request Cancellation
+
+Register a `cancelKey` on the request and cancel by key at any time:
+
+```typescript
+const promise = client.get('/long-poll', { cancelKey: 'my-poll' });
+
+// Cancel a specific request
+client.cancelRequest('my-poll');
+
+// Cancel all in-flight requests
+client.cancelAll();
+
+const result = await promise;
+if (!result.ok && result.error.type === 'cancelled') {
+  // handle cancellation
+}
+```
+
+---
+
+## Pipeline Middleware
+
+Pre-request middleware steps transform the `HttpCtx` before each request. Steps are powered by `@backendkit-labs/pipeline`.
+
+```typescript
+import type { PipelineStep, StepResult } from '@backendkit-labs/pipeline';
+import { Ok } from '@backendkit-labs/pipeline';
+import type { HttpCtx, HttpClientError } from '@backendkit-labs/http-client';
+
+const authStep: PipelineStep<HttpCtx, HttpClientError> = {
+  stepName: 'auth',
+  async handle(ctx): Promise<StepResult<HttpCtx, HttpClientError>> {
+    const token = await tokenStore.get();
+    return Ok({ ...ctx, headers: { ...ctx.headers, Authorization: `Bearer ${token}` } });
+  },
+};
+
+const client = new HttpClient({ steps: [authStep] });
+```
+
+A step can abort the request by returning `Err(...)`:
+
+```typescript
+import { Err } from '@backendkit-labs/pipeline';
+
+const rateLimitStep: PipelineStep<HttpCtx, HttpClientError> = {
+  stepName: 'rate-limit',
+  async handle(ctx): Promise<StepResult<HttpCtx, HttpClientError>> {
+    if (await rateLimiter.isExceeded()) {
+      return Err({ type: 'network', message: 'Rate limit exceeded' });
+    }
+    return Ok(ctx);
+  },
+};
+```
+
+---
+
+## Observability
+
+```typescript
+// Snapshot of lifetime counters
+client.getMetrics();
+// → { requests, success, failed, cancelled, circuitOpen, retried }
+
+// Circuit breaker state and counters
+client.getCircuitBreakerState();   // 'closed' | 'open' | 'half_open' | undefined
+client.getCircuitBreakerMetrics(); // detailed metrics or undefined
+```
+
+---
+
+## NestJS Integration
+
+### Module registration
+
+```typescript
+// Define typed injection tokens
+export const PRIMARY_API   = defineHttpClient('primary-api');
+export const PAYMENTS_API  = defineHttpClient('payments-api');
+```
+
+```typescript
+import { HttpClientModule } from '@backendkit-labs/http-client/nestjs';
+import { PRIMARY_API, PAYMENTS_API } from './tokens';
+
+@Module({
+  imports: [
+    HttpClientModule.forRoot({
+      clients: [
+        { token: PRIMARY_API,  config: { baseURL: 'https://api.example.com',     retry: { attempts: 3, delayMs: 100 } } },
+        { token: PAYMENTS_API, config: { baseURL: 'https://payments.example.com', circuitBreaker: { failureThreshold: 40, minimumCalls: 3 } } },
+      ],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Injection
+
+```typescript
+import { InjectHttpClient } from '@backendkit-labs/http-client/nestjs';
+import { PRIMARY_API } from './tokens';
+
+@Injectable()
+export class UserService {
+  constructor(
+    @InjectHttpClient(PRIMARY_API) private readonly http: HttpClient,
+  ) {}
+
+  async getUsers(): Promise<User[]> {
+    const result = await this.http.get<User[]>('/users');
+    if (!result.ok) throw new Error(result.error.message);
+    return result.value.data;
+  }
+}
+```
+
+### Async module registration
+
+```typescript
+HttpClientModule.forRootAsync({
+  imports: [ConfigModule],
+  inject:  [ConfigService],
+  useFactory: (config: ConfigService) => ({
+    clients: [{
+      token:  PRIMARY_API,
+      config: { baseURL: config.get('API_URL'), timeout: config.get('API_TIMEOUT') },
+    }],
+  }),
+}),
+```
+
+---
+
+## Named Clients
+
+```typescript
+import { defineHttpClient, HttpClientToken } from '@backendkit-labs/http-client';
+
+export const GITHUB_API: HttpClientToken = defineHttpClient('github-api');
+
+// Provides the token's symbol as the NestJS DI token:
+// Inject with @InjectHttpClient(GITHUB_API)
+```
+
+---
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,79 +1,106 @@
 {
   "name": "@backendkit-labs/http-client",
-  "version": "0.1.0",
-  "description": "Production-grade HTTP client for Node.js — built on axios with circuit breaker, retry with backoff, request cancellation, typed Result responses, pipeline middleware, and optional NestJS integration",
+  "version": "0.1.1",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "BackendKit Labs",
+    "email": "backendkit.dev@gmail.com"
+  },
+  "description": "Production-grade HTTP client for Node.js — built on axios with circuit breaker, retry with backoff, request cancellation, typed Result responses, pipeline middleware, and optional NestJS integration",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types":   "./dist/index.d.ts",
-      "import":  "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
     "./nestjs": {
-      "types":   "./dist/nestjs/index.d.ts",
-      "import":  "./dist/nestjs/index.js",
+      "types": "./dist/nestjs/index.d.ts",
+      "import": "./dist/nestjs/index.js",
       "require": "./dist/nestjs/index.cjs"
     }
   },
-  "files": ["dist", "README.md", "LICENSE"],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "build":          "tsup",
-    "dev":            "tsup --watch",
-    "test":           "vitest run",
-    "test:watch":     "vitest",
-    "test:coverage":  "vitest run --coverage",
-    "typecheck":      "tsc --noEmit",
-    "lint":           "eslint src/",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
     "prepublishOnly": "npm run build && npm run test && npm run lint"
   },
   "keywords": [
-    "http", "axios", "circuit-breaker", "retry", "result",
-    "pipeline", "cancel", "nestjs", "node", "typescript"
+    "http",
+    "axios",
+    "circuit-breaker",
+    "retry",
+    "result",
+    "pipeline",
+    "cancel",
+    "nestjs",
+    "node",
+    "typescript"
   ],
-  "author": "Mairon José Cuello Martínez",
-  "license": "MIT",
   "homepage": "https://github.com/backendkit-dev/backendkit-monorepo/tree/master/packages/http-client#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/backendkit-dev/backendkit-monorepo.git",
     "directory": "packages/http-client"
   },
-  "bugs": { "url": "https://github.com/backendkit-dev/backendkit-monorepo/issues" },
-  "publishConfig": { "access": "public" },
+  "bugs": {
+    "url": "https://github.com/backendkit-dev/backendkit-monorepo/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "sideEffects": false,
-  "engines": { "node": ">=18" },
+  "engines": {
+    "node": ">=18"
+  },
   "dependencies": {
     "@backendkit-labs/circuit-breaker": "*",
-    "@backendkit-labs/pipeline":        "*",
-    "@backendkit-labs/result":          "*"
+    "@backendkit-labs/pipeline": "*",
+    "@backendkit-labs/result": "*"
   },
   "peerDependencies": {
     "@nestjs/common": ">=10.0.0",
-    "@nestjs/core":   ">=10.0.0",
-    "axios":          ">=1.0.0",
-    "rxjs":           ">=7.0.0"
+    "@nestjs/core": ">=10.0.0",
+    "axios": ">=1.0.0",
+    "rxjs": ">=7.0.0"
   },
   "peerDependenciesMeta": {
-    "@nestjs/common": { "optional": true },
-    "@nestjs/core":   { "optional": true },
-    "rxjs":           { "optional": true }
+    "@nestjs/common": {
+      "optional": true
+    },
+    "@nestjs/core": {
+      "optional": true
+    },
+    "rxjs": {
+      "optional": true
+    }
   },
   "devDependencies": {
-    "@eslint/js":        "^9.39.4",
-    "@nestjs/common":    "^10.0.0",
-    "@nestjs/core":      "^10.0.0",
-    "@types/node":       "^22.0.0",
-    "axios":             "^1.7.0",
+    "@eslint/js": "^9.39.4",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@types/node": "^22.0.0",
+    "axios": "^1.7.0",
     "axios-mock-adapter": "^2.1.0",
-    "eslint":            "^9.0.0",
-    "reflect-metadata":  "^0.2.0",
-    "rxjs":              "^7.8.0",
-    "tsup":              "^8.0.0",
-    "typescript":        "^5.5.0",
+    "eslint": "^9.0.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
     "typescript-eslint": "^8.59.3",
-    "vitest":            "^2.0.0"
+    "vitest": "^2.0.0"
   }
 }