Files
hyperframes/packages/core
James RussoandClaude Opus 5.5 ef5cdeb0a0 feat(core): give the preview parent a typed editing port to prepare for an opaque frame (#7556)
* feat(core): give the preview parent a typed editing port to prepare for an opaque frame

Studio reads the preview frame's window and document directly, which stops
working once the preview runs in an opaque origin. This adds the runtime half
of the replacement, with no Studio consumer changed yet:

- runtime/editingPort.ts: a versioned request/reply protocol, a validator
  that turns any bad request into a typed error, and a promise-based parent
  client with request ids, timeouts and dispose. Exported as
  @hyperframes/core/runtime/editing-port.
- runtime/editingAgent.ts: on the parent's connect, the runtime hands
  window.parent a MessagePort once and answers hello, runtime-snapshot,
  wait-for-seek and set-loop-start on it. A connect from anything but the
  parent is ignored and does not use up the handoff.

Playback transport stays on the existing control protocol.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(core): type the handed-off port under the runtime's strict index checks

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(core): emit the editing-port module so the published subpath resolves

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore(producer): raise the packed size budget for the runtime's editing agent

The producer ships the preview runtime, which now carries the editing agent
and its request validator. The packed tarball measured 878,763 bytes in CI
against an 870,000 budget.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 16:54:46 +00:00
..

@hyperframes/core

Types, parsers, generators, compiler, linter, runtime, and frame adapters for the Hyperframes video framework.

Install

npm install @hyperframes/core

Most users don't need to install core directly — the CLI, producer, and studio packages depend on it internally.

What's inside

Module Description
Types TimelineElement, CompositionSpec, Asset, canvas dimensions, defaults
Parsers parseHtml — extract timeline elements from HTML; parseGsapScript — parse GSAP animations
Generators generateHyperframesHtml — produce valid Hyperframes HTML from a composition spec
Compiler compileTimingAttrs — resolve data-start / data-duration into absolute times
Linter lintHyperframeHtml — validate Hyperframes HTML (missing attributes, overlapping tracks, etc.)
Runtime IIFE script injected into the browser — manages seek, media playback, and the window.__hf protocol
Frame Adapters Pluggable animation drivers (GSAP, Lottie, CSS, or custom)

Generated composition trust

Composition generators require trusted authors for code-bearing inputs. styles and generateHyperframesStyles preserve authored CSS, which can load external resources. animations may contain __raw: values that are emitted as JavaScript; includeScripts: true includes executable timeline code. serializeGsapAnimations also accepts raw preamble, postamble, and a code-bearing timelineVar. Never fill these inputs with untrusted data. Attribute encoding and closing-tag containment are not a sandbox; render untrusted compositions in an appropriately isolated execution environment and never serve them on a privileged origin.

Text content retains the supported inline-formatting sanitizer contract. The clip parser intentionally flattens inner formatting to text, so parse/generate is not a lossless replacement for editing the source HTML.

Frame Adapters

A frame adapter tells the engine how to seek your animation to a specific frame:

import { createGSAPFrameAdapter } from "@hyperframes/core";

const adapter = createGSAPFrameAdapter({
  getTimeline: () => gsap.timeline(),
  compositionId: "my-video",
});

Implement FrameAdapter for custom animation runtimes:

import type { FrameAdapter } from "@hyperframes/core";

const myAdapter: FrameAdapter = {
  id: "my-adapter",
  getDurationFrames: () => 300,
  seekFrame: (frame) => {
    /* seek your animation */
  },
};

Parsing and generating HTML

import { parseHtml, generateHyperframesHtml } from "@hyperframes/core";

const { elements, metadata } = parseHtml(htmlString);
const html = generateHyperframesHtml(spec);

Linting

import { lintHyperframeHtml } from "@hyperframes/core/lint";

const result = lintHyperframeHtml(htmlString);
// result.findings: { severity, message, elementId }[]

Documentation

Full documentation: hyperframes.heygen.com/packages/core