@fluidframework/container-runtime 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.1

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 (424) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/api-extractor/api-extractor-lint-bundle.json +5 -0
  3. package/api-extractor/api-extractor-lint-legacy.cjs.json +5 -0
  4. package/api-extractor/api-extractor-lint-legacy.esm.json +5 -0
  5. package/api-extractor/api-extractor-lint-public.cjs.json +5 -0
  6. package/api-extractor/api-extractor-lint-public.esm.json +5 -0
  7. package/api-extractor.json +1 -1
  8. package/api-report/{container-runtime.api.md → container-runtime.alpha.api.md} +33 -516
  9. package/api-report/container-runtime.beta.api.md +73 -0
  10. package/api-report/container-runtime.public.api.md +73 -0
  11. package/biome.jsonc +4 -0
  12. package/container-runtime.test-files.tar +0 -0
  13. package/dist/batchTracker.d.ts.map +1 -1
  14. package/dist/batchTracker.js.map +1 -1
  15. package/dist/blobManager.d.ts +3 -20
  16. package/dist/blobManager.d.ts.map +1 -1
  17. package/dist/blobManager.js +1 -35
  18. package/dist/blobManager.js.map +1 -1
  19. package/dist/channelCollection.d.ts +21 -12
  20. package/dist/channelCollection.d.ts.map +1 -1
  21. package/dist/channelCollection.js +113 -110
  22. package/dist/channelCollection.js.map +1 -1
  23. package/dist/connectionTelemetry.d.ts +1 -1
  24. package/dist/connectionTelemetry.d.ts.map +1 -1
  25. package/dist/connectionTelemetry.js +14 -14
  26. package/dist/connectionTelemetry.js.map +1 -1
  27. package/dist/containerHandleContext.d.ts +2 -1
  28. package/dist/containerHandleContext.d.ts.map +1 -1
  29. package/dist/containerHandleContext.js.map +1 -1
  30. package/dist/containerRuntime.d.ts +17 -34
  31. package/dist/containerRuntime.d.ts.map +1 -1
  32. package/dist/containerRuntime.js +109 -145
  33. package/dist/containerRuntime.js.map +1 -1
  34. package/dist/dataStore.d.ts.map +1 -1
  35. package/dist/dataStore.js.map +1 -1
  36. package/dist/dataStoreContext.d.ts +30 -44
  37. package/dist/dataStoreContext.d.ts.map +1 -1
  38. package/dist/dataStoreContext.js +26 -40
  39. package/dist/dataStoreContext.js.map +1 -1
  40. package/dist/dataStoreContexts.d.ts.map +1 -1
  41. package/dist/dataStoreContexts.js.map +1 -1
  42. package/dist/dataStoreRegistry.js.map +1 -1
  43. package/dist/deltaManagerProxies.d.ts +4 -3
  44. package/dist/deltaManagerProxies.d.ts.map +1 -1
  45. package/dist/deltaManagerProxies.js.map +1 -1
  46. package/dist/deltaScheduler.d.ts +1 -1
  47. package/dist/deltaScheduler.d.ts.map +1 -1
  48. package/dist/deltaScheduler.js +1 -3
  49. package/dist/deltaScheduler.js.map +1 -1
  50. package/dist/gc/garbageCollection.d.ts +5 -5
  51. package/dist/gc/garbageCollection.d.ts.map +1 -1
  52. package/dist/gc/garbageCollection.js +29 -30
  53. package/dist/gc/garbageCollection.js.map +1 -1
  54. package/dist/gc/gcConfigs.d.ts.map +1 -1
  55. package/dist/gc/gcConfigs.js +12 -31
  56. package/dist/gc/gcConfigs.js.map +1 -1
  57. package/dist/gc/gcDefinitions.d.ts +10 -38
  58. package/dist/gc/gcDefinitions.d.ts.map +1 -1
  59. package/dist/gc/gcDefinitions.js +1 -5
  60. package/dist/gc/gcDefinitions.js.map +1 -1
  61. package/dist/gc/gcHelpers.d.ts +2 -3
  62. package/dist/gc/gcHelpers.d.ts.map +1 -1
  63. package/dist/gc/gcHelpers.js.map +1 -1
  64. package/dist/gc/gcReferenceGraphAlgorithm.js.map +1 -1
  65. package/dist/gc/gcSummaryDefinitions.d.ts +1 -1
  66. package/dist/gc/gcSummaryDefinitions.d.ts.map +1 -1
  67. package/dist/gc/gcSummaryDefinitions.js.map +1 -1
  68. package/dist/gc/gcSummaryStateTracker.d.ts +2 -35
  69. package/dist/gc/gcSummaryStateTracker.d.ts.map +1 -1
  70. package/dist/gc/gcSummaryStateTracker.js +9 -62
  71. package/dist/gc/gcSummaryStateTracker.js.map +1 -1
  72. package/dist/gc/gcTelemetry.d.ts +2 -2
  73. package/dist/gc/gcTelemetry.d.ts.map +1 -1
  74. package/dist/gc/gcTelemetry.js +3 -9
  75. package/dist/gc/gcTelemetry.js.map +1 -1
  76. package/dist/gc/gcUnreferencedStateTracker.js.map +1 -1
  77. package/dist/gc/index.d.ts +1 -1
  78. package/dist/gc/index.d.ts.map +1 -1
  79. package/dist/gc/index.js +1 -3
  80. package/dist/gc/index.js.map +1 -1
  81. package/dist/index.d.ts +2 -2
  82. package/dist/index.d.ts.map +1 -1
  83. package/dist/index.js.map +1 -1
  84. package/dist/legacy.d.ts +1 -1
  85. package/dist/messageTypes.d.ts +6 -22
  86. package/dist/messageTypes.d.ts.map +1 -1
  87. package/dist/messageTypes.js.map +1 -1
  88. package/dist/opLifecycle/batchManager.js.map +1 -1
  89. package/dist/opLifecycle/definitions.d.ts +2 -2
  90. package/dist/opLifecycle/definitions.d.ts.map +1 -1
  91. package/dist/opLifecycle/definitions.js.map +1 -1
  92. package/dist/opLifecycle/index.d.ts +1 -1
  93. package/dist/opLifecycle/index.d.ts.map +1 -1
  94. package/dist/opLifecycle/index.js.map +1 -1
  95. package/dist/opLifecycle/opCompressor.d.ts +11 -1
  96. package/dist/opLifecycle/opCompressor.d.ts.map +1 -1
  97. package/dist/opLifecycle/opCompressor.js +13 -2
  98. package/dist/opLifecycle/opCompressor.js.map +1 -1
  99. package/dist/opLifecycle/opDecompressor.d.ts +1 -1
  100. package/dist/opLifecycle/opDecompressor.d.ts.map +1 -1
  101. package/dist/opLifecycle/opDecompressor.js +1 -2
  102. package/dist/opLifecycle/opDecompressor.js.map +1 -1
  103. package/dist/opLifecycle/opGroupingManager.d.ts +10 -3
  104. package/dist/opLifecycle/opGroupingManager.d.ts.map +1 -1
  105. package/dist/opLifecycle/opGroupingManager.js +7 -0
  106. package/dist/opLifecycle/opGroupingManager.js.map +1 -1
  107. package/dist/opLifecycle/opSplitter.d.ts +4 -2
  108. package/dist/opLifecycle/opSplitter.d.ts.map +1 -1
  109. package/dist/opLifecycle/opSplitter.js +13 -8
  110. package/dist/opLifecycle/opSplitter.js.map +1 -1
  111. package/dist/opLifecycle/outbox.d.ts +10 -0
  112. package/dist/opLifecycle/outbox.d.ts.map +1 -1
  113. package/dist/opLifecycle/outbox.js +13 -18
  114. package/dist/opLifecycle/outbox.js.map +1 -1
  115. package/dist/opLifecycle/remoteMessageProcessor.d.ts +1 -1
  116. package/dist/opLifecycle/remoteMessageProcessor.d.ts.map +1 -1
  117. package/dist/opLifecycle/remoteMessageProcessor.js +2 -2
  118. package/dist/opLifecycle/remoteMessageProcessor.js.map +1 -1
  119. package/dist/opProperties.d.ts +1 -1
  120. package/dist/opProperties.d.ts.map +1 -1
  121. package/dist/opProperties.js.map +1 -1
  122. package/dist/packageVersion.d.ts +1 -1
  123. package/dist/packageVersion.js +1 -1
  124. package/dist/packageVersion.js.map +1 -1
  125. package/dist/pendingStateManager.d.ts.map +1 -1
  126. package/dist/pendingStateManager.js +15 -5
  127. package/dist/pendingStateManager.js.map +1 -1
  128. package/dist/scheduleManager.d.ts +1 -1
  129. package/dist/scheduleManager.d.ts.map +1 -1
  130. package/dist/scheduleManager.js.map +1 -1
  131. package/dist/storageServiceWithAttachBlobs.js.map +1 -1
  132. package/dist/summary/documentSchema.d.ts.map +1 -1
  133. package/dist/summary/documentSchema.js +2 -3
  134. package/dist/summary/documentSchema.js.map +1 -1
  135. package/dist/summary/index.d.ts +2 -2
  136. package/dist/summary/index.d.ts.map +1 -1
  137. package/dist/summary/index.js.map +1 -1
  138. package/dist/summary/orderedClientElection.d.ts +4 -2
  139. package/dist/summary/orderedClientElection.d.ts.map +1 -1
  140. package/dist/summary/orderedClientElection.js +35 -13
  141. package/dist/summary/orderedClientElection.js.map +1 -1
  142. package/dist/summary/runWhileConnectedCoordinator.js.map +1 -1
  143. package/dist/summary/runningSummarizer.d.ts +1 -6
  144. package/dist/summary/runningSummarizer.d.ts.map +1 -1
  145. package/dist/summary/runningSummarizer.js +23 -110
  146. package/dist/summary/runningSummarizer.js.map +1 -1
  147. package/dist/summary/summarizer.d.ts +1 -1
  148. package/dist/summary/summarizer.d.ts.map +1 -1
  149. package/dist/summary/summarizer.js +4 -1
  150. package/dist/summary/summarizer.js.map +1 -1
  151. package/dist/summary/summarizerClientElection.d.ts +1 -1
  152. package/dist/summary/summarizerClientElection.d.ts.map +1 -1
  153. package/dist/summary/summarizerClientElection.js +2 -2
  154. package/dist/summary/summarizerClientElection.js.map +1 -1
  155. package/dist/summary/summarizerHeuristics.js.map +1 -1
  156. package/dist/summary/summarizerNode/summarizerNode.d.ts +2 -3
  157. package/dist/summary/summarizerNode/summarizerNode.d.ts.map +1 -1
  158. package/dist/summary/summarizerNode/summarizerNode.js +16 -16
  159. package/dist/summary/summarizerNode/summarizerNode.js.map +1 -1
  160. package/dist/summary/summarizerNode/summarizerNodeUtils.d.ts +2 -1
  161. package/dist/summary/summarizerNode/summarizerNodeUtils.d.ts.map +1 -1
  162. package/dist/summary/summarizerNode/summarizerNodeUtils.js.map +1 -1
  163. package/dist/summary/summarizerNode/summarizerNodeWithGc.d.ts +2 -3
  164. package/dist/summary/summarizerNode/summarizerNodeWithGc.d.ts.map +1 -1
  165. package/dist/summary/summarizerNode/summarizerNodeWithGc.js +5 -2
  166. package/dist/summary/summarizerNode/summarizerNodeWithGc.js.map +1 -1
  167. package/dist/summary/summarizerTypes.d.ts +17 -29
  168. package/dist/summary/summarizerTypes.d.ts.map +1 -1
  169. package/dist/summary/summarizerTypes.js.map +1 -1
  170. package/dist/summary/summaryCollection.d.ts +1 -1
  171. package/dist/summary/summaryCollection.d.ts.map +1 -1
  172. package/dist/summary/summaryCollection.js +11 -11
  173. package/dist/summary/summaryCollection.js.map +1 -1
  174. package/dist/summary/summaryFormat.d.ts +2 -3
  175. package/dist/summary/summaryFormat.d.ts.map +1 -1
  176. package/dist/summary/summaryFormat.js +2 -2
  177. package/dist/summary/summaryFormat.js.map +1 -1
  178. package/dist/summary/summaryGenerator.d.ts +7 -8
  179. package/dist/summary/summaryGenerator.d.ts.map +1 -1
  180. package/dist/summary/summaryGenerator.js +27 -24
  181. package/dist/summary/summaryGenerator.js.map +1 -1
  182. package/dist/summary/summaryManager.d.ts.map +1 -1
  183. package/dist/summary/summaryManager.js +1 -2
  184. package/dist/summary/summaryManager.js.map +1 -1
  185. package/dist/throttler.d.ts.map +1 -1
  186. package/dist/throttler.js +3 -1
  187. package/dist/throttler.js.map +1 -1
  188. package/lib/batchTracker.d.ts.map +1 -1
  189. package/lib/batchTracker.js +1 -1
  190. package/lib/batchTracker.js.map +1 -1
  191. package/lib/blobManager.d.ts +3 -20
  192. package/lib/blobManager.d.ts.map +1 -1
  193. package/lib/blobManager.js +2 -36
  194. package/lib/blobManager.js.map +1 -1
  195. package/lib/channelCollection.d.ts +21 -12
  196. package/lib/channelCollection.d.ts.map +1 -1
  197. package/lib/channelCollection.js +114 -112
  198. package/lib/channelCollection.js.map +1 -1
  199. package/lib/connectionTelemetry.d.ts +1 -1
  200. package/lib/connectionTelemetry.d.ts.map +1 -1
  201. package/lib/connectionTelemetry.js +2 -2
  202. package/lib/connectionTelemetry.js.map +1 -1
  203. package/lib/containerHandleContext.d.ts +2 -1
  204. package/lib/containerHandleContext.d.ts.map +1 -1
  205. package/lib/containerHandleContext.js.map +1 -1
  206. package/lib/containerRuntime.d.ts +17 -34
  207. package/lib/containerRuntime.d.ts.map +1 -1
  208. package/lib/containerRuntime.js +106 -142
  209. package/lib/containerRuntime.js.map +1 -1
  210. package/lib/dataStore.d.ts.map +1 -1
  211. package/lib/dataStore.js.map +1 -1
  212. package/lib/dataStoreContext.d.ts +30 -44
  213. package/lib/dataStoreContext.d.ts.map +1 -1
  214. package/lib/dataStoreContext.js +29 -43
  215. package/lib/dataStoreContext.js.map +1 -1
  216. package/lib/dataStoreContexts.d.ts.map +1 -1
  217. package/lib/dataStoreContexts.js +1 -1
  218. package/lib/dataStoreContexts.js.map +1 -1
  219. package/lib/dataStoreRegistry.js.map +1 -1
  220. package/lib/deltaManagerProxies.d.ts +4 -3
  221. package/lib/deltaManagerProxies.d.ts.map +1 -1
  222. package/lib/deltaManagerProxies.js.map +1 -1
  223. package/lib/deltaScheduler.d.ts +1 -1
  224. package/lib/deltaScheduler.d.ts.map +1 -1
  225. package/lib/deltaScheduler.js +1 -3
  226. package/lib/deltaScheduler.js.map +1 -1
  227. package/lib/gc/garbageCollection.d.ts +5 -5
  228. package/lib/gc/garbageCollection.d.ts.map +1 -1
  229. package/lib/gc/garbageCollection.js +30 -31
  230. package/lib/gc/garbageCollection.js.map +1 -1
  231. package/lib/gc/gcConfigs.d.ts.map +1 -1
  232. package/lib/gc/gcConfigs.js +13 -32
  233. package/lib/gc/gcConfigs.js.map +1 -1
  234. package/lib/gc/gcDefinitions.d.ts +10 -38
  235. package/lib/gc/gcDefinitions.d.ts.map +1 -1
  236. package/lib/gc/gcDefinitions.js +0 -4
  237. package/lib/gc/gcDefinitions.js.map +1 -1
  238. package/lib/gc/gcHelpers.d.ts +2 -3
  239. package/lib/gc/gcHelpers.d.ts.map +1 -1
  240. package/lib/gc/gcHelpers.js.map +1 -1
  241. package/lib/gc/gcReferenceGraphAlgorithm.js.map +1 -1
  242. package/lib/gc/gcSummaryDefinitions.d.ts +1 -1
  243. package/lib/gc/gcSummaryDefinitions.d.ts.map +1 -1
  244. package/lib/gc/gcSummaryDefinitions.js.map +1 -1
  245. package/lib/gc/gcSummaryStateTracker.d.ts +2 -35
  246. package/lib/gc/gcSummaryStateTracker.d.ts.map +1 -1
  247. package/lib/gc/gcSummaryStateTracker.js +4 -57
  248. package/lib/gc/gcSummaryStateTracker.js.map +1 -1
  249. package/lib/gc/gcTelemetry.d.ts +2 -2
  250. package/lib/gc/gcTelemetry.d.ts.map +1 -1
  251. package/lib/gc/gcTelemetry.js +3 -9
  252. package/lib/gc/gcTelemetry.js.map +1 -1
  253. package/lib/gc/gcUnreferencedStateTracker.js.map +1 -1
  254. package/lib/gc/index.d.ts +1 -1
  255. package/lib/gc/index.d.ts.map +1 -1
  256. package/lib/gc/index.js +1 -1
  257. package/lib/gc/index.js.map +1 -1
  258. package/lib/index.d.ts +2 -2
  259. package/lib/index.d.ts.map +1 -1
  260. package/lib/index.js.map +1 -1
  261. package/lib/legacy.d.ts +1 -1
  262. package/lib/messageTypes.d.ts +6 -22
  263. package/lib/messageTypes.d.ts.map +1 -1
  264. package/lib/messageTypes.js.map +1 -1
  265. package/lib/opLifecycle/batchManager.js.map +1 -1
  266. package/lib/opLifecycle/definitions.d.ts +2 -2
  267. package/lib/opLifecycle/definitions.d.ts.map +1 -1
  268. package/lib/opLifecycle/definitions.js.map +1 -1
  269. package/lib/opLifecycle/index.d.ts +1 -1
  270. package/lib/opLifecycle/index.d.ts.map +1 -1
  271. package/lib/opLifecycle/index.js +1 -1
  272. package/lib/opLifecycle/index.js.map +1 -1
  273. package/lib/opLifecycle/opCompressor.d.ts +11 -1
  274. package/lib/opLifecycle/opCompressor.d.ts.map +1 -1
  275. package/lib/opLifecycle/opCompressor.js +13 -2
  276. package/lib/opLifecycle/opCompressor.js.map +1 -1
  277. package/lib/opLifecycle/opDecompressor.d.ts +1 -1
  278. package/lib/opLifecycle/opDecompressor.d.ts.map +1 -1
  279. package/lib/opLifecycle/opDecompressor.js +1 -2
  280. package/lib/opLifecycle/opDecompressor.js.map +1 -1
  281. package/lib/opLifecycle/opGroupingManager.d.ts +10 -3
  282. package/lib/opLifecycle/opGroupingManager.d.ts.map +1 -1
  283. package/lib/opLifecycle/opGroupingManager.js +7 -0
  284. package/lib/opLifecycle/opGroupingManager.js.map +1 -1
  285. package/lib/opLifecycle/opSplitter.d.ts +4 -2
  286. package/lib/opLifecycle/opSplitter.d.ts.map +1 -1
  287. package/lib/opLifecycle/opSplitter.js +13 -8
  288. package/lib/opLifecycle/opSplitter.js.map +1 -1
  289. package/lib/opLifecycle/outbox.d.ts +10 -0
  290. package/lib/opLifecycle/outbox.d.ts.map +1 -1
  291. package/lib/opLifecycle/outbox.js +13 -18
  292. package/lib/opLifecycle/outbox.js.map +1 -1
  293. package/lib/opLifecycle/remoteMessageProcessor.d.ts +1 -1
  294. package/lib/opLifecycle/remoteMessageProcessor.d.ts.map +1 -1
  295. package/lib/opLifecycle/remoteMessageProcessor.js +1 -1
  296. package/lib/opLifecycle/remoteMessageProcessor.js.map +1 -1
  297. package/lib/opProperties.d.ts +1 -1
  298. package/lib/opProperties.d.ts.map +1 -1
  299. package/lib/opProperties.js.map +1 -1
  300. package/lib/packageVersion.d.ts +1 -1
  301. package/lib/packageVersion.js +1 -1
  302. package/lib/packageVersion.js.map +1 -1
  303. package/lib/pendingStateManager.d.ts.map +1 -1
  304. package/lib/pendingStateManager.js +15 -5
  305. package/lib/pendingStateManager.js.map +1 -1
  306. package/lib/scheduleManager.d.ts +1 -1
  307. package/lib/scheduleManager.d.ts.map +1 -1
  308. package/lib/scheduleManager.js.map +1 -1
  309. package/lib/storageServiceWithAttachBlobs.js.map +1 -1
  310. package/lib/summary/documentSchema.d.ts.map +1 -1
  311. package/lib/summary/documentSchema.js +2 -3
  312. package/lib/summary/documentSchema.js.map +1 -1
  313. package/lib/summary/index.d.ts +2 -2
  314. package/lib/summary/index.d.ts.map +1 -1
  315. package/lib/summary/index.js +1 -1
  316. package/lib/summary/index.js.map +1 -1
  317. package/lib/summary/orderedClientElection.d.ts +4 -2
  318. package/lib/summary/orderedClientElection.d.ts.map +1 -1
  319. package/lib/summary/orderedClientElection.js +35 -13
  320. package/lib/summary/orderedClientElection.js.map +1 -1
  321. package/lib/summary/runWhileConnectedCoordinator.js.map +1 -1
  322. package/lib/summary/runningSummarizer.d.ts +1 -6
  323. package/lib/summary/runningSummarizer.d.ts.map +1 -1
  324. package/lib/summary/runningSummarizer.js +22 -109
  325. package/lib/summary/runningSummarizer.js.map +1 -1
  326. package/lib/summary/summarizer.d.ts +1 -1
  327. package/lib/summary/summarizer.d.ts.map +1 -1
  328. package/lib/summary/summarizer.js +4 -1
  329. package/lib/summary/summarizer.js.map +1 -1
  330. package/lib/summary/summarizerClientElection.d.ts +1 -1
  331. package/lib/summary/summarizerClientElection.d.ts.map +1 -1
  332. package/lib/summary/summarizerClientElection.js +1 -1
  333. package/lib/summary/summarizerClientElection.js.map +1 -1
  334. package/lib/summary/summarizerHeuristics.js.map +1 -1
  335. package/lib/summary/summarizerNode/summarizerNode.d.ts +2 -3
  336. package/lib/summary/summarizerNode/summarizerNode.d.ts.map +1 -1
  337. package/lib/summary/summarizerNode/summarizerNode.js +14 -14
  338. package/lib/summary/summarizerNode/summarizerNode.js.map +1 -1
  339. package/lib/summary/summarizerNode/summarizerNodeUtils.d.ts +2 -1
  340. package/lib/summary/summarizerNode/summarizerNodeUtils.d.ts.map +1 -1
  341. package/lib/summary/summarizerNode/summarizerNodeUtils.js.map +1 -1
  342. package/lib/summary/summarizerNode/summarizerNodeWithGc.d.ts +2 -3
  343. package/lib/summary/summarizerNode/summarizerNodeWithGc.d.ts.map +1 -1
  344. package/lib/summary/summarizerNode/summarizerNodeWithGc.js +5 -2
  345. package/lib/summary/summarizerNode/summarizerNodeWithGc.js.map +1 -1
  346. package/lib/summary/summarizerTypes.d.ts +17 -29
  347. package/lib/summary/summarizerTypes.d.ts.map +1 -1
  348. package/lib/summary/summarizerTypes.js.map +1 -1
  349. package/lib/summary/summaryCollection.d.ts +1 -1
  350. package/lib/summary/summaryCollection.d.ts.map +1 -1
  351. package/lib/summary/summaryCollection.js +3 -3
  352. package/lib/summary/summaryCollection.js.map +1 -1
  353. package/lib/summary/summaryFormat.d.ts +2 -3
  354. package/lib/summary/summaryFormat.d.ts.map +1 -1
  355. package/lib/summary/summaryFormat.js +2 -2
  356. package/lib/summary/summaryFormat.js.map +1 -1
  357. package/lib/summary/summaryGenerator.d.ts +7 -8
  358. package/lib/summary/summaryGenerator.d.ts.map +1 -1
  359. package/lib/summary/summaryGenerator.js +26 -23
  360. package/lib/summary/summaryGenerator.js.map +1 -1
  361. package/lib/summary/summaryManager.d.ts.map +1 -1
  362. package/lib/summary/summaryManager.js +1 -2
  363. package/lib/summary/summaryManager.js.map +1 -1
  364. package/lib/throttler.d.ts.map +1 -1
  365. package/lib/throttler.js +3 -1
  366. package/lib/throttler.js.map +1 -1
  367. package/lib/tsdoc-metadata.json +1 -1
  368. package/package.json +92 -28
  369. package/src/batchTracker.ts +5 -2
  370. package/src/blobManager.ts +21 -61
  371. package/src/channelCollection.ts +179 -186
  372. package/src/connectionTelemetry.ts +18 -12
  373. package/src/containerHandleContext.ts +2 -1
  374. package/src/containerRuntime.ts +166 -214
  375. package/src/dataStore.ts +2 -1
  376. package/src/dataStoreContext.ts +79 -98
  377. package/src/dataStoreContexts.ts +7 -2
  378. package/src/deltaManagerProxies.ts +15 -6
  379. package/src/deltaScheduler.ts +5 -4
  380. package/src/gc/garbageCollection.md +0 -8
  381. package/src/gc/garbageCollection.ts +66 -57
  382. package/src/gc/gcConfigs.ts +15 -37
  383. package/src/gc/gcDefinitions.ts +20 -39
  384. package/src/gc/gcHelpers.ts +8 -4
  385. package/src/gc/gcSummaryDefinitions.ts +1 -1
  386. package/src/gc/gcSummaryStateTracker.ts +11 -74
  387. package/src/gc/gcTelemetry.ts +4 -11
  388. package/src/gc/index.ts +0 -2
  389. package/src/index.ts +1 -2
  390. package/src/messageTypes.ts +8 -24
  391. package/src/opLifecycle/README.md +120 -160
  392. package/src/opLifecycle/definitions.ts +2 -2
  393. package/src/opLifecycle/index.ts +5 -1
  394. package/src/opLifecycle/opCompressor.ts +13 -2
  395. package/src/opLifecycle/opDecompressor.ts +3 -7
  396. package/src/opLifecycle/opGroupingManager.ts +12 -8
  397. package/src/opLifecycle/opSplitter.ts +22 -11
  398. package/src/opLifecycle/outbox.ts +14 -32
  399. package/src/opLifecycle/remoteMessageProcessor.ts +4 -1
  400. package/src/opProperties.ts +2 -2
  401. package/src/packageVersion.ts +1 -1
  402. package/src/pendingStateManager.ts +20 -7
  403. package/src/scheduleManager.ts +4 -1
  404. package/src/summary/documentSchema.ts +4 -7
  405. package/src/summary/images/appTree.png +0 -0
  406. package/src/summary/images/protocolAndAppTree.png +0 -0
  407. package/src/summary/images/summaryTree.png +0 -0
  408. package/src/summary/index.ts +5 -2
  409. package/src/summary/orderedClientElection.ts +100 -22
  410. package/src/summary/runningSummarizer.ts +54 -124
  411. package/src/summary/summarizer.ts +5 -2
  412. package/src/summary/summarizerClientElection.ts +4 -2
  413. package/src/summary/summarizerNode/summarizerNode.ts +23 -30
  414. package/src/summary/summarizerNode/summarizerNodeUtils.ts +9 -3
  415. package/src/summary/summarizerNode/summarizerNodeWithGc.ts +11 -11
  416. package/src/summary/summarizerTypes.ts +32 -33
  417. package/src/summary/summaryCollection.ts +6 -3
  418. package/src/summary/summaryFormat.ts +18 -10
  419. package/src/summary/summaryFormats.md +160 -0
  420. package/src/summary/summaryGenerator.ts +47 -30
  421. package/src/summary/summaryManager.ts +6 -9
  422. package/src/throttler.ts +3 -1
  423. package/tsconfig.json +2 -0
  424. package/tsdoc.json +4 -0
@@ -1,4 +1,4 @@
1
- ## API Report File for "@fluidframework/container-runtime"
1
+ ## Alpha API Report File for "@fluidframework/container-runtime"
2
2
 
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
@@ -10,11 +10,10 @@ import { ContainerWarning } from '@fluidframework/container-definitions/internal
10
10
  import { CreateChildSummarizerNodeFn } from '@fluidframework/runtime-definitions/internal';
11
11
  import { CreateChildSummarizerNodeParam } from '@fluidframework/runtime-definitions/internal';
12
12
  import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions/internal';
13
- import { FluidObject } from '@fluidframework/core-interfaces/internal';
14
- import { FluidObject as FluidObject_2 } from '@fluidframework/core-interfaces';
13
+ import { FluidObject } from '@fluidframework/core-interfaces';
15
14
  import { FlushMode } from '@fluidframework/runtime-definitions/internal';
16
15
  import { IAudience } from '@fluidframework/container-definitions';
17
- import { IClientDetails } from '@fluidframework/protocol-definitions';
16
+ import { IClientDetails } from '@fluidframework/driver-definitions';
18
17
  import { IContainerContext } from '@fluidframework/container-definitions/internal';
19
18
  import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
20
19
  import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
@@ -23,170 +22,55 @@ import { ICriticalContainerError } from '@fluidframework/container-definitions';
23
22
  import { IDataStore } from '@fluidframework/runtime-definitions/internal';
24
23
  import { IDeltaManager } from '@fluidframework/container-definitions/internal';
25
24
  import { IDisposable } from '@fluidframework/core-interfaces';
26
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
25
+ import { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
27
26
  import { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
28
27
  import { IEnvelope } from '@fluidframework/runtime-definitions/internal';
29
28
  import { IEvent } from '@fluidframework/core-interfaces';
30
- import { IEvent as IEvent_2 } from '@fluidframework/core-interfaces/internal';
31
29
  import { IEventProvider } from '@fluidframework/core-interfaces';
32
30
  import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
33
31
  import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
34
32
  import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions/internal';
35
33
  import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
36
34
  import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
37
- import { IFluidHandle } from '@fluidframework/core-interfaces/internal';
35
+ import { IFluidHandle } from '@fluidframework/core-interfaces';
38
36
  import { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
39
- import { IFluidHandleContext as IFluidHandleContext_2 } from '@fluidframework/core-interfaces';
40
37
  import { IFluidHandleInternal } from '@fluidframework/core-interfaces/internal';
41
38
  import { IFluidParentContext } from '@fluidframework/runtime-definitions/internal';
42
- import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
39
+ import { IGarbageCollectionData } from '@fluidframework/runtime-definitions/internal';
43
40
  import { IGarbageCollectionDetailsBase } from '@fluidframework/runtime-definitions/internal';
44
41
  import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions/internal';
45
42
  import type { IIdCompressor } from '@fluidframework/id-compressor';
46
43
  import type { IIdCompressorCore } from '@fluidframework/id-compressor/internal';
47
- import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
44
+ import { IInboundSignalMessage } from '@fluidframework/runtime-definitions/internal';
48
45
  import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces/internal';
49
- import { IQuorumClients } from '@fluidframework/protocol-definitions';
50
- import { IRequest } from '@fluidframework/core-interfaces/internal';
51
- import { IRequest as IRequest_2 } from '@fluidframework/core-interfaces';
52
- import { IResponse } from '@fluidframework/core-interfaces/internal';
53
- import { IResponse as IResponse_2 } from '@fluidframework/core-interfaces';
46
+ import { IQuorumClients } from '@fluidframework/driver-definitions';
47
+ import { IRequest } from '@fluidframework/core-interfaces';
48
+ import { IResponse } from '@fluidframework/core-interfaces';
54
49
  import { IRuntime } from '@fluidframework/container-definitions/internal';
55
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
56
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
50
+ import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
51
+ import { ISignalMessage } from '@fluidframework/driver-definitions/internal';
57
52
  import type { ISnapshot } from '@fluidframework/driver-definitions/internal';
58
- import { ISnapshotTree } from '@fluidframework/protocol-definitions';
53
+ import { ISnapshotTree } from '@fluidframework/driver-definitions/internal';
59
54
  import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
60
55
  import { ISummarizerNodeWithGC } from '@fluidframework/runtime-definitions/internal';
61
- import { ISummaryAck } from '@fluidframework/protocol-definitions';
62
- import { ISummaryContent } from '@fluidframework/protocol-definitions';
63
- import { ISummaryNack } from '@fluidframework/protocol-definitions';
64
- import { ISummaryStats } from '@fluidframework/runtime-definitions';
65
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
66
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
56
+ import { ISummaryAck } from '@fluidframework/driver-definitions/internal';
57
+ import { ISummaryContent } from '@fluidframework/driver-definitions/internal';
58
+ import { ISummaryNack } from '@fluidframework/driver-definitions/internal';
59
+ import { ISummaryStats } from '@fluidframework/runtime-definitions/internal';
60
+ import { ISummaryTree } from '@fluidframework/driver-definitions';
61
+ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
67
62
  import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
68
- import { ITelemetryContext } from '@fluidframework/runtime-definitions';
63
+ import { ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
69
64
  import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils/internal';
70
- import { MessageType } from '@fluidframework/protocol-definitions';
65
+ import { MessageType } from '@fluidframework/driver-definitions/internal';
71
66
  import { MonitoringContext } from '@fluidframework/telemetry-utils/internal';
72
67
  import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
73
68
  import { SummarizeInternalFn } from '@fluidframework/runtime-definitions/internal';
74
69
  import { TypedEventEmitter } from '@fluid-internal/client-utils';
75
70
 
76
- // @internal
77
- export const agentSchedulerId = "_scheduler";
78
-
79
- // @internal
80
- export const AllowInactiveRequestHeaderKey = "allowInactive";
81
-
82
71
  // @alpha
83
72
  export const AllowTombstoneRequestHeaderKey = "allowTombstone";
84
73
 
85
- // @internal
86
- export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
87
- constructor(baseSnapshot: ISnapshotTree | ISnapshot | undefined, parentContext: IFluidParentContext, baseLogger: ITelemetryBaseLogger, gcNodeUpdated: (props: IGCNodeUpdatedProps) => void, isDataStoreDeleted: (nodePath: string) => boolean, aliasMap: Map<string, string>, provideEntryPoint: (runtime: ChannelCollection) => Promise<FluidObject_2>);
88
- // (undocumented)
89
- get aliases(): ReadonlyMap<string, string>;
90
- // (undocumented)
91
- protected applyStashedChannelChannelOp(envelope: IEnvelope): Promise<unknown>;
92
- // (undocumented)
93
- applyStashedOp(content: unknown): Promise<unknown>;
94
- // (undocumented)
95
- readonly attachOpFiredForDataStore: Set<string>;
96
- // (undocumented)
97
- protected readonly baseSnapshot: ISnapshotTree | ISnapshot | undefined;
98
- // (undocumented)
99
- readonly containerLoadStats: {
100
- readonly containerLoadDataStoreCount: number;
101
- readonly referencedDataStoreCount: number;
102
- };
103
- // (undocumented)
104
- protected readonly contexts: DataStoreContexts;
105
- // (undocumented)
106
- protected createContext<T extends LocalFluidDataStoreContext>(id: string, pkg: Readonly<string[]>, contextCtor: new (props: ILocalDetachedFluidDataStoreContextProps) => T, createProps?: any, loadingGroupId?: string): T;
107
- // (undocumented)
108
- createDataStoreContext(pkg: Readonly<string[]>, props?: any, loadingGroupId?: string): IFluidDataStoreContextInternal;
109
- protected createDataStoreId(): string;
110
- // (undocumented)
111
- createDetachedDataStore(pkg: Readonly<string[]>, loadingGroupId?: string): IFluidDataStoreContextDetached;
112
- // (undocumented)
113
- deleteChild(dataStoreId: string): void;
114
- deleteSweepReadyNodes(sweepReadyDataStoreRoutes: readonly string[]): readonly string[];
115
- // (undocumented)
116
- readonly dispose: () => void;
117
- // (undocumented)
118
- get disposed(): boolean;
119
- // (undocumented)
120
- readonly entryPoint: IFluidHandleInternal<FluidObject_2>;
121
- getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
122
- getDataStoreIfAvailable(id: string, requestHeaderData: RuntimeHeaderData): Promise<IFluidDataStoreContextInternal | undefined>;
123
- getDataStorePackagePath(nodePath: string): Promise<readonly string[] | undefined>;
124
- getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
125
- getGCNodeType(nodePath: string): GCNodeType | undefined;
126
- // (undocumented)
127
- internalId(maybeAlias: string): string;
128
- makeVisibleAndAttachGraph(): void;
129
- // (undocumented)
130
- protected readonly mc: MonitoringContext;
131
- // (undocumented)
132
- readonly parentContext: IFluidParentContext;
133
- // (undocumented)
134
- get pendingAliases(): Map<string, Promise<AliasResult>>;
135
- // (undocumented)
136
- process(message: ISequencedDocumentMessage, local: boolean, localMessageMetadata: unknown, addedOutboundReference?: (fromNodePath: string, toNodePath: string) => void): void;
137
- // (undocumented)
138
- processAliasMessageCore(internalId: string, alias: string): boolean;
139
- // (undocumented)
140
- protected processChannelOp(address: string, message: ISequencedDocumentMessage, local: boolean, localMessageMetadata: unknown): void;
141
- // (undocumented)
142
- processSignal(messageArg: IInboundSignalMessage, local: boolean): void;
143
- // (undocumented)
144
- request(request: IRequest_2): Promise<IResponse_2>;
145
- // (undocumented)
146
- reSubmit(type: string, content: any, localOpMetadata: unknown): void;
147
- // (undocumented)
148
- protected reSubmitChannelOp(type: string, content: any, localOpMetadata: unknown): void;
149
- // (undocumented)
150
- rollback(type: string, content: any, localOpMetadata: unknown): void;
151
- // (undocumented)
152
- setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
153
- // (undocumented)
154
- setConnectionState(connected: boolean, clientId?: string): void;
155
- // (undocumented)
156
- get size(): number;
157
- // (undocumented)
158
- protected submitAttachChannelOp(localContext: LocalFluidDataStoreContext): void;
159
- // (undocumented)
160
- summarize(fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
161
- updateStateBeforeGC(): Promise<void>;
162
- updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
163
- updateUsedRoutes(usedRoutes: readonly string[]): void;
164
- // (undocumented)
165
- waitIfPendingAlias(maybeAlias: string): Promise<AliasResult>;
166
- // (undocumented)
167
- protected wrapContextForInnerChannel(id: string): IFluidParentContext;
168
- }
169
-
170
- // @internal (undocumented)
171
- export class ChannelCollectionFactory<T extends ChannelCollection = ChannelCollection> implements IFluidDataStoreFactory {
172
- constructor(registryEntries: NamedFluidDataStoreRegistryEntries, provideEntryPoint: (runtime: IFluidDataStoreChannel) => Promise<FluidObject_2>, ctor: (...args: ConstructorParameters<typeof ChannelCollection>) => T);
173
- // (undocumented)
174
- get IFluidDataStoreFactory(): this;
175
- // (undocumented)
176
- IFluidDataStoreRegistry: IFluidDataStoreRegistry;
177
- // (undocumented)
178
- instantiateDataStore(context: IFluidDataStoreContext, _existing: boolean): Promise<IFluidDataStoreChannel>;
179
- // (undocumented)
180
- readonly type = "ChannelCollectionChannel";
181
- }
182
-
183
- // @internal
184
- export type CompatModeBehavior =
185
- /** Ignore the op. It won't be persisted if this client summarizes */
186
- "Ignore"
187
- /** Fail processing immediately. (The container will close) */
188
- | "FailToProcess";
189
-
190
74
  // @alpha
191
75
  export enum CompressionAlgorithms {
192
76
  // (undocumented)
@@ -214,17 +98,15 @@ export enum ContainerMessageType {
214
98
 
215
99
  // @alpha
216
100
  export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
217
- protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, logger: ITelemetryLoggerExt, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, createIdCompressor: () => Promise<IIdCompressor & IIdCompressorCore>, documentsSchemaController: DocumentsSchemaController, featureGatesForTelemetry: Record<string, boolean | number | undefined>, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration);
101
+ protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, baseLogger: ITelemetryBaseLogger, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, createIdCompressor: () => Promise<IIdCompressor & IIdCompressorCore>, documentsSchemaController: DocumentsSchemaController, featureGatesForTelemetry: Record<string, boolean | number | undefined>, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration);
218
102
  // (undocumented)
219
103
  protected addContainerStateToSummary(summaryTree: ISummaryTreeWithStats, fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext): void;
220
- addedGCOutboundReference(srcHandle: {
221
- absolutePath: string;
222
- }, outboundHandle: {
223
- absolutePath: string;
224
- }): void;
104
+ addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
225
105
  // (undocumented)
226
106
  get attachState(): AttachState;
227
107
  // (undocumented)
108
+ readonly baseLogger: ITelemetryBaseLogger;
109
+ // (undocumented)
228
110
  readonly clientDetails: IClientDetails;
229
111
  // (undocumented)
230
112
  get clientId(): string | undefined;
@@ -308,8 +190,6 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
308
190
  provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;
309
191
  }): Promise<ContainerRuntime>;
310
192
  // (undocumented)
311
- readonly logger: ITelemetryLoggerExt;
312
- // (undocumented)
313
193
  makeLocallyVisible(): void;
314
194
  // (undocumented)
315
195
  notifyOpReplay(message: ISequencedDocumentMessage): Promise<void>;
@@ -356,62 +236,21 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
356
236
  // (undocumented)
357
237
  summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
358
238
  get summarizerClientId(): string | undefined;
359
- updateStateBeforeGC(): Promise<void>;
360
239
  updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
361
240
  updateUsedRoutes(usedRoutes: readonly string[]): void;
362
241
  // (undocumented)
363
242
  uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternal<ArrayBufferLike>>;
364
243
  }
365
244
 
366
- // @internal @deprecated
367
- export interface ContainerRuntimeMessage {
368
- compatDetails?: IContainerRuntimeMessageCompatDetails;
369
- contents: any;
370
- type: ContainerMessageType;
371
- }
372
-
373
245
  // @alpha
374
246
  export const currentDocumentVersionSchema = 1;
375
247
 
376
- // @internal (undocumented)
377
- export class DataStoreContexts implements Iterable<[string, FluidDataStoreContext]>, IDisposable {
378
- // (undocumented)
379
- [Symbol.iterator](): Iterator<[string, FluidDataStoreContext]>;
380
- constructor(baseLogger: ITelemetryBaseLogger);
381
- addBoundOrRemoted(context: FluidDataStoreContext): void;
382
- addUnbound(context: LocalFluidDataStoreContext): void;
383
- bind(id: string): void;
384
- // (undocumented)
385
- delete(id: string): boolean;
386
- // (undocumented)
387
- readonly dispose: () => void;
388
- // (undocumented)
389
- get disposed(): boolean;
390
- // (undocumented)
391
- get(id: string): FluidDataStoreContext | undefined;
392
- getBoundOrRemoted(id: string, wait: boolean): Promise<FluidDataStoreContext | undefined>;
393
- // (undocumented)
394
- getRecentlyDeletedContext(id: string): FluidDataStoreContext | undefined;
395
- getUnbound(id: string): LocalFluidDataStoreContext | undefined;
396
- // (undocumented)
397
- has(id: string): boolean;
398
- // (undocumented)
399
- isNotBound(id: string): boolean;
400
- // (undocumented)
401
- notBoundLength(): number;
402
- // (undocumented)
403
- get size(): number;
404
- }
405
-
406
248
  // @alpha (undocumented)
407
249
  export const DefaultSummaryConfiguration: ISummaryConfiguration;
408
250
 
409
251
  // @alpha
410
252
  export const DeletedResponseHeaderKey = "wasDeleted";
411
253
 
412
- // @internal
413
- export function detectOutboundReferences(address: string, contents: unknown, addedOutboundReference: (fromNodePath: string, toNodePath: string) => void): void;
414
-
415
254
  // @alpha (undocumented)
416
255
  export const disabledCompressionConfig: ICompressionRuntimeOptions;
417
256
 
@@ -442,154 +281,6 @@ export type EnqueueSummarizeResult = (ISummarizeResults & {
442
281
  readonly overridden?: undefined;
443
282
  };
444
283
 
445
- // @internal
446
- export abstract class FluidDataStoreContext extends TypedEventEmitter<IFluidDataStoreContextEvents> implements IFluidDataStoreContextInternal, IFluidParentContext, IDisposable {
447
- constructor(props: IFluidDataStoreContextProps, existing: boolean, isLocalDataStore: boolean, makeLocallyVisibleFn: () => void);
448
- // @deprecated (undocumented)
449
- addedGCOutboundReference(srcHandle: IFluidHandleInternal, outboundHandle: IFluidHandleInternal): void;
450
- addedGCOutboundRoute(fromPath: string, toPath: string): void;
451
- // (undocumented)
452
- applyStashedOp(contents: any): Promise<unknown>;
453
- // (undocumented)
454
- get attachState(): AttachState;
455
- // (undocumented)
456
- protected _attachState: AttachState;
457
- // (undocumented)
458
- get baseSnapshot(): ISnapshotTree | undefined;
459
- // (undocumented)
460
- protected _baseSnapshot: ISnapshotTree | undefined;
461
- // (undocumented)
462
- protected bindRuntime(channel: IFluidDataStoreChannel, existing: boolean): Promise<void>;
463
- // (undocumented)
464
- protected channel: IFluidDataStoreChannel | undefined;
465
- // (undocumented)
466
- protected channelP: Promise<IFluidDataStoreChannel> | undefined;
467
- // (undocumented)
468
- get clientDetails(): IClientDetails;
469
- // (undocumented)
470
- get clientId(): string | undefined;
471
- // (undocumented)
472
- protected completeBindingRuntime(channel: IFluidDataStoreChannel): void;
473
- // (undocumented)
474
- get connected(): boolean;
475
- // (undocumented)
476
- get containerRuntime(): IContainerRuntimeBase;
477
- delete(): void;
478
- // (undocumented)
479
- deleteChildSummarizerNode(id: string): void;
480
- protected deleted: boolean;
481
- // (undocumented)
482
- get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
483
- // (undocumented)
484
- protected detachedRuntimeCreation: boolean;
485
- // (undocumented)
486
- dispose(): void;
487
- // (undocumented)
488
- get disposed(): boolean;
489
- // (undocumented)
490
- ensureNoDataModelChanges<T>(callback: () => T): T;
491
- // (undocumented)
492
- protected factoryFromPackagePath(): Promise<IFluidDataStoreFactory>;
493
- readonly gcThrowOnTombstoneUsage: boolean;
494
- // (undocumented)
495
- readonly gcTombstoneEnforcementAllowed: boolean;
496
- // (undocumented)
497
- getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
498
- abstract getAttachData(includeGCData: boolean, telemetryContext?: ITelemetryContext): {
499
- attachSummary: ISummaryTreeWithStats;
500
- type: string;
501
- };
502
- // (undocumented)
503
- getAudience(): IAudience;
504
- // @deprecated (undocumented)
505
- getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
506
- // (undocumented)
507
- getCreateChildSummarizerNodeFn(id: string, createParam: CreateChildSummarizerNodeParam): (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>) => ISummarizerNodeWithGC;
508
- getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
509
- // (undocumented)
510
- abstract getInitialSnapshotDetails(): Promise<ISnapshotDetails>;
511
- // (undocumented)
512
- getQuorum(): IQuorumClients;
513
- // (undocumented)
514
- readonly id: string;
515
- // (undocumented)
516
- get idCompressor(): IIdCompressor | undefined;
517
- protected identifyLocalChangeInSummarizer(eventName: string, type?: string): void;
518
- // (undocumented)
519
- get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
520
- // (undocumented)
521
- get IFluidHandleContext(): IFluidHandleContext_2;
522
- protected isInMemoryRoot(): boolean;
523
- // (undocumented)
524
- get isLoaded(): boolean;
525
- // (undocumented)
526
- readonly isLocalDataStore: boolean;
527
- isRoot(aliasedDataStores?: Set<string>): Promise<boolean>;
528
- // (undocumented)
529
- readonly loadingGroupId: string | undefined;
530
- // (undocumented)
531
- get logger(): ITelemetryBaseLogger;
532
- makeLocallyVisible(): void;
533
- // (undocumented)
534
- protected readonly mc: MonitoringContext;
535
- // (undocumented)
536
- get options(): Record<string | number, any>;
537
- // (undocumented)
538
- get packagePath(): readonly string[];
539
- // (undocumented)
540
- protected pending: ISequencedDocumentMessage[] | undefined;
541
- // (undocumented)
542
- protected pkg?: readonly string[];
543
- // (undocumented)
544
- process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
545
- // (undocumented)
546
- protected processPendingOps(channel: IFluidDataStoreChannel): void;
547
- // (undocumented)
548
- processSignal(message: IInboundSignalMessage, local: boolean): void;
549
- // (undocumented)
550
- realize(): Promise<IFluidDataStoreChannel>;
551
- // (undocumented)
552
- protected registry: IFluidDataStoreRegistry | undefined;
553
- // @deprecated (undocumented)
554
- request(request: IRequest_2): Promise<IResponse_2>;
555
- // (undocumented)
556
- reSubmit(type: string, contents: any, localOpMetadata: unknown): void;
557
- // (undocumented)
558
- rollback(type: string, contents: any, localOpMetadata: unknown): void;
559
- // (undocumented)
560
- readonly scope: FluidObject_2;
561
- // (undocumented)
562
- abstract setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
563
- setChannelDirty(address: string): void;
564
- setConnectionState(connected: boolean, clientId?: string): void;
565
- // @deprecated (undocumented)
566
- setInMemoryRoot(): void;
567
- // (undocumented)
568
- setTombstone(tombstone: boolean): void;
569
- // (undocumented)
570
- readonly storage: IDocumentStorageService;
571
- // (undocumented)
572
- submitMessage(type: string, content: any, localOpMetadata: unknown): void;
573
- submitSignal(type: string, content: unknown, targetClientId?: string): void;
574
- summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;
575
- // (undocumented)
576
- protected readonly summarizerNode: ISummarizerNodeWithGC;
577
- // (undocumented)
578
- get tombstoned(): boolean;
579
- updateUsedRoutes(usedRoutes: string[]): void;
580
- // (undocumented)
581
- uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternal<ArrayBufferLike>>;
582
- }
583
-
584
- // @internal (undocumented)
585
- export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
586
- constructor(namedEntries: NamedFluidDataStoreRegistryEntries);
587
- // (undocumented)
588
- get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
589
- // (undocumented)
590
- get IFluidDataStoreRegistry(): this;
591
- }
592
-
593
284
  // @alpha (undocumented)
594
285
  export type GCFeatureMatrix = {
595
286
  gcGeneration?: number;
@@ -630,7 +321,7 @@ export interface IAckSummaryResult {
630
321
 
631
322
  // @alpha
632
323
  export interface IBaseSummarizeResult {
633
- readonly error: Error | undefined;
324
+ readonly error: IRetriableFailureError | undefined;
634
325
  // (undocumented)
635
326
  readonly minimumSequenceNumber: number;
636
327
  readonly referenceSequenceNumber: number;
@@ -666,20 +357,6 @@ export interface ICancellationToken<T> {
666
357
  readonly waitCancelled: Promise<T>;
667
358
  }
668
359
 
669
- // @internal (undocumented)
670
- export interface IChunkedOp {
671
- // (undocumented)
672
- chunkId: number;
673
- // (undocumented)
674
- contents: string;
675
- // (undocumented)
676
- originalCompression?: string;
677
- // (undocumented)
678
- originalMetadata?: Record<string, unknown>;
679
- // (undocumented)
680
- totalChunks: number;
681
- }
682
-
683
360
  // @alpha
684
361
  export interface IClientSummaryWatcher extends IDisposable {
685
362
  // (undocumented)
@@ -706,11 +383,6 @@ export interface IConnectableRuntime {
706
383
  once(event: "connected" | "disconnected" | "dispose", listener: () => void): this;
707
384
  }
708
385
 
709
- // @internal
710
- export interface IContainerRuntimeMessageCompatDetails {
711
- behavior: CompatModeBehavior;
712
- }
713
-
714
386
  // @alpha (undocumented)
715
387
  export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
716
388
  readonly disableIsolatedChannels?: true;
@@ -818,45 +490,6 @@ export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFlui
818
490
  readonly summaryFormatVersion: 2;
819
491
  }
820
492
 
821
- // @internal (undocumented)
822
- export interface IFluidDataStoreContextEvents extends IEvent_2 {
823
- // (undocumented)
824
- (event: "attaching" | "attached", listener: () => void): any;
825
- }
826
-
827
- // @internal
828
- export interface IFluidDataStoreContextInternal extends IFluidDataStoreContext {
829
- // (undocumented)
830
- getAttachData(includeGCData: boolean, telemetryContext?: ITelemetryContext): {
831
- attachSummary: ISummaryTreeWithStats;
832
- type: string;
833
- };
834
- // (undocumented)
835
- getInitialSnapshotDetails(): Promise<ISnapshotDetails>;
836
- // (undocumented)
837
- isRoot(): Promise<boolean>;
838
- // (undocumented)
839
- realize(): Promise<IFluidDataStoreChannel>;
840
- }
841
-
842
- // @internal
843
- export interface IFluidDataStoreContextProps {
844
- // (undocumented)
845
- readonly createSummarizerNodeFn: CreateChildSummarizerNodeFn;
846
- // (undocumented)
847
- readonly id: string;
848
- // (undocumented)
849
- readonly loadingGroupId?: string;
850
- // (undocumented)
851
- readonly parentContext: IFluidParentContext;
852
- // (undocumented)
853
- readonly pkg?: Readonly<string[]>;
854
- // (undocumented)
855
- readonly scope: FluidObject_2;
856
- // (undocumented)
857
- readonly storage: IDocumentStorageService;
858
- }
859
-
860
493
  // @alpha
861
494
  export interface IGCMetadata {
862
495
  readonly gcFeature?: GCVersion;
@@ -867,25 +500,10 @@ export interface IGCMetadata {
867
500
  readonly tombstoneTimeoutMs?: number;
868
501
  }
869
502
 
870
- // @internal
871
- export interface IGCNodeUpdatedProps {
872
- headerData?: RuntimeHeaderData;
873
- node: {
874
- type: (typeof GCNodeType)["DataStore" | "Blob"];
875
- path: string;
876
- };
877
- packagePath?: readonly string[];
878
- reason: "Loaded" | "Changed";
879
- request?: IRequest_2;
880
- timestampMs?: number;
881
- }
882
-
883
503
  // @alpha (undocumented)
884
504
  export interface IGCRuntimeOptions {
885
505
  [key: string]: any;
886
- disableGC?: boolean;
887
506
  enableGCSweep?: true;
888
- gcAllowed?: boolean;
889
507
  runFullGC?: boolean;
890
508
  sessionExpiryTimeoutMs?: number;
891
509
  sweepGracePeriodMs?: number;
@@ -907,7 +525,6 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
907
525
 
908
526
  // @alpha
909
527
  export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
910
- readonly forcedFullTree: boolean;
911
528
  readonly generateDuration: number;
912
529
  // (undocumented)
913
530
  readonly stage: "generate";
@@ -915,24 +532,6 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
915
532
  readonly summaryTree: ISummaryTree;
916
533
  }
917
534
 
918
- // @internal
919
- export interface ILocalDetachedFluidDataStoreContextProps extends ILocalFluidDataStoreContextProps {
920
- // (undocumented)
921
- readonly channelToDataStoreFn: (channel: IFluidDataStoreChannel) => IDataStore;
922
- }
923
-
924
- // @internal
925
- export interface ILocalFluidDataStoreContextProps extends IFluidDataStoreContextProps {
926
- // @deprecated (undocumented)
927
- readonly createProps?: any;
928
- // (undocumented)
929
- readonly makeLocallyVisibleFn: () => void;
930
- // (undocumented)
931
- readonly pkg: Readonly<string[]> | undefined;
932
- // (undocumented)
933
- readonly snapshotTree: ISnapshotTree | undefined;
934
- }
935
-
936
535
  // @alpha
937
536
  export interface IMarkPhaseStats {
938
537
  attachmentBlobCount: number;
@@ -947,7 +546,7 @@ export interface IMarkPhaseStats {
947
546
  }
948
547
 
949
548
  // @alpha (undocumented)
950
- export interface INackSummaryResult extends IRetriableFailureResult {
549
+ export interface INackSummaryResult {
951
550
  // (undocumented)
952
551
  readonly ackNackDuration: number;
953
552
  // (undocumented)
@@ -972,7 +571,7 @@ export interface IRefreshSummaryAckOptions {
972
571
  }
973
572
 
974
573
  // @alpha
975
- export interface IRetriableFailureResult {
574
+ export interface IRetriableFailureError extends Error {
976
575
  // (undocumented)
977
576
  readonly retryAfterSeconds?: number;
978
577
  }
@@ -984,21 +583,6 @@ export interface ISerializedElection {
984
583
  readonly electionSequenceNumber: number;
985
584
  }
986
585
 
987
- // @internal (undocumented)
988
- export interface ISnapshotDetails {
989
- // (undocumented)
990
- isRootDataStore: boolean;
991
- // (undocumented)
992
- pkg: readonly string[];
993
- // (undocumented)
994
- sequenceNumber?: number;
995
- // (undocumented)
996
- snapshot?: ISnapshotTree;
997
- }
998
-
999
- // @internal @deprecated (undocumented)
1000
- export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
1001
-
1002
586
  // @alpha
1003
587
  export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
1004
588
  readonly clientSequenceNumber: number;
@@ -1030,8 +614,6 @@ export interface ISummarizeEventProps {
1030
614
  // @alpha
1031
615
  export interface ISummarizeOptions {
1032
616
  readonly fullTree?: boolean;
1033
- // @deprecated
1034
- readonly refreshLatestAck?: boolean;
1035
617
  }
1036
618
 
1037
619
  // @alpha (undocumented)
@@ -1068,6 +650,8 @@ export interface ISummarizerInternalsProvider {
1068
650
 
1069
651
  // @alpha (undocumented)
1070
652
  export interface ISummarizerRuntime extends IConnectableRuntime {
653
+ // (undocumented)
654
+ readonly baseLogger: ITelemetryBaseLogger;
1071
655
  // (undocumented)
1072
656
  closeFn(): void;
1073
657
  // (undocumented)
@@ -1075,22 +659,12 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
1075
659
  // (undocumented)
1076
660
  disposeFn(): void;
1077
661
  // (undocumented)
1078
- readonly logger: ITelemetryLoggerExt;
1079
- // (undocumented)
1080
662
  off(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): this;
1081
663
  // (undocumented)
1082
664
  on(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): this;
1083
665
  readonly summarizerClientId: string | undefined;
1084
666
  }
1085
667
 
1086
- // @internal (undocumented)
1087
- export interface ISummarizingWarning extends ContainerWarning {
1088
- // (undocumented)
1089
- readonly errorType: "summarizingError";
1090
- // (undocumented)
1091
- readonly logged: boolean;
1092
- }
1093
-
1094
668
  // @alpha
1095
669
  export interface ISummary {
1096
670
  // (undocumented)
@@ -1200,31 +774,6 @@ export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "
1200
774
  readonly uploadDuration: number;
1201
775
  }
1202
776
 
1203
- // @internal
1204
- export class LocalFluidDataStoreContext extends LocalFluidDataStoreContextBase {
1205
- constructor(props: ILocalFluidDataStoreContextProps);
1206
- }
1207
-
1208
- // @internal
1209
- export class LocalFluidDataStoreContextBase extends FluidDataStoreContext {
1210
- constructor(props: ILocalFluidDataStoreContextProps);
1211
- // @deprecated (undocumented)
1212
- readonly createProps?: any;
1213
- delete(): void;
1214
- // (undocumented)
1215
- getAttachData(includeGCData: boolean, telemetryContext?: ITelemetryContext): {
1216
- attachSummary: ISummaryTreeWithStats;
1217
- type: string;
1218
- };
1219
- // (undocumented)
1220
- getInitialSnapshotDetails(): Promise<ISnapshotDetails>;
1221
- // (undocumented)
1222
- setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
1223
- }
1224
-
1225
- // @internal
1226
- export const neverCancelledSummaryToken: ISummaryCancellationToken;
1227
-
1228
777
  // @alpha @deprecated (undocumented)
1229
778
  export type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
1230
779
 
@@ -1237,31 +786,8 @@ export type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck |
1237
786
  // @alpha @deprecated
1238
787
  export type ReadFluidDataStoreAttributes = IFluidDataStoreAttributes0 | IFluidDataStoreAttributes1 | IFluidDataStoreAttributes2;
1239
788
 
1240
- // @internal
1241
- export interface RecentlyAddedContainerRuntimeMessageDetails {
1242
- compatDetails: IContainerRuntimeMessageCompatDetails;
1243
- }
1244
-
1245
- // @internal
1246
- export interface RuntimeHeaderData {
1247
- // (undocumented)
1248
- allowInactive?: boolean;
1249
- // (undocumented)
1250
- allowTombstone?: boolean;
1251
- // (undocumented)
1252
- viaHandle?: boolean;
1253
- // (undocumented)
1254
- wait?: boolean;
1255
- }
1256
-
1257
- // @internal
1258
- export enum RuntimeHeaders {
1259
- viaHandle = "viaHandle",
1260
- wait = "wait"
1261
- }
1262
-
1263
789
  // @alpha
1264
- export interface SubmitSummaryFailureData extends IRetriableFailureResult {
790
+ export interface SubmitSummaryFailureData {
1265
791
  // (undocumented)
1266
792
  stage: SummaryStage;
1267
793
  }
@@ -1273,7 +799,7 @@ export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeRes
1273
799
  export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
1274
800
  constructor(
1275
801
  runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration,
1276
- internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext_2, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);
802
+ internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);
1277
803
  // (undocumented)
1278
804
  close(): void;
1279
805
  dispose(): void;
@@ -1301,7 +827,7 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
1301
827
  success: false;
1302
828
  data: TFailure | undefined;
1303
829
  message: string;
1304
- error: any;
830
+ error: IRetriableFailureError;
1305
831
  };
1306
832
 
1307
833
  // @alpha (undocumented)
@@ -1361,15 +887,6 @@ export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
1361
887
  // @alpha
1362
888
  export const TombstoneResponseHeaderKey = "isTombstoned";
1363
889
 
1364
- // @internal
1365
- export interface UnknownContainerRuntimeMessage extends Partial<RecentlyAddedContainerRuntimeMessageDetails> {
1366
- contents: unknown;
1367
- type: "__unknown_container_message_type__never_use_as_value__";
1368
- }
1369
-
1370
- // @internal
1371
- export function unpackRuntimeMessage(message: ISequencedDocumentMessage): boolean;
1372
-
1373
890
  // (No @packageDocumentation comment for this package)
1374
891
 
1375
892
  ```