@fluidframework/runtime-definitions 2.70.0-361248 → 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 -35
- package/api-report/runtime-definitions.legacy.beta.api.md +0 -35
- 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/protocol.d.ts +1 -53
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js.map +1 -1
- 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/protocol.d.ts +1 -53
- package/lib/protocol.d.ts.map +1 -1
- package/lib/protocol.js.map +1 -1
- 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 +29 -7
- package/src/index.ts +3 -3
- package/src/protocol.ts +0 -79
- 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>;
|
|
@@ -309,25 +298,7 @@ export interface IRuntimeMessagesContent {
|
|
|
309
298
|
|
|
310
299
|
// @beta @legacy
|
|
311
300
|
export interface IRuntimeStorageService {
|
|
312
|
-
// @deprecated (undocumented)
|
|
313
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
314
|
-
// @deprecated
|
|
315
|
-
dispose?(error?: Error): void;
|
|
316
|
-
// @deprecated
|
|
317
|
-
readonly disposed?: boolean;
|
|
318
|
-
// @deprecated (undocumented)
|
|
319
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
320
|
-
// @deprecated (undocumented)
|
|
321
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
322
|
-
// @deprecated (undocumented)
|
|
323
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
324
|
-
// @deprecated (undocumented)
|
|
325
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
326
|
-
// @deprecated (undocumented)
|
|
327
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
328
301
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
329
|
-
// @deprecated (undocumented)
|
|
330
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
331
302
|
}
|
|
332
303
|
|
|
333
304
|
// @beta @legacy
|
|
@@ -456,12 +427,6 @@ export interface StageControlsAlpha {
|
|
|
456
427
|
readonly discardChanges: () => void;
|
|
457
428
|
}
|
|
458
429
|
|
|
459
|
-
// @beta @sealed @deprecated @legacy
|
|
460
|
-
export interface StageControlsExperimental {
|
|
461
|
-
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;
|
|
462
|
-
readonly discardChanges: () => void;
|
|
463
|
-
}
|
|
464
|
-
|
|
465
430
|
// @beta @legacy (undocumented)
|
|
466
431
|
export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
|
|
467
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>;
|
|
@@ -300,25 +289,7 @@ export interface IRuntimeMessagesContent {
|
|
|
300
289
|
|
|
301
290
|
// @beta @legacy
|
|
302
291
|
export interface IRuntimeStorageService {
|
|
303
|
-
// @deprecated (undocumented)
|
|
304
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
305
|
-
// @deprecated
|
|
306
|
-
dispose?(error?: Error): void;
|
|
307
|
-
// @deprecated
|
|
308
|
-
readonly disposed?: boolean;
|
|
309
|
-
// @deprecated (undocumented)
|
|
310
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
311
|
-
// @deprecated (undocumented)
|
|
312
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
313
|
-
// @deprecated (undocumented)
|
|
314
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
315
|
-
// @deprecated (undocumented)
|
|
316
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
317
|
-
// @deprecated (undocumented)
|
|
318
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
319
292
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
320
|
-
// @deprecated (undocumented)
|
|
321
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
322
293
|
}
|
|
323
294
|
|
|
324
295
|
// @beta @legacy
|
|
@@ -441,12 +412,6 @@ export interface OpAttributionKey {
|
|
|
441
412
|
// @beta @legacy
|
|
442
413
|
export type PackagePath = readonly string[];
|
|
443
414
|
|
|
444
|
-
// @beta @sealed @deprecated @legacy
|
|
445
|
-
export interface StageControlsExperimental {
|
|
446
|
-
readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;
|
|
447
|
-
readonly discardChanges: () => void;
|
|
448
|
-
}
|
|
449
|
-
|
|
450
415
|
// @beta @legacy (undocumented)
|
|
451
416
|
export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
|
|
452
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/protocol.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
|
|
6
|
-
import type { ITree, ISignalMessage, ISequencedDocumentMessage
|
|
6
|
+
import type { ITree, ISignalMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
7
|
/**
|
|
8
8
|
* An envelope wraps the contents with the intended target
|
|
9
9
|
* @legacy @beta
|
|
@@ -110,57 +110,5 @@ export interface IRuntimeStorageService {
|
|
|
110
110
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
111
111
|
*/
|
|
112
112
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
113
|
-
/**
|
|
114
|
-
* Whether or not the object has been disposed.
|
|
115
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
116
|
-
*
|
|
117
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
118
|
-
* it is unused in the DataStore layer.
|
|
119
|
-
*/
|
|
120
|
-
readonly disposed?: boolean;
|
|
121
|
-
/**
|
|
122
|
-
* Dispose of the object and its resources.
|
|
123
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
124
|
-
* disposed as the result of an error.
|
|
125
|
-
*
|
|
126
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
127
|
-
* it is unused in the DataStore layer.
|
|
128
|
-
*/
|
|
129
|
-
dispose?(error?: Error): void;
|
|
130
|
-
/**
|
|
131
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
132
|
-
* it is unused in the DataStore layer.
|
|
133
|
-
*/
|
|
134
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
135
|
-
/**
|
|
136
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
137
|
-
* it is unused in the DataStore layer.
|
|
138
|
-
*/
|
|
139
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
140
|
-
/**
|
|
141
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
142
|
-
* it is unused in the DataStore layer.
|
|
143
|
-
*/
|
|
144
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
145
|
-
/**
|
|
146
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
147
|
-
* it is unused in the DataStore layer.
|
|
148
|
-
*/
|
|
149
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
150
|
-
/**
|
|
151
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
152
|
-
* it is unused in the DataStore layer.
|
|
153
|
-
*/
|
|
154
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
155
|
-
/**
|
|
156
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
157
|
-
* it is unused in the DataStore layer.
|
|
158
|
-
*/
|
|
159
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
160
|
-
/**
|
|
161
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
162
|
-
* it is unused in the DataStore layer.
|
|
163
|
-
*/
|
|
164
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
165
113
|
}
|
|
166
114
|
//# sourceMappingURL=protocol.d.ts.map
|
package/dist/protocol.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAClF,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAErE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC3C,yBAAyB,EACzB,UAAU,GAAG,sBAAsB,CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/C"}
|
package/dist/protocol.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n
|
|
1
|
+
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @legacy @beta\n */\nexport interface IEnvelope {\n\t/**\n\t * The target for the envelope\n\t */\n\taddress: string;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change\n\tcontents: any;\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @legacy @beta\n */\nexport interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessage<TMessage> {\n\treadonly type: TMessage[\"type\"];\n}\n\n/**\n * Message send by client attaching local data structure.\n * Contains snapshot of data structure which is the current state of this data structure.\n * @legacy @beta\n */\nexport interface IAttachMessage {\n\t/**\n\t * The identifier for the object\n\t */\n\tid: string;\n\n\t/**\n\t * The type of object\n\t */\n\ttype: string;\n\n\t/**\n\t * Initial snapshot of the document (contains ownership)\n\t */\n\tsnapshot: ITree;\n}\n\n/**\n * This type should be used when reading an incoming attach op,\n * but it should not be used when creating a new attach op.\n * Older versions of attach messages could have null snapshots,\n * so this gives correct typings for writing backward compatible code.\n * @legacy @beta\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\t// eslint-disable-next-line @rushstack/no-new-null -- TODO: breaking change; protocol might even explicitly use null\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\n\n/**\n * This is the message type that is used within the runtime when processing a sequenced message.\n * It is the same as ISequencedDocumentMessage, but without the contents and clientSequenceNumbers\n * which are sent separately. The contents are modified at multiple layers in the stack so having it\n * separate doesn't require packing and unpacking the entire message.\n * @legacy @beta\n */\nexport type ISequencedMessageEnvelope = Omit<\n\tISequencedDocumentMessage,\n\t\"contents\" | \"clientSequenceNumber\"\n>;\n\n/**\n * These are the contents of a runtime message as it is processed throughout the stack.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessagesContent {\n\t/**\n\t * The contents of the message, i.e., the payload\n\t */\n\treadonly contents: unknown;\n\t/**\n\t * The local metadata associated with the original message that was submitted\n\t */\n\treadonly localOpMetadata: unknown;\n\t/**\n\t * The client sequence number of the message\n\t */\n\treadonly clientSequenceNumber: number;\n}\n\n/**\n * A collection of messages that are processed by the runtime.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessageCollection {\n\t/**\n\t * The envelope for all the messages in the collection\n\t */\n\treadonly envelope: ISequencedMessageEnvelope;\n\t/**\n\t * Whether these messages were originally generated by the client processing them\n\t */\n\treadonly local: boolean;\n\t/**\n\t * The contents of the messages in the collection\n\t */\n\treadonly messagesContent: readonly IRuntimeMessagesContent[];\n}\n\n/**\n * Interface to provide access to snapshot blobs to DataStore layer.\n *\n * @legacy @beta\n */\nexport interface IRuntimeStorageService {\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n}\n"]}
|
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/protocol.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
|
|
6
|
-
import type { ITree, ISignalMessage, ISequencedDocumentMessage
|
|
6
|
+
import type { ITree, ISignalMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
7
|
/**
|
|
8
8
|
* An envelope wraps the contents with the intended target
|
|
9
9
|
* @legacy @beta
|
|
@@ -110,57 +110,5 @@ export interface IRuntimeStorageService {
|
|
|
110
110
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
111
111
|
*/
|
|
112
112
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
113
|
-
/**
|
|
114
|
-
* Whether or not the object has been disposed.
|
|
115
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
116
|
-
*
|
|
117
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
118
|
-
* it is unused in the DataStore layer.
|
|
119
|
-
*/
|
|
120
|
-
readonly disposed?: boolean;
|
|
121
|
-
/**
|
|
122
|
-
* Dispose of the object and its resources.
|
|
123
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
124
|
-
* disposed as the result of an error.
|
|
125
|
-
*
|
|
126
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
127
|
-
* it is unused in the DataStore layer.
|
|
128
|
-
*/
|
|
129
|
-
dispose?(error?: Error): void;
|
|
130
|
-
/**
|
|
131
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
132
|
-
* it is unused in the DataStore layer.
|
|
133
|
-
*/
|
|
134
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
135
|
-
/**
|
|
136
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
137
|
-
* it is unused in the DataStore layer.
|
|
138
|
-
*/
|
|
139
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
140
|
-
/**
|
|
141
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
142
|
-
* it is unused in the DataStore layer.
|
|
143
|
-
*/
|
|
144
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
145
|
-
/**
|
|
146
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
147
|
-
* it is unused in the DataStore layer.
|
|
148
|
-
*/
|
|
149
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
150
|
-
/**
|
|
151
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
152
|
-
* it is unused in the DataStore layer.
|
|
153
|
-
*/
|
|
154
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
155
|
-
/**
|
|
156
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
157
|
-
* it is unused in the DataStore layer.
|
|
158
|
-
*/
|
|
159
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
160
|
-
/**
|
|
161
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
162
|
-
* it is unused in the DataStore layer.
|
|
163
|
-
*/
|
|
164
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
165
113
|
}
|
|
166
114
|
//# sourceMappingURL=protocol.d.ts.map
|
package/lib/protocol.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAClF,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAErE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC3C,yBAAyB,EACzB,UAAU,GAAG,sBAAsB,CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/C"}
|
package/lib/protocol.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n
|
|
1
|
+
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @legacy @beta\n */\nexport interface IEnvelope {\n\t/**\n\t * The target for the envelope\n\t */\n\taddress: string;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change\n\tcontents: any;\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @legacy @beta\n */\nexport interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessage<TMessage> {\n\treadonly type: TMessage[\"type\"];\n}\n\n/**\n * Message send by client attaching local data structure.\n * Contains snapshot of data structure which is the current state of this data structure.\n * @legacy @beta\n */\nexport interface IAttachMessage {\n\t/**\n\t * The identifier for the object\n\t */\n\tid: string;\n\n\t/**\n\t * The type of object\n\t */\n\ttype: string;\n\n\t/**\n\t * Initial snapshot of the document (contains ownership)\n\t */\n\tsnapshot: ITree;\n}\n\n/**\n * This type should be used when reading an incoming attach op,\n * but it should not be used when creating a new attach op.\n * Older versions of attach messages could have null snapshots,\n * so this gives correct typings for writing backward compatible code.\n * @legacy @beta\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\t// eslint-disable-next-line @rushstack/no-new-null -- TODO: breaking change; protocol might even explicitly use null\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\n\n/**\n * This is the message type that is used within the runtime when processing a sequenced message.\n * It is the same as ISequencedDocumentMessage, but without the contents and clientSequenceNumbers\n * which are sent separately. The contents are modified at multiple layers in the stack so having it\n * separate doesn't require packing and unpacking the entire message.\n * @legacy @beta\n */\nexport type ISequencedMessageEnvelope = Omit<\n\tISequencedDocumentMessage,\n\t\"contents\" | \"clientSequenceNumber\"\n>;\n\n/**\n * These are the contents of a runtime message as it is processed throughout the stack.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessagesContent {\n\t/**\n\t * The contents of the message, i.e., the payload\n\t */\n\treadonly contents: unknown;\n\t/**\n\t * The local metadata associated with the original message that was submitted\n\t */\n\treadonly localOpMetadata: unknown;\n\t/**\n\t * The client sequence number of the message\n\t */\n\treadonly clientSequenceNumber: number;\n}\n\n/**\n * A collection of messages that are processed by the runtime.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessageCollection {\n\t/**\n\t * The envelope for all the messages in the collection\n\t */\n\treadonly envelope: ISequencedMessageEnvelope;\n\t/**\n\t * Whether these messages were originally generated by the client processing them\n\t */\n\treadonly local: boolean;\n\t/**\n\t * The contents of the messages in the collection\n\t */\n\treadonly messagesContent: readonly IRuntimeMessagesContent[];\n}\n\n/**\n * Interface to provide access to snapshot blobs to DataStore layer.\n *\n * @legacy @beta\n */\nexport interface IRuntimeStorageService {\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n}\n"]}
|
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",
|
|
@@ -79,7 +79,29 @@
|
|
|
79
79
|
"typescript": "~5.4.5"
|
|
80
80
|
},
|
|
81
81
|
"typeValidation": {
|
|
82
|
-
"broken": {
|
|
82
|
+
"broken": {
|
|
83
|
+
"Interface_CommitStagedChangesOptionsExperimental": {
|
|
84
|
+
"backCompat": false
|
|
85
|
+
},
|
|
86
|
+
"Interface_IContainerRuntimeBaseExperimental": {
|
|
87
|
+
"backCompat": false
|
|
88
|
+
},
|
|
89
|
+
"Interface_StageControlsExperimental": {
|
|
90
|
+
"backCompat": false
|
|
91
|
+
},
|
|
92
|
+
"Interface_IFluidDataStoreContext": {
|
|
93
|
+
"backCompat": false
|
|
94
|
+
},
|
|
95
|
+
"Interface_IFluidDataStoreContextDetached": {
|
|
96
|
+
"backCompat": false
|
|
97
|
+
},
|
|
98
|
+
"Interface_IFluidParentContext": {
|
|
99
|
+
"backCompat": false
|
|
100
|
+
},
|
|
101
|
+
"Interface_IRuntimeStorageService": {
|
|
102
|
+
"backCompat": false
|
|
103
|
+
}
|
|
104
|
+
},
|
|
83
105
|
"entrypoint": "legacy"
|
|
84
106
|
},
|
|
85
107
|
"scripts": {
|
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/protocol.ts
CHANGED
|
@@ -8,16 +8,6 @@ import type {
|
|
|
8
8
|
ITree,
|
|
9
9
|
ISignalMessage,
|
|
10
10
|
ISequencedDocumentMessage,
|
|
11
|
-
IDocumentStorageServicePolicies,
|
|
12
|
-
IVersion,
|
|
13
|
-
ISnapshotTree,
|
|
14
|
-
ISnapshotFetchOptions,
|
|
15
|
-
ISnapshot,
|
|
16
|
-
FetchSource,
|
|
17
|
-
ICreateBlobResponse,
|
|
18
|
-
ISummaryTree,
|
|
19
|
-
ISummaryHandle,
|
|
20
|
-
ISummaryContext,
|
|
21
11
|
} from "@fluidframework/driver-definitions/internal";
|
|
22
12
|
|
|
23
13
|
/**
|
|
@@ -142,73 +132,4 @@ export interface IRuntimeStorageService {
|
|
|
142
132
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
143
133
|
*/
|
|
144
134
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* Whether or not the object has been disposed.
|
|
148
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
149
|
-
*
|
|
150
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
151
|
-
* it is unused in the DataStore layer.
|
|
152
|
-
*/
|
|
153
|
-
readonly disposed?: boolean;
|
|
154
|
-
|
|
155
|
-
/**
|
|
156
|
-
* Dispose of the object and its resources.
|
|
157
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
158
|
-
* disposed as the result of an error.
|
|
159
|
-
*
|
|
160
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
161
|
-
* it is unused in the DataStore layer.
|
|
162
|
-
*/
|
|
163
|
-
dispose?(error?: Error): void;
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
167
|
-
* it is unused in the DataStore layer.
|
|
168
|
-
*/
|
|
169
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
173
|
-
* it is unused in the DataStore layer.
|
|
174
|
-
*/
|
|
175
|
-
// eslint-disable-next-line @rushstack/no-new-null
|
|
176
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
180
|
-
* it is unused in the DataStore layer.
|
|
181
|
-
*/
|
|
182
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
186
|
-
* it is unused in the DataStore layer.
|
|
187
|
-
*/
|
|
188
|
-
getVersions(
|
|
189
|
-
// TODO: use `undefined` instead.
|
|
190
|
-
// eslint-disable-next-line @rushstack/no-new-null
|
|
191
|
-
versionId: string | null,
|
|
192
|
-
count: number,
|
|
193
|
-
scenarioName?: string,
|
|
194
|
-
fetchSource?: FetchSource,
|
|
195
|
-
): Promise<IVersion[]>;
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
199
|
-
* it is unused in the DataStore layer.
|
|
200
|
-
*/
|
|
201
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
205
|
-
* it is unused in the DataStore layer.
|
|
206
|
-
*/
|
|
207
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
211
|
-
* it is unused in the DataStore layer.
|
|
212
|
-
*/
|
|
213
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
214
135
|
}
|
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
|
/**
|