@elastic/isomer-sdk 0.0.0 → 0.1.0

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

@@ -0,0 +1,32 @@
+"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.applyEnhancements = void 0;
+const enhancements_1 = require("../../pack/enhancements");
+const anchors_1 = require("../anchors");
+const context_view_1 = require("../context_view");
+/**
+ * The `definitions` that apply to `body`, the first of each id and limited to
+ * `requested` ids when given, and `context` for a React render of it: carrying
+ * their ids as `context.enhancements`, with `context.anchors` on when one
+ * declares `anchors: true`. `context` is viewed, not copied, as the HTML
+ * surface does.
+ */
+const applyEnhancements = (context, body, walk, definitions, requested) => {
+    const applied = (0, enhancements_1.resolveEnhancements)(body, walk, definitions, requested);
+    const ids = new Set(applied.map(({ id }) => id));
+    const enhanced = (0, context_view_1.contextWith)(context, 'enhancements', ids);
+    return {
+        context: applied.some(({ anchors }) => anchors)
+            ? (0, anchors_1.withNodeAnchors)(enhanced)
+            : enhanced,
+        applied,
+    };
+};
+exports.applyEnhancements = applyEnhancements;
+//# sourceMappingURL=enhancements.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enhancements.js","sourceRoot":"","sources":["../../../../src/render/react/enhancements.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAIH,0DAGiC;AACjC,wCAA6C;AAC7C,kDAA8C;AAE9C;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAC/B,OAAiB,EACjB,IAA8B,EAC9B,IAAqB,EACrB,WAA6C,EAC7C,SAA6B,EAC4B,EAAE;IAC3D,MAAM,OAAO,GAAG,IAAA,kCAAmB,EAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACxE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,OAAO,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;IAC3D,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC;YAC7C,CAAC,CAAC,IAAA,yBAAe,EAAC,QAAQ,CAAC;YAC3B,CAAC,CAAC,QAAQ;QACZ,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,iBAAiB,qBAgB5B","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';\nimport type { PrimitiveNode } from '../../composition/node';\nimport {\n  type EnhancementDefinition,\n  resolveEnhancements,\n} from '../../pack/enhancements';\nimport { withNodeAnchors } from '../anchors';\nimport { contextWith } from '../context_view';\n\n/**\n * The `definitions` that apply to `body`, the first of each id and limited to\n * `requested` ids when given, and `context` for a React render of it: carrying\n * their ids as `context.enhancements`, with `context.anchors` on when one\n * declares `anchors: true`. `context` is viewed, not copied, as the HTML\n * surface does.\n */\nexport const applyEnhancements = <TContext>(\n  context: TContext,\n  body: readonly PrimitiveNode[],\n  walk: ChildNodeWalker,\n  definitions: readonly EnhancementDefinition[],\n  requested?: readonly string[]\n): { context: TContext; applied: EnhancementDefinition[] } => {\n  const applied = resolveEnhancements(body, walk, definitions, requested);\n  const ids = new Set(applied.map(({ id }) => id));\n  const enhanced = contextWith(context, 'enhancements', ids);\n  return {\n    context: applied.some(({ anchors }) => anchors)\n      ? withNodeAnchors(enhanced)\n      : enhanced,\n    applied,\n  };\n};\n"]}

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

@@ -0,0 +1,15 @@
+"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.applyEnhancements = exports.wrapCompositionContent = exports.renderCompositionContent = void 0;
+var content_1 = require("./content");
+Object.defineProperty(exports, "renderCompositionContent", { enumerable: true, get: function () { return content_1.renderCompositionContent; } });
+Object.defineProperty(exports, "wrapCompositionContent", { enumerable: true, get: function () { return content_1.wrapCompositionContent; } });
+var enhancements_1 = require("./enhancements");
+Object.defineProperty(exports, "applyEnhancements", { enumerable: true, get: function () { return enhancements_1.applyEnhancements; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/render/react/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,qCAMmB;AAFjB,mHAAA,wBAAwB,OAAA;AACxB,iHAAA,sBAAsB,OAAA;AAExB,+CAAmD;AAA1C,iHAAA,iBAAiB,OAAA","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 {\n  type CompositionWrapperOptions,\n  type ReactContentDispatcher,\n  type ReactContentOptions,\n  renderCompositionContent,\n  wrapCompositionContent,\n} from './content';\nexport { applyEnhancements } from './enhancements';\n"]}

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

@@ -0,0 +1,45 @@
+"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.createSlackAssetCollector = exports.isSlackReachableImageUrl = void 0;
+const blocks_1 = require("./blocks");
+const format_1 = require("./format");
+/**
+ * Whether Slack's servers can fetch `src` themselves: an `https:` URL with a
+ * host, so a data URL or a host-relative path has to go through an upload.
+ */
+const isSlackReachableImageUrl = (src) => /^https:/i.test(src) && (0, format_1.isAbsoluteHttpUrl)(src);
+exports.isSlackReachableImageUrl = isSlackReachableImageUrl;
+/**
+ * A fresh {@link SlackAssetCollector} handing out `{prefix}-0`, `{prefix}-1`,
+ * … in allocation order. `prefix` defaults to `asset`.
+ */
+const createSlackAssetCollector = (options = {}) => {
+    const prefix = options.prefix ?? 'asset';
+    const requests = [];
+    let counter = 0;
+    return {
+        allocate: (node, altText) => {
+            const ref = `${prefix}-${counter}`;
+            counter += 1;
+            // Clamped at allocation so a host reading `requests` for an upload title
+            // sees the same string as the block it accompanies.
+            requests.push({
+                ref,
+                node,
+                altText: (0, format_1.clampSlackText)(altText, blocks_1.SLACK_LIMITS.imageAltTextChars),
+            });
+            return ref;
+        },
+        get requests() {
+            return requests;
+        },
+    };
+};
+exports.createSlackAssetCollector = createSlackAssetCollector;
+//# sourceMappingURL=assets.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../../../src/render/slack/assets.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAQH,qCAAwC;AACxC,qCAA6D;AAI7D;;;GAGG;AACI,MAAM,wBAAwB,GAAG,CAAC,GAAW,EAAW,EAAE,CAC/D,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAA,0BAAiB,EAAC,GAAG,CAAC,CAAC;AADpC,QAAA,wBAAwB,4BACY;AAEjD;;;GAGG;AACI,MAAM,yBAAyB,GAAG,CAGvC,UAA+B,EAAE,EACL,EAAE;IAC9B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;IACzC,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,OAAO;QACL,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC1B,MAAM,GAAG,GAAG,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,CAAC;YACb,yEAAyE;YACzE,oDAAoD;YACpD,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG;gBACH,IAAI;gBACJ,OAAO,EAAE,IAAA,uBAAc,EAAC,OAAO,EAAE,qBAAY,CAAC,iBAAiB,CAAC;aACjE,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,QAAQ;YACV,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAzBW,QAAA,yBAAyB,6BAyBpC","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 { PrimitiveNode } from '../../composition/node';\nimport type {\n  SlackAssetCollector,\n  SlackAssetRequest,\n} from '../../define/slack_assets';\n\nimport { SLACK_LIMITS } from './blocks';\nimport { clampSlackText, isAbsoluteHttpUrl } from './format';\n\nexport type { SlackAssetCollector, SlackAssetRequest };\n\n/**\n * Whether Slack's servers can fetch `src` themselves: an `https:` URL with a\n * host, so a data URL or a host-relative path has to go through an upload.\n */\nexport const isSlackReachableImageUrl = (src: string): boolean =>\n  /^https:/i.test(src) && isAbsoluteHttpUrl(src);\n\n/**\n * A fresh {@link SlackAssetCollector} handing out `{prefix}-0`, `{prefix}-1`,\n * … in allocation order. `prefix` defaults to `asset`.\n */\nexport const createSlackAssetCollector = <\n  TNode extends PrimitiveNode = PrimitiveNode,\n>(\n  options: { prefix?: string } = {}\n): SlackAssetCollector<TNode> => {\n  const prefix = options.prefix ?? 'asset';\n  const requests: SlackAssetRequest<TNode>[] = [];\n  let counter = 0;\n  return {\n    allocate: (node, altText) => {\n      const ref = `${prefix}-${counter}`;\n      counter += 1;\n      // Clamped at allocation so a host reading `requests` for an upload title\n      // sees the same string as the block it accompanies.\n      requests.push({\n        ref,\n        node,\n        altText: clampSlackText(altText, SLACK_LIMITS.imageAltTextChars),\n      });\n      return ref;\n    },\n    get requests() {\n      return requests;\n    },\n  };\n};\n"]}

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

@@ -0,0 +1,80 @@
+"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.SLACK_LIMITS = void 0;
+/**
+ * Slack's published surface limits, enforced by the renderer so a composition
+ * cannot silently trip Slack's validation.
+ */
+exports.SLACK_LIMITS = {
+    blocksPerMessage: 50,
+    /** `section.text`. */
+    sectionTextChars: 3000,
+    /** One entry of `section.fields`. */
+    sectionFieldChars: 2000,
+    /** One entry of `context.elements`. */
+    contextElementChars: 2000,
+    /** `header.text`, which is `plain_text`. */
+    headerTextChars: 150,
+    fieldsPerSection: 10,
+    /** Elements per `context` block. */
+    contextElements: 10,
+    buttonsPerActions: 25,
+    /** Slack truncates the top-level `text` fallback in notifications around here. */
+    fallbackTextChars: 4000,
+    /** `plain_text` option labels (selects, radio, checkboxes, overflow). */
+    optionTextChars: 75,
+    /** Options per select, or per option group of one. */
+    optionsPerSelect: 100,
+    /** Options per overflow menu (Slack caps overflow at 5). */
+    optionsPerOverflow: 5,
+    /** Options per radio button group or checkboxes element. */
+    optionsPerChoice: 10,
+    /** Option groups per select, each holding up to `optionsPerSelect` options. */
+    optionGroupsPerSelect: 100,
+    /** An option's `value`, which interactions send back. */
+    optionValueChars: 150,
+    /** A button's `value`. */
+    buttonValueChars: 2000,
+    /** A button's or overflow option's `url`. */
+    urlChars: 3000,
+    /** An interactive element's `action_id`. */
+    actionIdChars: 255,
+    /** Max indent level for `rich_text_list`. */
+    richTextListMaxIndent: 8,
+    /**
+     * Characters across every table cell in one message. Slack publishes the
+     * same 10,000 figure per table and per message, so the message-wide
+     * aggregate is the binding one.
+     * https://docs.slack.dev/reference/block-kit/blocks/table-block/
+     */
+    tableCellCharsPerMessage: 10_000,
+    /** Rows per `table` block (includes the header row). */
+    tableRows: 100,
+    /** Cells per `table` row / columns per table. */
+    tableColumns: 20,
+    /** `image`/image-element `image_url` max length. */
+    imageUrlChars: 3000,
+    /** `image`/image-element `alt_text` max length. */
+    imageAltTextChars: 2000,
+    /** `image` block `title`. */
+    imageTitleChars: 2000,
+    /** `video` block `title`; Slack requires fewer than 200. */
+    videoTitleChars: 199,
+    /** `video` block `description`; Slack requires fewer than 200. */
+    videoDescriptionChars: 199,
+    /** `video` block `author_name`; Slack requires fewer than 50. */
+    videoAuthorNameChars: 49,
+    /** `button` element `text`. */
+    buttonTextChars: 75,
+    /** Select `placeholder`. */
+    placeholderChars: 150,
+    /** `option_groups[].label`. */
+    optionGroupLabelChars: 75,
+};
+//# sourceMappingURL=blocks.js.map

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

@@ -0,0 +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"]}