heimdall-api-platform 1.0.11 → 1.0.32

package/README.md

@@ -39,7 +39,6 @@ Ideal para arquiteturas modernas, legadas ou híbridas, ele permite centralizar
 * 📄 Documentação automática com Swagger e Redocly
 * 🎭 Suporte a mocks estáticos e dinâmicos
 * ▶️ Execução de functions customizadas, integração com clientes de API e mocks internos
-* 🧪 Testes automatizados com Mocha + Chai
 * 🛠️ Padronização de erros e respostas de falha
 * 🔖 Geração automática de correlation id para rastreamento
 * ☁️ Totalmente compatível com AWS Lambda e Google Cloud Functions
@@ -60,97 +59,190 @@ npm install heimdall-api-platform
 
 ---
 
-## 🔧 Exemplo de Uso Básico
+## 🔧 Exemplos de Configuração de Rotas
 
-### execute-function
+### 1. execute-function
 
 ```js
 module.exports = {
-    name: 'executeFunction',
-    description: 'Execute Function',
-    method: 'POST',
-    route: '/execute_function',
-    indexedResult: false,
-    responseHeaders: {
-        'Content-Type': 'application/json;charset=UTF-8'
-    },
-    flow: [{
-        resultVariable: '.',
-        skipErrors: false,
-        cacheEnable: true,
-        cacheTtl: 10, // TTL em segundos
-        operation: {
-            functionName: 'return-body-result',
-            type: 'function',
-        }
-    }]
+  name: 'executeFunction',
+  description: 'Execute Function',
+  method: 'POST',
+  route: '/execute_function',
+  indexedResult: false,
+  responseHeaders: {
+    'Content-Type': 'application/json;charset=UTF-8'
+  },
+  flow: [
+    {
+      resultVariable: '.',
+      skipErrors: false,
+      cacheEnable: true,
+      cacheTtl: 10, // TTL em segundos
+      operation: {
+        functionName: 'return-body-result',
+        type: 'function'
+      }
+    }
+  ]
 };
 ```
 
-### execute-mock
+| **Atributo**      | **Descrição**                                   |
+| ----------------- | ----------------------------------------------- |
+| `name`            | Identificador único da rota/configuração.       |
+| `description`     | Descrição para documentação.                    |
+| `method`          | Método HTTP (GET, POST, etc.).                  |
+| `route`           | Caminho exposto no gateway.                     |
+| `indexedResult`   | Se deve indexar o resultado para uso posterior. |
+| `responseHeaders` | Headers fixos retornados na resposta.           |
+
+**Detalhes do `flow`**
+
+| **Campo**        | **Descrição**                                |
+| ---------------- | -------------------------------------------- |
+| `resultVariable` | Variável onde armazenar o saída da operação. |
+| `skipErrors`     | Se `true`, ignora erros e continua o fluxo.  |
+| `cacheEnable`    | Se `true`, ativa cache para esta operação.   |
+| `cacheTtl`       | Tempo de vida (segundos) do cache.           |
+| `operation`      | Configuração da operação (`function`).       |
+
+**Configuração `operation`**
+
+| **Campo**      | **Descrição**                           |
+| -------------- | --------------------------------------- |
+| `functionName` | Nome da função registrada no framework. |
+| `type`         | Tipo de operação (`function`).          |
+
+---
+
+### 2. execute-mock
 
 ```js
 module.exports = {
-    name: 'executeMock',
-    description: 'Execute Mock',
-    method: 'GET',
-    route: '/execute_mock',
-    indexedResult: false,
-    responseHeaders: {
-        'Content-Type': 'application/json;charset=UTF-8'
-    },
-    flow: [{
-        resultVariable: '.',
-        skipErrors: false,
-        operation: {
-            file: 'demo-mock.json',
-            type: 'mock',
-        }
-    }]
+  name: 'executeMock',
+  description: 'Execute Mock',
+  method: 'GET',
+  route: '/execute_mock',
+  indexedResult: false,
+  responseHeaders: {
+    'Content-Type': 'application/json;charset=UTF-8'
+  },
+  flow: [
+    {
+      resultVariable: '.',
+      skipErrors: false,
+      operation: {
+        file: 'demo-mock.json',
+        type: 'mock'
+      }
+    }
+  ]
 };
 ```
 
-### execute-api-rest (usando client)
+| **Atributo**      | **Descrição**                        |
+| ----------------- | ------------------------------------ |
+| `name`            | Identificador único da rota de mock. |
+| `description`     | Descrição para documentação.         |
+| `method`          | Método HTTP.                         |
+| `route`           | Caminho exposto no mock.             |
+| `indexedResult`   | Se deve indexar o mock.              |
+| `responseHeaders` | Headers fixos para resposta do mock. |
+
+**Detalhes do `flow`**
+
+| **Campo**        | **Descrição**                             |
+| ---------------- | ----------------------------------------- |
+| `resultVariable` | Variável que receberá o conteúdo do mock. |
+| `skipErrors`     | Se `true`, ignora erros.                  |
+| `operation`      | Configuração da operação (`mock`).        |
+
+**Configuração `operation`**
+
+| **Campo** | **Descrição**                      |
+| --------- | ---------------------------------- |
+| `file`    | Caminho para arquivo JSON de mock. |
+| `type`    | Tipo de operação (`mock`).         |
+
+---
+
+### 3. execute-api-rest (usando client)
 
 ```js
 module.exports = {
-    name: "addressByZipcodeService",
-    description: "Get Address By Zipcode",
-    method: "GET",
-    route: "/:zipcode/by_client_api",
-    indexedResult: false,
-    responseHeaders: {
-        "Content-Type": "application/json;charset=UTF-8",
-    },
-    flow: [
-        {
-            resultVariable: ".",
-            skipErrors: false,
-            cacheEnable: false,
-            cacheTtl: 24 * 60 * 30, // 30 dias
-            cacheKey: "{{params.zipcode}}",
-            operation: {
-                clientName: "viaCEP",
-                mergedHeaders: false,
-                headersTransformation: "transformation-header-get-cep",
-                requestTransformation: "transformation-request-get-cep",
-                responseTransformation: "transformation-response-get-cep",
-                onError: "on-error-get-cep",
-                onSuccess: "on-success-get-cep",
-                headers: {
-                    "Content-Type": "application/json;charset=UTF-8",
-                    "X-HEADER-CEP": "{{params.zipcode}}",
-                },
-                type: "http",
-                method: "GET",
-                path: "/{{params.zipcode}}/json",
-            },
+  name: 'addressByZipcodeService',
+  description: 'Get Address By Zipcode',
+  method: 'GET',
+  route: '/:zipcode/by_client_api',
+  indexedResult: false,
+  responseHeaders: {
+    'Content-Type': 'application/json;charset=UTF-8'
+  },
+  flow: [
+    {
+      resultVariable: '.',
+      skipErrors: false,
+      cacheEnable: false,
+      cacheTtl: 24 * 60 * 60 * 30, // 30 dias em segundos
+      cacheKey: '{{params.zipcode}}',
+      operation: {
+        clientName: 'viaCEP',
+        mergedHeaders: false,
+        headersTransformation: 'transformation-header-get-cep',
+        requestTransformation: 'transformation-request-get-cep',
+        responseTransformation: 'transformation-response-get-cep',
+        onError: 'on-error-get-cep',
+        onSuccess: 'on-success-get-cep',
+        headers: {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'X-HEADER-CEP': '{{params.zipcode}}'
         },
-    ],
+        type: 'http',
+        method: 'GET',
+        path: '/{{params.zipcode}}/json'
+      }
+    }
+  ]
 };
 ```
 
----
+| **Atributo**      | **Descrição**                                   |
+| ----------------- | ----------------------------------------------- |
+| `name`            | Identificador único do serviço.                 |
+| `description`     | Descrição para documentação.                    |
+| `method`          | Método HTTP da chamada externa.                 |
+| `route`           | Rota no gateway para chamada externa.           |
+| `indexedResult`   | Se deve indexar o resultado.                    |
+| `responseHeaders` | Headers fixos da resposta.                      |
+| `flow`            | Lista de etapas de orquestração para esta rota. |
+
+**Detalhes do `flow`**
+
+| **Campo**        | **Descrição**                                         |
+| ---------------- | ----------------------------------------------------- |
+| `resultVariable` | Variável que armazena o resultado da chamada externa. |
+| `skipErrors`     | Se `true`, continua o fluxo mesmo com erros.          |
+| `cacheEnable`    | Se `true`, habilita cache para esta operação.         |
+| `cacheTtl`       | TTL do cache em segundos.                             |
+| `cacheKey`       | Chave de cache baseada em parâmetros da rota.         |
+| `operation`      | Configuração da operação HTTP.                        |
+
+**Configuração `operation`**
+
+| **Campo**                | **Descrição**                                             |
+| ------------------------ | --------------------------------------------------------- |
+| `clientName`             | Nome do cliente HTTP em `mappingClients`.                 |
+| `mergedHeaders`          | Se `true`, mescla todos os cabeçalhos de entrada.         |
+| `headersTransformation`  | Função para transformar cabeçalhos.                       |
+| `requestTransformation`  | Função para transformar payload de request.               |
+| `responseTransformation` | Função para transformar a resposta recebida.              |
+| `onError`                | Função acionada em caso de erro.                          |
+| `onSuccess`              | Função acionada em caso de sucesso.                       |
+| `headers`                | Headers estáticos extras para requisição.                 |
+| `type`                   | Tipo da operação (`http`).                                |
+| `method`                 | Método HTTP da chamada externa.                           |
+| `path`                   | Path da rota externa, suportando templates de parâmetros. |
 
 ---
 
@@ -160,80 +252,58 @@ module.exports = {
 
 ```js
 module.exports = {
-  appName: 'demo-api-gateway',
-  serverPort: 9010,
-  enableRedis: true,
-  redisCache: {
-    reader: { host: "localhost", port: 6379 },
-    writer: { host: "localhost", port: 6379 }
-  },
-  enableElasticSearch: false,
+  appName: process.env.appName || 'demo-api-gateway',
+  requestTimeout: process.env.requestTimeout || 20000,
+  requestPerSecond: process.env.requestPerSecond || 40,
+  memoryCheckInterval: process.env.memoryCheckInterval || 20000,
+  serverPort: process.env.serverPort || 9010,
   logger: {
     Console: {
-      level: "info"
+      level: process.env.loggerLevel || 'info'
     }
+  },
+  enableRedis: true,
+  redisCache: {
+    reader: { host: 'localhost', port: 6379, connectTimeout: 5000 },
+    writer: { host: 'localhost', port: 6379, connectTimeout: 5000 }
+  },
+  enableElasticSearch: process.env.elasticEnable,
+  elasticSearch: {
+    indexName: process.env.elasticIndexName,
+    client: process.env.elasticClient,
+    credentials: { accessKeyId: process.env.elasticAccessKeyId, secretAccessKey: process.env.elasticSecretAccessKey },
+    host: process.env.elasticHost,
+    port: process.env.elasticPort
   }
 };
 ```
 
-### `mappingClients.js`
-
-```js
-module.exports = {
-  viaCEP: {
-    description: "Consulta CEP",
-    basePath: "ws/",
-    host: "https://viacep.com.br",
-    timeout: 9000,
-    healthCheck: "ws/01001000/json"
-  }
-};
-```
-
-### `mappingServices.js`
-
-```js
-"use strict";
-const routeCEP = require("./controller/demo/routes");
-
-module.exports = [routeCEP];
-```
-
----
-
-## ⚙️ Transformações e Operações de Fluxo
-
-Para cenários avançados, o Heimdall permite aplicar transformações dinâmicas a cabeçalhos, payloads e respostas em tempo de execução, além de tratamento customizado de erros. Exemplo de implementação interna de uma operação HTTP:
-
-```js
-this.type = options.type || Const.FLOW_OPERATION_TYPE.HTTP;
-this.path = options.path || "";
-this.method = options.method || Const.HTTP_METHOD.GET;
-this.body = options.body || "";
-this.mergedHeaders = options.mergedHeaders === undefined ? false : options.mergedHeaders;
-this.encapsuleError = options.encapsuleError === undefined ? true : options.encapsuleError;
-this.httpClient = ClientFactory.createByName(options.clientName);
-this.headers = options.headers || {};
-
-// Factories para transformar headers, request e response:
-this.headersTransformation = TransformationFunctionFactory.create(options.headersTransformation, this);
-this.requestTransformation = TransformationFunctionFactory.create(options.requestTransformation, this);
-this.responseTransformation = TransformationFunctionFactory.create(options.responseTransformation, this);
-
-// Tratamento de erros e sucesso customizado:
-this.ifResponseError = TransformationFunctionFactory.create(options.ifResponseError, this);
-this.onError = TransformationFunctionFactory.create(options.onError, this);
-this.onSuccess = TransformationFunctionFactory.create(options.onSuccess, this);
-```
+| **Atributo**                  | **Descrição**                                            |
+| ----------------------------- | -------------------------------------------------------- |
+| `appName`                     | Nome da aplicação exibido nos logs e métricas.           |
+| `requestTimeout`              | Tempo (ms) para timeout de chamadas a serviços upstream. |
+| `requestPerSecond`            | Limite de requisições por segundo do gateway.            |
+| `memoryCheckInterval`         | Intervalo (ms) para verificar uso de memória.            |
+| `serverPort`                  | Porta na qual o servidor HTTP irá escutar.               |
+| `logger.Console.level`        | Nível de log para console (`info`, `warn`, `error`).     |
+| `enableRedis`                 | Ativa cache e throttling com Redis.                      |
+| `redisCache.reader.*`         | Configurações de conexão de leitura no Redis.            |
+| `redisCache.writer.*`         | Configurações de conexão de escrita no Redis.            |
+| `enableElasticSearch`         | Ativa integração com OpenSearch/ElasticSearch.           |
+| `elasticSearch.indexName`     | Nome do índice para armazenamento de logs.               |
+| `elasticSearch.client`        | Driver utilizado para conexão com OpenSearch.            |
+| `elasticSearch.credentials.*` | Credenciais de acesso ao OpenSearch.                     |
+| `elasticSearch.host`          | Host/URL do serviço OpenSearch.                          |
+| `elasticSearch.port`          | Porta do serviço OpenSearch.                             |
 
 ---
 
 ## ▶️ Comandos Úteis
 
 ```bash
-npm run build         # Gera o código ofuscado e empacota a lib
-npm run test          # Executa os testes automatizados
-npm start             # Inicia localmente o gateway
+npm run build
+npm run test
+npm start
 ```
 
 ---
@@ -252,8 +322,9 @@ export APP_KEY=minha-chave-da-licenca
 
 ## 📜 Política de Licença
 
-* Uso exige validação da licença.
-* Licenciado sob **MIT**.
+* Produção: exige licença.
+* Dev/local: sem restrição.
+* MIT.
 
 ---
 

package/dist/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Márcio Rosa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.