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

package/examples/manifest/procurement-approval-hub/schema.ts

@@ -0,0 +1,256 @@
+/**
+ * Typed custom-object schema definitions for the procurement approval hub example.
+ */
+
+import {
+  date,
+  defineCustomObject,
+  email,
+  formula,
+  longText,
+  lookup,
+  number,
+  parentChild,
+  radio,
+  section,
+  text,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category shared by the procurement approval hub example. */
+export const PROCUREMENT_CATEGORY = 'procurement';
+
+/** Vendor profile schema used for contract and request relationships. */
+export const vendorDefinition = defineCustomObject({
+  name: 'pa_vendor',
+  displayName: 'Vendor',
+  pluralLabel: 'Vendors',
+  category: PROCUREMENT_CATEGORY,
+  description: 'Vendor profile, risk tier, and compliance owner',
+  sections: {
+    vendor: section('Vendor', { sectionId: 'sec_pa_vendor' }),
+  },
+  fields: {
+    legal_name: text({
+      displayName: 'Legal name',
+      description: 'Registered legal vendor name',
+      required: true,
+      maxLength: 200,
+      section: 'vendor',
+    }),
+    vendor_category: radio({
+      displayName: 'Vendor category',
+      description: 'Primary spend category',
+      options: ['Software', 'Facilities', 'Professional services', 'Marketing', 'Hardware', 'Other'],
+      required: true,
+      section: 'vendor',
+    }),
+    risk_tier: radio({
+      displayName: 'Risk tier',
+      description: 'Risk tier from diligence review',
+      options: ['Low', 'Medium', 'High', 'Critical'],
+      required: true,
+      section: 'vendor',
+    }),
+    contact_email: email({
+      displayName: 'Contact email',
+      description: 'Primary vendor contact email',
+      section: 'vendor',
+    }),
+  },
+});
+
+/** Contract schema tied to a parent vendor. */
+export const contractDefinition = defineCustomObject({
+  name: 'pa_contract',
+  displayName: 'Contract',
+  pluralLabel: 'Contracts',
+  category: PROCUREMENT_CATEGORY,
+  description: 'Vendor contract with dates, status, and spend ceiling',
+  sections: {
+    contract: section('Contract', { sectionId: 'sec_pa_contract' }),
+  },
+  fields: {
+    vendor_ref: parentChild(vendorDefinition, {
+      displayName: 'Vendor',
+      description: 'Vendor this contract belongs to',
+      relatedDataLabel: 'Contracts',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'contract',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Contract lifecycle status',
+      options: ['Draft', 'In review', 'Active', 'Expired', 'Terminated'],
+      required: true,
+      section: 'contract',
+    }),
+    start_date: date({
+      displayName: 'Start date',
+      description: 'Contract effective date',
+      section: 'contract',
+    }),
+    end_date: date({
+      displayName: 'End date',
+      description: 'Contract expiration date',
+      section: 'contract',
+    }),
+    spend_ceiling_cents: number({
+      displayName: 'Spend ceiling (cents)',
+      description: 'Approved maximum spend in cents',
+      decimalPlaces: 0,
+      section: 'contract',
+    }),
+    key_terms: longText({
+      displayName: 'Key terms',
+      description: 'Renewal, data processing, and termination notes',
+      maxLength: 6000,
+      section: 'contract',
+    }),
+  },
+});
+
+/** Purchase-request schema tied to a vendor and optional contract. */
+export const requestDefinition = defineCustomObject({
+  name: 'pa_purchase_request',
+  displayName: 'Purchase request',
+  pluralLabel: 'Purchase requests',
+  category: PROCUREMENT_CATEGORY,
+  description: 'Purchase request with business justification and approval state',
+  sections: {
+    request: section('Purchase request', { sectionId: 'sec_pa_request' }),
+  },
+  fields: {
+    vendor_ref: lookup(vendorDefinition, {
+      displayName: 'Vendor',
+      description: 'Preferred or selected vendor',
+      relatedDataLabel: 'Purchase requests',
+      required: true,
+      section: 'request',
+    }),
+    contract_ref: lookup(contractDefinition, {
+      displayName: 'Contract',
+      description: 'Contract used for this request, if any',
+      relatedDataLabel: 'Purchase requests',
+      section: 'request',
+    }),
+    amount_cents: number({
+      displayName: 'Amount (cents)',
+      description: 'Requested spend amount in cents',
+      decimalPlaces: 0,
+      required: true,
+      section: 'request',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Approval status',
+      options: ['Draft', 'Submitted', 'In approval', 'Approved', 'Rejected', 'Ordered'],
+      required: true,
+      section: 'request',
+    }),
+    need_by: date({
+      displayName: 'Need by',
+      description: 'Requested delivery or purchase date',
+      section: 'request',
+    }),
+    business_justification: longText({
+      displayName: 'Business justification',
+      description: 'Why the purchase is needed',
+      maxLength: 6000,
+      section: 'request',
+    }),
+    approval_label: formula.text({
+      displayName: 'Approval label',
+      description: 'Status and amount for approval queues',
+      formula: "CONCATENATE(status__c, ' - ', amount_cents__c)",
+      maxLength: 240,
+      section: 'request',
+    }),
+  },
+});
+
+/** Approval-step schema tied to a parent purchase request. */
+export const approvalDefinition = defineCustomObject({
+  name: 'pa_approval_step',
+  displayName: 'Approval step',
+  pluralLabel: 'Approval steps',
+  category: PROCUREMENT_CATEGORY,
+  description: 'Approval routing line tied to a purchase request',
+  sections: {
+    approval: section('Approval step', { sectionId: 'sec_pa_approval' }),
+  },
+  fields: {
+    purchase_request_ref: parentChild(requestDefinition, {
+      displayName: 'Purchase request',
+      description: 'Purchase request this approval belongs to',
+      relatedDataLabel: 'Approval steps',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: true,
+      section: 'approval',
+    }),
+    sequence: number({
+      displayName: 'Sequence',
+      description: 'Approval sequence number',
+      decimalPlaces: 0,
+      required: true,
+      section: 'approval',
+    }),
+    approval_role: radio({
+      displayName: 'Approval role',
+      description: 'Approval lane',
+      options: ['Budget owner', 'Finance', 'Security', 'Legal', 'Procurement'],
+      required: true,
+      section: 'approval',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Approval step status',
+      options: ['Pending', 'Approved', 'Rejected', 'Skipped'],
+      required: true,
+      section: 'approval',
+    }),
+  },
+});
+
+/** Invoice schema tied to a parent contract. */
+export const invoiceDefinition = defineCustomObject({
+  name: 'pa_invoice',
+  displayName: 'Invoice',
+  pluralLabel: 'Invoices',
+  category: PROCUREMENT_CATEGORY,
+  description: 'Invoice received against a vendor contract',
+  sections: {
+    invoice: section('Invoice', { sectionId: 'sec_pa_invoice' }),
+  },
+  fields: {
+    contract_ref: parentChild(contractDefinition, {
+      displayName: 'Contract',
+      description: 'Contract this invoice is billed against',
+      relatedDataLabel: 'Invoices',
+      parentChildType: 'PRIMARY',
+      enableParentOwnerInheritance: false,
+      section: 'invoice',
+    }),
+    invoice_number: text({
+      displayName: 'Invoice number',
+      description: 'Vendor invoice number',
+      maxLength: 120,
+      required: true,
+      section: 'invoice',
+    }),
+    amount_cents: number({
+      displayName: 'Amount (cents)',
+      description: 'Invoice amount in cents',
+      decimalPlaces: 0,
+      required: true,
+      section: 'invoice',
+    }),
+    status: radio({
+      displayName: 'Status',
+      description: 'Invoice processing status',
+      options: ['Received', 'Matched', 'Approved', 'Paid', 'Exception'],
+      required: true,
+      section: 'invoice',
+    }),
+  },
+});

package/examples/manifest/simple-todo-app/functions/mark-done.ts

@@ -1,28 +1,33 @@
-import RipplingSDK, {
+import {
   DetailViewActionFunctionEvent,
   FunctionContext,
   FunctionResponse,
   ListViewActionFunctionEvent,
 } from '@rippling/rippling-sdk';
+import { createCustomObjectFunctionRuntime } from '@rippling/rippling-sdk/core/platform/custom-objects';
+import { todoDefinition } from '../schema';
 
-const TODO_OBJECT_API_NAME = 'simple_todo__c';
 const ACTION_BUTTON = 'Mark done';
 
 type DetailEvent = DetailViewActionFunctionEvent<
   {},
-  typeof TODO_OBJECT_API_NAME,
+  typeof todoDefinition.apiName,
   typeof ACTION_BUTTON,
   'layout_simple_todo'
 >;
 
-type ListEvent = ListViewActionFunctionEvent<{}, typeof TODO_OBJECT_API_NAME, typeof ACTION_BUTTON>;
+type ListEvent = ListViewActionFunctionEvent<{}, typeof todoDefinition.apiName, typeof ACTION_BUTTON>;
 
-type MarkDoneEvent = DetailEvent | ListEvent;
+export type Input = DetailEvent | ListEvent;
+
+export type Output = {
+  updatedRecordIds: string[];
+};
 
 export async function onRipplingEvent(
-  event: MarkDoneEvent,
+  event: Input,
   context: FunctionContext,
-): Promise<FunctionResponse<{ updatedRecordIds: string[] }>> {
+): Promise<FunctionResponse<Output>> {
   const recordIds = event.trigger_type === 'record view' ? [event.record_id] : event.record_ids;
   if (recordIds.length === 0) {
     return new FunctionResponse({
@@ -31,13 +36,12 @@ export async function onRipplingEvent(
     });
   }
 
-  const client = new RipplingSDK({
-    bearerToken: context.env.rippling_user_bearer_token,
-  });
+  const runtime = createCustomObjectFunctionRuntime(context);
+  const manager = runtime.for(todoDefinition);
 
   for (const recordId of recordIds) {
-    await client.customObjects.records.update(TODO_OBJECT_API_NAME, recordId, {
-      status__c: 'Done',
+    await manager.update(recordId, {
+      status: 'Done',
     });
   }
 

package/examples/manifest/simple-todo-app/functions/todo-list.ts

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

package/examples/manifest/simple-todo-app/schema.ts

@@ -0,0 +1,60 @@
+/**
+ * Typed custom-object schema for the simple todo example.
+ */
+
+import {
+  date,
+  defineCustomObject,
+  longText,
+  radio,
+  section,
+  select,
+} from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category shared by the simple todo custom-object example. */
+export const SIMPLE_TODO_CATEGORY = 'simple_todo';
+
+/** Typed schema used by the simple todo manifest and action functions. */
+export const todoDefinition = defineCustomObject({
+  name: 'simple_todo',
+  displayName: 'Todo',
+  pluralLabel: 'Todos',
+  category: SIMPLE_TODO_CATEGORY,
+  description: 'A single task with status, priority, due date, and notes.',
+  icon: { emoji: '✅' },
+  sections: {
+    details: section('Details', { sectionId: 'sec_todo_details' }),
+  },
+  fields: {
+    status: radio({
+      displayName: 'Status',
+      description: 'Status field',
+      options: ['To Do', 'In Progress', 'Done'],
+      required: true,
+      section: 'details',
+    }),
+    priority: radio({
+      displayName: 'Priority',
+      description: 'Priority field',
+      options: ['Low', 'Medium', 'High'],
+      section: 'details',
+    }),
+    labels: select({
+      displayName: 'Labels',
+      description: 'One or more labels for organizing the task',
+      options: ['Personal', 'Work', 'Urgent', 'Follow-up'],
+      section: 'details',
+    }),
+    due_date: date({
+      displayName: 'Due date',
+      description: 'Due date field',
+      section: 'details',
+    }),
+    notes: longText({
+      displayName: 'Notes',
+      description: 'Notes field',
+      maxLength: 4000,
+      section: 'details',
+    }),
+  },
+});

package/examples/manifest/simple-todo-app/simple-todo-app.ts

@@ -1,9 +1,10 @@
 /*
  * Simple Todo — minimal CRUD example.
  *
- * One Custom Object (`simple_todo__c`) with name / status / priority / due date / notes,
- * one section, one list view ("Open todos"), one page layout, and one SDUI page that
- * renders the records via ObjectListView. No SDUI beyond ObjectListView.
+ * One typed Custom Object (`simple_todo__c`) with name / status / priority /
+ * due date / notes, one list view ("Open todos"), one page layout, and one
+ * SDUI page that renders the records via ObjectListView. No SDUI beyond
+ * ObjectListView.
  *
  *   simple_todo__c   ← name, status, priority, due_date, notes
  *
@@ -12,107 +13,48 @@
  *       > examples/manifest/simple-todo-app/manifest.json
  */
 
-import * as fs from 'node:fs';
 import * as path from 'node:path';
+import { toCustomCategoryApiName } from '@rippling/rippling-sdk/core/platform/custom-objects';
 import {
-  App,
-  Category,
-  CustomObject,
-  CustomObjectAction,
-  CustomObjectFieldSection,
-  CustomObjectPageLayout,
-  DateField,
-  ListViewDef,
-  LongTextField,
-  ManifestBuilder,
-  ManifestFunction,
-  RadioField,
-  SduiPage,
-  SelectField,
-} from '@rippling/rippling-sdk/lib/manifest';
+  defineSduiPageFromFunctionFile,
+  defineTypedCustomObjectActionFromFunctionFile,
+  defineTypedListView,
+  defineTypedPageLayout,
+  registerManifestCustomObject,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { App, Category, ManifestBuilder } from '@rippling/rippling-sdk/lib/manifest';
+import { SIMPLE_TODO_CATEGORY, todoDefinition } from './schema';
 
 const manifest = new ManifestBuilder({
   key: 'simple_todo_app',
   name: 'Simple Todo',
-  description: 'A minimal CRUD todo app: one Custom Object rendered as an SDUI ObjectListView',
+  description: 'A minimal CRUD todo app: one typed custom object rendered as an SDUI ObjectListView',
 });
 
 const todoCategory = new Category(manifest, {
-  apiName: 'simple_todo__c',
+  apiName: toCustomCategoryApiName(SIMPLE_TODO_CATEGORY),
   name: 'Tasks',
   description: 'Container for todo records',
 });
 
-// ── Todo object ─────────────────────────────────────────────────────────────
-const todoObj = new CustomObject(manifest, {
-  apiName: 'simple_todo__c',
-  name: 'Todo',
-  pluralLabel: 'Todos',
+const todo = registerManifestCustomObject(manifest, {
+  definition: todoDefinition,
   category: todoCategory,
-  description: 'A single task with status, priority, and due date',
-  icon: { emoji: '✅' },
-});
-
-const detailsSection = new CustomObjectFieldSection(todoObj, {
-  name: 'Details',
-  sectionId: 'sec_todo_details',
-});
-
-const statusField = new RadioField(todoObj, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Status field',
-  options: ['To Do', 'In Progress', 'Done'],
-  required: true,
-  section: detailsSection,
 });
 
-const priorityField = new RadioField(todoObj, {
-  apiName: 'priority__c',
-  displayName: 'Priority',
-  description: 'Priority field',
-  options: ['Low', 'Medium', 'High'],
-  section: detailsSection,
-});
-
-const labelsField = new SelectField(todoObj, {
-  apiName: 'labels__c',
-  displayName: 'Labels',
-  description: 'One or more labels for organizing the task',
-  options: ['Personal', 'Work', 'Urgent', 'Follow-up'],
-  section: detailsSection,
-});
-
-const dueDateField = new DateField(todoObj, {
-  apiName: 'due_date__c',
-  displayName: 'Due date',
-  description: 'Due date field',
-  section: detailsSection,
-});
-
-const notesField = new LongTextField(todoObj, {
-  apiName: 'notes__c',
-  displayName: 'Notes',
-  description: 'Notes field',
-  maxLength: 4000,
-  section: detailsSection,
-});
-
-// ── List view: Open todos ───────────────────────────────────────────────────
-new ListViewDef(todoObj, {
+defineTypedListView(todo, {
   viewId: 'view_simple_todo_open',
   name: 'Open todos',
   description: 'Everything that is not Done, ordered by due date',
-  fields: ['name', statusField, priorityField, labelsField, dueDateField],
-  orderBy: dueDateField,
+  fields: ['name', 'status', 'priority', 'labels', 'due_date'],
+  orderBy: 'due_date',
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
-  rqlFilter: "(status__c != 'Done')",
+  filter: (c) => c.ne(c.fields.status, 'Done'),
 });
 
-// ── Page layout ─────────────────────────────────────────────────────────────
-new CustomObjectPageLayout(todoObj, {
+defineTypedPageLayout(todo, {
   apiName: 'default',
   name: 'Todo',
   layoutId: 'layout_simple_todo',
@@ -126,15 +68,8 @@ new CustomObjectPageLayout(todoObj, {
           {
             name: 'Details',
             type: 'fields_section',
-            section: detailsSection,
-            fields: [
-              { field: 'name', editable: true },
-              statusField,
-              priorityField,
-              labelsField,
-              dueDateField,
-              notesField,
-            ],
+            section: todo.sections.details,
+            fields: [{ field: 'name', editable: true }, 'status', 'priority', 'labels', 'due_date', 'notes'],
           },
         ],
       },
@@ -146,41 +81,37 @@ new CustomObjectPageLayout(todoObj, {
 });
 
 // ── SDUI page (ObjectListView) ──────────────────────────────────────────────
-const todoListFn = new ManifestFunction(manifest, {
+const { function: todoListFn, page: todoListPage } = defineSduiPageFromFunctionFile(manifest, {
   apiName: 'simple_todo_list_fn',
   name: 'renderTodos',
   description: 'SDUI ObjectListView for todo records',
-  code: fs.readFileSync(path.join(__dirname, 'functions', 'todo-list.ts'), 'utf-8'),
+  codeDirectory: path.join(__dirname, 'functions'),
+  codeFilename: 'todo-list.ts',
   dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.65', '@rippling/pebble-sdui-web': '^0.9.2' },
   isAsync: false,
+  pageId: 'simple_todo_page',
+  pageName: 'Todos',
 });
 
-const todoListPage = new SduiPage(manifest, {
-  sduiPageId: 'simple_todo_page',
-  name: 'Todos',
-  function: todoListFn,
-});
-
-const markDoneFn = new ManifestFunction(manifest, {
-  apiName: 'simple_todo_mark_done_fn',
-  name: 'markDone',
-  description: 'Marks one todo from its detail view or selected todos from the list view as done',
-  code: fs.readFileSync(path.join(__dirname, 'functions', 'mark-done.ts'), 'utf-8'),
-  dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.76' },
-  isAsync: false,
-});
-
-new CustomObjectAction(todoObj, {
+defineTypedCustomObjectActionFromFunctionFile(manifest, todo, {
   actionId: 'action_simple_todo_mark_done',
   name: 'Mark done',
-  function: markDoneFn,
   visibilityPreferences: ['DETAIL_VIEW', 'LIST_VIEW'],
+  function: {
+    apiName: 'simple_todo_mark_done_fn',
+    name: 'markDone',
+    description: 'Marks one todo from its detail view or selected todos from the list view as done',
+    codeDirectory: path.join(__dirname, 'functions'),
+    codeFilename: 'mark-done.ts',
+    dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.76' },
+    isAsync: false,
+  },
 });
 
 new App(manifest, {
   apiName: 'simple_todo_app',
   name: 'Simple Todo',
-  description: 'Minimal todo app: one Custom Object with an SDUI ObjectListView page',
+  description: 'Minimal todo app: one typed custom object with an SDUI ObjectListView page',
   appType: 'custom',
   pages: [todoListPage],
 });