@object-ui/plugin-list 3.3.0 → 3.3.1

package/src/__tests__/GalleryTimelineSpecConfig.test.tsx

@@ -1,203 +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 { describe, it, expect } from 'vitest';
-import type { ListViewSchema } from '@object-ui/types';
-
-/**
- * Tests for Gallery/Timeline spec config propagation through ListView's
- * buildViewSchema. We test the internal logic by checking that the
- * ListViewSchema types accept spec config and that the config values are correct.
- */
-
-describe('Gallery/Timeline Spec Config Types', () => {
-  describe('GalleryConfig on ListViewSchema', () => {
-    it('accepts spec gallery config with coverField', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'products',
-        viewType: 'gallery',
-        fields: ['name', 'photo'],
-        gallery: {
-          coverField: 'photo',
-          coverFit: 'contain',
-          cardSize: 'large',
-          titleField: 'name',
-          visibleFields: ['status', 'price'],
-        },
-      };
-
-      expect(schema.gallery?.coverField).toBe('photo');
-      expect(schema.gallery?.coverFit).toBe('contain');
-      expect(schema.gallery?.cardSize).toBe('large');
-      expect(schema.gallery?.titleField).toBe('name');
-      expect(schema.gallery?.visibleFields).toEqual(['status', 'price']);
-    });
-
-    it('accepts all cardSize values', () => {
-      const sizes = ['small', 'medium', 'large'] as const;
-      sizes.forEach((cardSize) => {
-        const schema: ListViewSchema = {
-          type: 'list-view',
-          objectName: 'products',
-          viewType: 'gallery',
-          fields: ['name'],
-          gallery: { cardSize },
-        };
-        expect(schema.gallery?.cardSize).toBe(cardSize);
-      });
-    });
-
-    it('accepts all coverFit values', () => {
-      const fits = ['cover', 'contain', 'fill'] as const;
-      fits.forEach((coverFit) => {
-        const schema: ListViewSchema = {
-          type: 'list-view',
-          objectName: 'products',
-          viewType: 'gallery',
-          fields: ['name'],
-          gallery: { coverFit },
-        };
-        expect(schema.gallery?.coverFit).toBe(coverFit);
-      });
-    });
-
-    it('accepts legacy imageField and subtitleField alongside spec fields', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'products',
-        viewType: 'gallery',
-        fields: ['name'],
-        gallery: {
-          coverField: 'photo',
-          imageField: 'legacyImg',
-          subtitleField: 'description',
-        },
-      };
-
-      expect(schema.gallery?.coverField).toBe('photo');
-      expect(schema.gallery?.imageField).toBe('legacyImg');
-      expect(schema.gallery?.subtitleField).toBe('description');
-    });
-
-    it('accepts gallery config from legacy options as fallback', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'products',
-        viewType: 'gallery',
-        fields: ['name'],
-        options: {
-          gallery: { imageField: 'oldImg', titleField: 'label' },
-        },
-      };
-
-      expect(schema.options?.gallery?.imageField).toBe('oldImg');
-      expect(schema.options?.gallery?.titleField).toBe('label');
-    });
-  });
-
-  describe('TimelineConfig on ListViewSchema', () => {
-    it('accepts spec timeline config with all fields', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'events',
-        viewType: 'timeline',
-        fields: ['name', 'date'],
-        timeline: {
-          startDateField: 'start_date',
-          endDateField: 'end_date',
-          titleField: 'event_name',
-          groupByField: 'category',
-          colorField: 'priority_color',
-          scale: 'month',
-        },
-      };
-
-      expect(schema.timeline?.startDateField).toBe('start_date');
-      expect(schema.timeline?.endDateField).toBe('end_date');
-      expect(schema.timeline?.titleField).toBe('event_name');
-      expect(schema.timeline?.groupByField).toBe('category');
-      expect(schema.timeline?.colorField).toBe('priority_color');
-      expect(schema.timeline?.scale).toBe('month');
-    });
-
-    it('accepts legacy dateField for backward compatibility', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'events',
-        viewType: 'timeline',
-        fields: ['name'],
-        timeline: {
-          startDateField: 'created_at',
-          titleField: 'name',
-          dateField: 'legacy_date',
-        },
-      };
-
-      expect(schema.timeline?.startDateField).toBe('created_at');
-      expect(schema.timeline?.dateField).toBe('legacy_date');
-    });
-
-    it('supports all scale values', () => {
-      const scales = ['hour', 'day', 'week', 'month', 'quarter', 'year'] as const;
-      scales.forEach((scale) => {
-        const schema: ListViewSchema = {
-          type: 'list-view',
-          objectName: 'events',
-          viewType: 'timeline',
-          fields: ['name'],
-          timeline: { startDateField: 'date', titleField: 'name', scale },
-        };
-        expect(schema.timeline?.scale).toBe(scale);
-      });
-    });
-
-    it('accepts timeline config from legacy options as fallback', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'events',
-        viewType: 'timeline',
-        fields: ['name'],
-        options: {
-          timeline: { dateField: 'created_at', titleField: 'name' },
-        },
-      };
-
-      expect(schema.options?.timeline?.dateField).toBe('created_at');
-    });
-  });
-
-  describe('spec config co-existence', () => {
-    it('gallery and timeline configs can coexist on the same ListViewSchema', () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'projects',
-        viewType: 'grid',
-        fields: ['name', 'date', 'photo'],
-        gallery: {
-          coverField: 'photo',
-          cardSize: 'medium',
-          titleField: 'name',
-          visibleFields: ['status'],
-        },
-        timeline: {
-          startDateField: 'start_date',
-          titleField: 'name',
-          scale: 'quarter',
-          groupByField: 'team',
-        },
-      };
-
-      expect(schema.gallery?.coverField).toBe('photo');
-      expect(schema.gallery?.cardSize).toBe('medium');
-      expect(schema.timeline?.startDateField).toBe('start_date');
-      expect(schema.timeline?.scale).toBe('quarter');
-      expect(schema.timeline?.groupByField).toBe('team');
-    });
-  });
-});

package/src/__tests__/ListRefresh.test.tsx

@@ -1,276 +0,0 @@
-/**
- * ObjectUI — List Refresh Tests
- * Tests for the standardized list refresh after mutation mechanism.
- *
- * Covers:
- *  - P0: refreshTrigger prop triggers data re-fetch
- *  - P1: Imperative refresh() via forwardRef
- *  - P2: Auto-refresh via DataSource.onMutation()
- */
-
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import * as React from 'react';
-import { render, act } from '@testing-library/react';
-import { ListView } from '../ListView';
-import type { ListViewHandle } from '../ListView';
-import type { ListViewSchema } from '@object-ui/types';
-import { SchemaRendererProvider } from '@object-ui/react';
-
-let mockDataSource: any;
-
-const renderWithProvider = (component: React.ReactNode, ds?: any) =>
-  render(
-    <SchemaRendererProvider dataSource={ds || mockDataSource}>
-      {component}
-    </SchemaRendererProvider>,
-  );
-
-describe('ListView Refresh Mechanisms', () => {
-  beforeEach(() => {
-    mockDataSource = {
-      find: vi.fn().mockResolvedValue([]),
-      findOne: vi.fn(),
-      create: vi.fn(),
-      update: vi.fn(),
-      delete: vi.fn(),
-      getObjectSchema: vi.fn().mockResolvedValue({ name: 'contacts', fields: {} }),
-    };
-  });
-
-  // =========================================================================
-  // P0: refreshTrigger schema prop
-  // =========================================================================
-  describe('P0 — refreshTrigger prop', () => {
-    it('should re-fetch data when refreshTrigger changes', async () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-        refreshTrigger: 0,
-      };
-
-      const { rerender } = renderWithProvider(
-        <ListView schema={schema} dataSource={mockDataSource} />,
-      );
-
-      // Wait for initial data fetch
-      await vi.waitFor(() => {
-        expect(mockDataSource.find).toHaveBeenCalled();
-      });
-
-      const initialCallCount = mockDataSource.find.mock.calls.length;
-
-      // Increment refreshTrigger → should trigger a new data fetch
-      const updatedSchema: ListViewSchema = { ...schema, refreshTrigger: 1 };
-      rerender(
-        <SchemaRendererProvider dataSource={mockDataSource}>
-          <ListView schema={updatedSchema} dataSource={mockDataSource} />
-        </SchemaRendererProvider>,
-      );
-
-      await vi.waitFor(() => {
-        expect(mockDataSource.find.mock.calls.length).toBeGreaterThan(initialCallCount);
-      });
-    });
-
-    it('should NOT re-fetch when refreshTrigger stays the same', async () => {
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-        refreshTrigger: 5,
-      };
-
-      const { rerender } = renderWithProvider(
-        <ListView schema={schema} dataSource={mockDataSource} />,
-      );
-
-      await vi.waitFor(() => {
-        expect(mockDataSource.find).toHaveBeenCalled();
-      });
-
-      const callCount = mockDataSource.find.mock.calls.length;
-
-      // Re-render with the same refreshTrigger → no extra fetch
-      rerender(
-        <SchemaRendererProvider dataSource={mockDataSource}>
-          <ListView schema={{ ...schema }} dataSource={mockDataSource} />
-        </SchemaRendererProvider>,
-      );
-
-      // Wait a tick and verify no extra call
-      await new Promise(r => setTimeout(r, 100));
-      expect(mockDataSource.find.mock.calls.length).toBe(callCount);
-    });
-  });
-
-  // =========================================================================
-  // P1: Imperative refresh() via forwardRef
-  // =========================================================================
-  describe('P1 — imperative refresh() API', () => {
-    it('should expose a refresh() method via ref', () => {
-      const ref = React.createRef<ListViewHandle>();
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      renderWithProvider(<ListView ref={ref} schema={schema} dataSource={mockDataSource} />);
-
-      expect(ref.current).toBeDefined();
-      expect(typeof ref.current?.refresh).toBe('function');
-    });
-
-    it('calling refresh() should trigger a data re-fetch', async () => {
-      const ref = React.createRef<ListViewHandle>();
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      renderWithProvider(<ListView ref={ref} schema={schema} dataSource={mockDataSource} />);
-
-      await vi.waitFor(() => {
-        expect(mockDataSource.find).toHaveBeenCalled();
-      });
-
-      const callCount = mockDataSource.find.mock.calls.length;
-
-      // Call imperative refresh
-      act(() => {
-        ref.current?.refresh();
-      });
-
-      await vi.waitFor(() => {
-        expect(mockDataSource.find.mock.calls.length).toBeGreaterThan(callCount);
-      });
-    });
-  });
-
-  // =========================================================================
-  // P2: Auto-refresh via DataSource.onMutation()
-  // =========================================================================
-  describe('P2 — DataSource.onMutation() auto-refresh', () => {
-    it('should auto-refresh when a mutation event fires for the same resource', async () => {
-      let mutationCallback: ((event: any) => void) | null = null;
-      const unsub = vi.fn();
-
-      const dsWithMutation = {
-        ...mockDataSource,
-        onMutation: vi.fn((cb: any) => {
-          mutationCallback = cb;
-          return unsub;
-        }),
-      };
-
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      renderWithProvider(
-        <ListView schema={schema} dataSource={dsWithMutation} />,
-        dsWithMutation,
-      );
-
-      await vi.waitFor(() => {
-        expect(dsWithMutation.find).toHaveBeenCalled();
-      });
-
-      const callCount = dsWithMutation.find.mock.calls.length;
-
-      // Simulate a mutation on the same resource
-      act(() => {
-        mutationCallback?.({ type: 'create', resource: 'contacts', record: { id: '1' } });
-      });
-
-      await vi.waitFor(() => {
-        expect(dsWithMutation.find.mock.calls.length).toBeGreaterThan(callCount);
-      });
-    });
-
-    it('should NOT refresh when a mutation fires for a different resource', async () => {
-      let mutationCallback: ((event: any) => void) | null = null;
-
-      const dsWithMutation = {
-        ...mockDataSource,
-        onMutation: vi.fn((cb: any) => {
-          mutationCallback = cb;
-          return vi.fn();
-        }),
-      };
-
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      renderWithProvider(
-        <ListView schema={schema} dataSource={dsWithMutation} />,
-        dsWithMutation,
-      );
-
-      await vi.waitFor(() => {
-        expect(dsWithMutation.find).toHaveBeenCalled();
-      });
-
-      const callCount = dsWithMutation.find.mock.calls.length;
-
-      // Fire a mutation for a different resource
-      act(() => {
-        mutationCallback?.({ type: 'create', resource: 'accounts', record: { id: '2' } });
-      });
-
-      // Should NOT trigger a refresh
-      await new Promise(r => setTimeout(r, 100));
-      expect(dsWithMutation.find.mock.calls.length).toBe(callCount);
-    });
-
-    it('should unsubscribe when unmounted', async () => {
-      const unsub = vi.fn();
-      const dsWithMutation = {
-        ...mockDataSource,
-        onMutation: vi.fn(() => unsub),
-      };
-
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      const { unmount } = renderWithProvider(
-        <ListView schema={schema} dataSource={dsWithMutation} />,
-        dsWithMutation,
-      );
-
-      await vi.waitFor(() => {
-        expect(dsWithMutation.onMutation).toHaveBeenCalled();
-      });
-
-      unmount();
-      expect(unsub).toHaveBeenCalled();
-    });
-
-    it('should work without onMutation (backward compatible)', async () => {
-      // DataSource without onMutation — should not throw
-      const schema: ListViewSchema = {
-        type: 'list-view',
-        objectName: 'contacts',
-        fields: ['name'],
-      };
-
-      renderWithProvider(
-        <ListView schema={schema} dataSource={mockDataSource} />,
-      );
-
-      await vi.waitFor(() => {
-        expect(mockDataSource.find).toHaveBeenCalled();
-      });
-    });
-  });
-});