pin api-extractor to 7.7.11 #8400

KarishmaGhiya · 2020-04-16T18:46:37Z

There is a bug in the newer versions of api-extractor (both 7.7.12 and 7.7.13) where it changes the public api and appends "_2" to many of the public-facing interfaces and properties -
Also look at the commits - https://github.com/Azure/azure-sdk-for-js/pull/8179/commits

git diff .\sdk\storage\storage-file-datalake\
diff --git a/sdk/storage/storage-file-datalake/package.json b/sdk/storage/storage-file-datalake/package.json
index 905c34f082..cb1ecf55e3 100644
--- a/sdk/storage/storage-file-datalake/package.json
+++ b/sdk/storage/storage-file-datalake/package.json
@@ -106,7 +106,7 @@
   "devDependencies": {
     "@azure/identity": "1.1.0-preview.2",
     "@azure/test-utils-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.7.13",
     "@opentelemetry/types": "^0.2.0",
     "@rollup/plugin-commonjs": "^11.0.1",
     "@rollup/plugin-multi-entry": "^3.0.0",
diff --git a/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md b/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
index d0c931a0fb..b5b1647378 100644
--- a/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
+++ b/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
@@ -96,7 +96,7 @@ export interface AccountSASSignatureValues {
 }

 // @public
-export class AnonymousCredential extends Credential {
+export class AnonymousCredential extends Credential_2 {
     create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }

@@ -116,10 +116,12 @@ export interface CommonOptions {
 export type CopyStatusType = "pending" | "success" | "aborted" | "failed";

 // @public
-export abstract class Credential implements RequestPolicyFactory {
+abstract class Credential_2 implements RequestPolicyFactory {
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }

+export { Credential_2 as Credential }
+
 // @public
 export abstract class CredentialPolicy extends BaseRequestPolicy {
     sendRequest(request: WebResource): Promise<HttpOperationResponse>;
@@ -1514,7 +1516,7 @@ export enum StorageRetryPolicyType {
 }

 // @public
-export class StorageSharedKeyCredential extends Credential {
+export class StorageSharedKeyCredential extends Credential_2 {
     constructor(accountName: string, accountKey: string);
     readonly accountName: string;
     computeHMACSHA256(stringToSign: string): string;
PS C:\code\azure-sdk-for-js> git diff .\sdk\storage\
diff --git a/sdk/storage/storage-blob/package.json b/sdk/storage/storage-blob/package.json
index 381ca62d1a..3f714f5c48 100644
--- a/sdk/storage/storage-blob/package.json
+++ b/sdk/storage/storage-blob/package.json
@@ -111,7 +111,7 @@
   "devDependencies": {
     "@azure/identity": "1.1.0-preview.2",
     "@azure/test-utils-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.7.13",
     "@rollup/plugin-multi-entry": "^3.0.0",
     "@rollup/plugin-replace": "^2.2.0",
     "@types/mocha": "^7.0.2",
diff --git a/sdk/storage/storage-blob/review/storage-blob.api.md b/sdk/storage/storage-blob/review/storage-blob.api.md
index 181ba0c818..bb5756fc19 100644
--- a/sdk/storage/storage-blob/review/storage-blob.api.md
+++ b/sdk/storage/storage-blob/review/storage-blob.api.md
@@ -89,7 +89,7 @@ export interface AccountSASSignatureValues {
 }

 // @public
-export class AnonymousCredential extends Credential {
+export class AnonymousCredential extends Credential_2 {
     create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }

@@ -1088,7 +1088,7 @@ export interface BlockBlobStageBlockFromURLOptions extends CommonOptions {
     conditions?: LeaseAccessConditions;
     customerProvidedKey?: CpkInfo;
     encryptionScope?: string;
-    range?: Range;
+    range?: Range_2;
     sourceContentCrc64?: Uint8Array;
     sourceContentMD5?: Uint8Array;
 }
@@ -1570,10 +1570,12 @@ export interface CpkInfo {
 }

 // @public
-export abstract class Credential implements RequestPolicyFactory {
+abstract class Credential_2 implements RequestPolicyFactory {
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }

+export { Credential_2 as Credential }
+
 // @public
 export abstract class CredentialPolicy extends BaseRequestPolicy {
     sendRequest(request: WebResource): Promise<HttpOperationResponse>;
@@ -2056,8 +2058,8 @@ export type PageBlobUploadPagesResponse = PageBlobUploadPagesHeaders & {

 // @public
 export interface PageList {
-    clearRange?: Range[];
-    pageRange?: Range[];
+    clearRange?: Range_2[];
+    pageRange?: Range_2[];
 }

 // @public
@@ -2103,11 +2105,13 @@ export enum PremiumPageBlobTier {
 export type PublicAccessType = 'container' | 'blob';

 // @public
-export interface Range {
+interface Range_2 {
     count?: number;
     offset: number;
 }

+export { Range_2 as Range }
+
 // @public
 export type RehydratePriority = 'High' | 'Standard';

@@ -2416,7 +2420,7 @@ export enum StorageRetryPolicyType {
 }

 // @public
-export class StorageSharedKeyCredential extends Credential {
+export class StorageSharedKeyCredential extends Credential_2 {
     constructor(accountName: string, accountKey: string);
     readonly accountName: string;
     computeHMACSHA256(stringToSign: string): string;
diff --git a/sdk/storage/storage-file-datalake/package.json b/sdk/storage/storage-file-datalake/package.json
index 905c34f082..cb1ecf55e3 100644
--- a/sdk/storage/storage-file-datalake/package.json
+++ b/sdk/storage/storage-file-datalake/package.json
@@ -106,7 +106,7 @@
   "devDependencies": {
     "@azure/identity": "1.1.0-preview.2",
     "@azure/test-utils-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.7.13",
     "@opentelemetry/types": "^0.2.0",
     "@rollup/plugin-commonjs": "^11.0.1",
     "@rollup/plugin-multi-entry": "^3.0.0",
diff --git a/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md b/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
index d0c931a0fb..b5b1647378 100644
--- a/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
+++ b/sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md
@@ -96,7 +96,7 @@ export interface AccountSASSignatureValues {
 }

 // @public
-export class AnonymousCredential extends Credential {
+export class AnonymousCredential extends Credential_2 {
     create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }

@@ -116,10 +116,12 @@ export interface CommonOptions {
 export type CopyStatusType = "pending" | "success" | "aborted" | "failed";

 // @public
-export abstract class Credential implements RequestPolicyFactory {
+abstract class Credential_2 implements RequestPolicyFactory {
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }

+export { Credential_2 as Credential }
+
 // @public
 export abstract class CredentialPolicy extends BaseRequestPolicy {
     sendRequest(request: WebResource): Promise<HttpOperationResponse>;
@@ -1514,7 +1516,7 @@ export enum StorageRetryPolicyType {
 }

 // @public
-export class StorageSharedKeyCredential extends Credential {
+export class StorageSharedKeyCredential extends Credential_2 {
     constructor(accountName: string, accountKey: string);
     readonly accountName: string;
     computeHMACSHA256(stringToSign: string): string;
diff --git a/sdk/storage/storage-file-share/package.json b/sdk/storage/storage-file-share/package.json
index d141d9d067..d8e89adf2c 100644
--- a/sdk/storage/storage-file-share/package.json
+++ b/sdk/storage/storage-file-share/package.json
@@ -112,7 +112,7 @@
   },
   "devDependencies": {
     "@azure/test-utils-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
+    "@microsoft/api-extractor": "^7.7.13",
     "@rollup/plugin-commonjs": "^11.0.1",
     "@rollup/plugin-multi-entry": "^3.0.0",
     "@rollup/plugin-node-resolve": "^7.0.0",
diff --git a/sdk/storage/storage-file-share/review/storage-file-share.api.md b/sdk/storage/storage-file-share/review/storage-file-share.api.md
index 5e35c854da..c6308143b1 100644
--- a/sdk/storage/storage-file-share/review/storage-file-share.api.md
+++ b/sdk/storage/storage-file-share/review/storage-file-share.api.md
@@ -80,7 +80,7 @@ export interface AccountSASSignatureValues {
 }

 // @public
-export class AnonymousCredential extends Credential {
+export class AnonymousCredential extends Credential_2 {
     create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }

@@ -128,10 +128,12 @@ export interface CorsRule {
 }

 // @public
-export abstract class Credential implements RequestPolicyFactory {
+abstract class Credential_2 implements RequestPolicyFactory {
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }

+export { Credential_2 as Credential }
+
 // @public
 export abstract class CredentialPolicy extends BaseRequestPolicy {
     sendRequest(request: WebResource): Promise<HttpOperationResponse>;
@@ -673,7 +675,7 @@ export interface FileGetRangeListHeaders {
 export interface FileGetRangeListOptions extends CommonOptions {
     abortSignal?: AbortSignalLike;
     leaseAccessConditions?: LeaseAccessConditions;
-    range?: Range;
+    range?: Range_2;
 }

 // @public
@@ -1124,7 +1126,7 @@ export interface Metrics {
 }

 // @public
-export function newPipeline(credential: Credential, pipelineOptions?: StoragePipelineOptions): Pipeline;
+export function newPipeline(credential: Credential_2, pipelineOptions?: StoragePipelineOptions): Pipeline;

 // @public (undocumented)
 export interface OperationTracingOptions {
@@ -1145,11 +1147,13 @@ export interface PipelineOptions {
 }

 // @public
-export interface Range {
+interface Range_2 {
     count?: number;
     offset: number;
 }

+export { Range_2 as Range }
+
 // @public
 export interface RangeModel {
     end: number;
@@ -1280,7 +1284,7 @@ export interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
 // @public
 export class ShareClient extends StorageClient {
     constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
-    constructor(url: string, credential?: Credential, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
     constructor(url: string, pipeline: Pipeline);
     create(options?: ShareCreateOptions): Promise<ShareCreateResponse>;
     createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{
@@ -1409,7 +1413,7 @@ export type ShareDeleteResponse = ShareDeleteHeaders & {

 // @public

pin api-extractor to 7.7.11

3acecc3

KarishmaGhiya requested review from bterlson, chradek, daviwil, HarshaNalluru, jeremymeng, jiacfan, sophiajt, ljian3377, ramya-rao-a, richardpark-msft, sadasant, schaabs, southpolesteve, vinjiang, willmtemple, XiaoningLiu and xirzec as code owners April 16, 2020 18:46

This was referenced Apr 16, 2020

Fix Review Files #8366

Closed

Updates to api review.md across sdks #8179

Closed

ramya-rao-a mentioned this pull request Apr 16, 2020

Use OperationTracingOptions from core-tracing #8389

Merged

ramya-rao-a approved these changes Apr 16, 2020

View reviewed changes

KarishmaGhiya merged commit baa6d42 into Azure:master Apr 16, 2020

ramya-rao-a mentioned this pull request May 27, 2020

Update dev dependency "@microsoft/api-extractor" #9121

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pin api-extractor to 7.7.11 #8400

pin api-extractor to 7.7.11 #8400

KarishmaGhiya commented Apr 16, 2020 •

edited

Loading

pin api-extractor to 7.7.11 #8400

pin api-extractor to 7.7.11 #8400

Conversation

KarishmaGhiya commented Apr 16, 2020 • edited Loading

KarishmaGhiya commented Apr 16, 2020 •

edited

Loading