This package has been deprecated

Author message:

change package name to @sideex/api

sideex-api

SideeX JavaScript API

SideeX JavaScript API is a JS library running on a webpage for recording and playing web browsing behavior. As opposed to acting as a browser web extension, the API can be directly embedded and used within a webpage via JavaScript .

Installation

npm i sideex-api

Example

Record and playback

import {SideeX} from "sideex-api" 
/* or
var {SideeX} = require('sideex-api') 
*/
var sideex = new SideeX();
 
sideex.recorder.start();//start recording
/* 
  Record a command
  For example: click at anywhere on the window,
  then you get a ClickAt command  
*/
sideex.recorder.stop();//stop recording
console.log(sideex.file.command.get(0));//get the first recorded command
sideex.playback.start();//replay the recorded commands

Save and load the recorded commands

import {SideeX} from "sideex-api"
var sideex = new SideeX();
 
sideex.recorder.start();//start recording
/* 
  Record a command
  For example: click at anywhere on the window,
  then you get a ClickAt command  
*/
sideex.recorder.stop();//stop recording
console.log(sideex.file.command.get(0));//get the record that you recorded
let jsonString = sideex.file.testSuite.save();//serialize the recorded commands to a JSON string
 
//save the jsonString on your own
 
sideex.file.testSuite.load(jsonString);//load the jsonString
sideex.playback.start();//replay the recorded commands

Change a recorded command to a user-defined action

import {SideeX} from "sideex-api"
var sideex = new SideeX();
 
sideex.recorder.start();//start recording
/* 
  Record a command
  For example: click at anywhere on the window,
  then you get a ClickAt command  
*/
sideex.recorder.stop();//stop recording
console.log(sideex.file.command.get(0));//get the first recorded command
let command = sideex.file.command.get(0);
command.name = "myAction";//rename the command name to "myAction"
console.log(sideex.file.command.get(0));//see the change of the command name
//add a user-defined function for executing "myAction"
sideex.playback.addCustomCommand("myAction", true, (target, value) => {
    console.log(target, value);
    //define the action here
    }
);
sideex.playback.start();//replay the modified recorded commands

API Docs