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

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

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