ofx-data-extractor 1.2.0 → 1.2.1

package/dist/config.d.ts

@@ -0,0 +1,4 @@
+export declare const ELEMENT_CLOSURE_REGEX: RegExp;
+export declare const ELEMENT_OPENING_REGEX: RegExp;
+export declare const START_TEXT_BANK_TRANSFER = "<STMTTRN>";
+export declare const END_TEXT_BANK_TRANSFER = "</STMTTRN>";

package/dist/helpers.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import { STRTTRN as STRTTRNType } from './types';
+export declare function formatDate(date: string, format: string): string;
+export declare function fixJsonProblems(content: string): string;
+export declare function extractFinancialInstitutionTransactionId(fitid: string): string;
+export declare function isDateField(field: string): boolean;
+export declare function trim(str: string): string;
+export declare function objectStartReplacer(param: string): string;
+export declare function objectEndReplacer(param: string): string;
+export declare function sanitizeCurrency(value: string): string;
+export declare function isValidNumberToConvert(field: string, value: string): boolean;
+export declare function getBankTransferListText(ofxContent: string): {
+    oldListText: string;
+    newListText: string;
+};
+export declare function convertMetaDataToObject(stringList: string[], nativeTypes: boolean): {
+    [key: string]: any;
+};
+export declare function getTransactionsSummary(STRTTRN: STRTTRNType[]): {
+    credit: number;
+    debit: number;
+    amountOfCredits: number;
+    amountOfDebits: number;
+};
+export declare function bufferToString(data: Buffer): string;
+export declare function fileFromPathToString(pathname: string): Promise<string>;
+export declare function blobToString(blob: Blob): Promise<string>;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Ofx } from './main';
+export { formatDate, fixJsonProblems, blobToString, bufferToString, fileFromPathToString, } from './helpers';
+export type { OfxResponse, OFXMetaData, OfxStructure, BankTransferList, } from './types';

package/dist/main.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+import { OfxConfig, OFXMetaData, OfxResponse, OfxStructure, STRTTRN } from './types';
+export declare class Ofx {
+    private _data;
+    private _config;
+    constructor(data: string, config?: OfxConfig);
+    static fromBuffer(data: Buffer): Ofx;
+    static fromFilePath(pathname: string): Promise<Ofx>;
+    static fromBlob(blob: Blob): Promise<Ofx>;
+    config(config: OfxConfig): this;
+    getHeaders(): OFXMetaData;
+    getBankTransferList(): STRTTRN[];
+    private getPartialJsonData;
+    private sanitizeValue;
+    private sanitize;
+    private configFinancialInstitutionTransactionId;
+    private configDate;
+    getTransactionsSummary(): {
+        credit: number;
+        debit: number;
+        amountOfCredits: number;
+        amountOfDebits: number;
+        dateStart: import("./types").DateResponse;
+        dateEnd: import("./types").DateResponse;
+    };
+    getContent(): OfxStructure;
+    toJson(): OfxResponse;
+}

package/dist/types.d.ts

@@ -0,0 +1,114 @@
+export type OFXMetaData = {
+    OFXHEADER: string;
+    DATA: string;
+    VERSION: string;
+    SECURITY: string;
+    ENCODING: string;
+    CHARSET: string;
+    COMPRESSION: string;
+    OLDFILEUID: string;
+    NEWFILEUID: string;
+};
+export type DateResponse = {
+    datetime: string | null;
+    date: string | null;
+    time: string | null;
+    offset: string | null;
+    timezone: string | null;
+};
+/**
+ * separated - returns the separate transaction id:
+ *  "date": string,
+ *  "transactionCode": string,
+ *  "protocol": string
+ */
+type ConfigFitId = 'normal' | 'separated';
+export type ConfigDate = {
+    /**
+     * @description supported keys:
+     *  yy => year -> 2 digits,
+     *  yyyy or y => year,
+     *  MM or M => month,
+     *  dd or d => day,
+     *  hh or h => hour,
+     *  mm or m => minute,
+     *  ss or s => second,
+     *  O => offset,
+     *  TZ => timezone
+     * @example format: 'y-M-d h:m:s'
+     * @returns '2022-02-21 09:00:00'
+     */
+    formatDate?: string;
+};
+type MapKeys<T> = {
+    [Property in keyof T]?: string;
+};
+type KeysJson = MapKeys<Status | BankAccountFrom | STRTTRN | BankTransferList | LedGerBal | FINANCIAL_INSTITUTION | OfxStructure>;
+export type OfxConfig = ConfigDate & {
+    fitId?: ConfigFitId;
+    nativeTypes?: boolean;
+    formatJson?: MapKeys<KeysJson>;
+};
+export type Status = {
+    CODE: string;
+    SEVERITY: string;
+};
+export type BankAccountFrom = {
+    BANKID: string;
+    ACCTID: string;
+    ACCTT: string;
+};
+type TransferType = string;
+export type STRTTRN = {
+    TRNTYPE: TransferType;
+    DTPOSTED: DateResponse;
+    TRNAMT: string;
+    FITID: string | {
+        date: string;
+        protocol: string;
+        transactionCode: string;
+    };
+    CHECKNUM: string;
+    MEMO: string;
+};
+export type BankTransferList = {
+    DTSTART: DateResponse;
+    DTEND: DateResponse;
+    STRTTRN: STRTTRN[];
+};
+export type LedGerBal = {
+    BALAMT: string;
+    DTASOF: DateResponse;
+};
+export type FINANCIAL_INSTITUTION = {
+    ORG: string;
+    FID: string;
+};
+export type OfxStructure = {
+    OFX: {
+        SIGNONMSGSRSV1: {
+            SONRS: {
+                STATUS: Status;
+                DTSERVER: DateResponse;
+                LANGUAGE: string;
+                DTACCTUP: DateResponse;
+                FI: FINANCIAL_INSTITUTION;
+            };
+        };
+        BANKMSGSRSV1: {
+            STMTTRNRS: {
+                TRNUID: number;
+                STATUS: Status;
+                STMTRS: {
+                    CURDEF: string;
+                    BANKACCTFROM: BankAccountFrom;
+                    BANKTRANLIST: BankTransferList;
+                    LEDGERBAL: LedGerBal;
+                    MKTGINFO: string;
+                };
+            };
+        };
+    };
+};
+export type OfxResponse = OFXMetaData & OfxStructure;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofx-data-extractor",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "keywords": [
     "ofx",
     "financial",