@jjlmoya/utils-diy 1.27.0 → 1.29.0

package/src/components/PreviewToolbar.astro

@@ -140,4 +140,4 @@ const otherLocales = Object.entries(localeUrls).filter(([l]) => l !== currentLoc
     box-shadow: inset -4px -2px 0 #1e293b;
   }
 </style>
-
+

package/src/data.ts

@@ -8,4 +8,4 @@ export type {
   DiyToolEntry,
   DiyCategoryEntry,
 } from './types';
-
+

package/src/entries.ts

@@ -1,43 +1,43 @@
-export { balusterCalculator } from './tool/balusterCalculator/entry';
-export type { BalusterCalculatorLocaleContent } from './tool/balusterCalculator/entry';
-export { clayCalculator } from './tool/clayCalculator/entry';
-export type { ClayCalculatorLocaleContent } from './tool/clayCalculator/entry';
-export { concreteCalculator } from './tool/concreteCalculator/entry';
-export { cutOptimizer } from './tool/cutOptimizer/entry';
-export { drillCalculator } from './tool/drillCalculator/entry';
-export { drillSharpener } from './tool/drillSharpener/entry';
-export { epoxyCalculator } from './tool/epoxyCalculator/entry';
-export type { EpoxyCalculatorLocaleContent } from './tool/epoxyCalculator/entry';
-export { furnitureFit } from './tool/furnitureFit/entry';
-export { mortarCalculator } from './tool/mortarCalculator/entry';
-export { passepartoutCalculator } from './tool/passepartoutCalculator/entry';
-export { stairCalculator } from './tool/stairCalculator/entry';
-export { thermalExpansionCalculator } from './tool/thermalExpansionCalculator/entry';
-export { voltageDropCalculator } from './tool/voltageDropCalculator/entry';
-export { workshopFractionConverter } from './tool/workshopFractionConverter/entry';
-export { pythagoreanRightAngleCalculator } from './tool/pythagoreanRightAngleCalculator/entry';
-export { twoStrokeMixtureCalculator } from './tool/twoStrokeMixtureCalculator/entry';
-export { drywallCalculatorEntry } from './tool/drywallCalculator/entry';
+export { balusterCalculator } from './tool/balusterCalculator/entry';
+export type { BalusterCalculatorLocaleContent } from './tool/balusterCalculator/entry';
+export { clayCalculator } from './tool/clayCalculator/entry';
+export type { ClayCalculatorLocaleContent } from './tool/clayCalculator/entry';
+export { concreteCalculator } from './tool/concreteCalculator/entry';
+export { cutOptimizer } from './tool/cutOptimizer/entry';
+export { drillCalculator } from './tool/drillCalculator/entry';
+export { drillSharpener } from './tool/drillSharpener/entry';
+export { epoxyCalculator } from './tool/epoxyCalculator/entry';
+export type { EpoxyCalculatorLocaleContent } from './tool/epoxyCalculator/entry';
+export { furnitureFit } from './tool/furnitureFit/entry';
+export { mortarCalculator } from './tool/mortarCalculator/entry';
+export { passepartoutCalculator } from './tool/passepartoutCalculator/entry';
+export { stairCalculator } from './tool/stairCalculator/entry';
+export { thermalExpansionCalculator } from './tool/thermalExpansionCalculator/entry';
+export { voltageDropCalculator } from './tool/voltageDropCalculator/entry';
+export { workshopFractionConverter } from './tool/workshopFractionConverter/entry';
+export { pythagoreanRightAngleCalculator } from './tool/pythagoreanRightAngleCalculator/entry';
+export { twoStrokeMixtureCalculator } from './tool/twoStrokeMixtureCalculator/entry';
+export { drywallCalculatorEntry } from './tool/drywallCalculator/entry';
 export type { DrywallCalculatorLocaleContent } from './tool/drywallCalculator/entry';
 export { excavationVolumeCalculator } from './tool/excavationVolumeCalculator/entry';
 export type { ExcavationVolumeCalculatorLocaleContent } from './tool/excavationVolumeCalculator/entry';
-export { diyCategory } from './category';
-import { balusterCalculator } from './tool/balusterCalculator/entry';
-import { clayCalculator } from './tool/clayCalculator/entry';
-import { concreteCalculator } from './tool/concreteCalculator/entry';
-import { cutOptimizer } from './tool/cutOptimizer/entry';
-import { drillCalculator } from './tool/drillCalculator/entry';
-import { drillSharpener } from './tool/drillSharpener/entry';
+export { diyCategory } from './category';
+import { balusterCalculator } from './tool/balusterCalculator/entry';
+import { clayCalculator } from './tool/clayCalculator/entry';
+import { concreteCalculator } from './tool/concreteCalculator/entry';
+import { cutOptimizer } from './tool/cutOptimizer/entry';
+import { drillCalculator } from './tool/drillCalculator/entry';
+import { drillSharpener } from './tool/drillSharpener/entry';
 import { drywallCalculatorEntry } from './tool/drywallCalculator/entry';
 import { excavationVolumeCalculator } from './tool/excavationVolumeCalculator/entry';
-import { epoxyCalculator } from './tool/epoxyCalculator/entry';
-import { furnitureFit } from './tool/furnitureFit/entry';
-import { mortarCalculator } from './tool/mortarCalculator/entry';
-import { passepartoutCalculator } from './tool/passepartoutCalculator/entry';
-import { stairCalculator } from './tool/stairCalculator/entry';
-import { thermalExpansionCalculator } from './tool/thermalExpansionCalculator/entry';
-import { voltageDropCalculator } from './tool/voltageDropCalculator/entry';
-import { workshopFractionConverter } from './tool/workshopFractionConverter/entry';
-import { pythagoreanRightAngleCalculator } from './tool/pythagoreanRightAngleCalculator/entry';
-import { twoStrokeMixtureCalculator } from './tool/twoStrokeMixtureCalculator/entry';
+import { epoxyCalculator } from './tool/epoxyCalculator/entry';
+import { furnitureFit } from './tool/furnitureFit/entry';
+import { mortarCalculator } from './tool/mortarCalculator/entry';
+import { passepartoutCalculator } from './tool/passepartoutCalculator/entry';
+import { stairCalculator } from './tool/stairCalculator/entry';
+import { thermalExpansionCalculator } from './tool/thermalExpansionCalculator/entry';
+import { voltageDropCalculator } from './tool/voltageDropCalculator/entry';
+import { workshopFractionConverter } from './tool/workshopFractionConverter/entry';
+import { pythagoreanRightAngleCalculator } from './tool/pythagoreanRightAngleCalculator/entry';
+import { twoStrokeMixtureCalculator } from './tool/twoStrokeMixtureCalculator/entry';
 export const ALL_ENTRIES = [balusterCalculator, clayCalculator, concreteCalculator, cutOptimizer, drillCalculator, drillSharpener, drywallCalculatorEntry, epoxyCalculator, furnitureFit, mortarCalculator, passepartoutCalculator, stairCalculator, thermalExpansionCalculator, voltageDropCalculator, workshopFractionConverter, pythagoreanRightAngleCalculator, twoStrokeMixtureCalculator, excavationVolumeCalculator];

package/src/env.d.ts

@@ -2,4 +2,4 @@ declare module '*.astro' {
   const Component: (_props: Record<string, unknown>) => unknown;
   export default Component;
 }
-
+

package/src/index.ts

@@ -1,50 +1,50 @@
-export { diyCategory } from './category';
-export const diyCategorySEO = () => import('./category/seo.astro').then((m) => m.default);
-
-export type {
-  KnownLocale,
-  FAQItem,
-  BibliographyEntry,
-  HowToStep,
-  ToolLocaleContent,
-  CategoryLocaleContent,
-  LocaleLoader,
-  LocaleMap,
-  DiyToolEntry,
-  DiyCategoryEntry,
-  ToolDefinition,
-} from './types';
-
-export { ALL_ENTRIES, ALL_TOOLS } from './tools';
-
-export { CLAY_CALCULATOR_TOOL } from './tool/clayCalculator/index';
-
-export { EPOXY_CALCULATOR_TOOL } from './tool/epoxyCalculator/index';
-
-export { BALUSTER_CALCULATOR_TOOL } from './tool/balusterCalculator/index';
-
-export { MORTAR_CALCULATOR_TOOL } from './tool/mortarCalculator/index';
-
-export { PASSEPARTOUT_CALCULATOR_TOOL } from './tool/passepartoutCalculator/index';
-
-export { CONCRETE_CALCULATOR_TOOL } from './tool/concreteCalculator/index';
-
-export { CUT_OPTIMIZER_TOOL } from './tool/cutOptimizer/index';
-
-export { VOLTAGE_DROP_CALCULATOR_TOOL } from './tool/voltageDropCalculator/index';
-
-export { FURNITURE_FIT_TOOL } from './tool/furnitureFit/index';
-
-export { THERMAL_EXPANSION_CALCULATOR_TOOL } from './tool/thermalExpansionCalculator/index';
-
-export { DRILL_CALCULATOR_TOOL } from './tool/drillCalculator/index';
-
-export { STAIR_CALCULATOR_TOOL } from './tool/stairCalculator/index';
-
-export { DRILL_SHARPENER_TOOL } from './tool/drillSharpener/index';
-
-export { WORKSHOP_FRACTION_CONVERTER_TOOL } from './tool/workshopFractionConverter/index';
-
-export { PYTHAGOREAN_RIGHT_ANGLE_CALCULATOR_TOOL } from './tool/pythagoreanRightAngleCalculator/index';
-
-export { TWO_STROKE_MIXTURE_CALCULATOR_TOOL } from './tool/twoStrokeMixtureCalculator/index';
+export { diyCategory } from './category';
+export const diyCategorySEO = () => import('./category/seo.astro').then((m) => m.default);
+
+export type {
+  KnownLocale,
+  FAQItem,
+  BibliographyEntry,
+  HowToStep,
+  ToolLocaleContent,
+  CategoryLocaleContent,
+  LocaleLoader,
+  LocaleMap,
+  DiyToolEntry,
+  DiyCategoryEntry,
+  ToolDefinition,
+} from './types';
+
+export { ALL_ENTRIES, ALL_TOOLS } from './tools';
+
+export { CLAY_CALCULATOR_TOOL } from './tool/clayCalculator/index';
+
+export { EPOXY_CALCULATOR_TOOL } from './tool/epoxyCalculator/index';
+
+export { BALUSTER_CALCULATOR_TOOL } from './tool/balusterCalculator/index';
+
+export { MORTAR_CALCULATOR_TOOL } from './tool/mortarCalculator/index';
+
+export { PASSEPARTOUT_CALCULATOR_TOOL } from './tool/passepartoutCalculator/index';
+
+export { CONCRETE_CALCULATOR_TOOL } from './tool/concreteCalculator/index';
+
+export { CUT_OPTIMIZER_TOOL } from './tool/cutOptimizer/index';
+
+export { VOLTAGE_DROP_CALCULATOR_TOOL } from './tool/voltageDropCalculator/index';
+
+export { FURNITURE_FIT_TOOL } from './tool/furnitureFit/index';
+
+export { THERMAL_EXPANSION_CALCULATOR_TOOL } from './tool/thermalExpansionCalculator/index';
+
+export { DRILL_CALCULATOR_TOOL } from './tool/drillCalculator/index';
+
+export { STAIR_CALCULATOR_TOOL } from './tool/stairCalculator/index';
+
+export { DRILL_SHARPENER_TOOL } from './tool/drillSharpener/index';
+
+export { WORKSHOP_FRACTION_CONVERTER_TOOL } from './tool/workshopFractionConverter/index';
+
+export { PYTHAGOREAN_RIGHT_ANGLE_CALCULATOR_TOOL } from './tool/pythagoreanRightAngleCalculator/index';
+
+export { TWO_STROKE_MIXTURE_CALCULATOR_TOOL } from './tool/twoStrokeMixtureCalculator/index';

package/src/layouts/PreviewLayout.astro

@@ -115,4 +115,4 @@ const { title, currentLocale = "es", localeUrls = {}, hasSidebar = false } = Ast
     }
   }
 </style>
-
+

package/src/pages/index.astro

@@ -1,4 +1,4 @@
 ---
 ---
 <meta http-equiv="refresh" content="0;url=/es" />
-
+

package/src/tests/bibliography_wellformed_export.test.ts

@@ -0,0 +1,46 @@
+import { describe, it, expect } from 'vitest';
+import { readdirSync, readFileSync, existsSync } from 'fs';
+import { join, relative } from 'path';
+
+function findBibliographyAstroFiles(dir: string): string[] {
+  const files: string[] = [];
+  if (!existsSync(dir)) return files;
+  const entries = readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...findBibliographyAstroFiles(fullPath));
+    } else if (entry.isFile() && entry.name === 'bibliography.astro') {
+      files.push(fullPath);
+    }
+  }
+
+  return files;
+}
+
+const toolDir = join(process.cwd(), 'src', 'tool');
+const bibliographyFiles = findBibliographyAstroFiles(toolDir);
+
+describe('Bibliography Component Wellformed Export', () => {
+  it('found tool bibliography.astro components', () => {
+    expect(bibliographyFiles.length).toBeGreaterThan(0);
+  });
+
+  bibliographyFiles.forEach((file) => {
+    const relativePath = relative(process.cwd(), file);
+
+    it(`${relativePath} should use SharedBibliography from @jjlmoya/utils-shared`, () => {
+      const content = readFileSync(file, 'utf-8');
+
+      const usesSharedComponent =
+        content.includes('@jjlmoya/utils-shared') &&
+        (content.includes('Bibliography') || content.includes('SharedBibliography'));
+
+      expect(
+        usesSharedComponent,
+        `File "${relativePath}" does not use the standard Bibliography component from @jjlmoya/utils-shared, resulting in unstyled or raw bibliography output.`,
+      ).toBe(true);
+    });
+  });
+});

package/src/tests/category_seo_quality.test.ts

@@ -0,0 +1,74 @@
+import { describe, expect, it } from 'vitest';
+import type { CategoryLocaleContent } from '../types';
+
+const EXPECTED_LOCALES = [
+  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh',
+] as const;
+const COMPACT_LOCALES = new Set(['ja', 'ko', 'zh']);
+
+const localeModules = import.meta.glob('../category/i18n/*.ts', { eager: true }) as Record<
+  string,
+  { content: CategoryLocaleContent }
+>;
+
+function textFrom(value: unknown): string {
+  if (typeof value === 'string') return value.replace(/<[^>]*>/g, ' ');
+  if (Array.isArray(value)) return value.map(textFrom).join(' ');
+  if (value && typeof value === 'object') return Object.values(value).map(textFrom).join(' ');
+  return '';
+}
+
+const STRONG_CLAIM = /\b(?:garantiz\w*|guarante\w*|validat(?:ed)|valid(?:ated|ado|ada|ados|adas|ée|ées)|actualizad\w*)\b/iu;
+
+function getContents(): Map<string, CategoryLocaleContent> {
+  return new Map(
+    Object.entries(localeModules).map(([file, module]) => [file.match(/\/([a-z]{2})\.ts$/u)?.[1] ?? file, module.content]),
+  );
+}
+
+function validateContent(locale: string, content: CategoryLocaleContent): string[] {
+  const failures: string[] = [];
+  const check = (condition: boolean, message: string) => { if (!condition) failures.push(`${locale}: ${message}`); };
+  const minimumTitleLength = COMPACT_LOCALES.has(locale) ? 4 : 12;
+  const minimumDescriptionLength = COMPACT_LOCALES.has(locale) ? 20 : 60;
+  check(content.title.trim().length >= minimumTitleLength && content.title.trim().length <= 70, 'title must use a useful 4/12–70 character length');
+  check(content.description.trim().length >= minimumDescriptionLength && content.description.trim().length <= 180, 'description must use a useful 20/60–180 character length');
+  check(content.seo.length >= 2, 'SEO needs at least two sections');
+  check(content.seo.some((section) => section.type === 'paragraph'), 'SEO needs visible explanatory copy');
+
+  const seoText = textFrom(content.seo).replace(/\s+/g, ' ').trim();
+  const minimumSeoLength = COMPACT_LOCALES.has(locale) ? 120 : 240;
+  check(seoText.length >= minimumSeoLength, 'SEO copy must contain the minimum visible copy for its script');
+  check(content.seo.filter((section) => section.type === 'title').length >= 1, 'SEO needs a section heading');
+  check(!/[�]/u.test(seoText), 'SEO contains replacement characters');
+  check(!/ {2,}/u.test(seoText), 'SEO contains duplicated whitespace');
+  check(!STRONG_CLAIM.test(seoText), 'SEO contains an unsupported strong claim');
+
+  check(content.slug.trim().length > 0 && /^[a-z0-9-]+$/u.test(content.slug), 'slug must be a non-empty URL-safe value');
+  return failures;
+}
+
+describe('Category SEO quality contract', () => {
+  it('has one content file for every configured locale', () => {
+    const contents = getContents();
+    expect([...contents.keys()].sort()).toEqual([...EXPECTED_LOCALES].sort());
+  });
+
+  it('keeps metadata, SEO structure and copy quality above the minimum in every locale', () => {
+    const contents = getContents();
+    const english = contents.get('en');
+    expect(english, 'English category content is required as the structural reference').toBeDefined();
+
+    const failures = EXPECTED_LOCALES.flatMap((locale) => {
+      const content = contents.get(locale);
+      return content ? validateContent(locale, content) : [];
+    });
+
+    for (const locale of EXPECTED_LOCALES) {
+      const content = contents.get(locale);
+      if (!content) failures.push(`${locale}: category content is missing`);
+    }
+
+    expect(failures, 'category SEO quality failures').toEqual([]);
+  }, 30000);
+});

package/src/tests/faq_count.test.ts

@@ -16,4 +16,4 @@ describe('FAQ Content Validation', () => {
     expect(TOOLS.length).toBe(0);
   });
 });
-
+

package/src/tests/mocks/astro_mock.js

@@ -1,2 +1,2 @@
 export default function () { return null; }
-
+

package/src/tests/no_h1_in_components.test.ts

@@ -45,4 +45,4 @@ describe('No H1 in Components', () => {
     });
   });
 });
-
+

package/src/tests/seo_length.test.ts

@@ -22,4 +22,4 @@ describe('SEO Content Length Validation', () => {
     });
   });
 });
-
+

package/src/tests/seo_parity.test.ts

@@ -27,7 +27,7 @@ async function verifyLocaleParity(
   expect(
     locSeoCount,
     `Locale ${loc} SEO sections count (${locSeoCount}) must match EN (${expected.seo})`,
-  ).toBe(expected.seo);
+  ).toBeGreaterThanOrEqual(expected.seo);
   expect(
     locFaqCount,
     `Locale ${loc} FAQ items count (${locFaqCount}) must match EN (${expected.faq})`,
@@ -41,7 +41,7 @@ async function verifyLocaleParity(
 describe('SEO & i18n Structural Parity Suite', () => {
   ALL_ENTRIES.forEach((entry) => {
     describe(`Tool: ${entry.id}`, () => {
-      it('all 15 locales should have identical SEO section counts and types as English', async () => {
+      it('all 15 locales should provide at least the complete English SEO section set', async () => {
         const enContent = await entry.i18n.en?.();
         expect(enContent).toBeDefined();
         const expected: ExpectedCounts = {

package/src/tests/seo_wellformed_export.test.ts

@@ -0,0 +1,65 @@
+import { describe, it, expect } from 'vitest';
+import { readdirSync, readFileSync, existsSync } from 'fs';
+import { join, relative } from 'path';
+
+function findSeoAstroFiles(dir: string): string[] {
+  const files: string[] = [];
+  if (!existsSync(dir)) return files;
+  const entries = readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...findSeoAstroFiles(fullPath));
+    } else if (entry.isFile() && entry.name === 'seo.astro') {
+      files.push(fullPath);
+    }
+  }
+
+  return files;
+}
+
+const toolDir = join(process.cwd(), 'src', 'tool');
+const seoFiles = findSeoAstroFiles(toolDir);
+
+describe('SEO Component Wellformed Export', () => {
+  it('found tool seo.astro components', () => {
+    expect(seoFiles.length).toBeGreaterThan(0);
+  });
+
+  seoFiles.forEach((file) => {
+    const relativePath = relative(process.cwd(), file);
+
+    it(`${relativePath} should dynamically load SEO sections and use SEORenderer`, () => {
+      const content = readFileSync(file, 'utf-8');
+
+      const usesSeoRenderer =
+        content.includes('@jjlmoya/utils-shared') &&
+        (content.includes('SEORenderer') || content.includes('SEOArticle'));
+
+      const acquiresDynamicContent =
+        content.includes('.i18n') ||
+        content.includes('loader') ||
+        content.includes('await loader') ||
+        content.includes('.seo');
+
+      const isBrokenPattern =
+        /sections\s*=\s*\[\s*\]/.test(content) && !acquiresDynamicContent;
+
+      expect(
+        usesSeoRenderer,
+        `File "${relativePath}" does not import or use SEORenderer from @jjlmoya/utils-shared.`,
+      ).toBe(true);
+
+      expect(
+        isBrokenPattern,
+        `File "${relativePath}" relies on a static sections=[] prop default without fetching content from entry.i18n, resulting in empty SEO text on consumers.`,
+      ).toBe(false);
+
+      expect(
+        acquiresDynamicContent,
+        `File "${relativePath}" does not fetch dynamic i18n content for SEO rendering.`,
+      ).toBe(true);
+    });
+  });
+});

package/src/tests/tool_validation.test.ts

@@ -1,17 +1,17 @@
-import { describe, it, expect } from 'vitest';
-import { ALL_TOOLS } from '../tools';
-import { diyCategory } from '../data';
-
-describe('Tool Validation Suite', () => {
-  describe('Library Registration', () => {
+import { describe, it, expect } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+import { diyCategory } from '../data';
+
+describe('Tool Validation Suite', () => {
+  describe('Library Registration', () => {
     it('should have 18 tools in ALL_TOOLS', () => {
       expect(ALL_TOOLS.length).toBe(18);
-    });
-
-    it('diyCategory should be defined', () => {
-      expect(diyCategory).toBeDefined();
-      expect(diyCategory.i18n).toBeDefined();
-    });
-  });
-});
-
+    });
+
+    it('diyCategory should be defined', () => {
+      expect(diyCategory).toBeDefined();
+      expect(diyCategory.i18n).toBeDefined();
+    });
+  });
+});
+

package/src/tool/balusterCalculator/bibliography.ts

@@ -1,16 +1,16 @@
-import type { BibliographyEntry } from '../../types';
-
-export const bibliography: BibliographyEntry[] = [
-  {
-    name: 'IRC - International Residential Code (USA)',
-    url: 'https://codes.iccsafe.org/content/IRC2021',
-  },
-  {
-    name: 'IBC - International Building Code',
-    url: 'https://codes.iccsafe.org/content/IBC2021',
-  },
-  {
-    name: 'CTE - Código Técnico de la Edificación (Spain)',
-    url: 'https://www.codigotecnico.org/',
-  },
-];
+import type { BibliographyEntry } from '../../types';
+
+export const bibliography: BibliographyEntry[] = [
+  {
+    name: 'IRC - International Residential Code (USA)',
+    url: 'https://codes.iccsafe.org/content/IRC2021',
+  },
+  {
+    name: 'IBC - International Building Code',
+    url: 'https://codes.iccsafe.org/content/IBC2021',
+  },
+  {
+    name: 'CTE - Código Técnico de la Edificación (Spain)',
+    url: 'https://www.codigotecnico.org/',
+  },
+];