@object-ui/types 0.3.1 → 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/app.zod.ts

@@ -0,0 +1,72 @@
+/**
+ * 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/zod - Application Schema Zod Validators
+ * 
+ * Zod validation schemas for top-level application configuration.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/app
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema } from './base.zod.js';
+
+/**
+ * Menu Item Schema - Navigation menu item
+ */
+export const MenuItemSchema: z.ZodType<any> = z.lazy(() => z.object({
+  type: z.enum(['item', 'group', 'separator']).optional().describe('Item type'),
+  label: z.string().optional().describe('Display label'),
+  icon: z.string().optional().describe('Icon name (Lucide)'),
+  path: z.string().optional().describe('Target path (route)'),
+  href: z.string().optional().describe('External link'),
+  children: z.array(MenuItemSchema).optional().describe('Child items (submenu)'),
+  badge: z.union([z.string(), z.number()]).optional().describe('Badge or count'),
+  hidden: z.union([z.boolean(), z.string()]).optional().describe('Visibility condition'),
+}));
+
+/**
+ * App Action Schema - Application header/toolbar action
+ */
+export const AppActionSchema = z.object({
+  type: z.enum(['button', 'dropdown', 'user']).describe('Action type'),
+  label: z.string().optional().describe('Action label'),
+  icon: z.string().optional().describe('Icon name'),
+  onClick: z.string().optional().describe('Click handler expression'),
+  avatar: z.string().optional().describe('User avatar URL (for type="user")'),
+  description: z.string().optional().describe('Additional description (e.g., email for user)'),
+  items: z.array(MenuItemSchema).optional().describe('Dropdown menu items (for type="dropdown" or "user")'),
+  shortcut: z.string().optional().describe('Keyboard shortcut'),
+  variant: z.enum(['default', 'destructive', 'outline', 'secondary', 'ghost', 'link']).optional().describe('Button variant'),
+  size: z.enum(['default', 'sm', 'lg', 'icon']).optional().describe('Button size'),
+});
+
+/**
+ * App Schema - Top-level application configuration
+ */
+export const AppSchema = BaseSchema.extend({
+  type: z.literal('app'),
+  name: z.string().optional().describe('Application name (system ID)'),
+  title: z.string().optional().describe('Display title'),
+  description: z.string().optional().describe('Application description'),
+  logo: z.string().optional().describe('Logo URL or icon name'),
+  favicon: z.string().optional().describe('Favicon URL'),
+  layout: z.enum(['sidebar', 'header', 'empty']).optional().default('sidebar').describe('Global layout strategy'),
+  menu: z.array(MenuItemSchema).optional().describe('Global navigation menu'),
+  actions: z.array(AppActionSchema).optional().describe('Global actions (user profile, settings, etc.)'),
+});
+
+/**
+ * Export type inference helpers
+ */
+export type MenuItemSchemaType = z.infer<typeof MenuItemSchema>;
+export type AppActionSchemaType = z.infer<typeof AppActionSchema>;
+export type AppSchemaType = z.infer<typeof AppSchema>;

package/src/zod/blocks.zod.ts

@@ -0,0 +1,170 @@
+/**
+ * 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/zod - Block Schema Zod Validators
+ * 
+ * Zod validation schemas for reusable component blocks.
+ * Following @objectstack/spec UI specification format.
+ * 
+ * @module zod/blocks
+ * @packageDocumentation
+ */
+
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
+
+/**
+ * Block Variable Schema
+ */
+export const BlockVariableSchema = z.object({
+  name: z.string().describe('Variable name'),
+  label: z.string().optional().describe('Display label'),
+  type: z.enum(['string', 'number', 'boolean', 'object', 'array', 'component']).optional().describe('Variable type'),
+  defaultValue: z.any().optional().describe('Default value'),
+  description: z.string().optional().describe('Description/help text'),
+  required: z.boolean().optional().describe('Whether this variable is required'),
+  validation: z.any().optional().describe('Validation rules'),
+  enum: z.array(z.any()).optional().describe('Enum options (for string/number types)'),
+});
+
+/**
+ * Block Slot Schema
+ */
+export const BlockSlotSchema = z.object({
+  name: z.string().describe('Slot name'),
+  label: z.string().optional().describe('Display label'),
+  description: z.string().optional().describe('Description'),
+  defaultContent: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Default content'),
+  allowedTypes: z.array(z.string()).optional().describe('Allowed component types'),
+  maxChildren: z.number().optional().describe('Maximum number of children'),
+  required: z.boolean().optional().describe('Whether this slot is required'),
+});
+
+/**
+ * Block Metadata Schema
+ */
+export const BlockMetadataSchema = z.object({
+  name: z.string().describe('Block name/identifier'),
+  label: z.string().optional().describe('Display label'),
+  description: z.string().optional().describe('Block description'),
+  category: z.string().optional().describe('Block category'),
+  icon: z.string().optional().describe('Block icon'),
+  tags: z.array(z.string()).optional().describe('Block tags for search'),
+  author: z.string().optional().describe('Author/creator'),
+  version: z.string().optional().describe('Version'),
+  license: z.string().optional().describe('License'),
+  repository: z.string().optional().describe('Repository URL'),
+  preview: z.string().optional().describe('Preview image URL'),
+  premium: z.boolean().optional().describe('Is this a premium/paid block'),
+});
+
+/**
+ * Block Schema
+ */
+export const BlockSchema = BaseSchema.extend({
+  type: z.literal('block'),
+  meta: BlockMetadataSchema.optional().describe('Block metadata'),
+  variables: z.array(BlockVariableSchema).optional().describe('Block variables/props'),
+  slots: z.array(BlockSlotSchema).optional().describe('Block slots for content injection'),
+  template: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Block template (component tree)'),
+  values: z.record(z.string(), z.any()).optional().describe('Variable values (when using a block)'),
+  slotContent: z.record(z.string(), z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)])).optional().describe('Slot content (when using a block)'),
+  blockRef: z.string().optional().describe('Block reference (for reusing saved blocks)'),
+  editable: z.boolean().optional().describe('Enable edit mode'),
+});
+
+/**
+ * Block Library Item Schema
+ */
+export const BlockLibraryItemSchema = z.object({
+  id: z.string().describe('Unique identifier'),
+  meta: BlockMetadataSchema.describe('Block metadata'),
+  schema: BlockSchema.describe('Block schema'),
+  installs: z.number().optional().describe('Installation count'),
+  rating: z.number().optional().describe('Rating (1-5)'),
+  ratingCount: z.number().optional().describe('Number of ratings'),
+  updatedAt: z.string().optional().describe('Last updated timestamp'),
+  createdAt: z.string().optional().describe('Created timestamp'),
+});
+
+/**
+ * Block Library Schema
+ */
+export const BlockLibrarySchema = BaseSchema.extend({
+  type: z.literal('block-library'),
+  apiEndpoint: z.string().optional().describe('Library API endpoint'),
+  category: z.string().optional().describe('Filter by category'),
+  searchQuery: z.string().optional().describe('Search query'),
+  tags: z.array(z.string()).optional().describe('Filter by tags'),
+  showPremium: z.boolean().optional().describe('Show premium blocks'),
+  blocks: z.array(BlockLibraryItemSchema).optional().describe('Blocks to display'),
+  loading: z.boolean().optional().describe('Loading state'),
+  onInstall: z.string().optional().describe('Install callback'),
+  onPreview: z.string().optional().describe('Preview callback'),
+});
+
+/**
+ * Block Editor Schema
+ */
+export const BlockEditorSchema = BaseSchema.extend({
+  type: z.literal('block-editor'),
+  block: BlockSchema.optional().describe('Block being edited'),
+  showVariables: z.boolean().optional().describe('Show variable editor'),
+  showSlots: z.boolean().optional().describe('Show slot editor'),
+  showTemplate: z.boolean().optional().describe('Show template editor'),
+  showPreview: z.boolean().optional().describe('Show preview'),
+  onSave: z.string().optional().describe('Save callback'),
+  onCancel: z.string().optional().describe('Cancel callback'),
+});
+
+/**
+ * Block Instance Schema
+ */
+export const BlockInstanceSchema = BaseSchema.extend({
+  type: z.literal('block-instance'),
+  blockId: z.string().describe('Block reference ID'),
+  blockName: z.string().optional().describe('Block name (for local blocks)'),
+  values: z.record(z.string(), z.any()).optional().describe('Variable values'),
+  slotContent: z.record(z.string(), z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)])).optional().describe('Slot content'),
+  overrideStyles: z.boolean().optional().describe('Override styles'),
+});
+
+/**
+ * Component Schema
+ */
+export const ComponentSchema = BaseSchema.extend({
+  type: z.literal('component'),
+  componentName: z.string().optional().describe('Component name/identifier'),
+  props: z.record(z.string(), z.any()).optional().describe('Component props'),
+  children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Component children'),
+});
+
+/**
+ * Union of all block schemas
+ */
+export const BlockComponentSchema = z.union([
+  BlockSchema,
+  BlockLibrarySchema,
+  BlockEditorSchema,
+  BlockInstanceSchema,
+  ComponentSchema,
+]);
+
+/**
+ * Export type inference helpers
+ */
+export type BlockVariableSchemaType = z.infer<typeof BlockVariableSchema>;
+export type BlockSlotSchemaType = z.infer<typeof BlockSlotSchema>;
+export type BlockMetadataSchemaType = z.infer<typeof BlockMetadataSchema>;
+export type BlockSchemaType = z.infer<typeof BlockSchema>;
+export type BlockLibraryItemSchemaType = z.infer<typeof BlockLibraryItemSchema>;
+export type BlockLibrarySchemaType = z.infer<typeof BlockLibrarySchema>;
+export type BlockEditorSchemaType = z.infer<typeof BlockEditorSchema>;
+export type BlockInstanceSchemaType = z.infer<typeof BlockInstanceSchema>;
+export type ComponentSchemaType = z.infer<typeof ComponentSchema>;

package/src/zod/complex.zod.ts

@@ -17,7 +17,7 @@
  */
 
 import { z } from 'zod';
-import { BaseSchema, SchemaNodeSchema } from './base.zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod.js';
 
 /**
  * Kanban Card Schema