@asamuzakjp/dom-selector 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 asamuzaK (Kazz)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# DOM Selector
+
+[![build](https://github.com/asamuzaK/domSelector/actions/workflows/node.js.yml/badge.svg)](https://github.com/asamuzaK/domSelector/actions/workflows/node.js.yml)
+[![CodeQL](https://github.com/asamuzaK/domSelector/actions/workflows/codeql.yml/badge.svg)](https://github.com/asamuzaK/domSelector/actions/workflows/codeql.yml)
+<!--
+[![npm](https://img.shields.io/npm/v/dom-selector)](https://www.npmjs.com/package/url-sanitizer)
+[![release](https://img.shields.io/github/v/release/asamuzaK/domSelector)](https://github.com/asamuzaK/domSelector/releases)
+-->
+
+Retrieve DOM node from the given CSS selector.
+**Experimental**
+
+
+## Install
+
+```console
+npm i dom-selector
+```
+
+
+## Usage
+
+```javascript
+const {
+  matches, closest, querySelector, querySelectorAll
+} = require('dom-selector');
+```
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+- [matches][1]
+  - [Parameters][2]
+- [closest][3]
+  - [Parameters][4]
+- [querySelector][5]
+  - [Parameters][6]
+- [querySelectorAll][7]
+  - [Parameters][8]
+
+
+### matches(selector, node)
+
+Implementation of [Element.matches()][62].
+
+#### Parameters
+
+- `selector` **[string][56]** CSS selector
+- `node` **[object][57]** Referenced Element node
+
+Returns **[boolean][58]** Result
+
+
+### closest(selector, node)
+
+Implementation of [Element.closest()][63].
+
+#### Parameters
+
+- `selector` **[string][56]** CSS selector
+- `node` **[object][57]** Referenced Element node
+
+Returns **[object][57]?** Matched node
+
+
+### querySelector(selector, refPoint)
+
+Implementation of [Document.querySelector()][64], [Element.querySelector()][65].
+
+#### Parameters
+
+- `selector` **[string][56]** CSS selector
+- `refPoint` **[object][57]** Reference point. Document or Element node
+
+Returns **[object][57]?** Matched node
+
+
+### querySelectorAll(selector, refPoint)
+
+Implementation of [Document.querySelectorAll()][66], [Element.querySelectorAll()][67].
+**NOTE**: returns [Array][59], not [NodeList][61].
+
+#### Parameters
+
+- `selector` **[string][56]** CSS selector
+- `refPoint` **[object][57]** Reference point. Document or Element node
+
+Returns **[Array][59]&lt;([object][57] \| [undefined][60])>** Array of matched nodes
+
+
+## Acknowledgments
+
+The following resources have been of great help in the development of the DOM Selector.
+
+- [CSSTree](https://github.com/csstree/csstree)
+- [selery](https://github.com/danburzo/selery)
+
+
+[1]: #matches
+[2]: #parameters
+[3]: #closest
+[4]: #parameters-1
+[5]: #queryselector
+[6]: #parameters-2
+[7]: #queryselectorall
+[8]: #parameters-3
+[56]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[57]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[58]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[59]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[60]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
+[61]: https://developer.mozilla.org/docs/Web/API/NodeList
+[62]: https://developer.mozilla.org/docs/Web/API/Element/matches
+[63]: https://developer.mozilla.org/docs/Web/API/Element/closest
+[64]: https://developer.mozilla.org/docs/Web/API/Document/querySelector
+[65]: https://developer.mozilla.org/docs/Web/API/Element/querySelector
+[66]: https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll
+[67]: https://developer.mozilla.org/docs/Web/API/Element/querySelectorAll

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@asamuzakjp/dom-selector",
+  "description": "Retrieve DOM node from the given CSS selector.",
+  "author": "asamuzaK",
+  "license": "MIT",
+  "homepage": "https://github.com/asamuzaK/domSelector#readme",
+  "bugs": {
+    "url": "https://github.com/asamuzaK/domSelector/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asamuzaK/domSelector.git"
+  },
+  "files": [
+    "src",
+    "types"
+  ],
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "@types/css-tree": "^2.3.1",
+    "@types/node": "^20.1.0",
+    "css-tree": "^2.3.1"
+  },
+  "devDependencies": {
+    "c8": "^7.13.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.40.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-jsdoc": "^43.2.0",
+    "eslint-plugin-regexp": "^1.14.0",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "jsdom": "^22.0.0",
+    "mocha": "^10.2.0",
+    "sinon": "^15.0.4",
+    "typescript": "^5.0.4"
+  },
+  "scripts": {
+    "build": "npm run tsc && npm run lint && npm test",
+    "lint": "eslint --fix .",
+    "test": "c8 --reporter=text mocha --exit test/**/*.test.js",
+    "tsc": "npx tsc"
+  },
+  "version": "0.2.1"
+}

package/src/index.js

@@ -0,0 +1,61 @@
+/*!
+ * DOM Selector - retrieve DOM node from the given CSS selector
+ * @license MIT
+ * @copyright asamuzaK (Kazz)
+ * @see {@link https://github.com/asamuzaK/domSelector/blob/main/LICENSE}
+ */
+
+/* import */
+const { Matcher } = require('./js/matcher.js');
+
+/**
+ * matches - Element.matches()
+ * @param {string} selector - CSS selector
+ * @param {object} node - Element node
+ * @returns {boolean} - result
+ */
+const matches = (selector, node) => {
+  const matcher = new Matcher(selector, node);
+  return matcher.matches();
+};
+
+/**
+ * closest - Element.closest()
+ * @param {string} selector - CSS selector
+ * @param {object} node - Element node
+ * @returns {?object} - matched node
+ */
+const closest = (selector, node) => {
+  const matcher = new Matcher(selector, node);
+  return matcher.closest();
+};
+
+/**
+ * querySelector - Document.querySelector(), Element.querySelector()
+ * @param {string} selector - CSS selector
+ * @param {object} refPoint - Document or Element node
+ * @returns {?object} - matched node
+ */
+const querySelector = (selector, refPoint) => {
+  const matcher = new Matcher(selector, refPoint);
+  return matcher.querySelector();
+};
+
+/**
+ * querySelectorAll - Document.querySelectorAll(), Element.querySelectorAll()
+ * NOTE: returns Array, not NodeList
+ * @param {string} selector - CSS selector
+ * @param {object} refPoint - Document or Element node
+ * @returns {Array.<object|undefined>} - array of matched nodes
+ */
+const querySelectorAll = (selector, refPoint) => {
+  const matcher = new Matcher(selector, refPoint);
+  return matcher.querySelectorAll();
+};
+
+module.exports = {
+  closest,
+  matches,
+  querySelector,
+  querySelectorAll
+};

package/src/js/constant.js

@@ -0,0 +1,47 @@
+/**
+ * constant.js
+ */
+
+module.exports = {
+  AN_PLUS_B: 'AnPlusB',
+  AT_RULE: 'Atrule',
+  AT_RULE_PRELUDE: 'AtrulePrelude',
+  ATTRIBUTE_SELECTOR: 'AttributeSelector',
+  BLOCK: 'Block',
+  BRACKETS: 'Brackets',
+  CDC: 'CDC',
+  CDO: 'CDO',
+  CLASS_SELECTOR: 'ClassSelector',
+  COMBINATOR: 'Combinator',
+  COMMENT: 'Comment',
+  DECLARATION: 'Declaration',
+  DECLARATION_LIST: 'DeclarationList',
+  DIMENSION: 'Dimension',
+  FUNCTION: 'Function',
+  HASH: 'Hash',
+  ID_SELECTOR: 'IdSelector',
+  IDENTIFIER: 'Identifier',
+  MEDIA_FEATURE: 'MediaFeature',
+  MEDIA_QUERY: 'MediaQuery',
+  MEDIA_QUERY_LIST: 'MediaQueryList',
+  NESTING_SELECTOR: 'NestingSelector',
+  NTH: 'Nth',
+  NUMBER: 'Number',
+  OPERATOR: 'Operator',
+  PARENTHESES: 'Parentheses',
+  PERCENTAGE: 'Percentage',
+  PSEUDO_CLASS_SELECTOR: 'PseudoClassSelector',
+  PSEUDO_ELEMENT_SELECTOR: 'PseudoElementSelector',
+  RATIO: 'Ratio',
+  RAW: 'Raw',
+  RULE: 'Rule',
+  SELECTOR: 'Selector',
+  SELECTOR_LIST: 'SelectorList',
+  STRING: 'String',
+  STYLE_SHEET: 'StyleSheet',
+  TYPE_SELECTOR: 'TypeSelector',
+  UNICODE_RANGE: 'UnicodeRange',
+  URL: 'Url',
+  VALUE: 'Value',
+  WHITESPACE: 'WhiteSpace'
+};