@rippling/rippling-sdk 0.2.0-alpha.40 → 0.2.0-alpha.41

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

@@ -241,7 +241,7 @@ export interface AddPageLayoutFieldOptions extends SectionFieldOptions {
    * Existing layouts often use layout section keys that differ from field section
    * ids. Pass this when the field was not constructed with a `section`.
    */
-  fieldSection?: CustomObjectFieldSection | string;
+  fieldSection?: CustomObjectFieldSection;
   /** Insert position inside the section field list. Optional. @default `'end'` */
   position?: PageLayoutMutationPosition;
   /** Allow the same field to appear twice in the same section. Optional. @default false */
@@ -838,8 +838,8 @@ export class CustomObjectPageLayout {
    * Adds multiple fields to an existing layout section.
    *
    * Fields are inserted in the order provided. If a field does not already have
-   * field-section metadata, it is assigned to `options.fieldSection` when
-   * provided, otherwise to `options.sectionKey`.
+   * field-section metadata, pass `options.fieldSection` so the corresponding
+   * `CUSTOM_OBJECT_FIELD_SECTION` component is registered in the manifest.
    */
   addFields(fields: Field[], options: AddPageLayoutFieldsOptions): this {
     if (fields.length === 0) return this;
@@ -1196,21 +1196,34 @@ export class CustomObjectPageLayout {
   private assignFieldSectionForMutation(
     field: Field,
     fallbackSectionKey: string,
-    fieldSection: CustomObjectFieldSection | string | undefined,
+    fieldSection: CustomObjectFieldSection | undefined,
   ): void {
-    if (fieldSection != null) {
-      if (typeof fieldSection !== 'string' && fieldSection.getModelApiName() !== this._customObjectApiName) {
+    const rawFieldSection = fieldSection as CustomObjectFieldSection | string | undefined;
+    if (rawFieldSection != null) {
+      if (typeof rawFieldSection === 'string') {
+        throw new TypeError(
+          `CustomObjectPageLayout fieldSection must be a CustomObjectFieldSection object; ` +
+            `received raw section id "${rawFieldSection}". Load/include the existing field section first.`,
+        );
+      }
+      if (rawFieldSection.getModelApiName() !== this._customObjectApiName) {
         throw new Error(
-          `CustomObjectPageLayout field section "${fieldSection.getSectionId()}" belongs to ` +
-            `"${fieldSection.getModelApiName()}", but the layout belongs to "${this._customObjectApiName}".`,
+          `CustomObjectPageLayout field section "${rawFieldSection.getSectionId()}" belongs to ` +
+            `"${rawFieldSection.getModelApiName()}", but the layout belongs to "${
+              this._customObjectApiName
+            }".`,
         );
       }
-      field._assignSection(fieldSection);
+      field._assignSection(rawFieldSection);
       return;
     }
 
     if (field.getSectionId() == null) {
-      field._assignSection(fallbackSectionKey);
+      throw new Error(
+        `CustomObjectPageLayout field "${field.getApiName()}" is missing field-section metadata. ` +
+          `Construct the field with a CustomObjectFieldSection or pass fieldSection when adding it to ` +
+          `section "${fallbackSectionKey}".`,
+      );
     }
   }
 

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

@@ -600,6 +600,7 @@ export class ExistingManifestContext {
     }
     if (field == null || typeof field !== 'object') return;
     const record = field as Record<string, any>;
+    this.loadFieldSectionIfPresent(customObjectApiName, record['fieldSection'] ?? record['field_section']);
     this.loadFieldDependencyIfString(customObjectApiName, record['fieldRqlName'] ?? record['field_rql_name']);
   }
 

package/src/lib/manifest/field.ts

@@ -70,7 +70,7 @@ interface CommonFieldProps {
   apiName: string;
   displayName: string;
   description?: string;
-  section?: CustomObjectFieldSection | string;
+  section?: CustomObjectFieldSection;
 }
 
 /**
@@ -93,7 +93,7 @@ export interface FieldProps {
   formulaAttrMetas?: Record<string, any> | null | undefined;
   derivedAggregatedField?: Record<string, any> | null | undefined;
   derivedFieldFormula?: string | null | undefined;
-  section?: CustomObjectFieldSection | string | null | undefined;
+  section?: CustomObjectFieldSection | null | undefined;
   maxLength?: number | undefined;
   decimalPlaces?: number | undefined;
   currency?: string | undefined;
@@ -106,6 +106,17 @@ export interface FieldLoadFromExistingOptions extends ExistingManifestContextOpt
   customObjectApiName?: string;
 }
 
+function normalizeSectionInput(section: CustomObjectFieldSection | string | null | undefined): string | null {
+  if (section == null) return null;
+  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.',
+    );
+  }
+  return section.getSectionId();
+}
+
 class ExistingFieldReference {
   private _section: string | null;
 
@@ -240,11 +251,8 @@ export class Field {
     this._derivedFieldFormula = props.derivedFieldFormula ?? null;
     this._summarySpec = props.summarySpec ?? null;
 
-    const rawSection = props.section;
-    this._section =
-      rawSection == null ? null
-      : typeof rawSection === 'string' ? rawSection
-      : rawSection.getSectionId();
+    const rawSection = props.section as CustomObjectFieldSection | string | null | undefined;
+    this._section = normalizeSectionInput(rawSection);
 
     customObject._register(this);
   }
@@ -278,8 +286,9 @@ export class Field {
     }
     if (component['derived_field_formula'] !== undefined)
       props.derivedFieldFormula = component['derived_field_formula'];
-    if (component['section'] !== undefined) props.section = component['section'];
-    return new Field(customObject, props);
+    const field = new Field(customObject, props);
+    if (typeof component['section'] === 'string') field._assignSection(component['section']);
+    return field;
   }
 
   /** @internal Creates a non-registered reference for standard or external fields. */

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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