mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 12:54:29 +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>
558 lines
20 KiB
TypeScript
558 lines
20 KiB
TypeScript
import type { MutableRefObject } from "react";
|
|
import type { Composition, GsapTweenSpec } from "@hyperframes/sdk";
|
|
import type { DomEditSelection } from "../components/editor/domEditing";
|
|
import type { EditHistoryKind } from "./editHistory";
|
|
import type { PatchOperation } from "./sourcePatcher";
|
|
import { STUDIO_SDK_CUTOVER_ENABLED } from "../components/editor/manualEditingAvailability";
|
|
import { trackStudioEvent } from "./studioTelemetry";
|
|
import { markSelfWrite } from "../hooks/sdkSelfWriteRegistry";
|
|
import { patchOpsToSdkEditOps } from "./sdkOpMapping";
|
|
import { recordResolverParity, recordAnimationResolverParity } from "./sdkResolverShadow";
|
|
import { shouldDeclineTextCutoverForTarget, shouldUseSdkCutover } from "./sdkCutoverEligibility";
|
|
|
|
export { shouldUseSdkCutover } from "./sdkCutoverEligibility";
|
|
|
|
export interface CutoverDeps {
|
|
editHistory: {
|
|
recordEdit: (entry: {
|
|
label: string;
|
|
kind: EditHistoryKind;
|
|
coalesceKey?: string;
|
|
coalesceMs?: number;
|
|
files: Record<string, { before: string; after: string }>;
|
|
}) => Promise<void>;
|
|
};
|
|
writeProjectFile: (path: string, content: string) => Promise<void>;
|
|
reloadPreview: () => void;
|
|
domEditSaveTimestampRef: MutableRefObject<number>;
|
|
/**
|
|
* Optional post-write refresh. When provided, it REPLACES the default
|
|
* reloadPreview() — the GSAP path passes one that soft-reloads (preserving
|
|
* the playhead) and invalidates the keyframe/gsap panel cache. Receives the
|
|
* serialized document just written.
|
|
*/
|
|
refresh?: (after: string) => void;
|
|
/**
|
|
* Path of the composition the SDK session was opened for. The session models
|
|
* ONLY this file (serialize() emits the whole active composition), so any edit
|
|
* whose targetPath differs (a sub-composition file) must take the server path
|
|
* — otherwise we'd write the full active-comp serialization into that file.
|
|
*/
|
|
compositionPath?: string | null;
|
|
/**
|
|
* Optional per-key task serializer (the same `gsap-file:${file}` serializer the
|
|
* legacy `commitMutation` uses). When provided, every GSAP-op persist routes its
|
|
* read-serialize → dispatch → serialize → write through it so two concurrent
|
|
* same-file flushes can't interleave their read-modify-write and lose an edit.
|
|
* Absent (e.g. in unit tests) → ops run unserialized as before.
|
|
*/
|
|
serialize?: <T>(key: string, task: () => Promise<T>) => Promise<T>;
|
|
/**
|
|
* Optional reader for the on-disk content of targetPath. Timing/GSAP persists
|
|
* use it to capture the EXACT prior bytes as the undo-history `before`, so undo
|
|
* restores the file verbatim instead of a normalized SDK re-emit (which would
|
|
* reformat the whole file). The style/delete paths already thread originalContent
|
|
* in explicitly; this gives timing/GSAP parity without touching every call site.
|
|
* Absent → falls back to the SDK's pre-edit serialize() (the prior behavior).
|
|
*/
|
|
readProjectFile?: (path: string) => Promise<string>;
|
|
}
|
|
|
|
/**
|
|
* Capture the undo-history `before` baseline for timing/GSAP persists: the exact
|
|
* on-disk bytes when a reader is available (so undo restores them verbatim),
|
|
* falling back to the SDK's pre-edit serialization when it isn't. Never throws —
|
|
* a failed read degrades to the serialized fallback rather than aborting the edit.
|
|
*/
|
|
async function captureOnDiskBefore(
|
|
deps: CutoverDeps,
|
|
targetPath: string,
|
|
serializedFallback: string,
|
|
): Promise<string> {
|
|
if (!deps.readProjectFile) return serializedFallback;
|
|
try {
|
|
return await deps.readProjectFile(targetPath);
|
|
} catch {
|
|
return serializedFallback;
|
|
}
|
|
}
|
|
|
|
/** True when targetPath isn't the composition the SDK session models. */
|
|
function wrongCompositionFile(deps: CutoverDeps, targetPath: string): boolean {
|
|
return deps.compositionPath != null && targetPath !== deps.compositionPath;
|
|
}
|
|
|
|
interface CutoverOptions {
|
|
label?: string;
|
|
coalesceKey?: string;
|
|
/** Coalesce window (ms); Infinity folds across a slow round-trip. */
|
|
coalesceMs?: number;
|
|
/** Skip the preview reload (mirrors the server path's skipRefresh). */
|
|
skipRefresh?: boolean;
|
|
}
|
|
|
|
// ponytail: exported for setSlideshowManifest (third caller — island write bypasses
|
|
// the SDK dispatch path since <script> nodes are not in the element tree).
|
|
// `after` is serialized once by the caller (which also did the no-op check
|
|
// against its pre-dispatch snapshot), so this never re-serializes.
|
|
export async function persistSdkSerialize(
|
|
after: string,
|
|
targetPath: string,
|
|
originalContent: string,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<void> {
|
|
deps.domEditSaveTimestampRef.current = Date.now();
|
|
// Tag this write with the exact content (by hash) so the file-change
|
|
// reload-suppression can recognize its own echo by IDENTITY, not just a 2 s
|
|
// clock — an undo write (different bytes, not registered here) then always
|
|
// reloads instead of being swallowed by the time window.
|
|
markSelfWrite(targetPath, after);
|
|
await deps.writeProjectFile(targetPath, after);
|
|
await deps.editHistory.recordEdit({
|
|
label: options?.label ?? "Edit layer",
|
|
kind: "manual",
|
|
...(options?.coalesceKey ? { coalesceKey: options.coalesceKey } : {}),
|
|
...(options?.coalesceMs != null ? { coalesceMs: options.coalesceMs } : {}),
|
|
files: { [targetPath]: { before: originalContent, after } },
|
|
});
|
|
if (deps.refresh) deps.refresh(after);
|
|
else if (!options?.skipRefresh) deps.reloadPreview();
|
|
}
|
|
|
|
export async function sdkCutoverPersist(
|
|
selection: DomEditSelection,
|
|
ops: PatchOperation[],
|
|
originalContent: string,
|
|
targetPath: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
if (!shouldUseSdkCutover(STUDIO_SDK_CUTOVER_ENABLED, !!sdkSession, selection.hfId, ops))
|
|
return false;
|
|
if (!sdkSession) return false;
|
|
const hfId = selection.hfId;
|
|
if (!hfId) return false;
|
|
const target = sdkSession.getElement(hfId);
|
|
if (!target) return false;
|
|
if (shouldDeclineTextCutoverForTarget(target, ops)) return false;
|
|
if (wrongCompositionFile(deps, targetPath)) return false;
|
|
try {
|
|
const before = sdkSession.serialize();
|
|
sdkSession.batch(() => {
|
|
for (const editOp of patchOpsToSdkEditOps(hfId, ops)) {
|
|
sdkSession.dispatch(editOp);
|
|
}
|
|
});
|
|
const after = sdkSession.serialize();
|
|
if (after === before) return false;
|
|
await persistSdkSerialize(after, targetPath, originalContent, deps, options);
|
|
trackStudioEvent("sdk_cutover_success", { hfId, opCount: ops.length });
|
|
return true;
|
|
} catch (err) {
|
|
trackStudioEvent("sdk_cutover_fallback", {
|
|
hfId: selection.hfId ?? null,
|
|
error: String(err),
|
|
});
|
|
return false;
|
|
}
|
|
}
|
|
|
|
export async function sdkTimingPersist(
|
|
hfId: string,
|
|
targetPath: string,
|
|
timingUpdate: { start?: number; duration?: number; trackIndex?: number },
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
// Resolver tripwire — runs BEFORE the cutover gate (decoupled): records when
|
|
// the SDK can't resolve a target the server timing path is addressing.
|
|
const timingSrc = deps.readProjectFile;
|
|
void recordResolverParity(
|
|
sdkSession,
|
|
hfId,
|
|
"setTiming",
|
|
timingSrc ? () => timingSrc(targetPath) : undefined,
|
|
);
|
|
// Dark-launch gate: without this, timing cutover runs whenever an SDK session
|
|
// exists (it always does, for shadow/selection) — flipping the flag OFF would
|
|
// NOT disable it. Gate here so flag-off routes back to the legacy server path.
|
|
if (!STUDIO_SDK_CUTOVER_ENABLED) return false;
|
|
if (!sdkSession || !sdkSession.getElement(hfId)) return false;
|
|
if (wrongCompositionFile(deps, targetPath)) return false;
|
|
try {
|
|
const serializedBefore = sdkSession.serialize();
|
|
sdkSession.batch(() => sdkSession.setTiming(hfId, timingUpdate));
|
|
const after = sdkSession.serialize();
|
|
if (after === serializedBefore) return false;
|
|
// Undo baseline = exact on-disk bytes (matching the style/delete paths), so
|
|
// undoing a timing edit restores the file verbatim instead of a normalized
|
|
// full-DOM re-emit. Falls back to serializedBefore when no reader is wired.
|
|
const undoBefore = await captureOnDiskBefore(deps, targetPath, serializedBefore);
|
|
await persistSdkSerialize(after, targetPath, undoBefore, deps, options);
|
|
trackStudioEvent("sdk_cutover_success", { hfId, opCount: 1 });
|
|
return true;
|
|
} catch (err) {
|
|
trackStudioEvent("sdk_cutover_fallback", { hfId, error: String(err) });
|
|
return false;
|
|
}
|
|
}
|
|
|
|
export async function sdkTimingBatchPersist(
|
|
changes: Array<{
|
|
hfId: string;
|
|
timingUpdate: { start?: number; duration?: number; trackIndex?: number };
|
|
}>,
|
|
targetPath: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
const timingSrc = deps.readProjectFile;
|
|
for (const change of changes) {
|
|
void recordResolverParity(
|
|
sdkSession,
|
|
change.hfId,
|
|
"setTiming",
|
|
timingSrc ? () => timingSrc(targetPath) : undefined,
|
|
);
|
|
}
|
|
if (!STUDIO_SDK_CUTOVER_ENABLED) return false;
|
|
if (!sdkSession || wrongCompositionFile(deps, targetPath)) return false;
|
|
if (changes.some((change) => !sdkSession.getElement(change.hfId))) return false;
|
|
try {
|
|
const serializedBefore = sdkSession.serialize();
|
|
sdkSession.batch(() => {
|
|
for (const change of changes) sdkSession.setTiming(change.hfId, change.timingUpdate);
|
|
});
|
|
const after = sdkSession.serialize();
|
|
if (after === serializedBefore) return false;
|
|
const undoBefore = await captureOnDiskBefore(deps, targetPath, serializedBefore);
|
|
await persistSdkSerialize(after, targetPath, undoBefore, deps, options);
|
|
trackStudioEvent("sdk_cutover_success", {
|
|
hfId: changes[0]?.hfId ?? null,
|
|
opCount: changes.length,
|
|
});
|
|
return true;
|
|
} catch (err) {
|
|
trackStudioEvent("sdk_cutover_fallback", {
|
|
hfId: changes[0]?.hfId ?? null,
|
|
error: String(err),
|
|
});
|
|
return false;
|
|
}
|
|
}
|
|
|
|
type SdkGsapTweenOp =
|
|
| { kind: "add"; target: string; spec: GsapTweenSpec }
|
|
| { kind: "set"; animationId: string; properties: Partial<GsapTweenSpec> }
|
|
| { kind: "remove"; animationId: string };
|
|
|
|
export function sdkGsapTweenPersist(
|
|
targetPath: string,
|
|
op: SdkGsapTweenOp,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
// Resolver tripwire — runs BEFORE this function's own cutover gate (decoupled).
|
|
// add targets an element (element-resolution parity); set/remove target an
|
|
// animationId (animation-resolution parity). Done here, not via
|
|
// dispatchGsapOpAndPersist's resolverTarget, because the gate below returns
|
|
// before that call when cutover is off.
|
|
if (op.kind === "add") {
|
|
const gsapSrc = deps.readProjectFile;
|
|
void recordResolverParity(
|
|
sdkSession,
|
|
op.target,
|
|
"addGsapTween",
|
|
gsapSrc ? () => gsapSrc(targetPath) : undefined,
|
|
);
|
|
} else {
|
|
recordAnimationResolverParity(
|
|
sdkSession,
|
|
op.animationId,
|
|
op.kind === "set" ? "setGsapTween" : "removeGsapTween",
|
|
);
|
|
}
|
|
// Leading dark-launch gate so flag-off does no SDK touch (getElement) at all —
|
|
// matches the other three chokepoints' discipline.
|
|
if (!STUDIO_SDK_CUTOVER_ENABLED) return Promise.resolve(false);
|
|
if (op.kind === "add" && sdkSession && !sdkSession.getElement(op.target))
|
|
return Promise.resolve(false);
|
|
// dispatchGsapOpAndPersist returns false on before===after — that catches stale
|
|
// animationIds and unsupported shapes (e.g. from-prop on a plain tween), falling
|
|
// back to the server path. This subsumes explicit existence guards for set/remove.
|
|
return dispatchGsapOpAndPersist(targetPath, sdkSession, deps, options, (s) => {
|
|
s.batch(() => {
|
|
if (op.kind === "add") {
|
|
s.addGsapTween(op.target, op.spec);
|
|
} else if (op.kind === "set") {
|
|
s.setGsapTween(op.animationId, op.properties);
|
|
} else {
|
|
s.removeGsapTween(op.animationId);
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
async function dispatchGsapOpAndPersist(
|
|
targetPath: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options: CutoverOptions | undefined,
|
|
dispatch: (s: Composition) => void,
|
|
resolverTarget?: { animationId: string; opLabel: string },
|
|
): Promise<boolean> {
|
|
// Resolver tripwire — runs BEFORE the cutover gate (decoupled): records when
|
|
// the SDK can't resolve the animationId the server GSAP path is addressing.
|
|
if (resolverTarget) {
|
|
recordAnimationResolverParity(sdkSession, resolverTarget.animationId, resolverTarget.opLabel);
|
|
}
|
|
// Dark-launch gate (shared chokepoint for every GSAP-op cutover persist):
|
|
// flag OFF → return false → caller falls back to the legacy server path.
|
|
if (!STUDIO_SDK_CUTOVER_ENABLED) return false;
|
|
if (!sdkSession) return false;
|
|
if (wrongCompositionFile(deps, targetPath)) return false;
|
|
const session = sdkSession;
|
|
// Route the whole read-serialize → dispatch → serialize → write through the
|
|
// per-file serializer (when provided) so overlapping same-file flushes can't
|
|
// interleave their read-modify-write and drop an edit, matching the legacy
|
|
// commitMutation path's `gsap-file:${file}` serialization.
|
|
const run = async (): Promise<boolean> => {
|
|
try {
|
|
const serializedBefore = session.serialize();
|
|
dispatch(session);
|
|
const after = session.serialize();
|
|
if (after === serializedBefore) return false;
|
|
// Undo baseline = exact on-disk bytes (matching the style/delete paths), so
|
|
// undoing a GSAP edit restores the file verbatim instead of a normalized
|
|
// full-DOM re-emit. Falls back to serializedBefore when no reader is wired.
|
|
const undoBefore = await captureOnDiskBefore(deps, targetPath, serializedBefore);
|
|
await persistSdkSerialize(after, targetPath, undoBefore, deps, options);
|
|
trackStudioEvent("sdk_cutover_success", { opCount: 1 });
|
|
return true;
|
|
} catch (err) {
|
|
trackStudioEvent("sdk_cutover_fallback", { error: String(err) });
|
|
return false;
|
|
}
|
|
};
|
|
return deps.serialize ? deps.serialize(`gsap-file:${targetPath}`, run) : run();
|
|
}
|
|
|
|
export function sdkGsapKeyframePersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
position: number,
|
|
value: Record<string, unknown>,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => s.batch(() => s.dispatch({ type: "addGsapKeyframe", animationId, position, value })),
|
|
{ animationId, opLabel: "addGsapKeyframe" },
|
|
);
|
|
}
|
|
|
|
export function sdkGsapRemoveKeyframePersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
percentage: number,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => s.dispatch({ type: "removeGsapKeyframe", animationId, percentage }),
|
|
{ animationId, opLabel: "removeGsapKeyframe" },
|
|
);
|
|
}
|
|
|
|
export function sdkGsapRemovePropertyPersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
property: string,
|
|
from: boolean,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => s.dispatch({ type: "removeGsapProperty", animationId, property, from }),
|
|
{ animationId, opLabel: "removeGsapProperty" },
|
|
);
|
|
}
|
|
|
|
export function sdkGsapDeleteAllForSelectorPersist(
|
|
targetPath: string,
|
|
selector: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(targetPath, sdkSession, deps, options, (s) =>
|
|
s.dispatch({ type: "deleteAllForSelector", selector }),
|
|
);
|
|
}
|
|
|
|
export function sdkGsapRemoveAllKeyframesPersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => s.dispatch({ type: "removeAllKeyframes", animationId }),
|
|
{ animationId, opLabel: "removeAllKeyframes" },
|
|
);
|
|
}
|
|
|
|
export function sdkGsapConvertToKeyframesPersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
resolvedFromValues: Record<string, number | string> | undefined,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => s.dispatch({ type: "convertToKeyframes", animationId, resolvedFromValues }),
|
|
{ animationId, opLabel: "convertToKeyframes" },
|
|
);
|
|
}
|
|
|
|
type KeyframeSpec = {
|
|
percentage: number;
|
|
properties: Record<string, number | string>;
|
|
ease?: string;
|
|
auto?: boolean;
|
|
};
|
|
|
|
type KeyframesPayload = {
|
|
targetSelector: string;
|
|
position: number;
|
|
duration: number;
|
|
keyframes: KeyframeSpec[];
|
|
ease?: string;
|
|
};
|
|
|
|
/** Shared inner dispatch for addWithKeyframes / replaceWithKeyframes ops. */
|
|
function dispatchWithKeyframes(
|
|
s: Composition,
|
|
payload: KeyframesPayload,
|
|
animationId?: string,
|
|
): void {
|
|
if (animationId !== undefined) {
|
|
s.dispatch({ type: "replaceWithKeyframes", animationId, ...payload });
|
|
} else {
|
|
s.dispatch({ type: "addWithKeyframes", ...payload });
|
|
}
|
|
}
|
|
|
|
export function sdkAddWithKeyframesPersist(
|
|
targetPath: string,
|
|
targetSelector: string,
|
|
position: number,
|
|
duration: number,
|
|
keyframes: KeyframeSpec[],
|
|
ease: string | undefined,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
const payload: KeyframesPayload = {
|
|
targetSelector,
|
|
position,
|
|
duration,
|
|
keyframes,
|
|
...(ease ? { ease } : {}),
|
|
};
|
|
return dispatchGsapOpAndPersist(targetPath, sdkSession, deps, options, (s) =>
|
|
dispatchWithKeyframes(s, payload),
|
|
);
|
|
}
|
|
|
|
export function sdkReplaceWithKeyframesPersist(
|
|
targetPath: string,
|
|
animationId: string,
|
|
targetSelector: string,
|
|
position: number,
|
|
duration: number,
|
|
keyframes: KeyframeSpec[],
|
|
ease: string | undefined,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
options?: CutoverOptions,
|
|
): Promise<boolean> {
|
|
const payload: KeyframesPayload = {
|
|
targetSelector,
|
|
position,
|
|
duration,
|
|
keyframes,
|
|
...(ease ? { ease } : {}),
|
|
};
|
|
return dispatchGsapOpAndPersist(
|
|
targetPath,
|
|
sdkSession,
|
|
deps,
|
|
options,
|
|
(s) => dispatchWithKeyframes(s, payload, animationId),
|
|
{ animationId, opLabel: "replaceWithKeyframes" },
|
|
);
|
|
}
|
|
|
|
export async function sdkDeletePersist(
|
|
hfId: string,
|
|
originalContent: string,
|
|
targetPath: string,
|
|
sdkSession: Composition | null | undefined,
|
|
deps: CutoverDeps,
|
|
): Promise<boolean> {
|
|
// Resolver tripwire — runs BEFORE the cutover gate (decoupled).
|
|
void recordResolverParity(sdkSession, hfId, "removeElement", () =>
|
|
Promise.resolve(originalContent),
|
|
);
|
|
// Dark-launch gate: flag OFF → legacy server delete path.
|
|
if (!STUDIO_SDK_CUTOVER_ENABLED) return false;
|
|
if (!sdkSession || !sdkSession.getElement(hfId)) return false;
|
|
if (wrongCompositionFile(deps, targetPath)) return false;
|
|
try {
|
|
const before = sdkSession.serialize();
|
|
sdkSession.batch(() => sdkSession.removeElement(hfId));
|
|
const after = sdkSession.serialize();
|
|
if (after === before) return false;
|
|
await persistSdkSerialize(after, targetPath, originalContent, deps, {
|
|
label: "Delete element",
|
|
});
|
|
trackStudioEvent("sdk_cutover_success", { hfId, opCount: 1 });
|
|
return true;
|
|
} catch (err) {
|
|
trackStudioEvent("sdk_cutover_fallback", { hfId, error: String(err) });
|
|
return false;
|
|
}
|
|
}
|