@dogsbay/serialize-core 0.2.0-beta.129 → 0.2.0-beta.130

package/dist/index.d.ts

@@ -16,7 +16,7 @@
  * Plus format-agnostic text helpers (`text.ts`) and an unknown-node fallback
  * that reports instead of silently dropping (`unknown.ts`).
  */
-export { leafInline, leafHtml, hasInline, hasContent, codeText, codeLang, tabTitle, tabValue, cardFields, cardBodySources, headingLevel, headingText, headingFragment, slugifyHeadingText, calloutVariant, calloutTitle, listStart, mediaSrc, renderLeaf, type CardFields, } from "./reads.js";
+export { leafInline, leafHtml, hasInline, hasContent, codeText, codeLang, tabTitle, tabValue, cardFields, cardBodySources, headingLevel, headingText, headingFragment, slugifyHeadingText, calloutVariant, calloutTitle, stepLead, stepTitle, listStart, mediaSrc, renderLeaf, type CardFields, } from "./reads.js";
 export { walkInline, applyTextFlags, inlinePlainText, markdownInlineEmitters, htmlInlineEmitters, escapeHtml, escapeAttr, codeSpan, type InlineContext, type InlineEmitters, type InlineWalkOptions, } from "./inline.js";
 export { ExportLedger, formatLedgerReport, formatCapabilityTable, unsupportedFeatures, validateCapabilities, validateLedgerAgainstCapabilities, type SupportLevel, type CapabilityDeclaration, type LossAction, type ExportLedgerEntry, type LedgerSummaryRow, } from "./capability.js";
 export { MATRIX_ROWS, formatCapabilityMatrix, missingMatrixCells, splitGroupChildren, renderAroundGroup, isDetailsSheet, type MatrixRow, type MatrixGroup, type MatrixColumn } from "./matrix.js";

package/dist/index.js

@@ -16,7 +16,7 @@
  * Plus format-agnostic text helpers (`text.ts`) and an unknown-node fallback
  * that reports instead of silently dropping (`unknown.ts`).
  */
-export { leafInline, leafHtml, hasInline, hasContent, codeText, codeLang, tabTitle, tabValue, cardFields, cardBodySources, headingLevel, headingText, headingFragment, slugifyHeadingText, calloutVariant, calloutTitle, listStart, mediaSrc, renderLeaf, } from "./reads.js";
+export { leafInline, leafHtml, hasInline, hasContent, codeText, codeLang, tabTitle, tabValue, cardFields, cardBodySources, headingLevel, headingText, headingFragment, slugifyHeadingText, calloutVariant, calloutTitle, stepLead, stepTitle, listStart, mediaSrc, renderLeaf, } from "./reads.js";
 export { walkInline, applyTextFlags, inlinePlainText, markdownInlineEmitters, htmlInlineEmitters, escapeHtml, escapeAttr, codeSpan, } from "./inline.js";
 export { ExportLedger, formatLedgerReport, formatCapabilityTable, unsupportedFeatures, validateCapabilities, validateLedgerAgainstCapabilities, } from "./capability.js";
 export { MATRIX_ROWS, formatCapabilityMatrix, missingMatrixCells, splitGroupChildren, renderAroundGroup, isDetailsSheet } from "./matrix.js";

package/dist/reads.d.ts

@@ -139,6 +139,28 @@ export declare function calloutVariant(node: TreeNode, fallback?: string): strin
  * "deliberately untitled" from "absent".
  */
 export declare function calloutTitle(node: TreeNode): string | undefined;
+/**
+ * A step's `title` prop to draw as its lead (Mintlify/MDX `<Step title="…">`), or undefined.
+ * The dogsbay-md parser never sets it (a step's title is its own first line); an importer that
+ * also writes the title into the content (format-mdx's Steps parser adds `<strong>title</strong>`)
+ * is not drawn twice: a title the step's text already starts with is skipped.
+ */
+export declare function stepTitle(node: TreeNode): string | undefined;
+/**
+ * A step's title written as its leading bold run on a line of its own, split from the detail:
+ * `1. **Stop the writer**` then `Run …` on the next line is ONE paragraph to Markdown, so every
+ * renderer drew the title and the detail on one line. The documents skill teaches that form, and
+ * it is what Mintlify's `<Step title>` imports as. The line end is what decides it: the
+ * dogsbay-md parser marks bold that ends its line (`lineEnd`), and a hard break counts too. So
+ * `1. **Click** Save.` and `**Optional:** configure X` stay one line. The bold run is bold text
+ * and links whose text is all bold. The title's nodes lose `bold` (the renderer wraps them in
+ * its title element) and `lineEnd`; the detail loses a leading break and leading space.
+ * Undefined when the step does not start with such a run, or is only the bold text.
+ */
+export declare function stepLead(inline: InlineNode[] | undefined): {
+    title: InlineNode[];
+    rest: InlineNode[];
+} | undefined;
 /** An ordered list's start number, or undefined when it starts at 1. */
 export declare function listStart(node: TreeNode): number | undefined;
 /** An image/media source, tolerating `props.src` and `props.url`. */

package/dist/reads.js

@@ -211,6 +211,84 @@ export function calloutTitle(node) {
     // title back — so the empty string is preserved and only absence is undefined.
     return typeof title === "string" ? title : undefined;
 }
+/**
+ * A step's `title` prop to draw as its lead (Mintlify/MDX `<Step title="…">`), or undefined.
+ * The dogsbay-md parser never sets it (a step's title is its own first line); an importer that
+ * also writes the title into the content (format-mdx's Steps parser adds `<strong>title</strong>`)
+ * is not drawn twice: a title the step's text already starts with is skipped.
+ */
+export function stepTitle(node) {
+    const title = typeof node.props?.title === "string" ? node.props.title.trim() : "";
+    if (!title)
+        return undefined;
+    const first = node.inline?.length ? node.inline : undefined;
+    const firstChild = node.children?.[0];
+    const text = (nodes) => (nodes ?? []).map((n) => ("text" in n && typeof n.text === "string" ? n.text : "children" in n && Array.isArray(n.children) ? text(n.children) : "")).join("");
+    const html = firstChild && !first ? leafHtml(firstChild) : undefined;
+    const lead = (first ? text(first)
+        : html !== undefined ? decodeEntities(html.replace(/<[^>]*>/g, ""))
+            : firstChild ? text(leafInline(firstChild))
+                : "").trim();
+    // The whole title, then the end of the lead or a non-word character: "A" is not in "Apple pie"
+    return lead.startsWith(title) && !/^[\p{L}\p{N}_]/u.test(lead.slice(title.length)) ? undefined : title;
+}
+/**
+ * A step's title written as its leading bold run on a line of its own, split from the detail:
+ * `1. **Stop the writer**` then `Run …` on the next line is ONE paragraph to Markdown, so every
+ * renderer drew the title and the detail on one line. The documents skill teaches that form, and
+ * it is what Mintlify's `<Step title>` imports as. The line end is what decides it: the
+ * dogsbay-md parser marks bold that ends its line (`lineEnd`), and a hard break counts too. So
+ * `1. **Click** Save.` and `**Optional:** configure X` stay one line. The bold run is bold text
+ * and links whose text is all bold. The title's nodes lose `bold` (the renderer wraps them in
+ * its title element) and `lineEnd`; the detail loses a leading break and leading space.
+ * Undefined when the step does not start with such a run, or is only the bold text.
+ */
+export function stepLead(inline) {
+    if (!inline?.length)
+        return undefined;
+    const textOf = (n) => ("text" in n && typeof n.text === "string" ? n.text : undefined);
+    const flag = (n, k) => n[k] === true;
+    const bold = (n) => {
+        if (n.type === "link") {
+            const texts = n.children.filter((c) => c.type === "text");
+            return texts.length > 0 && texts.every((c) => flag(c, "bold"));
+        }
+        return flag(n, "bold");
+    };
+    let i = 0;
+    while (i < inline.length && textOf(inline[i]) === "" && !bold(inline[i]))
+        i++;
+    const start = i;
+    while (i < inline.length && bold(inline[i]))
+        i++;
+    if (i === start)
+        return undefined;
+    let j = i;
+    while (j < inline.length && textOf(inline[j]) === "")
+        j++;
+    const hardBreak = inline[j]?.type === "break";
+    if (!flag(inline[i - 1], "lineEnd") && !hardBreak)
+        return undefined;
+    const plain = (n) => n.type === "link"
+        ? { ...n, lineEnd: undefined, children: n.children.map((c) => ({ ...c, bold: undefined })) }
+        : { ...n, bold: undefined, lineEnd: undefined };
+    const title = inline.slice(start, i).map(plain);
+    const rest = inline.slice(hardBreak ? j + 1 : i);
+    const first = rest[0] && textOf(rest[0]);
+    if (first !== undefined)
+        rest[0] = { ...rest[0], text: first.replace(/^\s+/, "") };
+    if (!rest.some((n) => textOf(n) !== ""))
+        return undefined;
+    return { title, rest };
+}
+/** The five XML entities and numeric references, for comparing an html lead with a title. */
+function decodeEntities(s) {
+    return s
+        .replace(/&#(\d+);/g, (_, d) => String.fromCodePoint(Number(d)))
+        .replace(/&#x([0-9a-f]+);/gi, (_, h) => String.fromCodePoint(parseInt(h, 16)))
+        .replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, '"').replace(/&#39;|&apos;/g, "'")
+        .replace(/&amp;/g, "&");
+}
 /** An ordered list's start number, or undefined when it starts at 1. */
 export function listStart(node) {
     const raw = node.props?.start;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/serialize-core",
-  "version": "0.2.0-beta.129",
+  "version": "0.2.0-beta.130",
   "description": "Shared serializer core — shape-tolerant TreeNode reads, a generic inline walker, fence/indent utilities, and the export capability ledger every format exporter builds on",
   "type": "module",
   "main": "dist/index.js",
@@ -22,7 +22,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@dogsbay/types": "0.2.0-beta.129"
+    "@dogsbay/types": "0.2.0-beta.130"
   },
   "repository": {
     "type": "git",