@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.83

package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts

@@ -1,9 +1,13 @@
 /*
  * Existing manifest mutations.
  *
- * This example keeps the existing manifest JSON inline, hydrates it back into
- * SDK objects, removes layout content, adds different layout content, and
- * prints the updated manifest JSON.
+ * This example keeps the existing manifest JSON inline, rebinds a typed
+ * definition onto the existing manifest, removes layout content, adds
+ * different layout content, and prints the updated manifest JSON.
+ *
+ * Current boundary: rebinding avoids most manual load-from-existing plumbing,
+ * but creating brand-new fields/sections in an existing manifest still uses
+ * low-level manifest classes as an explicit escape hatch.
  *
  * Run:
  *   yarn -s tsn examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts \
@@ -11,9 +15,15 @@
  */
 
 import {
-  CustomObject,
+  defineCustomObject,
+  phone,
+  radio,
+  section,
+  text,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+import { bindExistingManifestCustomObject } from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import {
   CustomObjectFieldSection,
-  CustomObjectPageLayout,
   type ExistingManifest,
   ManifestBuilder,
   RadioField,
@@ -161,24 +171,58 @@ const existingManifestJson: ExistingManifest = {
   ],
 };
 
-const manifest = ManifestBuilder.loadFromExistingJson(existingManifestJson);
-const memberObj = CustomObject.loadFromExisting('gym_member__c');
-const profileSection = CustomObjectFieldSection.loadFromExisting('sec_gm_profile', {
-  customObjectApiName: memberObj.getApiName(),
-});
-const membershipSection = CustomObjectFieldSection.loadFromExisting('sec_gm_membership', {
-  customObjectApiName: memberObj.getApiName(),
-});
-const memberLayout = CustomObjectPageLayout.loadFromExisting('layout_gym_member', {
-  customObjectApiName: memberObj.getApiName(),
+const gymMemberDefinition = defineCustomObject({
+  name: 'gym_member',
+  displayName: 'Member',
+  pluralLabel: 'Members',
+  category: 'gym',
+  description: 'Gym member profile, contact, and membership status',
+  sections: {
+    profile: section('Profile', { sectionId: 'sec_gm_profile' }),
+    membership: section('Membership', { sectionId: 'sec_gm_membership' }),
+  },
+  fields: {
+    first_name: text({
+      displayName: 'First name',
+      description: 'First name',
+      required: true,
+      maxLength: 80,
+      section: 'profile',
+    }),
+    last_name: text({
+      displayName: 'Last name',
+      description: 'Last name',
+      required: true,
+      maxLength: 80,
+      section: 'profile',
+    }),
+    phone: phone({
+      displayName: 'Phone',
+      description: 'Phone',
+      section: 'profile',
+    }),
+    membership_status: radio({
+      displayName: 'Membership status',
+      description: 'Membership status',
+      options: ['Active', 'Frozen', 'Cancelled', 'Trial'],
+      required: true,
+      section: 'membership',
+    }),
+  },
 });
 
-const preferredName = new TextField(memberObj, {
+const manifest = ManifestBuilder.loadFromExistingJson(existingManifestJson);
+const member = bindExistingManifestCustomObject(gymMemberDefinition);
+const memberLayout = member.loadPageLayout('layout_gym_member');
+
+// Escape hatch: new field creation inside an existing-manifest mutation still
+// drops to the low-level manifest class model today.
+const preferredName = new TextField(member.object, {
   apiName: 'preferred_name__c',
   displayName: 'Preferred name',
   description: 'Preferred name field',
   maxLength: 80,
-  section: profileSection,
+  section: member.sections.profile,
 });
 
 // Remove an existing field from one section, then add a different field there.
@@ -187,27 +231,28 @@ const preferredName = new TextField(memberObj, {
 memberLayout
   .removeField('phone__c', {
     tabKey: 'member',
-    section: profileSection,
+    section: member.sections.profile,
     removeAll: false,
   })
   .addField(preferredName, {
     tabKey: 'member',
-    section: profileSection,
+    section: member.sections.profile,
     position: 2,
   });
 
-const marketingSection = new CustomObjectFieldSection(memberObj, {
+// Escape hatch: new section creation likewise stays low-level for now.
+const marketingSection = new CustomObjectFieldSection(member.object, {
   sectionId: 'sec_gm_marketing',
   name: 'Marketing',
 });
-const marketingOptIn = new RadioField(memberObj, {
+const marketingOptIn = new RadioField(member.object, {
   apiName: 'marketing_opt_in__c',
   displayName: 'Marketing opt-in',
   description: 'Marketing opt-in field',
   options: ['Yes', 'No', 'Unknown'],
   section: marketingSection,
 });
-const referralSource = new TextField(memberObj, {
+const referralSource = new TextField(member.object, {
   apiName: 'referral_source__c',
   displayName: 'Referral source',
   description: 'Referral source field',
@@ -218,7 +263,7 @@ const referralSource = new TextField(memberObj, {
 // Remove one existing section from the layout, then add a different one.
 // The removed section component and its fields remain in the manifest.
 memberLayout
-  .removeSection(membershipSection, {
+  .removeSection(member.sections.membership, {
     tabKey: 'member',
     removeAll: false,
   })