@elastic/isomer-sdk 0.1.0 → 0.2.0

package/dist/cjs/validate/validation.js

@@ -70,12 +70,7 @@ const createCompositionValidator = (definitions, options = {}) => {
         if (result.success) {
             const { body } = plain;
             const idErrors = collectDuplicateNodeIdErrors(body, walk);
-            const warnings = [
-                ...collectEmptySurfaceWarnings(body, walk),
-                ...(options.sizesFromNodeHeights
-                    ? collectMissingSvgHeightWarnings(body, definitions, walk)
-                    : []),
-            ];
+            const warnings = collectEmptySurfaceWarnings(body, walk);
             return {
                 valid: idErrors.length === 0,
                 errors: idErrors,
@@ -127,48 +122,10 @@ const createCompositionParser = (definitions, { inputBudget } = {}) => {
 };
 exports.createCompositionParser = createCompositionParser;
 /** Warns once per surface that the whole body renders nothing on. */
-const collectEmptySurfaceWarnings = (body, walk) => body_node_base_1.BODY_NODE_SURFACES.filter((surface) => !body.some((node) => (0, body_node_base_1.rendersOnSurface)(node, surface, walk))).map((surface) => ({
+const collectEmptySurfaceWarnings = (body, walk) => body_node_base_1.SURFACE_NAMES.filter((surface) => !body.some((node) => (0, body_node_base_1.rendersOnSurface)(node, surface, walk))).map((surface) => ({
     surface,
     message: `composition renders no nodes on surface "${surface}"`,
 }));
-/**
- * Warns for each node that renders to `svg` but declares no `svgHeight`.
- *
- * `metrics.svgHeight` is optional, so `dispatcher.estimateSvgHeight` returns
- * `0` for such a node and a frame that sums node heights sizes short.
- *
- * Whether a runtime consults the metric at all is the caller's to decide; see
- * {@link CompositionValidatorOptions.sizesFromNodeHeights}. A fixed-size frame
- * never does, and warning about a value nothing reads is how a warning channel
- * gets ignored.
- */
-const collectMissingSvgHeightWarnings = (body, definitions, walk) => {
-    const unmeasured = new Set(definitions
-        .filter((definition) => !definition.metrics?.svgHeight)
-        .map((definition) => definition.type));
-    if (unmeasured.size === 0) {
-        return [];
-    }
-    const warnings = [];
-    const visit = (node, path) => {
-        if (!node || typeof node !== 'object' || !(0, body_node_base_1.isVisibleOnSurface)(node, 'svg')) {
-            return;
-        }
-        const { type } = node;
-        if (typeof type === 'string' && unmeasured.has(type)) {
-            warnings.push({
-                surface: 'svg',
-                path,
-                message: `${path} type ${(0, one_line_1.quoteText)(type)} declares no svgHeight metric and will be measured as 0, sizing the frame short`,
-            });
-        }
-        walk(node).forEach(({ node: child, path: field }) => {
-            visit(child, (0, body_node_base_1.childNodePath)(path, field));
-        });
-    };
-    body.forEach((node, index) => visit(node, `body[${index}]`));
-    return warnings;
-};
 /**
  * Errors for each node whose `id` repeats one already seen, naming the first
  * use.

package/dist/cjs/validate/validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../src/validate/validation.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,kEAOuC;AAGvC,sDAAoD;AACpD,sEAGyC;AAuEhC,2GAzEP,6CAA0B,OAyEO;AApEnC,6DAA0E;AAC1E,iDAIwB;AACxB,+CAAyE;AAsCzE,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAc5E,8EAA8E;AACvE,MAAM,kBAAkB,GAAG,CAChC,MAAwB,EACxB,OAAoB,EACC,EAAE,CACvB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;AAJtD,QAAA,kBAAkB,sBAIoC;AAOnE,0LAA0L;AACnL,MAAM,qBAAqB,GAAG,CACnC,MAAwB,EACxB,IAA0B,EACpB,EAAE;IACR,IACE,CAAC,MAAM,CAAC,KAAK;QACb,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,6BAAc,CAAC,CAAC,EACxD,CAAC;QACD,MAAM,IAAI,6CAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,qBAAqB,yBAUhC;AAEF,kOAAkO;AAC3N,MAAM,mBAAmB,GAAG,CACjC,MAAsC,EACtC,IAA0B,EACC,EAAE;IAC7B,IAAA,6BAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAC/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,6CAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAVW,QAAA,mBAAmB,uBAU9B;AAkBF,0EAA0E;AAC1E,MAAM,SAAS,GAAG,CAAC,KAAc,EAAe,EAAE;IAChD,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAuB,CAAC;IACrD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACxB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAU,CAAC;QAC9D,CAAC,CAAC,EAAE,CAAC;AACT,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,0BAA0B,GAAG,CAGxC,WAA8C,EAC9C,UAAuC,EAAE,EAC8B,EAAE;IACzE,MAAM,MAAM,GAAG,IAAA,uDAAkC,EAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAA,sCAAqB,EAAC,WAAW,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,IAAA,sCAAwB,EAAC,WAAW,CAAC,CAAC;IAC3D,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;gBACvB,QAAQ,EAAE,EAAE;gBACZ,WAAW,EAAE,SAAS;aACvB,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAkC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;YACvB,MAAM,QAAQ,GAAG,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG;gBACf,GAAG,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC;gBAC1C,GAAG,CAAC,OAAO,CAAC,oBAAoB;oBAC9B,CAAC,CAAC,+BAA+B,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC;oBAC1D,CAAC,CAAC,EAAE,CAAC;aACR,CAAC;YACF,OAAO;gBACL,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAC5B,MAAM,EAAE,QAAQ;gBAChB,QAAQ;gBACR,WAAW,EAAE,KAAK;aACnB,CAAC;QACJ,CAAC;QACD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAC3D,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,KAAK;SACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AA5CW,QAAA,0BAA0B,8BA4CrC;AAYF;;;;;;;;;;GAUG;AACI,MAAM,uBAAuB,GAAG,CACrC,WAA8C,EAC9C,EAAE,WAAW,KAAuD,EAAE,EAC7B,EAAE;IAC3C,MAAM,MAAM,GAAG,IAAA,uDAAkC,EAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAA,sCAAwB,EAAC,WAAW,CAAC,CAAC;IAC3D,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO;gBACL,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,IAA8B;aACnD,CAAC;QACJ,CAAC;QACD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;SACpE,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAxBW,QAAA,uBAAuB,2BAwBlC;AAEF,qEAAqE;AACrE,MAAM,2BAA2B,GAAG,CAClC,IAAwB,EACxB,IAA8C,EACzB,EAAE,CACvB,mCAAkB,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,iCAAgB,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CACzE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAClB,OAAO;IACP,OAAO,EAAE,4CAA4C,OAAO,GAAG;CAChE,CAAC,CAAC,CAAC;AAEN;;;;;;;;;;GAUG;AACH,MAAM,+BAA+B,GAAG,CACtC,IAAwB,EACxB,WAA8C,EAC9C,IAA8C,EACzB,EAAE;IACvB,MAAM,UAAU,GAAG,IAAI,GAAG,CACxB,WAAW;SACR,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC;SACtD,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CACxC,CAAC;IACF,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,QAAQ,GAAwB,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAQ,EAAE;QAClD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAA,mCAAkB,EAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YAC1E,OAAO;QACT,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAA0B,CAAC;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrD,QAAQ,CAAC,IAAI,CAAC;gBACZ,OAAO,EAAE,KAAK;gBACd,IAAI;gBACJ,OAAO,EAAE,GAAG,IAAI,SAAS,IAAA,oBAAS,EAAC,IAAI,CAAC,iFAAiF;aAC1H,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAClD,KAAK,CAAC,KAAK,EAAE,IAAA,8BAAa,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,4BAA4B,GAAG,CACnC,IAAwB,EACxB,IAA8C,EAC3B,EAAE;IACrB,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAQ,EAAE;QAClD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QACD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,IAAwC,CAAC;QAC9D,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3B,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,KAAK;oBAClB,OAAO,EAAE,iBAAiB,IAAA,oBAAS,EAAC,EAAE,CAAC,kBAAkB,KAAK,EAAE;oBAChE,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACxD,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAClD,KAAK,CAAC,KAAK,EAAE,IAAA,8BAAa,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,MAAM,CAAC;AAChB,CAAC,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\nimport {\n  BODY_NODE_SURFACES,\n  childNodePath,\n  createChildNodeWalker,\n  isVisibleOnSurface,\n  rendersOnSurface,\n  type SurfaceName,\n} from '../composition/body_node_base';\nimport type { Composition } from '../composition/composition';\nimport type { PrimitiveNode } from '../composition/node';\nimport { quoteText } from '../composition/one_line';\nimport {\n  CompositionValidationError,\n  type ValidationError,\n} from '../composition/validation_error';\nimport type { AnyPrimitiveDefinition } from '../define/primitive_module';\n\nimport { getCompositionSchemaForDefinitions } from './composition_schema';\nimport {\n  checkInputBudget,\n  type InputBudget,\n  isInputRefusal,\n} from './input_budget';\nimport { createNodeIssueFormatter, type IssueRoot } from './node_issues';\n\n/**\n * A non-fatal validation finding, scoped to the surface it concerns.\n *\n * Warnings carry `surface` because every one of them is a statement about one\n * render target — a composition that draws nothing on `slack` is not news to a\n * caller rendering HTML. Without the scope a host receives every surface's\n * findings on every call and learns to ignore the channel.\n * {@link warningsForSurface} is the filter.\n */\nexport interface ValidationWarning {\n  /** The render target this finding concerns, never the composition as a whole. */\n  surface: SurfaceName;\n  /**\n   * Path of the offending node within the composition, absent for\n   * whole-composition findings.\n   */\n  path?: string;\n  /** Safe to show a user, and phrased for whoever can act on it. */\n  message: string;\n}\n\n/**\n * The outcome of `validate`: errors are fatal, warnings are advisory.\n *\n * `valid` tracks `errors` only — a composition can be valid and still carry\n * warnings, which is the normal case for a surface gap.\n */\nexport interface ValidationResult {\n  /** True when `errors` is empty, regardless of `warnings`. */\n  valid: boolean;\n  /** Fatal findings. Empty when `valid`. */\n  errors: ValidationError[];\n  /** Advisory findings, empty when there are none. */\n  warnings: ValidationWarning[];\n}\n\nconst checkedComposition = Symbol.for('elastic.isomer.checked_composition');\n\n/** The copy {@link createCompositionValidator} checked, which a validating render draws in place of the caller's value. The brand is type-only. */\nexport type CheckedComposition<TNode extends PrimitiveNode = PrimitiveNode> =\n  Composition<TNode> & { readonly [checkedComposition]: true };\n\n/** A {@link ValidationResult} with the composition it describes. */\nexport interface CheckedValidationResult<\n  TNode extends PrimitiveNode = PrimitiveNode,\n> extends ValidationResult {\n  /** Undefined only when {@link checkInputBudget} refused the input. */\n  composition: CheckedComposition<TNode> | undefined;\n}\n\n/** Narrows a result's warnings to the surface a caller is about to render. */\nexport const warningsForSurface = (\n  result: ValidationResult,\n  surface: SurfaceName\n): ValidationWarning[] =>\n  result.warnings.filter((warning) => warning.surface === surface);\n\n/** Whether a render reports validation findings or raises on them. */\nexport type ValidationErrorMode = 'collect' | 'throw';\n\nexport { CompositionValidationError };\n\n/** Raises {@link CompositionValidationError} when `mode` is `throw` and `result` is invalid, or in any mode when {@link checkInputBudget} refused the input, which nothing can render. */\nexport const enforceValidationMode = (\n  result: ValidationResult,\n  mode?: ValidationErrorMode\n): void => {\n  if (\n    !result.valid &&\n    (mode === 'throw' || result.errors.some(isInputRefusal))\n  ) {\n    throw new CompositionValidationError(result.errors);\n  }\n};\n\n/** The composition `result` checked, which is what a render draws. Throws {@link CompositionValidationError} when `mode` is `'throw'` and `result` is invalid, or in any mode when {@link checkInputBudget} refused the input. */\nexport const compositionToRender = <TNode extends PrimitiveNode>(\n  result: CheckedValidationResult<TNode>,\n  mode?: ValidationErrorMode\n): CheckedComposition<TNode> => {\n  enforceValidationMode(result, mode);\n  const { composition } = result;\n  if (composition === undefined) {\n    throw new CompositionValidationError(result.errors);\n  }\n  return composition;\n};\n\n/** Runtime facts the semantic passes need beyond the primitive inventory. */\nexport interface CompositionValidatorOptions {\n  /**\n   * Whether any frame the runtime can draw with sizes itself from node heights,\n   * which is what makes a missing `metrics.svgHeight` matter.\n   *\n   * A runtime-wide question rather than a per-node one, because a frame is a\n   * runtime input: any node can be drawn under any frame, so the metric is\n   * load-bearing as soon as one frame consults it. Defaults to `false`, so a\n   * runtime with no frame at all reports nothing about a value nothing reads.\n   */\n  sizesFromNodeHeights?: boolean;\n  /** Limits checked before the schema runs; see {@link checkInputBudget}. */\n  inputBudget?: InputBudget;\n}\n\n/** The body's nodes, as {@link IssueRoot}s for a node issue formatter. */\nconst bodyRoots = (value: unknown): IssueRoot[] => {\n  const { body } = (value ?? {}) as { body?: unknown };\n  return Array.isArray(body)\n    ? body.map((node, index) => [node, `body[${index}]`] as const)\n    : [];\n};\n\n/**\n * Builds the trusted-input validator: {@link checkInputBudget}, then the schema and the semantic passes on its copy, which the result carries.\n *\n * `definitions` is memoized on array identity, so a caller that rebuilds the\n * array per call (`createCompositionValidator(packs.flatMap(…))`) resolves a\n * fresh discriminated union each time. Hold the array `composePacks` returns\n * and reuse it across the validator, the parser, and the authoring context.\n */\nexport const createCompositionValidator = <\n  TNode extends PrimitiveNode = PrimitiveNode,\n>(\n  definitions: readonly AnyPrimitiveDefinition[],\n  options: CompositionValidatorOptions = {}\n): ((composition: Composition<TNode>) => CheckedValidationResult<TNode>) => {\n  const schema = getCompositionSchemaForDefinitions(definitions);\n  const walk = createChildNodeWalker(definitions);\n  const formatIssues = createNodeIssueFormatter(definitions);\n  return (composition) => {\n    const checked = checkInputBudget(composition, options.inputBudget);\n    if (!checked.valid) {\n      return {\n        valid: false,\n        errors: [checked.error],\n        warnings: [],\n        composition: undefined,\n      };\n    }\n    const plain = checked.value as CheckedComposition<TNode>;\n    const result = schema.safeParse(plain, { reportInput: true });\n    if (result.success) {\n      const { body } = plain;\n      const idErrors = collectDuplicateNodeIdErrors(body, walk);\n      const warnings = [\n        ...collectEmptySurfaceWarnings(body, walk),\n        ...(options.sizesFromNodeHeights\n          ? collectMissingSvgHeightWarnings(body, definitions, walk)\n          : []),\n      ];\n      return {\n        valid: idErrors.length === 0,\n        errors: idErrors,\n        warnings,\n        composition: plain,\n      };\n    }\n    return {\n      valid: false,\n      errors: formatIssues(bodyRoots(plain), result.error.issues),\n      warnings: [],\n      composition: plain,\n    };\n  };\n};\n\n/** The outcome of `parse`. */\nexport interface ParsedComposition {\n  /** True when the value matched the schema. Says nothing about id uniqueness. */\n  valid: boolean;\n  /** Schema failures. Empty when `valid`. */\n  errors: ValidationError[];\n  /** The parsed document, present only when `valid`. */\n  composition?: Composition;\n}\n\n/**\n * Builds the untrusted-input parser: {@link checkInputBudget}, then the schema only on its copy, reported rather than thrown.\n *\n * Deliberately narrower than {@link createCompositionValidator}. This answers\n * \"is this a `Composition`\", not \"is this a good one\" — it does not run the\n * duplicate-id pass or produce warnings, so a composition with two nodes\n * sharing an `id` parses as valid. Id uniqueness is a `validate` guarantee, so\n * a caller that wants the semantic checks runs `validate` on the result.\n *\n * Shares {@link createCompositionValidator}'s memoization identity requirement.\n */\nexport const createCompositionParser = (\n  definitions: readonly AnyPrimitiveDefinition[],\n  { inputBudget }: Pick<CompositionValidatorOptions, 'inputBudget'> = {}\n): ((value: unknown) => ParsedComposition) => {\n  const schema = getCompositionSchemaForDefinitions(definitions);\n  const formatIssues = createNodeIssueFormatter(definitions);\n  return (value) => {\n    const checked = checkInputBudget(value, inputBudget);\n    if (!checked.valid) {\n      return { valid: false, errors: [checked.error] };\n    }\n    const result = schema.safeParse(checked.value, { reportInput: true });\n    if (result.success) {\n      return {\n        valid: true,\n        errors: [],\n        composition: result.data as unknown as Composition,\n      };\n    }\n    return {\n      valid: false,\n      errors: formatIssues(bodyRoots(checked.value), result.error.issues),\n    };\n  };\n};\n\n/** Warns once per surface that the whole body renders nothing on. */\nconst collectEmptySurfaceWarnings = (\n  body: readonly unknown[],\n  walk: ReturnType<typeof createChildNodeWalker>\n): ValidationWarning[] =>\n  BODY_NODE_SURFACES.filter(\n    (surface) => !body.some((node) => rendersOnSurface(node, surface, walk))\n  ).map((surface) => ({\n    surface,\n    message: `composition renders no nodes on surface \"${surface}\"`,\n  }));\n\n/**\n * Warns for each node that renders to `svg` but declares no `svgHeight`.\n *\n * `metrics.svgHeight` is optional, so `dispatcher.estimateSvgHeight` returns\n * `0` for such a node and a frame that sums node heights sizes short.\n *\n * Whether a runtime consults the metric at all is the caller's to decide; see\n * {@link CompositionValidatorOptions.sizesFromNodeHeights}. A fixed-size frame\n * never does, and warning about a value nothing reads is how a warning channel\n * gets ignored.\n */\nconst collectMissingSvgHeightWarnings = (\n  body: readonly unknown[],\n  definitions: readonly AnyPrimitiveDefinition[],\n  walk: ReturnType<typeof createChildNodeWalker>\n): ValidationWarning[] => {\n  const unmeasured = new Set(\n    definitions\n      .filter((definition) => !definition.metrics?.svgHeight)\n      .map((definition) => definition.type)\n  );\n  if (unmeasured.size === 0) {\n    return [];\n  }\n  const warnings: ValidationWarning[] = [];\n  const visit = (node: unknown, path: string): void => {\n    if (!node || typeof node !== 'object' || !isVisibleOnSurface(node, 'svg')) {\n      return;\n    }\n    const { type } = node as { type?: unknown };\n    if (typeof type === 'string' && unmeasured.has(type)) {\n      warnings.push({\n        surface: 'svg',\n        path,\n        message: `${path} type ${quoteText(type)} declares no svgHeight metric and will be measured as 0, sizing the frame short`,\n      });\n    }\n    walk(node).forEach(({ node: child, path: field }) => {\n      visit(child, childNodePath(path, field));\n    });\n  };\n  body.forEach((node, index) => visit(node, `body[${index}]`));\n  return warnings;\n};\n\n/**\n * Errors for each node whose `id` repeats one already seen, naming the first\n * use.\n *\n * Errors rather than warnings, because ids are what a host addresses a node by.\n * Run by `validate` and deliberately not by `parse`; see\n * {@link createCompositionParser}.\n */\nconst collectDuplicateNodeIdErrors = (\n  body: readonly unknown[],\n  walk: ReturnType<typeof createChildNodeWalker>\n): ValidationError[] => {\n  const errors: ValidationError[] = [];\n  const seen = new Map<string, string>();\n  const visit = (node: unknown, path: string): void => {\n    if (!node || typeof node !== 'object') {\n      return;\n    }\n    const { id, type } = node as { id?: unknown; type?: unknown };\n    if (typeof id === 'string') {\n      const first = seen.get(id);\n      if (first) {\n        errors.push({\n          path: `${path}.id`,\n          message: `duplicates id ${quoteText(id)} first used at ${first}`,\n          ...(typeof type === 'string' ? { nodeType: type } : {}),\n        });\n      } else {\n        seen.set(id, path);\n      }\n    }\n    walk(node).forEach(({ node: child, path: field }) => {\n      visit(child, childNodePath(path, field));\n    });\n  };\n  body.forEach((node, index) => visit(node, `body[${index}]`));\n  return errors;\n};\n"]}
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../src/validate/validation.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,kEAMuC;AAGvC,sDAAoD;AACpD,sEAGyC;AAuEhC,2GAzEP,6CAA0B,OAyEO;AApEnC,6DAA0E;AAC1E,iDAIwB;AACxB,+CAAyE;AAsCzE,MAAM,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAc5E,8EAA8E;AACvE,MAAM,kBAAkB,GAAG,CAChC,MAAwB,EACxB,OAAoB,EACC,EAAE,CACvB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;AAJtD,QAAA,kBAAkB,sBAIoC;AAOnE,0LAA0L;AACnL,MAAM,qBAAqB,GAAG,CACnC,MAAwB,EACxB,IAA0B,EACpB,EAAE;IACR,IACE,CAAC,MAAM,CAAC,KAAK;QACb,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,6BAAc,CAAC,CAAC,EACxD,CAAC;QACD,MAAM,IAAI,6CAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,qBAAqB,yBAUhC;AAEF,kOAAkO;AAC3N,MAAM,mBAAmB,GAAG,CACjC,MAAsC,EACtC,IAA0B,EACC,EAAE;IAC7B,IAAA,6BAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAC/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,6CAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAVW,QAAA,mBAAmB,uBAU9B;AAQF,0EAA0E;AAC1E,MAAM,SAAS,GAAG,CAAC,KAAc,EAAe,EAAE;IAChD,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAuB,CAAC;IACrD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACxB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAU,CAAC;QAC9D,CAAC,CAAC,EAAE,CAAC;AACT,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,0BAA0B,GAAG,CAGxC,WAA8C,EAC9C,UAAuC,EAAE,EAC8B,EAAE;IACzE,MAAM,MAAM,GAAG,IAAA,uDAAkC,EAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAA,sCAAqB,EAAC,WAAW,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,IAAA,sCAAwB,EAAC,WAAW,CAAC,CAAC;IAC3D,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;gBACvB,QAAQ,EAAE,EAAE;gBACZ,WAAW,EAAE,SAAS;aACvB,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAkC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;YACvB,MAAM,QAAQ,GAAG,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzD,OAAO;gBACL,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAC5B,MAAM,EAAE,QAAQ;gBAChB,QAAQ;gBACR,WAAW,EAAE,KAAK;aACnB,CAAC;QACJ,CAAC;QACD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAC3D,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,KAAK;SACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAvCW,QAAA,0BAA0B,8BAuCrC;AAYF;;;;;;;;;;GAUG;AACI,MAAM,uBAAuB,GAAG,CACrC,WAA8C,EAC9C,EAAE,WAAW,KAAuD,EAAE,EAC7B,EAAE;IAC3C,MAAM,MAAM,GAAG,IAAA,uDAAkC,EAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAA,sCAAwB,EAAC,WAAW,CAAC,CAAC;IAC3D,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO;gBACL,KAAK,EAAE,IAAI;gBACX,MAAM,EAAE,EAAE;gBACV,WAAW,EAAE,MAAM,CAAC,IAA8B;aACnD,CAAC;QACJ,CAAC;QACD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;SACpE,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAxBW,QAAA,uBAAuB,2BAwBlC;AAEF,qEAAqE;AACrE,MAAM,2BAA2B,GAAG,CAClC,IAAwB,EACxB,IAA8C,EACzB,EAAE,CACvB,8BAAa,CAAC,MAAM,CAClB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,iCAAgB,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CACzE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAClB,OAAO;IACP,OAAO,EAAE,4CAA4C,OAAO,GAAG;CAChE,CAAC,CAAC,CAAC;AAEN;;;;;;;GAOG;AACH,MAAM,4BAA4B,GAAG,CACnC,IAAwB,EACxB,IAA8C,EAC3B,EAAE;IACrB,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAQ,EAAE;QAClD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QACD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,IAAwC,CAAC;QAC9D,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC3B,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,KAAK;oBAClB,OAAO,EAAE,iBAAiB,IAAA,oBAAS,EAAC,EAAE,CAAC,kBAAkB,KAAK,EAAE;oBAChE,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACxD,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAClD,KAAK,CAAC,KAAK,EAAE,IAAA,8BAAa,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,MAAM,CAAC;AAChB,CAAC,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\nimport {\n  childNodePath,\n  createChildNodeWalker,\n  rendersOnSurface,\n  SURFACE_NAMES,\n  type SurfaceName,\n} from '../composition/body_node_base';\nimport type { Composition } from '../composition/composition';\nimport type { PrimitiveNode } from '../composition/node';\nimport { quoteText } from '../composition/one_line';\nimport {\n  CompositionValidationError,\n  type ValidationError,\n} from '../composition/validation_error';\nimport type { AnyPrimitiveDefinition } from '../define/primitive_module';\n\nimport { getCompositionSchemaForDefinitions } from './composition_schema';\nimport {\n  checkInputBudget,\n  type InputBudget,\n  isInputRefusal,\n} from './input_budget';\nimport { createNodeIssueFormatter, type IssueRoot } from './node_issues';\n\n/**\n * A non-fatal validation finding, scoped to the surface it concerns.\n *\n * Warnings carry `surface` because every one of them is a statement about one\n * render target — a composition that draws nothing on `slack` is not news to a\n * caller rendering HTML. Without the scope a host receives every surface's\n * findings on every call and learns to ignore the channel.\n * {@link warningsForSurface} is the filter.\n */\nexport interface ValidationWarning {\n  /** The render target this finding concerns, never the composition as a whole. */\n  surface: SurfaceName;\n  /**\n   * Path of the offending node within the composition, absent for\n   * whole-composition findings.\n   */\n  path?: string;\n  /** Safe to show a user, and phrased for whoever can act on it. */\n  message: string;\n}\n\n/**\n * The outcome of `validate`: errors are fatal, warnings are advisory.\n *\n * `valid` tracks `errors` only — a composition can be valid and still carry\n * warnings, which is the normal case for a surface gap.\n */\nexport interface ValidationResult {\n  /** True when `errors` is empty, regardless of `warnings`. */\n  valid: boolean;\n  /** Fatal findings. Empty when `valid`. */\n  errors: ValidationError[];\n  /** Advisory findings, empty when there are none. */\n  warnings: ValidationWarning[];\n}\n\nconst checkedComposition = Symbol.for('elastic.isomer.checked_composition');\n\n/** The copy {@link createCompositionValidator} checked, which a validating render draws in place of the caller's value. The brand is type-only. */\nexport type CheckedComposition<TNode extends PrimitiveNode = PrimitiveNode> =\n  Composition<TNode> & { readonly [checkedComposition]: true };\n\n/** A {@link ValidationResult} with the composition it describes. */\nexport interface CheckedValidationResult<\n  TNode extends PrimitiveNode = PrimitiveNode,\n> extends ValidationResult {\n  /** Undefined only when {@link checkInputBudget} refused the input. */\n  composition: CheckedComposition<TNode> | undefined;\n}\n\n/** Narrows a result's warnings to the surface a caller is about to render. */\nexport const warningsForSurface = (\n  result: ValidationResult,\n  surface: SurfaceName\n): ValidationWarning[] =>\n  result.warnings.filter((warning) => warning.surface === surface);\n\n/** Whether a render reports validation findings or raises on them. */\nexport type ValidationErrorMode = 'collect' | 'throw';\n\nexport { CompositionValidationError };\n\n/** Raises {@link CompositionValidationError} when `mode` is `throw` and `result` is invalid, or in any mode when {@link checkInputBudget} refused the input, which nothing can render. */\nexport const enforceValidationMode = (\n  result: ValidationResult,\n  mode?: ValidationErrorMode\n): void => {\n  if (\n    !result.valid &&\n    (mode === 'throw' || result.errors.some(isInputRefusal))\n  ) {\n    throw new CompositionValidationError(result.errors);\n  }\n};\n\n/** The composition `result` checked, which is what a render draws. Throws {@link CompositionValidationError} when `mode` is `'throw'` and `result` is invalid, or in any mode when {@link checkInputBudget} refused the input. */\nexport const compositionToRender = <TNode extends PrimitiveNode>(\n  result: CheckedValidationResult<TNode>,\n  mode?: ValidationErrorMode\n): CheckedComposition<TNode> => {\n  enforceValidationMode(result, mode);\n  const { composition } = result;\n  if (composition === undefined) {\n    throw new CompositionValidationError(result.errors);\n  }\n  return composition;\n};\n\n/** Options for {@link createCompositionValidator}. */\nexport interface CompositionValidatorOptions {\n  /** Limits checked before the schema runs; see {@link checkInputBudget}. */\n  inputBudget?: InputBudget;\n}\n\n/** The body's nodes, as {@link IssueRoot}s for a node issue formatter. */\nconst bodyRoots = (value: unknown): IssueRoot[] => {\n  const { body } = (value ?? {}) as { body?: unknown };\n  return Array.isArray(body)\n    ? body.map((node, index) => [node, `body[${index}]`] as const)\n    : [];\n};\n\n/**\n * Builds the trusted-input validator: {@link checkInputBudget}, then the schema and the semantic passes on its copy, which the result carries.\n *\n * `definitions` is memoized on array identity, so a caller that rebuilds the\n * array per call (`createCompositionValidator(packs.flatMap(…))`) resolves a\n * fresh discriminated union each time. Hold the array `composePacks` returns\n * and reuse it across the validator, the parser, and the authoring context.\n */\nexport const createCompositionValidator = <\n  TNode extends PrimitiveNode = PrimitiveNode,\n>(\n  definitions: readonly AnyPrimitiveDefinition[],\n  options: CompositionValidatorOptions = {}\n): ((composition: Composition<TNode>) => CheckedValidationResult<TNode>) => {\n  const schema = getCompositionSchemaForDefinitions(definitions);\n  const walk = createChildNodeWalker(definitions);\n  const formatIssues = createNodeIssueFormatter(definitions);\n  return (composition) => {\n    const checked = checkInputBudget(composition, options.inputBudget);\n    if (!checked.valid) {\n      return {\n        valid: false,\n        errors: [checked.error],\n        warnings: [],\n        composition: undefined,\n      };\n    }\n    const plain = checked.value as CheckedComposition<TNode>;\n    const result = schema.safeParse(plain, { reportInput: true });\n    if (result.success) {\n      const { body } = plain;\n      const idErrors = collectDuplicateNodeIdErrors(body, walk);\n      const warnings = collectEmptySurfaceWarnings(body, walk);\n      return {\n        valid: idErrors.length === 0,\n        errors: idErrors,\n        warnings,\n        composition: plain,\n      };\n    }\n    return {\n      valid: false,\n      errors: formatIssues(bodyRoots(plain), result.error.issues),\n      warnings: [],\n      composition: plain,\n    };\n  };\n};\n\n/** The outcome of `parse`. */\nexport interface ParsedComposition {\n  /** True when the value matched the schema. Says nothing about id uniqueness. */\n  valid: boolean;\n  /** Schema failures. Empty when `valid`. */\n  errors: ValidationError[];\n  /** The parsed document, present only when `valid`. */\n  composition?: Composition;\n}\n\n/**\n * Builds the untrusted-input parser: {@link checkInputBudget}, then the schema only on its copy, reported rather than thrown.\n *\n * Deliberately narrower than {@link createCompositionValidator}. This answers\n * \"is this a `Composition`\", not \"is this a good one\" — it does not run the\n * duplicate-id pass or produce warnings, so a composition with two nodes\n * sharing an `id` parses as valid. Id uniqueness is a `validate` guarantee, so\n * a caller that wants the semantic checks runs `validate` on the result.\n *\n * Shares {@link createCompositionValidator}'s memoization identity requirement.\n */\nexport const createCompositionParser = (\n  definitions: readonly AnyPrimitiveDefinition[],\n  { inputBudget }: Pick<CompositionValidatorOptions, 'inputBudget'> = {}\n): ((value: unknown) => ParsedComposition) => {\n  const schema = getCompositionSchemaForDefinitions(definitions);\n  const formatIssues = createNodeIssueFormatter(definitions);\n  return (value) => {\n    const checked = checkInputBudget(value, inputBudget);\n    if (!checked.valid) {\n      return { valid: false, errors: [checked.error] };\n    }\n    const result = schema.safeParse(checked.value, { reportInput: true });\n    if (result.success) {\n      return {\n        valid: true,\n        errors: [],\n        composition: result.data as unknown as Composition,\n      };\n    }\n    return {\n      valid: false,\n      errors: formatIssues(bodyRoots(checked.value), result.error.issues),\n    };\n  };\n};\n\n/** Warns once per surface that the whole body renders nothing on. */\nconst collectEmptySurfaceWarnings = (\n  body: readonly unknown[],\n  walk: ReturnType<typeof createChildNodeWalker>\n): ValidationWarning[] =>\n  SURFACE_NAMES.filter(\n    (surface) => !body.some((node) => rendersOnSurface(node, surface, walk))\n  ).map((surface) => ({\n    surface,\n    message: `composition renders no nodes on surface \"${surface}\"`,\n  }));\n\n/**\n * Errors for each node whose `id` repeats one already seen, naming the first\n * use.\n *\n * Errors rather than warnings, because ids are what a host addresses a node by.\n * Run by `validate` and deliberately not by `parse`; see\n * {@link createCompositionParser}.\n */\nconst collectDuplicateNodeIdErrors = (\n  body: readonly unknown[],\n  walk: ReturnType<typeof createChildNodeWalker>\n): ValidationError[] => {\n  const errors: ValidationError[] = [];\n  const seen = new Map<string, string>();\n  const visit = (node: unknown, path: string): void => {\n    if (!node || typeof node !== 'object') {\n      return;\n    }\n    const { id, type } = node as { id?: unknown; type?: unknown };\n    if (typeof id === 'string') {\n      const first = seen.get(id);\n      if (first) {\n        errors.push({\n          path: `${path}.id`,\n          message: `duplicates id ${quoteText(id)} first used at ${first}`,\n          ...(typeof type === 'string' ? { nodeType: type } : {}),\n        });\n      } else {\n        seen.set(id, path);\n      }\n    }\n    walk(node).forEach(({ node: child, path: field }) => {\n      visit(child, childNodePath(path, field));\n    });\n  };\n  body.forEach((node, index) => visit(node, `body[${index}]`));\n  return errors;\n};\n"]}

package/dist/composition/body_node_base.d.ts

@@ -1,12 +1,13 @@
 /**
- * The five surfaces a node renders on or is hidden from.
+ * Every surface a node renders on or is hidden from, in render order.
  *
- * Spelled out rather than derived as `keyof SurfaceMap<…>`: the keys never vary
- * with the pack types, and TypeScript can fail to prove a `keyof` over one
- * instantiation transfers to another, silently widening to `any`.
+ * `html` is not here: the runtime's `html` surface wraps `react` output in a
+ * document, and no node targets it.
  */
-export type SurfaceName = 'react' | 'svg' | 'text' | 'markdown' | 'slack';
-/** Every {@link SurfaceName}, for callers that iterate them. */
+export declare const SURFACE_NAMES: readonly ["react", "snapshot", "text", "markdown", "slack"];
+/** One of the {@link SURFACE_NAMES}. */
+export type SurfaceName = (typeof SURFACE_NAMES)[number];
+/** @deprecated Use {@link SURFACE_NAMES}. */
 export declare const BODY_NODE_SURFACES: readonly SurfaceName[];
 /** The two fields every primitive node carries, whatever its pack. */
 export interface BodyNodeBase {

package/dist/composition/body_node_base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"body_node_base.d.ts","sourceRoot":"","sources":["../../src/composition/body_node_base.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;AAE1E,gEAAgE;AAChE,eAAO,MAAM,kBAAkB,EAAE,SAAS,WAAW,EAMpD,CAAC;AAEF,sEAAsE;AACtE,MAAM,WAAW,YAAY;IAC3B,mFAAmF;IACnF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iEAAiE;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,qFAAqF;IACrF,IAAI,EAAE,OAAO,CAAC;IACd,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,KAAK,YAAY,EAAE,CAAC,GAAG;IAClE,aAAa,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CACxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,aAAa,SAAS;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,EAAE,KACF,eAyCF,CAAC;AAEF,qEAAqE;AACrE,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,EAAE,OAAO,MAAM,KAAG,MACxC,CAAC;AAEvB;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GACvB,OAAO,SAAS,OAAO,EAAE,EACzB,SAAS,WAAW,EACpB,WAAW,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,EACrC,MAAM,eAAe,KACpB,OAcC,CAAC;AAEL,oFAAoF;AACpF,eAAO,MAAM,kBAAkB,GAC7B,MAAM,OAAO,EACb,SAAS,WAAW,KACnB,OAMF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,MAAM,OAAO,EACb,SAAS,WAAW,EACpB,MAAM,eAAe,KACpB,OAWF,CAAC"}
+{"version":3,"file":"body_node_base.d.ts","sourceRoot":"","sources":["../../src/composition/body_node_base.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,6DAMhB,CAAC;AAEX,wCAAwC;AACxC,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD,6CAA6C;AAC7C,eAAO,MAAM,kBAAkB,EAAE,SAAS,WAAW,EAAkB,CAAC;AAExE,sEAAsE;AACtE,MAAM,WAAW,YAAY;IAC3B,mFAAmF;IACnF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iEAAiE;IACjE,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,qFAAqF;IACrF,IAAI,EAAE,OAAO,CAAC;IACd,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,KAAK,YAAY,EAAE,CAAC,GAAG;IAClE,aAAa,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CACxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,aAAa,SAAS;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,EAAE,KACF,eAyCF,CAAC;AAEF,qEAAqE;AACrE,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,EAAE,OAAO,MAAM,KAAG,MACxC,CAAC;AAEvB;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GACvB,OAAO,SAAS,OAAO,EAAE,EACzB,SAAS,WAAW,EACpB,WAAW,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,EACrC,MAAM,eAAe,KACpB,OAcC,CAAC;AAEL,oFAAoF;AACpF,eAAO,MAAM,kBAAkB,GAC7B,MAAM,OAAO,EACb,SAAS,WAAW,KACnB,OAMF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,MAAM,OAAO,EACb,SAAS,WAAW,EACpB,MAAM,eAAe,KACpB,OAWF,CAAC"}

package/dist/composition/body_node_base.js

@@ -4,14 +4,21 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-/** Every {@link SurfaceName}, for callers that iterate them. */
-export const BODY_NODE_SURFACES = [
+/**
+ * Every surface a node renders on or is hidden from, in render order.
+ *
+ * `html` is not here: the runtime's `html` surface wraps `react` output in a
+ * document, and no node targets it.
+ */
+export const SURFACE_NAMES = [
     'react',
-    'svg',
+    'snapshot',
     'text',
     'markdown',
     'slack',
 ];
+/** @deprecated Use {@link SURFACE_NAMES}. */
+export const BODY_NODE_SURFACES = SURFACE_NAMES;
 /**
  * Builds the {@link ChildNodeWalker} for one composition's inventory.
  *

package/dist/composition/body_node_base.js.map

@@ -1 +1 @@
-{"version":3,"file":"body_node_base.js","sourceRoot":"","sources":["../../src/composition/body_node_base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAA2B;IACxD,OAAO;IACP,KAAK;IACL,MAAM;IACN,UAAU;IACV,OAAO;CACR,CAAC;AAgCF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,WAIG,EACc,EAAE;IACnB,MAAM,cAAc,GAAG,IAAI,GAAG,EAG3B,CAAC;IACJ,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAsC,CAAC;IACvE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,OAAO,UAAU,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC9C,cAAc,CAAC,GAAG,CAChB,UAAU,CAAC,IAAI,EACf,UAAU,CAAC,QAAsD,CAClE,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,UAAU,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;YACnD,gBAAgB,CAAC,GAAG,CAClB,UAAU,CAAC,IAAI,EACf,UAAU,CAAC,aAA2C,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE;QAC9B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAA0B,CAAC;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC,CAAoB,CAAC;IACtB,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,EAAE;QAC5B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAA0B,CAAC;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;IACrD,CAAC,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,qEAAqE;AACrE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CACrE,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC;AAEvB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,KAAyB,EACzB,OAAoB,EACpB,SAAqC,EACrC,IAAqB,EACZ,EAAE,CACX,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;IAClB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,SAAS,CAAC,IAAI,CAAC;QACf,YAAY,CACV,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EACrC,OAAO,EACP,SAAS,EACT,IAAI,CACL,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,oFAAoF;AACpF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,IAAa,EACb,OAAoB,EACX,EAAE;IACX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAA8B,CAAC;IACpD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,IAAa,EACb,OAAoB,EACpB,IAAqB,EACZ,EAAE;IACX,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CACvC,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CACvC,CAAC;AACJ,CAAC,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\n/**\n * The five surfaces a node renders on or is hidden from.\n *\n * Spelled out rather than derived as `keyof SurfaceMap<…>`: the keys never vary\n * with the pack types, and TypeScript can fail to prove a `keyof` over one\n * instantiation transfers to another, silently widening to `any`.\n */\nexport type SurfaceName = 'react' | 'svg' | 'text' | 'markdown' | 'slack';\n\n/** Every {@link SurfaceName}, for callers that iterate them. */\nexport const BODY_NODE_SURFACES: readonly SurfaceName[] = [\n  'react',\n  'svg',\n  'text',\n  'markdown',\n  'slack',\n];\n\n/** The two fields every primitive node carries, whatever its pack. */\nexport interface BodyNodeBase {\n  /** Unique within a composition, which `validate` enforces and `parse` does not. */\n  id?: string;\n  /** Surfaces this node appears on. Absent means every surface. */\n  surfaces?: SurfaceName[];\n}\n\n/**\n * A child node together with the field path locating it inside its parent, so\n * an error path can name the field a child actually lives under. A container\n * that returned bare nodes would leave every caller guessing the field name.\n */\nexport interface ChildNodeRef {\n  /** Erased: one walker spans every pack's node types, so it can name none of them. */\n  node: unknown;\n  /** Relative to the parent, e.g. `items[0].node`, `items[2].description`. */\n  path: string;\n}\n\n/**\n * Walks nested nodes and, for a hybrid container, reports whether the parent\n * still produces output of its own. A non-empty `children` result is the\n * complete source of rendered content unless\n * {@link ChildNodeWalker.hasOwnContent} is true for that node.\n */\nexport type ChildNodeWalker = ((node: unknown) => ChildNodeRef[]) & {\n  hasOwnContent?(node: unknown): boolean;\n};\n\n/**\n * Builds the {@link ChildNodeWalker} for one composition's inventory.\n *\n * Pass every pack's definitions: a walker missing one cannot see children of a\n * container that pack defines, and a tree walk would stop at its boundary.\n */\nexport const createChildNodeWalker = (\n  definitions: readonly {\n    type: string;\n    children?: unknown;\n    hasOwnContent?: unknown;\n  }[]\n): ChildNodeWalker => {\n  const childrenByType = new Map<\n    string,\n    (node: unknown) => readonly ChildNodeRef[]\n  >();\n  const ownContentByType = new Map<string, (node: unknown) => boolean>();\n  for (const definition of definitions) {\n    if (typeof definition.children === 'function') {\n      childrenByType.set(\n        definition.type,\n        definition.children as (node: unknown) => readonly ChildNodeRef[]\n      );\n    }\n    if (typeof definition.hasOwnContent === 'function') {\n      ownContentByType.set(\n        definition.type,\n        definition.hasOwnContent as (node: unknown) => boolean\n      );\n    }\n  }\n  const walk = ((node: unknown) => {\n    if (!node || typeof node !== 'object') {\n      return [];\n    }\n    const { type } = node as { type?: unknown };\n    if (typeof type !== 'string') {\n      return [];\n    }\n    return [...(childrenByType.get(type)?.(node) ?? [])];\n  }) as ChildNodeWalker;\n  walk.hasOwnContent = (node) => {\n    if (!node || typeof node !== 'object') {\n      return false;\n    }\n    const { type } = node as { type?: unknown };\n    if (typeof type !== 'string') {\n      return false;\n    }\n    return ownContentByType.get(type)?.(node) ?? false;\n  };\n  return walk;\n};\n\n/** Joins a parent path with a {@link ChildNodeRef.path} fragment. */\nexport const childNodePath = (parent: string, child: string): string =>\n  `${parent}.${child}`;\n\n/**\n * Whether any node visible on `surface` matches, descending through container\n * children via `walk`. A node (or a container ancestor) hidden from `surface`\n * is skipped along with its children.\n *\n * `walk` must span every pack in the composition: a walker built from one\n * pack's definitions cannot see children of a container defined in another.\n */\nexport const someBodyNode = (\n  nodes: readonly unknown[],\n  surface: SurfaceName,\n  predicate: (node: unknown) => boolean,\n  walk: ChildNodeWalker\n): boolean =>\n  nodes.some((node) => {\n    if (!isVisibleOnSurface(node, surface)) {\n      return false;\n    }\n    return (\n      predicate(node) ||\n      someBodyNode(\n        walk(node).map((child) => child.node),\n        surface,\n        predicate,\n        walk\n      )\n    );\n  });\n\n/** Whether `node`'s own `surfaces` hint admits `surface`, ignoring its children. */\nexport const isVisibleOnSurface = (\n  node: unknown,\n  surface: SurfaceName\n): boolean => {\n  if (!node || typeof node !== 'object') {\n    return false;\n  }\n  const { surfaces } = node as { surfaces?: unknown };\n  return !Array.isArray(surfaces) || surfaces.includes(surface);\n};\n\n/**\n * Whether `node` puts anything on `surface` — itself or through a descendant.\n *\n * Stronger than {@link isVisibleOnSurface}: a container every one of whose\n * children is hidden renders nothing, even though its own hint allows the\n * surface. A hybrid container that also owns string fields declares\n * {@link ChildNodeWalker.hasOwnContent} and keeps rendering regardless.\n */\nexport const rendersOnSurface = (\n  node: unknown,\n  surface: SurfaceName,\n  walk: ChildNodeWalker\n): boolean => {\n  if (!isVisibleOnSurface(node, surface)) {\n    return false;\n  }\n  const children = walk(node);\n  if (children.length === 0 || walk.hasOwnContent?.(node)) {\n    return true;\n  }\n  return children.some(({ node: child }) =>\n    rendersOnSurface(child, surface, walk)\n  );\n};\n"]}
+{"version":3,"file":"body_node_base.js","sourceRoot":"","sources":["../../src/composition/body_node_base.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO;IACP,UAAU;IACV,MAAM;IACN,UAAU;IACV,OAAO;CACC,CAAC;AAKX,6CAA6C;AAC7C,MAAM,CAAC,MAAM,kBAAkB,GAA2B,aAAa,CAAC;AAgCxE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,WAIG,EACc,EAAE;IACnB,MAAM,cAAc,GAAG,IAAI,GAAG,EAG3B,CAAC;IACJ,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAsC,CAAC;IACvE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,OAAO,UAAU,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC9C,cAAc,CAAC,GAAG,CAChB,UAAU,CAAC,IAAI,EACf,UAAU,CAAC,QAAsD,CAClE,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,UAAU,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;YACnD,gBAAgB,CAAC,GAAG,CAClB,UAAU,CAAC,IAAI,EACf,UAAU,CAAC,aAA2C,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE;QAC9B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAA0B,CAAC;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC,CAAoB,CAAC;IACtB,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,EAAE,EAAE;QAC5B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,IAA0B,CAAC;QAC5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;IACrD,CAAC,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,qEAAqE;AACrE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CACrE,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC;AAEvB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,KAAyB,EACzB,OAAoB,EACpB,SAAqC,EACrC,IAAqB,EACZ,EAAE,CACX,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;IAClB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,SAAS,CAAC,IAAI,CAAC;QACf,YAAY,CACV,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EACrC,OAAO,EACP,SAAS,EACT,IAAI,CACL,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,oFAAoF;AACpF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,IAAa,EACb,OAAoB,EACX,EAAE;IACX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAA8B,CAAC;IACpD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,IAAa,EACb,OAAoB,EACpB,IAAqB,EACZ,EAAE;IACX,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CACvC,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CACvC,CAAC;AACJ,CAAC,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\n/**\n * Every surface a node renders on or is hidden from, in render order.\n *\n * `html` is not here: the runtime's `html` surface wraps `react` output in a\n * document, and no node targets it.\n */\nexport const SURFACE_NAMES = [\n  'react',\n  'snapshot',\n  'text',\n  'markdown',\n  'slack',\n] as const;\n\n/** One of the {@link SURFACE_NAMES}. */\nexport type SurfaceName = (typeof SURFACE_NAMES)[number];\n\n/** @deprecated Use {@link SURFACE_NAMES}. */\nexport const BODY_NODE_SURFACES: readonly SurfaceName[] = SURFACE_NAMES;\n\n/** The two fields every primitive node carries, whatever its pack. */\nexport interface BodyNodeBase {\n  /** Unique within a composition, which `validate` enforces and `parse` does not. */\n  id?: string;\n  /** Surfaces this node appears on. Absent means every surface. */\n  surfaces?: SurfaceName[];\n}\n\n/**\n * A child node together with the field path locating it inside its parent, so\n * an error path can name the field a child actually lives under. A container\n * that returned bare nodes would leave every caller guessing the field name.\n */\nexport interface ChildNodeRef {\n  /** Erased: one walker spans every pack's node types, so it can name none of them. */\n  node: unknown;\n  /** Relative to the parent, e.g. `items[0].node`, `items[2].description`. */\n  path: string;\n}\n\n/**\n * Walks nested nodes and, for a hybrid container, reports whether the parent\n * still produces output of its own. A non-empty `children` result is the\n * complete source of rendered content unless\n * {@link ChildNodeWalker.hasOwnContent} is true for that node.\n */\nexport type ChildNodeWalker = ((node: unknown) => ChildNodeRef[]) & {\n  hasOwnContent?(node: unknown): boolean;\n};\n\n/**\n * Builds the {@link ChildNodeWalker} for one composition's inventory.\n *\n * Pass every pack's definitions: a walker missing one cannot see children of a\n * container that pack defines, and a tree walk would stop at its boundary.\n */\nexport const createChildNodeWalker = (\n  definitions: readonly {\n    type: string;\n    children?: unknown;\n    hasOwnContent?: unknown;\n  }[]\n): ChildNodeWalker => {\n  const childrenByType = new Map<\n    string,\n    (node: unknown) => readonly ChildNodeRef[]\n  >();\n  const ownContentByType = new Map<string, (node: unknown) => boolean>();\n  for (const definition of definitions) {\n    if (typeof definition.children === 'function') {\n      childrenByType.set(\n        definition.type,\n        definition.children as (node: unknown) => readonly ChildNodeRef[]\n      );\n    }\n    if (typeof definition.hasOwnContent === 'function') {\n      ownContentByType.set(\n        definition.type,\n        definition.hasOwnContent as (node: unknown) => boolean\n      );\n    }\n  }\n  const walk = ((node: unknown) => {\n    if (!node || typeof node !== 'object') {\n      return [];\n    }\n    const { type } = node as { type?: unknown };\n    if (typeof type !== 'string') {\n      return [];\n    }\n    return [...(childrenByType.get(type)?.(node) ?? [])];\n  }) as ChildNodeWalker;\n  walk.hasOwnContent = (node) => {\n    if (!node || typeof node !== 'object') {\n      return false;\n    }\n    const { type } = node as { type?: unknown };\n    if (typeof type !== 'string') {\n      return false;\n    }\n    return ownContentByType.get(type)?.(node) ?? false;\n  };\n  return walk;\n};\n\n/** Joins a parent path with a {@link ChildNodeRef.path} fragment. */\nexport const childNodePath = (parent: string, child: string): string =>\n  `${parent}.${child}`;\n\n/**\n * Whether any node visible on `surface` matches, descending through container\n * children via `walk`. A node (or a container ancestor) hidden from `surface`\n * is skipped along with its children.\n *\n * `walk` must span every pack in the composition: a walker built from one\n * pack's definitions cannot see children of a container defined in another.\n */\nexport const someBodyNode = (\n  nodes: readonly unknown[],\n  surface: SurfaceName,\n  predicate: (node: unknown) => boolean,\n  walk: ChildNodeWalker\n): boolean =>\n  nodes.some((node) => {\n    if (!isVisibleOnSurface(node, surface)) {\n      return false;\n    }\n    return (\n      predicate(node) ||\n      someBodyNode(\n        walk(node).map((child) => child.node),\n        surface,\n        predicate,\n        walk\n      )\n    );\n  });\n\n/** Whether `node`'s own `surfaces` hint admits `surface`, ignoring its children. */\nexport const isVisibleOnSurface = (\n  node: unknown,\n  surface: SurfaceName\n): boolean => {\n  if (!node || typeof node !== 'object') {\n    return false;\n  }\n  const { surfaces } = node as { surfaces?: unknown };\n  return !Array.isArray(surfaces) || surfaces.includes(surface);\n};\n\n/**\n * Whether `node` puts anything on `surface` — itself or through a descendant.\n *\n * Stronger than {@link isVisibleOnSurface}: a container every one of whose\n * children is hidden renders nothing, even though its own hint allows the\n * surface. A hybrid container that also owns string fields declares\n * {@link ChildNodeWalker.hasOwnContent} and keeps rendering regardless.\n */\nexport const rendersOnSurface = (\n  node: unknown,\n  surface: SurfaceName,\n  walk: ChildNodeWalker\n): boolean => {\n  if (!isVisibleOnSurface(node, surface)) {\n    return false;\n  }\n  const children = walk(node);\n  if (children.length === 0 || walk.hasOwnContent?.(node)) {\n    return true;\n  }\n  return children.some(({ node: child }) =>\n    rendersOnSurface(child, surface, walk)\n  );\n};\n"]}

package/dist/composition/error.d.ts

@@ -14,6 +14,7 @@ export declare const ISOMER_ERROR_CODES: {
     readonly CYCLIC_COMPOSITION: "CYCLIC_COMPOSITION";
     readonly DUPLICATE_AUTHORED_CHILD: "DUPLICATE_AUTHORED_CHILD";
     readonly DUPLICATE_ENHANCEMENT: "DUPLICATE_ENHANCEMENT";
+    readonly DUPLICATE_FORMAT: "DUPLICATE_FORMAT";
     readonly DUPLICATE_PACK_ID: "DUPLICATE_PACK_ID";
     readonly DUPLICATE_PRIMITIVE_TYPE: "DUPLICATE_PRIMITIVE_TYPE";
     readonly DUPLICATE_VIEW: "DUPLICATE_VIEW";

package/dist/composition/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/composition/error.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCrB,CAAC;AAEX,yCAAyC;AACzC,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;gBAEnB,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM;CAKnD"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/composition/error.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsCrB,CAAC;AAEX,yCAAyC;AACzC,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;;;GAOG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;gBAEnB,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM;CAKnD"}

package/dist/composition/error.js

@@ -20,6 +20,7 @@ export const ISOMER_ERROR_CODES = {
     CYCLIC_COMPOSITION: 'CYCLIC_COMPOSITION',
     DUPLICATE_AUTHORED_CHILD: 'DUPLICATE_AUTHORED_CHILD',
     DUPLICATE_ENHANCEMENT: 'DUPLICATE_ENHANCEMENT',
+    DUPLICATE_FORMAT: 'DUPLICATE_FORMAT',
     DUPLICATE_PACK_ID: 'DUPLICATE_PACK_ID',
     DUPLICATE_PRIMITIVE_TYPE: 'DUPLICATE_PRIMITIVE_TYPE',
     DUPLICATE_VIEW: 'DUPLICATE_VIEW',

package/dist/composition/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/composition/error.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,eAAe,EAAE,iBAAiB;IAClC,uBAAuB,EAAE,yBAAyB;IAClD,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;IACxC,wBAAwB,EAAE,0BAA0B;IACpD,qBAAqB,EAAE,uBAAuB;IAC9C,iBAAiB,EAAE,mBAAmB;IACtC,wBAAwB,EAAE,0BAA0B;IACpD,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,gBAAgB,EAAE,kBAAkB;IACpC,wBAAwB,EAAE,0BAA0B;IACpD,yBAAyB,EAAE,2BAA2B;IACtD,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,4BAA4B,EAAE,8BAA8B;IAC5D,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,iBAAiB,EAAE,mBAAmB;IACtC,kBAAkB,EAAE,oBAAoB;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,mBAAmB,EAAE,qBAAqB;IAC1C,mBAAmB,EAAE,qBAAqB;IAC1C,aAAa,EAAE,eAAe;IAC9B,sBAAsB,EAAE,wBAAwB;IAChD,eAAe,EAAE,iBAAiB;IAClC,YAAY,EAAE,cAAc;IAC5B,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,oBAAoB;IACxC,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAMX;;;;;;;GAOG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAC3B,IAAI,CAAkB;IAE/B,YAAY,IAAqB,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF","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/**\n * Stable codes for {@link IsomerError}, {@link CompositionValidationError},\n * and the runtime's `RegisteredViewInputError`. Hosts branch on `code`, not\n * on `message`. Codes name the condition, not the throwing module: duplicate\n * type at `definePrimitivePack`, `composePacks`, and `createIsomerRuntime` is the same\n * `DUPLICATE_PRIMITIVE_TYPE`; the message names the layer.\n */\nexport const ISOMER_ERROR_CODES = {\n  AMBIGUOUS_FRAME: 'AMBIGUOUS_FRAME',\n  AMBIGUOUS_STYLE_ADAPTER: 'AMBIGUOUS_STYLE_ADAPTER',\n  AUTHOR_TYPE_MISMATCH: 'AUTHOR_TYPE_MISMATCH',\n  AUTHORED_SCHEMA_REUSED: 'AUTHORED_SCHEMA_REUSED',\n  COMPOSITION_INVALID: 'COMPOSITION_INVALID',\n  CYCLIC_COMPOSITION: 'CYCLIC_COMPOSITION',\n  DUPLICATE_AUTHORED_CHILD: 'DUPLICATE_AUTHORED_CHILD',\n  DUPLICATE_ENHANCEMENT: 'DUPLICATE_ENHANCEMENT',\n  DUPLICATE_PACK_ID: 'DUPLICATE_PACK_ID',\n  DUPLICATE_PRIMITIVE_TYPE: 'DUPLICATE_PRIMITIVE_TYPE',\n  DUPLICATE_VIEW: 'DUPLICATE_VIEW',\n  EMPTY_FRAMES: 'EMPTY_FRAMES',\n  EMPTY_PACK: 'EMPTY_PACK',\n  EMPTY_PACKS: 'EMPTY_PACKS',\n  EMPTY_PAGES: 'EMPTY_PAGES',\n  EMPTY_VOCABULARY: 'EMPTY_VOCABULARY',\n  ENHANCEMENT_ROOT_MISSING: 'ENHANCEMENT_ROOT_MISSING',\n  EXPECTED_AUTHOR_COMPONENT: 'EXPECTED_AUTHOR_COMPONENT',\n  EXPECTED_JSX_ELEMENT: 'EXPECTED_JSX_ELEMENT',\n  EXPECTED_TEXT_CHILDREN: 'EXPECTED_TEXT_CHILDREN',\n  INCOMPATIBLE_STYLE_COLLECTOR: 'INCOMPATIBLE_STYLE_COLLECTOR',\n  INPUT_NOT_PLAIN_DATA: 'INPUT_NOT_PLAIN_DATA',\n  INPUT_OVER_BUDGET: 'INPUT_OVER_BUDGET',\n  INVALID_BODY_NODE: 'INVALID_BODY_NODE',\n  INVALID_FRAME_BODY: 'INVALID_FRAME_BODY',\n  MISSING_AUTHORED_TEXT: 'MISSING_AUTHORED_TEXT',\n  MISSING_STYLE_ADAPTER: 'MISSING_STYLE_ADAPTER',\n  RESERVED_NODE_FIELD: 'RESERVED_NODE_FIELD',\n  UNEXPECTED_CHILDREN: 'UNEXPECTED_CHILDREN',\n  UNKNOWN_FRAME: 'UNKNOWN_FRAME',\n  UNKNOWN_PRIMITIVE_TYPE: 'UNKNOWN_PRIMITIVE_TYPE',\n  UNKNOWN_SURFACE: 'UNKNOWN_SURFACE',\n  UNKNOWN_VIEW: 'UNKNOWN_VIEW',\n  UNSUPPORTED_CHILD_PATH: 'UNSUPPORTED_CHILD_PATH',\n  VIEW_INPUT_INVALID: 'VIEW_INPUT_INVALID',\n  VOCABULARY_UNRESOLVED: 'VOCABULARY_UNRESOLVED',\n} as const;\n\n/** One of {@link ISOMER_ERROR_CODES}. */\nexport type IsomerErrorCode =\n  (typeof ISOMER_ERROR_CODES)[keyof typeof ISOMER_ERROR_CODES];\n\n/**\n * Thrown for construction and authoring failures that are not a\n * `CompositionValidationError`.\n *\n * Identify it by `name` and `code`, never `instanceof`: the SDK ships both\n * ESM and CJS builds, so a host can hold two copies of this class and an\n * identity check would miss one.\n */\nexport class IsomerError extends Error {\n  readonly code: IsomerErrorCode;\n\n  constructor(code: IsomerErrorCode, message: string) {\n    super(message);\n    this.name = 'IsomerError';\n    this.code = code;\n  }\n}\n"]}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/composition/error.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,eAAe,EAAE,iBAAiB;IAClC,uBAAuB,EAAE,yBAAyB;IAClD,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,oBAAoB;IACxC,wBAAwB,EAAE,0BAA0B;IACpD,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,wBAAwB,EAAE,0BAA0B;IACpD,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,gBAAgB,EAAE,kBAAkB;IACpC,wBAAwB,EAAE,0BAA0B;IACpD,yBAAyB,EAAE,2BAA2B;IACtD,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,4BAA4B,EAAE,8BAA8B;IAC5D,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,iBAAiB,EAAE,mBAAmB;IACtC,kBAAkB,EAAE,oBAAoB;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,mBAAmB,EAAE,qBAAqB;IAC1C,mBAAmB,EAAE,qBAAqB;IAC1C,aAAa,EAAE,eAAe;IAC9B,sBAAsB,EAAE,wBAAwB;IAChD,eAAe,EAAE,iBAAiB;IAClC,YAAY,EAAE,cAAc;IAC5B,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,oBAAoB;IACxC,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAMX;;;;;;;GAOG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAC3B,IAAI,CAAkB;IAE/B,YAAY,IAAqB,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF","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/**\n * Stable codes for {@link IsomerError}, {@link CompositionValidationError},\n * and the runtime's `RegisteredViewInputError`. Hosts branch on `code`, not\n * on `message`. Codes name the condition, not the throwing module: duplicate\n * type at `definePrimitivePack`, `composePacks`, and `createIsomerRuntime` is the same\n * `DUPLICATE_PRIMITIVE_TYPE`; the message names the layer.\n */\nexport const ISOMER_ERROR_CODES = {\n  AMBIGUOUS_FRAME: 'AMBIGUOUS_FRAME',\n  AMBIGUOUS_STYLE_ADAPTER: 'AMBIGUOUS_STYLE_ADAPTER',\n  AUTHOR_TYPE_MISMATCH: 'AUTHOR_TYPE_MISMATCH',\n  AUTHORED_SCHEMA_REUSED: 'AUTHORED_SCHEMA_REUSED',\n  COMPOSITION_INVALID: 'COMPOSITION_INVALID',\n  CYCLIC_COMPOSITION: 'CYCLIC_COMPOSITION',\n  DUPLICATE_AUTHORED_CHILD: 'DUPLICATE_AUTHORED_CHILD',\n  DUPLICATE_ENHANCEMENT: 'DUPLICATE_ENHANCEMENT',\n  DUPLICATE_FORMAT: 'DUPLICATE_FORMAT',\n  DUPLICATE_PACK_ID: 'DUPLICATE_PACK_ID',\n  DUPLICATE_PRIMITIVE_TYPE: 'DUPLICATE_PRIMITIVE_TYPE',\n  DUPLICATE_VIEW: 'DUPLICATE_VIEW',\n  EMPTY_FRAMES: 'EMPTY_FRAMES',\n  EMPTY_PACK: 'EMPTY_PACK',\n  EMPTY_PACKS: 'EMPTY_PACKS',\n  EMPTY_PAGES: 'EMPTY_PAGES',\n  EMPTY_VOCABULARY: 'EMPTY_VOCABULARY',\n  ENHANCEMENT_ROOT_MISSING: 'ENHANCEMENT_ROOT_MISSING',\n  EXPECTED_AUTHOR_COMPONENT: 'EXPECTED_AUTHOR_COMPONENT',\n  EXPECTED_JSX_ELEMENT: 'EXPECTED_JSX_ELEMENT',\n  EXPECTED_TEXT_CHILDREN: 'EXPECTED_TEXT_CHILDREN',\n  INCOMPATIBLE_STYLE_COLLECTOR: 'INCOMPATIBLE_STYLE_COLLECTOR',\n  INPUT_NOT_PLAIN_DATA: 'INPUT_NOT_PLAIN_DATA',\n  INPUT_OVER_BUDGET: 'INPUT_OVER_BUDGET',\n  INVALID_BODY_NODE: 'INVALID_BODY_NODE',\n  INVALID_FRAME_BODY: 'INVALID_FRAME_BODY',\n  MISSING_AUTHORED_TEXT: 'MISSING_AUTHORED_TEXT',\n  MISSING_STYLE_ADAPTER: 'MISSING_STYLE_ADAPTER',\n  RESERVED_NODE_FIELD: 'RESERVED_NODE_FIELD',\n  UNEXPECTED_CHILDREN: 'UNEXPECTED_CHILDREN',\n  UNKNOWN_FRAME: 'UNKNOWN_FRAME',\n  UNKNOWN_PRIMITIVE_TYPE: 'UNKNOWN_PRIMITIVE_TYPE',\n  UNKNOWN_SURFACE: 'UNKNOWN_SURFACE',\n  UNKNOWN_VIEW: 'UNKNOWN_VIEW',\n  UNSUPPORTED_CHILD_PATH: 'UNSUPPORTED_CHILD_PATH',\n  VIEW_INPUT_INVALID: 'VIEW_INPUT_INVALID',\n  VOCABULARY_UNRESOLVED: 'VOCABULARY_UNRESOLVED',\n} as const;\n\n/** One of {@link ISOMER_ERROR_CODES}. */\nexport type IsomerErrorCode =\n  (typeof ISOMER_ERROR_CODES)[keyof typeof ISOMER_ERROR_CODES];\n\n/**\n * Thrown for construction and authoring failures that are not a\n * `CompositionValidationError`.\n *\n * Identify it by `name` and `code`, never `instanceof`: the SDK ships both\n * ESM and CJS builds, so a host can hold two copies of this class and an\n * identity check would miss one.\n */\nexport class IsomerError extends Error {\n  readonly code: IsomerErrorCode;\n\n  constructor(code: IsomerErrorCode, message: string) {\n    super(message);\n    this.name = 'IsomerError';\n    this.code = code;\n  }\n}\n"]}

package/dist/composition/index.d.ts

@@ -1,5 +1,5 @@
 export { type ActionEventRef } from './action_event.js';
-export { type BodyNodeBase, type ChildNodeRef, type ChildNodeWalker, type SurfaceName, BODY_NODE_SURFACES, createChildNodeWalker, isVisibleOnSurface, someBodyNode, } from './body_node_base.js';
+export { type BodyNodeBase, type ChildNodeRef, type ChildNodeWalker, type SurfaceName, BODY_NODE_SURFACES, SURFACE_NAMES, createChildNodeWalker, isVisibleOnSurface, someBodyNode, } from './body_node_base.js';
 export { type Composition, type CompositionMeta } from './composition.js';
 export { type IsomerErrorCode, ISOMER_ERROR_CODES, IsomerError } from './error.js';
 export { mapCompositionNodes } from './map_nodes.js';

package/dist/composition/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composition/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,gBAAgB,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,eAAe,EACpB,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composition/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,gBAAgB,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,eAAe,EACpB,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,oBAAoB,CAAC"}

package/dist/composition/index.js

@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-export { BODY_NODE_SURFACES, createChildNodeWalker, isVisibleOnSurface, someBodyNode, } from './body_node_base.js';
+export { BODY_NODE_SURFACES, SURFACE_NAMES, createChildNodeWalker, isVisibleOnSurface, someBodyNode, } from './body_node_base.js';
 export { ISOMER_ERROR_CODES, IsomerError } from './error.js';
 export { mapCompositionNodes } from './map_nodes.js';
 export { ALL_NAMED_COLORS, } from './named_color.js';

package/dist/composition/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/composition/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAKL,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAwB,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAIL,gBAAgB,GACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAIL,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,oBAAoB,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 ActionEventRef } from './action_event';\nexport {\n  type BodyNodeBase,\n  type ChildNodeRef,\n  type ChildNodeWalker,\n  type SurfaceName,\n  BODY_NODE_SURFACES,\n  createChildNodeWalker,\n  isVisibleOnSurface,\n  someBodyNode,\n} from './body_node_base';\nexport { type Composition, type CompositionMeta } from './composition';\nexport { type IsomerErrorCode, ISOMER_ERROR_CODES, IsomerError } from './error';\nexport { mapCompositionNodes } from './map_nodes';\nexport {\n  type NamedColor,\n  type NamedColorPalette,\n  type RenderTheme,\n  ALL_NAMED_COLORS,\n} from './named_color';\nexport { type PrimitiveNode } from './node';\nexport { nameText, oneLine, quoteText } from './one_line';\nexport {\n  type DisplayValue,\n  type StructuredValue,\n  type StructuredValueFormat,\n  STRUCTURED_VALUE_FORMATS,\n} from './structured_value';\nexport {\n  type ValidationError,\n  CompositionValidationError,\n  formatValidationError,\n} from './validation_error';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/composition/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAKL,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAwB,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAIL,gBAAgB,GACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAIL,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,oBAAoB,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 ActionEventRef } from './action_event';\nexport {\n  type BodyNodeBase,\n  type ChildNodeRef,\n  type ChildNodeWalker,\n  type SurfaceName,\n  BODY_NODE_SURFACES,\n  SURFACE_NAMES,\n  createChildNodeWalker,\n  isVisibleOnSurface,\n  someBodyNode,\n} from './body_node_base';\nexport { type Composition, type CompositionMeta } from './composition';\nexport { type IsomerErrorCode, ISOMER_ERROR_CODES, IsomerError } from './error';\nexport { mapCompositionNodes } from './map_nodes';\nexport {\n  type NamedColor,\n  type NamedColorPalette,\n  type RenderTheme,\n  ALL_NAMED_COLORS,\n} from './named_color';\nexport { type PrimitiveNode } from './node';\nexport { nameText, oneLine, quoteText } from './one_line';\nexport {\n  type DisplayValue,\n  type StructuredValue,\n  type StructuredValueFormat,\n  STRUCTURED_VALUE_FORMATS,\n} from './structured_value';\nexport {\n  type ValidationError,\n  CompositionValidationError,\n  formatValidationError,\n} from './validation_error';\n"]}

package/dist/define/frame.d.ts

@@ -33,10 +33,10 @@ export interface FrameViewport<TTheme> {
  * written against a narrowed node union while the runtime holds the erased form.
  */
 export interface FrameDispatcher<TNode extends PrimitiveNode = PrimitiveNode> {
-    /** Draws one node on the `svg` surface. `key` must be unique among its siblings. */
-    renderSvg(node: TNode, key: string): ReactNode;
-    /** The node's height in pixels; `0` when it is hidden from `svg` or its primitive declares no `metrics.svgHeight`. */
-    estimateSvgHeight(node: TNode): number;
+    /** Draws one node on the `snapshot` surface. `key` must be unique among its siblings. */
+    renderSnapshot(node: TNode, key: string): ReactNode;
+    /** The node's height in pixels; `0` when it is hidden from `snapshot` or its primitive declares no `metrics.snapshotHeight`. */
+    estimateSnapshotHeight(node: TNode): number;
 }
 /**
  * What {@link Frame.wrap} is told about the composition it draws around.
@@ -63,7 +63,7 @@ export interface FrameComposition extends FrameHeader {
  */
 export type FrameBody = readonly ReactNode[];
 /**
- * A document an `svg` render can produce: its geometry, the surround it draws
+ * A document a `snapshot` render can produce: its geometry, the surround it draws
  * around the body, and whatever it requires of a composition it is asked to
  * draw.
  *
@@ -77,16 +77,6 @@ export type FrameBody = readonly ReactNode[];
 export interface Frame<TTheme> {
     /** Width used when the caller passes none. */
     defaultWidth: number;
-    /**
-     * Whether {@link Frame.estimateHeight} sums per-node heights, and so
-     * under-sizes the frame for a node whose primitive declares no
-     * `metrics.svgHeight` — `dispatcher.estimateSvgHeight` returns `0` for those.
-     *
-     * Defaults to `true`, because the gap is silent and a frame that measures
-     * nodes is the normal case. A fixed-size frame sets `false` once and stops
-     * the missing `svgHeight` warning reporting a metric nothing reads.
-     */
-    sizesFromNodeHeights?: boolean;
     /**
      * Palette per mode. Frame and palette vary independently — a branded card is
      * this geometry with a host's colors — so a host overrides one by spreading
@@ -95,8 +85,9 @@ export interface Frame<TTheme> {
     theme: ThemePair<TTheme>;
     /**
      * Height for this body when the caller passes none, in the geometry this
-     * document defines. See {@link Frame.sizesFromNodeHeights} for what it may
-     * assume of the nodes.
+     * document defines. Calling {@link FrameDispatcher.estimateSnapshotHeight} is
+     * what makes a missing `metrics.snapshotHeight` size the frame short: that
+     * method returns `0` for a node whose primitive declares none.
      */
     estimateHeight(composition: FrameComposition, dispatcher: FrameDispatcher): number;
     /**
@@ -106,7 +97,7 @@ export interface Frame<TTheme> {
      * Returned rather than thrown so a caller can decide what to do with it, but
      * note where it is *not* checked: composition validation is frame-agnostic,
      * and has to be, because the same composition can be valid in one frame and
-     * not another. Only the `svg` surface consults this, on the frame a render
+     * not another. Only the `snapshot` surface consults this, on the frame a render
      * actually names, and raises before drawing. A host that wants the answer
      * earlier asks the frame directly.
      */
@@ -136,8 +127,6 @@ export interface Frame<TTheme> {
  */
 export interface BoundFrame {
     readonly defaultWidth: number;
-    /** See {@link Frame.sizesFromNodeHeights}; defaulted at binding. */
-    readonly sizesFromNodeHeights: boolean;
     /** See {@link Frame.estimateHeight}. */
     estimateHeight(composition: FrameComposition, dispatcher: FrameDispatcher): number;
     /** See {@link Frame.validateBody}; empty when this frame states no rule. */

package/dist/define/frame.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../src/define/frame.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,+FAA+F;IAC/F,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe,CAAC,KAAK,SAAS,aAAa,GAAG,aAAa;IAC1E,oFAAoF;IACpF,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,sHAAsH;IACtH,iBAAiB,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,gGAAgG;IAChG,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CACjC;AAED,8EAA8E;AAC9E,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,wFAAwF;IACxF,IAAI,EAAE,aAAa,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;AAE7C;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,KAAK,CAAC,MAAM;IAC3B,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IACzB;;;;OAIG;IACH,cAAc,CACZ,WAAW,EAAE,gBAAgB,EAC7B,UAAU,EAAE,eAAe,GAC1B,MAAM,CAAC;IACV;;;;;;;;;;OAUG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,GAAG,SAAS,MAAM,EAAE,CAAC;IACjE;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,CACJ,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,KAC5B,SAAS,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,oEAAoE;IACpE,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IACvC,wCAAwC;IACxC,cAAc,CACZ,WAAW,EAAE,gBAAgB,EAC7B,UAAU,EAAE,eAAe,GAC1B,MAAM,CAAC;IACV,4EAA4E;IAC5E,YAAY,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,GAAG,SAAS,MAAM,EAAE,CAAC;IAChE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC;IACrD,kEAAkE;IAClE,MAAM,CACJ,WAAW,EAAE,gBAAgB,EAC7B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE,EAC1E,UAAU,EAAE,eAAe,GAC1B,SAAS,CAAC;IACb,6BAA6B;IAC7B,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,GAAG,SAAS,CAAC;CACzE;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,EAAE,OAAO,KAAK,CAAC,MAAM,CAAC,KAAG,UAuBxD,CAAC"}
+{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../src/define/frame.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,+FAA+F;IAC/F,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe,CAAC,KAAK,SAAS,aAAa,GAAG,aAAa;IAC1E,yFAAyF;IACzF,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACpD,gIAAgI;IAChI,sBAAsB,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,gGAAgG;IAChG,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CACjC;AAED,8EAA8E;AAC9E,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,wFAAwF;IACxF,IAAI,EAAE,aAAa,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;AAE7C;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,KAAK,CAAC,MAAM;IAC3B,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IACzB;;;;;OAKG;IACH,cAAc,CACZ,WAAW,EAAE,gBAAgB,EAC7B,UAAU,EAAE,eAAe,GAC1B,MAAM,CAAC;IACV;;;;;;;;;;OAUG;IACH,YAAY,CAAC,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,GAAG,SAAS,MAAM,EAAE,CAAC;IACjE;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,CACJ,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,SAAS,EACf,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,KAC5B,SAAS,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,wCAAwC;IACxC,cAAc,CACZ,WAAW,EAAE,gBAAgB,EAC7B,UAAU,EAAE,eAAe,GAC1B,MAAM,CAAC;IACV,4EAA4E;IAC5E,YAAY,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,GAAG,SAAS,MAAM,EAAE,CAAC;IAChE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC;IACrD,kEAAkE;IAClE,MAAM,CACJ,WAAW,EAAE,gBAAgB,EAC7B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE,EAC1E,UAAU,EAAE,eAAe,GAC1B,SAAS,CAAC;IACb,6BAA6B;IAC7B,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,eAAe,GAAG,SAAS,CAAC;CACzE;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,EAAE,OAAO,KAAK,CAAC,MAAM,CAAC,KAAG,UAuBxD,CAAC"}

package/dist/define/frame.js

@@ -13,16 +13,15 @@ export const bindFrame = (frame) => {
     const themeFor = (mode) => mode === 'dark' ? frame.theme.dark : frame.theme.light;
     return {
         defaultWidth: frame.defaultWidth,
-        sizesFromNodeHeights: frame.sizesFromNodeHeights ?? true,
         estimateHeight: (composition, dispatcher) => frame.estimateHeight(composition, dispatcher),
         validateBody: (body) => frame.validateBody?.(body) ?? [],
         resolveTheme: (mode) => themeFor(mode),
         render: (composition, viewport, dispatcher) => {
             const theme = themeFor(viewport.mode);
             const { title, subtitle, theme: mode } = composition;
-            return frame.wrap({ title, subtitle, theme: mode }, composition.body.map((node, index) => dispatcher.renderSvg(node, `body-${index}`)), { ...viewport, theme });
+            return frame.wrap({ title, subtitle, theme: mode }, composition.body.map((node, index) => dispatcher.renderSnapshot(node, `body-${index}`)), { ...viewport, theme });
         },
-        renderNode: (node, dispatcher) => dispatcher.renderSvg(node, node.type),
+        renderNode: (node, dispatcher) => dispatcher.renderSnapshot(node, node.type),
     };
 };
 //# sourceMappingURL=frame.js.map

package/dist/define/frame.js.map

@@ -1 +1 @@
-{"version":3,"file":"frame.js","sourceRoot":"","sources":["../../src/define/frame.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAyLH;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAS,KAAoB,EAAc,EAAE;IACpE,MAAM,QAAQ,GAAG,CAAC,IAA6B,EAAU,EAAE,CACzD,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;IACzD,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,IAAI,IAAI;QACxD,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,CAC1C,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC;QAC/C,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE;QACxD,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YACrD,OAAO,KAAK,CAAC,IAAI,CACf,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAChC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,EAAE,CAAC,CAC5C,EACD,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,CACvB,CAAC;QACJ,CAAC;QACD,UAAU,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,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\n// The frame an `svg` render is drawn inside, and the geometry that sizes it.\n// Frame is a runtime input, not a pack asset: vocabulary is additive, the\n// document is exclusive.\n\nimport type { ReactNode } from 'react';\n\nimport type { RenderTheme } from '../composition/named_color';\nimport type { PrimitiveNode } from '../composition/node';\n\n/**\n * A frame's palette, per mode. An image has no media queries, so it must\n * commit to one; `auto` resolves light.\n */\nexport interface ThemePair<TTheme> {\n  light: TTheme;\n  dark: TTheme;\n}\n\n/**\n * Geometry and resolved theme a frame draws within.\n *\n * Named for the viewport rather than the frame because {@link Frame.wrap}\n * draws *a* frame within it; the two would otherwise read as the same thing.\n */\nexport interface FrameViewport<TTheme> {\n  width: number;\n  height: number;\n  /** Resolved from {@link Frame.theme} for `mode`. */\n  theme: TTheme;\n  /** What the caller asked for, before resolution. `undefined` and `auto` both resolve light. */\n  mode: RenderTheme | undefined;\n}\n\n/**\n * The two dispatcher methods a frame needs.\n *\n * The render context the nodes are drawn with is bound by the caller rather\n * than passed here: it carries the class-name resolution that pairs with the\n * stylesheet emitted alongside the frame's output, which is the surface's\n * concern and not the document's. Generic in `TNode` so a helper can be\n * written against a narrowed node union while the runtime holds the erased form.\n */\nexport interface FrameDispatcher<TNode extends PrimitiveNode = PrimitiveNode> {\n  /** Draws one node on the `svg` surface. `key` must be unique among its siblings. */\n  renderSvg(node: TNode, key: string): ReactNode;\n  /** The node's height in pixels; `0` when it is hidden from `svg` or its primitive declares no `metrics.svgHeight`. */\n  estimateSvgHeight(node: TNode): number;\n}\n\n/**\n * What {@link Frame.wrap} is told about the composition it draws around.\n *\n * The body is withheld, and {@link bindFrame} copies only these fields into a\n * fresh value, so the surround cannot branch on a pack's node types.\n */\nexport interface FrameHeader {\n  title?: string | undefined;\n  subtitle?: string | undefined;\n  /** The caller's preference, not a resolved palette. Use {@link FrameViewport.theme} to draw. */\n  theme?: RenderTheme | undefined;\n}\n\n/** {@link FrameHeader} plus the body, for the sizing and validation hooks. */\nexport interface FrameComposition extends FrameHeader {\n  /** Raw nodes, for measuring and checking only. {@link FrameBody} is what gets drawn. */\n  body: PrimitiveNode[];\n}\n\n/**\n * Body nodes already rendered to elements, ready to be surrounded.\n *\n * Distinct from `Composition.body`, which is the raw {@link PrimitiveNode}\n * array a frame never sees.\n */\nexport type FrameBody = readonly ReactNode[];\n\n/**\n * A document an `svg` render can produce: its geometry, the surround it draws\n * around the body, and whatever it requires of a composition it is asked to\n * draw.\n *\n * A host registers frames with the runtime and picks one per render. That is\n * what lets one runtime serve a 760px card, a 1920x1080 slide, and a\n * host-branded variant of either from the same vocabulary — and what keeps a\n * vocabulary pack additive, since nothing about a primitive decides the frame.\n * A frame is named by the key a host registers it under, not by a field it\n * carries.\n */\nexport interface Frame<TTheme> {\n  /** Width used when the caller passes none. */\n  defaultWidth: number;\n  /**\n   * Whether {@link Frame.estimateHeight} sums per-node heights, and so\n   * under-sizes the frame for a node whose primitive declares no\n   * `metrics.svgHeight` — `dispatcher.estimateSvgHeight` returns `0` for those.\n   *\n   * Defaults to `true`, because the gap is silent and a frame that measures\n   * nodes is the normal case. A fixed-size frame sets `false` once and stops\n   * the missing `svgHeight` warning reporting a metric nothing reads.\n   */\n  sizesFromNodeHeights?: boolean;\n  /**\n   * Palette per mode. Frame and palette vary independently — a branded card is\n   * this geometry with a host's colors — so a host overrides one by spreading\n   * this value rather than rebuilding anything.\n   */\n  theme: ThemePair<TTheme>;\n  /**\n   * Height for this body when the caller passes none, in the geometry this\n   * document defines. See {@link Frame.sizesFromNodeHeights} for what it may\n   * assume of the nodes.\n   */\n  estimateHeight(\n    composition: FrameComposition,\n    dispatcher: FrameDispatcher\n  ): number;\n  /**\n   * What this document requires of a body. A slide document's\n   * exactly-one-`slideFrame` rule is the example.\n   *\n   * Returned rather than thrown so a caller can decide what to do with it, but\n   * note where it is *not* checked: composition validation is frame-agnostic,\n   * and has to be, because the same composition can be valid in one frame and\n   * not another. Only the `svg` surface consults this, on the frame a render\n   * actually names, and raises before drawing. A host that wants the answer\n   * earlier asks the frame directly.\n   */\n  validateBody?(body: readonly PrimitiveNode[]): readonly string[];\n  /**\n   * Draws the surround around the already-rendered body nodes, including a\n   * title header if this document wants one.\n   *\n   * Takes the nodes as an array rather than a single `ReactNode` so a frame\n   * that draws no surround can return its one root element — image layout\n   * starts from a single element, and an array or a fragment is not one.\n   *\n   * Declared property-style, so it is checked contravariantly in `TTheme` under\n   * `strictFunctionTypes`. A method signature is bivariant, which would admit a\n   * frame needing a richer theme into a slot typed for a narrower one, where it\n   * would read a token nothing supplies.\n   */\n  wrap: (\n    header: FrameHeader,\n    body: FrameBody,\n    viewport: FrameViewport<TTheme>\n  ) => ReactNode;\n}\n\n/**\n * A {@link Frame} as the runtime stores it, with its theme resolved away.\n *\n * The erasure is a closure rather than a type parameter because the runtime\n * dispatches nodes through one inventory keyed by node type, which has no\n * single theme to name. A runtime's frames are homogeneous in `TTheme`, so the\n * palette is known where it is resolved and only the resolved result is stored.\n */\nexport interface BoundFrame {\n  readonly defaultWidth: number;\n  /** See {@link Frame.sizesFromNodeHeights}; defaulted at binding. */\n  readonly sizesFromNodeHeights: boolean;\n  /** See {@link Frame.estimateHeight}. */\n  estimateHeight(\n    composition: FrameComposition,\n    dispatcher: FrameDispatcher\n  ): number;\n  /** See {@link Frame.validateBody}; empty when this frame states no rule. */\n  validateBody(body: readonly PrimitiveNode[]): readonly string[];\n  /**\n   * Resolves {@link Frame.theme} for `mode`, erased to `unknown` like the rest\n   * of this type. Lets a caller hand the palette to a primitive's `env.theme`\n   * without itself knowing `TTheme`.\n   */\n  resolveTheme(mode: RenderTheme | undefined): unknown;\n  /** Renders the body and its surround at `viewport`'s geometry. */\n  render(\n    composition: FrameComposition,\n    viewport: { width: number; height: number; mode: RenderTheme | undefined },\n    dispatcher: FrameDispatcher\n  ): ReactNode;\n  /** One node, no surround. */\n  renderNode(node: PrimitiveNode, dispatcher: FrameDispatcher): ReactNode;\n}\n\n/**\n * Erases a {@link Frame}'s `TTheme` into a {@link BoundFrame}, resolving the\n * palette per render and composing the generic body walk with the frame's own\n * surround.\n */\nexport const bindFrame = <TTheme>(frame: Frame<TTheme>): BoundFrame => {\n  const themeFor = (mode: RenderTheme | undefined): TTheme =>\n    mode === 'dark' ? frame.theme.dark : frame.theme.light;\n  return {\n    defaultWidth: frame.defaultWidth,\n    sizesFromNodeHeights: frame.sizesFromNodeHeights ?? true,\n    estimateHeight: (composition, dispatcher) =>\n      frame.estimateHeight(composition, dispatcher),\n    validateBody: (body) => frame.validateBody?.(body) ?? [],\n    resolveTheme: (mode) => themeFor(mode),\n    render: (composition, viewport, dispatcher) => {\n      const theme = themeFor(viewport.mode);\n      const { title, subtitle, theme: mode } = composition;\n      return frame.wrap(\n        { title, subtitle, theme: mode },\n        composition.body.map((node, index) =>\n          dispatcher.renderSvg(node, `body-${index}`)\n        ),\n        { ...viewport, theme }\n      );\n    },\n    renderNode: (node, dispatcher) => dispatcher.renderSvg(node, node.type),\n  };\n};\n"]}
+{"version":3,"file":"frame.js","sourceRoot":"","sources":["../../src/define/frame.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA8KH;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAS,KAAoB,EAAc,EAAE;IACpE,MAAM,QAAQ,GAAG,CAAC,IAA6B,EAAU,EAAE,CACzD,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;IACzD,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,cAAc,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,EAAE,CAC1C,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC;QAC/C,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE;QACxD,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE;YAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YACrD,OAAO,KAAK,CAAC,IAAI,CACf,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAChC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,KAAK,EAAE,CAAC,CACjD,EACD,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,CACvB,CAAC;QACJ,CAAC;QACD,UAAU,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,CAC/B,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;KAC7C,CAAC;AACJ,CAAC,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\n// The frame a `snapshot` render is drawn inside, and the geometry that sizes it.\n// Frame is a runtime input, not a pack asset: vocabulary is additive, the\n// document is exclusive.\n\nimport type { ReactNode } from 'react';\n\nimport type { RenderTheme } from '../composition/named_color';\nimport type { PrimitiveNode } from '../composition/node';\n\n/**\n * A frame's palette, per mode. An image has no media queries, so it must\n * commit to one; `auto` resolves light.\n */\nexport interface ThemePair<TTheme> {\n  light: TTheme;\n  dark: TTheme;\n}\n\n/**\n * Geometry and resolved theme a frame draws within.\n *\n * Named for the viewport rather than the frame because {@link Frame.wrap}\n * draws *a* frame within it; the two would otherwise read as the same thing.\n */\nexport interface FrameViewport<TTheme> {\n  width: number;\n  height: number;\n  /** Resolved from {@link Frame.theme} for `mode`. */\n  theme: TTheme;\n  /** What the caller asked for, before resolution. `undefined` and `auto` both resolve light. */\n  mode: RenderTheme | undefined;\n}\n\n/**\n * The two dispatcher methods a frame needs.\n *\n * The render context the nodes are drawn with is bound by the caller rather\n * than passed here: it carries the class-name resolution that pairs with the\n * stylesheet emitted alongside the frame's output, which is the surface's\n * concern and not the document's. Generic in `TNode` so a helper can be\n * written against a narrowed node union while the runtime holds the erased form.\n */\nexport interface FrameDispatcher<TNode extends PrimitiveNode = PrimitiveNode> {\n  /** Draws one node on the `snapshot` surface. `key` must be unique among its siblings. */\n  renderSnapshot(node: TNode, key: string): ReactNode;\n  /** The node's height in pixels; `0` when it is hidden from `snapshot` or its primitive declares no `metrics.snapshotHeight`. */\n  estimateSnapshotHeight(node: TNode): number;\n}\n\n/**\n * What {@link Frame.wrap} is told about the composition it draws around.\n *\n * The body is withheld, and {@link bindFrame} copies only these fields into a\n * fresh value, so the surround cannot branch on a pack's node types.\n */\nexport interface FrameHeader {\n  title?: string | undefined;\n  subtitle?: string | undefined;\n  /** The caller's preference, not a resolved palette. Use {@link FrameViewport.theme} to draw. */\n  theme?: RenderTheme | undefined;\n}\n\n/** {@link FrameHeader} plus the body, for the sizing and validation hooks. */\nexport interface FrameComposition extends FrameHeader {\n  /** Raw nodes, for measuring and checking only. {@link FrameBody} is what gets drawn. */\n  body: PrimitiveNode[];\n}\n\n/**\n * Body nodes already rendered to elements, ready to be surrounded.\n *\n * Distinct from `Composition.body`, which is the raw {@link PrimitiveNode}\n * array a frame never sees.\n */\nexport type FrameBody = readonly ReactNode[];\n\n/**\n * A document a `snapshot` render can produce: its geometry, the surround it draws\n * around the body, and whatever it requires of a composition it is asked to\n * draw.\n *\n * A host registers frames with the runtime and picks one per render. That is\n * what lets one runtime serve a 760px card, a 1920x1080 slide, and a\n * host-branded variant of either from the same vocabulary — and what keeps a\n * vocabulary pack additive, since nothing about a primitive decides the frame.\n * A frame is named by the key a host registers it under, not by a field it\n * carries.\n */\nexport interface Frame<TTheme> {\n  /** Width used when the caller passes none. */\n  defaultWidth: number;\n  /**\n   * Palette per mode. Frame and palette vary independently — a branded card is\n   * this geometry with a host's colors — so a host overrides one by spreading\n   * this value rather than rebuilding anything.\n   */\n  theme: ThemePair<TTheme>;\n  /**\n   * Height for this body when the caller passes none, in the geometry this\n   * document defines. Calling {@link FrameDispatcher.estimateSnapshotHeight} is\n   * what makes a missing `metrics.snapshotHeight` size the frame short: that\n   * method returns `0` for a node whose primitive declares none.\n   */\n  estimateHeight(\n    composition: FrameComposition,\n    dispatcher: FrameDispatcher\n  ): number;\n  /**\n   * What this document requires of a body. A slide document's\n   * exactly-one-`slideFrame` rule is the example.\n   *\n   * Returned rather than thrown so a caller can decide what to do with it, but\n   * note where it is *not* checked: composition validation is frame-agnostic,\n   * and has to be, because the same composition can be valid in one frame and\n   * not another. Only the `snapshot` surface consults this, on the frame a render\n   * actually names, and raises before drawing. A host that wants the answer\n   * earlier asks the frame directly.\n   */\n  validateBody?(body: readonly PrimitiveNode[]): readonly string[];\n  /**\n   * Draws the surround around the already-rendered body nodes, including a\n   * title header if this document wants one.\n   *\n   * Takes the nodes as an array rather than a single `ReactNode` so a frame\n   * that draws no surround can return its one root element — image layout\n   * starts from a single element, and an array or a fragment is not one.\n   *\n   * Declared property-style, so it is checked contravariantly in `TTheme` under\n   * `strictFunctionTypes`. A method signature is bivariant, which would admit a\n   * frame needing a richer theme into a slot typed for a narrower one, where it\n   * would read a token nothing supplies.\n   */\n  wrap: (\n    header: FrameHeader,\n    body: FrameBody,\n    viewport: FrameViewport<TTheme>\n  ) => ReactNode;\n}\n\n/**\n * A {@link Frame} as the runtime stores it, with its theme resolved away.\n *\n * The erasure is a closure rather than a type parameter because the runtime\n * dispatches nodes through one inventory keyed by node type, which has no\n * single theme to name. A runtime's frames are homogeneous in `TTheme`, so the\n * palette is known where it is resolved and only the resolved result is stored.\n */\nexport interface BoundFrame {\n  readonly defaultWidth: number;\n  /** See {@link Frame.estimateHeight}. */\n  estimateHeight(\n    composition: FrameComposition,\n    dispatcher: FrameDispatcher\n  ): number;\n  /** See {@link Frame.validateBody}; empty when this frame states no rule. */\n  validateBody(body: readonly PrimitiveNode[]): readonly string[];\n  /**\n   * Resolves {@link Frame.theme} for `mode`, erased to `unknown` like the rest\n   * of this type. Lets a caller hand the palette to a primitive's `env.theme`\n   * without itself knowing `TTheme`.\n   */\n  resolveTheme(mode: RenderTheme | undefined): unknown;\n  /** Renders the body and its surround at `viewport`'s geometry. */\n  render(\n    composition: FrameComposition,\n    viewport: { width: number; height: number; mode: RenderTheme | undefined },\n    dispatcher: FrameDispatcher\n  ): ReactNode;\n  /** One node, no surround. */\n  renderNode(node: PrimitiveNode, dispatcher: FrameDispatcher): ReactNode;\n}\n\n/**\n * Erases a {@link Frame}'s `TTheme` into a {@link BoundFrame}, resolving the\n * palette per render and composing the generic body walk with the frame's own\n * surround.\n */\nexport const bindFrame = <TTheme>(frame: Frame<TTheme>): BoundFrame => {\n  const themeFor = (mode: RenderTheme | undefined): TTheme =>\n    mode === 'dark' ? frame.theme.dark : frame.theme.light;\n  return {\n    defaultWidth: frame.defaultWidth,\n    estimateHeight: (composition, dispatcher) =>\n      frame.estimateHeight(composition, dispatcher),\n    validateBody: (body) => frame.validateBody?.(body) ?? [],\n    resolveTheme: (mode) => themeFor(mode),\n    render: (composition, viewport, dispatcher) => {\n      const theme = themeFor(viewport.mode);\n      const { title, subtitle, theme: mode } = composition;\n      return frame.wrap(\n        { title, subtitle, theme: mode },\n        composition.body.map((node, index) =>\n          dispatcher.renderSnapshot(node, `body-${index}`)\n        ),\n        { ...viewport, theme }\n      );\n    },\n    renderNode: (node, dispatcher) =>\n      dispatcher.renderSnapshot(node, node.type),\n  };\n};\n"]}

package/dist/define/index.d.ts

@@ -1,6 +1,8 @@
 export { type BoundFrame, type Frame, type FrameBody, type FrameComposition, type FrameDispatcher, type FrameHeader, type FrameViewport, type ThemePair, bindFrame, } from './frame.js';
 export { type MarkdownBlock, type MarkdownContent, type MarkdownInline, type MarkdownInlineInput, } from './markdown_content.js';
-export { type AnyPrimitiveDefinition, type DefaultPackTypes, type OptionalSurface, type PackTypes, type PrimitiveCatalogEntry, type PrimitiveChildRef, type PrimitiveDefinition, type PrimitiveMetrics, type PrimitiveNode, type PrimitiveRenderContext, type PrimitiveSchema, type PrimitiveStyleCollectionContext, type PrimitiveStyleCollector, type ReactContextArg, type Renderer, type Renderers, type RenderScope, type StyledRenderContext, type StyleHandle, type SurfaceMap, type ThemeTokenPath, type WithNodeFields, bodyNodeIdSchema, bodyNodeSurfacesSchema, definePrimitive, definePrimitiveFor, unresolvedBodyNodeSchema, validateWithSchema, } from './primitive_module.js';
+export { type ExampleNode, type NormalizedPrimitiveExample, type PrimitiveExample, exampleNodes, primitiveExamples, } from './primitive_example.js';
+export { type PrimitiveIcon, ICON_VARS } from './primitive_icon.js';
+export { type AnyPrimitiveDefinition, type DefaultPackTypes, type OptionalSurface, type PackTypes, type PrimitiveCatalogEntry, type PrimitiveChildRef, type PrimitiveDefinition, type PrimitiveMetrics, type PrimitiveNode, type PrimitiveRenderContext, type PrimitiveSchema, type PrimitiveStyleCollectionContext, type PrimitiveStyleCollector, type ReactContextArg, type Renderer, type Renderers, type RenderScope, type StyledRenderContext, type StyleHandle, type SurfaceMap, type ThemeTokenPath, type WithNodeFields, OPTIONAL_SURFACES, bodyNodeIdSchema, bodyNodeSurfacesSchema, definePrimitive, definePrimitiveFor, unresolvedBodyNodeSchema, validateWithSchema, } from './primitive_module.js';
 export { type SlackAssetCollector, type SlackAssetRequest, } from './slack_assets.js';
 export { type SlackActionElement, type SlackActionsBlock, type SlackBlock, type SlackButtonElement, type SlackCheckboxesElement, type SlackContextBlock, type SlackDividerBlock, type SlackFileReference, type SlackHeaderBlock, type SlackHeaderLevel, type SlackImageBlock, type SlackImageElement, type SlackMrkdwnTextObject, type SlackMultiStaticSelectElement, type SlackOptionGroup, type SlackOptionObject, type SlackOverflowElement, type SlackPlainTextObject, type SlackRadioButtonsElement, type SlackRawTextElement, type SlackRichTextBlock, type SlackRichTextBlockElement, type SlackRichTextInline, type SlackRichTextLink, type SlackRichTextList, type SlackRichTextPreformatted, type SlackRichTextQuote, type SlackRichTextSection, type SlackRichTextStyle, type SlackRichTextTag, type SlackRichTextText, type SlackSectionAccessory, type SlackSectionBlock, type SlackStaticSelectElement, type SlackTableBlock, type SlackTableCell, type SlackTableColumnSetting, type SlackTagColor, type SlackTextObject, type SlackVideoBlock, } from './slack_blocks.js';
 export { declaredFieldsNote, formatZodIssues } from './zod_format.js';

package/dist/define/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/define/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAClC,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,eAAe,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/define/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,0BAA0B,EAC/B,KAAK,gBAAgB,EACrB,YAAY,EACZ,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAClC,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,eAAe,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC"}

package/dist/define/index.js

@@ -5,7 +5,9 @@
  * 2.0.
  */
 export { bindFrame, } from './frame.js';
-export { bodyNodeIdSchema, bodyNodeSurfacesSchema, definePrimitive, definePrimitiveFor, unresolvedBodyNodeSchema, validateWithSchema, } from './primitive_module.js';
+export { exampleNodes, primitiveExamples, } from './primitive_example.js';
+export { ICON_VARS } from './primitive_icon.js';
+export { OPTIONAL_SURFACES, bodyNodeIdSchema, bodyNodeSurfacesSchema, definePrimitive, definePrimitiveFor, unresolvedBodyNodeSchema, validateWithSchema, } from './primitive_module.js';
 export { declaredFieldsNote, formatZodIssues } from './zod_format.js';
 export { requiredString, z } from './zod_helpers.js';
 //# sourceMappingURL=index.js.map

package/dist/define/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/define/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EASL,SAAS,GACV,MAAM,SAAS,CAAC;AAOjB,OAAO,EAuBL,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AA+C5B,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE,MAAM,eAAe,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 {\n  type BoundFrame,\n  type Frame,\n  type FrameBody,\n  type FrameComposition,\n  type FrameDispatcher,\n  type FrameHeader,\n  type FrameViewport,\n  type ThemePair,\n  bindFrame,\n} from './frame';\nexport {\n  type MarkdownBlock,\n  type MarkdownContent,\n  type MarkdownInline,\n  type MarkdownInlineInput,\n} from './markdown_content';\nexport {\n  type AnyPrimitiveDefinition,\n  type DefaultPackTypes,\n  type OptionalSurface,\n  type PackTypes,\n  type PrimitiveCatalogEntry,\n  type PrimitiveChildRef,\n  type PrimitiveDefinition,\n  type PrimitiveMetrics,\n  type PrimitiveNode,\n  type PrimitiveRenderContext,\n  type PrimitiveSchema,\n  type PrimitiveStyleCollectionContext,\n  type PrimitiveStyleCollector,\n  type ReactContextArg,\n  type Renderer,\n  type Renderers,\n  type RenderScope,\n  type StyledRenderContext,\n  type StyleHandle,\n  type SurfaceMap,\n  type ThemeTokenPath,\n  type WithNodeFields,\n  bodyNodeIdSchema,\n  bodyNodeSurfacesSchema,\n  definePrimitive,\n  definePrimitiveFor,\n  unresolvedBodyNodeSchema,\n  validateWithSchema,\n} from './primitive_module';\nexport {\n  type SlackAssetCollector,\n  type SlackAssetRequest,\n} from './slack_assets';\nexport {\n  type SlackActionElement,\n  type SlackActionsBlock,\n  type SlackBlock,\n  type SlackButtonElement,\n  type SlackCheckboxesElement,\n  type SlackContextBlock,\n  type SlackDividerBlock,\n  type SlackFileReference,\n  type SlackHeaderBlock,\n  type SlackHeaderLevel,\n  type SlackImageBlock,\n  type SlackImageElement,\n  type SlackMrkdwnTextObject,\n  type SlackMultiStaticSelectElement,\n  type SlackOptionGroup,\n  type SlackOptionObject,\n  type SlackOverflowElement,\n  type SlackPlainTextObject,\n  type SlackRadioButtonsElement,\n  type SlackRawTextElement,\n  type SlackRichTextBlock,\n  type SlackRichTextBlockElement,\n  type SlackRichTextInline,\n  type SlackRichTextLink,\n  type SlackRichTextList,\n  type SlackRichTextPreformatted,\n  type SlackRichTextQuote,\n  type SlackRichTextSection,\n  type SlackRichTextStyle,\n  type SlackRichTextTag,\n  type SlackRichTextText,\n  type SlackSectionAccessory,\n  type SlackSectionBlock,\n  type SlackStaticSelectElement,\n  type SlackTableBlock,\n  type SlackTableCell,\n  type SlackTableColumnSetting,\n  type SlackTagColor,\n  type SlackTextObject,\n  type SlackVideoBlock,\n} from './slack_blocks';\nexport { declaredFieldsNote, formatZodIssues } from './zod_format';\nexport { requiredString, z } from './zod_helpers';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/define/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EASL,SAAS,GACV,MAAM,SAAS,CAAC;AAOjB,OAAO,EAIL,YAAY,EACZ,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAsB,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAuBL,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AA+C5B,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE,MAAM,eAAe,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 {\n  type BoundFrame,\n  type Frame,\n  type FrameBody,\n  type FrameComposition,\n  type FrameDispatcher,\n  type FrameHeader,\n  type FrameViewport,\n  type ThemePair,\n  bindFrame,\n} from './frame';\nexport {\n  type MarkdownBlock,\n  type MarkdownContent,\n  type MarkdownInline,\n  type MarkdownInlineInput,\n} from './markdown_content';\nexport {\n  type ExampleNode,\n  type NormalizedPrimitiveExample,\n  type PrimitiveExample,\n  exampleNodes,\n  primitiveExamples,\n} from './primitive_example';\nexport { type PrimitiveIcon, ICON_VARS } from './primitive_icon';\nexport {\n  type AnyPrimitiveDefinition,\n  type DefaultPackTypes,\n  type OptionalSurface,\n  type PackTypes,\n  type PrimitiveCatalogEntry,\n  type PrimitiveChildRef,\n  type PrimitiveDefinition,\n  type PrimitiveMetrics,\n  type PrimitiveNode,\n  type PrimitiveRenderContext,\n  type PrimitiveSchema,\n  type PrimitiveStyleCollectionContext,\n  type PrimitiveStyleCollector,\n  type ReactContextArg,\n  type Renderer,\n  type Renderers,\n  type RenderScope,\n  type StyledRenderContext,\n  type StyleHandle,\n  type SurfaceMap,\n  type ThemeTokenPath,\n  type WithNodeFields,\n  OPTIONAL_SURFACES,\n  bodyNodeIdSchema,\n  bodyNodeSurfacesSchema,\n  definePrimitive,\n  definePrimitiveFor,\n  unresolvedBodyNodeSchema,\n  validateWithSchema,\n} from './primitive_module';\nexport {\n  type SlackAssetCollector,\n  type SlackAssetRequest,\n} from './slack_assets';\nexport {\n  type SlackActionElement,\n  type SlackActionsBlock,\n  type SlackBlock,\n  type SlackButtonElement,\n  type SlackCheckboxesElement,\n  type SlackContextBlock,\n  type SlackDividerBlock,\n  type SlackFileReference,\n  type SlackHeaderBlock,\n  type SlackHeaderLevel,\n  type SlackImageBlock,\n  type SlackImageElement,\n  type SlackMrkdwnTextObject,\n  type SlackMultiStaticSelectElement,\n  type SlackOptionGroup,\n  type SlackOptionObject,\n  type SlackOverflowElement,\n  type SlackPlainTextObject,\n  type SlackRadioButtonsElement,\n  type SlackRawTextElement,\n  type SlackRichTextBlock,\n  type SlackRichTextBlockElement,\n  type SlackRichTextInline,\n  type SlackRichTextLink,\n  type SlackRichTextList,\n  type SlackRichTextPreformatted,\n  type SlackRichTextQuote,\n  type SlackRichTextSection,\n  type SlackRichTextStyle,\n  type SlackRichTextTag,\n  type SlackRichTextText,\n  type SlackSectionAccessory,\n  type SlackSectionBlock,\n  type SlackStaticSelectElement,\n  type SlackTableBlock,\n  type SlackTableCell,\n  type SlackTableColumnSetting,\n  type SlackTagColor,\n  type SlackTextObject,\n  type SlackVideoBlock,\n} from './slack_blocks';\nexport { declaredFieldsNote, formatZodIssues } from './zod_format';\nexport { requiredString, z } from './zod_helpers';\n"]}

package/dist/define/primitive_example.d.ts

@@ -0,0 +1,30 @@
+import type { PrimitiveNode } from '../composition/node.js';
+/** A published example with a name hosts can list it by. */
+export interface PrimitiveExample<TNode extends PrimitiveNode = PrimitiveNode> {
+    /** Short and unique within the primitive, such as `Warning tone`. */
+    name: string;
+    /** What the example demonstrates. */
+    description?: string;
+    node: TNode;
+    /** Never set: an entry is a bare node exactly when it has a `type`. */
+    type?: never;
+}
+/** An entry of `examples` read as one shape; `name` is absent for a bare node. */
+export interface NormalizedPrimitiveExample<TNode extends PrimitiveNode = PrimitiveNode> {
+    name?: string;
+    description?: string;
+    node: TNode;
+}
+/** The node type an `examples` entry holds. */
+export type ExampleNode<TEntry> = TEntry extends PrimitiveExample<infer TNode> ? TNode : TEntry;
+interface WithExamples {
+    readonly examples: readonly (PrimitiveNode | PrimitiveExample)[];
+}
+/** Distributes over a union of definitions, so a mixed registry keeps every node type. */
+type NodeOf<TDefinition extends WithExamples> = ExampleNode<TDefinition['examples'][number]>;
+/** A definition's examples, bare or named, as {@link NormalizedPrimitiveExample}s. */
+export declare const primitiveExamples: <TDefinition extends WithExamples>({ examples, }: TDefinition) => NormalizedPrimitiveExample<NodeOf<TDefinition>>[];
+/** A definition's example nodes, without names. */
+export declare const exampleNodes: <TDefinition extends WithExamples>({ examples, }: TDefinition) => NodeOf<TDefinition>[];
+export {};
+//# sourceMappingURL=primitive_example.d.ts.map

package/dist/define/primitive_example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"primitive_example.d.ts","sourceRoot":"","sources":["../../src/define/primitive_example.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB,CAAC,KAAK,SAAS,aAAa,GAAG,aAAa;IAC3E,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,KAAK,CAAC;IACZ,uEAAuE;IACvE,IAAI,CAAC,EAAE,KAAK,CAAC;CACd;AAED,kFAAkF;AAClF,MAAM,WAAW,0BAA0B,CACzC,KAAK,SAAS,aAAa,GAAG,aAAa;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,KAAK,CAAC;CACb;AAED,+CAA+C;AAC/C,MAAM,MAAM,WAAW,CAAC,MAAM,IAC5B,MAAM,SAAS,gBAAgB,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhE,UAAU,YAAY;IACpB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAC;CAClE;AAED,0FAA0F;AAC1F,KAAK,MAAM,CAAC,WAAW,SAAS,YAAY,IAAI,WAAW,CACzD,WAAW,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAChC,CAAC;AAkBF,sFAAsF;AACtF,eAAO,MAAM,iBAAiB,GAAI,WAAW,SAAS,YAAY,EAAE,eAEjE,WAAW,KAAG,0BAA0B,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EACc,CAAC;AAE/E,mDAAmD;AACnD,eAAO,MAAM,YAAY,GAAI,WAAW,SAAS,YAAY,EAAE,eAE5D,WAAW,KAAG,MAAM,CAAC,WAAW,CAAC,EACqC,CAAC"}