@fluidframework/runtime-definitions 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.245554
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/.eslintrc.cjs +1 -1
- package/CHANGELOG.md +75 -0
- package/api-extractor-cjs.json +8 -0
- package/api-extractor-lint.json +1 -1
- package/api-extractor.json +1 -1
- package/api-report/runtime-definitions.api.md +102 -84
- package/dist/dataStoreContext.d.ts +124 -73
- package/dist/dataStoreContext.d.ts.map +1 -1
- package/dist/dataStoreContext.js +3 -0
- package/dist/dataStoreContext.js.map +1 -1
- package/dist/dataStoreFactory.d.ts +1 -1
- package/dist/dataStoreFactory.d.ts.map +1 -1
- package/dist/dataStoreFactory.js.map +1 -1
- package/dist/dataStoreRegistry.d.ts +1 -1
- package/dist/dataStoreRegistry.d.ts.map +1 -1
- package/dist/dataStoreRegistry.js.map +1 -1
- package/dist/{garbageCollection.d.ts → garbageCollectionDefinitions.d.ts} +8 -2
- package/dist/garbageCollectionDefinitions.d.ts.map +1 -0
- package/dist/{garbageCollection.js → garbageCollectionDefinitions.js} +9 -3
- package/dist/garbageCollectionDefinitions.js.map +1 -0
- package/dist/index.d.ts +12 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -19
- package/dist/index.js.map +1 -1
- package/dist/package.json +3 -0
- package/dist/protocol.d.ts +1 -1
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js.map +1 -1
- package/dist/runtime-definitions-alpha.d.ts +184 -124
- package/dist/runtime-definitions-beta.d.ts +37 -30
- package/dist/runtime-definitions-public.d.ts +37 -30
- package/dist/runtime-definitions-untrimmed.d.ts +190 -125
- package/dist/summary.d.ts +15 -7
- package/dist/summary.d.ts.map +1 -1
- package/dist/summary.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/attribution.d.ts +71 -0
- package/lib/attribution.d.ts.map +1 -0
- package/lib/attribution.js +6 -0
- package/lib/attribution.js.map +1 -0
- package/lib/dataStoreContext.d.ts +464 -0
- package/lib/dataStoreContext.d.ts.map +1 -0
- package/lib/dataStoreContext.js +67 -0
- package/lib/dataStoreContext.js.map +1 -0
- package/lib/dataStoreFactory.d.ts +33 -0
- package/lib/dataStoreFactory.d.ts.map +1 -0
- package/lib/dataStoreFactory.js +9 -0
- package/lib/dataStoreFactory.js.map +1 -0
- package/lib/dataStoreRegistry.d.ts +41 -0
- package/lib/dataStoreRegistry.d.ts.map +1 -0
- package/lib/dataStoreRegistry.js +9 -0
- package/lib/dataStoreRegistry.js.map +1 -0
- package/lib/garbageCollectionDefinitions.d.ts +62 -0
- package/lib/garbageCollectionDefinitions.d.ts.map +1 -0
- package/lib/garbageCollectionDefinitions.js +35 -0
- package/lib/garbageCollectionDefinitions.js.map +1 -0
- package/lib/index.d.ts +17 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -0
- package/lib/protocol.d.ts +77 -0
- package/lib/protocol.d.ts.map +1 -0
- package/lib/protocol.js +6 -0
- package/lib/protocol.js.map +1 -0
- package/lib/runtime-definitions-alpha.d.ts +1019 -0
- package/lib/runtime-definitions-beta.d.ts +242 -0
- package/lib/runtime-definitions-public.d.ts +242 -0
- package/lib/runtime-definitions-untrimmed.d.ts +1100 -0
- package/lib/summary.d.ts +322 -0
- package/lib/summary.d.ts.map +1 -0
- package/lib/summary.js +26 -0
- package/lib/summary.js.map +1 -0
- package/package.json +75 -31
- package/src/dataStoreContext.ts +144 -90
- package/src/dataStoreFactory.ts +1 -1
- package/src/dataStoreRegistry.ts +1 -1
- package/src/{garbageCollection.ts → garbageCollectionDefinitions.ts} +7 -1
- package/src/index.ts +26 -22
- package/src/protocol.ts +1 -1
- package/src/summary.ts +18 -7
- package/tsconfig.cjs.json +7 -0
- package/tsconfig.json +2 -5
- package/dist/garbageCollection.d.ts.map +0 -1
- package/dist/garbageCollection.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -2,11 +2,16 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
export { AttributionInfo, AttributionKey, DetachedAttributionKey, LocalAttributionKey, OpAttributionKey, } from "./attribution";
|
|
6
|
-
export { AliasResult, CreateChildSummarizerNodeFn,
|
|
7
|
-
export {
|
|
8
|
-
export {
|
|
9
|
-
export {
|
|
10
|
-
export {
|
|
11
|
-
export {
|
|
5
|
+
export type { AttributionInfo, AttributionKey, DetachedAttributionKey, LocalAttributionKey, OpAttributionKey, } from "./attribution.js";
|
|
6
|
+
export type { AliasResult, CreateChildSummarizerNodeFn, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IDataStore, IFluidDataStoreChannel, IFluidDataStoreContext, IFluidParentContext, IFluidDataStoreContextDetached, } from "./dataStoreContext.js";
|
|
7
|
+
export { FlushMode, FlushModeExperimental, VisibilityState } from "./dataStoreContext.js";
|
|
8
|
+
export type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
|
|
9
|
+
export { IFluidDataStoreFactory } from "./dataStoreFactory.js";
|
|
10
|
+
export type { FluidDataStoreRegistryEntry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries, NamedFluidDataStoreRegistryEntry, } from "./dataStoreRegistry.js";
|
|
11
|
+
export { IFluidDataStoreRegistry } from "./dataStoreRegistry.js";
|
|
12
|
+
export type { IGarbageCollectionData, IGarbageCollectionDetailsBase, } from "./garbageCollectionDefinitions.js";
|
|
13
|
+
export { gcBlobPrefix, gcDataBlobKey, gcDeletedBlobKey, gcTombstoneBlobKey, gcTreeKey, } from "./garbageCollectionDefinitions.js";
|
|
14
|
+
export type { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope, } from "./protocol.js";
|
|
15
|
+
export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn, } from "./summary.js";
|
|
16
|
+
export { blobCountPropertyName, channelsTreeName, CreateSummarizerNodeSource, totalBlobSizePropertyName, } from "./summary.js";
|
|
12
17
|
//# 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,
|
|
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,sBAAsB,EACtB,mBAAmB,EACnB,8BAA8B,GAC9B,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,GAChC,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,eAAe,GACf,MAAM,eAAe,CAAC;AACvB,YAAY,EACX,8BAA8B,EAC9B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,yBAAyB,GACzB,MAAM,cAAc,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,23 +4,24 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.totalBlobSizePropertyName = exports.CreateSummarizerNodeSource = exports.channelsTreeName = exports.blobCountPropertyName = exports.gcTreeKey = exports.gcTombstoneBlobKey = exports.gcDeletedBlobKey = exports.gcBlobPrefix = exports.IFluidDataStoreRegistry = exports.IFluidDataStoreFactory = exports.VisibilityState = exports.FlushModeExperimental = exports.FlushMode = void 0;
|
|
8
|
-
var
|
|
9
|
-
Object.defineProperty(exports, "FlushMode", { enumerable: true, get: function () { return
|
|
10
|
-
Object.defineProperty(exports, "FlushModeExperimental", { enumerable: true, get: function () { return
|
|
11
|
-
Object.defineProperty(exports, "VisibilityState", { enumerable: true, get: function () { return
|
|
12
|
-
var
|
|
13
|
-
Object.defineProperty(exports, "IFluidDataStoreFactory", { enumerable: true, get: function () { return
|
|
14
|
-
var
|
|
15
|
-
Object.defineProperty(exports, "IFluidDataStoreRegistry", { enumerable: true, get: function () { return
|
|
16
|
-
var
|
|
17
|
-
Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return
|
|
18
|
-
Object.defineProperty(exports, "
|
|
19
|
-
Object.defineProperty(exports, "
|
|
20
|
-
Object.defineProperty(exports, "
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
Object.defineProperty(exports, "
|
|
24
|
-
Object.defineProperty(exports, "
|
|
25
|
-
Object.defineProperty(exports, "
|
|
7
|
+
exports.totalBlobSizePropertyName = exports.CreateSummarizerNodeSource = exports.channelsTreeName = exports.blobCountPropertyName = exports.gcTreeKey = exports.gcTombstoneBlobKey = exports.gcDeletedBlobKey = exports.gcDataBlobKey = exports.gcBlobPrefix = exports.IFluidDataStoreRegistry = exports.IFluidDataStoreFactory = exports.VisibilityState = exports.FlushModeExperimental = exports.FlushMode = void 0;
|
|
8
|
+
var dataStoreContext_js_1 = require("./dataStoreContext.js");
|
|
9
|
+
Object.defineProperty(exports, "FlushMode", { enumerable: true, get: function () { return dataStoreContext_js_1.FlushMode; } });
|
|
10
|
+
Object.defineProperty(exports, "FlushModeExperimental", { enumerable: true, get: function () { return dataStoreContext_js_1.FlushModeExperimental; } });
|
|
11
|
+
Object.defineProperty(exports, "VisibilityState", { enumerable: true, get: function () { return dataStoreContext_js_1.VisibilityState; } });
|
|
12
|
+
var dataStoreFactory_js_1 = require("./dataStoreFactory.js");
|
|
13
|
+
Object.defineProperty(exports, "IFluidDataStoreFactory", { enumerable: true, get: function () { return dataStoreFactory_js_1.IFluidDataStoreFactory; } });
|
|
14
|
+
var dataStoreRegistry_js_1 = require("./dataStoreRegistry.js");
|
|
15
|
+
Object.defineProperty(exports, "IFluidDataStoreRegistry", { enumerable: true, get: function () { return dataStoreRegistry_js_1.IFluidDataStoreRegistry; } });
|
|
16
|
+
var garbageCollectionDefinitions_js_1 = require("./garbageCollectionDefinitions.js");
|
|
17
|
+
Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return garbageCollectionDefinitions_js_1.gcBlobPrefix; } });
|
|
18
|
+
Object.defineProperty(exports, "gcDataBlobKey", { enumerable: true, get: function () { return garbageCollectionDefinitions_js_1.gcDataBlobKey; } });
|
|
19
|
+
Object.defineProperty(exports, "gcDeletedBlobKey", { enumerable: true, get: function () { return garbageCollectionDefinitions_js_1.gcDeletedBlobKey; } });
|
|
20
|
+
Object.defineProperty(exports, "gcTombstoneBlobKey", { enumerable: true, get: function () { return garbageCollectionDefinitions_js_1.gcTombstoneBlobKey; } });
|
|
21
|
+
Object.defineProperty(exports, "gcTreeKey", { enumerable: true, get: function () { return garbageCollectionDefinitions_js_1.gcTreeKey; } });
|
|
22
|
+
var summary_js_1 = require("./summary.js");
|
|
23
|
+
Object.defineProperty(exports, "blobCountPropertyName", { enumerable: true, get: function () { return summary_js_1.blobCountPropertyName; } });
|
|
24
|
+
Object.defineProperty(exports, "channelsTreeName", { enumerable: true, get: function () { return summary_js_1.channelsTreeName; } });
|
|
25
|
+
Object.defineProperty(exports, "CreateSummarizerNodeSource", { enumerable: true, get: function () { return summary_js_1.CreateSummarizerNodeSource; } });
|
|
26
|
+
Object.defineProperty(exports, "totalBlobSizePropertyName", { enumerable: true, get: function () { return summary_js_1.totalBlobSizePropertyName; } });
|
|
26
27
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBH,6DAA0F;AAAjF,gHAAA,SAAS,OAAA;AAAE,4HAAA,qBAAqB,OAAA;AAAE,sHAAA,eAAe,OAAA;AAE1D,6DAA+D;AAAtD,6HAAA,sBAAsB,OAAA;AAO/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;AAuBV,2CAKsB;AAJrB,mHAAA,qBAAqB,OAAA;AACrB,8GAAA,gBAAgB,OAAA;AAChB,wHAAA,0BAA0B,OAAA;AAC1B,uHAAA,yBAAyB,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\tIFluidDataStoreContext,\n\tIFluidParentContext,\n\tIFluidDataStoreContextDetached,\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} 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\tISignalEnvelope,\n} from \"./protocol.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\tSummarizeInternalFn,\n} from \"./summary.js\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateSummarizerNodeSource,\n\ttotalBlobSizePropertyName,\n} from \"./summary.js\";\n"]}
|
package/dist/protocol.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
|
|
5
|
+
import type { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
|
|
6
6
|
/**
|
|
7
7
|
* An envelope wraps the contents with the intended target
|
|
8
8
|
* @alpha
|
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,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,GAAG,CAAC;KACb,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC5D,IAAI,EAAE,MAAM,CAAC;CACb;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;IACrE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}
|
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 { ISignalMessage, ITree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @alpha\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\tcontents: any;\n}\n\n/**\n * @internal\n * @deprecated - This interface is now moved to `@fluidframework/container-definitions` package. Please import from that package.\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Identifier for the signal being submitted.\n\t */\n\tclientSignalSequenceNumber: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\tcontent: any;\n\t};\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @public\n */\nexport interface IInboundSignalMessage extends ISignalMessage {\n\ttype: string;\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 * @alpha\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 * @alpha\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\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 { ISignalMessage, ITree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @alpha\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\tcontents: any;\n}\n\n/**\n * @internal\n * @deprecated - This interface is now moved to `@fluidframework/container-definitions` package. Please import from that package.\n */\nexport interface ISignalEnvelope {\n\t/**\n\t * The target for the envelope, undefined for the container\n\t */\n\taddress?: string;\n\n\t/**\n\t * Identifier for the signal being submitted.\n\t */\n\tclientSignalSequenceNumber: number;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\tcontents: {\n\t\ttype: string;\n\t\tcontent: any;\n\t};\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @public\n */\nexport interface IInboundSignalMessage extends ISignalMessage {\n\ttype: string;\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 * @alpha\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 * @alpha\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\n"]}
|
|
@@ -1,29 +1,28 @@
|
|
|
1
|
-
import { AttachState } from '@fluidframework/container-definitions';
|
|
2
|
-
import { FluidObject } from '@fluidframework/core-interfaces';
|
|
3
|
-
import { IAudience } from '@fluidframework/container-definitions';
|
|
4
|
-
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
5
|
-
import { IDeltaManager } from '@fluidframework/container-definitions';
|
|
6
|
-
import { IDisposable } from '@fluidframework/core-interfaces';
|
|
7
|
-
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
9
|
-
import { IEvent } from '@fluidframework/core-interfaces';
|
|
10
|
-
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
11
|
-
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
12
|
-
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
23
|
-
import { ITree } from '@fluidframework/protocol-definitions';
|
|
1
|
+
import type { AttachState } from '@fluidframework/container-definitions';
|
|
2
|
+
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
3
|
+
import type { IAudience } from '@fluidframework/container-definitions';
|
|
4
|
+
import type { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
5
|
+
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
6
|
+
import type { IDisposable } from '@fluidframework/core-interfaces';
|
|
7
|
+
import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
8
|
+
import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
9
|
+
import type { IEvent } from '@fluidframework/core-interfaces';
|
|
10
|
+
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
11
|
+
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
12
|
+
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
13
|
+
import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
14
|
+
import type { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
15
|
+
import type { IRequest } from '@fluidframework/core-interfaces';
|
|
16
|
+
import type { IResponse } from '@fluidframework/core-interfaces';
|
|
17
|
+
import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
18
|
+
import type { ISignalMessage } from '@fluidframework/protocol-definitions';
|
|
19
|
+
import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
20
|
+
import type { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
21
|
+
import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
|
|
22
|
+
import type { ITree } from '@fluidframework/protocol-definitions';
|
|
24
23
|
import type { IUser } from '@fluidframework/protocol-definitions';
|
|
25
|
-
import { SummaryTree } from '@fluidframework/protocol-definitions';
|
|
26
|
-
import {
|
|
24
|
+
import type { SummaryTree } from '@fluidframework/protocol-definitions';
|
|
25
|
+
import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
|
|
27
26
|
|
|
28
27
|
/**
|
|
29
28
|
* Encapsulates the return codes of the aliasing API.
|
|
@@ -116,6 +115,9 @@ export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluid
|
|
|
116
115
|
export declare enum FlushMode {
|
|
117
116
|
/**
|
|
118
117
|
* In Immediate flush mode the runtime will immediately send all operations to the driver layer.
|
|
118
|
+
*
|
|
119
|
+
* @deprecated This option will be removed in the next major version and should not be used. Use {@link FlushMode.TurnBased} instead, which is the default.
|
|
120
|
+
* See https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/opLifecycle#how-batching-works
|
|
119
121
|
*/
|
|
120
122
|
Immediate = 0,
|
|
121
123
|
/**
|
|
@@ -129,6 +131,8 @@ export declare enum FlushMode {
|
|
|
129
131
|
|
|
130
132
|
/* Excluded from this release type: gcBlobPrefix */
|
|
131
133
|
|
|
134
|
+
/* Excluded from this release type: gcDataBlobKey */
|
|
135
|
+
|
|
132
136
|
/* Excluded from this release type: gcDeletedBlobKey */
|
|
133
137
|
|
|
134
138
|
/* Excluded from this release type: gcTombstoneBlobKey */
|
|
@@ -163,6 +167,7 @@ export declare interface IAttachMessage {
|
|
|
163
167
|
export declare interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
|
|
164
168
|
readonly logger: ITelemetryBaseLogger;
|
|
165
169
|
readonly clientDetails: IClientDetails;
|
|
170
|
+
readonly disposed: boolean;
|
|
166
171
|
/**
|
|
167
172
|
* Invokes the given callback and guarantees that all operations generated within the callback will be ordered
|
|
168
173
|
* sequentially.
|
|
@@ -174,12 +179,13 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
174
179
|
* Submits a container runtime level signal to be sent to other clients.
|
|
175
180
|
* @param type - Type of the signal.
|
|
176
181
|
* @param content - Content of the signal.
|
|
182
|
+
* @param targetClientId - When specified, the signal is only sent to the provided client id.
|
|
177
183
|
*/
|
|
178
|
-
submitSignal(type: string, content: any): void;
|
|
184
|
+
submitSignal(type: string, content: any, targetClientId?: string): void;
|
|
179
185
|
/**
|
|
180
186
|
* @deprecated 0.16 Issue #1537, #3631
|
|
181
187
|
*/
|
|
182
|
-
_createDataStoreWithProps(pkg: string | string[]
|
|
188
|
+
_createDataStoreWithProps(pkg: Readonly<string | string[]>, props?: any, id?: string): Promise<IDataStore>;
|
|
183
189
|
/**
|
|
184
190
|
* Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
|
|
185
191
|
* as the data store's router. The data store is not bound to a container, and in such state is not persisted to
|
|
@@ -187,18 +193,20 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
187
193
|
* already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this
|
|
188
194
|
* store being attached to storage.
|
|
189
195
|
* @param pkg - Package name of the data store factory
|
|
190
|
-
* @param
|
|
191
|
-
*
|
|
196
|
+
* @param loadingGroupId - This represents the group of the datastore within a container or its snapshot.
|
|
197
|
+
* When not specified the datastore will belong to a `default` group. Read more about it in this
|
|
198
|
+
* {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
|
|
192
199
|
*/
|
|
193
|
-
createDataStore(pkg: string | string[]
|
|
200
|
+
createDataStore(pkg: Readonly<string | string[]>, loadingGroupId?: string): Promise<IDataStore>;
|
|
194
201
|
/**
|
|
195
202
|
* Creates detached data store context. Only after context.attachRuntime() is called,
|
|
196
203
|
* data store initialization is considered complete.
|
|
197
204
|
* @param pkg - Package name of the data store factory
|
|
198
|
-
* @param
|
|
199
|
-
*
|
|
205
|
+
* @param loadingGroupId - This represents the group of the datastore within a container or its snapshot.
|
|
206
|
+
* When not specified the datastore will belong to a `default` group. Read more about it in this
|
|
207
|
+
* {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}.
|
|
200
208
|
*/
|
|
201
|
-
createDetachedDataStore(pkg: Readonly<string[]>,
|
|
209
|
+
createDetachedDataStore(pkg: Readonly<string[]>, loadingGroupId?: string): IFluidDataStoreContextDetached;
|
|
202
210
|
/**
|
|
203
211
|
* Get an absolute url for a provided container-relative request.
|
|
204
212
|
* Returns undefined if the container or data store isn't attached to storage.
|
|
@@ -214,6 +222,28 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
214
222
|
* Returns the current audience.
|
|
215
223
|
*/
|
|
216
224
|
getAudience(): IAudience;
|
|
225
|
+
/**
|
|
226
|
+
* Generates a new ID that is guaranteed to be unique across all sessions for this container.
|
|
227
|
+
* It could be in compact form (non-negative integer, oppotunistic), but it could also be UUID string.
|
|
228
|
+
* UUIDs generated will have low entropy in groups and will compress well.
|
|
229
|
+
* It can be leveraged anywhere in container where container unique IDs are required, i.e. any place
|
|
230
|
+
* that uses uuid() and stores result in container is likely candidate to start leveraging this API.
|
|
231
|
+
* If you always want to convert to string, instead of doing String(generateDocumentUniqueId()), consider
|
|
232
|
+
* doing encodeCompactIdToString(generateDocumentUniqueId()).
|
|
233
|
+
*
|
|
234
|
+
* For more details, please see IIdCompressor.generateDocumentUniqueId()
|
|
235
|
+
*/
|
|
236
|
+
generateDocumentUniqueId(): number | string;
|
|
237
|
+
/**
|
|
238
|
+
* Api to fetch the snapshot from the service for a loadingGroupIds.
|
|
239
|
+
* @param loadingGroupIds - LoadingGroupId for which the snapshot is asked for.
|
|
240
|
+
* @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
|
|
241
|
+
* @returns - snapshotTree and the sequence number of the snapshot.
|
|
242
|
+
*/
|
|
243
|
+
getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{
|
|
244
|
+
snapshotTree: ISnapshotTree;
|
|
245
|
+
sequenceNumber: number;
|
|
246
|
+
}>;
|
|
217
247
|
}
|
|
218
248
|
|
|
219
249
|
/**
|
|
@@ -228,6 +258,7 @@ export declare interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
228
258
|
(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;
|
|
229
259
|
(event: "batchEnd", listener: (error: any, op: ISequencedDocumentMessage) => void): any;
|
|
230
260
|
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
|
|
261
|
+
(event: "dispose", listener: () => void): any;
|
|
231
262
|
}
|
|
232
263
|
|
|
233
264
|
/**
|
|
@@ -304,34 +335,27 @@ export declare interface IExperimentalIncrementalSummaryContext {
|
|
|
304
335
|
* @alpha
|
|
305
336
|
*/
|
|
306
337
|
export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
307
|
-
readonly id: string;
|
|
308
|
-
/**
|
|
309
|
-
* Indicates the attachment state of the channel to a host service.
|
|
310
|
-
*/
|
|
311
|
-
readonly attachState: AttachState;
|
|
312
|
-
readonly visibilityState: VisibilityState;
|
|
313
|
-
/**
|
|
314
|
-
* Runs through the graph and attaches the bound handles. Then binds this runtime to the container.
|
|
315
|
-
* @deprecated This will be removed in favor of {@link IFluidDataStoreChannel.makeVisibleAndAttachGraph}.
|
|
316
|
-
*/
|
|
317
|
-
attachGraph(): void;
|
|
318
338
|
/**
|
|
319
339
|
* Makes the data store channel visible in the container. Also, runs through its graph and attaches all
|
|
320
340
|
* bound handles that represent its dependencies in the container's graph.
|
|
321
341
|
*/
|
|
322
342
|
makeVisibleAndAttachGraph(): void;
|
|
323
343
|
/**
|
|
324
|
-
*
|
|
344
|
+
* Synchronously retrieves the summary used as part of the initial summary message
|
|
325
345
|
*/
|
|
326
346
|
getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
|
|
347
|
+
/**
|
|
348
|
+
* Synchronously retrieves GC Data (representing the outbound routes present) for the initial state of the DataStore
|
|
349
|
+
*/
|
|
350
|
+
getAttachGCData?(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
|
|
327
351
|
/**
|
|
328
352
|
* Processes the op.
|
|
329
353
|
*/
|
|
330
|
-
process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
|
|
354
|
+
process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown, addedOutboundReference?: (fromNodePath: string, toNodePath: string) => void): void;
|
|
331
355
|
/**
|
|
332
356
|
* Processes the signal.
|
|
333
357
|
*/
|
|
334
|
-
processSignal(message:
|
|
358
|
+
processSignal(message: IInboundSignalMessage, local: boolean): void;
|
|
335
359
|
/**
|
|
336
360
|
* Generates a summary for the channel.
|
|
337
361
|
* Introduced with summarizerNode - will be required in a future release.
|
|
@@ -379,6 +403,7 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
379
403
|
*/
|
|
380
404
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
381
405
|
request(request: IRequest): Promise<IResponse>;
|
|
406
|
+
setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
|
|
382
407
|
}
|
|
383
408
|
|
|
384
409
|
/**
|
|
@@ -386,7 +411,7 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
386
411
|
* get information and call functionality to the container.
|
|
387
412
|
* @alpha
|
|
388
413
|
*/
|
|
389
|
-
export declare interface IFluidDataStoreContext extends
|
|
414
|
+
export declare interface IFluidDataStoreContext extends IFluidParentContext {
|
|
390
415
|
readonly id: string;
|
|
391
416
|
/**
|
|
392
417
|
* A data store created by a client, is a local data store for that client. Also, when a detached container loads
|
|
@@ -401,29 +426,110 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
|
|
|
401
426
|
* The package path of the data store as per the package factory.
|
|
402
427
|
*/
|
|
403
428
|
readonly packagePath: readonly string[];
|
|
404
|
-
readonly
|
|
429
|
+
readonly baseSnapshot: ISnapshotTree | undefined;
|
|
430
|
+
/**
|
|
431
|
+
* @deprecated 0.16 Issue #1635, #3631
|
|
432
|
+
*/
|
|
433
|
+
readonly createProps?: any;
|
|
434
|
+
/**
|
|
435
|
+
* @deprecated The functionality to get base GC details has been moved to summarizer node.
|
|
436
|
+
*
|
|
437
|
+
* Returns the GC details in the initial summary of this data store. This is used to initialize the data store
|
|
438
|
+
* and its children with the GC details from the previous summary.
|
|
439
|
+
*/
|
|
440
|
+
getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
|
|
441
|
+
/**
|
|
442
|
+
* (Same as @see addedGCOutboundReference, but with string paths instead of handles)
|
|
443
|
+
*
|
|
444
|
+
* Called when a new outbound reference is added to another node. This is used by garbage collection to identify
|
|
445
|
+
* all references added in the system.
|
|
446
|
+
*
|
|
447
|
+
* @param fromPath - The absolute path of the node that added the reference.
|
|
448
|
+
* @param toPath - The absolute path of the outbound node that is referenced.
|
|
449
|
+
*/
|
|
450
|
+
addedGCOutboundRoute?(fromPath: string, toPath: string): void;
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* @alpha
|
|
455
|
+
*/
|
|
456
|
+
export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
|
|
457
|
+
/**
|
|
458
|
+
* Binds a runtime to the context.
|
|
459
|
+
*/
|
|
460
|
+
attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<IDataStore>;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* @alpha
|
|
465
|
+
*/
|
|
466
|
+
export declare const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* IFluidDataStoreFactory create data stores. It is associated with an identifier (its `type` member)
|
|
470
|
+
* and usually provided to consumers using this mapping through a data store registry.
|
|
471
|
+
* @alpha
|
|
472
|
+
*/
|
|
473
|
+
export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
|
|
474
|
+
/**
|
|
475
|
+
* String that uniquely identifies the type of data store created by this factory.
|
|
476
|
+
*/
|
|
477
|
+
type: string;
|
|
478
|
+
/**
|
|
479
|
+
* Generates runtime for the data store from the data store context. Once created should be bound to the context.
|
|
480
|
+
* @param context - Context for the data store.
|
|
481
|
+
* @param existing - If instantiating from an existing file.
|
|
482
|
+
*/
|
|
483
|
+
instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* @alpha
|
|
488
|
+
*/
|
|
489
|
+
export declare const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
|
|
490
|
+
|
|
491
|
+
/**
|
|
492
|
+
* An association of identifiers to data store registry entries, where the
|
|
493
|
+
* entries can be used to create data stores.
|
|
494
|
+
* @alpha
|
|
495
|
+
*/
|
|
496
|
+
export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
|
|
497
|
+
get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* Represents the context for the data store like objects. It is used by the data store runtime to
|
|
502
|
+
* get information and call functionality to its parent.
|
|
503
|
+
*
|
|
504
|
+
* This layout is temporary, as {@link IFluidParentContext} and {@link IFluidDataStoreContext} will converge.
|
|
505
|
+
*
|
|
506
|
+
* @alpha
|
|
507
|
+
*/
|
|
508
|
+
export declare interface IFluidParentContext extends IProvideFluidHandleContext, Partial<IProvideFluidDataStoreRegistry> {
|
|
509
|
+
readonly options: Record<string | number, any>;
|
|
405
510
|
readonly clientId: string | undefined;
|
|
406
511
|
readonly connected: boolean;
|
|
407
512
|
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
408
513
|
readonly storage: IDocumentStorageService;
|
|
409
|
-
readonly baseSnapshot: ISnapshotTree | undefined;
|
|
410
514
|
readonly logger: ITelemetryBaseLogger;
|
|
411
515
|
readonly clientDetails: IClientDetails;
|
|
412
516
|
readonly idCompressor?: IIdCompressor;
|
|
413
|
-
|
|
517
|
+
/**
|
|
518
|
+
* Represents the loading group to which the data store belongs to. Please refer to this readme for more context.
|
|
519
|
+
* {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}
|
|
520
|
+
*/
|
|
521
|
+
readonly loadingGroupId?: string;
|
|
414
522
|
/**
|
|
415
523
|
* Indicates the attachment state of the data store to a host service.
|
|
416
524
|
*/
|
|
417
525
|
readonly attachState: AttachState;
|
|
418
526
|
readonly containerRuntime: IContainerRuntimeBase;
|
|
419
|
-
/**
|
|
420
|
-
* @deprecated 0.16 Issue #1635, #3631
|
|
421
|
-
*/
|
|
422
|
-
readonly createProps?: any;
|
|
423
527
|
/**
|
|
424
528
|
* Ambient services provided with the context
|
|
425
529
|
*/
|
|
426
530
|
readonly scope: FluidObject;
|
|
531
|
+
readonly gcThrowOnTombstoneUsage: boolean;
|
|
532
|
+
readonly gcTombstoneEnforcementAllowed: boolean;
|
|
427
533
|
/**
|
|
428
534
|
* Returns the current quorum.
|
|
429
535
|
*/
|
|
@@ -462,11 +568,6 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
|
|
|
462
568
|
* when they are marked as root. For non-root data stores, this happens when their handle is added to a visible DDS.
|
|
463
569
|
*/
|
|
464
570
|
makeLocallyVisible(): void;
|
|
465
|
-
/**
|
|
466
|
-
* Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
|
|
467
|
-
* @param address - The address of the channel that is dirty.
|
|
468
|
-
*/
|
|
469
|
-
setChannelDirty(address: string): void;
|
|
470
571
|
/**
|
|
471
572
|
* Get an absolute url to the container based on the provided relativeUrl.
|
|
472
573
|
* Returns undefined if the container or data store isn't attached to storage.
|
|
@@ -485,78 +586,29 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
|
|
|
485
586
|
* If it is local, it will throw unsupported errors on calls to summarize.
|
|
486
587
|
*/
|
|
487
588
|
createParam: CreateChildSummarizerNodeParam): CreateChildSummarizerNodeFn;
|
|
589
|
+
deleteChildSummarizerNode?(id: string): void;
|
|
488
590
|
uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
|
|
489
|
-
/**
|
|
490
|
-
* @deprecated The functionality to get base GC details has been moved to summarizer node.
|
|
491
|
-
*
|
|
492
|
-
* Returns the GC details in the initial summary of this data store. This is used to initialize the data store
|
|
493
|
-
* and its children with the GC details from the previous summary.
|
|
494
|
-
*/
|
|
495
|
-
getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
|
|
496
591
|
/**
|
|
497
592
|
* @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
|
|
498
593
|
* It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
|
|
499
594
|
*
|
|
595
|
+
* Similar capability is exposed with from/to string paths instead of handles via @see addedGCOutboundRoute
|
|
596
|
+
*
|
|
500
597
|
* Called when a new outbound reference is added to another node. This is used by garbage collection to identify
|
|
501
598
|
* all references added in the system.
|
|
502
599
|
* @param srcHandle - The handle of the node that added the reference.
|
|
503
600
|
* @param outboundHandle - The handle of the outbound node that is referenced.
|
|
504
601
|
*/
|
|
505
|
-
addedGCOutboundReference?(srcHandle:
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
*/
|
|
511
|
-
export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
|
|
602
|
+
addedGCOutboundReference?(srcHandle: {
|
|
603
|
+
absolutePath: string;
|
|
604
|
+
}, outboundHandle: {
|
|
605
|
+
absolutePath: string;
|
|
606
|
+
}): void;
|
|
512
607
|
/**
|
|
513
|
-
*
|
|
514
|
-
|
|
515
|
-
attachRuntime(factory: IProvideFluidDataStoreFactory, dataStoreRuntime: IFluidDataStoreChannel): Promise<void>;
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
/**
|
|
519
|
-
* @alpha
|
|
520
|
-
*/
|
|
521
|
-
export declare interface IFluidDataStoreContextEvents extends IEvent {
|
|
522
|
-
(event: "attaching" | "attached", listener: () => void): any;
|
|
523
|
-
}
|
|
524
|
-
|
|
525
|
-
/**
|
|
526
|
-
* @alpha
|
|
527
|
-
*/
|
|
528
|
-
export declare const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
|
|
529
|
-
|
|
530
|
-
/**
|
|
531
|
-
* IFluidDataStoreFactory create data stores. It is associated with an identifier (its `type` member)
|
|
532
|
-
* and usually provided to consumers using this mapping through a data store registry.
|
|
533
|
-
* @alpha
|
|
534
|
-
*/
|
|
535
|
-
export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
|
|
536
|
-
/**
|
|
537
|
-
* String that uniquely identifies the type of data store created by this factory.
|
|
538
|
-
*/
|
|
539
|
-
type: string;
|
|
540
|
-
/**
|
|
541
|
-
* Generates runtime for the data store from the data store context. Once created should be bound to the context.
|
|
542
|
-
* @param context - Context for the data store.
|
|
543
|
-
* @param existing - If instantiating from an existing file.
|
|
608
|
+
* Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
|
|
609
|
+
* @param address - The address of the channel that is dirty.
|
|
544
610
|
*/
|
|
545
|
-
|
|
546
|
-
}
|
|
547
|
-
|
|
548
|
-
/**
|
|
549
|
-
* @alpha
|
|
550
|
-
*/
|
|
551
|
-
export declare const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
|
|
552
|
-
|
|
553
|
-
/**
|
|
554
|
-
* An association of identifiers to data store registry entries, where the
|
|
555
|
-
* entries can be used to create data stores.
|
|
556
|
-
* @alpha
|
|
557
|
-
*/
|
|
558
|
-
export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
|
|
559
|
-
get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
|
|
611
|
+
setChannelDirty(address: string): void;
|
|
560
612
|
}
|
|
561
613
|
|
|
562
614
|
/**
|
|
@@ -711,7 +763,9 @@ export declare interface ISummarizerNode {
|
|
|
711
763
|
*/
|
|
712
764
|
config?: ISummarizerNodeConfig): ISummarizerNode;
|
|
713
765
|
getChild(id: string): ISummarizerNode | undefined;
|
|
714
|
-
/**
|
|
766
|
+
/**
|
|
767
|
+
* True if a summary is currently in progress
|
|
768
|
+
*/
|
|
715
769
|
isSummaryInProgress?(): boolean;
|
|
716
770
|
}
|
|
717
771
|
|
|
@@ -854,24 +908,30 @@ export declare interface ITelemetryContext {
|
|
|
854
908
|
* @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
|
|
855
909
|
* @param value - value to attribute to this summary telemetry data
|
|
856
910
|
*/
|
|
857
|
-
set(prefix: string, property: string, value:
|
|
911
|
+
set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
|
|
858
912
|
/**
|
|
859
913
|
* Sets multiple values for telemetry data being tracked.
|
|
860
914
|
* @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
|
|
861
915
|
* @param property - property name of the telemetry data being tracked (ex: "Options")
|
|
862
916
|
* @param values - A set of values to attribute to this summary telemetry data.
|
|
863
917
|
*/
|
|
864
|
-
setMultiple(prefix: string, property: string, values: Record<string,
|
|
918
|
+
setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
|
|
865
919
|
/**
|
|
866
920
|
* Get the telemetry data being tracked
|
|
921
|
+
*
|
|
922
|
+
* @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
|
|
923
|
+
*
|
|
867
924
|
* @param prefix - unique prefix for this data (ex: "fluid:map:")
|
|
868
925
|
* @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
|
|
869
926
|
* @returns undefined if item not found
|
|
870
927
|
*/
|
|
871
|
-
get(prefix: string, property: string):
|
|
928
|
+
get(prefix: string, property: string): TelemetryBaseEventPropertyType;
|
|
872
929
|
/**
|
|
873
930
|
* Returns a serialized version of all the telemetry data.
|
|
874
931
|
* Should be used when logging in telemetry events.
|
|
932
|
+
*
|
|
933
|
+
* @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
|
|
934
|
+
* but this functionality should not be used by other code being given an ITelemetryContext.
|
|
875
935
|
*/
|
|
876
936
|
serialize(): string;
|
|
877
937
|
}
|