@object-ui/types 0.3.1 → 2.0.0

package/src/index.ts

@@ -94,6 +94,10 @@ export type {
   AspectRatioSchema,
   LayoutSchema,
   PageSchema,
+  PageType,
+  PageRegion,
+  PageRegionWidth,
+  PageVariable,
 } from './layout';
 
 // ============================================================================
@@ -249,6 +253,7 @@ export type {
   DataBinding,
   ValidationError,
   APIError,
+  FileUploadResult,
 } from './data';
 
 // ============================================================================
@@ -290,7 +295,10 @@ export type {
   ListViewSchema,
   ObjectGridSchema,
   ObjectFormSchema,
+  ObjectFormSection,
   ObjectViewSchema,
+  NamedListView,
+  ViewNavigationConfig,
   ObjectQLComponentSchema,
 } from './objectql';
 
@@ -299,6 +307,8 @@ export type {
 // ============================================================================
 export type {
   BaseFieldMetadata,
+  VisibilityCondition,
+  ValidationFunction as FieldValidationFunction,
   TextFieldMetadata,
   TextareaFieldMetadata,
   MarkdownFieldMetadata,
@@ -328,10 +338,191 @@ 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 v2.0.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';
+
+// ============================================================================
+// Permission & RBAC Types (Q2 2026)
+// ============================================================================
+export type {
+  PermissionAction,
+  PermissionEffect,
+  RoleDefinition,
+  ObjectLevelPermission,
+  FieldLevelPermission,
+  RowLevelPermission,
+  PermissionCondition,
+  ObjectPermissionConfig,
+  SharingRuleConfig,
+  PermissionCheckResult,
+  PermissionContext,
+  PermissionGuardConfig,
+} from './permissions';
+
+// ============================================================================
+// Multi-Tenancy Types (Q2 2026)
+// ============================================================================
+export type {
+  TenantIsolationStrategy,
+  TenantStatus,
+  TenantPlan,
+  TenantConfig,
+  TenantBranding,
+  TenantLimits,
+  TenantContext,
+  TenantResolutionStrategy,
+  TenantProviderConfig,
+  TenantScopedQueryConfig,
+} from './tenant';
+
+// ============================================================================
+// Mobile Optimization Types (Q2 2026)
+// ============================================================================
+export type {
+  BreakpointName,
+  ResponsiveValue,
+  ResponsiveConfig,
+  MobileOverrides,
+  PWAConfig,
+  PWAIcon,
+  CacheStrategy,
+  OfflineConfig,
+  OfflineRoute,
+  GestureType,
+  GestureConfig,
+  GestureContext,
+  MobileComponentConfig,
+} from './mobile';
+
+// ============================================================================
+// Visual Designer Types (Q2 2026)
+// ============================================================================
+export type {
+  DesignerPosition,
+  DesignerCanvasConfig,
+  DesignerComponent,
+  PageDesignerSchema,
+  DesignerPaletteCategory,
+  DesignerPaletteItem,
+  DataModelEntity,
+  DataModelField,
+  DataModelRelationship,
+  DataModelDesignerSchema,
+  BPMNNodeType,
+  BPMNNode,
+  BPMNEdge,
+  BPMNLane,
+  ProcessDesignerSchema,
+  ReportSectionType,
+  ReportDesignerElement,
+  ReportDesignerSection,
+  ReportDesignerSchema,
+  CollaborationPresence,
+  CollaborationOperation,
+  CollaborationConfig,
+  ViewDesignerColumn,
+  ViewDesignerSchema,
+} from './designer';
+
 // ============================================================================
 // API and Events - API Integration and Event Handling
 // ============================================================================
@@ -365,6 +556,110 @@ 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 (aligned with @objectstack/spec)
+  Theme,
+  ThemeSchema,
+  ThemeMode,
+  ColorPalette,
+  Typography,
+  Spacing,
+  BorderRadius,
+  Shadow,
+  Breakpoints,
+  Animation,
+  ZIndex,
+  ThemeLogo,
+  ThemeSwitcherSchema,
+  ThemePreviewSchema,
+  // Legacy aliases
+  ThemeDefinition,
+  SpacingScale,
+} from './theme';
+
+export type {
+  // Report System
+  ReportSchema,
+  ReportExportFormat,
+  ReportScheduleFrequency,
+  ReportAggregationType,
+  ReportField,
+  ReportFilter,
+  ReportGroupBy,
+  ReportSection,
+  ReportSchedule,
+  ReportExportConfig,
+  ReportBuilderSchema,
+  ReportViewerSchema,
+} from './reports';
+
+export type {
+  // Workflow System
+  WorkflowStatus,
+  WorkflowNodeType,
+  WorkflowEdgeType,
+  WorkflowNode,
+  WorkflowNodeAction,
+  WorkflowEdge,
+  ApprovalRule,
+  WorkflowVariable,
+  WorkflowSchema,
+  WorkflowDesignerSchema,
+  ApprovalHistoryItem,
+  ApprovalProcessSchema,
+  WorkflowInstanceSchema,
+} from './workflow';
+
+export type {
+  // AI System
+  AIProvider,
+  AIModelType,
+  AIConfig,
+  AIFieldSuggestion,
+  AIFormAssistSchema,
+  AIRecommendationItem,
+  AIRecommendationsSchema,
+  NLQueryResult,
+  NLQuerySchema,
+  AIInsightsSchema,
+} from './ai';
+
+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 +726,134 @@ 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 v2.0.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,
+  BatchOperationConfig,
+  BatchOperationResult,
+  TransactionIsolationLevel,
+  TransactionConfig,
+  TransactionResult,
+  UndoRedoEntry,
+  UndoRedoConfig,
+  UndoRedoState,
+} 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, Kernel } from '@object-ui/types';
+ * 
+ * const field: Data.Field = { name: 'task_name', type: 'text' };
+ * const view: UI.ListView = { name: 'all', label: 'All Records', ... };
+ * ```
+ */
+export type {
+  Data,
+  UI,
+  System,
+  AI,
+  API,
+  Hub,
+  Automation,
+  Shared,
+  QA,
+  Kernel,
+  Contracts,
+  Integration,
+  Studio,
+  Identity,
+  Security,
+} from '@objectstack/spec';
+
+// ============================================================================
+// ObjectStack Protocol Utilities - defineStack, definePlugin
+// ============================================================================
+/**
+ * Re-export ObjectStack Protocol utility functions and top-level types.
+ *
+ * @example
+ * ```typescript
+ * import { defineStack, definePlugin } from '@object-ui/types';
+ *
+ * export default defineStack({
+ *   manifest: { id: 'com.example.app', version: '1.0.0', type: 'app', name: 'My App' },
+ *   objects: [],
+ *   apps: [],
+ * });
+ * ```
+ */
+export {
+  defineStack,
+  definePlugin,
+  ObjectStackSchema,
+  ObjectStackDefinitionSchema,
+  ObjectStackCapabilitiesSchema,
+  ObjectOSCapabilitiesSchema,
+  ObjectQLCapabilitiesSchema,
+  ObjectUICapabilitiesSchema,
+} from '@objectstack/spec';
+
+export type {
+  PluginContext,
+  ObjectStack,
+  ObjectStackDefinition,
+  ObjectStackCapabilities,
+  ObjectOSCapabilities,
+  ObjectQLCapabilities,
+  ObjectUICapabilities,
+} from '@objectstack/spec';
+
+// ============================================================================
+// Widget System - Runtime Widget Registration (Section 1.6)
+// ============================================================================
+/**
+ * Widget manifest and registry types for runtime widget registration,
+ * plugin auto-discovery, and custom widget registry.
+ */
+export type {
+  WidgetManifest,
+  WidgetSource,
+  WidgetSourceModule,
+  WidgetSourceInline,
+  WidgetSourceRegistry,
+  WidgetInput,
+  WidgetCapabilities,
+  ResolvedWidget,
+  WidgetRegistryEvent,
+  WidgetRegistryListener,
+} from './widget';

package/src/layout.ts

@@ -424,35 +424,64 @@ export interface AspectRatioSchema extends BaseSchema {
   children?: SchemaNode | SchemaNode[];
 }
 
+/**
+ * Page Type
+ * Determines page behavior and default layout template.
+ * Aligned with @objectstack/spec Page.type
+ */
+export type PageType = 'record' | 'home' | 'app' | 'utility';
+
+/**
+ * Page Variable
+ * Local page state that can be read/written by components and expressions.
+ * Aligned with @objectstack/spec PageVariableSchema
+ */
+export interface PageVariable {
+  /** Variable name */
+  name: string;
+  /** Variable type @default 'string' */
+  type?: 'string' | 'number' | 'boolean' | 'object' | 'array';
+  /** Default value for initialization */
+  defaultValue?: any;
+}
+
+/**
+ * Page Region Size
+ * Aligned with @objectstack/spec PageRegionSchema.width
+ */
+export type PageRegionWidth = 'small' | 'medium' | 'large' | 'full';
+
 /**
  * Page Region (Header, Sidebar, Main, etc)
+ * Aligned with @objectstack/spec PageRegionSchema
  */
 export interface PageRegion {
   /**
-   * Region name/id
+   * Region name/id (e.g. "sidebar", "main", "header")
    */
   name: string;
   /**
-   * Region type
+   * Region type — semantic role for layout rendering
    */
   type?: 'header' | 'sidebar' | 'main' | 'footer' | 'aside';
   /**
-   * Width (flex basis)
+   * Region width (spec-aligned enum)
    */
-  width?: string;
+  width?: PageRegionWidth | string;
   /**
    * Components in this region
    */
   components: SchemaNode[];
   /**
-   * CSS class
+   * CSS class overrides
    */
   className?: string;
 }
 
 /**
  * Page layout component
- * Top-level container for a page route
+ * Top-level container for a page route.
+ * Aligned with @objectstack/spec PageSchema
  */
 export interface PageSchema extends BaseSchema {
   type: 'page';
@@ -461,13 +490,33 @@ export interface PageSchema extends BaseSchema {
    */
   title?: string;
   /**
-    * Page icon (Lucide icon name)
-    */
+   * Page icon (Lucide icon name)
+   */
   icon?: string;
   /**
    * Page description
    */
   description?: string;
+  /**
+   * Page type — determines default layout and behavior
+   * @default 'record'
+   */
+  pageType?: PageType;
+  /**
+   * Bound object name (for record pages)
+   * Provides record context to components in regions
+   */
+  object?: string;
+  /**
+   * Layout template name (e.g. "default", "header-sidebar-main")
+   * @default 'default'
+   */
+  template?: string;
+  /**
+   * Local page state variables
+   * Initialized on mount and available to all components via context
+   */
+  variables?: PageVariable[];
   /**
    * Page layout regions
    * (Aligned with @objectstack/spec Page.regions)
@@ -481,6 +530,15 @@ export interface PageSchema extends BaseSchema {
    * Alternative content prop
    */
   children?: SchemaNode | SchemaNode[];
+  /**
+   * Whether this is the default page for the object/app
+   * @default false
+   */
+  isDefault?: boolean;
+  /**
+   * Profiles that can access this page
+   */
+  assignedProfiles?: string[];
 }
 
 /**