parser-de-notas-de-corretagem 0.5.0 → 0.5.2

package/asset-crawler.d.ts

@@ -0,0 +1,76 @@
+import { Asset } from "./types/common";
+import { StockInfos } from "./types/listed-stocks";
+import { FiiInfos } from "./types/listed-real-estates";
+import { CashDividendShortVersion, StockDividendShortVersion } from "./types/corporative-events";
+/** Types of asset verbosity */
+export type AssetVerbosity = 'off' | 'all' | 'minimal';
+/** Assets crawler manager */
+export declare class AssetCrawler {
+    /** Assets cached */
+    protected assets: Array<StockInfos | FiiInfos>;
+    /** Assets defined on runtime */
+    customAssets: Asset[];
+    /** Auto-update flag */
+    private _autoUpdate;
+    /** Auto-update flag */
+    set autoUpdate(v: boolean);
+    get autoUpdate(): boolean;
+    private autoUpdateTimer;
+    /** Auto-update timeout */
+    private updaterTimeout;
+    /** Auto-update timeout when any failure happens */
+    private updaterTimeoutIfFailed;
+    /** Set the verbosity level */
+    verbosity: AssetVerbosity;
+    /** Max number of retries when fetching data. Default is 20 */
+    maxRetries: number;
+    /** Manage the keys being listened to */
+    private listenerKey;
+    /** Keys generated on update */
+    private listeners;
+    /**
+     * Instantiate a new `AssetCrawler`
+     * @param autoUpdate whether the application should auto-update
+     * the list of assets for new changes. Default is `false`. Require internet connection
+     * @param verbose set the verbosity level. Default is `off`
+     */
+    constructor(autoUpdate?: boolean, verbose?: AssetVerbosity);
+    /**
+     * Update the listed assets after a timeout
+     * @param timeout update after `timeout` milliseconds
+     */
+    private updater;
+    /**
+     * Update the current listed assets. May take several minutes.
+     * If `maxRetires` is reached, an Error is thrown and the fetch
+     * process is interrupted
+     */
+    fetchListedAssets(): Promise<void>;
+    /**
+     * Parse the stock name and returns the stock code
+     * @param name title of the stock in the brokerage note
+     * @returns the stock code
+     */
+    getCodeFromTitle(name: string): Asset;
+    /**
+     * Get the stock dividends and the cash dividends of a given asset, if any
+     * @param code the asset code (letter only)
+     * @returns and `Array` where the first position is the list of stock dividends
+     * and the second position is a list of the cash dividends
+     */
+    getDividends(code: string): [StockDividendShortVersion[], CashDividendShortVersion[]];
+    /**
+     * Subscribe to updates when `autoUpdate` is `on` or
+     * when `fetchListedAssets` is manually called
+     * @param callback function to be called when the data is updated
+     * @returns the key number referring to the listener. Can be used to `unsubscribeToUpdates`
+     */
+    subscribeToUpdates(callback: (assets: Array<StockInfos | FiiInfos>) => void): number;
+    /**
+     * Unsubscribe to updates when `autoUpdate` is `on` or
+     * when `fetchListedAssets` is manually called
+     * @param key the subscription key returned by `subscribeToUpdates`
+     */
+    unsubscribeToUpdates(key: number): void;
+}
+//# sourceMappingURL=asset-crawler.d.ts.map

package/notes-parser.d.ts

@@ -1,4 +1,7 @@
+import { AssetCrawler, AssetVerbosity } from "./asset-crawler";
 import { CashDividendShortVersion, StockDividendShortVersion } from './types/corporative-events';
+export { AssetCrawler, CashDividendShortVersion, StockDividendShortVersion };
+export type { AssetVerbosity };
 /** Deal made in a `NegotiationNote` type */
 export interface Deal {
     /** Deal type */
@@ -64,17 +67,22 @@ export declare class UnknownAsset extends Error {
 }
 /** Brokerage notes parser */
 export declare class NoteParser {
-    /** Path to the JSON data file */
-    private stockParser;
+    /** Info about the assets */
+    assetCrawler: AssetCrawler;
     /** The date format used. Default is `dd/MM/yyyy` */
     private dateFormat;
+    /** Set the verbosity level. Actually it's the same as the crawler */
+    private _verbosity;
+    /** Set the verbosity level */
+    set verbosity(v: AssetVerbosity);
+    get verbosity(): AssetVerbosity;
     /**
      * 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);
+    constructor(autoUpdateLookUpList?: boolean, verbosity?: AssetVerbosity);
     /**
      * Set the date format
      * @param format a `DateFormat`