@azure/storage-file-share 12.9.0-beta.2 → 12.9.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -4
 - package/README.md +6 -5
 - package/dist/index.js +942 -373
 - package/dist/index.js.map +1 -1
 - package/dist-esm/src/AccountSASSignatureValues.js +2 -2
 - package/dist-esm/src/AccountSASSignatureValues.js.map +1 -1
 - package/dist-esm/src/Clients.js +236 -112
 - package/dist-esm/src/Clients.js.map +1 -1
 - package/dist-esm/src/FileDownloadResponse.js +1 -1
 - package/dist-esm/src/FileDownloadResponse.js.map +1 -1
 - package/dist-esm/src/FileSASSignatureValues.js +1 -1
 - package/dist-esm/src/FileSASSignatureValues.js.map +1 -1
 - package/dist-esm/src/Pipeline.js +6 -6
 - package/dist-esm/src/Pipeline.js.map +1 -1
 - package/dist-esm/src/SASQueryParameters.js +2 -2
 - package/dist-esm/src/SASQueryParameters.js.map +1 -1
 - package/dist-esm/src/ShareServiceClient.js +8 -8
 - package/dist-esm/src/ShareServiceClient.js.map +1 -1
 - package/dist-esm/src/StorageClient.js.map +1 -1
 - package/dist-esm/src/TelemetryPolicyFactory.js +1 -1
 - package/dist-esm/src/TelemetryPolicyFactory.js.map +1 -1
 - package/dist-esm/src/credentials/StorageSharedKeyCredential.js +1 -3
 - package/dist-esm/src/credentials/StorageSharedKeyCredential.js.map +1 -1
 - package/dist-esm/src/generated/src/models/index.js.map +1 -1
 - package/dist-esm/src/generated/src/models/mappers.js +232 -0
 - package/dist-esm/src/generated/src/models/mappers.js.map +1 -1
 - package/dist-esm/src/generated/src/models/parameters.js +101 -35
 - package/dist-esm/src/generated/src/models/parameters.js.map +1 -1
 - package/dist-esm/src/generated/src/operations/directory.js +48 -0
 - package/dist-esm/src/generated/src/operations/directory.js.map +1 -1
 - package/dist-esm/src/generated/src/operations/file.js +51 -7
 - package/dist-esm/src/generated/src/operations/file.js.map +1 -1
 - package/dist-esm/src/generated/src/storageClientContext.js +2 -2
 - package/dist-esm/src/generated/src/storageClientContext.js.map +1 -1
 - package/dist-esm/src/generatedModels.js.map +1 -1
 - package/dist-esm/src/index.browser.js.map +1 -1
 - package/dist-esm/src/index.js.map +1 -1
 - package/dist-esm/src/policies/StorageBrowserPolicy.js +1 -1
 - package/dist-esm/src/policies/StorageBrowserPolicy.js.map +1 -1
 - package/dist-esm/src/policies/StorageRetryPolicy.js +5 -5
 - package/dist-esm/src/policies/StorageRetryPolicy.js.map +1 -1
 - package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js +1 -1
 - package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
 - package/dist-esm/src/policies/TelemetryPolicy.js +1 -1
 - package/dist-esm/src/policies/TelemetryPolicy.js.map +1 -1
 - package/dist-esm/src/utils/Batch.js.map +1 -1
 - package/dist-esm/src/utils/RetriableReadableStream.js +1 -2
 - package/dist-esm/src/utils/RetriableReadableStream.js.map +1 -1
 - package/dist-esm/src/utils/constants.js +8 -8
 - package/dist-esm/src/utils/constants.js.map +1 -1
 - package/dist-esm/src/utils/tracing.js +2 -2
 - package/dist-esm/src/utils/tracing.js.map +1 -1
 - package/dist-esm/src/utils/utils.common.js +23 -1
 - package/dist-esm/src/utils/utils.common.js.map +1 -1
 - package/package.json +41 -43
 - package/{typings → types}/3.1/storage-file-share.d.ts +267 -4
 - package/{typings → types}/latest/storage-file-share.d.ts +231 -4
 
    
        package/CHANGELOG.md
    CHANGED
    
    | 
         @@ -1,5 +1,12 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            # Release History
         
     | 
| 
       2 
2 
     | 
    
         | 
| 
      
 3 
     | 
    
         
            +
            ## 12.9.0-beta.3 (2022-02-11)
         
     | 
| 
      
 4 
     | 
    
         
            +
             
     | 
| 
      
 5 
     | 
    
         
            +
            ### Features Added
         
     | 
| 
      
 6 
     | 
    
         
            +
             
     | 
| 
      
 7 
     | 
    
         
            +
            - Added support for service version 2021-04-10.
         
     | 
| 
      
 8 
     | 
    
         
            +
            - Added support for renaming a file or a directory.
         
     | 
| 
      
 9 
     | 
    
         
            +
             
     | 
| 
       3 
10 
     | 
    
         
             
            ## 12.9.0-beta.2 (2021-12-03)
         
     | 
| 
       4 
11 
     | 
    
         | 
| 
       5 
12 
     | 
    
         
             
            ### Features Added
         
     | 
| 
         @@ -196,14 +203,14 @@ 
     | 
|
| 
       196 
203 
     | 
    
         
             
              Before this change the option is specified as
         
     | 
| 
       197 
204 
     | 
    
         
             
              ```js
         
     | 
| 
       198 
205 
     | 
    
         
             
              fileServiceClient.listShares({
         
     | 
| 
       199 
     | 
    
         
            -
                include: ["metadata", "snapshots"]
         
     | 
| 
      
 206 
     | 
    
         
            +
                include: ["metadata", "snapshots"],
         
     | 
| 
       200 
207 
     | 
    
         
             
              });
         
     | 
| 
       201 
208 
     | 
    
         
             
              ```
         
     | 
| 
       202 
209 
     | 
    
         
             
              After this change:
         
     | 
| 
       203 
210 
     | 
    
         
             
              ```js
         
     | 
| 
       204 
211 
     | 
    
         
             
              fileServiceClient.listShares({
         
     | 
| 
       205 
212 
     | 
    
         
             
                includeMetadata: true,
         
     | 
| 
       206 
     | 
    
         
            -
                includeSnapshots: true
         
     | 
| 
      
 213 
     | 
    
         
            +
                includeSnapshots: true,
         
     | 
| 
       207 
214 
     | 
    
         
             
              });
         
     | 
| 
       208 
215 
     | 
    
         
             
              ```
         
     | 
| 
       209 
216 
     | 
    
         | 
| 
         @@ -234,7 +241,7 @@ 
     | 
|
| 
       234 
241 
     | 
    
         
             
            - Added `DirectoryClient.listHandlesSegment()` and `FileClient.listHandlesSegment()` to returns a list of open handles on a directory or a file.
         
     | 
| 
       235 
242 
     | 
    
         
             
            - Added `DirectoryClient.forceCloseHandlesSegment()`, `FileClient.forceCloseHandlesSegment()`, `DirectoryClient.forceCloseHandle()` and `FileClient.forceCloseHandle()` to close handles.
         
     | 
| 
       236 
243 
     | 
    
         
             
            - Pass through `options.abortSignal` to the optional `abortSignal` attribute in option bags instead of using `AbortSignal.none` as the default value when `options.abortSignal` is not specified.
         
     | 
| 
       237 
     | 
    
         
            -
            - Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - [ 
     | 
| 
      
 244 
     | 
    
         
            +
            - Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - [proxyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-file-share/samples-dev/proxyAuth.ts)
         
     | 
| 
       238 
245 
     | 
    
         
             
            - Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint)
         
     | 
| 
       239 
246 
     | 
    
         | 
| 
       240 
247 
     | 
    
         
             
            ## 12.0.0-preview.2 (2019-08-01)
         
     | 
| 
         @@ -275,7 +282,7 @@ 
     | 
|
| 
       275 
282 
     | 
    
         
             
            - Creation/Deletion of child resources are duplicated to parent client type.
         
     | 
| 
       276 
283 
     | 
    
         
             
            - HTTP proxy support is added (Node.js only).
         
     | 
| 
       277 
284 
     | 
    
         | 
| 
       278 
     | 
    
         
            -
              - Please refer to the `proxyAuth.ts` sample in the `samples/typescript` folder.
         
     | 
| 
      
 285 
     | 
    
         
            +
              - Please refer to the `proxyAuth.ts` sample in the `samples/v12/typescript` folder.
         
     | 
| 
       279 
286 
     | 
    
         | 
| 
       280 
287 
     | 
    
         
             
            - Request and response headers are now logged at INFO level, with sensitive data redacted.
         
     | 
| 
       281 
288 
     | 
    
         
             
            - `downloadToFile()` is added to `FileClient`.
         
     | 
    
        package/README.md
    CHANGED
    
    | 
         @@ -16,6 +16,7 @@ Use the client libraries in this package to: 
     | 
|
| 
       16 
16 
     | 
    
         
             
            > for Azure Storage Files DataLake and provide a consistent set of APIs for working with files on Azure.
         
     | 
| 
       17 
17 
     | 
    
         | 
| 
       18 
18 
     | 
    
         
             
            Key links:
         
     | 
| 
      
 19 
     | 
    
         
            +
             
     | 
| 
       19 
20 
     | 
    
         
             
            - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share)
         
     | 
| 
       20 
21 
     | 
    
         
             
            - [Package (npm)](https://www.npmjs.com/package/@azure/storage-file-share/)
         
     | 
| 
       21 
22 
     | 
    
         
             
            - [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-file-share)
         
     | 
| 
         @@ -34,7 +35,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP 
     | 
|
| 
       34 
35 
     | 
    
         | 
| 
       35 
36 
     | 
    
         
             
            ### Prerequisites
         
     | 
| 
       36 
37 
     | 
    
         | 
| 
       37 
     | 
    
         
            -
            - An [Azure subscription](https://azure.microsoft.com/free/) 
     | 
| 
      
 38 
     | 
    
         
            +
            - An [Azure subscription](https://azure.microsoft.com/free/)
         
     | 
| 
       38 
39 
     | 
    
         
             
            - A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create)
         
     | 
| 
       39 
40 
     | 
    
         | 
| 
       40 
41 
     | 
    
         
             
            ### Install the package
         
     | 
| 
         @@ -388,7 +389,7 @@ async function main() { 
     | 
|
| 
       388 
389 
     | 
    
         
             
            main();
         
     | 
| 
       389 
390 
     | 
    
         
             
            ```
         
     | 
| 
       390 
391 
     | 
    
         | 
| 
       391 
     | 
    
         
            -
            For a complete sample on iterating please see [samples/typescript/src/ 
     | 
| 
      
 392 
     | 
    
         
            +
            For a complete sample on iterating please see [samples/v12/typescript/src/listFilesAndDirectories.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-file-share/samples/v12/typescript/src/listFilesAndDirectories.ts).
         
     | 
| 
       392 
393 
     | 
    
         | 
| 
       393 
394 
     | 
    
         
             
            ### Download a file and convert it to a string (Node.js)
         
     | 
| 
       394 
395 
     | 
    
         | 
| 
         @@ -481,7 +482,7 @@ async function blobToString(blob) { 
     | 
|
| 
       481 
482 
     | 
    
         
             
            main();
         
     | 
| 
       482 
483 
     | 
    
         
             
            ```
         
     | 
| 
       483 
484 
     | 
    
         | 
| 
       484 
     | 
    
         
            -
            A complete example of  
     | 
| 
      
 485 
     | 
    
         
            +
            A complete example of simple `ShareServiceClient` scenarios is at [samples/v12/typescript/src/shareSerivceClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-file-share/samples/v12/typescript/src/shareServiceClient.ts).
         
     | 
| 
       485 
486 
     | 
    
         | 
| 
       486 
487 
     | 
    
         
             
            ## Troubleshooting
         
     | 
| 
       487 
488 
     | 
    
         | 
| 
         @@ -497,8 +498,8 @@ setLogLevel("info"); 
     | 
|
| 
       497 
498 
     | 
    
         | 
| 
       498 
499 
     | 
    
         
             
            More code samples
         
     | 
| 
       499 
500 
     | 
    
         | 
| 
       500 
     | 
    
         
            -
            - [File Share Storage Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/samples/javascript)
         
     | 
| 
       501 
     | 
    
         
            -
            - [File Share Storage Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/samples/typescript)
         
     | 
| 
      
 501 
     | 
    
         
            +
            - [File Share Storage Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/samples/v12/javascript)
         
     | 
| 
      
 502 
     | 
    
         
            +
            - [File Share Storage Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/samples/v12/typescript)
         
     | 
| 
       502 
503 
     | 
    
         
             
            - [File Share Storage Test Cases](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/test)
         
     | 
| 
       503 
504 
     | 
    
         | 
| 
       504 
505 
     | 
    
         
             
            ## Contributing
         
     |