@f-o-t/markdown 1.0.3 → 1.0.6

package/dist/inline-parser.d.ts

@@ -0,0 +1,13 @@
+import type { InlineNode } from "./schemas";
+/**
+ * Parses inline content and returns AST nodes.
+ *
+ * @param text - The inline content to parse
+ * @param references - Link reference definitions
+ * @returns Array of inline nodes
+ */
+export declare function parseInline(text: string, references?: Map<string, {
+    url: string;
+    title?: string;
+}>): InlineNode[];
+//# sourceMappingURL=inline-parser.d.ts.map

package/dist/inline-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline-parser.d.ts","sourceRoot":"","sources":["../src/inline-parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAo8B5C;;;;;;GAMG;AACH,wBAAgB,WAAW,CACxB,IAAI,EAAE,MAAM,EACZ,UAAU,GAAE,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAa,GACpE,UAAU,EAAE,CAKd"}

package/dist/parser.d.ts

@@ -0,0 +1,185 @@
+import { type MarkdownDocument, type ParseOptions } from "./schemas";
+import type { ParseResult } from "./types";
+/**
+ * Parses markdown content and returns a result object.
+ *
+ * @param content - The markdown string to parse
+ * @param options - Parsing options
+ * @returns A ParseResult containing either the parsed document or an error
+ *
+ * @example
+ * ```typescript
+ * const result = parse("# Hello World");
+ * if (result.success) {
+ *   console.log(result.data.root.children);
+ * }
+ * ```
+ */
+export declare function parse(content: string, options?: ParseOptions): ParseResult<MarkdownDocument>;
+/**
+ * Parses markdown content and throws on error.
+ *
+ * @param content - The markdown string to parse
+ * @param options - Parsing options
+ * @returns The parsed markdown document
+ * @throws Error if parsing fails or options are invalid
+ *
+ * @example
+ * ```typescript
+ * const doc = parseOrThrow("# Hello World");
+ * console.log(doc.root.children);
+ * ```
+ */
+export declare function parseOrThrow(content: string, options?: ParseOptions): MarkdownDocument;
+/**
+ * Parses markdown from a buffer with automatic encoding detection.
+ *
+ * @param buffer - The buffer containing markdown data
+ * @param options - Parsing options
+ * @returns A ParseResult containing either the parsed document or an error
+ *
+ * @example
+ * ```typescript
+ * const buffer = new Uint8Array([...]);
+ * const result = parseBuffer(buffer);
+ * if (result.success) {
+ *   console.log(result.data.root.children);
+ * }
+ * ```
+ */
+export declare function parseBuffer(buffer: Uint8Array, options?: ParseOptions): ParseResult<MarkdownDocument>;
+/**
+ * Parses markdown from a buffer with automatic encoding detection.
+ * Throws on error.
+ *
+ * @param buffer - The buffer containing markdown data
+ * @param options - Parsing options
+ * @returns The parsed markdown document
+ * @throws Error if parsing fails
+ *
+ * @example
+ * ```typescript
+ * const buffer = new Uint8Array([...]);
+ * const doc = parseBufferOrThrow(buffer);
+ * console.log(doc.root.children);
+ * ```
+ */
+export declare function parseBufferOrThrow(buffer: Uint8Array, options?: ParseOptions): MarkdownDocument;
+/**
+ * Parses markdown and returns just the AST root node.
+ *
+ * @param content - The markdown string to parse
+ * @param options - Parsing options
+ * @returns The root document node
+ *
+ * @example
+ * ```typescript
+ * const root = parseToAst("# Hello");
+ * console.log(root.type); // "document"
+ * ```
+ */
+export declare function parseToAst(content: string, options?: ParseOptions): MarkdownDocument["root"];
+/**
+ * Checks if the given content is valid markdown (doesn't throw during parsing).
+ *
+ * @param content - The content to check
+ * @returns True if the content can be parsed as markdown
+ *
+ * @example
+ * ```typescript
+ * isValidMarkdown("# Hello"); // true
+ * isValidMarkdown("anything"); // true (markdown is very permissive)
+ * ```
+ */
+export declare function isValidMarkdown(content: string): boolean;
+/**
+ * Extracts all text content from a markdown document (strips formatting).
+ *
+ * @param content - The markdown string
+ * @returns Plain text content
+ *
+ * @example
+ * ```typescript
+ * extractText("**Hello** *world*"); // "Hello world"
+ * ```
+ */
+export declare function extractText(content: string): string;
+/**
+ * Counts the number of words in a markdown document.
+ *
+ * @param content - The markdown string
+ * @returns Word count
+ *
+ * @example
+ * ```typescript
+ * countWords("Hello **world**!"); // 2
+ * ```
+ */
+export declare function countWords(content: string): number;
+/**
+ * Gets headings from a markdown document.
+ *
+ * @param content - The markdown string
+ * @returns Array of heading info
+ *
+ * @example
+ * ```typescript
+ * getHeadings("# Title\n## Section");
+ * // [{ level: 1, text: "Title" }, { level: 2, text: "Section" }]
+ * ```
+ */
+export declare function getHeadings(content: string): Array<{
+    level: number;
+    text: string;
+}>;
+/**
+ * Gets all links from a markdown document.
+ *
+ * @param content - The markdown string
+ * @returns Array of link info
+ *
+ * @example
+ * ```typescript
+ * getLinks("[Example](https://example.com)");
+ * // [{ text: "Example", url: "https://example.com" }]
+ * ```
+ */
+export declare function getLinks(content: string): Array<{
+    text: string;
+    url: string;
+    title?: string;
+}>;
+/**
+ * Gets all images from a markdown document.
+ *
+ * @param content - The markdown string
+ * @returns Array of image info
+ *
+ * @example
+ * ```typescript
+ * getImages("![Alt text](image.png)");
+ * // [{ alt: "Alt text", url: "image.png" }]
+ * ```
+ */
+export declare function getImages(content: string): Array<{
+    alt: string;
+    url: string;
+    title?: string;
+}>;
+/**
+ * Gets all code blocks from a markdown document.
+ *
+ * @param content - The markdown string
+ * @returns Array of code block info
+ *
+ * @example
+ * ```typescript
+ * getCodeBlocks("```js\nconsole.log('hi');\n```");
+ * // [{ lang: "js", code: "console.log('hi');" }]
+ * ```
+ */
+export declare function getCodeBlocks(content: string): Array<{
+    lang?: string;
+    code: string;
+}>;
+//# sourceMappingURL=parser.d.ts.map

package/dist/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AACA,OAAO,EAGJ,KAAK,gBAAgB,EACrB,KAAK,YAAY,EAEnB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAU3C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,KAAK,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY,GACtB,WAAW,CAAC,gBAAgB,CAAC,CAU/B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY,GACtB,gBAAgB,CAqElB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACxB,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,YAAY,GACtB,WAAW,CAAC,gBAAgB,CAAC,CAU/B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAC/B,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,YAAY,GACtB,gBAAgB,CAGlB;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,YAAY,GACtB,gBAAgB,CAAC,MAAM,CAAC,CAE1B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAGxD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGnD;AAyBD;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CACxB,OAAO,EAAE,MAAM,GACf,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBxC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACrB,OAAO,EAAE,MAAM,GACf,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBtD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CACtB,OAAO,EAAE,MAAM,GACf,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAkBrD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC1B,OAAO,EAAE,MAAM,GACf,KAAK,CAAC;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAkBxC"}