@fluidframework/tree 2.4.0-297027 → 2.4.0-299374

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 (559) hide show
  1. package/.dependency-cruiser-known-violations.json +0 -14
  2. package/.vscode/settings.json +9 -1
  3. package/api-report/tree.alpha.api.md +178 -21
  4. package/api-report/tree.beta.api.md +46 -21
  5. package/api-report/tree.legacy.alpha.api.md +46 -21
  6. package/api-report/tree.legacy.public.api.md +46 -21
  7. package/api-report/tree.public.api.md +46 -21
  8. package/dist/alpha.d.ts +29 -1
  9. package/dist/beta.d.ts +2 -0
  10. package/dist/codec/codec.d.ts +4 -4
  11. package/dist/codec/codec.js.map +1 -1
  12. package/dist/codec/noopValidator.d.ts +1 -1
  13. package/dist/codec/noopValidator.js +1 -1
  14. package/dist/codec/noopValidator.js.map +1 -1
  15. package/dist/core/change-family/changeFamily.d.ts +2 -2
  16. package/dist/core/change-family/changeFamily.d.ts.map +1 -1
  17. package/dist/core/change-family/changeFamily.js.map +1 -1
  18. package/dist/core/change-family/editBuilder.d.ts +3 -2
  19. package/dist/core/change-family/editBuilder.d.ts.map +1 -1
  20. package/dist/core/change-family/editBuilder.js.map +1 -1
  21. package/dist/core/rebase/changeRebaser.d.ts +2 -1
  22. package/dist/core/rebase/changeRebaser.d.ts.map +1 -1
  23. package/dist/core/rebase/changeRebaser.js.map +1 -1
  24. package/dist/core/rebase/utils.js +1 -1
  25. package/dist/core/rebase/utils.js.map +1 -1
  26. package/dist/core/tree/anchorSet.d.ts +159 -2
  27. package/dist/core/tree/anchorSet.d.ts.map +1 -1
  28. package/dist/core/tree/anchorSet.js +54 -12
  29. package/dist/core/tree/anchorSet.js.map +1 -1
  30. package/dist/external-utilities/typeboxValidator.d.ts +1 -1
  31. package/dist/external-utilities/typeboxValidator.js +1 -1
  32. package/dist/external-utilities/typeboxValidator.js.map +1 -1
  33. package/dist/feature-libraries/default-schema/defaultEditBuilder.d.ts +4 -3
  34. package/dist/feature-libraries/default-schema/defaultEditBuilder.d.ts.map +1 -1
  35. package/dist/feature-libraries/default-schema/defaultEditBuilder.js +41 -30
  36. package/dist/feature-libraries/default-schema/defaultEditBuilder.js.map +1 -1
  37. package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts +4 -6
  38. package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts.map +1 -1
  39. package/dist/feature-libraries/default-schema/defaultFieldKinds.js.map +1 -1
  40. package/dist/feature-libraries/flex-tree/lazyField.d.ts +4 -0
  41. package/dist/feature-libraries/flex-tree/lazyField.d.ts.map +1 -1
  42. package/dist/feature-libraries/flex-tree/lazyField.js +38 -6
  43. package/dist/feature-libraries/flex-tree/lazyField.js.map +1 -1
  44. package/dist/feature-libraries/index.d.ts +0 -1
  45. package/dist/feature-libraries/index.d.ts.map +1 -1
  46. package/dist/feature-libraries/index.js +46 -49
  47. package/dist/feature-libraries/index.js.map +1 -1
  48. package/dist/feature-libraries/mitigatedChangeFamily.d.ts.map +1 -1
  49. package/dist/feature-libraries/mitigatedChangeFamily.js +4 -4
  50. package/dist/feature-libraries/mitigatedChangeFamily.js.map +1 -1
  51. package/dist/feature-libraries/modular-schema/fieldChangeHandler.d.ts +1 -1
  52. package/dist/feature-libraries/modular-schema/fieldChangeHandler.d.ts.map +1 -1
  53. package/dist/feature-libraries/modular-schema/fieldChangeHandler.js.map +1 -1
  54. package/dist/feature-libraries/modular-schema/modularChangeFamily.d.ts +12 -8
  55. package/dist/feature-libraries/modular-schema/modularChangeFamily.d.ts.map +1 -1
  56. package/dist/feature-libraries/modular-schema/modularChangeFamily.js +179 -60
  57. package/dist/feature-libraries/modular-schema/modularChangeFamily.js.map +1 -1
  58. package/dist/feature-libraries/optional-field/optionalField.d.ts +10 -9
  59. package/dist/feature-libraries/optional-field/optionalField.d.ts.map +1 -1
  60. package/dist/feature-libraries/optional-field/optionalField.js +9 -7
  61. package/dist/feature-libraries/optional-field/optionalField.js.map +1 -1
  62. package/dist/feature-libraries/schema-index/schemaSummarizer.d.ts +3 -10
  63. package/dist/feature-libraries/schema-index/schemaSummarizer.d.ts.map +1 -1
  64. package/dist/feature-libraries/schema-index/schemaSummarizer.js +1 -8
  65. package/dist/feature-libraries/schema-index/schemaSummarizer.js.map +1 -1
  66. package/dist/feature-libraries/sequence-field/compose.d.ts.map +1 -1
  67. package/dist/feature-libraries/sequence-field/compose.js +32 -20
  68. package/dist/feature-libraries/sequence-field/compose.js.map +1 -1
  69. package/dist/feature-libraries/sequence-field/invert.d.ts +6 -1
  70. package/dist/feature-libraries/sequence-field/invert.d.ts.map +1 -1
  71. package/dist/feature-libraries/sequence-field/invert.js +25 -9
  72. package/dist/feature-libraries/sequence-field/invert.js.map +1 -1
  73. package/dist/feature-libraries/sequence-field/sequenceFieldEditor.d.ts +17 -16
  74. package/dist/feature-libraries/sequence-field/sequenceFieldEditor.d.ts.map +1 -1
  75. package/dist/feature-libraries/sequence-field/sequenceFieldEditor.js +19 -11
  76. package/dist/feature-libraries/sequence-field/sequenceFieldEditor.js.map +1 -1
  77. package/dist/feature-libraries/treeCompressionUtils.d.ts +1 -1
  78. package/dist/feature-libraries/treeCompressionUtils.js +1 -1
  79. package/dist/feature-libraries/treeCompressionUtils.js.map +1 -1
  80. package/dist/index.d.ts +6 -5
  81. package/dist/index.d.ts.map +1 -1
  82. package/dist/index.js +4 -2
  83. package/dist/index.js.map +1 -1
  84. package/dist/internalTypes.d.ts +2 -2
  85. package/dist/internalTypes.d.ts.map +1 -1
  86. package/dist/internalTypes.js.map +1 -1
  87. package/dist/legacy.d.ts +2 -0
  88. package/dist/packageVersion.d.ts +1 -1
  89. package/dist/packageVersion.js +1 -1
  90. package/dist/packageVersion.js.map +1 -1
  91. package/dist/public.d.ts +2 -0
  92. package/dist/shared-tree/index.d.ts +2 -1
  93. package/dist/shared-tree/index.d.ts.map +1 -1
  94. package/dist/shared-tree/index.js +5 -1
  95. package/dist/shared-tree/index.js.map +1 -1
  96. package/dist/shared-tree/schematizingTreeView.d.ts.map +1 -1
  97. package/dist/shared-tree/schematizingTreeView.js +1 -14
  98. package/dist/shared-tree/schematizingTreeView.js.map +1 -1
  99. package/dist/shared-tree/sharedTree.d.ts +24 -9
  100. package/dist/shared-tree/sharedTree.d.ts.map +1 -1
  101. package/dist/shared-tree/sharedTree.js +21 -9
  102. package/dist/shared-tree/sharedTree.js.map +1 -1
  103. package/dist/shared-tree/sharedTreeChangeFamily.d.ts +2 -2
  104. package/dist/shared-tree/sharedTreeChangeFamily.d.ts.map +1 -1
  105. package/dist/shared-tree/sharedTreeChangeFamily.js +4 -4
  106. package/dist/shared-tree/sharedTreeChangeFamily.js.map +1 -1
  107. package/dist/shared-tree/sharedTreeEditBuilder.d.ts +2 -2
  108. package/dist/shared-tree/sharedTreeEditBuilder.d.ts.map +1 -1
  109. package/dist/shared-tree/sharedTreeEditBuilder.js +15 -11
  110. package/dist/shared-tree/sharedTreeEditBuilder.js.map +1 -1
  111. package/dist/shared-tree/treeApi.d.ts +6 -6
  112. package/dist/shared-tree/treeApi.d.ts.map +1 -1
  113. package/dist/shared-tree/treeApi.js.map +1 -1
  114. package/dist/shared-tree/treeCheckout.d.ts.map +1 -1
  115. package/dist/shared-tree/treeCheckout.js +4 -3
  116. package/dist/shared-tree/treeCheckout.js.map +1 -1
  117. package/dist/shared-tree-core/branch.d.ts +2 -3
  118. package/dist/shared-tree-core/branch.d.ts.map +1 -1
  119. package/dist/shared-tree-core/branch.js +10 -11
  120. package/dist/shared-tree-core/branch.js.map +1 -1
  121. package/dist/shared-tree-core/defaultResubmitMachine.d.ts +5 -5
  122. package/dist/shared-tree-core/defaultResubmitMachine.d.ts.map +1 -1
  123. package/dist/shared-tree-core/defaultResubmitMachine.js +4 -4
  124. package/dist/shared-tree-core/defaultResubmitMachine.js.map +1 -1
  125. package/dist/shared-tree-core/editManager.d.ts.map +1 -1
  126. package/dist/shared-tree-core/editManager.js +1 -1
  127. package/dist/shared-tree-core/editManager.js.map +1 -1
  128. package/dist/shared-tree-core/sharedTreeCore.d.ts.map +1 -1
  129. package/dist/shared-tree-core/sharedTreeCore.js +2 -2
  130. package/dist/shared-tree-core/sharedTreeCore.js.map +1 -1
  131. package/dist/simple-tree/api/conciseTree.d.ts +29 -0
  132. package/dist/simple-tree/api/conciseTree.d.ts.map +1 -0
  133. package/dist/simple-tree/api/conciseTree.js +25 -0
  134. package/dist/simple-tree/api/conciseTree.js.map +1 -0
  135. package/dist/simple-tree/api/customTree.d.ts +44 -0
  136. package/dist/simple-tree/api/customTree.d.ts.map +1 -0
  137. package/dist/simple-tree/api/customTree.js +63 -0
  138. package/dist/simple-tree/api/customTree.js.map +1 -0
  139. package/dist/simple-tree/api/index.d.ts +7 -2
  140. package/dist/simple-tree/api/index.d.ts.map +1 -1
  141. package/dist/simple-tree/api/index.js +5 -1
  142. package/dist/simple-tree/api/index.js.map +1 -1
  143. package/dist/simple-tree/api/schemaCreationUtilities.d.ts +41 -26
  144. package/dist/simple-tree/api/schemaCreationUtilities.d.ts.map +1 -1
  145. package/dist/simple-tree/api/schemaCreationUtilities.js +43 -15
  146. package/dist/simple-tree/api/schemaCreationUtilities.js.map +1 -1
  147. package/dist/simple-tree/api/schemaFactory.d.ts +1 -2
  148. package/dist/simple-tree/api/schemaFactory.d.ts.map +1 -1
  149. package/dist/simple-tree/api/schemaFactory.js +8 -8
  150. package/dist/simple-tree/api/schemaFactory.js.map +1 -1
  151. package/dist/simple-tree/api/schemaFactoryRecursive.d.ts +1 -2
  152. package/dist/simple-tree/api/schemaFactoryRecursive.d.ts.map +1 -1
  153. package/dist/simple-tree/api/schemaFactoryRecursive.js.map +1 -1
  154. package/dist/simple-tree/api/storedSchema.d.ts +78 -0
  155. package/dist/simple-tree/api/storedSchema.d.ts.map +1 -0
  156. package/dist/simple-tree/api/storedSchema.js +107 -0
  157. package/dist/simple-tree/api/storedSchema.js.map +1 -0
  158. package/dist/simple-tree/api/testRecursiveDomain.d.ts +10 -10
  159. package/dist/simple-tree/api/tree.d.ts +12 -3
  160. package/dist/simple-tree/api/tree.d.ts.map +1 -1
  161. package/dist/simple-tree/api/tree.js.map +1 -1
  162. package/dist/simple-tree/api/treeNodeApi.d.ts.map +1 -1
  163. package/dist/simple-tree/api/treeNodeApi.js +5 -5
  164. package/dist/simple-tree/api/treeNodeApi.js.map +1 -1
  165. package/dist/simple-tree/{typesUnsafe.d.ts → api/typesUnsafe.d.ts} +58 -10
  166. package/dist/simple-tree/api/typesUnsafe.d.ts.map +1 -0
  167. package/dist/simple-tree/api/typesUnsafe.js.map +1 -0
  168. package/dist/simple-tree/api/verboseTree.d.ts +6 -20
  169. package/dist/simple-tree/api/verboseTree.d.ts.map +1 -1
  170. package/dist/simple-tree/api/verboseTree.js +10 -48
  171. package/dist/simple-tree/api/verboseTree.js.map +1 -1
  172. package/dist/simple-tree/arrayNode.d.ts +14 -3
  173. package/dist/simple-tree/arrayNode.d.ts.map +1 -1
  174. package/dist/simple-tree/arrayNode.js +1 -2
  175. package/dist/simple-tree/arrayNode.js.map +1 -1
  176. package/dist/simple-tree/core/index.d.ts +1 -1
  177. package/dist/simple-tree/core/index.d.ts.map +1 -1
  178. package/dist/simple-tree/core/index.js +2 -1
  179. package/dist/simple-tree/core/index.js.map +1 -1
  180. package/dist/simple-tree/core/treeNodeKernel.d.ts +9 -0
  181. package/dist/simple-tree/core/treeNodeKernel.d.ts.map +1 -1
  182. package/dist/simple-tree/core/treeNodeKernel.js +14 -1
  183. package/dist/simple-tree/core/treeNodeKernel.js.map +1 -1
  184. package/dist/simple-tree/core/treeNodeSchema.d.ts +6 -5
  185. package/dist/simple-tree/core/treeNodeSchema.d.ts.map +1 -1
  186. package/dist/simple-tree/core/treeNodeSchema.js.map +1 -1
  187. package/dist/simple-tree/core/unhydratedFlexTree.d.ts.map +1 -1
  188. package/dist/simple-tree/core/unhydratedFlexTree.js +3 -1
  189. package/dist/simple-tree/core/unhydratedFlexTree.js.map +1 -1
  190. package/dist/simple-tree/core/withType.d.ts +3 -1
  191. package/dist/simple-tree/core/withType.d.ts.map +1 -1
  192. package/dist/simple-tree/core/withType.js.map +1 -1
  193. package/dist/simple-tree/flexList.d.ts.map +1 -0
  194. package/dist/simple-tree/flexList.js.map +1 -0
  195. package/dist/simple-tree/index.d.ts +6 -7
  196. package/dist/simple-tree/index.d.ts.map +1 -1
  197. package/dist/simple-tree/index.js +5 -3
  198. package/dist/simple-tree/index.js.map +1 -1
  199. package/dist/simple-tree/mapNode.d.ts.map +1 -1
  200. package/dist/simple-tree/mapNode.js +2 -3
  201. package/dist/simple-tree/mapNode.js.map +1 -1
  202. package/dist/simple-tree/objectNode.d.ts.map +1 -1
  203. package/dist/simple-tree/objectNode.js +3 -4
  204. package/dist/simple-tree/objectNode.js.map +1 -1
  205. package/dist/simple-tree/schemaTypes.d.ts +60 -7
  206. package/dist/simple-tree/schemaTypes.d.ts.map +1 -1
  207. package/dist/simple-tree/schemaTypes.js +11 -6
  208. package/dist/simple-tree/schemaTypes.js.map +1 -1
  209. package/dist/simple-tree/toFlexSchema.d.ts.map +1 -1
  210. package/dist/simple-tree/toFlexSchema.js +13 -15
  211. package/dist/simple-tree/toFlexSchema.js.map +1 -1
  212. package/dist/simple-tree/toMapTree.d.ts +4 -2
  213. package/dist/simple-tree/toMapTree.d.ts.map +1 -1
  214. package/dist/simple-tree/toMapTree.js +3 -3
  215. package/dist/simple-tree/toMapTree.js.map +1 -1
  216. package/dist/simple-tree/treeNodeValid.d.ts.map +1 -1
  217. package/dist/simple-tree/treeNodeValid.js +2 -1
  218. package/dist/simple-tree/treeNodeValid.js.map +1 -1
  219. package/dist/treeFactory.d.ts +1 -0
  220. package/dist/treeFactory.d.ts.map +1 -1
  221. package/dist/treeFactory.js +1 -0
  222. package/dist/treeFactory.js.map +1 -1
  223. package/dist/util/utils.d.ts +10 -8
  224. package/dist/util/utils.d.ts.map +1 -1
  225. package/dist/util/utils.js.map +1 -1
  226. package/docs/main/detached-trees.md +8 -8
  227. package/lib/alpha.d.ts +29 -1
  228. package/lib/beta.d.ts +2 -0
  229. package/lib/codec/codec.d.ts +4 -4
  230. package/lib/codec/codec.js.map +1 -1
  231. package/lib/codec/noopValidator.d.ts +1 -1
  232. package/lib/codec/noopValidator.js +1 -1
  233. package/lib/codec/noopValidator.js.map +1 -1
  234. package/lib/core/change-family/changeFamily.d.ts +2 -2
  235. package/lib/core/change-family/changeFamily.d.ts.map +1 -1
  236. package/lib/core/change-family/changeFamily.js.map +1 -1
  237. package/lib/core/change-family/editBuilder.d.ts +3 -2
  238. package/lib/core/change-family/editBuilder.d.ts.map +1 -1
  239. package/lib/core/change-family/editBuilder.js.map +1 -1
  240. package/lib/core/rebase/changeRebaser.d.ts +2 -1
  241. package/lib/core/rebase/changeRebaser.d.ts.map +1 -1
  242. package/lib/core/rebase/changeRebaser.js.map +1 -1
  243. package/lib/core/rebase/utils.js +1 -1
  244. package/lib/core/rebase/utils.js.map +1 -1
  245. package/lib/core/tree/anchorSet.d.ts +159 -2
  246. package/lib/core/tree/anchorSet.d.ts.map +1 -1
  247. package/lib/core/tree/anchorSet.js +54 -12
  248. package/lib/core/tree/anchorSet.js.map +1 -1
  249. package/lib/external-utilities/typeboxValidator.d.ts +1 -1
  250. package/lib/external-utilities/typeboxValidator.js +1 -1
  251. package/lib/external-utilities/typeboxValidator.js.map +1 -1
  252. package/lib/feature-libraries/default-schema/defaultEditBuilder.d.ts +4 -3
  253. package/lib/feature-libraries/default-schema/defaultEditBuilder.d.ts.map +1 -1
  254. package/lib/feature-libraries/default-schema/defaultEditBuilder.js +41 -30
  255. package/lib/feature-libraries/default-schema/defaultEditBuilder.js.map +1 -1
  256. package/lib/feature-libraries/default-schema/defaultFieldKinds.d.ts +4 -6
  257. package/lib/feature-libraries/default-schema/defaultFieldKinds.d.ts.map +1 -1
  258. package/lib/feature-libraries/default-schema/defaultFieldKinds.js.map +1 -1
  259. package/lib/feature-libraries/flex-tree/lazyField.d.ts +4 -0
  260. package/lib/feature-libraries/flex-tree/lazyField.d.ts.map +1 -1
  261. package/lib/feature-libraries/flex-tree/lazyField.js +36 -5
  262. package/lib/feature-libraries/flex-tree/lazyField.js.map +1 -1
  263. package/lib/feature-libraries/index.d.ts +0 -1
  264. package/lib/feature-libraries/index.d.ts.map +1 -1
  265. package/lib/feature-libraries/index.js +0 -1
  266. package/lib/feature-libraries/index.js.map +1 -1
  267. package/lib/feature-libraries/mitigatedChangeFamily.d.ts.map +1 -1
  268. package/lib/feature-libraries/mitigatedChangeFamily.js +4 -4
  269. package/lib/feature-libraries/mitigatedChangeFamily.js.map +1 -1
  270. package/lib/feature-libraries/modular-schema/fieldChangeHandler.d.ts +1 -1
  271. package/lib/feature-libraries/modular-schema/fieldChangeHandler.d.ts.map +1 -1
  272. package/lib/feature-libraries/modular-schema/fieldChangeHandler.js.map +1 -1
  273. package/lib/feature-libraries/modular-schema/modularChangeFamily.d.ts +12 -8
  274. package/lib/feature-libraries/modular-schema/modularChangeFamily.d.ts.map +1 -1
  275. package/lib/feature-libraries/modular-schema/modularChangeFamily.js +180 -61
  276. package/lib/feature-libraries/modular-schema/modularChangeFamily.js.map +1 -1
  277. package/lib/feature-libraries/optional-field/optionalField.d.ts +10 -9
  278. package/lib/feature-libraries/optional-field/optionalField.d.ts.map +1 -1
  279. package/lib/feature-libraries/optional-field/optionalField.js +9 -7
  280. package/lib/feature-libraries/optional-field/optionalField.js.map +1 -1
  281. package/lib/feature-libraries/schema-index/schemaSummarizer.d.ts +3 -10
  282. package/lib/feature-libraries/schema-index/schemaSummarizer.d.ts.map +1 -1
  283. package/lib/feature-libraries/schema-index/schemaSummarizer.js +1 -8
  284. package/lib/feature-libraries/schema-index/schemaSummarizer.js.map +1 -1
  285. package/lib/feature-libraries/sequence-field/compose.d.ts.map +1 -1
  286. package/lib/feature-libraries/sequence-field/compose.js +32 -20
  287. package/lib/feature-libraries/sequence-field/compose.js.map +1 -1
  288. package/lib/feature-libraries/sequence-field/invert.d.ts +6 -1
  289. package/lib/feature-libraries/sequence-field/invert.d.ts.map +1 -1
  290. package/lib/feature-libraries/sequence-field/invert.js +25 -9
  291. package/lib/feature-libraries/sequence-field/invert.js.map +1 -1
  292. package/lib/feature-libraries/sequence-field/sequenceFieldEditor.d.ts +17 -16
  293. package/lib/feature-libraries/sequence-field/sequenceFieldEditor.d.ts.map +1 -1
  294. package/lib/feature-libraries/sequence-field/sequenceFieldEditor.js +19 -11
  295. package/lib/feature-libraries/sequence-field/sequenceFieldEditor.js.map +1 -1
  296. package/lib/feature-libraries/treeCompressionUtils.d.ts +1 -1
  297. package/lib/feature-libraries/treeCompressionUtils.js +1 -1
  298. package/lib/feature-libraries/treeCompressionUtils.js.map +1 -1
  299. package/lib/index.d.ts +6 -5
  300. package/lib/index.d.ts.map +1 -1
  301. package/lib/index.js +3 -3
  302. package/lib/index.js.map +1 -1
  303. package/lib/internalTypes.d.ts +2 -2
  304. package/lib/internalTypes.d.ts.map +1 -1
  305. package/lib/internalTypes.js.map +1 -1
  306. package/lib/legacy.d.ts +2 -0
  307. package/lib/packageVersion.d.ts +1 -1
  308. package/lib/packageVersion.js +1 -1
  309. package/lib/packageVersion.js.map +1 -1
  310. package/lib/public.d.ts +2 -0
  311. package/lib/shared-tree/index.d.ts +2 -1
  312. package/lib/shared-tree/index.d.ts.map +1 -1
  313. package/lib/shared-tree/index.js +2 -1
  314. package/lib/shared-tree/index.js.map +1 -1
  315. package/lib/shared-tree/schematizingTreeView.d.ts.map +1 -1
  316. package/lib/shared-tree/schematizingTreeView.js +2 -15
  317. package/lib/shared-tree/schematizingTreeView.js.map +1 -1
  318. package/lib/shared-tree/sharedTree.d.ts +24 -9
  319. package/lib/shared-tree/sharedTree.d.ts.map +1 -1
  320. package/lib/shared-tree/sharedTree.js +20 -9
  321. package/lib/shared-tree/sharedTree.js.map +1 -1
  322. package/lib/shared-tree/sharedTreeChangeFamily.d.ts +2 -2
  323. package/lib/shared-tree/sharedTreeChangeFamily.d.ts.map +1 -1
  324. package/lib/shared-tree/sharedTreeChangeFamily.js +4 -4
  325. package/lib/shared-tree/sharedTreeChangeFamily.js.map +1 -1
  326. package/lib/shared-tree/sharedTreeEditBuilder.d.ts +2 -2
  327. package/lib/shared-tree/sharedTreeEditBuilder.d.ts.map +1 -1
  328. package/lib/shared-tree/sharedTreeEditBuilder.js +15 -11
  329. package/lib/shared-tree/sharedTreeEditBuilder.js.map +1 -1
  330. package/lib/shared-tree/treeApi.d.ts +6 -6
  331. package/lib/shared-tree/treeApi.d.ts.map +1 -1
  332. package/lib/shared-tree/treeApi.js.map +1 -1
  333. package/lib/shared-tree/treeCheckout.d.ts.map +1 -1
  334. package/lib/shared-tree/treeCheckout.js +5 -4
  335. package/lib/shared-tree/treeCheckout.js.map +1 -1
  336. package/lib/shared-tree-core/branch.d.ts +2 -3
  337. package/lib/shared-tree-core/branch.d.ts.map +1 -1
  338. package/lib/shared-tree-core/branch.js +11 -12
  339. package/lib/shared-tree-core/branch.js.map +1 -1
  340. package/lib/shared-tree-core/defaultResubmitMachine.d.ts +5 -5
  341. package/lib/shared-tree-core/defaultResubmitMachine.d.ts.map +1 -1
  342. package/lib/shared-tree-core/defaultResubmitMachine.js +4 -4
  343. package/lib/shared-tree-core/defaultResubmitMachine.js.map +1 -1
  344. package/lib/shared-tree-core/editManager.d.ts.map +1 -1
  345. package/lib/shared-tree-core/editManager.js +2 -2
  346. package/lib/shared-tree-core/editManager.js.map +1 -1
  347. package/lib/shared-tree-core/sharedTreeCore.d.ts.map +1 -1
  348. package/lib/shared-tree-core/sharedTreeCore.js +2 -2
  349. package/lib/shared-tree-core/sharedTreeCore.js.map +1 -1
  350. package/lib/simple-tree/api/conciseTree.d.ts +29 -0
  351. package/lib/simple-tree/api/conciseTree.d.ts.map +1 -0
  352. package/lib/simple-tree/api/conciseTree.js +21 -0
  353. package/lib/simple-tree/api/conciseTree.js.map +1 -0
  354. package/lib/simple-tree/api/customTree.d.ts +44 -0
  355. package/lib/simple-tree/api/customTree.d.ts.map +1 -0
  356. package/lib/simple-tree/api/customTree.js +59 -0
  357. package/lib/simple-tree/api/customTree.js.map +1 -0
  358. package/lib/simple-tree/api/index.d.ts +7 -2
  359. package/lib/simple-tree/api/index.d.ts.map +1 -1
  360. package/lib/simple-tree/api/index.js +1 -0
  361. package/lib/simple-tree/api/index.js.map +1 -1
  362. package/lib/simple-tree/api/schemaCreationUtilities.d.ts +41 -26
  363. package/lib/simple-tree/api/schemaCreationUtilities.d.ts.map +1 -1
  364. package/lib/simple-tree/api/schemaCreationUtilities.js +43 -15
  365. package/lib/simple-tree/api/schemaCreationUtilities.js.map +1 -1
  366. package/lib/simple-tree/api/schemaFactory.d.ts +1 -2
  367. package/lib/simple-tree/api/schemaFactory.d.ts.map +1 -1
  368. package/lib/simple-tree/api/schemaFactory.js +1 -1
  369. package/lib/simple-tree/api/schemaFactory.js.map +1 -1
  370. package/lib/simple-tree/api/schemaFactoryRecursive.d.ts +1 -2
  371. package/lib/simple-tree/api/schemaFactoryRecursive.d.ts.map +1 -1
  372. package/lib/simple-tree/api/schemaFactoryRecursive.js.map +1 -1
  373. package/lib/simple-tree/api/storedSchema.d.ts +78 -0
  374. package/lib/simple-tree/api/storedSchema.d.ts.map +1 -0
  375. package/lib/simple-tree/api/storedSchema.js +101 -0
  376. package/lib/simple-tree/api/storedSchema.js.map +1 -0
  377. package/lib/simple-tree/api/testRecursiveDomain.d.ts +10 -10
  378. package/lib/simple-tree/api/tree.d.ts +12 -3
  379. package/lib/simple-tree/api/tree.d.ts.map +1 -1
  380. package/lib/simple-tree/api/tree.js.map +1 -1
  381. package/lib/simple-tree/api/treeNodeApi.d.ts.map +1 -1
  382. package/lib/simple-tree/api/treeNodeApi.js +3 -3
  383. package/lib/simple-tree/api/treeNodeApi.js.map +1 -1
  384. package/lib/simple-tree/{typesUnsafe.d.ts → api/typesUnsafe.d.ts} +58 -10
  385. package/lib/simple-tree/api/typesUnsafe.d.ts.map +1 -0
  386. package/lib/simple-tree/api/typesUnsafe.js.map +1 -0
  387. package/lib/simple-tree/api/verboseTree.d.ts +6 -20
  388. package/lib/simple-tree/api/verboseTree.d.ts.map +1 -1
  389. package/lib/simple-tree/api/verboseTree.js +11 -49
  390. package/lib/simple-tree/api/verboseTree.js.map +1 -1
  391. package/lib/simple-tree/arrayNode.d.ts +14 -3
  392. package/lib/simple-tree/arrayNode.d.ts.map +1 -1
  393. package/lib/simple-tree/arrayNode.js +1 -2
  394. package/lib/simple-tree/arrayNode.js.map +1 -1
  395. package/lib/simple-tree/core/index.d.ts +1 -1
  396. package/lib/simple-tree/core/index.d.ts.map +1 -1
  397. package/lib/simple-tree/core/index.js +1 -1
  398. package/lib/simple-tree/core/index.js.map +1 -1
  399. package/lib/simple-tree/core/treeNodeKernel.d.ts +9 -0
  400. package/lib/simple-tree/core/treeNodeKernel.d.ts.map +1 -1
  401. package/lib/simple-tree/core/treeNodeKernel.js +12 -0
  402. package/lib/simple-tree/core/treeNodeKernel.js.map +1 -1
  403. package/lib/simple-tree/core/treeNodeSchema.d.ts +6 -5
  404. package/lib/simple-tree/core/treeNodeSchema.d.ts.map +1 -1
  405. package/lib/simple-tree/core/treeNodeSchema.js.map +1 -1
  406. package/lib/simple-tree/core/unhydratedFlexTree.d.ts.map +1 -1
  407. package/lib/simple-tree/core/unhydratedFlexTree.js +3 -1
  408. package/lib/simple-tree/core/unhydratedFlexTree.js.map +1 -1
  409. package/lib/simple-tree/core/withType.d.ts +3 -1
  410. package/lib/simple-tree/core/withType.d.ts.map +1 -1
  411. package/lib/simple-tree/core/withType.js.map +1 -1
  412. package/lib/simple-tree/flexList.d.ts.map +1 -0
  413. package/lib/simple-tree/flexList.js.map +1 -0
  414. package/lib/simple-tree/index.d.ts +6 -7
  415. package/lib/simple-tree/index.d.ts.map +1 -1
  416. package/lib/simple-tree/index.js +3 -4
  417. package/lib/simple-tree/index.js.map +1 -1
  418. package/lib/simple-tree/mapNode.d.ts.map +1 -1
  419. package/lib/simple-tree/mapNode.js +1 -2
  420. package/lib/simple-tree/mapNode.js.map +1 -1
  421. package/lib/simple-tree/objectNode.d.ts.map +1 -1
  422. package/lib/simple-tree/objectNode.js +1 -2
  423. package/lib/simple-tree/objectNode.js.map +1 -1
  424. package/lib/simple-tree/schemaTypes.d.ts +60 -7
  425. package/lib/simple-tree/schemaTypes.d.ts.map +1 -1
  426. package/lib/simple-tree/schemaTypes.js +6 -1
  427. package/lib/simple-tree/schemaTypes.js.map +1 -1
  428. package/lib/simple-tree/toFlexSchema.d.ts.map +1 -1
  429. package/lib/simple-tree/toFlexSchema.js +1 -3
  430. package/lib/simple-tree/toFlexSchema.js.map +1 -1
  431. package/lib/simple-tree/toMapTree.d.ts +4 -2
  432. package/lib/simple-tree/toMapTree.d.ts.map +1 -1
  433. package/lib/simple-tree/toMapTree.js +3 -3
  434. package/lib/simple-tree/toMapTree.js.map +1 -1
  435. package/lib/simple-tree/treeNodeValid.d.ts.map +1 -1
  436. package/lib/simple-tree/treeNodeValid.js +2 -1
  437. package/lib/simple-tree/treeNodeValid.js.map +1 -1
  438. package/lib/treeFactory.d.ts +1 -0
  439. package/lib/treeFactory.d.ts.map +1 -1
  440. package/lib/treeFactory.js +1 -0
  441. package/lib/treeFactory.js.map +1 -1
  442. package/lib/util/utils.d.ts +10 -8
  443. package/lib/util/utils.d.ts.map +1 -1
  444. package/lib/util/utils.js.map +1 -1
  445. package/package.json +44 -27
  446. package/src/codec/codec.ts +4 -4
  447. package/src/codec/noopValidator.ts +1 -1
  448. package/src/core/change-family/changeFamily.ts +5 -2
  449. package/src/core/change-family/editBuilder.ts +3 -2
  450. package/src/core/rebase/changeRebaser.ts +6 -1
  451. package/src/core/rebase/utils.ts +1 -1
  452. package/src/core/tree/anchorSet.ts +63 -13
  453. package/src/external-utilities/typeboxValidator.ts +1 -1
  454. package/src/feature-libraries/default-schema/defaultEditBuilder.ts +92 -47
  455. package/src/feature-libraries/default-schema/defaultFieldKinds.ts +7 -7
  456. package/src/feature-libraries/flex-tree/lazyField.ts +44 -7
  457. package/src/feature-libraries/index.ts +0 -10
  458. package/src/feature-libraries/mitigatedChangeFamily.ts +11 -4
  459. package/src/feature-libraries/modular-schema/fieldChangeHandler.ts +1 -0
  460. package/src/feature-libraries/modular-schema/modularChangeFamily.ts +218 -175
  461. package/src/feature-libraries/optional-field/optionalField.ts +21 -17
  462. package/src/feature-libraries/schema-index/schemaSummarizer.ts +2 -10
  463. package/src/feature-libraries/sequence-field/compose.ts +67 -58
  464. package/src/feature-libraries/sequence-field/invert.ts +30 -6
  465. package/src/feature-libraries/sequence-field/sequenceFieldEditor.ts +65 -19
  466. package/src/feature-libraries/treeCompressionUtils.ts +1 -1
  467. package/src/index.ts +26 -6
  468. package/src/internalTypes.ts +4 -1
  469. package/src/packageVersion.ts +1 -1
  470. package/src/shared-tree/index.ts +5 -0
  471. package/src/shared-tree/schematizingTreeView.ts +7 -16
  472. package/src/shared-tree/sharedTree.ts +55 -23
  473. package/src/shared-tree/sharedTreeChangeFamily.ts +5 -1
  474. package/src/shared-tree/sharedTreeEditBuilder.ts +23 -12
  475. package/src/shared-tree/treeApi.ts +19 -9
  476. package/src/shared-tree/treeCheckout.ts +7 -6
  477. package/src/shared-tree-core/branch.ts +11 -14
  478. package/src/shared-tree-core/defaultResubmitMachine.ts +4 -4
  479. package/src/shared-tree-core/editManager.ts +2 -1
  480. package/src/shared-tree-core/sharedTreeCore.ts +4 -2
  481. package/src/simple-tree/api/conciseTree.ts +58 -0
  482. package/src/simple-tree/api/customTree.ts +119 -0
  483. package/src/simple-tree/api/index.ts +39 -1
  484. package/src/simple-tree/api/schemaCreationUtilities.ts +55 -36
  485. package/src/simple-tree/api/schemaFactory.ts +4 -6
  486. package/src/simple-tree/api/schemaFactoryRecursive.ts +1 -2
  487. package/src/simple-tree/api/storedSchema.ts +126 -0
  488. package/src/simple-tree/api/tree.ts +24 -2
  489. package/src/simple-tree/api/treeNodeApi.ts +3 -8
  490. package/src/simple-tree/{typesUnsafe.ts → api/typesUnsafe.ts} +95 -21
  491. package/src/simple-tree/api/verboseTree.ts +21 -76
  492. package/src/simple-tree/arrayNode.ts +35 -15
  493. package/src/simple-tree/core/index.ts +1 -0
  494. package/src/simple-tree/core/treeNodeKernel.ts +13 -0
  495. package/src/simple-tree/core/treeNodeSchema.ts +7 -5
  496. package/src/simple-tree/core/unhydratedFlexTree.ts +6 -1
  497. package/src/simple-tree/core/withType.ts +10 -1
  498. package/src/simple-tree/index.ts +41 -21
  499. package/src/simple-tree/mapNode.ts +1 -1
  500. package/src/simple-tree/objectNode.ts +1 -1
  501. package/src/simple-tree/schemaTypes.ts +70 -11
  502. package/src/simple-tree/toFlexSchema.ts +1 -3
  503. package/src/simple-tree/toMapTree.ts +7 -4
  504. package/src/simple-tree/treeNodeValid.ts +2 -1
  505. package/src/treeFactory.ts +1 -0
  506. package/src/util/utils.ts +10 -8
  507. package/dist/feature-libraries/flex-tree/unboxed.d.ts +0 -12
  508. package/dist/feature-libraries/flex-tree/unboxed.d.ts.map +0 -1
  509. package/dist/feature-libraries/flex-tree/unboxed.js +0 -20
  510. package/dist/feature-libraries/flex-tree/unboxed.js.map +0 -1
  511. package/dist/feature-libraries/typed-schema/flexList.d.ts.map +0 -1
  512. package/dist/feature-libraries/typed-schema/flexList.js.map +0 -1
  513. package/dist/feature-libraries/typed-schema/index.d.ts +0 -7
  514. package/dist/feature-libraries/typed-schema/index.d.ts.map +0 -1
  515. package/dist/feature-libraries/typed-schema/index.js +0 -12
  516. package/dist/feature-libraries/typed-schema/index.js.map +0 -1
  517. package/dist/feature-libraries/typed-schema/typedTreeSchema.d.ts +0 -14
  518. package/dist/feature-libraries/typed-schema/typedTreeSchema.d.ts.map +0 -1
  519. package/dist/feature-libraries/typed-schema/typedTreeSchema.js +0 -7
  520. package/dist/feature-libraries/typed-schema/typedTreeSchema.js.map +0 -1
  521. package/dist/simple-tree/proxyBinding.d.ts +0 -15
  522. package/dist/simple-tree/proxyBinding.d.ts.map +0 -1
  523. package/dist/simple-tree/proxyBinding.js +0 -22
  524. package/dist/simple-tree/proxyBinding.js.map +0 -1
  525. package/dist/simple-tree/typesUnsafe.d.ts.map +0 -1
  526. package/dist/simple-tree/typesUnsafe.js.map +0 -1
  527. package/lib/feature-libraries/flex-tree/unboxed.d.ts +0 -12
  528. package/lib/feature-libraries/flex-tree/unboxed.d.ts.map +0 -1
  529. package/lib/feature-libraries/flex-tree/unboxed.js +0 -16
  530. package/lib/feature-libraries/flex-tree/unboxed.js.map +0 -1
  531. package/lib/feature-libraries/typed-schema/flexList.d.ts.map +0 -1
  532. package/lib/feature-libraries/typed-schema/flexList.js.map +0 -1
  533. package/lib/feature-libraries/typed-schema/index.d.ts +0 -7
  534. package/lib/feature-libraries/typed-schema/index.d.ts.map +0 -1
  535. package/lib/feature-libraries/typed-schema/index.js +0 -6
  536. package/lib/feature-libraries/typed-schema/index.js.map +0 -1
  537. package/lib/feature-libraries/typed-schema/typedTreeSchema.d.ts +0 -14
  538. package/lib/feature-libraries/typed-schema/typedTreeSchema.d.ts.map +0 -1
  539. package/lib/feature-libraries/typed-schema/typedTreeSchema.js +0 -6
  540. package/lib/feature-libraries/typed-schema/typedTreeSchema.js.map +0 -1
  541. package/lib/simple-tree/proxyBinding.d.ts +0 -15
  542. package/lib/simple-tree/proxyBinding.d.ts.map +0 -1
  543. package/lib/simple-tree/proxyBinding.js +0 -18
  544. package/lib/simple-tree/proxyBinding.js.map +0 -1
  545. package/lib/simple-tree/typesUnsafe.d.ts.map +0 -1
  546. package/lib/simple-tree/typesUnsafe.js.map +0 -1
  547. package/src/feature-libraries/flex-tree/unboxed.ts +0 -24
  548. package/src/feature-libraries/typed-schema/README.md +0 -6
  549. package/src/feature-libraries/typed-schema/index.ts +0 -16
  550. package/src/feature-libraries/typed-schema/typedTreeSchema.ts +0 -14
  551. package/src/simple-tree/proxyBinding.ts +0 -20
  552. /package/dist/simple-tree/{typesUnsafe.js → api/typesUnsafe.js} +0 -0
  553. /package/dist/{feature-libraries/typed-schema → simple-tree}/flexList.d.ts +0 -0
  554. /package/dist/{feature-libraries/typed-schema → simple-tree}/flexList.js +0 -0
  555. /package/lib/simple-tree/{typesUnsafe.js → api/typesUnsafe.js} +0 -0
  556. /package/lib/{feature-libraries/typed-schema → simple-tree}/flexList.d.ts +0 -0
  557. /package/lib/{feature-libraries/typed-schema → simple-tree}/flexList.js +0 -0
  558. /package/src/simple-tree/{ProxyBinding.md → core/TreeNodeBinding.md} +0 -0
  559. /package/src/{feature-libraries/typed-schema → simple-tree}/flexList.ts +0 -0
@@ -3,27 +3,27 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
- import type { FlexListToUnion, Unenforced } from "../feature-libraries/index.js";
7
- import type { RestrictiveStringRecord, _InlineTrick } from "../util/index.js";
6
+ import type { RestrictiveStringRecord, _InlineTrick } from "../../util/index.js";
8
7
 
9
8
  import type {
10
- AllowedTypes,
11
9
  ApplyKind,
12
10
  FieldKind,
13
11
  FieldSchema,
14
12
  ImplicitAllowedTypes,
15
13
  ImplicitFieldSchema,
16
- NodeFromSchema,
17
- TreeNodeFromImplicitAllowedTypes,
18
- } from "./schemaTypes.js";
14
+ TreeLeafValue,
15
+ } from "../schemaTypes.js";
19
16
  import type {
20
17
  NodeKind,
21
- TreeNodeSchema,
22
18
  WithType,
23
19
  TreeNode,
24
20
  Unhydrated,
25
- } from "./core/index.js";
26
- import type { TreeArrayNodeBase, TreeArrayNode } from "./arrayNode.js";
21
+ InternalTreeNode,
22
+ TreeNodeSchema,
23
+ TreeNodeSchemaCore,
24
+ } from "../core/index.js";
25
+ import type { TreeArrayNodeBase } from "../arrayNode.js";
26
+ import type { FlexListToUnion, LazyItem } from "../flexList.js";
27
27
 
28
28
  /*
29
29
  * TODO:
@@ -37,6 +37,16 @@ import type { TreeArrayNodeBase, TreeArrayNode } from "./arrayNode.js";
37
37
  */
38
38
  /* eslint-disable @typescript-eslint/no-explicit-any */
39
39
 
40
+ /**
41
+ * A placeholder to use in {@link https://www.typescriptlang.org/docs/handbook/2/generics.html#generic-constraints | extends constraints} when using the real type breaks compilation of some recursive types due to {@link https://github.com/microsoft/TypeScript/issues/55758 | a design limitation of TypeScript}.
42
+ *
43
+ * These extends constraints only serve as documentation:
44
+ * to avoid breaking compilation, this type has to not actually enforce anything, and thus is just `unknown`.
45
+ * Therefore the type safety is the responsibility of the user of the API.
46
+ * @public
47
+ */
48
+ export type Unenforced<_DesiredExtendsConstraint> = unknown;
49
+
40
50
  /**
41
51
  * {@link Unenforced} version of `ObjectFromSchemaRecord`.
42
52
  * @remarks
@@ -49,6 +59,65 @@ export type ObjectFromSchemaRecordUnsafe<
49
59
  -readonly [Property in keyof T]: TreeFieldFromImplicitFieldUnsafe<T[Property]>;
50
60
  };
51
61
 
62
+ /**
63
+ * {@link Unenforced} version of {@link TreeNodeSchema}.
64
+ * @remarks
65
+ * Do note use this type directly: its only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.
66
+ * @system @public
67
+ */
68
+ export type TreeNodeSchemaUnsafe<
69
+ Name extends string = string,
70
+ Kind extends NodeKind = NodeKind,
71
+ TNode extends Unenforced<TreeNode | TreeLeafValue> = unknown,
72
+ TBuild = never,
73
+ ImplicitlyConstructable extends boolean = boolean,
74
+ Info = unknown,
75
+ > =
76
+ | TreeNodeSchemaClassUnsafe<Name, Kind, TNode, TBuild, ImplicitlyConstructable, Info>
77
+ | TreeNodeSchemaNonClassUnsafe<Name, Kind, TNode, TBuild, ImplicitlyConstructable, Info>;
78
+
79
+ /**
80
+ * {@link Unenforced} version of {@link TreeNodeSchemaClass}.
81
+ * @remarks
82
+ * Do note use this type directly: its only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.
83
+ * @system @public
84
+ */
85
+ export interface TreeNodeSchemaClassUnsafe<
86
+ out Name extends string,
87
+ out Kind extends NodeKind,
88
+ // TODO: maybe this can be more specific (exclude leaves)
89
+ out TNode extends Unenforced<TreeNode | TreeLeafValue>,
90
+ in TInsertable = never,
91
+ out ImplicitlyConstructable extends boolean = boolean,
92
+ out Info = unknown,
93
+ > extends TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info> {
94
+ /**
95
+ * Constructs an {@link Unhydrated} node with this schema.
96
+ * @remarks
97
+ * This constructor is also used internally to construct hydrated nodes with a different parameter type.
98
+ * Therefore, overriding this constructor with different argument types is not type-safe and is not supported.
99
+ * @sealed
100
+ */
101
+ new (data: TInsertable | InternalTreeNode): Unhydrated<TNode>;
102
+ }
103
+
104
+ /**
105
+ * {@link Unenforced} version of {@link TreeNodeSchemaNonClass}.
106
+ * @remarks
107
+ * Do note use this type directly: its only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.
108
+ * @system @public
109
+ */
110
+ export interface TreeNodeSchemaNonClassUnsafe<
111
+ out Name extends string,
112
+ out Kind extends NodeKind,
113
+ out TNode extends Unenforced<TreeNode | TreeLeafValue>,
114
+ in TInsertable = never,
115
+ out ImplicitlyConstructable extends boolean = boolean,
116
+ out Info = unknown,
117
+ > extends TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info> {
118
+ create(data: TInsertable): TNode;
119
+ }
120
+
52
121
  /**
53
122
  * {@link Unenforced} version of {@link TreeObjectNode}.
54
123
  * @remarks
@@ -73,6 +142,14 @@ export type TreeFieldFromImplicitFieldUnsafe<TSchema extends Unenforced<Implicit
73
142
  ? TreeNodeFromImplicitAllowedTypesUnsafe<TSchema>
74
143
  : unknown;
75
144
 
145
+ /**
146
+ * {@link Unenforced} version of {@link AllowedTypes}.
147
+ * @remarks
148
+ * Do note use this type directly: its only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.
149
+ * @system @public
150
+ */
151
+ export type AllowedTypesUnsafe = readonly LazyItem<TreeNodeSchemaUnsafe>[];
152
+
76
153
  /**
77
154
  * {@link Unenforced} version of {@link TreeNodeFromImplicitAllowedTypes}.
78
155
  * @remarks
@@ -81,13 +158,11 @@ export type TreeFieldFromImplicitFieldUnsafe<TSchema extends Unenforced<Implicit
81
158
  */
82
159
  export type TreeNodeFromImplicitAllowedTypesUnsafe<
83
160
  TSchema extends Unenforced<ImplicitAllowedTypes>,
84
- > = TSchema extends ImplicitAllowedTypes
85
- ? TreeNodeFromImplicitAllowedTypes<TSchema>
86
- : TSchema extends TreeNodeSchema
87
- ? NodeFromSchema<TSchema>
88
- : TSchema extends AllowedTypes
89
- ? NodeFromSchema<FlexListToUnion<TSchema>>
90
- : unknown;
161
+ > = TSchema extends TreeNodeSchemaUnsafe
162
+ ? NodeFromSchemaUnsafe<TSchema>
163
+ : TSchema extends AllowedTypesUnsafe
164
+ ? NodeFromSchemaUnsafe<FlexListToUnion<TSchema>>
165
+ : unknown;
91
166
 
92
167
  /**
93
168
  * {@link Unenforced} version of {@link InsertableTreeNodeFromImplicitAllowedTypes}.
@@ -97,7 +172,7 @@ export type TreeNodeFromImplicitAllowedTypesUnsafe<
97
172
  */
98
173
  export type InsertableTreeNodeFromImplicitAllowedTypesUnsafe<
99
174
  TSchema extends Unenforced<ImplicitAllowedTypes>,
100
- > = TSchema extends AllowedTypes
175
+ > = TSchema extends AllowedTypesUnsafe
101
176
  ? InsertableTypedNodeUnsafe<FlexListToUnion<TSchema>>
102
177
  : InsertableTypedNodeUnsafe<TSchema>;
103
178
 
@@ -119,7 +194,7 @@ export type InsertableTypedNodeUnsafe<T extends Unenforced<TreeNodeSchema>> = [
119
194
  * @system @public
120
195
  */
121
196
  export type NodeFromSchemaUnsafe<T extends Unenforced<TreeNodeSchema>> =
122
- T extends TreeNodeSchema<string, NodeKind, infer TNode> ? TNode : never;
197
+ T extends TreeNodeSchemaUnsafe<string, NodeKind, infer TNode> ? TNode : never;
123
198
 
124
199
  /**
125
200
  * {@link Unenforced} version of {@link InsertableTreeNodeFromImplicitAllowedTypes}.
@@ -128,7 +203,7 @@ export type NodeFromSchemaUnsafe<T extends Unenforced<TreeNodeSchema>> =
128
203
  * @system @public
129
204
  */
130
205
  export type NodeBuilderDataUnsafe<T extends Unenforced<TreeNodeSchema>> =
131
- T extends TreeNodeSchema<string, NodeKind, unknown, infer TBuild> ? TBuild : never;
206
+ T extends TreeNodeSchemaUnsafe<string, NodeKind, unknown, infer TBuild> ? TBuild : never;
132
207
 
133
208
  /**
134
209
  * {@link Unenforced} version of {@link (TreeArrayNode:interface)}.
@@ -139,8 +214,7 @@ export type NodeBuilderDataUnsafe<T extends Unenforced<TreeNodeSchema>> =
139
214
  export interface TreeArrayNodeUnsafe<TAllowedTypes extends Unenforced<ImplicitAllowedTypes>>
140
215
  extends TreeArrayNodeBase<
141
216
  TreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>,
142
- InsertableTreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>,
143
- TreeArrayNode
217
+ InsertableTreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>
144
218
  > {}
145
219
 
146
220
  /**
@@ -10,10 +10,7 @@ import { assert } from "@fluidframework/core-utils/internal";
10
10
  import {
11
11
  aboveRootPlaceholder,
12
12
  EmptyKey,
13
- forEachField,
14
- inCursorField,
15
13
  keyAsDetachedField,
16
- mapCursorField,
17
14
  type FieldKey,
18
15
  type ITreeCursor,
19
16
  type ITreeCursorSynchronous,
@@ -40,16 +37,22 @@ import {
40
37
  stringSchema,
41
38
  } from "../leafNodeSchema.js";
42
39
  import { isObjectNodeSchema } from "../objectNodeTypes.js";
43
- import { walkFieldSchema } from "../walkFieldSchema.js";
40
+ import {
41
+ customFromCursorInner,
42
+ type CustomTreeNode,
43
+ type CustomTreeValue,
44
+ type EncodeOptions,
45
+ } from "./customTree.js";
44
46
  import { getUnhydratedContext } from "../createContext.js";
45
47
 
46
48
  /**
47
- * Verbose encoding of a {@link TreeNode} or {@link TreeValue}.
49
+ * Verbose encoding of a {@link TreeNode} or {@link TreeLeafValue}.
48
50
  * @remarks
49
51
  * This is verbose meaning that every {@link TreeNode} is a {@link VerboseTreeNode}.
50
52
  * Any IFluidHandle values have been replaced by `THandle`.
51
53
  * @privateRemarks
52
- * This can store all possible simple trees, but it can not store all possible trees representable by our internal representations like FlexTree and JsonableTree.
54
+ * This can store all possible simple trees,
55
+ * but it can not store all possible trees representable by our internal representations like FlexTree and JsonableTree.
53
56
  */
54
57
  export type VerboseTree<THandle = IFluidHandle> =
55
58
  | VerboseTreeNode<THandle>
@@ -77,7 +80,8 @@ export type VerboseTree<THandle = IFluidHandle> =
77
80
  * This format allows for all simple-tree compatible trees to be represented.
78
81
  *
79
82
  * Unlike `JsonableTree`, leaf nodes are not boxed into node objects, and instead have their schema inferred from the value.
80
- * Additionally, sequence fields can only occur on a node that has a single sequence field (with the empty key) replicating the behavior of simple-tree ArrayNodes.
83
+ * Additionally, sequence fields can only occur on a node that has a single sequence field (with the empty key)
84
+ * replicating the behavior of simple-tree ArrayNodes.
81
85
  */
82
86
  export interface VerboseTreeNode<THandle = IFluidHandle> {
83
87
  /**
@@ -144,24 +148,6 @@ export interface SchemalessParseOptions<TCustom> {
144
148
  };
145
149
  }
146
150
 
147
- /**
148
- * Options for how to interpret a `VerboseTree<TCustom>` without relying on schema.
149
- */
150
- export interface EncodeOptions<TCustom> {
151
- /**
152
- * Fixup custom input formats.
153
- * @remarks
154
- * See note on {@link ParseOptions.valueConverter}.
155
- */
156
- valueConverter(data: IFluidHandle): TCustom;
157
- /**
158
- * If true, interpret the input keys of object nodes as stored keys.
159
- * If false, interpret them as property keys.
160
- * @defaultValue false.
161
- */
162
- readonly useStoredKeys?: boolean;
163
- }
164
-
165
151
  /**
166
152
  * Use info from `schema` to convert `options` to {@link SchemalessParseOptions}.
167
153
  */
@@ -345,12 +331,7 @@ export function verboseFromCursor<TCustom>(
345
331
  ...options,
346
332
  };
347
333
 
348
- const schemaMap = new Map<string, TreeNodeSchema>();
349
- walkFieldSchema(rootSchema, {
350
- node(schema) {
351
- schemaMap.set(schema.identifier, schema);
352
- },
353
- });
334
+ const schemaMap = getUnhydratedContext(rootSchema).schema;
354
335
 
355
336
  return verboseFromCursorInner(reader, config, schemaMap);
356
337
  }
@@ -360,50 +341,14 @@ function verboseFromCursorInner<TCustom>(
360
341
  options: Required<EncodeOptions<TCustom>>,
361
342
  schema: ReadonlyMap<string, TreeNodeSchema>,
362
343
  ): VerboseTree<TCustom> {
363
- const type = reader.type;
364
- const nodeSchema = schema.get(type) ?? fail("missing schema for type in cursor");
365
-
366
- switch (type) {
367
- case numberSchema.identifier:
368
- case booleanSchema.identifier:
369
- case nullSchema.identifier:
370
- case stringSchema.identifier:
371
- assert(reader.value !== undefined, 0xa14 /* out of schema: missing value */);
372
- assert(!isFluidHandle(reader.value), 0xa15 /* out of schema: unexpected FluidHandle */);
373
- return reader.value;
374
- case handleSchema.identifier:
375
- assert(reader.value !== undefined, 0xa16 /* out of schema: missing value */);
376
- assert(isFluidHandle(reader.value), 0xa17 /* out of schema: unexpected FluidHandle */);
377
- return options.valueConverter(reader.value);
378
- default: {
379
- assert(reader.value === undefined, 0xa18 /* out of schema: unexpected value */);
380
- if (nodeSchema.kind === NodeKind.Array) {
381
- const fields = inCursorField(reader, EmptyKey, () =>
382
- mapCursorField(reader, () => verboseFromCursorInner(reader, options, schema)),
383
- );
384
- return { type, fields };
385
- } else {
386
- const fields: Record<string, VerboseTree<TCustom>> = {};
387
- forEachField(reader, () => {
388
- const children = mapCursorField(reader, () =>
389
- verboseFromCursorInner(reader, options, schema),
390
- );
391
- if (children.length === 1) {
392
- const storedKey = reader.getFieldKey();
393
- const key =
394
- isObjectNodeSchema(nodeSchema) && !options.useStoredKeys
395
- ? nodeSchema.storedKeyToPropertyKey.get(storedKey) ??
396
- fail("missing property key")
397
- : storedKey;
398
- // Length is checked above.
399
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
400
- fields[key] = children[0]!;
401
- } else {
402
- assert(children.length === 0, 0xa19 /* invalid children number */);
403
- }
404
- });
405
- return { type, fields };
406
- }
407
- }
344
+ const fields = customFromCursorInner(reader, options, schema, verboseFromCursorInner);
345
+ const nodeSchema = schema.get(reader.type) ?? fail("missing schema for type in cursor");
346
+ if (nodeSchema.kind === NodeKind.Leaf) {
347
+ return fields as CustomTreeValue<TCustom>;
408
348
  }
349
+
350
+ return {
351
+ type: reader.type,
352
+ fields: fields as CustomTreeNode<TCustom>,
353
+ };
409
354
  }
@@ -14,11 +14,11 @@ import {
14
14
  isFlexTreeNode,
15
15
  } from "../feature-libraries/index.js";
16
16
  import { prepareContentForHydration } from "./proxies.js";
17
- import { getOrCreateInnerNode } from "./proxyBinding.js";
18
17
  import {
19
18
  normalizeAllowedTypes,
20
19
  type ImplicitAllowedTypes,
21
20
  type InsertableTreeNodeFromImplicitAllowedTypes,
21
+ type TreeLeafValue,
22
22
  type TreeNodeFromImplicitAllowedTypes,
23
23
  } from "./schemaTypes.js";
24
24
  import {
@@ -34,6 +34,8 @@ import {
34
34
  getOrCreateNodeFromInnerNode,
35
35
  type TreeNodeSchemaBoth,
36
36
  getSimpleNodeSchemaFromInnerNode,
37
+ getOrCreateInnerNode,
38
+ type TreeNodeSchemaClass,
37
39
  } from "./core/index.js";
38
40
  import { type InsertableContent, mapTreeFromNodeData } from "./toMapTree.js";
39
41
  import { fail } from "../util/index.js";
@@ -45,6 +47,19 @@ import {
45
47
  import { TreeNodeValid, type MostDerivedData } from "./treeNodeValid.js";
46
48
  import { getUnhydratedContext } from "./createContext.js";
47
49
 
50
+ /**
51
+ * A covariant base type for {@link (TreeArrayNode:interface)}.
52
+ *
53
+ * This provides the readonly subset of TreeArrayNode functionality, and is used as the source interface for moves since that needs to be covariant.
54
+ * @privateRemarks
55
+ * Ideally this would just include `TreeNode, WithType<string, NodeKind.Array>` in the extends list but https://github.com/microsoft/TypeScript/issues/16936 prevents that from compiling.
56
+ * As a workaround around for this TypeScript limitation, the conflicting type intersection is wrapped in `Awaited` (which has no effect on the type in this case) which allows it to compile.
57
+ * @system @sealed @public
58
+ */
59
+ export interface ReadonlyArrayNode<out T = TreeNode | TreeLeafValue>
60
+ extends ReadonlyArray<T>,
61
+ Awaited<TreeNode & WithType<string, NodeKind.Array>> {}
62
+
48
63
  /**
49
64
  * A generic array type, used to defined types like {@link (TreeArrayNode:interface)}.
50
65
  *
@@ -53,9 +68,8 @@ import { getUnhydratedContext } from "./createContext.js";
53
68
  *
54
69
  * @system @sealed @public
55
70
  */
56
- export interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom>
57
- extends ReadonlyArray<T>,
58
- TreeNode {
71
+ export interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom = ReadonlyArrayNode>
72
+ extends ReadonlyArrayNode<T> {
59
73
  /**
60
74
  * Inserts new item(s) at a specified location.
61
75
  * @param index - The index at which to insert `value`.
@@ -366,8 +380,7 @@ export interface TreeArrayNode<
366
380
  TAllowedTypes extends ImplicitAllowedTypes = ImplicitAllowedTypes,
367
381
  > extends TreeArrayNodeBase<
368
382
  TreeNodeFromImplicitAllowedTypes<TAllowedTypes>,
369
- InsertableTreeNodeFromImplicitAllowedTypes<TAllowedTypes>,
370
- TreeArrayNode
383
+ InsertableTreeNodeFromImplicitAllowedTypes<TAllowedTypes>
371
384
  > {}
372
385
 
373
386
  /**
@@ -417,9 +430,7 @@ export class IterableTreeArrayContent<T> implements Iterable<T> {
417
430
  /**
418
431
  * Given a array node proxy, returns its underlying LazySequence field.
419
432
  */
420
- function getSequenceField<TSimpleType extends ImplicitAllowedTypes>(
421
- arrayNode: TreeArrayNode<TSimpleType>,
422
- ): FlexTreeSequenceField {
433
+ function getSequenceField(arrayNode: ReadonlyArrayNode): FlexTreeSequenceField {
423
434
  return getOrCreateInnerNode(arrayNode).getBoxed(EmptyKey) as FlexTreeSequenceField;
424
435
  }
425
436
 
@@ -799,6 +810,11 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
799
810
  protected abstract get simpleSchema(): T;
800
811
  protected abstract get allowedTypes(): ReadonlySet<TreeNodeSchema>;
801
812
 
813
+ public abstract override get [typeSchemaSymbol](): TreeNodeSchemaClass<
814
+ string,
815
+ NodeKind.Array
816
+ >;
817
+
802
818
  public constructor(
803
819
  input: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>> | InternalTreeNode,
804
820
  ) {
@@ -901,13 +917,13 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
901
917
  }
902
918
  field.editor.remove(removeStart, removeEnd - removeStart);
903
919
  }
904
- public moveToStart(sourceIndex: number, source?: TreeArrayNode): void {
920
+ public moveToStart(sourceIndex: number, source?: ReadonlyArrayNode): void {
905
921
  const sourceArray = source ?? this;
906
922
  const sourceField = getSequenceField(sourceArray);
907
923
  validateIndex(sourceIndex, sourceField, "moveToStart");
908
924
  this.moveRangeToIndex(0, sourceIndex, sourceIndex + 1, source);
909
925
  }
910
- public moveToEnd(sourceIndex: number, source?: TreeArrayNode): void {
926
+ public moveToEnd(sourceIndex: number, source?: ReadonlyArrayNode): void {
911
927
  const sourceArray = source ?? this;
912
928
  const sourceField = getSequenceField(sourceArray);
913
929
  validateIndex(sourceIndex, sourceField, "moveToEnd");
@@ -916,7 +932,7 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
916
932
  public moveToIndex(
917
933
  destinationGap: number,
918
934
  sourceIndex: number,
919
- source?: TreeArrayNode,
935
+ source?: ReadonlyArrayNode,
920
936
  ): void {
921
937
  const sourceArray = source ?? this;
922
938
  const sourceField = getSequenceField(sourceArray);
@@ -928,7 +944,7 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
928
944
  public moveRangeToStart(
929
945
  sourceStart: number,
930
946
  sourceEnd: number,
931
- source?: TreeArrayNode,
947
+ source?: ReadonlyArrayNode,
932
948
  ): void {
933
949
  validateIndexRange(
934
950
  sourceStart,
@@ -938,7 +954,11 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
938
954
  );
939
955
  this.moveRangeToIndex(0, sourceStart, sourceEnd, source);
940
956
  }
941
- public moveRangeToEnd(sourceStart: number, sourceEnd: number, source?: TreeArrayNode): void {
957
+ public moveRangeToEnd(
958
+ sourceStart: number,
959
+ sourceEnd: number,
960
+ source?: ReadonlyArrayNode,
961
+ ): void {
942
962
  validateIndexRange(
943
963
  sourceStart,
944
964
  sourceEnd,
@@ -951,7 +971,7 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
951
971
  destinationGap: number,
952
972
  sourceStart: number,
953
973
  sourceEnd: number,
954
- source?: TreeArrayNode,
974
+ source?: ReadonlyArrayNode,
955
975
  ): void {
956
976
  const destinationField = getSequenceField(this);
957
977
  const destinationSchema = this.allowedTypes;
@@ -11,6 +11,7 @@ export {
11
11
  type InnerNode,
12
12
  tryDisposeTreeNode,
13
13
  tryGetTreeNodeFromMapNode,
14
+ getOrCreateInnerNode,
14
15
  } from "./treeNodeKernel.js";
15
16
  export { type WithType, typeNameSymbol, typeSchemaSymbol } from "./withType.js";
16
17
  export {
@@ -430,3 +430,16 @@ export function getTreeNodeSchemaFromHydratedFlexNode(flexNode: FlexTreeNode): T
430
430
 
431
431
  return context.schema.get(flexNode.schema) ?? fail("Missing schema");
432
432
  }
433
+
434
+ /**
435
+ * Retrieves the flex node associated with the given target via {@link setInnerNode}.
436
+ * @remarks
437
+ * For {@link Unhydrated} nodes, this returns the MapTreeNode.
438
+ *
439
+ * For hydrated nodes it returns a FlexTreeNode backed by the forest.
440
+ * Note that for "marinated" nodes, this FlexTreeNode exists and returns it: it does not return the MapTreeNode which is the current InnerNode.
441
+ */
442
+ export function getOrCreateInnerNode(treeNode: TreeNode, allowFreed = false): InnerNode {
443
+ const kernel = getKernel(treeNode);
444
+ return kernel.getOrCreateInnerNode(allowFreed);
445
+ }
@@ -3,7 +3,8 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
- import type { InternalTreeNode, Unhydrated } from "./types.js";
6
+ import type { TreeLeafValue } from "../schemaTypes.js";
7
+ import type { InternalTreeNode, TreeNode, Unhydrated } from "./types.js";
7
8
 
8
9
  /**
9
10
  * Schema for a tree node.
@@ -19,7 +20,7 @@ import type { InternalTreeNode, Unhydrated } from "./types.js";
19
20
  export type TreeNodeSchema<
20
21
  Name extends string = string,
21
22
  Kind extends NodeKind = NodeKind,
22
- TNode = unknown,
23
+ TNode extends TreeNode | TreeLeafValue = TreeNode | TreeLeafValue,
23
24
  TBuild = never,
24
25
  ImplicitlyConstructable extends boolean = boolean,
25
26
  Info = unknown,
@@ -38,7 +39,7 @@ export type TreeNodeSchema<
38
39
  export interface TreeNodeSchemaNonClass<
39
40
  out Name extends string = string,
40
41
  out Kind extends NodeKind = NodeKind,
41
- out TNode = unknown,
42
+ out TNode extends TreeNode | TreeLeafValue = TreeNode | TreeLeafValue,
42
43
  in TInsertable = never,
43
44
  out ImplicitlyConstructable extends boolean = boolean,
44
45
  out Info = unknown,
@@ -94,7 +95,8 @@ export interface TreeNodeSchemaNonClass<
94
95
  export interface TreeNodeSchemaClass<
95
96
  out Name extends string = string,
96
97
  out Kind extends NodeKind = NodeKind,
97
- out TNode = unknown,
98
+ // TODO: maybe this can be more specific (exclude leaves)
99
+ out TNode extends TreeNode | TreeLeafValue = TreeNode | TreeLeafValue,
98
100
  in TInsertable = never,
99
101
  out ImplicitlyConstructable extends boolean = boolean,
100
102
  out Info = unknown,
@@ -115,7 +117,7 @@ export interface TreeNodeSchemaClass<
115
117
  export type TreeNodeSchemaBoth<
116
118
  Name extends string = string,
117
119
  Kind extends NodeKind = NodeKind,
118
- TNode = unknown,
120
+ TNode extends TreeNode = TreeNode,
119
121
  TInsertable = never,
120
122
  ImplicitlyConstructable extends boolean = boolean,
121
123
  Info = unknown,
@@ -442,7 +442,12 @@ class EagerMapTreeRequiredField
442
442
  implements FlexTreeRequiredField
443
443
  {
444
444
  public override get content(): FlexTreeUnknownUnboxed {
445
- return super.content ?? fail("Expected EagerMapTree required field to have a value");
445
+ // This cannot use ?? since null is a legal value here.
446
+ assert(
447
+ super.content !== undefined,
448
+ "Expected EagerMapTree required field to have a value",
449
+ );
450
+ return super.content;
446
451
  }
447
452
  }
448
453
 
@@ -3,7 +3,9 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
+ import type { TreeLeafValue } from "../schemaTypes.js";
6
7
  import type { NodeKind, TreeNodeSchemaClass } from "./treeNodeSchema.js";
8
+ import type { TreeNode } from "./types.js";
7
9
 
8
10
  /**
9
11
  * The type of a {@link TreeNode}.
@@ -87,5 +89,12 @@ export interface WithType<
87
89
  /**
88
90
  * Type symbol, marking a type in a way to increase type safety via strong type checking.
89
91
  */
90
- get [typeSchemaSymbol](): TreeNodeSchemaClass<TName, TKind, unknown, never, boolean, TInfo>;
92
+ get [typeSchemaSymbol](): TreeNodeSchemaClass<
93
+ TName,
94
+ TKind,
95
+ TreeNode | TreeLeafValue,
96
+ never,
97
+ boolean,
98
+ TInfo
99
+ >;
91
100
  }