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

package/lib/manifest/category.js

@@ -1,29 +1,64 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * Rippling category definitions for grouping objects in navigation.
- * Backend schema: CUSTOM_CATEGORY (v2)
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Category = void 0;
+/**
+ * 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.
+ */
 class Category {
-    /** Build a new category and auto-register with `scope` (usually a `ManifestBuilder`). */
+    /**
+     * @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);
     }
-    /** Backend api_name used as this category's identifier. */
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
     getApiName() {
         return this._apiName;
     }
-    /** Display name shown in the UI. */
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
     getName() {
         return this._name;
     }
-    /** Serialize to the backend `CUSTOM_CATEGORY` wire shape. */
+    /**
+     * 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',

package/lib/manifest/category.js.map

@@ -1 +1 @@
-{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAaH,MAAa,QAAQ;IAKnB,yFAAyF;IACzF,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,2DAA2D;IAC3D,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,oCAAoC;IACpC,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,6DAA6D;IAC7D,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;AAhCD,4BAgCC"}
+{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":";;;AA0BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,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;AA3CD,4BA2CC"}

package/lib/manifest/category.mjs

@@ -1,26 +1,61 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+/**
+ * Defines a category and registers it with the manifest.
  *
- * Rippling category definitions for grouping objects in navigation.
- * Backend schema: CUSTOM_CATEGORY (v2)
+ * 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 {
-    /** Build a new category and auto-register with `scope` (usually a `ManifestBuilder`). */
+    /**
+     * @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);
     }
-    /** Backend api_name used as this category's identifier. */
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
     getApiName() {
         return this._apiName;
     }
-    /** Display name shown in the UI. */
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
     getName() {
         return this._name;
     }
-    /** Serialize to the backend `CUSTOM_CATEGORY` wire shape. */
+    /**
+     * 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',

package/lib/manifest/category.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"category.mjs","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,MAAM,OAAO,QAAQ;IAKnB,yFAAyF;IACzF,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,2DAA2D;IAC3D,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,oCAAoC;IACpC,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,6DAA6D;IAC7D,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"}
+{"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

@@ -1,21 +1,71 @@
 import type { CustomObject } from "./custom-object.mjs";
+/**
+ * Initialization properties for {@link CustomObjectFieldSection}.
+ */
 export interface CustomObjectFieldSectionProps {
-    /** Required. Display name of the section. */
+    /**
+     * Display name of the section shown as a group header on the detail page
+     * (e.g. `'Profile'`, `'Membership'`).
+     *
+     * Required.
+     */
     name: string;
-    /** Identity override. Override the section identifier. @default generateId('sec') */
+    /**
+     * 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;
-    /** Build a new section and auto-register with the CO's scope. */
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
     constructor(customObject: CustomObject, props: CustomObjectFieldSectionProps);
-    /** Backend section_id used as this section's identifier. */
+    /**
+     * 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;
-    /** api_name of the parent custom object this section lives on. */
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
     getModelApiName(): string;
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD_SECTION` wire shape. */
+    /**
+     * 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

@@ -1 +1 @@
-{"version":3,"file":"custom-object-field-section.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"OAYO,KAAK,EAAE,YAAY,EAAE;AAE5B,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,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,iEAAiE;gBACrD,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,6BAA6B;IAO5E,4DAA4D;IAC5D,YAAY,IAAI,MAAM;IAItB,kEAAkE;IAClE,eAAe,IAAI,MAAM;IAIzB,yEAAyE;IACzE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
+{"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

@@ -1,21 +1,71 @@
 import type { CustomObject } from "./custom-object.js";
+/**
+ * Initialization properties for {@link CustomObjectFieldSection}.
+ */
 export interface CustomObjectFieldSectionProps {
-    /** Required. Display name of the section. */
+    /**
+     * Display name of the section shown as a group header on the detail page
+     * (e.g. `'Profile'`, `'Membership'`).
+     *
+     * Required.
+     */
     name: string;
-    /** Identity override. Override the section identifier. @default generateId('sec') */
+    /**
+     * 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;
-    /** Build a new section and auto-register with the CO's scope. */
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
     constructor(customObject: CustomObject, props: CustomObjectFieldSectionProps);
-    /** Backend section_id used as this section's identifier. */
+    /**
+     * 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;
-    /** api_name of the parent custom object this section lives on. */
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
     getModelApiName(): string;
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD_SECTION` wire shape. */
+    /**
+     * 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

@@ -1 +1 @@
-{"version":3,"file":"custom-object-field-section.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"OAYO,KAAK,EAAE,YAAY,EAAE;AAE5B,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,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,iEAAiE;gBACrD,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,6BAA6B;IAO5E,4DAA4D;IAC5D,YAAY,IAAI,MAAM;IAItB,kEAAkE;IAClE,eAAe,IAAI,MAAM;IAIzB,yEAAyE;IACzE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
+{"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

@@ -1,34 +1,61 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * Custom object field sections (UI grouping of fields on detail pages).
- * Backend schema: CUSTOM_OBJECT_FIELD_SECTION (v2)
- *
- * Construction is CDK-style: `new CustomObjectFieldSection(customObject, props)`
- * — the CO is the first positional arg, and the section auto-registers with
- * the manifest via the CO's scope chain.
- */
 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 {
-    /** Build a new section and auto-register with the CO's scope. */
+    /**
+     * @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);
     }
-    /** Backend section_id used as this section's identifier. */
+    /**
+     * 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;
     }
-    /** api_name of the parent custom object this section lives on. */
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
     getModelApiName() {
         return this._model.getApiName();
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD_SECTION` wire shape. */
+    /**
+     * 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',

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

@@ -1 +1 @@
-{"version":3,"file":"custom-object-field-section.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,4CAAwC;AAUxC,MAAa,wBAAwB;IAKnC,iEAAiE;IACjE,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,4DAA4D;IAC5D,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,kEAAkE;IAClE,eAAe;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,yEAAyE;IACzE,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;AAhCD,4DAgCC"}
+{"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

@@ -1,31 +1,58 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+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.
  *
- * Custom object field sections (UI grouping of fields on detail pages).
- * Backend schema: CUSTOM_OBJECT_FIELD_SECTION (v2)
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
  *
- * Construction is CDK-style: `new CustomObjectFieldSection(customObject, props)`
- * — the CO is the first positional arg, and the section auto-registers with
- * the manifest via the CO's scope chain.
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
  */
-import { generateId } from "./_helpers.mjs";
 export class CustomObjectFieldSection {
-    /** Build a new section and auto-register with the CO's scope. */
+    /**
+     * @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);
     }
-    /** Backend section_id used as this section's identifier. */
+    /**
+     * 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;
     }
-    /** api_name of the parent custom object this section lives on. */
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
     getModelApiName() {
         return this._model.getApiName();
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD_SECTION` wire shape. */
+    /**
+     * 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',

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

@@ -1 +1 @@
-{"version":3,"file":"custom-object-field-section.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;OAEI,EAAE,UAAU,EAAE;AAUrB,MAAM,OAAO,wBAAwB;IAKnC,iEAAiE;IACjE,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,4DAA4D;IAC5D,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,kEAAkE;IAClE,eAAe;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,yEAAyE;IACzE,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"}
+{"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"}