@object-ui/types 0.3.1 → 2.0.0

package/dist/views.d.ts

@@ -0,0 +1,427 @@
+/**
+ * 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 - View Component Schemas
+ *
+ * Type definitions for various view components (List, Detail, Grid, Kanban, Calendar).
+ * These schemas enable building different data visualization interfaces.
+ *
+ * @module views
+ * @packageDocumentation
+ */
+import type { BaseSchema, SchemaNode } from './base';
+import type { ActionSchema } from './crud';
+import type { TableColumn } from './data-display';
+/**
+ * View Type
+ */
+export type ViewType = 'list' | 'detail' | 'grid' | 'kanban' | 'calendar' | 'timeline' | 'map';
+/**
+ * Detail View Field Configuration
+ */
+export interface DetailViewField {
+    /**
+     * Field name/path
+     */
+    name: string;
+    /**
+     * Display label
+     */
+    label?: string;
+    /**
+     * Field type for rendering
+     */
+    type?: 'text' | 'image' | 'link' | 'badge' | 'date' | 'datetime' | 'json' | 'html' | 'markdown' | 'custom';
+    /**
+     * Format string (e.g., date format)
+     */
+    format?: string;
+    /**
+     * Custom renderer
+     */
+    render?: SchemaNode;
+    /**
+     * Field value
+     */
+    value?: any;
+    /**
+     * Whether field is read-only
+     */
+    readonly?: boolean;
+    /**
+     * Field visibility condition
+     */
+    visible?: boolean | string;
+    /**
+     * Span across columns (for grid layout)
+     */
+    span?: number;
+}
+/**
+ * Detail View Section/Group
+ */
+export interface DetailViewSection {
+    /**
+     * Section title
+     */
+    title?: string;
+    /**
+     * Section description
+     */
+    description?: string;
+    /**
+     * Section icon
+     */
+    icon?: string;
+    /**
+     * Fields in this section
+     */
+    fields: DetailViewField[];
+    /**
+     * Collapsible section
+     */
+    collapsible?: boolean;
+    /**
+     * Default collapsed state
+     */
+    defaultCollapsed?: boolean;
+    /**
+     * Grid columns for field layout
+     */
+    columns?: number;
+    /**
+     * Section visibility condition
+     */
+    visible?: boolean | string;
+}
+/**
+ * Detail View Tab
+ */
+export interface DetailViewTab {
+    /**
+     * Tab key/identifier
+     */
+    key: string;
+    /**
+     * Tab label
+     */
+    label: string;
+    /**
+     * Tab icon
+     */
+    icon?: string;
+    /**
+     * Tab content
+     */
+    content: SchemaNode | SchemaNode[];
+    /**
+     * Tab visibility condition
+     */
+    visible?: boolean | string;
+    /**
+     * Badge count
+     */
+    badge?: string | number;
+}
+/**
+ * Detail View Schema - Display detailed information about a single record
+ * Enhanced in Phase 2 with better organization and features
+ */
+export interface DetailViewSchema extends BaseSchema {
+    type: 'detail-view';
+    /**
+     * Detail title
+     */
+    title?: string;
+    /**
+     * API endpoint to fetch detail data
+     */
+    api?: string;
+    /**
+     * Resource ID to display
+     */
+    resourceId?: string | number;
+    /**
+     * Object name (for ObjectQL integration)
+     */
+    objectName?: string;
+    /**
+     * Data to display (if not fetching from API)
+     */
+    data?: any;
+    /**
+     * Layout mode
+     */
+    layout?: 'vertical' | 'horizontal' | 'grid';
+    /**
+     * Grid columns (for grid layout)
+     */
+    columns?: number;
+    /**
+     * Field sections for organized display
+     */
+    sections?: DetailViewSection[];
+    /**
+     * Direct fields (without sections)
+     */
+    fields?: DetailViewField[];
+    /**
+     * Actions available in detail view
+     */
+    actions?: ActionSchema[];
+    /**
+     * Tabs for additional content
+     */
+    tabs?: DetailViewTab[];
+    /**
+     * Show back button
+     * @default true
+     */
+    showBack?: boolean;
+    /**
+     * Back button URL
+     */
+    backUrl?: string;
+    /**
+     * Custom back action
+     */
+    onBack?: string;
+    /**
+     * Show edit button
+     */
+    showEdit?: boolean;
+    /**
+     * Edit button URL
+     */
+    editUrl?: string;
+    /**
+     * Show delete button
+     */
+    showDelete?: boolean;
+    /**
+     * Delete confirmation message
+     */
+    deleteConfirmation?: string;
+    /**
+     * Whether to show loading state
+     * @default true
+     */
+    loading?: boolean;
+    /**
+     * Custom header content
+     */
+    header?: SchemaNode;
+    /**
+     * Custom footer content
+     */
+    footer?: SchemaNode;
+    /**
+     * Navigation handler for SPA-aware routing.
+     * Called instead of window.location.href for back/edit navigation.
+     * @param url - The URL to navigate to
+     * @param options - Navigation options (replace, newTab, etc.)
+     */
+    onNavigate?: (url: string, options?: {
+        replace?: boolean;
+        newTab?: boolean;
+    }) => void;
+    /**
+     * Related records section
+     */
+    related?: Array<{
+        /**
+         * Relation title
+         */
+        title: string;
+        /**
+         * Relation type
+         */
+        type: 'list' | 'grid' | 'table';
+        /**
+         * API endpoint for related data
+         */
+        api?: string;
+        /**
+         * Static data
+         */
+        data?: any[];
+        /**
+         * Columns for table view
+         */
+        columns?: TableColumn[];
+        /**
+         * Fields for list view
+         */
+        fields?: string[];
+    }>;
+}
+/**
+ * View Switcher Schema - Toggle between different view modes
+ * New in Phase 2
+ */
+export interface ViewSwitcherSchema extends BaseSchema {
+    type: 'view-switcher';
+    /**
+     * Available view types
+     */
+    views: Array<{
+        /**
+         * View type
+         */
+        type: ViewType;
+        /**
+         * View label
+         */
+        label?: string;
+        /**
+         * View icon
+         */
+        icon?: string;
+        /**
+         * View schema
+         */
+        schema?: SchemaNode;
+    }>;
+    /**
+     * Default/active view
+     */
+    defaultView?: ViewType;
+    /**
+     * Current active view
+     */
+    activeView?: ViewType;
+    /**
+     * Switcher variant
+     */
+    variant?: 'tabs' | 'buttons' | 'dropdown';
+    /**
+     * Switcher position
+     */
+    position?: 'top' | 'bottom' | 'left' | 'right';
+    /**
+     * View change callback
+     */
+    onViewChange?: string;
+    /**
+     * Persist view preference
+     */
+    persistPreference?: boolean;
+    /**
+     * Storage key for persisting view
+     */
+    storageKey?: string;
+}
+/**
+ * Filter UI Schema - Enhanced filter interface
+ * New in Phase 2
+ */
+export interface FilterUISchema extends BaseSchema {
+    type: 'filter-ui';
+    /**
+     * Available filters
+     */
+    filters: Array<{
+        /**
+         * Filter field
+         */
+        field: string;
+        /**
+         * Filter label
+         */
+        label?: string;
+        /**
+         * Filter type
+         */
+        type: 'text' | 'number' | 'select' | 'date' | 'date-range' | 'boolean';
+        /**
+         * Filter operator
+         */
+        operator?: 'equals' | 'contains' | 'startsWith' | 'gt' | 'lt' | 'between' | 'in';
+        /**
+         * Options for select filter
+         */
+        options?: Array<{
+            label: string;
+            value: any;
+        }>;
+        /**
+         * Placeholder
+         */
+        placeholder?: string;
+    }>;
+    /**
+     * Current filter values
+     */
+    values?: Record<string, any>;
+    /**
+     * Filter change callback
+     */
+    onChange?: string;
+    /**
+     * Show clear button
+     */
+    showClear?: boolean;
+    /**
+     * Show apply button
+     */
+    showApply?: boolean;
+    /**
+     * Filter layout
+     */
+    layout?: 'inline' | 'popover' | 'drawer';
+}
+/**
+ * Sort UI Schema - Enhanced sort interface
+ * New in Phase 2
+ */
+export interface SortUISchema extends BaseSchema {
+    type: 'sort-ui';
+    /**
+     * Sortable fields
+     */
+    fields: Array<{
+        /**
+         * Field name
+         */
+        field: string;
+        /**
+         * Field label
+         */
+        label?: string;
+    }>;
+    /**
+     * Current sort configuration
+     */
+    sort?: Array<{
+        /**
+         * Field to sort by
+         */
+        field: string;
+        /**
+         * Sort direction
+         */
+        direction: 'asc' | 'desc';
+    }>;
+    /**
+     * Sort change callback
+     */
+    onChange?: string;
+    /**
+     * Allow multiple sort fields
+     */
+    multiple?: boolean;
+    /**
+     * UI variant
+     */
+    variant?: 'dropdown' | 'buttons';
+}
+/**
+ * Union type of all view schemas
+ */
+export type ViewComponentSchema = DetailViewSchema | ViewSwitcherSchema | FilterUISchema | SortUISchema;
+//# sourceMappingURL=views.d.ts.map

package/dist/views.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../src/views.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,KAAK,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;IAC3G;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;IACtF;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;QACd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAChC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QACxB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;QACX;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QACf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC;KACrB,CAAC,CAAC;IACH;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;IAC/C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QACb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;QACvE;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC;QACjF;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,GAAG,CAAA;SAAE,CAAC,CAAC;QAC/C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;IACH;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;QACX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC;KAC3B,CAAC,CAAC;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,YAAY,CAAC"}

package/dist/views.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/widget.d.ts

@@ -0,0 +1,181 @@
+/**
+ * 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 - Widget Manifest & Registry Types
+ *
+ * Defines the WidgetManifest interface for runtime widget registration,
+ * plugin auto-discovery from server metadata, and custom widget registry
+ * for user-defined components.
+ *
+ * @module widget
+ * @packageDocumentation
+ */
+/**
+ * Widget manifest describing a runtime-loadable widget.
+ *
+ * A manifest provides all metadata needed to discover, load, and render
+ * a widget without requiring an upfront import of its code.
+ *
+ * @example
+ * ```ts
+ * const manifest: WidgetManifest = {
+ *   name: 'custom-chart',
+ *   version: '1.0.0',
+ *   type: 'chart',
+ *   label: 'Custom Chart Widget',
+ *   description: 'A custom chart powered by D3.',
+ *   category: 'data-visualization',
+ *   icon: 'BarChart',
+ *   source: { type: 'module', url: '/widgets/custom-chart.js' },
+ * };
+ * ```
+ */
+export interface WidgetManifest {
+    /** Unique widget identifier (e.g., 'custom-chart', 'org.acme.table') */
+    name: string;
+    /** Semver version string */
+    version: string;
+    /** Component type key used for schema rendering (e.g., 'chart', 'grid') */
+    type: string;
+    /** Human-readable label for the widget */
+    label: string;
+    /** Short description of the widget */
+    description?: string;
+    /** Category for grouping in the designer palette */
+    category?: string;
+    /** Icon name (Lucide icon name) or SVG string */
+    icon?: string;
+    /** Thumbnail image URL for the designer palette */
+    thumbnail?: string;
+    /** Widget loading source configuration */
+    source: WidgetSource;
+    /** Required peer dependencies (e.g., { 'react': '^18.0.0' }) */
+    peerDependencies?: Record<string, string>;
+    /** Dependencies on other widgets by name */
+    dependencies?: string[];
+    /** Default props to apply when the widget is first dropped in the designer */
+    defaultProps?: Record<string, unknown>;
+    /** Input schema for the widget's configurable properties */
+    inputs?: WidgetInput[];
+    /** Whether the widget can contain child components */
+    isContainer?: boolean;
+    /** Widget capabilities */
+    capabilities?: WidgetCapabilities;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Describes how to load the widget's code at runtime.
+ */
+export type WidgetSource = WidgetSourceModule | WidgetSourceInline | WidgetSourceRegistry;
+/**
+ * Load from an ES module URL.
+ *
+ * ⚠️ SECURITY WARNING: Only use URLs from trusted sources.
+ * Never pass user-supplied URLs directly. URLs should be validated
+ * and controlled by your application. This feature uses dynamic imports
+ * which bypass static analysis and may be restricted by Content Security Policy.
+ */
+export interface WidgetSourceModule {
+    type: 'module';
+    /**
+     * URL to the ES module (e.g., '/widgets/chart.js' or 'https://cdn.example.com/widget.mjs')
+     * Must be from a trusted source - never user input.
+     */
+    url: string;
+    /** Named export to use (default: 'default') */
+    exportName?: string;
+}
+/** The component is provided inline (already loaded) */
+export interface WidgetSourceInline {
+    type: 'inline';
+    /** The React component (already resolved) */
+    component: unknown;
+}
+/** The component is registered in the global component registry */
+export interface WidgetSourceRegistry {
+    type: 'registry';
+    /** The component type key in the registry */
+    registryKey: string;
+}
+/**
+ * Configurable input for a widget.
+ */
+export interface WidgetInput {
+    /** Input field name (maps to prop name) */
+    name: string;
+    /** Input field type */
+    type: 'string' | 'number' | 'boolean' | 'enum' | 'array' | 'object' | 'color' | 'date' | 'code' | 'file' | 'slot';
+    /** Human-readable label */
+    label?: string;
+    /** Default value */
+    defaultValue?: unknown;
+    /** Whether this input is required */
+    required?: boolean;
+    /** Enum options (for type: 'enum') */
+    options?: string[] | Array<{
+        label: string;
+        value: unknown;
+    }>;
+    /** Help text */
+    description?: string;
+    /** Whether this is an advanced setting (hidden by default) */
+    advanced?: boolean;
+}
+/**
+ * Widget capabilities flag set.
+ */
+export interface WidgetCapabilities {
+    /** Widget supports data binding via dataSource */
+    dataBinding?: boolean;
+    /** Widget supports real-time updates */
+    realTime?: boolean;
+    /** Widget supports export (PDF, CSV, etc.) */
+    export?: boolean;
+    /** Widget supports responsive sizing */
+    responsive?: boolean;
+    /** Widget supports theming */
+    themeable?: boolean;
+    /** Widget supports drag and drop */
+    draggable?: boolean;
+    /** Widget supports resize */
+    resizable?: boolean;
+}
+/**
+ * Resolved widget: a manifest with its loaded component.
+ */
+export interface ResolvedWidget {
+    /** The original manifest */
+    manifest: WidgetManifest;
+    /** The loaded React component */
+    component: unknown;
+    /** Timestamp when the widget was loaded */
+    loadedAt: number;
+}
+/**
+ * Widget registry event types.
+ */
+export type WidgetRegistryEvent = {
+    type: 'widget:registered';
+    widget: WidgetManifest;
+} | {
+    type: 'widget:unregistered';
+    name: string;
+} | {
+    type: 'widget:loaded';
+    widget: ResolvedWidget;
+} | {
+    type: 'widget:error';
+    name: string;
+    error: Error;
+};
+/**
+ * Widget registry event listener.
+ */
+export type WidgetRegistryListener = (event: WidgetRegistryEvent) => void;
+//# sourceMappingURL=widget.d.ts.map

package/dist/widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IAEb,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAEhB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IAEb,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IAEd,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0CAA0C;IAC1C,MAAM,EAAE,YAAY,CAAC;IAErB,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC,4DAA4D;IAC5D,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IAEvB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAElC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,CAAC;AAEzB;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,6CAA6C;IAC7C,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,mEAAmE;AACnE,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,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,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAC9D,gBAAgB;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kDAAkD;IAClD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4BAA4B;IAC5B,QAAQ,EAAE,cAAc,CAAC;IACzB,iCAAiC;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,qBAAqB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC"}

package/dist/widget.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 {};