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

package/lib/manifest/list-view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list-view.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":"OAWO,EAAc,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE;OAChD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAErB,MAAM,WAAW,gBAAgB;IAC/B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,sEAAsE;IACtE,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,0DAA0D;IAC1D,QAAQ,EAAE,OAAO,CAAC;IAClB,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,wDAAwD;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAChE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAEhD,kEAAkE;gBACtD,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB;IAsB/D,sDAAsD;IACtD,SAAS,IAAI,MAAM;IAInB,uDAAuD;IACvD,sBAAsB,IAAI,MAAM;IAIhC,qEAAqE;IACrE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAiB9B"}
+{"version":3,"file":"list-view.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":"OAAO,EAAc,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE;OAChD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAErB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAChE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAEhD;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB;IAsB/D;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;;OAKG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAiB9B"}

package/lib/manifest/list-view.js

@@ -1,19 +1,46 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * List view definitions for custom objects (column layout + sorting).
- * Backend schema: CUSTOM_OBJECT_LIST_VIEW (v2)
- *
- * Construction is CDK-style: `new ListViewDef(customObject, props)` — the
- * CO is the first positional arg, and the view auto-registers with the
- * manifest via the CO's scope chain.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListViewDef = void 0;
 const _helpers_1 = require("./_helpers.js");
+/**
+ * Defines a list view and registers it with the manifest.
+ *
+ * A list view defines which fields appear as columns, their sort order, and an
+ * optional RQL filter. You can define multiple views per custom object; each
+ * appears as a selectable view in the object's list page.
+ *
+ * @example
+ * ```ts
+ * new ListViewDef(memberObj, {
+ *   viewId: 'view_gym_all_members',
+ *   name: 'All members',
+ *   description: 'Directory with membership status',
+ *   fields: [memberDisplayName, memberEmail, memberPhone, memberStatusField, memberJoinDate],
+ *   orderBy: memberLastName,
+ *   sortOrder: 'ASC',
+ *   isPublic: true,
+ *   objectScope: 'all',
+ * });
+ *
+ * // Filtered view example:
+ * new ListViewDef(sessionObj, {
+ *   viewId: 'view_gym_today_sessions',
+ *   name: 'Today\'s class sessions',
+ *   fields: [sessionTrainerRef, sessionStartField, sessionClassTypeField],
+ *   orderBy: sessionStartField,
+ *   sortOrder: 'ASC',
+ *   isPublic: true,
+ *   objectScope: 'all',
+ *   rqlFilter: '(session_date__c == TODAY())',
+ * });
+ * ```
+ */
 class ListViewDef {
-    /** Build a new view def and auto-register with the CO's scope. */
+    /**
+     * @param customObject - The custom object this view belongs to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `name` is empty, `fields` is empty, or `sortOrder` is set without `orderBy`.
+     */
     constructor(customObject, props) {
         if (!props.name)
             throw new Error('ListViewDef: name cannot be empty');
@@ -36,15 +63,24 @@ class ListViewDef {
         this._rqlFilter = props.rqlFilter;
         customObject._register(this);
     }
-    /** Backend view_id used as this view's identifier. */
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
     getViewId() {
         return this._viewId;
     }
-    /** api_name of the CustomObject this view lives on. */
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
     getCustomObjectApiName() {
         return this._customObjectApiName;
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_LIST_VIEW` wire shape. */
+    /**
+     * Serializes this list view to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_LIST_VIEW'`.
+     * Optional fields are omitted when unset.
+     */
     toDict() {
         const d = {
             type: 'CUSTOM_OBJECT_LIST_VIEW',

package/lib/manifest/list-view.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-view.js","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,4CAA0E;AA2B1E,MAAa,WAAW;IAatB,kEAAkE;IAClE,YAAY,YAA0B,EAAE,KAAuB;QAC7D,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,sDAAsD;IACtD,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,uDAAuD;IACvD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,qEAAqE;IACrE,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,yBAAyB;YAC/B,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;SAChD,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACrE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACtE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QACxE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AAhED,kCAgEC"}
+{"version":3,"file":"list-view.js","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":";;;AAAA,4CAA0E;AAwE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAa,WAAW;IAatB;;;;OAIG;IACH,YAAY,YAA0B,EAAE,KAAuB;QAC7D,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,yBAAyB;YAC/B,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;SAChD,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACrE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACtE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QACxE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AA7ED,kCA6EC"}

package/lib/manifest/list-view.mjs

@@ -1,16 +1,43 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+import { generateId } from "./_helpers.mjs";
+/**
+ * Defines a list view and registers it with the manifest.
+ *
+ * A list view defines which fields appear as columns, their sort order, and an
+ * optional RQL filter. You can define multiple views per custom object; each
+ * appears as a selectable view in the object's list page.
  *
- * List view definitions for custom objects (column layout + sorting).
- * Backend schema: CUSTOM_OBJECT_LIST_VIEW (v2)
+ * @example
+ * ```ts
+ * new ListViewDef(memberObj, {
+ *   viewId: 'view_gym_all_members',
+ *   name: 'All members',
+ *   description: 'Directory with membership status',
+ *   fields: [memberDisplayName, memberEmail, memberPhone, memberStatusField, memberJoinDate],
+ *   orderBy: memberLastName,
+ *   sortOrder: 'ASC',
+ *   isPublic: true,
+ *   objectScope: 'all',
+ * });
  *
- * Construction is CDK-style: `new ListViewDef(customObject, props)` — the
- * CO is the first positional arg, and the view auto-registers with the
- * manifest via the CO's scope chain.
+ * // Filtered view example:
+ * new ListViewDef(sessionObj, {
+ *   viewId: 'view_gym_today_sessions',
+ *   name: 'Today\'s class sessions',
+ *   fields: [sessionTrainerRef, sessionStartField, sessionClassTypeField],
+ *   orderBy: sessionStartField,
+ *   sortOrder: 'ASC',
+ *   isPublic: true,
+ *   objectScope: 'all',
+ *   rqlFilter: '(session_date__c == TODAY())',
+ * });
+ * ```
  */
-import { generateId } from "./_helpers.mjs";
 export class ListViewDef {
-    /** Build a new view def and auto-register with the CO's scope. */
+    /**
+     * @param customObject - The custom object this view belongs to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `name` is empty, `fields` is empty, or `sortOrder` is set without `orderBy`.
+     */
     constructor(customObject, props) {
         if (!props.name)
             throw new Error('ListViewDef: name cannot be empty');
@@ -33,15 +60,24 @@ export class ListViewDef {
         this._rqlFilter = props.rqlFilter;
         customObject._register(this);
     }
-    /** Backend view_id used as this view's identifier. */
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
     getViewId() {
         return this._viewId;
     }
-    /** api_name of the CustomObject this view lives on. */
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
     getCustomObjectApiName() {
         return this._customObjectApiName;
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_LIST_VIEW` wire shape. */
+    /**
+     * Serializes this list view to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_LIST_VIEW'`.
+     * Optional fields are omitted when unset.
+     */
     toDict() {
         const d = {
             type: 'CUSTOM_OBJECT_LIST_VIEW',

package/lib/manifest/list-view.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"list-view.mjs","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;OAEI,EAAE,UAAU,EAAoC;AA2BvD,MAAM,OAAO,WAAW;IAatB,kEAAkE;IAClE,YAAY,YAA0B,EAAE,KAAuB;QAC7D,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,sDAAsD;IACtD,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,uDAAuD;IACvD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,qEAAqE;IACrE,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,yBAAyB;YAC/B,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;SAChD,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACrE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACtE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QACxE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,OAAO,CAAC,CAAC;IACX,CAAC;CACF"}
+{"version":3,"file":"list-view.mjs","sourceRoot":"","sources":["../../src/lib/manifest/list-view.ts"],"names":[],"mappings":"OAAO,EAAE,UAAU,EAAoC;AAwEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,WAAW;IAatB;;;;OAIG;IACH,YAAY,YAA0B,EAAE,KAAuB;QAC7D,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,CAAC,GAAwB;YAC7B,IAAI,EAAE,yBAAyB;YAC/B,eAAe,EAAE,IAAI,CAAC,oBAAoB;YAC1C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,MAAM,EAAE,IAAI,CAAC,SAAS;YACtB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;SAChD,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACrE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,CAAC,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACtE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QACxE,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI;YAAE,CAAC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/D,OAAO,CAAC,CAAC;IACX,CAAC;CACF"}

package/lib/manifest/manifest-builder.d.mts

@@ -1,44 +1,110 @@
-/** Any object with a toDict() method can be a manifest component. */
+/**
+ * Any object that can be included in a manifest.
+ *
+ * Implement `toDict()` to return the component's wire-format dict.
+ * All built-in SDK classes implement this interface automatically.
+ */
 export interface ManifestComponent {
     toDict(): Record<string, any>;
 }
 /**
- * A scope — anything that can accept a child component for registration.
- * Implemented by `ManifestBuilder` (root) and by nestable parents like
- * `CustomObject` and `CustomObjectFieldSection` that forward to the builder.
+ * A scope — anything that can accept child component registrations.
+ *
+ * Implemented by {@link ManifestBuilder} (the root) and by nestable parents
+ * like `CustomObject` that forward registrations up to the builder.
+ * Pass a scope as the first argument when constructing any manifest component.
  */
 export interface ManifestScope {
     /** @internal Register a child component; builder-bound scopes forward up. */
     _register(component: ManifestComponent): void;
 }
+/**
+ * Initialization properties for {@link ManifestBuilder}.
+ */
 export interface ManifestBuilderProps {
-    /** Unique project key for this manifest. */
+    /**
+     * Unique project key for this manifest (e.g. `'gym_membership_management'`).
+     *
+     * Required.
+     */
     key: string;
-    /** Display name (defaults to key if not provided). */
+    /**
+     * Display name for this manifest.
+     *
+     * Optional. Defaults to `key` when not provided.
+     */
     name?: string;
-    /** Optional description. */
+    /**
+     * Human-readable description of what this manifest contains.
+     *
+     * Optional.
+     */
     description?: string;
 }
+/**
+ * Root container for a manifest — collects all components and serializes them to JSON.
+ *
+ * You would normally create one `ManifestBuilder` at the top of your manifest file,
+ * then pass it as the scope to all top-level components (categories, custom objects,
+ * functions, apps, SDUI pages). Each component auto-registers on construction; there
+ * is no separate add or register call.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ * });
+ *
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
+ * // ... define fields, rules, list views, etc. ...
+ *
+ * console.log(manifest.preview());
+ * ```
+ */
 export declare class ManifestBuilder implements ManifestScope {
     readonly key: string;
     readonly name: string;
     readonly description: string;
     private readonly _components;
-    /** Build a new manifest; `name` defaults to `key` when unset. */
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
     constructor(props: ManifestBuilderProps);
     /**
      * @internal Scope hook invoked by child constructors. Components enter the
      * manifest here — there is no other path.
      */
     _register(component: ManifestComponent): void;
-    /** Build the manifest object: metadata + flat component list. */
+    /**
+     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     *
+     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     */
     buildManifest(): {
         metadata: Record<string, any>;
         components: Record<string, any>[];
     };
-    /** Flat list of all component dicts. */
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
     componentsList(): Record<string, any>[];
-    /** Pretty-printed JSON string. */
+    /**
+     * Returns the full manifest as a pretty-printed JSON string.
+     *
+     * Typically used as the final line of a manifest file to emit the output:
+     * `console.log(manifest.preview())`.
+     *
+     * @returns Indented JSON string of the complete manifest.
+     */
     preview(): string;
 }
 //# sourceMappingURL=manifest-builder.d.mts.map

package/lib/manifest/manifest-builder.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAuBA,qEAAqE;AACrE,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD,iEAAiE;gBACrD,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C,iEAAiE;IACjE,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF,wCAAwC;IACxC,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC,kCAAkC;IAClC,OAAO,IAAI,MAAM;CAGlB"}
+{"version":3,"file":"manifest-builder.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD;;;OAGG;gBACS,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C;;;;OAIG;IACH,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC;;;;;;;OAOG;IACH,OAAO,IAAI,MAAM;CAGlB"}

package/lib/manifest/manifest-builder.d.ts

@@ -1,44 +1,110 @@
-/** Any object with a toDict() method can be a manifest component. */
+/**
+ * Any object that can be included in a manifest.
+ *
+ * Implement `toDict()` to return the component's wire-format dict.
+ * All built-in SDK classes implement this interface automatically.
+ */
 export interface ManifestComponent {
     toDict(): Record<string, any>;
 }
 /**
- * A scope — anything that can accept a child component for registration.
- * Implemented by `ManifestBuilder` (root) and by nestable parents like
- * `CustomObject` and `CustomObjectFieldSection` that forward to the builder.
+ * A scope — anything that can accept child component registrations.
+ *
+ * Implemented by {@link ManifestBuilder} (the root) and by nestable parents
+ * like `CustomObject` that forward registrations up to the builder.
+ * Pass a scope as the first argument when constructing any manifest component.
  */
 export interface ManifestScope {
     /** @internal Register a child component; builder-bound scopes forward up. */
     _register(component: ManifestComponent): void;
 }
+/**
+ * Initialization properties for {@link ManifestBuilder}.
+ */
 export interface ManifestBuilderProps {
-    /** Unique project key for this manifest. */
+    /**
+     * Unique project key for this manifest (e.g. `'gym_membership_management'`).
+     *
+     * Required.
+     */
     key: string;
-    /** Display name (defaults to key if not provided). */
+    /**
+     * Display name for this manifest.
+     *
+     * Optional. Defaults to `key` when not provided.
+     */
     name?: string;
-    /** Optional description. */
+    /**
+     * Human-readable description of what this manifest contains.
+     *
+     * Optional.
+     */
     description?: string;
 }
+/**
+ * Root container for a manifest — collects all components and serializes them to JSON.
+ *
+ * You would normally create one `ManifestBuilder` at the top of your manifest file,
+ * then pass it as the scope to all top-level components (categories, custom objects,
+ * functions, apps, SDUI pages). Each component auto-registers on construction; there
+ * is no separate add or register call.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ * });
+ *
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
+ * // ... define fields, rules, list views, etc. ...
+ *
+ * console.log(manifest.preview());
+ * ```
+ */
 export declare class ManifestBuilder implements ManifestScope {
     readonly key: string;
     readonly name: string;
     readonly description: string;
     private readonly _components;
-    /** Build a new manifest; `name` defaults to `key` when unset. */
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
     constructor(props: ManifestBuilderProps);
     /**
      * @internal Scope hook invoked by child constructors. Components enter the
      * manifest here — there is no other path.
      */
     _register(component: ManifestComponent): void;
-    /** Build the manifest object: metadata + flat component list. */
+    /**
+     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     *
+     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     */
     buildManifest(): {
         metadata: Record<string, any>;
         components: Record<string, any>[];
     };
-    /** Flat list of all component dicts. */
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
     componentsList(): Record<string, any>[];
-    /** Pretty-printed JSON string. */
+    /**
+     * Returns the full manifest as a pretty-printed JSON string.
+     *
+     * Typically used as the final line of a manifest file to emit the output:
+     * `console.log(manifest.preview())`.
+     *
+     * @returns Indented JSON string of the complete manifest.
+     */
     preview(): string;
 }
 //# sourceMappingURL=manifest-builder.d.ts.map

package/lib/manifest/manifest-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAuBA,qEAAqE;AACrE,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD,iEAAiE;gBACrD,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C,iEAAiE;IACjE,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF,wCAAwC;IACxC,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC,kCAAkC;IAClC,OAAO,IAAI,MAAM;CAGlB"}
+{"version":3,"file":"manifest-builder.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD;;;OAGG;gBACS,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C;;;;OAIG;IACH,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC;;;;;;;OAOG;IACH,OAAO,IAAI,MAAM;CAGlB"}

package/lib/manifest/manifest-builder.js

@@ -1,30 +1,37 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestBuilder = void 0;
+/**
+ * Root container for a manifest — collects all components and serializes them to JSON.
+ *
+ * You would normally create one `ManifestBuilder` at the top of your manifest file,
+ * then pass it as the scope to all top-level components (categories, custom objects,
+ * functions, apps, SDUI pages). Each component auto-registers on construction; there
+ * is no separate add or register call.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
  *
- * ManifestBuilder collects manifest components and serializes to JSON.
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ * });
  *
- * Wiring model (CDK-style scope-first):
- *   - Every component takes its parent scope as the first positional
- *     constructor arg. The scope is either a `ManifestBuilder` (root) or a
- *     `CustomObject` / `CustomObjectFieldSection` for nested children.
- *   - Constructing a component auto-registers it with the builder via the
- *     scope's `_register` hook. There is no public `addComponent` — the
- *     only way a component enters the manifest is by being constructed
- *     with a scope that forwards up to this builder.
- *   - The builder does not walk into components; each component emits the
- *     foreign-key fields (`custom_object_api_name`, `model_rql_name`, ...)
- *     itself in `toDict()`.
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
+ * // ... define fields, rules, list views, etc. ...
  *
- * Local operations only (no HTTP):
- *   - preview()         — render manifest as a JSON string
- *   - buildManifest()   — return the manifest as a plain object
- *   - componentsList()  — return the flat list of component dicts
+ * console.log(manifest.preview());
+ * ```
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManifestBuilder = void 0;
 class ManifestBuilder {
-    /** Build a new manifest; `name` defaults to `key` when unset. */
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
     constructor(props) {
         this._components = [];
         if (!props.key) {
@@ -44,7 +51,11 @@ class ManifestBuilder {
         }
         this._components.push(component);
     }
-    /** Build the manifest object: metadata + flat component list. */
+    /**
+     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     *
+     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     */
     buildManifest() {
         const metadata = {
             key: this.key,
@@ -56,11 +67,22 @@ class ManifestBuilder {
         const components = this._components.map((c) => c.toDict());
         return { metadata, components };
     }
-    /** Flat list of all component dicts. */
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
     componentsList() {
         return this._components.map((c) => c.toDict());
     }
-    /** Pretty-printed JSON string. */
+    /**
+     * Returns the full manifest as a pretty-printed JSON string.
+     *
+     * Typically used as the final line of a manifest file to emit the output:
+     * `console.log(manifest.preview())`.
+     *
+     * @returns Indented JSON string of the complete manifest.
+     */
     preview() {
         return JSON.stringify(this.buildManifest(), null, 2);
     }

package/lib/manifest/manifest-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AA0BH,MAAa,eAAe;IAM1B,iEAAiE;IACjE,YAAY,KAA2B;QAHtB,gBAAW,GAAwB,EAAE,CAAC;QAIrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,iEAAiE;IACjE,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,wCAAwC;IACxC,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,kCAAkC;IAClC,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AAjDD,0CAiDC"}
+{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AA8CA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,eAAe;IAM1B;;;OAGG;IACH,YAAY,KAA2B;QANtB,gBAAW,GAAwB,EAAE,CAAC;QAOrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AAnED,0CAmEC"}