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

package/examples/manifest/dental-practice-management/dental-practice-management.ts

@@ -444,7 +444,6 @@ new CustomObjectPageLayout(patientObj, {
         type: 'tab_with_sections',
         sections: [
           {
-            key: 'id',
             name: 'Profile',
             type: 'fields_section',
             section: patientIdentitySection,
@@ -457,7 +456,6 @@ new CustomObjectPageLayout(patientObj, {
             ],
           },
           {
-            key: 'clinical',
             name: 'Clinical & billing',
             type: 'fields_section',
             section: patientClinicalSection,
@@ -490,7 +488,6 @@ new CustomObjectPageLayout(operatoryObj, {
         type: 'tab_with_sections',
         sections: [
           {
-            key: 'room',
             name: 'Room',
             type: 'fields_section',
             section: operatorySection,
@@ -518,14 +515,12 @@ new CustomObjectPageLayout(apptObj, {
         type: 'tab_with_sections',
         sections: [
           {
-            key: 'chair',
             name: 'Chair & schedule',
             type: 'fields_section',
             section: apptOperatorySection,
             fields: [apptOperatoryRef, apptStartField, apptDurationMins],
           },
           {
-            key: 'patient',
             name: 'Patient & status',
             type: 'fields_section',
             section: apptPatientSection,
@@ -553,14 +548,12 @@ new CustomObjectPageLayout(planObj, {
         type: 'tab_with_sections',
         sections: [
           {
-            key: 'link',
             name: 'Patient',
             type: 'fields_section',
             section: planLinkSection,
             fields: [planPatientRef],
           },
           {
-            key: 'content',
             name: 'Planned work',
             type: 'fields_section',
             section: planBodySection,
@@ -575,64 +568,121 @@ new CustomObjectPageLayout(planObj, {
   visibilityConditions: {},
 });
 
-// ── SDUI: chair schedule tab — ObjectListView on appointments (same style as other examples) ─
-const chairBoardCode = [
-  "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';",
-  "import SDUI from '@rippling/sdui-builder';",
-  '',
-  `const OBJECT = '${apptObj.getApiName()}';`,
-  '',
-  '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');
-
-const chairBoardFn = new ManifestFunction(manifest, {
-  apiName: 'dental_chair_schedule_fn',
-  name: 'Daily chair board (SDUI)',
-  description: 'SDUI ObjectListView for appointments (init + spec render)',
-  runtime: 'lambda-deno',
-  code: chairBoardCode,
-  dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.33', '@rippling/sdui-builder': '^0.1.0' },
-  isAsync: false,
-});
-
-const chairBoardPage = new SduiPage(manifest, {
-  sduiPageId: 'dental_chair_schedule',
-  name: 'Chair schedule',
-  function: chairBoardFn,
-  description: 'SDUI list of appointments (searchable grid); use object records for status edits',
+// ── 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 createObjectListPage(props: {
+  objectApiName: string;
+  functionApiName: string;
+  functionName: string;
+  functionDescription: string;
+  pageId: string;
+  pageName: string;
+  pageDescription: string;
+}): SduiPage {
+  const listFn = new ManifestFunction(manifest, {
+    apiName: props.functionApiName,
+    name: props.functionName,
+    description: props.functionDescription,
+    runtime: 'lambda-deno',
+    code: objectListViewCode(props.objectApiName),
+    dependencies: sduiObjectListDependencies,
+    isAsync: false,
+  });
+
+  return new SduiPage(manifest, {
+    sduiPageId: props.pageId,
+    name: props.pageName,
+    function: listFn,
+    description: props.pageDescription,
+  });
+}
+
+const patientListPage = createObjectListPage({
+  objectApiName: patientObj.getApiName(),
+  functionApiName: 'dental_patient_list_fn',
+  functionName: 'Patients (SDUI)',
+  functionDescription: 'SDUI ObjectListView for patient records',
+  pageId: 'dental_patients',
+  pageName: 'Patients',
+  pageDescription: 'SDUI ObjectListView for patient records',
+});
+
+const operatoryListPage = createObjectListPage({
+  objectApiName: operatoryObj.getApiName(),
+  functionApiName: 'dental_operatory_list_fn',
+  functionName: 'Operatories (SDUI)',
+  functionDescription: 'SDUI ObjectListView for operatory records',
+  pageId: 'dental_operatories',
+  pageName: 'Operatories',
+  pageDescription: 'SDUI ObjectListView for operatory records',
+});
+
+const chairBoardPage = createObjectListPage({
+  objectApiName: apptObj.getApiName(),
+  functionApiName: 'dental_chair_schedule_fn',
+  functionName: 'Daily chair board (SDUI)',
+  functionDescription: 'SDUI ObjectListView for appointments (init + spec render)',
+  pageId: 'dental_chair_schedule',
+  pageName: 'Chair schedule',
+  pageDescription: 'SDUI list of appointments (searchable grid); use object records for status edits',
+});
+
+const treatmentPlanListPage = createObjectListPage({
+  objectApiName: planObj.getApiName(),
+  functionApiName: 'dental_treatment_plan_list_fn',
+  functionName: 'Treatment plans (SDUI)',
+  functionDescription: 'SDUI ObjectListView for treatment plan records',
+  pageId: 'dental_treatment_plans',
+  pageName: 'Treatment plans',
+  pageDescription: 'SDUI ObjectListView for treatment plan records',
 });
 
 new App(manifest, {
   apiName: 'dental_practice_management_app',
   name: 'Dental Practice Management',
-  description: 'Patient charts, operatories, treatment plans, and an SDUI appointment list tab',
+  description: 'Patient charts, operatories, treatment plans, and SDUI object-list tabs',
   appType: 'custom',
-  pages: [patientObj, operatoryObj, apptObj, planObj, chairBoardPage],
+  pages: [patientListPage, operatoryListPage, chairBoardPage, treatmentPlanListPage],
 });
 
 console.log(manifest.preview());

package/examples/manifest/dental-practice-management/manifest.json

@@ -1588,6 +1588,7 @@
       "name": "Patient chart",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["chart"],
         "newTabs": [
           {
             "key": "chart",
@@ -1595,7 +1596,6 @@
             "type": "tab_with_sections",
             "sections": [
               {
-                "key": "id",
                 "name": "Profile",
                 "type": "fields_section",
                 "fields": [
@@ -1617,7 +1617,6 @@
                 ]
               },
               {
-                "key": "clinical",
                 "name": "Clinical & billing",
                 "type": "fields_section",
                 "fields": [
@@ -1638,8 +1637,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["chart"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "legal_name__c"
@@ -1655,6 +1653,7 @@
       "name": "Operatory",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["overview"],
         "newTabs": [
           {
             "key": "overview",
@@ -1662,7 +1661,6 @@
             "type": "tab_with_sections",
             "sections": [
               {
-                "key": "room",
                 "name": "Room",
                 "type": "fields_section",
                 "fields": [
@@ -1680,8 +1678,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["overview"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "operatory_name__c"
@@ -1697,6 +1694,7 @@
       "name": "Appointment",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["visit"],
         "newTabs": [
           {
             "key": "visit",
@@ -1704,7 +1702,6 @@
             "type": "tab_with_sections",
             "sections": [
               {
-                "key": "chair",
                 "name": "Chair & schedule",
                 "type": "fields_section",
                 "fields": [
@@ -1720,7 +1717,6 @@
                 ]
               },
               {
-                "key": "patient",
                 "name": "Patient & status",
                 "type": "fields_section",
                 "fields": [
@@ -1744,8 +1740,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["visit"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "board_label__c"
@@ -1761,6 +1756,7 @@
       "name": "Treatment plan",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["plan"],
         "newTabs": [
           {
             "key": "plan",
@@ -1768,7 +1764,6 @@
             "type": "tab_with_sections",
             "sections": [
               {
-                "key": "link",
                 "name": "Patient",
                 "type": "fields_section",
                 "fields": [
@@ -1778,7 +1773,6 @@
                 ]
               },
               {
-                "key": "content",
                 "name": "Planned work",
                 "type": "fields_section",
                 "fields": [
@@ -1802,8 +1796,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["plan"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "plan_name__c"
@@ -1811,6 +1804,48 @@
       "visibility_conditions": {},
       "blueprint_key": "dental_treatment_plan__c"
     },
+    {
+      "type": "FUNCTION",
+      "name": "Patients (SDUI)",
+      "api_name": "dental_patient_list_fn",
+      "description": "SDUI ObjectListView for patient records",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'dental_patient__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}",
+      "dependencies": {
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
+        "@rippling/sdui-builder": "^0.1.0"
+      },
+      "deployment_options": {
+        "runtime": "lambda-deno"
+      }
+    },
+    {
+      "type": "SDUI_PAGE",
+      "name": "Patients",
+      "sdui_page_id": "dental_patients",
+      "function_api_name": "dental_patient_list_fn",
+      "description": "SDUI ObjectListView for patient records"
+    },
+    {
+      "type": "FUNCTION",
+      "name": "Operatories (SDUI)",
+      "api_name": "dental_operatory_list_fn",
+      "description": "SDUI ObjectListView for operatory records",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'dental_operatory__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}",
+      "dependencies": {
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
+        "@rippling/sdui-builder": "^0.1.0"
+      },
+      "deployment_options": {
+        "runtime": "lambda-deno"
+      }
+    },
+    {
+      "type": "SDUI_PAGE",
+      "name": "Operatories",
+      "sdui_page_id": "dental_operatories",
+      "function_api_name": "dental_operatory_list_fn",
+      "description": "SDUI ObjectListView for operatory records"
+    },
     {
       "type": "FUNCTION",
       "name": "Daily chair board (SDUI)",
@@ -1832,37 +1867,53 @@
       "function_api_name": "dental_chair_schedule_fn",
       "description": "SDUI list of appointments (searchable grid); use object records for status edits"
     },
+    {
+      "type": "FUNCTION",
+      "name": "Treatment plans (SDUI)",
+      "api_name": "dental_treatment_plan_list_fn",
+      "description": "SDUI ObjectListView for treatment plan records",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/sdui-builder';\n\nconst OBJECT = 'dental_treatment_plan__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}",
+      "dependencies": {
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33",
+        "@rippling/sdui-builder": "^0.1.0"
+      },
+      "deployment_options": {
+        "runtime": "lambda-deno"
+      }
+    },
+    {
+      "type": "SDUI_PAGE",
+      "name": "Treatment plans",
+      "sdui_page_id": "dental_treatment_plans",
+      "function_api_name": "dental_treatment_plan_list_fn",
+      "description": "SDUI ObjectListView for treatment plan records"
+    },
     {
       "type": "CUSTOM_APP",
       "api_name": "dental_practice_management_app",
       "name": "Dental Practice Management",
-      "description": "Patient charts, operatories, treatment plans, and an SDUI appointment list tab",
+      "description": "Patient charts, operatories, treatment plans, and SDUI object-list tabs",
       "app_type": "custom",
       "pages": [
         {
-          "api_name": "dental_patient__c",
-          "page_type": "object_page",
-          "object_rql_name": "dental_patient__c"
-        },
-        {
-          "api_name": "dental_operatory__c",
-          "page_type": "object_page",
-          "object_rql_name": "dental_operatory__c"
-        },
-        {
-          "api_name": "dental_appointment__c",
-          "page_type": "object_page",
-          "object_rql_name": "dental_appointment__c"
+          "api_name": "dental_patients",
+          "page_type": "sdui_page",
+          "sdui_page_id": "dental_patients"
         },
         {
-          "api_name": "dental_treatment_plan__c",
-          "page_type": "object_page",
-          "object_rql_name": "dental_treatment_plan__c"
+          "api_name": "dental_operatories",
+          "page_type": "sdui_page",
+          "sdui_page_id": "dental_operatories"
         },
         {
           "api_name": "dental_chair_schedule",
           "page_type": "sdui_page",
           "sdui_page_id": "dental_chair_schedule"
+        },
+        {
+          "api_name": "dental_treatment_plans",
+          "page_type": "sdui_page",
+          "sdui_page_id": "dental_treatment_plans"
         }
       ]
     }

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

@@ -128,7 +128,6 @@ const existingManifestJson: ExistingManifest = {
             type: 'tab_with_sections',
             sections: [
               {
-                key: 'profile',
                 name: 'Profile',
                 type: 'fields_section',
                 fields: [
@@ -138,7 +137,6 @@ const existingManifestJson: ExistingManifest = {
                 ],
               },
               {
-                key: 'membership',
                 name: 'Membership',
                 type: 'fields_section',
                 fields: [{ fieldRqlName: 'membership_status__c' }, { fieldRqlName: 'join_date__c' }],
@@ -164,6 +162,9 @@ 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(),
 });
@@ -181,13 +182,12 @@ const preferredName = new TextField(memberObj, {
 memberLayout
   .removeField('phone__c', {
     tabKey: 'member',
-    sectionKey: 'profile',
+    section: profileSection,
     removeAll: false,
   })
   .addField(preferredName, {
     tabKey: 'member',
-    sectionKey: 'profile',
-    fieldSection: profileSection,
+    section: profileSection,
     position: 2,
   });
 
@@ -211,13 +211,12 @@ 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('membership', {
+  .removeSection(membershipSection, {
     tabKey: 'member',
     removeAll: false,
   })
   .addSection(
     {
-      key: 'marketing',
       name: 'Marketing',
       type: 'fields_section',
       section: marketingSection,