@object-ui/types 3.0.3 → 3.1.0

package/src/data.ts

@@ -237,6 +237,19 @@ export interface DataSource<T = any> {
    */
   getView?(objectName: string, viewId: string): Promise<any | null>;
 
+  /**
+   * Persist a view configuration to the backend.
+   * Called when a user saves view settings (columns, filters, sort, toggles, etc.)
+   * from the inline ViewConfigPanel.
+   * Optional — implementations that do not support view persistence may omit this.
+   *
+   * @param objectName - Object name
+   * @param viewId - View identifier (e.g., 'all', 'pipeline')
+   * @param config - The full view configuration to persist
+   * @returns Promise resolving to the persisted config (or void)
+   */
+  updateViewConfig?(objectName: string, viewId: string, config: Record<string, any>): Promise<Record<string, any> | void>;
+
   /**
    * Get an application definition by name or ID.
    * Used by app shells to render server-defined navigation, branding, and layout.
@@ -296,6 +309,42 @@ export interface DataSource<T = any> {
       onProgress?: (percent: number) => void;
     },
   ): Promise<FileUploadResult[]>;
+
+  /**
+   * Perform server-side aggregation on a resource.
+   * Used by chart widgets to offload grouping/aggregation to the backend,
+   * avoiding large data downloads.
+   * Optional — when not implemented, chart components will fall back to
+   * fetching all records via `find()` and aggregating client-side.
+   *
+   * @param resource - Resource name (e.g., 'opportunity')
+   * @param params - Aggregation parameters (field, function, groupBy, filter)
+   * @returns Promise resolving to aggregated results
+   */
+  aggregate?(resource: string, params: AggregateParams): Promise<AggregateResult[]>;
+}
+
+/**
+ * Parameters for server-side aggregation.
+ * Describes how to group and aggregate data on the backend.
+ */
+export interface AggregateParams {
+  /** Field to aggregate (e.g., 'amount') */
+  field: string;
+  /** Aggregation function (e.g., 'sum', 'count', 'avg', 'min', 'max') */
+  function: string;
+  /** Field to group by (e.g., 'stage') */
+  groupBy: string;
+  /** Optional filter to apply before aggregation */
+  filter?: any;
+}
+
+/**
+ * Result of a server-side aggregation.
+ * Each entry represents one group with the aggregated value.
+ */
+export interface AggregateResult {
+  [key: string]: any;
 }
 
 /**

package/src/designer.ts

@@ -393,11 +393,11 @@ export interface ReportDesignerSchema extends BaseSchema {
 }
 
 // ============================================================================
-// View Designer (List View Layout Editor)
+// Unified View Configuration
 // ============================================================================
 
-/** Column configuration for the view designer */
-export interface ViewDesignerColumn {
+/** Column configuration for rich view columns */
+export interface ViewColumnConfig {
   /** Field name */
   field: string;
   /** Display label */
@@ -412,35 +412,224 @@ export interface ViewDesignerColumn {
   order?: number;
 }
 
-/** View designer schema */
-export interface ViewDesignerSchema extends BaseSchema {
-  type: 'view-designer';
-  /** Object name this view is for */
-  objectName: string;
-  /** View identifier (for editing existing views) */
-  viewId?: string;
-  /** View display label */
-  viewLabel?: string;
+/** View type union */
+export type UnifiedViewType = 'grid' | 'kanban' | 'gallery' | 'calendar' | 'timeline' | 'gantt' | 'map' | 'chart';
+
+/**
+ * Unified data model for view configuration.
+ *
+ * Used by ViewConfigPanel (create/edit).
+ * Columns may be simple field-name strings or rich ViewColumnConfig objects;
+ * consumers should handle both.
+ */
+export interface UnifiedViewConfig {
+  /** View identifier */
+  id?: string;
+  /** Display label */
+  label?: string;
   /** View type */
-  viewType?: 'grid' | 'kanban' | 'gallery' | 'calendar' | 'timeline' | 'gantt' | 'map';
-  /** Columns / fields to display */
-  columns?: ViewDesignerColumn[];
-  /** Filter conditions */
-  filters?: Array<{ field: string; operator: string; value: any }>;
+  type?: UnifiedViewType;
+  /** Column configuration — simple field names or rich ViewColumnConfig objects */
+  columns?: Array<string | ViewColumnConfig>;
+  /** Filter conditions in @objectstack/spec JSON-rules array format */
+  filter?: any[];
   /** Sort configuration */
-  sort?: Array<{ field: string; direction: 'asc' | 'desc' }>;
-  /** Available fields from the object schema */
-  availableFields?: Array<{ name: string; label: string; type: string }>;
-  /** Type-specific options */
-  options?: Record<string, any>;
-  /** Read-only mode */
-  readOnly?: boolean;
-  /** Callback when view config changes */
-  onChange?: string;
-  /** Callback when view is saved */
-  onSave?: string;
-  /** Callback when cancelled */
-  onCancel?: string;
+  sort?: Array<{ field: string; order?: string; direction?: string; id?: string }>;
+  /** Description */
+  description?: string;
+  /** Enable search bar */
+  showSearch?: boolean;
+  /** Enable user filter controls */
+  showFilters?: boolean;
+  /** Enable user sort controls */
+  showSort?: boolean;
+  /** Allow data export */
+  allowExport?: boolean;
+  /** Show view description */
+  showDescription?: boolean;
+  /** Enable "add record via form" action */
+  addRecordViaForm?: boolean;
+  /** Export options */
+  exportOptions?: any;
+
+  // -- Type-specific options (nested per @objectstack/spec protocol) ----------
+
+  /** Kanban-specific options */
+  kanban?: {
+    groupByField?: string;
+    groupField?: string;
+    titleField?: string;
+    columns?: string[];
+  };
+  /** Calendar-specific options */
+  calendar?: {
+    startDateField?: string;
+    endDateField?: string;
+    titleField?: string;
+    colorField?: string;
+    allDayField?: string;
+    defaultView?: string;
+  };
+  /** Map-specific options */
+  map?: {
+    locationField?: string;
+    titleField?: string;
+    latitudeField?: string;
+    longitudeField?: string;
+    zoom?: number;
+    center?: { lat: number; lng: number };
+  };
+  /** Gallery-specific options */
+  gallery?: {
+    imageField?: string;
+    titleField?: string;
+    subtitleField?: string;
+  };
+  /** Timeline-specific options */
+  timeline?: {
+    dateField?: string;
+    titleField?: string;
+    descriptionField?: string;
+  };
+  /** Gantt-specific options */
+  gantt?: {
+    startDateField?: string;
+    endDateField?: string;
+    titleField?: string;
+    progressField?: string;
+    dependenciesField?: string;
+    colorField?: string;
+  };
+  /** Chart-specific options */
+  chart?: {
+    chartType?: string;
+    xAxisField?: string;
+    yAxisFields?: string[];
+    aggregation?: string;
+    series?: any[];
+    config?: any;
+    filter?: any;
+  };
+
+  /** Catch-all for additional properties */
+  [key: string]: any;
+}
+
+// ============================================================================
+// Dashboard Configuration
+// ============================================================================
+
+/** All supported color variants for dashboard widgets */
+export const DASHBOARD_COLOR_VARIANTS = [
+  'default', 'blue', 'teal', 'orange', 'purple', 'success', 'warning', 'danger',
+] as const;
+
+/** Color variant for dashboard widgets */
+export type DashboardColorVariant = (typeof DASHBOARD_COLOR_VARIANTS)[number];
+
+/** All supported widget visualization types */
+export const DASHBOARD_WIDGET_TYPES = [
+  'metric', 'bar', 'line', 'pie', 'donut', 'area', 'scatter', 'table', 'pivot', 'list', 'custom',
+] as const;
+
+/** Widget visualization type */
+export type DashboardWidgetType = (typeof DASHBOARD_WIDGET_TYPES)[number];
+
+/** Layout position for a single dashboard widget */
+export interface DashboardWidgetConfig {
+  /** Widget identifier */
+  id: string;
+  /** Widget title */
+  title?: string;
+  /** Widget description */
+  description?: string;
+  /** Visualization type */
+  type?: DashboardWidgetType;
+  /** Data source object name */
+  object?: string;
+  /** Filter conditions applied to widget data */
+  filter?: any[];
+  /** Category / x-axis field */
+  categoryField?: string;
+  /** Value / y-axis field */
+  valueField?: string;
+  /** Aggregation function (count, sum, avg, min, max) */
+  aggregate?: string;
+  /** Chart-specific configuration */
+  chartConfig?: any;
+  /** Color variant */
+  colorVariant?: DashboardColorVariant;
+  /** Grid layout position */
+  layout?: { x: number; y: number; w: number; h: number };
+  /** Clickable action URL */
+  actionUrl?: string;
+}
+
+/**
+ * Unified data model for dashboard configuration.
+ *
+ * Used by the DashboardConfigPanel for create/edit workflows.
+ * Mirrors the pattern of UnifiedViewConfig for view configuration.
+ */
+export interface DashboardConfig {
+  /** Dashboard identifier */
+  id?: string;
+  /** Display title */
+  title?: string;
+  /** Dashboard description */
+  description?: string;
+  /** Number of grid columns (default: 12) */
+  columns?: number;
+  /** Grid gap in pixels */
+  gap?: number;
+  /** Auto-refresh interval in seconds */
+  refreshInterval?: number;
+  /** Dashboard widgets */
+  widgets?: DashboardWidgetConfig[];
+
+  // -- Global filters --------------------------------------------------------
+
+  /** Global filter conditions applied across all widgets */
+  globalFilters?: any[];
+  /** Date range filter configuration */
+  dateRange?: {
+    enabled?: boolean;
+    field?: string;
+    presets?: string[];
+  };
+  /** User-selectable filter fields */
+  userFilters?: Array<{
+    field: string;
+    label?: string;
+    type?: string;
+  }>;
+
+  // -- Appearance ------------------------------------------------------------
+
+  /** Show dashboard header with title/description */
+  showHeader?: boolean;
+  /** Show global filter bar */
+  showFilters?: boolean;
+  /** Show date range picker */
+  showDateRange?: boolean;
+  /** Action buttons in dashboard header */
+  headerActions?: Array<{
+    label: string;
+    action?: string;
+    icon?: string;
+    variant?: string;
+  }>;
+
+  // -- Accessibility ---------------------------------------------------------
+
+  /** ARIA properties */
+  aria?: {
+    label?: string;
+    description?: string;
+  };
+
+  /** Catch-all for additional properties */
+  [key: string]: any;
 }
 
 // ============================================================================

package/src/index.ts

@@ -53,8 +53,18 @@
 export type {
   AppSchema,
   AppAction,
-  MenuItem as AppMenuItem
+  NavigationItem,
+  NavigationItemType,
+  NavigationArea,
+  MenuItem as AppMenuItem,
+  AppWizardStepId,
+  AppWizardStep,
+  BrandingConfig,
+  ObjectSelection,
+  AppWizardDraft,
+  EditorMode,
 } from './app';
+export { menuItemToNavigationItem, isValidAppName, wizardDraftToAppSchema } from './app';
 
 // ============================================================================
 // Base Types - The Foundation
@@ -147,6 +157,8 @@ export type {
   ChartType,
   ChartSeries,
   ChartSchema,
+  PivotAggregation,
+  PivotTableSchema,
   TimelineEvent,
   TimelineSchema,
   KbdSchema,
@@ -254,6 +266,8 @@ export type {
   ValidationError,
   APIError,
   FileUploadResult,
+  AggregateParams,
+  AggregateResult,
 } from './data';
 
 // ============================================================================
@@ -285,12 +299,23 @@ export type {
   KanbanConfig,
   CalendarConfig,
   GanttConfig,
+  ListViewGalleryConfig,
+  ListViewTimelineConfig,
   SortConfig,
+  // QuickFilter dual-format types
+  ObjectUIQuickFilterItem,
+  SpecQuickFilterItem,
+  QuickFilterItem,
+  // ConditionalFormatting dual-format types
+  ObjectUIConditionalFormattingRule,
+  SpecConditionalFormattingRule,
+  ConditionalFormattingRule,
   // Component schemas
   ObjectMapSchema,
   ObjectGanttSchema,
   ObjectCalendarSchema,
   ObjectKanbanSchema,
+  KanbanConditionalFormattingRule,
   ObjectChartSchema,
   ListViewSchema,
   ObjectGridSchema,
@@ -299,9 +324,23 @@ export type {
   ObjectViewSchema,
   NamedListView,
   ViewNavigationConfig,
+  ViewTabBarConfig,
   ObjectQLComponentSchema,
 } from './objectql';
 
+// ============================================================================
+// Record Components - Spec-aligned record:* page component props
+// ============================================================================
+export type {
+  RecordComponentAriaProps,
+  RecordDetailsComponentProps,
+  RecordHighlightsComponentProps,
+  RecordRelatedListComponentProps,
+  RecordActivityComponentProps,
+  RecordChatterComponentProps,
+  RecordPathComponentProps,
+} from './record-components';
+
 // ============================================================================
 // Field Types - ObjectQL Field Type System
 // ============================================================================
@@ -519,8 +558,18 @@ export type {
   CollaborationPresence,
   CollaborationOperation,
   CollaborationConfig,
-  ViewDesignerColumn,
-  ViewDesignerSchema,
+  ViewColumnConfig,
+  UnifiedViewType,
+  UnifiedViewConfig,
+  DashboardColorVariant,
+  DashboardWidgetType,
+  DashboardWidgetConfig,
+  DashboardConfig,
+} from './designer';
+
+export {
+  DASHBOARD_COLOR_VARIANTS,
+  DASHBOARD_WIDGET_TYPES,
 } from './designer';
 
 // ============================================================================
@@ -583,6 +632,7 @@ export type {
 export type {
   // Report System
   ReportSchema,
+  ReportType,
   ReportExportFormat,
   ReportScheduleFrequency,
   ReportAggregationType,
@@ -611,6 +661,20 @@ export type {
   ApprovalHistoryItem,
   ApprovalProcessSchema,
   WorkflowInstanceSchema,
+  // Flow Designer (spec v3.0.9)
+  FlowNodeType,
+  FlowWaitEventType,
+  FlowNodeExecutionStatus,
+  FlowNodeExecutorDescriptor,
+  FlowBoundaryConfig,
+  FlowNode,
+  FlowEdgeType,
+  FlowEdge,
+  FlowVersionEntry,
+  FlowConcurrencyPolicy,
+  FlowBpmnInteropResult,
+  FlowExecutionStep,
+  FlowDesignerSchema,
 } from './workflow';
 
 export type {
@@ -651,6 +715,17 @@ export type {
   FilterUISchema,
   SortUISchema,
   ViewComponentSchema,
+  CommentEntry,
+  MentionNotification,
+  CommentSearchResult,
+  ActivityEntry,
+  // Feed / Chatter Protocol Types
+  FeedItemType,
+  FeedItem,
+  FieldChangeEntry,
+  Mention,
+  Reaction,
+  RecordSubscription,
 } from './views';
 
 export type {
@@ -962,10 +1037,123 @@ export type {
   RowHeight,
   RowHeightSchema,
   DensityMode,
+  DensityModeSchema,
+  TimelineConfig,
+  TimelineConfigSchema,
+  NavigationConfig,
+  NavigationConfigSchema,
   ViewSharing,
   ViewSharingSchema,
 } from '@objectstack/spec/ui';
 
+// ============================================================================
+// v3.0.8 Spec UI Types — Dashboard (P1.3)
+// ============================================================================
+export type {
+  Dashboard as SpecDashboard,
+  DashboardSchema as SpecDashboardSchema,
+  DashboardWidget as SpecDashboardWidget,
+  DashboardWidgetSchema as SpecDashboardWidgetSchema,
+  DashboardHeader as SpecDashboardHeader,
+  DashboardHeaderSchema as SpecDashboardHeaderSchema,
+  DashboardHeaderAction as SpecDashboardHeaderAction,
+  DashboardHeaderActionSchema as SpecDashboardHeaderActionSchema,
+  GlobalFilter as SpecGlobalFilter,
+  GlobalFilterSchema as SpecGlobalFilterSchema,
+  GlobalFilterOptionsFrom,
+  GlobalFilterOptionsFromSchema,
+  WidgetMeasure,
+  WidgetMeasureSchema,
+  WidgetColorVariant,
+  WidgetColorVariantSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — Sharing & Embedding (P2.3)
+// ============================================================================
+export type {
+  SharingConfig,
+  SharingConfigSchema,
+  EmbedConfig,
+  EmbedConfigSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — View Configuration (P2.4)
+// ============================================================================
+export type {
+  AddRecordConfig,
+  AddRecordConfigSchema,
+  AppearanceConfig,
+  AppearanceConfigSchema,
+  UserActionsConfig,
+  UserActionsConfigSchema,
+  ViewTab,
+  ViewTabSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.10 Spec UI Types — View Filter Rules
+// ============================================================================
+export type {
+  ViewFilterRule,
+  ViewFilterRuleSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — Form View (P1.2)
+// ============================================================================
+export type {
+  FormView as SpecFormView,
+  FormViewSchema as SpecFormViewSchema,
+  FormSection as SpecFormSection,
+  FormSectionSchema as SpecFormSectionSchema,
+  FormField as SpecFormField,
+  FormFieldSchema as SpecFormFieldSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — ListView (P1.1)
+// ============================================================================
+export type {
+  ListView as SpecListView,
+  ListViewSchema as SpecListViewSchema,
+  ListColumn as SpecListColumn,
+  ListColumnSchema as SpecListColumnSchema,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — Record Components (P1.5)
+// ============================================================================
+export type {
+  RecordDetailsProps as SpecRecordDetailsProps,
+  RecordHighlightsProps as SpecRecordHighlightsProps,
+  RecordRelatedListProps as SpecRecordRelatedListProps,
+  RecordActivityProps as SpecRecordActivityProps,
+  RecordChatterProps as SpecRecordChatterProps,
+  RecordPathProps as SpecRecordPathProps,
+} from '@objectstack/spec/ui';
+
+// ============================================================================
+// v3.0.8 Spec UI Types — Page (P1.4)
+// ============================================================================
+export type {
+  Page as SpecPage,
+  PageSchema as SpecPageSchema,
+  PageComponent as SpecPageComponent,
+  PageComponentSchema as SpecPageComponentSchema,
+  PageRegion as SpecPageRegion,
+  PageRegionSchema as SpecPageRegionSchema,
+  PageType as SpecPageType,
+  PageTypeSchema as SpecPageTypeSchema,
+  PageVariable as SpecPageVariable,
+  PageVariableSchema as SpecPageVariableSchema,
+  BlankPageLayout,
+  BlankPageLayoutSchema,
+  BlankPageLayoutItem,
+  BlankPageLayoutItemSchema,
+} from '@objectstack/spec/ui';
+
 // ============================================================================
 // v2.0.7 Spec UI Types — Performance & Page Transitions
 // ============================================================================
@@ -984,6 +1172,7 @@ export type {
   AriaProps,
   AriaPropsSchema,
   WcagContrastLevel,
+  WcagContrastLevelSchema,
 } from '@objectstack/spec/ui';
 
 // ============================================================================

package/src/layout.ts

@@ -429,7 +429,23 @@ export interface AspectRatioSchema extends BaseSchema {
  * Determines page behavior and default layout template.
  * Aligned with @objectstack/spec Page.type
  */
-export type PageType = 'record' | 'home' | 'app' | 'utility';
+export type PageType =
+  | 'record'
+  | 'home'
+  | 'app'
+  | 'utility'
+  | 'dashboard'
+  | 'grid'
+  | 'list'
+  | 'gallery'
+  | 'kanban'
+  | 'calendar'
+  | 'timeline'
+  | 'form'
+  | 'record_detail'
+  | 'record_review'
+  | 'overview'
+  | 'blank';
 
 /**
  * Page Variable
@@ -440,9 +456,11 @@ export interface PageVariable {
   /** Variable name */
   name: string;
   /** Variable type @default 'string' */
-  type?: 'string' | 'number' | 'boolean' | 'object' | 'array';
+  type?: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'record_id';
   /** Default value for initialization */
   defaultValue?: any;
+  /** Variable data source (e.g. URL param, context, expression) */
+  source?: string;
 }
 
 /**
@@ -522,6 +540,32 @@ export interface PageSchema extends BaseSchema {
    * (Aligned with @objectstack/spec Page.regions)
    */
   regions?: PageRegion[];
+  /**
+   * Blank page grid layout
+   * Used when pageType is 'blank' for free-form grid canvas.
+   * Aligned with @objectstack/spec BlankPageLayoutSchema.
+   */
+  blankLayout?: {
+    /** Number of grid columns */
+    columns?: number;
+    /** Row height in pixels */
+    rowHeight?: number;
+    /** Gap between grid items in pixels */
+    gap?: number;
+    /** Items placed on the grid */
+    items?: Array<{
+      /** Component ID reference */
+      componentId: string;
+      /** Grid column position */
+      x: number;
+      /** Grid row position */
+      y: number;
+      /** Width in grid columns */
+      width: number;
+      /** Height in grid rows */
+      height: number;
+    }>;
+  };
   /**
    * Main content array (Legacy/Simple mode)
    */
@@ -539,6 +583,15 @@ export interface PageSchema extends BaseSchema {
    * Profiles that can access this page
    */
   assignedProfiles?: string[];
+  /**
+   * ARIA accessibility attributes.
+   * Aligned with @objectstack/spec AriaPropsSchema.
+   */
+  aria?: {
+    ariaLabel?: string;
+    ariaDescribedBy?: string;
+    role?: string;
+  };
 }
 
 /**