@azure/storage-file-share 12.8.0-beta.1 → 12.8.1-alpha.20211025.1

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Release History
 
-## 12.8.0-beta.1 (2021-07-26)
+## 12.8.1 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+## 12.8.0 (2021-09-10)
+
+### Features Added
+
+- Includes all features released in 12.8.0-beta.1.
+
+## 12.7.0 (2021-08-02)
+
+- Support for Node.js 8 and IE 11 has been dropped. Please see our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
+- Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
+- Updated our internal core package dependencies to their latest versions in order to add support for Opentelemetry 1.0.0 which is compatible with the latest versions of our other client libraries.
+
+## 12.8.0-beta.1 (2021-07-28)
 
 ### Features Added
 
@@ -8,7 +30,6 @@
 - Added support for including additional information in `ShareDirectoryClient.listFilesAndDirectories()`.
 - Added support for OAuth in copying source in `ShareFileClient.uploadRangeFromURL()` when source is a Blob.
 - With the dropping of support for Node.js versions that are no longer in LTS, the dependency on `@types/node` has been updated to version 12. Read our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
-- Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
 
 ## 12.6.0 (2021-06-09)
 

package/dist/index.js

@@ -311,7 +311,7 @@ function ipRangeToString(ipRange) {
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "12.8.0-beta.1";
+const SDK_VERSION = "12.8.1";
 const SERVICE_VERSION = "2020-10-02";
 const FILE_MAX_SIZE_BYTES = 4 * 1024 * 1024 * 1024 * 1024; // 4TB
 const FILE_RANGE_MAX_SIZE_BYTES = 4 * 1024 * 1024; // 4MB
@@ -681,6 +681,7 @@ function truncatedISO8061Date(date, withMilliseconds = true) {
  */
 async function delay(timeInMs, aborter, abortError) {
     return new Promise((resolve, reject) => {
+        /* eslint-disable-next-line prefer-const */
         let timeout;
         const abortHandler = () => {
             if (timeout !== undefined) {
@@ -694,6 +695,7 @@ async function delay(timeInMs, aborter, abortError) {
             }
             resolve();
         };
+        /* eslint-disable-next-line prefer-const */
         timeout = setTimeout(resolveHandler, timeInMs);
         if (aborter !== undefined) {
             aborter.addEventListener("abort", abortHandler);
@@ -732,10 +734,10 @@ function getAccountNameFromUrl(url) {
     }
 }
 function isIpEndpointStyle(parsedUrl) {
-    if (parsedUrl.getHost() == undefined) {
+    if (parsedUrl.getHost() === undefined) {
         return false;
     }
-    const host = parsedUrl.getHost() + (parsedUrl.getPort() == undefined ? "" : ":" + parsedUrl.getPort());
+    const host = parsedUrl.getHost() + (parsedUrl.getPort() === undefined ? "" : ":" + parsedUrl.getPort());
     // Case 1: Ipv6, use a broad regex to find out candidates whose host contains two ':'.
     // Case 2: localhost(:port), use broad regex to match port part.
     // Case 3: Ipv4, use broad regex which just check if host contains Ipv4.
@@ -798,9 +800,7 @@ function getShareNameAndPathFromUrl(url) {
     }
 }
 function httpAuthorizationToString(httpAuthorization) {
-    return httpAuthorization
-        ? httpAuthorization.scheme + " " + httpAuthorization.parameter
-        : undefined;
+    return httpAuthorization ? httpAuthorization.scheme + " " + httpAuthorization.value : undefined;
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -817,7 +817,7 @@ function httpAuthorizationToString(httpAuthorization) {
 /**
  * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
  * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link FileSASSignatureValues}
- * types. Once generated, it can be encoded into a {@code String} and appended to a URL directly (though caution should
+ * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
  * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
  * these query parameters).
  *
@@ -9184,6 +9184,8 @@ class StorageBrowserPolicy extends coreHttp.BaseRequestPolicy {
      * @param nextPolicy -
      * @param options -
      */
+    // The base class has a protected constructor. Adding a public one to enable constructing of this class.
+    /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
     constructor(nextPolicy, options) {
         super(nextPolicy, options);
     }
@@ -9311,7 +9313,7 @@ class StorageRetryPolicy extends coreHttp.BaseRequestPolicy {
             }
         }
         await this.delay(isPrimaryRetry, attempt, request.abortSignal);
-        return await this.attemptSendRequest(request, secondaryHas404, ++attempt);
+        return this.attemptSendRequest(request, secondaryHas404, ++attempt);
     }
     /**
      * Decide whether to retry according to last HTTP response and retry counters.
@@ -9539,6 +9541,8 @@ class AnonymousCredentialPolicy extends CredentialPolicy {
      * @param nextPolicy -
      * @param options -
      */
+    // The base class has a protected constructor. Adding a public one to enable constructing of this class.
+    /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
     constructor(nextPolicy, options) {
         super(nextPolicy, options);
     }
@@ -9557,11 +9561,7 @@ class Credential {
      * @param _nextPolicy -
      * @param _options -
      */
-    create(
-    // tslint:disable-next-line:variable-name
-    _nextPolicy, 
-    // tslint:disable-next-line:variable-name
-    _options) {
+    create(_nextPolicy, _options) {
         throw new Error("Method should be implemented in children classes.");
     }
 }
@@ -9777,7 +9777,7 @@ class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
         if (queries) {
             const queryKeys = [];
             for (const key in queries) {
-                if (queries.hasOwnProperty(key)) {
+                if (Object.prototype.hasOwnProperty.call(queries, key)) {
                     const lowercaseKey = key.toLowerCase();
                     lowercaseQueries[lowercaseKey] = queries[key];
                     queryKeys.push(lowercaseKey);
@@ -9849,6 +9849,7 @@ const createSpan = coreTracing.createSpanFunction({
 function convertTracingToRequestOptionsBase(options) {
     var _a, _b;
     return {
+        // By passing spanOptions if they exist at runtime, we're backwards compatible with @azure/core-tracing@preview.13 and earlier.
         spanOptions: (_a = options === null || options === void 0 ? void 0 : options.tracingOptions) === null || _a === void 0 ? void 0 : _a.spanOptions,
         tracingContext: (_b = options === null || options === void 0 ? void 0 : options.tracingOptions) === null || _b === void 0 ? void 0 : _b.tracingContext
     };
@@ -9862,7 +9863,7 @@ function convertTracingToRequestOptionsBase(options) {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 const packageName = "azure-storage-file-share";
-const packageVersion = "12.7.0-beta.1";
+const packageVersion = "12.8.1";
 class StorageClientContext extends coreHttp.ServiceClient {
     /**
      * Initializes a new instance of the StorageClientContext class.
@@ -10160,15 +10161,14 @@ class RetriableReadableStream extends stream.Readable {
                         this.setSourceDataHandler();
                         this.setSourceEndHandler();
                         this.setSourceErrorHandler();
+                        return;
                     })
                         .catch((error) => {
                         this.emit("error", error);
                     });
                 }
                 else {
-                    this.emit("error", new Error(
-                    // tslint:disable-next-line:max-line-length
-                    `Data corruption failure: received less data than required and reached maxRetires limitation. Received data offset: ${this
+                    this.emit("error", new Error(`Data corruption failure: received less data than required and reached maxRetires limitation. Received data offset: ${this
                         .offset - 1}, data needed offset: ${this.end}, retries: ${this.retries}, max retries: ${this.maxRetryRequests}`));
                 }
             }
@@ -11109,7 +11109,10 @@ const fsCreateReadStream = fs.createReadStream;
  * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
  */
 class ShareClient extends StorageClient {
-    constructor(urlOrConnectionString, credentialOrPipelineOrShareName, options) {
+    constructor(urlOrConnectionString, credentialOrPipelineOrShareName, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
         let pipeline;
         let url;
         if (credentialOrPipelineOrShareName instanceof Pipeline) {
@@ -11234,6 +11237,8 @@ class ShareClient extends StorageClient {
      * @param directoryName - A directory name
      * @returns The ShareDirectoryClient object for the given directory name.
      */
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-subclients */
     getDirectoryClient(directoryName) {
         return new ShareDirectoryClient(appendToURLPath(this.url, encodeURIComponent(directoryName)), this.pipeline);
     }
@@ -11243,6 +11248,8 @@ class ShareClient extends StorageClient {
      *
      * @readonly A new ShareDirectoryClient object for the root directory.
      */
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-subclients */
     get rootDirectoryClient() {
         return this.getDirectoryClient("");
     }
@@ -12071,6 +12078,8 @@ class ShareDirectoryClient extends StorageClient {
      * console.log("Updated file successfully!")
      * ```
      */
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-subclients */
     getFileClient(fileName) {
         return new ShareFileClient(appendToURLPath(this.url, encodeURIComponent(fileName)), this.pipeline);
     }
@@ -12663,8 +12672,12 @@ class ShareDirectoryClient extends StorageClient {
             do {
                 const response = await this.forceCloseHandlesSegment(marker, updatedOptions);
                 marker = response.marker;
-                response.closedHandlesCount && (handlesClosed += response.closedHandlesCount);
-                response.closeFailureCount && (numberOfHandlesFailedToClose += response.closeFailureCount);
+                if (response.closedHandlesCount) {
+                    handlesClosed += response.closedHandlesCount;
+                }
+                if (response.closeFailureCount) {
+                    numberOfHandlesFailedToClose += response.closeFailureCount;
+                }
             } while (marker);
             return { closedHandlesCount: handlesClosed, closeFailureCount: numberOfHandlesFailedToClose };
         }
@@ -12717,7 +12730,10 @@ class ShareDirectoryClient extends StorageClient {
  * A ShareFileClient represents a URL to an Azure Storage file.
  */
 class ShareFileClient extends StorageClient {
-    constructor(url, credentialOrPipeline, options) {
+    constructor(url, credentialOrPipeline, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
         let pipeline;
         if (credentialOrPipeline instanceof Pipeline) {
             pipeline = credentialOrPipeline;
@@ -12902,7 +12918,7 @@ class ShareFileClient extends StorageClient {
                 throw new RangeError(`File download response doesn't contain valid content length header`);
             }
             return new FileDownloadResponse(res, async (start) => {
-                const updatedOptions = {
+                const updatedDownloadOptions = {
                     range: rangeToString({
                         count: offset + res.contentLength - start,
                         offset: start
@@ -12911,10 +12927,10 @@ class ShareFileClient extends StorageClient {
                 // Debug purpose only
                 // console.log(
                 //   `Read from internal stream, range: ${
-                //     updatedOptions.range
-                //   }, options: ${JSON.stringify(updatedOptions)}`
+                //     chunkDownloadOptions.range
+                //   }, options: ${JSON.stringify(chunkDownloadOptions)}`
                 // );
-                const downloadRes = await this.context.download(Object.assign(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.leaseAccessConditions }, updatedOptions), convertTracingToRequestOptionsBase(updatedOptions)));
+                const downloadRes = await this.context.download(Object.assign(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.leaseAccessConditions }, updatedDownloadOptions), convertTracingToRequestOptionsBase(updatedDownloadOptions)));
                 if (!(downloadRes.etag === res.etag)) {
                     throw new Error("File has been modified concurrently");
                 }
@@ -13974,8 +13990,12 @@ class ShareFileClient extends StorageClient {
             do {
                 const response = await this.forceCloseHandlesSegment(marker, { tracingOptions: updatedOptions.tracingOptions });
                 marker = response.marker;
-                response.closedHandlesCount && (handlesClosed += response.closedHandlesCount);
-                response.closeFailureCount && (numberOfHandlesFailedToClose += response.closeFailureCount);
+                if (response.closedHandlesCount) {
+                    handlesClosed += response.closedHandlesCount;
+                }
+                if (response.closeFailureCount) {
+                    numberOfHandlesFailedToClose += response.closeFailureCount;
+                }
             } while (marker);
             return {
                 closedHandlesCount: handlesClosed,
@@ -14228,7 +14248,7 @@ class ShareClientInternal extends StorageClient {
         this.context = new Share(this.storageClientContext);
     }
     async restore(options = {}) {
-        return await this.context.restore(options);
+        return this.context.restore(options);
     }
 }
 
@@ -14238,7 +14258,10 @@ class ShareClientInternal extends StorageClient {
  * to manipulate file shares.
  */
 class ShareServiceClient extends StorageClient {
-    constructor(url, credentialOrPipeline, options) {
+    constructor(url, credentialOrPipeline, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
         let pipeline;
         if (credentialOrPipeline instanceof Pipeline) {
             pipeline = credentialOrPipeline;
@@ -14266,7 +14289,10 @@ class ShareServiceClient extends StorageClient {
      * @param options - Options to configure the HTTP pipeline.
      * @returns A new ShareServiceClient from the given connection string.
      */
-    static fromConnectionString(connectionString, options) {
+    static fromConnectionString(connectionString, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
         const extractedCreds = extractConnectionStringParts(connectionString);
         if (extractedCreds.kind === "AccountConnString") {
             {