@microsoft/api-extractor-model 7.32.2 → 7.33.1

package/lib-esm/model/ApiFunction.js

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript function declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiFunction` represents a TypeScript declaration such as this example:
+ *
+ * ```ts
+ * export function getAverage(x: number, y: number): number {
+ *   return (x + y) / 2.0;
+ * }
+ * ```
+ *
+ * Functions are exported by an entry point module or by a namespace.  Compare with {@link ApiMethod}, which
+ * represents a function that is a member of a class.
+ *
+ * @public
+ */
+export class ApiFunction extends ApiNameMixin(ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiExportedMixin(ApiDeclaredItem)))))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name, overloadIndex) {
+        return `${name}|${ApiItemKind.Function}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Function;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiFunction.getContainerKey(this.name, this.overloadIndex);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        const navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(navigation, nameComponent)
+            .withMeaning(Meaning.Function)
+            .withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiFunction.js.map

package/lib-esm/model/ApiFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiFunction.js","sourceRoot":"","sources":["../../src/model/ApiFunction.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAgC,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAsC,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAEL,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAiC,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAe7F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY,CAC3C,yBAAyB,CACvB,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACjG,CACF;IACC,YAAmB,OAA4B;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,QAAQ,IAAI,aAAa,EAAE,CAAC;IAC5D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACpE,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC;aAC5C,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC;aAC7B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { type IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\nimport { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport {\n  type IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from '../mixins/ApiTypeParameterListMixin';\nimport { type IApiExportedMixinOptions, ApiExportedMixin } from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiFunction}.\n * @public\n */\nexport interface IApiFunctionOptions\n  extends IApiNameMixinOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiExportedMixinOptions {}\n\n/**\n * Represents a TypeScript function declaration.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiFunction` represents a TypeScript declaration such as this example:\n *\n * ```ts\n * export function getAverage(x: number, y: number): number {\n *   return (x + y) / 2.0;\n * }\n * ```\n *\n * Functions are exported by an entry point module or by a namespace.  Compare with {@link ApiMethod}, which\n * represents a function that is a member of a class.\n *\n * @public\n */\nexport class ApiFunction extends ApiNameMixin(\n  ApiTypeParameterListMixin(\n    ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiExportedMixin(ApiDeclaredItem))))\n  )\n) {\n  public constructor(options: IApiFunctionOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string, overloadIndex: number): string {\n    return `${name}|${ApiItemKind.Function}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Function;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiFunction.getContainerKey(this.name, this.overloadIndex);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(navigation, nameComponent)\n      .withMeaning(Meaning.Function)\n      .withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiIndexSignature.js

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
+import { ApiReadonlyMixin } from '../mixins/ApiReadonlyMixin';
+/**
+ * Represents a TypeScript index signature.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example:
+ *
+ * ```ts
+ * export interface INumberTable {
+ *   // An index signature
+ *   [value: number]: number;
+ *
+ *   // An overloaded index signature
+ *   [name: string]: number;
+ * }
+ * ```
+ *
+ * @public
+ */
+export class ApiIndexSignature extends ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiReadonlyMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(overloadIndex) {
+        return `|${ApiItemKind.IndexSignature}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.IndexSignature;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiIndexSignature.getContainerKey(this.overloadIndex);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const parent = this.parent
+            ? this.parent.canonicalReference
+            : // .withMeaning() requires some kind of component
+                DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');
+        return parent.withMeaning(Meaning.IndexSignature).withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiIndexSignature.js.map

package/lib-esm/model/ApiIndexSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiIndexSignature.js","sourceRoot":"","sources":["../../src/model/ApiIndexSignature.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EACX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAgC,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAsC,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAiC,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAa7F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,qBAAqB,CAC1D,kBAAkB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAC1E;IACC,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,WAAW,CAAC,cAAc,IAAI,aAAa,EAAE,CAAC;IAC3D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,cAAc,CAAC;IACpC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,MAAM,GAAyB,IAAI,CAAC,MAAM;YAC9C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB;YAChC,CAAC,CAAC,iDAAiD;gBACjD,oBAAoB,CAAC,KAAK,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1F,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { type IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\nimport { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\nimport { type IApiReadonlyMixinOptions, ApiReadonlyMixin } from '../mixins/ApiReadonlyMixin';\n\n/**\n * Constructor options for {@link ApiIndexSignature}.\n * @public\n */\nexport interface IApiIndexSignatureOptions\n  extends IApiParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiReadonlyMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript index signature.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example:\n *\n * ```ts\n * export interface INumberTable {\n *   // An index signature\n *   [value: number]: number;\n *\n *   // An overloaded index signature\n *   [name: string]: number;\n * }\n * ```\n *\n * @public\n */\nexport class ApiIndexSignature extends ApiParameterListMixin(\n  ApiReleaseTagMixin(ApiReturnTypeMixin(ApiReadonlyMixin(ApiDeclaredItem)))\n) {\n  public constructor(options: IApiIndexSignatureOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(overloadIndex: number): string {\n    return `|${ApiItemKind.IndexSignature}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.IndexSignature;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiIndexSignature.getContainerKey(this.overloadIndex);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const parent: DeclarationReference = this.parent\n      ? this.parent.canonicalReference\n      : // .withMeaning() requires some kind of component\n        DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');\n    return parent.withMeaning(Meaning.IndexSignature).withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiInterface.js

@@ -0,0 +1,73 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { HeritageType } from './HeritageType';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript class declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiInterface` represents a TypeScript declaration such as this:
+ *
+ * ```ts
+ * export interface X extends Y {
+ * }
+ * ```
+ *
+ * @public
+ */
+export class ApiInterface extends ApiItemContainerMixin(ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))))) {
+    constructor(options) {
+        super(options);
+        this._extendsTypes = [];
+        for (const extendsTokenRange of options.extendsTokenRanges) {
+            this._extendsTypes.push(new HeritageType(this.buildExcerpt(extendsTokenRange)));
+        }
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.Interface}`;
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.extendsTokenRanges = jsonObject.extendsTokenRanges;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Interface;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiInterface.getContainerKey(this.name);
+    }
+    /**
+     * The list of base interfaces that this interface inherits from using the `extends` keyword.
+     */
+    get extendsTypes() {
+        return this._extendsTypes;
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        jsonObject.extendsTokenRanges = this.extendsTypes.map((x) => x.excerpt.tokenRange);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        const navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(navigation, nameComponent)
+            .withMeaning(Meaning.Interface);
+    }
+}
+//# sourceMappingURL=ApiInterface.js.map

package/lib-esm/model/ApiInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiInterface.js","sourceRoot":"","sources":["../../src/model/ApiInterface.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,qBAAqB,EAGtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,eAAe,EAGhB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEL,kBAAkB,EAEnB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAA6B,YAAY,EAA0B,MAAM,wBAAwB,CAAC;AACzG,OAAO,EAGL,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAGL,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AA0BpC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAAqB,CACrD,YAAY,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAC/F;IAGC,YAAmB,OAA6B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHA,kBAAa,GAAmB,EAAE,CAAC;QAKlD,KAAK,MAAM,iBAAiB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC3D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;QAE7B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAC7D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAsC;QACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrF,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC;aAC5C,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport {\n  ApiItemContainerMixin,\n  type IApiItemContainerMixinOptions,\n  type IApiItemContainerJson\n} from '../mixins/ApiItemContainerMixin';\nimport {\n  ApiDeclaredItem,\n  type IApiDeclaredItemOptions,\n  type IApiDeclaredItemJson\n} from '../items/ApiDeclaredItem';\nimport {\n  type IApiReleaseTagMixinOptions,\n  ApiReleaseTagMixin,\n  type IApiReleaseTagMixinJson\n} from '../mixins/ApiReleaseTagMixin';\nimport type { IExcerptTokenRange } from '../mixins/Excerpt';\nimport { HeritageType } from './HeritageType';\nimport { type IApiNameMixinOptions, ApiNameMixin, type IApiNameMixinJson } from '../mixins/ApiNameMixin';\nimport {\n  type IApiTypeParameterListMixinOptions,\n  type IApiTypeParameterListMixinJson,\n  ApiTypeParameterListMixin\n} from '../mixins/ApiTypeParameterListMixin';\nimport type { DeserializerContext } from './DeserializerContext';\nimport {\n  type IApiExportedMixinJson,\n  type IApiExportedMixinOptions,\n  ApiExportedMixin\n} from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiInterface}.\n * @public\n */\nexport interface IApiInterfaceOptions\n  extends IApiItemContainerMixinOptions,\n    IApiNameMixinOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiExportedMixinOptions {\n  extendsTokenRanges: IExcerptTokenRange[];\n}\n\nexport interface IApiInterfaceJson\n  extends IApiItemContainerJson,\n    IApiNameMixinJson,\n    IApiTypeParameterListMixinJson,\n    IApiReleaseTagMixinJson,\n    IApiDeclaredItemJson,\n    IApiExportedMixinJson {\n  extendsTokenRanges: IExcerptTokenRange[];\n}\n\n/**\n * Represents a TypeScript class declaration.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiInterface` represents a TypeScript declaration such as this:\n *\n * ```ts\n * export interface X extends Y {\n * }\n * ```\n *\n * @public\n */\nexport class ApiInterface extends ApiItemContainerMixin(\n  ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))))\n) {\n  private readonly _extendsTypes: HeritageType[] = [];\n\n  public constructor(options: IApiInterfaceOptions) {\n    super(options);\n\n    for (const extendsTokenRange of options.extendsTokenRanges) {\n      this._extendsTypes.push(new HeritageType(this.buildExcerpt(extendsTokenRange)));\n    }\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.Interface}`;\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiInterfaceOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiInterfaceJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.extendsTokenRanges = jsonObject.extendsTokenRanges;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Interface;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiInterface.getContainerKey(this.name);\n  }\n\n  /**\n   * The list of base interfaces that this interface inherits from using the `extends` keyword.\n   */\n  public get extendsTypes(): ReadonlyArray<HeritageType> {\n    return this._extendsTypes;\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiInterfaceJson>): void {\n    super.serializeInto(jsonObject);\n\n    jsonObject.extendsTokenRanges = this.extendsTypes.map((x) => x.excerpt.tokenRange);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(navigation, nameComponent)\n      .withMeaning(Meaning.Interface);\n  }\n}\n"]}

package/lib-esm/model/ApiMethod.js

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiProtectedMixin } from '../mixins/ApiProtectedMixin';
+import { ApiStaticMixin } from '../mixins/ApiStaticMixin';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiAbstractMixin } from '../mixins/ApiAbstractMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiOptionalMixin } from '../mixins/ApiOptionalMixin';
+/**
+ * Represents a TypeScript member function declaration that belongs to an `ApiClass`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiMethod` represents a TypeScript declaration such as the `render` member function in this example:
+ *
+ * ```ts
+ * export class Widget {
+ *   public render(): void { }
+ * }
+ * ```
+ *
+ * Compare with {@link ApiMethodSignature}, which represents a method belonging to an interface.
+ * For example, a class method can be `static` but an interface method cannot.
+ *
+ * @public
+ */
+export class ApiMethod extends ApiNameMixin(ApiAbstractMixin(ApiOptionalMixin(ApiParameterListMixin(ApiProtectedMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiTypeParameterListMixin(ApiDeclaredItem))))))))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name, isStatic, overloadIndex) {
+        if (isStatic) {
+            return `${name}|${ApiItemKind.Method}|static|${overloadIndex}`;
+        }
+        else {
+            return `${name}|${ApiItemKind.Method}|instance|${overloadIndex}`;
+        }
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Method;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiMethod.getContainerKey(this.name, this.isStatic, this.overloadIndex);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)
+            .withMeaning(Meaning.Member)
+            .withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiMethod.js.map

package/lib-esm/model/ApiMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiMethod.js","sourceRoot":"","sources":["../../src/model/ApiMethod.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAkC,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAAE,cAAc,EAA+B,MAAM,0BAA0B,CAAC;AACvF,OAAO,EAAgC,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAsC,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAiC,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EACL,yBAAyB,EAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAiC,MAAM,4BAA4B,CAAC;AAkB7F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY,CACzC,gBAAgB,CACd,gBAAgB,CACd,qBAAqB,CACnB,iBAAiB,CACf,kBAAkB,CAAC,kBAAkB,CAAC,cAAc,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACnG,CACF,CACF,CACF,CACF;IACC,YAAmB,OAA0B;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,QAAiB,EAAE,aAAqB;QAClF,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,MAAM,WAAW,aAAa,EAAE,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,MAAM,aAAa,aAAa,EAAE,CAAC;QACnE,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACjF,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC;aACzF,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { ApiProtectedMixin, type IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin';\nimport { ApiStaticMixin, type IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';\nimport { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { type IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\nimport { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\nimport { ApiReturnTypeMixin, type IApiReturnTypeMixinOptions } from '../mixins/ApiReturnTypeMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { type IApiAbstractMixinOptions, ApiAbstractMixin } from '../mixins/ApiAbstractMixin';\nimport {\n  ApiTypeParameterListMixin,\n  type IApiTypeParameterListMixinOptions\n} from '../mixins/ApiTypeParameterListMixin';\nimport { ApiOptionalMixin, type IApiOptionalMixinOptions } from '../mixins/ApiOptionalMixin';\n\n/**\n * Constructor options for {@link ApiMethod}.\n * @public\n */\nexport interface IApiMethodOptions\n  extends IApiNameMixinOptions,\n    IApiAbstractMixinOptions,\n    IApiOptionalMixinOptions,\n    IApiParameterListMixinOptions,\n    IApiProtectedMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiStaticMixinOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript member function declaration that belongs to an `ApiClass`.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiMethod` represents a TypeScript declaration such as the `render` member function in this example:\n *\n * ```ts\n * export class Widget {\n *   public render(): void { }\n * }\n * ```\n *\n * Compare with {@link ApiMethodSignature}, which represents a method belonging to an interface.\n * For example, a class method can be `static` but an interface method cannot.\n *\n * @public\n */\nexport class ApiMethod extends ApiNameMixin(\n  ApiAbstractMixin(\n    ApiOptionalMixin(\n      ApiParameterListMixin(\n        ApiProtectedMixin(\n          ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiTypeParameterListMixin(ApiDeclaredItem))))\n        )\n      )\n    )\n  )\n) {\n  public constructor(options: IApiMethodOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string {\n    if (isStatic) {\n      return `${name}|${ApiItemKind.Method}|static|${overloadIndex}`;\n    } else {\n      return `${name}|${ApiItemKind.Method}|instance|${overloadIndex}`;\n    }\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Method;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiMethod.getContainerKey(this.name, this.isStatic, this.overloadIndex);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)\n      .withMeaning(Meaning.Member)\n      .withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiMethodSignature.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.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiOptionalMixin } from '../mixins/ApiOptionalMixin';
+/**
+ * Represents a TypeScript member function declaration that belongs to an `ApiInterface`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example:
+ *
+ * ```ts
+ * export interface IWidget {
+ *   render(): void;
+ * }
+ * ```
+ *
+ * Compare with {@link ApiMethod}, which represents a method belonging to a class.
+ * For example, a class method can be `static` but an interface method cannot.
+ *
+ * @public
+ */
+export class ApiMethodSignature extends ApiNameMixin(ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiOptionalMixin(ApiDeclaredItem)))))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name, overloadIndex) {
+        return `${name}|${ApiItemKind.MethodSignature}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.MethodSignature;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(Navigation.Members, nameComponent)
+            .withMeaning(Meaning.Member)
+            .withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiMethodSignature.js.map

package/lib-esm/model/ApiMethodSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiMethodSignature.js","sourceRoot":"","sources":["../../src/model/ApiMethodSignature.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAgC,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAEL,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAiC,MAAM,4BAA4B,CAAC;AAY7F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAAY,CAClD,yBAAyB,CACvB,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACjG,CACF;IACC,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,eAAe,IAAI,aAAa,EAAE,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC;aACpD,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { ApiDeclaredItem, type IApiDeclaredItemOptions } from '../items/ApiDeclaredItem';\nimport { ApiParameterListMixin, type IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin';\nimport { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport {\n  type IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from '../mixins/ApiTypeParameterListMixin';\nimport { ApiOptionalMixin, type IApiOptionalMixinOptions } from '../mixins/ApiOptionalMixin';\n\n/** @public */\nexport interface IApiMethodSignatureOptions\n  extends IApiNameMixinOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiOptionalMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript member function declaration that belongs to an `ApiInterface`.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example:\n *\n * ```ts\n * export interface IWidget {\n *   render(): void;\n * }\n * ```\n *\n * Compare with {@link ApiMethod}, which represents a method belonging to a class.\n * For example, a class method can be `static` but an interface method cannot.\n *\n * @public\n */\nexport class ApiMethodSignature extends ApiNameMixin(\n  ApiTypeParameterListMixin(\n    ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiOptionalMixin(ApiDeclaredItem))))\n  )\n) {\n  public constructor(options: IApiMethodSignatureOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string, overloadIndex: number): string {\n    return `${name}|${ApiItemKind.MethodSignature}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.MethodSignature;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(Navigation.Members, nameComponent)\n      .withMeaning(Meaning.Member)\n      .withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiModel.js

@@ -0,0 +1,170 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { PackageName } from '@rushstack/node-core-library';
+import { DocDeclarationReference } from '@microsoft/tsdoc';
+import { ApiItem, ApiItemKind } from '../items/ApiItem';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiPackage } from './ApiPackage';
+import { ModelReferenceResolver } from './ModelReferenceResolver';
+/**
+ * A serializable representation of a collection of API declarations.
+ *
+ * @remarks
+ *
+ * An `ApiModel` represents a collection of API declarations that can be serialized to disk.  It captures all the
+ * important information needed to generate documentation, without any reliance on the TypeScript compiler engine.
+ *
+ * An `ApiModel` acts as the root of a tree of objects that all inherit from the `ApiItem` base class.
+ * The tree children are determined by the {@link (ApiItemContainerMixin:interface)} mixin base class.  The model
+ * contains packages.  Packages have an entry point (today, only one).  And the entry point can contain various types
+ * of API declarations.  The container relationships might look like this:
+ *
+ * ```
+ * Things that can contain other things:
+ *
+ * - ApiModel
+ *   - ApiPackage
+ *     - ApiEntryPoint
+ *       - ApiClass
+ *         - ApiMethod
+ *         - ApiProperty
+ *       - ApiEnum
+ *         - ApiEnumMember
+ *       - ApiInterface
+ *         - ApiMethodSignature
+ *         - ApiPropertySignature
+ *       - ApiNamespace
+ *         - (ApiClass, ApiEnum, ApiInterace, ...)
+ *
+ * ```
+ *
+ * Normally, API Extractor writes an .api.json file to disk for each project that it builds.  Then, a tool like
+ * API Documenter can load the various `ApiPackage` objects into a single `ApiModel` and process them as a group.
+ * This is useful because compilation generally occurs separately (e.g. because projects may reside in different
+ * Git repos, or because they build with different TypeScript compiler configurations that may be incompatible),
+ * whereas API Documenter cannot detect broken hyperlinks without seeing the entire documentation set.
+ *
+ * @public
+ */
+export class ApiModel extends ApiItemContainerMixin(ApiItem) {
+    constructor() {
+        super({});
+        this._packagesByName = undefined;
+        this._apiItemsByCanonicalReference = undefined;
+        this._resolver = new ModelReferenceResolver(this);
+    }
+    loadPackage(apiJsonFilename) {
+        const apiPackage = ApiPackage.loadFromJsonFile(apiJsonFilename);
+        this.addMember(apiPackage);
+        return apiPackage;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Model;
+    }
+    /** @override */
+    get containerKey() {
+        return '';
+    }
+    get packages() {
+        return this.members;
+    }
+    /** @override */
+    addMember(member) {
+        if (member.kind !== ApiItemKind.Package) {
+            throw new Error('Only items of type ApiPackage may be added to an ApiModel');
+        }
+        super.addMember(member);
+        this._packagesByName = undefined; // invalidate the cache
+        this._apiItemsByCanonicalReference = undefined; // invalidate the cache
+    }
+    /**
+     * Efficiently finds a package by the NPM package name.
+     *
+     * @remarks
+     *
+     * If the NPM scope is omitted in the package name, it will still be found provided that it is an unambiguous match.
+     * For example, it's often convenient to write `{@link node-core-library#JsonFile}` instead of
+     * `{@link @rushstack/node-core-library#JsonFile}`.
+     */
+    tryGetPackageByName(packageName) {
+        // Build the lookup on demand
+        if (this._packagesByName === undefined) {
+            this._packagesByName = new Map();
+            const unscopedMap = new Map();
+            for (const apiPackage of this.packages) {
+                if (this._packagesByName.get(apiPackage.name)) {
+                    // This should not happen
+                    throw new Error(`The model contains multiple packages with the name ${apiPackage.name}`);
+                }
+                this._packagesByName.set(apiPackage.name, apiPackage);
+                const unscopedName = PackageName.parse(apiPackage.name).unscopedName;
+                if (unscopedMap.has(unscopedName)) {
+                    // If another package has the same unscoped name, then we won't register it
+                    unscopedMap.set(unscopedName, undefined);
+                }
+                else {
+                    unscopedMap.set(unscopedName, apiPackage);
+                }
+            }
+            for (const [unscopedName, apiPackage] of unscopedMap) {
+                if (apiPackage) {
+                    if (!this._packagesByName.has(unscopedName)) {
+                        // If the unscoped name is unambiguous, then we can also use it as a lookup
+                        this._packagesByName.set(unscopedName, apiPackage);
+                    }
+                }
+            }
+        }
+        return this._packagesByName.get(packageName);
+    }
+    resolveDeclarationReference(declarationReference, contextApiItem) {
+        if (declarationReference instanceof DocDeclarationReference) {
+            return this._resolver.resolve(declarationReference, contextApiItem);
+        }
+        else if (declarationReference instanceof DeclarationReference) {
+            // use this._apiItemsByCanonicalReference to look up ApiItem
+            // Build the lookup on demand
+            if (!this._apiItemsByCanonicalReference) {
+                this._apiItemsByCanonicalReference = new Map();
+                for (const apiPackage of this.packages) {
+                    this._initApiItemsRecursive(apiPackage, this._apiItemsByCanonicalReference);
+                }
+            }
+            const result = {
+                resolvedApiItem: undefined,
+                errorMessage: undefined
+            };
+            const apiItem = this._apiItemsByCanonicalReference.get(declarationReference.toString());
+            if (!apiItem) {
+                result.errorMessage = `${declarationReference.toString()} can not be located`;
+            }
+            else {
+                result.resolvedApiItem = apiItem;
+            }
+            return result;
+        }
+        else {
+            // NOTE: The "instanceof DeclarationReference" test assumes a specific version of the @microsoft/tsdoc package.
+            throw new Error('The "declarationReference" parameter must be an instance of' +
+                ' DocDeclarationReference or DeclarationReference');
+        }
+    }
+    _initApiItemsRecursive(apiItem, apiItemsByCanonicalReference) {
+        if (apiItem.canonicalReference && !apiItem.canonicalReference.isEmpty) {
+            apiItemsByCanonicalReference.set(apiItem.canonicalReference.toString(), apiItem);
+        }
+        // Recurse container members
+        if (ApiItemContainerMixin.isBaseClassOf(apiItem)) {
+            for (const apiMember of apiItem.members) {
+                this._initApiItemsRecursive(apiMember, apiItemsByCanonicalReference);
+            }
+        }
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        return DeclarationReference.empty();
+    }
+}
+//# sourceMappingURL=ApiModel.js.map

package/lib-esm/model/ApiModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiModel.js","sourceRoot":"","sources":["../../src/model/ApiModel.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAA2C,MAAM,0BAA0B,CAAC;AAE3G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,OAAO,QAAS,SAAQ,qBAAqB,CAAC,OAAO,CAAC;IAK1D;QACE,KAAK,CAAC,EAAE,CAAC,CAAC;QAHJ,oBAAe,GAAwC,SAAS,CAAC;QACjE,kCAA6B,GAAqC,SAAS,CAAC;QAIlF,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,eAAuB;QACxC,MAAM,UAAU,GAAe,UAAU,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAoC,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAkB;QACjC,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,uBAAuB;QACzD,IAAI,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC,uBAAuB;IACzE,CAAC;IAED;;;;;;;;OAQG;IACI,mBAAmB,CAAC,WAAmB;QAC5C,6BAA6B;QAC7B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAsB,CAAC;YAErD,MAAM,WAAW,GAAwC,IAAI,GAAG,EAAkC,CAAC;YAEnG,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9C,yBAAyB;oBACzB,MAAM,IAAI,KAAK,CAAC,sDAAsD,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3F,CAAC;gBAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBAEtD,MAAM,YAAY,GAAW,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC;gBAE7E,IAAI,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;oBAClC,2EAA2E;oBAC3E,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;gBAC5C,CAAC;YACH,CAAC;YAED,KAAK,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,WAAW,EAAE,CAAC;gBACrD,IAAI,UAAU,EAAE,CAAC;oBACf,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;wBAC5C,2EAA2E;wBAC3E,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;oBACrD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAEM,2BAA2B,CAChC,oBAAoE,EACpE,cAAmC;QAEnC,IAAI,oBAAoB,YAAY,uBAAuB,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,oBAAoB,YAAY,oBAAoB,EAAE,CAAC;YAChE,4DAA4D;YAE5D,6BAA6B;YAC7B,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACxC,IAAI,CAAC,6BAA6B,GAAG,IAAI,GAAG,EAAmB,CAAC;gBAEhE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;YAED,MAAM,MAAM,GAAuC;gBACjD,eAAe,EAAE,SAAS;gBAC1B,YAAY,EAAE,SAAS;aACxB,CAAC;YAEF,MAAM,OAAO,GAAwB,IAAI,CAAC,6BAA6B,CAAC,GAAG,CACzE,oBAAoB,CAAC,QAAQ,EAAE,CAChC,CAAC;YAEF,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,CAAC,YAAY,GAAG,GAAG,oBAAoB,CAAC,QAAQ,EAAE,qBAAqB,CAAC;YAChF,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC;YACnC,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,+GAA+G;YAC/G,MAAM,IAAI,KAAK,CACb,6DAA6D;gBAC3D,kDAAkD,CACrD,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,OAAgB,EAAE,4BAAkD;QACjG,IAAI,OAAO,CAAC,kBAAkB,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;YACtE,4BAA4B,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QACnF,CAAC;QAED,4BAA4B;QAC5B,IAAI,qBAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACxC,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,OAAO,oBAAoB,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;CACF","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 { PackageName } from '@rushstack/node-core-library';\nimport { DocDeclarationReference } from '@microsoft/tsdoc';\n\nimport { ApiItem, ApiItemKind } from '../items/ApiItem';\nimport { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';\nimport { ApiPackage } from './ApiPackage';\nimport { ModelReferenceResolver, type IResolveDeclarationReferenceResult } from './ModelReferenceResolver';\n\n/**\n * A serializable representation of a collection of API declarations.\n *\n * @remarks\n *\n * An `ApiModel` represents a collection of API declarations that can be serialized to disk.  It captures all the\n * important information needed to generate documentation, without any reliance on the TypeScript compiler engine.\n *\n * An `ApiModel` acts as the root of a tree of objects that all inherit from the `ApiItem` base class.\n * The tree children are determined by the {@link (ApiItemContainerMixin:interface)} mixin base class.  The model\n * contains packages.  Packages have an entry point (today, only one).  And the entry point can contain various types\n * of API declarations.  The container relationships might look like this:\n *\n * ```\n * Things that can contain other things:\n *\n * - ApiModel\n *   - ApiPackage\n *     - ApiEntryPoint\n *       - ApiClass\n *         - ApiMethod\n *         - ApiProperty\n *       - ApiEnum\n *         - ApiEnumMember\n *       - ApiInterface\n *         - ApiMethodSignature\n *         - ApiPropertySignature\n *       - ApiNamespace\n *         - (ApiClass, ApiEnum, ApiInterace, ...)\n *\n * ```\n *\n * Normally, API Extractor writes an .api.json file to disk for each project that it builds.  Then, a tool like\n * API Documenter can load the various `ApiPackage` objects into a single `ApiModel` and process them as a group.\n * This is useful because compilation generally occurs separately (e.g. because projects may reside in different\n * Git repos, or because they build with different TypeScript compiler configurations that may be incompatible),\n * whereas API Documenter cannot detect broken hyperlinks without seeing the entire documentation set.\n *\n * @public\n */\nexport class ApiModel extends ApiItemContainerMixin(ApiItem) {\n  private readonly _resolver: ModelReferenceResolver;\n\n  private _packagesByName: Map<string, ApiPackage> | undefined = undefined;\n  private _apiItemsByCanonicalReference: Map<string, ApiItem> | undefined = undefined;\n  public constructor() {\n    super({});\n\n    this._resolver = new ModelReferenceResolver(this);\n  }\n\n  public loadPackage(apiJsonFilename: string): ApiPackage {\n    const apiPackage: ApiPackage = ApiPackage.loadFromJsonFile(apiJsonFilename);\n    this.addMember(apiPackage);\n    return apiPackage;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Model;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return '';\n  }\n\n  public get packages(): ReadonlyArray<ApiPackage> {\n    return this.members as ReadonlyArray<ApiPackage>;\n  }\n\n  /** @override */\n  public addMember(member: ApiPackage): void {\n    if (member.kind !== ApiItemKind.Package) {\n      throw new Error('Only items of type ApiPackage may be added to an ApiModel');\n    }\n    super.addMember(member);\n    this._packagesByName = undefined; // invalidate the cache\n    this._apiItemsByCanonicalReference = undefined; // invalidate the cache\n  }\n\n  /**\n   * Efficiently finds a package by the NPM package name.\n   *\n   * @remarks\n   *\n   * If the NPM scope is omitted in the package name, it will still be found provided that it is an unambiguous match.\n   * For example, it's often convenient to write `{@link node-core-library#JsonFile}` instead of\n   * `{@link @rushstack/node-core-library#JsonFile}`.\n   */\n  public tryGetPackageByName(packageName: string): ApiPackage | undefined {\n    // Build the lookup on demand\n    if (this._packagesByName === undefined) {\n      this._packagesByName = new Map<string, ApiPackage>();\n\n      const unscopedMap: Map<string, ApiPackage | undefined> = new Map<string, ApiPackage | undefined>();\n\n      for (const apiPackage of this.packages) {\n        if (this._packagesByName.get(apiPackage.name)) {\n          // This should not happen\n          throw new Error(`The model contains multiple packages with the name ${apiPackage.name}`);\n        }\n\n        this._packagesByName.set(apiPackage.name, apiPackage);\n\n        const unscopedName: string = PackageName.parse(apiPackage.name).unscopedName;\n\n        if (unscopedMap.has(unscopedName)) {\n          // If another package has the same unscoped name, then we won't register it\n          unscopedMap.set(unscopedName, undefined);\n        } else {\n          unscopedMap.set(unscopedName, apiPackage);\n        }\n      }\n\n      for (const [unscopedName, apiPackage] of unscopedMap) {\n        if (apiPackage) {\n          if (!this._packagesByName.has(unscopedName)) {\n            // If the unscoped name is unambiguous, then we can also use it as a lookup\n            this._packagesByName.set(unscopedName, apiPackage);\n          }\n        }\n      }\n    }\n\n    return this._packagesByName.get(packageName);\n  }\n\n  public resolveDeclarationReference(\n    declarationReference: DocDeclarationReference | DeclarationReference,\n    contextApiItem: ApiItem | undefined\n  ): IResolveDeclarationReferenceResult {\n    if (declarationReference instanceof DocDeclarationReference) {\n      return this._resolver.resolve(declarationReference, contextApiItem);\n    } else if (declarationReference instanceof DeclarationReference) {\n      // use this._apiItemsByCanonicalReference to look up ApiItem\n\n      // Build the lookup on demand\n      if (!this._apiItemsByCanonicalReference) {\n        this._apiItemsByCanonicalReference = new Map<string, ApiItem>();\n\n        for (const apiPackage of this.packages) {\n          this._initApiItemsRecursive(apiPackage, this._apiItemsByCanonicalReference);\n        }\n      }\n\n      const result: IResolveDeclarationReferenceResult = {\n        resolvedApiItem: undefined,\n        errorMessage: undefined\n      };\n\n      const apiItem: ApiItem | undefined = this._apiItemsByCanonicalReference.get(\n        declarationReference.toString()\n      );\n\n      if (!apiItem) {\n        result.errorMessage = `${declarationReference.toString()} can not be located`;\n      } else {\n        result.resolvedApiItem = apiItem;\n      }\n\n      return result;\n    } else {\n      // NOTE: The \"instanceof DeclarationReference\" test assumes a specific version of the @microsoft/tsdoc package.\n      throw new Error(\n        'The \"declarationReference\" parameter must be an instance of' +\n          ' DocDeclarationReference or DeclarationReference'\n      );\n    }\n  }\n\n  private _initApiItemsRecursive(apiItem: ApiItem, apiItemsByCanonicalReference: Map<string, ApiItem>): void {\n    if (apiItem.canonicalReference && !apiItem.canonicalReference.isEmpty) {\n      apiItemsByCanonicalReference.set(apiItem.canonicalReference.toString(), apiItem);\n    }\n\n    // Recurse container members\n    if (ApiItemContainerMixin.isBaseClassOf(apiItem)) {\n      for (const apiMember of apiItem.members) {\n        this._initApiItemsRecursive(apiMember, apiItemsByCanonicalReference);\n      }\n    }\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    return DeclarationReference.empty();\n  }\n}\n"]}

package/lib-esm/model/ApiNamespace.js

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript namespace declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiNamespace` represents a TypeScript declaration such `X` or `Y` in this example:
+ *
+ * ```ts
+ * export namespace X {
+ *   export namespace Y {
+ *     export interface IWidget {
+ *       render(): void;
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @public
+ */
+export class ApiNamespace extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.Namespace}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Namespace;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiNamespace.getContainerKey(this.name);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        const navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(navigation, nameComponent)
+            .withMeaning(Meaning.Namespace);
+    }
+}
+//# sourceMappingURL=ApiNamespace.js.map

package/lib-esm/model/ApiNamespace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiNamespace.js","sourceRoot":"","sources":["../../src/model/ApiNamespace.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAgC,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAiC,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAa7F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAAqB,CACrD,YAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CACpE;IACC,YAAmB,OAA6B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC;aAC5C,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;CACF","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 {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\nimport { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { type IApiExportedMixinOptions, ApiExportedMixin } from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiClass}.\n * @public\n */\nexport interface IApiNamespaceOptions\n  extends IApiItemContainerMixinOptions,\n    IApiNameMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiExportedMixinOptions {}\n\n/**\n * Represents a TypeScript namespace declaration.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiNamespace` represents a TypeScript declaration such `X` or `Y` in this example:\n *\n * ```ts\n * export namespace X {\n *   export namespace Y {\n *     export interface IWidget {\n *       render(): void;\n *     }\n *   }\n * }\n * ```\n *\n * @public\n */\nexport class ApiNamespace extends ApiItemContainerMixin(\n  ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))\n) {\n  public constructor(options: IApiNamespaceOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.Namespace}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Namespace;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiNamespace.getContainerKey(this.name);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(navigation, nameComponent)\n      .withMeaning(Meaning.Namespace);\n  }\n}\n"]}