@azure/storage-file-share 12.8.0-beta.1 → 12.8.1-alpha.20211025.1
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 +23 -2
- package/dist/index.js +57 -31
- package/dist/index.js.map +1 -1
- package/dist-esm/src/Clients.js +30 -10
- package/dist-esm/src/Clients.js.map +1 -1
- package/dist-esm/src/Range.js.map +1 -1
- package/dist-esm/src/SASQueryParameters.js +1 -1
- package/dist-esm/src/SASQueryParameters.js.map +1 -1
- package/dist-esm/src/ShareClientInternal.js +1 -1
- package/dist-esm/src/ShareClientInternal.js.map +1 -1
- package/dist-esm/src/ShareSASPermissions.js.map +1 -1
- package/dist-esm/src/ShareServiceClient.js +8 -2
- package/dist-esm/src/ShareServiceClient.js.map +1 -1
- package/dist-esm/src/credentials/Credential.js +1 -5
- package/dist-esm/src/credentials/Credential.js.map +1 -1
- package/dist-esm/src/generated/src/storageClientContext.js +1 -1
- package/dist-esm/src/generated/src/storageClientContext.js.map +1 -1
- package/dist-esm/src/generatedModels.js.map +1 -1
- package/dist-esm/src/models.js.map +1 -1
- package/dist-esm/src/policies/AnonymousCredentialPolicy.js +2 -0
- package/dist-esm/src/policies/AnonymousCredentialPolicy.js.map +1 -1
- package/dist-esm/src/policies/StorageBrowserPolicy.js +2 -0
- package/dist-esm/src/policies/StorageBrowserPolicy.js.map +1 -1
- package/dist-esm/src/policies/StorageRetryPolicy.js +1 -1
- 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/utils/RetriableReadableStream.js +2 -3
- package/dist-esm/src/utils/RetriableReadableStream.js.map +1 -1
- package/dist-esm/src/utils/constants.js +1 -1
- package/dist-esm/src/utils/constants.js.map +1 -1
- package/dist-esm/src/utils/tracing.js +1 -0
- package/dist-esm/src/utils/tracing.js.map +1 -1
- package/dist-esm/src/utils/utils.browser.js +12 -4
- package/dist-esm/src/utils/utils.browser.js.map +1 -1
- package/dist-esm/src/utils/utils.common.js +5 -30
- package/dist-esm/src/utils/utils.common.js.map +1 -1
- package/package.json +12 -13
- package/typings/3.1/storage-file-share.d.ts +16 -15
- package/typings/latest/storage-file-share.d.ts +28 -16
@@ -1,5 +1,6 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import { AbortSignalLike } from '@azure/abort-controller';
|
3
|
+
import { AzureLogger } from '@azure/logger';
|
3
4
|
import { BaseRequestPolicy } from '@azure/core-http';
|
4
5
|
import * as coreHttp from '@azure/core-http';
|
5
6
|
import { deserializationPolicy } from '@azure/core-http';
|
@@ -224,7 +225,7 @@ export declare interface AccountSASSignatureValues {
|
|
224
225
|
* HTTP(S) requests that read public resources or for use with Shared Access
|
225
226
|
* Signatures (SAS).
|
226
227
|
*/
|
227
|
-
export declare class AnonymousCredential extends
|
228
|
+
export declare class AnonymousCredential extends Credential_2 {
|
228
229
|
/**
|
229
230
|
* Creates an {@link AnonymousCredentialPolicy} object.
|
230
231
|
*
|
@@ -352,7 +353,7 @@ export declare interface CorsRule {
|
|
352
353
|
* Credential is an abstract class for Azure Storage HTTP requests signing. This
|
353
354
|
* class will host an credentialPolicyCreator factory which generates CredentialPolicy.
|
354
355
|
*/
|
355
|
-
|
356
|
+
declare abstract class Credential_2 implements RequestPolicyFactory {
|
356
357
|
/**
|
357
358
|
* Creates a RequestPolicy object.
|
358
359
|
*
|
@@ -361,6 +362,7 @@ export declare abstract class Credential implements RequestPolicyFactory {
|
|
361
362
|
*/
|
362
363
|
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
|
363
364
|
}
|
365
|
+
export { Credential_2 as Credential };
|
364
366
|
/**
|
365
367
|
* Credential policy used to sign HTTP(S) requests before sending. This is an
|
366
368
|
* abstract class.
|
@@ -1477,7 +1479,7 @@ export declare interface FileGetRangeListOptions extends CommonOptions {
|
|
1477
1479
|
/**
|
1478
1480
|
* Optional. Specifies the range of bytes over which to list ranges, inclusively.
|
1479
1481
|
*/
|
1480
|
-
range?:
|
1482
|
+
range?: Range_2;
|
1481
1483
|
/**
|
1482
1484
|
* Lease access conditions.
|
1483
1485
|
*/
|
@@ -2253,7 +2255,7 @@ export declare interface HttpAuthorization {
|
|
2253
2255
|
/**
|
2254
2256
|
* the credentials containing the authentication information of the user agent for the resource being requested.
|
2255
2257
|
*/
|
2256
|
-
|
2258
|
+
value: string;
|
2257
2259
|
}
|
2258
2260
|
export { HttpHeaders };
|
2259
2261
|
export { HttpOperationResponse };
|
@@ -2350,8 +2352,6 @@ export declare interface ListFilesAndDirectoriesSegmentResponse {
|
|
2350
2352
|
continuationToken: string;
|
2351
2353
|
directoryId?: string;
|
2352
2354
|
}
|
2353
|
-
/** Defines values for ListFilesIncludeType. */
|
2354
|
-
export declare type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
|
2355
2355
|
/** An enumeration of handles. */
|
2356
2356
|
export declare interface ListHandlesResponse {
|
2357
2357
|
handleList?: HandleItem[];
|
@@ -2382,7 +2382,7 @@ export declare interface ListSharesResponseModel {
|
|
2382
2382
|
/**
|
2383
2383
|
* The `@azure/logger` configuration for this package.
|
2384
2384
|
*/
|
2385
|
-
export declare const logger:
|
2385
|
+
export declare const logger: AzureLogger;
|
2386
2386
|
export declare interface Metadata {
|
2387
2387
|
[propertyName: string]: string;
|
2388
2388
|
}
|
@@ -2404,7 +2404,7 @@ export declare interface Metrics {
|
|
2404
2404
|
* @param pipelineOptions - Optional. Options.
|
2405
2405
|
* @returns A new Pipeline object.
|
2406
2406
|
*/
|
2407
|
-
export declare function newPipeline(credential?:
|
2407
|
+
export declare function newPipeline(credential?: Credential_2, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
2408
2408
|
/** Defines values for PermissionCopyModeType. */
|
2409
2409
|
export declare type PermissionCopyModeType = "source" | "override";
|
2410
2410
|
/**
|
@@ -2452,7 +2452,7 @@ export declare interface PipelineOptions {
|
|
2452
2452
|
* Range for Service Operations.
|
2453
2453
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
|
2454
2454
|
*/
|
2455
|
-
|
2455
|
+
declare interface Range_2 {
|
2456
2456
|
/**
|
2457
2457
|
* StartByte, larger than or equal 0.
|
2458
2458
|
*/
|
@@ -2463,6 +2463,7 @@ export declare interface Range {
|
|
2463
2463
|
*/
|
2464
2464
|
count?: number;
|
2465
2465
|
}
|
2466
|
+
export { Range_2 as Range };
|
2466
2467
|
/** An Azure Storage file range. */
|
2467
2468
|
export declare interface RangeModel {
|
2468
2469
|
/** Start of the range. */
|
@@ -2512,7 +2513,7 @@ export declare enum SASProtocol {
|
|
2512
2513
|
/**
|
2513
2514
|
* Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
|
2514
2515
|
* by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link FileSASSignatureValues}
|
2515
|
-
* types. Once generated, it can be encoded into a {@
|
2516
|
+
* types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
|
2516
2517
|
* be taken here in case there are existing query parameters, which might affect the appropriate means of appending
|
2517
2518
|
* these query parameters).
|
2518
2519
|
*
|
@@ -2809,7 +2810,7 @@ export declare class ShareClient extends StorageClient {
|
|
2809
2810
|
* If not specified, AnonymousCredential is used.
|
2810
2811
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
2811
2812
|
*/
|
2812
|
-
constructor(url: string, credential?:
|
2813
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
2813
2814
|
/**
|
2814
2815
|
* Creates an instance of ShareClient.
|
2815
2816
|
*
|
@@ -3272,7 +3273,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3272
3273
|
* If not specified, AnonymousCredential is used.
|
3273
3274
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3274
3275
|
*/
|
3275
|
-
constructor(url: string, credential?:
|
3276
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
3276
3277
|
/**
|
3277
3278
|
* Creates an instance of DirectoryClient.
|
3278
3279
|
*
|
@@ -3752,7 +3753,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
3752
3753
|
* If not specified, AnonymousCredential is used.
|
3753
3754
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3754
3755
|
*/
|
3755
|
-
constructor(url: string, credential?:
|
3756
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
3756
3757
|
/**
|
3757
3758
|
* Creates an instance of ShareFileClient.
|
3758
3759
|
*
|
@@ -4700,7 +4701,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
4700
4701
|
* If not specified, AnonymousCredential is used.
|
4701
4702
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4702
4703
|
*/
|
4703
|
-
constructor(url: string, credential?:
|
4704
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
4704
4705
|
/**
|
4705
4706
|
* Creates an instance of ShareServiceClient.
|
4706
4707
|
*
|
@@ -5331,7 +5332,7 @@ export declare enum StorageRetryPolicyType {
|
|
5331
5332
|
*
|
5332
5333
|
* StorageSharedKeyCredential for account key authorization of Azure Storage service.
|
5333
5334
|
*/
|
5334
|
-
export declare class StorageSharedKeyCredential extends
|
5335
|
+
export declare class StorageSharedKeyCredential extends Credential_2 {
|
5335
5336
|
/**
|
5336
5337
|
* Azure Storage account name; readonly.
|
5337
5338
|
*/
|
@@ -1,5 +1,7 @@
|
|
1
1
|
/// <reference types="node" />
|
2
|
+
|
2
3
|
import { AbortSignalLike } from '@azure/abort-controller';
|
4
|
+
import { AzureLogger } from '@azure/logger';
|
3
5
|
import { BaseRequestPolicy } from '@azure/core-http';
|
4
6
|
import * as coreHttp from '@azure/core-http';
|
5
7
|
import { deserializationPolicy } from '@azure/core-http';
|
@@ -230,7 +232,7 @@ export declare interface AccountSASSignatureValues {
|
|
230
232
|
* HTTP(S) requests that read public resources or for use with Shared Access
|
231
233
|
* Signatures (SAS).
|
232
234
|
*/
|
233
|
-
export declare class AnonymousCredential extends
|
235
|
+
export declare class AnonymousCredential extends Credential_2 {
|
234
236
|
/**
|
235
237
|
* Creates an {@link AnonymousCredentialPolicy} object.
|
236
238
|
*
|
@@ -252,6 +254,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
252
254
|
*/
|
253
255
|
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
254
256
|
}
|
257
|
+
|
255
258
|
export { BaseRequestPolicy }
|
256
259
|
|
257
260
|
export declare interface ClearRange {
|
@@ -367,7 +370,7 @@ export declare interface CorsRule {
|
|
367
370
|
* Credential is an abstract class for Azure Storage HTTP requests signing. This
|
368
371
|
* class will host an credentialPolicyCreator factory which generates CredentialPolicy.
|
369
372
|
*/
|
370
|
-
|
373
|
+
declare abstract class Credential_2 implements RequestPolicyFactory {
|
371
374
|
/**
|
372
375
|
* Creates a RequestPolicy object.
|
373
376
|
*
|
@@ -376,6 +379,7 @@ export declare abstract class Credential implements RequestPolicyFactory {
|
|
376
379
|
*/
|
377
380
|
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
|
378
381
|
}
|
382
|
+
export { Credential_2 as Credential }
|
379
383
|
|
380
384
|
/**
|
381
385
|
* Credential policy used to sign HTTP(S) requests before sending. This is an
|
@@ -404,6 +408,7 @@ export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, option
|
|
404
408
|
|
405
409
|
/** Defines values for DeleteSnapshotsOptionType. */
|
406
410
|
export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
|
411
|
+
|
407
412
|
export { deserializationPolicy }
|
408
413
|
|
409
414
|
/**
|
@@ -1557,7 +1562,7 @@ export declare interface FileGetRangeListOptions extends CommonOptions {
|
|
1557
1562
|
/**
|
1558
1563
|
* Optional. Specifies the range of bytes over which to list ranges, inclusively.
|
1559
1564
|
*/
|
1560
|
-
range?:
|
1565
|
+
range?: Range_2;
|
1561
1566
|
/**
|
1562
1567
|
* Lease access conditions.
|
1563
1568
|
*/
|
@@ -2373,11 +2378,15 @@ export declare interface HttpAuthorization {
|
|
2373
2378
|
/**
|
2374
2379
|
* the credentials containing the authentication information of the user agent for the resource being requested.
|
2375
2380
|
*/
|
2376
|
-
|
2381
|
+
value: string;
|
2377
2382
|
}
|
2383
|
+
|
2378
2384
|
export { HttpHeaders }
|
2385
|
+
|
2379
2386
|
export { HttpOperationResponse }
|
2387
|
+
|
2380
2388
|
export { HttpRequestBody }
|
2389
|
+
|
2381
2390
|
export { IHttpClient }
|
2382
2391
|
|
2383
2392
|
/** Parameter group */
|
@@ -2479,9 +2488,6 @@ export declare interface ListFilesAndDirectoriesSegmentResponse {
|
|
2479
2488
|
directoryId?: string;
|
2480
2489
|
}
|
2481
2490
|
|
2482
|
-
/** Defines values for ListFilesIncludeType. */
|
2483
|
-
export declare type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
|
2484
|
-
|
2485
2491
|
/** An enumeration of handles. */
|
2486
2492
|
export declare interface ListHandlesResponse {
|
2487
2493
|
handleList?: HandleItem[];
|
@@ -2516,7 +2522,7 @@ export declare interface ListSharesResponseModel {
|
|
2516
2522
|
/**
|
2517
2523
|
* The `@azure/logger` configuration for this package.
|
2518
2524
|
*/
|
2519
|
-
export declare const logger:
|
2525
|
+
export declare const logger: AzureLogger;
|
2520
2526
|
|
2521
2527
|
export declare interface Metadata {
|
2522
2528
|
[propertyName: string]: string;
|
@@ -2541,7 +2547,7 @@ export declare interface Metrics {
|
|
2541
2547
|
* @param pipelineOptions - Optional. Options.
|
2542
2548
|
* @returns A new Pipeline object.
|
2543
2549
|
*/
|
2544
|
-
export declare function newPipeline(credential?:
|
2550
|
+
export declare function newPipeline(credential?: Credential_2, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
2545
2551
|
|
2546
2552
|
/** Defines values for PermissionCopyModeType. */
|
2547
2553
|
export declare type PermissionCopyModeType = "source" | "override";
|
@@ -2593,7 +2599,7 @@ export declare interface PipelineOptions {
|
|
2593
2599
|
* Range for Service Operations.
|
2594
2600
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
|
2595
2601
|
*/
|
2596
|
-
|
2602
|
+
declare interface Range_2 {
|
2597
2603
|
/**
|
2598
2604
|
* StartByte, larger than or equal 0.
|
2599
2605
|
*/
|
@@ -2604,6 +2610,7 @@ export declare interface Range {
|
|
2604
2610
|
*/
|
2605
2611
|
count?: number;
|
2606
2612
|
}
|
2613
|
+
export { Range_2 as Range }
|
2607
2614
|
|
2608
2615
|
/** An Azure Storage file range. */
|
2609
2616
|
export declare interface RangeModel {
|
@@ -2612,9 +2619,13 @@ export declare interface RangeModel {
|
|
2612
2619
|
/** End of the range. */
|
2613
2620
|
end: number;
|
2614
2621
|
}
|
2622
|
+
|
2615
2623
|
export { RequestPolicy }
|
2624
|
+
|
2616
2625
|
export { RequestPolicyFactory }
|
2626
|
+
|
2617
2627
|
export { RequestPolicyOptions }
|
2628
|
+
|
2618
2629
|
export { RestError }
|
2619
2630
|
|
2620
2631
|
/** The retention policy. */
|
@@ -2658,7 +2669,7 @@ export declare enum SASProtocol {
|
|
2658
2669
|
/**
|
2659
2670
|
* Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
|
2660
2671
|
* by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link FileSASSignatureValues}
|
2661
|
-
* types. Once generated, it can be encoded into a {@
|
2672
|
+
* types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
|
2662
2673
|
* be taken here in case there are existing query parameters, which might affect the appropriate means of appending
|
2663
2674
|
* these query parameters).
|
2664
2675
|
*
|
@@ -2977,7 +2988,7 @@ export declare class ShareClient extends StorageClient {
|
|
2977
2988
|
* If not specified, AnonymousCredential is used.
|
2978
2989
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
2979
2990
|
*/
|
2980
|
-
constructor(url: string, credential?:
|
2991
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
2981
2992
|
/**
|
2982
2993
|
* Creates an instance of ShareClient.
|
2983
2994
|
*
|
@@ -3470,7 +3481,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3470
3481
|
* If not specified, AnonymousCredential is used.
|
3471
3482
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3472
3483
|
*/
|
3473
|
-
constructor(url: string, credential?:
|
3484
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
3474
3485
|
/**
|
3475
3486
|
* Creates an instance of DirectoryClient.
|
3476
3487
|
*
|
@@ -3961,7 +3972,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
3961
3972
|
* If not specified, AnonymousCredential is used.
|
3962
3973
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3963
3974
|
*/
|
3964
|
-
constructor(url: string, credential?:
|
3975
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
3965
3976
|
/**
|
3966
3977
|
* Creates an instance of ShareFileClient.
|
3967
3978
|
*
|
@@ -4946,7 +4957,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
4946
4957
|
* If not specified, AnonymousCredential is used.
|
4947
4958
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4948
4959
|
*/
|
4949
|
-
constructor(url: string, credential?:
|
4960
|
+
constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
|
4950
4961
|
/**
|
4951
4962
|
* Creates an instance of ShareServiceClient.
|
4952
4963
|
*
|
@@ -5606,7 +5617,7 @@ export declare enum StorageRetryPolicyType {
|
|
5606
5617
|
*
|
5607
5618
|
* StorageSharedKeyCredential for account key authorization of Azure Storage service.
|
5608
5619
|
*/
|
5609
|
-
export declare class StorageSharedKeyCredential extends
|
5620
|
+
export declare class StorageSharedKeyCredential extends Credential_2 {
|
5610
5621
|
/**
|
5611
5622
|
* Azure Storage account name; readonly.
|
5612
5623
|
*/
|
@@ -5696,6 +5707,7 @@ export declare type TimeNowType = "now";
|
|
5696
5707
|
* Indicates keep existing time value unchanged.
|
5697
5708
|
*/
|
5698
5709
|
export declare type TimePreserveType = "preserve";
|
5710
|
+
|
5699
5711
|
export { WebResource }
|
5700
5712
|
|
5701
5713
|
export { }
|