@hyperframes/studio 0.6.0-alpha.1 → 0.6.0-alpha.11

package/src/components/sidebar/LeftSidebar.tsx

@@ -1,10 +1,20 @@
-import { memo, useState, useCallback, type ReactNode } from "react";
-import { useMountEffect } from "../../hooks/useMountEffect";
+import {
+  memo,
+  useState,
+  useCallback,
+  useImperativeHandle,
+  forwardRef,
+  type ReactNode,
+} from "react";
 import { CompositionsTab } from "./CompositionsTab";
 import { AssetsTab } from "./AssetsTab";
 import { FileTree } from "../editor/FileTree";
 
-type SidebarTab = "compositions" | "assets" | "code";
+export type SidebarTab = "compositions" | "assets" | "code";
+
+export interface LeftSidebarHandle {
+  selectTab: (tab: SidebarTab) => void;
+}
 
 const STORAGE_KEY = "hf-studio-sidebar-tab";
 
@@ -39,201 +49,191 @@ interface LeftSidebarProps {
   takeoverContent?: ReactNode;
 }
 
-export const LeftSidebar = memo(function LeftSidebar({
-  width = 240,
-  projectId,
-  compositions,
-  assets,
-  activeComposition,
-  onSelectComposition,
-  onImportFiles,
-  fileTree: fileProp,
-  editingFile,
-  onSelectFile,
-  onCreateFile,
-  onCreateFolder,
-  onDeleteFile,
-  onRenameFile,
-  onDuplicateFile,
-  onMoveFile,
-  codeChildren,
-  onLint,
-  linting,
-  onToggleCollapse,
-  takeoverContent,
-}: LeftSidebarProps) {
-  const [tab, setTab] = useState<SidebarTab>(getPersistedTab);
+export const LeftSidebar = memo(
+  forwardRef<LeftSidebarHandle, LeftSidebarProps>(function LeftSidebar(
+    {
+      width = 240,
+      projectId,
+      compositions,
+      assets,
+      activeComposition,
+      onSelectComposition,
+      onImportFiles,
+      fileTree: fileProp,
+      editingFile,
+      onSelectFile,
+      onCreateFile,
+      onCreateFolder,
+      onDeleteFile,
+      onRenameFile,
+      onDuplicateFile,
+      onMoveFile,
+      codeChildren,
+      onLint,
+      linting,
+      onToggleCollapse,
+      takeoverContent,
+    },
+    ref,
+  ) {
+    const [tab, setTab] = useState<SidebarTab>(getPersistedTab);
 
-  const selectTab = useCallback((t: SidebarTab) => {
-    setTab(t);
-    localStorage.setItem(STORAGE_KEY, t);
-  }, []);
+    const selectTab = useCallback((t: SidebarTab) => {
+      setTab(t);
+      localStorage.setItem(STORAGE_KEY, t);
+    }, []);
 
-  // Keyboard shortcuts: Cmd+1 for Compositions, Cmd+2 for Assets
-  useMountEffect(() => {
-    const handler = (e: KeyboardEvent) => {
-      if (!e.metaKey && !e.ctrlKey) return;
-      if (e.key === "1") {
-        e.preventDefault();
-        selectTab("compositions");
-      }
-      if (e.key === "2") {
-        e.preventDefault();
-        selectTab("assets");
-      }
-    };
-    window.addEventListener("keydown", handler);
-    return () => window.removeEventListener("keydown", handler);
-  });
+    useImperativeHandle(ref, () => ({ selectTab }), [selectTab]);
 
-  return (
-    <div
-      className="flex flex-col h-full bg-neutral-950 border-r border-neutral-800/50"
-      style={{ width }}
-    >
-      {takeoverContent ? (
-        <div className="flex min-h-0 flex-1">{takeoverContent}</div>
-      ) : (
-        <>
-          {/* Tabs — Code first */}
-          <div className="border-b border-neutral-800/50 px-3 py-3 flex-shrink-0">
-            <div className="flex items-center gap-2">
-              <div
-                className="grid min-w-0 flex-1 gap-1 rounded-[18px] bg-neutral-900 p-1 shadow-[inset_0_1px_0_rgba(255,255,255,0.03)]"
-                style={{ gridTemplateColumns: "0.9fr 1.25fr 0.9fr" }}
-              >
-                <button
-                  type="button"
-                  onClick={() => selectTab("code")}
-                  className={`rounded-[14px] px-2.5 py-2 text-[10px] font-semibold transition-all ${
-                    tab === "code"
-                      ? "bg-neutral-800 text-white"
-                      : "text-neutral-500 hover:text-neutral-200"
-                  }`}
-                >
-                  Code
-                </button>
-                <button
-                  type="button"
-                  onClick={() => selectTab("compositions")}
-                  className={`rounded-[14px] px-2.5 py-2 text-[10px] font-semibold transition-all ${
-                    tab === "compositions"
-                      ? "bg-neutral-800 text-white"
-                      : "text-neutral-500 hover:text-neutral-200"
-                  }`}
-                >
-                  Compositions
-                </button>
-                <button
-                  type="button"
-                  onClick={() => selectTab("assets")}
-                  className={`rounded-[14px] px-2.5 py-2 text-[10px] font-semibold transition-all ${
-                    tab === "assets"
-                      ? "bg-neutral-800 text-white"
-                      : "text-neutral-500 hover:text-neutral-200"
-                  }`}
+    return (
+      <div
+        className="flex flex-col h-full bg-neutral-950 border-r border-neutral-800/50"
+        style={{ width }}
+      >
+        {takeoverContent ? (
+          <div className="flex min-h-0 flex-1">{takeoverContent}</div>
+        ) : (
+          <>
+            {/* Tabs — Code first */}
+            <div className="border-b border-neutral-800/50 px-3 py-3 flex-shrink-0">
+              <div className="flex items-center gap-2">
+                <div
+                  className="grid min-w-0 flex-1 gap-0.5 rounded-[18px] bg-neutral-900 p-1 shadow-[inset_0_1px_0_rgba(255,255,255,0.03)]"
+                  style={{ gridTemplateColumns: "1fr 1fr 1fr" }}
                 >
-                  Assets
-                </button>
+                  <button
+                    type="button"
+                    onClick={() => selectTab("code")}
+                    className={`rounded-[14px] px-1.5 py-2 text-[10px] font-semibold truncate transition-all ${
+                      tab === "code"
+                        ? "bg-neutral-800 text-white"
+                        : "text-neutral-500 hover:text-neutral-200"
+                    }`}
+                  >
+                    Code
+                  </button>
+                  <button
+                    type="button"
+                    onClick={() => selectTab("compositions")}
+                    className={`rounded-[14px] px-1.5 py-2 text-[10px] font-semibold truncate transition-all ${
+                      tab === "compositions"
+                        ? "bg-neutral-800 text-white"
+                        : "text-neutral-500 hover:text-neutral-200"
+                    }`}
+                  >
+                    Comps
+                  </button>
+                  <button
+                    type="button"
+                    onClick={() => selectTab("assets")}
+                    className={`rounded-[14px] px-1.5 py-2 text-[10px] font-semibold truncate transition-all ${
+                      tab === "assets"
+                        ? "bg-neutral-800 text-white"
+                        : "text-neutral-500 hover:text-neutral-200"
+                    }`}
+                  >
+                    Assets
+                  </button>
+                </div>
+                {onToggleCollapse && (
+                  <button
+                    type="button"
+                    onClick={onToggleCollapse}
+                    className="flex h-8 w-8 flex-shrink-0 items-center justify-center rounded-md border border-transparent text-neutral-500 transition-colors hover:border-neutral-800 hover:bg-neutral-900 hover:text-neutral-300"
+                    title="Hide sidebar"
+                    aria-label="Hide sidebar"
+                  >
+                    <svg
+                      width="14"
+                      height="14"
+                      viewBox="0 0 24 24"
+                      fill="none"
+                      stroke="currentColor"
+                      strokeWidth="1.5"
+                      strokeLinecap="round"
+                      strokeLinejoin="round"
+                      aria-hidden="true"
+                    >
+                      <path d="m14 7-5 5 5 5" />
+                      <path d="M19 4v16" />
+                    </svg>
+                  </button>
+                )}
               </div>
-              {onToggleCollapse && (
+            </div>
+
+            {/* Tab content */}
+            {tab === "compositions" && (
+              <CompositionsTab
+                projectId={projectId}
+                compositions={compositions}
+                activeComposition={activeComposition}
+                onSelect={onSelectComposition}
+              />
+            )}
+            {tab === "assets" && (
+              <AssetsTab
+                projectId={projectId}
+                assets={assets}
+                onImport={onImportFiles}
+                onDelete={onDeleteFile}
+                onRename={onRenameFile}
+              />
+            )}
+            {tab === "code" && (
+              <div className="flex flex-1 min-h-0">
+                {(fileProp?.length ?? 0) > 0 && (
+                  <div className="w-[160px] flex-shrink-0 border-r border-neutral-800 overflow-y-auto">
+                    <FileTree
+                      files={fileProp ?? []}
+                      activeFile={editingFile?.path ?? null}
+                      onSelectFile={onSelectFile ?? (() => {})}
+                      onCreateFile={onCreateFile}
+                      onCreateFolder={onCreateFolder}
+                      onDeleteFile={onDeleteFile}
+                      onRenameFile={onRenameFile}
+                      onDuplicateFile={onDuplicateFile}
+                      onMoveFile={onMoveFile}
+                      onImportFiles={onImportFiles}
+                    />
+                  </div>
+                )}
+                <div className="flex-1 overflow-hidden min-w-0">
+                  {codeChildren ?? (
+                    <div className="flex items-center justify-center h-full text-neutral-600 text-sm">
+                      Select a file to edit
+                    </div>
+                  )}
+                </div>
+              </div>
+            )}
+
+            {/* Lint button pinned at the bottom */}
+            {onLint && (
+              <div className="border-t border-neutral-800 p-2 flex-shrink-0">
                 <button
-                  type="button"
-                  onClick={onToggleCollapse}
-                  className="flex h-8 w-8 flex-shrink-0 items-center justify-center rounded-md border border-transparent text-neutral-500 transition-colors hover:border-neutral-800 hover:bg-neutral-900 hover:text-neutral-300"
-                  title="Hide sidebar"
-                  aria-label="Hide sidebar"
+                  onClick={onLint}
+                  disabled={linting}
+                  className="w-full flex items-center justify-center gap-1.5 px-2 py-1.5 rounded-md text-[11px] font-medium text-neutral-500 hover:text-amber-300 hover:bg-neutral-800 transition-colors disabled:opacity-40"
                 >
                   <svg
-                    width="14"
-                    height="14"
+                    width="12"
+                    height="12"
                     viewBox="0 0 24 24"
                     fill="none"
                     stroke="currentColor"
-                    strokeWidth="1.5"
-                    strokeLinecap="round"
-                    strokeLinejoin="round"
-                    aria-hidden="true"
+                    strokeWidth="2"
                   >
-                    <path d="m14 7-5 5 5 5" />
-                    <path d="M19 4v16" />
+                    <path d="M9 11l3 3L22 4" />
+                    <path d="M21 12v7a2 2 0 01-2 2H5a2 2 0 01-2-2V5a2 2 0 012-2h11" />
                   </svg>
+                  {linting ? "Linting…" : "Lint"}
                 </button>
-              )}
-            </div>
-          </div>
-
-          {/* Tab content */}
-          {tab === "compositions" && (
-            <CompositionsTab
-              projectId={projectId}
-              compositions={compositions}
-              activeComposition={activeComposition}
-              onSelect={onSelectComposition}
-            />
-          )}
-          {tab === "assets" && (
-            <AssetsTab
-              projectId={projectId}
-              assets={assets}
-              onImport={onImportFiles}
-              onDelete={onDeleteFile}
-              onRename={onRenameFile}
-            />
-          )}
-          {tab === "code" && (
-            <div className="flex flex-1 min-h-0">
-              {(fileProp?.length ?? 0) > 0 && (
-                <div className="w-[160px] flex-shrink-0 border-r border-neutral-800 overflow-y-auto">
-                  <FileTree
-                    files={fileProp ?? []}
-                    activeFile={editingFile?.path ?? null}
-                    onSelectFile={onSelectFile ?? (() => {})}
-                    onCreateFile={onCreateFile}
-                    onCreateFolder={onCreateFolder}
-                    onDeleteFile={onDeleteFile}
-                    onRenameFile={onRenameFile}
-                    onDuplicateFile={onDuplicateFile}
-                    onMoveFile={onMoveFile}
-                    onImportFiles={onImportFiles}
-                  />
-                </div>
-              )}
-              <div className="flex-1 overflow-hidden min-w-0">
-                {codeChildren ?? (
-                  <div className="flex items-center justify-center h-full text-neutral-600 text-sm">
-                    Select a file to edit
-                  </div>
-                )}
               </div>
-            </div>
-          )}
-
-          {/* Lint button pinned at the bottom */}
-          {onLint && (
-            <div className="border-t border-neutral-800 p-2 flex-shrink-0">
-              <button
-                onClick={onLint}
-                disabled={linting}
-                className="w-full flex items-center justify-center gap-1.5 px-2 py-1.5 rounded-md text-[11px] font-medium text-neutral-500 hover:text-amber-300 hover:bg-neutral-800 transition-colors disabled:opacity-40"
-              >
-                <svg
-                  width="12"
-                  height="12"
-                  viewBox="0 0 24 24"
-                  fill="none"
-                  stroke="currentColor"
-                  strokeWidth="2"
-                >
-                  <path d="M9 11l3 3L22 4" />
-                  <path d="M21 12v7a2 2 0 01-2 2H5a2 2 0 01-2-2V5a2 2 0 012-2h11" />
-                </svg>
-                {linting ? "Linting…" : "Lint"}
-              </button>
-            </div>
-          )}
-        </>
-      )}
-    </div>
-  );
-});
+            )}
+          </>
+        )}
+      </div>
+    );
+  }),
+);

package/src/player/components/Player.test.ts

@@ -0,0 +1,58 @@
+// @vitest-environment happy-dom
+
+import { describe, expect, it } from "vitest";
+import { hasUnloadedAssets, shouldShowCompositionLoadingOverlay } from "./Player";
+
+describe("composition loading overlay", () => {
+  it("shows while the composition is loading", () => {
+    expect(shouldShowCompositionLoadingOverlay(true)).toBe(true);
+  });
+
+  it("hides after the composition is ready", () => {
+    expect(shouldShowCompositionLoadingOverlay(false)).toBe(false);
+  });
+
+  it("keeps the asset overlay up while media is still buffering", () => {
+    const iframe = document.createElement("iframe");
+    document.body.appendChild(iframe);
+    const audio = iframe.contentDocument?.createElement("audio");
+    expect(audio).toBeDefined();
+    Object.defineProperty(audio, "readyState", {
+      value: 0,
+      configurable: true,
+    });
+    Object.defineProperty(audio, "networkState", {
+      value: 2,
+      configurable: true,
+    });
+    iframe.contentDocument?.body.appendChild(audio!);
+
+    expect(hasUnloadedAssets(iframe, false)).toBe(true);
+
+    iframe.remove();
+  });
+
+  it("does not keep the asset overlay stuck on failed media sources", () => {
+    const iframe = document.createElement("iframe");
+    document.body.appendChild(iframe);
+    const audio = iframe.contentDocument?.createElement("audio");
+    expect(audio).toBeDefined();
+    Object.defineProperty(audio, "error", {
+      value: { code: 4, message: "format error" },
+      configurable: true,
+    });
+    Object.defineProperty(audio, "readyState", {
+      value: 0,
+      configurable: true,
+    });
+    Object.defineProperty(audio, "networkState", {
+      value: 3,
+      configurable: true,
+    });
+    iframe.contentDocument?.body.appendChild(audio!);
+
+    expect(hasUnloadedAssets(iframe, false)).toBe(false);
+
+    iframe.remove();
+  });
+});

package/src/player/components/Player.tsx

@@ -10,14 +10,19 @@ interface PlayerProps {
   projectId?: string;
   directUrl?: string;
   onLoad: () => void;
+  onCompositionLoadingChange?: (loading: boolean) => void;
   portrait?: boolean;
   style?: React.CSSProperties;
+  suppressLoadingOverlay?: boolean;
 }
 
 interface HyperframesPlayerElement extends HTMLElement {
   iframeElement: HTMLIFrameElement;
 }
 
+const MEDIA_HAVE_FUTURE_DATA = 3;
+const MEDIA_NETWORK_NO_SOURCE = 3;
+
 function isRecord(value: unknown): value is Record<string, unknown> {
   return typeof value === "object" && value !== null;
 }
@@ -31,6 +36,10 @@ function getShaderTransitionLoading(event: Event): boolean | null {
   return state.loading === true && state.ready !== true;
 }
 
+export function shouldShowCompositionLoadingOverlay(compositionLoading: boolean): boolean {
+  return compositionLoading;
+}
+
 function enableInteractiveIframe(player: HyperframesPlayerElement): void {
   const root = player.shadowRoot;
   if (!root) return;
@@ -42,6 +51,11 @@ function enableInteractiveIframe(player: HyperframesPlayerElement): void {
   iframe?.style.setProperty("pointer-events", "auto");
 }
 
+function isPreviewMediaElement(el: Element): el is HTMLMediaElement {
+  const tagName = el.tagName.toLowerCase();
+  return tagName === "video" || tagName === "audio";
+}
+
 // Assets are considered ready when every `<video>`/`<audio>` has enough data
 // to play through without buffering, and every registered Lottie animation has
 // finished loading.
@@ -50,14 +64,19 @@ function enableInteractiveIframe(player: HyperframesPlayerElement): void {
 // races so a brief access failure (e.g. an iframe that just swapped src)
 // doesn't flicker the overlay state — we keep showing whatever was most
 // recently true.
-function hasUnloadedAssets(iframe: HTMLIFrameElement, lastResult: boolean): boolean {
+export function hasUnloadedAssets(iframe: HTMLIFrameElement, lastResult: boolean): boolean {
   try {
     const win = iframe.contentWindow as unknown as (Window & { __hfLottie?: unknown[] }) | null;
     const doc = iframe.contentDocument;
     if (!win || !doc) return lastResult;
 
     for (const el of doc.querySelectorAll("video, audio")) {
-      if (el instanceof HTMLMediaElement && el.readyState < HTMLMediaElement.HAVE_FUTURE_DATA) {
+      if (
+        isPreviewMediaElement(el) &&
+        !el.error &&
+        el.networkState !== MEDIA_NETWORK_NO_SOURCE &&
+        el.readyState < MEDIA_HAVE_FUTURE_DATA
+      ) {
         return true;
       }
     }
@@ -84,7 +103,18 @@ function hasUnloadedAssets(iframe: HTMLIFrameElement, lastResult: boolean): bool
  * timeline probing, and DOM inspection.
  */
 export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
-  ({ projectId, directUrl, onLoad, portrait, style }, ref) => {
+  (
+    {
+      projectId,
+      directUrl,
+      onLoad,
+      onCompositionLoadingChange,
+      portrait,
+      style,
+      suppressLoadingOverlay,
+    },
+    ref,
+  ) => {
     const containerRef = useRef<HTMLDivElement>(null);
     const loadCountRef = useRef(0);
     const assetPollRef = useRef<ReturnType<typeof setInterval> | null>(null);
@@ -93,6 +123,7 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
     const [assetOverlayVisible, setAssetOverlayVisible] = useState(false);
     const [assetOverlayFading, setAssetOverlayFading] = useState(false);
     const [shaderTransitionLoading, setShaderTransitionLoading] = useState(false);
+    const [compositionLoading, setCompositionLoading] = useState(true);
 
     useMountEffect(() => {
       const container = containerRef.current;
@@ -138,10 +169,20 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
         };
         player.addEventListener("shadertransitionstate", handleShaderTransitionState);
 
+        const handleReady = () => {
+          setCompositionLoading(false);
+        };
+        const handleError = () => {
+          setCompositionLoading(false);
+        };
+        player.addEventListener("ready", handleReady);
+        player.addEventListener("error", handleError);
+
         // Forward the iframe's native load event to the studio's onIframeLoad.
         const handleLoad = () => {
           loadCountRef.current++;
           setShaderTransitionLoading(false);
+          setCompositionLoading(true);
           // Reveal animation on reload (hot-reload, composition switch)
           if (loadCountRef.current > 1) {
             container.classList.remove("preview-revealing");
@@ -192,6 +233,8 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
           iframe.removeEventListener("load", handleLoad);
           player.removeEventListener("click", preventToggle, { capture: true });
           player.removeEventListener("shadertransitionstate", handleShaderTransitionState);
+          player.removeEventListener("ready", handleReady);
+          player.removeEventListener("error", handleError);
           if (assetPollRef.current) clearInterval(assetPollRef.current);
           assetPollRef.current = null;
           container.removeChild(player);
@@ -237,7 +280,14 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
       };
     }, [assetsLoading]);
 
-    const showAssetOverlay = assetOverlayVisible && !shaderTransitionLoading;
+    const showCompositionOverlay =
+      !suppressLoadingOverlay && shouldShowCompositionLoadingOverlay(compositionLoading);
+    const showAssetOverlay =
+      assetOverlayVisible && !shaderTransitionLoading && !showCompositionOverlay;
+
+    useEffect(() => {
+      onCompositionLoadingChange?.(showCompositionOverlay || showAssetOverlay);
+    }, [onCompositionLoadingChange, showCompositionOverlay, showAssetOverlay]);
 
     return (
       <div
@@ -245,6 +295,23 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
         style={style}
       >
         <div ref={containerRef} className="w-full h-full" />
+        {showCompositionOverlay && (
+          <div
+            className="absolute inset-0 bg-black flex items-center justify-center z-30 select-none"
+            data-hyperframes-ignore=""
+            data-testid="composition-loading-overlay"
+            draggable={false}
+            onDragStart={(event) => event.preventDefault()}
+            onMouseDown={(event) => event.preventDefault()}
+            onPointerDown={(event) => event.preventDefault()}
+          >
+            <HyperframesLoader
+              title="Loading composition"
+              detail="Preparing the Studio preview."
+              size={56}
+            />
+          </div>
+        )}
         {showAssetOverlay && (
           <div
             className="absolute inset-0 bg-black flex items-center justify-center z-20 select-none"