@rippling/rippling-sdk 0.2.0-alpha.32 → 0.2.0-alpha.34

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

@@ -0,0 +1,158 @@
+import type { CustomObject } from "./custom-object.js";
+import type { Field } from "./field.js";
+/** Edit to a built-in (system) header field. */
+export interface SystemHeaderFieldEdit {
+    newRqlField?: string;
+    deleted?: boolean;
+}
+/** Custom header field added via newFields. `key` is required + non-empty. */
+export interface NewHeaderField {
+    rqlName: string;
+    key: string;
+    canBeDeleted?: boolean;
+    canBeChanged?: boolean;
+    canBeMoved?: boolean;
+}
+/**
+ * Strict shape for header_edits. Only the keys listed here are accepted by
+ * HeaderEditsDTO — anything else is dropped on the wire. Pass `{}` for an
+ * empty header.
+ */
+export interface HeaderEdits {
+    newTitleField?: string | null;
+    titleFieldDeleted?: boolean;
+    newDescriptionField?: string | null;
+    descriptionFieldDeleted?: boolean;
+    /** Map of system field key → edit. */
+    systemFieldEdits?: Record<string, SystemHeaderFieldEdit>;
+    newFields?: NewHeaderField[];
+    /** Sort order of header field `key` values (custom + system). */
+    headerFieldsOrder?: string[];
+    buttons?: string[];
+}
+/** SectionFieldDTO — one field inside a fields_section. */
+export interface SectionField {
+    fieldRqlName: string;
+    hidden?: boolean;
+    editable?: boolean;
+    movementOption?: 'tab' | 'free';
+}
+/** FieldsSectionDTO — standard field grid section. */
+export interface FieldsSection {
+    type: 'fields_section';
+    key: string;
+    name: string;
+    fields: SectionField[];
+}
+/** Only `fields_section` is modeled today (most common). Add other section
+ *  types (related_object_section, custom_section, …) explicitly as needed. */
+export type PageLayoutSection = FieldsSection;
+/** PageLayoutTabWithSectionsDTO. */
+export interface TabWithSections {
+    type: 'tab_with_sections';
+    key: string;
+    name: string;
+    sections: PageLayoutSection[];
+}
+/** CustomTabDTO — host a custom component as a tab. */
+export interface CustomTab {
+    type: 'custom_tab';
+    key: string;
+    name: string;
+    componentKey: string;
+}
+export type PageLayoutTab = TabWithSections | CustomTab;
+/** Layout of fields inside a fields_section. */
+export type SectionFieldsLayout = 'one_column' | 'two_column' | 'three_column' | 'responsive';
+/** SystemSectionEditDTO — edits to a built-in section inside a system tab. */
+export interface SystemSectionEdit {
+    newName?: string;
+    deleted?: boolean;
+    newLayout?: SectionFieldsLayout;
+    newFields?: SectionField[];
+    newHideName?: boolean;
+}
+/** SystemTabEditDTO — edits to a built-in tab (rename, delete, add sections, …). */
+export interface SystemTabEdit {
+    newName?: string;
+    deleted?: boolean;
+    newSections?: PageLayoutSection[];
+    systemSectionEdits?: Record<string, SystemSectionEdit>;
+    sectionsOrder?: string[];
+}
+/**
+ * Strict shape for tab_edits. Only TabEditsDTO keys allowed.
+ *
+ * All fields are optional to match `TabEditsDTO`'s `default_factory` (empty
+ * list / empty dict). An omitted `tabEdits` defaults to `{}` in the
+ * constructor; partial objects rely on backend per-field defaults.
+ *
+ * - newTabs:        tabs to create (each needs a `type` discriminator)
+ * - systemTabEdits: edits keyed by built-in tab key
+ * - tabsOrder:      ordered list of tab `key` values (new + system)
+ * - newTabLayout:   optional orientation
+ */
+export interface TabEdits {
+    newTabs?: PageLayoutTab[];
+    systemTabEdits?: Record<string, SystemTabEdit>;
+    tabsOrder?: string[];
+    newTabLayout?: 'vertical' | 'horizontal';
+}
+/**
+ * VisibilityConditionDTO. Both fields are required on the Python type — pass
+ * empty string / empty object if you genuinely have no formula or AST.
+ */
+export interface VisibilityCondition {
+    rqlFormula: string;
+    layeredConditionsTree: Record<string, any>;
+}
+/** Pass `{}` for "no conditions" — both maps default empty. */
+export interface VisibilityConditions {
+    sections?: Record<string, VisibilityCondition>;
+    tabs?: Record<string, VisibilityCondition>;
+}
+export interface CustomObjectPageLayoutProps {
+    /**
+     * Required. Stable `api_name` for the layout. Use `'default'` for the layout
+     * that drives **Add** and the default object detail view (per Custom Object
+     * — one `default` per object).
+     */
+    apiName: string;
+    /** Required. Display name of the layout. */
+    name: string;
+    /** Optional. Tab structure (TabEditsDTO). Defaults to empty. */
+    tabEdits?: TabEdits;
+    /** Optional. Header configuration (HeaderEditsDTO). Defaults to empty. */
+    headerEdits?: HeaderEdits;
+    /** Optional. Visibility conditions. Defaults to empty (no conditions). */
+    visibilityConditions?: VisibilityConditions;
+    /** Identity override. Override the layout identifier. @default generateId('layout') */
+    layoutId?: string;
+    /** Optional. Overwritten at install; defaults to object api_name. */
+    blueprintKey?: string;
+}
+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;
+    /** Build a new layout and auto-register with the CO's scope. */
+    constructor(customObject: CustomObject, props: CustomObjectPageLayoutProps);
+    /** Backend layout_id used as this layout's identifier. */
+    getLayoutId(): string;
+    /** Stable api_name for this layout. */
+    getApiName(): string;
+    /** api_name of the CustomObject this layout lives on. */
+    getCustomObjectApiName(): string;
+    /** Serialize to the backend `CUSTOM_OBJECT_PAGE_LAYOUT` wire shape. */
+    toDict(): Record<string, any>;
+    /** Factory for a single-tab "Details" page listing the given fields. */
+    static basic(customObject: CustomObject, props?: {
+        fields?: Field[];
+    }): CustomObjectPageLayout;
+}
+//# sourceMappingURL=custom-object-page-layout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-page-layout.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-page-layout.ts"],"names":[],"mappings":"OA0BO,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAMrB,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,sCAAsC;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,iEAAiE;IACjE,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAMD,2DAA2D;AAC3D,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;8EAC8E;AAC9E,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE9C,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,uDAAuD;AACvD,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG,SAAS,CAAC;AAExD,gDAAgD;AAChD,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,YAAY,CAAC;AAE9F,8EAA8E;AAC9E,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,oFAAoF;AACpF,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACvD,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;CAC1C;AAMD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5C;AAED,+DAA+D;AAC/D,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC5C;AAMD,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,0EAA0E;IAC1E,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,uFAAuF;IACvF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,qBAAa,sBAAsB;IACjC,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,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAuB;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IAEnD,gEAAgE;gBACpD,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,2BAA2B;IAc1E,0DAA0D;IAC1D,WAAW,IAAI,MAAM;IAIrB,uCAAuC;IACvC,UAAU,IAAI,MAAM;IAIpB,yDAAyD;IACzD,sBAAsB,IAAI,MAAM;IAIhC,uEAAuE;IACvE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAiB7B,wEAAwE;IACxE,MAAM,CAAC,KAAK,CACV,YAAY,EAAE,YAAY,EAC1B,KAAK,GAAE;QACL,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;KACb,GACL,sBAAsB;CA+B1B"}

package/lib/manifest/custom-object-page-layout.js

@@ -0,0 +1,112 @@
+"use strict";
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * Custom object page layouts (detail page structure).
+ * Backend schema: CUSTOM_OBJECT_PAGE_LAYOUT (v2)
+ *
+ * CDK-style: `new CustomObjectPageLayout(customObject, props)` auto-registers
+ * with the CO's scope. `blueprint_key` defaults to the CO's api_name.
+ * For the layout that drives **Add** and the default detail view, use
+ * `apiName: 'default'` (one per custom object). `CustomObjectPageLayout.basic`
+ * uses `default` automatically.
+ *
+ * TabEditsDTO / HeaderEditsDTO / VisibilityConditionsDTO are strict
+ * dataclasses on the backend. They expect camelCase keys on the wire
+ * (newTabs, systemTabEdits, fieldRqlName, newTitleField, ...). Snake_case
+ * keys are silently dropped and produce an empty layout on deploy. The
+ * interfaces below mirror the DTO field aliases exactly.
+ *
+ * TS catches misspellings on direct object literals but not on spreads,
+ * `as` casts, or loosely-typed variables — so be careful when constructing
+ * these objects dynamically.
+ *
+ * DTO references: types/edits.py, types/layout.py, types/sections.py.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomObjectPageLayout = void 0;
+const _helpers_1 = require("./_helpers.js");
+// ---------------------------------------------------------------------------
+// Class
+// ---------------------------------------------------------------------------
+class CustomObjectPageLayout {
+    /** Build a new layout and auto-register with the CO's scope. */
+    constructor(customObject, props) {
+        if (!props.apiName)
+            throw new Error('CustomObjectPageLayout: apiName cannot be empty');
+        if (!props.name)
+            throw new Error('CustomObjectPageLayout: name cannot be empty');
+        this._layoutId = props.layoutId ?? (0, _helpers_1.generateId)('layout');
+        this._apiName = props.apiName;
+        this._customObjectApiName = customObject.getApiName();
+        this._name = props.name;
+        this._tabEdits = props.tabEdits ?? {};
+        this._headerEdits = props.headerEdits ?? {};
+        this._visibilityConditions = props.visibilityConditions ?? {};
+        this._blueprintKey = props.blueprintKey;
+        customObject._register(this);
+    }
+    /** Backend layout_id used as this layout's identifier. */
+    getLayoutId() {
+        return this._layoutId;
+    }
+    /** Stable api_name for this layout. */
+    getApiName() {
+        return this._apiName;
+    }
+    /** api_name of the CustomObject this layout lives on. */
+    getCustomObjectApiName() {
+        return this._customObjectApiName;
+    }
+    /** Serialize to the backend `CUSTOM_OBJECT_PAGE_LAYOUT` wire shape. */
+    toDict() {
+        const d = {
+            type: 'CUSTOM_OBJECT_PAGE_LAYOUT',
+            layout_id: this._layoutId,
+            api_name: this._apiName,
+            object_rql_name: this._customObjectApiName,
+            name: this._name,
+            // Packaged layouts are never system-created (backend invariant).
+            system_created: false,
+            tab_edits: this._tabEdits,
+            header_edits: this._headerEdits,
+            visibility_conditions: this._visibilityConditions,
+            blueprint_key: this._blueprintKey ?? this._customObjectApiName,
+        };
+        return d;
+    }
+    /** Factory for a single-tab "Details" page listing the given fields. */
+    static basic(customObject, props = {}) {
+        const coApiName = customObject.getApiName();
+        const coName = customObject.getName();
+        return new CustomObjectPageLayout(customObject, {
+            apiName: 'default',
+            name: `${coName} Layout`,
+            tabEdits: {
+                newTabs: [
+                    {
+                        key: 'details',
+                        name: 'Details',
+                        type: 'tab_with_sections',
+                        sections: [
+                            {
+                                key: 'general',
+                                name: 'General',
+                                type: 'fields_section',
+                                fields: (props.fields ?? []).map((f) => ({
+                                    fieldRqlName: f.getApiName(),
+                                })),
+                            },
+                        ],
+                    },
+                ],
+                systemTabEdits: {},
+                tabsOrder: ['details'],
+            },
+            headerEdits: {},
+            visibilityConditions: {},
+        });
+    }
+}
+exports.CustomObjectPageLayout = CustomObjectPageLayout;
+//# sourceMappingURL=custom-object-page-layout.js.map

package/lib/manifest/custom-object-page-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-page-layout.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-page-layout.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,4CAAwC;AAuKxC,8EAA8E;AAC9E,QAAQ;AACR,8EAA8E;AAE9E,MAAa,sBAAsB;IAUjC,gEAAgE;IAChE,YAAY,YAA0B,EAAE,KAAkC;QACxE,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvF,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAA,qBAAU,EAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,0DAA0D;IAC1D,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,uCAAuC;IACvC,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,yDAAyD;IACzD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,uEAAuE;IACvE,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,2BAA2B;YACjC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,iEAAiE;YACjE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;YACjD,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,oBAAoB;SAC/D,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,KAAK,CACV,YAA0B,EAC1B,QAEI,EAAE;QAEN,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;QACtC,OAAO,IAAI,sBAAsB,CAAC,YAAY,EAAE;YAC9C,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,GAAG,MAAM,SAAS;YACxB,QAAQ,EAAE;gBACR,OAAO,EAAE;oBACP;wBACE,GAAG,EAAE,SAAS;wBACd,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,mBAAmB;wBACzB,QAAQ,EAAE;4BACR;gCACE,GAAG,EAAE,SAAS;gCACd,IAAI,EAAE,SAAS;gCACf,IAAI,EAAE,gBAAgB;gCACtB,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC;oCAC9C,YAAY,EAAE,CAAC,CAAC,UAAU,EAAE;iCAC7B,CAAC,CAAC;6BACJ;yBACF;qBACF;iBACF;gBACD,cAAc,EAAE,EAAE;gBAClB,SAAS,EAAE,CAAC,SAAS,CAAC;aACvB;YACD,WAAW,EAAE,EAAE;YACf,oBAAoB,EAAE,EAAE;SACzB,CAAC,CAAC;IACL,CAAC;CACF;AA/FD,wDA+FC"}

package/lib/manifest/custom-object-page-layout.mjs

@@ -0,0 +1,108 @@
+/*
+ * The contents of this file were inserted manually and are not generated by Stainless.
+ *
+ * Custom object page layouts (detail page structure).
+ * Backend schema: CUSTOM_OBJECT_PAGE_LAYOUT (v2)
+ *
+ * CDK-style: `new CustomObjectPageLayout(customObject, props)` auto-registers
+ * with the CO's scope. `blueprint_key` defaults to the CO's api_name.
+ * For the layout that drives **Add** and the default detail view, use
+ * `apiName: 'default'` (one per custom object). `CustomObjectPageLayout.basic`
+ * uses `default` automatically.
+ *
+ * TabEditsDTO / HeaderEditsDTO / VisibilityConditionsDTO are strict
+ * dataclasses on the backend. They expect camelCase keys on the wire
+ * (newTabs, systemTabEdits, fieldRqlName, newTitleField, ...). Snake_case
+ * keys are silently dropped and produce an empty layout on deploy. The
+ * interfaces below mirror the DTO field aliases exactly.
+ *
+ * TS catches misspellings on direct object literals but not on spreads,
+ * `as` casts, or loosely-typed variables — so be careful when constructing
+ * these objects dynamically.
+ *
+ * DTO references: types/edits.py, types/layout.py, types/sections.py.
+ */
+import { generateId } from "./_helpers.mjs";
+// ---------------------------------------------------------------------------
+// Class
+// ---------------------------------------------------------------------------
+export class CustomObjectPageLayout {
+    /** Build a new layout and auto-register with the CO's scope. */
+    constructor(customObject, props) {
+        if (!props.apiName)
+            throw new Error('CustomObjectPageLayout: apiName cannot be empty');
+        if (!props.name)
+            throw new Error('CustomObjectPageLayout: name cannot be empty');
+        this._layoutId = props.layoutId ?? generateId('layout');
+        this._apiName = props.apiName;
+        this._customObjectApiName = customObject.getApiName();
+        this._name = props.name;
+        this._tabEdits = props.tabEdits ?? {};
+        this._headerEdits = props.headerEdits ?? {};
+        this._visibilityConditions = props.visibilityConditions ?? {};
+        this._blueprintKey = props.blueprintKey;
+        customObject._register(this);
+    }
+    /** Backend layout_id used as this layout's identifier. */
+    getLayoutId() {
+        return this._layoutId;
+    }
+    /** Stable api_name for this layout. */
+    getApiName() {
+        return this._apiName;
+    }
+    /** api_name of the CustomObject this layout lives on. */
+    getCustomObjectApiName() {
+        return this._customObjectApiName;
+    }
+    /** Serialize to the backend `CUSTOM_OBJECT_PAGE_LAYOUT` wire shape. */
+    toDict() {
+        const d = {
+            type: 'CUSTOM_OBJECT_PAGE_LAYOUT',
+            layout_id: this._layoutId,
+            api_name: this._apiName,
+            object_rql_name: this._customObjectApiName,
+            name: this._name,
+            // Packaged layouts are never system-created (backend invariant).
+            system_created: false,
+            tab_edits: this._tabEdits,
+            header_edits: this._headerEdits,
+            visibility_conditions: this._visibilityConditions,
+            blueprint_key: this._blueprintKey ?? this._customObjectApiName,
+        };
+        return d;
+    }
+    /** Factory for a single-tab "Details" page listing the given fields. */
+    static basic(customObject, props = {}) {
+        const coApiName = customObject.getApiName();
+        const coName = customObject.getName();
+        return new CustomObjectPageLayout(customObject, {
+            apiName: 'default',
+            name: `${coName} Layout`,
+            tabEdits: {
+                newTabs: [
+                    {
+                        key: 'details',
+                        name: 'Details',
+                        type: 'tab_with_sections',
+                        sections: [
+                            {
+                                key: 'general',
+                                name: 'General',
+                                type: 'fields_section',
+                                fields: (props.fields ?? []).map((f) => ({
+                                    fieldRqlName: f.getApiName(),
+                                })),
+                            },
+                        ],
+                    },
+                ],
+                systemTabEdits: {},
+                tabsOrder: ['details'],
+            },
+            headerEdits: {},
+            visibilityConditions: {},
+        });
+    }
+}
+//# sourceMappingURL=custom-object-page-layout.mjs.map

package/lib/manifest/custom-object-page-layout.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-page-layout.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-page-layout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;OAEI,EAAE,UAAU,EAAE;AAuKrB,8EAA8E;AAC9E,QAAQ;AACR,8EAA8E;AAE9E,MAAM,OAAO,sBAAsB;IAUjC,gEAAgE;IAChE,YAAY,YAA0B,EAAE,KAAkC;QACxE,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvF,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,0DAA0D;IAC1D,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,uCAAuC;IACvC,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,yDAAyD;IACzD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,uEAAuE;IACvE,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,2BAA2B;YACjC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,iEAAiE;YACjE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;YACjD,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,oBAAoB;SAC/D,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,KAAK,CACV,YAA0B,EAC1B,QAEI,EAAE;QAEN,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC;QACtC,OAAO,IAAI,sBAAsB,CAAC,YAAY,EAAE;YAC9C,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,GAAG,MAAM,SAAS;YACxB,QAAQ,EAAE;gBACR,OAAO,EAAE;oBACP;wBACE,GAAG,EAAE,SAAS;wBACd,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,mBAAmB;wBACzB,QAAQ,EAAE;4BACR;gCACE,GAAG,EAAE,SAAS;gCACd,IAAI,EAAE,SAAS;gCACf,IAAI,EAAE,gBAAgB;gCACtB,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC;oCAC9C,YAAY,EAAE,CAAC,CAAC,UAAU,EAAE;iCAC7B,CAAC,CAAC;6BACJ;yBACF;qBACF;iBACF;gBACD,cAAc,EAAE,EAAE;gBAClB,SAAS,EAAE,CAAC,SAAS,CAAC;aACvB;YACD,WAAW,EAAE,EAAE;YACf,oBAAoB,EAAE,EAAE;SACzB,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,52 @@
+import { Category } from "./category.mjs";
+import type { ManifestComponent, ManifestScope } from "./manifest-builder.mjs";
+export interface IconConfig {
+    emoji?: string | null;
+    ripplingIcon?: string | null;
+    s3Bucket?: string;
+    s3Key?: string;
+}
+export interface CustomObjectProps {
+    /** Required. Unique api_name (must end with `__c`). */
+    apiName: string;
+    /** Required. Singular display name. */
+    name: string;
+    /**
+     * Required. Category this object belongs to. Accepts a live `Category` ref
+     * (the SDK reads its api_name) or a raw api_name string for categories
+     * authored outside this manifest (e.g. Rippling-native or cross-package).
+     */
+    category: Category | string;
+    /** Optional. What this entity represents. @default null */
+    description?: string | null;
+    /** Optional. Icon configuration. @default null */
+    icon?: IconConfig | null;
+    /** Optional. Plural display form. @default null */
+    pluralLabel?: string | null;
+    /** Optional. Overrides for autonumber name fields. @default null */
+    nameFieldDetails?: Record<string, any> | null;
+    /** Optional. Default field section name. @default null */
+    defaultFieldSectionName?: string | null;
+}
+export declare class CustomObject implements ManifestScope {
+    private readonly _scope;
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _category;
+    private _description;
+    private _icon;
+    private _pluralLabel;
+    private _nameFieldDetails;
+    private _defaultFieldSectionName;
+    /** Build a new CO and auto-register with `scope`; enforces `__c` suffix on `apiName`. */
+    constructor(scope: ManifestScope, props: CustomObjectProps);
+    /** @internal Scope hook: forward child registration up to the builder. */
+    _register(component: ManifestComponent): void;
+    /** Backend api_name for this custom object. */
+    getApiName(): string;
+    /** Singular display name. */
+    getName(): string;
+    /** Serialize to the backend `CUSTOM_OBJECT` wire shape. */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":"OAsBO,EAAE,QAAQ,EAAE;OACZ,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE;AA4IhD,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC5B,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kDAAkD;IAClD,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IACzB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC9C,0DAA0D;IAC1D,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC;AAED,qBAAa,YAAa,YAAW,aAAa;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,KAAK,CAAgC;IAC7C,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,wBAAwB,CAA4B;IAE5D,yFAAyF;gBAC7E,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,iBAAiB;IAqB1D,0EAA0E;IAC1E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAI7C,+CAA+C;IAC/C,UAAU,IAAI,MAAM;IAIpB,6BAA6B;IAC7B,OAAO,IAAI,MAAM;IAIjB,2DAA2D;IAC3D,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CA0B9B"}

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

@@ -0,0 +1,52 @@
+import { Category } from "./category.js";
+import type { ManifestComponent, ManifestScope } from "./manifest-builder.js";
+export interface IconConfig {
+    emoji?: string | null;
+    ripplingIcon?: string | null;
+    s3Bucket?: string;
+    s3Key?: string;
+}
+export interface CustomObjectProps {
+    /** Required. Unique api_name (must end with `__c`). */
+    apiName: string;
+    /** Required. Singular display name. */
+    name: string;
+    /**
+     * Required. Category this object belongs to. Accepts a live `Category` ref
+     * (the SDK reads its api_name) or a raw api_name string for categories
+     * authored outside this manifest (e.g. Rippling-native or cross-package).
+     */
+    category: Category | string;
+    /** Optional. What this entity represents. @default null */
+    description?: string | null;
+    /** Optional. Icon configuration. @default null */
+    icon?: IconConfig | null;
+    /** Optional. Plural display form. @default null */
+    pluralLabel?: string | null;
+    /** Optional. Overrides for autonumber name fields. @default null */
+    nameFieldDetails?: Record<string, any> | null;
+    /** Optional. Default field section name. @default null */
+    defaultFieldSectionName?: string | null;
+}
+export declare class CustomObject implements ManifestScope {
+    private readonly _scope;
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _category;
+    private _description;
+    private _icon;
+    private _pluralLabel;
+    private _nameFieldDetails;
+    private _defaultFieldSectionName;
+    /** Build a new CO and auto-register with `scope`; enforces `__c` suffix on `apiName`. */
+    constructor(scope: ManifestScope, props: CustomObjectProps);
+    /** @internal Scope hook: forward child registration up to the builder. */
+    _register(component: ManifestComponent): void;
+    /** Backend api_name for this custom object. */
+    getApiName(): string;
+    /** Singular display name. */
+    getName(): string;
+    /** Serialize to the backend `CUSTOM_OBJECT` wire shape. */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object.ts"],"names":[],"mappings":"OAsBO,EAAE,QAAQ,EAAE;OACZ,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE;AA4IhD,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC5B,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kDAAkD;IAClD,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IACzB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC9C,0DAA0D;IAC1D,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC;AAED,qBAAa,YAAa,YAAW,aAAa;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,KAAK,CAAgC;IAC7C,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,wBAAwB,CAA4B;IAE5D,yFAAyF;gBAC7E,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,iBAAiB;IAqB1D,0EAA0E;IAC1E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAI7C,+CAA+C;IAC/C,UAAU,IAAI,MAAM;IAIpB,6BAA6B;IAC7B,OAAO,IAAI,MAAM;IAIjB,2DAA2D;IAC3D,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CA0B9B"}