@odg/message 1.18.0 → 1.19.0

package/agents.md

@@ -1,39 +1,26 @@
 # ODG Message - Consumer Guide
 
-## 🎯 Purpose
+Use this file as the package-level source of truth for AI agents and developers integrating `@odg/message`.
 
-- Padronizar contratos TypeScript de request/response para clientes HTTP/mensageria.
-- Permitir que apps consumam uma implementação própria via `MessageInterface`.
-- Fornecer tipos de erro e type guards unificados para tratamento de falhas.
+## Purpose
 
-## 📜 Contracts
+- Standardize TypeScript request/response contracts for HTTP or messaging clients.
+- Allow applications to plug in their own implementation through `MessageInterface`.
+- Example plug in `AxiosMessage` in `@odg/axios` to message with axios package.
+- Provide unified exceptions and type guards for safe error handling.
 
-- Entrada principal exporta: tipos de `./interfaces`, `MessageResponse`, `MessageException`, `MessageUnknownException`, `ODGMessage`, `Methods`, `CacheableLookup`.
-- Contrato central: `MessageInterface<RequestData, ResponseData>` com `request`, `interceptors`, `getDefaultOptions`, `setDefaultOptions`.
-- Request: `RequestInterface`, `RequestOptionsParametersInterface`, `ParametersInterface`, `ProxyConfigInterface`.
-- Response: `ResponseInterface`, `ResponseType`, `HttpHeadersInterface`, `MessageResponse`.
-- Interceptors: `InterceptorsInterface`, `InterceptorManager`, `onFulfilledType`, `onRejectedType`.
-- DNS cache opcional: `CacheableLookupConfig`, `LookupCacheType`, `LookupKeyType`, `LookupPromiseResult`.
+## Integration/Review Rules
 
-## 🚦 Rules (Usage)
+- All messages is typed with `MessageInterface<Req, Res>`
+- In `RequestInterface<RequestData>`:
+  - `RequestInterface.method` **MUST** use `Methods` enum when available, **MAY** use `string` for non-standard/custom verbs.
+  - `RequestInterface.baseUrl` **MUST** be domain-only and **MUST NOT** include a `/` at the end.
+  - `RequestInterface.url` **MUST** be a path that starts with `/` and represents the endpoint path to call.
+- Interceptor IDs returned by `use(...)` **MUST** be stored when lifecycle cleanup is needed, then removed with `eject(id)`.
+- Unknown types **MUST** be narrowed with `ODGMessage.isMessage(...)` or `ODGMessage.isMessageError(...)` before accessing message-specific fields, **MUST NOT** use instanceof.
 
-- Consumir pela API do pacote `@odg/message`; não importar caminhos internos.
-- Tipar chamadas com `MessageInterface<Req, Res>` e `RequestInterface<Req>`.
-- Usar `Methods` para padronizar verbos HTTP no campo `method`.
-- Em interceptors, persistir o id retornado por `use(...)` para remoção com `eject(id)`.
-- Para tratamento seguro de `unknown`, usar `ODGMessage.isMessage(...)` ou `ODGMessage.isMessageError(...)`.
-- Ao usar `CacheableLookup`, fornecer uma implementação compatível com `CacheInterface<LookupCacheType>`.
+## Known Integration Pitfalls
 
-## 💥 Exceptions
-
-- `MessageException<RequestData, ResponseData>`: erro de integração/transporte que inclui `message`, `code`, e opcionalmente `request`/`response`.
-- `MessageUnknownException<RequestData, ResponseData>`: erro não mapeado conhecido pela camada de mensagem, com mesma estrutura de contexto.
-- Quando há `request` e `response`, ambas oferecem `getMessage(): MessageResponse | undefined`.
-- Tratamento recomendado: capturar `unknown`, validar com `ODGMessage.isMessageError`, então usar `message`, `code` e `getMessage()` quando disponível.
-
-## ⚠️ Integration Pitfalls
-
-- `getMessageResponse()` nas exceptions retorna `MessageResponse` opcional caso não tenha `request` ou `response`.
-- `method` aceita `Methods | string`; valores fora do padrão podem passar na tipagem e falhar no cliente concreto.
-- `RequestInterface` possui campos opcionais amplos; dependências de validação ficam no implementador concreto.
-- `CacheableLookup` depende de `@odg/cache`; exceptions dependem de `@odg/exception` quando esses recursos forem usados.
+- `getMessageResponse()` can be `undefined` when `request` or `response` is absent.
+- `RequestInterface` is intentionally flexible; concrete clients **SHOULD** validate required fields.
+- `CacheableLookup` depends on `@odg/cache`; exception flows depend on `@odg/exception` when those features are used.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@odg/message",
-    "version": "1.18.0",
+    "version": "1.19.0",
     "description": "Interface request fo inversion of control",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -36,25 +36,25 @@
     "author": "Dragons Gamers <https://www.linkedin.com/in/victor-alves-odgodinho>",
     "license": "MIT",
     "devDependencies": {
-        "@odg/eslint-config": "^3.8.0",
+        "@odg/eslint-config": "^3.9.0",
         "@odg/tsconfig": "^1.5.0",
         "@types/node": ">=24",
-        "@vitest/coverage-istanbul": "^4.1.7",
-        "concurrently": "^10.0.0",
+        "@vitest/coverage-istanbul": "^4.1.8",
+        "concurrently": "^10.0.3",
         "rimraf": "^6.1.3",
         "tsc-alias": "^1.8.17",
-        "tsx": "^4.22.3",
+        "tsx": "^4.22.4",
         "typescript": "^6.0.3",
-        "vite": "^8.0.14",
-        "vitest": "^4.1.7"
+        "vite": "^8.0.16",
+        "vitest": "^4.1.8"
     },
     "dependencies": {
-        "@odg/cache": "^1.7.0",
-        "@odg/exception": "^1.14.0"
+        "@odg/cache": "^1.8.0",
+        "@odg/exception": "^1.15.0"
     },
     "peerDependencies": {
-        "@odg/cache": "^1.7.0",
-        "@odg/exception": "^1.14.0"
+        "@odg/cache": "^1.8.0",
+        "@odg/exception": "^1.15.0"
     },
     "peerDependenciesMeta": {
         "@odg/cache": {