@benup/bensdk 1.13.5 → 1.13.9-0

package/README.md

@@ -1,103 +1,86 @@
-# BenSDK 🚀
+# BenSDK CLI
 
 <div align="center">
   <img src="https://img.shields.io/badge/Status-Stable-green" alt="Status: Stable">
-  <img src="https://img.shields.io/badge/Version-1.12.1-blue" alt="Version: 1.12.1">
+  <img src="https://img.shields.io/badge/Version-1.12.2-blue" alt="Version: 1.12.2">
 </div>
 
+<br>
 <br>
 
 <div align="center">
   <img src="resources/intro.gif" alt="BenSDK CLI Demo" width="800">
 </div>
 
-O BenSDK CLI é uma ferramenta de linha de comando que auxilia no desenvolvimento de projetos que são executados dentro do Integrador Benup. Ele simplifica o processo de criação e gerenciamento dos módulos que se integram ao ecossistema Benup.
-
-## 📋 O que é o BenSDK?
-
-O BenSDK é um framework para a criação de integrações entre benefícios e o ecossistema Benup.
+O BenSDK CLI gera o scaffolding de projetos de integração de benefícios para o ecossistema Benup. Com um único comando você tem um projeto TypeScript pronto com máquina de estados, handlers, testes unitários e servidor local para testar contra a API real do parceiro.
 
-## ✨ Funcionalidades Principais
+## Instalação
 
-- 🚀 Geração de projetos benApp
-- ⚡ Configuração automática do ambiente de desenvolvimento
-- 📦 Suporte a TypeScript
-- 🎯 Interface de linha de comando
-
-## 🛠️ Instalação
+<br>
 
-Instale o BenSDK CLI globalmente via npm:
 ```bash
-npm i -g @benup/bensdk
-```
-
-Após a instalação, o CLI estará disponível através do comando `ben`:
-```
-Usage: BenSDK Tool [options] [command]
-
-CLI to create benefits integration
-
-Options:
-  -V, --version     output the version number
-  -h, --help        display help for command
-
-Commands:
-  init <string>     New project
-  help [command]    display help for command
+npm i -g @benup/bensdk-cli
 ```
 
-## 🚀 Uso
+## Uso
 
-Para criar um novo projeto benApp:
 ```bash
-ben init <NOME-DO-BENEFICIO>
+ben init <BENEFIT-ID>
 ```
 
-Após criar o projeto:
+O CLI vai perguntar:
+- Quais actions o benefício suporta (RECHARGE, DEDUCTION, GRANT_DEPENDENT, REVOKE_DEPENDENT)
+- Categoria do benefício (opcional)
+- Descrição curta (opcional)
+- Configurar git + husky com pre-commit (recomendado)
 
-1. Abra o projeto gerado no seu editor de preferência
-2. Execute o comando para gerar os handlers baseados na máquina de estado:
-```bash
-   npm run generate
-```
-3. Para rodar a integração localmente:
-```bash
-   npm run start
-```
+Ao final, o projeto estará instalado e pronto para uso.
 
-## 📦 Publicação
+## O que é gerado
 
-1. Instale o [maria-cli](https://github.com/benup-dev/maria) seguindo as instruções do repositório.
-2. Execute o comando abaixo na raiz do projeto:
-```bash
-maria benefit deploy -r <link-de-clone-do-repositorio.git> -n <BENEFIT-ID>
+```
+<BENEFIT-ID>/
+├── src/
+│   ├── benefit-definition.ts    # Maquina de estados + schemas (ponto de entrada)
+│   ├── handlers/                # Gerados via npm run generate
+│   └── lib/                     # Utilitarios e mocks
+├── bin/
+│   ├── cli/                     # npm run generate
+│   ├── server/                  # npm run dev:start
+│   └── docs/                    # npm run docs:update
+├── context.config.ts            # Mock context para testes unitarios
+├── ICON.png                     # Icone do beneficio
+└── dev-test.example.json        # Modelo de credenciais para testes locais
 ```
 
-## 📁 Estrutura do Projeto
+## Scripts do projeto gerado
 
-O projeto gerado inclui:
+| Comando | Descricao |
+|---------|-----------|
+| `npm run generate` | Gera handlers e testes baseados no `benefit-definition.ts` |
+| `npm run dev:start` | Sobe servidor local para testar handlers contra a API real do parceiro |
+| `npm run docs:update` | Regenera os diagramas Mermaid do README a partir do `benefit-definition.ts` atual |
+| `npm run test` | Executa os testes unitarios com Vitest |
+| `npm run start` | Abre o painel visual da maquina de estados |
+| `npm run lint` | Valida tipos TypeScript, formatacao e linting |
 
-- ⚙️ Configuração TypeScript
-- 📦 Estrutura básica para criação do módulo
-- 📚 Dependências necessárias
-- 🖼️ Simulador do Integrador para desenvolvimento local
-- 🔄 Geração automática de handlers baseado na máquina de estado
+## Testando localmente com `dev:start`
 
-## 📦 Dependências
+Copie `dev-test.example.json` para `dev-test.json`, preencha com as credenciais reais e suba o servidor:
 
-- Node.js
-- TypeScript
-- Várias bibliotecas de desenvolvimento
+```bash
+npm run dev:start
+```
 
-## 📝 Scripts Disponíveis
+Com isso voce consegue executar qualquer handler chamando `POST http://localhost:3000` com o payload da action, autenticando via o `auth.handler` definido no `benefit-definition.ts` e batendo na API real do parceiro. Veja `docs/DEV_SERVER.md` no projeto gerado para documentacao completa.
 
-- `ben init <NOME-DO-BENEFICIO>`: Cria um novo projeto benApp
-- `npm run generate`: Gera os handlers baseados na máquina de estado
-- `npm run start`: Inicia a integração localmente
+## Publicacao
 
-## 📚 Documentação
+Utilize o [maria-cli](https://github.com/benup-dev/maria) para publicar o beneficio:
 
-Para mais informações sobre o BenSDK e o Integrador, consulte a [documentação oficial](https://docs.benup.io/getting-started).
+```bash
+maria benefit deploy -r <link-ssh-do-repositorio> -n <BENEFIT-ID>
+```
 
 ---