@rippling/rippling-sdk 0.2.0-alpha.54 → 0.2.0-alpha.56

package/src/lib/manifest/list-view.ts

@@ -1,5 +1,5 @@
 import { generateId, type ObjectScope, type SortOrder } from './_helpers';
-import type { CustomObject } from './custom-object';
+import type { CustomObject, CustomObjectFieldInput } from './custom-object';
 import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { Field } from './field';
 import type { ManifestComponentDeletion } from './manifest-builder';
@@ -36,11 +36,11 @@ export interface ListViewDefProps {
    */
   name: string;
   /**
-   * Columns to display, as live {@link Field} references. At least one field is required.
+   * Columns to display, as live {@link Field} references or standard field names. At least one field is required.
    *
    * Required.
    */
-  fields: Field[];
+  fields: CustomObjectFieldInput[];
   /**
    * Whether this view is visible to all users (`true`) or only the record owner (`false`).
    *
@@ -59,7 +59,7 @@ export interface ListViewDefProps {
    *
    * Optional.
    */
-  orderBy?: Field;
+  orderBy?: CustomObjectFieldInput;
   /**
    * Sort direction. One of `'ASC'` | `'DESC'`. Requires `orderBy` to be set.
    *
@@ -113,8 +113,8 @@ export interface ListViewDefLoadFromExistingOptions extends ExistingManifestCont
  *   viewId: 'view_gym_all_members',
  *   name: 'All members',
  *   description: 'Directory with membership status',
- *   fields: [memberDisplayName, memberEmail, memberPhone, memberStatusField, memberJoinDate],
- *   orderBy: memberLastName,
+ *   fields: ['name', memberEmail, memberPhone, memberStatusField, memberJoinDate],
+ *   orderBy: 'name',
  *   sortOrder: 'ASC',
  *   isPublic: true,
  *   objectScope: 'all',
@@ -172,9 +172,9 @@ export class ListViewDef {
     this._viewId = props.viewId ?? generateId('view');
     this._customObjectApiName = customObject.getApiName();
     this._name = props.name;
-    this._fields = [...props.fields];
+    this._fields = props.fields.map((field) => customObject._resolveField(field));
     this._isPublic = props.isPublic;
-    this._orderBy = props.orderBy;
+    this._orderBy = props.orderBy == null ? undefined : customObject._resolveField(props.orderBy);
     this._sortOrder = props.sortOrder;
     this._objectScope = props.objectScope ?? 'all';
     this._description = props.description;