@rippling/rippling-sdk 0.2.0-alpha.84 → 0.2.0-alpha.86

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

@@ -1,256 +0,0 @@
-/**
- * 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/schema.ts

@@ -1,60 +0,0 @@
-/**
- * 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/todo-app-without-object-list-view/schema.ts

@@ -1,28 +0,0 @@
-/**
- * Typed custom-object schema for the custom SDUI todo example.
- */
-
-import { boolean, defineCustomObject, section } from '@rippling/rippling-sdk/core/platform/custom-objects';
-
-/** Logical category shared by the custom SDUI todo example. */
-export const CUSTOM_TODO_CATEGORY = 'custom_todo_app';
-
-/** Typed schema used by the custom SDUI todo manifest and function code. */
-export const todoDefinition = defineCustomObject({
-  name: 'todo',
-  displayName: 'Todo',
-  pluralLabel: 'Todos',
-  category: CUSTOM_TODO_CATEGORY,
-  description: 'A todo item rendered by a custom SDUI page.',
-  icon: { emoji: '✅' },
-  sections: {
-    details: section('Details', { sectionId: 'sec_custom_todo_details' }),
-  },
-  fields: {
-    completed: boolean({
-      displayName: 'Completed',
-      description: 'Whether the todo item is complete',
-      section: 'details',
-    }),
-  },
-});

package/src/core/platform/README.md

@@ -1,20 +0,0 @@
-# `core/platform`
-
-This directory holds public, higher-level platform abstractions that sit above the generated REST resources and above low-level manifest classes.
-
-Use this layer for SDK capabilities that are:
-
-- public and stable enough to be imported by SDK consumers
-- opinionated or cross-cutting rather than raw transport wrappers
-- centered on platform concepts such as custom objects, typed schemas, lifecycle helpers, record managers, or query helpers
-
-In practice, the layering is:
-
-- `src/resources/*` — generated REST resources and DTOs
-- `src/lib/manifest/*` — low-level manifest authoring classes
-- `src/core/platform/*` — higher-level typed/platform abstractions built on top of those surfaces
-
-Current structure:
-
-- `custom-objects/` — typed custom-object domain model, validation, provisioning, lifecycle, records, and RQL helpers
-- `manifest/` — typed adapters that materialize platform-domain definitions into low-level manifest authoring surfaces

package/src/core/platform/manifest/README.md

@@ -1,26 +0,0 @@
-# `core/platform/manifest`
-
-This directory holds public manifest-integration adapters for higher-level platform abstractions.
-
-Use this layer when code is primarily about translating typed platform/domain definitions into low-level `lib/manifest` classes rather than defining the domain model itself.
-
-Rule of thumb:
-
-- if code owns schema semantics, validation, provisioning, lifecycle, records, or query typing, it belongs in `core/platform/<domain>/`
-- if code primarily produces `lib/manifest` components or manifest-specific typed authoring helpers, it belongs in `core/platform/manifest/<domain>/`
-
-For example:
-
-- `core/platform/custom-objects/*` owns typed custom-object schema and runtime helpers
-- `core/platform/manifest/custom-objects/*` owns manifest registration, typed conditions, typed validations/rules/workflows, typed list-view helpers, typed page-layout helpers, function wiring helpers, and manifest field-resolution helpers for those custom-object definitions
-
-Current author-facing golden paths in this manifest layer:
-
-The custom-object review path should read top-down: registration/conditions/rules/workflows/actions/existing-manifest rebinding first, then the SDUI helper family as an additive UI-specific lane.
-
-- use `defineTypedWorkflowFromFunctionFile(...)` when one workflow owns one colocated function file and you want the handler loaded from disk plus wired into the workflow in one step
-- use `defineTypedCustomObjectActionFromFunctionFile(...)` when one custom-object action owns one colocated function file and you want the action plus `ManifestFunction` created together
-- use `bindExistingManifestCustomObject(...)` when extending an existing manifest through the typed custom-object lane instead of manually loading raw object, field, section, layout, and action classes
-- treat raw `lib/manifest` field/section construction as the explicit escape hatch when an existing-manifest mutation needs to create brand-new manifest components that do not yet have a dedicated typed helper
-- use `defineTypedRule(..., { actions: (rules) => [...] })` as the default rule-authoring path, and keep `createTypedRuleHelpers(...)` as the more explicit escape hatch when a caller wants to reuse one helper namespace across multiple rules
-- use `createManifestConditionHelpers(...)` callback inputs for typed conditions, prefer `c.where('field_name').eq(...)` plus `c.all(...)` / `c.any(...)` / `c.none(...)` for the higher-order condition path, use `typedCondition(...)` when a bounded parsed-string condition is clearer, and keep `c.raw(...)` as the explicit escape hatch for unsupported condition snippets

package/src/core/platform/manifest/custom-objects/action.ts

@@ -1,87 +0,0 @@
-import {
-  CustomObjectAction,
-  type CustomObjectActionProps,
-  type ManifestFunction,
-} from '../../../../lib/manifest';
-import type { ManifestScope } from '../../../../lib/manifest/manifest-builder';
-import type { AnyCustomObjectDefinition } from '../../custom-objects/types';
-import { defineManifestFunctionFromFile, type ManifestFunctionFromFileProps } from './function-file';
-import type { ManifestRegistration } from './types';
-
-/**
- * Initialization properties for {@link defineTypedCustomObjectAction}.
- *
- * @typeParam TDefinition - Typed custom-object definition whose object action is being authored.
- */
-export interface TypedCustomObjectActionProps<TDefinition extends AnyCustomObjectDefinition>
-  extends Omit<CustomObjectActionProps, 'function'> {
-  /** Existing manifest function invoked by this action. */
-  readonly function: ManifestFunction;
-  /** Phantom type anchor that keeps the props definition-scoped in editor hover/help. */
-  readonly __typedActionDefinition__?: TDefinition;
-}
-
-/**
- * Initialization properties for {@link defineTypedCustomObjectActionFromFunctionFile}.
- *
- * @typeParam TDefinition - Typed custom-object definition whose object action is being authored.
- */
-export interface TypedCustomObjectActionFromFunctionFileProps<TDefinition extends AnyCustomObjectDefinition>
-  extends Omit<TypedCustomObjectActionProps<TDefinition>, 'function'> {
-  /** Function metadata and source-file location for the action handler. */
-  readonly function: ManifestFunctionFromFileProps;
-}
-
-/** Result returned by {@link defineTypedCustomObjectActionFromFunctionFile}. */
-export interface TypedCustomObjectActionFromFunctionFileResult {
-  /** Manifest function created from the provided source file. */
-  readonly function: ManifestFunction;
-  /** Custom-object action wired to the created manifest function. */
-  readonly action: CustomObjectAction;
-}
-
-/**
- * Defines one custom-object action for a typed manifest registration.
- *
- * Prefer {@link defineTypedCustomObjectActionFromFunctionFile} for the common
- * colocated-handler path. Use this lower-level form when the backing manifest
- * function already exists separately and you only need to wire the action.
- *
- * @param registration - Manifest registration produced from the typed object definition.
- * @param props - Action metadata plus the backing manifest function.
- * @returns Low-level custom-object action manifest instance.
- * @typeParam TDefinition - Typed custom-object definition whose action is being authored.
- */
-export function defineTypedCustomObjectAction<TDefinition extends AnyCustomObjectDefinition>(
-  registration: ManifestRegistration<TDefinition>,
-  props: TypedCustomObjectActionProps<TDefinition>,
-): CustomObjectAction {
-  return new CustomObjectAction(registration.object, props);
-}
-
-/**
- * Defines one custom-object action and its backing manifest function from a source file.
- *
- * This is the intended golden path when one custom-object action owns one
- * colocated handler file.
- *
- * @param registration - Manifest registration produced from the typed object definition.
- * @param props - Action metadata plus the function source-file location.
- * @returns Created manifest function plus the action wired to it.
- * @typeParam TDefinition - Typed custom-object definition whose action is being authored.
- */
-export function defineTypedCustomObjectActionFromFunctionFile<TDefinition extends AnyCustomObjectDefinition>(
-  scope: ManifestScope,
-  registration: ManifestRegistration<TDefinition>,
-  props: TypedCustomObjectActionFromFunctionFileProps<TDefinition>,
-): TypedCustomObjectActionFromFunctionFileResult {
-  const { function: functionProps, ...actionProps } = props;
-  const createdFunction = defineManifestFunctionFromFile(scope, functionProps);
-  return {
-    function: createdFunction,
-    action: defineTypedCustomObjectAction(registration, {
-      ...actionProps,
-      function: createdFunction,
-    }),
-  };
-}