@microsoft/api-extractor-model 7.9.7 → 7.10.3

package/CHANGELOG.json

@@ -1,6 +1,81 @@
 {
   "name": "@microsoft/api-extractor-model",
   "entries": [
+    {
+      "version": "7.10.3",
+      "tag": "@microsoft/api-extractor-model_v7.10.3",
+      "date": "Tue, 06 Oct 2020 00:24:06 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.34.3`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/eslint-config\" to `2.2.1`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.10.2",
+      "tag": "@microsoft/api-extractor-model_v7.10.2",
+      "date": "Mon, 05 Oct 2020 22:36:57 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.34.2`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/eslint-config\" to `2.2.0`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.10.1",
+      "tag": "@microsoft/api-extractor-model_v7.10.1",
+      "date": "Wed, 30 Sep 2020 18:39:17 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update to build with @rushstack/heft-node-rig"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.34.1`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/eslint-config\" to `2.1.3`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.10.0",
+      "tag": "@microsoft/api-extractor-model_v7.10.0",
+      "date": "Wed, 30 Sep 2020 06:53:53 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update README.md"
+          }
+        ],
+        "minor": [
+          {
+            "comment": "Upgrade compiler; the API now requires TypeScript 3.9 or newer"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.34.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/eslint-config\" to `2.1.2`"
+          }
+        ]
+      }
+    },
     {
       "version": "7.9.7",
       "tag": "@microsoft/api-extractor-model_v7.9.7",

package/CHANGELOG.md

@@ -1,6 +1,34 @@
 # Change Log - @microsoft/api-extractor-model
 
-This log was last generated on Tue, 22 Sep 2020 05:45:57 GMT and should not be manually modified.
+This log was last generated on Tue, 06 Oct 2020 00:24:06 GMT and should not be manually modified.
+
+## 7.10.3
+Tue, 06 Oct 2020 00:24:06 GMT
+
+_Version update only_
+
+## 7.10.2
+Mon, 05 Oct 2020 22:36:57 GMT
+
+_Version update only_
+
+## 7.10.1
+Wed, 30 Sep 2020 18:39:17 GMT
+
+### Patches
+
+- Update to build with @rushstack/heft-node-rig
+
+## 7.10.0
+Wed, 30 Sep 2020 06:53:53 GMT
+
+### Minor changes
+
+- Upgrade compiler; the API now requires TypeScript 3.9 or newer
+
+### Patches
+
+- Update README.md
 
 ## 7.9.7
 Tue, 22 Sep 2020 05:45:57 GMT

package/README.md

@@ -57,3 +57,12 @@ a namespace containing static members of the class.
 
 > For a complete project that uses these APIs to generate an API reference web site,
 > see the [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) source code.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/master/apps/api-extractor-model/CHANGELOG.md) - Find
+  out what's new in the latest version
+- [API Reference](https://rushstack.io/pages/api/api-extractor-model/)
+
+API Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/dist/rollup.d.ts

@@ -21,7 +21,7 @@ export declare class AedocDefinitions {
     static readonly betaDocumentation: TSDocTagDefinition;
     static readonly internalRemarks: TSDocTagDefinition;
     static readonly preapprovedTag: TSDocTagDefinition;
-    static readonly tsdocConfiguration: TSDocConfiguration;
+    static get tsdocConfiguration(): TSDocConfiguration;
     private static _tsdocConfiguration;
 }
 
@@ -58,9 +58,9 @@ export declare class ApiCallSignature extends ApiCallSignature_base {
     constructor(options: IApiCallSignatureOptions);
     static getContainerKey(overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -94,13 +94,13 @@ export declare class ApiClass extends ApiClass_base {
     /** @override */
     static onDeserializeInto(options: Partial<IApiClassOptions>, context: DeserializerContext, jsonObject: IApiClassJson): void;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /**
      * The list of interfaces that this class implements using the `implements` keyword.
      */
-    readonly implementsTypes: ReadonlyArray<HeritageType>;
+    get implementsTypes(): ReadonlyArray<HeritageType>;
     /** @override */
     serializeInto(jsonObject: Partial<IApiClassJson>): void;
     /** @beta @override */
@@ -140,9 +140,9 @@ export declare class ApiConstructor extends ApiConstructor_base {
     constructor(options: IApiConstructorOptions);
     static getContainerKey(overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -195,9 +195,9 @@ export declare class ApiConstructSignature extends ApiConstructSignature_base {
     constructor(options: IApiConstructSignatureOptions);
     static getContainerKey(overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -226,11 +226,11 @@ export declare class ApiDeclaredItem extends ApiDocumentedItem {
     /**
      * The source code excerpt where the API item is declared.
      */
-    readonly excerpt: Excerpt;
+    get excerpt(): Excerpt;
     /**
      * The individual source code tokens that comprise the main excerpt.
      */
-    readonly excerptTokens: ReadonlyArray<ExcerptToken>;
+    get excerptTokens(): ReadonlyArray<ExcerptToken>;
     /**
      * If the API item has certain important modifier tags such as `@sealed`, `@virtual`, or `@override`,
      * this prepends them as a doc comment above the excerpt.
@@ -259,7 +259,7 @@ export declare class ApiDocumentedItem extends ApiItem {
     constructor(options: IApiDocumentedItemOptions);
     /** @override */
     static onDeserializeInto(options: Partial<IApiDocumentedItemOptions>, context: DeserializerContext, jsonObject: IApiItemJson): void;
-    readonly tsdocComment: tsdoc.DocComment | undefined;
+    get tsdocComment(): tsdoc.DocComment | undefined;
     /** @override */
     serializeInto(jsonObject: Partial<IApiDocumentedItemJson>): void;
 }
@@ -294,9 +294,9 @@ export declare class ApiDocumentedItem extends ApiItem {
 export declare class ApiEntryPoint extends ApiEntryPoint_base {
     constructor(options: IApiEntryPointOptions);
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /**
      * 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.
@@ -309,7 +309,7 @@ export declare class ApiEntryPoint extends ApiEntryPoint_base {
      *
      * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.
      */
-    readonly importPath: string;
+    get importPath(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -340,11 +340,11 @@ export declare class ApiEnum extends ApiEnum_base {
     constructor(options: IApiEnumOptions);
     static getContainerKey(name: string): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly members: ReadonlyArray<ApiEnumMember>;
+    get members(): ReadonlyArray<ApiEnumMember>;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @override */
     addMember(member: ApiEnumMember): void;
     /** @beta @override */
@@ -383,9 +383,9 @@ export declare class ApiEnumMember extends ApiEnumMember_base {
     /** @override */
     static onDeserializeInto(options: Partial<IApiEnumMemberOptions>, context: DeserializerContext, jsonObject: IApiEnumMemberJson): void;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @override */
     serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void;
     /** @beta @override */
@@ -419,9 +419,9 @@ export declare class ApiFunction extends ApiFunction_base {
     constructor(options: IApiFunctionOptions);
     static getContainerKey(name: string, overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -454,9 +454,9 @@ export declare class ApiIndexSignature extends ApiIndexSignature_base {
     constructor(options: IApiIndexSignatureOptions);
     static getContainerKey(overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -487,13 +487,13 @@ export declare class ApiInterface extends ApiInterface_base {
     /** @override */
     static onDeserializeInto(options: Partial<IApiInterfaceOptions>, context: DeserializerContext, jsonObject: IApiInterfaceJson): void;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /**
      * The list of base interfaces that this interface inherits from using the `extends` keyword.
      */
-    readonly extendsTypes: ReadonlyArray<HeritageType>;
+    get extendsTypes(): ReadonlyArray<HeritageType>;
     /** @override */
     serializeInto(jsonObject: Partial<IApiInterfaceJson>): void;
     /** @beta @override */
@@ -523,7 +523,7 @@ export declare class ApiItem {
      * Identifies the subclass of the `ApiItem` base class.
      * @virtual
      */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /**
      * Warning: This API is used internally by API extractor but is not yet ready for general usage.
      *
@@ -533,7 +533,7 @@ export declare class ApiItem {
      *
      * @beta
      */
-    readonly canonicalReference: DeclarationReference;
+    get canonicalReference(): DeclarationReference;
     /**
      * Returns a string key that can be used to efficiently retrieve an `ApiItem` from an `ApiItemContainerMixin`.
      * The key is unique within the container.  Its format is undocumented and may change at any time.
@@ -544,7 +544,7 @@ export declare class ApiItem {
      *
      * @virtual
      */
-    readonly containerKey: string;
+    get containerKey(): string;
     /**
      * Returns a name for this object that can be used in diagnostic messages, for example.
      *
@@ -554,21 +554,21 @@ export declare class ApiItem {
      *
      * @virtual
      */
-    readonly displayName: string;
+    get displayName(): string;
     /**
      * If this item was added to a ApiItemContainerMixin item, then this returns the container item.
      * If this is an Parameter that was added to a method or function, then this returns the function item.
      * Otherwise, it returns undefined.
      * @virtual
      */
-    readonly parent: ApiItem | undefined;
+    get parent(): ApiItem | undefined;
     /**
      * This property supports a visitor pattern for walking the tree.
      * For items with ApiItemContainerMixin, it returns the contained items.
      * Otherwise it returns an empty array.
      * @virtual
      */
-    readonly members: ReadonlyArray<ApiItem>;
+    get members(): ReadonlyArray<ApiItem>;
     /**
      * If this item has a name (i.e. extends `ApiNameMixin`), then return all items that have the same parent
      * and the same name.  Otherwise, return all items that have the same parent and the same `ApiItemKind`.
@@ -797,9 +797,9 @@ export declare class ApiMethod extends ApiMethod_base {
     constructor(options: IApiMethodOptions);
     static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -831,9 +831,9 @@ export declare class ApiMethodSignature extends ApiMethodSignature_base {
     constructor(options: IApiMethodSignatureOptions);
     static getContainerKey(name: string, overloadIndex: number): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -887,10 +887,10 @@ export declare class ApiModel extends ApiModel_base {
     constructor();
     loadPackage(apiJsonFilename: string): ApiPackage;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
-    readonly packages: ReadonlyArray<ApiPackage>;
+    get containerKey(): string;
+    get packages(): ReadonlyArray<ApiPackage>;
     /** @override */
     addMember(member: ApiPackage): void;
     /**
@@ -992,9 +992,9 @@ export declare class ApiNamespace extends ApiNamespace_base {
     constructor(options: IApiNamespaceOptions);
     static getContainerKey(name: string): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -1015,10 +1015,10 @@ export declare class ApiPackage extends ApiPackage_base {
     constructor(options: IApiPackageOptions);
     static loadFromJsonFile(apiJsonFilename: string): ApiPackage;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
-    readonly entryPoints: ReadonlyArray<ApiEntryPoint>;
+    get containerKey(): string;
+    get entryPoints(): ReadonlyArray<ApiEntryPoint>;
     /** @override */
     addMember(member: ApiEntryPoint): void;
     findEntryPointsByPath(importPath: string): ReadonlyArray<ApiEntryPoint>;
@@ -1145,9 +1145,9 @@ export declare class ApiProperty extends ApiProperty_base {
     constructor(options: IApiPropertyOptions);
     static getContainerKey(name: string, isStatic: boolean): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -1177,7 +1177,7 @@ export declare class ApiPropertyItem extends ApiPropertyItem_base {
      * The documentation should display such properties under an "Events" heading instead of the
      * usual "Properties" heading.
      */
-    readonly isEventProperty: boolean;
+    get isEventProperty(): boolean;
     /** @override */
     serializeInto(jsonObject: Partial<IApiPropertyItemJson>): void;
 }
@@ -1210,9 +1210,9 @@ export declare class ApiPropertySignature extends ApiPropertyItem {
     constructor(options: IApiPropertySignatureOptions);
     static getContainerKey(name: string): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @beta @override */
     buildCanonicalReference(): DeclarationReference;
 }
@@ -1419,9 +1419,9 @@ export declare class ApiTypeAlias extends ApiTypeAlias_base {
     static onDeserializeInto(options: Partial<IApiTypeAliasOptions>, context: DeserializerContext, jsonObject: IApiTypeAliasJson): void;
     static getContainerKey(name: string): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @override */
     serializeInto(jsonObject: Partial<IApiTypeAliasJson>): void;
     /** @beta @override */
@@ -1511,9 +1511,9 @@ export declare class ApiVariable extends ApiVariable_base {
     static onDeserializeInto(options: Partial<IApiVariableOptions>, context: DeserializerContext, jsonObject: IApiVariableJson): void;
     static getContainerKey(name: string): string;
     /** @override */
-    readonly kind: ApiItemKind;
+    get kind(): ApiItemKind;
     /** @override */
-    readonly containerKey: string;
+    get containerKey(): string;
     /** @override */
     serializeInto(jsonObject: Partial<IApiVariableJson>): void;
     /** @beta @override */
@@ -1594,11 +1594,11 @@ export declare class Excerpt {
     /**
      * The excerpted text, formed by concatenating the text of the `spannedTokens` strings.
      */
-    readonly text: string;
+    get text(): string;
     /**
      * Returns true if the excerpt is an empty range.
      */
-    readonly isEmpty: boolean;
+    get isEmpty(): boolean;
 }
 
 /**
@@ -1614,16 +1614,16 @@ export declare class ExcerptToken {
     /**
      * Indicates the kind of token.
      */
-    readonly kind: ExcerptTokenKind;
+    get kind(): ExcerptTokenKind;
     /**
      * The text fragment.
      */
-    readonly text: string;
+    get text(): string;
     /**
      * The hyperlink target for a token whose type is `ExcerptTokenKind.Reference`.  For other token types,
      * this property will be `undefined`.
      */
-    readonly canonicalReference: DeclarationReference | undefined;
+    get canonicalReference(): DeclarationReference | undefined;
 }
 
 /** @public */
@@ -2096,7 +2096,7 @@ export declare class Parameter {
     /**
      * Returns the `@param` documentation for this parameter, if present.
      */
-    readonly tsdocParamBlock: tsdoc.DocParamBlock | undefined;
+    get tsdocParamBlock(): tsdoc.DocParamBlock | undefined;
 }
 
 /**
@@ -2237,7 +2237,7 @@ export declare class TypeParameter {
     /**
      * Returns the `@typeParam` documentation for this parameter, if present.
      */
-    readonly tsdocTypeParamBlock: tsdoc.DocParamBlock | undefined;
+    get tsdocTypeParamBlock(): tsdoc.DocParamBlock | undefined;
 }
 
 export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.9.11"
+      "packageVersion": "7.10.0"
     }
   ]
 }

package/lib/aedoc/AedocDefinitions.d.ts

@@ -6,7 +6,7 @@ export declare class AedocDefinitions {
     static readonly betaDocumentation: TSDocTagDefinition;
     static readonly internalRemarks: TSDocTagDefinition;
     static readonly preapprovedTag: TSDocTagDefinition;
-    static readonly tsdocConfiguration: TSDocConfiguration;
+    static get tsdocConfiguration(): TSDocConfiguration;
     private static _tsdocConfiguration;
 }
 //# sourceMappingURL=AedocDefinitions.d.ts.map

package/lib/aedoc/AedocDefinitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AedocDefinitions.d.ts","sourceRoot":"","sources":["../../src/aedoc/AedocDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAoC,MAAM,kBAAkB,CAAC;AAE5G;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAuB,iBAAiB,EAAE,kBAAkB,CAGzD;IAEH,gBAAuB,eAAe,EAAE,kBAAkB,CAGvD;IAEH,gBAAuB,cAAc,EAAE,kBAAkB,CAGtD;oBAEe,kBAAkB,EAAI,kBAAkB;IA2C1D,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAiC;CACpE"}
+{"version":3,"file":"AedocDefinitions.d.ts","sourceRoot":"","sources":["../../src/aedoc/AedocDefinitions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAoC,MAAM,kBAAkB,CAAC;AAE5G;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAuB,iBAAiB,EAAE,kBAAkB,CAGzD;IAEH,gBAAuB,eAAe,EAAE,kBAAkB,CAGvD;IAEH,gBAAuB,cAAc,EAAE,kBAAkB,CAGtD;IAEH,WAAkB,kBAAkB,IAAI,kBAAkB,CAyCzD;IAED,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAiC;CACpE"}

package/lib/aedoc/AedocDefinitions.js

@@ -2,6 +2,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AedocDefinitions = void 0;
 const tsdoc_1 = require("@microsoft/tsdoc");
 /**
  * @internal
@@ -42,6 +43,7 @@ class AedocDefinitions {
         return AedocDefinitions._tsdocConfiguration;
     }
 }
+exports.AedocDefinitions = AedocDefinitions;
 AedocDefinitions.betaDocumentation = new tsdoc_1.TSDocTagDefinition({
     tagName: '@betaDocumentation',
     syntaxKind: tsdoc_1.TSDocTagSyntaxKind.ModifierTag
@@ -54,5 +56,4 @@ AedocDefinitions.preapprovedTag = new tsdoc_1.TSDocTagDefinition({
     tagName: '@preapproved',
     syntaxKind: tsdoc_1.TSDocTagSyntaxKind.ModifierTag
 });
-exports.AedocDefinitions = AedocDefinitions;
 //# sourceMappingURL=AedocDefinitions.js.map

package/lib/aedoc/AedocDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"AedocDefinitions.js","sourceRoot":"","sources":["../../src/aedoc/AedocDefinitions.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,4CAA4G;AAE5G;;GAEG;AACH,MAAa,gBAAgB;IAgBpB,MAAM,KAAK,kBAAkB;QAClC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE;YACzC,MAAM,aAAa,GAAuB,IAAI,0BAAkB,EAAE,CAAC;YACnE,aAAa,CAAC,iBAAiB,CAC7B;gBACE,gBAAgB,CAAC,iBAAiB;gBAClC,gBAAgB,CAAC,eAAe;gBAChC,gBAAgB,CAAC,cAAc;aAChC,EACD,IAAI,CACL,CAAC;YAEF,aAAa,CAAC,iBAAiB,CAC7B;gBACE,oBAAY,CAAC,KAAK;gBAClB,oBAAY,CAAC,IAAI;gBACjB,oBAAY,CAAC,YAAY;gBACzB,oBAAY,CAAC,UAAU;gBACvB,oBAAY,CAAC,aAAa;gBAC1B,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,UAAU;gBACvB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,IAAI;gBACjB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,oBAAoB;gBACjC,oBAAY,CAAC,KAAK;gBAClB,oBAAY,CAAC,cAAc;gBAC3B,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,OAAO;aACrB,EACD,IAAI,CACL,CAAC;YAEF,gBAAgB,CAAC,mBAAmB,GAAG,aAAa,CAAC;SACtD;QACD,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAC9C,CAAC;;AAxDsB,kCAAiB,GAAuB,IAAI,0BAAkB,CAAC;IACpF,OAAO,EAAE,oBAAoB;IAC7B,UAAU,EAAE,0BAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC;AAEoB,gCAAe,GAAuB,IAAI,0BAAkB,CAAC;IAClF,OAAO,EAAE,kBAAkB;IAC3B,UAAU,EAAE,0BAAkB,CAAC,QAAQ;CACxC,CAAC,CAAC;AAEoB,+BAAc,GAAuB,IAAI,0BAAkB,CAAC;IACjF,OAAO,EAAE,cAAc;IACvB,UAAU,EAAE,0BAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC;AAdL,4CA4DC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, StandardTags } from '@microsoft/tsdoc';\r\n\r\n/**\r\n * @internal\r\n */\r\nexport class AedocDefinitions {\r\n  public static readonly betaDocumentation: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@betaDocumentation',\r\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\r\n  });\r\n\r\n  public static readonly internalRemarks: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@internalRemarks',\r\n    syntaxKind: TSDocTagSyntaxKind.BlockTag\r\n  });\r\n\r\n  public static readonly preapprovedTag: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@preapproved',\r\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\r\n  });\r\n\r\n  public static get tsdocConfiguration(): TSDocConfiguration {\r\n    if (!AedocDefinitions._tsdocConfiguration) {\r\n      const configuration: TSDocConfiguration = new TSDocConfiguration();\r\n      configuration.addTagDefinitions(\r\n        [\r\n          AedocDefinitions.betaDocumentation,\r\n          AedocDefinitions.internalRemarks,\r\n          AedocDefinitions.preapprovedTag\r\n        ],\r\n        true\r\n      );\r\n\r\n      configuration.setSupportForTags(\r\n        [\r\n          StandardTags.alpha,\r\n          StandardTags.beta,\r\n          StandardTags.defaultValue,\r\n          StandardTags.deprecated,\r\n          StandardTags.eventProperty,\r\n          StandardTags.example,\r\n          StandardTags.inheritDoc,\r\n          StandardTags.internal,\r\n          StandardTags.link,\r\n          StandardTags.override,\r\n          StandardTags.packageDocumentation,\r\n          StandardTags.param,\r\n          StandardTags.privateRemarks,\r\n          StandardTags.public,\r\n          StandardTags.readonly,\r\n          StandardTags.remarks,\r\n          StandardTags.returns,\r\n          StandardTags.sealed,\r\n          StandardTags.throws,\r\n          StandardTags.virtual\r\n        ],\r\n        true\r\n      );\r\n\r\n      AedocDefinitions._tsdocConfiguration = configuration;\r\n    }\r\n    return AedocDefinitions._tsdocConfiguration;\r\n  }\r\n\r\n  private static _tsdocConfiguration: TSDocConfiguration | undefined;\r\n}\r\n"]}
+{"version":3,"file":"AedocDefinitions.js","sourceRoot":"","sources":["../../src/aedoc/AedocDefinitions.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,4CAA4G;AAE5G;;GAEG;AACH,MAAa,gBAAgB;IAgBpB,MAAM,KAAK,kBAAkB;QAClC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE;YACzC,MAAM,aAAa,GAAuB,IAAI,0BAAkB,EAAE,CAAC;YACnE,aAAa,CAAC,iBAAiB,CAC7B;gBACE,gBAAgB,CAAC,iBAAiB;gBAClC,gBAAgB,CAAC,eAAe;gBAChC,gBAAgB,CAAC,cAAc;aAChC,EACD,IAAI,CACL,CAAC;YAEF,aAAa,CAAC,iBAAiB,CAC7B;gBACE,oBAAY,CAAC,KAAK;gBAClB,oBAAY,CAAC,IAAI;gBACjB,oBAAY,CAAC,YAAY;gBACzB,oBAAY,CAAC,UAAU;gBACvB,oBAAY,CAAC,aAAa;gBAC1B,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,UAAU;gBACvB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,IAAI;gBACjB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,oBAAoB;gBACjC,oBAAY,CAAC,KAAK;gBAClB,oBAAY,CAAC,cAAc;gBAC3B,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,QAAQ;gBACrB,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,OAAO;gBACpB,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,MAAM;gBACnB,oBAAY,CAAC,OAAO;aACrB,EACD,IAAI,CACL,CAAC;YAEF,gBAAgB,CAAC,mBAAmB,GAAG,aAAa,CAAC;SACtD;QACD,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAC9C,CAAC;;AAzDH,4CA4DC;AA3DwB,kCAAiB,GAAuB,IAAI,0BAAkB,CAAC;IACpF,OAAO,EAAE,oBAAoB;IAC7B,UAAU,EAAE,0BAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC;AAEoB,gCAAe,GAAuB,IAAI,0BAAkB,CAAC;IAClF,OAAO,EAAE,kBAAkB;IAC3B,UAAU,EAAE,0BAAkB,CAAC,QAAQ;CACxC,CAAC,CAAC;AAEoB,+BAAc,GAAuB,IAAI,0BAAkB,CAAC;IACjF,OAAO,EAAE,cAAc;IACvB,UAAU,EAAE,0BAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, StandardTags } from '@microsoft/tsdoc';\r\n\r\n/**\r\n * @internal\r\n */\r\nexport class AedocDefinitions {\r\n  public static readonly betaDocumentation: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@betaDocumentation',\r\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\r\n  });\r\n\r\n  public static readonly internalRemarks: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@internalRemarks',\r\n    syntaxKind: TSDocTagSyntaxKind.BlockTag\r\n  });\r\n\r\n  public static readonly preapprovedTag: TSDocTagDefinition = new TSDocTagDefinition({\r\n    tagName: '@preapproved',\r\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\r\n  });\r\n\r\n  public static get tsdocConfiguration(): TSDocConfiguration {\r\n    if (!AedocDefinitions._tsdocConfiguration) {\r\n      const configuration: TSDocConfiguration = new TSDocConfiguration();\r\n      configuration.addTagDefinitions(\r\n        [\r\n          AedocDefinitions.betaDocumentation,\r\n          AedocDefinitions.internalRemarks,\r\n          AedocDefinitions.preapprovedTag\r\n        ],\r\n        true\r\n      );\r\n\r\n      configuration.setSupportForTags(\r\n        [\r\n          StandardTags.alpha,\r\n          StandardTags.beta,\r\n          StandardTags.defaultValue,\r\n          StandardTags.deprecated,\r\n          StandardTags.eventProperty,\r\n          StandardTags.example,\r\n          StandardTags.inheritDoc,\r\n          StandardTags.internal,\r\n          StandardTags.link,\r\n          StandardTags.override,\r\n          StandardTags.packageDocumentation,\r\n          StandardTags.param,\r\n          StandardTags.privateRemarks,\r\n          StandardTags.public,\r\n          StandardTags.readonly,\r\n          StandardTags.remarks,\r\n          StandardTags.returns,\r\n          StandardTags.sealed,\r\n          StandardTags.throws,\r\n          StandardTags.virtual\r\n        ],\r\n        true\r\n      );\r\n\r\n      AedocDefinitions._tsdocConfiguration = configuration;\r\n    }\r\n    return AedocDefinitions._tsdocConfiguration;\r\n  }\r\n\r\n  private static _tsdocConfiguration: TSDocConfiguration | undefined;\r\n}\r\n"]}

package/lib/aedoc/ReleaseTag.js

@@ -2,6 +2,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleaseTag = void 0;
 /**
  * A "release tag" is a custom TSDoc tag that is applied to an API to communicate the level of support
  * provided for third-party developers.

package/lib/aedoc/ReleaseTag.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReleaseTag.js","sourceRoot":"","sources":["../../src/aedoc/ReleaseTag.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D;;;;;;;;;;;;;GAaG;AACH,IAAY,UA2BX;AA3BD,WAAY,UAAU;IACpB;;OAEG;IACH,2CAAQ,CAAA;IACR;;;;OAIG;IACH,mDAAY,CAAA;IACZ;;;OAGG;IACH,6CAAS,CAAA;IACT;;;;OAIG;IACH,2CAAQ,CAAA;IACR;;;OAGG;IACH,+CAAU,CAAA;AACZ,CAAC,EA3BW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QA2BrB;AAED;;;GAGG;AACH,WAAiB,UAAU;IACzB;;;;;OAKG;IACH,SAAgB,UAAU,CAAC,UAAsB;QAC/C,QAAQ,UAAU,EAAE;YAClB,KAAK,UAAU,CAAC,IAAI;gBAClB,OAAO,QAAQ,CAAC;YAClB,KAAK,UAAU,CAAC,QAAQ;gBACtB,OAAO,WAAW,CAAC;YACrB,KAAK,UAAU,CAAC,KAAK;gBACnB,OAAO,QAAQ,CAAC;YAClB,KAAK,UAAU,CAAC,IAAI;gBAClB,OAAO,OAAO,CAAC;YACjB,KAAK,UAAU,CAAC,MAAM;gBACpB,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAde,qBAAU,aAczB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;QAClD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,kBAAO,UAEtB,CAAA;AACH,CAAC,EAlCgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAkC1B","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\n/**\r\n * A \"release tag\" is a custom TSDoc tag that is applied to an API to communicate the level of support\r\n * provided for third-party developers.\r\n *\r\n * @remarks\r\n *\r\n * The four release tags are: `@internal`, `@alpha`, `@beta`, and `@public`. They are applied to API items such\r\n * as classes, member functions, enums, etc.  The release tag applies recursively to members of a container\r\n * (e.g. class or interface). For example, if a class is marked as `@beta`, then all of its members automatically\r\n * have this status; you DON'T need add the `@beta` tag to each member function. However, you could add\r\n * `@internal` to a member function to give it a different release status.\r\n *\r\n * @public\r\n */\r\nexport enum ReleaseTag {\r\n  /**\r\n   * No release tag was specified in the AEDoc summary.\r\n   */\r\n  None = 0,\r\n  /**\r\n   * Indicates that an API item is meant only for usage by other NPM packages from the same\r\n   * maintainer. Third parties should never use \"internal\" APIs. (To emphasize this, their\r\n   * names are prefixed by underscores.)\r\n   */\r\n  Internal = 1,\r\n  /**\r\n   * Indicates that an API item is eventually intended to be public, but currently is in an\r\n   * early stage of development. Third parties should not use \"alpha\" APIs.\r\n   */\r\n  Alpha = 2,\r\n  /**\r\n   * Indicates that an API item has been released in an experimental state. Third parties are\r\n   * encouraged to try it and provide feedback. However, a \"beta\" API should NOT be used\r\n   * in production.\r\n   */\r\n  Beta = 3,\r\n  /**\r\n   * Indicates that an API item has been officially released. It is part of the supported\r\n   * contract (e.g. SemVer) for a package.\r\n   */\r\n  Public = 4\r\n}\r\n\r\n/**\r\n * Helper functions for working with the `ReleaseTag` enum.\r\n * @public\r\n */\r\nexport namespace ReleaseTag {\r\n  /**\r\n   * Returns the TSDoc tag name for a `ReleaseTag` value.\r\n   *\r\n   * @remarks\r\n   * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.\r\n   */\r\n  export function getTagName(releaseTag: ReleaseTag): string {\r\n    switch (releaseTag) {\r\n      case ReleaseTag.None:\r\n        return '(none)';\r\n      case ReleaseTag.Internal:\r\n        return '@internal';\r\n      case ReleaseTag.Alpha:\r\n        return '@alpha';\r\n      case ReleaseTag.Beta:\r\n        return '@beta';\r\n      case ReleaseTag.Public:\r\n        return '@public';\r\n    }\r\n    throw new Error('Unsupported release tag');\r\n  }\r\n\r\n  /**\r\n   * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.\r\n   * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,\r\n   * and a negative number if `a` is less public than `b`.\r\n   * @remarks\r\n   * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive\r\n   * number because beta is more public than alpha.\r\n   */\r\n  export function compare(a: ReleaseTag, b: ReleaseTag): number {\r\n    return a - b;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ReleaseTag.js","sourceRoot":"","sources":["../../src/aedoc/ReleaseTag.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;;;;;;;;;GAaG;AACH,IAAY,UA2BX;AA3BD,WAAY,UAAU;IACpB;;OAEG;IACH,2CAAQ,CAAA;IACR;;;;OAIG;IACH,mDAAY,CAAA;IACZ;;;OAGG;IACH,6CAAS,CAAA;IACT;;;;OAIG;IACH,2CAAQ,CAAA;IACR;;;OAGG;IACH,+CAAU,CAAA;AACZ,CAAC,EA3BW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QA2BrB;AAED;;;GAGG;AACH,WAAiB,UAAU;IACzB;;;;;OAKG;IACH,SAAgB,UAAU,CAAC,UAAsB;QAC/C,QAAQ,UAAU,EAAE;YAClB,KAAK,UAAU,CAAC,IAAI;gBAClB,OAAO,QAAQ,CAAC;YAClB,KAAK,UAAU,CAAC,QAAQ;gBACtB,OAAO,WAAW,CAAC;YACrB,KAAK,UAAU,CAAC,KAAK;gBACnB,OAAO,QAAQ,CAAC;YAClB,KAAK,UAAU,CAAC,IAAI;gBAClB,OAAO,OAAO,CAAC;YACjB,KAAK,UAAU,CAAC,MAAM;gBACpB,OAAO,SAAS,CAAC;SACpB;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAde,qBAAU,aAczB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;QAClD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,kBAAO,UAEtB,CAAA;AACH,CAAC,EAlCgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAkC1B","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\n/**\r\n * A \"release tag\" is a custom TSDoc tag that is applied to an API to communicate the level of support\r\n * provided for third-party developers.\r\n *\r\n * @remarks\r\n *\r\n * The four release tags are: `@internal`, `@alpha`, `@beta`, and `@public`. They are applied to API items such\r\n * as classes, member functions, enums, etc.  The release tag applies recursively to members of a container\r\n * (e.g. class or interface). For example, if a class is marked as `@beta`, then all of its members automatically\r\n * have this status; you DON'T need add the `@beta` tag to each member function. However, you could add\r\n * `@internal` to a member function to give it a different release status.\r\n *\r\n * @public\r\n */\r\nexport enum ReleaseTag {\r\n  /**\r\n   * No release tag was specified in the AEDoc summary.\r\n   */\r\n  None = 0,\r\n  /**\r\n   * Indicates that an API item is meant only for usage by other NPM packages from the same\r\n   * maintainer. Third parties should never use \"internal\" APIs. (To emphasize this, their\r\n   * names are prefixed by underscores.)\r\n   */\r\n  Internal = 1,\r\n  /**\r\n   * Indicates that an API item is eventually intended to be public, but currently is in an\r\n   * early stage of development. Third parties should not use \"alpha\" APIs.\r\n   */\r\n  Alpha = 2,\r\n  /**\r\n   * Indicates that an API item has been released in an experimental state. Third parties are\r\n   * encouraged to try it and provide feedback. However, a \"beta\" API should NOT be used\r\n   * in production.\r\n   */\r\n  Beta = 3,\r\n  /**\r\n   * Indicates that an API item has been officially released. It is part of the supported\r\n   * contract (e.g. SemVer) for a package.\r\n   */\r\n  Public = 4\r\n}\r\n\r\n/**\r\n * Helper functions for working with the `ReleaseTag` enum.\r\n * @public\r\n */\r\nexport namespace ReleaseTag {\r\n  /**\r\n   * Returns the TSDoc tag name for a `ReleaseTag` value.\r\n   *\r\n   * @remarks\r\n   * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.\r\n   */\r\n  export function getTagName(releaseTag: ReleaseTag): string {\r\n    switch (releaseTag) {\r\n      case ReleaseTag.None:\r\n        return '(none)';\r\n      case ReleaseTag.Internal:\r\n        return '@internal';\r\n      case ReleaseTag.Alpha:\r\n        return '@alpha';\r\n      case ReleaseTag.Beta:\r\n        return '@beta';\r\n      case ReleaseTag.Public:\r\n        return '@public';\r\n    }\r\n    throw new Error('Unsupported release tag');\r\n  }\r\n\r\n  /**\r\n   * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.\r\n   * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,\r\n   * and a negative number if `a` is less public than `b`.\r\n   * @remarks\r\n   * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive\r\n   * number because beta is more public than alpha.\r\n   */\r\n  export function compare(a: ReleaseTag, b: ReleaseTag): number {\r\n    return a - b;\r\n  }\r\n}\r\n"]}