Files
hyperframes/packages/core
Vance IngallsandClaude Sonnet 5.5 0865b6f36d feat(core,engine): track accelerated canvases before any page script runs (#5970)
html-in-canvas captures a WebGL or WebGPU canvas frozen or black, so the
runtime turns blur off when the composition draws one. Two cases slipped
past the tracker that spots them: a canvas handed to
transferControlToOffscreen (its context is created out of reach) and a
context made by an author script that runs before the runtime.

- The tracker is a self-contained function that also wraps
  transferControlToOffscreen (a transferred canvas counts as accelerated)
  and keeps its registry on window so independent installs agree.
- The engine evaluates it on every new document, ahead of any page script.
- insertRuntimeTag (bundler and Studio preview) puts it at the very start of
  <head> for pages that opt into blur; the runtime install is idempotent
  with it.
- report() carries failedFrames, the cumulative count of frames that
  rendered plain DOM because their capture failed or timed out.
  failures keeps its streak meaning.

Core's unpacked size budget rises from 3903211 to 3930000 bytes: the runtime
lifecycle, the compositor and the tracker together pass the old ceiling.

Folded review fixes: R6, R17 (the report counter; the engine log line lands
with the runtime's reason codes).

Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-21 14:19:13 -07:00
..
2026-10-21 19:19:45 +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