Update API Extractor for all packages (#17917)

## What - Update API Extractor to the latest version (currently 7.18.11) - Regenerate all API reviews by building all the packages ## Why This is something we keep bumping into. First, we needed to upgrade API Extractor to allow us to re-export directly from `@opentelemetry/api`. Then, it looks like we needed this to upgrade TypeScript to 4.4. We are way behind on this version, and it's time to upgrade. ## Callouts How noisy is this?! Here's what's happening - somewhere around 7.9 I think API Extractor improved the way it detects name collisions with predefined globals. Things like KeyType, Response, etc. If there's a clash, the generated API markdown file will rename <Item> to <Item_2> to make the name collision explicit. Talking to folks on the team, and the poor souls that will be doing API Review approvals, we agreed that doing the upgrade in one fell swoop is the way to go. Resolves #9410
Azure · Sep 30, 2021 · 9dc6167 · 9dc6167
1 parent 4aeb47a
commit 9dc6167
Show file tree

Hide file tree

Showing 140 changed files with 577 additions and 658 deletions.
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/sdk/agrifood/agrifood-farming-rest/package.json b/sdk/agrifood/agrifood-farming-rest/package.json
@@ -96,7 +96,7 @@
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/identity": "^1.1.0",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.13.2",
+    "@microsoft/api-extractor": "^7.18.11",
     "@types/chai": "^4.1.6",
     "@types/mocha": "^7.0.2",
     "@types/node": "^12.0.0",

diff --git a/sdk/anomalydetector/ai-anomaly-detector/package.json b/sdk/anomalydetector/ai-anomaly-detector/package.json
@@ -72,7 +72,7 @@
     "@azure/dev-tool": "^1.0.0",
     "@azure/identity": "2.0.0-beta.6",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/anomalydetector/ai-anomaly-detector/review/ai-anomaly-detector.api.md b/sdk/anomalydetector/ai-anomaly-detector/review/ai-anomaly-detector.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import * as coreHttp from '@azure/core-http';
 import { KeyCredential } from '@azure/core-auth';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
@@ -364,7 +366,6 @@ export interface TimeSeriesPoint {
     value: number;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/apimanagement/arm-apimanagement/package.json b/sdk/apimanagement/arm-apimanagement/package.json
@@ -28,7 +28,7 @@
   "module": "./dist-esm/src/index.js",
   "types": "./types/arm-apimanagement.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/apimanagement/arm-apimanagement/review/arm-apimanagement.api.md b/sdk/apimanagement/arm-apimanagement/review/arm-apimanagement.api.md
@@ -677,7 +677,7 @@ export class ApiManagementClient extends ApiManagementClientContext {
     beginPerformConnectivityCheckAsync(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: ApiManagementClientPerformConnectivityCheckAsyncOptionalParams): Promise<PollerLike<PollOperationState<ApiManagementClientPerformConnectivityCheckAsyncResponse>, ApiManagementClientPerformConnectivityCheckAsyncResponse>>;
     beginPerformConnectivityCheckAsyncAndWait(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: ApiManagementClientPerformConnectivityCheckAsyncOptionalParams): Promise<ApiManagementClientPerformConnectivityCheckAsyncResponse>;
     // (undocumented)
-    cache: Cache;
+    cache: Cache_2;
     // (undocumented)
     certificate: Certificate;
     // (undocumented)
@@ -715,7 +715,7 @@ export class ApiManagementClient extends ApiManagementClientContext {
     // (undocumented)
     networkStatus: NetworkStatus;
     // (undocumented)
-    notification: Notification;
+    notification: Notification_2;
     // (undocumented)
     notificationRecipientEmail: NotificationRecipientEmail;
     // (undocumented)
@@ -2405,14 +2405,15 @@ export interface BodyDiagnosticSettings {
 }
 
 // @public
-export interface Cache {
+interface Cache_2 {
     createOrUpdate(resourceGroupName: string, serviceName: string, cacheId: string, parameters: CacheContract, options?: CacheCreateOrUpdateOptionalParams): Promise<CacheCreateOrUpdateResponse>;
     delete(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, options?: CacheDeleteOptionalParams): Promise<void>;
     get(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetOptionalParams): Promise<CacheGetResponse>;
     getEntityTag(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetEntityTagOptionalParams): Promise<CacheGetEntityTagResponse>;
     listByService(resourceGroupName: string, serviceName: string, options?: CacheListByServiceOptionalParams): PagedAsyncIterableIterator<CacheContract>;
     update(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, parameters: CacheUpdateParameters, options?: CacheUpdateOptionalParams): Promise<CacheUpdateResponse>;
 }
+export { Cache_2 as Cache }
 
 // @public
 export interface CacheCollection {
@@ -3559,7 +3560,7 @@ export type GatewayHostnameConfigurationListByServiceResponse = GatewayHostnameC
 
 // @public
 export interface GatewayKeyRegenerationRequestContract {
-    keyType: KeyType;
+    keyType: KeyType_2;
 }
 
 // @public
@@ -3612,7 +3613,7 @@ export interface GatewayTokenContract {
 // @public
 export interface GatewayTokenRequestContract {
     expiry: Date;
-    keyType: KeyType;
+    keyType: KeyType_2;
 }
 
 // @public
@@ -4134,7 +4135,8 @@ export type IssueUpdateContractProperties = IssueContractBaseProperties & {
 };
 
 // @public
-export type KeyType = "primary" | "secondary";
+type KeyType_2 = "primary" | "secondary";
+export { KeyType_2 as KeyType }
 
 // @public
 export interface KeyVaultContractCreateProperties {
@@ -5010,11 +5012,12 @@ export interface NetworkStatusListByServiceOptionalParams extends coreClient.Ope
 export type NetworkStatusListByServiceResponse = NetworkStatusContractByLocation[];
 
 // @public
-export interface Notification {
+interface Notification_2 {
     createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: NotificationName, options?: NotificationCreateOrUpdateOptionalParams): Promise<NotificationCreateOrUpdateResponse>;
     get(resourceGroupName: string, serviceName: string, notificationName: NotificationName, options?: NotificationGetOptionalParams): Promise<NotificationGetResponse>;
     listByService(resourceGroupName: string, serviceName: string, options?: NotificationListByServiceOptionalParams): PagedAsyncIterableIterator<NotificationContract>;
 }
+export { Notification_2 as Notification }
 
 // @public
 export interface NotificationCollection {
@@ -7827,7 +7830,7 @@ export type UserSubscriptionListResponse = SubscriptionCollection;
 // @public
 export interface UserTokenParameters {
     expiry?: Date;
-    keyType?: KeyType;
+    keyType?: KeyType_2;
 }
 
 // @public
@@ -7888,7 +7891,6 @@ export interface X509CertificateName {
     name?: string;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/appconfiguration/app-configuration/package.json b/sdk/appconfiguration/app-configuration/package.json
@@ -99,7 +99,7 @@
     "@azure/identity": "2.0.0-beta.6",
     "@azure/keyvault-secrets": "^4.2.0",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-inject": "^4.0.0",
     "@rollup/plugin-json": "^4.0.0",

diff --git a/sdk/appconfiguration/app-configuration/review/app-configuration.api.md b/sdk/appconfiguration/app-configuration/review/app-configuration.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference lib="esnext.asynciterable" />
+
 import { HttpResponse } from '@azure/core-http';
 import { OperationOptions } from '@azure/core-http';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
@@ -218,7 +220,6 @@ export interface SyncTokenHeaderField {
     syncToken?: string;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/appservice/arm-appservice/package.json b/sdk/appservice/arm-appservice/package.json
@@ -28,7 +28,7 @@
   "module": "./dist-esm/index.js",
   "types": "./types/arm-appservice.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/appservice/arm-appservice/review/arm-appservice.api.md b/sdk/appservice/arm-appservice/review/arm-appservice.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
@@ -10626,7 +10628,6 @@ export type WorkerPoolResource = ProxyOnlyResource & {
 // @public
 export type WorkerSizeOptions = "Small" | "Medium" | "Large" | "D1" | "D2" | "D3" | "SmallV3" | "MediumV3" | "LargeV3" | "NestedSmall" | "NestedSmallLinux" | "Default";
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/attestation/attestation/package.json b/sdk/attestation/attestation/package.json
@@ -105,7 +105,7 @@
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/identity": "2.0.0-beta.6",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@types/chai": "^4.1.6",
     "@types/chai-as-promised": "^7.1.0",
     "@types/mocha": "^7.0.2",

diff --git a/sdk/attestation/attestation/review/attestation.api.md b/sdk/attestation/attestation/review/attestation.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { CommonClientOptions } from '@azure/core-client';
 import { OperationOptions } from '@azure/core-client';
 import { TokenCredential } from '@azure/core-auth';
@@ -17,7 +19,7 @@ export class AttestationAdministrationClient {
     removePolicyManagementCertificate(pemCertificate: string, privateKey: string, certificate: string, options?: AttestationAdministrationClientPolicyCertificateOperationOptions): Promise<AttestationResponse<PolicyCertificatesModificationResult>>;
     resetPolicy(attestationType: AttestationType, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>;
     setPolicy(attestationType: AttestationType, newPolicyDocument: string, options?: AttestationAdministrationClientPolicyOperationOptions): Promise<AttestationResponse<PolicyResult>>;
-    }
+}
 
 // @public
 export interface AttestationAdministrationClientOperationOptions extends OperationOptions {
@@ -48,7 +50,7 @@ export class AttestationClient {
     attestTpm(request: string, options?: AttestTpmOptions): Promise<string>;
     getAttestationSigners(options?: AttestationClientOperationOptions): Promise<AttestationSigner[]>;
     getOpenIdMetadata(options?: AttestationClientOperationOptions): Promise<Record<string, unknown>>;
-    }
+}
 
 // @public
 export interface AttestationClientOperationOptions extends OperationOptions {
@@ -207,7 +209,6 @@ export interface PolicyResult {
     policyTokenHash: Uint8Array;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/authorization/arm-authorization/package.json b/sdk/authorization/arm-authorization/package.json
@@ -26,7 +26,7 @@
   "module": "./dist-esm/index.js",
   "types": "./types/arm-authorization.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-chat/package.json b/sdk/communication/communication-chat/package.json
@@ -82,7 +82,7 @@
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-chat/review/communication-chat.api.md b/sdk/communication/communication-chat/review/communication-chat.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference lib="esnext.asynciterable" />
+
 import { ChatMessageDeletedEvent } from '@azure/communication-signaling';
 import { ChatMessageEditedEvent } from '@azure/communication-signaling';
 import { ChatMessageReceivedEvent } from '@azure/communication-signaling';
@@ -64,7 +66,7 @@ export class ChatClient {
     on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void;
     startRealtimeNotifications(): Promise<void>;
     stopRealtimeNotifications(): Promise<void>;
-    }
+}
 
 // @public
 export interface ChatClientOptions extends CommonClientOptions {
@@ -272,7 +274,6 @@ export interface UpdateMessageOptions extends OperationOptions {
 export interface UpdateTopicOptions extends OperationOptions {
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/communication/communication-common/package.json b/sdk/communication/communication-common/package.json
@@ -73,7 +73,7 @@
   "devDependencies": {
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/dev-tool": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-identity/package.json b/sdk/communication/communication-identity/package.json
@@ -89,7 +89,7 @@
     "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
     "@azure/identity": "2.0.0-beta.6",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-network-traversal/package.json b/sdk/communication/communication-network-traversal/package.json
@@ -88,7 +88,7 @@
     "@azure/identity": "2.0.0-beta.6",
     "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-phone-numbers/package.json b/sdk/communication/communication-phone-numbers/package.json
@@ -77,7 +77,7 @@
     "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
     "@azure/identity": "2.0.0-beta.6",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/...unication/communication-phone-numbers/review/communication-phone-numbers.api.md b/...unication/communication-phone-numbers/review/communication-phone-numbers.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference lib="esnext.asynciterable" />
+
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-http';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
@@ -125,7 +127,6 @@ export interface SearchAvailablePhoneNumbersRequest extends PhoneNumberSearchReq
     countryCode: string;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/communication/communication-sms/package.json b/sdk/communication/communication-sms/package.json
@@ -79,7 +79,7 @@
     "@azure/identity": "2.0.0-beta.6",
     "@azure/test-utils": "^1.0.0",
     "@azure-tools/test-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/communication/communication-sms/review/communication-sms.api.md b/sdk/communication/communication-sms/review/communication-sms.api.md
@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference lib="esnext.asynciterable" />
+
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-http';
 import { PipelineOptions } from '@azure/core-http';
@@ -43,7 +45,6 @@ export interface SmsSendResult {
     to: string;
 }
 
-
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/sdk/compute/arm-compute/package.json b/sdk/compute/arm-compute/package.json
@@ -28,7 +28,7 @@
   "module": "./dist-esm/index.js",
   "types": "./types/arm-compute.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.18.11",
     "@rollup/plugin-commonjs": "11.0.2",
     "@rollup/plugin-json": "^4.0.0",
     "@rollup/plugin-multi-entry": "^3.0.0",