ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-12 15:20:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(sdk): resolve composition-id targets + emit canonical data-hf-id for GSAP tweens (#1526)

Browse Source 
A sub-composition ROOT is addressed by its data-composition-id, but the SDK's
whole element<->tween attribution is data-hf-id based, so the prior fix's
[data-composition-id] selector was invisible to three readers (validateOp/can,
selectorMatchesId -> setTiming + removeElement cascade, buildAnimationIdMap ->
getElement.animationIds), diverging can from apply and orphaning tweens.

Root fix: make composition ids first-class resolvable addresses and emit the
canonical selector everywhere.

- resolveScoped (model.ts): for a bare id with no data-hf-id match, fall back to
  [data-composition-id]. data-hf-id keeps precedence; scoped-path and canonical
  behavior intact. Fixes validateOp gating, findById/getElement, and every op
  handler for comp-root targets in one place.
- gsapTargetSelector (mutate.ts): resolve the target and emit
  [data-hf-id="<resolved host hf-id>"] (canonical). Normal targets unchanged;
  comp-root targets resolve via comp-id -> host -> host hf-id. Defensive
  [data-composition-id] only when the resolved element has no hf-id.
- setTiming syncs the GSAP tween via the resolved element's data-hf-id so a
  comp-root target matches its host tween; removeElement cascade already covers
  the host hf-id via collectSubtreeHfIds.
- export escapeHfId; escape both the querySelector probe and the emitted
  selector string.

Tests: comp-id resolveScoped fallback + precedence (session.subcomp), canonical
selector, validateOp accept, setTiming sync, removeElement cascade, and
getElement.animationIds for comp-root tweens (mutate.gsap). The prior test only
called applyOp, masking all of this.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Vance Ingalls
2026-06-16 23:08:08 -07:00
committed by GitHub
co-authored by Claude Opus 4.8
parent 9cc3550f7e
commit 6e32142334
4 changed files with 180 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/sdk/src/session.subcomp.test.ts
+56
View File
@@ -50,6 +50,35 @@ describe("resolveScoped — flat id", () => {
expect(resolveScoped(doc as unknown as Document, "hf-xxxx")).toBeNull();
});
// A sub-composition ROOT is addressed by its composition id. When no element
// carries that as a data-hf-id, fall back to [data-composition-id]: comp-ids
// become first-class resolvable addresses (fixes validate / getElement).
it("resolves a bare id to a sub-comp root via data-composition-id fallback", () => {
const doc = makeDoc(
`<!DOCTYPE html><html><body><div data-hf-id="hf-host" data-composition-id="sub-1"></div></body></html>`,
) as unknown as Document;
const viaComp = resolveScoped(doc, "sub-1");
const viaHf = resolveScoped(doc, "hf-host");
expect(viaComp).not.toBeNull();
expect(viaComp?.getAttribute("data-hf-id")).toBe("hf-host");
// Both addresses resolve to the SAME host element.
expect(viaComp).toBe(viaHf);
});
// data-hf-id MUST take precedence: a bare id that matches a real data-hf-id
// never falls back to data-composition-id, even if some other element carries
// that string as its composition id.
it("data-hf-id takes precedence over data-composition-id for a bare id", () => {
const doc = makeDoc(
`<!DOCTYPE html><html><body>
<div data-hf-id="dup" class="byHfId"></div>
<div data-hf-id="hf-host" data-composition-id="dup" class="byCompId"></div>
</body></html>`,
) as unknown as Document;
const el = resolveScoped(doc, "dup");
expect(el?.getAttribute("class")).toBe("byHfId");
});
// Regression: findById is the patch-replay/undo resolver. It must agree with
// resolveScoped (forward dispatch) on an ambiguous bare id — both pick the
// canonical (top-level) instance — or undo reverts the wrong duplicate.
@@ -305,6 +334,33 @@ describe("dispatch — scoped target", () => {
});
});
// ─── 3b. Comp-root GSAP tween attribution ─────────────────────────────────────
describe("sub-comp root GSAP tween — canonical hf-id attribution", () => {
it("getElement(host).animationIds includes a tween added by comp-id target", async () => {
const html = inlinedHtml(`
<div data-hf-id="hf-root" data-hf-root>
<div data-hf-id="hf-host" data-composition-id="sub-1" data-composition-file="sub.html">
<p data-hf-id="hf-leaf">text</p>
</div>
<script>var tl = gsap.timeline({ paused: true });
window.__timelines = { t: tl };</script>
</div>
`);
const comp = await openComposition(html);
// Target the sub-comp ROOT by its composition id.
const animId = comp.addGsapTween("sub-1", {
method: "to",
duration: 0.3,
properties: { x: 200 },
});
// The tween is filed under the host's own data-hf-id (canonical form), so
// it surfaces on the host element snapshot.
const host = comp.getElement("hf-host");
expect(host?.animationIds).toContain(animId);
});
});
// ─── 4. Override-set keys for scoped ids ──────────────────────────────────────
describe("override-set — scoped id keys", () => {