markdown-to-slack-blocks 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 https://github.com/udivankin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,131 @@
+# Markdown to Slack Blocks
+
+A powerful library to convert Markdown text into Slack's Block Kit JSON format.
+
+## Motivation
+
+While Slack does offer native [markdown support in blocks](https://api.slack.com/reference/surfaces/formatting#basics), there are significant limitations. The following markdown features are **not supported** by Slack's native markdown:
+
+- **Code blocks with syntax highlighting** — Slack renders code blocks but ignores language hints
+- **Horizontal rules** — No native support for `---` or `***` dividers
+- **Tables** — Markdown tables are not rendered
+- **Task lists** — Checkbox-style lists (`- [ ]`, `- [x]`) are not recognized
+
+This library is particularly useful for apps that leverage **platform AI features** where you expect a **markdown response from an LLM**. Instead of sending raw markdown that Slack can't fully render, this library converts it to proper Block Kit JSON that displays correctly.
+
+## How It Works
+
+This library uses a two-step conversion process:
+
+1. **Markdown → AST**: The markdown string is parsed into an Abstract Syntax Tree (AST) using [mdast-util-from-markdown](https://github.com/syntax-tree/mdast-util-from-markdown), with GitHub Flavored Markdown (GFM) support via [mdast-util-gfm](https://github.com/syntax-tree/mdast-util-gfm).
+
+2. **AST → Slack Blocks**: The AST is traversed and converted into Slack's Block Kit JSON format, mapping markdown elements to their corresponding Slack block types and rich text elements.
+
+### Key Libraries
+
+- **[mdast-util-from-markdown](https://github.com/syntax-tree/mdast-util-from-markdown)** — Parses markdown into an AST
+- **[mdast-util-gfm](https://github.com/syntax-tree/mdast-util-gfm)** — Adds GitHub Flavored Markdown support (tables, strikethrough, task lists)
+- **[micromark-extension-gfm](https://github.com/micromark/micromark-extension-gfm)** — Micromark extension for GFM syntax
+- **[mdast-util-to-string](https://github.com/syntax-tree/mdast-util-to-string)** — Extracts plain text from AST nodes
+
+## Supported Output
+
+### Blocks
+
+| Block Type | Description |
+|------------|-------------|
+| `rich_text` | Primary block type for formatted text content |
+| `header` | H1 headings rendered as header blocks |
+| `divider` | Horizontal rules converted to divider blocks |
+| `image` | Standalone images |
+| `section` | Text sections with optional accessories |
+| `context` | Smaller context text and images |
+| `table` | Table data (converted from markdown tables) |
+
+### Rich Text Elements
+
+| Element Type | Description |
+|--------------|-------------|
+| `rich_text_section` | Container for inline text elements |
+| `rich_text_list` | Ordered and unordered lists (supports nesting) |
+| `rich_text_preformatted` | Code blocks |
+| `rich_text_quote` | Blockquotes |
+
+### Rich Text Section Elements
+
+| Element Type | Description |
+|--------------|-------------|
+| `text` | Plain text with optional styling (bold, italic, strike, code) |
+| `link` | Hyperlinks |
+| `emoji` | Emoji shortcodes (`:emoji_name:`) |
+| `user` | User mentions (`@username`) |
+| `channel` | Channel mentions (`#channel`) |
+| `usergroup` | User group mentions |
+| `team` | Team mentions |
+| `broadcast` | Broadcast mentions (`@here`, `@channel`, `@everyone`) |
+| `date` | Formatted date objects |
+| `color` | Color values (when `detectColors` is enabled) |
+
+### Text Styles
+
+| Style | Markdown Syntax |
+|-------|-----------------|
+| **Bold** | `**text**` or `__text__` |
+| *Italic* | `*text*` or `_text_` |
+| ~~Strikethrough~~ | `~~text~~` |
+| `Code` | `` `text` `` |
+
+## Features
+
+- **Standard Markdown Support**: Converts headings, lists, bold, italic, code blocks, blockquotes, and links.
+- **Slack-Specific Extensions**: Support for user mentions, channel mentions, user groups, and team mentions.
+- **Configurable**: Options to customize behavior, such as color detection.
+- **Type-Safe**: Written in TypeScript with full type definitions.
+
+## Installation
+
+```bash
+npm install markdown-to-slack-blocks
+```
+
+## Usage
+
+```typescript
+import { markdownToBlocks } from 'markdown-to-slack-blocks';
+
+const markdown = `
+# Hello World
+This is a **bold** statement.
+`;
+
+const blocks = markdownToBlocks(markdown);
+console.log(JSON.stringify(blocks, null, 2));
+```
+
+### Options
+
+You can pass an options object to `markdownToBlocks`, otherwise the mentions will be rendered as text:
+
+```typescript
+const options = {
+    mentions: {
+        users: { 'username': 'U123456' },
+        channels: { 'general': 'C123456' },
+        userGroups: { 'engineers': 'S123456' },
+        teams: { 'myteam': 'T123456' }
+    },
+    detectColors: true
+};
+
+const blocks = markdownToBlocks(markdown, options);
+```
+
+### Validation
+
+The library validates that the IDs provided in the `mentions` option adhere to Slack's ID format:
+- **User IDs**: Must start with `U` or `W`.
+- **Channel IDs**: Must start with `C`.
+- **User Group IDs**: Must start with `S`.
+- **Team IDs**: Must start with `T`.
+
+All IDs must be alphanumeric.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { MarkdownToBlocksOptions } from './types';
+export * from './types';
+export declare function markdownToBlocks(markdown: string, options?: MarkdownToBlocksOptions): import("./types").Block[];
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAIlD,cAAc,SAAS,CAAC;AAExB,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,6BAGnF"}

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markdownToBlocks = markdownToBlocks;
+const parser_1 = require("./parser");
+const validator_1 = require("./validator");
+// Re-export types for consumers
+__exportStar(require("./types"), exports);
+function markdownToBlocks(markdown, options) {
+    (0, validator_1.validateOptions)(options);
+    return (0, parser_1.parseMarkdown)(markdown, options);
+}

package/dist/parser.d.ts

@@ -0,0 +1,3 @@
+import { Block, MarkdownToBlocksOptions } from './types';
+export declare function parseMarkdown(markdown: string, options?: MarkdownToBlocksOptions): Block[];
+//# 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":"AAIA,OAAO,EACH,KAAK,EAKL,uBAAuB,EAG1B,MAAM,SAAS,CAAC;AAEjB,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B,GAAG,KAAK,EAAE,CAyK9F"}

package/dist/parser.js

@@ -0,0 +1,361 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseMarkdown = parseMarkdown;
+const mdast_util_from_markdown_1 = require("mdast-util-from-markdown");
+const mdast_util_to_string_1 = require("mdast-util-to-string");
+const micromark_extension_gfm_1 = require("micromark-extension-gfm");
+const mdast_util_gfm_1 = require("mdast-util-gfm");
+function parseMarkdown(markdown, options = {}) {
+    const ast = (0, mdast_util_from_markdown_1.fromMarkdown)(markdown, {
+        extensions: [(0, micromark_extension_gfm_1.gfm)()],
+        mdastExtensions: [(0, mdast_util_gfm_1.gfmFromMarkdown)()],
+    });
+    const blocks = [];
+    let currentRichTextElements = [];
+    const flushRichText = () => {
+        if (currentRichTextElements.length > 0) {
+            blocks.push({
+                type: 'rich_text',
+                elements: [...currentRichTextElements],
+            });
+            currentRichTextElements = [];
+        }
+    };
+    for (const node of ast.children) {
+        if (node.type === 'heading') {
+            flushRichText();
+            const text = (0, mdast_util_to_string_1.toString)(node);
+            if (node.depth <= 2) {
+                blocks.push({
+                    type: 'header',
+                    text: {
+                        type: 'plain_text',
+                        text: text,
+                    },
+                });
+            }
+            else {
+                blocks.push({
+                    type: 'rich_text',
+                    elements: [
+                        {
+                            type: 'rich_text_section',
+                            elements: [{ type: 'text', text: text, style: { bold: true } }],
+                        },
+                    ],
+                });
+            }
+        }
+        else if (node.type === 'paragraph') {
+            if (node.children.length === 1 && node.children[0].type === 'image') {
+                flushRichText();
+                const imageNode = node.children[0];
+                blocks.push({
+                    type: 'image',
+                    image_url: imageNode.url,
+                    alt_text: imageNode.alt || 'Image',
+                });
+            }
+            else {
+                currentRichTextElements.push({
+                    type: 'rich_text_section',
+                    elements: node.children.flatMap((child) => mapInlineNode(child, options)),
+                });
+            }
+        }
+        else if (node.type === 'list') {
+            // Helper function to recursively process lists with proper indentation
+            const processList = (listNode, indent) => {
+                const results = [];
+                const currentListItems = [];
+                for (const listItem of listNode.children) {
+                    // Process the paragraph content of this list item
+                    const paragraphElements = listItem.children
+                        .filter((child) => child.type === 'paragraph')
+                        .flatMap((child) => child.children.flatMap((c) => mapInlineNode(c, options)));
+                    if (paragraphElements.length > 0) {
+                        currentListItems.push({
+                            type: 'rich_text_section',
+                            elements: paragraphElements,
+                        });
+                    }
+                    // Process any nested lists (recursively)
+                    const nestedLists = listItem.children.filter((child) => child.type === 'list');
+                    if (nestedLists.length > 0) {
+                        // First, push the current list with items collected so far
+                        if (currentListItems.length > 0) {
+                            results.push({
+                                type: 'rich_text_list',
+                                style: listNode.ordered ? 'ordered' : 'bullet',
+                                indent,
+                                elements: [...currentListItems],
+                            });
+                            currentListItems.length = 0; // Clear the array
+                        }
+                        // Process each nested list
+                        for (const nestedList of nestedLists) {
+                            results.push(...processList(nestedList, indent + 1));
+                        }
+                    }
+                }
+                // Push any remaining items
+                if (currentListItems.length > 0) {
+                    results.push({
+                        type: 'rich_text_list',
+                        style: listNode.ordered ? 'ordered' : 'bullet',
+                        indent,
+                        elements: currentListItems,
+                    });
+                }
+                return results;
+            };
+            const listElements = processList(node, 0);
+            for (const listElement of listElements) {
+                currentRichTextElements.push(listElement);
+            }
+        }
+        else if (node.type === 'code') {
+            currentRichTextElements.push({
+                type: 'rich_text_preformatted',
+                elements: [{ type: 'text', text: node.value }],
+            });
+        }
+        else if (node.type === 'blockquote') {
+            currentRichTextElements.push({
+                type: 'rich_text_quote',
+                elements: node.children
+                    .flatMap((child) => {
+                    if (child.type === 'paragraph') {
+                        return child.children.flatMap((c) => mapInlineNode(c, options));
+                    }
+                    return [];
+                })
+            });
+        }
+        else if (node.type === 'thematicBreak') {
+            flushRichText();
+            blocks.push({ type: 'divider' });
+        }
+        else if (node.type === 'image') {
+            flushRichText();
+            blocks.push({
+                type: 'image',
+                image_url: node.url,
+                alt_text: node.alt || 'Image',
+            });
+        }
+        else if (node.type === 'table') {
+            flushRichText();
+            const rows = node.children.map((row) => {
+                return row.children.map((cell) => {
+                    return {
+                        type: 'rich_text',
+                        elements: [
+                            {
+                                type: 'rich_text_section',
+                                elements: cell.children.flatMap((c) => mapInlineNode(c, options)),
+                            },
+                        ],
+                    };
+                });
+            });
+            blocks.push({
+                type: 'table',
+                rows: rows,
+            });
+        }
+        else if (node.type === 'html') {
+            // Handle top-level HTML blocks (e.g. Slack specific tags like <!date...> starting a line)
+            currentRichTextElements.push({
+                type: 'rich_text_section',
+                elements: processTextNode(node.value, {}, options),
+            });
+        }
+    }
+    flushRichText();
+    return blocks;
+}
+function mapInlineNode(node, options) {
+    // console.log('Node:', node.type, node.value || node);
+    if (node.type === 'text' || node.type === 'html') {
+        // Pass empty object for style, processTextNode will handle it (and not attach if empty)
+        return processTextNode(node.value, {}, options);
+    }
+    else if (node.type === 'emphasis') {
+        return flattenStyles(node.children, { italic: true }, options);
+    }
+    else if (node.type === 'strong') {
+        return flattenStyles(node.children, { bold: true }, options);
+    }
+    else if (node.type === 'delete') {
+        return flattenStyles(node.children, { strike: true }, options);
+    }
+    else if (node.type === 'inlineCode') {
+        // inlineCode is text with code style
+        return processTextNode(node.value, { code: true }, options);
+    }
+    else if (node.type === 'link') {
+        return [{
+                type: 'link',
+                url: node.url,
+                text: (0, mdast_util_to_string_1.toString)(node),
+            }];
+    }
+    else if (node.type === 'image') {
+        return [{
+                type: 'link',
+                url: node.url,
+                text: node.alt || 'Image',
+            }];
+    }
+    return [];
+}
+function flattenStyles(children, style, options) {
+    const elements = children.flatMap(c => mapInlineNode(c, options));
+    return elements.map(el => {
+        const mergedStyle = { ...el.style, ...style };
+        // If the resulting style object is empty, do not attach it
+        if (Object.keys(mergedStyle).length > 0) {
+            return { ...el, style: mergedStyle };
+        }
+        // If it was empty before and we're not adding anything (shouldn't happen here if style has keys), just return
+        // But if el.style was undefined and style is {}, we want undefined.
+        // Logic: if mergedStyle has keys, use it. Else, if el had style, keep it? No, we want to flatten.
+        // Actually, if we merge {bold: true} with {}, we get {bold: true}.
+        // If we merge {} with {}, we get {}. We want to avoid {}.
+        const { style: _, ...rest } = el;
+        return rest;
+    });
+}
+function processTextNode(text, style, options) {
+    // Regex for:
+    // 1. Broadcast: <!here> | <!channel> | <!everyone>
+    // 2. Mention: <@U...>
+    // 3. Color: #123456
+    // 4. Channel: <#C...>
+    // 5. Team: <!subteam^T...>
+    // 6. Date: <!date^timestamp^format|fallback> (simple approx)
+    // 7. Emoji: :shortcode:
+    // 8. Mapped Mention: @name
+    // 9. Mapped Channel: #name
+    // Note: JS Regex stateful global matching
+    // We need to capture everything carefully.
+    // Groups:
+    // 1. Broadcast: (<!here>|<!channel>|<!everyone>)
+    // 2. Mention: (<@([\w.-]+)>)
+    // 3. Color: (#[0-9a-fA-F]{6})
+    // 4. Channel: (<#([\w.-]+)>)
+    // 5. Team: (<!subteam\^([\w.-]+)>)
+    // 6. Date: (<!date\^(\d+)\^([^|]+)\|([^>]+)>)
+    // 7. Emoji: (:([\w+-]+):)
+    // 8. Mapped Mention: (@([\w.-]+))
+    // 9. Mapped Channel: (#([\w.-]+))
+    const regex = /(<!here>|<!channel>|<!everyone>)|(<@([\w.-]+)>)|(#[0-9a-fA-F]{6})|(<#([\w.-]+)>)|(<!subteam\^([\w.-]+)>)|(<!date\^(\d+)\^([^|]+)\|([^>]+)>)|(:([\w+-]+):)|(@([\w.-]+))|(#([\w.-]+))/g;
+    const elements = [];
+    let lastIndex = 0;
+    let match;
+    const addText = (t) => {
+        if (!t)
+            return;
+        const el = { type: 'text', text: t };
+        if (Object.keys(style).length > 0) {
+            el.style = style;
+        }
+        elements.push(el);
+    };
+    while ((match = regex.exec(text)) !== null) {
+        const fullMatch = match[0];
+        const index = match.index;
+        if (index > lastIndex) {
+            addText(text.substring(lastIndex, index));
+        }
+        // Apply style if it exists
+        const withStyle = (obj) => {
+            if (Object.keys(style).length > 0) {
+                return { ...obj, style };
+            }
+            return obj;
+        };
+        if (match[1]) { // Broadcast: <!here>
+            const range = match[1].substring(2, match[1].length - 1);
+            elements.push(withStyle({ type: 'broadcast', range }));
+        }
+        else if (match[3]) { // Mention: <@ID>
+            const userId = match[3];
+            elements.push(withStyle({ type: 'user', user_id: userId }));
+        }
+        else if (match[4]) { // Color: #Hex
+            if (options.detectColors !== false) {
+                elements.push(withStyle({ type: 'color', value: match[4] }));
+            }
+            else {
+                addText(fullMatch);
+            }
+        }
+        else if (match[6]) { // Channel: <#ID>
+            const channelId = match[6];
+            elements.push(withStyle({ type: 'channel', channel_id: channelId }));
+        }
+        else if (match[8]) { // Team: <!subteam^ID>
+            const teamId = match[8];
+            elements.push(withStyle({ type: 'team', team_id: teamId }));
+        }
+        else if (match[10]) { // Date: <!date^...|...>
+            const timestamp = parseInt(match[10], 10);
+            const format = match[11];
+            // match[12] is fallback
+            elements.push(withStyle({
+                type: 'date',
+                timestamp,
+                format,
+            }));
+        }
+        else if (match[13]) { // Emoji: :name:
+            const name = match[14];
+            elements.push(withStyle({ type: 'emoji', name }));
+        }
+        else if (match[15]) { // Mapped Mention: @name
+            const name = match[16];
+            let mapped = false;
+            // 1. Check Broadcasts from plain text (@here, @channel, @everyone)
+            if (['here', 'channel', 'everyone'].includes(name)) {
+                elements.push(withStyle({ type: 'broadcast', range: name }));
+                mapped = true;
+            }
+            // 2. Check Users
+            else if (options.mentions?.users && options.mentions.users[name]) {
+                elements.push(withStyle({ type: 'user', user_id: options.mentions.users[name] }));
+                mapped = true;
+            }
+            // 3. Check User Groups
+            else if (options.mentions?.userGroups && options.mentions.userGroups[name]) {
+                elements.push(withStyle({ type: 'usergroup', usergroup_id: options.mentions.userGroups[name] }));
+                mapped = true;
+            }
+            // 4. Check Teams
+            else if (options.mentions?.teams && options.mentions.teams[name]) {
+                elements.push(withStyle({ type: 'team', team_id: options.mentions.teams[name] }));
+                mapped = true;
+            }
+            if (!mapped) {
+                addText(fullMatch);
+            }
+        }
+        else if (match[17]) { // Mapped Channel: #name
+            const name = match[18];
+            let mapped = false;
+            if (options.mentions?.channels && options.mentions.channels[name]) {
+                elements.push(withStyle({ type: 'channel', channel_id: options.mentions.channels[name] }));
+                mapped = true;
+            }
+            if (!mapped) {
+                addText(fullMatch);
+            }
+        }
+        lastIndex = regex.lastIndex;
+    }
+    if (lastIndex < text.length) {
+        addText(text.substring(lastIndex));
+    }
+    return elements;
+}

package/dist/types.d.ts

@@ -0,0 +1,154 @@
+export type Block = SectionBlock | HeaderBlock | ImageBlock | ContextBlock | DividerBlock | RichTextBlock | TableBlock;
+export interface SectionBlock {
+    type: 'section';
+    text?: TextObject;
+    fields?: TextObject[];
+    accessory?: any;
+    block_id?: string;
+}
+export interface HeaderBlock {
+    type: 'header';
+    text: PlainTextObject;
+    block_id?: string;
+}
+export interface ImageBlock {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+    title?: PlainTextObject;
+    block_id?: string;
+}
+export interface ContextBlock {
+    type: 'context';
+    elements: (ImageElement | TextObject)[];
+    block_id?: string;
+}
+export interface DividerBlock {
+    type: 'divider';
+    block_id?: string;
+}
+export interface RichTextBlock {
+    type: 'rich_text';
+    elements: RichTextElement[];
+    block_id?: string;
+}
+export type RichTextElement = RichTextSection | RichTextList | RichTextPreformatted | RichTextQuote;
+export interface RichTextSection {
+    type: 'rich_text_section';
+    elements: RichTextSectionElement[];
+}
+export interface RichTextList {
+    type: 'rich_text_list';
+    style: 'bullet' | 'ordered';
+    indent?: number;
+    offset?: number;
+    border?: number;
+    elements: RichTextSection[];
+}
+export interface RichTextPreformatted {
+    type: 'rich_text_preformatted';
+    elements: RichTextSectionElement[];
+    border?: number;
+}
+export interface RichTextQuote {
+    type: 'rich_text_quote';
+    elements: RichTextSectionElement[];
+    border?: number;
+}
+export type RichTextSectionElement = RichTextText | RichTextLink | RichTextEmoji | RichTextDate | RichTextUser | RichTextUserGroup | RichTextTeam | RichTextChannel | RichTextBroadcast | RichTextColor;
+export interface RichTextText {
+    type: 'text';
+    text: string;
+    style?: RichTextStyle;
+}
+export interface RichTextLink {
+    type: 'link';
+    url: string;
+    text?: string;
+    unsafe?: boolean;
+    style?: RichTextStyle;
+}
+export interface RichTextEmoji {
+    type: 'emoji';
+    name: string;
+    unicode?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextDate {
+    type: 'date';
+    timestamp: number;
+    format: string;
+    url?: string;
+    fallback?: string;
+    style?: RichTextStyle;
+}
+export interface RichTextUser {
+    type: 'user';
+    user_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextUserGroup {
+    type: 'usergroup';
+    usergroup_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextTeam {
+    type: 'team';
+    team_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextChannel {
+    type: 'channel';
+    channel_id: string;
+    style?: RichTextStyle;
+}
+export interface RichTextBroadcast {
+    type: 'broadcast';
+    range: 'here' | 'channel' | 'everyone';
+    style?: RichTextStyle;
+}
+export interface RichTextColor {
+    type: 'color';
+    value: string;
+    style?: RichTextStyle;
+}
+export interface RichTextStyle {
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    code?: boolean;
+}
+export interface TableBlock {
+    type: 'table';
+    columns?: {
+        width?: number;
+    }[];
+    rows: RichTextBlock[][];
+    block_id?: string;
+}
+export interface TextObject {
+    type: 'mrkdwn' | 'plain_text';
+    text: string;
+    emoji?: boolean;
+    verbatim?: boolean;
+}
+export interface PlainTextObject {
+    type: 'plain_text';
+    text: string;
+    emoji?: boolean;
+}
+export interface ImageElement {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+}
+export interface MarkdownToBlocksOptions {
+    mentions?: {
+        users?: Record<string, string>;
+        channels?: Record<string, string>;
+        userGroups?: Record<string, string>;
+        teams?: Record<string, string>;
+    };
+    detectColors?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,UAAU,CAAC;AAEjB,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,CAAC,YAAY,GAAG,UAAU,CAAC,EAAE,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,eAAe,GACrB,eAAe,GACf,YAAY,GACZ,oBAAoB,GACpB,aAAa,CAAC;AAEpB,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,sBAAsB,GAC5B,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,iBAAiB,GACjB,aAAa,CAAC;AAEpB,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;IACvC,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;KAAE,EAAE,CAAC;IAChC,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,CAAC;IACF,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B"}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validator.d.ts

@@ -0,0 +1,3 @@
+import { MarkdownToBlocksOptions } from './types';
+export declare function validateOptions(options?: MarkdownToBlocksOptions): void;
+//# sourceMappingURL=validator.d.ts.map

package/dist/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAsCvE"}

package/dist/validator.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = validateOptions;
+function validateOptions(options) {
+    if (!options?.mentions) {
+        return;
+    }
+    const { users, channels, userGroups, teams } = options.mentions;
+    if (users) {
+        for (const [name, id] of Object.entries(users)) {
+            if (!/^[UW][A-Z0-9]+$/.test(id)) {
+                throw new Error(`Invalid User ID for '${name}': '${id}'. Must start with U or W and contain only alphanumeric characters.`);
+            }
+        }
+    }
+    if (channels) {
+        for (const [name, id] of Object.entries(channels)) {
+            if (!/^C[A-Z0-9]+$/.test(id)) {
+                throw new Error(`Invalid Channel ID for '${name}': '${id}'. Must start with C and contain only alphanumeric characters.`);
+            }
+        }
+    }
+    if (userGroups) {
+        for (const [name, id] of Object.entries(userGroups)) {
+            if (!/^S[A-Z0-9]+$/.test(id)) {
+                throw new Error(`Invalid User Group ID for '${name}': '${id}'. Must start with S and contain only alphanumeric characters.`);
+            }
+        }
+    }
+    if (teams) {
+        for (const [name, id] of Object.entries(teams)) {
+            if (!/^T[A-Z0-9]+$/.test(id)) {
+                throw new Error(`Invalid Team ID for '${name}': '${id}'. Must start with T and contain only alphanumeric characters.`);
+            }
+        }
+    }
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "markdown-to-slack-blocks",
+  "version": "1.0.0",
+  "description": "Convert Markdown to Slack Block Kit JSON format",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build && npm test",
+    "test": "vitest"
+  },
+  "keywords": [
+    "slack",
+    "markdown",
+    "block-kit",
+    "converter",
+    "rich-text",
+    "parser"
+  ],
+  "author": "udi",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/udivankin/markdown-to-slack-blocks.git"
+  },
+  "homepage": "https://github.com/udivankin/markdown-to-slack-blocks#readme",
+  "bugs": {
+    "url": "https://github.com/udivankin/markdown-to-slack-blocks/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "mdast-util-from-markdown": "2.0.2",
+    "mdast-util-gfm": "3.1.0",
+    "mdast-util-to-string": "4.0.0",
+    "micromark-extension-gfm": "3.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.1",
+    "eslint": "9.39.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.15"
+  }
+}