Files
heygen-com__hyperframes/packages/studio/src/hooks/useAnimatedPropertyCommit.ts
Miguel Á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

158 lines
5.6 KiB
TypeScript

/**
* Unified helper for committing any GSAP property value from the design panel.
*
* Handles three cases:
* 1. Animation with keyframes → add-keyframe at current percentage
* 2. Flat animation (no keyframes) → convert to keyframes, then add-keyframe
* 3. No animation → create tl.to(), convert to keyframes, then add-keyframe
*/
import { useCallback } from "react";
import type { GsapAnimation } from "@hyperframes/core/gsap-parser";
import { classifyPropertyGroup } from "@hyperframes/core/gsap-parser";
import type { DomEditSelection } from "../components/editor/domEditingTypes";
import { usePlayerStore } from "../player/store/playerStore";
import { readAllAnimatedProperties, readGsapProperty } from "./gsapRuntimeBridge";
import { selectorFromSelection, computeElementPercentage } from "./gsapShared";
interface CommitAnimatedPropertyDeps {
selectedGsapAnimations: GsapAnimation[];
gsapCommitMutation:
| ((
selection: DomEditSelection,
mutation: Record<string, unknown>,
options: {
label: string;
coalesceKey?: string;
softReload?: boolean;
skipReload?: boolean;
},
) => Promise<void>)
| null;
addGsapAnimation: (
selection: DomEditSelection,
method: "to" | "from" | "set" | "fromTo",
currentTime?: number,
) => void;
convertToKeyframes: (selection: DomEditSelection, animId: string) => void;
previewIframeRef: React.RefObject<HTMLIFrameElement | null>;
bumpGsapCache: () => void;
}
function pickBestAnimation(
animations: GsapAnimation[],
selector: string | null,
property?: string,
): GsapAnimation | undefined {
if (animations.length <= 1) return animations[0];
const currentTime = usePlayerStore.getState().currentTime;
const targetGroup = property ? classifyPropertyGroup(property) : undefined;
const scored = animations.map((a) => {
let score = 0;
if (targetGroup && a.propertyGroup === targetGroup) score += 20;
if (a.keyframes) score += 10;
if (selector && a.targetSelector === selector) score += 5;
else if (a.targetSelector.includes(",")) score -= 3;
const pos = a.resolvedStart ?? (typeof a.position === "number" ? a.position : 0);
const dur = a.duration ?? 0;
if (currentTime >= pos - 0.05 && currentTime <= pos + dur + 0.05) score += 8;
return { anim: a, score };
});
scored.sort((a, b) => b.score - a.score);
return scored[0]?.anim;
}
export function useAnimatedPropertyCommit(deps: CommitAnimatedPropertyDeps) {
const {
selectedGsapAnimations,
gsapCommitMutation,
addGsapAnimation,
previewIframeRef,
bumpGsapCache,
} = deps;
const commitAnimatedProperty = useCallback(
async (
selection: DomEditSelection,
property: string,
value: number | string,
): Promise<void> => {
if (!gsapCommitMutation) return;
const iframe = previewIframeRef.current;
const selector = selectorFromSelection(selection);
let anim: GsapAnimation | undefined = pickBestAnimation(
selectedGsapAnimations,
selector,
property,
);
// Case 3: No animation — create one first
if (!anim) {
addGsapAnimation(selection, "to");
// The addGsapAnimation triggers a reload. We need to wait for the cache
// to update. Use a small delay then bump cache to re-fetch.
await new Promise((r) => setTimeout(r, 500));
bumpGsapCache();
// After creation, we can't proceed in this call — the animation isn't
// in our local state yet. The user's next edit will find it.
// For immediate feedback, trigger a convert-to-keyframes on the new animation.
return;
}
// Case 2: Flat animation — convert to keyframes first
if (!anim.keyframes) {
await gsapCommitMutation(
selection,
{ type: "convert-to-keyframes", animationId: anim.id },
{ label: "Convert to keyframes", skipReload: true },
);
}
const pct = computeElementPercentage(usePlayerStore.getState().currentTime, selection, anim);
// Read all currently animated properties from runtime for backfill
const runtimeProps = selector ? readAllAnimatedProperties(iframe, selector, anim) : {};
// Build the properties object: all runtime props + the new value
const properties: Record<string, number | string> = { ...runtimeProps };
properties[property] = value;
// Compute backfill defaults for properties not in existing keyframes
const backfillDefaults: Record<string, number | string> = { ...runtimeProps };
if (!(property in runtimeProps) && selector) {
const cssVal = readGsapProperty(iframe, selector, property);
if (cssVal != null) backfillDefaults[property] = cssVal;
}
backfillDefaults[property] = typeof value === "number" ? value : value;
const existingKf = anim.keyframes?.keyframes.some(
(kf) => Math.abs(kf.percentage - pct) < 0.05,
);
await gsapCommitMutation(
selection,
existingKf
? {
type: "update-keyframe",
animationId: anim.id,
percentage: pct,
properties,
}
: {
type: "add-keyframe",
animationId: anim.id,
percentage: pct,
properties,
backfillDefaults,
},
{ label: `Edit ${property} (keyframe ${pct}%)`, softReload: true },
);
},
[selectedGsapAnimations, gsapCommitMutation, addGsapAnimation, previewIframeRef, bumpGsapCache],
);
return commitAnimatedProperty;
}