@rippling/rippling-sdk 0.2.0-alpha.48 → 0.2.0-alpha.49

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

@@ -0,0 +1,429 @@
+{
+  "metadata": {
+    "key": "simple_todo_app",
+    "name": "Simple Todo",
+    "description": "A minimal CRUD todo app: one Custom Object rendered as an SDUI ObjectListView"
+  },
+  "components": [
+    {
+      "type": "CUSTOM_CATEGORY",
+      "api_name": "simple_todo__c",
+      "name": "Tasks",
+      "description": "Container for todo records"
+    },
+    {
+      "type": "CUSTOM_OBJECT",
+      "api_name": "simple_todo__c",
+      "name": "Todo",
+      "description": "A single task with status, priority, and due date",
+      "category_api_name": "simple_todo__c",
+      "icon": {
+        "emoji": "✅"
+      },
+      "plural_label": "Todos"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "id",
+      "field_display_name": "ID",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "TEXT"
+      },
+      "description": "The Rippling ID of a record",
+      "is_required": true,
+      "is_unique": true,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "created_at",
+      "field_display_name": "Created Date",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "DATETIME"
+      },
+      "description": "The date and time a record was created",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "updated_at",
+      "field_display_name": "Last Modified Date",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "DATETIME"
+      },
+      "description": "The date and time a record was last updated",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "system_updated_at",
+      "field_display_name": "System Modified At",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "DATETIME"
+      },
+      "description": "The date and time a record was last updated by the system",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "external_id",
+      "field_display_name": "External ID",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "TEXT"
+      },
+      "description": "The external identifier for a record used in third party integrations",
+      "is_required": false,
+      "is_unique": true,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "name",
+      "field_display_name": "Name",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "TEXT"
+      },
+      "description": "A string used to describe a record. This is used for display purposes as well as search",
+      "is_required": true,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "owner_role",
+      "field_display_name": "Owner",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "NATIVE_EDGE",
+        "og_model_rql_name": "Employee",
+        "db_model_name": "RoleWithCompany",
+        "reference_column_storage_type": "STRING"
+      },
+      "description": "The Employee responsible for the record. This is used by Permissions to determine who has ability to view, edit, and delete data",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "last_modified_by",
+      "field_display_name": "Last Modified by",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "NATIVE_EDGE",
+        "og_model_rql_name": "Employee",
+        "db_model_name": "RoleWithCompany",
+        "reference_column_storage_type": "STRING"
+      },
+      "description": "The Employee who made the latest change.",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "created_by",
+      "field_display_name": "Created by",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "NATIVE_EDGE",
+        "og_model_rql_name": "Employee",
+        "db_model_name": "RoleWithCompany",
+        "reference_column_storage_type": "STRING"
+      },
+      "description": "The Employee who created the record",
+      "is_required": false,
+      "is_unique": false,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": true,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": null
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD_SECTION",
+      "section_id": "sec_todo_details",
+      "model_name": "simple_todo__c",
+      "name": "Details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "title__c",
+      "field_display_name": "Title",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "TEXT",
+        "max_length": 200
+      },
+      "description": null,
+      "is_required": true,
+      "is_unique": null,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": false,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": "sec_todo_details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "status__c",
+      "field_display_name": "Status",
+      "data_type": {
+        "options_list": ["To Do", "In Progress", "Done"],
+        "supported_types": [],
+        "field_type": "SELECT"
+      },
+      "description": null,
+      "is_required": true,
+      "is_unique": null,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": false,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": "sec_todo_details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "priority__c",
+      "field_display_name": "Priority",
+      "data_type": {
+        "options_list": ["Low", "Medium", "High"],
+        "supported_types": [],
+        "field_type": "SELECT"
+      },
+      "description": null,
+      "is_required": null,
+      "is_unique": null,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": false,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": "sec_todo_details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "due_date__c",
+      "field_display_name": "Due date",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "DATE"
+      },
+      "description": null,
+      "is_required": null,
+      "is_unique": null,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": false,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": "sec_todo_details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_FIELD",
+      "custom_object_api_name": "simple_todo__c",
+      "field_api_name": "notes__c",
+      "field_display_name": "Notes",
+      "data_type": {
+        "options_list": [],
+        "supported_types": [],
+        "field_type": "LONG_TEXT",
+        "max_length": 4000
+      },
+      "description": null,
+      "is_required": null,
+      "is_unique": null,
+      "is_indexed": null,
+      "rql_formula": null,
+      "formula_attr_metas": null,
+      "is_standard": false,
+      "derived_aggregated_field": null,
+      "derived_field_formula": null,
+      "section": "sec_todo_details"
+    },
+    {
+      "type": "CUSTOM_OBJECT_LIST_VIEW",
+      "object_rql_name": "simple_todo__c",
+      "view_id": "view_simple_todo_open",
+      "name": "Open todos",
+      "public": true,
+      "fields": ["title__c", "status__c", "priority__c", "due_date__c"],
+      "description": "Everything that is not Done, ordered by due date",
+      "object_scope": "all",
+      "sort_order": "ASC",
+      "order_by": "due_date__c",
+      "rql_filter": "(status__c != 'Done')"
+    },
+    {
+      "type": "CUSTOM_OBJECT_PAGE_LAYOUT",
+      "layout_id": "layout_simple_todo",
+      "api_name": "default",
+      "object_rql_name": "simple_todo__c",
+      "name": "Todo",
+      "system_created": false,
+      "tab_edits": {
+        "tabsOrder": ["todo"],
+        "newTabs": [
+          {
+            "key": "todo",
+            "name": "Todo",
+            "type": "tab_with_sections",
+            "sections": [
+              {
+                "name": "Details",
+                "type": "fields_section",
+                "fields": [
+                  {
+                    "fieldRqlName": "title__c"
+                  },
+                  {
+                    "fieldRqlName": "status__c"
+                  },
+                  {
+                    "fieldRqlName": "priority__c"
+                  },
+                  {
+                    "fieldRqlName": "due_date__c"
+                  },
+                  {
+                    "fieldRqlName": "notes__c"
+                  }
+                ],
+                "key": "sec_todo_details"
+              }
+            ]
+          }
+        ],
+        "systemTabEdits": {}
+      },
+      "header_edits": {
+        "newTitleField": "title__c"
+      },
+      "visibility_conditions": {},
+      "blueprint_key": "simple_todo__c"
+    },
+    {
+      "type": "FUNCTION",
+      "name": "Todos (SDUI)",
+      "api_name": "simple_todo_list_fn",
+      "description": "SDUI ObjectListView for todo records",
+      "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'simple_todo__c';\n\nexport async function onRipplingEvent(\n  event: FunctionEvent,\n  context: FunctionContext,\n): Promise<FunctionResponse> {\n  const action = event['parameters']?.action;\n\n  if (!action || action === 'init') {\n    const s = SDUI.createState({});\n    const root = SDUI.components.VStack({\n      children: [\n        SDUI.components.ObjectListView({\n          objectApiName: OBJECT,\n          canSearchInGrid: true,\n        }),\n      ],\n    });\n    return new FunctionResponse({\n      body: { spec: JSON.stringify(SDUI.render(s, root)) },\n      statusCode: 200,\n      headers: {},\n      message: '',\n    });\n  }\n\n  return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
+      "dependencies": {
+        "@rippling/rippling-sdk": "^0.2.0-alpha.33"
+      }
+    },
+    {
+      "type": "SDUI_PAGE",
+      "name": "Todos",
+      "sdui_page_id": "simple_todo_page",
+      "function_api_name": "simple_todo_list_fn",
+      "description": "SDUI ObjectListView for todo records"
+    },
+    {
+      "type": "CUSTOM_APP",
+      "api_name": "simple_todo_app",
+      "name": "Simple Todo",
+      "description": "Minimal todo app: one Custom Object with an SDUI ObjectListView page",
+      "app_type": "custom",
+      "pages": [
+        {
+          "api_name": "simple_todo_page",
+          "page_type": "sdui_page",
+          "sdui_page_id": "simple_todo_page"
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,167 @@
+/*
+ * Simple Todo — minimal CRUD example.
+ *
+ * One Custom Object (`simple_todo__c`) with title / 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   ← title, status, priority, due_date, notes
+ *
+ * Run:
+ *   yarn tsn examples/manifest/simple-todo-app/simple-todo-app.ts \
+ *       > examples/manifest/simple-todo-app/manifest.json
+ */
+
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import {
+  App,
+  Category,
+  CustomObject,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  DateField,
+  ListViewDef,
+  LongTextField,
+  ManifestBuilder,
+  ManifestFunction,
+  SduiPage,
+  SelectField,
+  TextField,
+} from '@rippling/rippling-sdk/lib/manifest';
+
+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',
+});
+
+const todoCategory = new Category(manifest, {
+  apiName: 'simple_todo__c',
+  name: 'Tasks',
+  description: 'Container for todo records',
+});
+
+// ── 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 titleField = new TextField(todoObj, {
+  apiName: 'title__c',
+  displayName: 'Title',
+  description: 'Title field',
+  required: true,
+  maxLength: 200,
+  section: detailsSection,
+});
+
+const statusField = new SelectField(todoObj, {
+  apiName: 'status__c',
+  displayName: 'Status',
+  description: 'Status field',
+  options: ['To Do', 'In Progress', 'Done'],
+  required: true,
+  section: detailsSection,
+});
+
+const priorityField = new SelectField(todoObj, {
+  apiName: 'priority__c',
+  displayName: 'Priority',
+  description: 'Priority field',
+  options: ['Low', 'Medium', 'High'],
+  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: [titleField, statusField, priorityField, dueDateField],
+  orderBy: dueDateField,
+  sortOrder: 'ASC',
+  isPublic: true,
+  objectScope: 'all',
+  rqlFilter: "(status__c != 'Done')",
+});
+
+// ── Page layout ─────────────────────────────────────────────────────────────
+new CustomObjectPageLayout(todoObj, {
+  apiName: 'default',
+  name: 'Todo',
+  layoutId: 'layout_simple_todo',
+  headerEdits: { newTitleField: titleField.getApiName() },
+  tabEdits: {
+    newTabs: [
+      {
+        key: 'todo',
+        name: 'Todo',
+        type: 'tab_with_sections',
+        sections: [
+          {
+            name: 'Details',
+            type: 'fields_section',
+            section: detailsSection,
+            fields: [titleField, statusField, priorityField, dueDateField, notesField],
+          },
+        ],
+      },
+    ],
+    systemTabEdits: {},
+    tabsOrder: ['todo'],
+  },
+  visibilityConditions: {},
+});
+
+// ── SDUI page (ObjectListView) ──────────────────────────────────────────────
+const todoListFn = new ManifestFunction(manifest, {
+  apiName: 'simple_todo_list_fn',
+  name: 'Todos (SDUI)',
+  description: 'SDUI ObjectListView for todo records',
+  code: fs.readFileSync(path.join(__dirname, 'functions', 'todo-list.ts'), 'utf-8'),
+  dependencies: { '@rippling/rippling-sdk': '^0.2.0-alpha.33' },
+  isAsync: false,
+});
+
+const todoListPage = new SduiPage(manifest, {
+  sduiPageId: 'simple_todo_page',
+  name: 'Todos',
+  function: todoListFn,
+  description: 'SDUI ObjectListView for todo records',
+});
+
+new App(manifest, {
+  apiName: 'simple_todo_app',
+  name: 'Simple Todo',
+  description: 'Minimal todo app: one Custom Object with an SDUI ObjectListView page',
+  appType: 'custom',
+  pages: [todoListPage],
+});
+
+console.log(manifest.preview());

package/examples/sdui/sdui-crud-todo/rippling-function.ts

@@ -1,14 +1,6 @@
-/**
- * ----------------------------------------------------------------------------
- * PASTE THIS ENTIRE FILE INTO THE RIPPLING FUNCTION EDITOR TO PREVIEW RENDERED
- * SDUI (CUSTOM PAGE). DEPENDS ON @rippling/rippling-sdk AND @rippling/sdui-builder.
- * MOCK DATA ONLY — NO CUSTOM OBJECT API NAMES; SAFE TO RENDER WITHOUT CO DEFINITIONS.
- * ----------------------------------------------------------------------------
- * Pair file sdui-crud-todo.ts uses import from '@rippling/rippling-sdk/lib/sdui' for local runs.
- */
+/** Todo CRUD demo: grid + modals wired to create / update / delete via callFunction. Mock data only. */
 
-/*
-import SDUI from '@rippling/sdui-builder';
+import SDUI from '@rippling/rippling-sdk/lib/sdui';
 import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';
 
 const INITIAL_TODOS = [
@@ -58,10 +50,10 @@ function renderSpec(functionId: string) {
           SDUI.components.HStack({
             gap: 'space200',
             align: 'center',
-            wrap: true,
+            wrap: 'wrap',
             children: [
               SDUI.components.Heading({
-                level: '2',
+                level: 2,
                 text: 'Team todos',
               }),
               SDUI.components.Badge({
@@ -92,7 +84,7 @@ function renderSpec(functionId: string) {
           { id: 'notes__c', header: 'Notes', data: 'notes__c' },
         ],
         selectedRow: s.selectedRow.$bind,
-        headerActions: [{ id: 'new', label: 'New Todo', icon: 'ADD', appearance: 'PRIMARY' }],
+        headerActions: [{ id: 'new', label: 'New Todo', icon: 'ADD', appearance: 'primary' }],
         onHeaderAction: [
           SDUI.actions.set(s.form, { title: '', status: '', priority: '', notes: '' }),
           SDUI.actions.set(s.showCreateModal, true),
@@ -328,15 +320,15 @@ export async function onRipplingEvent(
   if (action === 'update') {
     const p = params ?? {};
     mutableTodos = mutableTodos.map((r) =>
-      r.id === p['id']
-        ? {
-            ...r,
-            title__c: (p['title'] as string) || r.title__c,
-            status__c: (p['status'] as string) || r.status__c,
-            priority__c: (p['priority'] as string) || r.priority__c,
-            notes__c: (p['notes'] as string) ?? r.notes__c,
-          }
-        : r,
+      r.id === p['id'] ?
+        {
+          ...r,
+          title__c: (p['title'] as string) || r.title__c,
+          status__c: (p['status'] as string) || r.status__c,
+          priority__c: (p['priority'] as string) || r.priority__c,
+          notes__c: (p['notes'] as string) ?? r.notes__c,
+        }
+      : r,
     );
     return new FunctionResponse({
       body: mutableTodos as unknown as Record<string, unknown>,
@@ -364,4 +356,3 @@ export async function onRipplingEvent(
     message: 'Unknown action',
   });
 }
-*/