@microsoft/api-extractor-model 7.32.2 → 7.33.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFindApiItemsResult.js","sourceRoot":"","sources":["../../src/mixins/IFindApiItemsResult.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AA2C3D;;;GAGG;AACH,MAAM,CAAN,IAAY,qBAoBX;AApBD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,sFAA6D,CAAA;IAE7D;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,yEAAgD,CAAA;IAEhD;;OAEG;IACH,6DAAoC,CAAA;AACtC,CAAC,EApBW,qBAAqB,KAArB,qBAAqB,QAoBhC","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 type { ApiItem } from '../items/ApiItem';\n\n/**\n * Generic result object for finding API items used by different kinds of find operations.\n * @public\n */\nexport interface IFindApiItemsResult {\n  /**\n   * The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.\n   */\n  items: ApiItem[];\n\n  /**\n   * Diagnostic messages regarding the find operation.\n   */\n  messages: IFindApiItemsMessage[];\n\n  /**\n   * Indicates whether the result is potentially incomplete due to errors during the find operation.\n   * If true, the `messages` explain the errors in more detail.\n   */\n  maybeIncompleteResult: boolean;\n}\n\n/**\n * This object is used for messages returned as part of `IFindApiItemsResult`.\n * @public\n */\nexport interface IFindApiItemsMessage {\n  /**\n   * Unique identifier for the message.\n   * @beta\n   */\n  messageId: FindApiItemsMessageId;\n\n  /**\n   * Text description of the message.\n   */\n  text: string;\n}\n\n/**\n * Unique identifiers for messages returned as part of `IFindApiItemsResult`.\n * @public\n */\nexport enum FindApiItemsMessageId {\n  /**\n   * \"Unable to resolve declaration reference within API item ___: ___\"\n   */\n  DeclarationResolutionFailed = 'declaration-resolution-failed',\n\n  /**\n   * \"Unable to analyze extends clause ___ of API item ___ because no canonical reference was found.\"\n   */\n  ExtendsClauseMissingReference = 'extends-clause-missing-reference',\n\n  /**\n   * \"Unable to analyze references of API item ___ because it is not associated with an ApiModel\"\n   */\n  NoAssociatedApiModel = 'no-associated-api-model',\n\n  /**\n   * \"Unable to analyze references of API item ___ because it is of unsupported kind ___\"\n   */\n  UnsupportedKind = 'unsupported-kind'\n}\n"]}

package/lib-esm/mixins/Mixin.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+export {};
+//# sourceMappingURL=Mixin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../src/mixins/Mixin.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * This abstraction is used by the mixin pattern.\n * It describes a class constructor.\n * @public\n */\nexport type Constructor<T = {}> = new (...args: any[]) => T; // eslint-disable-line @typescript-eslint/no-explicit-any\n\n/**\n * This abstraction is used by the mixin pattern.\n * It describes the \"static side\" of a class.\n *\n * @public\n */\nexport type PropertiesOf<T> = { [K in keyof T]: T[K] };\n"]}

package/lib-esm/model/ApiCallSignature.js

@@ -0,0 +1,63 @@
+// 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 { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+/**
+ * Represents a TypeScript function call signature.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiCallSignature` represents a TypeScript declaration such as `(x: number, y: number): number`
+ * in this example:
+ *
+ * ```ts
+ * export interface IChooser {
+ *   // A call signature:
+ *   (x: number, y: number): number;
+ *
+ *   // Another overload for this call signature:
+ *   (x: string, y: string): string;
+ * }
+ *
+ * function chooseFirst<T>(x: T, y: T): T {
+ *   return x;
+ * }
+ *
+ * let chooser: IChooser = chooseFirst;
+ * ```
+ *
+ * @public
+ */
+export class ApiCallSignature extends ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(overloadIndex) {
+        return `|${ApiItemKind.CallSignature}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.CallSignature;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiCallSignature.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.CallSignature).withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiCallSignature.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiCallSignature.js","sourceRoot":"","sources":["../../src/model/ApiCallSignature.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,EAEL,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAa7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,gBAAiB,SAAQ,yBAAyB,CAC7D,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,CAC/E;IACC,YAAmB,OAAiC;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,WAAW,CAAC,aAAa,IAAI,aAAa,EAAE,CAAC;IAC1D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,aAAa,CAAC;IACnC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9D,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,aAAa,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACzF,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 {\n  type IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from '../mixins/ApiTypeParameterListMixin';\n\n/**\n * Constructor options for {@link ApiCallSignature}.\n * @public\n */\nexport interface IApiCallSignatureOptions\n  extends IApiTypeParameterListMixinOptions,\n    IApiParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript function call 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 * `ApiCallSignature` represents a TypeScript declaration such as `(x: number, y: number): number`\n * in this example:\n *\n * ```ts\n * export interface IChooser {\n *   // A call signature:\n *   (x: number, y: number): number;\n *\n *   // Another overload for this call signature:\n *   (x: string, y: string): string;\n * }\n *\n * function chooseFirst<T>(x: T, y: T): T {\n *   return x;\n * }\n *\n * let chooser: IChooser = chooseFirst;\n * ```\n *\n * @public\n */\nexport class ApiCallSignature extends ApiTypeParameterListMixin(\n  ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))\n) {\n  public constructor(options: IApiCallSignatureOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(overloadIndex: number): string {\n    return `|${ApiItemKind.CallSignature}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.CallSignature;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiCallSignature.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.CallSignature).withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiClass.js

@@ -0,0 +1,84 @@
+// 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 { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { HeritageType } from './HeritageType';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+import { ApiAbstractMixin } from '../mixins/ApiAbstractMixin';
+/**
+ * Represents a TypeScript class declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiClass` represents a TypeScript declaration such as this:
+ *
+ * ```ts
+ * export class X { }
+ * ```
+ *
+ * @public
+ */
+export class ApiClass extends ApiItemContainerMixin(ApiNameMixin(ApiAbstractMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))))) {
+    constructor(options) {
+        super(options);
+        this._implementsTypes = [];
+        if (options.extendsTokenRange) {
+            this.extendsType = new HeritageType(this.buildExcerpt(options.extendsTokenRange));
+        }
+        else {
+            this.extendsType = undefined;
+        }
+        for (const implementsTokenRange of options.implementsTokenRanges) {
+            this._implementsTypes.push(new HeritageType(this.buildExcerpt(implementsTokenRange)));
+        }
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.Class}`;
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.extendsTokenRange = jsonObject.extendsTokenRange;
+        options.implementsTokenRanges = jsonObject.implementsTokenRanges;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Class;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiClass.getContainerKey(this.name);
+    }
+    /**
+     * The list of interfaces that this class implements using the `implements` keyword.
+     */
+    get implementsTypes() {
+        return this._implementsTypes;
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        // Note that JSON does not support the "undefined" value, so we simply omit the field entirely if it is undefined
+        if (this.extendsType) {
+            jsonObject.extendsTokenRange = this.extendsType.excerpt.tokenRange;
+        }
+        jsonObject.implementsTokenRanges = this.implementsTypes.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.Class);
+    }
+}
+//# sourceMappingURL=ApiClass.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiClass.js","sourceRoot":"","sources":["../../src/model/ApiClass.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,eAAe,EAGhB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AAEnG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EACL,yBAAyB,EAG1B,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAGL,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,gBAAgB,EAGjB,MAAM,4BAA4B,CAAC;AA2BpC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,QAAS,SAAQ,qBAAqB,CACjD,YAAY,CACV,gBAAgB,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACnG,CACF;IAQC,YAAmB,OAAyB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHA,qBAAgB,GAAmB,EAAE,CAAC;QAKrD,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACpF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,KAAK,MAAM,oBAAoB,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YACjE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;IACxC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAkC,EAClC,OAA4B,EAC5B,UAAyB;QAEzB,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACzD,OAAO,CAAC,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAkC;QACrD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,iHAAiH;QACjH,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;QACrE,CAAC;QAED,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3F,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,KAAK,CAAC,CAAC;IAChC,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  ApiDeclaredItem,\n  type IApiDeclaredItemOptions,\n  type IApiDeclaredItemJson\n} from '../items/ApiDeclaredItem';\nimport { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\nimport { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport type { IExcerptTokenRange } from '../mixins/Excerpt';\nimport { HeritageType } from './HeritageType';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport {\n  ApiTypeParameterListMixin,\n  type IApiTypeParameterListMixinOptions,\n  type IApiTypeParameterListMixinJson\n} from '../mixins/ApiTypeParameterListMixin';\nimport type { DeserializerContext } from './DeserializerContext';\nimport {\n  type IApiExportedMixinJson,\n  type IApiExportedMixinOptions,\n  ApiExportedMixin\n} from '../mixins/ApiExportedMixin';\nimport {\n  ApiAbstractMixin,\n  type IApiAbstractMixinJson,\n  type IApiAbstractMixinOptions\n} from '../mixins/ApiAbstractMixin';\n\n/**\n * Constructor options for {@link ApiClass}.\n * @public\n */\nexport interface IApiClassOptions\n  extends IApiItemContainerMixinOptions,\n    IApiNameMixinOptions,\n    IApiAbstractMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiExportedMixinOptions {\n  extendsTokenRange: IExcerptTokenRange | undefined;\n  implementsTokenRanges: IExcerptTokenRange[];\n}\n\nexport interface IApiClassJson\n  extends IApiDeclaredItemJson,\n    IApiAbstractMixinJson,\n    IApiTypeParameterListMixinJson,\n    IApiExportedMixinJson {\n  extendsTokenRange?: IExcerptTokenRange;\n  implementsTokenRanges: 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 * `ApiClass` represents a TypeScript declaration such as this:\n *\n * ```ts\n * export class X { }\n * ```\n *\n * @public\n */\nexport class ApiClass extends ApiItemContainerMixin(\n  ApiNameMixin(\n    ApiAbstractMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))))\n  )\n) {\n  /**\n   * The base class that this class inherits from (using the `extends` keyword), or undefined if there is no base class.\n   */\n  public readonly extendsType: HeritageType | undefined;\n\n  private readonly _implementsTypes: HeritageType[] = [];\n\n  public constructor(options: IApiClassOptions) {\n    super(options);\n\n    if (options.extendsTokenRange) {\n      this.extendsType = new HeritageType(this.buildExcerpt(options.extendsTokenRange));\n    } else {\n      this.extendsType = undefined;\n    }\n\n    for (const implementsTokenRange of options.implementsTokenRanges) {\n      this._implementsTypes.push(new HeritageType(this.buildExcerpt(implementsTokenRange)));\n    }\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.Class}`;\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiClassOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiClassJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.extendsTokenRange = jsonObject.extendsTokenRange;\n    options.implementsTokenRanges = jsonObject.implementsTokenRanges;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Class;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiClass.getContainerKey(this.name);\n  }\n\n  /**\n   * The list of interfaces that this class implements using the `implements` keyword.\n   */\n  public get implementsTypes(): ReadonlyArray<HeritageType> {\n    return this._implementsTypes;\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiClassJson>): void {\n    super.serializeInto(jsonObject);\n\n    // Note that JSON does not support the \"undefined\" value, so we simply omit the field entirely if it is undefined\n    if (this.extendsType) {\n      jsonObject.extendsTokenRange = this.extendsType.excerpt.tokenRange;\n    }\n\n    jsonObject.implementsTokenRanges = this.implementsTypes.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.Class);\n  }\n}\n"]}

package/lib-esm/model/ApiConstructSignature.js

@@ -0,0 +1,76 @@
+// 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 { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+/**
+ * Represents a TypeScript construct signature that belongs to an `ApiInterface`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example:
+ *
+ * ```ts
+ * export interface IVector {
+ *   x: number;
+ *   y: number;
+ * }
+ *
+ * export interface IVectorConstructor {
+ *   // A construct signature:
+ *   new(x: number, y: number): IVector;
+ * }
+ *
+ * export function createVector(vectorConstructor: IVectorConstructor,
+ *   x: number, y: number): IVector {
+ *   return new vectorConstructor(x, y);
+ * }
+ *
+ * class Vector implements IVector {
+ *   public x: number;
+ *   public y: number;
+ *   public constructor(x: number, y: number) {
+ *     this.x = x;
+ *     this.y = y;
+ *   }
+ * }
+ *
+ * let vector: Vector = createVector(Vector, 1, 2);
+ * ```
+ *
+ * Compare with {@link ApiConstructor}, which describes the class constructor itself.
+ *
+ * @public
+ */
+export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(overloadIndex) {
+        return `|${ApiItemKind.ConstructSignature}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.ConstructSignature;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiConstructSignature.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.ConstructSignature).withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiConstructSignature.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiConstructSignature.js","sourceRoot":"","sources":["../../src/model/ApiConstructSignature.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,EACL,yBAAyB,EAE1B,MAAM,qCAAqC,CAAC;AAa7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,OAAO,qBAAsB,SAAQ,yBAAyB,CAClE,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,CAC/E;IACC,YAAmB,OAAsC;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,WAAW,CAAC,kBAAkB,IAAI,aAAa,EAAE,CAAC;IAC/D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,kBAAkB,CAAC;IACxC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnE,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,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9F,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 {\n  ApiTypeParameterListMixin,\n  type IApiTypeParameterListMixinOptions\n} from '../mixins/ApiTypeParameterListMixin';\n\n/**\n * Constructor options for {@link ApiConstructor}.\n * @public\n */\nexport interface IApiConstructSignatureOptions\n  extends IApiTypeParameterListMixinOptions,\n    IApiParameterListMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReturnTypeMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript construct signature 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 * `ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example:\n *\n * ```ts\n * export interface IVector {\n *   x: number;\n *   y: number;\n * }\n *\n * export interface IVectorConstructor {\n *   // A construct signature:\n *   new(x: number, y: number): IVector;\n * }\n *\n * export function createVector(vectorConstructor: IVectorConstructor,\n *   x: number, y: number): IVector {\n *   return new vectorConstructor(x, y);\n * }\n *\n * class Vector implements IVector {\n *   public x: number;\n *   public y: number;\n *   public constructor(x: number, y: number) {\n *     this.x = x;\n *     this.y = y;\n *   }\n * }\n *\n * let vector: Vector = createVector(Vector, 1, 2);\n * ```\n *\n * Compare with {@link ApiConstructor}, which describes the class constructor itself.\n *\n * @public\n */\nexport class ApiConstructSignature extends ApiTypeParameterListMixin(\n  ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))\n) {\n  public constructor(options: IApiConstructSignatureOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(overloadIndex: number): string {\n    return `|${ApiItemKind.ConstructSignature}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.ConstructSignature;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiConstructSignature.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.ConstructSignature).withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiConstructor.js

@@ -0,0 +1,60 @@
+// 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 { ApiProtectedMixin } from '../mixins/ApiProtectedMixin';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+/**
+ * Represents a TypeScript class constructor declaration that belongs to an `ApiClass`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiConstructor` represents a declaration using the `constructor` keyword such as in this example:
+ *
+ * ```ts
+ * export class Vector {
+ *   public x: number;
+ *   public y: number;
+ *
+ *   // A class constructor:
+ *   public constructor(x: number, y: number) {
+ *     this.x = x;
+ *     this.y = y;
+ *   }
+ * }
+ * ```
+ *
+ * Compare with {@link ApiConstructSignature}, which describes the construct signature for a class constructor.
+ *
+ * @public
+ */
+export class ApiConstructor extends ApiParameterListMixin(ApiProtectedMixin(ApiReleaseTagMixin(ApiDeclaredItem))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(overloadIndex) {
+        return `|${ApiItemKind.Constructor}|${overloadIndex}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Constructor;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiConstructor.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.Constructor).withOverloadIndex(this.overloadIndex);
+    }
+}
+//# sourceMappingURL=ApiConstructor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiConstructor.js","sourceRoot":"","sources":["../../src/model/ApiConstructor.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,EAAE,iBAAiB,EAAkC,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAAmC,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAYnG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,cAAe,SAAQ,qBAAqB,CACvD,iBAAiB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CACvD;IACC,YAAmB,OAA+B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,WAAW,CAAC,WAAW,IAAI,aAAa,EAAE,CAAC;IACxD,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5D,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,WAAW,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACvF,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 { ApiProtectedMixin, type IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin';\nimport { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\n\n/**\n * Constructor options for {@link ApiConstructor}.\n * @public\n */\nexport interface IApiConstructorOptions\n  extends IApiParameterListMixinOptions,\n    IApiProtectedMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions {}\n\n/**\n * Represents a TypeScript class constructor 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 * `ApiConstructor` represents a declaration using the `constructor` keyword such as in this example:\n *\n * ```ts\n * export class Vector {\n *   public x: number;\n *   public y: number;\n *\n *   // A class constructor:\n *   public constructor(x: number, y: number) {\n *     this.x = x;\n *     this.y = y;\n *   }\n * }\n * ```\n *\n * Compare with {@link ApiConstructSignature}, which describes the construct signature for a class constructor.\n *\n * @public\n */\nexport class ApiConstructor extends ApiParameterListMixin(\n  ApiProtectedMixin(ApiReleaseTagMixin(ApiDeclaredItem))\n) {\n  public constructor(options: IApiConstructorOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(overloadIndex: number): string {\n    return `|${ApiItemKind.Constructor}|${overloadIndex}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Constructor;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiConstructor.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.Constructor).withOverloadIndex(this.overloadIndex);\n  }\n}\n"]}

package/lib-esm/model/ApiEntryPoint.js

@@ -0,0 +1,71 @@
+// 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 { ApiItem, ApiItemKind } from '../items/ApiItem';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiPackage } from './ApiPackage';
+/**
+ * Represents the entry point for an NPM package.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiEntryPoint` represents the entry point to an NPM package.  API Extractor does not currently support
+ * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature.
+ * In the current implementation, `ApiEntryPoint.importPath` is always the empty string.
+ *
+ * For example, suppose the package.json file looks like this:
+ *
+ * ```json
+ * {
+ *   "name": "example-library",
+ *   "version": "1.0.0",
+ *   "main": "./lib/index.js",
+ *   "typings": "./lib/index.d.ts"
+ * }
+ * ```
+ *
+ * In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.
+ *
+ * @public
+ */
+export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) {
+    constructor(options) {
+        super(options);
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.EntryPoint;
+    }
+    /** @override */
+    get containerKey() {
+        // No prefix needed, because ApiEntryPoint is the only possible member of an ApiPackage
+        return this.name;
+    }
+    /**
+     * The module path for this entry point, relative to the parent `ApiPackage`.  In the current implementation,
+     * this is always the empty string, indicating the default entry point.
+     *
+     * @remarks
+     *
+     * API Extractor does not currently support analysis of multiple entry points.  If that feature is implemented
+     * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points,
+     * for example: `controls/Button` in `import { Button } from "example-package/controls/Button";`.
+     *
+     * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.
+     */
+    get importPath() {
+        return this.name;
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        if (this.parent instanceof ApiPackage) {
+            return DeclarationReference.package(this.parent.name, this.importPath);
+        }
+        return DeclarationReference.empty();
+    }
+}
+//# sourceMappingURL=ApiEntryPoint.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiEntryPoint.js","sourceRoot":"","sources":["../../src/model/ApiEntryPoint.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAE/F,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,aAAc,SAAQ,qBAAqB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7E,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,UAAU,CAAC;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,uFAAuF;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,IAAI,IAAI,CAAC,MAAM,YAAY,UAAU,EAAE,CAAC;YACtC,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACzE,CAAC;QAED,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';\n\nimport { ApiItem, ApiItemKind } from '../items/ApiItem';\nimport { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { ApiPackage } from './ApiPackage';\n\n/**\n * Constructor options for {@link ApiEntryPoint}.\n * @public\n */\nexport interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions {}\n\n/**\n * Represents the entry point for an NPM package.\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 * `ApiEntryPoint` represents the entry point to an NPM package.  API Extractor does not currently support\n * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature.\n * In the current implementation, `ApiEntryPoint.importPath` is always the empty string.\n *\n * For example, suppose the package.json file looks like this:\n *\n * ```json\n * {\n *   \"name\": \"example-library\",\n *   \"version\": \"1.0.0\",\n *   \"main\": \"./lib/index.js\",\n *   \"typings\": \"./lib/index.d.ts\"\n * }\n * ```\n *\n * In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.\n *\n * @public\n */\nexport class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) {\n  public constructor(options: IApiEntryPointOptions) {\n    super(options);\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.EntryPoint;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    // No prefix needed, because ApiEntryPoint is the only possible member of an ApiPackage\n    return this.name;\n  }\n\n  /**\n   * The module path for this entry point, relative to the parent `ApiPackage`.  In the current implementation,\n   * this is always the empty string, indicating the default entry point.\n   *\n   * @remarks\n   *\n   * API Extractor does not currently support analysis of multiple entry points.  If that feature is implemented\n   * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points,\n   * for example: `controls/Button` in `import { Button } from \"example-package/controls/Button\";`.\n   *\n   * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.\n   */\n  public get importPath(): string {\n    return this.name;\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    if (this.parent instanceof ApiPackage) {\n      return DeclarationReference.package(this.parent.name, this.importPath);\n    }\n\n    return DeclarationReference.empty();\n  }\n}\n"]}

package/lib-esm/model/ApiEnum.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 { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript enum declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiEnum` represents an enum declaration such as `FontSizes` in the example below:
+ *
+ * ```ts
+ * export enum FontSizes {
+ *   Small = 100,
+ *   Medium = 200,
+ *   Large = 300
+ * }
+ * ```
+ *
+ * @public
+ */
+export class ApiEnum extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.Enum}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Enum;
+    }
+    /** @override */
+    get members() {
+        return super.members;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiEnum.getContainerKey(this.name);
+    }
+    /** @override */
+    addMember(member) {
+        if (member.kind !== ApiItemKind.EnumMember) {
+            throw new Error('Only ApiEnumMember objects can be added to an ApiEnum');
+        }
+        super.addMember(member);
+    }
+    /** @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.Enum);
+    }
+}
+//# sourceMappingURL=ApiEnum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiEnum.js","sourceRoot":"","sources":["../../src/model/ApiEnum.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,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAE5G,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAiC,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAa7F;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,OAAQ,SAAQ,qBAAqB,CAChD,YAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CACpE;IACC,YAAmB,OAAwB;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,gBAAgB;IAChB,IAAW,OAAO;QAChB,OAAO,KAAK,CAAC,OAAuC,CAAC;IACvD,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAqB;QACpC,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,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,IAAI,CAAC,CAAC;IAC/B,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 { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\nimport type { ApiEnumMember } from './ApiEnumMember';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { type IApiExportedMixinOptions, ApiExportedMixin } from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiEnum}.\n * @public\n */\nexport interface IApiEnumOptions\n  extends IApiItemContainerMixinOptions,\n    IApiNameMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiExportedMixinOptions {}\n\n/**\n * Represents a TypeScript enum 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 * `ApiEnum` represents an enum declaration such as `FontSizes` in the example below:\n *\n * ```ts\n * export enum FontSizes {\n *   Small = 100,\n *   Medium = 200,\n *   Large = 300\n * }\n * ```\n *\n * @public\n */\nexport class ApiEnum extends ApiItemContainerMixin(\n  ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))\n) {\n  public constructor(options: IApiEnumOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.Enum}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Enum;\n  }\n\n  /** @override */\n  public get members(): ReadonlyArray<ApiEnumMember> {\n    return super.members as ReadonlyArray<ApiEnumMember>;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiEnum.getContainerKey(this.name);\n  }\n\n  /** @override */\n  public addMember(member: ApiEnumMember): void {\n    if (member.kind !== ApiItemKind.EnumMember) {\n      throw new Error('Only ApiEnumMember objects can be added to an ApiEnum');\n    }\n    super.addMember(member);\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.Enum);\n  }\n}\n"]}

package/lib-esm/model/ApiEnumMember.js

@@ -0,0 +1,80 @@
+// 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 { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiInitializerMixin } from '../mixins/ApiInitializerMixin';
+/**
+ * Options for customizing the sort order of {@link ApiEnum} members.
+ *
+ * @privateRemarks
+ * This enum is currently only used by the `@microsoft/api-extractor` package; it is declared here
+ * because we anticipate that if more options are added in the future, their sorting will be implemented
+ * by the `@microsoft/api-extractor-model` package.
+ *
+ * See https://github.com/microsoft/rushstack/issues/918 for details.
+ *
+ * @public
+ */
+export var EnumMemberOrder;
+(function (EnumMemberOrder) {
+    /**
+     * `ApiEnumMember` items are sorted according to their {@link ApiItem.getSortKey}.  The order is
+     * basically alphabetical by identifier name, but otherwise unspecified to allow for cosmetic improvements.
+     *
+     * This is the default behavior.
+     */
+    EnumMemberOrder["ByName"] = "by-name";
+    /**
+     * `ApiEnumMember` items preserve the original order of the declarations in the source file.
+     * (This disables the automatic sorting that is normally applied based on {@link ApiItem.getSortKey}.)
+     */
+    EnumMemberOrder["Preserve"] = "preserve";
+})(EnumMemberOrder || (EnumMemberOrder = {}));
+/**
+ * Represents a member of a TypeScript enum declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiEnumMember` represents an enum member such as `Small = 100` in the example below:
+ *
+ * ```ts
+ * export enum FontSizes {
+ *   Small = 100,
+ *   Medium = 200,
+ *   Large = 300
+ * }
+ * ```
+ *
+ * @public
+ */
+export class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiInitializerMixin(ApiDeclaredItem))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name) {
+        // No prefix needed, because ApiEnumMember is the only possible member of an ApiEnum
+        return name;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.EnumMember;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiEnumMember.getContainerKey(this.name);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(Navigation.Exports, nameComponent)
+            .withMeaning(Meaning.Member);
+    }
+}
+//# sourceMappingURL=ApiEnumMember.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiEnumMember.js","sourceRoot":"","sources":["../../src/model/ApiEnumMember.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,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAoC,MAAM,+BAA+B,CAAC;AAYtG;;;;;;;;;;;GAWG;AACH,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB;;;;;OAKG;IACH,qCAAkB,CAAA;IAElB;;;OAGG;IACH,wCAAqB,CAAA;AACvB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACvG,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,oFAAoF;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,UAAU,CAAC;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,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,CAAC;IACjC,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 { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { ApiInitializerMixin, type IApiInitializerMixinOptions } from '../mixins/ApiInitializerMixin';\n\n/**\n * Constructor options for {@link ApiEnumMember}.\n * @public\n */\nexport interface IApiEnumMemberOptions\n  extends IApiNameMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiInitializerMixinOptions {}\n\n/**\n * Options for customizing the sort order of {@link ApiEnum} members.\n *\n * @privateRemarks\n * This enum is currently only used by the `@microsoft/api-extractor` package; it is declared here\n * because we anticipate that if more options are added in the future, their sorting will be implemented\n * by the `@microsoft/api-extractor-model` package.\n *\n * See https://github.com/microsoft/rushstack/issues/918 for details.\n *\n * @public\n */\nexport enum EnumMemberOrder {\n  /**\n   * `ApiEnumMember` items are sorted according to their {@link ApiItem.getSortKey}.  The order is\n   * basically alphabetical by identifier name, but otherwise unspecified to allow for cosmetic improvements.\n   *\n   * This is the default behavior.\n   */\n  ByName = 'by-name',\n\n  /**\n   * `ApiEnumMember` items preserve the original order of the declarations in the source file.\n   * (This disables the automatic sorting that is normally applied based on {@link ApiItem.getSortKey}.)\n   */\n  Preserve = 'preserve'\n}\n\n/**\n * Represents a member of a TypeScript enum 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 * `ApiEnumMember` represents an enum member such as `Small = 100` in the example below:\n *\n * ```ts\n * export enum FontSizes {\n *   Small = 100,\n *   Medium = 200,\n *   Large = 300\n * }\n * ```\n *\n * @public\n */\nexport class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiInitializerMixin(ApiDeclaredItem))) {\n  public constructor(options: IApiEnumMemberOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string): string {\n    // No prefix needed, because ApiEnumMember is the only possible member of an ApiEnum\n    return name;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.EnumMember;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiEnumMember.getContainerKey(this.name);\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.Exports, nameComponent)\n      .withMeaning(Meaning.Member);\n  }\n}\n"]}