@object-ui/types 0.3.0 → 0.3.1

package/dist/zod/overlay.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay.zod.d.ts","sourceRoot":"","sources":["../../src/zod/overlay.zod.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWvB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAa5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWtB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAUvB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASxB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAOxB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAU1B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAUzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAS7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;iBAI5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;iBAG5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;iBAGxB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAWxB,CAAC"}

package/dist/zod/overlay.zod.js

@@ -0,0 +1,179 @@
+/**
+ * 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/zod - Overlay Component Zod Validators
+ *
+ * Zod validation schemas for overlay, modal, and popup components.
+ * Following @objectstack/spec UI specification format.
+ *
+ * @module zod/overlay
+ * @packageDocumentation
+ */
+import { z } from 'zod';
+import { BaseSchema, SchemaNodeSchema } from './base.zod';
+/**
+ * Dialog Schema - Dialog/modal component
+ */
+export const DialogSchema = BaseSchema.extend({
+    type: z.literal('dialog'),
+    title: z.string().optional().describe('Dialog title'),
+    description: z.string().optional().describe('Dialog description'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Dialog content'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Dialog trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    footer: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Dialog footer'),
+    modal: z.boolean().optional().describe('Whether dialog is modal'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Alert Dialog Schema - Alert dialog component
+ */
+export const AlertDialogSchema = BaseSchema.extend({
+    type: z.literal('alert-dialog'),
+    title: z.string().optional().describe('Alert dialog title'),
+    description: z.string().optional().describe('Alert dialog description'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Dialog trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    cancelLabel: z.string().optional().describe('Cancel button label'),
+    confirmLabel: z.string().optional().describe('Confirm button label'),
+    confirmVariant: z.enum(['default', 'destructive']).optional().describe('Confirm button variant'),
+    onConfirm: z.function().optional().describe('Confirm handler'),
+    onCancel: z.function().optional().describe('Cancel handler'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Sheet Schema - Sheet/side panel component
+ */
+export const SheetSchema = BaseSchema.extend({
+    type: z.literal('sheet'),
+    title: z.string().optional().describe('Sheet title'),
+    description: z.string().optional().describe('Sheet description'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Sheet content'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Sheet trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    side: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Sheet position'),
+    footer: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Sheet footer'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Drawer Schema - Drawer component
+ */
+export const DrawerSchema = BaseSchema.extend({
+    type: z.literal('drawer'),
+    title: z.string().optional().describe('Drawer title'),
+    description: z.string().optional().describe('Drawer description'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Drawer content'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).optional().describe('Drawer trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    direction: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Drawer direction'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Popover Schema - Popover component
+ */
+export const PopoverSchema = BaseSchema.extend({
+    type: z.literal('popover'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Popover content'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Popover trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    side: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Popover side'),
+    align: z.enum(['start', 'center', 'end']).optional().describe('Popover alignment'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Tooltip Schema - Tooltip component
+ */
+export const TooltipSchema = BaseSchema.extend({
+    type: z.literal('tooltip'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Tooltip content'),
+    children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Tooltip children'),
+    side: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Tooltip side'),
+    align: z.enum(['start', 'center', 'end']).optional().describe('Tooltip alignment'),
+    delayDuration: z.number().optional().describe('Delay before showing (ms)'),
+});
+/**
+ * Hover Card Schema - Hover card component
+ */
+export const HoverCardSchema = BaseSchema.extend({
+    type: z.literal('hover-card'),
+    content: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Hover card content'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Hover card trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    side: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Hover card side'),
+    openDelay: z.number().optional().describe('Delay before opening (ms)'),
+    closeDelay: z.number().optional().describe('Delay before closing (ms)'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Menu Item Schema
+ */
+export const MenuItemSchema = z.lazy(() => z.object({
+    label: z.string().describe('Menu item label'),
+    icon: z.string().optional().describe('Menu item icon'),
+    disabled: z.boolean().optional().describe('Whether item is disabled'),
+    onClick: z.function().optional().describe('Click handler'),
+    shortcut: z.string().optional().describe('Keyboard shortcut'),
+    children: z.array(MenuItemSchema).optional().describe('Submenu items'),
+    separator: z.boolean().optional().describe('Whether this is a separator'),
+}));
+/**
+ * Dropdown Menu Schema - Dropdown menu component
+ */
+export const DropdownMenuSchema = BaseSchema.extend({
+    type: z.literal('dropdown-menu'),
+    items: z.array(MenuItemSchema).describe('Menu items'),
+    trigger: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Menu trigger'),
+    defaultOpen: z.boolean().optional().describe('Default open state'),
+    open: z.boolean().optional().describe('Controlled open state'),
+    side: z.enum(['top', 'right', 'bottom', 'left']).optional().describe('Menu side'),
+    align: z.enum(['start', 'center', 'end']).optional().describe('Menu alignment'),
+    onOpenChange: z.function().optional().describe('Open change handler'),
+});
+/**
+ * Context Menu Schema - Context menu component
+ */
+export const ContextMenuSchema = BaseSchema.extend({
+    type: z.literal('context-menu'),
+    items: z.array(MenuItemSchema).describe('Menu items'),
+    children: z.union([SchemaNodeSchema, z.array(SchemaNodeSchema)]).describe('Context menu children'),
+});
+/**
+ * Menubar Menu Schema
+ */
+export const MenubarMenuSchema = z.object({
+    label: z.string().describe('Menu label'),
+    items: z.array(MenuItemSchema).describe('Menu items'),
+});
+/**
+ * Menubar Schema - Menubar component
+ */
+export const MenubarSchema = BaseSchema.extend({
+    type: z.literal('menubar'),
+    menus: z.array(MenubarMenuSchema).optional().describe('Menubar menus'),
+});
+/**
+ * Overlay Schema Union - All overlay component schemas
+ */
+export const OverlaySchema = z.union([
+    DialogSchema,
+    AlertDialogSchema,
+    SheetSchema,
+    DrawerSchema,
+    PopoverSchema,
+    TooltipSchema,
+    HoverCardSchema,
+    DropdownMenuSchema,
+    ContextMenuSchema,
+    MenubarSchema,
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/types",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Pure TypeScript type definitions for Object UI - The Protocol Layer",
   "type": "module",
   "main": "./dist/index.js",
@@ -47,6 +47,10 @@
     "./data": {
       "types": "./dist/data.d.ts",
       "import": "./dist/data.js"
+    },
+    "./zod": {
+      "types": "./dist/zod/index.zod.d.ts",
+      "import": "./dist/zod/index.zod.js"
     }
   },
   "files": [
@@ -70,6 +74,10 @@
     "url": "https://github.com/objectstack-ai/objectui.git",
     "directory": "packages/types"
   },
+  "dependencies": {
+    "@objectstack/spec": "^0.3.3",
+    "zod": "^4.3.6"
+  },
   "devDependencies": {
     "typescript": "^5.9.3"
   },

package/src/api-types.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 - API and Event Schemas
  * 

package/src/app.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 - Application Schema
  * 

package/src/base.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 - Base Schema Types
  * 

package/src/complex.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 - Complex Component Schemas
  * 
@@ -9,6 +17,35 @@
 
 import type { BaseSchema, SchemaNode } from './base';
 
+/**
+ * Dashboard Component Schema
+ * (Report / BI View)
+ */
+export interface DashboardSchema extends BaseSchema {
+  type: 'dashboard';
+  /**
+   * Layout Grid Configuration (e.g. 12 column grid)
+   */
+  columns?: number;
+  /**
+   * Widget gap
+   */
+  gap?: number;
+  /**
+   * Dashboard Widgets
+   */
+  widgets: Array<{
+    /** Unique Widget ID */
+    id: string;
+    /** Widget Title */
+    title?: string;
+    /** Widget Component (Chart, Statistic, List, etc) */
+    component: SchemaNode;
+    /** Grid Position: x, y, w, h */
+    layout?: { x: number; y: number; w: number; h: number };
+  }>;
+}
+
 /**
  * Kanban column
  */
@@ -454,6 +491,36 @@ export interface ChatbotSchema extends BaseSchema {
   height?: string | number;
 }
 
+/**
+ * Dashboard Widget Layout
+ */
+export interface DashboardWidgetLayout {
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+}
+
+/**
+ * Dashboard Widget
+ */
+export interface DashboardWidgetSchema {
+  id: string;
+  title?: string;
+  component: SchemaNode;
+  layout?: DashboardWidgetLayout;
+}
+
+/**
+ * Dashboard Schema
+ */
+export interface DashboardSchema extends BaseSchema {
+  type: 'dashboard';
+  columns?: number;
+  gap?: number;
+  widgets: DashboardWidgetSchema[];
+}
+
 /**
  * Union type of all complex schemas
  */
@@ -462,4 +529,5 @@ export type ComplexSchema =
   | CalendarViewSchema
   | FilterBuilderSchema
   | CarouselSchema
-  | ChatbotSchema;
+  | ChatbotSchema
+  | DashboardSchema;

package/src/crud.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 - CRUD Component Schemas
  * 

package/src/data-display.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 - Data Display Component Schemas
  * 
@@ -322,9 +330,12 @@ export interface DataTableSchema extends BaseSchema {
   searchable?: boolean;
   /**
    * Enable row selection
+   * - boolean: Enable/disable selection (true = multiple selection)
+   * - 'single': Single row selection
+   * - 'multiple': Multiple row selection
    * @default false
    */
-  selectable?: boolean;
+  selectable?: boolean | 'single' | 'multiple';
   /**
    * Enable column sorting
    * @default true
@@ -601,6 +612,51 @@ export interface TimelineSchema extends BaseSchema {
   position?: 'left' | 'right' | 'alternate';
 }
 
+/**
+ * Breadcrumb item
+ */
+export interface BreadcrumbItem {
+  /**
+   * Item label
+   */
+  label: string;
+  /**
+   * Item href/link
+   */
+  href?: string;
+}
+
+/**
+ * Breadcrumb component
+ */
+export interface BreadcrumbSchema extends BaseSchema {
+  type: 'breadcrumb';
+  /**
+   * Breadcrumb items
+   */
+  items: BreadcrumbItem[];
+  /**
+   * Separator character
+   * @default '/'
+   */
+  separator?: string;
+}
+
+/**
+ * Keyboard key component
+ */
+export interface KbdSchema extends BaseSchema {
+  type: 'kbd';
+  /**
+   * Key label (single key)
+   */
+  label?: string;
+  /**
+   * Key labels (multiple keys)
+   */
+  keys?: string | string[];
+}
+
 /**
  * Union type of all data display schemas
  */
@@ -616,7 +672,9 @@ export type DataDisplaySchema =
   | ChartSchema
   | TimelineSchema
   | HtmlSchema
-  | StatisticSchema;
+  | StatisticSchema
+  | BreadcrumbSchema
+  | KbdSchema;
 
 /**
  * Raw HTML component

package/src/data.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 - Data Source Types
  * 
@@ -185,6 +193,16 @@ export interface DataSource<T = any> {
    * @returns Promise resolving to operation result
    */
   bulk?(resource: string, operation: 'create' | 'update' | 'delete', data: Partial<T>[]): Promise<T[]>;
+
+  /**
+   * Get object schema/metadata.
+   * Used by ObjectQL-aware components to auto-generate UI from object metadata.
+   * Required for all DataSource implementations to support schema-aware components.
+   * 
+   * @param objectName - Object name
+   * @returns Promise resolving to the object schema
+   */
+  getObjectSchema(objectName: string): Promise<any>;
 }
 
 /**

package/src/disclosure.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 - Disclosure Component Schemas
  * 
@@ -105,9 +113,74 @@ export interface CollapsibleSchema extends BaseSchema {
   onOpenChange?: (open: boolean) => void;
 }
 
+/**
+ * Toggle group item
+ */
+export interface ToggleGroupItem {
+  /**
+   * Item value
+   */
+  value: string;
+  /**
+   * Item label
+   */
+  label: string;
+  /**
+   * Item icon
+   */
+  icon?: string;
+  /**
+   * Whether item is disabled
+   */
+  disabled?: boolean;
+}
+
+/**
+ * Toggle group component
+ */
+export interface ToggleGroupSchema extends BaseSchema {
+  type: 'toggle-group';
+  /**
+   * Toggle group selection mode
+   * @default 'single'
+   */
+  selectionType?: 'single' | 'multiple';
+  /**
+   * Toggle group variant
+   * @default 'default'
+   */
+  variant?: 'default' | 'outline';
+  /**
+   * Toggle group size
+   * @default 'default'
+   */
+  size?: 'default' | 'sm' | 'lg';
+  /**
+   * Toggle group items
+   */
+  items?: ToggleGroupItem[];
+  /**
+   * Default selected value(s)
+   */
+  defaultValue?: string | string[];
+  /**
+   * Controlled selected value(s)
+   */
+  value?: string | string[];
+  /**
+   * Whether toggle group is disabled
+   */
+  disabled?: boolean;
+  /**
+   * Change handler
+   */
+  onValueChange?: (value: string | string[]) => void;
+}
+
 /**
  * Union type of all disclosure schemas
  */
 export type DisclosureSchema =
   | AccordionSchema
-  | CollapsibleSchema;
+  | CollapsibleSchema
+  | ToggleGroupSchema;

package/src/feedback.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 - Feedback Component Schemas
  * 
@@ -7,7 +15,7 @@
  * @packageDocumentation
  */
 
-import type { BaseSchema, SchemaNode } from './base';
+import type { BaseSchema } from './base';
 
 /**
  * Loading/Spinner component
@@ -159,6 +167,69 @@ export interface ToasterSchema extends BaseSchema {
   limit?: number;
 }
 
+/**
+ * Spinner component
+ */
+export interface SpinnerSchema extends BaseSchema {
+  type: 'spinner';
+  /**
+   * Spinner size
+   * @default 'md'
+   */
+  size?: 'sm' | 'md' | 'lg' | 'xl';
+}
+
+/**
+ * Empty state component
+ */
+export interface EmptySchema extends BaseSchema {
+  type: 'empty';
+  /**
+   * Empty state title
+   */
+  title?: string;
+  /**
+   * Empty state description
+   */
+  description?: string;
+  /**
+   * Icon to display
+   */
+  icon?: string;
+}
+
+/**
+ * Sonner toast component (using sonner library)
+ */
+export interface SonnerSchema extends BaseSchema {
+  type: 'sonner';
+  /**
+   * Toast message/title
+   */
+  message?: string;
+  /**
+   * Toast title (alias for message)
+   */
+  title?: string;
+  /**
+   * Toast description
+   */
+  description?: string;
+  /**
+   * Toast variant
+   * @default 'default'
+   */
+  variant?: 'default' | 'success' | 'error' | 'warning' | 'info';
+  /**
+   * Button label to trigger toast
+   */
+  buttonLabel?: string;
+  /**
+   * Button variant
+   */
+  buttonVariant?: 'default' | 'secondary' | 'destructive' | 'outline' | 'ghost' | 'link';
+}
+
 /**
  * Union type of all feedback schemas
  */
@@ -167,4 +238,7 @@ export type FeedbackSchema =
   | ProgressSchema
   | SkeletonSchema
   | ToastSchema
-  | ToasterSchema;
+  | ToasterSchema
+  | SpinnerSchema
+  | EmptySchema
+  | SonnerSchema;