@jjlmoya/utils-finance 1.41.0 → 1.42.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jjlmoya/utils-finance",
-    "version": "1.41.0",
+    "version": "1.42.0",
     "type": "module",
     "main": "./src/index.ts",
     "types": "./src/index.ts",

package/src/entries.ts

@@ -44,6 +44,8 @@ export { subscriptionCostAnnualizer } from './tool/subscriptionCostAnnualizer/en
 export type { SubscriptionCostAnnualizerLocaleContent } from './tool/subscriptionCostAnnualizer/entry';
 export { loanToIncomeRatio } from './tool/loanToIncomeRatio/entry';
 export type { LoanToIncomeRatioLocaleContent } from './tool/loanToIncomeRatio/entry';
+export { rentalDepositReturn } from './tool/rentalDepositReturn/entry';
+export type { RentalDepositReturnLocaleContent } from './tool/rentalDepositReturn/entry';
 export { financeCategory } from './category';
 import { compoundInterest } from './tool/compoundInterest/entry';
 import { financialFreedom } from './tool/financialFreedom/entry';
@@ -67,4 +69,5 @@ import { mortgageExtraPaymentPlanner } from './tool/mortgageExtraPaymentPlanner/
 import { inflationPurchasingPower } from './tool/inflationPurchasingPower/entry';
 import { subscriptionCostAnnualizer } from './tool/subscriptionCostAnnualizer/entry';
 import { loanToIncomeRatio } from './tool/loanToIncomeRatio/entry';
-export const ALL_ENTRIES = [compoundInterest, financialFreedom, savingsRate, profitability, courtFeeCalculator, debtSnowball, fireCalculator, ibanBicSwift, inflation, lateInterest, legalInterestRate, lotteryOptimizer, mortgage, percentageCalculator, rentIncrease, revolvingCardCalculator, pesetaValue, salaryEmployerCost, dividendYield, mortgageExtraPaymentPlanner, inflationPurchasingPower, subscriptionCostAnnualizer, loanToIncomeRatio];
+import { rentalDepositReturn } from './tool/rentalDepositReturn/entry';
+export const ALL_ENTRIES = [compoundInterest, financialFreedom, savingsRate, profitability, courtFeeCalculator, debtSnowball, fireCalculator, ibanBicSwift, inflation, lateInterest, legalInterestRate, lotteryOptimizer, mortgage, percentageCalculator, rentIncrease, revolvingCardCalculator, pesetaValue, salaryEmployerCost, dividendYield, mortgageExtraPaymentPlanner, inflationPurchasingPower, subscriptionCostAnnualizer, loanToIncomeRatio, rentalDepositReturn];

package/src/tests/locale_completeness.test.ts

@@ -25,7 +25,7 @@ describe('Locale Completeness Validation', () => {
     });
   });
 
-  it('all 23 tools registered', () => {
-    expect(ALL_TOOLS.length).toBe(23);
+  it('all 24 tools registered', () => {
+    expect(ALL_TOOLS.length).toBe(24);
   });
 });

package/src/tests/tool_validation.test.ts

@@ -4,8 +4,8 @@ import { financeCategory } from '../data';
 
 describe('Tool Validation Suite', () => {
   describe('Library Registration', () => {
-    it('should have 23 tools in ALL_TOOLS', () => {
-      expect(ALL_TOOLS.length).toBe(23);
+    it('should have 24 tools in ALL_TOOLS', () => {
+      expect(ALL_TOOLS.length).toBe(24);
     });
 
     it('financeCategory should be defined', () => {

package/src/tool/rentalDepositReturn/bibliography.astro

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

package/src/tool/rentalDepositReturn/bibliography.ts

@@ -0,0 +1,6 @@
+import type { BibliographyEntry } from '../../types';
+
+export const bibliography: BibliographyEntry[] = [
+  { name: 'Boletín Oficial del Estado, Ley 29/1994 de Arrendamientos Urbanos, artículo 36', url: 'https://www.boe.es/buscar/act.php?id=BOE-A-1994-26003' },
+  { name: 'GOV.UK, Tenancy deposit protection: Overview', url: 'https://www.gov.uk/tenancy-deposit-protection' },
+];

package/src/tool/rentalDepositReturn/component.astro

@@ -0,0 +1,53 @@
+---
+import type { RentalDepositReturnUI } from './ui';
+import { CURRENCIES, getDefaultCurrency, type CurrencyCode } from './currency';
+import type { RentalDepositInput } from './logic';
+import { calculateRentalDepositReturn } from './logic';
+import { renderDepositResults, renderDepositScene } from './dom-views';
+import './rental-deposit-return-calculator.css';
+
+interface Props { ui: RentalDepositReturnUI; locale?: string; }
+
+const { ui, locale = 'en' } = Astro.props;
+const initialCurrency = getDefaultCurrency(locale);
+const initial: RentalDepositInput = {
+  currency: initialCurrency,
+  deposit: 1200,
+  deductions: [
+    { id: 'final-bills', description: 'Final utility bills', amount: 84, status: 'confirmed' },
+    { id: 'wall-repair', description: 'Wall repair', amount: 165, status: 'disputed' },
+    { id: 'cleaning', description: 'Cleaning charge', amount: 60, status: 'disputed' },
+  ],
+};
+const initialResult = calculateRentalDepositReturn(initial);
+const config = JSON.stringify({ ui, initial, locale });
+const currencyOptions = Object.values(CURRENCIES) as Array<{ code: CurrencyCode; symbol: string }>;
+---
+
+<div class="rdr-tool" data-rdr-tool>
+  <form class="rdr-controls" aria-label={ui.deductionsTitle}>
+    <div class="rdr-top-controls">
+      <label class="rdr-deposit-field"><span>{ui.depositLabel}</span><input data-rdr-deposit type="number" min="0" step="0.01" inputmode="decimal" required /><small>{ui.depositHelp}</small></label>
+      <div class="rdr-currency-field"><span class="rdr-field-label">{ui.currencyLabel}</span><div class="rdr-currency-select" data-rdr-currency-select data-value={initialCurrency}>
+        <button type="button" class="rdr-currency-trigger" id="rdr-currency-trigger" data-rdr-currency-trigger aria-haspopup="listbox" aria-expanded="false" aria-controls="rdr-currency-menu" aria-label={`${ui.currencyLabel}: ${initialCurrency}`}><span class="rdr-currency-trigger-symbol" data-rdr-currency-symbol aria-hidden="true">{CURRENCIES[initialCurrency].symbol}</span><span class="rdr-currency-trigger-arrow" aria-hidden="true"></span></button>
+        <div class="rdr-currency-menu" id="rdr-currency-menu" data-rdr-currency-menu role="listbox" hidden aria-label={ui.currencyLabel}>
+          {currencyOptions.map((option) => <button type="button" class="rdr-currency-option" data-rdr-currency-option data-value={option.code} role="option" aria-label={`${option.code}: ${option.symbol}`} aria-selected={option.code === initialCurrency}><span aria-hidden="true">{option.symbol}</span></button>)}
+        </div>
+      </div><small>{ui.currencyHelp}</small></div>
+    </div>
+    <div class="rdr-list-heading"><div><h2>{ui.deductionsTitle}</h2><p>{ui.deductionsHelp}</p></div><button type="button" class="rdr-secondary-button" data-rdr-reset>{ui.resetButton}</button></div>
+    <div class="rdr-list" data-rdr-list></div>
+    <div class="rdr-actions"><button type="button" class="rdr-primary-button" data-rdr-add>{ui.addButton}</button><button type="button" class="rdr-copy-button" data-rdr-copy><span data-rdr-copy-label>{ui.copyButton}</span></button></div>
+  </form>
+  <section class="rdr-output" aria-live="polite"><div class="rdr-scene-wrap" data-rdr-scene set:html={initialResult ? renderDepositScene(initialResult, ui, locale) : ''}></div><div class="rdr-results-wrap" data-rdr-results set:html={initialResult ? renderDepositResults(initialResult, ui, locale) : ''}></div><p class="rdr-error" data-rdr-error hidden>{ui.emptyMessage}</p></section>
+  <p class="rdr-privacy">{ui.privacyNote}</p>
+  <details class="rdr-method"><summary>{ui.methodTitle}</summary><p>{ui.methodText}</p><p>{ui.limitationText}</p></details>
+</div>
+
+<script is:inline type="application/json" data-rdr-config set:html={config}></script>
+<script>
+  import { initRentalDepositReturn } from './controller';
+  const root = document.querySelector<HTMLElement>('[data-rdr-tool]');
+  const configElement = document.querySelector<HTMLScriptElement>('[data-rdr-config]');
+  if (root && configElement?.textContent) initRentalDepositReturn(root, JSON.parse(configElement.textContent));
+</script>

package/src/tool/rentalDepositReturn/controller.ts

@@ -0,0 +1,156 @@
+import { calculateRentalDepositReturn, type DeductionInput, type DeductionStatus, type RentalDepositInput } from './logic';
+import { CURRENCIES, type CurrencyCode } from './currency';
+import { renderDepositResults, renderDepositScene } from './dom-views';
+import type { RentalDepositReturnUI } from './ui';
+
+interface Config { ui: RentalDepositReturnUI; initial: RentalDepositInput; locale: string; }
+
+function createId(): string {
+  return `deduction-${Date.now()}-${Math.random().toString(36).slice(2, 7)}`;
+}
+
+function escapeAttribute(value: string): string {
+  return value.replace(/[&<>"']/g, (character) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#39;' })[character] ?? character);
+}
+
+function fieldValue(row: HTMLElement, selector: string): string {
+  return row.querySelector<HTMLInputElement | HTMLSelectElement>(selector)?.value.trim() ?? '';
+}
+
+function readDeductions(root: HTMLElement): DeductionInput[] {
+  return Array.from(root.querySelectorAll<HTMLElement>('[data-rdr-row]')).map((row) => ({
+    id: row.dataset.rdrRow ?? createId(),
+    description: fieldValue(row, '[data-rdr-field="description"]'),
+    amount: Number(fieldValue(row, '[data-rdr-field="amount"]')),
+    status: (fieldValue(row, '[data-rdr-field="status"]') || 'confirmed') as DeductionStatus,
+  }));
+}
+
+function collectState(root: HTMLElement): RentalDepositInput {
+  return {
+    currency: root.querySelector<HTMLElement>('[data-rdr-currency-select]')?.dataset.value ?? 'EUR',
+    deposit: Number(root.querySelector<HTMLInputElement>('[data-rdr-deposit]')?.value ?? 0),
+    deductions: readDeductions(root),
+  };
+}
+
+function render(root: HTMLElement, state: RentalDepositInput, ui: RentalDepositReturnUI, locale: string): void {
+  const result = calculateRentalDepositReturn(state);
+  const scene = root.querySelector<HTMLElement>('[data-rdr-scene]');
+  const results = root.querySelector<HTMLElement>('[data-rdr-results]');
+  const error = root.querySelector<HTMLElement>('[data-rdr-error]');
+  if (!scene || !results || !error) return;
+  if (!result) {
+    scene.innerHTML = '';
+    results.innerHTML = '';
+    error.hidden = false;
+    return;
+  }
+  error.hidden = true;
+  scene.innerHTML = renderDepositScene(result, ui, locale);
+  results.innerHTML = renderDepositResults(result, ui, locale);
+}
+
+function rowMarkup(item: DeductionInput, ui: RentalDepositReturnUI): string {
+  return `<div class="rdr-row" data-rdr-row="${escapeAttribute(item.id)}"><label><span>${escapeAttribute(ui.descriptionLabel)}</span><input data-rdr-field="description" value="${escapeAttribute(item.description)}" placeholder="${escapeAttribute(ui.descriptionPlaceholder)}" required /></label><label><span>${escapeAttribute(ui.amountLabel)}</span><input data-rdr-field="amount" type="number" min="0" step="0.01" value="${item.amount}" inputmode="decimal" required /></label><label><span>${escapeAttribute(ui.statusLabel)}</span><span class="rdr-select-wrap"><select data-rdr-field="status"><option value="confirmed" ${item.status === 'confirmed' ? 'selected' : ''}>${escapeAttribute(ui.confirmedOption)}</option><option value="disputed" ${item.status === 'disputed' ? 'selected' : ''}>${escapeAttribute(ui.disputedOption)}</option></select><span class="rdr-select-arrow" aria-hidden="true"></span></span></label><button type="button" class="rdr-remove" data-rdr-remove aria-label="${escapeAttribute(ui.removeButton)}">×</button></div>`;
+}
+
+function report(result: ReturnType<typeof calculateRentalDepositReturn>, ui: RentalDepositReturnUI, locale: string): string {
+  if (!result) return '';
+  const format = (value: number): string => new Intl.NumberFormat(locale, { style: 'currency', currency: result.currency }).format(value);
+  const lines = result.deductions.map((deduction) => `- ${deduction.description}: ${format(deduction.amount)} (${deduction.status === 'confirmed' ? ui.confirmedOption : ui.disputedOption})`);
+  return [ui.reportTitle, `${ui.reportDeposit}: ${format(result.deposit)}`, `${ui.reportDeductions}:`, ...lines, `${ui.reportConfirmed}: ${format(result.confirmedDeductions)}`, `${ui.reportDisputed}: ${format(result.disputedDeductions)}`, `${ui.reportEstimatedReturn}: ${format(result.estimatedReturn)}`, `${ui.reportPotentialReturn}: ${format(result.undisputedReturn)}`, ui.reportNote].join('\n');
+}
+
+// eslint-disable-next-line max-lines-per-function, complexity
+export function initRentalDepositReturn(root: HTMLElement, config: Config): void {
+  const deposit = root.querySelector<HTMLInputElement>('[data-rdr-deposit]');
+  const currency = root.querySelector<HTMLElement>('[data-rdr-currency-select]');
+  const currencyTrigger = currency?.querySelector<HTMLButtonElement>('[data-rdr-currency-trigger]');
+  const currencyMenu = currency?.querySelector<HTMLElement>('[data-rdr-currency-menu]');
+  const list = root.querySelector<HTMLElement>('[data-rdr-list]');
+  const copy = root.querySelector<HTMLButtonElement>('[data-rdr-copy]');
+  if (!deposit || !currency || !currencyTrigger || !currencyMenu || !list || !copy) return;
+  const initialState = config.initial;
+  deposit.value = String(initialState.deposit);
+  currency.dataset.value = initialState.currency;
+  list.innerHTML = initialState.deductions.map((item) => rowMarkup(item, config.ui)).join('');
+  render(root, initialState, config.ui, config.locale);
+  root.addEventListener('input', () => render(root, collectState(root), config.ui, config.locale));
+  root.addEventListener('change', () => render(root, collectState(root), config.ui, config.locale));
+  const closeCurrencyMenu = (): void => {
+    currencyMenu.hidden = true;
+    currencyTrigger.setAttribute('aria-expanded', 'false');
+  };
+  const syncCurrency = (value: CurrencyCode): void => {
+    currency.dataset.value = value;
+    const definition = CURRENCIES[value];
+    const symbol = currency.querySelector<HTMLElement>('[data-rdr-currency-symbol]');
+    if (symbol) symbol.textContent = definition.symbol;
+    currencyTrigger.setAttribute('aria-label', `${config.ui.currencyLabel}: ${value}`);
+    currency.querySelectorAll<HTMLButtonElement>('[data-rdr-currency-option]').forEach((option) => {
+      option.classList.toggle('is-active', option.dataset.value === value);
+      option.setAttribute('aria-selected', `${option.dataset.value === value}`);
+    });
+  };
+  syncCurrency(initialState.currency as CurrencyCode);
+  const openCurrencyMenu = (focusActive = false): void => {
+    currencyMenu.hidden = false;
+    currencyTrigger.setAttribute('aria-expanded', 'true');
+    if (focusActive) currency.querySelector<HTMLButtonElement>('.rdr-currency-option.is-active')?.focus();
+  };
+  currencyTrigger.addEventListener('click', () => {
+    const shouldOpen = currencyMenu.hidden;
+    closeCurrencyMenu();
+    if (shouldOpen) openCurrencyMenu();
+  });
+  currencyTrigger.addEventListener('keydown', (event) => {
+    if (event.key === 'Escape') closeCurrencyMenu();
+    if (event.key === 'ArrowDown' || event.key === 'Enter' || event.key === ' ') {
+      event.preventDefault();
+      openCurrencyMenu(true);
+    }
+  });
+  currencyMenu.querySelectorAll<HTMLButtonElement>('[data-rdr-currency-option]').forEach((option) => {
+    option.addEventListener('click', () => {
+      const value = option.dataset.value as CurrencyCode;
+      syncCurrency(value);
+      closeCurrencyMenu();
+      currencyTrigger.focus();
+      render(root, collectState(root), config.ui, config.locale);
+    });
+  });
+  document.addEventListener('click', (event) => {
+    if (!currency.contains(event.target as Node)) closeCurrencyMenu();
+  });
+  root.addEventListener('click', (event) => {
+    const target = event.target as HTMLElement;
+    const remove = target.closest<HTMLButtonElement>('[data-rdr-remove]');
+    if (remove) {
+      remove.closest<HTMLElement>('[data-rdr-row]')?.remove();
+      render(root, collectState(root), config.ui, config.locale);
+      return;
+    }
+    if (target.closest('[data-rdr-add]')) {
+      const next: DeductionInput = { id: createId(), description: config.ui.newDeductionLabel, amount: 0, status: 'confirmed' };
+      list.insertAdjacentHTML('beforeend', rowMarkup(next, config.ui));
+      list.querySelector<HTMLElement>('[data-rdr-row]:last-child [data-rdr-field="description"]')?.focus();
+      render(root, collectState(root), config.ui, config.locale);
+      return;
+    }
+    if (target.closest('[data-rdr-reset]')) {
+      deposit.value = String(initialState.deposit);
+      syncCurrency(initialState.currency as CurrencyCode);
+      list.innerHTML = initialState.deductions.map((item) => rowMarkup(item, config.ui)).join('');
+      render(root, initialState, config.ui, config.locale);
+      return;
+    }
+    if (target.closest('[data-rdr-copy]')) {
+      const result = calculateRentalDepositReturn(collectState(root));
+      navigator.clipboard.writeText(report(result, config.ui, config.locale));
+      const label = copy.querySelector('[data-rdr-copy-label]');
+      if (label) label.textContent = config.ui.copiedButton;
+      window.setTimeout(() => { if (label) label.textContent = config.ui.copyButton; }, 2000);
+    }
+  });
+}

package/src/tool/rentalDepositReturn/currency.ts

@@ -0,0 +1,67 @@
+export type CurrencyCode =
+  | 'AUD' | 'BRL' | 'CAD' | 'CHF' | 'CNY' | 'CZK' | 'DKK'
+  | 'EUR' | 'GBP' | 'IDR' | 'INR' | 'JPY' | 'KRW' | 'MXN' | 'NOK'
+  | 'PLN' | 'RUB' | 'SEK' | 'TRY' | 'USD';
+
+export interface CurrencyDefinition {
+  code: CurrencyCode;
+  symbol: string;
+}
+
+export const CURRENCIES = {
+  AUD: { code: 'AUD', symbol: 'A$' },
+  BRL: { code: 'BRL', symbol: 'R$' },
+  CAD: { code: 'CAD', symbol: 'C$' },
+  CHF: { code: 'CHF', symbol: 'CHF' },
+  CNY: { code: 'CNY', symbol: '¥' },
+  CZK: { code: 'CZK', symbol: 'Kč' },
+  DKK: { code: 'DKK', symbol: 'kr' },
+  EUR: { code: 'EUR', symbol: '€' },
+  GBP: { code: 'GBP', symbol: '£' },
+  IDR: { code: 'IDR', symbol: 'Rp' },
+  INR: { code: 'INR', symbol: '₹' },
+  JPY: { code: 'JPY', symbol: '¥' },
+  KRW: { code: 'KRW', symbol: '₩' },
+  MXN: { code: 'MXN', symbol: 'MX$' },
+  NOK: { code: 'NOK', symbol: 'kr' },
+  PLN: { code: 'PLN', symbol: 'zł' },
+  RUB: { code: 'RUB', symbol: '₽' },
+  SEK: { code: 'SEK', symbol: 'kr' },
+  TRY: { code: 'TRY', symbol: '₺' },
+  USD: { code: 'USD', symbol: '$' },
+} as const satisfies Record<CurrencyCode, CurrencyDefinition>;
+
+const DEFAULT_CURRENCY_BY_LOCALE: Record<string, CurrencyCode> = {
+  'en-au': 'AUD',
+  'en-ca': 'CAD',
+  'en-gb': 'GBP',
+  'en-in': 'INR',
+  'fr-ca': 'CAD',
+  'pt-br': 'BRL',
+  de: 'EUR',
+  en: 'USD',
+  es: 'EUR',
+  fr: 'EUR',
+  id: 'IDR',
+  it: 'EUR',
+  ja: 'JPY',
+  ko: 'KRW',
+  nl: 'EUR',
+  pl: 'PLN',
+  pt: 'EUR',
+  ru: 'RUB',
+  sv: 'SEK',
+  tr: 'TRY',
+  zh: 'CNY',
+};
+
+export function getDefaultCurrency(locale: string): CurrencyCode {
+  const normalizedLocale = locale.toLowerCase().replace('_', '-');
+  return DEFAULT_CURRENCY_BY_LOCALE[normalizedLocale]
+    ?? DEFAULT_CURRENCY_BY_LOCALE[normalizedLocale.split('-')[0] ?? '']
+    ?? 'EUR';
+}
+
+export function isCurrencyCode(value: string): value is CurrencyCode {
+  return Object.prototype.hasOwnProperty.call(CURRENCIES, value);
+}

package/src/tool/rentalDepositReturn/dom-views.ts

@@ -0,0 +1,31 @@
+import type { RentalDepositResult } from './logic';
+import type { RentalDepositReturnUI } from './ui';
+
+function escapeHtml(value: string): string {
+  return value.replace(/[&<>"']/g, (character) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#39;' })[character] ?? character);
+}
+
+function formatMoney(value: number, currency: string, locale: string): string {
+  return new Intl.NumberFormat(locale, { style: 'currency', currency, maximumFractionDigits: 2 }).format(value);
+}
+
+function metric(label: string, value: string, accent = ''): string {
+  return `<div class="rdr-metric ${accent}"><span>${escapeHtml(label)}</span><strong>${escapeHtml(value)}</strong></div>`;
+}
+
+export function renderDepositScene(result: RentalDepositResult, ui: RentalDepositReturnUI, locale = 'en-US'): string {
+  const used = result.deposit > 0 ? Math.min(100, (result.totalDeductions / result.deposit) * 100) : 0;
+  const returnWidth = result.deposit > 0 ? Math.max(0, 100 - used) : 0;
+  const rows = result.deductions.length === 0
+    ? `<p class="rdr-scene-empty">${escapeHtml(ui.emptyMessage)}</p>`
+    : result.deductions.map((deduction) => `<div class="rdr-ledger-row ${deduction.status}"><span>${escapeHtml(deduction.description)}</span><i class="rdr-ledger-line"><b style="width:${Math.min(100, Math.max(0, deduction.shareOfDeposit)).toFixed(1)}%"></b></i><strong>${escapeHtml(formatMoney(deduction.amount, result.currency, locale))}</strong></div>`).join('');
+  return `<div class="rdr-scene" aria-label="${escapeHtml(ui.returnFlowTitle)}"><div class="rdr-scene-heading"><span class="rdr-key-mark" aria-hidden="true">⌁</span><div><strong>${escapeHtml(ui.returnFlowTitle)}</strong><p>${escapeHtml(ui.returnFlowText)}</p></div></div><div class="rdr-flow"><div class="rdr-flow-node rdr-flow-deposit"><span aria-hidden="true">●</span><strong>${escapeHtml(formatMoney(result.deposit, result.currency, locale))}</strong><small>${escapeHtml(ui.depositNode)}</small></div><div class="rdr-flow-arrow" aria-hidden="true">→</div><div class="rdr-flow-node rdr-flow-return" style="--return-width:${returnWidth.toFixed(1)}%"><span aria-hidden="true">↗</span><strong>${escapeHtml(formatMoney(result.estimatedReturn, result.currency, locale))}</strong><small>${escapeHtml(ui.returnNode)}</small></div></div><div class="rdr-meter" aria-label="${escapeHtml(ui.deductionNode)}"><span style="width:${used.toFixed(1)}%"></span></div><div class="rdr-meter-labels"><span>${escapeHtml(ui.deductionNode)} ${escapeHtml(formatMoney(result.totalDeductions, result.currency, locale))}</span><span>${escapeHtml(ui.returnNode)} ${escapeHtml(formatMoney(result.estimatedReturn, result.currency, locale))}</span></div><div class="rdr-ledger"><div class="rdr-ledger-title"><span>${escapeHtml(ui.deductionBreakdownTitle)}</span><span>${escapeHtml(ui.amountLabel)}</span></div>${rows}</div></div>`;
+}
+
+export function renderDepositResults(result: RentalDepositResult, ui: RentalDepositReturnUI, locale = 'en-US'): string {
+  const scenarioRows = result.scenarios.length === 0
+    ? `<p class="rdr-muted">${escapeHtml(ui.noDisputed)}</p>`
+    : `<div class="rdr-table-wrap"><table><thead><tr><th scope="col">${escapeHtml(ui.scenarioColumn)}</th><th scope="col">${escapeHtml(ui.scenarioReturnColumn)}</th><th scope="col">${escapeHtml(ui.scenarioIncreaseColumn)}</th></tr></thead><tbody>${result.scenarios.map((scenario) => `<tr><th scope="row">${escapeHtml(scenario.description)}</th><td>${escapeHtml(formatMoney(scenario.returnAmount, result.currency, locale))}</td><td>+${escapeHtml(formatMoney(scenario.additionalReturn, result.currency, locale))}</td></tr>`).join('')}</tbody></table></div>`;
+  const warning = result.overDeducted > 0 ? `<div class="rdr-warning"><strong>${escapeHtml(ui.overDeductedTitle)}</strong><p>${escapeHtml(ui.overDeductedText)} ${escapeHtml(formatMoney(result.overDeducted, result.currency, locale))}</p></div>` : '';
+  return `<div class="rdr-results"><div class="rdr-metrics">${metric(ui.estimatedReturnLabel, formatMoney(result.estimatedReturn, result.currency, locale), 'rdr-accent')}${metric(ui.undisputedReturnLabel, formatMoney(result.undisputedReturn, result.currency, locale))}${metric(ui.totalDeductionsLabel, formatMoney(result.totalDeductions, result.currency, locale))}</div>${warning}<section class="rdr-panel"><h3>${escapeHtml(ui.scenariosTitle)}</h3><p>${escapeHtml(ui.scenariosText)}</p>${scenarioRows}</section><section class="rdr-panel rdr-summary"><h3>${escapeHtml(ui.summaryTitle)}</h3><dl><div><dt>${escapeHtml(ui.confirmedLabel)}</dt><dd>${escapeHtml(formatMoney(result.confirmedDeductions, result.currency, locale))}</dd></div><div><dt>${escapeHtml(ui.disputedLabel)}</dt><dd>${escapeHtml(formatMoney(result.disputedDeductions, result.currency, locale))}</dd></div></dl></section></div>`;
+}

package/src/tool/rentalDepositReturn/entry.ts

@@ -0,0 +1,28 @@
+import type { FinanceToolEntry, ToolLocaleContent } from '../../types';
+import type { RentalDepositReturnUI } from './ui';
+
+export type RentalDepositReturnLocaleContent = ToolLocaleContent<RentalDepositReturnUI>;
+
+export const rentalDepositReturn: FinanceToolEntry<RentalDepositReturnUI> = {
+  id: 'rental-deposit-return-calculator',
+  icons: { bg: 'mdi:home-lock-open', fg: 'mdi:cash-refund' },
+  i18n: {
+    de: () => import('./i18n/de').then((module) => module.content),
+    en: () => import('./i18n/en').then((module) => module.content),
+    es: () => import('./i18n/es').then((module) => module.content),
+    fr: () => import('./i18n/fr').then((module) => module.content),
+    id: () => import('./i18n/id').then((module) => module.content),
+    it: () => import('./i18n/it').then((module) => module.content),
+    ja: () => import('./i18n/ja').then((module) => module.content),
+    ko: () => import('./i18n/ko').then((module) => module.content),
+    nl: () => import('./i18n/nl').then((module) => module.content),
+    pl: () => import('./i18n/pl').then((module) => module.content),
+    pt: () => import('./i18n/pt').then((module) => module.content),
+    ru: () => import('./i18n/ru').then((module) => module.content),
+    sv: () => import('./i18n/sv').then((module) => module.content),
+    tr: () => import('./i18n/tr').then((module) => module.content),
+    zh: () => import('./i18n/zh').then((module) => module.content),
+  },
+};
+
+export { bibliography } from './bibliography';

package/src/tool/rentalDepositReturn/i18n/content-factory.ts

@@ -0,0 +1,36 @@
+import type { FAQPage, HowTo, SoftwareApplication, WithContext } from 'schema-dts';
+import type { SEOSection, ToolLocaleContent } from '../../../types';
+import { bibliography } from '../bibliography';
+import type { RentalDepositReturnUI } from '../ui';
+
+const baseUi: RentalDepositReturnUI = {
+  depositLabel: 'Deposit paid', depositHelp: 'Use the amount actually paid as the deposit, in the same currency as every line below.',
+  deductionsTitle: 'Items kept from the deposit', deductionsHelp: 'Enter the landlord or agent own breakdown. Mark a line disputed when you want to test the amount without it.',
+  descriptionLabel: 'Description', descriptionPlaceholder: 'e.g. Final water bill', amountLabel: 'Amount', statusLabel: 'Deduction status', confirmedOption: 'Confirmed', disputedOption: 'Disputed',
+  addButton: 'Add deduction', resetButton: 'Restore example', newDeductionLabel: 'New deduction', removeButton: 'Remove this deduction', currencyLabel: 'Currency', currencyHelp: 'All figures stay in this currency. No exchange rates are used.',
+  summaryTitle: 'Confirmed vs disputed', estimatedReturnLabel: 'Estimated return', undisputedReturnLabel: 'If disputed items are removed', totalDeductionsLabel: 'Total deductions', deductionBreakdownTitle: 'The ledger behind the result', confirmedLabel: 'Confirmed items', disputedLabel: 'Disputed items',
+  returnFlowTitle: 'Deposit to return', returnFlowText: 'A clear split between what is being kept and what could come back.', depositNode: 'Deposit in', deductionNode: 'Kept for deductions', returnNode: 'Estimated back', overDeductedTitle: 'The deductions exceed the deposit', overDeductedText: 'The entered breakdown is above the deposit by',
+  scenariosTitle: 'One dispute at a time', scenariosText: 'These scenarios show the return if one disputed line is removed while all other lines stay in place.', scenarioColumn: 'Removed line', scenarioReturnColumn: 'Return if removed', scenarioIncreaseColumn: 'Increase in return', noDisputed: 'Mark a line as disputed to see a comparison scenario.',
+  emptyMessage: 'Add a deposit and use a description with a zero or positive amount for every deduction.', copyButton: 'Copy claim summary', copiedButton: 'Summary copied', privacyNote: 'Your figures stay in this browser. Nothing is sent to a server.', methodTitle: 'How this estimate works',
+  methodText: 'The tool adds every deduction, subtracts that total from the deposit and floors the estimated return at zero. A disputed scenario removes one disputed line from the total so you can compare the effect of that line.', limitationText: 'This is a calculation of your own figures, not a legal decision. Deposit rules, allowable deductions, evidence requirements and deadlines vary by jurisdiction and agreement.',
+  reportTitle: 'Rental deposit return summary', reportDeposit: 'Deposit paid', reportDeductions: 'Deductions entered', reportConfirmed: 'Confirmed deductions', reportDisputed: 'Disputed deductions', reportEstimatedReturn: 'Estimated return', reportPotentialReturn: 'Return if disputed items are removed', reportNote: 'Check the agreement, invoices, condition record and local process before making a claim.',
+};
+
+const nativeUiPatches: Record<string, Partial<RentalDepositReturnUI>> = {
+  ja: { depositHelp: '\u5b9f\u969b\u306b\u652f\u6255\u3063\u305f\u4fdd\u8a3c\u91d1\u3068\u540c\u3058\u901a\u8ca8\u3067\u5165\u529b\u3057\u307e\u3059\u3002', deductionsHelp: '\u660e\u7d30\u306e\u5404\u9805\u76ee\u3092\u5165\u529b\u3057\u3001\u78ba\u8a8d\u3057\u305f\u3044\u9805\u76ee\u3092\u4e89\u8b70\u4e2d\u306b\u3057\u307e\u3059\u3002', descriptionPlaceholder: '\u4f8b: \u6700\u7d42\u6c34\u9053\u6599\u91d1', newDeductionLabel: '\u65b0\u3057\u3044\u63a7\u9664', removeButton: '\u3053\u306e\u63a7\u9664\u3092\u524a\u9664', currencyHelp: '\u3059\u3079\u3066\u306e\u91d1\u984d\u306b\u3053\u306e\u901a\u8ca8\u3092\u4f7f\u3044\u307e\u3059\u3002\u70ba\u66ff\u30ec\u30fc\u30c8\u306f\u4f7f\u3044\u307e\u305b\u3093\u3002', deductionBreakdownTitle: '\u7d50\u679c\u306e\u660e\u7d30', confirmedLabel: '\u78ba\u5b9a\u3057\u305f\u63a7\u9664', disputedLabel: '\u4e89\u8b70\u4e2d\u306e\u63a7\u9664', returnFlowText: '\u4fdd\u6301\u3055\u308c\u308b\u91d1\u984d\u3068\u8fd4\u9084\u3055\u308c\u308b\u53ef\u80fd\u6027\u306e\u3042\u308b\u91d1\u984d\u3092\u5206\u3051\u3066\u8868\u793a\u3057\u307e\u3059\u3002', depositNode: '\u5165\u91d1\u4fdd\u8a3c\u91d1', deductionNode: '\u63a7\u9664\u3068\u3057\u3066\u4fdd\u6301', overDeductedTitle: '\u63a7\u9664\u984d\u304c\u4fdd\u8a3c\u91d1\u3092\u8d85\u3048\u3066\u3044\u307e\u3059', overDeductedText: '\u5165\u529b\u3057\u305f\u660e\u7d30\u306f\u4fdd\u8a3c\u91d1\u3092\u6b21\u306e\u91d1\u984d\u3060\u3051\u8d85\u3048\u3066\u3044\u307e\u3059:', scenariosTitle: '\u4e00\u5ea6\u306b\u4e00\u3064\u306e\u4e89\u3044\u3092\u78ba\u8a8d', scenariosText: '\u4ed6\u306e\u9805\u76ee\u3092\u6b8b\u3057\u305f\u307e\u307e\u3001\u4e89\u8b70\u4e2d\u306e\u9805\u76ee\u3092\u4e00\u3064\u9664\u3044\u305f\u5834\u5408\u306e\u8fd4\u9084\u984d\u3067\u3059\u3002', scenarioColumn: '\u9664\u5916\u3059\u308b\u9805\u76ee', scenarioReturnColumn: '\u9664\u5916\u5f8c\u306e\u8fd4\u9084', scenarioIncreaseColumn: '\u8fd4\u9084\u306e\u5897\u52a0', noDisputed: '\u6bd4\u8f03\u3059\u308b\u306b\u306f\u9805\u76ee\u3092\u4e89\u8b70\u4e2d\u306b\u3057\u3066\u304f\u3060\u3055\u3044\u3002', emptyMessage: '\u4fdd\u8a3c\u91d1\u3068\u3001\u5404\u63a7\u9664\u306e\u8aac\u660e\u304a\u3088\u30730\u4ee5\u4e0a\u306e\u91d1\u984d\u3092\u5165\u529b\u3057\u3066\u304f\u3060\u3055\u3044\u3002', privacyNote: '\u5165\u529b\u3057\u305f\u6570\u5024\u306f\u3053\u306e\u30d6\u30e9\u30a6\u30b6\u30fc\u5185\u306b\u6b8b\u308a\u307e\u3059\u3002\u30b5\u30fc\u30d0\u30fc\u306b\u306f\u9001\u4fe1\u3055\u308c\u307e\u305b\u3093\u3002', methodText: '\u3059\u3079\u3066\u306e\u63a7\u9664\u3092\u5408\u8a08\u3057\u3066\u4fdd\u8a3c\u91d1\u304b\u3089\u5dee\u3057\u5f15\u304d\u3001\u8fd4\u9084\u984d\u304c\u8ca0\u306b\u306a\u3089\u306a\u3044\u3088\u3046\u306b\u3057\u307e\u3059\u3002', limitationText: '\u3053\u308c\u306f\u5165\u529b\u3057\u305f\u6570\u5024\u306e\u8a08\u7b97\u3067\u3042\u308a\u3001\u6cd5\u7684\u5224\u65ad\u3067\u306f\u3042\u308a\u307e\u305b\u3093\u3002' },
+  ko: { depositHelp: '\uc2e4\uc81c\ub85c \ub0a9\ubd80\ud55c \ubcf4\uc99d\uae08\uc744 \ubaa8\ub4e0 \ud56d\ubaa9\uacfc \uac19\uc740 \ud1b5\ud654\ub85c \uc785\ub825\ud558\uc138\uc694.', deductionsHelp: '\uba85\uc138\uc11c\uc758 \uac01 \ud56d\ubaa9\uc744 \uc785\ub825\ud558\uace0 \ud655\uc778\ud560 \ud56d\ubaa9\uc740 \uc774\uc758 \uc81c\uae30\ub85c \ud45c\uc2dc\ud558\uc138\uc694.', descriptionPlaceholder: '\uc608: \ucd5c\uc885 \uc218\ub3c4 \uc694\uae08', newDeductionLabel: '\uc0c8 \uacf5\uc81c \ud56d\ubaa9', removeButton: '\uc774 \uacf5\uc81c \ud56d\ubaa9 \uc0ad\uc81c', currencyHelp: '\ubaa8\ub4e0 \uae08\uc561\uc740 \uc774 \ud1b5\ud654\ub85c \ud45c\uc2dc\ub429\ub2c8\ub2e4. \ud658\uc728\uc740 \uc0ac\uc6a9\ud558\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4.', deductionBreakdownTitle: '\uacb0\uacfc\uc758 \uc138\ubd80 \ub0b4\uc5ed', confirmedLabel: '\ud655\uc815\ub41c \uacf5\uc81c', disputedLabel: '\uc774\uc758 \uc81c\uae30 \uacf5\uc81c', returnFlowText: '\ubcf4\uc99d\uae08\uc5d0\uc11c \ubcf4\ub958\ub418\ub294 \uae08\uc561\uacfc \ub3cc\uc544\uc62c \uc218 \uc788\ub294 \uae08\uc561\uc744 \ub098\ub204\uc5b4 \ubcf4\uc5ec\uc90d\ub2c8\ub2e4.', depositNode: '\ub0a9\ubd80\ud55c \ubcf4\uc99d\uae08', deductionNode: '\uacf5\uc81c\ub85c \ubcf4\ub958', overDeductedTitle: '\uacf5\uc81c\uc561\uc774 \ubcf4\uc99d\uae08\uc744 \ucd08\uacfc\ud569\ub2c8\ub2e4', overDeductedText: '\uc785\ub825\ud55c \ub0b4\uc5ed\uc774 \ubcf4\uc99d\uae08\uc744 \ucd08\uacfc\ud55c \uae08\uc561:', scenariosTitle: '\ud55c \ubc88\uc5d0 \ud558\ub098\uc529 \uc774\uc758 \uc81c\uae30', scenariosText: '\ub2e4\ub978 \ud56d\ubaa9\uc740 \uadf8\ub300\ub85c \ub450\uace0 \uc774\uc758 \uc81c\uae30 \ud56d\ubaa9 \ud558\ub098\ub97c \ube80 \ubc18\ud658\uc561\uc744 \ubcf4\uc5ec\uc90d\ub2c8\ub2e4.', scenarioColumn: '\uc81c\uc678\ud55c \ud56d\ubaa9', scenarioReturnColumn: '\uc81c\uc678 \ud6c4 \ubc18\ud658\uc561', scenarioIncreaseColumn: '\ubc18\ud658\uc561 \uc99d\uac00', noDisputed: '\ube44\uad50\ud558\ub824\uba74 \ud56d\ubaa9\uc744 \uc774\uc758 \uc81c\uae30\ub85c \ud45c\uc2dc\ud558\uc138\uc694.', emptyMessage: '\ubcf4\uc99d\uae08\uacfc \uac01 \uacf5\uc81c\uc758 \uc124\uba85 \ubc0f 0 \uc774\uc0c1\uc758 \uae08\uc561\uc744 \uc785\ub825\ud558\uc138\uc694.', privacyNote: '\uc785\ub825\ud55c \uc218\uce58\ub294 \uc774 \ube0c\ub77c\uc6b0\uc800\uc5d0\ub9cc \ub0a8\uc2b5\ub2c8\ub2e4. \uc11c\ubc84\ub85c \uc804\uc1a1\ub418\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4.', methodText: '\ubaa8\ub4e0 \uacf5\uc81c\uc561\uc744 \ub354\ud574 \ubcf4\uc99d\uae08\uc5d0\uc11c \ube7c\uace0 \ubc18\ud658\uc561\uc774 \uc74c\uc218\uac00 \ub418\uc9c0 \uc54a\uac8c \ud569\ub2c8\ub2e4.', limitationText: '\uc785\ub825\ud55c \uae08\uc561\uc5d0 \ub300\ud55c \uacc4\uc0b0\uc77c \ubfd0 \ubc95\uc801 \ud310\ub2e8\uc774 \uc544\ub2d9\ub2c8\ub2e4.' },
+  ru: { depositHelp: '\u0423\u043a\u0430\u0436\u0438\u0442\u0435 \u0444\u0430\u043a\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u0432\u043d\u0435\u0441\u0451\u043d\u043d\u044b\u0439 \u0437\u0430\u043b\u043e\u0433 \u0432 \u0442\u043e\u0439 \u0436\u0435 \u0432\u0430\u043b\u044e\u0442\u0435, \u0447\u0442\u043e \u0438 \u0432\u0441\u0435 \u0441\u0442\u0440\u043e\u043a\u0438 \u043d\u0438\u0436\u0435.', deductionsHelp: '\u0412\u0432\u0435\u0434\u0438\u0442\u0435 \u0432\u0441\u0435 \u0441\u0442\u0440\u043e\u043a\u0438 \u0438\u0437 \u0440\u0430\u0441\u0447\u0451\u0442\u0430 \u0438 \u043e\u0442\u043c\u0435\u0442\u044c\u0442\u0435 \u0441\u043f\u043e\u0440\u043d\u044b\u0435 \u043f\u043e\u0437\u0438\u0446\u0438\u0438.', descriptionPlaceholder: '\u043d\u0430\u043f\u0440\u0438\u043c\u0435\u0440, \u0438\u0442\u043e\u0433\u043e\u0432\u044b\u0439 \u0441\u0447\u0451\u0442 \u0437\u0430 \u0432\u043e\u0434\u0443', newDeductionLabel: '\u041d\u043e\u0432\u043e\u0435 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u0435', removeButton: '\u0423\u0434\u0430\u043b\u0438\u0442\u044c \u044d\u0442\u043e \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u0435', currencyHelp: '\u0412\u0441\u0435 \u0441\u0443\u043c\u043c\u044b \u0443\u043a\u0430\u0437\u0430\u043d\u044b \u0432 \u044d\u0442\u043e\u0439 \u0432\u0430\u043b\u044e\u0442\u0435. \u041a\u0443\u0440\u0441\u044b \u043e\u0431\u043c\u0435\u043d\u0430 \u043d\u0435 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044e\u0442\u0441\u044f.', deductionBreakdownTitle: '\u0420\u0430\u0437\u0431\u043e\u0440 \u0440\u0435\u0437\u0443\u043b\u044c\u0442\u0430', confirmedLabel: '\u041f\u043e\u0434\u0442\u0432\u0435\u0440\u0436\u0434\u0451\u043d\u043d\u044b\u0435 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f', disputedLabel: '\u041e\u0441\u043f\u0430\u0440\u0438\u0432\u0430\u0435\u043c\u044b\u0435 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f', returnFlowText: '\u041f\u043e\u043a\u0430\u0437\u044b\u0432\u0430\u0435\u0442 \u0440\u0430\u0437\u043d\u0438\u0446\u0443 \u043c\u0435\u0436\u0434\u0443 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u043d\u043e\u0439 \u0441\u0443\u043c\u043c\u043e\u0439 \u0438 \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u044b\u043c \u0432\u043e\u0437\u0432\u0440\u0430\u0442\u043e\u043c.', depositNode: '\u0412\u043d\u0435\u0441\u0451\u043d\u043d\u044b\u0439 \u0437\u0430\u043b\u043e\u0433', deductionNode: '\u0423\u0434\u0435\u0440\u0436\u0430\u043d\u043e', overDeductedTitle: '\u0423\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f \u043f\u0440\u0435\u0432\u044b\u0448\u0430\u044e\u0442 \u0437\u0430\u043b\u043e\u0433', overDeductedText: '\u0423\u043a\u0430\u0437\u0430\u043d\u043d\u044b\u0435 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f \u043f\u0440\u0435\u0432\u044b\u0448\u0430\u044e\u0442 \u0437\u0430\u043b\u043e\u0433 \u043d\u0430', scenariosTitle: '\u041f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043e\u0434\u043d\u043e\u0433\u043e \u0441\u043f\u043e\u0440\u0430', scenariosText: '\u0412\u043e\u0437\u0432\u0440\u0430\u0442, \u0435\u0441\u043b\u0438 \u0443\u0431\u0440\u0430\u0442\u044c \u043e\u0434\u043d\u0443 \u043e\u0441\u043f\u0430\u0440\u0438\u0432\u0430\u0435\u043c\u0443\u044e \u0441\u0442\u0440\u043e\u043a\u0443 \u0438 \u043e\u0441\u0442\u0430\u0432\u0438\u0442\u044c \u043e\u0441\u0442\u0430\u043b\u044c\u043d\u044b\u0435.', scenarioColumn: '\u0423\u0431\u0440\u0430\u043d\u043d\u0430\u044f \u0441\u0442\u0440\u043e\u043a\u0430', scenarioReturnColumn: '\u0412\u043e\u0437\u0432\u0440\u0430\u0442 \u043f\u043e\u0441\u043b\u0435 \u0443\u0434\u0430\u043b\u0435\u043d\u0438\u044f', scenarioIncreaseColumn: '\u0423\u0432\u0435\u043b\u0438\u0447\u0435\u043d\u0438\u0435 \u0432\u043e\u0437\u0432\u0440\u0430\u0442\u0430', noDisputed: '\u041e\u0442\u043c\u0435\u0442\u044c\u0442\u0435 \u0441\u0442\u0440\u043e\u043a\u0443 \u043a\u0430\u043a \u043e\u0441\u043f\u0430\u0440\u0438\u0432\u0430\u0435\u043c\u0443\u044e, \u0447\u0442\u043e\u0431\u044b \u0443\u0432\u0438\u0434\u0435\u0442\u044c \u0441\u0440\u0430\u0432\u043d\u0435\u043d\u0438\u0435.', emptyMessage: '\u0412\u0432\u0435\u0434\u0438\u0442\u0435 \u0437\u0430\u043b\u043e\u0433, \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u043a\u0430\u0436\u0434\u043e\u0433\u043e \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f \u0438 \u0441\u0443\u043c\u043c\u0443 \u043d\u0435 \u043c\u0435\u043d\u044c\u0448\u0435 \u043d\u0443\u043b\u044f.', privacyNote: '\u0412\u0430\u0448\u0438 \u0446\u0438\u0444\u0440\u044b \u043e\u0441\u0442\u0430\u044e\u0442\u0441\u044f \u0432 \u044d\u0442\u043e\u043c \u0431\u0440\u0430\u0443\u0437\u0435\u0440\u0435 \u0438 \u043d\u0435 \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u044e\u0442\u0441\u044f \u043d\u0430 \u0441\u0435\u0440\u0432\u0435\u0440.', methodText: '\u0418\u043d\u0441\u0442\u0440\u0443\u043c\u0435\u043d\u0442 \u0441\u043a\u043b\u0430\u0434\u044b\u0432\u0430\u0435\u0442 \u0443\u0434\u0435\u0440\u0436\u0430\u043d\u0438\u044f, \u0432\u044b\u0447\u0438\u0442\u0430\u0435\u0442 \u0438\u0445 \u0438\u0437 \u0437\u0430\u043b\u043e\u0433\u0430 \u0438 \u043d\u0435 \u0434\u043e\u043f\u0443\u0441\u043a\u0430\u0435\u0442 \u043e\u0442\u0440\u0438\u0446\u0430\u0442\u0435\u043b\u044c\u043d\u044b\u0439 \u0432\u043e\u0437\u0432\u0440\u0430\u0442.', limitationText: '\u042d\u0442\u043e \u0440\u0430\u0441\u0447\u0451\u0442 \u0432\u0430\u0448\u0438\u0445 \u0441\u0443\u043c\u043c, \u0430 \u043d\u0435 \u044e\u0440\u0438\u0434\u0438\u0447\u0435\u0441\u043a\u043e\u0435 \u0440\u0435\u0448\u0435\u043d\u0438\u0435.' },
+  zh: { depositHelp: '\u8bf7\u8f93\u5165\u5b9e\u9645\u652f\u4ed8\u7684\u62bc\u91d1\uff0c\u6240\u6709\u9879\u76ee\u4f7f\u7528\u540c\u4e00\u8d27\u5e01\u3002', deductionsHelp: '\u8f93\u5165\u7ed3\u7b97\u5355\u4e2d\u7684\u6bcf\u4e2a\u6263\u6b3e\u9879\u76ee\uff0c\u5e76\u6807\u8bb0\u60f3\u8981\u6838\u67e5\u7684\u4e89\u8bae\u9879\u76ee\u3002', descriptionPlaceholder: '\u4f8b\u5982\uff1a\u6700\u7ec8\u6c34\u8d39', newDeductionLabel: '\u65b0\u6263\u6b3e', removeButton: '\u5220\u9664\u6b64\u6263\u6b3e', currencyHelp: '\u6240\u6709\u91d1\u989d\u90fd\u4f7f\u7528\u6b64\u8d27\u5e01\uff0c\u4e0d\u4f7f\u7528\u6c47\u7387\u6362\u7b97\u3002', deductionBreakdownTitle: '\u7ed3\u679c\u660e\u7ec6', confirmedLabel: '\u5df2\u786e\u8ba4\u6263\u6b3e', disputedLabel: '\u6709\u4e89\u8bae\u6263\u6b3e', returnFlowText: '\u6e05\u695a\u533a\u5206\u4fdd\u7559\u91d1\u989d\u548c\u53ef\u80fd\u9000\u8fd8\u7684\u91d1\u989d\u3002', depositNode: '\u62bc\u91d1\u91d1\u989d', deductionNode: '\u6263\u9664\u5e76\u4fdd\u7559', overDeductedTitle: '\u6263\u6b3e\u8d85\u8fc7\u62bc\u91d1', overDeductedText: '\u8f93\u5165\u7684\u6263\u6b3e\u8d85\u8fc7\u62bc\u91d1', scenariosTitle: '\u9010\u9879\u67e5\u770b\u4e89\u8bae', scenariosText: '\u4fdd\u7559\u5176\u4ed6\u9879\u76ee\u4e0d\u53d8\uff0c\u79fb\u9664\u4e00\u4e2a\u6709\u4e89\u8bae\u9879\u76ee\u540e\u53ef\u9000\u8fd8\u7684\u91d1\u989d\u3002', scenarioColumn: '\u79fb\u9664\u9879\u76ee', scenarioReturnColumn: '\u79fb\u9664\u540e\u7684\u9000\u8fd8', scenarioIncreaseColumn: '\u9000\u8fd8\u589e\u52a0', noDisputed: '\u5c06\u9879\u76ee\u6807\u8bb0\u4e3a\u6709\u4e89\u8bae\u5373\u53ef\u67e5\u770b\u6bd4\u8f83\u3002', emptyMessage: '\u8bf7\u8f93\u5165\u62bc\u91d1\u3001\u6bcf\u9879\u6263\u6b3e\u7684\u8bf4\u660e\u4ee5\u53ca\u4e0d\u5c0f\u4e8e\u96f6\u7684\u91d1\u989d\u3002', privacyNote: '\u4f60\u7684\u6570\u5b57\u53ea\u4fdd\u7559\u5728\u6b64\u6d4f\u89c8\u5668\u4e2d\uff0c\u4e0d\u4f1a\u53d1\u9001\u5230\u670d\u52a1\u5668\u3002', methodText: '\u8ba1\u7b97\u5668\u6c47\u603b\u6240\u6709\u6263\u6b3e\u5e76\u4ece\u62bc\u91d1\u4e2d\u51cf\u53bb\uff0c\u9000\u8fd8\u91d1\u989d\u4e0d\u4f1a\u4f4e\u4e8e\u96f6\u3002', limitationText: '\u8fd9\u662f\u5bf9\u4f60\u8f93\u5165\u91d1\u989d\u7684\u8ba1\u7b97\uff0c\u4e0d\u662f\u6cd5\u5f8b\u5224\u65ad\u3002' },
+};
+
+export interface RentalDepositLocaleCopy { title: string; description: string; ui: Partial<RentalDepositReturnUI>; faq: Array<{ question: string; answer: string }>; howTo: Array<{ name: string; text: string }>; seo: SEOSection[]; }
+
+export function createRentalDepositContent(locale: string, copy: RentalDepositLocaleCopy): ToolLocaleContent<RentalDepositReturnUI> {
+  const ui: RentalDepositReturnUI = { ...baseUi, ...(nativeUiPatches[locale] ?? {}), ...copy.ui };
+  const localizedSlugs: Record<string, string> = { de: 'mietkaution-rueckzahlung-rechner', es: 'calculadora-devolucion-fianza-alquiler', fr: 'calculateur-restitution-depot-garantie', id: 'kalkulator-pengembalian-deposit-sewa', it: 'calcolatore-restituzione-deposito-cauzionale', nl: 'rekenhulp-terugbetaling-huurwaarborg', pl: 'kalkulator-zwrotu-kaucji-wynajem', pt: 'calculadora-devolucao-deposito-arrendamento', ru: 'kalkulyator-vozvrata-arendnogo-zaloga', sv: 'kalkylator-aterbetalning-hyresdeposition', tr: 'kira-depozitosu-iade-hesaplayici' };
+  const faqSchema: WithContext<FAQPage> = { '@context': 'https://schema.org', '@type': 'FAQPage', mainEntity: copy.faq.map((item) => ({ '@type': 'Question', name: item.question, acceptedAnswer: { '@type': 'Answer', text: item.answer } })) };
+  const howToSchema: WithContext<HowTo> = { '@context': 'https://schema.org', '@type': 'HowTo', name: copy.howTo[0]?.name ?? copy.title, description: copy.description, step: copy.howTo.map((step, index) => ({ '@type': 'HowToStep', position: index + 1, name: step.name, text: step.text })) };
+  const appSchema: WithContext<SoftwareApplication> = { '@context': 'https://schema.org', '@type': 'SoftwareApplication', name: copy.title, description: copy.description, applicationCategory: 'FinanceApplication', operatingSystem: 'All', offers: { '@type': 'Offer', price: '0', priceCurrency: 'EUR' }, inLanguage: locale };
+  const seo: SEOSection[] = [...copy.seo, { type: 'title', text: ui.scenariosTitle, level: 3 }, { type: 'paragraph', html: `<p>${copy.description} ${ui.methodText} ${ui.limitationText}</p>` }, { type: 'list', items: [ui.depositLabel, ui.deductionsTitle, ui.estimatedReturnLabel, ui.copyButton] }];
+  return { slug: localizedSlugs[locale] ?? 'rental-deposit-return-calculator', title: copy.title, description: copy.description, ui, faq: copy.faq, bibliography, howTo: copy.howTo, schemas: [faqSchema, howToSchema, appSchema], seo };
+}

package/src/tool/rentalDepositReturn/i18n/de.ts

@@ -0,0 +1,3 @@
+import { createRentalDepositContent } from './content-factory';
+import { localizedCopies } from './translations';
+export const content = createRentalDepositContent('de', localizedCopies.de!);

package/src/tool/rentalDepositReturn/i18n/en.ts

@@ -0,0 +1,116 @@
+import type { FAQPage, HowTo, SoftwareApplication, WithContext } from 'schema-dts';
+import type { ToolLocaleContent } from '../../../types';
+import { bibliography } from '../bibliography';
+import type { RentalDepositReturnUI } from '../ui';
+
+const ui: RentalDepositReturnUI = {
+  depositLabel: 'Deposit paid',
+  depositHelp: 'Use the amount actually paid as the deposit, in the same currency as every line below.',
+  deductionsTitle: 'Items kept from the deposit',
+  deductionsHelp: 'Enter the landlord or agent\'s own breakdown. Mark a line disputed when you want to test the amount without it.',
+  descriptionLabel: 'Description',
+  descriptionPlaceholder: 'e.g. Final water bill',
+  amountLabel: 'Amount',
+  statusLabel: 'Deduction status',
+  confirmedOption: 'Confirmed',
+  disputedOption: 'Disputed',
+  addButton: 'Add deduction',
+  resetButton: 'Restore example',
+  newDeductionLabel: 'New deduction',
+  removeButton: 'Remove this deduction',
+  currencyLabel: 'Currency',
+  currencyHelp: 'All figures stay in this currency. No exchange rates are used.',
+  summaryTitle: 'Confirmed vs disputed',
+  estimatedReturnLabel: 'Estimated return',
+  undisputedReturnLabel: 'If disputed items are removed',
+  totalDeductionsLabel: 'Total deductions',
+  deductionBreakdownTitle: 'The ledger behind the result',
+  confirmedLabel: 'Confirmed items',
+  disputedLabel: 'Disputed items',
+  returnFlowTitle: 'Deposit to return',
+  returnFlowText: 'A clear split between what is being kept and what could come back.',
+  depositNode: 'Deposit in',
+  deductionNode: 'Kept for deductions',
+  returnNode: 'Estimated back',
+  overDeductedTitle: 'The deductions exceed the deposit',
+  overDeductedText: 'The entered breakdown is above the deposit by',
+  scenariosTitle: 'One dispute at a time',
+  scenariosText: 'These scenarios show the return if one disputed line is removed while all other lines stay in place.',
+  scenarioColumn: 'Removed line',
+  scenarioReturnColumn: 'Return if removed',
+  scenarioIncreaseColumn: 'Increase in return',
+  noDisputed: 'Mark a line as disputed to see a comparison scenario.',
+  emptyMessage: 'Add a deposit and use a description with a zero or positive amount for every deduction.',
+  copyButton: 'Copy claim summary',
+  copiedButton: 'Summary copied',
+  privacyNote: 'Your figures stay in this browser. Nothing is sent to a server.',
+  methodTitle: 'How this estimate works',
+  methodText: 'The tool adds every deduction, subtracts that total from the deposit and floors the estimated return at zero. A disputed scenario removes one disputed line from the total so you can compare the effect of that line.',
+  limitationText: 'This is a calculation of your own figures, not a legal decision. Deposit rules, allowable deductions, evidence requirements and deadlines vary by jurisdiction and agreement.',
+  reportTitle: 'Rental deposit return summary',
+  reportDeposit: 'Deposit paid',
+  reportDeductions: 'Deductions entered',
+  reportConfirmed: 'Confirmed deductions',
+  reportDisputed: 'Disputed deductions',
+  reportEstimatedReturn: 'Estimated return',
+  reportPotentialReturn: 'Return if disputed items are removed',
+  reportNote: 'Check the agreement, invoices, condition record and local process before making a claim.',
+};
+
+const faq = [
+  { question: 'What does the rental deposit return calculator estimate?', answer: 'It totals the deduction amounts you enter and subtracts them from the deposit. It also shows the amount that would remain if disputed lines were removed one at a time.' },
+  { question: 'Does the calculator decide whether a deduction is legal?', answer: 'No. It only transforms your own figures. The rules, evidence and deadlines for a deposit depend on the tenancy agreement and the jurisdiction.' },
+  { question: 'What should I enter as a disputed item?', answer: 'Use a line for a charge you want to question, such as a repair, cleaning fee, unpaid bill or rent balance. The scenario shows how much the return changes if that line is left out.' },
+];
+
+const howTo = [
+  { name: 'Enter the deposit', text: 'Type the deposit amount that was actually paid and choose its currency.' },
+  { name: 'Add the breakdown', text: 'Enter each deduction from the statement or settlement, with its amount and a confirmed or disputed status.' },
+  { name: 'Compare the returns', text: 'Read the estimated return, the return without disputed items and the one-line dispute scenarios.' },
+  { name: 'Copy the summary', text: 'Copy the figures into your own message or notes, then check the agreement and supporting documents before claiming.' },
+];
+
+const faqSchema: WithContext<FAQPage> = {
+  '@context': 'https://schema.org',
+  '@type': 'FAQPage',
+  mainEntity: faq.map((item) => ({ '@type': 'Question', name: item.question, acceptedAnswer: { '@type': 'Answer', text: item.answer } })),
+};
+
+const howToSchema: WithContext<HowTo> = {
+  '@context': 'https://schema.org',
+  '@type': 'HowTo',
+  name: 'Estimate a rental deposit return',
+  description: 'Compare a rental deposit with the deductions in your own settlement.',
+  step: howTo.map((step, index) => ({ '@type': 'HowToStep', position: index + 1, name: step.name, text: step.text })),
+};
+
+const appSchema: WithContext<SoftwareApplication> = {
+  '@context': 'https://schema.org',
+  '@type': 'SoftwareApplication',
+  name: 'Rental Deposit Return Calculator',
+  description: 'Estimate a rental deposit return from your own deductions and compare disputed items.',
+  applicationCategory: 'FinanceApplication',
+  operatingSystem: 'All',
+  offers: { '@type': 'Offer', price: '0', priceCurrency: 'USD' },
+  inLanguage: 'en',
+};
+
+export const content: ToolLocaleContent<RentalDepositReturnUI> = {
+  slug: 'rental-deposit-return-calculator',
+  title: 'Rental Deposit Return Calculator',
+  description: 'Estimate how much of your rental deposit could come back after itemising confirmed and disputed deductions.',
+  ui,
+  faq,
+  bibliography,
+  howTo,
+  schemas: [faqSchema, howToSchema, appSchema],
+  seo: [
+    { type: 'title', text: 'Turn a deposit statement into a return estimate', level: 2 },
+    { type: 'paragraph', html: '<p>When a tenancy ends, a settlement can mix the deposit, unpaid bills, cleaning, repairs and other charges in one opaque figure. This browser-only calculator lets you enter that statement and see the arithmetic behind the estimated return.</p>' },
+    { type: 'title', text: 'Separate confirmed and disputed deductions', level: 3 },
+    { type: 'paragraph', html: '<p>Mark each line as confirmed or disputed. The main estimate includes every line, while the comparison shows what would come back if a disputed line were removed. That turns a vague disagreement into a specific amount to check against invoices, the condition record and the tenancy agreement.</p>' },
+    { type: 'list', items: ['Deposit paid and total deductions', 'Return estimate with the full breakdown', 'Return if disputed items are removed', 'A copyable summary for your own claim notes'] },
+    { type: 'title', text: 'A calculation, not a legal ruling', level: 3 },
+    { type: 'paragraph', html: '<p>Deposit protection and deduction rules differ across countries, regions and agreements. The tool does not decide whether a charge is lawful, reasonable or evidenced, and it does not apply a universal deadline or percentage.</p>' },
+  ],
+};

package/src/tool/rentalDepositReturn/i18n/es.ts

@@ -0,0 +1,3 @@
+import { createRentalDepositContent } from './content-factory';
+import { localizedCopies } from './translations';
+export const content = createRentalDepositContent('es', localizedCopies.es!);