@microsoft/api-extractor-model 7.32.2 → 7.33.1

package/CHANGELOG.json

@@ -1,6 +1,40 @@
 {
   "name": "@microsoft/api-extractor-model",
   "entries": [
+    {
+      "version": "7.33.1",
+      "tag": "@microsoft/api-extractor-model_v7.33.1",
+      "date": "Fri, 20 Feb 2026 00:15:03 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Add `\"node\"` condition before `\"import\"` in the `\"exports\"` map so that Node.js uses the CJS output (which handles extensionless imports), while bundlers still use ESM via `\"import\"`. Fixes https://github.com/microsoft/rushstack/issues/5644."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `5.20.1`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.33.0",
+      "tag": "@microsoft/api-extractor-model_v7.33.0",
+      "date": "Thu, 19 Feb 2026 00:04:52 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Normalize package layout. CommonJS is now under `lib-commonjs`, DTS is now under `lib-dts`, and ESM is now under `lib-esm`. Imports to `lib` still work as before, handled by the `\"exports\"` field in `package.json`."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `5.20.0`"
+          }
+        ]
+      }
+    },
     {
       "version": "7.32.2",
       "tag": "@microsoft/api-extractor-model_v7.32.2",

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log - @microsoft/api-extractor-model
 
-This log was last generated on Sat, 06 Dec 2025 01:12:29 GMT and should not be manually modified.
+This log was last generated on Fri, 20 Feb 2026 00:15:03 GMT and should not be manually modified.
+
+## 7.33.1
+Fri, 20 Feb 2026 00:15:03 GMT
+
+### Patches
+
+- Add `"node"` condition before `"import"` in the `"exports"` map so that Node.js uses the CJS output (which handles extensionless imports), while bundlers still use ESM via `"import"`. Fixes https://github.com/microsoft/rushstack/issues/5644.
+
+## 7.33.0
+Thu, 19 Feb 2026 00:04:52 GMT
+
+### Minor changes
+
+- Normalize package layout. CommonJS is now under `lib-commonjs`, DTS is now under `lib-dts`, and ESM is now under `lib-esm`. Imports to `lib` still work as before, handled by the `"exports"` field in `package.json`.
 
 ## 7.32.2
 Sat, 06 Dec 2025 01:12:29 GMT

package/dist/tsdoc-metadata.json

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

package/lib-esm/aedoc/AedocDefinitions.js

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, StandardTags } from '@microsoft/tsdoc';
+/**
+ * @internal
+ * @deprecated - tsdoc configuration is now constructed from tsdoc.json files associated with each package.
+ */
+export class AedocDefinitions {
+    static get tsdocConfiguration() {
+        if (!AedocDefinitions._tsdocConfiguration) {
+            const configuration = new TSDocConfiguration();
+            configuration.addTagDefinitions([
+                AedocDefinitions.betaDocumentation,
+                AedocDefinitions.internalRemarks,
+                AedocDefinitions.preapprovedTag
+            ], true);
+            configuration.setSupportForTags([
+                StandardTags.alpha,
+                StandardTags.beta,
+                StandardTags.decorator,
+                StandardTags.defaultValue,
+                StandardTags.deprecated,
+                StandardTags.eventProperty,
+                StandardTags.example,
+                StandardTags.inheritDoc,
+                StandardTags.internal,
+                StandardTags.link,
+                StandardTags.override,
+                StandardTags.packageDocumentation,
+                StandardTags.param,
+                StandardTags.privateRemarks,
+                StandardTags.public,
+                StandardTags.readonly,
+                StandardTags.remarks,
+                StandardTags.returns,
+                StandardTags.sealed,
+                StandardTags.throws,
+                StandardTags.virtual
+            ], true);
+            AedocDefinitions._tsdocConfiguration = configuration;
+        }
+        return AedocDefinitions._tsdocConfiguration;
+    }
+}
+AedocDefinitions.betaDocumentation = new TSDocTagDefinition({
+    tagName: '@betaDocumentation',
+    syntaxKind: TSDocTagSyntaxKind.ModifierTag
+});
+AedocDefinitions.internalRemarks = new TSDocTagDefinition({
+    tagName: '@internalRemarks',
+    syntaxKind: TSDocTagSyntaxKind.BlockTag
+});
+AedocDefinitions.preapprovedTag = new TSDocTagDefinition({
+    tagName: '@preapproved',
+    syntaxKind: TSDocTagSyntaxKind.ModifierTag
+});
+//# sourceMappingURL=AedocDefinitions.js.map

package/lib-esm/aedoc/AedocDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AedocDefinitions.js","sourceRoot":"","sources":["../../src/aedoc/AedocDefinitions.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAE5G;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAgBpB,MAAM,KAAK,kBAAkB;QAClC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;YAC1C,MAAM,aAAa,GAAuB,IAAI,kBAAkB,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,YAAY,CAAC,KAAK;gBAClB,YAAY,CAAC,IAAI;gBACjB,YAAY,CAAC,SAAS;gBACtB,YAAY,CAAC,YAAY;gBACzB,YAAY,CAAC,UAAU;gBACvB,YAAY,CAAC,aAAa;gBAC1B,YAAY,CAAC,OAAO;gBACpB,YAAY,CAAC,UAAU;gBACvB,YAAY,CAAC,QAAQ;gBACrB,YAAY,CAAC,IAAI;gBACjB,YAAY,CAAC,QAAQ;gBACrB,YAAY,CAAC,oBAAoB;gBACjC,YAAY,CAAC,KAAK;gBAClB,YAAY,CAAC,cAAc;gBAC3B,YAAY,CAAC,MAAM;gBACnB,YAAY,CAAC,QAAQ;gBACrB,YAAY,CAAC,OAAO;gBACpB,YAAY,CAAC,OAAO;gBACpB,YAAY,CAAC,MAAM;gBACnB,YAAY,CAAC,MAAM;gBACnB,YAAY,CAAC,OAAO;aACrB,EACD,IAAI,CACL,CAAC;YAEF,gBAAgB,CAAC,mBAAmB,GAAG,aAAa,CAAC;QACvD,CAAC;QACD,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAC9C,CAAC;;AAzDsB,kCAAiB,GAAuB,IAAI,kBAAkB,CAAC;IACpF,OAAO,EAAE,oBAAoB;IAC7B,UAAU,EAAE,kBAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC;AAEoB,gCAAe,GAAuB,IAAI,kBAAkB,CAAC;IAClF,OAAO,EAAE,kBAAkB;IAC3B,UAAU,EAAE,kBAAkB,CAAC,QAAQ;CACxC,CAAC,CAAC;AAEoB,+BAAc,GAAuB,IAAI,kBAAkB,CAAC;IACjF,OAAO,EAAE,cAAc;IACvB,UAAU,EAAE,kBAAkB,CAAC,WAAW;CAC3C,CAAC,CAAC","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 { TSDocConfiguration, TSDocTagDefinition, TSDocTagSyntaxKind, StandardTags } from '@microsoft/tsdoc';\n\n/**\n * @internal\n * @deprecated - tsdoc configuration is now constructed from tsdoc.json files associated with each package.\n */\nexport class AedocDefinitions {\n  public static readonly betaDocumentation: TSDocTagDefinition = new TSDocTagDefinition({\n    tagName: '@betaDocumentation',\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\n  });\n\n  public static readonly internalRemarks: TSDocTagDefinition = new TSDocTagDefinition({\n    tagName: '@internalRemarks',\n    syntaxKind: TSDocTagSyntaxKind.BlockTag\n  });\n\n  public static readonly preapprovedTag: TSDocTagDefinition = new TSDocTagDefinition({\n    tagName: '@preapproved',\n    syntaxKind: TSDocTagSyntaxKind.ModifierTag\n  });\n\n  public static get tsdocConfiguration(): TSDocConfiguration {\n    if (!AedocDefinitions._tsdocConfiguration) {\n      const configuration: TSDocConfiguration = new TSDocConfiguration();\n      configuration.addTagDefinitions(\n        [\n          AedocDefinitions.betaDocumentation,\n          AedocDefinitions.internalRemarks,\n          AedocDefinitions.preapprovedTag\n        ],\n        true\n      );\n\n      configuration.setSupportForTags(\n        [\n          StandardTags.alpha,\n          StandardTags.beta,\n          StandardTags.decorator,\n          StandardTags.defaultValue,\n          StandardTags.deprecated,\n          StandardTags.eventProperty,\n          StandardTags.example,\n          StandardTags.inheritDoc,\n          StandardTags.internal,\n          StandardTags.link,\n          StandardTags.override,\n          StandardTags.packageDocumentation,\n          StandardTags.param,\n          StandardTags.privateRemarks,\n          StandardTags.public,\n          StandardTags.readonly,\n          StandardTags.remarks,\n          StandardTags.returns,\n          StandardTags.sealed,\n          StandardTags.throws,\n          StandardTags.virtual\n        ],\n        true\n      );\n\n      AedocDefinitions._tsdocConfiguration = configuration;\n    }\n    return AedocDefinitions._tsdocConfiguration;\n  }\n\n  private static _tsdocConfiguration: TSDocConfiguration | undefined;\n}\n"]}

package/lib-esm/aedoc/ReleaseTag.js

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * 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.
+ *
+ * @remarks
+ *
+ * The four release tags are: `@internal`, `@alpha`, `@beta`, and `@public`. They are applied to API items such
+ * as classes, member functions, enums, etc.  The release tag applies recursively to members of a container
+ * (e.g. class or interface). For example, if a class is marked as `@beta`, then all of its members automatically
+ * have this status; you DON'T need add the `@beta` tag to each member function. However, you could add
+ * `@internal` to a member function to give it a different release status.
+ *
+ * @public
+ */
+export var ReleaseTag;
+(function (ReleaseTag) {
+    /**
+     * No release tag was specified in the AEDoc summary.
+     */
+    ReleaseTag[ReleaseTag["None"] = 0] = "None";
+    /**
+     * Indicates that an API item is meant only for usage by other NPM packages from the same
+     * maintainer. Third parties should never use "internal" APIs. (To emphasize this, their
+     * names are prefixed by underscores.)
+     */
+    ReleaseTag[ReleaseTag["Internal"] = 1] = "Internal";
+    /**
+     * Indicates that an API item is eventually intended to be public, but currently is in an
+     * early stage of development. Third parties should not use "alpha" APIs.
+     */
+    ReleaseTag[ReleaseTag["Alpha"] = 2] = "Alpha";
+    /**
+     * Indicates that an API item has been released in an experimental state. Third parties are
+     * encouraged to try it and provide feedback. However, a "beta" API should NOT be used
+     * in production.
+     */
+    ReleaseTag[ReleaseTag["Beta"] = 3] = "Beta";
+    /**
+     * Indicates that an API item has been officially released. It is part of the supported
+     * contract (e.g. SemVer) for a package.
+     */
+    ReleaseTag[ReleaseTag["Public"] = 4] = "Public";
+})(ReleaseTag || (ReleaseTag = {}));
+/**
+ * Helper functions for working with the `ReleaseTag` enum.
+ * @public
+ */
+(function (ReleaseTag) {
+    /**
+     * Returns the TSDoc tag name for a `ReleaseTag` value.
+     *
+     * @remarks
+     * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.
+     */
+    function getTagName(releaseTag) {
+        switch (releaseTag) {
+            case ReleaseTag.None:
+                return '(none)';
+            case ReleaseTag.Internal:
+                return '@internal';
+            case ReleaseTag.Alpha:
+                return '@alpha';
+            case ReleaseTag.Beta:
+                return '@beta';
+            case ReleaseTag.Public:
+                return '@public';
+            default:
+                throw new Error('Unsupported release tag');
+        }
+    }
+    ReleaseTag.getTagName = getTagName;
+    /**
+     * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.
+     * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,
+     * and a negative number if `a` is less public than `b`.
+     * @remarks
+     * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive
+     * number because beta is more public than alpha.
+     */
+    function compare(a, b) {
+        return a - b;
+    }
+    ReleaseTag.compare = compare;
+})(ReleaseTag || (ReleaseTag = {}));
+//# sourceMappingURL=ReleaseTag.js.map

package/lib-esm/aedoc/ReleaseTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReleaseTag.js","sourceRoot":"","sources":["../../src/aedoc/ReleaseTag.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAN,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,KAAV,UAAU,QA2BrB;AAED;;;GAGG;AACH,WAAiB,UAAU;IACzB;;;;;OAKG;IACH,SAAgB,UAAU,CAAC,UAAsB;QAC/C,QAAQ,UAAU,EAAE,CAAC;YACnB,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;YACnB;gBACE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAfe,qBAAU,aAezB,CAAA;IAED;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;QAClD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,kBAAO,UAEtB,CAAA;AACH,CAAC,EAnCgB,UAAU,KAAV,UAAU,QAmC1B","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 * A \"release tag\" is a custom TSDoc tag that is applied to an API to communicate the level of support\n * provided for third-party developers.\n *\n * @remarks\n *\n * The four release tags are: `@internal`, `@alpha`, `@beta`, and `@public`. They are applied to API items such\n * as classes, member functions, enums, etc.  The release tag applies recursively to members of a container\n * (e.g. class or interface). For example, if a class is marked as `@beta`, then all of its members automatically\n * have this status; you DON'T need add the `@beta` tag to each member function. However, you could add\n * `@internal` to a member function to give it a different release status.\n *\n * @public\n */\nexport enum ReleaseTag {\n  /**\n   * No release tag was specified in the AEDoc summary.\n   */\n  None = 0,\n  /**\n   * Indicates that an API item is meant only for usage by other NPM packages from the same\n   * maintainer. Third parties should never use \"internal\" APIs. (To emphasize this, their\n   * names are prefixed by underscores.)\n   */\n  Internal = 1,\n  /**\n   * Indicates that an API item is eventually intended to be public, but currently is in an\n   * early stage of development. Third parties should not use \"alpha\" APIs.\n   */\n  Alpha = 2,\n  /**\n   * Indicates that an API item has been released in an experimental state. Third parties are\n   * encouraged to try it and provide feedback. However, a \"beta\" API should NOT be used\n   * in production.\n   */\n  Beta = 3,\n  /**\n   * Indicates that an API item has been officially released. It is part of the supported\n   * contract (e.g. SemVer) for a package.\n   */\n  Public = 4\n}\n\n/**\n * Helper functions for working with the `ReleaseTag` enum.\n * @public\n */\nexport namespace ReleaseTag {\n  /**\n   * Returns the TSDoc tag name for a `ReleaseTag` value.\n   *\n   * @remarks\n   * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.\n   */\n  export function getTagName(releaseTag: ReleaseTag): string {\n    switch (releaseTag) {\n      case ReleaseTag.None:\n        return '(none)';\n      case ReleaseTag.Internal:\n        return '@internal';\n      case ReleaseTag.Alpha:\n        return '@alpha';\n      case ReleaseTag.Beta:\n        return '@beta';\n      case ReleaseTag.Public:\n        return '@public';\n      default:\n        throw new Error('Unsupported release tag');\n    }\n  }\n\n  /**\n   * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.\n   * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,\n   * and a negative number if `a` is less public than `b`.\n   * @remarks\n   * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive\n   * number because beta is more public than alpha.\n   */\n  export function compare(a: ReleaseTag, b: ReleaseTag): number {\n    return a - b;\n  }\n}\n"]}

package/lib-esm/index.js

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+/**
+ * Use this library to read and write *.api.json files as defined by the
+ * {@link https://api-extractor.com/ | API Extractor}  tool.  These files are used to generate a documentation
+ * website for your TypeScript package.  The files store the API signatures and doc comments that were extracted
+ * from your package.
+ *
+ * @packageDocumentation
+ */
+export { AedocDefinitions } from './aedoc/AedocDefinitions';
+export { ReleaseTag } from './aedoc/ReleaseTag';
+// items
+export { ApiDeclaredItem } from './items/ApiDeclaredItem';
+export { ApiDocumentedItem } from './items/ApiDocumentedItem';
+export { ApiItemKind, ApiItem } from './items/ApiItem';
+export { ApiPropertyItem } from './items/ApiPropertyItem';
+// mixins
+export { ApiParameterListMixin } from './mixins/ApiParameterListMixin';
+export { ApiTypeParameterListMixin } from './mixins/ApiTypeParameterListMixin';
+export { ApiAbstractMixin } from './mixins/ApiAbstractMixin';
+export { ApiItemContainerMixin } from './mixins/ApiItemContainerMixin';
+export { ApiProtectedMixin } from './mixins/ApiProtectedMixin';
+export { ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin';
+export { ApiReturnTypeMixin } from './mixins/ApiReturnTypeMixin';
+export { ApiStaticMixin } from './mixins/ApiStaticMixin';
+export { ApiNameMixin } from './mixins/ApiNameMixin';
+export { ApiOptionalMixin } from './mixins/ApiOptionalMixin';
+export { ApiReadonlyMixin } from './mixins/ApiReadonlyMixin';
+export { ApiInitializerMixin } from './mixins/ApiInitializerMixin';
+export { ApiExportedMixin } from './mixins/ApiExportedMixin';
+export { FindApiItemsMessageId } from './mixins/IFindApiItemsResult';
+export { ExcerptTokenKind, ExcerptToken, Excerpt } from './mixins/Excerpt';
+// model
+export { ApiCallSignature } from './model/ApiCallSignature';
+export { ApiClass } from './model/ApiClass';
+export { ApiConstructor } from './model/ApiConstructor';
+export { ApiConstructSignature } from './model/ApiConstructSignature';
+export { ApiEntryPoint } from './model/ApiEntryPoint';
+export { ApiEnum } from './model/ApiEnum';
+export { ApiEnumMember, EnumMemberOrder } from './model/ApiEnumMember';
+export { ApiFunction } from './model/ApiFunction';
+export { ApiIndexSignature } from './model/ApiIndexSignature';
+export { ApiInterface } from './model/ApiInterface';
+export { ApiMethod } from './model/ApiMethod';
+export { ApiMethodSignature } from './model/ApiMethodSignature';
+export { ApiModel } from './model/ApiModel';
+export { ApiNamespace } from './model/ApiNamespace';
+export { ApiPackage } from './model/ApiPackage';
+export { Parameter } from './model/Parameter';
+export { ApiProperty } from './model/ApiProperty';
+export { ApiPropertySignature } from './model/ApiPropertySignature';
+export { ApiTypeAlias } from './model/ApiTypeAlias';
+export { TypeParameter } from './model/TypeParameter';
+export { ApiVariable } from './model/ApiVariable';
+export { HeritageType } from './model/HeritageType';
+export { SourceLocation } from './model/SourceLocation';
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D;;;;;;;GAOG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,QAAQ;AACR,OAAO,EAAgC,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACxF,OAAO,EAAkC,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAwB,OAAO,EAA4B,MAAM,iBAAiB,CAAC;AACvG,OAAO,EAAgC,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAExF,SAAS;AACT,OAAO,EAGL,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAGL,yBAAyB,EAC1B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAiC,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAsC,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC3G,OAAO,EAAkC,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/F,OAAO,EAAmC,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAClG,OAAO,EAAmC,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAClG,OAAO,EAA+B,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAA6B,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAiC,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAiC,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAoC,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAiC,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAGL,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACL,gBAAgB,EAGhB,YAAY,EACZ,OAAO,EACR,MAAM,kBAAkB,CAAC;AAG1B,QAAQ;AACR,OAAO,EAAiC,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC3F,OAAO,EAAyB,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAA+B,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,EAAsC,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAC1G,OAAO,EAA8B,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAwB,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAA8B,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAA4B,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAkC,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9F,OAAO,EAA6B,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAA0B,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAmC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAA6B,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAA2B,UAAU,EAA+B,MAAM,oBAAoB,CAAC;AACtG,OAAO,EAA0B,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAA4B,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAqC,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACvG,OAAO,EAA6B,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAA8B,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAA4B,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAA+B,cAAc,EAAE,MAAM,wBAAwB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Use this library to read and write *.api.json files as defined by the\n * {@link https://api-extractor.com/ | API Extractor}  tool.  These files are used to generate a documentation\n * website for your TypeScript package.  The files store the API signatures and doc comments that were extracted\n * from your package.\n *\n * @packageDocumentation\n */\n\nexport { AedocDefinitions } from './aedoc/AedocDefinitions';\nexport { ReleaseTag } from './aedoc/ReleaseTag';\n\n// items\nexport { type IApiDeclaredItemOptions, ApiDeclaredItem } from './items/ApiDeclaredItem';\nexport { type IApiDocumentedItemOptions, ApiDocumentedItem } from './items/ApiDocumentedItem';\nexport { ApiItemKind, type IApiItemOptions, ApiItem, type IApiItemConstructor } from './items/ApiItem';\nexport { type IApiPropertyItemOptions, ApiPropertyItem } from './items/ApiPropertyItem';\n\n// mixins\nexport {\n  type IApiParameterListMixinOptions,\n  type IApiParameterOptions,\n  ApiParameterListMixin\n} from './mixins/ApiParameterListMixin';\nexport {\n  type IApiTypeParameterOptions,\n  type IApiTypeParameterListMixinOptions,\n  ApiTypeParameterListMixin\n} from './mixins/ApiTypeParameterListMixin';\nexport { type IApiAbstractMixinOptions, ApiAbstractMixin } from './mixins/ApiAbstractMixin';\nexport { type IApiItemContainerMixinOptions, ApiItemContainerMixin } from './mixins/ApiItemContainerMixin';\nexport { type IApiProtectedMixinOptions, ApiProtectedMixin } from './mixins/ApiProtectedMixin';\nexport { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin';\nexport { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from './mixins/ApiReturnTypeMixin';\nexport { type IApiStaticMixinOptions, ApiStaticMixin } from './mixins/ApiStaticMixin';\nexport { type IApiNameMixinOptions, ApiNameMixin } from './mixins/ApiNameMixin';\nexport { type IApiOptionalMixinOptions, ApiOptionalMixin } from './mixins/ApiOptionalMixin';\nexport { type IApiReadonlyMixinOptions, ApiReadonlyMixin } from './mixins/ApiReadonlyMixin';\nexport { type IApiInitializerMixinOptions, ApiInitializerMixin } from './mixins/ApiInitializerMixin';\nexport { type IApiExportedMixinOptions, ApiExportedMixin } from './mixins/ApiExportedMixin';\nexport {\n  type IFindApiItemsResult,\n  type IFindApiItemsMessage,\n  FindApiItemsMessageId\n} from './mixins/IFindApiItemsResult';\n\nexport {\n  ExcerptTokenKind,\n  type IExcerptTokenRange,\n  type IExcerptToken,\n  ExcerptToken,\n  Excerpt\n} from './mixins/Excerpt';\nexport type { Constructor, PropertiesOf } from './mixins/Mixin';\n\n// model\nexport { type IApiCallSignatureOptions, ApiCallSignature } from './model/ApiCallSignature';\nexport { type IApiClassOptions, ApiClass } from './model/ApiClass';\nexport { type IApiConstructorOptions, ApiConstructor } from './model/ApiConstructor';\nexport { type IApiConstructSignatureOptions, ApiConstructSignature } from './model/ApiConstructSignature';\nexport { type IApiEntryPointOptions, ApiEntryPoint } from './model/ApiEntryPoint';\nexport { type IApiEnumOptions, ApiEnum } from './model/ApiEnum';\nexport { type IApiEnumMemberOptions, ApiEnumMember, EnumMemberOrder } from './model/ApiEnumMember';\nexport { type IApiFunctionOptions, ApiFunction } from './model/ApiFunction';\nexport { type IApiIndexSignatureOptions, ApiIndexSignature } from './model/ApiIndexSignature';\nexport { type IApiInterfaceOptions, ApiInterface } from './model/ApiInterface';\nexport { type IApiMethodOptions, ApiMethod } from './model/ApiMethod';\nexport { type IApiMethodSignatureOptions, ApiMethodSignature } from './model/ApiMethodSignature';\nexport { ApiModel } from './model/ApiModel';\nexport { type IApiNamespaceOptions, ApiNamespace } from './model/ApiNamespace';\nexport { type IApiPackageOptions, ApiPackage, type IApiPackageSaveOptions } from './model/ApiPackage';\nexport { type IParameterOptions, Parameter } from './model/Parameter';\nexport { type IApiPropertyOptions, ApiProperty } from './model/ApiProperty';\nexport { type IApiPropertySignatureOptions, ApiPropertySignature } from './model/ApiPropertySignature';\nexport { type IApiTypeAliasOptions, ApiTypeAlias } from './model/ApiTypeAlias';\nexport { type ITypeParameterOptions, TypeParameter } from './model/TypeParameter';\nexport { type IApiVariableOptions, ApiVariable } from './model/ApiVariable';\nexport { type IResolveDeclarationReferenceResult } from './model/ModelReferenceResolver';\nexport { HeritageType } from './model/HeritageType';\nexport { type ISourceLocationOptions, SourceLocation } from './model/SourceLocation';\n"]}

package/lib-esm/items/ApiDeclaredItem.js

@@ -0,0 +1,137 @@
+// 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 { ApiDocumentedItem } from './ApiDocumentedItem';
+import { Excerpt, ExcerptToken } from '../mixins/Excerpt';
+import { SourceLocation } from '../model/SourceLocation';
+/**
+ * The base class for API items that have an associated source code excerpt containing a TypeScript declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * Most `ApiItem` subclasses have declarations and thus extend `ApiDeclaredItem`.  Counterexamples include
+ * `ApiModel` and `ApiPackage`, which do not have any corresponding TypeScript source code.
+ *
+ * @public
+ */
+export class ApiDeclaredItem extends ApiDocumentedItem {
+    constructor(options) {
+        super(options);
+        this._excerptTokens = options.excerptTokens.map((token) => {
+            const canonicalReference = token.canonicalReference === undefined
+                ? undefined
+                : DeclarationReference.parse(token.canonicalReference);
+            return new ExcerptToken(token.kind, token.text, canonicalReference);
+        });
+        this._excerpt = new Excerpt(this.excerptTokens, { startIndex: 0, endIndex: this.excerptTokens.length });
+        this._fileUrlPath = options.fileUrlPath;
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.excerptTokens = jsonObject.excerptTokens;
+        options.fileUrlPath = jsonObject.fileUrlPath;
+    }
+    /**
+     * The source code excerpt where the API item is declared.
+     */
+    get excerpt() {
+        return this._excerpt;
+    }
+    /**
+     * The individual source code tokens that comprise the main excerpt.
+     */
+    get excerptTokens() {
+        return this._excerptTokens;
+    }
+    /**
+     * The file URL path relative to the `projectFolder` and `projectFolderURL` fields
+     * as defined in the `api-extractor.json` config. Is `undefined` if the path is
+     * the same as the parent API item's.
+     */
+    get fileUrlPath() {
+        return this._fileUrlPath;
+    }
+    /**
+     * Returns the source location where the API item is declared.
+     */
+    get sourceLocation() {
+        if (!this._sourceLocation) {
+            this._sourceLocation = this._buildSourceLocation();
+        }
+        return this._sourceLocation;
+    }
+    /**
+     * 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.
+     */
+    getExcerptWithModifiers() {
+        const excerpt = this.excerpt.text;
+        const modifierTags = [];
+        if (excerpt.length > 0) {
+            if (this instanceof ApiDocumentedItem) {
+                if (this.tsdocComment) {
+                    if (this.tsdocComment.modifierTagSet.isSealed()) {
+                        modifierTags.push('@sealed');
+                    }
+                    if (this.tsdocComment.modifierTagSet.isVirtual()) {
+                        modifierTags.push('@virtual');
+                    }
+                    if (this.tsdocComment.modifierTagSet.isOverride()) {
+                        modifierTags.push('@override');
+                    }
+                }
+                if (modifierTags.length > 0) {
+                    return '/** ' + modifierTags.join(' ') + ' */\n' + excerpt;
+                }
+            }
+        }
+        return excerpt;
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        jsonObject.excerptTokens = this.excerptTokens.map((x) => {
+            const excerptToken = { kind: x.kind, text: x.text };
+            if (x.canonicalReference !== undefined) {
+                excerptToken.canonicalReference = x.canonicalReference.toString();
+            }
+            return excerptToken;
+        });
+        // Only serialize this API item's file URL path if it exists and it's different from its parent's
+        // (a little optimization to keep the doc model succinct).
+        if (this.fileUrlPath) {
+            if (!(this.parent instanceof ApiDeclaredItem) || this.fileUrlPath !== this.parent.fileUrlPath) {
+                jsonObject.fileUrlPath = this.fileUrlPath;
+            }
+        }
+    }
+    /**
+     * Constructs a new {@link Excerpt} corresponding to the provided token range.
+     */
+    buildExcerpt(tokenRange) {
+        return new Excerpt(this.excerptTokens, tokenRange);
+    }
+    /**
+     * Builds the cached object used by the `sourceLocation` property.
+     */
+    _buildSourceLocation() {
+        var _a;
+        const projectFolderUrl = (_a = this.getAssociatedPackage()) === null || _a === void 0 ? void 0 : _a.projectFolderUrl;
+        let fileUrlPath;
+        for (let current = this; current !== undefined; current = current.parent) {
+            if (current instanceof ApiDeclaredItem && current.fileUrlPath) {
+                fileUrlPath = current.fileUrlPath;
+                break;
+            }
+        }
+        return new SourceLocation({
+            projectFolderUrl: projectFolderUrl,
+            fileUrlPath: fileUrlPath
+        });
+    }
+}
+//# sourceMappingURL=ApiDeclaredItem.js.map

package/lib-esm/items/ApiDeclaredItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiDeclaredItem.js","sourceRoot":"","sources":["../../src/items/ApiDeclaredItem.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAE/F,OAAO,EACL,iBAAiB,EAGlB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,OAAO,EAAE,YAAY,EAA+C,MAAM,mBAAmB,CAAC;AAEvG,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAgBzD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,eAAgB,SAAQ,iBAAiB;IAMpD,YAAmB,OAAgC;QACjD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACxD,MAAM,kBAAkB,GACtB,KAAK,CAAC,kBAAkB,KAAK,SAAS;gBACpC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAC3D,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;QACxG,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAC1C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAyC,EACzC,OAA4B,EAC5B,UAAgC;QAEhC,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QACjD,OAAO,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,uBAAuB;QAC5B,MAAM,OAAO,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAC1C,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,IAAI,YAAY,iBAAiB,EAAE,CAAC;gBACtC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACtB,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC;wBAChD,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC/B,CAAC;oBACD,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,CAAC;wBACjD,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAChC,CAAC;oBACD,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,UAAU,EAAE,EAAE,CAAC;wBAClD,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACjC,CAAC;gBACH,CAAC;gBACD,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC5B,OAAO,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,OAAO,CAAC;gBAC7D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAyC;QAC5D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAChC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACtD,MAAM,YAAY,GAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACnE,IAAI,CAAC,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBACvC,YAAY,CAAC,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;YACpE,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,iGAAiG;QACjG,0DAA0D;QAC1D,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,YAAY,eAAe,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC9F,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,UAA8B;QAChD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACK,oBAAoB;;QAC1B,MAAM,gBAAgB,GAAuB,MAAA,IAAI,CAAC,oBAAoB,EAAE,0CAAE,gBAAgB,CAAC;QAE3F,IAAI,WAA+B,CAAC;QACpC,KAAK,IAAI,OAAO,GAAwB,IAAI,EAAE,OAAO,KAAK,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9F,IAAI,OAAO,YAAY,eAAe,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBAC9D,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBAClC,MAAM;YACR,CAAC;QACH,CAAC;QAED,OAAO,IAAI,cAAc,CAAC;YACxB,gBAAgB,EAAE,gBAAgB;YAClC,WAAW,EAAE,WAAW;SACzB,CAAC,CAAC;IACL,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 {\n  ApiDocumentedItem,\n  type IApiDocumentedItemJson,\n  type IApiDocumentedItemOptions\n} from './ApiDocumentedItem';\nimport type { ApiItem } from './ApiItem';\nimport { Excerpt, ExcerptToken, type IExcerptTokenRange, type IExcerptToken } from '../mixins/Excerpt';\nimport type { DeserializerContext } from '../model/DeserializerContext';\nimport { SourceLocation } from '../model/SourceLocation';\n\n/**\n * Constructor options for {@link ApiDeclaredItem}.\n * @public\n */\nexport interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions {\n  excerptTokens: IExcerptToken[];\n  fileUrlPath?: string;\n}\n\nexport interface IApiDeclaredItemJson extends IApiDocumentedItemJson {\n  excerptTokens: IExcerptToken[];\n  fileUrlPath?: string;\n}\n\n/**\n * The base class for API items that have an associated source code excerpt containing a TypeScript 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 * Most `ApiItem` subclasses have declarations and thus extend `ApiDeclaredItem`.  Counterexamples include\n * `ApiModel` and `ApiPackage`, which do not have any corresponding TypeScript source code.\n *\n * @public\n */\nexport class ApiDeclaredItem extends ApiDocumentedItem {\n  private _excerptTokens: ExcerptToken[];\n  private _excerpt: Excerpt;\n  private _fileUrlPath?: string;\n  private _sourceLocation?: SourceLocation;\n\n  public constructor(options: IApiDeclaredItemOptions) {\n    super(options);\n\n    this._excerptTokens = options.excerptTokens.map((token) => {\n      const canonicalReference: DeclarationReference | undefined =\n        token.canonicalReference === undefined\n          ? undefined\n          : DeclarationReference.parse(token.canonicalReference);\n      return new ExcerptToken(token.kind, token.text, canonicalReference);\n    });\n    this._excerpt = new Excerpt(this.excerptTokens, { startIndex: 0, endIndex: this.excerptTokens.length });\n    this._fileUrlPath = options.fileUrlPath;\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiDeclaredItemOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiDeclaredItemJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.excerptTokens = jsonObject.excerptTokens;\n    options.fileUrlPath = jsonObject.fileUrlPath;\n  }\n\n  /**\n   * The source code excerpt where the API item is declared.\n   */\n  public get excerpt(): Excerpt {\n    return this._excerpt;\n  }\n\n  /**\n   * The individual source code tokens that comprise the main excerpt.\n   */\n  public get excerptTokens(): ReadonlyArray<ExcerptToken> {\n    return this._excerptTokens;\n  }\n\n  /**\n   * The file URL path relative to the `projectFolder` and `projectFolderURL` fields\n   * as defined in the `api-extractor.json` config. Is `undefined` if the path is\n   * the same as the parent API item's.\n   */\n  public get fileUrlPath(): string | undefined {\n    return this._fileUrlPath;\n  }\n\n  /**\n   * Returns the source location where the API item is declared.\n   */\n  public get sourceLocation(): SourceLocation {\n    if (!this._sourceLocation) {\n      this._sourceLocation = this._buildSourceLocation();\n    }\n    return this._sourceLocation;\n  }\n\n  /**\n   * If the API item has certain important modifier tags such as `@sealed`, `@virtual`, or `@override`,\n   * this prepends them as a doc comment above the excerpt.\n   */\n  public getExcerptWithModifiers(): string {\n    const excerpt: string = this.excerpt.text;\n    const modifierTags: string[] = [];\n\n    if (excerpt.length > 0) {\n      if (this instanceof ApiDocumentedItem) {\n        if (this.tsdocComment) {\n          if (this.tsdocComment.modifierTagSet.isSealed()) {\n            modifierTags.push('@sealed');\n          }\n          if (this.tsdocComment.modifierTagSet.isVirtual()) {\n            modifierTags.push('@virtual');\n          }\n          if (this.tsdocComment.modifierTagSet.isOverride()) {\n            modifierTags.push('@override');\n          }\n        }\n        if (modifierTags.length > 0) {\n          return '/** ' + modifierTags.join(' ') + ' */\\n' + excerpt;\n        }\n      }\n    }\n\n    return excerpt;\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiDeclaredItemJson>): void {\n    super.serializeInto(jsonObject);\n    jsonObject.excerptTokens = this.excerptTokens.map((x) => {\n      const excerptToken: IExcerptToken = { kind: x.kind, text: x.text };\n      if (x.canonicalReference !== undefined) {\n        excerptToken.canonicalReference = x.canonicalReference.toString();\n      }\n      return excerptToken;\n    });\n\n    // Only serialize this API item's file URL path if it exists and it's different from its parent's\n    // (a little optimization to keep the doc model succinct).\n    if (this.fileUrlPath) {\n      if (!(this.parent instanceof ApiDeclaredItem) || this.fileUrlPath !== this.parent.fileUrlPath) {\n        jsonObject.fileUrlPath = this.fileUrlPath;\n      }\n    }\n  }\n\n  /**\n   * Constructs a new {@link Excerpt} corresponding to the provided token range.\n   */\n  public buildExcerpt(tokenRange: IExcerptTokenRange): Excerpt {\n    return new Excerpt(this.excerptTokens, tokenRange);\n  }\n\n  /**\n   * Builds the cached object used by the `sourceLocation` property.\n   */\n  private _buildSourceLocation(): SourceLocation {\n    const projectFolderUrl: string | undefined = this.getAssociatedPackage()?.projectFolderUrl;\n\n    let fileUrlPath: string | undefined;\n    for (let current: ApiItem | undefined = this; current !== undefined; current = current.parent) {\n      if (current instanceof ApiDeclaredItem && current.fileUrlPath) {\n        fileUrlPath = current.fileUrlPath;\n        break;\n      }\n    }\n\n    return new SourceLocation({\n      projectFolderUrl: projectFolderUrl,\n      fileUrlPath: fileUrlPath\n    });\n  }\n}\n"]}

package/lib-esm/items/ApiDocumentedItem.js

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import * as tsdoc from '@microsoft/tsdoc';
+import { ApiItem } from './ApiItem';
+/**
+ * An abstract base class for API declarations that can have an associated TSDoc comment.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * @public
+ */
+export class ApiDocumentedItem extends ApiItem {
+    constructor(options) {
+        super(options);
+        this._tsdocComment = options.docComment;
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        const documentedJson = jsonObject;
+        if (documentedJson.docComment) {
+            const tsdocParser = new tsdoc.TSDocParser(context.tsdocConfiguration);
+            // NOTE: For now, we ignore TSDoc errors found in a serialized .api.json file.
+            // Normally these errors would have already been reported by API Extractor during analysis.
+            // However, they could also arise if the JSON file was edited manually, or if the file was saved
+            // using a different release of the software that used an incompatible syntax.
+            const parserContext = tsdocParser.parseString(documentedJson.docComment);
+            options.docComment = parserContext.docComment;
+        }
+    }
+    get tsdocComment() {
+        return this._tsdocComment;
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        if (this.tsdocComment !== undefined) {
+            jsonObject.docComment = this.tsdocComment.emitAsTsdoc();
+        }
+        else {
+            jsonObject.docComment = '';
+        }
+    }
+}
+//# sourceMappingURL=ApiDocumentedItem.js.map

package/lib-esm/items/ApiDocumentedItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiDocumentedItem.js","sourceRoot":"","sources":["../../src/items/ApiDocumentedItem.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,OAAO,EAA2C,MAAM,WAAW,CAAC;AAe7E;;;;;;;;;GASG;AACH,MAAM,OAAO,iBAAkB,SAAQ,OAAO;IAG5C,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAA2C,EAC3C,OAA4B,EAC5B,UAAwB;QAExB,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,MAAM,cAAc,GAA2B,UAAoC,CAAC;QAEpF,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC;YAC9B,MAAM,WAAW,GAAsB,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAEzF,8EAA8E;YAC9E,2FAA2F;YAC3F,gGAAgG;YAChG,8EAA8E;YAC9E,MAAM,aAAa,GAAwB,WAAW,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAE9F,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;QAChD,CAAC;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAA2C;QAC9D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACpC,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,UAAU,GAAG,EAAE,CAAC;QAC7B,CAAC;IACH,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 * as tsdoc from '@microsoft/tsdoc';\n\nimport { ApiItem, type IApiItemOptions, type IApiItemJson } from './ApiItem';\nimport type { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Constructor options for {@link ApiDocumentedItem}.\n * @public\n */\nexport interface IApiDocumentedItemOptions extends IApiItemOptions {\n  docComment: tsdoc.DocComment | undefined;\n}\n\nexport interface IApiDocumentedItemJson extends IApiItemJson {\n  docComment: string;\n}\n\n/**\n * An abstract base class for API declarations that can have an associated TSDoc comment.\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 * @public\n */\nexport class ApiDocumentedItem extends ApiItem {\n  private _tsdocComment: tsdoc.DocComment | undefined;\n\n  public constructor(options: IApiDocumentedItemOptions) {\n    super(options);\n    this._tsdocComment = options.docComment;\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiDocumentedItemOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiItemJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    const documentedJson: IApiDocumentedItemJson = jsonObject as IApiDocumentedItemJson;\n\n    if (documentedJson.docComment) {\n      const tsdocParser: tsdoc.TSDocParser = new tsdoc.TSDocParser(context.tsdocConfiguration);\n\n      // NOTE: For now, we ignore TSDoc errors found in a serialized .api.json file.\n      // Normally these errors would have already been reported by API Extractor during analysis.\n      // However, they could also arise if the JSON file was edited manually, or if the file was saved\n      // using a different release of the software that used an incompatible syntax.\n      const parserContext: tsdoc.ParserContext = tsdocParser.parseString(documentedJson.docComment);\n\n      options.docComment = parserContext.docComment;\n    }\n  }\n\n  public get tsdocComment(): tsdoc.DocComment | undefined {\n    return this._tsdocComment;\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiDocumentedItemJson>): void {\n    super.serializeInto(jsonObject);\n    if (this.tsdocComment !== undefined) {\n      jsonObject.docComment = this.tsdocComment.emitAsTsdoc();\n    } else {\n      jsonObject.docComment = '';\n    }\n  }\n}\n"]}