@ng-doc/utils 17.6.8 → 17.6.9

package/index.esm.js

@@ -14,6 +14,10 @@ import { headingRank } from 'hast-util-heading-rank';
 import { rehype } from 'rehype';
 import { filter } from 'unist-util-filter';
 
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
 var unicode$3 = {};
 
 const UNDEFINED_CODE_POINTS = [
@@ -200,7 +204,7 @@ const DEFAULT_BUFFER_WATERLINE = 1 << 16;
 //Preprocessor
 //NOTE: HTML input preprocessing
 //(see: http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#preprocessing-the-input-stream)
-class Preprocessor$1 {
+let Preprocessor$1 = class Preprocessor {
     constructor() {
         this.html = null;
 
@@ -342,7 +346,7 @@ class Preprocessor$1 {
 
         this.pos--;
     }
-}
+};
 
 var preprocessor = Preprocessor$1;
 
@@ -561,7 +565,7 @@ function findNamedEntityTreeBranch(nodeIx, cp) {
 }
 
 //Tokenizer
-class Tokenizer$4 {
+let Tokenizer$4 = class Tokenizer {
     constructor() {
         this.preprocessor = new Preprocessor();
 
@@ -628,7 +632,7 @@ class Tokenizer$4 {
             }
 
             this.active = false;
-            this.tokenQueue.push({ type: Tokenizer$4.HIBERNATION_TOKEN });
+            this.tokenQueue.push({ type: Tokenizer.HIBERNATION_TOKEN });
 
             return true;
         }
@@ -706,7 +710,7 @@ class Tokenizer$4 {
     //Token creation
     _createStartTagToken() {
         this.currentToken = {
-            type: Tokenizer$4.START_TAG_TOKEN,
+            type: Tokenizer.START_TAG_TOKEN,
             tagName: '',
             selfClosing: false,
             ackSelfClosing: false,
@@ -716,7 +720,7 @@ class Tokenizer$4 {
 
     _createEndTagToken() {
         this.currentToken = {
-            type: Tokenizer$4.END_TAG_TOKEN,
+            type: Tokenizer.END_TAG_TOKEN,
             tagName: '',
             selfClosing: false,
             attrs: []
@@ -725,14 +729,14 @@ class Tokenizer$4 {
 
     _createCommentToken() {
         this.currentToken = {
-            type: Tokenizer$4.COMMENT_TOKEN,
+            type: Tokenizer.COMMENT_TOKEN,
             data: ''
         };
     }
 
     _createDoctypeToken(initialName) {
         this.currentToken = {
-            type: Tokenizer$4.DOCTYPE_TOKEN,
+            type: Tokenizer.DOCTYPE_TOKEN,
             name: initialName,
             forceQuirks: false,
             publicId: null,
@@ -748,7 +752,7 @@ class Tokenizer$4 {
     }
 
     _createEOFToken() {
-        this.currentToken = { type: Tokenizer$4.EOF_TOKEN };
+        this.currentToken = { type: Tokenizer.EOF_TOKEN };
     }
 
     //Tag attributes
@@ -760,7 +764,7 @@ class Tokenizer$4 {
     }
 
     _leaveAttrName(toState) {
-        if (Tokenizer$4.getTokenAttr(this.currentToken, this.currentAttr.name) === null) {
+        if (Tokenizer.getTokenAttr(this.currentToken, this.currentAttr.name) === null) {
             this.currentToken.attrs.push(this.currentAttr);
         } else {
             this._err(ERR$1.duplicateAttribute);
@@ -782,9 +786,9 @@ class Tokenizer$4 {
         this.currentToken = null;
 
         //NOTE: store emited start tag's tagName to determine is the following end tag token is appropriate.
-        if (ct.type === Tokenizer$4.START_TAG_TOKEN) {
+        if (ct.type === Tokenizer.START_TAG_TOKEN) {
             this.lastStartTagName = ct.tagName;
-        } else if (ct.type === Tokenizer$4.END_TAG_TOKEN) {
+        } else if (ct.type === Tokenizer.END_TAG_TOKEN) {
             if (ct.attrs.length > 0) {
                 this._err(ERR$1.endTagWithAttributes);
             }
@@ -832,12 +836,12 @@ class Tokenizer$4 {
     }
 
     _emitCodePoint(cp) {
-        let type = Tokenizer$4.CHARACTER_TOKEN;
+        let type = Tokenizer.CHARACTER_TOKEN;
 
         if (isWhitespace(cp)) {
-            type = Tokenizer$4.WHITESPACE_CHARACTER_TOKEN;
+            type = Tokenizer.WHITESPACE_CHARACTER_TOKEN;
         } else if (cp === $$5.NULL) {
-            type = Tokenizer$4.NULL_CHARACTER_TOKEN;
+            type = Tokenizer.NULL_CHARACTER_TOKEN;
         }
 
         this._appendCharToCurrentCharacterToken(type, toChar(cp));
@@ -852,7 +856,7 @@ class Tokenizer$4 {
     //NOTE: used then we emit character explicitly. This is always a non-whitespace and a non-null character.
     //So we can avoid additional checks here.
     _emitChars(ch) {
-        this._appendCharToCurrentCharacterToken(Tokenizer$4.CHARACTER_TOKEN, ch);
+        this._appendCharToCurrentCharacterToken(Tokenizer.CHARACTER_TOKEN, ch);
     }
 
     // Character reference helpers
@@ -2510,7 +2514,7 @@ class Tokenizer$4 {
         this._flushCodePointsConsumedAsCharacterReference();
         this._reconsumeInState(this.returnState);
     }
-}
+};
 
 //Token types
 Tokenizer$4.CHARACTER_TOKEN = 'CHARACTER_TOKEN';
@@ -2937,7 +2941,7 @@ function isScopingElement(tn, ns) {
 }
 
 //Stack of open elements
-class OpenElementStack$1 {
+let OpenElementStack$1 = class OpenElementStack {
     constructor(document, treeAdapter) {
         this.stackTop = -1;
         this.items = [];
@@ -3295,7 +3299,7 @@ class OpenElementStack$1 {
             this.pop();
         }
     }
-}
+};
 
 var openElementStack = OpenElementStack$1;
 
@@ -3303,7 +3307,7 @@ var openElementStack = OpenElementStack$1;
 const NOAH_ARK_CAPACITY = 3;
 
 //List of formatting elements
-class FormattingElementList$1 {
+let FormattingElementList$1 = class FormattingElementList {
     constructor(treeAdapter) {
         this.length = 0;
         this.entries = [];
@@ -3325,7 +3329,7 @@ class FormattingElementList$1 {
             for (let i = this.length - 1; i >= 0; i--) {
                 const entry = this.entries[i];
 
-                if (entry.type === FormattingElementList$1.MARKER_ENTRY) {
+                if (entry.type === FormattingElementList.MARKER_ENTRY) {
                     break;
                 }
 
@@ -3387,7 +3391,7 @@ class FormattingElementList$1 {
 
     //Mutations
     insertMarker() {
-        this.entries.push({ type: FormattingElementList$1.MARKER_ENTRY });
+        this.entries.push({ type: FormattingElementList.MARKER_ENTRY });
         this.length++;
     }
 
@@ -3395,7 +3399,7 @@ class FormattingElementList$1 {
         this._ensureNoahArkCondition(element);
 
         this.entries.push({
-            type: FormattingElementList$1.ELEMENT_ENTRY,
+            type: FormattingElementList.ELEMENT_ENTRY,
             element: element,
             token: token
         });
@@ -3413,7 +3417,7 @@ class FormattingElementList$1 {
         }
 
         this.entries.splice(bookmarkIdx + 1, 0, {
-            type: FormattingElementList$1.ELEMENT_ENTRY,
+            type: FormattingElementList.ELEMENT_ENTRY,
             element: element,
             token: token
         });
@@ -3437,7 +3441,7 @@ class FormattingElementList$1 {
 
             this.length--;
 
-            if (entry.type === FormattingElementList$1.MARKER_ENTRY) {
+            if (entry.type === FormattingElementList.MARKER_ENTRY) {
                 break;
             }
         }
@@ -3448,7 +3452,7 @@ class FormattingElementList$1 {
         for (let i = this.length - 1; i >= 0; i--) {
             const entry = this.entries[i];
 
-            if (entry.type === FormattingElementList$1.MARKER_ENTRY) {
+            if (entry.type === FormattingElementList.MARKER_ENTRY) {
                 return null;
             }
 
@@ -3464,14 +3468,14 @@ class FormattingElementList$1 {
         for (let i = this.length - 1; i >= 0; i--) {
             const entry = this.entries[i];
 
-            if (entry.type === FormattingElementList$1.ELEMENT_ENTRY && entry.element === element) {
+            if (entry.type === FormattingElementList.ELEMENT_ENTRY && entry.element === element) {
                 return entry;
             }
         }
 
         return null;
     }
-}
+};
 
 //Entry types
 FormattingElementList$1.MARKER_ENTRY = 'MARKER_ENTRY';
@@ -3479,7 +3483,7 @@ FormattingElementList$1.ELEMENT_ENTRY = 'ELEMENT_ENTRY';
 
 var formattingElementList = FormattingElementList$1;
 
-class Mixin$9 {
+let Mixin$9 = class Mixin {
     constructor(host) {
         const originalMethods = {};
         const overriddenMethods = this._getOverriddenMethods(this, originalMethods);
@@ -3495,7 +3499,7 @@ class Mixin$9 {
     _getOverriddenMethods() {
         throw new Error('Not implemented');
     }
-}
+};
 
 Mixin$9.install = function(host, Ctor, opts) {
     if (!host.__mixins) {
@@ -3519,7 +3523,7 @@ var mixin = Mixin$9;
 
 const Mixin$8 = mixin;
 
-class PositionTrackingPreprocessorMixin$2 extends Mixin$8 {
+let PositionTrackingPreprocessorMixin$2 = class PositionTrackingPreprocessorMixin extends Mixin$8 {
     constructor(preprocessor) {
         super(preprocessor);
 
@@ -3576,7 +3580,7 @@ class PositionTrackingPreprocessorMixin$2 extends Mixin$8 {
             }
         };
     }
-}
+};
 
 var preprocessorMixin$1 = PositionTrackingPreprocessorMixin$2;
 
@@ -3584,7 +3588,7 @@ const Mixin$7 = mixin;
 const Tokenizer$3 = tokenizer;
 const PositionTrackingPreprocessorMixin$1 = preprocessorMixin$1;
 
-class LocationInfoTokenizerMixin$2 extends Mixin$7 {
+let LocationInfoTokenizerMixin$2 = class LocationInfoTokenizerMixin extends Mixin$7 {
     constructor(tokenizer) {
         super(tokenizer);
 
@@ -3721,13 +3725,13 @@ class LocationInfoTokenizerMixin$2 extends Mixin$7 {
 
         return methods;
     }
-}
+};
 
 var tokenizerMixin$1 = LocationInfoTokenizerMixin$2;
 
 const Mixin$6 = mixin;
 
-class LocationInfoOpenElementStackMixin$1 extends Mixin$6 {
+let LocationInfoOpenElementStackMixin$1 = class LocationInfoOpenElementStackMixin extends Mixin$6 {
     constructor(stack, opts) {
         super(stack);
 
@@ -3755,7 +3759,7 @@ class LocationInfoOpenElementStackMixin$1 extends Mixin$6 {
             }
         };
     }
-}
+};
 
 var openElementStackMixin = LocationInfoOpenElementStackMixin$1;
 
@@ -3768,7 +3772,7 @@ const HTML$2 = html$4;
 //Aliases
 const $$2 = HTML$2.TAG_NAMES;
 
-class LocationInfoParserMixin$1 extends Mixin$5 {
+let LocationInfoParserMixin$1 = class LocationInfoParserMixin extends Mixin$5 {
     constructor(parser) {
         super(parser);
 
@@ -3977,13 +3981,13 @@ class LocationInfoParserMixin$1 extends Mixin$5 {
             }
         };
     }
-}
+};
 
 var parserMixin$1 = LocationInfoParserMixin$1;
 
 const Mixin$4 = mixin;
 
-class ErrorReportingMixinBase$3 extends Mixin$4 {
+let ErrorReportingMixinBase$3 = class ErrorReportingMixinBase extends Mixin$4 {
     constructor(host, opts) {
         super(host);
 
@@ -4019,7 +4023,7 @@ class ErrorReportingMixinBase$3 extends Mixin$4 {
             }
         };
     }
-}
+};
 
 var mixinBase = ErrorReportingMixinBase$3;
 
@@ -4027,7 +4031,7 @@ const ErrorReportingMixinBase$2 = mixinBase;
 const PositionTrackingPreprocessorMixin = preprocessorMixin$1;
 const Mixin$3 = mixin;
 
-class ErrorReportingPreprocessorMixin$1 extends ErrorReportingMixinBase$2 {
+let ErrorReportingPreprocessorMixin$1 = class ErrorReportingPreprocessorMixin extends ErrorReportingMixinBase$2 {
     constructor(preprocessor, opts) {
         super(preprocessor, opts);
 
@@ -4042,7 +4046,7 @@ class ErrorReportingPreprocessorMixin$1 extends ErrorReportingMixinBase$2 {
             super._reportError(code);
         }
     }
-}
+};
 
 var preprocessorMixin = ErrorReportingPreprocessorMixin$1;
 
@@ -4050,7 +4054,7 @@ const ErrorReportingMixinBase$1 = mixinBase;
 const ErrorReportingPreprocessorMixin = preprocessorMixin;
 const Mixin$2 = mixin;
 
-class ErrorReportingTokenizerMixin$1 extends ErrorReportingMixinBase$1 {
+let ErrorReportingTokenizerMixin$1 = class ErrorReportingTokenizerMixin extends ErrorReportingMixinBase$1 {
     constructor(tokenizer, opts) {
         super(tokenizer, opts);
 
@@ -4058,7 +4062,7 @@ class ErrorReportingTokenizerMixin$1 extends ErrorReportingMixinBase$1 {
 
         this.posTracker = preprocessorMixin.posTracker;
     }
-}
+};
 
 var tokenizerMixin = ErrorReportingTokenizerMixin$1;
 
@@ -4067,7 +4071,7 @@ const ErrorReportingTokenizerMixin = tokenizerMixin;
 const LocationInfoTokenizerMixin = tokenizerMixin$1;
 const Mixin$1 = mixin;
 
-class ErrorReportingParserMixin$1 extends ErrorReportingMixinBase {
+let ErrorReportingParserMixin$1 = class ErrorReportingParserMixin extends ErrorReportingMixinBase {
     constructor(parser, opts) {
         super(parser, opts);
 
@@ -4109,7 +4113,7 @@ class ErrorReportingParserMixin$1 extends ErrorReportingMixinBase {
             }
         };
     }
-}
+};
 
 var parserMixin = ErrorReportingParserMixin$1;
 
@@ -7731,7 +7735,7 @@ function endTagInForeignContent(p, token) {
     }
 }
 
-var Parser5 = parser;
+var Parser5 = /*@__PURE__*/getDefaultExportFromCjs(parser);
 
 /**
  * @typedef {import('./info.js').Info} Info
@@ -7767,6 +7771,7 @@ Schema.prototype.space = null;
  * @typedef {import('./schema.js').Normal} Normal
  */
 
+
 /**
  * @param {Schema[]} definitions
  * @param {string} [space]
@@ -7836,14 +7841,14 @@ function increment() {
 }
 
 var types = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    boolean: boolean,
-    booleanish: booleanish,
-    overloadedBoolean: overloadedBoolean,
-    number: number,
-    spaceSeparated: spaceSeparated,
-    commaSeparated: commaSeparated,
-    commaOrSpaceSeparated: commaOrSpaceSeparated
+	__proto__: null,
+	boolean: boolean,
+	booleanish: booleanish,
+	commaOrSpaceSeparated: commaOrSpaceSeparated,
+	commaSeparated: commaSeparated,
+	number: number,
+	overloadedBoolean: overloadedBoolean,
+	spaceSeparated: spaceSeparated
 });
 
 /** @type {Array<keyof types>} */
@@ -7902,6 +7907,7 @@ function mark(values, key, value) {
  * @property {Array<string>} [mustUseProperty]
  */
 
+
 const own$6 = {}.hasOwnProperty;
 
 /**
@@ -8078,7 +8084,7 @@ const html$3 = create({
     autoFocus: boolean,
     autoPlay: boolean,
     blocking: spaceSeparated,
-    capture: boolean,
+    capture: null,
     charSet: null,
     checked: boolean,
     cite: null,
@@ -8263,6 +8269,7 @@ const html$3 = create({
     scoped: boolean,
     seamless: boolean,
     selected: boolean,
+    shadowRootClonable: boolean,
     shadowRootDelegatesFocus: boolean,
     shadowRootMode: null,
     shape: null,
@@ -8288,6 +8295,7 @@ const html$3 = create({
     value: booleanish,
     width: number,
     wrap: null,
+    writingSuggestions: null,
 
     // Legacy.
     // See: https://html.spec.whatwg.org/#other-elements,-attributes-and-apis
@@ -8921,6 +8929,7 @@ const svg$1 = create({
  * @typedef {import('./util/schema.js').Schema} Schema
  */
 
+
 const valid = /^data[-\w.:]+$/i;
 const dash = /-[a-z]/g;
 const cap = /[A-Z]/g;
@@ -8986,6 +8995,7 @@ function camelcase$1($0) {
  * @typedef {import('./lib/util/info.js').Info} Info
  * @typedef {import('./lib/util/schema.js').Schema} Schema
  */
+
 const html$2 = merge([xml, xlink, xmlns, aria, html$3], 'html');
 const svg = merge([xml, xlink, xmlns, aria, svg$1], 'svg');
 
@@ -9167,6 +9177,7 @@ function stringify(values, options) {
  * @typedef {import('property-information').Schema} Schema
  */
 
+
 const buttonTypes = new Set(['menu', 'submit', 'reset', 'button']);
 
 const own$5 = {}.hasOwnProperty;
@@ -9448,6 +9459,7 @@ function createAdjustMap(values) {
  * @typedef {import('./jsx-classic.js').ElementChildrenAttribute} h.JSX.ElementChildrenAttribute
  */
 
+
 const h = core$1(html$2, 'div');
 
 const svgCaseSensitiveTagNames = [
@@ -9506,6 +9518,7 @@ const svgCaseSensitiveTagNames = [
  * @typedef {import('./jsx-classic.js').ElementChildrenAttribute} s.JSX.ElementChildrenAttribute
  */
 
+
 const s = core$1(svg, 'g', svgCaseSensitiveTagNames);
 
 /**
@@ -9650,6 +9663,7 @@ const webNamespaces = {
  * @typedef {import('parse5').Token.Location} P5Location
  */
 
+
 const own$4 = {}.hasOwnProperty;
 /** @type {unknown} */
 // type-coverage:ignore-next-line
@@ -10281,6 +10295,7 @@ const errors = {
  * @typedef {FromParse5Options & ParseFields & ErrorFields} Options
  */
 
+
 const base$1 = 'https://html.spec.whatwg.org/multipage/parsing.html#parse-error-';
 
 const fatalities = {2: true, 1: false, 0: null};
@@ -10526,7 +10541,7 @@ function zwitch(key, options) {
 
 /**
  * @typedef CoreOptions
- * @property {Array<string>} [subset=[]]
+ * @property {ReadonlyArray<string>} [subset=[]]
  *   Whether to only escape the given subset of characters.
  * @property {boolean} [escapeOnly=false]
  *   Whether to only escape possibly dangerous characters.
@@ -10539,6 +10554,16 @@ function zwitch(key, options) {
  * @typedef {CoreOptions & FormatOptions & import('./util/format-smart.js').FormatSmartOptions} CoreWithFormatOptions
  */
 
+const defaultSubsetRegex = /["&'<>`]/g;
+const surrogatePairsRegex = /[\uD800-\uDBFF][\uDC00-\uDFFF]/g;
+const controlCharactersRegex =
+  // eslint-disable-next-line no-control-regex, unicorn/no-hex-escape
+  /[\x01-\t\v\f\x0E-\x1F\x7F\x81\x8D\x8F\x90\x9D\xA0-\uFFFF]/g;
+const regexEscapeRegex = /[|\\{}()[\]^$+*?.]/g;
+
+/** @type {WeakMap<ReadonlyArray<string>, RegExp>} */
+const subsetToRegexCache = new WeakMap();
+
 /**
  * Encode certain characters in `value`.
  *
@@ -10548,7 +10573,9 @@ function zwitch(key, options) {
  */
 function core(value, options) {
   value = value.replace(
-    options.subset ? charactersToExpression(options.subset) : /["&'<>`]/g,
+    options.subset
+      ? charactersToExpressionCached(options.subset)
+      : defaultSubsetRegex,
     basic
   );
 
@@ -10559,14 +10586,10 @@ function core(value, options) {
   return (
     value
       // Surrogate pairs.
-      .replace(/[\uD800-\uDBFF][\uDC00-\uDFFF]/g, surrogate)
+      .replace(surrogatePairsRegex, surrogate)
       // BMP control characters (C0 except for LF, CR, SP; DEL; and some more
       // non-ASCII ones).
-      .replace(
-        // eslint-disable-next-line no-control-regex, unicorn/no-hex-escape
-        /[\x01-\t\v\f\x0E-\x1F\x7F\x81\x8D\x8F\x90\x9D\xA0-\uFFFF]/g,
-        basic
-      )
+      .replace(controlCharactersRegex, basic)
   )
 
   /**
@@ -10600,7 +10623,26 @@ function core(value, options) {
 }
 
 /**
- * @param {Array<string>} subset
+ * A wrapper function that caches the result of `charactersToExpression` with a WeakMap.
+ * This can improve performance when tooling calls `charactersToExpression` repeatedly
+ * with the same subset.
+ *
+ * @param {ReadonlyArray<string>} subset
+ * @returns {RegExp}
+ */
+function charactersToExpressionCached(subset) {
+  let cached = subsetToRegexCache.get(subset);
+
+  if (!cached) {
+    cached = charactersToExpression(subset);
+    subsetToRegexCache.set(subset, cached);
+  }
+
+  return cached
+}
+
+/**
+ * @param {ReadonlyArray<string>} subset
  * @returns {RegExp}
  */
 function charactersToExpression(subset) {
@@ -10609,12 +10651,14 @@ function charactersToExpression(subset) {
   let index = -1;
 
   while (++index < subset.length) {
-    groups.push(subset[index].replace(/[|\\{}()[\]^$+*?.]/g, '\\$&'));
+    groups.push(subset[index].replace(regexEscapeRegex, '\\$&'));
   }
 
   return new RegExp('(?:' + groups.join('|') + ')', 'g')
 }
 
+const hexadecimalRegex = /[\dA-Fa-f]/;
+
 /**
  * Configurable ways to encode characters as hexadecimal references.
  *
@@ -10625,11 +10669,13 @@ function charactersToExpression(subset) {
  */
 function toHexadecimal(code, next, omit) {
   const value = '&#x' + code.toString(16).toUpperCase();
-  return omit && next && !/[\dA-Fa-f]/.test(String.fromCharCode(next))
+  return omit && next && !hexadecimalRegex.test(String.fromCharCode(next))
     ? value
     : value + ';'
 }
 
+const decimalRegex = /\d/;
+
 /**
  * Configurable ways to encode characters as decimal references.
  *
@@ -10640,7 +10686,7 @@ function toHexadecimal(code, next, omit) {
  */
 function toDecimal(code, next, omit) {
   const value = '&#' + String(code);
-  return omit && next && !/\d/.test(String.fromCharCode(next))
+  return omit && next && !decimalRegex.test(String.fromCharCode(next))
     ? value
     : value + ';'
 }
@@ -11054,6 +11100,8 @@ for (key in characterEntitiesHtml4) {
   }
 }
 
+const notAlphanumericRegex = /[^\dA-Za-z]/;
+
 /**
  * Configurable ways to encode characters as named references.
  *
@@ -11077,7 +11125,7 @@ function toNamed(code, next, omit, attribute) {
       (!attribute ||
         (next &&
           next !== 61 /* `=` */ &&
-          /[^\da-z]/i.test(String.fromCharCode(next))))
+          notAlphanumericRegex.test(String.fromCharCode(next))))
     ) {
       return value
     }
@@ -11105,6 +11153,7 @@ function toNamed(code, next, omit, attribute) {
  *   `omitOptionalSemicolons: true`.
  */
 
+
 /**
  * Configurable ways to encode a character yielding pretty or small results.
  *
@@ -11159,6 +11208,7 @@ function formatSmart(code, next, options) {
  * @typedef {import('./core.js').CoreOptions} LightOptions
  */
 
+
 /**
  * Encode special characters in `value`.
  *
@@ -11179,6 +11229,7 @@ function stringifyEntities(value, options) {
  * @typedef {import('../types.js').State} State
  */
 
+
 /**
  * Serialize a comment.
  *
@@ -11305,6 +11356,7 @@ function whitespace(thing) {
  * @typedef {import('../../types.js').Content} Content
  */
 
+
 const siblingAfter = siblings(1);
 const siblingBefore = siblings(-1);
 
@@ -11376,6 +11428,7 @@ function omission(handlers) {
  * @typedef {import('../types.js').Parent} Parent
  */
 
+
 const closing = omission({
   html: html$1,
   head: headOrColgroupOrCaption,
@@ -11758,6 +11811,7 @@ function cells(_, index, parent) {
  * @typedef {import('../types.js').Content} Content
  */
 
+
 const opening = omission({
   html,
   head,
@@ -11904,6 +11958,7 @@ function tbody(node, index, parent) {
  * @typedef {import('../types.js').PropertyValue} PropertyValue
  */
 
+
 /**
  * Maps of subsets.
  *
@@ -12164,6 +12219,7 @@ function serializeAttribute(state, key, value) {
  * @typedef {import('../types.js').Text} Text
  */
 
+
 /**
  * Serialize a text node.
  *
@@ -12198,6 +12254,7 @@ function text(node, _, parent, state) {
  * @typedef {import('../types.js').Raw} Raw
  */
 
+
 /**
  * Serialize a raw node.
  *
@@ -12248,6 +12305,7 @@ function root(node, _1, _2, state) {
  * @typedef {import('../types.js').Parent} Parent
  */
 
+
 /**
  * @type {(node: Node, index: number | undefined, parent: Parent | undefined, state: State) => string}
  */
@@ -12290,6 +12348,7 @@ function unknown(node) {
  * @typedef {import('./types.js').State} State
  */
 
+
 /**
  * Serialize hast as HTML.
  *
@@ -12392,6 +12451,7 @@ function all(parent) {
  * @typedef {import('hast-util-to-html').Options} Options
  */
 
+
 /**
  * @this {import('unified').Processor}
  * @type {import('unified').Plugin<[Options?]|Array<void>, Node, string>}
@@ -12435,6 +12495,8 @@ var isBuffer = function isBuffer (obj) {
     typeof obj.constructor.isBuffer === 'function' && obj.constructor.isBuffer(obj)
 };
 
+var isBuffer$1 = /*@__PURE__*/getDefaultExportFromCjs(isBuffer);
+
 var hasOwn = Object.prototype.hasOwnProperty;
 var toStr = Object.prototype.toString;
 var defineProperty = Object.defineProperty;
@@ -12551,6 +12613,8 @@ var extend = function extend() {
 	return target;
 };
 
+var extend$1 = /*@__PURE__*/getDefaultExportFromCjs(extend);
+
 function isPlainObject(value) {
 	if (typeof value !== 'object' || value === null) {
 		return false;
@@ -12560,22 +12624,43 @@ function isPlainObject(value) {
 	return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);
 }
 
+// To do: remove `void`s
+// To do: remove `null` from output of our APIs, allow it as user APIs.
+
 /**
- * @typedef {(error?: Error|null|undefined, ...output: Array<any>) => void} Callback
+ * @typedef {(error?: Error | null | undefined, ...output: Array<any>) => void} Callback
+ *   Callback.
+ *
  * @typedef {(...input: Array<any>) => any} Middleware
+ *   Ware.
+ *
+ * @typedef Pipeline
+ *   Pipeline.
+ * @property {Run} run
+ *   Run the pipeline.
+ * @property {Use} use
+ *   Add middleware.
  *
  * @typedef {(...input: Array<any>) => void} Run
  *   Call all middleware.
+ *
+ *   Calls `done` on completion with either an error or the output of the
+ *   last middleware.
+ *
+ *   > 👉 **Note**: as the length of input defines whether async functions get a
+ *   > `next` function,
+ *   > it’s recommended to keep `input` at one value normally.
+
+ *
  * @typedef {(fn: Middleware) => Pipeline} Use
- *   Add `fn` (middleware) to the list.
- * @typedef {{run: Run, use: Use}} Pipeline
- *   Middleware.
+ *   Add middleware.
  */
 
 /**
  * Create new middleware.
  *
  * @returns {Pipeline}
+ *   Pipeline.
  */
 function trough() {
   /** @type {Array<Middleware>} */
@@ -12600,7 +12685,7 @@ function trough() {
     /**
      * Run the next `fn`, or we’re done.
      *
-     * @param {Error|null|undefined} error
+     * @param {Error | null | undefined} error
      * @param {Array<any>} output
      */
     function next(error, ...output) {
@@ -12645,12 +12730,36 @@ function trough() {
 }
 
 /**
- * Wrap `middleware`.
- * Can be sync or async; return a promise, receive a callback, or return new
- * values and errors.
+ * Wrap `middleware` into a uniform interface.
+ *
+ * You can pass all input to the resulting function.
+ * `callback` is then called with the output of `middleware`.
+ *
+ * If `middleware` accepts more arguments than the later given in input,
+ * an extra `done` function is passed to it after that input,
+ * which must be called by `middleware`.
+ *
+ * The first value in `input` is the main input value.
+ * All other input values are the rest input values.
+ * The values given to `callback` are the input values,
+ * merged with every non-nullish output value.
+ *
+ * * if `middleware` throws an error,
+ *   returns a promise that is rejected,
+ *   or calls the given `done` function with an error,
+ *   `callback` is called with that error
+ * * if `middleware` returns a value or returns a promise that is resolved,
+ *   that value is the main output value
+ * * if `middleware` calls `done`,
+ *   all non-nullish values except for the first one (the error) overwrite the
+ *   output values
  *
  * @param {Middleware} middleware
+ *   Function to wrap.
  * @param {Callback} callback
+ *   Callback called with the output of `middleware`.
+ * @returns {Run}
+ *   Wrapped middleware.
  */
 function wrap(middleware, callback) {
   /** @type {boolean} */
@@ -12690,7 +12799,7 @@ function wrap(middleware, callback) {
     }
 
     if (!fnExpectsCallback) {
-      if (result instanceof Promise) {
+      if (result && result.then && typeof result.then === 'function') {
         result.then(then, done);
       } else if (result instanceof Error) {
         done(result);
@@ -12702,6 +12811,7 @@ function wrap(middleware, callback) {
 
   /**
    * Call `callback`, only once.
+   *
    * @type {Callback}
    */
   function done(error, ...output) {
@@ -12813,6 +12923,7 @@ function index(value) {
  * @typedef {object & {type: string, position?: Position | undefined}} NodeLike
  */
 
+
 /**
  * Message.
  */
@@ -13077,6 +13188,7 @@ function isUrl(fileUrlOrPath) {
  * @typedef {import('../index.js').Value} Value
  */
 
+
 /**
  * Order of setting (least specific to most), we need this because otherwise
  * `{stem: 'a', path: '~/b.js'}` would throw, as a path is needed before a
@@ -13504,7 +13616,7 @@ function assertPath(path, name) {
  *   Whether `value` is a Node.js buffer.
  */
 function buffer(value) {
-  return isBuffer(value)
+  return isBuffer$1(value)
 }
 
 /**
@@ -13527,6 +13639,7 @@ function buffer(value) {
  * @property {VFile} file
  */
 
+
 // Expose a frozen processor.
 const unified = base().freeze();
 
@@ -13583,7 +13696,7 @@ function base() {
       destination.use(...attachers[index]);
     }
 
-    destination.data(extend(true, {}, namespace));
+    destination.data(extend$1(true, {}, namespace));
 
     return destination
   }
@@ -13744,7 +13857,7 @@ function base() {
 
       if (entry) {
         if (isPlainObject(entry[1]) && isPlainObject(value)) {
-          value = extend(true, entry[1], value);
+          value = extend$1(true, entry[1], value);
         }
 
         entry[1] = value;
@@ -14091,7 +14204,7 @@ function looksLikeAVFile(value) {
  * @returns {value is VFileValue}
  */
 function looksLikeAVFileValue(value) {
-  return typeof value === 'string' || isBuffer(value)
+  return typeof value === 'string' || isBuffer$1(value)
 }
 
 /**
@@ -14204,36 +14317,11 @@ const isElement$1 =
     function (node, test, index, parent, context) {
       const check = convertElement(test);
 
-      if (
-        index !== undefined &&
-        index !== null &&
-        (typeof index !== 'number' ||
-          index < 0 ||
-          index === Number.POSITIVE_INFINITY)
-      ) {
-        throw new Error('Expected positive finite index for child node')
-      }
-
-      if (
-        parent !== undefined &&
-        parent !== null &&
-        (!parent.type || !parent.children)
-      ) {
-        throw new Error('Expected parent node')
-      }
-
       // @ts-expect-error Looks like a node.
       if (!node || !node.type || typeof node.type !== 'string') {
         return false
       }
 
-      if (
-        (parent === undefined || parent === null) !==
-        (index === undefined || index === null)
-      ) {
-        throw new Error('Expected both parent and index')
-      }
-
       return check.call(context, node, index, parent)
     }
   );
@@ -14384,6 +14472,7 @@ function element(node) {
  * @typedef {import('unist').Parent} Parent
  */
 
+
 /**
  * Generate an assertion from a test.
  *
@@ -14553,6 +14642,7 @@ function color(d) {
  * @typedef {import('unist-util-is').Test} Test
  */
 
+
 /**
  * Continue traversing as normal.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/utils",
-  "version": "17.6.8",
+  "version": "17.6.9",
   "type": "module",
   "dependencies": {
     "rehype": "12.0.1",