@tecgovtnzwebdev/puppeteer 3.0.1 → 3.0.2

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@tecgovtnzwebdev/puppeteer",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "puppeteer helpers",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "/cjs"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/checkbox.ts

@@ -1,54 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { repeatUntil } from './wait-until';
-
-/**
- * Is a checkbox checked?
- * @param selector The selector for the HTMLInputElement element.
- * @param page The puppeteer page.
- * @returns true if the checkbox is checked, false otherwise.
- */
-export async function isChecked(page: puppeteer.Page, selector: string): Promise<boolean> {
-    const isChecked = await page.evaluate((selector_: string) => {
-        const checkbox = document.querySelector(selector_) as HTMLInputElement;
-        if (!checkbox) {
-            return null;
-        }
-        return checkbox.checked;
-    }, selector);
-
-    if (isChecked === null) {
-        throw new Error(`Failed to get the checked value of '${selector}'`);
-    }
-
-    return isChecked;
-}
-
-/**
- * Checks a checkbox.
- * @param page The puppeteer page.
- * @param selector The selector for the HTMLInputElement element.
- */
-export async function check(page: puppeteer.Page, selector: string) {
-    await repeatUntil(async () => {
-        if (await isChecked(page, selector)) {
-            return true;
-        }
-
-        await page.click(selector);
-    }, `Expected checkbox '${selector}' to be checked`);
-}
-
-/**
- * Unchecks a checkbox.
- * @param page The puppeteer page.
- * @param selector The selector for the HTMLInputElement element.
- */
-export async function uncheck(page: puppeteer.Page, selector: string) {
-    await repeatUntil(async () => {
-        if (!(await isChecked(page, selector))) {
-            return true;
-        }
-
-        await page.click(selector);
-    }, `Expected checkbox '${selector}' to be unchecked`);
-}

package/click-helper.ts

@@ -1,31 +0,0 @@
-import * as puppeteer from 'puppeteer';
-
-/**
- * Clicks an element and waits for the page to navigate to a new URL or to reload.
- * @param page The puppeteer page.
- * @param elementOrSelector The HTMLElement or string selector to click.
- * @param waitOptions Optional wait settings.
- * @returns A promise which resolves after the page has navigated.
- */
-export function clickAndWaitForNavigation (page: puppeteer.Page, elementOrSelector: string | puppeteer.ElementHandle, waitOptions?: puppeteer.WaitForOptions) {
-    if (typeof elementOrSelector === 'string') {
-        return clickSelectorAndWaitForNavigation(page, elementOrSelector, waitOptions);
-    }
-    else {
-        return clickElementAndWaitForNavigation(page, elementOrSelector, waitOptions);
-    }
-}
-
-export async function clickSelectorAndWaitForNavigation (page: puppeteer.Page, selector: string, waitOptions?: puppeteer.WaitForOptions) {
-    return Promise.all([
-        page.waitForNavigation(waitOptions),
-        page.click(selector)
-    ]);
-}
-
-export async function clickElementAndWaitForNavigation (page: puppeteer.Page, element: puppeteer.ElementHandle, waitOptions?: puppeteer.WaitForOptions) {
-    return Promise.all([
-        page.waitForNavigation(waitOptions),
-        element.click()
-    ]);
-}

package/find-element-with-text.ts

@@ -1,19 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { getText } from './get-text';
-
-/**
- * Tries to find an element containing the specified text in its innerText value.
- * @param page The puppeteer page.
- * @param elementSelector The set of elements to search in.
- * @param text The text to search for. This value is case-sensitive.
- */
-export async function findElementWithText(page: puppeteer.Page, elementSelector: string, text: string) {
-    const elements = (await page.$$(elementSelector)) as puppeteer.ElementHandle<HTMLElement>[];
-    for (const element of elements) {
-        const textOfElement = await getText(page, element);
-        if (textOfElement && textOfElement.includes(text)) {
-            return element;
-        }
-    }
-    return null;
-};

package/get-attribute.ts

@@ -1,25 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { assertSuccessfulSelector } from './throw-helper';
-
-/**
- * Get the attirbute value from an element.
- * @param page The puppeteer page.
- * @param elementSelectorOrHandle An element selector or handle to an element.
- * @param attributeName The name of the attribute to get the value for.
- */
-export async function getAttribute (page: puppeteer.Page, elementSelectorOrHandle: string | puppeteer.ElementHandle<Element>, attributeName: string) {
-    let element: puppeteer.ElementHandle<Element>;
-    switch (typeof elementSelectorOrHandle) {
-    case 'string':
-        element = (await page.waitForSelector(elementSelectorOrHandle))!;
-        assertSuccessfulSelector(elementSelectorOrHandle, element);
-        break;
-    case 'object':
-        element = elementSelectorOrHandle;
-        break;
-    default:
-        throw new Error(`Unsupported type ${typeof elementSelectorOrHandle}`);
-    }
-
-    return await page.evaluate((el, att) => el.getAttribute(att), element, attributeName);
-};

package/get-text.ts

@@ -1,21 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { assertSuccessfulSelector } from './throw-helper';
-
-/**
- * Gets the innerText value of an element.
- * @param page The puppeteer page.
- * @param elementSelectorOrHandle The HTMLElement or string selector to get the innerText value from.
- */
-export async function getText(page: puppeteer.Page, elementSelectorOrHandle: string | puppeteer.ElementHandle<HTMLElement>) {
-    switch (typeof elementSelectorOrHandle) {
-    case 'string':
-        const element = (await page.waitForSelector(elementSelectorOrHandle))! as puppeteer.ElementHandle<HTMLElement>;
-        assertSuccessfulSelector(elementSelectorOrHandle, element);
-
-        return (page.evaluate(el => el.innerText, element)) as Promise<string | null | undefined>;
-    case 'object':
-        return (page.evaluate(el => el.innerText, elementSelectorOrHandle)) as Promise<string | null | undefined>;
-    default:
-        throw new Error(`Unsupported type ${typeof elementSelectorOrHandle}`);
-    }
-}

package/index.ts

@@ -1,11 +0,0 @@
-export * from './checkbox';
-export * from './click-helper';
-export * from './find-element-with-text';
-export * from './get-attribute';
-export * from './get-text';
-export * from './input';
-export * from './is-visible';
-export * from './mail-hog';
-export * from './select';
-export * from './wait-until';
-export * from './wait';

package/input.ts

@@ -1,35 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { assertSuccessfulSelector } from './throw-helper';
-
-/**
- * Gets the value from an HTMLInputElement.
- * @param page The puppeteer page.
- * @param elementSelectorOrHandle A selector for a <input /> element, or a handle.
- */
-export async function getValue (page: puppeteer.Page, elementSelectorOrHandle: string | puppeteer.ElementHandle<HTMLInputElement>) {
-    switch (typeof elementSelectorOrHandle) {
-    case 'string':
-        const element = (await page.waitForSelector(elementSelectorOrHandle))! as puppeteer.ElementHandle<HTMLInputElement>;
-        assertSuccessfulSelector(elementSelectorOrHandle, element);
-        return page.evaluate(el => el.value, element);
-    case 'object':
-        return page.evaluate(el => el.value, elementSelectorOrHandle);
-    default:
-        throw new Error(`Unsupported type ${typeof elementSelectorOrHandle}`);
-    }
-}
-
-/**
- * @param selector A selector for a <input /> element.
- * @param text The text to type into the <input />.
- */
-export async function clearAndType (page: puppeteer.Page, selector: string, text: string) {
-    const input = (await page.$(selector))! as puppeteer.ElementHandle<HTMLInputElement>;
-    assertSuccessfulSelector(selector, input);
-
-    await page.evaluate(i => {
-        i.value = '';
-    }, input);
-
-    await page.type(selector, text);
-}

package/is-visible.ts

@@ -1,17 +0,0 @@
-import * as puppeteer from 'puppeteer';
-
-export async function isVisible(page: puppeteer.Page, selectorOrElementHandle: string | puppeteer.ElementHandle) {
-    const element = typeof selectorOrElementHandle === 'string'
-        ? await page.$(selectorOrElementHandle)
-        : selectorOrElementHandle;
-    if (element === null) {
-        throw new Error(`Failed to find object`);
-    }
-
-    return page.evaluate((element: Element) => {
-        const style = getComputedStyle(element);
-        const rect = element.getBoundingClientRect();
-
-        return style.visibility !== 'hidden' && !!(rect.bottom || rect.top || rect.height || rect.width) && style.opacity !== '0';
-    }, element);
-}

package/mail-hog.ts

@@ -1,23 +0,0 @@
-import nodeFetch from 'node-fetch';
-import parseEmail from 'mailparser';
-
-export class MailHog {
-    private _mailHogUrl: string;
-
-    constructor (mailHogUrl: string) {
-        this._mailHogUrl = mailHogUrl;
-    }
-
-    /**
-     * Gets email from the mailhog inbox which match the specified 'to' address.
-     * @param addressNeedle A 'to' address filter.
-     */
-    async get (addressNeedle: string) {
-        const response = await nodeFetch(`${this._mailHogUrl}/api/v2/search?kind=to&query=${encodeURIComponent(addressNeedle)}`);
-        const messagesJson = await response.json();
-
-        const messages = messagesJson.items as any[];
-
-        return Promise.all(messages.map(message => parseEmail.simpleParser(message.Raw.Data)));
-    }
-}

package/pipelines/artifact-publish-pipeline.yml

@@ -1,16 +0,0 @@
-trigger: none
-
-pool:
-  vmImage: 'ubuntu-latest'
-
-steps:
-  - task: NodeTool@1
-    displayName: "Install nodejs"
-    inputs:
-      version: '22.x'
-  - script: |
-      echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
-      npm publish
-    displayName: "Publish package to NPM"
-    env:
-      NPM_TOKEN: $(NPM_TOKEN)

package/select.ts

@@ -1,82 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { assertSuccessfulSelector } from './throw-helper';
-
-/**
- * Selects one (or many) dropdown items by matching their <option /> text values.
- * @param page The puppeteer page.
- * @param selector A selector to a <select /> element.
- * @param  texts A set of <option /> innerText values to match on.
- * @returns An array of option values that have been successfully selected.
- */
-export async function selectWithText (page: puppeteer.Page, selector: string, ...texts: string[]) {
-    const select = (await page.$(selector))!;
-    assertSuccessfulSelector(selector, select);
-
-    const options = await select.$$('option');
-
-    // Pull out just the option value and text
-    const optionData = (await Promise.all(
-        options.map(async opt => {
-            const value = await page.evaluate(element => element.value, opt);
-            const text = (await page.evaluate(element => element.textContent, opt))?.trim();
-
-            return {
-                value: value.toString(),
-                text
-            };
-        })
-    )).filter(opt => opt.text && texts.includes(opt.text));
-
-    return select.select(...optionData.map(opt => opt.value));
-}
-
-/**
- * Gets the text of the currently selected option of a <select />.
- * @param page The puppeteer page.
- * @param selector A selector to a <select /> element.
- * @returns
- */
- export async function getTextOfSelectedOption (page: puppeteer.Page, selector: string) {
-    const select = (await page.$(selector))!;
-    assertSuccessfulSelector(selector, select);
-    return page.evaluate((select: HTMLSelectElement) => {
-        return select.options[select.selectedIndex].text;
-    }, select as puppeteer.ElementHandle<HTMLSelectElement>);
-}
-
-/**
- * Gets the set of text of the currently selected options of a <select /> element.
- * @param page The puppeteer page.
- * @param selector A selector to a <select /> element.
- */
-export async function getTextsOfSelectedOptions (page: puppeteer.Page, selector: string) {
-    return await page.evaluate((selector_: string) => {
-        const select = document.querySelector(selector_) as HTMLSelectElement | null;
-
-        if (!select) {
-            throw new Error(`Could find select element by '${selector}'`);
-        }
-
-        return Array.from(select.options)
-            .filter(opt => opt.selected)
-            .map(opt => opt.innerText);
-    }, selector);
-}
-
-/**
- * Uncheck all options of a select.
- * @param page The puppeteer page.
- * @param selector A selector to a <select /> element.
- */
-export async function uncheckAll (page: puppeteer.Page, selector: string) {
-    await page.evaluate((selector_: string) => {
-        const select = document.querySelector(selector_) as HTMLSelectElement | null;
-        if (!select) {
-            throw new Error(`Could not find select with selector '${selector_}'`);
-        }
-
-        for (const opt of select.options) {
-            opt.selected = false;
-        }
-    }, selector);
-}

package/throw-helper.ts

@@ -1,8 +0,0 @@
-import * as puppeteer from 'puppeteer';
-
-export function assertSuccessfulSelector(selector: string, element: puppeteer.ElementHandle | null) {
-    if (element === null) {
-        throw new Error(`Failed to find object by selector '${selector}'`);
-    }
-    return element;
-}

package/tsconfig.json

@@ -1,71 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                         /* Enable incremental compilation */
-    "target": "es6",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                                   /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                             /* Allow javascript files to be compiled. */
-    // "checkJs": true,                             /* Report errors in .js files. */
-    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    "declaration": true,                         /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-    "outDir": "./cjs",                              /* Redirect output structure to the directory. */
-    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                           /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                                 /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                    /* Enable strict null checks. */
-    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
-  }
-}

package/wait-until.ts

@@ -1,48 +0,0 @@
-import * as puppeteer from 'puppeteer';
-import { wait } from './wait';
-
-/**
- * @deprecated Use `repeatUntil` instead.
- */
-export async function waitUntil(page: puppeteer.Page, waitFunction: () => Promise<boolean>, errorMessage = 'Timed out waiting for something', timeOut = 5000, pollInterval = 100) {
-    const endTime = Date.now() + timeOut;
-    let conditionMet = await waitFunction();
-    while (!conditionMet && Date.now() < endTime) {
-        await new Promise(resolve => setTimeout(resolve, pollInterval));
-        conditionMet = await waitFunction();
-    }
-    if (!conditionMet) {
-        throw new Error(errorMessage);
-    }
-}
-
-/**
- * Repeats an operation until a specified condition is met or a timeout occurs.
- *
- * @param page - The Puppeteer `Page` instance to operate on.
- * @param operation - An asynchronous function that returns a boolean indicating whether the condition is met.
- * @param errorMessage - The error message to throw if the timeout is reached before the condition is met. Defaults to 'Timed out waiting for something'.
- * @param timeOut - The maximum time to wait (in milliseconds) before throwing an error. Defaults to 5000 ms.
- * @param pollInterval - The interval (in milliseconds) at which the condition is checked. Defaults to 100 ms.
- * @throws Will throw an error with the provided `errorMessage` if the condition is not met within the timeout period.
- */
-export async function repeatUntil(
-    operation: () => Promise<boolean | undefined>,
-    errorMessage = 'Timed out waiting for something',
-    timeOut = 5000,
-    pollInterval = 100) {
-    // The absolute end time this operation should run until (in milliseconds)
-    const endTime = Date.now() + timeOut;
-
-    do {
-        // Call the operation and check if it returns true
-        if (await operation()) {
-            return;
-        }
-
-        // Wait for the specified poll interval before checking again
-        await wait(pollInterval);
-    } while (Date.now() < endTime);
-
-    throw new Error(errorMessage);
-}

package/wait.ts

@@ -1,9 +0,0 @@
-/**
- * Waits for a specified period of time.
- *
- * @param period - The time to wait in milliseconds.
- * @returns A promise that resolves after the specified period.
- */
-export const wait = async (period: number) => {
-  await new Promise(resolve => setTimeout(resolve, period));
-}