@fluidframework/runtime-definitions 2.1.0-274160 → 2.1.0-276985

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 (62) hide show
  1. package/README.md +3 -1
  2. package/dist/attribution.d.ts +5 -0
  3. package/dist/attribution.d.ts.map +1 -1
  4. package/dist/attribution.js.map +1 -1
  5. package/dist/dataStoreContext.d.ts +12 -0
  6. package/dist/dataStoreContext.d.ts.map +1 -1
  7. package/dist/dataStoreContext.js +2 -0
  8. package/dist/dataStoreContext.js.map +1 -1
  9. package/dist/dataStoreFactory.d.ts +3 -0
  10. package/dist/dataStoreFactory.d.ts.map +1 -1
  11. package/dist/dataStoreFactory.js +1 -0
  12. package/dist/dataStoreFactory.js.map +1 -1
  13. package/dist/dataStoreRegistry.d.ts +6 -0
  14. package/dist/dataStoreRegistry.d.ts.map +1 -1
  15. package/dist/dataStoreRegistry.js +1 -0
  16. package/dist/dataStoreRegistry.js.map +1 -1
  17. package/dist/garbageCollectionDefinitions.d.ts +2 -0
  18. package/dist/garbageCollectionDefinitions.d.ts.map +1 -1
  19. package/dist/garbageCollectionDefinitions.js.map +1 -1
  20. package/dist/legacy.d.ts +1 -1
  21. package/dist/protocol.d.ts +4 -0
  22. package/dist/protocol.d.ts.map +1 -1
  23. package/dist/protocol.js.map +1 -1
  24. package/dist/summary.d.ts +13 -0
  25. package/dist/summary.d.ts.map +1 -1
  26. package/dist/summary.js +1 -0
  27. package/dist/summary.js.map +1 -1
  28. package/lib/attribution.d.ts +5 -0
  29. package/lib/attribution.d.ts.map +1 -1
  30. package/lib/attribution.js.map +1 -1
  31. package/lib/dataStoreContext.d.ts +12 -0
  32. package/lib/dataStoreContext.d.ts.map +1 -1
  33. package/lib/dataStoreContext.js +2 -0
  34. package/lib/dataStoreContext.js.map +1 -1
  35. package/lib/dataStoreFactory.d.ts +3 -0
  36. package/lib/dataStoreFactory.d.ts.map +1 -1
  37. package/lib/dataStoreFactory.js +1 -0
  38. package/lib/dataStoreFactory.js.map +1 -1
  39. package/lib/dataStoreRegistry.d.ts +6 -0
  40. package/lib/dataStoreRegistry.d.ts.map +1 -1
  41. package/lib/dataStoreRegistry.js +1 -0
  42. package/lib/dataStoreRegistry.js.map +1 -1
  43. package/lib/garbageCollectionDefinitions.d.ts +2 -0
  44. package/lib/garbageCollectionDefinitions.d.ts.map +1 -1
  45. package/lib/garbageCollectionDefinitions.js.map +1 -1
  46. package/lib/legacy.d.ts +1 -1
  47. package/lib/protocol.d.ts +4 -0
  48. package/lib/protocol.d.ts.map +1 -1
  49. package/lib/protocol.js.map +1 -1
  50. package/lib/summary.d.ts +13 -0
  51. package/lib/summary.d.ts.map +1 -1
  52. package/lib/summary.js +1 -0
  53. package/lib/summary.js.map +1 -1
  54. package/package.json +8 -8
  55. package/src/attribution.ts +5 -0
  56. package/src/dataStoreContext.ts +12 -0
  57. package/src/dataStoreFactory.ts +3 -0
  58. package/src/dataStoreRegistry.ts +6 -0
  59. package/src/garbageCollectionDefinitions.ts +2 -0
  60. package/src/protocol.ts +4 -0
  61. package/src/summary.ts +13 -0
  62. /package/api-report/{runtime-definitions.alpha.api.md → runtime-definitions.legacy.alpha.api.md} +0 -0
package/src/summary.ts CHANGED
@@ -20,6 +20,7 @@ import type {
20
20
 
21
21
  /**
22
22
  * Contains the aggregation data from a Tree/Subtree.
23
+ * @legacy
23
24
  * @alpha
24
25
  */
25
26
  export interface ISummaryStats {
@@ -36,6 +37,7 @@ export interface ISummaryStats {
36
37
  * each of its DDS.
37
38
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
38
39
  * will be taking part of the summarization process.
40
+ * @legacy
39
41
  * @alpha
40
42
  */
41
43
  export interface ISummaryTreeWithStats {
@@ -52,6 +54,7 @@ export interface ISummaryTreeWithStats {
52
54
 
53
55
  /**
54
56
  * Represents a summary at a current sequence number.
57
+ * @legacy
55
58
  * @alpha
56
59
  */
57
60
  export interface ISummarizeResult {
@@ -73,6 +76,7 @@ export interface ISummarizeResult {
73
76
  * ...
74
77
  * "path1":
75
78
  * ```
79
+ * @legacy
76
80
  * @alpha
77
81
  */
78
82
  export interface ISummarizeInternalResult extends ISummarizeResult {
@@ -86,6 +90,7 @@ export interface ISummarizeInternalResult extends ISummarizeResult {
86
90
  /**
87
91
  * @experimental - Can be deleted/changed at any time
88
92
  * Contains the necessary information to allow DDSes to do incremental summaries
93
+ * @legacy
89
94
  * @alpha
90
95
  */
91
96
  export interface IExperimentalIncrementalSummaryContext {
@@ -112,6 +117,7 @@ export interface IExperimentalIncrementalSummaryContext {
112
117
  }
113
118
 
114
119
  /**
120
+ * @legacy
115
121
  * @alpha
116
122
  */
117
123
  export type SummarizeInternalFn = (
@@ -122,6 +128,7 @@ export type SummarizeInternalFn = (
122
128
  ) => Promise<ISummarizeInternalResult>;
123
129
 
124
130
  /**
131
+ * @legacy
125
132
  * @alpha
126
133
  */
127
134
  export interface ISummarizerNodeConfig {
@@ -133,6 +140,7 @@ export interface ISummarizerNodeConfig {
133
140
  }
134
141
 
135
142
  /**
143
+ * @legacy
136
144
  * @alpha
137
145
  */
138
146
  export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
@@ -144,6 +152,7 @@ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
144
152
  }
145
153
 
146
154
  /**
155
+ * @legacy
147
156
  * @alpha
148
157
  */
149
158
  export enum CreateSummarizerNodeSource {
@@ -152,6 +161,7 @@ export enum CreateSummarizerNodeSource {
152
161
  Local,
153
162
  }
154
163
  /**
164
+ * @legacy
155
165
  * @alpha
156
166
  */
157
167
  export type CreateChildSummarizerNodeParam =
@@ -168,6 +178,7 @@ export type CreateChildSummarizerNodeParam =
168
178
  };
169
179
 
170
180
  /**
181
+ * @legacy
171
182
  * @alpha
172
183
  */
173
184
  export interface ISummarizerNode {
@@ -257,6 +268,7 @@ export interface ISummarizerNode {
257
268
  * `isReferenced`: This tells whether this node is referenced in the document or not.
258
269
  *
259
270
  * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
271
+ * @legacy
260
272
  * @alpha
261
273
  */
262
274
  export interface ISummarizerNodeWithGC extends ISummarizerNode {
@@ -351,6 +363,7 @@ export interface ITelemetryContextExt {
351
363
  /**
352
364
  * Contains telemetry data relevant to summarization workflows.
353
365
  * This object is expected to be modified directly by various summarize methods.
366
+ * @legacy
354
367
  * @alpha
355
368
  */
356
369
  export interface ITelemetryContext {