system-testing 1.0.26 → 1.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "system-testing",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "description": "System testing with Selenium and browsers.",
   "keywords": [
     "system",

package/src/system-test-browser-helper.js

@@ -100,6 +100,9 @@ export default class SystemTestBrowserHelper {
     this.communicator.sendCommand(data)
   }
 
+  /**
+   * @returns {void}
+   */
   connectWebSocket() {
     this.ws = new WebSocket("ws://localhost:1985")
     this.communicator.ws = this.ws
@@ -108,6 +111,9 @@ export default class SystemTestBrowserHelper {
     this.ws.addEventListener("message", (event) => this.communicator.onMessage(event.data))
   }
 
+  /**
+   * @returns {void}
+   */
   enableOnBrowser() {
     this._enabled = true
     this.connectWebSocket()
@@ -116,7 +122,14 @@ export default class SystemTestBrowserHelper {
     this.overrideConsoleLog()
   }
 
+  /**
+   * @returns {boolean}
+   */
   getEnabled() { return this._enabled }
+
+  /**
+   * @returns {EventEmitter}
+   */
   getEvents() { return this.events }
 
   fakeConsoleError = (...args) => {
@@ -185,10 +198,17 @@ export default class SystemTestBrowserHelper {
     }
   }
 
+  /**
+   * @param {function() : void} callback
+   * @returns {void}
+   */
   onInitialize(callback) {
     this._onInitializeCallback = callback
   }
 
+  /**
+   * @returns {void}
+   */
   overrideConsoleLog() {
     if (this.originalConsoleError || this.originalConsoleLog) {
       throw new Error("Console methods has already been overridden!")
@@ -201,6 +221,10 @@ export default class SystemTestBrowserHelper {
     console.log = this.fakeConsoleLog
   }
 
+  /**
+   * @param {string} sql
+   * @returns {Promise<Array<Record<string, any>>>}
+   */
   async sendQuery(sql) {
     return await this.communicator.sendCommand({type: "query", sql})
   }

package/src/system-test-http-server.js

@@ -4,6 +4,7 @@ import mime from "mime"
 import url from "url"
 
 export default class SystemTestHttpServer {
+  /** @returns {void} */
   close() {
     this.httpServer.close()
   }
@@ -37,11 +38,13 @@ export default class SystemTestHttpServer {
     response.end(fileContent)
   }
 
+  /** @returns {Promise<void>} */
   async start() {
     this.basePath = await fs.realpath(`${__dirname}/../..`)
     await this.startHttpServer()
   }
 
+  /** @returns {Promise<void>} */
   startHttpServer() {
     return new Promise((resolve) => {
       this.httpServer = http.createServer(this.onHttpServerRequest)

package/src/system-test.js

@@ -93,13 +93,19 @@ export default class SystemTest {
     return this.getBaseSelector() ? `${this.getBaseSelector()} ${selector}` : selector
   }
 
-  /** Starts Scoundrel server which the browser connects to for remote evaluation in the browser */
+  /**
+   * Starts Scoundrel server which the browser connects to for remote evaluation in the browser
+   * @returns {void}
+   */
   startScoundrel() {
     this.wss = new WebSocketServer({port: 8090})
     this.serverWebSocket = new ServerWebSocket(this.wss)
     this.server = new Server(this.serverWebSocket)
   }
 
+  /**
+   * @returns {void}
+   */
   stopScoundrel() {
     this.server?.close()
     this.wss?.close()

package/src/use-system-test.js

@@ -9,7 +9,10 @@ const shared = {
   systemTestBrowserHelper: null
 }
 
-const isSystemTestEnabled = () => {
+/**
+ * @returns {boolean}
+ */
+function isSystemTestEnabled() {
   let enabled = false
   const initialUrl = globalThis.location?.href
 
@@ -25,7 +28,10 @@ const isSystemTestEnabled = () => {
   return enabled
 }
 
-const getSystemTestBrowserHelper = () => {
+/**
+ * @returns {SystemTestBrowserHelper}
+ */
+function getSystemTestBrowserHelper() {
   if (!shared.systemTestBrowserHelper) {
     shared.systemTestBrowserHelper = new SystemTestBrowserHelper()
     shared.systemTestBrowserHelper.enableOnBrowser()
@@ -38,9 +44,7 @@ const getSystemTestBrowserHelper = () => {
  * A hook that provides system test capabilities.
  * @param {object} options - Options for the hook.
  * @param {function() : void} options.onInitialize - A callback function that is called when the system test browser helper is initialized.
- * @returns {object} An object containing:
- *  - enabled: A boolean indicating if system test mode is enabled.
- *  - systemTestBrowserHelper: An instance of SystemTestBrowserHelper if enabled, otherwise null.
+ * @returns {{enabled: boolean, systemTestBrowserHelper: SystemTestBrowserHelper}}
  */
 export default function useSystemTest({onInitialize, ...restArgs} = {}) {
   const router = useRouter()