* fix(docs): escape catalog preview values and the install command's --vars argument The catalog preview embeds variable values as JSON that cannot close a script element or attribute, accepts value messages only from the page that embeds it, and reads only declared ids with primitive values from the link. The install command shell-quotes its --vars JSON and keeps only variable-id keys with primitive values. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(core): fold CSS line endings before decoding escapes in the SVG sanitizer A browser folds CR LF, CR and form feed into one newline before it reads CSS escapes, so the whitespace after a hex escape can be a CR LF pair. The sanitizer now does the same, so an escaped function name split by a line ending is checked under its real name. The media-use bundle is regenerated from the source. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(lint): match template ids and CSS rules in linear time A getElementById template literal is matched against document ids with an in-order indexOf scan instead of a regex of joined wildcards, so the time no longer grows with the number of placeholders. The CSS rule scanners only start a match at the beginning of a brace-free run, which finds the same rules without rescanning long brace-less text. Lint results on every HTML file in the repository are unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(parsers): keep GSAP writer output inside its script element String literals and quoted keys the GSAP writers emit now encode a script closer or comment opener as \u003c, so a value can no longer end the inline script that holds the timeline. Strings without those sequences are written exactly as before. The writers also refuse a tween method outside set, to, from and fromTo, and a motion path whose coordinates or curviness are not numbers, since both are emitted as code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(scripts): confine registry asset hosting to files inside the item The asset hosting script now refuses a manifest path that leaves the item directory or reaches its file through a symlink, before anything is read, staged, uploaded or removed. A repository test fails when the registry tracks a symlink or a manifest path that leaves its item. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(registry): pin the map blocks' d3 and atlas files to exact versions The five map blocks load d3 7.9.2, the build the d3@7 range serves today, with a subresource integrity hash, and fetch us-atlas 3.0.1 and world-atlas 2.0.2, the files their ranges serve today. The bytes are unchanged, so the blocks render the same. A repository test fails when a registry item names an npm CDN package by range, tag or no version. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(registry): pin map blocks to d3 7.9.0 7.9.0 has been the stable release since 2024; 7.9.1 and 7.9.2 were published days ago. Pin the long-standing version, with its subresource integrity hash. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(registry): keep the map block PR source-only and formatted Restore the generated catalog pages and payloads, which the catalog publish job regenerates from the item sources. Name the us-atlas URL in us-map-flow so the call fits on one line and formatting is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(scripts): check registry asset containment with one prefix test Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(lint): scan simple CSS rules in linear time The two CSS-rule scans in the gsap rules took a body that could cross '{', so a closed style of many '{' with no '}' rescanned to its end from every brace. A scanner now returns the same selector and body pairs and remembers the next '}', so each scan is linear. Findings are identical on every tracked HTML file. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(core): label the form-feed sanitizer case as a guard Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@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
Related packages
@hyperframes/engine— rendering engine that drives the browser@hyperframes/producer— full render pipeline (capture + encode)hyperframes— CLI