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

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

@@ -1,18 +1,28 @@
-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';
+import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
+import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
 
-export type Input = TypedObjectListPageInput;
-
-export type Output = TypedObjectListPageOutput;
+const OBJECT = 'dental_appointment__c';
 
 export async function onRipplingEvent(
-  event: Input,
+  event: SduiPageFunctionEvent,
   context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return handleTypedObjectListPageEvent(event, context, appointmentDefinition);
+): 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: '' });
 }

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

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

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

@@ -1,18 +1,28 @@
-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';
+import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
+import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
 
-export type Input = TypedObjectListPageInput;
-
-export type Output = TypedObjectListPageOutput;
+const OBJECT = 'dental_operatory__c';
 
 export async function onRipplingEvent(
-  event: Input,
+  event: SduiPageFunctionEvent,
   context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return handleTypedObjectListPageEvent(event, context, operatoryDefinition);
+): 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: '' });
 }

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

@@ -1,18 +1,28 @@
-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';
+import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
+import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
 
-export type Input = TypedObjectListPageInput;
-
-export type Output = TypedObjectListPageOutput;
+const OBJECT = 'dental_patient__c';
 
 export async function onRipplingEvent(
-  event: Input,
+  event: SduiPageFunctionEvent,
   context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return handleTypedObjectListPageEvent(event, context, patientDefinition);
+): 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: '' });
 }

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

@@ -1,18 +1,28 @@
-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';
+import { FunctionContext, FunctionResponse, SduiPageFunctionEvent } from '@rippling/rippling-sdk';
+import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
 
-export type Input = TypedObjectListPageInput;
-
-export type Output = TypedObjectListPageOutput;
+const OBJECT = 'dental_treatment_plan__c';
 
 export async function onRipplingEvent(
-  event: Input,
+  event: SduiPageFunctionEvent,
   context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return handleTypedObjectListPageEvent(event, context, treatmentPlanDefinition);
+): 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: '' });
 }

package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts

@@ -1,13 +1,9 @@
 /*
  * Existing manifest mutations.
  *
- * This example keeps the existing manifest JSON inline, rebinds a typed
- * definition onto the existing manifest, removes layout content, adds
- * different layout content, and prints the updated manifest JSON.
- *
- * Current boundary: rebinding avoids most manual load-from-existing plumbing,
- * but creating brand-new fields/sections in an existing manifest still uses
- * low-level manifest classes as an explicit escape hatch.
+ * This example keeps the existing manifest JSON inline, hydrates it back into
+ * SDK objects, removes layout content, adds different layout content, and
+ * prints the updated manifest JSON.
  *
  * Run:
  *   yarn -s tsn examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts \
@@ -15,15 +11,9 @@
  */
 
 import {
-  defineCustomObject,
-  phone,
-  radio,
-  section,
-  text,
-} from '@rippling/rippling-sdk/core/platform/custom-objects';
-import { bindExistingManifestCustomObject } from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
-import {
+  CustomObject,
   CustomObjectFieldSection,
+  CustomObjectPageLayout,
   type ExistingManifest,
   ManifestBuilder,
   RadioField,
@@ -171,58 +161,24 @@ const existingManifestJson: ExistingManifest = {
   ],
 };
 
-const gymMemberDefinition = defineCustomObject({
-  name: 'gym_member',
-  displayName: 'Member',
-  pluralLabel: 'Members',
-  category: 'gym',
-  description: 'Gym member profile, contact, and membership status',
-  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',
-      required: true,
-      maxLength: 80,
-      section: 'profile',
-    }),
-    last_name: text({
-      displayName: 'Last name',
-      description: 'Last name',
-      required: true,
-      maxLength: 80,
-      section: 'profile',
-    }),
-    phone: phone({
-      displayName: 'Phone',
-      description: 'Phone',
-      section: 'profile',
-    }),
-    membership_status: radio({
-      displayName: 'Membership status',
-      description: 'Membership status',
-      options: ['Active', 'Frozen', 'Cancelled', 'Trial'],
-      required: true,
-      section: 'membership',
-    }),
-  },
-});
-
 const manifest = ManifestBuilder.loadFromExistingJson(existingManifestJson);
-const member = bindExistingManifestCustomObject(gymMemberDefinition);
-const memberLayout = member.loadPageLayout('layout_gym_member');
+const memberObj = CustomObject.loadFromExisting('gym_member__c');
+const profileSection = CustomObjectFieldSection.loadFromExisting('sec_gm_profile', {
+  customObjectApiName: memberObj.getApiName(),
+});
+const membershipSection = CustomObjectFieldSection.loadFromExisting('sec_gm_membership', {
+  customObjectApiName: memberObj.getApiName(),
+});
+const memberLayout = CustomObjectPageLayout.loadFromExisting('layout_gym_member', {
+  customObjectApiName: memberObj.getApiName(),
+});
 
-// Escape hatch: new field creation inside an existing-manifest mutation still
-// drops to the low-level manifest class model today.
-const preferredName = new TextField(member.object, {
+const preferredName = new TextField(memberObj, {
   apiName: 'preferred_name__c',
   displayName: 'Preferred name',
   description: 'Preferred name field',
   maxLength: 80,
-  section: member.sections.profile,
+  section: profileSection,
 });
 
 // Remove an existing field from one section, then add a different field there.
@@ -231,28 +187,27 @@ const preferredName = new TextField(member.object, {
 memberLayout
   .removeField('phone__c', {
     tabKey: 'member',
-    section: member.sections.profile,
+    section: profileSection,
     removeAll: false,
   })
   .addField(preferredName, {
     tabKey: 'member',
-    section: member.sections.profile,
+    section: profileSection,
     position: 2,
   });
 
-// Escape hatch: new section creation likewise stays low-level for now.
-const marketingSection = new CustomObjectFieldSection(member.object, {
+const marketingSection = new CustomObjectFieldSection(memberObj, {
   sectionId: 'sec_gm_marketing',
   name: 'Marketing',
 });
-const marketingOptIn = new RadioField(member.object, {
+const marketingOptIn = new RadioField(memberObj, {
   apiName: 'marketing_opt_in__c',
   displayName: 'Marketing opt-in',
   description: 'Marketing opt-in field',
   options: ['Yes', 'No', 'Unknown'],
   section: marketingSection,
 });
-const referralSource = new TextField(member.object, {
+const referralSource = new TextField(memberObj, {
   apiName: 'referral_source__c',
   displayName: 'Referral source',
   description: 'Referral source field',
@@ -263,7 +218,7 @@ const referralSource = new TextField(member.object, {
 // Remove one existing section from the layout, then add a different one.
 // The removed section component and its fields remain in the manifest.
 memberLayout
-  .removeSection(member.sections.membership, {
+  .removeSection(membershipSection, {
     tabKey: 'member',
     removeAll: false,
   })