@rippling/rippling-sdk 0.2.0-alpha.34 → 0.2.0-alpha.36

package/examples/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store example files demonstrating usage of this SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

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

@@ -0,0 +1,651 @@
+/*
+ * Dental Practice Management — patient charts, operatories (chairs), appointments
+ * with status, treatment plans, rollups, and an SDUI ObjectListView tab for appointments.
+ *
+ *   dental_patient__c        ← chart: demographics, allergies, notes
+ *   dental_operatory__c      ← chair / room (parent for same-day board rollups)
+ *   dental_appointment__c   ← child of operatory; patient lookup, time, status, visit type
+ *   dental_treatment_plan__c ← child of patient; plan status, procedures, estimates
+ *
+ * Run:
+ *   yarn tsn examples/manifest/dental-practice-management/dental-practice-management.ts \
+ *       > examples/manifest/dental-practice-management/manifest.json
+ */
+
+import {
+  App,
+  Category,
+  CustomObject,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  DatetimeField,
+  DateField,
+  EmailField,
+  FormulaField,
+  ListViewDef,
+  LongTextField,
+  LookupField,
+  ManifestBuilder,
+  ManifestFunction,
+  NumberField,
+  ParentChildField,
+  PhoneField,
+  Rule,
+  SelectField,
+  SduiPage,
+  SummaryField,
+  TextField,
+  Validation,
+} from '@rippling/rippling-sdk/lib/manifest';
+const manifest = new ManifestBuilder({
+  key: 'dental_practice_management',
+  name: 'Dental Practice Management',
+  description:
+    'Patient charts, chair schedule, appointments with status, and treatment plans for a dental office',
+});
+
+const dentalCategory = new Category(manifest, {
+  apiName: 'dental__c',
+  name: 'Dental',
+  description: 'Patients, chairs, visits, and treatment plans',
+});
+
+// ── Patient (chart) ─────────────────────────────────────────────────────────
+const patientObj = new CustomObject(manifest, {
+  apiName: 'dental_patient__c',
+  name: 'Patient',
+  pluralLabel: 'Patients',
+  category: dentalCategory,
+  description: 'Clinical chart, demographics, and care preferences',
+  icon: { emoji: '🦷' },
+});
+
+const patientIdentitySection = new CustomObjectFieldSection(patientObj, {
+  name: 'Demographics',
+  sectionId: 'sec_pt_identity',
+});
+
+const patientClinicalSection = new CustomObjectFieldSection(patientObj, {
+  name: 'Clinical',
+  sectionId: 'sec_pt_clinical',
+});
+
+const patientNameField = new TextField(patientObj, {
+  apiName: 'legal_name__c',
+  displayName: 'Full legal name',
+  required: true,
+  maxLength: 160,
+  section: patientIdentitySection,
+});
+
+const patientDobField = new DateField(patientObj, {
+  apiName: 'date_of_birth__c',
+  displayName: 'Date of birth',
+  section: patientIdentitySection,
+});
+
+const patientPhoneField = new PhoneField(patientObj, {
+  apiName: 'phone__c',
+  displayName: 'Phone',
+  section: patientIdentitySection,
+});
+
+const patientEmailField = new EmailField(patientObj, {
+  apiName: 'email__c',
+  displayName: 'Email',
+  unique: true,
+  section: patientIdentitySection,
+});
+
+const patientAllergiesField = new LongTextField(patientObj, {
+  apiName: 'allergies_and_alerts__c',
+  displayName: 'Allergies & medical alerts',
+  maxLength: 2000,
+  description: 'Drug allergies, bisphosphonates, anticoagulants, latex, etc.',
+  section: patientClinicalSection,
+});
+
+const patientInsuranceField = new TextField(patientObj, {
+  apiName: 'insurance_plan__c',
+  displayName: 'Insurance / payer',
+  maxLength: 120,
+  section: patientClinicalSection,
+});
+
+const patientChartNotesField = new LongTextField(patientObj, {
+  apiName: 'chart_summary__c',
+  displayName: 'Chart summary & preferences',
+  maxLength: 4000,
+  description: 'Narrative, anxiety notes, perio class, last prophy, family history',
+  section: patientClinicalSection,
+});
+
+const patientLabelField = new FormulaField(patientObj, {
+  apiName: 'patient_label__c',
+  displayName: 'Chart label',
+  fieldType: 'TEXT',
+  maxLength: 220,
+  formula: "CONCATENATE(legal_name__c, ' (b. ', YEAR(date_of_birth__c), ')')",
+  description: 'Quick list label (name and birth year)',
+  section: patientIdentitySection,
+});
+
+// ── Operatory (chair) ─────────────────────────────────────────────────────────
+const operatoryObj = new CustomObject(manifest, {
+  apiName: 'dental_operatory__c',
+  name: 'Operatory',
+  pluralLabel: 'Operatories',
+  category: dentalCategory,
+  description: 'A chair, bay, or room you book on the daily board',
+  icon: { emoji: '🪥' },
+});
+
+const operatorySection = new CustomObjectFieldSection(operatoryObj, {
+  name: 'Operatory',
+  sectionId: 'sec_op_info',
+});
+
+const opNameField = new TextField(operatoryObj, {
+  apiName: 'operatory_name__c',
+  displayName: 'Name / label',
+  required: true,
+  maxLength: 80,
+  description: 'E.g. "Hyg 1", "DDS-2", "Surg A"',
+  section: operatorySection,
+});
+
+const opCodeField = new TextField(operatoryObj, {
+  apiName: 'room_code__c',
+  displayName: 'Room code',
+  maxLength: 20,
+  description: 'Short code for whiteboards and schedules',
+  section: operatorySection,
+});
+
+// ── Appointment (child of operatory) ─────────────────────────────────────────
+const apptObj = new CustomObject(manifest, {
+  apiName: 'dental_appointment__c',
+  name: 'Appointment',
+  pluralLabel: 'Appointments',
+  category: dentalCategory,
+  description: 'Chair booking with visit type and real-time visit status',
+  icon: { emoji: '📅' },
+});
+
+const apptOperatorySection = new CustomObjectFieldSection(apptObj, {
+  name: 'Operatory & time',
+  sectionId: 'sec_appt_op',
+});
+
+const apptPatientSection = new CustomObjectFieldSection(apptObj, {
+  name: 'Patient & visit',
+  sectionId: 'sec_appt_patient',
+});
+
+const apptOperatoryRef = new ParentChildField(apptObj, {
+  apiName: 'operatory_ref__c',
+  displayName: 'Operatory (chair)',
+  target: operatoryObj,
+  relatedDataLabel: 'Appointments',
+  parentChildType: 'PRIMARY',
+  enableParentOwnerInheritance: false,
+  description: 'Which chair or bay this visit is booked on',
+  section: apptOperatorySection,
+});
+
+const apptStartField = new DatetimeField(apptObj, {
+  apiName: 'start_time__c',
+  displayName: 'Start (local)',
+  required: true,
+  description: 'Planned or actual start; board sorts by this',
+  section: apptOperatorySection,
+});
+
+const apptDurationMins = new NumberField(apptObj, {
+  apiName: 'duration_minutes__c',
+  displayName: 'Duration (minutes)',
+  required: true,
+  decimalPlaces: 0,
+  description: 'Expected chair time for the procedure block',
+  section: apptOperatorySection,
+});
+
+const apptPatientRef = new LookupField(apptObj, {
+  apiName: 'patient_ref__c',
+  displayName: 'Patient',
+  target: patientObj,
+  relatedDataLabel: 'Appointments',
+  required: true,
+  description: 'Chart to open for this visit',
+  section: apptPatientSection,
+});
+
+const apptVisitTypeField = new SelectField(apptObj, {
+  apiName: 'visit_type__c',
+  displayName: 'Visit type',
+  options: [
+    'New patient exam',
+    'Periodic / recall exam',
+    'Prophy / cleaning',
+    'Restorative',
+    'Endodontic',
+    'Perio / SRP',
+    'Oral surgery / extraction',
+    'Orthodontic',
+    'Emergency / pain',
+    'Other',
+  ],
+  required: true,
+  section: apptPatientSection,
+});
+
+const apptStatusField = new SelectField(apptObj, {
+  apiName: 'appointment_status__c',
+  displayName: 'Visit status',
+  options: ['Scheduled', 'Checked in', 'In treatment', 'Completed', 'Cancelled', 'No-show'],
+  required: true,
+  description: 'Front-desk and clinical workflow status',
+  section: apptPatientSection,
+});
+
+const apptClinicalNotes = new LongTextField(apptObj, {
+  apiName: 'visit_notes__c',
+  displayName: 'Visit notes',
+  maxLength: 4000,
+  description: 'Chairside notes for this block (sync with EDR as needed)',
+  section: apptPatientSection,
+});
+
+const apptBoardLabel = new FormulaField(apptObj, {
+  apiName: 'board_label__c',
+  displayName: 'Board label',
+  fieldType: 'TEXT',
+  maxLength: 260,
+  formula: "CONCATENATE(visit_type__c, ' · ', appointment_status__c)",
+  section: apptPatientSection,
+});
+
+// ── Treatment plan (child of patient) ─────────────────────────────────────────
+const planObj = new CustomObject(manifest, {
+  apiName: 'dental_treatment_plan__c',
+  name: 'Treatment plan',
+  pluralLabel: 'Treatment plans',
+  category: dentalCategory,
+  description: 'Staged work sequenced for a patient',
+  icon: { emoji: '📋' },
+});
+
+const planLinkSection = new CustomObjectFieldSection(planObj, {
+  name: 'Link',
+  sectionId: 'sec_plan_link',
+});
+
+const planBodySection = new CustomObjectFieldSection(planObj, {
+  name: 'Plan',
+  sectionId: 'sec_plan_body',
+});
+
+const planPatientRef = new ParentChildField(planObj, {
+  apiName: 'plan_patient_ref__c',
+  displayName: 'Patient',
+  target: patientObj,
+  relatedDataLabel: 'Treatment plans',
+  parentChildType: 'PRIMARY',
+  enableParentOwnerInheritance: false,
+  description: 'Which chart owns this plan',
+  section: planLinkSection,
+});
+
+const planNameField = new TextField(planObj, {
+  apiName: 'plan_name__c',
+  displayName: 'Plan name',
+  required: true,
+  maxLength: 200,
+  description: 'E.g. "Full mouth rehab - phase 1", "Crown 14 DO"',
+  section: planBodySection,
+});
+
+const planStatusField = new SelectField(planObj, {
+  apiName: 'plan_status__c',
+  displayName: 'Status',
+  options: ['Draft', 'Presented', 'Accepted', 'In progress', 'Completed', 'Declined / on hold'],
+  required: true,
+  section: planBodySection,
+});
+
+const planTargetField = new DateField(planObj, {
+  apiName: 'target_completion__c',
+  displayName: 'Target completion',
+  description: 'Goal to finish or next review',
+  section: planBodySection,
+});
+
+const planProceduresField = new LongTextField(planObj, {
+  apiName: 'procedures_summary__c',
+  displayName: 'Procedures & sequence',
+  maxLength: 8000,
+  description: 'Tooth numbers, codes, and staging',
+  section: planBodySection,
+});
+
+const planFeeCents = new NumberField(planObj, {
+  apiName: 'fee_estimate_cents__c',
+  displayName: 'Fee estimate (cents)',
+  decimalPlaces: 0,
+  description: 'Rough office fee total for planning; adjust per office policy',
+  section: planBodySection,
+});
+
+// ── Rollups ────────────────────────────────────────────────────────────────
+const apptCountOnOperatory = new SummaryField(operatoryObj, {
+  apiName: 'appointment_count__c',
+  displayName: 'Appointments (count)',
+  aggregates: apptPatientRef,
+  using: 'COUNT',
+  lookup: apptOperatoryRef,
+  description: 'Rows in this operatory (filter by day in the chair board function)',
+  section: operatorySection,
+});
+
+const planCountOnPatient = new SummaryField(patientObj, {
+  apiName: 'treatment_plan_count__c',
+  displayName: 'Treatment plans',
+  aggregates: planNameField,
+  using: 'COUNT',
+  lookup: planPatientRef,
+  description: 'Active plans tied to the chart',
+  section: patientClinicalSection,
+});
+
+// ── Validations & defaults ──────────────────────────────────────────────────
+new Validation(apptObj, {
+  ruleId: 'dental_appt_duration_positive',
+  displayName: 'Duration must be positive',
+  rqlFormula: '(duration_minutes__c <= 0)',
+  errorMessage: 'Duration must be at least 1 minute.',
+  ruleDescription: 'Blocks empty or zero chair blocks',
+  state: 'ACTIVE',
+  level: 'FIELD',
+  fieldRef: apptDurationMins,
+});
+
+new Rule(apptObj, {
+  flowId: 'dental_default_appt_status',
+  flowName: 'Default visit status to Scheduled',
+  triggerType: 'CREATE',
+  description: 'New bookings start as Scheduled unless the team changes it',
+  actions: [{ targetField: apptStatusField, fixedValue: ['Scheduled'] }],
+});
+
+// ── List views ─────────────────────────────────────────────────────────────
+new ListViewDef(patientObj, {
+  viewId: 'view_dental_all_patients',
+  name: 'All patients',
+  description: 'Full chart list with plan counts',
+  fields: [patientNameField, patientDobField, patientPhoneField, patientLabelField, planCountOnPatient],
+  orderBy: patientNameField,
+  sortOrder: 'ASC',
+  isPublic: true,
+  objectScope: 'all',
+});
+
+new ListViewDef(operatoryObj, {
+  viewId: 'view_dental_all_operatories',
+  name: 'All operatories',
+  description: 'Chairs and daily volume rollups',
+  fields: [opNameField, opCodeField, apptCountOnOperatory],
+  orderBy: opNameField,
+  sortOrder: 'ASC',
+  isPublic: true,
+  objectScope: 'all',
+});
+
+new ListViewDef(apptObj, {
+  viewId: 'view_dental_appointments_all',
+  name: 'All appointments',
+  description: 'Chronological board with chair and status',
+  fields: [
+    apptOperatoryRef,
+    apptStartField,
+    apptDurationMins,
+    apptPatientRef,
+    apptVisitTypeField,
+    apptStatusField,
+    apptBoardLabel,
+  ],
+  orderBy: apptStartField,
+  sortOrder: 'ASC',
+  isPublic: true,
+  objectScope: 'all',
+});
+
+new ListViewDef(planObj, {
+  viewId: 'view_dental_treatment_plans',
+  name: 'All treatment plans',
+  description: 'Case tracking by status',
+  fields: [planPatientRef, planNameField, planStatusField, planTargetField, planFeeCents],
+  orderBy: planTargetField,
+  sortOrder: 'ASC',
+  isPublic: true,
+  objectScope: 'all',
+});
+
+// ── Page layouts ─────────────────────────────────────────────────────────────
+new CustomObjectPageLayout(patientObj, {
+  apiName: 'default',
+  name: 'Patient chart',
+  layoutId: 'layout_dental_patient',
+  headerEdits: { newTitleField: patientNameField.getApiName() },
+  tabEdits: {
+    newTabs: [
+      {
+        key: 'chart',
+        name: 'Chart',
+        type: 'tab_with_sections',
+        sections: [
+          {
+            key: 'id',
+            name: 'Profile',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: patientNameField.getApiName() },
+              { fieldRqlName: patientDobField.getApiName() },
+              { fieldRqlName: patientPhoneField.getApiName() },
+              { fieldRqlName: patientEmailField.getApiName() },
+              { fieldRqlName: patientLabelField.getApiName() },
+            ],
+          },
+          {
+            key: 'clinical',
+            name: 'Clinical & billing',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: patientAllergiesField.getApiName() },
+              { fieldRqlName: patientInsuranceField.getApiName() },
+              { fieldRqlName: patientChartNotesField.getApiName() },
+              { fieldRqlName: planCountOnPatient.getApiName() },
+            ],
+          },
+        ],
+      },
+    ],
+    systemTabEdits: {},
+    tabsOrder: ['chart'],
+  },
+  visibilityConditions: {},
+});
+
+new CustomObjectPageLayout(operatoryObj, {
+  apiName: 'default',
+  name: 'Operatory',
+  layoutId: 'layout_dental_operatory',
+  headerEdits: { newTitleField: opNameField.getApiName() },
+  tabEdits: {
+    newTabs: [
+      {
+        key: 'overview',
+        name: 'Overview',
+        type: 'tab_with_sections',
+        sections: [
+          {
+            key: 'room',
+            name: 'Room',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: opNameField.getApiName() },
+              { fieldRqlName: opCodeField.getApiName() },
+              { fieldRqlName: apptCountOnOperatory.getApiName() },
+            ],
+          },
+        ],
+      },
+    ],
+    systemTabEdits: {},
+    tabsOrder: ['overview'],
+  },
+  visibilityConditions: {},
+});
+
+new CustomObjectPageLayout(apptObj, {
+  apiName: 'default',
+  name: 'Appointment',
+  layoutId: 'layout_dental_appointment',
+  headerEdits: { newTitleField: apptBoardLabel.getApiName() },
+  tabEdits: {
+    newTabs: [
+      {
+        key: 'visit',
+        name: 'Visit',
+        type: 'tab_with_sections',
+        sections: [
+          {
+            key: 'chair',
+            name: 'Chair & schedule',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: apptOperatoryRef.getApiName() },
+              { fieldRqlName: apptStartField.getApiName() },
+              { fieldRqlName: apptDurationMins.getApiName() },
+            ],
+          },
+          {
+            key: 'patient',
+            name: 'Patient & status',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: apptPatientRef.getApiName() },
+              { fieldRqlName: apptVisitTypeField.getApiName() },
+              { fieldRqlName: apptStatusField.getApiName() },
+              { fieldRqlName: apptBoardLabel.getApiName() },
+              { fieldRqlName: apptClinicalNotes.getApiName() },
+            ],
+          },
+        ],
+      },
+    ],
+    systemTabEdits: {},
+    tabsOrder: ['visit'],
+  },
+  visibilityConditions: {},
+});
+
+new CustomObjectPageLayout(planObj, {
+  apiName: 'default',
+  name: 'Treatment plan',
+  layoutId: 'layout_dental_treatment_plan',
+  headerEdits: { newTitleField: planNameField.getApiName() },
+  tabEdits: {
+    newTabs: [
+      {
+        key: 'plan',
+        name: 'Plan',
+        type: 'tab_with_sections',
+        sections: [
+          {
+            key: 'link',
+            name: 'Patient',
+            type: 'fields_section',
+            fields: [{ fieldRqlName: planPatientRef.getApiName() }],
+          },
+          {
+            key: 'content',
+            name: 'Planned work',
+            type: 'fields_section',
+            fields: [
+              { fieldRqlName: planNameField.getApiName() },
+              { fieldRqlName: planStatusField.getApiName() },
+              { fieldRqlName: planTargetField.getApiName() },
+              { fieldRqlName: planProceduresField.getApiName() },
+              { fieldRqlName: planFeeCents.getApiName() },
+            ],
+          },
+        ],
+      },
+    ],
+    systemTabEdits: {},
+    tabsOrder: ['plan'],
+  },
+  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',
+});
+
+new App(manifest, {
+  apiName: 'dental_practice_management_app',
+  name: 'Dental Practice Management',
+  description: 'Patient charts, operatories, treatment plans, and an SDUI appointment list tab',
+  appType: 'custom',
+  pages: [patientObj, operatoryObj, apptObj, planObj, chairBoardPage],
+});
+
+console.log(manifest.preview());