Files
hyperframes/packages/core
James RussoandClaude Opus 5.5 e1ddb2e162 feat(core): runtime element handles for the editing channel (#7603)
* feat(core): runtime element handles for the editing channel

The runtime gives each element a numeric handle for one page load and
answers two new editing-port requests: `elements-at-point` (the stack under
a viewport point) and `describe` (handles to plain-data descriptions). Each
description carries the element's stable selector, the source facts Studio
resolves to a file, earlier class-selector matches counted per source,
attributes, inline styles, text, child handles and its client rect.

The stable-selector rule and source-attribute read move to core so Studio
and the runtime address elements one way; Studio re-exports them and
resolves a description's source file and selector index with its own map.

Studio adds `PreviewElement` (a checked description) and client helpers.
Every channel read now gives up after the agent probe when the frame's
runtime has no editing agent, as the seek wait already did. `computed-styles`
accepts custom property names with any case or `_`.

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

* fix(core): per-load element handles and a light elements-at-point reply

Handles are now "<load>:<n>" strings, where the load id is random per page
load, so a handle from an earlier load reads as null like a removed
element. `describe` checks the exact format.

`elements-at-point` returns only {handle, tag, rect}; callers describe the
one they keep. Descriptions cap each attribute and inline-style value, keep
only a `data:` value's header, leave <script> and <style> text out, and say
when anything was cut. A handle's entry goes once its element is collected
or found disconnected.

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

* fix(core): draw the element-handle load id on first use

A render seeds crypto.getRandomValues from virtual time, so drawing the
load id when the runtime loads shifted every random value the composition
drew after it, and the random-stagger-workers render no longer matched its
baseline. The id is now drawn the first time a handle is made, which a
render never does.

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

* fix(core): keep a parked element's handle, and cut data: headers only from values

A scene the preview parks and puts back keeps its element handles: an entry
now goes only once its element is garbage-collected. Text that starts with
"data:" is no longer cut to a header; that rule applies to attribute and
inline-style values.

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

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 14:13:18 +00:00
..
2026-11-12 13:27:37 +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