@happy-dom/global-registrator/lib/GlobalRegistrator.js

Use Happy DOM globally in a Node.js environment for testing.

import { GlobalWindow, PropertySymbol } from 'happy-dom';
const IGNORE_LIST = ['constructor', 'undefined', 'NaN', 'global', 'globalThis'];
/**
 *
 */
export default class GlobalRegistrator {
    static #registered = null;
    /**
     * Returns the registered state.
     *
     * @returns Registered state.
     */
    static get isRegistered() {
        return this.#registered !== null;
    }
    /**
     * Registers Happy DOM globally.
     *
     * @param [options] Options.
     * @param [options.width] Window width. Defaults to "1024".
     * @param [options.height] Window height. Defaults to "768".
     * @param [options.url] URL.
     * @param [options.settings] Settings.
     */
    static register(options) {
        if (this.#registered !== null) {
            throw new Error('Failed to register. Happy DOM has already been globally registered.');
        }
        const window = new GlobalWindow({ ...options, console: globalThis.console });
        this.#registered = {};
        // Define properties on the global object
        const propertyDescriptors = Object.getOwnPropertyDescriptors(window);
        for (const key of Object.keys(propertyDescriptors)) {
            if (!IGNORE_LIST.includes(key)) {
                const windowPropertyDescriptor = propertyDescriptors[key];
                const globalPropertyDescriptor = Object.getOwnPropertyDescriptor(globalThis, key);
                if (globalPropertyDescriptor?.value === undefined ||
                    globalPropertyDescriptor?.value !== windowPropertyDescriptor.value) {
                    this.#registered[key] = globalPropertyDescriptor || null;
                    // If the property is the window object, replace it with the global object
                    if (windowPropertyDescriptor.value === window) {
                        window[key] = globalThis;
                        windowPropertyDescriptor.value = globalThis;
                    }
                    Object.defineProperty(globalThis, key, {
                        ...windowPropertyDescriptor,
                        configurable: true
                    });
                }
            }
        }
        // Define symbol properties on the global object
        const propertySymbols = Object.getOwnPropertySymbols(window);
        for (const key of propertySymbols) {
            const propertyDescriptor = Object.getOwnPropertyDescriptor(window, key);
            this.#registered[key] = null;
            // If the property is the window object, replace it with the global object
            if (propertyDescriptor.value === window) {
                window[key] = globalThis;
                propertyDescriptor.value = globalThis;
            }
            Object.defineProperty(globalThis, key, {
                ...propertyDescriptor,
                configurable: true
            });
        }
        // Set owner window on document to global
        globalThis.document[PropertySymbol.defaultView] = globalThis;
    }
    /**
     * Closes the window and unregisters Happy DOM from being global.
     */
    static async unregister() {
        if (this.#registered === null) {
            throw new Error('Failed to unregister. Happy DOM has not previously been globally registered.');
        }
        const happyDOM = globalThis.happyDOM;
        for (const key of Object.keys(this.#registered)) {
            if (this.#registered[key] !== null) {
                Object.defineProperty(globalThis, key, this.#registered[key]);
            }
            else {
                delete globalThis[key];
            }
        }
        this.#registered = null;
        if (happyDOM) {
            await happyDOM.close();
        }
    }
}
//# sourceMappingURL=GlobalRegistrator.js.map