@fluidframework/runtime-definitions 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

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.
Files changed (55) hide show
  1. package/.eslintrc.cjs +12 -0
  2. package/CHANGELOG.md +330 -0
  3. package/README.md +43 -7
  4. package/api-extractor-lint.json +4 -0
  5. package/api-extractor.json +2 -2
  6. package/api-report/runtime-definitions.api.md +474 -0
  7. package/dist/attribution.d.ts +71 -0
  8. package/dist/attribution.d.ts.map +1 -0
  9. package/dist/attribution.js +7 -0
  10. package/dist/attribution.js.map +1 -0
  11. package/dist/dataStoreContext.d.ts +114 -61
  12. package/dist/dataStoreContext.d.ts.map +1 -1
  13. package/dist/dataStoreContext.js +27 -5
  14. package/dist/dataStoreContext.js.map +1 -1
  15. package/dist/dataStoreFactory.d.ts +7 -0
  16. package/dist/dataStoreFactory.d.ts.map +1 -1
  17. package/dist/dataStoreFactory.js +3 -0
  18. package/dist/dataStoreFactory.js.map +1 -1
  19. package/dist/dataStoreRegistry.d.ts +14 -4
  20. package/dist/dataStoreRegistry.d.ts.map +1 -1
  21. package/dist/dataStoreRegistry.js +3 -0
  22. package/dist/dataStoreRegistry.js.map +1 -1
  23. package/dist/garbageCollection.d.ts +35 -10
  24. package/dist/garbageCollection.d.ts.map +1 -1
  25. package/dist/garbageCollection.js +25 -3
  26. package/dist/garbageCollection.js.map +1 -1
  27. package/dist/index.d.ts +52 -6
  28. package/dist/index.d.ts.map +1 -1
  29. package/dist/index.js +26 -16
  30. package/dist/index.js.map +1 -1
  31. package/dist/protocol.d.ts +10 -3
  32. package/dist/protocol.d.ts.map +1 -1
  33. package/dist/protocol.js.map +1 -1
  34. package/dist/runtime-definitions-alpha.d.ts +993 -0
  35. package/dist/runtime-definitions-beta.d.ts +264 -0
  36. package/dist/runtime-definitions-public.d.ts +264 -0
  37. package/dist/runtime-definitions-untrimmed.d.ts +1068 -0
  38. package/dist/summary.d.ts +138 -70
  39. package/dist/summary.d.ts.map +1 -1
  40. package/dist/summary.js +13 -1
  41. package/dist/summary.js.map +1 -1
  42. package/dist/tsdoc-metadata.json +11 -0
  43. package/package.json +96 -42
  44. package/prettier.config.cjs +8 -0
  45. package/src/aliasing.md +42 -0
  46. package/src/attribution.ts +78 -0
  47. package/src/dataStoreContext.ts +432 -388
  48. package/src/dataStoreFactory.ts +21 -11
  49. package/src/dataStoreRegistry.ts +18 -6
  50. package/src/garbageCollection.ts +38 -15
  51. package/src/index.ts +111 -6
  52. package/src/protocol.ts +46 -38
  53. package/src/summary.ts +298 -225
  54. package/tsconfig.json +10 -12
  55. package/.eslintrc.js +0 -13
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRegistry.d.ts","sourceRoot":"","sources":["../src/dataStoreRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAEnE;;;GAGG;AACH,oBAAY,2BAA2B,GACnC,QAAQ,CAAC,OAAO,CAAC,8BAA8B,GAAG,6BAA6B,CAAC,CAAC,CAAC;AACtF;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC;AAC9F;;GAEG;AACH,oBAAY,kCAAkC,GAAG,QAAQ,CAAC,gCAAgC,CAAC,CAAC;AAE5F,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAA0D,CAAC;AAEvG,MAAM,WAAW,8BAA8B;IAC3C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC3E,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAC;CACvE"}
1
+ {"version":3,"file":"dataStoreRegistry.d.ts","sourceRoot":"","sources":["../src/dataStoreRegistry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CACjD,OAAO,CAAC,8BAA8B,GAAG,6BAA6B,CAAC,CACvE,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC;AAC9F;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,QAAQ,CAAC,gCAAgC,CAAC,CAAC;AAE5F;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BAClB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC9C,QAAQ,CAAC,uBAAuB,EAAE,uBAAuB,CAAC;CAC1D;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,8BAA8B;IAC9E,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAC;CACpE"}
@@ -5,5 +5,8 @@
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.IFluidDataStoreRegistry = void 0;
8
+ /**
9
+ * @alpha
10
+ */
8
11
  exports.IFluidDataStoreRegistry = "IFluidDataStoreRegistry";
9
12
  //# sourceMappingURL=dataStoreRegistry.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRegistry.js","sourceRoot":"","sources":["../src/dataStoreRegistry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBU,QAAA,uBAAuB,GAAyC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\n\n/**\n * A single registry entry that may be used to create data stores\n* It has to have either factory or registry, or both.\n */\nexport type FluidDataStoreRegistryEntry =\n Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;\n/**\n * An associated pair of an identifier and registry entry. Registry entries\n * may be dynamically loaded.\n */\nexport type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];\n/**\n * An iterable identifier/registry entry pair list\n */\nexport type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;\n\nexport const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry = \"IFluidDataStoreRegistry\";\n\nexport interface IProvideFluidDataStoreRegistry {\n readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;\n}\n\n/**\n * An association of identifiers to data store registry entries, where the\n * entries can be used to create data stores.\n */\nexport interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {\n get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;\n}\n"]}
1
+ {"version":3,"file":"dataStoreRegistry.js","sourceRoot":"","sources":["../src/dataStoreRegistry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwBH;;GAEG;AACU,QAAA,uBAAuB,GACnC,yBAAyB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\n\n/**\n * A single registry entry that may be used to create data stores\n * It has to have either factory or registry, or both.\n * @alpha\n */\nexport type FluidDataStoreRegistryEntry = Readonly<\n\tPartial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>\n>;\n/**\n * An associated pair of an identifier and registry entry. Registry entries\n * may be dynamically loaded.\n * @alpha\n */\nexport type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];\n/**\n * An iterable identifier/registry entry pair list\n * @alpha\n */\nexport type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;\n\n/**\n * @alpha\n */\nexport const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =\n\t\"IFluidDataStoreRegistry\";\n\n/**\n * @alpha\n */\nexport interface IProvideFluidDataStoreRegistry {\n\treadonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;\n}\n\n/**\n * An association of identifiers to data store registry entries, where the\n * entries can be used to create data stores.\n * @alpha\n */\nexport interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {\n\tget(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;\n}\n"]}
@@ -2,30 +2,55 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export declare const gcBlobKey = "gc";
5
+ /**
6
+ * The key for the GC tree in summary.
7
+ *
8
+ * @internal
9
+ */
10
+ export declare const gcTreeKey = "gc";
11
+ /**
12
+ * They prefix for GC blobs in the GC tree in summary.
13
+ *
14
+ * @internal
15
+ */
16
+ export declare const gcBlobPrefix = "__gc";
17
+ /**
18
+ * The key for tombstone blob in the GC tree in summary.
19
+ *
20
+ * @internal
21
+ */
22
+ export declare const gcTombstoneBlobKey = "__tombstones";
23
+ /**
24
+ * The key for deleted nodes blob in the GC tree in summary.
25
+ *
26
+ * @internal
27
+ */
28
+ export declare const gcDeletedBlobKey = "__deletedNodes";
6
29
  /**
7
30
  * Garbage collection data returned by nodes in a Container.
8
31
  * Used for running GC in the Container.
32
+ * @public
9
33
  */
10
34
  export interface IGarbageCollectionData {
11
- /** The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes. */
35
+ /**
36
+ * The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes.
37
+ */
12
38
  gcNodes: {
13
39
  [id: string]: string[];
14
40
  };
15
41
  }
16
42
  /**
17
43
  * GC details provided to each node during creation.
44
+ * @alpha
18
45
  */
19
46
  export interface IGarbageCollectionDetailsBase {
20
- /** A list of routes to Fluid objects that are used in this node. */
47
+ /**
48
+ * A list of routes to Fluid objects that are used in this node.
49
+ */
21
50
  usedRoutes?: string[];
22
- /** The GC data of this node. */
51
+ /**
52
+ * The GC data of this node.
53
+ */
23
54
  gcData?: IGarbageCollectionData;
24
- /** If this node is unreferenced, the time when it was marked as such. */
25
- unrefTimestamp?: number;
26
55
  }
27
- /**
28
- * @deprecated - Kept for back-compat. This has been renamed to {@link IGarbageCollectionDetailsBase}.
29
- */
30
- export declare type IGarbageCollectionSummaryDetails = IGarbageCollectionDetailsBase;
31
56
  //# sourceMappingURL=garbageCollection.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"garbageCollection.d.ts","sourceRoot":"","sources":["../src/garbageCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,eAAO,MAAM,SAAS,OAAO,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,kHAAkH;IAClH,OAAO,EAAE;QAAE,CAAE,EAAE,EAAE,MAAM,GAAI,MAAM,EAAE,CAAC;KAAE,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,gCAAgC;IAChC,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,yEAAyE;IACzE,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,oBAAY,gCAAgC,GAAG,6BAA6B,CAAC"}
1
+ {"version":3,"file":"garbageCollection.d.ts","sourceRoot":"","sources":["../src/garbageCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,eAAO,MAAM,SAAS,OAAO,CAAC;AAC9B;;;;GAIG;AACH,eAAO,MAAM,YAAY,SAAS,CAAC;AACnC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,iBAAiB,CAAC;AACjD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC;CAChC"}
@@ -4,7 +4,29 @@
4
4
  * Licensed under the MIT License.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.gcBlobKey = void 0;
8
- // The key to use for storing garbage collection blob in summary.
9
- exports.gcBlobKey = "gc";
7
+ exports.gcDeletedBlobKey = exports.gcTombstoneBlobKey = exports.gcBlobPrefix = exports.gcTreeKey = void 0;
8
+ /**
9
+ * The key for the GC tree in summary.
10
+ *
11
+ * @internal
12
+ */
13
+ exports.gcTreeKey = "gc";
14
+ /**
15
+ * They prefix for GC blobs in the GC tree in summary.
16
+ *
17
+ * @internal
18
+ */
19
+ exports.gcBlobPrefix = "__gc";
20
+ /**
21
+ * The key for tombstone blob in the GC tree in summary.
22
+ *
23
+ * @internal
24
+ */
25
+ exports.gcTombstoneBlobKey = "__tombstones";
26
+ /**
27
+ * The key for deleted nodes blob in the GC tree in summary.
28
+ *
29
+ * @internal
30
+ */
31
+ exports.gcDeletedBlobKey = "__deletedNodes";
10
32
  //# sourceMappingURL=garbageCollection.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"garbageCollection.js","sourceRoot":"","sources":["../src/garbageCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iEAAiE;AACpD,QAAA,SAAS,GAAG,IAAI,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// The key to use for storing garbage collection blob in summary.\nexport const gcBlobKey = \"gc\";\n\n/**\n * Garbage collection data returned by nodes in a Container.\n * Used for running GC in the Container.\n */\nexport interface IGarbageCollectionData {\n /** The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes. */\n gcNodes: { [ id: string ]: string[]; };\n}\n\n/**\n * GC details provided to each node during creation.\n */\nexport interface IGarbageCollectionDetailsBase {\n /** A list of routes to Fluid objects that are used in this node. */\n usedRoutes?: string[];\n /** The GC data of this node. */\n gcData?: IGarbageCollectionData;\n /** If this node is unreferenced, the time when it was marked as such. */\n unrefTimestamp?: number;\n}\n\n/**\n * @deprecated - Kept for back-compat. This has been renamed to {@link IGarbageCollectionDetailsBase}.\n */\nexport type IGarbageCollectionSummaryDetails = IGarbageCollectionDetailsBase;\n"]}
1
+ {"version":3,"file":"garbageCollection.js","sourceRoot":"","sources":["../src/garbageCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;GAIG;AACU,QAAA,SAAS,GAAG,IAAI,CAAC;AAC9B;;;;GAIG;AACU,QAAA,YAAY,GAAG,MAAM,CAAC;AACnC;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,cAAc,CAAC;AACjD;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The key for the GC tree in summary.\n *\n * @internal\n */\nexport const gcTreeKey = \"gc\";\n/**\n * They prefix for GC blobs in the GC tree in summary.\n *\n * @internal\n */\nexport const gcBlobPrefix = \"__gc\";\n/**\n * The key for tombstone blob in the GC tree in summary.\n *\n * @internal\n */\nexport const gcTombstoneBlobKey = \"__tombstones\";\n/**\n * The key for deleted nodes blob in the GC tree in summary.\n *\n * @internal\n */\nexport const gcDeletedBlobKey = \"__deletedNodes\";\n\n/**\n * Garbage collection data returned by nodes in a Container.\n * Used for running GC in the Container.\n * @public\n */\nexport interface IGarbageCollectionData {\n\t/**\n\t * The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes.\n\t */\n\tgcNodes: { [id: string]: string[] };\n}\n\n/**\n * GC details provided to each node during creation.\n * @alpha\n */\nexport interface IGarbageCollectionDetailsBase {\n\t/**\n\t * A list of routes to Fluid objects that are used in this node.\n\t */\n\tusedRoutes?: string[];\n\t/**\n\t * The GC data of this node.\n\t */\n\tgcData?: IGarbageCollectionData;\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -2,10 +2,56 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export * from "./dataStoreFactory";
6
- export * from "./dataStoreRegistry";
7
- export * from "./dataStoreContext";
8
- export * from "./garbageCollection";
9
- export * from "./protocol";
10
- export * from "./summary";
5
+ export { AttributionInfo, AttributionKey, DetachedAttributionKey, LocalAttributionKey, OpAttributionKey, } from "./attribution";
6
+ export { AliasResult, CreateChildSummarizerNodeFn, FlushMode, FlushModeExperimental, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IDataStore, IFluidDataStoreChannel, IFluidDataStoreContext, IFluidDataStoreContextDetached, IFluidDataStoreContextEvents, VisibilityState, } from "./dataStoreContext";
7
+ export { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from "./dataStoreFactory";
8
+ export { FluidDataStoreRegistryEntry, IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries, NamedFluidDataStoreRegistryEntry, } from "./dataStoreRegistry";
9
+ export { gcBlobPrefix, gcDeletedBlobKey, gcTombstoneBlobKey, gcTreeKey, IGarbageCollectionData, IGarbageCollectionDetailsBase, } from "./garbageCollection";
10
+ export { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope, } from "./protocol";
11
+ export { blobCountPropertyName, channelsTreeName, CreateChildSummarizerNodeParam, CreateSummarizerNodeSource, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn, totalBlobSizePropertyName, } from "./summary";
12
+ export {
13
+ /**
14
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
15
+ */
16
+ IdCompressor,
17
+ /**
18
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
19
+ */
20
+ IIdCompressor,
21
+ /**
22
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
23
+ */
24
+ IIdCompressorCore,
25
+ /**
26
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
27
+ */
28
+ IdCreationRange,
29
+ /**
30
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
31
+ */
32
+ OpSpaceCompressedId,
33
+ /**
34
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
35
+ */
36
+ SerializedIdCompressor,
37
+ /**
38
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
39
+ */
40
+ SerializedIdCompressorWithNoSession,
41
+ /**
42
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
43
+ */
44
+ SerializedIdCompressorWithOngoingSession,
45
+ /**
46
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
47
+ */
48
+ SessionId,
49
+ /**
50
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
51
+ */
52
+ SessionSpaceCompressedId,
53
+ /**
54
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
55
+ */
56
+ StableId, } from "@fluidframework/id-compressor";
11
57
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,2BAA2B,EAC3B,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,8BAA8B,EAC9B,4BAA4B,EAC5B,eAAe,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EACN,2BAA2B,EAC3B,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,GAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,EACT,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,8BAA8B,EAC9B,0BAA0B,EAC1B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,WAAW,CAAC;AAInB,OAAO;AACN;;GAEG;AACH,YAAY;AACZ;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,iBAAiB;AACjB;;GAEG;AACH,eAAe;AACf;;GAEG;AACH,mBAAmB;AACnB;;GAEG;AACH,sBAAsB;AACtB;;GAEG;AACH,mCAAmC;AACnC;;GAEG;AACH,wCAAwC;AACxC;;GAEG;AACH,SAAS;AACT;;GAEG;AACH,wBAAwB;AACxB;;GAEG;AACH,QAAQ,GACR,MAAM,+BAA+B,CAAC"}
package/dist/index.js CHANGED
@@ -3,21 +3,31 @@
3
3
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
4
  * Licensed under the MIT License.
5
5
  */
6
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
7
- if (k2 === undefined) k2 = k;
8
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
6
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./dataStoreFactory"), exports);
18
- __exportStar(require("./dataStoreRegistry"), exports);
19
- __exportStar(require("./dataStoreContext"), exports);
20
- __exportStar(require("./garbageCollection"), exports);
21
- __exportStar(require("./protocol"), exports);
22
- __exportStar(require("./summary"), exports);
7
+ exports.IdCompressor = 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 dataStoreContext_1 = require("./dataStoreContext");
9
+ Object.defineProperty(exports, "FlushMode", { enumerable: true, get: function () { return dataStoreContext_1.FlushMode; } });
10
+ Object.defineProperty(exports, "FlushModeExperimental", { enumerable: true, get: function () { return dataStoreContext_1.FlushModeExperimental; } });
11
+ Object.defineProperty(exports, "VisibilityState", { enumerable: true, get: function () { return dataStoreContext_1.VisibilityState; } });
12
+ var dataStoreFactory_1 = require("./dataStoreFactory");
13
+ Object.defineProperty(exports, "IFluidDataStoreFactory", { enumerable: true, get: function () { return dataStoreFactory_1.IFluidDataStoreFactory; } });
14
+ var dataStoreRegistry_1 = require("./dataStoreRegistry");
15
+ Object.defineProperty(exports, "IFluidDataStoreRegistry", { enumerable: true, get: function () { return dataStoreRegistry_1.IFluidDataStoreRegistry; } });
16
+ var garbageCollection_1 = require("./garbageCollection");
17
+ Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return garbageCollection_1.gcBlobPrefix; } });
18
+ Object.defineProperty(exports, "gcDeletedBlobKey", { enumerable: true, get: function () { return garbageCollection_1.gcDeletedBlobKey; } });
19
+ Object.defineProperty(exports, "gcTombstoneBlobKey", { enumerable: true, get: function () { return garbageCollection_1.gcTombstoneBlobKey; } });
20
+ Object.defineProperty(exports, "gcTreeKey", { enumerable: true, get: function () { return garbageCollection_1.gcTreeKey; } });
21
+ var summary_1 = require("./summary");
22
+ Object.defineProperty(exports, "blobCountPropertyName", { enumerable: true, get: function () { return summary_1.blobCountPropertyName; } });
23
+ Object.defineProperty(exports, "channelsTreeName", { enumerable: true, get: function () { return summary_1.channelsTreeName; } });
24
+ Object.defineProperty(exports, "CreateSummarizerNodeSource", { enumerable: true, get: function () { return summary_1.CreateSummarizerNodeSource; } });
25
+ Object.defineProperty(exports, "totalBlobSizePropertyName", { enumerable: true, get: function () { return summary_1.totalBlobSizePropertyName; } });
26
+ // Re-exports for backwards compatibility.
27
+ // Will be removed in the future.
28
+ var id_compressor_1 = require("@fluidframework/id-compressor");
29
+ /**
30
+ * @deprecated Import from `@fluidframework/id-compressor` instead.
31
+ */
32
+ Object.defineProperty(exports, "IdCompressor", { enumerable: true, get: function () { return id_compressor_1.IdCompressor; } });
23
33
  //# 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;;;;;;;;;;;;AAEH,qDAAmC;AACnC,sDAAoC;AACpC,qDAAmC;AACnC,sDAAoC;AACpC,6CAA2B;AAC3B,4CAA0B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./dataStoreFactory\";\nexport * from \"./dataStoreRegistry\";\nexport * from \"./dataStoreContext\";\nexport * from \"./garbageCollection\";\nexport * from \"./protocol\";\nexport * from \"./summary\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,uDAa4B;AAV3B,6GAAA,SAAS,OAAA;AACT,yHAAA,qBAAqB,OAAA;AAQrB,mHAAA,eAAe,OAAA;AAEhB,uDAA2F;AAAlF,0HAAA,sBAAsB,OAAA;AAC/B,yDAM6B;AAJ5B,4HAAA,uBAAuB,OAAA;AAKxB,yDAO6B;AAN5B,iHAAA,YAAY,OAAA;AACZ,qHAAA,gBAAgB,OAAA;AAChB,uHAAA,kBAAkB,OAAA;AAClB,8GAAA,SAAS,OAAA;AAWV,qCAiBmB;AAhBlB,gHAAA,qBAAqB,OAAA;AACrB,2GAAA,gBAAgB,OAAA;AAEhB,qHAAA,0BAA0B,OAAA;AAY1B,oHAAA,yBAAyB,OAAA;AAG1B,0CAA0C;AAC1C,iCAAiC;AACjC,+DA6CuC;AA5CtC;;GAEG;AACH,6GAAA,YAAY,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution\";\nexport {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tFlushMode,\n\tFlushModeExperimental,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n\tIFluidDataStoreContextDetached,\n\tIFluidDataStoreContextEvents,\n\tVisibilityState,\n} from \"./dataStoreContext\";\nexport { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nexport {\n\tFluidDataStoreRegistryEntry,\n\tIFluidDataStoreRegistry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n} from \"./dataStoreRegistry\";\nexport {\n\tgcBlobPrefix,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollection\";\nexport {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tISignalEnvelope,\n} from \"./protocol\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateChildSummarizerNodeParam,\n\tCreateSummarizerNodeSource,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tSummarizeInternalFn,\n\ttotalBlobSizePropertyName,\n} from \"./summary\";\n\n// Re-exports for backwards compatibility.\n// Will be removed in the future.\nexport {\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIIdCompressorCore,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIdCreationRange,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tOpSpaceCompressedId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressorWithNoSession,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressorWithOngoingSession,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSessionId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSessionSpaceCompressedId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tStableId,\n} from \"@fluidframework/id-compressor\";\n"]}
@@ -5,6 +5,7 @@
5
5
  import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
6
6
  /**
7
7
  * An envelope wraps the contents with the intended target
8
+ * @alpha
8
9
  */
9
10
  export interface IEnvelope {
10
11
  /**
@@ -16,6 +17,9 @@ export interface IEnvelope {
16
17
  */
17
18
  contents: any;
18
19
  }
20
+ /**
21
+ * @internal
22
+ */
19
23
  export interface ISignalEnvelope {
20
24
  /**
21
25
  * The target for the envelope, undefined for the container
@@ -26,8 +30,8 @@ export interface ISignalEnvelope {
26
30
  */
27
31
  clientSignalSequenceNumber: number;
28
32
  /**
29
- * The contents of the envelope
30
- */
33
+ * The contents of the envelope
34
+ */
31
35
  contents: {
32
36
  type: string;
33
37
  content: any;
@@ -35,6 +39,7 @@ export interface ISignalEnvelope {
35
39
  }
36
40
  /**
37
41
  * Represents ISignalMessage with its type.
42
+ * @public
38
43
  */
39
44
  export interface IInboundSignalMessage extends ISignalMessage {
40
45
  type: string;
@@ -42,6 +47,7 @@ export interface IInboundSignalMessage extends ISignalMessage {
42
47
  /**
43
48
  * Message send by client attaching local data structure.
44
49
  * Contains snapshot of data structure which is the current state of this data structure.
50
+ * @alpha
45
51
  */
46
52
  export interface IAttachMessage {
47
53
  /**
@@ -62,8 +68,9 @@ export interface IAttachMessage {
62
68
  * but it should not be used when creating a new attach op.
63
69
  * Older versions of attach messages could have null snapshots,
64
70
  * so this gives correct typings for writing backward compatible code.
71
+ * @alpha
65
72
  */
66
- export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
73
+ export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
67
74
  snapshot: IAttachMessage["snapshot"] | null;
68
75
  };
69
76
  //# sourceMappingURL=protocol.d.ts.map
@@ -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;AAE7E;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAElC;;MAEE;IACH,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,GAAG,CAAC;KAChB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IACzD,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACnB;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAC7D;IAAE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAAE,CAAC"}
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;AAE7E;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;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"}
@@ -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 */\nexport interface IEnvelope {\n /**\n * The target for the envelope\n */\n address: string;\n\n /**\n * The contents of the envelope\n */\n contents: any;\n}\n\nexport interface ISignalEnvelope {\n /**\n * The target for the envelope, undefined for the container\n */\n address?: string;\n\n /**\n * Identifier for the signal being submitted.\n */\n clientSignalSequenceNumber: number;\n\n /**\n * The contents of the envelope\n */\n contents: {\n type: string;\n content: any;\n };\n}\n\n/**\n * Represents ISignalMessage with its type.\n */\nexport interface IInboundSignalMessage extends ISignalMessage {\n type: 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 */\nexport interface IAttachMessage {\n /**\n * The identifier for the object\n */\n id: string;\n\n /**\n * The type of object\n */\n type: string;\n\n /**\n * Initial snapshot of the document (contains ownership)\n */\n snapshot: 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 */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\">\n & { snapshot: IAttachMessage[\"snapshot\"] | null; };\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 { 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 */\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"]}