@react-native-harness/ui 1.0.0-alpha.22

package/HarnessUI.podspec

@@ -0,0 +1,20 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "HarnessUI"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :git => "https://github.com/callstackincubator/react-native-harness.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
+  s.private_header_files = "ios/**/*.h"
+
+  install_modules_dependencies(s)
+end

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 Callstack
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,164 @@
+![harness-banner](https://react-native-harness.dev/harness-banner.jpg)
+
+### Native UI Testing Module for React Native Harness
+
+[![mit licence][license-badge]][license]
+[![npm downloads][npm-downloads-badge]][npm-downloads]
+[![Chat][chat-badge]][chat]
+[![PRs Welcome][prs-welcome-badge]][prs-welcome]
+
+Native UI testing module for React Native Harness that provides view queries and touch simulation capabilities. This module enables finding UI elements and simulating user interactions in your React Native tests.
+
+## Features
+
+- **View Queries**: Find elements by testID or accessibility label
+- **Touch Simulation**: Simulate user presses and text input
+- **Screenshot Capture**: Capture screenshots of the entire screen or specific elements
+- **Debug-Only**: Automatically excluded from release builds, only available in debug builds
+
+## Installation
+
+```bash
+npm install @react-native-harness/ui
+# or
+pnpm add @react-native-harness/ui
+# or
+yarn add @react-native-harness/ui
+```
+
+## Usage
+
+Import the UI testing utilities in your test files:
+
+```javascript
+import { screen, userEvent } from '@react-native-harness/ui';
+
+describe('My Component', () => {
+  it('should handle user interactions', async () => {
+    // Find elements on screen
+    const button = await screen.findByTestId('my-button');
+    const input = await screen.findByAccessibilityLabel('Username input');
+
+    // Simulate user interactions
+    await userEvent.type(input, 'testuser');
+    await userEvent.press(button);
+
+    // Take screenshots for debugging
+    const screenshot = await screen.screenshot();
+  });
+});
+```
+
+## API
+
+### `screen`
+
+Provides methods to query and interact with UI elements on screen.
+
+#### `findByTestId(testId: string): Promise<ElementReference>`
+
+Finds an element by its testID (accessibilityIdentifier on iOS, tag on Android).
+Throws an error if no element is found.
+
+#### `findAllByTestId(testId: string): Promise<ElementReference[]>`
+
+Finds all elements by testID. Throws an error if no elements are found.
+
+#### `queryByTestId(testId: string): ElementReference | null`
+
+Queries for an element by testID without throwing. Returns null if not found.
+
+#### `queryAllByTestId(testId: string): ElementReference[]`
+
+Queries for all elements by testID without throwing. Returns an empty array if none found.
+
+#### `findByAccessibilityLabel(label: string): Promise<ElementReference>`
+
+Finds an element by its accessibility label. Throws an error if no element is found.
+
+#### `findAllByAccessibilityLabel(label: string): Promise<ElementReference[]>`
+
+Finds all elements by accessibility label. Throws an error if no elements are found.
+
+#### `queryByAccessibilityLabel(label: string): ElementReference | null`
+
+Queries for an element by accessibility label without throwing. Returns null if not found.
+
+#### `queryAllByAccessibilityLabel(label: string): ElementReference[]`
+
+Queries for all elements by accessibility label without throwing. Returns an empty array if none found.
+
+#### `screenshot(element?: ElementReference): Promise<ScreenshotResult | null>`
+
+Captures a screenshot of the entire app window or a specific element.
+Returns a ScreenshotResult with PNG data, or null if capture fails.
+
+### `userEvent`
+
+Provides methods to simulate user interactions.
+
+#### `press(element: ElementReference): Promise<void>`
+
+Simulates a press on the given element at its center point.
+
+#### `pressAt(x: number, y: number): Promise<void>`
+
+Simulates a press at the specified screen coordinates.
+
+#### `type(element: ElementReference, text: string, options?: TypeOptions): Promise<void>`
+
+Simulates typing text into a text input element. Focuses the element, types each character, and blurs the element.
+
+**TypeOptions:**
+- `skipPress?: boolean` - If true, pressIn and pressOut events will not be triggered
+- `skipBlur?: boolean` - If true, endEditing and blur events will not be triggered
+- `submitEditing?: boolean` - If true, submitEditing event will be triggered after typing
+
+## Types
+
+### `ElementReference`
+
+Represents an element found on screen with its position and dimensions.
+
+```typescript
+type ElementReference = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  // ... additional view info
+};
+```
+
+### `ScreenshotResult`
+
+Screenshot result containing PNG image data.
+
+```typescript
+interface ScreenshotResult {
+  data: Uint8Array;  // PNG image data
+  width: number;     // Width in logical pixels
+  height: number;    // Height in logical pixels
+}
+```
+
+## Requirements
+
+- React Native project with React Native Harness configured
+- This module is only available in debug builds and is automatically excluded from release builds
+
+## Made with ❤️ at Callstack
+
+`@react-native-harness/ui` is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack][callstack-readme-with-love] is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!
+
+Like the project? ⚛️ [Join the team](https://callstack.com/careers/?utm_campaign=Senior_RN&utm_source=github&utm_medium=readme) who does amazing stuff for clients and drives React Native Open Source! 🔥
+
+[callstack-readme-with-love]: https://callstack.com/?utm_source=github.com&utm_medium=referral&utm_campaign=react-native-harness&utm_term=readme-with-love
+[license-badge]: https://img.shields.io/npm/l/@react-native-harness/ui?style=for-the-badge
+[license]: https://github.com/callstackincubator/react-native-harness/blob/main/LICENSE
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@react-native-harness/ui?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@react-native-harness/ui
+[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-welcome]: ../../CONTRIBUTING.md
+[chat-badge]: https://img.shields.io/discord/426714625279524876.svg?style=for-the-badge
+[chat]: https://discord.gg/xgGt7KAjxv

package/android/build.gradle

@@ -0,0 +1,77 @@
+buildscript {
+  ext.getExtOrDefault = {name ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['HarnessUI_' + name]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.2"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+  }
+}
+
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+apply plugin: "com.facebook.react"
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["HarnessUI_" + name]).toInteger()
+}
+
+android {
+  namespace "com.harnessui"
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs += [
+        "generated/java",
+        "generated/jni"
+      ]
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+HarnessUI_kotlinVersion=2.0.21
+HarnessUI_minSdkVersion=24
+HarnessUI_targetSdkVersion=34
+HarnessUI_compileSdkVersion=35
+HarnessUI_ndkVersion=27.1.12297006

package/android/src/main/java/com/harnessui/HarnessUIModule.kt

@@ -0,0 +1,53 @@
+package com.harnessui
+
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.bridge.WritableArray
+import com.facebook.react.bridge.WritableMap
+import com.facebook.react.module.annotations.ReactModule
+
+/**
+ * TurboModule for HarnessUI - provides UI testing capabilities.
+ * Includes touch simulation and view querying.
+ */
+@ReactModule(name = HarnessUIModule.NAME)
+class HarnessUIModule(reactContext: ReactApplicationContext) :
+    NativeHarnessUISpec(reactContext) {
+
+    companion object {
+        const val NAME = "HarnessUI"
+    }
+
+    private val helper = UIHelperImpl(reactContext)
+
+    override fun getName(): String = NAME
+
+    override fun simulatePress(x: Double, y: Double, promise: Promise) {
+        helper.simulatePress(x, y, promise)
+    }
+
+    override fun queryByTestId(testId: String): WritableMap? =
+        helper.queryByTestId(testId)
+
+    override fun queryByAccessibilityLabel(label: String): WritableMap? =
+        helper.queryByAccessibilityLabel(label)
+
+    override fun queryAllByTestId(testId: String): WritableArray =
+        helper.queryAllByTestId(testId)
+
+    override fun queryAllByAccessibilityLabel(label: String): WritableArray =
+        helper.queryAllByAccessibilityLabel(label)
+
+    override fun captureScreenshot(bounds: ReadableMap?, promise: Promise) {
+        helper.captureScreenshot(bounds, promise)
+    }
+
+    override fun typeChar(character: String, promise: Promise) {
+        helper.typeChar(character, promise)
+    }
+
+    override fun blur(options: ReadableMap, promise: Promise) {
+        helper.blur(options, promise)
+    }
+}

package/android/src/main/java/com/harnessui/HarnessUIPackage.kt

@@ -0,0 +1,33 @@
+package com.harnessui
+
+import com.facebook.react.BaseReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import java.util.HashMap
+
+class HarnessUIPackage : BaseReactPackage() {
+  override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+    return if (name == HarnessUIModule.NAME) {
+      HarnessUIModule(reactContext)
+    } else {
+      null
+    }
+  }
+
+  override fun getReactModuleInfoProvider(): ReactModuleInfoProvider {
+    return ReactModuleInfoProvider {
+      val moduleInfos: MutableMap<String, ReactModuleInfo> = HashMap()
+      moduleInfos[HarnessUIModule.NAME] = ReactModuleInfo(
+        HarnessUIModule.NAME,
+        HarnessUIModule.NAME,
+        false,  // canOverrideExistingModule
+        false,  // needsEagerInit
+        false,  // isCxxModule
+        true // isTurboModule
+      )
+      moduleInfos
+    }
+  }
+}