@fluidframework/driver-utils 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409

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.
Files changed (12) hide show
  1. package/api-report/driver-utils.alpha.api.md +75 -0
  2. package/api-report/driver-utils.beta.api.md +62 -0
  3. package/api-report/driver-utils.public.api.md +62 -0
  4. package/dist/packageVersion.d.ts +1 -1
  5. package/dist/packageVersion.js +1 -1
  6. package/dist/packageVersion.js.map +1 -1
  7. package/lib/packageVersion.d.ts +1 -1
  8. package/lib/packageVersion.js +1 -1
  9. package/lib/packageVersion.js.map +1 -1
  10. package/package.json +9 -9
  11. package/src/packageVersion.ts +1 -1
  12. package/api-report/driver-utils.api.md +0 -408
package/api-report/driver-utils.alpha.api.md ADDED
@@ -0,0 +1,75 @@
1
+ ## Alpha API Report File for "@fluidframework/driver-utils"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { FetchSource } from '@fluidframework/driver-definitions/internal';
8
+ import { IAttachment } from '@fluidframework/driver-definitions/internal';
9
+ import { IAuthorizationError } from '@fluidframework/driver-definitions/internal';
10
+ import { IBlob } from '@fluidframework/driver-definitions/internal';
11
+ import { ICommittedProposal } from '@fluidframework/driver-definitions/internal';
12
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
13
+ import { IDeltasFetchResult } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentAttributes } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
19
+ import { IDriverErrorBase } from '@fluidframework/driver-definitions/internal';
20
+ import { IFluidErrorBase } from '@fluidframework/telemetry-utils/internal';
21
+ import { ILocationRedirectionError } from '@fluidframework/driver-definitions/internal';
22
+ import { IRequest } from '@fluidframework/core-interfaces';
23
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
24
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
25
+ import { ISnapshot } from '@fluidframework/driver-definitions/internal';
26
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions/internal';
27
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
28
+ import { IStream } from '@fluidframework/driver-definitions/internal';
29
+ import { IStreamResult } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
31
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
32
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
33
+ import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
34
+ import type { ITelemetryErrorEventExt } from '@fluidframework/telemetry-utils/internal';
35
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
36
+ import { IThrottlingWarning } from '@fluidframework/driver-definitions/internal';
37
+ import { ITree } from '@fluidframework/driver-definitions/internal';
38
+ import { ITreeEntry } from '@fluidframework/driver-definitions/internal';
39
+ import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
40
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
41
+ import { LoaderCachingPolicy } from '@fluidframework/driver-definitions/internal';
42
+ import { LoggingError } from '@fluidframework/telemetry-utils/internal';
43
+
44
+ // @public (undocumented)
45
+ export interface ICompressionStorageConfig {
46
+ // (undocumented)
47
+ algorithm: SummaryCompressionAlgorithm;
48
+ // (undocumented)
49
+ minSizeToCompress: number;
50
+ }
51
+
52
+ // @alpha (undocumented)
53
+ export class RateLimiter {
54
+ constructor(maxRequests: number);
55
+ // (undocumented)
56
+ protected acquire(): Promise<void>;
57
+ // (undocumented)
58
+ protected readonly release: () => void;
59
+ // (undocumented)
60
+ schedule<T>(work: () => Promise<T>): Promise<T>;
61
+ // (undocumented)
62
+ get waitQueueLength(): number;
63
+ }
64
+
65
+ // @public (undocumented)
66
+ export enum SummaryCompressionAlgorithm {
67
+ // (undocumented)
68
+ LZ4 = 1,
69
+ // (undocumented)
70
+ None = 0
71
+ }
72
+
73
+ // (No @packageDocumentation comment for this package)
74
+
75
+ ```
package/api-report/driver-utils.beta.api.md ADDED
@@ -0,0 +1,62 @@
1
+ ## Beta API Report File for "@fluidframework/driver-utils"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { FetchSource } from '@fluidframework/driver-definitions/internal';
8
+ import { IAttachment } from '@fluidframework/driver-definitions/internal';
9
+ import { IAuthorizationError } from '@fluidframework/driver-definitions/internal';
10
+ import { IBlob } from '@fluidframework/driver-definitions/internal';
11
+ import { ICommittedProposal } from '@fluidframework/driver-definitions/internal';
12
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
13
+ import { IDeltasFetchResult } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentAttributes } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
19
+ import { IDriverErrorBase } from '@fluidframework/driver-definitions/internal';
20
+ import { IFluidErrorBase } from '@fluidframework/telemetry-utils/internal';
21
+ import { ILocationRedirectionError } from '@fluidframework/driver-definitions/internal';
22
+ import { IRequest } from '@fluidframework/core-interfaces';
23
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
24
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
25
+ import { ISnapshot } from '@fluidframework/driver-definitions/internal';
26
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions/internal';
27
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
28
+ import { IStream } from '@fluidframework/driver-definitions/internal';
29
+ import { IStreamResult } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
31
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
32
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
33
+ import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
34
+ import type { ITelemetryErrorEventExt } from '@fluidframework/telemetry-utils/internal';
35
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
36
+ import { IThrottlingWarning } from '@fluidframework/driver-definitions/internal';
37
+ import { ITree } from '@fluidframework/driver-definitions/internal';
38
+ import { ITreeEntry } from '@fluidframework/driver-definitions/internal';
39
+ import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
40
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
41
+ import { LoaderCachingPolicy } from '@fluidframework/driver-definitions/internal';
42
+ import { LoggingError } from '@fluidframework/telemetry-utils/internal';
43
+
44
+ // @public (undocumented)
45
+ export interface ICompressionStorageConfig {
46
+ // (undocumented)
47
+ algorithm: SummaryCompressionAlgorithm;
48
+ // (undocumented)
49
+ minSizeToCompress: number;
50
+ }
51
+
52
+ // @public (undocumented)
53
+ export enum SummaryCompressionAlgorithm {
54
+ // (undocumented)
55
+ LZ4 = 1,
56
+ // (undocumented)
57
+ None = 0
58
+ }
59
+
60
+ // (No @packageDocumentation comment for this package)
61
+
62
+ ```
package/api-report/driver-utils.public.api.md ADDED
@@ -0,0 +1,62 @@
1
+ ## Public API Report File for "@fluidframework/driver-utils"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { FetchSource } from '@fluidframework/driver-definitions/internal';
8
+ import { IAttachment } from '@fluidframework/driver-definitions/internal';
9
+ import { IAuthorizationError } from '@fluidframework/driver-definitions/internal';
10
+ import { IBlob } from '@fluidframework/driver-definitions/internal';
11
+ import { ICommittedProposal } from '@fluidframework/driver-definitions/internal';
12
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
13
+ import { IDeltasFetchResult } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentAttributes } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
19
+ import { IDriverErrorBase } from '@fluidframework/driver-definitions/internal';
20
+ import { IFluidErrorBase } from '@fluidframework/telemetry-utils/internal';
21
+ import { ILocationRedirectionError } from '@fluidframework/driver-definitions/internal';
22
+ import { IRequest } from '@fluidframework/core-interfaces';
23
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
24
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
25
+ import { ISnapshot } from '@fluidframework/driver-definitions/internal';
26
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions/internal';
27
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
28
+ import { IStream } from '@fluidframework/driver-definitions/internal';
29
+ import { IStreamResult } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
31
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
32
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
33
+ import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
34
+ import type { ITelemetryErrorEventExt } from '@fluidframework/telemetry-utils/internal';
35
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
36
+ import { IThrottlingWarning } from '@fluidframework/driver-definitions/internal';
37
+ import { ITree } from '@fluidframework/driver-definitions/internal';
38
+ import { ITreeEntry } from '@fluidframework/driver-definitions/internal';
39
+ import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
40
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
41
+ import { LoaderCachingPolicy } from '@fluidframework/driver-definitions/internal';
42
+ import { LoggingError } from '@fluidframework/telemetry-utils/internal';
43
+
44
+ // @public (undocumented)
45
+ export interface ICompressionStorageConfig {
46
+ // (undocumented)
47
+ algorithm: SummaryCompressionAlgorithm;
48
+ // (undocumented)
49
+ minSizeToCompress: number;
50
+ }
51
+
52
+ // @public (undocumented)
53
+ export enum SummaryCompressionAlgorithm {
54
+ // (undocumented)
55
+ LZ4 = 1,
56
+ // (undocumented)
57
+ None = 0
58
+ }
59
+
60
+ // (No @packageDocumentation comment for this package)
61
+
62
+ ```
package/dist/packageVersion.d.ts CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/driver-utils";
8
- export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.267932";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.268409";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
package/dist/packageVersion.js CHANGED
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/driver-utils";
11
- exports.pkgVersion = "2.0.0-dev-rc.5.0.0.267932";
11
+ exports.pkgVersion = "2.0.0-dev-rc.5.0.0.268409";
12
12
  //# sourceMappingURL=packageVersion.js.map
package/dist/packageVersion.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.267932\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.268409\";\n"]}
package/lib/packageVersion.d.ts CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/driver-utils";
8
- export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.267932";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.268409";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
package/lib/packageVersion.js CHANGED
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/driver-utils";
8
- export const pkgVersion = "2.0.0-dev-rc.5.0.0.267932";
8
+ export const pkgVersion = "2.0.0-dev-rc.5.0.0.268409";
9
9
  //# sourceMappingURL=packageVersion.js.map
package/lib/packageVersion.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.267932\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-utils\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.268409\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/driver-utils",
3
- "version": "2.0.0-dev-rc.5.0.0.267932",
3
+ "version": "2.0.0-dev-rc.5.0.0.268409",
4
4
  "description": "Collection of utility functions for Fluid drivers",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,25 +67,25 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.267932",
71
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.267932",
72
- "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.267932",
73
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.267932",
70
+ "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.268409",
71
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
72
+ "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
73
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
74
74
  "@fluidframework/protocol-base": "^4.0.0",
75
- "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.267932",
75
+ "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.268409",
76
76
  "axios": "^1.6.2",
77
77
  "lz4js": "^0.2.0",
78
78
  "uuid": "^9.0.0"
79
79
  },
80
80
  "devDependencies": {
81
81
  "@arethetypeswrong/cli": "^0.15.2",
82
- "@biomejs/biome": "^1.6.2",
83
- "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.267932",
82
+ "@biomejs/biome": "^1.7.3",
83
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.268409",
84
84
  "@fluid-tools/build-cli": "^0.39.0-264124",
85
85
  "@fluidframework/build-common": "^2.0.3",
86
86
  "@fluidframework/build-tools": "^0.39.0-264124",
87
87
  "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-rc.4.0.0",
88
- "@fluidframework/eslint-config-fluid": "^5.1.0",
88
+ "@fluidframework/eslint-config-fluid": "^5.3.0",
89
89
  "@microsoft/api-extractor": "^7.45.1",
90
90
  "@types/mocha": "^9.1.1",
91
91
  "@types/node": "^18.19.0",
package/src/packageVersion.ts CHANGED
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/driver-utils";
9
- export const pkgVersion = "2.0.0-dev-rc.5.0.0.267932";
9
+ export const pkgVersion = "2.0.0-dev-rc.5.0.0.268409";
package/api-report/driver-utils.api.md DELETED
@@ -1,408 +0,0 @@
1
- ## API Report File for "@fluidframework/driver-utils"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { FetchSource } from '@fluidframework/driver-definitions/internal';
8
- import { IAttachment } from '@fluidframework/driver-definitions/internal';
9
- import { IAuthorizationError } from '@fluidframework/driver-definitions/internal';
10
- import { IBlob } from '@fluidframework/driver-definitions/internal';
11
- import { ICommittedProposal } from '@fluidframework/driver-definitions/internal';
12
- import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
13
- import { IDeltasFetchResult } from '@fluidframework/driver-definitions/internal';
14
- import { IDocumentAttributes } from '@fluidframework/driver-definitions/internal';
15
- import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
17
- import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
18
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
19
- import { IDriverErrorBase } from '@fluidframework/driver-definitions/internal';
20
- import { IFluidErrorBase } from '@fluidframework/telemetry-utils/internal';
21
- import { ILocationRedirectionError } from '@fluidframework/driver-definitions/internal';
22
- import { IRequest } from '@fluidframework/core-interfaces';
23
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
24
- import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
25
- import { ISnapshot } from '@fluidframework/driver-definitions/internal';
26
- import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions/internal';
27
- import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
28
- import { IStream } from '@fluidframework/driver-definitions/internal';
29
- import { IStreamResult } from '@fluidframework/driver-definitions/internal';
30
- import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
31
- import { ISummaryHandle } from '@fluidframework/driver-definitions';
32
- import { ISummaryTree } from '@fluidframework/driver-definitions';
33
- import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
34
- import type { ITelemetryErrorEventExt } from '@fluidframework/telemetry-utils/internal';
35
- import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
36
- import { IThrottlingWarning } from '@fluidframework/driver-definitions/internal';
37
- import { ITree } from '@fluidframework/driver-definitions/internal';
38
- import { ITreeEntry } from '@fluidframework/driver-definitions/internal';
39
- import { IUrlResolver } from '@fluidframework/driver-definitions/internal';
40
- import { IVersion } from '@fluidframework/driver-definitions/internal';
41
- import { LoaderCachingPolicy } from '@fluidframework/driver-definitions/internal';
42
- import { LoggingError } from '@fluidframework/telemetry-utils/internal';
43
-
44
- // @internal
45
- export function applyStorageCompression(documentServiceFactory: IDocumentServiceFactory, config?: ICompressionStorageConfig | boolean): IDocumentServiceFactory;
46
-
47
- // @internal
48
- export class AttachmentTreeEntry {
49
- constructor(path: string, id: string);
50
- // (undocumented)
51
- readonly id: string;
52
- // (undocumented)
53
- readonly mode = FileMode.File;
54
- // (undocumented)
55
- readonly path: string;
56
- // (undocumented)
57
- readonly type = TreeEntry.Attachment;
58
- // (undocumented)
59
- readonly value: IAttachment;
60
- }
61
-
62
- // @internal (undocumented)
63
- export class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {
64
- constructor(message: string, claims: string | undefined, tenantId: string | undefined, props: DriverErrorTelemetryProps);
65
- // (undocumented)
66
- readonly canRetry = false;
67
- // (undocumented)
68
- readonly claims: string | undefined;
69
- // (undocumented)
70
- readonly errorType: "authorizationError";
71
- // (undocumented)
72
- readonly tenantId: string | undefined;
73
- }
74
-
75
- // @internal (undocumented)
76
- export const blobHeadersBlobName = ".metadata.blobHeaders";
77
-
78
- // @internal
79
- export class BlobTreeEntry {
80
- constructor(path: string, contents: string, encoding?: "utf-8" | "base64");
81
- // (undocumented)
82
- readonly mode = FileMode.File;
83
- // (undocumented)
84
- readonly path: string;
85
- // (undocumented)
86
- readonly type = TreeEntry.Blob;
87
- // (undocumented)
88
- readonly value: IBlob;
89
- }
90
-
91
- // @internal
92
- export function buildSnapshotTree(entries: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): ISnapshotTree;
93
-
94
- // @internal
95
- export function calculateMaxWaitTime(delayMs: number, error: unknown): number;
96
-
97
- // @internal (undocumented)
98
- export function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
99
-
100
- // @internal
101
- export const canRetryOnError: (error: any) => boolean;
102
-
103
- // @internal
104
- export interface CombinedAppAndProtocolSummary extends ISummaryTree {
105
- // (undocumented)
106
- tree: {
107
- [".app"]: ISummaryTree;
108
- [".protocol"]: ISummaryTree;
109
- };
110
- }
111
-
112
- // @internal
113
- export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree;
114
-
115
- // @internal (undocumented)
116
- export function createGenericNetworkError(message: string, retryInfo: {
117
- canRetry: boolean;
118
- retryAfterMs?: number;
119
- }, props: DriverErrorTelemetryProps): ThrottlingError | GenericNetworkError;
120
-
121
- // @internal (undocumented)
122
- export const createWriteError: (message: string, props: DriverErrorTelemetryProps) => NonRetryableError<"writeError">;
123
-
124
- // @internal (undocumented)
125
- export class DeltaStreamConnectionForbiddenError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
126
- constructor(message: string, props: DriverErrorTelemetryProps, storageOnlyReason?: string);
127
- // (undocumented)
128
- readonly canRetry = false;
129
- // (undocumented)
130
- static readonly errorType: "deltaStreamConnectionForbidden";
131
- // (undocumented)
132
- readonly errorType: "deltaStreamConnectionForbidden";
133
- // (undocumented)
134
- readonly storageOnlyReason: string | undefined;
135
- }
136
-
137
- // @internal (undocumented)
138
- export class DocumentStorageServiceProxy implements IDocumentStorageService {
139
- constructor(internalStorageService: IDocumentStorageService);
140
- // (undocumented)
141
- createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
142
- // (undocumented)
143
- downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
144
- // (undocumented)
145
- getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
146
- // (undocumented)
147
- getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
148
- // (undocumented)
149
- getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
150
- // (undocumented)
151
- protected readonly internalStorageService: IDocumentStorageService;
152
- set policies(policies: IDocumentStorageServicePolicies | undefined);
153
- // (undocumented)
154
- get policies(): IDocumentStorageServicePolicies | undefined;
155
- // (undocumented)
156
- readBlob(blobId: string): Promise<ArrayBufferLike>;
157
- // (undocumented)
158
- uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
159
- }
160
-
161
- // @internal
162
- export type DriverErrorTelemetryProps = ITelemetryBaseProperties & {
163
- driverVersion: string | undefined;
164
- };
165
-
166
- // @internal (undocumented)
167
- export const emptyMessageStream: IStream<ISequencedDocumentMessage[]>;
168
-
169
- // @internal
170
- export class FluidInvalidSchemaError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
171
- constructor(message: string, props: DriverErrorTelemetryProps);
172
- // (undocumented)
173
- readonly canRetry = false;
174
- // (undocumented)
175
- readonly errorType: "fluidInvalidSchema";
176
- }
177
-
178
- // @internal
179
- export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
180
- constructor(message: string, canRetry: boolean, props: DriverErrorTelemetryProps);
181
- // (undocumented)
182
- readonly canRetry: boolean;
183
- readonly errorType: "genericNetworkError";
184
- }
185
-
186
- // @internal
187
- export function getDocAttributesFromProtocolSummary(protocolSummary: ISummaryTree): IDocumentAttributes;
188
-
189
- // @internal
190
- export function getQuorumValuesFromProtocolSummary(protocolSummary: ISummaryTree): [string, ICommittedProposal][];
191
-
192
- // @internal
193
- export const getRetryDelayFromError: (error: any) => number | undefined;
194
-
195
- // @internal
196
- export const getRetryDelaySecondsFromError: (error: any) => number | undefined;
197
-
198
- // @internal
199
- export function getSnapshotTree(tree: ISnapshotTree | ISnapshot): ISnapshotTree;
200
-
201
- // @public (undocumented)
202
- export interface ICompressionStorageConfig {
203
- // (undocumented)
204
- algorithm: SummaryCompressionAlgorithm;
205
- // (undocumented)
206
- minSizeToCompress: number;
207
- }
208
-
209
- // @internal
210
- export class InsecureUrlResolver implements IUrlResolver {
211
- constructor(hostUrl: string, ordererUrl: string, storageUrl: string, deltaStreamUrl: string, tenantId: string, bearer: string, isForNodeTest?: boolean);
212
- // (undocumented)
213
- createCreateNewRequest(fileName?: string): IRequest;
214
- // (undocumented)
215
- getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
216
- // (undocumented)
217
- resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
218
- }
219
-
220
- // @internal
221
- export interface IProgress {
222
- cancel?: AbortSignal;
223
- onRetry?(delayInMs: number, error: any): void;
224
- }
225
-
226
- // @internal
227
- export function isCombinedAppAndProtocolSummary(summary: ISummaryTree | undefined, ...optionalRootTrees: string[]): summary is CombinedAppAndProtocolSummary;
228
-
229
- // @internal
230
- export function isInstanceOfISnapshot(obj: ISnapshotTree | ISnapshot | undefined): obj is ISnapshot;
231
-
232
- // @internal
233
- export function isOnline(): OnlineStatus;
234
-
235
- // @internal
236
- export function isRuntimeMessage(message: {
237
- type: string;
238
- }): boolean;
239
-
240
- // @internal (undocumented)
241
- export class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {
242
- constructor(message: string, redirectUrl: IResolvedUrl, props: DriverErrorTelemetryProps);
243
- // (undocumented)
244
- readonly canRetry = false;
245
- // (undocumented)
246
- readonly errorType: "locationRedirection";
247
- // (undocumented)
248
- readonly redirectUrl: IResolvedUrl;
249
- }
250
-
251
- // @internal (undocumented)
252
- export function logNetworkFailure(logger: ITelemetryLoggerExt, event: ITelemetryErrorEventExt, error?: any): void;
253
-
254
- // @internal (undocumented)
255
- export enum MessageType2 {
256
- // (undocumented)
257
- Accept = "accept"
258
- }
259
-
260
- // @internal (undocumented)
261
- export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
262
- constructor(message: string, errorType: T, canRetry: boolean, props: DriverErrorTelemetryProps);
263
- // (undocumented)
264
- readonly canRetry: boolean;
265
- // (undocumented)
266
- readonly errorType: T;
267
- }
268
-
269
- // @internal (undocumented)
270
- export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
271
- constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
272
- // (undocumented)
273
- readonly errorType: T;
274
- }
275
-
276
- // @internal (undocumented)
277
- export enum OnlineStatus {
278
- // (undocumented)
279
- Offline = 0,
280
- // (undocumented)
281
- Online = 1,
282
- // (undocumented)
283
- Unknown = 2
284
- }
285
-
286
- // @internal
287
- export class ParallelRequests<T> {
288
- constructor(from: number, to: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, requestCallback: (request: number, from: number, to: number, strongTo: boolean, props: ITelemetryBaseProperties) => Promise<{
289
- partial: boolean;
290
- cancel: boolean;
291
- payload: T[];
292
- }>, responseCallback: (payload: T[]) => void);
293
- // (undocumented)
294
- cancel(): void;
295
- // (undocumented)
296
- get canceled(): boolean;
297
- // (undocumented)
298
- run(concurrency: number): Promise<void>;
299
- }
300
-
301
- // @internal (undocumented)
302
- export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy {
303
- // (undocumented)
304
- getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
305
- // (undocumented)
306
- get policies(): {
307
- caching: LoaderCachingPolicy;
308
- maximumCacheDurationMs?: 432000000 | undefined;
309
- } | undefined;
310
- // (undocumented)
311
- readBlob(blobId: string): Promise<ArrayBufferLike>;
312
- // (undocumented)
313
- stopPrefetch(): void;
314
- }
315
-
316
- // @internal
317
- export class Queue<T> implements IStream<T> {
318
- // (undocumented)
319
- protected pushCore(value: Promise<IStreamResult<T>>): void;
320
- // (undocumented)
321
- pushDone(): void;
322
- // (undocumented)
323
- pushError(error: any): void;
324
- // (undocumented)
325
- pushValue(value: T): void;
326
- // (undocumented)
327
- read(): Promise<IStreamResult<T>>;
328
- }
329
-
330
- // @alpha (undocumented)
331
- export class RateLimiter {
332
- constructor(maxRequests: number);
333
- // (undocumented)
334
- protected acquire(): Promise<void>;
335
- // (undocumented)
336
- protected readonly release: () => void;
337
- // (undocumented)
338
- schedule<T>(work: () => Promise<T>): Promise<T>;
339
- // (undocumented)
340
- get waitQueueLength(): number;
341
- }
342
-
343
- // @internal
344
- export function readAndParse<T>(storage: Pick<IDocumentStorageService, "readBlob">, id: string): Promise<T>;
345
-
346
- // @internal
347
- export function requestOps(get: (from: number, to: number, telemetryProps: ITelemetryBaseProperties) => Promise<IDeltasFetchResult>, concurrency: number, fromTotal: number, toTotal: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, signal?: AbortSignal, scenarioName?: string): IStream<ISequencedDocumentMessage[]>;
348
-
349
- // @internal (undocumented)
350
- export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
351
- constructor(message: string, errorType: T, props: DriverErrorTelemetryProps);
352
- // (undocumented)
353
- readonly errorType: T;
354
- }
355
-
356
- // @internal (undocumented)
357
- export function runWithRetry<T>(api: (cancel?: AbortSignal) => Promise<T>, fetchCallName: string, logger: ITelemetryLoggerExt, progress: IProgress): Promise<T>;
358
-
359
- // @internal (undocumented)
360
- export function streamFromMessages(messagesArg: Promise<ISequencedDocumentMessage[]>): IStream<ISequencedDocumentMessage[]>;
361
-
362
- // @internal (undocumented)
363
- export function streamObserver<T>(stream: IStream<T>, handler: (value: IStreamResult<T>) => void): IStream<T>;
364
-
365
- // @public (undocumented)
366
- export enum SummaryCompressionAlgorithm {
367
- // (undocumented)
368
- LZ4 = 1,
369
- // (undocumented)
370
- None = 0
371
- }
372
-
373
- // @internal
374
- export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
375
- constructor(message: string, retryAfterSeconds: number, props: DriverErrorTelemetryProps);
376
- // (undocumented)
377
- readonly canRetry = true;
378
- // (undocumented)
379
- readonly errorType: "throttlingError";
380
- // (undocumented)
381
- readonly retryAfterSeconds: number;
382
- }
383
-
384
- // @internal
385
- export class TreeTreeEntry {
386
- constructor(path: string, value: ITree);
387
- // (undocumented)
388
- readonly mode = FileMode.Directory;
389
- // (undocumented)
390
- readonly path: string;
391
- // (undocumented)
392
- readonly type = TreeEntry.Tree;
393
- // (undocumented)
394
- readonly value: ITree;
395
- }
396
-
397
- // @internal
398
- export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
399
- constructor(message: string);
400
- // (undocumented)
401
- readonly canRetry = false;
402
- // (undocumented)
403
- readonly errorType: "usageError";
404
- }
405
-
406
- // (No @packageDocumentation comment for this package)
407
-
408
- ```