@microsoft/api-extractor-model 7.32.1 → 7.33.0

package/lib-esm/mixins/ApiItemContainerMixin.js

@@ -0,0 +1,319 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/* eslint-disable @typescript-eslint/no-redeclare */
+import { InternalError } from '@rushstack/node-core-library';
+import { ApiItem, apiItem_onParentChanged, ApiItemKind } from '../items/ApiItem';
+import { ApiNameMixin } from './ApiNameMixin';
+import { ExcerptTokenKind } from './Excerpt';
+import { FindApiItemsMessageId } from './IFindApiItemsResult';
+const _members = Symbol('ApiItemContainerMixin._members');
+const _membersSorted = Symbol('ApiItemContainerMixin._membersSorted');
+const _membersByContainerKey = Symbol('ApiItemContainerMixin._membersByContainerKey');
+const _membersByName = Symbol('ApiItemContainerMixin._membersByName');
+const _membersByKind = Symbol('ApiItemContainerMixin._membersByKind');
+const _preserveMemberOrder = Symbol('ApiItemContainerMixin._preserveMemberOrder');
+/**
+ * Mixin function for {@link ApiDeclaredItem}.
+ *
+ * @param baseClass - The base class to be extended
+ * @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.
+ *
+ * @public
+ */
+export function ApiItemContainerMixin(baseClass
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    class MixedClass extends baseClass {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(...args) {
+            var _a;
+            super(...args);
+            const options = args[0];
+            this[_members] = [];
+            this[_membersSorted] = false;
+            this[_membersByContainerKey] = new Map();
+            this[_preserveMemberOrder] = (_a = options.preserveMemberOrder) !== null && _a !== void 0 ? _a : false;
+            if (options.members) {
+                for (const member of options.members) {
+                    this.addMember(member);
+                }
+            }
+        }
+        /** @override */
+        static onDeserializeInto(options, context, jsonObject) {
+            baseClass.onDeserializeInto(options, context, jsonObject);
+            options.preserveMemberOrder = jsonObject.preserveMemberOrder;
+            options.members = [];
+            for (const memberObject of jsonObject.members) {
+                options.members.push(ApiItem.deserialize(memberObject, context));
+            }
+        }
+        /** @override */
+        get members() {
+            if (!this[_membersSorted] && !this[_preserveMemberOrder]) {
+                this[_members].sort((x, y) => x.getSortKey().localeCompare(y.getSortKey()));
+                this[_membersSorted] = true;
+            }
+            return this[_members];
+        }
+        get preserveMemberOrder() {
+            return this[_preserveMemberOrder];
+        }
+        addMember(member) {
+            if (this[_membersByContainerKey].has(member.containerKey)) {
+                throw new Error(`Another member has already been added with the same name (${member.displayName})` +
+                    ` and containerKey (${member.containerKey})`);
+            }
+            const existingParent = member.parent;
+            if (existingParent !== undefined) {
+                throw new Error(`This item has already been added to another container: "${existingParent.displayName}"`);
+            }
+            this[_members].push(member);
+            this[_membersByName] = undefined; // invalidate the lookup
+            this[_membersByKind] = undefined; // invalidate the lookup
+            this[_membersSorted] = false;
+            this[_membersByContainerKey].set(member.containerKey, member);
+            member[apiItem_onParentChanged](this);
+        }
+        tryGetMemberByKey(containerKey) {
+            return this[_membersByContainerKey].get(containerKey);
+        }
+        findMembersByName(name) {
+            this._ensureMemberMaps();
+            return this[_membersByName].get(name) || [];
+        }
+        findMembersWithInheritance() {
+            const messages = [];
+            let maybeIncompleteResult = false;
+            // For API items that don't support inheritance, this method just returns the item's
+            // immediate members.
+            switch (this.kind) {
+                case ApiItemKind.Class:
+                case ApiItemKind.Interface:
+                    break;
+                default: {
+                    return {
+                        items: this.members.concat(),
+                        messages,
+                        maybeIncompleteResult
+                    };
+                }
+            }
+            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.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.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 ApiItemKind.Class: {
+                        const apiClass = next;
+                        extendsTypes = apiClass.extendsType ? [apiClass.extendsType] : [];
+                        break;
+                    }
+                    case ApiItemKind.Interface: {
+                        const apiInterface = next;
+                        extendsTypes = apiInterface.extendsTypes;
+                        break;
+                    }
+                }
+                if (extendsTypes === undefined) {
+                    messages.push({
+                        messageId: FindApiItemsMessageId.UnsupportedKind,
+                        text: `Unable to analyze references of API item ${next.displayName} because it is of unsupported kind ${next.kind}`
+                    });
+                    maybeIncompleteResult = true;
+                    next = toVisit.shift();
+                    continue;
+                }
+                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 === ExcerptTokenKind.Reference && token.canonicalReference;
+                    });
+                    if (!firstReferenceToken) {
+                        messages.push({
+                            messageId: FindApiItemsMessageId.ExtendsClauseMissingReference,
+                            text: `Unable to analyze extends clause ${extendsType.excerpt.text} of API item ${next.displayName} because no canonical reference was found`
+                        });
+                        maybeIncompleteResult = true;
+                        continue;
+                    }
+                    const apiModel = this.getAssociatedModel();
+                    if (!apiModel) {
+                        messages.push({
+                            messageId: FindApiItemsMessageId.NoAssociatedApiModel,
+                            text: `Unable to analyze references of API item ${next.displayName} because it is not associated with an ApiModel`
+                        });
+                        maybeIncompleteResult = true;
+                        continue;
+                    }
+                    const canonicalReference = firstReferenceToken.canonicalReference;
+                    const apiItemResult = apiModel.resolveDeclarationReference(canonicalReference, undefined);
+                    const apiItem = apiItemResult.resolvedApiItem;
+                    if (!apiItem) {
+                        messages.push({
+                            messageId: FindApiItemsMessageId.DeclarationResolutionFailed,
+                            text: `Unable to resolve declaration reference within API item ${next.displayName}: ${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 {}
+                // ```
+                extendedItems.sort((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);
+            }
+            items.sort((x, y) => x.getSortKey().localeCompare(y.getSortKey()));
+            return {
+                items,
+                messages,
+                maybeIncompleteResult
+            };
+        }
+        /** @internal */
+        _getMergedSiblingsForMember(memberApiItem) {
+            this._ensureMemberMaps();
+            let result;
+            if (ApiNameMixin.isBaseClassOf(memberApiItem)) {
+                result = this[_membersByName].get(memberApiItem.name);
+            }
+            else {
+                result = this[_membersByKind].get(memberApiItem.kind);
+            }
+            if (!result) {
+                throw new InternalError('Item was not found in the _membersByName/_membersByKind lookup');
+            }
+            return result;
+        }
+        /** @internal */
+        _ensureMemberMaps() {
+            // Build the _membersByName and _membersByKind tables if they don't already exist
+            if (this[_membersByName] === undefined) {
+                const membersByName = new Map();
+                const membersByKind = new Map();
+                for (const member of this[_members]) {
+                    let map;
+                    let key;
+                    if (ApiNameMixin.isBaseClassOf(member)) {
+                        map = membersByName;
+                        key = member.name;
+                    }
+                    else {
+                        map = membersByKind;
+                        key = member.kind;
+                    }
+                    let list = map.get(key);
+                    if (list === undefined) {
+                        list = [];
+                        map.set(key, list);
+                    }
+                    list.push(member);
+                }
+                this[_membersByName] = membersByName;
+                this[_membersByKind] = membersByKind;
+            }
+        }
+        /** @override */
+        serializeInto(jsonObject) {
+            super.serializeInto(jsonObject);
+            const memberObjects = [];
+            for (const member of this.members) {
+                const memberJsonObject = {};
+                member.serializeInto(memberJsonObject);
+                memberObjects.push(memberJsonObject);
+            }
+            jsonObject.preserveMemberOrder = this.preserveMemberOrder;
+            jsonObject.members = memberObjects;
+        }
+    }
+    return MixedClass;
+}
+/**
+ * Static members for {@link (ApiItemContainerMixin:interface)}.
+ * @public
+ */
+(function (ApiItemContainerMixin) {
+    /**
+     * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiItemContainerMixin` mixin.
+     *
+     * @remarks
+     *
+     * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of
+     * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however
+     * the TypeScript type system cannot invoke a runtime test.)
+     */
+    function isBaseClassOf(apiItem) {
+        return apiItem.hasOwnProperty(_members);
+    }
+    ApiItemContainerMixin.isBaseClassOf = isBaseClassOf;
+})(ApiItemContainerMixin || (ApiItemContainerMixin = {}));
+//# sourceMappingURL=ApiItemContainerMixin.js.map

package/lib-esm/mixins/ApiItemContainerMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiItemContainerMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiItemContainerMixin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,oDAAoD;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAG7D,OAAO,EACL,OAAO,EACP,uBAAuB,EAIvB,WAAW,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAK9C,OAAO,EAAqB,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAGL,qBAAqB,EACtB,MAAM,uBAAuB,CAAC;AAkB/B,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,MAAM,UAAU,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,CAAC;gBACpB,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;oBACrC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;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,CAAC;gBAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;QAED,gBAAgB;QAChB,IAAW,OAAO;YAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC5E,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;YAC9B,CAAC;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,CAAC;gBAC1D,MAAM,IAAI,KAAK,CACb,6DAA6D,MAAM,CAAC,WAAW,GAAG;oBAChF,sBAAsB,MAAM,CAAC,YAAY,GAAG,CAC/C,CAAC;YACJ,CAAC;YAED,MAAM,cAAc,GAAwB,MAAM,CAAC,MAAM,CAAC;YAC1D,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,2DAA2D,cAAc,CAAC,WAAW,GAAG,CACzF,CAAC;YACJ,CAAC;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,uBAAuB,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,oFAAoF;YACpF,qBAAqB;YACrB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,WAAW,CAAC,KAAK,CAAC;gBACvB,KAAK,WAAW,CAAC,SAAS;oBACxB,MAAM;gBACR,OAAO,CAAC,CAAC,CAAC;oBACR,OAAO;wBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;wBAC5B,QAAQ;wBACR,qBAAqB;qBACtB,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,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,CAAC;gBACZ,MAAM,YAAY,GAAc,EAAE,CAAC;gBAEnC,kFAAkF;gBAClF,mFAAmF;gBACnF,6CAA6C;gBAC7C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClC,iFAAiF;oBACjF,yEAAyE;oBACzE,IAAI,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;wBACvC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;4BACpC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBAC5B,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;4BACpC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBAC5B,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;oBAClC,IAAI,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;wBACvC,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;oBAC1C,CAAC;yBAAM,CAAC;wBACN,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;oBAC1C,CAAC;gBACH,CAAC;gBAED,6EAA6E;gBAC7E,MAAM,aAAa,GAAc,EAAE,CAAC;gBACpC,IAAI,YAAiD,CAAC;gBAEtD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBAClB,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;wBACvB,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;oBACR,CAAC;oBACD,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;wBAC3B,MAAM,YAAY,GAAiB,IAAoB,CAAC;wBACxD,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;wBACzC,MAAM;oBACR,CAAC;gBACH,CAAC;gBAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,QAAQ,CAAC,IAAI,CAAC;wBACZ,SAAS,EAAE,qBAAqB,CAAC,eAAe;wBAChD,IAAI,EAAE,4CAA4C,IAAI,CAAC,WAAW,sCAAsC,IAAI,CAAC,IAAI,EAAE;qBACpH,CAAC,CAAC;oBACH,qBAAqB,GAAG,IAAI,CAAC;oBAC7B,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;oBACvB,SAAS;gBACX,CAAC;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;oBACvC,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,gBAAgB,CAAC,SAAS,IAAI,KAAK,CAAC,kBAAkB,CAAC;oBAC/E,CAAC,CACF,CAAC;oBAEF,IAAI,CAAC,mBAAmB,EAAE,CAAC;wBACzB,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,qBAAqB,CAAC,6BAA6B;4BAC9D,IAAI,EAAE,oCAAoC,WAAW,CAAC,OAAO,CAAC,IAAI,gBAAgB,IAAI,CAAC,WAAW,2CAA2C;yBAC9I,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;oBACX,CAAC;oBAED,MAAM,QAAQ,GAAyB,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBACjE,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACd,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,qBAAqB,CAAC,oBAAoB;4BACrD,IAAI,EAAE,4CAA4C,IAAI,CAAC,WAAW,gDAAgD;yBACnH,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;oBACX,CAAC;oBAED,MAAM,kBAAkB,GAAyB,mBAAmB,CAAC,kBAAmB,CAAC;oBACzF,MAAM,aAAa,GAAuC,QAAQ,CAAC,2BAA2B,CAC5F,kBAAkB,EAClB,SAAS,CACV,CAAC;oBAEF,MAAM,OAAO,GAAwB,aAAa,CAAC,eAAe,CAAC;oBACnE,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,QAAQ,CAAC,IAAI,CAAC;4BACZ,SAAS,EAAE,qBAAqB,CAAC,2BAA2B;4BAC5D,IAAI,EAAE,2DAA2D,IAAI,CAAC,WAAW,KAAK,aAAa,CAAC,YAAY,EAAE;yBACnH,CAAC,CAAC;wBACH,qBAAqB,GAAG,IAAI,CAAC;wBAC7B,SAAS;oBACX,CAAC;oBAED,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;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,aAAa,CAAC,IAAI,CAAC,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAE7F,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;gBAC/B,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;YACzB,CAAC;YAED,MAAM,KAAK,GAAc,EAAE,CAAC;YAC5B,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC7C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC7C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YACzB,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAErF,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,YAAY,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC9C,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,IAAI,CAAC,cAAc,CAAE,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,aAAa,CAAC,gEAAgE,CAAC,CAAC;YAC5F,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gBAAgB;QACT,iBAAiB;YACtB,iFAAiF;YACjF,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;gBACvC,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,CAAC;oBACpC,IAAI,GAAyD,CAAC;oBAC9D,IAAI,GAAyB,CAAC;oBAE9B,IAAI,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;wBACvC,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;oBACpB,CAAC;yBAAM,CAAC;wBACN,GAAG,GAAG,aAAa,CAAC;wBACpB,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;oBACpB,CAAC;oBAED,IAAI,IAAI,GAA0B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC/C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;wBACvB,IAAI,GAAG,EAAE,CAAC;wBACV,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;oBACrB,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpB,CAAC;gBAED,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,aAAa,CAAC;YACvC,CAAC;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,CAAC;gBAClC,MAAM,gBAAgB,GAA0B,EAAE,CAAC;gBACnD,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;gBACvC,aAAa,CAAC,IAAI,CAAC,gBAAgC,CAAC,CAAC;YACvD,CAAC;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;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,KAArB,qBAAqB,QAarC","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/* eslint-disable @typescript-eslint/no-redeclare */\n\nimport { InternalError } from '@rushstack/node-core-library';\nimport type { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport {\n  ApiItem,\n  apiItem_onParentChanged,\n  type IApiItemJson,\n  type IApiItemOptions,\n  type IApiItemConstructor,\n  ApiItemKind\n} from '../items/ApiItem';\nimport { ApiNameMixin } from './ApiNameMixin';\nimport type { DeserializerContext } from '../model/DeserializerContext';\nimport type { ApiModel } from '../model/ApiModel';\nimport type { ApiClass } from '../model/ApiClass';\nimport type { ApiInterface } from '../model/ApiInterface';\nimport { type ExcerptToken, ExcerptTokenKind } from './Excerpt';\nimport {\n  type IFindApiItemsResult,\n  type IFindApiItemsMessage,\n  FindApiItemsMessageId\n} from './IFindApiItemsResult';\nimport type { HeritageType } from '../model/HeritageType';\nimport type { 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        this[_members].sort((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      // For API items that don't support inheritance, this method just returns the item's\n      // immediate members.\n      switch (this.kind) {\n        case ApiItemKind.Class:\n        case ApiItemKind.Interface:\n          break;\n        default: {\n          return {\n            items: this.members.concat(),\n            messages,\n            maybeIncompleteResult\n          };\n        }\n      }\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: `Unable to analyze references of API item ${next.displayName} because it is of unsupported kind ${next.kind}`\n          });\n          maybeIncompleteResult = true;\n          next = toVisit.shift();\n          continue;\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.ExtendsClauseMissingReference,\n              text: `Unable to analyze extends clause ${extendsType.excerpt.text} of API item ${next.displayName} because no canonical reference was found`\n            });\n            maybeIncompleteResult = true;\n            continue;\n          }\n\n          const apiModel: ApiModel | undefined = this.getAssociatedModel();\n          if (!apiModel) {\n            messages.push({\n              messageId: FindApiItemsMessageId.NoAssociatedApiModel,\n              text: `Unable to analyze references of API item ${next.displayName} because it is not associated with an ApiModel`\n            });\n            maybeIncompleteResult = true;\n            continue;\n          }\n\n          const canonicalReference: DeclarationReference = firstReferenceToken.canonicalReference!;\n          const apiItemResult: IResolveDeclarationReferenceResult = apiModel.resolveDeclarationReference(\n            canonicalReference,\n            undefined\n          );\n\n          const apiItem: ApiItem | undefined = apiItemResult.resolvedApiItem;\n          if (!apiItem) {\n            messages.push({\n              messageId: FindApiItemsMessageId.DeclarationResolutionFailed,\n              text: `Unable to resolve declaration reference within API item ${next.displayName}: ${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        extendedItems.sort((x: ApiItem, y: ApiItem) => x.getSortKey().localeCompare(y.getSortKey()));\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      items.sort((x: ApiItem, y: ApiItem) => x.getSortKey().localeCompare(y.getSortKey()));\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-esm/mixins/ApiNameMixin.js

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const _name = Symbol('ApiNameMixin._name');
+/**
+ * Mixin function for {@link (ApiNameMixin:interface)}.
+ *
+ * @param baseClass - The base class to be extended
+ * @returns A child class that extends baseClass, adding the {@link (ApiNameMixin:interface)} functionality.
+ *
+ * @public
+ */
+export function ApiNameMixin(baseClass
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    class MixedClass extends baseClass {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(...args) {
+            super(...args);
+            const options = args[0];
+            this[_name] = options.name;
+        }
+        /** @override */
+        static onDeserializeInto(options, context, jsonObject) {
+            baseClass.onDeserializeInto(options, context, jsonObject);
+            options.name = jsonObject.name;
+        }
+        get name() {
+            return this[_name];
+        }
+        /** @override */
+        get displayName() {
+            return this[_name];
+        }
+        /** @override */
+        serializeInto(jsonObject) {
+            super.serializeInto(jsonObject);
+            jsonObject.name = this.name;
+        }
+    }
+    return MixedClass;
+}
+/**
+ * Static members for {@link (ApiNameMixin:interface)}.
+ * @public
+ */
+(function (ApiNameMixin) {
+    /**
+     * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiNameMixin` mixin.
+     *
+     * @remarks
+     *
+     * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of
+     * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however
+     * the TypeScript type system cannot invoke a runtime test.)
+     */
+    function isBaseClassOf(apiItem) {
+        return apiItem.hasOwnProperty(_name);
+    }
+    ApiNameMixin.isBaseClassOf = isBaseClassOf;
+})(ApiNameMixin || (ApiNameMixin = {}));
+//# sourceMappingURL=ApiNameMixin.js.map

package/lib-esm/mixins/ApiNameMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiNameMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiNameMixin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAmB3D,MAAM,KAAK,GAAkB,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAgC1D;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAGhC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAyB,IAAI,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC7B,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;YAE7B,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QACjC,CAAC;QAED,IAAW,IAAI;YACb,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,gBAAgB;QAChB,IAAW,WAAW;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAAsC;YACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,WAAiB,YAAY;IAC3B;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAFe,0BAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,YAAY,KAAZ,YAAY,QAa5B","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/* eslint-disable @typescript-eslint/no-redeclare */\n\nimport type { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\nimport type { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Constructor options for {@link (IApiNameMixinOptions:interface)}.\n * @public\n */\nexport interface IApiNameMixinOptions extends IApiItemOptions {\n  name: string;\n}\n\nexport interface IApiNameMixinJson extends IApiItemJson {\n  name: string;\n}\n\nconst _name: unique symbol = Symbol('ApiNameMixin._name');\n\n/**\n * The mixin base class for API items that have a name.  For example, a class has a name, but a class constructor\n * does not.\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 * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiNameMixin extends ApiItem {\n  /**\n   * The exported name of this API item.\n   *\n   * @remarks\n   * Note that due tue type aliasing, the exported name may be different from the locally declared name.\n   */\n  readonly name: string;\n\n  /** @override */\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link (ApiNameMixin:interface)}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiNameMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiNameMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiNameMixin) {\n  class MixedClass extends baseClass implements ApiNameMixin {\n    public readonly [_name]: string;\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n\n      const options: IApiNameMixinOptions = args[0];\n      this[_name] = options.name;\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiNameMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiNameMixinJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n\n      options.name = jsonObject.name;\n    }\n\n    public get name(): string {\n      return this[_name];\n    }\n\n    /** @override */\n    public get displayName(): string {\n      return this[_name];\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiNameMixinJson>): void {\n      super.serializeInto(jsonObject);\n\n      jsonObject.name = this.name;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiNameMixin:interface)}.\n * @public\n */\nexport namespace ApiNameMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiNameMixin` 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 ApiNameMixin {\n    return apiItem.hasOwnProperty(_name);\n  }\n}\n"]}

package/lib-esm/mixins/ApiOptionalMixin.js

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const _isOptional = Symbol('ApiOptionalMixin._isOptional');
+/**
+ * Mixin function for {@link (ApiOptionalMixin:interface)}.
+ *
+ * @param baseClass - The base class to be extended
+ * @returns A child class that extends baseClass, adding the {@link (ApiOptionalMixin:interface)} functionality.
+ *
+ * @public
+ */
+export function ApiOptionalMixin(baseClass
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    class MixedClass extends baseClass {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(...args) {
+            super(...args);
+            const options = args[0];
+            this[_isOptional] = !!options.isOptional;
+        }
+        /** @override */
+        static onDeserializeInto(options, context, jsonObject) {
+            baseClass.onDeserializeInto(options, context, jsonObject);
+            options.isOptional = !!jsonObject.isOptional;
+        }
+        get isOptional() {
+            return this[_isOptional];
+        }
+        /** @override */
+        serializeInto(jsonObject) {
+            super.serializeInto(jsonObject);
+            jsonObject.isOptional = this.isOptional;
+        }
+    }
+    return MixedClass;
+}
+/**
+ * Optional members for {@link (ApiOptionalMixin:interface)}.
+ * @public
+ */
+(function (ApiOptionalMixin) {
+    /**
+     * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiOptionalMixin` mixin.
+     *
+     * @remarks
+     *
+     * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of
+     * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however
+     * the TypeScript type system cannot invoke a runtime test.)
+     */
+    function isBaseClassOf(apiItem) {
+        return apiItem.hasOwnProperty(_isOptional);
+    }
+    ApiOptionalMixin.isBaseClassOf = isBaseClassOf;
+})(ApiOptionalMixin || (ApiOptionalMixin = {}));
+//# sourceMappingURL=ApiOptionalMixin.js.map

package/lib-esm/mixins/ApiOptionalMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiOptionalMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiOptionalMixin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAmB3D,MAAM,WAAW,GAAkB,MAAM,CAAC,8BAA8B,CAAC,CAAC;AAqC1E;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAGhC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAA6B,IAAI,CAAC,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3C,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA0C,EAC1C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;QAC/C,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1C,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,WAAiB,gBAAgB;IAC/B;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,8BAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,gBAAgB,KAAhB,gBAAgB,QAahC","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/* eslint-disable @typescript-eslint/no-redeclare */\n\nimport type { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\nimport type { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Constructor options for {@link (IApiOptionalMixinOptions:interface)}.\n * @public\n */\nexport interface IApiOptionalMixinOptions extends IApiItemOptions {\n  isOptional: boolean;\n}\n\nexport interface IApiOptionalMixinJson extends IApiItemJson {\n  isOptional: boolean;\n}\n\nconst _isOptional: unique symbol = Symbol('ApiOptionalMixin._isOptional');\n\n/**\n * The mixin base class for API items that can be marked as optional by appending a `?` to them.\n * For example, a property of an interface can be optional.\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 * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiOptionalMixin extends ApiItem {\n  /**\n   * True if this is an optional property.\n   * @remarks\n   * For example:\n   * ```ts\n   * interface X {\n   *   y: string;   // not optional\n   *   z?: string;  // optional\n   * }\n   * ```\n   */\n  readonly isOptional: boolean;\n\n  /** @override */\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link (ApiOptionalMixin:interface)}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiOptionalMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiOptionalMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiOptionalMixin) {\n  class MixedClass extends baseClass implements ApiOptionalMixin {\n    public [_isOptional]: boolean;\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n\n      const options: IApiOptionalMixinOptions = args[0];\n      this[_isOptional] = !!options.isOptional;\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiOptionalMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiOptionalMixinJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n\n      options.isOptional = !!jsonObject.isOptional;\n    }\n\n    public get isOptional(): boolean {\n      return this[_isOptional];\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiOptionalMixinJson>): void {\n      super.serializeInto(jsonObject);\n\n      jsonObject.isOptional = this.isOptional;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Optional members for {@link (ApiOptionalMixin:interface)}.\n * @public\n */\nexport namespace ApiOptionalMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiOptionalMixin` 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 ApiOptionalMixin {\n    return apiItem.hasOwnProperty(_isOptional);\n  }\n}\n"]}

package/lib-esm/mixins/ApiParameterListMixin.js

@@ -0,0 +1,93 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/* eslint-disable @typescript-eslint/no-redeclare */
+import { InternalError } from '@rushstack/node-core-library';
+import { Parameter } from '../model/Parameter';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+const _overloadIndex = Symbol('ApiParameterListMixin._overloadIndex');
+const _parameters = Symbol('ApiParameterListMixin._parameters');
+/**
+ * Mixin function for {@link (ApiParameterListMixin:interface)}.
+ *
+ * @param baseClass - The base class to be extended
+ * @returns A child class that extends baseClass, adding the {@link (ApiParameterListMixin:interface)} functionality.
+ *
+ * @public
+ */
+export function ApiParameterListMixin(baseClass
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    class MixedClass extends baseClass {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(...args) {
+            super(...args);
+            const options = args[0];
+            this[_overloadIndex] = options.overloadIndex;
+            this[_parameters] = [];
+            if (this instanceof ApiDeclaredItem) {
+                if (options.parameters) {
+                    for (const parameterOptions of options.parameters) {
+                        const parameter = new Parameter({
+                            name: parameterOptions.parameterName,
+                            parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),
+                            // Prior to ApiJsonSchemaVersion.V_1005 this input will be undefined
+                            isOptional: !!parameterOptions.isOptional,
+                            parent: this
+                        });
+                        this[_parameters].push(parameter);
+                    }
+                }
+            }
+            else {
+                throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');
+            }
+        }
+        /** @override */
+        static onDeserializeInto(options, context, jsonObject) {
+            baseClass.onDeserializeInto(options, context, jsonObject);
+            options.overloadIndex = jsonObject.overloadIndex;
+            options.parameters = jsonObject.parameters || [];
+        }
+        get overloadIndex() {
+            return this[_overloadIndex];
+        }
+        get parameters() {
+            return this[_parameters];
+        }
+        /** @override */
+        serializeInto(jsonObject) {
+            super.serializeInto(jsonObject);
+            jsonObject.overloadIndex = this.overloadIndex;
+            const parameterObjects = [];
+            for (const parameter of this.parameters) {
+                parameterObjects.push({
+                    parameterName: parameter.name,
+                    parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange,
+                    isOptional: parameter.isOptional
+                });
+            }
+            jsonObject.parameters = parameterObjects;
+        }
+    }
+    return MixedClass;
+}
+/**
+ * Static members for {@link (ApiParameterListMixin:interface)}.
+ * @public
+ */
+(function (ApiParameterListMixin) {
+    /**
+     * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin.
+     *
+     * @remarks
+     *
+     * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of
+     * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however
+     * the TypeScript type system cannot invoke a runtime test.)
+     */
+    function isBaseClassOf(apiItem) {
+        return apiItem.hasOwnProperty(_parameters);
+    }
+    ApiParameterListMixin.isBaseClassOf = isBaseClassOf;
+})(ApiParameterListMixin || (ApiParameterListMixin = {}));
+//# sourceMappingURL=ApiParameterListMixin.js.map

package/lib-esm/mixins/ApiParameterListMixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,oDAAoD;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAG7D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AA4B3D,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,WAAW,GAAkB,MAAM,CAAC,mCAAmC,CAAC,CAAC;AAwD/E;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAIhC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;YAE7C,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,IAAI,YAAY,eAAe,EAAE,CAAC;gBACpC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;oBACvB,KAAK,MAAM,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;wBAClD,MAAM,SAAS,GAAc,IAAI,SAAS,CAAC;4BACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa;4BACpC,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;4BACjF,oEAAoE;4BACpE,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,UAAU;4BACzC,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBAEH,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACpC,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,aAAa,CAAC,4EAA4E,CAAC,CAAC;YACxG,CAAC;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;YAE1D,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,IAAW,aAAa;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YAE9C,MAAM,gBAAgB,GAA2B,EAAE,CAAC;YACpD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxC,gBAAgB,CAAC,IAAI,CAAC;oBACpB,aAAa,EAAE,SAAS,CAAC,IAAI;oBAC7B,uBAAuB,EAAE,SAAS,CAAC,oBAAoB,CAAC,UAAU;oBAClE,UAAU,EAAE,SAAS,CAAC,UAAU;iBACjC,CAAC,CAAC;YACL,CAAC;YAED,UAAU,CAAC,UAAU,GAAG,gBAAgB,CAAC;QAC3C,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,KAArB,qBAAqB,QAarC","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/* eslint-disable @typescript-eslint/no-redeclare */\n\nimport { InternalError } from '@rushstack/node-core-library';\n\nimport type { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\nimport { Parameter } from '../model/Parameter';\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport type { IExcerptTokenRange } from './Excerpt';\nimport type { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Represents parameter information that is part of {@link IApiParameterListMixinOptions}\n * @public\n */\nexport interface IApiParameterOptions {\n  parameterName: string;\n  parameterTypeTokenRange: IExcerptTokenRange;\n  isOptional: boolean;\n}\n\n/**\n * Constructor options for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport interface IApiParameterListMixinOptions extends IApiItemOptions {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nexport interface IApiParameterListJson extends IApiItemJson {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nconst _overloadIndex: unique symbol = Symbol('ApiParameterListMixin._overloadIndex');\nconst _parameters: unique symbol = Symbol('ApiParameterListMixin._parameters');\n\n/**\n * The mixin base class for API items that can have function parameters (but not necessarily a return value).\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 * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiParameterListMixin extends ApiItem {\n  /**\n   * When a function has multiple overloaded declarations, this one-based integer index can be used to uniquely\n   * identify them.\n   *\n   * @remarks\n   *\n   * Consider this overloaded declaration:\n   *\n   * ```ts\n   * export namespace Versioning {\n   *   // TSDoc: Versioning.(addVersions:1)\n   *   export function addVersions(x: number, y: number): number;\n   *\n   *   // TSDoc: Versioning.(addVersions:2)\n   *   export function addVersions(x: string, y: string): string;\n   *\n   *   // (implementation)\n   *   export function addVersions(x: number|string, y: number|string): number|string {\n   *     // . . .\n   *   }\n   * }\n   * ```\n   *\n   * In the above example, there are two overloaded declarations.  The overload using numbers will have\n   * `overloadIndex = 1`.  The overload using strings will have `overloadIndex = 2`.  The third declaration that\n   * accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor.\n   */\n  readonly overloadIndex: number;\n\n  /**\n   * The function parameters.\n   */\n  readonly parameters: ReadonlyArray<Parameter>;\n\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link (ApiParameterListMixin:interface)}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiParameterListMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiParameterListMixin) {\n  class MixedClass extends baseClass implements ApiParameterListMixin {\n    public readonly [_overloadIndex]: number;\n    public readonly [_parameters]: Parameter[];\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n\n      const options: IApiParameterListMixinOptions = args[0];\n      this[_overloadIndex] = options.overloadIndex;\n\n      this[_parameters] = [];\n\n      if (this instanceof ApiDeclaredItem) {\n        if (options.parameters) {\n          for (const parameterOptions of options.parameters) {\n            const parameter: Parameter = new Parameter({\n              name: parameterOptions.parameterName,\n              parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),\n              // Prior to ApiJsonSchemaVersion.V_1005 this input will be undefined\n              isOptional: !!parameterOptions.isOptional,\n              parent: this\n            });\n\n            this[_parameters].push(parameter);\n          }\n        }\n      } else {\n        throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');\n      }\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiParameterListMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiParameterListJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n\n      options.overloadIndex = jsonObject.overloadIndex;\n      options.parameters = jsonObject.parameters || [];\n    }\n\n    public get overloadIndex(): number {\n      return this[_overloadIndex];\n    }\n\n    public get parameters(): ReadonlyArray<Parameter> {\n      return this[_parameters];\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiParameterListJson>): void {\n      super.serializeInto(jsonObject);\n\n      jsonObject.overloadIndex = this.overloadIndex;\n\n      const parameterObjects: IApiParameterOptions[] = [];\n      for (const parameter of this.parameters) {\n        parameterObjects.push({\n          parameterName: parameter.name,\n          parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange,\n          isOptional: parameter.isOptional\n        });\n      }\n\n      jsonObject.parameters = parameterObjects;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport namespace ApiParameterListMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` 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 ApiParameterListMixin {\n    return apiItem.hasOwnProperty(_parameters);\n  }\n}\n"]}