@jjlmoya/utils-finance 1.4.0 → 1.7.0

package/src/category/index.ts

@@ -16,9 +16,21 @@ export const financeCategory: FinanceCategoryEntry = {
   icon: 'mdi:finance',
   tools: [compoundInterest, mortgage, inflation, percentageCalculator, lateInterest, ibanBicSwift, rentIncrease, lotteryOptimizer, courtFeeCalculator, legalInterestRate, fireCalculator, debtSnowball],
   i18n: {
-    es: () => import('./i18n/es').then((m) => m.content),
     en: () => import('./i18n/en').then((m) => m.content),
+    es: () => import('./i18n/es').then((m) => m.content),
     fr: () => import('./i18n/fr').then((m) => m.content),
+    de: () => import('./i18n/de').then((m) => m.content),
+    id: () => import('./i18n/id').then((m) => m.content),
+    it: () => import('./i18n/it').then((m) => m.content),
+    ja: () => import('./i18n/ja').then((m) => m.content),
+    ko: () => import('./i18n/ko').then((m) => m.content),
+    nl: () => import('./i18n/nl').then((m) => m.content),
+    pl: () => import('./i18n/pl').then((m) => m.content),
+    pt: () => import('./i18n/pt').then((m) => m.content),
+    ru: () => import('./i18n/ru').then((m) => m.content),
+    sv: () => import('./i18n/sv').then((m) => m.content),
+    tr: () => import('./i18n/tr').then((m) => m.content),
+    zh: () => import('./i18n/zh').then((m) => m.content),
   },
 };
 

package/src/tests/category_validation.test.ts

@@ -0,0 +1,73 @@
+import { describe, it, expect } from 'vitest';
+import { financeCategory as toolsCategory } from '../category/index';
+import type { CategoryLocaleContent } from '../types';
+
+const EXPECTED_LOCALES = [
+  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh'
+];
+
+const sharingLocales = ['ja', 'ko', 'zh'];
+
+describe('Category Validation', () => {
+  it('should have all 15 required locales', () => {
+    const registeredLocales = Object.keys(toolsCategory.i18n);
+    EXPECTED_LOCALES.forEach((locale) => {
+      expect(
+        registeredLocales,
+        `Category is missing locale "${locale}"`,
+      ).toContain(locale);
+    });
+  });
+
+  describe('Category Slug Validation', () => {
+    it('every locale should have a unique, translated slug and follow format rules', async () => {
+      const slugs = new Map<string, string>();
+      const locales = Object.keys(toolsCategory.i18n);
+
+      let enSlug = '';
+      if (locales.includes('en')) {
+        const enLoader = toolsCategory.i18n['en' as keyof typeof toolsCategory.i18n];
+        const enContent = (await enLoader?.()) as CategoryLocaleContent;
+        enSlug = enContent.slug;
+      }
+
+      for (const locale of locales) {
+        const loader = toolsCategory.i18n[locale as keyof typeof toolsCategory.i18n];
+        const content = (await loader?.()) as CategoryLocaleContent;
+
+        expect(
+          content.slug,
+          `Category locale "${locale}" has an invalid slug ("${content.slug}"). Slugs must be transliterated (only a-z, 0-9, and -).`,
+        ).toMatch(/^[a-z0-9-]+$/);
+
+        expect(
+          content.slug,
+          `Category locale "${locale}" slug ("${content.slug}") cannot end with a 2-letter language code (e.g., -ja, -ru, -ko).`,
+        ).not.toMatch(/-[a-z]{2}$/);
+
+        if (locale !== 'en') {
+          if (sharingLocales.includes(locale)) {
+            expect(
+              content.slug,
+              `Category locale "${locale}" must use the same slug as "en" ("${enSlug}").`,
+            ).toBe(enSlug);
+          } else {
+            expect(
+              content.slug,
+              `Category locale "${locale}" has the same slug as "en" ("${enSlug}"). Cada slug tiene que estar en su propio idioma`,
+            ).not.toBe(enSlug);
+
+            if (slugs.has(content.slug)) {
+              const previousLocale = slugs.get(content.slug);
+              expect(
+                false,
+                `Category locales "${locale}" and "${previousLocale}" share the same slug ("${content.slug}"). Cada slug tiene que estar en su propia idioma`,
+              ).toBe(true);
+            }
+            slugs.set(content.slug, locale);
+          }
+        }
+      }
+    });
+  });
+});

package/src/tests/faq_count.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect } from 'vitest';
 import type * as DATA from '../data';
 
-const TOOLS: typeof DATA.financeCategory[] = [];
+const TOOLS: typeof DATA.audiovisualCategory[] = [];
 
 describe('FAQ Content Validation', () => {
   TOOLS.forEach((entry) => {

package/src/tests/i18n_coverage.test.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+
+const EXPECTED_LOCALES = [
+  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh'
+];
+
+describe('I18n Coverage Validation', () => {
+  it('all tools should be registered', () => {
+    expect(ALL_TOOLS.length).toBeGreaterThan(0);
+  });
+
+  ALL_TOOLS.forEach(({ entry }: { entry: any }) => {
+    describe(`Tool: ${entry.id}`, () => {
+      it('should have all 15 required locales', () => {
+        const registeredLocales = Object.keys(entry.i18n);
+        EXPECTED_LOCALES.forEach((locale) => {
+          expect(
+            registeredLocales,
+            `Tool "${entry.id}" is missing locale "${locale}"`,
+          ).toContain(locale);
+        });
+      });
+
+      it('all locale loaders should be functions', () => {
+        EXPECTED_LOCALES.forEach((locale) => {
+          const loader = entry.i18n[locale as keyof typeof entry.i18n];
+          expect(
+            typeof loader,
+            `Tool "${entry.id}" locale "${locale}" loader is not a function`,
+          ).toBe('function');
+        });
+      });
+    });
+  });
+});

package/src/tests/locale_completeness.test.ts

@@ -35,5 +35,8 @@ describe('Locale Completeness Validation', () => {
     });
   });
 
+  it('all 12 tools registered', () => {
+    expect(ALL_TOOLS.length).toBe(12);
+  });
 });
 

package/src/tests/slug_language_code_format.test.ts

@@ -0,0 +1,23 @@
+import { describe, it, expect } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+import type { ToolLocaleContent } from '../types';
+
+describe('Slug Language Code Format Validation', () => {
+  ALL_TOOLS.forEach((tool) => {
+    describe(`Tool: ${tool.entry.id}`, () => {
+      it('slug should not end with 2-letter language codes like -ja, -ru, -ko', async () => {
+        const locales = Object.keys(tool.entry.i18n);
+
+        for (const locale of locales) {
+          const loader = tool.entry.i18n[locale as keyof typeof tool.entry.i18n];
+          const content = (await loader?.()) as ToolLocaleContent;
+
+          expect(
+            content.slug,
+            `Tool "${tool.entry.id}" locale "${locale}" slug ("${content.slug}") cannot end with a 2-letter language code (e.g., -ja, -ru, -ko).`,
+          ).not.toMatch(/-[a-z]{2}$/);
+        }
+      });
+    });
+  });
+});

package/src/tests/slug_uniqueness.test.ts

@@ -0,0 +1,81 @@
+import { describe, it, expect } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+import type { ToolLocaleContent } from '../types';
+
+const sharingLocales = ['ja', 'ko', 'zh'];
+
+interface ValidateParams {
+  toolId: string;
+  locale: string;
+  content: ToolLocaleContent;
+  enSlug: string;
+  slugs: Map<string, string>;
+}
+
+const validateLocaleSlug = ({
+  toolId,
+  locale,
+  content,
+  enSlug,
+  slugs,
+}: ValidateParams) => {
+  expect(
+    content.slug,
+    `Tool "${toolId}" locale "${locale}" has an invalid slug ("${content.slug}"). Slugs must be transliterated (only a-z, 0-9, and -).`,
+  ).toMatch(/^[a-z0-9-]+$/);
+
+  if (locale === 'en') {
+    return;
+  }
+
+  if (sharingLocales.includes(locale)) {
+    expect(
+      content.slug,
+      `Tool "${toolId}" locale "${locale}" must use the same slug as "en" ("${enSlug}").`,
+    ).toBe(enSlug);
+  } else {
+    expect(
+      content.slug,
+      `Tool "${toolId}" locale "${locale}" has the same slug as "en" ("${enSlug}"). Cada slug tiene que estar en su propia idioma`,
+    ).not.toBe(enSlug);
+
+    if (slugs.has(content.slug)) {
+      const previousLocale = slugs.get(content.slug);
+      expect(
+        false,
+        `Tool "${toolId}" locales "${locale}" and "${previousLocale}" share the same slug ("${content.slug}"). Cada slug tiene que estar en su propia idioma`,
+      ).toBe(true);
+    }
+    slugs.set(content.slug, locale);
+  }
+};
+
+describe('Slug Localization and Uniqueness Validation', () => {
+  ALL_TOOLS.forEach((tool) => {
+    describe(`Tool: ${tool.entry.id}`, () => {
+      it('every locale should have a unique, translated slug', async () => {
+        const slugs = new Map<string, string>();
+        const locales = Object.keys(tool.entry.i18n);
+
+        let enSlug = '';
+        if (locales.includes('en')) {
+          const enLoader = tool.entry.i18n['en' as keyof typeof tool.entry.i18n];
+          const enContent = (await enLoader?.()) as ToolLocaleContent;
+          enSlug = enContent.slug;
+        }
+
+        for (const locale of locales) {
+          const loader = tool.entry.i18n[locale as keyof typeof tool.entry.i18n];
+          const content = (await loader?.()) as ToolLocaleContent;
+          validateLocaleSlug({
+            toolId: tool.entry.id,
+            locale,
+            content,
+            enSlug,
+            slugs,
+          });
+        }
+      });
+    });
+  });
+});

package/src/tests/title_quality.test.ts

@@ -41,7 +41,7 @@ describe('Project Titles - Separator Validation', () => {
       let match;
       while ((match = pattern.exec(content)) !== null) {
         const title = match[1];
-        if (title && (title.includes('|') || title.includes('-'))) {
+        if (title.includes('|') || title.includes('-')) {
           findings.push(title);
         }
       }

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

@@ -0,0 +1,208 @@
+import type { WithContext, FAQPage, HowTo, SoftwareApplication } from 'schema-dts';
+import type { ToolLocaleContent } from '../../../types';
+import type { CompoundInterestUI } from '../ui';
+
+const slug = 'zinseszins-rechner';
+const title = 'Zinseszinsrechner: Visualisieren Sie Ihren zukünftigen Reichtum';
+const description =
+  'Entdecken Sie, wie aus kleinen Investitionen große Vermögen werden. Das ultimative Werkzeug zur Planung Ihrer finanziellen Freiheit und Altersvorsorge.';
+
+const faqData = [
+  {
+    question: 'Was ist Zinseszins?',
+    answer:
+      'Es sind Zinsen, die auf das ursprüngliche Kapital und auch auf die aufgelaufenen Zinsen früherer Perioden berechnet werden. Dies führt im Laufe der Zeit zu einem exponentiellen Wachstum der Investition.',
+  },
+  {
+    question: 'Was ist der Unterschied zum einfachen Zins?',
+    answer:
+      'Beim einfachen Zins werden die Zinsen nur auf das ursprüngliche Kapital berechnet. Beim Zinseszins werden die Zinsen reinvestiert, was bedeutet, dass „Ihre Zinsen weitere Zinsen generieren“.',
+  },
+  {
+    question: 'Was ist die „72er-Regel“?',
+    answer:
+      'Es ist eine Faustformel zur Schätzung, wie lange es dauert, bis sich eine Investition verdoppelt: Teilen Sie 72 durch die jährliche Rendite. Beispiel: Bei 8 % pro Jahr verdoppeln Sie Ihr Geld in 9 Jahren.',
+  },
+  {
+    question: 'Warum ist es wichtig, jung mit dem Investieren zu beginnen?',
+    answer:
+      'Aufgrund des exponentiellen Effekts ist der entscheidendste Faktor nicht die Menge des gesparten Geldes, sondern die Zeit. Ein paar Jahre früher anzufangen, kann aufgrund der Kapitalisierung zu einem viel größeren Endvermögen führen.',
+  },
+];
+
+const howToData = [
+  {
+    name: 'Startkapital eingeben',
+    text: 'Geben Sie den Geldbetrag ein, mit dem Sie Ihren Investitionsplan beginnen möchten.',
+  },
+  {
+    name: 'Regelmäßige Beiträge festlegen',
+    text: 'Geben Sie an, wie viel Geld Sie zusätzlich jeden Monat oder jedes Jahr sparen und investieren werden.',
+  },
+  {
+    name: 'Jährliche Rendite schätzen',
+    text: 'Geben Sie den Prozentsatz an jährlichem Gewinn ein, den Sie erwarten (z. B. 7 % für den historischen S&P 500).',
+  },
+  {
+    name: 'Zeithorizont anpassen',
+    text: 'Wählen Sie aus, wie viele Jahre Sie die Investition halten möchten, um das exponentielle Wachstum Ihres Kapitals zu visualisieren.',
+  },
+];
+
+const faqSchema: WithContext<FAQPage> = {
+  '@context': 'https://schema.org',
+  '@type': 'FAQPage',
+  mainEntity: faqData.map((item) => ({
+    '@type': 'Question',
+    name: item.question,
+    acceptedAnswer: { '@type': 'Answer', text: item.answer },
+  })),
+};
+
+const howToSchema: WithContext<HowTo> = {
+  '@context': 'https://schema.org',
+  '@type': 'HowTo',
+  name: title,
+  description,
+  step: howToData.map((step, i) => ({
+    '@type': 'HowToStep',
+    position: i + 1,
+    name: step.name,
+    text: step.text,
+  })),
+};
+
+const appSchema: WithContext<SoftwareApplication> = {
+  '@context': 'https://schema.org',
+  '@type': 'SoftwareApplication',
+  name: title,
+  description,
+  applicationCategory: 'FinanceApplication',
+  operatingSystem: 'All',
+  offers: { '@type': 'Offer', price: '0', priceCurrency: 'EUR' },
+  inLanguage: 'de',
+};
+
+export const content: ToolLocaleContent<CompoundInterestUI> = {
+  slug,
+  title,
+  description,
+  faqTitle: 'Häufig gestellte Fragen',
+  faq: faqData,
+  bibliographyTitle: 'Quellen und Referenzen',
+  bibliography: [
+    {
+      name: 'Investopedia: Compound Interest Definition',
+      url: 'https://www.investopedia.com/terms/c/compoundinterest.asp',
+    },
+    {
+      name: 'Investopedia: Rule of 72',
+      url: 'https://www.investopedia.com/terms/r/ruleof72.asp',
+    },
+    {
+      name: 'Khan Academy: Interest and Debt',
+      url: 'https://www.khanacademy.org/economics-finance-domain/core-finance/interest-tutorial',
+    },
+  ],
+  howTo: howToData,
+  schemas: [faqSchema, howToSchema, appSchema],
+  seo: [
+    {
+      type: 'title',
+      text: 'Die Magie des Zinseszinses: Bauen Sie Ihren Reichtum exponentiell auf',
+      level: 2,
+    },
+    {
+      type: 'paragraph',
+      html: 'Albert Einstein nannte ihn das „achte Weltwunder“. Der <strong>Zinseszins</strong> ist der mächtigste Mechanismus, um langfristig Reichtum zu generieren. Man muss kein Finanzexperte sein, um ihn zu nutzen: Man braucht nur Zeit, Geduld und investiertes Geld.',
+    },
+    {
+      type: 'title',
+      text: 'Einfacher Zins vs. Zinseszins: Die Metapher des Schneeballs',
+      level: 3,
+    },
+    {
+      type: 'paragraph',
+      html: 'Stellen Sie sich vor, Sie haben einen Schneeball oben auf einem Hügel. Der <strong>einfache Zins</strong> ist so, als würde man diesen Ball hinunterrollen und manuell jeden Meter Schnee hinzufügen müssen, damit er wächst. Der <strong>Zinseszins</strong> ist so, als würde man den Ball von selbst rollen lassen: Er sammelt von alleine Schnee auf, und je größer er wird, desto mehr Oberfläche hat er, um bei jeder Drehung <em>noch mehr</em> Schnee aufzusammeln.',
+    },
+    {
+      type: 'comparative',
+      columns: 2,
+      items: [
+        {
+          title: 'Einfacher Zins',
+          description: 'Die Zinsen werden immer nur auf das ursprüngliche Kapital berechnet.',
+          points: [
+            'Formel: Kapital × Zinssatz × Zeit',
+            'Lineares und vorhersehbares Wachstum',
+            'Verwendet bei kurzfristigen Krediten',
+            'Keine Reinvestition von Gewinnen',
+          ],
+        },
+        {
+          title: 'Zinseszins',
+          description: 'Zinsen werden zum Kapital addiert und generieren neue Zinsen.',
+          highlight: true,
+          points: [
+            'Formel: Kapital × (1 + Zinssatz)^Zeit',
+            'Beschleunigtes exponentielles Wachstum',
+            'Grundlage jeder langfristigen Investition',
+            'Ihre Gewinne generieren weitere Gewinne',
+          ],
+        },
+      ],
+    },
+    {
+      type: 'paragraph',
+      html: 'Mathematisch gesehen generieren Ihre Gewinne neue Gewinne. In den ersten Jahren scheint es langsam zu sein, aber nach dem „Wendepunkt“ schießt die Kurve vertikal nach oben. Hier entstehen die wahren Vermögen.',
+    },
+    {
+      type: 'title',
+      text: 'Warum ist Zeit Ihr größter Verbündeter?',
+      level: 3,
+    },
+    {
+      type: 'paragraph',
+      html: 'Der entscheidendste Faktor ist nicht die Geldmenge, die Sie investieren, sondern <strong>wie viele Jahre Sie es wachsen lassen</strong>. 10 Jahre früher anzufangen kann zu einem 2- oder 3-mal größeren Endvermögen führen, selbst wenn Sie insgesamt weniger Geld investieren. Dieser exponentielle Effekt ist der Grund, warum junge Investoren einen unvergleichlichen Vorteil haben.',
+    },
+    {
+      type: 'tip',
+      title: 'Die 72er Regel',
+      html: '<p>Teilen Sie 72 durch Ihre jährliche Rendite, um zu wissen, wie viele Jahre es dauert, bis sich <strong>Ihr Geld verdoppelt</strong>.</p><p><em>Beispiel: Bei 8% verdoppeln Sie alle 9 Jahre (72/8 = 9).</em></p><p>Diese magische Formel funktioniert für jede Rendite und hilft Ihnen, das Wachstum Ihrer Investitionen schnell abzuschätzen.</p>',
+    },
+    {
+      type: 'tip',
+      title: 'Tipp 2026',
+      html: '<p>Die Inflation bleibt ein Faktor. Stellen Sie sicher, dass Ihre Nettorendite mindestens 2-3 % pro Jahr übersteigt, um keine Kaufkraft zu verlieren. Investieren Sie in Vermögenswerte, die schneller wachsen als die Inflation.</p>',
+    },
+    {
+      type: 'title',
+      text: 'Zinskapitalisierung: Spielt sie eine Rolle?',
+      level: 3,
+    },
+    {
+      type: 'paragraph',
+      html: 'Zinsen können jährlich, halbjährlich, vierteljährlich, monatlich oder sogar täglich kapitalisiert werden. Je <strong>häufiger die Kapitalisierung</strong> erfolgt, desto größer ist der Zinseszinseffekt. Ein gleiches Kapital mit demselben Zinssatz wächst stärker, wenn die Zinsverrechnung monatlich erfolgt als wenn sie nur jährlich durchgeführt wird.',
+    },
+  ],
+  ui: {
+    labelTitle: 'Investitionssimulator',
+    labelRealtime: 'Echtzeit',
+    labelInitial: 'Startkapital',
+    labelMonthly: 'Monatlicher Beitrag',
+    labelRate: 'Rendite p.a.',
+    labelYears: 'Jahre',
+    labelMyMoney: 'Ihr Geld',
+    labelProfit: 'Gewinn (Zinsen)',
+    labelTotal: 'Gesamtguthaben',
+    labelYear: 'Jahr',
+    labelPrincipal: 'Ihr Geld (Stammkapital)',
+    labelInterest: 'Generierte Zinsen',
+    insightPrefix: '[TIPP] Im Jahr ',
+    insightSuffix:
+      ', werden Ihre jährlich generierten Zinsen Ihre Beiträge übersteigen. Das Geld arbeitet bereits mehr als Sie!',
+    currencySymbol: '€',
+    currencyCode: 'EUR',
+    currencyLocale: 'de-DE',
+  },
+};