Files
hyperframes/packages/studio/src/hooks/useAnimatedPropertyCommit.ts
T
Miguel Ángelandukimsanov df29fa7a5e feat(studio): revamps Studio + improves code quality (#2291)
* 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>
2026-07-13 02:55:36 -04:00

531 lines
21 KiB
TypeScript

/**
* Unified helper for committing any GSAP property value from the design panel.
*
* Routing depends on whether the element is animated (has keyframes on any tween):
* - Animated → write the value into a keyframe at the current playhead (convert a
* flat tween first if needed). An existing static `set` auto-converts to keyframes.
* - Static (no keyframes anywhere) → persist as a `tl.set`, NEVER keyframes — same
* as manual drag / resize / rotate. Updates an existing set or creates one.
*/
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 type { SetPatchProps } from "./gsapRuntimePatch";
import { selectorFromSelection, computeElementPercentage, isInstantHold } from "./gsapShared";
import { resolveTweenStart, resolveTweenDuration } from "../utils/globalTimeCompiler";
import { roundTo3 } from "../utils/rounding";
import { commitWholePropertyOffset } from "./gsapWholePropertyOffsetCommit";
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 {
const targetGroup = property ? classifyPropertyGroup(property) : undefined;
// Group-aware: never hand back a tween from a DIFFERENT property group. The old
// `animations.length <= 1` early return merged a rotation/3D edit into the element's
// only tween even when that was a `position` tween — contaminating it and leaving the
// new property with no clean keyframe baseline. When a target group is known, only
// same-group tweens are candidates; if none exist we return undefined and the caller
// creates a fresh same-group tween.
const candidates =
targetGroup !== undefined
? animations.filter((a) => a.propertyGroup === targetGroup)
: animations;
if (candidates.length === 0) return undefined;
if (candidates.length === 1) return candidates[0];
const currentTime = usePlayerStore.getState().currentTime;
const scored = candidates.map((a) => {
let score = 0;
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;
}
/**
* Auto-keyframe a just-updated static `set`: if the element is already animated
* (its clip carries keyframes on another tween), convert the set to keyframes so
* subsequent edits at other playheads interpolate — matching the drag / resize /
* rotate UX. Purely static elements (no other keyframes) are left as a set.
*/
async function maybeAutoKeyframeSet(
selection: DomEditSelection,
setAnim: GsapAnimation,
animations: GsapAnimation[],
commit: NonNullable<CommitAnimatedPropertyDeps["gsapCommitMutation"]>,
): Promise<void> {
const animatedTween = animations.find((a) => a.keyframes && a.id !== setAnim.id);
if (!animatedTween) return;
await commit(
selection,
{
type: "convert-to-keyframes",
animationId: setAnim.id,
duration: animatedTween.duration ?? 1,
},
{ label: "Keyframe 3D transform", softReload: true },
);
}
type Commit = NonNullable<CommitAnimatedPropertyDeps["gsapCommitMutation"]>;
/** Undo-history label for a static-set commit, from the group it writes. */
const STATIC_SET_LABELS: Partial<Record<ReturnType<typeof classifyPropertyGroup>, string>> = {
position: "Move layer",
scale: "Resize layer",
size: "Resize layer",
rotation: "Rotate layer",
visual: "Set opacity",
other: "Set 3D transform",
};
function staticSetLabel(propEntries: [string, number | string][]): string {
const groups = new Set(propEntries.map(([k]) => classifyPropertyGroup(k)));
const only = groups.size === 1 ? [...groups][0] : undefined;
return (only && STATIC_SET_LABELS[only]) || "Set properties";
}
/** Merge ALL props into the static `set` in ONE commit (value-only, instant), then
* auto-keyframe. One mutation — a per-property loop would shift the set's
* group-derived id mid-way (e.g. reset adding `scale` to a rotation set), 404-ing
* the next update. */
async function commitSetProps(
selection: DomEditSelection,
setAnim: GsapAnimation,
propEntries: [string, number | string][],
selector: string | null,
animations: GsapAnimation[],
commit: Commit,
): Promise<void> {
const properties = Object.fromEntries(propEntries);
const numericProps: SetPatchProps = {};
for (const [k, v] of propEntries) {
if (typeof v === "number") numericProps[k as keyof SetPatchProps] = v;
}
const instantPatch =
selector && Object.keys(numericProps).length > 0
? {
selector,
change: {
kind: (setAnim.global ? "global-set" : "set") as "set" | "global-set",
props: numericProps,
},
}
: undefined;
await commit(
selection,
{ type: "update-properties", animationId: setAnim.id, properties },
{
label: staticSetLabel(propEntries),
softReload: true,
...(instantPatch ? { instantPatch } : {}),
},
);
await maybeAutoKeyframeSet(selection, setAnim, animations, commit);
}
/**
* Static element (no keyframes on ANY of its tweens): persist the 3D props as a
* `tl.set` — NEVER keyframes. Mirrors manual drag / resize / rotate, which `tl.set`
* a static element instead of animating it. Updates an existing same-group static
* hold in place, or creates a dedicated `set` at position 0 when the element has none.
*/
async function commitStaticSet(
selection: DomEditSelection,
propEntries: [string, number | string][],
selector: string | null,
animations: GsapAnimation[],
commit: Commit,
): Promise<void> {
if (!selector) return;
// One commit per PROPERTY GROUP, each into a static write that owns that group —
// never a live tween, and never a foreign-group write (a width edit used to
// merge into the element's position set, producing a mixed write the split
// machinery exists to prevent). Within a group everything batches into ONE
// commit: a write's id is group-derived, so a per-prop loop would shift the id
// mid-way and 404 the next update.
const byGroup = new Map<string, [string, number | string][]>();
for (const entry of propEntries) {
const group = classifyPropertyGroup(entry[0]);
const batch = byGroup.get(group) ?? [];
batch.push(entry);
byGroup.set(group, batch);
}
const staticWrites = animations.filter((a) => isInstantHold(a) && a.targetSelector === selector);
// Resolve every group's target BEFORE committing anything, and coalesce
// groups that land on the SAME write into one commit: the snapshot is captured
// once, so if two groups resolved to one legacy mixed write, a first
// commit could re-shape it server-side and leave the second chasing a stale
// id (404 on legacy pre-split files).
const byTargetWrite = new Map<GsapAnimation, [string, number | string][]>();
const newSetBatches: [string, number | string][][] = [];
for (const [group, batch] of byGroup) {
const existingWrite = findGroupOwningStaticWrite(staticWrites, group);
if (existingWrite) {
byTargetWrite.set(existingWrite, [...(byTargetWrite.get(existingWrite) ?? []), ...batch]);
} else {
newSetBatches.push(batch);
}
}
for (const [targetWrite, batch] of byTargetWrite) {
await commitSetProps(selection, targetWrite, batch, selector, animations, commit);
}
// Fresh adds don't reshape existing sets, so their ids can't go stale.
for (const batch of newSetBatches) {
await addGlobalStaticSet(selection, batch, selector, commit);
}
}
/**
* The static write that owns a property group: one already dedicated to the
* group wins; else a mixed write that already carries a property of the group
* (merging same-group values there beats spawning a second writer for the channel).
*/
function findGroupOwningStaticWrite(
staticWrites: GsapAnimation[],
group: string,
): GsapAnimation | undefined {
return (
staticWrites.find((a) => a.propertyGroup === group) ??
staticWrites.find((a) =>
Object.keys(a.properties).some((k) => classifyPropertyGroup(k) === group),
)
);
}
/**
* Base `gsap.set` (off-timeline) — a static hold with no 0% keyframe marker, so
* adjusting a 3D transform on a non-keyframed element doesn't drop a keyframe on
* the timeline (matches the manual-drag UX). The global-set instant patch applies
* it straight to the element so the first edit shows with no soft-reload flash.
*/
async function addGlobalStaticSet(
selection: DomEditSelection,
batch: [string, number | string][],
selector: string,
commit: Commit,
): Promise<void> {
const numericProps: SetPatchProps = {};
for (const [k, v] of batch) {
if (typeof v === "number") numericProps[k as keyof SetPatchProps] = v;
}
await commit(
selection,
{
type: "add",
targetSelector: selector,
method: "set",
position: 0,
properties: Object.fromEntries(batch),
global: true,
},
{
label: staticSetLabel(batch),
softReload: true,
...(Object.keys(numericProps).length > 0
? {
instantPatch: {
selector,
change: { kind: "global-set" as const, props: numericProps },
},
}
: {}),
},
);
}
/** Convert-if-flat, then write ALL props into ONE keyframe at the playhead. */
// fallow-ignore-next-line complexity
async function commitKeyframeProps(
selection: DomEditSelection,
anim: GsapAnimation,
props: Record<string, number | string>,
propEntries: [string, number | string][],
primaryProp: string,
selector: string | null,
iframe: HTMLIFrameElement | null,
commit: Commit,
): Promise<void> {
const wasKeyframed = !!anim.keyframes;
if (!wasKeyframed) {
await commit(
selection,
{ type: "convert-to-keyframes", animationId: anim.id },
{ label: "Convert to keyframes", skipReload: true },
);
}
const ct = usePlayerStore.getState().currentTime;
const runtimeProps = selector ? readAllAnimatedProperties(iframe, selector, anim) : {};
const properties: Record<string, number | string> = { ...runtimeProps, ...props };
const backfillDefaults: Record<string, number | string> = { ...runtimeProps };
for (const [property, value] of propEntries) {
if (!(property in runtimeProps) && selector) {
const cssVal = readGsapProperty(iframe, selector, property);
if (cssVal != null) backfillDefaults[property] = cssVal;
}
backfillDefaults[property] = value;
}
// Playhead OUTSIDE the keyframe tween's time range → EXTEND the tween to reach it
// and add a keyframe there, exactly like manual drag's extendTweenAndAddKeyframe.
// The add-keyframe below only writes WITHIN the existing range, so without this a
// depth edit past the tween end just overwrites the last keyframe (the bug: no new
// diamond appears at a playhead beyond the tween). Only for an already-keyframed
// tween — a freshly-converted set has no prior range worth remapping.
const kfs = anim.keyframes?.keyframes;
const ts = resolveTweenStart(anim);
const td = resolveTweenDuration(anim);
const hasSelectedKeyframe = usePlayerStore.getState().activeKeyframePct != null;
const playheadOutside = ts !== null && td > 0 && (ct < ts - 0.01 || ct > ts + td + 0.01);
const willExtend = wasKeyframed && !!kfs && playheadOutside && !hasSelectedKeyframe;
if (willExtend && kfs && ts !== null) {
const newStart = Math.min(ct, ts);
const newEnd = Math.max(ct, ts + td);
const newDuration = Math.max(0.01, newEnd - newStart);
const remapped = kfs.map((kf) => {
const absTime = ts + (kf.percentage / 100) * td;
const newPct = Math.round(((absTime - newStart) / newDuration) * 1000) / 10;
const p: Record<string, number | string> = { ...kf.properties };
for (const k of Object.keys(properties)) {
if (!(k in p) && backfillDefaults[k] != null) p[k] = backfillDefaults[k];
}
return { percentage: newPct, properties: p };
});
remapped.push({
percentage: Math.round(((ct - newStart) / newDuration) * 1000) / 10,
properties,
});
remapped.sort((a, b) => a.percentage - b.percentage);
await commit(
selection,
{
type: "replace-with-keyframes",
animationId: anim.id,
targetSelector: anim.targetSelector,
position: roundTo3(newStart),
duration: roundTo3(newDuration),
keyframes: remapped,
},
{ label: `Edit ${primaryProp} (extended keyframe)`, softReload: true },
);
return;
}
const pct = computeElementPercentage(ct, selection, anim);
const existingKf = anim.keyframes?.keyframes.some((kf) => Math.abs(kf.percentage - pct) < 0.05);
// Rebuild the live keyframe tween in place so the edit shows instantly (no flash);
// rebuildKeyframeTween declines → soft reload if the tween can't be safely rebuilt.
const numericProps: Record<string, number> = {};
for (const [k, v] of Object.entries(properties)) {
if (typeof v === "number") numericProps[k] = v;
}
const instantPatch =
selector && Object.keys(numericProps).length > 0
? { selector, change: { kind: "keyframe-rebuild" as const, pct, props: numericProps } }
: undefined;
await commit(
selection,
existingKf
? { type: "update-keyframe", animationId: anim.id, percentage: pct, properties }
: {
type: "add-keyframe",
animationId: anim.id,
percentage: pct,
properties,
backfillDefaults,
},
{
label: `Edit ${primaryProp} (keyframe ${pct}%)`,
softReload: true,
...(instantPatch ? { instantPatch } : {}),
},
);
}
export function useAnimatedPropertyCommit(deps: CommitAnimatedPropertyDeps) {
const { selectedGsapAnimations, gsapCommitMutation, previewIframeRef, bumpGsapCache } = deps;
const commitAnimatedProperties = useCallback(
async (selection: DomEditSelection, props: Record<string, number | string>): Promise<void> => {
if (!gsapCommitMutation) return;
const propEntries = Object.entries(props);
if (propEntries.length === 0) return;
const primaryProp = propEntries[0]![0];
const iframe = previewIframeRef.current;
const selector = selectorFromSelection(selection);
const anim: GsapAnimation | undefined = pickBestAnimation(
selectedGsapAnimations,
selector,
primaryProp,
);
// Whether the element is animated at all. A 3D edit only creates/edits
// keyframes when it IS — a static element (no keyframes on any of its tweens)
// gets a `tl.set`, never new keyframes (matches manual drag / resize / rotate).
const elementHasKeyframes = selectedGsapAnimations.some((a) => !!a.keyframes);
// The picked anim comes from the (possibly stale) panel cache: if keyframes
// were just removed or the script changed underneath us, its id is gone
// server-side and the commit 404s. The raw commit already toasts; we catch
// so the rejection doesn't escape as an uncaught promise, and bump the cache
// so selectedGsapAnimations re-syncs and the user's next edit self-heals.
try {
// Animated element → keyframe at the playhead, EXACTLY like manual drag /
// resize / rotate: if the picked anim is still a static `set`,
// commitKeyframeProps converts it to keyframes first, then writes the new
// value as a keyframe at the current time — so the 3D animates instead of
// holding a flat constant. This MUST come before the `set`-update path below,
// or a 3D `set` would short-circuit to an in-place update and the playhead
// keyframe would never land (the bug: scrolling depth on a keyframed element
// just changed the constant instead of dropping a keyframe).
if (elementHasKeyframes && anim) {
// With auto-keyframe off (#1808), nudge the whole tween instead of
// adding/updating a keyframe at the playhead.
if (!usePlayerStore.getState().autoKeyframeEnabled) {
const pct = computeElementPercentage(
usePlayerStore.getState().currentTime,
selection,
anim,
);
await commitWholePropertyOffset(
selection,
anim,
Object.fromEntries(
propEntries.filter((e): e is [string, number] => typeof e[1] === "number"),
),
pct,
iframe,
{ commitMutation: gsapCommitMutation },
`Edit ${primaryProp} (whole animation)`,
);
return;
}
await commitKeyframeProps(
selection,
anim,
props,
propEntries,
primaryProp,
selector,
iframe,
gsapCommitMutation,
);
return;
}
// Existing static hold on a NON-animated element — merge the props into the
// same write (maybeAutoKeyframeSet no-ops when nothing else is keyframed).
if (anim && isInstantHold(anim)) {
await commitSetProps(
selection,
anim,
propEntries,
selector,
selectedGsapAnimations,
gsapCommitMutation,
);
return;
}
// Static element (no keyframes anywhere) — persist as a `tl.set`, never
// keyframes (incl. the no-animation case, which creates a fresh set).
if (!elementHasKeyframes) {
await commitStaticSet(
selection,
propEntries,
selector,
selectedGsapAnimations,
gsapCommitMutation,
);
return;
}
// Animated element but NO same-group tween exists (e.g. the FIRST rotation/3D
// keyframe on an element that only has a position tween). Create a fresh
// same-group keyframed tween WITH a 0% baseline at the playhead, instead of
// contaminating a foreign-group tween. Mirror an existing keyframed tween's
// time range so the new group animates over the same span. The 0% baseline is
// an `_auto` endpoint so it tracks the nearest keyframe as you add more.
if (selector) {
const template = selectedGsapAnimations.find((a) => !!a.keyframes);
const tStart = template ? (resolveTweenStart(template) ?? 0) : 0;
const tDur = template ? resolveTweenDuration(template) || 1 : 1;
const ct = usePlayerStore.getState().currentTime;
const pct =
tDur > 0
? Math.max(0, Math.min(100, Math.round(((ct - tStart) / tDur) * 1000) / 10))
: 0;
const newProps = Object.fromEntries(propEntries);
const keyframes =
pct <= 0.05
? [{ percentage: 0, properties: newProps }]
: [
{ percentage: 0, properties: { ...newProps, _auto: 1 } },
{ percentage: pct, properties: newProps },
];
await gsapCommitMutation(
selection,
{
type: "add-with-keyframes",
targetSelector: selector,
position: roundTo3(tStart),
duration: roundTo3(tDur),
keyframes,
},
{ label: `Add ${primaryProp} keyframe`, softReload: true },
);
return;
}
bumpGsapCache();
} catch {
bumpGsapCache();
}
},
[selectedGsapAnimations, gsapCommitMutation, previewIframeRef, bumpGsapCache],
);
const commitAnimatedProperty = useCallback(
(selection: DomEditSelection, property: string, value: number | string) =>
commitAnimatedProperties(selection, { [property]: value }),
[commitAnimatedProperties],
);
return { commitAnimatedProperty, commitAnimatedProperties };
}