parser-de-notas-de-corretagem 0.3.1 → 0.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/planetsLightningArrester/parser-de-notas-de-corretagem/actions/workflows/ci.yml/badge.svg)](https://github.com/planetsLightningArrester/parser-de-notas-de-corretagem/actions/workflows/ci.yml)
 
-Easing the PITA of making IRRF
+Easing the PITA of making IRPF
 
 > Note: This is a JS/TS package. If you want the end-user solution, check the [Leitor de notas de corretagem](https://github.com/planetsLightningArrester/leitor-de-notas-de-corretagem)
 
@@ -27,7 +27,8 @@ Easing the PITA of making IRRF
         "average": "16.30",
         "price": "1010.91",
         "date": "02/02/2022",
-        "cnpj": "60.840.055/0001-31"
+        "cnpj": "60.840.055/0001-31",
+        "isFII": false
       },
       {
         "type": "buy",
@@ -36,7 +37,8 @@ Easing the PITA of making IRRF
         "average": "112.80",
         "price": "564.02",
         "date": "02/02/2022",
-        "cnpj": "28.737.771/0001-85"
+        "cnpj": "28.737.771/0001-85",
+        "isFII": true
       },
       {
         "type": "buy",
@@ -45,7 +47,8 @@ Easing the PITA of making IRRF
         "average": "112.03",
         "price": "560.17",
         "date": "02/02/2022",
-        "cnpj": "29.641.226/0001-53"
+        "cnpj": "29.641.226/0001-53",
+        "isFII": true
       },
       {
         "type": "buy",
@@ -54,7 +57,8 @@ Easing the PITA of making IRRF
         "average": "97.38",
         "price": "1460.69",
         "date": "02/02/2022",
-        "cnpj": "17.554.274/0001-25"
+        "cnpj": "17.554.274/0001-25",
+        "isFII": true
       },
       {
         "type": "buy",
@@ -63,7 +67,8 @@ Easing the PITA of making IRRF
         "average": "91.76",
         "price": "458.79",
         "date": "02/02/2022",
-        "cnpj": "28.757.546/0001-00"
+        "cnpj": "28.757.546/0001-00",
+        "isFII": true
       }
     ]
   }
@@ -141,7 +146,7 @@ assets.defineStock('BIDI11', 'BANCO INTER UNT');
 * The values can deviate from cents. It's always a good call to double-check if the result is as expected. Check the [License](#license)
 
 ## Contributors
-Thanks to whom sent me notes for the tests ❤️. Personal data is not stored neither used on tests, only the notes content.
+Thanks to whom sent me notes for the tests ❤️. Personal data is not stored neither used on tests, only the notes' content.
 
 ## Thanks? U welcome
 Consider thanking me: send a "Thanks!" 👋 by [PIX](https://www.bcb.gov.br/en/financialstability/pix_en) 😊

package/notes-parser.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 /** Deal made in a `NegotiationNote` type */
 export interface Deal {
     /** Deal type */
@@ -14,6 +15,8 @@ export interface Deal {
     date: string;
     /** Asset's CNPJ */
     cnpj: string;
+    /** Whether the asset is a FII (real estate) */
+    isFII: boolean;
 }
 /** A parsed Negotiation Note type */
 export declare class NegotiationNote {
@@ -83,14 +86,14 @@ export declare class NoteParser {
      * @param content PDF content
      * @returns an `Array` of `NegotiationNote`
      */
-    parseNote(noteName: string, content: string | Uint8Array, possiblePasswords?: string[]): Promise<NegotiationNote[]>;
+    parseNote(noteName: string, content: Buffer | Uint8Array, possiblePasswords?: string[]): Promise<NegotiationNote[]>;
     /**
      * Add stock definition
      * @param code stock code
      * @param name stock name
      * @param cnpj stock CNPJ
      */
-    defineStock(code: string, name: string, cnpj?: string): void;
+    defineStock(code: string, name: string, cnpj?: string, isFII?: boolean): void;
     /**
      * Convert a date according to `dateFormat`
      * @param date the date to be formatted