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

package/examples/manifest/dental-practice-management/functions/chair-schedule.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { appointmentDefinition } from '../schema';
 
-const OBJECT = 'dental_appointment__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, appointmentDefinition);
 }

package/examples/manifest/dental-practice-management/functions/complete-visit.ts

@@ -1,47 +1,26 @@
-import RipplingSDK, {
-  DetailViewActionFunctionEvent,
-  FunctionContext,
-  FunctionResponse,
-} from '@rippling/rippling-sdk';
-import type { CustomObjectDataRow } from '@rippling/rippling-sdk/resources/custom-objects/records';
+import { DetailViewActionFunctionEvent, FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import { createCustomObjectFunctionRuntime } from '@rippling/rippling-sdk/core/platform/custom-objects';
+import { appointmentDefinition, treatmentPlanDefinition } from '../schema';
 
-const APPOINTMENT_OBJECT_API_NAME = 'dental_appointment__c';
-const TREATMENT_PLAN_OBJECT_API_NAME = 'dental_treatment_plan__c';
+const APPOINTMENT_OBJECT_API_NAME = appointmentDefinition.apiName;
+const TREATMENT_PLAN_OBJECT_API_NAME = treatmentPlanDefinition.apiName;
 
-type CompleteVisitEvent = DetailViewActionFunctionEvent<
+export type Input = DetailViewActionFunctionEvent<
   {},
   typeof APPOINTMENT_OBJECT_API_NAME,
   'Complete visit',
   'layout_dental_appointment'
 >;
 
-type CompleteVisitResponse = {
-  appointmentId: string;
-  treatmentPlanId?: string;
-  message: string;
-};
+export type Output =
+  | {
+      appointmentId: string;
+      treatmentPlanId?: string;
+      message: string;
+    }
+  | { error: string };
 
-function createClient(context: FunctionContext): RipplingSDK {
-  return new RipplingSDK({
-    bearerToken: context.env.rippling_user_bearer_token,
-  });
-}
-
-function stringValue(record: CustomObjectDataRow, key: string): string {
-  const value = record[key];
-  return typeof value === 'string' ? value : '';
-}
-
-function lookupId(record: CustomObjectDataRow, key: string): string | undefined {
-  const value = record[key];
-  if (typeof value === 'string') return value;
-  if (value == null || typeof value !== 'object') return undefined;
-
-  const nested = value as Record<string, unknown>;
-  return typeof nested['id'] === 'string' ? nested['id'] : undefined;
-}
-
-function ok(body: CompleteVisitResponse): FunctionResponse<CompleteVisitResponse> {
+function ok(body: Extract<Output, { appointmentId: string }>): FunctionResponse<Output> {
   return new FunctionResponse({
     body,
     statusCode: 200,
@@ -50,7 +29,7 @@ function ok(body: CompleteVisitResponse): FunctionResponse<CompleteVisitResponse
   });
 }
 
-function badRequest(message: string): FunctionResponse<{ error: string }> {
+function badRequest(message: string): FunctionResponse<Output> {
   return new FunctionResponse({
     body: { error: message },
     statusCode: 400,
@@ -60,32 +39,31 @@ function badRequest(message: string): FunctionResponse<{ error: string }> {
 }
 
 export async function onRipplingEvent(
-  event: CompleteVisitEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse<CompleteVisitResponse | { error: string }>> {
+): Promise<FunctionResponse<Output>> {
   if (event.object_api_name !== APPOINTMENT_OBJECT_API_NAME) {
     return badRequest('Unsupported detail view action.');
   }
 
-  const client = createClient(context);
-  const appointment = await client.customObjects.records.retrieve(
-    APPOINTMENT_OBJECT_API_NAME,
-    event.record_id,
-  );
+  const runtime = createCustomObjectFunctionRuntime(context);
+  const appointments = runtime.for(appointmentDefinition);
+  const treatmentPlans = runtime.for(treatmentPlanDefinition);
+  const appointment = await appointments.get(event.record_id);
 
-  if (stringValue(appointment, 'appointment_status__c') === 'Completed') {
+  if (appointment.appointment_status === 'Completed') {
     return ok({
       appointmentId: event.record_id,
       message: `${appointment.name} is already completed.`,
     });
   }
 
-  await client.customObjects.records.update(APPOINTMENT_OBJECT_API_NAME, event.record_id, {
-    appointment_status__c: 'Completed',
-    visit_notes__c: stringValue(appointment, 'visit_notes__c'),
+  await appointments.update(event.record_id, {
+    appointment_status: 'Completed',
+    visit_notes: appointment.visit_notes ?? '',
   });
 
-  const patientId = lookupId(appointment, 'patient_ref__c');
+  const patientId = appointment.patient_ref?.id;
   if (!patientId) {
     return ok({
       appointmentId: event.record_id,
@@ -93,18 +71,17 @@ export async function onRipplingEvent(
     });
   }
 
-  const treatmentPlan = await client.customObjects.records.create(TREATMENT_PLAN_OBJECT_API_NAME, {
+  const treatmentPlan = await treatmentPlans.create({
     name: `Follow-up: ${appointment.name}`,
-    plan_patient_ref__c: patientId,
-    plan_status__c: 'Draft',
-    procedures_summary__c:
-      stringValue(appointment, 'visit_notes__c') || 'Follow up after the completed visit.',
+    plan_patient_ref: { id: patientId },
+    plan_status: 'Draft',
+    procedures_summary: appointment.visit_notes || 'Follow up after the completed visit.',
   });
-  const response: CompleteVisitResponse = {
+  const response: Extract<Output, { appointmentId: string }> = {
     appointmentId: event.record_id,
     message: `${appointment.name} marked completed and follow-up treatment plan drafted.`,
   };
-  if (treatmentPlan.data?.id != null) response.treatmentPlanId = treatmentPlan.data.id;
+  response.treatmentPlanId = treatmentPlan.id;
 
   return ok(response);
 }

package/examples/manifest/dental-practice-management/functions/operatory-list.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { operatoryDefinition } from '../schema';
 
-const OBJECT = 'dental_operatory__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, operatoryDefinition);
 }

package/examples/manifest/dental-practice-management/functions/patient-list.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { patientDefinition } from '../schema';
 
-const OBJECT = 'dental_patient__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, patientDefinition);
 }

package/examples/manifest/dental-practice-management/functions/treatment-plan-list.ts

@@ -1,28 +1,18 @@
-import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
-import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionContext, FunctionResponse } from '@rippling/rippling-sdk';
+import {
+  handleTypedObjectListPageEvent,
+  type TypedObjectListPageInput,
+  type TypedObjectListPageOutput,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { treatmentPlanDefinition } from '../schema';
 
-const OBJECT = 'dental_treatment_plan__c';
+export type Input = TypedObjectListPageInput;
+
+export type Output = TypedObjectListPageOutput;
 
 export async function onRipplingEvent(
-  event: SduiPageFunctionEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse> {
-  const action = event.parameters.action;
-
-  if (action === 'init') {
-    const spec = render({
-      root: ObjectListView({
-        props: { objectApiName: OBJECT },
-      }),
-      state: {},
-    });
-    return new FunctionResponse({
-      body: { spec: JSON.stringify(spec) },
-      statusCode: 200,
-      headers: {},
-      message: '',
-    });
-  }
-
-  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });
+): Promise<FunctionResponse<Output>> {
+  return handleTypedObjectListPageEvent(event, context, treatmentPlanDefinition);
 }

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

@@ -0,0 +1,298 @@
+/**
+ * Typed custom-object schema definitions for the dental practice management example.
+ *
+ * This file demonstrates the TypeScript-first schema layer under
+ * `core/platform/custom-objects`. The exported definitions are plain structural
+ * values that can be shared across manifests, validators, tests, and other
+ * tooling without depending on side-effectful constructor calls.
+ */
+
+import {
+  boolean,
+  date,
+  datetime,
+  defineCustomObject,
+  email,
+  formula,
+  longText,
+  lookup,
+  number,
+  parentChild,
+  phone,
+  radio,
+  section,
+  text,
+  typedRql,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category name shared by all custom objects in this example. */
+export const DENTAL_CATEGORY_NAME = 'dental';
+
+/** Patient chart schema: demographics, allergies, billing context, and chart notes. */
+export const patientDefinition = defineCustomObject({
+  name: 'dental_patient',
+  displayName: 'Patient',
+  pluralLabel: 'Patients',
+  category: DENTAL_CATEGORY_NAME,
+  description: 'Clinical chart, demographics, and care preferences',
+  icon: { emoji: '🦷' },
+  sections: {
+    identity: section('Demographics', { sectionId: 'sec_pt_identity' }),
+    clinical: section('Clinical', { sectionId: 'sec_pt_clinical' }),
+  },
+  fields: {
+    legal_name: text({
+      displayName: 'Full legal name',
+      description: 'Full legal name field',
+      required: true,
+      maxLength: 160,
+      section: 'identity',
+    }),
+    date_of_birth: date({
+      displayName: 'Date of birth',
+      description: 'Date of birth field',
+      section: 'identity',
+    }),
+    phone: phone({
+      displayName: 'Phone',
+      description: 'Phone field',
+      section: 'identity',
+    }),
+    email: email({
+      displayName: 'Email',
+      description: 'Email field',
+      unique: true,
+      section: 'identity',
+    }),
+    active_patient: boolean({
+      displayName: 'Active patient',
+      description: 'Whether the patient is currently active in the practice',
+      required: true,
+      section: 'identity',
+    }),
+    allergies_and_alerts: longText({
+      displayName: 'Allergies & medical alerts',
+      description: 'Drug allergies, bisphosphonates, anticoagulants, latex, etc.',
+      maxLength: 2000,
+      section: 'clinical',
+    }),
+    insurance_plan: text({
+      displayName: 'Insurance / payer',
+      description: 'Insurance / payer field',
+      maxLength: 120,
+      section: 'clinical',
+    }),
+    chart_summary: longText({
+      displayName: 'Chart summary & preferences',
+      description: 'Narrative, anxiety notes, perio class, last prophy, family history',
+      maxLength: 4000,
+      section: 'clinical',
+    }),
+    patient_label: formula.text({
+      displayName: 'Chart label',
+      description: 'Quick list label (name and birth year)',
+      formula: "CONCATENATE(legal_name__c, ' (b. ', YEAR(date_of_birth__c), ')')",
+      maxLength: 220,
+      section: 'identity',
+    }),
+  },
+});
+
+/** Provider schema used for appointment assignment and scheduling filters. */
+export const providerDefinition = defineCustomObject({
+  name: 'dental_provider',
+  displayName: 'Provider',
+  pluralLabel: 'Providers',
+  category: DENTAL_CATEGORY_NAME,
+  description: 'Clinicians who can be assigned to appointment blocks',
+  icon: { emoji: '🧑‍⚕️' },
+  sections: {
+    provider: section('Provider', { sectionId: 'sec_provider_info' }),
+  },
+  fields: {
+    provider_status: radio({
+      displayName: 'Status',
+      description: 'Whether this provider is active in the practice',
+      options: ['Active', 'On leave', 'Inactive'],
+      required: true,
+      section: 'provider',
+    }),
+    booking_status: radio({
+      displayName: 'Booking status',
+      description: 'Whether scheduling should offer this provider for new appointments',
+      options: ['Open', 'Limited', 'Closed'],
+      required: true,
+      section: 'provider',
+    }),
+    next_available_days: number({
+      displayName: 'Next available (days)',
+      description: 'Estimated days until this provider has an open appointment slot',
+      decimalPlaces: 0,
+      required: true,
+      section: 'provider',
+    }),
+  },
+});
+
+/** Operatory schema used as the parent object for the daily chair board. */
+export const operatoryDefinition = defineCustomObject({
+  name: 'dental_operatory',
+  displayName: 'Operatory',
+  pluralLabel: 'Operatories',
+  category: DENTAL_CATEGORY_NAME,
+  description: 'A chair, bay, or room you book on the daily board',
+  icon: { emoji: '🪥' },
+  sections: {
+    operatory: section('Operatory', { sectionId: 'sec_op_info' }),
+  },
+  fields: {
+    room_code: text({
+      displayName: 'Room code',
+      description: 'Short code for whiteboards and schedules',
+      maxLength: 20,
+      section: 'operatory',
+    }),
+  },
+});
+
+/** Appointment schema covering chair, patient, provider, schedule, and status. */
+export const appointmentDefinition = defineCustomObject({
+  name: 'dental_appointment',
+  displayName: 'Appointment',
+  pluralLabel: 'Appointments',
+  category: DENTAL_CATEGORY_NAME,
+  description: 'Chair booking with visit type and real-time visit status',
+  icon: { emoji: '📅' },
+  sections: {
+    operatory_and_time: section('Operatory & time', { sectionId: 'sec_appt_op' }),
+    patient_and_visit: section('Patient & visit', { sectionId: 'sec_appt_patient' }),
+  },
+  fields: {
+    operatory_ref: parentChild(operatoryDefinition, {
+      displayName: 'Operatory (chair)',
+      description: 'Which chair or bay this visit is booked on',
+      relatedDataLabel: 'Appointments',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'operatory_and_time',
+    }),
+    start_time: datetime({
+      displayName: 'Start (local)',
+      description: 'Planned or actual start; board sorts by this',
+      required: true,
+      section: 'operatory_and_time',
+    }),
+    duration_minutes: number({
+      displayName: 'Duration (minutes)',
+      description: 'Expected chair time for the procedure block',
+      required: true,
+      decimalPlaces: 0,
+      section: 'operatory_and_time',
+    }),
+    patient_ref: lookup(patientDefinition, {
+      displayName: 'Patient',
+      description: 'Chart to open for this visit (active patients only)',
+      relatedDataLabel: 'Appointments',
+      required: true,
+      lookupFilterRqlCondition: typedRql(patientDefinition, '(active_patient == True)'),
+      section: 'patient_and_visit',
+    }),
+    provider_ref: lookup(providerDefinition, {
+      displayName: 'Provider',
+      description: 'Provider assigned to this visit (active and bookable within two weeks)',
+      relatedDataLabel: 'Appointments',
+      required: true,
+      lookupFilterRqlCondition: typedRql(
+        providerDefinition,
+        "((provider_status IN ['Active']) AND (next_available_days <= 14) AND (booking_status NOT_IN ['Closed']))",
+      ),
+      section: 'patient_and_visit',
+    }),
+    visit_type: radio({
+      displayName: 'Visit type',
+      description: 'Visit type field',
+      options: [
+        'New patient exam',
+        'Periodic / recall exam',
+        'Prophy / cleaning',
+        'Restorative',
+        'Endodontic',
+        'Perio / SRP',
+        'Oral surgery / extraction',
+        'Orthodontic',
+        'Emergency / pain',
+        'Other',
+      ],
+      required: true,
+      section: 'patient_and_visit',
+    }),
+    appointment_status: radio({
+      displayName: 'Visit status',
+      description: 'Front-desk and clinical workflow status',
+      options: ['Scheduled', 'Checked in', 'In treatment', 'Completed', 'Cancelled', 'No-show'],
+      required: true,
+      section: 'patient_and_visit',
+    }),
+    visit_notes: longText({
+      displayName: 'Visit notes',
+      description: 'Chairside notes for this block (sync with EDR as needed)',
+      maxLength: 4000,
+      section: 'patient_and_visit',
+    }),
+    board_label: formula.text({
+      displayName: 'Board label',
+      description: 'Board label field',
+      formula: "CONCATENATE(visit_type__c, ' · ', appointment_status__c)",
+      maxLength: 260,
+      section: 'patient_and_visit',
+    }),
+  },
+});
+
+/** Treatment-plan schema for staged work owned by a patient chart. */
+export const treatmentPlanDefinition = defineCustomObject({
+  name: 'dental_treatment_plan',
+  displayName: 'Treatment plan',
+  pluralLabel: 'Treatment plans',
+  category: DENTAL_CATEGORY_NAME,
+  description: 'Staged work sequenced for a patient',
+  icon: { emoji: '📋' },
+  sections: {
+    link: section('Link', { sectionId: 'sec_plan_link' }),
+    plan: section('Plan', { sectionId: 'sec_plan_body' }),
+  },
+  fields: {
+    plan_patient_ref: parentChild(patientDefinition, {
+      displayName: 'Patient',
+      description: 'Which chart owns this plan',
+      relatedDataLabel: 'Treatment plans',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'link',
+    }),
+    plan_status: radio({
+      displayName: 'Status',
+      description: 'Status field',
+      options: ['Draft', 'Presented', 'Accepted', 'In progress', 'Completed', 'Declined / on hold'],
+      required: true,
+      section: 'plan',
+    }),
+    target_completion: date({
+      displayName: 'Target completion',
+      description: 'Goal to finish or next review',
+      section: 'plan',
+    }),
+    procedures_summary: longText({
+      displayName: 'Procedures & sequence',
+      description: 'Tooth numbers, codes, and staging',
+      maxLength: 8000,
+      section: 'plan',
+    }),
+    fee_estimate_cents: number({
+      displayName: 'Fee estimate (cents)',
+      description: 'Rough office fee total for planning; adjust per office policy',
+      decimalPlaces: 0,
+      section: 'plan',
+    }),
+  },
+});