@bendyline/squisq 0.1.2 → 1.0.1

package/dist/markdown/parse.js

@@ -0,0 +1,90 @@
+/**
+ * Markdown → JSON Parser
+ *
+ * Parses a markdown string into a MarkdownDocument JSON structure
+ * using the unified/remark ecosystem with GFM, math, and directive extensions.
+ */
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkGfm from 'remark-gfm';
+import remarkMath from 'remark-math';
+import remarkDirective from 'remark-directive';
+import remarkFrontmatter from 'remark-frontmatter';
+import { fromMdast } from './convert.js';
+import { parseFrontmatter } from './utils.js';
+// Cache the default processor (all extensions enabled) to avoid rebuilding on every call.
+let defaultProcessor;
+/**
+ * Parse a markdown string into a MarkdownDocument.
+ *
+ * All extensions (GFM, math, directives) are enabled by default.
+ * Use the `options` parameter to disable specific extensions.
+ *
+ * @param markdown - The markdown source text
+ * @param options - Parser options (extensions, HTML parsing)
+ * @returns A MarkdownDocument representing the parsed markdown
+ *
+ * @example
+ * ```ts
+ * const doc = parseMarkdown('# Hello\n\nWorld **bold** and *italic*');
+ * // doc.type === 'document'
+ * // doc.children[0].type === 'heading'
+ * // doc.children[1].type === 'paragraph'
+ * ```
+ */
+export function parseMarkdown(markdown, options) {
+    // Use cached default processor when all extensions are enabled (the common case).
+    const useDefaults = !options ||
+        (options.gfm !== false &&
+            options.math !== false &&
+            options.directive !== false &&
+            options.frontmatter !== false);
+    let processor;
+    if (useDefaults) {
+        if (!defaultProcessor) {
+            defaultProcessor = unified()
+                .use(remarkParse)
+                .use(remarkGfm)
+                .use(remarkMath)
+                .use(remarkDirective)
+                .use(remarkFrontmatter, ['yaml']);
+        }
+        processor = defaultProcessor;
+    }
+    else {
+        // Build a custom processor with requested extensions.
+        // unified's .use() chaining changes the generic signature each time,
+        // making strict typing impractical — use a widened Processor type.
+        processor = unified().use(remarkParse);
+        if (options?.gfm !== false) {
+            processor = processor.use(remarkGfm);
+        }
+        if (options?.math !== false) {
+            processor = processor.use(remarkMath);
+        }
+        if (options?.directive !== false) {
+            processor = processor.use(remarkDirective);
+        }
+        if (options?.frontmatter !== false) {
+            processor = processor.use(remarkFrontmatter, ['yaml']);
+        }
+    }
+    // Parse markdown → mdast tree (result is an mdast Root node)
+    const mdastTree = processor.parse(markdown);
+    // Convert mdast → MarkdownDocument
+    const doc = fromMdast(mdastTree, {
+        parseHtml: options?.parseHtml,
+    });
+    // Extract YAML frontmatter if present
+    if (options?.frontmatter !== false) {
+        const yamlNode = mdastTree.children?.find((n) => n.type === 'yaml');
+        if (yamlNode?.value) {
+            const fm = parseFrontmatter(yamlNode.value);
+            if (fm && Object.keys(fm).length > 0) {
+                doc.frontmatter = fm;
+            }
+        }
+    }
+    return doc;
+}
+//# sourceMappingURL=parse.js.map

package/dist/markdown/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/markdown/parse.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,0FAA0F;AAC1F,IAAI,gBAAqB,CAAC;AAE1B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,OAAsB;IACpE,kFAAkF;IAClF,MAAM,WAAW,GACf,CAAC,OAAO;QACR,CAAC,OAAO,CAAC,GAAG,KAAK,KAAK;YACpB,OAAO,CAAC,IAAI,KAAK,KAAK;YACtB,OAAO,CAAC,SAAS,KAAK,KAAK;YAC3B,OAAO,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC;IAEnC,IAAI,SAAc,CAAC;IAEnB,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,gBAAgB,GAAG,OAAO,EAAE;iBACzB,GAAG,CAAC,WAAW,CAAC;iBAChB,GAAG,CAAC,SAAS,CAAC;iBACd,GAAG,CAAC,UAAU,CAAC;iBACf,GAAG,CAAC,eAAe,CAAC;iBACpB,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;QACD,SAAS,GAAG,gBAAgB,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,sDAAsD;QACtD,qEAAqE;QACrE,mEAAmE;QACnE,SAAS,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAEvC,IAAI,OAAO,EAAE,GAAG,KAAK,KAAK,EAAE,CAAC;YAC3B,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,OAAO,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;YAC5B,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,KAAK,KAAK,EAAE,CAAC;YACjC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,OAAO,EAAE,WAAW,KAAK,KAAK,EAAE,CAAC;YACnC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,6DAA6D;IAC7D,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAGzC,CAAC;IAEF,mCAAmC;IACnC,MAAM,GAAG,GAAG,SAAS,CAAC,SAA4C,EAAE;QAClE,SAAS,EAAE,OAAO,EAAE,SAAS;KAC9B,CAAC,CAAC;IAEH,sCAAsC;IACtC,IAAI,OAAO,EAAE,WAAW,KAAK,KAAK,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;QACpE,IAAI,QAAQ,EAAE,KAAK,EAAE,CAAC;YACpB,MAAM,EAAE,GAAG,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5C,IAAI,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrC,GAAG,CAAC,WAAW,GAAG,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/markdown/stringify.d.ts

@@ -0,0 +1,32 @@
+/**
+ * JSON → Markdown Serializer
+ *
+ * Converts a MarkdownDocument JSON structure back to a markdown string
+ * using the unified/remark ecosystem with GFM, math, and directive extensions.
+ */
+import type { MarkdownDocument, StringifyOptions } from './types.js';
+/**
+ * Serialize a MarkdownDocument back to a markdown string.
+ *
+ * All extensions (GFM, math, directives) are enabled by default.
+ * Use the `options` parameter to control formatting and disable extensions.
+ *
+ * @param doc - The MarkdownDocument to serialize
+ * @param options - Serialization options (formatting, extensions)
+ * @returns A markdown string
+ *
+ * @example
+ * ```ts
+ * const doc: MarkdownDocument = {
+ *   type: 'document',
+ *   children: [
+ *     { type: 'heading', depth: 1, children: [{ type: 'text', value: 'Hello' }] },
+ *     { type: 'paragraph', children: [{ type: 'text', value: 'World' }] },
+ *   ],
+ * };
+ * const md = stringifyMarkdown(doc);
+ * // '# Hello\n\nWorld\n'
+ * ```
+ */
+export declare function stringifyMarkdown(doc: MarkdownDocument, options?: StringifyOptions): string;
+//# sourceMappingURL=stringify.d.ts.map

package/dist/markdown/stringify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.d.ts","sourceRoot":"","sources":["../../src/markdown/stringify.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAMrE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAgF3F"}

package/dist/markdown/stringify.js

@@ -0,0 +1,108 @@
+/**
+ * JSON → Markdown Serializer
+ *
+ * Converts a MarkdownDocument JSON structure back to a markdown string
+ * using the unified/remark ecosystem with GFM, math, and directive extensions.
+ */
+import { unified } from 'unified';
+import remarkStringify from 'remark-stringify';
+import remarkGfm from 'remark-gfm';
+import remarkMath from 'remark-math';
+import remarkDirective from 'remark-directive';
+import { toMdast } from './convert.js';
+// Cache the default processor (all extensions, default formatting) to avoid rebuilding on every call.
+let defaultProcessor;
+/**
+ * Serialize a MarkdownDocument back to a markdown string.
+ *
+ * All extensions (GFM, math, directives) are enabled by default.
+ * Use the `options` parameter to control formatting and disable extensions.
+ *
+ * @param doc - The MarkdownDocument to serialize
+ * @param options - Serialization options (formatting, extensions)
+ * @returns A markdown string
+ *
+ * @example
+ * ```ts
+ * const doc: MarkdownDocument = {
+ *   type: 'document',
+ *   children: [
+ *     { type: 'heading', depth: 1, children: [{ type: 'text', value: 'Hello' }] },
+ *     { type: 'paragraph', children: [{ type: 'text', value: 'World' }] },
+ *   ],
+ * };
+ * const md = stringifyMarkdown(doc);
+ * // '# Hello\n\nWorld\n'
+ * ```
+ */
+export function stringifyMarkdown(doc, options) {
+    // Convert MarkdownDocument → mdast tree
+    const mdastTree = toMdast(doc);
+    // Use cached default processor when all extensions and default formatting are used.
+    const useDefaults = !options ||
+        (options.gfm !== false &&
+            options.math !== false &&
+            options.directive !== false &&
+            !options.bullet &&
+            !options.bulletOrdered &&
+            !options.emphasis &&
+            !options.strong &&
+            !options.rule &&
+            !options.fence &&
+            options.setext == null);
+    let processor;
+    if (useDefaults) {
+        if (!defaultProcessor) {
+            defaultProcessor = unified()
+                .use(remarkGfm)
+                .use(remarkMath)
+                .use(remarkDirective)
+                .use(remarkStringify, {
+                bullet: '-',
+                bulletOrdered: '.',
+                emphasis: '*',
+                strong: '*',
+                rule: '-',
+                fence: '`',
+                setext: false,
+            });
+        }
+        processor = defaultProcessor;
+    }
+    else {
+        // Build a custom processor with requested options.
+        // unified's .use() chaining changes the generic signature each time,
+        // making strict typing impractical — use a widened Processor type.
+        processor = unified();
+        if (options?.gfm !== false) {
+            processor = processor.use(remarkGfm);
+        }
+        if (options?.math !== false) {
+            processor = processor.use(remarkMath);
+        }
+        if (options?.directive !== false) {
+            processor = processor.use(remarkDirective);
+        }
+        processor = processor.use(remarkStringify, {
+            bullet: options?.bullet ?? '-',
+            bulletOrdered: options?.bulletOrdered ?? '.',
+            emphasis: options?.emphasis ?? '*',
+            strong: options?.strong ?? '*',
+            rule: options?.rule ?? '-',
+            fence: options?.fence ?? '`',
+            setext: options?.setext ?? false,
+        });
+    }
+    // Stringify mdast → markdown string
+    const result = processor.stringify(mdastTree);
+    // remark-stringify escapes `[` in text nodes (to prevent link syntax),
+    // which turns `{[template]}` into `{\[template]}`. Unescape our annotation syntax.
+    const cleaned = result.replace(/\{\\\[([^\]]+)\]\}/g, '{[$1]}');
+    // Prepend YAML frontmatter if present
+    if (doc.frontmatter && Object.keys(doc.frontmatter).length > 0) {
+        const yamlLines = Object.entries(doc.frontmatter).map(([k, v]) => `${k}: ${typeof v === 'string' ? v : JSON.stringify(v)}`);
+        return `---\n${yamlLines.join('\n')}\n---\n\n${cleaned}`;
+    }
+    return cleaned;
+}
+//# sourceMappingURL=stringify.js.map

package/dist/markdown/stringify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.js","sourceRoot":"","sources":["../../src/markdown/stringify.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,sGAAsG;AACtG,IAAI,gBAAqB,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAqB,EAAE,OAA0B;IACjF,wCAAwC;IACxC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE/B,oFAAoF;IACpF,MAAM,WAAW,GACf,CAAC,OAAO;QACR,CAAC,OAAO,CAAC,GAAG,KAAK,KAAK;YACpB,OAAO,CAAC,IAAI,KAAK,KAAK;YACtB,OAAO,CAAC,SAAS,KAAK,KAAK;YAC3B,CAAC,OAAO,CAAC,MAAM;YACf,CAAC,OAAO,CAAC,aAAa;YACtB,CAAC,OAAO,CAAC,QAAQ;YACjB,CAAC,OAAO,CAAC,MAAM;YACf,CAAC,OAAO,CAAC,IAAI;YACb,CAAC,OAAO,CAAC,KAAK;YACd,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;IAE5B,IAAI,SAAc,CAAC;IAEnB,IAAI,WAAW,EAAE,CAAC;QAChB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,gBAAgB,GAAG,OAAO,EAAE;iBACzB,GAAG,CAAC,SAAS,CAAC;iBACd,GAAG,CAAC,UAAU,CAAC;iBACf,GAAG,CAAC,eAAe,CAAC;iBACpB,GAAG,CAAC,eAAe,EAAE;gBACpB,MAAM,EAAE,GAAG;gBACX,aAAa,EAAE,GAAG;gBAClB,QAAQ,EAAE,GAAG;gBACb,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,GAAG;gBACV,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;QACP,CAAC;QACD,SAAS,GAAG,gBAAgB,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,mDAAmD;QACnD,qEAAqE;QACrE,mEAAmE;QACnE,SAAS,GAAG,OAAO,EAAE,CAAC;QAEtB,IAAI,OAAO,EAAE,GAAG,KAAK,KAAK,EAAE,CAAC;YAC3B,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,OAAO,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;YAC5B,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,KAAK,KAAK,EAAE,CAAC;YACjC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7C,CAAC;QAED,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,eAAe,EAAE;YACzC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG;YAC9B,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,GAAG;YAC5C,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,GAAG;YAClC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG;YAC9B,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,GAAG;YAC1B,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG;YAC5B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;SACjC,CAAC,CAAC;IACL,CAAC;IAED,oCAAoC;IACpC,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAW,CAAC;IAExD,uEAAuE;IACvE,mFAAmF;IACnF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;IAEhE,sCAAsC;IACtC,IAAI,GAAG,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/D,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CACnD,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CACrE,CAAC;QACF,OAAO,QAAQ,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}