@dxos/echo 0.8.4-main.406dc2a → 0.8.4-main.4a85c3132b

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 (554) hide show
  1. package/README.md +3 -4
  2. package/dist/lib/neutral/Annotation.mjs +37 -0
  3. package/dist/lib/neutral/Database.mjs +45 -0
  4. package/dist/lib/neutral/Entity.mjs +56 -0
  5. package/dist/lib/neutral/Err.mjs +12 -0
  6. package/dist/lib/neutral/Feed.mjs +43 -0
  7. package/dist/lib/neutral/Filter.mjs +61 -0
  8. package/dist/lib/neutral/Format.mjs +66 -0
  9. package/dist/lib/neutral/Format.mjs.map +7 -0
  10. package/dist/lib/neutral/JsonSchema.mjs +18 -0
  11. package/dist/lib/neutral/JsonSchema.mjs.map +7 -0
  12. package/dist/lib/neutral/Key.mjs +12 -0
  13. package/dist/lib/neutral/Key.mjs.map +7 -0
  14. package/dist/lib/neutral/Obj.mjs +107 -0
  15. package/dist/lib/neutral/Obj.mjs.map +7 -0
  16. package/dist/lib/neutral/Order.mjs +12 -0
  17. package/dist/lib/neutral/Order.mjs.map +7 -0
  18. package/dist/lib/neutral/Query.mjs +32 -0
  19. package/dist/lib/neutral/Query.mjs.map +7 -0
  20. package/dist/lib/neutral/QueryResult.mjs +2 -0
  21. package/dist/lib/neutral/QueryResult.mjs.map +7 -0
  22. package/dist/lib/neutral/Ref.mjs +24 -0
  23. package/dist/lib/neutral/Ref.mjs.map +7 -0
  24. package/dist/lib/neutral/Relation.mjs +90 -0
  25. package/dist/lib/neutral/Relation.mjs.map +7 -0
  26. package/dist/lib/neutral/SchemaRegistry.mjs +2 -0
  27. package/dist/lib/neutral/SchemaRegistry.mjs.map +7 -0
  28. package/dist/lib/neutral/Tag.mjs +25 -0
  29. package/dist/lib/neutral/Tag.mjs.map +7 -0
  30. package/dist/lib/neutral/Type.mjs +34 -0
  31. package/dist/lib/neutral/Type.mjs.map +7 -0
  32. package/dist/lib/neutral/chunk-4KG6IGL4.mjs +67 -0
  33. package/dist/lib/neutral/chunk-4KG6IGL4.mjs.map +7 -0
  34. package/dist/lib/neutral/chunk-5ELDDYWE.mjs +130 -0
  35. package/dist/lib/neutral/chunk-5ELDDYWE.mjs.map +7 -0
  36. package/dist/lib/neutral/chunk-ALOGSVBP.mjs +299 -0
  37. package/dist/lib/neutral/chunk-ALOGSVBP.mjs.map +7 -0
  38. package/dist/lib/neutral/chunk-ANHVGJI4.mjs +21 -0
  39. package/dist/lib/neutral/chunk-ANHVGJI4.mjs.map +7 -0
  40. package/dist/lib/neutral/chunk-AQP4QKYP.mjs +283 -0
  41. package/dist/lib/neutral/chunk-AQP4QKYP.mjs.map +7 -0
  42. package/dist/lib/neutral/chunk-BRJSLACP.mjs +152 -0
  43. package/dist/lib/neutral/chunk-BRJSLACP.mjs.map +7 -0
  44. package/dist/lib/neutral/chunk-DZQSL6RW.mjs +73 -0
  45. package/dist/lib/neutral/chunk-DZQSL6RW.mjs.map +7 -0
  46. package/dist/lib/neutral/chunk-F7KMHDPJ.mjs +327 -0
  47. package/dist/lib/neutral/chunk-F7KMHDPJ.mjs.map +7 -0
  48. package/dist/lib/neutral/chunk-GAWKQ5DZ.mjs +56 -0
  49. package/dist/lib/neutral/chunk-GAWKQ5DZ.mjs.map +7 -0
  50. package/dist/lib/neutral/chunk-GFNCSK7F.mjs +101 -0
  51. package/dist/lib/neutral/chunk-GFNCSK7F.mjs.map +7 -0
  52. package/dist/lib/neutral/chunk-J5LGTIGS.mjs +10 -0
  53. package/dist/lib/neutral/chunk-J5LGTIGS.mjs.map +7 -0
  54. package/dist/lib/neutral/chunk-KGV3QIRX.mjs +313 -0
  55. package/dist/lib/neutral/chunk-KGV3QIRX.mjs.map +7 -0
  56. package/dist/lib/neutral/chunk-M2KVTHZM.mjs +402 -0
  57. package/dist/lib/neutral/chunk-M2KVTHZM.mjs.map +7 -0
  58. package/dist/lib/neutral/chunk-MXQJZCPY.mjs +51 -0
  59. package/dist/lib/neutral/chunk-MXQJZCPY.mjs.map +7 -0
  60. package/dist/lib/neutral/chunk-O3TZFQCT.mjs +27 -0
  61. package/dist/lib/neutral/chunk-O3TZFQCT.mjs.map +7 -0
  62. package/dist/lib/neutral/chunk-OMUPQMLR.mjs +7 -0
  63. package/dist/lib/neutral/chunk-OMUPQMLR.mjs.map +7 -0
  64. package/dist/lib/neutral/chunk-OVUBTQLT.mjs +45 -0
  65. package/dist/lib/neutral/chunk-OVUBTQLT.mjs.map +7 -0
  66. package/dist/lib/neutral/chunk-PP4DNUZU.mjs +3919 -0
  67. package/dist/lib/neutral/chunk-PP4DNUZU.mjs.map +7 -0
  68. package/dist/lib/neutral/chunk-QXF3LGN2.mjs +43 -0
  69. package/dist/lib/neutral/chunk-QXF3LGN2.mjs.map +7 -0
  70. package/dist/lib/neutral/chunk-T4MPQJ7X.mjs +97 -0
  71. package/dist/lib/neutral/chunk-T4MPQJ7X.mjs.map +7 -0
  72. package/dist/lib/neutral/chunk-T6JEFNP6.mjs +7 -0
  73. package/dist/lib/neutral/chunk-T6JEFNP6.mjs.map +7 -0
  74. package/dist/lib/neutral/chunk-W7OP5HGZ.mjs +121 -0
  75. package/dist/lib/neutral/chunk-W7OP5HGZ.mjs.map +7 -0
  76. package/dist/lib/neutral/chunk-ZTUBYOGB.mjs +42 -0
  77. package/dist/lib/neutral/chunk-ZTUBYOGB.mjs.map +7 -0
  78. package/dist/lib/neutral/chunk-ZWKJ4LZJ.mjs +298 -0
  79. package/dist/lib/neutral/chunk-ZWKJ4LZJ.mjs.map +7 -0
  80. package/dist/lib/neutral/index.mjs +94 -0
  81. package/dist/lib/neutral/index.mjs.map +7 -0
  82. package/dist/lib/{node-esm → neutral}/internal/index.mjs +253 -121
  83. package/dist/lib/neutral/internal/index.mjs.map +7 -0
  84. package/dist/lib/neutral/meta.json +1 -0
  85. package/dist/lib/neutral/testing/index.mjs +369 -0
  86. package/dist/lib/neutral/testing/index.mjs.map +7 -0
  87. package/dist/types/src/Annotation.d.ts +24 -0
  88. package/dist/types/src/Annotation.d.ts.map +1 -0
  89. package/dist/types/src/Collection.d.ts +16 -0
  90. package/dist/types/src/Collection.d.ts.map +1 -0
  91. package/dist/types/src/Database.d.ts +189 -0
  92. package/dist/types/src/Database.d.ts.map +1 -0
  93. package/dist/types/src/Dataset.d.ts +18 -0
  94. package/dist/types/src/Dataset.d.ts.map +1 -0
  95. package/dist/types/src/Entity.d.ts +168 -0
  96. package/dist/types/src/Entity.d.ts.map +1 -0
  97. package/dist/types/src/Entity.test.d.ts +2 -0
  98. package/dist/types/src/Entity.test.d.ts.map +1 -0
  99. package/dist/types/src/Err.d.ts +107 -0
  100. package/dist/types/src/Err.d.ts.map +1 -0
  101. package/dist/types/src/Feed.d.ts +165 -0
  102. package/dist/types/src/Feed.d.ts.map +1 -0
  103. package/dist/types/src/Filter.d.ts +120 -0
  104. package/dist/types/src/Filter.d.ts.map +1 -0
  105. package/dist/types/src/Format.d.ts +4 -0
  106. package/dist/types/src/Format.d.ts.map +1 -0
  107. package/dist/types/src/Hypergraph.d.ts +60 -0
  108. package/dist/types/src/Hypergraph.d.ts.map +1 -0
  109. package/dist/types/src/JsonSchema.d.ts +16 -0
  110. package/dist/types/src/JsonSchema.d.ts.map +1 -0
  111. package/dist/types/src/Key.d.ts +1 -0
  112. package/dist/types/src/Key.d.ts.map +1 -1
  113. package/dist/types/src/Obj.d.ts +417 -101
  114. package/dist/types/src/Obj.d.ts.map +1 -1
  115. package/dist/types/src/Obj.test.d.ts +2 -0
  116. package/dist/types/src/Obj.test.d.ts.map +1 -0
  117. package/dist/types/src/Order.d.ts +16 -0
  118. package/dist/types/src/Order.d.ts.map +1 -0
  119. package/dist/types/src/Query.d.ts +202 -0
  120. package/dist/types/src/Query.d.ts.map +1 -0
  121. package/dist/types/src/Query.test.d.ts +2 -0
  122. package/dist/types/src/Query.test.d.ts.map +1 -0
  123. package/dist/types/src/QueryResult.d.ts +80 -0
  124. package/dist/types/src/QueryResult.d.ts.map +1 -0
  125. package/dist/types/src/Ref.d.ts +61 -11
  126. package/dist/types/src/Ref.d.ts.map +1 -1
  127. package/dist/types/src/Relation.d.ts +287 -21
  128. package/dist/types/src/Relation.d.ts.map +1 -1
  129. package/dist/types/src/Relation.test.d.ts +2 -0
  130. package/dist/types/src/Relation.test.d.ts.map +1 -0
  131. package/dist/types/src/SchemaRegistry.d.ts +84 -0
  132. package/dist/types/src/SchemaRegistry.d.ts.map +1 -0
  133. package/dist/types/src/Tag.d.ts +18 -0
  134. package/dist/types/src/Tag.d.ts.map +1 -0
  135. package/dist/types/src/Type.d.ts +120 -97
  136. package/dist/types/src/Type.d.ts.map +1 -1
  137. package/dist/types/src/Type.test.d.ts +2 -0
  138. package/dist/types/src/Type.test.d.ts.map +1 -0
  139. package/dist/types/src/View.d.ts +68 -0
  140. package/dist/types/src/View.d.ts.map +1 -0
  141. package/dist/types/src/hierarchy.test.d.ts +2 -0
  142. package/dist/types/src/hierarchy.test.d.ts.map +1 -0
  143. package/dist/types/src/index.d.ts +19 -5
  144. package/dist/types/src/index.d.ts.map +1 -1
  145. package/dist/types/src/internal/annotations/annotations.d.ts +209 -0
  146. package/dist/types/src/internal/annotations/annotations.d.ts.map +1 -0
  147. package/dist/types/src/internal/annotations/annotations.test.d.ts.map +1 -0
  148. package/dist/types/src/internal/annotations/index.d.ts +3 -0
  149. package/dist/types/src/internal/annotations/index.d.ts.map +1 -0
  150. package/dist/types/src/internal/annotations/util.d.ts +39 -0
  151. package/dist/types/src/internal/annotations/util.d.ts.map +1 -0
  152. package/dist/types/src/internal/api/annotations.d.ts +23 -0
  153. package/dist/types/src/internal/api/annotations.d.ts.map +1 -0
  154. package/dist/types/src/internal/api/entity.d.ts +13 -0
  155. package/dist/types/src/internal/api/entity.d.ts.map +1 -0
  156. package/dist/types/src/internal/api/index.d.ts +15 -0
  157. package/dist/types/src/internal/api/index.d.ts.map +1 -0
  158. package/dist/types/src/internal/api/meta.d.ts +42 -0
  159. package/dist/types/src/internal/api/meta.d.ts.map +1 -0
  160. package/dist/types/src/internal/api/sorting.d.ts +24 -0
  161. package/dist/types/src/internal/api/sorting.d.ts.map +1 -0
  162. package/dist/types/src/internal/api/version.d.ts +42 -0
  163. package/dist/types/src/internal/api/version.d.ts.map +1 -0
  164. package/dist/types/src/internal/entities/entity.d.ts +20 -0
  165. package/dist/types/src/internal/entities/entity.d.ts.map +1 -0
  166. package/dist/types/src/internal/entities/index.d.ts +6 -0
  167. package/dist/types/src/internal/entities/index.d.ts.map +1 -0
  168. package/dist/types/src/internal/entities/model.d.ts +79 -0
  169. package/dist/types/src/internal/entities/model.d.ts.map +1 -0
  170. package/dist/types/src/internal/entities/object.d.ts +18 -0
  171. package/dist/types/src/internal/entities/object.d.ts.map +1 -0
  172. package/dist/types/src/internal/entities/relation.d.ts +62 -0
  173. package/dist/types/src/internal/entities/relation.d.ts.map +1 -0
  174. package/dist/types/src/internal/entities/util.d.ts +2 -0
  175. package/dist/types/src/internal/entities/util.d.ts.map +1 -0
  176. package/dist/types/src/internal/formats/format.d.ts +4 -2
  177. package/dist/types/src/internal/formats/format.d.ts.map +1 -1
  178. package/dist/types/src/internal/formats/select.d.ts +6 -4
  179. package/dist/types/src/internal/formats/select.d.ts.map +1 -1
  180. package/dist/types/src/internal/formats/string.d.ts +4 -0
  181. package/dist/types/src/internal/formats/string.d.ts.map +1 -1
  182. package/dist/types/src/internal/formats/types.d.ts +13 -9
  183. package/dist/types/src/internal/formats/types.d.ts.map +1 -1
  184. package/dist/types/src/internal/index.d.ts +7 -10
  185. package/dist/types/src/internal/index.d.ts.map +1 -1
  186. package/dist/types/src/internal/json-schema/annotations.d.ts.map +1 -0
  187. package/dist/types/src/internal/json-schema/effect-schema.test.d.ts.map +1 -0
  188. package/dist/types/src/internal/json-schema/index.d.ts +2 -0
  189. package/dist/types/src/internal/json-schema/index.d.ts.map +1 -1
  190. package/dist/types/src/internal/json-schema/json-schema-normalize.d.ts.map +1 -1
  191. package/dist/types/src/internal/json-schema/json-schema-type.d.ts +130 -29
  192. package/dist/types/src/internal/json-schema/json-schema-type.d.ts.map +1 -1
  193. package/dist/types/src/internal/{json → json-schema}/json-schema.d.ts +4 -2
  194. package/dist/types/src/internal/json-schema/json-schema.d.ts.map +1 -0
  195. package/dist/types/src/internal/json-schema/json-schema.test.d.ts.map +1 -0
  196. package/dist/types/src/internal/object/clone.d.ts +8 -0
  197. package/dist/types/src/internal/object/clone.d.ts.map +1 -0
  198. package/dist/types/src/internal/object/common.d.ts.map +1 -1
  199. package/dist/types/src/internal/object/{create.d.ts → create-object.d.ts} +10 -11
  200. package/dist/types/src/internal/object/create-object.d.ts.map +1 -0
  201. package/dist/types/src/internal/object/create-object.test.d.ts +2 -0
  202. package/dist/types/src/internal/object/create-object.test.d.ts.map +1 -0
  203. package/dist/types/src/internal/object/deleted.d.ts +2 -2
  204. package/dist/types/src/internal/object/deleted.d.ts.map +1 -1
  205. package/dist/types/src/internal/object/ids.d.ts.map +1 -1
  206. package/dist/types/src/internal/object/index.d.ts +6 -11
  207. package/dist/types/src/internal/object/index.d.ts.map +1 -1
  208. package/dist/types/src/internal/object/json-serializer.d.ts +14 -9
  209. package/dist/types/src/internal/object/json-serializer.d.ts.map +1 -1
  210. package/dist/types/src/internal/object/schema-validator.d.ts +1 -14
  211. package/dist/types/src/internal/object/schema-validator.d.ts.map +1 -1
  212. package/dist/types/src/internal/object/set-value.d.ts +7 -0
  213. package/dist/types/src/internal/object/set-value.d.ts.map +1 -0
  214. package/dist/types/src/internal/object/set-value.test.d.ts +2 -0
  215. package/dist/types/src/internal/object/set-value.test.d.ts.map +1 -0
  216. package/dist/types/src/internal/object/snapshot.d.ts +6 -0
  217. package/dist/types/src/internal/object/snapshot.d.ts.map +1 -0
  218. package/dist/types/src/internal/object/typed-object.d.ts +8 -14
  219. package/dist/types/src/internal/object/typed-object.d.ts.map +1 -1
  220. package/dist/types/src/internal/proxy/change-context.d.ts +55 -0
  221. package/dist/types/src/internal/proxy/change-context.d.ts.map +1 -0
  222. package/dist/types/src/internal/proxy/change.test.d.ts +2 -0
  223. package/dist/types/src/internal/proxy/change.test.d.ts.map +1 -0
  224. package/dist/types/src/internal/proxy/define-hidden-property.d.ts +5 -0
  225. package/dist/types/src/internal/proxy/define-hidden-property.d.ts.map +1 -0
  226. package/dist/types/src/internal/proxy/errors.d.ts +19 -0
  227. package/dist/types/src/internal/proxy/errors.d.ts.map +1 -0
  228. package/dist/types/src/internal/proxy/event-batch.d.ts +10 -0
  229. package/dist/types/src/internal/proxy/event-batch.d.ts.map +1 -0
  230. package/dist/types/src/internal/proxy/index.d.ts +14 -0
  231. package/dist/types/src/internal/proxy/index.d.ts.map +1 -0
  232. package/dist/types/src/internal/proxy/json-serializer.d.ts +6 -0
  233. package/dist/types/src/internal/proxy/json-serializer.d.ts.map +1 -0
  234. package/dist/types/src/internal/proxy/make-object.d.ts +14 -0
  235. package/dist/types/src/internal/proxy/make-object.d.ts.map +1 -0
  236. package/dist/types/src/internal/proxy/ownership.d.ts +57 -0
  237. package/dist/types/src/internal/proxy/ownership.d.ts.map +1 -0
  238. package/dist/types/src/internal/proxy/proxy-types.d.ts +18 -0
  239. package/dist/types/src/internal/proxy/proxy-types.d.ts.map +1 -0
  240. package/dist/types/src/internal/proxy/proxy-utils.d.ts +47 -0
  241. package/dist/types/src/internal/proxy/proxy-utils.d.ts.map +1 -0
  242. package/dist/types/src/internal/proxy/reactive-array.d.ts +8 -0
  243. package/dist/types/src/internal/proxy/reactive-array.d.ts.map +1 -0
  244. package/dist/types/src/internal/proxy/reactive.d.ts +39 -0
  245. package/dist/types/src/internal/proxy/reactive.d.ts.map +1 -0
  246. package/dist/types/src/internal/proxy/schema-validator.d.ts +15 -0
  247. package/dist/types/src/internal/proxy/schema-validator.d.ts.map +1 -0
  248. package/dist/types/src/internal/proxy/symbols.d.ts +3 -0
  249. package/dist/types/src/internal/proxy/symbols.d.ts.map +1 -0
  250. package/dist/types/src/internal/proxy/typed-handler.d.ts +16 -12
  251. package/dist/types/src/internal/proxy/typed-handler.d.ts.map +1 -1
  252. package/dist/types/src/internal/ref/ref-array.d.ts +4 -4
  253. package/dist/types/src/internal/ref/ref-array.d.ts.map +1 -1
  254. package/dist/types/src/internal/ref/ref.d.ts +43 -18
  255. package/dist/types/src/internal/ref/ref.d.ts.map +1 -1
  256. package/dist/types/src/internal/schema/compose.d.ts +7 -0
  257. package/dist/types/src/internal/schema/compose.d.ts.map +1 -0
  258. package/dist/types/src/internal/schema/compose.test.d.ts.map +1 -0
  259. package/dist/types/src/internal/schema/echo-schema.d.ts +25 -12
  260. package/dist/types/src/internal/schema/echo-schema.d.ts.map +1 -1
  261. package/dist/types/src/internal/schema/index.d.ts +1 -4
  262. package/dist/types/src/internal/schema/index.d.ts.map +1 -1
  263. package/dist/types/src/internal/schema/persistent-schema.d.ts +20 -0
  264. package/dist/types/src/internal/schema/persistent-schema.d.ts.map +1 -0
  265. package/dist/types/src/internal/types/base.d.ts +27 -0
  266. package/dist/types/src/internal/types/base.d.ts.map +1 -0
  267. package/dist/types/src/internal/types/entity.d.ts +37 -0
  268. package/dist/types/src/internal/types/entity.d.ts.map +1 -0
  269. package/dist/types/src/internal/types/index.d.ts +5 -2
  270. package/dist/types/src/internal/types/index.d.ts.map +1 -1
  271. package/dist/types/src/internal/{object → types}/meta.d.ts +16 -14
  272. package/dist/types/src/internal/types/meta.d.ts.map +1 -0
  273. package/dist/types/src/internal/types/typename.d.ts +21 -0
  274. package/dist/types/src/internal/types/typename.d.ts.map +1 -0
  275. package/dist/types/src/internal/types/version.d.ts +15 -0
  276. package/dist/types/src/internal/types/version.d.ts.map +1 -0
  277. package/dist/types/src/{test → testing}/api.test.d.ts.map +1 -1
  278. package/dist/types/src/testing/index.d.ts +3 -3
  279. package/dist/types/src/testing/index.d.ts.map +1 -1
  280. package/dist/types/src/testing/test-data.d.ts +18 -0
  281. package/dist/types/src/testing/test-data.d.ts.map +1 -0
  282. package/dist/types/src/testing/test-schema.d.ts +304 -0
  283. package/dist/types/src/testing/test-schema.d.ts.map +1 -0
  284. package/dist/types/src/testing/util.d.ts +21 -0
  285. package/dist/types/src/testing/util.d.ts.map +1 -0
  286. package/dist/types/tsconfig.tsbuildinfo +1 -1
  287. package/package.json +106 -65
  288. package/src/Annotation.ts +46 -0
  289. package/src/Collection.ts +30 -0
  290. package/src/Database.ts +315 -0
  291. package/src/Dataset.ts +24 -0
  292. package/src/Entity.test.ts +22 -0
  293. package/src/Entity.ts +234 -0
  294. package/src/Err.ts +38 -0
  295. package/src/Feed.ts +254 -0
  296. package/src/Filter.ts +389 -0
  297. package/src/Format.ts +9 -0
  298. package/src/Hypergraph.ts +74 -0
  299. package/src/JsonSchema.ts +24 -0
  300. package/src/Key.ts +3 -0
  301. package/src/Obj.test.ts +447 -0
  302. package/src/Obj.ts +580 -267
  303. package/src/Order.ts +44 -0
  304. package/src/Query.test.ts +632 -0
  305. package/src/Query.ts +520 -0
  306. package/src/QueryResult.ts +106 -0
  307. package/src/Ref.ts +77 -9
  308. package/src/Relation.test.ts +88 -0
  309. package/src/Relation.ts +440 -58
  310. package/src/SchemaRegistry.ts +106 -0
  311. package/src/{query/tag.ts → Tag.ts} +10 -8
  312. package/src/Type.test.ts +52 -0
  313. package/src/Type.ts +162 -151
  314. package/src/View.ts +100 -0
  315. package/src/hierarchy.test.ts +33 -0
  316. package/src/index.ts +20 -6
  317. package/src/internal/README.md +102 -0
  318. package/src/internal/{ast → annotations}/annotations.test.ts +18 -20
  319. package/src/internal/annotations/annotations.ts +526 -0
  320. package/src/internal/annotations/index.ts +6 -0
  321. package/src/internal/annotations/util.ts +85 -0
  322. package/src/internal/api/annotations.ts +60 -0
  323. package/src/internal/api/entity.ts +29 -0
  324. package/src/internal/api/index.ts +19 -0
  325. package/src/internal/api/meta.ts +88 -0
  326. package/src/internal/api/sorting.ts +53 -0
  327. package/src/internal/api/version.ts +96 -0
  328. package/src/internal/entities/entity.ts +128 -0
  329. package/src/internal/entities/index.ts +9 -0
  330. package/src/internal/entities/model.ts +138 -0
  331. package/src/internal/entities/object.ts +58 -0
  332. package/src/internal/entities/relation.ts +171 -0
  333. package/src/internal/entities/util.ts +33 -0
  334. package/src/internal/formats/date.test.ts +1 -1
  335. package/src/internal/formats/date.ts +5 -5
  336. package/src/internal/formats/format.test.ts +6 -6
  337. package/src/internal/formats/format.ts +8 -6
  338. package/src/internal/formats/number.ts +5 -5
  339. package/src/internal/formats/object.ts +4 -4
  340. package/src/internal/formats/select.ts +6 -4
  341. package/src/internal/formats/string.ts +14 -9
  342. package/src/internal/formats/types.ts +53 -42
  343. package/src/internal/index.ts +30 -13
  344. package/src/internal/{json → json-schema}/annotations.ts +1 -1
  345. package/src/internal/json-schema/index.ts +2 -0
  346. package/src/internal/json-schema/json-schema-normalize.ts +4 -2
  347. package/src/internal/json-schema/json-schema-type.ts +35 -35
  348. package/src/internal/{json → json-schema}/json-schema.test.ts +73 -69
  349. package/src/internal/{json → json-schema}/json-schema.ts +30 -15
  350. package/src/internal/object/clone.ts +48 -0
  351. package/src/internal/object/common.ts +3 -4
  352. package/src/internal/object/{create.test.ts → create-object.test.ts} +31 -33
  353. package/src/internal/object/{create.ts → create-object.ts} +36 -37
  354. package/src/internal/object/deleted.ts +6 -6
  355. package/src/internal/object/ids.ts +1 -1
  356. package/src/internal/object/index.ts +6 -11
  357. package/src/internal/object/inspect.ts +5 -7
  358. package/src/internal/object/json-serializer.test.ts +59 -37
  359. package/src/internal/object/json-serializer.ts +87 -108
  360. package/src/internal/object/schema-validator.test.ts +3 -7
  361. package/src/internal/object/schema-validator.ts +2 -237
  362. package/src/internal/object/set-value.test.ts +281 -0
  363. package/src/internal/object/set-value.ts +165 -0
  364. package/src/internal/object/snapshot.ts +96 -0
  365. package/src/internal/object/typed-object.test.ts +11 -11
  366. package/src/internal/object/typed-object.ts +8 -66
  367. package/src/internal/proxy/change-context.ts +138 -0
  368. package/src/internal/proxy/change.test.ts +519 -0
  369. package/src/internal/proxy/define-hidden-property.ts +14 -0
  370. package/src/internal/proxy/errors.ts +42 -0
  371. package/src/internal/proxy/event-batch.ts +44 -0
  372. package/src/internal/proxy/handler.test.ts +51 -91
  373. package/src/internal/proxy/index.ts +17 -0
  374. package/src/internal/proxy/json-serializer.ts +87 -0
  375. package/src/internal/proxy/make-object.ts +106 -0
  376. package/src/internal/proxy/ownership.ts +253 -0
  377. package/src/internal/proxy/proxy-types.ts +23 -0
  378. package/src/internal/proxy/proxy-utils.ts +150 -0
  379. package/src/internal/proxy/reactive-array.ts +71 -0
  380. package/src/internal/proxy/reactive.ts +69 -0
  381. package/src/internal/proxy/schema-validator.ts +244 -0
  382. package/src/internal/proxy/schema.test.ts +27 -18
  383. package/src/internal/proxy/symbols.ts +7 -0
  384. package/src/internal/proxy/typed-handler.test.ts +260 -48
  385. package/src/internal/proxy/typed-handler.ts +283 -61
  386. package/src/internal/proxy/typed-object.test.ts +54 -38
  387. package/src/internal/ref/ref-array.ts +4 -4
  388. package/src/internal/ref/ref.test.ts +10 -9
  389. package/src/internal/ref/ref.ts +107 -56
  390. package/src/internal/{projection → schema}/compose.test.ts +8 -9
  391. package/src/internal/{projection → schema}/compose.ts +13 -8
  392. package/src/internal/schema/echo-schema.ts +74 -33
  393. package/src/internal/schema/index.ts +1 -4
  394. package/src/internal/schema/manipulation.ts +1 -1
  395. package/src/internal/schema/persistent-schema.ts +33 -0
  396. package/src/internal/types/base.ts +43 -0
  397. package/src/internal/types/entity.ts +54 -0
  398. package/src/internal/types/index.ts +5 -2
  399. package/src/internal/types/meta.ts +68 -0
  400. package/src/internal/types/typename.ts +55 -0
  401. package/src/internal/types/version.ts +19 -0
  402. package/src/testing/api.test.ts +126 -0
  403. package/src/testing/index.ts +3 -3
  404. package/src/testing/test-data.ts +130 -0
  405. package/src/testing/test-schema.ts +240 -0
  406. package/src/testing/util.ts +85 -0
  407. package/dist/lib/browser/chunk-HKFCK2GL.mjs +0 -175
  408. package/dist/lib/browser/chunk-HKFCK2GL.mjs.map +0 -7
  409. package/dist/lib/browser/chunk-MAAYELT7.mjs +0 -830
  410. package/dist/lib/browser/chunk-MAAYELT7.mjs.map +0 -7
  411. package/dist/lib/browser/chunk-MB6MMNFP.mjs +0 -3857
  412. package/dist/lib/browser/chunk-MB6MMNFP.mjs.map +0 -7
  413. package/dist/lib/browser/index.mjs +0 -35
  414. package/dist/lib/browser/internal/index.mjs +0 -332
  415. package/dist/lib/browser/meta.json +0 -1
  416. package/dist/lib/browser/query/index.mjs +0 -15
  417. package/dist/lib/browser/testing/index.mjs +0 -298
  418. package/dist/lib/browser/testing/index.mjs.map +0 -7
  419. package/dist/lib/node-esm/chunk-5NWDGIBT.mjs +0 -830
  420. package/dist/lib/node-esm/chunk-5NWDGIBT.mjs.map +0 -7
  421. package/dist/lib/node-esm/chunk-AUAH4E2J.mjs +0 -175
  422. package/dist/lib/node-esm/chunk-AUAH4E2J.mjs.map +0 -7
  423. package/dist/lib/node-esm/chunk-BQRA4VLX.mjs +0 -3857
  424. package/dist/lib/node-esm/chunk-BQRA4VLX.mjs.map +0 -7
  425. package/dist/lib/node-esm/index.mjs +0 -35
  426. package/dist/lib/node-esm/meta.json +0 -1
  427. package/dist/lib/node-esm/query/index.mjs +0 -15
  428. package/dist/lib/node-esm/testing/index.mjs +0 -298
  429. package/dist/lib/node-esm/testing/index.mjs.map +0 -7
  430. package/dist/types/src/errors.d.ts +0 -72
  431. package/dist/types/src/errors.d.ts.map +0 -1
  432. package/dist/types/src/internal/ast/annotation-helper.d.ts +0 -8
  433. package/dist/types/src/internal/ast/annotation-helper.d.ts.map +0 -1
  434. package/dist/types/src/internal/ast/annotations.d.ts +0 -125
  435. package/dist/types/src/internal/ast/annotations.d.ts.map +0 -1
  436. package/dist/types/src/internal/ast/annotations.test.d.ts.map +0 -1
  437. package/dist/types/src/internal/ast/entity-kind.d.ts +0 -10
  438. package/dist/types/src/internal/ast/entity-kind.d.ts.map +0 -1
  439. package/dist/types/src/internal/ast/index.d.ts +0 -5
  440. package/dist/types/src/internal/ast/index.d.ts.map +0 -1
  441. package/dist/types/src/internal/ast/types.d.ts +0 -6
  442. package/dist/types/src/internal/ast/types.d.ts.map +0 -1
  443. package/dist/types/src/internal/json/annotations.d.ts.map +0 -1
  444. package/dist/types/src/internal/json/effect-schema.test.d.ts.map +0 -1
  445. package/dist/types/src/internal/json/index.d.ts +0 -2
  446. package/dist/types/src/internal/json/index.d.ts.map +0 -1
  447. package/dist/types/src/internal/json/json-schema.d.ts.map +0 -1
  448. package/dist/types/src/internal/json/json-schema.test.d.ts.map +0 -1
  449. package/dist/types/src/internal/object/accessors.d.ts +0 -37
  450. package/dist/types/src/internal/object/accessors.d.ts.map +0 -1
  451. package/dist/types/src/internal/object/create.d.ts.map +0 -1
  452. package/dist/types/src/internal/object/create.test.d.ts +0 -2
  453. package/dist/types/src/internal/object/create.test.d.ts.map +0 -1
  454. package/dist/types/src/internal/object/entity.d.ts +0 -33
  455. package/dist/types/src/internal/object/entity.d.ts.map +0 -1
  456. package/dist/types/src/internal/object/expando.d.ts +0 -14
  457. package/dist/types/src/internal/object/expando.d.ts.map +0 -1
  458. package/dist/types/src/internal/object/meta.d.ts.map +0 -1
  459. package/dist/types/src/internal/object/model.d.ts +0 -117
  460. package/dist/types/src/internal/object/model.d.ts.map +0 -1
  461. package/dist/types/src/internal/object/relation.d.ts +0 -17
  462. package/dist/types/src/internal/object/relation.d.ts.map +0 -1
  463. package/dist/types/src/internal/object/typename.d.ts +0 -15
  464. package/dist/types/src/internal/object/typename.d.ts.map +0 -1
  465. package/dist/types/src/internal/object/version.d.ts +0 -14
  466. package/dist/types/src/internal/object/version.d.ts.map +0 -1
  467. package/dist/types/src/internal/projection/compose.d.ts +0 -6
  468. package/dist/types/src/internal/projection/compose.d.ts.map +0 -1
  469. package/dist/types/src/internal/projection/compose.test.d.ts.map +0 -1
  470. package/dist/types/src/internal/projection/index.d.ts +0 -2
  471. package/dist/types/src/internal/projection/index.d.ts.map +0 -1
  472. package/dist/types/src/internal/proxy/reactive-object.d.ts +0 -15
  473. package/dist/types/src/internal/proxy/reactive-object.d.ts.map +0 -1
  474. package/dist/types/src/internal/query/index.d.ts +0 -2
  475. package/dist/types/src/internal/query/index.d.ts.map +0 -1
  476. package/dist/types/src/internal/query/query.d.ts +0 -17
  477. package/dist/types/src/internal/query/query.d.ts.map +0 -1
  478. package/dist/types/src/internal/schema/runtime-schema-registry.d.ts +0 -18
  479. package/dist/types/src/internal/schema/runtime-schema-registry.d.ts.map +0 -1
  480. package/dist/types/src/internal/schema/snapshot.d.ts +0 -6
  481. package/dist/types/src/internal/schema/snapshot.d.ts.map +0 -1
  482. package/dist/types/src/internal/schema/stored-schema.d.ts +0 -13
  483. package/dist/types/src/internal/schema/stored-schema.d.ts.map +0 -1
  484. package/dist/types/src/internal/testing/index.d.ts +0 -3
  485. package/dist/types/src/internal/testing/index.d.ts.map +0 -1
  486. package/dist/types/src/internal/testing/types.d.ts +0 -455
  487. package/dist/types/src/internal/testing/types.d.ts.map +0 -1
  488. package/dist/types/src/internal/testing/utils.d.ts +0 -10
  489. package/dist/types/src/internal/testing/utils.d.ts.map +0 -1
  490. package/dist/types/src/internal/types/types.d.ts +0 -79
  491. package/dist/types/src/internal/types/types.d.ts.map +0 -1
  492. package/dist/types/src/internal/types/types.test.d.ts +0 -2
  493. package/dist/types/src/internal/types/types.test.d.ts.map +0 -1
  494. package/dist/types/src/internal/types/util.d.ts +0 -5
  495. package/dist/types/src/internal/types/util.d.ts.map +0 -1
  496. package/dist/types/src/query/index.d.ts +0 -3
  497. package/dist/types/src/query/index.d.ts.map +0 -1
  498. package/dist/types/src/query/query.d.ts +0 -248
  499. package/dist/types/src/query/query.d.ts.map +0 -1
  500. package/dist/types/src/query/query.test.d.ts +0 -2
  501. package/dist/types/src/query/query.test.d.ts.map +0 -1
  502. package/dist/types/src/query/tag.d.ts +0 -17
  503. package/dist/types/src/query/tag.d.ts.map +0 -1
  504. package/dist/types/src/testing/echo-schema.d.ts +0 -7
  505. package/dist/types/src/testing/echo-schema.d.ts.map +0 -1
  506. package/dist/types/src/testing/types.d.ts +0 -113
  507. package/dist/types/src/testing/types.d.ts.map +0 -1
  508. package/src/errors.ts +0 -18
  509. package/src/internal/ast/annotation-helper.ts +0 -22
  510. package/src/internal/ast/annotations.ts +0 -219
  511. package/src/internal/ast/entity-kind.ts +0 -15
  512. package/src/internal/ast/index.ts +0 -8
  513. package/src/internal/ast/types.ts +0 -17
  514. package/src/internal/json/index.ts +0 -5
  515. package/src/internal/object/accessors.ts +0 -153
  516. package/src/internal/object/entity.ts +0 -248
  517. package/src/internal/object/expando.ts +0 -21
  518. package/src/internal/object/meta.ts +0 -61
  519. package/src/internal/object/model.ts +0 -170
  520. package/src/internal/object/relation.ts +0 -24
  521. package/src/internal/object/typename.ts +0 -61
  522. package/src/internal/object/version.ts +0 -22
  523. package/src/internal/projection/index.ts +0 -5
  524. package/src/internal/proxy/reactive-object.ts +0 -108
  525. package/src/internal/query/index.ts +0 -5
  526. package/src/internal/query/query.ts +0 -23
  527. package/src/internal/schema/runtime-schema-registry.ts +0 -78
  528. package/src/internal/schema/snapshot.ts +0 -25
  529. package/src/internal/schema/stored-schema.ts +0 -26
  530. package/src/internal/testing/index.ts +0 -6
  531. package/src/internal/testing/types.ts +0 -211
  532. package/src/internal/testing/utils.ts +0 -54
  533. package/src/internal/types/types.test.ts +0 -48
  534. package/src/internal/types/types.ts +0 -176
  535. package/src/internal/types/util.ts +0 -9
  536. package/src/query/index.ts +0 -6
  537. package/src/query/query.test.ts +0 -401
  538. package/src/query/query.ts +0 -789
  539. package/src/test/api.test.ts +0 -180
  540. package/src/testing/echo-schema.ts +0 -39
  541. package/src/testing/types.ts +0 -91
  542. /package/dist/lib/{browser/index.mjs.map → neutral/Annotation.mjs.map} +0 -0
  543. /package/dist/lib/{browser/internal/index.mjs.map → neutral/Database.mjs.map} +0 -0
  544. /package/dist/lib/{browser/query/index.mjs.map → neutral/Entity.mjs.map} +0 -0
  545. /package/dist/lib/{node-esm/index.mjs.map → neutral/Err.mjs.map} +0 -0
  546. /package/dist/lib/{node-esm/internal/index.mjs.map → neutral/Feed.mjs.map} +0 -0
  547. /package/dist/lib/{node-esm/query/index.mjs.map → neutral/Filter.mjs.map} +0 -0
  548. /package/dist/types/src/internal/{ast → annotations}/annotations.test.d.ts +0 -0
  549. /package/dist/types/src/internal/{json → json-schema}/annotations.d.ts +0 -0
  550. /package/dist/types/src/internal/{json → json-schema}/effect-schema.test.d.ts +0 -0
  551. /package/dist/types/src/internal/{json → json-schema}/json-schema.test.d.ts +0 -0
  552. /package/dist/types/src/internal/{projection → schema}/compose.test.d.ts +0 -0
  553. /package/dist/types/src/{test → testing}/api.test.d.ts +0 -0
  554. /package/src/internal/{json → json-schema}/effect-schema.test.ts +0 -0
@@ -1,219 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- import * as Function from 'effect/Function';
6
- import * as Option from 'effect/Option';
7
- import * as Schema from 'effect/Schema';
8
- import * as SchemaAST from 'effect/SchemaAST';
9
-
10
- import { assertArgument } from '@dxos/invariant';
11
- import { DXN } from '@dxos/keys';
12
- import { type Primitive } from '@dxos/util';
13
-
14
- import { createAnnotationHelper } from './annotation-helper';
15
- import { EntityKind } from './entity-kind';
16
-
17
- /**
18
- * If property is optional returns the nested property, otherwise returns the property.
19
- */
20
- // TODO(wittjosiah): Is there a way to do this as a generic?
21
- export const unwrapOptional = (property: SchemaAST.PropertySignature) => {
22
- if (!property.isOptional || !SchemaAST.isUnion(property.type)) {
23
- return property;
24
- }
25
-
26
- return property.type.types[0];
27
- };
28
-
29
- /**
30
- * ECHO identifier (for a stored schema).
31
- * Must be a `dxn:echo:` URI.
32
- */
33
- export const TypeIdentifierAnnotationId = Symbol.for('@dxos/schema/annotation/TypeIdentifier');
34
-
35
- export const getTypeIdentifierAnnotation = (schema: Schema.Schema.All) =>
36
- Function.flow(
37
- SchemaAST.getAnnotation<string>(TypeIdentifierAnnotationId),
38
- Option.getOrElse(() => undefined),
39
- )(schema.ast);
40
-
41
- /**
42
- * ECHO type.
43
- */
44
- export const TypeAnnotationId = Symbol.for('@dxos/schema/annotation/Type');
45
-
46
- // TODO(burdon): Create echo-schema Format types.
47
- // TODO(burdon): Reconcile with "short" DXN.
48
- export const Typename = Schema.String.pipe(Schema.pattern(/^[a-zA-Z]\w+\.[a-zA-Z]\w{1,}\/[\w/_-]+$/));
49
- export const SchemaVersion = Schema.String.pipe(Schema.pattern(/^\d+.\d+.\d+$/));
50
-
51
- /**
52
- * Payload stored under {@link TypeAnnotationId}.
53
- */
54
- // TODO(dmaretskyi): Rename getTypeAnnotation to represent commonality between objects and relations (e.g. `entity`).
55
- export const TypeAnnotation = Schema.Struct({
56
- kind: Schema.Enums(EntityKind),
57
- typename: Typename,
58
- version: SchemaVersion,
59
-
60
- /**
61
- * If this is a relation, the schema of the source object.
62
- * Must be present if entity kind is {@link EntityKind.Relation}.
63
- */
64
- sourceSchema: Schema.optional(DXN.Schema),
65
-
66
- /**
67
- * If this is a relation, the schema of the target object.
68
- * Must be present if entity kind is {@link EntityKind.Relation}.
69
- */
70
- targetSchema: Schema.optional(DXN.Schema),
71
- });
72
-
73
- export interface TypeAnnotation extends Schema.Schema.Type<typeof TypeAnnotation> {}
74
-
75
- export type TypeMeta = Pick<TypeAnnotation, 'typename' | 'version'>;
76
-
77
- /**
78
- * @returns {@link TypeAnnotation} from a schema.
79
- * Schema must have been created with {@link TypedObject} or {@link TypedLink} or manually assigned an appropriate annotation.
80
- */
81
- export const getTypeAnnotation = (schema: Schema.Schema.All): TypeAnnotation | undefined => {
82
- assertArgument(schema != null && schema.ast != null, 'schema', 'invalid schema');
83
- return Function.flow(
84
- SchemaAST.getAnnotation<TypeAnnotation>(TypeAnnotationId),
85
- Option.getOrElse(() => undefined),
86
- )(schema.ast);
87
- };
88
-
89
- /**
90
- * @returns {@link EntityKind} from a schema.
91
- */
92
- export const getEntityKind = (schema: Schema.Schema.All): EntityKind | undefined => getTypeAnnotation(schema)?.kind;
93
-
94
- /**
95
- * @deprecated Use {@link Type.getTypename} instead.
96
- * @returns Schema typename (without dxn: prefix or version number).
97
- */
98
- export const getSchemaTypename = (schema: Schema.Schema.All): string | undefined => getTypeAnnotation(schema)?.typename;
99
-
100
- /**
101
- * @deprecated Use {@link Type.getVersion} instead.
102
- * @returns Schema version in semver format.
103
- */
104
- export const getSchemaVersion = (schema: Schema.Schema.All): string | undefined => getTypeAnnotation(schema)?.version;
105
-
106
- /**
107
- * PropertyMeta (metadata for dynamic schema properties).
108
- * For user-defined annotations.
109
- */
110
- export const PropertyMetaAnnotationId = Symbol.for('@dxos/schema/annotation/PropertyMeta');
111
-
112
- export type PropertyMetaValue = Primitive | Record<string, Primitive> | Primitive[];
113
-
114
- export type PropertyMetaAnnotation = {
115
- [name: string]: PropertyMetaValue;
116
- };
117
-
118
- export const PropertyMeta = (name: string, value: PropertyMetaValue) => {
119
- return <A, I, R>(self: Schema.Schema<A, I, R>): Schema.Schema<A, I, R> => {
120
- const existingMeta = self.ast.annotations[PropertyMetaAnnotationId] as PropertyMetaAnnotation;
121
- return self.annotations({
122
- [PropertyMetaAnnotationId]: {
123
- ...existingMeta,
124
- [name]: value,
125
- },
126
- });
127
- };
128
- };
129
-
130
- export const getPropertyMetaAnnotation = <T>(prop: SchemaAST.PropertySignature, name: string) =>
131
- Function.pipe(
132
- SchemaAST.getAnnotation<PropertyMetaAnnotation>(PropertyMetaAnnotationId)(prop.type),
133
- Option.map((meta) => meta[name] as T),
134
- Option.getOrElse(() => undefined),
135
- );
136
-
137
- /**
138
- * Schema reference.
139
- */
140
- export const ReferenceAnnotationId = Symbol.for('@dxos/schema/annotation/Reference');
141
-
142
- export type ReferenceAnnotationValue = TypeAnnotation;
143
-
144
- export const getReferenceAnnotation = (schema: Schema.Schema.AnyNoContext) =>
145
- Function.pipe(
146
- SchemaAST.getAnnotation<ReferenceAnnotationValue>(ReferenceAnnotationId)(schema.ast),
147
- Option.getOrElse(() => undefined),
148
- );
149
-
150
- /**
151
- * SchemaMeta.
152
- */
153
- export const SchemaMetaSymbol = Symbol.for('@dxos/schema/SchemaMeta');
154
-
155
- export type SchemaMeta = TypeMeta & { id: string };
156
-
157
- /**
158
- * Identifies a schema as a view.
159
- */
160
- export const ViewAnnotationId = Symbol.for('@dxos/schema/annotation/View');
161
- export const ViewAnnotation = createAnnotationHelper<boolean>(ViewAnnotationId);
162
-
163
- /**
164
- * Identifies label property or JSON path expression.
165
- * Either a string or an array of strings representing field accessors each matched in priority order.
166
- */
167
- export const LabelAnnotationId = Symbol.for('@dxos/schema/annotation/Label');
168
- export const LabelAnnotation = createAnnotationHelper<string[]>(LabelAnnotationId);
169
-
170
- /**
171
- * Identifies description property or JSON path expression.
172
- * A string representing field accessor.
173
- */
174
- export const DescriptionAnnotationId = Symbol.for('@dxos/schema/annotation/Description');
175
- export const DescriptionAnnotation = createAnnotationHelper<string>(DescriptionAnnotationId);
176
-
177
- /**
178
- * Default field to be used on referenced schema to lookup the value.
179
- */
180
- export const FieldLookupAnnotationId = Symbol.for('@dxos/schema/annotation/FieldLookup');
181
-
182
- /**
183
- * Generate test data.
184
- */
185
- export const GeneratorAnnotationId = Symbol.for('@dxos/schema/annotation/Generator');
186
-
187
- export type GeneratorAnnotationValue =
188
- | string
189
- | {
190
- generator: string;
191
- args?: any[];
192
- probability?: number;
193
- };
194
-
195
- export const GeneratorAnnotation = createAnnotationHelper<GeneratorAnnotationValue>(GeneratorAnnotationId);
196
-
197
- /**
198
- * @returns DXN of the schema.
199
- *
200
- * For non-stored schema returns `dxn:type:`.
201
- * For stored schema returns `dxn:echo:`.
202
- * @deprecated Use `Type.getDXN`.
203
- */
204
- export const getSchemaDXN = (schema: Schema.Schema.All): DXN | undefined => {
205
- assertArgument(Schema.isSchema(schema), 'schema', 'invalid schema');
206
-
207
- const id = getTypeIdentifierAnnotation(schema);
208
- if (id) {
209
- return DXN.parse(id);
210
- }
211
-
212
- // TODO(dmaretskyi): Add support for dynamic schema.
213
- const objectAnnotation = getTypeAnnotation(schema);
214
- if (!objectAnnotation) {
215
- return undefined;
216
- }
217
-
218
- return DXN.fromTypenameAndVersion(objectAnnotation.typename, objectAnnotation.version);
219
- };
@@ -1,15 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- import * as Schema from 'effect/Schema';
6
-
7
- /**
8
- * Kinds of entities stored in ECHO: objects and relations.
9
- */
10
- export enum EntityKind {
11
- Object = 'object',
12
- Relation = 'relation',
13
- }
14
-
15
- export const EntityKindSchema = Schema.Enums(EntityKind);
@@ -1,8 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- export * from './annotations';
6
- export * from './annotation-helper';
7
- export * from './types';
8
- export * from './entity-kind';
@@ -1,17 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- import { PropertyMeta } from './annotations';
6
-
7
- /**
8
- * @internal
9
- */
10
- export const FIELD_PATH_ANNOTATION = 'path';
11
-
12
- /**
13
- * Sets the path for the field.
14
- * @param path Data source path in the json path format. This is the field path in the source object.
15
- */
16
- // TODO(burdon): Field, vs. path vs. property.
17
- export const FieldPath = (path: string) => PropertyMeta(FIELD_PATH_ANNOTATION, path);
@@ -1,5 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- export * from './json-schema';
@@ -1,153 +0,0 @@
1
- //
2
- // Copyright 2025 DXOS.org
3
- //
4
-
5
- import * as Option from 'effect/Option';
6
- import * as Schema from 'effect/Schema';
7
-
8
- import { type JsonPath, getField } from '@dxos/effect';
9
- import { assertArgument, invariant } from '@dxos/invariant';
10
- import { DXN, ObjectId } from '@dxos/keys';
11
- import { assumeType } from '@dxos/util';
12
-
13
- import { DescriptionAnnotation, LabelAnnotation } from '../ast';
14
-
15
- import { type InternalObjectProps, SchemaId, SelfDXNId } from './model';
16
-
17
- //
18
- // Accessors based on model.
19
- //
20
-
21
- /**
22
- * Returns a DXN for an object or schema.
23
- * @deprecated Use `Obj.getDXN`.
24
- */
25
- export const getObjectDXN = (object: any): DXN | undefined => {
26
- invariant(!Schema.isSchema(object), 'schema not allowed in this function');
27
- assertArgument(typeof object === 'object' && object != null, 'object', 'expected object');
28
- assumeType<InternalObjectProps>(object);
29
-
30
- if (object[SelfDXNId]) {
31
- invariant(object[SelfDXNId] instanceof DXN, 'Invalid object model: invalid self dxn');
32
- return object[SelfDXNId];
33
- }
34
-
35
- if (!ObjectId.isValid(object.id)) {
36
- throw new TypeError('Object id is not valid.');
37
- }
38
-
39
- return DXN.fromLocalObjectId(object.id);
40
- };
41
-
42
- /**
43
- * Returns the schema for the given object if one is defined.
44
- */
45
- // TODO(burdon): Reconcile with `getTypename`.
46
- // TODO(dmaretskyi): For echo objects, this always returns the root schema.
47
- export const getSchema = (obj: unknown | undefined): Schema.Schema.AnyNoContext | undefined => {
48
- if (obj) {
49
- return (obj as any)[SchemaId];
50
- }
51
- };
52
-
53
- /**
54
- * Internal use only.
55
- */
56
- export const setSchema = (obj: any, schema: Schema.Schema.AnyNoContext) => {
57
- Object.defineProperty(obj, SchemaId, {
58
- value: schema,
59
- writable: false,
60
- enumerable: false,
61
- configurable: false,
62
- });
63
- };
64
-
65
- /**
66
- * @deprecated Use {@link Obj.getLabel} instead.
67
- * Returns the label for a given object based on {@link LabelAnnotationId}.
68
- */
69
- export const getLabelForObject = (obj: unknown | undefined): string | undefined => {
70
- const schema = getSchema(obj);
71
- if (schema) {
72
- return getLabel(schema, obj);
73
- }
74
- };
75
-
76
- /**
77
- * Returns the label for a given object based on {@link LabelAnnotationId}.
78
- */
79
- // TODO(burdon): Convert to JsonPath?
80
- export const getLabel = <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>): string | undefined => {
81
- const annotation = LabelAnnotation.get(schema).pipe(Option.getOrElse(() => ['name']));
82
- for (const accessor of annotation) {
83
- assertArgument(
84
- typeof accessor === 'string',
85
- 'accessor',
86
- 'Label annotation must be a string or an array of strings',
87
- );
88
- const value = getField(object, accessor as JsonPath);
89
- switch (typeof value) {
90
- case 'string':
91
- case 'number':
92
- case 'boolean':
93
- case 'bigint':
94
- case 'symbol':
95
- return value.toString();
96
- case 'undefined':
97
- case 'object':
98
- case 'function':
99
- continue;
100
- }
101
- }
102
-
103
- return undefined;
104
- };
105
-
106
- /**
107
- * Sets the label for a given object based on {@link LabelAnnotationId}.
108
- */
109
- export const setLabel = <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, label: string) => {
110
- const annotation = LabelAnnotation.get(schema).pipe(
111
- Option.map((field) => field[0]),
112
- Option.getOrElse(() => 'name'),
113
- );
114
- object[annotation] = label;
115
- };
116
-
117
- /**
118
- * Returns the label for a given object based on {@link LabelAnnotationId}.
119
- */
120
- // TODO(burdon): Convert to JsonPath?
121
- export const getDescription = <S extends Schema.Schema.Any>(
122
- schema: S,
123
- object: Schema.Schema.Type<S>,
124
- ): string | undefined => {
125
- const accessor = DescriptionAnnotation.get(schema).pipe(Option.getOrElse(() => 'description'));
126
- assertArgument(typeof accessor === 'string', 'accessor', 'Description annotation must be a string');
127
- const value = getField(object, accessor as JsonPath);
128
- switch (typeof value) {
129
- case 'string':
130
- case 'number':
131
- case 'boolean':
132
- case 'bigint':
133
- case 'symbol':
134
- return value.toString();
135
- case 'undefined':
136
- case 'object':
137
- case 'function':
138
- default:
139
- return undefined;
140
- }
141
- };
142
-
143
- /**
144
- * Sets the description for a given object based on {@link DescriptionAnnotationId}.
145
- */
146
- export const setDescription = <S extends Schema.Schema.Any>(
147
- schema: S,
148
- object: Schema.Schema.Type<S>,
149
- description: string,
150
- ) => {
151
- const accessor = DescriptionAnnotation.get(schema).pipe(Option.getOrElse(() => 'description'));
152
- object[accessor] = description;
153
- };
@@ -1,248 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- import * as Schema from 'effect/Schema';
6
- import * as SchemaAST from 'effect/SchemaAST';
7
- import type * as Types from 'effect/Types';
8
-
9
- import { raise } from '@dxos/debug';
10
- import { assertArgument, invariant } from '@dxos/invariant';
11
- import { DXN } from '@dxos/keys';
12
-
13
- import {
14
- EntityKind,
15
- type TypeAnnotation,
16
- TypeAnnotationId,
17
- type TypeMeta,
18
- getEntityKind,
19
- getSchemaTypename,
20
- getTypeIdentifierAnnotation,
21
- } from '../ast';
22
- import { type HasId, type ToMutable } from '../types';
23
-
24
- import { type RelationSourceTargetRefs } from './relation';
25
-
26
- // TODO(burdon): Define Schema type for `typename` and use consistently for all DXN-like properties.
27
-
28
- // type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
29
- type EchoTypeSchemaProps<T, ExtraFields = {}> = Types.Simplify<HasId & ToMutable<T> & ExtraFields>;
30
-
31
- export interface EchoTypeSchema<Self extends Schema.Schema.Any, ExtraFields = {}>
32
- extends TypeMeta,
33
- Schema.AnnotableClass<
34
- EchoTypeSchema<Self, ExtraFields>,
35
- EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields>,
36
- EchoTypeSchemaProps<Schema.Schema.Encoded<Self>, ExtraFields>,
37
- Schema.Schema.Context<Self>
38
- > {
39
- // make(
40
- // props: RequiredKeys<Schema.TypeLiteral.Constructor<Fields, []>> extends never
41
- // ? void | Simplify<Schema.TypeLiteral.Constructor<Fields, []>>
42
- // : Simplify<Schema.TypeLiteral.Constructor<Fields, []>>,
43
- // options?: MakeOptions,
44
- // ): Simplify<Schema.TypeLiteral.Type<Fields, []>>;
45
-
46
- instanceOf(value: unknown): boolean;
47
- }
48
-
49
- /**
50
- * Pipeable function to add ECHO object annotations to a schema.
51
- */
52
- // TODO(dmaretskyi): Rename EchoObjectSchema.
53
- export const EchoObject: {
54
- // TODO(burdon): Tighten Self type to Schema.TypeLiteral or Schema.Struct to facilitate definition of `make` method.
55
- // (meta: TypeMeta): <Self extends Schema.Struct<Fields>, Fields extends Schema.Struct.Fields>(self: Self) => EchoObjectSchema<Self, Fields>;
56
- (meta: TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => EchoTypeSchema<Self>;
57
- } = ({ typename, version }) => {
58
- return <Self extends Schema.Schema.Any>(self: Self): EchoTypeSchema<Self> => {
59
- invariant(typeof TypeAnnotationId === 'symbol', 'Sanity.');
60
- invariant(SchemaAST.isTypeLiteral(self.ast), 'Schema must be a TypeLiteral.');
61
-
62
- // TODO(dmaretskyi): Does `Schema.mutable` work for deep mutability here?
63
- // TODO(dmaretskyi): Do not do mutable here.
64
- const schemaWithId = Schema.extend(Schema.mutable(self), Schema.Struct({ id: Schema.String }));
65
- const ast = SchemaAST.annotations(schemaWithId.ast, {
66
- // TODO(dmaretskyi): `extend` kills the annotations.
67
- ...self.ast.annotations,
68
- [TypeAnnotationId]: { kind: EntityKind.Object, typename, version } satisfies TypeAnnotation,
69
- // TODO(dmaretskyi): TypeIdentifierAnnotationId?
70
- [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
71
- kind: EntityKind.Object,
72
- typename,
73
- version,
74
- }),
75
- });
76
-
77
- return makeEchoObjectSchema<Self>(/* self.fields, */ ast, typename, version);
78
- };
79
- };
80
-
81
- export type EchoRelationOptions<
82
- TSource extends Schema.Schema.AnyNoContext,
83
- TTarget extends Schema.Schema.AnyNoContext,
84
- > = TypeMeta & {
85
- source: TSource;
86
- target: TTarget;
87
- };
88
-
89
- // TODO(dmaretskyi): Rename EchoRelationSchema.
90
- export const EchoRelation = <Source extends Schema.Schema.AnyNoContext, Target extends Schema.Schema.AnyNoContext>(
91
- options: EchoRelationOptions<Source, Target>,
92
- ) => {
93
- assertArgument(Schema.isSchema(options.source), 'source');
94
- assertArgument(Schema.isSchema(options.target), 'target');
95
- const sourceDXN = getDXNForRelationSchemaRef(options.source);
96
- const targetDXN = getDXNForRelationSchemaRef(options.target);
97
- if (getEntityKind(options.source) !== EntityKind.Object) {
98
- raise(new Error('Source schema must be an echo object schema.'));
99
- }
100
- if (getEntityKind(options.target) !== EntityKind.Object) {
101
- raise(new Error('Target schema must be an echo object schema.'));
102
- }
103
-
104
- return <Self extends Schema.Schema.Any>(
105
- self: Self,
106
- ): EchoTypeSchema<Self, RelationSourceTargetRefs<Schema.Schema.Type<Source>, Schema.Schema.Type<Target>>> => {
107
- invariant(SchemaAST.isTypeLiteral(self.ast), 'Schema must be a TypeLiteral.');
108
-
109
- // TODO(dmaretskyi): Does `Schema.mutable` work for deep mutability here?
110
- // TODO(dmaretskyi): Do not do mutable here.
111
- const schemaWithId = Schema.extend(Schema.mutable(self), Schema.Struct({ id: Schema.String }));
112
- const ast = SchemaAST.annotations(schemaWithId.ast, {
113
- // TODO(dmaretskyi): `extend` kills the annotations.
114
- ...self.ast.annotations,
115
- [TypeAnnotationId]: {
116
- kind: EntityKind.Relation,
117
- typename: options.typename,
118
- version: options.version,
119
- sourceSchema: sourceDXN,
120
- targetSchema: targetDXN,
121
- } satisfies TypeAnnotation,
122
- // TODO(dmaretskyi): TypeIdentifierAnnotationId?
123
-
124
- [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
125
- kind: EntityKind.Relation,
126
- typename: options.typename,
127
- version: options.version,
128
- relationSource: sourceDXN,
129
- relationTarget: targetDXN,
130
- }),
131
- });
132
-
133
- return makeEchoObjectSchema<Self>(/* self.fields, */ ast, options.typename, options.version);
134
- };
135
- };
136
-
137
- /**
138
- * @returns JSON-schema annotation so that the schema can be serialized with correct parameters.
139
- */
140
- export const makeTypeJsonSchemaAnnotation = (options: {
141
- identifier?: string;
142
- kind: EntityKind;
143
- typename: string;
144
- version: string;
145
- relationSource?: string;
146
- relationTarget?: string;
147
- }) => {
148
- assertArgument(!!options.relationSource === (options.kind === EntityKind.Relation), 'relationSource');
149
- assertArgument(!!options.relationTarget === (options.kind === EntityKind.Relation), 'relationTarget');
150
-
151
- const obj = {
152
- // TODO(dmaretskyi): Should this include the version?
153
- $id: options.identifier ?? DXN.fromTypename(options.typename).toString(),
154
- entityKind: options.kind,
155
- version: options.version,
156
- typename: options.typename,
157
- } as any;
158
- if (options.kind === EntityKind.Relation) {
159
- obj.relationSource = { $ref: options.relationSource };
160
- obj.relationTarget = { $ref: options.relationTarget };
161
- }
162
- return obj;
163
- };
164
-
165
- const getDXNForRelationSchemaRef = (schema: Schema.Schema.Any): string => {
166
- assertArgument(Schema.isSchema(schema), 'schema');
167
- const identifier = getTypeIdentifierAnnotation(schema);
168
- if (identifier) {
169
- return identifier;
170
- }
171
-
172
- const typename = getSchemaTypename(schema);
173
- if (!typename) {
174
- throw new Error('Schema must have a typename');
175
- }
176
-
177
- return DXN.fromTypename(typename).toString();
178
- };
179
-
180
- // type MakeOptions =
181
- // | boolean
182
- // | {
183
- // readonly disableValidation?: boolean;
184
- // };
185
-
186
- // NOTE: Utils copied from Effect `Schema.ts`.
187
- // const _ownKeys = (o: object): Array<PropertyKey> =>
188
- // (Object.keys(o) as Array<PropertyKey>).concat(Object.getOwnPropertySymbols(o));
189
-
190
- // const _lazilyMergeDefaults = (
191
- // fields: Schema.Struct.Fields,
192
- // out: Record<PropertyKey, unknown>,
193
- // ): { [x: string | symbol]: unknown } => {
194
- // const ownKeys = _ownKeys(fields);
195
- // for (const key of ownKeys) {
196
- // const field = fields[key];
197
- // if (out[key] === undefined && Schema.isPropertySignature(field)) {
198
- // const ast = field.ast;
199
- // const defaultValue = ast._tag === 'PropertySignatureDeclaration' ? ast.defaultValue : ast.to.defaultValue;
200
- // if (defaultValue !== undefined) {
201
- // out[key] = defaultValue();
202
- // }
203
- // }
204
- // }
205
- // return out;
206
- // };
207
-
208
- // const _getDisableValidationMakeOption = (options: MakeOptions | undefined): boolean =>
209
- // Predicate.isBoolean(options) ? options : options?.disableValidation ?? false;
210
-
211
- const makeEchoObjectSchema = <Self extends Schema.Schema.Any>(
212
- // fields: Fields,
213
- ast: SchemaAST.AST,
214
- typename: string,
215
- version: string,
216
- ): EchoTypeSchema<Self> => {
217
- return class EchoObjectSchemaClass extends Schema.make<
218
- EchoTypeSchemaProps<Schema.Schema.Type<Self>>,
219
- EchoTypeSchemaProps<Schema.Schema.Encoded<Self>>,
220
- Schema.Schema.Context<Self>
221
- >(ast) {
222
- static readonly typename = typename;
223
- static readonly version = version;
224
-
225
- static override annotations(
226
- annotations: Schema.Annotations.GenericSchema<EchoTypeSchemaProps<Schema.Schema.Type<Self>>>,
227
- ): EchoTypeSchema<Self> {
228
- const schema = Schema.make<EchoTypeSchemaProps<Schema.Schema.Type<Self>>>(ast).annotations(annotations);
229
- return makeEchoObjectSchema<Self>(/* fields, */ schema.ast, typename, version);
230
- }
231
-
232
- // static make(
233
- // props: RequiredKeys<Schema.TypeLiteral.Constructor<Fields, []>> extends never
234
- // ? void | Simplify<Schema.TypeLiteral.Constructor<Fields, []>>
235
- // : Simplify<Schema.TypeLiteral.Constructor<Fields, []>>,
236
- // options?: MakeOptions,
237
- // ): Simplify<Schema.TypeLiteral.Type<Fields, []>> {
238
- // const propsWithDefaults: any = _lazilyMergeDefaults(fields, { ...(props as any) });
239
- // return _getDisableValidationMakeOption(options)
240
- // ? propsWithDefaults
241
- // : ParseResult.validateSync(this)(propsWithDefaults);
242
- // }
243
-
244
- static instanceOf(value: unknown): boolean {
245
- return Schema.is(this)(value);
246
- }
247
- };
248
- };
@@ -1,21 +0,0 @@
1
- //
2
- // Copyright 2024 DXOS.org
3
- //
4
-
5
- import * as Schema from 'effect/Schema';
6
-
7
- import { EchoObject } from './entity';
8
-
9
- export const EXPANDO_TYPENAME = 'dxos.org/type/Expando';
10
-
11
- const ExpandoSchema = Schema.Struct({}, { key: Schema.String, value: Schema.Any }).pipe(
12
- EchoObject({ typename: EXPANDO_TYPENAME, version: '0.1.0' }),
13
- );
14
-
15
- /**
16
- * Expando object is an object with an arbitrary set of properties.
17
- */
18
- // TODO(dmaretskyi): Can we consider expando a top-type, i.e. have a ref to expando potentially be a valid ref to any object?
19
- export interface Expando extends Schema.Schema.Type<typeof ExpandoSchema> {}
20
-
21
- export const Expando: Schema.Schema<Expando> = ExpandoSchema;