@object-ui/types 0.3.0 → 0.5.0

package/src/blocks.ts

@@ -0,0 +1,405 @@
+/**
+ * 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 - Block Schema
+ * 
+ * Defines reusable component blocks for composition and templating.
+ */
+
+import type { BaseSchema, SchemaNode } from './base';
+
+/**
+ * Block Variable Definition
+ */
+export interface BlockVariable {
+  /**
+   * Variable name
+   */
+  name: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Variable type
+   */
+  type?: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'component';
+
+  /**
+   * Default value
+   */
+  defaultValue?: any;
+
+  /**
+   * Description/help text
+   */
+  description?: string;
+
+  /**
+   * Whether this variable is required
+   */
+  required?: boolean;
+
+  /**
+   * Validation rules
+   */
+  validation?: any;
+
+  /**
+   * Enum options (for string/number types)
+   */
+  enum?: any[];
+}
+
+/**
+ * Block Slot Definition
+ */
+export interface BlockSlot {
+  /**
+   * Slot name
+   */
+  name: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Description
+   */
+  description?: string;
+
+  /**
+   * Default content
+   */
+  defaultContent?: SchemaNode | SchemaNode[];
+
+  /**
+   * Allowed component types
+   */
+  allowedTypes?: string[];
+
+  /**
+   * Maximum number of children
+   */
+  maxChildren?: number;
+
+  /**
+   * Whether this slot is required
+   */
+  required?: boolean;
+}
+
+/**
+ * Block Metadata
+ */
+export interface BlockMetadata {
+  /**
+   * Block name/identifier
+   */
+  name: string;
+
+  /**
+   * Display label
+   */
+  label?: string;
+
+  /**
+   * Block description
+   */
+  description?: string;
+
+  /**
+   * Block category
+   */
+  category?: string;
+
+  /**
+   * Block icon
+   */
+  icon?: string;
+
+  /**
+   * Block tags for search
+   */
+  tags?: string[];
+
+  /**
+   * Author/creator
+   */
+  author?: string;
+
+  /**
+   * Version
+   */
+  version?: string;
+
+  /**
+   * License
+   */
+  license?: string;
+
+  /**
+   * Repository URL
+   */
+  repository?: string;
+
+  /**
+   * Preview image URL
+   */
+  preview?: string;
+
+  /**
+   * Is this a premium/paid block
+   */
+  premium?: boolean;
+}
+
+/**
+ * Block Schema - Reusable component block
+ */
+export interface BlockSchema extends BaseSchema {
+  type: 'block';
+
+  /**
+   * Block metadata
+   */
+  meta?: BlockMetadata;
+
+  /**
+   * Block variables/props
+   */
+  variables?: BlockVariable[];
+
+  /**
+   * Block slots for content injection
+   */
+  slots?: BlockSlot[];
+
+  /**
+   * Block template (component tree)
+   */
+  template?: SchemaNode | SchemaNode[];
+
+  /**
+   * Variable values (when using a block)
+   */
+  values?: Record<string, any>;
+
+  /**
+   * Slot content (when using a block)
+   */
+  slotContent?: Record<string, SchemaNode | SchemaNode[]>;
+
+  /**
+   * Block reference (for reusing saved blocks)
+   */
+  blockRef?: string;
+
+  /**
+   * Enable edit mode
+   */
+  editable?: boolean;
+}
+
+/**
+ * Block Library Item
+ */
+export interface BlockLibraryItem {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Block metadata
+   */
+  meta: BlockMetadata;
+
+  /**
+   * Block schema
+   */
+  schema: BlockSchema;
+
+  /**
+   * Installation count
+   */
+  installs?: number;
+
+  /**
+   * Rating (1-5)
+   */
+  rating?: number;
+
+  /**
+   * Number of ratings
+   */
+  ratingCount?: number;
+
+  /**
+   * Last updated timestamp
+   */
+  updatedAt?: string;
+
+  /**
+   * Created timestamp
+   */
+  createdAt?: string;
+}
+
+/**
+ * Block Library Schema - Browse and install blocks
+ */
+export interface BlockLibrarySchema extends BaseSchema {
+  type: 'block-library';
+
+  /**
+   * Library API endpoint
+   */
+  apiEndpoint?: string;
+
+  /**
+   * Filter by category
+   */
+  category?: string;
+
+  /**
+   * Search query
+   */
+  searchQuery?: string;
+
+  /**
+   * Filter by tags
+   */
+  tags?: string[];
+
+  /**
+   * Show premium blocks
+   */
+  showPremium?: boolean;
+
+  /**
+   * Blocks to display
+   */
+  blocks?: BlockLibraryItem[];
+
+  /**
+   * Loading state
+   */
+  loading?: boolean;
+
+  /**
+   * Install callback
+   */
+  onInstall?: string;
+
+  /**
+   * Preview callback
+   */
+  onPreview?: string;
+}
+
+/**
+ * Block Editor Schema - Edit/create blocks
+ */
+export interface BlockEditorSchema extends BaseSchema {
+  type: 'block-editor';
+
+  /**
+   * Block being edited
+   */
+  block?: BlockSchema;
+
+  /**
+   * Show variable editor
+   */
+  showVariables?: boolean;
+
+  /**
+   * Show slot editor
+   */
+  showSlots?: boolean;
+
+  /**
+   * Show template editor
+   */
+  showTemplate?: boolean;
+
+  /**
+   * Show preview
+   */
+  showPreview?: boolean;
+
+  /**
+   * Save callback
+   */
+  onSave?: string;
+
+  /**
+   * Cancel callback
+   */
+  onCancel?: string;
+}
+
+/**
+ * Block Instance Schema - Use a saved block
+ */
+export interface BlockInstanceSchema extends BaseSchema {
+  type: 'block-instance';
+
+  /**
+   * Block reference ID
+   */
+  blockId: string;
+
+  /**
+   * Block name (for local blocks)
+   */
+  blockName?: string;
+
+  /**
+   * Variable values
+   */
+  values?: Record<string, any>;
+
+  /**
+   * Slot content
+   */
+  slotContent?: Record<string, SchemaNode | SchemaNode[]>;
+
+  /**
+   * Override styles
+   */
+  overrideStyles?: boolean;
+}
+
+/**
+ * Component Schema Extension - For base component metadata
+ */
+export interface ComponentSchema extends BaseSchema {
+  type: 'component';
+
+  /**
+   * Component name/identifier
+   */
+  componentName?: string;
+
+  /**
+   * Component props
+   */
+  props?: Record<string, any>;
+
+  /**
+   * Component children
+   */
+  children?: SchemaNode | SchemaNode[];
+}

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
  * 
@@ -12,8 +20,67 @@ import type { BaseSchema, SchemaNode } from './base';
 import type { FormField } from './form';
 import type { TableColumn } from './data-display';
 
+/**
+ * Action execution mode for chaining
+ */
+export type ActionExecutionMode = 'sequential' | 'parallel';
+
+/**
+ * Action callback configuration
+ */
+export interface ActionCallback {
+  /**
+   * Callback type
+   */
+  type: 'toast' | 'message' | 'redirect' | 'reload' | 'custom' | 'ajax' | 'dialog';
+  /**
+   * Message to display
+   */
+  message?: string;
+  /**
+   * Redirect URL
+   */
+  url?: string;
+  /**
+   * API endpoint for ajax callback
+   */
+  api?: string;
+  /**
+   * HTTP method for ajax callback
+   */
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  /**
+   * Dialog schema to open
+   */
+  dialog?: SchemaNode;
+  /**
+   * Custom callback handler expression
+   */
+  handler?: string;
+}
+
+/**
+ * Conditional action configuration
+ */
+export interface ActionCondition {
+  /**
+   * Condition expression
+   * @example "${data.status === 'active'}"
+   */
+  expression: string;
+  /**
+   * Action to execute if condition is true
+   */
+  then?: ActionSchema | ActionSchema[];
+  /**
+   * Action to execute if condition is false
+   */
+  else?: ActionSchema | ActionSchema[];
+}
+
 /**
  * Action button configuration for CRUD operations
+ * Enhanced with Phase 2 features: ajax, confirm, dialog, chaining, conditional execution
  */
 export interface ActionSchema extends BaseSchema {
   type: 'action';
@@ -40,10 +107,11 @@ export interface ActionSchema extends BaseSchema {
   disabled?: boolean;
   /**
    * Action type
+   * Enhanced in Phase 2 with 'ajax', 'confirm', 'dialog'
    */
-  actionType?: 'button' | 'link' | 'dropdown';
+  actionType?: 'button' | 'link' | 'dropdown' | 'ajax' | 'confirm' | 'dialog';
   /**
-   * API endpoint to call
+   * API endpoint to call (for ajax actions)
    */
   api?: string;
   /**
@@ -52,13 +120,93 @@ export interface ActionSchema extends BaseSchema {
    */
   method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
   /**
-   * Confirmation message before execution
+   * Request body/data
+   */
+  data?: any;
+  /**
+   * Request headers
+   */
+  headers?: Record<string, string>;
+  /**
+   * Confirmation dialog configuration (for confirm actions)
+   */
+  confirm?: {
+    /**
+     * Confirmation title
+     */
+    title?: string;
+    /**
+     * Confirmation message
+     */
+    message?: string;
+    /**
+     * Confirm button text
+     */
+    confirmText?: string;
+    /**
+     * Cancel button text
+     */
+    cancelText?: string;
+    /**
+     * Confirm button variant
+     */
+    confirmVariant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost';
+  };
+  /**
+   * Legacy confirmation message (deprecated - use confirm object instead)
+   * @deprecated Use confirm.message instead
    */
   confirmText?: string;
+  /**
+   * Dialog configuration (for dialog actions)
+   */
+  dialog?: {
+    /**
+     * Dialog title
+     */
+    title?: string;
+    /**
+     * Dialog content
+     */
+    content?: SchemaNode | SchemaNode[];
+    /**
+     * Dialog size
+     */
+    size?: 'sm' | 'default' | 'lg' | 'xl' | 'full';
+    /**
+     * Dialog actions
+     */
+    actions?: ActionSchema[];
+  };
   /**
    * Success message after execution
    */
   successMessage?: string;
+  /**
+   * Error message on failure
+   */
+  errorMessage?: string;
+  /**
+   * Success callback (Phase 2)
+   */
+  onSuccess?: ActionCallback;
+  /**
+   * Failure callback (Phase 2)
+   */
+  onFailure?: ActionCallback;
+  /**
+   * Action chaining - actions to execute after this one (Phase 2)
+   */
+  chain?: ActionSchema[];
+  /**
+   * Chain execution mode
+   * @default 'sequential'
+   */
+  chainMode?: ActionExecutionMode;
+  /**
+   * Conditional execution (Phase 2)
+   */
+  condition?: ActionCondition;
   /**
    * Whether to reload data after action
    * @default true
@@ -77,6 +225,40 @@ export interface ActionSchema extends BaseSchema {
    * Redirect URL after success
    */
   redirect?: string;
+  /**
+   * Action logging/tracking (Phase 2)
+   */
+  tracking?: {
+    /**
+     * Enable tracking
+     */
+    enabled?: boolean;
+    /**
+     * Event name
+     */
+    event?: string;
+    /**
+     * Additional metadata
+     */
+    metadata?: Record<string, any>;
+  };
+  /**
+   * Timeout in milliseconds
+   */
+  timeout?: number;
+  /**
+   * Retry configuration
+   */
+  retry?: {
+    /**
+     * Maximum retry attempts
+     */
+    maxAttempts?: number;
+    /**
+     * Delay between retries (in ms)
+     */
+    delay?: number;
+  };
 }
 
 /**