@fluidframework/replay-driver 2.0.0-internal.7.0.0 → 2.0.0-internal.7.2.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 +8 -0
- package/api-extractor.json +9 -1
- package/api-report/replay-driver.api.md +150 -0
- package/dist/tsdoc-metadata.json +1 -1
- package/package.json +17 -18
package/CHANGELOG.md
CHANGED
package/api-extractor.json
CHANGED
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "@fluidframework/build-common/api-extractor-
|
|
3
|
+
"extends": "@fluidframework/build-common/api-extractor-base.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
"ae-missing-release-tag": {
|
|
7
|
+
// TODO: Fix violations and remove this rule override
|
|
8
|
+
"logLevel": "none"
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
}
|
|
4
12
|
}
|
|
@@ -0,0 +1,150 @@
|
|
|
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';
|
|
9
|
+
import { IClient } 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 { IResolvedUrl } from '@fluidframework/driver-definitions';
|
|
14
|
+
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
15
|
+
import { ISummaryContext } from '@fluidframework/driver-definitions';
|
|
16
|
+
import { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
17
|
+
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
18
|
+
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
|
|
19
|
+
import { ITree } from '@fluidframework/protocol-definitions';
|
|
20
|
+
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
21
|
+
|
|
22
|
+
// @public (undocumented)
|
|
23
|
+
export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
|
|
24
|
+
constructor(json: IFileSnapshot);
|
|
25
|
+
// (undocumented)
|
|
26
|
+
protected blobs: Map<string, ArrayBufferLike>;
|
|
27
|
+
// (undocumented)
|
|
28
|
+
protected readonly commits: {
|
|
29
|
+
[key: string]: ITree;
|
|
30
|
+
};
|
|
31
|
+
// (undocumented)
|
|
32
|
+
protected docId?: string;
|
|
33
|
+
// (undocumented)
|
|
34
|
+
protected docTree: ISnapshotTree;
|
|
35
|
+
// (undocumented)
|
|
36
|
+
protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
|
|
37
|
+
// (undocumented)
|
|
38
|
+
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
39
|
+
// (undocumented)
|
|
40
|
+
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
41
|
+
// (undocumented)
|
|
42
|
+
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
43
|
+
// (undocumented)
|
|
44
|
+
protected readonly trees: {
|
|
45
|
+
[key: string]: ISnapshotTree;
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// @public
|
|
50
|
+
export interface IFileSnapshot {
|
|
51
|
+
// (undocumented)
|
|
52
|
+
commits: {
|
|
53
|
+
[key: string]: ITree;
|
|
54
|
+
};
|
|
55
|
+
// (undocumented)
|
|
56
|
+
tree: ITree;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// @public (undocumented)
|
|
60
|
+
export class OpStorage extends ReadDocumentStorageServiceBase {
|
|
61
|
+
// (undocumented)
|
|
62
|
+
getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
|
|
63
|
+
// (undocumented)
|
|
64
|
+
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
65
|
+
// (undocumented)
|
|
66
|
+
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// @public
|
|
70
|
+
export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
|
|
71
|
+
// (undocumented)
|
|
72
|
+
createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
|
|
73
|
+
// (undocumented)
|
|
74
|
+
downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
|
|
75
|
+
// (undocumented)
|
|
76
|
+
abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
|
|
77
|
+
// (undocumented)
|
|
78
|
+
abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
|
|
79
|
+
// (undocumented)
|
|
80
|
+
abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
81
|
+
// (undocumented)
|
|
82
|
+
get repositoryUrl(): string;
|
|
83
|
+
// (undocumented)
|
|
84
|
+
uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
// @public
|
|
88
|
+
export abstract class ReplayController extends ReadDocumentStorageServiceBase {
|
|
89
|
+
abstract fetchTo(currentOp: number): number | undefined;
|
|
90
|
+
abstract getStartingOpSequence(): Promise<number>;
|
|
91
|
+
abstract initStorage(documentService: IDocumentService): Promise<boolean>;
|
|
92
|
+
abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
|
|
93
|
+
abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
// @public
|
|
97
|
+
export class ReplayDocumentService implements api_2.IDocumentService {
|
|
98
|
+
constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
|
|
99
|
+
connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
|
|
100
|
+
connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
|
|
101
|
+
connectToStorage(): Promise<api_2.IDocumentStorageService>;
|
|
102
|
+
// (undocumented)
|
|
103
|
+
static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
|
|
104
|
+
// (undocumented)
|
|
105
|
+
dispose(): void;
|
|
106
|
+
// (undocumented)
|
|
107
|
+
get resolvedUrl(): api_2.IResolvedUrl;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// @public (undocumented)
|
|
111
|
+
export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
|
|
112
|
+
constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
|
|
113
|
+
// (undocumented)
|
|
114
|
+
static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
|
|
115
|
+
// (undocumented)
|
|
116
|
+
createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
117
|
+
createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// @public (undocumented)
|
|
121
|
+
export class SnapshotStorage extends ReadDocumentStorageServiceBase {
|
|
122
|
+
constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
|
|
123
|
+
// (undocumented)
|
|
124
|
+
protected docId?: string;
|
|
125
|
+
// (undocumented)
|
|
126
|
+
protected readonly docTree: ISnapshotTree | null;
|
|
127
|
+
// (undocumented)
|
|
128
|
+
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
129
|
+
// (undocumented)
|
|
130
|
+
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
131
|
+
// (undocumented)
|
|
132
|
+
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
133
|
+
// (undocumented)
|
|
134
|
+
protected readonly storage: IDocumentStorageService;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// @public (undocumented)
|
|
138
|
+
export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
|
|
139
|
+
constructor(storage: IDocumentStorageService);
|
|
140
|
+
// (undocumented)
|
|
141
|
+
createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
142
|
+
// (undocumented)
|
|
143
|
+
createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
|
|
144
|
+
// (undocumented)
|
|
145
|
+
protected readonly storage: IDocumentStorageService;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
// (No @packageDocumentation comment for this package)
|
|
149
|
+
|
|
150
|
+
```
|
package/dist/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/replay-driver",
|
|
3
|
-
"version": "2.0.0-internal.7.
|
|
3
|
+
"version": "2.0.0-internal.7.2.0",
|
|
4
4
|
"description": "Document replay version of Socket.IO implementation",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -15,27 +15,26 @@
|
|
|
15
15
|
"module": "lib/index.js",
|
|
16
16
|
"types": "dist/index.d.ts",
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@fluid-internal/client-utils": ">=2.0.0-internal.7.
|
|
19
|
-
"@fluidframework/core-interfaces": ">=2.0.0-internal.7.
|
|
20
|
-
"@fluidframework/core-utils": ">=2.0.0-internal.7.
|
|
21
|
-
"@fluidframework/driver-definitions": ">=2.0.0-internal.7.
|
|
22
|
-
"@fluidframework/driver-utils": ">=2.0.0-internal.7.
|
|
18
|
+
"@fluid-internal/client-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
|
|
19
|
+
"@fluidframework/core-interfaces": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
|
|
20
|
+
"@fluidframework/core-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
|
|
21
|
+
"@fluidframework/driver-definitions": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
|
|
22
|
+
"@fluidframework/driver-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0",
|
|
23
23
|
"@fluidframework/protocol-definitions": "^3.0.0",
|
|
24
|
-
"@fluidframework/telemetry-utils": ">=2.0.0-internal.7.
|
|
24
|
+
"@fluidframework/telemetry-utils": ">=2.0.0-internal.7.2.0 <2.0.0-internal.7.3.0"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
|
-
"@fluid-tools/build-cli": "^0.
|
|
28
|
-
"@fluidframework/build-common": "^2.0.
|
|
29
|
-
"@fluidframework/build-tools": "^0.
|
|
30
|
-
"@fluidframework/eslint-config-fluid": "^
|
|
31
|
-
"@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@2.0.0-internal.
|
|
27
|
+
"@fluid-tools/build-cli": "^0.26.1",
|
|
28
|
+
"@fluidframework/build-common": "^2.0.3",
|
|
29
|
+
"@fluidframework/build-tools": "^0.26.1",
|
|
30
|
+
"@fluidframework/eslint-config-fluid": "^3.0.0",
|
|
31
|
+
"@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@2.0.0-internal.7.1.0",
|
|
32
32
|
"@microsoft/api-extractor": "^7.37.0",
|
|
33
33
|
"@types/nock": "^9.3.0",
|
|
34
34
|
"@types/node": "^16.18.38",
|
|
35
|
-
"
|
|
36
|
-
"eslint": "~8.6.0",
|
|
35
|
+
"eslint": "~8.50.0",
|
|
37
36
|
"nock": "^13.3.3",
|
|
38
|
-
"prettier": "~
|
|
37
|
+
"prettier": "~3.0.3",
|
|
39
38
|
"rimraf": "^4.4.0",
|
|
40
39
|
"typescript": "~5.1.6"
|
|
41
40
|
},
|
|
@@ -53,10 +52,10 @@
|
|
|
53
52
|
"scripts": {
|
|
54
53
|
"build": "fluid-build . --task build",
|
|
55
54
|
"build:compile": "fluid-build . --task compile",
|
|
56
|
-
"build:docs": "api-extractor run --local
|
|
55
|
+
"build:docs": "api-extractor run --local",
|
|
57
56
|
"build:esnext": "tsc --project ./tsconfig.esnext.json",
|
|
58
|
-
"ci:build:docs": "api-extractor run
|
|
59
|
-
"clean": "rimraf --glob
|
|
57
|
+
"ci:build:docs": "api-extractor run",
|
|
58
|
+
"clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\" _api-extractor-temp",
|
|
60
59
|
"eslint": "eslint --format stylish src",
|
|
61
60
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
62
61
|
"format": "npm run prettier:fix",
|