@fluidframework/file-driver 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

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 (32) hide show
  1. package/api-extractor-lint.json +13 -0
  2. package/api-extractor.json +0 -4
  3. package/api-report/file-driver.api.md +10 -10
  4. package/dist/file-driver-alpha.d.ts +46 -173
  5. package/dist/file-driver-beta.d.ts +46 -173
  6. package/dist/file-driver-public.d.ts +46 -173
  7. package/dist/file-driver-untrimmed.d.ts +22 -0
  8. package/dist/fileDeltaStorageService.d.ts +1 -0
  9. package/dist/fileDeltaStorageService.d.ts.map +1 -1
  10. package/dist/fileDeltaStorageService.js +1 -0
  11. package/dist/fileDeltaStorageService.js.map +1 -1
  12. package/dist/fileDocumentDeltaConnection.d.ts +4 -0
  13. package/dist/fileDocumentDeltaConnection.d.ts.map +1 -1
  14. package/dist/fileDocumentDeltaConnection.js +4 -0
  15. package/dist/fileDocumentDeltaConnection.js.map +1 -1
  16. package/dist/fileDocumentServiceFactory.d.ts +1 -0
  17. package/dist/fileDocumentServiceFactory.d.ts.map +1 -1
  18. package/dist/fileDocumentServiceFactory.js +1 -0
  19. package/dist/fileDocumentServiceFactory.js.map +1 -1
  20. package/dist/fileDocumentStorageService.d.ts +16 -0
  21. package/dist/fileDocumentStorageService.d.ts.map +1 -1
  22. package/dist/fileDocumentStorageService.js +10 -0
  23. package/dist/fileDocumentStorageService.js.map +1 -1
  24. package/lib/file-driver-alpha.d.ts +46 -173
  25. package/lib/file-driver-beta.d.ts +46 -173
  26. package/lib/file-driver-public.d.ts +46 -173
  27. package/lib/file-driver-untrimmed.d.ts +22 -0
  28. package/package.json +9 -8
  29. package/src/fileDeltaStorageService.ts +1 -0
  30. package/src/fileDocumentDeltaConnection.ts +4 -0
  31. package/src/fileDocumentServiceFactory.ts +1 -0
  32. package/src/fileDocumentStorageService.ts +16 -0
@@ -0,0 +1,13 @@
1
+ {
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
+ }
13
+ }
@@ -6,10 +6,6 @@
6
6
  },
7
7
  "messages": {
8
8
  "extractorMessageReporting": {
9
- // TODO: Fix violations and remove this rule override
10
- "ae-missing-release-tag": {
11
- "logLevel": "none"
12
- },
13
9
  // TODO: Add missing documentation and remove this rule override
14
10
  "ae-undocumented": {
15
11
  "logLevel": "none"
@@ -30,7 +30,7 @@ import { ITokenClaims } from '@fluidframework/protocol-definitions';
30
30
  import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
31
31
  import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
32
 
33
- // @public
33
+ // @internal
34
34
  export class FileDeltaStorageService implements IDocumentDeltaStorageService {
35
35
  constructor(path: string);
36
36
  // (undocumented)
@@ -40,7 +40,7 @@ export class FileDeltaStorageService implements IDocumentDeltaStorageService {
40
40
  get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
41
41
  }
42
42
 
43
- // @public
43
+ // @internal
44
44
  export class FileDocumentServiceFactory implements IDocumentServiceFactory {
45
45
  constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
46
46
  // (undocumented)
@@ -48,7 +48,7 @@ export class FileDocumentServiceFactory implements IDocumentServiceFactory {
48
48
  createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
49
49
  }
50
50
 
51
- // @public (undocumented)
51
+ // @internal (undocumented)
52
52
  export const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
53
53
  new (...args: any[]): {
54
54
  blobsWriter: Map<string, ArrayBufferLike>;
@@ -70,10 +70,10 @@ export const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(B
70
70
  };
71
71
  } & TBase;
72
72
 
73
- // @public (undocumented)
73
+ // @internal (undocumented)
74
74
  export const FileStorageDocumentName = "FileStorageDocId";
75
75
 
76
- // @public
76
+ // @internal
77
77
  export class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
78
78
  constructor(path: string, versionName?: string | undefined);
79
79
  // (undocumented)
@@ -84,7 +84,7 @@ export class FluidFetchReader extends ReadDocumentStorageServiceBase implements
84
84
  readBlob(sha: string): Promise<ArrayBufferLike>;
85
85
  }
86
86
 
87
- // @public (undocumented)
87
+ // @internal (undocumented)
88
88
  export const FluidFetchReaderFileSnapshotWriter: {
89
89
  new (...args: any[]): {
90
90
  blobsWriter: Map<string, ArrayBufferLike>;
@@ -106,7 +106,7 @@ export const FluidFetchReaderFileSnapshotWriter: {
106
106
  };
107
107
  } & typeof FluidFetchReader;
108
108
 
109
- // @public (undocumented)
109
+ // @internal (undocumented)
110
110
  export interface ISnapshotWriterStorage extends IDocumentStorageService {
111
111
  // (undocumented)
112
112
  onSnapshotHandler(snapshot: IFileSnapshot): void;
@@ -114,10 +114,10 @@ export interface ISnapshotWriterStorage extends IDocumentStorageService {
114
114
  reset(): void;
115
115
  }
116
116
 
117
- // @public (undocumented)
117
+ // @internal (undocumented)
118
118
  export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
119
119
 
120
- // @public
120
+ // @internal
121
121
  export class Replayer {
122
122
  constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
123
123
  // (undocumented)
@@ -128,7 +128,7 @@ export class Replayer {
128
128
  replay(replayTo: number): number;
129
129
  }
130
130
 
131
- // @public (undocumented)
131
+ // @internal (undocumented)
132
132
  export class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
133
133
  constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
134
134
  // (undocumented)
@@ -2,186 +2,59 @@ import * as api from '@fluidframework/protocol-definitions';
2
2
  import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
3
  import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
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
5
  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
6
  import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
7
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
8
  import { ISignalClient } from '@fluidframework/protocol-definitions';
18
9
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
10
  import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
11
  import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
-
26
- /**
27
- * Provides access to the underlying delta storage on the local file storage for file driver.
28
- */
29
- export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
30
- private readonly path;
31
- private readonly messages;
32
- private lastOps;
33
- constructor(path: string);
34
- fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
35
- get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
36
- /**
37
- * Retrieve ops within the exclusive sequence number range.
38
- *
39
- * @param from - First op to be fetched.
40
- * @param to - Last op to be fetched. This is exclusive.
41
- */
42
- getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
43
- }
44
-
45
- /**
46
- * Factory for creating the file document service. Use this if you want to
47
- * use the local file storage as underlying storage.
48
- */
49
- export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
50
- private readonly storage;
51
- private readonly deltaStorage;
52
- private readonly deltaConnection;
53
- constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
54
- /**
55
- * Creates the file document service if the path exists.
56
- *
57
- * @param fileURL - Path of directory containing ops/snapshots.
58
- * @returns file document service.
59
- */
60
- createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
61
- createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
62
- }
63
-
64
- export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
65
- new (...args: any[]): {
66
- blobsWriter: Map<string, ArrayBufferLike>;
67
- latestWriterTree?: api.ISnapshotTree | undefined;
68
- docId?: string | undefined;
69
- reset(): void;
70
- onSnapshotHandler(snapshot: IFileSnapshot): void;
71
- readBlob(sha: string): Promise<ArrayBufferLike>;
72
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
73
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
74
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
75
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
76
- repositoryUrl: string;
77
- readonly policies?: IDocumentStorageServicePolicies | undefined;
78
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
79
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
80
- readonly disposed?: boolean | undefined;
81
- dispose?: ((error?: Error | undefined) => void) | undefined;
82
- };
83
- } & TBase;
84
-
85
- export declare const FileStorageDocumentName = "FileStorageDocId";
86
-
87
- /**
88
- * Document storage service for the file driver.
89
- */
90
- export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
91
- private readonly path;
92
- private readonly versionName?;
93
- protected docTree: api.ISnapshotTree | null;
94
- constructor(path: string, versionName?: string | undefined);
95
- /**
96
- * Read the file and returns the snapshot tree.
97
- * @param version - The version contains the path of the file which contains the snapshot tree.
98
- */
99
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
100
- /**
101
- * Gets the path of the snapshot tree to be read.
102
- * @param versionId - version ID.
103
- * @param count - Number of versions to be returned.
104
- */
105
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
106
- readBlob(sha: string): Promise<ArrayBufferLike>;
107
- }
108
-
109
- export declare const FluidFetchReaderFileSnapshotWriter: {
110
- new (...args: any[]): {
111
- blobsWriter: Map<string, ArrayBufferLike>;
112
- latestWriterTree?: api.ISnapshotTree | undefined;
113
- docId?: string | undefined;
114
- reset(): void;
115
- onSnapshotHandler(snapshot: IFileSnapshot): void;
116
- readBlob(sha: string): Promise<ArrayBufferLike>;
117
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
118
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
119
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
120
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
121
- repositoryUrl: string;
122
- readonly policies?: IDocumentStorageServicePolicies | undefined;
123
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
124
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
125
- readonly disposed?: boolean | undefined;
126
- dispose?: ((error?: Error | undefined) => void) | undefined;
127
- };
128
- } & typeof FluidFetchReader;
129
-
130
- export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
131
- onSnapshotHandler(snapshot: IFileSnapshot): void;
132
- reset(): void;
133
- }
134
-
135
- export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
136
-
137
- /**
138
- * Replay service used to play ops using the delta connection.
139
- */
140
- export declare class Replayer {
141
- private readonly deltaConnection;
142
- private readonly documentStorageService;
143
- private currentReplayOp;
144
- constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
145
- get currentReplayedOp(): number;
146
- set currentReplayedOp(op: number);
147
- get ops(): readonly Readonly<ISequencedDocumentMessage>[];
148
- /**
149
- * Replay the ops upto a certain number.
150
- * @param replayTo - The last op number to be replayed.
151
- */
152
- replay(replayTo: number): number;
153
- private isDoneFetch;
154
- private emit;
155
- }
156
-
157
- export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
158
- details: IConnected;
159
- /**
160
- * Mimic the delta connection to replay ops on it.
161
- *
162
- * @param documentDeltaStorageService - The delta storage service to get ops from.
163
- * @returns Document delta connection.
164
- */
165
- static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
166
- readonly maxMessageSize: number;
167
- private readonly replayer;
168
- constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
169
- getReplayer(): Replayer;
170
- get clientId(): string;
171
- get mode(): ConnectionMode;
172
- get claims(): ITokenClaims;
173
- get existing(): boolean;
174
- get version(): string;
175
- get initialMessages(): ISequencedDocumentMessage[];
176
- get initialSignals(): ISignalMessage[];
177
- get initialClients(): ISignalClient[];
178
- get serviceConfiguration(): IClientConfiguration;
179
- submit(documentMessages: IDocumentMessage[]): void;
180
- submitSignal(message: any): Promise<void>;
181
- private _disposed;
182
- get disposed(): boolean;
183
- dispose(): void;
184
- }
12
+
13
+ /* Excluded from this release type: FileDeltaStorageService */
14
+
15
+ /* Excluded from this release type: FileDocumentServiceFactory */
16
+
17
+ /* Excluded from this release type: FileSnapshotWriterClassFactory */
18
+
19
+ /* Excluded from this release type: FileStorageDocumentName */
20
+
21
+ /* Excluded from this release type: FluidFetchReader */
22
+
23
+ /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
24
+
25
+ /* Excluded from this release type: IDisposable */
26
+
27
+ /* Excluded from this release type: IDocumentDeltaConnection */
28
+
29
+ /* Excluded from this release type: IDocumentDeltaConnectionEvents */
30
+
31
+ /* Excluded from this release type: IDocumentDeltaStorageService */
32
+
33
+ /* Excluded from this release type: IDocumentService */
34
+
35
+ /* Excluded from this release type: IDocumentServiceFactory */
36
+
37
+ /* Excluded from this release type: IDocumentStorageService */
38
+
39
+ /* Excluded from this release type: IFileSnapshot */
40
+
41
+ /* Excluded from this release type: IResolvedUrl */
42
+
43
+ /* Excluded from this release type: ISnapshotWriterStorage */
44
+
45
+ /* Excluded from this release type: IStream */
46
+
47
+ /* Excluded from this release type: ISummaryContext */
48
+
49
+ /* Excluded from this release type: ITelemetryBaseLogger */
50
+
51
+ /* Excluded from this release type: ReadDocumentStorageServiceBase */
52
+
53
+ /* Excluded from this release type: ReaderConstructor */
54
+
55
+ /* Excluded from this release type: Replayer */
56
+
57
+ /* Excluded from this release type: ReplayFileDeltaConnection */
185
58
 
186
59
  /* Excluded from this release type: TypedEventEmitter */
187
60
 
@@ -2,186 +2,59 @@ import * as api from '@fluidframework/protocol-definitions';
2
2
  import { ConnectionMode } from '@fluidframework/protocol-definitions';
3
3
  import { IClientConfiguration } from '@fluidframework/protocol-definitions';
4
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
5
  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
6
  import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
14
- import { IFileSnapshot } from '@fluidframework/replay-driver';
15
- import { IResolvedUrl } from '@fluidframework/driver-definitions';
16
7
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
17
8
  import { ISignalClient } from '@fluidframework/protocol-definitions';
18
9
  import { ISignalMessage } from '@fluidframework/protocol-definitions';
19
- import { IStream } from '@fluidframework/driver-definitions';
20
- import { ISummaryContext } from '@fluidframework/driver-definitions';
21
10
  import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
11
  import { ITokenClaims } from '@fluidframework/protocol-definitions';
24
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
25
-
26
- /**
27
- * Provides access to the underlying delta storage on the local file storage for file driver.
28
- */
29
- export declare class FileDeltaStorageService implements IDocumentDeltaStorageService {
30
- private readonly path;
31
- private readonly messages;
32
- private lastOps;
33
- constructor(path: string);
34
- fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<api.ISequencedDocumentMessage[]>;
35
- get ops(): readonly Readonly<api.ISequencedDocumentMessage>[];
36
- /**
37
- * Retrieve ops within the exclusive sequence number range.
38
- *
39
- * @param from - First op to be fetched.
40
- * @param to - Last op to be fetched. This is exclusive.
41
- */
42
- getFromWebSocket(from: number, to: number): api.ISequencedDocumentMessage[];
43
- }
44
-
45
- /**
46
- * Factory for creating the file document service. Use this if you want to
47
- * use the local file storage as underlying storage.
48
- */
49
- export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
50
- private readonly storage;
51
- private readonly deltaStorage;
52
- private readonly deltaConnection;
53
- constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
54
- /**
55
- * Creates the file document service if the path exists.
56
- *
57
- * @param fileURL - Path of directory containing ops/snapshots.
58
- * @returns file document service.
59
- */
60
- createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
61
- createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
62
- }
63
-
64
- export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
65
- new (...args: any[]): {
66
- blobsWriter: Map<string, ArrayBufferLike>;
67
- latestWriterTree?: api.ISnapshotTree | undefined;
68
- docId?: string | undefined;
69
- reset(): void;
70
- onSnapshotHandler(snapshot: IFileSnapshot): void;
71
- readBlob(sha: string): Promise<ArrayBufferLike>;
72
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
73
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
74
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
75
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
76
- repositoryUrl: string;
77
- readonly policies?: IDocumentStorageServicePolicies | undefined;
78
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
79
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
80
- readonly disposed?: boolean | undefined;
81
- dispose?: ((error?: Error | undefined) => void) | undefined;
82
- };
83
- } & TBase;
84
-
85
- export declare const FileStorageDocumentName = "FileStorageDocId";
86
-
87
- /**
88
- * Document storage service for the file driver.
89
- */
90
- export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
91
- private readonly path;
92
- private readonly versionName?;
93
- protected docTree: api.ISnapshotTree | null;
94
- constructor(path: string, versionName?: string | undefined);
95
- /**
96
- * Read the file and returns the snapshot tree.
97
- * @param version - The version contains the path of the file which contains the snapshot tree.
98
- */
99
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
100
- /**
101
- * Gets the path of the snapshot tree to be read.
102
- * @param versionId - version ID.
103
- * @param count - Number of versions to be returned.
104
- */
105
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
106
- readBlob(sha: string): Promise<ArrayBufferLike>;
107
- }
108
-
109
- export declare const FluidFetchReaderFileSnapshotWriter: {
110
- new (...args: any[]): {
111
- blobsWriter: Map<string, ArrayBufferLike>;
112
- latestWriterTree?: api.ISnapshotTree | undefined;
113
- docId?: string | undefined;
114
- reset(): void;
115
- onSnapshotHandler(snapshot: IFileSnapshot): void;
116
- readBlob(sha: string): Promise<ArrayBufferLike>;
117
- getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
118
- getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
119
- uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
120
- buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
121
- repositoryUrl: string;
122
- readonly policies?: IDocumentStorageServicePolicies | undefined;
123
- createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
124
- downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
125
- readonly disposed?: boolean | undefined;
126
- dispose?: ((error?: Error | undefined) => void) | undefined;
127
- };
128
- } & typeof FluidFetchReader;
129
-
130
- export declare interface ISnapshotWriterStorage extends IDocumentStorageService {
131
- onSnapshotHandler(snapshot: IFileSnapshot): void;
132
- reset(): void;
133
- }
134
-
135
- export declare type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
136
-
137
- /**
138
- * Replay service used to play ops using the delta connection.
139
- */
140
- export declare class Replayer {
141
- private readonly deltaConnection;
142
- private readonly documentStorageService;
143
- private currentReplayOp;
144
- constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
145
- get currentReplayedOp(): number;
146
- set currentReplayedOp(op: number);
147
- get ops(): readonly Readonly<ISequencedDocumentMessage>[];
148
- /**
149
- * Replay the ops upto a certain number.
150
- * @param replayTo - The last op number to be replayed.
151
- */
152
- replay(replayTo: number): number;
153
- private isDoneFetch;
154
- private emit;
155
- }
156
-
157
- export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
158
- details: IConnected;
159
- /**
160
- * Mimic the delta connection to replay ops on it.
161
- *
162
- * @param documentDeltaStorageService - The delta storage service to get ops from.
163
- * @returns Document delta connection.
164
- */
165
- static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
166
- readonly maxMessageSize: number;
167
- private readonly replayer;
168
- constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
169
- getReplayer(): Replayer;
170
- get clientId(): string;
171
- get mode(): ConnectionMode;
172
- get claims(): ITokenClaims;
173
- get existing(): boolean;
174
- get version(): string;
175
- get initialMessages(): ISequencedDocumentMessage[];
176
- get initialSignals(): ISignalMessage[];
177
- get initialClients(): ISignalClient[];
178
- get serviceConfiguration(): IClientConfiguration;
179
- submit(documentMessages: IDocumentMessage[]): void;
180
- submitSignal(message: any): Promise<void>;
181
- private _disposed;
182
- get disposed(): boolean;
183
- dispose(): void;
184
- }
12
+
13
+ /* Excluded from this release type: FileDeltaStorageService */
14
+
15
+ /* Excluded from this release type: FileDocumentServiceFactory */
16
+
17
+ /* Excluded from this release type: FileSnapshotWriterClassFactory */
18
+
19
+ /* Excluded from this release type: FileStorageDocumentName */
20
+
21
+ /* Excluded from this release type: FluidFetchReader */
22
+
23
+ /* Excluded from this release type: FluidFetchReaderFileSnapshotWriter */
24
+
25
+ /* Excluded from this release type: IDisposable */
26
+
27
+ /* Excluded from this release type: IDocumentDeltaConnection */
28
+
29
+ /* Excluded from this release type: IDocumentDeltaConnectionEvents */
30
+
31
+ /* Excluded from this release type: IDocumentDeltaStorageService */
32
+
33
+ /* Excluded from this release type: IDocumentService */
34
+
35
+ /* Excluded from this release type: IDocumentServiceFactory */
36
+
37
+ /* Excluded from this release type: IDocumentStorageService */
38
+
39
+ /* Excluded from this release type: IFileSnapshot */
40
+
41
+ /* Excluded from this release type: IResolvedUrl */
42
+
43
+ /* Excluded from this release type: ISnapshotWriterStorage */
44
+
45
+ /* Excluded from this release type: IStream */
46
+
47
+ /* Excluded from this release type: ISummaryContext */
48
+
49
+ /* Excluded from this release type: ITelemetryBaseLogger */
50
+
51
+ /* Excluded from this release type: ReadDocumentStorageServiceBase */
52
+
53
+ /* Excluded from this release type: ReaderConstructor */
54
+
55
+ /* Excluded from this release type: Replayer */
56
+
57
+ /* Excluded from this release type: ReplayFileDeltaConnection */
185
58
 
186
59
  /* Excluded from this release type: TypedEventEmitter */
187
60