parser-de-notas-de-corretagem 0.0.5 → 0.2.0

package/README.md

@@ -75,7 +75,7 @@ Easing the PITA of making IRRF
 
 ## Usage
 
-### Full example
+### Full NodeJS example
 ```Typescript
 import fs from 'fs';
 import path from 'path';
@@ -91,7 +91,7 @@ async function main() {
     // Get all negotiation notes inside a PDF, even with password
     const possiblePDFpasswords: string[] = ['123', '456'];
     let pdfPath = path.join(__dirname, 'note.pdf');
-    let parseResult = await assets.parseNote(pdfPath, possiblePDFpasswords);
+    let parseResult = await assets.parseNote(path.basename(pdfPath), fs.readFileSync(pdfPath), possiblePDFpasswords);
     
     // Merge all negotiation notes
     let allDeals: Deal[][] = [];

package/notes-parser.d.ts

@@ -1,92 +1,69 @@
-/**
- * Deal made in a `NegotiationNote` type
- */
+/** Deal made in a `NegotiationNote` type */
 export interface Deal {
-    /**
-     * Deal type
-     */
+    /** Deal type */
     type: 'buy' | 'sell';
-    /**
-     * Stock/FII code
-     */
+    /** Stock/FII code */
     code: string;
-    /**
-     * Amount bought/sold
-     */
+    /** Amount bought/sold */
     quantity: number;
-    /**
-     * Average value bought/sold with fees applied
-     */
+    /** Average value bought/sold with fees applied */
     average: string;
-    /**
-     * Total amount bought/sold with fees applied
-     */
+    /** Total amount bought/sold with fees applied */
     price: string;
-    /**
-     * Deal date in format yyyy-MM-dd
-     */
+    /** Deal date in format yyyy-MM-dd */
     date: string;
-    /**
-     * Asset's CNPJ
-     */
+    /** Asset's CNPJ */
     cnpj: string;
 }
-/**
- * A parsed Negotiation Note type
- */
+/** A parsed Negotiation Note type */
 export declare class NegotiationNote {
-    /**
-     * Negotiation note number
-     */
+    /** Negotiation note number */
     number: string;
-    /**
-     * The total amount bought with fees applied
-     */
+    /** The total amount bought with fees applied */
     buyTotal: string;
-    /**
-     * The total amount sold with fees applied
-     */
+    /** The total amount sold with fees applied */
     sellTotal: string;
-    /**
-     * The total amount of buy fees
-     */
+    /** The total amount of buy fees */
     buyFees: string;
-    /**
-     * The total amount of sell fees
-     */
+    /** The total amount of sell fees */
     sellFees: string;
-    /**
-     * The total amount of fees
-     */
+    /** The total amount of fees */
     fees: string;
-    /**
-     * Negotiation note date in format yyyy-MM-dd
-     */
+    /** Negotiation note date in format yyyy-MM-dd */
     date: string;
-    /**
-     * Negotiation note holder
-     */
+    /** Negotiation note holder */
     holder: string;
-    /**
-     * Array of deals with buys and sells
-     */
+    /** Array of deals with buys and sells */
     deals: Deal[];
 }
-/**
- * Possible date formats to be used
- */
+/** Possible date formats to be used */
 export type DateFormat = "dd/MM/yyyy" | "yyyy-MM-dd";
-/**
- * Brokerage notes parser
- */
+/** Wrong password error */
+export declare class WrongPassword extends Error {
+}
+/** Empty document error */
+export declare class EmptyDocument extends Error {
+}
+/** Document without note number error */
+export declare class MissingNoteNumber extends Error {
+}
+/** Document without holder error */
+export declare class MissingHolder extends Error {
+}
+/** Document without date error */
+export declare class MissingDate extends Error {
+}
+/** Missing Buy or Sell sums */
+export declare class MissingBuyOrSellSums extends Error {
+}
+/** Unknown Asset error error */
+export declare class UnknownAsset extends Error {
+}
+/** Brokerage notes parser */
 export declare class NoteParser {
-    /**
-     * Path to the JSON data file
-     */
+    /** Path to the JSON data file */
     private stockParser;
-    /**
-     * The date format used. Default is "dd/MM/yyyy"
-     */
+    /** The date format used. Default is `dd/MM/yyyy` */
     private dateFormat;
     /**
      * Instantiate a new `NoteParser`
@@ -102,10 +79,11 @@ export declare class NoteParser {
     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
+     * @param name PDF name
+     * @param content PDF content
      * @returns an `Array` of `NegotiationNote`
      */
-    parseNote(noteFullPath: string, possiblePasswords?: string[]): Promise<NegotiationNote[]>;
+    parseNote(noteName: string, content: Uint8Array, possiblePasswords?: string[]): Promise<NegotiationNote[]>;
     /**
      * Add stock definition
      * @param code stock code