@orkestrel/markdown 0.0.1 → 0.0.2

package/dist/src/core/Markdown.d.ts

@@ -1,4 +1,4 @@
-import type { BlockNode, MarkdownDocument, MarkdownHandlers, MarkdownInterface, MarkdownNode, MarkdownRewriteHandler } from './types.js';
+import { BlockNode, MarkdownDocument, MarkdownHandlers, MarkdownInterface, MarkdownNode, MarkdownRewriteHandler } from './types.js';
 /**
  * A stateful, parsed markdown document - wraps a typed {@link MarkdownDocument} AST
  * with the query (`find` / `filter` / `reduce` / iteration), rewrite (`map`), fold, and

package/dist/src/core/factories.d.ts

@@ -1,5 +1,5 @@
-import type { ContractInterface } from '@orkestrel/contract';
-import type { CodeBlockNode, CodeSpanNode, MarkdownDocument, MarkdownInterface, TextNode, ThematicBreakNode } from './types.js';
+import { ContractInterface } from '@orkestrel/contract';
+import { CodeBlockNode, CodeSpanNode, MarkdownDocument, MarkdownInterface, TextNode, ThematicBreakNode } from './types.js';
 /**
  * Create a stateful markdown handle from a markdown string or an already-parsed
  * {@link MarkdownDocument} - a typed AST plus the query, rewrite, and fold operations

package/dist/src/core/helpers.d.ts

@@ -1,4 +1,4 @@
-import type { EmphasisNode, InlineNode, LinkNode, ListItemParts, MarkdownDocument, MarkdownHandlers, MarkdownNode, MarkdownRewriteHandler, TableAlign } from './types.js';
+import { EmphasisNode, InlineNode, LinkNode, ListItemParts, MarkdownDocument, MarkdownHandlers, MarkdownNode, MarkdownRewriteHandler, TableAlign } from './types.js';
 /**
  * Normalize line endings to `\n` and split a markdown document into its lines - CRLF
  * (`\r\n`) and bare CR (`\r`) both collapse to `\n` first, so a Windows-origin
@@ -7,6 +7,11 @@ import type { EmphasisNode, InlineNode, LinkNode, ListItemParts, MarkdownDocumen
  *
  * @param markdown - The raw markdown source
  * @returns The document's lines, line-terminators stripped
+ *
+ * @example
+ * ```ts
+ * splitLines('a\r\nb\nc') // ['a', 'b', 'c']
+ * ```
  */
 export declare function splitLines(markdown: string): readonly string[];
 /**
@@ -15,6 +20,11 @@ export declare function splitLines(markdown: string): readonly string[];
  *
  * @param line - The line to measure
  * @returns The number of leading space / tab characters
+ *
+ * @example
+ * ```ts
+ * leadingIndent('  text') // 2
+ * ```
  */
 export declare function leadingIndent(line: string): number;
 /**
@@ -25,6 +35,11 @@ export declare function leadingIndent(line: string): number;
  *
  * @param line - The candidate line
  * @returns The heading level (1–6) and its raw inline text, or `undefined`
+ *
+ * @example
+ * ```ts
+ * extractHeading('## Title') // { level: 2, text: 'Title' }
+ * ```
  */
 export declare function extractHeading(line: string): {
     readonly level: number;
@@ -38,6 +53,11 @@ export declare function extractHeading(line: string): {
  *
  * @param line - The candidate line
  * @returns The fence marker run and its language tag, or `undefined`
+ *
+ * @example
+ * ```ts
+ * extractFence('```ts') // { marker: '```', lang: 'ts' }
+ * ```
  */
 export declare function extractFence(line: string): {
     readonly marker: string;
@@ -51,6 +71,11 @@ export declare function extractFence(line: string): {
  *
  * @param line - The candidate line
  * @returns The list-item parts, or `undefined` when not a list item
+ *
+ * @example
+ * ```ts
+ * extractListItem('- item') // { ordered: false, start: 1, content: 'item', indent: 0, marker: 2 }
+ * ```
  */
 export declare function extractListItem(line: string): ListItemParts | undefined;
 /**
@@ -59,6 +84,11 @@ export declare function extractListItem(line: string): ListItemParts | undefined
  *
  * @param line - A blockquote line (per {@link isQuote})
  * @returns The line with its leading `>` (and one space) removed
+ *
+ * @example
+ * ```ts
+ * stripQuote('> text') // 'text'
+ * ```
  */
 export declare function stripQuote(line: string): string;
 /**
@@ -68,6 +98,11 @@ export declare function stripQuote(line: string): string;
  *
  * @param row - The raw table row line
  * @returns The row's cells, in column order
+ *
+ * @example
+ * ```ts
+ * splitTableRow('|a|b|') // ['a', 'b']
+ * ```
  */
 export declare function splitTableRow(row: string): readonly string[];
 /**
@@ -76,6 +111,11 @@ export declare function splitTableRow(row: string): readonly string[];
  *
  * @param delimiter - The table's delimiter row
  * @returns One alignment per column, in column order
+ *
+ * @example
+ * ```ts
+ * tableAlignments('| :--- | ---: |') // ['left', 'right']
+ * ```
  */
 export declare function tableAlignments(delimiter: string): readonly TableAlign[];
 /**
@@ -88,6 +128,11 @@ export declare function tableAlignments(delimiter: string): readonly TableAlign[
  * @param lines - The document's lines
  * @param index - The line index to test
  * @returns `true` when the line begins a different block
+ *
+ * @example
+ * ```ts
+ * startsBlock(['text', '## Heading'], 1) // true
+ * ```
  */
 export declare function startsBlock(lines: readonly string[], index: number): boolean;
 /**
@@ -96,6 +141,11 @@ export declare function startsBlock(lines: readonly string[], index: number): bo
  *
  * @param text - The raw text possibly carrying `\x` escapes
  * @returns The text with escapable `\x` reduced to `x`
+ *
+ * @example
+ * ```ts
+ * unescapeText('\\*hi\\*') // '*hi*'
+ * ```
  */
 export declare function unescapeText(text: string): string;
 /**
@@ -104,6 +154,12 @@ export declare function unescapeText(text: string): string;
  *
  * @param nodes - The inline nodes (possibly with adjacent text runs)
  * @returns The nodes with consecutive text nodes concatenated
+ *
+ * @example
+ * ```ts
+ * coalesceText([{ element: 'text', value: 'a' }, { element: 'text', value: 'b' }])
+ * // [{ element: 'text', value: 'ab' }]
+ * ```
  */
 export declare function coalesceText(nodes: readonly InlineNode[]): readonly InlineNode[];
 /**
@@ -116,6 +172,11 @@ export declare function coalesceText(nodes: readonly InlineNode[]): readonly Inl
  * @param start - The index of the opening backtick
  * @param to - The exclusive end of the scan window
  * @returns The span text + end index, or `undefined`
+ *
+ * @example
+ * ```ts
+ * scanCode('`code`', 0, 6) // { value: 'code', end: 6 }
+ * ```
  */
 export declare function scanCode(source: string, start: number, to: number): {
     readonly value: string;
@@ -134,6 +195,12 @@ export declare function scanCode(source: string, start: number, to: number): {
  *   at {@link MAX_DEPTH} the link's text children degrade to literal text instead of
  *   recursing further
  * @returns The parsed {@link LinkNode} + end index, or `undefined`
+ *
+ * @example
+ * ```ts
+ * scanLink('[text](url)', 0, 11)
+ * // { node: { element: 'link', href: 'url', children: [...] }, end: 11 }
+ * ```
  */
 export declare function scanLink(source: string, start: number, to: number, depth?: number): {
     readonly node: LinkNode;
@@ -153,6 +220,12 @@ export declare function scanLink(source: string, start: number, to: number, dept
  *   at {@link MAX_DEPTH} the emphasis's children degrade to literal text instead of
  *   recursing further
  * @returns The parsed {@link EmphasisNode} + end index, or `undefined`
+ *
+ * @example
+ * ```ts
+ * scanEmphasis('*em*', 0, 4)
+ * // { node: { element: 'emphasis', strong: false, children: [...] }, end: 4 }
+ * ```
  */
 export declare function scanEmphasis(source: string, start: number, to: number, depth?: number): {
     readonly node: EmphasisNode;
@@ -173,6 +246,11 @@ export declare function scanEmphasis(source: string, start: number, to: number,
  *   it emits as a single literal text node - so pathological nesting (`[[[[…`,
  *   `****…`) cannot exhaust the call stack.
  * @returns The parsed inline nodes (NOT yet coalesced)
+ *
+ * @example
+ * ```ts
+ * scanInline('hi *there*', 0, 10) // [{ element: 'text', value: 'hi ' }, { element: 'emphasis', ... }]
+ * ```
  */
 export declare function scanInline(source: string, from: number, to: number, depth?: number): readonly InlineNode[];
 /**
@@ -182,6 +260,11 @@ export declare function scanInline(source: string, from: number, to: number, dep
  *
  * @param text - The raw text
  * @returns The HTML-escaped text
+ *
+ * @example
+ * ```ts
+ * escapeHtml('<a>&"\'') // '&lt;a&gt;&amp;&quot;&#39;'
+ * ```
  */
 export declare function escapeHtml(text: string): string;
 /**
@@ -197,6 +280,12 @@ export declare function escapeHtml(text: string): string;
  *
  * @param href - The raw link destination
  * @returns A safe, escaped `href` (empty when the scheme is unsafe or protocol-relative)
+ *
+ * @example
+ * ```ts
+ * sanitizeUrl('javascript:alert(1)') // ''
+ * sanitizeUrl('/path')               // '/path'
+ * ```
  */
 export declare function sanitizeUrl(href: string): string;
 /**