@invarn/cibuild 1.9.9 → 2.0.1

package/dist/src/runner-node-step.test.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Node-kind step execution must ride a temp script FILE, never `node -e`.
+ *
+ * The released `ci` binary is pkg-built. pkg's bootstrap intercepts child
+ * spawns of `node` and re-executes the pkg binary itself — and that
+ * bootstrap cannot handle `-e`: it resolves it as an entrypoint path and
+ * dies with `Cannot find module '<cwd>/-e'` before the script runs. A
+ * real file path works under both a system node and the pkg bootstrap,
+ * exactly like bash steps already do via their temp-file pattern.
+ */
+export {};
+//# sourceMappingURL=runner-node-step.test.d.ts.map

package/dist/src/runner-node-step.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner-node-step.test.d.ts","sourceRoot":"","sources":["../../src/runner-node-step.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/dist/src/runner-node-step.test.js

@@ -0,0 +1,61 @@
+/**
+ * Node-kind step execution must ride a temp script FILE, never `node -e`.
+ *
+ * The released `ci` binary is pkg-built. pkg's bootstrap intercepts child
+ * spawns of `node` and re-executes the pkg binary itself — and that
+ * bootstrap cannot handle `-e`: it resolves it as an entrypoint path and
+ * dies with `Cannot find module '<cwd>/-e'` before the script runs. A
+ * real file path works under both a system node and the pkg bootstrap,
+ * exactly like bash steps already do via their temp-file pattern.
+ */
+import { describe, test, expect, afterEach } from '@jest/globals';
+import { mkdtempSync, readFileSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { PipelineRunner, StepExecutionError } from './runner.js';
+import { loadConfig } from './config.js';
+function nodeStep(script) {
+    return {
+        id: 'step_test',
+        name: 'node-under-test',
+        kind: 'node',
+        script,
+    };
+}
+describe('PipelineRunner node-kind steps', () => {
+    let outDir = null;
+    afterEach(() => {
+        if (outDir)
+            rmSync(outDir, { recursive: true, force: true });
+        outDir = null;
+    });
+    test('executes the script from a file: argv[1] is a real path, never -e', async () => {
+        outDir = mkdtempSync(join(tmpdir(), 'cibuild-node-step-'));
+        const probePath = join(outDir, 'probe.json');
+        const runner = new PipelineRunner(loadConfig('/nonexistent/ci.config.json'));
+        await runner.runStep(nodeStep(`require('fs').writeFileSync(${JSON.stringify(probePath)}, JSON.stringify({` +
+            `argv1: process.argv[1] ?? null,` +
+            `filename: typeof __filename === 'string' ? __filename : null` +
+            `}))`));
+        const probe = JSON.parse(readFileSync(probePath, 'utf-8'));
+        // `node -e` leaves argv[1] undefined and has no __filename; a
+        // file-executed script has both, and neither may be the literal '-e'.
+        expect(probe.argv1).not.toBeNull();
+        expect(probe.argv1).not.toBe('-e');
+        expect(probe.filename).not.toBeNull();
+        expect(probe.filename).toMatch(/\.cjs$/);
+    });
+    test('propagates a non-zero exit as StepExecutionError', async () => {
+        const runner = new PipelineRunner(loadConfig('/nonexistent/ci.config.json'));
+        await expect(runner.runStep(nodeStep('process.exit(3)'))).rejects.toThrow(StepExecutionError);
+    });
+    test('cleans up the temp script file after the step exits', async () => {
+        outDir = mkdtempSync(join(tmpdir(), 'cibuild-node-step-'));
+        const probePath = join(outDir, 'probe.json');
+        const runner = new PipelineRunner(loadConfig('/nonexistent/ci.config.json'));
+        await runner.runStep(nodeStep(`require('fs').writeFileSync(${JSON.stringify(probePath)}, JSON.stringify({ filename: __filename }))`));
+        const { filename } = JSON.parse(readFileSync(probePath, 'utf-8'));
+        expect(() => readFileSync(filename)).toThrow();
+    });
+});
+//# sourceMappingURL=runner-node-step.test.js.map

package/dist/src/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/runner.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMjE,qBAAa,kBAAmB,SAAQ,KAAK;IAElC,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;gBAFhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM;CAK1B;AAED,qBAAa,cAAc;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,QAAQ;IAE9B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoJhE,OAAO,CAAC,cAAc;IAYtB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAwB7C,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAczD,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA2CpG"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../src/runner.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMjE,qBAAa,kBAAmB,SAAQ,KAAK;IAElC,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;gBAFhB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM;CAK1B;AAED,qBAAa,cAAc;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,QAAQ;IAE9B,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkKhE,OAAO,CAAC,cAAc;IAYtB,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI;IAwB7C,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAczD,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA2CpG"}

package/dist/src/runner.js

@@ -121,8 +121,23 @@ export -f envman
                     args = ["-e", step.script];
                     break;
                 case "node":
+                    // Write the script to a file instead of passing it via -e: the
+                    // released ci binary is pkg-built, and pkg's bootstrap intercepts
+                    // child spawns of `node`, re-executing the pkg binary itself —
+                    // which resolves `-e` as an entrypoint path and dies with
+                    // `Cannot find module '<cwd>/-e'`. A real file path executes
+                    // under both a system node and the pkg bootstrap.
                     cmd = this.config.interpreters.node;
-                    args = ["-e", step.script];
+                    try {
+                        const tmpDir = mkdtempSync(join(tmpdir(), 'cibuild-script-'));
+                        tmpScriptPath = join(tmpDir, `step-${step.id || 'script'}.cjs`);
+                        writeFileSync(tmpScriptPath, step.script, 'utf-8');
+                    }
+                    catch (err) {
+                        reject(new Error(`Failed to create temporary script file: ${err}`));
+                        return;
+                    }
+                    args = [tmpScriptPath];
                     break;
                 default:
                     reject(new Error(`Unknown step kind: ${step.kind}`));

package/dist/src/yaml/platform-detector.js

@@ -10,7 +10,7 @@ export class PlatformDetectionError extends Error {
     }
 }
 // Platform-specific step names
-const MACOS_STEPS = new Set(['xcodebuild', 'xcode-test']);
+const MACOS_STEPS = new Set(['xcodebuild', 'xcode-test', 'ui-fidelity-render']);
 const LINUX_STEPS = new Set(['gradle-build', 'android-lint', 'android-unit-test', 'set-java-version']);
 /**
  * PlatformDetector analyzes a YAML workflow and determines the target platform

package/dist/src/yaml/platform-detector.test.js

@@ -207,6 +207,25 @@ describe('PlatformDetector', () => {
             const detector = new PlatformDetector(pipeline, pipeline.workflows.primary, 'primary');
             expect(detector.getPlatform()).toBe('macos');
         });
+        test('should detect macOS from ui-fidelity-render step', () => {
+            const pipeline = {
+                format_version: '4',
+                workflows: {
+                    primary: {
+                        steps: [
+                            { 'git-clone@4.0.17': { inputs: {} } },
+                            {
+                                'ui-fidelity-render@1.0.0': {
+                                    inputs: { package_path: './MyPackage', target: 'MyViews' },
+                                },
+                            },
+                        ],
+                    },
+                },
+            };
+            const detector = new PlatformDetector(pipeline, pipeline.workflows.primary, 'primary');
+            expect(detector.getPlatform()).toBe('macos');
+        });
         test('should detect macOS from xcode-test step', () => {
             const pipeline = {
                 format_version: '4',

package/dist/src/yaml/steps/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/yaml/steps/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+BH;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAm1C7C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/yaml/steps/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoCH;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAi3C7C"}

package/dist/src/yaml/steps/index.js

@@ -24,6 +24,7 @@ import { BitriseSlackStepExecutor } from './bitrise-slack.js';
 import { BitriseApkInfoStepExecutor } from './bitrise-apk-info.js';
 import { GooglePlayDeployStepExecutor } from './google-play-deploy.js';
 import { AppStoreDeployStepExecutor } from './app-store-deploy.js';
+import { UiFidelityRenderStepExecutor, DEFAULT_RENDER_SIZE, DEFAULT_SCALE, } from './ui-fidelity-render.js';
 /**
  * Initializes the step registry with all available steps
  * This function should be called once at application startup
@@ -757,6 +758,34 @@ export function initializeStepRegistry() {
             },
         },
     });
+    // UI fidelity — render SwiftUI screens to PNGs via ImageRenderer on macOS
+    registerStep('ui-fidelity-render', new UiFidelityRenderStepExecutor(), {
+        name: 'ui-fidelity-render',
+        description: 'Render parameterless SwiftUI views from a SwiftPM package to PNGs with ImageRenderer (no app build, no simulator)',
+        platform: 'ios',
+        inputs: {
+            package_path: {
+                description: "Path to the user's SwiftPM package containing the screens",
+                required: true,
+                inputType: 'path',
+            },
+            target: {
+                description: 'SPM library product to import in the render harness',
+                required: true,
+                inputType: 'text',
+            },
+            render_size: {
+                description: 'Render size in device points, "<width>x<height>"',
+                required: false,
+                default: DEFAULT_RENDER_SIZE,
+            },
+            scale: {
+                description: 'Display scale factor applied to the render',
+                required: false,
+                default: DEFAULT_SCALE,
+            },
+        },
+    });
     // Export xcarchive
     registerStep('export-xcarchive', new ExportXcarchiveStepExecutor(), {
         name: 'export-xcarchive',

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

@@ -0,0 +1,120 @@
+/**
+ * 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>`.
+ *   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, compiler diagnostics) are
+ * rewritten to relative paths or placeholders before they are stored.
+ */
+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 {
+    /** Path to the user's SwiftPM package (the package that defines the screens) */
+    package_path: string;
+    /** SPM library product/target to import in the render harness */
+    target: string;
+    /** 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;
+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.
+ */
+export interface RenderScriptConfig {
+    packagePath: string;
+    target: string;
+    width: number;
+    height: number;
+    scale: number;
+}
+/** 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.
+ */
+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

@@ -0,0 +1 @@
+{"version":3,"file":"ui-fidelity-render.d.ts","sourceRoot":"","sources":["../../../../src/yaml/steps/ui-fidelity-render.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;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;AAEpE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gFAAgF;IAChF,YAAY,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,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,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;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;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;AA6eD;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,qBAAqB,CAShE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAQvE;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;IAoBpB,OAAO,CACX,MAAM,EAAE,sBAAsB,EAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC,OAAO,CAAC;CAoBpB"}