@fluidframework/file-driver 2.0.0-internal.8.0.1 → 2.0.0-rc.1.0.0

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 CHANGED
@@ -1,5 +1,39 @@
1
1
  # @fluidframework/file-driver
2
2
 
3
+ ## 2.0.0-rc.1.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
8
+
9
+ The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
10
+
11
+ - @fluidframework/gitresources
12
+ - @fluidframework/server-kafka-orderer
13
+ - @fluidframework/server-lambdas
14
+ - @fluidframework/server-lambdas-driver
15
+ - @fluidframework/server-local-server
16
+ - @fluidframework/server-memory-orderer
17
+ - @fluidframework/protocol-base
18
+ - @fluidframework/server-routerlicious
19
+ - @fluidframework/server-routerlicious-base
20
+ - @fluidframework/server-services
21
+ - @fluidframework/server-services-client
22
+ - @fluidframework/server-services-core
23
+ - @fluidframework/server-services-ordering-kafkanode
24
+ - @fluidframework/server-services-ordering-rdkafka
25
+ - @fluidframework/server-services-ordering-zookeeper
26
+ - @fluidframework/server-services-shared
27
+ - @fluidframework/server-services-telemetry
28
+ - @fluidframework/server-services-utils
29
+ - @fluidframework/server-test-utils
30
+ - tinylicious
31
+
32
+ - Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
33
+
34
+ The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
35
+ changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
36
+
3
37
  ## 2.0.0-internal.8.0.0
4
38
 
5
39
  Dependency updates only.
package/README.md CHANGED
@@ -13,12 +13,6 @@ When taking a dependency on a Fluid Framework library, we recommend using a `^`
13
13
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
14
14
  library consumers should always prefer `^`.
15
15
 
16
- Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
17
- you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
18
- Standard `^` and `~` ranges will not work as expected.
19
- See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
20
- package for more information including tools to convert between version schemes.
21
-
22
16
  <!-- prettier-ignore-end -->
23
17
 
24
18
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -0,0 +1,5 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../common/build/build-common/api-extractor-base-esm.json",
4
+ "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
5
+ }
@@ -1,13 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-lint.json",
4
- "messages": {
5
- "extractorMessageReporting": {
6
- // TODO: remove once base config has this enabled as an error
7
- "ae-incompatible-release-tags": {
8
- "logLevel": "error",
9
- "addToApiReportFile": false
10
- }
11
- }
12
- }
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.json"
13
4
  }
@@ -1,12 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.json",
4
- "messages": {
5
- "extractorMessageReporting": {
6
- // TODO: Add missing documentation and remove this rule override
7
- "ae-undocumented": {
8
- "logLevel": "none"
9
- }
10
- }
11
- }
3
+ "extends": "../../../common/build/build-common/api-extractor-base.json"
12
4
  }
@@ -36,8 +36,6 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
36
36
 
37
37
  /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
38
38
 
39
- /* Excluded from this release type: IDisposable */
40
-
41
39
  /* Excluded from this release type: IDocumentDeltaConnection */
42
40
 
43
41
  /* Excluded from this release type: IDocumentDeltaConnectionEvents */
@@ -60,8 +58,6 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
60
58
 
61
59
  /* Excluded from this release type: ISummaryContext */
62
60
 
63
- /* Excluded from this release type: ITelemetryBaseLogger */
64
-
65
61
  /* Excluded from this release type: ReadDocumentStorageServiceBase */
66
62
 
67
63
  /* Excluded from this release type: ReaderConstructor */
@@ -70,6 +66,4 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
70
66
 
71
67
  /* Excluded from this release type: ReplayFileDeltaConnection */
72
68
 
73
- /* Excluded from this release type: TypedEventEmitter */
74
-
75
69
  export { }
@@ -36,8 +36,6 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
36
36
 
37
37
  /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
38
38
 
39
- /* Excluded from this release type: IDisposable */
40
-
41
39
  /* Excluded from this release type: IDocumentDeltaConnection */
42
40
 
43
41
  /* Excluded from this release type: IDocumentDeltaConnectionEvents */
@@ -60,8 +58,6 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
60
58
 
61
59
  /* Excluded from this release type: ISummaryContext */
62
60
 
63
- /* Excluded from this release type: ITelemetryBaseLogger */
64
-
65
61
  /* Excluded from this release type: ReadDocumentStorageServiceBase */
66
62
 
67
63
  /* Excluded from this release type: ReaderConstructor */
@@ -70,6 +66,4 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
70
66
 
71
67
  /* Excluded from this release type: ReplayFileDeltaConnection */
72
68
 
73
- /* Excluded from this release type: TypedEventEmitter */
74
-
75
69
  export { }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/file-driver",
3
- "version": "2.0.0-internal.8.0.1",
3
+ "version": "2.0.0-rc.1.0.0",
4
4
  "description": "A driver that reads/write from/to local file storage.",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,21 +15,21 @@
15
15
  "main": "dist/index.js",
16
16
  "types": "dist/index.d.ts",
17
17
  "dependencies": {
18
- "@fluid-internal/client-utils": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0",
19
- "@fluidframework/core-interfaces": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0",
20
- "@fluidframework/core-utils": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0",
21
- "@fluidframework/driver-definitions": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0",
22
- "@fluidframework/driver-utils": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0",
23
- "@fluidframework/protocol-definitions": "^3.0.0",
24
- "@fluidframework/replay-driver": ">=2.0.0-internal.8.0.1 <2.0.0-internal.8.1.0"
18
+ "@fluid-internal/client-utils": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
19
+ "@fluidframework/core-interfaces": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
20
+ "@fluidframework/core-utils": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
21
+ "@fluidframework/driver-definitions": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
22
+ "@fluidframework/driver-utils": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
23
+ "@fluidframework/protocol-definitions": "^3.1.0",
24
+ "@fluidframework/replay-driver": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0"
25
25
  },
26
26
  "devDependencies": {
27
27
  "@arethetypeswrong/cli": "^0.13.3",
28
- "@fluid-tools/build-cli": "^0.28.0",
28
+ "@fluid-tools/build-cli": "^0.29.0",
29
29
  "@fluidframework/build-common": "^2.0.3",
30
- "@fluidframework/build-tools": "^0.28.0",
31
- "@fluidframework/eslint-config-fluid": "^3.1.0",
32
- "@fluidframework/file-driver-previous": "npm:@fluidframework/file-driver@2.0.0-internal.7.2.0",
30
+ "@fluidframework/build-tools": "^0.29.0",
31
+ "@fluidframework/eslint-config-fluid": "^3.2.0",
32
+ "@fluidframework/file-driver-previous": "npm:@fluidframework/file-driver@2.0.0-internal.8.0.0",
33
33
  "@microsoft/api-extractor": "^7.38.3",
34
34
  "@types/node": "^18.19.0",
35
35
  "copyfiles": "^2.4.1",
@@ -43,8 +43,7 @@
43
43
  "build:docs": {
44
44
  "dependsOn": [
45
45
  "...",
46
- "api-extractor:commonjs",
47
- "api-extractor:esnext"
46
+ "api-extractor:commonjs"
48
47
  ],
49
48
  "script": false
50
49
  },
@@ -60,7 +59,6 @@
60
59
  "scripts": {
61
60
  "api": "fluid-build . --task api",
62
61
  "api-extractor:commonjs": "api-extractor run --local",
63
- "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
64
62
  "build": "fluid-build . --task build",
65
63
  "build:compile": "fluid-build . --task compile",
66
64
  "build:docs": "fluid-build . --task api",
@@ -1,51 +0,0 @@
1
- import * as api from '@fluidframework/protocol-definitions';
2
- import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
- import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
- import { IConnected } from '@fluidframework/protocol-definitions';
5
- import { IDisposable } from '@fluidframework/core-interfaces';
6
- import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
7
- import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
8
- import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
- import { IDocumentService } from '@fluidframework/driver-definitions';
11
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
13
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
- import { ISignalClient } from '@fluidframework/protocol-definitions';
18
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
26
-
27
- /* Excluded from this release type: FileDeltaStorageService */
28
-
29
- /* Excluded from this release type: FileDocumentServiceFactory */
30
-
31
- /* Excluded from this release type: FileSnapshotWriterClassFactory */
32
-
33
- /* Excluded from this release type: FileStorageDocumentName */
34
-
35
- /* Excluded from this release type: FluidFetchReader */
36
-
37
- /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
38
-
39
- /* Excluded from this release type: IFileSnapshot */
40
-
41
- /* Excluded from this release type: ISnapshotWriterStorage */
42
-
43
- /* Excluded from this release type: ReadDocumentStorageServiceBase */
44
-
45
- /* Excluded from this release type: ReaderConstructor */
46
-
47
- /* Excluded from this release type: Replayer */
48
-
49
- /* Excluded from this release type: ReplayFileDeltaConnection */
50
-
51
- export { }
@@ -1,75 +0,0 @@
1
- import * as api from '@fluidframework/protocol-definitions';
2
- import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
- import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
- import { IConnected } from '@fluidframework/protocol-definitions';
5
- import { IDisposable } from '@fluidframework/core-interfaces';
6
- import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
7
- import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
8
- import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
- import { IDocumentService } from '@fluidframework/driver-definitions';
11
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
13
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
- import { ISignalClient } from '@fluidframework/protocol-definitions';
18
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
26
-
27
- /* Excluded from this release type: FileDeltaStorageService */
28
-
29
- /* Excluded from this release type: FileDocumentServiceFactory */
30
-
31
- /* Excluded from this release type: FileSnapshotWriterClassFactory */
32
-
33
- /* Excluded from this release type: FileStorageDocumentName */
34
-
35
- /* Excluded from this release type: FluidFetchReader */
36
-
37
- /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
38
-
39
- /* Excluded from this release type: IDisposable */
40
-
41
- /* Excluded from this release type: IDocumentDeltaConnection */
42
-
43
- /* Excluded from this release type: IDocumentDeltaConnectionEvents */
44
-
45
- /* Excluded from this release type: IDocumentDeltaStorageService */
46
-
47
- /* Excluded from this release type: IDocumentService */
48
-
49
- /* Excluded from this release type: IDocumentServiceFactory */
50
-
51
- /* Excluded from this release type: IDocumentStorageService */
52
-
53
- /* Excluded from this release type: IFileSnapshot */
54
-
55
- /* Excluded from this release type: IResolvedUrl */
56
-
57
- /* Excluded from this release type: ISnapshotWriterStorage */
58
-
59
- /* Excluded from this release type: IStream */
60
-
61
- /* Excluded from this release type: ISummaryContext */
62
-
63
- /* Excluded from this release type: ITelemetryBaseLogger */
64
-
65
- /* Excluded from this release type: ReadDocumentStorageServiceBase */
66
-
67
- /* Excluded from this release type: ReaderConstructor */
68
-
69
- /* Excluded from this release type: Replayer */
70
-
71
- /* Excluded from this release type: ReplayFileDeltaConnection */
72
-
73
- /* Excluded from this release type: TypedEventEmitter */
74
-
75
- export { }
@@ -1,75 +0,0 @@
1
- import * as api from '@fluidframework/protocol-definitions';
2
- import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
- import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
- import { IConnected } from '@fluidframework/protocol-definitions';
5
- import { IDisposable } from '@fluidframework/core-interfaces';
6
- import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
7
- import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
8
- import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
- import { IDocumentService } from '@fluidframework/driver-definitions';
11
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
13
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
- import { ISignalClient } from '@fluidframework/protocol-definitions';
18
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
26
-
27
- /* Excluded from this release type: FileDeltaStorageService */
28
-
29
- /* Excluded from this release type: FileDocumentServiceFactory */
30
-
31
- /* Excluded from this release type: FileSnapshotWriterClassFactory */
32
-
33
- /* Excluded from this release type: FileStorageDocumentName */
34
-
35
- /* Excluded from this release type: FluidFetchReader */
36
-
37
- /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
38
-
39
- /* Excluded from this release type: IDisposable */
40
-
41
- /* Excluded from this release type: IDocumentDeltaConnection */
42
-
43
- /* Excluded from this release type: IDocumentDeltaConnectionEvents */
44
-
45
- /* Excluded from this release type: IDocumentDeltaStorageService */
46
-
47
- /* Excluded from this release type: IDocumentService */
48
-
49
- /* Excluded from this release type: IDocumentServiceFactory */
50
-
51
- /* Excluded from this release type: IDocumentStorageService */
52
-
53
- /* Excluded from this release type: IFileSnapshot */
54
-
55
- /* Excluded from this release type: IResolvedUrl */
56
-
57
- /* Excluded from this release type: ISnapshotWriterStorage */
58
-
59
- /* Excluded from this release type: IStream */
60
-
61
- /* Excluded from this release type: ISummaryContext */
62
-
63
- /* Excluded from this release type: ITelemetryBaseLogger */
64
-
65
- /* Excluded from this release type: ReadDocumentStorageServiceBase */
66
-
67
- /* Excluded from this release type: ReaderConstructor */
68
-
69
- /* Excluded from this release type: Replayer */
70
-
71
- /* Excluded from this release type: ReplayFileDeltaConnection */
72
-
73
- /* Excluded from this release type: TypedEventEmitter */
74
-
75
- export { }
@@ -1,209 +0,0 @@
1
- import * as api from '@fluidframework/protocol-definitions';
2
- import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
- import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
- import { IConnected } from '@fluidframework/protocol-definitions';
5
- import { IDisposable } from '@fluidframework/core-interfaces';
6
- import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
7
- import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
8
- import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
- import { IDocumentService } from '@fluidframework/driver-definitions';
11
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
13
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
- import { ISignalClient } from '@fluidframework/protocol-definitions';
18
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
26
-
27
- /**
28
- * Provides access to the underlying delta storage on the local file storage for file driver.
29
- * @internal
30
- */
31
- export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
32
- private readonly path;
33
- private readonly messages;
34
- private lastOps;
35
- constructor(path: string);
36
- fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
37
- get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
38
- /**
39
- * Retrieve ops within the exclusive sequence number range.
40
- *
41
- * @param from - First op to be fetched.
42
- * @param to - Last op to be fetched. This is exclusive.
43
- */
44
- getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
45
- }
46
-
47
- /**
48
- * Factory for creating the file document service. Use this if you want to
49
- * use the local file storage as underlying storage.
50
- * @internal
51
- */
52
- export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
53
- private readonly storage;
54
- private readonly deltaStorage;
55
- private readonly deltaConnection;
56
- constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
57
- /**
58
- * Creates the file document service if the path exists.
59
- *
60
- * @param fileURL - Path of directory containing ops/snapshots.
61
- * @returns file document service.
62
- */
63
- createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
64
- createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
65
- }
66
-
67
- /**
68
- * @internal
69
- */
70
- export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
71
- new (...args: any[]): {
72
- blobsWriter: Map<string, ArrayBufferLike>;
73
- latestWriterTree?: api.ISnapshotTree | undefined;
74
- docId?: string | undefined;
75
- reset(): void;
76
- onSnapshotHandler(snapshot: IFileSnapshot): void;
77
- readBlob(sha: string): Promise<ArrayBufferLike>;
78
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
79
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
80
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
81
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
82
- repositoryUrl: string;
83
- readonly policies?: IDocumentStorageServicePolicies | undefined;
84
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
85
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
86
- readonly disposed?: boolean | undefined;
87
- dispose?: ((error?: Error | undefined) => void) | undefined;
88
- };
89
- } & TBase;
90
-
91
- /**
92
- * @internal
93
- */
94
- export declare const FileStorageDocumentName = "FileStorageDocId";
95
-
96
- /**
97
- * Document storage service for the file driver.
98
- * @internal
99
- */
100
- export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
101
- private readonly path;
102
- private readonly versionName?;
103
- protected docTree: api.ISnapshotTree | null;
104
- constructor(path: string, versionName?: string | undefined);
105
- /**
106
- * Read the file and returns the snapshot tree.
107
- * @param version - The version contains the path of the file which contains the snapshot tree.
108
- */
109
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
110
- /**
111
- * Gets the path of the snapshot tree to be read.
112
- * @param versionId - version ID.
113
- * @param count - Number of versions to be returned.
114
- */
115
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
116
- readBlob(sha: string): Promise<ArrayBufferLike>;
117
- }
118
-
119
- /**
120
- * @internal
121
- */
122
- export declare const FluidFetchReaderFileSnapshotWriter: {
123
- new (...args: any[]): {
124
- blobsWriter: Map<string, ArrayBufferLike>;
125
- latestWriterTree?: api.ISnapshotTree | undefined;
126
- docId?: string | undefined;
127
- reset(): void;
128
- onSnapshotHandler(snapshot: IFileSnapshot): void;
129
- readBlob(sha: string): Promise<ArrayBufferLike>;
130
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
131
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
132
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
133
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
134
- repositoryUrl: string;
135
- readonly policies?: IDocumentStorageServicePolicies | undefined;
136
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
137
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
138
- readonly disposed?: boolean | undefined;
139
- dispose?: ((error?: Error | undefined) => void) | undefined;
140
- };
141
- } & typeof FluidFetchReader;
142
-
143
- /**
144
- * @internal
145
- */
146
- export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
147
- onSnapshotHandler(snapshot: IFileSnapshot): void;
148
- reset(): void;
149
- }
150
-
151
- /**
152
- * @internal
153
- */
154
- export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
155
-
156
- /**
157
- * Replay service used to play ops using the delta connection.
158
- * @internal
159
- */
160
- export declare class Replayer {
161
- private readonly deltaConnection;
162
- private readonly documentStorageService;
163
- private currentReplayOp;
164
- constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
165
- get currentReplayedOp(): number;
166
- set currentReplayedOp(op: number);
167
- get ops(): readonly Readonly<ISequencedDocumentMessage>[];
168
- /**
169
- * Replay the ops upto a certain number.
170
- * @param replayTo - The last op number to be replayed.
171
- */
172
- replay(replayTo: number): number;
173
- private isDoneFetch;
174
- private emit;
175
- }
176
-
177
- /**
178
- * @internal
179
- */
180
- export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
181
- details: IConnected;
182
- /**
183
- * Mimic the delta connection to replay ops on it.
184
- *
185
- * @param documentDeltaStorageService - The delta storage service to get ops from.
186
- * @returns Document delta connection.
187
- */
188
- static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
189
- readonly maxMessageSize: number;
190
- private readonly replayer;
191
- constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
192
- getReplayer(): Replayer;
193
- get clientId(): string;
194
- get mode(): ConnectionMode;
195
- get claims(): ITokenClaims;
196
- get existing(): boolean;
197
- get version(): string;
198
- get initialMessages(): ISequencedDocumentMessage[];
199
- get initialSignals(): ISignalMessage[];
200
- get initialClients(): ISignalClient[];
201
- get serviceConfiguration(): IClientConfiguration;
202
- submit(documentMessages: IDocumentMessage[]): void;
203
- submitSignal(message: any): Promise<void>;
204
- private _disposed;
205
- get disposed(): boolean;
206
- dispose(): void;
207
- }
208
-
209
- export { }