@bettercms-ai/types 1.50.2 → 1.52.0

package/dist/index.js

@@ -3159,6 +3159,138 @@ var DOCK_ICON_NAMES = [
 ];
 var DOCK_ICON_NAME_SET = new Set(DOCK_ICON_NAMES);
 
+// src/help-catalog.ts
+var HELP_MAX = 160;
+var ROLE_HELP = {
+  // A top-level field's role in its section.
+  headline: "The page's main heading, one per page.",
+  heading: "The heading of this section.",
+  subheading: "Shown under the heading.",
+  eyebrow: "Short label shown above the heading.",
+  intro: "Shown under the heading. One or two sentences.",
+  paragraph: "A paragraph of text.",
+  text: "Text shown on the page.",
+  "primary-button": "The main call to action.",
+  "secondary-button": "The second call to action.",
+  button: "Its text, where it goes and how it looks.",
+  "button-label": "Text on the button. Two to four words works best.",
+  link: "Text of this link. Say where it leads.",
+  "home-link": "Takes visitors back to the home page.",
+  destination: "Pick a page or paste a full URL.",
+  image: "An image shown on the page.",
+  icon: "Optional icon before the label.",
+  logo: "An SVG or transparent PNG works best.",
+  "background-image": "Text sits on top of it, so a calm image works best.",
+  "video-poster": "Shown before the video plays.",
+  video: "Paste a link or upload an MP4.",
+  embed: "Paste the link the other site gives you to share it.",
+  audio: "Paste a link or upload an audio file.",
+  body: "Headings, paragraphs, lists and links, edited as one.",
+  content: "Headings, paragraphs, lists and links, edited as one.",
+  copyright: "Shown at the bottom of every page.",
+  email: "An email address, such as name@example.com.",
+  phone: "A phone number, with its country code.",
+  price: "Whole number, no currency symbol.",
+  percentage: "A number with its % sign.",
+  number: "A figure shown on the page.",
+  date: "A date, written as it should appear.",
+  "stat-value": "A figure shown large, such as 70k+.",
+  "stat-label": "What the figure counts.",
+  quote: "Without quote marks.",
+  attribution: "Who said it.",
+  caption: "Shown under the image.",
+  label: "A short label.",
+  summary: "Shown in lists and previews.",
+  address: "The postal address, as it should appear.",
+  code: "Shown exactly as written.",
+  term: "The word or phrase being explained.",
+  definition: "What the term means.",
+  "table-heading": "Heading of a table column.",
+  "table-cell": "One cell of the table.",
+  "list-item": "One item of the list.",
+  list: "One item per row.",
+  links: "One link per row.",
+  band: "All the text of this section, edited as one.",
+  // A column's role in its row.
+  title: "The title of this item.",
+  subtitle: "Shown under the title.",
+  description: "One line under the name.",
+  value: "The value shown for this item.",
+  // What a band's shape calls an element.
+  "plan-name": "Short name of this plan, shown at the top of its card.",
+  cents: "Digits after the decimal point.",
+  "billing-period": "How often the price is charged.",
+  // The parts of a plan's price object.
+  amount: "Whole number, no currency symbol.",
+  period: "How often the price is charged.",
+  badge: "Optional. Two or three words that make this plan stand out.",
+  features: "One feature per row.",
+  question: "One question, as a customer would ask it.",
+  answer: "Shown when the question is opened.",
+  author: "The person's full name.",
+  role: "Their job title and company.",
+  // What an attribute is, by what carries it.
+  tooltip: "Shown when the pointer rests on it.",
+  placeholder: "Shown in the empty input.",
+  "image-description": "Read by screen readers, not shown on the page.",
+  "counter-target": "The number the counter runs up to.",
+  attribute: "A setting of this element, not shown as text.",
+  "navigation-label": "Read by screen readers, not shown on the page.",
+  "link-label": "Read by screen readers, not shown on the page.",
+  "image-label": "Read by screen readers, not shown on the page.",
+  "field-label": "Read by screen readers, not shown on the page.",
+  "header-label": "Read by screen readers, not shown on the page.",
+  "footer-label": "Read by screen readers, not shown on the page.",
+  "aside-label": "Read by screen readers, not shown on the page.",
+  "section-label": "Read by screen readers, not shown on the page.",
+  "heading-label": "Read by screen readers, not shown on the page.",
+  // What a list's rows are.
+  plans: "One plan per card.",
+  questions: "One question and its answer per row.",
+  quotes: "One quote per row, with who said it.",
+  testimonials: "One quote per row, with who said it.",
+  stats: "One figure per row, with what it counts.",
+  logos: "One logo per row.",
+  cards: "One card per row.",
+  items: "One item per row."
+};
+var CANVAS_GESTURE_NAMES = ["rows.reorder", "image.replace", "link.popover", "text.inline"];
+var CONTROL_HELP = {
+  rows: { text: "Drag to reorder. You can also drag rows on the canvas.", gesture: "rows.reorder" },
+  image: { text: "You can also click it on the canvas to replace it.", gesture: "image.replace" },
+  link: { text: "Click it on the canvas to change where it goes.", gesture: "link.popover" },
+  text: { text: "You can also edit it on the canvas.", gesture: "text.inline" }
+};
+var EXAMPLE_MAX = 40;
+function sayOf(value) {
+  if (typeof value === "number") return String(value);
+  const v = value;
+  const raw = typeof value === "string" ? value : typeof v?.html === "string" ? v.html : typeof v?.label === "string" ? v.label : typeof v?.text === "string" ? v.text : "";
+  return raw.replace(/<[^>]+>/g, " ").replace(/&nbsp;/g, " ").replace(/\s+/g, " ").trim();
+}
+var quotable = (s) => s !== "" && s.length <= EXAMPLE_MAX && !s.includes('"');
+function exampleFor(column, rows, i) {
+  const at = (j) => {
+    const row = rows[j];
+    return row && typeof row === "object" ? sayOf(row[column]) : "";
+  };
+  const own2 = at(i);
+  for (let d = 1; d < rows.length; d += 1) {
+    for (const j of [i - d, i + d]) {
+      if (j < 0 || j >= rows.length) continue;
+      const v = at(j);
+      if (v !== own2 && quotable(v)) return `e.g. "${v}"`;
+    }
+  }
+  return quotable(own2) ? `e.g. "${own2}"` : void 0;
+}
+function withExample(help, example) {
+  if (!example) return help;
+  if (!help) return example;
+  const joined = `${help} ${example}`;
+  return joined.length <= HELP_MAX ? joined : help;
+}
+
 // src/dock-budget.ts
 var DOCK_BUDGET = { ungrouped: 8, group: 12, depth: 3, activations: 2 };
 function listItems(f) {
@@ -3408,6 +3540,19 @@ 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/link-pairs.ts
+var LINK_TYPES2 = /* @__PURE__ */ new Set(["link", "url"]);
+var nameOf = (s) => s.name ?? s.key;
+function rulePartnerOf(labelKey, siblings) {
+  const names = labelKey === "label" ? ["label-href", "href", "url", "link"] : [`${labelKey}-href`];
+  for (const n of names) {
+    const s = siblings.find((f) => nameOf(f) === n);
+    if (s && LINK_TYPES2.has(s.type ?? "")) return n;
+  }
+  return null;
+}
+var isRulePaired = (labelKey, siblings) => rulePartnerOf(labelKey, siblings) !== null;
+
 // src/button-look.ts
 import { ICON_MARKUP, iconSvg } from "@bettercms-ai/icons/markup";
 
@@ -4340,7 +4485,9 @@ var ROLE_KEYS = /* @__PURE__ */ new Set([
   "tooltip",
   "placeholder",
   "image-description",
-  "counter-target"
+  "counter-target",
+  "amount",
+  "period"
 ]);
 var ROLE_TAILS = /(?:-label)?(?:-[a-z])?(?:-\d+)?(?:-href)?$/;
 function isRoleKey(key) {
@@ -4403,8 +4550,152 @@ function planSections(slots, blocks) {
   });
   return out;
 }
+
+// src/kit-v2.ts
+var TAB_MAX = 8;
+var SEGMENTED_MIN = 2;
+var SEGMENTED_MAX = 8;
+var DEPTH_MAX = 10;
+var HELP_CAPS = {
+  field: 500,
+  prop: 200,
+  placeholder: 120,
+  helpMore: 2e3,
+  option: OPTION_DESCRIPTION_MAX,
+  fieldset: 500,
+  propGroup: 200
+};
+var SLOT_SETTINGS_MAX = 12;
+var SLOT_SETTINGS_TYPES = [
+  "text",
+  "slug",
+  "select",
+  "multiselect",
+  "number",
+  "rating",
+  "date",
+  "datetime",
+  "boolean",
+  "color",
+  "icon",
+  "link"
+];
+var BLOCK_FIELD_TYPES = [
+  "text",
+  "longtext",
+  "richtext",
+  "image",
+  "link",
+  "slug",
+  "email",
+  "phone",
+  "color",
+  "select",
+  "number",
+  "rating",
+  "date",
+  "datetime",
+  "boolean",
+  "video",
+  "object",
+  "array",
+  "reference",
+  "file",
+  "tags"
+];
+var BLOCK_FIELD_TYPES_RENDERABLE_NOW = [
+  "text",
+  "longtext",
+  "richtext",
+  "image",
+  "link",
+  "slug",
+  "email",
+  "phone",
+  "color",
+  "select",
+  "number",
+  "rating",
+  "date",
+  "datetime",
+  "boolean"
+];
+var V2_SHAPES = ["block", "page", "entry", "global", "object"];
+var V2_PLACEMENTS = ["inline", "section", "page"];
+var KIT_CATEGORIES = [
+  "Navigation & chrome",
+  "Heroes",
+  "Features & storytelling",
+  "Social proof",
+  "Media & galleries",
+  "Commerce",
+  "Pricing & plans",
+  "Conversion & forms",
+  "Listings & feeds",
+  "Long-form & docs",
+  "Company & people",
+  "Events & places",
+  "Data & interactive",
+  "Advanced patterns"
+];
+var V2_KEYS = {
+  components: ["shape", "placement"],
+  content_models: ["shape", "placement", "category", "variants"],
+  component_variant_groups: ["variants"]
+};
+var SOURCE_RANK = { auto: 0, site: 1, agent: 2, human: 3 };
+var mayOverwrite = (stored, incoming) => SOURCE_RANK[incoming] >= SOURCE_RANK[stored ?? "auto"];
+var UI_REFUSAL_CODES = {
+  schema: [
+    "facet_unclassified",
+    "excluded_facet",
+    "depth_exceeded",
+    "validation_failed",
+    "hash_mismatch",
+    "shape_kind_mismatch",
+    "block_field_unrenderable"
+  ],
+  build: ["peer_missing", "kit_major_unsupported", "compile_error", "nondeterministic", "size_exceeded"],
+  protocol: ["unsupported", "handshake_timeout", "origin_mismatch", "write_denied"],
+  runtime: ["crashed", "blank", "csp_violation"],
+  policy: ["confirmation_required", "flag_off"]
+};
+var uiRefusalId = (r) => `${r.family}.${r.code}`;
+var isUiRefusal = (v) => {
+  if (typeof v !== "object" || v === null) return false;
+  const { family, code, message } = v;
+  return typeof family === "string" && Object.hasOwn(UI_REFUSAL_CODES, family) && UI_REFUSAL_CODES[family].includes(code) && typeof message === "string";
+};
+function canonicalNumber(value) {
+  if (!Number.isFinite(value)) throw new TypeError("Canonical JSON only supports finite numbers");
+  if (Object.is(value, -0)) return "0";
+  const encoded = JSON.stringify(value);
+  const scientific = /^(-?)(\d+)(?:\.(\d+))?[eE]([+-]?\d+)$/.exec(encoded);
+  if (!scientific) return encoded;
+  const [, sign, integer, fraction = "", exponentText] = scientific;
+  const digits = `${integer}${fraction}`;
+  const decimalPoint = integer.length + Number(exponentText);
+  if (decimalPoint <= 0) return `${sign}0.${"0".repeat(-decimalPoint)}${digits}`;
+  if (decimalPoint >= digits.length) return `${sign}${digits}${"0".repeat(decimalPoint - digits.length)}`;
+  return `${sign}${digits.slice(0, decimalPoint)}.${digits.slice(decimalPoint)}`;
+}
+var skipped = (v) => v === void 0 || typeof v === "function" || typeof v === "symbol";
+function canonicalJson(value) {
+  if (value === null) return "null";
+  if (typeof value === "number") return canonicalNumber(value);
+  if (typeof value === "string" || typeof value === "boolean") return JSON.stringify(value);
+  if (Array.isArray(value)) return `[${value.map((child) => skipped(child) ? "null" : canonicalJson(child)).join(",")}]`;
+  if (typeof value === "object") {
+    const record = value;
+    const keys = Object.keys(record).filter((key) => !skipped(record[key])).sort();
+    return `{${keys.map((key) => `${JSON.stringify(key)}:${canonicalJson(record[key])}`).join(",")}}`;
+  }
+  throw new TypeError(`Unsupported canonical JSON value: ${typeof value}`);
+}
 export {
   BLOCK_BINDINGS,
+  BLOCK_FIELD_TYPES,
+  BLOCK_FIELD_TYPES_RENDERABLE_NOW,
   BODY_SCHEMA_ORIGINS,
   BREAKPOINTS,
   BUTTON_ACTIONS,
@@ -4415,8 +4706,11 @@ export {
   BUTTON_PLACEMENT_KEYS,
   BUTTON_SIZES,
   BUTTON_VARIANTS,
+  CANVAS_GESTURE_NAMES,
   CODE_SLOT_PREFIX,
   COMPONENT_PROP_TYPES,
+  CONTROL_HELP,
+  DEPTH_MAX,
   DIALOG_SELECTOR,
   DOCK_BUDGET,
   DOCK_ICON_NAMES,
@@ -4424,8 +4718,11 @@ export {
   FIELD_SIZE_ZOOM,
   FIELD_STYLE_KEYS,
   FOOTER_SECTION_ID,
+  HELP_CAPS,
+  HELP_MAX,
   IMAGE_ASPECTS,
   IMAGE_FRAME_RADIUS,
+  KIT_CATEGORIES,
   LANDMARK_SELECTOR,
   LAYOUT_SECTION_ICONS,
   LAYOUT_SECTION_ICON_SET,
@@ -4438,21 +4735,32 @@ export {
   OPTION_DESCRIPTION_MAX,
   PAGE_CONTENT_ANCHOR_ID,
   RESPONSIVE_CSS,
+  ROLE_HELP,
   ROLE_KEYS,
   SECTION_DOCTRINE,
   SECTION_SPACE_TOKENS,
+  SEGMENTED_MAX,
+  SEGMENTED_MIN,
   SIDE_SPACE_MIN_PX,
   SIDE_SPACE_TOKENS,
   SLOT_CHILD_KEYS,
   SLOT_ITEMS_CAP,
   SLOT_MAX_ITEMS,
+  SLOT_SETTINGS_MAX,
+  SLOT_SETTINGS_TYPES,
+  SOURCE_RANK,
   SPACE_BOTTOM_TOKENS,
   SPACE_STEP_TOKENS,
   TABLE_COLUMN_TYPES,
   TABLE_JSONLD_TYPES,
   TABLE_LIMITS,
   TABLE_RESPONSIVE,
+  TAB_MAX,
   TAG_HEADS,
+  UI_REFUSAL_CODES,
+  V2_KEYS,
+  V2_PLACEMENTS,
+  V2_SHAPES,
   VIDEO_TRANSCRIPT_MAX,
   VIDEO_VALUE_KEYS,
   allowRuleOf,
@@ -4472,11 +4780,13 @@ export {
   buttonValueProblem,
   buttonVariantOf,
   candidateRole,
+  canonicalJson,
   componentInstanceAddresses,
   componentPropTargetKey,
   derivedPairs,
   dockBudget,
   dockScreens,
+  exampleFor,
   expandBlockBindings,
   fieldGroupOf,
   fieldStyleCssText,
@@ -4495,9 +4805,11 @@ export {
   isCodeButton,
   isLinkObject,
   isRoleKey,
+  isRulePaired,
   isScriptHref,
   isSlotChild,
   isTableValue,
+  isUiRefusal,
   keyWords,
   landmarkRegions,
   linkAnchorOf,
@@ -4506,6 +4818,7 @@ export {
   linkValueProblem,
   locatorFor,
   locatorPath,
+  mayOverwrite,
   normalizeLinkValue,
   normalizeTableValue,
   normalizeWindow,
@@ -4519,6 +4832,7 @@ export {
   readPath,
   regionOf,
   renderTableHtml,
+  rulePartnerOf,
   safeCssUrl,
   sideFloorApplies,
   sideSpaceCss,
@@ -4536,6 +4850,7 @@ export {
   tableToMarkdown,
   tableValueProblems,
   topFieldKeyOf,
+  uiRefusalId,
   usesHideOn,
   videoUrlOf,
   videoValueProblem,
@@ -4543,6 +4858,7 @@ export {
   visibleDeliveredLayout,
   visibleLayoutStructure,
   windowState,
-  withButtonLookProps
+  withButtonLookProps,
+  withExample
 };
 //# sourceMappingURL=index.js.map