Files
hyperframes/packages/core
Miguel Angel Simon Sierra 0634d6780a fix(core): preserve root box styling on flattened sub-composition wrappers
Compositions that style their own box via the bare `[data-composition-id="X"]`
selector (e.g. `display: flex` to center their children) rely on that rule
landing on whatever element actually parents their content. Once
flattenInnerRoot preserves the authored root as a wrapper below the host
(data-hf-inner-root), the bare root selector was only ever rewritten onto the
host, one level too high, so the composition's own children lost their flex
or grid layout context entirely.

Rewrite a bare root composition-id selector to a compound-OR targeting both
the host and its data-hf-inner-root descendant, so the box styling reaches
whichever element actually holds the composition's content. Selectors with a
descendant part (e.g. `[data-composition-id="X"] .title`) are unaffected,
since a plain descendant combinator already matches at any depth.
2026-07-01 20:40:32 -07:00
..
2026-07-01 14:57:39 -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