@fluidframework/datastore-definitions 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.1
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 +55 -0
- package/api-extractor/api-extractor-lint-bundle.json +5 -0
- package/api-extractor/api-extractor-lint-legacy.cjs.json +5 -0
- package/api-extractor/api-extractor-lint-legacy.esm.json +5 -0
- package/api-extractor/api-extractor-lint-public.cjs.json +5 -0
- package/api-extractor/api-extractor-lint-public.esm.json +5 -0
- package/api-extractor.json +1 -1
- package/api-report/{datastore-definitions.api.md → datastore-definitions.alpha.api.md} +19 -21
- package/api-report/datastore-definitions.beta.api.md +27 -0
- package/api-report/datastore-definitions.public.api.md +27 -0
- package/biome.jsonc +4 -0
- package/dist/channel.d.ts +9 -19
- package/dist/channel.d.ts.map +1 -1
- package/dist/dataStoreRuntime.d.ts +8 -6
- package/dist/dataStoreRuntime.d.ts.map +1 -1
- package/dist/jsonable.d.ts.map +1 -1
- package/dist/legacy.d.ts +2 -4
- package/dist/public.d.ts +2 -13
- package/dist/storage.d.ts +1 -1
- package/lib/channel.d.ts +9 -19
- package/lib/channel.d.ts.map +1 -1
- package/lib/dataStoreRuntime.d.ts +8 -6
- package/lib/dataStoreRuntime.d.ts.map +1 -1
- package/lib/jsonable.d.ts.map +1 -1
- package/lib/legacy.d.ts +2 -4
- package/lib/public.d.ts +2 -13
- package/lib/storage.d.ts +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +25 -25
- package/src/channel.ts +14 -21
- package/src/dataStoreRuntime.ts +12 -11
- package/src/jsonable.ts +24 -22
- package/src/storage.ts +1 -1
- package/tsconfig.json +1 -0
- package/tsdoc.json +4 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,60 @@
|
|
|
1
1
|
# @fluidframework/datastore-definitions
|
|
2
2
|
|
|
3
|
+
## 2.0.0-rc.5.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- fluid-framework: Type Erase ISharedObjectKind ([#21081](https://github.com/microsoft/FluidFramework/pull/21081)) [78f228e370](https://github.com/microsoft/FluidFramework/commit/78f228e37055bd4d9a8f02b3a1eefebf4da9c59c)
|
|
8
|
+
|
|
9
|
+
A new type, `SharedObjectKind` is added as a type erased version of `ISharedObjectKind` and `DataObjectClass`.
|
|
10
|
+
|
|
11
|
+
This type fills the role of both `ISharedObjectKind` and `DataObjectClass` in the `@public` "declarative API" exposed in the `fluid-framework` package.
|
|
12
|
+
|
|
13
|
+
This allows several types referenced by `ISharedObjectKind` to be made `@alpha` as they should only need to be used by legacy code and users of the unstable/alpha/legacy "encapsulated API".
|
|
14
|
+
|
|
15
|
+
Access to these now less public types should not be required for users of the `@public` "declarative API" exposed in the `fluid-framework` package, but can still be accessed for those who need them under the `/legacy` import paths.
|
|
16
|
+
The full list of such types is:
|
|
17
|
+
|
|
18
|
+
- `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
|
|
19
|
+
- `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
|
|
20
|
+
`ISharedObject`
|
|
21
|
+
- `IChannel`
|
|
22
|
+
- `IChannelAttributes`
|
|
23
|
+
- `IChannelFactory`
|
|
24
|
+
- `IExperimentalIncrementalSummaryContext`
|
|
25
|
+
- `IGarbageCollectionData`
|
|
26
|
+
- `ISummaryStats`
|
|
27
|
+
- `ISummaryTreeWithStats`
|
|
28
|
+
- `ITelemetryContext`
|
|
29
|
+
- `IDeltaManagerErased`
|
|
30
|
+
- `IFluidDataStoreRuntimeEvents`
|
|
31
|
+
- `IFluidHandleContext`
|
|
32
|
+
- `IProvideFluidHandleContext`
|
|
33
|
+
|
|
34
|
+
Removed APIs:
|
|
35
|
+
|
|
36
|
+
- `DataObjectClass`: Usages replaced with `SharedObjectKind`.
|
|
37
|
+
- `LoadableObjectClass`: Replaced with `SharedObjectKind`.
|
|
38
|
+
- `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
|
|
39
|
+
-
|
|
40
|
+
|
|
41
|
+
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
|
|
42
|
+
|
|
43
|
+
Update package implementations to use TypeScript 5.4.5.
|
|
44
|
+
|
|
45
|
+
- fluid-framework: Remove several types from `@public` scope ([#21142](https://github.com/microsoft/FluidFramework/pull/21142)) [983e9f09f7](https://github.com/microsoft/FluidFramework/commit/983e9f09f7b10fef9ffa1e9af86166f0ccda7e14)
|
|
46
|
+
|
|
47
|
+
The following types have been moved from `@public` to `@alpha`:
|
|
48
|
+
|
|
49
|
+
- `IFluidSerializer`
|
|
50
|
+
- `ISharedObjectEvents`
|
|
51
|
+
- `IChannelServices`
|
|
52
|
+
- `IChannelStorageService`
|
|
53
|
+
- `IDeltaConnection`
|
|
54
|
+
- `IDeltaHandler`
|
|
55
|
+
|
|
56
|
+
These should not be needed by users of the declarative API, which is what `@public` is targeting.
|
|
57
|
+
|
|
3
58
|
## 2.0.0-rc.4.0.0
|
|
4
59
|
|
|
5
60
|
### Minor Changes
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/dist/legacy.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/lib/legacy.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
|
|
5
|
+
}
|
package/api-extractor.json
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "../../../common/build/build-common/api-extractor-base.esm.
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
|
|
4
4
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/datastore-definitions"
|
|
1
|
+
## Alpha API Report File for "@fluidframework/datastore-definitions"
|
|
2
2
|
|
|
3
3
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
4
|
|
|
@@ -11,20 +11,20 @@ import type { IAudience } from '@fluidframework/container-definitions';
|
|
|
11
11
|
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
12
|
import type { IEvent } from '@fluidframework/core-interfaces';
|
|
13
13
|
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
14
|
-
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions';
|
|
14
|
+
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions/internal';
|
|
15
15
|
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
16
|
-
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
16
|
+
import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
|
|
17
17
|
import type { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
18
|
-
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
|
|
18
|
+
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
|
|
19
19
|
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
20
|
-
import type { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
|
|
21
|
-
import type { IQuorumClients } from '@fluidframework/
|
|
22
|
-
import type { ISequencedDocumentMessage } from '@fluidframework/
|
|
23
|
-
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
20
|
+
import type { IInboundSignalMessage } from '@fluidframework/runtime-definitions/internal';
|
|
21
|
+
import type { IQuorumClients } from '@fluidframework/driver-definitions';
|
|
22
|
+
import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
|
|
23
|
+
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
|
|
24
24
|
import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
25
|
-
import type { ITelemetryContext } from '@fluidframework/runtime-definitions';
|
|
25
|
+
import type { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
|
|
26
26
|
|
|
27
|
-
// @
|
|
27
|
+
// @alpha (undocumented)
|
|
28
28
|
export interface IChannel extends IFluidLoadable {
|
|
29
29
|
// (undocumented)
|
|
30
30
|
readonly attributes: IChannelAttributes;
|
|
@@ -36,14 +36,14 @@ export interface IChannel extends IFluidLoadable {
|
|
|
36
36
|
summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
-
// @
|
|
39
|
+
// @alpha
|
|
40
40
|
export interface IChannelAttributes {
|
|
41
41
|
readonly packageVersion?: string;
|
|
42
42
|
readonly snapshotFormatVersion: string;
|
|
43
43
|
readonly type: string;
|
|
44
44
|
}
|
|
45
45
|
|
|
46
|
-
// @
|
|
46
|
+
// @alpha
|
|
47
47
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
48
48
|
readonly attributes: IChannelAttributes;
|
|
49
49
|
create(runtime: IFluidDataStoreRuntime, id: string): TChannel & IChannel;
|
|
@@ -51,7 +51,7 @@ export interface IChannelFactory<out TChannel = unknown> {
|
|
|
51
51
|
readonly type: string;
|
|
52
52
|
}
|
|
53
53
|
|
|
54
|
-
// @
|
|
54
|
+
// @alpha
|
|
55
55
|
export interface IChannelServices {
|
|
56
56
|
// (undocumented)
|
|
57
57
|
deltaConnection: IDeltaConnection;
|
|
@@ -59,17 +59,15 @@ export interface IChannelServices {
|
|
|
59
59
|
objectStorage: IChannelStorageService;
|
|
60
60
|
}
|
|
61
61
|
|
|
62
|
-
// @
|
|
62
|
+
// @alpha
|
|
63
63
|
export interface IChannelStorageService {
|
|
64
64
|
contains(path: string): Promise<boolean>;
|
|
65
65
|
list(path: string): Promise<string[]>;
|
|
66
66
|
readBlob(path: string): Promise<ArrayBufferLike>;
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
-
// @
|
|
69
|
+
// @alpha
|
|
70
70
|
export interface IDeltaConnection {
|
|
71
|
-
// @deprecated (undocumented)
|
|
72
|
-
addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
|
|
73
71
|
attach(handler: IDeltaHandler): void;
|
|
74
72
|
// (undocumented)
|
|
75
73
|
connected: boolean;
|
|
@@ -77,7 +75,7 @@ export interface IDeltaConnection {
|
|
|
77
75
|
submit(messageContent: any, localOpMetadata: unknown): void;
|
|
78
76
|
}
|
|
79
77
|
|
|
80
|
-
// @
|
|
78
|
+
// @alpha
|
|
81
79
|
export interface IDeltaHandler {
|
|
82
80
|
applyStashedOp(message: any): void;
|
|
83
81
|
process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;
|
|
@@ -86,10 +84,10 @@ export interface IDeltaHandler {
|
|
|
86
84
|
setConnectionState(connected: boolean): void;
|
|
87
85
|
}
|
|
88
86
|
|
|
89
|
-
// @
|
|
87
|
+
// @alpha
|
|
90
88
|
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
91
89
|
|
|
92
|
-
// @
|
|
90
|
+
// @alpha @sealed
|
|
93
91
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
94
92
|
addChannel(channel: IChannel): void;
|
|
95
93
|
readonly attachState: AttachState;
|
|
@@ -126,7 +124,7 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
126
124
|
waitAttached(): Promise<void>;
|
|
127
125
|
}
|
|
128
126
|
|
|
129
|
-
// @
|
|
127
|
+
// @alpha
|
|
130
128
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
131
129
|
// (undocumented)
|
|
132
130
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Beta API Report File for "@fluidframework/datastore-definitions"
|
|
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 type { AttachState } from '@fluidframework/container-definitions';
|
|
8
|
+
import type { ErasedType } from '@fluidframework/core-interfaces';
|
|
9
|
+
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
10
|
+
import type { IAudience } from '@fluidframework/container-definitions';
|
|
11
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
+
import type { IEvent } from '@fluidframework/core-interfaces';
|
|
13
|
+
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
14
|
+
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions/internal';
|
|
15
|
+
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
16
|
+
import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
|
|
17
|
+
import type { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
18
|
+
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
|
|
19
|
+
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
20
|
+
import type { IInboundSignalMessage } from '@fluidframework/runtime-definitions/internal';
|
|
21
|
+
import type { IQuorumClients } from '@fluidframework/driver-definitions';
|
|
22
|
+
import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
|
|
23
|
+
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
|
|
24
|
+
import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
25
|
+
import type { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
|
|
26
|
+
|
|
27
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Public API Report File for "@fluidframework/datastore-definitions"
|
|
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 type { AttachState } from '@fluidframework/container-definitions';
|
|
8
|
+
import type { ErasedType } from '@fluidframework/core-interfaces';
|
|
9
|
+
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
10
|
+
import type { IAudience } from '@fluidframework/container-definitions';
|
|
11
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
12
|
+
import type { IEvent } from '@fluidframework/core-interfaces';
|
|
13
|
+
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
14
|
+
import type { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions/internal';
|
|
15
|
+
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
16
|
+
import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
|
|
17
|
+
import type { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
18
|
+
import type { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
|
|
19
|
+
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
20
|
+
import type { IInboundSignalMessage } from '@fluidframework/runtime-definitions/internal';
|
|
21
|
+
import type { IQuorumClients } from '@fluidframework/driver-definitions';
|
|
22
|
+
import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
|
|
23
|
+
import type { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
|
|
24
|
+
import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
25
|
+
import type { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
|
|
26
|
+
|
|
27
|
+
```
|
package/biome.jsonc
ADDED
package/dist/channel.d.ts
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import type {
|
|
6
|
-
import type { ISequencedDocumentMessage } from "@fluidframework/
|
|
7
|
-
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
|
|
5
|
+
import type { IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
6
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
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;
|
|
@@ -166,20 +166,10 @@ export interface IDeltaConnection {
|
|
|
166
166
|
* that needs to be part of the summary but does not generate ops.
|
|
167
167
|
*/
|
|
168
168
|
dirty(): void;
|
|
169
|
-
/**
|
|
170
|
-
* @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
|
|
171
|
-
* It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
|
|
172
|
-
*
|
|
173
|
-
* Called when a new outbound reference is added to another node. This is used by garbage collection to identify
|
|
174
|
-
* all references added in the system.
|
|
175
|
-
* @param srcHandle - The handle of the node that added the reference.
|
|
176
|
-
* @param outboundHandle - The handle of the outbound node that is referenced.
|
|
177
|
-
*/
|
|
178
|
-
addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
|
|
179
169
|
}
|
|
180
170
|
/**
|
|
181
171
|
* Storage services to read the objects at a given path.
|
|
182
|
-
* @
|
|
172
|
+
* @alpha
|
|
183
173
|
*/
|
|
184
174
|
export interface IChannelStorageService {
|
|
185
175
|
/**
|
|
@@ -197,7 +187,7 @@ export interface IChannelStorageService {
|
|
|
197
187
|
}
|
|
198
188
|
/**
|
|
199
189
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
200
|
-
* @
|
|
190
|
+
* @alpha
|
|
201
191
|
*/
|
|
202
192
|
export interface IChannelServices {
|
|
203
193
|
deltaConnection: IDeltaConnection;
|
|
@@ -229,7 +219,7 @@ export interface IChannelServices {
|
|
|
229
219
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
230
220
|
* (while still requiring the implementation to implement it).
|
|
231
221
|
*
|
|
232
|
-
* @
|
|
222
|
+
* @alpha
|
|
233
223
|
*/
|
|
234
224
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
235
225
|
/**
|
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,
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,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,CACR,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,KACpB,IAAI,CAAC;IAEV;;;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;CACd;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"}
|
|
@@ -3,14 +3,16 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { AttachState, IAudience } from "@fluidframework/container-definitions";
|
|
6
|
-
import type { FluidObject, IDisposable, IEvent, IEventProvider,
|
|
6
|
+
import type { IFluidHandle, FluidObject, IDisposable, IEvent, IEventProvider, ITelemetryBaseLogger, ErasedType } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
8
|
+
import type { IQuorumClients } from "@fluidframework/driver-definitions";
|
|
9
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
10
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
8
|
-
import type {
|
|
9
|
-
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
11
|
+
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions/internal";
|
|
10
12
|
import type { IChannel } from "./channel.js";
|
|
11
13
|
/**
|
|
12
14
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
13
|
-
* @
|
|
15
|
+
* @alpha
|
|
14
16
|
*/
|
|
15
17
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
16
18
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
|
@@ -20,13 +22,13 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
20
22
|
}
|
|
21
23
|
/**
|
|
22
24
|
* Manages the transmission of ops between the runtime and storage.
|
|
23
|
-
* @
|
|
25
|
+
* @alpha
|
|
24
26
|
*/
|
|
25
27
|
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
26
28
|
/**
|
|
27
29
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
28
30
|
* @sealed
|
|
29
|
-
* @
|
|
31
|
+
* @alpha
|
|
30
32
|
*/
|
|
31
33
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
32
34
|
readonly id: string;
|
|
@@ -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,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,
|
|
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,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,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,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;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/jsonable.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC3B,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,CAAC,GACD,qCAAqC,CAAC,CAAC,CAAC,GACxC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAElC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC,CAAC,CAAC;IACvD,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,IAAyB,OAAO,SAAS,CACjF,CAAC,SAAS,KAAK,
|
|
1
|
+
{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC3B,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,CAAC,GACD,qCAAqC,CAAC,CAAC,CAAC,GACxC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAElC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC,CAAC,CAAC;IACvD,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,IAAyB,OAAO,SAAS,CACjF,CAAC,SAAS,KAAK,GACZ,IAAI,GACJ,KAAK,CACR,GACiB,gBAAgB,CAAC,SAAS,CAAC,GACjB,OAAO,SAAS,CAAC,GACtB,gBAAgB,CAAC,SAAS,CAAC,GACN,CAAC,SACtC,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACc,CAAC,GAEG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAClB,CAAC,SAAS,MAAM,GAC5B,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACpC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,GACjB;KACrB,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAC7C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GACzB,KAAK;CACR,GACsB,KAAK,GACX,KAAK,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,
|
|
@@ -19,9 +19,7 @@ export {
|
|
|
19
19
|
IDeltaHandler,
|
|
20
20
|
IDeltaManagerErased,
|
|
21
21
|
IFluidDataStoreRuntime,
|
|
22
|
-
IFluidDataStoreRuntimeEvents,
|
|
23
|
-
|
|
24
|
-
// @alpha APIs
|
|
22
|
+
IFluidDataStoreRuntimeEvents,
|
|
25
23
|
Internal_InterfaceOfJsonableTypesWith,
|
|
26
24
|
Jsonable,
|
|
27
25
|
JsonableTypeWith,
|
package/dist/public.d.ts
CHANGED
|
@@ -8,16 +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
|
-
IDeltaManagerErased,
|
|
21
|
-
IFluidDataStoreRuntime,
|
|
22
|
-
IFluidDataStoreRuntimeEvents
|
|
23
|
-
} from "./index.js";
|
|
11
|
+
export {}
|
|
12
|
+
|
package/dist/storage.d.ts
CHANGED
package/lib/channel.d.ts
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import type {
|
|
6
|
-
import type { ISequencedDocumentMessage } from "@fluidframework/
|
|
7
|
-
import type { IExperimentalIncrementalSummaryContext, IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
|
|
5
|
+
import type { IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
6
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
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;
|
|
@@ -166,20 +166,10 @@ export interface IDeltaConnection {
|
|
|
166
166
|
* that needs to be part of the summary but does not generate ops.
|
|
167
167
|
*/
|
|
168
168
|
dirty(): void;
|
|
169
|
-
/**
|
|
170
|
-
* @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
|
|
171
|
-
* It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
|
|
172
|
-
*
|
|
173
|
-
* Called when a new outbound reference is added to another node. This is used by garbage collection to identify
|
|
174
|
-
* all references added in the system.
|
|
175
|
-
* @param srcHandle - The handle of the node that added the reference.
|
|
176
|
-
* @param outboundHandle - The handle of the outbound node that is referenced.
|
|
177
|
-
*/
|
|
178
|
-
addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
|
|
179
169
|
}
|
|
180
170
|
/**
|
|
181
171
|
* Storage services to read the objects at a given path.
|
|
182
|
-
* @
|
|
172
|
+
* @alpha
|
|
183
173
|
*/
|
|
184
174
|
export interface IChannelStorageService {
|
|
185
175
|
/**
|
|
@@ -197,7 +187,7 @@ export interface IChannelStorageService {
|
|
|
197
187
|
}
|
|
198
188
|
/**
|
|
199
189
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
200
|
-
* @
|
|
190
|
+
* @alpha
|
|
201
191
|
*/
|
|
202
192
|
export interface IChannelServices {
|
|
203
193
|
deltaConnection: IDeltaConnection;
|
|
@@ -229,7 +219,7 @@ export interface IChannelServices {
|
|
|
229
219
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
230
220
|
* (while still requiring the implementation to implement it).
|
|
231
221
|
*
|
|
232
|
-
* @
|
|
222
|
+
* @alpha
|
|
233
223
|
*/
|
|
234
224
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
235
225
|
/**
|
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,
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,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,CACR,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,KACpB,IAAI,CAAC;IAEV;;;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;CACd;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"}
|
|
@@ -3,14 +3,16 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { AttachState, IAudience } from "@fluidframework/container-definitions";
|
|
6
|
-
import type { FluidObject, IDisposable, IEvent, IEventProvider,
|
|
6
|
+
import type { IFluidHandle, FluidObject, IDisposable, IEvent, IEventProvider, ITelemetryBaseLogger, ErasedType } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
8
|
+
import type { IQuorumClients } from "@fluidframework/driver-definitions";
|
|
9
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
10
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
8
|
-
import type {
|
|
9
|
-
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
11
|
+
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions/internal";
|
|
10
12
|
import type { IChannel } from "./channel.js";
|
|
11
13
|
/**
|
|
12
14
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
13
|
-
* @
|
|
15
|
+
* @alpha
|
|
14
16
|
*/
|
|
15
17
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
16
18
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
|
|
@@ -20,13 +22,13 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
20
22
|
}
|
|
21
23
|
/**
|
|
22
24
|
* Manages the transmission of ops between the runtime and storage.
|
|
23
|
-
* @
|
|
25
|
+
* @alpha
|
|
24
26
|
*/
|
|
25
27
|
export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
26
28
|
/**
|
|
27
29
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
28
30
|
* @sealed
|
|
29
|
-
* @
|
|
31
|
+
* @alpha
|
|
30
32
|
*/
|
|
31
33
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
32
34
|
readonly id: string;
|
|
@@ -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,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,
|
|
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,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAE1F,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,CACT,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1C;;;;;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/jsonable.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC3B,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,CAAC,GACD,qCAAqC,CAAC,CAAC,CAAC,GACxC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAElC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC,CAAC,CAAC;IACvD,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,IAAyB,OAAO,SAAS,CACjF,CAAC,SAAS,KAAK,
|
|
1
|
+
{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC3B,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,CAAC,GACD,qCAAqC,CAAC,CAAC,CAAC,GACxC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAElC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qCAAqC,CAAC,CAAC;IACvD,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,IAAyB,OAAO,SAAS,CACjF,CAAC,SAAS,KAAK,GACZ,IAAI,GACJ,KAAK,CACR,GACiB,gBAAgB,CAAC,SAAS,CAAC,GACjB,OAAO,SAAS,CAAC,GACtB,gBAAgB,CAAC,SAAS,CAAC,GACN,CAAC,SACtC,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACc,CAAC,GAEG,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAClB,CAAC,SAAS,MAAM,GAC5B,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACpC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,GACjB;KACrB,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAC7C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GACzB,KAAK;CACR,GACsB,KAAK,GACX,KAAK,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,
|
|
@@ -19,9 +19,7 @@ export {
|
|
|
19
19
|
IDeltaHandler,
|
|
20
20
|
IDeltaManagerErased,
|
|
21
21
|
IFluidDataStoreRuntime,
|
|
22
|
-
IFluidDataStoreRuntimeEvents,
|
|
23
|
-
|
|
24
|
-
// @alpha APIs
|
|
22
|
+
IFluidDataStoreRuntimeEvents,
|
|
25
23
|
Internal_InterfaceOfJsonableTypesWith,
|
|
26
24
|
Jsonable,
|
|
27
25
|
JsonableTypeWith,
|
package/lib/public.d.ts
CHANGED
|
@@ -8,16 +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
|
-
IDeltaManagerErased,
|
|
21
|
-
IFluidDataStoreRuntime,
|
|
22
|
-
IFluidDataStoreRuntimeEvents
|
|
23
|
-
} 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-rc.
|
|
3
|
+
"version": "2.0.0-rc.5.0.1",
|
|
4
4
|
"description": "Fluid data store definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -41,38 +41,30 @@
|
|
|
41
41
|
"main": "",
|
|
42
42
|
"types": "lib/public.d.ts",
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@fluidframework/container-definitions": ">=2.0.0-rc.
|
|
45
|
-
"@fluidframework/core-interfaces": ">=2.0.0-rc.
|
|
46
|
-
"@fluidframework/
|
|
47
|
-
"@fluidframework/
|
|
48
|
-
"@fluidframework/runtime-definitions": ">=2.0.0-rc.
|
|
44
|
+
"@fluidframework/container-definitions": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
|
|
45
|
+
"@fluidframework/core-interfaces": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
|
|
46
|
+
"@fluidframework/driver-definitions": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
|
|
47
|
+
"@fluidframework/id-compressor": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0",
|
|
48
|
+
"@fluidframework/runtime-definitions": ">=2.0.0-rc.5.0.1 <2.0.0-rc.5.1.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
52
|
-
"@biomejs/biome": "^1.
|
|
53
|
-
"@fluid-tools/build-cli": "^0.
|
|
52
|
+
"@biomejs/biome": "^1.7.3",
|
|
53
|
+
"@fluid-tools/build-cli": "^0.39.0",
|
|
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.
|
|
57
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
58
|
-
"@microsoft/api-extractor": "^7.
|
|
55
|
+
"@fluidframework/build-tools": "^0.39.0",
|
|
56
|
+
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-rc.4.0.0",
|
|
57
|
+
"@fluidframework/eslint-config-fluid": "^5.3.0",
|
|
58
|
+
"@microsoft/api-extractor": "^7.45.1",
|
|
59
|
+
"concurrently": "^8.2.1",
|
|
59
60
|
"copyfiles": "^2.4.1",
|
|
60
61
|
"eslint": "~8.55.0",
|
|
61
62
|
"prettier": "~3.0.3",
|
|
62
63
|
"rimraf": "^4.4.0",
|
|
63
|
-
"typescript": "~5.
|
|
64
|
+
"typescript": "~5.4.5"
|
|
64
65
|
},
|
|
65
66
|
"typeValidation": {
|
|
66
|
-
"broken": {
|
|
67
|
-
"InterfaceDeclaration_IFluidDataStoreRuntime": {
|
|
68
|
-
"backCompat": false,
|
|
69
|
-
"forwardCompat": false
|
|
70
|
-
},
|
|
71
|
-
"InterfaceDeclaration_IChannel": {
|
|
72
|
-
"forwardCompat": false,
|
|
73
|
-
"backCompat": false
|
|
74
|
-
}
|
|
75
|
-
}
|
|
67
|
+
"broken": {}
|
|
76
68
|
},
|
|
77
69
|
"scripts": {
|
|
78
70
|
"api": "fluid-build . --task api",
|
|
@@ -86,13 +78,21 @@
|
|
|
86
78
|
"build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
|
|
87
79
|
"build:test:esm": "tsc --project ./src/test/tsconfig.json",
|
|
88
80
|
"check:are-the-types-wrong": "attw --pack .",
|
|
81
|
+
"check:biome": "biome check . --formatter-enabled=true",
|
|
82
|
+
"check:exports": "concurrently \"npm:check:exports:*\"",
|
|
83
|
+
"check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
|
|
84
|
+
"check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
|
|
85
|
+
"check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
|
|
86
|
+
"check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
|
|
87
|
+
"check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
|
|
88
|
+
"check:format": "npm run check:biome",
|
|
89
89
|
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
90
|
-
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
91
90
|
"ci:build:docs": "api-extractor run",
|
|
92
91
|
"clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
|
|
93
92
|
"eslint": "eslint --format stylish src",
|
|
94
93
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
95
|
-
"format": "
|
|
94
|
+
"format": "npm run format:biome",
|
|
95
|
+
"format:biome": "biome check . --formatter-enabled=true --apply",
|
|
96
96
|
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
97
97
|
"lint": "fluid-build . --task lint",
|
|
98
98
|
"lint:fix": "fluid-build . --task eslint:fix --task format",
|
package/src/channel.ts
CHANGED
|
@@ -3,20 +3,20 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
-
import type {
|
|
7
|
-
import type { ISequencedDocumentMessage } from "@fluidframework/
|
|
6
|
+
import type { IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
8
8
|
import type {
|
|
9
9
|
IExperimentalIncrementalSummaryContext,
|
|
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
|
/**
|
|
@@ -129,7 +129,11 @@ export interface IDeltaHandler {
|
|
|
129
129
|
* @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
|
|
130
130
|
* For messages from a remote client, this will be undefined.
|
|
131
131
|
*/
|
|
132
|
-
process: (
|
|
132
|
+
process: (
|
|
133
|
+
message: ISequencedDocumentMessage,
|
|
134
|
+
local: boolean,
|
|
135
|
+
localOpMetadata: unknown,
|
|
136
|
+
) => void;
|
|
133
137
|
|
|
134
138
|
/**
|
|
135
139
|
* State change events to indicate changes to the delta connection
|
|
@@ -174,7 +178,7 @@ export interface IDeltaHandler {
|
|
|
174
178
|
|
|
175
179
|
/**
|
|
176
180
|
* Interface to represent a connection to a delta notification stream.
|
|
177
|
-
* @
|
|
181
|
+
* @alpha
|
|
178
182
|
*/
|
|
179
183
|
export interface IDeltaConnection {
|
|
180
184
|
connected: boolean;
|
|
@@ -198,22 +202,11 @@ export interface IDeltaConnection {
|
|
|
198
202
|
* that needs to be part of the summary but does not generate ops.
|
|
199
203
|
*/
|
|
200
204
|
dirty(): void;
|
|
201
|
-
|
|
202
|
-
/**
|
|
203
|
-
* @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
|
|
204
|
-
* It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
|
|
205
|
-
*
|
|
206
|
-
* Called when a new outbound reference is added to another node. This is used by garbage collection to identify
|
|
207
|
-
* all references added in the system.
|
|
208
|
-
* @param srcHandle - The handle of the node that added the reference.
|
|
209
|
-
* @param outboundHandle - The handle of the outbound node that is referenced.
|
|
210
|
-
*/
|
|
211
|
-
addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
|
|
212
205
|
}
|
|
213
206
|
|
|
214
207
|
/**
|
|
215
208
|
* Storage services to read the objects at a given path.
|
|
216
|
-
* @
|
|
209
|
+
* @alpha
|
|
217
210
|
*/
|
|
218
211
|
export interface IChannelStorageService {
|
|
219
212
|
/**
|
|
@@ -234,7 +227,7 @@ export interface IChannelStorageService {
|
|
|
234
227
|
|
|
235
228
|
/**
|
|
236
229
|
* Storage services to read the objects at a given path using the given delta connection.
|
|
237
|
-
* @
|
|
230
|
+
* @alpha
|
|
238
231
|
*/
|
|
239
232
|
export interface IChannelServices {
|
|
240
233
|
deltaConnection: IDeltaConnection;
|
|
@@ -268,7 +261,7 @@ export interface IChannelServices {
|
|
|
268
261
|
* This approach (not requiring TChannel to extend IChannel) also makes it possible for SharedObject's public interfaces to not include IChannel if desired
|
|
269
262
|
* (while still requiring the implementation to implement it).
|
|
270
263
|
*
|
|
271
|
-
* @
|
|
264
|
+
* @alpha
|
|
272
265
|
*/
|
|
273
266
|
export interface IChannelFactory<out TChannel = unknown> {
|
|
274
267
|
/**
|
package/src/dataStoreRuntime.ts
CHANGED
|
@@ -5,27 +5,25 @@
|
|
|
5
5
|
|
|
6
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,
|
|
15
14
|
ErasedType,
|
|
16
15
|
} from "@fluidframework/core-interfaces";
|
|
16
|
+
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
17
|
+
import type { IQuorumClients } from "@fluidframework/driver-definitions";
|
|
18
|
+
import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
17
19
|
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
18
|
-
import type {
|
|
19
|
-
IQuorumClients,
|
|
20
|
-
ISequencedDocumentMessage,
|
|
21
|
-
} from "@fluidframework/protocol-definitions";
|
|
22
|
-
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
20
|
+
import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions/internal";
|
|
23
21
|
|
|
24
22
|
import type { IChannel } from "./channel.js";
|
|
25
23
|
|
|
26
24
|
/**
|
|
27
25
|
* Events emitted by {@link IFluidDataStoreRuntime}.
|
|
28
|
-
* @
|
|
26
|
+
* @alpha
|
|
29
27
|
*/
|
|
30
28
|
export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
31
29
|
(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
|
|
@@ -36,7 +34,7 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
|
|
|
36
34
|
|
|
37
35
|
/**
|
|
38
36
|
* Manages the transmission of ops between the runtime and storage.
|
|
39
|
-
* @
|
|
37
|
+
* @alpha
|
|
40
38
|
*/
|
|
41
39
|
export type IDeltaManagerErased =
|
|
42
40
|
ErasedType<"@fluidframework/container-definitions.IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>">;
|
|
@@ -44,7 +42,7 @@ export type IDeltaManagerErased =
|
|
|
44
42
|
/**
|
|
45
43
|
* Represents the runtime for the data store. Contains helper functions/state of the data store.
|
|
46
44
|
* @sealed
|
|
47
|
-
* @
|
|
45
|
+
* @alpha
|
|
48
46
|
*/
|
|
49
47
|
export interface IFluidDataStoreRuntime
|
|
50
48
|
extends IEventProvider<IFluidDataStoreRuntimeEvents>,
|
|
@@ -113,7 +111,10 @@ export interface IFluidDataStoreRuntime
|
|
|
113
111
|
* Api to upload a blob of data.
|
|
114
112
|
* @param blob - blob to be uploaded.
|
|
115
113
|
*/
|
|
116
|
-
uploadBlob(
|
|
114
|
+
uploadBlob(
|
|
115
|
+
blob: ArrayBufferLike,
|
|
116
|
+
signal?: AbortSignal,
|
|
117
|
+
): Promise<IFluidHandle<ArrayBufferLike>>;
|
|
117
118
|
|
|
118
119
|
/**
|
|
119
120
|
* Submits the signal to be sent to other clients.
|
package/src/jsonable.ts
CHANGED
|
@@ -81,28 +81,30 @@ export interface Internal_InterfaceOfJsonableTypesWith<T> {
|
|
|
81
81
|
* @alpha
|
|
82
82
|
*/
|
|
83
83
|
export type Jsonable<T, TReplaced = never> = /* test for 'any' */ boolean extends (
|
|
84
|
-
T extends never
|
|
84
|
+
T extends never
|
|
85
|
+
? true
|
|
86
|
+
: false
|
|
85
87
|
)
|
|
86
88
|
? /* 'any' => */ JsonableTypeWith<TReplaced>
|
|
87
89
|
: /* test for 'unknown' */ unknown extends T
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
90
|
+
? /* 'unknown' => */ JsonableTypeWith<TReplaced>
|
|
91
|
+
: /* test for Jsonable primitive types */ T extends
|
|
92
|
+
| undefined /* is not serialized */
|
|
93
|
+
| null
|
|
94
|
+
| boolean
|
|
95
|
+
| number
|
|
96
|
+
| string
|
|
97
|
+
| TReplaced
|
|
98
|
+
? /* primitive types => */ T
|
|
99
|
+
: // eslint-disable-next-line @typescript-eslint/ban-types
|
|
100
|
+
/* test for not a function */ Extract<T, Function> extends never
|
|
101
|
+
? /* not a function => => test for object */ T extends object
|
|
102
|
+
? /* object => test for array */ T extends (infer U)[] // prefer ArrayLike test to catch non-array array-like types
|
|
103
|
+
? /* array => */ Jsonable<U, TReplaced>[]
|
|
104
|
+
: /* property bag => */ {
|
|
105
|
+
[K in keyof T]: Extract<K, symbol> extends never
|
|
106
|
+
? Jsonable<T[K], TReplaced>
|
|
107
|
+
: never;
|
|
108
|
+
}
|
|
109
|
+
: /* not an object => */ never
|
|
110
|
+
: /* function => */ never;
|
package/src/storage.ts
CHANGED
package/tsconfig.json
CHANGED
package/tsdoc.json
ADDED