@fluidframework/datastore-definitions 2.0.0-dev-rc.4.0.0.261659 → 2.0.0-dev-rc.5.0.0.265721
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 +21 -0
- package/api-report/datastore-definitions.api.md +19 -17
- package/dist/channel.d.ts +7 -7
- package/dist/channel.d.ts.map +1 -1
- package/dist/dataStoreRuntime.d.ts +13 -6
- package/dist/dataStoreRuntime.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/legacy.d.ts +3 -4
- package/dist/public.d.ts +2 -12
- package/dist/storage.d.ts +1 -1
- package/lib/channel.d.ts +7 -7
- package/lib/channel.d.ts.map +1 -1
- package/lib/dataStoreRuntime.d.ts +13 -6
- package/lib/dataStoreRuntime.d.ts.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/legacy.d.ts +3 -4
- package/lib/public.d.ts +2 -12
- package/lib/storage.d.ts +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +11 -15
- package/src/channel.ts +7 -7
- package/src/dataStoreRuntime.ts +15 -7
- package/src/index.ts +5 -1
- package/src/storage.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @fluidframework/datastore-definitions
|
|
2
2
|
|
|
3
|
+
## 2.0.0-rc.4.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Type Erase IFluidDataStoreRuntime.deltaManager [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
|
|
8
|
+
|
|
9
|
+
Make IFluidDataStoreRuntime.deltaManager have an opaque type.
|
|
10
|
+
Marks the following types which were reachable from it as alpha:
|
|
11
|
+
|
|
12
|
+
- IConnectionDetails
|
|
13
|
+
- IDeltaSender
|
|
14
|
+
- IDeltaManagerEvents
|
|
15
|
+
- IDeltaManager
|
|
16
|
+
- IDeltaQueueEvents
|
|
17
|
+
- IDeltaQueue
|
|
18
|
+
- ReadOnlyInfo
|
|
19
|
+
|
|
20
|
+
As a temporary workaround, users needing access to the full delta manager API can use the `@alpha` `toDeltaManagerInternal` API to retrieve its members, but should migrate away from requiring access to those APIs.
|
|
21
|
+
|
|
22
|
+
Implementing a custom `IFluidDataStoreRuntime` is not supported: this is now indicated by it being marked with `@sealed`.
|
|
23
|
+
|
|
3
24
|
## 2.0.0-rc.3.0.0
|
|
4
25
|
|
|
5
26
|
### Major Changes
|
|
@@ -5,27 +5,26 @@
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
7
|
import type { AttachState } from '@fluidframework/container-definitions';
|
|
8
|
+
import type { ErasedType } from '@fluidframework/core-interfaces';
|
|
8
9
|
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
9
10
|
import type { IAudience } from '@fluidframework/container-definitions';
|
|
10
|
-
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
11
11
|
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
-
import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
13
12
|
import type { IEvent } from '@fluidframework/core-interfaces';
|
|
14
13
|
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
15
|
-
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions';
|
|
14
|
+
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions/internal';
|
|
16
15
|
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
17
|
-
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
16
|
+
import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
|
|
18
17
|
import type { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
19
|
-
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
|
|
18
|
+
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
|
|
20
19
|
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
21
20
|
import type { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
|
|
22
21
|
import type { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
23
22
|
import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
24
|
-
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
23
|
+
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
|
|
25
24
|
import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
26
|
-
import type { ITelemetryContext } from '@fluidframework/runtime-definitions';
|
|
25
|
+
import type { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
|
|
27
26
|
|
|
28
|
-
// @
|
|
27
|
+
// @alpha (undocumented)
|
|
29
28
|
export interface IChannel extends IFluidLoadable {
|
|
30
29
|
// (undocumented)
|
|
31
30
|
readonly attributes: IChannelAttributes;
|
|
@@ -37,14 +36,14 @@ export interface IChannel extends IFluidLoadable {
|
|
|
37
36
|
summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
|
|
38
37
|
}
|
|
39
38
|
|
|
40
|
-
// @
|
|
39
|
+
// @alpha
|
|
41
40
|
export interface IChannelAttributes {
|
|
42
41
|
readonly packageVersion?: string;
|
|
43
42
|
readonly snapshotFormatVersion: string;
|
|
44
43
|
readonly type: string;
|
|
45
44
|
}
|
|
46
45
|
|
|
47
|
-
// @
|
|
46
|
+
// @alpha
|
|
48
47
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
49
48
|
readonly attributes: IChannelAttributes;
|
|
50
49
|
create(runtime: IFluidDataStoreRuntime, id: string): TChannel & IChannel;
|
|
@@ -52,7 +51,7 @@ export interface IChannelFactory<out TChannel = unknown> {
|
|
|
52
51
|
readonly type: string;
|
|
53
52
|
}
|
|
54
53
|
|
|
55
|
-
// @
|
|
54
|
+
// @alpha
|
|
56
55
|
export interface IChannelServices {
|
|
57
56
|
// (undocumented)
|
|
58
57
|
deltaConnection: IDeltaConnection;
|
|
@@ -60,14 +59,14 @@ export interface IChannelServices {
|
|
|
60
59
|
objectStorage: IChannelStorageService;
|
|
61
60
|
}
|
|
62
61
|
|
|
63
|
-
// @
|
|
62
|
+
// @alpha
|
|
64
63
|
export interface IChannelStorageService {
|
|
65
64
|
contains(path: string): Promise<boolean>;
|
|
66
65
|
list(path: string): Promise<string[]>;
|
|
67
66
|
readBlob(path: string): Promise<ArrayBufferLike>;
|
|
68
67
|
}
|
|
69
68
|
|
|
70
|
-
// @
|
|
69
|
+
// @alpha
|
|
71
70
|
export interface IDeltaConnection {
|
|
72
71
|
// @deprecated (undocumented)
|
|
73
72
|
addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
|
|
@@ -78,7 +77,7 @@ export interface IDeltaConnection {
|
|
|
78
77
|
submit(messageContent: any, localOpMetadata: unknown): void;
|
|
79
78
|
}
|
|
80
79
|
|
|
81
|
-
// @
|
|
80
|
+
// @alpha
|
|
82
81
|
export interface IDeltaHandler {
|
|
83
82
|
applyStashedOp(message: any): void;
|
|
84
83
|
process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;
|
|
@@ -87,7 +86,10 @@ export interface IDeltaHandler {
|
|
|
87
86
|
setConnectionState(connected: boolean): void;
|
|
88
87
|
}
|
|
89
88
|
|
|
90
|
-
// @
|
|
89
|
+
// @alpha
|
|
90
|
+
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
91
|
+
|
|
92
|
+
// @alpha @sealed
|
|
91
93
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
92
94
|
addChannel(channel: IChannel): void;
|
|
93
95
|
readonly attachState: AttachState;
|
|
@@ -100,7 +102,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
100
102
|
readonly connected: boolean;
|
|
101
103
|
createChannel(id: string | undefined, type: string): IChannel;
|
|
102
104
|
// (undocumented)
|
|
103
|
-
readonly deltaManager:
|
|
105
|
+
readonly deltaManager: IDeltaManagerErased;
|
|
104
106
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
105
107
|
getAudience(): IAudience;
|
|
106
108
|
getChannel(id: string): Promise<IChannel>;
|
|
@@ -124,7 +126,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
124
126
|
waitAttached(): Promise<void>;
|
|
125
127
|
}
|
|
126
128
|
|
|
127
|
-
// @
|
|
129
|
+
// @alpha
|
|
128
130
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
129
131
|
// (undocumented)
|
|
130
132
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
package/dist/channel.d.ts
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import type { IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
6
6
|
import type { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
7
|
-
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
|
|
7
|
+
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions/internal";
|
|
8
8
|
import type { IFluidDataStoreRuntime } from "./dataStoreRuntime.js";
|
|
9
9
|
import type { IChannelAttributes } from "./storage.js";
|
|
10
10
|
/**
|
|
11
|
-
* @
|
|
11
|
+
* @alpha
|
|
12
12
|
*/
|
|
13
13
|
export interface IChannel extends IFluidLoadable {
|
|
14
14
|
/**
|
|
@@ -95,7 +95,7 @@ export interface IChannel extends IFluidLoadable {
|
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
97
|
* Handler provided by shared data structure to process requests from the runtime.
|
|
98
|
-
* @
|
|
98
|
+
* @alpha
|
|
99
99
|
*/
|
|
100
100
|
export interface IDeltaHandler {
|
|
101
101
|
/**
|
|
@@ -145,7 +145,7 @@ export interface IDeltaHandler {
|
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
147
|
* Interface to represent a connection to a delta notification stream.
|
|
148
|
-
* @
|
|
148
|
+
* @alpha
|
|
149
149
|
*/
|
|
150
150
|
export interface IDeltaConnection {
|
|
151
151
|
connected: boolean;
|
|
@@ -179,7 +179,7 @@ export interface IDeltaConnection {
|
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
181
|
* Storage services to read the objects at a given path.
|
|
182
|
-
* @
|
|
182
|
+
* @alpha
|
|
183
183
|
*/
|
|
184
184
|
export interface IChannelStorageService {
|
|
185
185
|
/**
|
|
@@ -197,7 +197,7 @@ export interface IChannelStorageService {
|
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
199
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
200
|
-
* @
|
|
200
|
+
* @alpha
|
|
201
201
|
*/
|
|
202
202
|
export interface IChannelServices {
|
|
203
203
|
deltaConnection: IDeltaConnection;
|
|
@@ -229,7 +229,7 @@ export interface IChannelServices {
|
|
|
229
229
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
230
230
|
* (while still requiring the implementation to implement it).
|
|
231
231
|
*
|
|
232
|
-
* @
|
|
232
|
+
* @alpha
|
|
233
233
|
*/
|
|
234
234
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
235
235
|
/**
|
package/dist/channel.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,KAAK,EACX,sCAAsC,EACtC,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,KAAK,EACX,sCAAsC,EACtC,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,gBAAgB,CACf,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CACR,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAEhG;;;OAGG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvD;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;OAQG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,eAAe,EAAE,gBAAgB,CAAC;IAElC,aAAa,EAAE,sBAAsB,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,eAAe,CAAC,GAAG,CAAC,QAAQ,GAAG,OAAO;IACtD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACH,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC7C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;CACzE"}
|
|
@@ -2,15 +2,16 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import type { AttachState, IAudience
|
|
6
|
-
import type { FluidObject, IDisposable, IEvent, IEventProvider,
|
|
5
|
+
import type { AttachState, IAudience } from "@fluidframework/container-definitions";
|
|
6
|
+
import type { IFluidHandle, FluidObject, IDisposable, IEvent, IEventProvider, ITelemetryBaseLogger, ErasedType } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
7
8
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
8
|
-
import type {
|
|
9
|
+
import type { IQuorumClients, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
9
10
|
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
10
11
|
import type { IChannel } from "./channel.js";
|
|
11
12
|
/**
|
|
12
13
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
13
|
-
* @
|
|
14
|
+
* @alpha
|
|
14
15
|
*/
|
|
15
16
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
16
17
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
|
@@ -18,9 +19,15 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
18
19
|
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
|
|
19
20
|
(event: "connected", listener: (clientId: string) => void): any;
|
|
20
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* Manages the transmission of ops between the runtime and storage.
|
|
24
|
+
* @alpha
|
|
25
|
+
*/
|
|
26
|
+
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
21
27
|
/**
|
|
22
28
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
23
|
-
* @
|
|
29
|
+
* @sealed
|
|
30
|
+
* @alpha
|
|
24
31
|
*/
|
|
25
32
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
26
33
|
readonly id: string;
|
|
@@ -29,7 +36,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
29
36
|
readonly channelsRoutingContext: IFluidHandleContext;
|
|
30
37
|
readonly objectsRoutingContext: IFluidHandleContext;
|
|
31
38
|
readonly options: Record<string | number, any>;
|
|
32
|
-
readonly deltaManager:
|
|
39
|
+
readonly deltaManager: IDeltaManagerErased;
|
|
33
40
|
readonly clientId: string | undefined;
|
|
34
41
|
readonly connected: boolean;
|
|
35
42
|
readonly logger: ITelemetryBaseLogger;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACX,cAAc,EACd,yBAAyB,EACzB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACrF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;GAIG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAGpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C"}
|
package/dist/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* @packageDocumentation
|
|
10
10
|
*/
|
|
11
11
|
export type { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel.js";
|
|
12
|
-
export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from "./dataStoreRuntime.js";
|
|
12
|
+
export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents, IDeltaManagerErased, } from "./dataStoreRuntime.js";
|
|
13
13
|
export type { Jsonable, JsonableTypeWith, Internal_InterfaceOfJsonableTypesWith, } from "./jsonable.js";
|
|
14
14
|
export type { Serializable } from "./serializable.js";
|
|
15
15
|
export type { IChannelAttributes } from "./storage.js";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/legacy.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
export {
|
|
12
|
-
// @
|
|
12
|
+
// @alpha APIs
|
|
13
13
|
IChannel,
|
|
14
14
|
IChannelAttributes,
|
|
15
15
|
IChannelFactory,
|
|
@@ -17,10 +17,9 @@ export {
|
|
|
17
17
|
IChannelStorageService,
|
|
18
18
|
IDeltaConnection,
|
|
19
19
|
IDeltaHandler,
|
|
20
|
+
IDeltaManagerErased,
|
|
20
21
|
IFluidDataStoreRuntime,
|
|
21
|
-
IFluidDataStoreRuntimeEvents,
|
|
22
|
-
|
|
23
|
-
// @alpha APIs
|
|
22
|
+
IFluidDataStoreRuntimeEvents,
|
|
24
23
|
Internal_InterfaceOfJsonableTypesWith,
|
|
25
24
|
Jsonable,
|
|
26
25
|
JsonableTypeWith,
|
package/dist/public.d.ts
CHANGED
|
@@ -8,15 +8,5 @@
|
|
|
8
8
|
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
|
-
export {
|
|
12
|
-
|
|
13
|
-
IChannel,
|
|
14
|
-
IChannelAttributes,
|
|
15
|
-
IChannelFactory,
|
|
16
|
-
IChannelServices,
|
|
17
|
-
IChannelStorageService,
|
|
18
|
-
IDeltaConnection,
|
|
19
|
-
IDeltaHandler,
|
|
20
|
-
IFluidDataStoreRuntime,
|
|
21
|
-
IFluidDataStoreRuntimeEvents
|
|
22
|
-
} from "./index.js";
|
|
11
|
+
export {}
|
|
12
|
+
|
package/dist/storage.d.ts
CHANGED
package/lib/channel.d.ts
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import type { IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
6
6
|
import type { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
7
|
-
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
|
|
7
|
+
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions/internal";
|
|
8
8
|
import type { IFluidDataStoreRuntime } from "./dataStoreRuntime.js";
|
|
9
9
|
import type { IChannelAttributes } from "./storage.js";
|
|
10
10
|
/**
|
|
11
|
-
* @
|
|
11
|
+
* @alpha
|
|
12
12
|
*/
|
|
13
13
|
export interface IChannel extends IFluidLoadable {
|
|
14
14
|
/**
|
|
@@ -95,7 +95,7 @@ export interface IChannel extends IFluidLoadable {
|
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
97
|
* Handler provided by shared data structure to process requests from the runtime.
|
|
98
|
-
* @
|
|
98
|
+
* @alpha
|
|
99
99
|
*/
|
|
100
100
|
export interface IDeltaHandler {
|
|
101
101
|
/**
|
|
@@ -145,7 +145,7 @@ export interface IDeltaHandler {
|
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
147
|
* Interface to represent a connection to a delta notification stream.
|
|
148
|
-
* @
|
|
148
|
+
* @alpha
|
|
149
149
|
*/
|
|
150
150
|
export interface IDeltaConnection {
|
|
151
151
|
connected: boolean;
|
|
@@ -179,7 +179,7 @@ export interface IDeltaConnection {
|
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
181
|
* Storage services to read the objects at a given path.
|
|
182
|
-
* @
|
|
182
|
+
* @alpha
|
|
183
183
|
*/
|
|
184
184
|
export interface IChannelStorageService {
|
|
185
185
|
/**
|
|
@@ -197,7 +197,7 @@ export interface IChannelStorageService {
|
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
199
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
200
|
-
* @
|
|
200
|
+
* @alpha
|
|
201
201
|
*/
|
|
202
202
|
export interface IChannelServices {
|
|
203
203
|
deltaConnection: IDeltaConnection;
|
|
@@ -229,7 +229,7 @@ export interface IChannelServices {
|
|
|
229
229
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
230
230
|
* (while still requiring the implementation to implement it).
|
|
231
231
|
*
|
|
232
|
-
* @
|
|
232
|
+
* @alpha
|
|
233
233
|
*/
|
|
234
234
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
235
235
|
/**
|
package/lib/channel.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,KAAK,EACX,sCAAsC,EACtC,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,KAAK,EACX,sCAAsC,EACtC,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,gBAAgB,CACf,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CACR,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAEhG;;;OAGG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvD;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;OAQG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,eAAe,EAAE,gBAAgB,CAAC;IAElC,aAAa,EAAE,sBAAsB,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,eAAe,CAAC,GAAG,CAAC,QAAQ,GAAG,OAAO;IACtD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACH,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC7C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;CACzE"}
|
|
@@ -2,15 +2,16 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import type { AttachState, IAudience
|
|
6
|
-
import type { FluidObject, IDisposable, IEvent, IEventProvider,
|
|
5
|
+
import type { AttachState, IAudience } from "@fluidframework/container-definitions";
|
|
6
|
+
import type { IFluidHandle, FluidObject, IDisposable, IEvent, IEventProvider, ITelemetryBaseLogger, ErasedType } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
7
8
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
8
|
-
import type {
|
|
9
|
+
import type { IQuorumClients, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
9
10
|
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
10
11
|
import type { IChannel } from "./channel.js";
|
|
11
12
|
/**
|
|
12
13
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
13
|
-
* @
|
|
14
|
+
* @alpha
|
|
14
15
|
*/
|
|
15
16
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
16
17
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
|
@@ -18,9 +19,15 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
18
19
|
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
|
|
19
20
|
(event: "connected", listener: (clientId: string) => void): any;
|
|
20
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* Manages the transmission of ops between the runtime and storage.
|
|
24
|
+
* @alpha
|
|
25
|
+
*/
|
|
26
|
+
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
21
27
|
/**
|
|
22
28
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
23
|
-
* @
|
|
29
|
+
* @sealed
|
|
30
|
+
* @alpha
|
|
24
31
|
*/
|
|
25
32
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
26
33
|
readonly id: string;
|
|
@@ -29,7 +36,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
29
36
|
readonly channelsRoutingContext: IFluidHandleContext;
|
|
30
37
|
readonly objectsRoutingContext: IFluidHandleContext;
|
|
31
38
|
readonly options: Record<string | number, any>;
|
|
32
|
-
readonly deltaManager:
|
|
39
|
+
readonly deltaManager: IDeltaManagerErased;
|
|
33
40
|
readonly clientId: string | undefined;
|
|
34
41
|
readonly connected: boolean;
|
|
35
42
|
readonly logger: ITelemetryBaseLogger;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACX,cAAc,EACd,yBAAyB,EACzB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACrF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC9B,UAAU,CAAC,kGAAkG,CAAC,CAAC;AAEhH;;;;GAIG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAGpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhF;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C"}
|
package/lib/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* @packageDocumentation
|
|
10
10
|
*/
|
|
11
11
|
export type { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel.js";
|
|
12
|
-
export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from "./dataStoreRuntime.js";
|
|
12
|
+
export type { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents, IDeltaManagerErased, } from "./dataStoreRuntime.js";
|
|
13
13
|
export type { Jsonable, JsonableTypeWith, Internal_InterfaceOfJsonableTypesWith, } from "./jsonable.js";
|
|
14
14
|
export type { Serializable } from "./serializable.js";
|
|
15
15
|
export type { IChannelAttributes } from "./storage.js";
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,YAAY,EACX,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,qCAAqC,GACrC,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
export {
|
|
12
|
-
// @
|
|
12
|
+
// @alpha APIs
|
|
13
13
|
IChannel,
|
|
14
14
|
IChannelAttributes,
|
|
15
15
|
IChannelFactory,
|
|
@@ -17,10 +17,9 @@ export {
|
|
|
17
17
|
IChannelStorageService,
|
|
18
18
|
IDeltaConnection,
|
|
19
19
|
IDeltaHandler,
|
|
20
|
+
IDeltaManagerErased,
|
|
20
21
|
IFluidDataStoreRuntime,
|
|
21
|
-
IFluidDataStoreRuntimeEvents,
|
|
22
|
-
|
|
23
|
-
// @alpha APIs
|
|
22
|
+
IFluidDataStoreRuntimeEvents,
|
|
24
23
|
Internal_InterfaceOfJsonableTypesWith,
|
|
25
24
|
Jsonable,
|
|
26
25
|
JsonableTypeWith,
|
package/lib/public.d.ts
CHANGED
|
@@ -8,15 +8,5 @@
|
|
|
8
8
|
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
|
-
export {
|
|
12
|
-
|
|
13
|
-
IChannel,
|
|
14
|
-
IChannelAttributes,
|
|
15
|
-
IChannelFactory,
|
|
16
|
-
IChannelServices,
|
|
17
|
-
IChannelStorageService,
|
|
18
|
-
IDeltaConnection,
|
|
19
|
-
IDeltaHandler,
|
|
20
|
-
IFluidDataStoreRuntime,
|
|
21
|
-
IFluidDataStoreRuntimeEvents
|
|
22
|
-
} from "./index.js";
|
|
11
|
+
export {}
|
|
12
|
+
|
package/lib/storage.d.ts
CHANGED
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/datastore-definitions",
|
|
3
|
-
"version": "2.0.0-dev-rc.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.265721",
|
|
4
4
|
"description": "Fluid data store definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -41,33 +41,29 @@
|
|
|
41
41
|
"main": "",
|
|
42
42
|
"types": "lib/public.d.ts",
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@fluidframework/container-definitions": "2.0.0-dev-rc.
|
|
45
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.
|
|
46
|
-
"@fluidframework/id-compressor": "2.0.0-dev-rc.
|
|
44
|
+
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.265721",
|
|
45
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.265721",
|
|
46
|
+
"@fluidframework/id-compressor": "2.0.0-dev-rc.5.0.0.265721",
|
|
47
47
|
"@fluidframework/protocol-definitions": "^3.2.0",
|
|
48
|
-
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.
|
|
48
|
+
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.265721"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
52
52
|
"@biomejs/biome": "^1.6.2",
|
|
53
|
-
"@fluid-tools/build-cli": "0.
|
|
53
|
+
"@fluid-tools/build-cli": "^0.39.0-264124",
|
|
54
54
|
"@fluidframework/build-common": "^2.0.3",
|
|
55
|
-
"@fluidframework/build-tools": "0.
|
|
56
|
-
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-rc.
|
|
55
|
+
"@fluidframework/build-tools": "^0.39.0-264124",
|
|
56
|
+
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-rc.4.0.0",
|
|
57
57
|
"@fluidframework/eslint-config-fluid": "^5.1.0",
|
|
58
|
-
"@microsoft/api-extractor": "^7.
|
|
58
|
+
"@microsoft/api-extractor": "^7.43.1",
|
|
59
59
|
"copyfiles": "^2.4.1",
|
|
60
60
|
"eslint": "~8.55.0",
|
|
61
61
|
"prettier": "~3.0.3",
|
|
62
62
|
"rimraf": "^4.4.0",
|
|
63
|
-
"typescript": "~5.
|
|
63
|
+
"typescript": "~5.3.3"
|
|
64
64
|
},
|
|
65
65
|
"typeValidation": {
|
|
66
|
-
"broken": {
|
|
67
|
-
"InterfaceDeclaration_IFluidDataStoreRuntime": {
|
|
68
|
-
"backCompat": false
|
|
69
|
-
}
|
|
70
|
-
}
|
|
66
|
+
"broken": {}
|
|
71
67
|
},
|
|
72
68
|
"scripts": {
|
|
73
69
|
"api": "fluid-build . --task api",
|
package/src/channel.ts
CHANGED
|
@@ -10,13 +10,13 @@ import type {
|
|
|
10
10
|
IGarbageCollectionData,
|
|
11
11
|
ISummaryTreeWithStats,
|
|
12
12
|
ITelemetryContext,
|
|
13
|
-
} from "@fluidframework/runtime-definitions";
|
|
13
|
+
} from "@fluidframework/runtime-definitions/internal";
|
|
14
14
|
|
|
15
15
|
import type { IFluidDataStoreRuntime } from "./dataStoreRuntime.js";
|
|
16
16
|
import type { IChannelAttributes } from "./storage.js";
|
|
17
17
|
|
|
18
18
|
/**
|
|
19
|
-
* @
|
|
19
|
+
* @alpha
|
|
20
20
|
*/
|
|
21
21
|
export interface IChannel extends IFluidLoadable {
|
|
22
22
|
/**
|
|
@@ -119,7 +119,7 @@ export interface IChannel extends IFluidLoadable {
|
|
|
119
119
|
|
|
120
120
|
/**
|
|
121
121
|
* Handler provided by shared data structure to process requests from the runtime.
|
|
122
|
-
* @
|
|
122
|
+
* @alpha
|
|
123
123
|
*/
|
|
124
124
|
export interface IDeltaHandler {
|
|
125
125
|
/**
|
|
@@ -174,7 +174,7 @@ export interface IDeltaHandler {
|
|
|
174
174
|
|
|
175
175
|
/**
|
|
176
176
|
* Interface to represent a connection to a delta notification stream.
|
|
177
|
-
* @
|
|
177
|
+
* @alpha
|
|
178
178
|
*/
|
|
179
179
|
export interface IDeltaConnection {
|
|
180
180
|
connected: boolean;
|
|
@@ -213,7 +213,7 @@ export interface IDeltaConnection {
|
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
215
|
* Storage services to read the objects at a given path.
|
|
216
|
-
* @
|
|
216
|
+
* @alpha
|
|
217
217
|
*/
|
|
218
218
|
export interface IChannelStorageService {
|
|
219
219
|
/**
|
|
@@ -234,7 +234,7 @@ export interface IChannelStorageService {
|
|
|
234
234
|
|
|
235
235
|
/**
|
|
236
236
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
237
|
-
* @
|
|
237
|
+
* @alpha
|
|
238
238
|
*/
|
|
239
239
|
export interface IChannelServices {
|
|
240
240
|
deltaConnection: IDeltaConnection;
|
|
@@ -268,7 +268,7 @@ export interface IChannelServices {
|
|
|
268
268
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
269
269
|
* (while still requiring the implementation to implement it).
|
|
270
270
|
*
|
|
271
|
-
* @
|
|
271
|
+
* @alpha
|
|
272
272
|
*/
|
|
273
273
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
274
274
|
/**
|
package/src/dataStoreRuntime.ts
CHANGED
|
@@ -3,19 +3,19 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
-
import type { AttachState, IAudience
|
|
6
|
+
import type { AttachState, IAudience } from "@fluidframework/container-definitions";
|
|
7
7
|
import type {
|
|
8
|
+
IFluidHandle,
|
|
8
9
|
FluidObject,
|
|
9
10
|
IDisposable,
|
|
10
11
|
IEvent,
|
|
11
12
|
IEventProvider,
|
|
12
|
-
IFluidHandle,
|
|
13
|
-
IFluidHandleContext,
|
|
14
13
|
ITelemetryBaseLogger,
|
|
14
|
+
ErasedType,
|
|
15
15
|
} from "@fluidframework/core-interfaces";
|
|
16
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
16
17
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
17
18
|
import type {
|
|
18
|
-
IDocumentMessage,
|
|
19
19
|
IQuorumClients,
|
|
20
20
|
ISequencedDocumentMessage,
|
|
21
21
|
} from "@fluidframework/protocol-definitions";
|
|
@@ -25,7 +25,7 @@ import type { IChannel } from "./channel.js";
|
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
28
|
-
* @
|
|
28
|
+
* @alpha
|
|
29
29
|
*/
|
|
30
30
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
31
31
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
|
|
@@ -34,9 +34,17 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
34
34
|
(event: "connected", listener: (clientId: string) => void);
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
+
/**
|
|
38
|
+
* Manages the transmission of ops between the runtime and storage.
|
|
39
|
+
* @alpha
|
|
40
|
+
*/
|
|
41
|
+
export type IDeltaManagerErased =
|
|
42
|
+
ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
43
|
+
|
|
37
44
|
/**
|
|
38
45
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
39
|
-
* @
|
|
46
|
+
* @sealed
|
|
47
|
+
* @alpha
|
|
40
48
|
*/
|
|
41
49
|
export interface IFluidDataStoreRuntime
|
|
42
50
|
extends IEventProvider<IFluidDataStoreRuntimeEvents>,
|
|
@@ -52,7 +60,7 @@ export interface IFluidDataStoreRuntime
|
|
|
52
60
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
53
61
|
readonly options: Record<string | number, any>;
|
|
54
62
|
|
|
55
|
-
readonly deltaManager:
|
|
63
|
+
readonly deltaManager: IDeltaManagerErased;
|
|
56
64
|
|
|
57
65
|
readonly clientId: string | undefined;
|
|
58
66
|
|
package/src/index.ts
CHANGED
|
@@ -18,7 +18,11 @@ export type {
|
|
|
18
18
|
IDeltaConnection,
|
|
19
19
|
IDeltaHandler,
|
|
20
20
|
} from "./channel.js";
|
|
21
|
-
export type {
|
|
21
|
+
export type {
|
|
22
|
+
IFluidDataStoreRuntime,
|
|
23
|
+
IFluidDataStoreRuntimeEvents,
|
|
24
|
+
IDeltaManagerErased,
|
|
25
|
+
} from "./dataStoreRuntime.js";
|
|
22
26
|
export type {
|
|
23
27
|
Jsonable,
|
|
24
28
|
JsonableTypeWith,
|