@object-ui/plugin-dashboard 3.0.3 → 3.1.0

package/src/__tests__/ensureWidgetIds.test.tsx

@@ -0,0 +1,103 @@
+/**
+ * Tests for the ensureWidgetIds helper pattern.
+ * Validates that widgets without IDs get auto-assigned unique IDs.
+ */
+
+import { describe, it, expect } from 'vitest';
+import type { DashboardSchema } from '@object-ui/types';
+
+/**
+ * Portable implementation of ensureWidgetIds — mirrors
+ * apps/console/src/components/DashboardView.tsx.
+ */
+let counter = 0;
+function createWidgetId(): string {
+  counter += 1;
+  return `widget_test_${counter}`;
+}
+
+function ensureWidgetIds(schema: DashboardSchema): DashboardSchema {
+  if (!schema.widgets?.length) return schema;
+  const needsFix = schema.widgets.some((w) => !w.id);
+  if (!needsFix) return schema;
+  return {
+    ...schema,
+    widgets: schema.widgets.map((w) => (w.id ? w : { ...w, id: createWidgetId() })),
+  };
+}
+
+describe('ensureWidgetIds', () => {
+  beforeEach(() => {
+    counter = 0;
+  });
+  it('should return same schema when all widgets have IDs', () => {
+    const schema: DashboardSchema = {
+      type: 'dashboard',
+      columns: 3,
+      widgets: [
+        { id: 'w1', title: 'A', type: 'metric' },
+        { id: 'w2', title: 'B', type: 'bar' },
+      ],
+    };
+    const result = ensureWidgetIds(schema);
+    expect(result).toBe(schema); // same reference — no mutation
+  });
+
+  it('should assign IDs to widgets missing them', () => {
+    const schema: DashboardSchema = {
+      type: 'dashboard',
+      columns: 3,
+      widgets: [
+        { title: 'No ID', type: 'metric' },
+        { id: 'w2', title: 'Has ID', type: 'bar' },
+      ],
+    };
+    const result = ensureWidgetIds(schema);
+    expect(result).not.toBe(schema);
+    expect(result.widgets[0].id).toBeTruthy();
+    expect(result.widgets[1].id).toBe('w2');
+  });
+
+  it('should handle empty widgets array', () => {
+    const schema: DashboardSchema = {
+      type: 'dashboard',
+      columns: 3,
+      widgets: [],
+    };
+    const result = ensureWidgetIds(schema);
+    expect(result).toBe(schema);
+  });
+
+  it('should generate unique IDs for multiple missing widgets', () => {
+    const schema: DashboardSchema = {
+      type: 'dashboard',
+      columns: 3,
+      widgets: [
+        { title: 'A', type: 'metric' },
+        { title: 'B', type: 'bar' },
+        { title: 'C', type: 'pie' },
+      ],
+    };
+    const result = ensureWidgetIds(schema);
+    const ids = result.widgets.map((w) => w.id);
+    // All IDs should be unique
+    expect(new Set(ids).size).toBe(ids.length);
+    // All IDs should be truthy
+    ids.forEach((id) => expect(id).toBeTruthy());
+  });
+
+  it('should preserve existing widget data', () => {
+    const schema: DashboardSchema = {
+      type: 'dashboard',
+      columns: 3,
+      widgets: [
+        { title: 'Revenue', type: 'metric', object: 'orders', layout: { x: 0, y: 0, w: 2, h: 1 } },
+      ],
+    };
+    const result = ensureWidgetIds(schema);
+    expect(result.widgets[0].title).toBe('Revenue');
+    expect(result.widgets[0].type).toBe('metric');
+    expect(result.widgets[0].object).toBe('orders');
+    expect(result.widgets[0].layout).toEqual({ x: 0, y: 0, w: 2, h: 1 });
+  });
+});

package/src/index.tsx

@@ -11,8 +11,14 @@ import { DashboardRenderer } from './DashboardRenderer';
 import { DashboardGridLayout } from './DashboardGridLayout';
 import { MetricWidget } from './MetricWidget';
 import { MetricCard } from './MetricCard';
+import { PivotTable } from './PivotTable';
+import { ObjectPivotTable } from './ObjectPivotTable';
+import { ObjectDataTable } from './ObjectDataTable';
+import { DashboardConfigPanel } from './DashboardConfigPanel';
+import { WidgetConfigPanel } from './WidgetConfigPanel';
+import { DashboardWithConfig } from './DashboardWithConfig';
 
-export { DashboardRenderer, DashboardGridLayout, MetricWidget, MetricCard };
+export { DashboardRenderer, DashboardGridLayout, MetricWidget, MetricCard, PivotTable, ObjectPivotTable, ObjectDataTable, DashboardConfigPanel, WidgetConfigPanel, DashboardWithConfig };
 
 // Register dashboard component
 ComponentRegistry.register(
@@ -77,6 +83,77 @@ ComponentRegistry.register(
   }
 );
 
+// Register pivot table component
+ComponentRegistry.register(
+  'pivot',
+  PivotTable,
+  {
+    namespace: 'plugin-dashboard',
+    label: 'Pivot Table',
+    category: 'Dashboard',
+    icon: 'table-2',
+    inputs: [
+      { name: 'title', type: 'string', label: 'Title' },
+      { name: 'rowField', type: 'string', label: 'Row Field', required: true },
+      { name: 'columnField', type: 'string', label: 'Column Field', required: true },
+      { name: 'valueField', type: 'string', label: 'Value Field', required: true },
+      { name: 'aggregation', type: 'enum', label: 'Aggregation', enum: [
+        { label: 'Sum', value: 'sum' },
+        { label: 'Count', value: 'count' },
+        { label: 'Average', value: 'avg' },
+        { label: 'Min', value: 'min' },
+        { label: 'Max', value: 'max' },
+      ]},
+      { name: 'showRowTotals', type: 'boolean', label: 'Show Row Totals' },
+      { name: 'showColumnTotals', type: 'boolean', label: 'Show Column Totals' },
+      { name: 'format', type: 'string', label: 'Number Format' },
+    ],
+    defaultProps: {
+      rowField: '',
+      columnField: '',
+      valueField: '',
+      aggregation: 'sum',
+      data: [],
+    }
+  }
+);
+
+// Register object-aware pivot table (async data loading)
+ComponentRegistry.register(
+  'object-pivot',
+  ObjectPivotTable,
+  {
+    namespace: 'plugin-dashboard',
+    label: 'Object Pivot Table',
+    category: 'Dashboard',
+    icon: 'table-2',
+    inputs: [
+      { name: 'objectName', type: 'string', label: 'Object Name', required: true },
+      { name: 'title', type: 'string', label: 'Title' },
+      { name: 'rowField', type: 'string', label: 'Row Field', required: true },
+      { name: 'columnField', type: 'string', label: 'Column Field', required: true },
+      { name: 'valueField', type: 'string', label: 'Value Field', required: true },
+      { name: 'aggregation', type: 'enum', label: 'Aggregation', enum: [
+        { label: 'Sum', value: 'sum' },
+        { label: 'Count', value: 'count' },
+        { label: 'Average', value: 'avg' },
+        { label: 'Min', value: 'min' },
+        { label: 'Max', value: 'max' },
+      ]},
+      { name: 'showRowTotals', type: 'boolean', label: 'Show Row Totals' },
+      { name: 'showColumnTotals', type: 'boolean', label: 'Show Column Totals' },
+      { name: 'filter', type: 'array', label: 'Filter' },
+      { name: 'format', type: 'string', label: 'Number Format' },
+    ],
+    defaultProps: {
+      rowField: '',
+      columnField: '',
+      valueField: '',
+      aggregation: 'sum',
+    }
+  }
+);
+
 // Register dashboard grid layout component
 ComponentRegistry.register(
   'dashboard-grid',
@@ -99,10 +176,39 @@ ComponentRegistry.register(
   }
 );
 
+// Register object-aware data table (async data loading)
+ComponentRegistry.register(
+  'object-data-table',
+  ObjectDataTable,
+  {
+    namespace: 'plugin-dashboard',
+    label: 'Object Data Table',
+    category: 'Dashboard',
+    icon: 'table',
+    inputs: [
+      { name: 'objectName', type: 'string', label: 'Object Name', required: true },
+      { name: 'columns', type: 'array', label: 'Columns' },
+      { name: 'filter', type: 'array', label: 'Filter' },
+      { name: 'searchable', type: 'boolean', label: 'Searchable' },
+      { name: 'pagination', type: 'boolean', label: 'Pagination' },
+    ],
+    defaultProps: {
+      searchable: false,
+      pagination: false,
+    }
+  }
+);
+
 // Standard Export Protocol - for manual integration
 export const dashboardComponents = {
   DashboardRenderer,
   DashboardGridLayout,
   MetricWidget,
   MetricCard,
+  PivotTable,
+  ObjectPivotTable,
+  ObjectDataTable,
+  DashboardConfigPanel,
+  WidgetConfigPanel,
+  DashboardWithConfig,
 };

package/src/utils.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+
+/** Returns true when the widget data config uses provider: 'object' (async data source). */
+export function isObjectProvider(widgetData: unknown): widgetData is { provider: 'object'; object?: string; aggregate?: any } {
+  return (
+    widgetData != null &&
+    typeof widgetData === 'object' &&
+    !Array.isArray(widgetData) &&
+    (widgetData as any).provider === 'object'
+  );
+}