@object-ui/types 0.5.0 → 3.0.0

package/src/ai.ts

@@ -0,0 +1,454 @@
+/**
+ * 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 - AI Schema
+ *
+ * Defines AI-related UI component schemas for intelligent form assistance,
+ * recommendations, natural language queries, and data insights.
+ */
+
+import type { BaseSchema } from './base';
+
+/**
+ * AI Provider Type
+ */
+export type AIProvider = 'openai' | 'anthropic' | 'google' | 'azure' | 'custom';
+
+/**
+ * AI Model Type
+ */
+export type AIModelType = 'gpt-4' | 'gpt-3.5-turbo' | 'claude-3' | 'gemini-pro' | 'custom';
+
+/**
+ * AI Configuration
+ */
+export interface AIConfig {
+  /**
+   * AI provider to use
+   */
+  provider?: AIProvider;
+
+  /**
+   * Model identifier
+   */
+  model?: AIModelType | string;
+
+  /**
+   * Custom API endpoint URL
+   */
+  apiEndpoint?: string;
+
+  /**
+   * Sampling temperature (0-1)
+   */
+  temperature?: number;
+
+  /**
+   * Maximum tokens for response
+   */
+  maxTokens?: number;
+
+  /**
+   * System prompt for the AI model
+   */
+  systemPrompt?: string;
+}
+
+/**
+ * AI Field Suggestion
+ */
+export interface AIFieldSuggestion {
+  /**
+   * Name of the field being suggested
+   */
+  fieldName: string;
+
+  /**
+   * Suggested value for the field
+   */
+  value: any;
+
+  /**
+   * Confidence score (0-1)
+   */
+  confidence: number;
+
+  /**
+   * Explanation for the suggestion
+   */
+  reasoning?: string;
+}
+
+/**
+ * AI Form Assist Schema - Intelligent form field suggestions
+ */
+export interface AIFormAssistSchema extends BaseSchema {
+  type: 'ai-form-assist';
+
+  /**
+   * Target form identifier
+   */
+  formId?: string;
+
+  /**
+   * Object name for context
+   */
+  objectName?: string;
+
+  /**
+   * Fields to provide suggestions for
+   */
+  fields?: string[];
+
+  /**
+   * Additional context for generating suggestions
+   */
+  context?: Record<string, any>;
+
+  /**
+   * AI configuration
+   */
+  config?: AIConfig;
+
+  /**
+   * Current suggestions
+   */
+  suggestions?: AIFieldSuggestion[];
+
+  /**
+   * Automatically fill fields with suggestions
+   */
+  autoFill?: boolean;
+
+  /**
+   * Show confidence scores for suggestions
+   */
+  showConfidence?: boolean;
+
+  /**
+   * Show reasoning for suggestions
+   */
+  showReasoning?: boolean;
+
+  /**
+   * Callback when a suggestion is applied
+   */
+  onApplySuggestion?: string;
+
+  /**
+   * Callback when a suggestion is rejected
+   */
+  onRejectSuggestion?: string;
+}
+
+/**
+ * AI Recommendation Item
+ */
+export interface AIRecommendationItem {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Recommendation title
+   */
+  title: string;
+
+  /**
+   * Recommendation description
+   */
+  description?: string;
+
+  /**
+   * Relevance score (0-1)
+   */
+  score: number;
+
+  /**
+   * Recommendation category
+   */
+  category?: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: Record<string, any>;
+
+  /**
+   * Action to perform when selected
+   */
+  action?: {
+    /**
+     * Action type
+     */
+    type: string;
+
+    /**
+     * Action target
+     */
+    target?: string;
+  };
+}
+
+/**
+ * AI Recommendations Schema - Intelligent content recommendations
+ */
+export interface AIRecommendationsSchema extends BaseSchema {
+  type: 'ai-recommendations';
+
+  /**
+   * Object name for context
+   */
+  objectName?: string;
+
+  /**
+   * Additional context for generating recommendations
+   */
+  context?: Record<string, any>;
+
+  /**
+   * AI configuration
+   */
+  config?: AIConfig;
+
+  /**
+   * Current recommendations
+   */
+  recommendations?: AIRecommendationItem[];
+
+  /**
+   * Maximum number of results to display
+   */
+  maxResults?: number;
+
+  /**
+   * Show relevance scores
+   */
+  showScores?: boolean;
+
+  /**
+   * Display layout
+   */
+  layout?: 'list' | 'grid' | 'carousel';
+
+  /**
+   * Callback when a recommendation is selected
+   */
+  onSelect?: string;
+
+  /**
+   * Callback when a recommendation is dismissed
+   */
+  onDismiss?: string;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Message to display when no recommendations are available
+   */
+  emptyMessage?: string;
+}
+
+/**
+ * Natural Language Query Result
+ */
+export interface NLQueryResult {
+  /**
+   * Original query string
+   */
+  query: string;
+
+  /**
+   * Parsed query representation
+   */
+  parsedQuery?: Record<string, any>;
+
+  /**
+   * Result data
+   */
+  data?: any[];
+
+  /**
+   * Column definitions for the result data
+   */
+  columns?: Array<{
+    /**
+     * Column name
+     */
+    name: string;
+
+    /**
+     * Display label
+     */
+    label?: string;
+
+    /**
+     * Column data type
+     */
+    type?: string;
+  }>;
+
+  /**
+   * AI-generated summary of the results
+   */
+  summary?: string;
+
+  /**
+   * Confidence score for the query interpretation (0-1)
+   */
+  confidence?: number;
+}
+
+/**
+ * Natural Language Query Schema - Query data using natural language
+ */
+export interface NLQuerySchema extends BaseSchema {
+  type: 'nl-query';
+
+  /**
+   * Object name for context
+   */
+  objectName?: string;
+
+  /**
+   * Input placeholder text
+   */
+  placeholder?: string;
+
+  /**
+   * AI configuration
+   */
+  config?: AIConfig;
+
+  /**
+   * Current query result
+   */
+  result?: NLQueryResult;
+
+  /**
+   * Example queries to suggest
+   */
+  suggestions?: string[];
+
+  /**
+   * Show query history
+   */
+  showHistory?: boolean;
+
+  /**
+   * Query history entries
+   */
+  history?: Array<{
+    /**
+     * Query string
+     */
+    query: string;
+
+    /**
+     * Timestamp of the query
+     */
+    timestamp: string;
+  }>;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Callback when a query is submitted
+   */
+  onSubmit?: string;
+}
+
+/**
+ * AI Insights Schema - AI-generated data insights and analysis
+ */
+export interface AIInsightsSchema extends BaseSchema {
+  type: 'ai-insights';
+
+  /**
+   * Object name for context
+   */
+  objectName?: string;
+
+  /**
+   * Data to analyze
+   */
+  data?: any[];
+
+  /**
+   * AI configuration
+   */
+  config?: AIConfig;
+
+  /**
+   * Generated insights
+   */
+  insights?: Array<{
+    /**
+     * Insight title
+     */
+    title: string;
+
+    /**
+     * Insight description
+     */
+    description: string;
+
+    /**
+     * Insight type
+     */
+    type: 'trend' | 'anomaly' | 'prediction' | 'recommendation';
+
+    /**
+     * Severity level
+     */
+    severity?: 'info' | 'warning' | 'critical';
+
+    /**
+     * Associated metric
+     */
+    metric?: {
+      /**
+       * Metric value
+       */
+      value: number;
+
+      /**
+       * Change from previous period
+       */
+      change?: number;
+
+      /**
+       * Unit of measurement
+       */
+      unit?: string;
+    };
+  }>;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Automatically refresh insights
+   */
+  autoRefresh?: boolean;
+
+  /**
+   * Auto-refresh interval (in seconds)
+   */
+  refreshInterval?: number;
+}

package/src/app.ts

@@ -66,13 +66,13 @@ export interface AppSchema extends BaseSchema {
   actions?: AppAction[];
 
   /**
-   * Home page ID (ObjectStack Spec v0.7.1)
+   * Home page ID (ObjectStack Spec v2.0.1)
    * Default page to navigate to after login
    */
   homePageId?: string;
 
   /**
-   * Required permissions (ObjectStack Spec v0.7.1)
+   * Required permissions (ObjectStack Spec v2.0.1)
    * Permissions required to access this application
    */
   requiredPermissions?: string[];

package/src/complex.ts

@@ -519,6 +519,8 @@ export interface DashboardSchema extends BaseSchema {
   columns?: number;
   gap?: number;
   widgets: DashboardWidgetSchema[];
+  /** Auto-refresh interval in seconds. When set, the dashboard will periodically trigger onRefresh. */
+  refreshInterval?: number;
 }
 
 /**

package/src/crud.ts

@@ -81,6 +81,9 @@ export interface ActionCondition {
 /**
  * Action button configuration for CRUD operations
  * Enhanced with Phase 2 features: ajax, confirm, dialog, chaining, conditional execution
+ *
+ * @deprecated Use `UIActionSchema` from `@object-ui/types` (re-exported from `ui-action.ts`) for new code.
+ * This legacy interface will be removed in a future major version.
  */
 export interface ActionSchema extends BaseSchema {
   type: 'action';

package/src/data-display.ts

@@ -253,6 +253,11 @@ export interface TableColumn {
    * @default true
    */
   resizable?: boolean;
+  /**
+   * Whether column is editable (for inline editing)
+   * @default true
+   */
+  editable?: boolean;
   /**
    * Custom cell renderer function
    */
@@ -377,6 +382,37 @@ export interface DataTableSchema extends BaseSchema {
    * Columns reorder handler
    */
   onColumnsReorder?: (columns: TableColumn[]) => void;
+  /**
+   * Enable inline cell editing
+   * When true, cells become editable on double-click or Enter key
+   * @default false
+   */
+  editable?: boolean;
+  /**
+   * Cell value change handler
+   * Called when a cell value is edited
+   */
+  onCellChange?: (rowIndex: number, columnKey: string, newValue: any, row: any) => void;
+  /**
+   * Row save handler
+   * Called when saving changes for a single row
+   */
+  onRowSave?: (rowIndex: number, changes: Record<string, any>, row: any) => void | Promise<void>;
+  /**
+   * Batch save handler
+   * Called when saving changes for multiple rows
+   */
+  onBatchSave?: (changes: Array<{ rowIndex: number; changes: Record<string, any>; row: any }>) => void | Promise<void>;
+  /**
+   * Row click handler
+   * Called when a row is clicked
+   */
+  onRowClick?: (row: any) => void;
+  /**
+   * Dynamic row class name
+   * Function that returns a CSS class string for each row
+   */
+  rowClassName?: (row: any, index: number) => string | undefined;
 }
 
 /**

package/src/data-protocol.ts

@@ -81,7 +81,7 @@ export interface WhereNode extends QueryASTNode {
 }
 
 /**
- * Join execution strategy hint (ObjectStack Spec v0.7.1)
+ * Join execution strategy hint (ObjectStack Spec v2.0.1)
  */
 export type JoinStrategy = 'auto' | 'database' | 'hash' | 'loop';
 
@@ -155,7 +155,7 @@ export interface AggregateNode extends QueryASTNode {
 }
 
 /**
- * Window function type (ObjectStack Spec v0.7.1)
+ * Window function type (ObjectStack Spec v2.0.1)
  */
 export type WindowFunction = 
   | 'row_number'
@@ -173,12 +173,12 @@ export type WindowFunction =
   | 'max';
 
 /**
- * Window frame unit (ObjectStack Spec v0.7.1)
+ * Window frame unit (ObjectStack Spec v2.0.1)
  */
 export type WindowFrameUnit = 'rows' | 'range';
 
 /**
- * Window frame boundary (ObjectStack Spec v0.7.1)
+ * Window frame boundary (ObjectStack Spec v2.0.1)
  */
 export type WindowFrameBoundary = 
   | 'unbounded_preceding'
@@ -188,7 +188,7 @@ export type WindowFrameBoundary =
   | { type: 'following'; offset: number };
 
 /**
- * Window frame specification (ObjectStack Spec v0.7.1)
+ * Window frame specification (ObjectStack Spec v2.0.1)
  */
 export interface WindowFrame {
   unit: WindowFrameUnit;
@@ -197,7 +197,7 @@ export interface WindowFrame {
 }
 
 /**
- * Window function node (ObjectStack Spec v0.7.1)
+ * Window function node (ObjectStack Spec v2.0.1)
  */
 export interface WindowNode extends QueryASTNode {
   type: 'window';
@@ -341,7 +341,7 @@ export interface QuerySchema {
   group_by?: string[];
   
   /**
-   * Window functions (ObjectStack Spec v0.7.1)
+   * Window functions (ObjectStack Spec v2.0.1)
    */
   windows?: WindowConfig[];
   
@@ -388,7 +388,7 @@ export interface AggregationConfig {
 }
 
 /**
- * Window function configuration (ObjectStack Spec v0.7.1)
+ * Window function configuration (ObjectStack Spec v2.0.1)
  */
 export interface WindowConfig {
   /** Window function name */
@@ -826,12 +826,12 @@ export interface AdvancedValidationError {
 
 /**
  * =============================================================================
- * ObjectStack Spec v0.7.1: Object-Level Validation Framework
+ * ObjectStack Spec v2.0.1: Object-Level Validation Framework
  * =============================================================================
  */
 
 /**
- * Base validation interface (ObjectStack Spec v0.7.1)
+ * Base validation interface (ObjectStack Spec v2.0.1)
  */
 export interface BaseValidation {
   /** Unique validation name (snake_case) */
@@ -860,7 +860,7 @@ export interface BaseValidation {
 }
 
 /**
- * Script-based validation (ObjectStack Spec v0.7.1)
+ * Script-based validation (ObjectStack Spec v2.0.1)
  * Uses expression language to define conditions
  */
 export interface ScriptValidation extends BaseValidation {
@@ -871,7 +871,7 @@ export interface ScriptValidation extends BaseValidation {
 }
 
 /**
- * Uniqueness validation (ObjectStack Spec v0.7.1)
+ * Uniqueness validation (ObjectStack Spec v2.0.1)
  * Ensures field combinations are unique
  */
 export interface UniquenessValidation extends BaseValidation {
@@ -888,7 +888,7 @@ export interface UniquenessValidation extends BaseValidation {
 }
 
 /**
- * State machine validation (ObjectStack Spec v0.7.1)
+ * State machine validation (ObjectStack Spec v2.0.1)
  * Enforces valid state transitions
  */
 export interface StateMachineValidation extends BaseValidation {
@@ -911,7 +911,7 @@ export interface StateMachineValidation extends BaseValidation {
 }
 
 /**
- * Cross-field validation (ObjectStack Spec v0.7.1)
+ * Cross-field validation (ObjectStack Spec v2.0.1)
  * Validates relationships between multiple fields
  */
 export interface CrossFieldValidation extends BaseValidation {
@@ -925,7 +925,7 @@ export interface CrossFieldValidation extends BaseValidation {
 }
 
 /**
- * Async/remote validation (ObjectStack Spec v0.7.1)
+ * Async/remote validation (ObjectStack Spec v2.0.1)
  * Calls external endpoint for validation
  */
 export interface AsyncValidation extends BaseValidation {
@@ -948,7 +948,7 @@ export interface AsyncValidation extends BaseValidation {
 }
 
 /**
- * Conditional validation (ObjectStack Spec v0.7.1)
+ * Conditional validation (ObjectStack Spec v2.0.1)
  * Applies nested rules only when condition is met
  */
 export interface ConditionalValidation extends BaseValidation {
@@ -962,7 +962,7 @@ export interface ConditionalValidation extends BaseValidation {
 }
 
 /**
- * Format validation (ObjectStack Spec v0.7.1)
+ * Format validation (ObjectStack Spec v2.0.1)
  * Validates field format using regex or predefined patterns
  */
 export interface FormatValidation extends BaseValidation {
@@ -982,7 +982,7 @@ export interface FormatValidation extends BaseValidation {
 }
 
 /**
- * Range validation (ObjectStack Spec v0.7.1)
+ * Range validation (ObjectStack Spec v2.0.1)
  * Validates numeric or date ranges
  */
 export interface RangeValidation extends BaseValidation {
@@ -1005,7 +1005,7 @@ export interface RangeValidation extends BaseValidation {
 }
 
 /**
- * Union type for all validation rules (ObjectStack Spec v0.7.1)
+ * Union type for all validation rules (ObjectStack Spec v2.0.1)
  */
 export type ObjectValidationRule = 
   | ScriptValidation