@hyperframes/studio 0.8.50 → 0.8.53-desktop.0

package/src/components/dock/Dock.test.tsx

@@ -0,0 +1,274 @@
+// @vitest-environment happy-dom
+
+import React, { act, type ComponentProps } from "react";
+import type { DockviewApi } from "dockview-react";
+import { createRoot, type Root } from "react-dom/client";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import * as dockLayout from "./dockLayout";
+import { Dock } from "./Dock";
+import { parseDockLayout } from "./dockLayoutSchema";
+import { useDockLayoutStore } from "./dockLayoutStore";
+import { PANEL_IDS } from "./panelRegistry";
+import { readStudioUiPreferences } from "../../utils/studioUiPreferences";
+
+(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+let dockApi: DockviewApi | null = null;
+vi.mock("dockview-react", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("dockview-react")>();
+  return {
+    ...actual,
+    DockviewReact: (props: ComponentProps<typeof actual.DockviewReact>) =>
+      React.createElement(actual.DockviewReact, {
+        ...props,
+        onReady: (event) => {
+          dockApi = event.api;
+          props.onReady(event);
+        },
+      }),
+  };
+});
+
+const liveObservers = new Set<{ callback: () => void; target?: Element }>();
+class ResizeObserverStub {
+  private readonly entry: { callback: () => void; target?: Element };
+  constructor(callback: () => void) {
+    this.entry = { callback };
+  }
+  observe(target: Element) {
+    this.entry.target = target;
+    liveObservers.add(this.entry);
+  }
+  unobserve() {}
+  disconnect() {
+    liveObservers.delete(this.entry);
+  }
+}
+(globalThis as unknown as { ResizeObserver: unknown }).ResizeObserver = ResizeObserverStub;
+
+vi.mock("./dockLayout", async (importOriginal) => {
+  const actual = await importOriginal<typeof import("./dockLayout")>();
+  return { ...actual, applySideMinimums: vi.fn(actual.applySideMinimums) };
+});
+const applySideMinimums = vi.mocked(dockLayout.applySideMinimums);
+
+let root: Root | null = null;
+
+function mount(
+  projectId: string | null,
+  titles: Partial<Record<(typeof PANEL_IDS)[number], string>> = {},
+) {
+  const host = document.createElement("div");
+  document.body.append(host);
+  root = createRoot(host);
+  act(() => {
+    root?.render(
+      <Dock.Root projectId={projectId}>
+        {PANEL_IDS.map((id) => (
+          <Dock.Panel key={id} id={id} title={titles[id]}>
+            <div data-testid={`content-${id}`}>{id}</div>
+          </Dock.Panel>
+        ))}
+      </Dock.Root>,
+    );
+  });
+  return host;
+}
+
+/** The persisted views of the group holding `id`, after the debounced write lands. */
+function persistedGroupOf(id: string): string | undefined {
+  act(() => {
+    vi.advanceTimersByTime(1000);
+  });
+  const grid = JSON.stringify(readStudioUiPreferences(undefined, "p1").dockLayout?.grid);
+  const groups = [...grid.matchAll(/"views":\[([^\]]*)\]/g)].map((m) => m[1]);
+  return groups.find((views) => views.includes(`"${id}"`));
+}
+
+beforeEach(() => {
+  localStorage.clear();
+  vi.useFakeTimers();
+});
+
+afterEach(() => {
+  act(() => root?.unmount());
+  root = null;
+  document.body.innerHTML = "";
+  vi.useRealTimers();
+});
+
+// The default Edit layout tabs [compositions|assets|code|catalog] into one
+// group and [design|layers|renders|variables] into another; dockview shows
+// only the active tab's content per group. `slideshow` is never part of the
+// default build — StudioRightPanels opens it itself when the file is one.
+const DEFAULT_OPEN = PANEL_IDS.filter((id) => id !== "slideshow");
+const DEFAULT_VISIBLE = ["preview", "timeline", "compositions", "design"];
+
+describe("Dock on React 19", () => {
+  it("mounts the default layout's ten panels, showing only each group's active tab", () => {
+    const host = mount("p1");
+    for (const id of DEFAULT_VISIBLE) {
+      expect(host.querySelector(`[data-testid="content-${id}"]`)).not.toBeNull();
+    }
+    for (const id of DEFAULT_OPEN.filter((id) => !DEFAULT_VISIBLE.includes(id))) {
+      expect(host.querySelector(`[data-testid="content-${id}"]`)).toBeNull();
+    }
+    expect(host.querySelector('[data-testid="content-slideshow"]')).toBeNull();
+    expect(useDockLayoutStore.getState().openPanels).toEqual(new Set(DEFAULT_OPEN));
+  });
+
+  it("persists a layout change per project and reads it back through the schema", () => {
+    mount("p1");
+    act(() => useDockLayoutStore.getState().closePanel("renders"));
+    act(() => {
+      vi.advanceTimersByTime(400);
+    });
+    const stored = readStudioUiPreferences(undefined, "p1").dockLayout;
+    const expected = DEFAULT_OPEN.filter((id) => id !== "renders");
+    expect(Object.keys(stored?.panels ?? {}).sort()).toEqual([...expected].sort());
+    expect(readStudioUiPreferences(undefined, "p2").dockLayout).toBeUndefined();
+  });
+
+  it("closes a panel and reopens it from the store, becoming its group's visible tab", async () => {
+    const host = mount("p1");
+    act(() => useDockLayoutStore.getState().closePanel("renders"));
+    expect(useDockLayoutStore.getState().openPanels.has("renders")).toBe(false);
+    expect(host.querySelector('[data-testid="content-renders"]')).toBeNull();
+    // dockview's own panel-active event dispatch resolves on a microtask, one
+    // tick after the synchronous store call returns; `act(async ...)` is what
+    // actually waits for it instead of asserting against pre-flush DOM.
+    await act(async () => {
+      useDockLayoutStore.getState().togglePanel("renders");
+      await Promise.resolve();
+    });
+    expect(useDockLayoutStore.getState().openPanels.has("renders")).toBe(true);
+    expect(host.querySelector('[data-testid="content-renders"]')).not.toBeNull();
+  });
+
+  it("keeps a panel's custom title when it is closed and reopened", async () => {
+    const host = mount("p1", { renders: "Renders (2)" });
+    expect(host.textContent).toContain("Renders (2)");
+    act(() => useDockLayoutStore.getState().closePanel("renders"));
+    await act(async () => {
+      useDockLayoutStore.getState().togglePanel("renders");
+      await Promise.resolve();
+    });
+    expect(host.textContent).toContain("Renders (2)");
+  });
+
+  it("reopens a closed panel as a tab of its zone's group, not a new group", () => {
+    mount("p1");
+    act(() => useDockLayoutStore.getState().closePanel("compositions"));
+    act(() => useDockLayoutStore.getState().togglePanel("compositions"));
+    expect(persistedGroupOf("compositions")).toContain('"assets"');
+  });
+
+  it("reopens a side panel next to the preview when its whole column was closed", () => {
+    mount("p1");
+    const { closePanel, togglePanel } = useDockLayoutStore.getState();
+    for (const id of ["compositions", "assets", "code", "catalog"] as const)
+      act(() => closePanel(id));
+    act(() => togglePanel("compositions"));
+    expect(useDockLayoutStore.getState().openPanels.has("compositions")).toBe(true);
+    expect(useDockLayoutStore.getState().visiblePanels.has("compositions")).toBe(true);
+  });
+
+  it("reopens the timeline as its own group, never as a tab of the preview", () => {
+    mount("p1");
+    act(() => useDockLayoutStore.getState().closePanel("timeline"));
+    act(() => useDockLayoutStore.getState().togglePanel("timeline"));
+    expect(persistedGroupOf("timeline")).not.toContain('"preview"');
+  });
+
+  it("restores the stored layout on the next mount instead of rebuilding the default", () => {
+    mount("p1");
+    act(() => useDockLayoutStore.getState().closePanel("renders"));
+    act(() => {
+      vi.advanceTimersByTime(1000);
+    });
+    act(() => root?.unmount());
+    root = null;
+    document.body.innerHTML = "";
+
+    mount("p1");
+    expect(useDockLayoutStore.getState().openPanels.has("renders")).toBe(false);
+  });
+
+  it("falls back to the default layout when the stored one names an unknown panel", () => {
+    localStorage.setItem(
+      "hf-studio-ui-preferences:p1",
+      JSON.stringify({ dockLayout: { grid: {}, panels: { nope: {} } } }),
+    );
+    const host = mount("p1");
+    expect(host.querySelector('[data-testid="content-preview"]')).not.toBeNull();
+  });
+});
+
+describe("Dock wiring", () => {
+  it("re-applies the side minimums when a panel is dragged to another group", () => {
+    mount(null);
+    applySideMinimums.mockClear();
+    const preview = dockApi?.getPanel("preview");
+    const design = dockApi?.getPanel("design");
+    if (!preview || !design) throw new Error("default layout is missing panels");
+    act(() => design.api.moveTo({ group: preview.group }));
+    expect(applySideMinimums).toHaveBeenCalled();
+  });
+
+  it("makes the sashes keyboard-focusable separators", () => {
+    const host = mount(null);
+    const sashes = host.querySelectorAll<HTMLElement>('.dv-sash[role="separator"]');
+    expect(sashes.length).toBeGreaterThan(0);
+    for (const sash of sashes) expect(sash.tabIndex).toBe(0);
+  });
+
+  it("re-fits the side columns to the window width when it resizes", () => {
+    mount(null);
+    const innerWidth = window.innerWidth;
+    Object.defineProperty(window, "innerWidth", { value: 560, configurable: true });
+    try {
+      applySideMinimums.mockClear();
+      const dockObservers = [...liveObservers].filter(({ target }) =>
+        target?.classList.contains("hf-dock"),
+      );
+      act(() => dockObservers.forEach(({ callback }) => callback()));
+      expect(applySideMinimums).toHaveBeenCalledWith(expect.anything(), 560);
+    } finally {
+      Object.defineProperty(window, "innerWidth", { value: innerWidth, configurable: true });
+    }
+  });
+});
+
+describe("parseDockLayout", () => {
+  it("rejects shapes that are not a dock layout", () => {
+    expect(parseDockLayout(null)).toBeNull();
+    expect(parseDockLayout({ grid: {}, panels: {} })).toBeNull();
+    expect(
+      parseDockLayout({
+        grid: {
+          width: 1,
+          height: 1,
+          orientation: "HORIZONTAL",
+          root: { type: "leaf", data: { views: ["ghost"] } },
+        },
+        panels: { ghost: { id: "ghost", contentComponent: "panel" } },
+      }),
+    ).toBeNull();
+  });
+
+  const placed = (views: string[], panelIds: string[]) => ({
+    grid: {
+      width: 1,
+      height: 1,
+      orientation: "HORIZONTAL",
+      root: { type: "leaf", data: { views } },
+    },
+    panels: Object.fromEntries(panelIds.map((id) => [id, { id, contentComponent: "panel" }])),
+  });
+
+  it("rejects a view that has no panel entry and a panel that no view places", () => {
+    expect(parseDockLayout(placed(["preview", "design"], ["preview"]))).toBeNull();
+    expect(parseDockLayout(placed(["preview"], ["preview", "design"]))).toBeNull();
+    expect(parseDockLayout(placed(["preview", "design"], ["preview", "design"]))).not.toBeNull();
+  });
+});

package/src/components/dock/Dock.tsx

@@ -0,0 +1,291 @@
+import {
+  createContext,
+  useCallback,
+  useContext,
+  useEffect,
+  useRef,
+  useState,
+  type ReactNode,
+} from "react";
+import { createPortal } from "react-dom";
+import {
+  DockviewReact,
+  type DockviewApi,
+  type DockviewReadyEvent,
+  type IDockviewPanelProps,
+} from "dockview-react";
+import { readStudioUiPreferences, writeStudioUiPreferences } from "../../utils/studioUiPreferences";
+import { installDockAccessibility } from "./dockAccessibility";
+import { addRegisteredPanel, applySideMinimums, buildEditLayout } from "./dockLayout";
+import { DOCK_PANEL_COMPONENT } from "./dockLayoutSchema";
+import { useDockLayoutStore, type DockController, type DockSnapshot } from "./dockLayoutStore";
+import {
+  PANEL_DEFINITIONS,
+  PANEL_IDS,
+  isPanelId,
+  panelsInZone,
+  type PanelDefinition,
+  type PanelId,
+} from "./panelRegistry";
+import "./dock.css";
+
+const PERSIST_DEBOUNCE_MS = 250;
+
+type Slots = Partial<Record<PanelId, HTMLElement>>;
+
+interface SlotsContextValue {
+  slots: Slots;
+  registerSlot: (id: PanelId, element: HTMLElement | null) => void;
+}
+
+const SlotsContext = createContext<SlotsContextValue | null>(null);
+
+function useSlots(): SlotsContextValue {
+  const value = useContext(SlotsContext);
+  if (!value) throw new Error("Dock.Panel must be rendered inside Dock.Root");
+  return value;
+}
+
+/** The element dockview mounts for a panel; Dock.Panel portals the real content into it. */
+function PanelSlot({ api }: IDockviewPanelProps) {
+  const { registerSlot } = useSlots();
+  const id = api.id;
+  const ref = useCallback(
+    (element: HTMLDivElement | null) => {
+      if (isPanelId(id)) registerSlot(id, element);
+    },
+    [id, registerSlot],
+  );
+  return <div ref={ref} className="h-full w-full min-h-0 min-w-0 overflow-hidden" />;
+}
+
+const COMPONENTS = { [DOCK_PANEL_COMPONENT]: PanelSlot };
+
+function snapshot(api: DockviewApi): DockSnapshot {
+  const openPanels = new Set<PanelId>();
+  const visiblePanels = new Set<PanelId>();
+  for (const panel of api.panels) {
+    if (!isPanelId(panel.id)) continue;
+    openPanels.add(panel.id);
+    if (panel.api.isVisible && panel.group.api.isVisible) visiblePanels.add(panel.id);
+  }
+  const groupActivePanels = api.groups.flatMap((group) => {
+    const id = group.activePanel?.id;
+    return isPanelId(id) ? [id] : [];
+  });
+  const active = api.activePanel?.id;
+  return {
+    openPanels,
+    visiblePanels,
+    activePanel: isPanelId(active) ? active : null,
+    groupActivePanels,
+  };
+}
+
+function createController(api: DockviewApi): DockController {
+  const open = (id: PanelId) => {
+    if (api.getPanel(id)) return;
+    const { zone, reopen } = PANEL_DEFINITIONS[id];
+    // Side columns are tab groups; preview and timeline are separate groups in the centre.
+    const sibling =
+      zone === "center"
+        ? undefined
+        : panelsInZone(zone).find((other) => other !== id && api.getPanel(other));
+    if (sibling) {
+      addRegisteredPanel(api, id, { referencePanel: sibling, direction: "within" });
+      return;
+    }
+    const hasAnchor = api.getPanel(reopen.near) !== undefined;
+    const position = { referencePanel: reopen.near, direction: reopen.direction };
+    addRegisteredPanel(api, id, hasAnchor ? position : undefined);
+  };
+  return {
+    open,
+    activate: (id) => {
+      open(id);
+      api.getPanel(id)?.api.setActive();
+    },
+    close: (id) => {
+      const panel = api.getPanel(id);
+      if (panel) api.removePanel(panel);
+    },
+    setTitle: (id, title) => api.getPanel(id)?.api.setTitle(title),
+    setGroupVisible: (id, visible) => api.getPanel(id)?.group.api.setVisible(visible),
+    reset: () => buildEditLayout(api, window.innerWidth),
+  };
+}
+
+function restoreOrBuild(api: DockviewApi, projectId: string | null) {
+  const stored = readStudioUiPreferences(undefined, projectId).dockLayout;
+  if (stored) {
+    try {
+      api.fromJSON(stored);
+      return;
+    } catch {
+      /* a layout the schema accepted but dockview cannot load: start over */
+    }
+  }
+  buildEditLayout(api, window.innerWidth);
+}
+
+function Root({ projectId, children }: { projectId: string | null; children: ReactNode }) {
+  const [slots, setSlots] = useState<Slots>({});
+  const registerSlot = useCallback((id: PanelId, element: HTMLElement | null) => {
+    setSlots((prev) => {
+      if (prev[id] === (element ?? undefined)) return prev;
+      const next = { ...prev };
+      if (element) next[id] = element;
+      else delete next[id];
+      return next;
+    });
+  }, []);
+
+  const disposeRef = useRef<() => void>(() => {});
+  useEffect(() => () => disposeRef.current(), []);
+
+  const onReady = useCallback(
+    ({ api }: DockviewReadyEvent) => {
+      disposeRef.current();
+      restoreOrBuild(api, projectId);
+      applySideMinimums(api);
+      const root = api.groups[0]?.element.closest<HTMLElement>(".hf-dock");
+      const disposeAccessibility = root ? installDockAccessibility(api, root) : () => {};
+      // The dock spans the window (buildEditLayout sizes against it too); its own box lags a resize.
+      const resizeObserver = new ResizeObserver(() => applySideMinimums(api, window.innerWidth));
+      if (root) resizeObserver.observe(root);
+      const store = useDockLayoutStore.getState();
+      store.attach(createController(api));
+      store.sync(snapshot(api));
+      const pending = store.takePendingActivation();
+      if (pending) api.getPanel(pending)?.api.setActive();
+
+      let timer: ReturnType<typeof setTimeout> | undefined;
+      const persist = () => {
+        clearTimeout(timer);
+        timer = setTimeout(() => {
+          writeStudioUiPreferences({ dockLayout: api.toJSON() }, undefined, projectId);
+        }, PERSIST_DEBOUNCE_MS);
+      };
+      // dockview does not fire onDidLayoutChange for add/remove/activate,
+      // so every event class is wired to the same sync+persist pair.
+      const onDockChange = () => {
+        useDockLayoutStore.getState().sync(snapshot(api));
+        persist();
+      };
+      const subscriptions = [
+        api.onDidAddPanel(() => {
+          applySideMinimums(api);
+          onDockChange();
+        }),
+        api.onDidMovePanel(() => {
+          applySideMinimums(api);
+          onDockChange();
+        }),
+        api.onDidRemovePanel(onDockChange),
+        api.onDidActivePanelChange(onDockChange),
+        api.onDidLayoutChange(onDockChange),
+      ];
+      disposeRef.current = () => {
+        clearTimeout(timer);
+        for (const subscription of subscriptions) subscription.dispose();
+        disposeAccessibility();
+        resizeObserver.disconnect();
+        useDockLayoutStore.getState().detach();
+      };
+    },
+    [projectId],
+  );
+
+  return (
+    <SlotsContext.Provider value={{ slots, registerSlot }}>
+      <DockviewReact
+        key={projectId ?? ""}
+        className="hf-dock flex-1 min-h-0"
+        components={COMPONENTS}
+        defaultRenderer="always"
+        disableFloatingGroups
+        onReady={onReady}
+      />
+      {children}
+    </SlotsContext.Provider>
+  );
+}
+
+function Panel({ id, title, children }: { id: PanelId; title?: string; children: ReactNode }) {
+  const element = useSlots().slots[id];
+  const visible = useDockLayoutStore((state) => state.visiblePanels.has(id));
+  const controller = useDockLayoutStore((state) => state.controller);
+  const open = useDockLayoutStore((state) => state.openPanels.has(id));
+  const label = title ?? PANEL_DEFINITIONS[id].title;
+  useEffect(() => {
+    if (open) controller?.setTitle(id, label);
+  }, [controller, id, label, open]);
+  const definition: PanelDefinition = PANEL_DEFINITIONS[id];
+  const shown = visible || definition.keepMounted;
+  return element && shown ? createPortal(children, element) : null;
+}
+
+function WindowMenu() {
+  const openPanels = useDockLayoutStore((state) => state.openPanels);
+  const togglePanel = useDockLayoutStore((state) => state.togglePanel);
+  const resetLayout = useDockLayoutStore((state) => state.resetLayout);
+  const [open, setOpen] = useState(false);
+  const rootRef = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    if (!open) return;
+    const close = (event: PointerEvent) => {
+      if (!rootRef.current?.contains(event.target as Node)) setOpen(false);
+    };
+    document.addEventListener("pointerdown", close);
+    return () => document.removeEventListener("pointerdown", close);
+  }, [open]);
+
+  return (
+    <div ref={rootRef} className="relative">
+      <button
+        type="button"
+        aria-haspopup="menu"
+        aria-expanded={open}
+        onClick={() => setOpen((value) => !value)}
+        className="h-7 px-2.5 rounded-md text-[11px] font-medium text-neutral-400 hover:text-neutral-200 hover:bg-neutral-800 transition-colors"
+      >
+        Window
+      </button>
+      {open && (
+        <div
+          role="menu"
+          className="absolute right-0 top-8 z-50 w-44 rounded-md border border-neutral-800 bg-neutral-900 py-1 shadow-lg"
+        >
+          {PANEL_IDS.map((id) => (
+            <button
+              key={id}
+              type="button"
+              role="menuitemcheckbox"
+              aria-checked={openPanels.has(id)}
+              onClick={() => togglePanel(id)}
+              className="flex w-full items-center gap-2 px-3 py-1.5 text-left text-[11px] text-neutral-300 hover:bg-neutral-800"
+            >
+              <span className="w-3 text-panel-accent">{openPanels.has(id) ? "✓" : ""}</span>
+              {PANEL_DEFINITIONS[id].title}
+            </button>
+          ))}
+          <div className="my-1 border-t border-neutral-800" />
+          <button
+            type="button"
+            role="menuitem"
+            onClick={() => {
+              resetLayout();
+              setOpen(false);
+            }}
+            className="w-full px-3 py-1.5 text-left text-[11px] text-neutral-300 hover:bg-neutral-800"
+          >
+            Reset layout
+          </button>
+        </div>
+      )}
+    </div>
+  );
+}
+
+export const Dock = { Root, Panel, WindowMenu };

package/src/components/dock/dock.css

@@ -0,0 +1,28 @@
+@import "dockview-react/dist/styles/dockview.css";
+
+.hf-dock {
+  --dv-group-view-background-color: var(--color-panel-bg);
+  --dv-tabs-and-actions-container-background-color: var(--color-panel-surface);
+  --dv-activegroup-visiblepanel-tab-background-color: var(--color-panel-bg);
+  --dv-activegroup-hiddenpanel-tab-background-color: var(--color-panel-surface);
+  --dv-inactivegroup-visiblepanel-tab-background-color: var(--color-panel-bg);
+  --dv-inactivegroup-hiddenpanel-tab-background-color: var(--color-panel-surface);
+  --dv-activegroup-visiblepanel-tab-color: var(--color-panel-text-1);
+  --dv-activegroup-hiddenpanel-tab-color: var(--color-panel-text-3);
+  --dv-inactivegroup-visiblepanel-tab-color: var(--color-panel-text-2);
+  --dv-inactivegroup-hiddenpanel-tab-color: var(--color-panel-text-4);
+  --dv-tab-divider-color: var(--color-panel-border);
+  --dv-separator-border: var(--color-panel-border);
+  --dv-paneview-header-border-color: var(--color-panel-border);
+  --dv-sash-color: var(--color-panel-hover);
+  --dv-active-sash-color: var(--color-panel-accent);
+  --dv-drag-over-background-color: color-mix(in srgb, var(--color-panel-accent) 12%, transparent);
+  --dv-drag-over-border-color: var(--color-panel-accent);
+  --dv-tab-font-size: 11px;
+  --dv-tabs-and-actions-container-font-size: 11px;
+}
+
+.hf-dock .dv-sash:focus-visible {
+  background-color: var(--dv-active-sash-color);
+  outline: none;
+}