@microsoft/api-extractor 7.29.3 → 7.30.0

package/lib/collector/CollectorEntity.d.ts

@@ -1,5 +1,4 @@
 import { AstEntity } from '../analyzer/AstEntity';
-import { AstNamespaceImport } from '../analyzer/AstNamespaceImport';
 /**
  * This is a data structure used by the Collector to track an AstEntity that may be emitted in the *.d.ts file.
  *
@@ -17,19 +16,19 @@ export declare class CollectorEntity {
     private _exportNames;
     private _exportNamesSorted;
     private _singleExportName;
+    private _localExportNamesByParent;
     private _nameForEmit;
     private _sortKey;
-    private _astNamespaceImports;
     constructor(astEntity: AstEntity);
     /**
-     * The declaration name that will be emitted in a .d.ts rollup.  For non-exported declarations,
-     * Collector._makeUniqueNames() may need to rename the declaration to avoid conflicts with other declarations
-     * in that module.
+     * The declaration name that will be emitted in the .d.ts rollup, .api.md, and .api.json files. Generated by
+     * `Collector._makeUniqueNames`. Be aware that the declaration may be renamed to avoid conflicts with (1)
+     * global names (e.g. `Promise`) and (2) if local, other local names across different files.
      */
     get nameForEmit(): string | undefined;
     set nameForEmit(value: string | undefined);
     /**
-     * If this symbol is exported from the entry point, the list of export names.
+     * The list of export names if this symbol is exported from the entry point.
      *
      * @remarks
      * Note that a given symbol may be exported more than once:
@@ -51,49 +50,92 @@ export declare class CollectorEntity {
      */
     get shouldInlineExport(): boolean;
     /**
-     * Returns true if this symbol is an export for the entry point being analyzed.
+     * Indicates that this entity is exported from its parent module (i.e. either the package entry point or
+     * a local namespace). Compare to `CollectorEntity.consumable`.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * Namespace `calculator` is neither exported nor consumable, function `add` is exported (from `calculator`)
+     * but not consumable.
      */
     get exported(): boolean;
     /**
-     * Indicates that it is possible for a consumer of the API to access this declaration, either by importing
-     * it directly, or via some other alias such as a member of a namespace.  If a collector entity is not consumable,
-     * then API Extractor will report a ExtractorMessageId.ForgottenExport warning.
+     * Indicates that it is possible for a consumer of the API to "consume" this entity, either by importing
+     * it directly or via a namespace. If an entity is not consumable, then API Extractor will report an
+     * `ae-forgotten-export` warning. Compare to `CollectorEntity.exported`.
      *
      * @remarks
-     * Generally speaking, an API item is consumable if:
+     * An API item is consumable if:
      *
-     * - The collector encounters it while crawling the entry point, and it is a root symbol
-     *   (i.e. there is a corresponding a CollectorEntity)
+     * 1. It is exported from the top-level entry point OR
+     * 2. It is exported from a consumable parent entity.
      *
-     * - AND it is exported by the entry point
-     *
-     * However a special case occurs with `AstNamespaceImport` which produces a rollup like this:
+     * For an example of #2, consider how `AstNamespaceImport` entities are processed. A generated rollup.d.ts
+     * might look like this:
      *
      * ```ts
-     * declare interface IForgottenExport { }
-     *
-     * declare function member(): IForgottenExport;
-     *
-     * declare namespace ns {
+     * declare function add(): void;
+     * declare namespace calculator {
      *   export {
-     *     member
+     *     add
      *   }
      * }
-     * export { ns }
+     * export { calculator }
      * ```
      *
-     * In this example, `IForgottenExport` is not consumable.  Whereas `member()` is consumable as `ns.member()`
-     * even though `member()` itself is not exported.
+     * In this example, `add` is exported via the consumable `calculator` namespace.
      */
     get consumable(): boolean;
     /**
-     * Associates this entity with a `AstNamespaceImport`.
+     * Whether the entity has any parent entities.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * The `CollectorEntity` for `calculator` is the parent of the `CollectorEntity` for `add`.
      */
-    addAstNamespaceImports(astNamespaceImport: AstNamespaceImport): void;
+    get hasParents(): boolean;
     /**
-     * Adds a new exportName to the exportNames set.
+     * Adds a new export name to the entity.
      */
     addExportName(exportName: string): void;
+    /**
+     * Adds a new local export name to the entity.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * `add` is the local export name for the `CollectorEntity` for `add`.
+     */
+    addLocalExportName(localExportName: string, parent: CollectorEntity): void;
     /**
      * A sorting key used by DtsRollupGenerator._makeUniqueNames()
      */

package/lib/collector/CollectorEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectorEntity.d.ts","sourceRoot":"","sources":["../../src/collector/CollectorEntity.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IAErC,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,OAAO,CAAC,YAAY,CAAiC;IAErD,OAAO,CAAC,QAAQ,CAAiC;IAEjD,OAAO,CAAC,oBAAoB,CAAsC;gBAE/C,SAAS,EAAE,SAAS;IAIvC;;;;OAIG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAG/C;IAED;;;;;;;;;;OAUG;IACH,IAAW,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,CAM5C;IAED;;;OAGG;IACH,IAAW,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEhD;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,OAAO,CAYvC;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACI,sBAAsB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI;IAI3E;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAa9C;;OAEG;IACI,UAAU,IAAI,MAAM;CAM5B"}
+{"version":3,"file":"CollectorEntity.d.ts","sourceRoot":"","sources":["../../src/collector/CollectorEntity.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IAErC,OAAO,CAAC,YAAY,CAA0B;IAC9C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,yBAAyB,CAAgD;IAEjF,OAAO,CAAC,YAAY,CAAiC;IAErD,OAAO,CAAC,QAAQ,CAAiC;gBAE9B,SAAS,EAAE,SAAS;IAIvC;;;;OAIG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED,IAAW,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAG/C;IAED;;;;;;;;;;OAUG;IACH,IAAW,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,CAM5C;IAED;;;OAGG;IACH,IAAW,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEhD;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,OAAO,CAYvC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAW,QAAQ,IAAI,OAAO,CAY7B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAW,UAAU,IAAI,OAAO,CAY/B;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAa9C;;;;;;;;;;;;;;;;OAgBG;IACI,kBAAkB,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,IAAI;IAOjF;;OAEG;IACI,UAAU,IAAI,MAAM;CAM5B"}

package/lib/collector/CollectorEntity.js

@@ -44,15 +44,15 @@ class CollectorEntity {
         this._exportNames = new Set();
         this._exportNamesSorted = false;
         this._singleExportName = undefined;
+        this._localExportNamesByParent = new Map();
         this._nameForEmit = undefined;
         this._sortKey = undefined;
-        this._astNamespaceImports = new Set();
         this.astEntity = astEntity;
     }
     /**
-     * The declaration name that will be emitted in a .d.ts rollup.  For non-exported declarations,
-     * Collector._makeUniqueNames() may need to rename the declaration to avoid conflicts with other declarations
-     * in that module.
+     * The declaration name that will be emitted in the .d.ts rollup, .api.md, and .api.json files. Generated by
+     * `Collector._makeUniqueNames`. Be aware that the declaration may be renamed to avoid conflicts with (1)
+     * global names (e.g. `Promise`) and (2) if local, other local names across different files.
      */
     get nameForEmit() {
         return this._nameForEmit;
@@ -62,7 +62,7 @@ class CollectorEntity {
         this._sortKey = undefined; // invalidate the cached value
     }
     /**
-     * If this symbol is exported from the entry point, the list of export names.
+     * The list of export names if this symbol is exported from the entry point.
      *
      * @remarks
      * Note that a given symbol may be exported more than once:
@@ -104,53 +104,96 @@ class CollectorEntity {
         return false;
     }
     /**
-     * Returns true if this symbol is an export for the entry point being analyzed.
+     * Indicates that this entity is exported from its parent module (i.e. either the package entry point or
+     * a local namespace). Compare to `CollectorEntity.consumable`.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * Namespace `calculator` is neither exported nor consumable, function `add` is exported (from `calculator`)
+     * but not consumable.
      */
     get exported() {
-        return this.exportNames.size > 0;
+        // Exported from top-level?
+        if (this.exportNames.size > 0)
+            return true;
+        // Exported from parent?
+        for (const localExportNames of this._localExportNamesByParent.values()) {
+            if (localExportNames.size > 0) {
+                return true;
+            }
+        }
+        return false;
     }
     /**
-     * Indicates that it is possible for a consumer of the API to access this declaration, either by importing
-     * it directly, or via some other alias such as a member of a namespace.  If a collector entity is not consumable,
-     * then API Extractor will report a ExtractorMessageId.ForgottenExport warning.
+     * Indicates that it is possible for a consumer of the API to "consume" this entity, either by importing
+     * it directly or via a namespace. If an entity is not consumable, then API Extractor will report an
+     * `ae-forgotten-export` warning. Compare to `CollectorEntity.exported`.
      *
      * @remarks
-     * Generally speaking, an API item is consumable if:
-     *
-     * - The collector encounters it while crawling the entry point, and it is a root symbol
-     *   (i.e. there is a corresponding a CollectorEntity)
+     * An API item is consumable if:
      *
-     * - AND it is exported by the entry point
+     * 1. It is exported from the top-level entry point OR
+     * 2. It is exported from a consumable parent entity.
      *
-     * However a special case occurs with `AstNamespaceImport` which produces a rollup like this:
+     * For an example of #2, consider how `AstNamespaceImport` entities are processed. A generated rollup.d.ts
+     * might look like this:
      *
      * ```ts
-     * declare interface IForgottenExport { }
-     *
-     * declare function member(): IForgottenExport;
-     *
-     * declare namespace ns {
+     * declare function add(): void;
+     * declare namespace calculator {
      *   export {
-     *     member
+     *     add
      *   }
      * }
-     * export { ns }
+     * export { calculator }
      * ```
      *
-     * In this example, `IForgottenExport` is not consumable.  Whereas `member()` is consumable as `ns.member()`
-     * even though `member()` itself is not exported.
+     * In this example, `add` is exported via the consumable `calculator` namespace.
      */
     get consumable() {
-        return this.exported || this._astNamespaceImports.size > 0;
+        // Exported from top-level?
+        if (this.exportNames.size > 0)
+            return true;
+        // Exported from consumable parent?
+        for (const [parent, localExportNames] of this._localExportNamesByParent) {
+            if (localExportNames.size > 0 && parent.consumable) {
+                return true;
+            }
+        }
+        return false;
     }
     /**
-     * Associates this entity with a `AstNamespaceImport`.
+     * Whether the entity has any parent entities.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * The `CollectorEntity` for `calculator` is the parent of the `CollectorEntity` for `add`.
      */
-    addAstNamespaceImports(astNamespaceImport) {
-        this._astNamespaceImports.add(astNamespaceImport);
+    get hasParents() {
+        return this._localExportNamesByParent.size > 0;
     }
     /**
-     * Adds a new exportName to the exportNames set.
+     * Adds a new export name to the entity.
      */
     addExportName(exportName) {
         if (!this._exportNames.has(exportName)) {
@@ -164,6 +207,28 @@ class CollectorEntity {
             }
         }
     }
+    /**
+     * Adds a new local export name to the entity.
+     *
+     * @remarks
+     * In the example below:
+     *
+     * ```ts
+     * declare function add(): void;
+     * declare namespace calculator {
+     *  export {
+     *    add
+     *  }
+     * }
+     * ```
+     *
+     * `add` is the local export name for the `CollectorEntity` for `add`.
+     */
+    addLocalExportName(localExportName, parent) {
+        const localExportNames = this._localExportNamesByParent.get(parent) || new Set();
+        localExportNames.add(localExportName);
+        this._localExportNamesByParent.set(parent, localExportNames);
+    }
     /**
      * A sorting key used by DtsRollupGenerator._makeUniqueNames()
      */

package/lib/collector/CollectorEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"CollectorEntity.js","sourceRoot":"","sources":["../../src/collector/CollectorEntity.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,+CAAiC;AAEjC,qDAAkD;AAClD,2CAAwC;AACxC,oEAAoD;AAIpD;;;;;;;;GAQG;AACH,MAAa,eAAe;IAgB1B,YAAmB,SAAoB;QAV/B,iBAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;QACtC,uBAAkB,GAAY,KAAK,CAAC;QACpC,sBAAiB,GAAuB,SAAS,CAAC;QAElD,iBAAY,GAAuB,SAAS,CAAC;QAE7C,aAAQ,GAAuB,SAAS,CAAC;QAEzC,yBAAoB,GAA4B,IAAI,GAAG,EAAE,CAAC;QAGhE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,WAAW,CAAC,KAAyB;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC,8BAA8B;IAC3D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAW,WAAW;QACpB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC5B,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;SAChC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,kBAAkB;QAC3B,+BAA+B;QAC/B,IAAI,IAAI,CAAC,SAAS,YAAY,qBAAS,EAAE;YACvC,4DAA4D;YAC5D,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBACpG,gFAAgF;gBAChF,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,iBAAiB,EAAE;oBACnF,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,oBAAoB,CAAC,IAAI,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,kBAAsC;QAClE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,UAAkB;QACrC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YACtC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;YAChC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAElC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,EAAE;gBAChC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;aACrC;iBAAM;gBACL,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;SACF;IACH,CAAC;IAED;;OAEG;IACI,UAAU;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,qBAAS,CAAC,4BAA4B,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACtG;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AAzJD,0CAyJC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as ts from 'typescript';\n\nimport { AstSymbol } from '../analyzer/AstSymbol';\nimport { Collector } from './Collector';\nimport { Sort } from '@rushstack/node-core-library';\nimport { AstEntity } from '../analyzer/AstEntity';\nimport { AstNamespaceImport } from '../analyzer/AstNamespaceImport';\n\n/**\n * This is a data structure used by the Collector to track an AstEntity that may be emitted in the *.d.ts file.\n *\n * @remarks\n * The additional contextual state beyond AstSymbol is:\n * - Whether it's an export of this entry point or not\n * - The nameForEmit, which may get renamed by DtsRollupGenerator._makeUniqueNames()\n * - The export name (or names, if the same symbol is exported multiple times)\n */\nexport class CollectorEntity {\n  /**\n   * The AstEntity that this entry represents.\n   */\n  public readonly astEntity: AstEntity;\n\n  private _exportNames: Set<string> = new Set();\n  private _exportNamesSorted: boolean = false;\n  private _singleExportName: string | undefined = undefined;\n\n  private _nameForEmit: string | undefined = undefined;\n\n  private _sortKey: string | undefined = undefined;\n\n  private _astNamespaceImports: Set<AstNamespaceImport> = new Set();\n\n  public constructor(astEntity: AstEntity) {\n    this.astEntity = astEntity;\n  }\n\n  /**\n   * The declaration name that will be emitted in a .d.ts rollup.  For non-exported declarations,\n   * Collector._makeUniqueNames() may need to rename the declaration to avoid conflicts with other declarations\n   * in that module.\n   */\n  public get nameForEmit(): string | undefined {\n    return this._nameForEmit;\n  }\n\n  public set nameForEmit(value: string | undefined) {\n    this._nameForEmit = value;\n    this._sortKey = undefined; // invalidate the cached value\n  }\n\n  /**\n   * If this symbol is exported from the entry point, the list of export names.\n   *\n   * @remarks\n   * Note that a given symbol may be exported more than once:\n   * ```\n   * class X { }\n   * export { X }\n   * export { X as Y }\n   * ```\n   */\n  public get exportNames(): ReadonlySet<string> {\n    if (!this._exportNamesSorted) {\n      Sort.sortSet(this._exportNames);\n      this._exportNamesSorted = true;\n    }\n    return this._exportNames;\n  }\n\n  /**\n   * If exportNames contains only one string, then singleExportName is that string.\n   * In all other cases, it is undefined.\n   */\n  public get singleExportName(): string | undefined {\n    return this._singleExportName;\n  }\n\n  /**\n   * This is true if exportNames contains only one string, and the declaration can be exported using the inline syntax\n   * such as \"export class X { }\" instead of \"export { X }\".\n   */\n  public get shouldInlineExport(): boolean {\n    // We don't inline an AstImport\n    if (this.astEntity instanceof AstSymbol) {\n      // We don't inline a symbol with more than one exported name\n      if (this._singleExportName !== undefined && this._singleExportName !== ts.InternalSymbolName.Default) {\n        // We can't inline a symbol whose emitted name is different from the export name\n        if (this._nameForEmit === undefined || this._nameForEmit === this._singleExportName) {\n          return true;\n        }\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Returns true if this symbol is an export for the entry point being analyzed.\n   */\n  public get exported(): boolean {\n    return this.exportNames.size > 0;\n  }\n\n  /**\n   * Indicates that it is possible for a consumer of the API to access this declaration, either by importing\n   * it directly, or via some other alias such as a member of a namespace.  If a collector entity is not consumable,\n   * then API Extractor will report a ExtractorMessageId.ForgottenExport warning.\n   *\n   * @remarks\n   * Generally speaking, an API item is consumable if:\n   *\n   * - The collector encounters it while crawling the entry point, and it is a root symbol\n   *   (i.e. there is a corresponding a CollectorEntity)\n   *\n   * - AND it is exported by the entry point\n   *\n   * However a special case occurs with `AstNamespaceImport` which produces a rollup like this:\n   *\n   * ```ts\n   * declare interface IForgottenExport { }\n   *\n   * declare function member(): IForgottenExport;\n   *\n   * declare namespace ns {\n   *   export {\n   *     member\n   *   }\n   * }\n   * export { ns }\n   * ```\n   *\n   * In this example, `IForgottenExport` is not consumable.  Whereas `member()` is consumable as `ns.member()`\n   * even though `member()` itself is not exported.\n   */\n  public get consumable(): boolean {\n    return this.exported || this._astNamespaceImports.size > 0;\n  }\n\n  /**\n   * Associates this entity with a `AstNamespaceImport`.\n   */\n  public addAstNamespaceImports(astNamespaceImport: AstNamespaceImport): void {\n    this._astNamespaceImports.add(astNamespaceImport);\n  }\n\n  /**\n   * Adds a new exportName to the exportNames set.\n   */\n  public addExportName(exportName: string): void {\n    if (!this._exportNames.has(exportName)) {\n      this._exportNamesSorted = false;\n      this._exportNames.add(exportName);\n\n      if (this._exportNames.size === 1) {\n        this._singleExportName = exportName;\n      } else {\n        this._singleExportName = undefined;\n      }\n    }\n  }\n\n  /**\n   * A sorting key used by DtsRollupGenerator._makeUniqueNames()\n   */\n  public getSortKey(): string {\n    if (!this._sortKey) {\n      this._sortKey = Collector.getSortKeyIgnoringUnderscore(this.nameForEmit || this.astEntity.localName);\n    }\n    return this._sortKey;\n  }\n}\n"]}
+{"version":3,"file":"CollectorEntity.js","sourceRoot":"","sources":["../../src/collector/CollectorEntity.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,+CAAiC;AAEjC,qDAAkD;AAClD,2CAAwC;AACxC,oEAAoD;AAGpD;;;;;;;;GAQG;AACH,MAAa,eAAe;IAe1B,YAAmB,SAAoB;QAT/B,iBAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;QACtC,uBAAkB,GAAY,KAAK,CAAC;QACpC,sBAAiB,GAAuB,SAAS,CAAC;QAClD,8BAAyB,GAAsC,IAAI,GAAG,EAAE,CAAC;QAEzE,iBAAY,GAAuB,SAAS,CAAC;QAE7C,aAAQ,GAAuB,SAAS,CAAC;QAG/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,WAAW,CAAC,KAAyB;QAC9C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC,8BAA8B;IAC3D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAW,WAAW;QACpB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC5B,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;SAChC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,kBAAkB;QAC3B,+BAA+B;QAC/B,IAAI,IAAI,CAAC,SAAS,YAAY,qBAAS,EAAE;YACvC,4DAA4D;YAC5D,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBACpG,gFAAgF;gBAChF,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,iBAAiB,EAAE;oBACnF,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAW,QAAQ;QACjB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QAE3C,wBAAwB;QACxB,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,EAAE;YACtE,IAAI,gBAAgB,CAAC,IAAI,GAAG,CAAC,EAAE;gBAC7B,OAAO,IAAI,CAAC;aACb;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAW,UAAU;QACnB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QAE3C,mCAAmC;QACnC,KAAK,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,IAAI,IAAI,CAAC,yBAAyB,EAAE;YACvE,IAAI,gBAAgB,CAAC,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,UAAU,EAAE;gBAClD,OAAO,IAAI,CAAC;aACb;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,yBAAyB,CAAC,IAAI,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,UAAkB;QACrC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YACtC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;YAChC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAElC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,EAAE;gBAChC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;aACrC;iBAAM;gBACL,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;SACF;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,kBAAkB,CAAC,eAAuB,EAAE,MAAuB;QACxE,MAAM,gBAAgB,GAAgB,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QAC9F,gBAAgB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEtC,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,UAAU;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,qBAAS,CAAC,4BAA4B,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACtG;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AA7ND,0CA6NC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as ts from 'typescript';\n\nimport { AstSymbol } from '../analyzer/AstSymbol';\nimport { Collector } from './Collector';\nimport { Sort } from '@rushstack/node-core-library';\nimport { AstEntity } from '../analyzer/AstEntity';\n\n/**\n * This is a data structure used by the Collector to track an AstEntity that may be emitted in the *.d.ts file.\n *\n * @remarks\n * The additional contextual state beyond AstSymbol is:\n * - Whether it's an export of this entry point or not\n * - The nameForEmit, which may get renamed by DtsRollupGenerator._makeUniqueNames()\n * - The export name (or names, if the same symbol is exported multiple times)\n */\nexport class CollectorEntity {\n  /**\n   * The AstEntity that this entry represents.\n   */\n  public readonly astEntity: AstEntity;\n\n  private _exportNames: Set<string> = new Set();\n  private _exportNamesSorted: boolean = false;\n  private _singleExportName: string | undefined = undefined;\n  private _localExportNamesByParent: Map<CollectorEntity, Set<string>> = new Map();\n\n  private _nameForEmit: string | undefined = undefined;\n\n  private _sortKey: string | undefined = undefined;\n\n  public constructor(astEntity: AstEntity) {\n    this.astEntity = astEntity;\n  }\n\n  /**\n   * The declaration name that will be emitted in the .d.ts rollup, .api.md, and .api.json files. Generated by\n   * `Collector._makeUniqueNames`. Be aware that the declaration may be renamed to avoid conflicts with (1)\n   * global names (e.g. `Promise`) and (2) if local, other local names across different files.\n   */\n  public get nameForEmit(): string | undefined {\n    return this._nameForEmit;\n  }\n\n  public set nameForEmit(value: string | undefined) {\n    this._nameForEmit = value;\n    this._sortKey = undefined; // invalidate the cached value\n  }\n\n  /**\n   * The list of export names if this symbol is exported from the entry point.\n   *\n   * @remarks\n   * Note that a given symbol may be exported more than once:\n   * ```\n   * class X { }\n   * export { X }\n   * export { X as Y }\n   * ```\n   */\n  public get exportNames(): ReadonlySet<string> {\n    if (!this._exportNamesSorted) {\n      Sort.sortSet(this._exportNames);\n      this._exportNamesSorted = true;\n    }\n    return this._exportNames;\n  }\n\n  /**\n   * If exportNames contains only one string, then singleExportName is that string.\n   * In all other cases, it is undefined.\n   */\n  public get singleExportName(): string | undefined {\n    return this._singleExportName;\n  }\n\n  /**\n   * This is true if exportNames contains only one string, and the declaration can be exported using the inline syntax\n   * such as \"export class X { }\" instead of \"export { X }\".\n   */\n  public get shouldInlineExport(): boolean {\n    // We don't inline an AstImport\n    if (this.astEntity instanceof AstSymbol) {\n      // We don't inline a symbol with more than one exported name\n      if (this._singleExportName !== undefined && this._singleExportName !== ts.InternalSymbolName.Default) {\n        // We can't inline a symbol whose emitted name is different from the export name\n        if (this._nameForEmit === undefined || this._nameForEmit === this._singleExportName) {\n          return true;\n        }\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Indicates that this entity is exported from its parent module (i.e. either the package entry point or\n   * a local namespace). Compare to `CollectorEntity.consumable`.\n   *\n   * @remarks\n   * In the example below:\n   *\n   * ```ts\n   * declare function add(): void;\n   * declare namespace calculator {\n   *  export {\n   *    add\n   *  }\n   * }\n   * ```\n   *\n   * Namespace `calculator` is neither exported nor consumable, function `add` is exported (from `calculator`)\n   * but not consumable.\n   */\n  public get exported(): boolean {\n    // Exported from top-level?\n    if (this.exportNames.size > 0) return true;\n\n    // Exported from parent?\n    for (const localExportNames of this._localExportNamesByParent.values()) {\n      if (localExportNames.size > 0) {\n        return true;\n      }\n    }\n\n    return false;\n  }\n\n  /**\n   * Indicates that it is possible for a consumer of the API to \"consume\" this entity, either by importing\n   * it directly or via a namespace. If an entity is not consumable, then API Extractor will report an\n   * `ae-forgotten-export` warning. Compare to `CollectorEntity.exported`.\n   *\n   * @remarks\n   * An API item is consumable if:\n   *\n   * 1. It is exported from the top-level entry point OR\n   * 2. It is exported from a consumable parent entity.\n   *\n   * For an example of #2, consider how `AstNamespaceImport` entities are processed. A generated rollup.d.ts\n   * might look like this:\n   *\n   * ```ts\n   * declare function add(): void;\n   * declare namespace calculator {\n   *   export {\n   *     add\n   *   }\n   * }\n   * export { calculator }\n   * ```\n   *\n   * In this example, `add` is exported via the consumable `calculator` namespace.\n   */\n  public get consumable(): boolean {\n    // Exported from top-level?\n    if (this.exportNames.size > 0) return true;\n\n    // Exported from consumable parent?\n    for (const [parent, localExportNames] of this._localExportNamesByParent) {\n      if (localExportNames.size > 0 && parent.consumable) {\n        return true;\n      }\n    }\n\n    return false;\n  }\n\n  /**\n   * Whether the entity has any parent entities.\n   *\n   * @remarks\n   * In the example below:\n   *\n   * ```ts\n   * declare function add(): void;\n   * declare namespace calculator {\n   *  export {\n   *    add\n   *  }\n   * }\n   * ```\n   *\n   * The `CollectorEntity` for `calculator` is the parent of the `CollectorEntity` for `add`.\n   */\n  public get hasParents(): boolean {\n    return this._localExportNamesByParent.size > 0;\n  }\n\n  /**\n   * Adds a new export name to the entity.\n   */\n  public addExportName(exportName: string): void {\n    if (!this._exportNames.has(exportName)) {\n      this._exportNamesSorted = false;\n      this._exportNames.add(exportName);\n\n      if (this._exportNames.size === 1) {\n        this._singleExportName = exportName;\n      } else {\n        this._singleExportName = undefined;\n      }\n    }\n  }\n\n  /**\n   * Adds a new local export name to the entity.\n   *\n   * @remarks\n   * In the example below:\n   *\n   * ```ts\n   * declare function add(): void;\n   * declare namespace calculator {\n   *  export {\n   *    add\n   *  }\n   * }\n   * ```\n   *\n   * `add` is the local export name for the `CollectorEntity` for `add`.\n   */\n  public addLocalExportName(localExportName: string, parent: CollectorEntity): void {\n    const localExportNames: Set<string> = this._localExportNamesByParent.get(parent) || new Set();\n    localExportNames.add(localExportName);\n\n    this._localExportNamesByParent.set(parent, localExportNames);\n  }\n\n  /**\n   * A sorting key used by DtsRollupGenerator._makeUniqueNames()\n   */\n  public getSortKey(): string {\n    if (!this._sortKey) {\n      this._sortKey = Collector.getSortKeyIgnoringUnderscore(this.nameForEmit || this.astEntity.localName);\n    }\n    return this._sortKey;\n  }\n}\n"]}

package/lib/collector/MessageRouter.js

@@ -475,7 +475,7 @@ class MessageRouter {
      * Sorts an array of messages according to a reasonable ordering
      */
     _sortMessagesForOutput(messages) {
-        node_core_library_1.LegacyAdapters.sortStable(messages, (a, b) => {
+        messages.sort((a, b) => {
             let diff;
             // First sort by file name
             diff = node_core_library_1.Sort.compareByValue(a.sourceFilePath, b.sourceFilePath);

package/lib/collector/MessageRouter.js.map

@@ -1 +1 @@
-{"version":3,"file":"MessageRouter.js","sourceRoot":"","sources":["../../src/collector/MessageRouter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,oDAA4B;AAC5B,+CAAiC;AAEjC,oEAAmF;AAEnF,+DAA4D;AAE5D,8DAKiC;AACjC,kEAAuF;AAEvF,iDAA8C;AAyB9C,MAAa,aAAa;IA0CxB,YAAmB,OAA8B;QAzBjD,yEAAyE;QACjE,8BAAyB,GAAgC,IAAI,GAAG,EAA0B,CAAC;QAC3F,yBAAoB,GAAmB;YAC7C,QAAQ,qCAAwB;YAChC,kBAAkB,EAAE,KAAK;SAC1B,CAAC;QACM,0BAAqB,GAAmB;YAC9C,QAAQ,qCAAwB;YAChC,kBAAkB,EAAE,KAAK;SAC1B,CAAC;QACM,sBAAiB,GAAmB,EAAE,QAAQ,qCAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;QAErG,eAAU,GAAW,CAAC,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QAa9B,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QAC1D,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAEhD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,EAAsC,CAAC;QAC1F,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,EAAE,CAAC;QACxC,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAEtD,8CAA8C;QAC9C,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,eAAe,CAAC;QAClF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAE/C,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACK,oBAAoB,CAAC,cAAwC;QACnE,IAAI,cAAc,CAAC,wBAAwB,EAAE;YAC3C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAAE;gBAC3F,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,wBAAwB,CAAC,SAAS,CAAC,CACnD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,oBAAoB,GAAG,aAAa,CAAC;iBAC3C;qBAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBACxC,MAAM,IAAI,KAAK,CACb,qFAAqF;wBACnF,sBAAsB,SAAS,0DAA0D,CAC5F,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;QAED,IAAI,cAAc,CAAC,yBAAyB,EAAE;YAC5C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,yBAAyB,CAAC,EAAE;gBAC5F,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,yBAAyB,CAAC,SAAS,CAAC,CACpD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,qBAAqB,GAAG,aAAa,CAAC;iBAC5C;qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBAClC,MAAM,IAAI,KAAK,CACb,sFAAsF;wBACpF,sBAAsB,SAAS,kDAAkD,CACpF,CAAC;iBACH;qBAAM,IAAI,CAAC,2CAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACjD,MAAM,IAAI,KAAK,CACb,sFAAsF;wBACpF,gCAAgC,SAAS,8BAA8B,CAC1E,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;QAED,IAAI,cAAc,CAAC,qBAAqB,EAAE;YACxC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,qBAAqB,CAAC,EAAE;gBACxF,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAChD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC;iBACxC;qBAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBACrC,MAAM,IAAI,KAAK,CACb,kFAAkF;wBAChF,sBAAsB,SAAS,qDAAqD,CACvF,CAAC;iBACH;qBAAM,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE;oBAChE,MAAM,IAAI,KAAK,CACb,kFAAkF;wBAChF,gCAAgC,SAAS,8BAA8B,CAC1E,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;IACH,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,IAAiC;QACjE,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;YACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,IAAI,KAAK;SACrD,CAAC;IACJ,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,UAAyB;QACpD,QAAQ,UAAU,CAAC,QAAQ,EAAE;YAC3B,KAAK,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC;YACtC,KAAK,EAAE,CAAC,kBAAkB,CAAC,OAAO;gBAChC,OAAO,CAAC,eAAe;SAC1B;QAED,MAAM,WAAW,GAAW,EAAE,CAAC,4BAA4B,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,OAAO,GAA6B;YACxC,QAAQ,oDAAmC;YAC3C,SAAS,EAAE,KAAK,UAAU,CAAC,IAAI,EAAE;YACjC,IAAI,EAAE,WAAW;SAClB,CAAC;QAEF,IAAI,UAAU,CAAC,IAAI,EAAE;YACnB,MAAM,UAAU,GAAkB,UAAU,CAAC,IAAI,CAAC;YAClD,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CACpF,UAAU,CAAC,KAAK,IAAI,CAAC,CACtB,CAAC;YAEF,OAAO,CAAC,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC7C,OAAO,CAAC,cAAc,GAAG,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAC;YACnD,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,GAAG,CAAC,CAAC;SAC3D;QAED,6EAA6E;QAC7E,4CAA4C;QAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,gBAAgB,CACrB,SAA6B,EAC7B,WAAmB,EACnB,sBAAkD,EAClD,UAAwC;QAExC,IAAI,cAA8B,CAAC;QACnC,IAAI,sBAAsB,YAAY,+BAAc,EAAE;YACpD,cAAc,GAAG,sBAAsB,CAAC;SACzC;aAAM;YACL,cAAc,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;SAC5D;QAED,MAAM,gBAAgB,GAAqB,IAAI,CAAC,2BAA2B,CACzE,SAAS,EACT,WAAW,EACX,cAAc,CAAC,WAAW,CAAC,aAAa,EAAE,EAC1C,cAAc,CAAC,WAAW,CAAC,QAAQ,EAAE,EACrC,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,mCAAmC,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACI,gBAAgB,CACrB,aAAkC,EAClC,UAAyB,EACzB,cAA+B;QAE/B,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE;YAChD,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CACpF,OAAO,CAAC,SAAS,CAAC,GAAG,CACtB,CAAC;YAEF,MAAM,OAAO,GAA6B;gBACxC,QAAQ,8CAAgC;gBACxC,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,IAAI,EAAE,OAAO,CAAC,eAAe;gBAC7B,cAAc,EAAE,UAAU,CAAC,QAAQ;gBACnC,cAAc,EAAE,gBAAgB,CAAC,IAAI,GAAG,CAAC;gBACzC,gBAAgB,EAAE,gBAAgB,CAAC,SAAS,GAAG,CAAC;aACjD,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,gBAAgB,GAAqB,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC;YAEzE,IAAI,cAAc,EAAE;gBAClB,IAAI,CAAC,mCAAmC,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;aAC5E;YAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACvC;IACH,CAAC;IAED;;;;;;OAMG;IACH,8DAA8D;IACvD,MAAM,CAAC,mBAAmB,CAAC,KAAU,EAAE,OAAqC;QACjF,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QAED,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpE,OAAO,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACnE,CAAC;IAED,8DAA8D;IACtD,MAAM,CAAC,oBAAoB,CAAC,KAAU,EAAE,cAA2B;QACzE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,OAAO,IAAI,CAAC,CAAC,sCAAsC;SACpD;QAED,QAAQ,OAAO,KAAK,EAAE;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,KAAK,CAAC;YACf,KAAK,QAAQ;gBACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACxB,8DAA8D;oBAC9D,MAAM,WAAW,GAAU,EAAE,CAAC;oBAC9B,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;wBAC3B,8DAA8D;wBAC9D,MAAM,iBAAiB,GAAQ,aAAa,CAAC,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;wBAC3F,IAAI,iBAAiB,KAAK,SAAS,EAAE;4BACnC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;yBACrC;qBACF;oBACD,OAAO,WAAW,CAAC;iBACpB;gBAED,MAAM,YAAY,GAAW,EAAE,CAAC;gBAChC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE;oBACnD,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;wBAC3B,SAAS;qBACV;oBAED,8DAA8D;oBAC9D,MAAM,KAAK,GAAQ,KAAK,CAAC,GAAG,CAAC,CAAC;oBAE9B,8DAA8D;oBAC9D,MAAM,eAAe,GAAQ,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;oBAEvF,IAAI,eAAe,KAAK,SAAS,EAAE;wBACjC,8DAA8D;wBAC7D,YAAoB,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC;qBAC9C;iBACF;gBACD,OAAO,YAAY,CAAC;SACvB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,mCAAmC,CACzC,gBAAkC,EAClC,cAA8B;QAE9B,IAAI,kBAAkB,GACpB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEhE,IAAI,CAAC,kBAAkB,EAAE;YACvB,kBAAkB,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;SACnF;QACD,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,2BAA2B,CAChC,SAA6B,EAC7B,WAAmB,EACnB,UAAyB,EACzB,GAAW,EACX,UAAwC;QAExC,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;QAE5F,MAAM,OAAO,GAA6B;YACxC,QAAQ,sDAAoC;YAC5C,SAAS;YACT,IAAI,EAAE,WAAW;YACjB,cAAc,EAAE,UAAU,CAAC,QAAQ;YACnC,cAAc,EAAE,gBAAgB,CAAC,IAAI,GAAG,CAAC;YACzC,gBAAgB,EAAE,gBAAgB,CAAC,SAAS,GAAG,CAAC;YAChD,UAAU;SACX,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAqB,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC;QAEzE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACtC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,oCAAoC,CAAC,cAA8B;QACxE,MAAM,wBAAwB,GAAuB,EAAE,CAAC;QAExD,MAAM,kBAAkB,GACtB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACtE,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;YAClD,kEAAkE;YAClE,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;gBAC9B,gEAAgE;gBAChE,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;gBACjF,IAAI,aAAa,CAAC,kBAAkB,EAAE;oBACpC,2EAA2E;oBAC3E,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBACjD,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;iBAClC;aACF;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;QACtD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,sCAAsC;QAC3C,MAAM,wBAAwB,GAAuB,EAAE,CAAC;QAExD,KAAK,MAAM,mBAAmB,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/C,kEAAkE;YAClE,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBAChC,gEAAgE;gBAChE,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;gBACnF,IAAI,aAAa,CAAC,kBAAkB,EAAE;oBACpC,2EAA2E;oBAC3E,wBAAwB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;oBACnD,mBAAmB,CAAC,OAAO,GAAG,IAAI,CAAC;iBACpC;aACF;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;QACtD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,iCAAiC;QACtC,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QAEjD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,kDAAkD;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBACpB,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACjC;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAE/C,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SAC9B;IACH,CAAC;IAEM,QAAQ,CACb,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,uCAAyB;SAClC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,UAAU,CACf,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,2CAA2B;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,OAAO,CACZ,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,qCAAwB;SACjC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,UAAU,CACf,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,2CAA2B;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,mBAAmB,CAAC,KAAa;QACtC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB;QACxB,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEM,aAAa,CAAC,OAAe;QAClC,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,UAAU,2DAA+B,OAAO,CAAC,CAAC;SACxD;IACH,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,OAAyB;QAC9C,uFAAuF;QACvF,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO;SACR;QAED,iFAAiF;QACjF,IAAI,OAAO,CAAC,QAAQ,qDAAqC,EAAE;YACzD,4FAA4F;SAC7F;aAAM;YACL,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACvE,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;SAC3C;QAED,uEAAuE;QACvE,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;SAChC;QAED,wBAAwB;QACxB,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,EAAE,IAAI,CAAC,UAAU,CAAC;gBAClB,MAAM;YACR;gBACE,EAAE,IAAI,CAAC,YAAY,CAAC;gBACpB,MAAM;SACT;QAED,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO;SACR;QAED,8EAA8E;QAC9E,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QAEvB,IAAI,OAAO,CAAC,QAAQ,wCAA2B,EAAE;YAC/C,OAAO;SACR;QAED,IAAI,WAAmB,CAAC;QACxB,IAAI,OAAO,CAAC,QAAQ,qDAAqC,EAAE;YACzD,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;SAC5B;aAAM;YACL,WAAW,GAAG,OAAO,CAAC,yBAAyB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;SAC7E;QAED,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC;gBACnD,MAAM;YACR;gBACE,OAAO,CAAC,IAAI,CAAC,gBAAM,CAAC,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC;gBACvD,MAAM;YACR;gBACE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACzB,MAAM;YACR;gBACE,IAAI,IAAI,CAAC,mBAAmB,EAAE;oBAC5B,OAAO,CAAC,GAAG,CAAC,gBAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;iBACvC;gBACD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAClF;IACH,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,OAAyB;QAClD,MAAM,aAAa,GAA+B,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACxG,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QACD,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,OAAO,IAAI,CAAC,oBAAoB,CAAC;YACnC;gBACE,OAAO,IAAI,CAAC,qBAAqB,CAAC;YACpC;gBACE,OAAO,IAAI,CAAC,iBAAiB,CAAC;YAChC;gBACE,MAAM,IAAI,iCAAa,CAAC,uEAAuE,CAAC,CAAC;SACpG;IACH,CAAC;IAED;;OAEG;IACK,sBAAsB,CAAC,QAA4B;QACzD,kCAAc,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,IAAY,CAAC;YACjB,0BAA0B;YAC1B,IAAI,GAAG,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,OAAO,IAAI,CAAC;aACb;YACD,2BAA2B;YAC3B,IAAI,GAAG,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,OAAO,IAAI,CAAC;aACb;YACD,yBAAyB;YACzB,OAAO,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC;;AAjmBH,sCAkmBC;AAjmBwB,8BAAgB,GACrC,8DAA8D,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport colors from 'colors';\nimport * as ts from 'typescript';\nimport * as tsdoc from '@microsoft/tsdoc';\nimport { Sort, InternalError, LegacyAdapters } from '@rushstack/node-core-library';\n\nimport { AstDeclaration } from '../analyzer/AstDeclaration';\nimport { AstSymbol } from '../analyzer/AstSymbol';\nimport {\n  ExtractorMessage,\n  ExtractorMessageCategory,\n  IExtractorMessageOptions,\n  IExtractorMessageProperties\n} from '../api/ExtractorMessage';\nimport { ExtractorMessageId, allExtractorMessageIds } from '../api/ExtractorMessageId';\nimport { IExtractorMessagesConfig, IConfigMessageReportingRule } from '../api/IConfigFile';\nimport { SourceMapper } from './SourceMapper';\nimport { ExtractorLogLevel } from '../api/ExtractorLogLevel';\nimport { ConsoleMessageId } from '../api/ConsoleMessageId';\n\ninterface IReportingRule {\n  logLevel: ExtractorLogLevel;\n  addToApiReportFile: boolean;\n}\n\nexport interface IMessageRouterOptions {\n  workingPackageFolder: string | undefined;\n  messageCallback: ((message: ExtractorMessage) => void) | undefined;\n  messagesConfig: IExtractorMessagesConfig;\n  showVerboseMessages: boolean;\n  showDiagnostics: boolean;\n  tsdocConfiguration: tsdoc.TSDocConfiguration;\n}\n\nexport interface IBuildJsonDumpObjectOptions {\n  /**\n   * {@link MessageRouter.buildJsonDumpObject} will omit any objects keys with these names.\n   */\n  keyNamesToOmit?: string[];\n}\n\nexport class MessageRouter {\n  public static readonly DIAGNOSTICS_LINE: string =\n    '============================================================';\n\n  private readonly _workingPackageFolder: string | undefined;\n  private readonly _messageCallback: ((message: ExtractorMessage) => void) | undefined;\n\n  // All messages\n  private readonly _messages: ExtractorMessage[];\n\n  // For each AstDeclaration, the messages associated with it.  This is used when addToApiReportFile=true\n  private readonly _associatedMessagesForAstDeclaration: Map<AstDeclaration, ExtractorMessage[]>;\n\n  private readonly _sourceMapper: SourceMapper;\n\n  private readonly _tsdocConfiguration: tsdoc.TSDocConfiguration;\n\n  // Normalized representation of the routing rules from api-extractor.json\n  private _reportingRuleByMessageId: Map<string, IReportingRule> = new Map<string, IReportingRule>();\n  private _compilerDefaultRule: IReportingRule = {\n    logLevel: ExtractorLogLevel.None,\n    addToApiReportFile: false\n  };\n  private _extractorDefaultRule: IReportingRule = {\n    logLevel: ExtractorLogLevel.None,\n    addToApiReportFile: false\n  };\n  private _tsdocDefaultRule: IReportingRule = { logLevel: ExtractorLogLevel.None, addToApiReportFile: false };\n\n  public errorCount: number = 0;\n  public warningCount: number = 0;\n\n  /**\n   * See {@link IExtractorInvokeOptions.showVerboseMessages}\n   */\n  public readonly showVerboseMessages: boolean;\n\n  /**\n   * See {@link IExtractorInvokeOptions.showDiagnostics}\n   */\n  public readonly showDiagnostics: boolean;\n\n  public constructor(options: IMessageRouterOptions) {\n    this._workingPackageFolder = options.workingPackageFolder;\n    this._messageCallback = options.messageCallback;\n\n    this._messages = [];\n    this._associatedMessagesForAstDeclaration = new Map<AstDeclaration, ExtractorMessage[]>();\n    this._sourceMapper = new SourceMapper();\n    this._tsdocConfiguration = options.tsdocConfiguration;\n\n    // showDiagnostics implies showVerboseMessages\n    this.showVerboseMessages = options.showVerboseMessages || options.showDiagnostics;\n    this.showDiagnostics = options.showDiagnostics;\n\n    this._applyMessagesConfig(options.messagesConfig);\n  }\n\n  /**\n   * Read the api-extractor.json configuration and build up the tables of routing rules.\n   */\n  private _applyMessagesConfig(messagesConfig: IExtractorMessagesConfig): void {\n    if (messagesConfig.compilerMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.compilerMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.compilerMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._compilerDefaultRule = reportingRule;\n        } else if (!/^TS[0-9]+$/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.compilerMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\". The identifier format is \"TS\" followed by an integer.`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n\n    if (messagesConfig.extractorMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.extractorMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.extractorMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._extractorDefaultRule = reportingRule;\n        } else if (!/^ae-/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.extractorMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\".  The name should begin with the \"ae-\" prefix.`\n          );\n        } else if (!allExtractorMessageIds.has(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.extractorMessageReporting table contains` +\n              ` an unrecognized identifier \"${messageId}\".  Is it spelled correctly?`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n\n    if (messagesConfig.tsdocMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.tsdocMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.tsdocMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._tsdocDefaultRule = reportingRule;\n        } else if (!/^tsdoc-/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.tsdocMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\".  The name should begin with the \"tsdoc-\" prefix.`\n          );\n        } else if (!this._tsdocConfiguration.isKnownMessageId(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.tsdocMessageReporting table contains` +\n              ` an unrecognized identifier \"${messageId}\".  Is it spelled correctly?`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n  }\n\n  private static _getNormalizedRule(rule: IConfigMessageReportingRule): IReportingRule {\n    return {\n      logLevel: rule.logLevel || 'none',\n      addToApiReportFile: rule.addToApiReportFile || false\n    };\n  }\n\n  public get messages(): ReadonlyArray<ExtractorMessage> {\n    return this._messages;\n  }\n\n  /**\n   * Add a diagnostic message reported by the TypeScript compiler\n   */\n  public addCompilerDiagnostic(diagnostic: ts.Diagnostic): void {\n    switch (diagnostic.category) {\n      case ts.DiagnosticCategory.Suggestion:\n      case ts.DiagnosticCategory.Message:\n        return; // ignore noise\n    }\n\n    const messageText: string = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\\n');\n    const options: IExtractorMessageOptions = {\n      category: ExtractorMessageCategory.Compiler,\n      messageId: `TS${diagnostic.code}`,\n      text: messageText\n    };\n\n    if (diagnostic.file) {\n      const sourceFile: ts.SourceFile = diagnostic.file;\n      const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(\n        diagnostic.start || 0\n      );\n\n      options.sourceFilePath = sourceFile.fileName;\n      options.sourceFileLine = lineAndCharacter.line + 1;\n      options.sourceFileColumn = lineAndCharacter.character + 1;\n    }\n\n    // NOTE: Since compiler errors pertain to issues specific to the .d.ts files,\n    // we do not apply source mappings for them.\n    this._messages.push(new ExtractorMessage(options));\n  }\n\n  /**\n   * Add a message from the API Extractor analysis\n   */\n  public addAnalyzerIssue(\n    messageId: ExtractorMessageId,\n    messageText: string,\n    astDeclarationOrSymbol: AstDeclaration | AstSymbol,\n    properties?: IExtractorMessageProperties\n  ): void {\n    let astDeclaration: AstDeclaration;\n    if (astDeclarationOrSymbol instanceof AstDeclaration) {\n      astDeclaration = astDeclarationOrSymbol;\n    } else {\n      astDeclaration = astDeclarationOrSymbol.astDeclarations[0];\n    }\n\n    const extractorMessage: ExtractorMessage = this.addAnalyzerIssueForPosition(\n      messageId,\n      messageText,\n      astDeclaration.declaration.getSourceFile(),\n      astDeclaration.declaration.getStart(),\n      properties\n    );\n\n    this._associateMessageWithAstDeclaration(extractorMessage, astDeclaration);\n  }\n\n  /**\n   * Add all messages produced from an invocation of the TSDoc parser, assuming they refer to\n   * code in the specified source file.\n   */\n  public addTsdocMessages(\n    parserContext: tsdoc.ParserContext,\n    sourceFile: ts.SourceFile,\n    astDeclaration?: AstDeclaration\n  ): void {\n    for (const message of parserContext.log.messages) {\n      const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(\n        message.textRange.pos\n      );\n\n      const options: IExtractorMessageOptions = {\n        category: ExtractorMessageCategory.TSDoc,\n        messageId: message.messageId,\n        text: message.unformattedText,\n        sourceFilePath: sourceFile.fileName,\n        sourceFileLine: lineAndCharacter.line + 1,\n        sourceFileColumn: lineAndCharacter.character + 1\n      };\n\n      this._sourceMapper.updateExtractorMessageOptions(options);\n      const extractorMessage: ExtractorMessage = new ExtractorMessage(options);\n\n      if (astDeclaration) {\n        this._associateMessageWithAstDeclaration(extractorMessage, astDeclaration);\n      }\n\n      this._messages.push(extractorMessage);\n    }\n  }\n\n  /**\n   * Recursively collects the primitive members (numbers, strings, arrays, etc) into an object that\n   * is JSON serializable.  This is used by the \"--diagnostics\" feature to dump the state of configuration objects.\n   *\n   * @returns a JSON serializable object (possibly including `null` values)\n   *          or `undefined` if the input cannot be represented as JSON\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  public static buildJsonDumpObject(input: any, options?: IBuildJsonDumpObjectOptions): any | undefined {\n    if (!options) {\n      options = {};\n    }\n\n    const keyNamesToOmit: Set<string> = new Set(options.keyNamesToOmit);\n\n    return MessageRouter._buildJsonDumpObject(input, keyNamesToOmit);\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private static _buildJsonDumpObject(input: any, keyNamesToOmit: Set<string>): any | undefined {\n    if (input === null || input === undefined) {\n      return null; // JSON uses null instead of undefined\n    }\n\n    switch (typeof input) {\n      case 'boolean':\n      case 'number':\n      case 'string':\n        return input;\n      case 'object':\n        if (Array.isArray(input)) {\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const outputArray: any[] = [];\n          for (const element of input) {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            const serializedElement: any = MessageRouter._buildJsonDumpObject(element, keyNamesToOmit);\n            if (serializedElement !== undefined) {\n              outputArray.push(serializedElement);\n            }\n          }\n          return outputArray;\n        }\n\n        const outputObject: object = {};\n        for (const key of Object.getOwnPropertyNames(input)) {\n          if (keyNamesToOmit.has(key)) {\n            continue;\n          }\n\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const value: any = input[key];\n\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const serializedValue: any = MessageRouter._buildJsonDumpObject(value, keyNamesToOmit);\n\n          if (serializedValue !== undefined) {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            (outputObject as any)[key] = serializedValue;\n          }\n        }\n        return outputObject;\n    }\n\n    return undefined;\n  }\n\n  /**\n   * Record this message in  _associatedMessagesForAstDeclaration\n   */\n  private _associateMessageWithAstDeclaration(\n    extractorMessage: ExtractorMessage,\n    astDeclaration: AstDeclaration\n  ): void {\n    let associatedMessages: ExtractorMessage[] | undefined =\n      this._associatedMessagesForAstDeclaration.get(astDeclaration);\n\n    if (!associatedMessages) {\n      associatedMessages = [];\n      this._associatedMessagesForAstDeclaration.set(astDeclaration, associatedMessages);\n    }\n    associatedMessages.push(extractorMessage);\n  }\n\n  /**\n   * Add a message for a location in an arbitrary source file.\n   */\n  public addAnalyzerIssueForPosition(\n    messageId: ExtractorMessageId,\n    messageText: string,\n    sourceFile: ts.SourceFile,\n    pos: number,\n    properties?: IExtractorMessageProperties\n  ): ExtractorMessage {\n    const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(pos);\n\n    const options: IExtractorMessageOptions = {\n      category: ExtractorMessageCategory.Extractor,\n      messageId,\n      text: messageText,\n      sourceFilePath: sourceFile.fileName,\n      sourceFileLine: lineAndCharacter.line + 1,\n      sourceFileColumn: lineAndCharacter.character + 1,\n      properties\n    };\n\n    this._sourceMapper.updateExtractorMessageOptions(options);\n    const extractorMessage: ExtractorMessage = new ExtractorMessage(options);\n\n    this._messages.push(extractorMessage);\n    return extractorMessage;\n  }\n\n  /**\n   * This is used when writing the API report file.  It looks up any messages that were configured to get emitted\n   * in the API report file and returns them.  It also records that they were emitted, which suppresses them from\n   * being shown on the console.\n   */\n  public fetchAssociatedMessagesForReviewFile(astDeclaration: AstDeclaration): ExtractorMessage[] {\n    const messagesForApiReportFile: ExtractorMessage[] = [];\n\n    const associatedMessages: ExtractorMessage[] =\n      this._associatedMessagesForAstDeclaration.get(astDeclaration) || [];\n    for (const associatedMessage of associatedMessages) {\n      // Make sure we didn't already report this message for some reason\n      if (!associatedMessage.handled) {\n        // Is this message type configured to go in the API report file?\n        const reportingRule: IReportingRule = this._getRuleForMessage(associatedMessage);\n        if (reportingRule.addToApiReportFile) {\n          // Include it in the result, and record that it went to the API report file\n          messagesForApiReportFile.push(associatedMessage);\n          associatedMessage.handled = true;\n        }\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForApiReportFile);\n    return messagesForApiReportFile;\n  }\n\n  /**\n   * This returns all remaining messages that were flagged with `addToApiReportFile`, but which were not\n   * retreieved using `fetchAssociatedMessagesForReviewFile()`.\n   */\n  public fetchUnassociatedMessagesForReviewFile(): ExtractorMessage[] {\n    const messagesForApiReportFile: ExtractorMessage[] = [];\n\n    for (const unassociatedMessage of this.messages) {\n      // Make sure we didn't already report this message for some reason\n      if (!unassociatedMessage.handled) {\n        // Is this message type configured to go in the API report file?\n        const reportingRule: IReportingRule = this._getRuleForMessage(unassociatedMessage);\n        if (reportingRule.addToApiReportFile) {\n          // Include it in the result, and record that it went to the API report file\n          messagesForApiReportFile.push(unassociatedMessage);\n          unassociatedMessage.handled = true;\n        }\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForApiReportFile);\n    return messagesForApiReportFile;\n  }\n\n  /**\n   * This returns the list of remaining messages that were not already processed by\n   * `fetchAssociatedMessagesForReviewFile()` or `fetchUnassociatedMessagesForReviewFile()`.\n   * These messages will be shown on the console.\n   */\n  public handleRemainingNonConsoleMessages(): void {\n    const messagesForLogger: ExtractorMessage[] = [];\n\n    for (const message of this.messages) {\n      // Make sure we didn't already report this message\n      if (!message.handled) {\n        messagesForLogger.push(message);\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForLogger);\n\n    for (const message of messagesForLogger) {\n      this._handleMessage(message);\n    }\n  }\n\n  public logError(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Error\n      })\n    );\n  }\n\n  public logWarning(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Warning\n      })\n    );\n  }\n\n  public logInfo(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Info\n      })\n    );\n  }\n\n  public logVerbose(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Verbose\n      })\n    );\n  }\n\n  public logDiagnosticHeader(title: string): void {\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);\n    this.logDiagnostic(`DIAGNOSTIC: ` + title);\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);\n  }\n\n  public logDiagnosticFooter(): void {\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE + '\\n');\n  }\n\n  public logDiagnostic(message: string): void {\n    if (this.showDiagnostics) {\n      this.logVerbose(ConsoleMessageId.Diagnostics, message);\n    }\n  }\n\n  /**\n   * Give the calling application a chance to handle the `ExtractorMessage`, and if not, display it on the console.\n   */\n  private _handleMessage(message: ExtractorMessage): void {\n    // Don't tally messages that were already \"handled\" by writing them into the API report\n    if (message.handled) {\n      return;\n    }\n\n    // Assign the ExtractorMessage.logLevel; the message callback may adjust it below\n    if (message.category === ExtractorMessageCategory.Console) {\n      // Console messages have their category log level assigned via logInfo(), logVerbose(), etc.\n    } else {\n      const reportingRule: IReportingRule = this._getRuleForMessage(message);\n      message.logLevel = reportingRule.logLevel;\n    }\n\n    // If there is a callback, allow it to modify and/or handle the message\n    if (this._messageCallback) {\n      this._messageCallback(message);\n    }\n\n    // Update the statistics\n    switch (message.logLevel) {\n      case ExtractorLogLevel.Error:\n        ++this.errorCount;\n        break;\n      case ExtractorLogLevel.Warning:\n        ++this.warningCount;\n        break;\n    }\n\n    if (message.handled) {\n      return;\n    }\n\n    // The messageCallback did not handle the message, so perform default handling\n    message.handled = true;\n\n    if (message.logLevel === ExtractorLogLevel.None) {\n      return;\n    }\n\n    let messageText: string;\n    if (message.category === ExtractorMessageCategory.Console) {\n      messageText = message.text;\n    } else {\n      messageText = message.formatMessageWithLocation(this._workingPackageFolder);\n    }\n\n    switch (message.logLevel) {\n      case ExtractorLogLevel.Error:\n        console.error(colors.red('Error: ' + messageText));\n        break;\n      case ExtractorLogLevel.Warning:\n        console.warn(colors.yellow('Warning: ' + messageText));\n        break;\n      case ExtractorLogLevel.Info:\n        console.log(messageText);\n        break;\n      case ExtractorLogLevel.Verbose:\n        if (this.showVerboseMessages) {\n          console.log(colors.cyan(messageText));\n        }\n        break;\n      default:\n        throw new Error(`Invalid logLevel value: ${JSON.stringify(message.logLevel)}`);\n    }\n  }\n\n  /**\n   * For a given message, determine the IReportingRule based on the rule tables.\n   */\n  private _getRuleForMessage(message: ExtractorMessage): IReportingRule {\n    const reportingRule: IReportingRule | undefined = this._reportingRuleByMessageId.get(message.messageId);\n    if (reportingRule) {\n      return reportingRule;\n    }\n    switch (message.category) {\n      case ExtractorMessageCategory.Compiler:\n        return this._compilerDefaultRule;\n      case ExtractorMessageCategory.Extractor:\n        return this._extractorDefaultRule;\n      case ExtractorMessageCategory.TSDoc:\n        return this._tsdocDefaultRule;\n      case ExtractorMessageCategory.Console:\n        throw new InternalError('ExtractorMessageCategory.Console is not supported with IReportingRule');\n    }\n  }\n\n  /**\n   * Sorts an array of messages according to a reasonable ordering\n   */\n  private _sortMessagesForOutput(messages: ExtractorMessage[]): void {\n    LegacyAdapters.sortStable(messages, (a, b) => {\n      let diff: number;\n      // First sort by file name\n      diff = Sort.compareByValue(a.sourceFilePath, b.sourceFilePath);\n      if (diff !== 0) {\n        return diff;\n      }\n      // Then sort by line number\n      diff = Sort.compareByValue(a.sourceFileLine, b.sourceFileLine);\n      if (diff !== 0) {\n        return diff;\n      }\n      // Then sort by messageId\n      return Sort.compareByValue(a.messageId, b.messageId);\n    });\n  }\n}\n"]}
+{"version":3,"file":"MessageRouter.js","sourceRoot":"","sources":["../../src/collector/MessageRouter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,oDAA4B;AAC5B,+CAAiC;AAEjC,oEAAmE;AAEnE,+DAA4D;AAE5D,8DAKiC;AACjC,kEAAuF;AAEvF,iDAA8C;AAyB9C,MAAa,aAAa;IA0CxB,YAAmB,OAA8B;QAzBjD,yEAAyE;QACjE,8BAAyB,GAAgC,IAAI,GAAG,EAA0B,CAAC;QAC3F,yBAAoB,GAAmB;YAC7C,QAAQ,qCAAwB;YAChC,kBAAkB,EAAE,KAAK;SAC1B,CAAC;QACM,0BAAqB,GAAmB;YAC9C,QAAQ,qCAAwB;YAChC,kBAAkB,EAAE,KAAK;SAC1B,CAAC;QACM,sBAAiB,GAAmB,EAAE,QAAQ,qCAAwB,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;QAErG,eAAU,GAAW,CAAC,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QAa9B,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QAC1D,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAEhD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,EAAsC,CAAC;QAC1F,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,EAAE,CAAC;QACxC,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAEtD,8CAA8C;QAC9C,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,eAAe,CAAC;QAClF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAE/C,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACK,oBAAoB,CAAC,cAAwC;QACnE,IAAI,cAAc,CAAC,wBAAwB,EAAE;YAC3C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAAE;gBAC3F,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,wBAAwB,CAAC,SAAS,CAAC,CACnD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,oBAAoB,GAAG,aAAa,CAAC;iBAC3C;qBAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBACxC,MAAM,IAAI,KAAK,CACb,qFAAqF;wBACnF,sBAAsB,SAAS,0DAA0D,CAC5F,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;QAED,IAAI,cAAc,CAAC,yBAAyB,EAAE;YAC5C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,yBAAyB,CAAC,EAAE;gBAC5F,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,yBAAyB,CAAC,SAAS,CAAC,CACpD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,qBAAqB,GAAG,aAAa,CAAC;iBAC5C;qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBAClC,MAAM,IAAI,KAAK,CACb,sFAAsF;wBACpF,sBAAsB,SAAS,kDAAkD,CACpF,CAAC;iBACH;qBAAM,IAAI,CAAC,2CAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACjD,MAAM,IAAI,KAAK,CACb,sFAAsF;wBACpF,gCAAgC,SAAS,8BAA8B,CAC1E,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;QAED,IAAI,cAAc,CAAC,qBAAqB,EAAE;YACxC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,qBAAqB,CAAC,EAAE;gBACxF,MAAM,aAAa,GAAmB,aAAa,CAAC,kBAAkB,CACpE,cAAc,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAChD,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC;iBACxC;qBAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;oBACrC,MAAM,IAAI,KAAK,CACb,kFAAkF;wBAChF,sBAAsB,SAAS,qDAAqD,CACvF,CAAC;iBACH;qBAAM,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE;oBAChE,MAAM,IAAI,KAAK,CACb,kFAAkF;wBAChF,gCAAgC,SAAS,8BAA8B,CAC1E,CAAC;iBACH;qBAAM;oBACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBAC9D;aACF;SACF;IACH,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,IAAiC;QACjE,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,MAAM;YACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,IAAI,KAAK;SACrD,CAAC;IACJ,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,UAAyB;QACpD,QAAQ,UAAU,CAAC,QAAQ,EAAE;YAC3B,KAAK,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC;YACtC,KAAK,EAAE,CAAC,kBAAkB,CAAC,OAAO;gBAChC,OAAO,CAAC,eAAe;SAC1B;QAED,MAAM,WAAW,GAAW,EAAE,CAAC,4BAA4B,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,OAAO,GAA6B;YACxC,QAAQ,oDAAmC;YAC3C,SAAS,EAAE,KAAK,UAAU,CAAC,IAAI,EAAE;YACjC,IAAI,EAAE,WAAW;SAClB,CAAC;QAEF,IAAI,UAAU,CAAC,IAAI,EAAE;YACnB,MAAM,UAAU,GAAkB,UAAU,CAAC,IAAI,CAAC;YAClD,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CACpF,UAAU,CAAC,KAAK,IAAI,CAAC,CACtB,CAAC;YAEF,OAAO,CAAC,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC7C,OAAO,CAAC,cAAc,GAAG,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAC;YACnD,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,GAAG,CAAC,CAAC;SAC3D;QAED,6EAA6E;QAC7E,4CAA4C;QAC5C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,gBAAgB,CACrB,SAA6B,EAC7B,WAAmB,EACnB,sBAAkD,EAClD,UAAwC;QAExC,IAAI,cAA8B,CAAC;QACnC,IAAI,sBAAsB,YAAY,+BAAc,EAAE;YACpD,cAAc,GAAG,sBAAsB,CAAC;SACzC;aAAM;YACL,cAAc,GAAG,sBAAsB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;SAC5D;QAED,MAAM,gBAAgB,GAAqB,IAAI,CAAC,2BAA2B,CACzE,SAAS,EACT,WAAW,EACX,cAAc,CAAC,WAAW,CAAC,aAAa,EAAE,EAC1C,cAAc,CAAC,WAAW,CAAC,QAAQ,EAAE,EACrC,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,mCAAmC,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACI,gBAAgB,CACrB,aAAkC,EAClC,UAAyB,EACzB,cAA+B;QAE/B,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE;YAChD,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CACpF,OAAO,CAAC,SAAS,CAAC,GAAG,CACtB,CAAC;YAEF,MAAM,OAAO,GAA6B;gBACxC,QAAQ,8CAAgC;gBACxC,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,IAAI,EAAE,OAAO,CAAC,eAAe;gBAC7B,cAAc,EAAE,UAAU,CAAC,QAAQ;gBACnC,cAAc,EAAE,gBAAgB,CAAC,IAAI,GAAG,CAAC;gBACzC,gBAAgB,EAAE,gBAAgB,CAAC,SAAS,GAAG,CAAC;aACjD,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,gBAAgB,GAAqB,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC;YAEzE,IAAI,cAAc,EAAE;gBAClB,IAAI,CAAC,mCAAmC,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;aAC5E;YAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACvC;IACH,CAAC;IAED;;;;;;OAMG;IACH,8DAA8D;IACvD,MAAM,CAAC,mBAAmB,CAAC,KAAU,EAAE,OAAqC;QACjF,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QAED,MAAM,cAAc,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpE,OAAO,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACnE,CAAC;IAED,8DAA8D;IACtD,MAAM,CAAC,oBAAoB,CAAC,KAAU,EAAE,cAA2B;QACzE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,OAAO,IAAI,CAAC,CAAC,sCAAsC;SACpD;QAED,QAAQ,OAAO,KAAK,EAAE;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,KAAK,CAAC;YACf,KAAK,QAAQ;gBACX,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACxB,8DAA8D;oBAC9D,MAAM,WAAW,GAAU,EAAE,CAAC;oBAC9B,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;wBAC3B,8DAA8D;wBAC9D,MAAM,iBAAiB,GAAQ,aAAa,CAAC,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;wBAC3F,IAAI,iBAAiB,KAAK,SAAS,EAAE;4BACnC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;yBACrC;qBACF;oBACD,OAAO,WAAW,CAAC;iBACpB;gBAED,MAAM,YAAY,GAAW,EAAE,CAAC;gBAChC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE;oBACnD,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;wBAC3B,SAAS;qBACV;oBAED,8DAA8D;oBAC9D,MAAM,KAAK,GAAQ,KAAK,CAAC,GAAG,CAAC,CAAC;oBAE9B,8DAA8D;oBAC9D,MAAM,eAAe,GAAQ,aAAa,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;oBAEvF,IAAI,eAAe,KAAK,SAAS,EAAE;wBACjC,8DAA8D;wBAC7D,YAAoB,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC;qBAC9C;iBACF;gBACD,OAAO,YAAY,CAAC;SACvB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,mCAAmC,CACzC,gBAAkC,EAClC,cAA8B;QAE9B,IAAI,kBAAkB,GACpB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEhE,IAAI,CAAC,kBAAkB,EAAE;YACvB,kBAAkB,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;SACnF;QACD,kBAAkB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,2BAA2B,CAChC,SAA6B,EAC7B,WAAmB,EACnB,UAAyB,EACzB,GAAW,EACX,UAAwC;QAExC,MAAM,gBAAgB,GAAwB,UAAU,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;QAE5F,MAAM,OAAO,GAA6B;YACxC,QAAQ,sDAAoC;YAC5C,SAAS;YACT,IAAI,EAAE,WAAW;YACjB,cAAc,EAAE,UAAU,CAAC,QAAQ;YACnC,cAAc,EAAE,gBAAgB,CAAC,IAAI,GAAG,CAAC;YACzC,gBAAgB,EAAE,gBAAgB,CAAC,SAAS,GAAG,CAAC;YAChD,UAAU;SACX,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAqB,IAAI,mCAAgB,CAAC,OAAO,CAAC,CAAC;QAEzE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACtC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,oCAAoC,CAAC,cAA8B;QACxE,MAAM,wBAAwB,GAAuB,EAAE,CAAC;QAExD,MAAM,kBAAkB,GACtB,IAAI,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACtE,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;YAClD,kEAAkE;YAClE,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;gBAC9B,gEAAgE;gBAChE,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;gBACjF,IAAI,aAAa,CAAC,kBAAkB,EAAE;oBACpC,2EAA2E;oBAC3E,wBAAwB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBACjD,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC;iBAClC;aACF;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;QACtD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,sCAAsC;QAC3C,MAAM,wBAAwB,GAAuB,EAAE,CAAC;QAExD,KAAK,MAAM,mBAAmB,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/C,kEAAkE;YAClE,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBAChC,gEAAgE;gBAChE,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;gBACnF,IAAI,aAAa,CAAC,kBAAkB,EAAE;oBACpC,2EAA2E;oBAC3E,wBAAwB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;oBACnD,mBAAmB,CAAC,OAAO,GAAG,IAAI,CAAC;iBACpC;aACF;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;QACtD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,iCAAiC;QACtC,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QAEjD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,kDAAkD;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBACpB,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACjC;SACF;QAED,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAE/C,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SAC9B;IACH,CAAC;IAEM,QAAQ,CACb,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,uCAAyB;SAClC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,UAAU,CACf,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,2CAA2B;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,OAAO,CACZ,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,qCAAwB;SACjC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,UAAU,CACf,SAA2B,EAC3B,OAAe,EACf,UAAwC;QAExC,IAAI,CAAC,cAAc,CACjB,IAAI,mCAAgB,CAAC;YACnB,QAAQ,kDAAkC;YAC1C,SAAS;YACT,IAAI,EAAE,OAAO;YACb,UAAU;YACV,QAAQ,2CAA2B;SACpC,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,mBAAmB,CAAC,KAAa;QACtC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB;QACxB,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAEM,aAAa,CAAC,OAAe;QAClC,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,UAAU,2DAA+B,OAAO,CAAC,CAAC;SACxD;IACH,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,OAAyB;QAC9C,uFAAuF;QACvF,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO;SACR;QAED,iFAAiF;QACjF,IAAI,OAAO,CAAC,QAAQ,qDAAqC,EAAE;YACzD,4FAA4F;SAC7F;aAAM;YACL,MAAM,aAAa,GAAmB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACvE,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;SAC3C;QAED,uEAAuE;QACvE,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;SAChC;QAED,wBAAwB;QACxB,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,EAAE,IAAI,CAAC,UAAU,CAAC;gBAClB,MAAM;YACR;gBACE,EAAE,IAAI,CAAC,YAAY,CAAC;gBACpB,MAAM;SACT;QAED,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO;SACR;QAED,8EAA8E;QAC9E,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QAEvB,IAAI,OAAO,CAAC,QAAQ,wCAA2B,EAAE;YAC/C,OAAO;SACR;QAED,IAAI,WAAmB,CAAC;QACxB,IAAI,OAAO,CAAC,QAAQ,qDAAqC,EAAE;YACzD,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;SAC5B;aAAM;YACL,WAAW,GAAG,OAAO,CAAC,yBAAyB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;SAC7E;QAED,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC;gBACnD,MAAM;YACR;gBACE,OAAO,CAAC,IAAI,CAAC,gBAAM,CAAC,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC;gBACvD,MAAM;YACR;gBACE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACzB,MAAM;YACR;gBACE,IAAI,IAAI,CAAC,mBAAmB,EAAE;oBAC5B,OAAO,CAAC,GAAG,CAAC,gBAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;iBACvC;gBACD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAClF;IACH,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,OAAyB;QAClD,MAAM,aAAa,GAA+B,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACxG,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QACD,QAAQ,OAAO,CAAC,QAAQ,EAAE;YACxB;gBACE,OAAO,IAAI,CAAC,oBAAoB,CAAC;YACnC;gBACE,OAAO,IAAI,CAAC,qBAAqB,CAAC;YACpC;gBACE,OAAO,IAAI,CAAC,iBAAiB,CAAC;YAChC;gBACE,MAAM,IAAI,iCAAa,CAAC,uEAAuE,CAAC,CAAC;SACpG;IACH,CAAC;IAED;;OAEG;IACK,sBAAsB,CAAC,QAA4B;QACzD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACrB,IAAI,IAAY,CAAC;YACjB,0BAA0B;YAC1B,IAAI,GAAG,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,OAAO,IAAI,CAAC;aACb;YACD,2BAA2B;YAC3B,IAAI,GAAG,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,OAAO,IAAI,CAAC;aACb;YACD,yBAAyB;YACzB,OAAO,wBAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC;;AAjmBH,sCAkmBC;AAjmBwB,8BAAgB,GACrC,8DAA8D,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport colors from 'colors';\nimport * as ts from 'typescript';\nimport * as tsdoc from '@microsoft/tsdoc';\nimport { Sort, InternalError } from '@rushstack/node-core-library';\n\nimport { AstDeclaration } from '../analyzer/AstDeclaration';\nimport { AstSymbol } from '../analyzer/AstSymbol';\nimport {\n  ExtractorMessage,\n  ExtractorMessageCategory,\n  IExtractorMessageOptions,\n  IExtractorMessageProperties\n} from '../api/ExtractorMessage';\nimport { ExtractorMessageId, allExtractorMessageIds } from '../api/ExtractorMessageId';\nimport { IExtractorMessagesConfig, IConfigMessageReportingRule } from '../api/IConfigFile';\nimport { SourceMapper } from './SourceMapper';\nimport { ExtractorLogLevel } from '../api/ExtractorLogLevel';\nimport { ConsoleMessageId } from '../api/ConsoleMessageId';\n\ninterface IReportingRule {\n  logLevel: ExtractorLogLevel;\n  addToApiReportFile: boolean;\n}\n\nexport interface IMessageRouterOptions {\n  workingPackageFolder: string | undefined;\n  messageCallback: ((message: ExtractorMessage) => void) | undefined;\n  messagesConfig: IExtractorMessagesConfig;\n  showVerboseMessages: boolean;\n  showDiagnostics: boolean;\n  tsdocConfiguration: tsdoc.TSDocConfiguration;\n}\n\nexport interface IBuildJsonDumpObjectOptions {\n  /**\n   * {@link MessageRouter.buildJsonDumpObject} will omit any objects keys with these names.\n   */\n  keyNamesToOmit?: string[];\n}\n\nexport class MessageRouter {\n  public static readonly DIAGNOSTICS_LINE: string =\n    '============================================================';\n\n  private readonly _workingPackageFolder: string | undefined;\n  private readonly _messageCallback: ((message: ExtractorMessage) => void) | undefined;\n\n  // All messages\n  private readonly _messages: ExtractorMessage[];\n\n  // For each AstDeclaration, the messages associated with it.  This is used when addToApiReportFile=true\n  private readonly _associatedMessagesForAstDeclaration: Map<AstDeclaration, ExtractorMessage[]>;\n\n  private readonly _sourceMapper: SourceMapper;\n\n  private readonly _tsdocConfiguration: tsdoc.TSDocConfiguration;\n\n  // Normalized representation of the routing rules from api-extractor.json\n  private _reportingRuleByMessageId: Map<string, IReportingRule> = new Map<string, IReportingRule>();\n  private _compilerDefaultRule: IReportingRule = {\n    logLevel: ExtractorLogLevel.None,\n    addToApiReportFile: false\n  };\n  private _extractorDefaultRule: IReportingRule = {\n    logLevel: ExtractorLogLevel.None,\n    addToApiReportFile: false\n  };\n  private _tsdocDefaultRule: IReportingRule = { logLevel: ExtractorLogLevel.None, addToApiReportFile: false };\n\n  public errorCount: number = 0;\n  public warningCount: number = 0;\n\n  /**\n   * See {@link IExtractorInvokeOptions.showVerboseMessages}\n   */\n  public readonly showVerboseMessages: boolean;\n\n  /**\n   * See {@link IExtractorInvokeOptions.showDiagnostics}\n   */\n  public readonly showDiagnostics: boolean;\n\n  public constructor(options: IMessageRouterOptions) {\n    this._workingPackageFolder = options.workingPackageFolder;\n    this._messageCallback = options.messageCallback;\n\n    this._messages = [];\n    this._associatedMessagesForAstDeclaration = new Map<AstDeclaration, ExtractorMessage[]>();\n    this._sourceMapper = new SourceMapper();\n    this._tsdocConfiguration = options.tsdocConfiguration;\n\n    // showDiagnostics implies showVerboseMessages\n    this.showVerboseMessages = options.showVerboseMessages || options.showDiagnostics;\n    this.showDiagnostics = options.showDiagnostics;\n\n    this._applyMessagesConfig(options.messagesConfig);\n  }\n\n  /**\n   * Read the api-extractor.json configuration and build up the tables of routing rules.\n   */\n  private _applyMessagesConfig(messagesConfig: IExtractorMessagesConfig): void {\n    if (messagesConfig.compilerMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.compilerMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.compilerMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._compilerDefaultRule = reportingRule;\n        } else if (!/^TS[0-9]+$/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.compilerMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\". The identifier format is \"TS\" followed by an integer.`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n\n    if (messagesConfig.extractorMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.extractorMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.extractorMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._extractorDefaultRule = reportingRule;\n        } else if (!/^ae-/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.extractorMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\".  The name should begin with the \"ae-\" prefix.`\n          );\n        } else if (!allExtractorMessageIds.has(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.extractorMessageReporting table contains` +\n              ` an unrecognized identifier \"${messageId}\".  Is it spelled correctly?`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n\n    if (messagesConfig.tsdocMessageReporting) {\n      for (const messageId of Object.getOwnPropertyNames(messagesConfig.tsdocMessageReporting)) {\n        const reportingRule: IReportingRule = MessageRouter._getNormalizedRule(\n          messagesConfig.tsdocMessageReporting[messageId]\n        );\n\n        if (messageId === 'default') {\n          this._tsdocDefaultRule = reportingRule;\n        } else if (!/^tsdoc-/.test(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.tsdocMessageReporting table contains` +\n              ` an invalid entry \"${messageId}\".  The name should begin with the \"tsdoc-\" prefix.`\n          );\n        } else if (!this._tsdocConfiguration.isKnownMessageId(messageId)) {\n          throw new Error(\n            `Error in API Extractor config: The messages.tsdocMessageReporting table contains` +\n              ` an unrecognized identifier \"${messageId}\".  Is it spelled correctly?`\n          );\n        } else {\n          this._reportingRuleByMessageId.set(messageId, reportingRule);\n        }\n      }\n    }\n  }\n\n  private static _getNormalizedRule(rule: IConfigMessageReportingRule): IReportingRule {\n    return {\n      logLevel: rule.logLevel || 'none',\n      addToApiReportFile: rule.addToApiReportFile || false\n    };\n  }\n\n  public get messages(): ReadonlyArray<ExtractorMessage> {\n    return this._messages;\n  }\n\n  /**\n   * Add a diagnostic message reported by the TypeScript compiler\n   */\n  public addCompilerDiagnostic(diagnostic: ts.Diagnostic): void {\n    switch (diagnostic.category) {\n      case ts.DiagnosticCategory.Suggestion:\n      case ts.DiagnosticCategory.Message:\n        return; // ignore noise\n    }\n\n    const messageText: string = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\\n');\n    const options: IExtractorMessageOptions = {\n      category: ExtractorMessageCategory.Compiler,\n      messageId: `TS${diagnostic.code}`,\n      text: messageText\n    };\n\n    if (diagnostic.file) {\n      const sourceFile: ts.SourceFile = diagnostic.file;\n      const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(\n        diagnostic.start || 0\n      );\n\n      options.sourceFilePath = sourceFile.fileName;\n      options.sourceFileLine = lineAndCharacter.line + 1;\n      options.sourceFileColumn = lineAndCharacter.character + 1;\n    }\n\n    // NOTE: Since compiler errors pertain to issues specific to the .d.ts files,\n    // we do not apply source mappings for them.\n    this._messages.push(new ExtractorMessage(options));\n  }\n\n  /**\n   * Add a message from the API Extractor analysis\n   */\n  public addAnalyzerIssue(\n    messageId: ExtractorMessageId,\n    messageText: string,\n    astDeclarationOrSymbol: AstDeclaration | AstSymbol,\n    properties?: IExtractorMessageProperties\n  ): void {\n    let astDeclaration: AstDeclaration;\n    if (astDeclarationOrSymbol instanceof AstDeclaration) {\n      astDeclaration = astDeclarationOrSymbol;\n    } else {\n      astDeclaration = astDeclarationOrSymbol.astDeclarations[0];\n    }\n\n    const extractorMessage: ExtractorMessage = this.addAnalyzerIssueForPosition(\n      messageId,\n      messageText,\n      astDeclaration.declaration.getSourceFile(),\n      astDeclaration.declaration.getStart(),\n      properties\n    );\n\n    this._associateMessageWithAstDeclaration(extractorMessage, astDeclaration);\n  }\n\n  /**\n   * Add all messages produced from an invocation of the TSDoc parser, assuming they refer to\n   * code in the specified source file.\n   */\n  public addTsdocMessages(\n    parserContext: tsdoc.ParserContext,\n    sourceFile: ts.SourceFile,\n    astDeclaration?: AstDeclaration\n  ): void {\n    for (const message of parserContext.log.messages) {\n      const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(\n        message.textRange.pos\n      );\n\n      const options: IExtractorMessageOptions = {\n        category: ExtractorMessageCategory.TSDoc,\n        messageId: message.messageId,\n        text: message.unformattedText,\n        sourceFilePath: sourceFile.fileName,\n        sourceFileLine: lineAndCharacter.line + 1,\n        sourceFileColumn: lineAndCharacter.character + 1\n      };\n\n      this._sourceMapper.updateExtractorMessageOptions(options);\n      const extractorMessage: ExtractorMessage = new ExtractorMessage(options);\n\n      if (astDeclaration) {\n        this._associateMessageWithAstDeclaration(extractorMessage, astDeclaration);\n      }\n\n      this._messages.push(extractorMessage);\n    }\n  }\n\n  /**\n   * Recursively collects the primitive members (numbers, strings, arrays, etc) into an object that\n   * is JSON serializable.  This is used by the \"--diagnostics\" feature to dump the state of configuration objects.\n   *\n   * @returns a JSON serializable object (possibly including `null` values)\n   *          or `undefined` if the input cannot be represented as JSON\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  public static buildJsonDumpObject(input: any, options?: IBuildJsonDumpObjectOptions): any | undefined {\n    if (!options) {\n      options = {};\n    }\n\n    const keyNamesToOmit: Set<string> = new Set(options.keyNamesToOmit);\n\n    return MessageRouter._buildJsonDumpObject(input, keyNamesToOmit);\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private static _buildJsonDumpObject(input: any, keyNamesToOmit: Set<string>): any | undefined {\n    if (input === null || input === undefined) {\n      return null; // JSON uses null instead of undefined\n    }\n\n    switch (typeof input) {\n      case 'boolean':\n      case 'number':\n      case 'string':\n        return input;\n      case 'object':\n        if (Array.isArray(input)) {\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const outputArray: any[] = [];\n          for (const element of input) {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            const serializedElement: any = MessageRouter._buildJsonDumpObject(element, keyNamesToOmit);\n            if (serializedElement !== undefined) {\n              outputArray.push(serializedElement);\n            }\n          }\n          return outputArray;\n        }\n\n        const outputObject: object = {};\n        for (const key of Object.getOwnPropertyNames(input)) {\n          if (keyNamesToOmit.has(key)) {\n            continue;\n          }\n\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const value: any = input[key];\n\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          const serializedValue: any = MessageRouter._buildJsonDumpObject(value, keyNamesToOmit);\n\n          if (serializedValue !== undefined) {\n            // eslint-disable-next-line @typescript-eslint/no-explicit-any\n            (outputObject as any)[key] = serializedValue;\n          }\n        }\n        return outputObject;\n    }\n\n    return undefined;\n  }\n\n  /**\n   * Record this message in  _associatedMessagesForAstDeclaration\n   */\n  private _associateMessageWithAstDeclaration(\n    extractorMessage: ExtractorMessage,\n    astDeclaration: AstDeclaration\n  ): void {\n    let associatedMessages: ExtractorMessage[] | undefined =\n      this._associatedMessagesForAstDeclaration.get(astDeclaration);\n\n    if (!associatedMessages) {\n      associatedMessages = [];\n      this._associatedMessagesForAstDeclaration.set(astDeclaration, associatedMessages);\n    }\n    associatedMessages.push(extractorMessage);\n  }\n\n  /**\n   * Add a message for a location in an arbitrary source file.\n   */\n  public addAnalyzerIssueForPosition(\n    messageId: ExtractorMessageId,\n    messageText: string,\n    sourceFile: ts.SourceFile,\n    pos: number,\n    properties?: IExtractorMessageProperties\n  ): ExtractorMessage {\n    const lineAndCharacter: ts.LineAndCharacter = sourceFile.getLineAndCharacterOfPosition(pos);\n\n    const options: IExtractorMessageOptions = {\n      category: ExtractorMessageCategory.Extractor,\n      messageId,\n      text: messageText,\n      sourceFilePath: sourceFile.fileName,\n      sourceFileLine: lineAndCharacter.line + 1,\n      sourceFileColumn: lineAndCharacter.character + 1,\n      properties\n    };\n\n    this._sourceMapper.updateExtractorMessageOptions(options);\n    const extractorMessage: ExtractorMessage = new ExtractorMessage(options);\n\n    this._messages.push(extractorMessage);\n    return extractorMessage;\n  }\n\n  /**\n   * This is used when writing the API report file.  It looks up any messages that were configured to get emitted\n   * in the API report file and returns them.  It also records that they were emitted, which suppresses them from\n   * being shown on the console.\n   */\n  public fetchAssociatedMessagesForReviewFile(astDeclaration: AstDeclaration): ExtractorMessage[] {\n    const messagesForApiReportFile: ExtractorMessage[] = [];\n\n    const associatedMessages: ExtractorMessage[] =\n      this._associatedMessagesForAstDeclaration.get(astDeclaration) || [];\n    for (const associatedMessage of associatedMessages) {\n      // Make sure we didn't already report this message for some reason\n      if (!associatedMessage.handled) {\n        // Is this message type configured to go in the API report file?\n        const reportingRule: IReportingRule = this._getRuleForMessage(associatedMessage);\n        if (reportingRule.addToApiReportFile) {\n          // Include it in the result, and record that it went to the API report file\n          messagesForApiReportFile.push(associatedMessage);\n          associatedMessage.handled = true;\n        }\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForApiReportFile);\n    return messagesForApiReportFile;\n  }\n\n  /**\n   * This returns all remaining messages that were flagged with `addToApiReportFile`, but which were not\n   * retreieved using `fetchAssociatedMessagesForReviewFile()`.\n   */\n  public fetchUnassociatedMessagesForReviewFile(): ExtractorMessage[] {\n    const messagesForApiReportFile: ExtractorMessage[] = [];\n\n    for (const unassociatedMessage of this.messages) {\n      // Make sure we didn't already report this message for some reason\n      if (!unassociatedMessage.handled) {\n        // Is this message type configured to go in the API report file?\n        const reportingRule: IReportingRule = this._getRuleForMessage(unassociatedMessage);\n        if (reportingRule.addToApiReportFile) {\n          // Include it in the result, and record that it went to the API report file\n          messagesForApiReportFile.push(unassociatedMessage);\n          unassociatedMessage.handled = true;\n        }\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForApiReportFile);\n    return messagesForApiReportFile;\n  }\n\n  /**\n   * This returns the list of remaining messages that were not already processed by\n   * `fetchAssociatedMessagesForReviewFile()` or `fetchUnassociatedMessagesForReviewFile()`.\n   * These messages will be shown on the console.\n   */\n  public handleRemainingNonConsoleMessages(): void {\n    const messagesForLogger: ExtractorMessage[] = [];\n\n    for (const message of this.messages) {\n      // Make sure we didn't already report this message\n      if (!message.handled) {\n        messagesForLogger.push(message);\n      }\n    }\n\n    this._sortMessagesForOutput(messagesForLogger);\n\n    for (const message of messagesForLogger) {\n      this._handleMessage(message);\n    }\n  }\n\n  public logError(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Error\n      })\n    );\n  }\n\n  public logWarning(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Warning\n      })\n    );\n  }\n\n  public logInfo(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Info\n      })\n    );\n  }\n\n  public logVerbose(\n    messageId: ConsoleMessageId,\n    message: string,\n    properties?: IExtractorMessageProperties\n  ): void {\n    this._handleMessage(\n      new ExtractorMessage({\n        category: ExtractorMessageCategory.Console,\n        messageId,\n        text: message,\n        properties,\n        logLevel: ExtractorLogLevel.Verbose\n      })\n    );\n  }\n\n  public logDiagnosticHeader(title: string): void {\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);\n    this.logDiagnostic(`DIAGNOSTIC: ` + title);\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE);\n  }\n\n  public logDiagnosticFooter(): void {\n    this.logDiagnostic(MessageRouter.DIAGNOSTICS_LINE + '\\n');\n  }\n\n  public logDiagnostic(message: string): void {\n    if (this.showDiagnostics) {\n      this.logVerbose(ConsoleMessageId.Diagnostics, message);\n    }\n  }\n\n  /**\n   * Give the calling application a chance to handle the `ExtractorMessage`, and if not, display it on the console.\n   */\n  private _handleMessage(message: ExtractorMessage): void {\n    // Don't tally messages that were already \"handled\" by writing them into the API report\n    if (message.handled) {\n      return;\n    }\n\n    // Assign the ExtractorMessage.logLevel; the message callback may adjust it below\n    if (message.category === ExtractorMessageCategory.Console) {\n      // Console messages have their category log level assigned via logInfo(), logVerbose(), etc.\n    } else {\n      const reportingRule: IReportingRule = this._getRuleForMessage(message);\n      message.logLevel = reportingRule.logLevel;\n    }\n\n    // If there is a callback, allow it to modify and/or handle the message\n    if (this._messageCallback) {\n      this._messageCallback(message);\n    }\n\n    // Update the statistics\n    switch (message.logLevel) {\n      case ExtractorLogLevel.Error:\n        ++this.errorCount;\n        break;\n      case ExtractorLogLevel.Warning:\n        ++this.warningCount;\n        break;\n    }\n\n    if (message.handled) {\n      return;\n    }\n\n    // The messageCallback did not handle the message, so perform default handling\n    message.handled = true;\n\n    if (message.logLevel === ExtractorLogLevel.None) {\n      return;\n    }\n\n    let messageText: string;\n    if (message.category === ExtractorMessageCategory.Console) {\n      messageText = message.text;\n    } else {\n      messageText = message.formatMessageWithLocation(this._workingPackageFolder);\n    }\n\n    switch (message.logLevel) {\n      case ExtractorLogLevel.Error:\n        console.error(colors.red('Error: ' + messageText));\n        break;\n      case ExtractorLogLevel.Warning:\n        console.warn(colors.yellow('Warning: ' + messageText));\n        break;\n      case ExtractorLogLevel.Info:\n        console.log(messageText);\n        break;\n      case ExtractorLogLevel.Verbose:\n        if (this.showVerboseMessages) {\n          console.log(colors.cyan(messageText));\n        }\n        break;\n      default:\n        throw new Error(`Invalid logLevel value: ${JSON.stringify(message.logLevel)}`);\n    }\n  }\n\n  /**\n   * For a given message, determine the IReportingRule based on the rule tables.\n   */\n  private _getRuleForMessage(message: ExtractorMessage): IReportingRule {\n    const reportingRule: IReportingRule | undefined = this._reportingRuleByMessageId.get(message.messageId);\n    if (reportingRule) {\n      return reportingRule;\n    }\n    switch (message.category) {\n      case ExtractorMessageCategory.Compiler:\n        return this._compilerDefaultRule;\n      case ExtractorMessageCategory.Extractor:\n        return this._extractorDefaultRule;\n      case ExtractorMessageCategory.TSDoc:\n        return this._tsdocDefaultRule;\n      case ExtractorMessageCategory.Console:\n        throw new InternalError('ExtractorMessageCategory.Console is not supported with IReportingRule');\n    }\n  }\n\n  /**\n   * Sorts an array of messages according to a reasonable ordering\n   */\n  private _sortMessagesForOutput(messages: ExtractorMessage[]): void {\n    messages.sort((a, b) => {\n      let diff: number;\n      // First sort by file name\n      diff = Sort.compareByValue(a.sourceFilePath, b.sourceFilePath);\n      if (diff !== 0) {\n        return diff;\n      }\n      // Then sort by line number\n      diff = Sort.compareByValue(a.sourceFileLine, b.sourceFileLine);\n      if (diff !== 0) {\n        return diff;\n      }\n      // Then sort by messageId\n      return Sort.compareByValue(a.messageId, b.messageId);\n    });\n  }\n}\n"]}

package/lib/enhancers/DocCommentEnhancer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocCommentEnhancer.d.ts","sourceRoot":"","sources":["../../src/enhancers/DocCommentEnhancer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AASnD,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;gBAEpB,SAAS,EAAE,SAAS;WAIzB,OAAO,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAK1C,OAAO,IAAI,IAAI;IAYtB,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,0BAA0B;IA4ElC,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,6BAA6B;IA4BrC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiDxB;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAe3B"}
+{"version":3,"file":"DocCommentEnhancer.d.ts","sourceRoot":"","sources":["../../src/enhancers/DocCommentEnhancer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AASnD,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;gBAEpB,SAAS,EAAE,SAAS;WAIzB,OAAO,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAK1C,OAAO,IAAI,IAAI;IAgBtB,OAAO,CAAC,eAAe;IA2BvB,OAAO,CAAC,0BAA0B;IA4ElC,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,6BAA6B;IA4BrC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiDxB;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAe3B"}

package/lib/enhancers/DocCommentEnhancer.js

@@ -43,7 +43,9 @@ class DocCommentEnhancer {
     analyze() {
         for (const entity of this._collector.entities) {
             if (entity.astEntity instanceof AstSymbol_1.AstSymbol) {
-                if (entity.consumable) {
+                if (entity.consumable ||
+                    this._collector.extractorConfig.apiReportIncludeForgottenExports ||
+                    this._collector.extractorConfig.docModelIncludeForgottenExports) {
                     entity.astEntity.forEachDeclarationRecursive((astDeclaration) => {
                         this._analyzeApiItem(astDeclaration);
                     });