pinoy-kredit-parser 1.1.2 → 1.2.1

package/README.MD

@@ -1,6 +1,6 @@
 # pinoy-kredit-parser
 
-A lightweight Node.js library for parsing Philippine credit card statement PDFs into structured transaction data.
+A lightweight, isomorphic library for parsing Philippine credit card statement PDFs into structured transaction data. Works in Node.js, Browsers, and Next.js.
 
 Currently supports:
 
@@ -39,44 +39,50 @@ npm install pinoy-kredit-parser
 ---
 
 ## Usage
+The library automatically detects your environment (Node vs. Browser) to provide the correct parsing engine.
+
 ### Using a file path (Node.js)
 ```javascript
-const { parseKredit, BankType } = require('pinoy-kredit-parser')
+import { parseKredit, BankType } from 'pinoy-kredit-parser';
 
-async function main() {
-  const transactions = await parseKredit('statement.pdf', {
+const transactions = await parseKredit('./statement.pdf', {
     bank: BankType.RCBC,
-  })
-
-  console.log(transactions)
-}
-
-main()
+});
 ```
-### Using a File object (Browser / modern runtimes)
+### Browser / Next.js Client Components (File or ArrayBuffer)
 ```javascript
-import { parseKredit, BankType } from 'pinoy-kredit-parser'
-
-async function handleFile(file) {
-  const transactions = await parseKredit(file, {
-    bank: BankType.METROBANK,
-  })
+import { parseKredit, BankType } from 'pinoy-kredit-parser';
+
+const handleUpload = async (event) => {
+    const file = event.target.files[0];
+    const transactions = await parseKredit(file, {
+        bank: BankType.UNIONBANK,
+    });
+};
+```
 
-  console.log(transactions)
-}
+### Next.js (App Router / API Routes)
+When using this library in Next.js, you must add it to `serverExternalPackages` in your `next.config.ts` to correctly handle the native PDF rendering binaries.
+```javascript
+// next.config.ts
+const nextConfig = {
+  experimental: {
+    serverExternalPackages: ['pinoy-kredit-parser', 'pdf-parse', '@napi-rs/canvas'],
+  },
+};
 ```
 
 ---
 
 ## Output Format
 
-Each transaction is returned as:
+Transactions are returned in a clean, structured format:
 ```typescript
 type KreditTransaction = {
-  saleDate: string
-  postDate: string
-  description: string
-  amount: number
+  saleDate: string;    // MM/DD/YY
+  postDate: string;    // MM/DD/YY
+  description: string;
+  amount: number;      // Positive for purchases, negative for payments/credits
 }
 ```
 Example:
@@ -90,6 +96,12 @@ Example:
   }
 ]
 ```
+---
+## Features
+- **Isomorphic:** Shared logic for server-side and client-side parsing.
+- **Zero Global Pollution:** No need for manual DOMMatrix or Canvas polyfills.
+- **Next.js Ready:** Optimized for modern frameworks with automatic environment detection.
+- **Privacy-First:** All parsing happens locally on your machine. No data is ever sent to a server.
 
 ---
 

package/dist/browser.d.ts

@@ -0,0 +1,6 @@
+import { BankType } from './types';
+export * from './types';
+type BrowserInput = File | Blob | ArrayBuffer | Uint8Array;
+export declare const parseKredit: (input: BrowserInput, options: {
+    bank: BankType;
+}) => Promise<import("./types").KreditTransaction[]>;

package/dist/{index.js → browser.js}

@@ -14,6 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseKredit = void 0;
+const core_1 = require("./core");
 __exportStar(require("./types"), exports);
-__exportStar(require("./parseKredit"), exports);
-//# sourceMappingURL=index.js.map
+const parseKredit = async (input, options) => {
+    const data = input instanceof File || input instanceof Blob ? await input.arrayBuffer() : input;
+    return (0, core_1.baseParseKredit)(new Uint8Array(data), options);
+};
+exports.parseKredit = parseKredit;
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iCAAwC;AAGxC,0CAAuB;AAIhB,MAAM,WAAW,GAAG,KAAK,EAAE,KAAmB,EAAE,OAA2B,EAAE,EAAE;IACpF,MAAM,IAAI,GAAG,KAAK,YAAY,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;IAE/F,OAAO,IAAA,sBAAe,EAAC,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC,CAAA;AAJY,QAAA,WAAW,eAIvB"}

package/dist/core.d.ts

@@ -0,0 +1,5 @@
+import { BankType, KreditTransaction } from './types';
+export declare const baseParseKredit: (data: Buffer | Uint8Array, options: {
+    bank: BankType;
+    CanvasFactory?: any;
+}) => Promise<KreditTransaction[]>;

package/dist/{parseKredit.js → core.js}

@@ -1,24 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseKredit = void 0;
+exports.baseParseKredit = void 0;
 const pdf_parse_1 = require("pdf-parse");
 const types_1 = require("./types");
 const rcbc_1 = require("./parsers/rcbc");
 const metrobank_1 = require("./parsers/metrobank");
 const unionbank_1 = require("./parsers/unionbank");
-const node_fs_1 = require("node:fs");
-const parseKredit = async (input, options) => {
-    let buffer;
-    if (typeof input === 'string') {
-        buffer = (0, node_fs_1.readFileSync)(input);
-    }
-    else {
-        const arrayBuffer = await input.arrayBuffer();
-        buffer = Buffer.from(arrayBuffer);
-    }
-    const parser = new pdf_parse_1.PDFParse({ data: buffer });
-    const textResult = await parser.getText();
-    const text = textResult.text;
+const baseParseKredit = async (data, options) => {
+    const parser = new pdf_parse_1.PDFParse({
+        data: Buffer.from(data),
+        CanvasFactory: options.CanvasFactory,
+    });
+    const { text } = await parser.getText();
     switch (options.bank) {
         case types_1.BankType.RCBC:
             return (0, rcbc_1.parseRCBC)(text);
@@ -30,5 +23,5 @@ const parseKredit = async (input, options) => {
             throw new Error('Unsupported bank type');
     }
 };
-exports.parseKredit = parseKredit;
-//# sourceMappingURL=parseKredit.js.map
+exports.baseParseKredit = baseParseKredit;
+//# sourceMappingURL=core.js.map

package/dist/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AACpC,mCAAqD;AACrD,yCAA0C;AAC1C,mDAAoD;AACpD,mDAAoD;AAE7C,MAAM,eAAe,GAAG,KAAK,EAClC,IAAyB,EACzB,OAAgD,EAClB,EAAE;IAChC,MAAM,MAAM,GAAG,IAAI,oBAAQ,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,aAAa,EAAE,OAAO,CAAC,aAAa;KACrC,CAAC,CAAA;IAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAA;IAEvC,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,gBAAQ,CAAC,IAAI;YAChB,OAAO,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAA;QACxB,KAAK,gBAAQ,CAAC,SAAS;YACrB,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAA;QAC7B,KAAK,gBAAQ,CAAC,SAAS;YACrB,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAA;QAC7B;YACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAA;AArBY,QAAA,eAAe,mBAqB3B"}

package/dist/node.d.ts

@@ -0,0 +1,6 @@
+import { BankType } from './types';
+export * from './types';
+type NodeInput = string | Buffer | Uint8Array;
+export declare const parseKredit: (input: NodeInput, options: {
+    bank: BankType;
+}) => Promise<import("./types").KreditTransaction[]>;

package/dist/node.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseKredit = void 0;
+const node_fs_1 = require("node:fs");
+const worker_1 = require("pdf-parse/worker");
+const core_1 = require("./core");
+__exportStar(require("./types"), exports);
+const parseKredit = async (input, options) => {
+    const buffer = typeof input === 'string' ? (0, node_fs_1.readFileSync)(input) : input;
+    return (0, core_1.baseParseKredit)(buffer, { ...options, CanvasFactory: worker_1.CanvasFactory });
+};
+exports.parseKredit = parseKredit;
+//# sourceMappingURL=node.js.map

package/dist/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qCAAsC;AACtC,6CAAgD;AAChD,iCAAwC;AAGxC,0CAAuB;AAIhB,MAAM,WAAW,GAAG,KAAK,EAAE,KAAgB,EAAE,OAA2B,EAAE,EAAE;IACjF,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAEtE,OAAO,IAAA,sBAAe,EAAC,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,aAAa,EAAb,sBAAa,EAAE,CAAC,CAAA;AAC/D,CAAC,CAAA;AAJY,QAAA,WAAW,eAIvB"}

package/package.json

@@ -1,9 +1,24 @@
 {
   "name": "pinoy-kredit-parser",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "description": "Philippine credit card statement parser",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/node.js",
+  "browser": "./dist/browser.js",
+  "types": "./dist/node.d.ts",
+  "exports": {
+    ".": {
+      "node": {
+        "types": "./dist/node.d.ts",
+        "import": "./dist/node.js",
+        "require": "./dist/node.js"
+      },
+      "browser": {
+        "types": "./dist/browser.d.ts",
+        "import": "./dist/browser.js"
+      },
+      "default": "./dist/browser.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/baldonharris/pinoy-kredit-parser.git"
@@ -16,7 +31,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf dist && tsc",
     "format": "prettier --write 'src/**/*.ts'",
     "format:check": "prettier --check 'src/**/*.ts'",
     "prepublishOnly": "npm run build"

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './parseKredit';

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,gDAA6B"}

package/dist/parseKredit.d.ts

@@ -1,7 +0,0 @@
-import { BankType, KreditTransaction } from './types';
-type Input = File | string;
-type ParseKredit = (file: Input, options: {
-    bank: BankType;
-}) => Promise<KreditTransaction[]>;
-export declare const parseKredit: ParseKredit;
-export {};

package/dist/parseKredit.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parseKredit.js","sourceRoot":"","sources":["../src/parseKredit.ts"],"names":[],"mappings":";;;AAAA,yCAAoC;AACpC,mCAAqD;AACrD,yCAA0C;AAC1C,mDAAoD;AACpD,mDAAoD;AACpD,qCAAsC;AAI/B,MAAM,WAAW,GAAgB,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAC/D,IAAI,MAAc,CAAA;IAElB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;SAAM,CAAC;QACN,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAA;QAC7C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,oBAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IAC7C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAA;IAEzC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;IAE5B,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,gBAAQ,CAAC,IAAI;YAChB,OAAO,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAA;QAExB,KAAK,gBAAQ,CAAC,SAAS;YACrB,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAA;QAE7B,KAAK,gBAAQ,CAAC,SAAS;YACrB,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAA;QAE7B;YACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAA;AA5BY,QAAA,WAAW,eA4BvB"}