@object-ui/types 0.3.1 → 2.0.0

package/dist/permissions.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 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 - Permission & RBAC Types
+ *
+ * Complete RBAC (Role-Based Access Control) type definitions for
+ * object/field/row-level permissions aligned with @objectstack/spec v2.0.1.
+ *
+ * @module permissions
+ * @packageDocumentation
+ */
+/** Standard CRUD permission actions */
+export type PermissionAction = 'create' | 'read' | 'update' | 'delete' | 'export' | 'import' | 'share' | 'admin';
+/** Permission effect */
+export type PermissionEffect = 'allow' | 'deny';
+/** Role definition for RBAC */
+export interface RoleDefinition {
+    /** Unique role identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Role description */
+    description?: string;
+    /** Parent role for inheritance */
+    inherits?: string[];
+    /** Whether this is a system role */
+    system?: boolean;
+    /** Object-level permissions */
+    permissions: ObjectLevelPermission[];
+}
+/** Object-level permission assignment */
+export interface ObjectLevelPermission {
+    /** Target object name */
+    object: string;
+    /** Allowed actions */
+    actions: PermissionAction[];
+    /** Permission effect */
+    effect?: PermissionEffect;
+    /** Conditions for conditional permissions */
+    conditions?: PermissionCondition[];
+}
+/** Field-level permission */
+export interface FieldLevelPermission {
+    /** Target field name */
+    field: string;
+    /** Read permission */
+    read?: boolean;
+    /** Write permission */
+    write?: boolean;
+    /** Permission effect */
+    effect?: PermissionEffect;
+    /** Mask value for restricted fields (e.g., '****' for SSN) */
+    mask?: string;
+}
+/** Row-level permission (record-level security) */
+export interface RowLevelPermission {
+    /** Filter expression to scope visible records */
+    filter: string;
+    /** Actions allowed on matching records */
+    actions: PermissionAction[];
+    /** Description of the rule */
+    description?: string;
+}
+/** Permission condition for conditional access */
+export interface PermissionCondition {
+    /** Field to evaluate */
+    field: string;
+    /** Comparison operator */
+    operator: 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'contains' | 'is_null' | 'is_not_null';
+    /** Value to compare */
+    value: unknown;
+}
+/** Complete permission configuration for an object */
+export interface ObjectPermissionConfig {
+    /** Object name */
+    object: string;
+    /** Default permissions for unauthenticated users */
+    publicAccess?: PermissionAction[];
+    /** Role-based permissions */
+    roles: Record<string, {
+        actions: PermissionAction[];
+        fieldPermissions?: FieldLevelPermission[];
+        rowPermissions?: RowLevelPermission[];
+    }>;
+    /** Field-level permission defaults */
+    fieldDefaults?: FieldLevelPermission[];
+    /** Sharing rules */
+    sharingRules?: SharingRuleConfig[];
+}
+/** Sharing rule configuration */
+export interface SharingRuleConfig {
+    /** Rule name */
+    name: string;
+    /** Share with type */
+    type: 'role' | 'user' | 'group' | 'public';
+    /** Target entity (role name, user ID, group name) */
+    entity: string;
+    /** Permitted actions */
+    actions: PermissionAction[];
+    /** Filter to scope which records are shared */
+    filter?: string;
+}
+/** Permission check result */
+export interface PermissionCheckResult {
+    /** Whether the action is allowed */
+    allowed: boolean;
+    /** Reason for denial */
+    reason?: string;
+    /** Applicable field restrictions */
+    fieldRestrictions?: FieldLevelPermission[];
+    /** Row filter to apply */
+    rowFilter?: string;
+}
+/** Permission context for evaluating permissions */
+export interface PermissionContext {
+    /** Current user */
+    user: {
+        id: string;
+        roles: string[];
+        groups?: string[];
+        [key: string]: unknown;
+    };
+    /** Target object */
+    object: string;
+    /** Target action */
+    action: PermissionAction;
+    /** Target record (for row-level checks) */
+    record?: Record<string, unknown>;
+    /** Target field (for field-level checks) */
+    field?: string;
+}
+/** Permission guard configuration for UI components */
+export interface PermissionGuardConfig {
+    /** Required permission */
+    permission: string | PermissionAction;
+    /** Target object */
+    object?: string;
+    /** Fallback behavior when denied */
+    fallback?: 'hide' | 'disable' | 'redirect' | 'custom';
+    /** Custom fallback component type */
+    fallbackComponent?: string;
+    /** Redirect path for 'redirect' fallback */
+    redirectPath?: string;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/dist/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAMH,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;AAEjH,wBAAwB;AACxB,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAC;AAEhD,+BAA+B;AAC/B,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,oCAAoC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,+BAA+B;IAC/B,WAAW,EAAE,qBAAqB,EAAE,CAAC;CACtC;AAED,yCAAyC;AACzC,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,wBAAwB;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,6CAA6C;IAC7C,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACpC;AAED,6BAA6B;AAC7B,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,uBAAuB;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wBAAwB;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mDAAmD;AACnD,MAAM,WAAW,kBAAkB;IACjC,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,EAAE,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,CAAC;IAChH,uBAAuB;IACvB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,sBAAsB;IACrC,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;QACpB,OAAO,EAAE,gBAAgB,EAAE,CAAC;QAC5B,gBAAgB,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC1C,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAC;KACvC,CAAC,CAAC;IACH,sCAAsC;IACtC,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACvC,oBAAoB;IACpB,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACpC;AAED,iCAAiC;AACjC,MAAM,WAAW,iBAAiB;IAChC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC3C,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,8BAA8B;AAC9B,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAC3C,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,MAAM,EAAE,gBAAgB,CAAC;IACzB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACtC,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;IACtD,qCAAqC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/permissions.js

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+export {};

package/dist/plugin-scope.d.ts

@@ -0,0 +1,194 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=plugin-scope.d.ts.map

package/dist/plugin-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-scope.d.ts","sourceRoot":"","sources":["../src/plugin-scope.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAEtF;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAAC;IAE3D;;;;;;;;;OASG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtC;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAAC;IAEjE;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,EAAE,CAAC;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/plugin-scope.js

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+export {};

package/dist/reports.d.ts

@@ -0,0 +1,336 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=reports.d.ts.map