brisa-sdk 0.0.0-stage → 0.2.0
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.
- package/CHANGELOG.md +24 -0
- package/LICENSE +21 -0
- package/README.md +90 -2
- package/dist/index.cjs +621 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +928 -0
- package/dist/index.d.ts +928 -0
- package/dist/index.js +590 -0
- package/dist/index.js.map +1 -0
- package/docs/01-primeiros-passos.md +106 -0
- package/docs/02-autenticacao.md +55 -0
- package/docs/03-documentos.md +80 -0
- package/docs/04-pagamentos.md +69 -0
- package/docs/05-impressao.md +44 -0
- package/docs/06-dados-bancarios.md +42 -0
- package/docs/07-clientes-e-extrato.md +61 -0
- package/docs/08-artigos-e-stock.md +38 -0
- package/docs/09-saft.md +23 -0
- package/docs/10-webhooks.md +42 -0
- package/docs/11-erros.md +52 -0
- package/docs/12-idempotencia-e-limites.md +29 -0
- package/docs/13-sandbox-e-producao.md +25 -0
- package/docs/README.md +35 -0
- package/docs/openapi.json +16772 -0
- package/docs/upgrade.md +23 -0
- package/package.json +67 -4
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Todas as alterações relevantes deste pacote. Segue [Semantic Versioning](https://semver.org/lang/pt-BR/).
|
|
4
|
+
|
|
5
|
+
## [0.2.0] - 2026-11-15
|
|
6
|
+
|
|
7
|
+
- PDF: formatos `a5` (o A4 reduzido a meia folha), `thermal80` (rolo de 80 mm, igual a `thermal`) e `thermal58` (rolo de 58 mm).
|
|
8
|
+
- Venda direta paga com vários meios: `payment.payments` (até 6 meios; o troco sai do numerário); o detalhe do documento traz `paymentMethod` (`mixed`), `payments` e `amountReceived`.
|
|
9
|
+
- Dados bancários: `brisa.bank()` e `brisa.setBank()`; `bankDetails` e `printBankDetails` ao emitir `FT` e `PF`; o detalhe traz `bankDetails`.
|
|
10
|
+
- Clientes: `list` com `sort`, `desc` e `totals` (e `invoiced`, `amountDue`, `lastInvoiceDate`, `documents` em cada cliente); `statement`, `statementPdf` e `statementCsv` (a conta corrente).
|
|
11
|
+
- Requer a API de 15 de novembro de 2026 ou posterior; contra uma API anterior, os pedidos antigos continuam a funcionar.
|
|
12
|
+
|
|
13
|
+
## [0.1.0] - 2026-11-12
|
|
14
|
+
|
|
15
|
+
Primeira versão.
|
|
16
|
+
|
|
17
|
+
- Cliente `Brisa` com chave de API (`Authorization: Bearer brk_...`), sem dependências em tempo de execução; ESM e CommonJS, Node.js 18+.
|
|
18
|
+
- Documentos: emitir (`FT`, `FR`, `TV`, `PF`), listar (com paginação automática), consultar, PDF, exportar (JSON/XML), pagar, recibo global, anular, retificar, nota de crédito, créditos, histórico, vencimento, envio por e-mail.
|
|
19
|
+
- Clientes (criar, atualizar, consultar, listar, ativar/desativar), produtos e stock, impostos, motivos de isenção, categorias, SAF-T (pedir, esperar, descarregar), `me()` e `company()`.
|
|
20
|
+
- `Idempotency-Key` gerado automaticamente nas criações e repetido nas repetições.
|
|
21
|
+
- Repetições com espera crescente em `429`, `502`, `503` e falhas de rede, respeitando `Retry-After`; tempo máximo por pedido.
|
|
22
|
+
- Erros RFC 9457 como classes (`BrisaRuleError`, `BrisaRateLimitError`...), com `status`, `type`, `field` e `errors`.
|
|
23
|
+
- `verifyWebhook` (assinatura `Brisa-Signature`, dois segredos durante a troca, tolerância de tempo) e `signWebhookPayload`.
|
|
24
|
+
- Testes unitários com `fetch` simulado e testes de integração contra a sandbox.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Codespace
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,91 @@
|
|
|
1
|
-
#
|
|
1
|
+
# brisa-sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/brisa-sdk)
|
|
4
|
+
[](https://github.com/codespace-ao/brisa-sdk-js/actions/workflows/ci.yml)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
SDK oficial da [API Brisa](https://brisa.ao/developers) para JavaScript e TypeScript: faturação certificada pela AGT (Angola), clientes, artigos, SAF-T e webhooks.
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { Brisa } from 'brisa-sdk'
|
|
11
|
+
|
|
12
|
+
const brisa = new Brisa() // lê BRISA_API_KEY
|
|
13
|
+
|
|
14
|
+
const fatura = await brisa.documents.issue({
|
|
15
|
+
type: 'FR',
|
|
16
|
+
lines: [{ description: 'Parafuso M8', quantity: 4, unitPrice: 100 }],
|
|
17
|
+
payment: { method: 'cash', amountReceived: 500 },
|
|
18
|
+
})
|
|
19
|
+
const pdf = await brisa.documents.pdf(fatura.id, { format: 'a5' })
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
* **Sem dependências** em tempo de execução; ESM e CommonJS; tipos TypeScript incluídos.
|
|
23
|
+
* **Node.js 18+**, e também Deno, Bun e *edge runtimes* com `fetch`.
|
|
24
|
+
* **Seguro de repetir:** repete sozinho os pedidos em `429`, `502` e `503` e gera a chave de idempotência, por isso uma falha de rede nunca emite um documento duas vezes.
|
|
25
|
+
* **Erros que se programam:** classes por estado ([RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)), paginação automática e verificação da assinatura dos webhooks.
|
|
26
|
+
|
|
27
|
+
> **Atenção:** a chave de API é um segredo da empresa. Use o SDK no **servidor**; nunca a ponha numa aplicação web, móvel ou num repositório.
|
|
28
|
+
|
|
29
|
+
## Instalação
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm install brisa-sdk
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
(Ou `pnpm add`, `yarn add`, `bun add`.) Com CommonJS: `const { Brisa } = require('brisa-sdk')`.
|
|
36
|
+
|
|
37
|
+
## Início rápido
|
|
38
|
+
|
|
39
|
+
1. Na aplicação Brisa crie a **sandbox** e uma **chave de API** (`brk_sbx_...`).
|
|
40
|
+
2. `export BRISA_API_KEY="brk_sbx_a_sua_chave"`
|
|
41
|
+
3. Corra o exemplo acima. Quando funcionar, troque a chave pela da empresa real (`brk_...`): **é a chave que escolhe o ambiente**, o endereço é o mesmo.
|
|
42
|
+
|
|
43
|
+
## Documentação
|
|
44
|
+
|
|
45
|
+
O guia completo está em [`docs/`](docs/README.md), com exemplos em cURL, JavaScript e PHP:
|
|
46
|
+
|
|
47
|
+
| | |
|
|
48
|
+
|---|---|
|
|
49
|
+
| [Primeiros passos](docs/01-primeiros-passos.md) | a primeira fatura em 5 minutos |
|
|
50
|
+
| [Autenticação](docs/02-autenticacao.md) | chaves, permissões e ambientes |
|
|
51
|
+
| [Documentos](docs/03-documentos.md) | emitir, consultar, anular, creditar |
|
|
52
|
+
| [Pagamentos](docs/04-pagamentos.md) | no ato, depois, com vários meios |
|
|
53
|
+
| [Impressão](docs/05-impressao.md) | A4, A5 e rolos de 80 e 58 mm |
|
|
54
|
+
| [Dados bancários](docs/06-dados-bancarios.md) | como pagar, impresso nas faturas |
|
|
55
|
+
| [Clientes e extrato](docs/07-clientes-e-extrato.md) | totais, ordenar e imprimir o extrato |
|
|
56
|
+
| [Artigos e stock](docs/08-artigos-e-stock.md) | catálogo e movimentos |
|
|
57
|
+
| [SAF-T](docs/09-saft.md) | exportar para a AGT |
|
|
58
|
+
| [Webhooks](docs/10-webhooks.md) | ser avisado, com assinatura |
|
|
59
|
+
| [Erros](docs/11-erros.md) · [Idempotência e limites](docs/12-idempotencia-e-limites.md) | tratar falhas |
|
|
60
|
+
| [Sandbox e produção](docs/13-sandbox-e-producao.md) | ir para produção |
|
|
61
|
+
| [Guia de atualização](docs/upgrade.md) | de uma versão para outra |
|
|
62
|
+
|
|
63
|
+
A referência de todos os endpoints está em [`docs/openapi.json`](docs/openapi.json).
|
|
64
|
+
|
|
65
|
+
## Configuração
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
const brisa = new Brisa({
|
|
69
|
+
apiKey: process.env.BRISA_API_KEY, // ou a variável BRISA_API_KEY
|
|
70
|
+
baseUrl: 'https://api.brisa.ao', // por omissão (ou BRISA_API_URL)
|
|
71
|
+
timeoutMs: 30_000, // por tentativa
|
|
72
|
+
maxRetries: 2, // repetições em 429/502/503 e falhas de rede
|
|
73
|
+
maxRetryDelayMs: 60_000, // um Retry-After maior do que isto não se espera
|
|
74
|
+
fetch: globalThis.fetch, // outra implementação (proxy, testes)
|
|
75
|
+
headers: { 'X-Correlation-Id': 'abc' },
|
|
76
|
+
})
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Cada método aceita, no fim, `{ idempotencyKey, signal, timeoutMs, maxRetries, headers }`. Qualquer outro endpoint: `brisa.request({ method, path, body })`.
|
|
80
|
+
|
|
81
|
+
## Contribuir
|
|
82
|
+
|
|
83
|
+
Contribuições são bem-vindas: correções, testes, documentação e ideias. Leia o [guia de contribuição](CONTRIBUTING.md) e o [código de conduta](CODE_OF_CONDUCT.md). Para falhas de segurança, **não abra uma issue**: siga a [política de segurança](SECURITY.md).
|
|
84
|
+
|
|
85
|
+
## Suporte
|
|
86
|
+
|
|
87
|
+
Dúvidas sobre a API: geral@codespace.ao. Falhas ou pedidos para este SDK: [issues](https://github.com/codespace-ao/brisa-sdk-js/issues).
|
|
88
|
+
|
|
89
|
+
## Licença
|
|
90
|
+
|
|
91
|
+
[MIT](LICENSE) © Codespace One Services, Ltd®
|