moneyfunx 3.0.9 → 3.0.10

package/build/lib/debt/payments.d.ts

@@ -32,8 +32,8 @@ export declare function determineCarryover(loan: Loan, loanPayment: number, loan
  *
  * @param {Loan} loan The loan to amortize payments for
  * @param {number} principal The amount borrowed
- * @param {number} payment The amount to pay to the loan's balance each period
- * @param {number} numPayments The number of periods to make payments to the loan
+ * @param {number|null} payment The amount to pay to the loan's balance each period
+ * @param {number|null} numPayments The number of periods to make payments to the loan
  * @param {number} startPeriod An initial offset of periods to 'fast-forward' the state of the loan to prior to calculation of each period
  * @param {number} carryover An additional amount to pay towards a loan, used when a residual amount is available from paying off the previous loan this period
  * @returns {PaymentRecord[]} The amortization schedule for the number of payments of payment made to the loan from the provided start period

package/build/lib/debt/payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../../src/lib/debt/payments.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EACV,aAAa,EAEb,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,KAAK,EAAE,EACd,OAAO,EAAE,MAAM,GACd,MAAM,CAYR;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,OAAO,GACrB,MAAM,CAOR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAC,IAAI,EACpB,WAAW,EAAE,MAAM,GAAC,IAAI,EACxB,WAAW,GAAE,MAAU,EACvB,SAAS,GAAE,MAAU,GACpB,aAAa,EAAE,CA+BjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE,MAAM,EACf,aAAa,GAAE,OAAe,GAC7B,oBAAoB,CAqItB"}
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../../src/lib/debt/payments.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EACV,aAAa,EAEb,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,KAAK,EAAE,EACd,OAAO,EAAE,MAAM,GACd,MAAM,CAYR;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,OAAO,GACrB,MAAM,CAOR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,WAAW,GAAE,MAAU,EACvB,SAAS,GAAE,MAAU,GACpB,aAAa,EAAE,CA2BjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE,MAAM,EACf,aAAa,GAAE,OAAe,GAC7B,oBAAoB,CA0ItB"}

package/build/lib/debt/payments.js

@@ -4,6 +4,7 @@
  *
  */
 import * as errors from '../errors.js';
+import { TOTALS } from '../constants.js';
 /**
  *
  * Calculates the extra amount in a payment after all loans' minimum payments are met
@@ -45,27 +46,24 @@ export function determineCarryover(loan, loanPayment, loanFinalPayment, reduceMi
  *
  * @param {Loan} loan The loan to amortize payments for
  * @param {number} principal The amount borrowed
- * @param {number} payment The amount to pay to the loan's balance each period
- * @param {number} numPayments The number of periods to make payments to the loan
+ * @param {number|null} payment The amount to pay to the loan's balance each period
+ * @param {number|null} numPayments The number of periods to make payments to the loan
  * @param {number} startPeriod An initial offset of periods to 'fast-forward' the state of the loan to prior to calculation of each period
  * @param {number} carryover An additional amount to pay towards a loan, used when a residual amount is available from paying off the previous loan this period
  * @returns {PaymentRecord[]} The amortization schedule for the number of payments of payment made to the loan from the provided start period
  */
 export function amortizePayments(loan, principal, payment, numPayments, startPeriod = 0, carryover = 0) {
-    if (payment === null) {
-        payment = loan.minPayment;
-    }
-    payment = loan.validatePayment(payment);
-    if (numPayments === null) {
-        numPayments = loan.numPaymentsToZero(payment);
-    }
+    // Strict null check handling
+    let actualPayment = (payment !== null) ? payment : loan.minPayment;
+    actualPayment = loan.validatePayment(actualPayment);
+    let actualNumPayments = (numPayments !== null) ? numPayments : loan.numPaymentsToZero(actualPayment);
     const amortizationSchedule = [];
     let principalRemaining = principal;
-    for (let period = 0; period < numPayments; period++) {
+    for (let period = 0; period < actualNumPayments; period++) {
         const interestThisPeriod = loan.accrueInterest(principalRemaining);
-        const principalThisPeriod = Math.min((period === numPayments - 1
-            ? payment + carryover
-            : payment) - interestThisPeriod, principalRemaining);
+        const principalThisPeriod = Math.min((period === actualNumPayments - 1
+            ? actualPayment + carryover
+            : actualPayment) - interestThisPeriod, principalRemaining);
         principalRemaining -= principalThisPeriod;
         amortizationSchedule.push({
             period: startPeriod + period + 1,
@@ -110,11 +108,14 @@ export function payLoans(loans, payment, reduceMinimum = false) {
         const firstLoanPrincipalRemaining = loanPrincipalsRemaining[firstLoan.id];
         const periodsToPay = firstLoan.numPaymentsToZero(firstLoanPayment, firstLoanPrincipalRemaining);
         const firstLoanAmortizedPayments = amortizePayments(firstLoan, firstLoanPrincipalRemaining, firstLoanPayment, periodsToPay, periodsElapsed);
-        const firstLoanFinalPayment = firstLoan.principalRemaining(periodsToPay - 1, firstLoanPayment, firstLoanPrincipalRemaining) + firstLoan.accrueInterest(firstLoan.principalRemaining(periodsToPay - 1, firstLoanPayment, firstLoanPrincipalRemaining));
+        // Calculate final payment logic
+        const finalPrincipal = firstLoan.principalRemaining(periodsToPay - 1, firstLoanPayment, firstLoanPrincipalRemaining);
+        const firstLoanFinalPayment = finalPrincipal + firstLoan.accrueInterest(finalPrincipal);
         paymentSchedule[firstLoan.id].amortizationSchedule = [
             ...paymentSchedule[firstLoan.id].amortizationSchedule,
             ...firstLoanAmortizedPayments
         ];
+        // Merge into totals
         totalAmortizationSchedule = [
             ...totalAmortizationSchedule,
             ...firstLoanAmortizedPayments
@@ -132,6 +133,7 @@ export function payLoans(loans, payment, reduceMinimum = false) {
                 ...paymentSchedule[loan.id].amortizationSchedule,
                 ...loanAmortizedPayments,
             ];
+            // Safe map for totals
             totalAmortizationSchedule = totalAmortizationSchedule.map((element) => {
                 const matchedInnerElement = loanAmortizedPayments.find((innerElement) => innerElement.period === element.period);
                 return (matchedInnerElement != null)
@@ -144,7 +146,11 @@ export function payLoans(loans, payment, reduceMinimum = false) {
                     }
                     : element;
             });
-            loanPrincipalsRemaining[loan.id] = paymentSchedule[loan.id].amortizationSchedule[paymentSchedule[loan.id].amortizationSchedule.length - 1].principalRemaining;
+            // Update remaining principals for next iteration
+            const currentLoanSchedule = paymentSchedule[loan.id].amortizationSchedule;
+            if (currentLoanSchedule.length > 0) {
+                loanPrincipalsRemaining[loan.id] = currentLoanSchedule[currentLoanSchedule.length - 1].principalRemaining;
+            }
         });
         periodsElapsed += periodsToPay;
     }
@@ -155,7 +161,7 @@ export function payLoans(loans, payment, reduceMinimum = false) {
         totalLifetimeInterest += loanLifetimeInterest;
         totalLifetimePrincipal += loan.currentBalance;
     }
-    paymentSchedule.totals = {
+    paymentSchedule[TOTALS] = {
         lifetimeInterest: totalLifetimeInterest,
         lifetimePrincipal: totalLifetimePrincipal,
         amortizationSchedule: totalAmortizationSchedule,

package/build/lib/investment/contributions.d.ts

@@ -4,7 +4,7 @@
  *
  */
 import type { Instrument } from '../investment/instrument.js';
-import { ContributionRecord, InstrumentsContributionSchedule } from '../investment/contributionTypes.js';
+import type { ContributionRecord, InstrumentsContributionSchedule } from '../investment/contributionTypes.js';
 /**
  *
  * @param {IInstrument[]} instruments The instruments to allocate maximum contributions
@@ -19,8 +19,8 @@ export declare function determineExtraContribution(instruments: Instrument[], co
  * @param {number} contribution The amount to contribute to the instrument's balance
  * @param {number[int]} startPeriod The initial offset for period values
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {ContributionRecord} The amortized contribution
  */
 export declare function amortizeContribution(instrument: Instrument, currentBalance: number, contribution: number, startPeriod?: number, accrueBeforeContribution?: boolean): ContributionRecord;
@@ -34,8 +34,8 @@ export declare function amortizeContribution(instrument: Instrument, currentBala
  * @param {number} numContributions The number of periods to make contributions to the instrument
  * @param {number[int]} startPeriod The inital offset for period values
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {ContributionRecord[]} The amortized contributions
  */
 export declare function amortizeContributions(instrument: Instrument, initialBalance: number, contribution: number, numContributions: number, startPeriod?: number, accrueBeforeContribution?: boolean): ContributionRecord[];
@@ -45,8 +45,8 @@ export declare function amortizeContributions(instrument: Instrument, initialBal
  * @param {number} contribution The total amount to contirbute each period
  * @param {number[int]} numContributions The number of periods to contribute
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {InstrumentsContributionSchedule} The amortized contributions for all instruments
  */
 export declare function contributeInstruments(instruments: Instrument[], contribution: number, numContributions: number, accrueBeforeContribution?: boolean): InstrumentsContributionSchedule;

package/build/lib/investment/contributions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contributions.d.ts","sourceRoot":"","sources":["../../../src/lib/investment/contributions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,+BAA+B,EAGhC,MAAM,oCAAoC,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,UAAU,EAAE,EACzB,YAAY,EAAE,MAAM,GACnB,MAAM,CAMR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,WAAW,GAAE,MAAU,EACvB,wBAAwB,GAAE,OAAc,GACvC,kBAAkB,CAgBpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,WAAW,GAAE,MAAU,EACvB,wBAAwB,GAAE,OAAc,GACvC,kBAAkB,EAAE,CAkBtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,UAAU,EAAE,EACzB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,wBAAwB,GAAE,OAAc,GACvC,+BAA+B,CA6FjC"}
+{"version":3,"file":"contributions.d.ts","sourceRoot":"","sources":["../../../src/lib/investment/contributions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,kBAAkB,EAClB,+BAA+B,EAGhC,MAAM,oCAAoC,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,UAAU,EAAE,EACzB,YAAY,EAAE,MAAM,GACnB,MAAM,CAMR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,WAAW,GAAE,MAAU,EACvB,wBAAwB,GAAE,OAAc,GACvC,kBAAkB,CAkBpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,WAAW,GAAE,MAAU,EACvB,wBAAwB,GAAE,OAAc,GACvC,kBAAkB,EAAE,CAoBtB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,UAAU,EAAE,EACzB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,wBAAwB,GAAE,OAAc,GACvC,+BAA+B,CA+FjC"}

package/build/lib/investment/contributions.js

@@ -3,6 +3,7 @@
  * This file containts functions for computing detailed information on contributing to investments
  *
  */
+import { TOTALS } from '../constants.js';
 /**
  *
  * @param {IInstrument[]} instruments The instruments to allocate maximum contributions
@@ -21,26 +22,27 @@ export function determineExtraContribution(instruments, contribution) {
  * @param {number} contribution The amount to contribute to the instrument's balance
  * @param {number[int]} startPeriod The initial offset for period values
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {ContributionRecord} The amortized contribution
  */
 export function amortizeContribution(instrument, currentBalance, contribution, startPeriod = 0, accrueBeforeContribution = true) {
     let interestThisPeriod;
+    let newBalance = currentBalance;
     if (accrueBeforeContribution) {
-        interestThisPeriod = instrument.accrueInterest(currentBalance);
-        currentBalance += contribution + interestThisPeriod;
+        interestThisPeriod = instrument.accrueInterest(newBalance);
+        newBalance += contribution + interestThisPeriod;
     }
     else {
-        currentBalance += contribution;
-        interestThisPeriod = instrument.accrueInterest(currentBalance);
-        currentBalance += interestThisPeriod;
+        newBalance += contribution;
+        interestThisPeriod = instrument.accrueInterest(newBalance);
+        newBalance += interestThisPeriod;
     }
     return {
         period: startPeriod + 1,
         contribution: contribution,
         growth: interestThisPeriod,
-        currentBalance,
+        currentBalance: newBalance,
     };
 }
 ;
@@ -54,8 +56,8 @@ export function amortizeContribution(instrument, currentBalance, contribution, s
  * @param {number} numContributions The number of periods to make contributions to the instrument
  * @param {number[int]} startPeriod The inital offset for period values
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {ContributionRecord[]} The amortized contributions
  */
 export function amortizeContributions(instrument, initialBalance, contribution, numContributions, startPeriod = 0, accrueBeforeContribution = true) {
@@ -66,6 +68,8 @@ export function amortizeContributions(instrument, initialBalance, contribution,
         const periodicContribution = instrument.validateContribution(contribution, ytd);
         const record = amortizeContribution(instrument, currentBalance, periodicContribution, period + startPeriod, accrueBeforeContribution);
         currentBalance = record.currentBalance;
+        // Reset YTD every 12 periods, assuming monthly periodicity matching periodsPerYear
+        // NOTE: This logic assumes period 0 is the start of a year. 
         period % 12 === 0 ? ytd = 0 : ytd += periodicContribution;
         contributionSchedule.push(record);
     }
@@ -78,8 +82,8 @@ export function amortizeContributions(instrument, initialBalance, contribution,
  * @param {number} contribution The total amount to contirbute each period
  * @param {number[int]} numContributions The number of periods to contribute
  * @param {boolean} accrueBeforeContribution A flag for ordering operations of accrual (A) and contribution (C)
- *         true: A -> C
- *         false: C -> A
+ * true: A -> C
+ * false: C -> A
  * @returns {InstrumentsContributionSchedule} The amortized contributions for all instruments
  */
 export function contributeInstruments(instruments, contribution, numContributions, accrueBeforeContribution = true) {
@@ -126,6 +130,7 @@ export function contributeInstruments(instruments, contribution, numContribution
         contributionSchedules[instrument.id].lifetimeGrowth = instrumentLifetimeGrowth;
         totalLifetimeContribution += instrumentLifetimeContribution;
         totalLifetimeGrowth += instrumentLifetimeGrowth;
+        // Merge totals safely
         totalAmortizationSchedule = totalAmortizationSchedule.length
             ? (totalAmortizationSchedule.map((element) => {
                 const matchedInnerElement = instrumentSchedule.find((innerElement) => innerElement.period === element.period);
@@ -141,7 +146,7 @@ export function contributeInstruments(instruments, contribution, numContribution
             }))
             : instrumentSchedule;
     }
-    contributionSchedules.totals = {
+    contributionSchedules[TOTALS] = {
         lifetimeContribution: totalLifetimeContribution,
         lifetimeGrowth: totalLifetimeGrowth,
         amortizationSchedule: totalAmortizationSchedule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "moneyfunx",
-  "version": "3.0.9",
+  "version": "3.0.10",
   "type": "module",
   "exports": {
     ".": {