@bettercms-ai/types 1.33.0 → 1.35.0

package/dist/index.d.ts

@@ -205,7 +205,7 @@ interface ContentModelField {
     key: string;
     label: string;
     type: ContentModelFieldType;
-    /** Shown to editors under the field — an import writes the field's copy as `e.g. "49"`. */
+    /** Shown to editors under the field: what it is for, where it shows, any constraint. Never its value. */
     helpText?: string;
     required?: boolean;
     /**
@@ -241,10 +241,14 @@ interface ContentModelField {
     ui?: ContentModelFieldUi;
     /** Server-owned: who named this field (label, help text). Only an `auto` name may be renamed by a derive. */
     nameSource?: "auto" | "human";
+    /** Server-owned: who wrote `helpText`. @see HelpSource */
+    helpSource?: HelpSource;
     /** Server-owned provenance of this field's chrome. @see UiOrigin */
     uiOrigin?: UiOrigin;
     /** Server-owned revert point. @see UiBefore */
     uiBefore?: UiBefore;
+    /** `true`: the last release's build renders this field on no route of its page — hidden, never deleted. `false`: a person keeps it shown. */
+    stale?: boolean;
 }
 /** @see ContentModelField.ui */
 interface ContentModelFieldUi {
@@ -313,6 +317,12 @@ interface DockInputRef {
  * (an array zone field with its own `config.zones`) is supported.
  */
 type ZoneField = ContentModelField;
+/**
+ * Who wrote a help text or a description: the platform's generator (`auto`, rewritten whenever its
+ * wording improves), a person in the dashboard (`human`) or an agent over the API (`agent`). Only
+ * `auto` text is ever replaced. Server-owned: a client's copy is ignored.
+ */
+type HelpSource = "auto" | "human" | "agent";
 
 /**
  * Page — a published content page within a workspace.
@@ -1128,6 +1138,12 @@ interface LayoutFieldDefinition {
     } & Record<string, unknown>;
     /** Required for group/repeater; forbidden for scalar fields. */
     fields?: LayoutFieldDefinition[];
+    /** Shown to editors under the field. */
+    helpText?: string;
+    /** Server-owned: who wrote `helpText`. */
+    helpSource?: "auto" | "human" | "agent";
+    /** `true`: no route the last release inspected renders this field — hidden, never deleted. `false`: a person keeps it shown. */
+    stale?: boolean;
 }
 /** The canonical public input contract all variants in a group implement. */
 type CanonicalInputDefinition = LayoutFieldDefinition;
@@ -1175,6 +1191,10 @@ interface LayoutSection {
     reserved?: ReservedLayoutSection;
     fields: LayoutFieldDefinition[];
     items: LayoutSectionItem[];
+    /** What this Section is and which pages show it — for editors; no build reads it. */
+    description?: string;
+    /** Server-owned: who wrote `description`. */
+    helpSource?: "auto" | "human" | "agent";
     /**
      * The language this Section is a VARIANT for — BCP-47, lowercase (`fr`, `pt-br`).
      *
@@ -1339,6 +1359,7 @@ type ManagementLayoutCommand = {
     slug?: string;
     zone?: LayoutZone;
     orderKey?: string;
+    description?: string;
 } | {
     type: "remove-section";
     sectionId: string;
@@ -1559,6 +1580,8 @@ interface ComponentPropDef {
     required?: boolean;
     /** Hint shown under the control, muted. */
     helpText?: string;
+    /** Server-owned: who wrote `helpText`. */
+    helpSource?: "auto" | "human" | "agent";
     /** Ghost text inside a text-ish control. */
     placeholder?: string;
     /** Per-type settings; the save schema enforces that each is present on the type needing it. */
@@ -1597,6 +1620,8 @@ interface ComponentPropDef {
     uiOrigin?: UiOrigin;
     /** Server-owned revert point. @see UiBefore */
     uiBefore?: UiBefore;
+    /** `true`: no placement the last release inspected renders this prop — hidden, never deleted. `false`: a person keeps it shown. */
+    stale?: boolean;
 }
 /**
  * A top-level prop's dock group. Props have no fieldsets column, so the group rides inline: the
@@ -1624,6 +1649,7 @@ interface ComponentSubField {
     /** The same editor hints as the prop above, one level down. @see ComponentPropDef */
     required?: boolean;
     helpText?: string;
+    helpSource?: "auto" | "human" | "agent";
     placeholder?: string;
     options?: string[];
     /** CANONICAL. A nested `group`/`table`'s own sub-shape. */