@object-ui/types 0.3.1 → 0.5.0

package/src/data.ts

@@ -35,9 +35,11 @@ export interface QueryParams {
 
   /**
    * Sort order
+   * Can be a Map { field: 'asc' }, an Array of strings ['field', '-field'], or Array of sort objects
    * @example { createdAt: 'desc', name: 'asc' }
+   * @example ['name', '-createdAt']
    */
-  $orderby?: Record<string, 'asc' | 'desc'>;
+  $orderby?: Record<string, 'asc' | 'desc'> | string[] | Array<{ field: string; order?: 'asc' | 'desc' }>;
 
   /**
    * Number of records to skip (for pagination)

package/src/field-types.ts

@@ -67,11 +67,12 @@ export interface BaseFieldMetadata {
   defaultValue?: any;
   
   /**
-   * Field permissions
+   * Field permissions (Phase 3.2.6)
    */
   permissions?: {
     read?: boolean;
     write?: boolean;
+    edit?: boolean;
   };
   
   /**
@@ -93,6 +94,22 @@ export interface BaseFieldMetadata {
    * Custom validation function or rules
    */
   validate?: ValidationFunction | ValidationRule;
+  
+  /**
+   * Field dependencies (Phase 3.2.3)
+   * List of fields that this field depends on
+   */
+  depends_on?: string[];
+  
+  /**
+   * Field index for database optimization
+   */
+  indexed?: boolean;
+  
+  /**
+   * Field is unique constraint
+   */
+  unique?: boolean;
 }
 
 /**
@@ -339,21 +356,53 @@ export interface LookupFieldMetadata extends BaseFieldMetadata {
 
 /**
  * Formula field metadata (read-only computed field)
+ * Phase 3.2.4: Enhanced formula field with real-time computation
  */
 export interface FormulaFieldMetadata extends BaseFieldMetadata {
   type: 'formula';
+  /**
+   * Formula expression
+   * Supports JavaScript-like expressions with field references
+   * @example "${amount} * ${tax_rate}"
+   * @example "${firstName} + ' ' + ${lastName}"
+   */
   formula?: string;
-  return_type?: string;
+  /**
+   * Return type of the formula
+   */
+  return_type?: 'text' | 'number' | 'boolean' | 'date' | 'datetime';
+  /**
+   * Whether to recompute on dependency changes
+   */
+  auto_compute?: boolean;
 }
 
 /**
  * Summary/Rollup field metadata (aggregation)
+ * Phase 3.2.5: Enhanced summary field implementation
  */
 export interface SummaryFieldMetadata extends BaseFieldMetadata {
   type: 'summary';
+  /**
+   * Related object to summarize from
+   */
   summary_object?: string;
+  /**
+   * Field to aggregate in the related object
+   */
   summary_field?: string;
-  summary_type?: 'count' | 'sum' | 'avg' | 'min' | 'max';
+  /**
+   * Aggregation type
+   */
+  summary_type?: 'count' | 'sum' | 'avg' | 'min' | 'max' | 'first' | 'last';
+  /**
+   * Filter condition for summarized records
+   */
+  summary_filter?: Record<string, any>;
+  /**
+   * Whether to auto-update on related record changes
+   */
+  auto_update?: boolean;
 }
 
 /**
@@ -383,18 +432,136 @@ export interface ObjectFieldMetadata extends BaseFieldMetadata {
 
 /**
  * Vector field metadata (embeddings)
+ * Phase 3.2.1: Complete vector field implementation
  */
 export interface VectorFieldMetadata extends BaseFieldMetadata {
   type: 'vector';
+  /**
+   * Vector dimensions (e.g., 768 for BERT, 1536 for OpenAI)
+   */
   dimensions?: number;
+  /**
+   * Distance metric for similarity search
+   */
+  distance_metric?: 'cosine' | 'euclidean' | 'dot_product';
+  /**
+   * Whether to index for similarity search
+   */
+  indexed?: boolean;
+  /**
+   * Normalization strategy
+   */
+  normalize?: boolean;
 }
 
 /**
  * Grid field metadata (sub-table)
+ * Phase 3.2.2: Complete grid field implementation
  */
 export interface GridFieldMetadata extends BaseFieldMetadata {
   type: 'grid';
-  columns?: any[];
+  /**
+   * Column definitions for the grid
+   */
+  columns?: GridColumnDefinition[];
+  /**
+   * Minimum number of rows
+   */
+  min_rows?: number;
+  /**
+   * Maximum number of rows
+   */
+  max_rows?: number;
+  /**
+   * Whether to allow adding rows
+   */
+  allow_add?: boolean;
+  /**
+   * Whether to allow deleting rows
+   */
+  allow_delete?: boolean;
+  /**
+   * Whether to allow reordering rows
+   */
+  allow_reorder?: boolean;
+}
+
+/**
+ * Grid column definition
+ */
+export interface GridColumnDefinition {
+  /**
+   * Column field name
+   */
+  name: string;
+  /**
+   * Column label
+   */
+  label?: string;
+  /**
+   * Field type
+   */
+  type: string;
+  /**
+   * Whether column is required
+   */
+  required?: boolean;
+  /**
+   * Default value for new rows
+   */
+  defaultValue?: any;
+  /**
+   * Column width
+   */
+  width?: number;
+  /**
+   * Validation rules
+   */
+  validate?: ValidationRule;
+}
+
+export interface ColorFieldMetadata extends BaseFieldMetadata {
+  type: 'color';
+}
+
+export interface CodeFieldMetadata extends BaseFieldMetadata {
+  type: 'code';
+}
+
+export interface AvatarFieldMetadata extends BaseFieldMetadata {
+  type: 'avatar';
+}
+
+export interface SignatureFieldMetadata extends BaseFieldMetadata {
+  type: 'signature';
+}
+
+export interface QRCodeFieldMetadata extends BaseFieldMetadata {
+  type: 'qrcode';
+}
+
+export interface AddressFieldMetadata extends BaseFieldMetadata {
+  type: 'address';
+}
+
+export interface GeolocationFieldMetadata extends BaseFieldMetadata {
+  type: 'geolocation';
+}
+
+export interface SliderFieldMetadata extends BaseFieldMetadata {
+  type: 'slider';
+  min?: number;
+  max?: number;
+}
+
+export interface RatingFieldMetadata extends BaseFieldMetadata {
+  type: 'rating';
+  max?: number;
+}
+
+export interface MasterDetailFieldMetadata extends BaseFieldMetadata {
+  type: 'master_detail';
+  reference_to?: string;
 }
 
 /**
@@ -427,10 +594,118 @@ export type FieldMetadata =
   | UserFieldMetadata
   | ObjectFieldMetadata
   | VectorFieldMetadata
-  | GridFieldMetadata;
+  | GridFieldMetadata
+  | ColorFieldMetadata
+  | CodeFieldMetadata
+  | AvatarFieldMetadata
+  | SignatureFieldMetadata
+  | QRCodeFieldMetadata
+  | AddressFieldMetadata
+  | GeolocationFieldMetadata
+  | SliderFieldMetadata
+  | RatingFieldMetadata
+  | MasterDetailFieldMetadata;
+
+/**
+ * Object trigger configuration (Phase 3.1.3)
+ */
+export interface ObjectTrigger {
+  /**
+   * Trigger name
+   */
+  name: string;
+  /**
+   * When to execute the trigger
+   */
+  when: 'before' | 'after';
+  /**
+   * Which operation triggers this
+   */
+  on: 'create' | 'update' | 'delete' | 'read';
+  /**
+   * Trigger condition (optional)
+   */
+  condition?: string;
+  /**
+   * Action to execute
+   */
+  action: 'validation' | 'workflow' | 'notification' | 'calculation' | 'custom';
+  /**
+   * Action configuration
+   */
+  config?: Record<string, any>;
+}
+
+/**
+ * Object permission configuration (Phase 3.1.4)
+ */
+export interface ObjectPermission {
+  /**
+   * Permission profile name
+   */
+  profile?: string;
+  /**
+   * Role-based permissions
+   */
+  roles?: string[];
+  /**
+   * CRUD permissions
+   */
+  create?: boolean;
+  read?: boolean;
+  update?: boolean;
+  delete?: boolean;
+  /**
+   * Record-level permissions
+   */
+  record_level?: {
+    /**
+     * User can only access own records
+     */
+    own_records_only?: boolean;
+    /**
+     * Sharing rules
+     */
+    sharing_rules?: SharingRule[];
+  };
+  /**
+   * Field-level permissions
+   */
+  field_permissions?: Record<string, {
+    read?: boolean;
+    edit?: boolean;
+  }>;
+}
+
+/**
+ * Sharing rule configuration
+ */
+export interface SharingRule {
+  /**
+   * Rule name
+   */
+  name: string;
+  /**
+   * Criteria for sharing
+   */
+  criteria?: Record<string, any>;
+  /**
+   * Access level granted
+   */
+  access_level: 'read' | 'edit' | 'full';
+  /**
+   * Share with users/roles
+   */
+  share_with?: {
+    users?: string[];
+    roles?: string[];
+    groups?: string[];
+  };
+}
 
 /**
  * Object schema definition
+ * Phase 3.1: Enhanced with inheritance, triggers, permissions, and caching
  */
 export interface ObjectSchemaMetadata {
   /**
@@ -454,12 +729,118 @@ export interface ObjectSchemaMetadata {
   fields: Record<string, FieldMetadata>;
   
   /**
-   * Permissions
+   * Permissions (Phase 3.1.4: Enhanced permissions)
    */
-  permissions?: {
-    create?: boolean;
-    read?: boolean;
-    update?: boolean;
-    delete?: boolean;
+  permissions?: ObjectPermission;
+  
+  /**
+   * Parent object to inherit from (Phase 3.1.2)
+   */
+  extends?: string;
+  
+  /**
+   * Triggers configuration (Phase 3.1.3)
+   */
+  triggers?: ObjectTrigger[];
+  
+  /**
+   * Primary key field
+   */
+  primary_key?: string;
+  
+  /**
+   * Indexes for optimization
+   */
+  indexes?: ObjectIndex[];
+  
+  /**
+   * Relationships with other objects
+   */
+  relationships?: ObjectRelationship[];
+  
+  /**
+   * Record naming pattern
+   */
+  name_field?: string;
+  
+  /**
+   * Soft delete configuration
+   */
+  soft_delete?: boolean;
+  
+  /**
+   * Audit trail configuration
+   */
+  audit_trail?: boolean;
+  
+  /**
+   * Schema version
+   */
+  version?: string;
+  
+  /**
+   * Cache configuration (Phase 3.1.5)
+   */
+  cache?: {
+    /**
+     * Enable metadata caching
+     */
+    enabled?: boolean;
+    /**
+     * Cache TTL in seconds
+     */
+    ttl?: number;
+    /**
+     * Cache invalidation strategy
+     */
+    invalidation?: 'time' | 'event' | 'manual';
   };
 }
+
+/**
+ * Object index configuration
+ */
+export interface ObjectIndex {
+  /**
+   * Index name
+   */
+  name: string;
+  /**
+   * Fields to index
+   */
+  fields: string[];
+  /**
+   * Whether index is unique
+   */
+  unique?: boolean;
+  /**
+   * Index type
+   */
+  type?: 'btree' | 'hash' | 'gist' | 'gin';
+}
+
+/**
+ * Object relationship configuration
+ */
+export interface ObjectRelationship {
+  /**
+   * Relationship name
+   */
+  name: string;
+  /**
+   * Related object
+   */
+  object: string;
+  /**
+   * Relationship type
+   */
+  type: 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';
+  /**
+   * Foreign key field
+   */
+  foreign_key?: string;
+  /**
+   * Cascade delete
+   */
+  cascade_delete?: boolean;
+}

package/src/index.ts

@@ -299,6 +299,8 @@ export type {
 // ============================================================================
 export type {
   BaseFieldMetadata,
+  VisibilityCondition,
+  ValidationFunction as FieldValidationFunction,
   TextFieldMetadata,
   TextareaFieldMetadata,
   MarkdownFieldMetadata,
@@ -328,10 +330,108 @@ export type {
   ObjectFieldMetadata,
   VectorFieldMetadata,
   GridFieldMetadata,
+  GridColumnDefinition,
+  ColorFieldMetadata,
+  CodeFieldMetadata,
+  AvatarFieldMetadata,
+  SignatureFieldMetadata,
+  QRCodeFieldMetadata,
+  AddressFieldMetadata,
+  GeolocationFieldMetadata,
+  SliderFieldMetadata,
+  RatingFieldMetadata,
+  MasterDetailFieldMetadata,
   FieldMetadata,
+  ObjectTrigger,
+  ObjectPermission,
+  SharingRule,
   ObjectSchemaMetadata,
+  ObjectIndex,
+  ObjectRelationship,
 } from './field-types';
 
+// ============================================================================
+// Phase 3: Data Protocol Advanced Types
+// ============================================================================
+export type {
+  // Query AST (Phase 3.3)
+  QueryASTNodeType,
+  QueryASTNode,
+  SelectNode,
+  FromNode,
+  WhereNode,
+  JoinNode,
+  JoinStrategy,
+  GroupByNode,
+  OrderByNode,
+  LimitNode,
+  OffsetNode,
+  SubqueryNode,
+  AggregateNode,
+  WindowNode,
+  WindowFunction,
+  WindowFrame,
+  WindowFrameUnit,
+  WindowFrameBoundary,
+  FieldNode,
+  LiteralNode,
+  OperatorNode,
+  FunctionNode,
+  ComparisonOperator,
+  LogicalOperator,
+  QueryAST,
+  QuerySchema,
+  QuerySortConfig,
+  JoinConfig,
+  AggregationConfig,
+  WindowConfig,
+  // Filter Schema (Phase 3.4)
+  AdvancedFilterSchema,
+  AdvancedFilterCondition,
+  AdvancedFilterOperator,
+  DateRangeFilter,
+  DateRangePreset,
+  FilterBuilderConfig,
+  FilterFieldConfig,
+  // Validation Schema (Phase 3.5)
+  AdvancedValidationSchema,
+  AdvancedValidationRule,
+  ValidationRuleType,
+  ValidationFunction,
+  AsyncValidationFunction,
+  ValidationContext,
+  AdvancedValidationResult,
+  AdvancedValidationError,
+  // ObjectStack Spec v0.7.1 Validation
+  BaseValidation,
+  ScriptValidation,
+  UniquenessValidation,
+  StateMachineValidation,
+  CrossFieldValidation,
+  AsyncValidation,
+  ConditionalValidation,
+  FormatValidation,
+  RangeValidation,
+  ObjectValidationRule,
+  // Driver Interface (Phase 3.6)
+  DriverInterface,
+  ConnectionConfig,
+  DriverQueryResult,
+  BatchOperation,
+  BatchResult,
+  TransactionContext,
+  CacheManager,
+  ConnectionPool,
+  // Datasource Schema (Phase 3.7)
+  DatasourceSchema,
+  DatasourceType,
+  DatasourceMetric,
+  DatasourceAlert,
+  DatasourceManager,
+  HealthCheckResult,
+  DatasourceMetrics,
+} from './data-protocol';
+
 // ============================================================================
 // API and Events - API Integration and Event Handling
 // ============================================================================
@@ -365,6 +465,71 @@ import type { CRUDComponentSchema } from './crud';
 import type { ObjectQLComponentSchema, ListViewSchema } from './objectql';
 import type { AppSchema } from './app';
 
+// ============================================================================
+// Phase 2 Schemas - New Additions
+// ============================================================================
+export type {
+  // Theme System
+  ThemeSchema,
+  ThemeDefinition,
+  ThemeMode,
+  ColorPalette,
+  Typography,
+  SpacingScale,
+  BorderRadius,
+  ThemeSwitcherSchema,
+  ThemePreviewSchema,
+} from './theme';
+
+export type {
+  // Report System
+  ReportSchema,
+  ReportExportFormat,
+  ReportScheduleFrequency,
+  ReportAggregationType,
+  ReportField,
+  ReportFilter,
+  ReportGroupBy,
+  ReportSection,
+  ReportSchedule,
+  ReportExportConfig,
+  ReportBuilderSchema,
+  ReportViewerSchema,
+} from './reports';
+
+export type {
+  // Block System
+  BlockSchema,
+  BlockMetadata,
+  BlockVariable,
+  BlockSlot,
+  BlockLibraryItem,
+  BlockLibrarySchema,
+  BlockEditorSchema,
+  BlockInstanceSchema,
+  ComponentSchema,
+} from './blocks';
+
+export type {
+  // View System Enhancements
+  ViewType,
+  DetailViewSchema,
+  DetailViewField,
+  DetailViewSection,
+  DetailViewTab,
+  ViewSwitcherSchema,
+  FilterUISchema,
+  SortUISchema,
+  ViewComponentSchema,
+} from './views';
+
+export type {
+  // Enhanced Action System (Phase 2)
+  ActionExecutionMode,
+  ActionCallback,
+  ActionCondition,
+} from './crud';
+
 /**
  * Union of all component schemas.
  * Use this for generic component rendering where the type is determined at runtime.
@@ -431,3 +596,52 @@ export type {
   SchemaRegistry,
   ComponentType,
 } from './registry';
+
+// ============================================================================
+// Plugin Scope Isolation - Section 3.3
+// ============================================================================
+export type {
+  PluginScope,
+  PluginScopeConfig,
+  ComponentMeta as PluginComponentMeta,
+  ComponentInput as PluginComponentInput,
+  PluginEventHandler,
+} from './plugin-scope';
+
+// ============================================================================
+// UI Actions - Enhanced Action Schema (ObjectStack Spec v0.7.1)
+// ============================================================================
+/**
+ * Enhanced action schema with location-based placement, parameter collection,
+ * conditional visibility, and rich feedback mechanisms.
+ */
+export type {
+  ActionLocation,
+  ActionComponent,
+  ActionType,
+  ActionParam,
+  ActionSchema as UIActionSchema,
+  ActionGroup,
+  ActionContext,
+  ActionResult,
+  ActionExecutor,
+} from './ui-action';
+
+// ============================================================================
+// ObjectStack Protocol Namespaces - Protocol Re-exports
+// ============================================================================
+/**
+ * Re-export ObjectStack Protocol namespaces for convenience.
+ * 
+ * This allows consumers to access the full ObjectStack protocol through
+ * @object-ui/types without needing to install @objectstack/spec separately.
+ * 
+ * @example
+ * ```typescript
+ * import { Data, UI, System, AI, API } from '@object-ui/types';
+ * 
+ * const field: Data.Field = { name: 'task_name', type: 'text' };
+ * const component: UI.Component = { type: 'button', label: 'Click me' };
+ * ```
+ */
+export type { Data, UI, System, AI, API, Auth, Hub, Automation, Permission, Shared, QA } from '@objectstack/spec';