@object-ui/react 3.3.0 → 3.3.1

package/src/hooks/__tests__/useViewSharing.test.ts

@@ -1,121 +0,0 @@
-/**
- * Tests for useViewSharing hook
- */
-import { describe, it, expect } from 'vitest';
-import { renderHook, act } from '@testing-library/react';
-import { useViewSharing } from '../useViewSharing';
-import type { SavedView } from '../useViewSharing';
-
-const createView = (overrides?: Partial<SavedView>): SavedView => ({
-  id: 'test-1',
-  name: 'Test View',
-  config: { filters: [] },
-  visibility: 'private',
-  updatedAt: new Date(),
-  ...overrides,
-});
-
-describe('useViewSharing', () => {
-  it('starts with empty views by default', () => {
-    const { result } = renderHook(() => useViewSharing());
-    expect(result.current.views).toEqual([]);
-    expect(result.current.activeView).toBeNull();
-  });
-
-  it('starts with provided initial views', () => {
-    const initial = [createView()];
-    const { result } = renderHook(() => useViewSharing(initial));
-    expect(result.current.views).toHaveLength(1);
-    expect(result.current.activeView?.id).toBe('test-1');
-  });
-
-  it('saves a new view', () => {
-    const { result } = renderHook(() => useViewSharing());
-
-    act(() => {
-      result.current.saveView({
-        name: 'My View',
-        config: { sort: 'name' },
-        visibility: 'private',
-      });
-    });
-
-    expect(result.current.views).toHaveLength(1);
-    expect(result.current.views[0].name).toBe('My View');
-  });
-
-  it('returns ID when saving a view', () => {
-    const { result } = renderHook(() => useViewSharing());
-
-    let id: string = '';
-    act(() => {
-      id = result.current.saveView({
-        name: 'My View',
-        config: {},
-        visibility: 'private',
-      });
-    });
-
-    expect(id).toBeTruthy();
-    expect(id).toContain('view-');
-  });
-
-  it('deletes a view', () => {
-    const initial = [createView()];
-    const { result } = renderHook(() => useViewSharing(initial));
-
-    act(() => {
-      result.current.deleteView('test-1');
-    });
-
-    expect(result.current.views).toHaveLength(0);
-  });
-
-  it('sets active view', () => {
-    const initial = [
-      createView({ id: 'v1', name: 'View 1' }),
-      createView({ id: 'v2', name: 'View 2' }),
-    ];
-    const { result } = renderHook(() => useViewSharing(initial));
-
-    act(() => {
-      result.current.setActiveView('v2');
-    });
-
-    expect(result.current.activeView?.id).toBe('v2');
-  });
-
-  it('duplicates a view', () => {
-    const initial = [createView()];
-    const { result } = renderHook(() => useViewSharing(initial));
-
-    act(() => {
-      result.current.duplicateView('test-1', 'Copy of Test');
-    });
-
-    expect(result.current.views).toHaveLength(2);
-    expect(result.current.views[1].name).toBe('Copy of Test');
-    expect(result.current.views[1].isDefault).toBe(false);
-  });
-
-  it('updates view visibility', () => {
-    const initial = [createView()];
-    const { result } = renderHook(() => useViewSharing(initial));
-
-    act(() => {
-      result.current.setVisibility('test-1', 'organization');
-    });
-
-    expect(result.current.views[0].visibility).toBe('organization');
-  });
-
-  it('selects default view as active', () => {
-    const initial = [
-      createView({ id: 'v1', name: 'View 1' }),
-      createView({ id: 'v2', name: 'View 2', isDefault: true }),
-    ];
-    const { result } = renderHook(() => useViewSharing(initial));
-
-    expect(result.current.activeView?.id).toBe('v2');
-  });
-});

package/src/hooks/__tests__/useViewTransition.test.ts

@@ -1,61 +0,0 @@
-/**
- * Tests for useViewTransition hook
- */
-import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
-import { renderHook, act } from '@testing-library/react';
-import { useViewTransition } from '../useViewTransition';
-
-describe('useViewTransition', () => {
-  beforeEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it('returns isSupported as false when document.startViewTransition is not available', () => {
-    const { result } = renderHook(() => useViewTransition());
-
-    // happy-dom does not implement startViewTransition
-    expect(result.current.isSupported).toBe(false);
-  });
-
-  it('returns isTransitioning as false initially', () => {
-    const { result } = renderHook(() => useViewTransition());
-
-    expect(result.current.isTransitioning).toBe(false);
-  });
-
-  it('startTransition calls callback without transition API (fallback behavior)', async () => {
-    const { result } = renderHook(() => useViewTransition());
-
-    const callback = vi.fn();
-
-    await act(async () => {
-      await result.current.startTransition(callback);
-    });
-
-    expect(callback).toHaveBeenCalledTimes(1);
-  });
-
-  it('respects enabled: false by calling callback directly', async () => {
-    const { result } = renderHook(() =>
-      useViewTransition({ enabled: false }),
-    );
-
-    const callback = vi.fn();
-
-    await act(async () => {
-      await result.current.startTransition(callback);
-    });
-
-    expect(callback).toHaveBeenCalledTimes(1);
-  });
-
-  it('transitionClass is empty initially', () => {
-    const { result } = renderHook(() => useViewTransition());
-
-    expect(result.current.transitionClass).toBe('');
-  });
-});

package/src/hooks/index.ts

@@ -1,36 +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.
- */
-
-export * from './useExpression';
-export * from './useActionRunner';
-export * from './useNavigationOverlay';
-export * from './usePageVariables';
-export * from './useViewData';
-export * from './useDynamicApp';
-export * from './useDiscovery';
-export * from './useFocusTrap';
-export * from './useFocusManagement';
-export * from './useKeyboardShortcuts';
-export * from './useCrudShortcuts';
-export * from './useReducedMotion';
-export * from './useAnimation';
-export * from './useColumnSummary';
-export * from './useDensityMode';
-export * from './useViewSharing';
-export * from './useClientNotifications';
-export * from './useOffline';
-export * from './usePerformance';
-export * from './usePerformanceBudget';
-export * from './usePageTransition';
-export * from './useViewTransition';
-export * from './useETagCache';
-export * from './useSchemaPersistence';
-export * from './useGlobalUndo';
-export * from './useDebugMode';
-export * from './useActionEngine';
-export * from './useDataRefresh';

package/src/hooks/useActionEngine.ts

@@ -1,84 +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.
- */
-
-/**
- * useActionEngine — React hook wrapping ActionEngine for location-based action management.
- *
- * Provides declarative access to the ActionEngine's location filtering, bulk operations,
- * keyboard shortcut handling, and execution pipeline from React components.
- *
- * @example
- * ```tsx
- * const { getActionsForLocation, executeAction } = useActionEngine({
- *   actions: schema.actions,
- *   context: { record, user },
- * });
- *
- * const toolbarActions = getActionsForLocation('list_toolbar');
- * ```
- */
-
-import { useCallback, useMemo } from 'react';
-import {
-  ActionEngine,
-  type ActionLocation,
-  type ActionDef,
-  type ActionContext,
-  type ActionResult,
-} from '@object-ui/core';
-
-export interface UseActionEngineOptions {
-  /** Action definitions to register */
-  actions?: ActionDef[];
-  /** Action context (record, user, etc.) */
-  context?: ActionContext;
-}
-
-export interface UseActionEngineReturn {
-  /** Get actions available at a specific location, sorted by priority */
-  getActionsForLocation: (location: ActionLocation) => ActionDef[];
-  /** Get actions that support bulk operations */
-  getBulkActions: () => ActionDef[];
-  /** Execute an action by name */
-  executeAction: (name: string, contextOverride?: Partial<ActionContext>) => Promise<ActionResult>;
-  /** Handle a keyboard shortcut */
-  handleShortcut: (keys: string) => Promise<ActionResult | null>;
-  /** The underlying ActionEngine instance */
-  engine: ActionEngine;
-}
-
-export function useActionEngine(options: UseActionEngineOptions = {}): UseActionEngineReturn {
-  const { actions = [], context = {} } = options;
-
-  const engine = useMemo(() => {
-    const e = new ActionEngine(context);
-    e.registerActions(actions);
-    return e;
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [JSON.stringify(actions), JSON.stringify(context)]);
-
-  const getActionsForLocation = useCallback(
-    (location: ActionLocation) => engine.getActionsForLocation(location),
-    [engine],
-  );
-
-  const getBulkActions = useCallback(() => engine.getBulkActions(), [engine]);
-
-  const executeAction = useCallback(
-    (name: string, contextOverride?: Partial<ActionContext>) =>
-      engine.executeAction(name, contextOverride),
-    [engine],
-  );
-
-  const handleShortcut = useCallback(
-    (keys: string) => engine.handleShortcut(keys),
-    [engine],
-  );
-
-  return { getActionsForLocation, getBulkActions, executeAction, handleShortcut, engine };
-}

package/src/hooks/useActionRunner.ts

@@ -1,119 +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 { useState, useCallback, useMemo } from 'react';
-import {
-  ActionRunner,
-  type ActionContext,
-  type ActionDef,
-  type ActionResult,
-  type ConfirmationHandler,
-  type ToastHandler,
-  type ModalHandler,
-  type NavigationHandler,
-} from '@object-ui/core';
-
-export interface UseActionRunnerOptions {
-  context?: ActionContext;
-  /** Custom confirmation handler — wire to Shadcn AlertDialog or similar */
-  onConfirm?: ConfirmationHandler;
-  /** Custom toast handler — wire to Sonner or similar */
-  onToast?: ToastHandler;
-  /** Custom modal handler — render modals in response to modal actions */
-  onModal?: ModalHandler;
-  /** Custom navigation handler — SPA-aware routing */
-  onNavigate?: NavigationHandler;
-}
-
-/**
- * Hook for executing actions with loading state, typed with ActionDef.
- * 
- * @example
- * ```tsx
- * const { execute, loading, error, result } = useActionRunner({
- *   context: { data: formData },
- *   onToast: (msg, opts) => toast[opts?.type || 'info'](msg),
- * });
- * 
- * const handleClick = () => {
- *   execute({
- *     type: 'api',
- *     api: '/api/save',
- *     successMessage: 'Saved successfully!',
- *   });
- * };
- * ```
- */
-export function useActionRunner(
-  optionsOrContext: UseActionRunnerOptions | ActionContext = {},
-) {
-  // Backwards compat: if no 'context' key, treat entire object as context
-  const options: UseActionRunnerOptions = 'context' in optionsOrContext
-    ? optionsOrContext as UseActionRunnerOptions
-    : { context: optionsOrContext as ActionContext };
-
-  const { context = {}, onConfirm, onToast, onModal, onNavigate } = options;
-
-  const [loading, setLoading] = useState(false);
-  const [error, setError] = useState<string | null>(null);
-  const [result, setResult] = useState<ActionResult | null>(null);
-
-  const runner = useMemo(() => {
-    const r = new ActionRunner(context);
-    if (onConfirm) r.setConfirmHandler(onConfirm);
-    if (onToast) r.setToastHandler(onToast);
-    if (onModal) r.setModalHandler(onModal);
-    if (onNavigate) r.setNavigationHandler(onNavigate);
-    return r;
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [JSON.stringify(context)]);
-
-  const execute = useCallback(
-    async (action: ActionDef): Promise<ActionResult> => {
-      setLoading(true);
-      setError(null);
-      setResult(null);
-
-      try {
-        const actionResult = await runner.execute(action);
-        setResult(actionResult);
-
-        if (!actionResult.success) {
-          setError(actionResult.error || 'Action failed');
-        }
-
-        return actionResult;
-      } catch (err) {
-        const errorMessage = (err as Error).message;
-        setError(errorMessage);
-        const failureResult = { success: false, error: errorMessage };
-        setResult(failureResult);
-        return failureResult;
-      } finally {
-        setLoading(false);
-      }
-    },
-    [runner]
-  );
-
-  const updateContext = useCallback(
-    (newContext: Partial<ActionContext>) => {
-      runner.updateContext(newContext);
-    },
-    [runner]
-  );
-
-  return {
-    execute,
-    loading,
-    error,
-    result,
-    updateContext,
-    runner
-  };
-}

package/src/hooks/useAnimation.ts

@@ -1,117 +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 { useMemo } from 'react';
-
-/** Animation trigger type */
-export type AnimationTriggerType = 'enter' | 'exit' | 'hover' | 'focus' | 'click';
-
-/** Easing presets aligned with EasingFunctionSchema */
-export type EasingPreset =
-  | 'linear'
-  | 'ease'
-  | 'ease-in'
-  | 'ease-out'
-  | 'ease-in-out'
-  | 'spring';
-
-/** Transition preset aligned with TransitionPresetSchema */
-export type TransitionPresetType =
-  | 'fade'
-  | 'slide-up'
-  | 'slide-down'
-  | 'slide-left'
-  | 'slide-right'
-  | 'scale'
-  | 'scale-fade'
-  | 'none';
-
-export interface AnimationConfig {
-  /** The animation/transition preset */
-  preset?: TransitionPresetType;
-  /** Duration in milliseconds */
-  duration?: number;
-  /** Delay in milliseconds */
-  delay?: number;
-  /** Easing function */
-  easing?: EasingPreset;
-  /** Whether animation is enabled */
-  enabled?: boolean;
-}
-
-/** Resolved CSS classes and styles for animation */
-export interface AnimationResult {
-  /** Tailwind CSS classes for the animation */
-  className: string;
-  /** Inline style for custom durations/delays (only when needed) */
-  style: React.CSSProperties;
-}
-
-const EASING_MAP: Record<EasingPreset, string> = {
-  linear: 'linear',
-  ease: 'ease',
-  'ease-in': 'ease-in',
-  'ease-out': 'ease-out',
-  'ease-in-out': 'ease-in-out',
-  spring: 'cubic-bezier(0.34, 1.56, 0.64, 1)',
-};
-
-const PRESET_CLASSES: Record<TransitionPresetType, string> = {
-  fade: 'animate-in fade-in',
-  'slide-up': 'animate-in slide-in-from-bottom-2',
-  'slide-down': 'animate-in slide-in-from-top-2',
-  'slide-left': 'animate-in slide-in-from-right-2',
-  'slide-right': 'animate-in slide-in-from-left-2',
-  scale: 'animate-in zoom-in-95',
-  'scale-fade': 'animate-in fade-in zoom-in-95',
-  none: '',
-};
-
-/**
- * Hook for applying spec-driven animations to components.
- * Implements ComponentAnimationSchema and TransitionPresetSchema
- * from @objectstack/spec v2.0.7.
- *
- * @example
- * ```tsx
- * function Card() {
- *   const animation = useAnimation({ preset: 'fade', duration: 200, easing: 'ease-out' });
- *   return <div className={animation.className} style={animation.style}>...</div>;
- * }
- * ```
- */
-export function useAnimation(config: AnimationConfig = {}): AnimationResult {
-  const {
-    preset = 'none',
-    duration,
-    delay,
-    easing = 'ease-out',
-    enabled = true,
-  } = config;
-
-  return useMemo(() => {
-    if (!enabled || preset === 'none') {
-      return { className: '', style: {} };
-    }
-
-    const className = PRESET_CLASSES[preset] || '';
-    const style: React.CSSProperties = {};
-
-    if (duration !== undefined) {
-      style.animationDuration = `${duration}ms`;
-    }
-    if (delay !== undefined) {
-      style.animationDelay = `${delay}ms`;
-    }
-    if (easing) {
-      style.animationTimingFunction = EASING_MAP[easing] || easing;
-    }
-
-    return { className, style };
-  }, [preset, duration, delay, easing, enabled]);
-}