@bettercms-ai/types 1.50.0 → 1.50.2

package/dist/index.d.ts

@@ -54,6 +54,11 @@ interface NumberFieldFormat {
     decimal?: "." | ",";
     /** Fraction digits always shown (`2` for `£3.20`). A value with more keeps its own, up to six. */
     decimals?: number;
+    /**
+     * How the integer digits are grouped: `"3"` (absent) in threes, `"3;2"` the Indian way, the last
+     * three then pairs (`₹1,20,000`). Only meaningful with a `group` mark.
+     */
+    grouping?: "3" | "3;2";
 }
 /** The format a stored `config.format` holds, with anything malformed dropped: a bad row never throws at publish. */
 declare function readNumberFormat(raw: unknown): NumberFieldFormat;
@@ -431,6 +436,11 @@ interface ContentModelField {
      * translation write that changes one is 409 `FIELD_NOT_LOCALIZED`. None marked: rows copy as before.
      */
     localized?: boolean;
+    /**
+     * Schema V2 archive: the field is out of the entry form and the delivery API. Its key and
+     * stored values stay, so `false` restores it with nothing lost.
+     */
+    archived?: boolean;
     /**
      * Authoring chrome — how the field PRESENTS in the editor. Never delivered, never read by a
      * renderer, and never able to move a value; the same contract as {@link placement}.
@@ -513,6 +523,11 @@ interface ContentModelFieldUi {
     };
     /** V2 `valueShape`: a link / image / button writes a plain string or the object. */
     valueShape?: "string" | "object";
+    /** A live reference to a vendor item (custom integrations): the integration's slug and reference key. */
+    reference?: {
+        integration: string;
+        key: string;
+    };
     /** V2 field access (D58): who sees and who changes it. The editor gates; the backend stores. */
     access?: {
         view?: "schema.view";
@@ -587,6 +602,61 @@ interface Page {
     } | null;
 }
 
+/**
+ * A page BODY's own allow-list: which components a page accepts as sections (`pages.body_schema`,
+ * migration 0494). "A page accepts only the components built for that page."
+ *
+ * A third axis beside a zone's `allowedSections` and a component's `allowedOn`, judged by the same
+ * resolver (`resolveInsertableSections`, deny reason `not-in-body-allowlist`).
+ *
+ * 🔴 THE EMPTY-ARRAY TRAP, the same as on both other lists:
+ *   body_schema NULL      = UNRESTRICTED (every page that predates 0494; today's behaviour)
+ *   `allowed: []`         = DENY-ALL — no component is accepted. Never write `[]` to mean "unset":
+ *                           unset is the column being NULL.
+ */
+/**
+ * One rule. A component is accepted when ANY rule matches it.
+ *
+ *   source     built for this page: `splitSourceKey(component.sourceKey).page === pageId`, read off the
+ *              component's CURRENT source key at judge time (never a string prefix). A component with
+ *              no source key, or one whose key names no page (a shared band, a pre-per-page key), is
+ *              not built for any page.
+ *   component  exactly this component id.
+ *   family     any component of this section family (`sectionType`, trimmed, case-insensitive) — so a
+ *              variant swap passes iff its TARGET passes.
+ *   builtins   the platform's built-in sections (`builtin:*`), and a project's copy of one.
+ *   workspace  the workspace's shared components (`project_id IS NULL`).
+ */
+type AllowRule = {
+    kind: "source";
+    pageId: string;
+} | {
+    kind: "component";
+    id: string;
+} | {
+    kind: "family";
+    sectionType: string;
+} | {
+    kind: "builtins";
+} | {
+    kind: "workspace";
+};
+/** Who wrote the list: a lane's guess (componentize), a person's confirmation of it, or a person's own. */
+type BodySchemaOrigin = "inferred" | "confirmed" | "authored";
+interface BodySchema {
+    /** `[]` = deny-all. See the file header: unset is a NULL column, never an empty list. */
+    allowed: AllowRule[];
+    origin: BodySchemaOrigin;
+}
+declare const BODY_SCHEMA_ORIGINS: readonly BodySchemaOrigin[];
+/** Pure. One stored rule as an `AllowRule`, or null for one this reader does not know (it matches nothing). */
+declare function allowRuleOf(value: unknown): AllowRule | null;
+/**
+ * Pure. A stored `body_schema` as a `BodySchema`, or null (unrestricted) when it is not one.
+ * An unknown rule is dropped, which narrows the list — never widens it.
+ */
+declare function bodySchemaOf(value: unknown): BodySchema | null;
+
 /**
  * Section spacing as TOKEN STEPS — the ONE list of names and default sizes, shared by the save
  * schema and every renderer. A stored value is always a token (`section-space-large`), never a
@@ -1327,6 +1397,12 @@ interface ComponentProps {
      * while `bind` is; dropped with it when the instance takes its copy.
      */
     bindPaths?: Record<string, string>;
+    /**
+     * Phase B: the props this INSTANCE does not own — their copy stays in the page's own field, which
+     * the page lane keeps binding — and why: `{ <propKey>: "RICHTEXT_HEADING" | "BUTTON_LOOK_UNMAPPED" }`.
+     * The dock hides these props: an override written there renders nowhere.
+     */
+    kept?: Record<string, "RICHTEXT_HEADING" | "BUTTON_LOOK_UNMAPPED">;
 }
 interface ComponentBlock {
     type: "component";
@@ -1627,7 +1703,14 @@ declare function usesHideOn(blocks: unknown): boolean;
  * Returns "" for anything it does not fully trust. Twin of `safeCssUrl` in render-page.ts.
  */
 declare function safeCssUrl(raw: unknown): string;
-/** A CSS declaration object (key → value) usable as a React `style` prop, or undefined when empty. */
+/**
+ * A CSS declaration object (key → value) usable as a React `style` prop, or undefined when empty.
+ *
+ * Surfaces (twin: `platformSectionCss` in src/lib/sites/render-page.ts): no theme and no fill set no
+ * background, so the root is transparent; a `surface`/`muted` fill reads the kit's custom properties
+ * (`--bcms-bg-surface`/`--bcms-bg-muted`), which a code-built page with no kit sets transparent;
+ * an explicit theme Light/Dark is opaque by the author's choice; text colour inherits unless set.
+ */
 declare function blockStyleToCss(style: BlockStyle | undefined): Record<string, string | number> | undefined;
 /**
  * The content column: the declarations for the INNER box a renderer nests between a block's
@@ -3645,6 +3728,15 @@ interface DerivedLocator {
         groupKey: string;
         index: number;
     };
+    /**
+     * Each ancestor's index among ITS parent's element children, in `ancestors` order.
+     *
+     * The chain and the sibling index stop at one level: two price cards in one grid each hold
+     * `<span>.00</span>` at `div>div>span`, index 1, and those two locators are one address. With
+     * the path they are two. Minted only under the field-identity grammar (@see locatorPath), and
+     * compared only where the stored side has one: a locator without it matches as it always did.
+     */
+    path?: number[];
 }
 /** The DOM surface `locatorFor` reads. `Element` satisfies it; so does a plain object. */
 interface ElementLike {
@@ -3681,6 +3773,18 @@ interface LandmarkChainElement extends ElementLike {
  */
 declare function locatorFor(el: ElementLike, region: string | null): DerivedLocator;
 declare function locatorFor(el: LandmarkChainElement, region: string | null, landmarks: boolean): DerivedLocator;
+/**
+ * `DerivedLocator.path` for an element: its ancestors' own sibling indices, over the very chain
+ * `locatorFor` walks (same stop, same order), so the two always describe one chain.
+ */
+declare function locatorPath(el: ElementLike, landmarks?: false): number[];
+declare function locatorPath(el: LandmarkChainElement, landmarks: boolean): number[];
+/**
+ * Where a RESOLVED locator keeps its element's `path`: a symbol, so a locator a resolver hands out
+ * has no `path` of its own. Used as the stored side (a pin, a test's expectation) it compares as it
+ * always did, and it serializes as it always did. `atLocator` reads it by this registry key.
+ */
+declare const LOCATOR_PATH: unique symbol;
 /** The DOM surface `landmarkRegions` reads of each element it considers. */
 interface LandmarkElement {
     tagName: string;
@@ -3761,6 +3865,18 @@ declare function regionOf<E extends {
  * "Span" and "Icon".
  */
 declare const TAG_HEADS: ReadonlySet<string>;
+/**
+ * The ROLES a structural key ends in (`hero-headline`, `pricing-plans[0].plan-name`): what a value
+ * is FOR, never which element holds it. The same closed list as the server's `ROLE_VOCABULARY`
+ * (src/lib/content/field-names.ts); this package ships alone, so the two change together.
+ */
+declare const ROLE_KEYS: ReadonlySet<string>;
+/**
+ * Is this WHOLE key a bare role — `headline`, `primary-button-href`, `link-2` — the key a value
+ * outside any band gets? Such a key names no family. Only the whole key: `features-heading` is
+ * the `features` family, and `video-h2-take-the-tour` a tag-grammar key whose family is `video`.
+ */
+declare function isRoleKey(key: string): boolean;
 /** The top-level field key a path belongs to: `hero.title` → `hero`, `faq[0].q` → `faq`. */
 declare const topFieldKeyOf: (path: string) => string;
 /**
@@ -3813,4 +3929,4 @@ type SectionPlanItem<B> = {
  */
 declare function planSections<B>(slots: readonly string[], blocks: readonly B[] | null | undefined): SectionPlanItem<B>[];
 
-export { type AlignToken, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, BREAKPOINTS, BUTTON_ACTIONS, BUTTON_FULL_WIDTH_INVALID, BUTTON_ICONS, BUTTON_ICON_NAMES, BUTTON_LOOK_KEYS, BUTTON_PLACEMENT_KEYS, BUTTON_SIZES, BUTTON_VARIANTS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type ButtonAction, type ButtonBlock, type ButtonIcon, type ButtonLinkCandidate, type ButtonLookKey, type ButtonProps, type ButtonSiteLook, type ButtonSizeName, type ButtonValue, type ButtonVariant, CODE_SLOT_PREFIX, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type ChoiceOption, type CollectionBlock, type CollectionFilter, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPreview, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, type ComponentTab, type ComponentVariantGroup, type Content, type ContentBlock, type ContentEntry, type ContentModel, type ContentModelField, type ContentModelFieldType, type ContentModelFieldUi, type ContentPageResult, type ContentResponse, type ContentWidthToken, type CornerToken, DIALOG_SELECTOR, DOCK_BUDGET, DOCK_ICON_NAMES, DOCK_ICON_NAME_SET, type DeepReadonly, type DeliveredLayout, type DeliveryComponent, type DeliveryEntry, type DeliveryEntrySeo, type DeliveryList, type DeliveryPage, type DerivedLocator, type DockBudget, type DockFieldLike, type DockFieldsetLike, type DockIconName, type DockInputRef, type DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FIELD_SIZE_ZOOM, FIELD_STYLE_KEYS, FOOTER_SECTION_ID, type FieldConfig, type FieldSize, type FieldStyle, type FieldStyleKey, type FieldStyles, type Fieldset, type FieldsetKind, type FieldsetUiBefore, type FontSizeToken, type FooterBlock, type FooterColumn, type FooterProps, type Form, type FormBlock, type FormField, type FormProps, type FormSubmission, type HeadingBlock, type HeadingProps, IMAGE_ASPECTS, IMAGE_FRAME_RADIUS, type ImageAspect, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, LINK_RELS, LINK_VALUE_TYPES, LIST_ITEMS_CAP, type LandmarkChainElement, type LandmarkElement, type LayoutComponentItem, type LayoutDataDocument, type LayoutFieldDefinition, type LayoutFieldItem, type LayoutFieldType, type LayoutScalarFieldType, type LayoutSection, type LayoutSectionIcon, type LayoutSectionItem, type LayoutStructureDocument, type LayoutZone, type LinkRel, type LinkValue, type LinkValueType, type LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, type NumberFieldFormat, type NumberScale, OPTION_DESCRIPTION_MAX, type OpenMode, PAGE_CONTENT_ANCHOR_ID, type Page, type PageLayoutOverrideDataDocument, type PageLayoutOverrideDocument, type PageLayoutOverrideState, type PageLayoutOverrideStructureDocument, type PageLayoutSectionOverride, type PageLayoutSectionStructureOverride, type PageMetaJson, type PageOnlyLayoutSection, type PageSectionPlacement, type PaginatedResult, type Perspective, type PortableTextDocument, type PortableTextNode, type PropGroup, type PropTab, RESPONSIVE_CSS, type RadiusToken, type ReadButtonValue, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SIDE_SPACE_MIN_PX, SIDE_SPACE_TOKENS, SLOT_CHILD_KEYS, SLOT_ITEMS_CAP, SLOT_MAX_ITEMS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type ScaleUnit, type SectionBlock, type SectionPlanItem, type SectionProps, type SectionSpaceToken, type ShadowToken, type ShowIf, type ShowIfRule, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SlotChild, type SlotItem, type SlotShapeOptions, type SlotShapeProblem, type SlotValue, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, TABLE_COLUMN_TYPES, TABLE_JSONLD_TYPES, TABLE_LIMITS, TABLE_RESPONSIVE, TAG_HEADS, type TabItem, type TableCell, type TableCellObject, type TableCellValue, type TableCheckOptions, type TableColumn, type TableColumnType, type TableFieldOptions, type TableFootnote, type TableGroup, type TableLink, type TableProblem, type TableRef, type TableRefResolved, type TableRow, type TableValue, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, VIDEO_TRANSCRIPT_MAX, VIDEO_VALUE_KEYS, type VariantInputMapping, type VideoBlock, type VideoProps, type VideoValue, type VisibilityWindow, type WeightToken, type WindowState, type Workspace, type ZoneField, anchorTargetRel, blockStyleToColumnCss, blockStyleToCss, blockStyleToInnerCss, buttonBlockProps, buttonFullWidthProblem, buttonIconOf, buttonIconSvg, buttonLinkPairs, buttonLookValue, buttonSiteLookOf, buttonValueOfInstance, buttonValueProblem, buttonVariantOf, candidateRole, componentInstanceAddresses, componentPropTargetKey, derivedPairs, dockBudget, dockScreens, expandBlockBindings, fieldGroupOf, fieldStyleCssText, fieldStyleToCss, formatNumber, formatPropsAttribute, getBlockType, headingPaintCss, hiddenEverywhere, hideOnAttr, imageFrameCss, inWindow, isBlock, isButtonLookValue, isChromeLandmark, isCodeButton, isLinkObject, isScriptHref, isSlotChild, isTableValue, keyWords, landmarkRegions, linkAnchorOf, linkHref, linkRefOf, linkValueProblem, locatorFor, normalizeLinkValue, normalizeTableValue, normalizeWindow, parseNumberText, parsePropsAttribute, pickFieldStyle, placementBindOf, planSections, readButtonValue, readNumberFormat, readPath, regionOf, renderTableHtml, safeCssUrl, sideFloorApplies, sideSpaceCss, slotBindOf, slotChildValues, slotItems, slotPathString, slotShapeProblems, spaceTokenCss, splitButtonStyle, tableCellText, tablePathString, tableRefCells, tableSearchText, tableToMarkdown, tableValueProblems, topFieldKeyOf, usesHideOn, videoUrlOf, videoValueProblem, visibleBlocks, visibleDeliveredLayout, visibleLayoutStructure, windowState, withButtonLookProps };
+export { type AlignToken, type AllowRule, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, BODY_SCHEMA_ORIGINS, BREAKPOINTS, BUTTON_ACTIONS, BUTTON_FULL_WIDTH_INVALID, BUTTON_ICONS, BUTTON_ICON_NAMES, BUTTON_LOOK_KEYS, BUTTON_PLACEMENT_KEYS, BUTTON_SIZES, BUTTON_VARIANTS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type BodySchema, type BodySchemaOrigin, type ButtonAction, type ButtonBlock, type ButtonIcon, type ButtonLinkCandidate, type ButtonLookKey, type ButtonProps, type ButtonSiteLook, type ButtonSizeName, type ButtonValue, type ButtonVariant, CODE_SLOT_PREFIX, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type ChoiceOption, type CollectionBlock, type CollectionFilter, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPreview, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, type ComponentTab, type ComponentVariantGroup, type Content, type ContentBlock, type ContentEntry, type ContentModel, type ContentModelField, type ContentModelFieldType, type ContentModelFieldUi, type ContentPageResult, type ContentResponse, type ContentWidthToken, type CornerToken, DIALOG_SELECTOR, DOCK_BUDGET, DOCK_ICON_NAMES, DOCK_ICON_NAME_SET, type DeepReadonly, type DeliveredLayout, type DeliveryComponent, type DeliveryEntry, type DeliveryEntrySeo, type DeliveryList, type DeliveryPage, type DerivedLocator, type DockBudget, type DockFieldLike, type DockFieldsetLike, type DockIconName, type DockInputRef, type DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FIELD_SIZE_ZOOM, FIELD_STYLE_KEYS, FOOTER_SECTION_ID, type FieldConfig, type FieldSize, type FieldStyle, type FieldStyleKey, type FieldStyles, type Fieldset, type FieldsetKind, type FieldsetUiBefore, type FontSizeToken, type FooterBlock, type FooterColumn, type FooterProps, type Form, type FormBlock, type FormField, type FormProps, type FormSubmission, type HeadingBlock, type HeadingProps, IMAGE_ASPECTS, IMAGE_FRAME_RADIUS, type ImageAspect, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, LINK_RELS, LINK_VALUE_TYPES, LIST_ITEMS_CAP, LOCATOR_PATH, type LandmarkChainElement, type LandmarkElement, type LayoutComponentItem, type LayoutDataDocument, type LayoutFieldDefinition, type LayoutFieldItem, type LayoutFieldType, type LayoutScalarFieldType, type LayoutSection, type LayoutSectionIcon, type LayoutSectionItem, type LayoutStructureDocument, type LayoutZone, type LinkRel, type LinkValue, type LinkValueType, type LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, type NumberFieldFormat, type NumberScale, OPTION_DESCRIPTION_MAX, type OpenMode, PAGE_CONTENT_ANCHOR_ID, type Page, type PageLayoutOverrideDataDocument, type PageLayoutOverrideDocument, type PageLayoutOverrideState, type PageLayoutOverrideStructureDocument, type PageLayoutSectionOverride, type PageLayoutSectionStructureOverride, type PageMetaJson, type PageOnlyLayoutSection, type PageSectionPlacement, type PaginatedResult, type Perspective, type PortableTextDocument, type PortableTextNode, type PropGroup, type PropTab, RESPONSIVE_CSS, ROLE_KEYS, type RadiusToken, type ReadButtonValue, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SIDE_SPACE_MIN_PX, SIDE_SPACE_TOKENS, SLOT_CHILD_KEYS, SLOT_ITEMS_CAP, SLOT_MAX_ITEMS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type ScaleUnit, type SectionBlock, type SectionPlanItem, type SectionProps, type SectionSpaceToken, type ShadowToken, type ShowIf, type ShowIfRule, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SlotChild, type SlotItem, type SlotShapeOptions, type SlotShapeProblem, type SlotValue, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, TABLE_COLUMN_TYPES, TABLE_JSONLD_TYPES, TABLE_LIMITS, TABLE_RESPONSIVE, TAG_HEADS, type TabItem, type TableCell, type TableCellObject, type TableCellValue, type TableCheckOptions, type TableColumn, type TableColumnType, type TableFieldOptions, type TableFootnote, type TableGroup, type TableLink, type TableProblem, type TableRef, type TableRefResolved, type TableRow, type TableValue, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, VIDEO_TRANSCRIPT_MAX, VIDEO_VALUE_KEYS, type VariantInputMapping, type VideoBlock, type VideoProps, type VideoValue, type VisibilityWindow, type WeightToken, type WindowState, type Workspace, type ZoneField, allowRuleOf, anchorTargetRel, blockStyleToColumnCss, blockStyleToCss, blockStyleToInnerCss, bodySchemaOf, buttonBlockProps, buttonFullWidthProblem, buttonIconOf, buttonIconSvg, buttonLinkPairs, buttonLookValue, buttonSiteLookOf, buttonValueOfInstance, buttonValueProblem, buttonVariantOf, candidateRole, componentInstanceAddresses, componentPropTargetKey, derivedPairs, dockBudget, dockScreens, expandBlockBindings, fieldGroupOf, fieldStyleCssText, fieldStyleToCss, formatNumber, formatPropsAttribute, getBlockType, headingPaintCss, hiddenEverywhere, hideOnAttr, imageFrameCss, inWindow, isBlock, isButtonLookValue, isChromeLandmark, isCodeButton, isLinkObject, isRoleKey, isScriptHref, isSlotChild, isTableValue, keyWords, landmarkRegions, linkAnchorOf, linkHref, linkRefOf, linkValueProblem, locatorFor, locatorPath, normalizeLinkValue, normalizeTableValue, normalizeWindow, parseNumberText, parsePropsAttribute, pickFieldStyle, placementBindOf, planSections, readButtonValue, readNumberFormat, readPath, regionOf, renderTableHtml, safeCssUrl, sideFloorApplies, sideSpaceCss, slotBindOf, slotChildValues, slotItems, slotPathString, slotShapeProblems, spaceTokenCss, splitButtonStyle, tableCellText, tablePathString, tableRefCells, tableSearchText, tableToMarkdown, tableValueProblems, topFieldKeyOf, usesHideOn, videoUrlOf, videoValueProblem, visibleBlocks, visibleDeliveredLayout, visibleLayoutStructure, windowState, withButtonLookProps };

package/dist/index.js

@@ -1,3 +1,30 @@
+// src/body-schema.ts
+var BODY_SCHEMA_ORIGINS = ["inferred", "confirmed", "authored"];
+var isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+var nonEmpty = (v) => typeof v === "string" && v.length > 0;
+function allowRuleOf(value) {
+  if (!isRecord(value)) return null;
+  switch (value.kind) {
+    case "source":
+      return nonEmpty(value.pageId) ? { kind: "source", pageId: value.pageId } : null;
+    case "component":
+      return nonEmpty(value.id) ? { kind: "component", id: value.id } : null;
+    case "family":
+      return nonEmpty(value.sectionType) ? { kind: "family", sectionType: value.sectionType } : null;
+    case "builtins":
+      return { kind: "builtins" };
+    case "workspace":
+      return { kind: "workspace" };
+    default:
+      return null;
+  }
+}
+function bodySchemaOf(value) {
+  if (!isRecord(value) || !Array.isArray(value.allowed)) return null;
+  const origin = BODY_SCHEMA_ORIGINS.includes(value.origin) ? value.origin : "authored";
+  return { allowed: value.allowed.map(allowRuleOf).filter((r) => r !== null), origin };
+}
+
 // src/block.ts
 var WINDOW_INSTANT = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:\d{2})$/;
 function normalizeWindow(value) {
@@ -94,20 +121,23 @@ function readNumberFormat(raw) {
   const group = typeof o.group === "string" && GROUPS.includes(o.group) ? o.group : void 0;
   const decimal = o.decimal === "," ? "," : void 0;
   const decimals = typeof o.decimals === "number" && Number.isInteger(o.decimals) && o.decimals > 0 && o.decimals <= 6 ? o.decimals : void 0;
+  const grouping = o.grouping === "3;2" ? "3;2" : void 0;
   return {
     ...prefix ? { prefix } : {},
     ...suffix ? { suffix } : {},
     // A group mark that is also the decimal mark would print a number nobody can read back.
     ...group && group !== (decimal ?? ".") ? { group } : {},
     ...decimal ? { decimal } : {},
-    ...decimals ? { decimals } : {}
+    ...decimals ? { decimals } : {},
+    ...grouping ? { grouping } : {}
   };
 }
+var groupDigits = (int, mark, grouping) => grouping === "3;2" && int.length > 3 ? `${int.slice(0, -3).replace(/\B(?=(\d{2})+(?!\d))/g, mark)}${mark}${int.slice(-3)}` : int.replace(/\B(?=(\d{3})+(?!\d))/g, mark);
 function formatNumber(value, format = {}) {
   if (typeof value !== "number" || !Number.isFinite(value)) return "";
   const places = Math.max(format.decimals ?? 0, Math.min(6, fractionDigits(value)));
   const [int, frac] = Math.abs(value).toFixed(places).split(".");
-  const grouped = format.group ? int.replace(/\B(?=(\d{3})+(?!\d))/g, format.group) : int;
+  const grouped = format.group ? groupDigits(int, format.group, format.grouping) : int;
   return `${value < 0 ? "-" : ""}${format.prefix ?? ""}${grouped}${frac ? `${format.decimal ?? "."}${frac}` : ""}${format.suffix ?? ""}`;
 }
 function parseNumberText(text, opts = {}) {
@@ -194,14 +224,14 @@ var BLOCK_BINDINGS = {
   ],
   tabs: [{ path: "tabs[].label", kind: "text" }]
 };
-var isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+var isRecord2 = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
 function readPath(root, path) {
   let cursor = root;
   for (const segment of path.split(".")) {
     if (!segment) return void 0;
     const key = segment.replace(/\[\d+\]/g, "");
     if (key) {
-      if (!isRecord(cursor)) return void 0;
+      if (!isRecord2(cursor)) return void 0;
       cursor = cursor[key];
     }
     for (const index of segment.matchAll(/\[(\d+)\]/g)) {
@@ -226,7 +256,7 @@ function expandBlockBindings(block) {
   const declared = BLOCK_BINDINGS[block.type];
   if (!declared) return [];
   const props = block.props;
-  if (!isRecord(props)) return [];
+  if (!isRecord2(props)) return [];
   return declared.flatMap((binding) => expandTemplate(binding, props, binding.path)).filter((binding) => readPath(props, binding.path) !== void 0);
 }
 function formatPropsAttribute(entries) {
@@ -609,8 +639,8 @@ function slotItems(value) {
 // src/slot-child.ts
 var SLOT_CHILD_KEYS = ["_key", "_type", "_variant", "_settings"];
 var RESERVED = new Set(SLOT_CHILD_KEYS);
-var isRecord2 = (v) => !!v && typeof v === "object" && !Array.isArray(v);
-var isSlotChild = (v) => isRecord2(v) && typeof v._type === "string" && v._type !== "";
+var isRecord3 = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+var isSlotChild = (v) => isRecord3(v) && typeof v._type === "string" && v._type !== "";
 function slotChildValues(child) {
   const out = {};
   for (const [k, v] of Object.entries(child)) if (!RESERVED.has(k)) out[k] = v;
@@ -625,7 +655,7 @@ function slotShapeProblems(value, opts = {}) {
   if (opts.min !== void 0 && value.length < opts.min) out.push({ path: [], code: "slot_too_few", message: `slot_too_few: ${label} needs at least ${opts.min} blocks, got ${value.length}` });
   const keys = /* @__PURE__ */ new Set();
   value.forEach((child, i) => {
-    if (!isRecord2(child)) {
+    if (!isRecord3(child)) {
       out.push({ path: [i], code: "slot_value_invalid", message: `slot_value_invalid: ${label}: block ${i + 1} must be an object { _key, _type, ...values }` });
       return;
     }
@@ -643,7 +673,7 @@ function slotShapeProblems(value, opts = {}) {
     }
     if (child._settings !== void 0) {
       if (!opts.settings) out.push({ path: [i, "_settings"], code: "slot_settings_undeclared", message: `slot_settings_undeclared: ${label} declares no slotSettings, so a block holds no _settings` });
-      else if (!isRecord2(child._settings)) out.push({ path: [i, "_settings"], code: "slot_value_invalid", message: `slot_value_invalid: ${label}: _settings must be an object keyed by the slot's slotSettings` });
+      else if (!isRecord3(child._settings)) out.push({ path: [i, "_settings"], code: "slot_value_invalid", message: `slot_value_invalid: ${label}: _settings must be an object keyed by the slot's slotSettings` });
     }
     for (const k of Object.keys(child)) {
       if (k.startsWith("_") && !RESERVED.has(k)) {
@@ -3149,10 +3179,10 @@ function layout(fields, fieldsets, root) {
   const byId = new Map(fieldsets.map((s) => [s.id, s]));
   const tabIds = root ? fieldsets.filter((s) => s.kind === "tab").map((s) => s.id) : [];
   const tabOf = (s) => s?.kind === "tab" ? s.id : s?.tab !== void 0 && byId.get(s.tab)?.kind === "tab" ? s.tab : void 0;
-  const nonEmpty = new Set(
+  const nonEmpty2 = new Set(
     fields.map((f) => tabOf(byId.get(f.fieldsetId ?? ""))).filter((t) => t && tabIds.includes(t))
   );
-  const strip2 = nonEmpty.size >= 2;
+  const strip2 = nonEmpty2.size >= 2;
   const branches = /* @__PURE__ */ new Map();
   const nodeFor = (f, path) => {
     const key = `${path}${f.key}`;
@@ -3173,7 +3203,7 @@ function layout(fields, fieldsets, root) {
     return { kind: "leaf", key };
   };
   const pinned = [];
-  const panels = new Map(strip2 ? tabIds.filter((t) => nonEmpty.has(t)).map((t) => [t, []]) : []);
+  const panels = new Map(strip2 ? tabIds.filter((t) => nonEmpty2.has(t)).map((t) => [t, []]) : []);
   const containers = /* @__PURE__ */ new Map();
   for (const f of fields) {
     const node = nodeFor(f, "");
@@ -4181,6 +4211,14 @@ function locatorFor(el, region, landmarks = false) {
     tag: el.tagName.toLowerCase()
   };
 }
+function locatorPath(el, landmarks = false) {
+  const path = [];
+  for (let parent = el.parentElement; parent && parent.tagName !== "BODY" && !isChromeLandmark(parent, landmarks); parent = parent.parentElement) {
+    path.unshift(parent.parentElement ? Math.max(Array.from(parent.parentElement.children).indexOf(parent), 0) : 0);
+  }
+  return path;
+}
+var LOCATOR_PATH = /* @__PURE__ */ Symbol.for("bcms.locator.path");
 function landmarkRegions(doc, dialogs = false, landmarks = false) {
   const counts = /* @__PURE__ */ new Map();
   const out = [];
@@ -4241,9 +4279,79 @@ var TAG_HEADS = /* @__PURE__ */ new Set([
   "icon",
   "bg"
 ]);
+var ROLE_KEYS = /* @__PURE__ */ new Set([
+  "headline",
+  "heading",
+  "subheading",
+  "eyebrow",
+  "intro",
+  "paragraph",
+  "text",
+  "primary-button",
+  "secondary-button",
+  "button",
+  "link",
+  "home-link",
+  "image",
+  "icon",
+  "logo",
+  "background-image",
+  "video-poster",
+  "video",
+  "embed",
+  "audio",
+  "body",
+  "content",
+  "copyright",
+  "email",
+  "phone",
+  "price",
+  "percentage",
+  "number",
+  "date",
+  "stat-value",
+  "stat-label",
+  "quote",
+  "attribution",
+  "caption",
+  "label",
+  "summary",
+  "address",
+  "code",
+  "term",
+  "definition",
+  "table-heading",
+  "table-cell",
+  "list-item",
+  "title",
+  "subtitle",
+  "description",
+  "value",
+  "list",
+  "plan-name",
+  "cents",
+  "billing-period",
+  "badge",
+  "features",
+  "question",
+  "answer",
+  "author",
+  "role",
+  "tooltip",
+  "placeholder",
+  "image-description",
+  "counter-target"
+]);
+var ROLE_TAILS = /(?:-label)?(?:-[a-z])?(?:-\d+)?(?:-href)?$/;
+function isRoleKey(key) {
+  if (ROLE_KEYS.has(key)) return true;
+  const tail = ROLE_TAILS.exec(key);
+  return !!tail && tail[0] !== "" && ROLE_KEYS.has(key.slice(0, tail.index));
+}
 var topFieldKeyOf = (path) => path.split(/[.[]/, 1)[0] ?? path;
 function fieldGroupOf(topKey, flat = false) {
   if (topKey.startsWith("group-")) return { groupKey: topKey, rooted: true };
+  if (isRoleKey(topKey)) return { groupKey: topKey, rooted: false };
   const camel = flat ? /^([a-z][a-z0-9]*)[A-Z]/.exec(topKey)?.[1] : void 0;
   if (camel) return TAG_HEADS.has(camel) ? { groupKey: topKey, rooted: false } : { groupKey: camel, rooted: true };
   const head = topKey.split(/[-_]/, 1)[0] || topKey;
@@ -4297,6 +4405,7 @@ function planSections(slots, blocks) {
 }
 export {
   BLOCK_BINDINGS,
+  BODY_SCHEMA_ORIGINS,
   BREAKPOINTS,
   BUTTON_ACTIONS,
   BUTTON_FULL_WIDTH_INVALID,
@@ -4323,11 +4432,13 @@ export {
   LINK_RELS,
   LINK_VALUE_TYPES,
   LIST_ITEMS_CAP,
+  LOCATOR_PATH,
   MAIN_SELECTOR,
   NAVIGATION_SECTION_ID,
   OPTION_DESCRIPTION_MAX,
   PAGE_CONTENT_ANCHOR_ID,
   RESPONSIVE_CSS,
+  ROLE_KEYS,
   SECTION_DOCTRINE,
   SECTION_SPACE_TOKENS,
   SIDE_SPACE_MIN_PX,
@@ -4344,10 +4455,12 @@ export {
   TAG_HEADS,
   VIDEO_TRANSCRIPT_MAX,
   VIDEO_VALUE_KEYS,
+  allowRuleOf,
   anchorTargetRel,
   blockStyleToColumnCss,
   blockStyleToCss,
   blockStyleToInnerCss,
+  bodySchemaOf,
   buttonBlockProps,
   buttonFullWidthProblem,
   buttonIconOf,
@@ -4381,6 +4494,7 @@ export {
   isChromeLandmark,
   isCodeButton,
   isLinkObject,
+  isRoleKey,
   isScriptHref,
   isSlotChild,
   isTableValue,
@@ -4391,6 +4505,7 @@ export {
   linkRefOf,
   linkValueProblem,
   locatorFor,
+  locatorPath,
   normalizeLinkValue,
   normalizeTableValue,
   normalizeWindow,