@dogsbay/ssg 0.2.0-beta.149 → 0.2.0-beta.151.1

package/dist/package/types/core/config.d.ts

@@ -1,4 +1,4 @@
-import { type ProductModel } from "@dogsbay/site-files";
+import { type SiteChrome, type ProductModel } from "@dogsbay/site-files";
 export type LinkStyle = "html" | "pretty";
 export type TocMode = "top" | "popover" | "rail" | "off";
 export interface VersionDef {
@@ -99,7 +99,15 @@ export interface SiteConfig {
     basePath: string;
     repoUrl?: string;
     editUri?: string;
+    /** Inline Markdown (site-files `inlineMarkdownHtml`), as `chrome.copyright`. */
     copyright?: string;
+    /**
+     * The site's chrome, read and checked by site-files `siteChrome` for both pipelines: the logo,
+     * the first-visit colour mode, the announcement bar, header links and icons, footer columns and
+     * icons (`site.logo`, `site.colorMode`, `site.announcement`, `header:`, `footer:`). Its
+     * `warnings` are reported by the build. plans/site-chrome.md.
+     */
+    chrome: SiteChrome;
     linkStyle: LinkStyle;
     attributes: Record<string, unknown>;
     sources: SourceDef[];
@@ -372,8 +380,8 @@ export declare function projectPath(unit: BuildUnit, path: string): string;
 export declare const TOPIC_MAP: RegExp;
 /**
  * The project folders and files a build reads: every source's root, the theme folder, extra
- * stylesheets, the folder of each source's own nav file (a topic map's includes sit beside it), and
- * the data folders (the site's, and any source's own; one that does not exist is not read).
+ * stylesheets, the folder of each source's own nav file (a topic map's includes sit beside it), the
+ * data folders (the site's, and any source's own; one that does not exist is not read), and the logo files.
  * [""] when a source is the whole project. What the CLI reads from disk, and a dev session watches.
  */
 export declare function projectRoots(cfg: SiteConfig): string[];

package/dist/package/types/core/icon-notices.d.ts

@@ -0,0 +1,9 @@
+/** An Iconify set name as a unit manifest may record it (the `icon-notices` table's keys are of this shape). */
+export declare const ICON_SET_NAME: RegExp;
+/**
+ * THIRD-PARTY-NOTICES.txt's section for the Iconify sets the pages drew from (`sets`, prefixes), or
+ * undefined when there is none to list. Lucide and MDI are listed with render-html's built-in icons in
+ * every site already. Pure, so a one-unit build lists the sets its stored units recorded too
+ * (plans/unit-publishing.md).
+ */
+export declare function iconSetNotices(sets: Iterable<string>): string | undefined;

package/dist/package/types/core/links.d.ts

@@ -44,3 +44,11 @@ export declare function createResolver(table: LinkTable, page: {
     source: string;
     out: string;
 }): LinkResolver;
+/**
+ * A versionMenu or site chrome link as a page writes it: an http(s) address as is; a site path from the page's
+ * site root (a leading `basePath` dropped, as redirects do), `/x/` as `x/index.html` and `/x` as
+ * `x.html` (a folder's index needs the slash), with pretty links as the site serves them (`x/`, `x`).
+ * A file (`.pdf`, `.html`, MENU_FILE) is kept. At the site root the link starts with `./`, so
+ * nothing in the path can read as a scheme.
+ */
+export declare function menuHref(href: string, siteRoot: string, style: LinkStyle, basePath?: string): string;

package/dist/package/types/core/site-files.d.ts

@@ -117,5 +117,11 @@ export declare function splitSuffix(raw: string): {
 export declare function stubFile(rule: RedirectRule): string;
 /** A meta-refresh page, as `renderMetaRefreshPage`, with a relative target so it works from disk. */
 export declare function renderRedirectPage(rule: RedirectRule, cfg: SiteConfig): string;
+/** A rule as the site serves it: `from` and `to` with the base path, `to` as its page is served. */
+export declare function servedRedirect(r: RedirectRule, cfg: SiteConfig): {
+    from: string;
+    to: string;
+    status: number;
+};
 /** _redirects (Cloudflare), as `renderRedirectsFile`, with served paths. */
 export declare function renderRedirectsFile(rules: RedirectRule[], cfg: SiteConfig): string;

package/dist/package/types/core/unit-manifest.d.ts

@@ -0,0 +1,74 @@
+/**
+ * A manifest per unit (plans/unit-publishing.md): what each unit's build leaves for the site-wide
+ * files, so one product, version or language can be built and published on its own and the
+ * `_redirects`, sitemap index and root forwards still cover every unit. The format is
+ * @dogsbay/site-files' `UnitManifest` (shared with the Dogsbay CLI), with our own `ssg` section.
+ * Written at `_dogsbay/units/<unitKeyString>.json` on sites with two or more units. Pure: the CLI
+ * and the Worker read the files and hand them to `build()` as `BuildInput.manifests`.
+ */
+import { type UnitManifest } from "@dogsbay/site-files";
+import type { BuildUnit } from "./config.js";
+import type { RedirectInput } from "./site-files.js";
+/** What a unit's build records for the next one-unit build or assemble. */
+export interface SsgUnitData {
+    /** The unit's folder in the site ("" at the root). */
+    prefix: string;
+    /** Its redirects before they are resolved (front matter and aliases; config redirects come from the config). */
+    redirectInputs: RedirectInput[];
+    /** `[site path, output file]` of its pages, so other units' redirects resolve against them. */
+    pageOut: Array<[string, string]>;
+    /** Its sitemap files, for the sitemap index. */
+    sitemaps: string[];
+    /** The page its home forwards to, when it has no home page. */
+    homeForward?: string;
+    /** Every file it wrote, so the next publish of the unit can remove the ones it no longer writes. */
+    files: string[];
+    /** The client file its pages load (`_dogsbay/assets/<client>`). */
+    client: string;
+    /** The dogsbay-ssg version that built it. */
+    builder: string;
+    /** A page rendered math: the site keeps KaTeX's files and its notice. */
+    math?: boolean;
+    /** The Iconify sets its pages drew from, for THIRD-PARTY-NOTICES.txt (may list sets an earlier unit of the same build used). */
+    iconSets?: string[];
+}
+export type SsgUnitManifest = UnitManifest & {
+    ssg: SsgUnitData;
+};
+/** The unit's key, as site-files names a unit (`calico/_/3.32`). */
+export declare function unitKey(u: Pick<BuildUnit, "product" | "locale" | "version">): string;
+/** Where a unit's manifest is written, from the site root. */
+export declare function manifestPath(u: Pick<BuildUnit, "product" | "locale" | "version">): string;
+/** The folder the manifests sit in, from the site root. */
+export declare const MANIFEST_DIR = "_dogsbay/units/";
+export declare function makeManifest(u: BuildUnit, ssg: SsgUnitData, redirects: Array<[string, string, number]>): SsgUnitManifest;
+/**
+ * A manifest read back (JSON text or a parsed value), checked: undefined, with a reason, when it is
+ * not one this build can use (another format, or written by something other than dogsbay-ssg).
+ */
+export declare function parseManifest(raw: unknown): {
+    manifest?: SsgUnitManifest;
+    problem?: string;
+};
+/** The hashed client files (`dogsbay-<hash>.js`, in `_dogsbay/assets/`) an update removes when no unit loads them. */
+export declare const CLIENT_PATTERN: RegExp;
+/** What removing stale files needs of a manifest. */
+export interface UnitFiles {
+    prefix: string;
+    files: string[];
+    client: string;
+}
+/** A manifest's `UnitFiles`, or null when the text is not a manifest this version can read. */
+export declare function unitFilesOf(text: string): UnitFiles | null;
+/**
+ * After a one-unit update, the files to remove (site paths). `previous` and `now` are the site's
+ * manifests before and after the build, by path (null: unreadable); a unit counts as rebuilt when this
+ * build wrote its manifest (`written` holds every path the build wrote).
+ * - A rebuilt unit's files its previous manifest listed and its new one does not (pages deleted or
+ *   moved), unless this build wrote them, or they are not in that unit's own folder: the unit whose
+ *   prefix is the longest to hold the path (a version at the root holds the others' folders), so a
+ *   manifest can only ever remove files of its own unit.
+ * - The hashed clients in `assets` (file names) no manifest loads any more; none when a manifest
+ *   cannot be read, since its pages may load one.
+ */
+export declare function staleUnitFiles(previous: ReadonlyMap<string, UnitFiles | null>, now: ReadonlyMap<string, UnitFiles | null>, written: ReadonlySet<string>, assets: readonly string[]): string[];

package/dist/package/types/generated/assets.d.ts

@@ -1,4 +1,11 @@
 export declare const CLIENT_JS: string;
+/**
+ * The name the pages load the client by, from its content (_dogsbay/assets/<CLIENT_FILE>): a unit built
+ * by another version of the client keeps loading its own (plans/unit-publishing.md).
+ */
+export declare const CLIENT_FILE: string;
+/** This package's version, recorded in each unit's manifest. */
+export declare const SSG_VERSION: string;
 export declare const THEME_TEMPLATES: Record<string, string>;
 export declare const CLIENT_CANDIDATES: string[];
 /** _dogsbay/assets/THIRD-PARTY-NOTICES.txt: the client's packages and Tailwind (scripts/notices.mjs). */

package/dist/package/types/generated/icon-notices.d.ts

@@ -0,0 +1,2 @@
+/** Each Iconify set's attribution and licence (scripts/notices.mjs iconSetNotice), by prefix. */
+export declare const ICON_SET_NOTICES: Record<string, string>;

package/dist/package/types/theme/compose.d.ts

@@ -89,6 +89,11 @@ export interface PageModel {
     math?: boolean;
     /** The page's front matter, for templates (`page.meta.*`). */
     meta?: Record<string, unknown>;
+    /** The site logo's files as the build wrote them, from the site root (`_dogsbay/site/logo-light.svg`); none without `site.logo` or when it was left out. */
+    logo?: {
+        light: string;
+        dark?: string;
+    };
     /** Search-engine and social metadata; see seo.ts. */
     seo?: Omit<SeoInput, "title" | "siteName" | "description" | "headings" | "tags" | "lastUpdated">;
     t: (k: string) => string;
@@ -100,4 +105,11 @@ export interface PageModel {
  * template can only read plain data.
  */
 export declare function plainData(v: unknown): unknown;
+/**
+ * What a reader's close is stored under (`db-announcement-closed:<key>`): the id after the site's
+ * URL path and base path, as the Astro pipeline writes it (`/docs#launch-2026`), so sites on one
+ * host keep their own. Without either, the site's name: sites published under paths of the Worker,
+ * or opened from disk, share an origin too.
+ */
+export declare function announcementKey(cfg: SiteConfig): string;
 export declare function composePage(p: PageModel, cfg: SiteConfig, templates: ThemeTemplates): Promise<string>;

package/dist/package/types/theme/docs-layout/site-chrome.d.ts

@@ -0,0 +1,52 @@
+/**
+ * The site's chrome as DocsLayout draws it: the `chrome` object format-astro writes into
+ * site.json (its `chromeData`), links already carrying the site's prefix, texts already HTML
+ * (@dogsbay/site-files inline Markdown), icons already SVG. dogsbay-ssg draws the same keys with
+ * its own markup and these classes. See plans/site-chrome.md.
+ */
+export interface SiteChromeLink {
+    label: string;
+    href: string;
+}
+export interface SiteChromeMenu {
+    label: string;
+    items: SiteChromeLink[];
+}
+export interface SiteChromeSocial {
+    label: string;
+    href: string;
+    svg: string;
+}
+export interface SiteChromeData {
+    colorMode?: "light" | "dark" | "system";
+    logo?: {
+        light: string;
+        dark?: string;
+        alt: string;
+        replacesName: boolean;
+    };
+    /** `key` (format-astro): the stored id, with the site's prefix; older site.json files have only `id`. */
+    announcement?: {
+        id: string;
+        key?: string;
+        html: string;
+        tone: string;
+        closeable: boolean;
+    };
+    header?: {
+        links: Array<SiteChromeLink | SiteChromeMenu>;
+        social: SiteChromeSocial[];
+    };
+    footer?: {
+        columns: Array<{
+            title: string;
+            links: SiteChromeLink[];
+        }>;
+        social: SiteChromeSocial[];
+    };
+}
+export declare const isMenu: (l: SiteChromeLink | SiteChromeMenu) => l is SiteChromeMenu;
+/** An http(s) address on another site: opened as the version menu's are, in the same tab, marked external for link icons. */
+export declare const isExternal: (href: string) => boolean;
+/** The announcement's colours by tone: the callout tokens, so the theme and dark mode apply. */
+export declare const ANNOUNCEMENT_TONE_CLASS: Record<string, string>;

package/dist/package/types/theme/regions.d.ts

@@ -1,15 +1,19 @@
 import type { NavNode } from "../core/nav.js";
-/** Icons the region partials place (pager chevrons, the "Powered by" mark). */
+/** Icons the region partials place (pager chevrons, the "Powered by" mark, the header menus' chevron, the announcement's close). */
 export declare const ICONS: {
+    chevronDown: string;
+    close: string;
     chevronLeft: string;
     chevronRight: string;
     layers: string;
 };
 export declare const BOOK_ICON: string;
+/** `links`: the header's links as a list, shown here below lg (DocsLayout's SidebarGroup with HeaderLinks layout="list"). */
 export declare function sidebar(opts: {
     header: string;
     nav: string;
     label: string;
+    links?: string;
 }): string;
 export declare function sidebarTrigger(label: string): string;
 export interface NavOptions {
@@ -52,7 +56,6 @@ export declare function compactNav(nodes: NavNode[], href: (slug: string) => str
 export declare function navSize(nodes: NavNode[]): number;
 export declare function searchButton(label: string): string;
 export declare function themeToggle(label: string): string;
-export declare function repoLink(url: string, label: string): string;
 export interface SwitchOption {
     label: string;
     href: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/ssg",
-  "version": "0.2.0-beta.149",
+  "version": "0.2.0-beta.151.1",
   "type": "module",
   "description": "Documentation static site generator for Dogsbay-MD that builds inside Cloudflare Workers and publishes sites that work offline",
   "license": "Apache-2.0",
@@ -49,38 +49,38 @@
     "tailwindcss": "^4.3.2"
   },
   "peerDependencies": {
-    "@dogsbay/elements": "0.2.0-beta.149",
-    "@dogsbay/format-dogsbay-md": "0.2.0-beta.149",
-    "@dogsbay/format-openapi": "0.2.0-beta.149",
-    "@dogsbay/format-topicmap": "0.2.0-beta.149",
-    "@dogsbay/highlight": "0.2.0-beta.149",
-    "@dogsbay/minja": "0.2.0-beta.149",
-    "@dogsbay/primitives": "0.2.0-beta.149",
-    "@dogsbay/render-html": "0.2.0-beta.149",
-    "@dogsbay/search": "0.2.0-beta.149",
-    "@dogsbay/serialize-core": "0.2.0-beta.149",
-    "@dogsbay/site-check": "0.2.0-beta.149",
-    "@dogsbay/site-files": "0.2.0-beta.149",
-    "@dogsbay/types": "0.2.0-beta.149"
+    "@dogsbay/elements": "0.2.0-beta.151",
+    "@dogsbay/format-dogsbay-md": "0.2.0-beta.151",
+    "@dogsbay/format-openapi": "0.2.0-beta.151",
+    "@dogsbay/format-topicmap": "0.2.0-beta.151",
+    "@dogsbay/highlight": "0.2.0-beta.151",
+    "@dogsbay/minja": "0.2.0-beta.151",
+    "@dogsbay/primitives": "0.2.0-beta.151",
+    "@dogsbay/render-html": "0.2.0-beta.151",
+    "@dogsbay/search": "0.2.0-beta.151",
+    "@dogsbay/serialize-core": "0.2.0-beta.151",
+    "@dogsbay/site-check": "0.2.0-beta.151",
+    "@dogsbay/site-files": "0.2.0-beta.151",
+    "@dogsbay/types": "0.2.0-beta.151"
   },
   "devDependencies": {
     "@axe-core/playwright": "^4.12.1",
     "@cloudflare/workers-types": "^5.20260921.1",
-    "@dogsbay/elements": "0.2.0-beta.149",
-    "@dogsbay/format-dogsbay-md": "0.2.0-beta.149",
-    "@dogsbay/format-openapi": "0.2.0-beta.149",
-    "@dogsbay/format-topicmap": "0.2.0-beta.149",
-    "@dogsbay/highlight": "0.2.0-beta.149",
-    "@dogsbay/icons": "0.2.0-beta.149",
-    "@dogsbay/minja": "0.2.0-beta.149",
-    "@dogsbay/primitives": "0.2.0-beta.149",
-    "@dogsbay/render-html": "0.2.0-beta.149",
-    "@dogsbay/search": "0.2.0-beta.149",
-    "@dogsbay/serialize-core": "0.2.0-beta.149",
-    "@dogsbay/site-check": "0.2.0-beta.149",
-    "@dogsbay/site-files": "0.2.0-beta.149",
-    "@dogsbay/types": "0.2.0-beta.149",
-    "@dogsbay/ui": "0.2.0-beta.149",
+    "@dogsbay/elements": "0.2.0-beta.151",
+    "@dogsbay/format-dogsbay-md": "0.2.0-beta.151",
+    "@dogsbay/format-openapi": "0.2.0-beta.151",
+    "@dogsbay/format-topicmap": "0.2.0-beta.151",
+    "@dogsbay/highlight": "0.2.0-beta.151",
+    "@dogsbay/icons": "0.2.0-beta.151",
+    "@dogsbay/minja": "0.2.0-beta.151",
+    "@dogsbay/primitives": "0.2.0-beta.151",
+    "@dogsbay/render-html": "0.2.0-beta.151",
+    "@dogsbay/search": "0.2.0-beta.151",
+    "@dogsbay/serialize-core": "0.2.0-beta.151",
+    "@dogsbay/site-check": "0.2.0-beta.151",
+    "@dogsbay/site-files": "0.2.0-beta.151",
+    "@dogsbay/types": "0.2.0-beta.151",
+    "@dogsbay/ui": "0.2.0-beta.151",
     "@mermanjs/web": "0.7.0",
     "@playwright/test": "1.61.1",
     "@types/node": "^22.10.0",