@invarn/cibuild 2.9.4 → 2.9.7

package/dist/src/yaml/steps/ui-fidelity-render.d.ts

@@ -1,230 +0,0 @@
-/**
- * ui-fidelity-render step implementation.
- *
- * Renders parameterless SwiftUI views from a user's SwiftPM package to PNGs
- * with SwiftUI's ImageRenderer on a macOS runner — no app build, no
- * simulator. The step returns a self-contained node script that, at runtime:
- *
- *   1. Reads `.ci/inputs/params.json`
- *      ({ "screens": { "<ViewTypeName>": "<referenceFileBasename>" } });
- *      reference images live at `.ci/inputs/<basename>`.
- *      Optional reference-provenance sidecar: `"render_locale": "<locale>"`
- *      plus `"provenance": { "<ViewTypeName>": { figmaNode, locale, resolved,
- *      exportedAt } }`. The gate arms per screen from provenance presence and
- *      checks METADATA only (never pixels/OCR): an absent reference is FATAL
- *      (status `unverifiable`, REFERENCE_ABSENT); `resolved == false` or
- *      `locale != render_locale` downgrade ONLY the copy channel — the screen
- *      renders and is judged on every non-copy channel, and the downgrade
- *      rides as a per-screen `copy_advisory` (`copy_unverifiable` + reason).
- *      Unprovenanced screens keep legacy behaviour (no NO_PROVENANCE arming
- *      on iOS).
- *   2. Synthesizes a throwaway SwiftPM harness package that depends on the
- *      user's package and contains ONE executable target per screen, so a
- *      compile failure for one screen (unknown view type, unavailable init)
- *      never breaks the others. A screen-free probe target distinguishes
- *      "this screen is broken" from "the whole package does not build for
- *      macOS" (RENDER_UNSUPPORTED).
- *   3. Builds and runs each per-screen executable, which constructs the view
- *      strictly as `<ViewTypeName>()`, renders at render_size x scale on the
- *      MainActor, and writes a PNG via CGImage + ImageIO.
- *   4. Writes, inside the artifacts dir (${CIBUILD_ARTIFACTS_DIR:-.ci/artifacts}):
- *      - ui-fidelity/rendered/<Screen>.png
- *      - ui-fidelity/references/<Screen>.png (one copy per screen, even when
- *        two screens share a reference basename)
- *      - protocol-result.json (always written, even on partial/total failure;
- *        when params.json is absent/malformed the screens array is empty
- *        because screens cannot be enumerated)
- *   5. Exits non-zero iff any screen is not "rendered".
- *
- * protocol-result.json contains relative paths only: image paths are relative
- * to the artifacts dir, and error messages are sanitized so absolute runner
- * paths (resolved package_path, harness temp dir, extracted shipped package,
- * compiler diagnostics) are rewritten to relative paths or placeholders
- * before they are stored.
- *
- * The package_source input picks where the SwiftPM package comes from:
- *   - "repo" (default): the package lives in the checkout at package_path.
- *     Omitting the input generates a byte-identical script to the original
- *     step (locked by a snapshot test), and the result document keeps its
- *     original { renderer, screens } shape.
- *   - "inputs": the caller ships the package as .ci/inputs/package.tar.gz.
- *     The archive is extracted into a scratch directory and validated
- *     (single package root, Package.swift at its top, bounded extracted
- *     size); rendering then proceeds exactly as in repo mode. Validation
- *     failures are per-build structured errors (PACKAGE_ARCHIVE_MISSING,
- *     PACKAGE_ARCHIVE_INVALID, PACKAGE_MANIFEST_MISSING,
- *     PACKAGE_ARCHIVE_TOO_LARGE, PACKAGE_TARGET_UNRESOLVED) recorded as a
- *     top-level error object in the result document, distinct from
- *     per-screen render errors. With an explicit package_source the result
- *     document is { renderer, package_source, error, screens }.
- */
-import { BaseStepExecutor } from './base.js';
-import type { StepDef, CIConfig } from '../../types.js';
-import type { ValidationRequirement } from '../validation-types.js';
-/**
- * Inputs for the ui-fidelity-render step
- */
-export interface UiFidelityRenderInputs {
-    /**
-     * Where the SwiftPM package comes from (default "repo"):
-     * - "repo": the package lives in the checkout at package_path (v1
-     *   behavior; omitting package_source generates a byte-identical script).
-     * - "inputs": the package ships as .ci/inputs/package.tar.gz and is
-     *   extracted, validated, and built from a scratch directory at runtime.
-     * - "url" (fidelity-linux 03): the same package.tar.gz is downloaded from
-     *   the signed package_url into the run-inputs directory, then extracted
-     *   and built exactly like inputs mode — the clone-free delivery for
-     *   triggered runs. References resolve INSIDE the extracted package.
-     */
-    package_source?: 'repo' | 'inputs' | 'url';
-    /**
-     * Signed download URL for package.tar.gz. Required with package_source
-     * "url"; ignored otherwise.
-     */
-    package_url?: string;
-    /**
-     * Path to the user's SwiftPM package (the package that defines the
-     * screens). Required in repo mode; ignored with package_source "inputs".
-     */
-    package_path?: string;
-    /**
-     * SPM library product/target to import in the render harness. Required in
-     * repo mode; optional with package_source "inputs", where it is discovered
-     * from the shipped manifest when the package declares exactly one library
-     * product.
-     */
-    target?: string;
-    /**
-     * Where each screen's reference image comes from (default "inputs"):
-     * - "inputs" (default / v1): `params.screens[<Screen>]` is a plain file
-     *   basename read from `.ci/inputs/<basename>` (an agent-uploaded run input).
-     * - "repo": `params.screens[<Screen>]` is a repo-relative path to a COMMITTED
-     *   reference image, resolved against the checkout. Lets a triggered
-     *   (agent-less) run point at a reference that lives in the cloned repo.
-     *   Omitting reference_source generates a byte-identical v1 script.
-     */
-    reference_source?: 'repo' | 'inputs';
-    /** Render size in device points, formatted "<width>x<height>" (default 393x852) */
-    render_size?: string;
-    /** Display scale factor applied to the render (default 2) */
-    scale?: number | string;
-}
-/**
- * Default render size in device points. 393x852 is the iPhone-class portrait
- * canvas shared by the iPhone 14 Pro / 15 / 16 — the most common modern
- * iPhone logical resolution, so renders line up with design references by
- * default.
- */
-export declare const DEFAULT_RENDER_SIZE = "393x852";
-/** Default display scale (@2x), matching how references are typically exported. */
-export declare const DEFAULT_SCALE = 2;
-/** Valid values for the package_source input. */
-export declare const PACKAGE_SOURCES: readonly ["repo", "inputs", "url"];
-export type PackageSource = (typeof PACKAGE_SOURCES)[number];
-/** Default package source: the package lives in the repo checkout. */
-export declare const DEFAULT_PACKAGE_SOURCE: PackageSource;
-/** Valid values for the reference_source input. */
-export declare const REFERENCE_SOURCES: readonly ["repo", "inputs"];
-export type ReferenceSource = (typeof REFERENCE_SOURCES)[number];
-/** Default reference source: references arrive as run inputs (v1 behaviour). */
-export declare const DEFAULT_REFERENCE_SOURCE: ReferenceSource;
-/** Basename of the shipped package archive inside the run-inputs directory. */
-export declare const PACKAGE_ARCHIVE_BASENAME = "package.tar.gz";
-/**
- * Default cap on the extracted size of a shipped package archive (32 MiB),
- * overridable at runtime via UI_FIDELITY_MAX_PACKAGE_BYTES. The archive
- * arrives through a size-limited dispatch channel (256 KiB), and gzip tops
- * out around a 1000:1 ratio, so this bound is a decompression-bomb guard
- * with enormous headroom for legitimate source slices, which are typically
- * well under 1 MiB extracted.
- */
-export declare const DEFAULT_MAX_EXTRACTED_BYTES: number;
-export interface RenderSize {
-    width: number;
-    height: number;
-}
-/**
- * Parses a "<width>x<height>" render size string (device points).
- * @throws Error when the value is malformed or non-positive
- */
-export declare function parseRenderSize(value: string): RenderSize;
-/**
- * Parses the scale input into a positive finite number.
- * @throws Error when the value is not a positive number
- */
-export declare function parseScale(value: number | string): number;
-/**
- * Configuration baked into the generated runtime script at YAML-conversion
- * time. Everything else (screens, references) is read at runtime from
- * .ci/inputs/params.json.
- *
- * packageSource is only present when the package_source input was explicitly
- * configured. When absent, the generated script is byte-identical to the
- * pre-package_source script (locked by a snapshot test) and the result
- * document keeps its original `{ renderer, screens }` shape. When present,
- * the result document additionally records `package_source` and a top-level
- * `error` (null, or `{ code, message }` for per-build package failures).
- */
-export interface RenderScriptConfig {
-    /** null only with packageSource "inputs", where the package is shipped.
-     *  With packageSource "url" it carries the repo-relative package directory
-     *  committed reference paths are resolved under (never a local path). */
-    packagePath: string | null;
-    /** null with packageSource "inputs"/"url" when it is to be discovered. */
-    target: string | null;
-    width: number;
-    height: number;
-    scale: number;
-    packageSource?: PackageSource;
-    /**
-     * Signed download URL for package.tar.gz. Present (and required) only with
-     * packageSource "url"; ignored otherwise.
-     */
-    packageUrl?: string;
-    /**
-     * Only present (and only ever "repo") when reference_source was explicitly set
-     * to "repo". When absent, references are read from `.ci/inputs/<basename>` and
-     * the generated reference-sourcing code is byte-identical to v1.
-     */
-    referenceSource?: ReferenceSource;
-}
-/** Options consumed by the pure Swift-source generators. */
-export interface HarnessGeneratorOptions {
-    packagePath: string;
-    packageRef: string;
-    target: string;
-    width: number;
-    height: number;
-    scale: number;
-}
-/** The generator functions embedded in (and shared with) the runtime script. */
-export interface RenderScriptInternals {
-    swiftStringLiteral(value: string): string;
-    generateHarnessPackageSwift(screens: string[], options: HarnessGeneratorOptions): string;
-    generateProbeSwift(options: HarnessGeneratorOptions): string;
-    generateScreenSwift(screen: string, options: HarnessGeneratorOptions): string;
-}
-/**
- * Evaluates the embedded generator source and returns the real functions, so
- * unit tests exercise exactly the code that ships inside the runtime script.
- */
-export declare function getRenderScriptInternals(): RenderScriptInternals;
-/**
- * Generates the self-contained runtime node script for the step.
- * Pure function of its config — exported so tests can execute the script.
- *
- * When config.packageSource is absent the output is byte-identical to the
- * pre-package_source script (JSON.stringify drops undefined keys, and the
- * unpatched v1 runtime is used).
- */
-export declare function generateRenderScript(config: RenderScriptConfig): string;
-/**
- * ui-fidelity-render step executor.
- * Returns a node-kind StepDef whose script performs the render at runtime on
- * the macOS runner.
- */
-export declare class UiFidelityRenderStepExecutor extends BaseStepExecutor {
-    getValidationRequirements(inputs: UiFidelityRenderInputs, _env: Record<string, string>, _config: CIConfig): ValidationRequirement[];
-    execute(inputs: UiFidelityRenderInputs, _env: Record<string, string>, _config: CIConfig): Promise<StepDef>;
-}
-//# sourceMappingURL=ui-fidelity-render.d.ts.map

package/dist/src/yaml/steps/ui-fidelity-render.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ui-fidelity-render.d.ts","sourceRoot":"","sources":["../../../../src/yaml/steps/ui-fidelity-render.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAIpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC3C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IACrC,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,YAAY,CAAC;AAE7C,mFAAmF;AACnF,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,iDAAiD;AACjD,eAAO,MAAM,eAAe,oCAAqC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,EAAE,aAAsB,CAAC;AAE5D,mDAAmD;AACnD,eAAO,MAAM,iBAAiB,6BAA8B,CAAC;AAC7D,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE,gFAAgF;AAChF,eAAO,MAAM,wBAAwB,EAAE,eAA0B,CAAC;AAElE,+EAA+E;AAC/E,eAAO,MAAM,wBAAwB,mBAAmB,CAAC;AAEzD;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,QAAmB,CAAC;AAE5D,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAWzD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAQzD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IACjC;;6EAEyE;IACzE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,0EAA0E;IAC1E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,4DAA4D;AAC5D,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gFAAgF;AAChF,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1C,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,uBAAuB,GAAG,MAAM,CAAC;IACzF,kBAAkB,CAAC,OAAO,EAAE,uBAAuB,GAAG,MAAM,CAAC;IAC7D,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,GAAG,MAAM,CAAC;CAC/E;AA64CD;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,qBAAqB,CAShE;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAoBvE;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,gBAAgB;IAChE,yBAAyB,CACvB,MAAM,EAAE,sBAAsB,EAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,QAAQ,GAChB,qBAAqB,EAAE;IA+CpB,OAAO,CACX,MAAM,EAAE,sBAAsB,EAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,OAAO,CAAC;CA4GpB"}