react-cheminfo 0.4.0 → 0.4.1

package/lib/seo/core/siteFiles.js

@@ -0,0 +1,100 @@
+/**
+ * The files and blocks a crawler reads besides the head: the sitemap, the
+ * robots policy, the structured-data block and the list of addresses a visitor
+ * without JavaScript can still follow.
+ *
+ * All four are derived from the site's own record and its route table, so a
+ * page added to the table is added to every one of them at once.
+ */
+import { siteById, siteDisplayName } from "../../ecosystem/core/lookup.js";
+import { escapeAttribute, escapeText } from "../../share/core/escape.js";
+import { trimTrailingSlash } from "./routes.js";
+/** The sequence that must not appear raw inside a script element. */
+const SCRIPT_SAFE_LESS_THAN = String.raw `\u003c`;
+/**
+ * Every routed address, as the sitemap lists them.
+ * @param options - The site and its routes.
+ * @returns The `sitemap.xml` document.
+ */
+export function sitemapXml(options) {
+    const origin = originOf(options);
+    const entries = options.routes
+        .map((route) => `  <url><loc>${escapeText(`${origin}${route.path}`)}</loc></url>`)
+        .join('\n');
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${entries}
+</urlset>
+`;
+}
+/**
+ * The crawl policy.
+ *
+ * Our tools are meant to be found, so only the endpoints are disallowed — an
+ * API prefix and its documentation are not pages. The sitemap is named only
+ * because this module also writes it: a `Sitemap:` line pointing at a 404 is
+ * reported as an error on every fetch.
+ * @param options - The site and its routes.
+ * @param disallow - Address prefixes to keep out of the index.
+ * @returns The `robots.txt` document.
+ */
+export function robotsTxt(options, disallow = []) {
+    const lines = ['User-agent: *', 'Allow: /'];
+    for (const path of disallow)
+        lines.push(`Disallow: ${path}`);
+    lines.push('', `Sitemap: ${originOf(options)}/sitemap.xml`, '');
+    return lines.join('\n');
+}
+/**
+ * One `application/ld+json` block describing the tool.
+ *
+ * It is the same on every page of a site — what varies per page is the head —
+ * so it is written into the built page once rather than per route.
+ * @param options - The site, and what kind of application it is.
+ * @returns The script tag, ready to put in the head.
+ */
+export function structuredDataScript(options) {
+    const site = resolveSite(options.site);
+    const data = {
+        '@context': 'https://schema.org',
+        '@type': 'WebApplication',
+        name: siteDisplayName(site),
+        url: `${originOf(options)}/`,
+        description: site.tagline,
+        applicationCategory: options.category ?? 'EducationalApplication',
+        operatingSystem: options.operatingSystem ?? 'Any modern browser',
+        offers: { '@type': 'Offer', price: '0', priceCurrency: 'EUR' },
+        publisher: { '@type': 'Organization', name: 'cheminfo' },
+    };
+    const json = JSON.stringify(data, null, 2).replaceAll('<', SCRIPT_SAFE_LESS_THAN);
+    return `<script type="application/ld+json">\n${json}\n</script>`;
+}
+/**
+ * A readable page for a visitor, or a crawler, with no JavaScript.
+ *
+ * The body of our sites is an empty root element, so this is the only crawl
+ * path through them that costs nothing to render — and it is honest: it says
+ * the tool needs JavaScript, and links every address it answers.
+ * @param options - The site and its routes.
+ * @returns The `noscript` block, ready to put in the body.
+ */
+export function noscriptIndex(options) {
+    const site = resolveSite(options.site);
+    const items = options.routes
+        .map((route) => `    <li><a href="${escapeAttribute(route.path)}">${escapeText(route.title)}</a></li>`)
+        .join('\n');
+    return `<noscript>
+  <h1>${escapeText(siteDisplayName(site))}</h1>
+  <p>${escapeText(site.tagline)} This tool needs JavaScript; these are the pages it offers:</p>
+  <ul>
+${items}
+  </ul>
+</noscript>`;
+}
+function resolveSite(site) {
+    return typeof site === 'string' ? siteById(site) : site;
+}
+function originOf(options) {
+    return trimTrailingSlash(options.origin ?? `https://${resolveSite(options.site).host}`);
+}
+//# sourceMappingURL=siteFiles.js.map

package/lib/seo/core/siteFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siteFiles.js","sourceRoot":"","sources":["../../../src/seo/core/siteFiles.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAE3E,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAA,QAAQ,CAAC;AAejD;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,OAAyB;IAClD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM;SAC3B,GAAG,CACF,CAAC,KAAK,EAAE,EAAE,CACR,eAAe,UAAU,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,cAAc,CACpE;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,OAAO;;EAEP,OAAO;;CAER,CAAC;AACF,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CACvB,OAAyB,EACzB,WAA8B,EAAE;IAEhC,MAAM,KAAK,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IAC5C,KAAK,MAAM,IAAI,IAAI,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;IAC7D,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAgBD;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG;QACX,UAAU,EAAE,oBAAoB;QAChC,OAAO,EAAE,gBAAgB;QACzB,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;QAC3B,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG;QAC5B,WAAW,EAAE,IAAI,CAAC,OAAO;QACzB,mBAAmB,EAAE,OAAO,CAAC,QAAQ,IAAI,wBAAwB;QACjE,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,oBAAoB;QAChE,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE;QAC9D,SAAS,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE;KACzD,CAAC;IACF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CACnD,GAAG,EACH,qBAAqB,CACtB,CAAC;IACF,OAAO,wCAAwC,IAAI,aAAa,CAAC;AACnE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,OAAyB;IACrD,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM;SACzB,GAAG,CACF,CAAC,KAAK,EAAE,EAAE,CACR,oBAAoB,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CACzF;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,OAAO;QACD,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;OAClC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;;EAE7B,KAAK;;YAEK,CAAC;AACb,CAAC;AAED,SAAS,WAAW,CAAC,IAA4B;IAC/C,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1D,CAAC;AAED,SAAS,QAAQ,CAAC,OAAyB;IACzC,OAAO,iBAAiB,CACtB,OAAO,CAAC,MAAM,IAAI,WAAW,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAC9D,CAAC;AACJ,CAAC"}

package/lib/seo/vite/index.d.ts

@@ -0,0 +1,5 @@
+export type { OgCardOptions } from './ogCard.ts';
+export { OG_HEIGHT, OG_WIDTH, ogCardHtml } from './ogCard.ts';
+export type { PrerenderOptions } from './prerender.ts';
+export { cheminfoPrerender } from './prerender.ts';
+//# sourceMappingURL=index.d.ts.map

package/lib/seo/vite/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/seo/vite/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9D,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}

package/lib/seo/vite/index.js

@@ -0,0 +1,3 @@
+export { OG_HEIGHT, OG_WIDTH, ogCardHtml } from "./ogCard.js";
+export { cheminfoPrerender } from "./prerender.js";
+//# sourceMappingURL=index.js.map

package/lib/seo/vite/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/seo/vite/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}

package/lib/seo/vite/ogCard.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The 1200×630 card a link to a site unfurls into, as a page to screenshot.
+ *
+ * The card is the site's own mark, its two colours and its name, all read from
+ * its record — so it is generated rather than hand-drawn. A mark redrawn in the
+ * card is a mark that drifts from the one the site shows.
+ */
+import type { EcosystemSite, SiteId } from '../../ecosystem/core/sites.ts';
+/** The width every card is drawn at. */
+export declare const OG_WIDTH = 1200;
+/** The height every card is drawn at. */
+export declare const OG_HEIGHT = 630;
+/** What the card says, beyond the site's own name and mark. */
+export interface OgCardOptions {
+    /** The site, named or passed. */
+    site: EcosystemSite | SiteId;
+    /**
+     * The sentence under the name.
+     * @default the site's tagline
+     */
+    description?: string;
+}
+/**
+ * The card, as a standalone page.
+ *
+ * Screenshot it at {@link OG_WIDTH} × {@link OG_HEIGHT} — a headless browser is
+ * the only thing here that can rasterise it, and every site already has one for
+ * its end-to-end tests.
+ * @param options - Which site, and what it says.
+ * @returns A complete HTML document.
+ */
+export declare function ogCardHtml(options: OgCardOptions): string;
+//# sourceMappingURL=ogCard.d.ts.map

package/lib/seo/vite/ogCard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ogCard.d.ts","sourceRoot":"","sources":["../../../src/seo/vite/ogCard.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAI3E,wCAAwC;AACxC,eAAO,MAAM,QAAQ,OAAO,CAAC;AAE7B,yCAAyC;AACzC,eAAO,MAAM,SAAS,MAAM,CAAC;AAE7B,+DAA+D;AAC/D,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAiDzD"}

package/lib/seo/vite/ogCard.js

@@ -0,0 +1,72 @@
+/**
+ * The 1200×630 card a link to a site unfurls into, as a page to screenshot.
+ *
+ * The card is the site's own mark, its two colours and its name, all read from
+ * its record — so it is generated rather than hand-drawn. A mark redrawn in the
+ * card is a mark that drifts from the one the site shows.
+ */
+import { createElement } from 'react';
+import { renderToStaticMarkup } from 'react-dom/server';
+import { siteById } from "../../ecosystem/core/lookup.js";
+import { SiteMark } from "../../ecosystem/ui/marks.js";
+import { escapeText } from "../../share/core/escape.js";
+/** The width every card is drawn at. */
+export const OG_WIDTH = 1200;
+/** The height every card is drawn at. */
+export const OG_HEIGHT = 630;
+/**
+ * The card, as a standalone page.
+ *
+ * Screenshot it at {@link OG_WIDTH} × {@link OG_HEIGHT} — a headless browser is
+ * the only thing here that can rasterise it, and every site already has one for
+ * its end-to-end tests.
+ * @param options - Which site, and what it says.
+ * @returns A complete HTML document.
+ */
+export function ogCardHtml(options) {
+    const site = typeof options.site === 'string' ? siteById(options.site) : options.site;
+    const description = options.description ?? site.tagline;
+    const mark = renderToStaticMarkup(createElement(SiteMark, { site, size: 132, colors: 'literal' }));
+    const dot = site.name.dot === true ? '<span class="dot">.</span>' : '';
+    return `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <style>
+      * { box-sizing: border-box; margin: 0; }
+      body {
+        display: flex;
+        width: ${OG_WIDTH}px;
+        height: ${OG_HEIGHT}px;
+        flex-direction: column;
+        justify-content: center;
+        padding: 88px;
+        background: #ffffff;
+        color: #16202c;
+        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+          Helvetica, Arial, sans-serif;
+        gap: 28px;
+      }
+      h1 { font-size: 76px; font-weight: 700; letter-spacing: -0.02em; }
+      .lead { color: ${site.brand}; }
+      .alt { color: ${site.brandAlt}; }
+      .dot { color: #8a96a3; }
+      p { max-width: 900px; color: #5b6875; font-size: 34px; line-height: 1.35; }
+      .rule {
+        width: 180px;
+        height: 10px;
+        border-radius: 5px;
+        background: ${site.brandAlt};
+      }
+    </style>
+  </head>
+  <body>
+    ${mark}
+    <h1><span class="lead">${escapeText(site.name.lead)}</span>${dot}<span class="alt">${escapeText(site.name.alt)}</span></h1>
+    <div class="rule"></div>
+    <p>${escapeText(description)}</p>
+  </body>
+</html>
+`;
+}
+//# sourceMappingURL=ogCard.js.map

package/lib/seo/vite/ogCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ogCard.js","sourceRoot":"","sources":["../../../src/seo/vite/ogCard.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA8B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,wCAAwC;AACxC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC;AAE7B,yCAAyC;AACzC,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC;AAa7B;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,OAAsB;IAC/C,MAAM,IAAI,GACR,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3E,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC;IACxD,MAAM,IAAI,GAAG,oBAAoB,CAC/B,aAAa,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAChE,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,EAAE,CAAC;IAEvE,OAAO;;;;;;;;iBAQQ,QAAQ;kBACP,SAAS;;;;;;;;;;;uBAWJ,IAAI,CAAC,KAAK;sBACX,IAAI,CAAC,QAAQ;;;;;;;sBAOb,IAAI,CAAC,QAAQ;;;;;MAK7B,IAAI;6BACmB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,qBAAqB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;;SAEzG,UAAU,CAAC,WAAW,CAAC;;;CAG/B,CAAC;AACF,CAAC"}

package/lib/seo/vite/prerender.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Write one real HTML file per routed address, and everything else a crawler
+ * fetches on its own.
+ *
+ * A site served by a static image has nothing to rewrite a head per request: a
+ * crawler gets whatever came off the wire. Without this every address carries
+ * the same title and a search engine folds the whole site into one result.
+ *
+ * These files are also what makes the server's catch-all fallback unnecessary.
+ * Every address the tool answers is on disk, so an address that is *not* on
+ * disk is genuinely not a page and must 404 rather than serving the tool under
+ * a name it does not have.
+ */
+import type { Plugin } from 'vite';
+import type { EcosystemSite, SiteId } from '../../ecosystem/core/sites.ts';
+import type { RouteMeta } from '../core/routes.ts';
+/** What the build needs to know to write the site's addresses. */
+export interface PrerenderOptions {
+    /** The site, named or passed. */
+    site: EcosystemSite | SiteId;
+    /** Every address it answers, each with its title and description. */
+    routes: readonly RouteMeta[];
+    /**
+     * Origin every absolute address is built on.
+     * @default `https://<the site's host>`
+     */
+    origin?: string;
+    /**
+     * Address prefixes `robots.txt` keeps out of the index, e.g. `/v1/`. Set to
+     * `false` to write no `robots.txt` at all, for a site that ships its own.
+     * @default []
+     */
+    robots?: false | readonly string[];
+    /**
+     * The schema.org category of the structured-data block, or `false` to write
+     * none.
+     * @default 'EducationalApplication'
+     */
+    category?: false | string;
+    /**
+     * What the tool needs to run, named in the structured-data block.
+     * @default 'Any modern browser'
+     */
+    operatingSystem?: string;
+    /**
+     * Whether the built page carries a `noscript` index of the addresses. It is
+     * the only crawl path through a site whose body is an empty root element.
+     * @default true
+     */
+    noscript?: boolean;
+}
+/**
+ * Prerender every routed address of a cheminfo site.
+ * @param options - The site, its routes, and what a crawler is told.
+ * @returns The Vite plugin.
+ */
+export declare function cheminfoPrerender(options: PrerenderOptions): Plugin;
+//# sourceMappingURL=prerender.d.ts.map

package/lib/seo/vite/prerender.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerender.d.ts","sourceRoot":"","sources":["../../../src/seo/vite/prerender.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAKH,OAAO,KAAK,EAAU,MAAM,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAE3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAQnD,kEAAkE;AAClE,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC;IAC7B,qEAAqE;IACrE,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,MAAM,EAAE,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM,CA+EnE"}

package/lib/seo/vite/prerender.js

@@ -0,0 +1,76 @@
+/**
+ * Write one real HTML file per routed address, and everything else a crawler
+ * fetches on its own.
+ *
+ * A site served by a static image has nothing to rewrite a head per request: a
+ * crawler gets whatever came off the wire. Without this every address carries
+ * the same title and a search engine folds the whole site into one result.
+ *
+ * These files are also what makes the server's catch-all fallback unnecessary.
+ * Every address the tool answers is on disk, so an address that is *not* on
+ * disk is genuinely not a page and must 404 rather than serving the tool under
+ * a name it does not have.
+ */
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { injectPageMeta, insertBeforeHeadEnd } from "../core/pageMeta.js";
+import { noscriptIndex, robotsTxt, sitemapXml, structuredDataScript, } from "../core/siteFiles.js";
+/**
+ * Prerender every routed address of a cheminfo site.
+ * @param options - The site, its routes, and what a crawler is told.
+ * @returns The Vite plugin.
+ */
+export function cheminfoPrerender(options) {
+    const { site, routes, origin, robots = [], category, operatingSystem, noscript = true, } = options;
+    let out = 'dist';
+    let logger = null;
+    return {
+        name: 'cheminfo:prerender',
+        apply: 'build',
+        configResolved(config) {
+            out = resolve(config.root, config.build.outDir);
+            logger = config.logger;
+        },
+        transformIndexHtml: {
+            order: 'post',
+            handler(html) {
+                let page = html;
+                if (category !== false) {
+                    page = insertBeforeHeadEnd(page, structuredDataScript({
+                        site,
+                        routes,
+                        origin,
+                        category,
+                        operatingSystem,
+                    }));
+                }
+                if (noscript) {
+                    page = insertBeforeBodyEnd(page, noscriptIndex({ site, routes, origin }));
+                }
+                return page;
+            },
+        },
+        closeBundle() {
+            const index = readFileSync(join(out, 'index.html'), 'utf8');
+            for (const route of routes) {
+                const file = route.path === '/'
+                    ? join(out, 'index.html')
+                    : join(out, route.path.slice(1), 'index.html');
+                mkdirSync(dirname(file), { recursive: true });
+                writeFileSync(file, injectPageMeta(index, { site, routes, origin, url: route.path }));
+            }
+            writeFileSync(join(out, 'sitemap.xml'), sitemapXml({ site, routes, origin }));
+            if (robots !== false) {
+                writeFileSync(join(out, 'robots.txt'), robotsTxt({ site, routes, origin }, robots));
+            }
+            logger?.info(`${routes.length} pages prerendered, and listed in sitemap.xml`);
+        },
+    };
+}
+function insertBeforeBodyEnd(html, addition) {
+    const body = html.lastIndexOf('</body>');
+    if (body === -1)
+        return `${html}\n${addition}\n`;
+    return `${html.slice(0, body)}${addition}\n${html.slice(body)}`;
+}
+//# sourceMappingURL=prerender.js.map

package/lib/seo/vite/prerender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prerender.js","sourceRoot":"","sources":["../../../src/seo/vite/prerender.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKnD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EACL,aAAa,EACb,SAAS,EACT,UAAU,EACV,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAsC9B;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAyB;IACzD,MAAM,EACJ,IAAI,EACJ,MAAM,EACN,MAAM,EACN,MAAM,GAAG,EAAE,EACX,QAAQ,EACR,eAAe,EACf,QAAQ,GAAG,IAAI,GAChB,GAAG,OAAO,CAAC;IACZ,IAAI,GAAG,GAAG,MAAM,CAAC;IACjB,IAAI,MAAM,GAAkB,IAAI,CAAC;IAEjC,OAAO;QACL,IAAI,EAAE,oBAAoB;QAC1B,KAAK,EAAE,OAAO;QAEd,cAAc,CAAC,MAAM;YACnB,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QACzB,CAAC;QAED,kBAAkB,EAAE;YAClB,KAAK,EAAE,MAAM;YACb,OAAO,CAAC,IAAI;gBACV,IAAI,IAAI,GAAG,IAAI,CAAC;gBAChB,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;oBACvB,IAAI,GAAG,mBAAmB,CACxB,IAAI,EACJ,oBAAoB,CAAC;wBACnB,IAAI;wBACJ,MAAM;wBACN,MAAM;wBACN,QAAQ;wBACR,eAAe;qBAChB,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,IAAI,GAAG,mBAAmB,CACxB,IAAI,EACJ,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CACxC,CAAC;gBACJ,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF;QAED,WAAW;YACT,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;YAE5D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,IAAI,GACR,KAAK,CAAC,IAAI,KAAK,GAAG;oBAChB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC;oBACzB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;gBACnD,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,aAAa,CACX,IAAI,EACJ,cAAc,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CACjE,CAAC;YACJ,CAAC;YAED,aAAa,CACX,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,EACxB,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CACrC,CAAC;YACF,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBACrB,aAAa,CACX,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,EACvB,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,CAC5C,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,IAAI,CACV,GAAG,MAAM,CAAC,MAAM,+CAA+C,CAChE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAY,EAAE,QAAgB;IACzD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACzC,IAAI,IAAI,KAAK,CAAC,CAAC;QAAE,OAAO,GAAG,IAAI,KAAK,QAAQ,IAAI,CAAC;IACjD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;AAClE,CAAC"}

package/lib/vite.d.ts

@@ -0,0 +1,2 @@
+export * from './seo/vite/index.ts';
+//# sourceMappingURL=vite.d.ts.map

package/lib/vite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.d.ts","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/lib/vite.js

@@ -0,0 +1,2 @@
+export * from "./seo/vite/index.js";
+//# sourceMappingURL=vite.js.map

package/lib/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-cheminfo",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "license": "MIT",
   "description": "Assembled React components shared by the cheminfo sites: a Cite button and an ecosystem menu",
   "author": "Luc Patiny",
@@ -16,6 +16,7 @@
     "./orbital": "./lib/orbital.js",
     "./structure": "./lib/structure.js",
     "./ui": "./lib/ui.js",
+    "./vite": "./lib/vite.js",
     "./styles/*.css": "./styles/*.css"
   },
   "files": [
@@ -76,7 +77,8 @@
     "react": "^18.3.1 || >=19",
     "react-dom": "^18.3.1 || >=19",
     "react-ocl": "^8.7.1",
-    "react-science": "^20.6.2 || ^21.0.0 || ^22.0.0 || ^23.0.0"
+    "react-science": "^20.6.2 || ^21.0.0 || ^22.0.0 || ^23.0.0",
+    "vite": "^7.0.0 || ^8.0.0"
   },
   "repository": {
     "type": "git",
@@ -95,6 +97,9 @@
     },
     "react-ocl": {
       "optional": true
+    },
+    "vite": {
+      "optional": true
     }
   }
 }

package/src/ecosystem/core/index.ts

@@ -1,5 +1,5 @@
 export { renderEcosystemLinksHtml } from './links.ts';
-export { findSiteByHost, siteById } from './lookup.ts';
+export { findSiteByHost, siteById, siteDisplayName } from './lookup.ts';
 export type {
   EcosystemSite,
   SiteId,

package/src/ecosystem/core/lookup.ts

@@ -14,6 +14,22 @@ export function siteById(id: SiteId): EcosystemSite {
   throw new Error(`unknown ecosystem site: ${id}`);
 }
 
+/**
+ * The site's name as prose, for a page title, a card or a citation.
+ *
+ * An address-shaped name is written as the address it is — `3d` and `cheminfo`
+ * are two halves of `3d.cheminfo.org`, and joining them would read `3dcheminfo`
+ * — while a product-shaped one is its two halves run together, as its wordmark
+ * sets them.
+ * @param site - The site being named.
+ * @returns What the site is called, in one string.
+ */
+export function siteDisplayName(site: EcosystemSite): string {
+  return site.name.dot === true
+    ? site.host
+    : `${site.name.lead}${site.name.alt}`;
+}
+
 /**
  * The site a page is being served from, so a header can mark itself as the
  * current one without being told which site it belongs to.

package/src/ecosystem/core/sites.ts

@@ -14,7 +14,7 @@ export type SiteId =
   | 'equilibrium'
   | 'polycarp'
   | '3d'
-  | 'pt';
+  | 'periodic-table';
 
 export interface SiteName {
   /** First half of the name, set in the site's leading colour. */
@@ -210,10 +210,10 @@ export const ECOSYSTEM_SITES: readonly EcosystemSite[] = [
     mark: { plate: '#155e75', accent: '#f97316' },
   },
   {
-    id: 'pt',
-    name: { lead: 'pt', alt: 'cheminfo', dot: true },
-    host: 'pt.cheminfo.org',
-    repository: 'https://github.com/cheminfo/pt.cheminfo.org',
+    id: 'periodic-table',
+    name: { lead: 'Periodic', alt: 'Table' },
+    host: 'periodic-table.cheminfo.org',
+    repository: 'https://github.com/cheminfo/periodic-table.cheminfo.org',
     tagline: 'The periodic table, coloured, plotted and taken apart.',
     brand: '#15803d',
     brandAlt: '#a16207',

package/src/ecosystem/ui/glyphs.tsx

@@ -214,7 +214,7 @@ export const GLYPHS: Record<SiteId, (alt: string) => ReactNode> = {
   // The stepped corner of the table, with the one cell a visitor has picked
   // carrying the accent — which is what every tool of that site is: the table,
   // and one element read off it.
-  pt: (alt) => (
+  'periodic-table': (alt) => (
     <>
       <g fill="#ffffff" opacity="0.55">
         <rect x="5" y="6" width="5" height="5" rx="1" />

package/src/seo/core/index.ts

@@ -4,3 +4,23 @@ export {
   documentTitle,
   writeDocumentMeta,
 } from './documentMeta.ts';
+export type { PageMetaOptions } from './pageMeta.ts';
+export {
+  injectPageMeta,
+  insertBeforeHeadEnd,
+  pageDocumentMeta,
+} from './pageMeta.ts';
+export type { RouteMeta } from './routes.ts';
+export {
+  homeRoute,
+  pageMetaFor,
+  routeFor,
+  trimTrailingSlash,
+} from './routes.ts';
+export type { SiteFilesOptions, StructuredDataOptions } from './siteFiles.ts';
+export {
+  noscriptIndex,
+  robotsTxt,
+  sitemapXml,
+  structuredDataScript,
+} from './siteFiles.ts';

package/src/seo/core/pageMeta.ts

@@ -0,0 +1,127 @@
+/**
+ * The head of the page a crawler is handed.
+ *
+ * Googlebot renders JavaScript, but Bing, a Slack unfurl, an LMS preview and
+ * every academic indexer read the HTML that came off the wire — so the title,
+ * the description and the canonical of a page must already be in it. A site
+ * with a server rewrites them per request; a static one writes one file per
+ * address at build time. Both call this, which is pure string work: no
+ * `window`, no `node:fs`.
+ */
+
+import { siteById, siteDisplayName } from '../../ecosystem/core/lookup.ts';
+import type { EcosystemSite, SiteId } from '../../ecosystem/core/sites.ts';
+import { escapeAttribute, escapeText } from '../../share/core/escape.ts';
+
+import type { DocumentMeta } from './documentMeta.ts';
+import type { RouteMeta } from './routes.ts';
+import { pageMetaFor, trimTrailingSlash } from './routes.ts';
+
+/** Which site is being served, and what it answers. */
+export interface PageMetaOptions {
+  /** The site, named or passed. */
+  site: EcosystemSite | SiteId;
+  /** Every address it answers, each with its title and description. */
+  routes: readonly RouteMeta[];
+  /** The address being written, query string included. */
+  url: string;
+  /**
+   * Origin every absolute address is built on. A server passes the one the
+   * request arrived on; a build leaves it out and the site's own host is used.
+   * @default `https://<the site's host>`
+   */
+  origin?: string;
+  /**
+   * The card a link to the page unfurls into, as an absolute address or a path.
+   * @default '/og.png'
+   */
+  image?: string;
+}
+
+/**
+ * Give a page the title, the description and the canonical address of the route
+ * it answers, plus the card a link to it unfurls into.
+ * @param html - The built page.
+ * @param options - Which site, which address, and where it is served from.
+ * @returns The page, with its head rewritten for that route.
+ */
+export function injectPageMeta(html: string, options: PageMetaOptions): string {
+  const site = resolveSite(options.site);
+  const meta = pageMetaFor(options.routes, options.url);
+  const name = siteDisplayName(site);
+  const origin = trimTrailingSlash(options.origin ?? `https://${site.host}`);
+  const { title, canonical } = pageDocumentMeta(options);
+  const image = absolute(options.image ?? '/og.png', origin);
+
+  const head = [
+    `<link rel="canonical" href="${escapeAttribute(canonical)}" />`,
+    '<meta property="og:type" content="website" />',
+    `<meta property="og:site_name" content="${escapeAttribute(name)}" />`,
+    `<meta property="og:title" content="${escapeAttribute(title)}" />`,
+    `<meta property="og:description" content="${escapeAttribute(meta.description)}" />`,
+    `<meta property="og:url" content="${escapeAttribute(canonical)}" />`,
+    `<meta property="og:image" content="${escapeAttribute(image)}" />`,
+    '<meta name="twitter:card" content="summary_large_image" />',
+  ].join('\n');
+
+  return insertBeforeHeadEnd(
+    replaceDescription(replaceTitle(html, title), meta.description),
+    head,
+  );
+}
+
+/**
+ * What the page on screen is called and where it is indexed, for the app to
+ * write after an in-app move.
+ *
+ * The same title and canonical the build wrote into the file it served, so a
+ * click that changes the page cannot disagree with the page a crawler fetched.
+ * @param options - Which site, which address, and where it is served from.
+ * @returns The title, the description and the canonical of that address.
+ */
+export function pageDocumentMeta(options: PageMetaOptions): Required<DocumentMeta> {
+  const site = resolveSite(options.site);
+  const meta = pageMetaFor(options.routes, options.url);
+  const origin = trimTrailingSlash(options.origin ?? `https://${site.host}`);
+  return {
+    title: `${meta.title} — ${siteDisplayName(site)}`,
+    description: meta.description,
+    canonical: `${origin}${meta.path}`,
+  };
+}
+
+/**
+ * Put an addition at the end of the head, where a tracking snippet and a
+ * structured-data block both belong.
+ * @param html - The page.
+ * @param addition - The markup to add, taken as written.
+ * @returns The page, with the addition before `</head>`.
+ */
+export function insertBeforeHeadEnd(html: string, addition: string): string {
+  const head = html.lastIndexOf('</head>');
+  if (head === -1) return `${html}\n${addition}\n`;
+  return `${html.slice(0, head)}${addition}\n${html.slice(head)}`;
+}
+
+function resolveSite(site: EcosystemSite | SiteId): EcosystemSite {
+  return typeof site === 'string' ? siteById(site) : site;
+}
+
+function absolute(target: string, origin: string): string {
+  return target.startsWith('/') ? `${origin}${target}` : target;
+}
+
+function replaceTitle(html: string, title: string): string {
+  const replacement = `<title>${escapeText(title)}</title>`;
+  return html.includes('<title>')
+    ? html.replace(/<title>[\s\S]*?<\/title>/, replacement)
+    : insertBeforeHeadEnd(html, replacement);
+}
+
+function replaceDescription(html: string, description: string): string {
+  const replacement = `<meta name="description" content="${escapeAttribute(description)}" />`;
+  const existing = /<meta[^>]*name="description"[^>]*>/;
+  return existing.test(html)
+    ? html.replace(existing, replacement)
+    : insertBeforeHeadEnd(html, replacement);
+}