blume 2.0.2 → 2.1.0

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

@@ -1,8 +1,10 @@
+import type { CaptchaSettings } from "../captcha/schema.ts";
+import type { EndpointAuth } from "../components/content/api-page.ts";
 import type { SearchAdapterKind } from "../search/adapters/registry.ts";
 import type { StructuredDataIdentity } from "../seo/jsonld.ts";
 import type { FontHead } from "../theme/fonts.ts";
 import type { UIStrings } from "./i18n-ui.ts";
-import type { ResolvedConfig } from "./schema.ts";
+import type { LocalizableLabel, ResolvedConfig } from "./schema.ts";
 import type { Navigation, RouteAlternate, VersionAlternate } from "./types.ts";
 /**
  * The shape of the `blume:data` virtual module — the resolved, serializable
@@ -47,12 +49,16 @@ export interface BlumeFavicon {
         type?: string;
     };
 }
-/** Announcement banner, normalized from its config (string shorthand or object). */
+/**
+ * Announcement banner, normalized from its config (string shorthand or
+ * object). `content` and the link's `text` may be per-locale maps, resolved
+ * when the banner renders (see `core/localizable.ts`).
+ */
 export interface BlumeBanner {
-    content: string;
+    content: LocalizableLabel;
     link?: {
         href: string;
-        text: string;
+        text: LocalizableLabel;
     };
     dismissible: boolean;
     /** Dismissal key: the configured id, else the content itself. */
@@ -76,6 +82,8 @@ export interface BlumeDataI18n {
     fallbackLocale: string | null;
     hideDefaultLocalePrefix: boolean;
     locales: BlumeDataLocale[];
+    /** Send visitors from the default home page to their browser's language. */
+    routeByBrowserLanguage: boolean;
 }
 /** A single content route, with the metadata custom pages can read. */
 export interface BlumeRoute {
@@ -127,9 +135,26 @@ export interface BlumeDataConfig {
     appleIcon: BlumeFavicon | null;
     /** The assistant's empty-state suggestions, or `null` when the assistant is off. */
     assistant: {
+        /** The bot check's public settings, or `null` without one. */
+        captcha: CaptchaSettings | null;
         endpoint: string | null;
         suggestions: NonNullable<ResolvedConfig["ai"]["assistant"]>["suggestions"];
+        /** The Contact support link (`ai.assistant.support`), or `null`. */
+        support: string | null;
     } | null;
+    /**
+     * Defaults for hand-written endpoint pages (`api` frontmatter): the server a
+     * path joins, the default auth, and the playground, its `proxy` resolved to
+     * the URL sends go through (the built-in route under `basePath`) or `false`.
+     */
+    api: {
+        auth?: EndpointAuth;
+        playground: {
+            enabled: boolean;
+            proxy: string | false;
+        };
+        server?: string;
+    };
     banner: BlumeBanner | null;
     /** Site-wide route mount point, normalized to `""` or `/seg` (see config). */
     basePath: string;
@@ -137,6 +162,11 @@ export interface BlumeDataConfig {
     codeThemes: ResolvedConfig["markdown"]["code"]["theme"];
     /** `markdown.code.wrap`: wrap long code lines instead of scrolling. */
     codeWrap: boolean;
+    /**
+     * The consent adapter's descriptor, or `null` without one. When set, the
+     * layouts hold analytics until the reader allows it.
+     */
+    consent: ResolvedConfig["consent"];
     /** `dateFormat`: `Intl.DateTimeFormat` options for the date stamps. */
     dateFormat: ResolvedConfig["dateFormat"];
     description: string | undefined;
@@ -159,7 +189,12 @@ export interface BlumeDataConfig {
         sitemap: boolean;
     };
     favicon: BlumeFavicon;
+    /** Whether pages end with the "Was this page helpful?" rating. */
     feedback: boolean;
+    /** Whether the rating asks for a written comment after it (`feedback.comments`). */
+    feedbackComments: boolean;
+    /** `footer`: social profile icons and link columns, or `null` when unset. */
+    footer: ResolvedConfig["footer"] | null;
     /**
      * Repo coordinates for content components that address the API or build
      * their own repo links (`<GithubInfo>`, the OG card's footer slug), carrying
@@ -187,6 +222,16 @@ export interface BlumeDataConfig {
         name: string;
         route: string;
     } | null;
+    /** `seo.metatags`: the site's own tags for every page's head, or `null`. */
+    metatags: Record<string, string> | null;
+    /**
+     * "Listen to this page": `generated` when a `narration.provider` makes
+     * `blume build` write audio clips the player should look for, else the
+     * player reads with browser voices. `null` when narration is off.
+     */
+    narration: {
+        generated: boolean;
+    } | null;
     /**
      * Open Graph image generation. Card fonts are baked into the generated OG
      * endpoint (they can carry absolute build-machine paths) and deliberately

package/dist/types/core/directive-diagnostics.d.ts

@@ -0,0 +1,12 @@
+import type { SourceEntry } from "./sources/types.ts";
+import type { Diagnostic } from "./types.ts";
+/**
+ * Warn about each `:::name` container in an `.mdx` entry that isn't a callout.
+ * The page keeps its content — the body renders between the literal `:::`
+ * lines (see `markdown/directives.ts`) — but a typo like `:::warnig`, or a
+ * `:::details` carried over from another docs tool, should read as the
+ * mistake it is rather than as a finished page. Lines point into the file
+ * the author wrote, a partial's own file for a container an `<include>`
+ * brought in.
+ */
+export declare const unknownDirectiveDiagnostics: (entry: SourceEntry, sourceName: string) => Diagnostic[];

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

@@ -0,0 +1,8 @@
+/**
+ * The social platforms `footer.socials` links to, each shown by its brand
+ * icon: Mintlify's set, without its aliases (`twitter` and `x-twitter` are
+ * `x`, `earth-americas` is `website`).
+ */
+export declare const FOOTER_SOCIALS: readonly ["bluesky", "discord", "facebook", "github", "hacker-news", "instagram", "linkedin", "medium", "podcast", "reddit", "slack", "telegram", "threads", "website", "x", "youtube"];
+/** A platform `footer.socials` links to. */
+export type FooterSocial = (typeof FOOTER_SOCIALS)[number];

package/dist/types/core/heading-markers.d.ts

@@ -44,11 +44,9 @@ export interface HeadingMarkers {
  * the heading count (mid-text brackets are ordinary prose); when a marker kind
  * repeats, the last one written wins.
  *
- * `isRefDefined` reports whether a link-reference definition exists for a
- * bracket's label (`toc`, `!toc`, `#id`): a defined bracket is a CommonMark
- * shortcut link, not a marker — the renderer sees a resolved `<a>` element
- * there and strips nothing at or before it, so the parse stops the same way.
- * The render-time hast plugin never passes it (resolved links are already
- * elements by the time it runs); the raw-source scanner does.
+ * Callers pass the heading's trailing text node after a Markdown parse, so a
+ * bracket that a link-reference definition turns into a CommonMark shortcut
+ * link (`[toc]` with a `[toc]: …` definition) is already an element there and
+ * never reaches this parse.
  */
-export declare const parseHeadingMarkers: (text: string, isRefDefined?: (label: string) => boolean) => HeadingMarkers;
+export declare const parseHeadingMarkers: (text: string) => HeadingMarkers;

package/dist/types/core/i18n-ui.d.ts

@@ -11,6 +11,7 @@ declare const uiStringsObject: z.ZodObject<{
     actions: z.ZodPrefault<z.ZodObject<{
         addToCursor: z.ZodDefault<z.ZodString>;
         addToVscode: z.ZodDefault<z.ZodString>;
+        askAboutCode: z.ZodDefault<z.ZodString>;
         connectMcp: z.ZodDefault<z.ZodString>;
         copied: z.ZodDefault<z.ZodString>;
         copyClaudeCode: z.ZodDefault<z.ZodString>;
@@ -36,11 +37,18 @@ declare const uiStringsObject: z.ZodObject<{
         copy: z.ZodDefault<z.ZodString>;
         empty: z.ZodDefault<z.ZodString>;
         error: z.ZodDefault<z.ZodString>;
+        explainCode: z.ZodDefault<z.ZodString>;
         label: z.ZodDefault<z.ZodString>;
+        open: z.ZodDefault<z.ZodString>;
         placeholder: z.ZodDefault<z.ZodString>;
+        rateLimited: z.ZodDefault<z.ZodString>;
+        removeCode: z.ZodDefault<z.ZodString>;
         send: z.ZodDefault<z.ZodString>;
+        support: z.ZodDefault<z.ZodString>;
+        supportSubject: z.ZodDefault<z.ZodString>;
         tip: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
+        verifyFailed: z.ZodDefault<z.ZodString>;
         you: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     banner: z.ZodPrefault<z.ZodObject<{
@@ -50,6 +58,14 @@ declare const uiStringsObject: z.ZodObject<{
         description: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
+    consent: z.ZodPrefault<z.ZodObject<{
+        accept: z.ZodDefault<z.ZodString>;
+        decline: z.ZodDefault<z.ZodString>;
+        label: z.ZodDefault<z.ZodString>;
+        message: z.ZodDefault<z.ZodString>;
+        policy: z.ZodDefault<z.ZodString>;
+        settings: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
     content: z.ZodPrefault<z.ZodObject<{
         code: z.ZodDefault<z.ZodString>;
         copyColor: z.ZodDefault<z.ZodString>;
@@ -60,6 +76,8 @@ declare const uiStringsObject: z.ZodObject<{
         preview: z.ZodDefault<z.ZodString>;
         prop: z.ZodDefault<z.ZodString>;
         selectTab: z.ZodDefault<z.ZodString>;
+        selectView: z.ZodDefault<z.ZodString>;
+        showLess: z.ZodDefault<z.ZodString>;
         showMore: z.ZodDefault<z.ZodString>;
         stars: z.ZodDefault<z.ZodString>;
         tab: z.ZodDefault<z.ZodString>;
@@ -67,8 +85,10 @@ declare const uiStringsObject: z.ZodObject<{
         update: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     feedback: z.ZodPrefault<z.ZodObject<{
+        comment: z.ZodDefault<z.ZodString>;
         no: z.ZodDefault<z.ZodString>;
         question: z.ZodDefault<z.ZodString>;
+        send: z.ZodDefault<z.ZodString>;
         thanks: z.ZodDefault<z.ZodString>;
         yes: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
@@ -76,6 +96,28 @@ declare const uiStringsObject: z.ZodObject<{
         label: z.ZodDefault<z.ZodString>;
         untranslated: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
+    narration: z.ZodPrefault<z.ZodObject<{
+        cueDanger: z.ZodDefault<z.ZodString>;
+        cueInfo: z.ZodDefault<z.ZodString>;
+        cueNote: z.ZodDefault<z.ZodString>;
+        cueSection: z.ZodDefault<z.ZodString>;
+        cueStep: z.ZodDefault<z.ZodString>;
+        cueSuccess: z.ZodDefault<z.ZodString>;
+        cueTab: z.ZodDefault<z.ZodString>;
+        cueTip: z.ZodDefault<z.ZodString>;
+        cueWarning: z.ZodDefault<z.ZodString>;
+        error: z.ZodDefault<z.ZodString>;
+        follow: z.ZodDefault<z.ZodString>;
+        label: z.ZodDefault<z.ZodString>;
+        minutes: z.ZodDefault<z.ZodString>;
+        next: z.ZodDefault<z.ZodString>;
+        pause: z.ZodDefault<z.ZodString>;
+        play: z.ZodDefault<z.ZodString>;
+        previous: z.ZodDefault<z.ZodString>;
+        progress: z.ZodDefault<z.ZodString>;
+        speed: z.ZodDefault<z.ZodString>;
+        stop: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
     nav: z.ZodPrefault<z.ZodObject<{
         back: z.ZodDefault<z.ZodString>;
         breadcrumb: z.ZodDefault<z.ZodString>;
@@ -104,6 +146,7 @@ declare const uiStringsObject: z.ZodObject<{
         next: z.ZodDefault<z.ZodString>;
         pagination: z.ZodDefault<z.ZodString>;
         previous: z.ZodDefault<z.ZodString>;
+        related: z.ZodDefault<z.ZodString>;
         skipToContent: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     search: z.ZodPrefault<z.ZodObject<{
@@ -139,6 +182,7 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
     actions: z.ZodPrefault<z.ZodObject<{
         addToCursor: z.ZodDefault<z.ZodString>;
         addToVscode: z.ZodDefault<z.ZodString>;
+        askAboutCode: z.ZodDefault<z.ZodString>;
         connectMcp: z.ZodDefault<z.ZodString>;
         copied: z.ZodDefault<z.ZodString>;
         copyClaudeCode: z.ZodDefault<z.ZodString>;
@@ -164,11 +208,18 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         copy: z.ZodDefault<z.ZodString>;
         empty: z.ZodDefault<z.ZodString>;
         error: z.ZodDefault<z.ZodString>;
+        explainCode: z.ZodDefault<z.ZodString>;
         label: z.ZodDefault<z.ZodString>;
+        open: z.ZodDefault<z.ZodString>;
         placeholder: z.ZodDefault<z.ZodString>;
+        rateLimited: z.ZodDefault<z.ZodString>;
+        removeCode: z.ZodDefault<z.ZodString>;
         send: z.ZodDefault<z.ZodString>;
+        support: z.ZodDefault<z.ZodString>;
+        supportSubject: z.ZodDefault<z.ZodString>;
         tip: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
+        verifyFailed: z.ZodDefault<z.ZodString>;
         you: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     banner: z.ZodPrefault<z.ZodObject<{
@@ -178,6 +229,14 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         description: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
+    consent: z.ZodPrefault<z.ZodObject<{
+        accept: z.ZodDefault<z.ZodString>;
+        decline: z.ZodDefault<z.ZodString>;
+        label: z.ZodDefault<z.ZodString>;
+        message: z.ZodDefault<z.ZodString>;
+        policy: z.ZodDefault<z.ZodString>;
+        settings: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
     content: z.ZodPrefault<z.ZodObject<{
         code: z.ZodDefault<z.ZodString>;
         copyColor: z.ZodDefault<z.ZodString>;
@@ -188,6 +247,8 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         preview: z.ZodDefault<z.ZodString>;
         prop: z.ZodDefault<z.ZodString>;
         selectTab: z.ZodDefault<z.ZodString>;
+        selectView: z.ZodDefault<z.ZodString>;
+        showLess: z.ZodDefault<z.ZodString>;
         showMore: z.ZodDefault<z.ZodString>;
         stars: z.ZodDefault<z.ZodString>;
         tab: z.ZodDefault<z.ZodString>;
@@ -195,8 +256,10 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         update: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     feedback: z.ZodPrefault<z.ZodObject<{
+        comment: z.ZodDefault<z.ZodString>;
         no: z.ZodDefault<z.ZodString>;
         question: z.ZodDefault<z.ZodString>;
+        send: z.ZodDefault<z.ZodString>;
         thanks: z.ZodDefault<z.ZodString>;
         yes: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
@@ -204,6 +267,28 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         label: z.ZodDefault<z.ZodString>;
         untranslated: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
+    narration: z.ZodPrefault<z.ZodObject<{
+        cueDanger: z.ZodDefault<z.ZodString>;
+        cueInfo: z.ZodDefault<z.ZodString>;
+        cueNote: z.ZodDefault<z.ZodString>;
+        cueSection: z.ZodDefault<z.ZodString>;
+        cueStep: z.ZodDefault<z.ZodString>;
+        cueSuccess: z.ZodDefault<z.ZodString>;
+        cueTab: z.ZodDefault<z.ZodString>;
+        cueTip: z.ZodDefault<z.ZodString>;
+        cueWarning: z.ZodDefault<z.ZodString>;
+        error: z.ZodDefault<z.ZodString>;
+        follow: z.ZodDefault<z.ZodString>;
+        label: z.ZodDefault<z.ZodString>;
+        minutes: z.ZodDefault<z.ZodString>;
+        next: z.ZodDefault<z.ZodString>;
+        pause: z.ZodDefault<z.ZodString>;
+        play: z.ZodDefault<z.ZodString>;
+        previous: z.ZodDefault<z.ZodString>;
+        progress: z.ZodDefault<z.ZodString>;
+        speed: z.ZodDefault<z.ZodString>;
+        stop: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
     nav: z.ZodPrefault<z.ZodObject<{
         back: z.ZodDefault<z.ZodString>;
         breadcrumb: z.ZodDefault<z.ZodString>;
@@ -232,6 +317,7 @@ export declare const uiStringsSchema: z.ZodPrefault<z.ZodObject<{
         next: z.ZodDefault<z.ZodString>;
         pagination: z.ZodDefault<z.ZodString>;
         previous: z.ZodDefault<z.ZodString>;
+        related: z.ZodDefault<z.ZodString>;
         skipToContent: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>;
     search: z.ZodPrefault<z.ZodObject<{

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

@@ -89,5 +89,7 @@ export declare const localeTargetPath: (rel: string, ext: string, locale: string
  * recognizes) but aren't declared in `i18n.locales`. Without this they're
  * silently treated as default-locale content under a `/<code>/…` route, which
  * is almost never intended — usually a translation that wasn't registered.
+ * A folder named after the default locale gets the same treatment (see
+ * {@link defaultLocaleFolderDiagnostic}).
  */
 export declare const i18nDiagnostics: (pages: PageRecord[], i18n: ResolvedI18nConfig, versions?: ResolvedVersionsConfig) => Diagnostic[];

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

@@ -10,6 +10,12 @@ export interface IncludeAttributes {
     lang?: string;
     /** Fence meta string in code-block mode (e.g. `title="lib.ts"`). */
     meta?: string;
+    /**
+     * Every other attribute with a value: the snippet's own variables.
+     * `<include plan="Pro">` makes `{{plan}}` in the included file read `Pro`,
+     * ahead of any site-wide variable of the same name.
+     */
+    props?: Record<string, string>;
 }
 /** A parsed include statement. */
 export interface IncludeStatement {
@@ -18,8 +24,8 @@ export interface IncludeStatement {
 }
 /**
  * Parse one trimmed line as an include statement, or `null` when it isn't
- * one. Only `lang` and `meta` are meaningful; unknown attributes parse and
- * are ignored so a future attribute degrades gracefully on older versions.
+ * one. `lang` and `meta` shape a code include; every other attribute with a
+ * value becomes a prop, a variable scoped to the included file.
  */
 export declare const parseIncludeStatement: (line: string) => IncludeStatement | null;
 /**

package/dist/types/core/last-modified.d.ts

@@ -13,6 +13,16 @@ export declare const resolveLastModifiedConfig: (value: false | "git" | "frontma
  * newest-first, the first date seen for a path wins. Blank lines are ignored.
  */
 export declare const parseGitLog: (output: string) => Map<string, string>;
+/**
+ * `path` with every symlink resolved, the spelling git prints paths in: a
+ * project opened through a link (`/tmp/site` on macOS, where `/tmp` links to
+ * `/private/tmp`) gets `/private/tmp/site` from `rev-parse --show-toplevel`,
+ * so the project's own spelling would compare as outside the repository and
+ * every page would go undated. The native realpath also expands a Windows
+ * 8.3 short name (`RUNNER~1`), which git does too. A path that doesn't exist
+ * stays as written.
+ */
+export declare const realPath: (path: string) => string;
 /**
  * The toplevel of the repository containing `root`, or null when git is
  * unavailable or the project isn't a repo. Callers use it to decide which

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

@@ -0,0 +1,7 @@
+import type { LocalizableLabel } from "./schema.ts";
+/**
+ * Resolve a possibly-per-locale label to the string a locale renders: the
+ * active locale's entry, else the default locale's, else the map's first
+ * entry (which is also what a single-locale site gets).
+ */
+export declare const resolveLocalizable: (label: LocalizableLabel, locale?: string, defaultLocale?: string) => string;

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

@@ -11,6 +11,14 @@ export interface FolderMetaSource {
     include?: readonly string[];
     exclude?: readonly string[];
 }
+/**
+ * The folder-meta files a filesystem source contributes: `patterns` (every
+ * meta module name, shared `meta.$.*` included, by default) under the source's
+ * root, minus its `exclude` globs, dependencies, and build output, and only in
+ * folders its `include` globs reach. `blume translate` finds the meta files it
+ * translates through this too, so it covers exactly the ones the scan reads.
+ */
+export declare const findFolderMetaFiles: (source: FolderMetaSource, patterns?: readonly string[]) => Promise<string[]>;
 /**
  * Discover `meta.{ts,js,mjs}` files across the given filesystem sources. Keys are
  * the source's route prefix joined with the directory relative to that source's

package/dist/types/core/page-modes.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Page layout modes (`mode` frontmatter), Mintlify's names for what a page
+ * shows around its content:
+ *
+ * - `default`: the sidebar, the page's title and table of contents, and the
+ *   page-end links, around the prose column.
+ * - `wide`: no table of contents; the content takes its width.
+ * - `center`: no sidebar or table of contents; a wider column, centered.
+ *   For changelogs and other pages read top to bottom.
+ * - `custom`: only the header. No sidebar, title, breadcrumbs, table of
+ *   contents, page-end links, or site footer, and the content spans the
+ *   page, for a landing page written in MDX.
+ * - `frame`: `custom`, keeping the sidebar.
+ *
+ * Mintlify's `assistant` mode, a full-page chat, has no equivalent.
+ */
+export declare const PAGE_MODES: readonly ["default", "wide", "center", "custom", "frame"];
+export type PageMode = (typeof PAGE_MODES)[number];
+/** What a page shows around its content, and how wide the content runs. */
+export interface PageModeLayout {
+    /** The page's own chrome: title, description, breadcrumbs, page-end links, and the site footer. */
+    chrome: boolean;
+    sidebar: boolean;
+    toc: boolean;
+    /** `content` is the prose measure, `center` a wider centered column, `full` the whole column. */
+    width: "content" | "center" | "full";
+}
+/** The layout a mode gives a page. */
+export declare const pageModeLayout: (mode?: PageMode) => PageModeLayout;

package/dist/types/core/redirect-patterns.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Pattern redirects: a `from` that covers many paths, written the way
+ * Mintlify and `vercel.json` write them.
+ *
+ * - `:name` matches one whole segment: `/blog/:slug` → `/articles/:slug`.
+ * - `:name*` as the last segment matches the rest of the path, any number of
+ *   segments: `/beta/:slug*` → `/v2/:slug*` sends `/beta/a/b` to `/v2/a/b`
+ *   and `/beta` itself to `/v2`. A last segment of `*` does the same.
+ * - `*` ending a segment matches the rest of the path from there:
+ *   `/articles/concepts-*` → `/overview`, or `/old/article-*` →
+ *   `/new/article-*` to carry what it matched (`/new/article-:splat`, as
+ *   `_redirects` spells it, reads the same capture).
+ *
+ * `to` reads a capture as a whole segment (`/:name`, `/:name*`, `/*`) or, for
+ * `*`, wherever it stands. Hosts disagree on the rest of the syntax, so each
+ * gets its own translation from {@link expandRedirect}: `_redirects` splats,
+ * `vercel.json` sources, and the regular expressions Vercel's routing config,
+ * the Node and Cloudflare wrappers, and the dev server match with. A capture
+ * that may be empty is expanded into two rules first, so `/beta` lands on
+ * `/v2` rather than `/v2/` on every host.
+ */
+/** The name `*` captures under, which `_redirects` reads as `:splat`. */
+export declare const SPLAT = "splat";
+/** A piece of a parsed `from`, or of a rule it expands to. */
+type Part = {
+    kind: "text";
+    text: string;
+}
+/** `:name`: one whole segment. */
+ | {
+    kind: "param";
+    name: string;
+}
+/** `/:name*` or `/*` ending the path: zero or more segments. */
+ | {
+    kind: "rest";
+    name: string;
+}
+/** A rest in an expanded rule: one or more characters after its `/`. */
+ | {
+    kind: "tail";
+    name: string;
+}
+/** `*` ending a segment: any characters, none included. */
+ | {
+    kind: "splat";
+};
+/** A piece of an expanded rule, where a rest has become a tail. */
+type RulePart = Exclude<Part, {
+    kind: "rest";
+}>;
+/** A redirect's two ends, as configured or based. */
+interface RedirectEnds {
+    from: string;
+    status: number;
+    to: string;
+}
+/** One rule a redirect expands to. */
+export interface RedirectRule {
+    parts: RulePart[];
+    status: number;
+    to: string;
+}
+/** Whether a path is a pattern, rather than one exact path. */
+export declare const isPatternPath: (path: string) => boolean;
+/** Why a redirect's ends can't work, and which end to fix. */
+export interface RedirectPatternError {
+    end: "from" | "to";
+    message: string;
+}
+/**
+ * Why a redirect's ends can't work as a pattern, or `null` when they can:
+ * `from` has a malformed capture, or `to` reads one `from` doesn't make.
+ */
+export declare const redirectPatternError: (from: string, to: string) => RedirectPatternError | null;
+/**
+ * The rules a redirect expands to, in the order to try them. A `from` ending
+ * in a rest (`/:name*`, `/*`) becomes two: the bare path, its references
+ * dropped, and the path with at least one more segment. Only a pattern has
+ * rules; an exact redirect gets none.
+ */
+export declare const expandRedirect: (redirect: RedirectEnds) => RedirectRule[];
+/** Put exact redirects ahead of patterns, which hosts try in order. */
+export declare const exactFirst: <Redirect extends {
+    from: string;
+}>(redirects: readonly Redirect[]) => Redirect[];
+/** A rule as a `_redirects` `from` and `to`: rests and `*` are its splat. */
+export declare const underscoreRedirect: (rule: RedirectRule) => {
+    from: string;
+    to: string;
+};
+/**
+ * A rule as a `vercel.json` `source` and `destination` (`path-to-regexp`),
+ * each literal run escaped by `escape` so it matches only itself.
+ */
+export declare const vercelRedirect: (rule: RedirectRule, escape: (path: string) => string) => {
+    destination: string;
+    source: string;
+};
+/**
+ * A rule as a regular expression source over the decoded path (JavaScript
+ * and PCRE alike), a trailing slash optional, and its `to` with each capture
+ * a numbered `$n`. What Vercel's routing config and the server wrappers
+ * match with.
+ */
+export declare const regexRedirect: (rule: RedirectRule) => {
+    location: string;
+    source: string;
+};
+/** A pattern redirect as the server wrappers carry it: regex source, `Location` template, status. */
+export type CompiledRedirect = [
+    source: string,
+    location: string,
+    status: number
+];
+/**
+ * The pattern redirects among `redirects`, compiled for the server wrappers
+ * and the dev server, in the order to try them. The `Location` template is
+ * percent-encoded as the header needs; a capture is encoded when it's filled
+ * (see {@link fillLocation}).
+ */
+export declare const compileRedirects: (redirects: readonly RedirectEnds[]) => CompiledRedirect[];
+/** A captured value, encoded for a `Location` header that must not grow a query or fragment. */
+export declare const encodeCapture: (value: string) => string;
+/** A `Location` template with its `$n` references filled from `match`. */
+export declare const fillLocation: (location: string, match: RegExpExecArray) => string;
+/**
+ * The `Location` and status the first compiled redirect matching a decoded
+ * path answers with, or `null` when none does.
+ */
+export declare const matchCompiledRedirect: (compiled: readonly CompiledRedirect[], path: string) => [location: string, status: number] | null;
+/** A request URL's path, decoded; a malformed escape leaves it as sent. */
+export declare const requestPath: (url: string) => string;
+/**
+ * Where a pattern redirect sends a decoded path, unencoded, or `undefined`
+ * when none matches: what the link checks follow.
+ */
+export declare const patternDestination: (redirects: readonly RedirectEnds[], path: string) => string | undefined;
+/**
+ * The paths a pattern `from` matches, of those given; none for an exact
+ * `from`. Only the match matters here, so the rules' destinations are moot.
+ */
+export declare const pathsUnderPattern: (from: string, paths: readonly string[]) => string[];
+export {};

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

@@ -0,0 +1,40 @@
+import type { LocaleRouting } from "./i18n.ts";
+import type { PageLink } from "./types.ts";
+/** The most entries a page lists, as on Mintlify. */
+export declare const MAX_RELATED = 10;
+/** A `{ Title: link }` entry: the one key is the title, its value the link. */
+export interface TitledRelatedEntry {
+    [title: string]: string;
+}
+/** One `related` frontmatter entry. */
+export type RelatedEntry = string | TitledRelatedEntry;
+/** A resolved entry, ready to render. */
+export interface RelatedLink {
+    description?: string;
+    external: boolean;
+    /** A page's route (`basePath` included, deployment base not), or a URL. */
+    href: string;
+    title: string;
+}
+/** A served route, as the data snapshot lists it. */
+export interface RelatedRoute {
+    description: string | null;
+    path: string;
+    title: string;
+}
+/** What resolving needs from the site. */
+export interface RelatedContext {
+    basePath: string;
+    /** The site's locales, when it has more than one. */
+    i18n?: LocaleRouting | null;
+    /** The locale of the page being rendered. */
+    locale: string;
+    routes: readonly RelatedRoute[];
+}
+/** The links a page's `related` entries name, in the order written. */
+export declare const relatedLinks: (entries: readonly RelatedEntry[] | false | undefined, context: RelatedContext) => RelatedLink[];
+/**
+ * A page's `related` page links, as links the checker validates like any in
+ * its body. Front matter has no line map, so they point at its first line.
+ */
+export declare const relatedPageLinks: (entries?: readonly RelatedEntry[] | false) => PageLink[];