From 6e980e43e6065349bd5aa1c23621d754ec5e4d89 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 20 Jul 2019 00:07:18 -0700 Subject: [PATCH 01/22] Set up the new ApiItem.canonicalReference property --- apps/api-extractor-model/src/items/ApiItem.ts | 54 ++++++++++++++++--- .../src/mixins/ApiItemContainerMixin.ts | 6 +-- common/reviews/api/api-extractor-model.api.md | 9 +++- 3 files changed, 56 insertions(+), 13 deletions(-) diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts index a588ac0b2f9..9ca448a2195 100644 --- a/apps/api-extractor-model/src/items/ApiItem.ts +++ b/apps/api-extractor-model/src/items/ApiItem.ts @@ -1,10 +1,12 @@ // 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/beta/DeclarationReference'; import { Constructor, PropertiesOf } from '../mixins/Mixin'; import { ApiPackage } from '../model/ApiPackage'; import { ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; import { DeserializerContext } from '../model/DeserializerContext'; +import { InternalError } from '@microsoft/node-core-library'; /** * The type returned by the {@link ApiItem.kind} property, which can be used to easily distinguish subclasses of @@ -46,12 +48,10 @@ export interface IApiItemJson { kind: ApiItemKind; } -/** - * PRIVATE - * Allows ApiItemContainerMixin to assign the parent. - */ +// PRIVATE - Allows ApiItemContainerMixin to assign the parent. +// // tslint:disable-next-line:variable-name -export const ApiItem_parent: unique symbol = Symbol('ApiItem._parent'); +export const ApiItem_setParent: unique symbol = Symbol('ApiItem._setParent'); /** * The abstract base class for all members of an `ApiModel` object. @@ -62,7 +62,8 @@ export const ApiItem_parent: unique symbol = Symbol('ApiItem._parent'); * @public */ export class ApiItem { - public [ApiItem_parent]: ApiItem | undefined; + private _canonicalReference: DeclarationReference | undefined; + private _parent: ApiItem | undefined; public static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem { // The Deserializer class is coupled with a ton of other classes, so we delay loading it @@ -94,6 +95,22 @@ export class ApiItem { throw new Error('ApiItem.kind was not implemented by the child class'); } + /** + * Warning: This API is used internally by API extractor but is not yet ready for general usage. + * + * @remarks + * + * Returns a `DeclarationReference` object using the experimental new declaration reference notation. + * + * @beta + */ + public get canonicalReference(): DeclarationReference { + if (!this._canonicalReference) { + this._canonicalReference = this.buildCanonicalReference(); + } + return this._canonicalReference; + } + /** * Returns a string key that can be used to efficiently retrieve an `ApiItem` from an `ApiItemContainerMixin`. * The key is unique within the container. Its format is undocumented and may change at any time. @@ -105,7 +122,7 @@ export class ApiItem { * @virtual */ public get containerKey(): string { - throw new Error('ApiItem.containerKey was not implemented by the child class'); + throw new InternalError('ApiItem.containerKey was not implemented by the child class'); } /** @@ -135,7 +152,7 @@ export class ApiItem { * @virtual */ public get parent(): ApiItem | undefined { - return this[ApiItem_parent]; + return this._parent; } /** @@ -215,6 +232,27 @@ export class ApiItem { public getSortKey(): string { return this.containerKey; } + + /** + * PRIVATE + * + * @privateRemarks + * Allows ApiItemContainerMixin to assign the parent. + * + * @internal + */ + public [ApiItem_setParent](parent: ApiItem | undefined): void { + this._parent = parent; + this._canonicalReference = undefined; + } + + /** + * Builds the cached object used by the `canonicalReference` property. + * @virtual + */ + protected buildCanonicalReference(): DeclarationReference { + throw new InternalError('ApiItem.canonicalReference was not implemented by the child class'); + } } /** diff --git a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts index 78da377cae6..def0bc0d625 100644 --- a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information.s -import { ApiItem, ApiItem_parent, IApiItemJson, IApiItemOptions, IApiItemConstructor } from '../items/ApiItem'; +import { ApiItem, ApiItem_setParent, IApiItemJson, IApiItemOptions, IApiItemConstructor } from '../items/ApiItem'; import { ApiNameMixin } from './ApiNameMixin'; import { DeserializerContext } from '../model/DeserializerContext'; @@ -135,7 +135,7 @@ export function ApiItemContainerMixin(ba throw new Error('Another member has already been added with the same name and containerKey'); } - const existingParent: ApiItem | undefined = member[ApiItem_parent]; + const existingParent: ApiItem | undefined = member.parent; if (existingParent !== undefined) { throw new Error(`This item has already been added to another container: "${existingParent.displayName}"`); } @@ -145,7 +145,7 @@ export function ApiItemContainerMixin(ba this[_membersSorted] = false; this[_membersByContainerKey].set(member.containerKey, member); - member[ApiItem_parent] = this; + member[ApiItem_setParent](this); } public tryGetMemberByKey(containerKey: string): ApiItem | undefined { diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index ea85cf08eb1..39d363f8946 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -4,6 +4,7 @@ ```ts +import { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { DocDeclarationReference } from '@microsoft/tsdoc'; import { IJsonFileSaveOptions } from '@microsoft/node-core-library'; import * as tsdoc from '@microsoft/tsdoc'; @@ -211,10 +212,14 @@ export class ApiInterface extends ApiInterface_base { // @public export class ApiItem { - // (undocumented) - [ApiItem_parent]: ApiItem | undefined; + // @internal + [ApiItem_setParent](parent: ApiItem | undefined): void; constructor(options: IApiItemOptions); // @virtual + protected buildCanonicalReference(): DeclarationReference; + // @beta + readonly canonicalReference: DeclarationReference; + // @virtual readonly containerKey: string; // (undocumented) static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem; From efaf045d919c75dcbb13d74b566a543f4e48ddbd Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 20 Jul 2019 01:36:23 -0700 Subject: [PATCH 02/22] Implement buildCanonicalReference() for each ApiItem subclass --- .../src/mixins/ApiNameMixin.ts | 15 +++++++ .../src/model/ApiCallSignature.ts | 9 +++++ .../api-extractor-model/src/model/ApiClass.ts | 8 ++++ .../src/model/ApiConstructSignature.ts | 9 +++++ .../src/model/ApiConstructor.ts | 9 +++++ .../src/model/ApiEntryPoint.ts | 21 ++++++++++ apps/api-extractor-model/src/model/ApiEnum.ts | 8 ++++ .../src/model/ApiEnumMember.ts | 8 ++++ .../src/model/ApiFunction.ts | 9 +++++ .../src/model/ApiIndexSignature.ts | 9 +++++ .../src/model/ApiInterface.ts | 8 ++++ .../src/model/ApiMethod.ts | 9 +++++ .../src/model/ApiMethodSignature.ts | 9 +++++ .../api-extractor-model/src/model/ApiModel.ts | 6 +++ .../src/model/ApiNamespace.ts | 8 ++++ .../src/model/ApiPackage.ts | 6 +++ .../src/model/ApiProperty.ts | 8 ++++ .../src/model/ApiPropertySignature.ts | 8 ++++ .../src/model/ApiTypeAlias.ts | 8 ++++ .../src/model/ApiVariable.ts | 8 ++++ common/reviews/api/api-extractor-model.api.md | 40 +++++++++++++++++++ 21 files changed, 223 insertions(+) diff --git a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts index daa691a790d..674a8776d17 100644 --- a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information.s +import { StringChecks } from '@microsoft/tsdoc/lib/parser/StringChecks'; import { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem'; import { DeserializerContext } from '../model/DeserializerContext'; @@ -46,6 +47,9 @@ export interface ApiNameMixin extends ApiItem { /** @override */ serializeInto(jsonObject: Partial): void; + + /** @internal */ + _getCanonicalReferenceName(): string; } /** @@ -94,6 +98,17 @@ export function ApiNameMixin(baseClass: jsonObject.name = this.name; } + + /** @internal */ + public _getCanonicalReferenceName(): string { + // TODO: This is a temporary workaround for a limitation of the experimental DeclarationReference API. + // We will remove this when the final implementation is in place. + if (StringChecks.explainIfInvalidUnquotedIdentifier(this.name)) { + return JSON.stringify(this.name); + } else { + return this.name; + } + } } return MixedClass; diff --git a/apps/api-extractor-model/src/model/ApiCallSignature.ts b/apps/api-extractor-model/src/model/ApiCallSignature.ts index 4fc3e52688d..605d023f5e3 100644 --- a/apps/api-extractor-model/src/model/ApiCallSignature.ts +++ b/apps/api-extractor-model/src/model/ApiCallSignature.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -69,4 +70,12 @@ export class ApiCallSignature extends ApiTypeParameterListMixin(ApiParameterList public get containerKey(): string { return ApiCallSignature.getContainerKey(this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, '') + .withMeaning(Meaning.Signature) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiClass.ts b/apps/api-extractor-model/src/model/ApiClass.ts index 371a00a8471..f9e456faecb 100644 --- a/apps/api-extractor-model/src/model/ApiClass.ts +++ b/apps/api-extractor-model/src/model/ApiClass.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; @@ -116,4 +117,11 @@ export class ApiClass extends ApiItemContainerMixin(ApiNameMixin(ApiTypeParamete jsonObject.implementsTokenRanges = this.implementsTypes.map(x => x.excerpt.tokenRange); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this.name) + .withMeaning(Meaning.Class); + } } diff --git a/apps/api-extractor-model/src/model/ApiConstructSignature.ts b/apps/api-extractor-model/src/model/ApiConstructSignature.ts index f32adc70717..6cfd62f5139 100644 --- a/apps/api-extractor-model/src/model/ApiConstructSignature.ts +++ b/apps/api-extractor-model/src/model/ApiConstructSignature.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -82,4 +83,12 @@ export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParamete public get containerKey(): string { return ApiConstructSignature.getContainerKey(this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, '') + .withMeaning(Meaning.Signature) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiConstructor.ts b/apps/api-extractor-model/src/model/ApiConstructor.ts index 79488087867..bcd9aca321c 100644 --- a/apps/api-extractor-model/src/model/ApiConstructor.ts +++ b/apps/api-extractor-model/src/model/ApiConstructor.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -62,4 +63,12 @@ export class ApiConstructor extends ApiParameterListMixin(ApiReleaseTagMixin(Api public get containerKey(): string { return ApiConstructor.getContainerKey(this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, '') + .withMeaning(Meaning.Constructor) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiEntryPoint.ts b/apps/api-extractor-model/src/model/ApiEntryPoint.ts index 0b851c952f7..eedbc7af830 100644 --- a/apps/api-extractor-model/src/model/ApiEntryPoint.ts +++ b/apps/api-extractor-model/src/model/ApiEntryPoint.ts @@ -1,9 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, ModuleSource } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; +import { ApiPackage } from './ApiPackage'; /** * Constructor options for {@link ApiEntryPoint}. @@ -51,4 +53,23 @@ export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) // No prefix needed, because ApiEntryPoint is the only possible member of an ApiPackage return this.name; } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + let modulePath: string = ''; + + if (this.parent instanceof ApiPackage) { + modulePath = this.parent.name; + } + + if (this.name) { + modulePath += this.name; + } + + if (modulePath) { + return new DeclarationReference(new ModuleSource(modulePath)); + } + + return DeclarationReference.empty(); + } } diff --git a/apps/api-extractor-model/src/model/ApiEnum.ts b/apps/api-extractor-model/src/model/ApiEnum.ts index 4154f425692..6db9257e895 100644 --- a/apps/api-extractor-model/src/model/ApiEnum.ts +++ b/apps/api-extractor-model/src/model/ApiEnum.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -71,4 +72,11 @@ export class ApiEnum extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMix } super.addMember(member); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Enum); + } } diff --git a/apps/api-extractor-model/src/model/ApiEnumMember.ts b/apps/api-extractor-model/src/model/ApiEnumMember.ts index ebf217516c9..45bd2c3fd15 100644 --- a/apps/api-extractor-model/src/model/ApiEnumMember.ts +++ b/apps/api-extractor-model/src/model/ApiEnumMember.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -86,4 +87,11 @@ export class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredIt jsonObject.initializerTokenRange = this.initializerExcerpt.tokenRange; } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.EnumMember); + } } diff --git a/apps/api-extractor-model/src/model/ApiFunction.ts b/apps/api-extractor-model/src/model/ApiFunction.ts index 8e9588b53ea..9c4d9b04d88 100644 --- a/apps/api-extractor-model/src/model/ApiFunction.ts +++ b/apps/api-extractor-model/src/model/ApiFunction.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -63,4 +64,12 @@ export class ApiFunction extends ApiNameMixin(ApiTypeParameterListMixin(ApiParam public get containerKey(): string { return ApiFunction.getContainerKey(this.name, this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Function) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiIndexSignature.ts b/apps/api-extractor-model/src/model/ApiIndexSignature.ts index da4ca310977..035e9cd9f3c 100644 --- a/apps/api-extractor-model/src/model/ApiIndexSignature.ts +++ b/apps/api-extractor-model/src/model/ApiIndexSignature.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -59,4 +60,12 @@ export class ApiIndexSignature extends ApiParameterListMixin(ApiReleaseTagMixin( public get containerKey(): string { return ApiIndexSignature.getContainerKey(this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, '') + .withMeaning(Meaning.Signature) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiInterface.ts b/apps/api-extractor-model/src/model/ApiInterface.ts index 34a3c5e2ec7..d9757483fc4 100644 --- a/apps/api-extractor-model/src/model/ApiInterface.ts +++ b/apps/api-extractor-model/src/model/ApiInterface.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions, IApiItemContainerJson } from '../mixins/ApiItemContainerMixin'; @@ -103,4 +104,11 @@ export class ApiInterface extends ApiItemContainerMixin(ApiNameMixin(ApiTypePara jsonObject.extendsTokenRanges = this.extendsTypes.map(x => x.excerpt.tokenRange); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Interface); + } } diff --git a/apps/api-extractor-model/src/model/ApiMethod.ts b/apps/api-extractor-model/src/model/ApiMethod.ts index a1aa8c8c1b9..0c67fc7524e 100644 --- a/apps/api-extractor-model/src/model/ApiMethod.ts +++ b/apps/api-extractor-model/src/model/ApiMethod.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; @@ -69,4 +70,12 @@ export class ApiMethod extends ApiNameMixin(ApiTypeParameterListMixin(ApiParamet public get containerKey(): string { return ApiMethod.getContainerKey(this.name, this.isStatic, this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Member) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiMethodSignature.ts b/apps/api-extractor-model/src/model/ApiMethodSignature.ts index 2e8f1ed34f4..6dd27896607 100644 --- a/apps/api-extractor-model/src/model/ApiMethodSignature.ts +++ b/apps/api-extractor-model/src/model/ApiMethodSignature.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions } from '../items/ApiDeclaredItem'; import { ApiParameterListMixin, IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin'; @@ -60,4 +61,12 @@ export class ApiMethodSignature extends ApiNameMixin(ApiTypeParameterListMixin(A public get containerKey(): string { return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Member) + .withOverloadIndex(this.overloadIndex); + } } diff --git a/apps/api-extractor-model/src/model/ApiModel.ts b/apps/api-extractor-model/src/model/ApiModel.ts index 2a9ca55ff4e..6697aaccc76 100644 --- a/apps/api-extractor-model/src/model/ApiModel.ts +++ b/apps/api-extractor-model/src/model/ApiModel.ts @@ -1,6 +1,7 @@ // 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/beta/DeclarationReference'; import { ApiItem, ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin'; import { ApiPackage } from './ApiPackage'; @@ -140,4 +141,9 @@ export class ApiModel extends ApiItemContainerMixin(ApiItem) { contextApiItem: ApiItem | undefined): IResolveDeclarationReferenceResult { return this._resolver.resolve(declarationReference, contextApiItem); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return DeclarationReference.empty(); + } } diff --git a/apps/api-extractor-model/src/model/ApiNamespace.ts b/apps/api-extractor-model/src/model/ApiNamespace.ts index 36ac7dfb4f3..3a8012fa723 100644 --- a/apps/api-extractor-model/src/model/ApiNamespace.ts +++ b/apps/api-extractor-model/src/model/ApiNamespace.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; @@ -59,4 +60,11 @@ export class ApiNamespace extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseT public get containerKey(): string { return ApiNamespace.getContainerKey(this.name); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Namespace); + } } diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index bc21f0ddb06..a4df4061c16 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, ModuleSource } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, ApiItemKind, IApiItemJson } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { JsonFile, IJsonFileSaveOptions, PackageJsonLookup, IPackageJson } from '@microsoft/node-core-library'; @@ -203,4 +204,9 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented this.serializeInto(jsonObject); JsonFile.save(jsonObject, apiJsonFilename, options); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return new DeclarationReference(new ModuleSource(this.name)); + } } diff --git a/apps/api-extractor-model/src/model/ApiProperty.ts b/apps/api-extractor-model/src/model/ApiProperty.ts index ebc6620c905..a3bb92beff0 100644 --- a/apps/api-extractor-model/src/model/ApiProperty.ts +++ b/apps/api-extractor-model/src/model/ApiProperty.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyItem'; @@ -70,4 +71,11 @@ export class ApiProperty extends ApiStaticMixin(ApiPropertyItem) { public get containerKey(): string { return ApiProperty.getContainerKey(this.name, this.isStatic); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Member); + } } diff --git a/apps/api-extractor-model/src/model/ApiPropertySignature.ts b/apps/api-extractor-model/src/model/ApiPropertySignature.ts index 6a54ad50a95..669149ed722 100644 --- a/apps/api-extractor-model/src/model/ApiPropertySignature.ts +++ b/apps/api-extractor-model/src/model/ApiPropertySignature.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyItem'; @@ -52,4 +53,11 @@ export class ApiPropertySignature extends ApiPropertyItem { public get containerKey(): string { return ApiPropertySignature.getContainerKey(this.name); } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Members, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Member); + } } diff --git a/apps/api-extractor-model/src/model/ApiTypeAlias.ts b/apps/api-extractor-model/src/model/ApiTypeAlias.ts index f8306c5eb94..bc28c5571c9 100644 --- a/apps/api-extractor-model/src/model/ApiTypeAlias.ts +++ b/apps/api-extractor-model/src/model/ApiTypeAlias.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; @@ -103,4 +104,11 @@ export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiRele jsonObject.typeTokenRange = this.typeExcerpt.tokenRange; } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.TypeAlias); + } } diff --git a/apps/api-extractor-model/src/model/ApiVariable.ts b/apps/api-extractor-model/src/model/ApiVariable.ts index 68e3b9b4e0a..db6b20584b4 100644 --- a/apps/api-extractor-model/src/model/ApiVariable.ts +++ b/apps/api-extractor-model/src/model/ApiVariable.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. +import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -85,4 +86,11 @@ export class ApiVariable extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem jsonObject.variableTypeTokenRange = this.variableTypeExcerpt.tokenRange; } + + /** @beta @override */ + public buildCanonicalReference(): DeclarationReference { + return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .withMeaning(Meaning.Variable); + } } diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index 39d363f8946..a5ee27bdeee 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -30,6 +30,8 @@ export class AedocDefinitions { // @public export class ApiCallSignature extends ApiCallSignature_base { constructor(options: IApiCallSignatureOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -43,6 +45,8 @@ export class ApiCallSignature extends ApiCallSignature_base { // @public export class ApiClass extends ApiClass_base { constructor(options: IApiClassOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; readonly extendsType: HeritageType | undefined; @@ -65,6 +69,8 @@ export class ApiClass extends ApiClass_base { // @public export class ApiConstructor extends ApiConstructor_base { constructor(options: IApiConstructorOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -78,6 +84,8 @@ export class ApiConstructor extends ApiConstructor_base { // @public export class ApiConstructSignature extends ApiConstructSignature_base { constructor(options: IApiConstructSignatureOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -121,6 +129,8 @@ export class ApiDocumentedItem extends ApiItem { // @public export class ApiEntryPoint extends ApiEntryPoint_base { constructor(options: IApiEntryPointOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // @override (undocumented) @@ -134,6 +144,8 @@ export class ApiEnum extends ApiEnum_base { constructor(options: IApiEnumOptions); // @override (undocumented) addMember(member: ApiEnumMember): void; + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -149,6 +161,8 @@ export class ApiEnum extends ApiEnum_base { // @public export class ApiEnumMember extends ApiEnumMember_base { constructor(options: IApiEnumMemberOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -169,6 +183,8 @@ export class ApiEnumMember extends ApiEnumMember_base { // @public export class ApiFunction extends ApiFunction_base { constructor(options: IApiFunctionOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -182,6 +198,8 @@ export class ApiFunction extends ApiFunction_base { // @public export class ApiIndexSignature extends ApiIndexSignature_base { constructor(options: IApiIndexSignatureOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -195,6 +213,8 @@ export class ApiIndexSignature extends ApiIndexSignature_base { // @public export class ApiInterface extends ApiInterface_base { constructor(options: IApiInterfaceOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; readonly extendsTypes: ReadonlyArray; @@ -309,6 +329,8 @@ export const enum ApiItemKind { // @public export class ApiMethod extends ApiMethod_base { constructor(options: IApiMethodOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -322,6 +344,8 @@ export class ApiMethod extends ApiMethod_base { // @public export class ApiMethodSignature extends ApiMethodSignature_base { constructor(options: IApiMethodSignatureOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -337,6 +361,8 @@ export class ApiModel extends ApiModel_base { constructor(); // @override (undocumented) addMember(member: ApiPackage): void; + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // @override (undocumented) @@ -355,6 +381,8 @@ export function ApiNameMixin(baseClass: // @public export interface ApiNameMixin extends ApiItem { + // @internal (undocumented) + _getCanonicalReferenceName(): string; readonly name: string; // @override (undocumented) serializeInto(jsonObject: Partial): void; @@ -370,6 +398,8 @@ export namespace ApiNameMixin { // @public export class ApiNamespace extends ApiNamespace_base { constructor(options: IApiNamespaceOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -385,6 +415,8 @@ export class ApiPackage extends ApiPackage_base { constructor(options: IApiPackageOptions); // @override (undocumented) addMember(member: ApiEntryPoint): void; + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -420,6 +452,8 @@ export namespace ApiParameterListMixin { // @public export class ApiProperty extends ApiProperty_base { constructor(options: IApiPropertyOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -446,6 +480,8 @@ export class ApiPropertyItem extends ApiPropertyItem_base { // @public export class ApiPropertySignature extends ApiPropertyItem { constructor(options: IApiPropertySignatureOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -506,6 +542,8 @@ export namespace ApiStaticMixin { // @public export class ApiTypeAlias extends ApiTypeAlias_base { constructor(options: IApiTypeAliasOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) @@ -541,6 +579,8 @@ export namespace ApiTypeParameterListMixin { // @public export class ApiVariable extends ApiVariable_base { constructor(options: IApiVariableOptions); + // @beta @override (undocumented) + buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; // (undocumented) From b108208079b1dea8810ea458b282eaef8b50f017 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 20 Jul 2019 01:38:47 -0700 Subject: [PATCH 03/22] Reintroduce the new "canonicalReference" to the .api.json file format --- apps/api-extractor-model/src/items/ApiItem.ts | 2 ++ apps/api-extractor-model/src/model/DeserializerContext.ts | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts index 9ca448a2195..593bd246727 100644 --- a/apps/api-extractor-model/src/items/ApiItem.ts +++ b/apps/api-extractor-model/src/items/ApiItem.ts @@ -46,6 +46,7 @@ export interface IApiItemOptions { export interface IApiItemJson { kind: ApiItemKind; + canonicalReference: string; } // PRIVATE - Allows ApiItemContainerMixin to assign the parent. @@ -85,6 +86,7 @@ export class ApiItem { /** @virtual */ public serializeInto(jsonObject: Partial): void { jsonObject.kind = this.kind; + jsonObject.canonicalReference = this.canonicalReference.toString(); } /** diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts index 3279d540323..d34057c6404 100644 --- a/apps/api-extractor-model/src/model/DeserializerContext.ts +++ b/apps/api-extractor-model/src/model/DeserializerContext.ts @@ -13,7 +13,10 @@ export enum ApiJsonSchemaVersion { V_1001 = 1001, /** - * Remove "canonicalReference" field. This field was for diagnostic purposes only and was never deserialized. + * Change the "canonicalReference" field to use 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_1002 = 1002, From 8f9550b743b15894123e7ca3ee5d0422a697516b Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 20 Jul 2019 01:38:58 -0700 Subject: [PATCH 04/22] rush rebuild --- .../etc/api-documenter-test.api.json | 46 +++++++++++++++++++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 23 ++++++++++ .../api-extractor-scenarios.api.json | 7 +++ .../api-extractor-scenarios.api.json | 9 ++++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 9 ++++ .../api-extractor-scenarios.api.json | 11 +++++ .../api-extractor-scenarios.api.json | 10 ++++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 4 ++ .../api-extractor-scenarios.api.json | 2 + .../api-extractor-scenarios.api.json | 2 + .../api-extractor-scenarios.api.json | 5 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 3 ++ .../api-extractor-scenarios.api.json | 5 ++ .../api-extractor-scenarios.api.json | 2 + .../typeOf/api-extractor-scenarios.api.json | 4 ++ .../api-extractor-scenarios.api.json | 14 ++++++ 24 files changed, 180 insertions(+) diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 86479be2e64..4ebac064250 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-documenter-test!", "docComment": "/**\n * api-extractor-test-05\n *\n * This project tests various documentation generation scenarios and doc comment syntaxes.\n *\n * @packageDocumentation\n */\n", "name": "api-documenter-test", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-documenter-test!", "name": "", "members": [ { "kind": "Variable", + "canonicalReference": "api-documenter-test!constVariable:variable", "docComment": "/**\n * An exported variable declaration.\n *\n * @public\n */\n", "excerptTokens": [ { @@ -39,6 +42,7 @@ }, { "kind": "Class", + "canonicalReference": "api-documenter-test!DocBaseClass:class", "docComment": "/**\n * Example base class\n *\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -59,6 +63,7 @@ "members": [ { "kind": "Constructor", + "canonicalReference": "api-documenter-test!DocBaseClass#:constructor(1)", "docComment": "/**\n * The simple constructor for `DocBaseClass`\n */\n", "excerptTokens": [ { @@ -72,6 +77,7 @@ }, { "kind": "Constructor", + "canonicalReference": "api-documenter-test!DocBaseClass#:constructor(2)", "docComment": "/**\n * The overloaded constructor for `DocBaseClass`\n */\n", "excerptTokens": [ { @@ -112,6 +118,7 @@ }, { "kind": "Class", + "canonicalReference": "api-documenter-test!DocClass1:class", "docComment": "/**\n * This is an example class.\n *\n * @remarks\n *\n * These are some remarks.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DocClass1` class.\n *\n * @defaultValue\n *\n * a default value for this function\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -160,6 +167,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1#deprecatedExample:member(0)", "docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n", "excerptTokens": [ { @@ -191,6 +199,7 @@ }, { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1#exampleFunction:member(1)", "docComment": "/**\n * This is an overloaded function.\n *\n * @param a - the first string\n *\n * @param b - the second string\n */\n", "excerptTokens": [ { @@ -269,6 +278,7 @@ }, { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1#exampleFunction:member(2)", "docComment": "/**\n * This is also an overloaded function.\n *\n * @param x - the number\n */\n", "excerptTokens": [ { @@ -324,6 +334,7 @@ }, { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1#interestingEdgeCases:member(0)", "docComment": "/**\n * Example: \"\\{ \\\\\"maxItemsToShow\\\\\": 123 \\}\"\n *\n * The regular expression used to validate the constraints is /^[a-zA-Z0-9\\\\-_]+$/\n */\n", "excerptTokens": [ { @@ -355,6 +366,7 @@ }, { "kind": "Property", + "canonicalReference": "api-documenter-test!DocClass1#malformedEvent:member", "docComment": "/**\n * This event should have been marked as readonly.\n *\n * @eventProperty\n */\n", "excerptTokens": [ { @@ -384,6 +396,7 @@ }, { "kind": "Property", + "canonicalReference": "api-documenter-test!DocClass1#modifiedEvent:member", "docComment": "/**\n * This event is fired whenever the object is modified.\n *\n * @eventProperty\n */\n", "excerptTokens": [ { @@ -417,6 +430,7 @@ }, { "kind": "Property", + "canonicalReference": "api-documenter-test!DocClass1#regularProperty:member", "docComment": "/**\n * This is a regular property that happens to use the SystemEvent type.\n */\n", "excerptTokens": [ { @@ -446,6 +460,7 @@ }, { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1.sumWithExample:member(0)", "docComment": "/**\n * Returns the sum of two numbers.\n *\n * @remarks\n *\n * This illustrates usage of the `@example` block tag.\n *\n * @param x - the first number to add\n *\n * @param y - the second number to add\n *\n * @returns the sum of the two numbers\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * // Prints \"2\":\n * console.log(DocClass1.sumWithExample(1,1));\n * ```\n *\n * @example\n *\n * Here's an example with negative numbers:\n * ```\n * // Prints \"0\":\n * console.log(DocClass1.sumWithExample(1,-1));\n * ```\n *\n */\n", "excerptTokens": [ { @@ -528,6 +543,7 @@ }, { "kind": "Method", + "canonicalReference": "api-documenter-test!DocClass1#tableExample:member(0)", "docComment": "/**\n * An example with tables:\n *\n * @remarks\n *\n *
John Doe
\n */\n", "excerptTokens": [ { @@ -575,6 +591,7 @@ }, { "kind": "Enum", + "canonicalReference": "api-documenter-test!DocEnum:enum", "docComment": "/**\n * Docs for DocEnum\n *\n * {@docCategory SystemEvent}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -595,6 +612,7 @@ "members": [ { "kind": "EnumMember", + "canonicalReference": "api-documenter-test!DocEnum.One:enummember", "docComment": "/**\n * These are some docs for One\n */\n", "excerptTokens": [ { @@ -619,6 +637,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-documenter-test!DocEnum.Two:enummember", "docComment": "/**\n * These are some docs for Two\n */\n", "excerptTokens": [ { @@ -643,6 +662,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-documenter-test!DocEnum.Zero:enummember", "docComment": "/**\n * These are some docs for Zero\n */\n", "excerptTokens": [ { @@ -669,6 +689,7 @@ }, { "kind": "TypeAlias", + "canonicalReference": "api-documenter-test!ExampleTypeAlias:typealias", "docComment": "/**\n * A type alias\n *\n * @public\n */\n", "excerptTokens": [ { @@ -705,6 +726,7 @@ }, { "kind": "Class", + "canonicalReference": "api-documenter-test!Generic:class", "docComment": "/**\n * Generic class.\n *\n * @public\n */\n", "excerptTokens": [ { @@ -748,6 +770,7 @@ }, { "kind": "Function", + "canonicalReference": "api-documenter-test!globalFunction:function(0)", "docComment": "/**\n * An exported function\n *\n * @public\n */\n", "excerptTokens": [ { @@ -806,6 +829,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface1:interface", "docComment": "/**\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -826,6 +850,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface1#regularProperty:member", "docComment": "/**\n * Does something\n */\n", "excerptTokens": [ { @@ -857,6 +882,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface2:interface", "docComment": "/**\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -885,6 +911,7 @@ "members": [ { "kind": "MethodSignature", + "canonicalReference": "api-documenter-test!IDocInterface2#deprecatedExample:member(0)", "docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n", "excerptTokens": [ { @@ -923,6 +950,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface3:interface", "docComment": "/**\n * Some less common TypeScript declaration kinds.\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -943,6 +971,7 @@ "members": [ { "kind": "CallSignature", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", "docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -992,6 +1021,7 @@ }, { "kind": "ConstructSignature", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", "docComment": "/**\n * Construct signature\n */\n", "excerptTokens": [ { @@ -1017,6 +1047,7 @@ }, { "kind": "IndexSignature", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", "docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1069,6 +1100,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface4:interface", "docComment": "/**\n * Type union in an interface.\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -1089,6 +1121,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface4#Context:member", "docComment": "/**\n * Test newline rendering when code blocks are used in tables\n */\n", "excerptTokens": [ { @@ -1133,6 +1166,7 @@ }, { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface4#generic:member", "docComment": "/**\n * make sure html entities are escaped in tables.\n */\n", "excerptTokens": [ { @@ -1165,6 +1199,7 @@ }, { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface4#numberOrFunction:member", "docComment": "/**\n * a union type with a function\n */\n", "excerptTokens": [ { @@ -1193,6 +1228,7 @@ }, { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface4#stringOrNumber:member", "docComment": "/**\n * a union type\n */\n", "excerptTokens": [ { @@ -1224,6 +1260,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface5:interface", "docComment": "/**\n * Interface without inline tag to test custom TOC\n *\n * @public\n */\n", "excerptTokens": [ { @@ -1244,6 +1281,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface5#regularProperty:member", "docComment": "/**\n * Property of type string that does something\n */\n", "excerptTokens": [ { @@ -1275,6 +1313,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-documenter-test!IDocInterface6:interface", "docComment": "/**\n * Interface without inline tag to test custom TOC with injection\n *\n * @public\n */\n", "excerptTokens": [ { @@ -1295,6 +1334,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface6#regularProperty:member", "docComment": "/**\n * Property of type number that does something\n */\n", "excerptTokens": [ { @@ -1326,6 +1366,7 @@ }, { "kind": "Namespace", + "canonicalReference": "api-documenter-test!OuterNamespace:namespace", "docComment": "/**\n * A top-level namespace\n *\n * @public\n */\n", "excerptTokens": [ { @@ -1346,6 +1387,7 @@ "members": [ { "kind": "Namespace", + "canonicalReference": "api-documenter-test!OuterNamespace.InnerNamespace:namespace", "docComment": "/**\n * A nested namespace\n */\n", "excerptTokens": [ { @@ -1366,6 +1408,7 @@ "members": [ { "kind": "Function", + "canonicalReference": "api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(0)", "docComment": "/**\n * A function inside a namespace\n */\n", "excerptTokens": [ { @@ -1426,6 +1469,7 @@ }, { "kind": "Variable", + "canonicalReference": "api-documenter-test!OuterNamespace.nestedVariable:variable", "docComment": "/**\n * A variable exported from within a namespace.\n */\n", "excerptTokens": [ { @@ -1452,6 +1496,7 @@ }, { "kind": "Class", + "canonicalReference": "api-documenter-test!SystemEvent:class", "docComment": "/**\n * A class used to exposed events.\n *\n * {@docCategory SystemEvent}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -1472,6 +1517,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-documenter-test!SystemEvent#addHandler:member(0)", "docComment": "/**\n * Adds an handler for the event.\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index d3f29ad9552..f4795a4a1c1 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!ambientNameConflict:function(0)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 6667f277445..c63e98c1516 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!AbstractClass:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!AbstractClass#member:member(0)", "docComment": "", "excerptTokens": [ { @@ -73,6 +77,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -93,6 +98,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method1:member(0)", "docComment": "/**\n * type literal in\n */\n", "excerptTokens": [ { @@ -164,6 +170,7 @@ }, { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method2:member(0)", "docComment": "/**\n * type literal output\n */\n", "excerptTokens": [ { @@ -222,6 +229,7 @@ }, { "kind": "Enum", + "canonicalReference": "api-extractor-scenarios!ConstEnum:enum", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -242,6 +250,7 @@ "members": [ { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.One:enummember", "docComment": "", "excerptTokens": [ { @@ -266,6 +275,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.Two:enummember", "docComment": "", "excerptTokens": [ { @@ -290,6 +300,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.Zero:enummember", "docComment": "", "excerptTokens": [ { @@ -316,6 +327,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!IInterface:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -336,6 +348,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-extractor-scenarios!IInterface#member:member", "docComment": "", "excerptTokens": [ { @@ -367,6 +380,7 @@ }, { "kind": "Namespace", + "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -387,6 +401,7 @@ "members": [ { "kind": "Variable", + "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.constVariable:variable", "docComment": "", "excerptTokens": [ { @@ -411,6 +426,7 @@ }, { "kind": "Variable", + "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.variable:variable", "docComment": "", "excerptTokens": [ { @@ -437,6 +453,7 @@ }, { "kind": "Enum", + "canonicalReference": "api-extractor-scenarios!RegularEnum:enum", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -457,6 +474,7 @@ "members": [ { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.One:enummember", "docComment": "/**\n * These are some docs for One\n */\n", "excerptTokens": [ { @@ -481,6 +499,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.Two:enummember", "docComment": "/**\n * These are some docs for Two\n */\n", "excerptTokens": [ { @@ -505,6 +524,7 @@ }, { "kind": "EnumMember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.Zero:enummember", "docComment": "/**\n * These are some docs for Zero\n */\n", "excerptTokens": [ { @@ -531,6 +551,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!SimpleClass:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -551,6 +572,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!SimpleClass#member:member(0)", "docComment": "", "excerptTokens": [ { @@ -585,6 +607,7 @@ }, { "kind": "Variable", + "canonicalReference": "api-extractor-scenarios!VARIABLE:variable", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index 563ebecfd73..ac9622b525d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!IFile:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFile#containingFolder:member", "docComment": "", "excerptTokens": [ { @@ -67,6 +71,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!IFolder:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -87,6 +92,7 @@ "members": [ { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFolder#containingFolder:member", "docComment": "", "excerptTokens": [ { @@ -120,6 +126,7 @@ }, { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFolder#files:member", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index 82ec5b10ec4..54cf886fb20 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!A:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -37,6 +40,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!B:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -59,6 +63,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!IFile:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -79,6 +84,7 @@ "members": [ { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFile#containingFolder:member", "docComment": "", "excerptTokens": [ { @@ -111,6 +117,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!IFolder:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -131,6 +138,7 @@ "members": [ { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFolder#containingFolder:member", "docComment": "", "excerptTokens": [ { @@ -164,6 +172,7 @@ }, { "kind": "Property", + "canonicalReference": "api-extractor-scenarios!IFolder#files:member", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index 52e390e0f26..9481524ed75 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!DefaultClass:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index 75f9957830e..4f1b90992d9 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Variable", + "canonicalReference": "api-extractor-scenarios!defaultFunctionStatement:variable", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index 7d13160c3c7..3987fa5d9fd 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!defaultFunctionDeclaration:function(0)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index 8f8233d7148..62d64e8d91e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Variable", + "canonicalReference": "api-extractor-scenarios!_default:variable", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index ae48b76539a..d68c934e49e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!failWithBrokenLink:function(0)", "docComment": "/**\n * {@inheritDoc MyNamespace.MyClass.nonExistentMethod}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -49,6 +52,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!failWithMissingReference:function(0)", "docComment": "/**\n * {@inheritDoc}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -83,6 +87,7 @@ }, { "kind": "Namespace", + "canonicalReference": "api-extractor-scenarios!MyNamespace:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -103,6 +108,7 @@ "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!MyNamespace.MyClass:class", "docComment": "", "excerptTokens": [ { @@ -123,6 +129,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!MyNamespace.MyClass#myMethod:member(0)", "docComment": "/**\n * Summary for myMethod\n *\n * @remarks\n *\n * Remarks for myMethod\n *\n * @param x - the parameter\n *\n * @returns a number\n *\n * @beta\n */\n", "excerptTokens": [ { @@ -183,6 +190,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!succeedForNow:function(0)", "docComment": "/**\n * {@inheritDoc nonexistent-package#MyNamespace.MyClass.nonExistentMethod}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -217,6 +225,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!testSimple:function(0)", "docComment": "/**\n * Summary for myMethod\n *\n * @remarks\n *\n * Remarks for myMethod\n *\n * @param x - the parameter\n *\n * @returns a number\n *\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index b071b072c27..acb2b5589f6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!CyclicA:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!CyclicA#methodA1:member(0)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -66,6 +70,7 @@ }, { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!CyclicA#methodA3:member(0)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -100,6 +105,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!CyclicB:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -120,6 +126,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!CyclicB#methodB2:member(0)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -151,6 +158,7 @@ }, { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!CyclicB#methodB4:member(0)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -185,6 +193,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!FailWithSelfReference:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -205,6 +214,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method1:member(0)", "docComment": "", "excerptTokens": [ { @@ -236,6 +246,7 @@ }, { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method2:member(0)", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 24cbe1e8fca..4e41054e1aa 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!A:interface", "docComment": "", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-extractor-scenarios!A#myProperty:member", "docComment": "", "excerptTokens": [ { @@ -66,6 +70,7 @@ }, { "kind": "Namespace", + "canonicalReference": "api-extractor-scenarios!A:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -86,6 +91,7 @@ "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!A.B:class", "docComment": "", "excerptTokens": [ { @@ -106,6 +112,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!A.B#myMethod:member(0)", "docComment": "", "excerptTokens": [ { @@ -142,6 +149,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!failWithAmbiguity:function(0)", "docComment": "/**\n * {@link MyNamespace.MyClass.myMethod | the method}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -176,6 +184,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!succeedWithExternalReference:function(0)", "docComment": "/**\n * NOTE: The broken link checker currently is not able to validate references to external packages. Tracked by: https://github.com/Microsoft/web-build-tools/issues/1195 {@link nonexistent#nonexistent}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -210,6 +219,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!succeedWithSelector:function(0)", "docComment": "/**\n * {@link (A:namespace).B.myMethod | the method} {@link (A:interface).myProperty | the property}\n *\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index 5befba2f9ed..73311ed1929 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!X:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index c3cd80ea7d7..76a650e2830 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!ITeamsContext:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-extractor-scenarios!ITeamsContext#context:member", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index ff633f7bee8..26f39a63da4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -6,11 +6,13 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [] } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index ff633f7bee8..26f39a63da4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -6,11 +6,13 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [] } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index 857129cec57..14b0f05ad01 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!A:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -37,6 +40,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!B:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -59,6 +63,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!C:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index 23ec855816f..2df601f8b9c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!A:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index 23ec855816f..2df601f8b9c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!A:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index cc7aa8bb6e3..04a9257b392 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!useColors:function(0)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 71c904a13c3..46c6097a3c2 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!IBeta:interface", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-extractor-scenarios!IBeta#x:member", "docComment": "", "excerptTokens": [ { @@ -66,6 +70,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!publicFunctionReturnsBeta:function(0)", "docComment": "/**\n * It's not okay for a \"public\" function to reference a \"beta\" symbol, because \"beta\" is less public than \"public\".\n *\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index ff633f7bee8..26f39a63da4 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -6,11 +6,13 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [] } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index 4802fe05851..14e1972b9d1 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!f:function(0)", "docComment": "/**\n * Reference Lib1Class via \"typeof\"\n *\n * @public\n */\n", "excerptTokens": [ { @@ -57,6 +60,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!g:function(0)", "docComment": "/**\n * Reference IForgottenExport via \"typeof\"\n *\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index d71ab79b5ff..c6b6579e85b 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -6,15 +6,18 @@ "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", + "canonicalReference": "api-extractor-scenarios!", "docComment": "", "name": "api-extractor-scenarios", "members": [ { "kind": "EntryPoint", + "canonicalReference": "api-extractor-scenarios!", "name": "", "members": [ { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!ClassWithGenericMethod:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -35,6 +38,7 @@ "members": [ { "kind": "Method", + "canonicalReference": "api-extractor-scenarios!ClassWithGenericMethod#method:member(0)", "docComment": "", "excerptTokens": [ { @@ -90,6 +94,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!GenericClass:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -133,6 +138,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!GenericClassWithConstraint:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -184,6 +190,7 @@ }, { "kind": "Class", + "canonicalReference": "api-extractor-scenarios!GenericClassWithDefault:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -235,6 +242,7 @@ }, { "kind": "Function", + "canonicalReference": "api-extractor-scenarios!genericFunction:function(0)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -290,6 +298,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!GenericInterface:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -333,6 +342,7 @@ }, { "kind": "TypeAlias", + "canonicalReference": "api-extractor-scenarios!GenericTypeAlias:typealias", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -386,6 +396,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -406,6 +417,7 @@ "members": [ { "kind": "CallSignature", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature#:signature(0)", "docComment": "", "excerptTokens": [ { @@ -455,6 +467,7 @@ }, { "kind": "Interface", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -475,6 +488,7 @@ "members": [ { "kind": "ConstructSignature", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature#:signature(0)", "docComment": "", "excerptTokens": [ { From 9846fc3ab3aae40bdff23bfc0fda371345dbabfa Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sat, 20 Jul 2019 01:42:51 -0700 Subject: [PATCH 05/22] rush change --- ...-ae-new-canonical-references_2019-07-20-08-42.json | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json diff --git a/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json b/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json new file mode 100644 index 00000000000..48b4768f2e5 --- /dev/null +++ b/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-extractor-model", + "comment": "(Experimental) Add ApiExtractor.canonicalReference which is a beta implementation of the revised TSDoc declaration reference notation", + "type": "minor" + } + ], + "packageName": "@microsoft/api-extractor-model", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file From 36774d6aa5ac6f40a72aebc45ac9802eeae094e4 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 21 Jul 2019 16:12:26 -0700 Subject: [PATCH 06/22] Fix a bug where a function with only one declaration was assigned an overloadIndex of 0 instead of 1 --- apps/api-extractor/src/generators/ApiModelGenerator.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts index 2a38f963449..6a8d4ea8713 100644 --- a/apps/api-extractor/src/generators/ApiModelGenerator.ts +++ b/apps/api-extractor/src/generators/ApiModelGenerator.ts @@ -775,7 +775,7 @@ export class ApiModelGenerator { private _getOverloadIndex(astDeclaration: AstDeclaration): number { const allDeclarations: ReadonlyArray = astDeclaration.astSymbol.astDeclarations; if (allDeclarations.length === 1) { - return 0; // trivial case + return 1; // trivial case } let overloadIndex: number | undefined = this._cachedOverloadIndexesByDeclaration.get(astDeclaration); From 6e515f4eb96cec9e982009a06b47f9c0380839c4 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 21 Jul 2019 17:11:59 -0700 Subject: [PATCH 07/22] rush rebuild --- .../etc/api-documenter-test.api.json | 44 +++++++++---------- .../api-extractor-scenarios.api.json | 4 +- .../api-extractor-scenarios.api.json | 16 +++---- .../api-extractor-scenarios.api.json | 4 +- .../api-extractor-scenarios.api.json | 20 ++++----- .../api-extractor-scenarios.api.json | 24 +++++----- .../api-extractor-scenarios.api.json | 16 +++---- .../api-extractor-scenarios.api.json | 4 +- .../api-extractor-scenarios.api.json | 4 +- .../typeOf/api-extractor-scenarios.api.json | 8 ++-- .../api-extractor-scenarios.api.json | 16 +++---- 11 files changed, 80 insertions(+), 80 deletions(-) diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 4ebac064250..809ba95c8b2 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -167,7 +167,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-documenter-test!DocClass1#deprecatedExample:member(0)", + "canonicalReference": "api-documenter-test!DocClass1#deprecatedExample:member(1)", "docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n", "excerptTokens": [ { @@ -193,7 +193,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "deprecatedExample" }, @@ -334,7 +334,7 @@ }, { "kind": "Method", - "canonicalReference": "api-documenter-test!DocClass1#interestingEdgeCases:member(0)", + "canonicalReference": "api-documenter-test!DocClass1#interestingEdgeCases:member(1)", "docComment": "/**\n * Example: \"\\{ \\\\\"maxItemsToShow\\\\\": 123 \\}\"\n *\n * The regular expression used to validate the constraints is /^[a-zA-Z0-9\\\\-_]+$/\n */\n", "excerptTokens": [ { @@ -360,7 +360,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "interestingEdgeCases" }, @@ -460,7 +460,7 @@ }, { "kind": "Method", - "canonicalReference": "api-documenter-test!DocClass1.sumWithExample:member(0)", + "canonicalReference": "api-documenter-test!DocClass1.sumWithExample:member(1)", "docComment": "/**\n * Returns the sum of two numbers.\n *\n * @remarks\n *\n * This illustrates usage of the `@example` block tag.\n *\n * @param x - the first number to add\n *\n * @param y - the second number to add\n *\n * @returns the sum of the two numbers\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * // Prints \"2\":\n * console.log(DocClass1.sumWithExample(1,1));\n * ```\n *\n * @example\n *\n * Here's an example with negative numbers:\n * ```\n * // Prints \"0\":\n * console.log(DocClass1.sumWithExample(1,-1));\n * ```\n *\n */\n", "excerptTokens": [ { @@ -522,7 +522,7 @@ "endIndex": 12 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -543,7 +543,7 @@ }, { "kind": "Method", - "canonicalReference": "api-documenter-test!DocClass1#tableExample:member(0)", + "canonicalReference": "api-documenter-test!DocClass1#tableExample:member(1)", "docComment": "/**\n * An example with tables:\n *\n * @remarks\n *\n *
John Doe
\n */\n", "excerptTokens": [ { @@ -569,7 +569,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "tableExample" } @@ -770,7 +770,7 @@ }, { "kind": "Function", - "canonicalReference": "api-documenter-test!globalFunction:function(0)", + "canonicalReference": "api-documenter-test!globalFunction:function(1)", "docComment": "/**\n * An exported function\n *\n * @public\n */\n", "excerptTokens": [ { @@ -815,7 +815,7 @@ "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -911,7 +911,7 @@ "members": [ { "kind": "MethodSignature", - "canonicalReference": "api-documenter-test!IDocInterface2#deprecatedExample:member(0)", + "canonicalReference": "api-documenter-test!IDocInterface2#deprecatedExample:member(1)", "docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n", "excerptTokens": [ { @@ -936,7 +936,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "deprecatedExample" } @@ -971,7 +971,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", "docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1008,7 +1008,7 @@ "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -1021,7 +1021,7 @@ }, { "kind": "ConstructSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", "docComment": "/**\n * Construct signature\n */\n", "excerptTokens": [ { @@ -1042,12 +1042,12 @@ "endIndex": 2 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [] }, { "kind": "IndexSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(0)", + "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", "docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1084,7 +1084,7 @@ "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -1408,7 +1408,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(0)", + "canonicalReference": "api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1)", "docComment": "/**\n * A function inside a namespace\n */\n", "excerptTokens": [ { @@ -1453,7 +1453,7 @@ "endIndex": 8 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -1517,7 +1517,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-documenter-test!SystemEvent#addHandler:member(0)", + "canonicalReference": "api-documenter-test!SystemEvent#addHandler:member(1)", "docComment": "/**\n * Adds an handler for the event.\n */\n", "excerptTokens": [ { @@ -1559,7 +1559,7 @@ "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "handler", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index f4795a4a1c1..b270df1ff9c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!ambientNameConflict:function(0)", + "canonicalReference": "api-extractor-scenarios!ambientNameConflict:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -86,7 +86,7 @@ "endIndex": 14 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "p1", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index c63e98c1516..fc870a731d1 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -38,7 +38,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!AbstractClass#member:member(0)", + "canonicalReference": "api-extractor-scenarios!AbstractClass#member:member(1)", "docComment": "", "excerptTokens": [ { @@ -68,7 +68,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "member" } @@ -98,7 +98,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method1:member(0)", + "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method1:member(1)", "docComment": "/**\n * type literal in\n */\n", "excerptTokens": [ { @@ -156,7 +156,7 @@ "endIndex": 11 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "vector", @@ -170,7 +170,7 @@ }, { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method2:member(0)", + "canonicalReference": "api-extractor-scenarios!ClassWithTypeLiterals#method2:member(1)", "docComment": "/**\n * type literal output\n */\n", "excerptTokens": [ { @@ -220,7 +220,7 @@ "endIndex": 9 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "method2" } @@ -572,7 +572,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!SimpleClass#member:member(0)", + "canonicalReference": "api-extractor-scenarios!SimpleClass#member:member(1)", "docComment": "", "excerptTokens": [ { @@ -598,7 +598,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "member" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index 3987fa5d9fd..0dbdc6c0fb2 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!defaultFunctionDeclaration:function(0)", + "canonicalReference": "api-extractor-scenarios!defaultFunctionDeclaration:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -46,7 +46,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "defaultFunctionDeclaration" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index d68c934e49e..9953a8a5b84 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!failWithBrokenLink:function(0)", + "canonicalReference": "api-extractor-scenarios!failWithBrokenLink:function(1)", "docComment": "/**\n * {@inheritDoc MyNamespace.MyClass.nonExistentMethod}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -46,13 +46,13 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "failWithBrokenLink" }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!failWithMissingReference:function(0)", + "canonicalReference": "api-extractor-scenarios!failWithMissingReference:function(1)", "docComment": "/**\n * {@inheritDoc}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -81,7 +81,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "failWithMissingReference" }, @@ -129,7 +129,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!MyNamespace.MyClass#myMethod:member(0)", + "canonicalReference": "api-extractor-scenarios!MyNamespace.MyClass#myMethod:member(1)", "docComment": "/**\n * Summary for myMethod\n *\n * @remarks\n *\n * Remarks for myMethod\n *\n * @param x - the parameter\n *\n * @returns a number\n *\n * @beta\n */\n", "excerptTokens": [ { @@ -171,7 +171,7 @@ "endIndex": 7 }, "releaseTag": "Beta", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [ { "parameterName": "x", @@ -190,7 +190,7 @@ }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!succeedForNow:function(0)", + "canonicalReference": "api-extractor-scenarios!succeedForNow:function(1)", "docComment": "/**\n * {@inheritDoc nonexistent-package#MyNamespace.MyClass.nonExistentMethod}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -219,13 +219,13 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "succeedForNow" }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!testSimple:function(0)", + "canonicalReference": "api-extractor-scenarios!testSimple:function(1)", "docComment": "/**\n * Summary for myMethod\n *\n * @remarks\n *\n * Remarks for myMethod\n *\n * @param x - the parameter\n *\n * @returns a number\n *\n * @public\n */\n", "excerptTokens": [ { @@ -254,7 +254,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "testSimple" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index acb2b5589f6..0606d061ea8 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -38,7 +38,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!CyclicA#methodA1:member(0)", + "canonicalReference": "api-extractor-scenarios!CyclicA#methodA1:member(1)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -64,13 +64,13 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "methodA1" }, { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!CyclicA#methodA3:member(0)", + "canonicalReference": "api-extractor-scenarios!CyclicA#methodA3:member(1)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -96,7 +96,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "methodA3" } @@ -126,7 +126,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!CyclicB#methodB2:member(0)", + "canonicalReference": "api-extractor-scenarios!CyclicB#methodB2:member(1)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -152,13 +152,13 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "methodB2" }, { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!CyclicB#methodB4:member(0)", + "canonicalReference": "api-extractor-scenarios!CyclicB#methodB4:member(1)", "docComment": "/**\n * THE COMMENT\n */\n", "excerptTokens": [ { @@ -184,7 +184,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "methodB4" } @@ -214,7 +214,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method1:member(0)", + "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method1:member(1)", "docComment": "", "excerptTokens": [ { @@ -240,13 +240,13 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "method1" }, { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method2:member(0)", + "canonicalReference": "api-extractor-scenarios!FailWithSelfReference#method2:member(1)", "docComment": "", "excerptTokens": [ { @@ -272,7 +272,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "method2" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 4e41054e1aa..8dfbd6ed59a 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -112,7 +112,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!A.B#myMethod:member(0)", + "canonicalReference": "api-extractor-scenarios!A.B#myMethod:member(1)", "docComment": "", "excerptTokens": [ { @@ -138,7 +138,7 @@ "endIndex": 3 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "myMethod" } @@ -149,7 +149,7 @@ }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!failWithAmbiguity:function(0)", + "canonicalReference": "api-extractor-scenarios!failWithAmbiguity:function(1)", "docComment": "/**\n * {@link MyNamespace.MyClass.myMethod | the method}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -178,13 +178,13 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "failWithAmbiguity" }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!succeedWithExternalReference:function(0)", + "canonicalReference": "api-extractor-scenarios!succeedWithExternalReference:function(1)", "docComment": "/**\n * NOTE: The broken link checker currently is not able to validate references to external packages. Tracked by: https://github.com/Microsoft/web-build-tools/issues/1195 {@link nonexistent#nonexistent}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -213,13 +213,13 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "succeedWithExternalReference" }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!succeedWithSelector:function(0)", + "canonicalReference": "api-extractor-scenarios!succeedWithSelector:function(1)", "docComment": "/**\n * {@link (A:namespace).B.myMethod | the method} {@link (A:interface).myProperty | the property}\n *\n * @public\n */\n", "excerptTokens": [ { @@ -248,7 +248,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "succeedWithSelector" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index 04a9257b392..a7524865aa2 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!useColors:function(0)", + "canonicalReference": "api-extractor-scenarios!useColors:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -58,7 +58,7 @@ "endIndex": 7 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "useColors" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 46c6097a3c2..55b4e1e58d6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -70,7 +70,7 @@ }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!publicFunctionReturnsBeta:function(0)", + "canonicalReference": "api-extractor-scenarios!publicFunctionReturnsBeta:function(1)", "docComment": "/**\n * It's not okay for a \"public\" function to reference a \"beta\" symbol, because \"beta\" is less public than \"public\".\n *\n * @public\n */\n", "excerptTokens": [ { @@ -99,7 +99,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "publicFunctionReturnsBeta" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index 14e1972b9d1..235bbee2600 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!f:function(0)", + "canonicalReference": "api-extractor-scenarios!f:function(1)", "docComment": "/**\n * Reference Lib1Class via \"typeof\"\n *\n * @public\n */\n", "excerptTokens": [ { @@ -54,13 +54,13 @@ "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "f" }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!g:function(0)", + "canonicalReference": "api-extractor-scenarios!g:function(1)", "docComment": "/**\n * Reference IForgottenExport via \"typeof\"\n *\n * @public\n */\n", "excerptTokens": [ { @@ -97,7 +97,7 @@ "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "name": "g" } diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index c6b6579e85b..0f86bb8bc28 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -38,7 +38,7 @@ "members": [ { "kind": "Method", - "canonicalReference": "api-extractor-scenarios!ClassWithGenericMethod#method:member(0)", + "canonicalReference": "api-extractor-scenarios!ClassWithGenericMethod#method:member(1)", "docComment": "", "excerptTokens": [ { @@ -72,7 +72,7 @@ "endIndex": 5 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "typeParameters": [ { @@ -242,7 +242,7 @@ }, { "kind": "Function", - "canonicalReference": "api-extractor-scenarios!genericFunction:function(0)", + "canonicalReference": "api-extractor-scenarios!genericFunction:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -279,7 +279,7 @@ "endIndex": 6 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "typeParameters": [ { @@ -417,7 +417,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature#:signature(0)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature#:signature(1)", "docComment": "", "excerptTokens": [ { @@ -446,7 +446,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "typeParameters": [ { @@ -488,7 +488,7 @@ "members": [ { "kind": "ConstructSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature#:signature(0)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature#:signature(1)", "docComment": "", "excerptTokens": [ { @@ -517,7 +517,7 @@ "endIndex": 4 }, "releaseTag": "Public", - "overloadIndex": 0, + "overloadIndex": 1, "parameters": [], "typeParameters": [ { From aaf4d1375171e52ec1263429979b2fcca6f3ea28 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 21 Jul 2019 18:47:30 -0700 Subject: [PATCH 08/22] Fix how buildCanonicalReference() handles unnamed declarations --- apps/api-extractor-model/src/model/ApiCallSignature.ts | 7 +++++-- .../src/model/ApiConstructSignature.ts | 7 +++++-- apps/api-extractor-model/src/model/ApiConstructor.ts | 7 +++++-- .../api-extractor-model/src/model/ApiIndexSignature.ts | 7 +++++-- .../etc/api-documenter-test.api.json | 10 +++++----- .../typeParameters/api-extractor-scenarios.api.json | 4 ++-- 6 files changed, 27 insertions(+), 15 deletions(-) diff --git a/apps/api-extractor-model/src/model/ApiCallSignature.ts b/apps/api-extractor-model/src/model/ApiCallSignature.ts index 605d023f5e3..abc13d6b4ab 100644 --- a/apps/api-extractor-model/src/model/ApiCallSignature.ts +++ b/apps/api-extractor-model/src/model/ApiCallSignature.ts @@ -73,8 +73,11 @@ export class ApiCallSignature extends ApiTypeParameterListMixin(ApiParameterList /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, '') + const parent: DeclarationReference = this.parent + ? this.parent.canonicalReference + // .withMeaning() requires some kind of component + : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); + return parent .withMeaning(Meaning.Signature) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiConstructSignature.ts b/apps/api-extractor-model/src/model/ApiConstructSignature.ts index 6cfd62f5139..67ec2075523 100644 --- a/apps/api-extractor-model/src/model/ApiConstructSignature.ts +++ b/apps/api-extractor-model/src/model/ApiConstructSignature.ts @@ -86,8 +86,11 @@ export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParamete /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, '') + const parent: DeclarationReference = this.parent + ? this.parent.canonicalReference + // .withMeaning() requires some kind of component + : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); + return parent .withMeaning(Meaning.Signature) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiConstructor.ts b/apps/api-extractor-model/src/model/ApiConstructor.ts index bcd9aca321c..c491cf5e448 100644 --- a/apps/api-extractor-model/src/model/ApiConstructor.ts +++ b/apps/api-extractor-model/src/model/ApiConstructor.ts @@ -66,8 +66,11 @@ export class ApiConstructor extends ApiParameterListMixin(ApiReleaseTagMixin(Api /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, '') + const parent: DeclarationReference = this.parent + ? this.parent.canonicalReference + // .withMeaning() requires some kind of component + : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); + return parent .withMeaning(Meaning.Constructor) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiIndexSignature.ts b/apps/api-extractor-model/src/model/ApiIndexSignature.ts index 035e9cd9f3c..b5451b7a747 100644 --- a/apps/api-extractor-model/src/model/ApiIndexSignature.ts +++ b/apps/api-extractor-model/src/model/ApiIndexSignature.ts @@ -63,8 +63,11 @@ export class ApiIndexSignature extends ApiParameterListMixin(ApiReleaseTagMixin( /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, '') + const parent: DeclarationReference = this.parent + ? this.parent.canonicalReference + // .withMeaning() requires some kind of component + : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); + return parent .withMeaning(Meaning.Signature) .withOverloadIndex(this.overloadIndex); } diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 809ba95c8b2..bee2d7aff7e 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -63,7 +63,7 @@ "members": [ { "kind": "Constructor", - "canonicalReference": "api-documenter-test!DocBaseClass#:constructor(1)", + "canonicalReference": "api-documenter-test!DocBaseClass:constructor(1)", "docComment": "/**\n * The simple constructor for `DocBaseClass`\n */\n", "excerptTokens": [ { @@ -77,7 +77,7 @@ }, { "kind": "Constructor", - "canonicalReference": "api-documenter-test!DocBaseClass#:constructor(2)", + "canonicalReference": "api-documenter-test!DocBaseClass:constructor(2)", "docComment": "/**\n * The overloaded constructor for `DocBaseClass`\n */\n", "excerptTokens": [ { @@ -971,7 +971,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", "docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1021,7 +1021,7 @@ }, { "kind": "ConstructSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", "docComment": "/**\n * Construct signature\n */\n", "excerptTokens": [ { @@ -1047,7 +1047,7 @@ }, { "kind": "IndexSignature", - "canonicalReference": "api-documenter-test!IDocInterface3#:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", "docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index 0f86bb8bc28..09af0c48049 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -417,7 +417,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature#:signature(1)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:signature(1)", "docComment": "", "excerptTokens": [ { @@ -488,7 +488,7 @@ "members": [ { "kind": "ConstructSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature#:signature(1)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:signature(1)", "docComment": "", "excerptTokens": [ { From d772f412dd9ff3e59ab52d4100ef307bbca76eb0 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 21 Jul 2019 21:29:29 -0700 Subject: [PATCH 09/22] Apply suggestions from code review Co-Authored-By: Ron Buckton --- apps/api-extractor-model/src/model/ApiPackage.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index a4df4061c16..f48ccb67954 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -207,6 +207,6 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return new DeclarationReference(new ModuleSource(this.name)); + return DeclarationReference.module(this.name); } } From 5a280f578e9a25a11ee7df1d899dc76717f3bc51 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 22 Jul 2019 02:20:36 -0700 Subject: [PATCH 10/22] Update to use revised TSDoc API --- .../src/model/ApiCallSignature.ts | 2 +- .../src/model/ApiConstructSignature.ts | 2 +- .../src/model/ApiEnumMember.ts | 2 +- .../src/model/ApiIndexSignature.ts | 2 +- .../etc/api-documenter-test.api.json | 18 +++++++++--------- .../api-extractor-scenarios.api.json | 18 +++++++++--------- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 2 +- .../api-extractor-scenarios.api.json | 6 +++--- 9 files changed, 27 insertions(+), 27 deletions(-) diff --git a/apps/api-extractor-model/src/model/ApiCallSignature.ts b/apps/api-extractor-model/src/model/ApiCallSignature.ts index abc13d6b4ab..47c2353e989 100644 --- a/apps/api-extractor-model/src/model/ApiCallSignature.ts +++ b/apps/api-extractor-model/src/model/ApiCallSignature.ts @@ -78,7 +78,7 @@ export class ApiCallSignature extends ApiTypeParameterListMixin(ApiParameterList // .withMeaning() requires some kind of component : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); return parent - .withMeaning(Meaning.Signature) + .withMeaning(Meaning.CallSignature) .withOverloadIndex(this.overloadIndex); } } diff --git a/apps/api-extractor-model/src/model/ApiConstructSignature.ts b/apps/api-extractor-model/src/model/ApiConstructSignature.ts index 67ec2075523..6aeacb7fdac 100644 --- a/apps/api-extractor-model/src/model/ApiConstructSignature.ts +++ b/apps/api-extractor-model/src/model/ApiConstructSignature.ts @@ -91,7 +91,7 @@ export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParamete // .withMeaning() requires some kind of component : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); return parent - .withMeaning(Meaning.Signature) + .withMeaning(Meaning.ConstructSignature) .withOverloadIndex(this.overloadIndex); } } diff --git a/apps/api-extractor-model/src/model/ApiEnumMember.ts b/apps/api-extractor-model/src/model/ApiEnumMember.ts index 45bd2c3fd15..01d7a07569a 100644 --- a/apps/api-extractor-model/src/model/ApiEnumMember.ts +++ b/apps/api-extractor-model/src/model/ApiEnumMember.ts @@ -92,6 +92,6 @@ export class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredIt public buildCanonicalReference(): DeclarationReference { return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) - .withMeaning(Meaning.EnumMember); + .withMeaning(Meaning.Member); } } diff --git a/apps/api-extractor-model/src/model/ApiIndexSignature.ts b/apps/api-extractor-model/src/model/ApiIndexSignature.ts index b5451b7a747..0015ba2fee8 100644 --- a/apps/api-extractor-model/src/model/ApiIndexSignature.ts +++ b/apps/api-extractor-model/src/model/ApiIndexSignature.ts @@ -68,7 +68,7 @@ export class ApiIndexSignature extends ApiParameterListMixin(ApiReleaseTagMixin( // .withMeaning() requires some kind of component : DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)'); return parent - .withMeaning(Meaning.Signature) + .withMeaning(Meaning.IndexSignature) .withOverloadIndex(this.overloadIndex); } } diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index bee2d7aff7e..22def9a7dfd 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Variable", - "canonicalReference": "api-documenter-test!constVariable:variable", + "canonicalReference": "api-documenter-test!constVariable:var", "docComment": "/**\n * An exported variable declaration.\n *\n * @public\n */\n", "excerptTokens": [ { @@ -612,7 +612,7 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "api-documenter-test!DocEnum.One:enummember", + "canonicalReference": "api-documenter-test!DocEnum.One:member", "docComment": "/**\n * These are some docs for One\n */\n", "excerptTokens": [ { @@ -637,7 +637,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-documenter-test!DocEnum.Two:enummember", + "canonicalReference": "api-documenter-test!DocEnum.Two:member", "docComment": "/**\n * These are some docs for Two\n */\n", "excerptTokens": [ { @@ -662,7 +662,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-documenter-test!DocEnum.Zero:enummember", + "canonicalReference": "api-documenter-test!DocEnum.Zero:member", "docComment": "/**\n * These are some docs for Zero\n */\n", "excerptTokens": [ { @@ -689,7 +689,7 @@ }, { "kind": "TypeAlias", - "canonicalReference": "api-documenter-test!ExampleTypeAlias:typealias", + "canonicalReference": "api-documenter-test!ExampleTypeAlias:type", "docComment": "/**\n * A type alias\n *\n * @public\n */\n", "excerptTokens": [ { @@ -971,7 +971,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:call(1)", "docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1021,7 +1021,7 @@ }, { "kind": "ConstructSignature", - "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:new(1)", "docComment": "/**\n * Construct signature\n */\n", "excerptTokens": [ { @@ -1047,7 +1047,7 @@ }, { "kind": "IndexSignature", - "canonicalReference": "api-documenter-test!IDocInterface3:signature(1)", + "canonicalReference": "api-documenter-test!IDocInterface3:index(1)", "docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n", "excerptTokens": [ { @@ -1469,7 +1469,7 @@ }, { "kind": "Variable", - "canonicalReference": "api-documenter-test!OuterNamespace.nestedVariable:variable", + "canonicalReference": "api-documenter-test!OuterNamespace.nestedVariable:var", "docComment": "/**\n * A variable exported from within a namespace.\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index fc870a731d1..431aab7a468 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -250,7 +250,7 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!ConstEnum.One:enummember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.One:member", "docComment": "", "excerptTokens": [ { @@ -275,7 +275,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!ConstEnum.Two:enummember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.Two:member", "docComment": "", "excerptTokens": [ { @@ -300,7 +300,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!ConstEnum.Zero:enummember", + "canonicalReference": "api-extractor-scenarios!ConstEnum.Zero:member", "docComment": "", "excerptTokens": [ { @@ -401,7 +401,7 @@ "members": [ { "kind": "Variable", - "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.constVariable:variable", + "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.constVariable:var", "docComment": "", "excerptTokens": [ { @@ -426,7 +426,7 @@ }, { "kind": "Variable", - "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.variable:variable", + "canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.variable:var", "docComment": "", "excerptTokens": [ { @@ -474,7 +474,7 @@ "members": [ { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!RegularEnum.One:enummember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.One:member", "docComment": "/**\n * These are some docs for One\n */\n", "excerptTokens": [ { @@ -499,7 +499,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!RegularEnum.Two:enummember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.Two:member", "docComment": "/**\n * These are some docs for Two\n */\n", "excerptTokens": [ { @@ -524,7 +524,7 @@ }, { "kind": "EnumMember", - "canonicalReference": "api-extractor-scenarios!RegularEnum.Zero:enummember", + "canonicalReference": "api-extractor-scenarios!RegularEnum.Zero:member", "docComment": "/**\n * These are some docs for Zero\n */\n", "excerptTokens": [ { @@ -607,7 +607,7 @@ }, { "kind": "Variable", - "canonicalReference": "api-extractor-scenarios!VARIABLE:variable", + "canonicalReference": "api-extractor-scenarios!VARIABLE:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index 4f1b90992d9..44d058996b3 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Variable", - "canonicalReference": "api-extractor-scenarios!defaultFunctionStatement:variable", + "canonicalReference": "api-extractor-scenarios!defaultFunctionStatement:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index 62d64e8d91e..caf569dae49 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -17,7 +17,7 @@ "members": [ { "kind": "Variable", - "canonicalReference": "api-extractor-scenarios!_default:variable", + "canonicalReference": "api-extractor-scenarios!_default:var", "docComment": "", "excerptTokens": [ { diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index 09af0c48049..ad76fa49570 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -342,7 +342,7 @@ }, { "kind": "TypeAlias", - "canonicalReference": "api-extractor-scenarios!GenericTypeAlias:typealias", + "canonicalReference": "api-extractor-scenarios!GenericTypeAlias:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { @@ -417,7 +417,7 @@ "members": [ { "kind": "CallSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:signature(1)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:call(1)", "docComment": "", "excerptTokens": [ { @@ -488,7 +488,7 @@ "members": [ { "kind": "ConstructSignature", - "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:signature(1)", + "canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:new(1)", "docComment": "", "excerptTokens": [ { From 388997281999f24994b5d60422fb12e4c41eb14d Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 22 Jul 2019 18:52:09 -0700 Subject: [PATCH 11/22] Update to use new TSDoc API --- .../src/mixins/ApiNameMixin.ts | 19 ++++++++++--------- .../api-extractor-model/src/model/ApiClass.ts | 2 +- .../src/model/ApiEntryPoint.ts | 13 ++----------- .../src/model/ApiPackage.ts | 4 ++-- .../etc/api-documenter-test.api.json | 5 +++++ common/reviews/api/api-extractor-model.api.md | 2 +- 6 files changed, 21 insertions(+), 24 deletions(-) diff --git a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts index 674a8776d17..85fb812c7fe 100644 --- a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information.s -import { StringChecks } from '@microsoft/tsdoc/lib/parser/StringChecks'; +import { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem'; import { DeserializerContext } from '../model/DeserializerContext'; @@ -49,7 +49,7 @@ export interface ApiNameMixin extends ApiItem { serializeInto(jsonObject: Partial): void; /** @internal */ - _getCanonicalReferenceName(): string; + _getCanonicalReferenceName(): string | DeclarationReference; } /** @@ -100,14 +100,15 @@ export function ApiNameMixin(baseClass: } /** @internal */ - public _getCanonicalReferenceName(): string { - // TODO: This is a temporary workaround for a limitation of the experimental DeclarationReference API. - // We will remove this when the final implementation is in place. - if (StringChecks.explainIfInvalidUnquotedIdentifier(this.name)) { - return JSON.stringify(this.name); - } else { - return this.name; + public _getCanonicalReferenceName(): string | DeclarationReference { + const name: string = this.name; + if (name[0] === '"') { + return JSON.parse(name); } + if (name[0] === '[') { + return DeclarationReference.parse(name); + } + return name; } } diff --git a/apps/api-extractor-model/src/model/ApiClass.ts b/apps/api-extractor-model/src/model/ApiClass.ts index f9e456faecb..f830e97b941 100644 --- a/apps/api-extractor-model/src/model/ApiClass.ts +++ b/apps/api-extractor-model/src/model/ApiClass.ts @@ -121,7 +121,7 @@ export class ApiClass extends ApiItemContainerMixin(ApiNameMixin(ApiTypeParamete /** @beta @override */ public buildCanonicalReference(): DeclarationReference { return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this.name) + .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) .withMeaning(Meaning.Class); } } diff --git a/apps/api-extractor-model/src/model/ApiEntryPoint.ts b/apps/api-extractor-model/src/model/ApiEntryPoint.ts index eedbc7af830..5697b176215 100644 --- a/apps/api-extractor-model/src/model/ApiEntryPoint.ts +++ b/apps/api-extractor-model/src/model/ApiEntryPoint.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, ModuleSource } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; @@ -56,18 +56,9 @@ export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - let modulePath: string = ''; if (this.parent instanceof ApiPackage) { - modulePath = this.parent.name; - } - - if (this.name) { - modulePath += this.name; - } - - if (modulePath) { - return new DeclarationReference(new ModuleSource(modulePath)); + return DeclarationReference.package(this.parent.name, this.name); } return DeclarationReference.empty(); diff --git a/apps/api-extractor-model/src/model/ApiPackage.ts b/apps/api-extractor-model/src/model/ApiPackage.ts index f48ccb67954..0c6058ece07 100644 --- a/apps/api-extractor-model/src/model/ApiPackage.ts +++ b/apps/api-extractor-model/src/model/ApiPackage.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, ModuleSource } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, ApiItemKind, IApiItemJson } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { JsonFile, IJsonFileSaveOptions, PackageJsonLookup, IPackageJson } from '@microsoft/node-core-library'; @@ -207,6 +207,6 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented /** @beta @override */ public buildCanonicalReference(): DeclarationReference { - return DeclarationReference.module(this.name); + return DeclarationReference.package(this.name); } } diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index 1f73192bc31..b032c01e8d3 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -689,6 +689,7 @@ }, { "kind": "Namespace", + "canonicalReference": "api-documenter-test!EcmaSmbols:namespace", "docComment": "/**\n * A namespace containing an ECMAScript symbol\n *\n * @public\n */\n", "excerptTokens": [ { @@ -709,6 +710,7 @@ "members": [ { "kind": "Variable", + "canonicalReference": "api-documenter-test!EcmaSmbols.example:var", "docComment": "/**\n * An ECMAScript symbol\n */\n", "excerptTokens": [ { @@ -1017,6 +1019,7 @@ "members": [ { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface3#\"[not.a.symbol]\":member", "docComment": "/**\n * An identifier that does needs quotes. It misleadingly looks like an ECMAScript symbol.\n */\n", "excerptTokens": [ { @@ -1041,6 +1044,7 @@ }, { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface3#[[EcmaSmbols.example]]:member", "docComment": "/**\n * ECMAScript symbol\n */\n", "excerptTokens": [ { @@ -1207,6 +1211,7 @@ }, { "kind": "PropertySignature", + "canonicalReference": "api-documenter-test!IDocInterface3#redundantQuotes:member", "docComment": "/**\n * A quoted identifier with redundant quotes.\n */\n", "excerptTokens": [ { diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index a5ee27bdeee..ed4d2de8032 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -382,7 +382,7 @@ export function ApiNameMixin(baseClass: // @public export interface ApiNameMixin extends ApiItem { // @internal (undocumented) - _getCanonicalReferenceName(): string; + _getCanonicalReferenceName(): string | DeclarationReference; readonly name: string; // @override (undocumented) serializeInto(jsonObject: Partial): void; From dec3e004b16e7be4cd3164ef9906c0c67f50df2f Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 22 Jul 2019 18:53:49 -0700 Subject: [PATCH 12/22] Workaround for double-bracketing of symbols --- apps/api-extractor-model/src/mixins/ApiNameMixin.ts | 3 ++- .../api-documenter-test/etc/api-documenter-test.api.json | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts index 85fb812c7fe..a1125589bf8 100644 --- a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts @@ -106,7 +106,8 @@ export function ApiNameMixin(baseClass: return JSON.parse(name); } if (name[0] === '[') { - return DeclarationReference.parse(name); + // Unwrap the [] and parse the reference + return DeclarationReference.parse(name.substr(1, name.length - 2)); } return name; } diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index b032c01e8d3..f141ce469e5 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -1044,7 +1044,7 @@ }, { "kind": "PropertySignature", - "canonicalReference": "api-documenter-test!IDocInterface3#[[EcmaSmbols.example]]:member", + "canonicalReference": "api-documenter-test!IDocInterface3#[EcmaSmbols.example]:member", "docComment": "/**\n * ECMAScript symbol\n */\n", "excerptTokens": [ { From d3ff003b624b9b290aa84e56b0733f91b4a63a26 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Tue, 23 Jul 2019 17:25:27 -0700 Subject: [PATCH 13/22] Replace _getCanonicalReferenceName() workaround with new TSDoc API DeclarationReference.parseComponent() --- .../src/mixins/ApiNameMixin.ts | 17 ----------------- apps/api-extractor-model/src/model/ApiClass.ts | 5 +++-- apps/api-extractor-model/src/model/ApiEnum.ts | 5 +++-- .../src/model/ApiEnumMember.ts | 5 +++-- .../src/model/ApiFunction.ts | 5 +++-- .../src/model/ApiInterface.ts | 5 +++-- apps/api-extractor-model/src/model/ApiMethod.ts | 5 +++-- .../src/model/ApiMethodSignature.ts | 5 +++-- .../src/model/ApiNamespace.ts | 5 +++-- .../src/model/ApiProperty.ts | 5 +++-- .../src/model/ApiPropertySignature.ts | 5 +++-- .../src/model/ApiTypeAlias.ts | 5 +++-- .../src/model/ApiVariable.ts | 5 +++-- common/reviews/api/api-extractor-model.api.md | 2 -- 14 files changed, 36 insertions(+), 43 deletions(-) diff --git a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts index a1125589bf8..daa691a790d 100644 --- a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information.s -import { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem'; import { DeserializerContext } from '../model/DeserializerContext'; @@ -47,9 +46,6 @@ export interface ApiNameMixin extends ApiItem { /** @override */ serializeInto(jsonObject: Partial): void; - - /** @internal */ - _getCanonicalReferenceName(): string | DeclarationReference; } /** @@ -98,19 +94,6 @@ export function ApiNameMixin(baseClass: jsonObject.name = this.name; } - - /** @internal */ - public _getCanonicalReferenceName(): string | DeclarationReference { - const name: string = this.name; - if (name[0] === '"') { - return JSON.parse(name); - } - if (name[0] === '[') { - // Unwrap the [] and parse the reference - return DeclarationReference.parse(name.substr(1, name.length - 2)); - } - return name; - } } return MixedClass; diff --git a/apps/api-extractor-model/src/model/ApiClass.ts b/apps/api-extractor-model/src/model/ApiClass.ts index f830e97b941..086781ac5f4 100644 --- a/apps/api-extractor-model/src/model/ApiClass.ts +++ b/apps/api-extractor-model/src/model/ApiClass.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; @@ -120,8 +120,9 @@ export class ApiClass extends ApiItemContainerMixin(ApiNameMixin(ApiTypeParamete /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Class); } } diff --git a/apps/api-extractor-model/src/model/ApiEnum.ts b/apps/api-extractor-model/src/model/ApiEnum.ts index 6db9257e895..87c56d32a88 100644 --- a/apps/api-extractor-model/src/model/ApiEnum.ts +++ b/apps/api-extractor-model/src/model/ApiEnum.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -75,8 +75,9 @@ export class ApiEnum extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMix /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Enum); } } diff --git a/apps/api-extractor-model/src/model/ApiEnumMember.ts b/apps/api-extractor-model/src/model/ApiEnumMember.ts index 01d7a07569a..f52908fb29c 100644 --- a/apps/api-extractor-model/src/model/ApiEnumMember.ts +++ b/apps/api-extractor-model/src/model/ApiEnumMember.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -90,8 +90,9 @@ export class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredIt /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Member); } } diff --git a/apps/api-extractor-model/src/model/ApiFunction.ts b/apps/api-extractor-model/src/model/ApiFunction.ts index 9c4d9b04d88..c55c9a21799 100644 --- a/apps/api-extractor-model/src/model/ApiFunction.ts +++ b/apps/api-extractor-model/src/model/ApiFunction.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; @@ -67,8 +67,9 @@ export class ApiFunction extends ApiNameMixin(ApiTypeParameterListMixin(ApiParam /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Function) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiInterface.ts b/apps/api-extractor-model/src/model/ApiInterface.ts index d9757483fc4..0f3195d7b21 100644 --- a/apps/api-extractor-model/src/model/ApiInterface.ts +++ b/apps/api-extractor-model/src/model/ApiInterface.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions, IApiItemContainerJson } from '../mixins/ApiItemContainerMixin'; @@ -107,8 +107,9 @@ export class ApiInterface extends ApiItemContainerMixin(ApiNameMixin(ApiTypePara /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Interface); } } diff --git a/apps/api-extractor-model/src/model/ApiMethod.ts b/apps/api-extractor-model/src/model/ApiMethod.ts index 0c67fc7524e..005b612c01c 100644 --- a/apps/api-extractor-model/src/model/ApiMethod.ts +++ b/apps/api-extractor-model/src/model/ApiMethod.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; @@ -73,8 +73,9 @@ export class ApiMethod extends ApiNameMixin(ApiTypeParameterListMixin(ApiParamet /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, this._getCanonicalReferenceName()) + .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent) .withMeaning(Meaning.Member) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiMethodSignature.ts b/apps/api-extractor-model/src/model/ApiMethodSignature.ts index 6dd27896607..4175990fe6a 100644 --- a/apps/api-extractor-model/src/model/ApiMethodSignature.ts +++ b/apps/api-extractor-model/src/model/ApiMethodSignature.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions } from '../items/ApiDeclaredItem'; import { ApiParameterListMixin, IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin'; @@ -64,8 +64,9 @@ export class ApiMethodSignature extends ApiNameMixin(ApiTypeParameterListMixin(A /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Members, nameComponent) .withMeaning(Meaning.Member) .withOverloadIndex(this.overloadIndex); } diff --git a/apps/api-extractor-model/src/model/ApiNamespace.ts b/apps/api-extractor-model/src/model/ApiNamespace.ts index 3a8012fa723..56f83971231 100644 --- a/apps/api-extractor-model/src/model/ApiNamespace.ts +++ b/apps/api-extractor-model/src/model/ApiNamespace.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin'; import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; @@ -63,8 +63,9 @@ export class ApiNamespace extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseT /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Namespace); } } diff --git a/apps/api-extractor-model/src/model/ApiProperty.ts b/apps/api-extractor-model/src/model/ApiProperty.ts index a3bb92beff0..3bb7ee71981 100644 --- a/apps/api-extractor-model/src/model/ApiProperty.ts +++ b/apps/api-extractor-model/src/model/ApiProperty.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyItem'; @@ -74,8 +74,9 @@ export class ApiProperty extends ApiStaticMixin(ApiPropertyItem) { /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, this._getCanonicalReferenceName()) + .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent) .withMeaning(Meaning.Member); } } diff --git a/apps/api-extractor-model/src/model/ApiPropertySignature.ts b/apps/api-extractor-model/src/model/ApiPropertySignature.ts index 669149ed722..db3da87eb9b 100644 --- a/apps/api-extractor-model/src/model/ApiPropertySignature.ts +++ b/apps/api-extractor-model/src/model/ApiPropertySignature.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyItem'; @@ -56,8 +56,9 @@ export class ApiPropertySignature extends ApiPropertyItem { /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Members, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Members, nameComponent) .withMeaning(Meaning.Member); } } diff --git a/apps/api-extractor-model/src/model/ApiTypeAlias.ts b/apps/api-extractor-model/src/model/ApiTypeAlias.ts index bc28c5571c9..a3e1c56d4f6 100644 --- a/apps/api-extractor-model/src/model/ApiTypeAlias.ts +++ b/apps/api-extractor-model/src/model/ApiTypeAlias.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; @@ -107,8 +107,9 @@ export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiRele /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.TypeAlias); } } diff --git a/apps/api-extractor-model/src/model/ApiVariable.ts b/apps/api-extractor-model/src/model/ApiVariable.ts index db6b20584b4..6c94aef6605 100644 --- a/apps/api-extractor-model/src/model/ApiVariable.ts +++ b/apps/api-extractor-model/src/model/ApiVariable.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; +import { DeclarationReference, Meaning, Navigation, Component } from '@microsoft/tsdoc/lib/beta/DeclarationReference'; import { ApiItemKind } from '../items/ApiItem'; import { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem'; import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; @@ -89,8 +89,9 @@ export class ApiVariable extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem /** @beta @override */ public buildCanonicalReference(): DeclarationReference { + const nameComponent: Component = DeclarationReference.parseComponent(this.name); return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty()) - .addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName()) + .addNavigationStep(Navigation.Exports, nameComponent) .withMeaning(Meaning.Variable); } } diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index ed4d2de8032..3c97332d0e7 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -381,8 +381,6 @@ export function ApiNameMixin(baseClass: // @public export interface ApiNameMixin extends ApiItem { - // @internal (undocumented) - _getCanonicalReferenceName(): string | DeclarationReference; readonly name: string; // @override (undocumented) serializeInto(jsonObject: Partial): void; From 1049df121f7738a0df5de17a8a87cb815fc2ae03 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Tue, 23 Jul 2019 17:45:08 -0700 Subject: [PATCH 14/22] Upgrade TSDoc --- apps/api-documenter/package.json | 2 +- apps/api-extractor-model/package.json | 2 +- apps/api-extractor/package.json | 2 +- common/config/rush/pnpm-lock.yaml | 100 +++++++++++++------------- 4 files changed, 53 insertions(+), 53 deletions(-) diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json index a77be5fd5f3..08b7f87afaa 100644 --- a/apps/api-documenter/package.json +++ b/apps/api-documenter/package.json @@ -18,7 +18,7 @@ "@microsoft/api-extractor-model": "7.3.0", "@microsoft/node-core-library": "3.13.0", "@microsoft/ts-command-line": "4.2.6", - "@microsoft/tsdoc": "0.12.10", + "@microsoft/tsdoc": "0.12.11", "colors": "~1.2.1", "js-yaml": "~3.13.1" }, diff --git a/apps/api-extractor-model/package.json b/apps/api-extractor-model/package.json index c8354e026f7..f3d560a7f6d 100644 --- a/apps/api-extractor-model/package.json +++ b/apps/api-extractor-model/package.json @@ -18,7 +18,7 @@ }, "dependencies": { "@microsoft/node-core-library": "3.13.0", - "@microsoft/tsdoc": "0.12.10", + "@microsoft/tsdoc": "0.12.11", "@types/node": "8.5.8" }, "devDependencies": { diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index 475e37983cb..7047b571d00 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -38,7 +38,7 @@ "@microsoft/api-extractor-model": "7.3.0", "@microsoft/node-core-library": "3.13.0", "@microsoft/ts-command-line": "4.2.6", - "@microsoft/tsdoc": "0.12.10", + "@microsoft/tsdoc": "0.12.11", "colors": "~1.2.1", "lodash": "~4.17.5", "resolve": "1.8.1", diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 1a868463640..8a7f0ab0f2a 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -2,7 +2,7 @@ dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@pnpm/link-bins': 1.0.3 '@pnpm/logger': 1.0.2 '@rush-temp/api-documenter': 'file:projects/api-documenter.tgz' @@ -356,10 +356,10 @@ packages: dev: false resolution: integrity: sha512-GFLPg9Z5yiNca3di/V6Zt3tAvj1de9EK0eL88tE+1eckQSH405UQcm7D+H8LbEhRpqpG+ZqN9LXCAEw4L5uchg== - /@microsoft/tsdoc/0.12.10: + /@microsoft/tsdoc/0.12.11: dev: false resolution: - integrity: sha512-tsog/HTdM88/WyR0Jz7XWTI0ghbJkt9soFXnQJrINDyaTGzbCoJjRttaW/IY5eAp4eqDyfg++jq6o+byEDOkIQ== + integrity: sha512-CXAEl/mTBkr+KcX/+Xi7wbNBnofZ1p2UwYbaJ+zwcVMCWQTMsheqkOwPM3BQ7J6uOacxwxO6rBRDjQqBdfe8dQ== /@microsoft/tsdoc/0.12.9: dev: false resolution: @@ -1743,7 +1743,7 @@ packages: dependencies: caniuse-lite: 1.0.30000985 electron-to-chromium: 1.3.199 - node-releases: 1.1.25 + node-releases: 1.1.26 dev: false hasBin: true resolution: @@ -2422,7 +2422,7 @@ packages: /deasync/0.1.15: dependencies: bindings: 1.2.1 - node-addon-api: 1.6.3 + node-addon-api: 1.7.1 dev: false engines: node: '>=0.11.0' @@ -6374,10 +6374,10 @@ packages: dev: false resolution: integrity: sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ== - /node-addon-api/1.6.3: + /node-addon-api/1.7.1: dev: false resolution: - integrity: sha512-FXWH6mqjWgU8ewuahp4spec8LkroFZK2NicOv6bNwZC3kcwZUI8LeZdG80UzTSLLhK4T7MsgNwlYDVRlDdfTDg== + integrity: sha512-2+DuKodWvwRTrCfKOeR24KIc5unKjOh8mz17NCzVnHWfjAdDqbfbjqh7gUT+BkXBRQM52+xCHciKWonJ3CbJMQ== /node-fetch/2.1.2: dev: false engines: @@ -6459,12 +6459,12 @@ packages: dev: false resolution: integrity: sha512-SUDEb+o71XR5lXSTyivXd9J7fCloE3SyP4lSgt3lU2oSANiox+SxlNRGPjDKrwU1YN3ix2KN/VGGCg0t01rttQ== - /node-releases/1.1.25: + /node-releases/1.1.26: dependencies: semver: 5.3.0 dev: false resolution: - integrity: sha512-fI5BXuk83lKEoZDdH3gRhtsNgh05/wZacuXkgbiYkceE7+QIMXOg98n9ZV7mz27B+kFHnqHcUpscZZlGRSmTpQ== + integrity: sha512-fZPsuhhUHMTlfkhDLGtfY80DSJTjOcx+qD1j5pqPkuhUHVS7xHZIg9EE4DHK8O3f0zTxXHX5VIkDG8pu98/wfQ== /node-sass/4.12.0: dependencies: async-foreach: 0.1.3 @@ -9679,12 +9679,12 @@ packages: dev: false name: '@rush-temp/api-documenter-test' resolution: - integrity: sha512-Zam+qc4AXT7DQK5q938pxnT47G3jczL+WDiQhdR3c4kzQWfmR9i5Gj6aMn1D4Z0XlCAiU9T/vPYHE8ja2/klLw== + integrity: sha512-3wJ5byaOXb/q3JKGmf2TGM2LXHGIhs3An+Zjt8rYsL0+SCGkoCssjKqTXJ8SN7T7q9OCHFC338PUF2vEcIfYhw== tarball: 'file:projects/api-documenter-test.tgz' version: 0.0.0 'file:projects/api-documenter.tgz': dependencies: - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/js-yaml': 3.12.1 '@types/node': 8.5.8 @@ -9695,7 +9695,7 @@ packages: dev: false name: '@rush-temp/api-documenter' resolution: - integrity: sha512-sj4YTYB/Xgxor9rEYpNrBJfq1zKuM5qwhCC6G1UsL35jhDBuJapDCoC0eH0yZEx/AJBvTT48ggPDBALkusZWeQ== + integrity: sha512-lnvU8tYp01xCCOo/MMzdznwivkaUAskKy5xPmZS6cDc8GmnbXVPztJKQx5wMS+bocHs3Ih5CakDFha56aXPBzg== tarball: 'file:projects/api-documenter.tgz' version: 0.0.0 'file:projects/api-extractor-lib1-test.tgz': @@ -9738,7 +9738,7 @@ packages: dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/node': 8.5.8 gulp: 4.0.2 @@ -9746,7 +9746,7 @@ packages: dev: false name: '@rush-temp/api-extractor-model' resolution: - integrity: sha512-1w3u75gE6OtAy3p+gRSckt2kr/sjUF2uiZ3AhDPGb+pNqdMJGCNfwoOan17A0IOH6bSKK+N7EpUTrcxzM3/btw== + integrity: sha512-rb6jgpLT8jVuHTqlAh/ZzvHqFr66BNvXlp6dOGhJO3u5oH/pB3U7EMwL6QIFGwNHVilmxDo5UVa6V7zeFDM1zQ== tarball: 'file:projects/api-extractor-model.tgz' version: 0.0.0 'file:projects/api-extractor-scenarios.tgz': @@ -9816,7 +9816,7 @@ packages: dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/lodash': 4.14.116 '@types/node': 8.5.8 @@ -9829,7 +9829,7 @@ packages: dev: false name: '@rush-temp/api-extractor' resolution: - integrity: sha512-8F805AyGMOXEc55yOQy0NnKS4ek6lbYGTAP0lFGMRxlB04BXbuQW10mIFSDTv8umgS6QYa3KH+8msf99G70PgQ== + integrity: sha512-9w2YOm/Y1jcojcxLZHaI0kA79+sybNtdYvFOU8ggE36moJQy4UnYjhb0l/3MDQp9300jxo6CBnRIcKyFocE8ig== tarball: 'file:projects/api-extractor.tgz' version: 0.0.0 'file:projects/gulp-core-build-mocha.tgz': @@ -9851,7 +9851,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-mocha' resolution: - integrity: sha512-KkMARSU9gvLFiJMchJC2B0a7yTOfyci6Z3Jt2rr6ZbmYULt5qBM+Ft4ur/qm+Ges8Z0QUgChWk8tQMiiyiby8w== + integrity: sha512-89gWdcudza1UYiqwgGS65UoWZJcKZRJrZTztWWfRqLnJTYCLaMq2uYrkBrKR5swMs3efXHI8uoNnwM00qe8RXQ== tarball: 'file:projects/gulp-core-build-mocha.tgz' version: 0.0.0 'file:projects/gulp-core-build-sass.tgz': @@ -9873,7 +9873,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-sass' resolution: - integrity: sha512-/geSNXjxtIHqBrYZwTRgsSBhGgX9dT1iiMkiNNphf6BmG6Xk7FZiBpeo2CIkhHAsHY1NffiKRS/DpxbItVuuiw== + integrity: sha512-gkcb/FfZlJkpB5NUITUWot56zpGtrryECMXQz8SHPGrc8F4fD4IkInsMilAH1w2+ZYfTxJ35kEND3VqDDaNAEw== tarball: 'file:projects/gulp-core-build-sass.tgz' version: 0.0.0 'file:projects/gulp-core-build-serve.tgz': @@ -9900,7 +9900,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-serve' resolution: - integrity: sha512-0sfEzJyePqzRGKq12k9AB6lZmE2vNuS/kNsISnOBl1HybEfbxbB06EfIVxj/eOvoq4rJTjUFL9iYwPtx1rt+Ig== + integrity: sha512-Z0ZJ2PfCWjhIIHaBLzLWcuuolqUzJlDloPtS3gNJwFDvZc+zpAT8DGbqKCrILbdfU4yS3EOcwDLgnZZvSSgeKQ== tarball: 'file:projects/gulp-core-build-serve.tgz' version: 0.0.0 'file:projects/gulp-core-build-typescript.tgz': @@ -9920,7 +9920,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-typescript' resolution: - integrity: sha512-PawvE7L5/bhIinYgbmptO6u1KAAiUI6Fa8VB2DsiEYjJCf0ZlicPNVySwbAWQEEfjr13FoBiGxX+77VKLzqrBA== + integrity: sha512-0pyF5UEktFV6NHumZxDv+noBlFifrI4Vom3JBMn4ARkEpr8vMspqEvcwnuXw+52hoiA+2krHHHt33XaiXCOdbw== tarball: 'file:projects/gulp-core-build-typescript.tgz' version: 0.0.0 'file:projects/gulp-core-build-webpack.tgz': @@ -9938,7 +9938,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-webpack' resolution: - integrity: sha512-dsj+YHuIVa6xkjWXpukIehy8SYaBDRKzSsVJ4ll9ws/7avYnYdGeckX2/E4rTUOsDt+UeL+IBGzL9cDumwgxbw== + integrity: sha512-mEQ7xsUySAICJpLwZZPQULvK/dMnn8NnAY++ciB0DcLTJBFOy9RBJmVLa1I8KooLxo591I1/7HV0aecM+csUIQ== tarball: 'file:projects/gulp-core-build-webpack.tgz' version: 0.0.0 'file:projects/gulp-core-build.tgz': @@ -10000,7 +10000,7 @@ packages: dev: false name: '@rush-temp/load-themed-styles' resolution: - integrity: sha512-wzKpjG/jHMyXfu4y0ZVN6/YpM141M/s/qgJShppFPPZzFBiKrM3QR4HuSfOqNQYbuBlpSDC0DhisPDD+mV93+A== + integrity: sha512-+ckSlRxDbkoyfyAeukiZ5kzULdIQ9HJ/ssodoybqTllNl+WvG+SRhbIdje/up6SMgr8MEwP8i0tSEKo/GEHVdA== tarball: 'file:projects/load-themed-styles.tgz' version: 0.0.0 'file:projects/loader-load-themed-styles.tgz': @@ -10015,7 +10015,7 @@ packages: dev: false name: '@rush-temp/loader-load-themed-styles' resolution: - integrity: sha512-rMawxM/8QCVF2HPUfoMSIRvnQm448mFCJSnhOb/L9Wc7nCuEvdJiRAhEIai0a30Nd2MhRWkUEc21hJMc5ejQgw== + integrity: sha512-nAXvxfWQaO+txZU8Kvcp5zZpqhVLSYY1adclnl6f9iyqMtKtXYAzZYZddK7vl2KxbgLFuqtVdgym13QFadUMhA== tarball: 'file:projects/loader-load-themed-styles.tgz' version: 0.0.0 'file:projects/loader-raw-script.tgz': @@ -10029,7 +10029,7 @@ packages: dev: false name: '@rush-temp/loader-raw-script' resolution: - integrity: sha512-5mzlLCs+BxEqGouDHRSTLenublW8vXbKPd3ppKR70+AXzJcyKuUbx+CPmVybd7ygi6/Yj8j+4ctrMybtRmW7kg== + integrity: sha512-QofoEJ4o3lsjbeQ4CG17LNoqVVk8bmJnOkyR07YngkIgvUBROkU29pubdMxwG2CvcmJTlhIVblWrCqtrg8wuxg== tarball: 'file:projects/loader-raw-script.tgz' version: 0.0.0 'file:projects/loader-set-webpack-public-path.tgz': @@ -10045,7 +10045,7 @@ packages: dev: false name: '@rush-temp/loader-set-webpack-public-path' resolution: - integrity: sha512-xNSzHmJJYj2/qpnmJNZ1Z+yCE+E13YuGkuNu2wqWJ0NqE3o2zQ1wc2EkxZZ4dKb5/RTvYdzYlaIV2PKByUYluw== + integrity: sha512-5HlCPx0ItSF/Q1yBOPsvnGKdlRSX9S9uWQsKBLG7DhddNf43GxDptthgpyEz9cb/TmaoVayaDgpld0jiQuFTAw== tarball: 'file:projects/loader-set-webpack-public-path.tgz' version: 0.0.0 'file:projects/node-core-library.tgz': @@ -10079,7 +10079,7 @@ packages: dev: false name: '@rush-temp/node-library-build-test' resolution: - integrity: sha512-psLD46w190FM7BOTmPpgEXSYrReNkmLGOVIHOtlSgHHkU4xbLBDc3PXFDUSD0hflGW2ybRtiYkw6wUjLzqsGWg== + integrity: sha512-AgQD9nFCjtd+6iROHTKmMS0eIXjLq86nbnjN2Re6bHi2A2ZQ6LlKi+/Vy4bGhQRryZoOzQx34jB4ibTrr7bBAg== tarball: 'file:projects/node-library-build-test.tgz' version: 0.0.0 'file:projects/node-library-build.tgz': @@ -10090,7 +10090,7 @@ packages: dev: false name: '@rush-temp/node-library-build' resolution: - integrity: sha512-NC/NWeiUZMgLAYXTjFL7HFJsz9EBg0Wu9khglf3UxqtinC5zRLSRii6/ct00RgMSnbBGvUAMD51D5hNQVHn5lQ== + integrity: sha512-PSB9Z0e6R/hD0G3mVKcIEeNknlVRqa2y4EvCoaFSYhKdTrYHCOxMBKU1d3EuasbUB0IH2fC3HVc0QlmoHYy11A== tarball: 'file:projects/node-library-build.tgz' version: 0.0.0 'file:projects/package-deps-hash.tgz': @@ -10103,7 +10103,7 @@ packages: dev: false name: '@rush-temp/package-deps-hash' resolution: - integrity: sha512-ybKkMWJ/gypu2S/jP36531+hzzJVOLle5x5PQNhZmj8bLFhrGPRkac6E0GSJErSQbLj3LLUMjrtmdYijOsf/OA== + integrity: sha512-kMkENqzEi7U4fReV7xulU80NEQ4KrbbKztBSN9ESbIisBlADOxYuZP5eFD87hsutByijTGQT1AqhFiUrmYT0tA== tarball: 'file:projects/package-deps-hash.tgz' version: 0.0.0 'file:projects/resolve-chunk-plugin.tgz': @@ -10116,7 +10116,7 @@ packages: dev: false name: '@rush-temp/resolve-chunk-plugin' resolution: - integrity: sha512-NZqeW7i2/ch9CKk1IkdOv4zVESVQAMzazAOnfZIVD0nkWlxPWbCUI28zx8/XuQiPGaw8gf8kpAdOj1gXbMbuqQ== + integrity: sha512-TVV8J48O8MDAMOT7R5bgPVlauDQuFixQY0znkmJT5KRV8XvAN5dPH9RGBv3oYY1+02GTPvAaY+3mm5SptqcflA== tarball: 'file:projects/resolve-chunk-plugin.tgz' version: 0.0.0 'file:projects/rush-buildxl.tgz': @@ -10127,7 +10127,7 @@ packages: dev: false name: '@rush-temp/rush-buildxl' resolution: - integrity: sha512-TkIo3V0IdcOlfeUXx4lTkNcdMnHwUaaNk0BLgzlO38wSMKC0XB3+Xhl6OaMGzPQGyw4Yff7s52Lzgc6ll7pleg== + integrity: sha512-fsDHrftTnadUhs5TVww3pdwO1WoxPVDjQV7majZUTmqbj43YDLYPhNnlKJjBsqp6awxObw5VcwgIiiH0xOXmVQ== tarball: 'file:projects/rush-buildxl.tgz' version: 0.0.0 'file:projects/rush-lib.tgz': @@ -10169,7 +10169,7 @@ packages: dev: false name: '@rush-temp/rush-lib' resolution: - integrity: sha512-4q9dyw9caxnnmFv/nz0SW0GNgTpMKzfpRAs65SaN+P6D8+UjwjnnOxMdZfyuIPi0J3QmuFepFW76ebK/GLO3GA== + integrity: sha512-rIQWW5cCD+MtyGPU1f4ye2zlGsjnNqNOS4esrmQwuSywFrSH6W+J+aKzR+hBoGuau7JJRdrXwK69UdXnL0rDEA== tarball: 'file:projects/rush-lib.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.4-library-test.tgz': @@ -10179,7 +10179,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.4-library-test' resolution: - integrity: sha512-FTP62X6SA2oObepD6k6yjMiAGLuZubvK8eAp4bo5DUeU6E7I8XukjRyhHCtAK8PcCUUooW3cN6YJsQcsV3BpQA== + integrity: sha512-jHBI/hoMAHJTrBbflE5RdN7HtbCgfeKguFBhEAsERCkbK4q59dDf1rc9mYOUV1bbXeTMbn+5eZaL6isukQgr1Q== tarball: 'file:projects/rush-stack-compiler-2.4-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.4.tgz': @@ -10204,7 +10204,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.7-library-test' resolution: - integrity: sha512-u0rUUJGiVOv1x0yHth0KF1oKgOOn7fSxAJ7yKdhSEFCV5ZatMfmG9J5KeqQkSzU5tjnmaC+/XNxv6xKVRQU+TA== + integrity: sha512-0EzdOcsSRCytg4wa8RsV5+80etUpL07cttBFxG24k+Up6tC/DEfWEkXwc81R362wLrcxMfK2bdBs4B3O22pnhA== tarball: 'file:projects/rush-stack-compiler-2.7-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.7.tgz': @@ -10229,7 +10229,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.8-library-test' resolution: - integrity: sha512-CrmavyMelw0G60bflIfX45sTBRGquakhmH7W0EzgPDIhZQXLrUXgrTW7zOmW6y8W+aeVJzE8Tb9gSMkYhOzC4A== + integrity: sha512-t0VC/3q1S1XSag5Ity+wAvYiGz4pWSHo30pEd89ci7S9Q0oIuURf97O1NYFV5P4Za8t2he52Boi8byJEBnOdeg== tarball: 'file:projects/rush-stack-compiler-2.8-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.8.tgz': @@ -10254,7 +10254,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.9-library-test' resolution: - integrity: sha512-vLUQcUDfz+lcEABxclb7k0KRjPaL/tlJy5fFldM/E41uud3QdST8kEjRs0pPj39sBktFiQwA8qz7bOcZLMN9Vg== + integrity: sha512-58DY1Phoe0Guh5jlVtfL3EzUwqmazxLbiPwsthfgQLaK5cQx/pc74okUS9K596GS3U6owCWGOagiT8jZsvPpKA== tarball: 'file:projects/rush-stack-compiler-2.9-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.9.tgz': @@ -10279,7 +10279,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.0-library-test' resolution: - integrity: sha512-nn+XSnxuPqem/gwv9d3JRODBX/5SHmkbZvJg1J5i91w8ePEhGB/yMbU1n6JBa89ot8qeSjFYZJKahFDv0hgOeg== + integrity: sha512-Axyn3z615o3jzXQxNf8j4PWlhLhtYaDVRWpb732VHFSmb3Q7kVfeP+NBwJfkbQTBTD0OmbTe+r7UrLFl2DYFqg== tarball: 'file:projects/rush-stack-compiler-3.0-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.0.tgz': @@ -10304,7 +10304,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.1-library-test' resolution: - integrity: sha512-+B8BxCUHqqCecDO68Uq3BCNtHc9JU75GkEh4ryxDkYPnWGt1DPcZNYfhOnUlgJglkaiWZFjahaZl9nv3n9jopg== + integrity: sha512-fHm6VkNO3KsRMQojt2gXPc8hjfEbrb437/gu9Yr+qasRpXZR/3hk4bjRWsOqqKoBpglbRmUTUNpzjt7Vv2isrQ== tarball: 'file:projects/rush-stack-compiler-3.1-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.1.tgz': @@ -10329,7 +10329,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.2-library-test' resolution: - integrity: sha512-rmq0ObLdU586NLo7JRJ7RCjvbl4q8SUkBwuK0OH1QZcs+H/aeQpMzh/I0fGfSGKiXAPjJlMoQ2Dm8o+ik2D7Bw== + integrity: sha512-+eLxnaVxyUkzqE8XmGb9e4t7DghmYqNQoKbfjaXaafzF5l3wsscBGY90W9ZsNEvOXrv7cl90eDJ9gE3ww58aQA== tarball: 'file:projects/rush-stack-compiler-3.2-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.2.tgz': @@ -10354,7 +10354,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.3-library-test' resolution: - integrity: sha512-LYS5A52j619JccssEPR6jXoWwIto2vRbGkRZKlMJcwZD6/+K7NYZz+GXwHKxgbgAChC1iMx1RmTEwf634zgR+A== + integrity: sha512-HN48JRzWOVBlxeH6ZegCgUjadvusCNWSggOjgI5bF/uhJFYWafK3nJCb3yZsXaTABPfiqLqT5wU652LmOGCJ0w== tarball: 'file:projects/rush-stack-compiler-3.3-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.3.tgz': @@ -10379,7 +10379,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.4-library-test' resolution: - integrity: sha512-X54oQgZyGEg1Bwqcm0/HIr8Cwj1pqu5OksOvKqkVXFLMiu7mvCiYzMpal7iWl/e5GdzclL5h0+7PMyV5+GWUSA== + integrity: sha512-hxawtUM+Z0a11EXQyMukJghKouAZdgos9eTp63KaRv1JQ4NZvmy6YMhNP4pqbrrMDC7IqLM4H/SuU/zj64IzsA== tarball: 'file:projects/rush-stack-compiler-3.4-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.4.tgz': @@ -10404,7 +10404,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.5-library-test' resolution: - integrity: sha512-378UBBM6iinHRDfnBfXCHp+kbyXn1YV20ugRdPqyKmbt2Irt++2BOoiuHZp5BKB+cDl57MTaLIXghQDxUeIQ4Q== + integrity: sha512-sxc/wnVaAG84RZYt9xCnNgEBCGnORciaWFjkKscqS5ZNXBmussITzaYWNDnluqT21HLrN3Y31iLIYx8u1Ol7+w== tarball: 'file:projects/rush-stack-compiler-3.5-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.5.tgz': @@ -10433,7 +10433,7 @@ packages: dev: false name: '@rush-temp/rush-stack-library-test' resolution: - integrity: sha512-1z2UIMxox1RnhXlUGZ8tts3BARGlae3OlXP4Uimnca8AplldJpHV1INKOMQyJJX3KIeCStCMquwhcLoIoo3Zvg== + integrity: sha512-60WDnR9kaN2Lr775Nx14M2mi+t5CBwjETUV1TlY1YkseaKeG/F9MQhq3ZJQis/dQ3M2vAToPeAImDMYSuWVGeA== tarball: 'file:projects/rush-stack-library-test.tgz' version: 0.0.0 'file:projects/rush-stack.tgz': @@ -10444,7 +10444,7 @@ packages: dev: false name: '@rush-temp/rush-stack' resolution: - integrity: sha512-HPK2/idpIORmePJgSxpqyyBbSXMI9l47W2nIuDPkuMpvRppr1x9yZMcuPpKBjpTcswyijx5Go8jQfClysyHU8g== + integrity: sha512-iqDBGCn+Z259/816/gXSYkf+4GsgRxTWdVINlOHdjvpuj1zT8MX55wd6uxbFhiuHkyvPs/+2flqoug6gI5ZLMA== tarball: 'file:projects/rush-stack.tgz' version: 0.0.0 'file:projects/rush.tgz': @@ -10462,7 +10462,7 @@ packages: dev: false name: '@rush-temp/rush' resolution: - integrity: sha512-AYoVIseCSVj9t+GAFaHg90W9XUnfLhlXIwNQmSGGcEx8UEWyLEPAJoIsz8alT+V42bFY5DS9Ll8rxV9+yF8wzg== + integrity: sha512-sQu633Jnd2GggC/W+8x484enU7vnjjdJHus8p5fno1paCZOX8QCUz2O0uJOxcoEAHtovxKmQhouxwCHZkg5edQ== tarball: 'file:projects/rush.tgz' version: 0.0.0 'file:projects/rushell.tgz': @@ -10475,7 +10475,7 @@ packages: dev: false name: '@rush-temp/rushell' resolution: - integrity: sha512-8S7Is+FiV6PWw2o22dz/sPbxEsERlI23i44UnZ9W1FzaMKahMrZ0lDOLplp2Y89WEybrgXcWR3kLNRmFAKOukw== + integrity: sha512-Z75lByzCBM3rDnVZafP7SA3P4bM3wlcxGLF9rRb2zJ/9iR1FMv0T1xaDTAilrMBYRs51H/q1RutEnjkZ+fh1Mw== tarball: 'file:projects/rushell.tgz' version: 0.0.0 'file:projects/set-webpack-public-path-plugin.tgz': @@ -10494,7 +10494,7 @@ packages: dev: false name: '@rush-temp/set-webpack-public-path-plugin' resolution: - integrity: sha512-vTmuKiMuDk2FCWhBlMjM49VzWaqXWu+u2YijMZeYBuFSwqGGaZg0w12qqnGytNNbGGmLJOw/vUeVzuHqIbzJLg== + integrity: sha512-k7q9rfsXh+RAiReH1V3jDu0Rgfnmvr8OF/No5Bb3eoKzVucmCylJmZ+Vh9oVYFlwngJGuMqUl/Z6MN3PnoZCFA== tarball: 'file:projects/set-webpack-public-path-plugin.tgz' version: 0.0.0 'file:projects/stream-collator.tgz': @@ -10509,7 +10509,7 @@ packages: dev: false name: '@rush-temp/stream-collator' resolution: - integrity: sha512-QkPpquw7j7wHZ5FXkNjK2dfyVr+ol+/eZB+Dg35TWvPTvrqbPfWltec4tZItyLtSvBZgpf06iSOtpIISMnT0Dg== + integrity: sha512-6Nuyd1jWX28Ff/Jp8DP6+nhKkJAJaK+vVzV++nvVNFsGhGh8etDM5YPlFXMpSDzbDNt8pIArXFxeSClE1KqJxQ== tarball: 'file:projects/stream-collator.tgz' version: 0.0.0 'file:projects/ts-command-line.tgz': @@ -10537,7 +10537,7 @@ packages: dev: false name: '@rush-temp/web-library-build-test' resolution: - integrity: sha512-FmKRwxXAVfnNbA2nGEVBPqbzR0ft9GsHHNoO0tjSVf6ltrH9h+VwlXRTwF4F380IKAh4J6KtUz0O3ZKYoq72YA== + integrity: sha512-dvGpQpnBVPjntqfItXV87VNhdNwPm8sokoVM0Ki1xawaBH+zD20HonUP2qjXFcWN5Hek+f/HJ8dcAxKHVrfowg== tarball: 'file:projects/web-library-build-test.tgz' version: 0.0.0 'file:projects/web-library-build.tgz': @@ -10549,7 +10549,7 @@ packages: dev: false name: '@rush-temp/web-library-build' resolution: - integrity: sha512-zbMPfoNDEUUpY8eEI1kV71yOTOqgnYx3fMHPunZJyy7A/krNKag4TgDGRHUUMy0zsQSmXMCgK+J43UNJDqeEzw== + integrity: sha512-3T1D8T+obRzYE6eWTRaALuoSJvd9DBj44S/Q3vwWuA7dxgQd6/vFOfpY+OIuV/ci3AE1953yEvcVuI6Ya9mCdQ== tarball: 'file:projects/web-library-build.tgz' version: 0.0.0 registry: '' @@ -10557,7 +10557,7 @@ specifiers: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@pnpm/link-bins': ~1.0.1 '@pnpm/logger': ~1.0.1 '@rush-temp/api-documenter': 'file:./projects/api-documenter.tgz' From 7a76ff6dae3027afc4701f608d85145e6c1dff8a Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Tue, 23 Jul 2019 17:50:27 -0700 Subject: [PATCH 15/22] rush change --- ...-ae-new-canonical-references_2019-07-24-00-50.json | 11 +++++++++++ ...-ae-new-canonical-references_2019-07-20-08-42.json | 2 +- ...-ae-new-canonical-references_2019-07-24-00-50.json | 11 +++++++++++ 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 common/changes/@microsoft/api-documenter/octogonz-ae-new-canonical-references_2019-07-24-00-50.json create mode 100644 common/changes/@microsoft/api-extractor/octogonz-ae-new-canonical-references_2019-07-24-00-50.json diff --git a/common/changes/@microsoft/api-documenter/octogonz-ae-new-canonical-references_2019-07-24-00-50.json b/common/changes/@microsoft/api-documenter/octogonz-ae-new-canonical-references_2019-07-24-00-50.json new file mode 100644 index 00000000000..cddc05c5a56 --- /dev/null +++ b/common/changes/@microsoft/api-documenter/octogonz-ae-new-canonical-references_2019-07-24-00-50.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "comment": "", + "packageName": "@microsoft/api-documenter", + "type": "none" + } + ], + "packageName": "@microsoft/api-documenter", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file diff --git a/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json b/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json index 48b4768f2e5..9d75a99f682 100644 --- a/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json +++ b/common/changes/@microsoft/api-extractor-model/octogonz-ae-new-canonical-references_2019-07-20-08-42.json @@ -3,7 +3,7 @@ { "packageName": "@microsoft/api-extractor-model", "comment": "(Experimental) Add ApiExtractor.canonicalReference which is a beta implementation of the revised TSDoc declaration reference notation", - "type": "minor" + "type": "patch" } ], "packageName": "@microsoft/api-extractor-model", diff --git a/common/changes/@microsoft/api-extractor/octogonz-ae-new-canonical-references_2019-07-24-00-50.json b/common/changes/@microsoft/api-extractor/octogonz-ae-new-canonical-references_2019-07-24-00-50.json new file mode 100644 index 00000000000..1e70ed5a7ae --- /dev/null +++ b/common/changes/@microsoft/api-extractor/octogonz-ae-new-canonical-references_2019-07-24-00-50.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-extractor", + "comment": "Fix an issue where a function with only one declaration was assigned an overloadIndex of 0 instead of 1", + "type": "patch" + } + ], + "packageName": "@microsoft/api-extractor", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file From 8c247c02530ec293c7ce0231c2729b8a5fb1ee8b Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Tue, 23 Jul 2019 18:34:38 -0700 Subject: [PATCH 16/22] Improve error reporting when the `DeclarationReference` parser fails --- apps/api-extractor-model/src/items/ApiItem.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts index 593bd246727..400ae1dc639 100644 --- a/apps/api-extractor-model/src/items/ApiItem.ts +++ b/apps/api-extractor-model/src/items/ApiItem.ts @@ -108,7 +108,13 @@ export class ApiItem { */ public get canonicalReference(): DeclarationReference { if (!this._canonicalReference) { - this._canonicalReference = this.buildCanonicalReference(); + try { + this._canonicalReference = this.buildCanonicalReference(); + } catch (e) { + const name: string = this.getScopedNameWithinPackage() || this.displayName; + throw new InternalError(`Error building canonical reference for ${name}:\n` + + e.message); + } } return this._canonicalReference; } From 238711f74b6f3b4c603a9f21ead9ec6982ab16b3 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 15:25:54 -0700 Subject: [PATCH 17/22] rush update --full --- common/config/rush/pnpm-lock.yaml | 313 +++++++++++++++--------------- 1 file changed, 160 insertions(+), 153 deletions(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index a31c38e6208..552591f5887 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -2,7 +2,7 @@ dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@pnpm/link-bins': 1.0.3 '@pnpm/logger': 1.0.2 '@rush-temp/api-documenter': 'file:projects/api-documenter.tgz' @@ -188,7 +188,7 @@ packages: /@babel/highlight/7.5.0: dependencies: chalk: 2.4.2 - esutils: 2.0.2 + esutils: 2.0.3 js-tokens: 4.0.0 dev: false resolution: @@ -331,10 +331,10 @@ packages: dev: false resolution: integrity: sha512-GFLPg9Z5yiNca3di/V6Zt3tAvj1de9EK0eL88tE+1eckQSH405UQcm7D+H8LbEhRpqpG+ZqN9LXCAEw4L5uchg== - /@microsoft/tsdoc/0.12.10: + /@microsoft/tsdoc/0.12.11: dev: false resolution: - integrity: sha512-tsog/HTdM88/WyR0Jz7XWTI0ghbJkt9soFXnQJrINDyaTGzbCoJjRttaW/IY5eAp4eqDyfg++jq6o+byEDOkIQ== + integrity: sha512-CXAEl/mTBkr+KcX/+Xi7wbNBnofZ1p2UwYbaJ+zwcVMCWQTMsheqkOwPM3BQ7J6uOacxwxO6rBRDjQqBdfe8dQ== /@microsoft/tsdoc/0.12.9: dev: false resolution: @@ -344,7 +344,7 @@ packages: '@pnpm/package-bins': 1.0.0 '@pnpm/types': 1.8.0 '@types/mz': 0.0.32 - '@types/node': 10.14.13 + '@types/node': 10.14.15 '@types/ramda': 0.25.51 '@zkochan/cmd-shim': 2.2.4 arr-flatten: 1.1.0 @@ -368,7 +368,7 @@ packages: '@pnpm/package-bins': 1.0.0 '@pnpm/types': 1.8.0 '@types/mz': 0.0.32 - '@types/node': 10.14.13 + '@types/node': 10.14.15 '@types/ramda': 0.25.51 '@zkochan/cmd-shim': 2.2.4 arr-flatten: 1.1.0 @@ -388,7 +388,7 @@ packages: integrity: sha512-thVgwrQ5rMcPYI6a0IPOt2pnlF1n5zX7BN4CrFeBp0/JCGsZAht/VOPv9bD3cZ+j0vDemEwE23BfhOWxmxq2yQ== /@pnpm/logger/1.0.2: dependencies: - '@types/node': 10.14.13 + '@types/node': 10.14.15 bole: 3.0.2 ndjson: 1.5.0 dev: false @@ -557,7 +557,7 @@ packages: integrity: sha512-lAVp+Kj54ui/vLUFxsJTMtWvZraZxum3w3Nwkble2dNuV5VnPA+Mi2oGX9XYJAaIvZi3tn3cbjS/qcJXRb6Bww== /@types/mz/0.0.32: dependencies: - '@types/node': 10.14.13 + '@types/node': 10.14.15 dev: false resolution: integrity: sha512-cy3yebKhrHuOcrJGkfwNHhpTXQLgmXSv1BX+4p32j+VUQ6aP2eJ5cL7OvGcAQx75fCTFaAIIAKewvqL+iwSd4g== @@ -583,10 +583,10 @@ packages: dev: false resolution: integrity: sha512-uNpVWhwVmbB5luE7b8vxcJwu5np75YkVTBJS0O3ar+hrxqLfyhOKXg9NYBwJ6mMQX/V6/8d6mMZTB7x2r5x9Bw== - /@types/node/10.14.13: + /@types/node/10.14.15: dev: false resolution: - integrity: sha512-yN/FNNW1UYsRR1wwAoyOwqvDuLDtVXnaJTZ898XIw/Q5cCaeVAlVwvsmXLX5PuiScBYwZsZU4JYSHB3TvfdwvQ== + integrity: sha512-CBR5avlLcu0YCILJiDIXeU2pTw7UK/NIxfC63m7d7CVamho1qDEzXKkOtEauQRPMy6MI8mLozth+JJkas7HY6g== /@types/node/8.5.8: dev: false resolution: @@ -842,13 +842,13 @@ packages: dev: false resolution: integrity: sha1-x1K9IQvvZ5UBtsbLf8hPj0cVjMQ= - /acorn-globals/4.3.2: + /acorn-globals/4.3.3: dependencies: acorn: 6.2.1 acorn-walk: 6.2.0 dev: false resolution: - integrity: sha512-BbzvZhVtZP+Bs1J1HcwrQe8ycfO0wStkSGxuul3He3GkHOIZ6eTqOkPuw9IP1X3+IkOo4wiJmwkobzXYz4wewQ== + integrity: sha512-vkR40VwS2SYO98AIeFvzWWh+xyc2qi9s7OoXSFEGIP/rOJKzjnhykaZJNnHdoq4BL2gGxI5EZOU16z896EYnOQ== /acorn-walk/6.2.0: dev: false engines: @@ -1243,10 +1243,10 @@ packages: dev: false resolution: integrity: sha1-NhIfhFwFeBct5Bmpfb6x0W7DRUI= - /async-limiter/1.0.0: + /async-limiter/1.0.1: dev: false resolution: - integrity: sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg== + integrity: sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ== /async-settle/1.0.0: dependencies: async-done: 1.3.2 @@ -1279,7 +1279,7 @@ packages: /autoprefixer/9.1.5: dependencies: browserslist: 4.6.6 - caniuse-lite: 1.0.30000985 + caniuse-lite: 1.0.30000989 normalize-range: 0.1.2 num2fraction: 1.2.2 postcss: 7.0.5 @@ -1301,7 +1301,7 @@ packages: /babel-code-frame/6.26.0: dependencies: chalk: 1.1.3 - esutils: 2.0.2 + esutils: 2.0.3 js-tokens: 3.0.2 dev: false resolution: @@ -1473,7 +1473,7 @@ packages: /babel-types/6.26.0: dependencies: babel-runtime: 6.26.0 - esutils: 2.0.2 + esutils: 2.0.3 lodash: 4.17.15 to-fast-properties: 1.0.3 dev: false @@ -1518,10 +1518,10 @@ packages: node: '>=0.10.0' resolution: integrity: sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg== - /base64-js/1.3.0: + /base64-js/1.3.1: dev: false resolution: - integrity: sha512-ccav/yGvoa80BQDljCxsmmQ3Xvx60/UpBIij5QN21W3wBi/hhIC9OoO+KLpu9IJTS9j4DRVJ3aDDF9cMSoa2lw== + integrity: sha512-mLQ4i2QO1ytvGWFWmcngKO//JXAQueZvwEKtjgQFM4jIK0kU+ytMfplL8j+n5mspOfjHwoAg+9yhb7BwAHm36g== /batch/0.6.1: dev: false resolution: @@ -1716,8 +1716,8 @@ packages: integrity: sha512-Z942RysHXmJrhqk88FmKBVq/v5tqmSkDz7p54G/MGyjMnCFFnC79XWNbg+Vta8W6Wb2qtSZTSxIGkJrRpCFEiA== /browserslist/4.6.6: dependencies: - caniuse-lite: 1.0.30000985 - electron-to-chromium: 1.3.200 + caniuse-lite: 1.0.30000989 + electron-to-chromium: 1.3.219 node-releases: 1.1.26 dev: false hasBin: true @@ -1745,7 +1745,7 @@ packages: integrity: sha1-JuYe0UIvtw3ULm42cp7VHYVf6Nk= /buffer/4.9.1: dependencies: - base64-js: 1.3.0 + base64-js: 1.3.1 ieee754: 1.1.13 isarray: 1.0.0 dev: false @@ -1834,10 +1834,10 @@ packages: node: '>=4' resolution: integrity: sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0= - /caniuse-lite/1.0.30000985: + /caniuse-lite/1.0.30000989: dev: false resolution: - integrity: sha512-1ngiwkgqAYPG0JSSUp3PUDGPKKY59EK7NrGGX+VOxaKCNzRbNc7uXMny+c3VJfZxtoK3wSImTvG9T9sXiTw2+w== + integrity: sha512-vrMcvSuMz16YY6GSVZ0dWDTJP8jqk3iFQ/Aq5iqblPwxSVVZI+zxDyTX0VPqtQsDnfdrBDcsmhgTEOh5R8Lbpw== /capture-exit/1.2.0: dependencies: rsvp: 3.6.2 @@ -2352,7 +2352,7 @@ packages: /d/1.0.1: dependencies: es5-ext: 0.10.50 - type: 1.0.1 + type: 1.0.3 dev: false resolution: integrity: sha512-m62ShEObQ39CfralilEQRjH6oAMtNCV1xJyEx5LpRYUVN+EviphDgUc/F3hnYbADmkiNs67Y+3ylmlG7Lnu+FA== @@ -2662,10 +2662,10 @@ packages: dev: false resolution: integrity: sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0= - /electron-to-chromium/1.3.200: + /electron-to-chromium/1.3.219: dev: false resolution: - integrity: sha512-PUurrpyDA74MuAjJRD+79ss5BqJlU3mdArRbuu4wO/dt6jc3Ic/6BDmFJxkdwbfq39cHf/XKm2vW98XSvut9Dg== + integrity: sha512-xANtM7YNFQGCMl+a0ZceXnPedpAatcIIyDNM56nQKzJFwuCyIzKVtBvLzyMOU0cczwO900TP309EkSeudrGRbQ== /elliptic/6.5.0: dependencies: bn.js: 4.11.8 @@ -2704,7 +2704,7 @@ packages: integrity: sha1-6TUyWLqpEIll78QcsO+K3i88+wc= /enhanced-resolve/3.4.1: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 memory-fs: 0.4.1 object-assign: 4.1.1 tapable: 0.2.9 @@ -2826,7 +2826,7 @@ packages: dependencies: esprima: 3.1.3 estraverse: 4.2.0 - esutils: 2.0.2 + esutils: 2.0.3 optionator: 0.8.2 dev: false engines: @@ -2840,7 +2840,7 @@ packages: dependencies: esprima: 1.2.5 estraverse: 1.9.3 - esutils: 2.0.2 + esutils: 2.0.3 optionator: 0.5.0 dev: false engines: @@ -2854,7 +2854,7 @@ packages: dependencies: esprima: 2.7.3 estraverse: 1.9.3 - esutils: 2.0.2 + esutils: 2.0.3 optionator: 0.8.2 dev: false engines: @@ -2930,12 +2930,12 @@ packages: node: '>=0.10.0' resolution: integrity: sha1-De4/7TH81GlhjOc0IJn8GvoL2xM= - /esutils/2.0.2: + /esutils/2.0.3: dev: false engines: node: '>=0.10.0' resolution: - integrity: sha1-Cr9PHKpbyx96nYrMbepPqqBLrJs= + integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== /etag/1.7.0: dev: false engines: @@ -3458,7 +3458,7 @@ packages: integrity: sha1-g8YK/Fi5xWmXAH7Rp2izqzA6RP4= /fs-extra/6.0.0: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jsonfile: 4.0.0 universalify: 0.1.2 dev: false @@ -3466,7 +3466,7 @@ packages: integrity: sha512-lk2cUCo8QzbiEWEbt7Cw3m27WMiRG321xsssbcIpfMhpRjrlC08WBOVQqj1/nQYYNnPtyIhP1oqLO3QwT2tPCw== /fs-extra/7.0.1: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jsonfile: 4.0.0 universalify: 0.1.2 dev: false @@ -3482,7 +3482,7 @@ packages: integrity: sha512-crhvyXcMejjv3Z5d2Fa9sf5xLYVCF5O1c71QxbVnbLsmYMBEvDAftewesN/HhY03YRoA7zOMxjNGrF5svGaaeQ== /fs-mkdirp-stream/1.0.0: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 through2: 2.0.5 dev: false engines: @@ -3507,7 +3507,7 @@ packages: integrity: sha512-oeyj2H3EjjonWcFjD5NvZNE9Rqe4UW+nQBU2HNeKw0koVLEFIhtyETyAakeAM3de7Z/SW5kcA+fZUait9EApnw== /fstream/1.0.12: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 inherits: 2.0.4 mkdirp: 0.5.1 rimraf: 2.6.3 @@ -3821,10 +3821,10 @@ packages: node: '>=0.4.0' resolution: integrity: sha1-dhPHeKGv6mLyXGMKCG1/Osu92Bg= - /graceful-fs/4.2.0: + /graceful-fs/4.2.1: dev: false resolution: - integrity: sha512-jpSvDPV4Cq/bgtpndIWbI5hmYxhQGHPC4d4cqBPb4DLniCfhJokdXhwhaDuLBGLQdvvRum/UiX6ECVIPvDXqdg== + integrity: sha512-b9usnbDGnD928gJB3LrCmxoibr3VE4U2SMo5PBuBnokWyDADTqDPXg4YpwKF1trpH+UbGp7QLicO3+aWEy0+mw== /growl/1.10.5: dev: false engines: @@ -4175,10 +4175,12 @@ packages: node: '>=0.10.0' resolution: integrity: sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA== - /hosted-git-info/2.7.1: + /hosted-git-info/2.8.2: + dependencies: + lru-cache: 5.1.1 dev: false resolution: - integrity: sha512-7T/BxH19zbcCTa8XkMlbK5lTo1WtgkFi3GvdWEyNuc4Vex7/9Dqbnpsf4JMydcfj9HCg4zUWFTL3Za6lapg5/w== + integrity: sha512-CyjlXII6LMsPMyUzxpTt8fzh5QwzGqPmQXgY/Jyf4Zfp27t/FvfhwoE/8laaMUcMy816CkWF20I7NeQhwwY88w== /html-encoding-sniffer/1.0.2: dependencies: whatwg-encoding: 1.0.5 @@ -4896,7 +4898,7 @@ packages: chalk: 2.4.2 exit: 0.1.2 glob: 7.1.4 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 import-local: 1.0.0 is-ci: 1.2.1 istanbul-api: 1.3.7 @@ -4918,7 +4920,7 @@ packages: jest-validate: 22.4.4 jest-worker: 22.4.3 micromatch: 2.3.11 - node-notifier: 5.4.0 + node-notifier: 5.4.1 realpath-native: 1.1.0 rimraf: 2.6.3 slash: 1.0.0 @@ -4938,7 +4940,7 @@ packages: chalk: 2.4.2 exit: 0.1.2 glob: 7.1.4 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 import-local: 1.0.0 is-ci: 1.2.1 istanbul-api: 1.3.7 @@ -4961,7 +4963,7 @@ packages: jest-watcher: 23.4.0 jest-worker: 23.2.0 micromatch: 2.3.11 - node-notifier: 5.4.0 + node-notifier: 5.4.1 prompts: 0.1.14 realpath-native: 1.1.0 rimraf: 2.6.3 @@ -5085,7 +5087,7 @@ packages: /jest-haste-map/22.4.3: dependencies: fb-watchman: 2.0.0 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jest-docblock: 22.4.3 jest-serializer: 22.4.3 jest-worker: 22.4.3 @@ -5097,7 +5099,7 @@ packages: /jest-haste-map/23.6.0: dependencies: fb-watchman: 2.0.0 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 invariant: 2.2.4 jest-docblock: 23.2.0 jest-serializer: 23.0.1 @@ -5112,14 +5114,14 @@ packages: chalk: 2.4.2 co: 4.6.0 expect: 22.4.3 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 is-generator-fn: 1.0.0 jest-diff: 22.4.3 jest-matcher-utils: 22.4.3 jest-message-util: 22.4.3 jest-snapshot: 22.4.3 jest-util: 22.4.3 - source-map-support: 0.5.12 + source-map-support: 0.5.13 dev: false resolution: integrity: sha512-nK3vdUl50MuH7vj/8at7EQVjPGWCi3d5+6aCi7Gxy/XMWdOdbH1qtO/LjKbqD8+8dUAEH+BVVh7HkjpCWC1CSw== @@ -5251,7 +5253,7 @@ packages: /jest-runner/23.6.0: dependencies: exit: 0.1.2 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jest-config: 23.6.0 jest-docblock: 23.2.0 jest-haste-map: 23.6.0 @@ -5261,7 +5263,7 @@ packages: jest-runtime: 23.6.0 jest-util: 23.4.0 jest-worker: 23.2.0 - source-map-support: 0.5.12 + source-map-support: 0.5.13 throat: 4.1.0 dev: false resolution: @@ -5274,7 +5276,7 @@ packages: chalk: 2.4.2 convert-source-map: 1.6.0 exit: 0.1.2 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jest-config: 22.4.4 jest-haste-map: 22.4.3 jest-regex-util: 22.4.3 @@ -5300,7 +5302,7 @@ packages: convert-source-map: 1.6.0 exit: 0.1.2 fast-json-stable-stringify: 2.0.0 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 jest-config: 23.6.0 jest-haste-map: 23.6.0 jest-message-util: 23.4.0 @@ -5357,7 +5359,7 @@ packages: dependencies: callsites: 2.0.0 chalk: 2.4.2 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 is-ci: 1.2.1 jest-message-util: 22.4.3 mkdirp: 0.5.1 @@ -5369,7 +5371,7 @@ packages: dependencies: callsites: 2.0.0 chalk: 2.4.2 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 is-ci: 1.2.1 jest-message-util: 23.4.0 mkdirp: 0.5.1 @@ -5459,7 +5461,7 @@ packages: dependencies: abab: 1.0.4 acorn: 5.7.3 - acorn-globals: 4.3.2 + acorn-globals: 4.3.3 array-equal: 1.0.0 cssom: 0.3.8 cssstyle: 0.3.1 @@ -5534,7 +5536,7 @@ packages: /jsonfile/4.0.0: dev: false optionalDependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 resolution: integrity: sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss= /jsonify/0.0.0: @@ -5695,7 +5697,7 @@ packages: integrity: sha512-XPQH8Z2GDP/Hwz2PCDrh2mth4yFejwA1OZ/81Ti3LgKyhDcEjsSsqFWZojHG0va/duGd+WyosY7eXLDoOyqcPw== /load-json-file/1.1.0: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 parse-json: 2.2.0 pify: 2.3.0 pinkie-promise: 2.0.1 @@ -5707,7 +5709,7 @@ packages: integrity: sha1-lWkFcI1YtLq0wiYbBPWfMcmTdMA= /load-json-file/2.0.0: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 parse-json: 2.2.0 pify: 2.3.0 strip-bom: 3.0.0 @@ -5943,6 +5945,12 @@ packages: dev: false resolution: integrity: sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g== + /lru-cache/5.1.1: + dependencies: + yallist: 3.0.3 + dev: false + resolution: + integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== /make-iterator/1.0.1: dependencies: kind-of: 6.0.2 @@ -6371,7 +6379,7 @@ packages: dependencies: fstream: 1.0.12 glob: 7.0.6 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 mkdirp: 0.5.1 nopt: 3.0.6 npmlog: 4.1.2 @@ -6410,7 +6418,7 @@ packages: readable-stream: 2.3.6 stream-browserify: 2.0.2 stream-http: 2.8.3 - string_decoder: 1.2.0 + string_decoder: 1.3.0 timers-browserify: 2.0.10 tty-browserify: 0.0.0 url: 0.11.0 @@ -6428,7 +6436,7 @@ packages: dev: false resolution: integrity: sha1-RDhEn+aeMh+UHO+UOYaweXAycBs= - /node-notifier/5.4.0: + /node-notifier/5.4.1: dependencies: growly: 1.3.0 is-wsl: 1.1.0 @@ -6437,7 +6445,7 @@ packages: which: 1.3.1 dev: false resolution: - integrity: sha512-SUDEb+o71XR5lXSTyivXd9J7fCloE3SyP4lSgt3lU2oSANiox+SxlNRGPjDKrwU1YN3ix2KN/VGGCg0t01rttQ== + integrity: sha512-p52B+onAEHKW1OF9MGO/S7k/ahGEHfhP5/tvwYzog/5XLYOd8ZuD6vdNZdUuWMONRnKPneXV43v3s6Snx1wsCQ== /node-releases/1.1.26: dependencies: semver: 5.3.0 @@ -6479,8 +6487,8 @@ packages: integrity: sha1-xkZdvwirzU2zWTF/eaxopkayj/k= /normalize-package-data/2.5.0: dependencies: - hosted-git-info: 2.7.1 - resolve: 1.11.1 + hosted-git-info: 2.8.2 + resolve: 1.12.0 semver: 5.3.0 validate-npm-package-license: 3.0.4 dev: false @@ -6516,7 +6524,7 @@ packages: integrity: sha512-KGvQ0cB70AQfg107Xvs/Fbu+dGmZoTRJp2TaPwcwQm3/7PteUyN2BCgk8KBMPGBUXZdVwyWS8fDCGFygBm19UQ== /npm-package-arg/5.1.2: dependencies: - hosted-git-info: 2.7.1 + hosted-git-info: 2.8.2 osenv: 0.1.5 semver: 5.3.0 validate-npm-package-name: 3.0.0 @@ -6975,7 +6983,7 @@ packages: integrity: sha1-32BBeABfUi8V60SQ5yR6G/qmf4w= /path-type/1.1.0: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 pify: 2.3.0 pinkie-promise: 2.0.1 dev: false @@ -7221,10 +7229,10 @@ packages: dev: false resolution: integrity: sha1-8FKijacOYYkX7wqKw0wa5aaChrM= - /psl/1.2.0: + /psl/1.3.0: dev: false resolution: - integrity: sha512-GEn74ZffufCmkDDLNcl3uuyF/aSD6exEyh1v/ZSdAomB82t6G9hzJVRx0jBmLDW+VfZqks3aScmMw9DszwUalA== + integrity: sha512-avHdspHO+9rQTLbv1RO+MPYeP/SzsCoxofjVnHanETfQhTJrmB0HlDoW+EiN/R+C0BZ+gERab9NY0lPN2TxNag== /public-encrypt/4.0.3: dependencies: bn.js: 4.11.8 @@ -7359,7 +7367,7 @@ packages: slash: 1.0.0 dev: false optionalDependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 resolution: integrity: sha512-/1dZ7TRZvGrYqE0UAfN6qQb5GYBsNcqS1C0tNK601CFOJmtHI7NIGXwetEPU/OtoFHZL3hDxm4rolFFVE9Bnmg== /read-package-tree/5.1.6: @@ -7452,14 +7460,14 @@ packages: dependencies: debuglog: 1.0.1 dezalgo: 1.0.3 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 once: 1.4.0 dev: false resolution: integrity: sha512-asaikDeqAQg7JifRsZn1NJZXo9E+VwlyCfbkZhwyISinqk5zNS6266HS5kah6P0SaQKGF6SkNnZVHUzHFYxYDw== /readdirp/2.2.1: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 micromatch: 3.1.10 readable-stream: 2.3.6 dev: false @@ -7709,12 +7717,12 @@ packages: dev: false resolution: integrity: sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs= - /resolve/1.11.1: + /resolve/1.12.0: dependencies: path-parse: 1.0.6 dev: false resolution: - integrity: sha512-vIpgF6wfuJOZI7KKKSP+HmiKggadPQAdsp5HiC1mvqnfp0gF1vdwgBWZIdrVft9pgqoMFQN+R7BSWZiBxx+BBw== + integrity: sha512-B/dOmuoAik5bKcD6s6nXDCjzUKnaDvdkRyAk6rsmsKLipWj4797iothd7jmmUhWTfinVMU+wc56rYKsit2Qy4w== /resolve/1.8.1: dependencies: path-parse: 1.0.6 @@ -8110,13 +8118,13 @@ packages: dev: false resolution: integrity: sha512-try0/JqxPLF9nOjvSta7tVondkP5dwgyLDjVoyMDlmjugT2lRZ1OfsrYTkCd2hkDnJTKRbO/Rl3orm8vlsUzbA== - /source-map-support/0.5.12: + /source-map-support/0.5.13: dependencies: buffer-from: 1.1.1 source-map: 0.6.1 dev: false resolution: - integrity: sha512-4h2Pbvyy15EE02G+JOZpUCmqWJuqrs+sEkzewTm++BPi7Hvn/HwcqLAcNxYAyI0x13CpPPn+kMjl+hplXMHITQ== + integrity: sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w== /source-map-url/0.4.0: dev: false resolution: @@ -8350,12 +8358,12 @@ packages: dev: false resolution: integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== - /string_decoder/1.2.0: + /string_decoder/1.3.0: dependencies: - safe-buffer: 5.1.2 + safe-buffer: 5.2.0 dev: false resolution: - integrity: sha512-6YqyX6ZWEYguAxgZzHGL7SsCeGx3V2TtOTqZz1xSTSWnqsbWwbptafNyvf/ACquZUXV3DANr5BDIwNYe1mN42w== + integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== /strip-ansi/3.0.1: dependencies: ansi-regex: 2.1.1 @@ -8692,7 +8700,7 @@ packages: integrity: sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw== /tough-cookie/2.4.3: dependencies: - psl: 1.2.0 + psl: 1.3.0 punycode: 1.4.1 dev: false engines: @@ -8701,7 +8709,7 @@ packages: integrity: sha512-Q5srk/4vDM54WJsJio3XNn6K2sCG+CQ8G5Wz6bZhRZoAe/+TxjWB/GlFAnYEbkYVlON9FMk/fE3h2RLpPXo4lQ== /tough-cookie/2.5.0: dependencies: - psl: 1.2.0 + psl: 1.3.0 punycode: 2.1.1 dev: false engines: @@ -8747,7 +8755,7 @@ packages: jest-config: 22.4.4 lodash: 4.17.15 pkg-dir: 2.0.0 - source-map-support: 0.5.12 + source-map-support: 0.5.13 typescript: 3.0.3 yargs: 11.1.0 dev: false @@ -8767,7 +8775,7 @@ packages: jest-config: 22.4.4 lodash: 4.17.15 pkg-dir: 2.0.0 - source-map-support: 0.5.12 + source-map-support: 0.5.13 typescript: 3.0.3 yargs: 11.1.0 dev: false @@ -8876,10 +8884,10 @@ packages: node: '>= 0.6' resolution: integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g== - /type/1.0.1: + /type/1.0.3: dev: false resolution: - integrity: sha512-MAM5dBMJCJNKs9E7JXo4CXRAansRfG0nlJxW7Wf6GZzSOvH31zClSaHdIMWLehe/EGMBkqeC55rrkaOr5Oo7Nw== + integrity: sha512-51IMtNfVcee8+9GJvj0spSuFcZHe9vSib6Xtgsny1Km9ugyz2mbS08I3rsUIRYgJohFRFU1160sgRodYz378Hg== /typedarray/0.0.6: dev: false resolution: @@ -8996,7 +9004,7 @@ packages: dependencies: source-map: 0.5.7 uglify-js: 2.8.29 - webpack-sources: 1.3.0 + webpack-sources: 1.4.3 dev: false engines: node: '>=4.3.0 <5.0.0 || >=5.10' @@ -9232,7 +9240,7 @@ packages: dependencies: fs-mkdirp-stream: 1.0.0 glob-stream: 6.1.0 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 is-valid-glob: 1.0.0 lazystream: 1.0.0 lead: 1.0.0 @@ -9256,7 +9264,7 @@ packages: dependencies: append-buffer: 1.0.2 convert-source-map: 1.6.0 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 normalize-path: 2.1.1 now-and-later: 2.0.1 remove-bom-buffer: 3.0.0 @@ -9327,7 +9335,7 @@ packages: /watchpack/1.6.0: dependencies: chokidar: 2.1.6 - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 neo-async: 2.6.1 dev: false resolution: @@ -9336,13 +9344,13 @@ packages: dev: false resolution: integrity: sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg== - /webpack-sources/1.3.0: + /webpack-sources/1.4.3: dependencies: source-list-map: 2.0.1 source-map: 0.6.1 dev: false resolution: - integrity: sha512-OiVgSrbGu7NEnEvQJJgdSFPl2qWKkWq5lHMhgiToIiN9w34EBnjYzSYs+VbL5KoYiLNtFFa7BZIKxRED3I32pA== + integrity: sha512-lgTS3Xhv1lCOKo7SA5TjKXMjpSM4sBjNV5+q2bqesbSPs5FjGmU6jjtBSkX9b4qW87vDIsCIlUPOEhbZrMdjeQ== /webpack/3.11.0: dependencies: acorn: 5.7.3 @@ -9365,7 +9373,7 @@ packages: tapable: 0.2.9 uglifyjs-webpack-plugin: 0.4.6 watchpack: 1.6.0 - webpack-sources: 1.3.0 + webpack-sources: 1.4.3 yargs: 8.0.2 dev: false engines: @@ -9480,7 +9488,7 @@ packages: integrity: sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= /write-file-atomic/2.4.3: dependencies: - graceful-fs: 4.2.0 + graceful-fs: 4.2.1 imurmurhash: 0.1.4 signal-exit: 3.0.2 dev: false @@ -9488,7 +9496,7 @@ packages: integrity: sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ== /ws/4.1.0: dependencies: - async-limiter: 1.0.0 + async-limiter: 1.0.1 safe-buffer: 5.1.2 dev: false resolution: @@ -9662,12 +9670,12 @@ packages: dev: false name: '@rush-temp/api-documenter-test' resolution: - integrity: sha512-3wJ5byaOXb/q3JKGmf2TGM2LXHGIhs3An+Zjt8rYsL0+SCGkoCssjKqTXJ8SN7T7q9OCHFC338PUF2vEcIfYhw== + integrity: sha512-TRfkWlgKTUDo/qj63VUPkyRny1xVEKFYc2PJRdPrP6545DTYZ4Rj0CM/U5r9aCv+Rn02pB3IoRawOwqheansIw== tarball: 'file:projects/api-documenter-test.tgz' version: 0.0.0 'file:projects/api-documenter.tgz': dependencies: - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/js-yaml': 3.12.1 '@types/node': 8.5.8 @@ -9678,7 +9686,7 @@ packages: dev: false name: '@rush-temp/api-documenter' resolution: - integrity: sha512-6ZbmYvBK4Bu9HWtt3iFz+YHXuolWj7v3KuY+eWLXv3rULfyn6HCCfaHn4UXQuyCFyJBvOUFr+0Uybi2+OFE2sg== + integrity: sha512-oovql2s0nv/l0rK6cwfUYtYl1c9tMVwOov58IXNO/eWkCGe0hW4ZxhSiSYI1aqjAE1LaRmfFxa4DtrdoS8sPQw== tarball: 'file:projects/api-documenter.tgz' version: 0.0.0 'file:projects/api-extractor-lib1-test.tgz': @@ -9690,7 +9698,7 @@ packages: dev: false name: '@rush-temp/api-extractor-lib1-test' resolution: - integrity: sha512-CMaABD2i0ArnNxX6mVLK5d0hg6W7hgm3hzgyqm5P8pEmbG8ZDddtXamA/Z6Fwwch8vmMPrHDCr+iHgkLoOpMDw== + integrity: sha512-7ZR4z5pfPBxSYkOJB5e9cjQDhJrmptKNGydAQ/rj1nklkprsFbJEBKGfMC6qZfAyHupLD8PJLRSuKOk44IYYWg== tarball: 'file:projects/api-extractor-lib1-test.tgz' version: 0.0.0 'file:projects/api-extractor-lib2-test.tgz': @@ -9702,7 +9710,7 @@ packages: dev: false name: '@rush-temp/api-extractor-lib2-test' resolution: - integrity: sha512-BQldO9sUaR2yUWvVTiTHzx7/JHx3jx09oG1yhX7nic31e7/KSSFBcgG+K08m3tWfv+BI+Md2ozlsNzWQhwsvTQ== + integrity: sha512-y34t6wNiOR3AwtuKI367oVNMp7WP7+hFRfycYRdTml+ex8sG19IHDrKtGaSFqP1ApQHBXPohsASxU3x7eiBGtw== tarball: 'file:projects/api-extractor-lib2-test.tgz' version: 0.0.0 'file:projects/api-extractor-lib3-test.tgz': @@ -9714,14 +9722,14 @@ packages: dev: false name: '@rush-temp/api-extractor-lib3-test' resolution: - integrity: sha512-N+MwHDsq+aEZwtJcF0yFoymdPp4zVRObBuxVCkeqkKGfQbvzMeMZLk6NZbiFSczNeo+NkbQcylD4rdgkEaSVmQ== + integrity: sha512-g7sCJaoyF9Z5MhDmEA0foSr71uVDUXhI7iEa/wOq7s3nGYo9b0meDPe63b+g2pzkBjAbRkXVPw4+EYqpdNalDw== tarball: 'file:projects/api-extractor-lib3-test.tgz' version: 0.0.0 'file:projects/api-extractor-model.tgz': dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/node': 8.5.8 gulp: 4.0.2 @@ -9729,7 +9737,7 @@ packages: dev: false name: '@rush-temp/api-extractor-model' resolution: - integrity: sha512-1w3u75gE6OtAy3p+gRSckt2kr/sjUF2uiZ3AhDPGb+pNqdMJGCNfwoOan17A0IOH6bSKK+N7EpUTrcxzM3/btw== + integrity: sha512-rb6jgpLT8jVuHTqlAh/ZzvHqFr66BNvXlp6dOGhJO3u5oH/pB3U7EMwL6QIFGwNHVilmxDo5UVa6V7zeFDM1zQ== tarball: 'file:projects/api-extractor-model.tgz' version: 0.0.0 'file:projects/api-extractor-scenarios.tgz': @@ -9743,7 +9751,7 @@ packages: dev: false name: '@rush-temp/api-extractor-scenarios' resolution: - integrity: sha512-e2Xf2KCMetbysQu1bI1s0WWO02soi1oeWyv6Z5v/MvZO1nPQRNcSKuWWrJUHj3vuzPp4/Q7OahfXQon8DSAzSw== + integrity: sha512-h7VR2Wh08WBF3h60m9JrDU66REEREKshJci9KD+txtpP0uto1g54TNiaj6+7kID/dwX0bSGCyI1z9lbzBSQUAQ== tarball: 'file:projects/api-extractor-scenarios.tgz' version: 0.0.0 'file:projects/api-extractor-test-01.tgz': @@ -9757,7 +9765,7 @@ packages: dev: false name: '@rush-temp/api-extractor-test-01' resolution: - integrity: sha512-yMmjBSZ3O95fSLZEYhfM1kHSfj/p4H1Xf0KUV43h1dTsCxgfy2LVa1qWZmIS5YlEtF8w/GHK2NEEBf+sLADaTQ== + integrity: sha512-P4EFPmcvJblXsejpHUgfSnqR9lnxB2y/Daor0Ac3vUTlq/nU8Xo9iQ2i8TkK1MmythU4oLpynd2eWgY3G9n8hg== tarball: 'file:projects/api-extractor-test-01.tgz' version: 0.0.0 'file:projects/api-extractor-test-02.tgz': @@ -9770,7 +9778,7 @@ packages: dev: false name: '@rush-temp/api-extractor-test-02' resolution: - integrity: sha512-9wtz18D979obJc678nFFYQzQMcBZBv8jHitQUmkYXefCjQQ4wgpPLwsGC9eadRP9T8d5/C7HoiKXBF+77TyEMw== + integrity: sha512-/PPQ73RSElSOhz+RVF9tP294wsgrXc4jZFhJJcCDXWW+pYdDeRORTU6B/1WHNS9VtpNeby+zHaABr2zwU8NLHA== tarball: 'file:projects/api-extractor-test-02.tgz' version: 0.0.0 'file:projects/api-extractor-test-03.tgz': @@ -9792,14 +9800,14 @@ packages: dev: false name: '@rush-temp/api-extractor-test-04' resolution: - integrity: sha512-rO/L8tTeFp9LNAb1cSpjzltkWqzLhYG1hC+uaVrMUuyyhjcRl5sUL92EkqEVLHQb5gy2RFmRBCG1ZzX3kcqIjw== + integrity: sha512-3DRMAXxnzPoU8LdYa3CMtftCLm/aZm404QdH3cmu+Xhn/11BNGZerT8GpCzFQqrB+d4N3ZGbu6EcF9zv8DSu0w== tarball: 'file:projects/api-extractor-test-04.tgz' version: 0.0.0 'file:projects/api-extractor.tgz': dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@types/jest': 23.3.11 '@types/lodash': 4.14.116 '@types/node': 8.5.8 @@ -9812,7 +9820,7 @@ packages: dev: false name: '@rush-temp/api-extractor' resolution: - integrity: sha512-DNTpByXHqWWl0yZgF0TU5/gCXzH485ZGrN6nvLSZhxFQuDAksppfJwGRixklGUkzw4yTLDL+KgKlO0QurGkRxA== + integrity: sha512-8Pft8iR1ln2FLIKXSgfyOuLgBRY6nY7RfQDzSK2n8Dm/fy2R3KBV56Q2JODKCTrgxtShISR7yrlfQ6a2R9CBJQ== tarball: 'file:projects/api-extractor.tgz' version: 0.0.0 'file:projects/eslint-config-scalable-ts.tgz': @@ -9839,7 +9847,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-mocha' resolution: - integrity: sha512-89gWdcudza1UYiqwgGS65UoWZJcKZRJrZTztWWfRqLnJTYCLaMq2uYrkBrKR5swMs3efXHI8uoNnwM00qe8RXQ== + integrity: sha512-dG8JvwcM4ohgWT11AAPlViYX/l1IH5o1rrVQiP+Surlw8eNPwiTqLSH+2A3pRZyDkLfQRTc/93QJtwG5cSoUdw== tarball: 'file:projects/gulp-core-build-mocha.tgz' version: 0.0.0 'file:projects/gulp-core-build-sass.tgz': @@ -9861,7 +9869,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-sass' resolution: - integrity: sha512-gkcb/FfZlJkpB5NUITUWot56zpGtrryECMXQz8SHPGrc8F4fD4IkInsMilAH1w2+ZYfTxJ35kEND3VqDDaNAEw== + integrity: sha512-4oHrhDS3+iI1lKn9/Q/0+Kaw3nrkJBqg4VtCWef2ovyq5CCH6Gr3QanFszTw/1h2FoHDDuh0mWSxKo0m2r5zaQ== tarball: 'file:projects/gulp-core-build-sass.tgz' version: 0.0.0 'file:projects/gulp-core-build-serve.tgz': @@ -9887,7 +9895,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-serve' resolution: - integrity: sha512-Z0ZJ2PfCWjhIIHaBLzLWcuuolqUzJlDloPtS3gNJwFDvZc+zpAT8DGbqKCrILbdfU4yS3EOcwDLgnZZvSSgeKQ== + integrity: sha512-D6oZSOGMH7TiaGPIQP/4klw1XkNXiksBJJCOOLgNMIxBZK0Qc1Nx4xY8Qw8xcR+O4V+/DJCgiPKzzf5+LAYuRQ== tarball: 'file:projects/gulp-core-build-serve.tgz' version: 0.0.0 'file:projects/gulp-core-build-typescript.tgz': @@ -9907,7 +9915,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-typescript' resolution: - integrity: sha512-0pyF5UEktFV6NHumZxDv+noBlFifrI4Vom3JBMn4ARkEpr8vMspqEvcwnuXw+52hoiA+2krHHHt33XaiXCOdbw== + integrity: sha512-GZtt61hB/5JkGUbeSawDwKQJlijGrjlXxVljYk5wzYrKkuabXTBFCaqoIwDUwYmguroUflII+05Wa4w2IwXfnA== tarball: 'file:projects/gulp-core-build-typescript.tgz' version: 0.0.0 'file:projects/gulp-core-build-webpack.tgz': @@ -9924,7 +9932,7 @@ packages: dev: false name: '@rush-temp/gulp-core-build-webpack' resolution: - integrity: sha512-mEQ7xsUySAICJpLwZZPQULvK/dMnn8NnAY++ciB0DcLTJBFOy9RBJmVLa1I8KooLxo591I1/7HV0aecM+csUIQ== + integrity: sha512-dOBgzXtdMlAXecaoxFsyZnnMxu9OjEKksaIfHWyyo0zAAZYT2FtEUlMbNzV8FbGeCxgQZUMl2WJEDb+tNzOE6A== tarball: 'file:projects/gulp-core-build-webpack.tgz' version: 0.0.0 'file:projects/gulp-core-build.tgz': @@ -9984,7 +9992,7 @@ packages: dev: false name: '@rush-temp/load-themed-styles' resolution: - integrity: sha512-+ckSlRxDbkoyfyAeukiZ5kzULdIQ9HJ/ssodoybqTllNl+WvG+SRhbIdje/up6SMgr8MEwP8i0tSEKo/GEHVdA== + integrity: sha512-bPZHdLpNPnrKF+b3AdwSFNWD/NcaklcrZXg7y1ylEb/6VRYWDn7oqEcMpy1T9hW1oXUYnV9ZlPn3+hQZgUNE6g== tarball: 'file:projects/load-themed-styles.tgz' version: 0.0.0 'file:projects/loader-load-themed-styles.tgz': @@ -9999,7 +10007,7 @@ packages: dev: false name: '@rush-temp/loader-load-themed-styles' resolution: - integrity: sha512-nAXvxfWQaO+txZU8Kvcp5zZpqhVLSYY1adclnl6f9iyqMtKtXYAzZYZddK7vl2KxbgLFuqtVdgym13QFadUMhA== + integrity: sha512-HpyOh7zkwcNGMe1uFj8Vz+AsBoguRVKd3w6EvQm+lxvamRVwU2XEmsYOTxatUaflwYvgAUrU2Ug49jnzKVoQnQ== tarball: 'file:projects/loader-load-themed-styles.tgz' version: 0.0.0 'file:projects/loader-raw-script.tgz': @@ -10013,7 +10021,7 @@ packages: dev: false name: '@rush-temp/loader-raw-script' resolution: - integrity: sha512-QofoEJ4o3lsjbeQ4CG17LNoqVVk8bmJnOkyR07YngkIgvUBROkU29pubdMxwG2CvcmJTlhIVblWrCqtrg8wuxg== + integrity: sha512-6Xk2c651A1vk/rhkpsFVAhFhx5RU18JU0KA4fH3LbT3IXIZagTWEudrBqAKCwPzTzt2phxF4uDJtosaKErJhJQ== tarball: 'file:projects/loader-raw-script.tgz' version: 0.0.0 'file:projects/loader-set-webpack-public-path.tgz': @@ -10029,7 +10037,7 @@ packages: dev: false name: '@rush-temp/loader-set-webpack-public-path' resolution: - integrity: sha512-QA2lYaG9QLBvYpR7/EB730y4H1DV0mhkfyENin6glEEbLykheMiA93ZcIiwpCh1RQvW0laRKHL35v6Rz1knWcg== + integrity: sha512-nTo0wpzipUMIfW5RuWGVYlSwxEXPwrxSfAafVzKCxyGr7asMFNTHuGmhCsJG9MGuxHLyUI7jT7JZ7AMPE20qEw== tarball: 'file:projects/loader-set-webpack-public-path.tgz' version: 0.0.0 'file:projects/node-core-library.tgz': @@ -10062,7 +10070,7 @@ packages: dev: false name: '@rush-temp/node-library-build-test' resolution: - integrity: sha512-AgQD9nFCjtd+6iROHTKmMS0eIXjLq86nbnjN2Re6bHi2A2ZQ6LlKi+/Vy4bGhQRryZoOzQx34jB4ibTrr7bBAg== + integrity: sha512-zpb+cEBr1l4VI9qWx4cU8VMxcrldyu4qOUHMkTgxwNgri/uupjEwVB7lxro7+eLIUnI4HKsy91YfWb0/UjzTPg== tarball: 'file:projects/node-library-build-test.tgz' version: 0.0.0 'file:projects/node-library-build.tgz': @@ -10073,7 +10081,7 @@ packages: dev: false name: '@rush-temp/node-library-build' resolution: - integrity: sha512-PSB9Z0e6R/hD0G3mVKcIEeNknlVRqa2y4EvCoaFSYhKdTrYHCOxMBKU1d3EuasbUB0IH2fC3HVc0QlmoHYy11A== + integrity: sha512-OFwQs0Vi+2+5djK+c7YkF15elnObfUOYrWfj0BgCBgsUT6QBeg9qvsIGxILQyu7ifQ/NQg2vRtDKNFFFPv2PPQ== tarball: 'file:projects/node-library-build.tgz' version: 0.0.0 'file:projects/package-deps-hash.tgz': @@ -10086,7 +10094,7 @@ packages: dev: false name: '@rush-temp/package-deps-hash' resolution: - integrity: sha512-kMkENqzEi7U4fReV7xulU80NEQ4KrbbKztBSN9ESbIisBlADOxYuZP5eFD87hsutByijTGQT1AqhFiUrmYT0tA== + integrity: sha512-iowcUhSTXZqaabf4tn73HLCWex6QwBg4fUPGG+EHNwm/oeJ5VTX58vzQR2itIHA1xBGNw/s/Ck1QemxO0s0wQA== tarball: 'file:projects/package-deps-hash.tgz' version: 0.0.0 'file:projects/resolve-chunk-plugin.tgz': @@ -10099,7 +10107,7 @@ packages: dev: false name: '@rush-temp/resolve-chunk-plugin' resolution: - integrity: sha512-TVV8J48O8MDAMOT7R5bgPVlauDQuFixQY0znkmJT5KRV8XvAN5dPH9RGBv3oYY1+02GTPvAaY+3mm5SptqcflA== + integrity: sha512-CC0eVCWwkISGAb1uxn5pn5X48qgjQRpfIzs+jRYYy7hUNiDpsfKLtJX56qA6aWtvfPiKKHpPOLco/Gvl+6l1Rg== tarball: 'file:projects/resolve-chunk-plugin.tgz' version: 0.0.0 'file:projects/rush-buildxl.tgz': @@ -10110,7 +10118,7 @@ packages: dev: false name: '@rush-temp/rush-buildxl' resolution: - integrity: sha512-up7exMV6T+cBGc9/E2FBdYmIxVeDWsW+RZwDh72LBepQ27lMqLVVwzBislNBp/o9Q0qe/tNZyDzhOxrVqUs8sg== + integrity: sha512-xqJUvAXoFxwa0VPeELgGbZrMpQr6icztZabvk8pMGZX8AmQ2pS2odTGee+EguYm9q/MIKrB/jNzxQ7DRosYtUg== tarball: 'file:projects/rush-buildxl.tgz' version: 0.0.0 'file:projects/rush-lib.tgz': @@ -10153,7 +10161,7 @@ packages: dev: false name: '@rush-temp/rush-lib' resolution: - integrity: sha512-8N7cT8aQz+GFFinCjEYC/eGiYy3G+B6Zvz8aOQEgOWunX43wIaqwcwHeWWtmwNCh/jfTuduIO8sM2eCTmTKFYg== + integrity: sha512-HGC4ukpyFk67Fgl3PyPkLt9LV4O1Kl7M4UMNYA6G5bNW/itHWx4IrCwJVyO/DrQJtWjiWzuMKLTkd2xaPiOKww== tarball: 'file:projects/rush-lib.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.4-library-test.tgz': @@ -10163,7 +10171,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.4-library-test' resolution: - integrity: sha512-jHBI/hoMAHJTrBbflE5RdN7HtbCgfeKguFBhEAsERCkbK4q59dDf1rc9mYOUV1bbXeTMbn+5eZaL6isukQgr1Q== + integrity: sha512-M/2suIUCMCrf6O/YFh8okjkEj71Tjf46riTglTA/cBUzlKv4FEEASjcnlDC9pW4pmWxUM6whFN2qC+DLPz5kng== tarball: 'file:projects/rush-stack-compiler-2.4-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.4.tgz': @@ -10178,7 +10186,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.4' resolution: - integrity: sha512-3lQ7CLV3Lkr5w3TzyH5j/tTdSaqiJcelpkPw4EAWPLwCs5lUghTt4MYj9tOdsdc+ix/eFqtp2afQQxihuJ17Zg== + integrity: sha512-AF9RLBgAQdkBrPUx2Km30YPQqqu7ngxuCXvwsMOxZ98axJGR68Jeidko1IwMmXG84AKq45HOBQmMLQ0qDMDkdw== tarball: 'file:projects/rush-stack-compiler-2.4.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.7-library-test.tgz': @@ -10188,7 +10196,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.7-library-test' resolution: - integrity: sha512-0EzdOcsSRCytg4wa8RsV5+80etUpL07cttBFxG24k+Up6tC/DEfWEkXwc81R362wLrcxMfK2bdBs4B3O22pnhA== + integrity: sha512-xL3HeSfzmVUGHEbbQOPxzfI3Ty/N9MptSdJLm7AxbLOBI36iIKaNmqzMJT/dDwbvnlv7p/45vdeYo1XRTPr2XA== tarball: 'file:projects/rush-stack-compiler-2.7-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.7.tgz': @@ -10203,7 +10211,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.7' resolution: - integrity: sha512-dsNPJbHmOebMLfU5ZZmjoDj46fMrdrnmKyYh/pCgP0amFk8XzfJonJqYIdBSwoo++FPF1pnnqG3vrBJCvWL+5w== + integrity: sha512-Oppv/fBdiVeVfKqHyjZdByeylSR2qBtUJoOVVMTFrcDEhCx6c7eX4M4/3m0F43JnzpewyTb8Sz/uQmlB88rKsQ== tarball: 'file:projects/rush-stack-compiler-2.7.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.8-library-test.tgz': @@ -10213,7 +10221,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.8-library-test' resolution: - integrity: sha512-t0VC/3q1S1XSag5Ity+wAvYiGz4pWSHo30pEd89ci7S9Q0oIuURf97O1NYFV5P4Za8t2he52Boi8byJEBnOdeg== + integrity: sha512-rRSmEQ3kpq0JpNBTJPuVmC0OatHeJgIOtshLlGdE4tOHRUUghpKXmKICGUhRfcIrDqQA0gNwiafO7ulA/Sl5zw== tarball: 'file:projects/rush-stack-compiler-2.8-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.8.tgz': @@ -10228,7 +10236,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.8' resolution: - integrity: sha512-eKGwa5RQ3Lq6ctB1LE116pdVja6X777cCskjgQmjU2IfAQz6C9dIcya8kinVbnBkfhXdAAHwzkULDGnvgJBDvw== + integrity: sha512-ugQDx4kYn1PpnflXwI5Yhtj6J+tEwJjuYdgSLH6yq3G+ofsvdN+I9p3wEAZ4Uqgwi3Og7Ha4RDcuTcL5hgmUhg== tarball: 'file:projects/rush-stack-compiler-2.8.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.9-library-test.tgz': @@ -10238,7 +10246,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.9-library-test' resolution: - integrity: sha512-58DY1Phoe0Guh5jlVtfL3EzUwqmazxLbiPwsthfgQLaK5cQx/pc74okUS9K596GS3U6owCWGOagiT8jZsvPpKA== + integrity: sha512-PXU890aTvq99QYf+zg88r3d8mUA0ldyBjbWyWQ7+ANHT0s4FcCqw+2K6k4VzuwsJaEEJI8hvomCS7xDfJH/1/w== tarball: 'file:projects/rush-stack-compiler-2.9-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-2.9.tgz': @@ -10253,7 +10261,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-2.9' resolution: - integrity: sha512-jo1BJTVVcVoxTKWvogTvjRHqIVeLXFIxNV+DiyCybppxrSrRVLeAbkXa6NJ2U9T+mnvkoAvsBqw9MfaQlZ8+aw== + integrity: sha512-CWuyNhz8RP4iMKG4rs3ZdV81RBNUuy+UVLpVku7qHlevyuUro2tdYDL9UpqiHDOjpGE64xm5NYh07J8314GFNg== tarball: 'file:projects/rush-stack-compiler-2.9.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.0-library-test.tgz': @@ -10263,7 +10271,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.0-library-test' resolution: - integrity: sha512-Axyn3z615o3jzXQxNf8j4PWlhLhtYaDVRWpb732VHFSmb3Q7kVfeP+NBwJfkbQTBTD0OmbTe+r7UrLFl2DYFqg== + integrity: sha512-FGAdilCMJ/ZKXmZaKvkq3iV8X9ckhhe2SMITaYdgBAAkTatc5YUG4CPGkTesW279yxGZ1pFyIyBtFNtz++Kgag== tarball: 'file:projects/rush-stack-compiler-3.0-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.0.tgz': @@ -10278,7 +10286,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.0' resolution: - integrity: sha512-h+0QpViR6JOI9dVV22KK7zzC8C8vqROEZv/1V0geZ8ItRbrylvmi4p1KeB107LUUaDqQqxS9cBYQ4smlB/dTEQ== + integrity: sha512-u6Q5gfHak5OimdwYIivYlsxkl0+gyxkNS4Ma3SYWN3aHhRAaE6I3lsrtD/aQgi+9E6vgxHKPtS7rdbz1xKHEiQ== tarball: 'file:projects/rush-stack-compiler-3.0.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.1-library-test.tgz': @@ -10288,7 +10296,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.1-library-test' resolution: - integrity: sha512-fHm6VkNO3KsRMQojt2gXPc8hjfEbrb437/gu9Yr+qasRpXZR/3hk4bjRWsOqqKoBpglbRmUTUNpzjt7Vv2isrQ== + integrity: sha512-QKgnxA2+kwPCJEgK0nw1C1wl6zM1nRnirka+NirzmilW0PJXDiMihdvDWq59RacrmpfdSt0KyXPhjZhehQTuvQ== tarball: 'file:projects/rush-stack-compiler-3.1-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.1.tgz': @@ -10303,7 +10311,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.1' resolution: - integrity: sha512-Sbwss7q36mDgU2kjK69QFMq+SFBexUBjvgQdAQ2QIW23gb+smNOOtFuGqtnBRTncz3QToGOSQa9ihp3X3Ce80w== + integrity: sha512-zajgFD92xOhrNQpNFTArvjCbLTU9a1o2A2yE0N0keVVraLd4r9TDXyvOfvP/s05/nsaj4e3BXx+RtQOfS8Ox0g== tarball: 'file:projects/rush-stack-compiler-3.1.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.2-library-test.tgz': @@ -10313,7 +10321,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.2-library-test' resolution: - integrity: sha512-+eLxnaVxyUkzqE8XmGb9e4t7DghmYqNQoKbfjaXaafzF5l3wsscBGY90W9ZsNEvOXrv7cl90eDJ9gE3ww58aQA== + integrity: sha512-jziaH4IfKQwoyj4TjcmT8/EhK54wh6aIx90e8oSNv2H4rN691oDOzQh/jFjgNA32HSP93cS5BXs4Lx8NPBhSvg== tarball: 'file:projects/rush-stack-compiler-3.2-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.2.tgz': @@ -10328,7 +10336,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.2' resolution: - integrity: sha512-hUpMGyXd0KvLHInmHhCXBeLTz2kNnEDgqaN7i+4zKV+5ZPSo+EJdkJOGSZ+tleaOwwDob/C05elQJt9Aknm4Bw== + integrity: sha512-T7z6GSRcKPLkG0QaunktOO8A0ASuyhjQheKxGvyhbLyTIzm6JoGXUsGb2mEJ4IaHXNxjBhjDECZLltKxtFMQIw== tarball: 'file:projects/rush-stack-compiler-3.2.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.3-library-test.tgz': @@ -10338,7 +10346,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.3-library-test' resolution: - integrity: sha512-HN48JRzWOVBlxeH6ZegCgUjadvusCNWSggOjgI5bF/uhJFYWafK3nJCb3yZsXaTABPfiqLqT5wU652LmOGCJ0w== + integrity: sha512-3zwJ1lv+/sk7bjYKi16RJOnbZ/YmKBZvxEI+aeQ34nB7/BIm4nfjnplHMxw23Va1pIYQC3D+5RHxDDWAEDFqhQ== tarball: 'file:projects/rush-stack-compiler-3.3-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.3.tgz': @@ -10353,7 +10361,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.3' resolution: - integrity: sha512-emFR85GTqJZWwkPINm1yegFTNWqW78S2PAl+oz6/7uzEfLjRu8nUBb9wkM/FBWTKGvInVvhoq3ENycnRulVIdg== + integrity: sha512-wqTqUx8KLqWDFB/aC0pi+QEAL+bxKljUMvodPq/jA+/EaFzIlN681xozj3mwdnZYUqRse4N86iFqouiQD2rzoQ== tarball: 'file:projects/rush-stack-compiler-3.3.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.4-library-test.tgz': @@ -10363,7 +10371,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.4-library-test' resolution: - integrity: sha512-hxawtUM+Z0a11EXQyMukJghKouAZdgos9eTp63KaRv1JQ4NZvmy6YMhNP4pqbrrMDC7IqLM4H/SuU/zj64IzsA== + integrity: sha512-1kOwvvTKp3wkfOHKI8Mh7EF0WByPC0M2D7zF5H14LA/ODxpmrcoHc+atgZczqCj0677ehN+lEuHLqejt4nVmyw== tarball: 'file:projects/rush-stack-compiler-3.4-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.4.tgz': @@ -10378,7 +10386,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.4' resolution: - integrity: sha512-x0XqQ73TTdB2FE8WexSl6DRoYvtSKj+MKHYranNXmEiQ6BZ41LEfnr4CfSP8/FcQMET97dmQlgoM/GmlQT23iw== + integrity: sha512-MAso3+HlxKtMuwAorUNJpjUs1DuwHw4dYL/UBEwfqAhq5OIwXWD0GJKlCGhsMGREsBrNTYYFOKYN4T2vAEPCyQ== tarball: 'file:projects/rush-stack-compiler-3.4.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.5-library-test.tgz': @@ -10388,7 +10396,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.5-library-test' resolution: - integrity: sha512-sxc/wnVaAG84RZYt9xCnNgEBCGnORciaWFjkKscqS5ZNXBmussITzaYWNDnluqT21HLrN3Y31iLIYx8u1Ol7+w== + integrity: sha512-ZFSjz40kBMMfxH4hFRz6IR+IhX6upL8WmIFbdBRmrpn87M9aQjiZO1FwheR6Yk2HMQD87On1e/iRh3J+5vyX3Q== tarball: 'file:projects/rush-stack-compiler-3.5-library-test.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-3.5.tgz': @@ -10402,7 +10410,7 @@ packages: dev: false name: '@rush-temp/rush-stack-compiler-3.5' resolution: - integrity: sha512-EGhmzrLdl8cndy9C3rBsjDRCLbHwyWnqRs3s8SelSYQEngM2TLp7uRb5JQUTnKQHTHo6Ru5Cbni8fGhQQlCIaQ== + integrity: sha512-7SjQQF8HTZ6JuWJvTDEsfV/+o3FhzLng1cAVASyF/PQkpx7TrlYbh604ygk6Ta3O455BgJeihT9HxYWBIlOWig== tarball: 'file:projects/rush-stack-compiler-3.5.tgz' version: 0.0.0 'file:projects/rush-stack-compiler-shared.tgz': @@ -10416,7 +10424,7 @@ packages: dev: false name: '@rush-temp/rush-stack-library-test' resolution: - integrity: sha512-60WDnR9kaN2Lr775Nx14M2mi+t5CBwjETUV1TlY1YkseaKeG/F9MQhq3ZJQis/dQ3M2vAToPeAImDMYSuWVGeA== + integrity: sha512-jPkbFVouF+o4TC2YSrYM65ZJGtkfLQVjV2s1GpP/T+JZfwXD16SXZi5GXAIeyNETQUmzZEqFNJibR82La599Tg== tarball: 'file:projects/rush-stack-library-test.tgz' version: 0.0.0 'file:projects/rush-stack.tgz': @@ -10427,7 +10435,7 @@ packages: dev: false name: '@rush-temp/rush-stack' resolution: - integrity: sha512-iqDBGCn+Z259/816/gXSYkf+4GsgRxTWdVINlOHdjvpuj1zT8MX55wd6uxbFhiuHkyvPs/+2flqoug6gI5ZLMA== + integrity: sha512-G3RNfOi2gTHflyUI+PXr5A60Xkis+h/NOvQ5YATAurK1jnzQIplkghxDBdFaiNS/sTEWzqpb0hMH7FMkgMIImw== tarball: 'file:projects/rush-stack.tgz' version: 0.0.0 'file:projects/rush.tgz': @@ -10445,7 +10453,7 @@ packages: dev: false name: '@rush-temp/rush' resolution: - integrity: sha512-4UIns4+wu0WCVqsrtOIqTSW6oBlcA41uB3VI0DbvHhPu5cq6ITMZNnCQrJknbCCGs7Wa+coQb8rbdsqgYTsgrQ== + integrity: sha512-HlJcB33fMf6UstsUFmphGyPHC2gCTRoP1j81UDlT/ZsP6Jr8Z5GKVHAmFjjynC03wbXpf91TcEoBK1sxO/uJFg== tarball: 'file:projects/rush.tgz' version: 0.0.0 'file:projects/rushell.tgz': @@ -10458,7 +10466,7 @@ packages: dev: false name: '@rush-temp/rushell' resolution: - integrity: sha512-Z75lByzCBM3rDnVZafP7SA3P4bM3wlcxGLF9rRb2zJ/9iR1FMv0T1xaDTAilrMBYRs51H/q1RutEnjkZ+fh1Mw== + integrity: sha512-w16GCBq1xLKjf834Th7yBzHIGSEMdbObJg1NdTU7HI3HbD0dRsiRD+wGBc3GyGwsxdbByzp+sigzJFlYFSWIuA== tarball: 'file:projects/rushell.tgz' version: 0.0.0 'file:projects/set-webpack-public-path-plugin.tgz': @@ -10477,7 +10485,7 @@ packages: dev: false name: '@rush-temp/set-webpack-public-path-plugin' resolution: - integrity: sha512-Y9cHvupWvAXPLvbCqc+Gx3/s2ZveCfnjGqTk82QbxTCV/YQze6aQPDNESi1z51D2Z9AxL/qY/CZNLT9svB6XRg== + integrity: sha512-TRtPgbnbyXPpSuJXsebo9ODplQQ5jkI/voSCvCL+9ZBjFDEijWNf7x7MKiNLGEHcoryvLY3LrIdBG+CB2tPL1A== tarball: 'file:projects/set-webpack-public-path-plugin.tgz' version: 0.0.0 'file:projects/stream-collator.tgz': @@ -10492,7 +10500,7 @@ packages: dev: false name: '@rush-temp/stream-collator' resolution: - integrity: sha512-6Nuyd1jWX28Ff/Jp8DP6+nhKkJAJaK+vVzV++nvVNFsGhGh8etDM5YPlFXMpSDzbDNt8pIArXFxeSClE1KqJxQ== + integrity: sha512-UuXYBFkO+5TNfcczgteCpV3Z4CjedYrd4bchrzZgexMlSosdRD45iwSXtvS64vSo7uVcBrIWORqazETcRf8XiA== tarball: 'file:projects/stream-collator.tgz' version: 0.0.0 'file:projects/ts-command-line.tgz': @@ -10519,7 +10527,7 @@ packages: dev: false name: '@rush-temp/web-library-build-test' resolution: - integrity: sha512-dvGpQpnBVPjntqfItXV87VNhdNwPm8sokoVM0Ki1xawaBH+zD20HonUP2qjXFcWN5Hek+f/HJ8dcAxKHVrfowg== + integrity: sha512-UVJaePoujV03BNTtlziVdtSOFoxA1MsYWqsnze3upIm9h9gCkdHZWaX2HUQt7k7MNdj1Pw8U3yDHhnA4q5CszQ== tarball: 'file:projects/web-library-build-test.tgz' version: 0.0.0 'file:projects/web-library-build.tgz': @@ -10531,15 +10539,14 @@ packages: dev: false name: '@rush-temp/web-library-build' resolution: - integrity: sha512-3T1D8T+obRzYE6eWTRaALuoSJvd9DBj44S/Q3vwWuA7dxgQd6/vFOfpY+OIuV/ci3AE1953yEvcVuI6Ya9mCdQ== + integrity: sha512-yZFvtkoDz1jKq8yTfpQvsksMS2Yp5GrN8vycxNzCgLlf+hEj81Buj/LatY2NgUyqFZZibPL16hVgvhXmO8kuNw== tarball: 'file:projects/web-library-build.tgz' version: 0.0.0 -registry: '' specifiers: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.10 + '@microsoft/tsdoc': 0.12.11 '@pnpm/link-bins': ~1.0.1 '@pnpm/logger': ~1.0.1 '@rush-temp/api-documenter': 'file:./projects/api-documenter.tgz' From 132c8743b3466ea52ee632a70b22a3f42a3fe844 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 16:15:08 -0700 Subject: [PATCH 18/22] Upgrade TSDoc --- apps/api-documenter/package.json | 2 +- apps/api-extractor-model/package.json | 2 +- apps/api-extractor/package.json | 2 +- common/config/rush/pnpm-lock.yaml | 20 ++++++++++---------- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json index 5d42da8b213..0c24f44f8dc 100644 --- a/apps/api-documenter/package.json +++ b/apps/api-documenter/package.json @@ -18,7 +18,7 @@ "@microsoft/api-extractor-model": "7.3.0", "@microsoft/node-core-library": "3.13.0", "@microsoft/ts-command-line": "4.2.6", - "@microsoft/tsdoc": "0.12.11", + "@microsoft/tsdoc": "0.12.12", "colors": "~1.2.1", "js-yaml": "~3.13.1" }, diff --git a/apps/api-extractor-model/package.json b/apps/api-extractor-model/package.json index f3d560a7f6d..761ee5b0918 100644 --- a/apps/api-extractor-model/package.json +++ b/apps/api-extractor-model/package.json @@ -18,7 +18,7 @@ }, "dependencies": { "@microsoft/node-core-library": "3.13.0", - "@microsoft/tsdoc": "0.12.11", + "@microsoft/tsdoc": "0.12.12", "@types/node": "8.5.8" }, "devDependencies": { diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json index 1f6ec9222cb..5498505ba38 100644 --- a/apps/api-extractor/package.json +++ b/apps/api-extractor/package.json @@ -38,7 +38,7 @@ "@microsoft/api-extractor-model": "7.3.0", "@microsoft/node-core-library": "3.13.0", "@microsoft/ts-command-line": "4.2.6", - "@microsoft/tsdoc": "0.12.11", + "@microsoft/tsdoc": "0.12.12", "colors": "~1.2.1", "lodash": "~4.17.15", "resolve": "1.8.1", diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 552591f5887..aed65f4a3bd 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -2,7 +2,7 @@ dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.11 + '@microsoft/tsdoc': 0.12.12 '@pnpm/link-bins': 1.0.3 '@pnpm/logger': 1.0.2 '@rush-temp/api-documenter': 'file:projects/api-documenter.tgz' @@ -331,10 +331,10 @@ packages: dev: false resolution: integrity: sha512-GFLPg9Z5yiNca3di/V6Zt3tAvj1de9EK0eL88tE+1eckQSH405UQcm7D+H8LbEhRpqpG+ZqN9LXCAEw4L5uchg== - /@microsoft/tsdoc/0.12.11: + /@microsoft/tsdoc/0.12.12: dev: false resolution: - integrity: sha512-CXAEl/mTBkr+KcX/+Xi7wbNBnofZ1p2UwYbaJ+zwcVMCWQTMsheqkOwPM3BQ7J6uOacxwxO6rBRDjQqBdfe8dQ== + integrity: sha512-5EzH1gHIonvvgA/xWRmVAJmRkTQj/yayUXyr66hFwNZiFE4j7lP8is9YQeXhwxGZEjO1PVMblAmFF0CyjNtPGw== /@microsoft/tsdoc/0.12.9: dev: false resolution: @@ -9675,7 +9675,7 @@ packages: version: 0.0.0 'file:projects/api-documenter.tgz': dependencies: - '@microsoft/tsdoc': 0.12.11 + '@microsoft/tsdoc': 0.12.12 '@types/jest': 23.3.11 '@types/js-yaml': 3.12.1 '@types/node': 8.5.8 @@ -9686,7 +9686,7 @@ packages: dev: false name: '@rush-temp/api-documenter' resolution: - integrity: sha512-oovql2s0nv/l0rK6cwfUYtYl1c9tMVwOov58IXNO/eWkCGe0hW4ZxhSiSYI1aqjAE1LaRmfFxa4DtrdoS8sPQw== + integrity: sha512-bOFKX8xJtoRE8VeZ/I3LtznwZFbDeTL1nMtWLzL3RbuNwgqTBJEyjdrqS7okik5h35hKMY4EJQCaekBlR8WzjA== tarball: 'file:projects/api-documenter.tgz' version: 0.0.0 'file:projects/api-extractor-lib1-test.tgz': @@ -9729,7 +9729,7 @@ packages: dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.11 + '@microsoft/tsdoc': 0.12.12 '@types/jest': 23.3.11 '@types/node': 8.5.8 gulp: 4.0.2 @@ -9737,7 +9737,7 @@ packages: dev: false name: '@rush-temp/api-extractor-model' resolution: - integrity: sha512-rb6jgpLT8jVuHTqlAh/ZzvHqFr66BNvXlp6dOGhJO3u5oH/pB3U7EMwL6QIFGwNHVilmxDo5UVa6V7zeFDM1zQ== + integrity: sha512-wwScZSrQ71x9rv0NLXQgWv0jj6poRm1bxA2JUMFvutufdkxNdHe65biMBPHKzD9ZZHCuP4pyBTZ47P2h6npYgg== tarball: 'file:projects/api-extractor-model.tgz' version: 0.0.0 'file:projects/api-extractor-scenarios.tgz': @@ -9807,7 +9807,7 @@ packages: dependencies: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 - '@microsoft/tsdoc': 0.12.11 + '@microsoft/tsdoc': 0.12.12 '@types/jest': 23.3.11 '@types/lodash': 4.14.116 '@types/node': 8.5.8 @@ -9820,7 +9820,7 @@ packages: dev: false name: '@rush-temp/api-extractor' resolution: - integrity: sha512-8Pft8iR1ln2FLIKXSgfyOuLgBRY6nY7RfQDzSK2n8Dm/fy2R3KBV56Q2JODKCTrgxtShISR7yrlfQ6a2R9CBJQ== + integrity: sha512-01GBJs0JEbT9XYou74sVsT+S3xE4SoNwUOoRkejE9QsEkdoliDW9JeBKFzY2f/YtGBCnqgJp4U+OC+si/a6vGA== tarball: 'file:projects/api-extractor.tgz' version: 0.0.0 'file:projects/eslint-config-scalable-ts.tgz': @@ -10546,7 +10546,7 @@ specifiers: '@microsoft/node-library-build': 6.0.71 '@microsoft/rush-stack-compiler-3.4': 0.1.11 '@microsoft/teams-js': 1.3.0-beta.4 - '@microsoft/tsdoc': 0.12.11 + '@microsoft/tsdoc': 0.12.12 '@pnpm/link-bins': ~1.0.1 '@pnpm/logger': ~1.0.1 '@rush-temp/api-documenter': 'file:./projects/api-documenter.tgz' From 519e330e18625d19ad469c1e98752f3e3c36c819 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 16:18:04 -0700 Subject: [PATCH 19/22] Bump ApiJsonSchemaVersion since we published V_1002 before this PR was merged --- .../src/model/DeserializerContext.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/apps/api-extractor-model/src/model/DeserializerContext.ts b/apps/api-extractor-model/src/model/DeserializerContext.ts index d34057c6404..d10fafa55ca 100644 --- a/apps/api-extractor-model/src/model/DeserializerContext.ts +++ b/apps/api-extractor-model/src/model/DeserializerContext.ts @@ -13,12 +13,17 @@ export enum ApiJsonSchemaVersion { V_1001 = 1001, /** - * Change the "canonicalReference" field to use the experimental new TSDoc declaration reference notation. + * 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. * * This is not a breaking change because this field is never deserialized; it is provided for informational * purposes only. */ - V_1002 = 1002, + V_1003 = 1003, /** * The current latest .api.json schema version. @@ -26,7 +31,7 @@ export enum ApiJsonSchemaVersion { * IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE` * should be updated. */ - LATEST = V_1002, + LATEST = V_1003, /** * The oldest .api.json schema version that is still supported for backwards compatibility. From 32fb006468d1e01bc4f47392a82698104652720a Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 16:22:48 -0700 Subject: [PATCH 20/22] rush rebuild with new schemaVersion --- .../api-documenter-test/etc/api-documenter-test.api.json | 2 +- .../ambientNameConflict/api-extractor-scenarios.api.json | 2 +- .../test-outputs/apiItemKinds/api-extractor-scenarios.api.json | 2 +- .../circularImport/api-extractor-scenarios.api.json | 2 +- .../circularImport2/api-extractor-scenarios.api.json | 2 +- .../defaultExportOfEntryPoint/api-extractor-scenarios.api.json | 2 +- .../defaultExportOfEntryPoint2/api-extractor-scenarios.api.json | 2 +- .../defaultExportOfEntryPoint3/api-extractor-scenarios.api.json | 2 +- .../defaultExportOfEntryPoint4/api-extractor-scenarios.api.json | 2 +- .../test-outputs/docReferences/api-extractor-scenarios.api.json | 2 +- .../docReferences2/api-extractor-scenarios.api.json | 2 +- .../docReferences3/api-extractor-scenarios.api.json | 2 +- .../exportDuplicate/api-extractor-scenarios.api.json | 2 +- .../test-outputs/exportEquals/api-extractor-scenarios.api.json | 2 +- .../exportImportedExternal/api-extractor-scenarios.api.json | 2 +- .../exportImportedExternal2/api-extractor-scenarios.api.json | 2 +- .../test-outputs/exportStar/api-extractor-scenarios.api.json | 2 +- .../test-outputs/exportStar2/api-extractor-scenarios.api.json | 2 +- .../test-outputs/exportStar3/api-extractor-scenarios.api.json | 2 +- .../test-outputs/importEquals/api-extractor-scenarios.api.json | 2 +- .../inconsistentReleaseTags/api-extractor-scenarios.api.json | 2 +- .../test-outputs/preapproved/api-extractor-scenarios.api.json | 2 +- .../etc/test-outputs/typeOf/api-extractor-scenarios.api.json | 2 +- .../typeParameters/api-extractor-scenarios.api.json | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json index f141ce469e5..f080ab2777f 100644 --- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json +++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json index b270df1ff9c..80b89247e6c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json index 431aab7a468..f8884decec2 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json index ac9622b525d..9f51db8953c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json index 54cf886fb20..0a61210d03b 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json index 9481524ed75..ba722a2ba78 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json index 44d058996b3..c3ead7e6e28 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json index 0dbdc6c0fb2..6a0c7a1c392 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json index caf569dae49..1726fd0e68e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json index 9953a8a5b84..e33f3429525 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json index 0606d061ea8..9bfdc56a54f 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json index 8dfbd6ed59a..1fe99068e90 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json index 73311ed1929..17c76287b83 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json index 76a650e2830..7ce7c81c2d7 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json index 26f39a63da4..d7e603c111e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json index 26f39a63da4..d7e603c111e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json index 14b0f05ad01..87418952aa6 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json index 2df601f8b9c..bbc59f0821e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json index 2df601f8b9c..bbc59f0821e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json index a7524865aa2..c598779508c 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/importEquals/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json index 55b4e1e58d6..3c21db50c5e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/inconsistentReleaseTags/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json index 26f39a63da4..d7e603c111e 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/preapproved/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json index 235bbee2600..453042c127d 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeOf/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json index ad76fa49570..189423755b5 100644 --- a/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json +++ b/build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json @@ -2,7 +2,7 @@ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "[test mode]", - "schemaVersion": 1002, + "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", From 75fe2c3da50ed0c24b85d29357cf4fa307671cb0 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 16:52:26 -0700 Subject: [PATCH 21/22] PR Feedback: Rename ApiItem_setParent to ApiItem_onParentChanged to clarify that it is not intended to be a general purpose property setter --- apps/api-extractor-model/src/items/ApiItem.ts | 6 +++--- .../api-extractor-model/src/mixins/ApiItemContainerMixin.ts | 4 ++-- common/reviews/api/api-extractor-model.api.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts index 400ae1dc639..b70605354d2 100644 --- a/apps/api-extractor-model/src/items/ApiItem.ts +++ b/apps/api-extractor-model/src/items/ApiItem.ts @@ -52,7 +52,7 @@ export interface IApiItemJson { // PRIVATE - Allows ApiItemContainerMixin to assign the parent. // // tslint:disable-next-line:variable-name -export const ApiItem_setParent: unique symbol = Symbol('ApiItem._setParent'); +export const ApiItem_onParentChanged: unique symbol = Symbol('ApiItem._onAddToContainer'); /** * The abstract base class for all members of an `ApiModel` object. @@ -245,11 +245,11 @@ export class ApiItem { * PRIVATE * * @privateRemarks - * Allows ApiItemContainerMixin to assign the parent. + * Allows ApiItemContainerMixin to assign the parent when the item is added to a container. * * @internal */ - public [ApiItem_setParent](parent: ApiItem | undefined): void { + public [ApiItem_onParentChanged](parent: ApiItem | undefined): void { this._parent = parent; this._canonicalReference = undefined; } diff --git a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts index def0bc0d625..b234d6136ac 100644 --- a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts +++ b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information.s -import { ApiItem, ApiItem_setParent, IApiItemJson, IApiItemOptions, IApiItemConstructor } from '../items/ApiItem'; +import { ApiItem, ApiItem_onParentChanged, IApiItemJson, IApiItemOptions, IApiItemConstructor } from '../items/ApiItem'; import { ApiNameMixin } from './ApiNameMixin'; import { DeserializerContext } from '../model/DeserializerContext'; @@ -145,7 +145,7 @@ export function ApiItemContainerMixin(ba this[_membersSorted] = false; this[_membersByContainerKey].set(member.containerKey, member); - member[ApiItem_setParent](this); + member[ApiItem_onParentChanged](this); } public tryGetMemberByKey(containerKey: string): ApiItem | undefined { diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index 3c97332d0e7..6945e12a7f7 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -233,7 +233,7 @@ export class ApiInterface extends ApiInterface_base { // @public export class ApiItem { // @internal - [ApiItem_setParent](parent: ApiItem | undefined): void; + [ApiItem_onParentChanged](parent: ApiItem | undefined): void; constructor(options: IApiItemOptions); // @virtual protected buildCanonicalReference(): DeclarationReference; From 55a4264cc6c5390aec15142f2eabdf08165ff8d2 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Wed, 7 Aug 2019 17:12:08 -0700 Subject: [PATCH 22/22] PR Feedback: Add `EntryPoint.importPath` property to clarify how ApiEntryPoint will participate in the `ApiItem.canonicalReference` in the future --- .../src/model/ApiEntryPoint.ts | 25 ++++++++++++++++--- common/reviews/api/api-extractor-model.api.md | 1 + 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/apps/api-extractor-model/src/model/ApiEntryPoint.ts b/apps/api-extractor-model/src/model/ApiEntryPoint.ts index 5697b176215..a95b84f47ac 100644 --- a/apps/api-extractor-model/src/model/ApiEntryPoint.ts +++ b/apps/api-extractor-model/src/model/ApiEntryPoint.ts @@ -22,8 +22,11 @@ export interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IA * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of * API declarations. * - * `ApiEntryPoint` represents the entry point to an NPM package. For example, suppose the package.json file - * looks like this: + * `ApiEntryPoint` represents the entry point to an NPM package. API Extractor does not currently support + * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature. + * In the current implementation, `ApiEntryPoint.importPath` is always the empty string. + * + * For example, suppose the package.json file looks like this: * * ```json * { @@ -54,11 +57,27 @@ export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) return this.name; } + /** + * The module path for this entry point, relative to the parent `ApiPackage`. In the current implementation, + * this is always the empty string, indicating the default entry point. + * + * @remarks + * + * API Extractor does not currently support analysis of multiple entry points. If that feature is implemented + * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points, + * for example: `controls/Button` in `import { Button } from "example-package/controls/Button";`. + * + * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`. + */ + public get importPath(): string { + return this.name; + } + /** @beta @override */ public buildCanonicalReference(): DeclarationReference { if (this.parent instanceof ApiPackage) { - return DeclarationReference.package(this.parent.name, this.name); + return DeclarationReference.package(this.parent.name, this.importPath); } return DeclarationReference.empty(); diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md index 6945e12a7f7..275ca794fc7 100644 --- a/common/reviews/api/api-extractor-model.api.md +++ b/common/reviews/api/api-extractor-model.api.md @@ -133,6 +133,7 @@ export class ApiEntryPoint extends ApiEntryPoint_base { buildCanonicalReference(): DeclarationReference; // @override (undocumented) readonly containerKey: string; + readonly importPath: string; // @override (undocumented) readonly kind: ApiItemKind; }