@siteimprove/alfa-dom 0.99.0 → 0.100.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @siteimprove/alfa-dom
 
+## 0.100.1
+
+### Patch Changes
+
+- **Fixed:** Optional parameters `box` and `device` of `Text.of` now defaults to `None`. ([#1774](https://github.com/Siteimprove/alfa/pull/1774))
+
+## 0.100.0
+
+### Minor Changes
+
+- **Breaking:** The `hasBox` predicate has been moved from `Element` to `Node`. ([#1768](https://github.com/Siteimprove/alfa/pull/1768))
+
+  To migrate, replace `Element.hasBox` with `Node.hasBox`.
+  If `Node` is not imported, add it to the import statement:
+
+  ```
+  import { Element, Node } from "@siteimprove/alfa-dom";
+  ```
+
+- **Added:** `Text.of` now accepts `Option<Rectangle>` and `Option<Device>`. A rectangle can also be passed through the `box` JSON property when using `Text.fromText`. ([#1768](https://github.com/Siteimprove/alfa/pull/1768))
+
+  The rectangle represents the layout of the text node. If a rectangle is passed in, a device must be be supplied, otherwise the rectangle won't be set.
+
 ## 0.99.0
 
 ### Minor Changes

package/dist/h.d.ts

@@ -1,7 +1,7 @@
 import { Device } from "@siteimprove/alfa-device";
 import type { Rectangle } from "@siteimprove/alfa-rectangle";
 import type { Node, Rule } from "./index.js";
-import { Attribute, Block, Declaration, Document, Element, FontFaceRule, Fragment, ImportRule, Layer, KeyframeRule, KeyframesRule, MediaRule, Namespace, NamespaceRule, PageRule, Shadow, Sheet, StyleRule, SupportsRule, Text, Type } from "./index.js";
+import { Attribute, Block, Declaration, Document, Element, FontFaceRule, Fragment, ImportRule, KeyframeRule, KeyframesRule, Layer, MediaRule, Namespace, NamespaceRule, PageRule, Shadow, Sheet, StyleRule, SupportsRule, Text, Type } from "./index.js";
 /**
  * @public
  */
@@ -12,7 +12,7 @@ export declare function h<N extends string = string>(name: N, attributes?: Array
 export declare namespace h {
     function element<N extends string = string>(name: N, attributes?: Array<Attribute> | Record<string, string | boolean>, children?: Array<Node | string>, style?: Array<Declaration> | Record<string, string>, namespace?: Namespace, box?: Rectangle, device?: Device, externalId?: string, internalId?: string, extraData?: any): Element<N>;
     function attribute<N extends string = string>(name: N, value: string, externalId?: string, internalId?: string, extraData?: any): Attribute<N>;
-    function text(data: string, externalId?: string, internalId?: string, extraData?: any): Text;
+    function text(data: string, box?: Rectangle, device?: Device, externalId?: string, internalId?: string, extraData?: any): Text;
     function document(children: Array<Node | string>, style?: Array<Sheet>, externalId?: string, internalId?: string, extraData?: any): Document;
     function shadow(children: Array<Node | string>, style?: Array<Sheet>, mode?: Shadow.Mode, externalId?: string, internalId?: string, extraData?: any): Shadow;
     function type<N extends string = string>(name: N, publicId?: string, systemId?: string, externalId?: string, internalId?: string, extraData?: any): Type<N>;

package/dist/h.js

@@ -1,7 +1,7 @@
 import { None, Option } from "@siteimprove/alfa-option";
 import { Predicate } from "@siteimprove/alfa-predicate";
 import { Device } from "@siteimprove/alfa-device";
-import { Attribute, Block, Declaration, Document, Element, FontFaceRule, Fragment, ImportRule, Layer, KeyframeRule, KeyframesRule, MediaRule, Namespace, NamespaceRule, PageRule, Shadow, Sheet, StyleRule, SupportsRule, Text, Type, } from "./index.js";
+import { Attribute, Block, Declaration, Document, Element, FontFaceRule, Fragment, ImportRule, KeyframeRule, KeyframesRule, Layer, MediaRule, Namespace, NamespaceRule, PageRule, Shadow, Sheet, StyleRule, SupportsRule, Text, Type, } from "./index.js";
 const { entries } = Object;
 const { nor } = Predicate;
 /**
@@ -57,8 +57,8 @@ export function h(name, attributes, children, style, box, device = Device.standa
         return Attribute.of(None, None, name, value, externalId, internalId, extraData);
     }
     h.attribute = attribute;
-    function text(data, externalId, internalId, extraData) {
-        return Text.of(data, externalId, internalId, extraData);
+    function text(data, box, device, externalId, internalId, extraData) {
+        return Text.of(data, Option.from(box), Option.from(device), externalId, internalId, extraData);
     }
     h.text = text;
     function document(children, style, externalId, internalId, extraData) {

package/dist/native.js

@@ -6,6 +6,7 @@ export var Native;
 (function (Native) {
     async function fromNode(node = globalThis.window.document, options) {
         const { withCrossOrigin = false } = options ?? {};
+        const range = globalThis.document.createRange(); // Used by toText - the same instance can be reused for each text node.
         return toNode(node);
         async function toNode(node) {
             switch (node.nodeType) {
@@ -52,9 +53,16 @@ export var Native;
             };
         }
         function toText(text) {
+            range.selectNode(text);
             return {
                 type: "text",
                 data: text.data,
+                box: 
+                // Not all execution environments have layout, e.g. JSDOM:
+                // https://github.com/jsdom/jsdom/pull/2719#issuecomment-590145974
+                range.getBoundingClientRect !== undefined
+                    ? toRectangle(range.getBoundingClientRect())
+                    : null,
             };
         }
         function toComment(comment) {

package/dist/node/element/predicate.d.ts

@@ -1,5 +1,4 @@
 export * from "./predicate/has-attribute.js";
-export * from "./predicate/has-box.js";
 export * from "./predicate/has-display-size.js";
 export * from "./predicate/has-id.js";
 export * from "./predicate/has-input-type.js";
@@ -7,14 +6,14 @@ export * from "./predicate/has-name.js";
 export * from "./predicate/has-namespace.js";
 export * from "./predicate/has-tab-index.js";
 export * from "./predicate/has-unique-id.js";
+export * from "./predicate/is-actually-disabled.js";
 export * from "./predicate/is-browsing-context-container.js";
 export * from "./predicate/is-content.js";
-export * from "./predicate/is-actually-disabled.js";
 export * from "./predicate/is-document-element.js";
 export * from "./predicate/is-draggable.js";
 export * from "./predicate/is-editing-host.js";
 export * from "./predicate/is-fallback.js";
+export * from "./predicate/is-replaced.js";
 export * from "./predicate/is-scoped-to.js";
 export * from "./predicate/is-suggested-focusable.js";
-export * from "./predicate/is-replaced.js";
 //# sourceMappingURL=predicate.d.ts.map

package/dist/node/element/predicate.js

@@ -1,5 +1,4 @@
 export * from "./predicate/has-attribute.js";
-export * from "./predicate/has-box.js";
 export * from "./predicate/has-display-size.js";
 export * from "./predicate/has-id.js";
 export * from "./predicate/has-input-type.js";
@@ -7,14 +6,14 @@ export * from "./predicate/has-name.js";
 export * from "./predicate/has-namespace.js";
 export * from "./predicate/has-tab-index.js";
 export * from "./predicate/has-unique-id.js";
+export * from "./predicate/is-actually-disabled.js";
 export * from "./predicate/is-browsing-context-container.js";
 export * from "./predicate/is-content.js";
-export * from "./predicate/is-actually-disabled.js";
 export * from "./predicate/is-document-element.js";
 export * from "./predicate/is-draggable.js";
 export * from "./predicate/is-editing-host.js";
 export * from "./predicate/is-fallback.js";
+export * from "./predicate/is-replaced.js";
 export * from "./predicate/is-scoped-to.js";
 export * from "./predicate/is-suggested-focusable.js";
-export * from "./predicate/is-replaced.js";
 //# sourceMappingURL=predicate.js.map

package/dist/node/element.d.ts

@@ -119,7 +119,7 @@ export declare namespace Element {
      * @internal
      */
     function cloneElement(options: Node.ElementReplacementOptions, device?: Device): (element: Element) => Trampoline<Element>;
-    const hasAttribute: typeof predicate.hasAttribute, hasBox: typeof predicate.hasBox, hasDisplaySize: typeof predicate.hasDisplaySize, hasId: typeof predicate.hasId, hasInputType: typeof predicate.hasInputType, hasName: typeof predicate.hasName, hasNamespace: typeof predicate.hasNamespace, hasTabIndex: typeof predicate.hasTabIndex, hasUniqueId: Predicate<Element<string>>, isBrowsingContextContainer: typeof predicate.isBrowsingContextContainer, isContent: typeof predicate.isContent, isActuallyDisabled: typeof predicate.isActuallyDisabled, isDocumentElement: typeof predicate.isDocumentElement, isDraggable: typeof predicate.isDraggable, isEditingHost: typeof predicate.isEditingHost, isFallback: typeof predicate.isFallback, isScopedTo: typeof predicate.isScopedTo, isSuggestedFocusable: typeof predicate.isSuggestedFocusable, isReplaced: typeof predicate.isReplaced;
+    const hasAttribute: typeof predicate.hasAttribute, hasDisplaySize: typeof predicate.hasDisplaySize, hasId: typeof predicate.hasId, hasInputType: typeof predicate.hasInputType, hasName: typeof predicate.hasName, hasNamespace: typeof predicate.hasNamespace, hasTabIndex: typeof predicate.hasTabIndex, hasUniqueId: Predicate<Element<string>>, isBrowsingContextContainer: typeof predicate.isBrowsingContextContainer, isContent: typeof predicate.isContent, isActuallyDisabled: typeof predicate.isActuallyDisabled, isDocumentElement: typeof predicate.isDocumentElement, isDraggable: typeof predicate.isDraggable, isEditingHost: typeof predicate.isEditingHost, isFallback: typeof predicate.isFallback, isScopedTo: typeof predicate.isScopedTo, isSuggestedFocusable: typeof predicate.isSuggestedFocusable, isReplaced: typeof predicate.isReplaced;
     type InputType = helpers.InputType;
 }
 //# sourceMappingURL=element.d.ts.map

package/dist/node/element.js

@@ -336,6 +336,6 @@ export class Element extends Node {
         });
     }
     Element.cloneElement = cloneElement;
-    Element.hasAttribute = predicate.hasAttribute, Element.hasBox = predicate.hasBox, Element.hasDisplaySize = predicate.hasDisplaySize, Element.hasId = predicate.hasId, Element.hasInputType = predicate.hasInputType, Element.hasName = predicate.hasName, Element.hasNamespace = predicate.hasNamespace, Element.hasTabIndex = predicate.hasTabIndex, Element.hasUniqueId = predicate.hasUniqueId, Element.isBrowsingContextContainer = predicate.isBrowsingContextContainer, Element.isContent = predicate.isContent, Element.isActuallyDisabled = predicate.isActuallyDisabled, Element.isDocumentElement = predicate.isDocumentElement, Element.isDraggable = predicate.isDraggable, Element.isEditingHost = predicate.isEditingHost, Element.isFallback = predicate.isFallback, Element.isScopedTo = predicate.isScopedTo, Element.isSuggestedFocusable = predicate.isSuggestedFocusable, Element.isReplaced = predicate.isReplaced;
+    Element.hasAttribute = predicate.hasAttribute, Element.hasDisplaySize = predicate.hasDisplaySize, Element.hasId = predicate.hasId, Element.hasInputType = predicate.hasInputType, Element.hasName = predicate.hasName, Element.hasNamespace = predicate.hasNamespace, Element.hasTabIndex = predicate.hasTabIndex, Element.hasUniqueId = predicate.hasUniqueId, Element.isBrowsingContextContainer = predicate.isBrowsingContextContainer, Element.isContent = predicate.isContent, Element.isActuallyDisabled = predicate.isActuallyDisabled, Element.isDocumentElement = predicate.isDocumentElement, Element.isDraggable = predicate.isDraggable, Element.isEditingHost = predicate.isEditingHost, Element.isFallback = predicate.isFallback, Element.isScopedTo = predicate.isScopedTo, Element.isSuggestedFocusable = predicate.isSuggestedFocusable, Element.isReplaced = predicate.isReplaced;
 })(Element || (Element = {}));
 //# sourceMappingURL=element.js.map

package/dist/node/{element/predicate → predicate}/has-box.d.ts

@@ -1,9 +1,10 @@
 import type { Device } from "@siteimprove/alfa-device";
 import type { Predicate } from "@siteimprove/alfa-predicate";
 import type { Rectangle } from "@siteimprove/alfa-rectangle";
-import type { Element } from "../../element.js";
+import type { Element } from "../element.js";
+import type { Text } from "../text.js";
 /**
  * @public
  */
-export declare function hasBox(predicate: Predicate<Rectangle> | undefined, device: Device): Predicate<Element>;
+export declare function hasBox(predicate: Predicate<Rectangle> | undefined, device: Device): Predicate<Element | Text>;
 //# sourceMappingURL=has-box.d.ts.map

package/dist/node/predicate/has-box.js

@@ -0,0 +1,7 @@
+/**
+ * @public
+ */
+export function hasBox(predicate = () => true, device) {
+    return (node) => node.getBoundingBox(device).some(predicate);
+}
+//# sourceMappingURL=has-box.js.map

package/dist/node/predicate.d.ts

@@ -1,3 +1,4 @@
+export * from "./predicate/has-box.js";
 export * from "./predicate/has-child.js";
 export * from "./predicate/has-descendant.js";
 export * from "./predicate/has-inclusive-descendant.js";

package/dist/node/predicate.js

@@ -1,3 +1,4 @@
+export * from "./predicate/has-box.js";
 export * from "./predicate/has-child.js";
 export * from "./predicate/has-descendant.js";
 export * from "./predicate/has-inclusive-descendant.js";

package/dist/node/text.d.ts

@@ -1,4 +1,6 @@
-import type { Option } from "@siteimprove/alfa-option";
+import type { Device } from "@siteimprove/alfa-device";
+import { Option } from "@siteimprove/alfa-option";
+import { Rectangle } from "@siteimprove/alfa-rectangle";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 import * as json from "@siteimprove/alfa-json";
 import { Node } from "../node.js";
@@ -8,12 +10,14 @@ import { Slotable } from "./slotable.js";
  * @public
  */
 export declare class Text extends Node<"text"> implements Slotable {
-    static of(data: string, externalId?: string, internalId?: string, extraData?: any): Text;
+    static of(data: string, box?: Option<Rectangle>, device?: Option<Device>, externalId?: string, internalId?: string, extraData?: any): Text;
     static empty(): Text;
     private readonly _data;
-    protected constructor(data: string, externalId?: string, internalId?: string, extraData?: any);
+    private readonly _boxes;
+    protected constructor(data: string, box: Option<Rectangle>, device: Option<Device>, externalId?: string, internalId?: string, extraData?: any);
     get data(): string;
     assignedSlot(): Option<Slot>;
+    getBoundingBox(device: Device): Option<Rectangle>;
     /**
      * @internal
      **/
@@ -32,15 +36,16 @@ export declare namespace Text {
     }
     interface JSON extends Node.JSON<"text"> {
         data: string;
+        box: Rectangle.JSON | null;
     }
     function isText(value: unknown): value is Text;
     /**
      * @internal
      */
-    function fromText(json: JSON): Trampoline<Text>;
+    function fromText(json: JSON, device?: Device): Trampoline<Text>;
     /**
      * @internal
      */
-    function cloneText(text: Text): Trampoline<Text>;
+    function cloneText(device?: Device): (text: Text) => Trampoline<Text>;
 }
 //# sourceMappingURL=text.d.ts.map

package/dist/node/text.js

@@ -1,3 +1,6 @@
+import { Cache } from "@siteimprove/alfa-cache";
+import { None, Option } from "@siteimprove/alfa-option";
+import { Rectangle } from "@siteimprove/alfa-rectangle";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 import * as json from "@siteimprove/alfa-json";
 import { Node } from "../node.js";
@@ -6,16 +9,18 @@ import { Slotable } from "./slotable.js";
  * @public
  */
 export class Text extends Node {
-    static of(data, externalId, internalId, extraData) {
-        return new Text(data, externalId, internalId, extraData);
+    static of(data, box = None, device = None, externalId, internalId, extraData) {
+        return new Text(data, box, device, externalId, internalId, extraData);
     }
     static empty() {
-        return new Text("");
+        return new Text("", None, None);
     }
     _data;
-    constructor(data, externalId, internalId, extraData) {
+    _boxes;
+    constructor(data, box, device, externalId, internalId, extraData) {
         super([], "text", externalId, internalId, extraData);
         this._data = data;
+        this._boxes = Cache.from(device.isSome() && box.isSome() ? [[device.get(), box.get()]] : []);
     }
     get data() {
         return this._data;
@@ -23,6 +28,9 @@ export class Text extends Node {
     assignedSlot() {
         return Slotable.findSlot(this);
     }
+    getBoundingBox(device) {
+        return this._boxes.get(device);
+    }
     /**
      * @internal
      **/
@@ -46,6 +54,13 @@ export class Text extends Node {
             return result;
         }
         result.data = this.data;
+        result.box =
+            options?.device === undefined
+                ? null
+                : this._boxes
+                    .get(options.device)
+                    .map((box) => box.toJSON())
+                    .getOr(null);
         return result;
     }
     toString() {
@@ -68,15 +83,15 @@ export class Text extends Node {
     /**
      * @internal
      */
-    function fromText(json) {
-        return Trampoline.done(Text.of(json.data, json.externalId, undefined, json.internalId));
+    function fromText(json, device) {
+        return Trampoline.done(Text.of(json.data, Option.from(json.box).map(Rectangle.from), Option.from(device), json.externalId, undefined, json.internalId));
     }
     Text.fromText = fromText;
     /**
      * @internal
      */
-    function cloneText(text) {
-        return Trampoline.done(Text.of(text.data, text.externalId, text.extraData, text.internalId));
+    function cloneText(device) {
+        return (text) => Trampoline.done(Text.of(text.data, Option.from(device).flatMap((d) => text.getBoundingBox(d)), Option.from(device), text.externalId, text.extraData, text.internalId));
     }
     Text.cloneText = cloneText;
 })(Text || (Text = {}));

package/dist/node.d.ts

@@ -16,7 +16,7 @@ import * as traversal from "./node/traversal.js";
 /**
  * @public
  */
-export declare abstract class Node<T extends string = string> extends tree.Node<Node.Traversal.Flag, T> implements earl.Serializable<Node.EARL>, json.Serializable<tree.Node.JSON<T>>, sarif.Serializable<sarif.Location> {
+export declare abstract class Node<T extends string = string> extends tree.Node<"DOM traversal", Node.TraversalFlags, T> implements earl.Serializable<Node.EARL>, json.Serializable<tree.Node.JSON<T>>, sarif.Serializable<sarif.Location> {
     protected constructor(children: Array<Node>, type: T, externalId?: string, internalId?: string, extraData?: any);
     /**
      * {@link https://dom.spec.whatwg.org/#concept-descendant-text-content}
@@ -103,48 +103,148 @@ export declare namespace Node {
         };
     }
     function isNode(value: unknown): value is Node;
-    class Traversal extends Flags<Traversal.Flag> {
-        static of(...flags: Array<Traversal.Flag>): Traversal;
-    }
-    namespace Traversal {
-        type Flag = 0 | 1 | 2 | 4;
-        const none: Flag;
-        /**
-         * When set, traverse the node in shadow-including tree order.
-         *
-         * {@link https://dom.spec.whatwg.org/#concept-shadow-including-tree-order}
-         */
-        const composed: Flag;
-        /**
-         * When set, traverse the flattened element tree rooted at the node.
-         *
-         * {@link https://drafts.csswg.org/css-scoping/#flat-tree}
-         */
-        const flattened: Flag;
-        /**
-         * When set, traverse all nested browsing contexts encountered.
-         *
-         * {@link https://html.spec.whatwg.org/#nested-browsing-context}
-         */
-        const nested: Flag;
-        const empty: Traversal;
-    }
+    const Traversal: {
+        of: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => {
+            has(flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested"): boolean;
+            isSet: (flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested") => boolean;
+            add(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+            set: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+            remove(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+            unset: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+            is(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): boolean;
+            equals(value: any): boolean;
+            equals(value: unknown): value is any;
+            toString(): string;
+            toJSON(): Flags.JSON<"DOM traversal"> & {
+                composed: boolean;
+                flattened: boolean;
+                nested: boolean;
+            };
+            readonly value: number;
+            readonly kind: "DOM traversal";
+        } & {
+            composed: boolean;
+            flattened: boolean;
+            nested: boolean;
+        };
+        readonly none: 0;
+        readonly empty: {
+            has(flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested"): boolean;
+            isSet: (flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested") => boolean;
+            add(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+            set: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+            remove(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+            unset: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+            is(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): boolean;
+            equals(value: any): boolean;
+            equals(value: unknown): value is any;
+            toString(): string;
+            toJSON(): Flags.JSON<"DOM traversal"> & {
+                composed: boolean;
+                flattened: boolean;
+                nested: boolean;
+            };
+            readonly value: number;
+            readonly kind: "DOM traversal";
+        } & {
+            composed: boolean;
+            flattened: boolean;
+            nested: boolean;
+        };
+        readonly allFlags: [1, 2, 4];
+        nameOf: (flag: 1 | 2 | 4) => "composed" | "flattened" | "nested";
+        reduce: (...flags: import("@siteimprove/alfa-array").Array<number>) => number;
+        named: <K extends string, A extends import("@siteimprove/alfa-array").Array<string>>(kind: K, ...flags: A) => {
+            [x: string]: any;
+        };
+        composed: 1 | 2 | 4;
+        flattened: 1 | 2 | 4;
+        nested: 1 | 2 | 4;
+    };
+    type Traversal = ReturnType<(typeof Traversal)["of"]>;
+    type TraversalFlags = (typeof Node.Traversal.allFlags)[number];
     /**
      * Traversal options to traverse the flat tree.
      *
      * {@link https://drafts.csswg.org/css-scoping-1/#flattening}
      */
-    const flatTree: Traversal;
+    const flatTree: {
+        has(flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested"): boolean;
+        isSet: (flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested") => boolean;
+        add(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        set: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        remove(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        unset: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        is(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): boolean;
+        equals(value: any): boolean;
+        equals(value: unknown): value is any;
+        toString(): string;
+        toJSON(): Flags.JSON<"DOM traversal"> & {
+            composed: boolean;
+            flattened: boolean;
+            nested: boolean;
+        };
+        readonly value: number;
+        readonly kind: "DOM traversal";
+    } & {
+        composed: boolean;
+        flattened: boolean;
+        nested: boolean;
+    };
     /**
      * Traversal options to traverse all relevant nodes (flat tree and inside
      * nested browsing container), a very frequent use case.
      */
-    const fullTree: Traversal;
+    const fullTree: {
+        has(flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested"): boolean;
+        isSet: (flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested") => boolean;
+        add(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        set: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        remove(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        unset: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        is(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): boolean;
+        equals(value: any): boolean;
+        equals(value: unknown): value is any;
+        toString(): string;
+        toJSON(): Flags.JSON<"DOM traversal"> & {
+            composed: boolean;
+            flattened: boolean;
+            nested: boolean;
+        };
+        readonly value: number;
+        readonly kind: "DOM traversal";
+    } & {
+        composed: boolean;
+        flattened: boolean;
+        nested: boolean;
+    };
     /**
      * Traversal options to traverse in shadow-including tree order and inside
      * nested browsing context container, a common use case.
      */
-    const composedNested: Traversal;
+    const composedNested: {
+        has(flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested"): boolean;
+        isSet: (flag: 0 | 1 | 2 | 4 | "composed" | "flattened" | "nested") => boolean;
+        add(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        set: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        remove(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): any;
+        unset: (...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">) => any;
+        is(...flags: import("@siteimprove/alfa-array").Array<0 | 1 | 2 | 4 | "composed" | "flattened" | "nested">): boolean;
+        equals(value: any): boolean;
+        equals(value: unknown): value is any;
+        toString(): string;
+        toJSON(): Flags.JSON<"DOM traversal"> & {
+            composed: boolean;
+            flattened: boolean;
+            nested: boolean;
+        };
+        readonly value: number;
+        readonly kind: "DOM traversal";
+    } & {
+        composed: boolean;
+        flattened: boolean;
+        nested: boolean;
+    };
     function from(json: Element.JSON, device?: Device): Element;
     function from(json: Attribute.JSON, device?: Device): Attribute;
     function from(json: Text.JSON, device?: Device): Text;
@@ -261,6 +361,6 @@ export declare namespace Node {
      */
     function cloneNode(node: Node, options?: ElementReplacementOptions, device?: Device): Trampoline<Node>;
     const getNodesBetween: typeof traversal.getNodesBetween;
-    const hasChild: typeof predicate.hasChild, hasDescendant: typeof predicate.hasDescendant, hasInclusiveDescendant: typeof predicate.hasInclusiveDescendant, hasTextContent: typeof predicate.hasTextContent, isRoot: typeof predicate.isRoot;
+    const hasBox: typeof predicate.hasBox, hasChild: typeof predicate.hasChild, hasDescendant: typeof predicate.hasDescendant, hasInclusiveDescendant: typeof predicate.hasInclusiveDescendant, hasTextContent: typeof predicate.hasTextContent, isRoot: typeof predicate.isRoot;
 }
 //# sourceMappingURL=node.d.ts.map

package/dist/node.js

@@ -236,50 +236,23 @@ export class Node extends tree.Node {
         return value instanceof Node;
     }
     Node.isNode = isNode;
-    class Traversal extends Flags {
-        static of(...flags) {
-            return new Traversal(Flags._reduce(...flags));
-        }
-    }
-    Node.Traversal = Traversal;
-    (function (Traversal) {
-        Traversal.none = 0;
-        /**
-         * When set, traverse the node in shadow-including tree order.
-         *
-         * {@link https://dom.spec.whatwg.org/#concept-shadow-including-tree-order}
-         */
-        Traversal.composed = (1 << 0);
-        /**
-         * When set, traverse the flattened element tree rooted at the node.
-         *
-         * {@link https://drafts.csswg.org/css-scoping/#flat-tree}
-         */
-        Traversal.flattened = (1 << 1);
-        /**
-         * When set, traverse all nested browsing contexts encountered.
-         *
-         * {@link https://html.spec.whatwg.org/#nested-browsing-context}
-         */
-        Traversal.nested = (1 << 2);
-        Traversal.empty = Traversal.of(Traversal.none);
-    })(Traversal = Node.Traversal || (Node.Traversal = {}));
+    Node.Traversal = Flags.named("DOM traversal", "composed", "flattened", "nested");
     /**
      * Traversal options to traverse the flat tree.
      *
      * {@link https://drafts.csswg.org/css-scoping-1/#flattening}
      */
-    Node.flatTree = Traversal.of(Traversal.flattened);
+    Node.flatTree = Node.Traversal.of("flattened");
     /**
      * Traversal options to traverse all relevant nodes (flat tree and inside
      * nested browsing container), a very frequent use case.
      */
-    Node.fullTree = Traversal.of(Traversal.flattened, Traversal.nested);
+    Node.fullTree = Node.Traversal.of("flattened", "nested");
     /**
      * Traversal options to traverse in shadow-including tree order and inside
      * nested browsing context container, a common use case.
      */
-    Node.composedNested = Traversal.of(Traversal.composed, Traversal.nested);
+    Node.composedNested = Node.Traversal.of("composed", "nested");
     const cacheWithDevice = Cache.empty();
     const cacheWithoutDevice = Cache.empty();
     function from(json, device) {
@@ -300,7 +273,7 @@ export class Node extends tree.Node {
             case "attribute":
                 return Attribute.fromAttribute(json);
             case "text":
-                return Text.fromText(json);
+                return Text.fromText(json, device);
             case "comment":
                 return Comment.fromComment(json);
             case "document":
@@ -328,7 +301,7 @@ export class Node extends tree.Node {
         return Selective.of(node)
             .if(Element.isElement, Element.cloneElement(options, device))
             .if(Attribute.isAttribute, Attribute.cloneAttribute)
-            .if(Text.isText, Text.cloneText)
+            .if(Text.isText, Text.cloneText(device))
             .if(Comment.isComment, Comment.cloneComment)
             .if(Document.isDocument, Document.cloneDocument(options, device))
             .if(Type.isType, Type.cloneType)
@@ -341,6 +314,6 @@ export class Node extends tree.Node {
     }
     Node.cloneNode = cloneNode;
     Node.getNodesBetween = traversal.getNodesBetween;
-    Node.hasChild = predicate.hasChild, Node.hasDescendant = predicate.hasDescendant, Node.hasInclusiveDescendant = predicate.hasInclusiveDescendant, Node.hasTextContent = predicate.hasTextContent, Node.isRoot = predicate.isRoot;
+    Node.hasBox = predicate.hasBox, Node.hasChild = predicate.hasChild, Node.hasDescendant = predicate.hasDescendant, Node.hasInclusiveDescendant = predicate.hasInclusiveDescendant, Node.hasTextContent = predicate.hasTextContent, Node.isRoot = predicate.isRoot;
 })(Node || (Node = {}));
 //# sourceMappingURL=node.js.map

package/package.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/package",
   "name": "@siteimprove/alfa-dom",
   "homepage": "https://alfa.siteimprove.com",
-  "version": "0.99.0",
+  "version": "0.100.1",
   "license": "MIT",
   "description": "Implementations of the core DOM and CSSOM node types",
   "repository": {
@@ -35,35 +35,35 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@siteimprove/alfa-array": "^0.99.0",
-    "@siteimprove/alfa-cache": "^0.99.0",
-    "@siteimprove/alfa-comparable": "^0.99.0",
-    "@siteimprove/alfa-css": "^0.99.0",
-    "@siteimprove/alfa-css-feature": "^0.99.0",
-    "@siteimprove/alfa-device": "^0.99.0",
-    "@siteimprove/alfa-earl": "^0.99.0",
-    "@siteimprove/alfa-equatable": "^0.99.0",
-    "@siteimprove/alfa-flags": "^0.99.0",
-    "@siteimprove/alfa-iterable": "^0.99.0",
-    "@siteimprove/alfa-json": "^0.99.0",
-    "@siteimprove/alfa-lazy": "^0.99.0",
-    "@siteimprove/alfa-map": "^0.99.0",
-    "@siteimprove/alfa-option": "^0.99.0",
-    "@siteimprove/alfa-parser": "^0.99.0",
-    "@siteimprove/alfa-predicate": "^0.99.0",
-    "@siteimprove/alfa-rectangle": "^0.99.0",
-    "@siteimprove/alfa-refinement": "^0.99.0",
-    "@siteimprove/alfa-result": "^0.99.0",
-    "@siteimprove/alfa-sarif": "^0.99.0",
-    "@siteimprove/alfa-selective": "^0.99.0",
-    "@siteimprove/alfa-sequence": "^0.99.0",
-    "@siteimprove/alfa-slice": "^0.99.0",
-    "@siteimprove/alfa-string": "^0.99.0",
-    "@siteimprove/alfa-trampoline": "^0.99.0",
-    "@siteimprove/alfa-tree": "^0.99.0"
+    "@siteimprove/alfa-array": "^0.100.1",
+    "@siteimprove/alfa-cache": "^0.100.1",
+    "@siteimprove/alfa-comparable": "^0.100.1",
+    "@siteimprove/alfa-css": "^0.100.1",
+    "@siteimprove/alfa-css-feature": "^0.100.1",
+    "@siteimprove/alfa-device": "^0.100.1",
+    "@siteimprove/alfa-earl": "^0.100.1",
+    "@siteimprove/alfa-equatable": "^0.100.1",
+    "@siteimprove/alfa-flags": "^0.100.1",
+    "@siteimprove/alfa-iterable": "^0.100.1",
+    "@siteimprove/alfa-json": "^0.100.1",
+    "@siteimprove/alfa-lazy": "^0.100.1",
+    "@siteimprove/alfa-map": "^0.100.1",
+    "@siteimprove/alfa-option": "^0.100.1",
+    "@siteimprove/alfa-parser": "^0.100.1",
+    "@siteimprove/alfa-predicate": "^0.100.1",
+    "@siteimprove/alfa-rectangle": "^0.100.1",
+    "@siteimprove/alfa-refinement": "^0.100.1",
+    "@siteimprove/alfa-result": "^0.100.1",
+    "@siteimprove/alfa-sarif": "^0.100.1",
+    "@siteimprove/alfa-selective": "^0.100.1",
+    "@siteimprove/alfa-sequence": "^0.100.1",
+    "@siteimprove/alfa-slice": "^0.100.1",
+    "@siteimprove/alfa-string": "^0.100.1",
+    "@siteimprove/alfa-trampoline": "^0.100.1",
+    "@siteimprove/alfa-tree": "^0.100.1"
   },
   "devDependencies": {
-    "@siteimprove/alfa-test": "^0.99.0",
+    "@siteimprove/alfa-test": "^0.100.1",
     "@types/jsdom": "^21.1.6",
     "jsdom": "^26.0.0"
   },

package/dist/node/element/predicate/has-box.js

@@ -1,7 +0,0 @@
-/**
- * @public
- */
-export function hasBox(predicate = () => true, device) {
-    return (element) => element.getBoundingBox(device).some(predicate);
-}
-//# sourceMappingURL=has-box.js.map