@object-ui/types 0.3.0

package/dist/navigation.d.ts

@@ -0,0 +1,224 @@
+/**
+ * @object-ui/types - Navigation Component Schemas
+ *
+ * Type definitions for navigation and menu components.
+ *
+ * @module navigation
+ * @packageDocumentation
+ */
+import type { BaseSchema, SchemaNode } from './base';
+/**
+ * Navigation link
+ */
+export interface NavLink {
+    /**
+     * Link label
+     */
+    label: string;
+    /**
+     * Link URL/href
+     */
+    href: string;
+    /**
+     * Link icon
+     */
+    icon?: string;
+    /**
+     * Whether link is active
+     */
+    active?: boolean;
+    /**
+     * Whether link is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Submenu links
+     */
+    children?: NavLink[];
+    /**
+     * Badge content
+     */
+    badge?: string | number;
+}
+/**
+ * Header bar component
+ */
+export interface HeaderBarSchema extends BaseSchema {
+    type: 'header-bar';
+    /**
+     * Header title/brand
+     */
+    title?: string;
+    /**
+     * Brand logo image URL
+     */
+    logo?: string;
+    /**
+     * Navigation links
+     */
+    nav?: NavLink[];
+    /**
+     * Left side content
+     */
+    left?: SchemaNode | SchemaNode[];
+    /**
+     * Center content
+     */
+    center?: SchemaNode | SchemaNode[];
+    /**
+     * Right side content
+     */
+    right?: SchemaNode | SchemaNode[];
+    /**
+     * Whether header is sticky
+     * @default true
+     */
+    sticky?: boolean;
+    /**
+     * Header height
+     */
+    height?: string | number;
+    /**
+     * Header variant
+     * @default 'default'
+     */
+    variant?: 'default' | 'bordered' | 'floating';
+}
+/**
+ * Sidebar component
+ */
+export interface SidebarSchema extends BaseSchema {
+    type: 'sidebar';
+    /**
+     * Sidebar title
+     */
+    title?: string;
+    /**
+     * Navigation links
+     */
+    nav?: NavLink[];
+    /**
+     * Sidebar content (alternative to nav)
+     */
+    content?: SchemaNode | SchemaNode[];
+    /**
+     * Footer content
+     */
+    footer?: SchemaNode | SchemaNode[];
+    /**
+     * Sidebar position
+     * @default 'left'
+     */
+    position?: 'left' | 'right';
+    /**
+     * Whether sidebar is collapsible
+     * @default true
+     */
+    collapsible?: boolean;
+    /**
+     * Default collapsed state
+     * @default false
+     */
+    defaultCollapsed?: boolean;
+    /**
+     * Controlled collapsed state
+     */
+    collapsed?: boolean;
+    /**
+     * Sidebar width when expanded
+     * @default '16rem'
+     */
+    width?: string | number;
+    /**
+     * Sidebar width when collapsed
+     * @default '4rem'
+     */
+    collapsedWidth?: string | number;
+    /**
+     * Collapsed state change handler
+     */
+    onCollapsedChange?: (collapsed: boolean) => void;
+    /**
+     * Sidebar variant
+     * @default 'default'
+     */
+    variant?: 'default' | 'bordered' | 'floating';
+}
+/**
+ * Breadcrumb item
+ */
+export interface BreadcrumbItem {
+    /**
+     * Item label
+     */
+    label: string;
+    /**
+     * Item URL/href
+     */
+    href?: string;
+    /**
+     * Item icon
+     */
+    icon?: string;
+    /**
+     * Click handler (if not using href)
+     */
+    onClick?: () => void;
+}
+/**
+ * Breadcrumb component
+ */
+export interface BreadcrumbSchema extends BaseSchema {
+    type: 'breadcrumb';
+    /**
+     * Breadcrumb items
+     */
+    items: BreadcrumbItem[];
+    /**
+     * Separator character/icon
+     * @default '/'
+     */
+    separator?: string;
+    /**
+     * Maximum items to display before collapsing
+     */
+    maxItems?: number;
+}
+/**
+ * Pagination component
+ */
+export interface PaginationSchema extends BaseSchema {
+    type: 'pagination';
+    /**
+     * Current page (1-indexed)
+     */
+    page: number;
+    /**
+     * Total number of pages
+     */
+    totalPages: number;
+    /**
+     * Number of sibling pages to show
+     * @default 1
+     */
+    siblings?: number;
+    /**
+     * Show first/last buttons
+     * @default true
+     */
+    showFirstLast?: boolean;
+    /**
+     * Show previous/next buttons
+     * @default true
+     */
+    showPrevNext?: boolean;
+    /**
+     * Page change handler
+     */
+    onPageChange?: (page: number) => void;
+}
+/**
+ * Union type of all navigation schemas
+ */
+export type NavigationSchema = HeaderBarSchema | SidebarSchema | BreadcrumbSchema | PaginationSchema;
+//# sourceMappingURL=navigation.d.ts.map

package/dist/navigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../src/navigation.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACjD;;;OAGG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,aAAa,GACb,gBAAgB,GAChB,gBAAgB,CAAC"}

package/dist/navigation.js

@@ -0,0 +1,9 @@
+/**
+ * @object-ui/types - Navigation Component Schemas
+ *
+ * Type definitions for navigation and menu components.
+ *
+ * @module navigation
+ * @packageDocumentation
+ */
+export {};

package/dist/objectql.d.ts

@@ -0,0 +1,254 @@
+/**
+ * @object-ui/types - ObjectQL Component Schemas
+ *
+ * Type definitions for ObjectQL-specific components.
+ * These schemas enable building ObjectQL-aware interfaces directly from object metadata.
+ *
+ * @module objectql
+ * @packageDocumentation
+ */
+import type { BaseSchema } from './base';
+import type { TableColumn } from './data-display';
+import type { FormField } from './form';
+/**
+ * ObjectTable Schema
+ * A specialized table component that automatically fetches and displays data from ObjectQL objects.
+ * It reads the object schema from ObjectQL and generates columns automatically.
+ */
+export interface ObjectTableSchema extends BaseSchema {
+    type: 'object-table';
+    /**
+     * ObjectQL object name (e.g., 'users', 'accounts', 'contacts')
+     */
+    objectName: string;
+    /**
+     * Optional title for the table
+     */
+    title?: string;
+    /**
+     * Optional description
+     */
+    description?: string;
+    /**
+     * Field names to display as columns
+     * If not specified, uses all visible fields from object schema
+     */
+    fields?: string[];
+    /**
+     * Custom column configurations
+     * Overrides auto-generated columns for specific fields
+     */
+    columns?: TableColumn[];
+    /**
+     * Enable/disable built-in operations
+     */
+    operations?: {
+        /**
+         * Enable create operation
+         * @default true
+         */
+        create?: boolean;
+        /**
+         * Enable read/view operation
+         * @default true
+         */
+        read?: boolean;
+        /**
+         * Enable update operation
+         * @default true
+         */
+        update?: boolean;
+        /**
+         * Enable delete operation
+         * @default true
+         */
+        delete?: boolean;
+        /**
+         * Enable export operation
+         * @default false
+         */
+        export?: boolean;
+        /**
+         * Enable import operation
+         * @default false
+         */
+        import?: boolean;
+    };
+    /**
+     * Default filters to apply
+     */
+    defaultFilters?: Record<string, any>;
+    /**
+     * Default sort configuration
+     */
+    defaultSort?: {
+        field: string;
+        order: 'asc' | 'desc';
+    };
+    /**
+     * Page size
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Enable row selection
+     * @default false
+     */
+    selectable?: boolean | 'single' | 'multiple';
+    /**
+     * Show search box
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * Show filters
+     * @default true
+     */
+    showFilters?: boolean;
+    /**
+     * Show pagination
+     * @default true
+     */
+    showPagination?: boolean;
+    /**
+     * Custom row actions
+     */
+    rowActions?: string[];
+    /**
+     * Custom batch actions
+     */
+    batchActions?: string[];
+    /**
+     * Custom CSS class
+     */
+    className?: string;
+}
+/**
+ * ObjectForm Schema
+ * A smart form component that generates forms from ObjectQL object schemas.
+ * It automatically creates form fields based on object metadata.
+ */
+export interface ObjectFormSchema extends BaseSchema {
+    type: 'object-form';
+    /**
+     * ObjectQL object name (e.g., 'users', 'accounts', 'contacts')
+     */
+    objectName: string;
+    /**
+     * Form mode
+     */
+    mode: 'create' | 'edit' | 'view';
+    /**
+     * Record ID (required for edit/view modes)
+     */
+    recordId?: string | number;
+    /**
+     * Optional title for the form
+     */
+    title?: string;
+    /**
+     * Optional description
+     */
+    description?: string;
+    /**
+     * Field names to include in the form
+     * If not specified, uses all editable fields from object schema
+     */
+    fields?: string[];
+    /**
+     * Custom field configurations
+     * Overrides auto-generated fields for specific fields
+     */
+    customFields?: FormField[];
+    /**
+     * Field groups for organized layout
+     */
+    groups?: Array<{
+        title?: string;
+        description?: string;
+        fields: string[];
+        collapsible?: boolean;
+        defaultCollapsed?: boolean;
+    }>;
+    /**
+     * Form layout.
+     *
+     * Supported layouts:
+     * - `vertical`   – label above field (default)
+     * - `horizontal` – label and field in a row
+     * - `inline`     – compact inline layout, typically used in toolbars
+     * - `grid`       – **experimental** grid layout
+     *
+     * Note: As of the current implementation, the underlying form renderer does not yet
+     * support a native `grid` layout and will internally treat `layout: "grid"` as
+     * `layout: "vertical"`. This value is exposed in the schema for forward compatibility,
+     * and behavior may change once grid support is implemented.
+     *
+     * @default 'vertical'
+     */
+    layout?: 'vertical' | 'horizontal' | 'inline' | 'grid';
+    /**
+     * Grid columns (for grid layout).
+     *
+     * Intended number of columns when using a `grid` layout. Current renderers that do
+     * not implement true grid support may ignore this value and fall back to a vertical
+     * layout. When grid layout is supported, this value should control how many form
+     * fields are placed per row.
+     *
+     * @default 2
+     */
+    columns?: number;
+    /**
+     * Show submit button
+     * @default true
+     */
+    showSubmit?: boolean;
+    /**
+     * Submit button text
+     */
+    submitText?: string;
+    /**
+     * Show cancel button
+     * @default true
+     */
+    showCancel?: boolean;
+    /**
+     * Cancel button text
+     */
+    cancelText?: string;
+    /**
+     * Show reset button
+     * @default false
+     */
+    showReset?: boolean;
+    /**
+     * Initial values (for create mode)
+     */
+    initialValues?: Record<string, any>;
+    /**
+     * Callback on successful submission
+     */
+    onSuccess?: (data: any) => void | Promise<void>;
+    /**
+     * Callback on error
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback on cancel
+     */
+    onCancel?: () => void;
+    /**
+     * Read-only mode
+     * @default false
+     */
+    readOnly?: boolean;
+    /**
+     * Custom CSS class
+     */
+    className?: string;
+}
+/**
+ * Union type of all ObjectQL component schemas
+ */
+export type ObjectQLComponentSchema = ObjectTableSchema | ObjectFormSchema;
+//# sourceMappingURL=objectql.d.ts.map

package/dist/objectql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectql.d.ts","sourceRoot":"","sources":["../src/objectql.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;WAGG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;KACvB,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;IAEvD;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,iBAAiB,GACjB,gBAAgB,CAAC"}

package/dist/objectql.js

@@ -0,0 +1,10 @@
+/**
+ * @object-ui/types - ObjectQL Component Schemas
+ *
+ * Type definitions for ObjectQL-specific components.
+ * These schemas enable building ObjectQL-aware interfaces directly from object metadata.
+ *
+ * @module objectql
+ * @packageDocumentation
+ */
+export {};