@azure/storage-file-share 12.24.1-alpha.20240807.2 → 12.25.0-beta.1

package/dist-esm/storage-file-share/src/Clients.js

@@ -5,7 +5,7 @@ import { isTokenCredential } from "@azure/core-auth";
 import { isNode } from "@azure/core-util";
 import { isPipelineLike, newPipeline } from "./Pipeline";
 import { DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS, DEFAULT_HIGH_LEVEL_CONCURRENCY, FILE_MAX_SIZE_BYTES, FILE_RANGE_MAX_SIZE_BYTES, URLConstants, FileAttributesPreserve, FileAttributesNone, } from "./utils/constants";
-import { appendToURLPath, setURLParameter, truncatedISO8061Date, extractConnectionStringParts, getShareNameAndPathFromUrl, appendToURLQuery, httpAuthorizationToString, setURLPath, setURLQueries, EscapePath, ConvertInternalResponseOfListFiles, ConvertInternalResponseOfListHandles, assertResponse, removeEmptyString, } from "./utils/utils.common";
+import { appendToURLPath, setURLParameter, truncatedISO8061Date, extractConnectionStringParts, getShareNameAndPathFromUrl, appendToURLQuery, httpAuthorizationToString, setURLPath, setURLQueries, EscapePath, ConvertInternalResponseOfListFiles, ConvertInternalResponseOfListHandles, assertResponse, removeEmptyString, asSharePermission, } from "./utils/utils.common";
 import { Credential } from "../../storage-blob/src/credentials/Credential";
 import { StorageSharedKeyCredential } from "../../storage-blob/src/credentials/StorageSharedKeyCredential";
 import { AnonymousCredential } from "../../storage-blob/src/credentials/AnonymousCredential";
@@ -19,7 +19,7 @@ import { Batch } from "./utils/Batch";
 import { BufferScheduler } from "./utils/BufferScheduler";
 import { fsStat, fsCreateReadStream, readStreamToLocalFile, streamToBuffer, } from "./utils/utils.node";
 import { randomUUID } from "@azure/core-util";
-import { generateFileSASQueryParameters } from "./FileSASSignatureValues";
+import { generateFileSASQueryParameters, generateFileSASQueryParametersInternal, } from "./FileSASSignatureValues";
 /**
  * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
  */
@@ -105,7 +105,7 @@ export class ShareClient extends StorageClient {
      */
     async create(options = {}) {
         return tracingClient.withSpan("ShareClient-create", options, async (updatedOptions) => {
-            return assertResponse(await this.context.create(Object.assign(Object.assign({}, updatedOptions), { enabledProtocols: toShareProtocolsString(updatedOptions.protocols) })));
+            return assertResponse(await this.context.create(Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { enabledProtocols: toShareProtocolsString(updatedOptions.protocols) })));
         });
     }
     /**
@@ -271,7 +271,7 @@ export class ShareClient extends StorageClient {
     async getProperties(options = {}) {
         return tracingClient.withSpan("ShareClient-getProperties", options, async (updatedOptions) => {
             const res = assertResponse(await this.context.getProperties(updatedOptions));
-            return Object.assign(Object.assign({}, res), { protocols: toShareProtocols(res.enabledProtocols) });
+            return Object.assign(Object.assign(Object.assign({}, res), this.shareClientConfig), { protocols: toShareProtocols(res.enabledProtocols) });
         });
     }
     /**
@@ -284,7 +284,7 @@ export class ShareClient extends StorageClient {
      */
     async delete(options = {}) {
         return tracingClient.withSpan("ShareClient-delete", options, async (updatedOptions) => {
-            return assertResponse(await this.context.delete(Object.assign({}, updatedOptions)));
+            return assertResponse(await this.context.delete(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
     /**
@@ -322,7 +322,7 @@ export class ShareClient extends StorageClient {
      */
     async setMetadata(metadata, options = {}) {
         return tracingClient.withSpan("ShareClient-setMetadata", options, async (updatedOptions) => {
-            return assertResponse(await this.context.setMetadata(Object.assign(Object.assign({}, updatedOptions), { metadata })));
+            return assertResponse(await this.context.setMetadata(Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { metadata })));
         });
     }
     /**
@@ -339,7 +339,7 @@ export class ShareClient extends StorageClient {
      */
     async getAccessPolicy(options = {}) {
         return tracingClient.withSpan("ShareClient-getAccessPolicy", options, async (updatedOptions) => {
-            const response = assertResponse(await this.context.getAccessPolicy(Object.assign({}, updatedOptions)));
+            const response = assertResponse(await this.context.getAccessPolicy(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
             const res = {
                 _response: response._response,
                 date: response.date,
@@ -405,7 +405,7 @@ export class ShareClient extends StorageClient {
                     id: identifier.id,
                 });
             }
-            return assertResponse(await this.context.setAccessPolicy(Object.assign(Object.assign({}, updatedOptions), { shareAcl: acl })));
+            return assertResponse(await this.context.setAccessPolicy(Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { shareAcl: acl })));
         });
     }
     /**
@@ -416,7 +416,7 @@ export class ShareClient extends StorageClient {
      */
     async createSnapshot(options = {}) {
         return tracingClient.withSpan("ShareClient-createSnapshot", options, async (updatedOptions) => {
-            return assertResponse(await this.context.createSnapshot(updatedOptions));
+            return assertResponse(await this.context.createSnapshot(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
     /**
@@ -430,7 +430,7 @@ export class ShareClient extends StorageClient {
      */
     async setQuota(quotaInGB, options = {}) {
         return tracingClient.withSpan("ShareClient-setQuota", options, async (updatedOptions) => {
-            return assertResponse(await this.context.setProperties(Object.assign(Object.assign({}, updatedOptions), { quota: quotaInGB })));
+            return assertResponse(await this.context.setProperties(Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { quota: quotaInGB })));
         });
     }
     /**
@@ -441,7 +441,7 @@ export class ShareClient extends StorageClient {
      */
     async setProperties(options = {}) {
         return tracingClient.withSpan("ShareClient-setProperties", options, async (updatedOptions) => {
-            return assertResponse(await this.context.setProperties(Object.assign(Object.assign({}, options), { quota: options.quotaInGB, tracingOptions: updatedOptions.tracingOptions })));
+            return assertResponse(await this.context.setProperties(Object.assign(Object.assign(Object.assign({}, options), this.shareClientConfig), { quota: options.quotaInGB, tracingOptions: updatedOptions.tracingOptions })));
         });
     }
     /**
@@ -452,7 +452,7 @@ export class ShareClient extends StorageClient {
      */
     async getStatistics(options = {}) {
         return tracingClient.withSpan("ShareClient-getStatistics", options, async (updatedOptions) => {
-            const response = assertResponse(await this.context.getStatistics(updatedOptions));
+            const response = assertResponse(await this.context.getStatistics(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
             const GBBytes = 1024 * 1024 * 1024;
             return Object.assign(Object.assign({}, response), { shareUsage: Math.ceil(response.shareUsageBytes / GBBytes) });
         });
@@ -467,9 +467,7 @@ export class ShareClient extends StorageClient {
      */
     async createPermission(filePermission, options = {}) {
         return tracingClient.withSpan("ShareClient-createPermission", options, async (updatedOptions) => {
-            return assertResponse(await this.context.createPermission({
-                permission: filePermission,
-            }, Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
+            return assertResponse(await this.context.createPermission(asSharePermission(filePermission), Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
     /**
@@ -485,6 +483,15 @@ export class ShareClient extends StorageClient {
             return assertResponse(await this.context.getPermission(filePermissionKey, Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
+    /**
+     * Get a {@link ShareLeaseClient} that manages leases on the file.
+     *
+     * @param proposeLeaseId - Initial proposed lease Id.
+     * @returns A new ShareLeaseClient object for managing leases on the file.
+     */
+    getShareLeaseClient(proposeLeaseId) {
+        return new ShareLeaseClient(this, proposeLeaseId);
+    }
     /**
      * Only available for ShareClient constructed with a shared key credential.
      *
@@ -503,6 +510,24 @@ export class ShareClient extends StorageClient {
         const sas = generateFileSASQueryParameters(Object.assign({ shareName: this.name }, options), this.credential).toString();
         return appendToURLQuery(this.url, sas);
     }
+    /**
+     * Only available for ShareClient constructed with a shared key credential.
+     *
+     * 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://docs.microsoft.com/en-us/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.
+     */
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+    generateSasStringToSign(options) {
+        if (!(this.credential instanceof StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+        }
+        return generateFileSASQueryParametersInternal(Object.assign({ shareName: this.name }, options), this.credential).stringToSign;
+    }
 }
 /**
  * A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
@@ -2349,6 +2374,24 @@ export class ShareFileClient extends StorageClient {
         const sas = generateFileSASQueryParameters(Object.assign({ shareName: this.shareName, filePath: this.path }, options), this.credential).toString();
         return appendToURLQuery(this.url, sas);
     }
+    /**
+     * Only available for clients constructed with a shared key credential.
+     *
+     * 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://docs.microsoft.com/en-us/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.
+     */
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+    generateSasStringToSign(options) {
+        if (!(this.credential instanceof StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+        }
+        return generateFileSASQueryParametersInternal(Object.assign({ shareName: this.shareName, filePath: this.path }, options), this.credential).stringToSign;
+    }
     /**
      * Renames a file.
      * This API only supports renaming a file in the same share.
@@ -2437,9 +2480,11 @@ export class ShareLeaseClient {
         const clientContext = client["storageClientContext"];
         if (client instanceof ShareClient) {
             this.fileOrShare = clientContext.share;
+            this.shareClientConfig = client["shareClientConfig"];
         }
         else {
             this.fileOrShare = clientContext.file;
+            this.shareClientConfig = client["shareClientConfig"];
         }
         this._url = client.url;
         if (!leaseId) {
@@ -2456,7 +2501,7 @@ export class ShareLeaseClient {
      */
     async acquireLease(duration = -1, options = {}) {
         return tracingClient.withSpan("ShareLeaseClient-acquireLease", options, async (updatedOptions) => {
-            return assertResponse(await this.fileOrShare.acquireLease(Object.assign(Object.assign({}, updatedOptions), { duration, proposedLeaseId: this._leaseId })));
+            return assertResponse(await this.fileOrShare.acquireLease(Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { duration, proposedLeaseId: this._leaseId })));
         });
     }
     /**
@@ -2468,7 +2513,7 @@ export class ShareLeaseClient {
      */
     async changeLease(proposedLeaseId, options = {}) {
         return tracingClient.withSpan("ShareLeaseClient-changeLease", options, async (updatedOptions) => {
-            const response = assertResponse(await this.fileOrShare.changeLease(this._leaseId, Object.assign(Object.assign({}, updatedOptions), { proposedLeaseId })));
+            const response = assertResponse(await this.fileOrShare.changeLease(this._leaseId, Object.assign(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig), { proposedLeaseId })));
             this._leaseId = proposedLeaseId;
             return response;
         });
@@ -2482,7 +2527,7 @@ export class ShareLeaseClient {
      */
     async releaseLease(options = {}) {
         return tracingClient.withSpan("ShareLeaseClient-releaseLease", options, async (updatedOptions) => {
-            return assertResponse(await this.fileOrShare.releaseLease(this._leaseId, updatedOptions));
+            return assertResponse(await this.fileOrShare.releaseLease(this._leaseId, Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
     /**
@@ -2493,7 +2538,7 @@ export class ShareLeaseClient {
      */
     async breakLease(options = {}) {
         return tracingClient.withSpan("ShareLeaseClient-breakLease", options, async (updatedOptions) => {
-            return assertResponse(await this.fileOrShare.breakLease(updatedOptions));
+            return assertResponse(await this.fileOrShare.breakLease(Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
     /**
@@ -2509,7 +2554,7 @@ export class ShareLeaseClient {
             if (isFile(this.fileOrShare)) {
                 throw new RangeError("The renewLease operation is not available for lease on file.");
             }
-            return assertResponse(await this.fileOrShare.renewLease(this._leaseId, updatedOptions));
+            return assertResponse(await this.fileOrShare.renewLease(this._leaseId, Object.assign(Object.assign({}, updatedOptions), this.shareClientConfig)));
         });
     }
 }