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

package/src/lib/manifest/existing-manifest-context.ts

@@ -334,9 +334,15 @@ export class ExistingManifestContext {
     );
     const cacheKey = this.cacheKey('CUSTOM_OBJECT', customObjectApiName);
     return this.getOrLoad(cacheKey, () => {
-      return CustomObject._fromExistingComponent(this.getManifestBuilder(), component, (categoryApiName) =>
-        this.loadRequiredCategoryForCustomObject(categoryApiName, customObjectApiName),
+      const customObject = CustomObject._fromExistingComponent(
+        this.getManifestBuilder(),
+        component,
+        (categoryApiName) => this.loadRequiredCategoryForCustomObject(categoryApiName, customObjectApiName),
       );
+      customObject._setStandardFieldResolver((fieldApiName) =>
+        this.loadFieldByObjectAndApi(customObjectApiName, fieldApiName),
+      );
+      return customObject;
     });
   }
 

package/src/lib/manifest/field.ts

@@ -184,6 +184,10 @@ class ExistingFieldReference {
     return this.component['derived_aggregated_field'] != null;
   }
 
+  isStandard(): boolean {
+    return this.component['is_standard'] === true;
+  }
+
   getSectionId(): string | null {
     return this._section;
   }
@@ -345,7 +349,10 @@ export class Field {
     return new ExistingFieldReference(customObjectApiName, cloneJson(component)) as unknown as Field;
   }
 
-  /** @internal Creates a non-registered reference for a known wire field name. */
+  /**
+   * @internal Creates a non-registered reference for a known wire field name.
+   * @deprecated Agent-facing code should use CustomObject.standardFields or CustomObject.standardField(...).
+   */
   static _syntheticReference(customObjectApiName: string, fieldApiName: string): Field {
     return new ExistingFieldReference(customObjectApiName, {
       type: 'CUSTOM_OBJECT_FIELD',
@@ -396,6 +403,10 @@ export class Field {
   isSummary(): boolean {
     return this._summarySpec != null;
   }
+  /** Returns `true` if this is a platform-managed standard field reference. */
+  isStandard(): boolean {
+    return false;
+  }
   /** Returns the field section id assigned to this field, if any. */
   getSectionId(): string | null {
     return this._section;
@@ -861,9 +872,9 @@ export interface FormulaFieldProps extends CommonFieldProps {
  *
  * @example
  * ```ts
- * const memberDisplayName = new FormulaField(memberObj, {
- *   apiName: 'member_display_name__c',
- *   displayName: 'Display name',
+ * const memberLabel = new FormulaField(memberObj, {
+ *   apiName: 'member_label__c',
+ *   displayName: 'Member label',
  *   fieldType: 'TEXT',
  *   maxLength: 200,
  *   formula: "CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))",

package/src/lib/manifest/index.ts

@@ -20,7 +20,16 @@ export { App, type AppIcon, type AppPage, type AppProps } from './app';
 
 export { Category, type CategoryProps } from './category';
 
-export { CustomObject, type CustomObjectProps, type IconConfig } from './custom-object';
+export {
+  CustomObject,
+  type CustomObjectFieldInput,
+  type CustomObjectProps,
+  type CustomObjectStandardFieldApiName,
+  type CustomObjectStandardFieldIdentifier,
+  type CustomObjectStandardFieldKey,
+  type CustomObjectStandardFields,
+  type IconConfig,
+} from './custom-object';
 
 export {
   CustomObjectFieldSection,

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;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.56'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.55";
+export declare const VERSION = "0.2.0-alpha.56";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.55";
+export declare const VERSION = "0.2.0-alpha.56";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.55'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.56'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.55'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.56'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map