@fluidframework/tree 2.50.0 → 2.51.0-347100

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 (597) hide show
  1. package/.vscode/Tree.code-workspace +14 -1
  2. package/.vscode/settings.json +16 -0
  3. package/CHANGELOG.md +2 -2
  4. package/api-report/tree.alpha.api.md +7 -7
  5. package/dist/core/schema-stored/schema.d.ts +14 -1
  6. package/dist/core/schema-stored/schema.d.ts.map +1 -1
  7. package/dist/core/schema-stored/schema.js.map +1 -1
  8. package/dist/feature-libraries/default-schema/schemaChecker.d.ts.map +1 -1
  9. package/dist/feature-libraries/default-schema/schemaChecker.js +3 -0
  10. package/dist/feature-libraries/default-schema/schemaChecker.js.map +1 -1
  11. package/dist/feature-libraries/flex-tree/context.d.ts +7 -2
  12. package/dist/feature-libraries/flex-tree/context.d.ts.map +1 -1
  13. package/dist/feature-libraries/flex-tree/context.js +4 -4
  14. package/dist/feature-libraries/flex-tree/context.js.map +1 -1
  15. package/dist/feature-libraries/flex-tree/index.d.ts +1 -0
  16. package/dist/feature-libraries/flex-tree/index.d.ts.map +1 -1
  17. package/dist/feature-libraries/flex-tree/index.js +3 -1
  18. package/dist/feature-libraries/flex-tree/index.js.map +1 -1
  19. package/dist/feature-libraries/flex-tree/lazyField.d.ts.map +1 -1
  20. package/dist/feature-libraries/flex-tree/lazyField.js +5 -5
  21. package/dist/feature-libraries/flex-tree/lazyField.js.map +1 -1
  22. package/dist/feature-libraries/flex-tree/lazyNode.d.ts +3 -1
  23. package/dist/feature-libraries/flex-tree/lazyNode.d.ts.map +1 -1
  24. package/dist/feature-libraries/flex-tree/lazyNode.js +5 -3
  25. package/dist/feature-libraries/flex-tree/lazyNode.js.map +1 -1
  26. package/dist/feature-libraries/forest-summary/forestSummarizer.d.ts.map +1 -1
  27. package/dist/feature-libraries/forest-summary/forestSummarizer.js +3 -4
  28. package/dist/feature-libraries/forest-summary/forestSummarizer.js.map +1 -1
  29. package/dist/feature-libraries/index.d.ts +1 -1
  30. package/dist/feature-libraries/index.d.ts.map +1 -1
  31. package/dist/feature-libraries/index.js +2 -1
  32. package/dist/feature-libraries/index.js.map +1 -1
  33. package/dist/packageVersion.d.ts +1 -1
  34. package/dist/packageVersion.d.ts.map +1 -1
  35. package/dist/packageVersion.js +1 -1
  36. package/dist/packageVersion.js.map +1 -1
  37. package/dist/shared-tree/index.d.ts +0 -1
  38. package/dist/shared-tree/index.d.ts.map +1 -1
  39. package/dist/shared-tree/index.js +1 -3
  40. package/dist/shared-tree/index.js.map +1 -1
  41. package/dist/shared-tree/schematizeTree.d.ts.map +1 -1
  42. package/dist/shared-tree/schematizeTree.js +2 -6
  43. package/dist/shared-tree/schematizeTree.js.map +1 -1
  44. package/dist/shared-tree/schematizingTreeView.d.ts +11 -13
  45. package/dist/shared-tree/schematizingTreeView.d.ts.map +1 -1
  46. package/dist/shared-tree/schematizingTreeView.js +58 -81
  47. package/dist/shared-tree/schematizingTreeView.js.map +1 -1
  48. package/dist/shared-tree/sharedTreeChangeTypes.d.ts +1 -1
  49. package/dist/shared-tree/sharedTreeChangeTypes.js.map +1 -1
  50. package/dist/shared-tree/tree.d.ts.map +1 -1
  51. package/dist/shared-tree/tree.js +4 -3
  52. package/dist/shared-tree/tree.js.map +1 -1
  53. package/dist/shared-tree/treeAlpha.d.ts +7 -1
  54. package/dist/shared-tree/treeAlpha.d.ts.map +1 -1
  55. package/dist/shared-tree/treeAlpha.js.map +1 -1
  56. package/dist/shared-tree/treeCheckout.d.ts +7 -2
  57. package/dist/shared-tree/treeCheckout.d.ts.map +1 -1
  58. package/dist/shared-tree/treeCheckout.js +4 -1
  59. package/dist/shared-tree/treeCheckout.js.map +1 -1
  60. package/dist/simple-tree/api/conciseTree.d.ts +1 -1
  61. package/dist/simple-tree/api/conciseTree.d.ts.map +1 -1
  62. package/dist/simple-tree/api/conciseTree.js.map +1 -1
  63. package/dist/simple-tree/api/configuration.d.ts +1 -1
  64. package/dist/simple-tree/api/configuration.d.ts.map +1 -1
  65. package/dist/simple-tree/api/configuration.js +5 -5
  66. package/dist/simple-tree/api/configuration.js.map +1 -1
  67. package/dist/simple-tree/api/create.d.ts +3 -1
  68. package/dist/simple-tree/api/create.d.ts.map +1 -1
  69. package/dist/simple-tree/api/create.js +2 -0
  70. package/dist/simple-tree/api/create.js.map +1 -1
  71. package/dist/simple-tree/api/customTree.d.ts +1 -2
  72. package/dist/simple-tree/api/customTree.d.ts.map +1 -1
  73. package/dist/simple-tree/api/customTree.js.map +1 -1
  74. package/dist/simple-tree/api/getJsonSchema.d.ts +1 -1
  75. package/dist/simple-tree/api/getJsonSchema.d.ts.map +1 -1
  76. package/dist/simple-tree/api/getJsonSchema.js.map +1 -1
  77. package/dist/simple-tree/api/getSimpleSchema.d.ts +1 -1
  78. package/dist/simple-tree/api/getSimpleSchema.js.map +1 -1
  79. package/dist/simple-tree/api/identifierIndex.d.ts +1 -1
  80. package/dist/simple-tree/api/identifierIndex.js +2 -2
  81. package/dist/simple-tree/api/identifierIndex.js.map +1 -1
  82. package/dist/simple-tree/api/index.d.ts +1 -1
  83. package/dist/simple-tree/api/index.d.ts.map +1 -1
  84. package/dist/simple-tree/api/index.js.map +1 -1
  85. package/dist/simple-tree/api/schemaCompatibilityTester.d.ts +1 -1
  86. package/dist/simple-tree/api/schemaCompatibilityTester.js.map +1 -1
  87. package/dist/simple-tree/api/schemaCreationUtilities.d.ts +14 -2
  88. package/dist/simple-tree/api/schemaCreationUtilities.d.ts.map +1 -1
  89. package/dist/simple-tree/api/schemaCreationUtilities.js +41 -4
  90. package/dist/simple-tree/api/schemaCreationUtilities.js.map +1 -1
  91. package/dist/simple-tree/api/schemaFactory.d.ts +36 -3
  92. package/dist/simple-tree/api/schemaFactory.d.ts.map +1 -1
  93. package/dist/simple-tree/api/schemaFactory.js +18 -18
  94. package/dist/simple-tree/api/schemaFactory.js.map +1 -1
  95. package/dist/simple-tree/api/schemaFactoryAlpha.d.ts +16 -16
  96. package/dist/simple-tree/api/schemaFactoryAlpha.d.ts.map +1 -1
  97. package/dist/simple-tree/api/schemaFactoryAlpha.js.map +1 -1
  98. package/dist/simple-tree/api/schemaFactoryRecursive.d.ts +2 -2
  99. package/dist/simple-tree/api/schemaFactoryRecursive.d.ts.map +1 -1
  100. package/dist/simple-tree/api/schemaFactoryRecursive.js +2 -2
  101. package/dist/simple-tree/api/schemaFactoryRecursive.js.map +1 -1
  102. package/dist/simple-tree/api/schemaFromSimple.d.ts.map +1 -1
  103. package/dist/simple-tree/api/schemaFromSimple.js +4 -4
  104. package/dist/simple-tree/api/schemaFromSimple.js.map +1 -1
  105. package/dist/simple-tree/api/simpleSchemaToJsonSchema.js +2 -2
  106. package/dist/simple-tree/api/simpleSchemaToJsonSchema.js.map +1 -1
  107. package/dist/simple-tree/api/simpleTreeIndex.d.ts +2 -2
  108. package/dist/simple-tree/api/simpleTreeIndex.d.ts.map +1 -1
  109. package/dist/simple-tree/api/simpleTreeIndex.js +1 -1
  110. package/dist/simple-tree/api/simpleTreeIndex.js.map +1 -1
  111. package/dist/simple-tree/api/storedSchema.d.ts +1 -1
  112. package/dist/simple-tree/api/storedSchema.js +2 -2
  113. package/dist/simple-tree/api/storedSchema.js.map +1 -1
  114. package/dist/simple-tree/api/tree.d.ts +2 -1
  115. package/dist/simple-tree/api/tree.d.ts.map +1 -1
  116. package/dist/simple-tree/api/tree.js.map +1 -1
  117. package/dist/simple-tree/api/treeBeta.d.ts +4 -1
  118. package/dist/simple-tree/api/treeBeta.d.ts.map +1 -1
  119. package/dist/simple-tree/api/treeBeta.js.map +1 -1
  120. package/dist/simple-tree/api/treeNodeApi.d.ts +1 -2
  121. package/dist/simple-tree/api/treeNodeApi.d.ts.map +1 -1
  122. package/dist/simple-tree/api/treeNodeApi.js +3 -3
  123. package/dist/simple-tree/api/treeNodeApi.js.map +1 -1
  124. package/dist/simple-tree/api/typesUnsafe.d.ts +2 -3
  125. package/dist/simple-tree/api/typesUnsafe.d.ts.map +1 -1
  126. package/dist/simple-tree/api/typesUnsafe.js.map +1 -1
  127. package/dist/simple-tree/api/verboseTree.d.ts +2 -1
  128. package/dist/simple-tree/api/verboseTree.d.ts.map +1 -1
  129. package/dist/simple-tree/api/verboseTree.js.map +1 -1
  130. package/dist/simple-tree/api/viewSchemaToSimpleSchema.d.ts +1 -1
  131. package/dist/simple-tree/api/viewSchemaToSimpleSchema.js +2 -2
  132. package/dist/simple-tree/api/viewSchemaToSimpleSchema.js.map +1 -1
  133. package/dist/simple-tree/core/allowedTypes.d.ts +316 -0
  134. package/dist/simple-tree/core/allowedTypes.d.ts.map +1 -0
  135. package/dist/simple-tree/core/allowedTypes.js +173 -0
  136. package/dist/simple-tree/core/allowedTypes.js.map +1 -0
  137. package/dist/simple-tree/core/context.d.ts +3 -9
  138. package/dist/simple-tree/core/context.d.ts.map +1 -1
  139. package/dist/simple-tree/core/context.js +3 -11
  140. package/dist/simple-tree/core/context.js.map +1 -1
  141. package/dist/simple-tree/core/flexList.d.ts.map +1 -0
  142. package/dist/simple-tree/core/flexList.js.map +1 -0
  143. package/dist/simple-tree/core/getOrCreateNode.d.ts +1 -1
  144. package/dist/simple-tree/core/getOrCreateNode.d.ts.map +1 -1
  145. package/dist/simple-tree/core/getOrCreateNode.js.map +1 -1
  146. package/dist/simple-tree/core/index.d.ts +9 -3
  147. package/dist/simple-tree/core/index.d.ts.map +1 -1
  148. package/dist/simple-tree/core/index.js +19 -3
  149. package/dist/simple-tree/core/index.js.map +1 -1
  150. package/dist/simple-tree/core/treeNodeKernel.d.ts +8 -1
  151. package/dist/simple-tree/core/treeNodeKernel.d.ts.map +1 -1
  152. package/dist/simple-tree/core/treeNodeKernel.js +24 -20
  153. package/dist/simple-tree/core/treeNodeKernel.js.map +1 -1
  154. package/dist/simple-tree/core/treeNodeSchema.d.ts +182 -39
  155. package/dist/simple-tree/core/treeNodeSchema.d.ts.map +1 -1
  156. package/dist/simple-tree/core/treeNodeSchema.js +47 -17
  157. package/dist/simple-tree/core/treeNodeSchema.js.map +1 -1
  158. package/dist/simple-tree/{treeNodeValid.d.ts → core/treeNodeValid.d.ts} +18 -4
  159. package/dist/simple-tree/core/treeNodeValid.d.ts.map +1 -0
  160. package/dist/simple-tree/{treeNodeValid.js → core/treeNodeValid.js} +41 -11
  161. package/dist/simple-tree/core/treeNodeValid.js.map +1 -0
  162. package/dist/simple-tree/core/unhydratedFlexTree.d.ts +1 -1
  163. package/dist/simple-tree/core/unhydratedFlexTree.js.map +1 -1
  164. package/dist/simple-tree/core/walkSchema.d.ts +2 -1
  165. package/dist/simple-tree/core/walkSchema.d.ts.map +1 -1
  166. package/dist/simple-tree/core/walkSchema.js +6 -2
  167. package/dist/simple-tree/core/walkSchema.js.map +1 -1
  168. package/dist/simple-tree/createContext.d.ts +6 -2
  169. package/dist/simple-tree/createContext.d.ts.map +1 -1
  170. package/dist/simple-tree/createContext.js +15 -3
  171. package/dist/simple-tree/createContext.js.map +1 -1
  172. package/dist/simple-tree/fieldSchema.d.ts +423 -0
  173. package/dist/simple-tree/fieldSchema.d.ts.map +1 -0
  174. package/dist/simple-tree/{schemaTypes.js → fieldSchema.js} +5 -195
  175. package/dist/simple-tree/fieldSchema.js.map +1 -0
  176. package/dist/simple-tree/index.d.ts +5 -5
  177. package/dist/simple-tree/index.d.ts.map +1 -1
  178. package/dist/simple-tree/index.js +11 -11
  179. package/dist/simple-tree/index.js.map +1 -1
  180. package/dist/simple-tree/leafNodeSchema.d.ts +14 -5
  181. package/dist/simple-tree/leafNodeSchema.d.ts.map +1 -1
  182. package/dist/simple-tree/leafNodeSchema.js +117 -2
  183. package/dist/simple-tree/leafNodeSchema.js.map +1 -1
  184. package/dist/simple-tree/node-kinds/array/arrayNode.d.ts +3 -4
  185. package/dist/simple-tree/node-kinds/array/arrayNode.d.ts.map +1 -1
  186. package/dist/simple-tree/node-kinds/array/arrayNode.js +97 -26
  187. package/dist/simple-tree/node-kinds/array/arrayNode.js.map +1 -1
  188. package/dist/simple-tree/node-kinds/array/arrayNodeTypes.d.ts +2 -2
  189. package/dist/simple-tree/node-kinds/array/arrayNodeTypes.d.ts.map +1 -1
  190. package/dist/simple-tree/node-kinds/array/arrayNodeTypes.js.map +1 -1
  191. package/dist/simple-tree/node-kinds/common.d.ts +16 -0
  192. package/dist/simple-tree/node-kinds/common.d.ts.map +1 -0
  193. package/dist/simple-tree/node-kinds/common.js +42 -0
  194. package/dist/simple-tree/node-kinds/common.js.map +1 -0
  195. package/dist/simple-tree/node-kinds/index.d.ts +1 -1
  196. package/dist/simple-tree/node-kinds/index.d.ts.map +1 -1
  197. package/dist/simple-tree/node-kinds/index.js.map +1 -1
  198. package/dist/simple-tree/node-kinds/map/mapNode.d.ts +2 -3
  199. package/dist/simple-tree/node-kinds/map/mapNode.d.ts.map +1 -1
  200. package/dist/simple-tree/node-kinds/map/mapNode.js +64 -26
  201. package/dist/simple-tree/node-kinds/map/mapNode.js.map +1 -1
  202. package/dist/simple-tree/node-kinds/map/mapNodeTypes.d.ts +2 -2
  203. package/dist/simple-tree/node-kinds/map/mapNodeTypes.d.ts.map +1 -1
  204. package/dist/simple-tree/node-kinds/map/mapNodeTypes.js.map +1 -1
  205. package/dist/simple-tree/node-kinds/object/index.d.ts +1 -1
  206. package/dist/simple-tree/node-kinds/object/index.d.ts.map +1 -1
  207. package/dist/simple-tree/node-kinds/object/index.js.map +1 -1
  208. package/dist/simple-tree/node-kinds/object/objectNode.d.ts +19 -5
  209. package/dist/simple-tree/node-kinds/object/objectNode.d.ts.map +1 -1
  210. package/dist/simple-tree/node-kinds/object/objectNode.js +131 -27
  211. package/dist/simple-tree/node-kinds/object/objectNode.js.map +1 -1
  212. package/dist/simple-tree/node-kinds/object/objectNodeTypes.d.ts +11 -4
  213. package/dist/simple-tree/node-kinds/object/objectNodeTypes.d.ts.map +1 -1
  214. package/dist/simple-tree/node-kinds/object/objectNodeTypes.js.map +1 -1
  215. package/dist/simple-tree/node-kinds/record/recordNode.d.ts +2 -2
  216. package/dist/simple-tree/node-kinds/record/recordNode.d.ts.map +1 -1
  217. package/dist/simple-tree/node-kinds/record/recordNode.js +41 -13
  218. package/dist/simple-tree/node-kinds/record/recordNode.js.map +1 -1
  219. package/dist/simple-tree/node-kinds/record/recordNodeTypes.d.ts +2 -2
  220. package/dist/simple-tree/node-kinds/record/recordNodeTypes.d.ts.map +1 -1
  221. package/dist/simple-tree/node-kinds/record/recordNodeTypes.js.map +1 -1
  222. package/dist/simple-tree/prepareForInsertion.d.ts +2 -2
  223. package/dist/simple-tree/prepareForInsertion.d.ts.map +1 -1
  224. package/dist/simple-tree/prepareForInsertion.js +3 -3
  225. package/dist/simple-tree/prepareForInsertion.js.map +1 -1
  226. package/dist/simple-tree/simpleSchema.d.ts +2 -2
  227. package/dist/simple-tree/simpleSchema.d.ts.map +1 -1
  228. package/dist/simple-tree/simpleSchema.js.map +1 -1
  229. package/dist/simple-tree/toStoredSchema.d.ts +1 -1
  230. package/dist/simple-tree/toStoredSchema.d.ts.map +1 -1
  231. package/dist/simple-tree/toStoredSchema.js +6 -7
  232. package/dist/simple-tree/toStoredSchema.js.map +1 -1
  233. package/dist/simple-tree/unhydratedFlexTreeFromInsertable.d.ts +5 -11
  234. package/dist/simple-tree/unhydratedFlexTreeFromInsertable.d.ts.map +1 -1
  235. package/dist/simple-tree/unhydratedFlexTreeFromInsertable.js +25 -395
  236. package/dist/simple-tree/unhydratedFlexTreeFromInsertable.js.map +1 -1
  237. package/dist/simple-tree/unsafeUnknownSchema.d.ts +52 -0
  238. package/dist/simple-tree/unsafeUnknownSchema.d.ts.map +1 -0
  239. package/dist/simple-tree/unsafeUnknownSchema.js +13 -0
  240. package/dist/simple-tree/unsafeUnknownSchema.js.map +1 -0
  241. package/dist/simple-tree/walkFieldSchema.d.ts +1 -1
  242. package/dist/simple-tree/walkFieldSchema.js +2 -2
  243. package/dist/simple-tree/walkFieldSchema.js.map +1 -1
  244. package/dist/tableSchema.d.ts +12 -12
  245. package/dist/treeFactory.d.ts +0 -1
  246. package/dist/treeFactory.d.ts.map +1 -1
  247. package/dist/treeFactory.js +0 -1
  248. package/dist/treeFactory.js.map +1 -1
  249. package/lib/core/schema-stored/schema.d.ts +14 -1
  250. package/lib/core/schema-stored/schema.d.ts.map +1 -1
  251. package/lib/core/schema-stored/schema.js.map +1 -1
  252. package/lib/feature-libraries/default-schema/schemaChecker.d.ts.map +1 -1
  253. package/lib/feature-libraries/default-schema/schemaChecker.js +3 -0
  254. package/lib/feature-libraries/default-schema/schemaChecker.js.map +1 -1
  255. package/lib/feature-libraries/flex-tree/context.d.ts +7 -2
  256. package/lib/feature-libraries/flex-tree/context.d.ts.map +1 -1
  257. package/lib/feature-libraries/flex-tree/context.js +4 -4
  258. package/lib/feature-libraries/flex-tree/context.js.map +1 -1
  259. package/lib/feature-libraries/flex-tree/index.d.ts +1 -0
  260. package/lib/feature-libraries/flex-tree/index.d.ts.map +1 -1
  261. package/lib/feature-libraries/flex-tree/index.js +1 -0
  262. package/lib/feature-libraries/flex-tree/index.js.map +1 -1
  263. package/lib/feature-libraries/flex-tree/lazyField.d.ts.map +1 -1
  264. package/lib/feature-libraries/flex-tree/lazyField.js +6 -6
  265. package/lib/feature-libraries/flex-tree/lazyField.js.map +1 -1
  266. package/lib/feature-libraries/flex-tree/lazyNode.d.ts +3 -1
  267. package/lib/feature-libraries/flex-tree/lazyNode.d.ts.map +1 -1
  268. package/lib/feature-libraries/flex-tree/lazyNode.js +3 -1
  269. package/lib/feature-libraries/flex-tree/lazyNode.js.map +1 -1
  270. package/lib/feature-libraries/forest-summary/forestSummarizer.d.ts.map +1 -1
  271. package/lib/feature-libraries/forest-summary/forestSummarizer.js +1 -2
  272. package/lib/feature-libraries/forest-summary/forestSummarizer.js.map +1 -1
  273. package/lib/feature-libraries/index.d.ts +1 -1
  274. package/lib/feature-libraries/index.d.ts.map +1 -1
  275. package/lib/feature-libraries/index.js +1 -1
  276. package/lib/feature-libraries/index.js.map +1 -1
  277. package/lib/packageVersion.d.ts +1 -1
  278. package/lib/packageVersion.d.ts.map +1 -1
  279. package/lib/packageVersion.js +1 -1
  280. package/lib/packageVersion.js.map +1 -1
  281. package/lib/shared-tree/index.d.ts +0 -1
  282. package/lib/shared-tree/index.d.ts.map +1 -1
  283. package/lib/shared-tree/index.js +0 -1
  284. package/lib/shared-tree/index.js.map +1 -1
  285. package/lib/shared-tree/schematizeTree.d.ts.map +1 -1
  286. package/lib/shared-tree/schematizeTree.js +2 -6
  287. package/lib/shared-tree/schematizeTree.js.map +1 -1
  288. package/lib/shared-tree/schematizingTreeView.d.ts +11 -13
  289. package/lib/shared-tree/schematizingTreeView.d.ts.map +1 -1
  290. package/lib/shared-tree/schematizingTreeView.js +59 -81
  291. package/lib/shared-tree/schematizingTreeView.js.map +1 -1
  292. package/lib/shared-tree/sharedTreeChangeTypes.d.ts +1 -1
  293. package/lib/shared-tree/sharedTreeChangeTypes.js.map +1 -1
  294. package/lib/shared-tree/tree.d.ts.map +1 -1
  295. package/lib/shared-tree/tree.js +4 -3
  296. package/lib/shared-tree/tree.js.map +1 -1
  297. package/lib/shared-tree/treeAlpha.d.ts +7 -1
  298. package/lib/shared-tree/treeAlpha.d.ts.map +1 -1
  299. package/lib/shared-tree/treeAlpha.js.map +1 -1
  300. package/lib/shared-tree/treeCheckout.d.ts +7 -2
  301. package/lib/shared-tree/treeCheckout.d.ts.map +1 -1
  302. package/lib/shared-tree/treeCheckout.js +5 -2
  303. package/lib/shared-tree/treeCheckout.js.map +1 -1
  304. package/lib/simple-tree/api/conciseTree.d.ts +1 -1
  305. package/lib/simple-tree/api/conciseTree.d.ts.map +1 -1
  306. package/lib/simple-tree/api/conciseTree.js.map +1 -1
  307. package/lib/simple-tree/api/configuration.d.ts +1 -1
  308. package/lib/simple-tree/api/configuration.d.ts.map +1 -1
  309. package/lib/simple-tree/api/configuration.js +2 -2
  310. package/lib/simple-tree/api/configuration.js.map +1 -1
  311. package/lib/simple-tree/api/create.d.ts +3 -1
  312. package/lib/simple-tree/api/create.d.ts.map +1 -1
  313. package/lib/simple-tree/api/create.js +2 -0
  314. package/lib/simple-tree/api/create.js.map +1 -1
  315. package/lib/simple-tree/api/customTree.d.ts +1 -2
  316. package/lib/simple-tree/api/customTree.d.ts.map +1 -1
  317. package/lib/simple-tree/api/customTree.js.map +1 -1
  318. package/lib/simple-tree/api/getJsonSchema.d.ts +1 -1
  319. package/lib/simple-tree/api/getJsonSchema.d.ts.map +1 -1
  320. package/lib/simple-tree/api/getJsonSchema.js.map +1 -1
  321. package/lib/simple-tree/api/getSimpleSchema.d.ts +1 -1
  322. package/lib/simple-tree/api/getSimpleSchema.js.map +1 -1
  323. package/lib/simple-tree/api/identifierIndex.d.ts +1 -1
  324. package/lib/simple-tree/api/identifierIndex.js +1 -1
  325. package/lib/simple-tree/api/identifierIndex.js.map +1 -1
  326. package/lib/simple-tree/api/index.d.ts +1 -1
  327. package/lib/simple-tree/api/index.d.ts.map +1 -1
  328. package/lib/simple-tree/api/index.js.map +1 -1
  329. package/lib/simple-tree/api/schemaCompatibilityTester.d.ts +1 -1
  330. package/lib/simple-tree/api/schemaCompatibilityTester.js.map +1 -1
  331. package/lib/simple-tree/api/schemaCreationUtilities.d.ts +14 -2
  332. package/lib/simple-tree/api/schemaCreationUtilities.d.ts.map +1 -1
  333. package/lib/simple-tree/api/schemaCreationUtilities.js +40 -4
  334. package/lib/simple-tree/api/schemaCreationUtilities.js.map +1 -1
  335. package/lib/simple-tree/api/schemaFactory.d.ts +36 -3
  336. package/lib/simple-tree/api/schemaFactory.d.ts.map +1 -1
  337. package/lib/simple-tree/api/schemaFactory.js +2 -2
  338. package/lib/simple-tree/api/schemaFactory.js.map +1 -1
  339. package/lib/simple-tree/api/schemaFactoryAlpha.d.ts +16 -16
  340. package/lib/simple-tree/api/schemaFactoryAlpha.d.ts.map +1 -1
  341. package/lib/simple-tree/api/schemaFactoryAlpha.js.map +1 -1
  342. package/lib/simple-tree/api/schemaFactoryRecursive.d.ts +2 -2
  343. package/lib/simple-tree/api/schemaFactoryRecursive.d.ts.map +1 -1
  344. package/lib/simple-tree/api/schemaFactoryRecursive.js +1 -1
  345. package/lib/simple-tree/api/schemaFactoryRecursive.js.map +1 -1
  346. package/lib/simple-tree/api/schemaFromSimple.d.ts.map +1 -1
  347. package/lib/simple-tree/api/schemaFromSimple.js +1 -1
  348. package/lib/simple-tree/api/schemaFromSimple.js.map +1 -1
  349. package/lib/simple-tree/api/simpleSchemaToJsonSchema.js +1 -1
  350. package/lib/simple-tree/api/simpleSchemaToJsonSchema.js.map +1 -1
  351. package/lib/simple-tree/api/simpleTreeIndex.d.ts +2 -2
  352. package/lib/simple-tree/api/simpleTreeIndex.d.ts.map +1 -1
  353. package/lib/simple-tree/api/simpleTreeIndex.js +2 -2
  354. package/lib/simple-tree/api/simpleTreeIndex.js.map +1 -1
  355. package/lib/simple-tree/api/storedSchema.d.ts +1 -1
  356. package/lib/simple-tree/api/storedSchema.js +1 -1
  357. package/lib/simple-tree/api/storedSchema.js.map +1 -1
  358. package/lib/simple-tree/api/tree.d.ts +2 -1
  359. package/lib/simple-tree/api/tree.d.ts.map +1 -1
  360. package/lib/simple-tree/api/tree.js.map +1 -1
  361. package/lib/simple-tree/api/treeBeta.d.ts +4 -1
  362. package/lib/simple-tree/api/treeBeta.d.ts.map +1 -1
  363. package/lib/simple-tree/api/treeBeta.js.map +1 -1
  364. package/lib/simple-tree/api/treeNodeApi.d.ts +1 -2
  365. package/lib/simple-tree/api/treeNodeApi.d.ts.map +1 -1
  366. package/lib/simple-tree/api/treeNodeApi.js +2 -2
  367. package/lib/simple-tree/api/treeNodeApi.js.map +1 -1
  368. package/lib/simple-tree/api/typesUnsafe.d.ts +2 -3
  369. package/lib/simple-tree/api/typesUnsafe.d.ts.map +1 -1
  370. package/lib/simple-tree/api/typesUnsafe.js.map +1 -1
  371. package/lib/simple-tree/api/verboseTree.d.ts +2 -1
  372. package/lib/simple-tree/api/verboseTree.d.ts.map +1 -1
  373. package/lib/simple-tree/api/verboseTree.js.map +1 -1
  374. package/lib/simple-tree/api/viewSchemaToSimpleSchema.d.ts +1 -1
  375. package/lib/simple-tree/api/viewSchemaToSimpleSchema.js +1 -1
  376. package/lib/simple-tree/api/viewSchemaToSimpleSchema.js.map +1 -1
  377. package/lib/simple-tree/core/allowedTypes.d.ts +316 -0
  378. package/lib/simple-tree/core/allowedTypes.d.ts.map +1 -0
  379. package/lib/simple-tree/core/allowedTypes.js +162 -0
  380. package/lib/simple-tree/core/allowedTypes.js.map +1 -0
  381. package/lib/simple-tree/core/context.d.ts +3 -9
  382. package/lib/simple-tree/core/context.d.ts.map +1 -1
  383. package/lib/simple-tree/core/context.js +0 -8
  384. package/lib/simple-tree/core/context.js.map +1 -1
  385. package/lib/simple-tree/core/flexList.d.ts.map +1 -0
  386. package/lib/simple-tree/core/flexList.js.map +1 -0
  387. package/lib/simple-tree/core/getOrCreateNode.d.ts +1 -1
  388. package/lib/simple-tree/core/getOrCreateNode.d.ts.map +1 -1
  389. package/lib/simple-tree/core/getOrCreateNode.js.map +1 -1
  390. package/lib/simple-tree/core/index.d.ts +9 -3
  391. package/lib/simple-tree/core/index.d.ts.map +1 -1
  392. package/lib/simple-tree/core/index.js +6 -3
  393. package/lib/simple-tree/core/index.js.map +1 -1
  394. package/lib/simple-tree/core/treeNodeKernel.d.ts +8 -1
  395. package/lib/simple-tree/core/treeNodeKernel.d.ts.map +1 -1
  396. package/lib/simple-tree/core/treeNodeKernel.js +10 -6
  397. package/lib/simple-tree/core/treeNodeKernel.js.map +1 -1
  398. package/lib/simple-tree/core/treeNodeSchema.d.ts +182 -39
  399. package/lib/simple-tree/core/treeNodeSchema.d.ts.map +1 -1
  400. package/lib/simple-tree/core/treeNodeSchema.js +44 -14
  401. package/lib/simple-tree/core/treeNodeSchema.js.map +1 -1
  402. package/lib/simple-tree/{treeNodeValid.d.ts → core/treeNodeValid.d.ts} +18 -4
  403. package/lib/simple-tree/core/treeNodeValid.d.ts.map +1 -0
  404. package/lib/simple-tree/{treeNodeValid.js → core/treeNodeValid.js} +31 -3
  405. package/lib/simple-tree/core/treeNodeValid.js.map +1 -0
  406. package/lib/simple-tree/core/unhydratedFlexTree.d.ts +1 -1
  407. package/lib/simple-tree/core/unhydratedFlexTree.js.map +1 -1
  408. package/lib/simple-tree/core/walkSchema.d.ts +2 -1
  409. package/lib/simple-tree/core/walkSchema.d.ts.map +1 -1
  410. package/lib/simple-tree/core/walkSchema.js +7 -3
  411. package/lib/simple-tree/core/walkSchema.js.map +1 -1
  412. package/lib/simple-tree/createContext.d.ts +6 -2
  413. package/lib/simple-tree/createContext.d.ts.map +1 -1
  414. package/lib/simple-tree/createContext.js +13 -2
  415. package/lib/simple-tree/createContext.js.map +1 -1
  416. package/lib/simple-tree/fieldSchema.d.ts +423 -0
  417. package/lib/simple-tree/fieldSchema.d.ts.map +1 -0
  418. package/lib/simple-tree/{schemaTypes.js → fieldSchema.js} +3 -183
  419. package/lib/simple-tree/fieldSchema.js.map +1 -0
  420. package/lib/simple-tree/index.d.ts +5 -5
  421. package/lib/simple-tree/index.d.ts.map +1 -1
  422. package/lib/simple-tree/index.js +2 -2
  423. package/lib/simple-tree/index.js.map +1 -1
  424. package/lib/simple-tree/leafNodeSchema.d.ts +14 -5
  425. package/lib/simple-tree/leafNodeSchema.d.ts.map +1 -1
  426. package/lib/simple-tree/leafNodeSchema.js +117 -3
  427. package/lib/simple-tree/leafNodeSchema.js.map +1 -1
  428. package/lib/simple-tree/node-kinds/array/arrayNode.d.ts +3 -4
  429. package/lib/simple-tree/node-kinds/array/arrayNode.d.ts.map +1 -1
  430. package/lib/simple-tree/node-kinds/array/arrayNode.js +86 -15
  431. package/lib/simple-tree/node-kinds/array/arrayNode.js.map +1 -1
  432. package/lib/simple-tree/node-kinds/array/arrayNodeTypes.d.ts +2 -2
  433. package/lib/simple-tree/node-kinds/array/arrayNodeTypes.d.ts.map +1 -1
  434. package/lib/simple-tree/node-kinds/array/arrayNodeTypes.js +1 -1
  435. package/lib/simple-tree/node-kinds/array/arrayNodeTypes.js.map +1 -1
  436. package/lib/simple-tree/node-kinds/common.d.ts +16 -0
  437. package/lib/simple-tree/node-kinds/common.d.ts.map +1 -0
  438. package/lib/simple-tree/node-kinds/common.js +38 -0
  439. package/lib/simple-tree/node-kinds/common.js.map +1 -0
  440. package/lib/simple-tree/node-kinds/index.d.ts +1 -1
  441. package/lib/simple-tree/node-kinds/index.d.ts.map +1 -1
  442. package/lib/simple-tree/node-kinds/index.js.map +1 -1
  443. package/lib/simple-tree/node-kinds/map/mapNode.d.ts +2 -3
  444. package/lib/simple-tree/node-kinds/map/mapNode.d.ts.map +1 -1
  445. package/lib/simple-tree/node-kinds/map/mapNode.js +51 -13
  446. package/lib/simple-tree/node-kinds/map/mapNode.js.map +1 -1
  447. package/lib/simple-tree/node-kinds/map/mapNodeTypes.d.ts +2 -2
  448. package/lib/simple-tree/node-kinds/map/mapNodeTypes.d.ts.map +1 -1
  449. package/lib/simple-tree/node-kinds/map/mapNodeTypes.js +1 -1
  450. package/lib/simple-tree/node-kinds/map/mapNodeTypes.js.map +1 -1
  451. package/lib/simple-tree/node-kinds/object/index.d.ts +1 -1
  452. package/lib/simple-tree/node-kinds/object/index.d.ts.map +1 -1
  453. package/lib/simple-tree/node-kinds/object/index.js.map +1 -1
  454. package/lib/simple-tree/node-kinds/object/objectNode.d.ts +19 -5
  455. package/lib/simple-tree/node-kinds/object/objectNode.d.ts.map +1 -1
  456. package/lib/simple-tree/node-kinds/object/objectNode.js +116 -14
  457. package/lib/simple-tree/node-kinds/object/objectNode.js.map +1 -1
  458. package/lib/simple-tree/node-kinds/object/objectNodeTypes.d.ts +11 -4
  459. package/lib/simple-tree/node-kinds/object/objectNodeTypes.d.ts.map +1 -1
  460. package/lib/simple-tree/node-kinds/object/objectNodeTypes.js +1 -1
  461. package/lib/simple-tree/node-kinds/object/objectNodeTypes.js.map +1 -1
  462. package/lib/simple-tree/node-kinds/record/recordNode.d.ts +2 -2
  463. package/lib/simple-tree/node-kinds/record/recordNode.d.ts.map +1 -1
  464. package/lib/simple-tree/node-kinds/record/recordNode.js +40 -12
  465. package/lib/simple-tree/node-kinds/record/recordNode.js.map +1 -1
  466. package/lib/simple-tree/node-kinds/record/recordNodeTypes.d.ts +2 -2
  467. package/lib/simple-tree/node-kinds/record/recordNodeTypes.d.ts.map +1 -1
  468. package/lib/simple-tree/node-kinds/record/recordNodeTypes.js +1 -1
  469. package/lib/simple-tree/node-kinds/record/recordNodeTypes.js.map +1 -1
  470. package/lib/simple-tree/prepareForInsertion.d.ts +2 -2
  471. package/lib/simple-tree/prepareForInsertion.d.ts.map +1 -1
  472. package/lib/simple-tree/prepareForInsertion.js +2 -2
  473. package/lib/simple-tree/prepareForInsertion.js.map +1 -1
  474. package/lib/simple-tree/simpleSchema.d.ts +2 -2
  475. package/lib/simple-tree/simpleSchema.d.ts.map +1 -1
  476. package/lib/simple-tree/simpleSchema.js.map +1 -1
  477. package/lib/simple-tree/toStoredSchema.d.ts +1 -1
  478. package/lib/simple-tree/toStoredSchema.d.ts.map +1 -1
  479. package/lib/simple-tree/toStoredSchema.js +2 -3
  480. package/lib/simple-tree/toStoredSchema.js.map +1 -1
  481. package/lib/simple-tree/unhydratedFlexTreeFromInsertable.d.ts +5 -11
  482. package/lib/simple-tree/unhydratedFlexTreeFromInsertable.d.ts.map +1 -1
  483. package/lib/simple-tree/unhydratedFlexTreeFromInsertable.js +10 -381
  484. package/lib/simple-tree/unhydratedFlexTreeFromInsertable.js.map +1 -1
  485. package/lib/simple-tree/unsafeUnknownSchema.d.ts +52 -0
  486. package/lib/simple-tree/unsafeUnknownSchema.d.ts.map +1 -0
  487. package/lib/simple-tree/unsafeUnknownSchema.js +10 -0
  488. package/lib/simple-tree/unsafeUnknownSchema.js.map +1 -0
  489. package/lib/simple-tree/walkFieldSchema.d.ts +1 -1
  490. package/lib/simple-tree/walkFieldSchema.js +1 -1
  491. package/lib/simple-tree/walkFieldSchema.js.map +1 -1
  492. package/lib/tableSchema.d.ts +12 -12
  493. package/lib/treeFactory.d.ts +0 -1
  494. package/lib/treeFactory.d.ts.map +1 -1
  495. package/lib/treeFactory.js +0 -1
  496. package/lib/treeFactory.js.map +1 -1
  497. package/package.json +22 -23
  498. package/src/core/schema-stored/schema.ts +14 -1
  499. package/src/feature-libraries/default-schema/schemaChecker.ts +3 -0
  500. package/src/feature-libraries/flex-tree/context.ts +10 -5
  501. package/src/feature-libraries/flex-tree/index.ts +2 -0
  502. package/src/feature-libraries/flex-tree/lazyField.ts +10 -6
  503. package/src/feature-libraries/flex-tree/lazyNode.ts +6 -1
  504. package/src/feature-libraries/forest-summary/forestSummarizer.ts +1 -2
  505. package/src/feature-libraries/index.ts +1 -0
  506. package/src/packageVersion.ts +1 -1
  507. package/src/shared-tree/index.ts +0 -2
  508. package/src/shared-tree/schematizeTree.ts +2 -6
  509. package/src/shared-tree/schematizingTreeView.ts +72 -107
  510. package/src/shared-tree/sharedTreeChangeTypes.ts +1 -1
  511. package/src/shared-tree/tree.ts +4 -3
  512. package/src/shared-tree/treeAlpha.ts +7 -1
  513. package/src/shared-tree/treeCheckout.ts +15 -2
  514. package/src/simple-tree/api/conciseTree.ts +1 -2
  515. package/src/simple-tree/api/configuration.ts +7 -4
  516. package/src/simple-tree/api/create.ts +3 -1
  517. package/src/simple-tree/api/customTree.ts +1 -2
  518. package/src/simple-tree/api/getJsonSchema.ts +1 -1
  519. package/src/simple-tree/api/getSimpleSchema.ts +1 -1
  520. package/src/simple-tree/api/identifierIndex.ts +1 -1
  521. package/src/simple-tree/api/index.ts +2 -0
  522. package/src/simple-tree/api/schemaCompatibilityTester.ts +1 -1
  523. package/src/simple-tree/api/schemaCreationUtilities.ts +47 -5
  524. package/src/simple-tree/api/schemaFactory.ts +45 -10
  525. package/src/simple-tree/api/schemaFactoryAlpha.ts +4 -7
  526. package/src/simple-tree/api/schemaFactoryRecursive.ts +9 -4
  527. package/src/simple-tree/api/schemaFromSimple.ts +2 -3
  528. package/src/simple-tree/api/simpleSchemaToJsonSchema.ts +1 -1
  529. package/src/simple-tree/api/simpleTreeIndex.ts +8 -3
  530. package/src/simple-tree/api/storedSchema.ts +1 -1
  531. package/src/simple-tree/api/tree.ts +2 -2
  532. package/src/simple-tree/api/treeBeta.ts +4 -1
  533. package/src/simple-tree/api/treeNodeApi.ts +5 -8
  534. package/src/simple-tree/api/typesUnsafe.ts +5 -4
  535. package/src/simple-tree/api/verboseTree.ts +3 -6
  536. package/src/simple-tree/api/viewSchemaToSimpleSchema.ts +1 -1
  537. package/src/simple-tree/core/README.md +1 -1
  538. package/src/simple-tree/core/allowedTypes.ts +496 -0
  539. package/src/simple-tree/core/context.ts +3 -10
  540. package/src/simple-tree/core/getOrCreateNode.ts +1 -1
  541. package/src/simple-tree/core/index.ts +62 -9
  542. package/src/simple-tree/core/treeNodeKernel.ts +12 -6
  543. package/src/simple-tree/core/treeNodeSchema.ts +247 -63
  544. package/src/simple-tree/{treeNodeValid.ts → core/treeNodeValid.ts} +59 -15
  545. package/src/simple-tree/core/unhydratedFlexTree.ts +1 -1
  546. package/src/simple-tree/core/walkSchema.ts +9 -5
  547. package/src/simple-tree/createContext.ts +26 -2
  548. package/src/simple-tree/fieldSchema.ts +734 -0
  549. package/src/simple-tree/index.ts +32 -30
  550. package/src/simple-tree/leafNodeSchema.ts +137 -5
  551. package/src/simple-tree/node-kinds/array/arrayNode.ts +141 -30
  552. package/src/simple-tree/node-kinds/array/arrayNodeTypes.ts +5 -7
  553. package/src/simple-tree/node-kinds/common.ts +60 -0
  554. package/src/simple-tree/node-kinds/index.ts +1 -0
  555. package/src/simple-tree/node-kinds/map/mapNode.ts +91 -33
  556. package/src/simple-tree/node-kinds/map/mapNodeTypes.ts +5 -7
  557. package/src/simple-tree/node-kinds/object/index.ts +1 -0
  558. package/src/simple-tree/node-kinds/object/objectNode.ts +205 -25
  559. package/src/simple-tree/node-kinds/object/objectNodeTypes.ts +22 -5
  560. package/src/simple-tree/node-kinds/record/recordNode.ts +68 -26
  561. package/src/simple-tree/node-kinds/record/recordNodeTypes.ts +6 -8
  562. package/src/simple-tree/prepareForInsertion.ts +7 -6
  563. package/src/simple-tree/simpleSchema.ts +2 -2
  564. package/src/simple-tree/toStoredSchema.ts +2 -3
  565. package/src/simple-tree/unhydratedFlexTreeFromInsertable.ts +12 -494
  566. package/src/simple-tree/unsafeUnknownSchema.ts +70 -0
  567. package/src/simple-tree/walkFieldSchema.ts +1 -1
  568. package/src/treeFactory.ts +0 -1
  569. package/dist/shared-tree/checkoutFlexTreeView.d.ts +0 -58
  570. package/dist/shared-tree/checkoutFlexTreeView.d.ts.map +0 -1
  571. package/dist/shared-tree/checkoutFlexTreeView.js +0 -77
  572. package/dist/shared-tree/checkoutFlexTreeView.js.map +0 -1
  573. package/dist/simple-tree/flexList.d.ts.map +0 -1
  574. package/dist/simple-tree/flexList.js.map +0 -1
  575. package/dist/simple-tree/schemaTypes.d.ts +0 -856
  576. package/dist/simple-tree/schemaTypes.d.ts.map +0 -1
  577. package/dist/simple-tree/schemaTypes.js.map +0 -1
  578. package/dist/simple-tree/treeNodeValid.d.ts.map +0 -1
  579. package/dist/simple-tree/treeNodeValid.js.map +0 -1
  580. package/lib/shared-tree/checkoutFlexTreeView.d.ts +0 -58
  581. package/lib/shared-tree/checkoutFlexTreeView.d.ts.map +0 -1
  582. package/lib/shared-tree/checkoutFlexTreeView.js +0 -72
  583. package/lib/shared-tree/checkoutFlexTreeView.js.map +0 -1
  584. package/lib/simple-tree/flexList.d.ts.map +0 -1
  585. package/lib/simple-tree/flexList.js.map +0 -1
  586. package/lib/simple-tree/schemaTypes.d.ts +0 -856
  587. package/lib/simple-tree/schemaTypes.d.ts.map +0 -1
  588. package/lib/simple-tree/schemaTypes.js.map +0 -1
  589. package/lib/simple-tree/treeNodeValid.d.ts.map +0 -1
  590. package/lib/simple-tree/treeNodeValid.js.map +0 -1
  591. package/src/shared-tree/checkoutFlexTreeView.ts +0 -100
  592. package/src/simple-tree/schemaTypes.ts +0 -1420
  593. /package/dist/simple-tree/{flexList.d.ts → core/flexList.d.ts} +0 -0
  594. /package/dist/simple-tree/{flexList.js → core/flexList.js} +0 -0
  595. /package/lib/simple-tree/{flexList.d.ts → core/flexList.d.ts} +0 -0
  596. /package/lib/simple-tree/{flexList.js → core/flexList.js} +0 -0
  597. /package/src/simple-tree/{flexList.ts → core/flexList.ts} +0 -0
@@ -18,10 +18,16 @@ export declare function singletonSchema<TScope extends string, TName extends str
18
18
  }, Record<string, never>, true, Record<string, never>, undefined>;
19
19
  /**
20
20
  * Converts an enum into a collection of schema which can be used in a union.
21
+ *
22
+ * @typeParam TScope - The scope of the provided factory.
23
+ * There is a known issue where if a factory is provided that is typed as a {@link SchemaFactoryAlpha}, and its scope contains a "." character,
24
+ * the inferred type for the scope will end up as a union of the scope up to the first "." character and the scope as it should be.
25
+ * This can be mitigated by explicitly providing the TScope type parameter or by typing the provided factory as a {@link SchemaFactory} instead of a {@link SchemaFactoryAlpha}.
26
+ *
21
27
  * @remarks
22
28
  * The string value of the enum is used as the name of the schema: callers must ensure that it is stable and unique.
23
29
  * Numeric enums values have the value implicitly converted into a string.
24
- * Consider making a dedicated schema factory with a nested scope to avoid the enum members colliding with other schema.
30
+ * Consider making a dedicated schema factory with a nested scope (for example using {@link SchemaFactoryAlpha.scopedFactory}) to avoid the enum members colliding with other schema.
25
31
  * @example
26
32
  * ```typescript
27
33
  * const schemaFactory = new SchemaFactory("com.myApp");
@@ -52,7 +58,8 @@ export declare function singletonSchema<TScope extends string, TName extends str
52
58
  * }
53
59
  * ```
54
60
  * @privateRemarks
55
- * Maybe provide `SchemaFactory.nested` to ease creating nested scopes?
61
+ * TODO: AB#43345: see TScope known issue above, and other references to this work item.
62
+ *
56
63
  * @see {@link enumFromStrings} for a similar function that works on arrays of strings instead of an enum.
57
64
  * @beta
58
65
  */
@@ -65,6 +72,11 @@ export declare function adaptEnum<TScope extends string, const TEnum extends Rec
65
72
  readonly value: TEnum[Property];
66
73
  }, Record<string, never>, true, Record<string, never>, undefined>; }[keyof TEnum]>;
67
74
  };
75
+ /**
76
+ * Returns en "entries" (like Object.entries) for an enum object, omitting the
77
+ * {@link https://www.typescriptlang.org/docs/handbook/enums.html#reverse-mappings|reverse mappings}
78
+ */
79
+ export declare function enumEntries(enumObject: Record<string, string | number>): [string, string | number][];
68
80
  /**
69
81
  * Converts an array of distinct strings into a collection of schema which can be used like an enum style union.
70
82
  * @remarks
@@ -1 +1 @@
1
- {"version":3,"file":"schemaCreationUtilities.d.ts","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaCreationUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE1E,OAAO,KAAK,EAEX,QAAQ,EACR,QAAQ,EAER,mBAAmB,EACnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAWxD;;;;;;;GAOG;AAGH,wBAAgB,eAAe,CAAC,MAAM,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,GAAG,MAAM,EACnF,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EACrC,IAAI,EAAE,KAAK;oBAW2C,KAAK;kEAkB3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,wBAAgB,SAAS,CACxB,MAAM,SAAS,MAAM,EACrB,KAAK,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAClD,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,+CAsBG,MAAM;;;;;;;;EA4BxD;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,wBAAgB,eAAe,CAC9B,MAAM,SAAS,MAAM,EACrB,KAAK,CAAC,OAAO,SAAS,SAAS,MAAM,EAAE,EACtC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,4CAoBO,MAAM;;;;;;;;EA+B9D"}
1
+ {"version":3,"file":"schemaCreationUtilities.d.ts","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaCreationUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,KAAK,EAGX,QAAQ,EACR,QAAQ,EAER,mBAAmB,EACnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAWxD;;;;;;;GAOG;AAGH,wBAAgB,eAAe,CAAC,MAAM,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,GAAG,MAAM,EACnF,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EACrC,IAAI,EAAE,KAAK;oBAiB2C,KAAK;kEAkB3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,wBAAgB,SAAS,CACxB,MAAM,SAAS,MAAM,EACrB,KAAK,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAClD,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,+CAsBG,MAAM;;;;;;;;EA4BxD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAC1B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACzC,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,CAqB7B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,wBAAgB,eAAe,CAC9B,MAAM,SAAS,MAAM,EACrB,KAAK,CAAC,OAAO,SAAS,SAAS,MAAM,EAAE,EACtC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,4CAoBO,MAAM;;;;;;;;EA+B9D"}
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { UsageError } from "@fluidframework/telemetry-utils/internal";
6
- import { fail } from "@fluidframework/core-utils/internal";
6
+ import { assert, fail } from "@fluidframework/core-utils/internal";
7
7
  /*
8
8
  * This file does two things:
9
9
  *
@@ -23,6 +23,7 @@ import { fail } from "@fluidframework/core-utils/internal";
23
23
  // Return type is intentionally derived.
24
24
  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
25
25
  export function singletonSchema(factory, name) {
26
+ var _a;
26
27
  class SingletonSchema extends factory.object(name, {}) {
27
28
  constructor(data) {
28
29
  super(data ?? {});
@@ -30,7 +31,12 @@ export function singletonSchema(factory, name) {
30
31
  get value() {
31
32
  return name;
32
33
  }
34
+ static toString() {
35
+ return `SingletonSchema(${name})`;
36
+ }
33
37
  }
38
+ _a = Symbol.toStringTag;
39
+ SingletonSchema[_a] = `SingletonSchema(${name})`;
34
40
  // Returning SingletonSchema without a type conversion results in TypeScript generating something like `readonly "__#124291@#brand": unknown;`
35
41
  // for the private brand field of TreeNode.
36
42
  // This numeric id doesn't seem to be stable over incremental builds, and thus causes diffs in the API extractor reports.
@@ -41,10 +47,16 @@ export function singletonSchema(factory, name) {
41
47
  }
42
48
  /**
43
49
  * Converts an enum into a collection of schema which can be used in a union.
50
+ *
51
+ * @typeParam TScope - The scope of the provided factory.
52
+ * There is a known issue where if a factory is provided that is typed as a {@link SchemaFactoryAlpha}, and its scope contains a "." character,
53
+ * the inferred type for the scope will end up as a union of the scope up to the first "." character and the scope as it should be.
54
+ * This can be mitigated by explicitly providing the TScope type parameter or by typing the provided factory as a {@link SchemaFactory} instead of a {@link SchemaFactoryAlpha}.
55
+ *
44
56
  * @remarks
45
57
  * The string value of the enum is used as the name of the schema: callers must ensure that it is stable and unique.
46
58
  * Numeric enums values have the value implicitly converted into a string.
47
- * Consider making a dedicated schema factory with a nested scope to avoid the enum members colliding with other schema.
59
+ * Consider making a dedicated schema factory with a nested scope (for example using {@link SchemaFactoryAlpha.scopedFactory}) to avoid the enum members colliding with other schema.
48
60
  * @example
49
61
  * ```typescript
50
62
  * const schemaFactory = new SchemaFactory("com.myApp");
@@ -75,7 +87,8 @@ export function singletonSchema(factory, name) {
75
87
  * }
76
88
  * ```
77
89
  * @privateRemarks
78
- * Maybe provide `SchemaFactory.nested` to ease creating nested scopes?
90
+ * TODO: AB#43345: see TScope known issue above, and other references to this work item.
91
+ *
79
92
  * @see {@link enumFromStrings} for a similar function that works on arrays of strings instead of an enum.
80
93
  * @beta
81
94
  */
@@ -94,7 +107,7 @@ export function adaptEnum(factory, members) {
94
107
  ]();
95
108
  };
96
109
  const out = factoryOut;
97
- for (const [key, value] of Object.entries(members)) {
110
+ for (const [key, value] of enumEntries(members)) {
98
111
  const schema = singletonSchema(factory, value);
99
112
  schemaArray.push(schema);
100
113
  Object.defineProperty(out, key, {
@@ -112,6 +125,29 @@ export function adaptEnum(factory, members) {
112
125
  });
113
126
  return out;
114
127
  }
128
+ /**
129
+ * Returns en "entries" (like Object.entries) for an enum object, omitting the
130
+ * {@link https://www.typescriptlang.org/docs/handbook/enums.html#reverse-mappings|reverse mappings}
131
+ */
132
+ export function enumEntries(enumObject) {
133
+ // Skip reverse mapping for numeric entries.
134
+ // For numeric entries, TypeScript defines an additional property keyed with the number implicitly converted to a string.
135
+ // Note TypeScript can overwrite its own enum entries in some edge cases (see https://github.com/microsoft/TypeScript/issues/48956), so it's not possible to handle all cases correctly.
136
+ return Object.entries(enumObject).filter(([key, value]) => {
137
+ // All reverse mapping must also have a inverse mapping (the regular forward mapping) to a number:
138
+ const inverse = enumObject[value];
139
+ if (typeof inverse !== "number") {
140
+ // Known not to be a reverse mapping, so keep it.
141
+ return true;
142
+ }
143
+ // At this point, it is expected that all remaining cases are reverse mappings,
144
+ // but do some asserts to ensure that the above logic is sufficient.
145
+ assert(typeof value === "string", "expected reverse mapping and thus a string value");
146
+ assert(Number.parseFloat(key).toString() === key, "expected reverse mapping and thus a key that is a normalized number");
147
+ // Discard the reverse mapping.
148
+ return false;
149
+ });
150
+ }
115
151
  /**
116
152
  * Converts an array of distinct strings into a collection of schema which can be used like an enum style union.
117
153
  * @remarks
@@ -1 +1 @@
1
- {"version":3,"file":"schemaCreationUtilities.js","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaCreationUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAC;AAa3D;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,wCAAwC;AACxC,4EAA4E;AAC5E,MAAM,UAAU,eAAe,CAC9B,OAAqC,EACrC,IAAW;IAEX,MAAM,eAAgB,SAAQ,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QACrD,YAAmB,IAA+C;YACjE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QACnB,CAAC;QACD,IAAW,KAAK;YACf,OAAO,IAAI,CAAC;QACb,CAAC;KACD;IAID,8IAA8I;IAC9I,2CAA2C;IAC3C,yHAAyH;IACzH,iDAAiD;IACjD,qFAAqF;IACrF,MAAM,QAAQ,GAQV,eAAe,CAAC;IAEpB,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,4EAA4E;AAC5E,MAAM,UAAU,SAAS,CAGvB,OAA8B,EAAE,OAAc;IAE/C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAa,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAGlF,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,IAAI,UAAU,CAAC,iDAAiD,CAAC,CAAC;IACzE,CAAC;IASD,MAAM,WAAW,GAAqB,EAAE,CAAC;IAEzC,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAAwB,KAAa,EAAE,EAAE;QAC3D,OAAO,IAAI,GAAG,CACb,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC;QAC1D,oIAAoI;SACpI,EAEO,CAAC;IACV,CAAC,CAAC;IACF,MAAM,GAAG,GAAG,UAAyE,CAAC;IACtF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;YAC/B,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM;SACb,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE;QACpC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;QACnB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACZ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,4EAA4E;AAC5E,MAAM,UAAU,eAAe,CAG7B,OAA8B,EAAE,OAAgB;IACjD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IAeD,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAA8B,KAAa,EAAE,EAAE;QACjE,oIAAoI;QACpI,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,EAEnB,CAAC;IACV,CAAC,CAAC;IAGF,MAAM,WAAW,GAAqB,EAAE,CAAC;IAEzC,MAAM,GAAG,GAAG,UAAyE,CAAC;IACtF,MAAM,SAAS,GAAG,GAA8C,CAAC;IACjE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC9C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE;YAChC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM;SACb,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE;QACpC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;QACnB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,2HAA2H;AAC3H,4GAA4G;AAC5G,4EAA4E;AAC5E,SAAS,iBAAiB,CACzB,OAA8B,EAC9B,OAAgB;IAEhB,MAAM,UAAU,GAIZ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,IAAI;SACX,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { fail } from \"@fluidframework/core-utils/internal\";\n\nimport type { SchemaFactory, ScopedSchemaName } from \"./schemaFactory.js\";\nimport type { NodeFromSchema } from \"../schemaTypes.js\";\nimport type {\n\tInternalTreeNode,\n\tNodeKind,\n\tTreeNode,\n\tTreeNodeSchema,\n\tTreeNodeSchemaClass,\n} from \"../core/index.js\";\nimport type { UnionToTuple } from \"../../util/index.js\";\n\n/*\n * This file does two things:\n *\n * 1. Provides tools for making schema for cases like enums.\n *\n * 2. Demonstrates the kinds of schema utilities apps can write.\n * Nothing in here needs access to package internal APIs.\n */\n\n/**\n * Create a schema for a node with no state.\n * @remarks\n * This is commonly used in unions when the only information needed is which kind of node the value is.\n * Enums are a common example of this pattern.\n * @see {@link adaptEnum}\n * @beta\n */\n// Return type is intentionally derived.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function singletonSchema<TScope extends string, TName extends string | number>(\n\tfactory: SchemaFactory<TScope, TName>,\n\tname: TName,\n) {\n\tclass SingletonSchema extends factory.object(name, {}) {\n\t\tpublic constructor(data?: InternalTreeNode | Record<string, never>) {\n\t\t\tsuper(data ?? {});\n\t\t}\n\t\tpublic get value(): TName {\n\t\t\treturn name;\n\t\t}\n\t}\n\n\ttype SingletonNodeType = TreeNode & { readonly value: TName };\n\n\t// Returning SingletonSchema without a type conversion results in TypeScript generating something like `readonly \"__#124291@#brand\": unknown;`\n\t// for the private brand field of TreeNode.\n\t// This numeric id doesn't seem to be stable over incremental builds, and thus causes diffs in the API extractor reports.\n\t// This is avoided by doing this type conversion.\n\t// The conversion is done via assignment instead of `as` to get stronger type safety.\n\tconst toReturn: TreeNodeSchemaClass<\n\t\tScopedSchemaName<TScope, TName>,\n\t\tNodeKind.Object,\n\t\tSingletonNodeType,\n\t\tRecord<string, never>,\n\t\ttrue,\n\t\tRecord<string, never>,\n\t\tundefined\n\t> = SingletonSchema;\n\n\treturn toReturn;\n}\n\n/**\n * Converts an enum into a collection of schema which can be used in a union.\n * @remarks\n * The string value of the enum is used as the name of the schema: callers must ensure that it is stable and unique.\n * Numeric enums values have the value implicitly converted into a string.\n * Consider making a dedicated schema factory with a nested scope to avoid the enum members colliding with other schema.\n * @example\n * ```typescript\n * const schemaFactory = new SchemaFactory(\"com.myApp\");\n * // An enum for use in the tree. Must have string keys.\n * enum Mode {\n * \ta = \"A\",\n * \tb = \"B\",\n * }\n * // Define the schema for each member of the enum using a nested scope to group them together.\n * const ModeNodes = adaptEnum(new SchemaFactory(`${schemaFactory.scope}.Mode`), Mode);\n * // Defined the types of the nodes which correspond to this the schema.\n * type ModeNodes = TreeNodeFromImplicitAllowedTypes<(typeof ModeNodes.schema)>;\n * // An example schema which has an enum as a child.\n * class Parent extends schemaFactory.object(\"Parent\", {\n * \t// adaptEnum's return value has a \".schema\" property can be use as an `AllowedTypes` array allowing any of the members of the enum.\n * \tmode: ModeNodes.schema,\n * }) {}\n *\n * // Example usage of enum based nodes, showing what type to use and that `.value` can be used to read out the enum value.\n * function getValue(node: ModeNodes): Mode {\n * \treturn node.value;\n * }\n *\n * // Example constructing a tree containing an enum node from an enum value.\n * // The syntax `new ModeNodes.a()` is also supported.\n * function setValue(node: Parent): void {\n * \tnode.mode = ModeNodes(Mode.a);\n * }\n * ```\n * @privateRemarks\n * Maybe provide `SchemaFactory.nested` to ease creating nested scopes?\n * @see {@link enumFromStrings} for a similar function that works on arrays of strings instead of an enum.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function adaptEnum<\n\tTScope extends string,\n\tconst TEnum extends Record<string, string | number>,\n>(factory: SchemaFactory<TScope>, members: TEnum) {\n\ttype Values = TEnum[keyof TEnum];\n\tconst values = Object.values(members) as Values[];\n\tconst inverse = new Map(Object.entries(members).map(([key, value]) => [value, key])) as Map<\n\t\tValues,\n\t\tkeyof TEnum\n\t>;\n\n\tif (inverse.size !== values.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct values.\");\n\t}\n\n\ttype TOut = {\n\t\treadonly [Property in keyof TEnum]: ReturnType<\n\t\t\ttypeof singletonSchema<TScope, TEnum[Property]>\n\t\t>;\n\t};\n\n\ttype SchemaArray = UnionToTuple<TOut[keyof TEnum]>;\n\tconst schemaArray: TreeNodeSchema[] = [];\n\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends Values>(value: TValue) => {\n\t\treturn new out[\n\t\t\tinverse.get(value) ?? fail(0xb31 /* missing enum value */)\n\t\t\t// \"extends unknown\" is required here to handle when TValue is an union: each member of the union should be processed independently.\n\t\t]() as TValue extends unknown\n\t\t\t? NodeFromSchema<ReturnType<typeof singletonSchema<TScope, TValue>>>\n\t\t\t: never;\n\t};\n\tconst out = factoryOut as typeof factoryOut & TOut & { readonly schema: SchemaArray };\n\tfor (const [key, value] of Object.entries(members)) {\n\t\tconst schema = singletonSchema(factory, value);\n\t\tschemaArray.push(schema);\n\t\tObject.defineProperty(out, key, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: schema,\n\t\t});\n\t}\n\n\tObject.defineProperty(out, \"schema\", {\n\t\tenumerable: true,\n\t\tconfigurable: false,\n\t\twritable: false,\n\t\tvalue: schemaArray,\n\t});\n\n\treturn out;\n}\n\n/**\n * Converts an array of distinct strings into a collection of schema which can be used like an enum style union.\n * @remarks\n * The returned collection is also a function which can be used to convert strings into {@link Unhydrated} nodes in the union.\n * Each node type has a `.value` getter which returns the associated string.\n *\n * The produced nodes use the provided strings as their `name`, and don't store any data beyond that.\n * @example\n * ```typescript\n * const schemaFactory = new SchemaFactory(\"com.myApp\");\n * const Mode = enumFromStrings(schemaFactory, [\"Fun\", \"Cool\"]);\n * type Mode = TreeNodeFromImplicitAllowedTypes<typeof Mode.schema>;\n * const nodeFromString: Mode = Mode(\"Fun\");\n * const nodeFromSchema: Mode = new Mode.Fun();\n *\n * // Schema nodes have a strongly typed `.value` property.\n * const nameFromNode: \"Fun\" | \"Cool\" = nodeFromSchema.value;\n *\n * class Parent extends schemaFactory.object(\"Parent\", { mode: Mode.schema }) {}\n * ```\n * @see {@link adaptEnum} for a similar function that works on enums instead of arrays of strings.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function enumFromStrings<\n\tTScope extends string,\n\tconst Members extends readonly string[],\n>(factory: SchemaFactory<TScope>, members: Members) {\n\tconst names = new Set(members);\n\tif (names.size !== members.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct names\");\n\t}\n\n\ttype MembersUnion = Members[number];\n\n\t// Get all keys of the Members tuple which are numeric strings as union of numbers:\n\ttype Indexes = Extract<keyof Members, `${number}`> extends `${infer N extends number}`\n\t\t? N\n\t\t: never;\n\n\ttype TOut = {\n\t\t[Index in Indexes as Members[Index]]: ReturnType<\n\t\t\ttypeof singletonSchema<TScope, Members[Index] & string>\n\t\t>;\n\t};\n\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends MembersUnion>(value: TValue) => {\n\t\t// \"extends unknown\" is required here to handle when TValue is an union: each member of the union should be processed independently.\n\t\treturn new recordOut[value]() as TValue extends unknown\n\t\t\t? NodeFromSchema<ReturnType<typeof singletonSchema<TScope, TValue>>>\n\t\t\t: never;\n\t};\n\n\ttype SchemaArray = UnionToTuple<MembersUnion extends unknown ? TOut[MembersUnion] : never>;\n\tconst schemaArray: TreeNodeSchema[] = [];\n\n\tconst out = factoryOut as typeof factoryOut & TOut & { readonly schema: SchemaArray };\n\tconst recordOut = out as Record<MembersUnion, new () => unknown>;\n\tfor (const name of members) {\n\t\tconst schema = singletonSchema(factory, name);\n\t\tschemaArray.push(schema);\n\t\tObject.defineProperty(out, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: schema,\n\t\t});\n\t}\n\n\tObject.defineProperty(out, \"schema\", {\n\t\tenumerable: true,\n\t\tconfigurable: false,\n\t\twritable: false,\n\t\tvalue: schemaArray,\n\t});\n\n\treturn out;\n}\n\n// TODO: This generates an invalid d.ts file if exported due to a bug https://github.com/microsoft/TypeScript/issues/58688.\n// TODO: replace enumFromStrings above with this simpler implementation when the TypeScript bug is resolved.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nfunction _enumFromStrings2<TScope extends string, const Members extends readonly string[]>(\n\tfactory: SchemaFactory<TScope>,\n\tmembers: Members,\n) {\n\tconst enumObject: {\n\t\t[key in keyof Members as Members[key] extends string\n\t\t\t? Members[key]\n\t\t\t: string]: Members[key] extends string ? Members[key] : string;\n\t} = Object.create(null);\n\tfor (const name of members) {\n\t\tObject.defineProperty(enumObject, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: name,\n\t\t});\n\t}\n\n\treturn adaptEnum(factory, enumObject);\n}\n"]}
1
+ {"version":3,"file":"schemaCreationUtilities.js","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaCreationUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAC;AAanE;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,wCAAwC;AACxC,4EAA4E;AAC5E,MAAM,UAAU,eAAe,CAC9B,OAAqC,EACrC,IAAW;;IAEX,MAAM,eAAgB,SAAQ,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QACrD,YAAmB,IAA+C;YACjE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QACnB,CAAC;QACD,IAAW,KAAK;YACf,OAAO,IAAI,CAAC;QACb,CAAC;QAEM,MAAM,CAAU,QAAQ;YAC9B,OAAO,mBAAmB,IAAI,GAAG,CAAC;QACnC,CAAC;;SAEc,MAAM,CAAC,WAAW;IAAnB,mBAAoB,GAAG,mBAAmB,IAAI,GAAG,CAAC;IAKjE,8IAA8I;IAC9I,2CAA2C;IAC3C,yHAAyH;IACzH,iDAAiD;IACjD,qFAAqF;IACrF,MAAM,QAAQ,GAQV,eAAe,CAAC;IAEpB,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,4EAA4E;AAC5E,MAAM,UAAU,SAAS,CAGvB,OAA8B,EAAE,OAAc;IAE/C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAa,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAGlF,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,IAAI,UAAU,CAAC,iDAAiD,CAAC,CAAC;IACzE,CAAC;IASD,MAAM,WAAW,GAAqB,EAAE,CAAC;IAEzC,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAAwB,KAAa,EAAE,EAAE;QAC3D,OAAO,IAAI,GAAG,CACb,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC;QAC1D,oIAAoI;SACpI,EAEO,CAAC;IACV,CAAC,CAAC;IACF,MAAM,GAAG,GAAG,UAAyE,CAAC;IACtF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;YAC/B,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM;SACb,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE;QACpC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;QACnB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAC1B,UAA2C;IAE3C,4CAA4C;IAC5C,yHAAyH;IACzH,wLAAwL;IACxL,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACzD,kGAAkG;QAClG,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACjC,iDAAiD;YACjD,OAAO,IAAI,CAAC;QACb,CAAC;QACD,+EAA+E;QAC/E,oEAAoE;QACpE,MAAM,CAAC,OAAO,KAAK,KAAK,QAAQ,EAAE,kDAAkD,CAAC,CAAC;QACtF,MAAM,CACL,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,GAAG,EACzC,qEAAqE,CACrE,CAAC;QACF,+BAA+B;QAC/B,OAAO,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,4EAA4E;AAC5E,MAAM,UAAU,eAAe,CAG7B,OAA8B,EAAE,OAAgB;IACjD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IAeD,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAA8B,KAAa,EAAE,EAAE;QACjE,oIAAoI;QACpI,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,EAEnB,CAAC;IACV,CAAC,CAAC;IAGF,MAAM,WAAW,GAAqB,EAAE,CAAC;IAEzC,MAAM,GAAG,GAAG,UAAyE,CAAC;IACtF,MAAM,SAAS,GAAG,GAA8C,CAAC;IACjE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC9C,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE;YAChC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM;SACb,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE;QACpC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;QACnB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,2HAA2H;AAC3H,4GAA4G;AAC5G,4EAA4E;AAC5E,SAAS,iBAAiB,CACzB,OAA8B,EAC9B,OAAgB;IAEhB,MAAM,UAAU,GAIZ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,IAAI;SACX,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\n\nimport type { SchemaFactory, ScopedSchemaName } from \"./schemaFactory.js\";\nimport type {\n\tNodeFromSchema,\n\tInternalTreeNode,\n\tNodeKind,\n\tTreeNode,\n\tTreeNodeSchema,\n\tTreeNodeSchemaClass,\n} from \"../core/index.js\";\nimport type { UnionToTuple } from \"../../util/index.js\";\n\n/*\n * This file does two things:\n *\n * 1. Provides tools for making schema for cases like enums.\n *\n * 2. Demonstrates the kinds of schema utilities apps can write.\n * Nothing in here needs access to package internal APIs.\n */\n\n/**\n * Create a schema for a node with no state.\n * @remarks\n * This is commonly used in unions when the only information needed is which kind of node the value is.\n * Enums are a common example of this pattern.\n * @see {@link adaptEnum}\n * @beta\n */\n// Return type is intentionally derived.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function singletonSchema<TScope extends string, TName extends string | number>(\n\tfactory: SchemaFactory<TScope, TName>,\n\tname: TName,\n) {\n\tclass SingletonSchema extends factory.object(name, {}) {\n\t\tpublic constructor(data?: InternalTreeNode | Record<string, never>) {\n\t\t\tsuper(data ?? {});\n\t\t}\n\t\tpublic get value(): TName {\n\t\t\treturn name;\n\t\t}\n\n\t\tpublic static override toString(): string {\n\t\t\treturn `SingletonSchema(${name})`;\n\t\t}\n\n\t\tpublic static [Symbol.toStringTag] = `SingletonSchema(${name})`;\n\t}\n\n\ttype SingletonNodeType = TreeNode & { readonly value: TName };\n\n\t// Returning SingletonSchema without a type conversion results in TypeScript generating something like `readonly \"__#124291@#brand\": unknown;`\n\t// for the private brand field of TreeNode.\n\t// This numeric id doesn't seem to be stable over incremental builds, and thus causes diffs in the API extractor reports.\n\t// This is avoided by doing this type conversion.\n\t// The conversion is done via assignment instead of `as` to get stronger type safety.\n\tconst toReturn: TreeNodeSchemaClass<\n\t\tScopedSchemaName<TScope, TName>,\n\t\tNodeKind.Object,\n\t\tSingletonNodeType,\n\t\tRecord<string, never>,\n\t\ttrue,\n\t\tRecord<string, never>,\n\t\tundefined\n\t> = SingletonSchema;\n\n\treturn toReturn;\n}\n\n/**\n * Converts an enum into a collection of schema which can be used in a union.\n *\n * @typeParam TScope - The scope of the provided factory.\n * There is a known issue where if a factory is provided that is typed as a {@link SchemaFactoryAlpha}, and its scope contains a \".\" character,\n * the inferred type for the scope will end up as a union of the scope up to the first \".\" character and the scope as it should be.\n * This can be mitigated by explicitly providing the TScope type parameter or by typing the provided factory as a {@link SchemaFactory} instead of a {@link SchemaFactoryAlpha}.\n *\n * @remarks\n * The string value of the enum is used as the name of the schema: callers must ensure that it is stable and unique.\n * Numeric enums values have the value implicitly converted into a string.\n * Consider making a dedicated schema factory with a nested scope (for example using {@link SchemaFactoryAlpha.scopedFactory}) to avoid the enum members colliding with other schema.\n * @example\n * ```typescript\n * const schemaFactory = new SchemaFactory(\"com.myApp\");\n * // An enum for use in the tree. Must have string keys.\n * enum Mode {\n * \ta = \"A\",\n * \tb = \"B\",\n * }\n * // Define the schema for each member of the enum using a nested scope to group them together.\n * const ModeNodes = adaptEnum(new SchemaFactory(`${schemaFactory.scope}.Mode`), Mode);\n * // Defined the types of the nodes which correspond to this the schema.\n * type ModeNodes = TreeNodeFromImplicitAllowedTypes<(typeof ModeNodes.schema)>;\n * // An example schema which has an enum as a child.\n * class Parent extends schemaFactory.object(\"Parent\", {\n * \t// adaptEnum's return value has a \".schema\" property can be use as an `AllowedTypes` array allowing any of the members of the enum.\n * \tmode: ModeNodes.schema,\n * }) {}\n *\n * // Example usage of enum based nodes, showing what type to use and that `.value` can be used to read out the enum value.\n * function getValue(node: ModeNodes): Mode {\n * \treturn node.value;\n * }\n *\n * // Example constructing a tree containing an enum node from an enum value.\n * // The syntax `new ModeNodes.a()` is also supported.\n * function setValue(node: Parent): void {\n * \tnode.mode = ModeNodes(Mode.a);\n * }\n * ```\n * @privateRemarks\n * TODO: AB#43345: see TScope known issue above, and other references to this work item.\n *\n * @see {@link enumFromStrings} for a similar function that works on arrays of strings instead of an enum.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function adaptEnum<\n\tTScope extends string,\n\tconst TEnum extends Record<string, string | number>,\n>(factory: SchemaFactory<TScope>, members: TEnum) {\n\ttype Values = TEnum[keyof TEnum];\n\tconst values = Object.values(members) as Values[];\n\tconst inverse = new Map(Object.entries(members).map(([key, value]) => [value, key])) as Map<\n\t\tValues,\n\t\tkeyof TEnum\n\t>;\n\n\tif (inverse.size !== values.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct values.\");\n\t}\n\n\ttype TOut = {\n\t\treadonly [Property in keyof TEnum]: ReturnType<\n\t\t\ttypeof singletonSchema<TScope, TEnum[Property]>\n\t\t>;\n\t};\n\n\ttype SchemaArray = UnionToTuple<TOut[keyof TEnum]>;\n\tconst schemaArray: TreeNodeSchema[] = [];\n\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends Values>(value: TValue) => {\n\t\treturn new out[\n\t\t\tinverse.get(value) ?? fail(0xb31 /* missing enum value */)\n\t\t\t// \"extends unknown\" is required here to handle when TValue is an union: each member of the union should be processed independently.\n\t\t]() as TValue extends unknown\n\t\t\t? NodeFromSchema<ReturnType<typeof singletonSchema<TScope, TValue>>>\n\t\t\t: never;\n\t};\n\tconst out = factoryOut as typeof factoryOut & TOut & { readonly schema: SchemaArray };\n\tfor (const [key, value] of enumEntries(members)) {\n\t\tconst schema = singletonSchema(factory, value);\n\t\tschemaArray.push(schema);\n\t\tObject.defineProperty(out, key, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: schema,\n\t\t});\n\t}\n\n\tObject.defineProperty(out, \"schema\", {\n\t\tenumerable: true,\n\t\tconfigurable: false,\n\t\twritable: false,\n\t\tvalue: schemaArray,\n\t});\n\n\treturn out;\n}\n\n/**\n * Returns en \"entries\" (like Object.entries) for an enum object, omitting the\n * {@link https://www.typescriptlang.org/docs/handbook/enums.html#reverse-mappings|reverse mappings}\n */\nexport function enumEntries(\n\tenumObject: Record<string, string | number>,\n): [string, string | number][] {\n\t// Skip reverse mapping for numeric entries.\n\t// For numeric entries, TypeScript defines an additional property keyed with the number implicitly converted to a string.\n\t// Note TypeScript can overwrite its own enum entries in some edge cases (see https://github.com/microsoft/TypeScript/issues/48956), so it's not possible to handle all cases correctly.\n\treturn Object.entries(enumObject).filter(([key, value]) => {\n\t\t// All reverse mapping must also have a inverse mapping (the regular forward mapping) to a number:\n\t\tconst inverse = enumObject[value];\n\t\tif (typeof inverse !== \"number\") {\n\t\t\t// Known not to be a reverse mapping, so keep it.\n\t\t\treturn true;\n\t\t}\n\t\t// At this point, it is expected that all remaining cases are reverse mappings,\n\t\t// but do some asserts to ensure that the above logic is sufficient.\n\t\tassert(typeof value === \"string\", \"expected reverse mapping and thus a string value\");\n\t\tassert(\n\t\t\tNumber.parseFloat(key).toString() === key,\n\t\t\t\"expected reverse mapping and thus a key that is a normalized number\",\n\t\t);\n\t\t// Discard the reverse mapping.\n\t\treturn false;\n\t});\n}\n\n/**\n * Converts an array of distinct strings into a collection of schema which can be used like an enum style union.\n * @remarks\n * The returned collection is also a function which can be used to convert strings into {@link Unhydrated} nodes in the union.\n * Each node type has a `.value` getter which returns the associated string.\n *\n * The produced nodes use the provided strings as their `name`, and don't store any data beyond that.\n * @example\n * ```typescript\n * const schemaFactory = new SchemaFactory(\"com.myApp\");\n * const Mode = enumFromStrings(schemaFactory, [\"Fun\", \"Cool\"]);\n * type Mode = TreeNodeFromImplicitAllowedTypes<typeof Mode.schema>;\n * const nodeFromString: Mode = Mode(\"Fun\");\n * const nodeFromSchema: Mode = new Mode.Fun();\n *\n * // Schema nodes have a strongly typed `.value` property.\n * const nameFromNode: \"Fun\" | \"Cool\" = nodeFromSchema.value;\n *\n * class Parent extends schemaFactory.object(\"Parent\", { mode: Mode.schema }) {}\n * ```\n * @see {@link adaptEnum} for a similar function that works on enums instead of arrays of strings.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function enumFromStrings<\n\tTScope extends string,\n\tconst Members extends readonly string[],\n>(factory: SchemaFactory<TScope>, members: Members) {\n\tconst names = new Set(members);\n\tif (names.size !== members.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct names\");\n\t}\n\n\ttype MembersUnion = Members[number];\n\n\t// Get all keys of the Members tuple which are numeric strings as union of numbers:\n\ttype Indexes = Extract<keyof Members, `${number}`> extends `${infer N extends number}`\n\t\t? N\n\t\t: never;\n\n\ttype TOut = {\n\t\t[Index in Indexes as Members[Index]]: ReturnType<\n\t\t\ttypeof singletonSchema<TScope, Members[Index] & string>\n\t\t>;\n\t};\n\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends MembersUnion>(value: TValue) => {\n\t\t// \"extends unknown\" is required here to handle when TValue is an union: each member of the union should be processed independently.\n\t\treturn new recordOut[value]() as TValue extends unknown\n\t\t\t? NodeFromSchema<ReturnType<typeof singletonSchema<TScope, TValue>>>\n\t\t\t: never;\n\t};\n\n\ttype SchemaArray = UnionToTuple<MembersUnion extends unknown ? TOut[MembersUnion] : never>;\n\tconst schemaArray: TreeNodeSchema[] = [];\n\n\tconst out = factoryOut as typeof factoryOut & TOut & { readonly schema: SchemaArray };\n\tconst recordOut = out as Record<MembersUnion, new () => unknown>;\n\tfor (const name of members) {\n\t\tconst schema = singletonSchema(factory, name);\n\t\tschemaArray.push(schema);\n\t\tObject.defineProperty(out, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: schema,\n\t\t});\n\t}\n\n\tObject.defineProperty(out, \"schema\", {\n\t\tenumerable: true,\n\t\tconfigurable: false,\n\t\twritable: false,\n\t\tvalue: schemaArray,\n\t});\n\n\treturn out;\n}\n\n// TODO: This generates an invalid d.ts file if exported due to a bug https://github.com/microsoft/TypeScript/issues/58688.\n// TODO: replace enumFromStrings above with this simpler implementation when the TypeScript bug is resolved.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nfunction _enumFromStrings2<TScope extends string, const Members extends readonly string[]>(\n\tfactory: SchemaFactory<TScope>,\n\tmembers: Members,\n) {\n\tconst enumObject: {\n\t\t[key in keyof Members as Members[key] extends string\n\t\t\t? Members[key]\n\t\t\t: string]: Members[key] extends string ? Members[key] : string;\n\t} = Object.create(null);\n\tfor (const name of members) {\n\t\tObject.defineProperty(enumObject, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: name,\n\t\t});\n\t}\n\n\treturn adaptEnum(factory, enumObject);\n}\n"]}
@@ -4,11 +4,11 @@
4
4
  */
5
5
  import type { IFluidHandle } from "@fluidframework/core-interfaces";
6
6
  import type { TreeValue } from "../../core/index.js";
7
- import { type RestrictiveStringRecord } from "../../util/index.js";
8
- import type { NodeKind, WithType, TreeNodeSchema, TreeNodeSchemaClass, TreeNodeSchemaNonClass } from "../core/index.js";
7
+ import { type JsonCompatibleReadOnlyObject, type RestrictiveStringRecord } from "../../util/index.js";
8
+ import type { NodeKind, WithType, TreeNodeSchema, TreeNodeSchemaClass, TreeNodeSchemaNonClass, NodeSchemaMetadata, ImplicitAnnotatedAllowedTypes, UnannotateImplicitAllowedTypes, ImplicitAllowedTypes, InsertableTreeNodeFromImplicitAllowedTypes } from "../core/index.js";
9
9
  import { stringSchema, type LeafSchema } from "../leafNodeSchema.js";
10
10
  import { type MapNodeInsertableData, type TreeArrayNode, type InsertableObjectFromSchemaRecord, type TreeMapNode, type TreeObjectNode } from "../node-kinds/index.js";
11
- import { FieldKind, type FieldSchema, type ImplicitAllowedTypes, type ImplicitFieldSchema, type InsertableTreeNodeFromImplicitAllowedTypes, type FieldProps, type FieldSchemaAlpha, type ImplicitAnnotatedAllowedTypes, type UnannotateImplicitAllowedTypes, type NodeSchemaOptionsAlpha, type FieldPropsAlpha } from "../schemaTypes.js";
11
+ import { FieldKind, type FieldSchema, type ImplicitFieldSchema, type FieldProps, type FieldSchemaAlpha, type FieldPropsAlpha } from "../fieldSchema.js";
12
12
  import type { System_Unsafe, FieldSchemaAlphaUnsafe } from "./typesUnsafe.js";
13
13
  /**
14
14
  * Gets the leaf domain schema compatible with a given {@link TreeValue}.
@@ -696,5 +696,38 @@ export declare class SchemaFactory<out TScope extends string | undefined = strin
696
696
  }, false, T, undefined>;
697
697
  }
698
698
  export declare function structuralName<const T extends string>(collectionName: T, allowedTypes: TreeNodeSchema | readonly TreeNodeSchema[]): `${T}<${string}>`;
699
+ /**
700
+ * Additional information to provide to Node Schema creation.
701
+ *
702
+ * @typeParam TCustomMetadata - Custom metadata properties to associate with the Node Schema.
703
+ * See {@link NodeSchemaMetadata.custom}.
704
+ *
705
+ * @sealed
706
+ * @public
707
+ */
708
+ export interface NodeSchemaOptions<out TCustomMetadata = unknown> {
709
+ /**
710
+ * Optional metadata to associate with the Node Schema.
711
+ *
712
+ * @remarks
713
+ * Note: this metadata is not persisted nor made part of the collaborative state; it is strictly client-local.
714
+ * Different clients in the same collaborative session may see different metadata for the same field.
715
+ */
716
+ readonly metadata?: NodeSchemaMetadata<TCustomMetadata> | undefined;
717
+ }
718
+ /**
719
+ * Additional information to provide to Node Schema creation. Includes fields for alpha features.
720
+ *
721
+ * @typeParam TCustomMetadata - Custom metadata properties to associate with the Node Schema.
722
+ * See {@link NodeSchemaMetadata.custom}.
723
+ *
724
+ * @alpha
725
+ */
726
+ export interface NodeSchemaOptionsAlpha<out TCustomMetadata = unknown> extends NodeSchemaOptions<TCustomMetadata> {
727
+ /**
728
+ * The persisted metadata for this schema element.
729
+ */
730
+ readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;
731
+ }
699
732
  export {};
700
733
  //# sourceMappingURL=schemaFactory.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemaFactory.d.ts","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAKpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAIrD,OAAO,EACN,KAAK,uBAAuB,EAI5B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACX,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,sBAAsB,EAGtB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAKN,YAAY,EACZ,KAAK,UAAU,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEN,KAAK,qBAAqB,EAG1B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,SAAS,EACT,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,0CAA0C,EAC/C,KAAK,UAAU,EAKf,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,EAEnC,KAAK,sBAAsB,EAE3B,KAAK,eAAe,EACpB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAM9E;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,cAAc,CAkBhE;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B,CAAC,eAAe,GAAG,OAAO,CACpE,SAAQ,sBAAsB,CAAC,eAAe,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,iCAAiC,EAAE,QAAQ,CACvD,IAAI,CAAC,0BAA0B,EAAE,UAAU,GAAG,mBAAmB,CAAC,CAGlE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAC3B,MAAM,SAAS,MAAM,GAAG,SAAS,EACjC,KAAK,SAAS,MAAM,GAAG,MAAM,IAC1B,MAAM,SAAS,SAAS,GAAG,GAAG,KAAK,EAAE,GAAG,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC;AAGjE;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEjD;;;;;;;OAOG;IAEH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS;QACzB,aAAa,CAAC,QAAQ,CAAC;QACvB,aAAa,CAAC,QAAQ,CAAC;QACvB,aAAa,CAAC,SAAS,CAAC;QACxB,aAAa,CAAC,MAAM,CAAC;QACrB,aAAa,CAAC,QAAQ,CAAC;KACvB,CAAC;IAEF;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACxF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAEzD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACxF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,EAAE,CAC3B,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACxD,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,aAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,EAAE,CAC3B,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACxD,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,aAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;CAC7E;AAOD,iBAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACtF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;AAE5D,iBAAS,QAAQ,CAChB,KAAK,CAAC,CAAC,SAAS,6BAA6B,EAC7C,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAe5F,iBAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACtF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;AAE5D,iBAAS,QAAQ,CAChB,KAAK,CAAC,CAAC,SAAS,6BAA6B,EAC7C,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAY5F;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;+HAgBzB,CAAC,UACI,KAAK,gBAAgB,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAC/D,uBAAuB,UAAU,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC;;CAgBhC,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,aAAa;mEAGhB,KAAK,WAAW,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAC1D,iBAAiB,UAAU,UAAU,EAAE,mBAAmB,EAAE,eAAe,CAAC;;;;;;;;;iIA3B3E,CAAC;;CA8BI,CAAC;AAQX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2GG;AACH,qBAAa,aAAa,CACzB,GAAG,CAAC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC1D,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CACrC,YAAW,aAAa;IAkBxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,KAAK,EAAE,MAAM;IA/C9B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0C;IAE1E;;;;;OAKG;;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACa,KAAK,EAAE,MAAM;IAG9B,OAAO,CAAC,MAAM;IAMd;;OAEG;IACH,SAAgB,MAAM,+BAA8B;IAEpD;;OAEG;IACH,SAAgB,MAAM,+BAA8B;IAEpD;;OAEG;IACH,SAAgB,OAAO,iCAA+B;IAEtD;;OAEG;IACH,SAAgB,IAAI,2BAA4B;IAEhD;;OAEG;IACH,SAAgB,MAAM,8CAA8B;IAEpD;;OAEG;IACH,SAAgB,MAAM,+KAA8B;IAEpD;;OAEG;IACH,gBAAuB,MAAM,+BAA8B;IAE3D;;OAEG;IACH,gBAAuB,MAAM,+BAA8B;IAE3D;;OAEG;IACH,gBAAuB,OAAO,iCAA+B;IAE7D;;OAEG;IACH,gBAAuB,IAAI,2BAA4B;IAEvD;;OAEG;IACH,gBAAuB,MAAM,8CAA8B;IAE3D;;OAEG;IACH,gBAAuB,MAAM,+KAA8B;IAE3D;;;;;OAKG;IACI,MAAM,CACZ,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,uBAAuB,CAAC,mBAAmB,CAAC,EAE5D,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,CAAC,GACP,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,MAAM,EACf,cAAc,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACjD,MAAM,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAC5C,IAAI,EACJ,CAAC,CACD;IAiCD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACpE,YAAY,EAAE,CAAC,GACb,sBAAsB,CACxB,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,EAC1C,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,EACnF,qBAAqB,CAAC,CAAC,CAAC,EACxB,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IAED;;;;;;;;;;OAUG;IACI,GAAG,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAClE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,EACvE,qBAAqB,CAAC,CAAC,CAAC,EACxB,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IA0CD;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAyDhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACtE,YAAY,EAAE,CAAC,GACb,sBAAsB,CACxB,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,EAC5C,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EACzF,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAC1E,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAC3E,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IA8CD;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAC1B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,EACjD,OAAO,EAAE,MAAM,cAAc,GAC3B,cAAc;IAgBjB;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU;IAoClB;;OAEG;IACH,SAAgB,QAAQ,iNAAgC;IAExD;;OAEG;IACH,SAAgB,QAAQ,iNAAgC;IAExD;;OAEG;IACH,SAAgB,iBAAiB,yPAAyC;IAE1E;;OAEG;IACH,SAAgB,iBAAiB,yPAAyC;IAE1E;;OAEG;IACH,gBAAuB,QAAQ,iNAAgC;IAE/D;;OAEG;IACH,gBAAuB,QAAQ,iNAAgC;IAE/D;;OAEG;IACH,gBAAuB,iBAAiB,yPAAyC;IAEjF;;OAEG;IACH,gBAAuB,iBAAiB,yPAAyC;IAEjF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAW,UAAU,IAAI,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,MAAM,CAAC,CAoB7E;IAED;;;;;;;;;;OAUG;IACI,eAAe,CACrB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,uBAAuB,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAEhF,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,MAAM,EACf,aAAa,CAAC,oBAAoB,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACrE,MAAM,GAAG,aAAa,CAAC,sCAAsC,CAAC,CAAC,CAAC,EAChE,KAAK,EACL,CAAC,CACD;IAeD;;;;;;;OAOG;IAEI,cAAc,CACpB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACvD,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QAc1B;;;;;;;;;;WAUG;6BACkB,SACpB,cAAc,gDAAgD,CAAC,CAAC,CAAC,CACjE;;IAQJ;;;;;;OAMG;IAEI,YAAY,CAClB,IAAI,SAAS,KAAK,EAClB,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACvD,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QAgBzB;;;;;;;;;;WAUG;6BACkB,SACpB;YAAC,MAAM;YAAE,cAAc,gDAAgD,CAAC,CAAC,CAAC;SAAC,CAC3E;;;;CAcL;AAED,wBAAgB,cAAc,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACpD,cAAc,EAAE,CAAC,EACjB,YAAY,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,GACtD,GAAG,CAAC,IAAI,MAAM,GAAG,CAmBnB"}
1
+ {"version":3,"file":"schemaFactory.d.ts","sourceRoot":"","sources":["../../../src/simple-tree/api/schemaFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAKpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAIrD,OAAO,EACN,KAAK,4BAA4B,EACjC,KAAK,uBAAuB,EAI5B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EACX,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,sBAAsB,EAGtB,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,oBAAoB,EACpB,0CAA0C,EAC1C,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAKN,YAAY,EACZ,KAAK,UAAU,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEN,KAAK,qBAAqB,EAG1B,KAAK,aAAa,EAClB,KAAK,gCAAgC,EACrC,KAAK,WAAW,EAChB,KAAK,cAAc,EAEnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,SAAS,EACT,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EAIf,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAM9E;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,cAAc,CAkBhE;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B,CAAC,eAAe,GAAG,OAAO,CACpE,SAAQ,sBAAsB,CAAC,eAAe,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,iCAAiC,EAAE,QAAQ,CACvD,IAAI,CAAC,0BAA0B,EAAE,UAAU,GAAG,mBAAmB,CAAC,CAGlE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAC3B,MAAM,SAAS,MAAM,GAAG,SAAS,EACjC,KAAK,SAAS,MAAM,GAAG,MAAM,IAC1B,MAAM,SAAS,SAAS,GAAG,GAAG,KAAK,EAAE,GAAG,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC;AAGjE;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEjD;;;;;;;OAOG;IAEH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS;QACzB,aAAa,CAAC,QAAQ,CAAC;QACvB,aAAa,CAAC,QAAQ,CAAC;QACvB,aAAa,CAAC,SAAS,CAAC;QACxB,aAAa,CAAC,MAAM,CAAC;QACrB,aAAa,CAAC,QAAQ,CAAC;KACvB,CAAC;IAEF;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACxF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAEzD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACxF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,EAAE,CAC3B,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACxD,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,aAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,EAAE,CAC3B,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACxD,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,KACxD,aAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;CAC7E;AAOD,iBAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACtF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;AAE5D,iBAAS,QAAQ,CAChB,KAAK,CAAC,CAAC,SAAS,6BAA6B,EAC7C,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAe5F,iBAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,EACtF,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;AAE5D,iBAAS,QAAQ,CAChB,KAAK,CAAC,CAAC,SAAS,6BAA6B,EAC7C,KAAK,CAAC,eAAe,GAAG,OAAO,EAE/B,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,iBAAiB,CAAC,GAC/D,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAY5F;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;+HAgBzB,CAAC,UACI,KAAK,gBAAgB,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAC/D,uBAAuB,UAAU,QAAQ,EAAE,CAAC,EAAE,eAAe,CAAC;;CAgBhC,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,aAAa;mEAGhB,KAAK,WAAW,eAAe,CAAC,EAAE,iBAAiB,CAAC,KAC1D,iBAAiB,UAAU,UAAU,EAAE,mBAAmB,EAAE,eAAe,CAAC;;;;;;;;;iIA3B3E,CAAC;;CA8BI,CAAC;AAQX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2GG;AACH,qBAAa,aAAa,CACzB,GAAG,CAAC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC1D,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CACrC,YAAW,aAAa;IAkBxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,KAAK,EAAE,MAAM;IA/C9B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0C;IAE1E;;;;;OAKG;;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACa,KAAK,EAAE,MAAM;IAG9B,OAAO,CAAC,MAAM;IAMd;;OAEG;IACH,SAAgB,MAAM,+BAA8B;IAEpD;;OAEG;IACH,SAAgB,MAAM,+BAA8B;IAEpD;;OAEG;IACH,SAAgB,OAAO,iCAA+B;IAEtD;;OAEG;IACH,SAAgB,IAAI,2BAA4B;IAEhD;;OAEG;IACH,SAAgB,MAAM,8CAA8B;IAEpD;;OAEG;IACH,SAAgB,MAAM,+KAA8B;IAEpD;;OAEG;IACH,gBAAuB,MAAM,+BAA8B;IAE3D;;OAEG;IACH,gBAAuB,MAAM,+BAA8B;IAE3D;;OAEG;IACH,gBAAuB,OAAO,iCAA+B;IAE7D;;OAEG;IACH,gBAAuB,IAAI,2BAA4B;IAEvD;;OAEG;IACH,gBAAuB,MAAM,8CAA8B;IAE3D;;OAEG;IACH,gBAAuB,MAAM,+KAA8B;IAE3D;;;;;OAKG;IACI,MAAM,CACZ,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,uBAAuB,CAAC,mBAAmB,CAAC,EAE5D,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,CAAC,GACP,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,MAAM,EACf,cAAc,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACjD,MAAM,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAC5C,IAAI,EACJ,CAAC,CACD;IAiCD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACpE,YAAY,EAAE,CAAC,GACb,sBAAsB,CACxB,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,EAC1C,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,EACnF,qBAAqB,CAAC,CAAC,CAAC,EACxB,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IAED;;;;;;;;;;OAUG;IACI,GAAG,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAClE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,EACvE,qBAAqB,CAAC,CAAC,CAAC,EACxB,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IA0CD;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAyDhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACtE,YAAY,EAAE,CAAC,GACb,sBAAsB,CACxB,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,EAC5C,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EACzF,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAC1E,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAC3E,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,EACD,SAAS,CACT;IA8CD;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAC1B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,EACjD,OAAO,EAAE,MAAM,cAAc,GAC3B,cAAc;IAgBjB;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU;IAoClB;;OAEG;IACH,SAAgB,QAAQ,iNAAgC;IAExD;;OAEG;IACH,SAAgB,QAAQ,iNAAgC;IAExD;;OAEG;IACH,SAAgB,iBAAiB,yPAAyC;IAE1E;;OAEG;IACH,SAAgB,iBAAiB,yPAAyC;IAE1E;;OAEG;IACH,gBAAuB,QAAQ,iNAAgC;IAE/D;;OAEG;IACH,gBAAuB,QAAQ,iNAAgC;IAE/D;;OAEG;IACH,gBAAuB,iBAAiB,yPAAyC;IAEjF;;OAEG;IACH,gBAAuB,iBAAiB,yPAAyC;IAEjF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAW,UAAU,IAAI,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,MAAM,CAAC,CAoB7E;IAED;;;;;;;;;;OAUG;IACI,eAAe,CACrB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,uBAAuB,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAEhF,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,MAAM,EACf,aAAa,CAAC,oBAAoB,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACrE,MAAM,GAAG,aAAa,CAAC,sCAAsC,CAAC,CAAC,CAAC,EAChE,KAAK,EACL,CAAC,CACD;IAeD;;;;;;;OAOG;IAEI,cAAc,CACpB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACvD,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QAc1B;;;;;;;;;;WAUG;6BACkB,SACpB,cAAc,gDAAgD,CAAC,CAAC,CAAC,CACjE;;IAQJ;;;;;;OAMG;IAEI,YAAY,CAClB,IAAI,SAAS,KAAK,EAClB,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,0BAA0B,EACvD,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QAgBzB;;;;;;;;;;WAUG;6BACkB,SACpB;YAAC,MAAM;YAAE,cAAc,gDAAgD,CAAC,CAAC,CAAC;SAAC,CAC3E;;;;CAcL;AAED,wBAAgB,cAAc,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACpD,cAAc,EAAE,CAAC,EACjB,YAAY,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,GACtD,GAAG,CAAC,IAAI,MAAM,GAAG,CAmBnB;AAUD;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO;IAC/D;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;CACpE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CACpE,SAAQ,iBAAiB,CAAC,eAAe,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAC;CACtE"}
@@ -6,10 +6,10 @@ import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
6
6
  import { isFluidHandle } from "@fluidframework/runtime-utils/internal";
7
7
  import { UsageError } from "@fluidframework/telemetry-utils/internal";
8
8
  import { compareSets, getOrCreate, isReadonlyArray, } from "../../util/index.js";
9
- import { isLazy } from "../flexList.js";
9
+ import { normalizeAllowedTypes, markSchemaMostDerived, isLazy } from "../core/index.js";
10
10
  import { booleanSchema, handleSchema, nullSchema, numberSchema, stringSchema, } from "../leafNodeSchema.js";
11
11
  import { arraySchema, mapSchema, objectSchema, } from "../node-kinds/index.js";
12
- import { FieldKind, createFieldSchema, getDefaultProvider, markSchemaMostDerived, normalizeAllowedTypes, } from "../schemaTypes.js";
12
+ import { FieldKind, createFieldSchema, getDefaultProvider, } from "../fieldSchema.js";
13
13
  import { createFieldSchemaUnsafe } from "./schemaFactoryRecursive.js";
14
14
  import { createIdCompressor } from "@fluidframework/id-compressor/internal";
15
15
  import { unhydratedFlexTreeFromInsertable } from "../unhydratedFlexTreeFromInsertable.js";