@rippling/rippling-sdk 0.2.0-alpha.44 → 0.2.0-alpha.45

package/src/lib/manifest/custom-object.ts

@@ -271,10 +271,16 @@ export interface CustomObjectProps {
  * });
  *
  * // The object is now a scope — children register through it:
+ * const memberProfileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
  * const firstName = new TextField(memberObj, {
  *   apiName: 'first_name__c',
  *   displayName: 'First name',
  *   required: true,
+ *   section: memberProfileSection,
  * });
  * ```
  *

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

@@ -415,7 +415,11 @@ export class ExistingManifestContext {
     return this.getOrLoad(cacheKey, () => {
       const customObject = this.loadCustomObject(customObjectApiName);
       this.loadPageLayoutDependencies(customObjectApiName, component);
-      return CustomObjectPageLayout._fromExistingComponent(customObject, component);
+      return CustomObjectPageLayout._fromExistingComponent(customObject, component, (fieldApiName) => {
+        const fieldComponent = this.findFieldComponent(customObjectApiName, fieldApiName);
+        const sectionId = fieldComponent?.['section'];
+        return typeof sectionId === 'string' ? sectionId : undefined;
+      });
     });
   }
 
@@ -651,7 +655,6 @@ export class ExistingManifestContext {
   private loadSectionDependencies(customObjectApiName: string, section: unknown): void {
     if (section == null || typeof section !== 'object') return;
     const sectionRecord = section as Record<string, any>;
-    this.loadFieldSectionIfPresent(customObjectApiName, sectionRecord['key']);
     for (const field of sectionRecord['fields'] ?? []) {
       this.loadSerializedFieldDependency(customObjectApiName, field);
     }
@@ -683,16 +686,6 @@ export class ExistingManifestContext {
     }
   }
 
-  private loadFieldSectionIfPresent(customObjectApiName: string, sectionId: unknown): void {
-    if (typeof sectionId !== 'string') return;
-    const component = this.ofType('CUSTOM_OBJECT_FIELD_SECTION').find(
-      (candidate) => candidate['model_name'] === customObjectApiName && candidate['section_id'] === sectionId,
-    );
-    if (component != null) {
-      this.loadFieldSectionComponent(component);
-    }
-  }
-
   private loadRequiredFieldSection(customObjectApiName: string, sectionId: string, ownerLabel: string): void {
     const component = this.ofType('CUSTOM_OBJECT_FIELD_SECTION').find(
       (candidate) => candidate['model_name'] === customObjectApiName && candidate['section_id'] === sectionId,

package/src/lib/manifest/field.ts

@@ -6,7 +6,7 @@ import {
   type SummaryFilterOperator,
 } from './_helpers';
 import type { CustomObject } from './custom-object';
-import type { CustomObjectFieldSection } from './custom-object-field-section';
+import { CustomObjectFieldSection } from './custom-object-field-section';
 import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { ManifestComponentDeletion } from './manifest-builder';
 import { requireObjectComponentField, requireStringComponentField } from './_existing-component-fields';
@@ -71,7 +71,7 @@ interface CommonFieldProps {
   apiName: string;
   displayName: string;
   description?: string;
-  section?: CustomObjectFieldSection;
+  section: CustomObjectFieldSection;
 }
 
 /**
@@ -94,7 +94,7 @@ export interface FieldProps {
   formulaAttrMetas?: Record<string, any> | null | undefined;
   derivedAggregatedField?: Record<string, any> | null | undefined;
   derivedFieldFormula?: string | null | undefined;
-  section?: CustomObjectFieldSection | null | undefined;
+  section: CustomObjectFieldSection;
   maxLength?: number | undefined;
   decimalPlaces?: number | undefined;
   currency?: string | undefined;
@@ -107,14 +107,34 @@ export interface FieldLoadFromExistingOptions extends ExistingManifestContextOpt
   customObjectApiName?: string;
 }
 
-function normalizeSectionInput(section: CustomObjectFieldSection | string | null | undefined): string | null {
-  if (section == null) return null;
+const EXISTING_FIELD_SECTION_ID = Symbol('Field.existingFieldSectionId');
+
+function normalizeSectionInput(
+  customObject: CustomObject,
+  fieldApiName: string,
+  section: CustomObjectFieldSection | string | null | undefined,
+): string {
+  if (section == null) {
+    throw new Error(
+      `Field "${fieldApiName}" requires a CustomObjectFieldSection. ` +
+        'Create a CustomObjectFieldSection for the custom object and pass it as section.',
+    );
+  }
   if (typeof section === 'string') {
     throw new TypeError(
       `Field section must be a CustomObjectFieldSection object; received raw section id "${section}". ` +
         'Load/include the existing field section first.',
     );
   }
+  if (!(section instanceof CustomObjectFieldSection)) {
+    throw new TypeError('Field section must be a CustomObjectFieldSection object.');
+  }
+  if (section.getModelApiName() !== customObject.getApiName()) {
+    throw new Error(
+      `Field "${fieldApiName}" section "${section.getSectionId()}" belongs to ` +
+        `"${section.getModelApiName()}", but the field belongs to "${customObject.getApiName()}".`,
+    );
+  }
   return section.getSectionId();
 }
 
@@ -196,6 +216,7 @@ class ExistingFieldReference {
  *   displayName: 'First name',
  *   required: true,
  *   maxLength: 80,
+ *   section: profileSection,
  * });
  * ```
  *
@@ -256,8 +277,11 @@ export class Field {
     this._derivedFieldFormula = props.derivedFieldFormula ?? null;
     this._summarySpec = props.summarySpec ?? null;
 
+    const existingSectionId = (
+      props as unknown as Record<typeof EXISTING_FIELD_SECTION_ID, string | undefined>
+    )[EXISTING_FIELD_SECTION_ID];
     const rawSection = props.section as CustomObjectFieldSection | string | null | undefined;
-    this._section = normalizeSectionInput(rawSection);
+    this._section = existingSectionId ?? normalizeSectionInput(customObject, props.apiName, rawSection);
 
     customObject._register(this);
   }
@@ -274,11 +298,11 @@ export class Field {
 
   /** @internal Hydrates a custom object field from existing manifest wire JSON. */
   static _fromExistingComponent(customObject: CustomObject, component: Record<string, any>): Field {
-    const props: FieldProps = {
+    const props = {
       apiName: requireStringComponentField(component, 'field_api_name', Field.componentType),
       displayName: requireStringComponentField(component, 'field_display_name', Field.componentType),
       dataType: cloneJson(requireObjectComponentField(component, 'data_type', Field.componentType)),
-    };
+    } as FieldProps;
     if (component['description'] !== undefined) props.description = component['description'];
     if (component['is_required'] !== undefined) props.required = component['is_required'];
     if (component['is_unique'] !== undefined) props.unique = component['is_unique'];
@@ -291,8 +315,18 @@ export class Field {
     }
     if (component['derived_field_formula'] !== undefined)
       props.derivedFieldFormula = component['derived_field_formula'];
+    const sectionId = component['section'];
+    if (typeof sectionId !== 'string' || sectionId.length === 0) {
+      throw new Error(
+        `CUSTOM_OBJECT_FIELD ${customObject.getApiName()}.${
+          props.apiName
+        } is missing required field section. ` +
+          'Add a CUSTOM_OBJECT_FIELD_SECTION component and set the field section to its section_id.',
+      );
+    }
+    (props as unknown as Record<typeof EXISTING_FIELD_SECTION_ID, string>)[EXISTING_FIELD_SECTION_ID] =
+      sectionId;
     const field = new Field(customObject, props);
-    if (typeof component['section'] === 'string') field._assignSection(component['section']);
     return field;
   }
 
@@ -829,6 +863,7 @@ export interface FormulaFieldProps extends CommonFieldProps {
  *   fieldType: 'TEXT',
  *   maxLength: 200,
  *   formula: "CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))",
+ *   section: profileSection,
  * });
  * ```
  */
@@ -900,6 +935,7 @@ export interface SummaryFieldProps extends CommonFieldProps {
  *   aggregates: enrollmentMemberRef,
  *   using: 'COUNT',
  *   lookup: enrollmentSessionRef,  // ParentChildField on enrollmentObj → sessionObj
+ *   section: sessionStatsSection,
  * });
  * ```
  *

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.44";
+export declare const VERSION = "0.2.0-alpha.45";
 //# 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.44'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.45'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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