puppeteer-core
Version:
A high-level API to control headless Chrome over the DevTools Protocol
118 lines • 4.51 kB
JavaScript
;
/**
* @license
* Copyright 2023 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.customQueryHandlers = exports.CustomQueryHandlerRegistry = void 0;
const assert_js_1 = require("../util/assert.js");
const Function_js_1 = require("../util/Function.js");
const QueryHandler_js_1 = require("./QueryHandler.js");
const ScriptInjector_js_1 = require("./ScriptInjector.js");
/**
* The registry of {@link CustomQueryHandler | custom query handlers}.
*
* @example
*
* ```ts
* Puppeteer.customQueryHandlers.register('lit', { … });
* const aHandle = await page.$('lit/…');
* ```
*
* @internal
*/
class CustomQueryHandlerRegistry {
#handlers = new Map();
get(name) {
const handler = this.#handlers.get(name);
return handler ? handler[1] : undefined;
}
/**
* Registers a {@link CustomQueryHandler | custom query handler}.
*
* @remarks
* After registration, the handler can be used everywhere where a selector is
* expected by prepending the selection string with `<name>/`. The name is
* only allowed to consist of lower- and upper case latin letters.
*
* @example
*
* ```ts
* Puppeteer.customQueryHandlers.register('lit', { … });
* const aHandle = await page.$('lit/…');
* ```
*
* @param name - Name to register under.
* @param queryHandler - {@link CustomQueryHandler | Custom query handler} to
* register.
*/
register(name, handler) {
(0, assert_js_1.assert)(!this.#handlers.has(name), `Cannot register over existing handler: ${name}`);
(0, assert_js_1.assert)(/^[a-zA-Z]+$/.test(name), `Custom query handler names may only contain [a-zA-Z]`);
(0, assert_js_1.assert)(handler.queryAll || handler.queryOne, `At least one query method must be implemented.`);
const Handler = class extends QueryHandler_js_1.QueryHandler {
static querySelectorAll = (0, Function_js_1.interpolateFunction)((node, selector, PuppeteerUtil) => {
return PuppeteerUtil.customQuerySelectors
.get(PLACEHOLDER('name'))
.querySelectorAll(node, selector);
}, { name: JSON.stringify(name) });
static querySelector = (0, Function_js_1.interpolateFunction)((node, selector, PuppeteerUtil) => {
return PuppeteerUtil.customQuerySelectors
.get(PLACEHOLDER('name'))
.querySelector(node, selector);
}, { name: JSON.stringify(name) });
};
const registerScript = (0, Function_js_1.interpolateFunction)((PuppeteerUtil) => {
PuppeteerUtil.customQuerySelectors.register(PLACEHOLDER('name'), {
queryAll: PLACEHOLDER('queryAll'),
queryOne: PLACEHOLDER('queryOne'),
});
}, {
name: JSON.stringify(name),
queryAll: handler.queryAll
? (0, Function_js_1.stringifyFunction)(handler.queryAll)
: String(undefined),
queryOne: handler.queryOne
? (0, Function_js_1.stringifyFunction)(handler.queryOne)
: String(undefined),
}).toString();
this.#handlers.set(name, [registerScript, Handler]);
ScriptInjector_js_1.scriptInjector.append(registerScript);
}
/**
* Unregisters the {@link CustomQueryHandler | custom query handler} for the
* given name.
*
* @throws `Error` if there is no handler under the given name.
*/
unregister(name) {
const handler = this.#handlers.get(name);
if (!handler) {
throw new Error(`Cannot unregister unknown handler: ${name}`);
}
ScriptInjector_js_1.scriptInjector.pop(handler[0]);
this.#handlers.delete(name);
}
/**
* Gets the names of all {@link CustomQueryHandler | custom query handlers}.
*/
names() {
return [...this.#handlers.keys()];
}
/**
* Unregisters all custom query handlers.
*/
clear() {
for (const [registerScript] of this.#handlers) {
ScriptInjector_js_1.scriptInjector.pop(registerScript);
}
this.#handlers.clear();
}
}
exports.CustomQueryHandlerRegistry = CustomQueryHandlerRegistry;
/**
* @internal
*/
exports.customQueryHandlers = new CustomQueryHandlerRegistry();
//# sourceMappingURL=CustomQueryHandler.js.map