@brett_lamy/docstream 1.3.0 → 1.5.0

package/dist/gitbook/attrs.js

@@ -0,0 +1,36 @@
+/*
+ * Tag and fence attribute values (`{% demo title="…" %}`, ```` ```ts title="…" ````).
+ *
+ * Values are double-quoted. On serialize a backslash becomes `\\`, a double quote `\"`,
+ * and the tag terminator `%}` becomes `%\}` — so a value can never end its tag early or
+ * truncate at a quote. On parse `\\`, `\"` and `\}` are unescaped; any other backslash is
+ * kept literally (so `C:\temp` written by hand still reads as written).
+ */
+/** Escape one attribute value for a double-quoted `name="…"` pair. */
+export function escapeAttr(value) {
+    return value.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/%\}/g, "%\\}");
+}
+/** Undo `escapeAttr`. */
+export function unescapeAttr(raw) {
+    return raw.replace(/\\(["\\}])/g, "$1");
+}
+/** ` name="value"` with the value escaped (leading space included). */
+export function attr(name, value) {
+    return ` ${name}="${escapeAttr(String(value))}"`;
+}
+/** Every `name="value"` pair in `raw` (escapes honoured, values unescaped). */
+export function parseAttrs(raw) {
+    const attrs = {};
+    if (!raw)
+        return attrs;
+    for (const m of raw.matchAll(/([\w-]+)="((?:[^"\\]|\\.)*)"/g)) {
+        attrs[m[1]] = unescapeAttr(m[2]);
+    }
+    return attrs;
+}
+/**
+ * The attribute part of a `{% name … %}` tag, as a regex source: anything up to the
+ * closing `%}` (a lone `%` is fine; `%}` inside a value is always escaped as `%\}`).
+ */
+export const TAG_ATTRS = String.raw `(?:[^%\n]|%(?!\}))*?`;
+//# sourceMappingURL=attrs.js.map

package/dist/gitbook/attrs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attrs.js","sourceRoot":"","sources":["../../src/gitbook/attrs.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,sEAAsE;AACtE,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAClF,CAAC;AAED,yBAAyB;AACzB,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;AACzC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,IAAI,CAAC,IAAY,EAAE,KAAgC;IACjE,OAAO,IAAI,IAAI,KAAK,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAA;AAClD,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,UAAU,CAAC,GAAuB;IAChD,MAAM,KAAK,GAA2B,EAAE,CAAA;IACxC,IAAI,CAAC,GAAG;QAAE,OAAO,KAAK,CAAA;IACtB,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,+BAA+B,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAA,sBAAsB,CAAA"}

package/dist/gitbook/flatten.d.ts

@@ -0,0 +1,14 @@
+import type { Block, DocumentNode } from "./ast.js";
+/**
+ * docstream-only presentation blocks as plain Markdown, for LLM prompts and tools that don't
+ * know docstream (`resolveDemosToMarkdown(…, { format: "plain" })`):
+ *
+ * - `{% command %}` → a ```` ```sh ```` fence with the npm command;
+ * - titled `{% tabs title="Installation" %}` → a `## Installation` heading, then each tab as a
+ *   bold label followed by its blocks.
+ *
+ * Everything else is kept (GitBook tags included — they're GitBook, not docstream).
+ */
+export declare function flattenForPlainMarkdown(doc: DocumentNode): DocumentNode;
+export declare function flattenBlocks(blocks: Block[]): Block[];
+//# sourceMappingURL=flatten.d.ts.map

package/dist/gitbook/flatten.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flatten.d.ts","sourceRoot":"","sources":["../../src/gitbook/flatten.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAGhD;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY,CAEvE;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CA6BtD"}

package/dist/gitbook/flatten.js

@@ -0,0 +1,45 @@
+import { text } from "./ast.js";
+/**
+ * docstream-only presentation blocks as plain Markdown, for LLM prompts and tools that don't
+ * know docstream (`resolveDemosToMarkdown(…, { format: "plain" })`):
+ *
+ * - `{% command %}` → a ```` ```sh ```` fence with the npm command;
+ * - titled `{% tabs title="Installation" %}` → a `## Installation` heading, then each tab as a
+ *   bold label followed by its blocks.
+ *
+ * Everything else is kept (GitBook tags included — they're GitBook, not docstream).
+ */
+export function flattenForPlainMarkdown(doc) {
+    return { ...doc, children: flattenBlocks(doc.children) };
+}
+export function flattenBlocks(blocks) {
+    return blocks.flatMap((b) => {
+        switch (b.type) {
+            case "command":
+                return [{ type: "code", language: "sh", title: null, lineNumbers: false, code: b.command }];
+            case "tabs":
+                if (b.title) {
+                    return [
+                        { type: "heading", level: b.level ?? 2, children: [text(b.title)] },
+                        ...b.tabs.flatMap((t) => [{ type: "paragraph", children: [text(t.title, { bold: true })] }, ...flattenBlocks(t.children)]),
+                    ];
+                }
+                return [{ ...b, tabs: b.tabs.map((t) => ({ ...t, children: flattenBlocks(t.children) })) }];
+            case "hint":
+            case "expandable":
+            case "blockquote":
+                return [{ ...b, children: flattenBlocks(b.children) }];
+            case "stepper":
+                return [{ ...b, steps: b.steps.map((s) => ({ ...s, children: flattenBlocks(s.children) })) }];
+            case "columns":
+                return [{ ...b, columns: b.columns.map((c) => ({ ...c, children: flattenBlocks(c.children) })) }];
+            case "list":
+                return [{ ...b, items: b.items.map((item) => ({ ...item, children: flattenBlocks(item.children) })) }];
+            case "updates":
+                return [{ ...b, updates: b.updates.map((u) => ({ ...u, children: flattenBlocks(u.children) })) }];
+            default:
+                return [b];
+        }
+    });
+}
+//# sourceMappingURL=flatten.js.map

package/dist/gitbook/flatten.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flatten.js","sourceRoot":"","sources":["../../src/gitbook/flatten.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAE5B;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAiB;IACvD,OAAO,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAA;AAC1D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAe;IAC3C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAW,EAAE;QACnC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,SAAS;gBACZ,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAC7F,KAAK,MAAM;gBACT,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;oBACZ,OAAO;wBACL,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;wBACnE,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAW,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;qBACpI,CAAA;gBACH,CAAC;gBACD,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAC7F,KAAK,MAAM,CAAC;YACZ,KAAK,YAAY,CAAC;YAClB,KAAK,YAAY;gBACf,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACxD,KAAK,SAAS;gBACZ,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAC/F,KAAK,SAAS;gBACZ,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YACnG,KAAK,MAAM;gBACT,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YACxG,KAAK,SAAS;gBACZ,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YACnG;gBACE,OAAO,CAAC,CAAC,CAAC,CAAA;QACd,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/gitbook/index.d.ts

@@ -0,0 +1,10 @@
+export type * from "./ast.js";
+export { escapeAttr, unescapeAttr } from "./attrs.js";
+export { closesFence, demoBody, fenceOpener, fenceTracker, parseDemoVariants, parseMarkdown, parseBlocks, trimPartialInlineToken } from "./parse.js";
+export { fenceFor, serializeBlocks, serializeDemoFile, serializeMarkdown } from "./serialize.js";
+export { defaultInlineDelims, footnoteDefinitions, inlineDelims, parseInline, plainText, refDefinitions, serializeInline, serializeReference } from "./inline.js";
+export { PACKAGE_MANAGERS, packageManagerCommands } from "./package-managers.js";
+export { flattenBlocks, flattenForPlainMarkdown } from "./flatten.js";
+export { documentOutline, slugify } from "./outline.js";
+export type { OutlineEntry } from "./outline.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/gitbook/index.ts"],"names":[],"mappings":"AAEA,mBAAmB,OAAO,CAAA;AAC1B,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AACjJ,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7F,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC9J,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC7E,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAClE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACpD,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA"}

package/dist/gitbook/index.js

@@ -0,0 +1,8 @@
+export { escapeAttr, unescapeAttr } from "./attrs.js";
+export { closesFence, demoBody, fenceOpener, fenceTracker, parseDemoVariants, parseMarkdown, parseBlocks, trimPartialInlineToken } from "./parse.js";
+export { fenceFor, serializeBlocks, serializeDemoFile, serializeMarkdown } from "./serialize.js";
+export { defaultInlineDelims, footnoteDefinitions, inlineDelims, parseInline, plainText, refDefinitions, serializeInline, serializeReference } from "./inline.js";
+export { PACKAGE_MANAGERS, packageManagerCommands } from "./package-managers.js";
+export { flattenBlocks, flattenForPlainMarkdown } from "./flatten.js";
+export { documentOutline, slugify } from "./outline.js";
+//# sourceMappingURL=index.js.map

package/dist/gitbook/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gitbook/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AACjJ,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7F,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC9J,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC7E,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAClE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA"}

package/dist/gitbook/inline.d.ts

@@ -0,0 +1,28 @@
+import type { Inline, InlineDelimiter, ReferenceNode, TextNode } from "./ast.js";
+type Marks = Partial<Omit<TextNode, "type" | "text">>;
+export declare const refDefinitions: Map<string, string>;
+export declare const footnoteDefinitions: Map<string, {
+    url: string;
+    label?: string;
+}>;
+/** A reference label as matched against definitions: case-insensitive, inner whitespace collapsed. */
+export declare function normalizeLabel(label: string): string;
+export declare function parseInline(src: string, marks?: Marks): Inline[];
+/** Run `fn` with the document's reference definitions in scope for `serializeInline`. */
+export declare function withDocumentDefinitions<T>(defs: ReadonlyMap<string, string>, fn: () => T): T;
+export declare function serializeReference(n: ReferenceNode): string;
+/**
+ * The spelling `serializeInline` gives an inline, outermost → innermost: its `delims` hint reconciled with
+ * its marks. Editors can store it per mark and hand it back as `delims`.
+ */
+export declare function inlineDelims(n: Inline): InlineDelimiter[];
+/** The spelling an inline gets without a `delims` hint; a hint equal to it can be dropped. */
+export declare function defaultInlineDelims(n: Inline): InlineDelimiter[];
+export interface SerializeInlineOptions {
+    /** Inside a GFM table cell: pipes are written `\|` (except those a code span recorded as bare). */
+    tableCell?: boolean;
+}
+export declare function serializeInline(nodes: Inline[], options?: SerializeInlineOptions): string;
+export declare function plainText(nodes: Inline[]): string;
+export {};
+//# sourceMappingURL=inline.d.ts.map

package/dist/gitbook/inline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.d.ts","sourceRoot":"","sources":["../../src/gitbook/inline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAA6B,aAAa,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAExG,KAAK,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAA;AAIrD,eAAO,MAAM,cAAc,qBAA4B,CAAA;AAIvD,eAAO,MAAM,mBAAmB;SAA0B,MAAM;YAAU,MAAM;EAAK,CAAA;AAErF,sGAAsG;AACtG,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD;AAyhBD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,KAAU,GAAG,MAAM,EAAE,CAEpE;AAUD,yFAAyF;AACzF,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAQ5F;AAED,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,aAAa,GAAG,MAAM,CAG3D;AA+GD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,eAAe,EAAE,CAEzD;AAED,8FAA8F;AAC9F,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,GAAG,eAAe,EAAE,CAEhE;AAsPD,MAAM,WAAW,sBAAsB;IACrC,mGAAmG;IACnG,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAOD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,sBAA2B,GAAG,MAAM,CAuD7F;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAWjD"}