@fluidframework/runtime-definitions 2.53.1 → 2.61.0-355054

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