moneyfunx 0.0.39 → 0.0.41

package/build/index.d.ts

@@ -1,6 +1,6 @@
 export { PaymentTooLowError } from "./lib/errors";
 export { calculateMinPayment, numPaymentsToZero, principalRemaining, interestPaid, } from "./lib/helperFunctions";
-export { ILoan, Loan } from "./lib/loan";
+export { type ILoan, Loan } from "./lib/loan";
 export { determineExtraPayment, amortizePayments, payLoans, } from "./lib/payments";
-export { AmortizationRecord, LoansPaymentSummary, PaymentSummary, } from "./lib/paymentTypes";
+export { type AmortizationRecord, type LoansPaymentSummary, type PaymentSummary, } from "./lib/paymentTypes";
 export { snowball, avalanche, sortLoans } from "./lib/sorting";

package/build/lib/paymentTypes.d.ts

@@ -6,11 +6,8 @@ export interface AmortizationRecord {
 }
 export interface PaymentSummary {
     lifetimeInterest: number;
-    amortizationSchedule: Array<AmortizationRecord>;
-}
-export interface LoansPaymentSummary {
-    [id: string]: PaymentSummary;
-}
-export interface LoanPrincipals {
-    [id: string]: number;
+    lifetimePrincipal: number;
+    amortizationSchedule: AmortizationRecord[];
 }
+export type LoansPaymentSummary = Record<string, PaymentSummary>;
+export type LoanPrincipals = Record<string, number>;

package/build/lib/payments.d.ts

@@ -3,8 +3,8 @@
  * This file contains functions for computing detailed information on paying loans
  *
  */
-import { ILoan, Loan } from "./loan";
-import { AmortizationRecord, LoansPaymentSummary } from "./paymentTypes";
+import type { ILoan, Loan } from "./loan";
+import type { AmortizationRecord, LoansPaymentSummary } from "./paymentTypes";
 /**
  *
  * Calculates the extra amount in a payment after all loans' minimum payments are met
@@ -14,7 +14,7 @@ import { AmortizationRecord, LoansPaymentSummary } from "./paymentTypes";
  * @param {number} payment The amount to pay across all loans
  * @returns {number} The extra amount of payment
  */
-export declare function determineExtraPayment(loans: Array<ILoan>, payment: number): number;
+export declare function determineExtraPayment(loans: ILoan[], payment: number): number;
 /**
  *
  * Calculates the amortization schedule for a loan paid with a payment
@@ -25,7 +25,7 @@ export declare function determineExtraPayment(loans: Array<ILoan>, payment: numb
  * @param {number} startPeriod An initial offset of periods to "fast-forward" the state of the loan to prior to calculation of each period
  * @returns {Array<AmortizationRecord>} The amortization schdule for the number of payments of payment made to the loan from the provided start period
  */
-export declare function amortizePayments(loan: Loan, principal: number, payment: number, numPayments: number, startPeriod?: number, carryover?: number): Array<AmortizationRecord>;
+export declare function amortizePayments(loan: Loan, principal: number, payment: number, numPayments: number, startPeriod?: number, carryover?: number): AmortizationRecord[];
 /**
  *
  * Calculates a wealth of information about paying of a set of loans with a total payment amount

package/build/lib/payments.js

@@ -16,7 +16,8 @@ import * as helpers from "./helperFunctions";
  */
 export function determineExtraPayment(loans, payment) {
     const totalMinPayment = loans.reduce((previousValue, currentValue) => previousValue + currentValue.minPayment, 0);
-    if (totalMinPayment > payment) {
+    // hack to get around floating precision adjustments
+    if (parseFloat(totalMinPayment.toFixed(2)) > parseFloat(payment.toFixed(2))) {
         throw new errors.PaymentTooLowError(`Payment amount of ${payment} must be greater than ${totalMinPayment}`);
     }
     return payment - totalMinPayment;
@@ -43,13 +44,15 @@ export function amortizePayments(loan, principal, payment, numPayments, startPer
     const amortizationSchedule = [];
     for (let period = 0; period < numPayments; period++) {
         const interestThisPeriod = loan.accrueInterest(principalRemaining);
-        const principalThisPeriod = Math.min((period === numPayments - 1 ? payment + carryover : payment) - interestThisPeriod, principalRemaining);
+        const principalThisPeriod = Math.min((period === numPayments - 1
+            ? payment + carryover
+            : payment) - interestThisPeriod, principalRemaining);
         principalRemaining -= principalThisPeriod;
         amortizationSchedule.push({
             period: startPeriod + period + 1,
             principal: principalThisPeriod,
             interest: interestThisPeriod,
-            principalRemaining: principalRemaining,
+            principalRemaining,
         });
     }
     return amortizationSchedule;
@@ -68,13 +71,18 @@ export function payLoans(loans, payment, reduceMinimum = false) {
     let monthlyPayment = payment;
     const paymentData = {};
     const loanPrincipalsRemaining = {};
-    loans.map((loan) => {
-        paymentData[loan.id] = { lifetimeInterest: 0, amortizationSchedule: [] };
+    loans.forEach((loan) => {
+        paymentData[loan.id] = {
+            lifetimeInterest: 0,
+            lifetimePrincipal: loan.principal,
+            amortizationSchedule: []
+        };
         loanPrincipalsRemaining[loan.id] = loan.principal;
     });
     let periodsElapsed = 0;
     let paidLoans = 0;
     let totalLifetimeInterest = 0;
+    let totalLifetimePrincipal = 0;
     let totalAmortizationSchedule = [];
     while (paidLoans < loans.length) {
         const firstLoan = loans.slice(paidLoans)[0];
@@ -104,7 +112,7 @@ export function payLoans(loans, payment, reduceMinimum = false) {
             loanPrincipalsRemaining[loan.id] = paymentData[loan.id].amortizationSchedule[paymentData[loan.id].amortizationSchedule.length - 1].principalRemaining;
             totalAmortizationSchedule = totalAmortizationSchedule.map((element) => {
                 const matchedInnerElement = paidPeriods.find((innerElement) => innerElement.period === element.period);
-                return matchedInnerElement
+                return (matchedInnerElement != null)
                     ? {
                         period: element.period,
                         principal: element.principal + matchedInnerElement.principal,
@@ -121,12 +129,15 @@ export function payLoans(loans, payment, reduceMinimum = false) {
         periodsElapsed += periodsToPay;
     }
     for (const loan of loans) {
-        const loanLifetimeInterest = paymentData[loan.id].amortizationSchedule.reduce((acc, curval) => acc + curval.interest, 0);
+        const loanLifetimeInterest = (paymentData[loan.id].amortizationSchedule.reduce((acc, curval) => acc + curval.interest, 0));
         paymentData[loan.id].lifetimeInterest = loanLifetimeInterest;
+        paymentData[loan.id].lifetimePrincipal = loan.principal;
         totalLifetimeInterest += loanLifetimeInterest;
+        totalLifetimePrincipal += loan.principal;
     }
-    paymentData["totals"] = {
+    paymentData.totals = {
         lifetimeInterest: totalLifetimeInterest,
+        lifetimePrincipal: totalLifetimePrincipal,
         amortizationSchedule: totalAmortizationSchedule
     };
     return paymentData;

package/build/lib/sorting.d.ts

@@ -3,7 +3,7 @@
  * This file contains functions for sorting Arrays of Loans on certain attributes
  *
  */
-import { ILoan } from "./loan";
+import { type ILoan } from "./loan";
 type avalanche = (loan1: ILoan, loan2: ILoan) => number;
 type snowball = (loan1: ILoan, loan2: ILoan) => number;
 type sortFunction = avalanche | snowball;
@@ -27,5 +27,5 @@ export declare function snowball(loan1: ILoan, loan2: ILoan): number;
  * @param {function} sortFunc The algorithm to sort the loans with
  * @returns The sorted array loans
  */
-export declare function sortLoans(loans: Array<ILoan>, sortFunction: sortFunction): ILoan[];
+export declare function sortLoans(loans: ILoan[], sortFunction: sortFunction): ILoan[];
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "moneyfunx",
   "type": "module",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "description": "MoneyFunx is a small library of functions for financial computations, with a focus on personal finance",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/src/index.ts

@@ -5,15 +5,15 @@ export {
   principalRemaining,
   interestPaid,
 } from "./lib/helperFunctions";
-export { ILoan, Loan } from "./lib/loan";
+export { type ILoan, Loan } from "./lib/loan";
 export {
   determineExtraPayment,
   amortizePayments,
   payLoans,
 } from "./lib/payments";
 export {
-  AmortizationRecord,
-  LoansPaymentSummary,
-  PaymentSummary,
+  type AmortizationRecord,
+  type LoansPaymentSummary,
+  type PaymentSummary,
 } from "./lib/paymentTypes";
 export { snowball, avalanche, sortLoans } from "./lib/sorting";

package/src/lib/paymentTypes.ts

@@ -7,13 +7,10 @@ export interface AmortizationRecord {
 
 export interface PaymentSummary {
   lifetimeInterest: number;
-  amortizationSchedule: Array<AmortizationRecord>;
+  lifetimePrincipal: number;
+  amortizationSchedule: AmortizationRecord[];
 }
 
-export interface LoansPaymentSummary {
-  [id: string]: PaymentSummary;
-}
+export type LoansPaymentSummary = Record<string, PaymentSummary>;
 
-export interface LoanPrincipals {
-  [id: string]: number;
-}
+export type LoanPrincipals = Record<string, number>;

package/src/lib/payments.ts

@@ -6,12 +6,11 @@
 
 import * as errors from "./errors";
 import * as helpers from "./helperFunctions";
-import { ILoan, Loan } from "./loan";
-import {
+import type { ILoan, Loan } from "./loan";
+import type {
   AmortizationRecord,
   LoanPrincipals,
   LoansPaymentSummary,
-  PaymentSummary,
 } from "./paymentTypes";
 
 /**
@@ -24,14 +23,15 @@ import {
  * @returns {number} The extra amount of payment
  */
 export function determineExtraPayment(
-  loans: Array<ILoan>,
+  loans: ILoan[],
   payment: number
 ): number {
   const totalMinPayment = loans.reduce(
     (previousValue, currentValue) => previousValue + currentValue.minPayment,
     0
   );
-  if (totalMinPayment > payment) {
+  // hack to get around floating precision adjustments
+  if (parseFloat(totalMinPayment.toFixed(2)) > parseFloat(payment.toFixed(2))) {
     throw new errors.PaymentTooLowError(
       `Payment amount of ${payment} must be greater than ${totalMinPayment}`
     );
@@ -56,7 +56,7 @@ export function amortizePayments(
   numPayments: number,
   startPeriod: number = 0,
   carryover: number = 0
-): Array<AmortizationRecord> {
+): AmortizationRecord[] {
   if (payment === null) {
     payment = loan.minPayment;
   }
@@ -72,7 +72,9 @@ export function amortizePayments(
   for (let period = 0; period < numPayments; period++) {
     const interestThisPeriod = loan.accrueInterest(principalRemaining);
     const principalThisPeriod = Math.min(
-      (period === numPayments - 1 ? payment + carryover : payment) - interestThisPeriod,
+      (period === numPayments - 1
+        ? payment + carryover
+        : payment) - interestThisPeriod,
       principalRemaining
     );
     principalRemaining -= principalThisPeriod;
@@ -80,7 +82,7 @@ export function amortizePayments(
       period: startPeriod + period + 1,
       principal: principalThisPeriod,
       interest: interestThisPeriod,
-      principalRemaining: principalRemaining,
+      principalRemaining,
     });
   }
   return amortizationSchedule;
@@ -104,14 +106,19 @@ export function payLoans(
   let monthlyPayment = payment;
   const paymentData: LoansPaymentSummary = {};
   const loanPrincipalsRemaining: LoanPrincipals = {};
-  loans.map((loan) => {
-    paymentData[loan.id] = { lifetimeInterest: 0, amortizationSchedule: [] };
+  loans.forEach((loan) => {
+    paymentData[loan.id] = {
+      lifetimeInterest: 0,
+      lifetimePrincipal: loan.principal,
+      amortizationSchedule: []
+    };
     loanPrincipalsRemaining[loan.id] = loan.principal;
   });
 
   let periodsElapsed = 0;
   let paidLoans = 0;
   let totalLifetimeInterest = 0;
+  let totalLifetimePrincipal = 0;
   let totalAmortizationSchedule: AmortizationRecord[] = [];
 
   while (paidLoans < loans.length) {
@@ -180,15 +187,15 @@ export function payLoans(
         const matchedInnerElement = paidPeriods.find(
           (innerElement) => innerElement.period === element.period
         );
-        return matchedInnerElement
+        return (matchedInnerElement != null)
           ? {
-              period: element.period,
-              principal: element.principal + matchedInnerElement.principal,
-              interest: element.interest + matchedInnerElement.interest,
-              principalRemaining:
-                element.principalRemaining +
-                matchedInnerElement.principalRemaining
-            }
+            period: element.period,
+            principal: element.principal + matchedInnerElement.principal,
+            interest: element.interest + matchedInnerElement.interest,
+            principalRemaining:
+              element.principalRemaining +
+              matchedInnerElement.principalRemaining
+          }
           : element;
       });
     });
@@ -200,13 +207,21 @@ export function payLoans(
   }
 
   for (const loan of loans) {
-    const loanLifetimeInterest = paymentData[loan.id].amortizationSchedule.reduce((acc, curval) => acc + curval.interest, 0);
+    const loanLifetimeInterest = (
+      paymentData[loan.id].amortizationSchedule.reduce(
+        (acc, curval) => acc + curval.interest,
+        0
+      )
+    );
     paymentData[loan.id].lifetimeInterest = loanLifetimeInterest;
+    paymentData[loan.id].lifetimePrincipal = loan.principal;
     totalLifetimeInterest += loanLifetimeInterest;
+    totalLifetimePrincipal += loan.principal;
   }
 
-  paymentData["totals"] = {
+  paymentData.totals = {
     lifetimeInterest: totalLifetimeInterest,
+    lifetimePrincipal: totalLifetimePrincipal,
     amortizationSchedule: totalAmortizationSchedule
   };
 

package/src/lib/sorting.ts

@@ -4,7 +4,7 @@
  *
  */
 
-import { ILoan } from "./loan";
+import { type ILoan } from "./loan";
 
 type avalanche = (loan1: ILoan, loan2: ILoan) => number;
 type snowball = (loan1: ILoan, loan2: ILoan) => number;
@@ -36,6 +36,6 @@ export function snowball(loan1: ILoan, loan2: ILoan) {
  * @param {function} sortFunc The algorithm to sort the loans with
  * @returns The sorted array loans
  */
-export function sortLoans(loans: Array<ILoan>, sortFunction: sortFunction) {
+export function sortLoans(loans: ILoan[], sortFunction: sortFunction) {
   return loans.sort(sortFunction);
 }