@fluidframework/datastore-definitions 2.70.0 → 2.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -13
- package/api-report/datastore-definitions.legacy.alpha.api.md +1 -0
- package/api-report/datastore-definitions.legacy.beta.api.md +1 -0
- package/dist/dataStoreRuntime.d.ts +15 -0
- package/dist/dataStoreRuntime.d.ts.map +1 -1
- package/lib/dataStoreRuntime.d.ts +15 -0
- package/lib/dataStoreRuntime.d.ts.map +1 -1
- package/package.json +13 -23
- package/src/dataStoreRuntime.ts +16 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @fluidframework/datastore-definitions
|
|
2
2
|
|
|
3
|
+
## 2.72.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.71.0
|
|
8
|
+
|
|
9
|
+
Dependency updates only.
|
|
10
|
+
|
|
3
11
|
## 2.70.0
|
|
4
12
|
|
|
5
13
|
### Minor Changes
|
|
@@ -82,7 +90,6 @@ Dependency updates only.
|
|
|
82
90
|
- The process and processDocumentSchemaOp functions have been removed ([#24018](https://github.com/microsoft/FluidFramework/pull/24018)) [bc35d543d5](https://github.com/microsoft/FluidFramework/commit/bc35d543d58c7e4bf28944b09d645cc26bf28a29)
|
|
83
91
|
|
|
84
92
|
`process` has been replaced by `processMessages` from the following:
|
|
85
|
-
|
|
86
93
|
- `FluidDataStoreRuntime`
|
|
87
94
|
- `IDeltaHandler`
|
|
88
95
|
- `IFluidDataStoreChannel`
|
|
@@ -173,7 +180,6 @@ Dependency updates only.
|
|
|
173
180
|
|
|
174
181
|
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.
|
|
175
182
|
The full list of such types is:
|
|
176
|
-
|
|
177
183
|
- `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
|
|
178
184
|
- `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
|
|
179
185
|
`ISharedObject`
|
|
@@ -191,7 +197,6 @@ Dependency updates only.
|
|
|
191
197
|
- `IProvideFluidHandleContext`
|
|
192
198
|
|
|
193
199
|
Removed APIs:
|
|
194
|
-
|
|
195
200
|
- `DataObjectClass`: Usages replaced with `SharedObjectKind`.
|
|
196
201
|
- `LoadableObjectClass`: Replaced with `SharedObjectKind`.
|
|
197
202
|
- `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
|
|
@@ -204,7 +209,6 @@ Dependency updates only.
|
|
|
204
209
|
- fluid-framework: Remove several types from `@public` scope ([#21142](https://github.com/microsoft/FluidFramework/pull/21142)) [983e9f09f7](https://github.com/microsoft/FluidFramework/commit/983e9f09f7b10fef9ffa1e9af86166f0ccda7e14)
|
|
205
210
|
|
|
206
211
|
The following types have been moved from `@public` to `@alpha`:
|
|
207
|
-
|
|
208
212
|
- `IFluidSerializer`
|
|
209
213
|
- `ISharedObjectEvents`
|
|
210
214
|
- `IChannelServices`
|
|
@@ -222,7 +226,6 @@ Dependency updates only.
|
|
|
222
226
|
|
|
223
227
|
Make IFluidDataStoreRuntime.deltaManager have an opaque type.
|
|
224
228
|
Marks the following types which were reachable from it as alpha:
|
|
225
|
-
|
|
226
229
|
- IConnectionDetails
|
|
227
230
|
- IDeltaSender
|
|
228
231
|
- IDeltaManagerEvents
|
|
@@ -246,7 +249,6 @@ Dependency updates only.
|
|
|
246
249
|
TypeScript types and implementation code.
|
|
247
250
|
|
|
248
251
|
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
249
|
-
|
|
250
252
|
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
251
253
|
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
252
254
|
|
|
@@ -281,7 +283,6 @@ Dependency updates only.
|
|
|
281
283
|
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
282
284
|
|
|
283
285
|
The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
|
|
284
|
-
|
|
285
286
|
- @fluidframework/gitresources
|
|
286
287
|
- @fluidframework/server-kafka-orderer
|
|
287
288
|
- @fluidframework/server-lambdas
|
|
@@ -342,7 +343,6 @@ Dependency updates only.
|
|
|
342
343
|
limitation of serialization.
|
|
343
344
|
|
|
344
345
|
Additional modifications:
|
|
345
|
-
|
|
346
346
|
- `Jsonable`'s `TReplacement` parameter default has also been changed from `void` to `never`, which now disallows
|
|
347
347
|
`void`.
|
|
348
348
|
- Unrecognized primitive types like `symbol` are now filtered to `never` instead of `{}`.
|
|
@@ -376,7 +376,6 @@ Dependency updates only.
|
|
|
376
376
|
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
377
377
|
|
|
378
378
|
This included the following changes from the protocol-definitions release:
|
|
379
|
-
|
|
380
379
|
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
381
380
|
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
382
381
|
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
@@ -387,7 +386,6 @@ Dependency updates only.
|
|
|
387
386
|
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
388
387
|
|
|
389
388
|
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
390
|
-
|
|
391
389
|
- @fluidframework/gitresources: 2.0.1
|
|
392
390
|
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
393
391
|
- @fluidframework/server-lambdas: 2.0.1
|
|
@@ -412,7 +410,6 @@ Dependency updates only.
|
|
|
412
410
|
- test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
413
411
|
|
|
414
412
|
The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
|
|
415
|
-
|
|
416
413
|
- `BaseContainerRuntimeFactory`
|
|
417
414
|
- `RuntimeFactory`
|
|
418
415
|
- `ContainerRuntime` (constructor and `loadRuntime`)
|
|
@@ -445,7 +442,6 @@ Dependency updates only.
|
|
|
445
442
|
|
|
446
443
|
The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
|
|
447
444
|
imported from the **@fluidframework/core-interfaces** package:
|
|
448
|
-
|
|
449
445
|
- interface IDisposable
|
|
450
446
|
- interface IErrorEvent
|
|
451
447
|
- interface IErrorEvent
|
|
@@ -479,7 +475,6 @@ Dependency updates only.
|
|
|
479
475
|
- Request APIs deprecated from many places [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
480
476
|
|
|
481
477
|
The `request` API (associated with the `IFluidRouter` interface) has been deprecated on a number of classes and interfaces. The following are impacted:
|
|
482
|
-
|
|
483
478
|
- `IRuntime` and `ContainerRuntime`
|
|
484
479
|
- `IFluidDataStoreRuntime` and `FluidDataStoreRuntime`
|
|
485
480
|
- `IFluidDataStoreChannel`
|
|
@@ -70,6 +70,7 @@ export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definiti
|
|
|
70
70
|
|
|
71
71
|
// @beta @sealed @legacy
|
|
72
72
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
73
|
+
readonly activeLocalOperationActivity?: "applyStashed" | "rollback" | undefined;
|
|
73
74
|
addChannel(channel: IChannel): void;
|
|
74
75
|
readonly attachState: AttachState;
|
|
75
76
|
bindChannel(channel: IChannel): void;
|
|
@@ -70,6 +70,7 @@ export type IDeltaManagerErased = ErasedType<"@fluidframework/container-definiti
|
|
|
70
70
|
|
|
71
71
|
// @beta @sealed @legacy
|
|
72
72
|
export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
|
|
73
|
+
readonly activeLocalOperationActivity?: "applyStashed" | "rollback" | undefined;
|
|
73
74
|
addChannel(channel: IChannel): void;
|
|
74
75
|
readonly attachState: AttachState;
|
|
75
76
|
bindChannel(channel: IChannel): void;
|
|
@@ -125,6 +125,21 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
125
125
|
* with it.
|
|
126
126
|
*/
|
|
127
127
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
128
|
+
/**
|
|
129
|
+
* Indicates the current local operation activity being performed by the data store runtime.
|
|
130
|
+
*
|
|
131
|
+
* @remarks
|
|
132
|
+
* This property allows consumers to know when the runtime itself is actively making changes to data store DDSes.
|
|
133
|
+
* When this property is not `undefined`, consumers should expect to see state modifications initiated by the runtime
|
|
134
|
+
* rather than by the consumer directly:
|
|
135
|
+
* - `"applyStashed"` - The runtime is applying previously stashed operations during reconnection or container load.
|
|
136
|
+
* Stashed operations are local changes that were submitted but not yet acknowledged when a container was closed,
|
|
137
|
+
* and are being reapplied to restore the expected local state.
|
|
138
|
+
* - `"rollback"` - The runtime is rolling back (reverting) local operations that the user has chosen not to submit.
|
|
139
|
+
* This occurs when operations are being discarded, such as when exiting staging mode without committing changes.
|
|
140
|
+
* - `undefined` - No local operation activity is currently in progress.
|
|
141
|
+
*/
|
|
142
|
+
readonly activeLocalOperationActivity?: "applyStashed" | "rollback" | undefined;
|
|
128
143
|
}
|
|
129
144
|
/**
|
|
130
145
|
* @legacy @alpha
|
|
@@ -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,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,EACX,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,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;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;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;IAIpD,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;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;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;;;;;;;;;;;;;;;;;;OAkBG;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;
|
|
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,EACX,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,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;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;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;IAIpD,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;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;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;;;;;;;;;;;;;;;;;;OAkBG;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;IAE/C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,4BAA4B,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,SAAS,CAAC;CAChF;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,sBAAsB;IAC1E,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oCAAoC;IACpD,QAAQ,CAAC,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACnE"}
|
|
@@ -125,6 +125,21 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
|
|
|
125
125
|
* with it.
|
|
126
126
|
*/
|
|
127
127
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
128
|
+
/**
|
|
129
|
+
* Indicates the current local operation activity being performed by the data store runtime.
|
|
130
|
+
*
|
|
131
|
+
* @remarks
|
|
132
|
+
* This property allows consumers to know when the runtime itself is actively making changes to data store DDSes.
|
|
133
|
+
* When this property is not `undefined`, consumers should expect to see state modifications initiated by the runtime
|
|
134
|
+
* rather than by the consumer directly:
|
|
135
|
+
* - `"applyStashed"` - The runtime is applying previously stashed operations during reconnection or container load.
|
|
136
|
+
* Stashed operations are local changes that were submitted but not yet acknowledged when a container was closed,
|
|
137
|
+
* and are being reapplied to restore the expected local state.
|
|
138
|
+
* - `"rollback"` - The runtime is rolling back (reverting) local operations that the user has chosen not to submit.
|
|
139
|
+
* This occurs when operations are being discarded, such as when exiting staging mode without committing changes.
|
|
140
|
+
* - `undefined` - No local operation activity is currently in progress.
|
|
141
|
+
*/
|
|
142
|
+
readonly activeLocalOperationActivity?: "applyStashed" | "rollback" | undefined;
|
|
128
143
|
}
|
|
129
144
|
/**
|
|
130
145
|
* @legacy @alpha
|
|
@@ -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,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,EACX,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,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;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;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;IAIpD,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;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;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;;;;;;;;;;;;;;;;;;OAkBG;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;
|
|
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,EACX,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC9C,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACzC,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC1C,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;IAK3D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,OAAE;CAC7D;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;IAIpD,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;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IAEnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IAEjD;;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;;;;;;;;;;;;;;;;;;OAkBG;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;IAE/C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,4BAA4B,CAAC,EAAE,cAAc,GAAG,UAAU,GAAG,SAAS,CAAC;CAChF;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,sBAAsB;IAC1E,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oCAAoC;IACpD,QAAQ,CAAC,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACnE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/datastore-definitions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.72.0",
|
|
4
4
|
"description": "Fluid data store definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -49,20 +49,20 @@
|
|
|
49
49
|
"main": "",
|
|
50
50
|
"types": "lib/public.d.ts",
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@fluidframework/container-definitions": "~2.
|
|
53
|
-
"@fluidframework/core-interfaces": "~2.
|
|
54
|
-
"@fluidframework/driver-definitions": "~2.
|
|
55
|
-
"@fluidframework/id-compressor": "~2.
|
|
56
|
-
"@fluidframework/runtime-definitions": "~2.
|
|
52
|
+
"@fluidframework/container-definitions": "~2.72.0",
|
|
53
|
+
"@fluidframework/core-interfaces": "~2.72.0",
|
|
54
|
+
"@fluidframework/driver-definitions": "~2.72.0",
|
|
55
|
+
"@fluidframework/id-compressor": "~2.72.0",
|
|
56
|
+
"@fluidframework/runtime-definitions": "~2.72.0"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
59
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
60
60
|
"@biomejs/biome": "~1.9.3",
|
|
61
|
-
"@fluid-tools/build-cli": "^0.
|
|
61
|
+
"@fluid-tools/build-cli": "^0.60.0",
|
|
62
62
|
"@fluidframework/build-common": "^2.0.3",
|
|
63
|
-
"@fluidframework/build-tools": "^0.
|
|
64
|
-
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.
|
|
65
|
-
"@fluidframework/eslint-config-fluid": "
|
|
63
|
+
"@fluidframework/build-tools": "^0.60.0",
|
|
64
|
+
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.71.0",
|
|
65
|
+
"@fluidframework/eslint-config-fluid": "~2.72.0",
|
|
66
66
|
"@microsoft/api-extractor": "7.52.11",
|
|
67
67
|
"concurrently": "^8.2.1",
|
|
68
68
|
"copyfiles": "^2.4.1",
|
|
@@ -71,17 +71,7 @@
|
|
|
71
71
|
"typescript": "~5.4.5"
|
|
72
72
|
},
|
|
73
73
|
"typeValidation": {
|
|
74
|
-
"broken": {
|
|
75
|
-
"Interface_IFluidDataStoreRuntimeExperimental": {
|
|
76
|
-
"backCompat": false
|
|
77
|
-
},
|
|
78
|
-
"Interface_IChannelServices": {
|
|
79
|
-
"forwardCompat": false
|
|
80
|
-
},
|
|
81
|
-
"Interface_IChannelStorageService": {
|
|
82
|
-
"forwardCompat": false
|
|
83
|
-
}
|
|
84
|
-
},
|
|
74
|
+
"broken": {},
|
|
85
75
|
"entrypoint": "legacy"
|
|
86
76
|
},
|
|
87
77
|
"scripts": {
|
|
@@ -114,8 +104,8 @@
|
|
|
114
104
|
"ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
|
|
115
105
|
"ci:build:docs": "api-extractor run",
|
|
116
106
|
"clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
|
|
117
|
-
"eslint": "eslint --format stylish src",
|
|
118
|
-
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
107
|
+
"eslint": "eslint --quiet --format stylish src",
|
|
108
|
+
"eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
119
109
|
"format": "npm run format:biome",
|
|
120
110
|
"format:biome": "biome check . --write",
|
|
121
111
|
"lint": "fluid-build . --task lint",
|
package/src/dataStoreRuntime.ts
CHANGED
|
@@ -174,6 +174,22 @@ export interface IFluidDataStoreRuntime
|
|
|
174
174
|
* with it.
|
|
175
175
|
*/
|
|
176
176
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Indicates the current local operation activity being performed by the data store runtime.
|
|
180
|
+
*
|
|
181
|
+
* @remarks
|
|
182
|
+
* This property allows consumers to know when the runtime itself is actively making changes to data store DDSes.
|
|
183
|
+
* When this property is not `undefined`, consumers should expect to see state modifications initiated by the runtime
|
|
184
|
+
* rather than by the consumer directly:
|
|
185
|
+
* - `"applyStashed"` - The runtime is applying previously stashed operations during reconnection or container load.
|
|
186
|
+
* Stashed operations are local changes that were submitted but not yet acknowledged when a container was closed,
|
|
187
|
+
* and are being reapplied to restore the expected local state.
|
|
188
|
+
* - `"rollback"` - The runtime is rolling back (reverting) local operations that the user has chosen not to submit.
|
|
189
|
+
* This occurs when operations are being discarded, such as when exiting staging mode without committing changes.
|
|
190
|
+
* - `undefined` - No local operation activity is currently in progress.
|
|
191
|
+
*/
|
|
192
|
+
readonly activeLocalOperationActivity?: "applyStashed" | "rollback" | undefined;
|
|
177
193
|
}
|
|
178
194
|
|
|
179
195
|
/**
|