@wealthx/borrow-capacity-lib

A centralized TypeScript library for finance data computations used across WealthX applications.

Overview

This package provides a comprehensive set of financial calculations including:

• User Metrics: LVR, equity, excess monthly surplus calculations
• Borrow Capacity: Loan capacity and repayment calculations
• HEM Calculations: Household Expenditure Measure calculations for Australia
• History Data Processing: Scenario finance history aggregation

Installation

yarn add @wealthx/borrow-capacity-lib

Types

The library exports comprehensive TypeScript types for all calculations:

import {
  AccountCategory,
  AccountType,
  UserFinanceData,
  MonthlyFinanceData,
  BorrowCapacityParams,
  HEMCalculationParams,
  PeriodType,
  // ... and many more
} from "@wealthx/borrow-capacity-lib";

Testing

Run the test suite:

yarn test

Run tests with coverage:

yarn test:coverage

Development

Setup

# Use the correct Node.js version
nvm use

# Install dependencies
yarn install

Building

yarn build

Linting

yarn lint
yarn lint:fix

Formula References

• Borrow Capacity: Based on WealthX Finance Documentation

License

UNLICENSED - Private package for WealthX internal use only.

Contributing

This is a private package. Please follow the established patterns and ensure all calculations have corresponding test cases.