happy-dom/src/storage/StorageFactory.ts

Happy DOM is a JavaScript implementation of a web browser without its graphical user interface. It includes many web standards from WHATWG DOM and HTML.

import * as PropertySymbol from '../PropertySymbol.js';
import Storage from './Storage.js';

/**
 * Dataset factory.
 *
 * Reference:
 * https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/storage
 */
export default class StorageFactory {
	/**
	 * Creates a new storage.
	 */
	public static createStorage(): Storage {
		// Documentation for Proxy:
		// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
		return new Proxy(new Storage(), {
			get(storage: Storage, key: string): string | number | boolean | Function {
				if (Storage.prototype.hasOwnProperty(key)) {
					const descriptor = Object.getOwnPropertyDescriptor(Storage.prototype, key);
					if (descriptor.value !== undefined) {
						if (typeof descriptor.value === 'function') {
							return storage[key].bind(storage);
						}
						return descriptor.value;
					}
					if (descriptor.get) {
						return descriptor.get.call(storage);
					}
					return storage[key];
				}
				return storage[PropertySymbol.data][key];
			},
			set(storage: Storage, key: string, value: string): boolean {
				if (Storage.prototype.hasOwnProperty(key)) {
					return true;
				}
				storage[PropertySymbol.data][key] = String(value);
				return true;
			},
			deleteProperty(storage: Storage, key: string): boolean {
				if (Storage.prototype.hasOwnProperty(key)) {
					return true;
				}
				return delete storage[PropertySymbol.data][key];
			},
			ownKeys(storage: Storage): string[] {
				return Object.keys(storage[PropertySymbol.data]);
			},
			has(storage: Storage, key: string): boolean {
				return storage[PropertySymbol.data][key] !== undefined;
			},
			defineProperty(storage: Storage, key: string, descriptor: PropertyDescriptor): boolean {
				if (Storage.prototype.hasOwnProperty(key)) {
					if (descriptor.get || descriptor.set) {
						Object.defineProperty(storage, key, {
							...descriptor,
							get: descriptor.get ? descriptor.get.bind(storage) : undefined,
							set: descriptor.set ? descriptor.set.bind(storage) : undefined
						});
					} else {
						Object.defineProperty(storage, key, {
							...descriptor,
							value:
								typeof descriptor.value === 'function'
									? descriptor.value.bind(storage)
									: descriptor.value
						});
					}
					return true;
				}
				if (descriptor.value === undefined) {
					return false;
				}
				storage[PropertySymbol.data][key] = String(descriptor.value);
				return true;
			},
			getOwnPropertyDescriptor(storage: Storage, key: string): PropertyDescriptor {
				if (
					Storage.prototype.hasOwnProperty(key) ||
					storage[PropertySymbol.data][key] === undefined
				) {
					return;
				}

				return {
					value: storage[PropertySymbol.data][key],
					writable: true,
					enumerable: true,
					configurable: true
				};
			}
		});
	}
}