@elastic/isomer-sdk 0.2.0 → 0.4.0

package/dist/cjs/render/react/markdown_content.js

@@ -0,0 +1,143 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderMarkdownContent = void 0;
+// Builder content as React elements, read from the blocks the Markdown and
+// Slack surfaces read. Unstyled: a pack's stylesheet owns the look.
+const react_1 = require("react");
+const url_1 = require("../../validate/url");
+const blocks_1 = require("../markdown/blocks");
+const HEADINGS = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+const footnoteLabel = ({ identifier, label, }) => `[^${label ?? identifier}]`;
+const plainText = (node) => {
+    if ('value' in node) {
+        return node.value;
+    }
+    if (node.type === 'image') {
+        return node.alt ?? '';
+    }
+    if (node.type === 'footnoteReference') {
+        return footnoteLabel(node);
+    }
+    return 'children' in node ? node.children.map(plainText).join('') : '';
+};
+const keyed = (nodes) => nodes.map((node, index) => (0, react_1.createElement)(react_1.Fragment, { key: index }, node));
+const inlines = (nodes) => keyed(nodes.map(inline));
+const inline = (node) => {
+    switch (node.type) {
+        case 'strong':
+            return (0, react_1.createElement)('strong', null, ...inlines(node.children));
+        case 'emphasis':
+            return (0, react_1.createElement)('em', null, ...inlines(node.children));
+        case 'delete':
+            return (0, react_1.createElement)('del', null, ...inlines(node.children));
+        case 'inlineCode':
+            return (0, react_1.createElement)('code', null, node.value);
+        case 'break':
+            return (0, react_1.createElement)('br');
+        case 'link':
+            return (0, react_1.createElement)('a', {
+                href: (0, url_1.sanitizeParsedNavigationHref)(node.url) ?? url_1.BLOCKED_HREF,
+                ...(node.title ? { title: node.title } : {}),
+            }, ...inlines(node.children));
+        case 'image': {
+            const src = (0, url_1.sanitizeParsedAssetUrl)(node.url);
+            return src === null
+                ? (node.alt ?? '')
+                : (0, react_1.createElement)('img', {
+                    src,
+                    alt: node.alt ?? '',
+                    ...(node.title ? { title: node.title } : {}),
+                });
+        }
+        default:
+            return plainText(node);
+    }
+};
+const paragraphCount = (item) => item.children.filter(({ type }) => type === 'paragraph').length;
+// A spread list, a spread item, or an item with two paragraphs makes the whole list loose.
+const items = (list) => {
+    const tight = list.spread !== true &&
+        !list.children.some((item) => item.spread === true || paragraphCount(item) > 1);
+    return list.children.map((item, index) => listItem(item, index, tight));
+};
+// A task item's checkbox leads its first paragraph, so a loose item keeps it on the task's line.
+const listItem = (item, key, tight) => {
+    const checkbox = typeof item.checked === 'boolean'
+        ? [
+            (0, react_1.createElement)('input', {
+                type: 'checkbox',
+                checked: item.checked,
+                disabled: true,
+            }),
+            ' ',
+        ]
+        : [];
+    const [first, ...rest] = item.children;
+    const leadsWithParagraph = first?.type === 'paragraph';
+    const lead = leadsWithParagraph
+        ? [...checkbox, ...inlines(first.children)]
+        : checkbox;
+    const head = leadsWithParagraph && !tight ? [(0, react_1.createElement)('p', null, ...lead)] : lead;
+    const body = (leadsWithParagraph ? rest : item.children).flatMap((child) => child.type === 'paragraph' && tight
+        ? inlines(child.children)
+        : [block(child)]);
+    return (0, react_1.createElement)('li', { key }, ...keyed([...head, ...body]));
+};
+const tableRows = (table) => {
+    const [header, ...body] = table.children;
+    const cells = (row, tag) => (0, react_1.createElement)('tr', null, ...row.children.map((cell, index) => {
+        const align = table.align?.[index];
+        return (0, react_1.createElement)(tag, {
+            key: index,
+            ...(align ? { style: { textAlign: align } } : {}),
+        }, ...inlines(cell.children));
+    }));
+    return (0, react_1.createElement)(react_1.Fragment, null, header
+        ? (0, react_1.createElement)('thead', { key: 'head' }, cells(header, 'th'))
+        : null, body.length > 0
+        ? (0, react_1.createElement)('tbody', { key: 'body' }, ...body.map((row, index) => (0, react_1.createElement)(react_1.Fragment, { key: index }, cells(row, 'td'))))
+        : null);
+};
+const blocks = (nodes) => keyed(nodes.map(block));
+const block = (node) => {
+    switch (node.type) {
+        case 'paragraph':
+            return (0, react_1.createElement)('p', null, ...inlines(node.children));
+        case 'heading':
+            return (0, react_1.createElement)(HEADINGS[node.depth - 1], null, ...inlines(node.children));
+        case 'blockquote':
+            return (0, react_1.createElement)('blockquote', null, ...blocks(node.children));
+        case 'list':
+            return (0, react_1.createElement)(node.ordered ? 'ol' : 'ul', node.ordered && node.start != null && node.start !== 1
+                ? { start: node.start }
+                : null, ...items(node));
+        case 'code':
+            return (0, react_1.createElement)('pre', null, (0, react_1.createElement)('code', node.lang ? { className: `language-${node.lang}` } : null, node.value));
+        case 'table':
+            return (0, react_1.createElement)('table', null, tableRows(node));
+        case 'thematicBreak':
+            return (0, react_1.createElement)('hr');
+        case 'html':
+            return (0, react_1.createElement)('p', null, node.value);
+        case 'footnoteDefinition': {
+            const [first, ...rest] = node.children;
+            return (0, react_1.createElement)(react_1.Fragment, null, (0, react_1.createElement)('p', null, `${footnoteLabel(node)}: `, ...(first?.type === 'paragraph' ? inlines(first.children) : [])), ...blocks(first?.type === 'paragraph' ? rest : node.children));
+        }
+        default:
+            return null;
+    }
+};
+/**
+ * Builder content as React elements: paragraphs, headings, lists, quotes, code, tables, and thematic breaks, with inline marks, links, and images. Source from `md.authored` is parsed as GFM, once, as the Markdown and Slack surfaces read it.
+ *
+ * Links and images follow `md`'s URL policy: a blocked link keeps its label on {@link BLOCKED_HREF}, and a blocked image degrades to its alt text.
+ */
+const renderMarkdownContent = (content) => (0, react_1.createElement)(react_1.Fragment, null, ...blocks((0, blocks_1.resolvedMarkdownBlocks)(content)));
+exports.renderMarkdownContent = renderMarkdownContent;
+//# sourceMappingURL=markdown_content.js.map

package/dist/cjs/render/react/markdown_content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown_content.js","sourceRoot":"","sources":["../../../../src/render/react/markdown_content.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2EAA2E;AAC3E,oEAAoE;AAEpE,iCAAgE;AAYhE,4CAI4B;AAC5B,+CAA4D;AAE5D,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAE/D,MAAM,aAAa,GAAG,CAAC,EACrB,UAAU,EACV,KAAK,GAC4C,EAAU,EAAE,CAC7D,KAAK,KAAK,IAAI,UAAU,GAAG,CAAC;AAE9B,MAAM,SAAS,GAAG,CAAC,IAAW,EAAU,EAAE;IACxC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QACtC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzE,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,KAA2B,EAAe,EAAE,CACzD,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAA,qBAAa,EAAC,gBAAQ,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;AAE5E,MAAM,OAAO,GAAG,CAAC,KAAiC,EAAe,EAAE,CACjE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAE3B,MAAM,MAAM,GAAG,CAAC,IAAqB,EAAa,EAAE;IAClD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,IAAA,qBAAa,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClE,KAAK,UAAU;YACb,OAAO,IAAA,qBAAa,EAAC,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,KAAK,QAAQ;YACX,OAAO,IAAA,qBAAa,EAAC,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/D,KAAK,YAAY;YACf,OAAO,IAAA,qBAAa,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,KAAK,OAAO;YACV,OAAO,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;QAC7B,KAAK,MAAM;YACT,OAAO,IAAA,qBAAa,EAClB,GAAG,EACH;gBACE,IAAI,EAAE,IAAA,kCAA4B,EAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAY;gBAC5D,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC7C,EACD,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC1B,CAAC;QACJ,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,GAAG,GAAG,IAAA,4BAAsB,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO,GAAG,KAAK,IAAI;gBACjB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;gBAClB,CAAC,CAAC,IAAA,qBAAa,EAAC,KAAK,EAAE;oBACnB,GAAG;oBACH,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE;oBACnB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC7C,CAAC,CAAC;QACT,CAAC;QACD;YACE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAc,EAAU,EAAE,CAChD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,MAAM,CAAC;AAElE,2FAA2F;AAC3F,MAAM,KAAK,GAAG,CAAC,IAAU,EAAe,EAAE;IACxC,MAAM,KAAK,GACT,IAAI,CAAC,MAAM,KAAK,IAAI;QACpB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CACjB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,CAAC;IACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,iGAAiG;AACjG,MAAM,QAAQ,GAAG,CAAC,IAAc,EAAE,GAAW,EAAE,KAAc,EAAa,EAAE;IAC1E,MAAM,QAAQ,GACZ,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS;QAC/B,CAAC,CAAC;YACE,IAAA,qBAAa,EAAC,OAAO,EAAE;gBACrB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI;aACf,CAAC;YACF,GAAG;SACJ;QACH,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;IACvC,MAAM,kBAAkB,GAAG,KAAK,EAAE,IAAI,KAAK,WAAW,CAAC;IACvD,MAAM,IAAI,GAAG,kBAAkB;QAC7B,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,QAAQ,CAAC;IACb,MAAM,IAAI,GACR,kBAAkB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,qBAAa,EAAC,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5E,MAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAC9D,CAAC,KAAK,EAAe,EAAE,CACrB,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK;QACjC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;QACzB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CACrB,CAAC;IACF,OAAO,IAAA,qBAAa,EAAC,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAY,EAAa,EAAE;IAC5C,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;IACzC,MAAM,KAAK,GAAG,CAAC,GAA8B,EAAE,GAAgB,EAAa,EAAE,CAC5E,IAAA,qBAAa,EACX,IAAI,EACJ,IAAI,EACJ,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAClC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAA,qBAAa,EAClB,GAAG,EACH;YACE,GAAG,EAAE,KAAK;YACV,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD,EACD,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC1B,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IACJ,OAAO,IAAA,qBAAa,EAClB,gBAAQ,EACR,IAAI,EACJ,MAAM;QACJ,CAAC,CAAC,IAAA,qBAAa,EAAC,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9D,CAAC,CAAC,IAAI,EACR,IAAI,CAAC,MAAM,GAAG,CAAC;QACb,CAAC,CAAC,IAAA,qBAAa,EACX,OAAO,EACP,EAAE,GAAG,EAAE,MAAM,EAAE,EACf,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CACzB,IAAA,qBAAa,EAAC,gBAAQ,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAC1D,CACF;QACH,CAAC,CAAC,IAAI,CACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,KAA6B,EAAe,EAAE,CAC5D,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1B,MAAM,KAAK,GAAG,CAAC,IAAiB,EAAa,EAAE;IAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,IAAA,qBAAa,EAAC,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC7D,KAAK,SAAS;YACZ,OAAO,IAAA,qBAAa,EAClB,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAE,EACzB,IAAI,EACJ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC1B,CAAC;QACJ,KAAK,YAAY;YACf,OAAO,IAAA,qBAAa,EAAC,YAAY,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrE,KAAK,MAAM;YACT,OAAO,IAAA,qBAAa,EAClB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAC1B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;gBACpD,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE;gBACvB,CAAC,CAAC,IAAI,EACR,GAAG,KAAK,CAAC,IAAI,CAAC,CACf,CAAC;QACJ,KAAK,MAAM;YACT,OAAO,IAAA,qBAAa,EAClB,KAAK,EACL,IAAI,EACJ,IAAA,qBAAa,EACX,MAAM,EACN,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,YAAY,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EACzD,IAAI,CAAC,KAAK,CACX,CACF,CAAC;QACJ,KAAK,OAAO;YACV,OAAO,IAAA,qBAAa,EAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,KAAK,eAAe;YAClB,OAAO,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;QAC7B,KAAK,MAAM;YACT,OAAO,IAAA,qBAAa,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,KAAK,oBAAoB,CAAC,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;YACvC,OAAO,IAAA,qBAAa,EAClB,gBAAQ,EACR,IAAI,EACJ,IAAA,qBAAa,EACX,GAAG,EACH,IAAI,EACJ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,EAC1B,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAChE,EACD,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC9D,CAAC;QACJ,CAAC;QACD;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,OAAwB,EAAa,EAAE,CAC3E,IAAA,qBAAa,EACX,gBAAQ,EACR,IAAI,EACJ,GAAG,MAAM,CAAC,IAAA,+BAAsB,EAAC,OAAO,CAAkB,CAAC,CAC5D,CAAC;AALS,QAAA,qBAAqB,yBAK9B","sourcesContent":["/*\n * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one\n * or more contributor license agreements. Licensed under the Elastic License\n * 2.0; you may not use this file except in compliance with the Elastic License\n * 2.0.\n */\n\n// Builder content as React elements, read from the blocks the Markdown and\n// Slack surfaces read. Unstyled: a pack's stylesheet owns the look.\n\nimport { createElement, Fragment, type ReactNode } from 'react';\nimport type {\n  FootnoteDefinition,\n  List,\n  ListItem,\n  Nodes,\n  PhrasingContent,\n  RootContent,\n  Table,\n} from 'mdast';\n\nimport type { MarkdownContent } from '../../define/markdown_content';\nimport {\n  BLOCKED_HREF,\n  sanitizeParsedAssetUrl,\n  sanitizeParsedNavigationHref,\n} from '../../validate/url';\nimport { resolvedMarkdownBlocks } from '../markdown/blocks';\n\nconst HEADINGS = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'] as const;\n\nconst footnoteLabel = ({\n  identifier,\n  label,\n}: Pick<FootnoteDefinition, 'identifier' | 'label'>): string =>\n  `[^${label ?? identifier}]`;\n\nconst plainText = (node: Nodes): string => {\n  if ('value' in node) {\n    return node.value;\n  }\n  if (node.type === 'image') {\n    return node.alt ?? '';\n  }\n  if (node.type === 'footnoteReference') {\n    return footnoteLabel(node);\n  }\n  return 'children' in node ? node.children.map(plainText).join('') : '';\n};\n\nconst keyed = (nodes: readonly ReactNode[]): ReactNode[] =>\n  nodes.map((node, index) => createElement(Fragment, { key: index }, node));\n\nconst inlines = (nodes: readonly PhrasingContent[]): ReactNode[] =>\n  keyed(nodes.map(inline));\n\nconst inline = (node: PhrasingContent): ReactNode => {\n  switch (node.type) {\n    case 'strong':\n      return createElement('strong', null, ...inlines(node.children));\n    case 'emphasis':\n      return createElement('em', null, ...inlines(node.children));\n    case 'delete':\n      return createElement('del', null, ...inlines(node.children));\n    case 'inlineCode':\n      return createElement('code', null, node.value);\n    case 'break':\n      return createElement('br');\n    case 'link':\n      return createElement(\n        'a',\n        {\n          href: sanitizeParsedNavigationHref(node.url) ?? BLOCKED_HREF,\n          ...(node.title ? { title: node.title } : {}),\n        },\n        ...inlines(node.children)\n      );\n    case 'image': {\n      const src = sanitizeParsedAssetUrl(node.url);\n      return src === null\n        ? (node.alt ?? '')\n        : createElement('img', {\n            src,\n            alt: node.alt ?? '',\n            ...(node.title ? { title: node.title } : {}),\n          });\n    }\n    default:\n      return plainText(node);\n  }\n};\n\nconst paragraphCount = (item: ListItem): number =>\n  item.children.filter(({ type }) => type === 'paragraph').length;\n\n// A spread list, a spread item, or an item with two paragraphs makes the whole list loose.\nconst items = (list: List): ReactNode[] => {\n  const tight =\n    list.spread !== true &&\n    !list.children.some(\n      (item) => item.spread === true || paragraphCount(item) > 1\n    );\n  return list.children.map((item, index) => listItem(item, index, tight));\n};\n\n// A task item's checkbox leads its first paragraph, so a loose item keeps it on the task's line.\nconst listItem = (item: ListItem, key: number, tight: boolean): ReactNode => {\n  const checkbox =\n    typeof item.checked === 'boolean'\n      ? [\n          createElement('input', {\n            type: 'checkbox',\n            checked: item.checked,\n            disabled: true,\n          }),\n          ' ',\n        ]\n      : [];\n  const [first, ...rest] = item.children;\n  const leadsWithParagraph = first?.type === 'paragraph';\n  const lead = leadsWithParagraph\n    ? [...checkbox, ...inlines(first.children)]\n    : checkbox;\n  const head =\n    leadsWithParagraph && !tight ? [createElement('p', null, ...lead)] : lead;\n  const body = (leadsWithParagraph ? rest : item.children).flatMap(\n    (child): ReactNode[] =>\n      child.type === 'paragraph' && tight\n        ? inlines(child.children)\n        : [block(child)]\n  );\n  return createElement('li', { key }, ...keyed([...head, ...body]));\n};\n\nconst tableRows = (table: Table): ReactNode => {\n  const [header, ...body] = table.children;\n  const cells = (row: Table['children'][number], tag: 'th' | 'td'): ReactNode =>\n    createElement(\n      'tr',\n      null,\n      ...row.children.map((cell, index) => {\n        const align = table.align?.[index];\n        return createElement(\n          tag,\n          {\n            key: index,\n            ...(align ? { style: { textAlign: align } } : {}),\n          },\n          ...inlines(cell.children)\n        );\n      })\n    );\n  return createElement(\n    Fragment,\n    null,\n    header\n      ? createElement('thead', { key: 'head' }, cells(header, 'th'))\n      : null,\n    body.length > 0\n      ? createElement(\n          'tbody',\n          { key: 'body' },\n          ...body.map((row, index) =>\n            createElement(Fragment, { key: index }, cells(row, 'td'))\n          )\n        )\n      : null\n  );\n};\n\nconst blocks = (nodes: readonly RootContent[]): ReactNode[] =>\n  keyed(nodes.map(block));\n\nconst block = (node: RootContent): ReactNode => {\n  switch (node.type) {\n    case 'paragraph':\n      return createElement('p', null, ...inlines(node.children));\n    case 'heading':\n      return createElement(\n        HEADINGS[node.depth - 1]!,\n        null,\n        ...inlines(node.children)\n      );\n    case 'blockquote':\n      return createElement('blockquote', null, ...blocks(node.children));\n    case 'list':\n      return createElement(\n        node.ordered ? 'ol' : 'ul',\n        node.ordered && node.start != null && node.start !== 1\n          ? { start: node.start }\n          : null,\n        ...items(node)\n      );\n    case 'code':\n      return createElement(\n        'pre',\n        null,\n        createElement(\n          'code',\n          node.lang ? { className: `language-${node.lang}` } : null,\n          node.value\n        )\n      );\n    case 'table':\n      return createElement('table', null, tableRows(node));\n    case 'thematicBreak':\n      return createElement('hr');\n    case 'html':\n      return createElement('p', null, node.value);\n    case 'footnoteDefinition': {\n      const [first, ...rest] = node.children;\n      return createElement(\n        Fragment,\n        null,\n        createElement(\n          'p',\n          null,\n          `${footnoteLabel(node)}: `,\n          ...(first?.type === 'paragraph' ? inlines(first.children) : [])\n        ),\n        ...blocks(first?.type === 'paragraph' ? rest : node.children)\n      );\n    }\n    default:\n      return null;\n  }\n};\n\n/**\n * Builder content as React elements: paragraphs, headings, lists, quotes, code, tables, and thematic breaks, with inline marks, links, and images. Source from `md.authored` is parsed as GFM, once, as the Markdown and Slack surfaces read it.\n *\n * Links and images follow `md`'s URL policy: a blocked link keeps its label on {@link BLOCKED_HREF}, and a blocked image degrades to its alt text.\n */\nexport const renderMarkdownContent = (content: MarkdownContent): ReactNode =>\n  createElement(\n    Fragment,\n    null,\n    ...blocks(resolvedMarkdownBlocks(content) as RootContent[])\n  );\n"]}

package/dist/cjs/render/slack/blocks.js

@@ -12,7 +12,14 @@ exports.SLACK_LIMITS = void 0;
  * cannot silently trip Slack's validation.
  */
 exports.SLACK_LIMITS = {
+    /** Top-level blocks; a `container`'s `child_blocks` do not count. */
     blocksPerMessage: 50,
+    /** `container.title`, which is `plain_text`. */
+    containerTitleChars: 150,
+    /** `container.subtitle`. */
+    containerSubtitleChars: 150,
+    /** `container.child_blocks`; Slack also requires at least one. */
+    containerChildBlocks: 10,
     /** `section.text`. */
     sectionTextChars: 3000,
     /** One entry of `section.fields`. */

package/dist/cjs/render/slack/blocks.js.map

@@ -1 +1 @@
-{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../../../src/render/slack/blocks.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AA6CH;;;GAGG;AACU,QAAA,YAAY,GAAG;IAC1B,gBAAgB,EAAE,EAAE;IACpB,sBAAsB;IACtB,gBAAgB,EAAE,IAAI;IACtB,qCAAqC;IACrC,iBAAiB,EAAE,IAAI;IACvB,uCAAuC;IACvC,mBAAmB,EAAE,IAAI;IACzB,4CAA4C;IAC5C,eAAe,EAAE,GAAG;IACpB,gBAAgB,EAAE,EAAE;IACpB,oCAAoC;IACpC,eAAe,EAAE,EAAE;IACnB,iBAAiB,EAAE,EAAE;IACrB,kFAAkF;IAClF,iBAAiB,EAAE,IAAI;IACvB,yEAAyE;IACzE,eAAe,EAAE,EAAE;IACnB,sDAAsD;IACtD,gBAAgB,EAAE,GAAG;IACrB,4DAA4D;IAC5D,kBAAkB,EAAE,CAAC;IACrB,4DAA4D;IAC5D,gBAAgB,EAAE,EAAE;IACpB,+EAA+E;IAC/E,qBAAqB,EAAE,GAAG;IAC1B,yDAAyD;IACzD,gBAAgB,EAAE,GAAG;IACrB,0BAA0B;IAC1B,gBAAgB,EAAE,IAAI;IACtB,6CAA6C;IAC7C,QAAQ,EAAE,IAAI;IACd,4CAA4C;IAC5C,aAAa,EAAE,GAAG;IAClB,6CAA6C;IAC7C,qBAAqB,EAAE,CAAC;IACxB;;;;;OAKG;IACH,wBAAwB,EAAE,MAAM;IAChC,wDAAwD;IACxD,SAAS,EAAE,GAAG;IACd,iDAAiD;IACjD,YAAY,EAAE,EAAE;IAChB,oDAAoD;IACpD,aAAa,EAAE,IAAI;IACnB,mDAAmD;IACnD,iBAAiB,EAAE,IAAI;IACvB,6BAA6B;IAC7B,eAAe,EAAE,IAAI;IACrB,4DAA4D;IAC5D,eAAe,EAAE,GAAG;IACpB,kEAAkE;IAClE,qBAAqB,EAAE,GAAG;IAC1B,iEAAiE;IACjE,oBAAoB,EAAE,EAAE;IACxB,+BAA+B;IAC/B,eAAe,EAAE,EAAE;IACnB,4BAA4B;IAC5B,gBAAgB,EAAE,GAAG;IACrB,+BAA+B;IAC/B,qBAAqB,EAAE,EAAE;CACjB,CAAC","sourcesContent":["/*\n * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one\n * or more contributor license agreements. Licensed under the Elastic License\n * 2.0; you may not use this file except in compliance with the Elastic License\n * 2.0.\n */\n\nexport type {\n  SlackActionElement,\n  SlackActionsBlock,\n  SlackBlock,\n  SlackButtonElement,\n  SlackCheckboxesElement,\n  SlackContextBlock,\n  SlackDividerBlock,\n  SlackFileReference,\n  SlackHeaderBlock,\n  SlackHeaderLevel,\n  SlackImageBlock,\n  SlackImageElement,\n  SlackMrkdwnTextObject,\n  SlackMultiStaticSelectElement,\n  SlackOptionGroup,\n  SlackOptionObject,\n  SlackOverflowElement,\n  SlackPlainTextObject,\n  SlackRadioButtonsElement,\n  SlackRawTextElement,\n  SlackRichTextBlock,\n  SlackRichTextBlockElement,\n  SlackRichTextInline,\n  SlackRichTextLink,\n  SlackRichTextList,\n  SlackRichTextPreformatted,\n  SlackRichTextQuote,\n  SlackRichTextSection,\n  SlackRichTextStyle,\n  SlackRichTextTag,\n  SlackRichTextText,\n  SlackSectionAccessory,\n  SlackSectionBlock,\n  SlackStaticSelectElement,\n  SlackTableBlock,\n  SlackTableCell,\n  SlackTableColumnSetting,\n  SlackTagColor,\n  SlackTextObject,\n  SlackVideoBlock,\n} from '../../define/slack_blocks';\n\n/**\n * Slack's published surface limits, enforced by the renderer so a composition\n * cannot silently trip Slack's validation.\n */\nexport const SLACK_LIMITS = {\n  blocksPerMessage: 50,\n  /** `section.text`. */\n  sectionTextChars: 3000,\n  /** One entry of `section.fields`. */\n  sectionFieldChars: 2000,\n  /** One entry of `context.elements`. */\n  contextElementChars: 2000,\n  /** `header.text`, which is `plain_text`. */\n  headerTextChars: 150,\n  fieldsPerSection: 10,\n  /** Elements per `context` block. */\n  contextElements: 10,\n  buttonsPerActions: 25,\n  /** Slack truncates the top-level `text` fallback in notifications around here. */\n  fallbackTextChars: 4000,\n  /** `plain_text` option labels (selects, radio, checkboxes, overflow). */\n  optionTextChars: 75,\n  /** Options per select, or per option group of one. */\n  optionsPerSelect: 100,\n  /** Options per overflow menu (Slack caps overflow at 5). */\n  optionsPerOverflow: 5,\n  /** Options per radio button group or checkboxes element. */\n  optionsPerChoice: 10,\n  /** Option groups per select, each holding up to `optionsPerSelect` options. */\n  optionGroupsPerSelect: 100,\n  /** An option's `value`, which interactions send back. */\n  optionValueChars: 150,\n  /** A button's `value`. */\n  buttonValueChars: 2000,\n  /** A button's or overflow option's `url`. */\n  urlChars: 3000,\n  /** An interactive element's `action_id`. */\n  actionIdChars: 255,\n  /** Max indent level for `rich_text_list`. */\n  richTextListMaxIndent: 8,\n  /**\n   * Characters across every table cell in one message. Slack publishes the\n   * same 10,000 figure per table and per message, so the message-wide\n   * aggregate is the binding one.\n   * https://docs.slack.dev/reference/block-kit/blocks/table-block/\n   */\n  tableCellCharsPerMessage: 10_000,\n  /** Rows per `table` block (includes the header row). */\n  tableRows: 100,\n  /** Cells per `table` row / columns per table. */\n  tableColumns: 20,\n  /** `image`/image-element `image_url` max length. */\n  imageUrlChars: 3000,\n  /** `image`/image-element `alt_text` max length. */\n  imageAltTextChars: 2000,\n  /** `image` block `title`. */\n  imageTitleChars: 2000,\n  /** `video` block `title`; Slack requires fewer than 200. */\n  videoTitleChars: 199,\n  /** `video` block `description`; Slack requires fewer than 200. */\n  videoDescriptionChars: 199,\n  /** `video` block `author_name`; Slack requires fewer than 50. */\n  videoAuthorNameChars: 49,\n  /** `button` element `text`. */\n  buttonTextChars: 75,\n  /** Select `placeholder`. */\n  placeholderChars: 150,\n  /** `option_groups[].label`. */\n  optionGroupLabelChars: 75,\n} as const;\n"]}
+{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../../../src/render/slack/blocks.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AA+CH;;;GAGG;AACU,QAAA,YAAY,GAAG;IAC1B,qEAAqE;IACrE,gBAAgB,EAAE,EAAE;IACpB,gDAAgD;IAChD,mBAAmB,EAAE,GAAG;IACxB,4BAA4B;IAC5B,sBAAsB,EAAE,GAAG;IAC3B,kEAAkE;IAClE,oBAAoB,EAAE,EAAE;IACxB,sBAAsB;IACtB,gBAAgB,EAAE,IAAI;IACtB,qCAAqC;IACrC,iBAAiB,EAAE,IAAI;IACvB,uCAAuC;IACvC,mBAAmB,EAAE,IAAI;IACzB,4CAA4C;IAC5C,eAAe,EAAE,GAAG;IACpB,gBAAgB,EAAE,EAAE;IACpB,oCAAoC;IACpC,eAAe,EAAE,EAAE;IACnB,iBAAiB,EAAE,EAAE;IACrB,kFAAkF;IAClF,iBAAiB,EAAE,IAAI;IACvB,yEAAyE;IACzE,eAAe,EAAE,EAAE;IACnB,sDAAsD;IACtD,gBAAgB,EAAE,GAAG;IACrB,4DAA4D;IAC5D,kBAAkB,EAAE,CAAC;IACrB,4DAA4D;IAC5D,gBAAgB,EAAE,EAAE;IACpB,+EAA+E;IAC/E,qBAAqB,EAAE,GAAG;IAC1B,yDAAyD;IACzD,gBAAgB,EAAE,GAAG;IACrB,0BAA0B;IAC1B,gBAAgB,EAAE,IAAI;IACtB,6CAA6C;IAC7C,QAAQ,EAAE,IAAI;IACd,4CAA4C;IAC5C,aAAa,EAAE,GAAG;IAClB,6CAA6C;IAC7C,qBAAqB,EAAE,CAAC;IACxB;;;;;OAKG;IACH,wBAAwB,EAAE,MAAM;IAChC,wDAAwD;IACxD,SAAS,EAAE,GAAG;IACd,iDAAiD;IACjD,YAAY,EAAE,EAAE;IAChB,oDAAoD;IACpD,aAAa,EAAE,IAAI;IACnB,mDAAmD;IACnD,iBAAiB,EAAE,IAAI;IACvB,6BAA6B;IAC7B,eAAe,EAAE,IAAI;IACrB,4DAA4D;IAC5D,eAAe,EAAE,GAAG;IACpB,kEAAkE;IAClE,qBAAqB,EAAE,GAAG;IAC1B,iEAAiE;IACjE,oBAAoB,EAAE,EAAE;IACxB,+BAA+B;IAC/B,eAAe,EAAE,EAAE;IACnB,4BAA4B;IAC5B,gBAAgB,EAAE,GAAG;IACrB,+BAA+B;IAC/B,qBAAqB,EAAE,EAAE;CACjB,CAAC","sourcesContent":["/*\n * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one\n * or more contributor license agreements. Licensed under the Elastic License\n * 2.0; you may not use this file except in compliance with the Elastic License\n * 2.0.\n */\n\nexport type {\n  SlackActionElement,\n  SlackActionsBlock,\n  SlackBlock,\n  SlackButtonElement,\n  SlackCheckboxesElement,\n  SlackContainerBlock,\n  SlackContainerChildBlock,\n  SlackContextBlock,\n  SlackDividerBlock,\n  SlackFileReference,\n  SlackHeaderBlock,\n  SlackHeaderLevel,\n  SlackImageBlock,\n  SlackImageElement,\n  SlackMrkdwnTextObject,\n  SlackMultiStaticSelectElement,\n  SlackOptionGroup,\n  SlackOptionObject,\n  SlackOverflowElement,\n  SlackPlainTextObject,\n  SlackRadioButtonsElement,\n  SlackRawTextElement,\n  SlackRichTextBlock,\n  SlackRichTextBlockElement,\n  SlackRichTextInline,\n  SlackRichTextLink,\n  SlackRichTextList,\n  SlackRichTextPreformatted,\n  SlackRichTextQuote,\n  SlackRichTextSection,\n  SlackRichTextStyle,\n  SlackRichTextTag,\n  SlackRichTextText,\n  SlackSectionAccessory,\n  SlackSectionBlock,\n  SlackStaticSelectElement,\n  SlackTableBlock,\n  SlackTableCell,\n  SlackTableColumnSetting,\n  SlackTagColor,\n  SlackTextObject,\n  SlackVideoBlock,\n} from '../../define/slack_blocks';\n\n/**\n * Slack's published surface limits, enforced by the renderer so a composition\n * cannot silently trip Slack's validation.\n */\nexport const SLACK_LIMITS = {\n  /** Top-level blocks; a `container`'s `child_blocks` do not count. */\n  blocksPerMessage: 50,\n  /** `container.title`, which is `plain_text`. */\n  containerTitleChars: 150,\n  /** `container.subtitle`. */\n  containerSubtitleChars: 150,\n  /** `container.child_blocks`; Slack also requires at least one. */\n  containerChildBlocks: 10,\n  /** `section.text`. */\n  sectionTextChars: 3000,\n  /** One entry of `section.fields`. */\n  sectionFieldChars: 2000,\n  /** One entry of `context.elements`. */\n  contextElementChars: 2000,\n  /** `header.text`, which is `plain_text`. */\n  headerTextChars: 150,\n  fieldsPerSection: 10,\n  /** Elements per `context` block. */\n  contextElements: 10,\n  buttonsPerActions: 25,\n  /** Slack truncates the top-level `text` fallback in notifications around here. */\n  fallbackTextChars: 4000,\n  /** `plain_text` option labels (selects, radio, checkboxes, overflow). */\n  optionTextChars: 75,\n  /** Options per select, or per option group of one. */\n  optionsPerSelect: 100,\n  /** Options per overflow menu (Slack caps overflow at 5). */\n  optionsPerOverflow: 5,\n  /** Options per radio button group or checkboxes element. */\n  optionsPerChoice: 10,\n  /** Option groups per select, each holding up to `optionsPerSelect` options. */\n  optionGroupsPerSelect: 100,\n  /** An option's `value`, which interactions send back. */\n  optionValueChars: 150,\n  /** A button's `value`. */\n  buttonValueChars: 2000,\n  /** A button's or overflow option's `url`. */\n  urlChars: 3000,\n  /** An interactive element's `action_id`. */\n  actionIdChars: 255,\n  /** Max indent level for `rich_text_list`. */\n  richTextListMaxIndent: 8,\n  /**\n   * Characters across every table cell in one message. Slack publishes the\n   * same 10,000 figure per table and per message, so the message-wide\n   * aggregate is the binding one.\n   * https://docs.slack.dev/reference/block-kit/blocks/table-block/\n   */\n  tableCellCharsPerMessage: 10_000,\n  /** Rows per `table` block (includes the header row). */\n  tableRows: 100,\n  /** Cells per `table` row / columns per table. */\n  tableColumns: 20,\n  /** `image`/image-element `image_url` max length. */\n  imageUrlChars: 3000,\n  /** `image`/image-element `alt_text` max length. */\n  imageAltTextChars: 2000,\n  /** `image` block `title`. */\n  imageTitleChars: 2000,\n  /** `video` block `title`; Slack requires fewer than 200. */\n  videoTitleChars: 199,\n  /** `video` block `description`; Slack requires fewer than 200. */\n  videoDescriptionChars: 199,\n  /** `video` block `author_name`; Slack requires fewer than 50. */\n  videoAuthorNameChars: 49,\n  /** `button` element `text`. */\n  buttonTextChars: 75,\n  /** Select `placeholder`. */\n  placeholderChars: 150,\n  /** `option_groups[].label`. */\n  optionGroupLabelChars: 75,\n} as const;\n"]}

package/dist/cjs/render/slack/container.js

@@ -0,0 +1,62 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slackContainer = exports.containerWithChildren = exports.unwrapContainer = exports.isContainer = void 0;
+const blocks_1 = require("./blocks");
+const format_1 = require("./format");
+const unmodeled_1 = require("./unmodeled");
+/** A container Isomer fits, as opposed to one passed through `unmodeledSlackBlock`. */
+const isContainer = (block) => block.type === 'container' && !(0, unmodeled_1.isUnmodeledSlackBlock)(block);
+exports.isContainer = isContainer;
+/** A container as the blocks it holds, led by its title and subtitle. */
+const unwrapContainer = ({ title, rich_text_title, subtitle, child_blocks }, level) => [
+    ...(rich_text_title
+        ? [rich_text_title]
+        : title
+            ? [
+                {
+                    type: 'header',
+                    text: title,
+                    ...(level === undefined ? {} : { level }),
+                },
+            ]
+            : []),
+    ...(subtitle ? [{ type: 'context', elements: [subtitle] }] : []),
+    ...child_blocks,
+];
+exports.unwrapContainer = unwrapContainer;
+/**
+ * `container` holding `children`, with any nested container unwrapped, since
+ * Slack rejects one. A container left with no children, or more than
+ * `containerChildBlocks`, is unwrapped itself.
+ */
+const containerWithChildren = (container, children, level) => {
+    const child_blocks = children.flatMap((child) => (0, exports.isContainer)(child) ? (0, exports.unwrapContainer)(child) : [child]);
+    const refitted = { ...container, child_blocks };
+    return child_blocks.length === 0 ||
+        child_blocks.length > blocks_1.SLACK_LIMITS.containerChildBlocks
+        ? (0, exports.unwrapContainer)(refitted, level)
+        : [refitted];
+};
+exports.containerWithChildren = containerWithChildren;
+/**
+ * A titled section as one Block Kit `container`, from its title and the
+ * blocks its body rendered to, typically through `scope.renderSlack`.
+ *
+ * A nested container among `children` is unwrapped to its title and blocks.
+ * With no children, or more than `SLACK_LIMITS.containerChildBlocks`, the
+ * section falls back to a `header` at `fallbackLevel` followed by the blocks.
+ */
+const slackContainer = (title, children, { fallbackLevel, ...fields } = {}) => (0, exports.containerWithChildren)({
+    type: 'container',
+    title: { type: 'plain_text', text: (0, format_1.formatHeaderText)(title), emoji: true },
+    ...fields,
+    child_blocks: [],
+}, children, fallbackLevel);
+exports.slackContainer = slackContainer;
+//# sourceMappingURL=container.js.map

package/dist/cjs/render/slack/container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"container.js","sourceRoot":"","sources":["../../../../src/render/slack/container.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,qCAMkB;AAClB,qCAA4C;AAC5C,2CAAoD;AAgBpD,uFAAuF;AAChF,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAgC,EAAE,CAC7E,KAAK,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,IAAA,iCAAqB,EAAC,KAAK,CAAC,CAAC;AADjD,QAAA,WAAW,eACsC;AAE9D,yEAAyE;AAClE,MAAM,eAAe,GAAG,CAC7B,EAAE,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAuB,EACvE,KAAwB,EACI,EAAE,CAAC;IAC/B,GAAG,CAAC,eAAe;QACjB,CAAC,CAAC,CAAC,eAAe,CAAC;QACnB,CAAC,CAAC,KAAK;YACL,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,QAAiB;oBACvB,IAAI,EAAE,KAAK;oBACX,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;iBAC1C;aACF;YACH,CAAC,CAAC,EAAE,CAAC;IACT,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAkB,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,GAAG,YAAY;CAChB,CAAC;AAjBW,QAAA,eAAe,mBAiB1B;AAEF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CACnC,SAA8B,EAC9B,QAA+B,EAC/B,KAAwB,EACV,EAAE;IAChB,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC9C,IAAA,mBAAW,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,uBAAe,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CACtD,CAAC;IACF,MAAM,QAAQ,GAAG,EAAE,GAAG,SAAS,EAAE,YAAY,EAAE,CAAC;IAChD,OAAO,YAAY,CAAC,MAAM,KAAK,CAAC;QAC9B,YAAY,CAAC,MAAM,GAAG,qBAAY,CAAC,oBAAoB;QACvD,CAAC,CAAC,IAAA,uBAAe,EAAC,QAAQ,EAAE,KAAK,CAAC;QAClC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AACjB,CAAC,CAAC;AAbW,QAAA,qBAAqB,yBAahC;AAEF;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAC5B,KAAa,EACb,QAA+B,EAC/B,EAAE,aAAa,EAAE,GAAG,MAAM,KAA4B,EAAE,EAC1C,EAAE,CAChB,IAAA,6BAAqB,EACnB;IACE,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAA,yBAAgB,EAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE;IACzE,GAAG,MAAM;IACT,YAAY,EAAE,EAAE;CACjB,EACD,QAAQ,EACR,aAAa,CACd,CAAC;AAdS,QAAA,cAAc,kBAcvB","sourcesContent":["/*\n * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one\n * or more contributor license agreements. Licensed under the Elastic License\n * 2.0; you may not use this file except in compliance with the Elastic License\n * 2.0.\n */\n\nimport {\n  SLACK_LIMITS,\n  type SlackBlock,\n  type SlackContainerBlock,\n  type SlackContainerChildBlock,\n  type SlackHeaderLevel,\n} from './blocks';\nimport { formatHeaderText } from './format';\nimport { isUnmodeledSlackBlock } from './unmodeled';\n\n/** Options for {@link slackContainer}: the container's optional fields, and the level of the `header` it falls back to. */\nexport type SlackContainerOptions = Partial<\n  Pick<\n    SlackContainerBlock,\n    | 'block_id'\n    | 'subtitle'\n    | 'icon'\n    | 'width'\n    | 'is_collapsible'\n    | 'default_collapsed'\n    | 'has_header_divider'\n  >\n> & { fallbackLevel?: SlackHeaderLevel };\n\n/** A container Isomer fits, as opposed to one passed through `unmodeledSlackBlock`. */\nexport const isContainer = (block: SlackBlock): block is SlackContainerBlock =>\n  block.type === 'container' && !isUnmodeledSlackBlock(block);\n\n/** A container as the blocks it holds, led by its title and subtitle. */\nexport const unwrapContainer = (\n  { title, rich_text_title, subtitle, child_blocks }: SlackContainerBlock,\n  level?: SlackHeaderLevel\n): SlackContainerChildBlock[] => [\n  ...(rich_text_title\n    ? [rich_text_title]\n    : title\n      ? [\n          {\n            type: 'header' as const,\n            text: title,\n            ...(level === undefined ? {} : { level }),\n          },\n        ]\n      : []),\n  ...(subtitle ? [{ type: 'context' as const, elements: [subtitle] }] : []),\n  ...child_blocks,\n];\n\n/**\n * `container` holding `children`, with any nested container unwrapped, since\n * Slack rejects one. A container left with no children, or more than\n * `containerChildBlocks`, is unwrapped itself.\n */\nexport const containerWithChildren = (\n  container: SlackContainerBlock,\n  children: readonly SlackBlock[],\n  level?: SlackHeaderLevel\n): SlackBlock[] => {\n  const child_blocks = children.flatMap((child) =>\n    isContainer(child) ? unwrapContainer(child) : [child]\n  );\n  const refitted = { ...container, child_blocks };\n  return child_blocks.length === 0 ||\n    child_blocks.length > SLACK_LIMITS.containerChildBlocks\n    ? unwrapContainer(refitted, level)\n    : [refitted];\n};\n\n/**\n * A titled section as one Block Kit `container`, from its title and the\n * blocks its body rendered to, typically through `scope.renderSlack`.\n *\n * A nested container among `children` is unwrapped to its title and blocks.\n * With no children, or more than `SLACK_LIMITS.containerChildBlocks`, the\n * section falls back to a `header` at `fallbackLevel` followed by the blocks.\n */\nexport const slackContainer = (\n  title: string,\n  children: readonly SlackBlock[],\n  { fallbackLevel, ...fields }: SlackContainerOptions = {}\n): SlackBlock[] =>\n  containerWithChildren(\n    {\n      type: 'container',\n      title: { type: 'plain_text', text: formatHeaderText(title), emoji: true },\n      ...fields,\n      child_blocks: [],\n    },\n    children,\n    fallbackLevel\n  );\n"]}

package/dist/cjs/render/slack/envelope.js

@@ -10,7 +10,9 @@ exports.renderSlackEnvelope = void 0;
 const envelope_1 = require("../text/envelope");
 const assets_1 = require("./assets");
 const blocks_1 = require("./blocks");
+const container_1 = require("./container");
 const format_1 = require("./format");
+const unmodeled_1 = require("./unmodeled");
 /**
  * The composition as a `chat.postMessage` payload: notification `text`, blocks,
  * and the images the host must upload first.
@@ -20,8 +22,9 @@ const format_1 = require("./format");
  * fitted to Slack's limits — text is clamped, blocks past a count limit and
  * `rich_text` elements past a section's limit split, tables past a table limit
  * or the message's cell budget become rich text, spacers and then whole blocks
- * are dropped — so the output is always postable. `assets` stays empty
- * unless `collectAssets` is set.
+ * are dropped — so the output is always postable, except for a block from
+ * `unmodeledSlackBlock` or of a type Isomer does not model, which passes
+ * through unfitted. `assets` stays empty unless `collectAssets` is set.
  */
 const renderSlackEnvelope = (composition, dispatcher, options = {}) => {
     const blocks = [];
@@ -31,15 +34,17 @@ const renderSlackEnvelope = (composition, dispatcher, options = {}) => {
     const collector = options.collectAssets
         ? (0, assets_1.createSlackAssetCollector)(options.assetPrefix === undefined ? {} : { prefix: options.assetPrefix })
         : undefined;
-    const { heading = true } = options;
+    const { heading = true, baseUrl } = options;
+    (0, format_1.assertSlackBaseUrl)(baseUrl);
     if (heading && composition.title) {
         blocks.push(headerBlock(composition.title, 1));
     }
     if (heading && composition.subtitle) {
         blocks.push(contextBlock([(0, format_1.escapeMrkdwn)(composition.subtitle)]));
     }
+    const linkOptions = baseUrl === undefined ? {} : { baseUrl };
     for (const node of composition.body) {
-        blocks.push(...dispatcher.renderSlack(node, collector).flatMap(fitBlock));
+        blocks.push(...dispatcher.renderSlack(node, collector, linkOptions).flatMap(fitBlock));
     }
     // Split after the rhythm, so the fragments of one block read as one.
     const rhythm = applySectionRhythm(coalesceFieldSections(enforceTableLimits(blocks))).flatMap(splitBlockCounts);
@@ -159,7 +164,12 @@ const chunks = (items, size) => Array.from({ length: Math.ceil(items.length / si
 // Splits a block past a count limit into blocks of its type. Only the first
 // keeps a `block_id`, which Slack requires to be unique.
 const splitBlockCounts = (block) => {
+    if ((0, unmodeled_1.isUnmodeledSlackBlock)(block)) {
+        return [block];
+    }
     switch (block.type) {
+        case 'container':
+            return (0, container_1.containerWithChildren)(block, block.child_blocks.flatMap(splitBlockCounts));
         case 'context':
             return chunks(block.elements, blocks_1.SLACK_LIMITS.contextElements).map((elements, index) => index === 0 ? { ...block, elements } : { type: 'context', elements });
         case 'actions':
@@ -208,7 +218,39 @@ const fitImageUrls = (block) => {
             return [block];
     }
 };
-const fitBlock = (block) => fitImageUrls(block).map(clampBlockText);
+const fitBlock = (block) => {
+    if ((0, unmodeled_1.isUnmodeledSlackBlock)(block)) {
+        return [block];
+    }
+    return block.type === 'container'
+        ? fitContainer(block)
+        : fitImageUrls(block).map(clampBlockText);
+};
+const fitContainer = (container) => {
+    const { title, rich_text_title, subtitle, icon, child_blocks } = container;
+    const fitted = {
+        ...container,
+        ...(title && {
+            title: clampText(title, blocks_1.SLACK_LIMITS.containerTitleChars),
+        }),
+        ...(rich_text_title && {
+            rich_text_title: {
+                ...rich_text_title,
+                elements: rich_text_title.elements.flatMap(splitRichTextElement),
+            },
+        }),
+        ...(subtitle && {
+            subtitle: clampText(subtitle, blocks_1.SLACK_LIMITS.containerSubtitleChars),
+        }),
+    };
+    if (icon && fitsImageUrl(icon)) {
+        fitted.icon = clampAlt(icon);
+    }
+    else {
+        delete fitted.icon;
+    }
+    return (0, container_1.containerWithChildren)(fitted, child_blocks.flatMap(fitBlock));
+};
 // Pack renderers build their own blocks, and one overlong text makes Slack
 // reject the whole message.
 const clampBlockText = (block) => {
@@ -271,11 +313,15 @@ const clampBlockText = (block) => {
 };
 const collectSlackFileRefs = (blocks) => {
     const refs = new Set();
-    for (const block of blocks) {
+    const visit = (block) => {
         if (block.type === 'image' && block.slack_file?.ref !== undefined) {
             refs.add(block.slack_file.ref);
         }
-    }
+        else if ((0, container_1.isContainer)(block)) {
+            block.child_blocks.forEach(visit);
+        }
+    };
+    blocks.forEach(visit);
     return refs;
 };
 const headerBlock = (title, level) => ({
@@ -297,16 +343,20 @@ const slackSpacerBlock = () => ({
     type: 'section',
     text: { type: 'mrkdwn', text: SLACK_SPACER_TEXT },
 });
-const isSpacer = (block) => block.type === 'section' &&
+const isSpacer = (block) => !(0, unmodeled_1.isUnmodeledSlackBlock)(block) &&
+    block.type === 'section' &&
     block.text?.type === 'mrkdwn' &&
     block.text.text === SLACK_SPACER_TEXT &&
     block.fields === undefined &&
     block.accessory === undefined;
-const isFieldsOnly = (block) => block.type === 'section' &&
+const isFieldsOnly = (block) => !(0, unmodeled_1.isUnmodeledSlackBlock)(block) &&
+    block.type === 'section' &&
     (block.fields?.length ?? 0) > 0 &&
     block.text === undefined &&
     block.accessory === undefined;
-const isContent = (block) => block.type !== 'header' &&
+// A container sets itself apart, so no spacer goes beside it.
+const isContent = (block) => block.type !== 'container' &&
+    block.type !== 'header' &&
     block.type !== 'divider' &&
     block.type !== 'actions' &&
     block.type !== 'context' &&
@@ -335,7 +385,9 @@ const coalesceFieldSections = (blocks) => {
             out.push({ type: 'section', fields });
             continue;
         }
-        out.push(block);
+        out.push(...((0, container_1.isContainer)(block)
+            ? (0, container_1.containerWithChildren)(block, coalesceFieldSections(block.child_blocks))
+            : [block]));
         index += 1;
     }
     return out;
@@ -520,8 +572,11 @@ const fitsTableShape = ({ rows }) => rows.length > 0 &&
 // kept ones left.
 const enforceTableLimits = (blocks) => {
     let spent = 0;
-    return blocks.flatMap((block) => {
-        if (block.type !== 'table') {
+    const fit = (block) => {
+        if ((0, container_1.isContainer)(block)) {
+            return (0, container_1.containerWithChildren)(block, block.child_blocks.flatMap(fit));
+        }
+        if (block.type !== 'table' || (0, unmodeled_1.isUnmodeledSlackBlock)(block)) {
             return [block];
         }
         const cost = tableCharCount(block);
@@ -531,7 +586,8 @@ const enforceTableLimits = (blocks) => {
             return [block];
         }
         return degradeTable(block);
-    });
+    };
+    return blocks.flatMap(fit);
 };
 const enforceBlockBudget = (blocks) => {
     if (blocks.length <= blocks_1.SLACK_LIMITS.blocksPerMessage) {