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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/storage-file-share",
   "sdk-type": "client",
-  "version": "12.9.0-alpha.20220105.6",
+  "version": "12.9.0-alpha.20220210.2",
   "description": "Microsoft Azure Storage SDK for JavaScript - File",
   "main": "./dist/index.js",
   "module": "./dist-esm/src/index.js",
@@ -15,11 +15,11 @@
     "os": false,
     "process": false
   },
-  "types": "./typings/latest/storage-file-share.d.ts",
+  "types": "./types/latest/storage-file-share.d.ts",
   "typesVersions": {
     "<3.6": {
       "*": [
-        "./typings/3.1/storage-file-share.d.ts"
+        "./types/3.1/storage-file-share.d.ts"
       ]
     }
   },
@@ -28,20 +28,20 @@
   },
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
-    "build:browser": "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1",
-    "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
-    "build:nodebrowser": "rollup -c 2>&1",
-    "build:samples": "npm run build && npm run build:prep-samples",
+    "build:browser": "tsc -p . && dev-tool run bundle",
+    "build:node": "tsc -p . && dev-tool run bundle",
+    "build:nodebrowser": "dev-tool run bundle",
     "build:prep-samples": "dev-tool samples prep && cd dist-samples && tsc",
-    "build:test": "tsc -p . && rollup -c 2>&1",
-    "build:types": "downlevel-dts typings/latest typings/3.1",
-    "build": "npm run clean && tsc -p . && rollup -c 2>&1 && api-extractor run --local && npm run build:types",
-    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
-    "clean": "rimraf dist dist-* typings temp statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
-    "clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
+    "build:test": "tsc -p . && dev-tool run bundle",
+    "build:types": "downlevel-dts types/latest types/3.1",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local && npm run build:types",
+    "build:samples": "echo Obsolete.",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-* types temp statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "clean:samples": "rimraf samples/v12/javascript/node_modules samples/v12/typescript/node_modules samples/v12/typescript/dist samples/v12/typescript/package-lock.json samples/v12/javascript/package-lock.json",
     "extract-api": "tsc -p . && api-extractor run --local",
-    "execute:samples": "npm run build:samples && dev-tool samples run dist-samples/javascript dist-samples/typescript/src/",
-    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "execute:samples": "dev-tool samples run samples-dev",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "generate:client": "autorest --typescript ./swagger/README.md",
     "integration-test:browser": "karma start --single-run",
     "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000  \"dist-esm/test/*.spec.js\" \"dist-esm/test/node/*.spec.js\"",
@@ -61,8 +61,8 @@
     "ThirdPartyNotices.txt",
     "dist/",
     "dist-esm/src/",
-    "typings/latest/storage-file-share.d.ts",
-    "typings/3.1/storage-file-share.d.ts",
+    "types/latest/storage-file-share.d.ts",
+    "types/3.1/storage-file-share.d.ts",
     "README.md",
     "LICENSE"
   ],
@@ -102,14 +102,22 @@
   },
   "//sampleConfiguration": {
     "skip": [
-      "advanced.js",
-      "anonymousCred.js",
-      "basic.js",
+      "advancedRequestOptions.js",
+      "anonymousAuth.js",
+      "shareServiceClient.js",
       "customPipeline.js",
-      "iterators-files-and-directories.js",
-      "iterators-shares.js",
-      "sharedKeyCred.js"
-    ]
+      "listFilesAndDirectories.js",
+      "listShares.js",
+      "sharedKeyAuth.js"
+    ],
+    "productName": "Azure Storage File Share",
+    "productSlugs": [
+      "azure",
+      "azure-storage"
+    ],
+    "requiredResources": {
+      "Azure Storage Account": "https://docs.microsoft.com/azure/storage/common/storage-account-overview"
+    }
   },
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
@@ -128,17 +136,13 @@
     "@azure-tools/test-recorder": "^1.0.0",
     "@azure/test-utils-perf": ">=1.0.0-alpha <1.0.0-alphb",
     "@microsoft/api-extractor": "^7.18.11",
-    "@rollup/plugin-commonjs": "11.0.2",
-    "@rollup/plugin-multi-entry": "^3.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.0",
-    "@rollup/plugin-replace": "^2.2.0",
     "@types/chai": "^4.1.6",
     "@types/mocha": "^7.0.2",
     "@types/node": "^12.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
-    "downlevel-dts": "~0.4.0",
+    "downlevel-dts": "^0.8.0",
     "es6-promise": "^4.2.5",
     "eslint": "^7.15.0",
     "esm": "^3.2.18",
@@ -162,11 +166,6 @@
     "prettier": "^2.5.1",
     "puppeteer": "^10.2.0",
     "rimraf": "^3.0.0",
-    "rollup": "^1.16.3",
-    "rollup-plugin-shim": "^1.0.0",
-    "rollup-plugin-sourcemaps": "^0.4.2",
-    "rollup-plugin-terser": "^5.1.1",
-    "rollup-plugin-visualizer": "^4.0.4",
     "source-map-support": "^0.5.9",
     "ts-node": "^10.0.0",
     "typescript": "~4.2.0",

package/{typings → types}/3.1/storage-file-share.d.ts

@@ -321,16 +321,16 @@ export declare interface CommonOptions {
 }
 /** Parameter group */
 export declare interface CopyFileSmbInfo {
-    /** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
-    filePermissionCopyMode?: PermissionCopyModeType;
-    /** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
-    ignoreReadOnly?: boolean;
     /** Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. */
     fileAttributes?: string;
     /** Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. */
     fileCreationTime?: string;
     /** Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. */
     fileLastWriteTime?: string;
+    /** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
+    filePermissionCopyMode?: PermissionCopyModeType;
+    /** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
+    ignoreReadOnly?: boolean;
     /** Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state. */
     setArchiveAttribute?: boolean;
 }
@@ -767,6 +767,96 @@ export declare interface DirectoryProperties extends FileAndDirectorySetProperti
      */
     abortSignal?: AbortSignalLike;
 }
+/** Defines headers for Directory_rename operation. */
+export declare interface DirectoryRenameHeaders {
+    /** The ETag contains a value which represents the version of the file, in quotes. */
+    etag?: string;
+    /** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
+    lastModified?: Date;
+    /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
+    requestId?: string;
+    /** Indicates the version of the File service used to execute the request. */
+    version?: string;
+    /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
+    date?: Date;
+    /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
+    isServerEncrypted?: boolean;
+    /** Key of the permission set for the file. */
+    filePermissionKey?: string;
+    /** Attributes set for the file. */
+    fileAttributes?: string;
+    /** Creation time for the file. */
+    fileCreationTime?: Date;
+    /** Last write time for the file. */
+    fileLastWriteTime?: Date;
+    /** Change time for the file. */
+    fileChangeTime?: Date;
+    /** The fileId of the file. */
+    fileId?: string;
+    /** The parent fileId of the directory. */
+    fileParentId?: string;
+}
+/**
+ * Options to configure the {@link ShareDirectoryClient.rename} operation.
+ */
+export declare interface DirectoryRenameOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Lease access condition for source file. Required if the source file has an active infinite lease.
+     */
+    sourceLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Lease access condition for destination file. Required if the destination file has an active infinite lease.
+     */
+    destinationLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Optional.
+     * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
+     */
+    copyFileSmbInfo?: CopyFileSmbInfo;
+    /**
+     * Optional.
+     * The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
+     */
+    timeoutInSeconds?: number;
+    /**
+     * Optional.
+     * A name-value pair to associate with a file storage object.
+     */
+    metadata?: Metadata;
+    /**
+     * Optional.
+     * If specified the permission (security descriptor) shall be set for the directory/file.
+     */
+    filePermission?: string;
+    /**
+     * Optional.
+     * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
+     */
+    filePermissionKey?: string;
+    /**
+     * Optional.
+     * A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
+     */
+    replaceIfExists?: boolean;
+    /**
+     * Optional.
+     * A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
+     */
+    ignoreReadOnly?: boolean;
+}
+/** Contains response data for the rename operation. */
+export declare type DirectoryRenameResponse = DirectoryRenameHeaders & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The parsed HTTP response headers. */
+        parsedHeaders: DirectoryRenameHeaders;
+    };
+};
 /** Defines headers for Directory_setMetadata operation. */
 export declare interface DirectorySetMetadataHeaders {
     /** The ETag contains a value which represents the version of the directory, in quotes. */
@@ -1683,6 +1773,95 @@ export declare interface FileProperty {
     lastModified?: Date;
     etag?: string;
 }
+/** Defines headers for File_rename operation. */
+export declare interface FileRenameHeaders {
+    /** The ETag contains a value which represents the version of the file, in quotes. */
+    etag?: string;
+    /** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
+    lastModified?: Date;
+    /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
+    requestId?: string;
+    /** Indicates the version of the File service used to execute the request. */
+    version?: string;
+    /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
+    date?: Date;
+    /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
+    isServerEncrypted?: boolean;
+    /** Key of the permission set for the file. */
+    filePermissionKey?: string;
+    /** Attributes set for the file. */
+    fileAttributes?: string;
+    /** Creation time for the file. */
+    fileCreationTime?: Date;
+    /** Last write time for the file. */
+    fileLastWriteTime?: Date;
+    /** Change time for the file. */
+    fileChangeTime?: Date;
+    /** The fileId of the file. */
+    fileId?: string;
+    /** The parent fileId of the directory. */
+    fileParentId?: string;
+}
+/**
+ * Options to configure the {@link ShareFileClient.rename} operation.
+ */
+export declare interface FileRenameOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Lease access condition for source file. Required if the source file has an active infinite lease.
+     */
+    sourceLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Lease access condition for destination file. Required if the destination file has an active infinite lease.
+     */
+    destinationLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Optional.
+     * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
+     */
+    copyFileSmbInfo?: CopyFileSmbInfo;
+    /**
+     * A name-value pair to associate with a file storage object.
+     */
+    metadata?: Metadata;
+    /**
+     * Optional.
+     * The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
+     */
+    timeoutInSeconds?: number;
+    /**
+     * Optional.
+     * If specified the permission (security descriptor) shall be set for the directory/file.
+     */
+    filePermission?: string;
+    /**
+     * Optional.
+     * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
+     */
+    filePermissionKey?: string;
+    /**
+     * Optional.
+     * A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
+     */
+    replaceIfExists?: boolean;
+    /**
+     * Optional.
+     * A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
+     */
+    ignoreReadOnly?: boolean;
+}
+/** Contains response data for the rename operation. */
+export declare type FileRenameResponse = FileRenameHeaders & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The parsed HTTP response headers. */
+        parsedHeaders: FileRenameHeaders;
+    };
+};
 /**
  * Options to configure the {@link ShareFileClient.resize} operation.
  */
@@ -2583,6 +2762,11 @@ export declare class SASQueryParameters {
      * Inner value of getter ipRange.
      */
     private readonly ipRangeInner?;
+    /*
+    * Optional. IP range allowed for this SAS.
+    *
+    * @readonly
+    */
     readonly ipRange: SasIPRange | undefined;
     /**
      * Creates an instance of SASQueryParameters.
@@ -2780,6 +2964,9 @@ export declare class ShareClient extends StorageClient {
      */
     private context;
     private _name;
+    /*
+    * The name of the share
+    */
     readonly name: string;
     /**
      * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
@@ -2847,6 +3034,12 @@ export declare class ShareClient extends StorageClient {
      * @returns The ShareDirectoryClient object for the given directory name.
      */
     getDirectoryClient(directoryName: string): ShareDirectoryClient;
+    /*
+    * Gets the directory client for the root directory of this share.
+    * Note that the root directory always exists and cannot be deleted.
+    *
+    * @readonly A new ShareDirectoryClient object for the root directory.
+    */
     readonly rootDirectoryClient: ShareDirectoryClient;
     /**
      * Creates a new subdirectory under this share.
@@ -3248,8 +3441,17 @@ export declare class ShareDirectoryClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    /*
+    * The share name corresponding to this directory client
+    */
     readonly shareName: string;
+    /*
+    * The full path of the directory
+    */
     readonly path: string;
+    /*
+    * The name of the directory
+    */
     readonly name: string;
     /**
      * Creates an instance of DirectoryClient.
@@ -3702,6 +3904,27 @@ export declare class ShareDirectoryClient extends StorageClient {
      * @param options -
      */
     forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>;
+    /**
+     * 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!");
+     * ```
+     */
+    rename(destinationPath: string, options?: DirectoryRenameOptions): Promise<{
+        destinationDirectoryClient: ShareDirectoryClient;
+        directoryRenameResponse: DirectoryRenameResponse;
+    }>;
 }
 /**
  * Options to configure the {@link ShareClient.exists} operation.
@@ -3728,8 +3951,17 @@ export declare class ShareFileClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    /*
+    * The share name corresponding to this file client
+    */
     readonly shareName: string;
+    /*
+    * The full path of the file
+    */
     readonly path: string;
+    /*
+    * The name of the file
+    */
     readonly name: string;
     /**
      * Creates an instance of ShareFileClient.
@@ -4246,6 +4478,27 @@ export declare class ShareFileClient extends StorageClient {
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
      */
     generateSasUrl(options: FileGenerateSasUrlOptions): string;
+    /**
+     * 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!");
+     * ```
+     */
+    rename(destinationPath: string, options?: FileRenameOptions): Promise<{
+        destinationFileClient: ShareFileClient;
+        fileRenameResponse: FileRenameResponse;
+    }>;
 }
 /** The list of file ranges */
 export declare interface ShareFileRangeList {
@@ -4512,7 +4765,17 @@ export declare class ShareLeaseClient {
     private _url;
     private fileOrShare;
     private isShare;
+    /*
+    * Gets the lease Id.
+    *
+    * @readonly
+    */
     readonly leaseId: string;
+    /*
+    * Gets the url.
+    *
+    * @readonly
+    */
     readonly url: string;
     /**
      * Creates an instance of ShareLeaseClient.