Skip to content

Commit 107f980

Browse files
committed
feat: Ajusta nome da lib
1 parent 644287b commit 107f980

File tree

26 files changed

+184
-180
lines changed

26 files changed

+184
-180
lines changed

docs/configuracaoDeAmbiente.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuração de Ambiente
22

3-
Repositório do projeto [NFeWizard](https://github.com/nfewizard).
3+
Repositório do projeto [NFeWizard-io](https://github.com/nfewizard-org/nfewizard-io).
44

55
### DFE
66

docs/index.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Home
22

3-
Repositório do projeto [NFeWizard](https://github.com/nfewizard).
3+
Repositório do projeto [NFeWizard-io](https://github.com/nfewizard-org/nfewizard-io).
44
<div style="height: 200px; display: flex; justify-content: center; align-items: center; width: 200px;">
55
<img src="assets/logo.jpg" />
66
</div>
77

88
## Sobre
99

10-
NFeWizard é uma biblioteca Node.js projetada para simplificar a interação com os webservices da SEFAZ, proporcionando uma solução robusta para automação de processos relacionados à Nota Fiscal Eletrônica (NF-e). A biblioteca oferece métodos abrangentes para diversas operações fiscais, incluindo:
10+
NFeWizard-io é uma biblioteca Node.js projetada para simplificar a interação com os webservices da SEFAZ, proporcionando uma solução robusta para automação de processos relacionados à Nota Fiscal Eletrônica (NF-e). A biblioteca oferece métodos abrangentes para diversas operações fiscais, incluindo:
1111

1212
- **Autorização (Emissão de NFe)**: Submissão de notas fiscais eletrônicas para autorização.
1313
- **Distribuição DFe**: Consulta e Download de DF-e (Documentos fiscais eletrônicos), facilitando o acesso a documentos fiscais eletrônicos.
@@ -26,17 +26,19 @@ NFeWizard é uma biblioteca Node.js projetada para simplificar a interação com
2626

2727
<br>
2828
!!! Quote "Instalação"
29-
npm install nfewizard<br>
30-
yarn add nfewizard
29+
npm install nfewizard-io<br>
30+
yarn add nfewizard-io
3131

3232
## Exemplo de Utilização
3333

3434
```typescript
35+
import NFeWizard from 'nfewizard-io';
36+
3537
// Instanciar
36-
const nfeWizard = new NFeWizard();
38+
const nfewizard = new NFeWizard();
3739

3840
// Inicializar
39-
await nfeWizard.NFE_LoadEnvironment({
41+
await nfewizard.NFE_LoadEnvironment({
4042
config: {
4143
dfe: {
4244
baixarXMLDistribuicao: true,
@@ -90,7 +92,7 @@ const chaveNFe: DFePorChaveNFe = {
9092
},
9193
}
9294

93-
await nfeWizard.NFE_DistribuicaoDFePorChave(chaveNFe);
95+
await nfewizard.NFE_DistribuicaoDFePorChave(chaveNFe);
9496
```
9597

9698
<!-- ## Documentação
@@ -122,7 +124,7 @@ Primeiramente, obrigado por considerar contribuir para nossa biblioteca! Nosso p
122124

123125
Você pode contribuir através das seguintes plataformas:
124126

125-
- [GitHub Sponsors - Pendente](https://nfewizard-org.github.io/)
127+
- [GitHub Sponsors - Pendente](https://NFeWizard-org.github.io/)
126128
- **Pix**: Se preferir doar via Pix, utilize a seguinte chave:
127129

128130
```

docs/nfeAutorizacao.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ const autorizacao: NFe = {
175175
],
176176
};
177177

178-
await nfeWizard.NFE_Autorizacao(autorizacao);
178+
await nfewizard.NFE_Autorizacao(autorizacao);
179179
```
180180
<br>
181181

docs/nfeConsultaProtocolo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
```typescript title="NFE_ConsultaStatusServico" linenums="1"
16-
await nfeWizard.NFE_ConsultaProtocolo('99999999999999999999999999999999999999999999');
16+
await nfewizard.NFE_ConsultaProtocolo('99999999999999999999999999999999999999999999');
1717
```
1818
<br>
1919

docs/nfeDistribuicaoDfe.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const distribuicao: ConsultaNFe = {
4343
}
4444
}
4545

46-
await nfeWizard.NFE_DistribuicaoDFe(distribuicao);
46+
await nfewizard.NFE_DistribuicaoDFe(distribuicao);
4747
```
4848
<br>
4949
Também é possível utilizar o método especifico para cada tipo de distribuição:
@@ -65,7 +65,7 @@ const ultimoNSU: DFePorUltimoNSU = {
6565
},
6666
}
6767

68-
await nfeWizard.NFE_DistribuicaoDFePorUltNSU(ultimoNSU);
68+
await nfewizard.NFE_DistribuicaoDFePorUltNSU(ultimoNSU);
6969
```
7070

7171
`Retorno`:
@@ -121,7 +121,7 @@ const nsu: DFePorNSU = {
121121
},
122122
}
123123

124-
await nfeWizard.NFE_DistribuicaoDFePorNSU(nsu);
124+
await nfewizard.NFE_DistribuicaoDFePorNSU(nsu);
125125
```
126126

127127
`Retorno`:
@@ -169,7 +169,7 @@ const chave: DFePorChaveNFe = {
169169
},
170170
}
171171

172-
await nfeWizard.NFE_DistribuicaoDFePorChave(chave);
172+
await nfewizard.NFE_DistribuicaoDFePorChave(chave);
173173
```
174174

175175
`Retorno`:

docs/nfeEnviaEmail.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<br>
77

88
```typescript title="NFE_EnviaEmail" linenums="1"
9-
const nfeWizard = new NFeWizard();
9+
const nfewizard = new NFeWizard();
1010

1111
const messageExample = `
1212
<!DOCTYPE html>
@@ -105,7 +105,7 @@ const messageExample = `
105105
</html>
106106
`;
107107

108-
nfeWizard.NFE_EnviaEmail({
108+
nfewizard.NFE_EnviaEmail({
109109
messageExample,
110110
subject: 'Envio de DANFE e NF-e',
111111
attachments: [

docs/nfeGerarDanfe.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ const autorizacao: NFe | NFeDanfe = {
183183
],
184184
};
185185

186-
await nfeWizard.NFE_GerarDanfe({
186+
await nfewizard.NFE_GerarDanfe({
187187
chave: '99999999999999999999999999999999999999999999',
188188
data: {
189189
NFe: autorizacao.NFe
@@ -216,11 +216,11 @@ const autorizacao: NFeDanfe = {
216216
NFe: [...],
217217
};
218218

219-
const retorno = await nfeWizard.NFE_Autorizacao(autorizacao);
219+
const retorno = await nfewizard.NFE_Autorizacao(autorizacao);
220220

221221
// Gera DANFE da NFe transmitida
222222
const chave = retorno[0].protNFe.infProt.chNFe;
223-
await nfeWizard.NFE_GerarDanfe({
223+
await nfewizard.NFE_GerarDanfe({
224224
chave,
225225
data: retorno[0],
226226
outputPath: 'src/assets/DANFE.pdf'
@@ -259,7 +259,7 @@ const autorizacao: NFeDanfe = {
259259

260260
if (autorizacao.NFe instanceof Array) {
261261
autorizacao.NFe.forEach(async (NFe: LayoutNFe) => {
262-
await nfeWizard.NFE_GerarDanfe({
262+
await nfewizard.NFE_GerarDanfe({
263263
chave: '99999999999999999999999999999999999999999999',
264264
data: {
265265
NFe,
@@ -274,11 +274,11 @@ if (autorizacao.NFe instanceof Array) {
274274
* Exemplo com NFe já transmitida
275275
*/
276276

277-
const retorno = await nfeWizard.NFE_Autorizacao(autorizacao);
277+
const retorno = await nfewizard.NFE_Autorizacao(autorizacao);
278278

279279
retorno.forEach(async (NFe) => {
280280
const chave = NFe.protNFe.infProt.chNFe;
281-
await nfeWizard.NFE_GerarDanfe({
281+
await nfewizard.NFE_GerarDanfe({
282282
chave: chave,
283283
data: NFe,
284284
outputPath: `src/assets/DANFE-${chave}.pdf`

docs/nfeInicializarAmbiente.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Inicializar Ambiente
22

3-
Repositório do projeto [NFeWizard](https://github.com/nfewizard).
3+
Repositório do projeto [NFeWizard-io](https://github.com/nfewizard-org/nfewizard-io).
44

55
!!! Warning ""
66
`ATENÇÃO`: Após a inicialização do ambiente você será capaz de utilizar a biblioteca para se comunicar com os webservices da SEFAZ.
@@ -11,13 +11,15 @@ Para mais informações sobre opções de configuração consulte a sessão [`Co
1111
<br><br>
1212

1313
!!! Quote "Instalação"
14-
npm install nfewizard<br>
15-
yarn add nfewizard
14+
npm install nfewizard-io<br>
15+
yarn add nfewizard-io
1616

1717
```typescript title="NFE_LoadEnvironment" linenums="1"
18-
const nfeWizard = new NFeWizard();
18+
import NFeWizard from 'nfewizard-io';
1919

20-
await nfeWizard.NFE_LoadEnvironment({
20+
const nfewizard = new NFeWizard();
21+
22+
await nfewizard.NFE_LoadEnvironment({
2123
config: {
2224
dfe: {
2325
baixarXMLDistribuicao: true,

docs/nfeInutilizacao.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const inutilizacao: InutilizacaoData = {
3333
xJust: 'Teste de homologação',
3434
}
3535

36-
await nfeWizard.NFE_Inutilizacao(inutilizacao)
36+
await nfewizard.NFE_Inutilizacao(inutilizacao)
3737
```
3838
<br>
3939

docs/nfeRecepcaoEvento.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ const evento: EventoNFe = {
170170
]
171171
}
172172

173-
await nfeWizard.NFE_RecepcaoEvento(evento);
173+
await nfewizard.NFE_RecepcaoEvento(evento);
174174
```
175175
<br>
176176
Também é possível utilizar o método especifico para cada tipo de evento:
@@ -206,7 +206,7 @@ const cienciaDaOperacao: CienciaDaOperacao = {
206206
]
207207
}
208208

209-
await nfeWizard.NFE_CienciaDaOperacao(cienciaDaOperacao);
209+
await nfewizard.NFE_CienciaDaOperacao(cienciaDaOperacao);
210210
```
211211

212212
`Retorno`:
@@ -288,7 +288,7 @@ const confirmacaoDaOperacao: ConfirmacaoDaOperacao = {
288288
]
289289
}
290290

291-
await nfeWizard.NFE_ConfirmacaoDaOperacao(confirmacaoDaOperacao);
291+
await nfewizard.NFE_ConfirmacaoDaOperacao(confirmacaoDaOperacao);
292292
```
293293

294294
`Retorno`:
@@ -372,7 +372,7 @@ const cartaDeCorrecao: CartaDeCorrecao = {
372372
]
373373
}
374374

375-
await nfeWizard.NFE_CartaDeCorrecao(cartaDeCorrecao);
375+
await nfewizard.NFE_CartaDeCorrecao(cartaDeCorrecao);
376376
```
377377

378378
`Retorno`:
@@ -456,7 +456,7 @@ const cancelamento: Cancelamento = {
456456
]
457457
}
458458

459-
await nfeWizard.NFE_Cancelamento(cancelamento);
459+
await nfewizard.NFE_Cancelamento(cancelamento);
460460
```
461461

462462
`Retorno`:
@@ -538,7 +538,7 @@ const desconhecimentoDaOperacao: DesconhecimentoDaOperacao = {
538538
]
539539
}
540540

541-
await nfeWizard.NFE_DesconhecimentoDaOperacao(desconhecimentoDaOperacao);
541+
await nfewizard.NFE_DesconhecimentoDaOperacao(desconhecimentoDaOperacao);
542542
```
543543

544544
`Retorno`:
@@ -621,7 +621,7 @@ const operacaoNaoRealizada: OperacaoNaoRealizada = {
621621
]
622622
}
623623

624-
await nfeWizard.NFE_OperacaoNaoRealizada(operacaoNaoRealizada);
624+
await nfewizard.NFE_OperacaoNaoRealizada(operacaoNaoRealizada);
625625
```
626626

627627
`Retorno`:
@@ -717,7 +717,7 @@ const epec: EPEC = {
717717
]
718718
}
719719

720-
await nfeWizard.NFE_EventoPrevioDeEmissaoEmContingencia(epec);
720+
await nfewizard.NFE_EventoPrevioDeEmissaoEmContingencia(epec);
721721
```
722722
<br>
723723
`Retorno`:

docs/nfeStatusServico.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<br>
88

99
```typescript title="NFE_ConsultaStatusServico" linenums="1"
10-
await nfeWizard.NFE_ConsultaStatusServico();
10+
await nfewizard.NFE_ConsultaStatusServico();
1111
```
1212
<br>
1313

mkdocs.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: NFeWizard
1+
site_name: NFeWizard-io
22
theme:
33
name: material
44
features:
@@ -25,9 +25,9 @@ theme:
2525
extra:
2626
social:
2727
- icon: fontawesome/brands/github-alt
28-
link: https://github.com/nfewizard
28+
link: https://github.com/nfewizard-org/nfewizard-io
2929
- icon: fontawesome/solid/hand-holding-dollar
30-
link: https://github.com/sponsors/nfewizard/
30+
link: https://github.com/sponsors/NFeWizard-io/
3131
- icon: fontawesome/brands/linkedin
3232
link: https://www.linkedin.com/in/maurelima/
3333

@@ -67,4 +67,4 @@ nav:
6767
- NFeEnviaEmail: nfeEnviaEmail.md
6868

6969
copyright: |
70-
&copy; 2024 <a href="https://github.com/nfewizard" target="_blank" rel="noopener">NFeWizard</a>
70+
&copy; 2024 <a href="https://github.com/nfewizard-org/nfewizard-io" target="_blank" rel="noopener">NFeWizard-io</a>

site/404.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717

1818

19-
<title>NFeWizard</title>
19+
<title>NFeWizard-io</title>
2020

2121

2222

@@ -81,7 +81,7 @@
8181

8282
<header class="md-header md-header--shadow" data-md-component="header">
8383
<nav class="md-header__inner md-grid" aria-label="Header">
84-
<a href="/." title="NFeWizard" class="md-header__button md-logo" aria-label="NFeWizard" data-md-component="logo">
84+
<a href="/." title="NFeWizard-io" class="md-header__button md-logo" aria-label="NFeWizard-io" data-md-component="logo">
8585

8686

8787
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@@ -95,7 +95,7 @@
9595
<div class="md-header__ellipsis">
9696
<div class="md-header__topic">
9797
<span class="md-ellipsis">
98-
NFeWizard
98+
NFeWizard-io
9999
</span>
100100
</div>
101101
<div class="md-header__topic" data-md-component="header-topic">
@@ -206,13 +206,13 @@
206206

207207
<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
208208
<label class="md-nav__title" for="__drawer">
209-
<a href="/." title="NFeWizard" class="md-nav__button md-logo" aria-label="NFeWizard" data-md-component="logo">
209+
<a href="/." title="NFeWizard-io" class="md-nav__button md-logo" aria-label="NFeWizard-io" data-md-component="logo">
210210

211211

212212
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
213213

214214
</a>
215-
NFeWizard
215+
NFeWizard-io
216216
</label>
217217

218218
<ul class="md-nav__list" data-md-scrollfix>
@@ -552,7 +552,7 @@ <h1>404 - Not found</h1>
552552
<div class="md-copyright">
553553

554554
<div class="md-copyright__highlight">
555-
&copy; 2024 <a href="https://github.com/nfewizard" target="_blank" rel="noopener">NFeWizard</a>
555+
&copy; 2024 <a href="https://github.com/nfewizard-org/nfewizard-io" target="_blank" rel="noopener">NFeWizard-io</a>
556556

557557
</div>
558558

@@ -573,7 +573,7 @@ <h1>404 - Not found</h1>
573573

574574

575575

576-
<a href="https://github.com/nfewizard" target="_blank" rel="noopener" title="github.com" class="md-social__link">
576+
<a href="https://github.com/nfewizard-org/nfewizard-io" target="_blank" rel="noopener" title="github.com" class="md-social__link">
577577
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg>
578578
</a>
579579

@@ -584,7 +584,7 @@ <h1>404 - Not found</h1>
584584

585585

586586

587-
<a href="https://github.com/sponsors/nfewizard/" target="_blank" rel="noopener" title="github.com" class="md-social__link">
587+
<a href="https://github.com/sponsors/NFeWizard-io/" target="_blank" rel="noopener" title="github.com" class="md-social__link">
588588
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M312 24v10.5c6.4 1.2 12.6 2.7 18.2 4.2 12.8 3.4 20.4 16.6 17 29.4s-16.6 20.4-29.4 17c-10.9-2.9-21.1-4.9-30.2-5-7.3-.1-14.7 1.7-19.4 4.4-2.1 1.3-3.1 2.4-3.5 3-.3.5-.7 1.2-.7 2.8v.6c.2.2.9 1.2 3.3 2.6 5.8 3.5 14.4 6.2 27.4 10.1l.9.3c11.1 3.3 25.9 7.8 37.9 15.3 13.7 8.6 26.1 22.9 26.4 44.9.3 22.5-11.4 38.9-26.7 48.5-6.7 4.1-13.9 7-21.3 8.8V232c0 13.3-10.7 24-24 24s-24-10.7-24-24v-11.4c-9.5-2.3-18.2-5.3-25.6-7.8-2.1-.7-4.1-1.4-6-2-12.6-4.2-19.4-17.8-15.2-30.4s17.8-19.4 30.4-15.2c2.6.9 5 1.7 7.3 2.5 13.6 4.6 23.4 7.9 33.9 8.3 8 .3 15.1-1.6 19.2-4.1 1.9-1.2 2.8-2.2 3.2-2.9.4-.6.9-1.8.8-4.1v-.2c0-1 0-2.1-4-4.6-5.7-3.6-14.3-6.4-27.1-10.3l-1.9-.6c-10.8-3.2-25-7.5-36.4-14.4-13.5-8.1-26.5-22-26.6-44.1-.1-22.9 12.9-38.6 27.7-47.4 6.4-3.8 13.3-6.4 20.2-8.2V24c0-13.3 10.7-24 24-24s24 10.7 24 24zm256.2 312.3c13.1 17.8 9.3 42.8-8.5 55.9l-126.6 93.3c-23.4 17.2-51.6 26.5-80.7 26.5H32c-17.7 0-32-14.3-32-32v-64c0-17.7 14.3-32 32-32h36.8l44.9-36c22.7-18.2 50.9-28 80-28H352c17.7 0 32 14.3 32 32s-14.3 32-32 32h-80c-8.8 0-16 7.2-16 16s7.2 16 16 16h120.6l119.7-88.2c17.8-13.1 42.8-9.3 55.9 8.5zM193.6 384h-.9.9z"/></svg>
589589
</a>
590590

0 commit comments

Comments
 (0)