@markuplint/ml-core 3.3.1 → 3.5.0

package/lib/ml-dom/node/element.js

@@ -17,7 +17,11 @@ const parent_node_1 = require("./parent-node");
 const unexpected_call_error_1 = tslib_1.__importDefault(require("./unexpected-call-error"));
 const HTML_NAMESPACE = 'http://www.w3.org/1999/xhtml';
 class MLElement extends parent_node_1.MLParentNode {
-    constructor(astNode, document) {
+    constructor(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    astNode, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    document) {
         super(astNode, document);
         _MLElement_attributes.set(this, void 0);
         _MLElement_fixedNodeName.set(this, void 0);
@@ -1969,7 +1973,9 @@ class MLElement extends parent_node_1.MLParentNode {
     /**
      * @implements DOM API: `Element`
      */
-    after(...nodes) {
+    after(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    ...nodes) {
         (0, child_node_methods_1.after)(this, ...nodes);
     }
     /**
@@ -1979,7 +1985,11 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://www.w3.org/TR/web-animations-1/#dom-animatable-animate
      */
-    animate(keyframes, options) {
+    animate(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    keyframes, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    options) {
         throw new unexpected_call_error_1.default('Not supported "animate" method');
     }
     /**
@@ -1999,13 +2009,17 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#ref-for-dom-element-attachshadow%E2%91%A0
      */
-    attachShadow(init) {
+    attachShadow(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    init) {
         throw new unexpected_call_error_1.default('Not supported "attachShadow" method');
     }
     /**
      * @implements DOM API: `Element`
      */
-    before(...nodes) {
+    before(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    ...nodes) {
         (0, child_node_methods_1.before)(this, ...nodes);
     }
     /**
@@ -2018,6 +2032,18 @@ class MLElement extends parent_node_1.MLParentNode {
     blur() {
         throw new unexpected_call_error_1.default('Not supported "blur" method');
     }
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @deprecated
+     * @unsupported
+     * @implements DOM API: `Element`
+     */
+    checkVisibility(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    options) {
+        throw new unexpected_call_error_1.default('Not supported "checkVisibility" method');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2052,7 +2078,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @unsupported
      * @implements DOM API: `Element`
      */
-    focus(options) {
+    focus(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    options) {
         throw new unexpected_call_error_1.default('Not supported "focus" method');
     }
     /**
@@ -2068,7 +2096,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://www.w3.org/TR/web-animations-1/#dom-animatable-getanimations
      */
-    getAnimations(options) {
+    getAnimations(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    options) {
         throw new unexpected_call_error_1.default('Not supported "getAnimations" method');
     }
     /**
@@ -2308,7 +2338,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#dom-element-insertadjacentelement
      */
-    insertAdjacentElement(where, element) {
+    insertAdjacentElement(where, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    element) {
         // TODO:
         throw new unexpected_call_error_1.default('Does not implement "insertAdjacentElement" method yet');
     }
@@ -2511,13 +2543,17 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-D589198
      */
-    removeAttributeNode(attr) {
+    removeAttributeNode(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    attr) {
         throw new unexpected_call_error_1.default('Not supported "removeAttributeNode" method');
     }
     /**
      * @implements DOM API: `Element`
      */
-    replaceWith(...nodes) {
+    replaceWith(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    ...nodes) {
         (0, child_node_methods_1.replaceWith)(this, ...nodes);
     }
     /**
@@ -2527,7 +2563,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://fullscreen.spec.whatwg.org/#dom-element-requestfullscreen
      */
-    requestFullscreen(options) {
+    requestFullscreen(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    options) {
         throw new unexpected_call_error_1.default('Not supported "requestFullscreen" method');
     }
     /**
@@ -2567,7 +2605,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://www.w3.org/TR/cssom-view-1/#dom-element-scrollintoview
      */
-    scrollIntoView(arg) {
+    scrollIntoView(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    arg) {
         throw new unexpected_call_error_1.default('Not supported "scrollIntoView" method');
     }
     /**
@@ -2607,7 +2647,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#dom-element-setattributenode
      */
-    setAttributeNode(attr) {
+    setAttributeNode(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    attr) {
         throw new unexpected_call_error_1.default('Not supported "setAttributeNode" method');
     }
     /**
@@ -2617,7 +2659,9 @@ class MLElement extends parent_node_1.MLParentNode {
      * @implements DOM API: `Element`
      * @see https://dom.spec.whatwg.org/#dom-element-setattributenodens
      */
-    setAttributeNodeNS(attr) {
+    setAttributeNodeNS(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    attr) {
         throw new unexpected_call_error_1.default('Not supported "setAttributeNodeNS" method');
     }
     /**

package/lib/ml-dom/node/named-node-map.d.ts

@@ -1,47 +1,42 @@
 import type { MLAttr } from './attr';
-import type { RuleConfigValue } from '@markuplint/ml-config';
-export declare class MLNamedNodeMap<T extends RuleConfigValue, O = null>
-	extends Array<MLAttr<T, O>>
-	implements NamedNodeMap
-{
-	getNamedItem(qualifiedName: string): MLAttr<T, O> | null;
-	/**
-	 * **IT THROWS AN ERROR WHEN CALLING THIS.**
-	 *
-	 * @unsupported
-	 * @implements DOM API: `NamedNodeMap`
-	 */
-	getNamedItemNS(namespace: string | null, localName: string): Attr | null;
-	item(index: number): MLAttr<T, O> | null;
-	/**
-	 * **IT THROWS AN ERROR WHEN CALLING THIS.**
-	 *
-	 * @unsupported
-	 * @implements DOM API: `NamedNodeMap`
-	 */
-	removeNamedItem(qualifiedName: string): MLAttr<T, O>;
-	/**
-	 * **IT THROWS AN ERROR WHEN CALLING THIS.**
-	 *
-	 * @unsupported
-	 * @implements DOM API: `NamedNodeMap`
-	 */
-	removeNamedItemNS(namespace: string | null, localName: string): MLAttr<T, O>;
-	/**
-	 * **IT THROWS AN ERROR WHEN CALLING THIS.**
-	 *
-	 * @unsupported
-	 * @implements DOM API: `NamedNodeMap`
-	 */
-	setNamedItem(attr: MLAttr<T, O>): MLAttr<T, O> | null;
-	/**
-	 * **IT THROWS AN ERROR WHEN CALLING THIS.**
-	 *
-	 * @unsupported
-	 * @implements DOM API: `NamedNodeMap`
-	 */
-	setNamedItemNS(attr: MLAttr<T, O>): MLAttr<T, O> | null;
+import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
+export declare class MLNamedNodeMap<T extends RuleConfigValue, O extends PlainData = undefined> extends Array<MLAttr<T, O>> implements NamedNodeMap {
+    getNamedItem(qualifiedName: string): MLAttr<T, O> | null;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `NamedNodeMap`
+     */
+    getNamedItemNS(namespace: string | null, localName: string): Attr | null;
+    item(index: number): MLAttr<T, O> | null;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `NamedNodeMap`
+     */
+    removeNamedItem(qualifiedName: string): MLAttr<T, O>;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `NamedNodeMap`
+     */
+    removeNamedItemNS(namespace: string | null, localName: string): MLAttr<T, O>;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `NamedNodeMap`
+     */
+    setNamedItem(attr: MLAttr<T, O>): MLAttr<T, O> | null;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `NamedNodeMap`
+     */
+    setNamedItemNS(attr: MLAttr<T, O>): MLAttr<T, O> | null;
 }
-export declare function toNamedNodeMap<T extends RuleConfigValue, O = null>(
-	nodes: ReadonlyArray<MLAttr<T, O>>,
-): MLNamedNodeMap<T, O>;
+export declare function toNamedNodeMap<T extends RuleConfigValue, O extends PlainData = undefined>(nodes: ReadonlyArray<MLAttr<T, O>>): MLNamedNodeMap<T, O>;

package/lib/ml-dom/node/named-node-map.js

@@ -17,7 +17,8 @@ class MLNamedNodeMap extends Array {
         throw new unexpected_call_error_1.default('Not supported "getNamedItemNS" method');
     }
     item(index) {
-        return this[index];
+        var _a;
+        return (_a = this[index]) !== null && _a !== void 0 ? _a : null;
     }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
@@ -43,7 +44,9 @@ class MLNamedNodeMap extends Array {
      * @unsupported
      * @implements DOM API: `NamedNodeMap`
      */
-    setNamedItem(attr) {
+    setNamedItem(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    attr) {
         throw new unexpected_call_error_1.default('Not supported "setNamedItem" method');
     }
     /**
@@ -52,12 +55,16 @@ class MLNamedNodeMap extends Array {
      * @unsupported
      * @implements DOM API: `NamedNodeMap`
      */
-    setNamedItemNS(attr) {
+    setNamedItemNS(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    attr) {
         throw new unexpected_call_error_1.default('Not supported "setNamedItemNS" method');
     }
 }
 exports.MLNamedNodeMap = MLNamedNodeMap;
-function toNamedNodeMap(nodes) {
+function toNamedNodeMap(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes) {
     const namedNodeMap = new MLNamedNodeMap(...nodes);
     return namedNodeMap;
 }

package/lib/ml-dom/node/node-list.d.ts

@@ -1,12 +1,6 @@
 import type { MLChildNode } from './child-node';
 import type { MLElement } from './element';
-import type { RuleConfigValue } from '@markuplint/ml-config';
-export declare function toNodeList<T extends RuleConfigValue, O, N extends MLChildNode<T, O>>(
-	nodes: ReadonlyArray<N>,
-): NodeListOf<N>;
-export declare function toHTMLCollection<T extends RuleConfigValue, O = null>(
-	nodes: ReadonlyArray<MLElement<T, O>>,
-): HTMLCollectionOf<MLElement<T, O>>;
-export declare function nodeListToHTMLCollection<T extends RuleConfigValue, O = null>(
-	nodeList: NodeListOf<MLChildNode<T, O>>,
-): HTMLCollectionOf<MLElement<T, O>>;
+import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
+export declare function toNodeList<T extends RuleConfigValue, O extends PlainData, N extends MLChildNode<T, O>>(nodes: ReadonlyArray<N>): NodeListOf<N>;
+export declare function toHTMLCollection<T extends RuleConfigValue, O extends PlainData = undefined>(nodes: ReadonlyArray<MLElement<T, O>>): HTMLCollectionOf<MLElement<T, O>>;
+export declare function nodeListToHTMLCollection<T extends RuleConfigValue, O extends PlainData = undefined>(nodeList: NodeListOf<MLChildNode<T, O>>): HTMLCollectionOf<MLElement<T, O>>;

package/lib/ml-dom/node/node-list.js

@@ -6,7 +6,21 @@ class MLNodeList extends Array {
         return super.forEach.bind(this)((v, k) => callbackfn(v, k, thisArg !== null && thisArg !== void 0 ? thisArg : this));
     }
     item(index) {
-        return this[index];
+        const node = this[index];
+        if (!node) {
+            /**
+             * ⚠ TYPE CONTRADICTION
+             *
+             * It throws an error because it should return null but the `item` method of `NodeListOf` doesn't return null in the type definition of TypeScript.
+             *
+             * @see https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-844377136
+             *
+             * > item
+             * > Returns the index-th item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.
+             */
+            throw new ReferenceError('Invalid index');
+        }
+        return node;
     }
 }
 function toNodeList(nodes) {
@@ -16,18 +30,23 @@ function toNodeList(nodes) {
 exports.toNodeList = toNodeList;
 class MLHTMLCollection extends Array {
     item(index) {
-        return this[index];
+        var _a;
+        return (_a = this[index]) !== null && _a !== void 0 ? _a : null;
     }
     namedItem(name) {
         return this.find(el => el.getAttribute('name') === name) || null;
     }
 }
-function toHTMLCollection(nodes) {
+function toHTMLCollection(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes) {
     const collection = new MLHTMLCollection(...nodes);
     return collection;
 }
 exports.toHTMLCollection = toHTMLCollection;
-function nodeListToHTMLCollection(nodeList) {
+function nodeListToHTMLCollection(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodeList) {
     const collection = new MLHTMLCollection();
     nodeList.forEach(node => {
         if (node.is(node.ELEMENT_NODE)) {

package/lib/ml-dom/node/node-store.d.ts

@@ -1,11 +1,11 @@
 import type { MLNode } from './node';
 import type { MappedNode } from './types';
 import type { MLASTAbstractNode } from '@markuplint/ml-ast';
-import type { RuleConfigValue } from '@markuplint/ml-config';
+import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
 declare class NodeStore {
-	#private;
-	getNode<N extends MLASTAbstractNode, T extends RuleConfigValue, O = null>(astNode: N): MappedNode<N, T, O>;
-	setNode<A extends MLASTAbstractNode, T extends RuleConfigValue, O = null>(astNode: A, node: MLNode<T, O, A>): void;
+    #private;
+    getNode<N extends MLASTAbstractNode, T extends RuleConfigValue, O extends PlainData = undefined>(astNode: N): MappedNode<N, T, O>;
+    setNode<A extends MLASTAbstractNode, T extends RuleConfigValue, O extends PlainData = undefined>(astNode: A, node: MLNode<T, O, A>): void;
 }
 /**
  * `NodeStore` Singleton

package/lib/ml-dom/node/node-store.js

@@ -16,7 +16,10 @@ class NodeStore {
         const node = tslib_1.__classPrivateFieldGet(this, _NodeStore_store, "f").get(astNode.uuid);
         if (!node) {
             nodeStoreError('Ref ID: %s (%s: "%s")', astNode.uuid, astNode.nodeName, astNode.raw);
-            nodeStoreError('Map: %O', tslib_1.__classPrivateFieldGet(this, _NodeStore_store, "f"));
+            nodeStoreError('Map: %O', Array.from(tslib_1.__classPrivateFieldGet(this, _NodeStore_store, "f").entries()).map(([id, node]) => ({
+                id,
+                name: node.nodeName,
+            })));
             throw new parser_utils_1.ParserError('Broke mapping nodes.', {
                 line: astNode.startLine,
                 col: astNode.startCol,
@@ -26,7 +29,9 @@ class NodeStore {
         }
         return node;
     }
-    setNode(astNode, node) {
+    setNode(astNode, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    node) {
         if (node.is(node.DOCUMENT_NODE)) {
             return;
         }
@@ -34,7 +39,7 @@ class NodeStore {
             nodeStoreError('UUID is invalid: %s (%s: "%s")', astNode.uuid, astNode.nodeName, astNode.raw);
             nodeStoreError('Invalid node: %O', node);
         }
-        nodeStoreLog('Mapped: %s (%s: "%s")', astNode.uuid, astNode.nodeName, astNode.raw);
+        nodeStoreLog('Mapped: %s (%s: "%s")', astNode.uuid, astNode.nodeName, astNode.raw.replace(/\n/g, '⏎').replace(/\t/g, '→'));
         tslib_1.__classPrivateFieldGet(this, _NodeStore_store, "f").set(astNode.uuid, node);
     }
 }