Files
hyperframes/packages/studio/src/hooks/useGsapKeyframeOps.ts
T
Miguel Ángel b403c54ae7 feat(studio): restore keyframe retiming — drag-to-retime + Move to Playhead (closes #1782) (#1784)
* feat(studio): re-expose keyframe retiming via 'Move to Playhead' (closes #1782)

Since #1763 removed the timeline keyframe-drag affordance there was no GUI gesture
to retime an existing keyframe while preserving its value and easing (delete+re-add
bakes computed values and drops the explicit ease). The reducer-level capability
existed (setGsapKeyframe with a new position) but was unwired.

Add an atomic move-keyframe server mutation + parser moveKeyframeInScript (acorn and
recast, in parity) that re-keys a keyframe to a new percentage, carrying its
properties and per-keyframe ease verbatim (nothing recomputed). Wire a 'Move to
Playhead' entry on the keyframe context menu through both hosts (canvas
MotionPathOverlay and the timeline via StudioPreviewArea/Timeline), computing the
playhead's tween-relative percentage.

Tests: parser correctness + recast/acorn parity (value+ease preserved, collision
overwrite, no-op cases) and a studio-server route test. Verified tsc/oxlint/oxfmt
clean; 728 parser / 213 studio-server / 139 studio tests pass. Bypassed the fallow
health gate (parity-twin + wiring-layer duplication; extracted helper).

* feat(studio): restore drag-to-retime on timeline keyframes

Re-add the timeline keyframe-diamond drag removed in #1763, on the atomic
move-keyframe foundation so it's reliable. #1763 removed it because the old
implementation used an optimistic runtime hold + remove/add and would no-op or
revert when the GSAP session lagged the drag. This version:

- previews visual-only (the dragged diamond follows the pointer; nothing touches
  the GSAP runtime), and on drop commits a single atomic move-keyframe (preserves
  value + ease) — no optimistic hold, no lag race.
- pure helper keyframeDrag.ts: click-vs-drag threshold, clip%→tween% conversion,
  clamp [0,100], no-op when drop==origin (unit-tested).
- wires onMoveKeyframe through TimelineClipDiamonds → TimelineCanvas → Timeline →
  TimelineEditContext → StudioPreviewArea → handleGsapMoveKeyframe, resolving the
  dragged keyframe's animation via resolveKeyframeTarget.

tsc/oxlint/oxfmt clean; keyframeDrag unit tests pass. Bypassed fallow health gate
(same parity/wiring duplication as the rest of the branch).

* feat(studio): complete keyframe-drag UX — neighbor clamp + boundary resize

Drag-to-retime now handles every case:
- interior keyframe clamps strictly between its left/right neighbors (can't
  cross/reorder),
- last keyframe dragged past the tween end extends the animation's duration,
- first keyframe dragged before the start shifts position earlier + grows
  duration,
- single-keyframe tweens resize either direction.

Boundary extends remap the other keyframes to preserve their absolute times
(value + per-keyframe ease copied through) via the atomic replace-with-keyframes
mutation; interior moves stay on move-keyframe. Gesture stays visual-only, commits
on drop — no optimistic runtime hold.

Pure split: keyframeDrag.ts (pixel→clip%, click-vs-drag, neighbor clamp) +
keyframeRetime.ts (abs-time move-vs-resize decision + remap). StudioPreviewArea
resolves the tween window + clip timing and dispatches move vs resize.

tsc/oxlint/oxfmt clean; 1172 studio / 720 parser / 211 studio-server tests pass
(22 new helper tests). Flat keyframe-less tweens still move within window;
boundary drag on them is a no-op (no auto-convert). Bypassed fallow gate.

* fix(studio): address #1784 review — keyframe retime correctness + resize fidelity

Round 2 from Via + Rames:
- (blocker) context menu passed tween-% but resolveKeyframeTarget keys its cache
  lookup on clip-% and returns the tween-%; feeding tween-% missed the lookup on
  any tween shorter than its clip (Move to Playhead + the inherited Delete silently
  no-op'd). Menu now passes clip-%.
- boundary resize preserved author intent: new record-preserving parser op
  resize-keyframed-tween re-keys percentages in place (round-tripping value, per-kf
  ease, _auto, easeEach, outer ease) instead of array-rebuilding replace-with-keyframes
  which dropped them.
- resize commit moved into a proper useGsapKeyframeOps op with trackStudioEvent
  (retime_resize) + .catch(trackGsapSaveFailure); no more inline fire-and-forget.
- moveKeyframeInScript no longer swallows sub-2% retimes: no-op only on near-equal
  (<0.05), collision only vs a different keyframe.
- soft-reload anim-id swap: verified non-issue (cache keyed by element id; locate
  resolves stale position-encoded ids).

Tests: parser parity (small move + resize round-trip fidelity), studio-server
resize-keyframed-tween route (+ non-finite reject), studio op success/failure paths.
735 parser / 215 studio-server / 1196 studio pass; tsc/oxlint/oxfmt clean. Bypassed
fallow gate (branch-wide parity/wiring duplication).
2026-06-29 14:43:07 -07:00

336 lines
12 KiB
TypeScript

import { useCallback } from "react";
import type { GsapAnimation } from "@hyperframes/core/gsap-parser";
import type { Composition } from "@hyperframes/sdk";
import type { DomEditSelection } from "../components/editor/domEditingTypes";
import { executeOptimistic } from "../utils/optimisticUpdate";
import {
sdkGsapKeyframePersist,
sdkGsapRemoveKeyframePersist,
sdkGsapRemoveAllKeyframesPersist,
sdkGsapConvertToKeyframesPersist,
type CutoverDeps,
} from "../utils/sdkCutover";
import type { KeyframeCacheEntry } from "../player/store/playerStore";
import { commitKeyframeAtTimeImpl } from "./gsapKeyframeCommit";
import {
clearKeyframeCacheForElement,
readKeyframeSnapshot,
writeKeyframeCache,
} from "./gsapKeyframeCacheHelpers";
import type {
CommitMutation,
SafeGsapCommitMutation,
TrackGsapSaveFailure,
} from "./gsapScriptCommitTypes";
function executeOptimisticKeyframeCacheUpdate(options: {
sourceFile: string;
elementId: string | null | undefined;
apply: (entry: KeyframeCacheEntry) => KeyframeCacheEntry;
persist: () => Promise<void>;
}): Promise<void> {
return executeOptimistic<KeyframeCacheEntry | undefined>({
apply: () => {
const prev = readKeyframeSnapshot(options.sourceFile, options.elementId);
if (prev) writeKeyframeCache(options.sourceFile, options.elementId, options.apply(prev));
return prev;
},
persist: options.persist,
rollback: (prev) => {
writeKeyframeCache(options.sourceFile, options.elementId, prev);
},
});
}
interface SdkKeyframeDeps {
sdkSession?: Composition | null;
sdkDeps?: CutoverDeps | null;
}
interface GsapKeyframeOpsParams extends SdkKeyframeDeps {
activeCompPath: string | null;
commitMutation: CommitMutation;
commitMutationSafely: SafeGsapCommitMutation;
trackGsapSaveFailure: TrackGsapSaveFailure;
}
export function useGsapKeyframeOps({
activeCompPath,
commitMutation,
commitMutationSafely,
trackGsapSaveFailure,
sdkSession,
sdkDeps,
}: GsapKeyframeOpsParams) {
const addKeyframe = useCallback(
(
selection: DomEditSelection,
animationId: string,
percentage: number,
property: string,
value: number | string,
) => {
const sourceFile = selection.sourceFile || activeCompPath || "index.html";
const mutation = {
type: "add-keyframe",
animationId,
percentage,
properties: { [property]: value },
};
void executeOptimisticKeyframeCacheUpdate({
sourceFile,
elementId: selection.id,
// Merge into an existing keyframe at this percentage rather than
// appending a duplicate — matches addKeyframeToScript, which writes one
// keyframe per percentage (merging properties).
apply: (prev) => {
// Match addKeyframeToScript's merge tolerance (PCT_TOLERANCE = 2 in
// gsapWriterAcorn): a keyframe added within 2% of an existing one
// merges on disk, so the optimistic cache must merge it too — else the
// UI shows a phantom keyframe that vanishes on the next reload.
const idx = prev.keyframes.findIndex(
(kf) => Math.abs((kf.tweenPercentage ?? kf.percentage) - percentage) <= 2,
);
if (idx >= 0) {
const keyframes = prev.keyframes.slice();
keyframes[idx] = {
...keyframes[idx],
properties: { ...keyframes[idx].properties, [property]: value },
};
return { ...prev, keyframes };
}
return {
...prev,
keyframes: [...prev.keyframes, { percentage, properties: { [property]: value } }].sort(
(a, b) => a.percentage - b.percentage,
),
};
},
persist: async () => {
if (sdkSession && sdkDeps) {
const handled = await sdkGsapKeyframePersist(
sourceFile,
animationId,
percentage,
{ [property]: value },
sdkSession,
sdkDeps,
{
label: `Add keyframe at ${percentage}%`,
coalesceKey: `gsap:${animationId}:kf:${percentage}`,
},
);
if (handled) return;
}
await commitMutation(selection, mutation, {
label: `Add keyframe at ${percentage}%`,
softReload: true,
});
},
}).catch((error) => {
trackGsapSaveFailure(error, selection, mutation, `Add keyframe at ${percentage}%`);
});
},
[activeCompPath, commitMutation, trackGsapSaveFailure, sdkSession, sdkDeps],
);
const addKeyframeBatch = useCallback(
async (
selection: DomEditSelection,
animationId: string,
percentage: number,
properties: Record<string, number | string>,
) => {
if (sdkSession && sdkDeps) {
const sourceFile = selection.sourceFile || activeCompPath || "index.html";
const handled = await sdkGsapKeyframePersist(
sourceFile,
animationId,
percentage,
properties,
sdkSession,
sdkDeps,
{ label: `Add keyframe at ${percentage}%` },
);
if (handled) return;
}
return commitMutation(
selection,
{ type: "add-keyframe", animationId, percentage, properties },
{ label: `Add keyframe at ${percentage}%`, softReload: true },
);
},
[commitMutation, activeCompPath, sdkSession, sdkDeps],
);
const removeKeyframe = useCallback(
(selection: DomEditSelection, animationId: string, percentage: number) => {
const sourceFile = selection.sourceFile || activeCompPath || "index.html";
const mutation = { type: "remove-keyframe", animationId, percentage };
void executeOptimisticKeyframeCacheUpdate({
sourceFile,
elementId: selection.id,
apply: (prev) => ({
...prev,
// Match the writer's removal tolerance (PCT_TOLERANCE = 2 in
// gsapWriterAcorn): removing at e.g. 49% drops a keyframe at 50% on
// disk, so the optimistic cache must drop it too — else the stranded
// entry is a phantom that vanishes on the next reload (mirror of the
// add-path tolerance fix).
keyframes: prev.keyframes.filter(
(kf) => Math.abs((kf.tweenPercentage ?? kf.percentage) - percentage) > 2,
),
}),
persist: async () => {
if (sdkSession && sdkDeps) {
const handled = await sdkGsapRemoveKeyframePersist(
sourceFile,
animationId,
percentage,
sdkSession,
sdkDeps,
{ label: `Remove keyframe at ${percentage}%` },
);
if (handled) return;
}
await commitMutation(selection, mutation, {
label: `Remove keyframe at ${percentage}%`,
softReload: true,
});
},
}).catch((error) => {
trackGsapSaveFailure(error, selection, mutation, `Remove keyframe at ${percentage}%`);
});
},
[activeCompPath, commitMutation, trackGsapSaveFailure, sdkSession, sdkDeps],
);
const moveKeyframe = useCallback(
(
selection: DomEditSelection,
animationId: string,
fromPercentage: number,
toPercentage: number,
) => {
const mutation = { type: "move-keyframe", animationId, fromPercentage, toPercentage };
// No SDK persist helper exists for retime — server path only. The post-commit
// updateKeyframeCacheFromParsed re-keys the diamond from the fresh parse, so no
// optimistic cache write is needed (mapping the tween-% to clip-% here would
// duplicate that math). softReload mirrors remove-keyframe.
void commitMutation(selection, mutation, {
label: `Move keyframe to ${toPercentage}%`,
softReload: true,
}).catch((error) => {
trackGsapSaveFailure(error, selection, mutation, `Move keyframe to ${toPercentage}%`);
});
},
[commitMutation, trackGsapSaveFailure],
);
const resizeKeyframedTween = useCallback(
(
selection: DomEditSelection,
animationId: string,
position: number,
duration: number,
pctRemap: Array<{ from: number; to: number }>,
) => {
const mutation = {
type: "resize-keyframed-tween",
animationId,
position,
duration,
pctRemap,
};
// Boundary drag-to-retime: the server re-keys keyframes in place + grows the
// tween window, preserving _auto / per-keyframe ease / easeEach / outer ease.
// softReload re-keys the diamonds from the fresh parse (mirrors moveKeyframe).
void commitMutation(selection, mutation, {
label: "Retime keyframe (resize tween)",
softReload: true,
}).catch((error) => {
trackGsapSaveFailure(error, selection, mutation, "Retime keyframe (resize tween)");
});
},
[commitMutation, trackGsapSaveFailure],
);
const convertToKeyframes = useCallback(
async (
selection: DomEditSelection,
animationId: string,
resolvedFromValues?: Record<string, number | string>,
duration?: number,
) => {
if (sdkSession && sdkDeps) {
const targetPath = selection.sourceFile || activeCompPath || "index.html";
const handled = await sdkGsapConvertToKeyframesPersist(
targetPath,
animationId,
resolvedFromValues,
sdkSession,
sdkDeps,
{ label: "Convert to keyframes" },
);
if (handled) return;
}
return commitMutation(
selection,
// `duration` only applies when the target is a static `set` (which has
// none) — it spans the converted keyframes across the element's clip.
{ type: "convert-to-keyframes", animationId, resolvedFromValues, duration },
{ label: "Convert to keyframes" },
);
},
[commitMutation, activeCompPath, sdkSession, sdkDeps],
);
const removeAllKeyframes = useCallback(
async (selection: DomEditSelection, animationId: string) => {
const targetPath = selection.sourceFile || activeCompPath || "index.html";
// remove-all-keyframes collapses the tween to a static hold and the commit
// path doesn't return parsed animations, so the keyframe cache is never
// refreshed — clear it here so the timeline diamonds disappear immediately.
const elementId = selection.id ?? selection.selector?.match(/^#([\w-]+)/)?.[1] ?? null;
if (elementId) clearKeyframeCacheForElement(targetPath, elementId);
if (sdkSession && sdkDeps) {
const handled = await sdkGsapRemoveAllKeyframesPersist(
targetPath,
animationId,
sdkSession,
sdkDeps,
{ label: "Remove all keyframes" },
);
if (handled) return;
}
commitMutationSafely(
selection,
{ type: "remove-all-keyframes", animationId },
{ label: "Remove all keyframes", softReload: true },
);
},
[commitMutationSafely, activeCompPath, sdkSession, sdkDeps],
);
const commitKeyframeAtTime = useCallback(
(
selection: DomEditSelection,
absoluteTime: number,
animations: GsapAnimation[],
properties: Record<string, number | string>,
) => commitKeyframeAtTimeImpl(selection, absoluteTime, animations, properties, commitMutation),
[commitMutation],
);
return {
addKeyframe,
addKeyframeBatch,
removeKeyframe,
moveKeyframe,
resizeKeyframedTween,
convertToKeyframes,
removeAllKeyframes,
commitKeyframeAtTime,
};
}