@microsoft/api-extractor-model 7.15.4 → 7.16.2

package/README.md

@@ -61,7 +61,7 @@ a namespace containing static members of the class.
 ## Links
 
 - [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/master/apps/api-extractor-model/CHANGELOG.md) - Find
+  https://github.com/microsoft/rushstack/blob/main/libraries/api-extractor-model/CHANGELOG.md) - Find
   out what's new in the latest version
 - [API Reference](https://rushstack.io/pages/api/api-extractor-model/)
 

package/dist/rollup.d.ts

@@ -735,30 +735,36 @@ declare enum ApiJsonSchemaVersion {
      */
     V_1001 = 1001,
     /**
-     * Remove "canonicalReference" field.  This field was for diagnostic purposes only and was never deserialized.
+     * Remove `canonicalReference` field.  This field was for diagnostic purposes only and was never deserialized.
      */
     V_1002 = 1002,
     /**
-     * Reintroduce the "canonicalReference" field using the experimental new TSDoc declaration reference notation.
+     * Reintroduce the `canonicalReference` field using the experimental new TSDoc declaration reference notation.
      *
      * This is not a breaking change because this field is never deserialized; it is provided for informational
      * purposes only.
      */
     V_1003 = 1003,
     /**
-     * Add a "tsdocConfig" field that tracks the TSDoc configuration for parsing doc comments.
+     * Add a `tsdocConfig` field that tracks the TSDoc configuration for parsing doc comments.
      *
      * This is not a breaking change because an older implementation will still work correctly.  The
      * custom tags will be skipped over by the parser.
      */
     V_1004 = 1004,
+    /**
+     * Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional.
+     *
+     * When loading older JSON files, the value defaults to `false`.
+     */
+    V_1005 = 1005,
     /**
      * The current latest .api.json schema version.
      *
      * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`
      * should be updated.
      */
-    LATEST = 1004,
+    LATEST = 1005,
     /**
      * The oldest .api.json schema version that is still supported for backwards compatibility.
      *
@@ -1981,6 +1987,7 @@ export declare interface IApiParameterListMixinOptions extends IApiItemOptions {
 export declare interface IApiParameterOptions {
     parameterName: string;
     parameterTypeTokenRange: IExcerptTokenRange;
+    isOptional: boolean;
 }
 
 declare interface IApiPropertyItemJson extends IApiDeclaredItemJson {
@@ -2121,6 +2128,7 @@ export declare interface IExcerptTokenRange {
 export declare interface IParameterOptions {
     name: string;
     parameterTypeExcerpt: Excerpt;
+    isOptional: boolean;
     parent: ApiParameterListMixin;
 }
 
@@ -2178,6 +2186,10 @@ export declare class Parameter {
      * The parameter name.
      */
     name: string;
+    /**
+     * Whether the parameter is optional.
+     */
+    isOptional: boolean;
     private _parent;
     constructor(options: IParameterOptions);
     /**

package/dist/tsdoc-metadata.json

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

package/lib/mixins/ApiParameterListMixin.d.ts

@@ -8,6 +8,7 @@ import { IExcerptTokenRange } from './Excerpt';
 export interface IApiParameterOptions {
     parameterName: string;
     parameterTypeTokenRange: IExcerptTokenRange;
+    isOptional: boolean;
 }
 /**
  * Constructor options for {@link (ApiParameterListMixin:interface)}.

package/lib/mixins/ApiParameterListMixin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiParameterListMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAI/C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,kBAAkB,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,eAAe;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAKD;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAE9C,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,SAAS,mBAAmB,EAC1E,SAAS,EAAE,UAAU,GAEpB,UAAU,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAqB,CAAC,CAsE9D;AAED;;;GAGG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,qBAAqB,CAEhF;CACF"}
+{"version":3,"file":"ApiParameterListMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAI/C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,kBAAkB,CAAC;IAC5C,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,eAAe;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAKD;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAE9C,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,SAAS,mBAAmB,EAC1E,SAAS,EAAE,UAAU,GAEpB,UAAU,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAqB,CAAC,CAyE9D;AAED;;;GAGG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,qBAAqB,CAEhF;CACF"}

package/lib/mixins/ApiParameterListMixin.js

@@ -32,6 +32,8 @@ function ApiParameterListMixin(baseClass
                         const parameter = new Parameter_1.Parameter({
                             name: parameterOptions.parameterName,
                             parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),
+                            // Prior to ApiJsonSchemaVersion.V_1005 this input will be undefined
+                            isOptional: !!parameterOptions.isOptional,
                             parent: this
                         });
                         this[_parameters].push(parameter);
@@ -62,7 +64,8 @@ function ApiParameterListMixin(baseClass
             for (const parameter of this.parameters) {
                 parameterObjects.push({
                     parameterName: parameter.name,
-                    parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange
+                    parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange,
+                    isOptional: parameter.isOptional
                 });
             }
             jsonObject.parameters = parameterObjects;

package/lib/mixins/ApiParameterListMixin.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAG5D,kDAA+C;AAC/C,8DAA2D;AAE3D,oEAA6D;AA0B7D,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,WAAW,GAAkB,MAAM,CAAC,mCAAmC,CAAC,CAAC;AAwD/E;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAIhC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;YAE7C,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,IAAI,YAAY,iCAAe,EAAE;gBACnC,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,KAAK,MAAM,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE;wBACjD,MAAM,SAAS,GAAc,IAAI,qBAAS,CAAC;4BACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa;4BACpC,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;4BACjF,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBAEH,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;qBACnC;iBACF;aACF;iBAAM;gBACL,MAAM,IAAI,iCAAa,CAAC,4EAA4E,CAAC,CAAC;aACvG;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA+C,EAC/C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,IAAW,aAAa;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YAE9C,MAAM,gBAAgB,GAA2B,EAAE,CAAC;YACpD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;gBACvC,gBAAgB,CAAC,IAAI,CAAC;oBACpB,aAAa,EAAE,SAAS,CAAC,IAAI;oBAC7B,uBAAuB,EAAE,SAAS,CAAC,oBAAoB,CAAC,UAAU;iBACnE,CAAC,CAAC;aACJ;YAED,UAAU,CAAC,UAAU,GAAG,gBAAgB,CAAC;QAC3C,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAzED,sDAyEC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAarC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.s\n\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\nimport { Parameter } from '../model/Parameter';\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { IExcerptTokenRange } from './Excerpt';\nimport { InternalError } from '@rushstack/node-core-library';\nimport { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Represents parameter information that is part of {@link IApiParameterListMixinOptions}\n * @public\n */\nexport interface IApiParameterOptions {\n  parameterName: string;\n  parameterTypeTokenRange: IExcerptTokenRange;\n}\n\n/**\n * Constructor options for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport interface IApiParameterListMixinOptions extends IApiItemOptions {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nexport interface IApiParameterListJson extends IApiItemJson {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nconst _overloadIndex: unique symbol = Symbol('ApiParameterListMixin._overloadIndex');\nconst _parameters: unique symbol = Symbol('ApiParameterListMixin._parameters');\n\n/**\n * The mixin base class for API items that can have function parameters (but not necessarily a return value).\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.  The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\n * to extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\n * the function that generates a subclass, an interface that describes the members of the subclass, and\n * a namespace containing static members of the class.\n *\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiParameterListMixin extends ApiItem {\n  /**\n   * When a function has multiple overloaded declarations, this zero-based integer index can be used to unqiuely\n   * identify them.\n   *\n   * @remarks\n   *\n   * Consider this overloaded declaration:\n   *\n   * ```ts\n   * export namespace Versioning {\n   *   // TSDoc: Versioning.(addVersions:1)\n   *   export function addVersions(x: number, y: number): number;\n   *\n   *   // TSDoc: Versioning.(addVersions:2)\n   *   export function addVersions(x: string, y: string): string;\n   *\n   *   // (implementation)\n   *   export function addVersions(x: number|string, y: number|string): number|string {\n   *     // . . .\n   *   }\n   * }\n   * ```\n   *\n   * In the above example, there are two overloaded declarations.  The overload using numbers will have\n   * `overloadIndex = 1`.  The overload using strings will have `overloadIndex = 2`.  The third declaration that\n   * accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor.\n   */\n  readonly overloadIndex: number;\n\n  /**\n   * The function parameters.\n   */\n  readonly parameters: ReadonlyArray<Parameter>;\n\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link (ApiParameterListMixin:interface)}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiParameterListMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiParameterListMixin) {\n  class MixedClass extends baseClass implements ApiParameterListMixin {\n    public readonly [_overloadIndex]: number;\n    public readonly [_parameters]: Parameter[];\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n\n      const options: IApiParameterListMixinOptions = args[0];\n      this[_overloadIndex] = options.overloadIndex;\n\n      this[_parameters] = [];\n\n      if (this instanceof ApiDeclaredItem) {\n        if (options.parameters) {\n          for (const parameterOptions of options.parameters) {\n            const parameter: Parameter = new Parameter({\n              name: parameterOptions.parameterName,\n              parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),\n              parent: this\n            });\n\n            this[_parameters].push(parameter);\n          }\n        }\n      } else {\n        throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');\n      }\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiParameterListMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiParameterListJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n\n      options.overloadIndex = jsonObject.overloadIndex;\n      options.parameters = jsonObject.parameters || [];\n    }\n\n    public get overloadIndex(): number {\n      return this[_overloadIndex];\n    }\n\n    public get parameters(): ReadonlyArray<Parameter> {\n      return this[_parameters];\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiParameterListJson>): void {\n      super.serializeInto(jsonObject);\n\n      jsonObject.overloadIndex = this.overloadIndex;\n\n      const parameterObjects: IApiParameterOptions[] = [];\n      for (const parameter of this.parameters) {\n        parameterObjects.push({\n          parameterName: parameter.name,\n          parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange\n        });\n      }\n\n      jsonObject.parameters = parameterObjects;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport namespace ApiParameterListMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin.\n   *\n   * @remarks\n   *\n   * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\n   * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however\n   * the TypeScript type system cannot invoke a runtime test.)\n   */\n  export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiParameterListMixin {\n    return apiItem.hasOwnProperty(_parameters);\n  }\n}\n"]}
+{"version":3,"file":"ApiParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAG5D,kDAA+C;AAC/C,8DAA2D;AAE3D,oEAA6D;AA2B7D,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,WAAW,GAAkB,MAAM,CAAC,mCAAmC,CAAC,CAAC;AAwD/E;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAM,UAAW,SAAQ,SAAS;QAIhC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;YAE7C,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,IAAI,YAAY,iCAAe,EAAE;gBACnC,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,KAAK,MAAM,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE;wBACjD,MAAM,SAAS,GAAc,IAAI,qBAAS,CAAC;4BACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa;4BACpC,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;4BACjF,oEAAoE;4BACpE,UAAU,EAAE,CAAC,CAAC,gBAAgB,CAAC,UAAU;4BACzC,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBAEH,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;qBACnC;iBACF;aACF;iBAAM;gBACL,MAAM,IAAI,iCAAa,CAAC,4EAA4E,CAAC,CAAC;aACvG;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA+C,EAC/C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,IAAW,aAAa;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YAE9C,MAAM,gBAAgB,GAA2B,EAAE,CAAC;YACpD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;gBACvC,gBAAgB,CAAC,IAAI,CAAC;oBACpB,aAAa,EAAE,SAAS,CAAC,IAAI;oBAC7B,uBAAuB,EAAE,SAAS,CAAC,oBAAoB,CAAC,UAAU;oBAClE,UAAU,EAAE,SAAS,CAAC,UAAU;iBACjC,CAAC,CAAC;aACJ;YAED,UAAU,CAAC,UAAU,GAAG,gBAAgB,CAAC;QAC3C,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA5ED,sDA4EC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAarC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.s\n\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\nimport { Parameter } from '../model/Parameter';\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\nimport { IExcerptTokenRange } from './Excerpt';\nimport { InternalError } from '@rushstack/node-core-library';\nimport { DeserializerContext } from '../model/DeserializerContext';\n\n/**\n * Represents parameter information that is part of {@link IApiParameterListMixinOptions}\n * @public\n */\nexport interface IApiParameterOptions {\n  parameterName: string;\n  parameterTypeTokenRange: IExcerptTokenRange;\n  isOptional: boolean;\n}\n\n/**\n * Constructor options for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport interface IApiParameterListMixinOptions extends IApiItemOptions {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nexport interface IApiParameterListJson extends IApiItemJson {\n  overloadIndex: number;\n  parameters: IApiParameterOptions[];\n}\n\nconst _overloadIndex: unique symbol = Symbol('ApiParameterListMixin._overloadIndex');\nconst _parameters: unique symbol = Symbol('ApiParameterListMixin._parameters');\n\n/**\n * The mixin base class for API items that can have function parameters (but not necessarily a return value).\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.  The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\n * to extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\n * the function that generates a subclass, an interface that describes the members of the subclass, and\n * a namespace containing static members of the class.\n *\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface ApiParameterListMixin extends ApiItem {\n  /**\n   * When a function has multiple overloaded declarations, this zero-based integer index can be used to unqiuely\n   * identify them.\n   *\n   * @remarks\n   *\n   * Consider this overloaded declaration:\n   *\n   * ```ts\n   * export namespace Versioning {\n   *   // TSDoc: Versioning.(addVersions:1)\n   *   export function addVersions(x: number, y: number): number;\n   *\n   *   // TSDoc: Versioning.(addVersions:2)\n   *   export function addVersions(x: string, y: string): string;\n   *\n   *   // (implementation)\n   *   export function addVersions(x: number|string, y: number|string): number|string {\n   *     // . . .\n   *   }\n   * }\n   * ```\n   *\n   * In the above example, there are two overloaded declarations.  The overload using numbers will have\n   * `overloadIndex = 1`.  The overload using strings will have `overloadIndex = 2`.  The third declaration that\n   * accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor.\n   */\n  readonly overloadIndex: number;\n\n  /**\n   * The function parameters.\n   */\n  readonly parameters: ReadonlyArray<Parameter>;\n\n  serializeInto(jsonObject: Partial<IApiItemJson>): void;\n}\n\n/**\n * Mixin function for {@link (ApiParameterListMixin:interface)}.\n *\n * @param baseClass - The base class to be extended\n * @returns A child class that extends baseClass, adding the {@link (ApiParameterListMixin:interface)} functionality.\n *\n * @public\n */\nexport function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(\n  baseClass: TBaseClass\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): TBaseClass & (new (...args: any[]) => ApiParameterListMixin) {\n  class MixedClass extends baseClass implements ApiParameterListMixin {\n    public readonly [_overloadIndex]: number;\n    public readonly [_parameters]: Parameter[];\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    public constructor(...args: any[]) {\n      super(...args);\n\n      const options: IApiParameterListMixinOptions = args[0];\n      this[_overloadIndex] = options.overloadIndex;\n\n      this[_parameters] = [];\n\n      if (this instanceof ApiDeclaredItem) {\n        if (options.parameters) {\n          for (const parameterOptions of options.parameters) {\n            const parameter: Parameter = new Parameter({\n              name: parameterOptions.parameterName,\n              parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),\n              // Prior to ApiJsonSchemaVersion.V_1005 this input will be undefined\n              isOptional: !!parameterOptions.isOptional,\n              parent: this\n            });\n\n            this[_parameters].push(parameter);\n          }\n        }\n      } else {\n        throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');\n      }\n    }\n\n    /** @override */\n    public static onDeserializeInto(\n      options: Partial<IApiParameterListMixinOptions>,\n      context: DeserializerContext,\n      jsonObject: IApiParameterListJson\n    ): void {\n      baseClass.onDeserializeInto(options, context, jsonObject);\n\n      options.overloadIndex = jsonObject.overloadIndex;\n      options.parameters = jsonObject.parameters || [];\n    }\n\n    public get overloadIndex(): number {\n      return this[_overloadIndex];\n    }\n\n    public get parameters(): ReadonlyArray<Parameter> {\n      return this[_parameters];\n    }\n\n    /** @override */\n    public serializeInto(jsonObject: Partial<IApiParameterListJson>): void {\n      super.serializeInto(jsonObject);\n\n      jsonObject.overloadIndex = this.overloadIndex;\n\n      const parameterObjects: IApiParameterOptions[] = [];\n      for (const parameter of this.parameters) {\n        parameterObjects.push({\n          parameterName: parameter.name,\n          parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange,\n          isOptional: parameter.isOptional\n        });\n      }\n\n      jsonObject.parameters = parameterObjects;\n    }\n  }\n\n  return MixedClass;\n}\n\n/**\n * Static members for {@link (ApiParameterListMixin:interface)}.\n * @public\n */\nexport namespace ApiParameterListMixin {\n  /**\n   * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin.\n   *\n   * @remarks\n   *\n   * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\n   * the mixin function produces a different subclass.  (This could be mitigated by `Symbol.hasInstance`, however\n   * the TypeScript type system cannot invoke a runtime test.)\n   */\n  export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiParameterListMixin {\n    return apiItem.hasOwnProperty(_parameters);\n  }\n}\n"]}

package/lib/model/DeserializerContext.d.ts

@@ -9,30 +9,36 @@ export declare enum ApiJsonSchemaVersion {
      */
     V_1001 = 1001,
     /**
-     * Remove "canonicalReference" field.  This field was for diagnostic purposes only and was never deserialized.
+     * Remove `canonicalReference` field.  This field was for diagnostic purposes only and was never deserialized.
      */
     V_1002 = 1002,
     /**
-     * Reintroduce the "canonicalReference" field using the experimental new TSDoc declaration reference notation.
+     * Reintroduce the `canonicalReference` field using the experimental new TSDoc declaration reference notation.
      *
      * This is not a breaking change because this field is never deserialized; it is provided for informational
      * purposes only.
      */
     V_1003 = 1003,
     /**
-     * Add a "tsdocConfig" field that tracks the TSDoc configuration for parsing doc comments.
+     * Add a `tsdocConfig` field that tracks the TSDoc configuration for parsing doc comments.
      *
      * This is not a breaking change because an older implementation will still work correctly.  The
      * custom tags will be skipped over by the parser.
      */
     V_1004 = 1004,
+    /**
+     * Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional.
+     *
+     * When loading older JSON files, the value defaults to `false`.
+     */
+    V_1005 = 1005,
     /**
      * The current latest .api.json schema version.
      *
      * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`
      * should be updated.
      */
-    LATEST = 1004,
+    LATEST = 1005,
     /**
      * The oldest .api.json schema version that is still supported for backwards compatibility.
      *

package/lib/model/DeserializerContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DeserializerContext.d.ts","sourceRoot":"","sources":["../../src/model/DeserializerContext.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,MAAM,OAAO;IAEb;;OAEG;IACH,MAAM,OAAO;IAEb;;OAEG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAS;IAEf;;;;;OAKG;IACH,gBAAgB,OAAS;IAEzB;;;;;;OAMG;IACH,0BAA0B,OAAS;CACpC;AAED,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,SAAgB,eAAe,EAAE,MAAM,CAAC;IAExC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3D;;OAEG;IACH,SAAgB,kBAAkB,EAAE,kBAAkB,CAAC;gBAEpC,OAAO,EAAE,mBAAmB;CAOhD"}
+{"version":3,"file":"DeserializerContext.d.ts","sourceRoot":"","sources":["../../src/model/DeserializerContext.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,MAAM,OAAO;IAEb;;OAEG;IACH,MAAM,OAAO;IAEb;;OAEG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAO;IAEb;;;;OAIG;IACH,MAAM,OAAO;IAEb;;;;;OAKG;IACH,MAAM,OAAS;IAEf;;;;;OAKG;IACH,gBAAgB,OAAS;IAEzB;;;;;;OAMG;IACH,0BAA0B,OAAS;CACpC;AAED,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,SAAgB,eAAe,EAAE,MAAM,CAAC;IAExC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3D;;OAEG;IACH,SAAgB,kBAAkB,EAAE,kBAAkB,CAAC;gBAEpC,OAAO,EAAE,mBAAmB;CAOhD"}

package/lib/model/DeserializerContext.js

@@ -14,30 +14,36 @@ var ApiJsonSchemaVersion;
      */
     ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1001"] = 1001] = "V_1001";
     /**
-     * Remove "canonicalReference" field.  This field was for diagnostic purposes only and was never deserialized.
+     * Remove `canonicalReference` field.  This field was for diagnostic purposes only and was never deserialized.
      */
     ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1002"] = 1002] = "V_1002";
     /**
-     * Reintroduce the "canonicalReference" field using the experimental new TSDoc declaration reference notation.
+     * Reintroduce the `canonicalReference` field using the experimental new TSDoc declaration reference notation.
      *
      * This is not a breaking change because this field is never deserialized; it is provided for informational
      * purposes only.
      */
     ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1003"] = 1003] = "V_1003";
     /**
-     * Add a "tsdocConfig" field that tracks the TSDoc configuration for parsing doc comments.
+     * Add a `tsdocConfig` field that tracks the TSDoc configuration for parsing doc comments.
      *
      * This is not a breaking change because an older implementation will still work correctly.  The
      * custom tags will be skipped over by the parser.
      */
     ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1004"] = 1004] = "V_1004";
+    /**
+     * Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional.
+     *
+     * When loading older JSON files, the value defaults to `false`.
+     */
+    ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1005"] = 1005] = "V_1005";
     /**
      * The current latest .api.json schema version.
      *
      * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`
      * should be updated.
      */
-    ApiJsonSchemaVersion[ApiJsonSchemaVersion["LATEST"] = 1004] = "LATEST";
+    ApiJsonSchemaVersion[ApiJsonSchemaVersion["LATEST"] = 1005] = "LATEST";
     /**
      * The oldest .api.json schema version that is still supported for backwards compatibility.
      *

package/lib/model/DeserializerContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeserializerContext.js","sourceRoot":"","sources":["../../src/model/DeserializerContext.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,IAAY,oBAwDX;AAxDD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,sEAAa,CAAA;IAEb;;OAEG;IACH,sEAAa,CAAA;IAEb;;OAEG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAe,CAAA;IAEf;;;;;OAKG;IACH,0FAAyB,CAAA;IAEzB;;;;;;OAMG;IACH,8GAAmC,CAAA;AACrC,CAAC,EAxDW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAwD/B;AAED,MAAa,mBAAmB;IA0B9B,YAAmB,OAA4B;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACvD,CAAC;CACF;AAjCD,kDAiCC","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 } from '@microsoft/tsdoc';\n\nexport enum ApiJsonSchemaVersion {\n  /**\n   * The initial release.\n   */\n  V_1000 = 1000,\n\n  /**\n   * Add support for type parameters and type alias types.\n   */\n  V_1001 = 1001,\n\n  /**\n   * Remove \"canonicalReference\" field.  This field was for diagnostic purposes only and was never deserialized.\n   */\n  V_1002 = 1002,\n\n  /**\n   * Reintroduce the \"canonicalReference\" field using the experimental new TSDoc declaration reference notation.\n   *\n   * This is not a breaking change because this field is never deserialized; it is provided for informational\n   * purposes only.\n   */\n  V_1003 = 1003,\n\n  /**\n   * Add a \"tsdocConfig\" field that tracks the TSDoc configuration for parsing doc comments.\n   *\n   * This is not a breaking change because an older implementation will still work correctly.  The\n   * custom tags will be skipped over by the parser.\n   */\n  V_1004 = 1004,\n\n  /**\n   * The current latest .api.json schema version.\n   *\n   * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`\n   * should be updated.\n   */\n  LATEST = V_1004,\n\n  /**\n   * The oldest .api.json schema version that is still supported for backwards compatibility.\n   *\n   * This must be updated if you change to the file format and do not implement compatibility logic for\n   * deserializing the older representation.\n   */\n  OLDEST_SUPPORTED = V_1001,\n\n  /**\n   * Used to assign `IApiPackageMetadataJson.oldestForwardsCompatibleVersion`.\n   *\n   * This value must be \\<= `ApiJsonSchemaVersion.LATEST`.  It must be reset to the `LATEST` value\n   * if the older library would not be able to deserialize your new file format.  Adding a nonessential field\n   * is generally okay.  Removing, modifying, or reinterpreting existing fields is NOT safe.\n   */\n  OLDEST_FORWARDS_COMPATIBLE = V_1001\n}\n\nexport class DeserializerContext {\n  /**\n   * The path of the file being deserialized, which may be useful for diagnostic purposes.\n   */\n  public readonly apiJsonFilename: string;\n\n  /**\n   * Metadata from `IApiPackageMetadataJson.toolPackage`.\n   */\n  public readonly toolPackage: string;\n\n  /**\n   * Metadata from `IApiPackageMetadataJson.toolVersion`.\n   */\n  public readonly toolVersion: string;\n\n  /**\n   * The version of the schema being deserialized, as obtained from `IApiPackageMetadataJson.schemaVersion`.\n   */\n  public readonly versionToDeserialize: ApiJsonSchemaVersion;\n\n  /**\n   * The TSDoc configuration for the context.\n   */\n  public readonly tsdocConfiguration: TSDocConfiguration;\n\n  public constructor(options: DeserializerContext) {\n    this.apiJsonFilename = options.apiJsonFilename;\n    this.toolPackage = options.toolPackage;\n    this.toolVersion = options.toolVersion;\n    this.versionToDeserialize = options.versionToDeserialize;\n    this.tsdocConfiguration = options.tsdocConfiguration;\n  }\n}\n"]}
+{"version":3,"file":"DeserializerContext.js","sourceRoot":"","sources":["../../src/model/DeserializerContext.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,IAAY,oBA+DX;AA/DD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,sEAAa,CAAA;IAEb;;OAEG;IACH,sEAAa,CAAA;IAEb;;OAEG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAa,CAAA;IAEb;;;;OAIG;IACH,sEAAa,CAAA;IAEb;;;;;OAKG;IACH,sEAAe,CAAA;IAEf;;;;;OAKG;IACH,0FAAyB,CAAA;IAEzB;;;;;;OAMG;IACH,8GAAmC,CAAA;AACrC,CAAC,EA/DW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA+D/B;AAED,MAAa,mBAAmB;IA0B9B,YAAmB,OAA4B;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACvD,CAAC;CACF;AAjCD,kDAiCC","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 } from '@microsoft/tsdoc';\n\nexport enum ApiJsonSchemaVersion {\n  /**\n   * The initial release.\n   */\n  V_1000 = 1000,\n\n  /**\n   * Add support for type parameters and type alias types.\n   */\n  V_1001 = 1001,\n\n  /**\n   * Remove `canonicalReference` field.  This field was for diagnostic purposes only and was never deserialized.\n   */\n  V_1002 = 1002,\n\n  /**\n   * Reintroduce the `canonicalReference` field using the experimental new TSDoc declaration reference notation.\n   *\n   * This is not a breaking change because this field is never deserialized; it is provided for informational\n   * purposes only.\n   */\n  V_1003 = 1003,\n\n  /**\n   * Add a `tsdocConfig` field that tracks the TSDoc configuration for parsing doc comments.\n   *\n   * This is not a breaking change because an older implementation will still work correctly.  The\n   * custom tags will be skipped over by the parser.\n   */\n  V_1004 = 1004,\n\n  /**\n   * Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional.\n   *\n   * When loading older JSON files, the value defaults to `false`.\n   */\n  V_1005 = 1005,\n\n  /**\n   * The current latest .api.json schema version.\n   *\n   * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`\n   * should be updated.\n   */\n  LATEST = V_1005,\n\n  /**\n   * The oldest .api.json schema version that is still supported for backwards compatibility.\n   *\n   * This must be updated if you change to the file format and do not implement compatibility logic for\n   * deserializing the older representation.\n   */\n  OLDEST_SUPPORTED = V_1001,\n\n  /**\n   * Used to assign `IApiPackageMetadataJson.oldestForwardsCompatibleVersion`.\n   *\n   * This value must be \\<= `ApiJsonSchemaVersion.LATEST`.  It must be reset to the `LATEST` value\n   * if the older library would not be able to deserialize your new file format.  Adding a nonessential field\n   * is generally okay.  Removing, modifying, or reinterpreting existing fields is NOT safe.\n   */\n  OLDEST_FORWARDS_COMPATIBLE = V_1001\n}\n\nexport class DeserializerContext {\n  /**\n   * The path of the file being deserialized, which may be useful for diagnostic purposes.\n   */\n  public readonly apiJsonFilename: string;\n\n  /**\n   * Metadata from `IApiPackageMetadataJson.toolPackage`.\n   */\n  public readonly toolPackage: string;\n\n  /**\n   * Metadata from `IApiPackageMetadataJson.toolVersion`.\n   */\n  public readonly toolVersion: string;\n\n  /**\n   * The version of the schema being deserialized, as obtained from `IApiPackageMetadataJson.schemaVersion`.\n   */\n  public readonly versionToDeserialize: ApiJsonSchemaVersion;\n\n  /**\n   * The TSDoc configuration for the context.\n   */\n  public readonly tsdocConfiguration: TSDocConfiguration;\n\n  public constructor(options: DeserializerContext) {\n    this.apiJsonFilename = options.apiJsonFilename;\n    this.toolPackage = options.toolPackage;\n    this.toolVersion = options.toolVersion;\n    this.versionToDeserialize = options.versionToDeserialize;\n    this.tsdocConfiguration = options.tsdocConfiguration;\n  }\n}\n"]}

package/lib/model/ModelReferenceResolver.js

@@ -3,6 +3,7 @@
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ModelReferenceResolver = void 0;
+const tsdoc_1 = require("@microsoft/tsdoc");
 const ApiItem_1 = require("../items/ApiItem");
 const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");
 const ApiParameterListMixin_1 = require("../mixins/ApiParameterListMixin");
@@ -83,10 +84,10 @@ class ModelReferenceResolver {
             else {
                 let memberSelectorResult;
                 switch (memberSelector.selectorKind) {
-                    case "system" /* System */:
+                    case tsdoc_1.SelectorKind.System:
                         memberSelectorResult = this._selectUsingSystemSelector(foundMembers, memberSelector, identifier);
                         break;
-                    case "index" /* Index */:
+                    case tsdoc_1.SelectorKind.Index:
                         memberSelectorResult = this._selectUsingIndexSelector(foundMembers, memberSelector, identifier);
                         break;
                     default:

package/lib/model/ModelReferenceResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelReferenceResolver.js","sourceRoot":"","sources":["../../src/model/ModelReferenceResolver.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,8CAAwD;AAIxD,2EAAwE;AACxE,2EAAwE;AAoBxE;;;;;;;GAOG;AACH,MAAa,sBAAsB;IAGjC,YAAmB,QAAkB;QACnC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,OAAO,CACZ,oBAA6C,EAC7C,cAAmC;QAEnC,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,IAAI,UAAU,GAA2B,SAAS,CAAC;QAEnD,iCAAiC;QACjC,IAAI,oBAAoB,CAAC,WAAW,KAAK,SAAS,EAAE;YAClD,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAClF,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,MAAM,CAAC,YAAY,GAAG,gBAAgB,oBAAoB,CAAC,WAAW,wBAAwB,CAAC;gBAC/F,OAAO,MAAM,CAAC;aACf;SACF;aAAM;YACL,mEAAmE;YACnE,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,UAAU,GAAG,cAAc,CAAC,oBAAoB,EAAE,CAAC;aACpD;YAED,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,MAAM,CAAC,YAAY;oBACjB,sFAAsF;wBACtF,mBAAmB,CAAC;gBACtB,OAAO,MAAM,CAAC;aACf;SACF;QAED,MAAM,UAAU,GAAW,oBAAoB,CAAC,UAAU,IAAI,EAAE,CAAC;QAEjE,MAAM,gBAAgB,GAAiC,UAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,MAAM,CAAC,YAAY,GAAG,oBAAoB,UAAU,yBAAyB,CAAC;YAC9E,OAAO,MAAM,CAAC;SACf;QAED,IAAI,WAAW,GAAY,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAE/C,sCAAsC;QACtC,KAAK,MAAM,eAAe,IAAI,oBAAoB,CAAC,gBAAgB,EAAE;YACnE,IAAI,eAAe,CAAC,YAAY,KAAK,SAAS,EAAE;gBAC9C,MAAM,CAAC,YAAY,GAAG,yDAAyD,CAAC;gBAChF,OAAO,MAAM,CAAC;aACf;YAED,IAAI,eAAe,CAAC,gBAAgB,KAAK,SAAS,EAAE;gBAClD,MAAM,CAAC,YAAY,GAAG,2BAA2B,CAAC;gBAClD,OAAO,MAAM,CAAC;aACf;YAED,MAAM,UAAU,GAAW,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC;YAEvE,IAAI,CAAC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;gBACrD,4FAA4F;gBAC5F,MAAM,CAAC,YAAY,GAAG,qBAAqB,IAAI,CAAC,SAAS,CACvD,UAAU,CACX,YAAY,WAAW,CAAC,0BAA0B,EAAE,4BAA4B,CAAC;gBAClF,OAAO,MAAM,CAAC;aACf;YAED,MAAM,YAAY,GAA2B,WAAW,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACvF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;gBACzF,OAAO,MAAM,CAAC;aACf;YAED,MAAM,cAAc,GAAkC,eAAe,CAAC,QAAQ,CAAC;YAC/E,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC3B,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;oBACzF,OAAO,MAAM,CAAC;iBACf;gBACD,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;aAC/B;iBAAM;gBACL,IAAI,oBAAwD,CAAC;gBAC7D,QAAQ,cAAc,CAAC,YAAY,EAAE;oBACnC;wBACE,oBAAoB,GAAG,IAAI,CAAC,0BAA0B,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;wBACjG,MAAM;oBACR;wBACE,oBAAoB,GAAG,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;wBAChG,MAAM;oBACR;wBACE,MAAM,CAAC,YAAY,GAAG,iBAAiB,cAAc,CAAC,QAAQ,oCAAoC,CAAC;wBACnG,OAAO,MAAM,CAAC;iBACjB;gBACD,IAAI,oBAAoB,CAAC,eAAe,KAAK,SAAS,EAAE;oBACtD,OAAO,oBAAoB,CAAC;iBAC7B;gBACD,WAAW,GAAG,oBAAoB,CAAC,eAAe,CAAC;aACpD;SACF;QACD,MAAM,CAAC,eAAe,GAAG,WAAW,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,0BAA0B,CAChC,YAAoC,EACpC,cAAiC,EACjC,UAAkB;QAElB,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,MAAM,YAAY,GAAW,cAAc,CAAC,QAAQ,CAAC;QAErD,IAAI,gBAA6B,CAAC;QAClC,QAAQ,YAAY,EAAE;YACpB,KAAK,OAAO;gBACV,gBAAgB,GAAG,qBAAW,CAAC,KAAK,CAAC;gBACrC,MAAM;YACR,KAAK,MAAM;gBACT,gBAAgB,GAAG,qBAAW,CAAC,IAAI,CAAC;gBACpC,MAAM;YACR,KAAK,UAAU;gBACb,gBAAgB,GAAG,qBAAW,CAAC,QAAQ,CAAC;gBACxC,MAAM;YACR,KAAK,WAAW;gBACd,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,WAAW;gBACd,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,MAAM;gBACT,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,UAAU;gBACb,gBAAgB,GAAG,qBAAW,CAAC,QAAQ,CAAC;gBACxC,MAAM;YACR;gBACE,MAAM,CAAC,YAAY,GAAG,gCAAgC,YAAY,GAAG,CAAC;gBACtE,OAAO,MAAM,CAAC;SACjB;QAED,MAAM,OAAO,GAAc,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;QACnF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,MAAM,CAAC,YAAY;gBACjB,sBAAsB,UAAU,kCAAkC;oBAClE,oBAAoB,YAAY,GAAG,CAAC;YACtC,OAAO,MAAM,CAAC;SACf;QACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,CAAC,YAAY,GAAG,8BAA8B,UAAU,iCAAiC,YAAY,GAAG,CAAC;SAChH;QACD,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,yBAAyB,CAC/B,YAAoC,EACpC,cAAiC,EACjC,UAAkB;QAElB,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,MAAM,eAAe,GAAc,EAAE,CAAC;QAEtC,MAAM,qBAAqB,GAAW,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxE,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;YACtC,IAAI,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;gBACpD,IAAI,WAAW,CAAC,aAAa,KAAK,qBAAqB,EAAE;oBACvD,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBACnC;aACF;SACF;QAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,MAAM,CAAC,YAAY;gBACjB,mBAAmB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,6BAA6B;oBAC1E,yBAAyB,qBAAqB,GAAG,CAAC;YACpD,OAAO,MAAM,CAAC;SACf;QAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACzF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AArMD,wDAqMC","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 { DocDeclarationReference, DocMemberSelector, SelectorKind } from '@microsoft/tsdoc';\nimport { ApiItem, ApiItemKind } from '../items/ApiItem';\nimport { ApiModel } from './ApiModel';\nimport { ApiPackage } from './ApiPackage';\nimport { ApiEntryPoint } from './ApiEntryPoint';\nimport { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\n\n/**\n * Result object for {@link ApiModel.resolveDeclarationReference}.\n *\n * @public\n */\nexport interface IResolveDeclarationReferenceResult {\n  /**\n   * The referenced ApiItem, if the declaration reference could be resolved.\n   */\n  resolvedApiItem: ApiItem | undefined;\n\n  /**\n   * If resolvedApiItem is undefined, then this will always contain an error message explaining why the\n   * resolution failed.\n   */\n  errorMessage: string | undefined;\n}\n\n/**\n * This resolves a TSDoc declaration reference by walking the `ApiModel` hierarchy.\n *\n * @remarks\n *\n * This class is analogous to `AstReferenceResolver` from the `@microsoft/api-extractor` project,\n * which resolves declaration references by walking the compiler state.\n */\nexport class ModelReferenceResolver {\n  private readonly _apiModel: ApiModel;\n\n  public constructor(apiModel: ApiModel) {\n    this._apiModel = apiModel;\n  }\n\n  public resolve(\n    declarationReference: DocDeclarationReference,\n    contextApiItem: ApiItem | undefined\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    let apiPackage: ApiPackage | undefined = undefined;\n\n    // Is this an absolute reference?\n    if (declarationReference.packageName !== undefined) {\n      apiPackage = this._apiModel.tryGetPackageByName(declarationReference.packageName);\n      if (apiPackage === undefined) {\n        result.errorMessage = `The package \"${declarationReference.packageName}\" could not be located`;\n        return result;\n      }\n    } else {\n      // If the package name is omitted, try to infer it from the context\n      if (contextApiItem !== undefined) {\n        apiPackage = contextApiItem.getAssociatedPackage();\n      }\n\n      if (apiPackage === undefined) {\n        result.errorMessage =\n          `The reference does not include a package name, and the package could not be inferred` +\n          ` from the context`;\n        return result;\n      }\n    }\n\n    const importPath: string = declarationReference.importPath || '';\n\n    const foundEntryPoints: ReadonlyArray<ApiEntryPoint> = apiPackage.findEntryPointsByPath(importPath);\n    if (foundEntryPoints.length !== 1) {\n      result.errorMessage = `The import path \"${importPath}\" could not be resolved`;\n      return result;\n    }\n\n    let currentItem: ApiItem = foundEntryPoints[0];\n\n    // Now search for the member reference\n    for (const memberReference of declarationReference.memberReferences) {\n      if (memberReference.memberSymbol !== undefined) {\n        result.errorMessage = `Symbols are not yet supported in declaration references`;\n        return result;\n      }\n\n      if (memberReference.memberIdentifier === undefined) {\n        result.errorMessage = `Missing member identifier`;\n        return result;\n      }\n\n      const identifier: string = memberReference.memberIdentifier.identifier;\n\n      if (!ApiItemContainerMixin.isBaseClassOf(currentItem)) {\n        // For example, {@link MyClass.myMethod.X} is invalid because methods cannot contain members\n        result.errorMessage = `Unable to resolve ${JSON.stringify(\n          identifier\n        )} because ${currentItem.getScopedNameWithinPackage()} cannot act as a container`;\n        return result;\n      }\n\n      const foundMembers: ReadonlyArray<ApiItem> = currentItem.findMembersByName(identifier);\n      if (foundMembers.length === 0) {\n        result.errorMessage = `The member reference ${JSON.stringify(identifier)} was not found`;\n        return result;\n      }\n\n      const memberSelector: DocMemberSelector | undefined = memberReference.selector;\n      if (memberSelector === undefined) {\n        if (foundMembers.length > 1) {\n          result.errorMessage = `The member reference ${JSON.stringify(identifier)} was ambiguous`;\n          return result;\n        }\n        currentItem = foundMembers[0];\n      } else {\n        let memberSelectorResult: IResolveDeclarationReferenceResult;\n        switch (memberSelector.selectorKind) {\n          case SelectorKind.System:\n            memberSelectorResult = this._selectUsingSystemSelector(foundMembers, memberSelector, identifier);\n            break;\n          case SelectorKind.Index:\n            memberSelectorResult = this._selectUsingIndexSelector(foundMembers, memberSelector, identifier);\n            break;\n          default:\n            result.errorMessage = `The selector \"${memberSelector.selector}\" is not a supported selector type`;\n            return result;\n        }\n        if (memberSelectorResult.resolvedApiItem === undefined) {\n          return memberSelectorResult;\n        }\n        currentItem = memberSelectorResult.resolvedApiItem;\n      }\n    }\n    result.resolvedApiItem = currentItem;\n    return result;\n  }\n\n  private _selectUsingSystemSelector(\n    foundMembers: ReadonlyArray<ApiItem>,\n    memberSelector: DocMemberSelector,\n    identifier: string\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    const selectorName: string = memberSelector.selector;\n\n    let selectorItemKind: ApiItemKind;\n    switch (selectorName) {\n      case 'class':\n        selectorItemKind = ApiItemKind.Class;\n        break;\n      case 'enum':\n        selectorItemKind = ApiItemKind.Enum;\n        break;\n      case 'function':\n        selectorItemKind = ApiItemKind.Function;\n        break;\n      case 'interface':\n        selectorItemKind = ApiItemKind.Interface;\n        break;\n      case 'namespace':\n        selectorItemKind = ApiItemKind.Namespace;\n        break;\n      case 'type':\n        selectorItemKind = ApiItemKind.TypeAlias;\n        break;\n      case 'variable':\n        selectorItemKind = ApiItemKind.Variable;\n        break;\n      default:\n        result.errorMessage = `Unsupported system selector \"${selectorName}\"`;\n        return result;\n    }\n\n    const matches: ApiItem[] = foundMembers.filter((x) => x.kind === selectorItemKind);\n    if (matches.length === 0) {\n      result.errorMessage =\n        `A declaration for \"${identifier}\" was not found that matches the` +\n        ` TSDoc selector \"${selectorName}\"`;\n      return result;\n    }\n    if (matches.length > 1) {\n      result.errorMessage = `More than one declaration \"${identifier}\" matches the TSDoc selector \"${selectorName}\"`;\n    }\n    result.resolvedApiItem = matches[0];\n    return result;\n  }\n\n  private _selectUsingIndexSelector(\n    foundMembers: ReadonlyArray<ApiItem>,\n    memberSelector: DocMemberSelector,\n    identifier: string\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    const selectedMembers: ApiItem[] = [];\n\n    const selectorOverloadIndex: number = parseInt(memberSelector.selector);\n    for (const foundMember of foundMembers) {\n      if (ApiParameterListMixin.isBaseClassOf(foundMember)) {\n        if (foundMember.overloadIndex === selectorOverloadIndex) {\n          selectedMembers.push(foundMember);\n        }\n      }\n    }\n\n    if (selectedMembers.length === 0) {\n      result.errorMessage =\n        `An overload for ${JSON.stringify(identifier)} was not found that matches` +\n        ` the TSDoc selector \":${selectorOverloadIndex}\"`;\n      return result;\n    }\n\n    if (selectedMembers.length === 1) {\n      result.resolvedApiItem = selectedMembers[0];\n      return result;\n    }\n\n    result.errorMessage = `The member reference ${JSON.stringify(identifier)} was ambiguous`;\n    return result;\n  }\n}\n"]}
+{"version":3,"file":"ModelReferenceResolver.js","sourceRoot":"","sources":["../../src/model/ModelReferenceResolver.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,4CAA4F;AAC5F,8CAAwD;AAIxD,2EAAwE;AACxE,2EAAwE;AAoBxE;;;;;;;GAOG;AACH,MAAa,sBAAsB;IAGjC,YAAmB,QAAkB;QACnC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,OAAO,CACZ,oBAA6C,EAC7C,cAAmC;QAEnC,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,IAAI,UAAU,GAA2B,SAAS,CAAC;QAEnD,iCAAiC;QACjC,IAAI,oBAAoB,CAAC,WAAW,KAAK,SAAS,EAAE;YAClD,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAClF,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,MAAM,CAAC,YAAY,GAAG,gBAAgB,oBAAoB,CAAC,WAAW,wBAAwB,CAAC;gBAC/F,OAAO,MAAM,CAAC;aACf;SACF;aAAM;YACL,mEAAmE;YACnE,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,UAAU,GAAG,cAAc,CAAC,oBAAoB,EAAE,CAAC;aACpD;YAED,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,MAAM,CAAC,YAAY;oBACjB,sFAAsF;wBACtF,mBAAmB,CAAC;gBACtB,OAAO,MAAM,CAAC;aACf;SACF;QAED,MAAM,UAAU,GAAW,oBAAoB,CAAC,UAAU,IAAI,EAAE,CAAC;QAEjE,MAAM,gBAAgB,GAAiC,UAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,MAAM,CAAC,YAAY,GAAG,oBAAoB,UAAU,yBAAyB,CAAC;YAC9E,OAAO,MAAM,CAAC;SACf;QAED,IAAI,WAAW,GAAY,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAE/C,sCAAsC;QACtC,KAAK,MAAM,eAAe,IAAI,oBAAoB,CAAC,gBAAgB,EAAE;YACnE,IAAI,eAAe,CAAC,YAAY,KAAK,SAAS,EAAE;gBAC9C,MAAM,CAAC,YAAY,GAAG,yDAAyD,CAAC;gBAChF,OAAO,MAAM,CAAC;aACf;YAED,IAAI,eAAe,CAAC,gBAAgB,KAAK,SAAS,EAAE;gBAClD,MAAM,CAAC,YAAY,GAAG,2BAA2B,CAAC;gBAClD,OAAO,MAAM,CAAC;aACf;YAED,MAAM,UAAU,GAAW,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC;YAEvE,IAAI,CAAC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;gBACrD,4FAA4F;gBAC5F,MAAM,CAAC,YAAY,GAAG,qBAAqB,IAAI,CAAC,SAAS,CACvD,UAAU,CACX,YAAY,WAAW,CAAC,0BAA0B,EAAE,4BAA4B,CAAC;gBAClF,OAAO,MAAM,CAAC;aACf;YAED,MAAM,YAAY,GAA2B,WAAW,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACvF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;gBACzF,OAAO,MAAM,CAAC;aACf;YAED,MAAM,cAAc,GAAkC,eAAe,CAAC,QAAQ,CAAC;YAC/E,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC3B,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;oBACzF,OAAO,MAAM,CAAC;iBACf;gBACD,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;aAC/B;iBAAM;gBACL,IAAI,oBAAwD,CAAC;gBAC7D,QAAQ,cAAc,CAAC,YAAY,EAAE;oBACnC,KAAK,oBAAY,CAAC,MAAM;wBACtB,oBAAoB,GAAG,IAAI,CAAC,0BAA0B,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;wBACjG,MAAM;oBACR,KAAK,oBAAY,CAAC,KAAK;wBACrB,oBAAoB,GAAG,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;wBAChG,MAAM;oBACR;wBACE,MAAM,CAAC,YAAY,GAAG,iBAAiB,cAAc,CAAC,QAAQ,oCAAoC,CAAC;wBACnG,OAAO,MAAM,CAAC;iBACjB;gBACD,IAAI,oBAAoB,CAAC,eAAe,KAAK,SAAS,EAAE;oBACtD,OAAO,oBAAoB,CAAC;iBAC7B;gBACD,WAAW,GAAG,oBAAoB,CAAC,eAAe,CAAC;aACpD;SACF;QACD,MAAM,CAAC,eAAe,GAAG,WAAW,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,0BAA0B,CAChC,YAAoC,EACpC,cAAiC,EACjC,UAAkB;QAElB,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,MAAM,YAAY,GAAW,cAAc,CAAC,QAAQ,CAAC;QAErD,IAAI,gBAA6B,CAAC;QAClC,QAAQ,YAAY,EAAE;YACpB,KAAK,OAAO;gBACV,gBAAgB,GAAG,qBAAW,CAAC,KAAK,CAAC;gBACrC,MAAM;YACR,KAAK,MAAM;gBACT,gBAAgB,GAAG,qBAAW,CAAC,IAAI,CAAC;gBACpC,MAAM;YACR,KAAK,UAAU;gBACb,gBAAgB,GAAG,qBAAW,CAAC,QAAQ,CAAC;gBACxC,MAAM;YACR,KAAK,WAAW;gBACd,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,WAAW;gBACd,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,MAAM;gBACT,gBAAgB,GAAG,qBAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR,KAAK,UAAU;gBACb,gBAAgB,GAAG,qBAAW,CAAC,QAAQ,CAAC;gBACxC,MAAM;YACR;gBACE,MAAM,CAAC,YAAY,GAAG,gCAAgC,YAAY,GAAG,CAAC;gBACtE,OAAO,MAAM,CAAC;SACjB;QAED,MAAM,OAAO,GAAc,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;QACnF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,MAAM,CAAC,YAAY;gBACjB,sBAAsB,UAAU,kCAAkC;oBAClE,oBAAoB,YAAY,GAAG,CAAC;YACtC,OAAO,MAAM,CAAC;SACf;QACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,CAAC,YAAY,GAAG,8BAA8B,UAAU,iCAAiC,YAAY,GAAG,CAAC;SAChH;QACD,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,yBAAyB,CAC/B,YAAoC,EACpC,cAAiC,EACjC,UAAkB;QAElB,MAAM,MAAM,GAAuC;YACjD,eAAe,EAAE,SAAS;YAC1B,YAAY,EAAE,SAAS;SACxB,CAAC;QAEF,MAAM,eAAe,GAAc,EAAE,CAAC;QAEtC,MAAM,qBAAqB,GAAW,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxE,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;YACtC,IAAI,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;gBACpD,IAAI,WAAW,CAAC,aAAa,KAAK,qBAAqB,EAAE;oBACvD,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBACnC;aACF;SACF;QAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,MAAM,CAAC,YAAY;gBACjB,mBAAmB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,6BAA6B;oBAC1E,yBAAyB,qBAAqB,GAAG,CAAC;YACpD,OAAO,MAAM,CAAC;SACf;QAED,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,YAAY,GAAG,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACzF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AArMD,wDAqMC","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 { DocDeclarationReference, DocMemberSelector, SelectorKind } from '@microsoft/tsdoc';\nimport { ApiItem, ApiItemKind } from '../items/ApiItem';\nimport { ApiModel } from './ApiModel';\nimport { ApiPackage } from './ApiPackage';\nimport { ApiEntryPoint } from './ApiEntryPoint';\nimport { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\n\n/**\n * Result object for {@link ApiModel.resolveDeclarationReference}.\n *\n * @public\n */\nexport interface IResolveDeclarationReferenceResult {\n  /**\n   * The referenced ApiItem, if the declaration reference could be resolved.\n   */\n  resolvedApiItem: ApiItem | undefined;\n\n  /**\n   * If resolvedApiItem is undefined, then this will always contain an error message explaining why the\n   * resolution failed.\n   */\n  errorMessage: string | undefined;\n}\n\n/**\n * This resolves a TSDoc declaration reference by walking the `ApiModel` hierarchy.\n *\n * @remarks\n *\n * This class is analogous to `AstReferenceResolver` from the `@microsoft/api-extractor` project,\n * which resolves declaration references by walking the compiler state.\n */\nexport class ModelReferenceResolver {\n  private readonly _apiModel: ApiModel;\n\n  public constructor(apiModel: ApiModel) {\n    this._apiModel = apiModel;\n  }\n\n  public resolve(\n    declarationReference: DocDeclarationReference,\n    contextApiItem: ApiItem | undefined\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    let apiPackage: ApiPackage | undefined = undefined;\n\n    // Is this an absolute reference?\n    if (declarationReference.packageName !== undefined) {\n      apiPackage = this._apiModel.tryGetPackageByName(declarationReference.packageName);\n      if (apiPackage === undefined) {\n        result.errorMessage = `The package \"${declarationReference.packageName}\" could not be located`;\n        return result;\n      }\n    } else {\n      // If the package name is omitted, try to infer it from the context\n      if (contextApiItem !== undefined) {\n        apiPackage = contextApiItem.getAssociatedPackage();\n      }\n\n      if (apiPackage === undefined) {\n        result.errorMessage =\n          `The reference does not include a package name, and the package could not be inferred` +\n          ` from the context`;\n        return result;\n      }\n    }\n\n    const importPath: string = declarationReference.importPath || '';\n\n    const foundEntryPoints: ReadonlyArray<ApiEntryPoint> = apiPackage.findEntryPointsByPath(importPath);\n    if (foundEntryPoints.length !== 1) {\n      result.errorMessage = `The import path \"${importPath}\" could not be resolved`;\n      return result;\n    }\n\n    let currentItem: ApiItem = foundEntryPoints[0];\n\n    // Now search for the member reference\n    for (const memberReference of declarationReference.memberReferences) {\n      if (memberReference.memberSymbol !== undefined) {\n        result.errorMessage = `Symbols are not yet supported in declaration references`;\n        return result;\n      }\n\n      if (memberReference.memberIdentifier === undefined) {\n        result.errorMessage = `Missing member identifier`;\n        return result;\n      }\n\n      const identifier: string = memberReference.memberIdentifier.identifier;\n\n      if (!ApiItemContainerMixin.isBaseClassOf(currentItem)) {\n        // For example, {@link MyClass.myMethod.X} is invalid because methods cannot contain members\n        result.errorMessage = `Unable to resolve ${JSON.stringify(\n          identifier\n        )} because ${currentItem.getScopedNameWithinPackage()} cannot act as a container`;\n        return result;\n      }\n\n      const foundMembers: ReadonlyArray<ApiItem> = currentItem.findMembersByName(identifier);\n      if (foundMembers.length === 0) {\n        result.errorMessage = `The member reference ${JSON.stringify(identifier)} was not found`;\n        return result;\n      }\n\n      const memberSelector: DocMemberSelector | undefined = memberReference.selector;\n      if (memberSelector === undefined) {\n        if (foundMembers.length > 1) {\n          result.errorMessage = `The member reference ${JSON.stringify(identifier)} was ambiguous`;\n          return result;\n        }\n        currentItem = foundMembers[0];\n      } else {\n        let memberSelectorResult: IResolveDeclarationReferenceResult;\n        switch (memberSelector.selectorKind) {\n          case SelectorKind.System:\n            memberSelectorResult = this._selectUsingSystemSelector(foundMembers, memberSelector, identifier);\n            break;\n          case SelectorKind.Index:\n            memberSelectorResult = this._selectUsingIndexSelector(foundMembers, memberSelector, identifier);\n            break;\n          default:\n            result.errorMessage = `The selector \"${memberSelector.selector}\" is not a supported selector type`;\n            return result;\n        }\n        if (memberSelectorResult.resolvedApiItem === undefined) {\n          return memberSelectorResult;\n        }\n        currentItem = memberSelectorResult.resolvedApiItem;\n      }\n    }\n    result.resolvedApiItem = currentItem;\n    return result;\n  }\n\n  private _selectUsingSystemSelector(\n    foundMembers: ReadonlyArray<ApiItem>,\n    memberSelector: DocMemberSelector,\n    identifier: string\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    const selectorName: string = memberSelector.selector;\n\n    let selectorItemKind: ApiItemKind;\n    switch (selectorName) {\n      case 'class':\n        selectorItemKind = ApiItemKind.Class;\n        break;\n      case 'enum':\n        selectorItemKind = ApiItemKind.Enum;\n        break;\n      case 'function':\n        selectorItemKind = ApiItemKind.Function;\n        break;\n      case 'interface':\n        selectorItemKind = ApiItemKind.Interface;\n        break;\n      case 'namespace':\n        selectorItemKind = ApiItemKind.Namespace;\n        break;\n      case 'type':\n        selectorItemKind = ApiItemKind.TypeAlias;\n        break;\n      case 'variable':\n        selectorItemKind = ApiItemKind.Variable;\n        break;\n      default:\n        result.errorMessage = `Unsupported system selector \"${selectorName}\"`;\n        return result;\n    }\n\n    const matches: ApiItem[] = foundMembers.filter((x) => x.kind === selectorItemKind);\n    if (matches.length === 0) {\n      result.errorMessage =\n        `A declaration for \"${identifier}\" was not found that matches the` +\n        ` TSDoc selector \"${selectorName}\"`;\n      return result;\n    }\n    if (matches.length > 1) {\n      result.errorMessage = `More than one declaration \"${identifier}\" matches the TSDoc selector \"${selectorName}\"`;\n    }\n    result.resolvedApiItem = matches[0];\n    return result;\n  }\n\n  private _selectUsingIndexSelector(\n    foundMembers: ReadonlyArray<ApiItem>,\n    memberSelector: DocMemberSelector,\n    identifier: string\n  ): IResolveDeclarationReferenceResult {\n    const result: IResolveDeclarationReferenceResult = {\n      resolvedApiItem: undefined,\n      errorMessage: undefined\n    };\n\n    const selectedMembers: ApiItem[] = [];\n\n    const selectorOverloadIndex: number = parseInt(memberSelector.selector);\n    for (const foundMember of foundMembers) {\n      if (ApiParameterListMixin.isBaseClassOf(foundMember)) {\n        if (foundMember.overloadIndex === selectorOverloadIndex) {\n          selectedMembers.push(foundMember);\n        }\n      }\n    }\n\n    if (selectedMembers.length === 0) {\n      result.errorMessage =\n        `An overload for ${JSON.stringify(identifier)} was not found that matches` +\n        ` the TSDoc selector \":${selectorOverloadIndex}\"`;\n      return result;\n    }\n\n    if (selectedMembers.length === 1) {\n      result.resolvedApiItem = selectedMembers[0];\n      return result;\n    }\n\n    result.errorMessage = `The member reference ${JSON.stringify(identifier)} was ambiguous`;\n    return result;\n  }\n}\n"]}

package/lib/model/Parameter.d.ts

@@ -8,6 +8,7 @@ import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
 export interface IParameterOptions {
     name: string;
     parameterTypeExcerpt: Excerpt;
+    isOptional: boolean;
     parent: ApiParameterListMixin;
 }
 /**
@@ -36,6 +37,10 @@ export declare class Parameter {
      * The parameter name.
      */
     name: string;
+    /**
+     * Whether the parameter is optional.
+     */
+    isOptional: boolean;
     private _parent;
     constructor(options: IParameterOptions);
     /**

package/lib/model/Parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../src/model/Parameter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,EAAE,OAAO,CAAC;IAC9B,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;OAEG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,OAAO,CAAwB;gBAEpB,OAAO,EAAE,iBAAiB;IAM7C;;OAEG;IACH,IAAW,eAAe,IAAI,KAAK,CAAC,aAAa,GAAG,SAAS,CAM5D;CACF"}
+{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../src/model/Parameter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB,EAAE,OAAO,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;OAEG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACI,UAAU,EAAE,OAAO,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAwB;gBAEpB,OAAO,EAAE,iBAAiB;IAO7C;;OAEG;IACH,IAAW,eAAe,IAAI,KAAK,CAAC,aAAa,GAAG,SAAS,CAM5D;CACF"}

package/lib/model/Parameter.js

@@ -25,6 +25,7 @@ class Parameter {
     constructor(options) {
         this.name = options.name;
         this.parameterTypeExcerpt = options.parameterTypeExcerpt;
+        this.isOptional = options.isOptional;
         this._parent = options.parent;
     }
     /**

package/lib/model/Parameter.js.map

@@ -1 +1 @@
-{"version":3,"file":"Parameter.js","sourceRoot":"","sources":["../../src/model/Parameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,kEAA+D;AAc/D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,SAAS;IAapB,YAAmB,OAA0B;QAC3C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,OAAO,YAAY,qCAAiB,EAAE;YAC7C,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACtE;SACF;IACH,CAAC;CACF;AA7BD,8BA6BC","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 { ApiDocumentedItem } from '../items/ApiDocumentedItem';\nimport { Excerpt } from '../mixins/Excerpt';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\n\n/**\n * Constructor options for {@link Parameter}.\n * @public\n */\nexport interface IParameterOptions {\n  name: string;\n  parameterTypeExcerpt: Excerpt;\n  parent: ApiParameterListMixin;\n}\n\n/**\n * Represents a named parameter for a function-like declaration.\n *\n * @remarks\n *\n * `Parameter` represents a TypeScript declaration such as `x: number` in this example:\n *\n * ```ts\n * export function add(x: number, y: number): number {\n *   return x + y;\n * }\n * ```\n *\n * `Parameter` objects belong to the {@link (ApiParameterListMixin:interface).parameters} collection.\n *\n * @public\n */\nexport class Parameter {\n  /**\n   * An {@link Excerpt} that describes the type of the parameter.\n   */\n  public readonly parameterTypeExcerpt: Excerpt;\n\n  /**\n   * The parameter name.\n   */\n  public name: string;\n\n  private _parent: ApiParameterListMixin;\n\n  public constructor(options: IParameterOptions) {\n    this.name = options.name;\n    this.parameterTypeExcerpt = options.parameterTypeExcerpt;\n    this._parent = options.parent;\n  }\n\n  /**\n   * Returns the `@param` documentation for this parameter, if present.\n   */\n  public get tsdocParamBlock(): tsdoc.DocParamBlock | undefined {\n    if (this._parent instanceof ApiDocumentedItem) {\n      if (this._parent.tsdocComment) {\n        return this._parent.tsdocComment.params.tryGetBlockByName(this.name);\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"Parameter.js","sourceRoot":"","sources":["../../src/model/Parameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,kEAA+D;AAe/D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,SAAS;IAkBpB,YAAmB,OAA0B;QAC3C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,OAAO,YAAY,qCAAiB,EAAE;YAC7C,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACtE;SACF;IACH,CAAC;CACF;AAnCD,8BAmCC","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 { ApiDocumentedItem } from '../items/ApiDocumentedItem';\nimport { Excerpt } from '../mixins/Excerpt';\nimport { ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\n\n/**\n * Constructor options for {@link Parameter}.\n * @public\n */\nexport interface IParameterOptions {\n  name: string;\n  parameterTypeExcerpt: Excerpt;\n  isOptional: boolean;\n  parent: ApiParameterListMixin;\n}\n\n/**\n * Represents a named parameter for a function-like declaration.\n *\n * @remarks\n *\n * `Parameter` represents a TypeScript declaration such as `x: number` in this example:\n *\n * ```ts\n * export function add(x: number, y: number): number {\n *   return x + y;\n * }\n * ```\n *\n * `Parameter` objects belong to the {@link (ApiParameterListMixin:interface).parameters} collection.\n *\n * @public\n */\nexport class Parameter {\n  /**\n   * An {@link Excerpt} that describes the type of the parameter.\n   */\n  public readonly parameterTypeExcerpt: Excerpt;\n\n  /**\n   * The parameter name.\n   */\n  public name: string;\n\n  /**\n   * Whether the parameter is optional.\n   */\n  public isOptional: boolean;\n\n  private _parent: ApiParameterListMixin;\n\n  public constructor(options: IParameterOptions) {\n    this.name = options.name;\n    this.parameterTypeExcerpt = options.parameterTypeExcerpt;\n    this.isOptional = options.isOptional;\n    this._parent = options.parent;\n  }\n\n  /**\n   * Returns the `@param` documentation for this parameter, if present.\n   */\n  public get tsdocParamBlock(): tsdoc.DocParamBlock | undefined {\n    if (this._parent instanceof ApiDocumentedItem) {\n      if (this._parent.tsdocComment) {\n        return this._parent.tsdocComment.params.tryGetBlockByName(this.name);\n      }\n    }\n  }\n}\n"]}

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@microsoft/api-extractor-model",
-  "version": "7.15.4",
+  "version": "7.16.2",
   "description": "A helper library for loading and saving the .api.json files created by API Extractor",
   "repository": {
     "type": "git",
     "url": "https://github.com/microsoft/rushstack.git",
-    "directory": "apps/api-extractor-model"
+    "directory": "libraries/api-extractor-model"
   },
   "homepage": "https://api-extractor.com",
   "main": "lib/index.js",
   "typings": "dist/rollup.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@microsoft/tsdoc": "0.13.2",
-    "@microsoft/tsdoc-config": "~0.15.2",
-    "@rushstack/node-core-library": "3.45.1"
+    "@microsoft/tsdoc": "0.14.1",
+    "@microsoft/tsdoc-config": "~0.16.1",
+    "@rushstack/node-core-library": "3.45.2"
   },
   "devDependencies": {
-    "@rushstack/eslint-config": "2.5.2",
-    "@rushstack/heft": "0.44.2",
-    "@rushstack/heft-node-rig": "1.7.1",
+    "@rushstack/eslint-config": "2.5.3",
+    "@rushstack/heft": "0.44.9",
+    "@rushstack/heft-node-rig": "1.8.7",
     "@types/heft-jest": "1.0.1",
     "@types/node": "12.20.24"
   },
@@ -28,5 +28,5 @@
     "_phase:build": "heft build --clean",
     "_phase:test": "heft test --no-build"
   },
-  "readme": "# @microsoft/api-extractor-model\n\nUse this library to read and write *.api.json files as defined by the [API Extractor](https://api-extractor.com/) tool.\nThese files are used to generate a documentation website for your TypeScript package.  The files store the\nAPI signatures and doc comments that were extracted from your package.\n\nAPI documentation for this package: https://rushstack.io/pages/api/api-extractor-model/\n\n## Example Usage\n\nThe following code sample shows how to load `example.api.json`, which would be generated by API Extractor\nwhen it analyzes a hypothetical NPM package called `example`:\n\n```ts\nimport { ApiModel, ApiPackage } from '@microsoft/api-extractor-model';\n\nconst apiModel: ApiModel = new ApiModel();\nconst apiPackage: ApiPackage = apiModel.loadPackage('example.api.json');\n\nfor (const member of apiPackage.members) {\n  console.log(member.displayName);\n}\n```\n\nThe `ApiModel` is acts as a container for various packages that are loaded and operated on as a group.\nFor example, a documentation tool may need to resolve `@link` references across different packages.\nIn this case we would load the various packages into the `ApiModel`, and then use\nthe `ApiModel.resolveDeclarationReference()` to resolve the `@link` targets.\n\nThe data structure forms a tree of various classes that start with the `Api` prefix.  The nesting hierarchy\nmight look like this:\n\n```\n- ApiModel\n  - ApiPackage\n    - ApiEntryPoint\n      - ApiClass\n        - ApiMethod\n        - ApiProperty\n      - ApiEnum\n        - ApiEnumMember\n      - ApiInterface\n        - ApiMethodSignature\n        - ApiPropertySignature\n      - ApiNamespace\n        - (ApiClass, ApiEnum, ApiInterface, ...)\n```\n\nYou can use the `ApiItem.members` property to traverse this tree.\n\nNote that the non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\nTypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\nfeatures that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\nto extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\nthe function that generates a subclass, an interface that describes the members of the subclass, and\na namespace containing static members of the class.\n\n> For a complete project that uses these APIs to generate an API reference web site,\n> see the [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) source code.\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/master/apps/api-extractor-model/CHANGELOG.md) - Find\n  out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/api-extractor-model/)\n\nAPI Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
+  "readme": "# @microsoft/api-extractor-model\n\nUse this library to read and write *.api.json files as defined by the [API Extractor](https://api-extractor.com/) tool.\nThese files are used to generate a documentation website for your TypeScript package.  The files store the\nAPI signatures and doc comments that were extracted from your package.\n\nAPI documentation for this package: https://rushstack.io/pages/api/api-extractor-model/\n\n## Example Usage\n\nThe following code sample shows how to load `example.api.json`, which would be generated by API Extractor\nwhen it analyzes a hypothetical NPM package called `example`:\n\n```ts\nimport { ApiModel, ApiPackage } from '@microsoft/api-extractor-model';\n\nconst apiModel: ApiModel = new ApiModel();\nconst apiPackage: ApiPackage = apiModel.loadPackage('example.api.json');\n\nfor (const member of apiPackage.members) {\n  console.log(member.displayName);\n}\n```\n\nThe `ApiModel` is acts as a container for various packages that are loaded and operated on as a group.\nFor example, a documentation tool may need to resolve `@link` references across different packages.\nIn this case we would load the various packages into the `ApiModel`, and then use\nthe `ApiModel.resolveDeclarationReference()` to resolve the `@link` targets.\n\nThe data structure forms a tree of various classes that start with the `Api` prefix.  The nesting hierarchy\nmight look like this:\n\n```\n- ApiModel\n  - ApiPackage\n    - ApiEntryPoint\n      - ApiClass\n        - ApiMethod\n        - ApiProperty\n      - ApiEnum\n        - ApiEnumMember\n      - ApiInterface\n        - ApiMethodSignature\n        - ApiPropertySignature\n      - ApiNamespace\n        - (ApiClass, ApiEnum, ApiInterface, ...)\n```\n\nYou can use the `ApiItem.members` property to traverse this tree.\n\nNote that the non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\nTypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\nfeatures that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\nto extend more than one base class).  The \"mixin\" is a TypeScript merged declaration with three components:\nthe function that generates a subclass, an interface that describes the members of the subclass, and\na namespace containing static members of the class.\n\n> For a complete project that uses these APIs to generate an API reference web site,\n> see the [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) source code.\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/main/libraries/api-extractor-model/CHANGELOG.md) - Find\n  out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/api-extractor-model/)\n\nAPI Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
 }