@rippling/rippling-sdk 0.2.0-alpha.49 → 0.2.0-alpha.50

package/src/lib/manifest/custom-object-page-layout.ts

@@ -11,6 +11,23 @@ export interface PageLayoutDeletionIdentifier {
   objectRqlName: string;
 }
 
+export type ObjectRqlName = string;
+export type BlueprintKey = string;
+export type LayoutApiName = string;
+export type TabKey = string;
+export type SectionKey = string;
+export type HeaderFieldKey = string;
+export type FieldRqlName = string;
+export type RelatedObjectRqlName = string;
+export type CanvasCompositionId = string;
+export type HeaderButtonKey = string;
+
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+export interface JsonObject {
+  [key: string]: JsonValue;
+}
+
 // ---------------------------------------------------------------------------
 // header_edits — HeaderEditsDTO
 // ---------------------------------------------------------------------------
@@ -18,7 +35,7 @@ export interface PageLayoutDeletionIdentifier {
 /** Edit to a built-in (system) header field. */
 export interface SystemHeaderFieldEdit {
   /** Replace the system field's RQL field reference. Optional. */
-  newRqlField?: string;
+  newRqlField?: FieldRqlName;
   /** Remove this system field from the header. Optional. */
   deleted?: boolean;
 }
@@ -31,9 +48,9 @@ export interface SystemHeaderFieldEdit {
  */
 export interface NewHeaderField {
   /** RQL field name to display. Required. */
-  rqlName: string;
+  rqlName: FieldRqlName;
   /** Stable key for this field. Required. */
-  key: string;
+  key: HeaderFieldKey;
   /** Whether the user can remove this field. Optional. */
   canBeDeleted?: boolean;
   /** Whether the user can swap this field for another. Optional. */
@@ -53,48 +70,93 @@ export interface NewHeaderField {
  */
 export interface HeaderEdits {
   /** Replace the record title field (pass the field's api_name). Optional. */
-  newTitleField?: string | null;
+  newTitleField?: FieldRqlName;
   /** Remove the title field from the header. Optional. */
   titleFieldDeleted?: boolean;
   /** Replace the record description field. Optional. */
-  newDescriptionField?: string | null;
+  newDescriptionField?: FieldRqlName;
   /** Remove the description field from the header. Optional. */
   descriptionFieldDeleted?: boolean;
   /** Edits to built-in system header fields, keyed by system field key. Optional. */
-  systemFieldEdits?: Record<string, SystemHeaderFieldEdit>;
+  systemFieldEdits?: Record<HeaderFieldKey, SystemHeaderFieldEdit>;
   /** Additional custom fields to add to the header. Optional. */
   newFields?: NewHeaderField[];
   /** Ordered list of header field RQL names. Custom header keys are accepted and converted. Optional. */
-  headerFieldsOrder?: string[];
+  headerFieldsOrder?: FieldRqlName[];
   /** Action button keys to show in the header. Optional. */
-  buttons?: string[];
+  buttons?: HeaderButtonKey[];
+}
+
+interface SerializedSystemHeaderFieldEdit extends Omit<SystemHeaderFieldEdit, 'newRqlField'> {
+  newRqlField?: FieldRqlName | null;
+}
+
+interface SerializedHeaderEdits
+  extends Omit<HeaderEdits, 'newTitleField' | 'newDescriptionField' | 'systemFieldEdits'> {
+  newTitleField?: FieldRqlName | null;
+  newDescriptionField?: FieldRqlName | null;
+  systemFieldEdits?: Record<HeaderFieldKey, SerializedSystemHeaderFieldEdit>;
 }
 
 // ---------------------------------------------------------------------------
 // tab_edits — TabEditsDTO + section/tab DTOs
 // ---------------------------------------------------------------------------
 
+export type SectionFieldsLayout = 'one_column' | 'two_column' | 'three_column' | 'responsive';
+export type TabLayout = 'vertical' | 'horizontal';
+export type SectionMovementOption = 'static' | 'tab' | 'free';
+export type FieldMovementOption = 'tab' | 'free';
+export type CustomObjectCustomSectionComponentKey = 'attachments' | 'comments';
+
+/** Default value wrapper used by `SectionField.defaultValue`. */
+export interface SectionFieldDefaultValue {
+  value: JsonValue;
+}
+
 /** Options for one field entry inside a `fields_section`. */
 export interface SectionFieldOptions {
   /** Hide this field from view. Optional. */
   hidden?: boolean;
   /** Allow inline editing of this field. Optional. */
   editable?: boolean;
+  /** Render this field read-only. Optional. */
+  readOnly?: boolean;
+  /** Default value metadata for the field. Optional. */
+  defaultValue?: SectionFieldDefaultValue;
+  /** Rich-text field height. Optional. */
+  height?: number;
+  /** Whether the layout manager can remove this field. Optional. */
+  canBeDeleted?: boolean;
   /** Controls how the field can be moved in the UI. Optional. */
-  movementOption?: 'tab' | 'free';
+  movementOption?: FieldMovementOption;
 }
 
 /** A typed field entry inside a `fields_section`. */
-export interface SectionFieldRef extends SectionFieldOptions {
+export interface SectionField extends SectionFieldOptions {
   /** Field to display. Required. */
   field: Field;
 }
 
+/** @deprecated Use `SectionField` for object entries or `SectionFieldInput` for field arrays. */
+export type SectionFieldRef = SectionField;
+
 /** One field entry inside a `fields_section`. */
-export type SectionField = Field | SectionFieldRef;
+export type SectionFieldInput = Field | SectionField;
+
+/** Common edit controls for sections. */
+export interface PageLayoutSectionOptions {
+  /** Whether the layout manager can delete this section. Optional. */
+  canBeDeleted?: boolean;
+  /** Whether the layout manager can rename this section. Optional. */
+  canBeRenamed?: boolean;
+  /** Controls how the section can be moved. Optional. */
+  movementOption?: SectionMovementOption;
+  /** Hide the section title. Optional. */
+  hideName?: boolean;
+}
 
 /** A standard field-grid section inside a tab. */
-export interface FieldsSection {
+export interface FieldsSection extends PageLayoutSectionOptions {
   type: 'fields_section';
   /** Field section metadata for the fields displayed in this layout section. Required. */
   section: CustomObjectFieldSection;
@@ -103,24 +165,105 @@ export interface FieldsSection {
   /** Display name of the layout section. Optional. Defaults to the field section name. */
   name?: string;
   /** Fields to display in this section. Required. */
-  fields: SectionField[];
+  fields: SectionFieldInput[];
   /** Column layout for the fields. Optional. @default `'responsive'` (backend default). */
   layout?: SectionFieldsLayout;
 }
 
-/**
- * A section inside a page layout tab.
- *
- * Only `fields_section` is modeled today. Add other section types
- * (`related_object_section`, `custom_section`, …) explicitly as needed.
- */
-export type PageLayoutSection = FieldsSection;
+export interface RelatedObjectSection extends PageLayoutSectionOptions {
+  type: 'related_object_section';
+  /** Stable layout section key. Required. */
+  key: SectionKey;
+  /** Display name of the layout section. Required. */
+  name: string;
+  /** Related object whose records point back to this custom object. Required. */
+  relatedObjectRqlName: RelatedObjectRqlName;
+  /** Field on the related object that points back to this custom object. Required. */
+  relatedFieldRqlName: FieldRqlName;
+  /** Field RQL names to display for related records. Required. */
+  fields: FieldRqlName[];
+}
+
+export interface RelatedFieldSection extends PageLayoutSectionOptions {
+  type: 'related_field_section';
+  /** Stable layout section key. Required. */
+  key: SectionKey;
+  /** Display name of the layout section. Required. */
+  name: string;
+  /** Related object reached from this custom object. Required. */
+  relatedObjectRqlName: RelatedObjectRqlName;
+  /** Field on this custom object that points to the related object. Required. */
+  relatedFieldRqlName: FieldRqlName;
+  /** Field RQL names to display from the related object. Required. */
+  fields: FieldRqlName[];
+  /** Column layout for the fields. Optional. @default `'responsive'` (backend default). */
+  layout?: SectionFieldsLayout;
+}
+
+export interface CustomSection extends PageLayoutSectionOptions {
+  type: 'custom_section';
+  /** Stable layout section key. Required. */
+  key: SectionKey;
+  /** Display name of the layout section. Required. */
+  name: string;
+  /** Custom object section component key. Required. */
+  componentKey: CustomObjectCustomSectionComponentKey;
+}
+
+export interface ResizableLayoutPosition {
+  identifier: string;
+  width: number;
+  height: number;
+  minWidth?: number;
+  minHeight?: number;
+  maxWidth?: number;
+  maxHeight?: number;
+}
+
+export interface ReportsSectionItem {
+  key: string;
+  reportId: string;
+  position: ResizableLayoutPosition;
+  contextualFieldAttrName?: FieldRqlName;
+  visualizationType?: string;
+}
+
+export interface ReportsSection extends PageLayoutSectionOptions {
+  type: 'reports_section';
+  /** Stable layout section key. Required. */
+  key: SectionKey;
+  /** Display name of the layout section. Required. */
+  name: string;
+  /** Reports to display in this section. Required. */
+  reports: ReportsSectionItem[];
+}
+
+export interface CanvasSection extends PageLayoutSectionOptions {
+  type: 'canvas_section';
+  /** Stable layout section key. Required. */
+  key: SectionKey;
+  /** Display name of the layout section. Required. */
+  name: string;
+  /** Canvas composition to render. Required. */
+  canvasCompositionId: CanvasCompositionId;
+  /** Composition input name to field or state path mapping. Optional. */
+  inputMapping?: Record<string, string>;
+}
+
+/** A section inside a page layout tab. */
+export type PageLayoutSection =
+  | FieldsSection
+  | RelatedObjectSection
+  | RelatedFieldSection
+  | CustomSection
+  | ReportsSection
+  | CanvasSection;
 
 /** A tab that contains one or more field-grid sections. */
 export interface TabWithSections {
   type: 'tab_with_sections';
   /** Stable key for this tab. Required. */
-  key: string;
+  key: TabKey;
   /** Display name of the tab. Required. */
   name: string;
   /** Sections inside this tab. Required. */
@@ -131,7 +274,7 @@ export interface TabWithSections {
 export interface CustomTab {
   type: 'custom_tab';
   /** Stable key for this tab. Required. */
-  key: string;
+  key: TabKey;
   /** Display name of the tab. Required. */
   name: string;
   /** Key of the custom component to render. Required. */
@@ -142,8 +285,6 @@ export interface CustomTab {
 export type PageLayoutTab = TabWithSections | CustomTab;
 
 /** Column layout for a `fields_section`. */
-export type SectionFieldsLayout = 'one_column' | 'two_column' | 'three_column' | 'responsive';
-
 /** Edits to a built-in section inside a system tab. */
 export interface SystemSectionEdit {
   /** Rename this section. Optional. */
@@ -153,7 +294,7 @@ export interface SystemSectionEdit {
   /** Change the column layout. Optional. */
   newLayout?: SectionFieldsLayout;
   /** Add fields to this section. Optional. */
-  newFields?: SectionField[];
+  newFields?: SectionFieldInput[];
   /** Hide the section name header. Optional. */
   newHideName?: boolean;
 }
@@ -167,9 +308,9 @@ export interface SystemTabEdit {
   /** Add new sections to this tab. Optional. */
   newSections?: PageLayoutSection[];
   /** Edits to built-in sections inside this tab, keyed by section key. Optional. */
-  systemSectionEdits?: Record<string, SystemSectionEdit>;
+  systemSectionEdits?: Record<SectionKey, SystemSectionEdit>;
   /** Reorder sections by key. Optional. */
-  sectionsOrder?: string[];
+  sectionsOrder?: SectionKey[];
 }
 
 /**
@@ -184,11 +325,11 @@ export interface TabEdits {
   /** New tabs to add to this layout. Each must include a `type` discriminator. Optional. */
   newTabs?: PageLayoutTab[];
   /** Edits to existing system tabs, keyed by tab key. Optional. */
-  systemTabEdits?: Record<string, SystemTabEdit>;
+  systemTabEdits?: Record<TabKey, SystemTabEdit>;
   /** Ordered list of tab `key` values (new + system). Optional. */
-  tabsOrder?: string[];
+  tabsOrder?: TabKey[];
   /** Tab strip orientation. Optional. */
-  newTabLayout?: 'vertical' | 'horizontal';
+  newTabLayout?: TabLayout;
 }
 
 // ---------------------------------------------------------------------------
@@ -205,7 +346,7 @@ export interface VisibilityCondition {
   /** RQL formula that controls visibility. Required. */
   rqlFormula: string;
   /** Layered conditions tree (AST). Required. */
-  layeredConditionsTree: Record<string, any>;
+  layeredConditionsTree: JsonObject;
 }
 
 /**
@@ -215,9 +356,9 @@ export interface VisibilityCondition {
  */
 export interface VisibilityConditions {
   /** Per-section visibility conditions, keyed by section key. Optional. */
-  sections?: Record<string, VisibilityCondition>;
+  sections?: Record<SectionKey, VisibilityCondition>;
   /** Per-tab visibility conditions, keyed by tab key. Optional. */
-  tabs?: Record<string, VisibilityCondition>;
+  tabs?: Record<TabKey, VisibilityCondition>;
 }
 
 // ---------------------------------------------------------------------------
@@ -455,7 +596,7 @@ interface SerializedSectionField extends SectionFieldOptions {
   fieldRqlName: string;
 }
 
-interface SerializedFieldsSection {
+interface SerializedFieldsSection extends PageLayoutSectionOptions {
   key?: string;
   type: 'fields_section';
   name: string;
@@ -463,11 +604,19 @@ interface SerializedFieldsSection {
   layout?: SectionFieldsLayout;
 }
 
+type SerializedPageLayoutSection =
+  | SerializedFieldsSection
+  | RelatedObjectSection
+  | RelatedFieldSection
+  | CustomSection
+  | ReportsSection
+  | CanvasSection;
+
 interface SerializedTabWithSections {
   type: 'tab_with_sections';
   key: string;
   name: string;
-  sections: SerializedFieldsSection[];
+  sections: SerializedPageLayoutSection[];
 }
 
 type SerializedPageLayoutTab = SerializedTabWithSections | CustomTab;
@@ -477,7 +626,7 @@ interface SerializedSystemSectionEdit extends Omit<SystemSectionEdit, 'newFields
 }
 
 interface SerializedSystemTabEdit extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
-  newSections?: SerializedFieldsSection[];
+  newSections?: SerializedPageLayoutSection[];
   systemSectionEdits?: Record<string, SerializedSystemSectionEdit>;
 }
 
@@ -502,7 +651,7 @@ function isField(value: unknown): value is Field {
   );
 }
 
-function isFieldRef(value: SectionField): value is SectionFieldRef {
+function isFieldRef(value: SectionFieldInput): value is SectionField {
   const candidate = value as { field?: unknown } | null;
   return candidate != null && typeof candidate === 'object' && isField(candidate.field);
 }
@@ -528,22 +677,26 @@ function attachFieldSectionId(section: SerializedFieldsSection, sectionId: strin
   return section;
 }
 
-function layoutSectionKey(section: SerializedFieldsSection): string | undefined {
+function layoutSectionKey(section: { key?: string }): string | undefined {
   return (
     section.key ??
     (section as unknown as Record<typeof FIELD_SECTION_ID, string | undefined>)[FIELD_SECTION_ID]
   );
 }
 
-function layoutSectionMatches(section: SerializedFieldsSection, sectionKey: string): boolean {
+function layoutSectionMatches(section: { key?: string }, sectionKey: string): boolean {
   return layoutSectionKey(section) === sectionKey;
 }
 
-function inputFieldsSectionHasKey(input: PageLayoutSection): boolean {
+function inputFieldsSectionHasKey(input: FieldsSection): boolean {
   const record = input as unknown as Record<string, unknown>;
   return Object.prototype.hasOwnProperty.call(record, 'key') && record['key'] != null;
 }
 
+function isSerializedFieldsSection(section: SerializedPageLayoutSection): section is SerializedFieldsSection {
+  return section.type === 'fields_section';
+}
+
 function assertSameObject(customObject: CustomObject, field: Field, sectionKey: string): void {
   if (field.getCustomObjectApiName() !== customObject.getApiName()) {
     throw new Error(
@@ -585,15 +738,30 @@ function toSerializedSectionField(
   const normalized: SerializedSectionField = { fieldRqlName };
   if (options.hidden != null) normalized.hidden = options.hidden;
   if (options.editable != null) normalized.editable = options.editable;
+  if (options.readOnly != null) normalized.readOnly = options.readOnly;
+  if (options.defaultValue != null) normalized.defaultValue = options.defaultValue;
+  if (options.height != null) normalized.height = options.height;
+  if (options.canBeDeleted != null) normalized.canBeDeleted = options.canBeDeleted;
   if (options.movementOption != null) normalized.movementOption = options.movementOption;
   return normalized;
 }
 
+function copySectionOptions<T extends PageLayoutSectionOptions>(
+  target: T,
+  input: PageLayoutSectionOptions,
+): T {
+  if (input.canBeDeleted != null) target.canBeDeleted = input.canBeDeleted;
+  if (input.canBeRenamed != null) target.canBeRenamed = input.canBeRenamed;
+  if (input.movementOption != null) target.movementOption = input.movementOption;
+  if (input.hideName != null) target.hideName = input.hideName;
+  return target;
+}
+
 function normalizeSectionField(
   customObject: CustomObject,
   section: CustomObjectFieldSection | string,
   sectionKey: string,
-  entry: SectionField,
+  entry: SectionFieldInput,
 ): SerializedSectionField {
   if (isField(entry)) {
     assertSameObject(customObject, entry, sectionKey);
@@ -613,30 +781,40 @@ function normalizeSectionField(
   );
 }
 
-function normalizeFieldsSection(
-  customObject: CustomObject,
-  input: PageLayoutSection,
-): SerializedFieldsSection {
+function normalizeFieldsSection(customObject: CustomObject, input: FieldsSection): SerializedFieldsSection {
   assertSectionBelongsTo(customObject, input.section);
   const sectionId = input.section.getSectionId();
   if (inputFieldsSectionHasKey(input)) {
     throw new Error('CustomObjectPageLayout fields_section key is not supported. Omit key.');
   }
   const name = input.name ?? input.section.getName();
-  const normalized: SerializedFieldsSection = {
-    name,
-    type: 'fields_section',
-    fields: input.fields.map((field) => normalizeSectionField(customObject, input.section, sectionId, field)),
-  };
+  const normalized = copySectionOptions<SerializedFieldsSection>(
+    {
+      name,
+      type: 'fields_section',
+      fields: input.fields.map((field) =>
+        normalizeSectionField(customObject, input.section, sectionId, field),
+      ),
+    },
+    input,
+  );
   if (input.layout != null) normalized.layout = input.layout;
   return attachFieldSectionId(normalized, sectionId);
 }
 
+function normalizeSection(
+  customObject: CustomObject,
+  section: PageLayoutSection,
+): SerializedPageLayoutSection {
+  if (section.type === 'fields_section') return normalizeFieldsSection(customObject, section);
+  return { ...section };
+}
+
 function normalizeTab(customObject: CustomObject, tab: PageLayoutTab): SerializedPageLayoutTab {
   if (tab.type === 'custom_tab') return tab;
   return {
     ...tab,
-    sections: tab.sections.map((section) => normalizeFieldsSection(customObject, section)),
+    sections: tab.sections.map((section) => normalizeSection(customObject, section)),
   };
 }
 
@@ -664,7 +842,7 @@ function normalizeSystemTabEdit(
   const { newSections: _newSections, systemSectionEdits: _systemSectionEdits, ...rest } = edit;
   const normalized: SerializedSystemTabEdit = { ...rest };
   if (edit.newSections != null) {
-    normalized.newSections = edit.newSections.map((section) => normalizeFieldsSection(customObject, section));
+    normalized.newSections = edit.newSections.map((section) => normalizeSection(customObject, section));
   }
   if (edit.systemSectionEdits != null) {
     const systemSectionEdits: Record<string, SerializedSystemSectionEdit> = {};
@@ -730,7 +908,7 @@ function assertKnownKeys(
   }
 }
 
-function normalizeHeaderEdits(headerEdits: HeaderEdits): HeaderEdits {
+function normalizeHeaderEdits(headerEdits: HeaderEdits): SerializedHeaderEdits {
   assertKnownKeys(
     headerEdits as unknown as Record<string, unknown>,
     HEADER_EDIT_KEYS,
@@ -756,6 +934,27 @@ function normalizeHeaderEdits(headerEdits: HeaderEdits): HeaderEdits {
     );
   }
 
+  if (headerEdits.newTitleField === '') {
+    throw new Error(
+      'CustomObjectPageLayout headerEdits.newTitleField cannot be empty. Use titleFieldDeleted.',
+    );
+  }
+  if (headerEdits.newDescriptionField === '') {
+    throw new Error(
+      'CustomObjectPageLayout headerEdits.newDescriptionField cannot be empty. Use descriptionFieldDeleted.',
+    );
+  }
+  if (headerEdits.newTitleField != null && headerEdits.titleFieldDeleted === true) {
+    throw new Error(
+      'CustomObjectPageLayout headerEdits cannot both set newTitleField and titleFieldDeleted.',
+    );
+  }
+  if (headerEdits.newDescriptionField != null && headerEdits.descriptionFieldDeleted === true) {
+    throw new Error(
+      'CustomObjectPageLayout headerEdits cannot both set newDescriptionField and descriptionFieldDeleted.',
+    );
+  }
+
   if (headerEdits.headerFieldsOrder == null) return headerEdits;
   return {
     ...headerEdits,
@@ -768,13 +967,13 @@ function addUniqueHeaderOrderField(order: string[], field: unknown): void {
   if (!order.includes(field)) order.push(field);
 }
 
-function normalizeHeaderFieldsOrder(headerEdits: HeaderEdits): string[] {
+function normalizeHeaderFieldsOrder(headerEdits: SerializedHeaderEdits): string[] {
   const customFieldRqlByKey = new Map(
     (headerEdits.newFields ?? []).map((field) => [field.key, field.rqlName]),
   );
   const systemFieldRqlByKey = new Map(
     Object.entries(headerEdits.systemFieldEdits ?? {})
-      .filter((entry): entry is [string, SystemHeaderFieldEdit & { newRqlField: string }] => {
+      .filter((entry): entry is [string, SerializedSystemHeaderFieldEdit & { newRqlField: string }] => {
         const [, edit] = entry;
         return typeof edit.newRqlField === 'string' && edit.newRqlField.length > 0;
       })
@@ -894,13 +1093,19 @@ function annotateLoadedTabEdits(
 ): SerializedTabEdits {
   for (const tab of tabEdits.newTabs ?? []) {
     if (!isTabWithSections(tab)) continue;
-    tab.sections = tab.sections.map((section) => annotateLoadedFieldsSection(section, resolveFieldSectionId));
+    tab.sections = tab.sections.map((section) =>
+      isSerializedFieldsSection(section) ?
+        annotateLoadedFieldsSection(section, resolveFieldSectionId)
+      : section,
+    );
   }
 
   for (const tabEdit of Object.values(tabEdits.systemTabEdits ?? {})) {
     if (tabEdit.newSections != null) {
       tabEdit.newSections = tabEdit.newSections.map((section) =>
-        annotateLoadedFieldsSection(section, resolveFieldSectionId),
+        isSerializedFieldsSection(section) ?
+          annotateLoadedFieldsSection(section, resolveFieldSectionId)
+        : section,
       );
     }
   }
@@ -1020,7 +1225,7 @@ export class CustomObjectPageLayout {
   private readonly _customObjectApiName: string;
   private readonly _name: string;
   private readonly _tabEdits: SerializedTabEdits;
-  private readonly _headerEdits: HeaderEdits;
+  private readonly _headerEdits: SerializedHeaderEdits;
   private readonly _visibilityConditions: VisibilityConditions;
   private readonly _blueprintKey: string | undefined;
 
@@ -1280,7 +1485,7 @@ export class CustomObjectPageLayout {
     const normalized = this.normalizeSectionForMutation(section);
     if (options.systemTab === true) {
       const tabEdit = this.ensureSystemTabEdit(options.tabKey);
-      const sections = ensureArrayProperty<SerializedFieldsSection>(
+      const sections = ensureArrayProperty<SerializedPageLayoutSection>(
         tabEdit as Record<string, any>,
         'newSections',
         `systemTabEdits.${options.tabKey}.newSections`,
@@ -1346,7 +1551,7 @@ export class CustomObjectPageLayout {
     this.assertFieldSectionBelongsToLayout(section);
     const sectionKey = section.getSectionId();
     const matches: Array<{
-      sections: SerializedFieldsSection[];
+      sections: SerializedPageLayoutSection[];
       section: SerializedFieldsSection;
       index: number;
       tabEdit?: SerializedSystemTabEdit;
@@ -1356,14 +1561,14 @@ export class CustomObjectPageLayout {
       if (!isTabWithSections(tab)) continue;
       if (options.tabKey != null && tab.key !== options.tabKey) continue;
       tab.sections.forEach((section, index) => {
-        if (layoutSectionMatches(section, sectionKey))
+        if (isSerializedFieldsSection(section) && layoutSectionMatches(section, sectionKey))
           matches.push({ sections: tab.sections, section, index, tabKey: tab.key });
       });
     }
     for (const [tabKey, tabEdit] of Object.entries(this._tabEdits.systemTabEdits ?? {})) {
       if (options.tabKey != null && tabKey !== options.tabKey) continue;
       (tabEdit.newSections ?? []).forEach((section, index) => {
-        if (layoutSectionMatches(section, sectionKey))
+        if (isSerializedFieldsSection(section) && layoutSectionMatches(section, sectionKey))
           matches.push({ sections: tabEdit.newSections!, section, index, tabEdit, tabKey });
       });
     }
@@ -1380,7 +1585,7 @@ export class CustomObjectPageLayout {
     }
 
     const removals = removeAll ? matches : matches.slice(0, 1);
-    const byArray = new Map<SerializedFieldsSection[], number[]>();
+    const byArray = new Map<SerializedPageLayoutSection[], number[]>();
     for (const match of removals) {
       const indexes = byArray.get(match.sections) ?? [];
       indexes.push(match.index);
@@ -1474,11 +1679,13 @@ export class CustomObjectPageLayout {
   }
 
   /** Sets the record title field in `header_edits`. */
-  setTitleField(field: Field | string | null): this {
+  setTitleField(field: Field): this;
+  setTitleField(fieldApiName: FieldRqlName): this;
+  setTitleField(field: Field | FieldRqlName): this {
     const previousTitleField = this._headerEdits.newTitleField;
     const nextTitleField = this.headerFieldApiName(field);
     this._headerEdits.newTitleField = nextTitleField;
-    if (field != null) this._headerEdits.titleFieldDeleted = false;
+    this._headerEdits.titleFieldDeleted = false;
     insertUniqueAt(this.ensureHeaderFieldsOrder(), nextTitleField, 'end');
     this.removeHeaderOrderFieldIfUnused(previousTitleField);
     return this;
@@ -1494,11 +1701,13 @@ export class CustomObjectPageLayout {
   }
 
   /** Sets the record description field in `header_edits`. */
-  setDescriptionField(field: Field | string | null): this {
+  setDescriptionField(field: Field): this;
+  setDescriptionField(fieldApiName: FieldRqlName): this;
+  setDescriptionField(field: Field | FieldRqlName): this {
     const previousDescriptionField = this._headerEdits.newDescriptionField;
     const nextDescriptionField = this.headerFieldApiName(field);
     this._headerEdits.newDescriptionField = nextDescriptionField;
-    if (field != null) this._headerEdits.descriptionFieldDeleted = false;
+    this._headerEdits.descriptionFieldDeleted = false;
     insertUniqueAt(this.ensureHeaderFieldsOrder(), nextDescriptionField, 'end');
     this.removeHeaderOrderFieldIfUnused(previousDescriptionField);
     return this;
@@ -1571,7 +1780,7 @@ export class CustomObjectPageLayout {
   private normalizeSectionFieldForMutation(
     section: CustomObjectFieldSection | string,
     sectionKey: string,
-    entry: SectionField,
+    entry: SectionFieldInput,
   ): SerializedSectionField {
     if (isField(entry)) {
       this.assertFieldBelongsToLayout(entry);
@@ -1591,7 +1800,9 @@ export class CustomObjectPageLayout {
     );
   }
 
-  private normalizeSectionForMutation(input: PageLayoutSection): SerializedFieldsSection {
+  private normalizeSectionForMutation(input: PageLayoutSection): SerializedPageLayoutSection {
+    if (input.type !== 'fields_section') return { ...input };
+
     this.assertFieldSectionBelongsToLayout(input.section);
 
     const sectionId = input.section.getSectionId();
@@ -1599,13 +1810,16 @@ export class CustomObjectPageLayout {
       throw new Error('CustomObjectPageLayout fields_section key is not supported. Omit key.');
     }
     const name = input.name ?? input.section.getName();
-    const normalized: SerializedFieldsSection = {
-      name,
-      type: 'fields_section',
-      fields: input.fields.map((field) =>
-        this.normalizeSectionFieldForMutation(input.section, sectionId, field),
-      ),
-    };
+    const normalized = copySectionOptions<SerializedFieldsSection>(
+      {
+        name,
+        type: 'fields_section',
+        fields: input.fields.map((field) =>
+          this.normalizeSectionFieldForMutation(input.section, sectionId, field),
+        ),
+      },
+      input,
+    );
     if (input.layout != null) normalized.layout = input.layout;
     return attachFieldSectionId(normalized, sectionId);
   }
@@ -1738,6 +1952,7 @@ export class CustomObjectPageLayout {
         if (!isTabWithSections(tab)) continue;
         if (filter.tabKey != null && tab.key !== filter.tabKey) continue;
         for (const [index, section] of tab.sections.entries()) {
+          if (!isSerializedFieldsSection(section)) continue;
           const sectionKey = layoutSectionKey(section);
           if (filter.sectionKey != null && !layoutSectionMatches(section, filter.sectionKey)) continue;
           const label = sectionKey == null ? `${tab.key}.sections[${index}]` : `${tab.key}.${sectionKey}`;
@@ -1758,6 +1973,7 @@ export class CustomObjectPageLayout {
       for (const [tabKey, tabEdit] of Object.entries(this._tabEdits.systemTabEdits ?? {})) {
         if (filter.tabKey != null && tabKey !== filter.tabKey) continue;
         for (const [index, section] of (tabEdit.newSections ?? []).entries()) {
+          if (!isSerializedFieldsSection(section)) continue;
           const sectionKey = layoutSectionKey(section);
           if (filter.sectionKey != null && !layoutSectionMatches(section, filter.sectionKey)) continue;
           const label = sectionKey == null ? `${tabKey}.newSections[${index}]` : `${tabKey}.${sectionKey}`;
@@ -1870,7 +2086,7 @@ export class CustomObjectPageLayout {
   }
 
   private assertSectionKeyAvailable(
-    sections: SerializedFieldsSection[],
+    sections: SerializedPageLayoutSection[],
     sectionKey: string | undefined,
     tabKey: string,
     allowDuplicate: boolean | undefined,
@@ -1903,8 +2119,7 @@ export class CustomObjectPageLayout {
     return normalized;
   }
 
-  private headerFieldApiName(field: Field | string | null): string | null {
-    if (field == null) return null;
+  private headerFieldApiName(field: Field | FieldRqlName): FieldRqlName {
     if (typeof field === 'string') return field;
     this.assertFieldBelongsToLayout(field);
     return field.getApiName();