markdown-to-slack-blocks 1.3.1 → 1.4.0

package/README.md

@@ -168,3 +168,16 @@ splitBlocksWithText(blocks, { maxBlocks: 40, maxCharacters: 12000 });
 ```
 
 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.
+
+### Plain text rendering
+
+If you already have a block array and need a lightweight plaintext fallback (for example to populate the `text` field in `chat.postMessage`), use `blocksToPlainText`:
+
+```typescript
+import { blocksToPlainText } from 'markdown-to-slack-blocks';
+
+const text = blocksToPlainText(blocks);
+// -> "Hello world" or similar, depending on your blocks
+```
+
+The function walks the rendered blocks and returns a joined string that keeps list markers, quotes, tables (as `cell | cell` rows), mentions, dates (using the provided fallback or ISO string), and basic formatting markers where possible. The output is best-effort and is intended for concise fallbacks rather than full fidelity rendering.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { MarkdownToBlocksOptions } from './types';
-export * from './types';
-export { splitBlocks, splitBlocksWithText, SplitBlocksOptions, SplitBlocksResult } from './splitter';
+import type { MarkdownToBlocksOptions } from "./types";
+export * from "./types";
+export { blocksToPlainText, 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,mBAAmB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAErG,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,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAIvD,cAAc,SAAS,CAAC;AACxB,OAAO,EACN,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,GACjB,MAAM,YAAY,CAAC;AAEpB,wBAAgB,gBAAgB,CAC/B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,uBAAuB,6BAIjC"}

package/dist/index.js

@@ -14,13 +14,14 @@ 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.splitBlocksWithText = exports.splitBlocks = void 0;
+exports.splitBlocksWithText = exports.splitBlocks = exports.blocksToPlainText = void 0;
 exports.markdownToBlocks = markdownToBlocks;
 const parser_1 = require("./parser");
 const validator_1 = require("./validator");
 // Re-export types for consumers
 __exportStar(require("./types"), exports);
 var splitter_1 = require("./splitter");
+Object.defineProperty(exports, "blocksToPlainText", { enumerable: true, get: function () { return splitter_1.blocksToPlainText; } });
 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) {

package/dist/parser.d.ts

@@ -1,3 +1,3 @@
-import { Block, MarkdownToBlocksOptions } from './types';
+import type { Block, MarkdownToBlocksOptions } from "./types";
 export declare function parseMarkdown(markdown: string, options?: MarkdownToBlocksOptions): Block[];
 //# sourceMappingURL=parser.d.ts.map

package/dist/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,KAAK,EAML,uBAAuB,EAG1B,MAAM,SAAS,CAAC;AAEjB,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B,GAAG,KAAK,EAAE,CAsM9F"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACX,KAAK,EAKL,uBAAuB,EAGvB,MAAM,SAAS,CAAC;AAmFjB,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,uBAA4B,GACnC,KAAK,EAAE,CAiNT"}