portadom 1.0.0

package/dist/cjs/dom/types.d.ts

@@ -0,0 +1,371 @@
+import type { StrAsNumOptions } from '../utils/format';
+import type { FormatUrlOptions } from '../utils/url';
+import type { MaybeArray, MaybePromise } from '../utils/types';
+/**
+ * Common interface for working with DOM despite different environments.
+ *
+ * Consider these environments:
+ * 1) Browser (via Playwright & Chromium) - uses Browser API to work with DOM
+ * 2) Cheerio - uses own API to work with DOM
+ *
+ * This common interfaces makes the scraping code more portable between the two.
+ */
+export interface Portadom<El extends BaseEl, BaseEl> {
+    node: El | null;
+    /** Get element's text (trimmed) */
+    text: (options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<string | null>;
+    /** Get element's text as uppercase (trimmed) */
+    textAsUpper: (options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<string | null>;
+    /** Get element's text as lowercase (trimmed) */
+    textAsLower: (options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<string | null>;
+    /** Get element's text and convert it to number */
+    textAsNumber: (options?: StrAsNumOptions) => MaybePromise<number | null>;
+    /** Get element's attribute */
+    attr: (attrName: string, options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<string | null>;
+    /** Get element's attributes */
+    attrs: <T extends string>(attrNames: T[], options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<Record<T, string | null>>;
+    /** Get element's property */
+    prop: <R = unknown>(
+    /** Single or nested prop path */
+    propName: MaybeArray<string>, options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<R>;
+    /** Get element's properties */
+    props: <R extends any[]>(
+    /** List of single or nested prop paths */
+    propName: MaybeArray<string>[], options?: {
+        allowEmpty?: boolean;
+    }) => MaybePromise<R>;
+    /** Get element's href */
+    href: (options?: {
+        allowEmpty?: boolean;
+    } & FormatUrlOptions) => MaybePromise<string | null>;
+    /** Get element's src */
+    src: (options?: {
+        allowEmpty?: boolean;
+    } & FormatUrlOptions) => MaybePromise<string | null>;
+    /** Get element's nodeName */
+    nodeName: () => MaybePromise<string | null>;
+    /** Get URL of website associated with the DOM */
+    url: () => MaybePromise<string | null>;
+    /** Freely modify the underlying DOM node */
+    map: <TVal>(map: (node: El | null) => TVal) => MaybePromise<TVal>;
+    /** Get a single descendant matching the selector */
+    findOne: <TNewEl extends BaseEl = El>(selector: string) => PortadomPromise<TNewEl, BaseEl>;
+    /** Get all descendants matching the selector */
+    findMany: <TNewEl extends BaseEl = El>(selector: string) => PortadomArrayPromise<TNewEl, BaseEl>;
+    /** Get a single ancestor (or itself) matching the selector */
+    closest: <TNewEl extends BaseEl = El>(selector: string) => PortadomPromise<TNewEl, BaseEl>;
+    /** Get element's parent */
+    parent: <TNewEl extends BaseEl = El>() => PortadomPromise<TNewEl, BaseEl>;
+    /** Get element's children */
+    children: <TNewEl extends BaseEl = El>() => PortadomArrayPromise<TNewEl, BaseEl>;
+    /** Remove the element */
+    remove: () => MaybePromise<void>;
+    /** Get root element */
+    root: <TNewEl extends BaseEl = El>() => PortadomPromise<TNewEl, BaseEl>;
+    /**
+     * Given two elements, return closest ancestor element that encompases them both,
+     * or `null` if none such found.
+     */
+    getCommonAncestor: <TNewEl extends BaseEl = El>(otherEl: El) => PortadomPromise<TNewEl, BaseEl>;
+    /**
+     * Given a selector, find all DOM elements that match the selector,
+     * and return closest ancestor element that encompases them all,
+     * or `null` if none such found.
+     */
+    getCommonAncestorFromSelector: <TNewEl extends BaseEl = El>(selector: string) => PortadomPromise<TNewEl, BaseEl>;
+}
+/**
+ * Wrapper for a {@link Promise} that resolves to a {@link Portadom} instance. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+export interface PortadomPromise<El extends BaseEl, BaseEl> {
+    promise: Promise<Portadom<El, BaseEl> | null>;
+    node: Promise<NonNullable<El> | null>;
+    /** Get element's text (trimmed) */
+    text: (...args: Parameters<Portadom<El, BaseEl>['text']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['text']>>>;
+    /** Get element's text as uppercase (trimmed) */
+    textAsUpper: (...args: Parameters<Portadom<El, BaseEl>['textAsUpper']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['textAsUpper']>>>;
+    /** Get element's text as lowercase (trimmed) */
+    textAsLower: (...args: Parameters<Portadom<El, BaseEl>['textAsLower']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['textAsLower']>>>;
+    /** Get element's text and convert it to number */
+    textAsNumber: (...args: Parameters<Portadom<El, BaseEl>['textAsNumber']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['textAsNumber']>>>;
+    /** Get element's attribute */
+    attr: (...args: Parameters<Portadom<El, BaseEl>['attr']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['attr']>>>;
+    /** Get element's attributes */
+    attrs: <Attrs extends string>(...args: [attrNames: Attrs[], options?: {
+        allowEmpty?: boolean;
+    }]) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['attrs']> | null>>;
+    /** Get element's property */
+    prop: <R = unknown>(...args: Parameters<Portadom<El, BaseEl>['prop']>) => Promise<R | null>;
+    /** Get element's properties */
+    props: <R extends any[]>(...args: Parameters<Portadom<El, BaseEl>['props']>) => Promise<R | null>;
+    /** Get element's href */
+    href: (...args: Parameters<Portadom<El, BaseEl>['href']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['href']>>>;
+    /** Get element's src */
+    src: (...args: Parameters<Portadom<El, BaseEl>['src']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['src']>>>;
+    /** Get element's nodeName */
+    nodeName: (...args: Parameters<Portadom<El, BaseEl>['nodeName']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['nodeName']>>>;
+    /** Get URL of website associated with the DOM */
+    url: (...args: Parameters<Portadom<El, BaseEl>['url']>) => Promise<Awaited<ReturnType<Portadom<El, BaseEl>['url']>>>;
+    /** Freely modify the underlying DOM node */
+    map: <TVal>(...args: [map: (node: El | null) => TVal]) => Promise<TVal | null>;
+    /** Get a single descendant matching the selector */
+    findOne: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['findOne']>) => PortadomPromise<TNewEl, BaseEl>;
+    /** Get all descendants matching the selector */
+    findMany: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['findMany']>) => PortadomArrayPromise<TNewEl, BaseEl>;
+    /** Get a single ancestor (or itself) matching the selector */
+    closest: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['closest']>) => PortadomPromise<TNewEl, BaseEl>;
+    /** Get element's parent */
+    parent: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['parent']>) => PortadomPromise<TNewEl, BaseEl>;
+    /** Get element's children */
+    children: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['children']>) => PortadomArrayPromise<TNewEl, BaseEl>;
+    /** Remove the element */
+    remove: (...args: Parameters<Portadom<El, BaseEl>['remove']>) => MaybePromise<void>;
+    /** Get root element */
+    root: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['root']>) => PortadomPromise<TNewEl, BaseEl>;
+    /**
+     * Given two elements, return closest ancestor element that encompases them both,
+     * or `null` if none such found.
+     */
+    getCommonAncestor: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['getCommonAncestor']>) => PortadomPromise<TNewEl, BaseEl>;
+    /**
+     * Given a selector, find all DOM elements that match the selector,
+     * and return closest ancestor element that encompases them all,
+     * or `null` if none such found.
+     */
+    getCommonAncestorFromSelector: <TNewEl extends BaseEl = El>(...args: Parameters<Portadom<El, BaseEl>['getCommonAncestorFromSelector']>) => PortadomPromise<TNewEl, BaseEl>;
+}
+/**
+ * Wrapper for a {@link Promise} that resolves to a {@link Portadom} instance. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+export declare const createPortadomPromise: <El extends BaseEl, BaseEl>(promiseDom: MaybePromise<Portadom<El, BaseEl> | null>) => PortadomPromise<El, BaseEl>;
+/**
+ * Wrapper for a {@link Promise} that resolves to a n Array of {@link Portadom} instances. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomArrayPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+export interface PortadomArrayPromise<El extends BaseEl, BaseEl> {
+    /** Wrapped Promise of an array of {@link Portadom} instances */
+    promise: Promise<Portadom<El, BaseEl>[]>;
+    /** Wrapper for {@link Array.at} that returns the resulting item as {@link PortadomPromise}. */
+    at: (...args: Parameters<Portadom<El, BaseEl>[]['at']>) => PortadomPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.concat} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     *
+     * NOTE: The concat values are expected to be {@link Portadom} instances
+     */
+    concat: (...args: Parameters<Portadom<El, BaseEl>[]['concat']>) => PortadomArrayPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.copyWithin} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     *
+     * NOTE: The concat values are expected to be {@link Portadom} instances
+     */
+    copyWithin: (...args: Parameters<Portadom<El, BaseEl>[]['copyWithin']>) => PortadomArrayPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.entries}.
+     *
+     * NOTE: Does NOT return an instance of {@link PortadomArrayPromise}
+     */
+    entries: (...args: Parameters<Portadom<El, BaseEl>[]['entries']>) => Promise<IterableIterator<[number, Portadom<El, BaseEl>]>>;
+    /** Wrapper for {@link Array.every}. */
+    every: (...args: Parameters<Portadom<El, BaseEl>[]['every']>) => Promise<boolean>;
+    /**
+     * Wrapper for {@link Array.fill}.
+     *
+     * NOTE: Fill values can be anything, so result is NOT wrapped in an instance of {@link PortadomArrayPromise}.
+     *
+     * NOTE2: Unlike {@link Array.fill}, this option doesn't allow to specify `start` and `end`.
+     */
+    fill: <U>(...args: [value: U]) => Promise<U[]>;
+    /**
+     * Wrapper for {@link Array.filter} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     */
+    filter: (...args: Parameters<Portadom<El, BaseEl>[]['filter']>) => PortadomArrayPromise<El, BaseEl>;
+    /** Wrapper for {@link Array.find} that returns the resulting item as {@link PortadomPromise}. */
+    find: (...args: Parameters<Portadom<El, BaseEl>[]['find']>) => PortadomPromise<El, BaseEl>;
+    /** Wrapper for {@link Array.findIndex}. */
+    findIndex: (...args: Parameters<Portadom<El, BaseEl>[]['findIndex']>) => Promise<number>;
+    /** Wrapper for {@link Array.flat} that returns the resulting array wrapped in {@link PortadomArrayPromise}. */
+    flat: (...args: Parameters<Portadom<El, BaseEl>[]['flat']>) => PortadomArrayPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.entries}.
+     *
+     * NOTE: Mapped values can be anything, so result is NOT wrapped in an instance of {@link PortadomArrayPromise}
+     */
+    flatMap: <U, This>(...args: [
+        callback: (this: This, value: Portadom<El, BaseEl>, index: number, array: Portadom<El, BaseEl>[]) => U | readonly U[],
+        thisArg?: This | undefined
+    ]) => Promise<U[]>;
+    /** Wrapper for {@link Array.forEach}. */
+    forEach: (...args: Parameters<Portadom<El, BaseEl>[]['forEach']>) => Promise<void>;
+    /** Wrapper for {@link Array.includes}. */
+    includes: (...args: Parameters<Portadom<El, BaseEl>[]['includes']>) => Promise<boolean>;
+    /** Wrapper for {@link Array.indexOf}. */
+    indexOf: (...args: Parameters<Portadom<El, BaseEl>[]['indexOf']>) => Promise<number>;
+    /** Wrapper for {@link Array.join}. */
+    join: (...args: Parameters<Portadom<El, BaseEl>[]['join']>) => Promise<string>;
+    /** Wrapper for {@link Array.keys}. */
+    keys: (...args: Parameters<Portadom<El, BaseEl>[]['keys']>) => Promise<IterableIterator<number>>;
+    /** Wrapper for {@link Array.lastIndexOf}. */
+    lastIndexOf: (...args: Parameters<Portadom<El, BaseEl>[]['lastIndexOf']>) => Promise<number>;
+    /** Wrapper for {@link Array.length}. */
+    length: Promise<number>;
+    /**
+     * Wrapper for {@link Array.map}.
+     *
+     * NOTE: Mapped values can be anything, so result is NOT wrapped in an instance of {@link PortadomArrayPromise}
+     */
+    map: <U>(...args: [
+        callbackfn: (value: Portadom<El, BaseEl>, index: number, array: Portadom<El, BaseEl>[]) => U,
+        thisArg?: any
+    ]) => Promise<U[]>;
+    /** Wrapper for {@link Array.pop} that returns the resulting item as {@link PortadomPromise}. */
+    pop: (...args: Parameters<Portadom<El, BaseEl>[]['pop']>) => PortadomPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.push}.
+     *
+     * NOTE: The pushed values are expected to be {@link Portadom} instances.
+     */
+    push: (...args: Parameters<Portadom<El, BaseEl>[]['push']>) => Promise<number>;
+    /**
+     * Wrapper for {@link Array.reduce}.
+     *
+     * NOTE: The reduce value can be anything, so result is NOT wrapped in an instance of {@link PortadomArrayPromise}
+     */
+    reduce: {
+        (callbackfn: (previousValue: Portadom<El, BaseEl>, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => Portadom<El, BaseEl>): Promise<Portadom<El, BaseEl>>;
+        (callbackfn: (previousValue: Portadom<El, BaseEl>, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => Portadom<El, BaseEl>, initialValue: Portadom<El, BaseEl>): Promise<Portadom<El, BaseEl>>;
+        <U>(callbackfn: (previousValue: U, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => U, initialValue: U): Promise<U>;
+    };
+    /**
+     * Wrapper for {@link Array.reduceRight}.
+     *
+     * NOTE: The reduce value can be anything, so result is NOT wrapped in an instance of {@link PortadomArrayPromise}
+     */
+    reduceRight: {
+        reduceRight(callbackfn: (previousValue: Portadom<El, BaseEl>, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => Portadom<El, BaseEl>): Promise<Portadom<El, BaseEl>>;
+        reduceRight(callbackfn: (previousValue: Portadom<El, BaseEl>, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => Portadom<El, BaseEl>, initialValue: Portadom<El, BaseEl>): Promise<Portadom<El, BaseEl>>;
+        reduceRight<U>(callbackfn: (previousValue: U, currentValue: Portadom<El, BaseEl>, currentIndex: number, array: Portadom<El, BaseEl>[]) => U, initialValue: U): Promise<U>;
+    };
+    /**
+     * Wrapper for {@link Array.reverse} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     */
+    reverse: (...args: Parameters<Portadom<El, BaseEl>[]['reverse']>) => PortadomArrayPromise<El, BaseEl>;
+    /** Wrapper for {@link Array.shift} that returns the resulting item as {@link PortadomPromise}. */
+    shift: (...args: Parameters<Portadom<El, BaseEl>[]['shift']>) => PortadomPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.slice} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     */
+    slice: (...args: Parameters<Portadom<El, BaseEl>[]['slice']>) => PortadomArrayPromise<El, BaseEl>;
+    /** Wrapper for {@link Array.some}. */
+    some: (...args: Parameters<Portadom<El, BaseEl>[]['some']>) => Promise<boolean>;
+    /**
+     * Wrapper for {@link Array.sort} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     */
+    sort: (...args: Parameters<Portadom<El, BaseEl>[]['sort']>) => PortadomArrayPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.splice} that returns the resulting array wrapped in {@link PortadomArrayPromise}.
+     */
+    splice: (...args: Parameters<Portadom<El, BaseEl>[]['splice']>) => PortadomArrayPromise<El, BaseEl>;
+    /**
+     * Wrapper for {@link Array.unshift}.
+     *
+     * NOTE: The added values are expected to be {@link Portadom} instances.
+     */
+    unshift: (...args: Parameters<Portadom<El, BaseEl>[]['unshift']>) => Promise<number>;
+    /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+    values: (...args: Parameters<Portadom<El, BaseEl>[]['values']>) => Promise<IterableIterator<Portadom<El, BaseEl>>>;
+}
+/**
+ * Wrapper for a {@link Promise} that resolves to a n Array of {@link Portadom} instances. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomArrayPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+export declare const createPortadomArrayPromise: <El extends BaseEl, BaseEl>(promiseDom: MaybePromise<Portadom<El, BaseEl>[]>) => PortadomArrayPromise<El, BaseEl>;

package/dist/cjs/dom/types.js

@@ -0,0 +1,216 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPortadomArrayPromise = exports.createPortadomPromise = void 0;
+/**
+ * Wrapper for a {@link Promise} that resolves to a {@link Portadom} instance. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+const createPortadomPromise = (promiseDom) => {
+    const promise = Promise.resolve(promiseDom);
+    return {
+        promise,
+        get node() {
+            return promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.node) !== null && _a !== void 0 ? _a : null; });
+        },
+        ///////////////////////
+        // SCALAR OPERATIONS
+        ///////////////////////
+        /** Get element's text (trimmed) */
+        text: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.text(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's text as uppercase (trimmed) */
+        textAsUpper: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.textAsUpper(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's text as lowercase (trimmed) */
+        textAsLower: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.textAsLower(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's text and convert it to number */
+        textAsNumber: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.textAsNumber(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's attribute */
+        attr: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.attr(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's attributes */
+        attrs: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.attrs(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's property */
+        prop: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.prop(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's properties */
+        props: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.props(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's href */
+        href: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.href(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's src */
+        src: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.src(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get element's nodeName */
+        nodeName: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.nodeName(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Get URL of website associated with the DOM */
+        url: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.url(...args)) !== null && _a !== void 0 ? _a : null; }),
+        /** Freely modify the underlying DOM node */
+        map: (...args) => promise.then((d) => { var _a; return (_a = d === null || d === void 0 ? void 0 : d.map(...args)) !== null && _a !== void 0 ? _a : null; }),
+        ///////////////////////
+        // NODE OPERATIONS
+        ///////////////////////
+        /** Get a single descendant matching the selector */
+        findOne: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.findOne(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+        /** Get all descendants matching the selector */
+        findMany: (...args) => {
+            return (0, exports.createPortadomArrayPromise)(promise.then((d) => d ? d.findMany(...args).promise : []));
+        },
+        /** Get a single ancestor (or itself) matching the selector */
+        closest: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.closest(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+        /** Get element's parent */
+        parent: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.parent(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+        /** Get element's children */
+        children: (...args) => {
+            return (0, exports.createPortadomArrayPromise)(promise.then((d) => d ? d.children(...args).promise : []));
+        },
+        /** Get remove the element */
+        remove: (...args) => promise.then((d) => d === null || d === void 0 ? void 0 : d.remove(...args)),
+        /** Get root element */
+        root: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.root(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+        /**
+         * Given two elements, return closest ancestor element that encompases them both,
+         * or `null` if none such found.
+         */
+        getCommonAncestor: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.getCommonAncestor(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+        /**
+         * Given a selector, find all DOM elements that match the selector,
+         * and return closest ancestor element that encompases them all,
+         * or `null` if none such found.
+         */
+        getCommonAncestorFromSelector: (...args) => {
+            return (0, exports.createPortadomPromise)(promise.then((d) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const res = (_a = yield (d === null || d === void 0 ? void 0 : d.getCommonAncestorFromSelector(...args).promise)) !== null && _a !== void 0 ? _a : null;
+                return res;
+            })));
+        },
+    }; // prettier-ignore
+};
+exports.createPortadomPromise = createPortadomPromise;
+/**
+ * Wrapper for a {@link Promise} that resolves to a n Array of {@link Portadom} instances. This allows us to chain
+ * Portadom methods before the Promise is resolved.
+ *
+ * Example:
+ *
+ * ```js
+ * const dom = Promise.resolve(browserPortadom({}));
+ * ```
+ *
+ * Instead of:
+ * ```js
+ * const resA = await (await dom).findOne('..');
+ * const resB = await (await dom).text();
+ * ```
+ *
+ * You can call:
+ * ```js
+ * const domP = createPortadomArrayPromise(dom);
+ * const resA = await domP.findOne('..');
+ * const resB = await domP.text();
+ * ```
+ */
+const createPortadomArrayPromise = (promiseDom) => {
+    const promise = Promise.resolve(promiseDom);
+    return {
+        promise,
+        at: (...args) => (0, exports.createPortadomPromise)(promise.then((d) => { var _a; return (_a = d.at(...args)) !== null && _a !== void 0 ? _a : null; })),
+        /** NOTE: The concat values are expected to be Portadom instances */
+        concat: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.concat(...args))),
+        copyWithin: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.copyWithin(...args))),
+        /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+        entries: (...args) => promise.then((d) => d.entries(...args)),
+        every: (...args) => promise.then((d) => d.every(...args)),
+        /** NOTE: The fill value is expected to be a Portadom instance */
+        fill: (...args) => promise.then((d) => d.fill(...args)),
+        filter: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.filter(...args))),
+        find: (...args) => (0, exports.createPortadomPromise)(promise.then((d) => { var _a; return (_a = d.find(...args)) !== null && _a !== void 0 ? _a : null; })),
+        findIndex: (...args) => promise.then((d) => d.findIndex(...args)),
+        flat: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.flat(...args))),
+        /** NOTE: Items are expected to be mapped to Portadom instances */
+        flatMap: (...args) => promise.then((d) => d.flatMap(...args)),
+        forEach: (...args) => promise.then((d) => d.forEach(...args)),
+        includes: (...args) => promise.then((d) => d.includes(...args)),
+        indexOf: (...args) => promise.then((d) => d.indexOf(...args)),
+        join: (...args) => promise.then((d) => d.join(...args)),
+        keys: (...args) => promise.then((d) => d.keys(...args)),
+        lastIndexOf: (...args) => promise.then((d) => d.lastIndexOf(...args)),
+        get length() {
+            return promise.then((d) => d.length);
+        },
+        /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+        map: (...args) => promise.then((d) => d.map(...args)),
+        pop: (...args) => (0, exports.createPortadomPromise)(promise.then((d) => { var _a; return (_a = d.pop(...args)) !== null && _a !== void 0 ? _a : null; })),
+        push: (...args) => promise.then((d) => d.push(...args)),
+        /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+        // NOTE: reduce has a complex type, so let the type definition handle that
+        reduce: (...args) => promise.then((d) => d.reduce(...args)),
+        /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+        // NOTE: reduceRight has a complex type, so let the type definition handle that
+        reduceRight: ((...args) => promise.then((d) => d.reduceRight(...args))),
+        reverse: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.reverse(...args))),
+        shift: (...args) => (0, exports.createPortadomPromise)(promise.then((d) => { var _a; return (_a = d.shift(...args)) !== null && _a !== void 0 ? _a : null; })),
+        slice: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.slice(...args))),
+        some: (...args) => promise.then((d) => d.some(...args)),
+        sort: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.sort(...args))),
+        splice: (...args) => (0, exports.createPortadomArrayPromise)(promise.then((d) => d.splice(...args))),
+        unshift: (...args) => promise.then((d) => d.unshift(...args)),
+        /** NOTE: Does NOT return an instance of PortadomArrayPromise */
+        values: (...args) => promise.then((d) => d.values(...args)),
+    }; // prettier-ignore
+};
+exports.createPortadomArrayPromise = createPortadomArrayPromise;
+//# sourceMappingURL=types.js.map