@dogsbay/format-astro 0.2.0-beta.144 → 0.2.0-beta.145

package/dist/canonical.d.ts

@@ -7,7 +7,7 @@
  * plans/canonical-versions.md, step 2.
  */
 import type { ExportPage } from "@dogsbay/types";
-import { type VersionSeo } from "@dogsbay/site-files";
+import { type ProductModel, type VersionSeo } from "@dogsbay/site-files";
 export interface CanonicalPlanOptions {
     /** Pages the build does not emit (fragments, `excludeFromRoutes`): never a canonical target. */
     isEmitted?: (page: ExportPage) => boolean;
@@ -18,6 +18,8 @@ export interface CanonicalPlanOptions {
         id: string;
     } & VersionSeo>;
     defaultVersion?: string;
+    /** With a `products:` block: each product's own versions and default replace `versions`/`defaultVersion`. */
+    products?: ProductModel;
     redirects?: Record<string, string | {
         to: string;
         status?: number;

package/dist/canonical.js

@@ -1,4 +1,4 @@
-import { decideCanonical } from "@dogsbay/site-files";
+import { decideCanonical, productDefault } from "@dogsbay/site-files";
 import { normalizePrefix, originOf, pageHref } from "./sitemap.js";
 import { inPageUnit, pageUnitPrefix } from "./redirects.js";
 const URL_RE = /^[a-z][a-z0-9+.-]*:/i;
@@ -60,27 +60,31 @@ export function canonicalPlan(pages, o) {
             return s;
         return s.endsWith("/" + inV) ? s.slice(0, -inV.length - 1) : s === inV ? "" : s;
     };
+    // The page's product's versions and default (the site-wide ones without a products: block).
+    const axisOf = (p) => o.products ? productDefault(o.products, p.multiSource?.namespace) ?? {} : { versions: o.versions, defaultVersion: o.defaultVersion };
     const defaults = new Map();
-    if (o.defaultVersion) {
+    {
         for (const p of pages) {
-            if (p.multiSource?.version !== o.defaultVersion || !live(p))
+            const dv = axisOf(p).defaultVersion;
+            if (!dv || p.multiSource?.version !== dv || !live(p))
                 continue;
             const g = defaults.get(group(p)) ?? { prefix: prefixOf(p), pages: new Map() };
             g.pages.set(inVersion(p), slugOf(p));
             defaults.set(group(p), g);
         }
     }
-    const hasOlder = pages.some((p) => p.multiSource?.version && p.multiSource.version !== o.defaultVersion);
+    const hasOlder = pages.some((p) => p.multiSource?.version && p.multiSource.version !== axisOf(p).defaultVersion);
     const url = (slug) => (origin ? `${origin}${pageHref(slug, prefix)}` : undefined);
     for (const p of pages) {
         if (!live(p))
             continue;
-        const version = o.versions?.find((v) => v.id === p.multiSource?.version);
+        const axis = axisOf(p);
+        const version = axis.versions?.find((v) => v.id === p.multiSource?.version);
         const table = defaults.get(group(p));
         const fm = typeof p.frontmatter?.canonicalUrl === "string" ? p.frontmatter.canonicalUrl : undefined;
         const d = decideCanonical({
             selfUrl: url(slugOf(p)),
-            isDefault: !hasOlder || !p.multiSource?.version || p.multiSource.version === o.defaultVersion || !table,
+            isDefault: !hasOlder || !p.multiSource?.version || p.multiSource.version === axis.defaultVersion || !table,
             path: inVersion(p),
             version,
             frontmatter: fm,

package/dist/index.d.ts

@@ -31,5 +31,6 @@ export type { DiffMarks } from "./diff-decoration.js";
  */
 export { BOOK_SEGMENT, assembleBook, bookHeading, bookSlugFrom, estimateTreeBytes, openAsPageNode, rewriteIntraBookLinks, shiftHeadings, slugFromHref, } from "./granularity.js";
 export type { AssembleBookOptions, BookView } from "./granularity.js";
-export { pageUnitPrefix, inPageUnit, normalizeTarget } from "./redirects.js";
+export { pageUnitPrefix, inPageUnit, normalizeTarget, collectRedirects } from "./redirects.js";
+export { canonicalPlan } from "./canonical.js";
 export { TONES, CARD_TONE_CLASSES, TAB_VARIANTS, THEME_SCOPES } from "./tone-classes.js";

package/dist/index.js

@@ -59,6 +59,7 @@ export { DIFF_CSS, decorateDiff, diffMarksOf, hasDiffMarks, injectAttrs, inlineS
  * See plans/granularity-views.md and docs/single-page-view.md.
  */
 export { BOOK_SEGMENT, assembleBook, bookHeading, bookSlugFrom, estimateTreeBytes, openAsPageNode, rewriteIntraBookLinks, shiftHeadings, slugFromHref, } from "./granularity.js";
-export { pageUnitPrefix, inPageUnit, normalizeTarget } from "./redirects.js";
+export { pageUnitPrefix, inPageUnit, normalizeTarget, collectRedirects } from "./redirects.js";
+export { canonicalPlan } from "./canonical.js";
 // Variants, tones and scoped themes: the class tables both renderers draw from
 export { TONES, CARD_TONE_CLASSES, TAB_VARIANTS, THEME_SCOPES } from "./tone-classes.js";

package/dist/project.d.ts

@@ -1,4 +1,5 @@
 import type { ExportPage, NavItem } from "@dogsbay/types";
+import { type ProductModel } from "@dogsbay/site-files";
 import { type BlogEmitConfig } from "./blog.js";
 import { type RedirectsConfig } from "./redirects.js";
 /**
@@ -197,6 +198,14 @@ export interface AstroProjectOptions {
      * default (enforced at config load).
      */
     defaultVersion?: string;
+    /**
+     * With a `products:` block: the model from @dogsbay/site-files
+     * (`productModel`). Each product's own versions and default then drive
+     * canonicals, the version switcher (`productVersions`), the forward from
+     * a product's root to its default version, and the data files
+     * `_dogsbay/versions.js` and `<unit home>_dogsbay/pages.js`.
+     */
+    products?: ProductModel;
     /**
      * Declared locales for the i18n axis. Same role as
      * `versions` for the locale axis.
@@ -601,6 +610,20 @@ export interface SwitcherMap {
      * the full URL plus the (locale, version) combo it represents.
      */
     byLogicalKey: Record<string, SwitcherVariant[]>;
+    /**
+     * With a `products:` block: each product's version rows per locale, keyed
+     * `<product|_>/<locale|_>`, in config order, hidden versions left out, each
+     * with its home URL (where the row goes when the page is not in it). The
+     * version switcher uses these instead of `versions`.
+     */
+    productVersions?: Record<string, Array<{
+        id: string;
+        label?: string;
+        eol?: boolean;
+        prerelease?: boolean;
+        default?: boolean;
+        home: string;
+    }>>;
 }
 export interface SwitcherVariant {
     /** Present when the locale axis is active for this site. */

package/dist/project.js

@@ -30,6 +30,7 @@ import { buildSitemapFiles, buildSitemapIndex } from "./sitemap.js";
 import { canonicalPlan } from "./canonical.js";
 import { headMetadata } from "./head-metadata.js";
 import { buildHeadersFile, buildRobotsTxt as buildRobotsTxtFile } from "@dogsbay/site-files";
+import { productRootRedirects, siteFiles, siteRootTarget, switcher as productSwitcherRows, toPagesScript, toScript, unitKeyString, unitManifest, unitOf, } from "@dogsbay/site-files";
 import { assembleBook, estimateTreeBytes } from "./granularity.js";
 /**
  * The per-topic "Read as single page" affordance (granularity book view).
@@ -1776,6 +1777,7 @@ export async function emitAstroPages(pages, nav, outputDir, options) {
         basePath: combined,
         versions: options.versions,
         defaultVersion: options.defaultVersion,
+        products: options.products,
         redirects: options.redirects,
     });
     // hreflang alternates, WebSite on home pages, BreadcrumbList from the nav (src/head-metadata.ts).
@@ -2348,13 +2350,16 @@ export async function emitAstroPages(pages, nav, outputDir, options) {
     // With the default version at the root (`path: ""`) and no locale or
     // namespace, it has no subtree: its entries are the ones outside every
     // other version's subtree.
-    const firstHref = (defaultVersionPrefixes.length > 0
-        ? findFirstNavHrefUnder(outputNav, defaultVersionPrefixes, [...subtreeRoots]
-            .filter(([q]) => defaultVersionPrefixes.some((d) => `${combined}/${q}`.startsWith(`${d}/`)))
-            .map(([q]) => `${combined}/${q}`))
-        : rootVersion && subtreeRoots.size > 0
-            ? findFirstNavHrefUnder(outputNav, [combined], nestedIn(""))
-            : undefined) ?? findFirstNavHref(outputNav, basePath);
+    // With products and no unnamed source, `/` goes to the first product's default home (site-files siteRootTarget).
+    const productRoot = options.products ? siteRootTarget(options.products) : undefined;
+    const firstHref = productRoot !== undefined ? `${combined}${productRoot}` :
+        (defaultVersionPrefixes.length > 0
+            ? findFirstNavHrefUnder(outputNav, defaultVersionPrefixes, [...subtreeRoots]
+                .filter(([q]) => defaultVersionPrefixes.some((d) => `${combined}/${q}`.startsWith(`${d}/`)))
+                .map(([q]) => `${combined}/${q}`))
+            : rootVersion && subtreeRoots.size > 0
+                ? findFirstNavHrefUnder(outputNav, [combined], nestedIn(""))
+                : undefined) ?? findFirstNavHref(outputNav, basePath);
     const needsRootRedirect = basePath !== "" ||
         (!section && !rootIndexEmitted && firstHref !== "");
     if (needsRootRedirect) {
@@ -2457,7 +2462,10 @@ function emitRedirects(outputDir, options, pages) {
             // Front matter paths are relative to the page's language and version (#096): collectRedirects needs its original slug.
             multiSource: p.multiSource,
         })),
-        config: options.redirects,
+        // A product's root forwards to its default version's home; a redirect the config gives for it wins.
+        config: options.products
+            ? { ...Object.fromEntries(productRootRedirects(options.products)), ...options.redirects }
+            : options.redirects,
         prefix,
     });
     if (errors.length > 0) {
@@ -2572,7 +2580,7 @@ export function emitSwitcherMap(pages, outputDir, options) {
     }
     const versionAxisActive = versionsSeen.size >= 2;
     const localeAxisActive = localesSeen.size >= 2;
-    if (!versionAxisActive && !localeAxisActive) {
+    if (!versionAxisActive && !localeAxisActive && !options.products) {
         mkdirSync(dataDir, { recursive: true });
         writeFileSync(outPath, JSON.stringify({ versions: [], locales: [], byLogicalKey: {} }, null, 2));
         return;
@@ -2601,9 +2609,73 @@ export function emitSwitcherMap(pages, outputDir, options) {
         byLogicalKey[key].push(variant);
     }
     const data = { versions, locales, byLogicalKey };
+    if (options.products) {
+        data.productVersions = productVersionRows(options.products, combined);
+        emitProductDataFiles(pages, outputDir, options, options.products);
+    }
     mkdirSync(dataDir, { recursive: true });
     writeFileSync(outPath, JSON.stringify(data, null, 2));
 }
+/** Each product's switcher rows per locale (`<product|_>/<locale|_>`), with full home URLs. */
+function productVersionRows(model, combined) {
+    const out = {};
+    const locales = model.localeAxis ? [...new Set(model.units.map((u) => u.locale))] : [undefined];
+    for (const p of model.products) {
+        if (!p.versions.length)
+            continue;
+        for (const l of locales) {
+            const rows = productSwitcherRows(model, p.name, l);
+            if (!rows.length)
+                continue;
+            out[`${p.name ?? "_"}/${l ?? "_"}`] = rows.map((r) => ({
+                id: r.id,
+                label: r.label,
+                ...(r.eol ? { eol: true } : {}),
+                ...(r.prerelease ? { prerelease: true } : {}),
+                ...(r.isDefault ? { default: true } : {}),
+                home: `${combined}${r.home}`,
+            }));
+        }
+    }
+    return out;
+}
+/**
+ * The data files dogsbay-ssg writes too (@dogsbay/site-files products.ts):
+ * `_dogsbay/versions.js` (+ `.json`), the switchers and product switcher every
+ * page can load, and each unit's page list in its own folder,
+ * `<home>_dogsbay/pages.js`. Scripts, so they also work from `file://`.
+ */
+function emitProductDataFiles(pages, outputDir, options, model) {
+    const publicDir = join(outputDir, "public", ...basePathSegments(normalizeBasePath(options.basePath)));
+    const byUnit = new Map();
+    for (const page of pages) {
+        const ms = page.multiSource;
+        if (!ms || page.redirect || page.fragment === true)
+            continue;
+        const key = unitKeyString({ ...(ms.namespace ? { product: ms.namespace } : {}), ...(ms.locale ? { locale: ms.locale } : {}), ...(ms.version ? { version: ms.version } : {}) });
+        const list = byUnit.get(key) ?? [];
+        list.push(ms.originalSlug.replace(/^\/+|\/+$/g, "").replace(/(^|\/)index$/, ""));
+        byUnit.set(key, list);
+    }
+    const built = new Set(model.units.map(unitKeyString));
+    const manifests = [...byUnit.entries()]
+        .filter(([key]) => built.has(key))
+        .map(([key, list]) => {
+        const [product, locale, version] = key.split("/").map((x) => (x === "_" ? undefined : x));
+        return unitManifest({ ...(product ? { product } : {}), ...(locale ? { locale } : {}), ...(version ? { version } : {}) }, { pages: [...new Set(list)].sort(), sitemap: [], redirects: [] });
+    });
+    const files = siteFiles(model, manifests);
+    const dataDir = join(publicDir, "_dogsbay");
+    mkdirSync(dataDir, { recursive: true });
+    writeFileSync(join(dataDir, "versions.js"), toScript("__DOGSBAY_VERSIONS__", files.versions));
+    writeFileSync(join(dataDir, "versions.json"), JSON.stringify(files.versions));
+    for (const m of manifests) {
+        const unit = unitOf(model, { ...(m.product ? { product: m.product } : {}), ...(m.locale ? { locale: m.locale } : {}), ...(m.version ? { version: m.version } : {}) });
+        const dest = join(publicDir, ...unit.segments, "_dogsbay", "pages.js");
+        mkdirSync(dirname(dest), { recursive: true });
+        writeFileSync(dest, toPagesScript(unit.home, m.pages));
+    }
+}
 /**
  * Compose a switcherMap axis header from declared entries +
  * the set of ids actually seen in pages. Honours declared
@@ -3163,6 +3235,7 @@ function emitSitemapFiles(outputDir, options, pages) {
         basePath: combined,
         versions: options.versions,
         defaultVersion: options.defaultVersion,
+        products: options.products,
         redirects: options.redirects,
     });
     // More than one file past 50,000 URLs, the protocol's limit per file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/format-astro",
-  "version": "0.2.0-beta.144",
+  "version": "0.2.0-beta.145",
   "description": "Astro format plugin for Dogsbay — export TreeNode[] to Astro component markup",
   "type": "module",
   "main": "dist/index.js",
@@ -32,12 +32,12 @@
   "license": "MIT",
   "dependencies": {
     "markdown-it": "^14.3.0",
-    "@dogsbay/format-dogsbay-md": "0.2.0-beta.144",
-    "@dogsbay/render-html": "0.2.0-beta.144",
-    "@dogsbay/serialize-core": "0.2.0-beta.144",
-    "@dogsbay/site-files": "0.2.0-beta.144",
-    "@dogsbay/types": "0.2.0-beta.144",
-    "@dogsbay/ui": "0.2.0-beta.144"
+    "@dogsbay/format-dogsbay-md": "0.2.0-beta.145",
+    "@dogsbay/serialize-core": "0.2.0-beta.145",
+    "@dogsbay/render-html": "0.2.0-beta.145",
+    "@dogsbay/site-files": "0.2.0-beta.145",
+    "@dogsbay/ui": "0.2.0-beta.145",
+    "@dogsbay/types": "0.2.0-beta.145"
   },
   "repository": {
     "type": "git",