parser-de-notas-de-corretagem 0.0.1

package/README.md

@@ -0,0 +1,152 @@
+# Parse Brazilian brokerage notes PDFs (Inter and Clear holders available)
+
+Easing the PITA of making IRRF
+
+> Note: This is a JS/TS package. If you want the final-user solution, check the [Leitor de notas de corretagem](https://github.com/planetsLightningArrester/leitor-de-notas-de-corretagem)
+
+## Example result
+> The `price` and `average` fields already include the fees paid
+```JSON
+[
+  {
+    "number": "11111",
+    "buyTotal": "4054.58",
+    "sellTotal": "0.00",
+    "buyFees": "1.24",
+    "sellFees": "0.00",
+    "fees": "1.24",
+    "date": "02/02/2022",
+    "holder": "rico",
+    "deals": [
+      {
+        "type": "buy",
+        "code": "FLRY3",
+        "quantity": 62,
+        "average": "16.30",
+        "price": "1010.91",
+        "date": "02/02/2022",
+        "cnpj": "60.840.055/0001-31"
+      },
+      {
+        "type": "buy",
+        "code": "ALZR11",
+        "quantity": 5,
+        "average": "112.80",
+        "price": "564.02",
+        "date": "02/02/2022",
+        "cnpj": "00.000.000/0000-00"
+      },
+      {
+        "type": "buy",
+        "code": "HGRU11",
+        "quantity": 5,
+        "average": "112.03",
+        "price": "560.17",
+        "date": "02/02/2022",
+        "cnpj": "00.000.000/0000-00"
+      },
+      {
+        "type": "buy",
+        "code": "VISC11",
+        "quantity": 15,
+        "average": "97.38",
+        "price": "1460.69",
+        "date": "02/02/2022",
+        "cnpj": "00.000.000/0000-00"
+      },
+      {
+        "type": "buy",
+        "code": "XPML11",
+        "quantity": 5,
+        "average": "91.76",
+        "price": "458.79",
+        "date": "02/02/2022",
+        "cnpj": "00.000.000/0000-00"
+      }
+    ]
+  }
+]
+``` 
+
+## Install
+> npm i parser-de-notas-de-corretagem
+
+## Usage
+
+### Full example
+```Typescript
+import fs from 'fs';
+import path from 'path';
+import { Deal, NoteParser } from 'parser-de-notas-de-corretagem';
+
+async function main() {
+
+  console.log(`Leitor de Notas de Negociação - GNU GPLv3`);
+  
+  const assets = new NoteParser();
+  try {
+
+    // Get all negotiation notes inside a PDF, even with password
+    const possiblePDFpasswords: string[] = ['123', '456'];
+    let pdfPassword = path.join(__dirname, 'note.pdf');
+    let parseResult = await assets.parseNote(pdfPassword, possiblePDFpasswords);
+    
+    // Merge all negotiation notes
+    let allDeals: Deal[][] = [];
+    parseResult.forEach(note => {
+      note.deals.forEach(deal => {
+        let index = allDeals.findIndex(el => el.some(subEl => subEl.code === deal.code));
+        if (index === -1) {
+          allDeals.push([deal]);
+        } else {
+          allDeals[index].push(deal);
+        }
+      })
+    })
+    
+    // Generate a .csv result
+    let result: string = `Código\tCNPJ\tData\tC/V\tQuantidade\tPreço+custos\n`;
+    allDeals.forEach(asset => {
+      asset.forEach(deal => {
+        result += `${deal.code}\t${deal.cnpj}\t${deal.date}\t${deal.type=='buy'?'C':'V'}\t${deal.quantity}\t${deal.price.replace(/\./g, ',')}\n`;
+      })
+      result += `\n`;
+    });
+    
+    fs.writeFileSync(path.join(__dirname, '..', '..', 'Resultado.csv'), result);
+    
+    console.log(`Todas as ${parseResult.length} notas foram processadas`);
+    console.log(`O arquivo "Resultado.csv" foi gerado no diretório atual.`);
+
+  } catch (error) {
+    console.log(error);
+  }
+}
+
+main();
+```
+
+### Add a custom stock
+```Typescript
+const assets = new NoteParser();
+// Old stocks aren't available by default, but you can add them
+assets.defineStock('BIDI3', 'BANCO INTER ON');
+assets.defineStock('BIDI11', 'BANCO INTER UNT');
+```
+
+## P.S.
+* Total values include fees
+* 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)
+* FIIs and custom stocks doesn't provide a valid CNPJ field
+
+## Contributors
+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) 😊
+> a09e5878-2355-45f7-9f36-6df4ccf383cf
+
+## License
+As license, this software is provided as is, free of charge, without any warranty whatsoever. Its author is not responsible for its usage. Use it by your own risk.
+
+[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)

package/notes-parser.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Deal made in a `NegotiationNote` type
+ */
+export interface Deal {
+    /**
+     * Deal type
+     */
+    type: 'buy' | 'sell';
+    /**
+     * Stock/FII code
+     */
+    code: string;
+    /**
+     * Amount bought/sold
+     */
+    quantity: number;
+    /**
+     * Average value bought/sold with fees applied
+     */
+    average: string;
+    /**
+     * Total amount bought/sold with fees applied
+     */
+    price: string;
+    /**
+     * Deal date in format yyyy-MM-dd
+     */
+    date: string;
+    /**
+     * Asset's CNPJ
+     */
+    cnpj: string;
+}
+/**
+ * A parsed Negotiation Note type
+ */
+export declare class NegotiationNote {
+    /**
+     * Negotiation note number
+     */
+    number: string;
+    /**
+     * The total amount bought with fees applied
+     */
+    buyTotal: string;
+    /**
+     * The total amount sold with fees applied
+     */
+    sellTotal: string;
+    /**
+     * The total amount of buy fees
+     */
+    buyFees: string;
+    /**
+     * The total amount of sell fees
+     */
+    sellFees: string;
+    /**
+     * The total amount of fees
+     */
+    fees: string;
+    /**
+     * Negotiation note date in format yyyy-MM-dd
+     */
+    date: string;
+    /**
+     * Negotiation note holder
+     */
+    holder: string;
+    /**
+     * Array of deals with buys and sells
+     */
+    deals: Deal[];
+}
+/**
+ * Brokerage notes parser
+ */
+export declare class NoteParser {
+    /**
+     * Path to the JSON data file
+     */
+    private stockParser;
+    /**
+     * Instantiate a new `NoteParser`
+     * @param autoUpdateLookUpList whether the application should auto-update
+     * the list of assets for new changes every week. Default is `false`. Require internet connection.
+     * Updating this package to the latest version also gets the latest infos
+     */
+    constructor(autoUpdateLookUpList?: boolean);
+    /**
+     * Read and parse a given PDF negotiation note by its full path
+     * @param noteFullPath the full path to the PDF note to be parsed
+     * @returns an `Array` of `NegotiationNote`
+     */
+    parseNote(noteFullPath: string, 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;
+}
+//# sourceMappingURL=notes-parser.d.ts.map