@jjlmoya/utils-finance 1.43.0 → 1.44.0

package/src/tool/insuranceDeductibleBreakEvenCalculator/logic.ts

@@ -0,0 +1,72 @@
+import { isInsuranceCurrencyCode, type InsuranceCurrencyCode } from './currency';
+
+export interface InsuranceDeductibleInput {
+  currency: string;
+  damageCost: number;
+  deductible: number;
+  annualPremium: number;
+  premiumIncreasePercent: number;
+  surchargeYears: number;
+}
+
+export type InsuranceRecommendation = 'claim' | 'payYourself' | 'breakEven';
+
+export interface InsuranceValidationErrors {
+  currency?: string;
+  damageCost?: string;
+  deductible?: string;
+  annualPremium?: string;
+  premiumIncreasePercent?: string;
+  surchargeYears?: string;
+}
+
+export interface InsuranceDeductibleResult {
+  currency: InsuranceCurrencyCode;
+  damageCost: number;
+  deductible: number;
+  annualPremium: number;
+  premiumIncreasePercent: number;
+  surchargeYears: number;
+  premiumSurcharge: number;
+  insurerShare: number;
+  claimCost: number;
+  payYourselfCost: number;
+  difference: number;
+  breakEvenDamage: number;
+  recommendation: InsuranceRecommendation;
+}
+
+const roundMoney = (value: number): number => Number(value.toFixed(2));
+const isMoney = (value: number): boolean => Number.isFinite(value) && value >= 0 && value <= 1_000_000_000_000;
+
+export function validateInsuranceInput(input: InsuranceDeductibleInput): InsuranceValidationErrors {
+  const errors: InsuranceValidationErrors = {};
+  const currency = input.currency.trim().toUpperCase();
+  const addError = (key: keyof InsuranceValidationErrors, invalid: boolean): void => { if (invalid) errors[key] = key; };
+  addError('currency', !isInsuranceCurrencyCode(currency));
+  addError('damageCost', !Number.isFinite(input.damageCost) || input.damageCost <= 0 || input.damageCost > 1_000_000_000_000);
+  addError('deductible', !isMoney(input.deductible));
+  addError('annualPremium', !isMoney(input.annualPremium));
+  addError('premiumIncreasePercent', !Number.isFinite(input.premiumIncreasePercent) || input.premiumIncreasePercent < 0 || input.premiumIncreasePercent > 100);
+  addError('surchargeYears', !Number.isFinite(input.surchargeYears) || input.surchargeYears <= 0 || input.surchargeYears > 20);
+  return errors;
+}
+
+const recommendationFor = (difference: number): InsuranceRecommendation => {
+  if (difference > 0.005) return 'claim';
+  if (difference < -0.005) return 'payYourself';
+  return 'breakEven';
+};
+
+export function calculateInsuranceDeductibleBreakEven(input: InsuranceDeductibleInput): InsuranceDeductibleResult | null {
+  const errors = validateInsuranceInput(input);
+  if (Object.keys(errors).length > 0) return null;
+  const currency = input.currency.trim().toUpperCase() as InsuranceCurrencyCode;
+  const premiumSurcharge = roundMoney(input.annualPremium * input.premiumIncreasePercent / 100 * input.surchargeYears);
+  const insurerShare = roundMoney(Math.max(0, input.damageCost - input.deductible));
+  const claimCost = roundMoney(Math.min(input.damageCost, input.deductible) + premiumSurcharge);
+  const payYourselfCost = roundMoney(input.damageCost);
+  const difference = roundMoney(payYourselfCost - claimCost);
+  const breakEvenDamage = roundMoney(input.deductible + premiumSurcharge);
+  return { currency, damageCost: payYourselfCost, deductible: roundMoney(input.deductible), annualPremium: roundMoney(input.annualPremium), premiumIncreasePercent: input.premiumIncreasePercent, surchargeYears: input.surchargeYears, premiumSurcharge, insurerShare, claimCost, payYourselfCost, difference, breakEvenDamage, recommendation: recommendationFor(difference) };
+}

package/src/tool/insuranceDeductibleBreakEvenCalculator/seo.astro

@@ -0,0 +1,11 @@
+---
+import { SEORenderer } from '@jjlmoya/utils-shared';
+import { insuranceDeductibleBreakEvenCalculator } from './entry';
+import type { KnownLocale } from '../../types';
+
+interface Props { locale?: KnownLocale; }
+const { locale = 'en' } = Astro.props;
+const content = await insuranceDeductibleBreakEvenCalculator.i18n[locale]?.() ?? await insuranceDeductibleBreakEvenCalculator.i18n.en?.();
+---
+
+{content?.seo && <SEORenderer content={{ locale, sections: content.seo }} />}

package/src/tool/insuranceDeductibleBreakEvenCalculator/ui.ts

@@ -0,0 +1,33 @@
+export interface InsuranceDeductibleBreakEvenCalculatorUI extends Record<string, string> {
+  labelDamageCost: string;
+  labelDeductible: string;
+  labelAnnualPremium: string;
+  labelPremiumIncrease: string;
+  labelSurchargeYears: string;
+  labelCurrency: string;
+  labelClaimRoute: string;
+  labelPayYourselfRoute: string;
+  labelClaimCost: string;
+  labelPayYourselfCost: string;
+  labelPremiumSurcharge: string;
+  labelInsurerShare: string;
+  labelBreakEvenDamage: string;
+  labelDifference: string;
+  labelRecommendation: string;
+  labelClaimRecommended: string;
+  labelPayYourselfRecommended: string;
+  labelBreakEvenRecommendation: string;
+  labelVisual: string;
+  labelReset: string;
+  labelCopy: string;
+  labelCopied: string;
+  labelCopyFailed: string;
+  labelInvalidInput: string;
+  labelMethodTitle: string;
+  labelMethodText: string;
+  labelPrivacyNote: string;
+  labelAmountPlaceholder: string;
+  labelPercentPlaceholder: string;
+  labelYearsPlaceholder: string;
+  labelApproximateRates: string;
+}

package/src/tools.ts

@@ -25,5 +25,6 @@ import { SUBSCRIPTION_COST_ANNUALIZER_TOOL } from './tool/subscriptionCostAnnual
 import { LOAN_TO_INCOME_RATIO_TOOL } from './tool/loanToIncomeRatio';
 import { RENTAL_DEPOSIT_RETURN_TOOL } from './tool/rentalDepositReturn';
 import { CAPITAL_GAINS_TAX_SCENARIO_CALCULATOR_TOOL } from './tool/capitalGainsTaxScenarioCalculator';
+import { INSURANCE_DEDUCTIBLE_BREAK_EVEN_CALCULATOR_TOOL } from './tool/insuranceDeductibleBreakEvenCalculator';
 
-export const ALL_TOOLS: ToolDefinition[] = [COMPOUND_INTEREST_TOOL, FINANCIAL_FREEDOM_TOOL, SAVINGS_RATE_TOOL, PROFITABILITY_TOOL, MORTGAGE_TOOL, INFLATION_TOOL, PERCENTAGE_CALCULATOR_TOOL, LATE_INTEREST_TOOL, IBAN_BIC_SWIFT_TOOL, RENT_INCREASE_TOOL, LOTTERY_OPTIMIZER_TOOL, COURT_FEE_CALCULATOR_TOOL, LEGAL_INTEREST_RATE_TOOL, FIRE_CALCULATOR_TOOL, DEBT_SNOWBALL_TOOL, REVOLVING_CARD_CALCULATOR_TOOL, PESETA_VALUE_TOOL, SALARY_EMPLOYER_COST_TOOL, DIVIDEND_YIELD_TOOL, MORTGAGE_EXTRA_PAYMENT_PLANNER_TOOL, INFLATION_PURCHASING_POWER_TOOL, SUBSCRIPTION_COST_ANNUALIZER_TOOL, LOAN_TO_INCOME_RATIO_TOOL, RENTAL_DEPOSIT_RETURN_TOOL, CAPITAL_GAINS_TAX_SCENARIO_CALCULATOR_TOOL];
+export const ALL_TOOLS: ToolDefinition[] = [COMPOUND_INTEREST_TOOL, FINANCIAL_FREEDOM_TOOL, SAVINGS_RATE_TOOL, PROFITABILITY_TOOL, MORTGAGE_TOOL, INFLATION_TOOL, PERCENTAGE_CALCULATOR_TOOL, LATE_INTEREST_TOOL, IBAN_BIC_SWIFT_TOOL, RENT_INCREASE_TOOL, LOTTERY_OPTIMIZER_TOOL, COURT_FEE_CALCULATOR_TOOL, LEGAL_INTEREST_RATE_TOOL, FIRE_CALCULATOR_TOOL, DEBT_SNOWBALL_TOOL, REVOLVING_CARD_CALCULATOR_TOOL, PESETA_VALUE_TOOL, SALARY_EMPLOYER_COST_TOOL, DIVIDEND_YIELD_TOOL, MORTGAGE_EXTRA_PAYMENT_PLANNER_TOOL, INFLATION_PURCHASING_POWER_TOOL, SUBSCRIPTION_COST_ANNUALIZER_TOOL, LOAN_TO_INCOME_RATIO_TOOL, RENTAL_DEPOSIT_RETURN_TOOL, CAPITAL_GAINS_TAX_SCENARIO_CALCULATOR_TOOL, INSURANCE_DEDUCTIBLE_BREAK_EVEN_CALCULATOR_TOOL];