Files
hyperframes/packages/core
Vance Ingalls 96ee2b1437 fix(core): keep linter rules aligned with parser for void elements and object-target tweens
`video_nested_in_timed_element` previously kept HTML5 void elements (e.g.
<img>, <br>) on its parent stack forever — they have no closing tag — so
any later <video data-start> was reported as nested inside the most recent
<img>. Skip void elements explicitly.

`overlapping_gsap_tweens` walked GSAP `.to/.from/.fromTo/.set/.add` regex
matches and indexed into `parsed.animations` from `parseGsapScript`. The
parser silently drops calls whose first argument is not a quoted selector
(object-target tweens like `tl.to({ _: 0 }, …)` used to anchor a timeline's
duration), but the regex still matched them — drifting the index by one
and making subsequent windows pick up the wrong selector and position.
Skip matches with non-quoted first arguments so both passes agree.

Both regressions surfaced while linting an HDR showcase composition that
mixes timed <img> HDR layers with <video> HDR layers and uses a phantom
duration tween in its GSAP timeline.

Made-with: Cursor
2026-04-20 00:38:37 -07:00
..
2026-04-19 23:35:35 +00:00
2026-03-21 22:43:56 -07:00
2026-03-21 22:43:56 -07: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)

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