Initial commit - Dutchie dispensary scraper

This commit is contained in:
Kelly
2025-11-28 19:45:44 -07:00
commit 5757a8e9bd
23375 changed files with 3788799 additions and 0 deletions

21
backend/node_modules/puppeteer-extra-plugin/LICENSE generated vendored Normal file
View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2019 berstend <github@berstend.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,533 @@
/*!
* puppeteer-extra-plugin v3.2.2 by berstend
* https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin
* @license MIT
*/
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
var debug = _interopDefault(require('debug'));
/** @private */
const merge = require('merge-deep');
/**
* Base class for `puppeteer-extra` plugins.
*
* Provides convenience methods to avoid boilerplate.
*
* All common `puppeteer` browser events will be bound to
* the plugin instance, if a respectively named class member is found.
*
* Please refer to the [puppeteer API documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md) as well.
*
* @example
* // hello-world-plugin.js
* const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
*
* class Plugin extends PuppeteerExtraPlugin {
* constructor (opts = { }) { super(opts) }
*
* get name () { return 'hello-world' }
*
* async onPageCreated (page) {
* this.debug('page created', page.url())
* const ua = await page.browser().userAgent()
* this.debug('user agent', ua)
* }
* }
*
* module.exports = function (pluginConfig) { return new Plugin(pluginConfig) }
*
*
* // foo.js
* const puppeteer = require('puppeteer-extra')
* puppeteer.use(require('./hello-world-plugin')())
*
* ;(async () => {
* const browser = await puppeteer.launch({headless: false})
* const page = await browser.newPage()
* await page.goto('http://example.com', {waitUntil: 'domcontentloaded'})
* await browser.close()
* })()
*
*/
class PuppeteerExtraPlugin {
constructor(opts) {
this._debugBase = debug(`puppeteer-extra-plugin:base:${this.name}`);
this._childClassMembers = [];
this._opts = merge(this.defaults, opts || {});
this._debugBase('Initialized.');
}
/**
* Plugin name (required).
*
* Convention:
* - Package: `puppeteer-extra-plugin-anonymize-ua`
* - Name: `anonymize-ua`
*
* @example
* get name () { return 'anonymize-ua' }
*/
get name() {
throw new Error('Plugin must override "name"');
}
/**
* Plugin defaults (optional).
*
* If defined will be ([deep-](https://github.com/jonschlinkert/merge-deep))merged with the (optional) user supplied options (supplied during plugin instantiation).
*
* The result of merging defaults with user supplied options can be accessed through `this.opts`.
*
* @see [[opts]]
*
* @example
* get defaults () {
* return {
* stripHeadless: true,
* makeWindows: true,
* customFn: null
* }
* }
*
* // Users can overwrite plugin defaults during instantiation:
* puppeteer.use(require('puppeteer-extra-plugin-foobar')({ makeWindows: false }))
*/
get defaults() {
return {};
}
/**
* Plugin requirements (optional).
*
* Signal certain plugin requirements to the base class and the user.
*
* Currently supported:
* - `launch`
* - If the plugin only supports locally created browser instances (no `puppeteer.connect()`),
* will output a warning to the user.
* - `headful`
* - If the plugin doesn't work in `headless: true` mode,
* will output a warning to the user.
* - `dataFromPlugins`
* - In case the plugin requires data from other plugins.
* will enable usage of `this.getDataFromPlugins()`.
* - `runLast`
* - In case the plugin prefers to run after the others.
* Useful when the plugin needs data from others.
*
* @example
* get requirements () {
* return new Set(['runLast', 'dataFromPlugins'])
* }
*/
get requirements() {
return new Set([]);
}
/**
* Plugin dependencies (optional).
*
* Missing plugins will be required() by puppeteer-extra.
*
* @example
* get dependencies () {
* return new Set(['user-preferences'])
* }
* // Will ensure the 'puppeteer-extra-plugin-user-preferences' plugin is loaded.
*/
get dependencies() {
return new Set([]);
}
/**
* Plugin data (optional).
*
* Plugins can expose data (an array of objects), which in turn can be consumed by other plugins,
* that list the `dataFromPlugins` requirement (by using `this.getDataFromPlugins()`).
*
* Convention: `[ {name: 'Any name', value: 'Any value'} ]`
*
* @see [[getDataFromPlugins]]
*
* @example
* // plugin1.js
* get data () {
* return [
* {
* name: 'userPreferences',
* value: { foo: 'bar' }
* },
* {
* name: 'userPreferences',
* value: { hello: 'world' }
* }
* ]
*
* // plugin2.js
* get requirements () { return new Set(['dataFromPlugins']) }
*
* async beforeLaunch () {
* const prefs = this.getDataFromPlugins('userPreferences').map(d => d.value)
* this.debug(prefs) // => [ { foo: 'bar' }, { hello: 'world' } ]
* }
*/
get data() {
return [];
}
/**
* Access the plugin options (usually the `defaults` merged with user defined options)
*
* To skip the auto-merging of defaults with user supplied opts don't define a `defaults`
* property and set the `this._opts` Object in your plugin constructor directly.
*
* @see [[defaults]]
*
* @example
* get defaults () { return { foo: "bar" } }
*
* async onPageCreated (page) {
* this.debug(this.opts.foo) // => bar
* }
*/
get opts() {
return this._opts;
}
/**
* Convenience debug logger based on the [debug] module.
* Will automatically namespace the logging output to the plugin package name.
* [debug]: https://www.npmjs.com/package/debug
*
* ```bash
* # toggle output using environment variables
* DEBUG=puppeteer-extra-plugin:<plugin_name> node foo.js
* # to debug all the things:
* DEBUG=puppeteer-extra,puppeteer-extra-plugin:* node foo.js
* ```
*
* @example
* this.debug('hello world')
* // will output e.g. 'puppeteer-extra-plugin:anonymize-ua hello world'
*/
get debug() {
return debug(`puppeteer-extra-plugin:${this.name}`);
}
/**
* Before a new browser instance is created/launched.
*
* Can be used to modify the puppeteer launch options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @example
* async beforeLaunch (options) {
* if (this.opts.flashPluginPath) {
* options.args.push(`--ppapi-flash-path=${this.opts.flashPluginPath}`)
* }
* }
*
* @param options - Puppeteer launch options
*/
async beforeLaunch(options) {
// noop
}
/**
* After the browser has launched.
*
* Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
* It's possible that `pupeeteer.launch` will be called multiple times and more than one browser created.
* In order to make the plugins as stateless as possible don't store a reference to the browser instance
* in the plugin but rather consider alternatives.
*
* E.g. when using `onPageCreated` you can get a browser reference by using `page.browser()`.
*
* Alternatively you could expose a class method that takes a browser instance as a parameter to work with:
*
* ```es6
* const fancyPlugin = require('puppeteer-extra-plugin-fancy')()
* puppeteer.use(fancyPlugin)
* const browser = await puppeteer.launch()
* await fancyPlugin.killBrowser(browser)
* ```
*
* @param browser - The `puppeteer` browser instance.
* @param opts.options - Puppeteer launch options used.
*
* @example
* async afterLaunch (browser, opts) {
* this.debug('browser has been launched', opts.options)
* }
*/
async afterLaunch(browser, opts = { options: {} }) {
// noop
}
/**
* Before connecting to an existing browser instance.
*
* Can be used to modify the puppeteer connect options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @param {Object} options - Puppeteer connect options
* @return {Object=}
*/
async beforeConnect(options) {
// noop
}
/**
* After connecting to an existing browser instance.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
* @param {Object} opts
* @param {Object} opts.options - Puppeteer connect options used.
*
*/
async afterConnect(browser, opts = {}) {
// noop
}
/**
* Called when a browser instance is available.
*
* This applies to both `puppeteer.launch()` and `puppeteer.connect()`.
*
* Convenience method created for plugins that need access to a browser instance
* and don't mind if it has been created through `launch` or `connect`.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
*/
async onBrowser(browser, opts) {
// noop
}
/**
* Called when a target is created, for example when a new page is opened by window.open or browser.newPage.
*
* > Note: This includes target creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetCreated(target) {
// noop
}
/**
* Same as `onTargetCreated` but prefiltered to only contain Pages, for convenience.
*
* > Note: This includes page creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*
* @example
* async onPageCreated (page) {
* let ua = await page.browser().userAgent()
* if (this.opts.stripHeadless) {
* ua = ua.replace('HeadlessChrome/', 'Chrome/')
* }
* this.debug('new ua', ua)
* await page.setUserAgent(ua)
* }
*/
async onPageCreated(page) {
// noop
}
/**
* Called when the url of a target changes.
*
* > Note: This includes target changes in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetChanged(target) {
// noop
}
/**
* Called when a target is destroyed, for example when a page is closed.
*
* > Note: This includes target destructions in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetDestroyed(target) {
// noop
}
/**
* Called when Puppeteer gets disconnected from the Chromium instance.
*
* This might happen because of one of the following:
* - Chromium is closed or crashed
* - The `browser.disconnect` method was called
*/
async onDisconnected() {
// noop
}
/**
* **Deprecated:** Since puppeteer v1.6.0 `onDisconnected` has been improved
* and should be used instead of `onClose`.
*
* In puppeteer < v1.6.0 `onDisconnected` was not catching all exit scenarios.
* In order for plugins to clean up properly (e.g. deleting temporary files)
* the `onClose` method had been introduced.
*
* > Note: Might be called multiple times on exit.
*
* > Note: This only includes browser instances created through `.launch()`.
*/
async onClose() {
// noop
}
/**
* After the plugin has been registered in `puppeteer-extra`.
*
* Normally right after `puppeteer.use(plugin)` is called
*/
async onPluginRegistered() {
// noop
}
/**
* Helper method to retrieve `data` objects from other plugins.
*
* A plugin needs to state the `dataFromPlugins` requirement
* in order to use this method. Will be mapped to `puppeteer.getPluginData`.
*
* @param name - Filter data by `name` property
*
* @see [data]
* @see [requirements]
*/
getDataFromPlugins(name) {
return [];
}
/**
* Will match plugin dependencies against all currently registered plugins.
* Is being called by `puppeteer-extra` and used to require missing dependencies.
*
* @param {Array<Object>} plugins
* @return {Set} - list of missing plugin names
*
* @private
*/
_getMissingDependencies(plugins) {
const pluginNames = new Set(plugins.map((p) => p.name));
const missing = new Set(Array.from(this.dependencies.values()).filter(x => !pluginNames.has(x)));
return missing;
}
/**
* Conditionally bind browser/process events to class members.
* The idea is to reduce event binding boilerplate in plugins.
*
* For efficiency we make sure the plugin is using the respective event
* by checking the child class members before registering the listener.
*
* @param {<Puppeteer.Browser>} browser
* @param {Object} opts - Options
* @param {string} opts.context - Puppeteer context (launch/connect)
* @param {Object} [opts.options] - Puppeteer launch or connect options
* @param {Array<string>} [opts.defaultArgs] - The default flags that Chromium will be launched with
*
* @private
*/
async _bindBrowserEvents(browser, opts = {}) {
if (this._hasChildClassMember('onTargetCreated') ||
this._hasChildClassMember('onPageCreated')) {
browser.on('targetcreated', this._onTargetCreated.bind(this));
}
if (this._hasChildClassMember('onTargetChanged') && this.onTargetChanged) {
browser.on('targetchanged', this.onTargetChanged.bind(this));
}
if (this._hasChildClassMember('onTargetDestroyed') &&
this.onTargetDestroyed) {
browser.on('targetdestroyed', this.onTargetDestroyed.bind(this));
}
if (this._hasChildClassMember('onDisconnected') && this.onDisconnected) {
browser.on('disconnected', this.onDisconnected.bind(this));
}
if (opts.context === 'launch' && this._hasChildClassMember('onClose')) {
// The disconnect event has been improved since puppeteer v1.6.0
// onClose is being kept mostly for legacy reasons
if (this.onClose) {
process.on('exit', this.onClose.bind(this));
browser.on('disconnected', this.onClose.bind(this));
if (opts.options.handleSIGINT !== false) {
process.on('SIGINT', this.onClose.bind(this));
}
if (opts.options.handleSIGTERM !== false) {
process.on('SIGTERM', this.onClose.bind(this));
}
if (opts.options.handleSIGHUP !== false) {
process.on('SIGHUP', this.onClose.bind(this));
}
}
}
if (opts.context === 'launch' && this.afterLaunch) {
await this.afterLaunch(browser, opts);
}
if (opts.context === 'connect' && this.afterConnect) {
await this.afterConnect(browser, opts);
}
if (this.onBrowser)
await this.onBrowser(browser, opts);
}
/**
* @private
*/
async _onTargetCreated(target) {
if (this.onTargetCreated)
await this.onTargetCreated(target);
// Pre filter pages for plugin developers convenience
if (target.type() === 'page') {
try {
const page = await target.page();
if (!page) {
return;
}
const validPage = 'isClosed' in page && !page.isClosed();
if (this.onPageCreated && validPage) {
await this.onPageCreated(page);
}
}
catch (err) {
console.error(err);
}
}
}
/**
* @private
*/
_register(prototype) {
this._registerChildClassMembers(prototype);
if (this.onPluginRegistered)
this.onPluginRegistered();
}
/**
* @private
*/
_registerChildClassMembers(prototype) {
this._childClassMembers = Object.getOwnPropertyNames(prototype);
}
/**
* @private
*/
_hasChildClassMember(name) {
return !!this._childClassMembers.includes(name);
}
/**
* @private
*/
get _isPuppeteerExtraPlugin() {
return true;
}
}
exports.PuppeteerExtraPlugin = PuppeteerExtraPlugin;
//# sourceMappingURL=index.cjs.js.map

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,420 @@
import { Debugger } from 'debug';
import * as Puppeteer from './puppeteer';
export interface PluginOptions {
[key: string]: any;
}
export interface PluginData {
name: {
[key: string]: any;
};
value: {
[key: string]: any;
};
}
export declare type PluginDependencies = Set<string>;
export declare type PluginRequirements = Set<'launch' | 'headful' | 'dataFromPlugins' | 'runLast'>;
/**
* Base class for `puppeteer-extra` plugins.
*
* Provides convenience methods to avoid boilerplate.
*
* All common `puppeteer` browser events will be bound to
* the plugin instance, if a respectively named class member is found.
*
* Please refer to the [puppeteer API documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md) as well.
*
* @example
* // hello-world-plugin.js
* const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
*
* class Plugin extends PuppeteerExtraPlugin {
* constructor (opts = { }) { super(opts) }
*
* get name () { return 'hello-world' }
*
* async onPageCreated (page) {
* this.debug('page created', page.url())
* const ua = await page.browser().userAgent()
* this.debug('user agent', ua)
* }
* }
*
* module.exports = function (pluginConfig) { return new Plugin(pluginConfig) }
*
*
* // foo.js
* const puppeteer = require('puppeteer-extra')
* puppeteer.use(require('./hello-world-plugin')())
*
* ;(async () => {
* const browser = await puppeteer.launch({headless: false})
* const page = await browser.newPage()
* await page.goto('http://example.com', {waitUntil: 'domcontentloaded'})
* await browser.close()
* })()
*
*/
export declare abstract class PuppeteerExtraPlugin {
/** @private */
private _debugBase;
/** @private */
private _opts;
/** @private */
private _childClassMembers;
constructor(opts?: PluginOptions);
/**
* Plugin name (required).
*
* Convention:
* - Package: `puppeteer-extra-plugin-anonymize-ua`
* - Name: `anonymize-ua`
*
* @example
* get name () { return 'anonymize-ua' }
*/
get name(): string;
/**
* Plugin defaults (optional).
*
* If defined will be ([deep-](https://github.com/jonschlinkert/merge-deep))merged with the (optional) user supplied options (supplied during plugin instantiation).
*
* The result of merging defaults with user supplied options can be accessed through `this.opts`.
*
* @see [[opts]]
*
* @example
* get defaults () {
* return {
* stripHeadless: true,
* makeWindows: true,
* customFn: null
* }
* }
*
* // Users can overwrite plugin defaults during instantiation:
* puppeteer.use(require('puppeteer-extra-plugin-foobar')({ makeWindows: false }))
*/
get defaults(): PluginOptions;
/**
* Plugin requirements (optional).
*
* Signal certain plugin requirements to the base class and the user.
*
* Currently supported:
* - `launch`
* - If the plugin only supports locally created browser instances (no `puppeteer.connect()`),
* will output a warning to the user.
* - `headful`
* - If the plugin doesn't work in `headless: true` mode,
* will output a warning to the user.
* - `dataFromPlugins`
* - In case the plugin requires data from other plugins.
* will enable usage of `this.getDataFromPlugins()`.
* - `runLast`
* - In case the plugin prefers to run after the others.
* Useful when the plugin needs data from others.
*
* @example
* get requirements () {
* return new Set(['runLast', 'dataFromPlugins'])
* }
*/
get requirements(): PluginRequirements;
/**
* Plugin dependencies (optional).
*
* Missing plugins will be required() by puppeteer-extra.
*
* @example
* get dependencies () {
* return new Set(['user-preferences'])
* }
* // Will ensure the 'puppeteer-extra-plugin-user-preferences' plugin is loaded.
*/
get dependencies(): PluginDependencies;
/**
* Plugin data (optional).
*
* Plugins can expose data (an array of objects), which in turn can be consumed by other plugins,
* that list the `dataFromPlugins` requirement (by using `this.getDataFromPlugins()`).
*
* Convention: `[ {name: 'Any name', value: 'Any value'} ]`
*
* @see [[getDataFromPlugins]]
*
* @example
* // plugin1.js
* get data () {
* return [
* {
* name: 'userPreferences',
* value: { foo: 'bar' }
* },
* {
* name: 'userPreferences',
* value: { hello: 'world' }
* }
* ]
*
* // plugin2.js
* get requirements () { return new Set(['dataFromPlugins']) }
*
* async beforeLaunch () {
* const prefs = this.getDataFromPlugins('userPreferences').map(d => d.value)
* this.debug(prefs) // => [ { foo: 'bar' }, { hello: 'world' } ]
* }
*/
get data(): PluginData[];
/**
* Access the plugin options (usually the `defaults` merged with user defined options)
*
* To skip the auto-merging of defaults with user supplied opts don't define a `defaults`
* property and set the `this._opts` Object in your plugin constructor directly.
*
* @see [[defaults]]
*
* @example
* get defaults () { return { foo: "bar" } }
*
* async onPageCreated (page) {
* this.debug(this.opts.foo) // => bar
* }
*/
get opts(): PluginOptions;
/**
* Convenience debug logger based on the [debug] module.
* Will automatically namespace the logging output to the plugin package name.
* [debug]: https://www.npmjs.com/package/debug
*
* ```bash
* # toggle output using environment variables
* DEBUG=puppeteer-extra-plugin:<plugin_name> node foo.js
* # to debug all the things:
* DEBUG=puppeteer-extra,puppeteer-extra-plugin:* node foo.js
* ```
*
* @example
* this.debug('hello world')
* // will output e.g. 'puppeteer-extra-plugin:anonymize-ua hello world'
*/
get debug(): Debugger;
/**
* Before a new browser instance is created/launched.
*
* Can be used to modify the puppeteer launch options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @example
* async beforeLaunch (options) {
* if (this.opts.flashPluginPath) {
* options.args.push(`--ppapi-flash-path=${this.opts.flashPluginPath}`)
* }
* }
*
* @param options - Puppeteer launch options
*/
beforeLaunch(options: any): Promise<void>;
/**
* After the browser has launched.
*
* Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
* It's possible that `pupeeteer.launch` will be called multiple times and more than one browser created.
* In order to make the plugins as stateless as possible don't store a reference to the browser instance
* in the plugin but rather consider alternatives.
*
* E.g. when using `onPageCreated` you can get a browser reference by using `page.browser()`.
*
* Alternatively you could expose a class method that takes a browser instance as a parameter to work with:
*
* ```es6
* const fancyPlugin = require('puppeteer-extra-plugin-fancy')()
* puppeteer.use(fancyPlugin)
* const browser = await puppeteer.launch()
* await fancyPlugin.killBrowser(browser)
* ```
*
* @param browser - The `puppeteer` browser instance.
* @param opts.options - Puppeteer launch options used.
*
* @example
* async afterLaunch (browser, opts) {
* this.debug('browser has been launched', opts.options)
* }
*/
afterLaunch(browser: Puppeteer.Browser, opts?: {
options: Puppeteer.LaunchOptions;
}): Promise<void>;
/**
* Before connecting to an existing browser instance.
*
* Can be used to modify the puppeteer connect options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @param {Object} options - Puppeteer connect options
* @return {Object=}
*/
beforeConnect(options: Puppeteer.ConnectOptions): Promise<void>;
/**
* After connecting to an existing browser instance.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
* @param {Object} opts
* @param {Object} opts.options - Puppeteer connect options used.
*
*/
afterConnect(browser: Puppeteer.Browser, opts?: {}): Promise<void>;
/**
* Called when a browser instance is available.
*
* This applies to both `puppeteer.launch()` and `puppeteer.connect()`.
*
* Convenience method created for plugins that need access to a browser instance
* and don't mind if it has been created through `launch` or `connect`.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
*/
onBrowser(browser: Puppeteer.Browser, opts: any): Promise<void>;
/**
* Called when a target is created, for example when a new page is opened by window.open or browser.newPage.
*
* > Note: This includes target creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
onTargetCreated(target: Puppeteer.Target): Promise<void>;
/**
* Same as `onTargetCreated` but prefiltered to only contain Pages, for convenience.
*
* > Note: This includes page creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*
* @example
* async onPageCreated (page) {
* let ua = await page.browser().userAgent()
* if (this.opts.stripHeadless) {
* ua = ua.replace('HeadlessChrome/', 'Chrome/')
* }
* this.debug('new ua', ua)
* await page.setUserAgent(ua)
* }
*/
onPageCreated(page: Puppeteer.Page): Promise<void>;
/**
* Called when the url of a target changes.
*
* > Note: This includes target changes in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
onTargetChanged(target: Puppeteer.Target): Promise<void>;
/**
* Called when a target is destroyed, for example when a page is closed.
*
* > Note: This includes target destructions in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
onTargetDestroyed(target: Puppeteer.Target): Promise<void>;
/**
* Called when Puppeteer gets disconnected from the Chromium instance.
*
* This might happen because of one of the following:
* - Chromium is closed or crashed
* - The `browser.disconnect` method was called
*/
onDisconnected(): Promise<void>;
/**
* **Deprecated:** Since puppeteer v1.6.0 `onDisconnected` has been improved
* and should be used instead of `onClose`.
*
* In puppeteer < v1.6.0 `onDisconnected` was not catching all exit scenarios.
* In order for plugins to clean up properly (e.g. deleting temporary files)
* the `onClose` method had been introduced.
*
* > Note: Might be called multiple times on exit.
*
* > Note: This only includes browser instances created through `.launch()`.
*/
onClose(): Promise<void>;
/**
* After the plugin has been registered in `puppeteer-extra`.
*
* Normally right after `puppeteer.use(plugin)` is called
*/
onPluginRegistered(): Promise<void>;
/**
* Helper method to retrieve `data` objects from other plugins.
*
* A plugin needs to state the `dataFromPlugins` requirement
* in order to use this method. Will be mapped to `puppeteer.getPluginData`.
*
* @param name - Filter data by `name` property
*
* @see [data]
* @see [requirements]
*/
getDataFromPlugins(name?: string): PluginData[];
/**
* Will match plugin dependencies against all currently registered plugins.
* Is being called by `puppeteer-extra` and used to require missing dependencies.
*
* @param {Array<Object>} plugins
* @return {Set} - list of missing plugin names
*
* @private
*/
_getMissingDependencies(plugins: any): Set<string>;
/**
* Conditionally bind browser/process events to class members.
* The idea is to reduce event binding boilerplate in plugins.
*
* For efficiency we make sure the plugin is using the respective event
* by checking the child class members before registering the listener.
*
* @param {<Puppeteer.Browser>} browser
* @param {Object} opts - Options
* @param {string} opts.context - Puppeteer context (launch/connect)
* @param {Object} [opts.options] - Puppeteer launch or connect options
* @param {Array<string>} [opts.defaultArgs] - The default flags that Chromium will be launched with
*
* @private
*/
_bindBrowserEvents(browser: Puppeteer.Browser, opts?: any): Promise<void>;
/**
* @private
*/
_onTargetCreated(target: Puppeteer.Target): Promise<void>;
/**
* @private
*/
_register(prototype: any): void;
/**
* @private
*/
_registerChildClassMembers(prototype: any): void;
/**
* @private
*/
_hasChildClassMember(name: string): boolean;
/**
* @private
*/
get _isPuppeteerExtraPlugin(): boolean;
}

View File

@@ -0,0 +1,527 @@
/*!
* puppeteer-extra-plugin v3.2.2 by berstend
* https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin
* @license MIT
*/
import debug from 'debug';
/** @private */
const merge = require('merge-deep');
/**
* Base class for `puppeteer-extra` plugins.
*
* Provides convenience methods to avoid boilerplate.
*
* All common `puppeteer` browser events will be bound to
* the plugin instance, if a respectively named class member is found.
*
* Please refer to the [puppeteer API documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md) as well.
*
* @example
* // hello-world-plugin.js
* const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
*
* class Plugin extends PuppeteerExtraPlugin {
* constructor (opts = { }) { super(opts) }
*
* get name () { return 'hello-world' }
*
* async onPageCreated (page) {
* this.debug('page created', page.url())
* const ua = await page.browser().userAgent()
* this.debug('user agent', ua)
* }
* }
*
* module.exports = function (pluginConfig) { return new Plugin(pluginConfig) }
*
*
* // foo.js
* const puppeteer = require('puppeteer-extra')
* puppeteer.use(require('./hello-world-plugin')())
*
* ;(async () => {
* const browser = await puppeteer.launch({headless: false})
* const page = await browser.newPage()
* await page.goto('http://example.com', {waitUntil: 'domcontentloaded'})
* await browser.close()
* })()
*
*/
class PuppeteerExtraPlugin {
constructor(opts) {
this._debugBase = debug(`puppeteer-extra-plugin:base:${this.name}`);
this._childClassMembers = [];
this._opts = merge(this.defaults, opts || {});
this._debugBase('Initialized.');
}
/**
* Plugin name (required).
*
* Convention:
* - Package: `puppeteer-extra-plugin-anonymize-ua`
* - Name: `anonymize-ua`
*
* @example
* get name () { return 'anonymize-ua' }
*/
get name() {
throw new Error('Plugin must override "name"');
}
/**
* Plugin defaults (optional).
*
* If defined will be ([deep-](https://github.com/jonschlinkert/merge-deep))merged with the (optional) user supplied options (supplied during plugin instantiation).
*
* The result of merging defaults with user supplied options can be accessed through `this.opts`.
*
* @see [[opts]]
*
* @example
* get defaults () {
* return {
* stripHeadless: true,
* makeWindows: true,
* customFn: null
* }
* }
*
* // Users can overwrite plugin defaults during instantiation:
* puppeteer.use(require('puppeteer-extra-plugin-foobar')({ makeWindows: false }))
*/
get defaults() {
return {};
}
/**
* Plugin requirements (optional).
*
* Signal certain plugin requirements to the base class and the user.
*
* Currently supported:
* - `launch`
* - If the plugin only supports locally created browser instances (no `puppeteer.connect()`),
* will output a warning to the user.
* - `headful`
* - If the plugin doesn't work in `headless: true` mode,
* will output a warning to the user.
* - `dataFromPlugins`
* - In case the plugin requires data from other plugins.
* will enable usage of `this.getDataFromPlugins()`.
* - `runLast`
* - In case the plugin prefers to run after the others.
* Useful when the plugin needs data from others.
*
* @example
* get requirements () {
* return new Set(['runLast', 'dataFromPlugins'])
* }
*/
get requirements() {
return new Set([]);
}
/**
* Plugin dependencies (optional).
*
* Missing plugins will be required() by puppeteer-extra.
*
* @example
* get dependencies () {
* return new Set(['user-preferences'])
* }
* // Will ensure the 'puppeteer-extra-plugin-user-preferences' plugin is loaded.
*/
get dependencies() {
return new Set([]);
}
/**
* Plugin data (optional).
*
* Plugins can expose data (an array of objects), which in turn can be consumed by other plugins,
* that list the `dataFromPlugins` requirement (by using `this.getDataFromPlugins()`).
*
* Convention: `[ {name: 'Any name', value: 'Any value'} ]`
*
* @see [[getDataFromPlugins]]
*
* @example
* // plugin1.js
* get data () {
* return [
* {
* name: 'userPreferences',
* value: { foo: 'bar' }
* },
* {
* name: 'userPreferences',
* value: { hello: 'world' }
* }
* ]
*
* // plugin2.js
* get requirements () { return new Set(['dataFromPlugins']) }
*
* async beforeLaunch () {
* const prefs = this.getDataFromPlugins('userPreferences').map(d => d.value)
* this.debug(prefs) // => [ { foo: 'bar' }, { hello: 'world' } ]
* }
*/
get data() {
return [];
}
/**
* Access the plugin options (usually the `defaults` merged with user defined options)
*
* To skip the auto-merging of defaults with user supplied opts don't define a `defaults`
* property and set the `this._opts` Object in your plugin constructor directly.
*
* @see [[defaults]]
*
* @example
* get defaults () { return { foo: "bar" } }
*
* async onPageCreated (page) {
* this.debug(this.opts.foo) // => bar
* }
*/
get opts() {
return this._opts;
}
/**
* Convenience debug logger based on the [debug] module.
* Will automatically namespace the logging output to the plugin package name.
* [debug]: https://www.npmjs.com/package/debug
*
* ```bash
* # toggle output using environment variables
* DEBUG=puppeteer-extra-plugin:<plugin_name> node foo.js
* # to debug all the things:
* DEBUG=puppeteer-extra,puppeteer-extra-plugin:* node foo.js
* ```
*
* @example
* this.debug('hello world')
* // will output e.g. 'puppeteer-extra-plugin:anonymize-ua hello world'
*/
get debug() {
return debug(`puppeteer-extra-plugin:${this.name}`);
}
/**
* Before a new browser instance is created/launched.
*
* Can be used to modify the puppeteer launch options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @example
* async beforeLaunch (options) {
* if (this.opts.flashPluginPath) {
* options.args.push(`--ppapi-flash-path=${this.opts.flashPluginPath}`)
* }
* }
*
* @param options - Puppeteer launch options
*/
async beforeLaunch(options) {
// noop
}
/**
* After the browser has launched.
*
* Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
* It's possible that `pupeeteer.launch` will be called multiple times and more than one browser created.
* In order to make the plugins as stateless as possible don't store a reference to the browser instance
* in the plugin but rather consider alternatives.
*
* E.g. when using `onPageCreated` you can get a browser reference by using `page.browser()`.
*
* Alternatively you could expose a class method that takes a browser instance as a parameter to work with:
*
* ```es6
* const fancyPlugin = require('puppeteer-extra-plugin-fancy')()
* puppeteer.use(fancyPlugin)
* const browser = await puppeteer.launch()
* await fancyPlugin.killBrowser(browser)
* ```
*
* @param browser - The `puppeteer` browser instance.
* @param opts.options - Puppeteer launch options used.
*
* @example
* async afterLaunch (browser, opts) {
* this.debug('browser has been launched', opts.options)
* }
*/
async afterLaunch(browser, opts = { options: {} }) {
// noop
}
/**
* Before connecting to an existing browser instance.
*
* Can be used to modify the puppeteer connect options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @param {Object} options - Puppeteer connect options
* @return {Object=}
*/
async beforeConnect(options) {
// noop
}
/**
* After connecting to an existing browser instance.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
* @param {Object} opts
* @param {Object} opts.options - Puppeteer connect options used.
*
*/
async afterConnect(browser, opts = {}) {
// noop
}
/**
* Called when a browser instance is available.
*
* This applies to both `puppeteer.launch()` and `puppeteer.connect()`.
*
* Convenience method created for plugins that need access to a browser instance
* and don't mind if it has been created through `launch` or `connect`.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
*/
async onBrowser(browser, opts) {
// noop
}
/**
* Called when a target is created, for example when a new page is opened by window.open or browser.newPage.
*
* > Note: This includes target creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetCreated(target) {
// noop
}
/**
* Same as `onTargetCreated` but prefiltered to only contain Pages, for convenience.
*
* > Note: This includes page creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*
* @example
* async onPageCreated (page) {
* let ua = await page.browser().userAgent()
* if (this.opts.stripHeadless) {
* ua = ua.replace('HeadlessChrome/', 'Chrome/')
* }
* this.debug('new ua', ua)
* await page.setUserAgent(ua)
* }
*/
async onPageCreated(page) {
// noop
}
/**
* Called when the url of a target changes.
*
* > Note: This includes target changes in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetChanged(target) {
// noop
}
/**
* Called when a target is destroyed, for example when a page is closed.
*
* > Note: This includes target destructions in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetDestroyed(target) {
// noop
}
/**
* Called when Puppeteer gets disconnected from the Chromium instance.
*
* This might happen because of one of the following:
* - Chromium is closed or crashed
* - The `browser.disconnect` method was called
*/
async onDisconnected() {
// noop
}
/**
* **Deprecated:** Since puppeteer v1.6.0 `onDisconnected` has been improved
* and should be used instead of `onClose`.
*
* In puppeteer < v1.6.0 `onDisconnected` was not catching all exit scenarios.
* In order for plugins to clean up properly (e.g. deleting temporary files)
* the `onClose` method had been introduced.
*
* > Note: Might be called multiple times on exit.
*
* > Note: This only includes browser instances created through `.launch()`.
*/
async onClose() {
// noop
}
/**
* After the plugin has been registered in `puppeteer-extra`.
*
* Normally right after `puppeteer.use(plugin)` is called
*/
async onPluginRegistered() {
// noop
}
/**
* Helper method to retrieve `data` objects from other plugins.
*
* A plugin needs to state the `dataFromPlugins` requirement
* in order to use this method. Will be mapped to `puppeteer.getPluginData`.
*
* @param name - Filter data by `name` property
*
* @see [data]
* @see [requirements]
*/
getDataFromPlugins(name) {
return [];
}
/**
* Will match plugin dependencies against all currently registered plugins.
* Is being called by `puppeteer-extra` and used to require missing dependencies.
*
* @param {Array<Object>} plugins
* @return {Set} - list of missing plugin names
*
* @private
*/
_getMissingDependencies(plugins) {
const pluginNames = new Set(plugins.map((p) => p.name));
const missing = new Set(Array.from(this.dependencies.values()).filter(x => !pluginNames.has(x)));
return missing;
}
/**
* Conditionally bind browser/process events to class members.
* The idea is to reduce event binding boilerplate in plugins.
*
* For efficiency we make sure the plugin is using the respective event
* by checking the child class members before registering the listener.
*
* @param {<Puppeteer.Browser>} browser
* @param {Object} opts - Options
* @param {string} opts.context - Puppeteer context (launch/connect)
* @param {Object} [opts.options] - Puppeteer launch or connect options
* @param {Array<string>} [opts.defaultArgs] - The default flags that Chromium will be launched with
*
* @private
*/
async _bindBrowserEvents(browser, opts = {}) {
if (this._hasChildClassMember('onTargetCreated') ||
this._hasChildClassMember('onPageCreated')) {
browser.on('targetcreated', this._onTargetCreated.bind(this));
}
if (this._hasChildClassMember('onTargetChanged') && this.onTargetChanged) {
browser.on('targetchanged', this.onTargetChanged.bind(this));
}
if (this._hasChildClassMember('onTargetDestroyed') &&
this.onTargetDestroyed) {
browser.on('targetdestroyed', this.onTargetDestroyed.bind(this));
}
if (this._hasChildClassMember('onDisconnected') && this.onDisconnected) {
browser.on('disconnected', this.onDisconnected.bind(this));
}
if (opts.context === 'launch' && this._hasChildClassMember('onClose')) {
// The disconnect event has been improved since puppeteer v1.6.0
// onClose is being kept mostly for legacy reasons
if (this.onClose) {
process.on('exit', this.onClose.bind(this));
browser.on('disconnected', this.onClose.bind(this));
if (opts.options.handleSIGINT !== false) {
process.on('SIGINT', this.onClose.bind(this));
}
if (opts.options.handleSIGTERM !== false) {
process.on('SIGTERM', this.onClose.bind(this));
}
if (opts.options.handleSIGHUP !== false) {
process.on('SIGHUP', this.onClose.bind(this));
}
}
}
if (opts.context === 'launch' && this.afterLaunch) {
await this.afterLaunch(browser, opts);
}
if (opts.context === 'connect' && this.afterConnect) {
await this.afterConnect(browser, opts);
}
if (this.onBrowser)
await this.onBrowser(browser, opts);
}
/**
* @private
*/
async _onTargetCreated(target) {
if (this.onTargetCreated)
await this.onTargetCreated(target);
// Pre filter pages for plugin developers convenience
if (target.type() === 'page') {
try {
const page = await target.page();
if (!page) {
return;
}
const validPage = 'isClosed' in page && !page.isClosed();
if (this.onPageCreated && validPage) {
await this.onPageCreated(page);
}
}
catch (err) {
console.error(err);
}
}
}
/**
* @private
*/
_register(prototype) {
this._registerChildClassMembers(prototype);
if (this.onPluginRegistered)
this.onPluginRegistered();
}
/**
* @private
*/
_registerChildClassMembers(prototype) {
this._childClassMembers = Object.getOwnPropertyNames(prototype);
}
/**
* @private
*/
_hasChildClassMember(name) {
return !!this._childClassMembers.includes(name);
}
/**
* @private
*/
get _isPuppeteerExtraPlugin() {
return true;
}
}
export { PuppeteerExtraPlugin };
//# sourceMappingURL=index.esm.js.map

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,526 @@
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PuppeteerExtraPlugin = void 0;
const debug_1 = __importDefault(require("debug"));
/** @private */
const merge = require('merge-deep');
/**
* Base class for `puppeteer-extra` plugins.
*
* Provides convenience methods to avoid boilerplate.
*
* All common `puppeteer` browser events will be bound to
* the plugin instance, if a respectively named class member is found.
*
* Please refer to the [puppeteer API documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md) as well.
*
* @example
* // hello-world-plugin.js
* const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
*
* class Plugin extends PuppeteerExtraPlugin {
* constructor (opts = { }) { super(opts) }
*
* get name () { return 'hello-world' }
*
* async onPageCreated (page) {
* this.debug('page created', page.url())
* const ua = await page.browser().userAgent()
* this.debug('user agent', ua)
* }
* }
*
* module.exports = function (pluginConfig) { return new Plugin(pluginConfig) }
*
*
* // foo.js
* const puppeteer = require('puppeteer-extra')
* puppeteer.use(require('./hello-world-plugin')())
*
* ;(async () => {
* const browser = await puppeteer.launch({headless: false})
* const page = await browser.newPage()
* await page.goto('http://example.com', {waitUntil: 'domcontentloaded'})
* await browser.close()
* })()
*
*/
class PuppeteerExtraPlugin {
constructor(opts) {
this._debugBase = (0, debug_1.default)(`puppeteer-extra-plugin:base:${this.name}`);
this._childClassMembers = [];
this._opts = merge(this.defaults, opts || {});
this._debugBase('Initialized.');
}
/**
* Plugin name (required).
*
* Convention:
* - Package: `puppeteer-extra-plugin-anonymize-ua`
* - Name: `anonymize-ua`
*
* @example
* get name () { return 'anonymize-ua' }
*/
get name() {
throw new Error('Plugin must override "name"');
}
/**
* Plugin defaults (optional).
*
* If defined will be ([deep-](https://github.com/jonschlinkert/merge-deep))merged with the (optional) user supplied options (supplied during plugin instantiation).
*
* The result of merging defaults with user supplied options can be accessed through `this.opts`.
*
* @see [[opts]]
*
* @example
* get defaults () {
* return {
* stripHeadless: true,
* makeWindows: true,
* customFn: null
* }
* }
*
* // Users can overwrite plugin defaults during instantiation:
* puppeteer.use(require('puppeteer-extra-plugin-foobar')({ makeWindows: false }))
*/
get defaults() {
return {};
}
/**
* Plugin requirements (optional).
*
* Signal certain plugin requirements to the base class and the user.
*
* Currently supported:
* - `launch`
* - If the plugin only supports locally created browser instances (no `puppeteer.connect()`),
* will output a warning to the user.
* - `headful`
* - If the plugin doesn't work in `headless: true` mode,
* will output a warning to the user.
* - `dataFromPlugins`
* - In case the plugin requires data from other plugins.
* will enable usage of `this.getDataFromPlugins()`.
* - `runLast`
* - In case the plugin prefers to run after the others.
* Useful when the plugin needs data from others.
*
* @example
* get requirements () {
* return new Set(['runLast', 'dataFromPlugins'])
* }
*/
get requirements() {
return new Set([]);
}
/**
* Plugin dependencies (optional).
*
* Missing plugins will be required() by puppeteer-extra.
*
* @example
* get dependencies () {
* return new Set(['user-preferences'])
* }
* // Will ensure the 'puppeteer-extra-plugin-user-preferences' plugin is loaded.
*/
get dependencies() {
return new Set([]);
}
/**
* Plugin data (optional).
*
* Plugins can expose data (an array of objects), which in turn can be consumed by other plugins,
* that list the `dataFromPlugins` requirement (by using `this.getDataFromPlugins()`).
*
* Convention: `[ {name: 'Any name', value: 'Any value'} ]`
*
* @see [[getDataFromPlugins]]
*
* @example
* // plugin1.js
* get data () {
* return [
* {
* name: 'userPreferences',
* value: { foo: 'bar' }
* },
* {
* name: 'userPreferences',
* value: { hello: 'world' }
* }
* ]
*
* // plugin2.js
* get requirements () { return new Set(['dataFromPlugins']) }
*
* async beforeLaunch () {
* const prefs = this.getDataFromPlugins('userPreferences').map(d => d.value)
* this.debug(prefs) // => [ { foo: 'bar' }, { hello: 'world' } ]
* }
*/
get data() {
return [];
}
/**
* Access the plugin options (usually the `defaults` merged with user defined options)
*
* To skip the auto-merging of defaults with user supplied opts don't define a `defaults`
* property and set the `this._opts` Object in your plugin constructor directly.
*
* @see [[defaults]]
*
* @example
* get defaults () { return { foo: "bar" } }
*
* async onPageCreated (page) {
* this.debug(this.opts.foo) // => bar
* }
*/
get opts() {
return this._opts;
}
/**
* Convenience debug logger based on the [debug] module.
* Will automatically namespace the logging output to the plugin package name.
* [debug]: https://www.npmjs.com/package/debug
*
* ```bash
* # toggle output using environment variables
* DEBUG=puppeteer-extra-plugin:<plugin_name> node foo.js
* # to debug all the things:
* DEBUG=puppeteer-extra,puppeteer-extra-plugin:* node foo.js
* ```
*
* @example
* this.debug('hello world')
* // will output e.g. 'puppeteer-extra-plugin:anonymize-ua hello world'
*/
get debug() {
return (0, debug_1.default)(`puppeteer-extra-plugin:${this.name}`);
}
/**
* Before a new browser instance is created/launched.
*
* Can be used to modify the puppeteer launch options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @example
* async beforeLaunch (options) {
* if (this.opts.flashPluginPath) {
* options.args.push(`--ppapi-flash-path=${this.opts.flashPluginPath}`)
* }
* }
*
* @param options - Puppeteer launch options
*/
async beforeLaunch(options) {
// noop
}
/**
* After the browser has launched.
*
* Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
* It's possible that `pupeeteer.launch` will be called multiple times and more than one browser created.
* In order to make the plugins as stateless as possible don't store a reference to the browser instance
* in the plugin but rather consider alternatives.
*
* E.g. when using `onPageCreated` you can get a browser reference by using `page.browser()`.
*
* Alternatively you could expose a class method that takes a browser instance as a parameter to work with:
*
* ```es6
* const fancyPlugin = require('puppeteer-extra-plugin-fancy')()
* puppeteer.use(fancyPlugin)
* const browser = await puppeteer.launch()
* await fancyPlugin.killBrowser(browser)
* ```
*
* @param browser - The `puppeteer` browser instance.
* @param opts.options - Puppeteer launch options used.
*
* @example
* async afterLaunch (browser, opts) {
* this.debug('browser has been launched', opts.options)
* }
*/
async afterLaunch(browser, opts = { options: {} }) {
// noop
}
/**
* Before connecting to an existing browser instance.
*
* Can be used to modify the puppeteer connect options by modifying or returning them.
*
* Plugins using this method will be called in sequence to each
* be able to update the launch options.
*
* @param {Object} options - Puppeteer connect options
* @return {Object=}
*/
async beforeConnect(options) {
// noop
}
/**
* After connecting to an existing browser instance.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
* @param {Object} opts
* @param {Object} opts.options - Puppeteer connect options used.
*
*/
async afterConnect(browser, opts = {}) {
// noop
}
/**
* Called when a browser instance is available.
*
* This applies to both `puppeteer.launch()` and `puppeteer.connect()`.
*
* Convenience method created for plugins that need access to a browser instance
* and don't mind if it has been created through `launch` or `connect`.
*
* > Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
*
* @param browser - The `puppeteer` browser instance.
*/
async onBrowser(browser, opts) {
// noop
}
/**
* Called when a target is created, for example when a new page is opened by window.open or browser.newPage.
*
* > Note: This includes target creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetCreated(target) {
// noop
}
/**
* Same as `onTargetCreated` but prefiltered to only contain Pages, for convenience.
*
* > Note: This includes page creations in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*
* @example
* async onPageCreated (page) {
* let ua = await page.browser().userAgent()
* if (this.opts.stripHeadless) {
* ua = ua.replace('HeadlessChrome/', 'Chrome/')
* }
* this.debug('new ua', ua)
* await page.setUserAgent(ua)
* }
*/
async onPageCreated(page) {
// noop
}
/**
* Called when the url of a target changes.
*
* > Note: This includes target changes in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetChanged(target) {
// noop
}
/**
* Called when a target is destroyed, for example when a page is closed.
*
* > Note: This includes target destructions in incognito browser contexts.
*
* > Note: This includes browser instances created through `.launch()` as well as `.connect()`.
*
* @param {Puppeteer.Target} target
*/
async onTargetDestroyed(target) {
// noop
}
/**
* Called when Puppeteer gets disconnected from the Chromium instance.
*
* This might happen because of one of the following:
* - Chromium is closed or crashed
* - The `browser.disconnect` method was called
*/
async onDisconnected() {
// noop
}
/**
* **Deprecated:** Since puppeteer v1.6.0 `onDisconnected` has been improved
* and should be used instead of `onClose`.
*
* In puppeteer < v1.6.0 `onDisconnected` was not catching all exit scenarios.
* In order for plugins to clean up properly (e.g. deleting temporary files)
* the `onClose` method had been introduced.
*
* > Note: Might be called multiple times on exit.
*
* > Note: This only includes browser instances created through `.launch()`.
*/
async onClose() {
// noop
}
/**
* After the plugin has been registered in `puppeteer-extra`.
*
* Normally right after `puppeteer.use(plugin)` is called
*/
async onPluginRegistered() {
// noop
}
/**
* Helper method to retrieve `data` objects from other plugins.
*
* A plugin needs to state the `dataFromPlugins` requirement
* in order to use this method. Will be mapped to `puppeteer.getPluginData`.
*
* @param name - Filter data by `name` property
*
* @see [data]
* @see [requirements]
*/
getDataFromPlugins(name) {
return [];
}
/**
* Will match plugin dependencies against all currently registered plugins.
* Is being called by `puppeteer-extra` and used to require missing dependencies.
*
* @param {Array<Object>} plugins
* @return {Set} - list of missing plugin names
*
* @private
*/
_getMissingDependencies(plugins) {
const pluginNames = new Set(plugins.map((p) => p.name));
const missing = new Set(Array.from(this.dependencies.values()).filter(x => !pluginNames.has(x)));
return missing;
}
/**
* Conditionally bind browser/process events to class members.
* The idea is to reduce event binding boilerplate in plugins.
*
* For efficiency we make sure the plugin is using the respective event
* by checking the child class members before registering the listener.
*
* @param {<Puppeteer.Browser>} browser
* @param {Object} opts - Options
* @param {string} opts.context - Puppeteer context (launch/connect)
* @param {Object} [opts.options] - Puppeteer launch or connect options
* @param {Array<string>} [opts.defaultArgs] - The default flags that Chromium will be launched with
*
* @private
*/
async _bindBrowserEvents(browser, opts = {}) {
if (this._hasChildClassMember('onTargetCreated') ||
this._hasChildClassMember('onPageCreated')) {
browser.on('targetcreated', this._onTargetCreated.bind(this));
}
if (this._hasChildClassMember('onTargetChanged') && this.onTargetChanged) {
browser.on('targetchanged', this.onTargetChanged.bind(this));
}
if (this._hasChildClassMember('onTargetDestroyed') &&
this.onTargetDestroyed) {
browser.on('targetdestroyed', this.onTargetDestroyed.bind(this));
}
if (this._hasChildClassMember('onDisconnected') && this.onDisconnected) {
browser.on('disconnected', this.onDisconnected.bind(this));
}
if (opts.context === 'launch' && this._hasChildClassMember('onClose')) {
// The disconnect event has been improved since puppeteer v1.6.0
// onClose is being kept mostly for legacy reasons
if (this.onClose) {
process.on('exit', this.onClose.bind(this));
browser.on('disconnected', this.onClose.bind(this));
if (opts.options.handleSIGINT !== false) {
process.on('SIGINT', this.onClose.bind(this));
}
if (opts.options.handleSIGTERM !== false) {
process.on('SIGTERM', this.onClose.bind(this));
}
if (opts.options.handleSIGHUP !== false) {
process.on('SIGHUP', this.onClose.bind(this));
}
}
}
if (opts.context === 'launch' && this.afterLaunch) {
await this.afterLaunch(browser, opts);
}
if (opts.context === 'connect' && this.afterConnect) {
await this.afterConnect(browser, opts);
}
if (this.onBrowser)
await this.onBrowser(browser, opts);
}
/**
* @private
*/
async _onTargetCreated(target) {
if (this.onTargetCreated)
await this.onTargetCreated(target);
// Pre filter pages for plugin developers convenience
if (target.type() === 'page') {
try {
const page = await target.page();
if (!page) {
return;
}
const validPage = 'isClosed' in page && !page.isClosed();
if (this.onPageCreated && validPage) {
await this.onPageCreated(page);
}
}
catch (err) {
console.error(err);
}
}
}
/**
* @private
*/
_register(prototype) {
this._registerChildClassMembers(prototype);
if (this.onPluginRegistered)
this.onPluginRegistered();
}
/**
* @private
*/
_registerChildClassMembers(prototype) {
this._childClassMembers = Object.getOwnPropertyNames(prototype);
}
/**
* @private
*/
_hasChildClassMember(name) {
return !!this._childClassMembers.includes(name);
}
/**
* @private
*/
get _isPuppeteerExtraPlugin() {
return true;
}
}
exports.PuppeteerExtraPlugin = PuppeteerExtraPlugin;
//# sourceMappingURL=index.js.map

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1 @@
export {};

View File

@@ -0,0 +1,115 @@
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const ava_1 = __importDefault(require("ava"));
const _1 = require(".");
(0, ava_1.default)('is a function', async (t) => {
t.is(typeof _1.PuppeteerExtraPlugin, 'function');
});
(0, ava_1.default)('will throw without a name', async (t) => {
class Derived extends _1.PuppeteerExtraPlugin {
}
const error = await t.throws(() => new Derived());
t.is(error.message, `Plugin must override "name"`);
});
(0, ava_1.default)('should have the basic class members', async (t) => {
const pluginName = 'hello-world';
class Plugin extends _1.PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts);
}
get name() {
return pluginName;
}
}
const instance = new Plugin();
t.is(instance.name, pluginName);
t.true(instance.requirements instanceof Set);
t.true(instance.dependencies instanceof Set);
t.true(instance.data instanceof Array);
t.true(instance.defaults instanceof Object);
t.is(instance.data.length, 0);
t.true(instance.debug instanceof Function);
t.is(instance.debug.namespace, `puppeteer-extra-plugin:${pluginName}`);
t.true(instance._isPuppeteerExtraPlugin);
});
(0, ava_1.default)('should have the public class members', async (t) => {
const pluginName = 'hello-world';
class Plugin extends _1.PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts);
}
get name() {
return pluginName;
}
}
const instance = new Plugin();
t.true(instance.beforeLaunch instanceof Function);
t.true(instance.afterLaunch instanceof Function);
t.true(instance.onTargetCreated instanceof Function);
t.true(instance.onBrowser instanceof Function);
t.true(instance.onPageCreated instanceof Function);
t.true(instance.onTargetChanged instanceof Function);
t.true(instance.onTargetDestroyed instanceof Function);
t.true(instance.onDisconnected instanceof Function);
t.true(instance.onClose instanceof Function);
t.true(instance.onPluginRegistered instanceof Function);
t.true(instance.getDataFromPlugins instanceof Function);
});
(0, ava_1.default)('should have the internal class members', async (t) => {
const pluginName = 'hello-world';
class Plugin extends _1.PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts);
}
get name() {
return pluginName;
}
}
const instance = new Plugin();
t.true(instance._getMissingDependencies instanceof Function);
t.true(instance._bindBrowserEvents instanceof Function);
t.true(instance._onTargetCreated instanceof Function);
t.true(instance._register instanceof Function);
t.true(instance._registerChildClassMembers instanceof Function);
t.true(instance._hasChildClassMember instanceof Function);
});
(0, ava_1.default)('should merge opts with defaults automatically', async (t) => {
const pluginName = 'hello-world';
const pluginDefaults = { foo: 'bar', foo2: 'bar2', extra1: 123 };
const userOpts = { foo2: 'bob', extra2: 666 };
class Plugin extends _1.PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts);
}
get name() {
return pluginName;
}
get defaults() {
return pluginDefaults;
}
}
const instance = new Plugin(userOpts);
t.deepEqual(instance.defaults, pluginDefaults);
t.is(instance.opts.foo, pluginDefaults.foo);
t.is(instance.opts.foo2, userOpts.foo2);
t.is(instance.opts.extra1, pluginDefaults.extra1);
t.is(instance.opts.extra2, userOpts.extra2);
});
(0, ava_1.default)('should have opts when defaults is not defined', async (t) => {
const pluginName = 'hello-world';
const userOpts = { foo2: 'bob', extra2: 666 };
class Plugin extends _1.PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts);
}
get name() {
return pluginName;
}
}
const instance = new Plugin(userOpts);
t.deepEqual(instance.opts, userOpts);
});
//# sourceMappingURL=index.test.js.map

View File

@@ -0,0 +1 @@
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAsB;AAEtB,wBAAwC;AAExC,IAAA,aAAI,EAAC,eAAe,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9B,CAAC,CAAC,EAAE,CAAC,OAAO,uBAAoB,EAAE,UAAU,CAAC,CAAA;AAC/C,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,2BAA2B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1C,MAAM,OAAQ,SAAQ,uBAAoB;KAAG;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC,CAAA;IACjD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAA;AACpD,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,qCAAqC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpD,MAAM,UAAU,GAAG,aAAa,CAAA;IAChC,MAAM,MAAO,SAAQ,uBAAoB;QACvC,YAAY,IAAI,GAAG,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;QACD,IAAI,IAAI;YACN,OAAO,UAAU,CAAA;QACnB,CAAC;KACF;IACD,MAAM,QAAQ,GAAG,IAAI,MAAM,EAAE,CAAA;IAE7B,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,YAAY,GAAG,CAAC,CAAA;IAC5C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,YAAY,GAAG,CAAC,CAAA;IAC5C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,YAAY,KAAK,CAAC,CAAA;IACtC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,YAAY,MAAM,CAAC,CAAA;IAC3C,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAC7B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,YAAY,QAAQ,CAAC,CAAA;IAC1C,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,0BAA0B,UAAU,EAAE,CAAC,CAAA;IACtE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAA;AAC1C,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,sCAAsC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACrD,MAAM,UAAU,GAAG,aAAa,CAAA;IAChC,MAAM,MAAO,SAAQ,uBAAoB;QACvC,YAAY,IAAI,GAAG,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;QACD,IAAI,IAAI;YACN,OAAO,UAAU,CAAA;QACnB,CAAC;KACF;IACD,MAAM,QAAQ,GAAG,IAAI,MAAM,EAAE,CAAA;IAE7B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,YAAY,QAAQ,CAAC,CAAA;IACjD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,YAAY,QAAQ,CAAC,CAAA;IAChD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAA;IACpD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,YAAY,QAAQ,CAAC,CAAA;IAC9C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,YAAY,QAAQ,CAAC,CAAA;IAClD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAA;IACpD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,YAAY,QAAQ,CAAC,CAAA;IACtD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,YAAY,QAAQ,CAAC,CAAA;IACnD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,YAAY,QAAQ,CAAC,CAAA;IAC5C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,YAAY,QAAQ,CAAC,CAAA;IACvD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,YAAY,QAAQ,CAAC,CAAA;AACzD,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,wCAAwC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACvD,MAAM,UAAU,GAAG,aAAa,CAAA;IAChC,MAAM,MAAO,SAAQ,uBAAoB;QACvC,YAAY,IAAI,GAAG,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;QACD,IAAI,IAAI;YACN,OAAO,UAAU,CAAA;QACnB,CAAC;KACF;IACD,MAAM,QAAQ,GAAG,IAAI,MAAM,EAAE,CAAA;IAE7B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,YAAY,QAAQ,CAAC,CAAA;IAC5D,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,YAAY,QAAQ,CAAC,CAAA;IACvD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,YAAY,QAAQ,CAAC,CAAA;IACrD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,YAAY,QAAQ,CAAC,CAAA;IAC9C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,YAAY,QAAQ,CAAC,CAAA;IAC/D,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,YAAY,QAAQ,CAAC,CAAA;AAC3D,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,+CAA+C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9D,MAAM,UAAU,GAAG,aAAa,CAAA;IAChC,MAAM,cAAc,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;IAChE,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;IAE7C,MAAM,MAAO,SAAQ,uBAAoB;QACvC,YAAY,IAAI,GAAG,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;QACD,IAAI,IAAI;YACN,OAAO,UAAU,CAAA;QACnB,CAAC;QACD,IAAI,QAAQ;YACV,OAAO,cAAc,CAAA;QACvB,CAAC;KACF;IACD,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAA;IAErC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;IAC9C,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IACjD,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;AAC7C,CAAC,CAAC,CAAA;AAEF,IAAA,aAAI,EAAC,+CAA+C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9D,MAAM,UAAU,GAAG,aAAa,CAAA;IAChC,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAA;IAE7C,MAAM,MAAO,SAAQ,uBAAoB;QACvC,YAAY,IAAI,GAAG,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACb,CAAC;QACD,IAAI,IAAI;YACN,OAAO,UAAU,CAAA;QACnB,CAAC;KACF;IACD,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAA;IAErC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;AACtC,CAAC,CAAC,CAAA"}

View File

@@ -0,0 +1,5 @@
export { Browser } from 'puppeteer';
export { Page } from 'puppeteer';
export { Target } from 'puppeteer';
export { ConnectOptions } from 'puppeteer';
export { LaunchOptions } from 'puppeteer';

View File

@@ -0,0 +1,13 @@
"use strict";
// A wildcard import would result in a `require("puppeteer")` statement
// at the top of the transpiled js file, not what we want. :-/
// "import type" is a solution here but requires TS >= v3.8 which we don't want to require yet as a minimum.
Object.defineProperty(exports, "__esModule", { value: true });
exports.Target = exports.Page = exports.Browser = void 0;
var puppeteer_1 = require("puppeteer");
Object.defineProperty(exports, "Browser", { enumerable: true, get: function () { return puppeteer_1.Browser; } });
var puppeteer_2 = require("puppeteer");
Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return puppeteer_2.Page; } });
var puppeteer_3 = require("puppeteer");
Object.defineProperty(exports, "Target", { enumerable: true, get: function () { return puppeteer_3.Target; } });
//# sourceMappingURL=puppeteer.js.map

View File

@@ -0,0 +1 @@
{"version":3,"file":"puppeteer.js","sourceRoot":"","sources":["../src/puppeteer.ts"],"names":[],"mappings":";AAAA,uEAAuE;AACvE,8DAA8D;AAC9D,4GAA4G;;;AAE5G,uCAAmC;AAA1B,oGAAA,OAAO,OAAA;AAChB,uCAAgC;AAAvB,iGAAA,IAAI,OAAA;AACb,uCAAkC;AAAzB,mGAAA,MAAM,OAAA"}

View File

@@ -0,0 +1,20 @@
(The MIT License)
Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>
Copyright (c) 2018-2021 Josh Junon
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the 'Software'), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,481 @@
# debug
[![OpenCollective](https://opencollective.com/debug/backers/badge.svg)](#backers)
[![OpenCollective](https://opencollective.com/debug/sponsors/badge.svg)](#sponsors)
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
A tiny JavaScript debugging utility modelled after Node.js core's debugging
technique. Works in Node.js and web browsers.
## Installation
```bash
$ npm install debug
```
## Usage
`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.
Example [_app.js_](./examples/node/app.js):
```js
var debug = require('debug')('http')
, http = require('http')
, name = 'My App';
// fake app
debug('booting %o', name);
http.createServer(function(req, res){
debug(req.method + ' ' + req.url);
res.end('hello\n');
}).listen(3000, function(){
debug('listening');
});
// fake worker of some kind
require('./worker');
```
Example [_worker.js_](./examples/node/worker.js):
```js
var a = require('debug')('worker:a')
, b = require('debug')('worker:b');
function work() {
a('doing lots of uninteresting work');
setTimeout(work, Math.random() * 1000);
}
work();
function workb() {
b('doing some work');
setTimeout(workb, Math.random() * 2000);
}
workb();
```
The `DEBUG` environment variable is then used to enable these based on space or
comma-delimited names.
Here are some examples:
<img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png">
<img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png">
<img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png">
#### Windows command prompt notes
##### CMD
On Windows the environment variable is set using the `set` command.
```cmd
set DEBUG=*,-not_this
```
Example:
```cmd
set DEBUG=* & node app.js
```
##### PowerShell (VS Code default)
PowerShell uses different syntax to set environment variables.
```cmd
$env:DEBUG = "*,-not_this"
```
Example:
```cmd
$env:DEBUG='app';node app.js
```
Then, run the program to be debugged as usual.
npm script example:
```js
"windowsDebug": "@powershell -Command $env:DEBUG='*';node app.js",
```
## Namespace Colors
Every debug instance has a color generated for it based on its namespace name.
This helps when visually parsing the debug output to identify which debug instance
a debug line belongs to.
#### Node.js
In Node.js, colors are enabled when stderr is a TTY. You also _should_ install
the [`supports-color`](https://npmjs.org/supports-color) module alongside debug,
otherwise debug will only use a small handful of basic colors.
<img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png">
#### Web Browser
Colors are also enabled on "Web Inspectors" that understand the `%c` formatting
option. These are WebKit web inspectors, Firefox ([since version
31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))
and the Firebug plugin for Firefox (any version).
<img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png">
## Millisecond diff
When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls.
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png">
When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:
<img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png">
## Conventions
If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.
## Wildcards
The `*` character may be used as a wildcard. Suppose for example your library has
debuggers named "connect:bodyParser", "connect:compress", "connect:session",
instead of listing all three with
`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do
`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.
You can also exclude specific debuggers by prefixing them with a "-" character.
For example, `DEBUG=*,-connect:*` would include all debuggers except those
starting with "connect:".
## Environment Variables
When running through Node.js, you can set a few environment variables that will
change the behavior of the debug logging:
| Name | Purpose |
|-----------|-------------------------------------------------|
| `DEBUG` | Enables/disables specific debugging namespaces. |
| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |
| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |
| `DEBUG_DEPTH` | Object inspection depth. |
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |
__Note:__ The environment variables beginning with `DEBUG_` end up being
converted into an Options object that gets used with `%o`/`%O` formatters.
See the Node.js documentation for
[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)
for the complete list.
## Formatters
Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.
Below are the officially supported formatters:
| Formatter | Representation |
|-----------|----------------|
| `%O` | Pretty-print an Object on multiple lines. |
| `%o` | Pretty-print an Object all on a single line. |
| `%s` | String. |
| `%d` | Number (both integer and float). |
| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |
| `%%` | Single percent sign ('%'). This does not consume an argument. |
### Custom formatters
You can add custom formatters by extending the `debug.formatters` object.
For example, if you wanted to add support for rendering a Buffer as hex with
`%h`, you could do something like:
```js
const createDebug = require('debug')
createDebug.formatters.h = (v) => {
return v.toString('hex')
}
// …elsewhere
const debug = createDebug('foo')
debug('this is hex: %h', new Buffer('hello world'))
// foo this is hex: 68656c6c6f20776f726c6421 +0ms
```
## Browser Support
You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),
or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),
if you don't want to build it yourself.
Debug's enable state is currently persisted by `localStorage`.
Consider the situation shown below where you have `worker:a` and `worker:b`,
and wish to debug both. You can enable this using `localStorage.debug`:
```js
localStorage.debug = 'worker:*'
```
And then refresh the page.
```js
a = debug('worker:a');
b = debug('worker:b');
setInterval(function(){
a('doing some work');
}, 1000);
setInterval(function(){
b('doing some work');
}, 1200);
```
In Chromium-based web browsers (e.g. Brave, Chrome, and Electron), the JavaScript console will—by default—only show messages logged by `debug` if the "Verbose" log level is _enabled_.
<img width="647" src="https://user-images.githubusercontent.com/7143133/152083257-29034707-c42c-4959-8add-3cee850e6fcf.png">
## Output streams
By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:
Example [_stdout.js_](./examples/node/stdout.js):
```js
var debug = require('debug');
var error = debug('app:error');
// by default stderr is used
error('goes to stderr!');
var log = debug('app:log');
// set this namespace to log via console.log
log.log = console.log.bind(console); // don't forget to bind to console!
log('goes to stdout');
error('still goes to stderr!');
// set all output to go via console.info
// overrides all per-namespace log settings
debug.log = console.info.bind(console);
error('now goes to stdout via console.info');
log('still goes to stdout, but via console.info now');
```
## Extend
You can simply extend debugger
```js
const log = require('debug')('auth');
//creates new debug instance with extended namespace
const logSign = log.extend('sign');
const logLogin = log.extend('login');
log('hello'); // auth hello
logSign('hello'); //auth:sign hello
logLogin('hello'); //auth:login hello
```
## Set dynamically
You can also enable debug dynamically by calling the `enable()` method :
```js
let debug = require('debug');
console.log(1, debug.enabled('test'));
debug.enable('test');
console.log(2, debug.enabled('test'));
debug.disable();
console.log(3, debug.enabled('test'));
```
print :
```
1 false
2 true
3 false
```
Usage :
`enable(namespaces)`
`namespaces` can include modes separated by a colon and wildcards.
Note that calling `enable()` completely overrides previously set DEBUG variable :
```
$ DEBUG=foo node -e 'var dbg = require("debug"); dbg.enable("bar"); console.log(dbg.enabled("foo"))'
=> false
```
`disable()`
Will disable all namespaces. The functions returns the namespaces currently
enabled (and skipped). This can be useful if you want to disable debugging
temporarily without knowing what was enabled to begin with.
For example:
```js
let debug = require('debug');
debug.enable('foo:*,-foo:bar');
let namespaces = debug.disable();
debug.enable(namespaces);
```
Note: There is no guarantee that the string will be identical to the initial
enable string, but semantically they will be identical.
## Checking whether a debug target is enabled
After you've created a debug instance, you can determine whether or not it is
enabled by checking the `enabled` property:
```javascript
const debug = require('debug')('http');
if (debug.enabled) {
// do stuff...
}
```
You can also manually toggle this property to force the debug instance to be
enabled or disabled.
## Usage in child processes
Due to the way `debug` detects if the output is a TTY or not, colors are not shown in child processes when `stderr` is piped. A solution is to pass the `DEBUG_COLORS=1` environment variable to the child process.
For example:
```javascript
worker = fork(WORKER_WRAP_PATH, [workerPath], {
stdio: [
/* stdin: */ 0,
/* stdout: */ 'pipe',
/* stderr: */ 'pipe',
'ipc',
],
env: Object.assign({}, process.env, {
DEBUG_COLORS: 1 // without this settings, colors won't be shown
}),
});
worker.stderr.pipe(process.stderr, { end: false });
```
## Authors
- TJ Holowaychuk
- Nathan Rajlich
- Andrew Rhyne
- Josh Junon
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]
<a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a>
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]
<a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a>
## License
(The MIT License)
Copyright (c) 2014-2017 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
Copyright (c) 2018-2021 Josh Junon
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,64 @@
{
"name": "debug",
"version": "4.4.3",
"repository": {
"type": "git",
"url": "git://github.com/debug-js/debug.git"
},
"description": "Lightweight debugging utility for Node.js and the browser",
"keywords": [
"debug",
"log",
"debugger"
],
"files": [
"src",
"LICENSE",
"README.md"
],
"author": "Josh Junon (https://github.com/qix-)",
"contributors": [
"TJ Holowaychuk <tj@vision-media.ca>",
"Nathan Rajlich <nathan@tootallnate.net> (http://n8.io)",
"Andrew Rhyne <rhyneandrew@gmail.com>"
],
"license": "MIT",
"scripts": {
"lint": "xo",
"test": "npm run test:node && npm run test:browser && npm run lint",
"test:node": "mocha test.js test.node.js",
"test:browser": "karma start --single-run",
"test:coverage": "cat ./coverage/lcov.info | coveralls"
},
"dependencies": {
"ms": "^2.1.3"
},
"devDependencies": {
"brfs": "^2.0.1",
"browserify": "^16.2.3",
"coveralls": "^3.0.2",
"karma": "^3.1.4",
"karma-browserify": "^6.0.0",
"karma-chrome-launcher": "^2.2.0",
"karma-mocha": "^1.3.0",
"mocha": "^5.2.0",
"mocha-lcov-reporter": "^1.2.0",
"sinon": "^14.0.0",
"xo": "^0.23.0"
},
"peerDependenciesMeta": {
"supports-color": {
"optional": true
}
},
"main": "./src/index.js",
"browser": "./src/browser.js",
"engines": {
"node": ">=6.0"
},
"xo": {
"rules": {
"import/extensions": "off"
}
}
}

View File

@@ -0,0 +1,272 @@
/* eslint-env browser */
/**
* This is the web browser implementation of `debug()`.
*/
exports.formatArgs = formatArgs;
exports.save = save;
exports.load = load;
exports.useColors = useColors;
exports.storage = localstorage();
exports.destroy = (() => {
let warned = false;
return () => {
if (!warned) {
warned = true;
console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
}
};
})();
/**
* Colors.
*/
exports.colors = [
'#0000CC',
'#0000FF',
'#0033CC',
'#0033FF',
'#0066CC',
'#0066FF',
'#0099CC',
'#0099FF',
'#00CC00',
'#00CC33',
'#00CC66',
'#00CC99',
'#00CCCC',
'#00CCFF',
'#3300CC',
'#3300FF',
'#3333CC',
'#3333FF',
'#3366CC',
'#3366FF',
'#3399CC',
'#3399FF',
'#33CC00',
'#33CC33',
'#33CC66',
'#33CC99',
'#33CCCC',
'#33CCFF',
'#6600CC',
'#6600FF',
'#6633CC',
'#6633FF',
'#66CC00',
'#66CC33',
'#9900CC',
'#9900FF',
'#9933CC',
'#9933FF',
'#99CC00',
'#99CC33',
'#CC0000',
'#CC0033',
'#CC0066',
'#CC0099',
'#CC00CC',
'#CC00FF',
'#CC3300',
'#CC3333',
'#CC3366',
'#CC3399',
'#CC33CC',
'#CC33FF',
'#CC6600',
'#CC6633',
'#CC9900',
'#CC9933',
'#CCCC00',
'#CCCC33',
'#FF0000',
'#FF0033',
'#FF0066',
'#FF0099',
'#FF00CC',
'#FF00FF',
'#FF3300',
'#FF3333',
'#FF3366',
'#FF3399',
'#FF33CC',
'#FF33FF',
'#FF6600',
'#FF6633',
'#FF9900',
'#FF9933',
'#FFCC00',
'#FFCC33'
];
/**
* Currently only WebKit-based Web Inspectors, Firefox >= v31,
* and the Firebug extension (any Firefox version) are known
* to support "%c" CSS customizations.
*
* TODO: add a `localStorage` variable to explicitly enable/disable colors
*/
// eslint-disable-next-line complexity
function useColors() {
// NB: In an Electron preload script, document will be defined but not fully
// initialized. Since we know we're in Chrome, we'll just detect this case
// explicitly
if (typeof window !== 'undefined' && window.process && (window.process.type === 'renderer' || window.process.__nwjs)) {
return true;
}
// Internet Explorer and Edge do not support colors.
if (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) {
return false;
}
let m;
// Is webkit? http://stackoverflow.com/a/16459606/376773
// document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
// eslint-disable-next-line no-return-assign
return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
// Is firebug? http://stackoverflow.com/a/398120/376773
(typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
// Is firefox >= v31?
// https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
(typeof navigator !== 'undefined' && navigator.userAgent && (m = navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/)) && parseInt(m[1], 10) >= 31) ||
// Double check webkit in userAgent just in case we are in a worker
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
}
/**
* Colorize log arguments if enabled.
*
* @api public
*/
function formatArgs(args) {
args[0] = (this.useColors ? '%c' : '') +
this.namespace +
(this.useColors ? ' %c' : ' ') +
args[0] +
(this.useColors ? '%c ' : ' ') +
'+' + module.exports.humanize(this.diff);
if (!this.useColors) {
return;
}
const c = 'color: ' + this.color;
args.splice(1, 0, c, 'color: inherit');
// The final "%c" is somewhat tricky, because there could be other
// arguments passed either before or after the %c, so we need to
// figure out the correct index to insert the CSS into
let index = 0;
let lastC = 0;
args[0].replace(/%[a-zA-Z%]/g, match => {
if (match === '%%') {
return;
}
index++;
if (match === '%c') {
// We only are interested in the *last* %c
// (the user may have provided their own)
lastC = index;
}
});
args.splice(lastC, 0, c);
}
/**
* Invokes `console.debug()` when available.
* No-op when `console.debug` is not a "function".
* If `console.debug` is not available, falls back
* to `console.log`.
*
* @api public
*/
exports.log = console.debug || console.log || (() => {});
/**
* Save `namespaces`.
*
* @param {String} namespaces
* @api private
*/
function save(namespaces) {
try {
if (namespaces) {
exports.storage.setItem('debug', namespaces);
} else {
exports.storage.removeItem('debug');
}
} catch (error) {
// Swallow
// XXX (@Qix-) should we be logging these?
}
}
/**
* Load `namespaces`.
*
* @return {String} returns the previously persisted debug modes
* @api private
*/
function load() {
let r;
try {
r = exports.storage.getItem('debug') || exports.storage.getItem('DEBUG') ;
} catch (error) {
// Swallow
// XXX (@Qix-) should we be logging these?
}
// If debug isn't set in LS, and we're in Electron, try to load $DEBUG
if (!r && typeof process !== 'undefined' && 'env' in process) {
r = process.env.DEBUG;
}
return r;
}
/**
* Localstorage attempts to return the localstorage.
*
* This is necessary because safari throws
* when a user disables cookies/localstorage
* and you attempt to access it.
*
* @return {LocalStorage}
* @api private
*/
function localstorage() {
try {
// TVMLKit (Apple TV JS Runtime) does not have a window object, just localStorage in the global context
// The Browser also has localStorage in the global context.
return localStorage;
} catch (error) {
// Swallow
// XXX (@Qix-) should we be logging these?
}
}
module.exports = require('./common')(exports);
const {formatters} = module.exports;
/**
* Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
*/
formatters.j = function (v) {
try {
return JSON.stringify(v);
} catch (error) {
return '[UnexpectedJSONParseError]: ' + error.message;
}
};

View File

@@ -0,0 +1,292 @@
/**
* This is the common logic for both the Node.js and web browser
* implementations of `debug()`.
*/
function setup(env) {
createDebug.debug = createDebug;
createDebug.default = createDebug;
createDebug.coerce = coerce;
createDebug.disable = disable;
createDebug.enable = enable;
createDebug.enabled = enabled;
createDebug.humanize = require('ms');
createDebug.destroy = destroy;
Object.keys(env).forEach(key => {
createDebug[key] = env[key];
});
/**
* The currently active debug mode names, and names to skip.
*/
createDebug.names = [];
createDebug.skips = [];
/**
* Map of special "%n" handling functions, for the debug "format" argument.
*
* Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
*/
createDebug.formatters = {};
/**
* Selects a color for a debug namespace
* @param {String} namespace The namespace string for the debug instance to be colored
* @return {Number|String} An ANSI color code for the given namespace
* @api private
*/
function selectColor(namespace) {
let hash = 0;
for (let i = 0; i < namespace.length; i++) {
hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
hash |= 0; // Convert to 32bit integer
}
return createDebug.colors[Math.abs(hash) % createDebug.colors.length];
}
createDebug.selectColor = selectColor;
/**
* Create a debugger with the given `namespace`.
*
* @param {String} namespace
* @return {Function}
* @api public
*/
function createDebug(namespace) {
let prevTime;
let enableOverride = null;
let namespacesCache;
let enabledCache;
function debug(...args) {
// Disabled?
if (!debug.enabled) {
return;
}
const self = debug;
// Set `diff` timestamp
const curr = Number(new Date());
const ms = curr - (prevTime || curr);
self.diff = ms;
self.prev = prevTime;
self.curr = curr;
prevTime = curr;
args[0] = createDebug.coerce(args[0]);
if (typeof args[0] !== 'string') {
// Anything else let's inspect with %O
args.unshift('%O');
}
// Apply any `formatters` transformations
let index = 0;
args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {
// If we encounter an escaped % then don't increase the array index
if (match === '%%') {
return '%';
}
index++;
const formatter = createDebug.formatters[format];
if (typeof formatter === 'function') {
const val = args[index];
match = formatter.call(self, val);
// Now we need to remove `args[index]` since it's inlined in the `format`
args.splice(index, 1);
index--;
}
return match;
});
// Apply env-specific formatting (colors, etc.)
createDebug.formatArgs.call(self, args);
const logFn = self.log || createDebug.log;
logFn.apply(self, args);
}
debug.namespace = namespace;
debug.useColors = createDebug.useColors();
debug.color = createDebug.selectColor(namespace);
debug.extend = extend;
debug.destroy = createDebug.destroy; // XXX Temporary. Will be removed in the next major release.
Object.defineProperty(debug, 'enabled', {
enumerable: true,
configurable: false,
get: () => {
if (enableOverride !== null) {
return enableOverride;
}
if (namespacesCache !== createDebug.namespaces) {
namespacesCache = createDebug.namespaces;
enabledCache = createDebug.enabled(namespace);
}
return enabledCache;
},
set: v => {
enableOverride = v;
}
});
// Env-specific initialization logic for debug instances
if (typeof createDebug.init === 'function') {
createDebug.init(debug);
}
return debug;
}
function extend(namespace, delimiter) {
const newDebug = createDebug(this.namespace + (typeof delimiter === 'undefined' ? ':' : delimiter) + namespace);
newDebug.log = this.log;
return newDebug;
}
/**
* Enables a debug mode by namespaces. This can include modes
* separated by a colon and wildcards.
*
* @param {String} namespaces
* @api public
*/
function enable(namespaces) {
createDebug.save(namespaces);
createDebug.namespaces = namespaces;
createDebug.names = [];
createDebug.skips = [];
const split = (typeof namespaces === 'string' ? namespaces : '')
.trim()
.replace(/\s+/g, ',')
.split(',')
.filter(Boolean);
for (const ns of split) {
if (ns[0] === '-') {
createDebug.skips.push(ns.slice(1));
} else {
createDebug.names.push(ns);
}
}
}
/**
* Checks if the given string matches a namespace template, honoring
* asterisks as wildcards.
*
* @param {String} search
* @param {String} template
* @return {Boolean}
*/
function matchesTemplate(search, template) {
let searchIndex = 0;
let templateIndex = 0;
let starIndex = -1;
let matchIndex = 0;
while (searchIndex < search.length) {
if (templateIndex < template.length && (template[templateIndex] === search[searchIndex] || template[templateIndex] === '*')) {
// Match character or proceed with wildcard
if (template[templateIndex] === '*') {
starIndex = templateIndex;
matchIndex = searchIndex;
templateIndex++; // Skip the '*'
} else {
searchIndex++;
templateIndex++;
}
} else if (starIndex !== -1) { // eslint-disable-line no-negated-condition
// Backtrack to the last '*' and try to match more characters
templateIndex = starIndex + 1;
matchIndex++;
searchIndex = matchIndex;
} else {
return false; // No match
}
}
// Handle trailing '*' in template
while (templateIndex < template.length && template[templateIndex] === '*') {
templateIndex++;
}
return templateIndex === template.length;
}
/**
* Disable debug output.
*
* @return {String} namespaces
* @api public
*/
function disable() {
const namespaces = [
...createDebug.names,
...createDebug.skips.map(namespace => '-' + namespace)
].join(',');
createDebug.enable('');
return namespaces;
}
/**
* Returns true if the given mode name is enabled, false otherwise.
*
* @param {String} name
* @return {Boolean}
* @api public
*/
function enabled(name) {
for (const skip of createDebug.skips) {
if (matchesTemplate(name, skip)) {
return false;
}
}
for (const ns of createDebug.names) {
if (matchesTemplate(name, ns)) {
return true;
}
}
return false;
}
/**
* Coerce `val`.
*
* @param {Mixed} val
* @return {Mixed}
* @api private
*/
function coerce(val) {
if (val instanceof Error) {
return val.stack || val.message;
}
return val;
}
/**
* XXX DO NOT USE. This is a temporary stub function.
* XXX It WILL be removed in the next major release.
*/
function destroy() {
console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
}
createDebug.enable(createDebug.load());
return createDebug;
}
module.exports = setup;

View File

@@ -0,0 +1,10 @@
/**
* Detect Electron renderer / nwjs process, which is node, but we should
* treat as a browser.
*/
if (typeof process === 'undefined' || process.type === 'renderer' || process.browser === true || process.__nwjs) {
module.exports = require('./browser.js');
} else {
module.exports = require('./node.js');
}

View File

@@ -0,0 +1,263 @@
/**
* Module dependencies.
*/
const tty = require('tty');
const util = require('util');
/**
* This is the Node.js implementation of `debug()`.
*/
exports.init = init;
exports.log = log;
exports.formatArgs = formatArgs;
exports.save = save;
exports.load = load;
exports.useColors = useColors;
exports.destroy = util.deprecate(
() => {},
'Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.'
);
/**
* Colors.
*/
exports.colors = [6, 2, 3, 4, 5, 1];
try {
// Optional dependency (as in, doesn't need to be installed, NOT like optionalDependencies in package.json)
// eslint-disable-next-line import/no-extraneous-dependencies
const supportsColor = require('supports-color');
if (supportsColor && (supportsColor.stderr || supportsColor).level >= 2) {
exports.colors = [
20,
21,
26,
27,
32,
33,
38,
39,
40,
41,
42,
43,
44,
45,
56,
57,
62,
63,
68,
69,
74,
75,
76,
77,
78,
79,
80,
81,
92,
93,
98,
99,
112,
113,
128,
129,
134,
135,
148,
149,
160,
161,
162,
163,
164,
165,
166,
167,
168,
169,
170,
171,
172,
173,
178,
179,
184,
185,
196,
197,
198,
199,
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
214,
215,
220,
221
];
}
} catch (error) {
// Swallow - we only care if `supports-color` is available; it doesn't have to be.
}
/**
* Build up the default `inspectOpts` object from the environment variables.
*
* $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
*/
exports.inspectOpts = Object.keys(process.env).filter(key => {
return /^debug_/i.test(key);
}).reduce((obj, key) => {
// Camel-case
const prop = key
.substring(6)
.toLowerCase()
.replace(/_([a-z])/g, (_, k) => {
return k.toUpperCase();
});
// Coerce string value into JS value
let val = process.env[key];
if (/^(yes|on|true|enabled)$/i.test(val)) {
val = true;
} else if (/^(no|off|false|disabled)$/i.test(val)) {
val = false;
} else if (val === 'null') {
val = null;
} else {
val = Number(val);
}
obj[prop] = val;
return obj;
}, {});
/**
* Is stdout a TTY? Colored output is enabled when `true`.
*/
function useColors() {
return 'colors' in exports.inspectOpts ?
Boolean(exports.inspectOpts.colors) :
tty.isatty(process.stderr.fd);
}
/**
* Adds ANSI color escape codes if enabled.
*
* @api public
*/
function formatArgs(args) {
const {namespace: name, useColors} = this;
if (useColors) {
const c = this.color;
const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c);
const prefix = ` ${colorCode};1m${name} \u001B[0m`;
args[0] = prefix + args[0].split('\n').join('\n' + prefix);
args.push(colorCode + 'm+' + module.exports.humanize(this.diff) + '\u001B[0m');
} else {
args[0] = getDate() + name + ' ' + args[0];
}
}
function getDate() {
if (exports.inspectOpts.hideDate) {
return '';
}
return new Date().toISOString() + ' ';
}
/**
* Invokes `util.formatWithOptions()` with the specified arguments and writes to stderr.
*/
function log(...args) {
return process.stderr.write(util.formatWithOptions(exports.inspectOpts, ...args) + '\n');
}
/**
* Save `namespaces`.
*
* @param {String} namespaces
* @api private
*/
function save(namespaces) {
if (namespaces) {
process.env.DEBUG = namespaces;
} else {
// If you set a process.env field to null or undefined, it gets cast to the
// string 'null' or 'undefined'. Just delete instead.
delete process.env.DEBUG;
}
}
/**
* Load `namespaces`.
*
* @return {String} returns the previously persisted debug modes
* @api private
*/
function load() {
return process.env.DEBUG;
}
/**
* Init logic for `debug` instances.
*
* Create a new `inspectOpts` object in case `useColors` is set
* differently for a particular `debug` instance.
*/
function init(debug) {
debug.inspectOpts = {};
const keys = Object.keys(exports.inspectOpts);
for (let i = 0; i < keys.length; i++) {
debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
}
}
module.exports = require('./common')(exports);
const {formatters} = module.exports;
/**
* Map %o to `util.inspect()`, all on a single line.
*/
formatters.o = function (v) {
this.inspectOpts.colors = this.useColors;
return util.inspect(v, this.inspectOpts)
.split('\n')
.map(str => str.trim())
.join(' ');
};
/**
* Map %O to `util.inspect()`, allowing multiple lines if needed.
*/
formatters.O = function (v) {
this.inspectOpts.colors = this.useColors;
return util.inspect(v, this.inspectOpts);
};

View File

@@ -0,0 +1,162 @@
/**
* Helpers.
*/
var s = 1000;
var m = s * 60;
var h = m * 60;
var d = h * 24;
var w = d * 7;
var y = d * 365.25;
/**
* Parse or format the given `val`.
*
* Options:
*
* - `long` verbose formatting [false]
*
* @param {String|Number} val
* @param {Object} [options]
* @throws {Error} throw an error if val is not a non-empty string or a number
* @return {String|Number}
* @api public
*/
module.exports = function (val, options) {
options = options || {};
var type = typeof val;
if (type === 'string' && val.length > 0) {
return parse(val);
} else if (type === 'number' && isFinite(val)) {
return options.long ? fmtLong(val) : fmtShort(val);
}
throw new Error(
'val is not a non-empty string or a valid number. val=' +
JSON.stringify(val)
);
};
/**
* Parse the given `str` and return milliseconds.
*
* @param {String} str
* @return {Number}
* @api private
*/
function parse(str) {
str = String(str);
if (str.length > 100) {
return;
}
var match = /^(-?(?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(
str
);
if (!match) {
return;
}
var n = parseFloat(match[1]);
var type = (match[2] || 'ms').toLowerCase();
switch (type) {
case 'years':
case 'year':
case 'yrs':
case 'yr':
case 'y':
return n * y;
case 'weeks':
case 'week':
case 'w':
return n * w;
case 'days':
case 'day':
case 'd':
return n * d;
case 'hours':
case 'hour':
case 'hrs':
case 'hr':
case 'h':
return n * h;
case 'minutes':
case 'minute':
case 'mins':
case 'min':
case 'm':
return n * m;
case 'seconds':
case 'second':
case 'secs':
case 'sec':
case 's':
return n * s;
case 'milliseconds':
case 'millisecond':
case 'msecs':
case 'msec':
case 'ms':
return n;
default:
return undefined;
}
}
/**
* Short format for `ms`.
*
* @param {Number} ms
* @return {String}
* @api private
*/
function fmtShort(ms) {
var msAbs = Math.abs(ms);
if (msAbs >= d) {
return Math.round(ms / d) + 'd';
}
if (msAbs >= h) {
return Math.round(ms / h) + 'h';
}
if (msAbs >= m) {
return Math.round(ms / m) + 'm';
}
if (msAbs >= s) {
return Math.round(ms / s) + 's';
}
return ms + 'ms';
}
/**
* Long format for `ms`.
*
* @param {Number} ms
* @return {String}
* @api private
*/
function fmtLong(ms) {
var msAbs = Math.abs(ms);
if (msAbs >= d) {
return plural(ms, msAbs, d, 'day');
}
if (msAbs >= h) {
return plural(ms, msAbs, h, 'hour');
}
if (msAbs >= m) {
return plural(ms, msAbs, m, 'minute');
}
if (msAbs >= s) {
return plural(ms, msAbs, s, 'second');
}
return ms + ' ms';
}
/**
* Pluralization helper.
*/
function plural(ms, msAbs, n, name) {
var isPlural = msAbs >= n * 1.5;
return Math.round(ms / n) + ' ' + name + (isPlural ? 's' : '');
}

View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2020 Vercel, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,38 @@
{
"name": "ms",
"version": "2.1.3",
"description": "Tiny millisecond conversion utility",
"repository": "vercel/ms",
"main": "./index",
"files": [
"index.js"
],
"scripts": {
"precommit": "lint-staged",
"lint": "eslint lib/* bin/*",
"test": "mocha tests.js"
},
"eslintConfig": {
"extends": "eslint:recommended",
"env": {
"node": true,
"es6": true
}
},
"lint-staged": {
"*.js": [
"npm run lint",
"prettier --single-quote --write",
"git add"
]
},
"license": "MIT",
"devDependencies": {
"eslint": "4.18.2",
"expect.js": "0.3.1",
"husky": "0.14.3",
"lint-staged": "5.0.0",
"mocha": "4.0.1",
"prettier": "2.0.5"
}
}

View File

@@ -0,0 +1,59 @@
# ms
![CI](https://github.com/vercel/ms/workflows/CI/badge.svg)
Use this package to easily convert various time formats to milliseconds.
## Examples
```js
ms('2 days') // 172800000
ms('1d') // 86400000
ms('10h') // 36000000
ms('2.5 hrs') // 9000000
ms('2h') // 7200000
ms('1m') // 60000
ms('5s') // 5000
ms('1y') // 31557600000
ms('100') // 100
ms('-3 days') // -259200000
ms('-1h') // -3600000
ms('-200') // -200
```
### Convert from Milliseconds
```js
ms(60000) // "1m"
ms(2 * 60000) // "2m"
ms(-3 * 60000) // "-3m"
ms(ms('10 hours')) // "10h"
```
### Time Format Written-Out
```js
ms(60000, { long: true }) // "1 minute"
ms(2 * 60000, { long: true }) // "2 minutes"
ms(-3 * 60000, { long: true }) // "-3 minutes"
ms(ms('10 hours'), { long: true }) // "10 hours"
```
## Features
- Works both in [Node.js](https://nodejs.org) and in the browser
- If a number is supplied to `ms`, a string with a unit is returned
- If a string that contains the number is supplied, it returns it as a number (e.g.: it returns `100` for `'100'`)
- If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned
## Related Packages
- [ms.macro](https://github.com/knpwrs/ms.macro) - Run `ms` as a macro at build-time.
## Caught a Bug?
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Link the package to the global module directory: `npm link`
3. Within the module you want to test your local development instance of ms, just link it to the dependencies: `npm link ms`. Instead of the default one from npm, Node.js will now use your clone of ms!
As always, you can run the tests using: `npm test`

View File

@@ -0,0 +1,82 @@
{
"name": "puppeteer-extra-plugin",
"version": "3.2.3",
"description": "Base class for puppeteer-extra plugins.",
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
"typings": "dist/index.d.ts",
"files": [
"dist"
],
"repository": "berstend/puppeteer-extra",
"homepage": "https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin",
"author": "berstend",
"license": "MIT",
"scripts": {
"clean": "rimraf dist/*",
"prebuild": "run-s clean",
"build": "run-s build:tsc build:rollup",
"build:tsc": "tsc --module commonjs",
"build:rollup": "rollup -c rollup.config.ts",
"docs": "documentation readme --quiet --shallow --github --markdown-theme transitivebs --readme-file readme.md --section API ./src/index.ts",
"postdocs": "npx prettier --write readme.md",
"test": "ava -v --config ava.config-ts.js",
"pretest-ci": "run-s build",
"test-ci": "ava --fail-fast -v"
},
"engines": {
"node": ">=9.11.2"
},
"prettier": {
"printWidth": 80,
"semi": false,
"singleQuote": true
},
"keywords": [
"puppeteer",
"puppeteer-extra",
"puppeteer-extra-plugin",
"ua",
"user-agent",
"chrome",
"headless",
"pupeteer"
],
"devDependencies": {
"@types/node": "14.14.34",
"@types/puppeteer": "*",
"ava": "2.4.0",
"documentation-markdown-themes": "^12.1.5",
"npm-run-all": "^4.1.5",
"puppeteer": "9",
"rimraf": "^3.0.0",
"rollup": "^1.27.5",
"rollup-plugin-commonjs": "^10.1.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
"rollup-plugin-typescript2": "^0.25.2",
"ts-node": "^8.5.4",
"tslint": "^5.12.1",
"tslint-config-prettier": "^1.18.0",
"tslint-config-standard": "^9.0.0",
"typescript": "4.4.3"
},
"dependencies": {
"@types/debug": "^4.1.0",
"debug": "^4.1.1",
"merge-deep": "^3.0.1"
},
"peerDependencies": {
"playwright-extra": "*",
"puppeteer-extra": "*"
},
"peerDependenciesMeta": {
"puppeteer-extra": {
"optional": true
},
"playwright-extra": {
"optional": true
}
},
"gitHead": "2f4a357f233b35a7a20f16ce007f5ef3f62765b9"
}

509
backend/node_modules/puppeteer-extra-plugin/readme.md generated vendored Normal file
View File

@@ -0,0 +1,509 @@
# puppeteer-extra-plugin [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/berstend/puppeteer-extra/test.yml?branch=master&event=push)](https://github.com/berstend/puppeteer-extra/actions) [![Discord](https://img.shields.io/discord/737009125862408274)](https://extra.community) [![npm](https://img.shields.io/npm/v/puppeteer-extra-plugin.svg)](https://www.npmjs.com/package/puppeteer-extra-plugin)
## Installation
```bash
yarn add puppeteer-extra-plugin
```
## Changelog
<details>
<summary><strong>v3.0.1</strong></summary><br>
- Now written in TypeScript 🎉
- **Breaking change:** Now using a named export:
```js
// Before
const PuppeteerExtraPlugin = require('puppeteer-extra-plugin')
// After (>= v3.0.1)
const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
```
</details>
## API
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
#### Table of Contents
- [puppeteer-extra-plugin ![GitHub Workflow Status](https://github.com/berstend/puppeteer-extra/actions) [![Discord](https://img.shields.io/discord/737009125862408274)](https://extra.community) [![npm](https://img.shields.io/npm/v/puppeteer-extra-plugin.svg)](https://www.npmjs.com/package/puppeteer-extra-plugin)](#puppeteer-extra-plugin---)
- [Installation](#installation)
- [Changelog](#changelog)
- [API](#api)
- [Table of Contents](#table-of-contents)
- [class: PuppeteerExtraPlugin](#class-puppeteerextraplugin)
- [.name](#name)
- [.defaults](#defaults)
- [.requirements](#requirements)
- [.dependencies](#dependencies)
- [.data](#data)
- [.opts](#opts)
- [.debug](#debug)
- [.beforeLaunch(options)](#beforelaunchoptions)
- [.afterLaunch(browser, opts)](#afterlaunchbrowser-opts)
- [.beforeConnect(options)](#beforeconnectoptions)
- [.afterConnect(browser, opts)](#afterconnectbrowser-opts)
- [.onBrowser(browser, opts)](#onbrowserbrowser-opts)
- [.onTargetCreated(target)](#ontargetcreatedtarget)
- [.onPageCreated(page, target)](#onpagecreatedpage-target)
- [.onTargetChanged(target)](#ontargetchangedtarget)
- [.onTargetDestroyed(target)](#ontargetdestroyedtarget)
- [.onDisconnected()](#ondisconnected)
- [.onClose()](#onclose)
- [.onPluginRegistered()](#onpluginregistered)
- [.getDataFromPlugins(name?)](#getdatafrompluginsname)
### class: [PuppeteerExtraPlugin](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L65-L572)
- `opts` **PluginOptions?**
Base class for `puppeteer-extra` plugins.
Provides convenience methods to avoid boilerplate.
All common `puppeteer` browser events will be bound to
the plugin instance, if a respectively named class member is found.
Please refer to the [puppeteer API documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md) as well.
Example:
```javascript
// hello-world-plugin.js
const { PuppeteerExtraPlugin } = require('puppeteer-extra-plugin')
class Plugin extends PuppeteerExtraPlugin {
constructor(opts = {}) {
super(opts)
}
get name() {
return 'hello-world'
}
async onPageCreated(page) {
this.debug('page created', page.url())
const ua = await page.browser().userAgent()
this.debug('user agent', ua)
}
}
module.exports = function(pluginConfig) {
return new Plugin(pluginConfig)
}
// foo.js
const puppeteer = require('puppeteer-extra')
puppeteer.use(require('./hello-world-plugin')())
;(async () => {
const browser = await puppeteer.launch({ headless: false })
const page = await browser.newPage()
await page.goto('http://example.com', { waitUntil: 'domcontentloaded' })
await browser.close()
})()
```
---
#### .[name](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L92-L94)
Type: **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
Plugin name (required).
Convention:
- Package: `puppeteer-extra-plugin-anonymize-ua`
- Name: `anonymize-ua`
Example:
```javascript
get name () { return 'anonymize-ua' }
```
---
#### .[defaults](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L117-L119)
Type: **PluginOptions**
Plugin defaults (optional).
If defined will be ([deep-](https://github.com/jonschlinkert/merge-deep))merged with the (optional) user supplied options (supplied during plugin instantiation).
The result of merging defaults with user supplied options can be accessed through `this.opts`.
Example:
```javascript
get defaults () {
return {
stripHeadless: true,
makeWindows: true,
customFn: null
}
}
// Users can overwrite plugin defaults during instantiation:
puppeteer.use(require('puppeteer-extra-plugin-foobar')({ makeWindows: false }))
```
- **See: \[[opts]]**
---
#### .[requirements](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L145-L147)
Type: **PluginRequirements**
Plugin requirements (optional).
Signal certain plugin requirements to the base class and the user.
Currently supported:
- `launch`
- If the plugin only supports locally created browser instances (no `puppeteer.connect()`),
will output a warning to the user.
- `headful`
- If the plugin doesn't work in `headless: true` mode,
will output a warning to the user.
- `dataFromPlugins`
- In case the plugin requires data from other plugins.
will enable usage of `this.getDataFromPlugins()`.
- `runLast`
- In case the plugin prefers to run after the others.
Useful when the plugin needs data from others.
Example:
```javascript
get requirements () {
return new Set(['runLast', 'dataFromPlugins'])
}
```
---
#### .[dependencies](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L160-L162)
Type: **PluginDependencies**
Plugin dependencies (optional).
Missing plugins will be required() by puppeteer-extra.
Example:
```javascript
get dependencies () {
return new Set(['user-preferences'])
}
// Will ensure the 'puppeteer-extra-plugin-user-preferences' plugin is loaded.
```
---
#### .[data](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L196-L198)
Type: **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;PluginData>**
Plugin data (optional).
Plugins can expose data (an array of objects), which in turn can be consumed by other plugins,
that list the `dataFromPlugins` requirement (by using `this.getDataFromPlugins()`).
Convention: `[ {name: 'Any name', value: 'Any value'} ]`
Example:
```javascript
// plugin1.js
get data () {
return [
{
name: 'userPreferences',
value: { foo: 'bar' }
},
{
name: 'userPreferences',
value: { hello: 'world' }
}
]
// plugin2.js
get requirements () { return new Set(['dataFromPlugins']) }
async beforeLaunch () {
const prefs = this.getDataFromPlugins('userPreferences').map(d => d.value)
this.debug(prefs) // => [ { foo: 'bar' }, { hello: 'world' } ]
}
```
- **See: \[[getDataFromPlugins]]**
---
#### .[opts](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L215-L217)
Type: **PluginOptions**
Access the plugin options (usually the `defaults` merged with user defined options)
To skip the auto-merging of defaults with user supplied opts don't define a `defaults`
property and set the `this._opts` Object in your plugin constructor directly.
Example:
```javascript
get defaults () { return { foo: "bar" } }
async onPageCreated (page) {
this.debug(this.opts.foo) // => bar
}
```
- **See: \[[defaults]]**
---
#### .[debug](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L235-L237)
Type: **Debugger**
Convenience debug logger based on the [debug] module.
Will automatically namespace the logging output to the plugin package name.
[debug]: https://www.npmjs.com/package/debug
```bash
# toggle output using environment variables
DEBUG=puppeteer-extra-plugin:<plugin_name> node foo.js
# to debug all the things:
DEBUG=puppeteer-extra,puppeteer-extra-plugin:* node foo.js
```
Example:
```javascript
this.debug('hello world')
// will output e.g. 'puppeteer-extra-plugin:anonymize-ua hello world'
```
---
#### .[beforeLaunch(options)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L256-L258)
- `options` **any** Puppeteer launch options
Before a new browser instance is created/launched.
Can be used to modify the puppeteer launch options by modifying or returning them.
Plugins using this method will be called in sequence to each
be able to update the launch options.
Example:
```javascript
async beforeLaunch (options) {
if (this.opts.flashPluginPath) {
options.args.push(`--ppapi-flash-path=${this.opts.flashPluginPath}`)
}
}
```
---
#### .[afterLaunch(browser, opts)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L287-L292)
- `browser` **Puppeteer.Browser** The `puppeteer` browser instance.
- `opts` (optional, default `{options:({}as Puppeteer.LaunchOptions)}`)
After the browser has launched.
Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
It's possible that `pupeeteer.launch` will be called multiple times and more than one browser created.
In order to make the plugins as stateless as possible don't store a reference to the browser instance
in the plugin but rather consider alternatives.
E.g. when using `onPageCreated` you can get a browser reference by using `page.browser()`.
Alternatively you could expose a class method that takes a browser instance as a parameter to work with:
```es6
const fancyPlugin = require('puppeteer-extra-plugin-fancy')()
puppeteer.use(fancyPlugin)
const browser = await puppeteer.launch()
await fancyPlugin.killBrowser(browser)
```
Example:
```javascript
async afterLaunch (browser, opts) {
this.debug('browser has been launched', opts.options)
}
```
---
#### .[beforeConnect(options)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L305-L307)
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Puppeteer connect options
Before connecting to an existing browser instance.
Can be used to modify the puppeteer connect options by modifying or returning them.
Plugins using this method will be called in sequence to each
be able to update the launch options.
---
#### .[afterConnect(browser, opts)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L319-L321)
- `browser` **Puppeteer.Browser** The `puppeteer` browser instance.
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
- `opts.options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Puppeteer connect options used.
After connecting to an existing browser instance.
> Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
---
#### .[onBrowser(browser, opts)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L335-L337)
- `browser` **Puppeteer.Browser** The `puppeteer` browser instance.
- `opts` **any**
Returns: **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;void>**
Called when a browser instance is available.
This applies to both `puppeteer.launch()` and `puppeteer.connect()`.
Convenience method created for plugins that need access to a browser instance
and don't mind if it has been created through `launch` or `connect`.
> Note: Don't assume that there will only be a single browser instance during the lifecycle of a plugin.
---
#### .[onTargetCreated(target)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L348-L350)
- `target` **Puppeteer.Target**
Called when a target is created, for example when a new page is opened by window.open or browser.newPage.
> Note: This includes target creations in incognito browser contexts.
>
> Note: This includes browser instances created through `.launch()` as well as `.connect()`.
---
#### .[onPageCreated(page, target)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L371-L373)
- `page` **Puppeteer.Page**
- `target` **Puppeteer.Target**
Same as `onTargetCreated` but prefiltered to only contain Pages, for convenience.
> Note: This includes page creations in incognito browser contexts.
>
> Note: This includes browser instances created through `.launch()` as well as `.connect()`.
Example:
```javascript
async onPageCreated (page) {
let ua = await page.browser().userAgent()
if (this.opts.stripHeadless) {
ua = ua.replace('HeadlessChrome/', 'Chrome/')
}
this.debug('new ua', ua)
await page.setUserAgent(ua)
}
```
---
#### .[onTargetChanged(target)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L384-L386)
- `target` **Puppeteer.Target**
Called when the url of a target changes.
> Note: This includes target changes in incognito browser contexts.
>
> Note: This includes browser instances created through `.launch()` as well as `.connect()`.
---
#### .[onTargetDestroyed(target)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L397-L399)
- `target` **Puppeteer.Target**
Called when a target is destroyed, for example when a page is closed.
> Note: This includes target destructions in incognito browser contexts.
>
> Note: This includes browser instances created through `.launch()` as well as `.connect()`.
---
#### .[onDisconnected()](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L408-L410)
Called when Puppeteer gets disconnected from the Chromium instance.
This might happen because of one of the following:
- Chromium is closed or crashed
- The `browser.disconnect` method was called
---
#### .[onClose()](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L424-L426)
**Deprecated:** Since puppeteer v1.6.0 `onDisconnected` has been improved
and should be used instead of `onClose`.
In puppeteer &lt; v1.6.0 `onDisconnected` was not catching all exit scenarios.
In order for plugins to clean up properly (e.g. deleting temporary files)
the `onClose` method had been introduced.
> Note: Might be called multiple times on exit.
>
> Note: This only includes browser instances created through `.launch()`.
---
#### .[onPluginRegistered()](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L433-L435)
After the plugin has been registered in `puppeteer-extra`.
Normally right after `puppeteer.use(plugin)` is called
---
#### .[getDataFromPlugins(name?)](https://github.com/berstend/puppeteer-extra/blob/dc8b90260a927c0c66c4585c5a56092ea9c35049/packages/puppeteer-extra-plugin/src/index.ts#L448-L450)
- `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Filter data by `name` property
Returns: **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;PluginData>**
Helper method to retrieve `data` objects from other plugins.
A plugin needs to state the `dataFromPlugins` requirement
in order to use this method. Will be mapped to `puppeteer.getPluginData`.
- **See: [data]**
- **See: [requirements]**
---