@bettercms-ai/types 1.34.0 → 1.36.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,6 +241,8 @@ 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 */
@@ -315,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.
@@ -1130,6 +1138,10 @@ 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;
 }
@@ -1179,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`).
      *
@@ -1343,6 +1359,7 @@ type ManagementLayoutCommand = {
     slug?: string;
     zone?: LayoutZone;
     orderKey?: string;
+    description?: string;
 } | {
     type: "remove-section";
     sectionId: string;
@@ -1563,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. */
@@ -1630,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. */
@@ -1723,6 +1743,10 @@ interface Component {
  */
 interface DeliveryComponent {
     id: string;
+    /** The project the component belongs to. */
+    projectId?: string | null;
+    /** The component's preview image in the editor's library, when it has one. */
+    thumbnail?: string | null;
     name: string;
     slug: string;
     category: ComponentCategory;
@@ -1978,7 +2002,25 @@ interface DeliveryEntry<T = Record<string, unknown>> {
     status: "draft" | "published";
     publishedAt: string | null;
     updatedAt: string | null;
+    /**
+     * The entry's language (`null`: the site's default) and, on a translation, the id of the entry it
+     * translates. Served on every entry since localization shipped; absent from this type until the
+     * contract test (backend · src/__tests__/contracts/delivery-types.test.ts) held the two together.
+     */
+    locale?: string | null;
+    translationOf?: string | null;
+    /** Single-entry read only: the other languages of this entry. */
+    translations?: Array<{
+        id: string;
+        locale: string | null;
+        slug: string;
+    }>;
     data: T;
+    /** Only on a campaign entry: the account's section plan (ABM). */
+    _abm?: {
+        campaignId: string;
+        layout: unknown;
+    };
     /**
      * The entry's SEO, ready for `<head>`: its collection template's meta and JSON-LD with
      * `{{field}}` tokens already resolved for this entry, the entry's own values merged over it
@@ -2075,6 +2117,9 @@ interface DeliveryPage {
     layout?: DeliveredLayout | null;
     updatedAt: string | null;
     publishedAt: string | null;
+    /** The page's language (`null`: the site's default) and, on a translation, the page it translates. */
+    locale?: string | null;
+    translationOf?: string | null;
 }
 /** Generic paginated list envelope (the `data` of a list response). */
 interface DeliveryList<T> {
@@ -2085,6 +2130,8 @@ interface DeliveryList<T> {
     totalPages: number;
     hasNextPage: boolean;
     hasPreviousPage: boolean;
+    /** Entry lists only: the project the read was addressed to, when one was named or implied. */
+    projectId?: string | null;
 }
 
 /**