@dogsbay/format-starlight 0.2.0-beta.13 → 0.2.0-beta.130

package/dist/parse-mdx.d.ts

@@ -13,10 +13,70 @@
  * - The adapter pattern for site-specific component mappings
  */
 import type { TreeNode } from "@dogsbay/types";
-import type { SiteAdapter } from "./adapter.js";
+import type { IncludeOptions, SiteAdapter } from "./adapter.js";
+/**
+ * MDX reads the TEXT inside JSX/HTML elements as Markdown; a raw HTML block
+ * here is emitted as it is. Two Markdown forms in that text then broke the
+ * page: a code span (`` `Array<String>` `` in a `<td>` — the browser read
+ * `<String>` as a tag and the type vanished; 10 on the Cloudflare corpus) and
+ * a backslash escape (`Promise\<InstanceStatus>` inside `<code>` showed the
+ * backslash). Both become their HTML: `<code>` with escaped text, `&lt;`.
+ * Only TEXT between tags is touched — never inside a tag (attribute values)
+ * or inside `<pre>`, `<script>`, `<style>`.
+ */
+export declare function mdxHtmlText(html: string): string;
+/**
+ * MDX has no HTML blocks: every tag line is its own JSX element. Markdown's
+ * HTML block runs to the next BLANK line, so a component written straight
+ * after a `<p>…</p>` line was swallowed into it and leaked as a tag
+ * (`<AnchorHeading>`, `<Aside>` in Cloudflare's JSX branches). A blank line
+ * goes between them — only after a line that is one COMPLETE element, so an
+ * open `<table>` or `<ul>` that the component sits inside is left whole.
+ */
+export declare function endHtmlBlocksAtComponents(source: string): string;
+/**
+ * `<Feature header="…"> Paid add-on` — text after a CONTAINER's opener on
+ * its line — is the start of the body in MDX. The block rule took the line
+ * as the opener and the text was lost with no report (web3: two plan badges).
+ * It moves to its own line, at the opener's indent. A component after the
+ * opener is `normalizeJsxLines`' job; a closer on the same line is an inline
+ * use and is left alone.
+ */
+export declare function splitContainerOpenerText(source: string, isContainer: (tag: string) => boolean): string;
 export interface ParseOptions {
     adapter?: SiteAdapter;
+    /**
+     * The page's front matter, when the caller has already split it off (the
+     * CLI parses the BODY). Components that read it (`<ProductReleaseNotes>`)
+     * otherwise saw nothing.
+     */
+    frontmatter?: Record<string, unknown>;
     /** Directory containing partial MDX files for <Render> resolution */
     partialsDir?: string;
+    /** How partials are resolved (inline, or template-page directives). */
+    includeOptions?: IncludeOptions;
+    /**
+     * Called with the tag name of every component DROPPED from the output —
+     * one that no builtin and no adapter mapping claimed.
+     *
+     * A dropped component is content that is not on the page. Cloudflare's
+     * `<AiSearchOverviewDiagram />` is the architecture diagram at the top of
+     * the AI Search overview; it vanished with no trace, and the only way to
+     * find out was to compare the converted page against the live one by eye.
+     * The importer knows at the moment it happens — this is how it says so.
+     */
+    onDrop?: (tag: string) => void;
+    /**
+     * Accessible description for a component we cannot render, if one can be
+     * found — used to leave a described placeholder instead of a hole.
+     *
+     * Cloudflare's diagrams are 478-line Astro components: inline SVG, a web
+     * component and CSS animation, with no image file anywhere. Nothing can
+     * convert that. But each carries an `aria-label` written by their docs team
+     * ("AI Search is a managed search primitive: you upload or connect your
+     * content…"), which IS the information the diagram conveys — and it was
+     * being thrown away with the markup.
+     */
+    describeComponent?: (tag: string) => string | undefined;
 }
 export declare function starlightToTree(source: string, options?: ParseOptions): TreeNode[];