@rippling/rippling-sdk 0.2.0-alpha.39 → 0.2.0-alpha.41

package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts

@@ -0,0 +1,240 @@
+/*
+ * Existing manifest mutations.
+ *
+ * This example keeps the existing manifest JSON inline, hydrates it back into
+ * SDK objects, removes layout content, adds different layout content, and
+ * prints the updated manifest JSON.
+ *
+ * Run:
+ *   yarn -s tsn examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts \
+ *       > examples/manifest/existing-manifest-mutations/manifest.updated.json
+ */
+
+import {
+  CustomObject,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  type ExistingManifest,
+  ManifestBuilder,
+  SelectField,
+  TextField,
+} from '@rippling/rippling-sdk/lib/manifest';
+
+const existingManifestJson: ExistingManifest = {
+  metadata: {
+    key: 'gym_membership_management',
+    name: 'Gym Membership Management',
+    description: 'Small inline manifest used by the existing-manifest mutation example',
+  },
+  components: [
+    {
+      type: 'CUSTOM_CATEGORY',
+      api_name: 'gym__c',
+      name: 'Gym',
+      description: 'Memberships, staff, schedules, and attendance',
+    },
+    {
+      type: 'CUSTOM_OBJECT',
+      api_name: 'gym_member__c',
+      name: 'Member',
+      plural_label: 'Members',
+      category_api_name: 'gym__c',
+      description: 'Gym member profile, contact, and membership status',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD_SECTION',
+      section_id: 'sec_gm_profile',
+      model_name: 'gym_member__c',
+      name: 'Profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD_SECTION',
+      section_id: 'sec_gm_membership',
+      model_name: 'gym_member__c',
+      name: 'Membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'first_name__c',
+      field_display_name: 'First name',
+      data_type: { field_type: 'TEXT', max_length: 80 },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'last_name__c',
+      field_display_name: 'Last name',
+      data_type: { field_type: 'TEXT', max_length: 80 },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'phone__c',
+      field_display_name: 'Phone',
+      data_type: { field_type: 'PHONE_NUMBER' },
+      is_required: false,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'membership_status__c',
+      field_display_name: 'Membership status',
+      data_type: { field_type: 'SELECT', options_list: ['Active', 'Frozen', 'Cancelled', 'Trial'] },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'join_date__c',
+      field_display_name: 'Join date',
+      data_type: { field_type: 'DATE' },
+      is_required: false,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_PAGE_LAYOUT',
+      layout_id: 'layout_gym_member',
+      api_name: 'default',
+      object_rql_name: 'gym_member__c',
+      name: 'Member',
+      system_created: false,
+      tab_edits: {
+        newTabs: [
+          {
+            key: 'member',
+            name: 'Member',
+            type: 'tab_with_sections',
+            sections: [
+              {
+                key: 'profile',
+                name: 'Profile',
+                type: 'fields_section',
+                fields: [
+                  { fieldRqlName: 'first_name__c' },
+                  { fieldRqlName: 'last_name__c' },
+                  { fieldRqlName: 'phone__c' },
+                ],
+              },
+              {
+                key: 'membership',
+                name: 'Membership',
+                type: 'fields_section',
+                fields: [{ fieldRqlName: 'membership_status__c' }, { fieldRqlName: 'join_date__c' }],
+              },
+            ],
+          },
+        ],
+        systemTabEdits: {},
+        tabsOrder: ['member'],
+      },
+      header_edits: {
+        newTitleField: 'first_name__c',
+        newDescriptionField: 'membership_status__c',
+      },
+      visibility_conditions: {},
+      blueprint_key: 'gym_member__c',
+    },
+  ],
+};
+
+const manifest = ManifestBuilder.loadFromExistingJson(existingManifestJson);
+const memberObj = CustomObject.loadFromExisting('gym_member__c');
+const profileSection = CustomObjectFieldSection.loadFromExisting('sec_gm_profile', {
+  customObjectApiName: memberObj.getApiName(),
+});
+const memberLayout = CustomObjectPageLayout.loadFromExisting('layout_gym_member', {
+  customObjectApiName: memberObj.getApiName(),
+});
+
+const preferredName = new TextField(memberObj, {
+  apiName: 'preferred_name__c',
+  displayName: 'Preferred name',
+  maxLength: 80,
+  section: profileSection,
+});
+
+// Remove an existing field from one section, then add a different field there.
+// The removed field component remains in the manifest; only this layout stops
+// rendering it.
+memberLayout
+  .removeField('phone__c', {
+    tabKey: 'member',
+    sectionKey: 'profile',
+    removeAll: false,
+  })
+  .addField(preferredName, {
+    tabKey: 'member',
+    sectionKey: 'profile',
+    fieldSection: profileSection,
+    position: 2,
+  });
+
+const marketingSection = new CustomObjectFieldSection(memberObj, {
+  sectionId: 'sec_gm_marketing',
+  name: 'Marketing',
+});
+const marketingOptIn = new SelectField(memberObj, {
+  apiName: 'marketing_opt_in__c',
+  displayName: 'Marketing opt-in',
+  options: ['Yes', 'No', 'Unknown'],
+  section: marketingSection,
+});
+const referralSource = new TextField(memberObj, {
+  apiName: 'referral_source__c',
+  displayName: 'Referral source',
+  maxLength: 120,
+  section: marketingSection,
+});
+
+// Remove one existing section from the layout, then add a different one.
+// The removed section component and its fields remain in the manifest.
+memberLayout
+  .removeSection('membership', {
+    tabKey: 'member',
+    removeAll: false,
+  })
+  .addSection(
+    {
+      key: 'marketing',
+      name: 'Marketing',
+      type: 'fields_section',
+      section: marketingSection,
+      fields: [marketingOptIn, referralSource],
+      layout: 'two_column',
+    },
+    {
+      tabKey: 'member',
+      position: 'end',
+    },
+  )
+  .addHeaderField(preferredName, {
+    key: 'preferred_name_header',
+    canBeDeleted: true,
+    canBeMoved: true,
+  })
+  .setTitleField(preferredName)
+  .removeDescriptionField();
+
+console.log(manifest.preview());

package/lib/manifest/custom-object-page-layout.d.mts

@@ -187,6 +187,116 @@ export interface VisibilityConditions {
     /** Per-tab visibility conditions, keyed by tab key. Optional. */
     tabs?: Record<string, VisibilityCondition>;
 }
+/** Where to insert a new layout item. Defaults to `'end'`. */
+export type PageLayoutMutationPosition = 'start' | 'end' | number;
+/** Options for adding a field to an existing layout section. */
+export interface AddPageLayoutFieldOptions extends SectionFieldOptions {
+    /**
+     * Tab key containing the target section. Optional when `sectionKey` is unique
+     * across the layout.
+     */
+    tabKey?: string;
+    /** Section key to add the field to. Required. */
+    sectionKey: string;
+    /**
+     * Field-section metadata to assign to the field component.
+     *
+     * Existing layouts often use layout section keys that differ from field section
+     * ids. Pass this when the field was not constructed with a `section`.
+     */
+    fieldSection?: CustomObjectFieldSection;
+    /** Insert position inside the section field list. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow the same field to appear twice in the same section. Optional. @default false */
+    allowDuplicate?: boolean;
+    /**
+     * Add to a built-in system section via `systemTabEdits`.
+     *
+     * When true, `tabKey` is required and the edit is created if it does not
+     * already exist.
+     */
+    systemSection?: boolean;
+}
+/** Options for adding multiple fields to an existing layout section. */
+export type AddPageLayoutFieldsOptions = AddPageLayoutFieldOptions;
+/** Options for removing fields from a layout. */
+export interface RemovePageLayoutFieldOptions {
+    /** Limit removal to one tab. Optional. */
+    tabKey?: string;
+    /** Limit removal to one section. Optional. */
+    sectionKey?: string;
+    /**
+     * Remove all matching occurrences. When false, removing a field that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Remove from a built-in system section edit. Optional. */
+    systemSection?: boolean;
+}
+/** Options for adding a section to an existing tab. */
+export interface AddPageLayoutSectionOptions {
+    /** Tab key to add the section to. Required. */
+    tabKey: string;
+    /** Insert position inside the tab. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another section with the same key in the same tab. Optional. @default false */
+    allowDuplicate?: boolean;
+    /**
+     * Add to a built-in system tab via `systemTabEdits.newSections`.
+     *
+     * When false, the tab must already be present in `newTabs`.
+     */
+    systemTab?: boolean;
+}
+/** Options for removing sections from a layout. */
+export interface RemovePageLayoutSectionOptions {
+    /** Limit removal to one tab. Optional. */
+    tabKey?: string;
+    /**
+     * Remove all matching occurrences. When false, removing a section that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Delete a built-in system section via `systemSectionEdits`. Requires `tabKey`. */
+    systemSection?: boolean;
+}
+/** Options for adding a tab to a layout. */
+export interface AddPageLayoutTabOptions {
+    /** Insert position inside `newTabs`. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another tab with the same key. Optional. @default false */
+    allowDuplicate?: boolean;
+}
+/** Options for removing a tab from a layout. */
+export interface RemovePageLayoutTabOptions {
+    /**
+     * Remove all matching occurrences. When false, removing a tab that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Delete a built-in system tab via `systemTabEdits`. */
+    systemTab?: boolean;
+}
+/** Options for adding a custom header field. */
+export interface AddHeaderFieldOptions extends Omit<NewHeaderField, 'rqlName' | 'key'> {
+    /**
+     * Stable header key. Defaults to the field api_name when adding a `Field`.
+     * Required when adding a raw `NewHeaderField`.
+     */
+    key?: string;
+    /** Insert position inside `newFields` and `headerFieldsOrder`. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another custom header field with the same key. Optional. @default false */
+    allowDuplicate?: boolean;
+}
+/** Options for removing custom header fields. */
+export interface RemoveHeaderFieldOptions {
+    /**
+     * Remove all matching occurrences. When false, removing a header field that
+     * appears more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+}
 /**
  * Initialization properties for {@link CustomObjectPageLayout}.
  */
@@ -319,6 +429,81 @@ export declare class CustomObjectPageLayout {
      * Returns the api_name of the custom object this layout belongs to.
      */
     getCustomObjectApiName(): string;
+    /**
+     * Adds one field to an existing layout section.
+     *
+     * For loaded layouts, this mutates the preserved `tab_edits` JSON in place
+     * and normalizes only the inserted field entry.
+     */
+    addField(field: Field, options: AddPageLayoutFieldOptions): this;
+    /**
+     * Adds multiple fields to an existing layout section.
+     *
+     * Fields are inserted in the order provided. If a field does not already have
+     * field-section metadata, pass `options.fieldSection` so the corresponding
+     * `CUSTOM_OBJECT_FIELD_SECTION` component is registered in the manifest.
+     */
+    addFields(fields: Field[], options: AddPageLayoutFieldsOptions): this;
+    /**
+     * Removes a field from the layout's field sections.
+     *
+     * This only removes the field from the page layout. It does not delete the
+     * `CUSTOM_OBJECT_FIELD` component from the manifest.
+     */
+    removeField(field: Field | string, options?: RemovePageLayoutFieldOptions): this;
+    /** Removes multiple fields from the layout's field sections. */
+    removeFields(fields: Array<Field | string>, options?: RemovePageLayoutFieldOptions): this;
+    /**
+     * Adds a section to an existing tab.
+     *
+     * Pass `systemTab: true` to add a new section to a built-in tab via
+     * `systemTabEdits.newSections`.
+     */
+    addSection(section: PageLayoutSection, options: AddPageLayoutSectionOptions): this;
+    /**
+     * Removes a section from `newTabs` / `systemTabEdits.newSections`.
+     *
+     * Pass `systemSection: true` with `tabKey` to delete a built-in section via
+     * `systemSectionEdits[sectionKey].deleted`.
+     */
+    removeSection(sectionKey: string, options?: RemovePageLayoutSectionOptions): this;
+    /** Adds a new tab to `tab_edits.newTabs`. */
+    addTab(tab: PageLayoutTab, options?: AddPageLayoutTabOptions): this;
+    /**
+     * Removes a tab from `newTabs`.
+     *
+     * Pass `systemTab: true` to delete a built-in tab via `systemTabEdits[tabKey].deleted`.
+     */
+    removeTab(tabKey: string, options?: RemovePageLayoutTabOptions): this;
+    /** Adds a custom header field to `header_edits.newFields`. */
+    addHeaderField(field: Field | NewHeaderField, options?: AddHeaderFieldOptions): this;
+    /** Removes custom header fields from `header_edits.newFields`. */
+    removeHeaderField(fieldOrKey: Field | string, options?: RemoveHeaderFieldOptions): this;
+    /** Sets the record title field in `header_edits`. */
+    setTitleField(field: Field | string | null): this;
+    /** Removes the record title field from the header. */
+    removeTitleField(): this;
+    /** Sets the record description field in `header_edits`. */
+    setDescriptionField(field: Field | string | null): this;
+    /** Removes the record description field from the header. */
+    removeDescriptionField(): this;
+    private serializeFieldForMutation;
+    private normalizeSectionFieldForMutation;
+    private normalizeSectionForMutation;
+    private normalizeTabForMutation;
+    private assignFieldSectionForMutation;
+    private assertFieldBelongsToLayout;
+    private requireOneFieldContainer;
+    private findFieldContainers;
+    private ensureSystemSectionFieldContainer;
+    private ensureSystemTabEdit;
+    private ensureSystemSectionEdit;
+    private findNewTabWithSections;
+    private assertSectionKeyAvailable;
+    private normalizeHeaderFieldForMutation;
+    private headerFieldApiName;
+    private removeSectionVisibility;
+    private removeTabVisibility;
     /**
      * Serializes this layout to the wire format consumed by the manifest install endpoint.
      *

package/lib/manifest/custom-object-page-layout.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"custom-object-page-layout.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-page-layout.ts"],"names":[],"mappings":"OACO,EAAE,wBAAwB,EAAE;OAC5B,KAAK,EAAE,YAAY,EAAE;OACrB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,KAAK,EAAE;OACd,KAAK,EAAE,yBAAyB,EAAE;AAEzC,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAMD,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kEAAkE;IAClE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,sDAAsD;IACtD,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,+DAA+D;IAC/D,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAMD,6DAA6D;AAC7D,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,eAAe,CAAC;AAEnD,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,wFAAwF;IACxF,OAAO,EAAE,wBAAwB,CAAC;IAClC,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,yFAAyF;IACzF,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE9C,2DAA2D;AAC3D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,8CAA8C;AAC9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,4FAA4F;AAC5F,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG,SAAS,CAAC;AAExD,4CAA4C;AAC5C,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,YAAY,CAAC;AAE9F,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,4CAA4C;IAC5C,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;IAC3B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAClC,kFAAkF;IAClF,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACvD,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,iEAAiE;IACjE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,uCAAuC;IACvC,YAAY,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;CAC1C;AAMD;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC/C,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC5C;AAMD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6CAA8C,SAAQ,8BAA8B;IACnG,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AA0MD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,sBAAsB;IACjC,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,2BAA2B,CAAU;IAErE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,4BAA4B,GAAG,yBAAyB;IAQhG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAuB;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IAEnD;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,2BAA2B;IAc1E;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CACrB,iBAAiB,EAAE,MAAM,EACzB,OAAO,GAAE,6CAAkD,GAC1D,sBAAsB;IAIzB,yEAAyE;IACzE,MAAM,CAAC,sBAAsB,CAC3B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,sBAAsB;IAgBzB;;OAEG;IACH,WAAW,IAAI,MAAM;IAIrB;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAiB7B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CACV,YAAY,EAAE,YAAY,EAC1B,KAAK,GAAE;QACL,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;KACb,GACL,sBAAsB;CAmC1B"}
+{"version":3,"file":"custom-object-page-layout.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-page-layout.ts"],"names":[],"mappings":"OACO,EAAE,wBAAwB,EAAE;OAC5B,KAAK,EAAE,YAAY,EAAE;OACrB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,KAAK,EAAE;OACd,KAAK,EAAE,yBAAyB,EAAE;AAEzC,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAMD,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kEAAkE;IAClE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,sDAAsD;IACtD,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,8DAA8D;IAC9D,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,+DAA+D;IAC/D,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAMD,6DAA6D;AAC7D,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,eAAe,CAAC;AAEnD,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,wFAAwF;IACxF,OAAO,EAAE,wBAAwB,CAAC;IAClC,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,yFAAyF;IACzF,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE9C,2DAA2D;AAC3D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,8CAA8C;AAC9C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,4FAA4F;AAC5F,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG,SAAS,CAAC;AAExD,4CAA4C;AAC5C,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,YAAY,CAAC;AAE9F,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,4CAA4C;IAC5C,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;IAC3B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAClC,kFAAkF;IAClF,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACvD,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,iEAAiE;IACjE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,uCAAuC;IACvC,YAAY,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;CAC1C;AAMD;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC/C,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC5C;AAMD,8DAA8D;AAC9D,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AAElE,gEAAgE;AAChE,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,gFAAgF;IAChF,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,yFAAyF;IACzF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,wEAAwE;AACxE,MAAM,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAEnE,iDAAiD;AACjD,MAAM,WAAW,4BAA4B;IAC3C,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,uDAAuD;AACvD,MAAM,WAAW,2BAA2B;IAC1C,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,wFAAwF;IACxF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,mDAAmD;AACnD,MAAM,WAAW,8BAA8B;IAC7C,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oFAAoF;IACpF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,4CAA4C;AAC5C,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,oEAAoE;IACpE,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,gDAAgD;AAChD,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yDAAyD;IACzD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,gDAAgD;AAChD,MAAM,WAAW,qBAAsB,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,KAAK,CAAC;IACpF;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,oFAAoF;IACpF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,iDAAiD;AACjD,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6CAA8C,SAAQ,8BAA8B;IACnG,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAkSD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,sBAAsB;IACjC,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,2BAA2B,CAAU;IAErE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,4BAA4B,GAAG,yBAAyB;IAQhG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAuB;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IAEnD;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,2BAA2B;IAc1E;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CACrB,iBAAiB,EAAE,MAAM,EACzB,OAAO,GAAE,6CAAkD,GAC1D,sBAAsB;IAIzB,yEAAyE;IACzE,MAAM,CAAC,sBAAsB,CAC3B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,sBAAsB;IAgBzB;;OAEG;IACH,WAAW,IAAI,MAAM;IAIrB;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAIhE;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,0BAA0B,GAAG,IAAI;IA2BrE;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,OAAO,GAAE,4BAAiC,GAAG,IAAI;IA0CpF,gEAAgE;IAChE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,EAAE,OAAO,GAAE,4BAAiC,GAAG,IAAI;IAO7F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,2BAA2B,GAAG,IAAI;IA2BlF;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,IAAI;IA0DrF,6CAA6C;IAC7C,MAAM,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,GAAE,uBAA4B,GAAG,IAAI;IAavE;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,0BAA+B,GAAG,IAAI;IAwBzE,8DAA8D;IAC9D,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,EAAE,OAAO,GAAE,qBAA0B,GAAG,IAAI;IAaxF,kEAAkE;IAClE,iBAAiB,CAAC,UAAU,EAAE,KAAK,GAAG,MAAM,EAAE,OAAO,GAAE,wBAA6B,GAAG,IAAI;IAyB3F,qDAAqD;IACrD,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI;IAMjD,sDAAsD;IACtD,gBAAgB,IAAI,IAAI;IAMxB,2DAA2D;IAC3D,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI;IAMvD,4DAA4D;IAC5D,sBAAsB,IAAI,IAAI;IAM9B,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,gCAAgC;IAuBxC,OAAO,CAAC,2BAA2B;IAoBnC,OAAO,CAAC,uBAAuB;IAQ/B,OAAO,CAAC,6BAA6B;IAkCrC,OAAO,CAAC,0BAA0B;IASlC,OAAO,CAAC,wBAAwB;IAmBhC,OAAO,CAAC,mBAAmB;IAmE3B,OAAO,CAAC,iCAAiC;IAuBzC,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,uBAAuB;IAc/B,OAAO,CAAC,sBAAsB;IAiB9B,OAAO,CAAC,yBAAyB;IAYjC,OAAO,CAAC,+BAA+B;IAsBvC,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,mBAAmB;IAM3B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAiB7B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,KAAK,CACV,YAAY,EAAE,YAAY,EAC1B,KAAK,GAAE;QACL,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;KACb,GACL,sBAAsB;CAmC1B"}

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

@@ -187,6 +187,116 @@ export interface VisibilityConditions {
     /** Per-tab visibility conditions, keyed by tab key. Optional. */
     tabs?: Record<string, VisibilityCondition>;
 }
+/** Where to insert a new layout item. Defaults to `'end'`. */
+export type PageLayoutMutationPosition = 'start' | 'end' | number;
+/** Options for adding a field to an existing layout section. */
+export interface AddPageLayoutFieldOptions extends SectionFieldOptions {
+    /**
+     * Tab key containing the target section. Optional when `sectionKey` is unique
+     * across the layout.
+     */
+    tabKey?: string;
+    /** Section key to add the field to. Required. */
+    sectionKey: string;
+    /**
+     * Field-section metadata to assign to the field component.
+     *
+     * Existing layouts often use layout section keys that differ from field section
+     * ids. Pass this when the field was not constructed with a `section`.
+     */
+    fieldSection?: CustomObjectFieldSection;
+    /** Insert position inside the section field list. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow the same field to appear twice in the same section. Optional. @default false */
+    allowDuplicate?: boolean;
+    /**
+     * Add to a built-in system section via `systemTabEdits`.
+     *
+     * When true, `tabKey` is required and the edit is created if it does not
+     * already exist.
+     */
+    systemSection?: boolean;
+}
+/** Options for adding multiple fields to an existing layout section. */
+export type AddPageLayoutFieldsOptions = AddPageLayoutFieldOptions;
+/** Options for removing fields from a layout. */
+export interface RemovePageLayoutFieldOptions {
+    /** Limit removal to one tab. Optional. */
+    tabKey?: string;
+    /** Limit removal to one section. Optional. */
+    sectionKey?: string;
+    /**
+     * Remove all matching occurrences. When false, removing a field that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Remove from a built-in system section edit. Optional. */
+    systemSection?: boolean;
+}
+/** Options for adding a section to an existing tab. */
+export interface AddPageLayoutSectionOptions {
+    /** Tab key to add the section to. Required. */
+    tabKey: string;
+    /** Insert position inside the tab. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another section with the same key in the same tab. Optional. @default false */
+    allowDuplicate?: boolean;
+    /**
+     * Add to a built-in system tab via `systemTabEdits.newSections`.
+     *
+     * When false, the tab must already be present in `newTabs`.
+     */
+    systemTab?: boolean;
+}
+/** Options for removing sections from a layout. */
+export interface RemovePageLayoutSectionOptions {
+    /** Limit removal to one tab. Optional. */
+    tabKey?: string;
+    /**
+     * Remove all matching occurrences. When false, removing a section that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Delete a built-in system section via `systemSectionEdits`. Requires `tabKey`. */
+    systemSection?: boolean;
+}
+/** Options for adding a tab to a layout. */
+export interface AddPageLayoutTabOptions {
+    /** Insert position inside `newTabs`. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another tab with the same key. Optional. @default false */
+    allowDuplicate?: boolean;
+}
+/** Options for removing a tab from a layout. */
+export interface RemovePageLayoutTabOptions {
+    /**
+     * Remove all matching occurrences. When false, removing a tab that appears
+     * more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+    /** Delete a built-in system tab via `systemTabEdits`. */
+    systemTab?: boolean;
+}
+/** Options for adding a custom header field. */
+export interface AddHeaderFieldOptions extends Omit<NewHeaderField, 'rqlName' | 'key'> {
+    /**
+     * Stable header key. Defaults to the field api_name when adding a `Field`.
+     * Required when adding a raw `NewHeaderField`.
+     */
+    key?: string;
+    /** Insert position inside `newFields` and `headerFieldsOrder`. Optional. @default `'end'` */
+    position?: PageLayoutMutationPosition;
+    /** Allow another custom header field with the same key. Optional. @default false */
+    allowDuplicate?: boolean;
+}
+/** Options for removing custom header fields. */
+export interface RemoveHeaderFieldOptions {
+    /**
+     * Remove all matching occurrences. When false, removing a header field that
+     * appears more than once throws. Optional. @default true
+     */
+    removeAll?: boolean;
+}
 /**
  * Initialization properties for {@link CustomObjectPageLayout}.
  */
@@ -319,6 +429,81 @@ export declare class CustomObjectPageLayout {
      * Returns the api_name of the custom object this layout belongs to.
      */
     getCustomObjectApiName(): string;
+    /**
+     * Adds one field to an existing layout section.
+     *
+     * For loaded layouts, this mutates the preserved `tab_edits` JSON in place
+     * and normalizes only the inserted field entry.
+     */
+    addField(field: Field, options: AddPageLayoutFieldOptions): this;
+    /**
+     * Adds multiple fields to an existing layout section.
+     *
+     * Fields are inserted in the order provided. If a field does not already have
+     * field-section metadata, pass `options.fieldSection` so the corresponding
+     * `CUSTOM_OBJECT_FIELD_SECTION` component is registered in the manifest.
+     */
+    addFields(fields: Field[], options: AddPageLayoutFieldsOptions): this;
+    /**
+     * Removes a field from the layout's field sections.
+     *
+     * This only removes the field from the page layout. It does not delete the
+     * `CUSTOM_OBJECT_FIELD` component from the manifest.
+     */
+    removeField(field: Field | string, options?: RemovePageLayoutFieldOptions): this;
+    /** Removes multiple fields from the layout's field sections. */
+    removeFields(fields: Array<Field | string>, options?: RemovePageLayoutFieldOptions): this;
+    /**
+     * Adds a section to an existing tab.
+     *
+     * Pass `systemTab: true` to add a new section to a built-in tab via
+     * `systemTabEdits.newSections`.
+     */
+    addSection(section: PageLayoutSection, options: AddPageLayoutSectionOptions): this;
+    /**
+     * Removes a section from `newTabs` / `systemTabEdits.newSections`.
+     *
+     * Pass `systemSection: true` with `tabKey` to delete a built-in section via
+     * `systemSectionEdits[sectionKey].deleted`.
+     */
+    removeSection(sectionKey: string, options?: RemovePageLayoutSectionOptions): this;
+    /** Adds a new tab to `tab_edits.newTabs`. */
+    addTab(tab: PageLayoutTab, options?: AddPageLayoutTabOptions): this;
+    /**
+     * Removes a tab from `newTabs`.
+     *
+     * Pass `systemTab: true` to delete a built-in tab via `systemTabEdits[tabKey].deleted`.
+     */
+    removeTab(tabKey: string, options?: RemovePageLayoutTabOptions): this;
+    /** Adds a custom header field to `header_edits.newFields`. */
+    addHeaderField(field: Field | NewHeaderField, options?: AddHeaderFieldOptions): this;
+    /** Removes custom header fields from `header_edits.newFields`. */
+    removeHeaderField(fieldOrKey: Field | string, options?: RemoveHeaderFieldOptions): this;
+    /** Sets the record title field in `header_edits`. */
+    setTitleField(field: Field | string | null): this;
+    /** Removes the record title field from the header. */
+    removeTitleField(): this;
+    /** Sets the record description field in `header_edits`. */
+    setDescriptionField(field: Field | string | null): this;
+    /** Removes the record description field from the header. */
+    removeDescriptionField(): this;
+    private serializeFieldForMutation;
+    private normalizeSectionFieldForMutation;
+    private normalizeSectionForMutation;
+    private normalizeTabForMutation;
+    private assignFieldSectionForMutation;
+    private assertFieldBelongsToLayout;
+    private requireOneFieldContainer;
+    private findFieldContainers;
+    private ensureSystemSectionFieldContainer;
+    private ensureSystemTabEdit;
+    private ensureSystemSectionEdit;
+    private findNewTabWithSections;
+    private assertSectionKeyAvailable;
+    private normalizeHeaderFieldForMutation;
+    private headerFieldApiName;
+    private removeSectionVisibility;
+    private removeTabVisibility;
     /**
      * Serializes this layout to the wire format consumed by the manifest install endpoint.
      *