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

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

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

package/examples/manifest/simple-todo-app/functions/todo-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 { todoDefinition } 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 = 'simple_todo__c';
 
 export async function onRipplingEvent(
-  event: Input,
+  event: SduiPageFunctionEvent,
   context: FunctionContext,
-): Promise<FunctionResponse<Output>> {
-  return handleTypedObjectListPageEvent(event, context, todoDefinition);
+): 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/simple-todo-app/simple-todo-app.ts

@@ -1,10 +1,9 @@
 /*
  * Simple Todo — minimal CRUD example.
  *
- * 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.
+ * 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.
  *
  *   simple_todo__c   ← name, status, priority, due_date, notes
  *
@@ -13,48 +12,107 @@
  *       > 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 {
-  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';
+  App,
+  Category,
+  CustomObject,
+  CustomObjectAction,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  DateField,
+  ListViewDef,
+  LongTextField,
+  ManifestBuilder,
+  ManifestFunction,
+  RadioField,
+  SduiPage,
+  SelectField,
+} from '@rippling/rippling-sdk/lib/manifest';
 
 const manifest = new ManifestBuilder({
   key: 'simple_todo_app',
   name: 'Simple Todo',
-  description: 'A minimal CRUD todo app: one typed custom object rendered as an SDUI ObjectListView',
+  description: 'A minimal CRUD todo app: one Custom Object rendered as an SDUI ObjectListView',
 });
 
 const todoCategory = new Category(manifest, {
-  apiName: toCustomCategoryApiName(SIMPLE_TODO_CATEGORY),
+  apiName: 'simple_todo__c',
   name: 'Tasks',
   description: 'Container for todo records',
 });
 
-const todo = registerManifestCustomObject(manifest, {
-  definition: todoDefinition,
+// ── Todo object ─────────────────────────────────────────────────────────────
+const todoObj = new CustomObject(manifest, {
+  apiName: 'simple_todo__c',
+  name: 'Todo',
+  pluralLabel: 'Todos',
   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,
 });
 
-defineTypedListView(todo, {
+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, {
   viewId: 'view_simple_todo_open',
   name: 'Open todos',
   description: 'Everything that is not Done, ordered by due date',
-  fields: ['name', 'status', 'priority', 'labels', 'due_date'],
-  orderBy: 'due_date',
+  fields: ['name', statusField, priorityField, labelsField, dueDateField],
+  orderBy: dueDateField,
   sortOrder: 'ASC',
   isPublic: true,
   objectScope: 'all',
-  filter: (c) => c.ne(c.fields.status, 'Done'),
+  rqlFilter: "(status__c != 'Done')",
 });
 
-defineTypedPageLayout(todo, {
+// ── Page layout ─────────────────────────────────────────────────────────────
+new CustomObjectPageLayout(todoObj, {
   apiName: 'default',
   name: 'Todo',
   layoutId: 'layout_simple_todo',
@@ -68,8 +126,15 @@ defineTypedPageLayout(todo, {
           {
             name: 'Details',
             type: 'fields_section',
-            section: todo.sections.details,
-            fields: [{ field: 'name', editable: true }, 'status', 'priority', 'labels', 'due_date', 'notes'],
+            section: detailsSection,
+            fields: [
+              { field: 'name', editable: true },
+              statusField,
+              priorityField,
+              labelsField,
+              dueDateField,
+              notesField,
+            ],
           },
         ],
       },
@@ -81,37 +146,41 @@ defineTypedPageLayout(todo, {
 });
 
 // ── SDUI page (ObjectListView) ──────────────────────────────────────────────
-const { function: todoListFn, page: todoListPage } = defineSduiPageFromFunctionFile(manifest, {
+const todoListFn = new ManifestFunction(manifest, {
   apiName: 'simple_todo_list_fn',
   name: 'renderTodos',
   description: 'SDUI ObjectListView for todo records',
-  codeDirectory: path.join(__dirname, 'functions'),
-  codeFilename: 'todo-list.ts',
+  code: fs.readFileSync(path.join(__dirname, 'functions', 'todo-list.ts'), 'utf-8'),
   dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.65', '@rippling/pebble-sdui-web': '^0.9.2' },
   isAsync: false,
-  pageId: 'simple_todo_page',
-  pageName: 'Todos',
 });
 
-defineTypedCustomObjectActionFromFunctionFile(manifest, todo, {
+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, {
   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 typed custom object with an SDUI ObjectListView page',
+  description: 'Minimal todo app: one Custom Object with an SDUI ObjectListView page',
   appType: 'custom',
   pages: [todoListPage],
 });