@fluidframework/runtime-definitions 2.70.0-361788 → 2.70.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 +26 -0
- package/api-report/runtime-definitions.legacy.alpha.api.md +0 -17
- package/api-report/runtime-definitions.legacy.beta.api.md +0 -17
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +0 -3
- package/dist/legacyAlpha.d.ts +0 -3
- package/dist/stagingMode.d.ts +8 -31
- package/dist/stagingMode.d.ts.map +1 -1
- package/dist/stagingMode.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/legacy.d.ts +0 -3
- package/lib/legacyAlpha.d.ts +0 -3
- package/lib/stagingMode.d.ts +8 -31
- package/lib/stagingMode.d.ts.map +1 -1
- package/lib/stagingMode.js.map +1 -1
- package/package.json +15 -6
- package/src/index.ts +3 -3
- package/src/stagingMode.ts +8 -31
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# @fluidframework/runtime-definitions
|
|
2
2
|
|
|
3
|
+
## 2.70.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Deprecated properties have been removed from IRuntimeStorageService and IContainerStorageService ([#25708](https://github.com/microsoft/FluidFramework/pull/25708)) [82c936ed28](https://github.com/microsoft/FluidFramework/commit/82c936ed285c7e450d5e907a531ce71178f57819)
|
|
8
|
+
|
|
9
|
+
The following deprecated properties have been removed from `IRuntimeStorageService`:
|
|
10
|
+
|
|
11
|
+
- `createBlob`
|
|
12
|
+
- `dispose`
|
|
13
|
+
- `disposed`
|
|
14
|
+
- `downloadSummary`
|
|
15
|
+
- `getSnapshot`
|
|
16
|
+
- `getSnapshotTree`
|
|
17
|
+
- `getVersions`
|
|
18
|
+
- `policies`
|
|
19
|
+
- `uploadSummaryWithContext`
|
|
20
|
+
|
|
21
|
+
The following deprecated properties have been removed from `IContainerStorageService`:
|
|
22
|
+
|
|
23
|
+
- `dispose`
|
|
24
|
+
- `disposed`
|
|
25
|
+
- `downloadSummary`
|
|
26
|
+
|
|
27
|
+
Please see [this Github issue](https://github.com/microsoft/FluidFramework/issues/25069) for more details.
|
|
28
|
+
|
|
3
29
|
## 2.63.0
|
|
4
30
|
|
|
5
31
|
Dependency updates only.
|
|
@@ -19,11 +19,6 @@ export interface AttributionInfo {
|
|
|
19
19
|
// @beta @legacy
|
|
20
20
|
export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
|
|
21
21
|
|
|
22
|
-
// @beta @sealed @deprecated @legacy
|
|
23
|
-
export interface CommitStagedChangesOptionsExperimental {
|
|
24
|
-
squash?: boolean;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
22
|
// @alpha @sealed @legacy
|
|
28
23
|
export interface ContainerRuntimeBaseAlpha extends IContainerRuntimeBase {
|
|
29
24
|
enterStagingMode(): StageControlsAlpha;
|
|
@@ -115,12 +110,6 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
115
110
|
(event: "dispose", listener: () => void): any;
|
|
116
111
|
}
|
|
117
112
|
|
|
118
|
-
// @beta @sealed @deprecated @legacy
|
|
119
|
-
export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase {
|
|
120
|
-
enterStagingMode?(): StageControlsExperimental;
|
|
121
|
-
readonly inStagingMode?: boolean;
|
|
122
|
-
}
|
|
123
|
-
|
|
124
113
|
// @beta @legacy
|
|
125
114
|
export interface IDataStore {
|
|
126
115
|
readonly entryPoint: IFluidHandleInternal<FluidObject>;
|
|
@@ -438,12 +427,6 @@ export interface StageControlsAlpha {
|
|
|
438
427
|
readonly discardChanges: () => void;
|
|
439
428
|
}
|
|
440
429
|
|
|
441
|
-
// @beta @sealed @deprecated @legacy
|
|
442
|
-
export interface StageControlsExperimental {
|
|
443
|
-
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;
|
|
444
|
-
readonly discardChanges: () => void;
|
|
445
|
-
}
|
|
446
|
-
|
|
447
430
|
// @beta @legacy (undocumented)
|
|
448
431
|
export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
|
|
449
432
|
|
|
@@ -16,11 +16,6 @@ export interface AttributionInfo {
|
|
|
16
16
|
// @beta @legacy
|
|
17
17
|
export type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
|
|
18
18
|
|
|
19
|
-
// @beta @sealed @deprecated @legacy
|
|
20
|
-
export interface CommitStagedChangesOptionsExperimental {
|
|
21
|
-
squash?: boolean;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
19
|
// @beta @legacy (undocumented)
|
|
25
20
|
export type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
|
|
26
21
|
getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
|
|
@@ -106,12 +101,6 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
106
101
|
(event: "dispose", listener: () => void): any;
|
|
107
102
|
}
|
|
108
103
|
|
|
109
|
-
// @beta @sealed @deprecated @legacy
|
|
110
|
-
export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase {
|
|
111
|
-
enterStagingMode?(): StageControlsExperimental;
|
|
112
|
-
readonly inStagingMode?: boolean;
|
|
113
|
-
}
|
|
114
|
-
|
|
115
104
|
// @beta @legacy
|
|
116
105
|
export interface IDataStore {
|
|
117
106
|
readonly entryPoint: IFluidHandleInternal<FluidObject>;
|
|
@@ -423,12 +412,6 @@ export interface OpAttributionKey {
|
|
|
423
412
|
// @beta @legacy
|
|
424
413
|
export type PackagePath = readonly string[];
|
|
425
414
|
|
|
426
|
-
// @beta @sealed @deprecated @legacy
|
|
427
|
-
export interface StageControlsExperimental {
|
|
428
|
-
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;
|
|
429
|
-
readonly discardChanges: () => void;
|
|
430
|
-
}
|
|
431
|
-
|
|
432
415
|
// @beta @legacy (undocumented)
|
|
433
416
|
export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
|
|
434
417
|
|
package/dist/index.d.ts
CHANGED
|
@@ -16,5 +16,5 @@ export { encodeHandlesInContainerRuntime, notifiesReadOnlyState, } from "./runti
|
|
|
16
16
|
export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, ITelemetryContextExt, SummarizeInternalFn, } from "./summary.js";
|
|
17
17
|
export { blobCountPropertyName, channelsTreeName, CreateSummarizerNodeSource, totalBlobSizePropertyName, } from "./summary.js";
|
|
18
18
|
export type { MinimumVersionForCollab } from "./compatibilityDefinitions.js";
|
|
19
|
-
export { type ContainerRuntimeBaseAlpha, type StageControlsAlpha, type
|
|
19
|
+
export { type ContainerRuntimeBaseAlpha, type StageControlsAlpha, type CommitStagedChangesOptionsInternal, type IContainerRuntimeBaseInternal, type StageControlsInternal, asLegacyAlpha, } from "./stagingMode.js";
|
|
20
20
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACX,WAAW,EACX,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,WAAW,GACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1F,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,YAAY,EACX,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACX,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACX,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EACX,8BAA8B,EAC9B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAE7E,OAAO,EACN,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACX,WAAW,EACX,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,WAAW,GACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1F,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,YAAY,EACX,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACX,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACX,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EACX,8BAA8B,EAC9B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAE7E,OAAO,EACN,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,kCAAkC,EACvC,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,aAAa,GACb,MAAM,kBAAkB,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH,6DAA0F;AAAjF,gHAAA,SAAS,OAAA;AAAE,4HAAA,qBAAqB,OAAA;AAAE,sHAAA,eAAe,OAAA;AAE1D,6DAA+D;AAAtD,6HAAA,sBAAsB,OAAA;AAQ/B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAKhC,qFAM2C;AAL1C,+HAAA,YAAY,OAAA;AACZ,gIAAA,aAAa,OAAA;AACb,mIAAA,gBAAgB,OAAA;AAChB,qIAAA,kBAAkB,OAAA;AAClB,4HAAA,SAAS,OAAA;AAYV,yFAG6C;AAF5C,oJAAA,+BAA+B,OAAA;AAC/B,0IAAA,qBAAqB,OAAA;AAiBtB,2CAKsB;AAJrB,mHAAA,qBAAqB,OAAA;AACrB,8GAAA,gBAAgB,OAAA;AAChB,wHAAA,0BAA0B,OAAA;AAC1B,uHAAA,yBAAyB,OAAA;AAI1B,mDAO0B;AADzB,+GAAA,aAAa,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution.js\";\nexport type {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStorePolicies,\n\tIFluidDataStoreContext,\n\tIFluidParentContext,\n\tIFluidDataStoreContextDetached,\n\tIPendingMessagesState,\n\tPackagePath,\n} from \"./dataStoreContext.js\";\nexport { FlushMode, FlushModeExperimental, VisibilityState } from \"./dataStoreContext.js\";\nexport type { IProvideFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport { IFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport type {\n\tFluidDataStoreRegistryEntry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n\tNamedFluidDataStoreRegistryEntry2,\n} from \"./dataStoreRegistry.js\";\nexport { IFluidDataStoreRegistry } from \"./dataStoreRegistry.js\";\nexport type {\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollectionDefinitions.js\";\nexport {\n\tgcBlobPrefix,\n\tgcDataBlobKey,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n} from \"./garbageCollectionDefinitions.js\";\nexport type {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tIRuntimeMessageCollection,\n\tIRuntimeMessagesContent,\n\tISequencedMessageEnvelope,\n\tIRuntimeStorageService,\n} from \"./protocol.js\";\nexport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"./runtimeLayerCompatFeatureNames.js\";\nexport type {\n\tCreateChildSummarizerNodeParam,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tITelemetryContextExt,\n\tSummarizeInternalFn,\n} from \"./summary.js\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateSummarizerNodeSource,\n\ttotalBlobSizePropertyName,\n} from \"./summary.js\";\nexport type { MinimumVersionForCollab } from \"./compatibilityDefinitions.js\";\n\nexport {\n\ttype ContainerRuntimeBaseAlpha,\n\ttype StageControlsAlpha,\n\ttype
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH,6DAA0F;AAAjF,gHAAA,SAAS,OAAA;AAAE,4HAAA,qBAAqB,OAAA;AAAE,sHAAA,eAAe,OAAA;AAE1D,6DAA+D;AAAtD,6HAAA,sBAAsB,OAAA;AAQ/B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAKhC,qFAM2C;AAL1C,+HAAA,YAAY,OAAA;AACZ,gIAAA,aAAa,OAAA;AACb,mIAAA,gBAAgB,OAAA;AAChB,qIAAA,kBAAkB,OAAA;AAClB,4HAAA,SAAS,OAAA;AAYV,yFAG6C;AAF5C,oJAAA,+BAA+B,OAAA;AAC/B,0IAAA,qBAAqB,OAAA;AAiBtB,2CAKsB;AAJrB,mHAAA,qBAAqB,OAAA;AACrB,8GAAA,gBAAgB,OAAA;AAChB,wHAAA,0BAA0B,OAAA;AAC1B,uHAAA,yBAAyB,OAAA;AAI1B,mDAO0B;AADzB,+GAAA,aAAa,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution.js\";\nexport type {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStorePolicies,\n\tIFluidDataStoreContext,\n\tIFluidParentContext,\n\tIFluidDataStoreContextDetached,\n\tIPendingMessagesState,\n\tPackagePath,\n} from \"./dataStoreContext.js\";\nexport { FlushMode, FlushModeExperimental, VisibilityState } from \"./dataStoreContext.js\";\nexport type { IProvideFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport { IFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport type {\n\tFluidDataStoreRegistryEntry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n\tNamedFluidDataStoreRegistryEntry2,\n} from \"./dataStoreRegistry.js\";\nexport { IFluidDataStoreRegistry } from \"./dataStoreRegistry.js\";\nexport type {\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollectionDefinitions.js\";\nexport {\n\tgcBlobPrefix,\n\tgcDataBlobKey,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n} from \"./garbageCollectionDefinitions.js\";\nexport type {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tIRuntimeMessageCollection,\n\tIRuntimeMessagesContent,\n\tISequencedMessageEnvelope,\n\tIRuntimeStorageService,\n} from \"./protocol.js\";\nexport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"./runtimeLayerCompatFeatureNames.js\";\nexport type {\n\tCreateChildSummarizerNodeParam,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tITelemetryContextExt,\n\tSummarizeInternalFn,\n} from \"./summary.js\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateSummarizerNodeSource,\n\ttotalBlobSizePropertyName,\n} from \"./summary.js\";\nexport type { MinimumVersionForCollab } from \"./compatibilityDefinitions.js\";\n\nexport {\n\ttype ContainerRuntimeBaseAlpha,\n\ttype StageControlsAlpha,\n\ttype CommitStagedChangesOptionsInternal,\n\ttype IContainerRuntimeBaseInternal,\n\ttype StageControlsInternal,\n\tasLegacyAlpha,\n} from \"./stagingMode.js\";\n"]}
|
package/dist/legacy.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ export {
|
|
|
13
13
|
AliasResult,
|
|
14
14
|
AttributionInfo,
|
|
15
15
|
AttributionKey,
|
|
16
|
-
CommitStagedChangesOptionsExperimental,
|
|
17
16
|
CreateChildSummarizerNodeFn,
|
|
18
17
|
CreateChildSummarizerNodeParam,
|
|
19
18
|
CreateSummarizerNodeSource,
|
|
@@ -23,7 +22,6 @@ export {
|
|
|
23
22
|
IAttachMessage,
|
|
24
23
|
IContainerRuntimeBase,
|
|
25
24
|
IContainerRuntimeBaseEvents,
|
|
26
|
-
IContainerRuntimeBaseExperimental,
|
|
27
25
|
IDataStore,
|
|
28
26
|
IEnvelope,
|
|
29
27
|
IExperimentalIncrementalSummaryContext,
|
|
@@ -60,7 +58,6 @@ export {
|
|
|
60
58
|
NamedFluidDataStoreRegistryEntry2,
|
|
61
59
|
OpAttributionKey,
|
|
62
60
|
PackagePath,
|
|
63
|
-
StageControlsExperimental,
|
|
64
61
|
SummarizeInternalFn,
|
|
65
62
|
VisibilityState
|
|
66
63
|
// #endregion
|
package/dist/legacyAlpha.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ export {
|
|
|
13
13
|
AliasResult,
|
|
14
14
|
AttributionInfo,
|
|
15
15
|
AttributionKey,
|
|
16
|
-
CommitStagedChangesOptionsExperimental,
|
|
17
16
|
CreateChildSummarizerNodeFn,
|
|
18
17
|
CreateChildSummarizerNodeParam,
|
|
19
18
|
CreateSummarizerNodeSource,
|
|
@@ -23,7 +22,6 @@ export {
|
|
|
23
22
|
IAttachMessage,
|
|
24
23
|
IContainerRuntimeBase,
|
|
25
24
|
IContainerRuntimeBaseEvents,
|
|
26
|
-
IContainerRuntimeBaseExperimental,
|
|
27
25
|
IDataStore,
|
|
28
26
|
IEnvelope,
|
|
29
27
|
IExperimentalIncrementalSummaryContext,
|
|
@@ -60,7 +58,6 @@ export {
|
|
|
60
58
|
NamedFluidDataStoreRegistryEntry2,
|
|
61
59
|
OpAttributionKey,
|
|
62
60
|
PackagePath,
|
|
63
|
-
StageControlsExperimental,
|
|
64
61
|
SummarizeInternalFn,
|
|
65
62
|
VisibilityState,
|
|
66
63
|
// #endregion
|
package/dist/stagingMode.d.ts
CHANGED
|
@@ -5,14 +5,9 @@
|
|
|
5
5
|
import type { IContainerRuntimeBase } from "./dataStoreContext.js";
|
|
6
6
|
/**
|
|
7
7
|
* Options for committing staged changes in experimental staging mode.
|
|
8
|
-
*
|
|
9
|
-
* @experimental
|
|
10
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
11
|
-
* @legacy @beta
|
|
12
|
-
* @sealed
|
|
13
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
8
|
+
* @internal
|
|
14
9
|
*/
|
|
15
|
-
export interface
|
|
10
|
+
export interface CommitStagedChangesOptionsInternal {
|
|
16
11
|
/**
|
|
17
12
|
* If true, intermediate states created by changes made while in staging mode will be "squashed" out of the
|
|
18
13
|
* ops which were created during staging mode.
|
|
@@ -33,25 +28,16 @@ export interface CommitStagedChangesOptionsExperimental {
|
|
|
33
28
|
* Controls for managing staged changes in experimental staging mode.
|
|
34
29
|
*
|
|
35
30
|
* Provides methods to either commit or discard changes made while in staging mode.
|
|
36
|
-
*
|
|
37
|
-
* @experimental
|
|
38
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
39
|
-
* @legacy @beta
|
|
40
|
-
* @sealed
|
|
41
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
31
|
+
* @internal
|
|
42
32
|
*/
|
|
43
|
-
export interface
|
|
33
|
+
export interface StageControlsInternal extends StageControlsAlpha {
|
|
44
34
|
/**
|
|
45
35
|
* Exit staging mode and commit to any changes made while in staging mode.
|
|
46
36
|
* This will cause them to be sent to the ordering service, and subsequent changes
|
|
47
37
|
* made by this container will additionally flow freely to the ordering service.
|
|
48
38
|
* @param options - Options when committing changes.
|
|
49
39
|
*/
|
|
50
|
-
readonly commitChanges: (options?: Partial<
|
|
51
|
-
/**
|
|
52
|
-
* Exit staging mode and discard any changes made while in staging mode.
|
|
53
|
-
*/
|
|
54
|
-
readonly discardChanges: () => void;
|
|
40
|
+
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsInternal>) => void;
|
|
55
41
|
}
|
|
56
42
|
/**
|
|
57
43
|
* Controls for managing staged changes in alpha staging mode.
|
|
@@ -75,23 +61,14 @@ export interface StageControlsAlpha {
|
|
|
75
61
|
}
|
|
76
62
|
/**
|
|
77
63
|
* Experimental extension of {@link IContainerRuntimeBase} to support staging mode.
|
|
78
|
-
*
|
|
79
|
-
* @experimental
|
|
80
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
81
|
-
* @legacy @beta
|
|
82
|
-
* @sealed
|
|
83
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
64
|
+
* @internal
|
|
84
65
|
*/
|
|
85
|
-
export interface
|
|
66
|
+
export interface IContainerRuntimeBaseInternal extends ContainerRuntimeBaseAlpha {
|
|
86
67
|
/**
|
|
87
68
|
* Enters staging mode, allowing changes to be staged before being committed or discarded.
|
|
88
69
|
* @returns Controls for committing or discarding staged changes.
|
|
89
70
|
*/
|
|
90
|
-
enterStagingMode
|
|
91
|
-
/**
|
|
92
|
-
* Indicates whether the container is currently in staging mode.
|
|
93
|
-
*/
|
|
94
|
-
readonly inStagingMode?: boolean;
|
|
71
|
+
enterStagingMode(): StageControlsInternal;
|
|
95
72
|
}
|
|
96
73
|
/**
|
|
97
74
|
* Alpha interface for container runtime base supporting staging mode.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stagingMode.d.ts","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnE
|
|
1
|
+
{"version":3,"file":"stagingMode.d.ts","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAChE;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,KAAK,IAAI,CAAC;CACxF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC/E;;;OAGG;IACH,gBAAgB,IAAI,qBAAqB,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACvE;;;OAGG;IACH,gBAAgB,IAAI,kBAAkB,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,qBAAqB,GAAG,yBAAyB,CAEpF"}
|
package/dist/stagingMode.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stagingMode.js","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"stagingMode.js","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA6FH;;;;GAIG;AACH,SAAgB,aAAa,CAAC,IAA2B;IACxD,OAAO,IAAiC,CAAC;AAC1C,CAAC;AAFD,sCAEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainerRuntimeBase } from \"./dataStoreContext.js\";\n\n/**\n * Options for committing staged changes in experimental staging mode.\n * @internal\n */\nexport interface CommitStagedChangesOptionsInternal {\n\t/**\n\t * If true, intermediate states created by changes made while in staging mode will be \"squashed\" out of the\n\t * ops which were created during staging mode.\n\t * Defaults to false.\n\t * @remarks\n\t * The squash parameter is analogous to `git squash` but differs in a notable way: ops created by a client exiting staging mode\n\t * are not necessarily coalesced into a single op or something like it.\n\t * It still does have the desirable property that \"unnecessary changes\" (such as inserting some content then removing it) will\n\t * be removed from the set of submitted ops, which means it helps reduce network traffic and the chance of unwanted data being\n\t * persisted--even if only temporarily--in the document.\n\t *\n\t * By not attempting to reduce the set of changes to a single op a la `git squash`, we can better preserve the ordering of\n\t * changes that remote clients see such that they better align with the client which submitted the changes.\n\t */\n\tsquash?: boolean;\n}\n\n/**\n * Controls for managing staged changes in experimental staging mode.\n *\n * Provides methods to either commit or discard changes made while in staging mode.\n * @internal\n */\nexport interface StageControlsInternal extends StageControlsAlpha {\n\t/**\n\t * Exit staging mode and commit to any changes made while in staging mode.\n\t * This will cause them to be sent to the ordering service, and subsequent changes\n\t * made by this container will additionally flow freely to the ordering service.\n\t * @param options - Options when committing changes.\n\t */\n\treadonly commitChanges: (options?: Partial<CommitStagedChangesOptionsInternal>) => void;\n}\n\n/**\n * Controls for managing staged changes in alpha staging mode.\n *\n * Provides methods to either commit or discard changes made while in staging mode.\n *\n * @legacy @alpha\n * @sealed\n */\nexport interface StageControlsAlpha {\n\t/**\n\t * Exit staging mode and commit to any changes made while in staging mode.\n\t * This will cause them to be sent to the ordering service, and subsequent changes\n\t * made by this container will additionally flow freely to the ordering service.\n\t */\n\treadonly commitChanges: () => void;\n\t/**\n\t * Exit staging mode and discard any changes made while in staging mode.\n\t */\n\treadonly discardChanges: () => void;\n}\n\n/**\n * Experimental extension of {@link IContainerRuntimeBase} to support staging mode.\n * @internal\n */\nexport interface IContainerRuntimeBaseInternal extends ContainerRuntimeBaseAlpha {\n\t/**\n\t * Enters staging mode, allowing changes to be staged before being committed or discarded.\n\t * @returns Controls for committing or discarding staged changes.\n\t */\n\tenterStagingMode(): StageControlsInternal;\n}\n\n/**\n * Alpha interface for container runtime base supporting staging mode.\n *\n * @legacy @alpha\n * @sealed\n */\nexport interface ContainerRuntimeBaseAlpha extends IContainerRuntimeBase {\n\t/**\n\t * Enters staging mode, allowing changes to be staged before being committed or discarded.\n\t * @returns Controls for committing or discarding staged changes.\n\t */\n\tenterStagingMode(): StageControlsAlpha;\n\t/**\n\t * Indicates whether the container is currently in staging mode.\n\t */\n\treadonly inStagingMode: boolean;\n}\n\n/**\n * Converts types to their alpha counterparts to expose alpha functionality.\n * @legacy @alpha\n * @sealed\n */\nexport function asLegacyAlpha(base: IContainerRuntimeBase): ContainerRuntimeBaseAlpha {\n\treturn base as ContainerRuntimeBaseAlpha;\n}\n"]}
|
package/lib/index.d.ts
CHANGED
|
@@ -16,5 +16,5 @@ export { encodeHandlesInContainerRuntime, notifiesReadOnlyState, } from "./runti
|
|
|
16
16
|
export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, ITelemetryContextExt, SummarizeInternalFn, } from "./summary.js";
|
|
17
17
|
export { blobCountPropertyName, channelsTreeName, CreateSummarizerNodeSource, totalBlobSizePropertyName, } from "./summary.js";
|
|
18
18
|
export type { MinimumVersionForCollab } from "./compatibilityDefinitions.js";
|
|
19
|
-
export { type ContainerRuntimeBaseAlpha, type StageControlsAlpha, type
|
|
19
|
+
export { type ContainerRuntimeBaseAlpha, type StageControlsAlpha, type CommitStagedChangesOptionsInternal, type IContainerRuntimeBaseInternal, type StageControlsInternal, asLegacyAlpha, } from "./stagingMode.js";
|
|
20
20
|
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACX,WAAW,EACX,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,WAAW,GACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1F,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,YAAY,EACX,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACX,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACX,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EACX,8BAA8B,EAC9B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAE7E,OAAO,EACN,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACX,WAAW,EACX,2BAA2B,EAC3B,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,8BAA8B,EAC9B,qBAAqB,EACrB,WAAW,GACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1F,YAAY,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,YAAY,EACX,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACX,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACX,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EACX,8BAA8B,EAC9B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAE7E,OAAO,EACN,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,kCAAkC,EACvC,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,aAAa,GACb,MAAM,kBAAkB,CAAC"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAQ/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAKjE,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAW3C,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAgB7C,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAMN,aAAa,GACb,MAAM,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution.js\";\nexport type {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStorePolicies,\n\tIFluidDataStoreContext,\n\tIFluidParentContext,\n\tIFluidDataStoreContextDetached,\n\tIPendingMessagesState,\n\tPackagePath,\n} from \"./dataStoreContext.js\";\nexport { FlushMode, FlushModeExperimental, VisibilityState } from \"./dataStoreContext.js\";\nexport type { IProvideFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport { IFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport type {\n\tFluidDataStoreRegistryEntry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n\tNamedFluidDataStoreRegistryEntry2,\n} from \"./dataStoreRegistry.js\";\nexport { IFluidDataStoreRegistry } from \"./dataStoreRegistry.js\";\nexport type {\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollectionDefinitions.js\";\nexport {\n\tgcBlobPrefix,\n\tgcDataBlobKey,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n} from \"./garbageCollectionDefinitions.js\";\nexport type {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tIRuntimeMessageCollection,\n\tIRuntimeMessagesContent,\n\tISequencedMessageEnvelope,\n\tIRuntimeStorageService,\n} from \"./protocol.js\";\nexport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"./runtimeLayerCompatFeatureNames.js\";\nexport type {\n\tCreateChildSummarizerNodeParam,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tITelemetryContextExt,\n\tSummarizeInternalFn,\n} from \"./summary.js\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateSummarizerNodeSource,\n\ttotalBlobSizePropertyName,\n} from \"./summary.js\";\nexport type { MinimumVersionForCollab } from \"./compatibilityDefinitions.js\";\n\nexport {\n\ttype ContainerRuntimeBaseAlpha,\n\ttype StageControlsAlpha,\n\ttype
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAQ/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAKjE,OAAO,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,GACT,MAAM,mCAAmC,CAAC;AAW3C,OAAO,EACN,+BAA+B,EAC/B,qBAAqB,GACrB,MAAM,qCAAqC,CAAC;AAgB7C,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAMN,aAAa,GACb,MAAM,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution.js\";\nexport type {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStorePolicies,\n\tIFluidDataStoreContext,\n\tIFluidParentContext,\n\tIFluidDataStoreContextDetached,\n\tIPendingMessagesState,\n\tPackagePath,\n} from \"./dataStoreContext.js\";\nexport { FlushMode, FlushModeExperimental, VisibilityState } from \"./dataStoreContext.js\";\nexport type { IProvideFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport { IFluidDataStoreFactory } from \"./dataStoreFactory.js\";\nexport type {\n\tFluidDataStoreRegistryEntry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n\tNamedFluidDataStoreRegistryEntry2,\n} from \"./dataStoreRegistry.js\";\nexport { IFluidDataStoreRegistry } from \"./dataStoreRegistry.js\";\nexport type {\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollectionDefinitions.js\";\nexport {\n\tgcBlobPrefix,\n\tgcDataBlobKey,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n} from \"./garbageCollectionDefinitions.js\";\nexport type {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tIRuntimeMessageCollection,\n\tIRuntimeMessagesContent,\n\tISequencedMessageEnvelope,\n\tIRuntimeStorageService,\n} from \"./protocol.js\";\nexport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"./runtimeLayerCompatFeatureNames.js\";\nexport type {\n\tCreateChildSummarizerNodeParam,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tITelemetryContextExt,\n\tSummarizeInternalFn,\n} from \"./summary.js\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateSummarizerNodeSource,\n\ttotalBlobSizePropertyName,\n} from \"./summary.js\";\nexport type { MinimumVersionForCollab } from \"./compatibilityDefinitions.js\";\n\nexport {\n\ttype ContainerRuntimeBaseAlpha,\n\ttype StageControlsAlpha,\n\ttype CommitStagedChangesOptionsInternal,\n\ttype IContainerRuntimeBaseInternal,\n\ttype StageControlsInternal,\n\tasLegacyAlpha,\n} from \"./stagingMode.js\";\n"]}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ export {
|
|
|
13
13
|
AliasResult,
|
|
14
14
|
AttributionInfo,
|
|
15
15
|
AttributionKey,
|
|
16
|
-
CommitStagedChangesOptionsExperimental,
|
|
17
16
|
CreateChildSummarizerNodeFn,
|
|
18
17
|
CreateChildSummarizerNodeParam,
|
|
19
18
|
CreateSummarizerNodeSource,
|
|
@@ -23,7 +22,6 @@ export {
|
|
|
23
22
|
IAttachMessage,
|
|
24
23
|
IContainerRuntimeBase,
|
|
25
24
|
IContainerRuntimeBaseEvents,
|
|
26
|
-
IContainerRuntimeBaseExperimental,
|
|
27
25
|
IDataStore,
|
|
28
26
|
IEnvelope,
|
|
29
27
|
IExperimentalIncrementalSummaryContext,
|
|
@@ -60,7 +58,6 @@ export {
|
|
|
60
58
|
NamedFluidDataStoreRegistryEntry2,
|
|
61
59
|
OpAttributionKey,
|
|
62
60
|
PackagePath,
|
|
63
|
-
StageControlsExperimental,
|
|
64
61
|
SummarizeInternalFn,
|
|
65
62
|
VisibilityState
|
|
66
63
|
// #endregion
|
package/lib/legacyAlpha.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ export {
|
|
|
13
13
|
AliasResult,
|
|
14
14
|
AttributionInfo,
|
|
15
15
|
AttributionKey,
|
|
16
|
-
CommitStagedChangesOptionsExperimental,
|
|
17
16
|
CreateChildSummarizerNodeFn,
|
|
18
17
|
CreateChildSummarizerNodeParam,
|
|
19
18
|
CreateSummarizerNodeSource,
|
|
@@ -23,7 +22,6 @@ export {
|
|
|
23
22
|
IAttachMessage,
|
|
24
23
|
IContainerRuntimeBase,
|
|
25
24
|
IContainerRuntimeBaseEvents,
|
|
26
|
-
IContainerRuntimeBaseExperimental,
|
|
27
25
|
IDataStore,
|
|
28
26
|
IEnvelope,
|
|
29
27
|
IExperimentalIncrementalSummaryContext,
|
|
@@ -60,7 +58,6 @@ export {
|
|
|
60
58
|
NamedFluidDataStoreRegistryEntry2,
|
|
61
59
|
OpAttributionKey,
|
|
62
60
|
PackagePath,
|
|
63
|
-
StageControlsExperimental,
|
|
64
61
|
SummarizeInternalFn,
|
|
65
62
|
VisibilityState,
|
|
66
63
|
// #endregion
|
package/lib/stagingMode.d.ts
CHANGED
|
@@ -5,14 +5,9 @@
|
|
|
5
5
|
import type { IContainerRuntimeBase } from "./dataStoreContext.js";
|
|
6
6
|
/**
|
|
7
7
|
* Options for committing staged changes in experimental staging mode.
|
|
8
|
-
*
|
|
9
|
-
* @experimental
|
|
10
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
11
|
-
* @legacy @beta
|
|
12
|
-
* @sealed
|
|
13
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
8
|
+
* @internal
|
|
14
9
|
*/
|
|
15
|
-
export interface
|
|
10
|
+
export interface CommitStagedChangesOptionsInternal {
|
|
16
11
|
/**
|
|
17
12
|
* If true, intermediate states created by changes made while in staging mode will be "squashed" out of the
|
|
18
13
|
* ops which were created during staging mode.
|
|
@@ -33,25 +28,16 @@ export interface CommitStagedChangesOptionsExperimental {
|
|
|
33
28
|
* Controls for managing staged changes in experimental staging mode.
|
|
34
29
|
*
|
|
35
30
|
* Provides methods to either commit or discard changes made while in staging mode.
|
|
36
|
-
*
|
|
37
|
-
* @experimental
|
|
38
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
39
|
-
* @legacy @beta
|
|
40
|
-
* @sealed
|
|
41
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
31
|
+
* @internal
|
|
42
32
|
*/
|
|
43
|
-
export interface
|
|
33
|
+
export interface StageControlsInternal extends StageControlsAlpha {
|
|
44
34
|
/**
|
|
45
35
|
* Exit staging mode and commit to any changes made while in staging mode.
|
|
46
36
|
* This will cause them to be sent to the ordering service, and subsequent changes
|
|
47
37
|
* made by this container will additionally flow freely to the ordering service.
|
|
48
38
|
* @param options - Options when committing changes.
|
|
49
39
|
*/
|
|
50
|
-
readonly commitChanges: (options?: Partial<
|
|
51
|
-
/**
|
|
52
|
-
* Exit staging mode and discard any changes made while in staging mode.
|
|
53
|
-
*/
|
|
54
|
-
readonly discardChanges: () => void;
|
|
40
|
+
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsInternal>) => void;
|
|
55
41
|
}
|
|
56
42
|
/**
|
|
57
43
|
* Controls for managing staged changes in alpha staging mode.
|
|
@@ -75,23 +61,14 @@ export interface StageControlsAlpha {
|
|
|
75
61
|
}
|
|
76
62
|
/**
|
|
77
63
|
* Experimental extension of {@link IContainerRuntimeBase} to support staging mode.
|
|
78
|
-
*
|
|
79
|
-
* @experimental
|
|
80
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
81
|
-
* @legacy @beta
|
|
82
|
-
* @sealed
|
|
83
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
64
|
+
* @internal
|
|
84
65
|
*/
|
|
85
|
-
export interface
|
|
66
|
+
export interface IContainerRuntimeBaseInternal extends ContainerRuntimeBaseAlpha {
|
|
86
67
|
/**
|
|
87
68
|
* Enters staging mode, allowing changes to be staged before being committed or discarded.
|
|
88
69
|
* @returns Controls for committing or discarding staged changes.
|
|
89
70
|
*/
|
|
90
|
-
enterStagingMode
|
|
91
|
-
/**
|
|
92
|
-
* Indicates whether the container is currently in staging mode.
|
|
93
|
-
*/
|
|
94
|
-
readonly inStagingMode?: boolean;
|
|
71
|
+
enterStagingMode(): StageControlsInternal;
|
|
95
72
|
}
|
|
96
73
|
/**
|
|
97
74
|
* Alpha interface for container runtime base supporting staging mode.
|
package/lib/stagingMode.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stagingMode.d.ts","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnE
|
|
1
|
+
{"version":3,"file":"stagingMode.d.ts","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAChE;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,KAAK,IAAI,CAAC;CACxF;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC/E;;;OAGG;IACH,gBAAgB,IAAI,qBAAqB,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACvE;;;OAGG;IACH,gBAAgB,IAAI,kBAAkB,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,qBAAqB,GAAG,yBAAyB,CAEpF"}
|
package/lib/stagingMode.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stagingMode.js","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"stagingMode.js","sourceRoot":"","sources":["../src/stagingMode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA6FH;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAA2B;IACxD,OAAO,IAAiC,CAAC;AAC1C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainerRuntimeBase } from \"./dataStoreContext.js\";\n\n/**\n * Options for committing staged changes in experimental staging mode.\n * @internal\n */\nexport interface CommitStagedChangesOptionsInternal {\n\t/**\n\t * If true, intermediate states created by changes made while in staging mode will be \"squashed\" out of the\n\t * ops which were created during staging mode.\n\t * Defaults to false.\n\t * @remarks\n\t * The squash parameter is analogous to `git squash` but differs in a notable way: ops created by a client exiting staging mode\n\t * are not necessarily coalesced into a single op or something like it.\n\t * It still does have the desirable property that \"unnecessary changes\" (such as inserting some content then removing it) will\n\t * be removed from the set of submitted ops, which means it helps reduce network traffic and the chance of unwanted data being\n\t * persisted--even if only temporarily--in the document.\n\t *\n\t * By not attempting to reduce the set of changes to a single op a la `git squash`, we can better preserve the ordering of\n\t * changes that remote clients see such that they better align with the client which submitted the changes.\n\t */\n\tsquash?: boolean;\n}\n\n/**\n * Controls for managing staged changes in experimental staging mode.\n *\n * Provides methods to either commit or discard changes made while in staging mode.\n * @internal\n */\nexport interface StageControlsInternal extends StageControlsAlpha {\n\t/**\n\t * Exit staging mode and commit to any changes made while in staging mode.\n\t * This will cause them to be sent to the ordering service, and subsequent changes\n\t * made by this container will additionally flow freely to the ordering service.\n\t * @param options - Options when committing changes.\n\t */\n\treadonly commitChanges: (options?: Partial<CommitStagedChangesOptionsInternal>) => void;\n}\n\n/**\n * Controls for managing staged changes in alpha staging mode.\n *\n * Provides methods to either commit or discard changes made while in staging mode.\n *\n * @legacy @alpha\n * @sealed\n */\nexport interface StageControlsAlpha {\n\t/**\n\t * Exit staging mode and commit to any changes made while in staging mode.\n\t * This will cause them to be sent to the ordering service, and subsequent changes\n\t * made by this container will additionally flow freely to the ordering service.\n\t */\n\treadonly commitChanges: () => void;\n\t/**\n\t * Exit staging mode and discard any changes made while in staging mode.\n\t */\n\treadonly discardChanges: () => void;\n}\n\n/**\n * Experimental extension of {@link IContainerRuntimeBase} to support staging mode.\n * @internal\n */\nexport interface IContainerRuntimeBaseInternal extends ContainerRuntimeBaseAlpha {\n\t/**\n\t * Enters staging mode, allowing changes to be staged before being committed or discarded.\n\t * @returns Controls for committing or discarding staged changes.\n\t */\n\tenterStagingMode(): StageControlsInternal;\n}\n\n/**\n * Alpha interface for container runtime base supporting staging mode.\n *\n * @legacy @alpha\n * @sealed\n */\nexport interface ContainerRuntimeBaseAlpha extends IContainerRuntimeBase {\n\t/**\n\t * Enters staging mode, allowing changes to be staged before being committed or discarded.\n\t * @returns Controls for committing or discarding staged changes.\n\t */\n\tenterStagingMode(): StageControlsAlpha;\n\t/**\n\t * Indicates whether the container is currently in staging mode.\n\t */\n\treadonly inStagingMode: boolean;\n}\n\n/**\n * Converts types to their alpha counterparts to expose alpha functionality.\n * @legacy @alpha\n * @sealed\n */\nexport function asLegacyAlpha(base: IContainerRuntimeBase): ContainerRuntimeBaseAlpha {\n\treturn base as ContainerRuntimeBaseAlpha;\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/runtime-definitions",
|
|
3
|
-
"version": "2.70.0
|
|
3
|
+
"version": "2.70.0",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,11 +57,11 @@
|
|
|
57
57
|
"main": "lib/index.js",
|
|
58
58
|
"types": "lib/public.d.ts",
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluidframework/container-definitions": "2.70.0
|
|
61
|
-
"@fluidframework/core-interfaces": "2.70.0
|
|
62
|
-
"@fluidframework/driver-definitions": "2.70.0
|
|
63
|
-
"@fluidframework/id-compressor": "2.70.0
|
|
64
|
-
"@fluidframework/telemetry-utils": "2.70.0
|
|
60
|
+
"@fluidframework/container-definitions": "~2.70.0",
|
|
61
|
+
"@fluidframework/core-interfaces": "~2.70.0",
|
|
62
|
+
"@fluidframework/driver-definitions": "~2.70.0",
|
|
63
|
+
"@fluidframework/id-compressor": "~2.70.0",
|
|
64
|
+
"@fluidframework/telemetry-utils": "~2.70.0"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
67
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -80,6 +80,15 @@
|
|
|
80
80
|
},
|
|
81
81
|
"typeValidation": {
|
|
82
82
|
"broken": {
|
|
83
|
+
"Interface_CommitStagedChangesOptionsExperimental": {
|
|
84
|
+
"backCompat": false
|
|
85
|
+
},
|
|
86
|
+
"Interface_IContainerRuntimeBaseExperimental": {
|
|
87
|
+
"backCompat": false
|
|
88
|
+
},
|
|
89
|
+
"Interface_StageControlsExperimental": {
|
|
90
|
+
"backCompat": false
|
|
91
|
+
},
|
|
83
92
|
"Interface_IFluidDataStoreContext": {
|
|
84
93
|
"backCompat": false
|
|
85
94
|
},
|
package/src/index.ts
CHANGED
|
@@ -86,8 +86,8 @@ export type { MinimumVersionForCollab } from "./compatibilityDefinitions.js";
|
|
|
86
86
|
export {
|
|
87
87
|
type ContainerRuntimeBaseAlpha,
|
|
88
88
|
type StageControlsAlpha,
|
|
89
|
-
type
|
|
90
|
-
type
|
|
91
|
-
type
|
|
89
|
+
type CommitStagedChangesOptionsInternal,
|
|
90
|
+
type IContainerRuntimeBaseInternal,
|
|
91
|
+
type StageControlsInternal,
|
|
92
92
|
asLegacyAlpha,
|
|
93
93
|
} from "./stagingMode.js";
|
package/src/stagingMode.ts
CHANGED
|
@@ -7,14 +7,9 @@ import type { IContainerRuntimeBase } from "./dataStoreContext.js";
|
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
9
|
* Options for committing staged changes in experimental staging mode.
|
|
10
|
-
*
|
|
11
|
-
* @experimental
|
|
12
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
13
|
-
* @legacy @beta
|
|
14
|
-
* @sealed
|
|
15
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
10
|
+
* @internal
|
|
16
11
|
*/
|
|
17
|
-
export interface
|
|
12
|
+
export interface CommitStagedChangesOptionsInternal {
|
|
18
13
|
/**
|
|
19
14
|
* If true, intermediate states created by changes made while in staging mode will be "squashed" out of the
|
|
20
15
|
* ops which were created during staging mode.
|
|
@@ -36,25 +31,16 @@ export interface CommitStagedChangesOptionsExperimental {
|
|
|
36
31
|
* Controls for managing staged changes in experimental staging mode.
|
|
37
32
|
*
|
|
38
33
|
* Provides methods to either commit or discard changes made while in staging mode.
|
|
39
|
-
*
|
|
40
|
-
* @experimental
|
|
41
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
42
|
-
* @legacy @beta
|
|
43
|
-
* @sealed
|
|
44
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
34
|
+
* @internal
|
|
45
35
|
*/
|
|
46
|
-
export interface
|
|
36
|
+
export interface StageControlsInternal extends StageControlsAlpha {
|
|
47
37
|
/**
|
|
48
38
|
* Exit staging mode and commit to any changes made while in staging mode.
|
|
49
39
|
* This will cause them to be sent to the ordering service, and subsequent changes
|
|
50
40
|
* made by this container will additionally flow freely to the ordering service.
|
|
51
41
|
* @param options - Options when committing changes.
|
|
52
42
|
*/
|
|
53
|
-
readonly commitChanges: (options?: Partial<
|
|
54
|
-
/**
|
|
55
|
-
* Exit staging mode and discard any changes made while in staging mode.
|
|
56
|
-
*/
|
|
57
|
-
readonly discardChanges: () => void;
|
|
43
|
+
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsInternal>) => void;
|
|
58
44
|
}
|
|
59
45
|
|
|
60
46
|
/**
|
|
@@ -80,23 +66,14 @@ export interface StageControlsAlpha {
|
|
|
80
66
|
|
|
81
67
|
/**
|
|
82
68
|
* Experimental extension of {@link IContainerRuntimeBase} to support staging mode.
|
|
83
|
-
*
|
|
84
|
-
* @experimental
|
|
85
|
-
* @deprecated These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
|
|
86
|
-
* @legacy @beta
|
|
87
|
-
* @sealed
|
|
88
|
-
* @privateRemarks After partners move to the alpha interfaces this interface should be renamed and tagged to be internal.
|
|
69
|
+
* @internal
|
|
89
70
|
*/
|
|
90
|
-
export interface
|
|
71
|
+
export interface IContainerRuntimeBaseInternal extends ContainerRuntimeBaseAlpha {
|
|
91
72
|
/**
|
|
92
73
|
* Enters staging mode, allowing changes to be staged before being committed or discarded.
|
|
93
74
|
* @returns Controls for committing or discarding staged changes.
|
|
94
75
|
*/
|
|
95
|
-
enterStagingMode
|
|
96
|
-
/**
|
|
97
|
-
* Indicates whether the container is currently in staging mode.
|
|
98
|
-
*/
|
|
99
|
-
readonly inStagingMode?: boolean;
|
|
76
|
+
enterStagingMode(): StageControlsInternal;
|
|
100
77
|
}
|
|
101
78
|
|
|
102
79
|
/**
|