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

package/examples/manifest/gym-membership-management/gym-membership-management.ts

@@ -14,25 +14,34 @@
  *   (With npx, use `2>/dev/null` before `>` if npm prints warnings into the file.)
  */
 
+import * as fs from 'node:fs';
 import * as path from 'node:path';
-import { toCustomCategoryApiName } from '@rippling/rippling-sdk/core/platform/custom-objects';
 import {
-  createTypedRuleHelpers,
-  defineSduiPageFromFunctionFile,
-  defineTypedListView,
-  defineTypedPageLayout,
-  defineTypedValidation,
-  defineTypedRule,
-  registerManifestCustomObjects,
-} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
-import { App, Category, ManifestBuilder, SduiPage, SummaryField } from '@rippling/rippling-sdk/lib/manifest';
-import {
-  enrollmentDefinition,
-  GYM_CATEGORY,
-  memberDefinition,
-  sessionDefinition,
-  trainerDefinition,
-} from './schema';
+  App,
+  Category,
+  CustomObject,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  DatetimeField,
+  DateField,
+  EmailField,
+  FormulaField,
+  ListViewDef,
+  LongTextField,
+  LookupField,
+  ManifestBuilder,
+  ManifestFunction,
+  NumberField,
+  ParentChildField,
+  PhoneField,
+  RadioField,
+  Rule,
+  SelectField,
+  SduiPage,
+  SummaryField,
+  TextField,
+  Validation,
+} from '@rippling/rippling-sdk/lib/manifest';
 
 const manifest = new ManifestBuilder({
   key: 'gym_membership_management',
@@ -42,138 +51,455 @@ const manifest = new ManifestBuilder({
 });
 
 const gymCategory = new Category(manifest, {
-  apiName: toCustomCategoryApiName(GYM_CATEGORY),
+  apiName: 'gym__c',
   name: 'Gym',
   description: 'Memberships, staff, schedules, and attendance',
 });
 
-const [member, trainer, session, enrollment] = registerManifestCustomObjects(manifest, {
+// ── Member ────────────────────────────────────────────────────────────────────
+const memberObj = new CustomObject(manifest, {
+  apiName: 'gym_member__c',
+  name: 'Member',
+  pluralLabel: 'Members',
   category: gymCategory,
-  definitions: [memberDefinition, trainerDefinition, sessionDefinition, enrollmentDefinition] as const,
+  description: 'Gym member profile, contact, and membership status',
+  icon: { emoji: '🏋️' },
+});
+
+const memberProfileSection = new CustomObjectFieldSection(memberObj, {
+  name: 'Profile',
+  sectionId: 'sec_gm_profile',
+});
+
+const memberMembershipSection = new CustomObjectFieldSection(memberObj, {
+  name: 'Membership',
+  sectionId: 'sec_gm_membership',
+});
+
+const memberFirstName = new TextField(memberObj, {
+  apiName: 'first_name__c',
+  displayName: 'First name',
+  description: 'First name field',
+  required: true,
+  maxLength: 80,
+  section: memberProfileSection,
+});
+
+const memberLastName = new TextField(memberObj, {
+  apiName: 'last_name__c',
+  displayName: 'Last name',
+  description: 'Last name field',
+  required: true,
+  maxLength: 80,
+  section: memberProfileSection,
+});
+
+const memberEmail = new EmailField(memberObj, {
+  apiName: 'email__c',
+  displayName: 'Email',
+  description: 'Email field',
+  unique: true,
+  section: memberProfileSection,
+});
+
+const memberPhone = new PhoneField(memberObj, {
+  apiName: 'phone__c',
+  displayName: 'Phone',
+  description: 'Phone field',
+  section: memberProfileSection,
+});
+
+const memberStatusField = new RadioField(memberObj, {
+  apiName: 'membership_status__c',
+  displayName: 'Membership status',
+  description: 'Membership status field',
+  options: ['Active', 'Frozen', 'Cancelled', 'Trial'],
+  required: true,
+  section: memberMembershipSection,
+});
+
+const memberJoinDate = new DateField(memberObj, {
+  apiName: 'join_date__c',
+  displayName: 'Join date',
+  description: 'Join date field',
+  section: memberMembershipSection,
+});
+
+const memberEmergencyField = new LongTextField(memberObj, {
+  apiName: 'emergency_contact__c',
+  displayName: 'Emergency contact',
+  maxLength: 2000,
+  description: 'Name and phone for emergencies',
+  section: memberMembershipSection,
+});
+
+const memberPreferredClassTypesField = new SelectField(memberObj, {
+  apiName: 'preferred_class_types__c',
+  displayName: 'Preferred class types',
+  description: 'One or more class types the member enjoys',
+  options: ['Yoga', 'Spin', 'HIIT', 'Strength', 'Pilates', 'Dance', 'Aquatics'],
+  section: memberMembershipSection,
+});
+
+// ── Trainer ─────────────────────────────────────────────────────────────────
+const trainerObj = new CustomObject(manifest, {
+  apiName: 'gym_trainer__c',
+  name: 'Trainer',
+  pluralLabel: 'Trainers',
+  category: gymCategory,
+  description: 'Instructors and coaches who lead scheduled classes',
+  icon: { emoji: '🎯' },
+});
+
+const trainerSection = new CustomObjectFieldSection(trainerObj, {
+  name: 'Trainer',
+  sectionId: 'sec_tr_profile',
+});
+
+const trainerEmailField = new EmailField(trainerObj, {
+  apiName: 'email__c',
+  displayName: 'Email',
+  description: 'Email field',
+  section: trainerSection,
+});
+
+const trainerSpecialtyField = new RadioField(trainerObj, {
+  apiName: 'specialty__c',
+  displayName: 'Primary specialty',
+  description: 'Primary specialty field',
+  options: ['Yoga', 'Spin', 'HIIT', 'Strength', 'Pilates', 'Dance', 'Aquatics', 'General'],
+  section: trainerSection,
+});
+
+const trainerBioField = new LongTextField(trainerObj, {
+  apiName: 'bio__c',
+  displayName: 'Bio & certifications',
+  description: 'Bio & certifications field',
+  maxLength: 4000,
+  section: trainerSection,
+});
+
+const trainerLabelField = new FormulaField(trainerObj, {
+  apiName: 'trainer_label__c',
+  displayName: 'List label',
+  description: 'List label field',
+  fieldType: 'TEXT',
+  maxLength: 220,
+  formula: "CONCATENATE(name, ' · ', specialty__c)",
+  section: trainerSection,
+});
+
+// ── Class session ───────────────────────────────────────────────────────────
+const sessionObj = new CustomObject(manifest, {
+  apiName: 'gym_class_session__c',
+  name: 'Class session',
+  pluralLabel: 'Class sessions',
+  category: gymCategory,
+  description: 'A scheduled class with assigned trainer, time, and capacity',
+  icon: { emoji: '📅' },
+});
+
+const sessionScheduleSection = new CustomObjectFieldSection(sessionObj, {
+  name: 'Schedule',
+  sectionId: 'sec_cs_schedule',
+});
+
+const sessionTrainerSection = new CustomObjectFieldSection(sessionObj, {
+  name: 'Class & room',
+  sectionId: 'sec_cs_class',
+});
+
+const sessionTrainerRef = new LookupField(sessionObj, {
+  apiName: 'trainer_ref__c',
+  displayName: 'Trainer',
+  target: trainerObj,
+  relatedDataLabel: 'Class sessions',
+  required: true,
+  description: 'Instructor leading this session',
+  section: sessionScheduleSection,
+});
+
+const sessionStartField = new DatetimeField(sessionObj, {
+  apiName: 'start_time__c',
+  displayName: 'Start',
+  required: true,
+  description: 'Session start (local)',
+  section: sessionScheduleSection,
+});
+
+const sessionEndField = new DatetimeField(sessionObj, {
+  apiName: 'end_time__c',
+  displayName: 'End',
+  required: true,
+  description: 'Session end (local)',
+  section: sessionScheduleSection,
+});
+
+const sessionClassTypeField = new RadioField(sessionObj, {
+  apiName: 'class_type__c',
+  displayName: 'Class type',
+  description: 'Class type field',
+  options: [
+    'Yoga',
+    'Spin',
+    'HIIT',
+    'Strength',
+    'Pilates',
+    'Dance',
+    'Aquatics',
+    'Recovery / stretch',
+    'Other',
+  ],
+  required: true,
+  section: sessionTrainerSection,
+});
+
+const sessionRoomField = new TextField(sessionObj, {
+  apiName: 'room_name__c',
+  displayName: 'Studio / room',
+  maxLength: 80,
+  description: 'E.g. Studio A, Pool lane 2',
+  section: sessionTrainerSection,
+});
+
+const sessionCapacityField = new NumberField(sessionObj, {
+  apiName: 'capacity__c',
+  displayName: 'Capacity',
+  decimalPlaces: 0,
+  description: 'Maximum attendees for this session',
+  section: sessionTrainerSection,
+});
+
+const sessionNotesField = new LongTextField(sessionObj, {
+  apiName: 'session_notes__c',
+  displayName: 'Notes',
+  description: 'Notes field',
+  maxLength: 4000,
+  section: sessionTrainerSection,
+});
+
+const sessionDayField = new FormulaField(sessionObj, {
+  apiName: 'session_date__c',
+  displayName: 'Session date',
+  fieldType: 'DATE',
+  formula: "DATETRUNC('DAY', start_time__c)",
+  description: 'Calendar day for filtering “today” views',
+  section: sessionScheduleSection,
+});
+
+const sessionBoardLabel = new FormulaField(sessionObj, {
+  apiName: 'session_board_label__c',
+  displayName: 'Board label',
+  description: 'Board label field',
+  fieldType: 'TEXT',
+  maxLength: 260,
+  formula: "CONCATENATE(class_type__c, ' · ', room_name__c)",
+  section: sessionScheduleSection,
+});
+
+// ── Enrollment (child of session) ───────────────────────────────────────────
+const enrollmentObj = new CustomObject(manifest, {
+  apiName: 'gym_class_enrollment__c',
+  name: 'Class enrollment',
+  pluralLabel: 'Class enrollments',
+  category: gymCategory,
+  description: 'Member registration for a session with attendance and check-in',
+  icon: { emoji: '✅' },
+});
+
+const enrollmentSessionSection = new CustomObjectFieldSection(enrollmentObj, {
+  name: 'Session & member',
+  sectionId: 'sec_ce_link',
+});
+
+const enrollmentAttendanceSection = new CustomObjectFieldSection(enrollmentObj, {
+  name: 'Attendance',
+  sectionId: 'sec_ce_att',
+});
+
+const enrollmentSessionRef = new ParentChildField(enrollmentObj, {
+  apiName: 'class_session_ref__c',
+  displayName: 'Class session',
+  target: sessionObj,
+  relatedDataLabel: 'Enrollments',
+  parentChildType: 'PRIMARY',
+  enableParentOwnerInheritance: false,
+  description: 'Which scheduled class this row belongs to',
+  section: enrollmentSessionSection,
+});
+
+const enrollmentMemberRef = new LookupField(enrollmentObj, {
+  apiName: 'member_ref__c',
+  displayName: 'Member',
+  description: 'Member field',
+  target: memberObj,
+  relatedDataLabel: 'Class enrollments',
+  required: true,
+  section: enrollmentSessionSection,
+});
+
+const enrollmentAttendanceField = new RadioField(enrollmentObj, {
+  apiName: 'attendance_status__c',
+  displayName: 'Attendance',
+  options: ['Registered', 'Checked in', 'Late', 'No-show', 'Cancelled'],
+  required: true,
+  description: 'Front desk: set to Checked in when the member arrives',
+  section: enrollmentAttendanceSection,
+});
+
+const enrollmentCheckedInAt = new DatetimeField(enrollmentObj, {
+  apiName: 'checked_in_at__c',
+  displayName: 'Checked in at',
+  description: 'Timestamp when staff recorded arrival (optional)',
+  section: enrollmentAttendanceSection,
+});
+
+const enrollmentNotesField = new LongTextField(enrollmentObj, {
+  apiName: 'enrollment_notes__c',
+  displayName: 'Notes',
+  description: 'Notes field',
+  maxLength: 2000,
+  section: enrollmentAttendanceSection,
+});
+
+const enrollmentRosterTitle = new FormulaField(enrollmentObj, {
+  apiName: 'roster_row_label__c',
+  displayName: 'Roster row label',
+  description: 'Roster row label field',
+  fieldType: 'TEXT',
+  maxLength: 160,
+  formula: "CONCATENATE(attendance_status__c, ' · Enrollment')",
+  section: enrollmentAttendanceSection,
 });
 
 // ── Rollups ─────────────────────────────────────────────────────────────────
-const enrollmentCountOnSession = new SummaryField(session.object, {
+const enrollmentCountOnSession = new SummaryField(sessionObj, {
   apiName: 'enrollment_count__c',
   displayName: 'Enrolled (count)',
-  aggregates: enrollment.fields.member_ref,
+  aggregates: enrollmentMemberRef,
   using: 'COUNT',
-  lookup: enrollment.fields.class_session_ref,
+  lookup: enrollmentSessionRef,
   description: 'Rows on this session’s roster',
-  section: session.sections.schedule,
+  section: sessionScheduleSection,
 });
 
 // Note: Rollups from session → trainer would require a parent–child edge from
 // session to trainer; trainer is linked via LookupField instead, so session
 // counts per trainer are surfaced via session list views and SDUI, not a rollup.
 
-// ── Validations & defaults ──────────────────────────────────────────────────
-defineTypedValidation(session, {
+// ── Validations & defaults ────────────────────────────────────────────────────
+new Validation(sessionObj, {
   ruleId: 'gym_session_end_after_start',
   displayName: 'End time must be after start',
-  whenInvalid: (c) => c.lte(c.fields.end_time, c.fields.start_time),
+  rqlFormula: '(end_time__c <= start_time__c)',
   errorMessage: 'End time must be after the start time.',
   ruleDescription: 'Prevents zero-length or inverted intervals',
   state: 'ACTIVE',
   level: 'FIELD',
-  field: 'end_time',
+  fieldRef: sessionEndField,
 });
 
-const enrollmentRules = createTypedRuleHelpers(enrollment);
-defineTypedRule(enrollment, {
+new Rule(enrollmentObj, {
   flowId: 'gym_default_enrollment_status',
   flowName: 'Default attendance to Registered',
   triggerType: 'CREATE',
   description: 'New roster rows start as Registered unless changed',
-  actions: [enrollmentRules.setField('attendance_status').toValue('Registered')],
+  actions: [{ targetField: enrollmentAttendanceField, fixedValue: 'Registered' }],
 });
 
-// ── List views ──────────────────────────────────────────────────────────────
-defineTypedListView(member, {
+// ── List views ───────────────────────────────────────────────────────────────
+new ListViewDef(memberObj, {
   viewId: 'view_gym_all_members',
   name: 'All members',
   description: 'Directory with membership status',
-  fields: ['name', 'email', 'phone', 'membership_status', 'preferred_class_types', 'join_date'],
+  fields: [
+    'name',
+    memberEmail,
+    memberPhone,
+    memberStatusField,
+    memberPreferredClassTypesField,
+    memberJoinDate,
+  ],
   orderBy: 'name',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-defineTypedListView(trainer, {
+new ListViewDef(trainerObj, {
   viewId: 'view_gym_all_trainers',
   name: 'All trainers',
   description: 'Staff roster with session counts',
-  fields: ['name', 'email', 'specialty', 'trainer_label'],
+  fields: ['name', trainerEmailField, trainerSpecialtyField, trainerLabelField],
   orderBy: 'name',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-defineTypedListView(session, {
+new ListViewDef(sessionObj, {
   viewId: 'view_gym_all_sessions',
   name: 'All class sessions',
   description: 'Chronological schedule with trainer and enrollments',
   fields: [
     'name',
-    'trainer_ref',
-    'start_time',
-    'end_time',
-    'class_type',
-    'room_name',
-    'capacity',
+    sessionTrainerRef,
+    sessionStartField,
+    sessionEndField,
+    sessionClassTypeField,
+    sessionRoomField,
+    sessionCapacityField,
     enrollmentCountOnSession,
-    'session_board_label',
+    sessionBoardLabel,
   ],
-  orderBy: 'start_time',
+  orderBy: sessionStartField,
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-defineTypedListView(session, {
+new ListViewDef(sessionObj, {
   viewId: 'view_gym_today_sessions',
   name: 'Today’s class sessions',
   description: 'Sessions whose calendar day is today — use with Today’s schedule SDUI tab',
   fields: [
     'name',
-    'trainer_ref',
-    'start_time',
-    'end_time',
-    'class_type',
-    'room_name',
+    sessionTrainerRef,
+    sessionStartField,
+    sessionEndField,
+    sessionClassTypeField,
+    sessionRoomField,
     enrollmentCountOnSession,
-    'session_board_label',
-    'session_date',
+    sessionBoardLabel,
+    sessionDayField,
   ],
-  orderBy: 'start_time',
+  orderBy: sessionStartField,
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
-  filter: (c) => c.eq(c.fields.session_date, c.today()),
+  rqlFilter: '(session_date__c == TODAY())',
 });
 
-defineTypedListView(enrollment, {
+new ListViewDef(enrollmentObj, {
   viewId: 'view_gym_all_enrollments',
   name: 'All enrollments',
   description: 'Full roster grid',
   fields: [
     'name',
-    'class_session_ref',
-    'member_ref',
-    'attendance_status',
-    'checked_in_at',
-    'roster_row_label',
+    enrollmentSessionRef,
+    enrollmentMemberRef,
+    enrollmentAttendanceField,
+    enrollmentCheckedInAt,
+    enrollmentRosterTitle,
   ],
-  orderBy: 'member_ref',
+  orderBy: enrollmentMemberRef,
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
 });
 
-// ── Page layouts ────────────────────────────────────────────────────────────
-defineTypedPageLayout(member, {
+// ── Page layouts ─────────────────────────────────────────────────────────────
+new CustomObjectPageLayout(memberObj, {
   apiName: 'default',
   name: 'Member',
   layoutId: 'layout_gym_member',
@@ -187,14 +513,20 @@ defineTypedPageLayout(member, {
           {
             name: 'Profile',
             type: 'fields_section',
-            section: member.sections.profile,
-            fields: [{ field: 'name', editable: true }, 'first_name', 'last_name', 'email', 'phone'],
+            section: memberProfileSection,
+            fields: [
+              { field: 'name', editable: true },
+              memberFirstName,
+              memberLastName,
+              memberEmail,
+              memberPhone,
+            ],
           },
           {
             name: 'Membership',
             type: 'fields_section',
-            section: member.sections.membership,
-            fields: ['membership_status', 'preferred_class_types', 'join_date', 'emergency_contact'],
+            section: memberMembershipSection,
+            fields: [memberStatusField, memberPreferredClassTypesField, memberJoinDate, memberEmergencyField],
           },
         ],
       },
@@ -205,7 +537,7 @@ defineTypedPageLayout(member, {
   visibilityConditions: {},
 });
 
-defineTypedPageLayout(trainer, {
+new CustomObjectPageLayout(trainerObj, {
   apiName: 'default',
   name: 'Trainer',
   layoutId: 'layout_gym_trainer',
@@ -219,8 +551,14 @@ defineTypedPageLayout(trainer, {
           {
             name: 'Details',
             type: 'fields_section',
-            section: trainer.sections.trainer,
-            fields: [{ field: 'name', editable: true }, 'email', 'specialty', 'trainer_label', 'bio'],
+            section: trainerSection,
+            fields: [
+              { field: 'name', editable: true },
+              trainerEmailField,
+              trainerSpecialtyField,
+              trainerLabelField,
+              trainerBioField,
+            ],
           },
         ],
       },
@@ -231,7 +569,7 @@ defineTypedPageLayout(trainer, {
   visibilityConditions: {},
 });
 
-defineTypedPageLayout(session, {
+new CustomObjectPageLayout(sessionObj, {
   apiName: 'default',
   name: 'Class session',
   layoutId: 'layout_gym_class_session',
@@ -245,22 +583,22 @@ defineTypedPageLayout(session, {
           {
             name: 'Schedule',
             type: 'fields_section',
-            section: session.sections.schedule,
+            section: sessionScheduleSection,
             fields: [
               { field: 'name', editable: true },
-              'trainer_ref',
-              'start_time',
-              'end_time',
-              'session_date',
-              'session_board_label',
+              sessionTrainerRef,
+              sessionStartField,
+              sessionEndField,
+              sessionDayField,
+              sessionBoardLabel,
               enrollmentCountOnSession,
             ],
           },
           {
             name: 'Class & room',
             type: 'fields_section',
-            section: session.sections.class_and_room,
-            fields: ['class_type', 'room_name', 'capacity', 'session_notes'],
+            section: sessionTrainerSection,
+            fields: [sessionClassTypeField, sessionRoomField, sessionCapacityField, sessionNotesField],
           },
         ],
       },
@@ -271,7 +609,7 @@ defineTypedPageLayout(session, {
   visibilityConditions: {},
 });
 
-defineTypedPageLayout(enrollment, {
+new CustomObjectPageLayout(enrollmentObj, {
   apiName: 'default',
   name: 'Enrollment',
   layoutId: 'layout_gym_enrollment',
@@ -285,14 +623,19 @@ defineTypedPageLayout(enrollment, {
           {
             name: 'Session & member',
             type: 'fields_section',
-            section: enrollment.sections.session_and_member,
-            fields: [{ field: 'name', editable: true }, 'class_session_ref', 'member_ref'],
+            section: enrollmentSessionSection,
+            fields: [{ field: 'name', editable: true }, enrollmentSessionRef, enrollmentMemberRef],
           },
           {
             name: 'Attendance & check-in',
             type: 'fields_section',
-            section: enrollment.sections.attendance,
-            fields: ['attendance_status', 'checked_in_at', 'roster_row_label', 'enrollment_notes'],
+            section: enrollmentAttendanceSection,
+            fields: [
+              enrollmentAttendanceField,
+              enrollmentCheckedInAt,
+              enrollmentRosterTitle,
+              enrollmentNotesField,
+            ],
           },
         ],
       },
@@ -303,12 +646,16 @@ defineTypedPageLayout(enrollment, {
   visibilityConditions: {},
 });
 
-// ── SDUI object-list tabs ──────────────────────────────────────────────────
+// ── SDUI object-list tabs ───────────────────────────────────────────────────
 const sduiObjectListDependencies = {
   '@rippling/rippling-sdk': '^0.2.0-alpha.65',
   '@rippling/pebble-sdui-web': '^0.9.2',
 };
 
+function loadFunctionCode(filename: string): string {
+  return fs.readFileSync(path.join(__dirname, 'functions', filename), 'utf-8');
+}
+
 function createObjectListPage(props: {
   codeFilename: string;
   functionApiName: string;
@@ -317,17 +664,20 @@ function createObjectListPage(props: {
   pageId: string;
   pageName: string;
 }): SduiPage {
-  return defineSduiPageFromFunctionFile(manifest, {
+  const listFn = new ManifestFunction(manifest, {
     apiName: props.functionApiName,
     name: props.functionName,
     description: props.functionDescription,
-    codeDirectory: path.join(__dirname, 'functions'),
-    codeFilename: props.codeFilename,
+    code: loadFunctionCode(props.codeFilename),
     dependencies: sduiObjectListDependencies,
     isAsync: false,
-    pageId: props.pageId,
-    pageName: props.pageName,
-  }).page;
+  });
+
+  return new SduiPage(manifest, {
+    sduiPageId: props.pageId,
+    name: props.pageName,
+    function: listFn,
+  });
 }
 
 const memberListPage = createObjectListPage({