make API chainable

Author: lsoares

lib/src/main/kotlin/com/luissoares/JavaScriptScript.kt renamed to lib/src/main/kotlin/seleniumtestinglib/JavaScriptScript.kt

@@ -1,4 +1,4 @@
-package com.luissoares
+package seleniumtestinglib
 
 import org.openqa.selenium.JavascriptExecutor
 

lib/src/main/kotlin/com/luissoares/RemoteWebDriver.kt renamed to lib/src/main/kotlin/seleniumtestinglib/RemoteWebDriver.kt

@@ -1,4 +1,4 @@
-package com.luissoares
+package seleniumtestinglib
 
 import org.openqa.selenium.remote.RemoteWebDriver
 

lib/src/main/kotlin/com/luissoares/WebElement.kt renamed to lib/src/main/kotlin/seleniumtestinglib/WebElement.kt

@@ -1,4 +1,4 @@
-package com.luissoares
+package seleniumtestinglib
 
 import org.openqa.selenium.WebElement
 import org.openqa.selenium.remote.RemoteWebDriver

lib/src/main/kotlin/com/luissoares/interactions/Clipboard.kt renamed to lib/src/main/kotlin/seleniumtestinglib/interactions/Clipboard.kt

@@ -1,17 +1,20 @@
-package com.luissoares.interactions
+package seleniumtestinglib.interactions
 
 /**
  * https://testing-library.com/docs/user-event/clipboard
  */
-fun User.copy() {
+fun User.copy(): User {
     javascriptExecutor.executeScript("await user.copy()")
+    return this
 }
 
-fun User.cut() {
+fun User.cut(): User {
     javascriptExecutor.executeScript("await user.cut()")
+    return this
 }
 
 // TODO receive DataTransfer
-fun User.paste(clipboardData: String? = null) {
+fun User.paste(clipboardData: String? = null): User {
     javascriptExecutor.executeScript("await user.paste(arguments[0])", clipboardData)
+    return this
 }

lib/src/main/kotlin/com/luissoares/interactions/Keyboard.kt renamed to lib/src/main/kotlin/seleniumtestinglib/interactions/Keyboard.kt

@@ -1,15 +1,17 @@
-package com.luissoares.interactions
+package seleniumtestinglib.interactions
 
 /**
  * https://testing-library.com/docs/user-event/keyboard
  */
-fun User.keyboard(input: String) {
+fun User.keyboard(input: String): User {
     javascriptExecutor.executeScript("await user.keyboard(arguments[0])", input)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#tab
  */
-fun User.tab(shift: Boolean = false) {
+fun User.tab(shift: Boolean = false): User {
     javascriptExecutor.executeScript("await user.tab(arguments[0])", mapOf("shift" to shift))
+    return this
 }

lib/src/main/kotlin/com/luissoares/interactions/Pointer.kt renamed to lib/src/main/kotlin/seleniumtestinglib/interactions/Pointer.kt

@@ -1,55 +1,62 @@
-package com.luissoares.interactions
+package seleniumtestinglib.interactions
 
 import org.openqa.selenium.WebElement
 
 /**
  * https://testing-library.com/docs/user-event/pointer
  */
-fun User.pointer(vararg inputs: String) {
+fun User.pointer(vararg inputs: String): User {
     javascriptExecutor.executeScript("await user.pointer(arguments[0])", inputs)
+    return this
 }
 
 private val pointerValidOptions = setOf("target", "keys", "offset", "pointerName", "node")
-fun User.pointer(vararg inputs: Map<String, Any>) {
+fun User.pointer(vararg inputs: Map<String, Any>): User {
     inputs.forEach { input ->
         input.forEach {
             require(it.key in pointerValidOptions) { "${it.key} is not valid (valid keys are $pointerValidOptions)" }
         }
     }
     javascriptExecutor.executeScript("await user.pointer(arguments[0])", inputs)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#click
  */
-fun User.click(element: WebElement) {
+fun User.click(element: WebElement): User {
     javascriptExecutor.executeScript("await user.click(arguments[0])", element)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#dblclick
  */
-fun User.dblClick(element: WebElement) {
+fun User.dblClick(element: WebElement): User {
     javascriptExecutor.executeScript("await user.dblClick(arguments[0])", element)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#tripleclick
  */
-fun User.tripleClick(element: WebElement) {
+fun User.tripleClick(element: WebElement): User {
     javascriptExecutor.executeScript("await user.tripleClick(arguments[0])", element)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#hover
  */
-fun User.hover(element: WebElement) {
+fun User.hover(element: WebElement): User {
     javascriptExecutor.executeScript("await user.hover(arguments[0])", element)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/convenience#unhover
  */
-fun User.unhover(element: WebElement) {
+fun User.unhover(element: WebElement): User {
     javascriptExecutor.executeScript("await user.unhover(arguments[0])", element)
+    return this
 }

lib/src/main/kotlin/com/luissoares/interactions/User.kt renamed to lib/src/main/kotlin/seleniumtestinglib/interactions/User.kt

@@ -1,8 +1,8 @@
-package com.luissoares.interactions
+package seleniumtestinglib.interactions
 
-import com.luissoares.ensureScript
 import org.openqa.selenium.JavascriptExecutor
 import org.openqa.selenium.remote.RemoteWebDriver
+import seleniumtestinglib.ensureScript
 
 class User(val javascriptExecutor: JavascriptExecutor)
 

lib/src/main/kotlin/com/luissoares/interactions/Utility.kt renamed to lib/src/main/kotlin/seleniumtestinglib/interactions/Utility.kt

@@ -1,32 +1,35 @@
-package com.luissoares.interactions
+package seleniumtestinglib.interactions
 
 import org.openqa.selenium.WebElement
 
 /**
  * https://testing-library.com/docs/user-event/utility#clear
  */
-fun User.clear(element: WebElement) {
+fun User.clear(element: WebElement): User {
     javascriptExecutor.executeScript("await user.clear(arguments[0])", element)
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/utility#-selectoptions-deselectoptions
  */
-fun User.selectOptions(element: WebElement, vararg values: SelectOption) {
+fun User.selectOptions(element: WebElement, vararg values: SelectOption): User {
     javascriptExecutor.executeScript(
         "await user.selectOptions(arguments[0], arguments[1])", element,
         values.map(SelectOption::value)
     )
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/utility#-selectoptions-deselectoptions
  */
-fun User.deselectOptions(element: WebElement, vararg values: SelectOption) {
+fun User.deselectOptions(element: WebElement, vararg values: SelectOption): User {
     javascriptExecutor.executeScript(
         "await user.deselectOptions(arguments[0], arguments[1])", element,
         values.map(SelectOption::value)
     )
+    return this
 }
 
 sealed class SelectOption(open val value: Any) {
@@ -44,7 +47,7 @@ fun User.type(
     skipAutoClose: Boolean? = null,
     initialSelectionStart: Int? = null,
     initialSelectionEnd: Int? = null,
-) {
+): User {
     javascriptExecutor.executeScript(
         "await user.type(arguments[0], arguments[1], arguments[2])",
         element,
@@ -56,19 +59,21 @@ fun User.type(
             "initialSelectionEnd" to initialSelectionEnd,
         ).filterValues { it != null }
     )
+    return this
 }
 
 /**
  * https://testing-library.com/docs/user-event/utility#upload
  */
-fun User.upload(input: WebElement, file: File) {
+fun User.upload(input: WebElement, file: File): User {
     javascriptExecutor.executeScript(
         "await user.upload(arguments[0], new File(arguments[1], arguments[2], arguments[3]))",
         input,
         file.bits,
         file.name,
         file.options
     )
+    return this
 }
 
 data class File(val bits: List<String>, val name: String, val options: Map<String, String> = emptyMap())

lib/src/main/kotlin/com/luissoares/locators/ByAltText.kt renamed to lib/src/main/kotlin/seleniumtestinglib/locators/ByAltText.kt

@@ -1,4 +1,4 @@
-package com.luissoares.locators
+package seleniumtestinglib.locators
 
 /**
  * https://testing-library.com/docs/queries/byalttext

lib/src/main/kotlin/com/luissoares/locators/ByDisplayValue.kt renamed to lib/src/main/kotlin/seleniumtestinglib/locators/ByDisplayValue.kt

@@ -1,4 +1,4 @@
-package com.luissoares.locators
+package seleniumtestinglib.locators
 
 /**
  * https://testing-library.com/docs/queries/bydisplayvalue