markdown-to-slack-blocks 1.2.2 → 1.3.1

package/README.md

@@ -141,22 +141,30 @@ All IDs must be alphanumeric.
 
 ### Handling Large Messages
 
-Slack limits messages to **~45 blocks** and **~12KB** of JSON. Use `splitBlocks` to split large outputs into several messages:
+Slack limits messages to **~45 blocks** and **~12KB** of JSON. Use `splitBlocks` to split large outputs into several messages, or `splitBlocksWithText` if you also need a plain-text fallback for `postMessage`:
 
 ```typescript
-import { markdownToBlocks, splitBlocks } from 'markdown-to-slack-blocks';
+import { markdownToBlocks, splitBlocks, splitBlocksWithText } from 'markdown-to-slack-blocks';
 
 const blocks = markdownToBlocks(veryLongMarkdown);
-const batches = splitBlocks(blocks);
 
+// Blocks-only batches
+const batches = splitBlocks(blocks);
 for (const batch of batches) {
     await slack.postMessage({ channel, blocks: batch });
 }
+
+// Batches with text fallback
+const batchesWithText = splitBlocksWithText(blocks);
+for (const batch of batchesWithText) {
+    await slack.postMessage({ channel, text: batch.text, blocks: batch.blocks });
+}
 ```
 
 **Options:**
 ```typescript
 splitBlocks(blocks, { maxBlocks: 40, maxCharacters: 12000 });
+splitBlocksWithText(blocks, { maxBlocks: 40, maxCharacters: 12000 });
 ```
 
-The function splits at natural boundaries: between blocks first, then within `rich_text` elements, and finally within large code blocks by line.
+Splitting happens at natural boundaries: between blocks first, then within `rich_text` elements, and finally within large code blocks by line. `splitBlocksWithText` additionally generates a concise plaintext summary per batch (headers, sections, rich text, tables, etc.) suitable for Slack's `text` field.

package/dist/index.d.ts

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

package/dist/index.d.ts.map

@@ -1 +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;AACxB,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAE7D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,6BAGnF"}
+{"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;AACxB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAErG,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,6BAGnF"}

package/dist/index.js

@@ -14,7 +14,7 @@ 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.splitBlocks = void 0;
+exports.splitBlocksWithText = exports.splitBlocks = void 0;
 exports.markdownToBlocks = markdownToBlocks;
 const parser_1 = require("./parser");
 const validator_1 = require("./validator");
@@ -22,6 +22,7 @@ const validator_1 = require("./validator");
 __exportStar(require("./types"), exports);
 var splitter_1 = require("./splitter");
 Object.defineProperty(exports, "splitBlocks", { enumerable: true, get: function () { return splitter_1.splitBlocks; } });
+Object.defineProperty(exports, "splitBlocksWithText", { enumerable: true, get: function () { return splitter_1.splitBlocksWithText; } });
 function markdownToBlocks(markdown, options) {
     (0, validator_1.validateOptions)(options);
     return (0, parser_1.parseMarkdown)(markdown, options);

package/dist/parser.js

@@ -254,6 +254,14 @@ function flattenStyles(children, style, options) {
     });
 }
 function processTextNode(text, style, options) {
+    // Do not parse mentions/colors inside code-styled text; treat as literal.
+    if (style.code) {
+        const literal = { type: 'text', text };
+        if (Object.keys(style).length > 0) {
+            literal.style = style;
+        }
+        return [literal];
+    }
     // Regex for:
     // 1. Broadcast: <!here> | <!channel> | <!everyone>
     // 2. Mention: <@U...>

package/dist/splitter.d.ts

@@ -5,6 +5,10 @@ export interface SplitBlocksOptions {
     /** Maximum JSON character count per message. Default: 12000 */
     maxCharacters?: number;
 }
+export interface SplitBlocksResult {
+    text: string;
+    blocks: Block[];
+}
 /**
  * Splits an array of blocks into multiple arrays that fit within Slack's limits.
  * Attempts to split at natural boundaries (between top-level blocks, rich_text elements, etc.)
@@ -14,4 +18,8 @@ export interface SplitBlocksOptions {
  * @returns Array of block arrays, each fitting within the limits
  */
 export declare function splitBlocks(blocks: Block[], options?: SplitBlocksOptions): Block[][];
+/**
+ * Splits blocks and also returns a plain-text fallback for each batch, suitable for postMessage `text`.
+ */
+export declare function splitBlocksWithText(blocks: Block[], options?: SplitBlocksOptions): SplitBlocksResult[];
 //# sourceMappingURL=splitter.d.ts.map

package/dist/splitter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"splitter.d.ts","sourceRoot":"","sources":["../src/splitter.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,EAQR,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,kBAAkB;IAC/B,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAMD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,KAAK,EAAE,EAAE,CA6EpF"}
+{"version":3,"file":"splitter.d.ts","sourceRoot":"","sources":["../src/splitter.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,EASR,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,kBAAkB;IAC/B,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,EAAE,CAAC;CACnB;AAMD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,KAAK,EAAE,EAAE,CA6EpF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,EAAE,CAMtG"}

package/dist/splitter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitBlocks = splitBlocks;
+exports.splitBlocksWithText = splitBlocksWithText;
 const DEFAULT_MAX_BLOCKS = 40;
 const DEFAULT_MAX_CHARACTERS = 12000;
 const DEFAULT_MAX_TEXT_SECTION_CHARACTERS = 3000;
@@ -83,6 +84,16 @@ function splitBlocks(blocks, options) {
     flushBatch();
     return result.length > 0 ? result : [[]];
 }
+/**
+ * Splits blocks and also returns a plain-text fallback for each batch, suitable for postMessage `text`.
+ */
+function splitBlocksWithText(blocks, options) {
+    const batches = splitBlocks(blocks, options);
+    return batches.map(batch => ({
+        text: blocksToPlainText(batch),
+        blocks: batch,
+    }));
+}
 /**
  * Splits a large RichTextBlock into smaller RichTextBlocks by splitting its elements
  */
@@ -315,3 +326,89 @@ function chunkString(str, limit) {
     }
     return chunks;
 }
+/**
+ * Generates a lightweight plain-text fallback from a block batch.
+ */
+function blocksToPlainText(blocks) {
+    const parts = [];
+    const renderTextObject = (text) => text?.text ?? '';
+    const renderRichTextSectionElement = (element) => {
+        switch (element.type) {
+            case 'text':
+                return element.text;
+            case 'link':
+                return element.text ?? element.url;
+            case 'emoji':
+                return `:${element.name}:`;
+            case 'date':
+                return element.fallback ?? new Date(element.timestamp * 1000).toISOString();
+            case 'user':
+                return `<@${element.user_id}>`;
+            case 'usergroup':
+                return `<!subteam^${element.usergroup_id}>`;
+            case 'team':
+                return `<team:${element.team_id}>`;
+            case 'channel':
+                return `<#${element.channel_id}>`;
+            case 'broadcast':
+                return element.range === 'here' ? `<!here>` : element.range === 'channel' ? `<!channel>` : `<!everyone>`;
+            case 'color':
+                return element.value;
+            default:
+                return '';
+        }
+    };
+    const renderRichTextElement = (element) => {
+        switch (element.type) {
+            case 'rich_text_section':
+                return element.elements.map(renderRichTextSectionElement).filter(Boolean).join('');
+            case 'rich_text_list':
+                return element.elements
+                    .map((item, idx) => {
+                    const marker = element.style === 'ordered' ? `${(element.offset ?? 1) + idx}. ` : '- ';
+                    return marker + item.elements.map(renderRichTextSectionElement).join('');
+                })
+                    .join('\n');
+            case 'rich_text_preformatted':
+                return element.elements.map(renderRichTextSectionElement).join('');
+            case 'rich_text_quote':
+                return element.elements.map(renderRichTextSectionElement).map(line => `> ${line}`).join('\n');
+            default:
+                return '';
+        }
+    };
+    const renderRichTextBlock = (block) => {
+        return block.elements.map(renderRichTextElement).filter(Boolean).join('\n');
+    };
+    const renderBlock = (block) => {
+        switch (block.type) {
+            case 'section':
+                return renderTextObject(block.text);
+            case 'header':
+                return renderTextObject(block.text);
+            case 'context':
+                return block.elements
+                    .map(el => el.text ?? '')
+                    .filter(Boolean)
+                    .join(' ');
+            case 'rich_text':
+                return renderRichTextBlock(block);
+            case 'divider':
+                return '---';
+            case 'image':
+                return block.title?.text ?? block.alt_text ?? 'Image';
+            case 'table':
+                return block.rows
+                    .map(row => row.map(renderRichTextBlock).join(' | '))
+                    .join('\n');
+            default:
+                return '';
+        }
+    };
+    for (const block of blocks) {
+        const rendered = renderBlock(block).trim();
+        if (rendered)
+            parts.push(rendered);
+    }
+    return parts.join('\n\n');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-to-slack-blocks",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "description": "Convert Markdown to Slack Block Kit JSON format",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",