@dogsbay/docs-layout 0.2.0-beta.143 → 0.2.0-beta.145

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/docs-layout",
-  "version": "0.2.0-beta.143",
+  "version": "0.2.0-beta.145",
   "description": "Standard documentation layout components for Dogsbay",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "./json-ld": "./src/json-ld.ts"
   },
   "dependencies": {
-    "@dogsbay/primitives": "0.2.0-beta.143",
-    "@dogsbay/site-files": "0.2.0-beta.143",
-    "@dogsbay/ui": "0.2.0-beta.143"
+    "@dogsbay/primitives": "0.2.0-beta.145",
+    "@dogsbay/site-files": "0.2.0-beta.145",
+    "@dogsbay/ui": "0.2.0-beta.145"
   },
   "devDependencies": {
     "happy-dom": "^20.10.6",

package/src/DocsLayout.astro

@@ -360,6 +360,10 @@ interface Props {
     version?: string;
     locale?: string;
     originalSlug: string;
+    /** With a `products:` block: the version's URL segment (`latest`, or `""` at the product's root). */
+    versionPath?: string;
+    /** With a `products:` block: the product's other versions' URL segments. */
+    siblingVersionPaths?: string[];
   };
   /**
    * Switcher data emitted by format-astro's `emitSwitcherMap`.
@@ -557,7 +561,15 @@ const {
 
 // The version served at the site root (`path: ""`), if any: the sidebar
 // keeps its pages by leaving out the other versions' folders.
-const navRootVersion = rootVersionFilter(switcherMap?.versions);
+// With a products: block the page carries its version's URL segment, which may
+// differ from its id (`latest`); at the product's root (`""`) its menu leaves
+// out the product's other versions' folders.
+const navRootVersion = multiSource?.versionPath !== undefined
+  ? multiSource.versionPath === ""
+    ? { rootVersion: multiSource.version, versionSegments: multiSource.siblingVersionPaths ?? [] }
+    : {}
+  : rootVersionFilter(switcherMap?.versions);
+const navVersion = multiSource?.versionPath ? multiSource.versionPath : multiSource?.version;
 
 // Link icons — classified in CSS by href shape. `data-link-icons`
 // lists which kinds are active; the glyphs ride in CSS custom props
@@ -1070,7 +1082,7 @@ const siteIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16"
                   currentPath={currentPath}
                   basePath={basePath ?? ""}
                   namespace={multiSource?.namespace}
-                  version={multiSource?.version}
+                  version={navVersion}
                   locale={multiSource?.locale}
                   rootVersion={navRootVersion.rootVersion}
                   versionSegments={navRootVersion.versionSegments}
@@ -1086,7 +1098,7 @@ const siteIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16"
                     items={filterNavByAxis(group.items, {
                       basePath: basePath ?? "/docs",
                       namespace: multiSource?.namespace,
-                      version: multiSource?.version,
+                      version: navVersion,
                       locale: multiSource?.locale,
                       ...navRootVersion,
                     })}
@@ -1102,7 +1114,7 @@ const siteIcon = '<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16"
                   items={filterNavByAxis(nav, {
                     basePath: basePath ?? "/docs",
                     namespace: multiSource?.namespace,
-                    version: multiSource?.version,
+                    version: navVersion,
                     locale: multiSource?.locale,
                     ...navRootVersion,
                   })}

package/src/VersionSwitcher.astro

@@ -44,7 +44,7 @@ const currentLabel = currentRow?.entry.label ?? currentRow?.entry.id ?? "Version
     </summary>
     <ul class="absolute right-0 z-50 mt-1 min-w-[10rem] rounded-md border border-border bg-popover p-1 text-sm shadow-md">
       {rows.map((row) => {
-        const href = row.url ?? fallbackLandingUrl(basePath, row.entry.id, row.entry.root === true);
+        const href = row.url ?? row.entry.home ?? fallbackLandingUrl(basePath, row.entry.id, row.entry.root === true);
         const isFallback = row.url === null && !row.isCurrent;
         return (
           <li>

package/src/switcher.ts

@@ -26,6 +26,8 @@ export interface AxisEntry {
    * page is `<basePath>/`, and its per-page URLs come from the variants.
    */
   root?: boolean;
+  /** With a `products:` block: the version's home URL, where the row goes when the page is not in it. */
+  home?: string;
 }
 
 export interface SwitcherVariant {
@@ -38,6 +40,17 @@ export interface SwitcherMap {
   versions: AxisEntry[];
   locales: AxisEntry[];
   byLogicalKey: Record<string, SwitcherVariant[]>;
+  /**
+   * With a `products:` block: each product's version rows per locale
+   * (`<product|_>/<locale|_>`), config order, hidden left out, with homes.
+   */
+  productVersions?: Record<string, AxisEntry[]>;
+}
+
+/** The current page's product version rows, when the site has a `products:` block. */
+export function productVersionEntries(switcherMap: SwitcherMap, ms: MultiSourceMeta): AxisEntry[] | undefined {
+  if (!switcherMap.productVersions) return undefined;
+  return switcherMap.productVersions[`${ms.namespace ?? "_"}/${ms.locale ?? "_"}`] ?? [];
 }
 
 export interface MultiSourceMeta {
@@ -121,6 +134,15 @@ export function buildSwitcherRows(input: BuildRowsInput): SwitcherRow[] {
 
   const variants = switcherMap.byLogicalKey[logicalKeyFor(multiSource)] ?? [];
 
+  // A products: block: the product's own rows, in config order (the shared model's switcher)
+  const productRows = axis === "version" ? productVersionEntries(switcherMap, multiSource) : undefined;
+  if (productRows) {
+    return productRows.map((entry) => {
+      const match = variants.find((v) => v.version === entry.id && (otherCurrent === undefined || v.locale === otherCurrent));
+      return { entry, url: match?.url ?? null, isCurrent: entry.id === currentId };
+    });
+  }
+
   // On a MULTI-PRODUCT (namespace-active) site the declared version list
   // is the UNION across products, but a page's variants are same-namespace
   // (the logical key is namespaced). Scope the version switcher to the
@@ -204,7 +226,7 @@ export function shouldRenderSwitcher(
   multiSource: MultiSourceMeta | undefined,
 ): boolean {
   if (!multiSource) return false;
-  const entries = axis === "version" ? switcherMap.versions : switcherMap.locales;
+  const entries = (axis === "version" ? productVersionEntries(switcherMap, multiSource) : undefined) ?? (axis === "version" ? switcherMap.versions : switcherMap.locales);
   if (entries.length < 2) return false;
   const id = axis === "version" ? multiSource.version : multiSource.locale;
   return id !== undefined;