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

package/lib/manifest/list-view.d.mts

@@ -0,0 +1,138 @@
+import { type ObjectScope, type SortOrder } from "./_helpers.mjs";
+import type { CustomObject } from "./custom-object.mjs";
+import type { Field } from "./field.mjs";
+/**
+ * Initialization properties for {@link ListViewDef}.
+ */
+export interface ListViewDefProps {
+    /**
+     * Display name of this list view shown in the UI (e.g. `'All members'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Columns to display, as live {@link Field} references. At least one field is required.
+     *
+     * Required.
+     */
+    fields: Field[];
+    /**
+     * Whether this view is visible to all users (`true`) or only the record owner (`false`).
+     *
+     * Required.
+     */
+    isPublic: boolean;
+    /**
+     * Stable identifier for this view. Pass a human-readable slug
+     * (e.g. `'view_gym_all_members'`) to keep it stable across regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('view')
+     */
+    viewId?: string;
+    /**
+     * Field to sort by. Required when `sortOrder` is set.
+     *
+     * Optional.
+     */
+    orderBy?: Field;
+    /**
+     * Sort direction. One of `'ASC'` | `'DESC'`. Requires `orderBy` to be set.
+     *
+     * Optional.
+     */
+    sortOrder?: SortOrder;
+    /**
+     * Record scope for this view. One of `'all'` | `'my_records'`.
+     *
+     * Optional. @default `'all'`
+     */
+    objectScope?: ObjectScope;
+    /**
+     * Human-readable description of this view.
+     *
+     * Optional. @default null
+     */
+    description?: string;
+    /**
+     * Per-column configuration overrides (width, visibility, etc.).
+     *
+     * Optional. @default `{}`
+     */
+    columnConfig?: Record<string, any>;
+    /**
+     * RQL filter expression to pre-filter records shown in this view
+     * (e.g. `'(session_date__c == TODAY())'`).
+     *
+     * Optional. @default null
+     */
+    rqlFilter?: string;
+}
+/**
+ * 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())',
+ * });
+ * ```
+ */
+export declare class ListViewDef {
+    private readonly _viewId;
+    private readonly _customObjectApiName;
+    private readonly _name;
+    private readonly _fields;
+    private readonly _isPublic;
+    private readonly _orderBy;
+    private readonly _sortOrder;
+    private readonly _objectScope;
+    private readonly _description;
+    private readonly _columnConfig;
+    private readonly _rqlFilter;
+    /**
+     * @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: CustomObject, props: ListViewDefProps);
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
+    getViewId(): string;
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
+    getCustomObjectApiName(): string;
+    /**
+     * 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(): Record<string, any>;
+}
+//# sourceMappingURL=list-view.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"list-view.d.mts","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.d.ts

@@ -0,0 +1,138 @@
+import { type ObjectScope, type SortOrder } from "./_helpers.js";
+import type { CustomObject } from "./custom-object.js";
+import type { Field } from "./field.js";
+/**
+ * Initialization properties for {@link ListViewDef}.
+ */
+export interface ListViewDefProps {
+    /**
+     * Display name of this list view shown in the UI (e.g. `'All members'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Columns to display, as live {@link Field} references. At least one field is required.
+     *
+     * Required.
+     */
+    fields: Field[];
+    /**
+     * Whether this view is visible to all users (`true`) or only the record owner (`false`).
+     *
+     * Required.
+     */
+    isPublic: boolean;
+    /**
+     * Stable identifier for this view. Pass a human-readable slug
+     * (e.g. `'view_gym_all_members'`) to keep it stable across regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('view')
+     */
+    viewId?: string;
+    /**
+     * Field to sort by. Required when `sortOrder` is set.
+     *
+     * Optional.
+     */
+    orderBy?: Field;
+    /**
+     * Sort direction. One of `'ASC'` | `'DESC'`. Requires `orderBy` to be set.
+     *
+     * Optional.
+     */
+    sortOrder?: SortOrder;
+    /**
+     * Record scope for this view. One of `'all'` | `'my_records'`.
+     *
+     * Optional. @default `'all'`
+     */
+    objectScope?: ObjectScope;
+    /**
+     * Human-readable description of this view.
+     *
+     * Optional. @default null
+     */
+    description?: string;
+    /**
+     * Per-column configuration overrides (width, visibility, etc.).
+     *
+     * Optional. @default `{}`
+     */
+    columnConfig?: Record<string, any>;
+    /**
+     * RQL filter expression to pre-filter records shown in this view
+     * (e.g. `'(session_date__c == TODAY())'`).
+     *
+     * Optional. @default null
+     */
+    rqlFilter?: string;
+}
+/**
+ * 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())',
+ * });
+ * ```
+ */
+export declare class ListViewDef {
+    private readonly _viewId;
+    private readonly _customObjectApiName;
+    private readonly _name;
+    private readonly _fields;
+    private readonly _isPublic;
+    private readonly _orderBy;
+    private readonly _sortOrder;
+    private readonly _objectScope;
+    private readonly _description;
+    private readonly _columnConfig;
+    private readonly _rqlFilter;
+    /**
+     * @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: CustomObject, props: ListViewDefProps);
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
+    getViewId(): string;
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
+    getCustomObjectApiName(): string;
+    /**
+     * 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(): Record<string, any>;
+}
+//# sourceMappingURL=list-view.d.ts.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,109 @@
+"use strict";
+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 {
+    /**
+     * @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');
+        if (!props.fields || props.fields.length === 0) {
+            throw new Error('ListViewDef: must have at least one field');
+        }
+        if (props.sortOrder && !props.orderBy) {
+            throw new Error('ListViewDef: sortOrder requires orderBy to be set');
+        }
+        this._viewId = props.viewId ?? (0, _helpers_1.generateId)('view');
+        this._customObjectApiName = customObject.getApiName();
+        this._name = props.name;
+        this._fields = [...props.fields];
+        this._isPublic = props.isPublic;
+        this._orderBy = props.orderBy;
+        this._sortOrder = props.sortOrder;
+        this._objectScope = props.objectScope ?? 'all';
+        this._description = props.description;
+        this._columnConfig = props.columnConfig;
+        this._rqlFilter = props.rqlFilter;
+        customObject._register(this);
+    }
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
+    getViewId() {
+        return this._viewId;
+    }
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
+    getCustomObjectApiName() {
+        return this._customObjectApiName;
+    }
+    /**
+     * 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',
+            object_rql_name: this._customObjectApiName,
+            view_id: this._viewId,
+            name: this._name,
+            public: this._isPublic,
+            fields: this._fields.map((f) => f.getApiName()),
+        };
+        if (this._description != null)
+            d['description'] = this._description;
+        if (this._objectScope != null)
+            d['object_scope'] = this._objectScope;
+        if (this._sortOrder != null)
+            d['sort_order'] = this._sortOrder;
+        if (this._orderBy != null)
+            d['order_by'] = this._orderBy.getApiName();
+        if (this._columnConfig != null)
+            d['column_config'] = this._columnConfig;
+        if (this._rqlFilter != null)
+            d['rql_filter'] = this._rqlFilter;
+        return d;
+    }
+}
+exports.ListViewDef = ListViewDef;
+//# sourceMappingURL=list-view.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,105 @@
+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.
+ *
+ * @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())',
+ * });
+ * ```
+ */
+export class ListViewDef {
+    /**
+     * @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');
+        if (!props.fields || props.fields.length === 0) {
+            throw new Error('ListViewDef: must have at least one field');
+        }
+        if (props.sortOrder && !props.orderBy) {
+            throw new Error('ListViewDef: sortOrder requires orderBy to be set');
+        }
+        this._viewId = props.viewId ?? generateId('view');
+        this._customObjectApiName = customObject.getApiName();
+        this._name = props.name;
+        this._fields = [...props.fields];
+        this._isPublic = props.isPublic;
+        this._orderBy = props.orderBy;
+        this._sortOrder = props.sortOrder;
+        this._objectScope = props.objectScope ?? 'all';
+        this._description = props.description;
+        this._columnConfig = props.columnConfig;
+        this._rqlFilter = props.rqlFilter;
+        customObject._register(this);
+    }
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
+    getViewId() {
+        return this._viewId;
+    }
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
+    getCustomObjectApiName() {
+        return this._customObjectApiName;
+    }
+    /**
+     * 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',
+            object_rql_name: this._customObjectApiName,
+            view_id: this._viewId,
+            name: this._name,
+            public: this._isPublic,
+            fields: this._fields.map((f) => f.getApiName()),
+        };
+        if (this._description != null)
+            d['description'] = this._description;
+        if (this._objectScope != null)
+            d['object_scope'] = this._objectScope;
+        if (this._sortOrder != null)
+            d['sort_order'] = this._sortOrder;
+        if (this._orderBy != null)
+            d['order_by'] = this._orderBy.getApiName();
+        if (this._columnConfig != null)
+            d['column_config'] = this._columnConfig;
+        if (this._rqlFilter != null)
+            d['rql_filter'] = this._rqlFilter;
+        return d;
+    }
+}
+//# sourceMappingURL=list-view.mjs.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,110 @@
+/**
+ * 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 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 (e.g. `'gym_membership_management'`).
+     *
+     * Required.
+     */
+    key: string;
+    /**
+     * Display name for this manifest.
+     *
+     * Optional. Defaults to `key` when not provided.
+     */
+    name?: string;
+    /**
+     * 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;
+    /**
+     * @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;
+    /**
+     * 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>[];
+    };
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
+    componentsList(): Record<string, any>[];
+    /**
+     * 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

@@ -0,0 +1 @@
+{"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"}