@tenphi/docs 0.15.0 → 0.17.0

package/README.md

@@ -27,4 +27,4 @@ extraction root.
 
 Most applications should install `@tenphi/cookbook`, which combines this engine
 with the supported Astro/Starlight renderer. This package is useful for custom
-tooling, validation, and alternate renderers. Node.js 22.14 or newer is required.
+tooling, validation, and alternate renderers. Node.js 22.19 or newer is required.

package/dist/config/index.d.ts

@@ -1,4 +1,4 @@
-import { A as NavigationConfig, B as SiteIconConfig, D as HeadConfig, E as EditLinkConfig, G as TypographyPreset, H as ThemePaletteConfig, K as TypographyPresets, M as NavigationPlacement, N as NavigationTab, O as LocaleConfig, P as NormalizedDocsConfig, R as SearchConfig, T as DocsSource, U as ThemeTokenValue, V as ThemeConfig, W as ThemeTokens, _ as DocsConfig, a as ComponentStyleConfig, c as ComponentsConfig, i as COOKBOOK_COMPONENT_SUB_ELEMENTS, j as NavigationItem, k as MarkdownConfig, l as ContentConfig, n as BuildConfig, o as ComponentStyles, r as COOKBOOK_COMPONENT_NAMES, s as ComponentStylesConfig, t as BrandConfig, u as CookbookComponentName, v as DocsDiagnostic, z as SiteConfig } from "../types-B-msp1dH.js";
+import { $ as TypographyPresets, A as LocaleConfig, B as SearchConfig, D as EditLinkConfig, E as DocsSource, F as NavigationTab, G as ThemeFont, H as SiteIconConfig, I as NormalizedDocsConfig, J as ThemePaletteColor, K as ThemeFontFile, M as NavigationConfig, N as NavigationItem, O as HeadConfig, P as NavigationPlacement, Q as TypographyPreset, V as SiteConfig, W as ThemeConfig, X as ThemeTokenValue, Y as ThemePaletteConfig, Z as ThemeTokens, a as COOKBOOK_COMPONENT_SUB_ELEMENTS, c as ComponentStylesConfig, d as CookbookComponentName, i as COOKBOOK_COMPONENT_NAMES, j as MarkdownConfig, k as HeaderLink, l as ComponentsConfig, n as BrandDeclaration, o as ComponentStyleConfig, q as ThemeFonts, r as BuildConfig, s as ComponentStyles, t as BrandConfig, u as ContentConfig, v as DocsConfig, y as DocsDiagnostic } from "../types-C-AgUcAb.js";
 //#region src/config/index.d.ts
 declare class DocsConfigError extends Error {
   readonly diagnostics: DocsDiagnostic[];
@@ -7,8 +7,8 @@ declare class DocsConfigError extends Error {
 declare function validateConfig(config: DocsConfig): DocsDiagnostic[];
 declare function normalizeDocsConfig(config?: DocsConfig): NormalizedDocsConfig;
 declare function defineDocsConfig(config: DocsConfig): DocsConfig;
-/** Compose presets. Objects merge, arrays replace, and styles use Tasty semantics. */
+/** Compose presets. Color roles and fonts replace, other objects merge, and styles use Tasty semantics. */
 declare function mergeDocsConfig(...configs: DocsConfig[]): DocsConfig;
 //#endregion
-export { type BrandConfig, type BuildConfig, COOKBOOK_COMPONENT_NAMES, COOKBOOK_COMPONENT_SUB_ELEMENTS, type ComponentStyleConfig, type ComponentStyles, type ComponentStylesConfig, type ComponentsConfig, type ContentConfig, type CookbookComponentName, type DocsConfig, DocsConfigError, type DocsSource, type EditLinkConfig, type HeadConfig, type LocaleConfig, type MarkdownConfig, type NavigationConfig, type NavigationItem, type NavigationPlacement, type NavigationTab, type NormalizedDocsConfig, type SearchConfig, type SiteConfig, type SiteIconConfig, type ThemeConfig, type ThemePaletteConfig, type ThemeTokenValue, type ThemeTokens, type TypographyPreset, type TypographyPresets, defineDocsConfig, mergeDocsConfig, normalizeDocsConfig, validateConfig };
+export { type BrandConfig, type BrandDeclaration, type BuildConfig, COOKBOOK_COMPONENT_NAMES, COOKBOOK_COMPONENT_SUB_ELEMENTS, type ComponentStyleConfig, type ComponentStyles, type ComponentStylesConfig, type ComponentsConfig, type ContentConfig, type CookbookComponentName, type DocsConfig, DocsConfigError, type DocsSource, type EditLinkConfig, type HeadConfig, type HeaderLink, type LocaleConfig, type MarkdownConfig, type NavigationConfig, type NavigationItem, type NavigationPlacement, type NavigationTab, type NormalizedDocsConfig, type SearchConfig, type SiteConfig, type SiteIconConfig, type ThemeConfig, type ThemeFont, type ThemeFontFile, type ThemeFonts, type ThemePaletteColor, type ThemePaletteConfig, type ThemeTokenValue, type ThemeTokens, type TypographyPreset, type TypographyPresets, defineDocsConfig, mergeDocsConfig, normalizeDocsConfig, validateConfig };
 //# sourceMappingURL=index.d.ts.map

package/dist/config/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/config/index.ts"],"mappings":";;cAyEa,wBAAwB;WAC1B,aAAa;EAEtB,YAAY,aAAa;;iBAOX,eAAe,QAAQ,aAAa;iBA4iBpC,oBACd,SAAQ,aACP;iBA4Ca,iBAAiB,QAAQ,aAAa;;iBAOtC,mBAAmB,SAAS,eAAe"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/config/index.ts"],"mappings":";;cA8Fa,wBAAwB;WAC1B,aAAa;EAEtB,YAAY,aAAa;;iBAOX,eAAe,QAAQ,aAAa;iBA23BpC,oBACd,SAAQ,aACP;iBA4Ca,iBAAiB,QAAQ,aAAa;;iBAOtC,mBAAmB,SAAS,eAAe"}

package/dist/config/index.js

@@ -1,2 +1,2 @@
-import { a as validateConfig, i as normalizeDocsConfig, n as defineDocsConfig, o as COOKBOOK_COMPONENT_NAMES, r as mergeDocsConfig, s as COOKBOOK_COMPONENT_SUB_ELEMENTS, t as DocsConfigError } from "../config-DoR8g9IM.js";
+import { a as validateConfig, i as normalizeDocsConfig, n as defineDocsConfig, o as COOKBOOK_COMPONENT_NAMES, r as mergeDocsConfig, s as COOKBOOK_COMPONENT_SUB_ELEMENTS, t as DocsConfigError } from "../config-Ci9Nv0wQ.js";
 export { COOKBOOK_COMPONENT_NAMES, COOKBOOK_COMPONENT_SUB_ELEMENTS, DocsConfigError, defineDocsConfig, mergeDocsConfig, normalizeDocsConfig, validateConfig };

package/dist/config/schema.json

@@ -15,6 +15,19 @@
         "version": {
           "type": "string"
         },
+        "versions": {
+          "type": "array",
+          "minItems": 2,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["label", "routeBase"],
+            "properties": {
+              "label": { "type": "string", "minLength": 1 },
+              "routeBase": { "type": "string", "pattern": "^/(?!/)" }
+            }
+          }
+        },
         "description": {
           "type": "string"
         },
@@ -48,6 +61,32 @@
               }
             }
           ]
+        },
+        "headerLinks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["label", "link"],
+            "properties": {
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "pattern": "\\S"
+              },
+              "link": {
+                "type": "string",
+                "pattern": "^(?:https?://[^\\s\\\\]+|/(?!/)[^\\s\\\\]*|#[^\\s\\\\]*)$"
+              },
+              "variant": {
+                "enum": ["default", "primary"]
+              },
+              "newTab": {
+                "type": "boolean",
+                "default": false
+              }
+            }
+          }
         }
       }
     },
@@ -153,18 +192,29 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
-        "brand": {},
+        "brand": { "$ref": "#/$defs/brandColor" },
         "palette": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
-            "surface": {},
-            "text": {},
-            "textSoft": {},
-            "info": {},
-            "success": {},
-            "warning": {},
-            "danger": {}
+            "surface": { "$ref": "#/$defs/paletteColor" },
+            "text": { "$ref": "#/$defs/paletteColor" },
+            "textSoft": { "$ref": "#/$defs/paletteColor" },
+            "info": { "$ref": "#/$defs/paletteColor" },
+            "success": { "$ref": "#/$defs/paletteColor" },
+            "warning": { "$ref": "#/$defs/paletteColor" },
+            "danger": { "$ref": "#/$defs/paletteColor" },
+            "header": { "$ref": "#/$defs/paletteColor" },
+            "overlay": { "$ref": "#/$defs/paletteColor" }
+          }
+        },
+        "fonts": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "body": { "$ref": "#/$defs/themeFont" },
+            "heading": { "$ref": "#/$defs/themeFont" },
+            "code": { "$ref": "#/$defs/themeFont" }
           }
         },
         "states": {
@@ -328,6 +378,14 @@
                 }
               }
             },
+            "VersionSwitcher": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
             "Preview": {
               "type": "object",
               "propertyNames": {
@@ -407,6 +465,54 @@
                   "const": "mode"
                 }
               }
+            },
+            "HeaderFrame": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
+            "HeaderLinks": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
+            "Layout": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
+            "SearchButton": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
+            "TableOfContentsLayout": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
+            },
+            "PageFrame": {
+              "type": "object",
+              "propertyNames": {
+                "not": {
+                  "const": "mode"
+                }
+              }
             }
           }
         },
@@ -533,6 +639,207 @@
     }
   },
   "$defs": {
+    "brandColor": {
+      "description": "A Glaze from declaration for the brand seed, optionally with APCA targets. Literal shorthand and structured hue, saturation, and tone are also supported.",
+      "oneOf": [
+        { "$ref": "#/$defs/glazeColorValue" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["from"],
+          "properties": {
+            "from": { "$ref": "#/$defs/glazeColorValue" },
+            "contrast": { "$ref": "#/$defs/brandContrast" },
+            "unsafeContrast": { "type": "boolean" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["hue", "saturation", "tone"],
+          "properties": {
+            "hue": { "type": "number", "minimum": 0, "maximum": 360 },
+            "saturation": { "type": "number", "minimum": 0, "maximum": 100 },
+            "tone": { "type": "number", "minimum": 0, "maximum": 100 },
+            "contrast": { "$ref": "#/$defs/brandContrast" },
+            "unsafeContrast": { "type": "boolean" }
+          }
+        }
+      ]
+    },
+    "brandContrast": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["apca"],
+      "properties": {
+        "apca": {
+          "oneOf": [
+            { "type": "number" },
+            {
+              "type": "array",
+              "prefixItems": [{ "type": "number" }, { "type": "number" }],
+              "minItems": 2,
+              "maxItems": 2
+            }
+          ]
+        }
+      }
+    },
+    "paletteColor": {
+      "description": "A Glaze color declaration; literal colors are convenient seed shorthands.",
+      "oneOf": [
+        { "$ref": "#/$defs/glazeColorValue" },
+        { "$ref": "#/$defs/glazeDeclaration" }
+      ]
+    },
+    "glazeColorValue": {
+      "oneOf": [
+        { "type": "string" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["h", "s", "l"],
+          "properties": {
+            "h": { "type": "number" },
+            "s": { "type": "number" },
+            "l": { "type": "number" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["h", "s", "t"],
+          "properties": {
+            "h": { "type": "number" },
+            "s": { "type": "number" },
+            "t": { "type": "number" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["r", "g", "b"],
+          "properties": {
+            "r": { "type": "number" },
+            "g": { "type": "number" },
+            "b": { "type": "number" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["l", "c", "h"],
+          "properties": {
+            "l": { "type": "number" },
+            "c": { "type": "number" },
+            "h": { "type": "number" }
+          }
+        }
+      ]
+    },
+    "glazeDeclaration": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "from": { "$ref": "#/$defs/glazeColorValue" },
+        "tone": {
+          "oneOf": [
+            { "type": "number", "minimum": 0, "maximum": 100 },
+            { "type": "string" },
+            {
+              "type": "array",
+              "prefixItems": [
+                { "oneOf": [{ "type": "number" }, { "type": "string" }] },
+                { "oneOf": [{ "type": "number" }, { "type": "string" }] }
+              ],
+              "minItems": 2,
+              "maxItems": 2
+            }
+          ]
+        },
+        "saturation": { "type": "number", "minimum": 0, "maximum": 1 },
+        "hue": { "oneOf": [{ "type": "number" }, { "type": "string" }] },
+        "darkHue": { "oneOf": [{ "type": "number" }, { "type": "string" }] },
+        "darkSaturation": { "type": "number", "minimum": 0, "maximum": 1 },
+        "base": { "type": "string" },
+        "contrast": {
+          "oneOf": [
+            { "type": "number" },
+            { "type": "string" },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "apca": {},
+                "wcag": {}
+              }
+            }
+          ]
+        },
+        "mode": { "enum": ["auto", "fixed", "static"] },
+        "autoFlip": { "type": "boolean" },
+        "opacity": { "type": "number", "minimum": 0, "maximum": 1 },
+        "pastel": { "type": "boolean" },
+        "role": { "type": "string" },
+        "inherit": { "type": "boolean" }
+      }
+    },
+    "themeFont": {
+      "oneOf": [
+        { "type": "string", "minLength": 1 },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["google"],
+          "properties": {
+            "google": { "type": "string", "minLength": 1 },
+            "weights": {
+              "type": "array",
+              "minItems": 1,
+              "items": { "type": "integer", "minimum": 1, "maximum": 1000 }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["family", "files"],
+          "properties": {
+            "family": { "type": "string", "minLength": 1 },
+            "files": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": ["src"],
+                "properties": {
+                  "src": {
+                    "type": "string",
+                    "pattern": "^/(?!/).+\\.(woff2?|ttf|otf)$"
+                  },
+                  "weight": {
+                    "oneOf": [
+                      { "type": "integer", "minimum": 1, "maximum": 1000 },
+                      {
+                        "type": "string",
+                        "pattern": "^(?:[1-9][0-9]{0,2}|1000) (?:[1-9][0-9]{0,2}|1000)$"
+                      }
+                    ]
+                  },
+                  "style": { "enum": ["normal", "italic"] }
+                }
+              }
+            }
+          }
+        }
+      ]
+    },
     "locale": {
       "type": "object",
       "additionalProperties": false,
@@ -567,6 +874,14 @@
               "items": {
                 "$ref": "#/$defs/navigationItem"
               }
+            },
+            "link": {
+              "type": "string",
+              "pattern": "^/(?!/)[^?#\\\\\\s]*$",
+              "description": "Optional parent page route, without a deployment base, query, or fragment.",
+              "not": {
+                "pattern": "//|(^|/)\\.{1,2}(/|$)"
+              }
             }
           }
         },
@@ -587,6 +902,14 @@
                   "type": "string"
                 }
               }
+            },
+            "link": {
+              "type": "string",
+              "pattern": "^/(?!/)[^?#\\\\\\s]*$",
+              "description": "Optional parent page route, without a deployment base, query, or fragment.",
+              "not": {
+                "pattern": "//|(^|/)\\.{1,2}(/|$)"
+              }
             }
           }
         },
@@ -780,6 +1103,17 @@
               "format": "uri"
             }
           }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["openapi"],
+          "properties": {
+            "openapi": { "type": "string", "minLength": 1 },
+            "id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" },
+            "root": { "type": "string" },
+            "routeBase": { "type": "string" }
+          }
         }
       ]
     },