@markuplint/rules 3.0.0-canary.3 → 3.0.0-dev.177

package/lib/permitted-contents/index.d.ts

@@ -1,3 +1,3 @@
 import type { Options, TagRule } from './types';
-declare const _default: import("@markuplint/ml-core").RuleSeed<TagRule[], Options>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<TagRule[], Options>>;
 export default _default;

package/lib/permitted-contents/index.js

@@ -11,22 +11,17 @@ exports.default = (0, ml_core_1.createRule)({
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
             var _a, _b, _c;
-            if (!el.rule.value) {
+            if (el.rule.options.ignoreHasMutableChildren && el.hasMutableChildren()) {
                 return;
             }
-            if (el.rule.option.ignoreHasMutableChildren && el.hasMutableChildren()) {
-                return;
-            }
-            const results = (0, content_model_1.contentModel)(el, el.rule.value, el.rule.option);
+            const results = (0, content_model_1.contentModel)(el, el.rule.value, el.rule.options);
             for (const { type, scope, query, hint } of results) {
                 let message = '';
-                if (hint) {
-                    if (hint.max != null) {
-                        message =
-                            t('there is more content than it needs') +
-                                t('. ') +
-                                t('the max number of elements required is {0}', `${hint.max}`);
-                    }
+                if (hint.max != null) {
+                    message =
+                        t('there is more content than it needs') +
+                            t('. ') +
+                            t('the max number of elements required is {0}', `${hint.max}`);
                 }
                 switch (type) {
                     case 'MATCHED':
@@ -75,10 +70,10 @@ exports.default = (0, ml_core_1.createRule)({
                         });
                         break;
                     }
-                    case 'VOID_ELEMENT': {
+                    case 'NOTHING': {
                         report({
                             scope: el,
-                            message: t('{0} is {1}', t('the {0}', 'element'), t('a {0}', 'void element')),
+                            message: t('{0} disallows {1}', t('the {0}', 'element'), 'contents'),
                         });
                         break;
                     }
@@ -91,7 +86,9 @@ exports.default = (0, ml_core_1.createRule)({
         });
     },
 });
-function name(scope, t) {
+function name(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+scope, t) {
     if (scope.is(scope.ELEMENT_NODE)) {
         return t('the "{0}" {1}', scope.localName, 'element');
     }

package/lib/permitted-contents/matches-selector.d.ts

@@ -1,3 +1,8 @@
-import type { ChildNode, Options, Result, Specs } from './types';
+import type { ChildNode, Result, Specs } from './types';
 export type SelectorResult = Result<'UNMATCHED_SELECTOR_BUT_MAY_EMPTY' | 'MISSING_NODE' | 'UNMATCHED_SELECTORS'>;
-export declare function matchesSelector(query: string, node: ChildNode | undefined, specs: Specs, options: Options, depth: number): SelectorResult;
+export declare function matchesSelector(
+	query: string,
+	node: ChildNode | undefined,
+	specs: Specs,
+	depth: number,
+): SelectorResult;

package/lib/permitted-contents/matches-selector.js

@@ -4,7 +4,9 @@ exports.matchesSelector = void 0;
 const ml_spec_1 = require("@markuplint/ml-spec");
 const debug_1 = require("./debug");
 const utils_1 = require("./utils");
-function matchesSelector(query, node, specs, options, depth) {
+function matchesSelector(query, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+node, specs, depth) {
     const nodeLog = debug_1.cmLog.extend(`node#${depth}`);
     const { selector, hasText, hasCustom } = optCondition(query, specs);
     if (node == null) {
@@ -12,7 +14,7 @@ function matchesSelector(query, node, specs, options, depth) {
             nodeLog('<#text>.matches(%s) => ""', query);
             return {
                 type: 'MATCHED_ZERO',
-                matched: node ? [node] : [],
+                matched: [],
                 unmatched: [],
                 zeroMatch: true,
                 query,
@@ -103,9 +105,9 @@ function matchesSelector(query, node, specs, options, depth) {
                 unmatched: [node],
                 zeroMatch: true,
                 query,
-                hint: {
+                hint: (0, utils_1.cleanObject)({
                     not: result.not,
-                },
+                }),
             };
         }
         return {
@@ -114,9 +116,9 @@ function matchesSelector(query, node, specs, options, depth) {
             unmatched: [node],
             zeroMatch: false,
             query,
-            hint: {
+            hint: (0, utils_1.cleanObject)({
                 not: result.not,
-            },
+            }),
         };
     }
     return {

package/lib/permitted-contents/order.d.ts

@@ -1,5 +1,6 @@
 import type { ChildNode, Options, Result, Specs } from './types';
 import type { PermittedContentPattern } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
 /**
  * Check ordered array
  *
@@ -10,4 +11,10 @@ import type { PermittedContentPattern } from '@markuplint/ml-spec';
  * @param depth
  * @returns
  */
-export declare function order(contents: ReadonlyArray<PermittedContentPattern>, nodes: ReadonlyArray<ChildNode>, specs: Specs, options: Options, depth: number): Result;
+export declare function order(
+	contents: ReadonlyDeep<PermittedContentPattern[]>,
+	nodes: readonly ChildNode[],
+	specs: Specs,
+	options: Options,
+	depth: number,
+): Result;

package/lib/permitted-contents/order.js

@@ -15,42 +15,51 @@ const utils_1 = require("./utils");
  * @param depth
  * @returns
  */
-function order(contents, nodes, specs, options, depth) {
-    var _a, _b, _c, _d;
+function order(contents, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes, specs, options, depth) {
+    var _a, _b, _c, _d, _e;
     const orderLog = debug_1.cmLog.extend(`order#${depth}`);
     const btLog = debug_1.cmLog.extend(`backtrack#${depth}`);
     const patterns = (0, helpers_1.deepCopy)(contents);
     const collection = new utils_1.Collection(nodes);
+    orderLog('Model:\n  RegEx: %s\n  Schema: %o', (0, utils_1.modelLog)(patterns, ''), patterns);
     orderLog('Starts: %s', collection);
     let result = undefined;
     let backtrackMode = false;
     let afterBacktrack = false;
     const unmatchedResults = [];
-    while (patterns.length) {
+    while (patterns.length > 0 && patterns[0]) {
         result = (0, complex_branch_1.complexBranch)(patterns[0], collection.unmatched, specs, options, depth);
         collection.addMatched(result.matched);
-        orderLog('stack: %s', collection);
         if (result.type !== 'UNEXPECTED_EXTRA_NODE' && result.type !== 'MATCHED' && result.type !== 'MATCHED_ZERO') {
             unmatchedResults.push(result);
             if (backtrackMode) {
                 collection.back();
-                btLog('🔙');
+                btLog('🔙◀BACK');
                 backtrackMode = false;
                 afterBacktrack = true;
                 continue;
             }
-            orderLog('conformed (%s): %s', result.type, collection.toString(true));
             const barelyMatchedResult = unmatchedResults.sort((a, b) => b.matched.length - a.matched.length)[0];
             if (!barelyMatchedResult) {
                 throw new Error('Unreachable code');
             }
+            orderLog('Result (%s): %s%s', result.type, collection.toString(true), ((_a = barelyMatchedResult.hint.missing) === null || _a === void 0 ? void 0 : _a.barelyMatchedElements) != null
+                ? `; But ${barelyMatchedResult.hint.missing.barelyMatchedElements} elements hit out of pattern`
+                : '');
             return {
                 type: barelyMatchedResult.type,
                 matched: collection.matched,
                 unmatched: collection.unmatched,
                 zeroMatch: barelyMatchedResult.zeroMatch,
                 query: barelyMatchedResult.query,
-                hint: barelyMatchedResult.hint,
+                hint: (0, utils_1.mergeHints)(barelyMatchedResult.hint, {
+                    missing: {
+                        barelyMatchedElements: collection.matched.length,
+                        need: barelyMatchedResult.query,
+                    },
+                }),
             };
         }
         if (afterBacktrack) {
@@ -65,25 +74,26 @@ function order(contents, nodes, specs, options, depth) {
         }
         patterns.shift();
     }
-    if (collection.unmatched.length) {
-        orderLog('Conformed (UNEXPECTED_EXTRA_NODE): %s', collection.toString(true));
+    if (collection.unmatched.length > 0) {
+        orderLog('Result (UNEXPECTED_EXTRA_NODE): %s', collection.toString(true));
         return {
             type: 'UNEXPECTED_EXTRA_NODE',
             matched: collection.matched,
             unmatched: collection.unmatched,
             zeroMatch: false,
-            query: (_a = result === null || result === void 0 ? void 0 : result.query) !== null && _a !== void 0 ? _a : 'N/A',
-            hint: (_b = result === null || result === void 0 ? void 0 : result.hint) !== null && _b !== void 0 ? _b : {},
+            query: (_b = result === null || result === void 0 ? void 0 : result.query) !== null && _b !== void 0 ? _b : 'N/A',
+            hint: (_c = result === null || result === void 0 ? void 0 : result.hint) !== null && _c !== void 0 ? _c : {},
         };
     }
-    orderLog('Conformed: %s', collection);
+    const resultType = collection.matched.length > 0 ? 'MATCHED' : 'MATCHED_ZERO';
+    orderLog('Result (%s): %s', resultType, collection.toString(true));
     return {
-        type: collection.matched.length ? 'MATCHED' : 'MATCHED_ZERO',
+        type: resultType,
         matched: collection.matched,
         unmatched: collection.unmatched,
         zeroMatch: false,
-        query: (_c = result === null || result === void 0 ? void 0 : result.query) !== null && _c !== void 0 ? _c : 'N/A',
-        hint: (_d = result === null || result === void 0 ? void 0 : result.hint) !== null && _d !== void 0 ? _d : {},
+        query: (_d = result === null || result === void 0 ? void 0 : result.query) !== null && _d !== void 0 ? _d : 'N/A',
+        hint: (_e = result === null || result === void 0 ? void 0 : result.hint) !== null && _e !== void 0 ? _e : {},
     };
 }
 exports.order = order;

package/lib/permitted-contents/recursive-branch.d.ts

@@ -1,4 +1,11 @@
 import type { SelectorResult } from './matches-selector';
 import type { ChildNode, Options, Specs } from './types';
 import type { PermittedContentPattern, Model } from '@markuplint/ml-spec';
-export declare function recursiveBranch(model: Model | PermittedContentPattern[], nodes: readonly ChildNode[], specs: Specs, options: Options, depth: number): SelectorResult;
+import type { ReadonlyDeep } from 'type-fest';
+export declare function recursiveBranch(
+	model: ReadonlyDeep<Model | PermittedContentPattern[]>,
+	nodes: readonly ChildNode[],
+	specs: Specs,
+	options: Options,
+	depth: number,
+): SelectorResult;

package/lib/permitted-contents/recursive-branch.js

@@ -4,17 +4,19 @@ exports.recursiveBranch = void 0;
 const matches_selector_1 = require("./matches-selector");
 const order_1 = require("./order");
 const utils_1 = require("./utils");
-function recursiveBranch(model, nodes, specs, options, depth) {
+function recursiveBranch(model, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes, specs, options, depth) {
     if (!(0, utils_1.isModel)(model)) {
         return (0, order_1.order)(model, nodes, specs, options, depth + 1);
     }
     if (typeof model === 'string') {
-        return (0, matches_selector_1.matchesSelector)(model, nodes[0], specs, options, depth);
+        return (0, matches_selector_1.matchesSelector)(model, nodes[0], specs, depth);
     }
     const collection = new utils_1.Collection(nodes);
     let lastUnmatched = null;
     for (const query of model) {
-        const result = (0, matches_selector_1.matchesSelector)(query, collection.unmatched[0], specs, options, depth);
+        const result = (0, matches_selector_1.matchesSelector)(query, collection.unmatched[0], specs, depth);
         collection.addMatched(result.matched);
         if (result.type === 'MATCHED' || result.type === 'MATCHED_ZERO') {
             return {

package/lib/permitted-contents/represent-transparent-nodes.d.ts

@@ -1,6 +1,10 @@
 import type { ChildNode, Options, Result, Specs } from './types';
 export declare const transparentMode: Map<ChildNode, true>;
-export declare function representTransparentNodes(nodes: ChildNode[], specs: Specs, options: Options): {
-    nodes: ChildNode[];
-    errors: Result[];
+export declare function representTransparentNodes(
+	nodes: ChildNode[],
+	specs: Specs,
+	options: Options,
+): {
+	nodes: ChildNode[];
+	errors: Result[];
 };

package/lib/permitted-contents/represent-transparent-nodes.js

@@ -5,7 +5,9 @@ const ml_spec_1 = require("@markuplint/ml-spec");
 const order_1 = require("./order");
 const utils_1 = require("./utils");
 exports.transparentMode = new Map();
-function representTransparentNodes(nodes, specs, options) {
+function representTransparentNodes(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes, specs, options) {
     var _a;
     const result = [];
     const errors = [];
@@ -13,9 +15,6 @@ function representTransparentNodes(nodes, specs, options) {
     if (parent) {
         const { errors: parentErrors } = representTransparentNodes([parent], specs, options);
         errors.push(...parentErrors);
-        // if (!Array.isArray(parentRes)) {
-        // 	return parentRes;
-        // }
     }
     for (const node of nodes) {
         if (!node.is(node.ELEMENT_NODE)) {
@@ -34,7 +33,7 @@ function representTransparentNodes(nodes, specs, options) {
         }
         const collection = new utils_1.Collection((0, utils_1.getChildNodesWithoutWhitespaces)(node));
         let unmatched;
-        if (noTransparentModels.length) {
+        if (noTransparentModels.length > 0) {
             const result = (0, order_1.order)(noTransparentModels, collection.unmatched, specs, options, Infinity);
             unmatched = result.unmatched;
         }

package/lib/permitted-contents/start.d.ts

@@ -1,5 +1,6 @@
 import type { ContentModelResult, Element, Options, Specs } from './types';
 import type { ContentModel } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
 /**
  * Check start
  *
@@ -9,4 +10,9 @@ import type { ContentModel } from '@markuplint/ml-spec';
  * @param options
  * @returns
  */
-export declare function start(contents: ContentModel['contents'], el: Element, specs: Specs, options: Options): ContentModelResult[];
+export declare function start(
+	contents: ReadonlyDeep<ContentModel['contents']>,
+	el: Element,
+	specs: Specs,
+	options: Options,
+): ContentModelResult[];

package/lib/permitted-contents/start.js

@@ -13,13 +13,15 @@ const utils_1 = require("./utils");
  * @param options
  * @returns
  */
-function start(contents, el, specs, options) {
+function start(contents, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el, specs, options) {
     var _a;
     if (contents === false) {
-        if (el.childNodes.length) {
+        if (el.childNodes.length > 0) {
             return [
                 {
-                    type: 'VOID_ELEMENT',
+                    type: 'NOTHING',
                     scope: el,
                     query: ':not(*)',
                     hint: {},

package/lib/permitted-contents/transparent.d.ts

@@ -1,2 +1,2 @@
-import type { ChildNode, Options, Result, Specs } from './types';
-export declare function transparent(nodes: ChildNode[], specs: Specs, options: Options, depth: number): Result;
+import type { ChildNode, Result } from './types';
+export declare function transparent(nodes: readonly ChildNode[]): Result;

package/lib/permitted-contents/transparent.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transparent = void 0;
-const count_pattern_1 = require("./count-pattern");
 const debug_1 = require("./debug");
-const utils_1 = require("./utils");
 const transparentLog = debug_1.cmLog.extend('transparent');
-function transparent(nodes, specs, options, depth) {
-    var _a;
-    if (nodes.length === 0 || ((_a = nodes[0].parentElement) === null || _a === void 0 ? void 0 : _a.parentElement)) {
+function transparent(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes) {
+    var _a, _b;
+    if (nodes.length === 0 || ((_b = (_a = nodes[0]) === null || _a === void 0 ? void 0 : _a.parentElement) === null || _b === void 0 ? void 0 : _b.parentElement)) {
         transparentLog('Skipped');
         return {
             type: nodes.length === 0 ? 'MATCHED_ZERO' : 'MATCHED',
@@ -19,16 +19,13 @@ function transparent(nodes, specs, options, depth) {
         };
     }
     transparentLog('Transparent model element is component root');
-    const collection = new utils_1.Collection(nodes);
-    const result = (0, count_pattern_1.countPattern)({ zeroOrMore: ':model(flow)' }, collection.unmatched, specs, options, depth);
-    collection.addMatched(result.matched);
     return {
-        type: result.type,
-        matched: collection.matched,
-        unmatched: collection.unmatched,
-        zeroMatch: result.zeroMatch,
-        query: result.query,
-        hint: result.hint,
+        type: 'MATCHED',
+        matched: nodes.slice(),
+        unmatched: [],
+        zeroMatch: false,
+        query: 'transparent',
+        hint: {},
     };
 }
 exports.transparent = transparent;

package/lib/permitted-contents/types.d.ts

@@ -1,45 +1,52 @@
 import type { Element as _Element, ChildNode as _ChildNode } from '@markuplint/ml-core';
 import type { ContentModel, MLMLSpec } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
 export type Element = _Element<TagRule[], Options>;
 export type ChildNode = _ChildNode<TagRule[], Options>;
 export type Specs = {
-    cites: MLMLSpec['cites'];
-    def: MLMLSpec['def'];
-    specs: {
-        name: string;
-        contentModel: {
-            contents: MLMLSpec['specs'][0]['contentModel']['contents'];
-        };
-    }[];
+	readonly cites: MLMLSpec['cites'];
+	readonly def: MLMLSpec['def'];
+	readonly specs: readonly {
+		readonly name: string;
+		readonly contentModel: {
+			readonly contents: MLMLSpec['specs'][0]['contentModel']['contents'];
+		};
+	}[];
 };
 export type ContentModelResult = {
-    type: MatchedReason | UnmatchedReason;
-    scope: ChildNode;
-    query: Result['query'];
-    hint: Result['hint'];
+	type: MatchedReason | UnmatchedReason;
+	scope: ChildNode;
+	query: Result['query'];
+	hint: Result['hint'];
 };
 export type Result<T extends string = MatchedReason> = {
-    type: MatchedReason | UnmatchedReason | T;
-    matched: ChildNode[];
-    unmatched: ChildNode[];
-    zeroMatch: boolean;
-    query: string;
-    hint: {
-        max?: number;
-        not?: ChildNode;
-        transparent?: Element;
-    };
+	type: MatchedReason | UnmatchedReason | T;
+	matched: ChildNode[];
+	unmatched: ChildNode[];
+	zeroMatch: boolean;
+	query: string;
+	hint: Hints;
+};
+export type Hints = {
+	max?: number;
+	not?: ChildNode;
+	transparent?: Element;
+	missing?: {
+		barelyMatchedElements?: number;
+		need?: string;
+	};
 };
 export type MatchedReason = 'MATCHED' | 'MATCHED_ZERO';
-export type UnmatchedReason = 'VOID_ELEMENT' | 'UNEXPECTED_EXTRA_NODE' | 'TRANSPARENT_MODEL_DISALLOWS' | MissingNodeReason;
+export type UnmatchedReason = 'NOTHING' | 'UNEXPECTED_EXTRA_NODE' | 'TRANSPARENT_MODEL_DISALLOWS' | MissingNodeReason;
 export type MissingNodeReason = 'MISSING_NODE_REQUIRED' | 'MISSING_NODE_ONE_OR_MORE';
+export type RepeatSign = '' | '?' | '+' | '*' | `{${number},${number}}`;
 export type TransparentModel = {
-    el: Element;
-    additionalCondition: string;
+	el: Element;
+	additionalCondition: string;
 };
 export type TagRule = {
-    tag: string;
-} & ContentModel;
+	readonly tag: string;
+} & ReadonlyDeep<ContentModel>;
 export type Options = {
-    ignoreHasMutableChildren: boolean;
+	readonly ignoreHasMutableChildren: boolean;
 };

package/lib/permitted-contents/utils.d.ts

@@ -1,32 +1,100 @@
-import type { ChildNode, Element, Specs } from './types';
-import type { PermittedContentPattern, PermittedContentChoice, PermittedContentOneOrMore, PermittedContentOptional, PermittedContentRequire, PermittedContentTransparent, PermittedContentZeroOrMore, Model } from '@markuplint/ml-spec';
+import type { ChildNode, Element, Hints, MissingNodeReason, RepeatSign, Specs } from './types';
+import type {
+	PermittedContentPattern,
+	PermittedContentChoice,
+	PermittedContentOneOrMore,
+	PermittedContentOptional,
+	PermittedContentRequire,
+	PermittedContentTransparent,
+	PermittedContentZeroOrMore,
+	Model,
+} from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
 export declare function getChildNodesWithoutWhitespaces(el: Element): ChildNode[];
-export declare function isModel(model: Model | PermittedContentPattern[]): model is Model;
-export declare function matches(selector: string, node: ChildNode, specs: Specs): {
-    matched: boolean;
-    not?: undefined;
-} | {
-    matched: boolean;
-    not: ChildNode | undefined;
+export declare function isModel(model: ReadonlyDeep<Model | PermittedContentPattern[]>): model is ReadonlyDeep<Model>;
+export declare function matches(
+	selector: string,
+	node: ChildNode,
+	specs: Specs,
+):
+	| {
+			matched: boolean;
+			not?: undefined;
+	  }
+	| {
+			matched: boolean;
+			not: ChildNode | undefined;
+	  };
+export declare function isRequire(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentRequire>;
+export declare function isOptional(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentOptional>;
+export declare function isOneOrMore(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentOneOrMore>;
+export declare function isZeroOrMore(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentZeroOrMore>;
+export declare function isChoice(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentChoice>;
+export declare function isTransparent(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentTransparent>;
+export declare function normalizeModel(
+	pattern:
+		| ReadonlyDeep<PermittedContentRequire>
+		| ReadonlyDeep<PermittedContentOptional>
+		| ReadonlyDeep<PermittedContentOneOrMore>
+		| ReadonlyDeep<PermittedContentZeroOrMore>,
+): {
+	model: ReadonlyDeep<PermittedContentPattern[] | Model>;
+	min: number;
+	max: number;
+	repeat: RepeatSign;
+	missingType: MissingNodeReason | undefined;
 };
-export declare function isRequire(content: PermittedContentPattern): content is PermittedContentRequire;
-export declare function isOptional(content: PermittedContentPattern): content is PermittedContentOptional;
-export declare function isOneOrMore(content: PermittedContentPattern): content is PermittedContentOneOrMore;
-export declare function isZeroOrMore(content: PermittedContentPattern): content is PermittedContentZeroOrMore;
-export declare function isChoice(content: PermittedContentPattern): content is PermittedContentChoice;
-export declare function isTransparent(content: PermittedContentPattern): content is PermittedContentTransparent;
+export declare function mergeHints(
+	a: Readonly<Hints>,
+	b: Readonly<Hints>,
+): Partial<{
+	missing:
+		| Partial<{
+				barelyMatchedElements?: number | undefined;
+				need?: string | undefined;
+		  }>
+		| undefined;
+	max?: number | undefined;
+	not?:
+		| import('packages/@markuplint/ml-core/lib').DocumentType<
+				import('./types').TagRule[],
+				import('./types').Options
+		  >
+		| import('packages/@markuplint/ml-core/lib/ml-dom/node/character-data').MLCharacterData<
+				import('./types').TagRule[],
+				import('./types').Options,
+				import('packages/@markuplint/ml-ast/lib').MLASTAbstractNode
+		  >
+		| import('packages/@markuplint/ml-core/lib').Element<import('./types').TagRule[], import('./types').Options>
+		| import('packages/@markuplint/ml-core/lib').Block<import('./types').TagRule[], import('./types').Options>
+		| undefined;
+	transparent?: Element | undefined;
+}>;
+export declare function cleanObject<T extends Object>(object: T): Partial<T>;
 export declare class Collection {
-    #private;
-    constructor(origin: readonly ChildNode[]);
-    get matched(): ChildNode[];
-    get matchedCount(): number;
-    get nodes(): ChildNode[];
-    get unmatched(): ChildNode[];
-    addMatched(nodes: ChildNode[]): boolean;
-    back(): void;
-    lock(): void;
-    max(max: number): void;
-    toString(highlightExtraNodes?: boolean): string;
-}
-export declare class UnsupportedError extends Error {
+	#private;
+	constructor(origin: readonly ChildNode[]);
+	get matched(): ChildNode[];
+	get matchedCount(): number;
+	get nodes(): ChildNode[];
+	get unmatched(): ChildNode[];
+	addMatched(nodes: ChildNode[]): boolean;
+	back(): void;
+	lock(): void;
+	max(max: number): void;
+	toString(highlightExtraNodes?: boolean): string;
 }
+export declare class UnsupportedError extends Error {}
+export declare function modelLog(model: ReadonlyDeep<Model | PermittedContentPattern[]>, repeat: RepeatSign): string;