@remotion/renderer 3.0.19 → 3.0.22

package/dist/browser/EventEmitter.js

@@ -0,0 +1,102 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventEmitter = void 0;
+const mitt_1 = __importDefault(require("./mitt"));
+class EventEmitter {
+    constructor() {
+        this.eventsMap = new Map();
+        this.emitter = (0, mitt_1.default)(this.eventsMap);
+    }
+    /**
+     * Bind an event listener to fire when an event occurs.
+     * @param event - the event type you'd like to listen to. Can be a string or symbol.
+     * @param handler  - the function to be called when the event occurs.
+     * @returns `this` to enable you to chain method calls.
+     */
+    on(event, handler) {
+        this.emitter.on(event, handler);
+        return this;
+    }
+    /**
+     * Remove an event listener from firing.
+     * @param event - the event type you'd like to stop listening to.
+     * @param handler  - the function that should be removed.
+     * @returns `this` to enable you to chain method calls.
+     */
+    off(event, handler) {
+        this.emitter.off(event, handler);
+        return this;
+    }
+    /**
+     * Remove an event listener.
+     * @deprecated please use {@link EventEmitter.off} instead.
+     */
+    removeListener(event, handler) {
+        this.off(event, handler);
+        return this;
+    }
+    /**
+     * Add an event listener.
+     * @deprecated please use {@link EventEmitter.on} instead.
+     */
+    addListener(event, handler) {
+        this.on(event, handler);
+        return this;
+    }
+    /**
+     * Emit an event and call any associated listeners.
+     *
+     * @param event - the event you'd like to emit
+     * @param eventData - any data you'd like to emit with the event
+     * @returns `true` if there are any listeners, `false` if there are not.
+     */
+    emit(event, eventData) {
+        this.emitter.emit(event, eventData);
+        return this.eventListenersCount(event) > 0;
+    }
+    /**
+     * Like `on` but the listener will only be fired once and then it will be removed.
+     * @param event - the event you'd like to listen to
+     * @param handler - the handler function to run when the event occurs
+     * @returns `this` to enable you to chain method calls.
+     */
+    once(event, handler) {
+        const onceHandler = (eventData) => {
+            handler(eventData);
+            this.off(event, onceHandler);
+        };
+        return this.on(event, onceHandler);
+    }
+    /**
+     * Gets the number of listeners for a given event.
+     *
+     * @param event - the event to get the listener count for
+     * @returns the number of listeners bound to the given event
+     */
+    listenerCount(event) {
+        return this.eventListenersCount(event);
+    }
+    /**
+     * Removes all listeners. If given an event argument, it will remove only
+     * listeners for that event.
+     * @param event - the event to remove listeners for.
+     * @returns `this` to enable you to chain method calls.
+     */
+    removeAllListeners(event) {
+        if (event) {
+            this.eventsMap.delete(event);
+        }
+        else {
+            this.eventsMap.clear();
+        }
+        return this;
+    }
+    eventListenersCount(event) {
+        var _a;
+        return ((_a = this.eventsMap.get(event)) === null || _a === void 0 ? void 0 : _a.length) || 0;
+    }
+}
+exports.EventEmitter = EventEmitter;

package/dist/browser/ExecutionContext.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+import type { Protocol } from 'devtools-protocol';
+import { CDPSession } from './Connection';
+import { DOMWorld } from './DOMWorld';
+import { EvaluateHandleFn, SerializableOrJSHandle } from './EvalTypes';
+import { Frame } from './FrameManager';
+import { ElementHandle, JSHandle } from './JSHandle';
+export declare const EVALUATION_SCRIPT_URL = "pptr://__puppeteer_evaluation_script__";
+export declare class ExecutionContext {
+    #private;
+    _client: CDPSession;
+    _world: DOMWorld;
+    _contextId: number;
+    _contextName: string;
+    constructor(client: CDPSession, contextPayload: Protocol.Runtime.ExecutionContextDescription, world: DOMWorld);
+    frame(): Frame | null;
+    evaluate<ReturnType>(pageFunction: Function | string, ...args: unknown[]): Promise<ReturnType>;
+    evaluateHandle<HandleType extends JSHandle | ElementHandle = JSHandle>(pageFunction: EvaluateHandleFn, ...args: SerializableOrJSHandle[]): Promise<HandleType>;
+}

package/dist/browser/ExecutionContext.js

@@ -0,0 +1,174 @@
+"use strict";
+/* eslint-disable no-new-func */
+/* eslint-disable no-new */
+/**
+ * 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.
+ */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ExecutionContext_instances, _ExecutionContext_evaluate;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutionContext = exports.EVALUATION_SCRIPT_URL = void 0;
+const JSHandle_1 = require("./JSHandle");
+const util_1 = require("./util");
+exports.EVALUATION_SCRIPT_URL = 'pptr://__puppeteer_evaluation_script__';
+const SOURCE_URL_REGEX = /^[\040\t]*\/\/[@#] sourceURL=\s*(\S*?)\s*$/m;
+class ExecutionContext {
+    constructor(client, contextPayload, world) {
+        _ExecutionContext_instances.add(this);
+        this._client = client;
+        this._world = world;
+        this._contextId = contextPayload.id;
+        this._contextName = contextPayload.name;
+    }
+    frame() {
+        return this._world ? this._world.frame() : null;
+    }
+    evaluate(pageFunction, ...args) {
+        return __classPrivateFieldGet(this, _ExecutionContext_instances, "m", _ExecutionContext_evaluate).call(this, true, pageFunction, ...args);
+    }
+    evaluateHandle(pageFunction, ...args) {
+        return __classPrivateFieldGet(this, _ExecutionContext_instances, "m", _ExecutionContext_evaluate).call(this, false, pageFunction, ...args);
+    }
+}
+exports.ExecutionContext = ExecutionContext;
+_ExecutionContext_instances = new WeakSet(), _ExecutionContext_evaluate = async function _ExecutionContext_evaluate(returnByValue, pageFunction, ...args) {
+    const suffix = `//# sourceURL=${exports.EVALUATION_SCRIPT_URL}`;
+    if ((0, util_1.isString)(pageFunction)) {
+        const contextId = this._contextId;
+        const expression = pageFunction;
+        const expressionWithSourceUrl = SOURCE_URL_REGEX.test(expression)
+            ? expression
+            : expression + '\n' + suffix;
+        const { exceptionDetails: _details, result: _remoteObject } = await this._client
+            .send('Runtime.evaluate', {
+            expression: expressionWithSourceUrl,
+            contextId,
+            returnByValue,
+            awaitPromise: true,
+            userGesture: true,
+        })
+            .catch(rewriteError);
+        if (_details) {
+            throw new Error('Evaluation failed: ' + (0, util_1.getExceptionMessage)(_details));
+        }
+        return returnByValue
+            ? (0, util_1.valueFromRemoteObject)(_remoteObject)
+            : (0, JSHandle_1._createJSHandle)(this, _remoteObject);
+    }
+    if (typeof pageFunction !== 'function') {
+        throw new Error(`Expected to get |string| or |function| as the first argument, but got "${pageFunction}" instead.`);
+    }
+    let functionText = pageFunction.toString();
+    try {
+        new Function('(' + functionText + ')');
+    }
+    catch (error) {
+        // This means we might have a function shorthand. Try another
+        // time prefixing 'function '.
+        if (functionText.startsWith('async ')) {
+            functionText =
+                'async function ' + functionText.substring('async '.length);
+        }
+        else {
+            functionText = 'function ' + functionText;
+        }
+        try {
+            new Function('(' + functionText + ')');
+        }
+        catch (_error) {
+            // We tried hard to serialize, but there's a weird beast here.
+            throw new Error('Passed function is not well-serializable!');
+        }
+    }
+    let callFunctionOnPromise;
+    try {
+        callFunctionOnPromise = this._client.send('Runtime.callFunctionOn', {
+            functionDeclaration: functionText + '\n' + suffix + '\n',
+            executionContextId: this._contextId,
+            arguments: args.map(convertArgument.bind(this)),
+            returnByValue,
+            awaitPromise: true,
+            userGesture: true,
+        });
+    }
+    catch (error) {
+        if (error instanceof TypeError &&
+            error.message.startsWith('Converting circular structure to JSON')) {
+            error.message += ' Recursive objects are not allowed.';
+        }
+        throw error;
+    }
+    const { exceptionDetails, result: remoteObject } = await callFunctionOnPromise.catch(rewriteError);
+    if (exceptionDetails) {
+        throw new Error('Evaluation failed: ' + (0, util_1.getExceptionMessage)(exceptionDetails));
+    }
+    return returnByValue
+        ? (0, util_1.valueFromRemoteObject)(remoteObject)
+        : (0, JSHandle_1._createJSHandle)(this, remoteObject);
+    function convertArgument(arg) {
+        if (typeof arg === 'bigint') {
+            // eslint-disable-line valid-typeof
+            return { unserializableValue: `${arg.toString()}n` };
+        }
+        if (Object.is(arg, -0)) {
+            return { unserializableValue: '-0' };
+        }
+        if (Object.is(arg, Infinity)) {
+            return { unserializableValue: 'Infinity' };
+        }
+        if (Object.is(arg, -Infinity)) {
+            return { unserializableValue: '-Infinity' };
+        }
+        if (Object.is(arg, NaN)) {
+            return { unserializableValue: 'NaN' };
+        }
+        const objectHandle = arg && arg instanceof JSHandle_1.JSHandle ? arg : null;
+        if (objectHandle) {
+            if (objectHandle._context !== this) {
+                throw new Error('JSHandles can be evaluated only in the context they were created!');
+            }
+            if (objectHandle._disposed) {
+                throw new Error('JSHandle is disposed!');
+            }
+            if (objectHandle._remoteObject.unserializableValue) {
+                return {
+                    unserializableValue: objectHandle._remoteObject.unserializableValue,
+                };
+            }
+            if (!objectHandle._remoteObject.objectId) {
+                return { value: objectHandle._remoteObject.value };
+            }
+            return { objectId: objectHandle._remoteObject.objectId };
+        }
+        return { value: arg };
+    }
+    function rewriteError(error) {
+        if (error.message.includes('Object reference chain is too long')) {
+            return { result: { type: 'undefined' } };
+        }
+        if (error.message.includes("Object couldn't be returned by value")) {
+            return { result: { type: 'undefined' } };
+        }
+        if (error.message.endsWith('Cannot find context with specified id') ||
+            error.message.endsWith('Inspected target navigated or closed')) {
+            throw new Error('Execution context was destroyed, most likely because of a navigation.');
+        }
+        throw error;
+    }
+};

package/dist/browser/FrameManager.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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.
+ */
+import type { Protocol } from 'devtools-protocol';
+import { CDPSession } from './Connection';
+import { DOMWorld } from './DOMWorld';
+import { EvaluateFn, EvaluateFnReturnType, EvaluateHandleFn, SerializableOrJSHandle, UnwrapPromiseLike } from './EvalTypes';
+import { EventEmitter } from './EventEmitter';
+import { ExecutionContext } from './ExecutionContext';
+import { HTTPResponse } from './HTTPResponse';
+import { JSHandle } from './JSHandle';
+import { PuppeteerLifeCycleEvent } from './LifecycleWatcher';
+import { NetworkManager } from './NetworkManager';
+import { Page } from './Page';
+import { TimeoutSettings } from './TimeoutSettings';
+export declare const FrameManagerEmittedEvents: {
+    FrameNavigated: symbol;
+    FrameDetached: symbol;
+    FrameSwapped: symbol;
+    LifecycleEvent: symbol;
+    FrameNavigatedWithinDocument: symbol;
+    ExecutionContextCreated: symbol;
+    ExecutionContextDestroyed: symbol;
+};
+export declare class FrameManager extends EventEmitter {
+    #private;
+    get _timeoutSettings(): TimeoutSettings;
+    get _client(): CDPSession;
+    constructor(client: CDPSession, page: Page, timeoutSettings: TimeoutSettings);
+    private setupEventListeners;
+    initialize(client?: CDPSession): Promise<void>;
+    networkManager(): NetworkManager;
+    navigateFrame(frame: Frame, url: string, options?: {
+        referer?: string;
+        timeout?: number;
+        waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
+    }): Promise<HTTPResponse | null>;
+    page(): Page;
+    mainFrame(): Frame;
+    frames(): Frame[];
+    frame(frameId: string): Frame | null;
+    _ensureIsolatedWorld(session: CDPSession, name: string): Promise<void>;
+    executionContextById(contextId: number, session?: CDPSession): ExecutionContext;
+}
+export declare class Frame {
+    #private;
+    _frameManager: FrameManager;
+    _id: string;
+    _loaderId: string;
+    _name?: string;
+    _hasStartedLoading: boolean;
+    _lifecycleEvents: Set<string>;
+    _mainWorld: DOMWorld;
+    _secondaryWorld: DOMWorld;
+    _childFrames: Set<Frame>;
+    constructor(frameManager: FrameManager, parentFrame: Frame | null, frameId: string, client: CDPSession);
+    _updateClient(client: CDPSession): void;
+    isOOPFrame(): boolean;
+    goto(url: string, options?: {
+        referer?: string;
+        timeout?: number;
+        waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
+    }): Promise<HTTPResponse | null>;
+    _client(): CDPSession;
+    /**
+     * @returns a promise that resolves to the frame's default execution context.
+     */
+    executionContext(): Promise<ExecutionContext>;
+    evaluateHandle<HandlerType extends JSHandle = JSHandle>(pageFunction: EvaluateHandleFn, ...args: SerializableOrJSHandle[]): Promise<HandlerType>;
+    evaluate<T extends EvaluateFn>(pageFunction: T, ...args: SerializableOrJSHandle[]): Promise<UnwrapPromiseLike<EvaluateFnReturnType<T>>>;
+    name(): string;
+    url(): string;
+    parentFrame(): Frame | null;
+    childFrames(): Frame[];
+    isDetached(): boolean;
+    waitForFunction(pageFunction: Function | string, ...args: SerializableOrJSHandle[]): Promise<JSHandle>;
+    title(): Promise<string>;
+    _navigated(framePayload: Protocol.Page.Frame): void;
+    _navigatedWithinDocument(url: string): void;
+    _onLifecycleEvent(loaderId: string, name: string): void;
+    _onLoadingStopped(): void;
+    _onLoadingStarted(): void;
+    _detach(): void;
+}