@utilix-tech/sdk 0.32.0 → 0.34.0

package/dist/{units-DQYLZd1n.d.ts → units-BhoxdHhs.d.cts}

@@ -29,6 +29,7 @@
  *  - break-even-calculator : calculateBreakEven
  *  - video-bitrate-calculator : calculateVideoBitrate
  *  - emi-calculator : calculateEmi
+ *  - savings-goal-calculator : calculateSavingsGoal
  */
 interface PxConvertResult {
     px: number;
@@ -676,6 +677,41 @@ interface EmiResult {
 declare function calculateEmi(principal: number, annualRatePercent: number, tenure: number, tenureUnit?: EmiTenureUnit): EmiResult | {
     error: string;
 };
+type SavingsGoalMode = 'time-to-goal' | 'contribution-for-target';
+interface SavingsGoalInput {
+    mode: SavingsGoalMode;
+    goalAmount: number;
+    currentSavings: number;
+    annualInterestRatePercent: number;
+    /** Required for mode "time-to-goal". */
+    monthlyContribution?: number;
+    /** Required for mode "contribution-for-target". */
+    months?: number;
+}
+interface SavingsGoalResult {
+    mode: SavingsGoalMode;
+    goalAmount: number;
+    currentSavings: number;
+    annualInterestRatePercent: number;
+    monthlyContribution: number;
+    months: number;
+    monthsRounded: number;
+    years: number;
+    totalContributed: number;
+    totalInterestEarned: number;
+    finalBalance: number;
+}
+/**
+ * Standard time-value-of-money arithmetic for an ordinary annuity
+ * (contributions at the end of each month, compounded monthly). Mode
+ * "time-to-goal" solves for how many months it takes to reach a goal given
+ * a fixed monthly contribution; mode "contribution-for-target" solves for
+ * the monthly contribution required to reach the goal in a given number of
+ * months. Pure closed-form formulas, no live rate data.
+ */
+declare function calculateSavingsGoal(input: SavingsGoalInput): SavingsGoalResult | {
+    error: string;
+};
 
 type units_AmortizationRow = AmortizationRow;
 type units_AprApyDirection = AprApyDirection;
@@ -727,6 +763,9 @@ type units_Permission = Permission;
 type units_PxConvertResult = PxConvertResult;
 type units_RuleOf72Direction = RuleOf72Direction;
 type units_RuleOf72Result = RuleOf72Result;
+type units_SavingsGoalInput = SavingsGoalInput;
+type units_SavingsGoalMode = SavingsGoalMode;
+type units_SavingsGoalResult = SavingsGoalResult;
 type units_SemverVersion = SemverVersion;
 type units_SimpleInterestResult = SimpleInterestResult;
 type units_SubnetInfo = SubnetInfo;
@@ -754,6 +793,7 @@ declare const units_calculateLoan: typeof calculateLoan;
 declare const units_calculateMarginMarkup: typeof calculateMarginMarkup;
 declare const units_calculatePercentageChange: typeof calculatePercentageChange;
 declare const units_calculateRuleOf72: typeof calculateRuleOf72;
+declare const units_calculateSavingsGoal: typeof calculateSavingsGoal;
 declare const units_calculateSimpleInterest: typeof calculateSimpleInterest;
 declare const units_calculateTax: typeof calculateTax;
 declare const units_calculateTimeValue: typeof calculateTimeValue;
@@ -812,7 +852,7 @@ declare const units_validateIban: typeof validateIban;
 declare const units_validateIsbn: typeof validateIsbn;
 declare const units_viewportToPx: typeof viewportToPx;
 declare namespace units {
-  export { type units_AmortizationRow as AmortizationRow, type units_AprApyDirection as AprApyDirection, type units_AprApyResult as AprApyResult, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_BreakEvenInput as BreakEvenInput, type units_BreakEvenResult as BreakEvenResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_DiscountField as DiscountField, type units_DiscountInput as DiscountInput, type units_DiscountResult as DiscountResult, type units_EmiResult as EmiResult, type units_EmiTenureUnit as EmiTenureUnit, type units_EmiYearlyBreakdownRow as EmiYearlyBreakdownRow, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_MarginMarkupField as MarginMarkupField, type units_MarginMarkupInput as MarginMarkupInput, type units_MarginMarkupResult as MarginMarkupResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_RuleOf72Direction as RuleOf72Direction, type units_RuleOf72Result as RuleOf72Result, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_SuccessiveDiscountResult as SuccessiveDiscountResult, type units_SuccessiveDiscountStep as SuccessiveDiscountStep, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_VideoBitrateInput as VideoBitrateInput, type units_VideoBitrateMode as VideoBitrateMode, type units_VideoBitrateResult as VideoBitrateResult, type units_ViewportConvertResult as ViewportConvertResult, units_applySuccessiveDiscounts as applySuccessiveDiscounts, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateBreakEven as calculateBreakEven, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateDiscount as calculateDiscount, units_calculateEmi as calculateEmi, units_calculateLoan as calculateLoan, units_calculateMarginMarkup as calculateMarginMarkup, units_calculatePercentageChange as calculatePercentageChange, units_calculateRuleOf72 as calculateRuleOf72, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_calculateVideoBitrate as calculateVideoBitrate, units_compareSemver as compareSemver, units_convert as convert, units_convertAprApy as convertAprApy, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_marginToMarkup as marginToMarkup, units_markupToMargin as markupToMargin, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
+  export { type units_AmortizationRow as AmortizationRow, type units_AprApyDirection as AprApyDirection, type units_AprApyResult as AprApyResult, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_BreakEvenInput as BreakEvenInput, type units_BreakEvenResult as BreakEvenResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_DiscountField as DiscountField, type units_DiscountInput as DiscountInput, type units_DiscountResult as DiscountResult, type units_EmiResult as EmiResult, type units_EmiTenureUnit as EmiTenureUnit, type units_EmiYearlyBreakdownRow as EmiYearlyBreakdownRow, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_MarginMarkupField as MarginMarkupField, type units_MarginMarkupInput as MarginMarkupInput, type units_MarginMarkupResult as MarginMarkupResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_RuleOf72Direction as RuleOf72Direction, type units_RuleOf72Result as RuleOf72Result, type units_SavingsGoalInput as SavingsGoalInput, type units_SavingsGoalMode as SavingsGoalMode, type units_SavingsGoalResult as SavingsGoalResult, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_SuccessiveDiscountResult as SuccessiveDiscountResult, type units_SuccessiveDiscountStep as SuccessiveDiscountStep, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_VideoBitrateInput as VideoBitrateInput, type units_VideoBitrateMode as VideoBitrateMode, type units_VideoBitrateResult as VideoBitrateResult, type units_ViewportConvertResult as ViewportConvertResult, units_applySuccessiveDiscounts as applySuccessiveDiscounts, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateBreakEven as calculateBreakEven, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateDiscount as calculateDiscount, units_calculateEmi as calculateEmi, units_calculateLoan as calculateLoan, units_calculateMarginMarkup as calculateMarginMarkup, units_calculatePercentageChange as calculatePercentageChange, units_calculateRuleOf72 as calculateRuleOf72, units_calculateSavingsGoal as calculateSavingsGoal, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_calculateVideoBitrate as calculateVideoBitrate, units_compareSemver as compareSemver, units_convert as convert, units_convertAprApy as convertAprApy, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_marginToMarkup as marginToMarkup, units_markupToMargin as markupToMargin, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
 }
 
-export { type SubnetInfo as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type EmiResult as E, type EmiTenureUnit as F, type EmiYearlyBreakdownRow as G, type FilePermissions as H, type FormatOptions as I, type IbanValidationResult as J, type IpConversion as K, type IsbnFormat as L, type IsbnResult as M, type LoanResult as N, type MarginMarkupField as O, type MarginMarkupInput as P, type MarginMarkupResult as Q, type NotationStyle as R, type NumberBase as S, type PercentChangeDirection as T, type PercentageChangeResult as U, type Permission as V, type PxConvertResult as W, type RuleOf72Direction as X, type RuleOf72Result as Y, type SemverVersion as Z, type SimpleInterestResult as _, type AprApyDirection as a, permissionsToChmod as a$, type SuccessiveDiscountResult as a0, type SuccessiveDiscountStep as a1, type TaxDirection as a2, type TaxResult as a3, type TimeValueDirection as a4, type TimeValueResult as a5, type TipSplitResult as a6, type VideoBitrateInput as a7, type VideoBitrateMode as a8, type VideoBitrateResult as a9, decimalToIpCidr as aA, describePermissions as aB, fitIntoBox as aC, formatNumber as aD, formatValue as aE, formatVwValue as aF, formatWithSeparator as aG, gcd as aH, ipFromBinary as aI, ipFromDecimal as aJ, ipFromHex as aK, ipToBinary as aL, ipToDecimal as aM, ipToDecimalCidr as aN, ipToHex as aO, ipToOctal as aP, isValid as aQ, isValidCidr as aR, isValidIp as aS, isValidIpv4 as aT, marginToMarkup as aU, markupToMargin as aV, octalToPermissions as aW, parseFileSize as aX, parseInput as aY, parseNumberString as aZ, parseSemver as a_, type ViewportConvertResult as aa, applySuccessiveDiscounts as ab, autoFormat as ac, bumpVersion as ad, calcAspectRatio as ae, calcSubnet as af, calculateBreakEven as ag, calculateCompoundInterest as ah, calculateDiscount as ai, calculateEmi as aj, calculateLoan as ak, calculateMarginMarkup as al, calculatePercentageChange as am, calculateRuleOf72 as an, calculateSimpleInterest as ao, calculateTax as ap, calculateTimeValue as aq, calculateTipSplit as ar, calculateVideoBitrate as as, compareSemver as at, convert as au, convertAprApy as av, convertBytes as aw, convertIp as ax, coverBox as ay, decimalToIp as az, type AprApyResult as b, permissionsToOctal as b0, permissionsToSymbolic as b1, ptToPx as b2, pxToAll as b3, pxToViewport as b4, remToPx as b5, satisfiesRange as b6, scaleByHeight as b7, scaleByWidth as b8, sortVersions as b9, splitSubnet as ba, symbolicToPermissions as bb, validateBarcode as bc, validateCardNumber as bd, validateIban as be, validateIsbn as bf, viewportToPx as bg, type AspectRatioResult as c, BASE_PREFIXES as d, BYTE_UNITS as e, type BarcodeFormat as f, type BarcodeValidationResult as g, type BaseConvertResult as h, type BreakEvenInput as i, type BreakEvenResult as j, type ByteConvertResult as k, type ByteUnit as l, COMMON_LOCALES as m, COMMON_PERMISSIONS as n, COMMON_RATIOS as o, COMMON_SIZES as p, COMMON_TAX_RATES as q, COMMON_TIP_PERCENTAGES as r, COMMON_VIEWPORTS as s, type CardValidationResult as t, units as u, type CompoundInterestResult as v, type CompoundYearRow as w, type DiscountField as x, type DiscountInput as y, type DiscountResult as z };
+export { type SavingsGoalResult as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type EmiResult as E, type EmiTenureUnit as F, type EmiYearlyBreakdownRow as G, type FilePermissions as H, type FormatOptions as I, type IbanValidationResult as J, type IpConversion as K, type IsbnFormat as L, type IsbnResult as M, type LoanResult as N, type MarginMarkupField as O, type MarginMarkupInput as P, type MarginMarkupResult as Q, type NotationStyle as R, type NumberBase as S, type PercentChangeDirection as T, type PercentageChangeResult as U, type Permission as V, type PxConvertResult as W, type RuleOf72Direction as X, type RuleOf72Result as Y, type SavingsGoalInput as Z, type SavingsGoalMode as _, type AprApyDirection as a, parseFileSize as a$, type SemverVersion as a0, type SimpleInterestResult as a1, type SubnetInfo as a2, type SuccessiveDiscountResult as a3, type SuccessiveDiscountStep as a4, type TaxDirection as a5, type TaxResult as a6, type TimeValueDirection as a7, type TimeValueResult as a8, type TipSplitResult as a9, convertBytes as aA, convertIp as aB, coverBox as aC, decimalToIp as aD, decimalToIpCidr as aE, describePermissions as aF, fitIntoBox as aG, formatNumber as aH, formatValue as aI, formatVwValue as aJ, formatWithSeparator as aK, gcd as aL, ipFromBinary as aM, ipFromDecimal as aN, ipFromHex as aO, ipToBinary as aP, ipToDecimal as aQ, ipToDecimalCidr as aR, ipToHex as aS, ipToOctal as aT, isValid as aU, isValidCidr as aV, isValidIp as aW, isValidIpv4 as aX, marginToMarkup as aY, markupToMargin as aZ, octalToPermissions as a_, type VideoBitrateInput as aa, type VideoBitrateMode as ab, type VideoBitrateResult as ac, type ViewportConvertResult as ad, applySuccessiveDiscounts as ae, autoFormat as af, bumpVersion as ag, calcAspectRatio as ah, calcSubnet as ai, calculateBreakEven as aj, calculateCompoundInterest as ak, calculateDiscount as al, calculateEmi as am, calculateLoan as an, calculateMarginMarkup as ao, calculatePercentageChange as ap, calculateRuleOf72 as aq, calculateSavingsGoal as ar, calculateSimpleInterest as as, calculateTax as at, calculateTimeValue as au, calculateTipSplit as av, calculateVideoBitrate as aw, compareSemver as ax, convert as ay, convertAprApy as az, type AprApyResult as b, parseInput as b0, parseNumberString as b1, parseSemver as b2, permissionsToChmod as b3, permissionsToOctal as b4, permissionsToSymbolic as b5, ptToPx as b6, pxToAll as b7, pxToViewport as b8, remToPx as b9, satisfiesRange as ba, scaleByHeight as bb, scaleByWidth as bc, sortVersions as bd, splitSubnet as be, symbolicToPermissions as bf, validateBarcode as bg, validateCardNumber as bh, validateIban as bi, validateIsbn as bj, viewportToPx as bk, type AspectRatioResult as c, BASE_PREFIXES as d, BYTE_UNITS as e, type BarcodeFormat as f, type BarcodeValidationResult as g, type BaseConvertResult as h, type BreakEvenInput as i, type BreakEvenResult as j, type ByteConvertResult as k, type ByteUnit as l, COMMON_LOCALES as m, COMMON_PERMISSIONS as n, COMMON_RATIOS as o, COMMON_SIZES as p, COMMON_TAX_RATES as q, COMMON_TIP_PERCENTAGES as r, COMMON_VIEWPORTS as s, type CardValidationResult as t, units as u, type CompoundInterestResult as v, type CompoundYearRow as w, type DiscountField as x, type DiscountInput as y, type DiscountResult as z };

package/dist/{units-DQYLZd1n.d.cts → units-BhoxdHhs.d.ts}

@@ -29,6 +29,7 @@
  *  - break-even-calculator : calculateBreakEven
  *  - video-bitrate-calculator : calculateVideoBitrate
  *  - emi-calculator : calculateEmi
+ *  - savings-goal-calculator : calculateSavingsGoal
  */
 interface PxConvertResult {
     px: number;
@@ -676,6 +677,41 @@ interface EmiResult {
 declare function calculateEmi(principal: number, annualRatePercent: number, tenure: number, tenureUnit?: EmiTenureUnit): EmiResult | {
     error: string;
 };
+type SavingsGoalMode = 'time-to-goal' | 'contribution-for-target';
+interface SavingsGoalInput {
+    mode: SavingsGoalMode;
+    goalAmount: number;
+    currentSavings: number;
+    annualInterestRatePercent: number;
+    /** Required for mode "time-to-goal". */
+    monthlyContribution?: number;
+    /** Required for mode "contribution-for-target". */
+    months?: number;
+}
+interface SavingsGoalResult {
+    mode: SavingsGoalMode;
+    goalAmount: number;
+    currentSavings: number;
+    annualInterestRatePercent: number;
+    monthlyContribution: number;
+    months: number;
+    monthsRounded: number;
+    years: number;
+    totalContributed: number;
+    totalInterestEarned: number;
+    finalBalance: number;
+}
+/**
+ * Standard time-value-of-money arithmetic for an ordinary annuity
+ * (contributions at the end of each month, compounded monthly). Mode
+ * "time-to-goal" solves for how many months it takes to reach a goal given
+ * a fixed monthly contribution; mode "contribution-for-target" solves for
+ * the monthly contribution required to reach the goal in a given number of
+ * months. Pure closed-form formulas, no live rate data.
+ */
+declare function calculateSavingsGoal(input: SavingsGoalInput): SavingsGoalResult | {
+    error: string;
+};
 
 type units_AmortizationRow = AmortizationRow;
 type units_AprApyDirection = AprApyDirection;
@@ -727,6 +763,9 @@ type units_Permission = Permission;
 type units_PxConvertResult = PxConvertResult;
 type units_RuleOf72Direction = RuleOf72Direction;
 type units_RuleOf72Result = RuleOf72Result;
+type units_SavingsGoalInput = SavingsGoalInput;
+type units_SavingsGoalMode = SavingsGoalMode;
+type units_SavingsGoalResult = SavingsGoalResult;
 type units_SemverVersion = SemverVersion;
 type units_SimpleInterestResult = SimpleInterestResult;
 type units_SubnetInfo = SubnetInfo;
@@ -754,6 +793,7 @@ declare const units_calculateLoan: typeof calculateLoan;
 declare const units_calculateMarginMarkup: typeof calculateMarginMarkup;
 declare const units_calculatePercentageChange: typeof calculatePercentageChange;
 declare const units_calculateRuleOf72: typeof calculateRuleOf72;
+declare const units_calculateSavingsGoal: typeof calculateSavingsGoal;
 declare const units_calculateSimpleInterest: typeof calculateSimpleInterest;
 declare const units_calculateTax: typeof calculateTax;
 declare const units_calculateTimeValue: typeof calculateTimeValue;
@@ -812,7 +852,7 @@ declare const units_validateIban: typeof validateIban;
 declare const units_validateIsbn: typeof validateIsbn;
 declare const units_viewportToPx: typeof viewportToPx;
 declare namespace units {
-  export { type units_AmortizationRow as AmortizationRow, type units_AprApyDirection as AprApyDirection, type units_AprApyResult as AprApyResult, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_BreakEvenInput as BreakEvenInput, type units_BreakEvenResult as BreakEvenResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_DiscountField as DiscountField, type units_DiscountInput as DiscountInput, type units_DiscountResult as DiscountResult, type units_EmiResult as EmiResult, type units_EmiTenureUnit as EmiTenureUnit, type units_EmiYearlyBreakdownRow as EmiYearlyBreakdownRow, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_MarginMarkupField as MarginMarkupField, type units_MarginMarkupInput as MarginMarkupInput, type units_MarginMarkupResult as MarginMarkupResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_RuleOf72Direction as RuleOf72Direction, type units_RuleOf72Result as RuleOf72Result, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_SuccessiveDiscountResult as SuccessiveDiscountResult, type units_SuccessiveDiscountStep as SuccessiveDiscountStep, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_VideoBitrateInput as VideoBitrateInput, type units_VideoBitrateMode as VideoBitrateMode, type units_VideoBitrateResult as VideoBitrateResult, type units_ViewportConvertResult as ViewportConvertResult, units_applySuccessiveDiscounts as applySuccessiveDiscounts, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateBreakEven as calculateBreakEven, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateDiscount as calculateDiscount, units_calculateEmi as calculateEmi, units_calculateLoan as calculateLoan, units_calculateMarginMarkup as calculateMarginMarkup, units_calculatePercentageChange as calculatePercentageChange, units_calculateRuleOf72 as calculateRuleOf72, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_calculateVideoBitrate as calculateVideoBitrate, units_compareSemver as compareSemver, units_convert as convert, units_convertAprApy as convertAprApy, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_marginToMarkup as marginToMarkup, units_markupToMargin as markupToMargin, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
+  export { type units_AmortizationRow as AmortizationRow, type units_AprApyDirection as AprApyDirection, type units_AprApyResult as AprApyResult, type units_AspectRatioResult as AspectRatioResult, units_BASE_LABELS as BASE_LABELS, units_BASE_PREFIXES as BASE_PREFIXES, units_BYTE_UNITS as BYTE_UNITS, type units_BarcodeFormat as BarcodeFormat, type units_BarcodeValidationResult as BarcodeValidationResult, type units_BaseConvertResult as BaseConvertResult, type units_BreakEvenInput as BreakEvenInput, type units_BreakEvenResult as BreakEvenResult, type units_ByteConvertResult as ByteConvertResult, type units_ByteUnit as ByteUnit, units_COMMON_CURRENCIES as COMMON_CURRENCIES, units_COMMON_LOCALES as COMMON_LOCALES, units_COMMON_PERMISSIONS as COMMON_PERMISSIONS, units_COMMON_RATIOS as COMMON_RATIOS, units_COMMON_SIZES as COMMON_SIZES, units_COMMON_TAX_RATES as COMMON_TAX_RATES, units_COMMON_TIP_PERCENTAGES as COMMON_TIP_PERCENTAGES, units_COMMON_VIEWPORTS as COMMON_VIEWPORTS, type units_CardValidationResult as CardValidationResult, type units_CompoundInterestResult as CompoundInterestResult, type units_CompoundYearRow as CompoundYearRow, type units_Dimensions as Dimensions, type units_DiscountField as DiscountField, type units_DiscountInput as DiscountInput, type units_DiscountResult as DiscountResult, type units_EmiResult as EmiResult, type units_EmiTenureUnit as EmiTenureUnit, type units_EmiYearlyBreakdownRow as EmiYearlyBreakdownRow, type units_FilePermissions as FilePermissions, type units_FormatOptions as FormatOptions, type units_IbanValidationResult as IbanValidationResult, type units_IpConversion as IpConversion, type units_IsbnFormat as IsbnFormat, type units_IsbnResult as IsbnResult, type units_LoanResult as LoanResult, type units_MarginMarkupField as MarginMarkupField, type units_MarginMarkupInput as MarginMarkupInput, type units_MarginMarkupResult as MarginMarkupResult, type units_NotationStyle as NotationStyle, type units_NumberBase as NumberBase, type units_PercentChangeDirection as PercentChangeDirection, type units_PercentageChangeResult as PercentageChangeResult, type units_Permission as Permission, type units_PxConvertResult as PxConvertResult, type units_RuleOf72Direction as RuleOf72Direction, type units_RuleOf72Result as RuleOf72Result, type units_SavingsGoalInput as SavingsGoalInput, type units_SavingsGoalMode as SavingsGoalMode, type units_SavingsGoalResult as SavingsGoalResult, type units_SemverVersion as SemverVersion, type units_SimpleInterestResult as SimpleInterestResult, type units_SubnetInfo as SubnetInfo, type units_SuccessiveDiscountResult as SuccessiveDiscountResult, type units_SuccessiveDiscountStep as SuccessiveDiscountStep, type units_TaxDirection as TaxDirection, type units_TaxResult as TaxResult, type units_TimeValueDirection as TimeValueDirection, type units_TimeValueResult as TimeValueResult, type units_TipSplitResult as TipSplitResult, type units_VideoBitrateInput as VideoBitrateInput, type units_VideoBitrateMode as VideoBitrateMode, type units_VideoBitrateResult as VideoBitrateResult, type units_ViewportConvertResult as ViewportConvertResult, units_applySuccessiveDiscounts as applySuccessiveDiscounts, units_autoFormat as autoFormat, units_bumpVersion as bumpVersion, units_calcAspectRatio as calcAspectRatio, units_calcSubnet as calcSubnet, units_calculateBreakEven as calculateBreakEven, units_calculateCompoundInterest as calculateCompoundInterest, units_calculateDiscount as calculateDiscount, units_calculateEmi as calculateEmi, units_calculateLoan as calculateLoan, units_calculateMarginMarkup as calculateMarginMarkup, units_calculatePercentageChange as calculatePercentageChange, units_calculateRuleOf72 as calculateRuleOf72, units_calculateSavingsGoal as calculateSavingsGoal, units_calculateSimpleInterest as calculateSimpleInterest, units_calculateTax as calculateTax, units_calculateTimeValue as calculateTimeValue, units_calculateTipSplit as calculateTipSplit, units_calculateVideoBitrate as calculateVideoBitrate, units_compareSemver as compareSemver, units_convert as convert, units_convertAprApy as convertAprApy, units_convertBytes as convertBytes, units_convertIp as convertIp, units_coverBox as coverBox, units_decimalToIp as decimalToIp, units_decimalToIpCidr as decimalToIpCidr, units_describePermissions as describePermissions, units_fitIntoBox as fitIntoBox, units_formatNumber as formatNumber, units_formatValue as formatValue, units_formatVwValue as formatVwValue, units_formatWithSeparator as formatWithSeparator, units_gcd as gcd, units_ipFromBinary as ipFromBinary, units_ipFromDecimal as ipFromDecimal, units_ipFromHex as ipFromHex, units_ipToBinary as ipToBinary, units_ipToDecimal as ipToDecimal, units_ipToDecimalCidr as ipToDecimalCidr, units_ipToHex as ipToHex, units_ipToOctal as ipToOctal, units_isValid as isValid, units_isValidCidr as isValidCidr, units_isValidIp as isValidIp, units_isValidIpv4 as isValidIpv4, units_marginToMarkup as marginToMarkup, units_markupToMargin as markupToMargin, units_octalToPermissions as octalToPermissions, units_parseFileSize as parseFileSize, units_parseInput as parseInput, units_parseNumberString as parseNumberString, units_parseSemver as parseSemver, units_permissionsToChmod as permissionsToChmod, units_permissionsToOctal as permissionsToOctal, units_permissionsToSymbolic as permissionsToSymbolic, units_ptToPx as ptToPx, units_pxToAll as pxToAll, units_pxToViewport as pxToViewport, units_remToPx as remToPx, units_satisfiesRange as satisfiesRange, units_scaleByHeight as scaleByHeight, units_scaleByWidth as scaleByWidth, units_sortVersions as sortVersions, units_splitSubnet as splitSubnet, units_symbolicToPermissions as symbolicToPermissions, units_validateBarcode as validateBarcode, units_validateCardNumber as validateCardNumber, units_validateIban as validateIban, units_validateIsbn as validateIsbn, units_viewportToPx as viewportToPx };
 }
 
-export { type SubnetInfo as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type EmiResult as E, type EmiTenureUnit as F, type EmiYearlyBreakdownRow as G, type FilePermissions as H, type FormatOptions as I, type IbanValidationResult as J, type IpConversion as K, type IsbnFormat as L, type IsbnResult as M, type LoanResult as N, type MarginMarkupField as O, type MarginMarkupInput as P, type MarginMarkupResult as Q, type NotationStyle as R, type NumberBase as S, type PercentChangeDirection as T, type PercentageChangeResult as U, type Permission as V, type PxConvertResult as W, type RuleOf72Direction as X, type RuleOf72Result as Y, type SemverVersion as Z, type SimpleInterestResult as _, type AprApyDirection as a, permissionsToChmod as a$, type SuccessiveDiscountResult as a0, type SuccessiveDiscountStep as a1, type TaxDirection as a2, type TaxResult as a3, type TimeValueDirection as a4, type TimeValueResult as a5, type TipSplitResult as a6, type VideoBitrateInput as a7, type VideoBitrateMode as a8, type VideoBitrateResult as a9, decimalToIpCidr as aA, describePermissions as aB, fitIntoBox as aC, formatNumber as aD, formatValue as aE, formatVwValue as aF, formatWithSeparator as aG, gcd as aH, ipFromBinary as aI, ipFromDecimal as aJ, ipFromHex as aK, ipToBinary as aL, ipToDecimal as aM, ipToDecimalCidr as aN, ipToHex as aO, ipToOctal as aP, isValid as aQ, isValidCidr as aR, isValidIp as aS, isValidIpv4 as aT, marginToMarkup as aU, markupToMargin as aV, octalToPermissions as aW, parseFileSize as aX, parseInput as aY, parseNumberString as aZ, parseSemver as a_, type ViewportConvertResult as aa, applySuccessiveDiscounts as ab, autoFormat as ac, bumpVersion as ad, calcAspectRatio as ae, calcSubnet as af, calculateBreakEven as ag, calculateCompoundInterest as ah, calculateDiscount as ai, calculateEmi as aj, calculateLoan as ak, calculateMarginMarkup as al, calculatePercentageChange as am, calculateRuleOf72 as an, calculateSimpleInterest as ao, calculateTax as ap, calculateTimeValue as aq, calculateTipSplit as ar, calculateVideoBitrate as as, compareSemver as at, convert as au, convertAprApy as av, convertBytes as aw, convertIp as ax, coverBox as ay, decimalToIp as az, type AprApyResult as b, permissionsToOctal as b0, permissionsToSymbolic as b1, ptToPx as b2, pxToAll as b3, pxToViewport as b4, remToPx as b5, satisfiesRange as b6, scaleByHeight as b7, scaleByWidth as b8, sortVersions as b9, splitSubnet as ba, symbolicToPermissions as bb, validateBarcode as bc, validateCardNumber as bd, validateIban as be, validateIsbn as bf, viewportToPx as bg, type AspectRatioResult as c, BASE_PREFIXES as d, BYTE_UNITS as e, type BarcodeFormat as f, type BarcodeValidationResult as g, type BaseConvertResult as h, type BreakEvenInput as i, type BreakEvenResult as j, type ByteConvertResult as k, type ByteUnit as l, COMMON_LOCALES as m, COMMON_PERMISSIONS as n, COMMON_RATIOS as o, COMMON_SIZES as p, COMMON_TAX_RATES as q, COMMON_TIP_PERCENTAGES as r, COMMON_VIEWPORTS as s, type CardValidationResult as t, units as u, type CompoundInterestResult as v, type CompoundYearRow as w, type DiscountField as x, type DiscountInput as y, type DiscountResult as z };
+export { type SavingsGoalResult as $, type AmortizationRow as A, BASE_LABELS as B, COMMON_CURRENCIES as C, type Dimensions as D, type EmiResult as E, type EmiTenureUnit as F, type EmiYearlyBreakdownRow as G, type FilePermissions as H, type FormatOptions as I, type IbanValidationResult as J, type IpConversion as K, type IsbnFormat as L, type IsbnResult as M, type LoanResult as N, type MarginMarkupField as O, type MarginMarkupInput as P, type MarginMarkupResult as Q, type NotationStyle as R, type NumberBase as S, type PercentChangeDirection as T, type PercentageChangeResult as U, type Permission as V, type PxConvertResult as W, type RuleOf72Direction as X, type RuleOf72Result as Y, type SavingsGoalInput as Z, type SavingsGoalMode as _, type AprApyDirection as a, parseFileSize as a$, type SemverVersion as a0, type SimpleInterestResult as a1, type SubnetInfo as a2, type SuccessiveDiscountResult as a3, type SuccessiveDiscountStep as a4, type TaxDirection as a5, type TaxResult as a6, type TimeValueDirection as a7, type TimeValueResult as a8, type TipSplitResult as a9, convertBytes as aA, convertIp as aB, coverBox as aC, decimalToIp as aD, decimalToIpCidr as aE, describePermissions as aF, fitIntoBox as aG, formatNumber as aH, formatValue as aI, formatVwValue as aJ, formatWithSeparator as aK, gcd as aL, ipFromBinary as aM, ipFromDecimal as aN, ipFromHex as aO, ipToBinary as aP, ipToDecimal as aQ, ipToDecimalCidr as aR, ipToHex as aS, ipToOctal as aT, isValid as aU, isValidCidr as aV, isValidIp as aW, isValidIpv4 as aX, marginToMarkup as aY, markupToMargin as aZ, octalToPermissions as a_, type VideoBitrateInput as aa, type VideoBitrateMode as ab, type VideoBitrateResult as ac, type ViewportConvertResult as ad, applySuccessiveDiscounts as ae, autoFormat as af, bumpVersion as ag, calcAspectRatio as ah, calcSubnet as ai, calculateBreakEven as aj, calculateCompoundInterest as ak, calculateDiscount as al, calculateEmi as am, calculateLoan as an, calculateMarginMarkup as ao, calculatePercentageChange as ap, calculateRuleOf72 as aq, calculateSavingsGoal as ar, calculateSimpleInterest as as, calculateTax as at, calculateTimeValue as au, calculateTipSplit as av, calculateVideoBitrate as aw, compareSemver as ax, convert as ay, convertAprApy as az, type AprApyResult as b, parseInput as b0, parseNumberString as b1, parseSemver as b2, permissionsToChmod as b3, permissionsToOctal as b4, permissionsToSymbolic as b5, ptToPx as b6, pxToAll as b7, pxToViewport as b8, remToPx as b9, satisfiesRange as ba, scaleByHeight as bb, scaleByWidth as bc, sortVersions as bd, splitSubnet as be, symbolicToPermissions as bf, validateBarcode as bg, validateCardNumber as bh, validateIban as bi, validateIsbn as bj, viewportToPx as bk, type AspectRatioResult as c, BASE_PREFIXES as d, BYTE_UNITS as e, type BarcodeFormat as f, type BarcodeValidationResult as g, type BaseConvertResult as h, type BreakEvenInput as i, type BreakEvenResult as j, type ByteConvertResult as k, type ByteUnit as l, COMMON_LOCALES as m, COMMON_PERMISSIONS as n, COMMON_RATIOS as o, COMMON_SIZES as p, COMMON_TAX_RATES as q, COMMON_TIP_PERCENTAGES as r, COMMON_VIEWPORTS as s, type CardValidationResult as t, units as u, type CompoundInterestResult as v, type CompoundYearRow as w, type DiscountField as x, type DiscountInput as y, type DiscountResult as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utilix-tech/sdk",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "154+ developer utility tools for Node.js: JSON, encoding, hashing, color, CSS, network and more. Runs locally, no API key required.",
   "author": "Utilix <hello@utilix.tech>",
   "license": "MIT",