Files
hyperframes/packages/studio/src/hooks/useGsapAwareEditing.ts
T
Miguel ÁngelandMiguel Ángel 7bff49ecf0 refactor(studio): simplify hooks, split contexts, remove dead code (#1416)
* fix(studio): guard Zustand no-op setters and fix useConsoleErrorCapture memory leak

- Guard setIsPlaying to skip set() when value unchanged (eliminates 60
  notifications/sec during reverse playback)
- Guard caption store selectGroup to bail before set() when group missing
  (prevents empty Zustand notifications)
- Guard clearSelection to skip when already empty
- Fix useConsoleErrorCapture: restore original console.error, remove error
  event listener, and delete __hfErrorCapture flag on cleanup

* fix(studio): delete dead files and unused exports

Remove 7 dead files (audioBeatDetection, keyframeSnapping,
timelineInspector, DopesheetStrip, StaggerControls,
TimelineLayerPanel, TimelineEditorNotice) and their test companions.

Delete unused computeFitToChildrenSize export from propertyPanelHelpers.

Fix re-export indirection: useDomEditCommits and studioMotionOps.test
now import patch builders directly from manualEditsDomPatches instead
of the re-export passthrough in manualEditsDom.

* fix(studio): eliminate effect-chain state mirroring for lint findings, hover, and GSAP fetch

Move lint findingsByElement sync from App.tsx into useLintModal where
the value is produced, removing the mirroring useEffect. Consolidate
4 hover-clearing effects in useDomSelection into 2 (one unconditional
on context change, one conditional combining caption mode, selection
match, and disconnected element checks). Fold the GSAP retry effect
into the fetch effect in useGsapTweenCache, scheduling a single retry
via setTimeout when the initial fetch returns 0 animations.

Eliminates 3 unnecessary render cycles from effect chains.

* fix(studio): memoize renderQueue, toolbar, and canvas rect to prevent re-render cascade

- Wrap renderQueue object in useMemo so StudioContext consumers don't
  re-render on every App render
- Memoize timelineToolbar JSX so NLELayout memo isn't defeated
- Move canvasRect getBoundingClientRect() from render-time IIFE to a
  useLayoutEffect-backed ref, eliminating layout thrashing
- Track and clear setTimeout handles in refreshPreviewDocumentVersion
  to prevent stale timer accumulation on rapid calls and unmount

* refactor(studio): consolidate GSAP shared primitives — defaults, iframe access, keyframe parsing

Extract duplicated PROPERTY_DEFAULTS, IframeGsap interface, iframe
accessors (getIframeGsap, queryIframeElement), percentage keyframe
parsing, and toAbsoluteTime into a single gsapShared.ts module.

Removes ~120 lines of copy-pasted logic across 8 hook files, reducing
drift risk between the duplicate implementations.

* fix(studio): remove dead store fields, dead file, duplicate helper, and unsafe assertions

* refactor(studio): deduplicate selector helpers, rounding utils, percentage computation, and iframe access

* fix(studio): split StudioContext into Shell + Playback to prevent cascade re-renders

* refactor(studio): decompose useGsapScriptCommits into focused mutation hooks

* refactor(studio): decompose useFileManager into focused file operation hooks

Extract useFileTree (tree loading, refresh, derived assets/compositions)
and useEditorSave (debounced save with history tracking) from the 508-LOC
useFileManager. The parent hook composes both and retains file I/O,
click-to-source, upload/import, and CRUD — preserving the same public
interface so no consumers change.

* refactor(studio): decompose useDomEditCommits into focused commit hooks

Extract geometry (path offset, box size, rotation) and element lifecycle
(delete, z-index reorder) into useDomGeometryCommits and
useElementLifecycleOps. Parent keeps persistDomEditOperations as core
and composes all sub-hooks — public interface unchanged.

* refactor(studio): simplify useAppHotkeys with declarative command table

* refactor(studio): simplify useAppHotkeys with declarative command table

Replace 15 individual useRef callback refs with a single cbRef object.
Extract keydown dispatch into pure dispatchModifierKey/dispatchPlainKey
functions. Merge duplicate undo/redo logic into shared applyHistory.
Extract cross-origin listener boilerplate into safeAddListener/safeRemoveListener.

Hook body: 204 LOC (down from 445). Public API unchanged.

* fix(studio): remove unused getDomEditTargetKey import

* refactor(studio): decompose useDomEditSession into focused editing hooks

Extract GSAP-aware geometry intercepts (move/resize/rotation) and
animated property commit into useGsapAwareEditing, and selection
wiring, GSAP cache management, preview sync, and selection handlers
into useDomEditWiring. The parent remains a pure composition shell.

* style(studio): fix formatting in 5 files

* fix(studio): trim App.tsx to 598 lines (under 600 limit)

---------

Co-authored-by: Miguel Ángel <miguel07alm@protonmail.com>
2026-06-13 18:25:11 -04:00

243 lines
7.6 KiB
TypeScript

/**
* GSAP-aware move/resize/rotation wrappers that intercept geometry commits
* for animated elements and route them through script mutation instead of
* CSS patching. Also exposes the animated-property commit, arc-path ops,
* and the thin `commitMutation` facade.
*
* Extracted from useDomEditSession to isolate the GSAP intercept routing
* from the rest of the editing orchestration.
*/
import { useCallback } from "react";
import type { GsapAnimation } from "@hyperframes/core/gsap-parser";
import type { DomEditSelection } from "../components/editor/domEditingTypes";
import { STUDIO_GSAP_DRAG_INTERCEPT_ENABLED } from "../components/editor/manualEditingAvailability";
import { GSAP_CSS_FALLBACK_BLOCKED_MESSAGE } from "./useDomGeometryCommits";
import {
tryGsapDragIntercept,
tryGsapResizeIntercept,
tryGsapRotationIntercept,
} from "./gsapRuntimeBridge";
import { useAnimatedPropertyCommit } from "./useAnimatedPropertyCommit";
import type { CommitMutation } from "./gsapScriptCommitTypes";
export interface UseGsapAwareEditingParams {
domEditSelection: DomEditSelection | null;
selectedGsapAnimations: GsapAnimation[];
gsapCommitMutation: CommitMutation | null;
previewIframeRef: React.RefObject<HTMLIFrameElement | null>;
showToast: (message: string, tone?: "error" | "info") => void;
bumpGsapCache: () => void;
makeFetchFallback: (selection: DomEditSelection) => () => Promise<GsapAnimation[]>;
trackGsapInteractionFailure: (
error: unknown,
selection: DomEditSelection,
mutationType: string,
label: string,
) => void;
// DOM fallbacks (from useDomEditCommits)
handleDomPathOffsetCommit: (
selection: DomEditSelection,
next: { x: number; y: number },
) => Promise<void>;
handleDomBoxSizeCommit: (
selection: DomEditSelection,
next: { width: number; height: number },
) => Promise<void>;
handleDomRotationCommit: (selection: DomEditSelection, next: { angle: number }) => Promise<void>;
// GSAP script commit ops (from useGsapScriptCommits)
addGsapAnimation: (
sel: DomEditSelection,
method: "to" | "from" | "set" | "fromTo",
time?: number,
) => Promise<void>;
convertToKeyframes: (sel: DomEditSelection, animId: string) => void;
setArcPath: (
sel: DomEditSelection,
animId: string,
config: {
enabled: boolean;
autoRotate?: boolean | number;
segments?: Array<{
curviness: number;
cp1?: { x: number; y: number };
cp2?: { x: number; y: number };
}>;
},
) => void;
updateArcSegment: (
sel: DomEditSelection,
animId: string,
segmentIndex: number,
update: {
curviness?: number;
cp1?: { x: number; y: number };
cp2?: { x: number; y: number };
},
) => void;
}
export function useGsapAwareEditing({
domEditSelection,
selectedGsapAnimations,
gsapCommitMutation,
previewIframeRef,
showToast,
bumpGsapCache,
makeFetchFallback,
trackGsapInteractionFailure,
handleDomPathOffsetCommit,
handleDomBoxSizeCommit,
handleDomRotationCommit,
addGsapAnimation,
convertToKeyframes,
setArcPath,
updateArcSegment,
}: UseGsapAwareEditingParams) {
// ── GSAP-aware geometry commits ──
const handleGsapAwarePathOffsetCommit = useCallback(
async (selection: DomEditSelection, next: { x: number; y: number }) => {
const hasGsapAnims = selectedGsapAnimations.length > 0;
if (hasGsapAnims && !STUDIO_GSAP_DRAG_INTERCEPT_ENABLED) {
showToast(GSAP_CSS_FALLBACK_BLOCKED_MESSAGE, "error");
throw new Error(GSAP_CSS_FALLBACK_BLOCKED_MESSAGE);
}
if (STUDIO_GSAP_DRAG_INTERCEPT_ENABLED && gsapCommitMutation) {
try {
const handled = await tryGsapDragIntercept(
selection,
next,
selectedGsapAnimations,
previewIframeRef.current,
gsapCommitMutation,
makeFetchFallback(selection),
);
if (handled) return;
} catch (error) {
trackGsapInteractionFailure(error, selection, "drag", "Move animated layer");
throw error;
}
}
return handleDomPathOffsetCommit(selection, next);
},
[
handleDomPathOffsetCommit,
selectedGsapAnimations,
gsapCommitMutation,
previewIframeRef,
makeFetchFallback,
trackGsapInteractionFailure,
showToast,
],
);
const handleGsapAwareBoxSizeCommit = useCallback(
async (selection: DomEditSelection, next: { width: number; height: number }) => {
if (STUDIO_GSAP_DRAG_INTERCEPT_ENABLED && gsapCommitMutation) {
try {
const handled = await tryGsapResizeIntercept(
selection,
next,
selectedGsapAnimations,
previewIframeRef.current,
gsapCommitMutation,
makeFetchFallback(selection),
);
if (handled) return;
} catch (error) {
trackGsapInteractionFailure(error, selection, "resize", "Resize animated layer");
throw error;
}
}
return handleDomBoxSizeCommit(selection, next);
},
[
handleDomBoxSizeCommit,
selectedGsapAnimations,
gsapCommitMutation,
previewIframeRef,
makeFetchFallback,
trackGsapInteractionFailure,
],
);
const handleGsapAwareRotationCommit = useCallback(
async (selection: DomEditSelection, next: { angle: number }) => {
if (STUDIO_GSAP_DRAG_INTERCEPT_ENABLED && gsapCommitMutation) {
try {
const handled = await tryGsapRotationIntercept(
selection,
next.angle,
selectedGsapAnimations,
previewIframeRef.current,
gsapCommitMutation,
makeFetchFallback(selection),
);
if (handled) return;
} catch (error) {
trackGsapInteractionFailure(error, selection, "rotation", "Rotate animated layer");
throw error;
}
}
return handleDomRotationCommit(selection, next);
},
[
handleDomRotationCommit,
selectedGsapAnimations,
gsapCommitMutation,
previewIframeRef,
makeFetchFallback,
trackGsapInteractionFailure,
],
);
// ── Animated property commit ──
const commitAnimatedProperty = useAnimatedPropertyCommit({
selectedGsapAnimations,
gsapCommitMutation,
addGsapAnimation: (sel, method, time) => addGsapAnimation(sel, method, time),
convertToKeyframes: (sel, animId) => convertToKeyframes(sel, animId),
previewIframeRef,
bumpGsapCache,
});
// ── Arc path wrappers ──
const handleSetArcPath = useCallback(
(animId: string, config: Parameters<typeof setArcPath>[2]) => {
if (!domEditSelection) return;
setArcPath(domEditSelection, animId, config);
},
[domEditSelection, setArcPath],
);
const handleUpdateArcSegment = useCallback(
(animId: string, segmentIndex: number, update: Parameters<typeof updateArcSegment>[3]) => {
if (!domEditSelection) return;
updateArcSegment(domEditSelection, animId, segmentIndex, update);
},
[domEditSelection, updateArcSegment],
);
// ── Thin commitMutation facade ──
const commitMutation = useCallback(
async (mutation: Record<string, unknown>, options: { label: string; softReload?: boolean }) => {
if (!domEditSelection) return;
await gsapCommitMutation?.(domEditSelection, mutation, options);
},
[domEditSelection, gsapCommitMutation],
);
return {
handleGsapAwarePathOffsetCommit,
handleGsapAwareBoxSizeCommit,
handleGsapAwareRotationCommit,
commitAnimatedProperty,
handleSetArcPath,
handleUpdateArcSegment,
commitMutation,
};
}