@object-ui/types 0.5.0 → 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';
 
@@ -402,7 +410,7 @@ export type {
   ValidationContext,
   AdvancedValidationResult,
   AdvancedValidationError,
-  // ObjectStack Spec v0.7.1 Validation
+  // ObjectStack Spec v2.0.1 Validation
   BaseValidation,
   ScriptValidation,
   UniquenessValidation,
@@ -432,6 +440,89 @@ export type {
   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
 // ============================================================================
@@ -469,16 +560,24 @@ import type { AppSchema } from './app';
 // Phase 2 Schemas - New Additions
 // ============================================================================
 export type {
-  // Theme System
+  // Theme System (aligned with @objectstack/spec)
+  Theme,
   ThemeSchema,
-  ThemeDefinition,
   ThemeMode,
   ColorPalette,
   Typography,
-  SpacingScale,
+  Spacing,
   BorderRadius,
+  Shadow,
+  Breakpoints,
+  Animation,
+  ZIndex,
+  ThemeLogo,
   ThemeSwitcherSchema,
   ThemePreviewSchema,
+  // Legacy aliases
+  ThemeDefinition,
+  SpacingScale,
 } from './theme';
 
 export type {
@@ -497,6 +596,37 @@ export type {
   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,
@@ -609,7 +739,7 @@ export type {
 } from './plugin-scope';
 
 // ============================================================================
-// UI Actions - Enhanced Action Schema (ObjectStack Spec v0.7.1)
+// UI Actions - Enhanced Action Schema (ObjectStack Spec v2.0.1)
 // ============================================================================
 /**
  * Enhanced action schema with location-based placement, parameter collection,
@@ -625,6 +755,14 @@ export type {
   ActionContext,
   ActionResult,
   ActionExecutor,
+  BatchOperationConfig,
+  BatchOperationResult,
+  TransactionIsolationLevel,
+  TransactionConfig,
+  TransactionResult,
+  UndoRedoEntry,
+  UndoRedoConfig,
+  UndoRedoState,
 } from './ui-action';
 
 // ============================================================================
@@ -638,10 +776,84 @@ export type {
  * 
  * @example
  * ```typescript
- * import { Data, UI, System, AI, API } from '@object-ui/types';
+ * import { Data, UI, System, AI, API, Kernel } from '@object-ui/types';
  * 
  * const field: Data.Field = { name: 'task_name', type: 'text' };
- * const component: UI.Component = { type: 'button', label: 'Click me' };
+ * 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 type { Data, UI, System, AI, API, Auth, Hub, Automation, Permission, Shared, QA } from '@objectstack/spec';
+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[];
 }
 
 /**

package/src/mobile.ts

@@ -0,0 +1,205 @@
+/**
+ * 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 - Mobile Optimization Types
+ * 
+ * Type definitions for mobile-responsive components, PWA support,
+ * and touch gesture handling.
+ * 
+ * @module mobile
+ * @packageDocumentation
+ */
+
+// ============================================================================
+// Responsive Configuration
+// ============================================================================
+
+/** Breakpoint names */
+export type BreakpointName = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
+
+/** Responsive value - different values for different breakpoints */
+export type ResponsiveValue<T> = T | Partial<Record<BreakpointName, T>>;
+
+/** Responsive layout configuration */
+export interface ResponsiveConfig {
+  /** Number of columns at each breakpoint */
+  columns?: ResponsiveValue<number>;
+  /** Whether to stack vertically on mobile */
+  stackOnMobile?: boolean;
+  /** Breakpoint at which to stack */
+  stackBreakpoint?: BreakpointName;
+  /** Gap between items at each breakpoint */
+  gap?: ResponsiveValue<string | number>;
+  /** Padding at each breakpoint */
+  padding?: ResponsiveValue<string | number>;
+  /** Whether to hide on specific breakpoints */
+  hidden?: BreakpointName[];
+  /** Whether to show only on specific breakpoints */
+  showOnly?: BreakpointName[];
+}
+
+/** Mobile-specific component overrides */
+export interface MobileOverrides {
+  /** Simplified layout for mobile */
+  layout?: 'stack' | 'tabs' | 'accordion' | 'carousel';
+  /** Reduced columns for forms */
+  columns?: number;
+  /** Whether to use bottom sheet instead of modal */
+  useBottomSheet?: boolean;
+  /** Whether to use full-screen mode */
+  fullScreen?: boolean;
+  /** Touch-friendly sizing */
+  touchTarget?: 'default' | 'large' | 'xlarge';
+  /** Simplified navigation */
+  navigation?: 'bottom-tabs' | 'hamburger' | 'drawer';
+}
+
+// ============================================================================
+// PWA Support
+// ============================================================================
+
+/** PWA configuration */
+export interface PWAConfig {
+  /** Enable PWA support */
+  enabled: boolean;
+  /** App name */
+  name: string;
+  /** Short name for home screen */
+  shortName: string;
+  /** App description */
+  description?: string;
+  /** Theme color */
+  themeColor?: string;
+  /** Background color */
+  backgroundColor?: string;
+  /** Display mode */
+  display?: 'standalone' | 'fullscreen' | 'minimal-ui' | 'browser';
+  /** App icons */
+  icons?: PWAIcon[];
+  /** Start URL */
+  startUrl?: string;
+  /** Scope */
+  scope?: string;
+  /** Orientation */
+  orientation?: 'any' | 'portrait' | 'landscape';
+}
+
+/** PWA icon definition */
+export interface PWAIcon {
+  /** Icon URL */
+  src: string;
+  /** Icon sizes (e.g., '192x192') */
+  sizes: string;
+  /** MIME type */
+  type?: string;
+  /** Purpose */
+  purpose?: 'any' | 'maskable' | 'monochrome';
+}
+
+/** Offline caching strategy */
+export type CacheStrategy = 'cache-first' | 'network-first' | 'stale-while-revalidate' | 'network-only' | 'cache-only';
+
+/** Offline configuration */
+export interface OfflineConfig {
+  /** Enable offline support */
+  enabled: boolean;
+  /** Default caching strategy */
+  defaultStrategy: CacheStrategy;
+  /** Routes with specific caching strategies */
+  routes?: OfflineRoute[];
+  /** Maximum cache size in bytes */
+  maxCacheSize?: number;
+  /** Cache expiration in seconds */
+  cacheExpiration?: number;
+  /** Objects to cache for offline access */
+  offlineObjects?: string[];
+  /** Sync strategy when back online */
+  syncStrategy?: 'immediate' | 'background' | 'manual';
+  /** Conflict resolution strategy */
+  conflictResolution?: 'server-wins' | 'client-wins' | 'manual';
+}
+
+/** Offline route configuration */
+export interface OfflineRoute {
+  /** URL pattern (glob or regex) */
+  pattern: string;
+  /** Caching strategy for this route */
+  strategy: CacheStrategy;
+  /** Cache name */
+  cacheName?: string;
+  /** Cache expiration override */
+  expiration?: number;
+}
+
+// ============================================================================
+// Touch Gestures
+// ============================================================================
+
+/** Touch gesture types */
+export type GestureType = 'tap' | 'double-tap' | 'long-press' | 'swipe-left' | 'swipe-right' | 'swipe-up' | 'swipe-down' | 'pinch' | 'rotate' | 'pan';
+
+/** Gesture handler configuration */
+export interface GestureConfig {
+  /** Gesture type */
+  type: GestureType;
+  /** Action to execute */
+  action: string;
+  /** Minimum distance for swipe gestures (pixels) */
+  threshold?: number;
+  /** Duration for long-press (milliseconds) */
+  duration?: number;
+  /** Whether to prevent default browser behavior */
+  preventDefault?: boolean;
+  /** Whether gesture is enabled */
+  enabled?: boolean;
+}
+
+/** Touch gesture context */
+export interface GestureContext {
+  /** Gesture type that was detected */
+  type: GestureType;
+  /** Start position */
+  startPosition: { x: number; y: number };
+  /** End position */
+  endPosition: { x: number; y: number };
+  /** Distance traveled */
+  distance: number;
+  /** Direction of movement */
+  direction?: 'up' | 'down' | 'left' | 'right';
+  /** Duration of gesture in milliseconds */
+  duration: number;
+  /** Velocity (pixels per millisecond) */
+  velocity: number;
+  /** Scale for pinch gestures */
+  scale?: number;
+  /** Rotation angle for rotate gestures */
+  rotation?: number;
+}
+
+/** Mobile component schema extension */
+export interface MobileComponentConfig {
+  /** Responsive configuration */
+  responsive?: ResponsiveConfig;
+  /** Mobile-specific overrides */
+  mobileOverrides?: MobileOverrides;
+  /** Touch gesture handlers */
+  gestures?: GestureConfig[];
+  /** Pull-to-refresh configuration */
+  pullToRefresh?: {
+    enabled: boolean;
+    threshold?: number;
+    onRefresh?: string;
+  };
+  /** Infinite scroll configuration */
+  infiniteScroll?: {
+    enabled: boolean;
+    threshold?: number;
+    loadMore?: string;
+  };
+}