@dscribers/autosurf v2.2.0

autosurf

Installation

Include on page to test

<script src="https://cdn.jsdelivr.net/npm/@dscribers/autosurf/dist/autosurf.min.js"></script>

Use nodejs

yarn add @dscribers/autosurf

Usage

<script>
  const $surf = new AutoSurf()
  $surf
    .on('*', handleAllEvents)
    // This function directly passed to the init method of the adapter
    .ready(() => {
      $surf.schedules(schedulesArray).start()
    })
</script>

Config

const $surf = new AutoSurf({
  autoAdvance: false, // Indicates whether to automatically advance to the next step or not. Defaults to TRUE,
  defaultFailMessage: 'Something went wrong', // The default message for failed actions. It may be overridden by a more specific message, if available.
  typingSpeed: 500, // The speed for the typing action in milliseconds. Defaults to 100
})

All possible lists of dos and checks are properly documented in the BaseAdapter.

Methods

Schedules

A schedules array consists of schedule objects which have the following structure:

// a schedule object

{
  "do": [
    {
      "action": "type",
      "params": ["John Doe"],
      "selector": "#inputName"
    }
  ],
  "check": [
    {
      "action": "valueIs",
      "selector": "#name",
      "params": ["John Doe"]
    }
  ]
}

Events

Events are triggered at different points of the execution. These can be used to monitor the execution.

The following is the list of events:

Adapters

AutoSurf works with adapters to surf different devices and platforms. This is required.

Below is a list of available adapters:

• WebSurf

How to build

Adapters are classes which must extend the BaseAdapter class.

import BaseAdapter from '@dscribers/autosurf/dist/base-adapter'

export default class MobileAdapter extends BaseAdapter {
  static init($autosurf, callback) {
    // initialize the adapter
  }

  static quit($autosurf) {
    // clean up the process
  }

  static doType(selector, str, speed = 500) {
    // select the element
    // type the str into the element at the given speed
    // throw new Error if something goes wrong
  }

  static checkValueIs(selector, value) {
    // select the element
    // check that the value of the element is the same as the given value
    // throw new Error if not the same
  }

  // ...
}

Usage

import AutoSurf from '@dscribers/autosurf'
import MobileSurf from 'mobile-surf-adapter'

$autosurf = new AutoSurf(new MobileSurf())

Methods

All methods in the BaseAdapter should be overridden as they are designed to fail by default.