@f-o-t/ofx 1.2.0 → 1.2.1

package/dist/index.d.ts

@@ -59,4 +59,68 @@ interface BalanceInfo {
 }
 declare function getBalance(document: OFXDocument): BalanceInfo[];
 declare function getSignOnInfo(document: OFXDocument): OFXSignOnResponse;
-export { schemas, parseOrThrow, parse, getTransactions, getSignOnInfo, getBalance, getAccountInfo, ParseResult, OFXTransactionType, OFXTransactionList, OFXTransaction, OFXStatus, OFXSignOnResponse, OFXSignOnMessageSetResponse, OFXResponse, OFXHeader, OFXFinancialInstitution, OFXDocument, OFXDate, OFXCreditCardStatementTransactionResponse, OFXCreditCardStatementResponse, OFXCreditCardMessageSetResponse, OFXCreditCardAccount, OFXBankStatementTransactionResponse, OFXBankStatementResponse, OFXBankMessageSetResponse, OFXBankAccount, OFXBalance, OFXAccountType, BalanceInfo };
+declare function formatOfxDate(date: Date, timezone?: {
+	offset: number;
+	name: string;
+}): string;
+interface GenerateHeaderOptions {
+	version?: string;
+	encoding?: string;
+	charset?: string;
+}
+declare function generateHeader(options?: GenerateHeaderOptions): string;
+interface GenerateTransactionInput {
+	type: OFXTransactionType;
+	datePosted: Date;
+	amount: number;
+	fitId: string;
+	name?: string;
+	memo?: string;
+	checkNum?: string;
+	refNum?: string;
+}
+interface GenerateBankStatementOptions {
+	bankId: string;
+	accountId: string;
+	accountType: OFXAccountType;
+	currency: string;
+	startDate: Date;
+	endDate: Date;
+	transactions: GenerateTransactionInput[];
+	ledgerBalance?: {
+		amount: number;
+		asOfDate: Date;
+	};
+	availableBalance?: {
+		amount: number;
+		asOfDate: Date;
+	};
+	financialInstitution?: {
+		org?: string;
+		fid?: string;
+	};
+	language?: string;
+}
+declare function generateBankStatement(options: GenerateBankStatementOptions): string;
+interface GenerateCreditCardStatementOptions {
+	accountId: string;
+	currency: string;
+	startDate: Date;
+	endDate: Date;
+	transactions: GenerateTransactionInput[];
+	ledgerBalance?: {
+		amount: number;
+		asOfDate: Date;
+	};
+	availableBalance?: {
+		amount: number;
+		asOfDate: Date;
+	};
+	financialInstitution?: {
+		org?: string;
+		fid?: string;
+	};
+	language?: string;
+}
+declare function generateCreditCardStatement(options: GenerateCreditCardStatementOptions): string;
+export { schemas, parseOrThrow, parse, getTransactions, getSignOnInfo, getBalance, getAccountInfo, generateHeader, generateCreditCardStatement, generateBankStatement, formatOfxDate, ParseResult, OFXTransactionType, OFXTransactionList, OFXTransaction, OFXStatus, OFXSignOnResponse, OFXSignOnMessageSetResponse, OFXResponse, OFXHeader, OFXFinancialInstitution, OFXDocument, OFXDate, OFXCreditCardStatementTransactionResponse, OFXCreditCardStatementResponse, OFXCreditCardMessageSetResponse, OFXCreditCardAccount, OFXBankStatementTransactionResponse, OFXBankStatementResponse, OFXBankMessageSetResponse, OFXBankAccount, OFXBalance, OFXAccountType, GenerateTransactionInput, GenerateHeaderOptions, GenerateCreditCardStatementOptions, GenerateBankStatementOptions, BalanceInfo };

package/dist/index.js

@@ -358,6 +358,210 @@ function getBalance(document) {
 function getSignOnInfo(document) {
   return document.OFX.SIGNONMSGSRSV1.SONRS;
 }
+var pad = (n, width = 2) => n.toString().padStart(width, "0");
+function formatOfxDate(date, timezone) {
+  const tz = timezone ?? { name: "GMT", offset: 0 };
+  const offsetMs = tz.offset * 60 * 60 * 1000;
+  const adjustedDate = new Date(date.getTime() + offsetMs);
+  const year = adjustedDate.getUTCFullYear();
+  const month = pad(adjustedDate.getUTCMonth() + 1);
+  const day = pad(adjustedDate.getUTCDate());
+  const hour = pad(adjustedDate.getUTCHours());
+  const minute = pad(adjustedDate.getUTCMinutes());
+  const second = pad(adjustedDate.getUTCSeconds());
+  const sign = tz.offset >= 0 ? "+" : "";
+  return `${year}${month}${day}${hour}${minute}${second}[${sign}${tz.offset}:${tz.name}]`;
+}
+function escapeOfxText(text) {
+  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+function formatAmount(amount) {
+  return amount.toFixed(2);
+}
+function generateHeader(options) {
+  const version = options?.version ?? "100";
+  const encoding = options?.encoding ?? "USASCII";
+  const charset = options?.charset ?? "1252";
+  return [
+    "OFXHEADER:100",
+    "DATA:OFXSGML",
+    `VERSION:${version}`,
+    "SECURITY:NONE",
+    `ENCODING:${encoding}`,
+    `CHARSET:${charset}`,
+    "COMPRESSION:NONE",
+    "OLDFILEUID:NONE",
+    "NEWFILEUID:NONE",
+    ""
+  ].join(`
+`);
+}
+function generateTransaction(trn) {
+  const lines = [
+    "<STMTTRN>",
+    `<TRNTYPE>${trn.type}`,
+    `<DTPOSTED>${formatOfxDate(trn.datePosted)}`,
+    `<TRNAMT>${formatAmount(trn.amount)}`,
+    `<FITID>${escapeOfxText(trn.fitId)}`
+  ];
+  if (trn.name) {
+    lines.push(`<NAME>${escapeOfxText(trn.name)}`);
+  }
+  if (trn.memo) {
+    lines.push(`<MEMO>${escapeOfxText(trn.memo)}`);
+  }
+  if (trn.checkNum) {
+    lines.push(`<CHECKNUM>${escapeOfxText(trn.checkNum)}`);
+  }
+  if (trn.refNum) {
+    lines.push(`<REFNUM>${escapeOfxText(trn.refNum)}`);
+  }
+  lines.push("</STMTTRN>");
+  return lines.join(`
+`);
+}
+function generateBankStatement(options) {
+  const header = generateHeader();
+  const serverDate = formatOfxDate(new Date);
+  const language = options.language ?? "POR";
+  const transactionsContent = options.transactions.map((trn) => generateTransaction(trn)).join(`
+`);
+  let fiContent = "";
+  if (options.financialInstitution) {
+    fiContent = `<FI>
+`;
+    if (options.financialInstitution.org) {
+      fiContent += `<ORG>${escapeOfxText(options.financialInstitution.org)}
+`;
+    }
+    if (options.financialInstitution.fid) {
+      fiContent += `<FID>${escapeOfxText(options.financialInstitution.fid)}
+`;
+    }
+    fiContent += `</FI>
+`;
+  }
+  let ledgerBalContent = "";
+  if (options.ledgerBalance) {
+    ledgerBalContent = `<LEDGERBAL>
+<BALAMT>${formatAmount(options.ledgerBalance.amount)}
+<DTASOF>${formatOfxDate(options.ledgerBalance.asOfDate)}
+</LEDGERBAL>
+`;
+  }
+  let availBalContent = "";
+  if (options.availableBalance) {
+    availBalContent = `<AVAILBAL>
+<BALAMT>${formatAmount(options.availableBalance.amount)}
+<DTASOF>${formatOfxDate(options.availableBalance.asOfDate)}
+</AVAILBAL>
+`;
+  }
+  return `${header}<OFX>
+<SIGNONMSGSRSV1>
+<SONRS>
+<STATUS>
+<CODE>0
+<SEVERITY>INFO
+</STATUS>
+<DTSERVER>${serverDate}
+<LANGUAGE>${language}
+${fiContent}</SONRS>
+</SIGNONMSGSRSV1>
+<BANKMSGSRSV1>
+<STMTTRNRS>
+<TRNUID>0
+<STATUS>
+<CODE>0
+<SEVERITY>INFO
+</STATUS>
+<STMTRS>
+<CURDEF>${options.currency}
+<BANKACCTFROM>
+<BANKID>${escapeOfxText(options.bankId)}
+<ACCTID>${escapeOfxText(options.accountId)}
+<ACCTTYPE>${options.accountType}
+</BANKACCTFROM>
+<BANKTRANLIST>
+<DTSTART>${formatOfxDate(options.startDate)}
+<DTEND>${formatOfxDate(options.endDate)}
+${transactionsContent}
+</BANKTRANLIST>
+${ledgerBalContent}${availBalContent}</STMTRS>
+</STMTTRNRS>
+</BANKMSGSRSV1>
+</OFX>`;
+}
+function generateCreditCardStatement(options) {
+  const header = generateHeader();
+  const serverDate = formatOfxDate(new Date);
+  const language = options.language ?? "POR";
+  const transactionsContent = options.transactions.map((trn) => generateTransaction(trn)).join(`
+`);
+  let fiContent = "";
+  if (options.financialInstitution) {
+    fiContent = `<FI>
+`;
+    if (options.financialInstitution.org) {
+      fiContent += `<ORG>${escapeOfxText(options.financialInstitution.org)}
+`;
+    }
+    if (options.financialInstitution.fid) {
+      fiContent += `<FID>${escapeOfxText(options.financialInstitution.fid)}
+`;
+    }
+    fiContent += `</FI>
+`;
+  }
+  let ledgerBalContent = "";
+  if (options.ledgerBalance) {
+    ledgerBalContent = `<LEDGERBAL>
+<BALAMT>${formatAmount(options.ledgerBalance.amount)}
+<DTASOF>${formatOfxDate(options.ledgerBalance.asOfDate)}
+</LEDGERBAL>
+`;
+  }
+  let availBalContent = "";
+  if (options.availableBalance) {
+    availBalContent = `<AVAILBAL>
+<BALAMT>${formatAmount(options.availableBalance.amount)}
+<DTASOF>${formatOfxDate(options.availableBalance.asOfDate)}
+</AVAILBAL>
+`;
+  }
+  return `${header}<OFX>
+<SIGNONMSGSRSV1>
+<SONRS>
+<STATUS>
+<CODE>0
+<SEVERITY>INFO
+</STATUS>
+<DTSERVER>${serverDate}
+<LANGUAGE>${language}
+${fiContent}</SONRS>
+</SIGNONMSGSRSV1>
+<CREDITCARDMSGSRSV1>
+<CCSTMTTRNRS>
+<TRNUID>0
+<STATUS>
+<CODE>0
+<SEVERITY>INFO
+</STATUS>
+<CCSTMTRS>
+<CURDEF>${options.currency}
+<CCACCTFROM>
+<ACCTID>${escapeOfxText(options.accountId)}
+</CCACCTFROM>
+<BANKTRANLIST>
+<DTSTART>${formatOfxDate(options.startDate)}
+<DTEND>${formatOfxDate(options.endDate)}
+${transactionsContent}
+</BANKTRANLIST>
+${ledgerBalContent}${availBalContent}</CCSTMTRS>
+</CCSTMTTRNRS>
+</CREDITCARDMSGSRSV1>
+</OFX>`;
+}
 export {
   schemas,
   parseOrThrow,
@@ -365,5 +569,9 @@ export {
   getTransactions,
   getSignOnInfo,
   getBalance,
-  getAccountInfo
+  getAccountInfo,
+  generateHeader,
+  generateCreditCardStatement,
+  generateBankStatement,
+  formatOfxDate
 };

package/package.json

@@ -16,10 +16,12 @@
    },
    "exports": {
       ".": {
+         "bun": "./src/index.ts",
          "import": {
             "default": "./dist/index.js",
             "types": "./dist/index.d.ts"
-         }
+         },
+         "types": "./src/index.ts"
       },
       "./package.json": "./package.json"
    },
@@ -52,6 +54,7 @@
       "lint": "biome check .",
       "lint:fix": "biome check --write .",
       "postinstall": "bun simple-git-hooks",
+      "publish": "bunx npm publish",
       "release": "bumpp --commit --push --tag",
       "test": "bun test",
       "test:coverage": "bun test --coverage",
@@ -63,5 +66,5 @@
    },
    "type": "module",
    "types": "./dist/index.d.ts",
-   "version": "1.2.0"
+   "version": "1.2.1"
 }