@object-ui/types 0.5.0 → 2.0.0

package/src/workflow.ts

@@ -0,0 +1,409 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @object-ui/types - Workflow Schema
+ * 
+ * Defines workflow UI types for visual workflow design, approval processes,
+ * and workflow instance tracking.
+ */
+
+import type { BaseSchema } from './base';
+
+/**
+ * Workflow lifecycle status
+ */
+export type WorkflowStatus = 'draft' | 'active' | 'paused' | 'completed' | 'cancelled';
+
+/**
+ * Types of nodes available in the workflow designer
+ */
+export type WorkflowNodeType = 'start' | 'end' | 'task' | 'approval' | 'condition' | 'parallel' | 'delay' | 'notification' | 'script';
+
+/**
+ * Types of edges connecting workflow nodes
+ */
+export type WorkflowEdgeType = 'default' | 'conditional' | 'timeout';
+
+/**
+ * Action that can be performed on a workflow node
+ */
+export interface WorkflowNodeAction {
+  /**
+   * Action type
+   */
+  type: 'approve' | 'reject' | 'reassign' | 'comment' | 'escalate' | 'custom';
+
+  /**
+   * Display label for the action
+   */
+  label: string;
+
+  /**
+   * Target node to transition to after action
+   */
+  nextNodeId?: string;
+
+  /**
+   * Condition expression for action availability
+   */
+  condition?: string;
+}
+
+/**
+ * A node in the workflow graph
+ */
+export interface WorkflowNode {
+  /**
+   * Unique node identifier
+   */
+  id: string;
+
+  /**
+   * Node type
+   */
+  type: WorkflowNodeType;
+
+  /**
+   * Display label
+   */
+  label: string;
+
+  /**
+   * Node description
+   */
+  description?: string;
+
+  /**
+   * Position in the workflow canvas
+   */
+  position?: { x: number; y: number };
+
+  /**
+   * Node-specific configuration
+   */
+  config?: Record<string, any>;
+
+  /**
+   * Assignee identifier
+   */
+  assignee?: string;
+
+  /**
+   * How the assignee is resolved
+   */
+  assigneeType?: 'user' | 'role' | 'group' | 'expression';
+
+  /**
+   * Timeout duration in minutes
+   */
+  timeout?: number;
+
+  /**
+   * Available actions for this node
+   */
+  actions?: WorkflowNodeAction[];
+}
+
+/**
+ * An edge connecting two workflow nodes
+ */
+export interface WorkflowEdge {
+  /**
+   * Unique edge identifier
+   */
+  id: string;
+
+  /**
+   * Source node identifier
+   */
+  source: string;
+
+  /**
+   * Target node identifier
+   */
+  target: string;
+
+  /**
+   * Edge type
+   */
+  type?: WorkflowEdgeType;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Condition expression for conditional edges
+   */
+  condition?: string;
+}
+
+/**
+ * Rule governing how approvals are processed
+ */
+export interface ApprovalRule {
+  /**
+   * Approval strategy type
+   */
+  type: 'any' | 'all' | 'majority' | 'sequential';
+
+  /**
+   * Minimum number of approvals required
+   */
+  minApprovals?: number;
+
+  /**
+   * Timeout duration in minutes
+   */
+  timeout?: number;
+
+  /**
+   * Identifier to escalate to on timeout
+   */
+  escalateTo?: string;
+
+  /**
+   * Expression that triggers automatic approval
+   */
+  autoApproveCondition?: string;
+}
+
+/**
+ * Variable definition for workflow context
+ */
+export interface WorkflowVariable {
+  /**
+   * Variable name
+   */
+  name: string;
+
+  /**
+   * Variable data type
+   */
+  type: 'string' | 'number' | 'boolean' | 'date' | 'object';
+
+  /**
+   * Default value
+   */
+  defaultValue?: any;
+
+  /**
+   * Whether the variable is required
+   */
+  required?: boolean;
+}
+
+/**
+ * Workflow Schema - Main workflow definition
+ */
+export interface WorkflowSchema extends BaseSchema {
+  type: 'workflow';
+
+  /**
+   * Workflow title
+   */
+  title?: string;
+
+  /**
+   * Workflow description
+   */
+  description?: string;
+
+  /**
+   * Current workflow status
+   */
+  status?: WorkflowStatus;
+
+  /**
+   * Workflow nodes
+   */
+  nodes: WorkflowNode[];
+
+  /**
+   * Workflow edges
+   */
+  edges: WorkflowEdge[];
+
+  /**
+   * Workflow variables
+   */
+  variables?: WorkflowVariable[];
+
+  /**
+   * Workflow version number
+   */
+  version?: number;
+}
+
+/**
+ * Workflow Designer Schema - Visual workflow editor component
+ */
+export interface WorkflowDesignerSchema extends BaseSchema {
+  type: 'workflow-designer';
+
+  /**
+   * Workflow to edit
+   */
+  workflow?: WorkflowSchema;
+
+  /**
+   * Whether the designer is in read-only mode
+   */
+  readOnly?: boolean;
+
+  /**
+   * Show minimap navigation panel
+   */
+  showMinimap?: boolean;
+
+  /**
+   * Show designer toolbar
+   */
+  showToolbar?: boolean;
+
+  /**
+   * Save callback action
+   */
+  onSave?: string;
+
+  /**
+   * Publish callback action
+   */
+  onPublish?: string;
+}
+
+/**
+ * A single entry in the approval history
+ */
+export interface ApprovalHistoryItem {
+  /**
+   * Node where the action was taken
+   */
+  nodeId: string;
+
+  /**
+   * Action that was performed
+   */
+  action: string;
+
+  /**
+   * Actor identifier
+   */
+  actor: string;
+
+  /**
+   * Display name of the actor
+   */
+  actorName?: string;
+
+  /**
+   * ISO 8601 timestamp of the action
+   */
+  timestamp: string;
+
+  /**
+   * Optional comment
+   */
+  comment?: string;
+}
+
+/**
+ * Approval Process Schema - Approval workflow UI component
+ */
+export interface ApprovalProcessSchema extends BaseSchema {
+  type: 'approval-process';
+
+  /**
+   * Associated workflow identifier
+   */
+  workflowId?: string;
+
+  /**
+   * Workflow instance identifier
+   */
+  instanceId?: string;
+
+  /**
+   * Current active node identifier
+   */
+  currentNodeId?: string;
+
+  /**
+   * Approval rule configuration
+   */
+  approvalRule?: ApprovalRule;
+
+  /**
+   * Approval history entries
+   */
+  history?: ApprovalHistoryItem[];
+
+  /**
+   * Approval process data
+   */
+  data?: Record<string, any>;
+
+  /**
+   * Show approval history timeline
+   */
+  showHistory?: boolean;
+
+  /**
+   * Show comments section
+   */
+  showComments?: boolean;
+}
+
+/**
+ * Workflow Instance Schema - Runtime state of a workflow execution
+ */
+export interface WorkflowInstanceSchema extends BaseSchema {
+  type: 'workflow-instance';
+
+  /**
+   * Associated workflow definition identifier
+   */
+  workflowId: string;
+
+  /**
+   * Unique instance identifier
+   */
+  instanceId: string;
+
+  /**
+   * Current instance status
+   */
+  status: WorkflowStatus;
+
+  /**
+   * Currently active node identifiers
+   */
+  currentNodes: string[];
+
+  /**
+   * Runtime variable values
+   */
+  variables?: Record<string, any>;
+
+  /**
+   * ISO 8601 timestamp when the instance started
+   */
+  startedAt?: string;
+
+  /**
+   * ISO 8601 timestamp when the instance completed
+   */
+  completedAt?: string;
+
+  /**
+   * Instance data payload
+   */
+  data?: Record<string, any>;
+}

package/src/zod/index.zod.ts

@@ -78,6 +78,10 @@ export {
   ResizablePanelSchema,
   ResizableSchema,
   AspectRatioSchema,
+  PageRegionWidthSchema,
+  PageRegionSchema,
+  PageVariableSchema,
+  PageTypeSchema,
   PageSchema,
   LayoutSchema,
 } from './layout.zod.js';
@@ -273,14 +277,21 @@ export {
 export {
   ColorPaletteSchema,
   TypographySchema,
+  SpacingSchema,
   SpacingScaleSchema,
   BorderRadiusSchema,
+  ShadowSchema,
+  BreakpointsSchema,
+  AnimationSchema,
+  ZIndexSchema,
+  ThemeLogoSchema,
   ThemeModeSchema,
   ThemeDefinitionSchema,
   ThemeSchema,
+  ThemeComponentSchema,
+  ThemeUnionSchema,
   ThemeSwitcherSchema,
   ThemePreviewSchema,
-  ThemeComponentSchema,
 } from './theme.zod.js';
 
 export {
@@ -340,7 +351,7 @@ import { NavigationSchema } from './navigation.zod.js';
 import { ComplexSchema } from './complex.zod.js';
 import { ObjectQLComponentSchema } from './objectql.zod.js';
 import { CRUDComponentSchema } from './crud.zod.js';
-import { ThemeComponentSchema } from './theme.zod.js';
+import { ThemeUnionSchema } from './theme.zod.js';
 import { ReportComponentSchema } from './reports.zod.js';
 import { BlockComponentSchema } from './blocks.zod.js';
 import { ViewComponentSchema } from './views.zod.js';
@@ -361,7 +372,7 @@ export const AnyComponentSchema = z.union([
   ComplexSchema,
   ObjectQLComponentSchema,
   CRUDComponentSchema,
-  ThemeComponentSchema,
+  ThemeUnionSchema,
   ReportComponentSchema,
   BlockComponentSchema,
   ViewComponentSchema,

package/src/zod/layout.zod.ts

@@ -227,16 +227,54 @@ export const AspectRatioSchema = BaseSchema.extend({
   children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Child components'),
 });
 
+/**
+ * Page Region Width Schema
+ */
+export const PageRegionWidthSchema = z.enum(['small', 'medium', 'large', 'full']);
+
+/**
+ * Page Region Schema
+ */
+export const PageRegionSchema = z.object({
+  name: z.string().describe('Region name (e.g. "sidebar", "main", "header")'),
+  type: z.enum(['header', 'sidebar', 'main', 'footer', 'aside']).optional().describe('Semantic region type'),
+  width: z.union([PageRegionWidthSchema, z.string()]).optional().describe('Region width'),
+  components: z.array(SchemaNodeSchema).describe('Components in this region'),
+  className: z.string().optional().describe('CSS class overrides'),
+});
+
+/**
+ * Page Variable Schema
+ */
+export const PageVariableSchema = z.object({
+  name: z.string().describe('Variable name'),
+  type: z.enum(['string', 'number', 'boolean', 'object', 'array']).optional().default('string').describe('Variable type'),
+  defaultValue: z.any().optional().describe('Default value'),
+});
+
+/**
+ * Page Type Schema
+ */
+export const PageTypeSchema = z.enum(['record', 'home', 'app', 'utility']);
+
 /**
  * Page Schema - Top-level page layout
+ * Aligned with @objectstack/spec PageSchema
  */
 export const PageSchema = BaseSchema.extend({
   type: z.literal('page'),
   title: z.string().optional().describe('Page title'),
   icon: z.string().optional().describe('Page icon (Lucide icon name)'),
   description: z.string().optional().describe('Page description'),
+  pageType: PageTypeSchema.optional().describe('Page type (record, home, app, utility)'),
+  object: z.string().optional().describe('Bound object name (for record pages)'),
+  template: z.string().optional().default('default').describe('Layout template name'),
+  variables: z.array(PageVariableSchema).optional().describe('Local page state variables'),
+  regions: z.array(PageRegionSchema).optional().describe('Page layout regions'),
   body: z.array(SchemaNodeSchema).optional().describe('Main content array'),
   children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Alternative content prop'),
+  isDefault: z.boolean().optional().default(false).describe('Whether this is the default page'),
+  assignedProfiles: z.array(z.string()).optional().describe('Profiles that can access this page'),
 });
 
 /**

package/src/zod/objectql.zod.ts

@@ -21,11 +21,13 @@ import { BaseSchema } from './base.zod.js';
 
 /**
  * HTTP Method Schema
+ * Mirrors @objectstack/spec/ui HttpMethodSchema.
  */
 export const HttpMethodSchema = z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']);
 
 /**
  * HTTP Request Schema
+ * Mirrors @objectstack/spec/ui HttpRequestSchema.
  */
 export const HttpRequestSchema = z.object({
   url: z.string().describe('API endpoint URL'),
@@ -37,6 +39,7 @@ export const HttpRequestSchema = z.object({
 
 /**
  * View Data Source Schema
+ * Mirrors @objectstack/spec/ui ViewDataSchema.
  */
 export const ViewDataSchema = z.union([
   z.object({
@@ -56,6 +59,7 @@ export const ViewDataSchema = z.union([
 
 /**
  * List Column Schema
+ * Mirrors @objectstack/spec/ui ListColumnSchema.
  */
 export const ListColumnSchema = z.object({
   field: z.string().describe('Field name'),
@@ -67,10 +71,13 @@ export const ListColumnSchema = z.object({
   resizable: z.boolean().optional().describe('Allow resizing'),
   wrap: z.boolean().optional().describe('Allow text wrapping'),
   type: z.string().optional().describe('Renderer type override'),
+  link: z.boolean().optional().describe('Functions as the primary navigation link (triggers View navigation)'),
+  action: z.string().optional().describe('Registered Action ID to execute when clicked'),
 });
 
 /**
  * Selection Config Schema
+ * Mirrors @objectstack/spec/ui SelectionConfigSchema.
  */
 export const SelectionConfigSchema = z.object({
   type: z.enum(['none', 'single', 'multiple']).optional().describe('Selection mode'),
@@ -78,6 +85,7 @@ export const SelectionConfigSchema = z.object({
 
 /**
  * Pagination Config Schema
+ * Mirrors @objectstack/spec/ui PaginationConfigSchema.
  */
 export const PaginationConfigSchema = z.object({
   pageSize: z.number().optional().describe('Page size'),