@nyby/detox-component-testing 1.6.1 → 1.7.0

package/README.md

@@ -121,7 +121,7 @@ module.exports = {
   maxWorkers: 1,
   globalSetup: 'detox/runners/jest/globalSetup',
   globalTeardown: 'detox/runners/jest/globalTeardown',
-  testEnvironment: '@nyby/detox-component-testing/environment',
+  testEnvironment: 'detox/runners/jest/testEnvironment',
   setupFilesAfterEnv: ['./setup.ts'],
   testRunner: 'jest-circus/runner',
   testTimeout: 120000,
@@ -237,47 +237,6 @@ Returns an assertion object for a spy:
 - `.toHaveBeenCalledTimes(n)` — spy was called exactly `n` times
 - `.lastCalledWith(...args)` — the last call's arguments match
 
-#### `debug(label?, outputDir?)`
-
-Capture a screenshot and native view hierarchy for the current screen state. Useful for debugging test failures or inspecting what's on screen at any point in a test.
-
-```ts
-import {mount, debug} from '@nyby/detox-component-testing/test';
-
-it('renders the event screen', async () => {
-  await mount('EventScreen', {eventId: 'event_1'});
-  await debug('after-mount'); // writes to artifacts/debug-after-mount.{png,xml}
-});
-```
-
-Each call writes up to two files to the output directory (defaults to `<cwd>/artifacts`):
-
-- `debug-<label>.png` — screenshot
-- `debug-<label>-view.xml` — native view hierarchy
-
-If no label is provided, calls are numbered automatically (`1`, `2`, `3`, ...).
-
-### Debugging
-
-#### Custom test environment
-
-A Detox Jest environment that automatically captures debug artifacts when a test fails. Use it instead of the default Detox environment:
-
-```js
-// jest.config.js
-module.exports = {
-  testEnvironment: '@nyby/detox-component-testing/environment',
-  // ...
-};
-```
-
-On test failure, it captures:
-
-- A screenshot
-- The native view hierarchy
-
-All artifacts are written to `<cwd>/artifacts/`.
-
 ## Limitations
 
 - **No JSX in tests** — Tests run in Node.js, not the React Native runtime. You cannot import components or use JSX in test files. Reference components by their registered name string.

package/dist/test.d.ts

@@ -1,3 +1,2 @@
 export { mount, spy, expectSpy } from './mount';
-export { debug } from './debug';
 //# sourceMappingURL=test.d.ts.map

package/dist/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC"}

package/dist/test.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = exports.expectSpy = exports.spy = exports.mount = void 0;
+exports.expectSpy = exports.spy = exports.mount = void 0;
 var mount_1 = require("./mount");
 Object.defineProperty(exports, "mount", { enumerable: true, get: function () { return mount_1.mount; } });
 Object.defineProperty(exports, "spy", { enumerable: true, get: function () { return mount_1.spy; } });
 Object.defineProperty(exports, "expectSpy", { enumerable: true, get: function () { return mount_1.expectSpy; } });
-var debug_1 = require("./debug");
-Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return debug_1.debug; } });
 //# sourceMappingURL=test.js.map

package/dist/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;;AAAA,iCAA8C;AAAtC,8FAAA,KAAK,OAAA;AAAE,4FAAA,GAAG,OAAA;AAAE,kGAAA,SAAS,OAAA;AAC7B,iCAA8B;AAAtB,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;;AAAA,iCAA8C;AAAtC,8FAAA,KAAK,OAAA;AAAE,4FAAA,GAAG,OAAA;AAAE,kGAAA,SAAS,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nyby/detox-component-testing",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Component testing support for Detox and React Native",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,9 +12,6 @@
     "./test": {
       "types": "./dist/test.d.ts",
       "default": "./dist/test.js"
-    },
-    "./environment": {
-      "default": "./dist/environment.js"
     }
   },
   "typesVersions": {
@@ -29,7 +26,7 @@
     "src"
   ],
   "scripts": {
-    "build": "tsc && cp src/environment.js dist/environment.js",
+    "build": "tsc",
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run clean && npm run build",
     "publish:public": "npm publish --access public",

package/src/ComponentRegistry.ts

@@ -46,4 +46,4 @@ export function getComponent(name: string): ComponentEntry {
     );
   }
   return entry;
-}
+}

package/src/launch-arguments.d.ts

@@ -0,0 +1,5 @@
+declare module 'react-native-launch-arguments' {
+  export const LaunchArguments: {
+    value(): Record<string, any>;
+  };
+}

package/src/test.ts

@@ -1,2 +1 @@
 export {mount, spy, expectSpy} from './mount';
-export {debug} from './debug';

package/dist/debug.d.ts

@@ -1,10 +0,0 @@
-/**
- * Capture a screenshot and native view hierarchy to the given directory.
- * Used by both the `debug()` helper and the custom test environment.
- */
-export declare function captureArtifacts(name: string, outputDir: string, deviceRef: {
-    takeScreenshot: (n: string) => Promise<string>;
-    generateViewHierarchyXml: () => Promise<string>;
-}): Promise<void>;
-export declare function debug(label?: string, outputDir?: string): Promise<void>;
-//# sourceMappingURL=debug.d.ts.map

package/dist/debug.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE;IACT,cAAc,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,wBAAwB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACjD,iBAiBF;AAaD,wBAAsB,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,iBAI7D"}

package/dist/debug.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.captureArtifacts = captureArtifacts;
-exports.debug = debug;
-const fs_1 = require("fs");
-const path_1 = require("path");
-/**
- * Capture a screenshot and native view hierarchy to the given directory.
- * Used by both the `debug()` helper and the custom test environment.
- */
-async function captureArtifacts(name, outputDir, deviceRef) {
-    (0, fs_1.mkdirSync)(outputDir, { recursive: true });
-    // Screenshot via Detox, then move to our artifacts dir
-    try {
-        const tempPath = await deviceRef.takeScreenshot(`debug-${name}`);
-        if (tempPath) {
-            (0, fs_1.renameSync)(tempPath, (0, path_1.join)(outputDir, `debug-${name}.png`));
-        }
-    }
-    catch { }
-    // Native view hierarchy
-    try {
-        const xml = await deviceRef.generateViewHierarchyXml();
-        (0, fs_1.writeFileSync)((0, path_1.join)(outputDir, `debug-${name}-view.xml`), xml, 'utf8');
-    }
-    catch { }
-}
-/**
- * Capture a screenshot and native view hierarchy.
- * Drop this anywhere in a test to inspect the current screen state.
- *
- * Usage:
- *   import { debug } from '@nyby/detox-component-testing/test';
- *   await debug();              // artifacts/debug-1.png, debug-1-view.xml
- *   await debug('after-tap');   // artifacts/debug-after-tap.png, etc.
- */
-let counter = 0;
-async function debug(label, outputDir) {
-    const name = label || String(++counter);
-    const dir = outputDir || (0, path_1.join)(process.cwd(), 'artifacts');
-    await captureArtifacts(name, dir, device);
-}
-//# sourceMappingURL=debug.js.map

package/dist/debug.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debug.js","sourceRoot":"","sources":["../src/debug.ts"],"names":[],"mappings":";;AAOA,4CAuBC;AAaD,sBAIC;AA/CD,2BAAwD;AACxD,+BAA0B;AAE1B;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CACpC,IAAY,EACZ,SAAiB,EACjB,SAGC;IAED,IAAA,cAAS,EAAC,SAAS,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAExC,uDAAuD;IACvD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;QACjE,IAAI,QAAQ,EAAE,CAAC;YACb,IAAA,eAAU,EAAC,QAAQ,EAAE,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;IAEV,wBAAwB;IACxB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,wBAAwB,EAAE,CAAC;QACvD,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,IAAI,WAAW,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAAC,MAAM,CAAC,CAAA,CAAC;AACZ,CAAC;AAED;;;;;;;;GAQG;AACH,IAAI,OAAO,GAAG,CAAC,CAAC;AAET,KAAK,UAAU,KAAK,CAAC,KAAc,EAAE,SAAkB;IAC5D,MAAM,IAAI,GAAG,KAAK,IAAI,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,GAAG,GAAG,SAAS,IAAI,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,CAAC;IAC1D,MAAM,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AAC5C,CAAC"}

package/dist/environment.js

@@ -1,17 +0,0 @@
-const DetoxCircusEnvironment = require('detox/runners/jest/testEnvironment');
-const {join} = require('path');
-const {captureArtifacts} = require('./debug');
-
-class CustomDetoxEnvironment extends DetoxCircusEnvironment {
-  async handleTestEvent(event, state) {
-    await super.handleTestEvent(event, state);
-
-    if (event.name === 'test_done' && event.test.errors.length > 0) {
-      const safeName = event.test.name.replace(/[^a-zA-Z0-9_-]/g, '_');
-      const outputDir = join(process.cwd(), 'artifacts');
-      await captureArtifacts(safeName, outputDir, this.global.device);
-    }
-  }
-}
-
-module.exports = CustomDetoxEnvironment;

package/src/debug.ts

@@ -1,48 +0,0 @@
-import {mkdirSync, renameSync, writeFileSync} from 'fs';
-import {join} from 'path';
-
-/**
- * Capture a screenshot and native view hierarchy to the given directory.
- * Used by both the `debug()` helper and the custom test environment.
- */
-export async function captureArtifacts(
-  name: string,
-  outputDir: string,
-  deviceRef: {
-    takeScreenshot: (n: string) => Promise<string>;
-    generateViewHierarchyXml: () => Promise<string>;
-  },
-) {
-  mkdirSync(outputDir, {recursive: true});
-
-  // Screenshot via Detox, then move to our artifacts dir
-  try {
-    const tempPath = await deviceRef.takeScreenshot(`debug-${name}`);
-    if (tempPath) {
-      renameSync(tempPath, join(outputDir, `debug-${name}.png`));
-    }
-  } catch {}
-
-  // Native view hierarchy
-  try {
-    const xml = await deviceRef.generateViewHierarchyXml();
-    writeFileSync(join(outputDir, `debug-${name}-view.xml`), xml, 'utf8');
-  } catch {}
-}
-
-/**
- * Capture a screenshot and native view hierarchy.
- * Drop this anywhere in a test to inspect the current screen state.
- *
- * Usage:
- *   import { debug } from '@nyby/detox-component-testing/test';
- *   await debug();              // artifacts/debug-1.png, debug-1-view.xml
- *   await debug('after-tap');   // artifacts/debug-after-tap.png, etc.
- */
-let counter = 0;
-
-export async function debug(label?: string, outputDir?: string) {
-  const name = label || String(++counter);
-  const dir = outputDir || join(process.cwd(), 'artifacts');
-  await captureArtifacts(name, dir, device);
-}

package/src/environment.js

@@ -1,17 +0,0 @@
-const DetoxCircusEnvironment = require('detox/runners/jest/testEnvironment');
-const {join} = require('path');
-const {captureArtifacts} = require('./debug');
-
-class CustomDetoxEnvironment extends DetoxCircusEnvironment {
-  async handleTestEvent(event, state) {
-    await super.handleTestEvent(event, state);
-
-    if (event.name === 'test_done' && event.test.errors.length > 0) {
-      const safeName = event.test.name.replace(/[^a-zA-Z0-9_-]/g, '_');
-      const outputDir = join(process.cwd(), 'artifacts');
-      await captureArtifacts(safeName, outputDir, this.global.device);
-    }
-  }
-}
-
-module.exports = CustomDetoxEnvironment;