mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-15 13:58:20 +00:00
* feat(studio): glue API coexistence layer for the NLE swap What: extends 21 glue files so the OLD timeline/canvas engine and the NEW NLE components type-check side by side: playerStore (multi-select setters, zoom pin, snap toggle, non-reactive scale scratch), drag-state types gain optional NLE fields, timelineLayout/timelineAssetDrop/timelineEditingHelpers/ timelineEditing/timelineElementHelpers/studioHelpers/assetHelpers gain the NLE exports, DomEditOverlay + gestures + AssetContextMenu + Timeline props gain optional callbacks/params, contexts gain *Optional hooks, and TimelineEditCallbacks.onMoveElements becomes a bivariant method accepting both engines' change shapes. patchDocumentRootDuration's test rides along. Why: this is the keystone that dissolves the old "welded glue" problem — every symbol the NLE components need is ADDED next to what the old engine still uses, so the engine components and the swaps can land as separate reviewable PRs. How: 15 authored intermediate files (main content + additive symbols; no behavior changes — new fields optional, new callbacks unused until wired) plus 6 files whose final content is already purely additive. New exports without consumers yet carry TEMP(studio-dnd) ignoreExports entries, removed by the app-shell swap. Test plan: tsc --noEmit in studio + studio-server (verifies BOTH engines compile); bunx vitest run (full suite green incl. the 6 new patchDocumentRootDuration tests); fallow audit clean. * feat(studio): timeline interaction hooks and lanes component (unwired) What: the timeline-side wiring layer, unwired: TimelineLanes (the lane renderer driving drag/resize/marquee), timelineMarquee (+tests), useTimelineStackingSync, useTimelineGeometry, useTimelineEditPinning, useTimelineEditingDrops. Why: everything between the pure drag math and <Timeline> itself; the timeline-glue swap PR then only rewires Timeline/TimelineCanvas onto these. How: new files, tsc-clean against the coexistence layer. Unwired components carry TEMP(studio-dnd) entry registrations, removed at the app-shell swap. Test plan: bunx vitest run timelineMarquee.test.ts; tsc --noEmit; fallow audit clean. * feat(studio): NLE shell assembly (unwired) What: EditorShell (the full editor layout replacing NLELayout + StudioPreviewArea), TimelinePane (timeline host with sub-comp rebasing) and useTimelineEditCallbacks (the callback bag bridging store edits to the timeline), all unwired. Why: the shell that App swaps to in the final step; reviewing it standalone keeps that swap PR small. How: new files against the coexistence layer; TEMP(studio-dnd) entries until App mounts EditorShell in the app-shell swap. Test plan: tsc --noEmit; bunx vitest run (suite unchanged); fallow audit clean. * feat(studio): timeline glue swap — Timeline/TimelineCanvas onto the NLE engine What: flips the timeline glue to its final form (23 files): Timeline and TimelineCanvas rebuilt on TimelineLanes/TimelineOverlays, useTimelineClipDrag drives preview/commit through the new drag engine, range selection goes multi-select, playback loop moves to useTimelinePlayerLoop. Deletes the 9 old-engine files this orphans (group drag, marquee selection, snap targets, layer gutter, selection overlays + their suites) — each is compile- or gate-forced by this swap, verified by probe. Why: second swap step; timeline-only, canvas and App untouched. How: modified files to final content + forced deletions. playerStore/timelineEditing/timelineCallbacks stay at their coexistence form until the app swap (the old App still runs on them). Test plan: tsc --noEmit; bunx vitest run (full suite); fallow audit clean. * feat(studio): clip thumbnail modules What: ImageThumbnail (+tests) and thumbnailUtils (+tests) — frame decode with SVG/AVIF format fallbacks and rounded-corner clipping — plus VideoThumbnail updates. Why: the decode layer for timeline clip thumbnails, ahead of the visual refresh that renders them. How: new modules + one modified file; purely presentational. Test plan: bunx vitest run on both test files; tsc --noEmit; fallow audit clean. * feat(studio): assets/blocks panel behaviors + preview helpers What: blocks tab install flow, right-panel and global drag-overlay polish, music beat analysis and clip-content rendering hooks, and the preview-helper utilities backing asset preview. Why: completes the studio NLE stack on top of the visual refresh. How: modified files only (kept as one PR: splitting further would produce sub-150-LOC fragments of interdependent panel glue). Test plan: bunx vitest run studioPreviewHelpers/studioUrlState suites; tsc --noEmit; fallow audit clean. * fix(studio): restore timeline playback loop * fix(studio): restore missing GSAP helpers module * refactor(studio): split timeline GSAP helpers * style(studio): keep timeline helper under size limit * fix(studio): restore timeline overlays module * fix(studio): remove stale GSAP import * fix(studio): restore canonical timeline dependencies * style(studio): format restored timeline helpers * style(studio): satisfy helper line limit * fix(studio): repair rebuilt timeline integration * feat(studio): complete rebuilt NLE cutover * fix(studio): guard project and timeline race boundaries * fix(studio): preserve graded resize and crop geometry * fix(studio): log resize/rotate commit failures, move anchor accumulator to resize-local * fix(studio): treat duration-0 tweens as static holds and settle resize position before persist Instant holds (to()/fromTo() with duration 0) were classified as animated tweens by every commit route, so resizing or rotating them converted the hold into a corrupt duration-0 keyframes tween (new value at 0%, old at 100%) that GSAP drops; panel edits appended a losing set. A shared isInstantHold() now routes them through the static replace-in-place path, and percentage math guards zero-duration windows. Separately, anchored-corner resizes painted 3-5 frames at the new size but old position while the offset persist round-tripped the server. The commit path now applies the corrected GSAP position synchronously before awaiting the offset persist, mirroring the scale route's settle. * feat(studio): gesture-transaction seam with commit observability Introduce runGestureTransaction — one owner for a gesture commit's settle -> persist -> record lifecycle. It settles the live DOM synchronously before any async persist, folds every mutation into one undo entry via a per-transaction coalesceKey, restores pre-gesture state exactly once on failure, and asserts (dev console) + reports (PostHog: commit_transaction / commit_invariant_violation / commit_transaction_failed) that a persist never changes pixels. The box-size resize path is migrated onto it; the ad hoc per-route coalesceKey/reload handling is removed. Extract the resize draft-rect math into resizeDraft.ts to keep the gesture-handler file under the size cap. Also: keep url_hash telemetry to the route slug only (drop the query string, which carried the user's selected element id/selector), and gate the [hf-resize] diagnostics behind localStorage hf-resize-debug so they ship as opt-in tracing rather than console noise. * fix(studio): transaction owns the undo label The coalesced history entry took the last sub-mutation's label, so a resize surfaced as "Move layer" (the offset persist) in undo/redo. The seam now stamps tx.label on every wrapped mutation, so the folded entry reads as the gesture. * fix(studio): atomic static size/position commits (no data loss) Static resize/position holds updated an existing set via delete+add — two undo entries, and a delete that succeeded before a failed add lost the hold on disk. Use one in-place update-properties mutation when a set exists (one undo entry, no partial-failure window). The keyframed-hold heal that can't be expressed as a property update now adds before it deletes, so any single failure leaves a recoverable duplicate, never a lost hold. Transaction-owned commits are tracked via a WeakSet so the heal path never double-wraps an already-wrapped gesture. * fix(core): restore timed-clip visibility after a forced timeline rebind __hfForceTimelineRebind force-rendered the re-registered timeline but never re-ran the per-[data-start] visibility pass, so after undo or soft reload every clip rendered regardless of its time window until a full page reload. Extract the visibility loop into syncTimedElementVisibility and call it from both syncMediaForCurrentState (unchanged) and the rebind. * fix(studio): atomic z-order/keyframe/split commits, one undo entry each Three edit-commit paths hardened onto the one-transaction invariant: - Z-order reorder (useElementLifecycleOps): N per-element writes now fold into one undo entry (coalesceMs Infinity) and, on a failed persist, restore already-written files to disk so no partial reorder survives. - Enable-keyframes (useEnableKeyframes/useGsapKeyframeOps): the intermediate convert phase no longer full-reloads the preview (skipReload), killing the black-flash remount; convert + edit share one coalesce key = one undo entry. - Razor split-all (useRazorSplit): snapshot before the batch and restore on any failure, so a mid-batch error never leaves un-revertable partial splits. Shared file-history helpers (RecordEditInput, DomEditCommitBaseParams, readProjectFileContent, restoreFilesToOriginal) dedupe the rollback/commit logic across these paths. Commit options thread as one partial object rather than field-by-field. Test setup extracted into colocated helpers. * fix(studio): fold multi-step edits into one undo entry; guard text revert - Gesture recording (useGestureCommit): the per-property-group commits now share one coalesce key and only the last reloads, so a recording is one undo entry and one preview reload instead of up to four. - Delete selected keyframes (deleteSelectedKeyframes, split out of timelineEditingHelpers): N removals fold into one coalesced undo entry with a single reload. - Text-field commit (useDomEditTextCommits): commitDomTextFields now uses the same version-guarded revert as handleDomTextCommit, so a stale failed commit can no longer stomp a newer successful one. * feat(studio): batch a gesture's mutations into one atomic server write A transaction that emits N mutations previously did N sequential POSTs, each rewriting the file and soft-reloading — the root of the multi-phase persist window. Add a gsap-mutations-batch endpoint that validates every mutation up front, applies them in one in-memory rewrite chain, and writes the file once (all-or-nothing: an invalid entry rejects the whole batch, no partial write). The seam buffers a transaction's commits and, when more than one targets the same file, dispatches a single batch — one write, one history entry, one reload. The batch capability rides on the existing commit-function reference; no option fields are threaded through callers. * fix(studio): soften off-canvas indicator outline to 30% opacity The dashed off-canvas selection outline at 60% was noisy with many protruding elements on screen; drop the resting opacity to 30% (hover still restores full opacity so it stays discoverable). * fix(studio): drop off-canvas indicator outline to 10% opacity Follow-up to the 30% softening — 10% resting opacity reads much calmer with many protruding elements; hover still restores full opacity. * fix(studio): gate [hf-commit] console traces to dev only The start/settled/persisted/restore lifecycle traces logged on every gesture commit in all environments — console noise for end users. Route them through a dev-only traceCommit helper (matching the pixel-violation error's existing DEV gate). The commit_* PostHog events stay always on; they are the production observability, the console lines are a dev aid. * fix(studio): count actual reloads, not softReload requests, in commit telemetry A resize's size and offset persists both request softReload; the seam counted each request, so a batched gesture reported reload_count 2 even though the batch is one write and one reload. Compute the count from what dispatchBufferedCommits actually did — one for a batch, the request count for the sequential fallback. * fix(studio): rotate hover + off-canvas overlays with the element; flicker-free crop - Hover overlay applied the element's rotation only to the selection chrome, not the hover box; it now rotates about center like the selection, via a shared orientedGroupAwareOverlayRect router (one owner for rotation-aware overlay geometry across hover/selection/off-canvas). - Off-canvas indicator was axis-aligned; it now rotates with the element and inverse-rotates the canvas-exclusion clip into the element's local frame, so the protruding-sliver clip stays correct for rotated elements. - Crop commit re-lifted the element only in the commit's .then(), so one frame painted the cropped state (the flicker). Re-lift synchronously right after onStyleCommit (which applies the clip before its first await), so the cropped state never paints; the persisted file value is unchanged. * fix(studio): address code-review findings across the commit-hardening campaign Correctness (would ship green, bite under latency): - Enable-keyframes phase 2 now carries coalesceMs: Infinity, so the convert folds into one undo entry instead of splitting past the 300ms default. - The SDK keyframe persist path forwards coalesceMs (CutoverOptions gains the field); multi-keyframe delete and convert coalesce correctly when SDK-routed. - Razor split-all's rollback is guarded so a failing restore can't swallow the error toast that tells the user the split failed. Simplification (single source of truth / no dead flexibility): - Decompose resolveResizeDraftRect (drops a fallow-ignore suppression). - Delegate the third readProjectFileContent copy to the shared helper. - Inline setPatchFromUpdateProperties (its only caller passes one mutation). - One toSdkPersistOptions translates gesture overrides to SDK options. - Bundle the reorder-rollback deps into one object (was 7-9 positional args). - Dedupe the 'last group reloads' ternary; type gesture options as CommitMutationOptions; drop a Map+array wrapper around a single write. * feat(studio): atomic z-order reorder via batch patch-element endpoint Z-order reorder issued N per-element inline-style patches (one server write each), so a mid-chain failure could leave a partial reorder on disk. Add a patch-elements-batch endpoint that validates every patch, folds them over the file in one in-memory rewrite, and writes once (all-or-nothing; unsafe input rejects with no write). The reorder now sends one batch per source file and records one undo entry. Because a failed atomic write persists nothing, the interim disk-write-back rollback (restoreReorderedFile / restoreFulfilledReorderFiles / ReorderRollbackDeps) is deleted — failure rolls back only live DOM/store state. Closes the last disk-atomicity gap. * fix(studio): razor-split undo no longer silently no-ops The split clone was written to disk without a data-hf-id, so the split endpoint recorded that unstamped HTML as the undo entry's afterHash. The next reloadPreview() ran the preview route's ensureHfIds write-back, which minted a fresh id and persisted DIFFERENT bytes — so at undo time the disk hash no longer matched afterHash and editHistory's content-mismatch guard silently refused the undo (no write, no network, no error). Stamp the split output via ensureHfIds in splitElementInHtml before it is written/returned, so the preview write-back is a no-op and the recorded afterHash always equals the final on-disk bytes. Fixes at the source rather than relaxing the mismatch guard. Corrects the stale comment that credited forceReloadSdkSession. * feat(studio): closed-hand grab cursor on the rotate handle The rotate handle used the default arrow cursor; show a grabbing (closed-hand) cursor on hover to signal it's grabbed and dragged to rotate. * fix(studio): dropping a dragged element over another no longer selects it A moved drag's release fired the box click, which re-selected whatever now sat under the pointer via the hover cache — so dropping an element over a higher-z one selected the drop target instead of keeping the dragged element selected. The drag-move branch now suppresses the next box click, mirroring the resize branch. * fix(studio): group drag is one undo entry, not one per element Dragging a multi-selected group committed each member's position write as its own undo entry, so reverting took N Cmd+Z presses. Force a shared coalesceKey (infinite window) across every member's commit so they fold into a single undo entry, like the other multi-step commit paths. * fix(studio): undo of a split no longer leaves a ghost clip in the timeline The file and the composition iframe revert correctly on undo, but the timeline panel kept a ghost node for the split clone. The element-merge that repopulates the timeline preserves elements the fresh scan dropped — intended for enriched sub-composition children a bare DOM re-scan misses, but it also preserved a genuinely-removed TOP-LEVEL element (the split clone after undo), leaving a phantom clip. Restrict the preserve to elements with a compositionSrc (the enriched sub-comp children); a top-level element missing from the fresh scan was truly removed. --------- Co-authored-by: ukimsanov <ular.kimsanov@heygen.com>
501 lines
20 KiB
TypeScript
501 lines
20 KiB
TypeScript
/**
|
|
* Centralized "Enable keyframes" logic that handles ALL scenarios:
|
|
* - Element has explicit keyframes → add/remove at seeked time
|
|
* - Element has a flat tween → convert + add at seeked time + propagate to end
|
|
* - Element has no animation (deleted) → create new tween with correct position + keyframes
|
|
*
|
|
* Always fetches fresh animation data to avoid stale session state.
|
|
* Reads GSAP runtime values only (no CSS offset — it applies separately via translate).
|
|
*/
|
|
import { useCallback } from "react";
|
|
import type { GsapAnimation, GsapPercentageKeyframe } from "@hyperframes/core/gsap-parser";
|
|
import type { DomEditSelection } from "../components/editor/domEditingTypes";
|
|
import { usePlayerStore } from "../player/store/playerStore";
|
|
import { fetchParsedAnimations, getAnimationsForElement } from "./useGsapTweenCache";
|
|
import { selectorFromSelection, computeElementPercentage, isInstantHold } from "./gsapShared";
|
|
import {
|
|
resolveTweenStart,
|
|
resolveTweenDuration,
|
|
isTimeWithinTween,
|
|
} from "../utils/globalTimeCompiler";
|
|
import { POSITION_PROPS } from "./gsapRuntimeReaders";
|
|
import { roundTo3 } from "../utils/rounding";
|
|
import { nearestPointOnPath } from "../components/editor/motionPathGeometry";
|
|
import type { CommitMutationOptions } from "./gsapScriptCommitTypes";
|
|
|
|
let enableKeyframesTransactionCounter = 0;
|
|
|
|
export interface EnableKeyframesSession {
|
|
domEditSelection: DomEditSelection | null;
|
|
selectedGsapAnimations: GsapAnimation[];
|
|
previewIframeRef?: React.RefObject<HTMLIFrameElement | null>;
|
|
handleGsapAddAnimation: (method: "to" | "from" | "set" | "fromTo") => void;
|
|
handleGsapConvertToKeyframes: (
|
|
animId: string,
|
|
resolvedFromValues?: Record<string, number | string>,
|
|
duration?: number,
|
|
commitOverrides?: Partial<CommitMutationOptions>,
|
|
) => void | Promise<void>;
|
|
handleGsapRemoveKeyframe: (animId: string, pct: number) => void;
|
|
handleGsapAddKeyframeBatch?: (
|
|
animId: string,
|
|
pct: number,
|
|
properties: Record<string, number | string>,
|
|
commitOverrides?: Partial<CommitMutationOptions>,
|
|
) => Promise<void>;
|
|
commitMutation?: (
|
|
mutation: Record<string, unknown>,
|
|
options: CommitMutationOptions,
|
|
) => Promise<void>;
|
|
}
|
|
|
|
/**
|
|
* Which animated properties to capture from the live element. Array-form keyframe
|
|
* tweens (`keyframes: [{x,y},…]`) leave `anim.properties` empty — the props live in
|
|
* the keyframe stops — so fall back to the union of the stops' keys, then to x/y.
|
|
*/
|
|
export function animatedProps(anim: GsapAnimation | null): string[] {
|
|
if (!anim) return ["x", "y"];
|
|
const own = Object.keys(anim.properties ?? {});
|
|
if (own.length > 0) return own;
|
|
const stops = anim.keyframes?.keyframes;
|
|
if (stops?.length) {
|
|
const keys = new Set<string>();
|
|
for (const stop of stops) for (const k of Object.keys(stop.properties ?? {})) keys.add(k);
|
|
if (keys.size > 0) return [...keys];
|
|
}
|
|
return ["x", "y"];
|
|
}
|
|
|
|
/**
|
|
* Whether the playhead sits inside an animation's tween range. When the tween's
|
|
* start can't be resolved we don't block (the percentage falls back to clip range,
|
|
* preserving prior behavior for elements without explicit timing).
|
|
*/
|
|
export function isPlayheadWithinTween(anim: GsapAnimation, currentTime: number): boolean {
|
|
const start = resolveTweenStart(anim);
|
|
if (start === null) return true;
|
|
return isTimeWithinTween(currentTime, start, resolveTweenDuration(anim));
|
|
}
|
|
|
|
/**
|
|
* Grow a keyframe tween's range to reach a playhead that sits outside it, and add a
|
|
* keyframe there. Existing keyframes keep their *absolute* timing (percentages
|
|
* rescale into the new range), so the current motion is preserved — the playhead
|
|
* just becomes a new hold at the start or end. Used when "add keyframe at playhead"
|
|
* fires beyond the tween instead of disabling the action.
|
|
*/
|
|
export function buildExtendedKeyframes(
|
|
anim: GsapAnimation,
|
|
currentTime: number,
|
|
position: Record<string, number>,
|
|
): { position: number; duration: number; keyframes: GsapPercentageKeyframe[] } {
|
|
const oldStart = resolveTweenStart(anim) ?? 0;
|
|
const oldDuration = resolveTweenDuration(anim);
|
|
const newStart = Math.min(oldStart, currentTime);
|
|
const newEnd = Math.max(oldStart + oldDuration, currentTime);
|
|
const newDuration = roundTo3(newEnd - newStart);
|
|
const toPct = (absoluteTime: number) =>
|
|
newDuration > 0
|
|
? Math.max(
|
|
0,
|
|
Math.min(100, Math.round(((absoluteTime - newStart) / newDuration) * 1000) / 10),
|
|
)
|
|
: 0;
|
|
const stops = anim.keyframes?.keyframes ?? [];
|
|
const rescaled: GsapPercentageKeyframe[] = stops.map((stop) => ({
|
|
percentage: toPct(oldStart + (stop.percentage / 100) * oldDuration),
|
|
properties: stop.properties,
|
|
...(stop.ease ? { ease: stop.ease } : {}),
|
|
}));
|
|
const added: GsapPercentageKeyframe = { percentage: toPct(currentTime), properties: position };
|
|
const keyframes = [...rescaled, added].sort((a, b) => a.percentage - b.percentage);
|
|
return { position: roundTo3(newStart), duration: newDuration, keyframes };
|
|
}
|
|
|
|
async function replaceSetWithSingleKeyframe(
|
|
session: EnableKeyframesSession,
|
|
sel: DomEditSelection,
|
|
setAnim: GsapAnimation,
|
|
t: number,
|
|
iframe: HTMLIFrameElement | null,
|
|
selector: string,
|
|
): Promise<void> {
|
|
const position = readElementPosition(iframe, sel, setAnim);
|
|
if (Object.keys(position).length === 0) {
|
|
for (const [key, held] of Object.entries(setAnim.properties ?? {})) {
|
|
if (typeof held === "number") position[key] = held;
|
|
}
|
|
}
|
|
if (Object.keys(position).length === 0 || !session.commitMutation) return;
|
|
const range = resolveNewTweenRange(sel.dataAttributes?.start, sel.dataAttributes?.duration, t);
|
|
await session.commitMutation(
|
|
{
|
|
type: "replace-with-keyframes",
|
|
animationId: setAnim.id,
|
|
targetSelector: selector,
|
|
position: roundTo3(range.start),
|
|
duration: roundTo3(range.duration),
|
|
keyframes: [{ percentage: 0, properties: position }],
|
|
ease: setAnim.ease,
|
|
},
|
|
{ label: "Enable keyframes", softReload: true },
|
|
);
|
|
}
|
|
|
|
// fallow-ignore-next-line complexity
|
|
function readElementPosition(
|
|
iframe: HTMLIFrameElement | null,
|
|
sel: DomEditSelection,
|
|
anim: GsapAnimation | null,
|
|
): Record<string, number> {
|
|
const result: Record<string, number> = {};
|
|
if (!iframe?.contentWindow) return result;
|
|
|
|
let gsap: { getProperty?: (el: Element, prop: string) => number } | undefined;
|
|
try {
|
|
gsap = (iframe.contentWindow as Window & { gsap?: typeof gsap }).gsap;
|
|
} catch {
|
|
return result;
|
|
}
|
|
|
|
const element = sel.element;
|
|
if (!element?.isConnected || !gsap?.getProperty) return result;
|
|
|
|
// ponytail: a brand-new tween captures position only — bundling opacity made it
|
|
// a mixed group that the position-only drag intercept couldn't resolve.
|
|
const props = animatedProps(anim);
|
|
for (const prop of props) {
|
|
const val = Number(gsap.getProperty(element, prop));
|
|
if (!Number.isFinite(val)) continue;
|
|
result[prop] = POSITION_PROPS.has(prop) ? Math.round(val) : roundTo3(val);
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Range for a brand-new keyframe tween created via "Enable keyframes" on an element
|
|
* with no existing animation. "Add a keyframe" must land at the PLAYHEAD.
|
|
*
|
|
* The runtime auto-stamps `data-start="0"` + `data-duration=<rootDuration>` on every
|
|
* timeline element, so we can't treat `data-start` as authored timing (doing so put
|
|
* the keyframe at 0). Instead, clamp the playhead into the element's [start, end]
|
|
* range: the auto-stamp's full-composition range passes the playhead through
|
|
* unchanged, while a genuinely narrow authored clip still clamps sensibly.
|
|
*/
|
|
export function resolveNewTweenRange(
|
|
authoredStart: string | undefined,
|
|
authoredDuration: string | undefined,
|
|
currentTime: number,
|
|
): { start: number; duration: number } {
|
|
const t = Math.max(0, roundTo3(currentTime));
|
|
const start = authoredStart != null ? Number.parseFloat(authoredStart) : Number.NaN;
|
|
const duration = authoredDuration != null ? Number.parseFloat(authoredDuration) : Number.NaN;
|
|
if (!Number.isFinite(start) || !Number.isFinite(duration) || duration <= 0) {
|
|
return { start: t, duration: 1 };
|
|
}
|
|
const end = start + duration;
|
|
const clampedStart = Math.min(Math.max(t, start), end);
|
|
return { start: clampedStart, duration: Math.max(0.5, roundTo3(end - clampedStart)) };
|
|
}
|
|
|
|
// Authoritative parse of the current source for `sel`. Returns `null` when the
|
|
// fetch can't run (no projectId / request failed) so callers can distinguish
|
|
// "unavailable" from a genuine empty result (e.g. after a delete-all). An empty
|
|
// array means the source was read and the element has no animations.
|
|
async function tryFetchAnimationsForElement(
|
|
sel: DomEditSelection,
|
|
): Promise<GsapAnimation[] | null> {
|
|
const projectId = window.location.hash.match(/project\/([^?/]+)/)?.[1];
|
|
if (!projectId) return null;
|
|
const sourceFile = sel.sourceFile || "index.html";
|
|
const parsed = await fetchParsedAnimations(projectId, sourceFile);
|
|
if (!parsed) return null;
|
|
return getAnimationsForElement(parsed.animations, {
|
|
id: sel.id,
|
|
selector: sel.selector,
|
|
});
|
|
}
|
|
|
|
async function fetchAnimationsForElement(sel: DomEditSelection): Promise<GsapAnimation[]> {
|
|
return (await tryFetchAnimationsForElement(sel)) ?? [];
|
|
}
|
|
|
|
/**
|
|
* Apply "add keyframe at playhead" to a tween that already has x/y keyframes:
|
|
* toggle off an existing stop, add one at the playhead's tween-relative %, or —
|
|
* when the playhead sits outside the tween — extend the range to reach it (see
|
|
* buildExtendedKeyframes). Shared by native keyframe tweens and flat tweens that
|
|
* were just converted, so both behave identically.
|
|
*/
|
|
async function applyKeyframeAtPlayhead(
|
|
session: EnableKeyframesSession,
|
|
sel: DomEditSelection,
|
|
kfAnim: GsapAnimation,
|
|
t: number,
|
|
iframe: HTMLIFrameElement | null,
|
|
commitOverrides?: Partial<CommitMutationOptions>,
|
|
): Promise<void> {
|
|
if (!isPlayheadWithinTween(kfAnim, t)) {
|
|
const position = readElementPosition(iframe, sel, kfAnim);
|
|
const selector = selectorFromSelection(sel);
|
|
if (selector && Object.keys(position).length > 0 && session.commitMutation) {
|
|
const extended = buildExtendedKeyframes(kfAnim, t, position);
|
|
await session.commitMutation(
|
|
{
|
|
type: "replace-with-keyframes",
|
|
animationId: kfAnim.id,
|
|
targetSelector: selector,
|
|
position: extended.position,
|
|
duration: extended.duration,
|
|
keyframes: extended.keyframes,
|
|
ease: kfAnim.ease,
|
|
},
|
|
{
|
|
label: "Add keyframe",
|
|
softReload: true,
|
|
...commitOverrides,
|
|
},
|
|
);
|
|
}
|
|
return;
|
|
}
|
|
const pct = computeElementPercentage(t, sel, kfAnim);
|
|
const existing = kfAnim.keyframes?.keyframes.find((k) => Math.abs(k.percentage - pct) <= 1);
|
|
if (existing) {
|
|
session.handleGsapRemoveKeyframe(kfAnim.id, existing.percentage);
|
|
return;
|
|
}
|
|
if (session.handleGsapAddKeyframeBatch) {
|
|
const position = readElementPosition(iframe, sel, kfAnim);
|
|
if (Object.keys(position).length > 0) {
|
|
await session.handleGsapAddKeyframeBatch(kfAnim.id, pct, position, commitOverrides);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A set() is an instantaneous hold. "Add keyframe at playhead" promotes it to a
|
|
* two-stop tween from the set's time to the playhead — the held value at 0%, the
|
|
* live value at 100% — giving the user something to animate. No-op if the playhead
|
|
* is at or before the set.
|
|
*
|
|
* The 0% endpoint is the held start, which the user didn't choose — mark it `auto`
|
|
* so it tracks the nearest keyframe until edited directly. The 100% is the real
|
|
* keyframe being placed at the playhead, so it stays fixed.
|
|
*/
|
|
export async function promoteSetToKeyframes(
|
|
session: EnableKeyframesSession,
|
|
sel: DomEditSelection,
|
|
setAnim: GsapAnimation,
|
|
t: number,
|
|
iframe: HTMLIFrameElement | null,
|
|
): Promise<void> {
|
|
const selector = selectorFromSelection(sel);
|
|
const setStart = resolveTweenStart(setAnim) ?? 0;
|
|
if (!selector || !session.commitMutation) return;
|
|
// Playhead at or before the set → there's no forward range to promote into.
|
|
// Instead of doing nothing (which read as "can't add a keyframe at 0"), replace
|
|
// the set with a single keyframe at the playhead holding its value, matching the
|
|
// no-animation branch: one diamond the user can build motion from.
|
|
if (t <= setStart) {
|
|
await replaceSetWithSingleKeyframe(session, sel, setAnim, t, iframe, selector);
|
|
return;
|
|
}
|
|
const endPosition = readElementPosition(iframe, sel, setAnim);
|
|
if (Object.keys(endPosition).length === 0) return;
|
|
const startPosition: Record<string, number> = {};
|
|
for (const key of Object.keys(endPosition)) {
|
|
const held = setAnim.properties?.[key];
|
|
if (typeof held === "number") startPosition[key] = held;
|
|
}
|
|
await session.commitMutation(
|
|
{
|
|
type: "replace-with-keyframes",
|
|
animationId: setAnim.id,
|
|
targetSelector: selector,
|
|
position: roundTo3(setStart),
|
|
duration: roundTo3(t - setStart),
|
|
keyframes: [
|
|
{
|
|
percentage: 0,
|
|
properties: Object.keys(startPosition).length > 0 ? startPosition : endPosition,
|
|
auto: true,
|
|
},
|
|
{ percentage: 100, properties: endPosition },
|
|
],
|
|
ease: setAnim.ease,
|
|
},
|
|
{ label: "Add keyframe", softReload: true },
|
|
);
|
|
}
|
|
|
|
/**
|
|
* An arc (motionPath) tween — its waypoints are reconstructed onto `keyframes`, so
|
|
* it must be edited as waypoints (not x/y keyframes, which would break the curve).
|
|
* "Add keyframe at playhead" drops a waypoint where the element currently sits on
|
|
* the path, inserted at the matching segment so the curve is preserved. Outside the
|
|
* range, extend the duration so the motion reaches the playhead.
|
|
*/
|
|
// fallow-ignore-next-line complexity
|
|
async function applyArcWaypointAtPlayhead(
|
|
session: EnableKeyframesSession,
|
|
sel: DomEditSelection,
|
|
arcAnim: GsapAnimation,
|
|
t: number,
|
|
iframe: HTMLIFrameElement | null,
|
|
): Promise<void> {
|
|
if (!session.commitMutation) return;
|
|
if (!isPlayheadWithinTween(arcAnim, t)) {
|
|
const start = resolveTweenStart(arcAnim) ?? 0;
|
|
if (t > start) {
|
|
await session.commitMutation(
|
|
{
|
|
type: "update-meta",
|
|
animationId: arcAnim.id,
|
|
updates: { duration: roundTo3(t - start) },
|
|
},
|
|
{ label: "Extend motion path", softReload: true },
|
|
);
|
|
}
|
|
return;
|
|
}
|
|
const live = readElementPosition(iframe, sel, arcAnim);
|
|
if (typeof live.x !== "number" || typeof live.y !== "number") return;
|
|
const liveX = live.x;
|
|
const liveY = live.y;
|
|
const nodes = (arcAnim.keyframes?.keyframes ?? [])
|
|
.map((k) => ({ x: k.properties.x, y: k.properties.y }))
|
|
.filter(
|
|
(p): p is { x: number; y: number } => typeof p.x === "number" && typeof p.y === "number",
|
|
);
|
|
// Don't duplicate a waypoint that already sits where the element is (e.g. at the
|
|
// path endpoints).
|
|
const WAYPOINT_MERGE_PX = 6;
|
|
if (nodes.some((n) => Math.hypot(n.x - liveX, n.y - liveY) <= WAYPOINT_MERGE_PX)) return;
|
|
const proj = nearestPointOnPath(liveX, liveY, nodes);
|
|
if (!proj) return;
|
|
await session.commitMutation(
|
|
{
|
|
type: "add-motion-path-point",
|
|
animationId: arcAnim.id,
|
|
index: proj.segIndex + 1,
|
|
x: liveX,
|
|
y: liveY,
|
|
},
|
|
{ label: "Add waypoint", softReload: true },
|
|
);
|
|
}
|
|
|
|
export function useEnableKeyframes(
|
|
sessionRef: React.RefObject<EnableKeyframesSession | undefined>,
|
|
) {
|
|
// fallow-ignore-next-line complexity
|
|
return useCallback(async () => {
|
|
const session = sessionRef.current;
|
|
if (!session) return;
|
|
const sel = session.domEditSelection;
|
|
if (!sel) return;
|
|
|
|
const t = usePlayerStore.getState().currentTime;
|
|
const iframe = session.previewIframeRef?.current ?? null;
|
|
|
|
// `selectedGsapAnimations` is a studio-side selection cache that can lag a
|
|
// mutation — e.g. right after a delete-all it may still hold the just-removed
|
|
// tween, which would route us into the wrong branch below (editing a tween
|
|
// that no longer exists in source). Prefer the authoritative parse of the
|
|
// current source; an empty parse is a valid "no animations" result and is
|
|
// honored. Fall back to the cache only when the fetch couldn't run at all
|
|
// (no projectId / request failed), preserving prior behavior offline.
|
|
const fetched = await tryFetchAnimationsForElement(sel);
|
|
const anims = fetched ?? session.selectedGsapAnimations;
|
|
|
|
// An arc/motionPath tween carries reconstructed x/y keyframes too, so match it
|
|
// first and edit it as waypoints — treating it as plain keyframes would break
|
|
// the curve.
|
|
const arcAnim = anims.find((a) => a.arcPath);
|
|
const kfAnim = anims.find((a) => a.keyframes && !a.arcPath);
|
|
const setAnim = anims.find((a) => isInstantHold(a) && !a.keyframes && !a.arcPath);
|
|
const flatAnim = anims.find((a) => !a.keyframes && !a.arcPath && !isInstantHold(a));
|
|
|
|
if (arcAnim) {
|
|
await applyArcWaypointAtPlayhead(session, sel, arcAnim, t, iframe);
|
|
} else if (kfAnim) {
|
|
await applyKeyframeAtPlayhead(session, sel, kfAnim, t, iframe);
|
|
} else if (setAnim) {
|
|
await promoteSetToKeyframes(session, sel, setAnim, t, iframe);
|
|
} else if (flatAnim) {
|
|
// Convert the flat tween (to/from/fromTo) to its natural keyframes — no
|
|
// resolvedFromValues, so the 0%/100% stops keep the real start→end motion
|
|
// (passing the playhead value would flatten it). Then apply uniformly so an
|
|
// out-of-range playhead extends the range just like a keyframe tween.
|
|
enableKeyframesTransactionCounter += 1;
|
|
const coalesceKey = `enable-keyframes:${flatAnim.id}:${enableKeyframesTransactionCounter}`;
|
|
const convertCommitOverrides: Partial<CommitMutationOptions> = {
|
|
skipReload: true,
|
|
coalesceKey,
|
|
coalesceMs: Number.POSITIVE_INFINITY,
|
|
};
|
|
await session.handleGsapConvertToKeyframes(
|
|
flatAnim.id,
|
|
undefined,
|
|
undefined,
|
|
convertCommitOverrides,
|
|
);
|
|
const converted = (await fetchAnimationsForElement(sel)).find((a) => a.keyframes);
|
|
if (converted) {
|
|
const applyCommitOverrides: Partial<CommitMutationOptions> = {
|
|
softReload: true,
|
|
coalesceKey,
|
|
// Must match the convert phase's window: editHistory keys coalescing
|
|
// off the incoming entry, so without Infinity here the apply (landing
|
|
// after two POSTs + a fetch) falls back to the 300ms default and the
|
|
// conversion splits into two undo entries under real latency.
|
|
coalesceMs: Number.POSITIVE_INFINITY,
|
|
};
|
|
await applyKeyframeAtPlayhead(session, sel, converted, t, iframe, applyCommitOverrides);
|
|
}
|
|
} else {
|
|
const position = readElementPosition(iframe, sel, null);
|
|
const { start: elStart, duration: elDuration } = resolveNewTweenRange(
|
|
sel.dataAttributes?.start,
|
|
sel.dataAttributes?.duration,
|
|
t,
|
|
);
|
|
const selector = selectorFromSelection(sel);
|
|
|
|
if (!selector) {
|
|
session.handleGsapAddAnimation("to");
|
|
return;
|
|
}
|
|
|
|
if (Object.keys(position).length === 0) {
|
|
position.x = 0;
|
|
position.y = 0;
|
|
}
|
|
|
|
// One keyframe at the playhead — a single diamond capturing the current
|
|
// value. Motion comes from the user adding/dragging more keyframes later;
|
|
// creating 0%+100% up front showed two diamonds for a single "add keyframe".
|
|
const keyframes: Array<{ percentage: number; properties: Record<string, number | string> }> =
|
|
[{ percentage: 0, properties: { ...position } }];
|
|
|
|
if (session.commitMutation) {
|
|
await session.commitMutation(
|
|
{
|
|
type: "add-with-keyframes",
|
|
targetSelector: selector,
|
|
position: roundTo3(elStart),
|
|
duration: roundTo3(elDuration),
|
|
keyframes,
|
|
},
|
|
{ label: "Enable keyframes", softReload: true },
|
|
);
|
|
} else {
|
|
session.handleGsapAddAnimation("to");
|
|
}
|
|
}
|
|
}, [sessionRef]);
|
|
}
|