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

package/dist/index.js

@@ -825,6 +825,28 @@ function getShareNameAndPathFromUrl(url) {
 function httpAuthorizationToString(httpAuthorization) {
     return httpAuthorization ? httpAuthorization.scheme + " " + httpAuthorization.value : undefined;
 }
+/**
+ * Set URL path.
+ *
+ * @param url - URL to change path to.
+ * @param path - Path to set into the URL.
+ */
+function setURLPath(url, path) {
+    const urlParsed = coreHttp.URLBuilder.parse(url);
+    urlParsed.setPath(path);
+    return urlParsed.toString();
+}
+/**
+ * Set URL query string.
+ *
+ * @param url - URL to set query string to.
+ * @param queryString - Query string to set to the URL.
+ */
+function setURLQueries(url, queryString) {
+    const urlParsed = coreHttp.URLBuilder.parse(url);
+    urlParsed.setQuery(queryString);
+    return urlParsed.toString();
+}
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -4477,6 +4499,122 @@ const DirectoryForceCloseHandlesExceptionHeaders = {
         }
     }
 };
+const DirectoryRenameHeaders = {
+    serializedName: "Directory_renameHeaders",
+    type: {
+        name: "Composite",
+        className: "DirectoryRenameHeaders",
+        modelProperties: {
+            etag: {
+                serializedName: "etag",
+                xmlName: "etag",
+                type: {
+                    name: "String"
+                }
+            },
+            lastModified: {
+                serializedName: "last-modified",
+                xmlName: "last-modified",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            requestId: {
+                serializedName: "x-ms-request-id",
+                xmlName: "x-ms-request-id",
+                type: {
+                    name: "String"
+                }
+            },
+            version: {
+                serializedName: "x-ms-version",
+                xmlName: "x-ms-version",
+                type: {
+                    name: "String"
+                }
+            },
+            date: {
+                serializedName: "date",
+                xmlName: "date",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            isServerEncrypted: {
+                serializedName: "x-ms-request-server-encrypted",
+                xmlName: "x-ms-request-server-encrypted",
+                type: {
+                    name: "Boolean"
+                }
+            },
+            filePermissionKey: {
+                serializedName: "x-ms-file-permission-key",
+                xmlName: "x-ms-file-permission-key",
+                type: {
+                    name: "String"
+                }
+            },
+            fileAttributes: {
+                serializedName: "x-ms-file-attributes",
+                xmlName: "x-ms-file-attributes",
+                type: {
+                    name: "String"
+                }
+            },
+            fileCreationTime: {
+                serializedName: "x-ms-file-creation-time",
+                xmlName: "x-ms-file-creation-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileLastWriteTime: {
+                serializedName: "x-ms-file-last-write-time",
+                xmlName: "x-ms-file-last-write-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileChangeTime: {
+                serializedName: "x-ms-file-change-time",
+                xmlName: "x-ms-file-change-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileId: {
+                serializedName: "x-ms-file-id",
+                xmlName: "x-ms-file-id",
+                type: {
+                    name: "String"
+                }
+            },
+            fileParentId: {
+                serializedName: "x-ms-file-parent-id",
+                xmlName: "x-ms-file-parent-id",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const DirectoryRenameExceptionHeaders = {
+    serializedName: "Directory_renameExceptionHeaders",
+    type: {
+        name: "Composite",
+        className: "DirectoryRenameExceptionHeaders",
+        modelProperties: {
+            errorCode: {
+                serializedName: "x-ms-error-code",
+                xmlName: "x-ms-error-code",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const FileCreateHeaders = {
     serializedName: "File_createHeaders",
     type: {
@@ -6173,6 +6311,122 @@ const FileForceCloseHandlesExceptionHeaders = {
         }
     }
 };
+const FileRenameHeaders = {
+    serializedName: "File_renameHeaders",
+    type: {
+        name: "Composite",
+        className: "FileRenameHeaders",
+        modelProperties: {
+            etag: {
+                serializedName: "etag",
+                xmlName: "etag",
+                type: {
+                    name: "String"
+                }
+            },
+            lastModified: {
+                serializedName: "last-modified",
+                xmlName: "last-modified",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            requestId: {
+                serializedName: "x-ms-request-id",
+                xmlName: "x-ms-request-id",
+                type: {
+                    name: "String"
+                }
+            },
+            version: {
+                serializedName: "x-ms-version",
+                xmlName: "x-ms-version",
+                type: {
+                    name: "String"
+                }
+            },
+            date: {
+                serializedName: "date",
+                xmlName: "date",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            isServerEncrypted: {
+                serializedName: "x-ms-request-server-encrypted",
+                xmlName: "x-ms-request-server-encrypted",
+                type: {
+                    name: "Boolean"
+                }
+            },
+            filePermissionKey: {
+                serializedName: "x-ms-file-permission-key",
+                xmlName: "x-ms-file-permission-key",
+                type: {
+                    name: "String"
+                }
+            },
+            fileAttributes: {
+                serializedName: "x-ms-file-attributes",
+                xmlName: "x-ms-file-attributes",
+                type: {
+                    name: "String"
+                }
+            },
+            fileCreationTime: {
+                serializedName: "x-ms-file-creation-time",
+                xmlName: "x-ms-file-creation-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileLastWriteTime: {
+                serializedName: "x-ms-file-last-write-time",
+                xmlName: "x-ms-file-last-write-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileChangeTime: {
+                serializedName: "x-ms-file-change-time",
+                xmlName: "x-ms-file-change-time",
+                type: {
+                    name: "DateTimeRfc1123"
+                }
+            },
+            fileId: {
+                serializedName: "x-ms-file-id",
+                xmlName: "x-ms-file-id",
+                type: {
+                    name: "String"
+                }
+            },
+            fileParentId: {
+                serializedName: "x-ms-file-parent-id",
+                xmlName: "x-ms-file-parent-id",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const FileRenameExceptionHeaders = {
+    serializedName: "File_renameExceptionHeaders",
+    type: {
+        name: "Composite",
+        className: "FileRenameExceptionHeaders",
+        modelProperties: {
+            errorCode: {
+                serializedName: "x-ms-error-code",
+                xmlName: "x-ms-error-code",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 
 var Mappers = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -6257,6 +6511,8 @@ var Mappers = /*#__PURE__*/Object.freeze({
     DirectoryListHandlesExceptionHeaders: DirectoryListHandlesExceptionHeaders,
     DirectoryForceCloseHandlesHeaders: DirectoryForceCloseHandlesHeaders,
     DirectoryForceCloseHandlesExceptionHeaders: DirectoryForceCloseHandlesExceptionHeaders,
+    DirectoryRenameHeaders: DirectoryRenameHeaders,
+    DirectoryRenameExceptionHeaders: DirectoryRenameExceptionHeaders,
     FileCreateHeaders: FileCreateHeaders,
     FileCreateExceptionHeaders: FileCreateExceptionHeaders,
     FileDownloadHeaders: FileDownloadHeaders,
@@ -6290,7 +6546,9 @@ var Mappers = /*#__PURE__*/Object.freeze({
     FileListHandlesHeaders: FileListHandlesHeaders,
     FileListHandlesExceptionHeaders: FileListHandlesExceptionHeaders,
     FileForceCloseHandlesHeaders: FileForceCloseHandlesHeaders,
-    FileForceCloseHandlesExceptionHeaders: FileForceCloseHandlesExceptionHeaders
+    FileForceCloseHandlesExceptionHeaders: FileForceCloseHandlesExceptionHeaders,
+    FileRenameHeaders: FileRenameHeaders,
+    FileRenameExceptionHeaders: FileRenameExceptionHeaders
 });
 
 /*
@@ -6376,7 +6634,7 @@ const timeoutInSeconds = {
 const version = {
     parameterPath: "version",
     mapper: {
-        defaultValue: "2021-02-12",
+        defaultValue: "2021-04-10",
         isConstant: true,
         serializedName: "x-ms-version",
         type: {
@@ -6938,6 +7196,102 @@ const handleId = {
         }
     }
 };
+const comp11 = {
+    parameterPath: "comp",
+    mapper: {
+        defaultValue: "rename",
+        isConstant: true,
+        serializedName: "comp",
+        type: {
+            name: "String"
+        }
+    }
+};
+const renameSource = {
+    parameterPath: "renameSource",
+    mapper: {
+        serializedName: "x-ms-file-rename-source",
+        required: true,
+        xmlName: "x-ms-file-rename-source",
+        type: {
+            name: "String"
+        }
+    }
+};
+const replaceIfExists = {
+    parameterPath: ["options", "replaceIfExists"],
+    mapper: {
+        serializedName: "x-ms-file-rename-replace-if-exists",
+        xmlName: "x-ms-file-rename-replace-if-exists",
+        type: {
+            name: "Boolean"
+        }
+    }
+};
+const ignoreReadOnly = {
+    parameterPath: ["options", "ignoreReadOnly"],
+    mapper: {
+        serializedName: "x-ms-file-rename-ignore-readonly",
+        xmlName: "x-ms-file-rename-ignore-readonly",
+        type: {
+            name: "Boolean"
+        }
+    }
+};
+const sourceLeaseId = {
+    parameterPath: ["options", "sourceLeaseAccessConditions", "sourceLeaseId"],
+    mapper: {
+        serializedName: "x-ms-source-lease-id",
+        xmlName: "x-ms-source-lease-id",
+        type: {
+            name: "String"
+        }
+    }
+};
+const destinationLeaseId = {
+    parameterPath: [
+        "options",
+        "destinationLeaseAccessConditions",
+        "destinationLeaseId"
+    ],
+    mapper: {
+        serializedName: "x-ms-destination-lease-id",
+        xmlName: "x-ms-destination-lease-id",
+        type: {
+            name: "String"
+        }
+    }
+};
+const fileAttributes1 = {
+    parameterPath: ["options", "copyFileSmbInfo", "fileAttributes"],
+    mapper: {
+        serializedName: "x-ms-file-attributes",
+        xmlName: "x-ms-file-attributes",
+        type: {
+            name: "String"
+        }
+    }
+};
+const fileCreationTime = {
+    parameterPath: ["options", "copyFileSmbInfo", "fileCreationTime"],
+    mapper: {
+        serializedName: "x-ms-file-creation-time",
+        xmlName: "x-ms-file-creation-time",
+        type: {
+            name: "String"
+        }
+    }
+};
+const fileLastWriteTime = {
+    parameterPath: ["options", "copyFileSmbInfo", "fileLastWriteTime"],
+    mapper: {
+        serializedName: "x-ms-file-last-write-time",
+        xmlName: "x-ms-file-last-write-time",
+        type: {
+            name: "String"
+        }
+    }
+};
 const fileContentLength = {
     parameterPath: "fileContentLength",
     mapper: {
@@ -7082,7 +7436,7 @@ const accept3 = {
         }
     }
 };
-const comp11 = {
+const comp12 = {
     parameterPath: "comp",
     mapper: {
         defaultValue: "range",
@@ -7218,7 +7572,7 @@ const copySourceAuthorization = {
         }
     }
 };
-const comp12 = {
+const comp13 = {
     parameterPath: "comp",
     mapper: {
         defaultValue: "rangelist",
@@ -7250,7 +7604,7 @@ const filePermissionCopyMode = {
         }
     }
 };
-const ignoreReadOnly = {
+const ignoreReadOnly1 = {
     parameterPath: ["options", "copyFileSmbInfo", "ignoreReadOnly"],
     mapper: {
         serializedName: "x-ms-file-copy-ignore-read-only",
@@ -7260,36 +7614,6 @@ const ignoreReadOnly = {
         }
     }
 };
-const fileAttributes1 = {
-    parameterPath: ["options", "copyFileSmbInfo", "fileAttributes"],
-    mapper: {
-        serializedName: "x-ms-file-attributes",
-        xmlName: "x-ms-file-attributes",
-        type: {
-            name: "String"
-        }
-    }
-};
-const fileCreationTime = {
-    parameterPath: ["options", "copyFileSmbInfo", "fileCreationTime"],
-    mapper: {
-        serializedName: "x-ms-file-creation-time",
-        xmlName: "x-ms-file-creation-time",
-        type: {
-            name: "String"
-        }
-    }
-};
-const fileLastWriteTime = {
-    parameterPath: ["options", "copyFileSmbInfo", "fileLastWriteTime"],
-    mapper: {
-        serializedName: "x-ms-file-last-write-time",
-        xmlName: "x-ms-file-last-write-time",
-        type: {
-            name: "String"
-        }
-    }
-};
 const setArchiveAttribute = {
     parameterPath: ["options", "copyFileSmbInfo", "setArchiveAttribute"],
     mapper: {
@@ -7300,7 +7624,7 @@ const setArchiveAttribute = {
         }
     }
 };
-const comp13 = {
+const comp14 = {
     parameterPath: "comp",
     mapper: {
         defaultValue: "copy",
@@ -8279,6 +8603,18 @@ class Directory {
         };
         return this.client.sendOperationRequest(operationArguments, forceCloseHandlesOperationSpec$1);
     }
+    /**
+     * Renames a directory
+     * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
+     * @param options The options parameters.
+     */
+    rename(renameSource, options) {
+        const operationArguments = {
+            renameSource,
+            options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, renameOperationSpec$1);
+    }
 }
 // Operation Specifications
 const xmlSerializer$1 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
@@ -8494,6 +8830,42 @@ const forceCloseHandlesOperationSpec$1 = {
     isXML: true,
     serializer: xmlSerializer$1
 };
+const renameOperationSpec$1 = {
+    path: "/{shareName}/{directory}",
+    httpMethod: "PUT",
+    responses: {
+        200: {
+            headersMapper: DirectoryRenameHeaders
+        },
+        default: {
+            bodyMapper: StorageError,
+            headersMapper: DirectoryRenameExceptionHeaders
+        }
+    },
+    queryParameters: [
+        timeoutInSeconds,
+        restype2,
+        comp11
+    ],
+    urlParameters: [url],
+    headerParameters: [
+        version,
+        accept1,
+        metadata,
+        filePermission,
+        filePermissionKey1,
+        renameSource,
+        replaceIfExists,
+        ignoreReadOnly,
+        sourceLeaseId,
+        destinationLeaseId,
+        fileAttributes1,
+        fileCreationTime,
+        fileLastWriteTime
+    ],
+    isXML: true,
+    serializer: xmlSerializer$1
+};
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -8747,6 +9119,18 @@ class File {
         };
         return this.client.sendOperationRequest(operationArguments, forceCloseHandlesOperationSpec);
     }
+    /**
+     * Renames a file
+     * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
+     * @param options The options parameters.
+     */
+    rename(renameSource, options) {
+        const operationArguments = {
+            renameSource,
+            options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, renameOperationSpec);
+    }
 }
 // Operation Specifications
 const xmlSerializer = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
@@ -9033,7 +9417,7 @@ const uploadRangeOperationSpec = {
         }
     },
     requestBody: body,
-    queryParameters: [timeoutInSeconds, comp11],
+    queryParameters: [timeoutInSeconds, comp12],
     urlParameters: [url],
     headerParameters: [
         version,
@@ -9061,7 +9445,7 @@ const uploadRangeFromURLOperationSpec = {
             headersMapper: FileUploadRangeFromURLExceptionHeaders
         }
     },
-    queryParameters: [timeoutInSeconds, comp11],
+    queryParameters: [timeoutInSeconds, comp12],
     urlParameters: [url],
     headerParameters: [
         version,
@@ -9096,7 +9480,7 @@ const getRangeListOperationSpec = {
     queryParameters: [
         timeoutInSeconds,
         shareSnapshot,
-        comp12,
+        comp13,
         prevsharesnapshot
     ],
     urlParameters: [url],
@@ -9130,12 +9514,12 @@ const startCopyOperationSpec = {
         leaseId,
         filePermission,
         filePermissionKey1,
-        copySource,
-        filePermissionCopyMode,
-        ignoreReadOnly,
         fileAttributes1,
         fileCreationTime,
         fileLastWriteTime,
+        copySource,
+        filePermissionCopyMode,
+        ignoreReadOnly1,
         setArchiveAttribute
     ],
     isXML: true,
@@ -9155,7 +9539,7 @@ const abortCopyOperationSpec = {
     },
     queryParameters: [
         timeoutInSeconds,
-        comp13,
+        comp14,
         copyId
     ],
     urlParameters: [url],
@@ -9220,6 +9604,38 @@ const forceCloseHandlesOperationSpec = {
     isXML: true,
     serializer: xmlSerializer
 };
+const renameOperationSpec = {
+    path: "/{shareName}/{directory}/{fileName}",
+    httpMethod: "PUT",
+    responses: {
+        200: {
+            headersMapper: FileRenameHeaders
+        },
+        default: {
+            bodyMapper: StorageError,
+            headersMapper: FileRenameExceptionHeaders
+        }
+    },
+    queryParameters: [timeoutInSeconds, comp11],
+    urlParameters: [url],
+    headerParameters: [
+        version,
+        accept1,
+        metadata,
+        filePermission,
+        filePermissionKey1,
+        renameSource,
+        replaceIfExists,
+        ignoreReadOnly,
+        sourceLeaseId,
+        destinationLeaseId,
+        fileAttributes1,
+        fileCreationTime,
+        fileLastWriteTime
+    ],
+    isXML: true,
+    serializer: xmlSerializer
+};
 
 // Copyright (c) Microsoft Corporation.
 /**
@@ -9959,7 +10375,7 @@ class StorageClientContext extends coreHttp__namespace.ServiceClient {
         // Parameter assignments
         this.url = url;
         // Assigning values to Constant parameters
-        this.version = options.version || "2021-02-12";
+        this.version = options.version || "2021-04-10";
         this.fileRangeWriteFromUrl = options.fileRangeWriteFromUrl || "update";
     }
 }
@@ -12797,6 +13213,68 @@ 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: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
 }
 /**
  * A ShareFileClient represents a URL to an Azure Storage file.
@@ -14143,6 +14621,68 @@ 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: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
 }
 /**
  * A client that manages leases for a {@link ShareFileClient} or {@link ShareClient}.