@helpu/headless-loan-calculator 1.0.0

package/COMMERCIAL-LICENSING.md

@@ -0,0 +1,17 @@
+# Commercial Licensing
+
+This software is available for permitted non-commercial use under the PolyForm Noncommercial License 1.0.0.
+
+Commercial use requires a separate license from Omisai Technologies.
+
+Organizations wishing to use this software in connection with a commercial product, service, platform, internal business activity, client engagement, SaaS offering, financial service, or other commercial activity should contact Omisai Technologies to discuss commercial licensing.
+
+Commercial licensing revenue supports the HelpU Finance mission of creating freely accessible financial tools, educational resources, and technology for the public.
+
+## Commercial Licensing Contact
+
+Commercial licensing: Please contact Omisai Technologies through its [official website](https://omisai.com/licensing).
+
+Copyright (c) 2026 Omisai Technologies.
+
+HelpU Finance is a project and brand of Omisai Technologies.

package/LICENSE

@@ -0,0 +1,64 @@
+Required Notice: Copyright (c) 2026 Omisai Technologies
+Required Notice: HelpU Finance is a project and brand of Omisai Technologies.
+Required Notice: Commercial licensing is available separately from Omisai Technologies.
+
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,290 @@
+<p align="center">
+  <a href="https://github.com/helpufinance/helpu.finance">
+    <img src="https://raw.githubusercontent.com/helpufinance/.github/refs/heads/main/profile/assets/helpu_finance.png" alt="HelpU Finance" width="260">
+  </a>
+</p>
+
+# Headless Loan Calculator
+
+A headless, framework-agnostic loan calculator with support for VAT, multiple currencies, and full amortization schedules. Zero dependencies, works in Node.js, Bun, and browsers.
+
+## What is HelpU Finance?
+
+HelpU Finance is a free, privacy-first platform with financial tools and educational resources. No tracking, no data collection.
+
+We believe that financial literacy should be accessible to everyone.
+
+## Features
+
+- **Full amortization schedule** - Get detailed month-by-month payment breakdown
+- **VAT support** - Calculate with net or gross prices, with configurable VAT rates
+- **Multi-currency** - Support for 35+ currencies with proper formatting
+- **Open & Closed loans** - Support for both traditional loans and balloon payment structures
+- **Zero dependencies** - Lightweight and fast
+- **TypeScript first** - Full type safety and IntelliSense support
+- **Universal** - Works with Node.js, Bun, and in browsers
+
+## Installation
+
+```bash
+# npm
+npm install @helpu/headless-loan-calculator
+
+# yarn
+yarn add @helpu/headless-loan-calculator
+
+# pnpm
+pnpm add @helpu/headless-loan-calculator
+
+# bun
+bun add @helpu/headless-loan-calculator
+```
+
+## Usage
+
+```typescript
+import { calculateLoan, formatCurrency } from '@helpu/headless-loan-calculator'
+
+const result = calculateLoan({
+  price: 25000,           // Total price
+  loanTermMonths: 60,     // 5 years
+  apr: 6.5,               // 6.5% APR
+  initialPayment: 5000,   // $5,000 down payment
+  residualValue: 0,       // No balloon payment
+  loanType: 'closed',     // Standard loan
+  priceMode: 'gross',     // Price includes VAT
+  vatRate: 0.21,          // 21% VAT
+})
+
+if (result.success) {
+  console.log('Monthly payment:', formatCurrency('USD', result.data.monthlyPayment))
+  console.log('Total interest:', formatCurrency('USD', result.data.totalInterestAmount))
+  console.log('Total repayment:', formatCurrency('USD', result.data.totalRepayment))
+}
+```
+
+## API Reference
+
+### `calculateLoan(input)`
+
+Calculate a complete loan with amortization schedule.
+
+```typescript
+interface LoanCalculationInput {
+  price: number
+  loanTermMonths: number
+  apr: number
+  initialPayment?: number
+  residualValue?: number
+  loanType: 'closed' | 'open'
+  priceMode: 'gross' | 'net'
+  vatRate: number
+}
+```
+
+Returns a result object:
+
+```typescript
+interface LoanCalculationResult {
+  totalFinancedAmount: number
+  totalInterestAmount: number
+  totalVatAmount: number
+  totalRepayment: number
+  monthlyPayment: number
+  paymentSchedule: MonthlyPayment[]
+  input: LoanCalculationInput
+}
+```
+
+### `calculateMonthlyPayment(principal, monthlyRate, termMonths)`
+
+Calculate the monthly payment for a loan using the amortization formula.
+
+```typescript
+import { calculateMonthlyPayment } from '@helpu/headless-loan-calculator'
+
+const monthlyPayment = calculateMonthlyPayment(
+  20000,      // Principal
+  0.005,      // Monthly rate (6% APR / 12)
+  60          // Term in months
+)
+```
+
+### `calculateAffordableLoan(monthlyPayment, monthlyRate, termMonths)`
+
+Calculate how much you can borrow based on a desired monthly payment.
+
+```typescript
+import { calculateAffordableLoan } from '@helpu/headless-loan-calculator'
+
+const maxLoan = calculateAffordableLoan(
+  500,        // Desired monthly payment
+  0.005,      // Monthly rate
+  60          // Term in months
+)
+```
+
+### `formatCurrency(currency, amount)`
+
+Format a number as currency with proper locale-specific formatting.
+
+```typescript
+import { formatCurrency } from '@helpu/headless-loan-calculator'
+
+formatCurrency('EUR', 1234.56)  // "1 234,56 €"
+formatCurrency('USD', 1234.56)  // "$1,234.56"
+formatCurrency('HUF', 123456)   // "123 456 Ft"
+```
+
+### `getVatRate(vatRateKey, customRate?)`
+
+Get the VAT rate for a specific region.
+
+```typescript
+import { getVatRate } from '@helpu/headless-loan-calculator'
+
+getVatRate('EU')              // 0.21 (21%)
+getVatRate('DE')              // 0.19 (19%)
+getVatRate('Custom', 15)      // 0.15 (15%)
+```
+
+## Loan Types
+
+### Closed Loan (Standard)
+
+Traditional loan where the full amount is financed and paid off over the term.
+
+```typescript
+const result = calculateLoan({
+  price: 30000,
+  loanTermMonths: 48,
+  apr: 5.9,
+  loanType: 'closed',
+  priceMode: 'gross',
+  vatRate: 0.21,
+})
+```
+
+### Open Loan (Balloon Payment)
+
+Loan with a residual value that is paid as a lump sum at the end.
+
+```typescript
+const result = calculateLoan({
+  price: 30000,
+  loanTermMonths: 48,
+  apr: 5.9,
+  residualValue: 10000,  // Balloon payment at end
+  loanType: 'open',
+  priceMode: 'gross',
+  vatRate: 0.21,
+})
+```
+
+## Price Modes
+
+### Gross Mode (Default)
+
+Use when the price includes VAT. Common for consumer/retail scenarios.
+
+```typescript
+const result = calculateLoan({
+  price: 12100,
+  priceMode: 'gross',
+  vatRate: 0.21,
+  ...
+})
+```
+
+### Net Mode
+
+Use when the price excludes VAT. Common for B2B scenarios where VAT can be deducted.
+
+```typescript
+const result = calculateLoan({
+  price: 10000,
+  priceMode: 'net',
+  vatRate: 0.21,
+  ...
+})
+```
+
+## Supported Currencies
+
+The library supports 35+ currencies across all regions:
+
+- **Europe**: EUR, GBP, CHF, SEK, NOK, DKK, PLN, CZK, RON, HUF
+- **Americas**: USD, CAD, MXN, BRL, ARS, CLP, COP, PEN
+- **Asia**: JPY, CNY, HKD, KRW, SGD, INR, THB, MYR, IDR, PHP
+- **Middle East & Africa**: AED, SAR, ILS, ZAR
+- **Oceania**: AUD, NZD
+- **Other**: RUB, TRY
+
+## Error Handling
+
+The library uses a Result type pattern for safe error handling:
+
+```typescript
+const result = calculateLoan(input)
+
+if (result.success) {
+  console.log(result.data.monthlyPayment)
+} else {
+  console.error(result.error.code, result.error.message)
+}
+```
+
+Possible error codes:
+
+- `INVALID_PRICE` - Price must be a positive number
+- `INVALID_TERM` - Loan term must be a positive integer
+- `INVALID_APR` - APR must be a non-negative number
+- `INITIAL_PAYMENT_TOO_HIGH` - Initial payment exceeds price
+- `RESIDUAL_VALUE_TOO_HIGH` - Residual value exceeds financed amount
+
+## TypeScript Support
+
+Full TypeScript support with exported types:
+
+```typescript
+import type {
+  LoanCalculationInput,
+  LoanCalculationResult,
+  MonthlyPayment,
+  Currency,
+  LoanType,
+  PriceMode,
+} from '@helpu/headless-loan-calculator'
+```
+
+## Testing
+
+Install the repository dependencies and run the test suite with:
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome. Please read the [contribution guidelines](https://docs.omisai.com/contribution-guidelines) before opening a pull request.
+
+## Sponsor
+
+Support HelpU Finance through [GitHub Sponsors](https://github.com/sponsors/helpufinance).
+
+## License
+
+This project is available for permitted non-commercial use under the **PolyForm Noncommercial License 1.0.0**.
+
+Personal learning, education, research, experimentation, and other uses permitted by the PolyForm Noncommercial License are welcome.
+
+**Commercial use requires a separate license from Omisai Technologies.**
+
+Commercial licensing helps fund the HelpU Finance mission of creating freely accessible financial tools, educational resources, and technology.
+
+For commercial licensing, see [`COMMERCIAL-LICENSING.md`](./COMMERCIAL-LICENSING.md).
+
+Copyright (c) 2026 Omisai Technologies.
+
+HelpU Finance is a project and brand of Omisai Technologies.

package/dist/calculator.d.ts

@@ -0,0 +1,8 @@
+import type { LoanCalculationError, LoanCalculationInput, LoanCalculationResultOrError } from './types';
+export declare function validateInput(input: LoanCalculationInput): LoanCalculationError | null;
+export declare function calculateMonthlyPayment(principal: number, monthlyRate: number, termMonths: number): number;
+export declare function calculateLoan(input: LoanCalculationInput): LoanCalculationResultOrError;
+export declare function calculateAffordableLoan(monthlyPayment: number, monthlyRate: number, termMonths: number): number;
+export declare function calculateTotalInterest(principal: number, monthlyPayment: number, termMonths: number): number;
+export declare function getVatRate(vatRateKey: string, customRate?: number): number;
+//# sourceMappingURL=calculator.d.ts.map

package/dist/calculator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator.d.ts","sourceRoot":"","sources":["../src/calculator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EAEpB,4BAA4B,EAE7B,MAAM,SAAS,CAAA;AAChB,wBAAgB,aAAa,CAAC,KAAK,EAAE,oBAAoB,GAAG,oBAAoB,GAAG,IAAI,CA4CtF;AACD,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,MAAM,CAMR;AACD,wBAAgB,aAAa,CAAC,KAAK,EAAE,oBAAoB,GAAG,4BAA4B,CA2IvF;AACD,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,MAAM,CAMR;AACD,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,GACjB,MAAM,CAER;AACD,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAgB1E"}

package/dist/currency.d.ts

@@ -0,0 +1,7 @@
+import type { Currency, CurrencyConfig } from './types';
+export declare const CURRENCY_CONFIG: Record<Currency, CurrencyConfig>;
+export declare function formatCurrency(currency: Currency, amount: number): string;
+export declare function getCurrencyConfig(currency: Currency): CurrencyConfig;
+export declare function getSupportedCurrencies(): Currency[];
+export declare function getCurrenciesByRegion(region: CurrencyConfig['region']): Currency[];
+//# sourceMappingURL=currency.d.ts.map

package/dist/currency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../src/currency.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACvD,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,QAAQ,EAAE,cAAc,CAyW5D,CAAA;AACD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBzE;AACD,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,cAAc,CAEpE;AACD,wBAAgB,sBAAsB,IAAI,QAAQ,EAAE,CAEnD;AACD,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,QAAQ,EAAE,CAIlF"}