@bettercms-ai/types 1.25.0 → 1.27.0

package/dist/index.d.ts

@@ -48,7 +48,7 @@ interface ContentModel {
  * by the API but normalized to `array` + zones on write, so stored/delivered
  * content never contains them.
  */
-type ContentModelFieldType = "text" | "richtext" | "document" | "image" | "boolean" | "number" | "select" | "reference" | "multi-reference" | "multiReference" | "array" | "date" | "datetime" | "longtext" | "slug" | "email" | "phone" | "link" | "color" | "json" | "file" | "component-ref" | "modular" | "sections" | "location";
+type ContentModelFieldType = "text" | "richtext" | "document" | "image" | "boolean" | "number" | "select" | "reference" | "multi-reference" | "multiReference" | "array" | "date" | "datetime" | "longtext" | "slug" | "email" | "phone" | "link" | "color" | "json" | "file" | "component-ref" | "modular" | "sections" | "location" | "button";
 type ContentModelKind = "model" | "block";
 /**
  * How a fieldset renders in the dock. ABSENT ≡ today's flat list (V2): a legacy `{id, name}`
@@ -326,6 +326,71 @@ declare const SPACE_BOTTOM_TOKENS: ("section-space-none" | "section-space-small"
 /** `var(--bcms-<token>,<px>)`, or "" for anything that is not a known token (closed set). */
 declare function spaceTokenCss(token: unknown): string;
 
+declare const BUTTON_VARIANTS: readonly ["primary", "secondary", "tertiary", "brand", "dark", "light", "outline", "link"];
+type ButtonVariant = (typeof BUTTON_VARIANTS)[number];
+/** Each icon's inner SVG markup (viewBox `0 0 25 25`), by name. */
+declare const BUTTON_ICONS: Readonly<Record<DockIconName, string>>;
+type ButtonIcon = DockIconName;
+declare const BUTTON_ICON_NAMES: readonly ["access-denied", "activity", "add", "add-circle", "add-comment", "add-document", "add-user", "api", "archive", "arrow-down", "arrow-left", "arrow-right", "arrow-top-right", "arrow-up", "asterisk", "bar-chart", "basket", "bell", "bill", "binary-document", "block-content", "block-element", "blockquote", "bold", "bolt", "book", "bookmark", "bookmark-filled", "bottle", "bug", "bulb-filled", "bulb-outline", "calendar", "case", "chart-upward", "checkmark", "checkmark-circle", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "clipboard", "clipboard-image", "clock", "close", "close-circle", "code", "code-block", "cog", "collapse", "color-wheel", "comment", "component", "compose", "compose-sparkles", "confetti", "controls", "copy", "credit-card", "crop", "cube", "dashboard", "database", "desktop", "diamond", "document", "document-pdf", "document-remove", "document-sheet", "document-text", "document-video", "document-word", "document-zip", "documents", "dot", "double-chevron-down", "double-chevron-left", "double-chevron-right", "double-chevron-up", "double-quote", "download", "drag-handle", "drop", "earth-americas", "earth-globe", "edit", "ellipsis-horizontal", "ellipsis-vertical", "empty", "enter", "enter-right", "envelope", "equal", "error-filled", "error-outline", "error-screen", "expand", "eye-closed", "eye-open", "face-happy", "face-indifferent", "face-sad", "feedback", "filter", "folder", "generate", "github", "groq", "hash", "heart", "heart-filled", "help-circle", "highlight", "home", "ice-cream", "image", "image-remove", "images", "inbox", "info-filled", "info-outline", "inline", "inline-element", "insert-above", "insert-below", "italic", "joystick", "json", "launch", "leave", "lemon", "link", "link-removed", "linkedin", "list", "lock", "logo-js", "logo-ts", "marker", "marker-removed", "master-detail", "menu", "microphone", "microphone-slash", "mobile-device", "moon", "number", "ok-hand", "olist", "overage", "package", "panel-left", "panel-right", "pause", "pin", "pin-filled", "pin-removed", "play", "plug", "presentation", "progress-50", "progress-75", "projects", "publish", "read-only", "redo", "refresh", "remove", "remove-circle", "reset", "restore", "retrieve", "retry", "revert", "robot", "rocket", "schema", "search", "select", "share", "sort", "sparkle", "sparkles", "spinner", "split-horizontal", "split-vertical", "square", "stack", "stack-compact", "star", "star-filled", "stop", "strikethrough", "string", "sun", "sync", "tablet-device", "tag", "tags", "target", "task", "terminal", "text", "th-large", "th-list", "thumbs-down", "thumbs-up", "tiers", "timeline", "toggle-arrow-right", "token", "transfer", "translate", "trash", "trend-upward", "triangle-outline", "trolley", "truncate", "twitter", "ulist", "unarchive", "underline", "undo", "unknown", "unlink", "unlock", "unpublish", "upload", "user", "users", "versions", "video", "warning-filled", "warning-outline", "wrench"];
+/** A stored variant as it renders: anything off the list is Primary. */
+declare function buttonVariantOf(value: unknown): ButtonVariant;
+/** A stored icon as it renders: anything off the list is no icon. */
+declare function buttonIconOf(value: unknown): ButtonIcon | null;
+/** One icon as inline SVG sized to the button's text, hidden from assistive tech (the label names the button). */
+declare function buttonIconSvg(name: ButtonIcon, cls: "bcms-btn-icon" | "bcms-btn-arrow"): string;
+declare const BUTTON_SIZES: readonly ["sm", "md", "lg"];
+type ButtonSizeName = (typeof BUTTON_SIZES)[number];
+/**
+ * The value a `button` field stores: the words, the link and the look, as Sanity stores a button
+ * object. Only `label` and `href` are required; every look key is optional and absent reads as
+ * today's default (Primary, medium, no arrow, no icon, same tab).
+ */
+interface ButtonValue {
+    label: string;
+    href: string;
+    variant?: ButtonVariant;
+    size?: ButtonSizeName;
+    arrow?: boolean;
+    icon?: ButtonIcon | null;
+    newTab?: boolean;
+}
+/** A stored button value as it renders: every key read through the same allow-lists as a block. */
+declare function readButtonValue(value: unknown): Required<ButtonValue>;
+/** Why a value is not a button, or null when it is. Look keys are checked only when present. */
+declare function buttonValueProblem(value: unknown): string | null;
+/** The look keys an instance of a Button component may override, beside its label and link. */
+declare const BUTTON_LOOK_KEYS: readonly ["variant", "size", "arrow", "icon", "newTab"];
+type ButtonLookKey = (typeof BUTTON_LOOK_KEYS)[number];
+interface PropDefLike {
+    key: string;
+    label?: string;
+    type?: string;
+    target: {
+        blockId: string;
+        path: string;
+    };
+}
+interface ComponentLike<P extends PropDefLike> {
+    category?: string | null;
+    blockJson?: unknown;
+    props?: readonly P[] | null;
+}
+/**
+ * A component's prop declarations, plus — on a Button component (category `button`, one button
+ * block) — a look prop for every `BUTTON_LOOK_KEYS` key it does not declare itself, each driving
+ * that block's `props.<key>`. So an INSTANCE of any Button carries its own look in its overrides
+ * (`{ text, href, variant, arrow, … }`) with nothing to backfill: every renderer that applies
+ * overrides passes this instead of `props`. Any other component is returned as declared, so a
+ * section with one CTA never has a stray `variant` override land on its button.
+ */
+declare function withButtonLookProps<P extends PropDefLike>(def: ComponentLike<P>): P[];
+/**
+ * One instance of a Button component as a `ButtonValue` — the definition's button with the
+ * instance's overrides written onto it — for a site rendering the instance with `BcmsButton`.
+ * Null when the component is not a Button (not category `button`, or not exactly one button).
+ */
+declare function buttonValueOfInstance<P extends PropDefLike>(def: ComponentLike<P>, overrides: Record<string, unknown> | null | undefined): Required<ButtonValue> | null;
+
 /**
  * ContentBlock — a discriminated union of all CMS block types.
  * Each block has a `type` discriminator and a `props` object
@@ -510,11 +575,18 @@ interface ImageBlock {
 interface ButtonProps {
     text: string;
     href: string;
-    variant?: "primary" | "secondary";
+    /** Absent or off the list ⇒ "primary". Renders `bcms-btn-{variant}`. */
+    variant?: ButtonVariant;
     /** Padding + font-size step. Absent ⇒ "md", today's button. sm/lg render `bcms-btn-sm|lg`. */
     size?: "sm" | "md" | "lg";
     /** Stretch to the column's width. Absent ⇒ false. true renders `bcms-btn-full`. */
     fullWidth?: boolean;
+    /** Draw a trailing arrow after the text. Absent ⇒ false. */
+    arrow?: boolean;
+    /** A leading icon from `BUTTON_ICONS`. Absent, null or off the list ⇒ none. */
+    icon?: ButtonIcon | null;
+    /** Open the link in a new tab (`target="_blank" rel="noopener noreferrer"`). Absent ⇒ false. */
+    newTab?: boolean;
 }
 interface ButtonBlock {
     type: "button";
@@ -2308,4 +2380,4 @@ declare function regionOf<E extends {
     el: E;
 }[], el: unknown): string | null;
 
-export { type AlignToken, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type ButtonBlock, type ButtonLinkCandidate, type ButtonProps, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type CollectionBlock, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, 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 DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FOOTER_SECTION_ID, type FieldConfig, 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, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, 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 LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, 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 RadiusToken, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type SectionBlock, type SectionProps, type SectionSpaceToken, type ShadowToken, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, type TabItem, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, type VariantInputMapping, type VideoBlock, type VideoProps, type WeightToken, type Workspace, type ZoneField, blockStyleToCss, buttonLinkPairs, candidateRole, componentInstanceAddresses, componentPropTargetKey, dockBudget, dockScreens, expandBlockBindings, formatPropsAttribute, getBlockType, isBlock, isChromeLandmark, keyWords, landmarkRegions, locatorFor, parsePropsAttribute, readPath, regionOf, spaceTokenCss };
+export { type AlignToken, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, BUTTON_ICONS, BUTTON_ICON_NAMES, BUTTON_LOOK_KEYS, BUTTON_SIZES, BUTTON_VARIANTS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type ButtonBlock, type ButtonIcon, type ButtonLinkCandidate, type ButtonLookKey, type ButtonProps, type ButtonSizeName, type ButtonValue, type ButtonVariant, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type CollectionBlock, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, 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 DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FOOTER_SECTION_ID, type FieldConfig, 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, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, 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 LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, 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 RadiusToken, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type SectionBlock, type SectionProps, type SectionSpaceToken, type ShadowToken, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, type TabItem, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, type VariantInputMapping, type VideoBlock, type VideoProps, type WeightToken, type Workspace, type ZoneField, blockStyleToCss, buttonIconOf, buttonIconSvg, buttonLinkPairs, buttonValueOfInstance, buttonValueProblem, buttonVariantOf, candidateRole, componentInstanceAddresses, componentPropTargetKey, dockBudget, dockScreens, expandBlockBindings, formatPropsAttribute, getBlockType, isBlock, isChromeLandmark, keyWords, landmarkRegions, locatorFor, parsePropsAttribute, readButtonValue, readPath, regionOf, spaceTokenCss, withButtonLookProps };

package/dist/index.js

@@ -2601,6 +2601,95 @@ function buttonLinkPairs(candidates) {
   return [...proposals.values()].filter(([t, l]) => !ambiguous.has(t) && !ambiguous.has(l) && uses.get(t) === 1 && uses.get(l) === 1).sort((a, b) => Math.min(...a) - Math.min(...b));
 }
 
+// src/button-look.ts
+import { ICON_MARKUP, iconSvg } from "@bettercms-ai/icons/markup";
+var BUTTON_VARIANTS = ["primary", "secondary", "tertiary", "brand", "dark", "light", "outline", "link"];
+var BUTTON_ICONS = ICON_MARKUP;
+var BUTTON_ICON_NAMES = DOCK_ICON_NAMES;
+function buttonVariantOf(value) {
+  return BUTTON_VARIANTS.includes(value) ? value : "primary";
+}
+function buttonIconOf(value) {
+  return typeof value === "string" && DOCK_ICON_NAME_SET.has(value) ? value : null;
+}
+function buttonIconSvg(name, cls) {
+  return iconSvg(name, cls);
+}
+var BUTTON_SIZES = ["sm", "md", "lg"];
+var hrefOf = (href) => typeof href === "string" ? href : href && typeof href === "object" && typeof href.href === "string" ? href.href : null;
+function readButtonValue(value) {
+  const v = value && typeof value === "object" ? value : {};
+  return {
+    label: typeof v.label === "string" ? v.label : "",
+    href: hrefOf(v.href) ?? "",
+    variant: buttonVariantOf(v.variant),
+    size: BUTTON_SIZES.includes(v.size) ? v.size : "md",
+    arrow: v.arrow === true,
+    icon: buttonIconOf(v.icon),
+    newTab: v.newTab === true
+  };
+}
+function buttonValueProblem(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return "must be a { label, href } button";
+  const v = value;
+  if (typeof v.label !== "string") return "needs a label";
+  if (hrefOf(v.href) === null) return "needs an href";
+  if (v.variant !== void 0 && !BUTTON_VARIANTS.includes(v.variant)) return `has an unknown variant "${String(v.variant)}"`;
+  if (v.size !== void 0 && !BUTTON_SIZES.includes(v.size)) return `has an unknown size "${String(v.size)}"`;
+  if (v.arrow !== void 0 && typeof v.arrow !== "boolean") return "arrow must be true or false";
+  if (v.newTab !== void 0 && typeof v.newTab !== "boolean") return "newTab must be true or false";
+  if (v.icon !== void 0 && v.icon !== null && buttonIconOf(v.icon) === null) return `has an unknown icon "${String(v.icon)}"`;
+  return null;
+}
+var BUTTON_LOOK_KEYS = ["variant", "size", "arrow", "icon", "newTab"];
+function soleButtonId(blockJson) {
+  const ids = [];
+  const walk = (list) => {
+    if (!Array.isArray(list)) return;
+    for (const b of list) {
+      if (b?.type === "button" && typeof b.id === "string") ids.push(b.id);
+      walk(b?.props?.children);
+      if (Array.isArray(b?.props?.columns)) for (const column of b.props.columns) walk(column);
+    }
+  };
+  walk(blockJson);
+  return ids.length === 1 ? ids[0] : null;
+}
+var LOOK_PROP_TYPE = { variant: "text", size: "text", arrow: "boolean", icon: "text", newTab: "boolean" };
+var LOOK_PROP_LABEL = { variant: "Style", size: "Size", arrow: "Show arrow", icon: "Leading icon", newTab: "Open in new tab" };
+function withButtonLookProps(def) {
+  const props = [...def.props ?? []];
+  if (def.category !== "button") return props;
+  const blockId = soleButtonId(def.blockJson);
+  if (!blockId) return props;
+  for (const key of BUTTON_LOOK_KEYS) {
+    if (props.some((p) => p.key === key)) continue;
+    props.push({ key, label: LOOK_PROP_LABEL[key], type: LOOK_PROP_TYPE[key], target: { blockId, path: `props.${key}` } });
+  }
+  return props;
+}
+function buttonValueOfInstance(def, overrides) {
+  if (def.category !== "button") return null;
+  const blockId = soleButtonId(def.blockJson);
+  if (!blockId) return null;
+  const found = [];
+  const walk = (list) => {
+    if (!Array.isArray(list)) return;
+    for (const b of list) {
+      if (b?.id === blockId) found.push(b);
+      walk(b?.props?.children);
+      if (Array.isArray(b?.props?.columns)) for (const column of b.props.columns) walk(column);
+    }
+  };
+  walk(def.blockJson);
+  const props = { ...found[0]?.props ?? {} };
+  for (const p of withButtonLookProps(def)) {
+    if (p.target.blockId !== blockId || !p.target.path.startsWith("props.") || !overrides || !(p.key in overrides)) continue;
+    props[p.target.path.slice("props.".length)] = overrides[p.key];
+  }
+  return readButtonValue({ ...props, label: props.text });
+}
+
 // src/locator.ts
 var LANDMARK_SELECTOR = "header,nav,footer";
 var LANDMARK_TAGS = /* @__PURE__ */ new Set(["HEADER", "NAV", "FOOTER"]);
@@ -2663,6 +2752,11 @@ function regionOf(regions, el) {
 }
 export {
   BLOCK_BINDINGS,
+  BUTTON_ICONS,
+  BUTTON_ICON_NAMES,
+  BUTTON_LOOK_KEYS,
+  BUTTON_SIZES,
+  BUTTON_VARIANTS,
   COMPONENT_PROP_TYPES,
   DIALOG_SELECTOR,
   DOCK_BUDGET,
@@ -2680,7 +2774,12 @@ export {
   SPACE_BOTTOM_TOKENS,
   SPACE_STEP_TOKENS,
   blockStyleToCss,
+  buttonIconOf,
+  buttonIconSvg,
   buttonLinkPairs,
+  buttonValueOfInstance,
+  buttonValueProblem,
+  buttonVariantOf,
   candidateRole,
   componentInstanceAddresses,
   componentPropTargetKey,
@@ -2695,8 +2794,10 @@ export {
   landmarkRegions,
   locatorFor,
   parsePropsAttribute,
+  readButtonValue,
   readPath,
   regionOf,
-  spaceTokenCss
+  spaceTokenCss,
+  withButtonLookProps
 };
 //# sourceMappingURL=index.js.map