@jjlmoya/utils-tabletop 1.39.0 → 1.40.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jjlmoya/utils-tabletop",
-    "version": "1.39.0",
+    "version": "1.40.1",
     "type": "module",
     "main": "./src/index.ts",
     "types": "./src/index.ts",

package/src/components/ProductionStructuredData.astro

@@ -0,0 +1,46 @@
+---
+import type { KnownLocale, ToolLocaleContent } from "../types";
+import { TABLETOP_ASSET_VERSION } from "../mfe/assets";
+
+interface Props {
+    locale: KnownLocale;
+    content: ToolLocaleContent;
+    publicPath: string;
+    categoryTitle: string;
+    categoryHref: string;
+}
+
+const { locale, content, publicPath, categoryTitle, categoryHref } = Astro.props;
+const siteOrigin = locale === "es" ? "https://www.jjlmoya.es" : "https://www.gamebob.dev";
+const fullUrl = new URL(publicPath, siteOrigin).href;
+const categoryUrl = new URL(categoryHref, siteOrigin).href;
+const brandName = locale === "es" ? "jjlmoya" : "GameBob";
+const schemas = (content.schemas ?? []).filter((schema) => (schema as unknown as Record<string, unknown>)["@type"] !== "FAQPage");
+const schemaTypes = new Set(schemas.map((schema) => (schema as unknown as Record<string, unknown>)["@type"]));
+const breadcrumbSchema = {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    itemListElement: [
+        { "@type": "ListItem", position: 1, name: brandName, item: `${siteOrigin}/${locale === "es" ? "" : `${locale}/`}` },
+        { "@type": "ListItem", position: 2, name: categoryTitle, item: categoryUrl },
+        { "@type": "ListItem", position: 3, name: content.title, item: fullUrl },
+    ],
+};
+const webApplicationSchema = {
+    "@context": "https://schema.org",
+    "@type": "WebApplication",
+    name: content.title,
+    description: content.description,
+    url: fullUrl,
+    applicationCategory: "UtilityApplication",
+    operatingSystem: "Any",
+    softwareVersion: TABLETOP_ASSET_VERSION,
+    author: { "@type": "Person", name: "jjlmoya", url: siteOrigin },
+    publisher: { "@type": "Organization", name: brandName, url: siteOrigin },
+    inLanguage: locale,
+    offers: { "@type": "Offer", price: "0", priceCurrency: "EUR" },
+};
+---
+<script is:inline type="application/ld+json" set:html={JSON.stringify(breadcrumbSchema)} />
+{!schemaTypes.has("WebApplication") && <script is:inline type="application/ld+json" set:html={JSON.stringify(webApplicationSchema)} />}
+{schemas.map((schema) => <script is:inline type="application/ld+json" set:html={JSON.stringify(schema)} />)}

package/src/layouts/ProductionPage.astro

@@ -22,10 +22,11 @@ interface Props {
     image?: string | undefined;
     toolCss?: string | undefined;
     publicPath: string;
+    manifestPath?: string | undefined;
     alternates: readonly AlternateLink[];
 }
 
-const { title, description, locale, image, toolCss, publicPath, alternates } = Astro.props;
+const { title, description, locale, image, toolCss, publicPath, manifestPath, alternates } = Astro.props;
 const brand = getBrand(locale);
 const brandFavicon = getBrandAssetPath(brand, "favicon");
 const brandSizedFavicon = getBrandAssetPath(brand, "faviconSized");
@@ -67,6 +68,7 @@ const xDefaultUrl = alternates.find(({ language }) => language === "en")?.url ??
         <link rel="icon" type="image/x-icon" href={brandFavicon} />
         <link rel="icon" type="image/webp" sizes={brand === "jjlmoya" ? "32x32" : "48x48"} href={brandSizedFavicon} />
         <link rel="apple-touch-icon" href={brandAppleTouchIcon} />
+        {manifestPath && <link rel="manifest" href={manifestPath} />}
         <link rel="canonical" href={canonical} />
         {alternates.map(({ language, url }) => <link rel="alternate" hreflang={language} href={absoluteUrl(language, url)} />)}
         <link rel="alternate" hreflang="x-default" href={absoluteUrl("en", xDefaultUrl)} />

package/src/layouts/ProductionUtilityPage.astro

@@ -4,10 +4,11 @@ import { FAQSection, UtilityHeader } from "@jjlmoya/utils-shared";
 import { Icon } from "astro-icon/components";
 import ProductionBreadcrumb from "../components/ProductionBreadcrumb.astro";
 import ProductionWidget from "../components/ProductionWidget.astro";
+import ProductionStructuredData from "../components/ProductionStructuredData.astro";
 import type { KnownLocale, ToolLocaleContent } from "../types";
 import { getCategoryUi } from "../mfe/category-ui";
 import { getCategoryPath, getUtilityPath } from "../mfe/routes";
-import { getUtilityCssPath } from "../mfe/assets";
+import { getUtilityCssPath, TABLETOP_ASSET_VERSION } from "../mfe/assets";
 import type { AstroComponentFactory } from "astro/runtime/server/index.js";
 
 interface RelatedTool { title: string; description: string; href: string; icon: string; }
@@ -21,7 +22,7 @@ const publicCategoryPath = getCategoryPath(locale, categorySlug);
 const ui = getCategoryUi(locale);
 ---
 
-<ProductionPage title={content.title} description={content.description} {locale} {publicPath} {alternates} {image} toolCss={getUtilityCssPath(englishSlug)}>
+<ProductionPage title={content.title} description={content.description} {locale} {publicPath} manifestPath={`${publicPath}manifest.json?version=${TABLETOP_ASSET_VERSION}`} {alternates} {image} toolCss={getUtilityCssPath(englishSlug)}>
   <div class="utility-production">
     <div class="utility-production-inner">
       <ProductionBreadcrumb locale={locale} categoryTitle={categoryTitle} categoryHref={categoryHref || publicCategoryPath} currentTitle={content.title} />
@@ -34,7 +35,7 @@ const ui = getCategoryUi(locale);
       <ProductionWidget locale={locale} slug={content.slug} />
       {content.faq.length > 0 && <section class="utility-section-production"><FAQSection items={content.faq} /></section>}
       <Fragment slot="head">
-        {(content.schemas ?? []).map((schema) => <script is:inline type="application/ld+json" set:html={JSON.stringify(schema)} />)}
+        <ProductionStructuredData locale={locale} {content} {publicPath} categoryTitle={categoryTitle} categoryHref={categoryHref || publicCategoryPath} />
       </Fragment>
       <section class="utility-section-production"><SEOComponent locale={locale} /></section>
       {content.bibliography.length > 0 && <section class="utility-section-production"><BibliographyComponent locale={locale} /></section>}

package/src/mfe/manifest.ts

@@ -0,0 +1,45 @@
+import { getUtilityOgImage } from "./assets";
+
+export interface UtilityManifestInput {
+    title: string;
+    description: string;
+    startUrl: string;
+    englishSlug: string;
+}
+
+const buildUtilityManifest = ({
+    title,
+    description,
+    startUrl,
+    englishSlug,
+}: UtilityManifestInput) => {
+    const shortName = title.length > 12
+        ? title.split(/\s+/).map((word) => word[0]).join("")
+        : title;
+    const manifest = {
+        name: title,
+        short_name: shortName,
+        description,
+        start_url: startUrl,
+        scope: startUrl,
+        icons: [{
+            src: getUtilityOgImage(englishSlug),
+            sizes: "512x512",
+            type: "image/webp",
+            purpose: "any",
+        }],
+        theme_color: "#0f172a",
+        background_color: "#0f172a",
+        display: "standalone",
+        orientation: "portrait",
+    };
+
+    return manifest;
+};
+
+export const createUtilityManifestResponse = (input: UtilityManifestInput): Response => new Response(JSON.stringify(buildUtilityManifest(input), null, 2), {
+        headers: {
+            "Content-Type": "application/manifest+json",
+            "Cache-Control": "public, max-age=31536000, immutable",
+        },
+    });

package/src/pages/[locale]/[utilities]/[categories]/[category]/[slug]/manifest.json.ts

@@ -0,0 +1,49 @@
+import type { APIRoute } from "astro";
+import { ALL_TOOLS, tabletopCategory } from "../../../../../../index";
+import type { CategoryLocaleContent, ToolLocaleContent } from "../../../../../../types";
+import { LANGUAGE_CODES, type Language } from "../../../../../../i18n/languages";
+import { getCategoryNamespace, getUtilityNamespace, getUtilityPath } from "../../../../../../mfe/routes";
+import { createUtilityManifestResponse, type UtilityManifestInput } from "../../../../../../mfe/manifest";
+
+const loadCategories = async () => Object.fromEntries(await Promise.all(LANGUAGE_CODES.map(async (language) => [
+    language,
+    await tabletopCategory.i18n[language]!(),
+]))) as Record<Language, CategoryLocaleContent>;
+
+const loadContents = async (entry: (typeof ALL_TOOLS)[number]["entry"]) => Object.fromEntries(await Promise.all(LANGUAGE_CODES.map(async (language) => {
+    const loader = entry.i18n[language] ?? entry.i18n.en;
+    if (!loader) throw new Error(`Missing ${language} locale for ${entry.id}`);
+    return [language, await loader()];
+}))) as Record<Language, ToolLocaleContent>;
+
+const createManifestPath = (locale: Exclude<Language, "es">, category: CategoryLocaleContent, content: ToolLocaleContent, englishContent: ToolLocaleContent) => ({
+    params: {
+        locale,
+        utilities: getUtilityNamespace(locale),
+        categories: getCategoryNamespace(locale),
+        category: category.slug,
+        slug: content.slug,
+    },
+    props: {
+        title: content.title,
+        description: content.description,
+        startUrl: getUtilityPath(locale, category.slug, content.slug),
+        englishSlug: englishContent.slug,
+    },
+});
+
+export async function getStaticPaths() {
+    const categories = await loadCategories();
+    const paths = [];
+    for (const { entry } of ALL_TOOLS) {
+        const contents = await loadContents(entry);
+        for (const locale of LANGUAGE_CODES.filter((candidate) => candidate !== "es")) {
+            const content = contents[locale];
+            const category = categories[locale];
+            paths.push(createManifestPath(locale, category, content, contents.en));
+        }
+    }
+    return paths;
+}
+
+export const GET: APIRoute = ({ props }) => createUtilityManifestResponse(props as unknown as UtilityManifestInput);

package/src/pages/utilidades/[slug]/manifest.json.ts

@@ -0,0 +1,28 @@
+import type { APIRoute } from "astro";
+import { ALL_TOOLS, tabletopCategory } from "../../../index";
+import type { ToolLocaleContent } from "../../../types";
+import { getUtilityPath } from "../../../mfe/routes";
+import { createUtilityManifestResponse, type UtilityManifestInput } from "../../../mfe/manifest";
+
+export async function getStaticPaths() {
+    const category = await tabletopCategory.i18n.es!();
+    const paths = [];
+    for (const { entry } of ALL_TOOLS) {
+        const loader = entry.i18n.es ?? entry.i18n.en;
+        if (!loader) continue;
+        const content = await loader() as ToolLocaleContent;
+        const englishContent = await (entry.i18n.en ?? loader)() as ToolLocaleContent;
+        paths.push({
+            params: { slug: content.slug },
+            props: {
+                title: content.title,
+                description: content.description,
+                startUrl: getUtilityPath("es", category.slug, content.slug),
+                englishSlug: englishContent.slug,
+            },
+        });
+    }
+    return paths;
+}
+
+export const GET: APIRoute = ({ props }) => createUtilityManifestResponse(props as unknown as UtilityManifestInput);

package/src/tests/mfe_manifest.test.ts

@@ -0,0 +1,28 @@
+import { describe, expect, it } from "vitest";
+import { createUtilityManifestResponse } from "../mfe/manifest";
+
+describe("MFE utility manifest", () => {
+    it("returns a versioned installable manifest for the current utility", async () => {
+        const response = createUtilityManifestResponse({
+            title: "Card draw odds calculator",
+            description: "Calculate card draw probabilities.",
+            startUrl: "/en/utilities/categories/tabletop/card-draw-odds-calculator/",
+            englishSlug: "card-draw-odds-calculator",
+        });
+        const manifest = await response.json() as {
+            name: string;
+            start_url: string;
+            scope: string;
+            icons: { src: string; sizes: string; type: string; purpose: string }[];
+        };
+
+        expect(response.headers.get("Content-Type")).toContain("application/manifest+json");
+        expect(response.headers.get("Cache-Control")).toContain("immutable");
+        expect(manifest.name).toBe("Card draw odds calculator");
+        expect(manifest.start_url).toBe(manifest.scope);
+        expect(manifest.icons[0]?.src).toContain("/_utilities/tabletop/images/card-draw-odds-calculator.webp?version=");
+        expect(manifest.icons[0]?.sizes).toBe("512x512");
+        expect(manifest.icons[0]?.type).toBe("image/webp");
+        expect(manifest.icons[0]?.purpose).toBe("any");
+    });
+});