npm package: @rpascene/ios
Description: RPA iOS automation library for Rpascene
Latest version: 0.30.18

# @rpascene/ios

iOS automation library for Rpascene, providing AI-powered testing and automation capabilities for iOS simulators and devices.

## Features

- 🎯 **iOS Simulator Support** - Full automation support for iOS simulators
- 🤖 **AI-Powered Actions** - Intelligent element detection and interaction
- 📱 **Native iOS Actions** - Home button, app switcher, and iOS-specific gestures
- 🔧 **Simple API** - Easy-to-use interface similar to @rpascene/android
- 📸 **Screenshot Capture** - Built-in screenshot functionality
- ⌨️ **Text Input** - Support for text input including non-ASCII characters
- 🎮 **Gesture Support** - Tap, swipe, long press, and custom gestures

## Prerequisites

- **macOS** (required for iOS development)
- **Xcode** and Xcode Command Line Tools
- **iOS Simulator** or physical iOS device
- **WebDriverAgent** (required for automation)

### Environment Setup

```bash
# Install Xcode Command Line Tools
xcode-select --install

# Verify simctl is available
xcrun simctl list devices

# Install WebDriverAgent dependency
npm install appium-webdriveragent
```

### WebDriverAgent Setup

Rpascene iOS uses WebDriverAgent for device automation. You need to prepare WebDriverAgent before using the library:

#### For iOS Simulators

1. **Install WebDriverAgent dependency:**
   ```bash
   npm install appium-webdriveragent
   ```

2. **Build and start WebDriverAgent:**
   ```bash
   # Navigate to WebDriverAgent project
   cd node_modules/appium-webdriveragent
   
   # Build and run for simulator
   xcodebuild -project WebDriverAgent.xcodeproj \
             -scheme WebDriverAgentRunner \
             -destination 'platform=iOS Simulator,name=iPhone 15' \
             test
   ```

#### For Physical iOS Devices

1. **Configure Development Team:**
   - Open `node_modules/appium-webdriveragent/WebDriverAgent.xcodeproj` in Xcode
   - Select your Development Team for both `WebDriverAgentLib` and `WebDriverAgentRunner` targets
   - Ensure proper code signing is configured

2. **Build and deploy to device:**
   ```bash
   # Replace DEVICE_UDID with your device's UDID
   xcodebuild -project WebDriverAgent.xcodeproj \
             -scheme WebDriverAgentRunner \
             -destination 'id=YOUR_DEVICE_UDID' \
             test
   ```

3. **Trust Developer Certificate:**
   - On your iOS device, go to Settings > General > VPN & Device Management
   - Trust your developer certificate

4. **Set up port forwarding (for real devices):**
   ```bash
   # Install iproxy (if needed)
   brew install libimobiledevice
   
   # Forward local port 8100 to device port 8100
   iproxy -u YOUR_DEVICE_ID 8100:8100
   ```

#### Alternative Setup Methods

For more advanced setup options and troubleshooting, refer to the official WebDriverAgent documentation:
**📖 [WebDriverAgent Setup Guide](https://appium.github.io/appium-xcuitest-driver/4.25/wda-custom-server/)**

> **⚠️ Important:** WebDriverAgent must be running on port 8100 (default) before using Rpascene iOS. If WebDriverAgent is not detected, you'll receive setup instructions.

## Installation

```bash
npm install @rpascene/ios
# or
pnpm add @rpascene/ios
```

## Quick Start

### Basic Usage (Recommended)

```typescript
import { agentFromWebDriverAgent } from '@rpascene/ios';

// Connect to WebDriverAgent (auto-detects device)
const agent = await agentFromWebDriverAgent();

// Launch an app
await agent.launch('com.apple.MobileSafari');

// Perform AI-powered actions
await agent.aiAction('tap on the address bar');
await agent.aiAction('type "https://example.com"');
await agent.aiAction('tap the go button');
```

### Using Custom WebDriverAgent Configuration

```typescript
import { agentFromWebDriverAgent } from '@rpascene/ios';

// Connect to WebDriverAgent on custom host/port
const agent = await agentFromWebDriverAgent({
  wdaHost: 'localhost',
  wdaPort: 8100,  // Custom port
  aiActionContext: 'If any popup appears, click agree',
});

// Launch app and interact
await agent.launch('com.yourapp.bundleid');
await agent.aiAction('tap the login button');
```

## API Reference

### IOSDevice

Core device automation class implementing the AbstractInterface.

```typescript
import { IOSDevice } from '@rpascene/ios';

// Create device (deviceId is auto-detected from WebDriverAgent)
const device = new IOSDevice({
  wdaHost: 'localhost',
  wdaPort: 8100,
});
await device.connect();

// Basic interactions
await device.tap(100, 200);
await device.swipe(100, 200, 300, 400);
await device.typeText('Hello World');
await device.pressKey('Enter');

// iOS-specific actions
await device.home();
await device.appSwitcher();
await device.longPress(150, 300, 1000);

// Screenshots
const screenshot = await device.screenshotBase64();

// Cleanup
await device.destroy();
```

### IOSAgent

High-level agent for AI-powered automation.

```typescript
import { IOSAgent, agentFromWebDriverAgent } from '@rpascene/ios';

// Recommended approach
const agent = await agentFromWebDriverAgent();

// AI actions
await agent.aiAction('tap the settings icon');
await agent.aiQuery('what is the current battery level?');
await agent.aiWaitFor('the page is loaded');

// App management
await agent.launch('com.apple.Preferences');
```

### Utility Functions

```typescript
import {
  checkIOSEnvironment,
  ensureSimulatorBooted,
  // Note: getConnectedDevices and getDefaultDevice are deprecated
  // Use agentFromWebDriverAgent() instead
} from '@rpascene/ios';

// Environment check
const envStatus = await checkIOSEnvironment();
console.log('iOS environment available:', envStatus.available);

// Simulator management (if needed)
await ensureSimulatorBooted('simulator-udid');

// Simulator management
await ensureSimulatorBooted('device-udid');
```

## Configuration

Set environment variables for default behavior:

```bash
# Default device UDID
export MIDSCENE_IOS_DEVICE_UDID=your-device-udid

# Default simulator UDID
export MIDSCENE_IOS_SIMULATOR_UDID=your-simulator-udid
```

## Supported iOS Actions

### Basic Gestures
- `tap(x, y)` - Single tap at coordinates
- `doubleTap(x, y)` - Double tap at coordinates
- `longPress(x, y, duration)` - Long press with duration
- `swipe(fromX, fromY, toX, toY)` - Swipe gesture

### Text Input
- `typeText(text)` - Type text using iOS keyboard
- `pressKey(key)` - Press specific keys (Enter, Backspace, etc.)
- `clearInput(element)` - Clear input field

### Scrolling
- `scrollUp/Down/Left/Right(distance?, startPoint?)` - Directional scrolling
- `scrollUntilTop/Bottom/Left/Right(startPoint?)` - Scroll to extremes

### iOS System Actions
- `home()` - Press home button
- `appSwitcher()` - Open app switcher
- `hideKeyboard()` - Dismiss keyboard

### AI-Powered Actions
- `aiAction(instruction)` - Perform action based on natural language
- `aiQuery(question)` - Query UI state with natural language
- `aiWaitFor(condition)` - Wait for condition to be met

## Device Requirements

### iOS Simulators
- Managed through Xcode
- No additional setup required
- Supports all iOS versions available in Xcode

### Physical iOS Devices
- Requires iOS 9.0 or later
- Device must be in Developer Mode
- Requires valid provisioning profile for your apps

## Examples

### Complete Test Example

```typescript
import { describe, it } from 'vitest';
import { agentFromWebDriverAgent } from '@rpascene/ios';

describe('iOS App Test', () => {
  it('should login to app', async () => {
    // WebDriverAgent auto-detects the connected device
    const agent = await agentFromWebDriverAgent();
    
    // Launch your app
    await agent.launch('com.yourcompany.yourapp');
    
    // AI-powered login flow
    await agent.aiAction('tap on email field');
    await agent.aiAction('type "user@example.com"');
    await agent.aiAction('tap on password field');
    await agent.aiAction('type "password123"');
    await agent.aiAction('tap the login button');
    
    // Verify successful login
    await agent.aiWaitFor('dashboard is visible');
    
    const isLoggedIn = await agent.aiQuery('is the user logged in?');
    expect(isLoggedIn).toBe(true);
  });
});
```

## Troubleshooting

### Common Issues

1. **"No iOS devices available"**
   - Ensure Xcode is installed
   - Check `xcrun simctl list devices` shows available simulators
   - Try booting a simulator manually in Xcode

2. **"Command failed: xcrun simctl"**
   - Verify Xcode Command Line Tools are installed
   - Run `xcode-select --install` if needed
   - Check `which xcrun` returns a valid path

3. **Simulator not responding**
   - Restart the simulator
   - Try `xcrun simctl shutdown all && xcrun simctl boot <udid>`

4. **App launch fails**
   - Verify the bundle ID is correct
   - Ensure the app is installed on the simulator
   - Check app permissions and entitlements

### Debug Mode

Enable debug logging:

```typescript
process.env.DEBUG = 'ios:*';
```

## Contributing

1. Fork the repository
2. Create your feature branch
3. Add tests for new functionality
4. Ensure all tests pass
5. Submit a pull request

## License

MIT License - see LICENSE file for details.