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

package/lib/manifest/field.mjs

@@ -1,23 +1,3 @@
-/*
- * Fields for Rippling custom objects (CUSTOM_OBJECT_FIELD v2).
- * Hand-written (not Stainless-generated); mirrors custom_object_field.py.
- *
- * Each concrete field type is its own class that extends the internal `Field`
- * base. Construct like any other component:
- *
- *     new TextField(customObject, { apiName, displayName, ... });
- *     new LookupField(customObject, { apiName, target: otherCo, ... });
- *     new SummaryField(customObject, { apiName, aggregates, using, lookup, ... });
- *
- * This mirrors AWS CDK's per-variant-class pattern (e.g.
- * `new codepipeline_actions.GitHubSourceAction({...})` rather than a single
- * Action class with 30 static factories). Every subclass serializes to the
- * same `CUSTOM_OBJECT_FIELD` wire shape, discriminated by `data_type.field_type`.
- *
- * The parent CO is the first positional arg (the "scope") — its `api_name`
- * becomes `custom_object_api_name` at serialization, and the field
- * auto-registers with the manifest via the CO's scope chain.
- */
 import { FILTER_OPERATORS_BY_TYPE, } from "./_helpers.mjs";
 function validateApiName(apiName) {
     if (!apiName.endsWith('__c')) {
@@ -28,12 +8,35 @@ function validateApiName(apiName) {
 // Base class
 // ────────────────────────────────────────────────────────────────────────
 /**
- * Base class for every custom-object field. Prefer the concrete subclasses
- * (`TextField`, `LookupField`, `SummaryField`, …). Construct `Field` directly
- * only for wire-types the SDK doesn't yet model.
+ * Base class for every custom-object field.
+ *
+ * Prefer the typed subclasses (`TextField`, `NumberField`, `LookupField`, …) over
+ * constructing `Field` directly. Use `Field` only for wire-level field types the
+ * SDK does not yet model with a dedicated subclass.
+ *
+ * All field classes share the same scope-first CDK pattern: pass the parent
+ * {@link CustomObject} as the first argument and the field auto-registers with
+ * the manifest. Every field api_name must end with `__c`.
+ *
+ * @example
+ * ```ts
+ * // Prefer typed subclasses:
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   required: true,
+ *   maxLength: 80,
+ * });
+ * ```
+ *
+ * @see {@link TextField}, {@link NumberField}, {@link LookupField}, {@link SummaryField}
  */
 export class Field {
-    /** Build a new field; enforces `__c` suffix and folds props into `data_type`. */
+    /**
+     * @param customObject - The custom object this field belongs to.
+     * @param props - Field configuration. See {@link FieldProps}.
+     * @throws {Error} If `props.apiName` does not end with `__c`.
+     */
     constructor(customObject, props) {
         validateApiName(props.apiName);
         this._fieldApiName = props.apiName;
@@ -68,36 +71,40 @@ export class Field {
         customObject._register(this);
     }
     // ── Getters ────────────────────────────────────────────────────────────
-    /** Backend api_name for this field. */
+    /** Returns the api_name of this field (e.g. `'first_name__c'`). */
     getApiName() {
         return this._fieldApiName;
     }
-    /** Human-readable display name. */
+    /** Returns the display name of this field. */
     getDisplayName() {
         return this._fieldDisplayName;
     }
-    /** api_name of the CustomObject this field lives on. */
+    /** Returns the api_name of the custom object this field belongs to. */
     getCustomObjectApiName() {
         return this._customObjectApiName;
     }
-    /** Resolved `data_type.field_type`, or null if unset. */
+    /** Returns the resolved `field_type` (e.g. `'TEXT'`), or `null` if unset. */
     getFieldType() {
         return this._dataType['field_type'] ?? null;
     }
-    /** Raw `data_type` dict (read-only view). */
+    /** Returns a read-only view of the raw `data_type` dict. */
     getDataType() {
         return this._dataType;
     }
-    /** True if this field is a simple formula field. */
+    /** Returns `true` if this is a formula (computed) field. */
     isFormula() {
         return this._derivedFieldFormula != null;
     }
-    /** True if this field is a summary/rollup field. */
+    /** Returns `true` if this is a summary (rollup) field. */
     isSummary() {
         return this._summarySpec != null;
     }
     // ── Serialization ──────────────────────────────────────────────────────
-    /** Serialize to the backend `CUSTOM_OBJECT_FIELD` wire shape. */
+    /**
+     * Serializes this field to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD'`.
+     */
     toDict() {
         return {
             type: 'CUSTOM_OBJECT_FIELD',
@@ -145,91 +152,91 @@ export class Field {
         };
     }
 }
-/** Single-line text. */
+/** Single-line text field. */
 export class TextField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'TEXT' });
     }
 }
-/** Multi-line text. */
+/** Multi-line text field. */
 export class LongTextField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'LONG_TEXT' });
     }
 }
-/** Email address (format-validated by the UI). */
+/** Email address field. Format is validated by the Rippling UI. */
 export class EmailField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'EMAIL' });
     }
 }
-/** URL (format-validated by the UI). */
+/** URL field. Format is validated by the Rippling UI. */
 export class UrlField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'URL' });
     }
 }
-/** Phone number. */
+/** Phone number field. */
 export class PhoneField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'PHONE_NUMBER' });
     }
 }
-/** Number. */
+/** Numeric field. */
 export class NumberField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'NUMBER' });
     }
 }
-/** Currency amount; `currency` is forwarded only when set. */
+/** Currency amount field. */
 export class CurrencyField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'CURRENCY' });
     }
 }
-/** Percentage. */
+/** Percentage field. */
 export class PercentageField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'PERCENTAGE' });
     }
 }
-/** Date (no time). */
+/** Date field (no time component). */
 export class DateField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'DATE' });
     }
 }
-/** Date + time. */
+/** Date and time field. */
 export class DatetimeField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'DATETIME' });
     }
 }
-/** Time of day. */
+/** Time-of-day field. */
 export class TimeField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'TIME' });
     }
 }
-/** Dropdown select. */
+/** Dropdown single-select field. */
 export class SelectField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'SELECT' });
     }
 }
-/** Radio button group. */
+/** Radio button group field. */
 export class RadioField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'RADIO' });
     }
 }
-/** Boolean (checkbox). */
+/** Boolean (checkbox) field. */
 export class BooleanField extends Field {
     constructor(customObject, props) {
         super(customObject, { ...props, fieldType: 'BOOLEAN' });
     }
 }
-/** File attachment; `allowedType` mirrors the UI's "File type" dropdown. */
+/** File attachment field. */
 export class FileField extends Field {
     constructor(customObject, props) {
         const { allowedType, ...rest } = props;
@@ -241,7 +248,12 @@ export class FileField extends Field {
         });
     }
 }
-/** Many-to-one reference. */
+/**
+ * Many-to-one reference field. Links this record to one record on the target object.
+ *
+ * Use {@link ParentChildField} instead when the relationship should create a
+ * parent-child hierarchy with rollup support.
+ */
 export class LookupField extends Field {
     constructor(customObject, props) {
         const targetApiName = typeof props.target === 'string' ? props.target : props.target.getApiName();
@@ -260,7 +272,13 @@ export class LookupField extends Field {
         });
     }
 }
-/** Parent-child reference — always required on the wire. */
+/**
+ * Parent-child reference field. Creates a hierarchical relationship between
+ * this object (child) and the target (parent), enabling {@link SummaryField}
+ * rollups from the child to the parent.
+ *
+ * Always emitted as `required: true` on the wire.
+ */
 export class ParentChildField extends Field {
     constructor(customObject, props) {
         super(customObject, {
@@ -283,9 +301,21 @@ export class ParentChildField extends Field {
     }
 }
 /**
- * Computed formula field (read-only). `fieldType` is required and narrowed
- * to the 7 variants the UI "Data type" dropdown exposes. `maxLength` is
- * required when `fieldType === 'TEXT'`.
+ * Read-only computed field whose value is derived from an RQL formula.
+ *
+ * `fieldType` is required and restricted to the 7 output types the Rippling
+ * formula editor supports. `maxLength` is required when `fieldType === 'TEXT'`.
+ *
+ * @example
+ * ```ts
+ * const memberDisplayName = new FormulaField(memberObj, {
+ *   apiName: 'member_display_name__c',
+ *   displayName: 'Display name',
+ *   fieldType: 'TEXT',
+ *   maxLength: 200,
+ *   formula: "CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))",
+ * });
+ * ```
  */
 export class FormulaField extends Field {
     constructor(customObject, props) {
@@ -303,11 +333,24 @@ export class FormulaField extends Field {
     }
 }
 /**
- * Summary/rollup field — aggregates a child-object field (read-only).
- * SDK enforces only what backend/UI won't: `lookup` edge_type, output-type
- * inference, per-type filter operators, and same-child-CO residency for
- * `aggregates` + `lookup`. Per-filter residency / LONG_TEXT / formula
- * filter / currency pairing checks are left to the backend.
+ * Read-only rollup field that aggregates a child object's field values.
+ *
+ * Defined on the **parent** object. Requires a {@link ParentChildField} on the
+ * child object pointing back at this parent as the `lookup` edge.
+ *
+ * @example
+ * ```ts
+ * // Count enrollments on a class session:
+ * const enrollmentCount = new SummaryField(sessionObj, {
+ *   apiName: 'enrollment_count__c',
+ *   displayName: 'Enrolled (count)',
+ *   aggregates: enrollmentMemberRef,
+ *   using: 'COUNT',
+ *   lookup: enrollmentSessionRef,  // ParentChildField on enrollmentObj → sessionObj
+ * });
+ * ```
+ *
+ * @see {@link ParentChildField} — must be used as `lookup`.
  */
 export class SummaryField extends Field {
     constructor(customObject, props) {

package/lib/manifest/field.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"field.mjs","sourceRoot":"","sources":["../../src/lib/manifest/field.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;OAEI,EACL,wBAAwB,GAKzB;AAqBD,SAAS,eAAe,CAAC,OAAe;IACtC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAuCD,2EAA2E;AAC3E,aAAa;AACb,2EAA2E;AAE3E;;;;GAIG;AACH,MAAM,OAAO,KAAK;IAgBhB,iFAAiF;IACjF,YAAY,YAA0B,EAAE,KAAiB;QACvD,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAEtD,MAAM,EAAE,GAAwB,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI;YAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;QAChE,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI;YAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;QAChE,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI;YAAE,EAAE,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;QACnF,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI;YAAE,EAAE,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC5D,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI;YAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC;QACxD,IAAI,CAAC,6BAA6B,GAAG,KAAK,CAAC,sBAAsB,IAAI,IAAI,CAAC;QAC1E,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAE9C,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,QAAQ;YACX,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBACzB,CAAC,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU;oBAC7C,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;QAE9B,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,0EAA0E;IAE1E,uCAAuC;IACvC,UAAU;QACR,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,mCAAmC;IACnC,cAAc;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,wDAAwD;IACxD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IACD,yDAAyD;IACzD,YAAY;QACV,OAAQ,IAAI,CAAC,SAAS,CAAC,YAAY,CAA2B,IAAI,IAAI,CAAC;IACzE,CAAC;IACD,6CAA6C;IAC7C,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,oDAAoD;IACpD,SAAS;QACP,OAAO,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC;IAC3C,CAAC;IACD,oDAAoD;IACpD,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC;IACnC,CAAC;IAED,0EAA0E;IAE1E,iEAAiE;IACjE,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;YACjD,cAAc,EAAE,IAAI,CAAC,aAAa;YAClC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;YAC1C,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE;YACvE,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI;YACrC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;YAC1C,uEAAuE;YACvE,WAAW,EAAE,KAAK;YAClB,wBAAwB,EAAE,IAAI,CAAC,uBAAuB,EAAE;YACxD,qBAAqB,EAAE,IAAI,CAAC,oBAAoB,IAAI,IAAI;YACxD,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC;IACJ,CAAC;IAED,0FAA0F;IAClF,uBAAuB;QAC7B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,6BAA6B,CAAC;QACzE,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;QAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC;QAC3D,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;QAC1D,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,iBAAiB,IAAI,CAAC,aAAa,uBAAuB,YAAY,IAAI;gBACxE,4BAA4B,SAAS,iCAAiC;gBACtE,qBAAqB,CACxB,CAAC;QACJ,CAAC;QAED,8EAA8E;QAE9E,OAAO;YACL,oBAAoB,EAAE,IAAI,CAAC,KAAK;YAChC,gBAAgB,EAAE,SAAS;YAC3B,aAAa,EAAE,IAAI,CAAC,YAAY;YAChC,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;YAChD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAChC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE;gBAChC,YAAY,EAAE,CAAC,CAAC,KAAK;gBACrB,QAAQ,EAAE,CAAC,CAAC,QAAQ;aACrB,CAAC,CAAC;YACH,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;SAChD,CAAC;IACJ,CAAC;CACF;AAeD,wBAAwB;AACxB,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AAMD,uBAAuB;AACvB,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AAMD,kDAAkD;AAClD,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAKD,wCAAwC;AACxC,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC,YAAY,YAA0B,EAAE,KAAoB;QAC1D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAKD,oBAAoB;AACpB,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AASD,cAAc;AACd,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAOD,8DAA8D;AAC9D,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAMD,kBAAkB;AAClB,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,YAA0B,EAAE,KAA2B;QACjE,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAOD,sBAAsB;AACtB,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AAKD,mBAAmB;AACnB,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAKD,mBAAmB;AACnB,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AASD,uBAAuB;AACvB,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAOD,0BAA0B;AAC1B,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAKD,0BAA0B;AAC1B,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAcD,4EAA4E;AAC5E,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,SAAS,GAAG,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAChE,KAAK,CAAC,YAAY,EAAE;YAClB,GAAG,IAAI;YACP,SAAS,EAAE,MAAM;YACjB,QAAQ,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAUD,6BAA6B;AAC7B,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,MAAM,aAAa,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAClG,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,QAAQ,EAAE;gBACR,UAAU,EAAE,oBAAoB;gBAChC,iBAAiB,EAAE,aAAa;gBAChC,SAAS,EAAE,QAAQ;gBACnB,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC1F;YACD,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AASD,4DAA4D;AAC5D,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YAAY,YAA0B,EAAE,KAA4B;QAClE,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,QAAQ,EAAE;gBACR,UAAU,EAAE,oBAAoB;gBAChC,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC5C,SAAS,EAAE,cAAc;gBACzB,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzF,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,GAAG,CAAC,KAAK,CAAC,4BAA4B,IAAI,IAAI,CAAC,CAAC;oBAC9C,EAAE,+BAA+B,EAAE,KAAK,CAAC,4BAA4B,EAAE;oBACzE,CAAC,CAAC,EAAE,CAAC;aACN;YACD,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAYD;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,CAAC,OAAO,oDAAoD,CAAC,CAAC;QACtG,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACnC,KAAK,CAAC,YAAY,EAAE;YAClB,GAAG,IAAI;YACP,mBAAmB,EAAE,OAAO;YAC5B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAYD;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,KAAK,cAAc,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oCAAoC;gBAChE,uCAAuC;gBACvC,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAChE,CAAC;QACJ,CAAC;QAED,8EAA8E;QAC9E,IAAI,eAA0B,CAAC;QAC/B,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC5B,eAAe,GAAG,QAAQ,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;YAC5C,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,gCAAgC;oBAC5D,qBAAqB,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW;oBAC7D,6DAA6D;oBAC7D,+BAA+B,CAClC,CAAC;YACJ,CAAC;YACD,eAAe,GAAG,GAAG,CAAC;QACxB,CAAC;QAED,wEAAwE;QACxE,qEAAqE;QACrE,2DAA2D;QAC3D,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAElC,2DAA2D;YAC3D,+DAA+D;YAC/D,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,WAAW;oBAChE,iEAAiE;oBACjE,kEAAkE,CACrE,CAAC;YACJ,CAAC;YACD,2DAA2D;YAC3D,8BAA8B;YAC9B,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,OAAO;oBAC5D,iEAAiE;oBACjE,6DAA6D;oBAC7D,6CAA6C,CAChD,CAAC;YACJ,CAAC;YACD,IAAI,EAAE,IAAI,IAAI;gBAAE,SAAS;YACzB,iEAAiE;YACjE,gEAAgE;YAChE,+DAA+D;YAC/D,MAAM,OAAO,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,aAAa;oBAClE,GAAG,EAAE,4DAA4D;oBACjE,gEAAgE;oBAChE,gEAAgE,CACnE,CAAC;YACJ,CAAC;YACD,oCAAoC;YACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC,QAAQ,OAAO;oBAC7D,iBAAiB,EAAE,WAAW,KAAK,KAAK;oBACxC,YAAY,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACzC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,eAAe;YAC1B,QAAQ,EAAE,eAAe,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YACzE,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE;gBACX,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;gBAC5B,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,IAAI;aACzC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"field.mjs","sourceRoot":"","sources":["../../src/lib/manifest/field.ts"],"names":[],"mappings":"OAAO,EACL,wBAAwB,GAKzB;AA2CD,SAAS,eAAe,CAAC,OAAe;IACtC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAuCD,2EAA2E;AAC3E,aAAa;AACb,2EAA2E;AAE3E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,KAAK;IAgBhB;;;;OAIG;IACH,YAAY,YAA0B,EAAE,KAAiB;QACvD,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAEtD,MAAM,EAAE,GAAwB,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI;YAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;QAChE,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI;YAAE,EAAE,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;QAChE,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI;YAAE,EAAE,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;QACnF,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI;YAAE,EAAE,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC5D,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI;YAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC;QACxD,IAAI,CAAC,6BAA6B,GAAG,KAAK,CAAC,sBAAsB,IAAI,IAAI,CAAC;QAC1E,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAE9C,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,QAAQ;YACX,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBACzB,CAAC,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU;oBAC7C,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;QAE9B,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,0EAA0E;IAE1E,mEAAmE;IACnE,UAAU;QACR,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,8CAA8C;IAC9C,cAAc;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,uEAAuE;IACvE,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IACD,6EAA6E;IAC7E,YAAY;QACV,OAAQ,IAAI,CAAC,SAAS,CAAC,YAAY,CAA2B,IAAI,IAAI,CAAC;IACzE,CAAC;IACD,4DAA4D;IAC5D,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,4DAA4D;IAC5D,SAAS;QACP,OAAO,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC;IAC3C,CAAC;IACD,0DAA0D;IAC1D,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC;IACnC,CAAC;IAED,0EAA0E;IAE1E;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,qBAAqB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;YACjD,cAAc,EAAE,IAAI,CAAC,aAAa;YAClC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;YAC1C,SAAS,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE;YACvE,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,IAAI;YACrC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;YAC1C,uEAAuE;YACvE,WAAW,EAAE,KAAK;YAClB,wBAAwB,EAAE,IAAI,CAAC,uBAAuB,EAAE;YACxD,qBAAqB,EAAE,IAAI,CAAC,oBAAoB,IAAI,IAAI;YACxD,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC;IACJ,CAAC;IAED,0FAA0F;IAClF,uBAAuB;QAC7B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,6BAA6B,CAAC;QACzE,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;QAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC;QAC3D,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;QAC1D,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,iBAAiB,IAAI,CAAC,aAAa,uBAAuB,YAAY,IAAI;gBACxE,4BAA4B,SAAS,iCAAiC;gBACtE,qBAAqB,CACxB,CAAC;QACJ,CAAC;QAED,8EAA8E;QAE9E,OAAO;YACL,oBAAoB,EAAE,IAAI,CAAC,KAAK;YAChC,gBAAgB,EAAE,SAAS;YAC3B,aAAa,EAAE,IAAI,CAAC,YAAY;YAChC,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;YAChD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAChC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE;gBAChC,YAAY,EAAE,CAAC,CAAC,KAAK;gBACrB,QAAQ,EAAE,CAAC,CAAC,QAAQ;aACrB,CAAC,CAAC;YACH,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;SAChD,CAAC;IACJ,CAAC;CACF;AAmBD,8BAA8B;AAC9B,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AASD,6BAA6B;AAC7B,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AASD,mEAAmE;AACnE,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAOD,yDAAyD;AACzD,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC,YAAY,YAA0B,EAAE,KAAoB;QAC1D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAOD,0BAA0B;AAC1B,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AAaD,qBAAqB;AACrB,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAWD,6BAA6B;AAC7B,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AASD,wBAAwB;AACxB,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,YAA0B,EAAE,KAA2B;QACjE,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AASD,sCAAsC;AACtC,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AAOD,2BAA2B;AAC3B,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,YAA0B,EAAE,KAAyB;QAC/D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAOD,yBAAyB;AACzB,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;CACF;AAeD,oCAAoC;AACpC,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAaD,gCAAgC;AAChC,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,YAA0B,EAAE,KAAsB;QAC5D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAOD,gCAAgC;AAChC,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,KAAK,CAAC,YAAY,EAAE,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAkBD,6BAA6B;AAC7B,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,YAAY,YAA0B,EAAE,KAAqB;QAC3D,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,SAAS,GAAG,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAChE,KAAK,CAAC,YAAY,EAAE;YAClB,GAAG,IAAI;YACP,SAAS,EAAE,MAAM;YACjB,QAAQ,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAuBD;;;;;GAKG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,YAA0B,EAAE,KAAuB;QAC7D,MAAM,aAAa,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAClG,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,QAAQ,EAAE;gBACR,UAAU,EAAE,oBAAoB;gBAChC,iBAAiB,EAAE,aAAa;gBAChC,SAAS,EAAE,QAAQ;gBACnB,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC1F;YACD,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AA+BD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YAAY,YAA0B,EAAE,KAA4B;QAClE,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,QAAQ,EAAE;gBACR,UAAU,EAAE,oBAAoB;gBAChC,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC5C,SAAS,EAAE,cAAc;gBACzB,GAAG,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzF,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtF,GAAG,CAAC,KAAK,CAAC,4BAA4B,IAAI,IAAI,CAAC,CAAC;oBAC9C,EAAE,+BAA+B,EAAE,KAAK,CAAC,4BAA4B,EAAE;oBACzE,CAAC,CAAC,EAAE,CAAC;aACN;YACD,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AA2BD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,CAAC,OAAO,oDAAoD,CAAC,CAAC;QACtG,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACnC,KAAK,CAAC,YAAY,EAAE;YAClB,GAAG,IAAI;YACP,mBAAmB,EAAE,OAAO;YAC5B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAuCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,YAA0B,EAAE,KAAwB;QAC9D,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,KAAK,cAAc,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oCAAoC;gBAChE,uCAAuC;gBACvC,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAChE,CAAC;QACJ,CAAC;QAED,8EAA8E;QAC9E,IAAI,eAA0B,CAAC;QAC/B,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC5B,eAAe,GAAG,QAAQ,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;YAC5C,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,gCAAgC;oBAC5D,qBAAqB,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW;oBAC7D,6DAA6D;oBAC7D,+BAA+B,CAClC,CAAC;YACJ,CAAC;YACD,eAAe,GAAG,GAAG,CAAC;QACxB,CAAC;QAED,wEAAwE;QACxE,qEAAqE;QACrE,2DAA2D;QAC3D,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAElC,2DAA2D;YAC3D,+DAA+D;YAC/D,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,WAAW;oBAChE,iEAAiE;oBACjE,kEAAkE,CACrE,CAAC;YACJ,CAAC;YACD,2DAA2D;YAC3D,8BAA8B;YAC9B,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,OAAO;oBAC5D,iEAAiE;oBACjE,6DAA6D;oBAC7D,6CAA6C,CAChD,CAAC;YACJ,CAAC;YACD,IAAI,EAAE,IAAI,IAAI;gBAAE,SAAS;YACzB,iEAAiE;YACjE,gEAAgE;YAChE,+DAA+D;YAC/D,MAAM,OAAO,GAAG,wBAAwB,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,oBAAoB,KAAK,aAAa;oBAClE,GAAG,EAAE,4DAA4D;oBACjE,gEAAgE;oBAChE,gEAAgE,CACnE,CAAC;YACJ,CAAC;YACD,oCAAoC;YACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC,QAAQ,OAAO;oBAC7D,iBAAiB,EAAE,WAAW,KAAK,KAAK;oBACxC,YAAY,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACzC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,KAAK,CAAC,YAAY,EAAE;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,eAAe;YAC1B,QAAQ,EAAE,eAAe,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YACzE,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE;gBACX,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;gBAC5B,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,IAAI;aACzC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -1,28 +1,106 @@
 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 {
-    /** Required. Display name of the view. */
+    /**
+     * Display name of this list view shown in the UI (e.g. `'All members'`).
+     *
+     * Required.
+     */
     name: string;
-    /** Required. Column definitions (live `Field` refs; at least one). */
+    /**
+     * Columns to display, as live {@link Field} references. At least one field is required.
+     *
+     * Required.
+     */
     fields: Field[];
-    /** Required. Whether the view is visible to all users. */
+    /**
+     * Whether this view is visible to all users (`true`) or only the record owner (`false`).
+     *
+     * Required.
+     */
     isPublic: boolean;
-    /** Identity override. Override the view identifier. @default generateId('view') */
+    /**
+     * 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;
-    /** Optional. Sort column (live `Field` ref). Required if `sortOrder` is set. */
+    /**
+     * Field to sort by. Required when `sortOrder` is set.
+     *
+     * Optional.
+     */
     orderBy?: Field;
-    /** Conditional. Sort direction — requires `orderBy`. */
+    /**
+     * Sort direction. One of `'ASC'` | `'DESC'`. Requires `orderBy` to be set.
+     *
+     * Optional.
+     */
     sortOrder?: SortOrder;
-    /** Optional. Object scope. @default 'all' */
+    /**
+     * Record scope for this view. One of `'all'` | `'my_records'`.
+     *
+     * Optional. @default `'all'`
+     */
     objectScope?: ObjectScope;
-    /** Optional. Free-form description. @default null */
+    /**
+     * Human-readable description of this view.
+     *
+     * Optional. @default null
+     */
     description?: string;
-    /** Optional. Per-column configuration overrides. @default {} */
+    /**
+     * Per-column configuration overrides (width, visibility, etc.).
+     *
+     * Optional. @default `{}`
+     */
     columnConfig?: Record<string, any>;
-    /** Optional. RQL filter expression. @default null */
+    /**
+     * 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;
@@ -35,13 +113,26 @@ export declare class ListViewDef {
     private readonly _description;
     private readonly _columnConfig;
     private readonly _rqlFilter;
-    /** 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: CustomObject, props: ListViewDefProps);
-    /** Backend view_id used as this view's identifier. */
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
     getViewId(): string;
-    /** api_name of the CustomObject this view lives on. */
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
     getCustomObjectApiName(): string;
-    /** 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(): Record<string, any>;
 }
 //# sourceMappingURL=list-view.d.mts.map

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

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

@@ -1,28 +1,106 @@
 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 {
-    /** Required. Display name of the view. */
+    /**
+     * Display name of this list view shown in the UI (e.g. `'All members'`).
+     *
+     * Required.
+     */
     name: string;
-    /** Required. Column definitions (live `Field` refs; at least one). */
+    /**
+     * Columns to display, as live {@link Field} references. At least one field is required.
+     *
+     * Required.
+     */
     fields: Field[];
-    /** Required. Whether the view is visible to all users. */
+    /**
+     * Whether this view is visible to all users (`true`) or only the record owner (`false`).
+     *
+     * Required.
+     */
     isPublic: boolean;
-    /** Identity override. Override the view identifier. @default generateId('view') */
+    /**
+     * 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;
-    /** Optional. Sort column (live `Field` ref). Required if `sortOrder` is set. */
+    /**
+     * Field to sort by. Required when `sortOrder` is set.
+     *
+     * Optional.
+     */
     orderBy?: Field;
-    /** Conditional. Sort direction — requires `orderBy`. */
+    /**
+     * Sort direction. One of `'ASC'` | `'DESC'`. Requires `orderBy` to be set.
+     *
+     * Optional.
+     */
     sortOrder?: SortOrder;
-    /** Optional. Object scope. @default 'all' */
+    /**
+     * Record scope for this view. One of `'all'` | `'my_records'`.
+     *
+     * Optional. @default `'all'`
+     */
     objectScope?: ObjectScope;
-    /** Optional. Free-form description. @default null */
+    /**
+     * Human-readable description of this view.
+     *
+     * Optional. @default null
+     */
     description?: string;
-    /** Optional. Per-column configuration overrides. @default {} */
+    /**
+     * Per-column configuration overrides (width, visibility, etc.).
+     *
+     * Optional. @default `{}`
+     */
     columnConfig?: Record<string, any>;
-    /** Optional. RQL filter expression. @default null */
+    /**
+     * 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;
@@ -35,13 +113,26 @@ export declare class ListViewDef {
     private readonly _description;
     private readonly _columnConfig;
     private readonly _rqlFilter;
-    /** 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: CustomObject, props: ListViewDefProps);
-    /** Backend view_id used as this view's identifier. */
+    /**
+     * Returns the stable identifier for this view (e.g. `'view_gym_all_members'`).
+     */
     getViewId(): string;
-    /** api_name of the CustomObject this view lives on. */
+    /**
+     * Returns the api_name of the custom object this view belongs to.
+     */
     getCustomObjectApiName(): string;
-    /** 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(): Record<string, any>;
 }
 //# sourceMappingURL=list-view.d.ts.map