@firestormapps/utils - npm Package Compare versions

Comparing version 1.0.0 to 1.3.0

dist/index.d.ts

@@ -1,1 +0,9 @@
-export * from "./testing";
+export * from './boleto';
+export * from './capitalize';
+export * from './cep';
+export * from './cnpj';
+export * from './cpf';
+export * from './creditCard';
+export * from './email';
+export * from './getNameInitials';
+export * from './phone';

dist/index.js

@@ -13,3 +13,11 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./testing"), exports);
+__exportStar(require("./boleto"), exports);
+__exportStar(require("./capitalize"), exports);
+__exportStar(require("./cep"), exports);
+__exportStar(require("./cnpj"), exports);
+__exportStar(require("./cpf"), exports);
+__exportStar(require("./creditCard"), exports);
+__exportStar(require("./email"), exports);
+__exportStar(require("./getNameInitials"), exports);
+__exportStar(require("./phone"), exports);
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@firestormapps/utils",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "Utilities belt written in TypeScript",
@@ -26,4 +26,6 @@ "main": "dist/index.js",
   "dependencies": {
+    "@brazilian-utils/brazilian-utils": "^1.0.0-rc.12",
+    "card-validator": "6.1.0",
     "typescript": "^4.3.2"
   }
 }

README.md

@@ -1,2 +0,415 @@
-# firestormapps-utils
-Utilities belt written in TypeScript
+# Firestorm Apps - Utils
+
+Cinto de utilidades da Firestorm Apps escrito em TypeScript
+
+____
+
+**NOTA**:
+
+Essa biblioteca expoe algumas funções diretamente do projeto [brazilian-utils](https://brazilian-utils.com.br/#/) (versão atual `^1.0.0-rc.12`). 
+
+As seguintes funções do `brazilian-utils` são expostas:
+
+- isValidBoleto
+- formatBoleto
+- isValidCEP
+- formatCEP
+- isValidCNPJ
+- formatCNPJ
+- isValidCPF
+- formatCPF
+- isValidPIS
+- isValidEmail
+
+
+____
+
+## Menu
+
+- [Firestorm Apps - Utils](#firestorm-apps---utils)
+  - [Instalação](#instalação)
+  - [Boleto](#boleto)
+    - [isValidBoleto](#isvalidboleto)
+    - [formatBoleto](#formatboleto)
+  - [Strings](#strings)
+    - [capitalize](#capitalize)
+    - [getNameInitials](#getnameinitials)
+  - [CEP](#cep)
+    - [isValidCEP](#isvalidcep)
+    - [formatCEP](#formatcep)
+  - [CNPJ](#cnpj)
+    - [isValidCNPJ](#isvalidcnpj)
+    - [formatCNPJ](#formatcnpj)
+    - [validateCNPJ](#validatecnpj)
+    - [maskCNPJ](#maskcnpj)
+    - [unmaskCNPJ](#unmaskcnpj)
+  - [CPF](#cpf)
+    - [isValidCPF](#isvalidcpf)
+    - [formatCPF](#formatcpf)
+    - [maskCPF](#maskcpf)
+    - [unmaskCPF](#unmaskcpf)
+    - [validateCPF](#validatecpf)
+  - [Cartão de Crédito](#cartão-de-crédito)
+    - [validateCreditCardNumber](#validatecreditcardnumber)
+    - [validateCreditCardExpiration](#validatecreditcardexpiration)
+    - [getCardBrand](#getcardbrand)
+    - [getCreditCardInfo](#getcreditcardinfo)
+  - [E-mail](#e-mail)
+    - [isValidEmail](#isvalidemail)
+  - [Telefone](#telefone)
+    - [validatePhone](#validatephone)
+    - [maskPhone](#maskphone)
+    - [unmaskPhone](#unmaskphone)
+  - [PIS](#pis)
+    - [isValidPIS](#isvalidpis)
+
+
+## Instalação
+
+
+```
+npm i @firestormapps/utils
+```
+
+ou
+
+```
+yarn add @firestormapps/utils
+```
+
+____
+
+## Helpers
+
+### Boleto
+
+#### isValidBoleto
+
+Retorna um `boolean` se o número de boleto informado é válido ou não.
+
+```javascript
+
+import { isValidBoleto } from '@firestormapps/utils';
+
+isValidBoleto('00190000090114971860168524522114675860000102656'); // true
+
+```
+
+#### formatBoleto
+
+Adiciona a máscara com pontuação ao número de boleto informado.
+
+```javascript
+
+import { formatBoleto } from '@firestormapps/utils';
+
+formatBoleto('00190000090114971860168524522114675860000102656');
+
+```
+
+### Strings
+#### capitalize
+
+Torna maiúscula apenas a primeira letra de cada palavra da frase informada.
+
+
+```javascript
+import { capitalize } from '@firestormapps/utils';
+
+capitalize("Apenas pra gente TESTAR"); // Apenas Pra Gente Testar
+
+```
+
+### getNameInitials
+
+Retorna uma `string` com as letras iniciais do nome informado
+
+```javascript
+import { getNameInitials } from '@firestormapps/utils';
+
+getNameInitials('Bora testar'); // BT
+
+```
+
+
+____
+
+### CEP
+
+#### isValidCEP
+
+Retorna um `boolean` se o CEP informado é válido ou não.
+
+```javascript
+import { isValidCEP } from '@firestormapps/utils';
+
+isValidCEP('92500000'); // true
+
+```
+
+#### formatCEP
+
+Adicionar máscara ao número de CEP informado.
+
+```javascript
+import { formatCEP } from '@firestormapps/utils';
+
+formatCEP('92500000'); // 92500-000
+
+```
+
+### CNPJ
+
+#### isValidCNPJ
+
+Retorna um `boolean` se o CNPJ informado é válido ou não.
+
+```javascript
+import { isValidCNPJ } from '@firestormapps/utils';
+
+isValidCNPJ('15515147234255'); // true/false
+
+```
+
+#### formatCNPJ
+
+Adicionar máscara ao número de CNPJ informado.
+
+```javascript
+import { formatCNPJ } from '@firestormapps/utils';
+
+formatCNPJ('245222000174'); // 24.522.200/0174
+
+```
+### validateCNPJ
+
+Retorna um `boolean` se o CNPJ informado é válido ou não.
+
+```javascript
+import { validateCNPJ } from '@firestormapps/utils';
+
+validateCNPJ('17702663000150'); // true/false
+
+```
+
+### maskCNPJ
+
+Adicionar máscara ao número de CNPJ informado.
+
+
+```javascript
+import { maskCNPJ } from '@firestormapps/utils';
+
+maskCNPJ('17702663000150'); // 17.702.663/0001-50
+
+```
+
+### unmaskCNPJ
+
+Remove a máscara do número de CNPJ informado, retornando apenas os números.
+
+
+```javascript
+import { unmaskCNPJ } from '@firestormapps/utils';
+
+unmaskCNPJ('17.702.663/0001-50'); // 17702663000150
+
+```
+
+### CPF
+
+#### isValidCPF
+
+Retorna um `boolean` se o CPF informado é válido ou não.
+
+```javascript
+import { isValidCPF } from '@firestormapps/utils';
+
+isValidCPF('155151475'); // true/false
+
+```
+
+#### formatCPF
+
+Adicionar máscara ao número de CPF informado.
+
+```javascript
+import { formatCPF } from '@firestormapps/utils';
+
+formatCPF('746506880'); // 746.506.880
+
+```
+
+#### maskCPF
+
+Adicionar máscara ao número de CPF informado.
+
+
+```javascript
+import { maskCPF } from '@firestormapps/utils';
+
+maskCPF('28832326280'); // 288.323.262-80
+
+```
+
+#### unmaskCPF
+
+Remove a máscara do número de CPF informado, retornando apenas os números.
+
+
+```javascript
+import { unmaskCPF } from '@firestormapps/utils';
+
+unmaskCPF('288.323.262-80'); // 28832326280
+
+```
+
+#### validateCPF
+
+Retorna um `boolean` se o CPF informado é válido ou não.
+
+```javascript
+import { validateCPF } from '@firestormapps/utils';
+
+validateCPF('03455455787'); // true/false
+
+```
+
+### Cartão de Crédito
+
+#### validateCreditCardNumber
+
+Retorna um `boolean` se o número de cartão de crédito informado é válido ou não.
+
+```javascript
+import { validateCreditCardNumber } from '@firestormapps/utils';
+
+validateCreditCardNumber('5598928852411791'); // true/false
+
+```
+
+#### validateCreditCardExpiration
+
+Retorna um `boolean` se a data de expiração do cartão de crédito informado é válido ou não.
+
+```javascript
+import { validateCreditCardExpiration } from '@firestormapps/utils';
+
+validateCreditCardExpiration('12/22'); // true/false
+
+```
+
+#### getCardBrand
+
+Retorna uma `string` com a bandeira do cartão através do número informado (`cardNumber`). Os possíveis retornos são:
+
+- `Elo`,
+- `HiperCard`,
+- `Visa`,
+- `MasterCard`,
+- `JCB`,
+- `Diners Club`,
+- `Discover`,
+- `American Express`.
+
+```javascript
+import { getCardBrand } from '@firestormapps/utils';
+
+getCardBrand('5284929298198314'); 
+
+/*
+retorna: "MasterCard"
+*/
+
+```
+
+#### getCreditCardInfo
+
+Retorna um `object` com informações sobre o número de cartão de crédito informado.
+
+```javascript
+import { getCreditCardInfo } from '@firestormapps/utils';
+
+getCreditCardInfo('5485775006283622'); 
+
+/*
+retorna:
+
+{
+    card: {
+      niceType: 'Mastercard',
+      type: 'mastercard',
+      patterns: [[51, 55], [2221, 2229], [223, 229], [23, 26], [270, 271], 2720],
+      gaps: [4, 8, 12],
+      lengths: [16],
+      code: { name: 'CVC', size: 3 },
+      matchStrength: 2,
+    },
+    isPotentiallyValid: false,
+    isValid: false,
+  };
+*/
+
+```
+
+### E-mail
+
+### isValidEmail
+
+Retorna um `boolean` se o CPF informado é válido ou não.
+
+```javascript
+import { isValidEmail } from '@firestormapps/utils';
+
+isValidEmail('[e-mail]'); // true
+```
+
+### Telefone
+
+#### validatePhone
+
+Retorna um `boolean` se o número de telefone informado é válido ou não.
+
+```javascript
+import { validatePhone } from '@firestormapps/utils';
+
+validatePhone('(11) 99989-8887'); // true/false
+
+```
+
+#### maskPhone
+
+Adicionar máscara ao número de telefone informado.
+
+
+```javascript
+import { maskPhone } from '@firestormapps/utils';
+
+maskPhone('11999898887'); // (11) 99989-8887
+
+```
+
+#### unmaskPhone
+
+Remove a máscara do número de telefone informado, retornando apenas os números.
+
+
+```javascript
+import { unmaskPhone } from '@firestormapps/utils';
+
+unmaskPhone('(11) 99989-8887'); // 11999898887
+
+```
+
+### PIS
+
+#### isValidPIS
+
+Retorna um `boolean` se o CPF informado é válido ou não.
+
+```javascript
+import { isValidPIS } from '@firestormapps/utils';
+
+isValidPIS('12056412547'); // true/false
+
+```

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

Improved metrics

Total package byte prevSize

70292

increased by84.49%

Number of package files

39

increased by333.33%

Lines of code

337

increased by1062.07%

Number of lines in readme file

416

increased by13766.67%

Worsened metrics

Dependency count

3

increased by200%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@brazilian-utils/brazilian-utils@^1.0.0-rc.12

• + Addedcard-validator@6.1.0

• + Added@brazilian-utils/brazilian-utils@1.0.0-rc.12(transitive)

• + Addedcard-validator@6.1.0(transitive)

• + Addedcredit-card-type@8.3.0(transitive)