@rippling/rippling-sdk 0.2.0-alpha.33 → 0.2.0-alpha.35

package/lib/manifest/category.mjs

@@ -0,0 +1,68 @@
+/**
+ * Defines a category and registers it with the manifest.
+ *
+ * A category is the navigation grouping that organizes related custom objects
+ * in the Rippling sidebar. You would normally define one category per domain,
+ * then pass it (or its api_name string) to each {@link CustomObject} in that domain.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ * });
+ *
+ * const gymCategory = new Category(manifest, {
+ *   apiName: 'gym__c',
+ *   name: 'Gym',
+ *   description: 'Memberships, staff, schedules, and attendance',
+ * });
+ *
+ * // Pass the instance to any CustomObject in this domain:
+ * const memberObj = new CustomObject(manifest, {
+ *   apiName: 'gym_member__c',
+ *   name: 'Member',
+ *   category: gymCategory,
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — references this category via instance or api_name string.
+ */
+export class Category {
+    /**
+     * @param scope - The manifest to register this category with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope, props) {
+        this._apiName = props.apiName;
+        this._name = props.name;
+        this._description = props.description ?? null;
+        scope._register(this);
+    }
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
+    getApiName() {
+        return this._apiName;
+    }
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Serializes this category to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_CATEGORY'` and all configured fields.
+     */
+    toDict() {
+        return {
+            type: 'CUSTOM_CATEGORY',
+            api_name: this._apiName,
+            name: this._name,
+            description: this._description ?? null,
+        };
+    }
+}
+//# sourceMappingURL=category.mjs.map

package/lib/manifest/category.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.mjs","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"AA0BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,QAAQ;IAKnB;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAC9C,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;SACvC,CAAC;IACJ,CAAC;CACF"}

package/lib/manifest/custom-object-field-section.d.mts

@@ -0,0 +1,71 @@
+import type { CustomObject } from "./custom-object.mjs";
+/**
+ * Initialization properties for {@link CustomObjectFieldSection}.
+ */
+export interface CustomObjectFieldSectionProps {
+    /**
+     * Display name of the section shown as a group header on the detail page
+     * (e.g. `'Profile'`, `'Membership'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Stable identifier for this section. Pass a human-readable slug
+     * (e.g. `'sec_gm_profile'`) to keep it stable across manifest regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('sec')
+     */
+    sectionId?: string;
+}
+/**
+ * Defines a field section and registers it with the manifest.
+ *
+ * A field section is a named group of fields displayed together on a custom
+ * object's detail page. After creating a section, pass it as the `section`
+ * prop on any field that should belong to it.
+ *
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
+ */
+export declare class CustomObjectFieldSection {
+    private readonly _sectionId;
+    private readonly _name;
+    private readonly _model;
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
+    constructor(customObject: CustomObject, props: CustomObjectFieldSectionProps);
+    /**
+     * Returns the stable identifier for this section (e.g. `'sec_gm_profile'`).
+     *
+     * Use this value in page layout field entries via `getSectionId()`, or pass
+     * the section instance directly to field `section` props.
+     */
+    getSectionId(): string;
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
+    getModelApiName(): string;
+    /**
+     * Serializes this section to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD_SECTION'`.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object-field-section.d.mts.map

package/lib/manifest/custom-object-field-section.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-field-section.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"OACO,KAAK,EAAE,YAAY,EAAE;AAE5B;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IAEtC;;;OAGG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,6BAA6B;IAO5E;;;;;OAKG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/custom-object-field-section.d.ts

@@ -0,0 +1,71 @@
+import type { CustomObject } from "./custom-object.js";
+/**
+ * Initialization properties for {@link CustomObjectFieldSection}.
+ */
+export interface CustomObjectFieldSectionProps {
+    /**
+     * Display name of the section shown as a group header on the detail page
+     * (e.g. `'Profile'`, `'Membership'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Stable identifier for this section. Pass a human-readable slug
+     * (e.g. `'sec_gm_profile'`) to keep it stable across manifest regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('sec')
+     */
+    sectionId?: string;
+}
+/**
+ * Defines a field section and registers it with the manifest.
+ *
+ * A field section is a named group of fields displayed together on a custom
+ * object's detail page. After creating a section, pass it as the `section`
+ * prop on any field that should belong to it.
+ *
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
+ */
+export declare class CustomObjectFieldSection {
+    private readonly _sectionId;
+    private readonly _name;
+    private readonly _model;
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
+    constructor(customObject: CustomObject, props: CustomObjectFieldSectionProps);
+    /**
+     * Returns the stable identifier for this section (e.g. `'sec_gm_profile'`).
+     *
+     * Use this value in page layout field entries via `getSectionId()`, or pass
+     * the section instance directly to field `section` props.
+     */
+    getSectionId(): string;
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
+    getModelApiName(): string;
+    /**
+     * Serializes this section to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD_SECTION'`.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object-field-section.d.ts.map

package/lib/manifest/custom-object-field-section.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-field-section.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"OACO,KAAK,EAAE,YAAY,EAAE;AAE5B;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IAEtC;;;OAGG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,6BAA6B;IAO5E;;;;;OAKG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/custom-object-field-section.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomObjectFieldSection = void 0;
+const _helpers_1 = require("./_helpers.js");
+/**
+ * Defines a field section and registers it with the manifest.
+ *
+ * A field section is a named group of fields displayed together on a custom
+ * object's detail page. After creating a section, pass it as the `section`
+ * prop on any field that should belong to it.
+ *
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
+ */
+class CustomObjectFieldSection {
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
+    constructor(customObject, props) {
+        this._sectionId = props.sectionId ?? (0, _helpers_1.generateId)('sec');
+        this._name = props.name;
+        this._model = customObject;
+        customObject._register(this);
+    }
+    /**
+     * Returns the stable identifier for this section (e.g. `'sec_gm_profile'`).
+     *
+     * Use this value in page layout field entries via `getSectionId()`, or pass
+     * the section instance directly to field `section` props.
+     */
+    getSectionId() {
+        return this._sectionId;
+    }
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
+    getModelApiName() {
+        return this._model.getApiName();
+    }
+    /**
+     * Serializes this section to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD_SECTION'`.
+     */
+    toDict() {
+        return {
+            type: 'CUSTOM_OBJECT_FIELD_SECTION',
+            section_id: this._sectionId,
+            model_name: this._model.getApiName(),
+            name: this._name,
+        };
+    }
+}
+exports.CustomObjectFieldSection = CustomObjectFieldSection;
+//# sourceMappingURL=custom-object-field-section.js.map

package/lib/manifest/custom-object-field-section.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-field-section.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AAuBxC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,wBAAwB;IAKnC;;;OAGG;IACH,YAAY,YAA0B,EAAE,KAAoC;QAC1E,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,IAAI,IAAA,qBAAU,EAAC,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;QAC3B,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,6BAA6B;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;CACF;AA9CD,4DA8CC"}

package/lib/manifest/custom-object-field-section.mjs

@@ -0,0 +1,65 @@
+import { generateId } from "./_helpers.mjs";
+/**
+ * Defines a field section and registers it with the manifest.
+ *
+ * A field section is a named group of fields displayed together on a custom
+ * object's detail page. After creating a section, pass it as the `section`
+ * prop on any field that should belong to it.
+ *
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
+ */
+export class CustomObjectFieldSection {
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
+    constructor(customObject, props) {
+        this._sectionId = props.sectionId ?? generateId('sec');
+        this._name = props.name;
+        this._model = customObject;
+        customObject._register(this);
+    }
+    /**
+     * Returns the stable identifier for this section (e.g. `'sec_gm_profile'`).
+     *
+     * Use this value in page layout field entries via `getSectionId()`, or pass
+     * the section instance directly to field `section` props.
+     */
+    getSectionId() {
+        return this._sectionId;
+    }
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
+    getModelApiName() {
+        return this._model.getApiName();
+    }
+    /**
+     * Serializes this section to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD_SECTION'`.
+     */
+    toDict() {
+        return {
+            type: 'CUSTOM_OBJECT_FIELD_SECTION',
+            section_id: this._sectionId,
+            model_name: this._model.getApiName(),
+            name: this._name,
+        };
+    }
+}
+//# sourceMappingURL=custom-object-field-section.mjs.map

package/lib/manifest/custom-object-field-section.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-field-section.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"OAAO,EAAE,UAAU,EAAE;AAuBrB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,wBAAwB;IAKnC;;;OAGG;IACH,YAAY,YAA0B,EAAE,KAAoC;QAC1E,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;QAC3B,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,6BAA6B;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,318 @@
+import type { CustomObject } from "./custom-object.mjs";
+import type { Field } from "./field.mjs";
+/** Edit to a built-in (system) header field. */
+export interface SystemHeaderFieldEdit {
+    /** Replace the system field's RQL field reference. Optional. */
+    newRqlField?: string;
+    /** Remove this system field from the header. Optional. */
+    deleted?: boolean;
+}
+/**
+ * Custom header field added via `newFields`.
+ *
+ * `key` is required and must be non-empty — it is used as the stable identity
+ * for this field in `headerFieldsOrder` and visibility conditions.
+ */
+export interface NewHeaderField {
+    /** RQL field name to display. Required. */
+    rqlName: string;
+    /** Stable key for this field. Required. */
+    key: string;
+    /** Whether the user can remove this field. Optional. */
+    canBeDeleted?: boolean;
+    /** Whether the user can swap this field for another. Optional. */
+    canBeChanged?: boolean;
+    /** Whether the user can reorder this field. Optional. */
+    canBeMoved?: boolean;
+}
+/**
+ * Header configuration for a page layout (`header_edits`).
+ *
+ * Only the keys listed here are accepted — anything else is silently dropped
+ * on the wire. Pass `{}` for an unchanged header.
+ *
+ * > **Caution:** key names are camelCase on the wire. Snake_case keys are
+ * > silently dropped and produce an empty header on deploy.
+ */
+export interface HeaderEdits {
+    /** Replace the record title field (pass the field's api_name). Optional. */
+    newTitleField?: string | null;
+    /** Remove the title field from the header. Optional. */
+    titleFieldDeleted?: boolean;
+    /** Replace the record description field. Optional. */
+    newDescriptionField?: string | null;
+    /** 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>;
+    /** Additional custom fields to add to the header. Optional. */
+    newFields?: NewHeaderField[];
+    /** Ordered list of header field `key` values (custom + system). Optional. */
+    headerFieldsOrder?: string[];
+    /** Action button keys to show in the header. Optional. */
+    buttons?: string[];
+}
+/** One field entry inside a `fields_section`. */
+export interface SectionField {
+    /** RQL name of the field to display. Required. */
+    fieldRqlName: string;
+    /** Hide this field from view. Optional. */
+    hidden?: boolean;
+    /** Allow inline editing of this field. Optional. */
+    editable?: boolean;
+    /** Controls how the field can be moved in the UI. Optional. */
+    movementOption?: 'tab' | 'free';
+}
+/** A standard field-grid section inside a tab. */
+export interface FieldsSection {
+    type: 'fields_section';
+    /** Stable key for this section. Required. */
+    key: string;
+    /** Display name of the section. Required. */
+    name: string;
+    /** Fields to display in this section. Required. */
+    fields: SectionField[];
+}
+/**
+ * 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;
+/** 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;
+    /** Display name of the tab. Required. */
+    name: string;
+    /** Sections inside this tab. Required. */
+    sections: PageLayoutSection[];
+}
+/** A tab that hosts a custom UI component. */
+export interface CustomTab {
+    type: 'custom_tab';
+    /** Stable key for this tab. Required. */
+    key: string;
+    /** Display name of the tab. Required. */
+    name: string;
+    /** Key of the custom component to render. Required. */
+    componentKey: string;
+}
+/** A tab entry in a page layout — either a sections-based tab or a custom component tab. */
+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. */
+    newName?: string;
+    /** Remove this section. Optional. */
+    deleted?: boolean;
+    /** Change the column layout. Optional. */
+    newLayout?: SectionFieldsLayout;
+    /** Add fields to this section. Optional. */
+    newFields?: SectionField[];
+    /** Hide the section name header. Optional. */
+    newHideName?: boolean;
+}
+/** Edits to a built-in (system) tab. */
+export interface SystemTabEdit {
+    /** Rename this tab. Optional. */
+    newName?: string;
+    /** Remove this tab. Optional. */
+    deleted?: boolean;
+    /** 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>;
+    /** Reorder sections by key. Optional. */
+    sectionsOrder?: string[];
+}
+/**
+ * Tab structure configuration for a page layout (`tab_edits`).
+ *
+ * All fields are optional. An omitted `tabEdits` defaults to `{}`.
+ *
+ * > **Caution:** key names are camelCase on the wire. Snake_case keys are
+ * > silently dropped and produce an empty layout on deploy.
+ */
+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>;
+    /** Ordered list of tab `key` values (new + system). Optional. */
+    tabsOrder?: string[];
+    /** Tab strip orientation. Optional. */
+    newTabLayout?: 'vertical' | 'horizontal';
+}
+/**
+ * A single visibility condition applied to a section or tab.
+ *
+ * Both fields are required by the backend — pass an empty string / empty object
+ * if you have no formula or condition tree.
+ */
+export interface VisibilityCondition {
+    /** RQL formula that controls visibility. Required. */
+    rqlFormula: string;
+    /** Layered conditions tree (AST). Required. */
+    layeredConditionsTree: Record<string, any>;
+}
+/**
+ * Visibility conditions for sections and tabs on a page layout.
+ *
+ * Pass `{}` for no conditions.
+ */
+export interface VisibilityConditions {
+    /** Per-section visibility conditions, keyed by section key. Optional. */
+    sections?: Record<string, VisibilityCondition>;
+    /** Per-tab visibility conditions, keyed by tab key. Optional. */
+    tabs?: Record<string, VisibilityCondition>;
+}
+/**
+ * Initialization properties for {@link CustomObjectPageLayout}.
+ */
+export interface CustomObjectPageLayoutProps {
+    /**
+     * Stable identifier for this layout (e.g. `'default'`).
+     *
+     * Required. Use `'default'` for the layout that drives the **Add** form and
+     * the default record detail view. Each custom object supports one `'default'`
+     * layout.
+     */
+    apiName: string;
+    /**
+     * Display name of this layout shown in the layout selector.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Tab structure — which tabs and sections to show on the detail page.
+     *
+     * Optional. @default `{}`
+     */
+    tabEdits?: TabEdits;
+    /**
+     * Header configuration — title field, description field, and action buttons.
+     *
+     * Optional. @default `{}`
+     */
+    headerEdits?: HeaderEdits;
+    /**
+     * Visibility conditions for individual tabs and sections.
+     *
+     * Optional. @default `{}`
+     */
+    visibilityConditions?: VisibilityConditions;
+    /**
+     * Stable identifier for this layout record. Pass a human-readable slug
+     * to keep it stable across regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('layout')
+     */
+    layoutId?: string;
+    /**
+     * Blueprint key used during install. Defaults to the parent object's api_name.
+     *
+     * Optional.
+     */
+    blueprintKey?: string;
+}
+/**
+ * Defines a page layout and registers it with the manifest.
+ *
+ * A page layout controls the tab structure, section groupings, header fields,
+ * and visibility conditions on a custom object's record detail page. You would
+ * normally define one layout per custom object using `apiName: 'default'`.
+ *
+ * For simple single-tab layouts, use the {@link CustomObjectPageLayout.basic}
+ * factory instead of constructing the full props manually.
+ *
+ * > **Caution:** all keys inside `tabEdits` and `headerEdits` must be camelCase.
+ * > Snake_case keys are silently dropped on the wire and produce an empty layout.
+ *
+ * @example
+ * ```ts
+ * new CustomObjectPageLayout(memberObj, {
+ *   apiName: 'default',
+ *   name: 'Member',
+ *   layoutId: 'layout_gym_member',
+ *   headerEdits: { newTitleField: memberDisplayName.getApiName() },
+ *   tabEdits: {
+ *     newTabs: [{
+ *       key: 'member', name: 'Member', type: 'tab_with_sections',
+ *       sections: [{
+ *         key: 'profile', name: 'Profile', type: 'fields_section',
+ *         fields: [
+ *           { fieldRqlName: memberFirstName.getApiName() },
+ *           { fieldRqlName: memberEmail.getApiName() },
+ *         ],
+ *       }],
+ *     }],
+ *     systemTabEdits: {},
+ *     tabsOrder: ['member'],
+ *   },
+ *   visibilityConditions: {},
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout.basic} — factory for simple single-tab layouts.
+ */
+export declare class CustomObjectPageLayout {
+    private readonly _layoutId;
+    private readonly _apiName;
+    private readonly _customObjectApiName;
+    private readonly _name;
+    private readonly _tabEdits;
+    private readonly _headerEdits;
+    private readonly _visibilityConditions;
+    private readonly _blueprintKey;
+    /**
+     * @param customObject - The custom object this layout belongs to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `apiName` or `name` is empty.
+     */
+    constructor(customObject: CustomObject, props: CustomObjectPageLayoutProps);
+    /**
+     * Returns the stable identifier for this layout record (e.g. `'layout_gym_member'`).
+     */
+    getLayoutId(): string;
+    /**
+     * Returns the api_name of this layout (e.g. `'default'`).
+     */
+    getApiName(): string;
+    /**
+     * Returns the api_name of the custom object this layout belongs to.
+     */
+    getCustomObjectApiName(): string;
+    /**
+     * Serializes this layout to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_PAGE_LAYOUT'`.
+     */
+    toDict(): Record<string, any>;
+    /**
+     * Creates a simple single-tab "Details" layout with a single "General" section.
+     *
+     * Use this factory when you want a straightforward layout without customizing
+     * tabs or sections. Always uses `apiName: 'default'`.
+     *
+     * @param customObject - The custom object to create the layout for.
+     * @param props - Optional. Pass `fields` to populate the General section.
+     * @returns A new `CustomObjectPageLayout` registered with the manifest.
+     *
+     * @example
+     * ```ts
+     * CustomObjectPageLayout.basic(memberObj, {
+     *   fields: [memberFirstName, memberEmail, memberStatusField],
+     * });
+     * ```
+     */
+    static basic(customObject: CustomObject, props?: {
+        fields?: Field[];
+    }): CustomObjectPageLayout;
+}
+//# sourceMappingURL=custom-object-page-layout.d.mts.map