Files
hyperframes/packages/core
Michael Wang 3f3fa67f9c fix(producer): charge generated mount scripts and scoped styles to the budget (#8094)
* fix(producer): charge generated mount scripts and scoped styles to the expansion budget

The expansion budget charged only the source bytes of each mounted file.
The inliner wraps every inline script in kilobytes of scoping code and
prefixes every style rule with the host's scope, so tiny scripts or a long
composition id over many rules assembled a page hundreds of times larger
than its source.

The inliner now reports what it generates through a chargeEmitted option.
Each wrapped script is charged once built. Each style rule reserves an upper
bound before it is scoped and settles to its real size after, so no rule is
built past the limit. Generated output has its own 32 MB allowance.

* fix(core): reserve the separator postcss re-joins scoped selectors with

The per-rule reservation summed a bound per selector but left out the
separator. postcss's selectors setter re-joins the list with the first
separator in the authored selector, so a wide first separator over many
selectors grew the rule past its reservation before it was charged.

* test(core): give the scoper bound test the same time limit as its neighbour
2026-11-17 22:53:11 +00:00
..
2026-11-17 18:25:31 +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