@fluidframework/runtime-definitions 2.0.0-dev.7.4.0.216897 → 2.0.0-dev.7.4.0.217884
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/api-report/runtime-definitions.api.md +47 -47
- package/dist/dataStoreContext.d.ts +12 -12
- package/dist/dataStoreContext.js +2 -2
- package/dist/dataStoreContext.js.map +1 -1
- package/dist/dataStoreFactory.d.ts +3 -3
- package/dist/dataStoreFactory.js +1 -1
- package/dist/dataStoreFactory.js.map +1 -1
- package/dist/dataStoreRegistry.d.ts +6 -6
- package/dist/dataStoreRegistry.js +1 -1
- package/dist/dataStoreRegistry.js.map +1 -1
- package/dist/garbageCollection.d.ts +2 -2
- package/dist/garbageCollection.js.map +1 -1
- package/dist/id-compressor/idCompressor.d.ts +2 -2
- package/dist/id-compressor/idCompressor.js.map +1 -1
- package/dist/id-compressor/identifiers.d.ts +4 -4
- package/dist/id-compressor/identifiers.js.map +1 -1
- package/dist/id-compressor/persisted-types/0.0.1.d.ts +4 -4
- package/dist/id-compressor/persisted-types/0.0.1.js.map +1 -1
- package/dist/protocol.d.ts +1 -1
- package/dist/protocol.js.map +1 -1
- package/dist/runtime-definitions-alpha.d.ts +1073 -111
- package/dist/runtime-definitions-untrimmed.d.ts +47 -47
- package/dist/summary.d.ts +13 -13
- package/dist/summary.js +1 -1
- package/dist/summary.js.map +1 -1
- package/lib/runtime-definitions-alpha.d.ts +1073 -111
- package/lib/runtime-definitions-untrimmed.d.ts +47 -47
- package/package.json +4 -4
- package/src/dataStoreContext.ts +12 -12
- package/src/dataStoreFactory.ts +3 -3
- package/src/dataStoreRegistry.ts +6 -6
- package/src/garbageCollection.ts +2 -2
- package/src/id-compressor/idCompressor.ts +2 -2
- package/src/id-compressor/identifiers.ts +4 -4
- package/src/id-compressor/persisted-types/0.0.1.ts +4 -4
- package/src/protocol.ts +1 -1
- package/src/summary.ts +13 -13
|
@@ -34,7 +34,7 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
34
34
|
* the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded
|
|
35
35
|
* and will be garbage collected. The current datastore cannot be aliased to a different value.
|
|
36
36
|
* 'AlreadyAliased' - the datastore has already been previously bound to another alias name.
|
|
37
|
-
* @
|
|
37
|
+
* @alpha
|
|
38
38
|
*/
|
|
39
39
|
export declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
|
|
40
40
|
|
|
@@ -70,7 +70,7 @@ export declare const blobCountPropertyName = "BlobCount";
|
|
|
70
70
|
export declare const channelsTreeName = ".channels";
|
|
71
71
|
|
|
72
72
|
/**
|
|
73
|
-
* @
|
|
73
|
+
* @alpha
|
|
74
74
|
*/
|
|
75
75
|
export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
|
|
76
76
|
/**
|
|
@@ -79,7 +79,7 @@ export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeI
|
|
|
79
79
|
getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
|
-
* @
|
|
82
|
+
* @alpha
|
|
83
83
|
*/
|
|
84
84
|
export declare type CreateChildSummarizerNodeParam = {
|
|
85
85
|
type: CreateSummarizerNodeSource.FromSummary;
|
|
@@ -92,7 +92,7 @@ export declare type CreateChildSummarizerNodeParam = {
|
|
|
92
92
|
};
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
|
-
* @
|
|
95
|
+
* @alpha
|
|
96
96
|
*/
|
|
97
97
|
export declare enum CreateSummarizerNodeSource {
|
|
98
98
|
FromSummary = 0,
|
|
@@ -125,13 +125,13 @@ export declare interface DetachedAttributionKey {
|
|
|
125
125
|
/**
|
|
126
126
|
* A single registry entry that may be used to create data stores
|
|
127
127
|
* It has to have either factory or registry, or both.
|
|
128
|
-
* @
|
|
128
|
+
* @alpha
|
|
129
129
|
*/
|
|
130
130
|
export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
|
|
131
131
|
|
|
132
132
|
/**
|
|
133
133
|
* Runtime flush mode handling
|
|
134
|
-
* @
|
|
134
|
+
* @alpha
|
|
135
135
|
*/
|
|
136
136
|
export declare enum FlushMode {
|
|
137
137
|
/**
|
|
@@ -212,7 +212,7 @@ export declare interface IAttachMessage {
|
|
|
212
212
|
/**
|
|
213
213
|
* A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
|
|
214
214
|
* TODO: this should be merged into IFluidDataStoreContext
|
|
215
|
-
* @
|
|
215
|
+
* @alpha
|
|
216
216
|
*/
|
|
217
217
|
export declare interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
|
|
218
218
|
readonly logger: ITelemetryBaseLogger;
|
|
@@ -273,7 +273,7 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
273
273
|
}
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* @
|
|
276
|
+
* @alpha
|
|
277
277
|
*/
|
|
278
278
|
export declare interface IContainerRuntimeBaseEvents extends IEvent {
|
|
279
279
|
(event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void): any;
|
|
@@ -291,7 +291,7 @@ export declare interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
291
291
|
* - Handle to the data store's entryPoint
|
|
292
292
|
* - Fluid router for the data store
|
|
293
293
|
* - Can be assigned an alias
|
|
294
|
-
* @
|
|
294
|
+
* @alpha
|
|
295
295
|
*/
|
|
296
296
|
export declare interface IDataStore {
|
|
297
297
|
/**
|
|
@@ -345,7 +345,7 @@ export declare interface IDataStore {
|
|
|
345
345
|
* Data describing a range of session-local IDs (from a remote or local session).
|
|
346
346
|
*
|
|
347
347
|
* A range is composed of local IDs that were generated.
|
|
348
|
-
* @
|
|
348
|
+
* @alpha
|
|
349
349
|
*/
|
|
350
350
|
export declare interface IdCreationRange {
|
|
351
351
|
readonly sessionId: SessionId;
|
|
@@ -373,7 +373,7 @@ export declare interface IEnvelope {
|
|
|
373
373
|
/**
|
|
374
374
|
* @experimental - Can be deleted/changed at any time
|
|
375
375
|
* Contains the necessary information to allow DDSes to do incremental summaries
|
|
376
|
-
* @
|
|
376
|
+
* @alpha
|
|
377
377
|
*/
|
|
378
378
|
export declare interface IExperimentalIncrementalSummaryContext {
|
|
379
379
|
/**
|
|
@@ -402,7 +402,7 @@ export declare interface IExperimentalIncrementalSummaryContext {
|
|
|
402
402
|
*
|
|
403
403
|
* Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
|
|
404
404
|
* and connection state notifications
|
|
405
|
-
* @
|
|
405
|
+
* @alpha
|
|
406
406
|
*/
|
|
407
407
|
export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
408
408
|
readonly id: string;
|
|
@@ -489,7 +489,7 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
489
489
|
/**
|
|
490
490
|
* Represents the context for the data store. It is used by the data store runtime to
|
|
491
491
|
* get information and call functionality to the container.
|
|
492
|
-
* @
|
|
492
|
+
* @alpha
|
|
493
493
|
*/
|
|
494
494
|
export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreContextEvents>, Partial<IProvideFluidDataStoreRegistry>, IProvideFluidHandleContext {
|
|
495
495
|
readonly id: string;
|
|
@@ -607,7 +607,7 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
|
|
|
607
607
|
}
|
|
608
608
|
|
|
609
609
|
/**
|
|
610
|
-
* @
|
|
610
|
+
* @alpha
|
|
611
611
|
*/
|
|
612
612
|
export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
|
|
613
613
|
/**
|
|
@@ -617,21 +617,21 @@ export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreC
|
|
|
617
617
|
}
|
|
618
618
|
|
|
619
619
|
/**
|
|
620
|
-
* @
|
|
620
|
+
* @alpha
|
|
621
621
|
*/
|
|
622
622
|
export declare interface IFluidDataStoreContextEvents extends IEvent {
|
|
623
623
|
(event: "attaching" | "attached", listener: () => void): any;
|
|
624
624
|
}
|
|
625
625
|
|
|
626
626
|
/**
|
|
627
|
-
* @
|
|
627
|
+
* @alpha
|
|
628
628
|
*/
|
|
629
629
|
export declare const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
|
|
630
630
|
|
|
631
631
|
/**
|
|
632
632
|
* IFluidDataStoreFactory create data stores. It is associated with an identifier (its `type` member)
|
|
633
633
|
* and usually provided to consumers using this mapping through a data store registry.
|
|
634
|
-
* @
|
|
634
|
+
* @alpha
|
|
635
635
|
*/
|
|
636
636
|
export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
|
|
637
637
|
/**
|
|
@@ -647,14 +647,14 @@ export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFa
|
|
|
647
647
|
}
|
|
648
648
|
|
|
649
649
|
/**
|
|
650
|
-
* @
|
|
650
|
+
* @alpha
|
|
651
651
|
*/
|
|
652
652
|
export declare const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
|
|
653
653
|
|
|
654
654
|
/**
|
|
655
655
|
* An association of identifiers to data store registry entries, where the
|
|
656
656
|
* entries can be used to create data stores.
|
|
657
|
-
* @
|
|
657
|
+
* @alpha
|
|
658
658
|
*/
|
|
659
659
|
export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
|
|
660
660
|
get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
|
|
@@ -663,7 +663,7 @@ export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreR
|
|
|
663
663
|
/**
|
|
664
664
|
* Garbage collection data returned by nodes in a Container.
|
|
665
665
|
* Used for running GC in the Container.
|
|
666
|
-
* @
|
|
666
|
+
* @alpha
|
|
667
667
|
*/
|
|
668
668
|
export declare interface IGarbageCollectionData {
|
|
669
669
|
/**
|
|
@@ -676,7 +676,7 @@ export declare interface IGarbageCollectionData {
|
|
|
676
676
|
|
|
677
677
|
/**
|
|
678
678
|
* GC details provided to each node during creation.
|
|
679
|
-
* @
|
|
679
|
+
* @alpha
|
|
680
680
|
*/
|
|
681
681
|
export declare interface IGarbageCollectionDetailsBase {
|
|
682
682
|
/**
|
|
@@ -749,7 +749,7 @@ export declare interface IGarbageCollectionDetailsBase {
|
|
|
749
749
|
*
|
|
750
750
|
* These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
|
|
751
751
|
* should use op-space IDs.
|
|
752
|
-
* @
|
|
752
|
+
* @alpha
|
|
753
753
|
*/
|
|
754
754
|
export declare interface IIdCompressor {
|
|
755
755
|
localSessionId: SessionId;
|
|
@@ -796,7 +796,7 @@ export declare interface IIdCompressor {
|
|
|
796
796
|
}
|
|
797
797
|
|
|
798
798
|
/**
|
|
799
|
-
* @
|
|
799
|
+
* @alpha
|
|
800
800
|
*/
|
|
801
801
|
export declare interface IIdCompressorCore {
|
|
802
802
|
/**
|
|
@@ -825,7 +825,7 @@ export declare interface IIdCompressorCore {
|
|
|
825
825
|
|
|
826
826
|
/**
|
|
827
827
|
* Represents ISignalMessage with its type.
|
|
828
|
-
* @
|
|
828
|
+
* @alpha
|
|
829
829
|
*/
|
|
830
830
|
export declare interface IInboundSignalMessage extends ISignalMessage {
|
|
831
831
|
type: string;
|
|
@@ -850,14 +850,14 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
|
|
|
850
850
|
export declare const initialClusterCapacity = 512;
|
|
851
851
|
|
|
852
852
|
/**
|
|
853
|
-
* @
|
|
853
|
+
* @alpha
|
|
854
854
|
*/
|
|
855
855
|
export declare interface IProvideFluidDataStoreFactory {
|
|
856
856
|
readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
|
|
857
857
|
}
|
|
858
858
|
|
|
859
859
|
/**
|
|
860
|
-
* @
|
|
860
|
+
* @alpha
|
|
861
861
|
*/
|
|
862
862
|
export declare interface IProvideFluidDataStoreRegistry {
|
|
863
863
|
readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
|
|
@@ -898,7 +898,7 @@ export declare interface ISignalEnvelope {
|
|
|
898
898
|
* ...
|
|
899
899
|
* "path1":
|
|
900
900
|
* ```
|
|
901
|
-
* @
|
|
901
|
+
* @alpha
|
|
902
902
|
*/
|
|
903
903
|
export declare interface ISummarizeInternalResult extends ISummarizeResult {
|
|
904
904
|
id: string;
|
|
@@ -910,7 +910,7 @@ export declare interface ISummarizeInternalResult extends ISummarizeResult {
|
|
|
910
910
|
|
|
911
911
|
/**
|
|
912
912
|
* Represents a summary at a current sequence number.
|
|
913
|
-
* @
|
|
913
|
+
* @alpha
|
|
914
914
|
*/
|
|
915
915
|
export declare interface ISummarizeResult {
|
|
916
916
|
stats: ISummaryStats;
|
|
@@ -918,7 +918,7 @@ export declare interface ISummarizeResult {
|
|
|
918
918
|
}
|
|
919
919
|
|
|
920
920
|
/**
|
|
921
|
-
* @
|
|
921
|
+
* @alpha
|
|
922
922
|
*/
|
|
923
923
|
export declare interface ISummarizerNode {
|
|
924
924
|
/**
|
|
@@ -980,7 +980,7 @@ export declare interface ISummarizerNode {
|
|
|
980
980
|
}
|
|
981
981
|
|
|
982
982
|
/**
|
|
983
|
-
* @
|
|
983
|
+
* @alpha
|
|
984
984
|
*/
|
|
985
985
|
export declare interface ISummarizerNodeConfig {
|
|
986
986
|
/**
|
|
@@ -1001,7 +1001,7 @@ export declare interface ISummarizerNodeConfig {
|
|
|
1001
1001
|
}
|
|
1002
1002
|
|
|
1003
1003
|
/**
|
|
1004
|
-
* @
|
|
1004
|
+
* @alpha
|
|
1005
1005
|
*/
|
|
1006
1006
|
export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
|
|
1007
1007
|
/**
|
|
@@ -1032,7 +1032,7 @@ export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConf
|
|
|
1032
1032
|
* `isReferenced`: This tells whether this node is referenced in the document or not.
|
|
1033
1033
|
*
|
|
1034
1034
|
* `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
|
|
1035
|
-
* @
|
|
1035
|
+
* @alpha
|
|
1036
1036
|
*/
|
|
1037
1037
|
export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
|
|
1038
1038
|
createChild(
|
|
@@ -1086,7 +1086,7 @@ export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
|
|
|
1086
1086
|
|
|
1087
1087
|
/**
|
|
1088
1088
|
* Contains the aggregation data from a Tree/Subtree.
|
|
1089
|
-
* @
|
|
1089
|
+
* @alpha
|
|
1090
1090
|
*/
|
|
1091
1091
|
export declare interface ISummaryStats {
|
|
1092
1092
|
treeNodeCount: number;
|
|
@@ -1102,7 +1102,7 @@ export declare interface ISummaryStats {
|
|
|
1102
1102
|
* each of its DDS.
|
|
1103
1103
|
* Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
|
|
1104
1104
|
* will be taking part of the summarization process.
|
|
1105
|
-
* @
|
|
1105
|
+
* @alpha
|
|
1106
1106
|
*/
|
|
1107
1107
|
export declare interface ISummaryTreeWithStats {
|
|
1108
1108
|
/**
|
|
@@ -1119,7 +1119,7 @@ export declare interface ISummaryTreeWithStats {
|
|
|
1119
1119
|
/**
|
|
1120
1120
|
* Contains telemetry data relevant to summarization workflows.
|
|
1121
1121
|
* This object is expected to be modified directly by various summarize methods.
|
|
1122
|
-
* @
|
|
1122
|
+
* @alpha
|
|
1123
1123
|
*/
|
|
1124
1124
|
export declare interface ITelemetryContext {
|
|
1125
1125
|
/**
|
|
@@ -1160,14 +1160,14 @@ export declare interface LocalAttributionKey {
|
|
|
1160
1160
|
|
|
1161
1161
|
/**
|
|
1162
1162
|
* An iterable identifier/registry entry pair list
|
|
1163
|
-
* @
|
|
1163
|
+
* @alpha
|
|
1164
1164
|
*/
|
|
1165
1165
|
export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
|
|
1166
1166
|
|
|
1167
1167
|
/**
|
|
1168
1168
|
* An associated pair of an identifier and registry entry. Registry entries
|
|
1169
1169
|
* may be dynamically loaded.
|
|
1170
|
-
* @
|
|
1170
|
+
* @alpha
|
|
1171
1171
|
*/
|
|
1172
1172
|
export declare type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
|
|
1173
1173
|
|
|
@@ -1194,7 +1194,7 @@ export declare interface OpAttributionKey {
|
|
|
1194
1194
|
* A compressed ID that has been normalized into "op space".
|
|
1195
1195
|
* Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require less normalizing when
|
|
1196
1196
|
* received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.
|
|
1197
|
-
* @
|
|
1197
|
+
* @alpha
|
|
1198
1198
|
*/
|
|
1199
1199
|
export declare type OpSpaceCompressedId = number & {
|
|
1200
1200
|
readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
|
|
@@ -1202,7 +1202,7 @@ export declare type OpSpaceCompressedId = number & {
|
|
|
1202
1202
|
|
|
1203
1203
|
/**
|
|
1204
1204
|
* The serialized contents of an IdCompressor, suitable for persistence in a summary.
|
|
1205
|
-
* @
|
|
1205
|
+
* @alpha
|
|
1206
1206
|
*/
|
|
1207
1207
|
export declare type SerializedIdCompressor = string & {
|
|
1208
1208
|
readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
|
|
@@ -1210,7 +1210,7 @@ export declare type SerializedIdCompressor = string & {
|
|
|
1210
1210
|
|
|
1211
1211
|
/**
|
|
1212
1212
|
* The serialized contents of an IdCompressor, suitable for persistence in a summary.
|
|
1213
|
-
* @
|
|
1213
|
+
* @alpha
|
|
1214
1214
|
*/
|
|
1215
1215
|
export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
|
|
1216
1216
|
readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
|
|
@@ -1218,7 +1218,7 @@ export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor
|
|
|
1218
1218
|
|
|
1219
1219
|
/**
|
|
1220
1220
|
* The serialized contents of an IdCompressor, suitable for persistence in a summary.
|
|
1221
|
-
* @
|
|
1221
|
+
* @alpha
|
|
1222
1222
|
*/
|
|
1223
1223
|
export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
|
|
1224
1224
|
readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
|
|
@@ -1226,7 +1226,7 @@ export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompr
|
|
|
1226
1226
|
|
|
1227
1227
|
/**
|
|
1228
1228
|
* A StableId which is suitable for use as a session identifier
|
|
1229
|
-
* @
|
|
1229
|
+
* @alpha
|
|
1230
1230
|
*/
|
|
1231
1231
|
export declare type SessionId = StableId & {
|
|
1232
1232
|
readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
|
|
@@ -1236,7 +1236,7 @@ export declare type SessionId = StableId & {
|
|
|
1236
1236
|
* A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
|
|
1237
1237
|
* Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to
|
|
1238
1238
|
* the scope of the session (i.e. compressor) that produced them.
|
|
1239
|
-
* @
|
|
1239
|
+
* @alpha
|
|
1240
1240
|
*/
|
|
1241
1241
|
export declare type SessionSpaceCompressedId = number & {
|
|
1242
1242
|
readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
|
|
@@ -1247,14 +1247,14 @@ export declare type SessionSpaceCompressedId = number & {
|
|
|
1247
1247
|
* A 128-bit Universally Unique IDentifier. Represented here
|
|
1248
1248
|
* with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
|
|
1249
1249
|
* where x is a lowercase hex digit.
|
|
1250
|
-
* @
|
|
1250
|
+
* @alpha
|
|
1251
1251
|
*/
|
|
1252
1252
|
export declare type StableId = string & {
|
|
1253
1253
|
readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
|
|
1254
1254
|
};
|
|
1255
1255
|
|
|
1256
1256
|
/**
|
|
1257
|
-
* @
|
|
1257
|
+
* @alpha
|
|
1258
1258
|
*/
|
|
1259
1259
|
export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
|
|
1260
1260
|
|
|
@@ -1266,7 +1266,7 @@ export declare const totalBlobSizePropertyName = "TotalBlobSize";
|
|
|
1266
1266
|
/**
|
|
1267
1267
|
* This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible
|
|
1268
1268
|
* locally within the container only or visible globally to all clients.
|
|
1269
|
-
* @
|
|
1269
|
+
* @alpha
|
|
1270
1270
|
*/
|
|
1271
1271
|
export declare const VisibilityState: {
|
|
1272
1272
|
/**
|
|
@@ -1292,7 +1292,7 @@ export declare const VisibilityState: {
|
|
|
1292
1292
|
};
|
|
1293
1293
|
|
|
1294
1294
|
/**
|
|
1295
|
-
* @
|
|
1295
|
+
* @alpha
|
|
1296
1296
|
*/
|
|
1297
1297
|
export declare type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
|
|
1298
1298
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/runtime-definitions",
|
|
3
|
-
"version": "2.0.0-dev.7.4.0.
|
|
3
|
+
"version": "2.0.0-dev.7.4.0.217884",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
"main": "dist/index.js",
|
|
15
15
|
"types": "dist/index.d.ts",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@fluidframework/container-definitions": "2.0.0-dev.7.4.0.
|
|
18
|
-
"@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.
|
|
19
|
-
"@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.
|
|
17
|
+
"@fluidframework/container-definitions": "2.0.0-dev.7.4.0.217884",
|
|
18
|
+
"@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217884",
|
|
19
|
+
"@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.217884",
|
|
20
20
|
"@fluidframework/protocol-definitions": "^3.0.0"
|
|
21
21
|
},
|
|
22
22
|
"devDependencies": {
|
package/src/dataStoreContext.ts
CHANGED
|
@@ -46,7 +46,7 @@ import { IIdCompressor } from "./id-compressor";
|
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
48
|
* Runtime flush mode handling
|
|
49
|
-
* @
|
|
49
|
+
* @alpha
|
|
50
50
|
*/
|
|
51
51
|
export enum FlushMode {
|
|
52
52
|
/**
|
|
@@ -80,7 +80,7 @@ export enum FlushModeExperimental {
|
|
|
80
80
|
/**
|
|
81
81
|
* This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible
|
|
82
82
|
* locally within the container only or visible globally to all clients.
|
|
83
|
-
* @
|
|
83
|
+
* @alpha
|
|
84
84
|
*/
|
|
85
85
|
export const VisibilityState = {
|
|
86
86
|
/**
|
|
@@ -107,12 +107,12 @@ export const VisibilityState = {
|
|
|
107
107
|
GloballyVisible: "GloballyVisible",
|
|
108
108
|
};
|
|
109
109
|
/**
|
|
110
|
-
* @
|
|
110
|
+
* @alpha
|
|
111
111
|
*/
|
|
112
112
|
export type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
|
-
* @
|
|
115
|
+
* @alpha
|
|
116
116
|
*/
|
|
117
117
|
export interface IContainerRuntimeBaseEvents extends IEvent {
|
|
118
118
|
(event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void);
|
|
@@ -133,7 +133,7 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
133
133
|
* the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded
|
|
134
134
|
* and will be garbage collected. The current datastore cannot be aliased to a different value.
|
|
135
135
|
* 'AlreadyAliased' - the datastore has already been previously bound to another alias name.
|
|
136
|
-
* @
|
|
136
|
+
* @alpha
|
|
137
137
|
*/
|
|
138
138
|
export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
|
|
139
139
|
|
|
@@ -142,7 +142,7 @@ export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
|
|
|
142
142
|
* - Handle to the data store's entryPoint
|
|
143
143
|
* - Fluid router for the data store
|
|
144
144
|
* - Can be assigned an alias
|
|
145
|
-
* @
|
|
145
|
+
* @alpha
|
|
146
146
|
*/
|
|
147
147
|
export interface IDataStore {
|
|
148
148
|
/**
|
|
@@ -197,7 +197,7 @@ export interface IDataStore {
|
|
|
197
197
|
/**
|
|
198
198
|
* A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
|
|
199
199
|
* TODO: this should be merged into IFluidDataStoreContext
|
|
200
|
-
* @
|
|
200
|
+
* @alpha
|
|
201
201
|
*/
|
|
202
202
|
export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
|
|
203
203
|
readonly logger: ITelemetryBaseLogger;
|
|
@@ -277,7 +277,7 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
277
277
|
*
|
|
278
278
|
* Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
|
|
279
279
|
* and connection state notifications
|
|
280
|
-
* @
|
|
280
|
+
* @alpha
|
|
281
281
|
*/
|
|
282
282
|
export interface IFluidDataStoreChannel extends IDisposable {
|
|
283
283
|
readonly id: string;
|
|
@@ -384,7 +384,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
|
|
|
384
384
|
}
|
|
385
385
|
|
|
386
386
|
/**
|
|
387
|
-
* @
|
|
387
|
+
* @alpha
|
|
388
388
|
*/
|
|
389
389
|
export type CreateChildSummarizerNodeFn = (
|
|
390
390
|
summarizeInternal: SummarizeInternalFn,
|
|
@@ -396,7 +396,7 @@ export type CreateChildSummarizerNodeFn = (
|
|
|
396
396
|
) => ISummarizerNodeWithGC;
|
|
397
397
|
|
|
398
398
|
/**
|
|
399
|
-
* @
|
|
399
|
+
* @alpha
|
|
400
400
|
*/
|
|
401
401
|
export interface IFluidDataStoreContextEvents extends IEvent {
|
|
402
402
|
(event: "attaching" | "attached", listener: () => void);
|
|
@@ -405,7 +405,7 @@ export interface IFluidDataStoreContextEvents extends IEvent {
|
|
|
405
405
|
/**
|
|
406
406
|
* Represents the context for the data store. It is used by the data store runtime to
|
|
407
407
|
* get information and call functionality to the container.
|
|
408
|
-
* @
|
|
408
|
+
* @alpha
|
|
409
409
|
*/
|
|
410
410
|
export interface IFluidDataStoreContext
|
|
411
411
|
extends IEventProvider<IFluidDataStoreContextEvents>,
|
|
@@ -542,7 +542,7 @@ export interface IFluidDataStoreContext
|
|
|
542
542
|
}
|
|
543
543
|
|
|
544
544
|
/**
|
|
545
|
-
* @
|
|
545
|
+
* @alpha
|
|
546
546
|
*/
|
|
547
547
|
export interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
|
|
548
548
|
/**
|
package/src/dataStoreFactory.ts
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
import { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreContext";
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @
|
|
9
|
+
* @alpha
|
|
10
10
|
*/
|
|
11
11
|
export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* @
|
|
14
|
+
* @alpha
|
|
15
15
|
*/
|
|
16
16
|
export interface IProvideFluidDataStoreFactory {
|
|
17
17
|
readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
|
|
@@ -20,7 +20,7 @@ export interface IProvideFluidDataStoreFactory {
|
|
|
20
20
|
/**
|
|
21
21
|
* IFluidDataStoreFactory create data stores. It is associated with an identifier (its `type` member)
|
|
22
22
|
* and usually provided to consumers using this mapping through a data store registry.
|
|
23
|
-
* @
|
|
23
|
+
* @alpha
|
|
24
24
|
*/
|
|
25
25
|
export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
|
|
26
26
|
/**
|
package/src/dataStoreRegistry.ts
CHANGED
|
@@ -8,7 +8,7 @@ import { IProvideFluidDataStoreFactory } from "./dataStoreFactory";
|
|
|
8
8
|
/**
|
|
9
9
|
* A single registry entry that may be used to create data stores
|
|
10
10
|
* It has to have either factory or registry, or both.
|
|
11
|
-
* @
|
|
11
|
+
* @alpha
|
|
12
12
|
*/
|
|
13
13
|
export type FluidDataStoreRegistryEntry = Readonly<
|
|
14
14
|
Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>
|
|
@@ -16,23 +16,23 @@ export type FluidDataStoreRegistryEntry = Readonly<
|
|
|
16
16
|
/**
|
|
17
17
|
* An associated pair of an identifier and registry entry. Registry entries
|
|
18
18
|
* may be dynamically loaded.
|
|
19
|
-
* @
|
|
19
|
+
* @alpha
|
|
20
20
|
*/
|
|
21
21
|
export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
|
|
22
22
|
/**
|
|
23
23
|
* An iterable identifier/registry entry pair list
|
|
24
|
-
* @
|
|
24
|
+
* @alpha
|
|
25
25
|
*/
|
|
26
26
|
export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* @
|
|
29
|
+
* @alpha
|
|
30
30
|
*/
|
|
31
31
|
export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =
|
|
32
32
|
"IFluidDataStoreRegistry";
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
* @
|
|
35
|
+
* @alpha
|
|
36
36
|
*/
|
|
37
37
|
export interface IProvideFluidDataStoreRegistry {
|
|
38
38
|
readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
|
|
@@ -41,7 +41,7 @@ export interface IProvideFluidDataStoreRegistry {
|
|
|
41
41
|
/**
|
|
42
42
|
* An association of identifiers to data store registry entries, where the
|
|
43
43
|
* entries can be used to create data stores.
|
|
44
|
-
* @
|
|
44
|
+
* @alpha
|
|
45
45
|
*/
|
|
46
46
|
export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
|
|
47
47
|
get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
|
package/src/garbageCollection.ts
CHANGED
|
@@ -31,7 +31,7 @@ export const gcDeletedBlobKey = "__deletedNodes";
|
|
|
31
31
|
/**
|
|
32
32
|
* Garbage collection data returned by nodes in a Container.
|
|
33
33
|
* Used for running GC in the Container.
|
|
34
|
-
* @
|
|
34
|
+
* @alpha
|
|
35
35
|
*/
|
|
36
36
|
export interface IGarbageCollectionData {
|
|
37
37
|
/**
|
|
@@ -42,7 +42,7 @@ export interface IGarbageCollectionData {
|
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
44
|
* GC details provided to each node during creation.
|
|
45
|
-
* @
|
|
45
|
+
* @alpha
|
|
46
46
|
*/
|
|
47
47
|
export interface IGarbageCollectionDetailsBase {
|
|
48
48
|
/**
|
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
} from "./persisted-types";
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* @
|
|
14
|
+
* @alpha
|
|
15
15
|
*/
|
|
16
16
|
export interface IIdCompressorCore {
|
|
17
17
|
/**
|
|
@@ -101,7 +101,7 @@ export interface IIdCompressorCore {
|
|
|
101
101
|
*
|
|
102
102
|
* These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
|
|
103
103
|
* should use op-space IDs.
|
|
104
|
-
* @
|
|
104
|
+
* @alpha
|
|
105
105
|
*/
|
|
106
106
|
export interface IIdCompressor {
|
|
107
107
|
localSessionId: SessionId;
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
|
|
8
8
|
* Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to
|
|
9
9
|
* the scope of the session (i.e. compressor) that produced them.
|
|
10
|
-
* @
|
|
10
|
+
* @alpha
|
|
11
11
|
*/
|
|
12
12
|
export type SessionSpaceCompressedId = number & {
|
|
13
13
|
readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
|
|
@@ -17,7 +17,7 @@ export type SessionSpaceCompressedId = number & {
|
|
|
17
17
|
* A compressed ID that has been normalized into "op space".
|
|
18
18
|
* Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require less normalizing when
|
|
19
19
|
* received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.
|
|
20
|
-
* @
|
|
20
|
+
* @alpha
|
|
21
21
|
*/
|
|
22
22
|
export type OpSpaceCompressedId = number & {
|
|
23
23
|
readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
|
|
@@ -28,12 +28,12 @@ export type OpSpaceCompressedId = number & {
|
|
|
28
28
|
* A 128-bit Universally Unique IDentifier. Represented here
|
|
29
29
|
* with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
|
|
30
30
|
* where x is a lowercase hex digit.
|
|
31
|
-
* @
|
|
31
|
+
* @alpha
|
|
32
32
|
*/
|
|
33
33
|
export type StableId = string & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a" };
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
36
|
* A StableId which is suitable for use as a session identifier
|
|
37
|
-
* @
|
|
37
|
+
* @alpha
|
|
38
38
|
*/
|
|
39
39
|
export type SessionId = StableId & { readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58" };
|