@benup/bensdk 1.12.0 → 1.12.2

package/README.md

@@ -1,8 +1,8 @@
 # BenSDK 🚀
 
 <div align="center">
-  <img src="https://img.shields.io/badge/Status-Beta-yellow" alt="Status: Beta">
-  <img src="https://img.shields.io/badge/Version-1.0.0-blue" alt="Version: 1.0.0">
+  <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">
 </div>
 
 <br>
@@ -24,35 +24,54 @@ O BenSDK é um framework para a criação de integrações entre benefícios e o
 - 📦 Suporte a TypeScript
 - 🎯 Interface de linha de comando
 
-## 🛠️ Instalação Local
-
-Como o projeto ainda está em fase de testes internos, você precisará clonar o repositório:
+## 🛠️ Instalação
 
+Instale o BenSDK CLI globalmente via npm:
 ```bash
-git clone <url-do-repositorio>
-cd bensdk-cli
-npm install
+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
 ```
 
 ## 🚀 Uso
 
 Para criar um novo projeto benApp:
-
 ```bash
-npm start init <NOME-DO-BENEFICIO>
+ben init <NOME-DO-BENEFICIO>
 ```
 
 Após criar o projeto:
 
 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
+```bash
    npm run generate
-   ```
+```
 3. Para rodar a integração localmente:
-   ```bash
+```bash
    npm run start
-   ```
+```
+
+## 📦 Publicação
+
+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>
+```
 
 ## 📁 Estrutura do Projeto
 
@@ -72,7 +91,7 @@ O projeto gerado inclui:
 
 ## 📝 Scripts Disponíveis
 
-- `npm start init <NOME-DO-BENEFICIO>`: Cria um novo projeto benApp
+- `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
 

package/bin/lib/types/lib/issues-helper.lib.type.d.ts

@@ -3,6 +3,7 @@ export type SendIssueParameters = {
     title: string;
     description: string;
     fieldPath?: string;
+    type?: 'BENEFIT' | 'RECHARGE';
 };
 export interface IssuesHelper {
     sendIssue: (sendIssueParameters: SendIssueParameters) => Promise<AxiosResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@benup/bensdk",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "main": "index.js",
   "type": "module",
   "scripts": {