@azure/storage-file-datalake 12.27.0-beta.1 → 12.27.0

package/dist/commonjs/DataLakeFileSystemClient.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataLakeFileSystemClient = void 0;
-const tslib_1 = require("tslib");
 const storage_blob_1 = require("@azure/storage-blob");
 const Pipeline_js_1 = require("./Pipeline.js");
 const StorageSharedKeyCredential_js_1 = require("./credentials/StorageSharedKeyCredential.js");
@@ -21,6 +20,18 @@ const PathClientInternal_js_1 = require("./utils/PathClientInternal.js");
  * allowing you to manipulate its directories and files.
  */
 class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
+    /**
+     * fileSystemContext provided by protocol layer.
+     */
+    fileSystemContext;
+    /**
+     * fileSystemContext provided by protocol layer.
+     */
+    fileSystemContextToBlobEndpoint;
+    /**
+     * blobContainerClient provided by `@azure/storage-blob` package.
+     */
+    blobContainerClient;
     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 */
@@ -83,26 +94,36 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * Creates a new file system under the specified account. If the file system with
      * the same name already exists, the operation fails.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-container
      *
      * @param options - Optional. Options when creating file system.
      */
     async create(options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-create", options, async (updatedOptions) => {
-            return this.blobContainerClient.create(Object.assign(Object.assign({}, options), { access: (0, transforms_js_1.toContainerPublicAccessType)(options.access), tracingOptions: updatedOptions.tracingOptions, containerEncryptionScope: options.fileSystemEncryptionScope }));
+            return this.blobContainerClient.create({
+                ...options,
+                access: (0, transforms_js_1.toContainerPublicAccessType)(options.access),
+                tracingOptions: updatedOptions.tracingOptions,
+                containerEncryptionScope: options.fileSystemEncryptionScope,
+            });
         });
     }
     /**
      * Creates a new file system under the specified account. If the file system with
      * the same name already exists, it is not changed.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-container
      *
      * @param options -
      */
     async createIfNotExists(options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-createIfNotExists", options, async (updatedOptions) => {
-            return this.blobContainerClient.createIfNotExists(Object.assign(Object.assign({}, options), { access: (0, transforms_js_1.toContainerPublicAccessType)(options.access), containerEncryptionScope: options.fileSystemEncryptionScope, tracingOptions: updatedOptions.tracingOptions }));
+            return this.blobContainerClient.createIfNotExists({
+                ...options,
+                access: (0, transforms_js_1.toContainerPublicAccessType)(options.access),
+                containerEncryptionScope: options.fileSystemEncryptionScope,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
         });
     }
     /**
@@ -122,19 +143,22 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
     /**
      * Delete current file system.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-container
      *
      * @param options - Optional. Options when deleting file system.
      */
     async delete(options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-delete", options, async (updatedOptions) => {
-            return this.blobContainerClient.delete(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            return this.blobContainerClient.delete({
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
         });
     }
     /**
      * Delete current file system if it exists.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-container
      *
      * @param options -
      */
@@ -152,13 +176,16 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * the `listFileSystems` method of {@link DataLakeServiceClient} using the `includeMetadata` option, which
      * will retain their original casing.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-container-properties
      *
      * @param options - Optional. Options when getting file system properties.
      */
     async getProperties(options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-getProperties", options, async (updatedOptions) => {
-            const rawResponse = await this.blobContainerClient.getProperties(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            const rawResponse = await this.blobContainerClient.getProperties({
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
             // Transfer and rename blobPublicAccess to publicAccess
             const response = rawResponse;
             response.publicAccess = (0, transforms_js_1.toPublicAccessType)(rawResponse.blobPublicAccess);
@@ -174,7 +201,7 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * If no option provided, or no metadata defined in the parameter, the file system
      * metadata will be removed.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-container-metadata
      *
      * @param metadata - Replace existing metadata with this value.
      *                              If no value provided the existing metadata will be removed.
@@ -182,7 +209,10 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      */
     async setMetadata(metadata, options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-setMetadata", options, async (updatedOptions) => {
-            return this.blobContainerClient.setMetadata(metadata, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            return this.blobContainerClient.setMetadata(metadata, {
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
         });
     }
     /**
@@ -192,13 +222,16 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
      * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-container-acl
      *
      * @param options - Optional. Options when getting file system access policy.
      */
     async getAccessPolicy(options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-getAccessPolicy", options, async (updatedOptions) => {
-            const rawResponse = await this.blobContainerClient.getAccessPolicy(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            const rawResponse = await this.blobContainerClient.getAccessPolicy({
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
             // Transfer and rename blobPublicAccess to publicAccess
             const response = rawResponse;
             response.publicAccess = (0, transforms_js_1.toPublicAccessType)(rawResponse.blobPublicAccess);
@@ -216,7 +249,7 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * If no access or containerAcl provided, the existing file system ACL will be
      * removed.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-container-acl
      *
      * @param access - Optional. The level of public access to data in the file system.
      * @param fileSystemAcl - Optional. Array of elements each having a unique Id and details of the access policy.
@@ -224,7 +257,10 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      */
     async setAccessPolicy(access, fileSystemAcl, options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-setAccessPolicy", options, async (updatedOptions) => {
-            return this.blobContainerClient.setAccessPolicy((0, transforms_js_1.toContainerPublicAccessType)(access), fileSystemAcl, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            return this.blobContainerClient.setAccessPolicy((0, transforms_js_1.toContainerPublicAccessType)(access), fileSystemAcl, {
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            });
         });
     }
     /**
@@ -356,49 +392,44 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
                 return this;
             },
             byPage: (settings = {}) => {
-                return this.listSegments(settings.continuationToken, Object.assign({ maxResults: settings.maxPageSize }, options));
+                return this.listSegments(settings.continuationToken, {
+                    maxResults: settings.maxPageSize,
+                    ...options,
+                });
             },
         };
     }
-    listItems() {
-        return tslib_1.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
-            var _a, e_1, _b, _c;
-            try {
-                for (var _d = true, _e = tslib_1.__asyncValues(this.listSegments(undefined, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const response = _c;
-                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(response.pathItems || [])));
-                }
-            }
-            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 *listItems(options = {}) {
+        for await (const response of this.listSegments(undefined, options)) {
+            yield* response.pathItems || [];
+        }
     }
-    listSegments(continuation_1) {
-        return tslib_1.__asyncGenerator(this, arguments, function* listSegments_1(continuation, options = {}) {
-            let response;
-            if (!!continuation || continuation === undefined) {
-                do {
-                    response = yield tslib_1.__await(this.listPathsSegment(continuation, options));
-                    continuation = response.continuation;
-                    yield yield tslib_1.__await(response);
-                } while (continuation);
-            }
-        });
+    async *listSegments(continuation, options = {}) {
+        let response;
+        if (!!continuation || continuation === undefined) {
+            do {
+                response = await this.listPathsSegment(continuation, options);
+                continuation = response.continuation;
+                yield response;
+            } while (continuation);
+        }
     }
     async listPathsSegment(continuation, options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-listPathsSegment", options, async (updatedOptions) => {
-            const rawResponse = await this.fileSystemContext.listPaths(options.recursive || false, Object.assign(Object.assign({ continuation }, updatedOptions), { upn: options.userPrincipalName }));
+            const rawResponse = await this.fileSystemContext.listPaths(options.recursive || false, {
+                continuation,
+                ...updatedOptions,
+                upn: options.userPrincipalName,
+            });
             const response = rawResponse;
             response.pathItems = [];
             for (const path of rawResponse.paths || []) {
-                response.pathItems.push(Object.assign(Object.assign({}, path), { permissions: (0, transforms_js_1.toPermissions)(path.permissions), createdOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.creationTime), expiresOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.expiryTime) }));
+                response.pathItems.push({
+                    ...path,
+                    permissions: (0, transforms_js_1.toPermissions)(path.permissions),
+                    createdOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.creationTime),
+                    expiresOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.expiryTime),
+                });
             }
             delete rawResponse.paths;
             return response;
@@ -534,45 +565,35 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
                 return this;
             },
             byPage: (settings = {}) => {
-                return this.listDeletedSegments(settings.continuationToken, Object.assign({ maxResults: settings.maxPageSize }, options));
+                return this.listDeletedSegments(settings.continuationToken, {
+                    maxResults: settings.maxPageSize,
+                    ...options,
+                });
             },
         };
     }
-    listDeletedItems() {
-        return tslib_1.__asyncGenerator(this, arguments, function* listDeletedItems_1(options = {}) {
-            var _a, e_2, _b, _c;
-            try {
-                for (var _d = true, _e = tslib_1.__asyncValues(this.listDeletedSegments(undefined, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const response = _c;
-                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(response.pathItems || [])));
-                }
-            }
-            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 *listDeletedItems(options = {}) {
+        for await (const response of this.listDeletedSegments(undefined, options)) {
+            yield* response.pathItems || [];
+        }
     }
-    listDeletedSegments(continuation_1) {
-        return tslib_1.__asyncGenerator(this, arguments, function* listDeletedSegments_1(continuation, options = {}) {
-            let response;
-            if (!!continuation || continuation === undefined) {
-                do {
-                    response = yield tslib_1.__await(this.listDeletedPathsSegment(continuation, options));
-                    continuation = response.continuation;
-                    yield yield tslib_1.__await(response);
-                } while (continuation);
-            }
-        });
+    async *listDeletedSegments(continuation, options = {}) {
+        let response;
+        if (!!continuation || continuation === undefined) {
+            do {
+                response = await this.listDeletedPathsSegment(continuation, options);
+                continuation = response.continuation;
+                yield response;
+            } while (continuation);
+        }
     }
     async listDeletedPathsSegment(continuation, options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-listDeletedPathsSegment", options, async (updatedOptions) => {
-            const rawResponse = await this.fileSystemContextToBlobEndpoint.listBlobHierarchySegment(Object.assign(Object.assign({ marker: continuation }, updatedOptions), { prefix: options.prefix === "" ? undefined : options.prefix }));
+            const rawResponse = await this.fileSystemContextToBlobEndpoint.listBlobHierarchySegment({
+                marker: continuation,
+                ...updatedOptions,
+                prefix: options.prefix === "" ? undefined : options.prefix,
+            });
             const response = rawResponse;
             response.pathItems = [];
             for (const path of rawResponse.segment.blobItems || []) {
@@ -592,7 +613,7 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
     /**
      * Restores a soft deleted path.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/undelete-blob
      *
      * @param deletedPath - Required.  The path of the deleted path.
      *
@@ -602,12 +623,22 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
     async undeletePath(deletedPath, deletionId, options = {}) {
         return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-undeletePath", options, async (updatedOptions) => {
             const pathClient = new PathClientInternal_js_1.PathClientInternal((0, utils_common_js_1.appendToURLPath)(this.blobEndpointUrl, (0, utils_common_js_1.EscapePath)(deletedPath)), this.pipeline);
-            const rawResponse = (0, utils_common_js_1.assertResponse)(await pathClient.blobPathContext.undelete(Object.assign(Object.assign({ undeleteSource: "?" + constants_js_1.DeletionIdKey + "=" + deletionId }, options), { tracingOptions: updatedOptions.tracingOptions })));
+            const rawResponse = (0, utils_common_js_1.assertResponse)(await pathClient.blobPathContext.undelete({
+                undeleteSource: "?" + constants_js_1.DeletionIdKey + "=" + deletionId,
+                ...options,
+                tracingOptions: updatedOptions.tracingOptions,
+            }));
             if (rawResponse.resourceType === constants_js_1.PathResultTypeConstants.DirectoryResourceType) {
-                return Object.assign({ pathClient: this.getDirectoryClient(deletedPath) }, rawResponse);
+                return {
+                    pathClient: this.getDirectoryClient(deletedPath),
+                    ...rawResponse,
+                };
             }
             else {
-                return Object.assign({ pathClient: this.getFileClient(deletedPath) }, rawResponse);
+                return {
+                    pathClient: this.getFileClient(deletedPath),
+                    ...rawResponse,
+                };
             }
         });
     }
@@ -617,7 +648,7 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * Generates a Service 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/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -627,7 +658,10 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
             if (!(this.credential instanceof StorageSharedKeyCredential_js_1.StorageSharedKeyCredential)) {
                 throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
             }
-            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)(Object.assign({ fileSystemName: this.name }, options), this.credential).toString();
+            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)({
+                fileSystemName: this.name,
+                ...options,
+            }, this.credential).toString();
             resolve((0, utils_common_js_1.appendToURLQuery)(this.url, sas));
         });
     }
@@ -637,7 +671,7 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * Generates string to sign for a Service 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/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -647,13 +681,16 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
         if (!(this.credential instanceof StorageSharedKeyCredential_js_1.StorageSharedKeyCredential)) {
             throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
         }
-        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)(Object.assign({ fileSystemName: this.name }, options), this.credential).stringToSign;
+        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)({
+            fileSystemName: this.name,
+            ...options,
+        }, this.credential).stringToSign;
     }
     /**
      * Generates a Service Shared Access Signature (SAS) URI based on the client properties
      * and parameters passed in. The SAS is signed by the input user delegation key.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
@@ -661,7 +698,10 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      */
     generateUserDelegationSasUrl(options, userDelegationKey) {
         return new Promise((resolve) => {
-            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)(Object.assign({ fileSystemName: this.name }, options), userDelegationKey, this.accountName).toString();
+            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)({
+                fileSystemName: this.name,
+                ...options,
+            }, userDelegationKey, this.accountName).toString();
             resolve((0, utils_common_js_1.appendToURLQuery)(this.url, sas));
         });
     }
@@ -669,14 +709,17 @@ class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
      * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
      * and parameters passed in. The SAS is signed by the input user delegation key.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
      */
     generateUserDelegationSasStringToSign(options, userDelegationKey) {
-        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)(Object.assign({ fileSystemName: this.name }, options), userDelegationKey, this.accountName).stringToSign;
+        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)({
+            fileSystemName: this.name,
+            ...options,
+        }, userDelegationKey, this.accountName).stringToSign;
     }
 }
 exports.DataLakeFileSystemClient = DataLakeFileSystemClient;