moneyfunx 3.0.7 → 3.0.8

package/build/index.d.ts

@@ -1,18 +1,64 @@
 /**
- * MoneyFunx
- * * mek it funx up
+ * Moneyfunx
+ * A library for financial calculations regarding debt and investments.
  */
-export { MAX_DURATION_YEARS, TOTALS, } from './lib/constants.js';
-export { ILoan, Loan } from './lib/debt/loan.js';
-export { determineExtraPayment, amortizePayments, payLoans, } from './lib/debt/payments.js';
-export { PaymentRecord, LoansPaymentSchedule, LoanPrincipals, PaymentSchedule, } from './lib/debt/paymentTypes.js';
-export { NegativeContributionError, PaymentTooLowError, NegativeWithdrawalError } from './lib/errors.js';
-export { amortizeContributions, contributeInstruments, determineExtraContribution, } from './lib/investment/contributions.js';
-export { ContributionRecord, ContributionSchedule, InstrumentsContributionSchedule, } from './lib/investment/contributionTypes.js';
-export { IInstrument, Instrument } from './lib/investment/instrument.js';
-export { calculateAmortizedWithdrawal, drawdownInstruments, } from './lib/investment/withdrawals.js';
-export { WithdrawalRecord, WithdrawalSchedule, InstrumentsWithdrawalSchedule, } from './lib/investment/withdrawalTypes.js';
-export { performWaterfallDrawdown, } from './lib/investment/strategies.js';
-export { calculatePeriodicAmount, calculateBalanceRemaining, calculatePeriodsToZero, calculateInterestOverPeriods, } from './lib/shared/primitives.js';
-export { HasRateAndBalance, snowball, avalanche, sortWith } from './lib/shared/sorting.js';
+import * as constants from './lib/constants.js';
+import * as loan from './lib/debt/loan.js';
+import * as payments from './lib/debt/payments.js';
+import * as paymentTypes from './lib/debt/paymentTypes.js';
+import * as errors from './lib/errors.js';
+import * as contributions from './lib/investment/contributions.js';
+import * as contributionTypes from './lib/investment/contributionTypes.js';
+import * as instrument from './lib/investment/instrument.js';
+import * as withdrawals from './lib/investment/withdrawals.js';
+import * as withdrawalTypes from './lib/investment/withdrawalTypes.js';
+import * as strategies from './lib/investment/strategies.js';
+import * as primitives from './lib/shared/primitives.js';
+import * as sorting from './lib/shared/sorting.js';
+export { constants, loan, payments, paymentTypes, errors, contributions, contributionTypes, instrument, withdrawals, withdrawalTypes, strategies, primitives, sorting, };
+/**
+ * Consolidated namespace for unambiguous access.
+ * @example
+ * import moneyfunx from 'moneyfunx';
+ * moneyfunx.loan.calculateMonthlyPayment(...);
+ */
+declare const moneyfunx: {
+    avalanche<T extends sorting.HasRateAndBalance>(obj1: T, obj2: T): number;
+    snowball<T_1 extends sorting.HasRateAndBalance>(obj1: T_1, obj2: T_1): number;
+    sortWith<T_2 extends sorting.HasRateAndBalance>(sortable: T_2[], sortFunction: (obj1: sorting.HasRateAndBalance, obj2: sorting.HasRateAndBalance) => number): T_2[];
+    /**
+     * Moneyfunx
+     * A library for financial calculations regarding debt and investments.
+     */
+    calculatePeriodicAmount(startingBalance: number, periodicInterestRate: number, totalNumberOfPeriods: number): number;
+    calculateBalanceRemaining(initialBalance: number, periodicAmountApplied: number, periodicInterestRate: number, periodsElapsed: number): number;
+    calculatePeriodsToZero(currentBalance: number, periodicAmountApplied: number, periodicInterestRate: number): number;
+    calculateInterestOverPeriods(initialBalance: number, periodicAmountApplied: number, periodicInterestRate: number, periodsElapsed: number): number;
+    performWaterfallDrawdown(financialInstruments: instrument.Instrument[], targetNetPeriodicIncome: number, totalPeriodsToSimulate: number, effectiveTaxRate?: number): withdrawalTypes.InstrumentsWithdrawalSchedule;
+    calculateAmortizedWithdrawal(instrument: instrument.Instrument, currentInstrumentBalance: number, periodicWithdrawalAmount: number, periodsElapsedOffset?: number, applicableTaxRate?: number, accrueBeforeWithdrawal?: boolean): withdrawalTypes.WithdrawalRecord;
+    drawdownInstruments(instruments: instrument.Instrument[], targetNetPeriodicIncome: number, totalPeriodsToSimulate: number, effectiveTaxRate?: number, accrueBeforeWithdrawal?: boolean): withdrawalTypes.InstrumentsWithdrawalSchedule;
+    Instrument: typeof instrument.Instrument;
+    determineExtraContribution(instruments: instrument.Instrument[], contribution: number): number;
+    amortizeContribution(instrument: instrument.Instrument, currentBalance: number, contribution: number, startPeriod?: number, accrueBeforeContribution?: boolean): contributionTypes.ContributionRecord;
+    amortizeContributions(instrument: instrument.Instrument, initialBalance: number, contribution: number, numContributions: number, startPeriod?: number, accrueBeforeContribution?: boolean): contributionTypes.ContributionRecord[];
+    contributeInstruments(instruments: instrument.Instrument[], contribution: number, numContributions: number, accrueBeforeContribution?: boolean): contributionTypes.InstrumentsContributionSchedule;
+    /**
+     * Moneyfunx
+     * A library for financial calculations regarding debt and investments.
+     */
+    PaymentTooLowError: typeof errors.PaymentTooLowError;
+    NegativeContributionError: typeof errors.NegativeContributionError;
+    NegativeWithdrawalError: typeof errors.NegativeWithdrawalError;
+    determineExtraPayment(loans: loan.ILoan[], payment: number): number;
+    determineCarryover(loan: loan.Loan, loanPayment: number, loanFinalPayment: number, reduceMinimum: boolean): number;
+    amortizePayments(loan: loan.Loan, principal: number, payment: number | null, numPayments: number | null, startPeriod?: number, carryover?: number): paymentTypes.PaymentRecord[];
+    payLoans(loans: loan.Loan[], payment: number, reduceMinimum?: boolean): paymentTypes.LoansPaymentSchedule;
+    Loan: typeof loan.Loan;
+    TOTALS: "totals";
+    MAX_DURATION_YEARS: 110;
+    MAX_YIELD_FACTOR: 1.4;
+    MIN_GROWTH_FACTOR: 1;
+    MIN_YIELD_FACTOR: 0.45;
+};
+export default moneyfunx;
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,kBAAkB,EAClB,MAAM,GACP,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,QAAQ,GACT,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,eAAe,GAChB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAEzG,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,GAC3B,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,+BAA+B,GAChC,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,EACL,4BAA4B,EAC5B,mBAAmB,GACpB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,6BAA6B,GAC9B,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EACL,wBAAwB,GACzB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,SAAS,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,YAAY,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,aAAa,MAAM,mCAAmC,CAAC;AACnE,OAAO,KAAK,iBAAiB,MAAM,uCAAuC,CAAC;AAC3E,OAAO,KAAK,UAAU,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,WAAW,MAAM,iCAAiC,CAAC;AAC/D,OAAO,KAAK,eAAe,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,UAAU,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,UAAU,MAAM,4BAA4B,CAAC;AACzD,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAGnD,OAAO,EACL,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,eAAe,EACf,UAAU,EACV,UAAU,EACV,OAAO,GACR,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,SAAS;;;;IA1Cf;;;OAGG;;;;;;;;;;;;;IAHH;;;OAGG;;;;;;;;;;;;;;CAqDF,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/build/index.js

@@ -1,14 +1,27 @@
 /**
- * MoneyFunx
- * * mek it funx up
+ * Moneyfunx
+ * A library for financial calculations regarding debt and investments.
  */
-export { MAX_DURATION_YEARS, TOTALS, } from './lib/constants.js';
-export { Loan } from './lib/debt/loan.js';
-export { determineExtraPayment, amortizePayments, payLoans, } from './lib/debt/payments.js';
-export { NegativeContributionError, PaymentTooLowError, NegativeWithdrawalError } from './lib/errors.js';
-export { amortizeContributions, contributeInstruments, determineExtraContribution, } from './lib/investment/contributions.js';
-export { Instrument } from './lib/investment/instrument.js';
-export { calculateAmortizedWithdrawal, drawdownInstruments, } from './lib/investment/withdrawals.js';
-export { performWaterfallDrawdown, } from './lib/investment/strategies.js';
-export { calculatePeriodicAmount, calculateBalanceRemaining, calculatePeriodsToZero, calculateInterestOverPeriods, } from './lib/shared/primitives.js';
-export { snowball, avalanche, sortWith } from './lib/shared/sorting.js';
+import * as constants from './lib/constants.js';
+import * as loan from './lib/debt/loan.js';
+import * as payments from './lib/debt/payments.js';
+import * as paymentTypes from './lib/debt/paymentTypes.js';
+import * as errors from './lib/errors.js';
+import * as contributions from './lib/investment/contributions.js';
+import * as contributionTypes from './lib/investment/contributionTypes.js';
+import * as instrument from './lib/investment/instrument.js';
+import * as withdrawals from './lib/investment/withdrawals.js';
+import * as withdrawalTypes from './lib/investment/withdrawalTypes.js';
+import * as strategies from './lib/investment/strategies.js';
+import * as primitives from './lib/shared/primitives.js';
+import * as sorting from './lib/shared/sorting.js';
+// Named exports for granular access
+export { constants, loan, payments, paymentTypes, errors, contributions, contributionTypes, instrument, withdrawals, withdrawalTypes, strategies, primitives, sorting, };
+/**
+ * Consolidated namespace for unambiguous access.
+ * @example
+ * import moneyfunx from 'moneyfunx';
+ * moneyfunx.loan.calculateMonthlyPayment(...);
+ */
+const moneyfunx = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, constants), loan), payments), paymentTypes), errors), contributions), contributionTypes), instrument), withdrawals), withdrawalTypes), strategies), primitives), sorting);
+export default moneyfunx;

package/package.json

@@ -1,15 +1,13 @@
 {
   "name": "moneyfunx",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "type": "module",
   "exports": {
     ".": {
       "types": "./build/index.d.ts",
-      "import": "./build/index.js",
-      "require": "./build/index.cjs"
+      "import": "./build/index.js"
     }
   },
-  "main": "./build/index.cjs",
   "module": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [