@elastic/isomer-sdk 0.0.0 → 0.2.0

package/dist/cjs/render/layout_check.js

@@ -0,0 +1,133 @@
+"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.checkLayout = void 0;
+const anchors_1 = require("./anchors");
+// Sub-pixel rounding reads as overflow without it.
+const tolerance = 1;
+const isScaled = ({ scale = 1 }) => Math.abs(scale - 1) > 0.001;
+const hasArea = ({ width, height }) => width > 0 && height > 0;
+/** Every anchored box, pre-order, including those inside a scaled box, so a type's count matches its nodes. */
+const anchoredBoxes = (box) => {
+    const value = box.attributes?.[anchors_1.NODE_ANCHOR_ATTRIBUTE];
+    return [
+        ...(value === undefined ? [] : [[value, box]]),
+        ...box.children.flatMap(anchoredBoxes),
+    ];
+};
+const roomBoxes = (box) => [
+    ...(box.attributes?.[anchors_1.LAYOUT_ROOM_ATTRIBUTE] === undefined ? [] : [box]),
+    ...box.children.flatMap(roomBoxes),
+];
+/**
+ * The element boxes a node's own content fills: its box and those under it,
+ * down to the nodes nested in it. Text runs are left out because glyphs
+ * overhang a tight line height; a scaled box counts as itself alone.
+ */
+const ownBoxes = (box, nested) => [
+    box,
+    ...(isScaled(box)
+        ? []
+        : box.children.flatMap((child) => nested.has(child) ? [] : ownBoxes(child, nested))),
+];
+/** What a box paints: its text, or itself when it holds nothing else, like a dot or a rule. */
+const painted = (box) => {
+    if (isScaled(box)) {
+        return [box];
+    }
+    const own = box.runs && box.runs.length > 0
+        ? box.runs
+        : box.children.length === 0
+            ? [box]
+            : [];
+    return [...own.filter(hasArea), ...box.children.flatMap(painted)];
+};
+const pastRoom = (room, { x, y, width, height }) => Math.max(room.x - x, room.y - y, x + width - (room.x + room.width), y + height - (room.y + room.height));
+/** How far `a` and `b` would have to move apart, along one axis, to clear each other. */
+const overlapOf = (a, b) => {
+    const width = Math.min(a.x + a.width, b.x + b.width) - Math.max(a.x, b.x);
+    const height = Math.min(a.y + a.height, b.y + b.height) - Math.max(a.y, b.y);
+    if (width <= tolerance || height <= tolerance) {
+        return 0;
+    }
+    return Math.min(a.x + a.width - b.x, b.x + b.width - a.x, a.y + a.height - b.y, b.y + b.height - a.y);
+};
+/**
+ * Where the nodes of `body` run past their room or onto each other in
+ * `layout`, a measured render on `surface` with node anchors on. Empty when
+ * nothing does.
+ *
+ * A node's room is the box of its nearest anchored or `layoutRoom` ancestor,
+ * or `layout` at the top level, and only siblings under one room are
+ * compared. Nothing inside a scaled box is checked. A finding is advice, not an error:
+ * an overlap may be intended.
+ */
+const checkLayout = (layout, body, walk, surface) => {
+    const nodes = (0, anchors_1.anchoredNodePaths)(body, walk, surface);
+    const anchored = anchoredBoxes(layout);
+    const boxes = (0, anchors_1.pairAnchors)(anchored, nodes.map(({ node }) => node));
+    const placed = new Map();
+    boxes.forEach((box, index) => {
+        const { node, path } = nodes[index];
+        const type = (0, anchors_1.nodeType)(node);
+        if (box !== undefined && type !== undefined) {
+            placed.set(box, { box, path, type });
+        }
+    });
+    // Every anchored box bounds its ancestors' content, paired or not.
+    const nested = new Set(anchored.map(([, box]) => box));
+    const bounding = new Set([...nested, ...roomBoxes(layout)]);
+    const rooms = new Map();
+    const siblings = new Map();
+    const visit = (box, parent) => {
+        const node = placed.get(box);
+        if (node !== undefined) {
+            rooms.set(node, parent ?? layout);
+            siblings.set(parent, [...(siblings.get(parent) ?? []), node]);
+        }
+        if (!isScaled(box)) {
+            box.children.forEach((child) => visit(child, bounding.has(box) ? box : parent));
+        }
+    };
+    visit(layout, undefined);
+    const overflows = [...rooms].flatMap(([node, room]) => {
+        const by = Math.max(0, ...ownBoxes(node.box, nested)
+            .filter(hasArea)
+            .map((box) => pastRoom(room, box)));
+        return by > tolerance
+            ? [
+                {
+                    kind: 'overflow',
+                    path: node.path,
+                    type: node.type,
+                    by: Math.round(by),
+                },
+            ]
+            : [];
+    });
+    const overlaps = [...siblings.values()].flatMap((group) => {
+        const paints = group.map(({ box }) => painted(box));
+        return group.flatMap((first, i) => group.slice(i + 1).flatMap((second, offset) => {
+            const by = Math.max(0, ...paints[i].flatMap((a) => paints[i + 1 + offset].map((b) => overlapOf(a, b))));
+            return by > 0
+                ? [
+                    {
+                        kind: 'overlap',
+                        path: first.path,
+                        type: first.type,
+                        with: { path: second.path, type: second.type },
+                        by: Math.round(by),
+                    },
+                ]
+                : [];
+        }));
+    });
+    return [...overflows, ...overlaps];
+};
+exports.checkLayout = checkLayout;
+//# sourceMappingURL=layout_check.js.map

package/dist/cjs/render/layout_check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout_check.js","sourceRoot":"","sources":["../../../src/render/layout_check.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAIH,uCAMmB;AAsCnB,mDAAmD;AACnD,MAAM,SAAS,GAAG,CAAC,CAAC;AAEpB,MAAM,QAAQ,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAa,EAAW,EAAE,CACrD,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;AAE9B,MAAM,OAAO,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAc,EAAW,EAAE,CACzD,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;AAE1B,+GAA+G;AAC/G,MAAM,aAAa,GAAG,CAAC,GAAc,EAAyB,EAAE;IAC9D,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,+BAAqB,CAAC,CAAC;IACtD,OAAO;QACL,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAwB,CAAC,CAAC;QACrE,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC;KACvC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,GAAc,EAAe,EAAE,CAAC;IACjD,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,+BAAqB,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvE,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,QAAQ,GAAG,CACf,GAAc,EACd,MAA8B,EACjB,EAAE,CAAC;IAChB,GAAG;IACH,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;QACf,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC7B,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CACjD,CAAC;CACP,CAAC;AAEF,+FAA+F;AAC/F,MAAM,OAAO,GAAG,CAAC,GAAc,EAAgB,EAAE;IAC/C,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAClB,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IACD,MAAM,GAAG,GACP,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAC7B,CAAC,CAAC,GAAG,CAAC,IAAI;QACV,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,CAAC,GAAG,CAAC;YACP,CAAC,CAAC,EAAE,CAAC;IACX,OAAO,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAc,EAAE,EAAE,CACzE,IAAI,CAAC,GAAG,CACN,IAAI,CAAC,CAAC,GAAG,CAAC,EACV,IAAI,CAAC,CAAC,GAAG,CAAC,EACV,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EACjC,CAAC,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CACpC,CAAC;AAEJ,yFAAyF;AACzF,MAAM,SAAS,GAAG,CAAC,CAAa,EAAE,CAAa,EAAU,EAAE;IACzD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,IAAI,KAAK,IAAI,SAAS,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;QAC9C,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CACb,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EACnB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EACnB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACpB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACrB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CACzB,MAAiB,EACjB,IAAwB,EACxB,IAAqB,EACrB,OAA6B,EACZ,EAAE;IACnB,MAAM,KAAK,GAAG,IAAA,2BAAiB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,IAAA,qBAAW,EACvB,QAAQ,EACR,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC9B,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAChD,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAC3B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,KAAK,CAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,mEAAmE;IACnE,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;IAC/C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAuC,CAAC;IAChE,MAAM,KAAK,GAAG,CAAC,GAAc,EAAE,MAA6B,EAAQ,EAAE;QACpE,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC;YAClC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC7B,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAC/C,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;IACF,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEzB,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAmB,EAAE;QACrE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CACjB,CAAC,EACD,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;aAC1B,MAAM,CAAC,OAAO,CAAC;aACf,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CACrC,CAAC;QACF,OAAO,EAAE,GAAG,SAAS;YACnB,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;iBACnB;aACF;YACH,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACxD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAChC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAmB,EAAE;YAC7D,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CACjB,CAAC,EACD,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1B,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CACpD,CACF,CAAC;YACF,OAAO,EAAE,GAAG,CAAC;gBACX,CAAC,CAAC;oBACE;wBACE,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;wBAC9C,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;qBACnB;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;QACT,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AArFW,QAAA,WAAW,eAqFtB","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 type { ChildNodeWalker } from '../composition/body_node_base';\n\nimport {\n  anchoredNodePaths,\n  LAYOUT_ROOM_ATTRIBUTE,\n  NODE_ANCHOR_ATTRIBUTE,\n  nodeType,\n  pairAnchors,\n} from './anchors';\n\n/** A rectangle on the canvas, in pixels. */\nexport interface LayoutRect {\n  readonly x: number;\n  readonly y: number;\n  readonly width: number;\n  readonly height: number;\n}\n\n/** A laid-out element and the elements nested in it, as a layout engine measures them. */\nexport interface LayoutBox extends LayoutRect {\n  /** Absent means unscaled. */\n  readonly scale?: number;\n  /** Text laid out in the box. */\n  readonly runs?: readonly LayoutRect[];\n  /** Where a {@link NODE_ANCHOR_ATTRIBUTE} is read from. */\n  readonly attributes?: Readonly<Record<string, string>>;\n  readonly children: readonly LayoutBox[];\n}\n\n/** A node drawn past the room its container gives it, or onto a sibling, by `by` pixels. */\nexport interface LayoutFinding {\n  kind: 'overflow' | 'overlap';\n  /** In validation's form, e.g. `body[1].items[0]`. */\n  path: string;\n  type: string;\n  /** The sibling an `overlap` lands on. */\n  with?: { path: string; type: string };\n  by: number;\n}\n\ninterface PlacedNode {\n  box: LayoutBox;\n  path: string;\n  type: string;\n}\n\n// Sub-pixel rounding reads as overflow without it.\nconst tolerance = 1;\n\nconst isScaled = ({ scale = 1 }: LayoutBox): boolean =>\n  Math.abs(scale - 1) > 0.001;\n\nconst hasArea = ({ width, height }: LayoutRect): boolean =>\n  width > 0 && height > 0;\n\n/** Every anchored box, pre-order, including those inside a scaled box, so a type's count matches its nodes. */\nconst anchoredBoxes = (box: LayoutBox): [string, LayoutBox][] => {\n  const value = box.attributes?.[NODE_ANCHOR_ATTRIBUTE];\n  return [\n    ...(value === undefined ? [] : [[value, box] as [string, LayoutBox]]),\n    ...box.children.flatMap(anchoredBoxes),\n  ];\n};\n\nconst roomBoxes = (box: LayoutBox): LayoutBox[] => [\n  ...(box.attributes?.[LAYOUT_ROOM_ATTRIBUTE] === undefined ? [] : [box]),\n  ...box.children.flatMap(roomBoxes),\n];\n\n/**\n * The element boxes a node's own content fills: its box and those under it,\n * down to the nodes nested in it. Text runs are left out because glyphs\n * overhang a tight line height; a scaled box counts as itself alone.\n */\nconst ownBoxes = (\n  box: LayoutBox,\n  nested: ReadonlySet<LayoutBox>\n): LayoutBox[] => [\n  box,\n  ...(isScaled(box)\n    ? []\n    : box.children.flatMap((child) =>\n        nested.has(child) ? [] : ownBoxes(child, nested)\n      )),\n];\n\n/** What a box paints: its text, or itself when it holds nothing else, like a dot or a rule. */\nconst painted = (box: LayoutBox): LayoutRect[] => {\n  if (isScaled(box)) {\n    return [box];\n  }\n  const own =\n    box.runs && box.runs.length > 0\n      ? box.runs\n      : box.children.length === 0\n        ? [box]\n        : [];\n  return [...own.filter(hasArea), ...box.children.flatMap(painted)];\n};\n\nconst pastRoom = (room: LayoutRect, { x, y, width, height }: LayoutRect) =>\n  Math.max(\n    room.x - x,\n    room.y - y,\n    x + width - (room.x + room.width),\n    y + height - (room.y + room.height)\n  );\n\n/** How far `a` and `b` would have to move apart, along one axis, to clear each other. */\nconst overlapOf = (a: LayoutRect, b: LayoutRect): number => {\n  const width = Math.min(a.x + a.width, b.x + b.width) - Math.max(a.x, b.x);\n  const height = Math.min(a.y + a.height, b.y + b.height) - Math.max(a.y, b.y);\n  if (width <= tolerance || height <= tolerance) {\n    return 0;\n  }\n  return Math.min(\n    a.x + a.width - b.x,\n    b.x + b.width - a.x,\n    a.y + a.height - b.y,\n    b.y + b.height - a.y\n  );\n};\n\n/**\n * Where the nodes of `body` run past their room or onto each other in\n * `layout`, a measured render on `surface` with node anchors on. Empty when\n * nothing does.\n *\n * A node's room is the box of its nearest anchored or `layoutRoom` ancestor,\n * or `layout` at the top level, and only siblings under one room are\n * compared. Nothing inside a scaled box is checked. A finding is advice, not an error:\n * an overlap may be intended.\n */\nexport const checkLayout = (\n  layout: LayoutBox,\n  body: readonly unknown[],\n  walk: ChildNodeWalker,\n  surface: 'react' | 'snapshot'\n): LayoutFinding[] => {\n  const nodes = anchoredNodePaths(body, walk, surface);\n  const anchored = anchoredBoxes(layout);\n  const boxes = pairAnchors(\n    anchored,\n    nodes.map(({ node }) => node)\n  );\n  const placed = new Map<LayoutBox, PlacedNode>();\n  boxes.forEach((box, index) => {\n    const { node, path } = nodes[index]!;\n    const type = nodeType(node);\n    if (box !== undefined && type !== undefined) {\n      placed.set(box, { box, path, type });\n    }\n  });\n\n  // Every anchored box bounds its ancestors' content, paired or not.\n  const nested = new Set(anchored.map(([, box]) => box));\n  const bounding = new Set([...nested, ...roomBoxes(layout)]);\n  const rooms = new Map<PlacedNode, LayoutBox>();\n  const siblings = new Map<LayoutBox | undefined, PlacedNode[]>();\n  const visit = (box: LayoutBox, parent: LayoutBox | undefined): void => {\n    const node = placed.get(box);\n    if (node !== undefined) {\n      rooms.set(node, parent ?? layout);\n      siblings.set(parent, [...(siblings.get(parent) ?? []), node]);\n    }\n    if (!isScaled(box)) {\n      box.children.forEach((child) =>\n        visit(child, bounding.has(box) ? box : parent)\n      );\n    }\n  };\n  visit(layout, undefined);\n\n  const overflows = [...rooms].flatMap(([node, room]): LayoutFinding[] => {\n    const by = Math.max(\n      0,\n      ...ownBoxes(node.box, nested)\n        .filter(hasArea)\n        .map((box) => pastRoom(room, box))\n    );\n    return by > tolerance\n      ? [\n          {\n            kind: 'overflow',\n            path: node.path,\n            type: node.type,\n            by: Math.round(by),\n          },\n        ]\n      : [];\n  });\n\n  const overlaps = [...siblings.values()].flatMap((group) => {\n    const paints = group.map(({ box }) => painted(box));\n    return group.flatMap((first, i) =>\n      group.slice(i + 1).flatMap((second, offset): LayoutFinding[] => {\n        const by = Math.max(\n          0,\n          ...paints[i]!.flatMap((a) =>\n            paints[i + 1 + offset]!.map((b) => overlapOf(a, b))\n          )\n        );\n        return by > 0\n          ? [\n              {\n                kind: 'overlap',\n                path: first.path,\n                type: first.type,\n                with: { path: second.path, type: second.type },\n                by: Math.round(by),\n              },\n            ]\n          : [];\n      })\n    );\n  });\n\n  return [...overflows, ...overlaps];\n};\n"]}

package/dist/cjs/render/markdown/builder.js

@@ -0,0 +1,195 @@
+"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.serializeMarkdown = exports.markdownBlocks = exports.md = exports.VERBATIM_TYPE = void 0;
+const mdast_util_gfm_1 = require("mdast-util-gfm");
+const mdast_util_to_markdown_1 = require("mdast-util-to-markdown");
+const one_line_1 = require("../../composition/one_line");
+const markdown_content_1 = require("../../define/markdown_content");
+const url_1 = require("../../validate/url");
+const format_1 = require("./format");
+// A fence-info string only allows word-ish tokens; anything else would
+// terminate the fence early or inject markdown.
+const FENCE_INFO_RE = /^[\w+#.-]+$/;
+/** The node type of Markdown printed as written. */
+exports.VERBATIM_TYPE = 'isomerVerbatim';
+const inline = (node) => Object.assign(node, { [markdown_content_1.markdownContent]: 'inline' });
+const block = (node) => Object.assign(node, { [markdown_content_1.markdownContent]: 'block' });
+const isContentList = (content) => Array.isArray(content);
+const isInlineList = (label) => Array.isArray(label);
+const phrasing = (input) => typeof input === 'string'
+    ? { type: 'text', value: (0, one_line_1.oneLine)(input) }
+    : input;
+const emptyText = () => ({ type: 'text', value: '' });
+const isEmptyText = (node) => node.type === 'text' && node.value === '';
+// A break at either edge prints as a literal `\` or loose markers.
+const withoutEdgeBreaks = (inputs) => {
+    const children = inputs.map(phrasing).filter((node) => !isEmptyText(node));
+    let start = 0;
+    let end = children.length;
+    while (start < end && children[start].type === 'break') {
+        start += 1;
+    }
+    while (end > start && children[end - 1].type === 'break') {
+        end -= 1;
+    }
+    return children.slice(start, end);
+};
+// Only a paragraph breaks a line: a heading with one turns setext, and the
+// Slack fallback reads a line at a time.
+const inlineChildren = (inputs) => withoutEdgeBreaks(inputs).map((node) => node.type === 'break' ? { type: 'text', value: ' ' } : node);
+const rootContent = (content) => isContentList(content)
+    ? content.flatMap(rootContent)
+    : [content];
+const isInlineInput = (item) => typeof item === 'string' ||
+    (!isContentList(item) && item[markdown_content_1.markdownContent] === 'inline');
+const itemContent = (item) => isInlineInput(item)
+    ? [{ type: 'paragraph', children: withoutEdgeBreaks([item]) }]
+    : rootContent(item);
+// GFM reads a list number of at most nine digits, so the last item's must fit.
+const MAX_LIST_NUMBER = 999_999_999;
+const isListStart = (start, count) => start !== undefined &&
+    Number.isInteger(start) &&
+    start >= 0 &&
+    start + Math.max(count - 1, 0) <= MAX_LIST_NUMBER;
+// Printed as written, for Markdown that is already safe. Trailing whitespace
+// would add blank lines between blocks. `source` is the authored text when
+// sanitizing degraded it to inert text, whose escapes only Markdown resolves;
+// surfaces that print literal text read it instead.
+const verbatim = (markdown, source) => block({
+    type: exports.VERBATIM_TYPE,
+    value: markdown.trimEnd(),
+    ...(source === undefined ? {} : { source }),
+});
+// An empty wrapper prints its markers alone: `****` reads as a thematic break.
+const wrapper = (type, inputs) => {
+    const children = inlineChildren(inputs);
+    return inline(children.length === 0 ? emptyText() : { type, children });
+};
+const inlineRuns = (runs) => inlineChildren(isInlineList(runs) ? runs : [runs]);
+/**
+ * Builds Markdown as content rather than strings, so escaping follows where
+ * each value lands. Links and images apply the URL policy in
+ * `src/validate/url.ts`: a blocked link keeps its label on
+ * {@link BLOCKED_HREF}, and a blocked image degrades to its alt text.
+ *
+ * @example
+ * md.list(rows.map((row) => md.paragraph(md.strong(row.label), ': ', row.value)))
+ */
+exports.md = {
+    text: (value) => inline(phrasing(value)),
+    strong: (...children) => wrapper('strong', children),
+    emphasis: (...children) => wrapper('emphasis', children),
+    code: (value) => inline(value === '' ? emptyText() : { type: 'inlineCode', value: (0, one_line_1.oneLine)(value) }),
+    link: (label, href) => inline({
+        type: 'link',
+        url: (0, url_1.sanitizeNavigationHref)(href) ?? url_1.BLOCKED_HREF,
+        children: inlineRuns(label),
+    }),
+    image: (alt, src) => {
+        const url = (0, url_1.sanitizeAssetUrl)(src);
+        return url === null
+            ? inline(phrasing(alt))
+            : inline({ type: 'image', url, alt: (0, one_line_1.oneLine)(alt) });
+    },
+    /** A hard line break, printed as a backslash before the line ending. Inside a heading, strong, emphasis, link label, or table cell it is a space; at the start or end of any of these, or of a paragraph, it is dropped. */
+    break: () => inline({ type: 'break' }),
+    paragraph: (...children) => block({ type: 'paragraph', children: withoutEdgeBreaks(children) }),
+    heading: (depth, ...children) => block({ type: 'heading', depth, children: inlineChildren(children) }),
+    /** A quote with no blocks, such as one holding only a hidden child, is dropped. */
+    blockquote: (...children) => {
+        const content = rootContent(children);
+        return content.length === 0
+            ? []
+            : block({
+                type: 'blockquote',
+                children: content,
+            });
+    },
+    /**
+     * An item that is inline input becomes one paragraph; one with no blocks,
+     * such as a hidden child, is dropped. A `start` that would print a marker
+     * GFM does not read as a list number is ignored.
+     */
+    list: (items, { ordered = false, start } = {}) => {
+        const children = items.flatMap((item) => {
+            const content = itemContent(item);
+            return content.length === 0
+                ? []
+                : [{ type: 'listItem', spread: false, children: content }];
+        });
+        return block({
+            type: 'list',
+            ordered,
+            ...(isListStart(start, children.length) ? { start } : {}),
+            spread: false,
+            children,
+        });
+    },
+    /** A cell is one inline run or several. GFM trims a cell's edge whitespace. */
+    table: (columns, rows) => block({
+        type: 'table',
+        children: [columns, ...rows].map((cells) => ({
+            type: 'tableRow',
+            children: cells.map((cell) => ({
+                type: 'tableCell',
+                children: inlineRuns(cell),
+            })),
+        })),
+    }),
+    /** An unsafe `language` is dropped. */
+    codeBlock: (value, language) => block({
+        type: 'code',
+        lang: language !== undefined && FENCE_INFO_RE.test(language)
+            ? language
+            : null,
+        value,
+    }),
+    /** Authored Markdown source, after {@link sanitizeAuthoredSource}; whitespace-only source is dropped. */
+    authored: (source) => {
+        if (source.trim() === '') {
+            return [];
+        }
+        const { markdown, inert } = (0, format_1.sanitizeAuthoredSource)(source);
+        return verbatim(markdown, inert ? source : undefined);
+    },
+};
+const asText = (node, ...rest) => mdast_util_to_markdown_1.defaultHandlers.text({ type: 'text', value: node.value ?? node.alt ?? '' }, ...rest);
+// The URL policy again at serialization, for content built outside `md`.
+const handlers = {
+    link: (node, ...rest) => mdast_util_to_markdown_1.defaultHandlers.link({ ...node, url: (0, url_1.sanitizeNavigationHref)(node.url) ?? url_1.BLOCKED_HREF }, ...rest),
+    definition: (node, ...rest) => mdast_util_to_markdown_1.defaultHandlers.definition({ ...node, url: (0, url_1.sanitizeNavigationHref)(node.url) ?? url_1.BLOCKED_HREF }, ...rest),
+    image: (node, ...rest) => {
+        const url = (0, url_1.sanitizeAssetUrl)(node.url);
+        return url === null
+            ? asText(node, ...rest)
+            : mdast_util_to_markdown_1.defaultHandlers.image({ ...node, url }, ...rest);
+    },
+    html: asText,
+    [exports.VERBATIM_TYPE]: (node) => node.value,
+};
+const OPTIONS = {
+    bullet: '-',
+    // With `*`, emphasis around strong prints `***x***`, which the Slack
+    // fallback cannot split. `_` costs character references around emphasis
+    // inside a word.
+    emphasis: '_',
+    fence: '`',
+    listItemIndent: 'one',
+    rule: '-',
+    strong: '*',
+    extensions: [(0, mdast_util_gfm_1.gfmToMarkdown)({ tablePipeAlign: false })],
+    handlers: handlers,
+};
+/** `content` as flat mdast blocks, typed `unknown` so no declaration names mdast. */
+const markdownBlocks = (content) => rootContent(content);
+exports.markdownBlocks = markdownBlocks;
+/** `content` as GFM, without a trailing line break. */
+const serializeMarkdown = (content) => (0, mdast_util_to_markdown_1.toMarkdown)({ type: 'root', children: rootContent(content) }, OPTIONS).replace(/\n$/, '');
+exports.serializeMarkdown = serializeMarkdown;
+//# sourceMappingURL=builder.js.map

package/dist/cjs/render/markdown/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../../src/render/markdown/builder.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAeH,mDAA+C;AAC/C,mEAKgC;AAEhC,yDAAqD;AACrD,oEAMuC;AACvC,4CAI4B;AAE5B,qCAAkD;AAElD,uEAAuE;AACvE,gDAAgD;AAChD,MAAM,aAAa,GAAG,aAAa,CAAC;AACpC,oDAAoD;AACvC,QAAA,aAAa,GAAG,gBAAgB,CAAC;AAE9C,MAAM,MAAM,GAAG,CAAC,IAAqB,EAAkB,EAAE,CACvD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,kCAAe,CAAC,EAAE,QAAiB,EAAE,CAAC,CAAC;AAEhE,MAAM,KAAK,GAAG,CAAC,IAAiB,EAAiB,EAAE,CACjD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,kCAAe,CAAC,EAAE,OAAgB,EAAE,CAAC,CAAC;AAE/D,MAAM,aAAa,GAAG,CACpB,OAAyC,EACF,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAEnE,MAAM,YAAY,GAAG,CACnB,KAA2D,EAClB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEnE,MAAM,QAAQ,GAAG,CAAC,KAA0B,EAAmB,EAAE,CAC/D,OAAO,KAAK,KAAK,QAAQ;IACvB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,kBAAO,EAAC,KAAK,CAAC,EAAE;IACzC,CAAC,CAAE,KAAoC,CAAC;AAE5C,MAAM,SAAS,GAAG,GAAoB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;AAEvE,MAAM,WAAW,GAAG,CAAC,IAAqB,EAAW,EAAE,CACrD,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;AAE5C,mEAAmE;AACnE,MAAM,iBAAiB,GAAG,CACxB,MAAsC,EACnB,EAAE;IACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC1B,OAAO,KAAK,GAAG,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAE,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACxD,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,OAAO,GAAG,GAAG,KAAK,IAAI,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAE,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC1D,GAAG,IAAI,CAAC,CAAC;IACX,CAAC;IACD,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,2EAA2E;AAC3E,yCAAyC;AACzC,MAAM,cAAc,GAAG,CACrB,MAAsC,EACnB,EAAE,CACrB,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACrC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAC5D,CAAC;AAEJ,MAAM,WAAW,GAAG,CAAC,OAAwB,EAAiB,EAAE,CAC9D,aAAa,CAAC,OAAO,CAAC;IACpB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAC9B,CAAC,CAAC,CAAC,OAAiC,CAAC,CAAC;AAE1C,MAAM,aAAa,GAAG,CACpB,IAA2C,EACd,EAAE,CAC/B,OAAO,IAAI,KAAK,QAAQ;IACxB,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,kCAAe,CAAC,KAAK,QAAQ,CAAC,CAAC;AAE/D,MAAM,WAAW,GAAG,CAClB,IAA2C,EACrB,EAAE,CACxB,aAAa,CAAC,IAAI,CAAC;IACjB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAC9D,CAAC,CAAE,WAAW,CAAC,IAAI,CAA0B,CAAC;AAElD,+EAA+E;AAC/E,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,MAAM,WAAW,GAAG,CAClB,KAAyB,EACzB,KAAa,EACI,EAAE,CACnB,KAAK,KAAK,SAAS;IACnB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;IACvB,KAAK,IAAI,CAAC;IACV,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,eAAe,CAAC;AAEpD,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,oDAAoD;AACpD,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,MAAe,EAAiB,EAAE,CACpE,KAAK,CAAC;IACJ,IAAI,EAAE,qBAAa;IACnB,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE;IACzB,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC,CAAC;AAE/B,+EAA+E;AAC/E,MAAM,OAAO,GAAG,CACd,IAA2B,EAC3B,MAA6B,EACb,EAAE;IAClB,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CACjB,IAA0D,EACvC,EAAE,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAE3E;;;;;;;;GAQG;AACU,QAAA,EAAE,GAAG;IAChB,IAAI,EAAE,CAAC,KAAa,EAAkB,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,GAAG,QAA+B,EAAkB,EAAE,CAC7D,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC7B,QAAQ,EAAE,CAAC,GAAG,QAA+B,EAAkB,EAAE,CAC/D,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC/B,IAAI,EAAE,CAAC,KAAa,EAAkB,EAAE,CACtC,MAAM,CACJ,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,IAAA,kBAAO,EAAC,KAAK,CAAC,EAAE,CAC3E;IACH,IAAI,EAAE,CACJ,KAA2D,EAC3D,IAAY,EACI,EAAE,CAClB,MAAM,CAAC;QACL,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,IAAA,4BAAsB,EAAC,IAAI,CAAC,IAAI,kBAAY;QACjD,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC;KAC5B,CAAC;IACJ,KAAK,EAAE,CAAC,GAAW,EAAE,GAAW,EAAkB,EAAE;QAClD,MAAM,GAAG,GAAG,IAAA,sBAAgB,EAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,KAAK,IAAI;YACjB,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,IAAA,kBAAO,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,4NAA4N;IAC5N,KAAK,EAAE,GAAmB,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACtD,SAAS,EAAE,CAAC,GAAG,QAA+B,EAAiB,EAAE,CAC/D,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;IACrE,OAAO,EAAE,CACP,KAA4B,EAC5B,GAAG,QAA+B,EACnB,EAAE,CACjB,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IACvE,mFAAmF;IACnF,UAAU,EAAE,CAAC,GAAG,QAA2B,EAAmB,EAAE;QAC9D,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,KAAK,CAAC;gBACJ,IAAI,EAAE,YAAY;gBAClB,QAAQ,EAAE,OAAiC;aAC5C,CAAC,CAAC;IACT,CAAC;IACD;;;;OAIG;IACH,IAAI,EAAE,CACJ,KAAyD,EACzD,EAAE,OAAO,GAAG,KAAK,EAAE,KAAK,KAA4C,EAAE,EACvD,EAAE;QACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAc,EAAE;YAClD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC;gBACzB,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;YACX,IAAI,EAAE,MAAM;YACZ,OAAO;YACP,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzD,MAAM,EAAE,KAAK;YACb,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IACD,+EAA+E;IAC/E,KAAK,EAAE,CACL,OAA0E,EAC1E,IAEM,EACS,EAAE,CACjB,KAAK,CAAC;QACJ,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAY,EAAE,CAAC,CAAC;YACrD,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC7B,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;SACJ,CAAC,CAAC;KACJ,CAAC;IACJ,uCAAuC;IACvC,SAAS,EAAE,CAAC,KAAa,EAAE,QAAiB,EAAiB,EAAE,CAC7D,KAAK,CAAC;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EACF,QAAQ,KAAK,SAAS,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC;YACpD,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,IAAI;QACV,KAAK;KACN,CAAC;IACJ,yGAAyG;IACzG,QAAQ,EAAE,CAAC,MAAc,EAAmB,EAAE;QAC5C,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAA,+BAAsB,EAAC,MAAM,CAAC,CAAC;QAC3D,OAAO,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,GAAW,CACrB,IAA6C,EAC7C,GAAG,IAAI,EACP,EAAE,CACF,wCAAe,CAAC,IAAI,CAClB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE,EACrD,GAAG,IAAI,CACR,CAAC;AAEJ,yEAAyE;AACzE,MAAM,QAAQ,GAA2B;IACvC,IAAI,EAAE,CAAC,IAAU,EAAE,GAAG,IAAI,EAAE,EAAE,CAC5B,wCAAe,CAAC,IAAI,CAClB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,IAAA,4BAAsB,EAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAY,EAAE,EAClE,GAAG,IAAI,CACR;IACH,UAAU,EAAE,CAAC,IAAgB,EAAE,GAAG,IAAI,EAAE,EAAE,CACxC,wCAAe,CAAC,UAAU,CACxB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,IAAA,4BAAsB,EAAC,IAAI,CAAC,GAAG,CAAC,IAAI,kBAAY,EAAE,EAClE,GAAG,IAAI,CACR;IACH,KAAK,EAAE,CAAC,IAAW,EAAE,GAAG,IAAI,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,IAAA,sBAAgB,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,GAAG,KAAK,IAAI;YACjB,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;YACvB,CAAC,CAAC,wCAAe,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,EAAE,MAAM;IACZ,CAAC,qBAAa,CAAC,EAAE,CAAC,IAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK;CACzD,CAAC;AAEF,MAAM,OAAO,GAAY;IACvB,MAAM,EAAE,GAAG;IACX,qEAAqE;IACrE,wEAAwE;IACxE,iBAAiB;IACjB,QAAQ,EAAE,GAAG;IACb,KAAK,EAAE,GAAG;IACV,cAAc,EAAE,KAAK;IACrB,IAAI,EAAE,GAAG;IACT,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,CAAC,IAAA,8BAAa,EAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,QAAQ,EAAE,QAA+B;CAC1C,CAAC;AAEF,qFAAqF;AAC9E,MAAM,cAAc,GAAG,CAAC,OAAwB,EAAsB,EAAE,CAC7E,WAAW,CAAC,OAAO,CAAC,CAAC;AADV,QAAA,cAAc,kBACJ;AAEvB,uDAAuD;AAChD,MAAM,iBAAiB,GAAG,CAAC,OAAwB,EAAU,EAAE,CACpE,IAAA,mCAAU,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,OAAO,CAC3E,KAAK,EACL,EAAE,CACH,CAAC;AAJS,QAAA,iBAAiB,qBAI1B","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 is mdast under a brand. Every mdast type stays inside this\n// module, so no emitted declaration names one.\n\nimport type {\n  Blockquote,\n  Definition,\n  Image,\n  Link,\n  ListItem,\n  PhrasingContent,\n  RootContent,\n  TableRow,\n} from 'mdast';\nimport { gfmToMarkdown } from 'mdast-util-gfm';\nimport {\n  defaultHandlers,\n  type Handle,\n  type Options,\n  toMarkdown,\n} from 'mdast-util-to-markdown';\n\nimport { oneLine } from '../../composition/one_line';\nimport {\n  type MarkdownBlock,\n  type MarkdownContent,\n  markdownContent,\n  type MarkdownInline,\n  type MarkdownInlineInput,\n} from '../../define/markdown_content';\nimport {\n  BLOCKED_HREF,\n  sanitizeAssetUrl,\n  sanitizeNavigationHref,\n} from '../../validate/url';\n\nimport { sanitizeAuthoredSource } from './format';\n\n// A fence-info string only allows word-ish tokens; anything else would\n// terminate the fence early or inject markdown.\nconst FENCE_INFO_RE = /^[\\w+#.-]+$/;\n/** The node type of Markdown printed as written. */\nexport const VERBATIM_TYPE = 'isomerVerbatim';\n\nconst inline = (node: PhrasingContent): MarkdownInline =>\n  Object.assign(node, { [markdownContent]: 'inline' as const });\n\nconst block = (node: RootContent): MarkdownBlock =>\n  Object.assign(node, { [markdownContent]: 'block' as const });\n\nconst isContentList = (\n  content: MarkdownInline | MarkdownContent\n): content is readonly MarkdownContent[] => Array.isArray(content);\n\nconst isInlineList = (\n  label: MarkdownInlineInput | readonly MarkdownInlineInput[]\n): label is readonly MarkdownInlineInput[] => Array.isArray(label);\n\nconst phrasing = (input: MarkdownInlineInput): PhrasingContent =>\n  typeof input === 'string'\n    ? { type: 'text', value: oneLine(input) }\n    : (input as unknown as PhrasingContent);\n\nconst emptyText = (): PhrasingContent => ({ type: 'text', value: '' });\n\nconst isEmptyText = (node: PhrasingContent): boolean =>\n  node.type === 'text' && node.value === '';\n\n// A break at either edge prints as a literal `\\` or loose markers.\nconst withoutEdgeBreaks = (\n  inputs: readonly MarkdownInlineInput[]\n): PhrasingContent[] => {\n  const children = inputs.map(phrasing).filter((node) => !isEmptyText(node));\n  let start = 0;\n  let end = children.length;\n  while (start < end && children[start]!.type === 'break') {\n    start += 1;\n  }\n  while (end > start && children[end - 1]!.type === 'break') {\n    end -= 1;\n  }\n  return children.slice(start, end);\n};\n\n// Only a paragraph breaks a line: a heading with one turns setext, and the\n// Slack fallback reads a line at a time.\nconst inlineChildren = (\n  inputs: readonly MarkdownInlineInput[]\n): PhrasingContent[] =>\n  withoutEdgeBreaks(inputs).map((node) =>\n    node.type === 'break' ? { type: 'text', value: ' ' } : node\n  );\n\nconst rootContent = (content: MarkdownContent): RootContent[] =>\n  isContentList(content)\n    ? content.flatMap(rootContent)\n    : [content as unknown as RootContent];\n\nconst isInlineInput = (\n  item: MarkdownInlineInput | MarkdownContent\n): item is MarkdownInlineInput =>\n  typeof item === 'string' ||\n  (!isContentList(item) && item[markdownContent] === 'inline');\n\nconst itemContent = (\n  item: MarkdownInlineInput | MarkdownContent\n): ListItem['children'] =>\n  isInlineInput(item)\n    ? [{ type: 'paragraph', children: withoutEdgeBreaks([item]) }]\n    : (rootContent(item) as ListItem['children']);\n\n// GFM reads a list number of at most nine digits, so the last item's must fit.\nconst MAX_LIST_NUMBER = 999_999_999;\n\nconst isListStart = (\n  start: number | undefined,\n  count: number\n): start is number =>\n  start !== undefined &&\n  Number.isInteger(start) &&\n  start >= 0 &&\n  start + Math.max(count - 1, 0) <= MAX_LIST_NUMBER;\n\n// Printed as written, for Markdown that is already safe. Trailing whitespace\n// would add blank lines between blocks. `source` is the authored text when\n// sanitizing degraded it to inert text, whose escapes only Markdown resolves;\n// surfaces that print literal text read it instead.\nconst verbatim = (markdown: string, source?: string): MarkdownBlock =>\n  block({\n    type: VERBATIM_TYPE,\n    value: markdown.trimEnd(),\n    ...(source === undefined ? {} : { source }),\n  } as unknown as RootContent);\n\n// An empty wrapper prints its markers alone: `****` reads as a thematic break.\nconst wrapper = (\n  type: 'strong' | 'emphasis',\n  inputs: MarkdownInlineInput[]\n): MarkdownInline => {\n  const children = inlineChildren(inputs);\n  return inline(children.length === 0 ? emptyText() : { type, children });\n};\n\nconst inlineRuns = (\n  runs: MarkdownInlineInput | readonly MarkdownInlineInput[]\n): PhrasingContent[] => inlineChildren(isInlineList(runs) ? runs : [runs]);\n\n/**\n * Builds Markdown as content rather than strings, so escaping follows where\n * each value lands. Links and images apply the URL policy in\n * `src/validate/url.ts`: a blocked link keeps its label on\n * {@link BLOCKED_HREF}, and a blocked image degrades to its alt text.\n *\n * @example\n * md.list(rows.map((row) => md.paragraph(md.strong(row.label), ': ', row.value)))\n */\nexport const md = {\n  text: (value: string): MarkdownInline => inline(phrasing(value)),\n  strong: (...children: MarkdownInlineInput[]): MarkdownInline =>\n    wrapper('strong', children),\n  emphasis: (...children: MarkdownInlineInput[]): MarkdownInline =>\n    wrapper('emphasis', children),\n  code: (value: string): MarkdownInline =>\n    inline(\n      value === '' ? emptyText() : { type: 'inlineCode', value: oneLine(value) }\n    ),\n  link: (\n    label: MarkdownInlineInput | readonly MarkdownInlineInput[],\n    href: string\n  ): MarkdownInline =>\n    inline({\n      type: 'link',\n      url: sanitizeNavigationHref(href) ?? BLOCKED_HREF,\n      children: inlineRuns(label),\n    }),\n  image: (alt: string, src: string): MarkdownInline => {\n    const url = sanitizeAssetUrl(src);\n    return url === null\n      ? inline(phrasing(alt))\n      : inline({ type: 'image', url, alt: oneLine(alt) });\n  },\n  /** A hard line break, printed as a backslash before the line ending. Inside a heading, strong, emphasis, link label, or table cell it is a space; at the start or end of any of these, or of a paragraph, it is dropped. */\n  break: (): MarkdownInline => inline({ type: 'break' }),\n  paragraph: (...children: MarkdownInlineInput[]): MarkdownBlock =>\n    block({ type: 'paragraph', children: withoutEdgeBreaks(children) }),\n  heading: (\n    depth: 1 | 2 | 3 | 4 | 5 | 6,\n    ...children: MarkdownInlineInput[]\n  ): MarkdownBlock =>\n    block({ type: 'heading', depth, children: inlineChildren(children) }),\n  /** A quote with no blocks, such as one holding only a hidden child, is dropped. */\n  blockquote: (...children: MarkdownContent[]): MarkdownContent => {\n    const content = rootContent(children);\n    return content.length === 0\n      ? []\n      : block({\n          type: 'blockquote',\n          children: content as Blockquote['children'],\n        });\n  },\n  /**\n   * An item that is inline input becomes one paragraph; one with no blocks,\n   * such as a hidden child, is dropped. A `start` that would print a marker\n   * GFM does not read as a list number is ignored.\n   */\n  list: (\n    items: readonly (MarkdownInlineInput | MarkdownContent)[],\n    { ordered = false, start }: { ordered?: boolean; start?: number } = {}\n  ): MarkdownBlock => {\n    const children = items.flatMap((item): ListItem[] => {\n      const content = itemContent(item);\n      return content.length === 0\n        ? []\n        : [{ type: 'listItem', spread: false, children: content }];\n    });\n    return block({\n      type: 'list',\n      ordered,\n      ...(isListStart(start, children.length) ? { start } : {}),\n      spread: false,\n      children,\n    });\n  },\n  /** A cell is one inline run or several. GFM trims a cell's edge whitespace. */\n  table: (\n    columns: readonly (MarkdownInlineInput | readonly MarkdownInlineInput[])[],\n    rows: readonly (readonly (\n      MarkdownInlineInput | readonly MarkdownInlineInput[]\n    )[])[]\n  ): MarkdownBlock =>\n    block({\n      type: 'table',\n      children: [columns, ...rows].map((cells): TableRow => ({\n        type: 'tableRow',\n        children: cells.map((cell) => ({\n          type: 'tableCell',\n          children: inlineRuns(cell),\n        })),\n      })),\n    }),\n  /** An unsafe `language` is dropped. */\n  codeBlock: (value: string, language?: string): MarkdownBlock =>\n    block({\n      type: 'code',\n      lang:\n        language !== undefined && FENCE_INFO_RE.test(language)\n          ? language\n          : null,\n      value,\n    }),\n  /** Authored Markdown source, after {@link sanitizeAuthoredSource}; whitespace-only source is dropped. */\n  authored: (source: string): MarkdownContent => {\n    if (source.trim() === '') {\n      return [];\n    }\n    const { markdown, inert } = sanitizeAuthoredSource(source);\n    return verbatim(markdown, inert ? source : undefined);\n  },\n};\n\nconst asText: Handle = (\n  node: { value?: string; alt?: string | null },\n  ...rest\n) =>\n  defaultHandlers.text(\n    { type: 'text', value: node.value ?? node.alt ?? '' },\n    ...rest\n  );\n\n// The URL policy again at serialization, for content built outside `md`.\nconst handlers: Record<string, Handle> = {\n  link: (node: Link, ...rest) =>\n    defaultHandlers.link(\n      { ...node, url: sanitizeNavigationHref(node.url) ?? BLOCKED_HREF },\n      ...rest\n    ),\n  definition: (node: Definition, ...rest) =>\n    defaultHandlers.definition(\n      { ...node, url: sanitizeNavigationHref(node.url) ?? BLOCKED_HREF },\n      ...rest\n    ),\n  image: (node: Image, ...rest) => {\n    const url = sanitizeAssetUrl(node.url);\n    return url === null\n      ? asText(node, ...rest)\n      : defaultHandlers.image({ ...node, url }, ...rest);\n  },\n  html: asText,\n  [VERBATIM_TYPE]: (node: { value: string }) => node.value,\n};\n\nconst OPTIONS: Options = {\n  bullet: '-',\n  // With `*`, emphasis around strong prints `***x***`, which the Slack\n  // fallback cannot split. `_` costs character references around emphasis\n  // inside a word.\n  emphasis: '_',\n  fence: '`',\n  listItemIndent: 'one',\n  rule: '-',\n  strong: '*',\n  extensions: [gfmToMarkdown({ tablePipeAlign: false })],\n  handlers: handlers as Options['handlers'],\n};\n\n/** `content` as flat mdast blocks, typed `unknown` so no declaration names mdast. */\nexport const markdownBlocks = (content: MarkdownContent): readonly unknown[] =>\n  rootContent(content);\n\n/** `content` as GFM, without a trailing line break. */\nexport const serializeMarkdown = (content: MarkdownContent): string =>\n  toMarkdown({ type: 'root', children: rootContent(content) }, OPTIONS).replace(\n    /\\n$/,\n    ''\n  );\n"]}

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

@@ -0,0 +1,33 @@
+"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.renderMarkdownEnvelope = void 0;
+const builder_1 = require("./builder");
+/**
+ * The composition as GFM: title as `h1`, subtitle italicized, then every node
+ * that rendered anything. The title and subtitle are text, escaped by
+ * {@link serializeMarkdown}.
+ */
+const renderMarkdownEnvelope = (composition, dispatcher, { heading = true } = {}) => {
+    const blocks = [];
+    if (heading && composition.title) {
+        blocks.push((0, builder_1.serializeMarkdown)(builder_1.md.heading(1, composition.title)));
+    }
+    if (heading && composition.subtitle) {
+        blocks.push((0, builder_1.serializeMarkdown)(builder_1.md.paragraph(builder_1.md.emphasis(composition.subtitle))));
+    }
+    for (const node of composition.body) {
+        const rendered = dispatcher.renderMarkdown(node);
+        if (rendered.length > 0) {
+            blocks.push(rendered);
+        }
+    }
+    return blocks.join('\n\n');
+};
+exports.renderMarkdownEnvelope = renderMarkdownEnvelope;
+//# sourceMappingURL=envelope.js.map

package/dist/cjs/render/markdown/envelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"envelope.js","sourceRoot":"","sources":["../../../../src/render/markdown/envelope.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAMH,uCAAkD;AAgBlD;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,CACpC,WAA+B,EAC/B,UAA6C,EAC7C,EAAE,OAAO,GAAG,IAAI,KAA8B,EAAE,EACxC,EAAE;IACV,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,IAAA,2BAAiB,EAAC,YAAE,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,OAAO,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,CACT,IAAA,2BAAiB,EAAC,YAAE,CAAC,SAAS,CAAC,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CACnE,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC,CAAC;AArBW,QAAA,sBAAsB,0BAqBjC","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 type { Composition } from '../../composition/composition';\nimport type { PrimitiveNode } from '../../define/primitive_module';\nimport type { TextEnvelopeDispatcher } from '../text/envelope';\n\nimport { md, serializeMarkdown } from './builder';\n\n/** Adds GFM to {@link TextEnvelopeDispatcher}. */\nexport interface MarkdownEnvelopeDispatcher<\n  TNode extends PrimitiveNode,\n> extends TextEnvelopeDispatcher<TNode> {\n  /** Returns the empty string for a node with nothing to show; the envelope drops it rather than emitting a blank block. */\n  renderMarkdown(node: TNode): string;\n}\n\n/** Options for {@link renderMarkdownEnvelope}. */\nexport interface MarkdownEnvelopeOptions {\n  /** Renders the composition's title and subtitle. Defaults to `true`. Pass `false` when the host already shows the title, or the body opens with its own. */\n  heading?: boolean;\n}\n\n/**\n * The composition as GFM: title as `h1`, subtitle italicized, then every node\n * that rendered anything. The title and subtitle are text, escaped by\n * {@link serializeMarkdown}.\n */\nexport const renderMarkdownEnvelope = <TNode extends PrimitiveNode>(\n  composition: Composition<TNode>,\n  dispatcher: MarkdownEnvelopeDispatcher<TNode>,\n  { heading = true }: MarkdownEnvelopeOptions = {}\n): string => {\n  const blocks: string[] = [];\n  if (heading && composition.title) {\n    blocks.push(serializeMarkdown(md.heading(1, composition.title)));\n  }\n  if (heading && composition.subtitle) {\n    blocks.push(\n      serializeMarkdown(md.paragraph(md.emphasis(composition.subtitle)))\n    );\n  }\n  for (const node of composition.body) {\n    const rendered = dispatcher.renderMarkdown(node);\n    if (rendered.length > 0) {\n      blocks.push(rendered);\n    }\n  }\n  return blocks.join('\\n\\n');\n};\n"]}

package/dist/cjs/render/markdown/format.js

@@ -0,0 +1,208 @@
+"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.sanitizeMarkdownSource = exports.sanitizeAuthoredSource = exports.parseGfmBlocks = void 0;
+const mdast_util_from_markdown_1 = require("mdast-util-from-markdown");
+const mdast_util_gfm_1 = require("mdast-util-gfm");
+const micromark_extension_gfm_1 = require("micromark-extension-gfm");
+const url_1 = require("../../validate/url");
+// Escapes label characters that could close a `[...]` early and smuggle in a
+// hostile destination of their own.
+const escapeLinkLabel = (label) => label.replace(/[[\]\\]/g, '\\$&');
+// Percent-encodes destination characters that would terminate the `(...)`
+// early or read as a link title. `encodeURIComponent` leaves `(` and `)`
+// unescaped by spec, so those two are mapped by hand.
+const escapeLinkDestination = (href) => href.replace(/[()\s\\]/g, (char) => {
+    if (char === '(')
+        return '%28';
+    if (char === ')')
+        return '%29';
+    return encodeURIComponent(char);
+});
+const escapeParsedDestination = (href) => escapeLinkDestination(href.replace(/&/g, '&'));
+let parseOptions;
+const parse = (source) => (0, mdast_util_from_markdown_1.fromMarkdown)(source, (parseOptions ??= {
+    extensions: [(0, micromark_extension_gfm_1.gfm)()],
+    mdastExtensions: [(0, mdast_util_gfm_1.gfmFromMarkdown)()],
+}));
+/** `markdown` as flat GFM mdast blocks, typed `unknown` so no declaration names mdast; `null` past the parse budget or the parser's recursion depth. */
+const parseGfmBlocks = (markdown) => {
+    if (exceedsParseBudget(markdown))
+        return null;
+    try {
+        return parse(markdown).children;
+    }
+    catch (error) {
+        if (!(error instanceof RangeError))
+            throw error;
+        return null;
+    }
+};
+exports.parseGfmBlocks = parseGfmBlocks;
+// Each pass can expose a new sink (an escaped HTML block reveals the Markdown
+// inside it; a blocked link's label may close an outer `](`), so passes repeat
+// until the source is stable.
+const MAX_PASSES = 16;
+const escapeTitle = (title) => `"${title.replace(/["\\]/g, '\\$&')}"`;
+const offsets = (node) => {
+    const start = node.position?.start.offset;
+    const end = node.position?.end.offset;
+    return start === undefined || end === undefined ? undefined : [start, end];
+};
+const sanitizePass = (source) => {
+    const root = parse(source);
+    const definitions = new Map();
+    const pending = [...root.children].reverse();
+    while (pending.length) {
+        const node = pending.pop();
+        if (node.type === 'definition' && !definitions.has(node.identifier)) {
+            definitions.set(node.identifier, node);
+        }
+        if ('children' in node)
+            pending.push(...[...node.children].reverse());
+    }
+    const slice = (node) => {
+        const range = offsets(node);
+        return range ? source.slice(...range) : '';
+    };
+    const emitChildren = (start, end, children) => {
+        let out = '';
+        let cursor = start;
+        for (const child of children) {
+            const range = offsets(child);
+            if (!range)
+                continue;
+            out += source.slice(cursor, range[0]) + emit(child);
+            cursor = range[1];
+        }
+        return out + source.slice(cursor, end);
+    };
+    const emitLabel = (node) => {
+        const first = node.children[0];
+        const last = node.children[node.children.length - 1];
+        const from = first && offsets(first);
+        const to = last && offsets(last);
+        return from && to ? emitChildren(from[0], to[1], node.children) : '';
+    };
+    const rewrite = (node) => {
+        switch (node.type) {
+            case 'html':
+                return slice(node).replace(/</g, '&lt;');
+            case 'definition': {
+                const safe = (0, url_1.sanitizeParsedNavigationHref)(node.url) ??
+                    (0, url_1.sanitizeParsedAssetUrl)(node.url);
+                if (safe === node.url)
+                    return undefined;
+                const title = node.title ? ` ${escapeTitle(node.title)}` : '';
+                return `[${node.label ?? node.identifier}]: ${safe === null ? url_1.BLOCKED_HREF : escapeParsedDestination(safe)}${title}`;
+            }
+            case 'imageReference': {
+                const definition = definitions.get(node.identifier);
+                return definition && (0, url_1.sanitizeParsedAssetUrl)(definition.url) === null
+                    ? escapeLinkLabel(node.alt ?? '')
+                    : undefined;
+            }
+            case 'linkReference': {
+                const definition = definitions.get(node.identifier);
+                return definition &&
+                    (0, url_1.sanitizeParsedNavigationHref)(definition.url) === null &&
+                    (0, url_1.sanitizeParsedAssetUrl)(definition.url) !== null
+                    ? emitLabel(node)
+                    : undefined;
+            }
+            case 'image': {
+                const safe = (0, url_1.sanitizeParsedAssetUrl)(node.url);
+                if (safe === null)
+                    return escapeLinkLabel(node.alt ?? '');
+                if (safe === node.url)
+                    return undefined;
+                const title = node.title ? ` ${escapeTitle(node.title)}` : '';
+                return `![${escapeLinkLabel(node.alt ?? '')}](${escapeParsedDestination(safe)}${title})`;
+            }
+            case 'link': {
+                const raw = slice(node);
+                const safe = (0, url_1.sanitizeParsedNavigationHref)(node.url);
+                if (raw.startsWith('<')) {
+                    return safe === null ? raw.slice(1, -1) : undefined;
+                }
+                // A GFM literal (`www.x.com`) is http(s) or mailto by construction.
+                if (!raw.startsWith('['))
+                    return undefined;
+                if (safe === null)
+                    return emitLabel(node);
+                if (safe === node.url)
+                    return undefined;
+                const title = node.title ? ` ${escapeTitle(node.title)}` : '';
+                return `[${emitLabel(node)}](${escapeParsedDestination(safe)}${title})`;
+            }
+            default:
+                return undefined;
+        }
+    };
+    const emit = (node) => {
+        const replaced = rewrite(node);
+        if (replaced !== undefined)
+            return replaced;
+        const range = offsets(node);
+        if (!range)
+            return '';
+        return 'children' in node
+            ? emitChildren(range[0], range[1], node.children)
+            : source.slice(...range);
+    };
+    return emitChildren(0, source.length, root.children);
+};
+/** {@link sanitizeMarkdownSource}'s result, and whether it degraded to inert text. */
+const sanitizeAuthoredSource = (markdown) => {
+    if (exceedsParseBudget(markdown)) {
+        return { markdown: inert(markdown), inert: true };
+    }
+    let current = markdown;
+    try {
+        for (let pass = 0; pass < MAX_PASSES; pass++) {
+            const next = sanitizePass(current);
+            if (next === current)
+                return { markdown: current, inert: false };
+            current = next;
+        }
+    }
+    catch (error) {
+        // The parser recurses per nesting level, so inline nesting deep enough
+        // to exhaust the stack lands here.
+        if (!(error instanceof RangeError))
+            throw error;
+    }
+    return { markdown: inert(current), inert: true };
+};
+exports.sanitizeAuthoredSource = sanitizeAuthoredSource;
+/** Sanitizes GFM destinations and HTML; excessive syntax or length degrades to inert text. */
+const sanitizeMarkdownSource = (markdown) => (0, exports.sanitizeAuthoredSource)(markdown).markdown;
+exports.sanitizeMarkdownSource = sanitizeMarkdownSource;
+// No link, image, definition, or tag can survive without `[` or `<`.
+const inert = (markdown) => markdown.replace(/[[\]\\]/g, '\\$&').replace(/</g, '&lt;');
+// GFM parsing is superlinear for some delimiter runs, even without nesting.
+const LINE_PREFIX_RE = /^(?:[ \t>]|[-*+](?=[ \t])|\d{1,9}[.)](?=[ \t]))+/gm;
+const MAX_LINE_PREFIX = 256;
+const INLINE_DELIMITER_RE = /[[\]*`~<>|\\]|(?<![\p{L}\p{N}])_|_(?![\p{L}\p{N}])/gu;
+const MAX_INLINE_DELIMITERS = 2048;
+const MAX_PARSE_LENGTH = 16_384;
+const exceedsParseBudget = (markdown) => {
+    if (markdown.length > MAX_PARSE_LENGTH)
+        return true;
+    for (const [prefix] of markdown.matchAll(LINE_PREFIX_RE)) {
+        if (prefix.length > MAX_LINE_PREFIX)
+            return true;
+    }
+    let delimiters = 0;
+    for (const _ of markdown.matchAll(INLINE_DELIMITER_RE)) {
+        if (++delimiters > MAX_INLINE_DELIMITERS)
+            return true;
+    }
+    return false;
+};
+//# sourceMappingURL=format.js.map