@asamuzakjp/dom-selector 8.0.1 → 8.1.1

package/src/index.js

@@ -11,16 +11,19 @@ import { Finder } from './js/finder.js';
 import { Nwsapi } from './js/nwsapi.js';
 import { extractSubjectsAst } from './js/parser.js';
 import {
+  extractSubjectsRegExp,
   filterSelector,
-  getType,
-  extractSubjectsRegExp
-} from './js/utility.js';
+  isSupportedAST
+} from './js/selector.js';
+import { collectAllDescendants, getType } from './js/utility.js';
 
 /* constants */
 import {
+  ATTR_TYPE,
+  COMBO,
   DOCUMENT_NODE,
-  DOCUMENT_FRAGMENT_NODE,
   ELEMENT_NODE,
+  TAG_TYPE_WO_UNIVERSAL,
   TARGET_ALL,
   TARGET_FIRST,
   TARGET_LINEAL,
@@ -30,6 +33,10 @@ const CACHE_SIZE = 2048;
 
 /* regexp */
 const REG_SELECTOR = /[[\]():\\"'`]/;
+const REG_TEST_LIB = new RegExp(
+  `^(?:${TAG_TYPE_WO_UNIVERSAL}|[*]?${ATTR_TYPE}(?:\\s*,\\s*${TAG_TYPE_WO_UNIVERSAL}${COMBO}${TAG_TYPE_WO_UNIVERSAL})?)$`
+);
+const REG_UNIVERSAL = /^(?:\*\|)?\*$/;
 
 /**
  * @typedef {object} CheckResult
@@ -59,16 +66,51 @@ export class DOMSelector {
     this.#window = window;
     this.#document = document ?? window.document;
     this.#idlUtils = idlUtils;
-    this.#cache = new GenerationalCache(cacheSize ?? CACHE_SIZE);
+    this.#cache = new GenerationalCache(cacheSize ?? CACHE_SIZE, {
+      strictvalidate: false
+    });
     this.#finder = new Finder(this.#window);
     this.#nwsapi = new Nwsapi(this.#window, this.#document);
   }
 
   /**
-   * Clears the internal cache of finder results.
+   * Validates a node and returns an Error if invalid.
+   * @private
+   * @param {Document|DocumentFragment|Element} node - The node to check.
+   * @param {boolean} [element] - `true` if the node must be an Element.
+   * @returns {TypeError|null} Returns a TypeError if invalid, otherwise null.
+   */
+  #validateNodeType = (node, element = false) => {
+    if (!node?.nodeType) {
+      return new this.#window.TypeError(`Unexpected type ${getType(node)}`);
+    }
+    if (element && node.nodeType !== ELEMENT_NODE) {
+      return new this.#window.TypeError(`Unexpected node ${node.nodeName}`);
+    }
+    return null;
+  };
+
+  /**
+   * Determines whether Nwsapi can be used for the given document.
+   * @private
+   * @param {Document} doc - The document object to check.
+   * @returns {boolean} `true` if Nwsapi can be used, otherwise `false`.
+   */
+  #canUseNwsapi = doc =>
+    doc === this.#document &&
+    doc.contentType === 'text/html' &&
+    doc.documentElement;
+
+  /**
+   * Clears the internal caches.
+   * @param {boolean} [clearAll] - Whether to clear all caches. If false,
+   * only cached matching results are cleared.
    * @returns {void}
    */
-  clear = () => {
+  clear = (clearAll = false) => {
+    if (clearAll) {
+      this.#cache.clear();
+    }
     this.#finder.clearResults(true);
   };
 
@@ -94,7 +136,7 @@ export class DOMSelector {
       try {
         const ast = this.#finder.getAST(selector);
         subjects = extractSubjectsAst(ast);
-      } catch (e) {
+      } catch {
         // fall through
       }
     }
@@ -105,6 +147,34 @@ export class DOMSelector {
     return subjects;
   };
 
+  /**
+   * Checks if the given CSS selector is supported by this engine.
+   * @param {string} selector - The CSS selector to check.
+   * @returns {boolean} `true` if the selector is supported, `false` otherwise.
+   */
+  supports = selector => {
+    if (typeof selector !== 'string') {
+      return false;
+    }
+    const cacheKey = `supports_${selector}`;
+    let isSupported = this.#cache.get(cacheKey);
+    if (isSupported !== undefined) {
+      return isSupported;
+    }
+    if (filterSelector(selector, TARGET_SELF)) {
+      isSupported = true;
+    } else {
+      try {
+        const ast = this.#finder.getAST(selector);
+        isSupported = isSupportedAST(ast);
+      } catch {
+        isSupported = false;
+      }
+    }
+    this.#cache.set(cacheKey, isSupported);
+    return isSupported;
+  };
+
   /**
    * Checks if an element matches a CSS selector.
    * @param {string} selector - The CSS selector to check against.
@@ -113,20 +183,20 @@ export class DOMSelector {
    * @returns {CheckResult} An object containing the check result.
    */
   check = (selector, node, opt = {}) => {
-    if (!node?.nodeType) {
-      const e = new this.#window.TypeError(`Unexpected type ${getType(node)}`);
-      return this.#finder.onError(e, opt);
-    } else if (node.nodeType !== ELEMENT_NODE) {
-      const e = new this.#window.TypeError(`Unexpected node ${node.nodeName}`);
-      return this.#finder.onError(e, opt);
+    const error = this.#validateNodeType(node, true);
+    if (error) {
+      return this.#finder.onError(error, opt);
+    }
+    if (REG_UNIVERSAL.test(selector)) {
+      const ast = this.#finder.getAST(selector);
+      return {
+        ast,
+        match: true,
+        pseudoElement: null
+      };
     }
     const document = node.ownerDocument;
-    if (
-      document === this.#document &&
-      document.contentType === 'text/html' &&
-      document.documentElement &&
-      node.parentNode
-    ) {
+    if (node.parentNode && this.#canUseNwsapi(document)) {
       const cacheKey = `check_${selector}`;
       let filterMatches = this.#cache.get(cacheKey);
       if (filterMatches === undefined) {
@@ -159,10 +229,13 @@ export class DOMSelector {
     if (this.#idlUtils) {
       node = this.#idlUtils.wrapperForImpl(node);
     }
-    opt.check = true;
-    opt.noexcept = true;
-    opt.warn = false;
-    return this.#finder.setup(selector, node, opt).find(TARGET_SELF);
+    const options = {
+      ...opt,
+      check: true,
+      noexcept: true,
+      warn: false
+    };
+    return this.#finder.setup(selector, node, options).find(TARGET_SELF);
   };
 
   /**
@@ -173,20 +246,15 @@ export class DOMSelector {
    * @returns {boolean} `true` if the element matches, or `false` otherwise.
    */
   matches = (selector, node, opt = {}) => {
-    if (!node?.nodeType) {
-      const e = new this.#window.TypeError(`Unexpected type ${getType(node)}`);
-      return this.#finder.onError(e, opt);
-    } else if (node.nodeType !== ELEMENT_NODE) {
-      const e = new this.#window.TypeError(`Unexpected node ${node.nodeName}`);
-      return this.#finder.onError(e, opt);
+    const error = this.#validateNodeType(node, true);
+    if (error) {
+      return this.#finder.onError(error, opt);
+    }
+    if (REG_UNIVERSAL.test(selector)) {
+      return true;
     }
     const document = node.ownerDocument;
-    if (
-      document === this.#document &&
-      document.contentType === 'text/html' &&
-      document.documentElement &&
-      node.parentNode
-    ) {
+    if (node.parentNode && this.#canUseNwsapi(document)) {
       const cacheKey = `matches_${selector}`;
       let filterMatches = this.#cache.get(cacheKey);
       if (filterMatches === undefined) {
@@ -202,17 +270,16 @@ export class DOMSelector {
         }
       }
     }
-    let res;
     try {
       if (this.#idlUtils) {
         node = this.#idlUtils.wrapperForImpl(node);
       }
       const nodes = this.#finder.setup(selector, node, opt).find(TARGET_SELF);
-      res = nodes.size;
+      return nodes.size > 0;
     } catch (e) {
       this.#finder.onError(e, opt);
     }
-    return !!res;
+    return false;
   };
 
   /**
@@ -223,20 +290,15 @@ export class DOMSelector {
    * @returns {?Element} The first matching ancestor element, or `null`.
    */
   closest = (selector, node, opt = {}) => {
-    if (!node?.nodeType) {
-      const e = new this.#window.TypeError(`Unexpected type ${getType(node)}`);
-      return this.#finder.onError(e, opt);
-    } else if (node.nodeType !== ELEMENT_NODE) {
-      const e = new this.#window.TypeError(`Unexpected node ${node.nodeName}`);
-      return this.#finder.onError(e, opt);
+    const error = this.#validateNodeType(node, true);
+    if (error) {
+      return this.#finder.onError(error, opt);
+    }
+    if (REG_UNIVERSAL.test(selector)) {
+      return node;
     }
     const document = node.ownerDocument;
-    if (
-      document === this.#document &&
-      document.contentType === 'text/html' &&
-      document.documentElement &&
-      node.parentNode
-    ) {
+    if (node.parentNode && this.#canUseNwsapi(document)) {
       const cacheKey = `closest_${selector}`;
       let filterMatches = this.#cache.get(cacheKey);
       if (filterMatches === undefined) {
@@ -282,17 +344,19 @@ export class DOMSelector {
    * @returns {?Element} The first matching element, or `null`.
    */
   querySelector = (selector, node, opt = {}) => {
-    if (!node?.nodeType) {
-      const e = new this.#window.TypeError(`Unexpected type ${getType(node)}`);
-      return this.#finder.onError(e, opt);
+    const error = this.#validateNodeType(node);
+    if (error) {
+      return this.#finder.onError(error, opt);
+    }
+    if (REG_UNIVERSAL.test(selector)) {
+      return node.firstElementChild;
     }
+    /*
     const document =
       node.nodeType === DOCUMENT_NODE ? node : node.ownerDocument;
     if (
-      document === this.#document &&
-      document.contentType === 'text/html' &&
-      document.documentElement &&
-      (node.nodeType !== DOCUMENT_FRAGMENT_NODE || !node.host)
+      (node === this.#document || REG_TEST_LIB.test(selector)) &&
+      this.#canUseNwsapi(document)
     ) {
       const cacheKey = `querySelector_${selector}`;
       let filterMatches = this.#cache.get(cacheKey);
@@ -309,6 +373,7 @@ export class DOMSelector {
         }
       }
     }
+    */
     let res;
     try {
       if (this.#idlUtils) {
@@ -316,7 +381,7 @@ export class DOMSelector {
       }
       const nodes = this.#finder.setup(selector, node, opt).find(TARGET_FIRST);
       if (nodes.size) {
-        [res] = [...nodes];
+        res = nodes.values().next().value;
       }
     } catch (e) {
       this.#finder.onError(e, opt);
@@ -333,17 +398,18 @@ export class DOMSelector {
    * @returns {Array<Element>} An array of elements, or an empty array.
    */
   querySelectorAll = (selector, node, opt = {}) => {
-    if (!node?.nodeType) {
-      const e = new this.#window.TypeError(`Unexpected type ${getType(node)}`);
-      return this.#finder.onError(e, opt);
+    const error = this.#validateNodeType(node);
+    if (error) {
+      return this.#finder.onError(error, opt);
     }
     const document =
       node.nodeType === DOCUMENT_NODE ? node : node.ownerDocument;
+    if (document && REG_UNIVERSAL.test(selector)) {
+      return collectAllDescendants(node, document);
+    }
     if (
-      document === this.#document &&
-      document.contentType === 'text/html' &&
-      document.documentElement &&
-      (node.nodeType !== DOCUMENT_FRAGMENT_NODE || !node.host)
+      (node === this.#document || REG_TEST_LIB.test(selector)) &&
+      this.#canUseNwsapi(document)
     ) {
       const cacheKey = `querySelectorAll_${selector}`;
       let filterMatches = this.#cache.get(cacheKey);

package/src/js/constant.js

@@ -70,14 +70,18 @@ export const SIBLING = '\\s?[+~]\\s?';
 export const LOGIC_IS = `:is\\(\\s*[^)]+\\s*\\)`;
 // N_TH: excludes An+B with selector list, e.g. :nth-child(2n+1 of .foo)
 export const N_TH = `nth-(?:last-)?(?:child|of-type)\\(\\s*(?:even|odd|${ANB})\\s*\\)`;
-// SUB_TYPE: attr, id, class, pseudo-class, note that [foo|=bar] is excluded
-export const SUB_TYPE = '\\[[^|\\]]+\\]|[#.:][\\w-]+';
-export const SUB_TYPE_WO_PSEUDO = '\\[[^|\\]]+\\]|[#.][\\w-]+';
+// ATTR_TYPE: excludes [foo|=bar]
+export const ATTR_TYPE = '\\[[^|\\]]+\\]';
+// SUB_TYPE: attr, id, class, pseudo-class
+export const SUB_TYPE = `${ATTR_TYPE}|[#.:][\\w-]+`;
+export const SUB_TYPE_WO_PSEUDO = `${ATTR_TYPE}|[#.][\\w-]+`;
 // TAG_TYPE: *, tag
-export const TAG_TYPE = '\\*|[A-Za-z][\\w-]*';
+export const TAG_TYPE_WO_UNIVERSAL = '[A-Za-z][\\w-]*';
+export const TAG_TYPE = `\\*|${TAG_TYPE_WO_UNIVERSAL}`;
 export const TAG_TYPE_I = '\\*|[A-Z][\\w-]*';
 export const COMPOUND = `(?:${TAG_TYPE}|(?:${TAG_TYPE})?(?:${SUB_TYPE})+)`;
 export const COMPOUND_L = `(?:${TAG_TYPE}|(?:${TAG_TYPE})?(?:${SUB_TYPE}|${LOGIC_IS})+)`;
+export const COMPOUND_L_I = `(?:(?:${TAG_TYPE_I})?(?:${SUB_TYPE}|${LOGIC_IS})+)`;
 export const COMPOUND_I = `(?:${TAG_TYPE_I}|(?:${TAG_TYPE_I})?(?:${SUB_TYPE})+)`;
 export const COMPOUND_WO_PSEUDO = `(?:${TAG_TYPE}|(?:${TAG_TYPE})?(?:${SUB_TYPE_WO_PSEUDO})+)`;
 export const COMPLEX = `${COMPOUND}(?:${COMBO}${COMPOUND})*`;
@@ -127,3 +131,101 @@ export const INPUT_LTR = Object.freeze([
 
 /* logical combination pseudo-classes */
 export const KEYS_LOGICAL = new Set(['has', 'is', 'not', 'where']);
+
+/* lists of supported / unsupported pseudo-classes and pseudo-elements */
+export const KEYS_PS_CLASS_SUPPORTED = new Set([
+  'active',
+  'any-link',
+  'checked',
+  'closed',
+  'default',
+  'defined',
+  'dir',
+  'disabled',
+  'empty',
+  'enabled',
+  'first-child',
+  'first-of-type',
+  'focus',
+  'focus-visible',
+  'focus-within',
+  'has',
+  'host',
+  'host-context',
+  'hover',
+  'in-range',
+  'indeterminate',
+  'invalid',
+  'is',
+  'lang',
+  'last-child',
+  'last-of-type',
+  'link',
+  'local-link',
+  'not',
+  'nth-child',
+  'nth-last-child',
+  'nth-last-of-type',
+  'nth-of-type',
+  'only-child',
+  'only-of-type',
+  'open',
+  'optional',
+  'out-of-range',
+  'placeholder-shown',
+  'read-only',
+  'read-write',
+  'required',
+  'root',
+  'scope',
+  'state',
+  'target',
+  'target-within',
+  'valid',
+  'visited',
+  'where'
+]);
+
+export const KEYS_PS_CLASS_UNSUPPORTED = new Set([
+  'autofill',
+  'blank',
+  'buffering',
+  'contains',
+  'current',
+  'fullscreen',
+  'future',
+  'has-slotted',
+  'heading',
+  'modal',
+  'muted',
+  'nth-col',
+  'nth-last-col',
+  'past',
+  'paused',
+  'picture-in-picture',
+  'playing',
+  'popover-open',
+  'seeking',
+  'stalled',
+  'user-invalid',
+  'user-valid',
+  'volume-locked',
+  '-webkit-autofill'
+]);
+
+export const KEYS_PS_ELEMENT_UNSUPPORTED = new Set([
+  'after',
+  'backdrop',
+  'before',
+  'cue',
+  'cue-region',
+  'file-selector-button',
+  'first-letter',
+  'first-line',
+  'marker',
+  'part',
+  'placeholder',
+  'selection',
+  'slotted',
+  'target-text'
+]);