@azure/storage-file-share 12.26.0-beta.1 → 12.27.0-alpha.20250217.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. package/LICENSE +3 -3
  2. package/README.md +16 -18
  3. package/dist/index.js +1428 -431
  4. package/dist/index.js.map +1 -1
  5. package/dist-esm/storage-blob/src/BatchResponse.js.map +1 -1
  6. package/dist-esm/storage-blob/src/BatchResponseParser.js +1 -1
  7. package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
  8. package/dist-esm/storage-blob/src/BatchUtils.js.map +1 -1
  9. package/dist-esm/storage-blob/src/BlobBatch.js +1 -1
  10. package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
  11. package/dist-esm/storage-blob/src/BlobBatchClient.js +3 -3
  12. package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -1
  13. package/dist-esm/storage-blob/src/BlobDownloadResponse.js +1 -1
  14. package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +1 -1
  15. package/dist-esm/storage-blob/src/BlobLeaseClient.js +10 -10
  16. package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -1
  17. package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +1 -1
  18. package/dist-esm/storage-blob/src/BlobServiceClient.js +12 -14
  19. package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
  20. package/dist-esm/storage-blob/src/Clients.js +47 -48
  21. package/dist-esm/storage-blob/src/Clients.js.map +1 -1
  22. package/dist-esm/storage-blob/src/ContainerClient.js +20 -21
  23. package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
  24. package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +1 -1
  25. package/dist-esm/storage-blob/src/Pipeline.js.map +1 -1
  26. package/dist-esm/storage-blob/src/Range.js.map +1 -1
  27. package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +1 -1
  28. package/dist-esm/storage-blob/src/StorageClient.js.map +1 -1
  29. package/dist-esm/storage-blob/src/StorageContextClient.js.map +1 -1
  30. package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -1
  31. package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +1 -1
  32. package/dist-esm/storage-blob/src/credentials/Credential.js.map +1 -1
  33. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +1 -1
  34. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +1 -1
  35. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -1
  36. package/dist-esm/storage-blob/src/generated/src/storageClient.js +1 -1
  37. package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
  38. package/dist-esm/storage-blob/src/generatedModels.js.map +1 -1
  39. package/dist-esm/storage-blob/src/models.js +2 -2
  40. package/dist-esm/storage-blob/src/models.js.map +1 -1
  41. package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +1 -1
  42. package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +1 -1
  43. package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +1 -1
  44. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js.map +1 -1
  45. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +1 -1
  46. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.browser.js.map +1 -1
  47. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.js.map +1 -1
  48. package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +1 -1
  49. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +1 -1
  50. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +1 -1
  51. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +2 -2
  52. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
  53. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +1 -1
  54. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +2 -2
  55. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -1
  56. package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +1 -1
  57. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +2 -2
  58. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -1
  59. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js +1 -1
  60. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -1
  61. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +1 -1
  62. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
  63. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +1 -1
  64. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
  65. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +1 -1
  66. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -1
  67. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -1
  68. package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +1 -1
  69. package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +1 -1
  70. package/dist-esm/storage-blob/src/utils/cache.js.map +1 -1
  71. package/dist-esm/storage-blob/src/utils/constants.js +1 -1
  72. package/dist-esm/storage-blob/src/utils/constants.js.map +1 -1
  73. package/dist-esm/storage-blob/src/utils/utils.common.js +3 -3
  74. package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
  75. package/dist-esm/storage-blob/src/utils/utils.node.js +1 -1
  76. package/dist-esm/storage-blob/src/utils/utils.node.js.map +1 -1
  77. package/dist-esm/storage-file-share/src/AccountSASPermissions.js +2 -2
  78. package/dist-esm/storage-file-share/src/AccountSASPermissions.js.map +1 -1
  79. package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js +1 -1
  80. package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js.map +1 -1
  81. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js +1 -1
  82. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +1 -1
  83. package/dist-esm/storage-file-share/src/Clients.js +103 -79
  84. package/dist-esm/storage-file-share/src/Clients.js.map +1 -1
  85. package/dist-esm/storage-file-share/src/FileDownloadResponse.js +25 -1
  86. package/dist-esm/storage-file-share/src/FileDownloadResponse.js.map +1 -1
  87. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +1 -1
  88. package/dist-esm/storage-file-share/src/FileSystemAttributes.js +1 -1
  89. package/dist-esm/storage-file-share/src/FileSystemAttributes.js.map +1 -1
  90. package/dist-esm/storage-file-share/src/Pipeline.js.map +1 -1
  91. package/dist-esm/storage-file-share/src/Range.js.map +1 -1
  92. package/dist-esm/storage-file-share/src/SASQueryParameters.js.map +1 -1
  93. package/dist-esm/storage-file-share/src/ShareClientInternal.js.map +1 -1
  94. package/dist-esm/storage-file-share/src/ShareSASPermissions.js +1 -1
  95. package/dist-esm/storage-file-share/src/ShareSASPermissions.js.map +1 -1
  96. package/dist-esm/storage-file-share/src/ShareServiceClient.js +13 -7
  97. package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -1
  98. package/dist-esm/storage-file-share/src/StorageClient.js.map +1 -1
  99. package/dist-esm/storage-file-share/src/StorageContextClient.js.map +1 -1
  100. package/dist-esm/storage-file-share/src/StorageRetryPolicyFactory.js.map +1 -1
  101. package/dist-esm/storage-file-share/src/generated/src/models/index.js +10 -0
  102. package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -1
  103. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js +544 -0
  104. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -1
  105. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +108 -3
  106. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -1
  107. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +12 -10
  108. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -1
  109. package/dist-esm/storage-file-share/src/generated/src/operations/file.js +125 -10
  110. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
  111. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js.map +1 -1
  112. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js.map +1 -1
  113. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +2 -2
  114. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
  115. package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
  116. package/dist-esm/storage-file-share/src/index.browser.js +1 -0
  117. package/dist-esm/storage-file-share/src/index.browser.js.map +1 -1
  118. package/dist-esm/storage-file-share/src/index.js +1 -0
  119. package/dist-esm/storage-file-share/src/index.js.map +1 -1
  120. package/dist-esm/storage-file-share/src/models.js +0 -21
  121. package/dist-esm/storage-file-share/src/models.js.map +1 -1
  122. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicy.js.map +1 -1
  123. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicyV2.js +1 -1
  124. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicyV2.js.map +1 -1
  125. package/dist-esm/storage-file-share/src/utils/BufferScheduler.js.map +1 -1
  126. package/dist-esm/storage-file-share/src/utils/RetriableReadableStream.js.map +1 -1
  127. package/dist-esm/storage-file-share/src/utils/constants.js +2 -2
  128. package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
  129. package/dist-esm/storage-file-share/src/utils/utils.common.js +214 -3
  130. package/dist-esm/storage-file-share/src/utils/utils.common.js.map +1 -1
  131. package/package.json +11 -15
  132. package/types/latest/storage-file-share.d.ts +978 -144
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
- The MIT License (MIT)
1
+ Copyright (c) Microsoft Corporation.
2
2
 
3
- Copyright (c) 2020 Microsoft
3
+ MIT License
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
12
12
  The above copyright notice and this permission notice shall be included in all
13
13
  copies or substantial portions of the Software.
14
14
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
16
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
17
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
18
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
package/README.md CHANGED
@@ -19,10 +19,10 @@ Key links:
19
19
 
20
20
  - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share)
21
21
  - [Package (npm)](https://www.npmjs.com/package/@azure/storage-file-share/)
22
- - [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-file-share)
23
- - [Product documentation](https://docs.microsoft.com/azure/storage/files/storage-files-introduction)
22
+ - [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/storage-file-share)
23
+ - [Product documentation](https://learn.microsoft.com/azure/storage/files/storage-files-introduction)
24
24
  - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-file-share/samples)
25
- - [Azure Storage File REST APIs](https://docs.microsoft.com/rest/api/storageservices/file-service-rest-api)
25
+ - [Azure Storage File REST APIs](https://learn.microsoft.com/rest/api/storageservices/file-service-rest-api)
26
26
 
27
27
  ## Getting started
28
28
 
@@ -36,7 +36,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
36
36
  ### Prerequisites
37
37
 
38
38
  - An [Azure subscription](https://azure.microsoft.com/free/)
39
- - A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create)
39
+ - A [Storage Account](https://learn.microsoft.com/azure/storage/common/storage-account-create)
40
40
 
41
41
  ### Install the package
42
42
 
@@ -99,7 +99,7 @@ To use this client library in the browser, first you need to use a bundler. For
99
99
 
100
100
  ### CORS
101
101
 
102
- You need to set up [Cross-Origin Resource Sharing (CORS)](https://docs.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
102
+ You need to set up [Cross-Origin Resource Sharing (CORS)](https://learn.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
103
103
 
104
104
  For example, you can create following CORS settings for debugging. But please customize the settings carefully according to your requirements in production environment.
105
105
 
@@ -176,7 +176,7 @@ const credential = new StorageSharedKeyCredential(account, accountKey);
176
176
  const serviceClient = new ShareServiceClient(
177
177
  // When using AnonymousCredential, following url should include a valid SAS
178
178
  `https://${account}.file.core.windows.net`,
179
- credential
179
+ credential,
180
180
  );
181
181
  ```
182
182
 
@@ -191,7 +191,7 @@ const account = "<account name>";
191
191
  const sas = "<service Shared Access Signature Token>";
192
192
 
193
193
  const serviceClientWithSAS = new ShareServiceClient(
194
- `https://${account}.file.core.windows.net${sas}`
194
+ `https://${account}.file.core.windows.net${sas}`,
195
195
  );
196
196
  ```
197
197
 
@@ -209,7 +209,7 @@ const accountKey = "<accountkey>";
209
209
  const credential = new StorageSharedKeyCredential(account, accountKey);
210
210
  const serviceClient = new ShareServiceClient(
211
211
  `https://${account}.file.core.windows.net`,
212
- credential
212
+ credential,
213
213
  );
214
214
 
215
215
  async function main() {
@@ -235,7 +235,7 @@ const accountKey = "<accountkey>";
235
235
  const credential = new StorageSharedKeyCredential(account, accountKey);
236
236
  const serviceClient = new ShareServiceClient(
237
237
  `https://${account}.file.core.windows.net`,
238
- credential
238
+ credential,
239
239
  );
240
240
 
241
241
  async function main() {
@@ -262,7 +262,7 @@ const accountKey = "<accountkey>";
262
262
  const credential = new StorageSharedKeyCredential(account, accountKey);
263
263
  const serviceClient = new ShareServiceClient(
264
264
  `https://${account}.file.core.windows.net`,
265
- credential
265
+ credential,
266
266
  );
267
267
 
268
268
  async function main() {
@@ -291,7 +291,7 @@ const accountKey = "<accountkey>";
291
291
  const credential = new StorageSharedKeyCredential(account, accountKey);
292
292
  const serviceClient = new ShareServiceClient(
293
293
  `https://${account}.file.core.windows.net`,
294
- credential
294
+ credential,
295
295
  );
296
296
 
297
297
  const shareName = "<share name>";
@@ -329,7 +329,7 @@ const accountKey = "<accountkey>";
329
329
  const credential = new StorageSharedKeyCredential(account, accountKey);
330
330
  const serviceClient = new ShareServiceClient(
331
331
  `https://${account}.file.core.windows.net`,
332
- credential
332
+ credential,
333
333
  );
334
334
 
335
335
  const shareName = "<share name>";
@@ -364,7 +364,7 @@ const accountKey = "<accountkey>";
364
364
  const credential = new StorageSharedKeyCredential(account, accountKey);
365
365
  const serviceClient = new ShareServiceClient(
366
366
  `https://${account}.file.core.windows.net`,
367
- credential
367
+ credential,
368
368
  );
369
369
 
370
370
  const shareName = "<share name>";
@@ -403,7 +403,7 @@ const accountKey = "<accountkey>";
403
403
  const credential = new StorageSharedKeyCredential(account, accountKey);
404
404
  const serviceClient = new ShareServiceClient(
405
405
  `https://${account}.file.core.windows.net`,
406
- credential
406
+ credential,
407
407
  );
408
408
 
409
409
  const shareName = "<share name>";
@@ -434,7 +434,7 @@ async function main() {
434
434
  console.log(
435
435
  `Downloaded file content: ${(
436
436
  await streamToBuffer(downloadFileResponse.readableStreamBody)
437
- ).toString()}`
437
+ ).toString()}`,
438
438
  );
439
439
  }
440
440
 
@@ -464,7 +464,7 @@ async function main() {
464
464
  // In browsers, get downloaded data by accessing downloadFileResponse.blobBody
465
465
  const downloadFileResponse = await fileClient.download(0);
466
466
  console.log(
467
- `Downloaded file content: ${await blobToString(await downloadFileResponse.blobBody)}`
467
+ `Downloaded file content: ${await blobToString(await downloadFileResponse.blobBody)}`,
468
468
  );
469
469
  }
470
470
 
@@ -508,5 +508,3 @@ More code samples
508
508
  If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
509
509
 
510
510
  Also refer to [Storage specific guide](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/CONTRIBUTING.md) for additional information on setting up the test environment for storage libraries.
511
-
512
- ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fstorage%2Fstorage-file-share%2FREADME.png)