@dxos/echo 0.8.3 → 0.8.4-main.1068cf700f

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 (486) hide show
  1. package/README.md +2 -3
  2. package/dist/lib/neutral/Annotation.mjs +35 -0
  3. package/dist/lib/neutral/Database.mjs +45 -0
  4. package/dist/lib/neutral/Entity.mjs +51 -0
  5. package/dist/lib/neutral/Entity.mjs.map +7 -0
  6. package/dist/lib/neutral/Err.mjs +12 -0
  7. package/dist/lib/neutral/Err.mjs.map +7 -0
  8. package/dist/lib/neutral/Filter.mjs +61 -0
  9. package/dist/lib/neutral/Filter.mjs.map +7 -0
  10. package/dist/lib/neutral/Format.mjs +66 -0
  11. package/dist/lib/neutral/Format.mjs.map +7 -0
  12. package/dist/lib/neutral/JsonSchema.mjs +19 -0
  13. package/dist/lib/neutral/JsonSchema.mjs.map +7 -0
  14. package/dist/lib/neutral/Key.mjs +12 -0
  15. package/dist/lib/neutral/Key.mjs.map +7 -0
  16. package/dist/lib/neutral/Obj.mjs +104 -0
  17. package/dist/lib/neutral/Obj.mjs.map +7 -0
  18. package/dist/lib/neutral/Order.mjs +12 -0
  19. package/dist/lib/neutral/Order.mjs.map +7 -0
  20. package/dist/lib/neutral/Query.mjs +26 -0
  21. package/dist/lib/neutral/Query.mjs.map +7 -0
  22. package/dist/lib/neutral/QueryResult.mjs +2 -0
  23. package/dist/lib/neutral/QueryResult.mjs.map +7 -0
  24. package/dist/lib/neutral/Ref.mjs +22 -0
  25. package/dist/lib/neutral/Ref.mjs.map +7 -0
  26. package/dist/lib/neutral/Relation.mjs +84 -0
  27. package/dist/lib/neutral/Relation.mjs.map +7 -0
  28. package/dist/lib/neutral/SchemaRegistry.mjs +2 -0
  29. package/dist/lib/neutral/SchemaRegistry.mjs.map +7 -0
  30. package/dist/lib/neutral/Tag.mjs +25 -0
  31. package/dist/lib/neutral/Tag.mjs.map +7 -0
  32. package/dist/lib/neutral/Type.mjs +47 -0
  33. package/dist/lib/neutral/Type.mjs.map +7 -0
  34. package/dist/lib/neutral/chunk-4L6DOFXP.mjs +7 -0
  35. package/dist/lib/neutral/chunk-4L6DOFXP.mjs.map +7 -0
  36. package/dist/lib/neutral/chunk-7WE7SBA2.mjs +402 -0
  37. package/dist/lib/neutral/chunk-7WE7SBA2.mjs.map +7 -0
  38. package/dist/lib/neutral/chunk-7YWDDFPH.mjs +251 -0
  39. package/dist/lib/neutral/chunk-7YWDDFPH.mjs.map +7 -0
  40. package/dist/lib/neutral/chunk-ANHVGJI4.mjs +21 -0
  41. package/dist/lib/neutral/chunk-ANHVGJI4.mjs.map +7 -0
  42. package/dist/lib/neutral/chunk-B4FLOYG7.mjs +130 -0
  43. package/dist/lib/neutral/chunk-B4FLOYG7.mjs.map +7 -0
  44. package/dist/lib/neutral/chunk-EXAYCLIM.mjs +56 -0
  45. package/dist/lib/neutral/chunk-EXAYCLIM.mjs.map +7 -0
  46. package/dist/lib/neutral/chunk-F6BTBXL7.mjs +171 -0
  47. package/dist/lib/neutral/chunk-F6BTBXL7.mjs.map +7 -0
  48. package/dist/lib/neutral/chunk-HQXQWXLH.mjs +269 -0
  49. package/dist/lib/neutral/chunk-HQXQWXLH.mjs.map +7 -0
  50. package/dist/lib/neutral/chunk-J5LGTIGS.mjs +10 -0
  51. package/dist/lib/neutral/chunk-J5LGTIGS.mjs.map +7 -0
  52. package/dist/lib/neutral/chunk-KB7RIVLK.mjs +67 -0
  53. package/dist/lib/neutral/chunk-KB7RIVLK.mjs.map +7 -0
  54. package/dist/lib/neutral/chunk-MXQJZCPY.mjs +51 -0
  55. package/dist/lib/neutral/chunk-MXQJZCPY.mjs.map +7 -0
  56. package/dist/lib/neutral/chunk-N2QNHMT5.mjs +73 -0
  57. package/dist/lib/neutral/chunk-N2QNHMT5.mjs.map +7 -0
  58. package/dist/lib/neutral/chunk-OMUPQMLR.mjs +7 -0
  59. package/dist/lib/neutral/chunk-OMUPQMLR.mjs.map +7 -0
  60. package/dist/lib/neutral/chunk-RCBBZLVM.mjs +142 -0
  61. package/dist/lib/neutral/chunk-RCBBZLVM.mjs.map +7 -0
  62. package/dist/lib/neutral/chunk-RIMHNJ3E.mjs +296 -0
  63. package/dist/lib/neutral/chunk-RIMHNJ3E.mjs.map +7 -0
  64. package/dist/lib/neutral/chunk-ROKO4RKJ.mjs +42 -0
  65. package/dist/lib/neutral/chunk-ROKO4RKJ.mjs.map +7 -0
  66. package/dist/lib/neutral/chunk-TMLVKIMX.mjs +40 -0
  67. package/dist/lib/neutral/chunk-TMLVKIMX.mjs.map +7 -0
  68. package/dist/lib/neutral/chunk-UMECVTXM.mjs +287 -0
  69. package/dist/lib/neutral/chunk-UMECVTXM.mjs.map +7 -0
  70. package/dist/lib/neutral/chunk-VJ2H5MOJ.mjs +3905 -0
  71. package/dist/lib/neutral/chunk-VJ2H5MOJ.mjs.map +7 -0
  72. package/dist/lib/neutral/chunk-VYEWMV5U.mjs +23 -0
  73. package/dist/lib/neutral/chunk-VYEWMV5U.mjs.map +7 -0
  74. package/dist/lib/neutral/chunk-X2MPMYYN.mjs +13 -0
  75. package/dist/lib/neutral/chunk-X2MPMYYN.mjs.map +7 -0
  76. package/dist/lib/neutral/chunk-XAJMXQ4H.mjs +43 -0
  77. package/dist/lib/neutral/chunk-XAJMXQ4H.mjs.map +7 -0
  78. package/dist/lib/neutral/chunk-YPIP3WGI.mjs +97 -0
  79. package/dist/lib/neutral/chunk-YPIP3WGI.mjs.map +7 -0
  80. package/dist/lib/neutral/index.mjs +84 -0
  81. package/dist/lib/neutral/index.mjs.map +7 -0
  82. package/dist/lib/neutral/internal/index.mjs +462 -0
  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 +366 -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/Database.d.ts +216 -0
  90. package/dist/types/src/Database.d.ts.map +1 -0
  91. package/dist/types/src/Entity.d.ts +142 -0
  92. package/dist/types/src/Entity.d.ts.map +1 -0
  93. package/dist/types/src/Entity.test.d.ts +2 -0
  94. package/dist/types/src/Entity.test.d.ts.map +1 -0
  95. package/dist/types/src/Err.d.ts +107 -0
  96. package/dist/types/src/Err.d.ts.map +1 -0
  97. package/dist/types/src/Filter.d.ts +120 -0
  98. package/dist/types/src/Filter.d.ts.map +1 -0
  99. package/dist/types/src/Format.d.ts +4 -0
  100. package/dist/types/src/Format.d.ts.map +1 -0
  101. package/dist/types/src/Hypergraph.d.ts +60 -0
  102. package/dist/types/src/Hypergraph.d.ts.map +1 -0
  103. package/dist/types/src/JsonSchema.d.ts +9 -0
  104. package/dist/types/src/JsonSchema.d.ts.map +1 -0
  105. package/dist/types/src/Key.d.ts +1 -0
  106. package/dist/types/src/Key.d.ts.map +1 -1
  107. package/dist/types/src/Obj.d.ts +424 -34
  108. package/dist/types/src/Obj.d.ts.map +1 -1
  109. package/dist/types/src/Obj.test.d.ts +2 -0
  110. package/dist/types/src/Obj.test.d.ts.map +1 -0
  111. package/dist/types/src/Order.d.ts +16 -0
  112. package/dist/types/src/Order.d.ts.map +1 -0
  113. package/dist/types/src/Query.d.ts +125 -0
  114. package/dist/types/src/Query.d.ts.map +1 -0
  115. package/dist/types/src/Query.test.d.ts +2 -0
  116. package/dist/types/src/Query.test.d.ts.map +1 -0
  117. package/dist/types/src/QueryResult.d.ts +80 -0
  118. package/dist/types/src/QueryResult.d.ts.map +1 -0
  119. package/dist/types/src/Ref.d.ts +13 -11
  120. package/dist/types/src/Ref.d.ts.map +1 -1
  121. package/dist/types/src/Relation.d.ts +243 -20
  122. package/dist/types/src/Relation.d.ts.map +1 -1
  123. package/dist/types/src/Relation.test.d.ts +2 -0
  124. package/dist/types/src/Relation.test.d.ts.map +1 -0
  125. package/dist/types/src/SchemaRegistry.d.ts +84 -0
  126. package/dist/types/src/SchemaRegistry.d.ts.map +1 -0
  127. package/dist/types/src/Tag.d.ts +17 -0
  128. package/dist/types/src/Tag.d.ts.map +1 -0
  129. package/dist/types/src/Type.d.ts +232 -79
  130. package/dist/types/src/Type.d.ts.map +1 -1
  131. package/dist/types/src/Type.test.d.ts +2 -0
  132. package/dist/types/src/Type.test.d.ts.map +1 -0
  133. package/dist/types/src/hierarchy.test.d.ts +2 -0
  134. package/dist/types/src/hierarchy.test.d.ts.map +1 -0
  135. package/dist/types/src/index.d.ts +15 -3
  136. package/dist/types/src/index.d.ts.map +1 -1
  137. package/dist/types/src/internal/annotations/annotations.d.ts +177 -0
  138. package/dist/types/src/internal/annotations/annotations.d.ts.map +1 -0
  139. package/dist/types/src/internal/annotations/annotations.test.d.ts +2 -0
  140. package/dist/types/src/internal/annotations/annotations.test.d.ts.map +1 -0
  141. package/dist/types/src/internal/annotations/index.d.ts +3 -0
  142. package/dist/types/src/internal/annotations/index.d.ts.map +1 -0
  143. package/dist/types/src/internal/annotations/util.d.ts +39 -0
  144. package/dist/types/src/internal/annotations/util.d.ts.map +1 -0
  145. package/dist/types/src/internal/api/annotations.d.ts +23 -0
  146. package/dist/types/src/internal/api/annotations.d.ts.map +1 -0
  147. package/dist/types/src/internal/api/entity.d.ts +13 -0
  148. package/dist/types/src/internal/api/entity.d.ts.map +1 -0
  149. package/dist/types/src/internal/api/index.d.ts +15 -0
  150. package/dist/types/src/internal/api/index.d.ts.map +1 -0
  151. package/dist/types/src/internal/api/meta.d.ts +42 -0
  152. package/dist/types/src/internal/api/meta.d.ts.map +1 -0
  153. package/dist/types/src/internal/api/sorting.d.ts +24 -0
  154. package/dist/types/src/internal/api/sorting.d.ts.map +1 -0
  155. package/dist/types/src/internal/api/version.d.ts +42 -0
  156. package/dist/types/src/internal/api/version.d.ts.map +1 -0
  157. package/dist/types/src/internal/entities/entity.d.ts +20 -0
  158. package/dist/types/src/internal/entities/entity.d.ts.map +1 -0
  159. package/dist/types/src/internal/entities/index.d.ts +6 -0
  160. package/dist/types/src/internal/entities/index.d.ts.map +1 -0
  161. package/dist/types/src/internal/entities/model.d.ts +79 -0
  162. package/dist/types/src/internal/entities/model.d.ts.map +1 -0
  163. package/dist/types/src/internal/entities/object.d.ts +18 -0
  164. package/dist/types/src/internal/entities/object.d.ts.map +1 -0
  165. package/dist/types/src/internal/entities/relation.d.ts +62 -0
  166. package/dist/types/src/internal/entities/relation.d.ts.map +1 -0
  167. package/dist/types/src/internal/entities/util.d.ts +2 -0
  168. package/dist/types/src/internal/entities/util.d.ts.map +1 -0
  169. package/dist/types/src/internal/formats/date.d.ts +63 -0
  170. package/dist/types/src/internal/formats/date.d.ts.map +1 -0
  171. package/dist/types/src/internal/formats/date.test.d.ts +2 -0
  172. package/dist/types/src/internal/formats/date.test.d.ts.map +1 -0
  173. package/dist/types/src/internal/formats/format.d.ts +32 -0
  174. package/dist/types/src/internal/formats/format.d.ts.map +1 -0
  175. package/dist/types/src/internal/formats/format.test.d.ts +2 -0
  176. package/dist/types/src/internal/formats/format.test.d.ts.map +1 -0
  177. package/dist/types/src/internal/formats/index.d.ts +8 -0
  178. package/dist/types/src/internal/formats/index.d.ts.map +1 -0
  179. package/dist/types/src/internal/formats/number.d.ts +31 -0
  180. package/dist/types/src/internal/formats/number.d.ts.map +1 -0
  181. package/dist/types/src/internal/formats/object.d.ts +35 -0
  182. package/dist/types/src/internal/formats/object.d.ts.map +1 -0
  183. package/dist/types/src/internal/formats/select.d.ts +13 -0
  184. package/dist/types/src/internal/formats/select.d.ts.map +1 -0
  185. package/dist/types/src/internal/formats/string.d.ts +42 -0
  186. package/dist/types/src/internal/formats/string.d.ts.map +1 -0
  187. package/dist/types/src/internal/formats/types.d.ts +72 -0
  188. package/dist/types/src/internal/formats/types.d.ts.map +1 -0
  189. package/dist/types/src/internal/index.d.ts +12 -0
  190. package/dist/types/src/internal/index.d.ts.map +1 -0
  191. package/dist/types/src/internal/json-schema/annotations.d.ts +19 -0
  192. package/dist/types/src/internal/json-schema/annotations.d.ts.map +1 -0
  193. package/dist/types/src/internal/json-schema/effect-schema.test.d.ts +2 -0
  194. package/dist/types/src/internal/json-schema/effect-schema.test.d.ts.map +1 -0
  195. package/dist/types/src/internal/json-schema/index.d.ts +5 -0
  196. package/dist/types/src/internal/json-schema/index.d.ts.map +1 -0
  197. package/dist/types/src/internal/json-schema/json-schema-normalize.d.ts +7 -0
  198. package/dist/types/src/internal/json-schema/json-schema-normalize.d.ts.map +1 -0
  199. package/dist/types/src/internal/json-schema/json-schema-type.d.ts +351 -0
  200. package/dist/types/src/internal/json-schema/json-schema-type.d.ts.map +1 -0
  201. package/dist/types/src/internal/json-schema/json-schema.d.ts +30 -0
  202. package/dist/types/src/internal/json-schema/json-schema.d.ts.map +1 -0
  203. package/dist/types/src/internal/json-schema/json-schema.test.d.ts +2 -0
  204. package/dist/types/src/internal/json-schema/json-schema.test.d.ts.map +1 -0
  205. package/dist/types/src/internal/object/clone.d.ts +8 -0
  206. package/dist/types/src/internal/object/clone.d.ts.map +1 -0
  207. package/dist/types/src/internal/object/common.d.ts +18 -0
  208. package/dist/types/src/internal/object/common.d.ts.map +1 -0
  209. package/dist/types/src/internal/object/create-object.d.ts +39 -0
  210. package/dist/types/src/internal/object/create-object.d.ts.map +1 -0
  211. package/dist/types/src/internal/object/create-object.test.d.ts +2 -0
  212. package/dist/types/src/internal/object/create-object.test.d.ts.map +1 -0
  213. package/dist/types/src/internal/object/deleted.d.ts +6 -0
  214. package/dist/types/src/internal/object/deleted.d.ts.map +1 -0
  215. package/dist/types/src/internal/object/ids.d.ts +6 -0
  216. package/dist/types/src/internal/object/ids.d.ts.map +1 -0
  217. package/dist/types/src/internal/object/index.d.ts +11 -0
  218. package/dist/types/src/internal/object/index.d.ts.map +1 -0
  219. package/dist/types/src/internal/object/inspect.d.ts +2 -0
  220. package/dist/types/src/internal/object/inspect.d.ts.map +1 -0
  221. package/dist/types/src/internal/object/json-serializer.d.ts +37 -0
  222. package/dist/types/src/internal/object/json-serializer.d.ts.map +1 -0
  223. package/dist/types/src/internal/object/json-serializer.test.d.ts +2 -0
  224. package/dist/types/src/internal/object/json-serializer.test.d.ts.map +1 -0
  225. package/dist/types/src/internal/object/schema-validator.d.ts +2 -0
  226. package/dist/types/src/internal/object/schema-validator.d.ts.map +1 -0
  227. package/dist/types/src/internal/object/schema-validator.test.d.ts +2 -0
  228. package/dist/types/src/internal/object/schema-validator.test.d.ts.map +1 -0
  229. package/dist/types/src/internal/object/set-value.d.ts +7 -0
  230. package/dist/types/src/internal/object/set-value.d.ts.map +1 -0
  231. package/dist/types/src/internal/object/set-value.test.d.ts +2 -0
  232. package/dist/types/src/internal/object/set-value.test.d.ts.map +1 -0
  233. package/dist/types/src/internal/object/snapshot.d.ts +6 -0
  234. package/dist/types/src/internal/object/snapshot.d.ts.map +1 -0
  235. package/dist/types/src/internal/object/typed-object.d.ts +25 -0
  236. package/dist/types/src/internal/object/typed-object.d.ts.map +1 -0
  237. package/dist/types/src/internal/object/typed-object.test.d.ts +2 -0
  238. package/dist/types/src/internal/object/typed-object.test.d.ts.map +1 -0
  239. package/dist/types/src/internal/proxy/change-context.d.ts +55 -0
  240. package/dist/types/src/internal/proxy/change-context.d.ts.map +1 -0
  241. package/dist/types/src/internal/proxy/change.test.d.ts +2 -0
  242. package/dist/types/src/internal/proxy/change.test.d.ts.map +1 -0
  243. package/dist/types/src/internal/proxy/define-hidden-property.d.ts +5 -0
  244. package/dist/types/src/internal/proxy/define-hidden-property.d.ts.map +1 -0
  245. package/dist/types/src/internal/proxy/errors.d.ts +19 -0
  246. package/dist/types/src/internal/proxy/errors.d.ts.map +1 -0
  247. package/dist/types/src/internal/proxy/event-batch.d.ts +10 -0
  248. package/dist/types/src/internal/proxy/event-batch.d.ts.map +1 -0
  249. package/dist/types/src/internal/proxy/handler.test.d.ts +2 -0
  250. package/dist/types/src/internal/proxy/handler.test.d.ts.map +1 -0
  251. package/dist/types/src/internal/proxy/index.d.ts +14 -0
  252. package/dist/types/src/internal/proxy/index.d.ts.map +1 -0
  253. package/dist/types/src/internal/proxy/json-serializer.d.ts +6 -0
  254. package/dist/types/src/internal/proxy/json-serializer.d.ts.map +1 -0
  255. package/dist/types/src/internal/proxy/make-object.d.ts +14 -0
  256. package/dist/types/src/internal/proxy/make-object.d.ts.map +1 -0
  257. package/dist/types/src/internal/proxy/ownership.d.ts +57 -0
  258. package/dist/types/src/internal/proxy/ownership.d.ts.map +1 -0
  259. package/dist/types/src/internal/proxy/proxy-types.d.ts +18 -0
  260. package/dist/types/src/internal/proxy/proxy-types.d.ts.map +1 -0
  261. package/dist/types/src/internal/proxy/proxy-utils.d.ts +47 -0
  262. package/dist/types/src/internal/proxy/proxy-utils.d.ts.map +1 -0
  263. package/dist/types/src/internal/proxy/reactive-array.d.ts +8 -0
  264. package/dist/types/src/internal/proxy/reactive-array.d.ts.map +1 -0
  265. package/dist/types/src/internal/proxy/reactive.d.ts +39 -0
  266. package/dist/types/src/internal/proxy/reactive.d.ts.map +1 -0
  267. package/dist/types/src/internal/proxy/schema-validator.d.ts +15 -0
  268. package/dist/types/src/internal/proxy/schema-validator.d.ts.map +1 -0
  269. package/dist/types/src/internal/proxy/schema.test.d.ts +2 -0
  270. package/dist/types/src/internal/proxy/schema.test.d.ts.map +1 -0
  271. package/dist/types/src/internal/proxy/symbols.d.ts +3 -0
  272. package/dist/types/src/internal/proxy/symbols.d.ts.map +1 -0
  273. package/dist/types/src/internal/proxy/typed-handler.d.ts +48 -0
  274. package/dist/types/src/internal/proxy/typed-handler.d.ts.map +1 -0
  275. package/dist/types/src/internal/proxy/typed-handler.test.d.ts +2 -0
  276. package/dist/types/src/internal/proxy/typed-handler.test.d.ts.map +1 -0
  277. package/dist/types/src/internal/proxy/typed-object.test.d.ts +2 -0
  278. package/dist/types/src/internal/proxy/typed-object.test.d.ts.map +1 -0
  279. package/dist/types/src/internal/ref/index.d.ts +3 -0
  280. package/dist/types/src/internal/ref/index.d.ts.map +1 -0
  281. package/dist/types/src/internal/ref/ref-array.d.ts +21 -0
  282. package/dist/types/src/internal/ref/ref-array.d.ts.map +1 -0
  283. package/dist/types/src/internal/ref/ref.d.ts +231 -0
  284. package/dist/types/src/internal/ref/ref.d.ts.map +1 -0
  285. package/dist/types/src/internal/ref/ref.test.d.ts +2 -0
  286. package/dist/types/src/internal/ref/ref.test.d.ts.map +1 -0
  287. package/dist/types/src/internal/schema/compose.d.ts +7 -0
  288. package/dist/types/src/internal/schema/compose.d.ts.map +1 -0
  289. package/dist/types/src/internal/schema/compose.test.d.ts +2 -0
  290. package/dist/types/src/internal/schema/compose.test.d.ts.map +1 -0
  291. package/dist/types/src/internal/schema/echo-schema.d.ts +181 -0
  292. package/dist/types/src/internal/schema/echo-schema.d.ts.map +1 -0
  293. package/dist/types/src/internal/schema/index.d.ts +4 -0
  294. package/dist/types/src/internal/schema/index.d.ts.map +1 -0
  295. package/dist/types/src/internal/schema/manipulation.d.ts +10 -0
  296. package/dist/types/src/internal/schema/manipulation.d.ts.map +1 -0
  297. package/dist/types/src/internal/schema/persistent-schema.d.ts +20 -0
  298. package/dist/types/src/internal/schema/persistent-schema.d.ts.map +1 -0
  299. package/dist/types/src/internal/types/base.d.ts +26 -0
  300. package/dist/types/src/internal/types/base.d.ts.map +1 -0
  301. package/dist/types/src/internal/types/entity.d.ts +37 -0
  302. package/dist/types/src/internal/types/entity.d.ts.map +1 -0
  303. package/dist/types/src/internal/types/index.d.ts +6 -0
  304. package/dist/types/src/internal/types/index.d.ts.map +1 -0
  305. package/dist/types/src/internal/types/meta.d.ts +32 -0
  306. package/dist/types/src/internal/types/meta.d.ts.map +1 -0
  307. package/dist/types/src/internal/types/typename.d.ts +21 -0
  308. package/dist/types/src/internal/types/typename.d.ts.map +1 -0
  309. package/dist/types/src/internal/types/version.d.ts +15 -0
  310. package/dist/types/src/internal/types/version.d.ts.map +1 -0
  311. package/dist/types/src/{test → testing}/api.test.d.ts.map +1 -1
  312. package/dist/types/src/testing/index.d.ts +3 -1
  313. package/dist/types/src/testing/index.d.ts.map +1 -1
  314. package/dist/types/src/testing/test-data.d.ts +18 -0
  315. package/dist/types/src/testing/test-data.d.ts.map +1 -0
  316. package/dist/types/src/testing/test-schema.d.ts +303 -0
  317. package/dist/types/src/testing/test-schema.d.ts.map +1 -0
  318. package/dist/types/src/testing/util.d.ts +21 -0
  319. package/dist/types/src/testing/util.d.ts.map +1 -0
  320. package/dist/types/tsconfig.tsbuildinfo +1 -1
  321. package/package.json +107 -53
  322. package/src/Annotation.ts +45 -0
  323. package/src/Database.ts +353 -0
  324. package/src/Entity.test.ts +22 -0
  325. package/src/Entity.ts +217 -0
  326. package/src/Err.ts +38 -0
  327. package/src/Filter.ts +376 -0
  328. package/src/Format.ts +9 -0
  329. package/src/Hypergraph.ts +74 -0
  330. package/src/JsonSchema.ts +16 -0
  331. package/src/Key.ts +3 -0
  332. package/src/Obj.test.ts +442 -0
  333. package/src/Obj.ts +634 -80
  334. package/src/Order.ts +44 -0
  335. package/src/Query.test.ts +465 -0
  336. package/src/Query.ts +324 -0
  337. package/src/QueryResult.ts +106 -0
  338. package/src/Ref.ts +25 -9
  339. package/src/Relation.test.ts +82 -0
  340. package/src/Relation.ts +417 -52
  341. package/src/SchemaRegistry.ts +105 -0
  342. package/src/Tag.ts +40 -0
  343. package/src/Type.test.ts +52 -0
  344. package/src/Type.ts +383 -122
  345. package/src/hierarchy.test.ts +33 -0
  346. package/src/index.ts +17 -4
  347. package/src/internal/README.md +102 -0
  348. package/src/internal/annotations/annotations.test.ts +96 -0
  349. package/src/internal/annotations/annotations.ts +487 -0
  350. package/src/internal/annotations/index.ts +6 -0
  351. package/src/internal/annotations/util.ts +85 -0
  352. package/src/internal/api/annotations.ts +60 -0
  353. package/src/internal/api/entity.ts +29 -0
  354. package/src/internal/api/index.ts +19 -0
  355. package/src/internal/api/meta.ts +88 -0
  356. package/src/internal/api/sorting.ts +53 -0
  357. package/src/internal/api/version.ts +96 -0
  358. package/src/internal/entities/entity.ts +126 -0
  359. package/src/internal/entities/index.ts +9 -0
  360. package/src/internal/entities/model.ts +138 -0
  361. package/src/internal/entities/object.ts +58 -0
  362. package/src/internal/entities/relation.ts +171 -0
  363. package/src/internal/entities/util.ts +33 -0
  364. package/src/internal/formats/date.test.ts +56 -0
  365. package/src/internal/formats/date.ts +217 -0
  366. package/src/internal/formats/format.test.ts +77 -0
  367. package/src/internal/formats/format.ts +54 -0
  368. package/src/internal/formats/index.ts +12 -0
  369. package/src/internal/formats/number.ts +89 -0
  370. package/src/internal/formats/object.ts +80 -0
  371. package/src/internal/formats/select.ts +18 -0
  372. package/src/internal/formats/string.ts +81 -0
  373. package/src/internal/formats/types.ts +186 -0
  374. package/src/internal/index.ts +39 -0
  375. package/src/internal/json-schema/annotations.ts +50 -0
  376. package/src/internal/json-schema/effect-schema.test.ts +143 -0
  377. package/src/internal/json-schema/index.ts +8 -0
  378. package/src/internal/json-schema/json-schema-normalize.ts +111 -0
  379. package/src/internal/json-schema/json-schema-type.ts +403 -0
  380. package/src/internal/json-schema/json-schema.test.ts +861 -0
  381. package/src/internal/json-schema/json-schema.ts +532 -0
  382. package/src/internal/object/clone.ts +48 -0
  383. package/src/internal/object/common.ts +75 -0
  384. package/src/internal/object/create-object.test.ts +116 -0
  385. package/src/internal/object/create-object.ts +95 -0
  386. package/src/internal/object/deleted.ts +19 -0
  387. package/src/internal/object/ids.ts +12 -0
  388. package/src/internal/object/index.ts +14 -0
  389. package/src/internal/object/inspect.ts +46 -0
  390. package/src/internal/object/json-serializer.test.ts +98 -0
  391. package/src/internal/object/json-serializer.ts +197 -0
  392. package/src/internal/object/schema-validator.test.ts +182 -0
  393. package/src/internal/object/schema-validator.ts +6 -0
  394. package/src/internal/object/set-value.test.ts +281 -0
  395. package/src/internal/object/set-value.ts +165 -0
  396. package/src/internal/object/snapshot.ts +93 -0
  397. package/src/internal/object/typed-object.test.ts +34 -0
  398. package/src/internal/object/typed-object.ts +30 -0
  399. package/src/internal/proxy/change-context.ts +138 -0
  400. package/src/internal/proxy/change.test.ts +519 -0
  401. package/src/internal/proxy/define-hidden-property.ts +14 -0
  402. package/src/internal/proxy/errors.ts +42 -0
  403. package/src/internal/proxy/event-batch.ts +44 -0
  404. package/src/internal/proxy/handler.test.ts +123 -0
  405. package/src/internal/proxy/index.ts +17 -0
  406. package/src/internal/proxy/json-serializer.ts +87 -0
  407. package/src/internal/proxy/make-object.ts +106 -0
  408. package/src/internal/proxy/ownership.ts +253 -0
  409. package/src/internal/proxy/proxy-types.ts +23 -0
  410. package/src/internal/proxy/proxy-utils.ts +150 -0
  411. package/src/internal/proxy/reactive-array.ts +71 -0
  412. package/src/internal/proxy/reactive.ts +69 -0
  413. package/src/internal/proxy/schema-validator.ts +244 -0
  414. package/src/internal/proxy/schema.test.ts +145 -0
  415. package/src/internal/proxy/symbols.ts +7 -0
  416. package/src/internal/proxy/typed-handler.test.ts +314 -0
  417. package/src/internal/proxy/typed-handler.ts +450 -0
  418. package/src/internal/proxy/typed-object.test.ts +116 -0
  419. package/src/internal/ref/index.ts +6 -0
  420. package/src/internal/ref/ref-array.ts +39 -0
  421. package/src/internal/ref/ref.test.ts +101 -0
  422. package/src/internal/ref/ref.ts +572 -0
  423. package/src/internal/schema/compose.test.ts +42 -0
  424. package/src/internal/schema/compose.ts +41 -0
  425. package/src/internal/schema/echo-schema.ts +424 -0
  426. package/src/internal/schema/index.ts +7 -0
  427. package/src/internal/schema/manipulation.ts +92 -0
  428. package/src/internal/schema/persistent-schema.ts +28 -0
  429. package/src/internal/types/base.ts +43 -0
  430. package/src/internal/types/entity.ts +54 -0
  431. package/src/internal/types/index.ts +9 -0
  432. package/src/internal/types/meta.ts +65 -0
  433. package/src/internal/types/typename.ts +55 -0
  434. package/src/internal/types/version.ts +20 -0
  435. package/src/testing/api.test.ts +126 -0
  436. package/src/testing/index.ts +3 -1
  437. package/src/testing/test-data.ts +130 -0
  438. package/src/testing/test-schema.ts +238 -0
  439. package/src/testing/util.ts +85 -0
  440. package/dist/lib/browser/chunk-UYPR62ZB.mjs +0 -624
  441. package/dist/lib/browser/chunk-UYPR62ZB.mjs.map +0 -7
  442. package/dist/lib/browser/index.mjs +0 -22
  443. package/dist/lib/browser/meta.json +0 -1
  444. package/dist/lib/browser/testing/index.mjs +0 -70
  445. package/dist/lib/browser/testing/index.mjs.map +0 -7
  446. package/dist/lib/node/chunk-4HQE2F3L.cjs +0 -644
  447. package/dist/lib/node/chunk-4HQE2F3L.cjs.map +0 -7
  448. package/dist/lib/node/index.cjs +0 -43
  449. package/dist/lib/node/index.cjs.map +0 -7
  450. package/dist/lib/node/meta.json +0 -1
  451. package/dist/lib/node/testing/index.cjs +0 -89
  452. package/dist/lib/node/testing/index.cjs.map +0 -7
  453. package/dist/lib/node-esm/chunk-BYBICDIO.mjs +0 -624
  454. package/dist/lib/node-esm/chunk-BYBICDIO.mjs.map +0 -7
  455. package/dist/lib/node-esm/index.mjs +0 -22
  456. package/dist/lib/node-esm/meta.json +0 -1
  457. package/dist/lib/node-esm/testing/index.mjs +0 -70
  458. package/dist/lib/node-esm/testing/index.mjs.map +0 -7
  459. package/dist/types/src/experimental/database.d.ts +0 -8
  460. package/dist/types/src/experimental/database.d.ts.map +0 -1
  461. package/dist/types/src/experimental/index.d.ts +0 -1
  462. package/dist/types/src/experimental/index.d.ts.map +0 -1
  463. package/dist/types/src/experimental/queue.d.ts +0 -8
  464. package/dist/types/src/experimental/queue.d.ts.map +0 -1
  465. package/dist/types/src/experimental/space.d.ts +0 -8
  466. package/dist/types/src/experimental/space.d.ts.map +0 -1
  467. package/dist/types/src/query/dsl.d.ts +0 -218
  468. package/dist/types/src/query/dsl.d.ts.map +0 -1
  469. package/dist/types/src/query/dsl.test.d.ts +0 -2
  470. package/dist/types/src/query/dsl.test.d.ts.map +0 -1
  471. package/dist/types/src/query/index.d.ts +0 -2
  472. package/dist/types/src/query/index.d.ts.map +0 -1
  473. package/dist/types/src/testing/types.d.ts +0 -113
  474. package/dist/types/src/testing/types.d.ts.map +0 -1
  475. package/src/experimental/database.ts +0 -11
  476. package/src/experimental/index.ts +0 -7
  477. package/src/experimental/queue.ts +0 -11
  478. package/src/experimental/space.ts +0 -11
  479. package/src/query/dsl.test.ts +0 -323
  480. package/src/query/dsl.ts +0 -646
  481. package/src/query/index.ts +0 -5
  482. package/src/test/api.test.ts +0 -173
  483. package/src/testing/types.ts +0 -91
  484. /package/dist/lib/{browser/index.mjs.map → neutral/Annotation.mjs.map} +0 -0
  485. /package/dist/lib/{node-esm/index.mjs.map → neutral/Database.mjs.map} +0 -0
  486. /package/dist/types/src/{test → testing}/api.test.d.ts +0 -0
@@ -0,0 +1,52 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+ import { describe, test } from 'vitest';
7
+
8
+ import * as Obj from './Obj';
9
+ import * as Relation from './Relation';
10
+ import { TestSchema } from './testing';
11
+ import * as Type from './Type';
12
+
13
+ describe('Type', () => {
14
+ describe('Type.Obj', () => {
15
+ test('has SchemaKindId for schema type checking', ({ expect }) => {
16
+ // Type.isObjectSchema uses SchemaKindId to check if a schema is an object schema.
17
+ expect(Type.isObjectSchema(Type.Obj)).toBe(true);
18
+ expect(Type.isObjectSchema(TestSchema.Person)).toBe(true);
19
+ expect(Type.isObjectSchema(Type.Relation)).toBe(false);
20
+ });
21
+
22
+ test('Schema.is validates structural compatibility only', ({ expect }) => {
23
+ // Schema.is does structural validation (has id field).
24
+ // It accepts both ECHO objects and plain objects with compatible structure.
25
+ expect(Schema.is(Type.Obj)({ id: 'plain-object' })).toBe(true);
26
+ const obj = Obj.make(TestSchema.Person, { name: 'Test' });
27
+ expect(Schema.is(Type.Obj)(obj)).toBe(true);
28
+ });
29
+ });
30
+
31
+ describe('Type.Relation', () => {
32
+ test('has SchemaKindId for schema type checking', ({ expect }) => {
33
+ // Type.isRelationSchema uses SchemaKindId to check if a schema is a relation schema.
34
+ expect(Type.isRelationSchema(Type.Relation)).toBe(true);
35
+ expect(Type.isRelationSchema(TestSchema.HasManager)).toBe(true);
36
+ expect(Type.isRelationSchema(Type.Obj)).toBe(false);
37
+ });
38
+
39
+ test('Schema.is validates structural compatibility only', ({ expect }) => {
40
+ // Schema.is does structural validation (has id field).
41
+ // It accepts both ECHO relations and plain objects with compatible structure.
42
+ expect(Schema.is(Type.Relation)({ id: 'plain-object' })).toBe(true);
43
+ const obj1 = Obj.make(TestSchema.Person, { name: 'Alice' });
44
+ const obj2 = Obj.make(TestSchema.Person, { name: 'Bob' });
45
+ const rel = Relation.make(TestSchema.HasManager, {
46
+ [Relation.Source]: obj1,
47
+ [Relation.Target]: obj2,
48
+ });
49
+ expect(Schema.is(Type.Relation)(rel)).toBe(true);
50
+ });
51
+ });
52
+ });
package/src/Type.ts CHANGED
@@ -2,183 +2,464 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { type Schema } from 'effect';
6
- import type { Simplify } from 'effect/Schema';
5
+ import * as Schema from 'effect/Schema';
7
6
 
8
- import type { EncodedReference } from '@dxos/echo-protocol';
9
- import * as EchoSchema from '@dxos/echo-schema';
10
- import type { ToMutable } from '@dxos/echo-schema';
7
+ import { type EncodedReference } from '@dxos/echo-protocol';
11
8
  import { invariant } from '@dxos/invariant';
12
- import type * as Keys from '@dxos/keys';
9
+ import { type DXN, type ObjectId } from '@dxos/keys';
10
+ import { type ToMutable } from '@dxos/util';
11
+
12
+ import type * as Entity$ from './Entity';
13
+ import {
14
+ ANY_OBJECT_TYPENAME,
15
+ ANY_OBJECT_VERSION,
16
+ type ATTR_RELATION_SOURCE,
17
+ type ATTR_RELATION_TARGET,
18
+ type AnyEntity,
19
+ type AnyProperties,
20
+ EchoObjectSchema,
21
+ EchoRelationSchema,
22
+ type EchoRelationSchemaOptions,
23
+ EchoSchema,
24
+ EntityKind,
25
+ PersistentSchema,
26
+ Ref as Ref$,
27
+ type RefFn,
28
+ type RefSchema,
29
+ SchemaKindId,
30
+ type TypeAnnotation,
31
+ type TypeMeta,
32
+ getSchemaDXN,
33
+ getSchemaTypename,
34
+ getSchemaVersion,
35
+ getTypeAnnotation,
36
+ isMutable as isMutable$,
37
+ toEffectSchema,
38
+ toJsonSchema,
39
+ } from './internal';
40
+ import type * as Relation$ from './Relation';
13
41
 
14
- import type * as RelationModule from './Relation';
42
+ // TODO(burdon): Remove toEffectSchema, toJsonSchema (moved to JsonSchema export).
43
+ export { toEffectSchema, toJsonSchema };
15
44
 
16
- export const KindId: unique symbol = EchoSchema.EntityKindId as any;
17
- export type KindId = typeof KindId;
45
+ /**
46
+ * Returns all properties of an object or relation except for the id and kind.
47
+ */
48
+ export type Properties<T = any> = Omit<T, 'id' | Entity$.KindId | Relation$.Source | Relation$.Target>;
18
49
 
19
- export { EntityKind as Kind } from '@dxos/echo-schema';
50
+ //
51
+ // Internal types (not exported)
52
+ //
20
53
 
21
54
  /**
22
- * Assigns a kind to an Object or Relation instance.
55
+ * Type that marks a schema as an ECHO schema.
56
+ * The value indicates the entity kind (Object or Relation).
23
57
  */
24
- // NOTE: Needed to make `isRelation` and `isObject` checks work.
25
- export interface OfKind<Kind extends EchoSchema.EntityKind> {
26
- readonly id: Keys.ObjectId;
27
- readonly [KindId]: Kind;
28
- }
58
+ type EchoSchemaKind<K extends EntityKind = EntityKind> = {
59
+ readonly [SchemaKindId]: K;
60
+ };
29
61
 
62
+ /**
63
+ * JSON-encoded properties for objects.
64
+ */
30
65
  interface ObjJsonProps {
31
66
  id: string;
32
67
  }
33
68
 
69
+ /**
70
+ * JSON-encoded properties for relations.
71
+ */
34
72
  interface RelationJsonProps {
35
73
  id: string;
36
- [EchoSchema.ATTR_RELATION_SOURCE]: string;
37
- [EchoSchema.ATTR_RELATION_TARGET]: string;
74
+ [ATTR_RELATION_SOURCE]: string;
75
+ [ATTR_RELATION_TARGET]: string;
38
76
  }
39
77
 
40
- /**
41
- * Returns all properties of an object or relation except for the id and kind.
42
- */
43
- export type Properties<T> = Omit<T, 'id' | KindId | RelationModule.Source | RelationModule.Target>;
78
+ //
79
+ // Obj - Runtime schema for any ECHO object
80
+ //
44
81
 
45
- /**
46
- * Base ECHO schema type.
47
- */
48
- export type Schema = EchoSchema.EchoSchema;
82
+ // Internal type for the Obj schema constant.
83
+ // NOTE: The `any` in the type intersection is intentional - it makes this type bidirectionally
84
+ // assignable with specific object types (e.g., Type.Obj can be assigned to/from Meeting.Meeting).
85
+ // This is needed because operation schemas erase type information.
86
+ // TODO(wittjosiah): Consider alternatives to the `any` intersection hack:
87
+ // - Generic operation schemas that preserve input type in output
88
+ // - Branded types that specific schemas also carry
89
+ // - Accept the limitation and require explicit type narrowing at call sites
90
+ type ObjSchemaType = Schema.Schema<
91
+ any & AnyEntity & Entity$.OfKind<typeof Entity$.Kind.Object> & AnyProperties,
92
+ { id: string } & AnyProperties
93
+ > &
94
+ EchoSchemaKind<EntityKind.Object> &
95
+ TypeMeta;
96
+
97
+ // Internal schema definition.
98
+ // NOTE: The EchoObjectSchema annotation is required for Type.Ref(Type.Obj) to work.
99
+ // The typename/version only satisfy ECHO schema machinery for reference targets.
100
+ const ObjSchema = Schema.Struct({
101
+ id: Schema.String,
102
+ }).pipe(
103
+ Schema.extend(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
104
+ EchoObjectSchema({ typename: ANY_OBJECT_TYPENAME, version: ANY_OBJECT_VERSION }),
105
+ );
49
106
 
50
107
  /**
51
- * Return type of the `Obj` schema constructor.
108
+ * Runtime Effect schema for any ECHO object.
109
+ * Use for validation, parsing, or as a reference target for collections.
52
110
  *
53
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
54
- * See Effect's note on interface types.
111
+ * NOTE: `Schema.is(Type.Obj)` does STRUCTURAL validation only (checks for `id` field).
112
+ * Use `Obj.isObject()` for proper ECHO instance type guards that check the KindId brand.
113
+ *
114
+ * @example
115
+ * ```ts
116
+ * // Structural type guard (accepts any object with id field)
117
+ * if (Schema.is(Type.Obj)(unknownValue)) { ... }
118
+ *
119
+ * // ECHO instance type guard (checks KindId brand)
120
+ * if (Obj.isObject(unknownValue)) { ... }
121
+ *
122
+ * // Reference to any object type
123
+ * const Collection = Schema.Struct({
124
+ * objects: Schema.Array(Type.Ref(Type.Obj)),
125
+ * }).pipe(Type.object({ typename: 'Collection', version: '0.1.0' }));
126
+ * ```
55
127
  */
56
- export interface obj<Self extends Schema.Schema.Any>
57
- extends Schema.AnnotableClass<
58
- obj<Self>,
59
- OfKind<EchoSchema.EntityKind.Object> & ToMutable<Schema.Schema.Type<Self>>,
60
- Simplify<ObjJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>,
61
- Schema.Schema.Context<Self>
62
- >,
63
- EchoSchema.TypeMeta {}
128
+ // TODO(wittjosiah): Investigate if Schema.filter can validate KindId on ECHO instances.
129
+ // Effect Schema normalizes proxy objects to plain objects before calling filter predicates.
130
+ // Possible approaches: custom Schema.declare, AST manipulation, or upstream contribution.
131
+ export const Obj: ObjSchemaType = Object.assign(ObjSchema, {
132
+ [SchemaKindId]: (ObjSchema as any)[SchemaKindId],
133
+ }) as unknown as ObjSchemaType;
64
134
 
65
135
  /**
66
- * Object schema.
136
+ * TypeScript type for an ECHO object schema.
137
+ * `T` is the instance type produced by the schema.
138
+ * `Fields` is the optional struct fields type for introspection.
139
+ *
140
+ * @example
141
+ * ```ts
142
+ * const PersonSchema: Type.Obj<Person> = Schema.Struct({
143
+ * name: Schema.String,
144
+ * }).pipe(Type.object({ typename: 'Person', version: '0.1.0' }));
145
+ *
146
+ * // Access fields for introspection:
147
+ * Object.keys(PersonSchema.fields); // ['name']
148
+ * ```
67
149
  */
68
- export const Obj: {
69
- (opts: EchoSchema.TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => obj<Self>;
70
- } = EchoSchema.EchoObject as any;
150
+ export interface Obj<T = any, Fields extends Schema.Struct.Fields = Schema.Struct.Fields>
151
+ extends TypeMeta,
152
+ EchoSchemaKind<EntityKind.Object>,
153
+ Schema.AnnotableClass<
154
+ Obj<T, Fields>,
155
+ Entity$.OfKind<typeof Entity$.Kind.Object> & T,
156
+ Schema.Simplify<ObjJsonProps & ToMutable<T>>,
157
+ never
158
+ > {
159
+ /**
160
+ * The fields defined in the original struct schema.
161
+ * Allows accessing field definitions for introspection.
162
+ */
163
+ readonly fields: Fields;
164
+ }
71
165
 
72
166
  /**
73
- * Object schema type definitions.
167
+ * Structural base type for any ECHO object schema.
168
+ * Accepts both static schemas (created with Type.object()) and EchoSchema.
169
+ * NOTE: Does not include the brand symbol to avoid TS4053 declaration portability issues.
170
+ * Use Type.isObjectSchema() for runtime type guards.
74
171
  */
172
+ type ObjectSchemaBase = Schema.Schema.AnyNoContext & {
173
+ readonly typename: string;
174
+ readonly version: string;
175
+ };
176
+
75
177
  export namespace Obj {
76
178
  /**
77
- * Type that represents an arbitrary schema type of an object.
78
- * NOTE: This is not an instance type.
179
+ * Type that represents any ECHO object schema.
180
+ * Accepts both static schemas (Type.object()) and mutable schemas (EchoSchema).
79
181
  */
80
- // TODO(dmaretskyi): If schema was covariant, we could specify props in here, like `id: ObjectId`.
81
- export type Any = Schema.Schema.AnyNoContext;
182
+ export type Any = ObjectSchemaBase;
82
183
  }
83
184
 
84
185
  /**
85
- * Return type of the `Relation` schema constructor.
186
+ * Factory function to create an ECHO object schema.
187
+ * Adds object metadata annotations to an Effect schema.
86
188
  *
87
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
88
- * See Effect's note on interface types.
189
+ * @example
190
+ * ```ts
191
+ * const Person = Schema.Struct({
192
+ * name: Schema.String,
193
+ * }).pipe(Type.object({ typename: 'example.com/type/Person', version: '0.1.0' }));
194
+ * ```
89
195
  */
90
- export interface relation<
91
- Self extends Schema.Schema.Any,
92
- SourceSchema extends Schema.Schema.Any,
93
- TargetSchema extends Schema.Schema.Any,
94
- > extends Schema.AnnotableClass<
95
- relation<Self, SourceSchema, TargetSchema>,
96
- OfKind<EchoSchema.EntityKind.Relation> &
97
- Relation.Endpoints<Schema.Schema.Type<SourceSchema>, Schema.Schema.Type<TargetSchema>> &
98
- ToMutable<Schema.Schema.Type<Self>>,
99
- Simplify<RelationJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>,
100
- Schema.Schema.Context<Self>
101
- >,
102
- EchoSchema.TypeMeta {}
196
+ export const object: {
197
+ (opts: TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => Obj<Schema.Schema.Type<Self>>;
198
+ } = EchoObjectSchema as any;
199
+
200
+ //
201
+ // PersistentType (Schema stored in database)
202
+ //
203
+
204
+ export const PersistentType: Obj<PersistentSchema> = PersistentSchema as any;
205
+
206
+ export interface PersistentType extends Schema.Schema.Type<typeof PersistentType> {}
207
+
208
+ export { EchoSchema as RuntimeType };
209
+
210
+ //
211
+ // Relation - Runtime schema for any ECHO relation
212
+ //
213
+
214
+ // Internal type for the Relation schema constant.
215
+ type RelationSchemaType = Schema.Schema<
216
+ { id: ObjectId } & Record<string, unknown>,
217
+ { id: string } & Record<string, unknown>
218
+ > &
219
+ EchoSchemaKind<EntityKind.Relation> &
220
+ TypeMeta;
221
+
222
+ // Internal schema definition.
223
+ // NOTE: The EchoRelationSchema annotation is required for Type.Ref(Type.Relation) to work.
224
+ // The typename/version/source/target only satisfy ECHO schema machinery for reference targets.
225
+ const RelationSchema = Schema.Struct({
226
+ id: Schema.String,
227
+ }).pipe(
228
+ Schema.extend(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
229
+ EchoRelationSchema({
230
+ typename: 'dxos.org/schema/AnyRelation',
231
+ version: '0.0.0',
232
+ source: ObjSchema,
233
+ target: ObjSchema,
234
+ }),
235
+ );
103
236
 
104
237
  /**
105
- * Relation schema.
238
+ * Runtime Effect schema for any ECHO relation.
239
+ * Use for validation, parsing, or as a reference target for collections.
240
+ * A relation has `id`, source, and target fields plus any additional properties.
241
+ *
242
+ * NOTE: `Schema.is(Type.Relation)` does STRUCTURAL validation only (checks for `id` field).
243
+ * Use `Relation.isRelation()` for proper ECHO instance type guards that check the KindId brand.
244
+ *
245
+ * @example
246
+ * ```ts
247
+ * // Structural type guard (accepts any object with id field)
248
+ * if (Schema.is(Type.Relation)(unknownValue)) { ... }
249
+ *
250
+ * // ECHO instance type guard (checks KindId brand)
251
+ * if (Relation.isRelation(unknownValue)) { ... }
252
+ * ```
106
253
  */
107
- // TODO(dmaretskyi): I have to redefine the type here so that the definition uses symbols from @dxos/echo/Relation.
108
- export const Relation: {
109
- <Source extends Schema.Schema.AnyNoContext, Target extends Schema.Schema.AnyNoContext>(
110
- opts: EchoSchema.EchoRelationOptions<Source, Target>,
111
- ): <Self extends Schema.Schema.Any>(self: Self) => relation<Self, Source, Target>;
112
- } = EchoSchema.EchoRelation as any;
254
+ export const Relation: RelationSchemaType = Object.assign(RelationSchema, {
255
+ [SchemaKindId]: (RelationSchema as any)[SchemaKindId],
256
+ }) as unknown as RelationSchemaType;
113
257
 
114
258
  /**
115
- * Relation schema type definitions.
259
+ * TypeScript type for an ECHO relation schema.
260
+ * `T` is the instance type produced by the schema (excluding source/target).
261
+ * `Source` and `Target` are the endpoint types.
262
+ * `Fields` is the optional struct fields type for introspection.
116
263
  */
117
- export namespace Relation {
264
+ export interface Relation<
265
+ T = any,
266
+ Source = any,
267
+ Target = any,
268
+ Fields extends Schema.Struct.Fields = Schema.Struct.Fields,
269
+ > extends TypeMeta,
270
+ EchoSchemaKind<EntityKind.Relation>,
271
+ Schema.AnnotableClass<
272
+ Relation<T, Source, Target, Fields>,
273
+ Entity$.OfKind<typeof Entity$.Kind.Relation> & Relation.Endpoints<Source, Target> & T,
274
+ Schema.Simplify<RelationJsonProps & ToMutable<T>>,
275
+ never
276
+ > {
118
277
  /**
119
- * Type that represents an arbitrary schema type of a relation.
120
- * NOTE: This is not an instance type.
278
+ * The fields defined in the original struct schema.
279
+ * Allows accessing field definitions for introspection.
121
280
  */
122
- // TODO(dmaretskyi): If schema was covariant, we could specify props in here, like `id: ObjectId`.
123
- export type Any = Schema.Schema.AnyNoContext;
281
+ readonly fields: Fields;
282
+ }
124
283
 
284
+ /**
285
+ * Structural base type for any ECHO relation schema.
286
+ * Accepts static schemas (created with Type.relation()).
287
+ * NOTE: Does not include the brand symbol to avoid TS4053 declaration portability issues.
288
+ * Use Type.isRelationSchema() for runtime type guards.
289
+ */
290
+ type RelationSchemaBase = Schema.Schema.AnyNoContext & {
291
+ readonly typename: string;
292
+ readonly version: string;
293
+ };
294
+
295
+ export namespace Relation {
125
296
  /**
126
- * Get relation target type.
297
+ * Type that represents any ECHO relation schema.
298
+ * Accepts static schemas (Type.relation()).
127
299
  */
128
- export type Target<A> = A extends Relation.Endpoints<infer _S, infer T> ? T : never;
300
+ export type Any = RelationSchemaBase;
129
301
 
130
302
  /**
131
303
  * Get relation source type.
132
304
  */
133
305
  export type Source<A> = A extends Relation.Endpoints<infer S, infer _T> ? S : never;
134
306
 
307
+ /**
308
+ * Get relation target type.
309
+ */
310
+ export type Target<A> = A extends Relation.Endpoints<infer _S, infer T> ? T : never;
311
+
135
312
  export type Endpoints<Source, Target> = {
136
- [RelationModule.Source]: Source;
137
- [RelationModule.Target]: Target;
313
+ [Relation$.Source]: Source;
314
+ [Relation$.Target]: Target;
138
315
  };
139
316
  }
140
317
 
318
+ /**
319
+ * Factory function to create an ECHO relation schema.
320
+ * Adds relation metadata annotations to an Effect schema.
321
+ *
322
+ * @example
323
+ * ```ts
324
+ * const WorksFor = Schema.Struct({
325
+ * role: Schema.String,
326
+ * }).pipe(Type.relation({
327
+ * typename: 'example.com/type/WorksFor',
328
+ * version: '0.1.0',
329
+ * source: Person,
330
+ * target: Company,
331
+ * }));
332
+ * ```
333
+ */
334
+ export const relation: {
335
+ <SourceSchema extends Schema.Schema.AnyNoContext, TargetSchema extends Schema.Schema.AnyNoContext>(
336
+ opts: EchoRelationSchemaOptions<SourceSchema, TargetSchema>,
337
+ ): <Self extends Schema.Schema.Any>(
338
+ self: Self,
339
+ ) => Relation<Schema.Schema.Type<Self>, Schema.Schema.Type<SourceSchema>, Schema.Schema.Type<TargetSchema>>;
340
+ } = EchoRelationSchema as any;
341
+
342
+ //
343
+ // Entity - Entity schema types (union of Object | Relation)
344
+ //
345
+
346
+ export namespace Entity {
347
+ /**
348
+ * Runtime Effect schema for any ECHO entity (object or relation).
349
+ * Use for validation, parsing, or type guards on unknown values.
350
+ *
351
+ * @example
352
+ * ```ts
353
+ * if (Schema.is(Type.Entity.Any)(unknownValue)) {
354
+ * // unknownValue is an ECHO entity
355
+ * }
356
+ * ```
357
+ */
358
+ export const Any: Schema.Schema<
359
+ { id: ObjectId } & Record<string, unknown>,
360
+ { id: string } & Record<string, unknown>
361
+ > = Schema.Union(Obj, Relation);
362
+
363
+ /**
364
+ * Type alias for any ECHO entity schema (object or relation).
365
+ * Use this in type annotations for schema parameters.
366
+ */
367
+ export type Any = Obj.Any | Relation.Any;
368
+ }
369
+
370
+ /**
371
+ * Type guard to check if a schema is an object schema.
372
+ * NOTE: This checks SCHEMAS, not instances. Use Obj.isObject for instances.
373
+ */
374
+ export const isObjectSchema = (schema: Entity.Any): schema is Obj.Any => {
375
+ return (schema as any)[SchemaKindId] === EntityKind.Object;
376
+ };
377
+
378
+ /**
379
+ * Type guard to check if a schema is a relation schema.
380
+ * NOTE: This checks SCHEMAS, not instances. Use Relation.isRelation for instances.
381
+ */
382
+ export const isRelationSchema = (schema: Entity.Any): schema is Relation.Any => {
383
+ return (schema as any)[SchemaKindId] === EntityKind.Relation;
384
+ };
385
+
386
+ //
387
+ // Ref
388
+ //
389
+ // NOTE: `Type.Ref` vs `Ref.Ref`:
390
+ // - `Type.Ref<T>` is the SCHEMA type - a schema that produces `Ref.Ref<T>` instances.
391
+ // - `Ref.Ref<T>` is the INSTANCE type - the actual runtime ref object.
392
+ //
393
+ // Example:
394
+ // const taskRef: Ref.Ref<Task> = Ref.make(task); // Instance
395
+ // const schema: Type.Ref<Task> = Type.Ref(Task); // Schema
396
+ //
397
+
141
398
  /**
142
399
  * Return type of the `Ref` schema constructor.
143
400
  *
144
401
  * This typedef avoids `TS4023` error (name from external module cannot be used named).
145
402
  * See Effect's note on interface types.
146
403
  */
147
- export interface ref<TargetSchema extends Schema.Schema.Any>
148
- extends EchoSchema.Ref$<Schema.Schema.Type<TargetSchema>> {}
404
+ export interface ref<TargetSchema extends Schema.Schema.Any> extends RefSchema<Schema.Schema.Type<TargetSchema>> {}
149
405
 
150
406
  /**
151
- * Ref schema.
407
+ * Factory function to create a Ref schema for the given target schema.
408
+ * Use this in schema definitions to declare reference fields.
409
+ *
410
+ * @example
411
+ * ```ts
412
+ * const Task = Schema.Struct({
413
+ * assignee: Type.Ref(Person), // Creates a Ref schema
414
+ * }).pipe(Type.object({ typename: 'Task', version: '0.1.0' }));
415
+ * ```
152
416
  */
153
- export const Ref: <S extends Obj.Any>(schema: S) => ref<S> = EchoSchema.Ref;
417
+ export const Ref: RefFn = Ref$;
154
418
 
155
- export interface Ref<T> extends Schema.SchemaClass<EchoSchema.Ref<T>, EncodedReference> {}
419
+ /**
420
+ * TypeScript type for a Ref schema.
421
+ * This is the type of the SCHEMA itself, not the runtime ref instance.
422
+ * For the instance type, use `Ref.Ref<T>` from the Ref module.
423
+ *
424
+ * @example
425
+ * ```ts
426
+ * // Schema type annotation (rarely needed, usually inferred):
427
+ * const refSchema: Type.Ref<Task> = Type.Ref(Task);
428
+ *
429
+ * // Instance type annotation (use Ref.Ref instead):
430
+ * const refInstance: Ref.Ref<Task> = Ref.make(task);
431
+ * ```
432
+ */
433
+ export interface Ref<T> extends Schema.SchemaClass<Ref$<T>, EncodedReference> {}
156
434
 
157
- // TODO(buurdon): Move to Ref?
158
435
  export namespace Ref {
159
436
  /**
160
- * Type that represents an arbitrary schema type of a reference.
161
- * NOTE: This is not an instance type.
437
+ * Type that represents any Ref schema (with unknown target type).
438
+ * This is a schema type, not an instance type.
162
439
  */
163
- export type Any = Schema.Schema<EchoSchema.Ref<any>, EncodedReference>;
440
+ export type Any = Schema.Schema<Ref$<any>, EncodedReference>;
164
441
  }
165
442
 
443
+ //
444
+ // Schema utility functions
445
+ //
446
+
166
447
  /**
167
448
  * Gets the full DXN of the schema.
168
449
  * Will include the version if it's a `type` DXN.
169
450
  * @example "dxn:example.com/type/Person:0.1.0"
170
451
  * @example "dxn:echo:SSSSSSSSSS:XXXXXXXXXXXXX"
171
452
  */
172
- export const getDXN = (schema: Obj.Any | Relation.Any): Keys.DXN | undefined => {
173
- return EchoSchema.getSchemaDXN(schema);
453
+ export const getDXN = (schema: Entity.Any): DXN | undefined => {
454
+ return getSchemaDXN(schema);
174
455
  };
175
456
 
176
457
  /**
177
458
  * @param schema - Schema to get the typename from.
178
459
  * @returns The typename of the schema. Example: `example.com/type/Person`.
179
460
  */
180
- export const getTypename = (schema: Obj.Any | Relation.Any): string => {
181
- const typename = EchoSchema.getSchemaTypename(schema);
461
+ export const getTypename = (schema: Entity.Any): string => {
462
+ const typename = getSchemaTypename(schema);
182
463
  invariant(typeof typename === 'string' && !typename.startsWith('dxn:'), 'Invalid typename');
183
464
  return typename;
184
465
  };
@@ -187,45 +468,25 @@ export const getTypename = (schema: Obj.Any | Relation.Any): string => {
187
468
  * Gets the version of the schema.
188
469
  * @example 0.1.0
189
470
  */
190
- export const getVersion = (schema: Obj.Any | Relation.Any): string => {
191
- const version = EchoSchema.getSchemaVersion(schema);
471
+ export const getVersion = (schema: Entity.Any): string => {
472
+ const version = getSchemaVersion(schema);
192
473
  invariant(typeof version === 'string' && version.match(/^\d+\.\d+\.\d+$/), 'Invalid version');
193
474
  return version;
194
475
  };
195
476
 
196
477
  /**
197
- * ECHO type metadata.
478
+ * @returns True if the schema is mutable.
198
479
  */
199
- export type Meta = EchoSchema.TypeAnnotation;
480
+ export const isMutable = isMutable$;
200
481
 
201
482
  /**
202
- * Gets the meta data of the schema.
483
+ * ECHO type metadata.
203
484
  */
204
- export const getMeta = (schema: Obj.Any | Relation.Any): Meta | undefined => {
205
- return EchoSchema.getTypeAnnotation(schema);
206
- };
485
+ export type Meta = TypeAnnotation;
207
486
 
208
487
  /**
209
- * @returns True if the schema is mutable.
488
+ * Gets the meta data of the schema.
210
489
  */
211
- export const isMutable = EchoSchema.isMutable;
212
-
213
- export { SpaceId, ObjectId, DXN } from '@dxos/keys';
214
-
215
- export interface Expando extends OfKind<EchoSchema.EntityKind.Object> {
216
- [key: string]: any;
217
- }
218
-
219
- export const Expando: Schema.Schema<
220
- Expando,
221
- Simplify<ObjJsonProps & { [key: string]: any }>,
222
- never
223
- > = EchoSchema.Expando as any;
224
-
225
- export {
226
- // TODO(burdon): Standardize.
227
- Format,
228
- JsonSchemaType as JsonSchema,
229
- toEffectSchema,
230
- toJsonSchema,
231
- } from '@dxos/echo-schema';
490
+ export const getMeta = (schema: Entity.Any): Meta | undefined => {
491
+ return getTypeAnnotation(schema);
492
+ };