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

package/src/lib/manifest/sdui-page.ts

@@ -1,7 +1,7 @@
 import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { ManifestFunction } from './manifest-function';
 import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
-import { requireStringComponentField } from './_existing-component-fields';
+import { optionalStringComponentField, requireStringComponentField } from './_existing-component-fields';
 
 /**
  * Initialization properties for {@link SduiPage}.
@@ -29,9 +29,9 @@ export interface SduiPageProps {
   /**
    * Human-readable description of what this page shows.
    *
-   * Optional. @default `''`
+   * Required.
    */
-  description?: string;
+  description: string;
 }
 
 /**
@@ -92,7 +92,7 @@ export class SduiPage {
     this._sduiPageId = props.sduiPageId;
     this._name = props.name;
     this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
-    this._description = props.description ?? '';
+    this._description = props.description;
     scope._register(this);
   }
 
@@ -118,10 +118,8 @@ export class SduiPage {
       sduiPageId: requireStringComponentField(component, 'sdui_page_id', SduiPage.componentType),
       name: requireStringComponentField(component, 'name', SduiPage.componentType),
       function: resolveFunction(functionApiName),
+      description: optionalStringComponentField(component, 'description'),
     };
-    if (component['description'] !== undefined) {
-      props.description = component['description'];
-    }
     return new SduiPage(scope, props);
   }
 

package/src/lib/manifest.ts

@@ -0,0 +1 @@
+export * from './manifest/index';

package/src/lib/sdui.ts

@@ -0,0 +1,2 @@
+export * from './sdui/index';
+export { default } from './sdui/index';

package/src/resources/workers.ts

@@ -23,7 +23,7 @@ export class Workers extends APIResource {
    *
    * - Requires: `API Tier 1`
    * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,
-   *   `updated_at`
+   *   `updated_at`, `department_id`, `manager_id`
    * - Expandable fields: `user`, `manager`, `legal_entity`, `employment_type`,
    *   `compensation`, `department`, `teams`, `level`, `custom_fields`,
    *   `business_partners`

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.47'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.49'; // x-release-please-version

package/uploads.d.mts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.mjs

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.47";
+export declare const VERSION = "0.2.0-alpha.49";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.47";
+export declare const VERSION = "0.2.0-alpha.49";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.47'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.49'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.47'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.49'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

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

@@ -1,282 +0,0 @@
-/**
- * SDUI CRUD (Todo list) — mock data only; no Custom Objects / objectApiName.
- * Uses in-repo `@rippling/rippling-sdk/lib/sdui` (same pattern as manifest examples).
- *
- * Run:
- *   npx ts-node --transpile-only -r tsconfig-paths/register examples/sdui/sdui-crud-todo/sdui-crud-todo.ts
- */
-
-import SDUI from '@rippling/rippling-sdk/lib/sdui';
-
-const MOCK_TODOS = [
-  {
-    id: 't1',
-    _key: 't1',
-    title__c: 'Ship SDK patch',
-    status__c: 'In Progress',
-    priority__c: 'High',
-    notes__c: 'Regression pass on SDUI examples',
-  },
-  {
-    id: 't2',
-    _key: 't2',
-    title__c: 'Document Function paste flow',
-    status__c: 'To Do',
-    priority__c: 'Medium',
-    notes__c: 'Caps comment on rippling-function.ts',
-  },
-  {
-    id: 't3',
-    _key: 't3',
-    title__c: 'Weekly sync',
-    status__c: 'Done',
-    priority__c: 'Low',
-    notes__c: '',
-  },
-];
-
-function renderSpec(functionId: string) {
-  const s = SDUI.createState({
-    todos: MOCK_TODOS,
-    selectedRow: null as unknown,
-    showCreateModal: false,
-    showEditModal: false,
-    form: { title: '', status: '', priority: '', notes: '' },
-  });
-
-  const mainColumn = SDUI.components.VStack({
-    gap: 'space500',
-    children: [
-      SDUI.components.VStack({
-        gap: 'space300',
-        children: [
-          SDUI.components.HStack({
-            gap: 'space200',
-            align: 'center',
-            wrap: 'wrap',
-            children: [
-              SDUI.components.Heading({
-                level: 2,
-                text: 'Team todos',
-              }),
-              SDUI.components.Badge({
-                text: 'Demo data',
-                appearance: 'NEUTRAL',
-                size: 'S',
-              }),
-            ],
-          }),
-          SDUI.components.Text({
-            text: 'Create, edit, and delete call this Function; the grid below uses sample rows until you connect Custom Objects or your own API.',
-            typestyle: 'bodyMd',
-            color: 'secondary',
-            maxWidth: '720px',
-          }),
-        ],
-      }),
-      SDUI.components.Layout({
-        width: '100%',
-        children: [SDUI.components.Divider({})],
-      }),
-      SDUI.components.Grid({
-        data: s.todos,
-        columns: [
-          { id: 'title__c', header: 'Title', data: 'title__c' },
-          { id: 'status__c', header: 'Status', data: 'status__c', type: 'text' },
-          { id: 'priority__c', header: 'Priority', data: 'priority__c', type: 'text' },
-          { id: 'notes__c', header: 'Notes', data: 'notes__c' },
-        ],
-        selectedRow: s.selectedRow.$bind,
-        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),
-        ],
-        rowActions: [
-          { id: 'edit', label: 'Edit', icon: 'EDIT_OUTLINE', placement: 'menu' },
-          { id: 'delete', label: 'Delete', icon: 'TRASH_OUTLINE', placement: 'menu' },
-        ],
-        onRowAction: [
-          SDUI.actions.set(s.form, {
-            title: s.selectedRow['title__c'],
-            status: s.selectedRow['status__c'],
-            priority: s.selectedRow['priority__c'],
-            notes: s.selectedRow['notes__c'],
-          }),
-          SDUI.actions.set(s.showEditModal, true),
-        ],
-        onRowClick: [
-          SDUI.actions.set(s.form, {
-            title: s.selectedRow['title__c'],
-            status: s.selectedRow['status__c'],
-            priority: s.selectedRow['priority__c'],
-            notes: s.selectedRow['notes__c'],
-          }),
-          SDUI.actions.set(s.showEditModal, true),
-        ],
-      }),
-    ],
-  });
-
-  const root = SDUI.components.VStack({
-    align: 'center',
-    gap: 'space0',
-    children: [
-      SDUI.components.Layout({
-        maxWidth: '1080px',
-        width: '100%',
-        margin: { left: 'auto', right: 'auto' },
-        padding: { top: 32, bottom: 40, left: 24, right: 24 },
-        children: [mainColumn],
-      }),
-
-      SDUI.components.Modal({
-        title: 'New Todo',
-        isOpen: s.showCreateModal.$bind,
-        onClose: SDUI.actions.set(s.showCreateModal, false),
-        children: [
-          SDUI.components.VStack({
-            gap: 'space300',
-            children: [
-              SDUI.components.TextInput({
-                label: 'Title',
-                name: 'title',
-                value: s.form.title.$bind,
-                isRequired: true,
-              }),
-              SDUI.components.Select({
-                label: 'Status',
-                name: 'status',
-                value: s.form.status.$bind,
-                options: [
-                  { label: 'To Do', value: 'To Do' },
-                  { label: 'In Progress', value: 'In Progress' },
-                  { label: 'Done', value: 'Done' },
-                ],
-              }),
-              SDUI.components.Select({
-                label: 'Priority',
-                name: 'priority',
-                value: s.form.priority.$bind,
-                options: [
-                  { label: 'Low', value: 'Low' },
-                  { label: 'Medium', value: 'Medium' },
-                  { label: 'High', value: 'High' },
-                ],
-              }),
-              SDUI.components.Textarea({
-                label: 'Notes',
-                name: 'notes',
-                value: s.form.notes.$bind,
-              }),
-            ],
-          }),
-          SDUI.components.HStack({
-            gap: 'space200',
-            justify: 'flex-end',
-            children: [
-              SDUI.components.Button({
-                label: 'Cancel',
-                appearance: 'OUTLINE',
-                onPress: SDUI.actions.set(s.showCreateModal, false),
-              }),
-              SDUI.components.Button({
-                label: 'Create',
-                appearance: 'PRIMARY',
-                onPress: SDUI.actions.callFunction(functionId, 'create', {
-                  title: s.form.title,
-                  status: s.form.status,
-                  priority: s.form.priority,
-                  notes: s.form.notes,
-                  responsePath: '/todos',
-                  onSuccess: { set: { '/showCreateModal': false } },
-                }),
-              }),
-            ],
-          }),
-        ],
-      }),
-
-      SDUI.components.Modal({
-        title: 'Edit Todo',
-        isOpen: s.showEditModal.$bind,
-        onClose: SDUI.actions.set(s.showEditModal, false),
-        children: [
-          SDUI.components.VStack({
-            gap: 'space300',
-            children: [
-              SDUI.components.TextInput({
-                label: 'Title',
-                name: 'edit_title',
-                value: s.form.title.$bind,
-                isRequired: true,
-              }),
-              SDUI.components.Select({
-                label: 'Status',
-                name: 'edit_status',
-                value: s.form.status.$bind,
-                options: [
-                  { label: 'To Do', value: 'To Do' },
-                  { label: 'In Progress', value: 'In Progress' },
-                  { label: 'Done', value: 'Done' },
-                ],
-              }),
-              SDUI.components.Select({
-                label: 'Priority',
-                name: 'edit_priority',
-                value: s.form.priority.$bind,
-                options: [
-                  { label: 'Low', value: 'Low' },
-                  { label: 'Medium', value: 'Medium' },
-                  { label: 'High', value: 'High' },
-                ],
-              }),
-              SDUI.components.Textarea({
-                label: 'Notes',
-                name: 'edit_notes',
-                value: s.form.notes.$bind,
-              }),
-            ],
-          }),
-          SDUI.components.HStack({
-            gap: 'space200',
-            justify: 'flex-end',
-            children: [
-              SDUI.components.Button({
-                label: 'Delete',
-                appearance: 'DESTRUCTIVE',
-                onPress: SDUI.actions.callFunction(functionId, 'delete', {
-                  id: s.selectedRow['id'],
-                  responsePath: '/todos',
-                  onSuccess: { set: { '/showEditModal': false } },
-                }),
-              }),
-              SDUI.components.Button({
-                label: 'Cancel',
-                appearance: 'OUTLINE',
-                onPress: SDUI.actions.set(s.showEditModal, false),
-              }),
-              SDUI.components.Button({
-                label: 'Save',
-                appearance: 'PRIMARY',
-                onPress: SDUI.actions.callFunction(functionId, 'update', {
-                  id: s.selectedRow['id'],
-                  title: s.form.title,
-                  status: s.form.status,
-                  priority: s.form.priority,
-                  notes: s.form.notes,
-                  responsePath: '/todos',
-                  onSuccess: { set: { '/showEditModal': false } },
-                }),
-              }),
-            ],
-          }),
-        ],
-      }),
-    ],
-  });
-
-  return SDUI.render(s, root);
-}
-
-console.log(JSON.stringify(renderSpec('demo-fn'), null, 2));