pix-utils-js 1.0.5 → 1.0.7

package/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn
+    - run: yarn test

package/README.md

@@ -25,21 +25,22 @@ Instale pix-utils-js com npm ou yarn
 #### Identifique uma chave pix
 
 ```js
-  const { identify } = 'pix-utils-js'
+  import { identify } from 'pix-utils-js'
   const { pix, type } = identify({pix: 'test@gmail.com'}) // {pix: 'test@gmail.com', type: 'email'}
 ```
 
 | Função   | Parametro       | Retorno                           |
 | :---------- | :--------- | :---------------------------------- |
-| `identify` | `input: {pix: string}` | Pix `{ pix: string, type: 'email' \|  'cpf' \| 'cnpj' \|  'random' \|'phone' }` |
+| `identify` | `input: {pix: string}` | Pix `{ pix: string, type: 'email' \|  'cpf' \| 'cnpj' \|  'random' \|'phone' \| 'qrcode' }` |
 
 #### Validar uma chave pix
 
 ```js
-  const { validate } = 'pix-utils-js'
+  import { validate } from 'pix-utils-js'
   console.log(validate({pix: 'test@gmail.com'})) // true
   console.log(validate({pix: 'test'})) // false
   console.log(validate({pix: 'test@gmail.com', type : 'cpf'})) // false
+  console.log(validate({pix: '00020126360014BR.GOV...', type : 'qrcode'})) // true
   ```
 
 | Função   | Parametro       | Retorno                           |
@@ -49,15 +50,16 @@ Instale pix-utils-js com npm ou yarn
 #### Normalizar uma chave pix
 
 ```js
-  const { normalize } = 'pix-utils-js'
+  import { normalize } from 'pix-utils-js'
   console.log(normalize({pix: '000.000.000-00'})) // {pix: '00000000000', type: 'cpf'}
   console.log(normalize({pix: '00.000.000/0000-00'})) // {pix: '00000000000000', type: 'cnpj'}
   console.log(normalize({pix: '+55 (11) 0000-0000'})) // {pix: '551100000000', type: 'phone'}
+  console.log(normalize({pix: '00020126360014BR.GOV...'})) // {pix: '00020126360014BR.GOV...', type: 'qrcode'}
   ```
 
 | Função   | Parametro       | Retorno                           |
 | :---------- | :--------- | :---------------------------------- |
-| `normalize` | `input: {pix: string}` | Pix `{ pix: string, type: 'email' \|  'cpf' \| 'cnpj' \|  'random' \|'phone' }` |
+| `normalize` | `input: {pix: string}` | Pix `{ pix: string, type: 'email' \|  'cpf' \| 'cnpj' \|  'random' \|'phone' \| 'qrcode' }` |
 
 
 

package/index.d.ts

@@ -1,4 +1,4 @@
-export type PixType = "email" | "cpf" | "cnpj" | "random" | "phone"
+export type PixType = "email" | "cpf" | "cnpj" | "random" | "phone" | "qrcode"
 
 export interface InvalidPix extends Error {
     message: "chave pix invalida."

package/index.js

@@ -7,7 +7,8 @@ const validationPixMap = {
     random: validator.isUUID,
     phone: validator.isPhoneNumber,
     cnpj: validator.isCNPJ,
-    cpf: validator.isCPF
+    cpf: validator.isCPF,
+    qrcode: validator.isQRCode
 };
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pix-utils-js",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "author": "Paulo Henrique",
   "description": "Um pacote para fornecer utilidades e validações para chaves pix.",
   "main": "index.js",

package/tests/index.js

@@ -9,6 +9,11 @@ describe('validate', () => {
         assert.strictEqual(sut, false);
     });
 
+    it('should returns false if qr pix key is provided', (t) => {
+        const sut = validate({pix: 'invalid', type: 'qrcode'})
+        assert.strictEqual(sut, false);
+    });
+
     it('should returns true if email key is provided and is valid', (t) => {
         const sut = validate({pix: Generator.generateRandomEmail()})
         assert.strictEqual(sut, true);
@@ -23,6 +28,18 @@ describe('validate', () => {
         const sut = validate({pix: Generator.generateRandomUUID()})
         assert.strictEqual(sut, true);
     });
+
+    it('should returns true qrcode if qrcode pix is provided and is valid', (t) => {
+        const qrCode = '00020126360014BR.GOV.BCB.PIX0114+5511999226498520400005303986540813213.005802BR5904test6004test62070503***630450CF'
+        const sut = validate({ pix: qrCode })
+        assert.strictEqual(sut, true);
+    });
+
+    it('should returns false qrcode if qrcode pix is provided and is invalid', (t) => {
+        const qrCode = '/INVALID/00020126360014BR.GOV.BCB.PIX0114+5511999226498520400005303986540813213.005802BR5904test6004test62070503***630450CF'
+        const sut = validate({ pix: qrCode })
+        assert.strictEqual(sut, false);
+    });
 })
 
 describe('identify', () => {
@@ -56,6 +73,12 @@ describe('identify', () => {
         assert.notStrictEqual(sut, { pix: phone, type: 'phone' });
     });
 
+    it('should returns qrcode if qrcode pix is provided', (t) => {
+        const qrCode = '00020126360014BR.GOV.BCB.PIX0114+5511999226498520400005303986540813213.005802BR5904test6004test62070503***630450CF'
+        const sut = identify({ pix: qrCode })
+        assert.notStrictEqual(sut, { pix: qrCode, type: 'qrcode' });
+    });
+
     it('should throws if invalid pix is provided', (t) => {
         let sut;
         try {
@@ -79,4 +102,8 @@ describe("normalize", () => {
     it('should normalize phone key', (t) => {
         assert.deepEqual(normalize({ pix: "+55 (11) 0000-0000"}), { pix: '551100000000', type: 'phone'});
     });
+
+    it('should normalize qrcode key', (t) => {
+        assert.deepEqual(normalize({ pix: "00020126360014BR.GOV.BCB.PIX0114+5511999226498520400005303986540813213.005802BR5904test6004test62070503***630450CF"}), { pix: '00020126360014BR.GOV.BCB.PIX0114+5511999226498520400005303986540813213.005802BR5904test6004test62070503***630450CF', type: 'qrcode'});
+    });
 })

package/utils/validator.js

@@ -23,6 +23,11 @@ class Validator {
         const cnpjRegex = /^(\d{2}\.\d{3}\.\d{3}\/\d{4}-\d{2}|\d{14})$/;
         return cnpjRegex.test(cnpj)
     }
+
+    isQRCode(pixKeyCopyPaste) {
+        const qrCodeRegex = /^(000201|01|2636)/
+        return qrCodeRegex.test(pixKeyCopyPaste)
+    }
 }
 
 module.exports = {

package/yarn-error.log

@@ -0,0 +1,59 @@
+Arguments: 
+  C:\Program Files\nodejs\node.exe C:\Users\Paulo\AppData\Roaming\npm\node_modules\yarn\bin\yarn.js publish
+
+PATH: 
+  C:\Program Files\PowerShell\7;C:\Program Files\Common Files\Oracle\Java\javapath;C:\Program Files (x86)\Common Files\Oracle\Java\javapath;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\Windows\System32\OpenSSH\;C:\Program Files (x86)\NVIDIA Corporation\PhysX\Common;C:\Program Files\NVIDIA Corporation\NVIDIA NvDLISR;C:\Program Files\Git\cmd;C:\Program Files\Docker\Docker\resources\bin;C:\Program Files\Amazon\AWSCLIV2\;C:\Program Files\nodejs\;C:\Program Files\PowerShell\7\;C:\Program Files\dotnet\;C:\Users\Paulo\AppData\Local\Microsoft\WindowsApps;;C:\Users\Paulo\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\Paulo\AppData\Roaming\npm;C:\Users\Paulo\.dotnet\tools
+
+Yarn version: 
+  1.22.19
+
+Node version: 
+  20.9.0
+
+Platform: 
+  win32 x64
+
+Trace: 
+  Error: canceled
+      at Interface.<anonymous> (C:\Users\Paulo\AppData\Roaming\npm\node_modules\yarn\lib\cli.js:137150:13)
+      at Interface.emit (node:events:514:28)
+      at [_ttyWrite] [as _ttyWrite] (node:internal/readline/interface:1125:18)
+      at ReadStream.onkeypress (node:internal/readline/interface:264:20)
+      at ReadStream.emit (node:events:514:28)
+      at emitKeys (node:internal/readline/utils:371:14)
+      at emitKeys.next (<anonymous>)
+      at ReadStream.onData (node:internal/readline/emitKeypressEvents:64:36)
+      at ReadStream.emit (node:events:514:28)
+      at addChunk (node:internal/streams/readable:376:12)
+
+npm manifest: 
+  {
+    "name": "pix-utils-js",
+    "version": "1.0.7",
+    "author": "Paulo Henrique",
+    "description": "Um pacote para fornecer utilidades e validações para chaves pix.",
+    "main": "index.js",
+    "repository": {
+      "type": "git",
+      "url": "https://github.com/paulohenriquesn/pix-utils-js.git"
+    },
+    "bugs": {
+      "url": "https://github.com/paulohenriquesn/pix-utils-js/issues"
+    },
+    "homepage": "https://github.com/paulohenriquesn/pix-utils-js#readme",
+    "scripts": {
+      "test": "node tests/index.js"
+    },
+    "keywords": [
+      "pix",
+      "chave pix"
+    ],
+    "license": "MIT"
+  }
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+  # yarn lockfile v1