feat: move rqdata to HCaptchaVerifyParams and deprecate in HCaptchaConfig

alexbabrykovich · alexbabrykovich · commit 3ebe84e12901 · 2025-10-08T19:59:11.000+02:00
diff --git a/Example/HCaptcha_Tests/Core/HCaptchaVerifyParams__Tests.swift b/Example/HCaptcha_Tests/Core/HCaptchaVerifyParams__Tests.swift
@@ -63,52 +63,71 @@ class HCaptchaVerifyParams__Tests: XCTestCase {
         XCTAssertTrue(params.resetOnError)
     }
 
-    func test__init__withResetOnError() {
+    func test__init__withRqdata() {
         // Given
-        let phonePrefix = "44"
-        let resetOnError = false
+        let rqdata = "test-rqdata-string"
 
         // When
-        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, resetOnError: resetOnError)
+        let params = HCaptchaVerifyParams(rqdata: rqdata)
 
         // Then
-        XCTAssertEqual(params.phonePrefix, phonePrefix)
+        XCTAssertNil(params.phonePrefix)
         XCTAssertNil(params.phoneNumber)
-        XCTAssertFalse(params.resetOnError)
+        XCTAssertEqual(params.rqdata, rqdata)
+        XCTAssertTrue(params.resetOnError)
     }
 
     func test__init__withAllValues() {
         // Given
         let phonePrefix = "44"
         let phoneNumber = "1234567890"
+        let rqdata = "test-rqdata-string"
         let resetOnError = false
 
         // When
-        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, resetOnError: resetOnError)
+        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, rqdata: rqdata, resetOnError: resetOnError)
 
         // Then
         XCTAssertEqual(params.phonePrefix, phonePrefix)
         XCTAssertEqual(params.phoneNumber, phoneNumber)
+        XCTAssertEqual(params.rqdata, rqdata)
+        XCTAssertFalse(params.resetOnError)
+    }
+
+    func test__init__withResetOnError() {
+        // Given
+        let phonePrefix = "44"
+        let resetOnError = false
+
+        // When
+        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, resetOnError: resetOnError)
+
+        // Then
+        XCTAssertEqual(params.phonePrefix, phonePrefix)
+        XCTAssertNil(params.phoneNumber)
         XCTAssertFalse(params.resetOnError)
     }
 
+
     // MARK: - toDictionary Tests
 
     func test__toDictionary__withAllValues() {
         // Given
         let phonePrefix = "44"
         let phoneNumber = "1234567890"
+        let rqdata = "test-rqdata"
         let resetOnError = false
-        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, resetOnError: resetOnError)
+        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, rqdata: rqdata, resetOnError: resetOnError)
 
         // When
         let dict = params.toDictionary()
 
         // Then
         XCTAssertEqual(dict["phonePrefix"] as? String, phonePrefix)
         XCTAssertEqual(dict["phoneNumber"] as? String, phoneNumber)
+        XCTAssertEqual(dict["rqdata"] as? String, rqdata)
         XCTAssertEqual(dict["resetOnError"] as? Bool, resetOnError)
-        XCTAssertEqual(dict.count, 3)
+        XCTAssertEqual(dict.count, 4)
     }
 
     func test__toDictionary__withPartialValues() {
@@ -156,14 +175,32 @@ class HCaptchaVerifyParams__Tests: XCTestCase {
         XCTAssertEqual(dict.count, 2)
     }
 
+    func test__toDictionary__withOnlyRqdata() {
+        // Given
+        let rqdata = "test-rqdata-string"
+        let resetOnError = false
+        let params = HCaptchaVerifyParams(rqdata: rqdata, resetOnError: resetOnError)
+
+        // When
+        let dict = params.toDictionary()
+
+        // Then
+        XCTAssertNil(dict["phonePrefix"])
+        XCTAssertNil(dict["phoneNumber"])
+        XCTAssertEqual(dict["rqdata"] as? String, rqdata)
+        XCTAssertEqual(dict["resetOnError"] as? Bool, resetOnError)
+        XCTAssertEqual(dict.count, 2)
+    }
+
     // MARK: - toJSONString Tests
 
     func test__toJSONString__validJSON() {
         // Given
         let phonePrefix = "44"
         let phoneNumber = "1234567890"
+        let rqdata = "test-rqdata"
         let resetOnError = false
-        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, resetOnError: resetOnError)
+        let params = HCaptchaVerifyParams(phonePrefix: phonePrefix, phoneNumber: phoneNumber, rqdata: rqdata, resetOnError: resetOnError)
 
         // When
         let jsonString = params.toJSONString()
@@ -176,6 +213,7 @@ class HCaptchaVerifyParams__Tests: XCTestCase {
         let json = try! JSONSerialization.jsonObject(with: data) as! [String: Any]
         XCTAssertEqual(json["phonePrefix"] as? String, phonePrefix)
         XCTAssertEqual(json["phoneNumber"] as? String, phoneNumber)
+        XCTAssertEqual(json["rqdata"] as? String, rqdata)
         XCTAssertEqual(json["resetOnError"] as? Bool, resetOnError)
     }
 
diff --git a/Example/HCaptcha_Tests/Core/HCaptchaWebViewManager__Tests.swift b/Example/HCaptcha_Tests/Core/HCaptchaWebViewManager__Tests.swift
@@ -787,6 +787,22 @@ class HCaptchaWebViewManager__Tests: XCTestCase {
         XCTAssertTrue(rawValue.hasSuffix(");"))
     }
 
+    func test__JSCommand_execute__withRqdata() {
+        // Given
+        let rqdata = "test-rqdata-string"
+        let verifyParams = HCaptchaVerifyParams(rqdata: rqdata, resetOnError: false)
+        let command = HCaptchaWebViewManager.JSCommand.execute(verifyParams)
+
+        // When
+        let rawValue = command.rawValue
+
+        // Then
+        XCTAssertTrue(rawValue.contains("execute("))
+        XCTAssertTrue(rawValue.contains("\"rqdata\":\"test-rqdata-string\""))
+        XCTAssertTrue(rawValue.contains("\"resetOnError\":false"))
+        XCTAssertTrue(rawValue.hasSuffix(");"))
+    }
+
     func test__JSCommand_reset() {
         // Given
         let command = HCaptchaWebViewManager.JSCommand.reset
diff --git a/Example/HCaptcha_Tests/Core/HCaptcha__Tests.swift b/Example/HCaptcha_Tests/Core/HCaptcha__Tests.swift
@@ -214,6 +214,24 @@ class HCaptcha__Tests: XCTestCase {
         wait(for: [exp], timeout: TestTimeouts.standard)
     }
 
+    func test__validate__withVerifyParams__rqdata() {
+        // Given
+        let exp = expectation(description: "validate with rqdata")
+        let rqdata = "test-rqdata-string"
+        let verifyParams = HCaptchaVerifyParams(rqdata: rqdata)
+        let hcaptcha = HCaptcha(manager: HCaptchaWebViewManager(messageBody: "{token: \"test_token\"}"))
+
+        // When
+        let view = UIApplication.shared.windows.first?.rootViewController?.view
+        hcaptcha.validate(on: view, verifyParams: verifyParams) { result in
+            // Then
+            XCTAssertEqual(result.token, "test_token")
+            exp.fulfill()
+        }
+
+        wait(for: [exp], timeout: TestTimeouts.standard)
+    }
+
     func test__validate__withVerifyParams__resetOnErrorFalse() {
         // Given
         let exp = expectation(description: "validate with resetOnError false")
diff --git a/Example/RxSwift-Example/ViewController.swift b/Example/RxSwift-Example/ViewController.swift
@@ -15,11 +15,6 @@ import WebKit
 class ViewController: BaseViewController {
     var disposeBag = DisposeBag()
 
-    // Phone input UI elements - connected from storyboard
-    @IBOutlet weak var phoneTextField: UITextField!
-    @IBOutlet weak var phoneModeSwitch: UISwitch!
-    @IBOutlet weak var phoneModeLabel: UILabel!
-
     @IBAction private func didPressVerifyButton(button: UIButton) {
         disposeBag = DisposeBag()
 
@@ -34,7 +29,7 @@ class ViewController: BaseViewController {
             let verifyParams: HCaptchaVerifyParams
             if phoneModeSwitch.isOn {
                 // Phone number mode
-                verifyParams = HCaptchaVerifyParams(phoneNumber: phoneText)
+                verifyParams = HCaptchaVerifyParams(phoneNumber: phoneText, rqdata: "some_rq")
             } else {
                 // Phone prefix mode
                 verifyParams = HCaptchaVerifyParams(phonePrefix: phoneText)
@@ -94,29 +89,6 @@ class ViewController: BaseViewController {
             .disposed(by: disposeBag)
     }
 
-    override func viewDidLoad() {
-        super.viewDidLoad()
-        setupPhoneInputUI()
-    }
-
-    private func setupPhoneInputUI() {
-        // Configure initial state
-        phoneModeLabel.text = "Prefix"
-        phoneTextField.placeholder = "Enter phone prefix (e.g., 44)"
-        phoneTextField.keyboardType = .numberPad
-    }
-
-    @IBAction private func phoneModeChanged(_ sender: UISwitch) {
-        if phoneModeSwitch.isOn {
-            phoneModeLabel.text = "Phone"
-            phoneTextField.placeholder = "Enter phone number (e.g., +1234567890)"
-            phoneTextField.keyboardType = .phonePad
-        } else {
-            phoneModeLabel.text = "Prefix"
-            phoneTextField.placeholder = "Enter phone prefix (e.g., 44)"
-            phoneTextField.keyboardType = .numberPad
-        }
-    }
 
     override func setupHCaptcha() {
         // swiftlint:disable:next force_try
diff --git a/Example/Shared/BaseViewController.swift b/Example/Shared/BaseViewController.swift
@@ -20,16 +20,52 @@ class BaseViewController: UIViewController {
     @IBOutlet weak var localeSegmentedControl: UISegmentedControl!
     @IBOutlet weak var validateButton: UIButton!
     @IBOutlet weak var resetButton: UIButton!
+    
+    // Phone input UI elements - connected from storyboard
+    @IBOutlet weak var phoneTextField: UITextField!
+    @IBOutlet weak var phoneModeSwitch: UISwitch!
+    @IBOutlet weak var phoneModeLabel: UILabel!
 
     var hcaptcha: HCaptcha!
     var locale: Locale?
 
     override func viewDidLoad() {
         super.viewDidLoad()
+        setupPhoneInputUI()
+        setupToolbar()
         if !Bundle.main.bundlePath.contains("Tests") {
             setupHCaptcha()
         }
     }
+    
+    private func setupToolbar() {
+        let toolbar = UIToolbar()
+        toolbar.sizeToFit()
+        let done = UIBarButtonItem(title: "Done", style: .plain, target: self, action: #selector(doneTapped))
+        toolbar.items = [done]
+        phoneTextField.inputAccessoryView = toolbar
+    }
+    
+    @objc private func doneTapped() {
+        phoneTextField.resignFirstResponder()
+    }
+    
+    private func setupPhoneInputUI() {
+        phoneModeSwitch.isOn = false
+        phoneModeChanged(phoneModeSwitch)
+    }
+    
+    @IBAction func phoneModeChanged(_ sender: UISwitch) {
+        if sender.isOn {
+            phoneModeLabel.text = "Number"
+            phoneTextField.placeholder = "Enter phone number (e.g., +1234567890)"
+            phoneTextField.keyboardType = .phonePad
+        } else {
+            phoneModeLabel.text = "Prefix"
+            phoneTextField.placeholder = "Enter prefix (e.g., 44)"
+            phoneTextField.keyboardType = .numberPad
+        }
+    }
 
     @IBAction func didPressLocaleSegmentedControl(_ sender: UISegmentedControl) {
         label.text = ""
diff --git a/Example/UIKit-Example/ViewController.swift b/Example/UIKit-Example/ViewController.swift
@@ -12,11 +12,6 @@ import WebKit
 class ViewController: BaseViewController {
     private var challengeShown: Bool = false
 
-    // Phone input UI elements - connected from storyboard
-    @IBOutlet weak var phoneTextField: UITextField!
-    @IBOutlet weak var phoneModeSwitch: UISwitch!
-    @IBOutlet weak var phoneModeLabel: UILabel!
-
     @IBAction private func didPressVerifyButton(button: UIButton) {
         // Check if we should use verify params
         if let phoneText = phoneTextField.text, !phoneText.isEmpty {
@@ -53,29 +48,6 @@ class ViewController: BaseViewController {
         self.challengeShown = false
     }
 
-    override func viewDidLoad() {
-        super.viewDidLoad()
-        setupPhoneInputUI()
-    }
-
-    private func setupPhoneInputUI() {
-        // Configure initial state
-        phoneModeLabel.text = "Prefix"
-        phoneTextField.placeholder = "Enter prefix (e.g., 44)"
-        phoneTextField.keyboardType = .numberPad
-    }
-
-    @IBAction private func phoneModeChanged(_ sender: UISwitch) {
-        if phoneModeSwitch.isOn {
-            phoneModeLabel.text = "Phone"
-            phoneTextField.placeholder = "Enter phone (e.g., +1234567890)"
-            phoneTextField.keyboardType = .phonePad
-        } else {
-            phoneModeLabel.text = "Prefix"
-            phoneTextField.placeholder = "Enter prefix (e.g., 44)"
-            phoneTextField.keyboardType = .numberPad
-        }
-    }
 
     override func setupHCaptcha() {
         // swiftlint:disable:next force_try
diff --git a/HCaptcha/Assets/hcaptcha.html b/HCaptcha/Assets/hcaptcha.html
@@ -42,30 +42,22 @@
         window.webkit.messageHandlers.hcaptcha.postMessage(value);
       };
 
-      var getExecuteOpts = function() {
-        var opts;
-        var rqdata = "${rqdata}";
-        if (rqdata) {
-          opts = {'rqdata': rqdata};
-        }
-        return opts;
-      };
-
       console.log = function(message) {
         post({ log: message });
       };
 
       var setVerifyParams = function(params) {
+        console.log("setting verify params:", params);
         try {
-          console.log("setting verify params:", params);
-
           var phone = params.phoneNumber || params.mfa_phone;
           var prefix = params.phonePrefix || params.mfa_phoneprefix;
+          var rqdata = params.rqdata || "${rqdata}";
 
-          if (phone || prefix) {
+          if (phone || prefix || rqdata) {
             var data = {};
             if (phone) data.mfa_phone = phone;
             if (prefix) data.mfa_phoneprefix = prefix;
+            if (rqdata) data.rqdata = rqdata;
 
             if (window.hCaptchaID) {
               hcaptcha.setData(window.hCaptchaID, data);
@@ -87,7 +79,7 @@
           }
 
           if ("${size}" === 'invisible') {
-            hcaptcha.execute(getExecuteOpts());
+            hcaptcha.execute();
           } else {
             post({ action: "showHCaptcha" });
           }
diff --git a/HCaptcha/Classes/HCaptchaConfig.swift b/HCaptcha/Classes/HCaptchaConfig.swift
@@ -101,6 +101,8 @@ struct HCaptchaConfig: CustomDebugStringConvertible {
     let jsSrc: URL
 
     /// Custom supplied challenge data
+    /// - warning: Deprecated. Use `rqdata` in `HCaptchaVerifyParams` instead.
+    @available(*, deprecated, message: "Use rqdata in HCaptchaVerifyParams instead")
     let rqdata: String?
 
     /// Enable / Disable sentry error reporting.
diff --git a/HCaptcha/Classes/HCaptchaHtml.swift b/HCaptcha/Classes/HCaptchaHtml.swift
diff --git a/HCaptcha/Classes/HCaptchaVerifyParams.swift b/HCaptcha/Classes/HCaptchaVerifyParams.swift
