@sovereignfs/ui 0.54.0 → 0.83.1

package/src/hooks/__tests__/useSnapCarousel.test.tsx

@@ -36,6 +36,7 @@ describe('useSnapCarousel', () => {
     const onSettle = vi.fn();
     const { getByTestId } = render(<Harness itemCount={3} onSettle={onSettle} debounceMs={120} />);
     const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
     setLayout(el, 300, 300); // scrollLeft 300 / width 300 -> index 1
     fireEvent.scroll(el);
     expect(onSettle).not.toHaveBeenCalled();
@@ -47,6 +48,7 @@ describe('useSnapCarousel', () => {
     const onSettle = vi.fn();
     const { getByTestId } = render(<Harness itemCount={3} onSettle={onSettle} debounceMs={120} />);
     const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
     setLayout(el, 300, 0);
     fireEvent.scroll(el);
     act(() => void vi.advanceTimersByTime(60));
@@ -61,9 +63,11 @@ describe('useSnapCarousel', () => {
     const onSettle = vi.fn();
     const { getByTestId } = render(<Harness itemCount={3} onSettle={onSettle} debounceMs={120} />);
     const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
     setLayout(el, 300, 300);
     fireEvent.scroll(el);
     act(() => void vi.advanceTimersByTime(120));
+    fireEvent.touchStart(el);
     fireEvent.scroll(el);
     act(() => void vi.advanceTimersByTime(120));
     expect(onSettle).toHaveBeenCalledOnce();
@@ -73,12 +77,90 @@ describe('useSnapCarousel', () => {
     const onSettle = vi.fn();
     const { getByTestId } = render(<Harness itemCount={2} onSettle={onSettle} debounceMs={120} />);
     const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
     setLayout(el, 300, 900); // rounds to index 3, clamps to itemCount - 1 = 1
     fireEvent.scroll(el);
     act(() => void vi.advanceTimersByTime(120));
     expect(onSettle).toHaveBeenCalledWith(1);
   });
 
+  it('ignores a scroll event with no active gesture (drift, not a settle)', () => {
+    // Regression test: reproduced live via a user screen recording — a
+    // slide's content changing size while still loading can nudge
+    // scrollLeft enough to round to a different index. Previously any such
+    // stray `scroll` event was enough to fire a second, contradicting
+    // onSettle, silently "auto-swiping" the carousel back to the wrong
+    // slide with no further touch input.
+    const onSettle = vi.fn();
+    const { getByTestId } = render(<Harness itemCount={10} onSettle={onSettle} debounceMs={120} />);
+    const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
+    setLayout(el, 300, 1800); // settles cleanly on index 6
+    fireEvent.scroll(el);
+    act(() => void vi.advanceTimersByTime(120));
+    expect(onSettle).toHaveBeenCalledExactlyOnceWith(6);
+
+    // Well outside the grace window and no further touch/wheel/pointer
+    // activity — this scroll event is drift, not a resettle.
+    act(() => void vi.advanceTimersByTime(1000));
+    setLayout(el, 300, 1620); // would round to index 5
+    fireEvent.scroll(el);
+    act(() => void vi.advanceTimersByTime(120));
+    expect(onSettle).toHaveBeenCalledExactlyOnceWith(6);
+  });
+
+  it('still settles on long-running momentum/snap-correction scroll with no further touch input', () => {
+    // Regression test for a bug in the FIRST version of the drift fix above:
+    // gating on "was there a touch/wheel/pointer event within a fixed
+    // debounceMs * 2 slack of settle-check time" dropped real settles once
+    // native momentum/snap-correction ran longer than that slack — which it
+    // routinely does for a fast flick. That left activeIndex stuck on the
+    // old slide while the container had already scrolled to the new one,
+    // and since the mount window is keyed off activeIndex, the slide the
+    // user was actually looking at could get unmounted — a blank carousel,
+    // worse than the bug being fixed. The chain stays trusted for as long as
+    // scroll events keep arriving without a debounceMs-or-longer gap,
+    // regardless of how long that run lasts or how few touch events back it.
+    const onSettle = vi.fn();
+    const { getByTestId } = render(<Harness itemCount={10} onSettle={onSettle} debounceMs={120} />);
+    const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
+    setLayout(el, 300, 1700);
+    fireEvent.scroll(el); // starts the run — trusted (touchstart just happened)
+    fireEvent.touchEnd(el);
+    // Momentum keeps producing scroll events, each within debounceMs of the
+    // last (so the run never goes quiet), for far longer than any fixed
+    // slack window would tolerate — no further touch input at all.
+    for (const scrollLeft of [1720, 1740, 1760, 1780, 1800]) {
+      act(() => void vi.advanceTimersByTime(80));
+      setLayout(el, 300, scrollLeft);
+      fireEvent.scroll(el);
+    }
+    act(() => void vi.advanceTimersByTime(120));
+    expect(onSettle).toHaveBeenCalledExactlyOnceWith(6);
+  });
+
+  it('settles correctly on two independent real swipes fired back-to-back', () => {
+    // Regression test: two genuine swipes with essentially no gap between
+    // them (an impatient fast double-swipe) must not corrupt or drop either
+    // settle — each is its own trusted run.
+    const onSettle = vi.fn();
+    const { getByTestId } = render(<Harness itemCount={10} onSettle={onSettle} debounceMs={120} />);
+    const el = getByTestId('scroller');
+    fireEvent.touchStart(el);
+    setLayout(el, 300, 300);
+    fireEvent.scroll(el);
+    act(() => void vi.advanceTimersByTime(120));
+    expect(onSettle).toHaveBeenCalledExactlyOnceWith(1);
+
+    fireEvent.touchStart(el);
+    setLayout(el, 300, 600);
+    fireEvent.scroll(el);
+    act(() => void vi.advanceTimersByTime(120));
+    expect(onSettle).toHaveBeenCalledTimes(2);
+    expect(onSettle).toHaveBeenLastCalledWith(2);
+  });
+
   it('scrollToIndex scrolls the container to the target slide', () => {
     let scrollToIndex: ((index: number) => void) | undefined;
     const { getByTestId } = render(

package/src/hooks/__tests__/useSwipeStack.test.tsx

@@ -0,0 +1,155 @@
+// @vitest-environment jsdom
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { cleanup, fireEvent, render } from '@testing-library/react';
+import { useSwipeStack, type SwipeDirection, type UseSwipeStackOptions } from '../useSwipeStack';
+
+// jsdom doesn't implement pointer capture — stub it as a no-op so
+// `e.currentTarget.setPointerCapture(...)` doesn't throw.
+beforeEach(() => {
+  if (!HTMLElement.prototype.setPointerCapture) {
+    HTMLElement.prototype.setPointerCapture = vi.fn();
+  }
+});
+
+afterEach(cleanup);
+
+function Harness(props: UseSwipeStackOptions & { triggerDirection?: SwipeDirection }) {
+  const { triggerDirection, ...options } = props;
+  const { cardRef, wrapRef, handlers, touchAction, triggerCommit } = useSwipeStack(options);
+  return (
+    <div data-testid="wrap" ref={wrapRef}>
+      <div data-testid="card" ref={cardRef} data-touch-action={touchAction} {...handlers}>
+        card
+      </div>
+      {triggerDirection && (
+        <button data-testid="trigger" onClick={() => triggerCommit(triggerDirection)}>
+          trigger
+        </button>
+      )}
+    </div>
+  );
+}
+
+function pointer(x: number, y: number) {
+  return { clientX: x, clientY: y, pointerId: 1 };
+}
+
+function drag(el: HTMLElement, dx: number, dy: number) {
+  fireEvent.pointerDown(el, pointer(0, 0));
+  fireEvent.pointerMove(el, pointer(dx, dy));
+  fireEvent.pointerUp(el, pointer(dx, dy));
+}
+
+describe('useSwipeStack', () => {
+  it('commits when a drag crosses threshold in a live direction', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up', 'down', 'left', 'right']} threshold={100} onCommit={onCommit} />,
+    );
+    drag(getByTestId('card'), 0, -120);
+    expect(onCommit).toHaveBeenCalledWith('up');
+    expect(onCommit).toHaveBeenCalledOnce();
+  });
+
+  it('springs back without committing when under threshold', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up', 'down', 'left', 'right']} threshold={100} onCommit={onCommit} />,
+    );
+    drag(getByTestId('card'), 0, -40);
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('does not commit within the deadzone even if threshold is set very low', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up']} threshold={2} onCommit={onCommit} />,
+    );
+    drag(getByTestId('card'), 0, -5);
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('treats a non-configured direction as a wall — no commit even past what would be threshold distance', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up', 'down']} threshold={100} onCommit={onCommit} />,
+    );
+    drag(getByTestId('card'), 150, 0);
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('does nothing when disabled', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness
+        directions={['up', 'down', 'left', 'right']}
+        threshold={100}
+        onCommit={onCommit}
+        disabled
+      />,
+    );
+    drag(getByTestId('card'), 0, -150);
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('ignores pointerup without a preceding pointerdown', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up', 'down', 'left', 'right']} threshold={100} onCommit={onCommit} />,
+    );
+    fireEvent.pointerUp(getByTestId('card'), pointer(0, -150));
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('triggerCommit commits a live direction without a drag', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up']} onCommit={onCommit} triggerDirection="up" />,
+    );
+    fireEvent.click(getByTestId('trigger'));
+    expect(onCommit).toHaveBeenCalledWith('up');
+    expect(onCommit).toHaveBeenCalledOnce();
+  });
+
+  it('triggerCommit no-ops for a direction that is not live', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up']} onCommit={onCommit} triggerDirection="down" />,
+    );
+    fireEvent.click(getByTestId('trigger'));
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  it('triggerCommit does nothing when disabled', () => {
+    const onCommit = vi.fn();
+    const { getByTestId } = render(
+      <Harness directions={['up']} onCommit={onCommit} triggerDirection="up" disabled />,
+    );
+    fireEvent.click(getByTestId('trigger'));
+    expect(onCommit).not.toHaveBeenCalled();
+  });
+
+  describe('touchAction', () => {
+    it('is none when both axes have a live direction', () => {
+      const { getByTestId } = render(
+        <Harness directions={['left', 'right', 'up', 'down']} onCommit={vi.fn()} />,
+      );
+      expect(getByTestId('card').dataset.touchAction).toBe('none');
+    });
+
+    it('is pan-y when only horizontal directions are live', () => {
+      const { getByTestId } = render(<Harness directions={['left', 'right']} onCommit={vi.fn()} />);
+      expect(getByTestId('card').dataset.touchAction).toBe('pan-y');
+    });
+
+    it('is pan-x when only vertical directions are live', () => {
+      const { getByTestId } = render(<Harness directions={['up', 'down']} onCommit={vi.fn()} />);
+      expect(getByTestId('card').dataset.touchAction).toBe('pan-x');
+    });
+
+    it('is auto when no directions are live', () => {
+      const { getByTestId } = render(<Harness directions={[]} onCommit={vi.fn()} />);
+      expect(getByTestId('card').dataset.touchAction).toBe('auto');
+    });
+  });
+});

package/src/hooks/index.ts

@@ -22,3 +22,12 @@ export type {
   UseCarouselRouteSyncOptions,
   UseCarouselRouteSyncResult,
 } from './useCarouselRouteSync';
+export { useReorderSensors, shouldHandleDndEvent } from './useReorderSensors';
+export type { UseReorderSensorsOptions } from './useReorderSensors';
+export { useSwipeStack, SWIPE_STACK_TRANSITION_MS } from './useSwipeStack';
+export type {
+  SwipeDirection,
+  UseSwipeStackOptions,
+  UseSwipeStackHandlers,
+  UseSwipeStackResult,
+} from './useSwipeStack';

package/src/hooks/usePublishShellChromeHeight.ts

@@ -0,0 +1,96 @@
+'use client';
+
+import { useLayoutEffect } from 'react';
+import type { RefObject } from 'react';
+
+/**
+ * Internal implementation detail of `MobileHeader`/`MobileFooter` — not part
+ * of the package's public surface (not re-exported from `hooks/index.ts`).
+ *
+ * Measures `ref`'s own rendered height and publishes it as an inline
+ * `var(--sv-shell-header-height|--sv-shell-footer-height)` override on
+ * `#sv-app-shell` (the runtime shell's stable root id, `runtime/app/
+ * (platform)/layout.tsx`), removing it on unmount. This is what makes a
+ * *self-rendered* `MobileHeader`/`MobileFooter` — the sanctioned pattern for
+ * a plugin that opts out of the platform's own chrome via
+ * `shellConfig.mobileHeader`/`mobileFooter: false` (RFC 0075/0088) — work
+ * correctly with `Sheet`/`Drawer`/`Dialog`, which all size themselves against
+ * these same two variables so they stop above/below the chrome instead of
+ * sliding underneath it.
+ *
+ * Before this existed, only the *platform's own* header/footer had its
+ * height accounted for (a fixed CSS `calc()` in `shell.module.css`, driven by
+ * `data-mobile-header-hidden`/`data-mobile-footer-hidden`, which collapses
+ * the variable to `0px` whenever a plugin hides that chrome) — a plugin
+ * self-rendering its own via this same component instead had no path to tell
+ * the shell what its real height was, and silently inherited that `0px`.
+ * `Sheet`/`Drawer` then extended full-height, and since the header/footer's
+ * own `z-index` (101) beats an overlay's (100), the chrome visibly covered
+ * the overlay's last ~60px. First found and fixed ad hoc in `sovereign-tasks`
+ * (measuring in the plugin itself, `getBoundingClientRect()` in a
+ * `useLayoutEffect`); moved here so every consumer of these two components —
+ * present and future, in this repo or externally maintained — gets it for
+ * free, without having to know the mechanism exists. See
+ * `docs/architecture-rules.md` for the full rule.
+ *
+ * Deliberately **not** `ResizeObserver`: in live testing (both this repo's
+ * own Chromium-based browser-preview tooling and a real WebKit iOS Simulator
+ * session) a freshly created `ResizeObserver` never fired its callback even
+ * once for an already-rendered, stably-sized, non-zero element — cause not
+ * fully root-caused. A synchronous `getBoundingClientRect()` read in
+ * `useLayoutEffect`, re-run on `window`'s `resize` event, worked immediately
+ * and reliably in both environments instead.
+ *
+ * No-ops safely wherever `#sv-app-shell` doesn't exist (Storybook, a unit
+ * test, or any host other than the platform's own runtime shell) — every CSS
+ * consumer reads these variables with a `60px` fallback, so an absent
+ * override is harmless.
+ *
+ * For `--sv-shell-header-height` specifically, this also mirrors the same
+ * measured height onto `--sv-dialog-inset-top` on `:root` (`document.
+ * documentElement`, not `#sv-app-shell`) — `Dialog`'s mobile `.scrim` is
+ * `position: fixed` and reads that variable for its own `top` offset, and
+ * per `globals.css`'s own comment, iOS Safari has a documented quirk where a
+ * `position: fixed` element inherits custom properties from `:root` rather
+ * than from its DOM ancestors, so a value set only on `#sv-app-shell` (an
+ * ancestor, not `:root`) silently never reaches it there. The platform's own
+ * header already keeps `--sv-dialog-inset-top` correct this way, via
+ * `ClientShell.tsx`'s own `syncViewport()` — but that function is part of
+ * `(platform)/layout.tsx` and never runs for a `shell: minimal` plugin, so a
+ * self-rendered `MobileHeader` (this hook's entire reason to exist) had no
+ * equivalent, and `--sv-dialog-inset-top` silently kept `globals.css`'s
+ * hardcoded platform-header-height fallback (60px) regardless of this
+ * header's real height. Found live in `sovereign-plugin-kanban`: its
+ * self-rendered header measures 69px, so its card-detail `Dialog` opened
+ * with a real, reproducible ~9px misalignment against that header's own
+ * bottom edge — confirmed via `getBoundingClientRect()` on both elements,
+ * not just visually. */
+export function usePublishShellChromeHeight(
+  ref: RefObject<HTMLElement | null>,
+  cssVariable: '--sv-shell-header-height' | '--sv-shell-footer-height',
+) {
+  useLayoutEffect(() => {
+    const el = ref.current;
+    if (!el) return;
+
+    function publish() {
+      const shell = document.getElementById('sv-app-shell');
+      if (!shell || !el) return;
+      const height = `${el.getBoundingClientRect().height}px`;
+      shell.style.setProperty(cssVariable, height);
+      if (cssVariable === '--sv-shell-header-height') {
+        document.documentElement.style.setProperty('--sv-dialog-inset-top', height);
+      }
+    }
+
+    publish();
+    window.addEventListener('resize', publish);
+    return () => {
+      window.removeEventListener('resize', publish);
+      document.getElementById('sv-app-shell')?.style.removeProperty(cssVariable);
+      if (cssVariable === '--sv-shell-header-height') {
+        document.documentElement.style.removeProperty('--sv-dialog-inset-top');
+      }
+    };
+  }, [ref, cssVariable]);
+}

package/src/hooks/useReorderSensors.ts

@@ -0,0 +1,88 @@
+'use client';
+
+import {
+  KeyboardSensor,
+  MouseSensor as LibMouseSensor,
+  TouchSensor as LibTouchSensor,
+  useSensor,
+  useSensors,
+} from '@dnd-kit/core';
+import { sortableKeyboardCoordinates } from '@dnd-kit/sortable';
+import type { MouseEvent as ReactMouseEvent, TouchEvent as ReactTouchEvent } from 'react';
+
+/** Plain pointer drag (desktop, handle-initiated). */
+const DEFAULT_MOUSE_ACTIVATION_DISTANCE_PX = 8;
+
+/** Long-press-to-lift on touch. `delay` is how long a still hold takes before
+ *  the row lifts; `tolerance` is how far the finger may drift during that
+ *  hold before it's treated as a scroll instead — a finger that moves further
+ *  than this within the delay window cancels activation and the native
+ *  vertical scroll wins. */
+const DEFAULT_TOUCH_ACTIVATION_DELAY_MS = 300;
+const DEFAULT_TOUCH_ACTIVATION_TOLERANCE_PX = 8;
+
+/**
+ * True when a drag should be allowed to start from `target`. Refused when
+ * `target` sits inside an element marked `data-no-dnd` — a nested control
+ * (e.g. a visibility toggle) opts out so tapping it fires its own handler
+ * instead of lifting the row. Exported standalone so it's unit-testable
+ * without spinning up dnd-kit.
+ */
+export function shouldHandleDndEvent(target: EventTarget | null): boolean {
+  if (!(target instanceof Element)) return true;
+  return target.closest('[data-no-dnd]') === null;
+}
+
+export interface UseReorderSensorsOptions {
+  mouseActivationDistancePx?: number;
+  touchActivationDelayMs?: number;
+  touchActivationTolerancePx?: number;
+}
+
+// dnd-kit's documented pattern for scoping sensor activation to specific
+// elements: subclass the built-in sensor and replace its static `activators`
+// with a handler that inspects the originating event's target before
+// deferring to the base activation logic (distance/delay/tolerance), which
+// dnd-kit re-checks internally regardless of what this returns.
+class MouseSensor extends LibMouseSensor {
+  static override activators = [
+    {
+      eventName: 'onMouseDown' as const,
+      handler: ({ nativeEvent: event }: ReactMouseEvent) => shouldHandleDndEvent(event.target),
+    },
+  ];
+}
+
+class TouchSensor extends LibTouchSensor {
+  static override activators = [
+    {
+      eventName: 'onTouchStart' as const,
+      handler: ({ nativeEvent: event }: ReactTouchEvent) => shouldHandleDndEvent(event.target),
+    },
+  ];
+}
+
+/**
+ * Sensor set for a `data-no-dnd`-aware drag-reorder list — MouseSensor for
+ * desktop's handle-initiated drag, TouchSensor for mobile's long-press lift
+ * (fixes reordering being unusable on iOS PWA/Safari, which never implements
+ * the native HTML5 Drag-and-Drop API for touch input), KeyboardSensor
+ * unchanged. A bare call keeps the historical 8px/300ms/8px defaults.
+ */
+export function useReorderSensors(options: UseReorderSensorsOptions = {}) {
+  const {
+    mouseActivationDistancePx = DEFAULT_MOUSE_ACTIVATION_DISTANCE_PX,
+    touchActivationDelayMs = DEFAULT_TOUCH_ACTIVATION_DELAY_MS,
+    touchActivationTolerancePx = DEFAULT_TOUCH_ACTIVATION_TOLERANCE_PX,
+  } = options;
+  return useSensors(
+    useSensor(MouseSensor, { activationConstraint: { distance: mouseActivationDistancePx } }),
+    useSensor(TouchSensor, {
+      activationConstraint: {
+        delay: touchActivationDelayMs,
+        tolerance: touchActivationTolerancePx,
+      },
+    }),
+    useSensor(KeyboardSensor, { coordinateGetter: sortableKeyboardCoordinates }),
+  );
+}