Files
hyperframes/packages/core
WaterrrForeverandClaude Opus 5.5 cd7b7383cb fix(lint): flag a data-automation or data-fx-chain the render cannot read (#7169)
* fix(lint): flag a data-automation or data-fx-chain the render cannot read

A cue whose automation lane has no "version": 1 passed `hyperframes check`
and only failed at render: locally with "Unsupported automation version:
undefined", in the cloud with no cause at all. The new error
`audio_attribute_unreadable` reads each data-automation and data-fx-chain
envelope (JSON object, version 1, a lanes or nodes array, a target and
points per lane, a type per node) and names the element.

Lint cannot import the renderer's parsers from @hyperframes/core, which
depends on it, so core gains a parity test that fails if the two disagree
on any envelope case.

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

* fix(lint): an empty data-automation or data-fx-chain is ignored, as the mixer does

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

* chore(lint): split the audio attribute shape check and raise the CLI size budget

audioAttributeShapeError splits its envelope and per-entry checks to stay under
the cognitive-complexity gate, and media.ts drops the added rule label comment.
The CLI's unpacked size was already 0.99% over its budget on main (23,958,7xx of
23,722,874); this rule adds about 2.4 KB of bundled code, which crosses the 1%
tolerance. The budget moves to 5% above the measured 23,961,054, as the budget
file's own headroom rule sets it.

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

* style(lint): format the split audio attribute checks

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

* chore(ci): raise the lint package's unpacked size budget for the audio attribute rule

The rule and its envelope checks take @hyperframes/lint's unpacked size to 702,230,
just over 1% past its 695,173 budget. The budget moves to 5% above the measured size,
as the budget file's headroom rule sets it.

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

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 16:59:04 +00:00
..
2026-11-04 12:23:12 +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