mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 10:14:30 +00:00
## What PR 5/17 of the catalog system rollout. Adds the `hyperframes add` verb for installing blocks and components from the registry into an existing project, plus the `hyperframes.json` project config that tells `add` which registry to use and where to drop files. Stacks on #255. - **`packages/cli/src/commands/add.ts`** — new `hyperframes add <name>` command. Resolves an item, validates target paths, installs files in parallel, builds an include snippet, copies it to the clipboard. Exposes a testable `runAdd(opts)` function; the citty default wraps it with console output + exit handling - **`packages/cli/src/utils/projectConfig.ts`** — read/write/normalize `hyperframes.json`. Tolerant to missing and partial configs - **`packages/cli/src/utils/clipboard.ts`** — minimal cross-platform clipboard (pbcopy / clip.exe / wl-copy / xclip / xsel). Zero deps. Gracefully no-ops in headless environments - **`packages/cli/src/commands/init.ts`** — write `hyperframes.json` during scaffold if not already present - **`packages/cli/src/cli.ts`** + **`help.ts`** — register `add` under Getting Started (directly below `init`) Design doc: [Hyperframes Catalog System](https://www.notion.so/heygen/Hyperframes-Catalog-System-Design-Plan-341449792c69813f899dcd53b4c0383a). ## UX ```bash # Scaffold a project (now writes hyperframes.json too) npx hyperframes init my-video --example blank cd my-video # Add a block — files land, snippet copied to clipboard npx hyperframes add claude-code-window # ✓ Added claude-code-window (hyperframes:block) # compositions/claude-code-window.html # # Include snippet: # <iframe src="compositions/claude-code-window.html" data-start="0" data-duration="6"></iframe> # # Copied to clipboard — paste into your host composition. # Add a component effect npx hyperframes add shader-wipe # Headless / CI — no clipboard, JSON output for tooling npx hyperframes add shader-wipe --no-clipboard --json ``` Running `hyperframes add warm-grain` (an example) errors clearly pointing to `init --example`. ## Docs (bundled in this PR per the tracker principle) - `docs/packages/cli.mdx` — new `add` subsection under Commands (flags, examples, trigger rules) + new `hyperframes.json` section describing the config file shape ## Tests - **`packages/cli/src/commands/add.test.ts`** — 11 tests: - `remapTarget` / `buildSnippet` pure helpers (5 tests) - `runAdd` integration against a mocked `fetch` registry: block install lands files + returns snippet, component install respects `paths.components` remap, example-typed names throw `AddError` with code `example-type`, unknown names throw `AddError` with code `unknown-item` (4 tests plus 2 covering block default path and non-default path preservation) - **`packages/cli/src/utils/projectConfig.test.ts`** — 9 tests: - Write/read round-trip, partial-config normalization, corrupt-file handling, absent-file fallback to defaults, custom paths preserved - **CLI suite:** 92 passed (was 72 on #255, **+20**). Same 4 pre-existing failures unchanged ## Scope decisions - **`init.ts` full port to new resolver deferred.** The original plan bundled a removal of the `packages/cli/src/templates/` compat shim. That's ~300 more lines and isn't required for `add` to work. The compat shim from #254 still functions; a separate cleanup PR handles it - **No ajv runtime schema validation.** Manifests are trusted as schema-valid. Full validation lands when third-party registries arrive (PR 14/15). Path safety is still enforced by the installer's `assertSafeTarget` guard - **Default project paths stay under `compositions/`.** Blocks → `compositions/<name>.html`; components → `compositions/components/<name>/<file>`. Users override via `hyperframes.json#paths` ## Breaking / migration **None.** Pure additive — new command, new file types, no existing commands or flags change. `init.ts` now writes `hyperframes.json` but that's a new additional file, not a modification of existing output. ## Stacks on #255 — base branch. When #255 merges, this rebases onto `main`. ## Next in stack PR 6 — `feat(registry): seed block — claude-code-window`. First real registry item. Exercises the full `hyperframes add <name>` flow end-to-end against a committed item on `main`. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
53 lines
1.9 KiB
TypeScript
53 lines
1.9 KiB
TypeScript
// Compat shim — fetchRemoteTemplate delegates to the registry resolver +
|
|
// installer (packages/cli/src/registry/). Kept so init.ts and external imports
|
|
// that reference this path keep working. Deletable once init.ts is fully
|
|
// ported to call the resolver directly.
|
|
|
|
import { existsSync } from "node:fs";
|
|
import { join } from "node:path";
|
|
import { installItem, listRegistryItems, loadAllItems, resolveItem } from "../registry/index.js";
|
|
|
|
// Re-exported for the existing remote.test.ts regression guard. These paths
|
|
// describe the repo layout under the default registry URL; updating them in
|
|
// sync with any future move prevents silent breakage of installed CLIs.
|
|
export const TEMPLATES_DIR = "registry/examples";
|
|
export const MANIFEST_FILENAME = "templates.json";
|
|
|
|
export interface RemoteTemplateInfo {
|
|
id: string;
|
|
label: string;
|
|
hint: string;
|
|
bundled: boolean;
|
|
}
|
|
|
|
/**
|
|
* List available remote templates — kept for backwards compat with external
|
|
* imports. Internally, `resolveTemplateList` in generators.ts is what init.ts
|
|
* uses, and it goes through the registry resolver directly.
|
|
*/
|
|
export async function listRemoteTemplates(): Promise<RemoteTemplateInfo[]> {
|
|
const entries = await listRegistryItems({ type: "hyperframes:example" });
|
|
const items = await loadAllItems(entries);
|
|
return items.map((item) => ({
|
|
id: item.name,
|
|
label: item.title,
|
|
hint: item.description,
|
|
bundled: false,
|
|
}));
|
|
}
|
|
|
|
/**
|
|
* Download a template into destDir. Delegates to the registry installer.
|
|
*/
|
|
export async function fetchRemoteTemplate(templateId: string, destDir: string): Promise<void> {
|
|
const item = await resolveItem(templateId);
|
|
await installItem(item, { destDir });
|
|
|
|
// Safety check — an item with no index.html isn't a valid example.
|
|
if (!existsSync(join(destDir, "index.html"))) {
|
|
throw new Error(
|
|
`Example "${templateId}" installed but missing index.html. The registry item may be malformed.`,
|
|
);
|
|
}
|
|
}
|