@jjlmoya/utils-finance 1.36.0 → 1.37.0

package/src/tests/script_density.test.ts

@@ -1,94 +1,94 @@
-import { describe, expect, it } from 'vitest';
-import { ALL_TOOLS } from '../tools';
-
-type ScriptLocale = keyof typeof SCRIPT_RULES;
-
-const SCRIPT_RULES = {
-  ja: {
-    language: 'Japanese',
-    scriptName: 'kana/kanji',
-    scriptCharacters: /[\p{Script=Hiragana}\p{Script=Katakana}\p{Script=Han}]/gu,
-    minScriptRatio: 0.45,
-  },
-  ko: {
-    language: 'Korean',
-    scriptName: 'hangul',
-    scriptCharacters: /\p{Script=Hangul}/gu,
-    minScriptRatio: 0.55,
-  },
-  ru: {
-    language: 'Russian',
-    scriptName: 'cyrillic',
-    scriptCharacters: /\p{Script=Cyrillic}/gu,
-    minScriptRatio: 0.65,
-  },
-  zh: {
-    language: 'Chinese',
-    scriptName: 'han',
-    scriptCharacters: /\p{Script=Han}/gu,
-    minScriptRatio: 0.45,
-  },
-} as const;
-
-const LETTERS = /\p{L}/gu;
-const TRANSLATABLE_KEYS = ['title', 'description', 'ui', 'seo', 'faq', 'howTo'] as const;
-
-function collectStrings(value: unknown): string[] {
-  if (typeof value === 'string') return [value];
-  if (!value || typeof value !== 'object') return [];
-  if (Array.isArray(value)) return value.flatMap(collectStrings);
-  return Object.values(value).flatMap(collectStrings);
-}
-
-function normalizeText(value: unknown): string {
-  return collectStrings(value).join(' ').normalize('NFC');
-}
-
-function translatableContent(content: Record<string, unknown>) {
-  return TRANSLATABLE_KEYS.map((key) => content[key]);
-}
-
-function letterCount(text: string): number {
-  return text.match(LETTERS)?.length ?? 0;
-}
-
-function scriptCount(text: string, locale: ScriptLocale): number {
-  return text.match(SCRIPT_RULES[locale].scriptCharacters)?.length ?? 0;
-}
-
-function scriptRatio(text: string, locale: ScriptLocale): number {
-  const letters = letterCount(text);
-  if (letters === 0) return 0;
-  return scriptCount(text, locale) / letters;
-}
-
-describe('Native script density validation', () => {
-  ALL_TOOLS.forEach((tool) => {
-    describe(`Tool: ${tool.entry.id}`, () => {
-      Object.keys(SCRIPT_RULES).forEach((locale) => {
-        it(`${locale} keeps most translated text in its native script`, async () => {
-          const typedLocale = locale as ScriptLocale;
-          const loader = tool.entry.i18n[typedLocale];
-          if (!loader) return;
-
-          const content = await loader();
-          const rule = SCRIPT_RULES[typedLocale];
-          const text = normalizeText(translatableContent(content as Record<string, unknown>));
-          const letters = letterCount(text);
-          const matches = scriptCount(text, typedLocale);
-          const ratio = scriptRatio(text, typedLocale);
-
-          expect(
-            ratio,
-            [
-              `Possible broken translation detected in ${tool.entry.id}/${typedLocale} (${rule.language}).`,
-              `The text has ${matches} ${rule.scriptName} characters out of ${letters} analyzed letters (${(ratio * 100).toFixed(1)}%).`,
-              `Most translatable content should be written in ${rule.scriptName} script.`,
-              'Non-translatable fields such as slug, bibliography, and schemas are ignored to avoid false positives.',
-            ].join(' '),
-          ).toBeGreaterThanOrEqual(rule.minScriptRatio);
-        });
-      });
-    });
-  });
-});
+import { describe, expect, it } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+
+type ScriptLocale = keyof typeof SCRIPT_RULES;
+
+const SCRIPT_RULES = {
+  ja: {
+    language: 'Japanese',
+    scriptName: 'kana/kanji',
+    scriptCharacters: /[\p{Script=Hiragana}\p{Script=Katakana}\p{Script=Han}]/gu,
+    minScriptRatio: 0.45,
+  },
+  ko: {
+    language: 'Korean',
+    scriptName: 'hangul',
+    scriptCharacters: /\p{Script=Hangul}/gu,
+    minScriptRatio: 0.55,
+  },
+  ru: {
+    language: 'Russian',
+    scriptName: 'cyrillic',
+    scriptCharacters: /\p{Script=Cyrillic}/gu,
+    minScriptRatio: 0.65,
+  },
+  zh: {
+    language: 'Chinese',
+    scriptName: 'han',
+    scriptCharacters: /\p{Script=Han}/gu,
+    minScriptRatio: 0.45,
+  },
+} as const;
+
+const LETTERS = /\p{L}/gu;
+const TRANSLATABLE_KEYS = ['title', 'description', 'ui', 'seo', 'faq', 'howTo'] as const;
+
+function collectStrings(value: unknown): string[] {
+  if (typeof value === 'string') return [value];
+  if (!value || typeof value !== 'object') return [];
+  if (Array.isArray(value)) return value.flatMap(collectStrings);
+  return Object.values(value).flatMap(collectStrings);
+}
+
+function normalizeText(value: unknown): string {
+  return collectStrings(value).join(' ').normalize('NFC');
+}
+
+function translatableContent(content: Record<string, unknown>) {
+  return TRANSLATABLE_KEYS.map((key) => content[key]);
+}
+
+function letterCount(text: string): number {
+  return text.match(LETTERS)?.length ?? 0;
+}
+
+function scriptCount(text: string, locale: ScriptLocale): number {
+  return text.match(SCRIPT_RULES[locale].scriptCharacters)?.length ?? 0;
+}
+
+function scriptRatio(text: string, locale: ScriptLocale): number {
+  const letters = letterCount(text);
+  if (letters === 0) return 0;
+  return scriptCount(text, locale) / letters;
+}
+
+describe('Native script density validation', () => {
+  ALL_TOOLS.forEach((tool) => {
+    describe(`Tool: ${tool.entry.id}`, () => {
+      Object.keys(SCRIPT_RULES).forEach((locale) => {
+        it(`${locale} keeps most translated text in its native script`, async () => {
+          const typedLocale = locale as ScriptLocale;
+          const loader = tool.entry.i18n[typedLocale];
+          if (!loader) return;
+
+          const content = await loader();
+          const rule = SCRIPT_RULES[typedLocale];
+          const text = normalizeText(translatableContent(content as unknown as Record<string, unknown>));
+          const letters = letterCount(text);
+          const matches = scriptCount(text, typedLocale);
+          const ratio = scriptRatio(text, typedLocale);
+
+          expect(
+            ratio,
+            [
+              `Possible broken translation detected in ${tool.entry.id}/${typedLocale} (${rule.language}).`,
+              `The text has ${matches} ${rule.scriptName} characters out of ${letters} analyzed letters (${(ratio * 100).toFixed(1)}%).`,
+              `Most translatable content should be written in ${rule.scriptName} script.`,
+              'Non-translatable fields such as slug, bibliography, and schemas are ignored to avoid false positives.',
+            ].join(' '),
+          ).toBeGreaterThanOrEqual(rule.minScriptRatio);
+        });
+      });
+    });
+  });
+});

package/src/tests/translation_copy.test.ts

@@ -106,8 +106,8 @@ describe('Locales must not copy another locale wholesale', () => {
 
       for (let leftIndex = 0; leftIndex < locales.length; leftIndex += 1) {
         for (let rightIndex = leftIndex + 1; rightIndex < locales.length; rightIndex += 1) {
-          const left = locales[leftIndex];
-          const right = locales[rightIndex];
+          const left = locales[leftIndex]!;
+          const right = locales[rightIndex]!;
           const similarity = copySimilarity(corpora.get(left) ?? '', corpora.get(right) ?? '');
 
           if (similarity >= COPY_THRESHOLD) {

package/src/tool/compoundInterest/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { compoundInterest } from './entry';
 export * from './entry';
 export const COMPOUND_INTEREST_TOOL: ToolDefinition = {

package/src/tool/courtFeeCalculator/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { courtFeeCalculator } from './entry';
 export * from './entry';
 export const COURT_FEE_CALCULATOR_TOOL: ToolDefinition = {

package/src/tool/debtSnowball/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { debtSnowball } from './entry';
 import { DebtSnowballLogic } from './logic';
 export * from './entry';

package/src/tool/fireCalculator/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { fireCalculator } from './entry';
 export * from './entry';
 export const FIRE_CALCULATOR_TOOL: ToolDefinition = {

package/src/tool/ibanBicSwiftConverter/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { ibanBicSwift } from './entry';
 export * from './entry';
 export const IBAN_BIC_SWIFT_TOOL: ToolDefinition = {

package/src/tool/inflation/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { inflation } from './entry';
 export * from './entry';
 export const INFLATION_TOOL: ToolDefinition = {

package/src/tool/lateInterest/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { lateInterest } from './entry';
 export * from './entry';
 export const LATE_INTEREST_TOOL: ToolDefinition = {

package/src/tool/legalInterestRate/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { legalInterestRate } from './entry';
 export * from './entry';
 export const LEGAL_INTEREST_RATE_TOOL: ToolDefinition = {

package/src/tool/lotteryOptimizer/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { lotteryOptimizer } from './entry';
 export * from './entry';
 export const LOTTERY_OPTIMIZER_TOOL: ToolDefinition = {

package/src/tool/mortgage/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { mortgage } from './entry';
 export * from './entry';
 export const MORTGAGE_TOOL: ToolDefinition = {

package/src/tool/percentageCalculator/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { percentageCalculator } from './entry';
 export * from './entry';
 export const PERCENTAGE_CALCULATOR_TOOL: ToolDefinition = {

package/src/tool/rentIncreaseCalculator/index.ts

@@ -1,3 +1,4 @@
+import type { ToolDefinition } from '../../types';
 import { rentIncrease } from './entry';
 export * from './entry';
 export const RENT_INCREASE_TOOL: ToolDefinition = {

package/src/types.ts

@@ -1,12 +1,10 @@
 import type { SEOSection } from '@jjlmoya/utils-shared';
+import type { UtilityLocale } from '@jjlmoya/utils-shared/routing';
 import type { WithContext, Thing } from 'schema-dts';
 
 export type { SEOSection };
 
-export type KnownLocale =
-  | 'ar' | 'da' | 'de' | 'en' | 'es' | 'fi'
-  | 'fr' | 'id' | 'it' | 'ja' | 'ko' | 'nb' | 'nl'
-  | 'pl' | 'pt' | 'ru' | 'sv' | 'tr' | 'zh';
+export type KnownLocale = UtilityLocale;
 
 export interface FAQItem {
   question: string;

package/src/worker.ts

@@ -0,0 +1,25 @@
+interface UtilityMfeEnvironment {
+    ASSETS: { fetch(request: Request): Promise<Response> };
+}
+
+export const LONG_LIVED_ASSET_CACHE = "public, max-age=31536000, immutable";
+
+export const getCacheControl = (pathname: string): string | undefined => {
+    if (pathname.endsWith("/manifest.json")) return LONG_LIVED_ASSET_CACHE;
+    if (pathname.startsWith("/_utilities/")) {
+        return LONG_LIVED_ASSET_CACHE;
+    }
+    return undefined;
+};
+
+export default {
+    async fetch(request: Request, environment: UtilityMfeEnvironment): Promise<Response> {
+        const response = await environment.ASSETS.fetch(request);
+        const cacheControl = getCacheControl(new URL(request.url).pathname);
+        if (!cacheControl) return response;
+
+        const headers = new Headers(response.headers);
+        headers.set("Cache-Control", cacheControl);
+        return new Response(response.body, { status: response.status, headers });
+    },
+};

package/src/pages/[locale]/[slug].astro

@@ -1,161 +0,0 @@
----
-import PreviewLayout from "../../layouts/PreviewLayout.astro";
-import PreviewNavSidebar from "../../components/PreviewNavSidebar.astro";
-import { ALL_TOOLS } from "../../index";
-import {
-  UtilityHeader,
-  FAQSection,
-  Bibliography,
-  SEORenderer,
-} from "@jjlmoya/utils-shared";
-import type { KnownLocale, ToolLocaleContent } from "../../types";
-import type { UtilitySEOContent } from "@jjlmoya/utils-shared";
-
-export async function getStaticPaths() {
-  const paths = [];
-
-  for (const { entry, Component: lazyComp } of ALL_TOOLS) {
-    const { default: Component } = await lazyComp();
-    const localeEntries = Object.entries(entry.i18n) as [
-      KnownLocale,
-      () => Promise<ToolLocaleContent>,
-    ][];
-    const localeContents = await Promise.all(
-      localeEntries.map(async ([locale, loader]) => ({
-        locale,
-        content: await loader(),
-      })),
-    );
-
-    const localeUrls = Object.fromEntries(
-      localeContents.map(({ locale, content }) => [
-        locale,
-        `/${locale}/${content.slug}`,
-      ]),
-    ) as Partial<Record<KnownLocale, string>>;
-
-    const firstLoader = entry.i18n.en ?? Object.values(entry.i18n)[0];
-    const englishSlug = firstLoader ? (await firstLoader()).slug : entry.id;
-
-    for (const { locale, content } of localeContents) {
-      const allToolsNav = (
-        await Promise.all(
-          ALL_TOOLS.map(async ({ entry: navEntry }) => {
-            const loader = navEntry.i18n[locale] ?? navEntry.i18n.en;
-            if (!loader) return null;
-            const navContent = await loader();
-            return {
-              id: navEntry.id,
-              title: navContent.title,
-              href: `/${locale}/${navContent.slug}`,
-              isActive: navEntry.id === entry.id,
-            };
-          }),
-        )
-      ).filter(Boolean) as NavItem[];
-      paths.push({
-        params: { locale, slug: content.slug },
-        props: { Component, locale, content, localeUrls, allToolsNav, englishSlug },
-      });
-    }
-  }
-
-  return paths;
-}
-
-interface NavItem {
-  id: string;
-  title: string;
-  href: string;
-  isActive?: boolean;
-}
-
-interface Props {
-  Component: unknown;
-  locale: KnownLocale;
-  content: ToolLocaleContent;
-  localeUrls: Partial<Record<KnownLocale, string>>;
-  allToolsNav: NavItem[];
-  englishSlug: string;
-}
-
-const { Component, locale, content, localeUrls, allToolsNav, englishSlug } = Astro.props;
-
-const cssFiles = import.meta.glob("../../tool/*/*.css", { query: "?raw", import: "default" });
-const cssKey = Object.keys(cssFiles).find((k) => k.endsWith(`/${englishSlug}.css`));
-const toolCss = cssKey ? await cssFiles[cssKey]() as string : "";
-
-const seoContent: UtilitySEOContent = { locale, sections: content.seo ?? [] };
-
-const words = content.title.split(" ");
-const titleHighlight = words[0] || "";
-const titleBase = words.slice(1).join(" ") || "";
----
-
-<PreviewLayout
-  title={content.title}
-  currentLocale={locale}
-  localeUrls={localeUrls}
-  hasSidebar={true}
->
-  <PreviewNavSidebar
-    slot="sidebar"
-    categoryTitle="Tools"
-    tools={allToolsNav}
-  />
-  <Fragment slot="head">
-    {toolCss ? <Fragment set:html={`<style is:inline>${toolCss}</style>`} /> : null}
-    {
-      ( content.schemas ?? []).map((schema: unknown) => (
-        <script
-          is:inline
-          type="application/ld+json"
-          set:html={JSON.stringify(schema)}
-        />
-      ))
-    }
-  </Fragment>
-
-  <div class="tool-page">
-    <UtilityHeader
-      titleHighlight={titleHighlight}
-      titleBase={titleBase}
-      description={content.description}
-    />
-
-    <section class="section-tool">
-      <Component ui={content.ui} locale={locale} />
-    </section>
-
-    <section class="section-seo">
-      <SEORenderer content={seoContent} />
-    </section>
-
-    <section class="section-faq">
-      <FAQSection items={content.faq} title={content.faqTitle} inLanguage={locale} />
-    </section>
-
-    <section class="section-bibliography">
-      <Bibliography links={content.bibliography}  />
-    </section>
-  </div>
-</PreviewLayout>
-
-<style>
-  .tool-page {
-    display: flex;
-    flex-direction: column;
-    gap: 2rem;
-  }
-  .section-tool {
-    max-width: 1200px;
-    margin: 0 auto;
-    width: 100%;
-  }
-  .section-seo,
-  .section-faq,
-  .section-bibliography {
-    padding-top: 2rem;
-    border-top: 1px solid var(--border-color);
-  }
-</style>