puppethelper v1.0.5

🧰 puppethelper

A Puppeteer utility package for web automation.

(The instructions below have been made to work on Linux operating systems, specifically on Ubuntu 22.04)

Installation of the package:

1. sudo apt update

2. sudo apt upgrade -y

3. wget -qO- https://deb.nodesource.com/setup_20.x | sudo -E bash -

4. sudo apt install -y nodejs

5. npm install puppethelper

Running the demo:

1. Run the commands shown in Installation of the package.

2. sudo apt install git

3. git clone https://github.com/zahradnik-ondrej/puppethelper.git

4. cd puppethelper/bot-demo

5. npm start

Functions:

// clears a text field
clear(page: Page, selector: string)

// clicks on an element
click(page: Page, selector: string, timeout: number = 30)

// waits for an element to be loaded
findElement(page: Page, selector: string, timeout: number = 30)

// returns the attribute value of an element
getAttribute(page: Page, selector: string, attribute: string)

// returns the text within an element
getText(page: Page, selector: string)

// waits for a specified number of seconds
timeout(seconds: number = 5)

// types a string into a text field
type(page: Page, selector: string, text: string, timeout: number = 30)

Errors:

AttributeNotFound(attribute: string, selector: string)

ElementNotFound(selector: string)

Constants:

type ModeType = boolean | 'shell'

const browser_opts: {
  headless: ModeType
  slowMo: number
  devtools: boolean
  executablePath: string
  args: string[]
} = {
  headless: true,
  slowMo: 1,
  devtools: false,
  executablePath: '/usr/bin/chromium-browser',
  args: ['--no-sandbox', '--disable-setuid-sandbox'],
}

const page_opts: { default_timeout: number } = {
  default_timeout: 30000,
}

Types:

type SelectorType = 'css' | 'xpath'