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

package/examples/manifest/gym-membership-management/schema.ts

@@ -0,0 +1,266 @@
+/**
+ * Typed custom-object schema definitions for the gym membership management example.
+ */
+
+import {
+  date,
+  datetime,
+  defineCustomObject,
+  email,
+  formula,
+  longText,
+  lookup,
+  number,
+  parentChild,
+  phone,
+  radio,
+  section,
+  select,
+  text,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category shared by the gym membership management example. */
+export const GYM_CATEGORY = 'gym';
+
+/** Member schema used for directory, enrollment, and check-in flows. */
+export const memberDefinition = defineCustomObject({
+  name: 'gym_member',
+  displayName: 'Member',
+  pluralLabel: 'Members',
+  category: GYM_CATEGORY,
+  description: 'Gym member profile, contact, and membership status',
+  icon: { emoji: '🏋️' },
+  sections: {
+    profile: section('Profile', { sectionId: 'sec_gm_profile' }),
+    membership: section('Membership', { sectionId: 'sec_gm_membership' }),
+  },
+  fields: {
+    first_name: text({
+      displayName: 'First name',
+      description: 'First name field',
+      required: true,
+      maxLength: 80,
+      section: 'profile',
+    }),
+    last_name: text({
+      displayName: 'Last name',
+      description: 'Last name field',
+      required: true,
+      maxLength: 80,
+      section: 'profile',
+    }),
+    email: email({
+      displayName: 'Email',
+      description: 'Email field',
+      unique: true,
+      section: 'profile',
+    }),
+    phone: phone({
+      displayName: 'Phone',
+      description: 'Phone field',
+      section: 'profile',
+    }),
+    membership_status: radio({
+      displayName: 'Membership status',
+      description: 'Membership status field',
+      options: ['Active', 'Frozen', 'Cancelled', 'Trial'],
+      required: true,
+      section: 'membership',
+    }),
+    join_date: date({
+      displayName: 'Join date',
+      description: 'Join date field',
+      section: 'membership',
+    }),
+    emergency_contact: longText({
+      displayName: 'Emergency contact',
+      description: 'Name and phone for emergencies',
+      maxLength: 2000,
+      section: 'membership',
+    }),
+    preferred_class_types: select({
+      displayName: 'Preferred class types',
+      description: 'One or more class types the member enjoys',
+      options: ['Yoga', 'Spin', 'HIIT', 'Strength', 'Pilates', 'Dance', 'Aquatics'],
+      section: 'membership',
+    }),
+  },
+});
+
+/** Trainer schema used by scheduled class sessions. */
+export const trainerDefinition = defineCustomObject({
+  name: 'gym_trainer',
+  displayName: 'Trainer',
+  pluralLabel: 'Trainers',
+  category: GYM_CATEGORY,
+  description: 'Instructors and coaches who lead scheduled classes',
+  icon: { emoji: '🎯' },
+  sections: {
+    trainer: section('Trainer', { sectionId: 'sec_tr_profile' }),
+  },
+  fields: {
+    email: email({
+      displayName: 'Email',
+      description: 'Email field',
+      section: 'trainer',
+    }),
+    specialty: radio({
+      displayName: 'Primary specialty',
+      description: 'Primary specialty field',
+      options: ['Yoga', 'Spin', 'HIIT', 'Strength', 'Pilates', 'Dance', 'Aquatics', 'General'],
+      section: 'trainer',
+    }),
+    bio: longText({
+      displayName: 'Bio & certifications',
+      description: 'Bio & certifications field',
+      maxLength: 4000,
+      section: 'trainer',
+    }),
+    trainer_label: formula.text({
+      displayName: 'List label',
+      description: 'List label field',
+      formula: "CONCATENATE(name, ' · ', specialty__c)",
+      maxLength: 220,
+      section: 'trainer',
+    }),
+  },
+});
+
+/** Scheduled class-session schema tied to a trainer lookup. */
+export const sessionDefinition = defineCustomObject({
+  name: 'gym_class_session',
+  displayName: 'Class session',
+  pluralLabel: 'Class sessions',
+  category: GYM_CATEGORY,
+  description: 'A scheduled class with assigned trainer, time, and capacity',
+  icon: { emoji: '📅' },
+  sections: {
+    schedule: section('Schedule', { sectionId: 'sec_cs_schedule' }),
+    class_and_room: section('Class & room', { sectionId: 'sec_cs_class' }),
+  },
+  fields: {
+    trainer_ref: lookup(trainerDefinition, {
+      displayName: 'Trainer',
+      description: 'Instructor leading this session',
+      relatedDataLabel: 'Class sessions',
+      required: true,
+      section: 'schedule',
+    }),
+    start_time: datetime({
+      displayName: 'Start',
+      description: 'Session start (local)',
+      required: true,
+      section: 'schedule',
+    }),
+    end_time: datetime({
+      displayName: 'End',
+      description: 'Session end (local)',
+      required: true,
+      section: 'schedule',
+    }),
+    class_type: radio({
+      displayName: 'Class type',
+      description: 'Class type field',
+      options: [
+        'Yoga',
+        'Spin',
+        'HIIT',
+        'Strength',
+        'Pilates',
+        'Dance',
+        'Aquatics',
+        'Recovery / stretch',
+        'Other',
+      ],
+      required: true,
+      section: 'class_and_room',
+    }),
+    room_name: text({
+      displayName: 'Studio / room',
+      description: 'E.g. Studio A, Pool lane 2',
+      maxLength: 80,
+      section: 'class_and_room',
+    }),
+    capacity: number({
+      displayName: 'Capacity',
+      description: 'Maximum attendees for this session',
+      decimalPlaces: 0,
+      section: 'class_and_room',
+    }),
+    session_notes: longText({
+      displayName: 'Notes',
+      description: 'Notes field',
+      maxLength: 4000,
+      section: 'class_and_room',
+    }),
+    session_date: formula.date({
+      displayName: 'Session date',
+      description: 'Calendar day for filtering “today” views',
+      formula: "DATETRUNC('DAY', start_time__c)",
+      section: 'schedule',
+    }),
+    session_board_label: formula.text({
+      displayName: 'Board label',
+      description: 'Board label field',
+      formula: "CONCATENATE(class_type__c, ' · ', room_name__c)",
+      maxLength: 260,
+      section: 'schedule',
+    }),
+  },
+});
+
+/** Enrollment schema tied to a parent class session and member lookup. */
+export const enrollmentDefinition = defineCustomObject({
+  name: 'gym_class_enrollment',
+  displayName: 'Class enrollment',
+  pluralLabel: 'Class enrollments',
+  category: GYM_CATEGORY,
+  description: 'Member registration for a session with attendance and check-in',
+  icon: { emoji: '✅' },
+  sections: {
+    session_and_member: section('Session & member', { sectionId: 'sec_ce_link' }),
+    attendance: section('Attendance', { sectionId: 'sec_ce_att' }),
+  },
+  fields: {
+    class_session_ref: parentChild(sessionDefinition, {
+      displayName: 'Class session',
+      description: 'Which scheduled class this row belongs to',
+      relatedDataLabel: 'Enrollments',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'session_and_member',
+    }),
+    member_ref: lookup(memberDefinition, {
+      displayName: 'Member',
+      description: 'Member field',
+      relatedDataLabel: 'Class enrollments',
+      required: true,
+      section: 'session_and_member',
+    }),
+    attendance_status: radio({
+      displayName: 'Attendance',
+      description: 'Front desk: set to Checked in when the member arrives',
+      options: ['Registered', 'Checked in', 'Late', 'No-show', 'Cancelled'],
+      required: true,
+      section: 'attendance',
+    }),
+    checked_in_at: datetime({
+      displayName: 'Checked in at',
+      description: 'Timestamp when staff recorded arrival (optional)',
+      section: 'attendance',
+    }),
+    enrollment_notes: longText({
+      displayName: 'Notes',
+      description: 'Notes field',
+      maxLength: 2000,
+      section: 'attendance',
+    }),
+    roster_row_label: formula.text({
+      displayName: 'Roster row label',
+      description: 'Roster row label field',
+      formula: "CONCATENATE(attendance_status__c, ' · Enrollment')",
+      maxLength: 160,
+      section: 'attendance',
+    }),
+  },
+});

package/examples/manifest/procurement-approval-hub/functions/route-purchase-request.ts

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