@remotion/renderer 3.0.20 → 3.0.23

package/dist/browser/AriaQueryHandler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2020 Google Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { InternalQueryHandler } from './QueryHandler';
+/**
+ * @internal
+ */
+export declare const _ariaHandler: InternalQueryHandler;

package/dist/browser/AriaQueryHandler.js

@@ -0,0 +1,108 @@
+"use strict";
+/**
+ * Copyright 2020 Google Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._ariaHandler = void 0;
+const assert_1 = require("./assert");
+async function queryAXTree(client, element, accessibleName, role) {
+    const { nodes } = await client.send('Accessibility.queryAXTree', {
+        objectId: element._remoteObject.objectId,
+        accessibleName,
+        role,
+    });
+    const filteredNodes = nodes.filter((node) => {
+        return !node.role || node.role.value !== 'StaticText';
+    });
+    return filteredNodes;
+}
+const normalizeValue = (value) => {
+    return value.replace(/ +/g, ' ').trim();
+};
+const knownAttributes = new Set(['name', 'role']);
+const attributeRegexp = /\[\s*(?<attribute>\w+)\s*=\s*(?<quote>"|')(?<value>\\.|.*?(?=\k<quote>))\k<quote>\s*\]/g;
+function isKnownAttribute(attribute) {
+    return knownAttributes.has(attribute);
+}
+/*
+ * The selectors consist of an accessible name to query for and optionally
+ * further aria attributes on the form `[<attribute>=<value>]`.
+ * Currently, we only support the `name` and `role` attribute.
+ * The following examples showcase how the syntax works wrt. querying:
+ * - 'title[role="heading"]' queries for elements with name 'title' and role 'heading'.
+ * - '[role="img"]' queries for elements with role 'img' and any name.
+ * - 'label' queries for elements with name 'label' and any role.
+ * - '[name=""][role="button"]' queries for elements with no name and role 'button'.
+ */
+function parseAriaSelector(selector) {
+    const queryOptions = {};
+    const defaultName = selector.replace(attributeRegexp, (_, attribute, _quote, value) => {
+        attribute = attribute.trim();
+        (0, assert_1.assert)(isKnownAttribute(attribute), `Unknown aria attribute "${attribute}" in selector`);
+        queryOptions[attribute] = normalizeValue(value);
+        return '';
+    });
+    if (defaultName && !queryOptions.name) {
+        queryOptions.name = normalizeValue(defaultName);
+    }
+    return queryOptions;
+}
+const queryOne = async (element, selector) => {
+    const exeCtx = element.executionContext();
+    const { name, role } = parseAriaSelector(selector);
+    const res = await queryAXTree(exeCtx._client, element, name, role);
+    if (!res[0] || !res[0].backendDOMNodeId) {
+        return null;
+    }
+    return exeCtx._adoptBackendNodeId(res[0].backendDOMNodeId);
+};
+const waitFor = (domWorld, selector, options) => {
+    const binding = {
+        name: 'ariaQuerySelector',
+        pptrFunction: async (_selector) => {
+            const root = options.root || (await domWorld._document());
+            const element = await queryOne(root, _selector);
+            return element;
+        },
+    };
+    return domWorld._waitForSelectorInPage((_, _selector) => {
+        return globalThis.ariaQuerySelector(_selector);
+    }, selector, options, binding);
+};
+const queryAll = async (element, selector) => {
+    const exeCtx = element.executionContext();
+    const { name, role } = parseAriaSelector(selector);
+    const res = await queryAXTree(exeCtx._client, element, name, role);
+    return Promise.all(res.map((axNode) => {
+        return exeCtx._adoptBackendNodeId(axNode.backendDOMNodeId);
+    }));
+};
+const queryAllArray = async (element, selector) => {
+    const elementHandles = await queryAll(element, selector);
+    const exeCtx = element.executionContext();
+    const jsHandle = exeCtx.evaluateHandle((...elements) => {
+        return elements;
+    }, ...elementHandles);
+    return jsHandle;
+};
+/**
+ * @internal
+ */
+exports._ariaHandler = {
+    queryOne,
+    waitFor,
+    queryAll,
+    queryAllArray,
+};

package/dist/browser/Browser.d.ts

@@ -0,0 +1,209 @@
+/**
+ * Copyright 2017 Google Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="node" />
+import { ChildProcess } from 'child_process';
+import { Connection } from './Connection';
+import { EventEmitter } from './EventEmitter';
+import { Page } from './Page';
+import { Viewport } from './PuppeteerViewport';
+import { Target } from './Target';
+interface BrowserContextOptions {
+    /**
+     * Proxy server with optional port to use for all requests.
+     * Username and password can be set in `Page.authenticate`.
+     */
+    proxyServer?: string;
+    /**
+     * Bypass the proxy for the given semi-colon-separated list of hosts.
+     */
+    proxyBypassList?: string[];
+}
+declare type BrowserCloseCallback = () => Promise<void> | void;
+interface WaitForTargetOptions {
+    /**
+     * Maximum wait time in milliseconds. Pass `0` to disable the timeout.
+     * @defaultValue 30 seconds.
+     */
+    timeout?: number;
+}
+export declare class Browser extends EventEmitter {
+    #private;
+    static _create({ connection, contextIds, defaultViewport, process, closeCallback, }: {
+        connection: Connection;
+        contextIds: string[];
+        defaultViewport: Viewport;
+        process?: ChildProcess;
+        closeCallback?: BrowserCloseCallback;
+    }): Promise<Browser>;
+    get _targets(): Map<string, Target>;
+    constructor(connection: Connection, contextIds: string[], defaultViewport: Viewport, process?: ChildProcess, closeCallback?: BrowserCloseCallback);
+    /**
+     * The spawned browser process. Returns `null` if the browser instance was created with
+     * {@link Puppeteer.connect}.
+     */
+    process(): ChildProcess | null;
+    /**
+     * Creates a new incognito browser context. This won't share cookies/cache with other
+     * browser contexts.
+     *
+     * @example
+     * ```js
+     * (async () => {
+     *  const browser = await puppeteer.launch();
+     *   // Create a new incognito browser context.
+     *   const context = await browser.createIncognitoBrowserContext();
+     *   // Create a new page in a pristine context.
+     *   const page = await context.newPage();
+     *   // Do stuff
+     *   await page.goto('https://example.com');
+     * })();
+     * ```
+     */
+    createIncognitoBrowserContext(options?: BrowserContextOptions): Promise<BrowserContext>;
+    /**
+     * Returns an array of all open browser contexts. In a newly created browser, this will
+     * return a single instance of {@link BrowserContext}.
+     */
+    browserContexts(): BrowserContext[];
+    /**
+     * Returns the default browser context. The default browser context cannot be closed.
+     */
+    defaultBrowserContext(): BrowserContext;
+    _disposeContext(contextId?: string): Promise<void>;
+    /**
+     * The browser websocket endpoint which can be used as an argument to
+     * {@link Puppeteer.connect}.
+     *
+     * @returns The Browser websocket url.
+     *
+     * @remarks
+     *
+     * The format is `ws://${host}:${port}/devtools/browser/<id>`.
+     *
+     * You can find the `webSocketDebuggerUrl` from `http://${host}:${port}/json/version`.
+     * Learn more about the
+     * {@link https://chromedevtools.github.io/devtools-protocol | devtools protocol} and
+     * the {@link
+     * https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target
+     * | browser endpoint}.
+     */
+    wsEndpoint(): string;
+    /**
+     * Promise which resolves to a new {@link Page} object. The Page is created in
+     * a default browser context.
+     */
+    newPage(): Promise<Page>;
+    _createPageInContext(contextId?: string): Promise<Page>;
+    /**
+     * All active targets inside the Browser. In case of multiple browser contexts, returns
+     * an array with all the targets in all browser contexts.
+     */
+    targets(): Target[];
+    /**
+     * The target associated with the browser.
+     */
+    target(): Target;
+    /**
+     * Searches for a target in all browser contexts.
+     *
+     * @param predicate - A function to be run for every target.
+     * @returns The first target found that matches the `predicate` function.
+     *
+     * @example
+     *
+     * An example of finding a target for a page opened via `window.open`:
+     * ```js
+     * await page.evaluate(() => window.open('https://www.example.com/'));
+     * const newWindowTarget = await browser.waitForTarget(target => target.url() === 'https://www.example.com/');
+     * ```
+     */
+    waitForTarget(predicate: (x: Target) => boolean | Promise<boolean>, options?: WaitForTargetOptions): Promise<Target>;
+    /**
+     * An array of all open pages inside the Browser.
+     *
+     * @remarks
+     *
+     * In case of multiple browser contexts, returns an array with all the pages in all
+     * browser contexts. Non-visible pages, such as `"background_page"`, will not be listed
+     * here. You can find them using {@link Target.page}.
+     */
+    pages(): Promise<Page[]>;
+    /**
+     * A string representing the browser name and version.
+     *
+     * @remarks
+     *
+     * For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`. For
+     * non-headless, this is similar to `Chrome/61.0.3153.0`.
+     *
+     * The format of browser.version() might change with future releases of Chromium.
+     */
+    version(): Promise<string>;
+    /**
+     * The browser's original user agent. Pages can override the browser user agent with
+     * {@link Page.setUserAgent}.
+     */
+    userAgent(): Promise<string>;
+    /**
+     * Closes Chromium and all of its pages (if any were opened). The {@link Browser} object
+     * itself is considered to be disposed and cannot be used anymore.
+     */
+    close(): Promise<void>;
+    /**
+     * Disconnects Puppeteer from the browser, but leaves the Chromium process running.
+     * After calling `disconnect`, the {@link Browser} object is considered disposed and
+     * cannot be used anymore.
+     */
+    disconnect(): void;
+    /**
+     * Indicates that the browser is connected.
+     */
+    isConnected(): boolean;
+}
+export declare class BrowserContext extends EventEmitter {
+    #private;
+    constructor(browser: Browser, contextId?: string);
+    targets(): Target[];
+    waitForTarget(predicate: (x: Target) => boolean | Promise<boolean>, options?: {
+        timeout?: number;
+    }): Promise<Target>;
+    pages(): Promise<Page[]>;
+    /**
+     * Returns whether BrowserContext is incognito.
+     * The default browser context is the only non-incognito browser context.
+     *
+     * @remarks
+     * The default browser context cannot be closed.
+     */
+    isIncognito(): boolean;
+    /**
+     * Creates a new page in the browser context.
+     */
+    newPage(): Promise<Page>;
+    /**
+     * The browser this browser context belongs to.
+     */
+    browser(): Browser;
+    /**
+     * Closes the browser context. All the targets that belong to the browser context
+     * will be closed.
+     *
+     * @remarks
+     * Only incognito browser contexts can be closed.
+     */
+    close(): Promise<void>;
+}
+export {};