@react-native-harness/bridge 1.0.0-alpha.21 → 1.0.0-alpha.23

package/dist/binary-transfer.d.ts

@@ -0,0 +1,17 @@
+export declare const HEADER_SIZE = 8;
+export declare function createBinaryFrame(transferId: number, data: Uint8Array): Uint8Array;
+export declare function parseBinaryFrame(frame: Uint8Array): {
+    transferId: number;
+    data: Uint8Array;
+};
+export declare class BinaryStore {
+    private store;
+    private timeouts;
+    private readonly TIMEOUT_MS;
+    add(transferId: number, data: Uint8Array): void;
+    get(transferId: number): Uint8Array | undefined;
+    delete(transferId: number): boolean;
+    dispose(): void;
+}
+export declare function generateTransferId(): number;
+//# sourceMappingURL=binary-transfer.d.ts.map

package/dist/binary-transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-transfer.d.ts","sourceRoot":"","sources":["../src/binary-transfer.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,IAAI,CAAC;AAE7B,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,UAAU,GACf,UAAU,CAcZ;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB,CAMA;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,CAAC,QAAQ,CAA0B;IAE1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiB;IAE5C,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IAS/C,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAI/C,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IASnC,OAAO,IAAI,IAAI;CAOhB;AAGD,wBAAgB,kBAAkB,IAAI,MAAM,CAQ3C"}

package/dist/binary-transfer.js

@@ -0,0 +1,60 @@
+export const HEADER_SIZE = 8;
+export function createBinaryFrame(transferId, data) {
+    const frame = new Uint8Array(HEADER_SIZE + data.length);
+    const view = new DataView(frame.buffer);
+    // Transfer ID (4 bytes, Big Endian)
+    view.setUint32(0, transferId, false);
+    // Reserved (4 bytes) - set to 0
+    view.setUint32(4, 0, false);
+    // Copy data
+    frame.set(data, HEADER_SIZE);
+    return frame;
+}
+export function parseBinaryFrame(frame) {
+    const view = new DataView(frame.buffer, frame.byteOffset, frame.byteLength);
+    const transferId = view.getUint32(0, false);
+    const data = frame.subarray(HEADER_SIZE);
+    return { transferId, data };
+}
+export class BinaryStore {
+    store = new Map();
+    timeouts = new Map();
+    // 5 minutes timeout for binary data
+    TIMEOUT_MS = 5 * 60 * 1000;
+    add(transferId, data) {
+        this.store.set(transferId, data);
+        const timeout = setTimeout(() => {
+            this.store.delete(transferId);
+            this.timeouts.delete(transferId);
+        }, this.TIMEOUT_MS);
+        this.timeouts.set(transferId, timeout);
+    }
+    get(transferId) {
+        return this.store.get(transferId);
+    }
+    delete(transferId) {
+        const timeout = this.timeouts.get(transferId);
+        if (timeout) {
+            clearTimeout(timeout);
+            this.timeouts.delete(transferId);
+        }
+        return this.store.delete(transferId);
+    }
+    dispose() {
+        for (const timeout of this.timeouts.values()) {
+            clearTimeout(timeout);
+        }
+        this.timeouts.clear();
+        this.store.clear();
+    }
+}
+let nextTransferId = 1;
+export function generateTransferId() {
+    // Use a rolling counter, but ensure it doesn't overflow 32-bit integer just in case
+    // though JS numbers are doubles, we are writing to Uint32.
+    const id = nextTransferId++;
+    if (nextTransferId > 0xffffffff) {
+        nextTransferId = 1;
+    }
+    return id;
+}

package/dist/client.d.ts

@@ -3,6 +3,7 @@ import type { BridgeClientFunctions, BridgeServerFunctions } from './shared.js';
 export type BridgeClient = {
     rpc: BirpcReturn<BridgeServerFunctions, BridgeClientFunctions>;
     disconnect: () => void;
+    sendBinary: (transferId: number, data: Uint8Array) => void;
 };
 declare const getBridgeClient: (url: string, handlers: BridgeClientFunctions) => Promise<BridgeClient>;
 export { getBridgeClient };

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAGhF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,WAAW,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC;IAC/D,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF,QAAA,MAAM,eAAe,GACnB,KAAK,MAAM,EACX,UAAU,qBAAqB,KAC9B,OAAO,CAAC,YAAY,CA+BtB,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAIhF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,WAAW,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC;IAC/D,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,UAAU,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;CAC5D,CAAC;AAEF,QAAA,MAAM,eAAe,GACnB,KAAK,MAAM,EACX,UAAU,qBAAqB,KAC9B,OAAO,CAAC,YAAY,CAsCtB,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/client.js

@@ -1,14 +1,18 @@
 import { createBirpc } from 'birpc';
 import { deserialize, serialize } from './serializer.js';
+import { createBinaryFrame } from './binary-transfer.js';
 const getBridgeClient = async (url, handlers) => {
     return new Promise((resolve) => {
         const ws = new WebSocket(url);
+        ws.binaryType = 'arraybuffer';
         const handleOpen = () => {
             const rpc = createBirpc(handlers, {
                 post: (data) => ws.send(data),
                 on: (handler) => {
                     ws.addEventListener('message', (event) => {
-                        handler(event.data);
+                        if (typeof event.data === 'string') {
+                            handler(event.data);
+                        }
                     });
                 },
                 serialize,
@@ -19,6 +23,10 @@ const getBridgeClient = async (url, handlers) => {
                 disconnect: () => {
                     ws.close();
                 },
+                sendBinary: (transferId, data) => {
+                    const frame = createBinaryFrame(transferId, data);
+                    ws.send(frame);
+                },
             };
             resolve(client);
         };

package/dist/events.d.ts

@@ -0,0 +1,45 @@
+export type ExecutionStartedEvent = {
+    type: 'execution-started';
+    path: string;
+    numberOfTests: number;
+};
+export type ExecutionFinishedEvent = {
+    type: 'execution-finished';
+    path: string;
+    duration: number;
+};
+export type SuiteStartedEvent = {
+    type: 'suite-started';
+    path: string;
+    name: string;
+};
+export type SuiteFinishedEvent = {
+    type: 'suite-finished';
+    path: string;
+    name: string;
+    duration: number;
+    reason: 'passed' | 'failed' | 'skipped' | 'todo';
+};
+export type TestStartedEvent = {
+    type: 'test-started';
+    path: string;
+    suite: string;
+    name: string;
+};
+export type TestFinishedEvent = {
+    type: 'test-finished';
+    path: string;
+    suite: string;
+    name: string;
+    duration: number;
+    reason: 'passed' | 'failed' | 'skipped' | 'todo';
+};
+export type BridgeEvents = {
+    'execution-started': ExecutionStartedEvent;
+    'execution-finished': ExecutionFinishedEvent;
+    'suite-started': SuiteStartedEvent;
+    'suite-finished': SuiteFinishedEvent;
+    'test-started': TestStartedEvent;
+    'test-finished': TestFinishedEvent;
+};
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,mBAAmB,EAAE,qBAAqB,CAAC;IAC3C,oBAAoB,EAAE,sBAAsB,CAAC;IAC7C,eAAe,EAAE,iBAAiB,CAAC;IACnC,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,cAAc,EAAE,gBAAgB,CAAC;IACjC,eAAe,EAAE,iBAAiB,CAAC;CACpC,CAAC"}

package/dist/events.js

@@ -0,0 +1 @@
+export {};

package/dist/image-snapshot.d.ts

@@ -0,0 +1,6 @@
+import type { FileReference, ImageSnapshotOptions } from './shared.js';
+export declare const matchImageSnapshot: (screenshot: FileReference, testFilePath: string, options: ImageSnapshotOptions, platformName: string) => Promise<{
+    pass: boolean;
+    message: string;
+}>;
+//# sourceMappingURL=image-snapshot.d.ts.map

package/dist/image-snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-snapshot.d.ts","sourceRoot":"","sources":["../src/image-snapshot.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AA0CvE,eAAO,MAAM,kBAAkB,GAC7B,YAAY,aAAa,EACzB,cAAc,MAAM,EACpB,SAAS,oBAAoB,EAC7B,cAAc,MAAM;;;EAsHrB,CAAC"}

package/dist/image-snapshot.js

@@ -0,0 +1,131 @@
+import pixelmatch from 'pixelmatch';
+import { ssim } from 'ssim.js';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PNG } from 'pngjs';
+const SNAPSHOT_DIR_NAME = '__image_snapshots__';
+const DEFAULT_OPTIONS_FOR_PIXELMATCH = {
+    threshold: 0.1,
+    includeAA: false,
+    alpha: 0.1,
+    aaColor: [255, 255, 0],
+    diffColor: [255, 0, 0],
+    // @ts-expect-error - this is extracted from the pixelmatch package
+    diffColorAlt: null,
+    diffMask: false,
+};
+function maskRegions(data, imageWidth, regions) {
+    for (const region of regions) {
+        const startY = Math.max(0, region.y);
+        const endY = Math.min(Math.floor(data.length / 4 / imageWidth), region.y + region.height);
+        const startX = Math.max(0, region.x);
+        const endX = Math.min(imageWidth, region.x + region.width);
+        for (let y = startY; y < endY; y++) {
+            for (let x = startX; x < endX; x++) {
+                const idx = (imageWidth * y + x) << 2;
+                data[idx] = 0;
+                data[idx + 1] = 0;
+                data[idx + 2] = 0;
+                data[idx + 3] = 0;
+            }
+        }
+    }
+}
+export const matchImageSnapshot = async (screenshot, testFilePath, options, platformName) => {
+    const pixelmatchOptions = {
+        ...DEFAULT_OPTIONS_FOR_PIXELMATCH,
+        ...options,
+    };
+    const receivedPath = screenshot.path;
+    try {
+        await fs.access(receivedPath);
+    }
+    catch {
+        throw new Error(`Screenshot file not found at ${receivedPath}`);
+    }
+    const receivedBuffer = await fs.readFile(receivedPath);
+    // Create __image_snapshots__ directory in same directory as test file
+    const testDir = path.dirname(testFilePath);
+    const snapshotsDir = path.join(testDir, SNAPSHOT_DIR_NAME, platformName);
+    const snapshotName = `${options.name}.png`;
+    const snapshotPath = path.join(snapshotsDir, snapshotName);
+    await fs.mkdir(snapshotsDir, { recursive: true });
+    try {
+        await fs.access(snapshotPath);
+    }
+    catch {
+        // First time - create snapshot
+        await fs.writeFile(snapshotPath, receivedBuffer);
+        return {
+            pass: true,
+            message: `Snapshot created at ${snapshotPath}`,
+        };
+    }
+    const [receivedBufferAgain, snapshotBuffer] = await Promise.all([
+        fs.readFile(receivedPath),
+        fs.readFile(snapshotPath),
+    ]);
+    const img1 = PNG.sync.read(receivedBufferAgain);
+    const img2 = PNG.sync.read(snapshotBuffer);
+    const { width, height } = img1;
+    const diff = new PNG({ width, height });
+    if (img1.width !== img2.width || img1.height !== img2.height) {
+        return {
+            pass: false,
+            message: `Images have different dimensions. Received image width: ${img1.width}, height: ${img1.height}. Snapshot image width: ${img2.width}, height: ${img2.height}.`,
+        };
+    }
+    if (options.ignoreRegions) {
+        maskRegions(img1.data, width, options.ignoreRegions);
+        maskRegions(img2.data, width, options.ignoreRegions);
+    }
+    let pass = false;
+    let message = '';
+    // Always calculate pixel differences for visual diff
+    const differences = pixelmatch(img1.data, img2.data, diff.data, width, height, pixelmatchOptions);
+    if (options.comparisonMethod === 'ssim') {
+        const img1Data = {
+            data: new Uint8ClampedArray(img1.data),
+            width: img1.width,
+            height: img1.height,
+        };
+        const img2Data = {
+            data: new Uint8ClampedArray(img2.data),
+            width: img2.width,
+            height: img2.height,
+        };
+        const { mssim } = ssim(img1Data, img2Data);
+        const threshold = options.ssimThreshold ?? 0.95;
+        pass = mssim >= threshold;
+        message = pass
+            ? `Images match (SSIM: ${mssim})`
+            : `SSIM score ${mssim} is less than threshold ${threshold}`;
+    }
+    else {
+        const failureThreshold = options.failureThreshold ?? 0;
+        const failureThresholdType = options.failureThresholdType ?? 'pixel';
+        if (failureThresholdType === 'percent') {
+            const totalPixels = width * height;
+            const percentage = differences / totalPixels;
+            pass = percentage <= failureThreshold;
+        }
+        else {
+            pass = differences <= failureThreshold;
+        }
+        message = pass ? 'Images match' : `Images differ by ${differences} pixels.`;
+    }
+    // Save diff and actual images when test fails
+    if (!pass) {
+        const diffFileName = `${snapshotName.replace('.png', '')}-diff.png`;
+        const diffPath = path.join(snapshotsDir, diffFileName);
+        await fs.writeFile(diffPath, PNG.sync.write(diff));
+        const actualFileName = `${snapshotName.replace('.png', '')}-actual.png`;
+        const actualPath = path.join(snapshotsDir, actualFileName);
+        await fs.writeFile(actualPath, receivedBuffer);
+        message += ` Diff saved at ${diffPath}. Actual image saved at ${actualPath}.`;
+    }
+    return {
+        pass,
+        message,
+    };
+};

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './shared.js';
+export * from './binary-transfer.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -1 +1,2 @@
 export * from './shared.js';
+export * from './binary-transfer.js';

package/dist/platform-bridge.d.ts

@@ -0,0 +1,4 @@
+import type { HarnessPlatformRunner } from '@react-native-harness/platforms';
+import type { BridgeServerFunctions } from './shared.js';
+export declare const createPlatformBridgeFunctions: (platformRunner: HarnessPlatformRunner) => Partial<BridgeServerFunctions>;
+//# sourceMappingURL=platform-bridge.d.ts.map

package/dist/platform-bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-bridge.d.ts","sourceRoot":"","sources":["../src/platform-bridge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD,eAAO,MAAM,6BAA6B,GACxC,gBAAgB,qBAAqB,KACpC,OAAO,CAAC,qBAAqB,CAwB/B,CAAC"}

package/dist/platform-bridge.js

@@ -0,0 +1,25 @@
+export const createPlatformBridgeFunctions = (platformRunner) => {
+    return {
+        'platform.actions.tap': async (x, y) => {
+            await platformRunner.actions.tap(x, y);
+        },
+        'platform.actions.inputText': async (text) => {
+            await platformRunner.actions.inputText(text);
+        },
+        'platform.actions.tapElement': async (element) => {
+            await platformRunner.actions.tapElement(element);
+        },
+        'platform.actions.screenshot': async () => {
+            return await platformRunner.actions.screenshot();
+        },
+        'platform.queries.getUiHierarchy': async () => {
+            return await platformRunner.queries.getUiHierarchy();
+        },
+        'platform.queries.findByTestId': async (testId) => {
+            return await platformRunner.queries.findByTestId(testId);
+        },
+        'platform.queries.findAllByTestId': async (testId) => {
+            return await platformRunner.queries.findAllByTestId(testId);
+        },
+    };
+};

package/dist/server.d.ts

@@ -1,9 +1,11 @@
 import { WebSocketServer } from 'ws';
 import { type BirpcGroup } from 'birpc';
-import type { BridgeServerFunctions, BridgeClientFunctions, DeviceDescriptor, BridgeEvents } from './shared.js';
+import type { BridgeServerFunctions, BridgeClientFunctions, DeviceDescriptor, BridgeEvents, HarnessContext } from './shared.js';
+export { DeviceNotRespondingError } from './errors.js';
 export type BridgeServerOptions = {
     port: number;
     timeout?: number;
+    context: HarnessContext;
 };
 export type BridgeServerEvents = {
     ready: (device: DeviceDescriptor) => void;
@@ -18,5 +20,5 @@ export type BridgeServer = {
     off: <T extends keyof BridgeServerEvents>(event: T, listener: BridgeServerEvents[T]) => void;
     dispose: () => void;
 };
-export declare const getBridgeServer: ({ port, timeout, }: BridgeServerOptions) => Promise<BridgeServer>;
+export declare const getBridgeServer: ({ port, timeout, context, }: BridgeServerOptions) => Promise<BridgeServer>;
 //# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAkB,MAAM,IAAI,CAAC;AACrD,OAAO,EAAE,KAAK,UAAU,EAAoB,MAAM,OAAO,CAAC;AAG1D,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,YAAY,EACb,MAAM,aAAa,CAAC;AAIrB,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IACrC,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,eAAe,CAAC;IACpB,GAAG,EAAE,UAAU,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC;IAC9D,EAAE,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACrC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,IAAI,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACvC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,GAAG,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACtC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,oBAGnC,mBAAmB,KAAG,OAAO,CAAC,YAAY,CAiE5C,CAAC"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAkB,MAAM,IAAI,CAAC;AACrD,OAAO,EAAE,KAAK,UAAU,EAAoB,MAAM,OAAO,CAAC;AAQ1D,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,YAAY,EAEZ,cAAc,EAGf,MAAM,aAAa,CAAC;AAKrB,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IACrC,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,eAAe,CAAC;IACpB,GAAG,EAAE,UAAU,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC;IAC9D,EAAE,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACrC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,IAAI,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACvC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,GAAG,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACtC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC5B,IAAI,CAAC;IACV,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,6BAInC,mBAAmB,KAAG,OAAO,CAAC,YAAY,CA6H5C,CAAC"}

package/dist/server.js

@@ -2,9 +2,16 @@ import { WebSocketServer } from 'ws';
 import { createBirpcGroup } from 'birpc';
 import { logger } from '@react-native-harness/tools';
 import { EventEmitter } from 'node:events';
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import { randomUUID } from 'node:crypto';
+import { BinaryStore, parseBinaryFrame } from './binary-transfer.js';
 import { deserialize, serialize } from './serializer.js';
 import { DeviceNotRespondingError } from './errors.js';
-export const getBridgeServer = async ({ port, timeout, }) => {
+import { matchImageSnapshot } from './image-snapshot.js';
+export { DeviceNotRespondingError } from './errors.js';
+export const getBridgeServer = async ({ port, timeout, context, }) => {
     const wss = await new Promise((resolve) => {
         const server = new WebSocketServer({ port, host: '0.0.0.0' }, () => {
             resolve(server);
@@ -12,15 +19,40 @@ export const getBridgeServer = async ({ port, timeout, }) => {
     });
     const emitter = new EventEmitter();
     const clients = new Set();
-    const group = createBirpcGroup({
+    const binaryStore = new BinaryStore();
+    const baseFunctions = {
         reportReady: (device) => {
             emitter.emit('ready', device);
         },
         emitEvent: (_, data) => {
             emitter.emit('event', data);
         },
-    }, [], {
+        'device.screenshot.receive': async (reference, metadata) => {
+            const data = binaryStore.get(reference.transferId);
+            if (!data) {
+                throw new Error(`Binary data for transfer ${reference.transferId} not found or expired`);
+            }
+            // Clean up from store
+            binaryStore.delete(reference.transferId);
+            // Write to temp file
+            const tempFile = path.join(os.tmpdir(), `harness-screenshot-${randomUUID()}.png`);
+            await fs.writeFile(tempFile, data);
+            return {
+                path: tempFile,
+                width: metadata.width,
+                height: metadata.height,
+            };
+        },
+        'test.matchImageSnapshot': async (screenshot, testPath, options) => {
+            return await matchImageSnapshot(screenshot, testPath, options, context.platform.name);
+        },
+    };
+    const group = createBirpcGroup(baseFunctions, [], {
         timeout,
+        onFunctionError: (error, functionName, args) => {
+            console.error('Function error', error, functionName, args);
+            throw error;
+        },
         onTimeoutError(functionName, args) {
             throw new DeviceNotRespondingError(functionName, args);
         },
@@ -37,7 +69,18 @@ export const getBridgeServer = async ({ port, timeout, }) => {
             channels.push({
                 post: (data) => ws.send(data),
                 on: (handler) => {
-                    ws.on('message', (event) => {
+                    ws.on('message', (event, isBinary) => {
+                        if (isBinary) {
+                            const uint8Array = new Uint8Array(event);
+                            try {
+                                const { transferId, data } = parseBinaryFrame(uint8Array);
+                                binaryStore.add(transferId, data);
+                                return;
+                            }
+                            catch (error) {
+                                logger.warn('Failed to parse binary frame', error);
+                            }
+                        }
                         const message = event.toString();
                         handler(message);
                     });
@@ -50,6 +93,7 @@ export const getBridgeServer = async ({ port, timeout, }) => {
     const dispose = () => {
         wss.close();
         emitter.removeAllListeners();
+        binaryStore.dispose();
     };
     return {
         ws: wss,

package/dist/shared.d.ts

@@ -1,10 +1,74 @@
 import type { TestRunnerEvents, TestSuiteResult } from './shared/test-runner.js';
 import type { TestCollectorEvents } from './shared/test-collector.js';
 import type { BundlerEvents } from './shared/bundler.js';
+import type { HarnessPlatform } from '@react-native-harness/platforms';
+export type FileReference = {
+    path: string;
+};
+export type ImageSnapshotOptions = {
+    /**
+     * The name of the snapshot. This is required and must be unique within the test.
+     */
+    name: string;
+    /**
+     * Comparison algorithm to use.
+     * @default 'pixelmatch'
+     */
+    comparisonMethod?: 'pixelmatch' | 'ssim';
+    /**
+     * Matching threshold for pixelmatch, ranges from 0 to 1. Smaller values make the comparison more sensitive.
+     * @default 0.1
+     */
+    threshold?: number;
+    /**
+     * Threshold for test failure.
+     */
+    failureThreshold?: number;
+    /**
+     * Type of failure threshold.
+     * @default 'pixel'
+     */
+    failureThresholdType?: 'pixel' | 'percent';
+    /**
+     * Minimum similarity score for SSIM comparison (0-1).
+     * @default 0.95
+     */
+    ssimThreshold?: number;
+    /**
+     * Regions to ignore during comparison.
+     */
+    ignoreRegions?: Array<{
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }>;
+    /**
+     * If true, disables detecting and ignoring anti-aliased pixels.
+     * @default false
+     */
+    includeAA?: boolean;
+    /**
+     * Blending factor of unchanged pixels in the diff output.
+     * Ranges from 0 for pure white to 1 for original brightness
+     * @default 0.1
+     */
+    alpha?: number;
+    /**
+     * The color of differing pixels in the diff output.
+     * @default [255, 0, 0]
+     */
+    diffColor?: [number, number, number];
+    /**
+     * An alternative color to use for dark on light differences to differentiate between "added" and "removed" parts.
+     * If not provided, all differing pixels use the color specified by `diffColor`.
+     * @default null
+     */
+    diffColorAlt?: [number, number, number];
+};
 export type { TestCollectorEvents, TestCollectionStartedEvent, TestCollectionFinishedEvent, TestSuite, TestCase, CollectionResult, } from './shared/test-collector.js';
 export type { TestRunnerEvents, TestRunnerFileStartedEvent, TestRunnerFileFinishedEvent, TestRunnerSuiteStartedEvent, TestRunnerTestStartedEvent, TestRunnerTestFinishedEvent, TestRunnerSuiteFinishedEvent, TestSuiteResult, TestResult, TestResultStatus, SerializedError, CodeFrame, } from './shared/test-runner.js';
 export type { ModuleBundlingStartedEvent, ModuleBundlingFinishedEvent, ModuleBundlingFailedEvent, SetupFileBundlingStartedEvent, SetupFileBundlingFinishedEvent, SetupFileBundlingFailedEvent, BundlerEvents, } from './shared/bundler.js';
-export { DeviceNotRespondingError } from './errors.js';
 export type DeviceDescriptor = {
     platform: 'ios' | 'android' | 'vega';
     manufacturer: string;
@@ -21,12 +85,31 @@ export type TestExecutionOptions = {
     testNamePattern?: string;
     setupFiles?: string[];
     setupFilesAfterEnv?: string[];
+    runner: string;
 };
 export type BridgeClientFunctions = {
-    runTests: (path: string, options?: TestExecutionOptions) => Promise<TestSuiteResult>;
+    runTests: (path: string, options: TestExecutionOptions) => Promise<TestSuiteResult>;
 };
+export type BinaryDataReference = {
+    type: 'binary';
+    transferId: number;
+    size: number;
+    mimeType: 'image/png';
+};
+export type ScreenshotData = BinaryDataReference;
 export type BridgeServerFunctions = {
     reportReady: (device: DeviceDescriptor) => void;
     emitEvent: <TEvent extends BridgeEvents>(event: TEvent['type'], data: TEvent) => void;
+    'device.screenshot.receive': (reference: BinaryDataReference, metadata: {
+        width: number;
+        height: number;
+    }) => Promise<FileReference>;
+    'test.matchImageSnapshot': (screenshot: FileReference, testPath: string, options: ImageSnapshotOptions, runner: string) => Promise<{
+        pass: boolean;
+        message: string;
+    }>;
+};
+export type HarnessContext = {
+    platform: HarnessPlatform;
 };
 //# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,YAAY,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,2BAA2B,EAC3B,SAAS,EACT,QAAQ,EACR,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,eAAe,EACf,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,GACV,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC9B,4BAA4B,EAC5B,aAAa,GACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,mBAAmB,GACnB,gBAAgB,GAChB,aAAa,CAAC;AAElB,MAAM,MAAM,eAAe,GAAG;KAC3B,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAC3B,KAAK,EAAE,OAAO,CAAC,YAAY,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KACtC,IAAI;CACV,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,oBAAoB,KAC3B,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAChD,SAAS,EAAE,CAAC,MAAM,SAAS,YAAY,EACrC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,MAAM,KACT,IAAI,CAAC;CACX,CAAC"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAEvE,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACzC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC,CAAC;AAEF,YAAY,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,2BAA2B,EAC3B,SAAS,EACT,QAAQ,EACR,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,eAAe,EACf,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,GACV,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC9B,4BAA4B,EAC5B,aAAa,GACd,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GACpB,mBAAmB,GACnB,gBAAgB,GAChB,aAAa,CAAC;AAElB,MAAM,MAAM,eAAe,GAAG;KAC3B,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG,CAC3B,KAAK,EAAE,OAAO,CAAC,YAAY,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KACtC,IAAI;CACV,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,oBAAoB,KAC1B,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAChD,SAAS,EAAE,CAAC,MAAM,SAAS,YAAY,EACrC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EACrB,IAAI,EAAE,MAAM,KACT,IAAI,CAAC;IACV,2BAA2B,EAAE,CAC3B,SAAS,EAAE,mBAAmB,EAC9B,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KACxC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5B,yBAAyB,EAAE,CACzB,UAAU,EAAE,aAAa,EACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,oBAAoB,EAC7B,MAAM,EAAE,MAAM,KACX,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC"}

package/dist/shared.js

@@ -1 +1 @@
-export { DeviceNotRespondingError } from './errors.js';
+export {};