npm - heimdall-api-platform - Versions diffs - 1.0.32 → 1.0.33 - Mend

heimdall-api-platform 1.0.32 → 1.0.33

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.

Files changed (5) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "heimdall-api-platform",
-  "version": "1.0.32",
+  "version": "1.0.33",
   "description": "",
   "main": "dist/index.js",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "test": "mocha --timeout 5000 'test/**/*.test.js'",
     "test:watch": "nodemon --exec 'npm test'",
     "start": "node server.js",
-    "build": "rimraf dist && mkdir dist && ncc build lib/index.js -o dist && javascript-obfuscator ./dist/index.js --output ./dist/index.js --config ./javascript-obfuscator.config.json && cp ./package.json dist && cp ./LICENSE dist && cp ./README.md dist",
+    "build": "rimraf dist && mkdir dist && ncc build lib/index.js -o dist && javascript-obfuscator ./dist/index.js --output ./dist/index.js --config ./javascript-obfuscator.config.json",
     "prepublishOnly": "npm run build"
   },
   "repository": {

package/dist/LICENSE DELETED Viewed

@@ -1,21 +0,0 @@
-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.

package/dist/README.md DELETED Viewed

@@ -1,336 +0,0 @@
-# Heimdall API Platform
-**Um microgateway de alta performance para APIs, com orquestração inteligente e roteamento dinâmico.**
----
-## 🚀 O que é o Heimdall API Platform?
-O Heimdall API Platform é um microgateway projetado para lidar com orquestração de APIs, roteamento dinâmico e integração entre microsserviços de forma flexível e performática.
-Ideal para arquiteturas modernas, legadas ou híbridas, ele permite centralizar e controlar fluxos de requisições com segurança, cache, validação de licença e observabilidade.
----
-## ✅ Problemas que ele resolve
-* Roteamento inteligente entre múltiplas APIs
-* Orquestração de serviços e fluxos condicionais
-* Aplicação de padrões de segurança e autenticação
-* Cache de respostas via Redis
-* Observabilidade com OpenSearch
-* Proteção contra ataques DDoS e throttling de requisições
-* Transformações dinâmicas de dados de request em tempo de execução
-* Facilidade de integração com ambientes heterogêneos (legado + novo)
-* Padronização de erros e tratamento uniforme
-* Geração de correlation id para rastreamento de requisições
----
-## 🧩 Funcionalidades Principais
-* ✅ Gateway de APIs leve e flexível
-* 🔁 Roteamento dinâmico baseado em configurações
-* ⚙️ Orquestração de múltiplos fluxos por rota
-* 🔗 Agregação de vários serviços em uma única requisição utilizando fluxos
-* 🔐 Validação de licença (produção exige chave válida)
-* 📦 Cache com Redis (opcional, mas recomendado)
-* 🔍 Observabilidade com OpenSearch
-* 📄 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
-* 🛠️ 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
----
-## 📦 Pré-requisitos
-* **Node.js** v18 ou superior
----
-## 📥 Instalação via NPM
-```bash
-npm install heimdall-api-platform
-```
----
-## 🔧 Exemplos de Configuração de Rotas
-### 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'
-      }
-    }
-  ]
-};
-```
-| **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'
-      }
-    }
-  ]
-};
-```
-| **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 * 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. |
----
-## 🏗️ Estrutura Esperada de Configuração
-### `environment.js`
-```js
-module.exports = {
-  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: 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
-  }
-};
-```
-| **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
-npm run test
-npm start
-```
----
-## 🔑 Validação de Licença
-Para uso em produção é obrigatória uma licença válida. Em ambientes de desenvolvimento e testes, a licença pode ser omitida.
-A variável `APP_KEY` deve estar presente no ambiente:
-```bash
-export APP_KEY=minha-chave-da-licenca
-```
----
-## 📜 Política de Licença
-* Produção: exige licença.
-* Dev/local: sem restrição.
-* MIT.
----
-## 📫 Suporte e Contato
-* 🏢 **Empresa**: [P4F](https://www.protonss4fun.com.br/)
-* 📧 **E-mail**: [contato@p4f.dev](mailto:contato@p4f.dev)
-© 2025 P4F - Todos os direitos reservados.

package/dist/package.json DELETED Viewed

@@ -1,96 +0,0 @@
-{
-  "name": "heimdall-api-platform",
-  "version": "1.0.32",
-  "description": "",
-  "main": "dist/index.js",
-  "license": "MIT",
-  "files": [
-    "dist/index.js",
-    "LICENSE",
-    "README.md",
-    "package.json"
-  ],
-  "scripts": {
-    "prestart": "npm install",
-    "test": "mocha --timeout 5000 'test/**/*.test.js'",
-    "test:watch": "nodemon --exec 'npm test'",
-    "start": "node server.js",
-    "build": "rimraf dist && mkdir dist && ncc build lib/index.js -o dist && javascript-obfuscator ./dist/index.js --output ./dist/index.js --config ./javascript-obfuscator.config.json && cp ./package.json dist && cp ./LICENSE dist && cp ./README.md dist",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com:protonss4fun/heimdall-api-platform.git"
-  },
-  "keywords": [
-    "api",
-    "gateway",
-    "core",
-    "restful",
-    "json"
-  ],
-  "author": "Márcio Rosa <marcio.rosa@p4f.io>",
-  "bugs": {
-    "url": "https://github.com/protonss4fun/heimdall-api-platform/issues"
-  },
-  "homepage": "https://github.com/protonss4fun/heimdall-api-platform",
-  "dependencies": {
-    "@opensearch-project/opensearch": "^2.4.0",
-    "async": "^3.2.5",
-    "axios": "^1.8.2",
-    "body-parser": "^1.20.2",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "cors": "^2.8.5",
-    "dotenv": "^17.2.0",
-    "express": "^4.18.2",
-    "express-basic-auth": "^1.2.1",
-    "express-throttle": "^2.0.0",
-    "form-data": "^4.0.2",
-    "helmet": "^7.0.0",
-    "http-errors": "^2.0.0",
-    "jsonwebtoken": "^9.0.1",
-    "morgan": "^1.10.0",
-    "multer": "^1.4.5-lts.1",
-    "node-cache": "^5.1.2",
-    "object-hash": "^1.1.8",
-    "pseudomap": "^1.0.2",
-    "redis": "^3.1.2",
-    "redis-rate-limiter": "^1.2.0",
-    "step": "^1.0.0",
-    "underscore": "^1.9.1",
-    "uuid": "^9.0.0",
-    "winston": "^3.2.1",
-    "winston-transport": "4.3.0",
-    "yallist": "^3.0.2",
-    "yaml": "^2.8.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@vercel/ncc": "^0.38.3",
-    "chai": "^4.3.7",
-    "javascript-obfuscator": "^4.1.1",
-    "mocha": "^11.1.0",
-    "nodemon": "^3.1.9",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.45.1",
-    "rollup-plugin-javascript-obfuscator": "^1.0.4",
-    "sinon": "^19.0.2",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4",
-    "webpack-node-externals": "^3.0.0"
-  },
-  "pkg": {
-    "assets": [],
-    "scripts": [
-      "dist/index.js"
-    ],
-    "targets": [
-      "node20-linux-x64",
-      "node20-macos-x64",
-      "node20-win-x64"
-    ],
-    "outputPath": "dist"
-  }
-}