correios-brasil - npm Package Compare versions

Comparing version 2.1.2 to 2.2.0

package.json

 {
   "name": "correios-brasil",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Módulo completo consultar informações sobre o CEP, calcular o preço e os prazos das entregas das encomendas e também realizar o seu rastreio",
-  "main": "lib/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "files": [
+    "dist/**/*"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "ts-node ./lib/index.ts",
+    "test": "mocha -r ts-node/register tests/**/*.spec.ts",
+    "declarations": "tsc -emitDeclarationOnly --d",
+    "build": "rimraf dist && mkdirp dist && rollup -c",
+    "postbuild": "dts-bundle-generator -o ./dist/index.d.ts ./lib/index.ts",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test",
+    "lint": "eslint . --ext .ts"
   },
@@ -41,8 +52,40 @@ "keywords": [
   "dependencies": {
-    "cheerio": "^1.0.0-rc.5",
+    "@types/chai": "^4.2.16",
+    "@types/cheerio": "^0.22.28",
+    "@types/mocha": "^8.2.2",
+    "@types/node-fetch": "^2.5.10",
+    "cheerio": "^1.0.0-rc.6",
+    "esm": "^3.2.25",
     "iconv-lite": "^0.6.2",
     "node-fetch": "^2.6.1",
+    "rollup-plugin-typescript": "^1.0.1",
     "xml-js": "^1.6.11"
   },
-  "types": "./lib/correios-brasil.d.ts"
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^18.0.0",
+    "@rollup/plugin-node-resolve": "^11.2.1",
+    "@rollup/plugin-typescript": "8.2.1",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "chai": "^4.3.4",
+    "dts-bundle-generator": "^5.9.0",
+    "eslint": "^7.24.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.2.0",
+    "eslint-import-resolver-typescript": "^2.4.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^3.4.0",
+    "esm": "^3.2.25",
+    "mkdirp": "^1.0.4",
+    "mocha": "^8.3.2",
+    "prettier": "^2.2.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.45.2",
+    "rollup-plugin-dts": "^3.0.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "ts-node": "^9.1.1",
+    "tslib": "^2.2.0",
+    "typescript": "^4.2.4"
+  },
+  "types": "dist/index.d.js"
 }

README.md

@@ -0,96 +1,35 @@
+# Correios Brasil -- VERSÃO 2.2.0
 
-  
-
-# Correios Brasil -- VERSÃO 2.1.2
-
-  
-  
-
 <h4  align="center">
 
-  
-
-  
-
 <img  src="https://media.giphy.com/media/nbX0ijnZwU33wY6Wwo/giphy.gif"/><br>
 
-  
-
-  
-
 <b>Descomplicando os Correios!</b> 📬
 
-  
-
-  
-
 </h4>
 
-  
-
-  
-
 <p  align="center">
 
-  
-
-  
-
 <a  href="https://lucasfinoti.netlify.app">
 
-  
-
-  
-
 <img  alt="Made by Lucas Finoti"  src="https://img.shields.io/badge/made%20by-LucasFinoti-red">
 
-  
-
-  
-
 </a>
 
-  
-
-  
-
 <img  alt="License"  src="https://img.shields.io/badge/license-Apache 2.0-red">
-  
 
-  
-
 </p>
 
-  
-
-  
-
 <p  align="center">
 
-  
-
-  
-
 [![NPM](https://nodei.co/npm/correios-brasil.png?mini=true)](https://www.npmjs.com/package/correios-brasil/)
 
-  
-
-  
-
 </p>
 
-  
-  
-
 <br>
 
-  
-
 # O que é o Correios Brasil ?
 
-  
 O Correios Brasil é uma ferramenta completa para quem procura facilidade para sua aplicação, otimizando sua loja virtual e seu serviço como: consultar informações sobre o CEP, calcular o preço e os prazos das entregas das encomendas e também realizar seu rastreio tudo em um único lugar, agilizando assim os processos e demandas do dia a dia. Portanto, poupando seu tempo, por isso aproveite o pacote e não esqueça de deixar uma estrela no repositório, obrigado!
 
-  
-
 ## Medium storie explicando o pacote.
@@ -102,5 +41,6 @@
 
-</a>  
+</a>
 
 ## O que o Correios-Brasil é capaz de fazer ?
+
 - Obter informações de um CEP específico (Em dev: informações de multiplos CEPs);
@@ -110,4 +50,2 @@ - Cálcular preços e prazos para uma entrega em todos os serviços dos correios (PAC, SEDEX e etc);
 
-
-
 ## Como instalar
@@ -117,3 +55,3 @@
 npm install correios-brasil --save
- 
+
 ```
@@ -127,16 +65,12 @@
 ```typescript
-import { correiosBrasil } from "correios-brasil";
+import { correiosBrasil } from 'correios-brasil';
 ```
 
-  
-
 ## Como consultar um CEP
 
-  
+```javascript
+const { consultarCep } = require('correios-brasil');
 
-``` javascript
-const { consultarCep } = require("correios-brasil");
-
 // Cep pode ser String ou Number
-const cep = "21770200"; // 21770200 , '21770-200', '21770 200'.... qualquer um formato serve
+const cep = '21770200'; // 21770200 , '21770-200', '21770 200'.... qualquer um formato serve
 
@@ -146,3 +80,2 @@ consultarCep(cep).then((response) => {
 });
-
 ```
@@ -152,3 +85,3 @@
 
-``` javascript
+```javascript
 {
@@ -159,3 +92,3 @@ cep: '21770-200',
   bairro: 'Realengo',
-  localidade: 'Rio de Janeiro',     
+  localidade: 'Rio de Janeiro',
   uf: 'RJ',
@@ -171,17 +104,16 @@ ibge: '3304557',
 
+```javascript
+const { calcularPrecoPrazo } = require('correios-brasil');
 
-``` javascript
-const { calcularPrecoPrazo } = require("correios-brasil"); 
-
-let  args = {
+let args = {
   // Não se preocupe com a formatação dos valores de entrada do cep, qualquer uma será válida (ex: 21770-200, 21770 200, 21asa!770@###200 e etc),
-  sCepOrigem:  "81200100",
-  sCepDestino:  "21770200",
-  nVlPeso:  "1",
-  nCdFormato:  "1",
-  nVlComprimento:  "20",
-  nVlAltura:  "20",
-  nVlLargura:  "20",
-  nCdServico:  ["04014",'04510'], //Array com os códigos de serviço
-  nVlDiametro:  "0",
+  sCepOrigem: '81200100',
+  sCepDestino: '21770200',
+  nVlPeso: '1',
+  nCdFormato: '1',
+  nVlComprimento: '20',
+  nVlAltura: '20',
+  nVlLargura: '20',
+  nCdServico: ['04014', '04510'], //Array com os códigos de serviço
+  nVlDiametro: '0',
 };
@@ -194,9 +126,7 @@
 
-  
-
 ### Resposta
 
-``` javascript
-{
-  '0': {
+```javascript
+[
+  {
     Codigo: '04014',
@@ -211,10 +141,12 @@ Valor: '53,10',
     EntregaSabado: 'S',
-    obsFim: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
+    obsFim:
+      'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
     Erro: '011',
-    MsgErro: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.'
+    MsgErro:
+      'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
   },
-  '1': {
+  {
     Codigo: '04510',
     Valor: '27,80',
-    PrazoEntrega: '12',
+    PrazoEntrega: '13',
     ValorSemAdicionais: '27,80',
@@ -226,18 +158,17 @@ ValorMaoPropria: '0,00',
     EntregaSabado: 'S',
-    obsFim: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
+    obsFim:
+      'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
     Erro: '011',
-    MsgErro: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.'
-  }
-}
+    MsgErro:
+      'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
+  },
+];
 ```
- 
-  
 
 ## Como rastrear uma ou mais encomendas
-  
 
-``` javascript
-const { rastrearEncomendas } = require('correios-brasil')
+```javascript
+const { rastrearEncomendas } = require('correios-brasil');
 
-let  codRastreio = ['PW639018542BR', 'PW935793588BR'] // array de códigos de rastreios
+let codRastreio = ['PW639018542BR', 'PW935793588BR']; // array de códigos de rastreios
 
@@ -249,9 +180,7 @@ rastrearEncomendas(codRastreio).then((response) => {
 
-  
-
 ### Resposta
 
-``` javascript
-{
-  '0': [
+```javascript
+[
+  [
     {
@@ -261,3 +190,3 @@ status: 'Objeto postado',
       hora: '14:28',
-      local: 'AGF VILA PREL - Sao Paulo / SP'     
+      local: 'AGF VILA PREL - Sao Paulo / SP',
     },
@@ -268,4 +197,4 @@ {
       hora: '09:03',
-      origem: 'AGF VILA PREL - Sao Paulo / SP',   
-      destino: 'CTE CAJAMAR - Cajamar / SP'       
+      origem: 'AGF VILA PREL - Sao Paulo / SP',
+      destino: 'CTE CAJAMAR - Cajamar / SP',
     },
@@ -276,4 +205,4 @@ {
       hora: '22:18',
-      origem: 'CTE CAJAMAR - Cajamar / SP',       
-      destino: 'CTE BENFICA - Rio De Janeiro / RJ'
+      origem: 'CTE CAJAMAR - Cajamar / SP',
+      destino: 'CTE BENFICA - Rio De Janeiro / RJ',
     },
@@ -285,3 +214,3 @@ {
       origem: 'CTE BENFICA - Rio De Janeiro / RJ',
-      destino: 'CDD ITAGUAI - Itaguai / RJ'
+      destino: 'CDD ITAGUAI - Itaguai / RJ',
     },
@@ -292,3 +221,3 @@ {
       hora: '08:06',
-      local: 'CDD ITAGUAI - Itaguai / RJ'
+      local: 'CDD ITAGUAI - Itaguai / RJ',
     },
@@ -299,409 +228,134 @@ {
       hora: '11:12',
-      local: 'CDD ITAGUAI - Itaguai / RJ'
-    }
+      local: 'CDD ITAGUAI - Itaguai / RJ',
+    },
   ],
-  '1': [
-    {
-      status: 'Objeto postado após o horário limite da unidade',
-      data: '05/05/2020',
-      hora: '18:17',
-      local: 'AGF CIDADE DAS ROSAS - Sapiranga / RS'
-    },
-    {
-      status: 'Objeto encaminhado',
-      data: '05/05/2020',
-      hora: '18:29',
-      origem: 'AGF CIDADE DAS ROSAS - Sapiranga / RS',
-      destino: 'CTCE PORTO ALEGRE - Porto Alegre / RS'
-    },
-    {
-      status: 'Objeto encaminhado',
-      data: '09/05/2020',
-      hora: '03:05',
-      origem: 'CTE CAJAMAR - Cajamar / SP',
-      destino: 'CTE BENFICA - Rio De Janeiro / RJ'
-    },
-    {
-      status: 'Objeto encaminhado',
-      data: '12/05/2020',
-      hora: '13:54',
-      origem: 'CTE BENFICA - Rio De Janeiro / RJ',
-      destino: 'CDD ITAGUAI - Itaguai / RJ'
-    },
-    {
-      status: 'Objeto saiu para entrega ao destinatário',
-      data: '13/05/2020',
-      hora: '10:18',
-      local: 'CDD ITAGUAI - Itaguai / RJ'
-    },
-    {
-      status: 'Objeto entregue ao destinatário',
-      data: '13/05/2020',
-      hora: '13:22',
-      local: 'CDD ITAGUAI - Itaguai / RJ'
-    }
-  ]
-}
+    [
+      {
+        status: 'Objeto postado após o horário limite da unidade',
+        data: '05/05/2020',
+        hora: '18:17',
+        local: 'AGF CIDADE DAS ROSAS - Sapiranga / RS',
+      },
+      {
+        status: 'Objeto encaminhado',
+        data: '05/05/2020',
+        hora: '18:29',
+        origem: 'AGF CIDADE DAS ROSAS - Sapiranga / RS',
+        destino: 'CTCE PORTO ALEGRE - Porto Alegre / RS',
+      },
+      {
+        status: 'Objeto encaminhado',
+        data: '09/05/2020',
+        hora: '03:05',
+        origem: 'CTE CAJAMAR - Cajamar / SP',
+        destino: 'CTE BENFICA - Rio De Janeiro / RJ',
+      },
+      {
+        status: 'Objeto encaminhado',
+        data: '12/05/2020',
+        hora: '13:54',
+        origem: 'CTE BENFICA - Rio De Janeiro / RJ',
+        destino: 'CDD ITAGUAI - Itaguai / RJ',
+      },
+      {
+        status: 'Objeto saiu para entrega ao destinatário',
+        data: '13/05/2020',
+        hora: '10:18',
+        local: 'CDD ITAGUAI - Itaguai / RJ',
+      },
+      {
+        status: 'Objeto entregue ao destinatário',
+        data: '13/05/2020',
+        hora: '13:22',
+        local: 'CDD ITAGUAI - Itaguai / RJ',
+      },
+    ];
+]
 ```
 
-  
-
 # Argumentos para a consulta da API
 
-  
+- `codRastreio` - **Array[String]**
 
-  
-
--  ``codRastreio`` - **Array[String]**
-
-  
-
 String com o código de rastreio
 
-  
+- `nCdServico` - **Array[String]**
 
-  
-
--  ``nCdServico`` - **Array[String]**
-
-  
-
-  
-
 Código do serviço:
 
-  
-
-  
-
-  
-
 - 04014 = SEDEX à vista
 
-  
-
-  
-
-  
-
 - 04065 = SEDEX à vista pagamento na entrega
 
-  
-
-  
-
-  
-
 - 04510 = PAC à vista
 
-  
-
-  
-
-  
-
 - 04707 = PAC à vista pagamento na entrega
 
-  
-
-  
-
-  
-
 - 40169 = SEDEX12 ( à vista e a faturar)
 
-  
-
-  
-
-  
-
 - 40215 = SEDEX 10 (à vista e a faturar)
 
-  
-
-  
-
-  
-
 - 40290 = SEDEX Hoje Varejo
 
-  
+- `sCepOrigem` - **String/Number**
 
-  
-
-  
-
-  
-
--  ``sCepOrigem`` - **String/Number**
-
-  
-
-  
-
-  
-
-  
-
 CEP de Origem. Exemplo: **05311900**
 
-  
+- `sCepDestino` - **String/Number**
 
-  
-
-  
-
-  
-
--  ``sCepDestino`` - **String/Number**
-
-  
-
-  
-
-  
-
-  
-
 CEP de Destino
 
-  
+- `nVlPeso` - **String**
 
-  
-
-  
-
-  
-
--  ``nVlPeso`` - **String**
-
-  
-
-  
-
-  
-
-  
-
 Peso da encomenda, incluindo sua embalagem. O peso deve ser informado em quilogramas. Se o formato for Envelope, o valor máximo permitido será 1 kg
 
-  
+- `nCdFormato` - **Inteiro**
 
-  
-
-  
-
-  
-
--  ``nCdFormato`` - **Inteiro**
-
-  
-
-  
-
-  
-
-  
-
 Formato da encomenda (incluindo embalagem)
 
-  
-
-  
-
-  
-
 - 1 = Formato caixa/pacote
 
-  
-
-  
-
-  
-
 - 2 = Formato rolo/prisma
 
-  
-
-  
-
-  
-
 - 3 = Envelope
 
-  
+- `nVlComprimento` - **Decimal**
 
-  
-
-  
-
-  
-
--  ``nVlComprimento`` - **Decimal**
-
-  
-
-  
-
-  
-
-  
-
 Comprimento da encomenda (incluindo embalagem), em centímetros
 
-  
+- `nVlAltura` - **Decimal**
 
-  
-
-  
-
-  
-
--  ``nVlAltura`` - **Decimal**
-
-  
-
-  
-
-  
-
-  
-
 Altura da encomenda (incluindo embalagem), em centímetros. Se o formato for envelope, informar zero (0)
 
-  
+- `nVlLargura` - **Decimal**
 
-  
-
-  
-
-  
-
--  ``nVlLargura`` - **Decimal**
-
-  
-
-  
-
-  
-
-  
-
 Largura da encomenda (incluindo embalagem), em centímetros
 
-  
+- `nVlDiametro` - **Decimal**
 
-  
-
-  
-
-  
-
--  ``nVlDiametro`` - **Decimal**
-
-  
-
-  
-
-  
-
-  
-
 Diâmetro da encomenda (incluindo embalagem), em centímetros
 
-  
+- `sCdMaoPropria` - **String**
 
-  
-
-  
-
-  
-
--  ``sCdMaoPropria`` - **String**
-
-  
-
-  
-
-  
-
 Indica se a encomenda será entregue com o serviço adicional mão própria
 
-  
-
-  
-
-  
-
 - S = sim
 
-  
-
-  
-
-  
-
 - N = não **PADRÃO**
 
-  
+- `nVlValorDeclarado` - **Decimal**
 
-  
-
-  
-
-  
-
--  ``nVlValorDeclarado`` - **Decimal**
-
-  
-
-  
-
-  
-
 Indica se a encomenda será entregue com o serviço adicional valor declarado. Neste campo deve ser apresentado o valor declarado desejado, em Reais
 
-  
+- `sCdAvisoRecebimento` - **String**
 
-  
-
-  
-
-  
-
--  ``sCdAvisoRecebimento`` - **String**
-
-  
-
-  
-
-  
-
 Indica se a encomenda será entregue com o serviço adicional mão própria
 
-  
-
-  
-
-  
-
 - S = sim
 
-  
-
-  
-
-  
-
 - N = não **PADRÃO**
 
-  
 
-
-
 ### O que está em desenvolvimento ?
 
-  
-
 - Receber respostas de multiplas API's e retornar a primeira resposta 🟡.
@@ -711,4 +365,2 @@
 
-  
-
 ### :recycle: Como contribuir
@@ -721,32 +373,26 @@
 
-  
-
-  
-
 ### :memo: Licença
-  
 
 Apache License 2.0
-  
 
-  
+Copyright (c) 2020 Lucas Finoti
 
-  
+[See more about the license][license]
 
-Copyright (c) 2020 Lucas Finoti
+[license]: https://github.com/FinotiLucas/Correios-Brasil/blob/master/LICENSE
 
-  
 
-  
 
-  
 
-[See more about the license][LICENSE]
 
-  
+## 💪 Contribuidores
 
-  
+| [<img src="https://avatars0.githubusercontent.com/u/42827195?v=3&s=115" width="115"><br><sub>@jonabf1</sub>](https://github.com/jonabf1) | [<img src="https://avatars0.githubusercontent.com/u/18602545?v=3&s=115" width="115"><br><sub>@francopan</sub>](https://github.com/francopan) |
+|--|--|
 
-  
 
-[LICENSE]: <https://github.com/FinotiLucas/Correios-Brasil/blob/master/LICENSE>
+
+## 🚀 Autor
+
+| [<img src="https://avatars0.githubusercontent.com/u/42899930?v=3&s=115"><br><sub>@finotilucas</sub>](https://github.com/finotilucas) |
+|--|

New 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

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54964

increased by58.71%

Worsened metrics

Dependency count

10

increased by150%

Dev dependency count

24

increased byInfinity%

Number of package files

6

decreased by-64.71%

Lines of code

182

decreased by-46.31%

Number of lines in readme file

379

decreased by-48.29%

Number of medium supply chain risk alerts

5

increased by400%

Dependency changes

• + Added@types/chai@^4.2.16

• + Added@types/cheerio@^0.22.28

• + Added@types/mocha@^8.2.2

• + Added@types/node-fetch@^2.5.10

• + Addedesm@^3.2.25

• + Addedrollup-plugin-typescript@^1.0.1

• + Added@types/chai@4.3.16(transitive)

• + Added@types/cheerio@0.22.35(transitive)

• + Added@types/mocha@8.2.3(transitive)

• + Added@types/node@20.14.2(transitive)

• + Added@types/node-fetch@2.6.11(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedesm@3.2.25(transitive)

• + Addedestree-walker@0.6.1(transitive)

• + Addedform-data@4.0.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedis-core-module@2.13.1(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedrollup-plugin-typescript@1.0.1(transitive)

• + Addedrollup-pluginutils@2.8.2(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedtslib@2.6.3(transitive)

• + Addedtypescript@5.4.5(transitive)

• + Addedundici-types@5.26.5(transitive)

• Updatedcheerio@^1.0.0-rc.6