@microsoft/api-extractor-model 7.21.0 → 7.22.0

package/dist/rollup.d.ts

@@ -641,6 +641,11 @@ export declare class ApiItem {
      * Otherwise undefined is returned.
      */
     getAssociatedPackage(): ApiPackage | undefined;
+    /**
+     * If this item is an ApiModel or has an ApiModel as one of its parents, then that object is returned.
+     * Otherwise undefined is returned.
+     */
+    getAssociatedModel(): ApiModel | undefined;
     /**
      * A text string whose value determines the sort order that is automatically applied by the
      * {@link (ApiItemContainerMixin:interface)} class.
@@ -737,6 +742,63 @@ export declare interface ApiItemContainerMixin extends ApiItem {
      * Returns a list of members with the specified name.
      */
     findMembersByName(name: string): ReadonlyArray<ApiItem>;
+    /**
+     * Finds all of the ApiItem's immediate and inherited members by walking up the inheritance tree.
+     *
+     * @remarks
+     *
+     * Given the following class heritage:
+     *
+     * ```
+     * export class A {
+     *   public a: number|boolean;
+     * }
+     *
+     * export class B extends A {
+     *   public a: number;
+     *   public b: string;
+     * }
+     *
+     * export class C extends B {
+     *   public c: boolean;
+     * }
+     * ```
+     *
+     * Calling `findMembersWithInheritance` on `C` will return `B.a`, `B.b`, and `C.c`. Calling the
+     * method on `B` will return `B.a` and `B.b`. And calling the method on `A` will return just
+     * `A.a`.
+     *
+     * The inherited members returned by this method may be incomplete. If so, there will be a flag
+     * on the result object indicating this as well as messages explaining the errors in more detail.
+     * Some scenarios include:
+     *
+     * - Interface extending from a type alias.
+     *
+     * - Class extending from a variable.
+     *
+     * - Extending from a declaration not present in the model (e.g. external package).
+     *
+     * - Extending from an unexported declaration (e.g. ae-forgotten-export). Common in mixin
+     *   patterns.
+     *
+     * - Unexpected runtime errors...
+     *
+     * Lastly, be aware that the types of inherited members are returned with respect to their
+     * defining class as opposed to with respect to the inheriting class. For example, consider
+     * the following:
+     *
+     * ```
+     * export class A<T> {
+     *   public a: T;
+     * }
+     *
+     * export class B extends A<number> {}
+     * ```
+     *
+     * When called on `B`, this method will return `B.a` with type `T` as opposed to type
+     * `number`, although the latter is more accurate.
+     */
+    findMembersWithInheritance(): IFindApiItemsResult;
     /**
      * For a given member of this container, return its `ApiItem.getMergedSiblings()` list.
      * @internal
@@ -1970,7 +2032,32 @@ export declare enum ExcerptTokenKind {
 }
 
 /**
- * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class.
+ * Unique identifiers for messages returned as part of `IFindApiItemsResult`.
+ * @beta
+ */
+export declare enum FindApiItemsMessageId {
+    /**
+     * "Declaration resolution failed for ___. Error message: ___."
+     */
+    DeclarationResolutionFailed = "declaration-resolution-failed",
+    /**
+     * "Unable to get the associated model of ___."
+     */
+    MissingApiModel = "missing-api-model",
+    /**
+     * "Encountered unexpected excerpt tokens in ___. Excerpt: ___."
+     */
+    UnexpectedExcerptTokens = "unexpected-excerpt-tokens",
+    /**
+     * Item ___ is of unsupported kind ___."
+     */
+    UnsupportedKind = "unsupported-kind"
+}
+
+/**
+ * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class
+ * or interface.
+ *
  * @remarks
  *
  * For example, consider this declaration:
@@ -2393,6 +2480,42 @@ export declare interface IExcerptTokenRange {
     endIndex: number;
 }
 
+/**
+ * This object is used for messages returned as part of `IFindApiItemsResult`.
+ * @public
+ */
+export declare interface IFindApiItemsMessage {
+    /**
+     * Unique identifier for the message.
+     * @beta
+     */
+    messageId: FindApiItemsMessageId;
+    /**
+     * Text description of the message.
+     */
+    text: string;
+}
+
+/**
+ * Generic result object for finding API items used by different kinds of find operations.
+ * @public
+ */
+export declare interface IFindApiItemsResult {
+    /**
+     * The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.
+     */
+    items: ApiItem[];
+    /**
+     * Diagnostic messages regarding the find operation.
+     */
+    messages: IFindApiItemsMessage[];
+    /**
+     * Indicates whether the result is potentially incomplete due to errors during the find operation.
+     * If true, the `messages` explain the errors in more detail.
+     */
+    maybeIncompleteResult: boolean;
+}
+
 /**
  * Constructor options for {@link Parameter}.
  * @public

package/lib/index.d.ts

@@ -23,6 +23,7 @@ export { IApiNameMixinOptions, ApiNameMixin } from './mixins/ApiNameMixin';
 export { IApiOptionalMixinOptions, ApiOptionalMixin } from './mixins/ApiOptionalMixin';
 export { IApiReadonlyMixinOptions, ApiReadonlyMixin } from './mixins/ApiReadonlyMixin';
 export { IApiInitializerMixinOptions, ApiInitializerMixin } from './mixins/ApiInitializerMixin';
+export { IFindApiItemsResult, IFindApiItemsMessage, FindApiItemsMessageId } from './mixins/IFindApiItemsResult';
 export { ExcerptTokenKind, IExcerptTokenRange, IExcerptToken, ExcerptToken, Excerpt } from './mixins/Excerpt';
 export { Constructor, PropertiesOf } from './mixins/Mixin';
 export { IApiCallSignatureOptions, ApiCallSignature } from './model/ApiCallSignature';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC7F,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAGnF,OAAO,EACL,6BAA6B,EAC7B,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACtG,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEhG,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC9G,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACrG,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9F,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,4BAA4B,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC7F,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAGnF,OAAO,EACL,6BAA6B,EAC7B,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACtG,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACvF,OAAO,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAChG,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC9G,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACrG,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9F,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,4BAA4B,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}

package/lib/index.js

@@ -2,7 +2,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeritageType = exports.ApiVariable = exports.TypeParameter = exports.ApiTypeAlias = exports.ApiPropertySignature = exports.ApiProperty = exports.Parameter = exports.ApiPackage = exports.ApiNamespace = exports.ApiModel = exports.ApiMethodSignature = exports.ApiMethod = exports.ApiInterface = exports.ApiIndexSignature = exports.ApiFunction = exports.EnumMemberOrder = exports.ApiEnumMember = exports.ApiEnum = exports.ApiEntryPoint = exports.ApiConstructSignature = exports.ApiConstructor = exports.ApiClass = exports.ApiCallSignature = exports.Excerpt = exports.ExcerptToken = exports.ExcerptTokenKind = exports.ApiInitializerMixin = exports.ApiReadonlyMixin = exports.ApiOptionalMixin = exports.ApiNameMixin = exports.ApiStaticMixin = exports.ApiReturnTypeMixin = exports.ApiReleaseTagMixin = exports.ApiProtectedMixin = exports.ApiItemContainerMixin = exports.ApiTypeParameterListMixin = exports.ApiParameterListMixin = exports.ApiPropertyItem = exports.ApiItem = exports.ApiItemKind = exports.ApiDocumentedItem = exports.ApiDeclaredItem = exports.ReleaseTag = exports.AedocDefinitions = void 0;
+exports.HeritageType = exports.ApiVariable = exports.TypeParameter = exports.ApiTypeAlias = exports.ApiPropertySignature = exports.ApiProperty = exports.Parameter = exports.ApiPackage = exports.ApiNamespace = exports.ApiModel = exports.ApiMethodSignature = exports.ApiMethod = exports.ApiInterface = exports.ApiIndexSignature = exports.ApiFunction = exports.EnumMemberOrder = exports.ApiEnumMember = exports.ApiEnum = exports.ApiEntryPoint = exports.ApiConstructSignature = exports.ApiConstructor = exports.ApiClass = exports.ApiCallSignature = exports.Excerpt = exports.ExcerptToken = exports.ExcerptTokenKind = exports.FindApiItemsMessageId = exports.ApiInitializerMixin = exports.ApiReadonlyMixin = exports.ApiOptionalMixin = exports.ApiNameMixin = exports.ApiStaticMixin = exports.ApiReturnTypeMixin = exports.ApiReleaseTagMixin = exports.ApiProtectedMixin = exports.ApiItemContainerMixin = exports.ApiTypeParameterListMixin = exports.ApiParameterListMixin = exports.ApiPropertyItem = exports.ApiItem = exports.ApiItemKind = exports.ApiDocumentedItem = exports.ApiDeclaredItem = exports.ReleaseTag = exports.AedocDefinitions = void 0;
 /**
  * Use this library to read and write *.api.json files as defined by the
  * {@link https://api-extractor.com/ | API Extractor}  tool.  These files are used to generate a documentation
@@ -48,6 +48,8 @@ var ApiReadonlyMixin_1 = require("./mixins/ApiReadonlyMixin");
 Object.defineProperty(exports, "ApiReadonlyMixin", { enumerable: true, get: function () { return ApiReadonlyMixin_1.ApiReadonlyMixin; } });
 var ApiInitializerMixin_1 = require("./mixins/ApiInitializerMixin");
 Object.defineProperty(exports, "ApiInitializerMixin", { enumerable: true, get: function () { return ApiInitializerMixin_1.ApiInitializerMixin; } });
+var IFindApiItemsResult_1 = require("./mixins/IFindApiItemsResult");
+Object.defineProperty(exports, "FindApiItemsMessageId", { enumerable: true, get: function () { return IFindApiItemsResult_1.FindApiItemsMessageId; } });
 var Excerpt_1 = require("./mixins/Excerpt");
 Object.defineProperty(exports, "ExcerptTokenKind", { enumerable: true, get: function () { return Excerpt_1.ExcerptTokenKind; } });
 Object.defineProperty(exports, "ExcerptToken", { enumerable: true, get: function () { return Excerpt_1.ExcerptToken; } });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;;;GAOG;AAEH,6DAA4D;AAAnD,oHAAA,gBAAgB,OAAA;AACzB,iDAAgD;AAAvC,wGAAA,UAAU,OAAA;AAEnB,QAAQ;AACR,2DAAmF;AAAjD,kHAAA,eAAe,OAAA;AACjD,+DAAyF;AAArD,sHAAA,iBAAiB,OAAA;AACrD,2CAA6F;AAApF,sGAAA,WAAW,OAAA;AAAmB,kGAAA,OAAO,OAAA;AAC9C,2DAAmF;AAAjD,kHAAA,eAAe,OAAA;AAEjD,SAAS;AACT,wEAIwC;AADtC,8HAAA,qBAAqB,OAAA;AAEvB,gFAI4C;AAD1C,sIAAA,yBAAyB,OAAA;AAE3B,wEAAsG;AAA9D,8HAAA,qBAAqB,OAAA;AAC7D,gEAA0F;AAAtD,sHAAA,iBAAiB,OAAA;AACrD,kEAA6F;AAAxD,wHAAA,kBAAkB,OAAA;AACvD,kEAA6F;AAAxD,wHAAA,kBAAkB,OAAA;AACvD,0DAAiF;AAAhD,gHAAA,cAAc,OAAA;AAC/C,sDAA2E;AAA5C,4GAAA,YAAY,OAAA;AAC3C,8DAAuF;AAApD,oHAAA,gBAAgB,OAAA;AACnD,8DAAuF;AAApD,oHAAA,gBAAgB,OAAA;AACnD,oEAAgG;AAA1D,0HAAA,mBAAmB,OAAA;AAEzD,4CAA8G;AAArG,2GAAA,gBAAgB,OAAA;AAAqC,uGAAA,YAAY,OAAA;AAAE,kGAAA,OAAO,OAAA;AAGnF,QAAQ;AACR,6DAAsF;AAAnD,oHAAA,gBAAgB,OAAA;AACnD,6CAA8D;AAAnC,oGAAA,QAAQ,OAAA;AACnC,yDAAgF;AAA/C,gHAAA,cAAc,OAAA;AAC/C,uEAAqG;AAA7D,8HAAA,qBAAqB,OAAA;AAC7D,uDAA6E;AAA7C,8GAAA,aAAa,OAAA;AAC7C,2CAA2D;AAAjC,kGAAA,OAAO,OAAA;AACjC,uDAA8F;AAA9D,8GAAA,aAAa,OAAA;AAAE,gHAAA,eAAe,OAAA;AAC9D,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AACzC,+DAAyF;AAArD,sHAAA,iBAAiB,OAAA;AACrD,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,+CAAiE;AAArC,sGAAA,SAAS,OAAA;AACrC,iEAA4F;AAAvD,wHAAA,kBAAkB,OAAA;AACvD,6CAA4C;AAAnC,oGAAA,QAAQ,OAAA;AACjB,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,iDAA4F;AAA/D,wGAAA,UAAU,OAAA;AACvC,+CAAiE;AAArC,sGAAA,SAAS,OAAA;AACrC,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AACzC,qEAAkG;AAA3D,4HAAA,oBAAoB,OAAA;AAC3D,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,uDAA6E;AAA7C,8GAAA,aAAa,OAAA;AAC7C,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AAEzC,qDAAoD;AAA3C,4GAAA,YAAY,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Use this library to read and write *.api.json files as defined by the\n * {@link https://api-extractor.com/ | API Extractor}  tool.  These files are used to generate a documentation\n * website for your TypeScript package.  The files store the API signatures and doc comments that were extracted\n * from your package.\n *\n * @packageDocumentation\n */\n\nexport { AedocDefinitions } from './aedoc/AedocDefinitions';\nexport { ReleaseTag } from './aedoc/ReleaseTag';\n\n// items\nexport { IApiDeclaredItemOptions, ApiDeclaredItem } from './items/ApiDeclaredItem';\nexport { IApiDocumentedItemOptions, ApiDocumentedItem } from './items/ApiDocumentedItem';\nexport { ApiItemKind, IApiItemOptions, ApiItem, IApiItemConstructor } from './items/ApiItem';\nexport { IApiPropertyItemOptions, ApiPropertyItem } from './items/ApiPropertyItem';\n\n// mixins\nexport {\n  IApiParameterListMixinOptions,\n  IApiParameterOptions,\n  ApiParameterListMixin\n} from './mixins/ApiParameterListMixin';\nexport {\n  IApiTypeParameterOptions,\n  IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from './mixins/ApiTypeParameterListMixin';\nexport { IApiItemContainerMixinOptions, ApiItemContainerMixin } from './mixins/ApiItemContainerMixin';\nexport { IApiProtectedMixinOptions, ApiProtectedMixin } from './mixins/ApiProtectedMixin';\nexport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin';\nexport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from './mixins/ApiReturnTypeMixin';\nexport { IApiStaticMixinOptions, ApiStaticMixin } from './mixins/ApiStaticMixin';\nexport { IApiNameMixinOptions, ApiNameMixin } from './mixins/ApiNameMixin';\nexport { IApiOptionalMixinOptions, ApiOptionalMixin } from './mixins/ApiOptionalMixin';\nexport { IApiReadonlyMixinOptions, ApiReadonlyMixin } from './mixins/ApiReadonlyMixin';\nexport { IApiInitializerMixinOptions, ApiInitializerMixin } from './mixins/ApiInitializerMixin';\n\nexport { ExcerptTokenKind, IExcerptTokenRange, IExcerptToken, ExcerptToken, Excerpt } from './mixins/Excerpt';\nexport { Constructor, PropertiesOf } from './mixins/Mixin';\n\n// model\nexport { IApiCallSignatureOptions, ApiCallSignature } from './model/ApiCallSignature';\nexport { IApiClassOptions, ApiClass } from './model/ApiClass';\nexport { IApiConstructorOptions, ApiConstructor } from './model/ApiConstructor';\nexport { IApiConstructSignatureOptions, ApiConstructSignature } from './model/ApiConstructSignature';\nexport { IApiEntryPointOptions, ApiEntryPoint } from './model/ApiEntryPoint';\nexport { IApiEnumOptions, ApiEnum } from './model/ApiEnum';\nexport { IApiEnumMemberOptions, ApiEnumMember, EnumMemberOrder } from './model/ApiEnumMember';\nexport { IApiFunctionOptions, ApiFunction } from './model/ApiFunction';\nexport { IApiIndexSignatureOptions, ApiIndexSignature } from './model/ApiIndexSignature';\nexport { IApiInterfaceOptions, ApiInterface } from './model/ApiInterface';\nexport { IApiMethodOptions, ApiMethod } from './model/ApiMethod';\nexport { IApiMethodSignatureOptions, ApiMethodSignature } from './model/ApiMethodSignature';\nexport { ApiModel } from './model/ApiModel';\nexport { IApiNamespaceOptions, ApiNamespace } from './model/ApiNamespace';\nexport { IApiPackageOptions, ApiPackage, IApiPackageSaveOptions } from './model/ApiPackage';\nexport { IParameterOptions, Parameter } from './model/Parameter';\nexport { IApiPropertyOptions, ApiProperty } from './model/ApiProperty';\nexport { IApiPropertySignatureOptions, ApiPropertySignature } from './model/ApiPropertySignature';\nexport { IApiTypeAliasOptions, ApiTypeAlias } from './model/ApiTypeAlias';\nexport { ITypeParameterOptions, TypeParameter } from './model/TypeParameter';\nexport { IApiVariableOptions, ApiVariable } from './model/ApiVariable';\nexport { IResolveDeclarationReferenceResult } from './model/ModelReferenceResolver';\nexport { HeritageType } from './model/HeritageType';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;;;GAOG;AAEH,6DAA4D;AAAnD,oHAAA,gBAAgB,OAAA;AACzB,iDAAgD;AAAvC,wGAAA,UAAU,OAAA;AAEnB,QAAQ;AACR,2DAAmF;AAAjD,kHAAA,eAAe,OAAA;AACjD,+DAAyF;AAArD,sHAAA,iBAAiB,OAAA;AACrD,2CAA6F;AAApF,sGAAA,WAAW,OAAA;AAAmB,kGAAA,OAAO,OAAA;AAC9C,2DAAmF;AAAjD,kHAAA,eAAe,OAAA;AAEjD,SAAS;AACT,wEAIwC;AADtC,8HAAA,qBAAqB,OAAA;AAEvB,gFAI4C;AAD1C,sIAAA,yBAAyB,OAAA;AAE3B,wEAAsG;AAA9D,8HAAA,qBAAqB,OAAA;AAC7D,gEAA0F;AAAtD,sHAAA,iBAAiB,OAAA;AACrD,kEAA6F;AAAxD,wHAAA,kBAAkB,OAAA;AACvD,kEAA6F;AAAxD,wHAAA,kBAAkB,OAAA;AACvD,0DAAiF;AAAhD,gHAAA,cAAc,OAAA;AAC/C,sDAA2E;AAA5C,4GAAA,YAAY,OAAA;AAC3C,8DAAuF;AAApD,oHAAA,gBAAgB,OAAA;AACnD,8DAAuF;AAApD,oHAAA,gBAAgB,OAAA;AACnD,oEAAgG;AAA1D,0HAAA,mBAAmB,OAAA;AACzD,oEAIsC;AADpC,4HAAA,qBAAqB,OAAA;AAGvB,4CAA8G;AAArG,2GAAA,gBAAgB,OAAA;AAAqC,uGAAA,YAAY,OAAA;AAAE,kGAAA,OAAO,OAAA;AAGnF,QAAQ;AACR,6DAAsF;AAAnD,oHAAA,gBAAgB,OAAA;AACnD,6CAA8D;AAAnC,oGAAA,QAAQ,OAAA;AACnC,yDAAgF;AAA/C,gHAAA,cAAc,OAAA;AAC/C,uEAAqG;AAA7D,8HAAA,qBAAqB,OAAA;AAC7D,uDAA6E;AAA7C,8GAAA,aAAa,OAAA;AAC7C,2CAA2D;AAAjC,kGAAA,OAAO,OAAA;AACjC,uDAA8F;AAA9D,8GAAA,aAAa,OAAA;AAAE,gHAAA,eAAe,OAAA;AAC9D,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AACzC,+DAAyF;AAArD,sHAAA,iBAAiB,OAAA;AACrD,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,+CAAiE;AAArC,sGAAA,SAAS,OAAA;AACrC,iEAA4F;AAAvD,wHAAA,kBAAkB,OAAA;AACvD,6CAA4C;AAAnC,oGAAA,QAAQ,OAAA;AACjB,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,iDAA4F;AAA/D,wGAAA,UAAU,OAAA;AACvC,+CAAiE;AAArC,sGAAA,SAAS,OAAA;AACrC,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AACzC,qEAAkG;AAA3D,4HAAA,oBAAoB,OAAA;AAC3D,qDAA0E;AAA3C,4GAAA,YAAY,OAAA;AAC3C,uDAA6E;AAA7C,8GAAA,aAAa,OAAA;AAC7C,mDAAuE;AAAzC,0GAAA,WAAW,OAAA;AAEzC,qDAAoD;AAA3C,4GAAA,YAAY,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Use this library to read and write *.api.json files as defined by the\n * {@link https://api-extractor.com/ | API Extractor}  tool.  These files are used to generate a documentation\n * website for your TypeScript package.  The files store the API signatures and doc comments that were extracted\n * from your package.\n *\n * @packageDocumentation\n */\n\nexport { AedocDefinitions } from './aedoc/AedocDefinitions';\nexport { ReleaseTag } from './aedoc/ReleaseTag';\n\n// items\nexport { IApiDeclaredItemOptions, ApiDeclaredItem } from './items/ApiDeclaredItem';\nexport { IApiDocumentedItemOptions, ApiDocumentedItem } from './items/ApiDocumentedItem';\nexport { ApiItemKind, IApiItemOptions, ApiItem, IApiItemConstructor } from './items/ApiItem';\nexport { IApiPropertyItemOptions, ApiPropertyItem } from './items/ApiPropertyItem';\n\n// mixins\nexport {\n  IApiParameterListMixinOptions,\n  IApiParameterOptions,\n  ApiParameterListMixin\n} from './mixins/ApiParameterListMixin';\nexport {\n  IApiTypeParameterOptions,\n  IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from './mixins/ApiTypeParameterListMixin';\nexport { IApiItemContainerMixinOptions, ApiItemContainerMixin } from './mixins/ApiItemContainerMixin';\nexport { IApiProtectedMixinOptions, ApiProtectedMixin } from './mixins/ApiProtectedMixin';\nexport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin';\nexport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from './mixins/ApiReturnTypeMixin';\nexport { IApiStaticMixinOptions, ApiStaticMixin } from './mixins/ApiStaticMixin';\nexport { IApiNameMixinOptions, ApiNameMixin } from './mixins/ApiNameMixin';\nexport { IApiOptionalMixinOptions, ApiOptionalMixin } from './mixins/ApiOptionalMixin';\nexport { IApiReadonlyMixinOptions, ApiReadonlyMixin } from './mixins/ApiReadonlyMixin';\nexport { IApiInitializerMixinOptions, ApiInitializerMixin } from './mixins/ApiInitializerMixin';\nexport {\n  IFindApiItemsResult,\n  IFindApiItemsMessage,\n  FindApiItemsMessageId\n} from './mixins/IFindApiItemsResult';\n\nexport { ExcerptTokenKind, IExcerptTokenRange, IExcerptToken, ExcerptToken, Excerpt } from './mixins/Excerpt';\nexport { Constructor, PropertiesOf } from './mixins/Mixin';\n\n// model\nexport { IApiCallSignatureOptions, ApiCallSignature } from './model/ApiCallSignature';\nexport { IApiClassOptions, ApiClass } from './model/ApiClass';\nexport { IApiConstructorOptions, ApiConstructor } from './model/ApiConstructor';\nexport { IApiConstructSignatureOptions, ApiConstructSignature } from './model/ApiConstructSignature';\nexport { IApiEntryPointOptions, ApiEntryPoint } from './model/ApiEntryPoint';\nexport { IApiEnumOptions, ApiEnum } from './model/ApiEnum';\nexport { IApiEnumMemberOptions, ApiEnumMember, EnumMemberOrder } from './model/ApiEnumMember';\nexport { IApiFunctionOptions, ApiFunction } from './model/ApiFunction';\nexport { IApiIndexSignatureOptions, ApiIndexSignature } from './model/ApiIndexSignature';\nexport { IApiInterfaceOptions, ApiInterface } from './model/ApiInterface';\nexport { IApiMethodOptions, ApiMethod } from './model/ApiMethod';\nexport { IApiMethodSignatureOptions, ApiMethodSignature } from './model/ApiMethodSignature';\nexport { ApiModel } from './model/ApiModel';\nexport { IApiNamespaceOptions, ApiNamespace } from './model/ApiNamespace';\nexport { IApiPackageOptions, ApiPackage, IApiPackageSaveOptions } from './model/ApiPackage';\nexport { IParameterOptions, Parameter } from './model/Parameter';\nexport { IApiPropertyOptions, ApiProperty } from './model/ApiProperty';\nexport { IApiPropertySignatureOptions, ApiPropertySignature } from './model/ApiPropertySignature';\nexport { IApiTypeAliasOptions, ApiTypeAlias } from './model/ApiTypeAlias';\nexport { ITypeParameterOptions, TypeParameter } from './model/TypeParameter';\nexport { IApiVariableOptions, ApiVariable } from './model/ApiVariable';\nexport { IResolveDeclarationReferenceResult } from './model/ModelReferenceResolver';\nexport { HeritageType } from './model/HeritageType';\n"]}

package/lib/items/ApiItem.d.ts

@@ -2,6 +2,7 @@ import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/Declara
 import { Constructor, PropertiesOf } from '../mixins/Mixin';
 import { ApiPackage } from '../model/ApiPackage';
 import { DeserializerContext } from '../model/DeserializerContext';
+import { ApiModel } from '../model/ApiModel';
 /**
  * The type returned by the {@link ApiItem.kind} property, which can be used to easily distinguish subclasses of
  * {@link ApiItem}.
@@ -136,6 +137,11 @@ export declare class ApiItem {
      * Otherwise undefined is returned.
      */
     getAssociatedPackage(): ApiPackage | undefined;
+    /**
+     * If this item is an ApiModel or has an ApiModel as one of its parents, then that object is returned.
+     * Otherwise undefined is returned.
+     */
+    getAssociatedModel(): ApiModel | undefined;
     /**
      * A text string whose value determines the sort order that is automatically applied by the
      * {@link (ApiItemContainerMixin:interface)} class.

package/lib/items/ApiItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiItem.d.ts","sourceRoot":"","sources":["../../src/items/ApiItem.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAInE;;;;;GAKG;AACH,oBAAY,WAAW;IACrB,aAAa,kBAAkB;IAC/B,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,kBAAkB,uBAAuB;IACzC,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAID,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAA4C,CAAC;AAE1F;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAmC;IAC9D,OAAO,CAAC,OAAO,CAAsB;gBAElB,OAAO,EAAE,eAAe;WAI7B,WAAW,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO;IAO1F,eAAe;WACD,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,EACjC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,YAAY,GACvB,IAAI;IAIP,eAAe;IACR,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAK7D;;;OAGG;IACH,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED;;;;;;;;OAQG;IACH,IAAW,kBAAkB,IAAI,oBAAoB,CAUpD;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;;;;;;OAQG;IACH,IAAW,WAAW,IAAI,MAAM,CAc/B;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,OAAO,GAAG,SAAS,CAEvC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAE3C;IAED;;;;;;;;;OASG;IACI,iBAAiB,IAAI,aAAa,CAAC,OAAO,CAAC;IAQlD;;OAEG;IACI,YAAY,IAAI,aAAa,CAAC,OAAO,CAAC;IAS7C;;;;;;OAMG;IACI,0BAA0B,IAAI,MAAM;IAiC3C;;;OAGG;IACI,oBAAoB,IAAI,UAAU,GAAG,SAAS;IASrD;;;;;;;;;;OAUG;IACI,UAAU,IAAI,MAAM;IAI3B;;;;;;;OAOG;IACI,CAAC,uBAAuB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAKnE;;;OAGG;IACH,SAAS,CAAC,uBAAuB,IAAI,oBAAoB;CAG1D;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,OAAO,CAAC;CAAG"}
+{"version":3,"file":"ApiItem.d.ts","sourceRoot":"","sources":["../../src/items/ApiItem.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAGnE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;;GAKG;AACH,oBAAY,WAAW;IACrB,aAAa,kBAAkB;IAC/B,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,kBAAkB,uBAAuB;IACzC,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAID,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAA4C,CAAC;AAE1F;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAmC;IAC9D,OAAO,CAAC,OAAO,CAAsB;gBAElB,OAAO,EAAE,eAAe;WAI7B,WAAW,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO;IAO1F,eAAe;WACD,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,EACjC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,YAAY,GACvB,IAAI;IAIP,eAAe;IACR,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAK7D;;;OAGG;IACH,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED;;;;;;;;OAQG;IACH,IAAW,kBAAkB,IAAI,oBAAoB,CAUpD;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;;;;;;OAQG;IACH,IAAW,WAAW,IAAI,MAAM,CAc/B;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,OAAO,GAAG,SAAS,CAEvC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAE3C;IAED;;;;;;;;;OASG;IACI,iBAAiB,IAAI,aAAa,CAAC,OAAO,CAAC;IAQlD;;OAEG;IACI,YAAY,IAAI,aAAa,CAAC,OAAO,CAAC;IAS7C;;;;;;OAMG;IACI,0BAA0B,IAAI,MAAM;IAiC3C;;;OAGG;IACI,oBAAoB,IAAI,UAAU,GAAG,SAAS;IASrD;;;OAGG;IACI,kBAAkB,IAAI,QAAQ,GAAG,SAAS;IASjD;;;;;;;;;;OAUG;IACI,UAAU,IAAI,MAAM;IAI3B;;;;;;;OAOG;IACI,CAAC,uBAAuB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAKnE;;;OAGG;IACH,SAAS,CAAC,uBAAuB,IAAI,oBAAoB;CAG1D;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,OAAO,CAAC;CAAG"}

package/lib/items/ApiItem.js

@@ -224,6 +224,18 @@ class ApiItem {
         }
         return undefined;
     }
+    /**
+     * If this item is an ApiModel or has an ApiModel as one of its parents, then that object is returned.
+     * Otherwise undefined is returned.
+     */
+    getAssociatedModel() {
+        for (let current = this; current !== undefined; current = current.parent) {
+            if (current.kind === ApiItemKind.Model) {
+                return current;
+            }
+        }
+        return undefined;
+    }
     /**
      * A text string whose value determines the sort order that is automatically applied by the
      * {@link (ApiItemContainerMixin:interface)} class.

package/lib/items/ApiItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiItem.js","sourceRoot":"","sources":["../../src/items/ApiItem.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAK3D,2EAAwE;AAExE,oEAA6D;AAC7D,2EAAwE;AAExE;;;;;GAKG;AACH,IAAY,WAqBX;AArBD,WAAY,WAAW;IACrB,8CAA+B,CAAA;IAC/B,8BAAe,CAAA;IACf,0CAA2B,CAAA;IAC3B,wDAAyC,CAAA;IACzC,wCAAyB,CAAA;IACzB,4BAAa,CAAA;IACb,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;IACrB,gDAAiC,CAAA;IACjC,sCAAuB,CAAA;IACvB,gCAAiB,CAAA;IACjB,kDAAmC,CAAA;IACnC,8BAAe,CAAA;IACf,sCAAuB,CAAA;IACvB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,sDAAuC,CAAA;IACvC,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,4BAAa,CAAA;AACf,CAAC,EArBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAqBtB;AAaD,+DAA+D;AAC/D,EAAE;AACW,QAAA,uBAAuB,GAAkB,MAAM,CAAC,2BAA2B,CAAC,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAa,OAAO;IAIlB,YAAmB,OAAwB;QACzC,oEAAoE;IACtE,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAwB,EAAE,OAA4B;QAC9E,yFAAyF;QACzF,iCAAiC;QACjC,MAAM,kBAAkB,GAA2C,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACpG,OAAO,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED,eAAe;IACR,MAAM,CAAC,iBAAiB,CAC7B,OAAiC,EACjC,OAA4B,EAC5B,UAAwB;QAExB,8BAA8B;IAChC,CAAC;IAED,eAAe;IACR,aAAa,CAAC,UAAiC;QACpD,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IACrE,CAAC;IAED;;;OAGG;IACH,IAAW,IAAI;QACb,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,kBAAkB;QAC3B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,IAAI;gBACF,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;aAC3D;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,GAAW,IAAI,CAAC,0BAA0B,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC;gBAC3E,MAAM,IAAI,iCAAa,CAAC,0CAA0C,IAAI,KAAK,GAAI,CAAW,CAAC,OAAO,CAAC,CAAC;aACrG;SACF;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY;QACrB,MAAM,IAAI,iCAAa,CAAC,6DAA6D,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,WAAW;QACpB,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,WAAW,CAAC,aAAa;gBAC5B,OAAO,QAAQ,CAAC;YAClB,KAAK,WAAW,CAAC,WAAW;gBAC1B,OAAO,eAAe,CAAC;YACzB,KAAK,WAAW,CAAC,kBAAkB;gBACjC,OAAO,OAAO,CAAC;YACjB,KAAK,WAAW,CAAC,cAAc;gBAC7B,OAAO,WAAW,CAAC;YACrB,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,OAAO,CAAC,CAAC,gFAAgF;IAClG,CAAC;IAED;;;;;OAKG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,IAAW,OAAO;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;OASG;IACI,iBAAiB;QACtB,MAAM,MAAM,GAAwB,IAAI,CAAC,OAAO,CAAC;QACjD,IAAI,MAAM,IAAI,6CAAqB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;YACzD,OAAO,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;SACjD;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,MAAM,SAAS,GAAc,EAAE,CAAC;QAChC,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACzB;QACD,SAAS,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACI,0BAA0B;QAC/B,MAAM,aAAa,GAAa,EAAE,CAAC;QAEnC,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,IACE,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK;gBAClC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO;gBACpC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,UAAU,EACvC;gBACA,MAAM;aACP;YACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC9B,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;iBAAM;gBACL,QAAQ,OAAO,CAAC,IAAI,EAAE;oBACpB,KAAK,WAAW,CAAC,aAAa,CAAC;oBAC/B,KAAK,WAAW,CAAC,kBAAkB,CAAC;oBACpC,KAAK,WAAW,CAAC,WAAW,CAAC;oBAC7B,KAAK,WAAW,CAAC,cAAc;wBAC7B,sFAAsF;wBACtF,MAAM;oBACR;wBACE,IAAI,6CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;4BAChD,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;yBAC1B;iBACJ;aACF;YACD,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACzC;QAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,oBAAoB;QACzB,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE;gBACxC,OAAO,OAAqB,CAAC;aAC9B;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;;OAOG;IACI,CAAC,+BAAuB,CAAC,CAAC,MAA2B;QAC1D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;IACvC,CAAC;IAED;;;OAGG;IACO,uBAAuB;QAC/B,MAAM,IAAI,iCAAa,CAAC,mEAAmE,CAAC,CAAC;IAC/F,CAAC;CACF;AA5OD,0BA4OC","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 { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\nimport { Constructor, PropertiesOf } from '../mixins/Mixin';\nimport { ApiPackage } from '../model/ApiPackage';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\nimport { DeserializerContext } from '../model/DeserializerContext';\nimport { InternalError } from '@rushstack/node-core-library';\nimport { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';\n\n/**\n * The type returned by the {@link ApiItem.kind} property, which can be used to easily distinguish subclasses of\n * {@link ApiItem}.\n *\n * @public\n */\nexport enum ApiItemKind {\n  CallSignature = 'CallSignature',\n  Class = 'Class',\n  Constructor = 'Constructor',\n  ConstructSignature = 'ConstructSignature',\n  EntryPoint = 'EntryPoint',\n  Enum = 'Enum',\n  EnumMember = 'EnumMember',\n  Function = 'Function',\n  IndexSignature = 'IndexSignature',\n  Interface = 'Interface',\n  Method = 'Method',\n  MethodSignature = 'MethodSignature',\n  Model = 'Model',\n  Namespace = 'Namespace',\n  Package = 'Package',\n  Property = 'Property',\n  PropertySignature = 'PropertySignature',\n  TypeAlias = 'TypeAlias',\n  Variable = 'Variable',\n  None = 'None'\n}\n\n/**\n * Constructor options for {@link ApiItem}.\n * @public\n */\nexport interface IApiItemOptions {}\n\nexport interface IApiItemJson {\n  kind: ApiItemKind;\n  canonicalReference: string;\n}\n\n// PRIVATE - Allows ApiItemContainerMixin to assign the parent.\n//\nexport const apiItem_onParentChanged: unique symbol = Symbol('ApiItem._onAddToContainer');\n\n/**\n * The abstract base class for all members of an `ApiModel` object.\n *\n * @remarks\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n * @public\n */\nexport class ApiItem {\n  private _canonicalReference: DeclarationReference | undefined;\n  private _parent: ApiItem | undefined;\n\n  public constructor(options: IApiItemOptions) {\n    // (\"options\" is not used here, but part of the inheritance pattern)\n  }\n\n  public static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem {\n    // The Deserializer class is coupled with a ton of other classes, so  we delay loading it\n    // to avoid ES5 circular imports.\n    const deserializerModule: typeof import('../model/Deserializer') = require('../model/Deserializer');\n    return deserializerModule.Deserializer.deserialize(context, jsonObject);\n  }\n\n  /** @virtual */\n  public static onDeserializeInto(\n    options: Partial<IApiItemOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiItemJson\n  ): void {\n    // (implemented by subclasses)\n  }\n\n  /** @virtual */\n  public serializeInto(jsonObject: Partial<IApiItemJson>): void {\n    jsonObject.kind = this.kind;\n    jsonObject.canonicalReference = this.canonicalReference.toString();\n  }\n\n  /**\n   * Identifies the subclass of the `ApiItem` base class.\n   * @virtual\n   */\n  public get kind(): ApiItemKind {\n    throw new Error('ApiItem.kind was not implemented by the child class');\n  }\n\n  /**\n   * Warning: This API is used internally by API extractor but is not yet ready for general usage.\n   *\n   * @remarks\n   *\n   * Returns a `DeclarationReference` object using the experimental new declaration reference notation.\n   *\n   * @beta\n   */\n  public get canonicalReference(): DeclarationReference {\n    if (!this._canonicalReference) {\n      try {\n        this._canonicalReference = this.buildCanonicalReference();\n      } catch (e) {\n        const name: string = this.getScopedNameWithinPackage() || this.displayName;\n        throw new InternalError(`Error building canonical reference for ${name}:\\n` + (e as Error).message);\n      }\n    }\n    return this._canonicalReference;\n  }\n\n  /**\n   * Returns a string key that can be used to efficiently retrieve an `ApiItem` from an `ApiItemContainerMixin`.\n   * The key is unique within the container.  Its format is undocumented and may change at any time.\n   *\n   * @remarks\n   * Use the `getContainerKey()` static member to construct the key.  Each subclass has a different implementation\n   * of this function, according to the aspects that are important for identifying it.\n   *\n   * @virtual\n   */\n  public get containerKey(): string {\n    throw new InternalError('ApiItem.containerKey was not implemented by the child class');\n  }\n\n  /**\n   * Returns a name for this object that can be used in diagnostic messages, for example.\n   *\n   * @remarks\n   * For an object that inherits ApiNameMixin, this will return the declared name (e.g. the name of a TypeScript\n   * function).  Otherwise, it will return a string such as \"(call signature)\" or \"(model)\".\n   *\n   * @virtual\n   */\n  public get displayName(): string {\n    switch (this.kind) {\n      case ApiItemKind.CallSignature:\n        return '(call)';\n      case ApiItemKind.Constructor:\n        return '(constructor)';\n      case ApiItemKind.ConstructSignature:\n        return '(new)';\n      case ApiItemKind.IndexSignature:\n        return '(indexer)';\n      case ApiItemKind.Model:\n        return '(model)';\n    }\n    return '(???)'; // All other types should inherit ApiNameMixin which will override this property\n  }\n\n  /**\n   * If this item was added to a ApiItemContainerMixin item, then this returns the container item.\n   * If this is an Parameter that was added to a method or function, then this returns the function item.\n   * Otherwise, it returns undefined.\n   * @virtual\n   */\n  public get parent(): ApiItem | undefined {\n    return this._parent;\n  }\n\n  /**\n   * This property supports a visitor pattern for walking the tree.\n   * For items with ApiItemContainerMixin, it returns the contained items, sorted alphabetically.\n   * Otherwise it returns an empty array.\n   * @virtual\n   */\n  public get members(): ReadonlyArray<ApiItem> {\n    return [];\n  }\n\n  /**\n   * If this item has a name (i.e. extends `ApiNameMixin`), then return all items that have the same parent\n   * and the same name.  Otherwise, return all items that have the same parent and the same `ApiItemKind`.\n   *\n   * @remarks\n   * Examples: For a function, this would return all overloads for the function.  For a constructor, this would\n   * return all overloads for the constructor.  For a merged declaration (e.g. a `namespace` and `enum` with the\n   * same name), this would return both declarations.  If this item does not have a parent, or if it is the only\n   * item of its name/kind, then the result is an array containing only this item.\n   */\n  public getMergedSiblings(): ReadonlyArray<ApiItem> {\n    const parent: ApiItem | undefined = this._parent;\n    if (parent && ApiItemContainerMixin.isBaseClassOf(parent)) {\n      return parent._getMergedSiblingsForMember(this);\n    }\n    return [];\n  }\n\n  /**\n   * Returns the chain of ancestors, starting from the root of the tree, and ending with the this item.\n   */\n  public getHierarchy(): ReadonlyArray<ApiItem> {\n    const hierarchy: ApiItem[] = [];\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      hierarchy.push(current);\n    }\n    hierarchy.reverse();\n    return hierarchy;\n  }\n\n  /**\n   * This returns a scoped name such as `\"Namespace1.Namespace2.MyClass.myMember()\"`.  It does not include the\n   * package name or entry point.\n   *\n   * @remarks\n   * If called on an ApiEntrypoint, ApiPackage, or ApiModel item, the result is an empty string.\n   */\n  public getScopedNameWithinPackage(): string {\n    const reversedParts: string[] = [];\n\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (\n        current.kind === ApiItemKind.Model ||\n        current.kind === ApiItemKind.Package ||\n        current.kind === ApiItemKind.EntryPoint\n      ) {\n        break;\n      }\n      if (reversedParts.length !== 0) {\n        reversedParts.push('.');\n      } else {\n        switch (current.kind) {\n          case ApiItemKind.CallSignature:\n          case ApiItemKind.ConstructSignature:\n          case ApiItemKind.Constructor:\n          case ApiItemKind.IndexSignature:\n            // These functional forms don't have a proper name, so we don't append the \"()\" suffix\n            break;\n          default:\n            if (ApiParameterListMixin.isBaseClassOf(current)) {\n              reversedParts.push('()');\n            }\n        }\n      }\n      reversedParts.push(current.displayName);\n    }\n\n    return reversedParts.reverse().join('');\n  }\n\n  /**\n   * If this item is an ApiPackage or has an ApiPackage as one of its parents, then that object is returned.\n   * Otherwise undefined is returned.\n   */\n  public getAssociatedPackage(): ApiPackage | undefined {\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (current.kind === ApiItemKind.Package) {\n        return current as ApiPackage;\n      }\n    }\n    return undefined;\n  }\n\n  /**\n   * A text string whose value determines the sort order that is automatically applied by the\n   * {@link (ApiItemContainerMixin:interface)} class.\n   *\n   * @remarks\n   * The value of this string is undocumented and may change at any time.\n   * If {@link (ApiItemContainerMixin:interface).preserveMemberOrder} is enabled for the `ApiItem`'s parent,\n   * then no sorting is performed, and this key is not used.\n   *\n   * @virtual\n   */\n  public getSortKey(): string {\n    return this.containerKey;\n  }\n\n  /**\n   * PRIVATE\n   *\n   * @privateRemarks\n   * Allows ApiItemContainerMixin to assign the parent when the item is added to a container.\n   *\n   * @internal\n   */\n  public [apiItem_onParentChanged](parent: ApiItem | undefined): void {\n    this._parent = parent;\n    this._canonicalReference = undefined;\n  }\n\n  /**\n   * Builds the cached object used by the `canonicalReference` property.\n   * @virtual\n   */\n  protected buildCanonicalReference(): DeclarationReference {\n    throw new InternalError('ApiItem.canonicalReference was not implemented by the child class');\n  }\n}\n\n/**\n * This abstraction is used by the mixin pattern.\n * It describes a class type that inherits from {@link ApiItem}.\n *\n * @public\n */\nexport interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {}\n"]}
+{"version":3,"file":"ApiItem.js","sourceRoot":"","sources":["../../src/items/ApiItem.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAK3D,2EAAwE;AAExE,oEAA6D;AAC7D,2EAAwE;AAGxE;;;;;GAKG;AACH,IAAY,WAqBX;AArBD,WAAY,WAAW;IACrB,8CAA+B,CAAA;IAC/B,8BAAe,CAAA;IACf,0CAA2B,CAAA;IAC3B,wDAAyC,CAAA;IACzC,wCAAyB,CAAA;IACzB,4BAAa,CAAA;IACb,wCAAyB,CAAA;IACzB,oCAAqB,CAAA;IACrB,gDAAiC,CAAA;IACjC,sCAAuB,CAAA;IACvB,gCAAiB,CAAA;IACjB,kDAAmC,CAAA;IACnC,8BAAe,CAAA;IACf,sCAAuB,CAAA;IACvB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,sDAAuC,CAAA;IACvC,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,4BAAa,CAAA;AACf,CAAC,EArBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAqBtB;AAaD,+DAA+D;AAC/D,EAAE;AACW,QAAA,uBAAuB,GAAkB,MAAM,CAAC,2BAA2B,CAAC,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAa,OAAO;IAIlB,YAAmB,OAAwB;QACzC,oEAAoE;IACtE,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAwB,EAAE,OAA4B;QAC9E,yFAAyF;QACzF,iCAAiC;QACjC,MAAM,kBAAkB,GAA2C,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACpG,OAAO,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED,eAAe;IACR,MAAM,CAAC,iBAAiB,CAC7B,OAAiC,EACjC,OAA4B,EAC5B,UAAwB;QAExB,8BAA8B;IAChC,CAAC;IAED,eAAe;IACR,aAAa,CAAC,UAAiC;QACpD,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IACrE,CAAC;IAED;;;OAGG;IACH,IAAW,IAAI;QACb,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,kBAAkB;QAC3B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,IAAI;gBACF,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;aAC3D;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,IAAI,GAAW,IAAI,CAAC,0BAA0B,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC;gBAC3E,MAAM,IAAI,iCAAa,CAAC,0CAA0C,IAAI,KAAK,GAAI,CAAW,CAAC,OAAO,CAAC,CAAC;aACrG;SACF;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,YAAY;QACrB,MAAM,IAAI,iCAAa,CAAC,6DAA6D,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,WAAW;QACpB,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,WAAW,CAAC,aAAa;gBAC5B,OAAO,QAAQ,CAAC;YAClB,KAAK,WAAW,CAAC,WAAW;gBAC1B,OAAO,eAAe,CAAC;YACzB,KAAK,WAAW,CAAC,kBAAkB;gBACjC,OAAO,OAAO,CAAC;YACjB,KAAK,WAAW,CAAC,cAAc;gBAC7B,OAAO,WAAW,CAAC;YACrB,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,OAAO,CAAC,CAAC,gFAAgF;IAClG,CAAC;IAED;;;;;OAKG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,IAAW,OAAO;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;OASG;IACI,iBAAiB;QACtB,MAAM,MAAM,GAAwB,IAAI,CAAC,OAAO,CAAC;QACjD,IAAI,MAAM,IAAI,6CAAqB,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;YACzD,OAAO,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;SACjD;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,MAAM,SAAS,GAAc,EAAE,CAAC;QAChC,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACzB;QACD,SAAS,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACI,0BAA0B;QAC/B,MAAM,aAAa,GAAa,EAAE,CAAC;QAEnC,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,IACE,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK;gBAClC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO;gBACpC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,UAAU,EACvC;gBACA,MAAM;aACP;YACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC9B,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;iBAAM;gBACL,QAAQ,OAAO,CAAC,IAAI,EAAE;oBACpB,KAAK,WAAW,CAAC,aAAa,CAAC;oBAC/B,KAAK,WAAW,CAAC,kBAAkB,CAAC;oBACpC,KAAK,WAAW,CAAC,WAAW,CAAC;oBAC7B,KAAK,WAAW,CAAC,cAAc;wBAC7B,sFAAsF;wBACtF,MAAM;oBACR;wBACE,IAAI,6CAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;4BAChD,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;yBAC1B;iBACJ;aACF;YACD,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACzC;QAED,OAAO,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,oBAAoB;QACzB,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE;gBACxC,OAAO,OAAqB,CAAC;aAC9B;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE;YAC7F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,EAAE;gBACtC,OAAO,OAAmB,CAAC;aAC5B;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;;OAOG;IACI,CAAC,+BAAuB,CAAC,CAAC,MAA2B;QAC1D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;IACvC,CAAC;IAED;;;OAGG;IACO,uBAAuB;QAC/B,MAAM,IAAI,iCAAa,CAAC,mEAAmE,CAAC,CAAC;IAC/F,CAAC;CACF;AAzPD,0BAyPC","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 { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\nimport { Constructor, PropertiesOf } from '../mixins/Mixin';\nimport { ApiPackage } from '../model/ApiPackage';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\nimport { DeserializerContext } from '../model/DeserializerContext';\nimport { InternalError } from '@rushstack/node-core-library';\nimport { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';\nimport { ApiModel } from '../model/ApiModel';\n\n/**\n * The type returned by the {@link ApiItem.kind} property, which can be used to easily distinguish subclasses of\n * {@link ApiItem}.\n *\n * @public\n */\nexport enum ApiItemKind {\n  CallSignature = 'CallSignature',\n  Class = 'Class',\n  Constructor = 'Constructor',\n  ConstructSignature = 'ConstructSignature',\n  EntryPoint = 'EntryPoint',\n  Enum = 'Enum',\n  EnumMember = 'EnumMember',\n  Function = 'Function',\n  IndexSignature = 'IndexSignature',\n  Interface = 'Interface',\n  Method = 'Method',\n  MethodSignature = 'MethodSignature',\n  Model = 'Model',\n  Namespace = 'Namespace',\n  Package = 'Package',\n  Property = 'Property',\n  PropertySignature = 'PropertySignature',\n  TypeAlias = 'TypeAlias',\n  Variable = 'Variable',\n  None = 'None'\n}\n\n/**\n * Constructor options for {@link ApiItem}.\n * @public\n */\nexport interface IApiItemOptions {}\n\nexport interface IApiItemJson {\n  kind: ApiItemKind;\n  canonicalReference: string;\n}\n\n// PRIVATE - Allows ApiItemContainerMixin to assign the parent.\n//\nexport const apiItem_onParentChanged: unique symbol = Symbol('ApiItem._onAddToContainer');\n\n/**\n * The abstract base class for all members of an `ApiModel` object.\n *\n * @remarks\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n * @public\n */\nexport class ApiItem {\n  private _canonicalReference: DeclarationReference | undefined;\n  private _parent: ApiItem | undefined;\n\n  public constructor(options: IApiItemOptions) {\n    // (\"options\" is not used here, but part of the inheritance pattern)\n  }\n\n  public static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem {\n    // The Deserializer class is coupled with a ton of other classes, so  we delay loading it\n    // to avoid ES5 circular imports.\n    const deserializerModule: typeof import('../model/Deserializer') = require('../model/Deserializer');\n    return deserializerModule.Deserializer.deserialize(context, jsonObject);\n  }\n\n  /** @virtual */\n  public static onDeserializeInto(\n    options: Partial<IApiItemOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiItemJson\n  ): void {\n    // (implemented by subclasses)\n  }\n\n  /** @virtual */\n  public serializeInto(jsonObject: Partial<IApiItemJson>): void {\n    jsonObject.kind = this.kind;\n    jsonObject.canonicalReference = this.canonicalReference.toString();\n  }\n\n  /**\n   * Identifies the subclass of the `ApiItem` base class.\n   * @virtual\n   */\n  public get kind(): ApiItemKind {\n    throw new Error('ApiItem.kind was not implemented by the child class');\n  }\n\n  /**\n   * Warning: This API is used internally by API extractor but is not yet ready for general usage.\n   *\n   * @remarks\n   *\n   * Returns a `DeclarationReference` object using the experimental new declaration reference notation.\n   *\n   * @beta\n   */\n  public get canonicalReference(): DeclarationReference {\n    if (!this._canonicalReference) {\n      try {\n        this._canonicalReference = this.buildCanonicalReference();\n      } catch (e) {\n        const name: string = this.getScopedNameWithinPackage() || this.displayName;\n        throw new InternalError(`Error building canonical reference for ${name}:\\n` + (e as Error).message);\n      }\n    }\n    return this._canonicalReference;\n  }\n\n  /**\n   * Returns a string key that can be used to efficiently retrieve an `ApiItem` from an `ApiItemContainerMixin`.\n   * The key is unique within the container.  Its format is undocumented and may change at any time.\n   *\n   * @remarks\n   * Use the `getContainerKey()` static member to construct the key.  Each subclass has a different implementation\n   * of this function, according to the aspects that are important for identifying it.\n   *\n   * @virtual\n   */\n  public get containerKey(): string {\n    throw new InternalError('ApiItem.containerKey was not implemented by the child class');\n  }\n\n  /**\n   * Returns a name for this object that can be used in diagnostic messages, for example.\n   *\n   * @remarks\n   * For an object that inherits ApiNameMixin, this will return the declared name (e.g. the name of a TypeScript\n   * function).  Otherwise, it will return a string such as \"(call signature)\" or \"(model)\".\n   *\n   * @virtual\n   */\n  public get displayName(): string {\n    switch (this.kind) {\n      case ApiItemKind.CallSignature:\n        return '(call)';\n      case ApiItemKind.Constructor:\n        return '(constructor)';\n      case ApiItemKind.ConstructSignature:\n        return '(new)';\n      case ApiItemKind.IndexSignature:\n        return '(indexer)';\n      case ApiItemKind.Model:\n        return '(model)';\n    }\n    return '(???)'; // All other types should inherit ApiNameMixin which will override this property\n  }\n\n  /**\n   * If this item was added to a ApiItemContainerMixin item, then this returns the container item.\n   * If this is an Parameter that was added to a method or function, then this returns the function item.\n   * Otherwise, it returns undefined.\n   * @virtual\n   */\n  public get parent(): ApiItem | undefined {\n    return this._parent;\n  }\n\n  /**\n   * This property supports a visitor pattern for walking the tree.\n   * For items with ApiItemContainerMixin, it returns the contained items, sorted alphabetically.\n   * Otherwise it returns an empty array.\n   * @virtual\n   */\n  public get members(): ReadonlyArray<ApiItem> {\n    return [];\n  }\n\n  /**\n   * If this item has a name (i.e. extends `ApiNameMixin`), then return all items that have the same parent\n   * and the same name.  Otherwise, return all items that have the same parent and the same `ApiItemKind`.\n   *\n   * @remarks\n   * Examples: For a function, this would return all overloads for the function.  For a constructor, this would\n   * return all overloads for the constructor.  For a merged declaration (e.g. a `namespace` and `enum` with the\n   * same name), this would return both declarations.  If this item does not have a parent, or if it is the only\n   * item of its name/kind, then the result is an array containing only this item.\n   */\n  public getMergedSiblings(): ReadonlyArray<ApiItem> {\n    const parent: ApiItem | undefined = this._parent;\n    if (parent && ApiItemContainerMixin.isBaseClassOf(parent)) {\n      return parent._getMergedSiblingsForMember(this);\n    }\n    return [];\n  }\n\n  /**\n   * Returns the chain of ancestors, starting from the root of the tree, and ending with the this item.\n   */\n  public getHierarchy(): ReadonlyArray<ApiItem> {\n    const hierarchy: ApiItem[] = [];\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      hierarchy.push(current);\n    }\n    hierarchy.reverse();\n    return hierarchy;\n  }\n\n  /**\n   * This returns a scoped name such as `\"Namespace1.Namespace2.MyClass.myMember()\"`.  It does not include the\n   * package name or entry point.\n   *\n   * @remarks\n   * If called on an ApiEntrypoint, ApiPackage, or ApiModel item, the result is an empty string.\n   */\n  public getScopedNameWithinPackage(): string {\n    const reversedParts: string[] = [];\n\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (\n        current.kind === ApiItemKind.Model ||\n        current.kind === ApiItemKind.Package ||\n        current.kind === ApiItemKind.EntryPoint\n      ) {\n        break;\n      }\n      if (reversedParts.length !== 0) {\n        reversedParts.push('.');\n      } else {\n        switch (current.kind) {\n          case ApiItemKind.CallSignature:\n          case ApiItemKind.ConstructSignature:\n          case ApiItemKind.Constructor:\n          case ApiItemKind.IndexSignature:\n            // These functional forms don't have a proper name, so we don't append the \"()\" suffix\n            break;\n          default:\n            if (ApiParameterListMixin.isBaseClassOf(current)) {\n              reversedParts.push('()');\n            }\n        }\n      }\n      reversedParts.push(current.displayName);\n    }\n\n    return reversedParts.reverse().join('');\n  }\n\n  /**\n   * If this item is an ApiPackage or has an ApiPackage as one of its parents, then that object is returned.\n   * Otherwise undefined is returned.\n   */\n  public getAssociatedPackage(): ApiPackage | undefined {\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (current.kind === ApiItemKind.Package) {\n        return current as ApiPackage;\n      }\n    }\n    return undefined;\n  }\n\n  /**\n   * If this item is an ApiModel or has an ApiModel as one of its parents, then that object is returned.\n   * Otherwise undefined is returned.\n   */\n  public getAssociatedModel(): ApiModel | undefined {\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (current.kind === ApiItemKind.Model) {\n        return current as ApiModel;\n      }\n    }\n    return undefined;\n  }\n\n  /**\n   * A text string whose value determines the sort order that is automatically applied by the\n   * {@link (ApiItemContainerMixin:interface)} class.\n   *\n   * @remarks\n   * The value of this string is undocumented and may change at any time.\n   * If {@link (ApiItemContainerMixin:interface).preserveMemberOrder} is enabled for the `ApiItem`'s parent,\n   * then no sorting is performed, and this key is not used.\n   *\n   * @virtual\n   */\n  public getSortKey(): string {\n    return this.containerKey;\n  }\n\n  /**\n   * PRIVATE\n   *\n   * @privateRemarks\n   * Allows ApiItemContainerMixin to assign the parent when the item is added to a container.\n   *\n   * @internal\n   */\n  public [apiItem_onParentChanged](parent: ApiItem | undefined): void {\n    this._parent = parent;\n    this._canonicalReference = undefined;\n  }\n\n  /**\n   * Builds the cached object used by the `canonicalReference` property.\n   * @virtual\n   */\n  protected buildCanonicalReference(): DeclarationReference {\n    throw new InternalError('ApiItem.canonicalReference was not implemented by the child class');\n  }\n}\n\n/**\n * This abstraction is used by the mixin pattern.\n * It describes a class type that inherits from {@link ApiItem}.\n *\n * @public\n */\nexport interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {}\n"]}

package/lib/mixins/ApiItemContainerMixin.d.ts

@@ -1,4 +1,5 @@
 import { ApiItem, IApiItemJson, IApiItemOptions, IApiItemConstructor } from '../items/ApiItem';
+import { IFindApiItemsResult } from './IFindApiItemsResult';
 /**
  * Constructor options for {@link (ApiItemContainerMixin:interface)}.
  * @public
@@ -67,6 +68,63 @@ export interface ApiItemContainerMixin extends ApiItem {
      * Returns a list of members with the specified name.
      */
     findMembersByName(name: string): ReadonlyArray<ApiItem>;
+    /**
+     * Finds all of the ApiItem's immediate and inherited members by walking up the inheritance tree.
+     *
+     * @remarks
+     *
+     * Given the following class heritage:
+     *
+     * ```
+     * export class A {
+     *   public a: number|boolean;
+     * }
+     *
+     * export class B extends A {
+     *   public a: number;
+     *   public b: string;
+     * }
+     *
+     * export class C extends B {
+     *   public c: boolean;
+     * }
+     * ```
+     *
+     * Calling `findMembersWithInheritance` on `C` will return `B.a`, `B.b`, and `C.c`. Calling the
+     * method on `B` will return `B.a` and `B.b`. And calling the method on `A` will return just
+     * `A.a`.
+     *
+     * The inherited members returned by this method may be incomplete. If so, there will be a flag
+     * on the result object indicating this as well as messages explaining the errors in more detail.
+     * Some scenarios include:
+     *
+     * - Interface extending from a type alias.
+     *
+     * - Class extending from a variable.
+     *
+     * - Extending from a declaration not present in the model (e.g. external package).
+     *
+     * - Extending from an unexported declaration (e.g. ae-forgotten-export). Common in mixin
+     *   patterns.
+     *
+     * - Unexpected runtime errors...
+     *
+     * Lastly, be aware that the types of inherited members are returned with respect to their
+     * defining class as opposed to with respect to the inheriting class. For example, consider
+     * the following:
+     *
+     * ```
+     * export class A<T> {
+     *   public a: T;
+     * }
+     *
+     * export class B extends A<number> {}
+     * ```
+     *
+     * When called on `B`, this method will return `B.a` with type `T` as opposed to type
+     * `number`, although the latter is more accurate.
+     */
+    findMembersWithInheritance(): IFindApiItemsResult;
     /**
      * For a given member of this container, return its `ApiItem.getMergedSiblings()` list.
      * @internal

package/lib/mixins/ApiItemContainerMixin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiItemContainerMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiItemContainerMixin.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EAEP,YAAY,EACZ,eAAe,EACf,mBAAmB,EAEpB,MAAM,kBAAkB,CAAC;AAK1B;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,eAAe;IACpE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AASD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7D;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAExD;;;OAGG;IACH,2BAA2B,CAAC,aAAa,EAAE,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAE5E,gBAAgB;IAChB,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,SAAS,mBAAmB,EAC1E,SAAS,EAAE,UAAU,GAEpB,UAAU,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAqB,CAAC,CA8J9D;AAED;;;GAGG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,qBAAqB,CAEhF;CACF"}
+{"version":3,"file":"ApiItemContainerMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiItemContainerMixin.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EAEP,YAAY,EACZ,eAAe,EACf,mBAAmB,EAEpB,MAAM,kBAAkB,CAAC;AAO1B,OAAO,EAAE,mBAAmB,EAA+C,MAAM,uBAAuB,CAAC;AAKzG;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,eAAe;IACpE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AASD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7D;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,0BAA0B,IAAI,mBAAmB,CAAC;IAElD;;;OAGG;IACH,2BAA2B,CAAC,aAAa,EAAE,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAE5E,gBAAgB;IAChB,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,SAAS,mBAAmB,EAC1E,SAAS,EAAE,UAAU,GAEpB,UAAU,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAqB,CAAC,CAqU9D;AAED;;;GAGG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,qBAAqB,CAEhF;CACF"}

package/lib/mixins/ApiItemContainerMixin.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiItemContainerMixin = void 0;
 const ApiItem_1 = require("../items/ApiItem");
 const ApiNameMixin_1 = require("./ApiNameMixin");
+const Excerpt_1 = require("./Excerpt");
+const IFindApiItemsResult_1 = require("./IFindApiItemsResult");
 const node_core_library_1 = require("@rushstack/node-core-library");
 const _members = Symbol('ApiItemContainerMixin._members');
 const _membersSorted = Symbol('ApiItemContainerMixin._membersSorted');
@@ -82,6 +84,147 @@ function ApiItemContainerMixin(baseClass
             this._ensureMemberMaps();
             return this[_membersByName].get(name) || [];
         }
+        findMembersWithInheritance() {
+            const messages = [];
+            let maybeIncompleteResult = false;
+            const membersByName = new Map();
+            const membersByKind = new Map();
+            const toVisit = [];
+            let next = this;
+            while (next) {
+                const membersToAdd = [];
+                // For each member, check to see if we've already seen a member with the same name
+                // previously in the inheritance tree. If so, we know we won't inherit it, and thus
+                // do not add it to our `membersToAdd` array.
+                for (const member of next.members) {
+                    // We add the to-be-added members to an intermediate array instead of immediately
+                    // to the maps themselves to support method overloads with the same name.
+                    if (ApiNameMixin_1.ApiNameMixin.isBaseClassOf(member)) {
+                        if (!membersByName.has(member.name)) {
+                            membersToAdd.push(member);
+                        }
+                    }
+                    else {
+                        if (!membersByKind.has(member.kind)) {
+                            membersToAdd.push(member);
+                        }
+                    }
+                }
+                for (const member of membersToAdd) {
+                    if (ApiNameMixin_1.ApiNameMixin.isBaseClassOf(member)) {
+                        const members = membersByName.get(member.name) || [];
+                        members.push(member);
+                        membersByName.set(member.name, members);
+                    }
+                    else {
+                        const members = membersByKind.get(member.kind) || [];
+                        members.push(member);
+                        membersByKind.set(member.kind, members);
+                    }
+                }
+                // Interfaces can extend multiple interfaces, so iterate through all of them.
+                const extendedItems = [];
+                let extendsTypes;
+                switch (next.kind) {
+                    case ApiItem_1.ApiItemKind.Class: {
+                        const apiClass = next;
+                        extendsTypes = apiClass.extendsType ? [apiClass.extendsType] : [];
+                        break;
+                    }
+                    case ApiItem_1.ApiItemKind.Interface: {
+                        const apiInterface = next;
+                        extendsTypes = apiInterface.extendsTypes;
+                        break;
+                    }
+                }
+                if (extendsTypes === undefined) {
+                    messages.push({
+                        messageId: IFindApiItemsResult_1.FindApiItemsMessageId.UnsupportedKind,
+                        text: `Item ${next.displayName} is of unsupported kind ${next.kind}.`
+                    });
+                    maybeIncompleteResult = true;
+                    break;
+                }
+                for (const extendsType of extendsTypes) {
+                    // We want to find the reference token associated with the actual inherited declaration.
+                    // In every case we support, this is the first reference token. For example:
+                    //
+                    // ```
+                    // export class A extends B {}
+                    //                        ^
+                    // export class A extends B<C> {}
+                    //                        ^
+                    // export class A extends B.C {}
+                    //                        ^^^
+                    // ```
+                    const firstReferenceToken = extendsType.excerpt.spannedTokens.find((token) => {
+                        return token.kind === Excerpt_1.ExcerptTokenKind.Reference && token.canonicalReference;
+                    });
+                    if (!firstReferenceToken) {
+                        messages.push({
+                            messageId: IFindApiItemsResult_1.FindApiItemsMessageId.UnexpectedExcerptTokens,
+                            text: `Encountered unexpected excerpt tokens in ${next.displayName}. Excerpt: ${extendsType.excerpt.text}.`
+                        });
+                        maybeIncompleteResult = true;
+                        continue;
+                    }
+                    const apiModel = this.getAssociatedModel();
+                    if (!apiModel) {
+                        messages.push({
+                            messageId: IFindApiItemsResult_1.FindApiItemsMessageId.MissingApiModel,
+                            text: `Unable to get the associated model of ${next.displayName}.`
+                        });
+                        maybeIncompleteResult = true;
+                        continue;
+                    }
+                    const apiItemResult = apiModel.resolveDeclarationReference(firstReferenceToken.canonicalReference, undefined);
+                    const apiItem = apiItemResult.resolvedApiItem;
+                    if (!apiItem) {
+                        messages.push({
+                            messageId: IFindApiItemsResult_1.FindApiItemsMessageId.DeclarationResolutionFailed,
+                            text: `Declaration resolution failed for ${next.displayName}. Error message: ${apiItemResult.errorMessage}.`
+                        });
+                        maybeIncompleteResult = true;
+                        continue;
+                    }
+                    extendedItems.push(apiItem);
+                }
+                // For classes, this array will only have one item. For interfaces, there may be multiple items. Sort the array
+                // into alphabetical order before adding to our list of API items to visit. This ensures that in the case
+                // of multiple interface inheritance, a member inherited from multiple interfaces is attributed to the interface
+                // earlier in alphabetical order (as opposed to source order).
+                //
+                // For example, in the code block below, `Bar.x` is reported as the inherited item, not `Foo.x`.
+                //
+                // ```
+                // interface Foo {
+                //   public x: string;
+                // }
+                //
+                // interface Bar {
+                //   public x: string;
+                // }
+                //
+                // interface FooBar extends Foo, Bar {}
+                // ```
+                node_core_library_1.LegacyAdapters.sortStable(extendedItems, (x, y) => x.getSortKey().localeCompare(y.getSortKey()));
+                toVisit.push(...extendedItems);
+                next = toVisit.shift();
+            }
+            const items = [];
+            for (const members of membersByName.values()) {
+                items.push(...members);
+            }
+            for (const members of membersByKind.values()) {
+                items.push(...members);
+            }
+            node_core_library_1.LegacyAdapters.sortStable(items, (x, y) => x.getSortKey().localeCompare(y.getSortKey()));
+            return {
+                items,
+                messages,
+                maybeIncompleteResult
+            };
+        }
         /** @internal */
         _getMergedSiblingsForMember(memberApiItem) {
             this._ensureMemberMaps();

package/lib/mixins/ApiItemContainerMixin.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiItemContainerMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiItemContainerMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAE5D,8CAO0B;AAC1B,iDAA8C;AAE9C,oEAA6E;AAgB7E,MAAM,QAAQ,GAAkB,MAAM,CAAC,gCAAgC,CAAC,CAAC;AACzE,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,sBAAsB,GAAkB,MAAM,CAAC,8CAA8C,CAAC,CAAC;AACrG,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,oBAAoB,GAAkB,MAAM,CAAC,4CAA4C,CAAC,CAAC;AAyEjG;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAchC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAkC,CAAC;YAExF,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,GAAG,EAAmB,CAAC;YAC1D,IAAI,CAAC,oBAAoB,CAAC,GAAG,MAAA,OAAO,CAAC,mBAAmB,mCAAI,KAAK,CAAC;YAElE,IAAI,OAAO,CAAC,OAAO,EAAE;gBACnB,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;oBACpC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;iBACxB;aACF;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA+C,EAC/C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1D,OAAO,CAAC,mBAAmB,GAAG,UAAU,CAAC,mBAAmB,CAAC;YAC7D,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,UAAU,CAAC,OAAO,EAAE;gBAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAO,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;aAClE;QACH,CAAC;QAED,gBAAgB;QAChB,IAAW,OAAO;YAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE;gBACxD,kCAAc,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAClG,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;aAC7B;YAED,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;QAED,IAAW,mBAAmB;YAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;QAEM,SAAS,CAAC,MAAe;YAC9B,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;gBACzD,MAAM,IAAI,KAAK,CACb,6DAA6D,MAAM,CAAC,WAAW,GAAG;oBAChF,sBAAsB,MAAM,CAAC,YAAY,GAAG,CAC/C,CAAC;aACH;YAED,MAAM,cAAc,GAAwB,MAAM,CAAC,MAAM,CAAC;YAC1D,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,MAAM,IAAI,KAAK,CACb,2DAA2D,cAAc,CAAC,WAAW,GAAG,CACzF,CAAC;aACH;YAED,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,CAAC,wBAAwB;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,CAAC,wBAAwB;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAE9D,MAAM,CAAC,iCAAuB,CAAC,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QAEM,iBAAiB,CAAC,YAAoB;YAC3C,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC;QAEM,iBAAiB,CAAC,IAAY;YACnC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;QAED,gBAAgB;QACT,2BAA2B,CAAC,aAAsB;YACvD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,MAA6B,CAAC;YAClC,IAAI,2BAAY,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;gBAC7C,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;aACxD;iBAAM;gBACL,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,iCAAa,CAAC,gEAAgE,CAAC,CAAC;aAC3F;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gBAAgB;QACT,iBAAiB;YACtB,iFAAiF;YACjF,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE;gBACtC,MAAM,aAAa,GAA2B,IAAI,GAAG,EAAqB,CAAC;gBAC3E,MAAM,aAAa,GAA2B,IAAI,GAAG,EAAqB,CAAC;gBAE3E,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;oBACnC,IAAI,GAAyD,CAAC;oBAC9D,IAAI,GAAyB,CAAC;oBAE9B,IAAI,2BAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;wBACtC,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;qBACnB;yBAAM;wBACL,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;qBACnB;oBAED,IAAI,IAAI,GAA0B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC/C,IAAI,IAAI,KAAK,SAAS,EAAE;wBACtB,IAAI,GAAG,EAAE,CAAC;wBACV,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;qBACpB;oBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACnB;gBAED,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;aACtC;QACH,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,MAAM,aAAa,GAAmB,EAAE,CAAC;YAEzC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBACjC,MAAM,gBAAgB,GAA0B,EAAE,CAAC;gBACnD,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;gBACvC,aAAa,CAAC,IAAI,CAAC,gBAAgC,CAAC,CAAC;aACtD;YAED,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC1D,UAAU,CAAC,OAAO,GAAG,aAAa,CAAC;QACrC,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAjKD,sDAiKC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAarC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.s\n\nimport {\n  ApiItem,\n  apiItem_onParentChanged,\n  IApiItemJson,\n  IApiItemOptions,\n  IApiItemConstructor,\n  ApiItemKind\n} from '../items/ApiItem';\nimport { ApiNameMixin } from './ApiNameMixin';\nimport { DeserializerContext } from '../model/DeserializerContext';\nimport { InternalError, LegacyAdapters } from '@rushstack/node-core-library';\n\n/**\n * Constructor options for {@link (ApiItemContainerMixin:interface)}.\n * @public\n */\nexport interface IApiItemContainerMixinOptions extends IApiItemOptions {\n  preserveMemberOrder?: boolean;\n  members?: ApiItem[];\n}\n\nexport interface IApiItemContainerJson extends IApiItemJson {\n  preserveMemberOrder?: boolean;\n  members: IApiItemJson[];\n}\n\nconst _members: unique symbol = Symbol('ApiItemContainerMixin._members');\nconst _membersSorted: unique symbol = Symbol('ApiItemContainerMixin._membersSorted');\nconst _membersByContainerKey: unique symbol = Symbol('ApiItemContainerMixin._membersByContainerKey');\nconst _membersByName: unique symbol = Symbol('ApiItemContainerMixin._membersByName');\nconst _membersByKind: unique symbol = Symbol('ApiItemContainerMixin._membersByKind');\nconst _preserveMemberOrder: unique symbol = Symbol('ApiItemContainerMixin._preserveMemberOrder');\n\n/**\n * The mixin base class for API items that act as containers for other child items.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.  The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\n * to extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\n * the function that generates a subclass, an interface that describes the members of the subclass, and\n * a namespace containing static members of the class.\n *\n * Examples of `ApiItemContainerMixin` child classes include `ApiModel`, `ApiPackage`, `ApiEntryPoint`,\n * and `ApiEnum`.  But note that `Parameter` is not considered a \"member\" of an `ApiMethod`; this relationship\n * is modeled using {@link (ApiParameterListMixin:interface).parameters} instead\n * of {@link ApiItem.members}.\n *\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiItemContainerMixin extends ApiItem {\n  /**\n   * Disables automatic sorting of {@link ApiItem.members}.\n   *\n   * @remarks\n   * By default `ApiItemContainerMixin` will automatically sort its members according to their\n   * {@link ApiItem.getSortKey} string, which provides a standardized mostly alphabetical ordering\n   * that is appropriate for most API items.  When loading older .api.json files the automatic sorting\n   * is reapplied and may update the ordering.\n   *\n   * Set `preserveMemberOrder` to true to disable automatic sorting for this container; instead, the\n   * members will retain whatever ordering appeared in the {@link IApiItemContainerMixinOptions.members} array.\n   * The `preserveMemberOrder` option is saved in the .api.json file.\n   */\n  readonly preserveMemberOrder: boolean;\n\n  /**\n   * Adds a new member to the container.\n   *\n   * @remarks\n   * An ApiItem cannot be added to more than one container.\n   */\n  addMember(member: ApiItem): void;\n\n  /**\n   * Attempts to retrieve a member using its containerKey, or returns `undefined` if no matching member was found.\n   *\n   * @remarks\n   * Use the `getContainerKey()` static member to construct the key.  Each subclass has a different implementation\n   * of this function, according to the aspects that are important for identifying it.\n   *\n   * See {@link ApiItem.containerKey} for more information.\n   */\n  tryGetMemberByKey(containerKey: string): ApiItem | undefined;\n\n  /**\n   * Returns a list of members with the specified name.\n   */\n  findMembersByName(name: string): ReadonlyArray<ApiItem>;\n\n  /**\n   * For a given member of this container, return its `ApiItem.getMergedSiblings()` list.\n   * @internal\n   */\n  _getMergedSiblingsForMember(memberApiItem: ApiItem): ReadonlyArray<ApiItem>;\n\n  /** @override */\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link ApiDeclaredItem}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiItemContainerMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiItemContainerMixin) {\n  class MixedClass extends baseClass implements ApiItemContainerMixin {\n    public readonly [_members]: ApiItem[];\n    public [_membersSorted]: boolean;\n    public [_membersByContainerKey]: Map<string, ApiItem>;\n    public [_preserveMemberOrder]: boolean;\n\n    // For members of this container that extend ApiNameMixin, this stores the list of members with a given name.\n    // Examples include merged declarations, overloaded functions, etc.\n    public [_membersByName]: Map<string, ApiItem[]> | undefined;\n\n    // For members of this container that do NOT extend ApiNameMixin, this stores the list of members\n    // that share a common ApiItemKind.  Examples include overloaded constructors or index signatures.\n    public [_membersByKind]: Map<string, ApiItem[]> | undefined; // key is ApiItemKind\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n      const options: IApiItemContainerMixinOptions = args[0] as IApiItemContainerMixinOptions;\n\n      this[_members] = [];\n      this[_membersSorted] = false;\n      this[_membersByContainerKey] = new Map<string, ApiItem>();\n      this[_preserveMemberOrder] = options.preserveMemberOrder ?? false;\n\n      if (options.members) {\n        for (const member of options.members) {\n          this.addMember(member);\n        }\n      }\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiItemContainerMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiItemContainerJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n      options.preserveMemberOrder = jsonObject.preserveMemberOrder;\n      options.members = [];\n      for (const memberObject of jsonObject.members) {\n        options.members.push(ApiItem.deserialize(memberObject, context));\n      }\n    }\n\n    /** @override */\n    public get members(): ReadonlyArray<ApiItem> {\n      if (!this[_membersSorted] && !this[_preserveMemberOrder]) {\n        LegacyAdapters.sortStable(this[_members], (x, y) => x.getSortKey().localeCompare(y.getSortKey()));\n        this[_membersSorted] = true;\n      }\n\n      return this[_members];\n    }\n\n    public get preserveMemberOrder(): boolean {\n      return this[_preserveMemberOrder];\n    }\n\n    public addMember(member: ApiItem): void {\n      if (this[_membersByContainerKey].has(member.containerKey)) {\n        throw new Error(\n          `Another member has already been added with the same name (${member.displayName})` +\n            ` and containerKey (${member.containerKey})`\n        );\n      }\n\n      const existingParent: ApiItem | undefined = member.parent;\n      if (existingParent !== undefined) {\n        throw new Error(\n          `This item has already been added to another container: \"${existingParent.displayName}\"`\n        );\n      }\n\n      this[_members].push(member);\n      this[_membersByName] = undefined; // invalidate the lookup\n      this[_membersByKind] = undefined; // invalidate the lookup\n      this[_membersSorted] = false;\n      this[_membersByContainerKey].set(member.containerKey, member);\n\n      member[apiItem_onParentChanged](this);\n    }\n\n    public tryGetMemberByKey(containerKey: string): ApiItem | undefined {\n      return this[_membersByContainerKey].get(containerKey);\n    }\n\n    public findMembersByName(name: string): ReadonlyArray<ApiItem> {\n      this._ensureMemberMaps();\n      return this[_membersByName]!.get(name) || [];\n    }\n\n    /** @internal */\n    public _getMergedSiblingsForMember(memberApiItem: ApiItem): ReadonlyArray<ApiItem> {\n      this._ensureMemberMaps();\n      let result: ApiItem[] | undefined;\n      if (ApiNameMixin.isBaseClassOf(memberApiItem)) {\n        result = this[_membersByName]!.get(memberApiItem.name);\n      } else {\n        result = this[_membersByKind]!.get(memberApiItem.kind);\n      }\n      if (!result) {\n        throw new InternalError('Item was not found in the _membersByName/_membersByKind lookup');\n      }\n      return result;\n    }\n\n    /** @internal */\n    public _ensureMemberMaps(): void {\n      // Build the _membersByName and _membersByKind tables if they don't already exist\n      if (this[_membersByName] === undefined) {\n        const membersByName: Map<string, ApiItem[]> = new Map<string, ApiItem[]>();\n        const membersByKind: Map<string, ApiItem[]> = new Map<string, ApiItem[]>();\n\n        for (const member of this[_members]) {\n          let map: Map<string, ApiItem[]> | Map<ApiItemKind, ApiItem[]>;\n          let key: string | ApiItemKind;\n\n          if (ApiNameMixin.isBaseClassOf(member)) {\n            map = membersByName;\n            key = member.name;\n          } else {\n            map = membersByKind;\n            key = member.kind;\n          }\n\n          let list: ApiItem[] | undefined = map.get(key);\n          if (list === undefined) {\n            list = [];\n            map.set(key, list);\n          }\n          list.push(member);\n        }\n\n        this[_membersByName] = membersByName;\n        this[_membersByKind] = membersByKind;\n      }\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiItemContainerJson>): void {\n      super.serializeInto(jsonObject);\n\n      const memberObjects: IApiItemJson[] = [];\n\n      for (const member of this.members) {\n        const memberJsonObject: Partial<IApiItemJson> = {};\n        member.serializeInto(memberJsonObject);\n        memberObjects.push(memberJsonObject as IApiItemJson);\n      }\n\n      jsonObject.preserveMemberOrder = this.preserveMemberOrder;\n      jsonObject.members = memberObjects;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiItemContainerMixin:interface)}.\n * @public\n */\nexport namespace ApiItemContainerMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiItemContainerMixin` mixin.\n   *\n   * @remarks\n   *\n   * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\n   * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however\n   * the TypeScript type system cannot invoke a runtime test.)\n   */\n  export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiItemContainerMixin {\n    return apiItem.hasOwnProperty(_members);\n  }\n}\n"]}
+{"version":3,"file":"ApiItemContainerMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiItemContainerMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAE5D,8CAO0B;AAC1B,iDAA8C;AAK9C,uCAA2D;AAC3D,+DAAyG;AACzG,oEAA6E;AAkB7E,MAAM,QAAQ,GAAkB,MAAM,CAAC,gCAAgC,CAAC,CAAC;AACzE,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,sBAAsB,GAAkB,MAAM,CAAC,8CAA8C,CAAC,CAAC;AACrG,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,oBAAoB,GAAkB,MAAM,CAAC,4CAA4C,CAAC,CAAC;AAmIjG;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAchC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAkC,CAAC;YAExF,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,GAAG,EAAmB,CAAC;YAC1D,IAAI,CAAC,oBAAoB,CAAC,GAAG,MAAA,OAAO,CAAC,mBAAmB,mCAAI,KAAK,CAAC;YAElE,IAAI,OAAO,CAAC,OAAO,EAAE;gBACnB,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;oBACpC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;iBACxB;aACF;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA+C,EAC/C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1D,OAAO,CAAC,mBAAmB,GAAG,UAAU,CAAC,mBAAmB,CAAC;YAC7D,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;YACrB,KAAK,MAAM,YAAY,IAAI,UAAU,CAAC,OAAO,EAAE;gBAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAO,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;aAClE;QACH,CAAC;QAED,gBAAgB;QAChB,IAAW,OAAO;YAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE;gBACxD,kCAAc,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAClG,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;aAC7B;YAED,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;QAED,IAAW,mBAAmB;YAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;QAEM,SAAS,CAAC,MAAe;YAC9B,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;gBACzD,MAAM,IAAI,KAAK,CACb,6DAA6D,MAAM,CAAC,WAAW,GAAG;oBAChF,sBAAsB,MAAM,CAAC,YAAY,GAAG,CAC/C,CAAC;aACH;YAED,MAAM,cAAc,GAAwB,MAAM,CAAC,MAAM,CAAC;YAC1D,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,MAAM,IAAI,KAAK,CACb,2DAA2D,cAAc,CAAC,WAAW,GAAG,CACzF,CAAC;aACH;YAED,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,CAAC,wBAAwB;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,CAAC,wBAAwB;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAE9D,MAAM,CAAC,iCAAuB,CAAC,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QAEM,iBAAiB,CAAC,YAAoB;YAC3C,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC;QAEM,iBAAiB,CAAC,IAAY;YACnC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;QAEM,0BAA0B;YAC/B,MAAM,QAAQ,GAA2B,EAAE,CAAC;YAC5C,IAAI,qBAAqB,GAAY,KAAK,CAAC;YAE3C,MAAM,aAAa,GAA2B,IAAI,GAAG,EAAE,CAAC;YACxD,MAAM,aAAa,GAAgC,IAAI,GAAG,EAAE,CAAC;YAE7D,MAAM,OAAO,GAAc,EAAE,CAAC;YAC9B,IAAI,IAAI,GAAwB,IAAI,CAAC;YAErC,OAAO,IAAI,EAAE;gBACX,MAAM,YAAY,GAAc,EAAE,CAAC;gBAEnC,kFAAkF;gBAClF,mFAAmF;gBACnF,6CAA6C;gBAC7C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;oBACjC,iFAAiF;oBACjF,yEAAyE;oBACzE,IAAI,2BAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;wBACtC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;4BACnC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;yBAC3B;qBACF;yBAAM;wBACL,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;4BACnC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;yBAC3B;qBACF;iBACF;gBAED,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE;oBACjC,IAAI,2BAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;wBACtC,MAAM,OAAO,GAAc,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAChE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACrB,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;qBACzC;yBAAM;wBACL,MAAM,OAAO,GAAc,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAChE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACrB,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;qBACzC;iBACF;gBAED,6EAA6E;gBAC7E,MAAM,aAAa,GAAc,EAAE,CAAC;gBACpC,IAAI,YAAiD,CAAC;gBAEtD,QAAQ,IAAI,CAAC,IAAI,EAAE;oBACjB,KAAK,qBAAW,CAAC,KAAK,CAAC,CAAC;wBACtB,MAAM,QAAQ,GAAa,IAAgB,CAAC;wBAC5C,YAAY,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBAClE,MAAM;qBACP;oBACD,KAAK,qBAAW,CAAC,SAAS,CAAC,CAAC;wBAC1B,MAAM,YAAY,GAAiB,IAAoB,CAAC;wBACxD,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;wBACzC,MAAM;qBACP;iBACF;gBAED,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC9B,QAAQ,CAAC,IAAI,CAAC;wBACZ,SAAS,EAAE,2CAAqB,CAAC,eAAe;wBAChD,IAAI,EAAE,QAAQ,IAAI,CAAC,WAAW,2BAA2B,IAAI,CAAC,IAAI,GAAG;qBACtE,CAAC,CAAC;oBACH,qBAAqB,GAAG,IAAI,CAAC;oBAC7B,MAAM;iBACP;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;oBACtC,wFAAwF;oBACxF,4EAA4E;oBAC5E,EAAE;oBACF,MAAM;oBACN,8BAA8B;oBAC9B,2BAA2B;oBAC3B,iCAAiC;oBACjC,2BAA2B;oBAC3B,gCAAgC;oBAChC,6BAA6B;oBAC7B,MAAM;oBACN,MAAM,mBAAmB,GAA6B,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAC1F,CAAC,KAAmB,EAAE,EAAE;wBACtB,OAAO,KAAK,CAAC,IAAI,KAAK,0BAAgB,CAAC,SAAS,IAAI,KAAK,CAAC,kBAAkB,CAAC;oBAC/E,CAAC,CACF,CAAC;oBAEF,IAAI,CAAC,mBAAmB,EAAE;wBACxB,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,2CAAqB,CAAC,uBAAuB;4BACxD,IAAI,EAAE,4CAA4C,IAAI,CAAC,WAAW,cAAc,WAAW,CAAC,OAAO,CAAC,IAAI,GAAG;yBAC5G,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;qBACV;oBAED,MAAM,QAAQ,GAAyB,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBACjE,IAAI,CAAC,QAAQ,EAAE;wBACb,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,2CAAqB,CAAC,eAAe;4BAChD,IAAI,EAAE,yCAAyC,IAAI,CAAC,WAAW,GAAG;yBACnE,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;qBACV;oBAED,MAAM,aAAa,GAAuC,QAAQ,CAAC,2BAA2B,CAC5F,mBAAmB,CAAC,kBAAmB,EACvC,SAAS,CACV,CAAC;oBAEF,MAAM,OAAO,GAAwB,aAAa,CAAC,eAAe,CAAC;oBACnE,IAAI,CAAC,OAAO,EAAE;wBACZ,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,2CAAqB,CAAC,2BAA2B;4BAC5D,IAAI,EAAE,qCAAqC,IAAI,CAAC,WAAW,oBAAoB,aAAa,CAAC,YAAY,GAAG;yBAC7G,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;qBACV;oBAED,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBAC7B;gBAED,+GAA+G;gBAC/G,yGAAyG;gBACzG,gHAAgH;gBAChH,8DAA8D;gBAC9D,EAAE;gBACF,gGAAgG;gBAChG,EAAE;gBACF,MAAM;gBACN,kBAAkB;gBAClB,sBAAsB;gBACtB,IAAI;gBACJ,EAAE;gBACF,kBAAkB;gBAClB,sBAAsB;gBACtB,IAAI;gBACJ,EAAE;gBACF,uCAAuC;gBACvC,MAAM;gBACN,kCAAc,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAClE,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAC7C,CAAC;gBAEF,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;gBAC/B,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;aACxB;YAED,MAAM,KAAK,GAAc,EAAE,CAAC;YAC5B,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE;gBAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;aACxB;YACD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE;gBAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;aACxB;YACD,kCAAc,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAC1D,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAC7C,CAAC;YAEF,OAAO;gBACL,KAAK;gBACL,QAAQ;gBACR,qBAAqB;aACtB,CAAC;QACJ,CAAC;QAED,gBAAgB;QACT,2BAA2B,CAAC,aAAsB;YACvD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,MAA6B,CAAC;YAClC,IAAI,2BAAY,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;gBAC7C,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;aACxD;iBAAM;gBACL,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,iCAAa,CAAC,gEAAgE,CAAC,CAAC;aAC3F;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gBAAgB;QACT,iBAAiB;YACtB,iFAAiF;YACjF,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE;gBACtC,MAAM,aAAa,GAA2B,IAAI,GAAG,EAAqB,CAAC;gBAC3E,MAAM,aAAa,GAA2B,IAAI,GAAG,EAAqB,CAAC;gBAE3E,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;oBACnC,IAAI,GAAyD,CAAC;oBAC9D,IAAI,GAAyB,CAAC;oBAE9B,IAAI,2BAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;wBACtC,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;qBACnB;yBAAM;wBACL,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;qBACnB;oBAED,IAAI,IAAI,GAA0B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC/C,IAAI,IAAI,KAAK,SAAS,EAAE;wBACtB,IAAI,GAAG,EAAE,CAAC;wBACV,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;qBACpB;oBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACnB;gBAED,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;aACtC;QACH,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,MAAM,aAAa,GAAmB,EAAE,CAAC;YAEzC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBACjC,MAAM,gBAAgB,GAA0B,EAAE,CAAC;gBACnD,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;gBACvC,aAAa,CAAC,IAAI,CAAC,gBAAgC,CAAC,CAAC;aACtD;YAED,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC;YAC1D,UAAU,CAAC,OAAO,GAAG,aAAa,CAAC;QACrC,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAxUD,sDAwUC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAarC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.s\n\nimport {\n  ApiItem,\n  apiItem_onParentChanged,\n  IApiItemJson,\n  IApiItemOptions,\n  IApiItemConstructor,\n  ApiItemKind\n} from '../items/ApiItem';\nimport { ApiNameMixin } from './ApiNameMixin';\nimport { DeserializerContext } from '../model/DeserializerContext';\nimport { ApiModel } from '../model/ApiModel';\nimport { ApiClass } from '../model/ApiClass';\nimport { ApiInterface } from '../model/ApiInterface';\nimport { ExcerptToken, ExcerptTokenKind } from './Excerpt';\nimport { IFindApiItemsResult, IFindApiItemsMessage, FindApiItemsMessageId } from './IFindApiItemsResult';\nimport { InternalError, LegacyAdapters } from '@rushstack/node-core-library';\nimport { HeritageType } from '../model/HeritageType';\nimport { IResolveDeclarationReferenceResult } from '../model/ModelReferenceResolver';\n\n/**\n * Constructor options for {@link (ApiItemContainerMixin:interface)}.\n * @public\n */\nexport interface IApiItemContainerMixinOptions extends IApiItemOptions {\n  preserveMemberOrder?: boolean;\n  members?: ApiItem[];\n}\n\nexport interface IApiItemContainerJson extends IApiItemJson {\n  preserveMemberOrder?: boolean;\n  members: IApiItemJson[];\n}\n\nconst _members: unique symbol = Symbol('ApiItemContainerMixin._members');\nconst _membersSorted: unique symbol = Symbol('ApiItemContainerMixin._membersSorted');\nconst _membersByContainerKey: unique symbol = Symbol('ApiItemContainerMixin._membersByContainerKey');\nconst _membersByName: unique symbol = Symbol('ApiItemContainerMixin._membersByName');\nconst _membersByKind: unique symbol = Symbol('ApiItemContainerMixin._membersByKind');\nconst _preserveMemberOrder: unique symbol = Symbol('ApiItemContainerMixin._preserveMemberOrder');\n\n/**\n * The mixin base class for API items that act as containers for other child items.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.  The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\n * to extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\n * the function that generates a subclass, an interface that describes the members of the subclass, and\n * a namespace containing static members of the class.\n *\n * Examples of `ApiItemContainerMixin` child classes include `ApiModel`, `ApiPackage`, `ApiEntryPoint`,\n * and `ApiEnum`.  But note that `Parameter` is not considered a \"member\" of an `ApiMethod`; this relationship\n * is modeled using {@link (ApiParameterListMixin:interface).parameters} instead\n * of {@link ApiItem.members}.\n *\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiItemContainerMixin extends ApiItem {\n  /**\n   * Disables automatic sorting of {@link ApiItem.members}.\n   *\n   * @remarks\n   * By default `ApiItemContainerMixin` will automatically sort its members according to their\n   * {@link ApiItem.getSortKey} string, which provides a standardized mostly alphabetical ordering\n   * that is appropriate for most API items.  When loading older .api.json files the automatic sorting\n   * is reapplied and may update the ordering.\n   *\n   * Set `preserveMemberOrder` to true to disable automatic sorting for this container; instead, the\n   * members will retain whatever ordering appeared in the {@link IApiItemContainerMixinOptions.members} array.\n   * The `preserveMemberOrder` option is saved in the .api.json file.\n   */\n  readonly preserveMemberOrder: boolean;\n\n  /**\n   * Adds a new member to the container.\n   *\n   * @remarks\n   * An ApiItem cannot be added to more than one container.\n   */\n  addMember(member: ApiItem): void;\n\n  /**\n   * Attempts to retrieve a member using its containerKey, or returns `undefined` if no matching member was found.\n   *\n   * @remarks\n   * Use the `getContainerKey()` static member to construct the key.  Each subclass has a different implementation\n   * of this function, according to the aspects that are important for identifying it.\n   *\n   * See {@link ApiItem.containerKey} for more information.\n   */\n  tryGetMemberByKey(containerKey: string): ApiItem | undefined;\n\n  /**\n   * Returns a list of members with the specified name.\n   */\n  findMembersByName(name: string): ReadonlyArray<ApiItem>;\n\n  /**\n   * Finds all of the ApiItem's immediate and inherited members by walking up the inheritance tree.\n   *\n   * @remarks\n   *\n   * Given the following class heritage:\n   *\n   * ```\n   * export class A {\n   *   public a: number|boolean;\n   * }\n   *\n   * export class B extends A {\n   *   public a: number;\n   *   public b: string;\n   * }\n   *\n   * export class C extends B {\n   *   public c: boolean;\n   * }\n   * ```\n   *\n   * Calling `findMembersWithInheritance` on `C` will return `B.a`, `B.b`, and `C.c`. Calling the\n   * method on `B` will return `B.a` and `B.b`. And calling the method on `A` will return just\n   * `A.a`.\n   *\n   * The inherited members returned by this method may be incomplete. If so, there will be a flag\n   * on the result object indicating this as well as messages explaining the errors in more detail.\n   * Some scenarios include:\n   *\n   * - Interface extending from a type alias.\n   *\n   * - Class extending from a variable.\n   *\n   * - Extending from a declaration not present in the model (e.g. external package).\n   *\n   * - Extending from an unexported declaration (e.g. ae-forgotten-export). Common in mixin\n   *   patterns.\n   *\n   * - Unexpected runtime errors...\n   *\n   * Lastly, be aware that the types of inherited members are returned with respect to their\n   * defining class as opposed to with respect to the inheriting class. For example, consider\n   * the following:\n   *\n   * ```\n   * export class A<T> {\n   *   public a: T;\n   * }\n   *\n   * export class B extends A<number> {}\n   * ```\n   *\n   * When called on `B`, this method will return `B.a` with type `T` as opposed to type\n   * `number`, although the latter is more accurate.\n   */\n  findMembersWithInheritance(): IFindApiItemsResult;\n\n  /**\n   * For a given member of this container, return its `ApiItem.getMergedSiblings()` list.\n   * @internal\n   */\n  _getMergedSiblingsForMember(memberApiItem: ApiItem): ReadonlyArray<ApiItem>;\n\n  /** @override */\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link ApiDeclaredItem}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiItemContainerMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiItemContainerMixin) {\n  class MixedClass extends baseClass implements ApiItemContainerMixin {\n    public readonly [_members]: ApiItem[];\n    public [_membersSorted]: boolean;\n    public [_membersByContainerKey]: Map<string, ApiItem>;\n    public [_preserveMemberOrder]: boolean;\n\n    // For members of this container that extend ApiNameMixin, this stores the list of members with a given name.\n    // Examples include merged declarations, overloaded functions, etc.\n    public [_membersByName]: Map<string, ApiItem[]> | undefined;\n\n    // For members of this container that do NOT extend ApiNameMixin, this stores the list of members\n    // that share a common ApiItemKind.  Examples include overloaded constructors or index signatures.\n    public [_membersByKind]: Map<string, ApiItem[]> | undefined; // key is ApiItemKind\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n      const options: IApiItemContainerMixinOptions = args[0] as IApiItemContainerMixinOptions;\n\n      this[_members] = [];\n      this[_membersSorted] = false;\n      this[_membersByContainerKey] = new Map<string, ApiItem>();\n      this[_preserveMemberOrder] = options.preserveMemberOrder ?? false;\n\n      if (options.members) {\n        for (const member of options.members) {\n          this.addMember(member);\n        }\n      }\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiItemContainerMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiItemContainerJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n      options.preserveMemberOrder = jsonObject.preserveMemberOrder;\n      options.members = [];\n      for (const memberObject of jsonObject.members) {\n        options.members.push(ApiItem.deserialize(memberObject, context));\n      }\n    }\n\n    /** @override */\n    public get members(): ReadonlyArray<ApiItem> {\n      if (!this[_membersSorted] && !this[_preserveMemberOrder]) {\n        LegacyAdapters.sortStable(this[_members], (x, y) => x.getSortKey().localeCompare(y.getSortKey()));\n        this[_membersSorted] = true;\n      }\n\n      return this[_members];\n    }\n\n    public get preserveMemberOrder(): boolean {\n      return this[_preserveMemberOrder];\n    }\n\n    public addMember(member: ApiItem): void {\n      if (this[_membersByContainerKey].has(member.containerKey)) {\n        throw new Error(\n          `Another member has already been added with the same name (${member.displayName})` +\n            ` and containerKey (${member.containerKey})`\n        );\n      }\n\n      const existingParent: ApiItem | undefined = member.parent;\n      if (existingParent !== undefined) {\n        throw new Error(\n          `This item has already been added to another container: \"${existingParent.displayName}\"`\n        );\n      }\n\n      this[_members].push(member);\n      this[_membersByName] = undefined; // invalidate the lookup\n      this[_membersByKind] = undefined; // invalidate the lookup\n      this[_membersSorted] = false;\n      this[_membersByContainerKey].set(member.containerKey, member);\n\n      member[apiItem_onParentChanged](this);\n    }\n\n    public tryGetMemberByKey(containerKey: string): ApiItem | undefined {\n      return this[_membersByContainerKey].get(containerKey);\n    }\n\n    public findMembersByName(name: string): ReadonlyArray<ApiItem> {\n      this._ensureMemberMaps();\n      return this[_membersByName]!.get(name) || [];\n    }\n\n    public findMembersWithInheritance(): IFindApiItemsResult {\n      const messages: IFindApiItemsMessage[] = [];\n      let maybeIncompleteResult: boolean = false;\n\n      const membersByName: Map<string, ApiItem[]> = new Map();\n      const membersByKind: Map<ApiItemKind, ApiItem[]> = new Map();\n\n      const toVisit: ApiItem[] = [];\n      let next: ApiItem | undefined = this;\n\n      while (next) {\n        const membersToAdd: ApiItem[] = [];\n\n        // For each member, check to see if we've already seen a member with the same name\n        // previously in the inheritance tree. If so, we know we won't inherit it, and thus\n        // do not add it to our `membersToAdd` array.\n        for (const member of next.members) {\n          // We add the to-be-added members to an intermediate array instead of immediately\n          // to the maps themselves to support method overloads with the same name.\n          if (ApiNameMixin.isBaseClassOf(member)) {\n            if (!membersByName.has(member.name)) {\n              membersToAdd.push(member);\n            }\n          } else {\n            if (!membersByKind.has(member.kind)) {\n              membersToAdd.push(member);\n            }\n          }\n        }\n\n        for (const member of membersToAdd) {\n          if (ApiNameMixin.isBaseClassOf(member)) {\n            const members: ApiItem[] = membersByName.get(member.name) || [];\n            members.push(member);\n            membersByName.set(member.name, members);\n          } else {\n            const members: ApiItem[] = membersByKind.get(member.kind) || [];\n            members.push(member);\n            membersByKind.set(member.kind, members);\n          }\n        }\n\n        // Interfaces can extend multiple interfaces, so iterate through all of them.\n        const extendedItems: ApiItem[] = [];\n        let extendsTypes: readonly HeritageType[] | undefined;\n\n        switch (next.kind) {\n          case ApiItemKind.Class: {\n            const apiClass: ApiClass = next as ApiClass;\n            extendsTypes = apiClass.extendsType ? [apiClass.extendsType] : [];\n            break;\n          }\n          case ApiItemKind.Interface: {\n            const apiInterface: ApiInterface = next as ApiInterface;\n            extendsTypes = apiInterface.extendsTypes;\n            break;\n          }\n        }\n\n        if (extendsTypes === undefined) {\n          messages.push({\n            messageId: FindApiItemsMessageId.UnsupportedKind,\n            text: `Item ${next.displayName} is of unsupported kind ${next.kind}.`\n          });\n          maybeIncompleteResult = true;\n          break;\n        }\n\n        for (const extendsType of extendsTypes) {\n          // We want to find the reference token associated with the actual inherited declaration.\n          // In every case we support, this is the first reference token. For example:\n          //\n          // ```\n          // export class A extends B {}\n          //                        ^\n          // export class A extends B<C> {}\n          //                        ^\n          // export class A extends B.C {}\n          //                        ^^^\n          // ```\n          const firstReferenceToken: ExcerptToken | undefined = extendsType.excerpt.spannedTokens.find(\n            (token: ExcerptToken) => {\n              return token.kind === ExcerptTokenKind.Reference && token.canonicalReference;\n            }\n          );\n\n          if (!firstReferenceToken) {\n            messages.push({\n              messageId: FindApiItemsMessageId.UnexpectedExcerptTokens,\n              text: `Encountered unexpected excerpt tokens in ${next.displayName}. Excerpt: ${extendsType.excerpt.text}.`\n            });\n            maybeIncompleteResult = true;\n            continue;\n          }\n\n          const apiModel: ApiModel | undefined = this.getAssociatedModel();\n          if (!apiModel) {\n            messages.push({\n              messageId: FindApiItemsMessageId.MissingApiModel,\n              text: `Unable to get the associated model of ${next.displayName}.`\n            });\n            maybeIncompleteResult = true;\n            continue;\n          }\n\n          const apiItemResult: IResolveDeclarationReferenceResult = apiModel.resolveDeclarationReference(\n            firstReferenceToken.canonicalReference!,\n            undefined\n          );\n\n          const apiItem: ApiItem | undefined = apiItemResult.resolvedApiItem;\n          if (!apiItem) {\n            messages.push({\n              messageId: FindApiItemsMessageId.DeclarationResolutionFailed,\n              text: `Declaration resolution failed for ${next.displayName}. Error message: ${apiItemResult.errorMessage}.`\n            });\n            maybeIncompleteResult = true;\n            continue;\n          }\n\n          extendedItems.push(apiItem);\n        }\n\n        // For classes, this array will only have one item. For interfaces, there may be multiple items. Sort the array\n        // into alphabetical order before adding to our list of API items to visit. This ensures that in the case\n        // of multiple interface inheritance, a member inherited from multiple interfaces is attributed to the interface\n        // earlier in alphabetical order (as opposed to source order).\n        //\n        // For example, in the code block below, `Bar.x` is reported as the inherited item, not `Foo.x`.\n        //\n        // ```\n        // interface Foo {\n        //   public x: string;\n        // }\n        //\n        // interface Bar {\n        //   public x: string;\n        // }\n        //\n        // interface FooBar extends Foo, Bar {}\n        // ```\n        LegacyAdapters.sortStable(extendedItems, (x: ApiItem, y: ApiItem) =>\n          x.getSortKey().localeCompare(y.getSortKey())\n        );\n\n        toVisit.push(...extendedItems);\n        next = toVisit.shift();\n      }\n\n      const items: ApiItem[] = [];\n      for (const members of membersByName.values()) {\n        items.push(...members);\n      }\n      for (const members of membersByKind.values()) {\n        items.push(...members);\n      }\n      LegacyAdapters.sortStable(items, (x: ApiItem, y: ApiItem) =>\n        x.getSortKey().localeCompare(y.getSortKey())\n      );\n\n      return {\n        items,\n        messages,\n        maybeIncompleteResult\n      };\n    }\n\n    /** @internal */\n    public _getMergedSiblingsForMember(memberApiItem: ApiItem): ReadonlyArray<ApiItem> {\n      this._ensureMemberMaps();\n      let result: ApiItem[] | undefined;\n      if (ApiNameMixin.isBaseClassOf(memberApiItem)) {\n        result = this[_membersByName]!.get(memberApiItem.name);\n      } else {\n        result = this[_membersByKind]!.get(memberApiItem.kind);\n      }\n      if (!result) {\n        throw new InternalError('Item was not found in the _membersByName/_membersByKind lookup');\n      }\n      return result;\n    }\n\n    /** @internal */\n    public _ensureMemberMaps(): void {\n      // Build the _membersByName and _membersByKind tables if they don't already exist\n      if (this[_membersByName] === undefined) {\n        const membersByName: Map<string, ApiItem[]> = new Map<string, ApiItem[]>();\n        const membersByKind: Map<string, ApiItem[]> = new Map<string, ApiItem[]>();\n\n        for (const member of this[_members]) {\n          let map: Map<string, ApiItem[]> | Map<ApiItemKind, ApiItem[]>;\n          let key: string | ApiItemKind;\n\n          if (ApiNameMixin.isBaseClassOf(member)) {\n            map = membersByName;\n            key = member.name;\n          } else {\n            map = membersByKind;\n            key = member.kind;\n          }\n\n          let list: ApiItem[] | undefined = map.get(key);\n          if (list === undefined) {\n            list = [];\n            map.set(key, list);\n          }\n          list.push(member);\n        }\n\n        this[_membersByName] = membersByName;\n        this[_membersByKind] = membersByKind;\n      }\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiItemContainerJson>): void {\n      super.serializeInto(jsonObject);\n\n      const memberObjects: IApiItemJson[] = [];\n\n      for (const member of this.members) {\n        const memberJsonObject: Partial<IApiItemJson> = {};\n        member.serializeInto(memberJsonObject);\n        memberObjects.push(memberJsonObject as IApiItemJson);\n      }\n\n      jsonObject.preserveMemberOrder = this.preserveMemberOrder;\n      jsonObject.members = memberObjects;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiItemContainerMixin:interface)}.\n * @public\n */\nexport namespace ApiItemContainerMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiItemContainerMixin` mixin.\n   *\n   * @remarks\n   *\n   * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\n   * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however\n   * the TypeScript type system cannot invoke a runtime test.)\n   */\n  export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiItemContainerMixin {\n    return apiItem.hasOwnProperty(_members);\n  }\n}\n"]}

package/lib/mixins/IFindApiItemsResult.d.ts

@@ -0,0 +1,58 @@
+import { ApiItem } from '../items/ApiItem';
+/**
+ * Generic result object for finding API items used by different kinds of find operations.
+ * @public
+ */
+export interface IFindApiItemsResult {
+    /**
+     * The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.
+     */
+    items: ApiItem[];
+    /**
+     * Diagnostic messages regarding the find operation.
+     */
+    messages: IFindApiItemsMessage[];
+    /**
+     * Indicates whether the result is potentially incomplete due to errors during the find operation.
+     * If true, the `messages` explain the errors in more detail.
+     */
+    maybeIncompleteResult: boolean;
+}
+/**
+ * This object is used for messages returned as part of `IFindApiItemsResult`.
+ * @public
+ */
+export interface IFindApiItemsMessage {
+    /**
+     * Unique identifier for the message.
+     * @beta
+     */
+    messageId: FindApiItemsMessageId;
+    /**
+     * Text description of the message.
+     */
+    text: string;
+}
+/**
+ * Unique identifiers for messages returned as part of `IFindApiItemsResult`.
+ * @beta
+ */
+export declare enum FindApiItemsMessageId {
+    /**
+     * "Declaration resolution failed for ___. Error message: ___."
+     */
+    DeclarationResolutionFailed = "declaration-resolution-failed",
+    /**
+     * "Unable to get the associated model of ___."
+     */
+    MissingApiModel = "missing-api-model",
+    /**
+     * "Encountered unexpected excerpt tokens in ___. Excerpt: ___."
+     */
+    UnexpectedExcerptTokens = "unexpected-excerpt-tokens",
+    /**
+     * Item ___ is of unsupported kind ___."
+     */
+    UnsupportedKind = "unsupported-kind"
+}
+//# sourceMappingURL=IFindApiItemsResult.d.ts.map

package/lib/mixins/IFindApiItemsResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFindApiItemsResult.d.ts","sourceRoot":"","sources":["../../src/mixins/IFindApiItemsResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,SAAS,EAAE,qBAAqB,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,2BAA2B,kCAAkC;IAE7D;;OAEG;IACH,eAAe,sBAAsB;IAErC;;OAEG;IACH,uBAAuB,8BAA8B;IAErD;;OAEG;IACH,eAAe,qBAAqB;CACrC"}

package/lib/mixins/IFindApiItemsResult.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FindApiItemsMessageId = void 0;
+/**
+ * Unique identifiers for messages returned as part of `IFindApiItemsResult`.
+ * @beta
+ */
+var FindApiItemsMessageId;
+(function (FindApiItemsMessageId) {
+    /**
+     * "Declaration resolution failed for ___. Error message: ___."
+     */
+    FindApiItemsMessageId["DeclarationResolutionFailed"] = "declaration-resolution-failed";
+    /**
+     * "Unable to get the associated model of ___."
+     */
+    FindApiItemsMessageId["MissingApiModel"] = "missing-api-model";
+    /**
+     * "Encountered unexpected excerpt tokens in ___. Excerpt: ___."
+     */
+    FindApiItemsMessageId["UnexpectedExcerptTokens"] = "unexpected-excerpt-tokens";
+    /**
+     * Item ___ is of unsupported kind ___."
+     */
+    FindApiItemsMessageId["UnsupportedKind"] = "unsupported-kind";
+})(FindApiItemsMessageId = exports.FindApiItemsMessageId || (exports.FindApiItemsMessageId = {}));
+//# sourceMappingURL=IFindApiItemsResult.js.map

package/lib/mixins/IFindApiItemsResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFindApiItemsResult.js","sourceRoot":"","sources":["../../src/mixins/IFindApiItemsResult.ts"],"names":[],"mappings":";;;AAyCA;;;GAGG;AACH,IAAY,qBAoBX;AApBD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,sFAA6D,CAAA;IAE7D;;OAEG;IACH,8DAAqC,CAAA;IAErC;;OAEG;IACH,8EAAqD,CAAA;IAErD;;OAEG;IACH,6DAAoC,CAAA;AACtC,CAAC,EApBW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAoBhC","sourcesContent":["import { ApiItem } from '../items/ApiItem';\n\n/**\n * Generic result object for finding API items used by different kinds of find operations.\n * @public\n */\nexport interface IFindApiItemsResult {\n  /**\n   * The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.\n   */\n  items: ApiItem[];\n\n  /**\n   * Diagnostic messages regarding the find operation.\n   */\n  messages: IFindApiItemsMessage[];\n\n  /**\n   * Indicates whether the result is potentially incomplete due to errors during the find operation.\n   * If true, the `messages` explain the errors in more detail.\n   */\n  maybeIncompleteResult: boolean;\n}\n\n/**\n * This object is used for messages returned as part of `IFindApiItemsResult`.\n * @public\n */\nexport interface IFindApiItemsMessage {\n  /**\n   * Unique identifier for the message.\n   * @beta\n   */\n  messageId: FindApiItemsMessageId;\n\n  /**\n   * Text description of the message.\n   */\n  text: string;\n}\n\n/**\n * Unique identifiers for messages returned as part of `IFindApiItemsResult`.\n * @beta\n */\nexport enum FindApiItemsMessageId {\n  /**\n   * \"Declaration resolution failed for ___. Error message: ___.\"\n   */\n  DeclarationResolutionFailed = 'declaration-resolution-failed',\n\n  /**\n   * \"Unable to get the associated model of ___.\"\n   */\n  MissingApiModel = 'missing-api-model',\n\n  /**\n   * \"Encountered unexpected excerpt tokens in ___. Excerpt: ___.\"\n   */\n  UnexpectedExcerptTokens = 'unexpected-excerpt-tokens',\n\n  /**\n   * Item ___ is of unsupported kind ___.\"\n   */\n  UnsupportedKind = 'unsupported-kind'\n}\n"]}

package/lib/model/HeritageType.d.ts

@@ -1,6 +1,8 @@
 import { Excerpt } from '../mixins/Excerpt';
 /**
- * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class.
+ * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class
+ * or interface.
+ *
  * @remarks
  *
  * For example, consider this declaration:

package/lib/model/HeritageType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HeritageType.d.ts","sourceRoot":"","sources":["../../src/model/HeritageType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,OAAO;CAGpC"}
+{"version":3,"file":"HeritageType.d.ts","sourceRoot":"","sources":["../../src/model/HeritageType.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,OAAO;CAGpC"}

package/lib/model/HeritageType.js

@@ -4,7 +4,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HeritageType = void 0;
 /**
- * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class.
+ * Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class
+ * or interface.
+ *
  * @remarks
  *
  * For example, consider this declaration:

package/lib/model/HeritageType.js.map

@@ -1 +1 @@
-{"version":3,"file":"HeritageType.js","sourceRoot":"","sources":["../../src/model/HeritageType.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D;;;;;;;;;;;;;;GAcG;AACH,MAAa,YAAY;IAiBvB,YAAmB,OAAgB;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AApBD,oCAoBC","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 { Excerpt } from '../mixins/Excerpt';\n\n/**\n * Represents a type referenced via an \"extends\" or \"implements\" heritage clause for a TypeScript class.\n * @remarks\n *\n * For example, consider this declaration:\n *\n * ```ts\n * export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable {\n *   // . . .\n * }\n * ```\n *\n * The heritage types are `Controls.WidgetBase`, `Controls.IWidget`, and `IDisposable`.\n * @public\n */\nexport class HeritageType {\n  /**\n   * An excerpt corresponding to the referenced type.\n   * @remarks\n   *\n   * For example, consider this declaration:\n   *\n   * ```ts\n   * export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable {\n   *   // . . .\n   * }\n   * ```\n   *\n   * The excerpt might be `Controls.WidgetBase`, `Controls.IWidget`, or `IDisposable`.\n   */\n  public readonly excerpt: Excerpt;\n\n  public constructor(excerpt: Excerpt) {\n    this.excerpt = excerpt;\n  }\n}\n"]}
+{"version":3,"file":"HeritageType.js","sourceRoot":"","sources":["../../src/model/HeritageType.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAAY;IAiBvB,YAAmB,OAAgB;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AApBD,oCAoBC","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 { Excerpt } from '../mixins/Excerpt';\n\n/**\n * Represents a type referenced via an \"extends\" or \"implements\" heritage clause for a TypeScript class\n * or interface.\n *\n * @remarks\n *\n * For example, consider this declaration:\n *\n * ```ts\n * export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable {\n *   // . . .\n * }\n * ```\n *\n * The heritage types are `Controls.WidgetBase`, `Controls.IWidget`, and `IDisposable`.\n * @public\n */\nexport class HeritageType {\n  /**\n   * An excerpt corresponding to the referenced type.\n   * @remarks\n   *\n   * For example, consider this declaration:\n   *\n   * ```ts\n   * export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable {\n   *   // . . .\n   * }\n   * ```\n   *\n   * The excerpt might be `Controls.WidgetBase`, `Controls.IWidget`, or `IDisposable`.\n   */\n  public readonly excerpt: Excerpt;\n\n  public constructor(excerpt: Excerpt) {\n    this.excerpt = excerpt;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/api-extractor-model",
-  "version": "7.21.0",
+  "version": "7.22.0",
   "description": "A helper library for loading and saving the .api.json files created by API Extractor",
   "repository": {
     "type": "git",