parser-de-notas-de-corretagem 0.0.2 → 0.0.4

package/README.md

@@ -1,21 +1,23 @@
 # Parse Brazilian brokerage notes PDFs (Inter and Clear holders available)
 
+[![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
 
-> 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)
+> 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)
 
 ## Example result
 > The `price` and `average` fields already include the fees paid
 ```JSON
 [
   {
-    "number": "11111",
+    "number": "11111",    // Brokerage note number
     "buyTotal": "4054.58",
     "sellTotal": "0.00",
     "buyFees": "1.24",
     "sellFees": "0.00",
     "fees": "1.24",
-    "date": "02/02/2022",
+    "date": "02/02/2022", // Can also output in yyyy-MM-dd format
     "holder": "rico",
     "deals": [
       {
@@ -34,7 +36,7 @@ Easing the PITA of making IRRF
         "average": "112.80",
         "price": "564.02",
         "date": "02/02/2022",
-        "cnpj": "00.000.000/0000-00"
+        "cnpj": "00.000.000/0000-00"   // FIIs' CNPJs aren't supported yet
       },
       {
         "type": "buy",
@@ -88,8 +90,8 @@ async function main() {
 
     // 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);
+    let pdfPath = path.join(__dirname, 'note.pdf');
+    let parseResult = await assets.parseNote(pdfPath, possiblePDFpasswords);
     
     // Merge all negotiation notes
     let allDeals: Deal[][] = [];
@@ -147,6 +149,6 @@ Consider thanking me: send a "Thanks!" 👋 by [PIX](https://www.bcb.gov.br/en/f
 > 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.
+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

@@ -72,6 +72,10 @@ export declare class NegotiationNote {
      */
     deals: Deal[];
 }
+/**
+ * Possible date formats to be used
+ */
+export type DateFormat = "dd/MM/yyyy" | "yyyy-MM-dd";
 /**
  * Brokerage notes parser
  */
@@ -80,6 +84,10 @@ export declare class NoteParser {
      * Path to the JSON data file
      */
     private stockParser;
+    /**
+     * The date format used. Default is "dd/MM/yyyy"
+     */
+    private dateFormat;
     /**
      * Instantiate a new `NoteParser`
      * @param autoUpdateLookUpList whether the application should auto-update
@@ -87,6 +95,11 @@ export declare class NoteParser {
      * Updating this package to the latest version also gets the latest infos
      */
     constructor(autoUpdateLookUpList?: boolean);
+    /**
+     * Set the date format
+     * @param format a `DateFormat`
+     */
+    setDateFormat(format: DateFormat): void;
     /**
      * Read and parse a given PDF negotiation note by its full path
      * @param noteFullPath the full path to the PDF note to be parsed
@@ -100,5 +113,11 @@ export declare class NoteParser {
      * @param cnpj stock CNPJ
      */
     defineStock(code: string, name: string, cnpj?: string): void;
+    /**
+     * Convert a date according to `dateFormat`
+     * @param date the date to be formatted
+     * @returns the formatted date
+     */
+    private formatDate;
 }
 //# sourceMappingURL=notes-parser.d.ts.map