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

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

@@ -575,64 +575,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",
@@ -1638,8 +1639,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["chart"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "legal_name__c"
@@ -1655,6 +1655,7 @@
       "name": "Operatory",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["overview"],
         "newTabs": [
           {
             "key": "overview",
@@ -1680,8 +1681,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["overview"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "operatory_name__c"
@@ -1697,6 +1697,7 @@
       "name": "Appointment",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["visit"],
         "newTabs": [
           {
             "key": "visit",
@@ -1744,8 +1745,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["visit"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "board_label__c"
@@ -1761,6 +1761,7 @@
       "name": "Treatment plan",
       "system_created": false,
       "tab_edits": {
+        "tabsOrder": ["plan"],
         "newTabs": [
           {
             "key": "plan",
@@ -1802,8 +1803,7 @@
             ]
           }
         ],
-        "systemTabEdits": {},
-        "tabsOrder": ["plan"]
+        "systemTabEdits": {}
       },
       "header_edits": {
         "newTitleField": "plan_name__c"
@@ -1811,6 +1811,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 +1874,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/gym-membership-management/gym-membership-management.ts

@@ -630,117 +630,122 @@ new CustomObjectPageLayout(enrollmentObj, {
   visibilityConditions: {},
 });
 
-// ── SDUI: today’s schedule + check-in desk ──────────────────────────────────
-const todayScheduleCode = [
-  "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';",
-  "import SDUI from '@rippling/sdui-builder';",
-  '',
-  `const OBJECT = '${sessionObj.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 checkInDeskCode = [
-  "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';",
-  "import SDUI from '@rippling/sdui-builder';",
-  '',
-  `const OBJECT = '${enrollmentObj.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 todayScheduleFn = new ManifestFunction(manifest, {
-  apiName: 'gym_today_schedule_fn',
-  name: 'Today’s schedule (SDUI)',
-  description:
+// ── 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 memberListPage = createObjectListPage({
+  objectApiName: memberObj.getApiName(),
+  functionApiName: 'gym_member_list_fn',
+  functionName: 'Members (SDUI)',
+  functionDescription: 'SDUI ObjectListView for member records',
+  pageId: 'gym_members',
+  pageName: 'Members',
+  pageDescription: 'SDUI ObjectListView for member records',
+});
+
+const trainerListPage = createObjectListPage({
+  objectApiName: trainerObj.getApiName(),
+  functionApiName: 'gym_trainer_list_fn',
+  functionName: 'Trainers (SDUI)',
+  functionDescription: 'SDUI ObjectListView for trainer records',
+  pageId: 'gym_trainers',
+  pageName: 'Trainers',
+  pageDescription: 'SDUI ObjectListView for trainer records',
+});
+
+const todaySchedulePage = createObjectListPage({
+  objectApiName: sessionObj.getApiName(),
+  functionApiName: 'gym_today_schedule_fn',
+  functionName: 'Today’s schedule (SDUI)',
+  functionDescription:
     'Searchable grid of class sessions — pair with list view “Today’s class sessions” or filter by date',
-  runtime: 'lambda-deno',
-  code: todayScheduleCode,
-  dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.33', '@rippling/sdui-builder': '^0.1.0' },
-  isAsync: false,
-});
-
-const checkInDeskFn = new ManifestFunction(manifest, {
-  apiName: 'gym_check_in_desk_fn',
-  name: 'Check-in desk (SDUI)',
-  description: 'Searchable roster grid — update attendance and checked-in time as members arrive',
-  runtime: 'lambda-deno',
-  code: checkInDeskCode,
-  dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.33', '@rippling/sdui-builder': '^0.1.0' },
-  isAsync: false,
+  pageId: 'gym_today_schedule',
+  pageName: 'Today’s schedule',
+  pageDescription: 'SDUI list of class sessions for front desk (filter to today in the grid)',
 });
 
-const todaySchedulePage = new SduiPage(manifest, {
-  sduiPageId: 'gym_today_schedule',
-  name: 'Today’s schedule',
-  function: todayScheduleFn,
-  description: 'SDUI list of class sessions for front desk (filter to today in the grid)',
-});
-
-const checkInDeskPage = new SduiPage(manifest, {
-  sduiPageId: 'gym_check_in_desk',
-  name: 'Check-in desk',
-  function: checkInDeskFn,
-  description: 'SDUI roster — set attendance to Checked in and optional checked-in time',
+const checkInDeskPage = createObjectListPage({
+  objectApiName: enrollmentObj.getApiName(),
+  functionApiName: 'gym_check_in_desk_fn',
+  functionName: 'Check-in desk (SDUI)',
+  functionDescription: 'Searchable roster grid — update attendance and checked-in time as members arrive',
+  pageId: 'gym_check_in_desk',
+  pageName: 'Check-in desk',
+  pageDescription: 'SDUI roster — set attendance to Checked in and optional checked-in time',
 });
 
 new App(manifest, {
   apiName: 'gym_membership_management_app',
   name: 'Gym Membership Management',
-  description:
-    'Members, trainers, schedules, enrollments, today’s sessions list view, and SDUI for schedule + check-in',
+  description: 'Members, trainers, schedules, enrollments, and SDUI object-list tabs for schedule + check-in',
   appType: 'custom',
-  pages: [memberObj, trainerObj, sessionObj, enrollmentObj, todaySchedulePage, checkInDeskPage],
+  pages: [memberListPage, trainerListPage, todaySchedulePage, checkInDeskPage],
 });
 
 console.log(manifest.preview());