nfe2stalk - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

lib/utils/iti.js

@@ -29,3 +29,3 @@ const cheerio = require('cheerio')
     numero: url.substring(29, 33),
-    titulo: $('.tileItem').eq(0).find('.description').eq(0).text().trim(),
+    titulo: $('.tileItem').eq(0).find('.tileHeadline').eq(0).text().trim(),
     url: `http://www.iti.gov.br/noticias/indice-de-noticias${url}`
@@ -32,0 +32,0 @@ }

package.json

@@ -13,3 +13,3 @@ {
     ],
-    "version": "2.0.0",
+    "version": "2.0.1",
     "author": {
@@ -16,0 +16,0 @@ "name": "Igor Souza Martins",

README.md

@@ -27,5 +27,12 @@
 
+## Sites
+ - <a href="http://www.iti.gov.br">ITI</a>
+ - <a href="http://www.nfe.fazenda.gov.br">SEFAZ</a> 
+
 ## Como usar
 
-Precisamos configurar apenas o tempo que a lib vai consultar a Sefaz e se queremos receber uma mensagem mesmo quando não tiver nenhuma informação nova.
+Atualmente existem dois monitoradores, escolha um e configure o **tempo**, **tipoTempo** e **notificacaoCompleta**.
+- `tempo` (tempo entre as consultas, ex: 1, 10, 50. max: 59)
+- `tipoTempo` (segundos **s** ou minutos **m**)
+- `notificacaoCompleta` (retorna um alerta mesmo que não tenha um novo)
 
@@ -36,25 +43,69 @@ ```js
 let options = {
-  every: '10',
-  fullNotify: true
+  tempo: '10',
+  tipoTempo: 's',
+  notificacaoCompleta: true
 }
 
-nfe2stalk.monitor.iniciar(options)
+nfe2stalk.monitor.iti.iniciar(options)
+nfe2stalk.monitor.sefaz.iniciar(options)
 
-nfe2stalk.monitor.monitorar.on('alerta', (alerta) => {
-  console.log('Notificação da sefaz:')
-  console.log(alerta)
+nfe2stalk.monitor.iti.monitorar.on('alerta', (iti) => {
+  console.log('iti')
+  console.log(iti)
   console.log('------------------------------------')
 })
+
+nfe2stalk.monitor.sefaz.monitorar.on('alerta', (sefaz) => {
+  console.log('sefaz')
+  console.log(sefaz)
+  console.log('------------------------------------')
+})
 ```
 
+## nfe2stalk.monitor.SITE
+Aqui vamos informar qual site o monitorador fará suas consultas
+- `nfe2stalk.monitor.iti`
+- `nfe2stalk.monitor.sefaz`
+
+## nfe2stalk.monitor.SITE.FUNCTIONS
+Aqui serão listadas todas as funções disponíveis para cada site, hoje está padronizado para ambos os sites possuírem as mesmas funções.
+- `iniciar`
+- `monitorar`
+- `limparAlertas`
+
+## iniciar(options)
+Inicia o processo das consultas, é necessário informar um objeto seguindo esse modelo:
+```json
+{
+  "tempo": "10",
+  "tipoTempo": "s",
+  "notificacaoCompleta": true
+}
+```
+
+## monitorar
+Objeto do tipo [Events](https://nodejs.org/api/events.html), a partir dele vamos receber as notificações que o monitorador encontrar
+```javascript
+nfe2stalk.monitor.sefaz.monitorar.on('alerta', (sefaz) => {
+  console.log(sefaz)
+})
+```
 Resultado
+```json
+{
+    "numero": "490",
+    "titulo": "22/12/2017 - ATENÇÃO: Comunicamos que a aplicação das validações previstas na NT 2017.001 (GTIN) ocorrerá dentro de janeiro/2017",
+    "url": "http://www.nfe.fazenda.gov.br/portal/informe.aspx?ehCTG=false#490"
+}
 ```
-Notificação da sefaz:
-{ numero: '490',
-  titulo: '22/12/2017 - ATENÇÃO: Comunicamos que a aplicação das validações previstas na NT 2017.001 (GTIN) ocorrerá dentro de janeiro/2017',
-  url: 'http://www.nfe.fazenda.gov.br/portal/informe.aspx?ehCTG=false#490' }
-------------------------------------
-Notificação da sefaz:
-false
-------------------------------------
+
+## limparAlertas()
+Apaga a informação salva, desse modo quando você iniciar o monitorador, ele vai te notificar sobre a ultima noticia do site, independente se você já viu ela.
+```javascript
+nfe2stalk.monitor.sefaz.limparAlertas().then((qtAlertas) => {
+  console.log(`${qtAlertas} removidos`)
+})
+.catch((err) => {
+  console.log(err)
+})
 ```

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26454

increased by6.28%

Number of lines in readme file

110

increased by86.44%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes