@azure/storage-blob 12.28.0-beta.2 → 12.28.0

package/dist/commonjs/BlobServiceClient.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BlobServiceClient = void 0;
-const tslib_1 = require("tslib");
 const core_auth_1 = require("@azure/core-auth");
 const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
 const core_util_1 = require("@azure/core-util");
@@ -22,6 +21,10 @@ const AccountSASServices_js_1 = require("./sas/AccountSASServices.js");
  * to manipulate blob containers.
  */
 class BlobServiceClient extends StorageClient_js_1.StorageClient {
+    /**
+     * serviceContext provided by protocol layer.
+     */
+    serviceContext;
     /**
      *
      * Creates an instance of BlobServiceClient from connection string.
@@ -106,7 +109,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
         return new ContainerClient_js_1.ContainerClient((0, utils_common_js_1.appendToURLPath)(this.url, encodeURIComponent(containerName)), this.pipeline);
     }
     /**
-     * Create a Blob container. @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
+     * Create a Blob container. @see https://learn.microsoft.com/rest/api/storageservices/create-container
      *
      * @param containerName - Name of the container to create.
      * @param options - Options to configure Container Create operation.
@@ -160,7 +163,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
     /**
      * Gets the properties of a storage account’s Blob service, including properties
      * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
      *
      * @param options - Options to the Service Get Properties operation.
      * @returns Response data for the Service Get Properties operation.
@@ -176,7 +179,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
     /**
      * Sets properties for a storage account’s Blob service endpoint, including properties
      * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties
      *
      * @param properties -
      * @param options - Options to the Service Set Properties operation.
@@ -194,7 +197,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      * Retrieves statistics related to replication for the Blob service. It is only
      * available on the secondary location endpoint when read-access geo-redundant
      * replication is enabled for the storage account.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-blob-service-stats
      *
      * @param options - Options to the Service Get Statistics operation.
      * @returns Response data for the Service Get Statistics operation.
@@ -212,7 +215,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      * for the specified account.
      * The Get Account Information operation is available on service versions beginning
      * with version 2018-03-28.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-account-information
      *
      * @param options - Options to the Service Get Account Info operation.
      * @returns Response data for the Service Get Account Info operation.
@@ -227,7 +230,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Returns a list of the containers under the specified account.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-containers2
      *
      * @param marker - A string value that identifies the portion of
      *                        the list of containers to be returned with the next listing operation. The
@@ -241,7 +244,13 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      */
     async listContainersSegment(marker, options = {}) {
         return tracing_js_1.tracingClient.withSpan("BlobServiceClient-listContainersSegment", options, async (updatedOptions) => {
-            return (0, utils_common_js_2.assertResponse)(await this.serviceContext.listContainersSegment(Object.assign(Object.assign({ abortSignal: options.abortSignal, marker }, options), { include: typeof options.include === "string" ? [options.include] : options.include, tracingOptions: updatedOptions.tracingOptions })));
+            return (0, utils_common_js_2.assertResponse)(await this.serviceContext.listContainersSegment({
+                abortSignal: options.abortSignal,
+                marker,
+                ...options,
+                include: typeof options.include === "string" ? [options.include] : options.include,
+                tracingOptions: updatedOptions.tracingOptions,
+            }));
         });
     }
     /**
@@ -271,14 +280,17 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
                 maxPageSize: options.maxPageSize,
                 tracingOptions: updatedOptions.tracingOptions,
             }));
-            const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, blobs: response.blobs.map((blob) => {
-                    var _a;
+            const wrappedResponse = {
+                ...response,
+                _response: response._response, // _response is made non-enumerable
+                blobs: response.blobs.map((blob) => {
                     let tagValue = "";
-                    if (((_a = blob.tags) === null || _a === void 0 ? void 0 : _a.blobTagSet.length) === 1) {
+                    if (blob.tags?.blobTagSet.length === 1) {
                         tagValue = blob.tags.blobTagSet[0].value;
                     }
-                    return Object.assign(Object.assign({}, blob), { tags: (0, utils_common_js_1.toTags)(blob.tags), tagValue });
-                }) });
+                    return { ...blob, tags: (0, utils_common_js_1.toTags)(blob.tags), tagValue };
+                }),
+            };
             return wrappedResponse;
         });
     }
@@ -298,18 +310,16 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      *                          items. The marker value is opaque to the client.
      * @param options - Options to find blobs by tags.
      */
-    findBlobsByTagsSegments(tagFilterSqlExpression_1, marker_1) {
-        return tslib_1.__asyncGenerator(this, arguments, function* findBlobsByTagsSegments_1(tagFilterSqlExpression, marker, options = {}) {
-            let response;
-            if (!!marker || marker === undefined) {
-                do {
-                    response = yield tslib_1.__await(this.findBlobsByTagsSegment(tagFilterSqlExpression, marker, options));
-                    response.blobs = response.blobs || [];
-                    marker = response.continuationToken;
-                    yield yield tslib_1.__await(response);
-                } while (marker);
-            }
-        });
+    async *findBlobsByTagsSegments(tagFilterSqlExpression, marker, options = {}) {
+        let response;
+        if (!!marker || marker === undefined) {
+            do {
+                response = await this.findBlobsByTagsSegment(tagFilterSqlExpression, marker, options);
+                response.blobs = response.blobs || [];
+                marker = response.continuationToken;
+                yield response;
+            } while (marker);
+        }
     }
     /**
      * Returns an AsyncIterableIterator for blobs.
@@ -320,26 +330,11 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      *                                         however, only a subset of the OData filter syntax is supported in the Blob service.
      * @param options - Options to findBlobsByTagsItems.
      */
-    findBlobsByTagsItems(tagFilterSqlExpression_1) {
-        return tslib_1.__asyncGenerator(this, arguments, function* findBlobsByTagsItems_1(tagFilterSqlExpression, options = {}) {
-            var _a, e_1, _b, _c;
-            let marker;
-            try {
-                for (var _d = true, _e = tslib_1.__asyncValues(this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const segment = _c;
-                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(segment.blobs)));
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (!_d && !_a && (_b = _e.return)) yield tslib_1.__await(_b.call(_e));
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-        });
+    async *findBlobsByTagsItems(tagFilterSqlExpression, options = {}) {
+        let marker;
+        for await (const segment of this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)) {
+            yield* segment.blobs;
+        }
     }
     /**
      * Returns an async iterable iterator to find all blobs with specified tag
@@ -347,7 +342,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      *
      * .byPage() returns an async iterable iterator to list the blobs in pages.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
      *
      * ```ts snippet:BlobServiceClientFindBlobsByTags
      * import { BlobServiceClient } from "@azure/storage-blob";
@@ -418,7 +413,9 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      */
     findBlobsByTags(tagFilterSqlExpression, options = {}) {
         // AsyncIterableIterator to iterate over blobs
-        const listSegmentOptions = Object.assign({}, options);
+        const listSegmentOptions = {
+            ...options,
+        };
         const iter = this.findBlobsByTagsItems(tagFilterSqlExpression, listSegmentOptions);
         return {
             /**
@@ -437,7 +434,10 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
              * Return an AsyncIterableIterator that works a page at a time
              */
             byPage: (settings = {}) => {
-                return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
+                return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, {
+                    maxPageSize: settings.maxPageSize,
+                    ...listSegmentOptions,
+                });
             },
         };
     }
@@ -453,45 +453,28 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      *                        items. The marker value is opaque to the client.
      * @param options - Options to list containers operation.
      */
-    listSegments(marker_1) {
-        return tslib_1.__asyncGenerator(this, arguments, function* listSegments_1(marker, options = {}) {
-            let listContainersSegmentResponse;
-            if (!!marker || marker === undefined) {
-                do {
-                    listContainersSegmentResponse = yield tslib_1.__await(this.listContainersSegment(marker, options));
-                    listContainersSegmentResponse.containerItems =
-                        listContainersSegmentResponse.containerItems || [];
-                    marker = listContainersSegmentResponse.continuationToken;
-                    yield yield tslib_1.__await(yield tslib_1.__await(listContainersSegmentResponse));
-                } while (marker);
-            }
-        });
+    async *listSegments(marker, options = {}) {
+        let listContainersSegmentResponse;
+        if (!!marker || marker === undefined) {
+            do {
+                listContainersSegmentResponse = await this.listContainersSegment(marker, options);
+                listContainersSegmentResponse.containerItems =
+                    listContainersSegmentResponse.containerItems || [];
+                marker = listContainersSegmentResponse.continuationToken;
+                yield await listContainersSegmentResponse;
+            } while (marker);
+        }
     }
     /**
      * Returns an AsyncIterableIterator for Container Items
      *
      * @param options - Options to list containers operation.
      */
-    listItems() {
-        return tslib_1.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
-            var _a, e_2, _b, _c;
-            let marker;
-            try {
-                for (var _d = true, _e = tslib_1.__asyncValues(this.listSegments(marker, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const segment = _c;
-                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(segment.containerItems)));
-                }
-            }
-            catch (e_2_1) { e_2 = { error: e_2_1 }; }
-            finally {
-                try {
-                    if (!_d && !_a && (_b = _e.return)) yield tslib_1.__await(_b.call(_e));
-                }
-                finally { if (e_2) throw e_2.error; }
-            }
-        });
+    async *listItems(options = {}) {
+        let marker;
+        for await (const segment of this.listSegments(marker, options)) {
+            yield* segment.containerItems;
+        }
     }
     /**
      * Returns an async iterable iterator to list all the containers
@@ -578,7 +561,10 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
             include.push("system");
         }
         // AsyncIterableIterator to iterate over containers
-        const listSegmentOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include } : {}));
+        const listSegmentOptions = {
+            ...options,
+            ...(include.length > 0 ? { include } : {}),
+        };
         const iter = this.listItems(listSegmentOptions);
         return {
             /**
@@ -597,7 +583,10 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
              * Return an AsyncIterableIterator that works a page at a time
              */
             byPage: (settings = {}) => {
-                return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
+                return this.listSegments(settings.continuationToken, {
+                    maxPageSize: settings.maxPageSize,
+                    ...listSegmentOptions,
+                });
             },
         };
     }
@@ -607,7 +596,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      * Retrieves a user delegation key for the Blob service. This is only a valid operation when using
      * bearer token authentication.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
      *
      * @param startsOn -      The start time for the user delegation SAS. Must be within 7 days of the current time
      * @param expiresOn -     The end time for the user delegation SAS. Must be within 7 days of the current time
@@ -630,14 +619,22 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
                 signedVersion: response.signedVersion,
                 value: response.value,
             };
-            const res = Object.assign({ _response: response._response, requestId: response.requestId, clientRequestId: response.clientRequestId, version: response.version, date: response.date, errorCode: response.errorCode }, userDelegationKey);
+            const res = {
+                _response: response._response,
+                requestId: response.requestId,
+                clientRequestId: response.clientRequestId,
+                version: response.version,
+                date: response.date,
+                errorCode: response.errorCode,
+                ...userDelegationKey,
+            };
             return res;
         });
     }
     /**
      * Creates a BlobBatchClient object to conduct batch operations.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
+     * @see https://learn.microsoft.com/rest/api/storageservices/blob-batch
      *
      * @returns A new BlobBatchClient object for this service.
      */
@@ -650,7 +647,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      * Generates a Blob account Shared Access Signature (SAS) URI based on the client properties
      * and parameters passed in. The SAS is signed by the shared key credential of the client.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-account-sas
      *
      * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
      * @param permissions - Specifies the list of permissions to be associated with the SAS.
@@ -666,9 +663,13 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
             const now = new Date();
             expiresOn = new Date(now.getTime() + 3600 * 1000);
         }
-        const sas = (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParameters)(Object.assign({ permissions,
+        const sas = (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParameters)({
+            permissions,
             expiresOn,
-            resourceTypes, services: AccountSASServices_js_1.AccountSASServices.parse("b").toString() }, options), this.credential).toString();
+            resourceTypes,
+            services: AccountSASServices_js_1.AccountSASServices.parse("b").toString(),
+            ...options,
+        }, this.credential).toString();
         return (0, utils_common_js_1.appendToURLQuery)(this.url, sas);
     }
     /**
@@ -677,7 +678,7 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
      * Generates string to sign for a Blob account Shared Access Signature (SAS) URI based on
      * the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-account-sas
      *
      * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
      * @param permissions - Specifies the list of permissions to be associated with the SAS.
@@ -693,9 +694,13 @@ class BlobServiceClient extends StorageClient_js_1.StorageClient {
             const now = new Date();
             expiresOn = new Date(now.getTime() + 3600 * 1000);
         }
-        return (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParametersInternal)(Object.assign({ permissions,
+        return (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParametersInternal)({
+            permissions,
             expiresOn,
-            resourceTypes, services: AccountSASServices_js_1.AccountSASServices.parse("b").toString() }, options), this.credential).stringToSign;
+            resourceTypes,
+            services: AccountSASServices_js_1.AccountSASServices.parse("b").toString(),
+            ...options,
+        }, this.credential).stringToSign;
     }
 }
 exports.BlobServiceClient = BlobServiceClient;