@bereasoftware/nexa 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.en.md CHANGED
@@ -954,9 +954,11 @@ manager.register(rateLimitPlugin);
954
954
 
955
955
  ---
956
956
 
957
- ## Dev Overlay
958
-
959
- Built-in visual development tool for debugging and monitoring HTTP requests in real-time.
957
+ ## Dev Overlay
958
+
959
+ Built-in visual development tool for debugging and monitoring HTTP requests in real-time.
960
+
961
+ > API status: publicly available and intended for browser development flows. It is not designed for SSR or Node runtimes without a DOM.
960
962
 
961
963
  ```typescript
962
964
  import { createHttpClient, createDevOverlay } from "@bereasoftware/nexa";
@@ -1007,8 +1009,10 @@ createDevOverlay(config?: DevOverlayConfig): { tracker: RequestTracker; ui: DevO
1007
1009
  **Behavior notes:**
1008
1010
 
1009
1011
  - `createDevOverlay()` is a singleton. Multiple calls reuse the same instance.
1012
+ - The overlay only mounts UI when a DOM is available. In SSR or Node you can import the module safely, but no panel is rendered.
1010
1013
  - `theme` is typed as `'dark' | 'light'`, but the current UI is primarily designed for dark mode.
1011
1014
  - The retry button uses direct `fetch()` for quick revalidation; it does not automatically replay interceptors or advanced `HttpClient` configuration.
1015
+ - `destroyDevOverlay()` clears the singleton instance, removes the panel, and unregisters the global listeners used by the overlay.
1012
1016
 
1013
1017
  **Note:** Advanced request options such as `transformRequest`, `credentials`, `withCredentials`, `debug`, `logger`, `transport`, `nodeOptions`, and `autoFormData` are already typed, but not all of them are fully wired into the main `HttpClient` pipeline in this release.
1014
1018
 
@@ -1034,6 +1038,13 @@ getDevOverlay() // Get current { tracker, ui } or null if not created yet
1034
1038
  destroyDevOverlay() // Destroy the current singleton instance
1035
1039
  ```
1036
1040
 
1041
+ **When to use each export:**
1042
+
1043
+ - `createDevOverlay()` creates or reuses the overlay and returns the `tracker` you pass into `createHttpClient({ devTracker })`.
1044
+ - `getDevOverlay()` lets you inspect the current instance without creating a new one.
1045
+ - `destroyDevOverlay()` is useful for full teardown during hot reloads, tests, or manual cleanup.
1046
+ - `RequestTracker` can be used on its own if you want request history and metrics without mounting the UI.
1047
+
1037
1048
  **Exposed data shapes:**
1038
1049
 
1039
1050
  ```typescript
package/README.md CHANGED
@@ -1291,9 +1291,11 @@ manager.register(rateLimitPlugin);
1291
1291
 
1292
1292
  ---
1293
1293
 
1294
- ## Dev Overlay
1295
-
1296
- Herramienta visual de desarrollo integrada para depurar y monitorear requests HTTP en tiempo real.
1294
+ ## Dev Overlay
1295
+
1296
+ Herramienta visual de desarrollo integrada para depurar y monitorear requests HTTP en tiempo real.
1297
+
1298
+ > Estado de API: disponible públicamente y pensada para flujos de desarrollo en navegador. No está orientada a entornos SSR o Node sin DOM.
1297
1299
 
1298
1300
  ```typescript
1299
1301
  import { createHttpClient, createDevOverlay } from "@bereasoftware/nexa";
@@ -1344,8 +1346,10 @@ createDevOverlay(config?: DevOverlayConfig): { tracker: RequestTracker; ui: DevO
1344
1346
  **Notas de comportamiento:**
1345
1347
 
1346
1348
  - `createDevOverlay()` es singleton. Si lo llamas varias veces, reutiliza la misma instancia.
1349
+ - El overlay solo monta UI cuando hay DOM disponible. En SSR o Node puedes importar el módulo sin romper el proceso, pero no se renderiza panel.
1347
1350
  - `theme` está tipado como `'dark' | 'light'`, pero la UI actual está diseñada principalmente para tema oscuro.
1348
1351
  - El botón de retry del panel usa `fetch()` directo para revalidación rápida; no reaplica automáticamente interceptores ni configuración avanzada del `HttpClient`.
1352
+ - `destroyDevOverlay()` limpia la instancia singleton, desmonta el panel y remueve listeners globales registrados por el overlay.
1349
1353
 
1350
1354
  **Métodos del UI:**
1351
1355
 
@@ -1369,6 +1373,13 @@ getDevOverlay() // Obtener { tracker, ui } actuales o null si no existen
1369
1373
  destroyDevOverlay() // Destruir la instancia singleton actual
1370
1374
  ```
1371
1375
 
1376
+ **Cuándo usar cada export:**
1377
+
1378
+ - `createDevOverlay()` crea o reutiliza el overlay y devuelve el `tracker` que debes pasar a `createHttpClient({ devTracker })`.
1379
+ - `getDevOverlay()` te permite consultar la instancia actual sin crear una nueva.
1380
+ - `destroyDevOverlay()` sirve para cerrar completamente la herramienta en hot reloads, tests o limpieza manual.
1381
+ - `RequestTracker` puede usarse por separado si quieres recolectar historial y métricas sin montar la UI.
1382
+
1372
1383
  **Estructuras expuestas:**
1373
1384
 
1374
1385
  ```typescript
package/dist/nexa.es.js CHANGED
@@ -1,4 +1,4 @@
1
- /*! Nexa v1.4.0 | (c) 2026 Berea-Soft | MIT License | https://github.com/Berea-Soft/Nexa */
1
+ /*! Nexa v1.4.1 | (c) 2026 Berea-Soft | MIT License | https://github.com/Berea-Soft/Nexa */
2
2
  //#region src/types/index.ts
3
3
  var e = (e) => ({
4
4
  ok: !0,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bereasoftware/nexa",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "type": "module",
5
5
  "main": "./dist/nexa.cjs.js",
6
6
  "module": "./dist/nexa.es.js",
Binary file