@azure/storage-file-share 12.9.0-alpha.20220105.6 → 12.9.0-alpha.20220210.2

package/dist-esm/src/Clients.js

@@ -6,7 +6,7 @@ import { SpanStatusCode } from "@azure/core-tracing";
 import { Share, Directory, File } from "./generated/src/operations";
 import { newPipeline, Pipeline } from "./Pipeline";
 import { DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS, DEFAULT_HIGH_LEVEL_CONCURRENCY, FILE_MAX_SIZE_BYTES, FILE_RANGE_MAX_SIZE_BYTES, URLConstants, } from "./utils/constants";
-import { appendToURLPath, setURLParameter, truncatedISO8061Date, extractConnectionStringParts, getShareNameAndPathFromUrl, appendToURLQuery, httpAuthorizationToString, } from "./utils/utils.common";
+import { appendToURLPath, setURLParameter, truncatedISO8061Date, extractConnectionStringParts, getShareNameAndPathFromUrl, appendToURLQuery, httpAuthorizationToString, setURLPath, setURLQueries, } from "./utils/utils.common";
 import { Credential } from "./credentials/Credential";
 import { StorageSharedKeyCredential } from "./credentials/StorageSharedKeyCredential";
 import { AnonymousCredential } from "./credentials/AnonymousCredential";
@@ -1647,6 +1647,68 @@ export class ShareDirectoryClient extends StorageClient {
             span.end();
         }
     }
+    /**
+     * Renames a directory.
+     * This API only supports renaming a directory in the same share.
+     *
+     * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
+     * @param options - Options for the renaming operation.
+     * @returns Response data for the file renaming operation.
+     *
+     * Example usage:
+     *
+     * ```js
+     *
+     * // Rename the directory
+     * await diretoryClient.rename(destinationPath);
+     * console.log("Renamed directory successfully!");
+     * ```
+     */
+    async rename(destinationPath, options = {}) {
+        const { span, updatedOptions } = createSpan("ShareDirectoryClient-rename", options);
+        const split = destinationPath.split("?");
+        let destinationUrl;
+        if (split.length === 2) {
+            const pathOnly = encodeURIComponent(split[0]);
+            const renameDestination = `/${this.shareName}/${pathOnly}`;
+            destinationUrl = setURLPath(this.url, renameDestination);
+            destinationUrl = setURLQueries(destinationUrl, split[1]);
+        }
+        else if (split.length === 1) {
+            const pathOnly = encodeURIComponent(destinationPath);
+            const renameDestination = `/${this.shareName}/${pathOnly}`;
+            destinationUrl = setURLPath(this.url, renameDestination);
+        }
+        else {
+            throw new RangeError("Destination path should not contain more than one query string");
+        }
+        const destDirectory = new ShareDirectoryClient(destinationUrl, this.pipeline);
+        try {
+            const response = await destDirectory.context.rename(this.url, Object.assign(Object.assign({}, updatedOptions), { sourceLeaseAccessConditions: updatedOptions.sourceLeaseAccessConditions
+                    ? {
+                        sourceLeaseId: updatedOptions.sourceLeaseAccessConditions.leaseId,
+                    }
+                    : undefined, destinationLeaseAccessConditions: updatedOptions.destinationLeaseAccessConditions
+                    ? {
+                        destinationLeaseId: updatedOptions.destinationLeaseAccessConditions.leaseId,
+                    }
+                    : undefined }));
+            return {
+                destinationDirectoryClient: destDirectory,
+                directoryRenameResponse: response,
+            };
+        }
+        catch (e) {
+            span.setStatus({
+                code: SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
 }
 /**
  * A ShareFileClient represents a URL to an Azure Storage file.
@@ -2993,6 +3055,68 @@ 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);
     }
+    /**
+     * Renames a file.
+     * This API only supports renaming a file in the same share.
+     *
+     * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
+     * @param options - Options for the renaming operation.
+     * @returns Response data for the file renaming operation.
+     *
+     * Example usage:
+     *
+     * ```js
+     *
+     * // Rename the file
+     * await fileClient.rename(destinationPath);
+     * console.log("Renamed file successfully!");
+     * ```
+     */
+    async rename(destinationPath, options = {}) {
+        const { span, updatedOptions } = createSpan("ShareFileClient-rename", options);
+        const split = destinationPath.split("?");
+        let destinationUrl;
+        if (split.length === 2) {
+            const pathOnly = encodeURIComponent(split[0]);
+            const renameDestination = `/${this.shareName}/${pathOnly}`;
+            destinationUrl = setURLPath(this.url, renameDestination);
+            destinationUrl = setURLQueries(destinationUrl, split[1]);
+        }
+        else if (split.length === 1) {
+            const pathOnly = encodeURIComponent(destinationPath);
+            const renameDestination = `/${this.shareName}/${pathOnly}`;
+            destinationUrl = setURLPath(this.url, renameDestination);
+        }
+        else {
+            throw new RangeError("Destination path should not contain more than one query string");
+        }
+        const destFile = new ShareFileClient(destinationUrl, this.pipeline);
+        try {
+            const response = await destFile.context.rename(this.url, Object.assign(Object.assign({}, updatedOptions), { sourceLeaseAccessConditions: updatedOptions.sourceLeaseAccessConditions
+                    ? {
+                        sourceLeaseId: updatedOptions.sourceLeaseAccessConditions.leaseId,
+                    }
+                    : undefined, destinationLeaseAccessConditions: updatedOptions.destinationLeaseAccessConditions
+                    ? {
+                        destinationLeaseId: updatedOptions.destinationLeaseAccessConditions.leaseId,
+                    }
+                    : undefined }));
+            return {
+                destinationFileClient: destFile,
+                fileRenameResponse: response,
+            };
+        }
+        catch (e) {
+            span.setStatus({
+                code: SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
 }
 /**
  * A client that manages leases for a {@link ShareFileClient} or {@link ShareClient}.