feat(cli): hyperframes lambda render --variables / --variables-file / --strict-variables

Mirror the local hyperframes render variables UX on the Lambda CLI:

- --variables '<json>'       inline JSON object of variable values
- --variables-file <path>    path to a JSON file with variable values
- --strict-variables          fail on type/declared-mismatch (warn by default)

Resolution + validation logic is hoisted to packages/cli/src/utils/variables.ts
so both surfaces share one parser. The new reportVariableIssues helper formats
the warning block + handles --strict-variables exit, deduping the per-CLI
issue-handling block.

Variables flow into SerializableDistributedRenderConfig.variables and reach
every chunk worker via the path PR 9.1 + 9.2 wired up (plan() →
meta/encoder.json → renderChunk() → window.__hfVariables). Pre-validation
against the composition's data-composition-variables declaration runs only
when the project's index.html is on disk — --site-id pointing at a
pre-uploaded site that was packaged elsewhere skips the check, matching how
the local CLI treats unreadable index files.

The render.ts re-exports of parseVariablesArg / resolveVariablesArg /
validateVariablesAgainstProject are dropped; the matching tests move to
packages/cli/src/utils/variables.test.ts where the implementations now live.

Docs: docs/packages/cli.mdx adds a section on --variables / --variables-file /
--strict-variables for lambda render, including the 256 KiB Step Functions
execution-input cap and a pointer to the upcoming templates-on-lambda guide
(PR 9.5).

Phase 9 PR 9.3 of the distributed rendering plan.
This commit is contained in:
James
2026-05-19 19:54:30 -04:00
committed by James Russo
parent 87fdd556c4
commit cb948d5fcf
7 changed files with 479 additions and 305 deletions
+232
View File
@@ -0,0 +1,232 @@
/**
* Shared `--variables` / `--variables-file` / `--strict-variables` parsing
* and validation helpers used by both `hyperframes render` (in-process) and
* `hyperframes lambda render` (distributed). The Lambda CLI mirrors the
* local UX exactly — same flag names, same parse-error messages, same
* strict-mode behavior — so users who learned the local flow can drive
* Lambda renders without re-learning the surface.
*
* Side-effecting wrappers (`resolveVariablesArg`) call `process.exit(1)`
* on validation failure after rendering an `errorBox`; the pure parsers
* (`parseVariablesArg`) return a discriminated result so unit tests can
* exercise the validation paths without process termination.
*/
import { readFileSync } from "node:fs";
import { resolve } from "node:path";
import {
extractCompositionMetadata,
formatVariableValidationIssue,
validateVariables,
type VariableValidationIssue,
} from "@hyperframes/core";
import { ensureDOMParser } from "./dom.js";
import { c } from "../ui/colors.js";
import { errorBox } from "../ui/format.js";
export type VariablesParseError =
| { kind: "conflict" }
| { kind: "read-error"; path: string; cause: string }
| { kind: "parse-error"; source: "inline" | "file"; cause: string }
| { kind: "shape-error" };
export type VariablesParseResult =
| { ok: true; value: Record<string, unknown> | undefined }
| { ok: false; error: VariablesParseError };
/**
* Pure parser for the `--variables` / `--variables-file` flag pair. Splits
* out from `resolveVariablesArg` so validation paths are unit-testable
* without triggering `process.exit`. Reports failures via a structured
* `kind` discriminant so the side-effecting wrapper owns all UI strings.
*/
// Exported for tests in `./variables.test.ts`; not consumed outside the
// package. Suppressed so fallow's unused-exports audit doesn't flag a
// type-discriminated parser whose value is exactly testability.
// fallow-ignore-next-line unused-export complexity
export function parseVariablesArg(
inline: string | undefined,
filePath: string | undefined,
readFile: (path: string) => string = (p) => readFileSync(resolve(p), "utf8"),
): VariablesParseResult {
if (inline != null && filePath != null) {
return { ok: false, error: { kind: "conflict" } };
}
let raw: string | undefined;
let source: "inline" | "file" | undefined;
if (inline != null) {
raw = inline;
source = "inline";
} else if (filePath != null) {
try {
raw = readFile(filePath);
source = "file";
} catch (error: unknown) {
return {
ok: false,
error: {
kind: "read-error",
path: filePath,
cause: error instanceof Error ? error.message : String(error),
},
};
}
}
if (raw == null) return { ok: true, value: undefined };
let parsed: unknown;
try {
parsed = JSON.parse(raw);
} catch (error: unknown) {
return {
ok: false,
error: {
kind: "parse-error",
source: source ?? "inline",
cause: error instanceof Error ? error.message : String(error),
},
};
}
if (parsed == null || typeof parsed !== "object" || Array.isArray(parsed)) {
return { ok: false, error: { kind: "shape-error" } };
}
return { ok: true, value: parsed as Record<string, unknown> };
}
function variablesErrorMessage(error: VariablesParseError): { title: string; message: string } {
switch (error.kind) {
case "conflict":
return {
title: "Conflicting variables flags",
message: "Use either --variables or --variables-file, not both.",
};
case "read-error":
return {
title: "Could not read --variables-file",
message: `${error.path}: ${error.cause}`,
};
case "parse-error":
return {
title:
error.source === "file"
? "Invalid JSON in --variables-file"
: "Invalid JSON in --variables",
message: error.cause,
};
case "shape-error":
return {
title: "Invalid variables payload",
message: 'Variables must be a JSON object (e.g. {"title":"Hello"}).',
};
}
}
/**
* Resolve `--variables` / `--variables-file` into a plain object, or
* `undefined` when neither flag is set. Exits the process with a friendly
* error box on any validation failure.
*/
export function resolveVariablesArg(
inline: string | undefined,
filePath: string | undefined,
): Record<string, unknown> | undefined {
const result = parseVariablesArg(inline, filePath);
if (!result.ok) {
const { title, message } = variablesErrorMessage(result.error);
errorBox(title, message);
process.exit(1);
}
return result.value;
}
/**
* Validate `--variables` values against the project's top-level
* `data-composition-variables` declarations. Returns an empty array when
* the index has no declarations or when every key is declared with a
* matching type. Errors reading the index are silently treated as "no
* declarations" — the lint pass owns malformed-HTML diagnostics, render
* shouldn't fail just because the schema is unreadable.
*
* One-shot variant: parses the index every call. Batch callers that
* pre-validate N entries against the same project should reuse
* {@link loadProjectVariableSchema} + {@link validateVariablesAgainstSchema}
* to amortise the read + DOM parse.
*/
export function validateVariablesAgainstProject(
indexPath: string,
values: Record<string, unknown>,
): VariableValidationIssue[] {
const schema = loadProjectVariableSchema(indexPath);
return validateVariablesAgainstSchema(values, schema);
}
/** Cached schema returned by {@link loadProjectVariableSchema}. */
export type ProjectVariableSchema = ReturnType<typeof extractCompositionMetadata>["variables"];
/**
* Read + parse the composition's `data-composition-variables` declaration
* once. Returns an empty array on missing/unreadable index — the lint
* pass owns malformed-HTML diagnostics.
*
* Batch callers pair this with {@link validateVariablesAgainstSchema} to
* avoid the per-entry file read + DOMParser cost.
*/
export function loadProjectVariableSchema(indexPath: string): ProjectVariableSchema {
let html: string;
try {
html = readFileSync(indexPath, "utf8");
} catch {
return [];
}
// extractCompositionMetadata uses DOMParser, which Node doesn't ship.
// Same pattern as `compositions.ts` and other CLI commands that touch
// @hyperframes/core's HTML parsers.
ensureDOMParser();
return extractCompositionMetadata(html).variables;
}
/**
* Validate `values` against a pre-loaded schema. Empty schema means the
* project didn't declare variables — return no issues.
*/
export function validateVariablesAgainstSchema(
values: Record<string, unknown>,
schema: ProjectVariableSchema,
): VariableValidationIssue[] {
if (schema.length === 0) return [];
return validateVariables(values, schema);
}
/**
* Print a uniform warning block for variable validation issues; in
* `strict` mode, render an errorBox and exit(1). Used by both
* `hyperframes render` and `hyperframes lambda render` so the UX is
* identical across the two surfaces. Pass `quiet: true` to suppress the
* warning block (the errorBox in strict mode still prints).
*/
export function reportVariableIssues(
issues: readonly VariableValidationIssue[],
options: { strict: boolean; quiet?: boolean },
): void {
if (issues.length === 0) return;
const { strict, quiet } = options;
if (!quiet) {
console.log("");
console.log(
c.warn(
`Variable ${issues.length === 1 ? "issue" : "issues"} (${issues.length}) — values may not render as expected:`,
),
);
for (const issue of issues) {
console.log(" " + c.dim(formatVariableValidationIssue(issue)));
}
console.log("");
}
if (strict) {
errorBox(
"Variable validation failed",
"Aborting render due to variable issues (--strict-variables mode).",
);
process.exit(1);
}
}