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

package/examples/manifest/custom-object-creation-workflow/functions/intake-request-created.ts

@@ -1,20 +0,0 @@
-import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';
-
-export type Input = FunctionEvent;
-
-export type Output = {
-  ok: true;
-  runId: string;
-};
-
-export async function onRipplingEvent(
-  _event: Input,
-  context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return new FunctionResponse({
-    body: {
-      ok: true,
-      runId: context.function.run_id,
-    },
-  });
-}

package/examples/manifest/custom-object-creation-workflow/schema.ts

@@ -1,29 +0,0 @@
-/**
- * Typed custom-object schema for the minimal workflow example.
- */
-
-import { defineCustomObject, radio, section } from '@rippling/rippling-sdk/core/platform/custom-objects';
-
-/** Logical category shared by the intake workflow example. */
-export const INTAKE_CATEGORY = 'intake';
-
-/** Typed intake request schema used by the workflow example. */
-export const intakeRequestDefinition = defineCustomObject({
-  name: 'intake_request',
-  displayName: 'Intake request',
-  pluralLabel: 'Intake requests',
-  category: INTAKE_CATEGORY,
-  description: 'Request submitted for workflow processing.',
-  sections: {
-    details: section('Details', { sectionId: 'sec_intake_request_details' }),
-  },
-  fields: {
-    status: radio({
-      displayName: 'Status',
-      description: 'Request status',
-      options: ['New', 'In review', 'Complete'],
-      required: true,
-      section: 'details',
-    }),
-  },
-});

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

@@ -1,298 +0,0 @@
-/**
- * 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',
-    }),
-  },
-});

package/examples/manifest/field-service-dispatch/schema.ts

@@ -1,248 +0,0 @@
-/**
- * Typed custom-object schema definitions for the field service dispatch example.
- */
-
-import {
-  date,
-  datetime,
-  defineCustomObject,
-  formula,
-  longText,
-  lookup,
-  number,
-  parentChild,
-  radio,
-  section,
-  text,
-} from '@rippling/rippling-sdk/core/platform/custom-objects';
-
-/** Logical category shared by the field service dispatch example. */
-export const FIELD_SERVICE_CATEGORY = 'field_service';
-
-/** Customer-site schema used by assets and work orders. */
-export const siteDefinition = defineCustomObject({
-  name: 'fs_customer_site',
-  displayName: 'Customer site',
-  pluralLabel: 'Customer sites',
-  category: FIELD_SERVICE_CATEGORY,
-  description: 'Customer location with service tier and access notes',
-  sections: {
-    site: section('Site', { sectionId: 'sec_fs_site' }),
-  },
-  fields: {
-    account_name: text({
-      displayName: 'Account name',
-      description: 'Customer account or property group',
-      required: true,
-      maxLength: 160,
-      section: 'site',
-    }),
-    service_address: longText({
-      displayName: 'Service address',
-      description: 'Address, gate code, and arrival instructions',
-      maxLength: 3000,
-      section: 'site',
-    }),
-    service_tier: radio({
-      displayName: 'Service tier',
-      description: 'SLA tier for dispatch prioritization',
-      options: ['Standard', 'Premium', 'Critical 24x7'],
-      required: true,
-      section: 'site',
-    }),
-  },
-});
-
-/** Installed-asset schema tied to a customer site. */
-export const assetDefinition = defineCustomObject({
-  name: 'fs_asset',
-  displayName: 'Asset',
-  pluralLabel: 'Assets',
-  category: FIELD_SERVICE_CATEGORY,
-  description: 'Installed equipment maintained at a customer site',
-  sections: {
-    asset: section('Asset', { sectionId: 'sec_fs_asset' }),
-  },
-  fields: {
-    customer_site_ref: parentChild(siteDefinition, {
-      displayName: 'Customer site',
-      description: 'Site where this asset is installed',
-      relatedDataLabel: 'Assets',
-      parentChildType: 'PRIMARY',
-      enableParentOwnerInheritance: false,
-      section: 'asset',
-    }),
-    serial_number: text({
-      displayName: 'Serial number',
-      description: 'Manufacturer serial number',
-      maxLength: 80,
-      section: 'asset',
-    }),
-    asset_type: radio({
-      displayName: 'Asset type',
-      description: 'Equipment category',
-      options: ['HVAC', 'Generator', 'Security', 'Network', 'Kitchen equipment', 'Other'],
-      required: true,
-      section: 'asset',
-    }),
-    warranty_end: date({
-      displayName: 'Warranty end',
-      description: 'Warranty expiration date',
-      section: 'asset',
-    }),
-  },
-});
-
-/** Work-order schema tied to a customer site and optional asset. */
-export const workOrderDefinition = defineCustomObject({
-  name: 'fs_work_order',
-  displayName: 'Work order',
-  pluralLabel: 'Work orders',
-  category: FIELD_SERVICE_CATEGORY,
-  description: 'Dispatch job with schedule, priority, and status',
-  sections: {
-    work_order: section('Work order', { sectionId: 'sec_fs_work_order' }),
-  },
-  fields: {
-    customer_site_ref: parentChild(siteDefinition, {
-      displayName: 'Customer site',
-      description: 'Site receiving service',
-      relatedDataLabel: 'Work orders',
-      parentChildType: 'PRIMARY',
-      enableParentOwnerInheritance: false,
-      section: 'work_order',
-    }),
-    asset_ref: lookup(assetDefinition, {
-      displayName: 'Asset',
-      description: 'Optional installed asset being serviced',
-      relatedDataLabel: 'Work orders',
-      section: 'work_order',
-    }),
-    priority: radio({
-      displayName: 'Priority',
-      description: 'Dispatch priority',
-      options: ['Low', 'Normal', 'High', 'Emergency'],
-      required: true,
-      section: 'work_order',
-    }),
-    status: radio({
-      displayName: 'Status',
-      description: 'Current dispatch status',
-      options: ['New', 'Scheduled', 'In progress', 'Blocked', 'Complete', 'Cancelled'],
-      required: true,
-      section: 'work_order',
-    }),
-    scheduled_start: datetime({
-      displayName: 'Scheduled start',
-      description: 'Planned arrival window start',
-      section: 'work_order',
-    }),
-    scheduled_end: datetime({
-      displayName: 'Scheduled end',
-      description: 'Planned arrival window end',
-      section: 'work_order',
-    }),
-    problem_summary: longText({
-      displayName: 'Problem summary',
-      description: 'Customer-reported issue and triage notes',
-      maxLength: 6000,
-      section: 'work_order',
-    }),
-    dispatch_label: formula.text({
-      displayName: 'Dispatch label',
-      description: 'Compact board label',
-      formula: "CONCATENATE(priority__c, ' - ', status__c)",
-      maxLength: 240,
-      section: 'work_order',
-    }),
-  },
-});
-
-/** Task schema tied to a parent work order. */
-export const taskDefinition = defineCustomObject({
-  name: 'fs_task',
-  displayName: 'Task',
-  pluralLabel: 'Tasks',
-  category: FIELD_SERVICE_CATEGORY,
-  description: 'Work order task with labor estimate and completion state',
-  sections: {
-    task: section('Task', { sectionId: 'sec_fs_task' }),
-  },
-  fields: {
-    work_order_ref: parentChild(workOrderDefinition, {
-      displayName: 'Work order',
-      description: 'Work order this task belongs to',
-      relatedDataLabel: 'Tasks',
-      parentChildType: 'PRIMARY',
-      enableParentOwnerInheritance: true,
-      section: 'task',
-    }),
-    task_type: radio({
-      displayName: 'Task type',
-      description: 'Type of work required',
-      options: ['Inspect', 'Repair', 'Replace', 'Calibrate', 'Clean', 'Customer walkthrough'],
-      required: true,
-      section: 'task',
-    }),
-    status: radio({
-      displayName: 'Status',
-      description: 'Task status',
-      options: ['Open', 'In progress', 'Blocked', 'Done'],
-      required: true,
-      section: 'task',
-    }),
-    estimated_hours: number({
-      displayName: 'Estimated hours',
-      description: 'Labor estimate for this task',
-      decimalPlaces: 2,
-      section: 'task',
-    }),
-    completed_at: datetime({
-      displayName: 'Completed at',
-      description: 'Completion timestamp',
-      section: 'task',
-    }),
-  },
-});
-
-/** Part-usage schema tied to a parent task. */
-export const partUsageDefinition = defineCustomObject({
-  name: 'fs_part_usage',
-  displayName: 'Part usage',
-  pluralLabel: 'Part usage',
-  category: FIELD_SERVICE_CATEGORY,
-  description: 'Part consumed while completing a task',
-  sections: {
-    part_usage: section('Part usage', { sectionId: 'sec_fs_part_usage' }),
-  },
-  fields: {
-    task_ref: parentChild(taskDefinition, {
-      displayName: 'Task',
-      description: 'Task that consumed this part',
-      relatedDataLabel: 'Parts used',
-      parentChildType: 'PRIMARY',
-      enableParentOwnerInheritance: true,
-      section: 'part_usage',
-    }),
-    sku: text({
-      displayName: 'SKU',
-      description: 'Inventory SKU or part number',
-      maxLength: 80,
-      required: true,
-      section: 'part_usage',
-    }),
-    quantity: number({
-      displayName: 'Quantity',
-      description: 'Quantity consumed',
-      decimalPlaces: 2,
-      required: true,
-      section: 'part_usage',
-    }),
-    unit_cost_cents: number({
-      displayName: 'Unit cost (cents)',
-      description: 'Unit material cost in cents',
-      decimalPlaces: 0,
-      section: 'part_usage',
-    }),
-  },
-});