@object-ui/types 0.3.0 → 0.5.0

package/src/overlay.ts

@@ -1,3 +1,11 @@
+/**
+ * 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 - Overlay Component Schemas
  * 
@@ -403,6 +411,31 @@ export interface ContextMenuSchema extends BaseSchema {
   children: SchemaNode | SchemaNode[];
 }
 
+/**
+ * Menubar menu
+ */
+export interface MenubarMenu {
+  /**
+   * Menu label
+   */
+  label: string;
+  /**
+   * Menu items
+   */
+  items: MenuItem[];
+}
+
+/**
+ * Menubar component
+ */
+export interface MenubarSchema extends BaseSchema {
+  type: 'menubar';
+  /**
+   * Menubar menus
+   */
+  menus?: MenubarMenu[];
+}
+
 /**
  * Union type of all overlay schemas
  */
@@ -415,4 +448,5 @@ export type OverlaySchema =
   | TooltipSchema
   | HoverCardSchema
   | DropdownMenuSchema
-  | ContextMenuSchema;
+  | ContextMenuSchema
+  | MenubarSchema;

package/src/plugin-scope.ts

@@ -0,0 +1,210 @@
+/**
+ * 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 - Plugin Scope Isolation
+ * 
+ * Section 3.3: Plugin scope isolation types to prevent conflicts between plugins.
+ * Provides scoped component registration, state management, and event bus.
+ * 
+ * @module plugin-scope
+ * @packageDocumentation
+ */
+
+/**
+ * Plugin Scope Interface
+ * 
+ * Provides isolated access to the component registry, state management,
+ * and event bus for a specific plugin, preventing conflicts between plugins.
+ */
+export interface PluginScope {
+  /**
+   * Plugin name
+   */
+  name: string;
+  
+  /**
+   * Plugin version
+   */
+  version: string;
+  
+  /**
+   * Register a component in the scoped namespace.
+   * Components will be registered as "pluginName:type" to prevent conflicts.
+   * 
+   * @param type - Component type identifier (e.g., 'table', 'chart')
+   * @param component - Component renderer
+   * @param meta - Optional component metadata
+   * 
+   * @example
+   * // Plugin 'my-grid' registers a 'table' component
+   * // Registered as 'my-grid:table'
+   * scope.registerComponent('table', TableComponent, {
+   *   label: 'Data Table',
+   *   category: 'data'
+   * });
+   */
+  registerComponent(type: string, component: any, meta?: ComponentMeta): void;
+  
+  /**
+   * Get a component from the scoped namespace.
+   * First tries scoped lookup (pluginName:type), then falls back to global.
+   * 
+   * @param type - Component type identifier
+   * @returns Component renderer or undefined if not found
+   */
+  getComponent(type: string): any | undefined;
+  
+  /**
+   * Scoped state management.
+   * Each plugin has its own isolated state that won't conflict with others.
+   * 
+   * @param key - State key unique to this plugin
+   * @param initialValue - Initial state value
+   * @returns Tuple of [currentValue, setValue]
+   * 
+   * @example
+   * const [config, setConfig] = scope.useState('config', { theme: 'light' });
+   */
+  useState<T>(key: string, initialValue: T): [T, (value: T | ((prev: T) => T)) => void];
+  
+  /**
+   * Get scoped state value without setter.
+   * 
+   * @param key - State key
+   * @returns Current state value or undefined
+   */
+  getState<T>(key: string): T | undefined;
+  
+  /**
+   * Set scoped state value directly.
+   * 
+   * @param key - State key
+   * @param value - New state value
+   */
+  setState<T>(key: string, value: T): void;
+  
+  /**
+   * Subscribe to scoped events.
+   * Events are namespaced to prevent cross-plugin conflicts.
+   * 
+   * @param event - Event name (will be prefixed with plugin namespace)
+   * @param handler - Event handler function
+   * @returns Unsubscribe function
+   * 
+   * @example
+   * const unsubscribe = scope.on('data-updated', (data) => {
+   *   console.log('Scoped event received:', data);
+   * });
+   */
+  on(event: string, handler: PluginEventHandler): () => void;
+  
+  /**
+   * Emit a scoped event.
+   * Only subscribers within this plugin scope will receive it.
+   * 
+   * @param event - Event name
+   * @param data - Event data
+   * 
+   * @example
+   * scope.emit('data-updated', { rows: 100 });
+   */
+  emit(event: string, data?: any): void;
+  
+  /**
+   * Emit a global event that all plugins can receive.
+   * Use sparingly for cross-plugin communication.
+   * 
+   * @param event - Event name
+   * @param data - Event data
+   */
+  emitGlobal(event: string, data?: any): void;
+  
+  /**
+   * Subscribe to global events from any plugin.
+   * 
+   * @param event - Event name
+   * @param handler - Event handler function
+   * @returns Unsubscribe function
+   */
+  onGlobal(event: string, handler: PluginEventHandler): () => void;
+  
+  /**
+   * Clean up all plugin resources (state, event listeners, etc.)
+   * Called automatically when plugin is unloaded.
+   */
+  cleanup(): void;
+}
+
+/**
+ * Component metadata for registration
+ */
+export interface ComponentMeta {
+  label?: string;
+  icon?: string;
+  category?: string;
+  inputs?: ComponentInput[];
+  defaultProps?: Record<string, any>;
+  defaultChildren?: any[];
+  examples?: Record<string, any>;
+  isContainer?: boolean;
+  resizable?: boolean;
+  resizeConstraints?: {
+    width?: boolean;
+    height?: boolean;
+    minWidth?: number;
+    maxWidth?: number;
+    minHeight?: number;
+    maxHeight?: number;
+  };
+}
+
+/**
+ * Component input definition
+ */
+export interface ComponentInput {
+  name: string;
+  type: 'string' | 'number' | 'boolean' | 'enum' | 'array' | 'object' | 'color' | 'date' | 'code' | 'file' | 'slot';
+  label?: string;
+  defaultValue?: any;
+  required?: boolean;
+  enum?: string[] | { label: string; value: any }[];
+  description?: string;
+  advanced?: boolean;
+  inputType?: string;
+}
+
+/**
+ * Event handler type
+ */
+export type PluginEventHandler = (data?: any) => void;
+
+/**
+ * Plugin scope configuration
+ */
+export interface PluginScopeConfig {
+  /**
+   * Whether to enable state isolation (default: true)
+   */
+  enableStateIsolation?: boolean;
+  
+  /**
+   * Whether to enable event isolation (default: true)
+   */
+  enableEventIsolation?: boolean;
+  
+  /**
+   * Whether to allow global event access (default: true)
+   */
+  allowGlobalEvents?: boolean;
+  
+  /**
+   * Maximum state size per plugin in bytes (default: 5MB)
+   */
+  maxStateSize?: number;
+}

package/src/registry.ts

@@ -1,3 +1,11 @@
+/**
+ * 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.
+ */
+
 import type {
   DivSchema,
   SpanSchema,

package/src/reports.ts

@@ -0,0 +1,408 @@
+/**
+ * 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 - Report Schema
+ * 
+ * Defines report configuration for data aggregation, visualization, and export.
+ */
+
+import type { BaseSchema, SchemaNode } from './base';
+import type { ChartSchema } from './data-display';
+import type { DataSource } from './data';
+
+/**
+ * Report Export Format
+ */
+export type ReportExportFormat = 'pdf' | 'excel' | 'csv' | 'json' | 'html';
+
+/**
+ * Report Schedule Frequency
+ */
+export type ReportScheduleFrequency = 'once' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly';
+
+/**
+ * Report Aggregation Type
+ */
+export type ReportAggregationType = 'sum' | 'avg' | 'min' | 'max' | 'count' | 'distinct';
+
+/**
+ * Report Field Definition
+ */
+export interface ReportField {
+  /**
+   * Field name/identifier
+   */
+  name: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Field type
+   */
+  type?: 'string' | 'number' | 'date' | 'boolean';
+
+  /**
+   * Aggregation function
+   */
+  aggregation?: ReportAggregationType;
+
+  /**
+   * Format string
+   */
+  format?: string;
+
+  /**
+   * Show in summary
+   */
+  showInSummary?: boolean;
+
+  /**
+   * Sort order
+   */
+  sortOrder?: number;
+}
+
+/**
+ * Report Filter Definition
+ */
+export interface ReportFilter {
+  /**
+   * Field to filter on
+   */
+  field: string;
+
+  /**
+   * Filter operator
+   */
+  operator: 'equals' | 'not_equals' | 'contains' | 'greater_than' | 'less_than' | 'between' | 'in' | 'not_in';
+
+  /**
+   * Filter value
+   */
+  value?: any;
+
+  /**
+   * Multiple values (for 'in' operator)
+   */
+  values?: any[];
+}
+
+/**
+ * Report Group By Definition
+ */
+export interface ReportGroupBy {
+  /**
+   * Field to group by
+   */
+  field: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Sort direction
+   */
+  sort?: 'asc' | 'desc';
+}
+
+/**
+ * Report Section Definition
+ */
+export interface ReportSection {
+  /**
+   * Section type
+   */
+  type: 'header' | 'summary' | 'chart' | 'table' | 'text' | 'page-break';
+
+  /**
+   * Section title
+   */
+  title?: string;
+
+  /**
+   * Section content
+   */
+  content?: SchemaNode | SchemaNode[];
+
+  /**
+   * Chart configuration (for type='chart')
+   */
+  chart?: ChartSchema;
+
+  /**
+   * Columns to display (for type='table')
+   */
+  columns?: ReportField[];
+
+  /**
+   * Text content (for type='text')
+   */
+  text?: string;
+
+  /**
+   * Visibility condition
+   */
+  visible?: boolean | string;
+}
+
+/**
+ * Report Schedule Configuration
+ */
+export interface ReportSchedule {
+  /**
+   * Schedule enabled
+   */
+  enabled?: boolean;
+
+  /**
+   * Frequency
+   */
+  frequency?: ReportScheduleFrequency;
+
+  /**
+   * Specific day of week (for weekly)
+   */
+  dayOfWeek?: number;
+
+  /**
+   * Specific day of month (for monthly)
+   */
+  dayOfMonth?: number;
+
+  /**
+   * Time to run (HH:mm format)
+   */
+  time?: string;
+
+  /**
+   * Timezone
+   */
+  timezone?: string;
+
+  /**
+   * Email recipients
+   */
+  recipients?: string[];
+
+  /**
+   * Email subject
+   */
+  subject?: string;
+
+  /**
+   * Email body
+   */
+  body?: string;
+
+  /**
+   * Export formats to attach
+   */
+  formats?: ReportExportFormat[];
+}
+
+/**
+ * Report Export Configuration
+ */
+export interface ReportExportConfig {
+  /**
+   * Export format
+   */
+  format: ReportExportFormat;
+
+  /**
+   * Filename template
+   */
+  filename?: string;
+
+  /**
+   * Include headers
+   */
+  includeHeaders?: boolean;
+
+  /**
+   * Page orientation (for PDF)
+   */
+  orientation?: 'portrait' | 'landscape';
+
+  /**
+   * Page size (for PDF)
+   */
+  pageSize?: 'A4' | 'A3' | 'Letter' | 'Legal';
+
+  /**
+   * Custom options
+   */
+  options?: Record<string, any>;
+}
+
+/**
+ * Report Schema - Main report configuration
+ */
+export interface ReportSchema extends BaseSchema {
+  type: 'report';
+
+  /**
+   * Report title
+   */
+  title?: string;
+
+  /**
+   * Report description
+   */
+  description?: string;
+
+  /**
+   * Data source configuration
+   */
+  dataSource?: DataSource;
+
+  /**
+   * Report fields
+   */
+  fields?: ReportField[];
+
+  /**
+   * Report filters
+   */
+  filters?: ReportFilter[];
+
+  /**
+   * Group by configuration
+   */
+  groupBy?: ReportGroupBy[];
+
+  /**
+   * Report sections
+   */
+  sections?: ReportSection[];
+
+  /**
+   * Schedule configuration
+   */
+  schedule?: ReportSchedule;
+
+  /**
+   * Default export format
+   */
+  defaultExportFormat?: ReportExportFormat;
+
+  /**
+   * Export configurations
+   */
+  exportConfigs?: Record<ReportExportFormat, ReportExportConfig>;
+
+  /**
+   * Show export buttons
+   */
+  showExportButtons?: boolean;
+
+  /**
+   * Show print button
+   */
+  showPrintButton?: boolean;
+
+  /**
+   * Show schedule button
+   */
+  showScheduleButton?: boolean;
+
+  /**
+   * Auto-refresh interval (in seconds)
+   */
+  refreshInterval?: number;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Report data
+   */
+  data?: any[];
+}
+
+/**
+ * Report Builder Schema - Interactive report builder component
+ */
+export interface ReportBuilderSchema extends BaseSchema {
+  type: 'report-builder';
+
+  /**
+   * Initial report configuration
+   */
+  report?: ReportSchema;
+
+  /**
+   * Available data sources
+   */
+  dataSources?: DataSource[];
+
+  /**
+   * Available fields
+   */
+  availableFields?: ReportField[];
+
+  /**
+   * Show preview
+   */
+  showPreview?: boolean;
+
+  /**
+   * Save callback
+   */
+  onSave?: string;
+
+  /**
+   * Cancel callback
+   */
+  onCancel?: string;
+}
+
+/**
+ * Report Viewer Schema - Display a generated report
+ */
+export interface ReportViewerSchema extends BaseSchema {
+  type: 'report-viewer';
+
+  /**
+   * Report to display
+   */
+  report?: ReportSchema;
+
+  /**
+   * Report data
+   */
+  data?: any[];
+
+  /**
+   * Show toolbar
+   */
+  showToolbar?: boolean;
+
+  /**
+   * Allow export
+   */
+  allowExport?: boolean;
+
+  /**
+   * Allow print
+   */
+  allowPrint?: boolean;
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+}