@hyperframes/studio 0.8.50 → 0.8.52

package/src/hooks/useProjectSignaturePoll.test.tsx

@@ -1,135 +0,0 @@
-// @vitest-environment happy-dom
-
-import React, { act } from "react";
-import { createRoot, type Root } from "react-dom/client";
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { useProjectSignaturePoll } from "./useProjectSignaturePoll";
-
-Reflect.set(globalThis, "IS_REACT_ACT_ENVIRONMENT", true);
-
-function HookHost({
-  signature,
-  onChange,
-}: {
-  signature: string | undefined;
-  onChange: () => void;
-}) {
-  useProjectSignaturePoll("demo", signature, onChange);
-  return null;
-}
-
-let root: Root | null = null;
-let container: HTMLElement | null = null;
-
-function mount(signature: string | undefined, onChange: () => void): void {
-  act(() => {
-    if (!root) {
-      container = document.createElement("div");
-      document.body.appendChild(container);
-      root = createRoot(container);
-    }
-    root.render(<HookHost signature={signature} onChange={onChange} />);
-  });
-}
-
-function unmount(): void {
-  if (root) {
-    act(() => root?.unmount());
-    root = null;
-  }
-  container?.remove();
-  container = null;
-}
-
-function mockSignatureResponse(signature: string): ReturnType<typeof vi.fn> {
-  const fetchMock = vi.fn(async () => ({ ok: true, json: async () => ({ signature }) }));
-  vi.stubGlobal("fetch", fetchMock);
-  return fetchMock;
-}
-
-describe("useProjectSignaturePoll", () => {
-  beforeEach(() => {
-    vi.useFakeTimers();
-  });
-
-  afterEach(() => {
-    unmount();
-    vi.useRealTimers();
-    vi.unstubAllGlobals();
-    vi.restoreAllMocks();
-  });
-
-  it("fires onChange when the polled signature moves past the loaded one", async () => {
-    const fetchMock = mockSignatureResponse("sig-b");
-    const onChange = vi.fn();
-    mount("sig-a", onChange);
-
-    await vi.advanceTimersByTimeAsync(2000);
-    expect(fetchMock).toHaveBeenCalledWith("/api/projects/demo/signature");
-    expect(onChange).toHaveBeenCalledTimes(1);
-  });
-
-  it("stays quiet while the polled signature matches", async () => {
-    mockSignatureResponse("sig-a");
-    const onChange = vi.fn();
-    mount("sig-a", onChange);
-
-    await vi.advanceTimersByTimeAsync(6000);
-    expect(onChange).not.toHaveBeenCalled();
-  });
-
-  it("does not poll before a baseline signature exists", async () => {
-    const fetchMock = mockSignatureResponse("sig-a");
-    const onChange = vi.fn();
-    mount(undefined, onChange);
-
-    await vi.advanceTimersByTimeAsync(6000);
-    expect(fetchMock).not.toHaveBeenCalled();
-    expect(onChange).not.toHaveBeenCalled();
-  });
-
-  it("re-arms against the caller's refreshed signature without re-mounting", async () => {
-    mockSignatureResponse("sig-b");
-    const onChange = vi.fn();
-    mount("sig-a", onChange);
-
-    await vi.advanceTimersByTimeAsync(2000);
-    expect(onChange).toHaveBeenCalledTimes(1);
-
-    // The caller refetched and now holds the polled signature — no more firing.
-    mount("sig-b", onChange);
-    await vi.advanceTimersByTimeAsync(6000);
-    expect(onChange).toHaveBeenCalledTimes(1);
-  });
-
-  it("skips ticks while the tab is hidden and re-checks on visibility", async () => {
-    const fetchMock = mockSignatureResponse("sig-b");
-    const onChange = vi.fn();
-    let hidden = true;
-    vi.spyOn(document, "hidden", "get").mockImplementation(() => hidden);
-    mount("sig-a", onChange);
-
-    await vi.advanceTimersByTimeAsync(6000);
-    expect(fetchMock).not.toHaveBeenCalled();
-
-    hidden = false;
-    await act(async () => {
-      document.dispatchEvent(new Event("visibilitychange"));
-      await vi.advanceTimersByTimeAsync(0);
-    });
-    expect(onChange).toHaveBeenCalledTimes(1);
-  });
-
-  it("stops polling after unmount", async () => {
-    mockSignatureResponse("sig-b");
-    const onChange = vi.fn();
-    mount("sig-a", onChange);
-
-    await vi.advanceTimersByTimeAsync(2000);
-    expect(onChange).toHaveBeenCalledTimes(1);
-
-    unmount();
-    await vi.advanceTimersByTimeAsync(10_000);
-    expect(onChange).toHaveBeenCalledTimes(1);
-  });
-});

package/src/hooks/useProjectSignaturePoll.ts

@@ -1,68 +0,0 @@
-import { useEffect, useRef } from "react";
-import { buildProjectApiPath } from "../utils/projectRouting";
-
-const POLL_INTERVAL_MS = 2000;
-
-/** One poll: the current signature, or null on any failure (skip this tick). */
-async function fetchProjectSignature(projectId: string): Promise<string | null> {
-  try {
-    const res = await fetch(buildProjectApiPath(projectId, "/signature"));
-    if (!res.ok) return null;
-    const body = (await res.json()) as { signature?: string };
-    return typeof body.signature === "string" ? body.signature : null;
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Poll the project's content signature and fire `onChange` when it no longer
- * matches `currentSignature` — the storyboard board uses this to refresh itself
- * while an agent writes sketch frames to disk.
- *
- * The comparison baseline is the signature the caller's data was loaded with,
- * so a refetch triggered by `onChange` naturally re-arms the poll with the new
- * value. Ticks are skipped while the tab is hidden (a visibility flip re-checks
- * immediately) and while a previous request is still in flight; request
- * failures are ignored — polling degrades to today's manual-reload behavior.
- */
-export function useProjectSignaturePoll(
-  projectId: string | null,
-  currentSignature: string | undefined,
-  onChange: () => void,
-): void {
-  const signatureRef = useRef(currentSignature);
-  const onChangeRef = useRef(onChange);
-  signatureRef.current = currentSignature;
-  onChangeRef.current = onChange;
-
-  useEffect(() => {
-    if (!projectId) return;
-    let disposed = false;
-    let inFlight = false;
-
-    const tick = async () => {
-      if (disposed || inFlight || document.hidden) return;
-      // No baseline yet (initial storyboard fetch still loading, or an older
-      // server without the signature field) — nothing to compare against.
-      if (signatureRef.current === undefined) return;
-      inFlight = true;
-      const latest = await fetchProjectSignature(projectId);
-      inFlight = false;
-      if (disposed || latest === null) return;
-      if (latest !== signatureRef.current) onChangeRef.current();
-    };
-
-    const interval = window.setInterval(() => void tick(), POLL_INTERVAL_MS);
-    const onVisibilityChange = () => {
-      if (!document.hidden) void tick();
-    };
-    document.addEventListener("visibilitychange", onVisibilityChange);
-
-    return () => {
-      disposed = true;
-      window.clearInterval(interval);
-      document.removeEventListener("visibilitychange", onVisibilityChange);
-    };
-  }, [projectId]);
-}

package/src/hooks/useStoryboard.ts

@@ -1,99 +0,0 @@
-import { useCallback, useEffect, useRef, useState } from "react";
-import type {
-  StoryboardFrame,
-  StoryboardGlobals,
-  StoryboardWarning,
-} from "@hyperframes/core/storyboard";
-import { buildProjectApiPath } from "../utils/projectRouting";
-
-/** A frame as returned by the API: parsed frame + disk-resolution info. */
-export interface StoryboardFrameView extends StoryboardFrame {
-  /** Whether `src` resolves to an existing file inside the project. */
-  srcExists: boolean;
-}
-
-/** The companion narration script (SCRIPT.md), when present alongside the storyboard. */
-export interface StoryboardScript {
-  exists: boolean;
-  path: string;
-  content: string;
-}
-
-/** Shape of `GET /api/projects/:id/storyboard`. */
-export interface StoryboardResponse {
-  exists: boolean;
-  path: string;
-  globals: StoryboardGlobals;
-  frames: StoryboardFrameView[];
-  warnings: StoryboardWarning[];
-  script?: StoryboardScript;
-  /** Project content signature this payload was derived from (poster cache-bust + change poll). */
-  signature?: string;
-}
-
-export interface UseStoryboardResult {
-  data: StoryboardResponse | null;
-  loading: boolean;
-  error: string | null;
-  reload: () => void;
-}
-
-/**
- * Load the parsed storyboard manifest for a project. Markdown stays canonical on
- * disk; this fetches the server-derived JSON the storyboard view renders.
- *
- * `reload()` refetches in place: the blocking spinner only shows on first load
- * and project switches, so background refreshes (file-change polling, post-save
- * reloads) swap data without flashing the board.
- */
-export function useStoryboard(projectId: string | null): UseStoryboardResult {
-  const [data, setData] = useState<StoryboardResponse | null>(null);
-  const [loading, setLoading] = useState(true);
-  const [error, setError] = useState<string | null>(null);
-  const [reloadKey, setReloadKey] = useState(0);
-  const hasDataRef = useRef(false);
-  const lastProjectRef = useRef<string | null>(null);
-
-  const reload = useCallback(() => setReloadKey((k) => k + 1), []);
-
-  useEffect(() => {
-    if (!projectId) return;
-    let cancelled = false;
-    if (lastProjectRef.current !== projectId) {
-      lastProjectRef.current = projectId;
-      hasDataRef.current = false;
-      setData(null);
-    }
-    if (!hasDataRef.current) setLoading(true);
-    setError(null);
-
-    // Route through buildProjectApiPath so the (URL-derived) projectId is encoded
-    // into the path rather than interpolated raw (CodeQL js/client-side-request-forgery).
-    fetch(buildProjectApiPath(projectId, "/storyboard"))
-      .then((res) => {
-        if (!res.ok) throw new Error(`storyboard request failed: ${res.status}`);
-        return res.json() as Promise<StoryboardResponse>;
-      })
-      .then((json) => {
-        if (cancelled) return;
-        hasDataRef.current = true;
-        setData(json);
-      })
-      .catch((err: unknown) => {
-        if (cancelled) return;
-        // A failed background refresh keeps the last good board on screen;
-        // the blocking error state is only for loads with nothing to show.
-        if (hasDataRef.current) return;
-        setError(err instanceof Error ? err.message : "failed to load storyboard");
-      })
-      .finally(() => {
-        if (!cancelled) setLoading(false);
-      });
-
-    return () => {
-      cancelled = true;
-    };
-  }, [projectId, reloadKey]);
-
-  return { data, loading, error, reload };
-}