@fluidframework/replay-driver 2.0.0-dev-rc.5.0.0.265721 → 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.
- package/api-report/replay-driver.alpha.api.md +29 -0
- package/api-report/replay-driver.beta.api.md +29 -0
- package/api-report/replay-driver.public.api.md +29 -0
- package/dist/emptyDeltaStorageService.d.ts +1 -1
- package/dist/emptyDeltaStorageService.d.ts.map +1 -1
- package/dist/emptyDeltaStorageService.js.map +1 -1
- package/dist/replayController.d.ts +8 -8
- package/dist/replayController.d.ts.map +1 -1
- package/dist/replayController.js.map +1 -1
- package/dist/replayDocumentDeltaConnection.d.ts +2 -2
- package/dist/replayDocumentDeltaConnection.d.ts.map +1 -1
- package/dist/replayDocumentDeltaConnection.js +2 -2
- package/dist/replayDocumentDeltaConnection.js.map +1 -1
- package/dist/replayDocumentService.d.ts +9 -9
- package/dist/replayDocumentService.d.ts.map +1 -1
- package/dist/replayDocumentService.js.map +1 -1
- package/dist/replayDocumentServiceFactory.d.ts +1 -1
- package/dist/replayDocumentServiceFactory.d.ts.map +1 -1
- package/dist/replayDocumentServiceFactory.js.map +1 -1
- package/dist/storageImplementations.d.ts +2 -2
- package/dist/storageImplementations.d.ts.map +1 -1
- package/dist/storageImplementations.js.map +1 -1
- package/lib/emptyDeltaStorageService.d.ts +1 -1
- package/lib/emptyDeltaStorageService.d.ts.map +1 -1
- package/lib/emptyDeltaStorageService.js.map +1 -1
- package/lib/replayController.d.ts +8 -8
- package/lib/replayController.d.ts.map +1 -1
- package/lib/replayController.js.map +1 -1
- package/lib/replayDocumentDeltaConnection.d.ts +2 -2
- package/lib/replayDocumentDeltaConnection.d.ts.map +1 -1
- package/lib/replayDocumentDeltaConnection.js +1 -1
- package/lib/replayDocumentDeltaConnection.js.map +1 -1
- package/lib/replayDocumentService.d.ts +9 -9
- package/lib/replayDocumentService.d.ts.map +1 -1
- package/lib/replayDocumentService.js.map +1 -1
- package/lib/replayDocumentServiceFactory.d.ts +1 -1
- package/lib/replayDocumentServiceFactory.d.ts.map +1 -1
- package/lib/replayDocumentServiceFactory.js.map +1 -1
- package/lib/storageImplementations.d.ts +2 -2
- package/lib/storageImplementations.d.ts.map +1 -1
- package/lib/storageImplementations.js.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +11 -12
- package/src/emptyDeltaStorageService.ts +1 -1
- package/src/replayController.ts +15 -8
- package/src/replayDocumentDeltaConnection.ts +6 -6
- package/src/replayDocumentService.ts +19 -12
- package/src/replayDocumentServiceFactory.ts +1 -1
- package/src/storageImplementations.ts +3 -6
- package/api-report/replay-driver.api.md +0 -139
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
|
|
7
|
+
import { ISummaryTree } from "@fluidframework/driver-definitions";
|
|
7
8
|
import {
|
|
8
9
|
IDocumentService,
|
|
9
10
|
IDocumentServiceFactory,
|
|
10
11
|
IResolvedUrl,
|
|
11
12
|
} from "@fluidframework/driver-definitions/internal";
|
|
12
|
-
import { ISummaryTree } from "@fluidframework/protocol-definitions";
|
|
13
13
|
import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
|
|
14
14
|
|
|
15
15
|
import { ReplayController } from "./replayController.js";
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
import { TypedEventEmitter } from "@fluid-internal/client-utils";
|
|
7
7
|
import { assert } from "@fluidframework/core-utils/internal";
|
|
8
|
+
import { IClient, ISummaryTree } from "@fluidframework/driver-definitions";
|
|
8
9
|
import {
|
|
9
10
|
IDocumentDeltaConnection,
|
|
10
11
|
IDocumentDeltaStorageService,
|
|
@@ -13,15 +14,11 @@ import {
|
|
|
13
14
|
IDocumentServiceFactory,
|
|
14
15
|
IDocumentStorageService,
|
|
15
16
|
IResolvedUrl,
|
|
16
|
-
} from "@fluidframework/driver-definitions/internal";
|
|
17
|
-
import { buildSnapshotTree } from "@fluidframework/driver-utils/internal";
|
|
18
|
-
import {
|
|
19
|
-
IClient,
|
|
20
17
|
ISnapshotTree,
|
|
21
|
-
ISummaryTree,
|
|
22
18
|
ITree,
|
|
23
19
|
IVersion,
|
|
24
|
-
} from "@fluidframework/
|
|
20
|
+
} from "@fluidframework/driver-definitions/internal";
|
|
21
|
+
import { buildSnapshotTree } from "@fluidframework/driver-utils/internal";
|
|
25
22
|
import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
|
|
26
23
|
|
|
27
24
|
import { EmptyDeltaStorageService } from "./emptyDeltaStorageService.js";
|
|
@@ -1,139 +0,0 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/replay-driver"
|
|
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 * as api from '@fluidframework/protocol-definitions';
|
|
8
|
-
import * as api_2 from '@fluidframework/driver-definitions/internal';
|
|
9
|
-
import { IClient } from '@fluidframework/protocol-definitions';
|
|
10
|
-
import { IDocumentService } from '@fluidframework/driver-definitions/internal';
|
|
11
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
|
|
12
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
|
|
13
|
-
import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
|
|
14
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
15
|
-
import { ISummaryContext } from '@fluidframework/driver-definitions/internal';
|
|
16
|
-
import { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
17
|
-
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
18
|
-
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
|
|
19
|
-
import { ITree } from '@fluidframework/protocol-definitions';
|
|
20
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
21
|
-
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
22
|
-
|
|
23
|
-
// @internal (undocumented)
|
|
24
|
-
export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
|
|
25
|
-
constructor(json: IFileSnapshot);
|
|
26
|
-
// (undocumented)
|
|
27
|
-
protected blobs: Map<string, ArrayBufferLike>;
|
|
28
|
-
// (undocumented)
|
|
29
|
-
protected readonly commits: {
|
|
30
|
-
[key: string]: ITree;
|
|
31
|
-
};
|
|
32
|
-
// (undocumented)
|
|
33
|
-
protected docId?: string;
|
|
34
|
-
// (undocumented)
|
|
35
|
-
protected docTree: ISnapshotTree;
|
|
36
|
-
// (undocumented)
|
|
37
|
-
protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
|
|
38
|
-
// (undocumented)
|
|
39
|
-
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
40
|
-
// (undocumented)
|
|
41
|
-
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
42
|
-
// (undocumented)
|
|
43
|
-
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
44
|
-
// (undocumented)
|
|
45
|
-
protected readonly trees: {
|
|
46
|
-
[key: string]: ISnapshotTree;
|
|
47
|
-
};
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
// @internal
|
|
51
|
-
export interface IFileSnapshot {
|
|
52
|
-
// (undocumented)
|
|
53
|
-
commits: {
|
|
54
|
-
[key: string]: ITree;
|
|
55
|
-
};
|
|
56
|
-
// (undocumented)
|
|
57
|
-
tree: ITree;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
// @internal
|
|
61
|
-
export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
|
|
62
|
-
// (undocumented)
|
|
63
|
-
createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
|
|
64
|
-
// (undocumented)
|
|
65
|
-
downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
|
|
66
|
-
// (undocumented)
|
|
67
|
-
abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
|
|
68
|
-
// (undocumented)
|
|
69
|
-
abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
|
|
70
|
-
// (undocumented)
|
|
71
|
-
abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
72
|
-
// (undocumented)
|
|
73
|
-
uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
// @internal
|
|
77
|
-
export abstract class ReplayController extends ReadDocumentStorageServiceBase {
|
|
78
|
-
abstract fetchTo(currentOp: number): number | undefined;
|
|
79
|
-
abstract getStartingOpSequence(): Promise<number>;
|
|
80
|
-
abstract initStorage(documentService: IDocumentService): Promise<boolean>;
|
|
81
|
-
abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
|
|
82
|
-
abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
// @internal
|
|
86
|
-
export class ReplayDocumentService extends TypedEventEmitter<api_2.IDocumentServiceEvents> implements api_2.IDocumentService {
|
|
87
|
-
constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
|
|
88
|
-
connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
|
|
89
|
-
connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
|
|
90
|
-
connectToStorage(): Promise<api_2.IDocumentStorageService>;
|
|
91
|
-
// (undocumented)
|
|
92
|
-
static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
|
|
93
|
-
// (undocumented)
|
|
94
|
-
dispose(): void;
|
|
95
|
-
// (undocumented)
|
|
96
|
-
get resolvedUrl(): api_2.IResolvedUrl;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
// @internal (undocumented)
|
|
100
|
-
export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
|
|
101
|
-
constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
|
|
102
|
-
// (undocumented)
|
|
103
|
-
static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
|
|
104
|
-
// (undocumented)
|
|
105
|
-
createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
106
|
-
createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
// @internal (undocumented)
|
|
110
|
-
export class SnapshotStorage extends ReadDocumentStorageServiceBase {
|
|
111
|
-
constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
|
|
112
|
-
// (undocumented)
|
|
113
|
-
protected docId?: string;
|
|
114
|
-
// (undocumented)
|
|
115
|
-
protected readonly docTree: ISnapshotTree | null;
|
|
116
|
-
// (undocumented)
|
|
117
|
-
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
118
|
-
// (undocumented)
|
|
119
|
-
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
120
|
-
// (undocumented)
|
|
121
|
-
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
122
|
-
// (undocumented)
|
|
123
|
-
protected readonly storage: IDocumentStorageService;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
// @internal (undocumented)
|
|
127
|
-
export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
|
|
128
|
-
constructor(storage: IDocumentStorageService);
|
|
129
|
-
// (undocumented)
|
|
130
|
-
createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
131
|
-
// (undocumented)
|
|
132
|
-
createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
133
|
-
// (undocumented)
|
|
134
|
-
protected readonly storage: IDocumentStorageService;
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
// (No @packageDocumentation comment for this package)
|
|
138
|
-
|
|
139
|
-
```
|