@fluidframework/file-driver 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 (5) hide show
  1. package/api-report/file-driver.alpha.api.md +41 -0
  2. package/api-report/file-driver.beta.api.md +41 -0
  3. package/api-report/file-driver.public.api.md +41 -0
  4. package/package.json +9 -9
  5. package/api-report/file-driver.api.md +0 -177
package/api-report/file-driver.alpha.api.md ADDED
@@ -0,0 +1,41 @@
1
+ ## Alpha API Report File for "@fluidframework/file-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 { ConnectionMode } from '@fluidframework/driver-definitions';
8
+ import { IClientConfiguration } from '@fluidframework/driver-definitions/internal';
9
+ import { IConnected } from '@fluidframework/driver-definitions/internal';
10
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
11
+ import { IDisposable } from '@fluidframework/core-interfaces';
12
+ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions/internal';
13
+ import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentService } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
19
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
20
+ import { IFileSnapshot } from '@fluidframework/replay-driver/internal';
21
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
22
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
23
+ import { ISignalClient } from '@fluidframework/driver-definitions/internal';
24
+ import { ISignalMessage } 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 { ISummaryContext } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
31
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
32
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
33
+ import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
34
+ import { ITree } from '@fluidframework/driver-definitions/internal';
35
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
36
+ import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver/internal';
37
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
38
+
39
+ // (No @packageDocumentation comment for this package)
40
+
41
+ ```
package/api-report/file-driver.beta.api.md ADDED
@@ -0,0 +1,41 @@
1
+ ## Beta API Report File for "@fluidframework/file-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 { ConnectionMode } from '@fluidframework/driver-definitions';
8
+ import { IClientConfiguration } from '@fluidframework/driver-definitions/internal';
9
+ import { IConnected } from '@fluidframework/driver-definitions/internal';
10
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
11
+ import { IDisposable } from '@fluidframework/core-interfaces';
12
+ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions/internal';
13
+ import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentService } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
19
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
20
+ import { IFileSnapshot } from '@fluidframework/replay-driver/internal';
21
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
22
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
23
+ import { ISignalClient } from '@fluidframework/driver-definitions/internal';
24
+ import { ISignalMessage } 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 { ISummaryContext } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
31
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
32
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
33
+ import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
34
+ import { ITree } from '@fluidframework/driver-definitions/internal';
35
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
36
+ import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver/internal';
37
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
38
+
39
+ // (No @packageDocumentation comment for this package)
40
+
41
+ ```
package/api-report/file-driver.public.api.md ADDED
@@ -0,0 +1,41 @@
1
+ ## Public API Report File for "@fluidframework/file-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 { ConnectionMode } from '@fluidframework/driver-definitions';
8
+ import { IClientConfiguration } from '@fluidframework/driver-definitions/internal';
9
+ import { IConnected } from '@fluidframework/driver-definitions/internal';
10
+ import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
11
+ import { IDisposable } from '@fluidframework/core-interfaces';
12
+ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions/internal';
13
+ import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions/internal';
14
+ import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions/internal';
15
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
+ import { IDocumentService } from '@fluidframework/driver-definitions/internal';
17
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
18
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
19
+ import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
20
+ import { IFileSnapshot } from '@fluidframework/replay-driver/internal';
21
+ import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
22
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
23
+ import { ISignalClient } from '@fluidframework/driver-definitions/internal';
24
+ import { ISignalMessage } 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 { ISummaryContext } from '@fluidframework/driver-definitions/internal';
30
+ import { ISummaryHandle } from '@fluidframework/driver-definitions';
31
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
32
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
33
+ import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
34
+ import { ITree } from '@fluidframework/driver-definitions/internal';
35
+ import { IVersion } from '@fluidframework/driver-definitions/internal';
36
+ import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver/internal';
37
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
38
+
39
+ // (No @packageDocumentation comment for this package)
40
+
41
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/file-driver",
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": "A driver that reads/write from/to local file storage.",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -37,20 +37,20 @@
37
37
  "main": "lib/index.js",
38
38
  "types": "lib/public.d.ts",
39
39
  "dependencies": {
40
- "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.267932",
41
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.267932",
42
- "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.267932",
43
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.267932",
44
- "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.267932",
45
- "@fluidframework/replay-driver": "2.0.0-dev-rc.5.0.0.267932"
40
+ "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.268409",
41
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
42
+ "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
43
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
44
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.268409",
45
+ "@fluidframework/replay-driver": "2.0.0-dev-rc.5.0.0.268409"
46
46
  },
47
47
  "devDependencies": {
48
48
  "@arethetypeswrong/cli": "^0.15.2",
49
- "@biomejs/biome": "^1.6.2",
49
+ "@biomejs/biome": "^1.7.3",
50
50
  "@fluid-tools/build-cli": "^0.39.0-264124",
51
51
  "@fluidframework/build-common": "^2.0.3",
52
52
  "@fluidframework/build-tools": "^0.39.0-264124",
53
- "@fluidframework/eslint-config-fluid": "^5.1.0",
53
+ "@fluidframework/eslint-config-fluid": "^5.3.0",
54
54
  "@fluidframework/file-driver-previous": "npm:@fluidframework/file-driver@2.0.0-rc.4.0.0",
55
55
  "@microsoft/api-extractor": "^7.45.1",
56
56
  "@types/node": "^18.19.0",
package/api-report/file-driver.api.md DELETED
@@ -1,177 +0,0 @@
1
- ## API Report File for "@fluidframework/file-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 { ConnectionMode } from '@fluidframework/driver-definitions';
8
- import { IClientConfiguration } from '@fluidframework/driver-definitions/internal';
9
- import { IConnected } from '@fluidframework/driver-definitions/internal';
10
- import { ICreateBlobResponse } from '@fluidframework/driver-definitions/internal';
11
- import { IDisposable } from '@fluidframework/core-interfaces';
12
- import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions/internal';
13
- import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions/internal';
14
- import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions/internal';
15
- import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
16
- import { IDocumentService } from '@fluidframework/driver-definitions/internal';
17
- import { IDocumentServiceFactory } from '@fluidframework/driver-definitions/internal';
18
- import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
19
- import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions/internal';
20
- import { IFileSnapshot } from '@fluidframework/replay-driver/internal';
21
- import { IResolvedUrl } from '@fluidframework/driver-definitions/internal';
22
- import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions';
23
- import { ISignalClient } from '@fluidframework/driver-definitions/internal';
24
- import { ISignalMessage } 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 { ISummaryContext } from '@fluidframework/driver-definitions/internal';
30
- import { ISummaryHandle } from '@fluidframework/driver-definitions';
31
- import { ISummaryTree } from '@fluidframework/driver-definitions';
32
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
33
- import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
34
- import { ITree } from '@fluidframework/driver-definitions/internal';
35
- import { IVersion } from '@fluidframework/driver-definitions/internal';
36
- import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver/internal';
37
- import { TypedEventEmitter } from '@fluid-internal/client-utils';
38
-
39
- // @internal
40
- export class FileDeltaStorageService implements IDocumentDeltaStorageService {
41
- constructor(path: string);
42
- // (undocumented)
43
- fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<ISequencedDocumentMessage[]>;
44
- getFromWebSocket(from: number, to: number): ISequencedDocumentMessage[];
45
- // (undocumented)
46
- get ops(): readonly Readonly<ISequencedDocumentMessage>[];
47
- }
48
-
49
- // @internal
50
- export class FileDocumentServiceFactory implements IDocumentServiceFactory {
51
- constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
52
- // (undocumented)
53
- createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
54
- createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
55
- }
56
-
57
- // @internal (undocumented)
58
- export const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
59
- new (...args: any[]): {
60
- blobsWriter: Map<string, ArrayBufferLike>;
61
- latestWriterTree?: ISnapshotTree | undefined;
62
- docId?: string | undefined;
63
- reset(): void;
64
- onSnapshotHandler(snapshot: IFileSnapshot): void;
65
- readBlob(sha: string): Promise<ArrayBufferLike>;
66
- getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
67
- getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
68
- uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
69
- buildTree(snapshotTree: ISnapshotTree): Promise<ITree>;
70
- readonly policies?: IDocumentStorageServicePolicies | undefined;
71
- getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions | undefined): Promise<ISnapshot>;
72
- createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
73
- downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
74
- readonly disposed?: boolean | undefined;
75
- dispose?: ((error?: Error | undefined) => void) | undefined;
76
- };
77
- } & TBase;
78
-
79
- // @internal (undocumented)
80
- export const FileStorageDocumentName = "FileStorageDocId";
81
-
82
- // @internal
83
- export class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
84
- constructor(path: string, versionName?: string | undefined);
85
- // (undocumented)
86
- protected docTree: ISnapshotTree | null;
87
- getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
88
- getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
89
- // (undocumented)
90
- readBlob(sha: string): Promise<ArrayBufferLike>;
91
- }
92
-
93
- // @internal (undocumented)
94
- export const FluidFetchReaderFileSnapshotWriter: {
95
- new (...args: any[]): {
96
- blobsWriter: Map<string, ArrayBufferLike>;
97
- latestWriterTree?: ISnapshotTree | undefined;
98
- docId?: string | undefined;
99
- reset(): void;
100
- onSnapshotHandler(snapshot: IFileSnapshot): void;
101
- readBlob(sha: string): Promise<ArrayBufferLike>;
102
- getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
103
- getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
104
- uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
105
- buildTree(snapshotTree: ISnapshotTree): Promise<ITree>;
106
- readonly policies?: IDocumentStorageServicePolicies | undefined;
107
- getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions | undefined): Promise<ISnapshot>;
108
- createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
109
- downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
110
- readonly disposed?: boolean | undefined;
111
- dispose?: ((error?: Error | undefined) => void) | undefined;
112
- };
113
- } & typeof FluidFetchReader;
114
-
115
- // @internal (undocumented)
116
- export interface ISnapshotWriterStorage extends IDocumentStorageService {
117
- // (undocumented)
118
- onSnapshotHandler(snapshot: IFileSnapshot): void;
119
- // (undocumented)
120
- reset(): void;
121
- }
122
-
123
- // @internal (undocumented)
124
- export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
125
-
126
- // @internal
127
- export class Replayer {
128
- constructor(deltaConnection: ReplayFileDeltaConnection, documentStorageService: FileDeltaStorageService);
129
- // (undocumented)
130
- get currentReplayedOp(): number;
131
- set currentReplayedOp(op: number);
132
- // (undocumented)
133
- get ops(): readonly Readonly<ISequencedDocumentMessage>[];
134
- replay(replayTo: number): number;
135
- }
136
-
137
- // @internal (undocumented)
138
- export class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
139
- constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);
140
- // (undocumented)
141
- get claims(): ITokenClaims;
142
- // (undocumented)
143
- get clientId(): string;
144
- static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;
145
- // (undocumented)
146
- details: IConnected;
147
- // (undocumented)
148
- dispose(): void;
149
- // (undocumented)
150
- get disposed(): boolean;
151
- // (undocumented)
152
- get existing(): boolean;
153
- // (undocumented)
154
- getReplayer(): Replayer;
155
- // (undocumented)
156
- get initialClients(): ISignalClient[];
157
- // (undocumented)
158
- get initialMessages(): ISequencedDocumentMessage[];
159
- // (undocumented)
160
- get initialSignals(): ISignalMessage[];
161
- // (undocumented)
162
- readonly maxMessageSize: number;
163
- // (undocumented)
164
- get mode(): ConnectionMode;
165
- // (undocumented)
166
- get serviceConfiguration(): IClientConfiguration;
167
- // (undocumented)
168
- submit(documentMessages: IDocumentMessage[]): void;
169
- // (undocumented)
170
- submitSignal(message: any): Promise<void>;
171
- // (undocumented)
172
- get version(): string;
173
- }
174
-
175
- // (No @packageDocumentation comment for this package)
176
-
177
- ```