@helpu/headless-loan-calculator 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,93 @@
+export declare const VAT_RATES: {
+    readonly NoVat: {
+        readonly rate: 0;
+        readonly label: 'No VAT';
+    };
+    readonly DE: {
+        readonly rate: 0.19;
+        readonly label: 'Germany (19%)';
+    };
+    readonly UK: {
+        readonly rate: 0.2;
+        readonly label: 'UK (20%)';
+    };
+    readonly FR: {
+        readonly rate: 0.2;
+        readonly label: 'France (20%)';
+    };
+    readonly EU: {
+        readonly rate: 0.21;
+        readonly label: 'EU Standard (21%)';
+    };
+    readonly IT: {
+        readonly rate: 0.22;
+        readonly label: 'Italy (22%)';
+    };
+    readonly ES: {
+        readonly rate: 0.21;
+        readonly label: 'Spain (21%)';
+    };
+    readonly HU: {
+        readonly rate: 0.27;
+        readonly label: 'Hungary (27%)';
+    };
+    readonly Custom: {
+        readonly rate: 0;
+        readonly label: 'Custom Rate';
+    };
+};
+export type VATRateKey = keyof typeof VAT_RATES;
+export type PriceMode = 'gross' | 'net';
+export type LoanType = 'closed' | 'open';
+export type Currency = 'HUF' | 'EUR' | 'USD' | 'GBP' | 'JPY' | 'CNY' | 'AUD' | 'CAD' | 'CHF' | 'NZD' | 'SEK' | 'NOK' | 'DKK' | 'SGD' | 'HKD' | 'KRW' | 'MXN' | 'BRL' | 'INR' | 'RUB' | 'ZAR' | 'PLN' | 'TRY' | 'AED' | 'SAR' | 'THB' | 'MYR' | 'IDR' | 'PHP' | 'CZK' | 'ILS' | 'RON' | 'CLP' | 'ARS' | 'COP' | 'PEN';
+export interface MonthlyPayment {
+    month: number;
+    netAmount: number;
+    vatAmount: number;
+    grossAmount: number;
+    interestAmount: number;
+    monthlyPayment: number;
+    principalBalance: number;
+}
+export interface CurrencyConfig {
+    symbol: string;
+    code: string;
+    name?: string;
+    position: 'before' | 'after';
+    decimalPlaces: number;
+    thousandsSeparator: string;
+    decimalSeparator: string;
+    region?: 'Europe' | 'Americas' | 'Asia' | 'Middle East and Africa' | 'Oceania' | 'Other';
+}
+export interface LoanCalculationInput {
+    price: number;
+    loanTermMonths: number;
+    apr: number;
+    initialPayment?: number;
+    residualValue?: number;
+    loanType: LoanType;
+    priceMode: PriceMode;
+    vatRate: number;
+}
+export interface LoanCalculationResult {
+    totalFinancedAmount: number;
+    totalInterestAmount: number;
+    totalVatAmount: number;
+    totalRepayment: number;
+    monthlyPayment: number;
+    paymentSchedule: MonthlyPayment[];
+    input: LoanCalculationInput;
+}
+export interface LoanCalculationError {
+    code: 'INVALID_PRICE' | 'INVALID_TERM' | 'INVALID_APR' | 'INITIAL_PAYMENT_TOO_HIGH' | 'RESIDUAL_VALUE_TOO_HIGH' | 'INVALID_INPUT';
+    message: string;
+    field?: string;
+}
+export type LoanCalculationResultOrError = {
+    success: true;
+    data: LoanCalculationResult;
+} | {
+    success: false;
+    error: LoanCalculationError;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;aACpB,KAAK;iBAAI,IAAI,EAAE,CAAG;iBAAE,KAAK,EAAE,QAAQ;;aACnC,EAAE;iBAAI,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,eAAe;;aACxC,EAAE;iBAAI,IAAI,EAAE,GAAG;iBAAE,KAAK,EAAE,UAAU;;aAClC,EAAE;iBAAI,IAAI,EAAE,GAAG;iBAAE,KAAK,EAAE,cAAc;;aACtC,EAAE;iBAAI,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,mBAAmB;;aAC5C,EAAE;iBAAI,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,aAAa;;aACtC,EAAE;iBAAI,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,aAAa;;aACtC,EAAE;iBAAI,IAAI,EAAE,IAAI;iBAAE,KAAK,EAAE,eAAe;;aACxC,MAAM;iBAAI,IAAI,EAAE,CAAG;iBAAE,KAAK,EAAE,aAAa;;CACjC,CAAA;AACV,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,SAAS,CAAA;AAC/C,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,CAAA;AACvC,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AACxC,MAAM,MAAM,QAAQ,GAChB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAA;AACT,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AACD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAA;IAC5B,aAAa,EAAE,MAAM,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,gBAAgB,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,wBAAwB,GAAG,SAAS,GAAG,OAAO,CAAA;CACzF;AACD,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,QAAQ,CAAA;IAClB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB;AACD,MAAM,WAAW,qBAAqB;IACpC,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,cAAc,EAAE,CAAA;IACjC,KAAK,EAAE,oBAAoB,CAAA;CAC5B;AACD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EACA,eAAe,GACf,cAAc,GACd,aAAa,GACb,0BAA0B,GAC1B,yBAAyB,GACzB,eAAe,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AACD,MAAM,MAAM,4BAA4B,GACpC;IACE,OAAO,EAAE,IAAI,CAAA;IACb,IAAI,EAAE,qBAAqB,CAAA;CAC5B,GACD;IACE,OAAO,EAAE,KAAK,CAAA;IACd,KAAK,EAAE,oBAAoB,CAAA;CAC5B,CAAA"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@helpu/headless-loan-calculator",
+  "version": "1.0.0",
+  "description": "A headless, framework-agnostic loan calculator with support for VAT, multiple currencies, and amortization schedules",
+  "keywords": [
+    "loan",
+    "calculator",
+    "finance",
+    "amortization",
+    "mortgage",
+    "leasing",
+    "vat",
+    "currency",
+    "headless"
+  ],
+  "author": "HelpU Finance",
+  "license": "PolyForm-Noncommercial-1.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/helpufinance/headless-loan-calculator.git"
+  },
+  "homepage": "https://github.com/helpufinance/headless-loan-calculator#readme",
+  "bugs": {
+    "url": "https://github.com/helpufinance/headless-loan-calculator/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "COMMERCIAL-LICENSING.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "rolldown -c rolldown.config.ts && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "dev": "rolldown -c rolldown.config.ts --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "lint": "oxlint src/*.ts tests/*.ts",
+    "lint:fix": "oxlint --fix src/*.ts tests/*.ts",
+    "format": "oxfmt src/*.ts tests/*.ts rolldown.config.ts vitest.config.ts",
+    "format:check": "oxfmt --check src/*.ts tests/*.ts rolldown.config.ts vitest.config.ts",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^26.4.1",
+    "@vitest/coverage-v8": "^5.0.0",
+    "oxfmt": "^0.67.0",
+    "oxlint": "^1.82.0",
+    "rolldown": "^1.2.8",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.0"
+  }
+}