@object-ui/plugin-dashboard 3.1.5 → 3.3.1

package/src/DashboardConfigPanel.tsx

@@ -1,158 +0,0 @@
-/**
- * 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.
- */
-
-import * as React from 'react';
-import {
-  ConfigPanelRenderer,
-  useConfigDraft,
-} from '@object-ui/components';
-import type { ConfigPanelSchema } from '@object-ui/components';
-
-// ---------------------------------------------------------------------------
-// Schema — describes the full DashboardConfigPanel structure
-// ---------------------------------------------------------------------------
-
-const dashboardSchema: ConfigPanelSchema = {
-  breadcrumb: ['Dashboard', 'Configuration'],
-  sections: [
-    {
-      key: 'layout',
-      title: 'Layout',
-      fields: [
-        {
-          key: 'columns',
-          label: 'Columns',
-          type: 'slider',
-          defaultValue: 3,
-          min: 1,
-          max: 12,
-          step: 1,
-        },
-        {
-          key: 'gap',
-          label: 'Gap',
-          type: 'slider',
-          defaultValue: 4,
-          min: 0,
-          max: 16,
-          step: 1,
-        },
-        {
-          key: 'rowHeight',
-          label: 'Row height',
-          type: 'input',
-          defaultValue: '120',
-          placeholder: 'e.g. 120',
-        },
-      ],
-    },
-    {
-      key: 'data',
-      title: 'Data',
-      collapsible: true,
-      fields: [
-        {
-          key: 'refreshInterval',
-          label: 'Refresh interval',
-          type: 'select',
-          defaultValue: '0',
-          options: [
-            { value: '0', label: 'Manual' },
-            { value: '30', label: '30s' },
-            { value: '60', label: '1 min' },
-            { value: '300', label: '5 min' },
-          ],
-        },
-      ],
-    },
-    {
-      key: 'appearance',
-      title: 'Appearance',
-      collapsible: true,
-      defaultCollapsed: true,
-      fields: [
-        {
-          key: 'title',
-          label: 'Title',
-          type: 'input',
-          placeholder: 'Dashboard title',
-        },
-        {
-          key: 'showDescription',
-          label: 'Show description',
-          type: 'switch',
-          defaultValue: true,
-        },
-        {
-          key: 'theme',
-          label: 'Theme',
-          type: 'select',
-          defaultValue: 'auto',
-          options: [
-            { value: 'light', label: 'Light' },
-            { value: 'dark', label: 'Dark' },
-            { value: 'auto', label: 'Auto' },
-          ],
-        },
-      ],
-    },
-  ],
-};
-
-// ---------------------------------------------------------------------------
-// Props
-// ---------------------------------------------------------------------------
-
-export interface DashboardConfigPanelProps {
-  /** Whether the panel is open */
-  open: boolean;
-  /** Close handler */
-  onClose: () => void;
-  /** Initial / committed dashboard configuration */
-  config: Record<string, any>;
-  /** Persist the updated config */
-  onSave: (config: Record<string, any>) => void;
-  /** Optional live-update callback */
-  onFieldChange?: (field: string, value: any) => void;
-}
-
-// ---------------------------------------------------------------------------
-// Component
-// ---------------------------------------------------------------------------
-
-/**
- * DashboardConfigPanel — Schema-driven configuration panel for dashboards.
- *
- * Built entirely on the generic ConfigPanelRenderer + useConfigDraft,
- * demonstrating that a full config panel can be expressed in ~60 lines
- * of declarative schema rather than 1500+ lines of imperative code.
- */
-export function DashboardConfigPanel({
-  open,
-  onClose,
-  config,
-  onSave,
-  onFieldChange,
-}: DashboardConfigPanelProps) {
-  const { draft, isDirty, updateField, discard } = useConfigDraft(config, {
-    onUpdate: onFieldChange,
-  });
-
-  return (
-    <ConfigPanelRenderer
-      open={open}
-      onClose={onClose}
-      schema={dashboardSchema}
-      draft={draft}
-      isDirty={isDirty}
-      onFieldChange={updateField}
-      onSave={() => onSave(draft)}
-      onDiscard={discard}
-    />
-  );
-}

package/src/DashboardGridLayout.tsx

@@ -1,367 +0,0 @@
-import * as React from 'react';
-import { ResponsiveGridLayout, useContainerWidth, type LayoutItem as RGLLayout, type Layout, type ResponsiveLayouts } from 'react-grid-layout';
-import 'react-grid-layout/css/styles.css';
-import { cn, Card, CardHeader, CardTitle, CardContent, Button } from '@object-ui/components';
-import { Edit, GripVertical, Save, X, RefreshCw } from 'lucide-react';
-import { SchemaRenderer, useHasDndProvider, useDnd } from '@object-ui/react';
-import type { DashboardSchema, DashboardWidgetSchema } from '@object-ui/types';
-import { isObjectProvider } from './utils';
-
-/** Bridges editMode transitions to the ObjectUI DnD system when a DndProvider is present. */
-function DndEditModeBridge({ editMode }: { editMode: boolean }) {
-  const dnd = useDnd();
-
-  React.useEffect(() => {
-    if (editMode) {
-      dnd.startDrag({ id: 'dashboard-layout', type: 'dashboard-widget', data: {} });
-      return () => { dnd.endDrag(); };
-    } else {
-      dnd.endDrag('dashboard');
-    }
-  }, [editMode, dnd]);
-
-  return null;
-}
-
-const CHART_COLORS = [
-  'hsl(var(--chart-1))',
-  'hsl(var(--chart-2))',
-  'hsl(var(--chart-3))',
-  'hsl(var(--chart-4))',
-  'hsl(var(--chart-5))',
-];
-
-export interface DashboardGridLayoutProps {
-  schema: DashboardSchema;
-  className?: string;
-  onLayoutChange?: (layout: RGLLayout[]) => void;
-  persistLayoutKey?: string;
-  /** Callback invoked when dashboard refresh is triggered (manual or auto) */
-  onRefresh?: () => void;
-}
-
-export const DashboardGridLayout: React.FC<DashboardGridLayoutProps> = ({
-  schema,
-  className,
-  onLayoutChange,
-  persistLayoutKey = 'dashboard-layout',
-  onRefresh,
-}) => {
-  const { width, containerRef, mounted } = useContainerWidth();
-  const [editMode, setEditMode] = React.useState(false);
-  const [refreshing, setRefreshing] = React.useState(false);
-  const hasDndProvider = useHasDndProvider();
-  const intervalRef = React.useRef<ReturnType<typeof setInterval> | null>(null);
-
-  const handleRefresh = React.useCallback(() => {
-    if (!onRefresh) return;
-    setRefreshing(true);
-    onRefresh();
-    setTimeout(() => setRefreshing(false), 600);
-  }, [onRefresh]);
-
-  // Auto-refresh interval
-  React.useEffect(() => {
-    if (!schema.refreshInterval || schema.refreshInterval <= 0 || !onRefresh) return;
-    intervalRef.current = setInterval(handleRefresh, schema.refreshInterval * 1000);
-    return () => {
-      if (intervalRef.current) clearInterval(intervalRef.current);
-    };
-  }, [schema.refreshInterval, onRefresh, handleRefresh]);
-  const [layouts, setLayouts] = React.useState<{ lg: RGLLayout[] }>(() => {
-    // Try to load saved layout
-    if (typeof window !== 'undefined' && persistLayoutKey) {
-      const saved = localStorage.getItem(persistLayoutKey);
-      if (saved) {
-        try {
-          return JSON.parse(saved);
-        } catch (e) {
-          console.error('Failed to parse saved layout:', e);
-        }
-      }
-    }
-
-    // Default layout from schema
-    return {
-      lg: schema.widgets?.map((widget: DashboardWidgetSchema, index: number) => ({
-        i: widget.id || `widget-${index}`,
-        x: widget.layout?.x || (index % 4) * 3,
-        y: widget.layout?.y || Math.floor(index / 4) * 4,
-        w: widget.layout?.w || 3,
-        h: widget.layout?.h || 4,
-      })) || [],
-    };
-  });
-
-  const handleLayoutChange = React.useCallback(
-    (layout: Layout, allLayouts: ResponsiveLayouts) => {
-      setLayouts(allLayouts as { lg: RGLLayout[] });
-      onLayoutChange?.(layout as RGLLayout[]);
-    },
-    [onLayoutChange]
-  );
-
-  const handleSaveLayout = React.useCallback(() => {
-    if (typeof window !== 'undefined' && persistLayoutKey) {
-      localStorage.setItem(persistLayoutKey, JSON.stringify(layouts));
-    }
-    setEditMode(false);
-  }, [layouts, persistLayoutKey]);
-
-  const handleResetLayout = React.useCallback(() => {
-    const defaultLayouts = {
-      lg: schema.widgets?.map((widget: DashboardWidgetSchema, index: number) => ({
-        i: widget.id || `widget-${index}`,
-        x: widget.layout?.x || (index % 4) * 3,
-        y: widget.layout?.y || Math.floor(index / 4) * 4,
-        w: widget.layout?.w || 3,
-        h: widget.layout?.h || 4,
-      })) || [],
-    };
-    setLayouts(defaultLayouts);
-    if (typeof window !== 'undefined' && persistLayoutKey) {
-      localStorage.removeItem(persistLayoutKey);
-    }
-  }, [schema.widgets, persistLayoutKey]);
-
-  const getComponentSchema = React.useCallback((widget: DashboardWidgetSchema) => {
-    if (widget.component) return widget.component;
-
-    const widgetType = widget.type;
-    const options = (widget.options || {}) as Record<string, any>;
-    if (widgetType === 'bar' || widgetType === 'line' || widgetType === 'area' || widgetType === 'pie' || widgetType === 'donut' || widgetType === 'scatter') {
-      const widgetData = (widget as any).data || options.data;
-      // Widget-level fields (from config panel) override options-level fields
-      const xAxisKey = widget.categoryField || options.xField || 'name';
-      const yField = widget.valueField || options.yField || 'value';
-
-      // provider: 'object' — delegate to ObjectChart for async data loading
-      if (isObjectProvider(widgetData)) {
-        // Merge widget-level fields with data provider config.
-        // Widget-level fields take precedence so that config panel
-        // edits are immediately reflected in the live preview.
-        const providerAgg = widgetData.aggregate;
-        const effectiveAggregate = providerAgg ? {
-          field: widget.valueField || providerAgg.field,
-          function: widget.aggregate || providerAgg.function,
-          groupBy: widget.categoryField || providerAgg.groupBy,
-        } : undefined;
-        const effectiveYField = effectiveAggregate?.field || yField;
-        return {
-          type: 'object-chart',
-          chartType: widgetType,
-          objectName: widget.object || widgetData.object,
-          aggregate: effectiveAggregate,
-          xAxisKey: xAxisKey,
-          series: [{ dataKey: effectiveYField }],
-          colors: CHART_COLORS,
-          className: "h-full"
-        };
-      }
-
-      // No explicit data provider but widget has object binding
-      // (e.g. newly created widget via config panel) — build object-chart
-      if (!widgetData && widget.object) {
-        const aggregate = widget.aggregate ? {
-          field: widget.valueField || 'value',
-          function: widget.aggregate,
-          groupBy: widget.categoryField || 'name',
-        } : undefined;
-        return {
-          type: 'object-chart',
-          chartType: widgetType,
-          objectName: widget.object,
-          aggregate,
-          xAxisKey: xAxisKey,
-          series: [{ dataKey: widget.valueField || 'value' }],
-          colors: CHART_COLORS,
-          className: "h-full"
-        };
-      }
-
-      const dataItems = Array.isArray(widgetData) ? widgetData : widgetData?.items || [];
-      
-      return {
-        type: 'chart',
-        chartType: widgetType,
-        data: dataItems,
-        xAxisKey: xAxisKey,
-        series: [{ dataKey: yField }],
-        colors: CHART_COLORS,
-        className: "h-full"
-      };
-    }
-
-    if (widgetType === 'table') {
-      const widgetData = (widget as any).data || options.data;
-
-      // provider: 'object' — pass through object config for async data loading
-      if (isObjectProvider(widgetData)) {
-        const { data: _data, ...restOptions } = options;
-        return {
-          type: 'data-table',
-          ...restOptions,
-          objectName: widget.object || widgetData.object,
-          dataProvider: widgetData,
-          data: [],
-          searchable: false,
-          pagination: false,
-          className: "border-0"
-        };
-      }
-
-      // No explicit data provider but widget has object binding
-      if (!widgetData && widget.object) {
-        return {
-          type: 'data-table',
-          ...options,
-          objectName: widget.object,
-          data: [],
-          searchable: false,
-          pagination: false,
-          className: "border-0"
-        };
-      }
-
-      return {
-        type: 'data-table',
-        ...options,
-        data: widgetData?.items || [],
-        searchable: false,
-        pagination: false,
-        className: "border-0"
-      };
-    }
-
-    if (widgetType === 'pivot') {
-      const widgetData = (widget as any).data || options.data;
-
-      // provider: 'object' — pass through object config for async data loading
-      if (isObjectProvider(widgetData)) {
-        const { data: _data, ...restOptions } = options;
-        return {
-          type: 'pivot',
-          ...restOptions,
-          objectName: widget.object || widgetData.object,
-          dataProvider: widgetData,
-          data: [],
-        };
-      }
-
-      return {
-        type: 'pivot',
-        ...options,
-        data: Array.isArray(widgetData) ? widgetData : widgetData?.items || [],
-      };
-    }
-
-    return {
-      ...widget,
-      ...options
-    };
-  }, []);
-
-  return (
-    <div ref={containerRef} className={cn("w-full", className)} data-testid="grid-layout">
-      {hasDndProvider && <DndEditModeBridge editMode={editMode} />}
-      <div className="mb-4 flex items-center justify-between">
-        <h2 className="text-2xl font-bold">{schema.title || 'Dashboard'}</h2>
-        <div className="flex gap-2">
-          {editMode ? (
-            <>
-              <Button onClick={handleSaveLayout} size="sm" variant="default">
-                <Save className="h-4 w-4 mr-2" />
-                Save Layout
-              </Button>
-              <Button onClick={handleResetLayout} size="sm" variant="outline">
-                <X className="h-4 w-4 mr-2" />
-                Reset
-              </Button>
-              <Button onClick={() => setEditMode(false)} size="sm" variant="ghost">
-                Cancel
-              </Button>
-            </>
-          ) : (
-            <>
-              {onRefresh && (
-                <Button
-                  onClick={handleRefresh}
-                  size="sm"
-                  variant="outline"
-                  disabled={refreshing}
-                  aria-label="Refresh dashboard"
-                >
-                  <RefreshCw className={cn("h-4 w-4 mr-2", refreshing && "animate-spin")} />
-                  {refreshing ? 'Refreshing…' : 'Refresh All'}
-                </Button>
-              )}
-              <Button onClick={() => setEditMode(true)} size="sm" variant="outline">
-                <Edit className="h-4 w-4 mr-2" />
-                Edit Layout
-              </Button>
-            </>
-          )}
-        </div>
-      </div>
-
-      {mounted && (
-        <ResponsiveGridLayout
-          className="layout"
-          width={width}
-          layouts={layouts}
-          breakpoints={{ lg: 1200, md: 996, sm: 768, xs: 480, xxs: 0 }}
-          cols={{ lg: 12, md: 10, sm: 6, xs: 4, xxs: 2 }}
-          rowHeight={60}
-          dragConfig={{ enabled: editMode, handle: ".drag-handle" }}
-          resizeConfig={{ enabled: editMode }}
-          onLayoutChange={handleLayoutChange}
-        >
-          {schema.widgets?.map((widget, index) => {
-            const widgetId = widget.id || `widget-${index}`;
-            const componentSchema = getComponentSchema(widget);
-            const isSelfContained = widget.type === 'metric';
-
-            return (
-              <div key={widgetId} className="h-full">
-                {isSelfContained ? (
-                  <div className="h-full w-full relative">
-                    {editMode && (
-                      <div className="drag-handle absolute top-2 right-2 z-10 cursor-move p-1 bg-background/80 rounded border border-border">
-                        <GripVertical className="h-4 w-4" />
-                      </div>
-                    )}
-                    <SchemaRenderer schema={componentSchema} className="h-full w-full" />
-                  </div>
-                ) : (
-                  <Card className={cn(
-                    "h-full overflow-hidden border-border/50 shadow-sm transition-all",
-                    "bg-card/50 backdrop-blur-sm",
-                    editMode && "ring-2 ring-primary/20"
-                  )}>
-                    {widget.title && (
-                      <CardHeader className="pb-2 border-b border-border/40 bg-muted/20 flex flex-row items-center justify-between">
-                        <CardTitle className="text-base font-medium tracking-tight truncate" title={widget.title}>
-                          {widget.title}
-                        </CardTitle>
-                        {editMode && (
-                          <div className="drag-handle cursor-move p-1 hover:bg-muted/40 rounded">
-                            <GripVertical className="h-4 w-4" />
-                          </div>
-                        )}
-                      </CardHeader>
-                    )}
-                    <CardContent className="p-0 h-full">
-                      <div className={cn("h-full w-full overflow-auto p-4")}>
-                        <SchemaRenderer schema={componentSchema} />
-                      </div>
-                    </CardContent>
-                  </Card>
-                )}
-              </div>
-            );
-          })}
-        </ResponsiveGridLayout>
-      )}
-    </div>
-  );
-};

package/src/DashboardRenderer.stories.tsx

@@ -1,173 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { SchemaRenderer } from '@object-ui/react';
-import type { BaseSchema } from '@object-ui/types';
-
-const meta = {
-  title: 'Plugins/DashboardRenderer',
-  component: SchemaRenderer,
-  parameters: {
-    layout: 'padded',
-  },
-  tags: ['autodocs'],
-  argTypes: {
-    schema: { table: { disable: true } },
-  },
-} satisfies Meta<any>;
-
-export default meta;
-type Story = StoryObj<typeof meta>;
-
-const renderStory = (args: any) => <SchemaRenderer schema={args as unknown as BaseSchema} />;
-
-export const Default: Story = {
-  render: renderStory,
-  args: {
-    type: 'dashboard',
-    columns: 3,
-    gap: 4,
-    widgets: [
-      {
-        id: 'metric-1',
-        component: {
-          type: 'metric',
-          label: 'Total Revenue',
-          value: '$128,430',
-        },
-      },
-      {
-        id: 'metric-2',
-        component: {
-          type: 'metric',
-          label: 'Active Users',
-          value: '3,842',
-        },
-      },
-      {
-        id: 'metric-3',
-        component: {
-          type: 'metric',
-          label: 'Conversion Rate',
-          value: '4.2%',
-        },
-      },
-    ],
-  } as any,
-};
-
-export const WithMetricCards: Story = {
-  render: renderStory,
-  args: {
-    type: 'dashboard',
-    columns: 3,
-    gap: 4,
-    widgets: [
-      {
-        id: 'mc-1',
-        component: {
-          type: 'metric-card',
-          title: 'Monthly Revenue',
-          value: '$52,489',
-          icon: 'DollarSign',
-          trend: 'up',
-          trendValue: '+14.2%',
-          description: 'vs last month',
-        },
-        layout: { x: 0, y: 0, w: 1, h: 1 },
-      },
-      {
-        id: 'mc-2',
-        component: {
-          type: 'metric-card',
-          title: 'New Signups',
-          value: '1,205',
-          icon: 'Users',
-          trend: 'up',
-          trendValue: '+8.1%',
-          description: 'vs last month',
-        },
-        layout: { x: 1, y: 0, w: 1, h: 1 },
-      },
-      {
-        id: 'mc-3',
-        component: {
-          type: 'metric-card',
-          title: 'Churn Rate',
-          value: '1.8%',
-          icon: 'TrendingDown',
-          trend: 'down',
-          trendValue: '-0.3%',
-          description: 'vs last month',
-        },
-        layout: { x: 2, y: 0, w: 1, h: 1 },
-      },
-    ],
-  } as any,
-};
-
-export const WithChartsAndMetrics: Story = {
-  render: renderStory,
-  args: {
-    type: 'dashboard',
-    columns: 3,
-    gap: 4,
-    widgets: [
-      {
-        id: 'd-m1',
-        component: {
-          type: 'metric-card',
-          title: 'Total Orders',
-          value: '1,284',
-          icon: 'ShoppingCart',
-          trend: 'up',
-          trendValue: '+11%',
-        },
-        layout: { x: 0, y: 0, w: 1, h: 1 },
-      },
-      {
-        id: 'd-m2',
-        component: {
-          type: 'metric-card',
-          title: 'Avg Order Value',
-          value: '$86.50',
-          icon: 'DollarSign',
-          trend: 'up',
-          trendValue: '+3.2%',
-        },
-        layout: { x: 1, y: 0, w: 1, h: 1 },
-      },
-      {
-        id: 'd-m3',
-        component: {
-          type: 'metric-card',
-          title: 'Return Rate',
-          value: '2.1%',
-          icon: 'TrendingDown',
-          trend: 'down',
-          trendValue: '-0.8%',
-        },
-        layout: { x: 2, y: 0, w: 1, h: 1 },
-      },
-      {
-        id: 'd-chart',
-        title: 'Weekly Sales',
-        component: {
-          type: 'chart',
-          chartType: 'bar',
-          data: [
-            { day: 'Mon', sales: 120 },
-            { day: 'Tue', sales: 180 },
-            { day: 'Wed', sales: 150 },
-            { day: 'Thu', sales: 210 },
-            { day: 'Fri', sales: 190 },
-          ],
-          xAxisKey: 'day',
-          series: [{ dataKey: 'sales' }],
-          config: {
-            sales: { label: 'Sales', color: '#3b82f6' },
-          },
-        },
-        layout: { x: 0, y: 1, w: 3, h: 2 },
-      },
-    ],
-  } as any,
-};