@azure/storage-file-datalake 12.8.1-alpha.20220401.1 → 12.9.0-beta.1

package/CHANGELOG.md

@@ -1,14 +1,17 @@
 # Release History
 
-## 12.8.1 (Unreleased)
+## 12.9.0-beta.1 (2022-04-19)
 
 ### Features Added
 
-### Breaking Changes
+- Added support for service version 2021-06-08.
+- Added support for Customer Provided Key server-side encryption of files.
+- Added ability to retrieve path createdOn and expiresOn times with DataLakeFileSystemClient.listPaths().
 
 ### Bugs Fixed
 
-### Other Changes
+- Add missing browser mapping for `./dist-esm/storage-common/src/BufferScheduler.js`
+- Add `react-native` mapping to ESM entry point
 
 ## 12.8.0 (2022-03-11)
 

package/dist/index.js

@@ -123,8 +123,8 @@ class AnonymousCredential extends Credential {
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "12.8.1";
-const SERVICE_VERSION = "2021-04-10";
+const SDK_VERSION = "12.9.0-beta.1";
+const SERVICE_VERSION = "2021-06-08";
 const KB = 1024;
 const MB = KB * 1024;
 const DEFAULT_HIGH_LEVEL_CONCURRENCY = 5;
@@ -321,6 +321,7 @@ const ToDfsEndpointHostMappings = [
 ];
 const ETagAny = "*";
 const DeletionIdKey = "deletionid";
+const EncryptionAlgorithmAES25 = "AES256";
 const PathResultTypeConstants = {
     FileResourceType: "file",
     DirectoryResourceType: "directory",
@@ -737,6 +738,31 @@ function isIpEndpointStyle(parsedUrl) {
     // For valid host please refer to https://man7.org/linux/man-pages/man7/hostname.7.html.
     return /^.*:.*:.*$|^localhost(:[0-9]+)?$|^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])){3}(:[0-9]+)?$/.test(host);
 }
+/**
+ * This is to convert a Windows File Time ticks to a Date object.
+ */
+function windowsFileTimeTicksToTime(timeNumber) {
+    if (!timeNumber)
+        return undefined;
+    const timeNumberInternal = parseInt(timeNumber);
+    if (timeNumberInternal === 0)
+        return undefined;
+    // A windows file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed
+    // since 12:00 A.M. January 1, 1601 Coordinated Universal Time (UTC).
+    // Date accepts a value that represents miliseconds from 12:00 A.M. January 1, 1970
+    // Here should correct the year number after converting.
+    const date = new Date(timeNumberInternal / 10000);
+    date.setUTCFullYear(date.getUTCFullYear() - 369);
+    return date;
+}
+function ensureCpkIfSpecified(cpk, isHttps) {
+    if (cpk && !isHttps) {
+        throw new RangeError("Customer-provided encryption key must be used over HTTPS.");
+    }
+    if (cpk && !cpk.encryptionAlgorithm) {
+        cpk.encryptionAlgorithm = EncryptionAlgorithmAES25;
+    }
+}
 
 /**
  * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.
@@ -1226,6 +1252,27 @@ const Path$1 = {
                 type: {
                     name: "String"
                 }
+            },
+            encryptionScope: {
+                serializedName: "EncryptionScope",
+                xmlName: "EncryptionScope",
+                type: {
+                    name: "String"
+                }
+            },
+            creationTime: {
+                serializedName: "creationTime",
+                xmlName: "creationTime",
+                type: {
+                    name: "String"
+                }
+            },
+            expiryTime: {
+                serializedName: "expiryTime",
+                xmlName: "expiryTime",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -2233,6 +2280,20 @@ const PathCreateHeaders = {
                     name: "Number"
                 }
             },
+            isServerEncrypted: {
+                serializedName: "x-ms-request-server-encrypted",
+                xmlName: "x-ms-request-server-encrypted",
+                type: {
+                    name: "Boolean"
+                }
+            },
+            encryptionKeySha256: {
+                serializedName: "x-ms-encryption-key-sha256",
+                xmlName: "x-ms-encryption-key-sha256",
+                type: {
+                    name: "String"
+                }
+            },
             errorCode: {
                 serializedName: "x-ms-error-code",
                 xmlName: "x-ms-error-code",
@@ -2620,6 +2681,20 @@ const PathReadHeaders = {
                 type: {
                     name: "String"
                 }
+            },
+            isServerEncrypted: {
+                serializedName: "x-ms-request-server-encrypted",
+                xmlName: "x-ms-request-server-encrypted",
+                type: {
+                    name: "Boolean"
+                }
+            },
+            encryptionKeySha256: {
+                serializedName: "x-ms-encryption-key-sha256",
+                xmlName: "x-ms-encryption-key-sha256",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -3118,6 +3193,20 @@ const PathFlushDataHeaders = {
                 type: {
                     name: "String"
                 }
+            },
+            isServerEncrypted: {
+                serializedName: "x-ms-request-server-encrypted",
+                xmlName: "x-ms-request-server-encrypted",
+                type: {
+                    name: "Boolean"
+                }
+            },
+            encryptionKeySha256: {
+                serializedName: "x-ms-encryption-key-sha256",
+                xmlName: "x-ms-encryption-key-sha256",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -3213,6 +3302,13 @@ const PathAppendDataHeaders = {
                 type: {
                     name: "Boolean"
                 }
+            },
+            encryptionKeySha256: {
+                serializedName: "x-ms-encryption-key-sha256",
+                xmlName: "x-ms-encryption-key-sha256",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -3526,7 +3622,7 @@ const timeout = {
 const version = {
     parameterPath: "version",
     mapper: {
-        defaultValue: "2021-04-10",
+        defaultValue: "2021-06-08",
         isConstant: true,
         serializedName: "x-ms-version",
         type: {
@@ -3890,6 +3986,36 @@ const sourceIfUnmodifiedSince = {
         }
     }
 };
+const encryptionKey = {
+    parameterPath: ["options", "cpkInfo", "encryptionKey"],
+    mapper: {
+        serializedName: "x-ms-encryption-key",
+        xmlName: "x-ms-encryption-key",
+        type: {
+            name: "String"
+        }
+    }
+};
+const encryptionKeySha256 = {
+    parameterPath: ["options", "cpkInfo", "encryptionKeySha256"],
+    mapper: {
+        serializedName: "x-ms-encryption-key-sha256",
+        xmlName: "x-ms-encryption-key-sha256",
+        type: {
+            name: "String"
+        }
+    }
+};
+const encryptionAlgorithm = {
+    parameterPath: ["options", "cpkInfo", "encryptionAlgorithm"],
+    mapper: {
+        serializedName: "x-ms-encryption-algorithm",
+        xmlName: "x-ms-encryption-algorithm",
+        type: {
+            name: "String"
+        }
+    }
+};
 const contentType1 = {
     parameterPath: ["options", "contentType"],
     mapper: {
@@ -4757,7 +4883,10 @@ const createOperationSpec = {
         sourceIfMatch,
         sourceIfNoneMatch,
         sourceIfModifiedSince,
-        sourceIfUnmodifiedSince
+        sourceIfUnmodifiedSince,
+        encryptionKey,
+        encryptionKeySha256,
+        encryptionAlgorithm
     ],
     serializer
 };
@@ -4886,6 +5015,9 @@ const readOperationSpec = {
         leaseId,
         ifMatch,
         ifNoneMatch,
+        encryptionKey,
+        encryptionKeySha256,
+        encryptionAlgorithm,
         range,
         xMsRangeGetContentMd5
     ],
@@ -5041,6 +5173,9 @@ const flushDataOperationSpec = {
         leaseId,
         ifMatch,
         ifNoneMatch,
+        encryptionKey,
+        encryptionKeySha256,
+        encryptionAlgorithm,
         contentLength,
         contentMD5
     ],
@@ -5069,6 +5204,9 @@ const appendDataOperationSpec = {
         requestId,
         version,
         leaseId,
+        encryptionKey,
+        encryptionKeySha256,
+        encryptionAlgorithm,
         accept2,
         contentLength,
         contentType2,
@@ -5585,7 +5723,7 @@ function attachCredential(thing, credential) {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 const packageName = "azure-storage-datalake";
-const packageVersion = "12.8.1";
+const packageVersion = "12.9.0-beta.1";
 class StorageClientContext extends coreHttp__namespace.ServiceClient {
     /**
      * Initializes a new instance of the StorageClientContext class.
@@ -5611,7 +5749,7 @@ class StorageClientContext extends coreHttp__namespace.ServiceClient {
         // Parameter assignments
         this.url = url;
         // Assigning values to Constant parameters
-        this.version = options.version || "2021-04-10";
+        this.version = options.version || "2021-06-08";
         this.resource = options.resource || "filesystem";
     }
 }
@@ -5891,6 +6029,15 @@ function toAccessControlChangeFailureArray(aclFailedEntries = []) {
         };
     });
 }
+function toBlobCpkInfo(input) {
+    return input
+        ? {
+            encryptionKey: input.encryptionKey,
+            encryptionKeySha256: input.encryptionKeySha256,
+            encryptionAlgorithm: "AES256",
+        }
+        : undefined;
+}
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -7937,7 +8084,8 @@ class DataLakePathClient extends StorageClient {
         options.conditions = options.conditions || {};
         const { span, updatedOptions } = createSpan("DataLakePathClient-create", options);
         try {
-            return await this.pathContext.create(Object.assign(Object.assign(Object.assign({}, options), { resource: resourceType, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions, properties: toProperties(options.metadata) }), convertTracingToRequestOptionsBase(updatedOptions)));
+            ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+            return await this.pathContext.create(Object.assign(Object.assign(Object.assign({}, options), { resource: resourceType, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions, properties: toProperties(options.metadata), cpkInfo: options.customerProvidedKey }), convertTracingToRequestOptionsBase(updatedOptions)));
         }
         catch (e) {
             span.setStatus({
@@ -7996,7 +8144,7 @@ class DataLakePathClient extends StorageClient {
     async exists(options = {}) {
         const { span, updatedOptions } = createSpan("DataLakeFileClient-exists", options);
         try {
-            return await this.blobClient.exists(updatedOptions);
+            return await this.blobClient.exists(Object.assign(Object.assign({}, updatedOptions), { customerProvidedKey: toBlobCpkInfo(updatedOptions.customerProvidedKey) }));
         }
         catch (e) {
             span.setStatus({
@@ -8239,7 +8387,7 @@ class DataLakePathClient extends StorageClient {
     async getProperties(options = {}) {
         const { span, updatedOptions } = createSpan("DataLakePathClient-getProperties", options);
         try {
-            return await this.blobClient.getProperties(Object.assign(Object.assign({}, options), { customerProvidedKey: undefined, tracingOptions: updatedOptions.tracingOptions }));
+            return await this.blobClient.getProperties(Object.assign(Object.assign({}, options), { customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey), tracingOptions: updatedOptions.tracingOptions }));
         }
         catch (e) {
             span.setStatus({
@@ -8300,7 +8448,7 @@ class DataLakePathClient extends StorageClient {
     async setMetadata(metadata, options = {}) {
         const { span, updatedOptions } = createSpan("DataLakePathClient-setMetadata", options);
         try {
-            return await this.blobClient.setMetadata(metadata, Object.assign(Object.assign({}, options), { customerProvidedKey: undefined, tracingOptions: updatedOptions.tracingOptions }));
+            return await this.blobClient.setMetadata(metadata, Object.assign(Object.assign({}, options), { customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey), tracingOptions: updatedOptions.tracingOptions }));
         }
         catch (e) {
             span.setStatus({
@@ -8582,7 +8730,7 @@ class DataLakeFileClient extends DataLakePathClient {
     async read(offset = 0, count, options = {}) {
         const { span, updatedOptions } = createSpan("DataLakeFileClient-read", options);
         try {
-            const rawResponse = await this.blockBlobClientInternal.download(offset, count, updatedOptions);
+            const rawResponse = await this.blockBlobClientInternal.download(offset, count, Object.assign(Object.assign({}, updatedOptions), { customerProvidedKey: toBlobCpkInfo(updatedOptions.customerProvidedKey) }));
             const response = rawResponse;
             if (!coreHttp.isNode && !response.contentAsBlob) {
                 response.contentAsBlob = rawResponse.blobBody;
@@ -8620,11 +8768,12 @@ class DataLakeFileClient extends DataLakePathClient {
         options.conditions = options.conditions || {};
         const { span, updatedOptions } = createSpan("DataLakeFileClient-append", options);
         try {
+            ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
             return await this.pathContextInternal.appendData(body, Object.assign({ pathHttpHeaders: {
                     contentMD5: options.transactionalContentMD5,
                 }, abortSignal: options.abortSignal, position: offset, contentLength: length, leaseAccessConditions: options.conditions, requestOptions: {
                     onUploadProgress: options.onProgress,
-                } }, convertTracingToRequestOptionsBase(updatedOptions)));
+                }, cpkInfo: options.customerProvidedKey }, convertTracingToRequestOptionsBase(updatedOptions)));
         }
         catch (e) {
             span.setStatus({
@@ -8653,7 +8802,8 @@ class DataLakeFileClient extends DataLakePathClient {
         options.conditions = options.conditions || {};
         const { span, updatedOptions } = createSpan("DataLakeFileClient-flush", options);
         try {
-            return await this.pathContextInternal.flushData(Object.assign(Object.assign(Object.assign({}, options), { position, contentLength: 0, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions }), convertTracingToRequestOptionsBase(updatedOptions)));
+            ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+            return await this.pathContextInternal.flushData(Object.assign(Object.assign(Object.assign({}, options), { position, contentLength: 0, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions, cpkInfo: options.customerProvidedKey }), convertTracingToRequestOptionsBase(updatedOptions)));
         }
         catch (e) {
             span.setStatus({
@@ -8755,6 +8905,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 umask: options.umask,
                 conditions: options.conditions,
                 pathHttpHeaders: options.pathHttpHeaders,
+                customerProvidedKey: updatedOptions.customerProvidedKey,
                 tracingOptions: updatedOptions.tracingOptions,
             });
             // append() with empty data would return error, so do not continue
@@ -8793,6 +8944,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 await this.append(bodyFactory(0, size), 0, size, {
                     abortSignal: options.abortSignal,
                     conditions: options.conditions,
+                    customerProvidedKey: updatedOptions.customerProvidedKey,
                     onProgress: options.onProgress,
                     tracingOptions: updatedOptions.tracingOptions,
                 });
@@ -8801,6 +8953,7 @@ class DataLakeFileClient extends DataLakePathClient {
                     conditions: options.conditions,
                     close: options.close,
                     pathHttpHeaders: options.pathHttpHeaders,
+                    customerProvidedKey: updatedOptions.customerProvidedKey,
                     tracingOptions: updatedOptions.tracingOptions,
                 });
             }
@@ -8819,6 +8972,7 @@ class DataLakeFileClient extends DataLakePathClient {
                     await this.append(bodyFactory(start, contentLength), start, contentLength, {
                         abortSignal: options.abortSignal,
                         conditions: options.conditions,
+                        customerProvidedKey: updatedOptions.customerProvidedKey,
                         tracingOptions: updatedOptions.tracingOptions,
                     });
                     transferProgress += contentLength;
@@ -8833,6 +8987,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 conditions: options.conditions,
                 close: options.close,
                 pathHttpHeaders: options.pathHttpHeaders,
+                customerProvidedKey: updatedOptions.customerProvidedKey,
                 tracingOptions: updatedOptions.tracingOptions,
             });
         }
@@ -8874,6 +9029,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 umask: options.umask,
                 conditions: options.conditions,
                 pathHttpHeaders: options.pathHttpHeaders,
+                customerProvidedKey: options.customerProvidedKey,
                 tracingOptions: updatedOptions.tracingOptions,
             });
             // After the File is Create, Lease ID is the only valid request parameter.
@@ -8895,6 +9051,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 await this.append(body, offset, length, {
                     abortSignal: options.abortSignal,
                     conditions: options.conditions,
+                    customerProvidedKey: options.customerProvidedKey,
                     tracingOptions: updatedOptions.tracingOptions,
                 });
                 // Update progress after block is successfully uploaded to server, in case of block trying
@@ -8914,6 +9071,7 @@ class DataLakeFileClient extends DataLakePathClient {
                 conditions: options.conditions,
                 close: options.close,
                 pathHttpHeaders: options.pathHttpHeaders,
+                customerProvidedKey: options.customerProvidedKey,
                 tracingOptions: updatedOptions.tracingOptions,
             });
         }
@@ -8946,10 +9104,10 @@ class DataLakeFileClient extends DataLakePathClient {
         const { span, updatedOptions } = createSpan("DataLakeFileClient-readToBuffer", options);
         try {
             if (buffer) {
-                return await this.blockBlobClientInternal.downloadToBuffer(buffer, offset, count, Object.assign(Object.assign({}, options), { maxRetryRequestsPerBlock: options.maxRetryRequestsPerChunk, blockSize: options.chunkSize, tracingOptions: updatedOptions.tracingOptions }));
+                return await this.blockBlobClientInternal.downloadToBuffer(buffer, offset, count, Object.assign(Object.assign({}, options), { maxRetryRequestsPerBlock: options.maxRetryRequestsPerChunk, blockSize: options.chunkSize, customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey), tracingOptions: updatedOptions.tracingOptions }));
             }
             else {
-                return await this.blockBlobClientInternal.downloadToBuffer(offset, count, Object.assign(Object.assign({}, options), { maxRetryRequestsPerBlock: options.maxRetryRequestsPerChunk, blockSize: options.chunkSize, tracingOptions: updatedOptions.tracingOptions }));
+                return await this.blockBlobClientInternal.downloadToBuffer(offset, count, Object.assign(Object.assign({}, options), { maxRetryRequestsPerBlock: options.maxRetryRequestsPerChunk, blockSize: options.chunkSize, customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey), tracingOptions: updatedOptions.tracingOptions }));
             }
         }
         catch (e) {
@@ -8982,7 +9140,7 @@ class DataLakeFileClient extends DataLakePathClient {
     async readToFile(filePath, offset = 0, count, options = {}) {
         const { span, updatedOptions } = createSpan("DataLakeFileClient-readToFile", options);
         try {
-            return await this.blockBlobClientInternal.downloadToFile(filePath, offset, count, updatedOptions);
+            return await this.blockBlobClientInternal.downloadToFile(filePath, offset, count, Object.assign(Object.assign({}, updatedOptions), { customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey) }));
         }
         catch (e) {
             span.setStatus({
@@ -9026,7 +9184,7 @@ class DataLakeFileClient extends DataLakePathClient {
     async query(query, options = {}) {
         const { span, updatedOptions } = createSpan("DataLakeFileClient-query", options);
         try {
-            const rawResponse = await this.blockBlobClientInternal.query(query, updatedOptions);
+            const rawResponse = await this.blockBlobClientInternal.query(query, Object.assign(Object.assign({}, updatedOptions), { customerProvidedKey: toBlobCpkInfo(options.customerProvidedKey) }));
             const response = rawResponse;
             if (!coreHttp.isNode && !response.contentAsBlob) {
                 response.contentAsBlob = rawResponse.blobBody;
@@ -9567,7 +9725,7 @@ class DataLakeFileSystemClient extends StorageClient {
             const response = rawResponse;
             response.pathItems = [];
             for (const path of rawResponse.paths || []) {
-                response.pathItems.push(Object.assign(Object.assign({}, path), { permissions: toPermissions(path.permissions) }));
+                response.pathItems.push(Object.assign(Object.assign({}, path), { permissions: toPermissions(path.permissions), createdOn: windowsFileTimeTicksToTime(path.creationTime), expiresOn: windowsFileTimeTicksToTime(path.expiryTime) }));
             }
             delete rawResponse.paths;
             return response;