mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 22:58:02 +00:00
`copy.mts` lived in `plans/` and was read by one build script. Moving it to `packages/core/src/audioFxCopy.ts` puts it beside the registry it describes, and turns the coverage into `audioFxCopy.test.ts` — every shipped effect, every one of its parameters, and every preset has to have copy. That check existed before as a step in `build-preview.mts`, which means it only fired when somebody remembered to rebuild the review page. Now it fires on the commit that adds an effect without a plain name for it, which is the only moment it can still be cheap to fix. Four more assertions the build step never made, each of which was a real hole: copy for an effect the registry no longer ships (dead text that reads as coverage), a `SUMMARY` missing for an effect that has one everywhere else, a summary that renders `undefined` or `NaN` at the effect's own defaults — which is the first thing an author reads after adding one — and a gap or overlap in the shared frequency ruler, which would be a band the rack can name in one module and not in another. `PROFILES` deliberately did NOT come along. Its figures are proposed, not measured, nothing derives from them yet, and they want the same before/after listen the clip-before-duck fix got before a knob is wired to them. So it stays in `plans/audio-fx-ux/copy.mts`, which is now all that file holds, and `build-preview.mts` imports the shipped four from core and that one from beside itself. Landing the data is not wiring it: nothing in the studio reads this yet, and it should not until the three open UX questions are settled — whether the plain name replaces the DSP name or sits beside it decides what the rack renders. The README says so where the status used to say the layer had not landed. Falsified: deleting one parameter's entry fails the highpass case. core 1745 passing (111 files), studio unchanged at 3674 / 18 todo.
@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
Related packages
@hyperframes/engine— rendering engine that drives the browser@hyperframes/producer— full render pipeline (capture + encode)hyperframes— CLI