@rippling/rippling-sdk 0.2.0-alpha.48 → 0.2.0-alpha.49

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

@@ -14,6 +14,8 @@
  *   (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 {
   App,
   Category,
@@ -76,6 +78,7 @@ const memberMembershipSection = new CustomObjectFieldSection(memberObj, {
 const memberFirstName = new TextField(memberObj, {
   apiName: 'first_name__c',
   displayName: 'First name',
+  description: 'First name field',
   required: true,
   maxLength: 80,
   section: memberProfileSection,
@@ -84,6 +87,7 @@ const memberFirstName = new TextField(memberObj, {
 const memberLastName = new TextField(memberObj, {
   apiName: 'last_name__c',
   displayName: 'Last name',
+  description: 'Last name field',
   required: true,
   maxLength: 80,
   section: memberProfileSection,
@@ -92,6 +96,7 @@ const memberLastName = new TextField(memberObj, {
 const memberEmail = new EmailField(memberObj, {
   apiName: 'email__c',
   displayName: 'Email',
+  description: 'Email field',
   unique: true,
   section: memberProfileSection,
 });
@@ -99,12 +104,14 @@ const memberEmail = new EmailField(memberObj, {
 const memberPhone = new PhoneField(memberObj, {
   apiName: 'phone__c',
   displayName: 'Phone',
+  description: 'Phone field',
   section: memberProfileSection,
 });
 
 const memberStatusField = new SelectField(memberObj, {
   apiName: 'membership_status__c',
   displayName: 'Membership status',
+  description: 'Membership status field',
   options: ['Active', 'Frozen', 'Cancelled', 'Trial'],
   required: true,
   section: memberMembershipSection,
@@ -113,6 +120,7 @@ const memberStatusField = new SelectField(memberObj, {
 const memberJoinDate = new DateField(memberObj, {
   apiName: 'join_date__c',
   displayName: 'Join date',
+  description: 'Join date field',
   section: memberMembershipSection,
 });
 
@@ -127,6 +135,7 @@ const memberEmergencyField = new LongTextField(memberObj, {
 const memberDisplayName = new FormulaField(memberObj, {
   apiName: 'member_display_name__c',
   displayName: 'Display name',
+  description: 'Display name field',
   fieldType: 'TEXT',
   maxLength: 200,
   formula: "CONCATENATE(TRIM(first_name__c), ' ', TRIM(last_name__c))",
@@ -151,6 +160,7 @@ const trainerSection = new CustomObjectFieldSection(trainerObj, {
 const trainerNameField = new TextField(trainerObj, {
   apiName: 'full_name__c',
   displayName: 'Full name',
+  description: 'Full name field',
   required: true,
   maxLength: 160,
   section: trainerSection,
@@ -159,12 +169,14 @@ const trainerNameField = new TextField(trainerObj, {
 const trainerEmailField = new EmailField(trainerObj, {
   apiName: 'email__c',
   displayName: 'Email',
+  description: 'Email field',
   section: trainerSection,
 });
 
 const trainerSpecialtyField = new SelectField(trainerObj, {
   apiName: 'specialty__c',
   displayName: 'Primary specialty',
+  description: 'Primary specialty field',
   options: ['Yoga', 'Spin', 'HIIT', 'Strength', 'Pilates', 'Dance', 'Aquatics', 'General'],
   section: trainerSection,
 });
@@ -172,6 +184,7 @@ const trainerSpecialtyField = new SelectField(trainerObj, {
 const trainerBioField = new LongTextField(trainerObj, {
   apiName: 'bio__c',
   displayName: 'Bio & certifications',
+  description: 'Bio & certifications field',
   maxLength: 4000,
   section: trainerSection,
 });
@@ -179,6 +192,7 @@ const trainerBioField = new LongTextField(trainerObj, {
 const trainerLabelField = new FormulaField(trainerObj, {
   apiName: 'trainer_label__c',
   displayName: 'List label',
+  description: 'List label field',
   fieldType: 'TEXT',
   maxLength: 220,
   formula: "CONCATENATE(full_name__c, ' · ', specialty__c)",
@@ -234,6 +248,7 @@ const sessionEndField = new DatetimeField(sessionObj, {
 const sessionClassTypeField = new SelectField(sessionObj, {
   apiName: 'class_type__c',
   displayName: 'Class type',
+  description: 'Class type field',
   options: [
     'Yoga',
     'Spin',
@@ -268,6 +283,7 @@ const sessionCapacityField = new NumberField(sessionObj, {
 const sessionNotesField = new LongTextField(sessionObj, {
   apiName: 'session_notes__c',
   displayName: 'Notes',
+  description: 'Notes field',
   maxLength: 4000,
   section: sessionTrainerSection,
 });
@@ -284,6 +300,7 @@ const sessionDayField = new FormulaField(sessionObj, {
 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)",
@@ -324,6 +341,7 @@ const enrollmentSessionRef = new ParentChildField(enrollmentObj, {
 const enrollmentMemberRef = new LookupField(enrollmentObj, {
   apiName: 'member_ref__c',
   displayName: 'Member',
+  description: 'Member field',
   target: memberObj,
   relatedDataLabel: 'Class enrollments',
   required: true,
@@ -349,6 +367,7 @@ const enrollmentCheckedInAt = new DatetimeField(enrollmentObj, {
 const enrollmentNotesField = new LongTextField(enrollmentObj, {
   apiName: 'enrollment_notes__c',
   displayName: 'Notes',
+  description: 'Notes field',
   maxLength: 2000,
   section: enrollmentAttendanceSection,
 });
@@ -356,6 +375,7 @@ const enrollmentNotesField = new LongTextField(enrollmentObj, {
 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')",
@@ -626,47 +646,14 @@ new CustomObjectPageLayout(enrollmentObj, {
 // ── SDUI object-list tabs ───────────────────────────────────────────────────
 const sduiObjectListDependencies = {
   '@rippling/rippling-sdk': '^0.2.0-alpha.33',
-  '@rippling/sdui-builder': '^0.1.0',
 };
 
-function objectListViewCode(objectApiName: string): string {
-  return [
-    "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';",
-    "import SDUI from '@rippling/sdui-builder';",
-    '',
-    `const OBJECT = '${objectApiName}';`,
-    '',
-    'export async function onRipplingEvent(',
-    '  event: FunctionEvent,',
-    '  context: FunctionContext,',
-    '): Promise<FunctionResponse> {',
-    '  const action = event.parameters?.action;',
-    '',
-    "  if (!action || action === 'init') {",
-    '    const s = SDUI.createState({});',
-    '    const root = SDUI.components.VStack({',
-    '      children: [',
-    '        SDUI.components.ObjectListView({',
-    '          objectApiName: OBJECT,',
-    '          canSearchInGrid: true,',
-    '        }),',
-    '      ],',
-    '    });',
-    '    return new FunctionResponse({',
-    '      body: { spec: JSON.stringify(SDUI.render(s, root)) },',
-    '      statusCode: 200,',
-    '      headers: {},',
-    "      message: '',",
-    '    });',
-    '  }',
-    '',
-    "  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });",
-    '}',
-  ].join('\n');
+function loadFunctionCode(filename: string): string {
+  return fs.readFileSync(path.join(__dirname, 'functions', filename), 'utf-8');
 }
 
 function createObjectListPage(props: {
-  objectApiName: string;
+  codeFilename: string;
   functionApiName: string;
   functionName: string;
   functionDescription: string;
@@ -678,7 +665,7 @@ function createObjectListPage(props: {
     apiName: props.functionApiName,
     name: props.functionName,
     description: props.functionDescription,
-    code: objectListViewCode(props.objectApiName),
+    code: loadFunctionCode(props.codeFilename),
     dependencies: sduiObjectListDependencies,
     isAsync: false,
   });
@@ -692,7 +679,7 @@ function createObjectListPage(props: {
 }
 
 const memberListPage = createObjectListPage({
-  objectApiName: memberObj.getApiName(),
+  codeFilename: 'member-list.ts',
   functionApiName: 'gym_member_list_fn',
   functionName: 'Members (SDUI)',
   functionDescription: 'SDUI ObjectListView for member records',
@@ -702,7 +689,7 @@ const memberListPage = createObjectListPage({
 });
 
 const trainerListPage = createObjectListPage({
-  objectApiName: trainerObj.getApiName(),
+  codeFilename: 'trainer-list.ts',
   functionApiName: 'gym_trainer_list_fn',
   functionName: 'Trainers (SDUI)',
   functionDescription: 'SDUI ObjectListView for trainer records',
@@ -712,7 +699,7 @@ const trainerListPage = createObjectListPage({
 });
 
 const todaySchedulePage = createObjectListPage({
-  objectApiName: sessionObj.getApiName(),
+  codeFilename: 'today-schedule.ts',
   functionApiName: 'gym_today_schedule_fn',
   functionName: 'Today’s schedule (SDUI)',
   functionDescription:
@@ -723,7 +710,7 @@ const todaySchedulePage = createObjectListPage({
 });
 
 const checkInDeskPage = createObjectListPage({
-  objectApiName: enrollmentObj.getApiName(),
+  codeFilename: 'check-in-desk.ts',
   functionApiName: 'gym_check_in_desk_fn',
   functionName: 'Check-in desk (SDUI)',
   functionDescription: 'Searchable roster grid — update attendance and checked-in time as members arrive',

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

@@ -1684,7 +1684,8 @@
                   {
                     "fieldRqlName": "phone__c"
                   }
-                ]
+                ],
+                "key": "sec_gm_profile"
               },
               {
                 "name": "Membership",
@@ -1699,7 +1700,8 @@
                   {
                     "fieldRqlName": "emergency_contact__c"
                   }
-                ]
+                ],
+                "key": "sec_gm_membership"
               }
             ]
           }
@@ -1746,7 +1748,8 @@
                   {
                     "fieldRqlName": "bio__c"
                   }
-                ]
+                ],
+                "key": "sec_tr_profile"
               }
             ]
           }
@@ -1796,7 +1799,8 @@
                   {
                     "fieldRqlName": "enrollment_count__c"
                   }
-                ]
+                ],
+                "key": "sec_cs_schedule"
               },
               {
                 "name": "Class & room",
@@ -1814,7 +1818,8 @@
                   {
                     "fieldRqlName": "session_notes__c"
                   }
-                ]
+                ],
+                "key": "sec_cs_class"
               }
             ]
           }
@@ -1852,7 +1857,8 @@
                   {
                     "fieldRqlName": "member_ref__c"
                   }
-                ]
+                ],
+                "key": "sec_ce_link"
               },
               {
                 "name": "Attendance & check-in",
@@ -1870,7 +1876,8 @@
                   {
                     "fieldRqlName": "enrollment_notes__c"
                   }
-                ]
+                ],
+                "key": "sec_ce_att"
               }
             ]
           }
@@ -1888,10 +1895,9 @@
       "name": "Members (SDUI)",
       "api_name": "gym_member_list_fn",
       "description": "SDUI ObjectListView for member records",
-      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'gym_member__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event.parameters?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'gym_member__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event['parameters']?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
       "dependencies": {
-        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
-        "@rippling/sdui-builder": "^0.1.0"
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33"
       }
     },
     {
@@ -1906,10 +1912,9 @@
       "name": "Trainers (SDUI)",
       "api_name": "gym_trainer_list_fn",
       "description": "SDUI ObjectListView for trainer records",
-      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'gym_trainer__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event.parameters?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'gym_trainer__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event['parameters']?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
       "dependencies": {
-        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
-        "@rippling/sdui-builder": "^0.1.0"
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33"
       }
     },
     {
@@ -1924,10 +1929,9 @@
       "name": "Today’s schedule (SDUI)",
       "api_name": "gym_today_schedule_fn",
       "description": "Searchable grid of class sessions — pair with list view “Today’s class sessions” or filter by date",
-      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'gym_class_session__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event.parameters?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'gym_class_session__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event['parameters']?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
       "dependencies": {
-        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
-        "@rippling/sdui-builder": "^0.1.0"
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33"
       }
     },
     {
@@ -1942,10 +1946,9 @@
       "name": "Check-in desk (SDUI)",
       "api_name": "gym_check_in_desk_fn",
       "description": "Searchable roster grid — update attendance and checked-in time as members arrive",
-      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'gym_class_enrollment__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event.parameters?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'gym_class_enrollment__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event['parameters']?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
       "dependencies": {
-        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
-        "@rippling/sdui-builder": "^0.1.0"
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33"
       }
     },
     {

package/examples/manifest/simple-todo-app/functions/todo-list.ts

@@ -0,0 +1,31 @@
+import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';
+import SDUI from '@rippling/rippling-sdk/lib/sdui';
+
+const OBJECT = 'simple_todo__c';
+
+export async function onRipplingEvent(
+  event: FunctionEvent,
+  context: FunctionContext,
+): Promise<FunctionResponse> {
+  const action = event['parameters']?.action;
+
+  if (!action || action === 'init') {
+    const s = SDUI.createState({});
+    const root = SDUI.components.VStack({
+      children: [
+        SDUI.components.ObjectListView({
+          objectApiName: OBJECT,
+          canSearchInGrid: true,
+        }),
+      ],
+    });
+    return new FunctionResponse({
+      body: { spec: JSON.stringify(SDUI.render(s, root)) },
+      statusCode: 200,
+      headers: {},
+      message: '',
+    });
+  }
+
+  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+}