@dxos/echo 0.8.4-staging.ac66bdf99f → 0.9.0
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.
- package/LICENSE +102 -5
- package/README.md +7 -7
- package/dist/lib/neutral/Annotation.mjs +37 -6
- package/dist/lib/neutral/Database.mjs +6 -17
- package/dist/lib/neutral/Entity.mjs +31 -20
- package/dist/lib/neutral/Err.mjs +3 -3
- package/dist/lib/neutral/Feed.mjs +23 -19
- package/dist/lib/neutral/Filter.mjs +13 -15
- package/dist/lib/neutral/Format.mjs +23 -3
- package/dist/lib/neutral/JsonSchema.mjs +7 -8
- package/dist/lib/neutral/Key.mjs +9 -5
- package/dist/lib/neutral/Migration.mjs +11 -10
- package/dist/lib/neutral/Obj.mjs +29 -20
- package/dist/lib/neutral/Order.mjs +7 -3
- package/dist/lib/neutral/Query.mjs +17 -17
- package/dist/lib/neutral/QueryResult.mjs +1 -1
- package/dist/lib/neutral/Ref.mjs +10 -9
- package/dist/lib/neutral/Registry.mjs +14 -0
- package/dist/lib/neutral/Relation.mjs +28 -25
- package/dist/lib/neutral/Scope.mjs +12 -0
- package/dist/lib/neutral/Tag.mjs +17 -14
- package/dist/lib/neutral/Type.mjs +54 -26
- package/dist/lib/neutral/{chunk-OMUPQMLR.mjs → chunk-35INCYOE.mjs} +1 -1
- package/dist/lib/neutral/chunk-35INCYOE.mjs.map +7 -0
- package/dist/lib/neutral/chunk-3PBP4V4O.mjs +101 -0
- package/dist/lib/neutral/chunk-3PBP4V4O.mjs.map +7 -0
- package/dist/lib/neutral/chunk-4ZUHOTCG.mjs +184 -0
- package/dist/lib/neutral/chunk-4ZUHOTCG.mjs.map +7 -0
- package/dist/lib/neutral/chunk-5SMDBFVB.mjs +108 -0
- package/dist/lib/neutral/chunk-5SMDBFVB.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-OS35K56T.mjs → chunk-5SUJPHAE.mjs} +3 -3
- package/dist/lib/neutral/{chunk-OS35K56T.mjs.map → chunk-5SUJPHAE.mjs.map} +2 -2
- package/dist/lib/neutral/{chunk-GZQTCRJB.mjs → chunk-6M2Z6WBH.mjs} +22 -2
- package/dist/lib/neutral/chunk-6M2Z6WBH.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-V36VO5SS.mjs → chunk-6YDI3J37.mjs} +32 -40
- package/dist/lib/neutral/chunk-6YDI3J37.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-MOR5ERFM.mjs → chunk-7FPIAJIV.mjs} +701 -1256
- package/dist/lib/neutral/chunk-7FPIAJIV.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-ANHVGJI4.mjs → chunk-7LOUAPYZ.mjs} +9 -5
- package/dist/lib/neutral/chunk-7LOUAPYZ.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-JUXPFOEI.mjs → chunk-7PI7C4EF.mjs} +48 -88
- package/dist/lib/neutral/chunk-7PI7C4EF.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-UBEZSGXY.mjs → chunk-BBFJWWAV.mjs} +6 -6
- package/dist/lib/neutral/chunk-BBFJWWAV.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-UI6MWK5W.mjs → chunk-EVK6XBXO.mjs} +16 -2
- package/dist/lib/neutral/chunk-EVK6XBXO.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-7RO7CPBZ.mjs → chunk-IGK6FN65.mjs} +2 -2
- package/dist/lib/neutral/{chunk-HBUZJNZO.mjs → chunk-LWXVKPPW.mjs} +94 -99
- package/dist/lib/neutral/chunk-LWXVKPPW.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-BVOFLCVF.mjs → chunk-MZ7K3MLL.mjs} +9 -6
- package/dist/lib/neutral/chunk-MZ7K3MLL.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-TBKX6JQO.mjs → chunk-O6BH7EPN.mjs} +30 -3
- package/dist/lib/neutral/chunk-O6BH7EPN.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-EAMSSLZC.mjs → chunk-QQIYS74I.mjs} +83 -46
- package/dist/lib/neutral/chunk-QQIYS74I.mjs.map +7 -0
- package/dist/lib/neutral/chunk-R5W6DXR4.mjs +678 -0
- package/dist/lib/neutral/chunk-R5W6DXR4.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-WAK4DMFV.mjs → chunk-RIVWNMSF.mjs} +12 -7
- package/dist/lib/neutral/chunk-RIVWNMSF.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-T6W2LEZU.mjs → chunk-SBVFRTST.mjs} +73 -38
- package/dist/lib/neutral/chunk-SBVFRTST.mjs.map +7 -0
- package/dist/lib/neutral/chunk-T6E37YIP.mjs +251 -0
- package/dist/lib/neutral/chunk-T6E37YIP.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-DQYLD2RB.mjs → chunk-TFEWTY5A.mjs} +155 -129
- package/dist/lib/neutral/chunk-TFEWTY5A.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-B4BASU6W.mjs → chunk-TYGKCRMK.mjs} +85 -76
- package/dist/lib/neutral/chunk-TYGKCRMK.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-4OIBYSXE.mjs → chunk-UUP46KUQ.mjs} +78 -32
- package/dist/lib/neutral/chunk-UUP46KUQ.mjs.map +7 -0
- package/dist/lib/neutral/chunk-WISOH2XH.mjs +36 -0
- package/dist/lib/neutral/chunk-WISOH2XH.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-G3IQMKF7.mjs → chunk-WTQJHC75.mjs} +111 -112
- package/dist/lib/neutral/chunk-WTQJHC75.mjs.map +7 -0
- package/dist/lib/neutral/chunk-WU3GIANS.mjs +31 -0
- package/dist/lib/neutral/chunk-WU3GIANS.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-TU3GW67D.mjs → chunk-ZGNNFYHS.mjs} +40 -40
- package/dist/lib/neutral/chunk-ZGNNFYHS.mjs.map +7 -0
- package/dist/lib/neutral/index.mjs +47 -41
- package/dist/lib/neutral/internal/index.mjs +137 -72
- package/dist/lib/neutral/meta.json +1 -1
- package/dist/lib/neutral/testing/index.mjs +261 -178
- package/dist/lib/neutral/testing/index.mjs.map +4 -4
- package/dist/types/src/Annotation.d.ts +108 -4
- package/dist/types/src/Annotation.d.ts.map +1 -1
- package/dist/types/src/Annotation.test.d.ts +2 -0
- package/dist/types/src/Annotation.test.d.ts.map +1 -0
- package/dist/types/src/Collection.d.ts +2 -3
- package/dist/types/src/Collection.d.ts.map +1 -1
- package/dist/types/src/Database.d.ts +56 -49
- package/dist/types/src/Database.d.ts.map +1 -1
- package/dist/types/src/Dataset.d.ts +16 -6
- package/dist/types/src/Dataset.d.ts.map +1 -1
- package/dist/types/src/Entity.d.ts +101 -28
- package/dist/types/src/Entity.d.ts.map +1 -1
- package/dist/types/src/Err.d.ts +27 -27
- package/dist/types/src/Err.d.ts.map +1 -1
- package/dist/types/src/Feed.d.ts +66 -19
- package/dist/types/src/Feed.d.ts.map +1 -1
- package/dist/types/src/Filter.d.ts +38 -12
- package/dist/types/src/Filter.d.ts.map +1 -1
- package/dist/types/src/Format.d.ts +0 -2
- package/dist/types/src/Format.d.ts.map +1 -1
- package/dist/types/src/Hypergraph.d.ts +14 -9
- package/dist/types/src/Hypergraph.d.ts.map +1 -1
- package/dist/types/src/Json.d.ts +33 -0
- package/dist/types/src/Json.d.ts.map +1 -0
- package/dist/types/src/Json.test.d.ts +2 -0
- package/dist/types/src/Json.test.d.ts.map +1 -0
- package/dist/types/src/JsonSchema.d.ts +2 -2
- package/dist/types/src/JsonSchema.d.ts.map +1 -1
- package/dist/types/src/Key.d.ts +1 -1
- package/dist/types/src/Key.d.ts.map +1 -1
- package/dist/types/src/Migration.d.ts +26 -11
- package/dist/types/src/Migration.d.ts.map +1 -1
- package/dist/types/src/Obj.d.ts +104 -61
- package/dist/types/src/Obj.d.ts.map +1 -1
- package/dist/types/src/Order.d.ts +10 -0
- package/dist/types/src/Order.d.ts.map +1 -1
- package/dist/types/src/Query.d.ts +34 -12
- package/dist/types/src/Query.d.ts.map +1 -1
- package/dist/types/src/QueryResult.d.ts +21 -0
- package/dist/types/src/QueryResult.d.ts.map +1 -1
- package/dist/types/src/Ref.d.ts +15 -7
- package/dist/types/src/Ref.d.ts.map +1 -1
- package/dist/types/src/Registry.d.ts +131 -0
- package/dist/types/src/Registry.d.ts.map +1 -0
- package/dist/types/src/Relation.d.ts +73 -41
- package/dist/types/src/Relation.d.ts.map +1 -1
- package/dist/types/src/Scope.d.ts +35 -0
- package/dist/types/src/Scope.d.ts.map +1 -0
- package/dist/types/src/Tag.d.ts +21 -5
- package/dist/types/src/Tag.d.ts.map +1 -1
- package/dist/types/src/Type.d.ts +362 -95
- package/dist/types/src/Type.d.ts.map +1 -1
- package/dist/types/src/View.d.ts +9 -12
- package/dist/types/src/View.d.ts.map +1 -1
- package/dist/types/src/exemplars.test.d.ts +2 -0
- package/dist/types/src/exemplars.test.d.ts.map +1 -0
- package/dist/types/src/index.d.ts +4 -3
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/annotations.d.ts +79 -38
- package/dist/types/src/internal/Annotation/annotations.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/dictionary.d.ts +24 -0
- package/dist/types/src/internal/Annotation/dictionary.d.ts.map +1 -0
- package/dist/types/src/internal/Annotation/entity-dictionary.d.ts +14 -0
- package/dist/types/src/internal/Annotation/entity-dictionary.d.ts.map +1 -0
- package/dist/types/src/internal/Annotation/index.d.ts +4 -2
- package/dist/types/src/internal/Annotation/index.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/sorting.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/util.d.ts +14 -5
- package/dist/types/src/internal/Annotation/util.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/api.d.ts +17 -3
- package/dist/types/src/internal/Entity/api.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/entity.d.ts +72 -8
- package/dist/types/src/internal/Entity/entity.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/guard.d.ts +10 -0
- package/dist/types/src/internal/Entity/guard.d.ts.map +1 -0
- package/dist/types/src/internal/Entity/index.d.ts +2 -0
- package/dist/types/src/internal/Entity/index.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/model.d.ts +21 -17
- package/dist/types/src/internal/Entity/model.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/object.d.ts +3 -3
- package/dist/types/src/internal/Entity/object.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/relation.d.ts +30 -7
- package/dist/types/src/internal/Entity/relation.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/type-kind.d.ts +24 -0
- package/dist/types/src/internal/Entity/type-kind.d.ts.map +1 -0
- package/dist/types/src/internal/Entity/type-uri.d.ts +24 -0
- package/dist/types/src/internal/Entity/type-uri.d.ts.map +1 -0
- package/dist/types/src/internal/Entity/version.d.ts.map +1 -1
- package/dist/types/src/internal/Format/date.d.ts.map +1 -1
- package/dist/types/src/internal/Format/format.d.ts +3 -2
- package/dist/types/src/internal/Format/format.d.ts.map +1 -1
- package/dist/types/src/internal/Format/index.d.ts +2 -2
- package/dist/types/src/internal/Format/index.d.ts.map +1 -1
- package/dist/types/src/internal/Format/number.d.ts.map +1 -1
- package/dist/types/src/internal/Format/object.d.ts +3 -1
- package/dist/types/src/internal/Format/object.d.ts.map +1 -1
- package/dist/types/src/internal/Format/types.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema-normalize.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema-type.d.ts +34 -34
- package/dist/types/src/internal/JsonSchema/json-schema-type.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema.d.ts +3 -2
- package/dist/types/src/internal/JsonSchema/json-schema.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/atoms.d.ts +38 -0
- package/dist/types/src/internal/Obj/atoms.d.ts.map +1 -0
- package/dist/types/src/internal/Obj/clone.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/common.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/create-object.d.ts +12 -12
- package/dist/types/src/internal/Obj/create-object.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/deleted.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/index.d.ts +1 -1
- package/dist/types/src/internal/Obj/index.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/json-serializer.d.ts +8 -8
- package/dist/types/src/internal/Obj/json-serializer.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/set-value.d.ts +1 -1
- package/dist/types/src/internal/Obj/set-value.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/snapshot.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/typed-object.d.ts +1 -1
- package/dist/types/src/internal/Query/index.d.ts +2 -0
- package/dist/types/src/internal/Query/index.d.ts.map +1 -0
- package/dist/types/src/internal/{Query.d.ts → Query/pretty.d.ts} +1 -1
- package/dist/types/src/internal/Query/pretty.d.ts.map +1 -0
- package/dist/types/src/internal/Ref/atoms.d.ts +10 -0
- package/dist/types/src/internal/Ref/atoms.d.ts.map +1 -0
- package/dist/types/src/internal/Ref/ref-array.d.ts +2 -2
- package/dist/types/src/internal/Ref/ref.d.ts +50 -19
- package/dist/types/src/internal/Ref/ref.d.ts.map +1 -1
- package/dist/types/src/internal/Ref/utils.d.ts +8 -0
- package/dist/types/src/internal/Ref/utils.d.ts.map +1 -0
- package/dist/types/src/internal/Type/compose.d.ts.map +1 -1
- package/dist/types/src/internal/Type/index.d.ts +1 -2
- package/dist/types/src/internal/Type/index.d.ts.map +1 -1
- package/dist/types/src/internal/Type/manipulation.d.ts +0 -1
- package/dist/types/src/internal/Type/manipulation.d.ts.map +1 -1
- package/dist/types/src/internal/Type/type-schema.d.ts +52 -0
- package/dist/types/src/internal/Type/type-schema.d.ts.map +1 -0
- package/dist/types/src/internal/common/api/meta.d.ts +14 -11
- package/dist/types/src/internal/common/api/meta.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/change-context.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/change-context.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/define-hidden-property.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/errors.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/errors.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/event-batch.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/json-serializer.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/make-object.d.ts +11 -5
- package/dist/types/src/internal/common/proxy/make-object.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/ownership.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/proxy-utils.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/reactive-array.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/reactive.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/reactive.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/reactive.test.d.ts +2 -0
- package/dist/types/src/internal/common/proxy/reactive.test.d.ts.map +1 -0
- package/dist/types/src/internal/common/proxy/schema-validator.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/typed-handler.d.ts +18 -2
- package/dist/types/src/internal/common/proxy/typed-handler.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/base.d.ts +4 -4
- package/dist/types/src/internal/common/types/base.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/entity.d.ts +62 -5
- package/dist/types/src/internal/common/types/entity.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/index.d.ts +1 -1
- package/dist/types/src/internal/common/types/index.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/meta.d.ts +33 -12
- package/dist/types/src/internal/common/types/meta.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/model-symbols.d.ts +15 -4
- package/dist/types/src/internal/common/types/model-symbols.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/typename.d.ts +7 -0
- package/dist/types/src/internal/common/types/typename.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/version.d.ts +1 -1
- package/dist/types/src/internal/common/types/well-known-types.d.ts +11 -0
- package/dist/types/src/internal/common/types/well-known-types.d.ts.map +1 -0
- package/dist/types/src/internal/index.d.ts +2 -2
- package/dist/types/src/internal/index.d.ts.map +1 -1
- package/dist/types/src/testing/index.d.ts +1 -0
- package/dist/types/src/testing/index.d.ts.map +1 -1
- package/dist/types/src/testing/registry.d.ts +9 -0
- package/dist/types/src/testing/registry.d.ts.map +1 -0
- package/dist/types/src/testing/test-data.d.ts +8 -8
- package/dist/types/src/testing/test-data.d.ts.map +1 -1
- package/dist/types/src/testing/test-schema.d.ts +83 -89
- package/dist/types/src/testing/test-schema.d.ts.map +1 -1
- package/dist/types/src/testing/util.d.ts +5 -3
- package/dist/types/src/testing/util.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +26 -24
- package/src/Annotation.test.ts +439 -0
- package/src/Annotation.ts +158 -4
- package/src/Collection.ts +5 -9
- package/src/Database.ts +93 -100
- package/src/Dataset.ts +10 -2
- package/src/Entity.test.ts +116 -6
- package/src/Entity.ts +134 -32
- package/src/Err.ts +4 -4
- package/src/Feed.ts +92 -44
- package/src/Filter.ts +70 -40
- package/src/Format.ts +0 -4
- package/src/Hypergraph.ts +14 -9
- package/src/Json.test.ts +175 -0
- package/src/Json.ts +103 -0
- package/src/Key.ts +1 -1
- package/src/Migration.ts +39 -19
- package/src/Obj.test.ts +122 -20
- package/src/Obj.ts +168 -91
- package/src/Order.ts +22 -0
- package/src/Query.test.ts +183 -154
- package/src/Query.ts +172 -85
- package/src/QueryResult.ts +26 -0
- package/src/Ref.ts +22 -4
- package/src/Registry.ts +155 -0
- package/src/Relation.test.ts +10 -10
- package/src/Relation.ts +116 -69
- package/src/Scope.ts +50 -0
- package/src/Tag.md +88 -0
- package/src/Tag.ts +49 -6
- package/src/Type.test.ts +223 -18
- package/src/Type.ts +609 -131
- package/src/View.ts +14 -23
- package/src/exemplars.test.ts +21 -0
- package/src/index.ts +4 -4
- package/src/internal/Annotation/annotations.test.ts +31 -11
- package/src/internal/Annotation/annotations.ts +143 -111
- package/src/internal/Annotation/dictionary.ts +47 -0
- package/src/internal/Annotation/entity-dictionary.ts +74 -0
- package/src/internal/Annotation/index.ts +4 -2
- package/src/internal/Annotation/util.ts +17 -8
- package/src/internal/Entity/api.ts +54 -7
- package/src/internal/Entity/entity.ts +196 -47
- package/src/internal/Entity/guard.ts +26 -0
- package/src/internal/Entity/index.ts +2 -0
- package/src/internal/Entity/model.ts +38 -28
- package/src/internal/Entity/object.ts +21 -5
- package/src/internal/Entity/relation.ts +68 -34
- package/src/internal/Entity/type-kind.ts +75 -0
- package/src/internal/Entity/type-uri.ts +92 -0
- package/src/internal/Entity/util.ts +9 -9
- package/src/internal/Format/date.ts +0 -4
- package/src/internal/Format/format.test.ts +21 -0
- package/src/internal/Format/index.ts +2 -3
- package/src/internal/Format/object.ts +21 -4
- package/src/internal/Format/types.ts +1 -1
- package/src/internal/JsonSchema/annotations.ts +1 -1
- package/src/internal/JsonSchema/json-schema-type.ts +4 -4
- package/src/internal/JsonSchema/json-schema.test.ts +71 -145
- package/src/internal/JsonSchema/json-schema.ts +49 -35
- package/src/internal/Obj/atoms.ts +244 -0
- package/src/internal/Obj/clone.ts +9 -4
- package/src/internal/Obj/create-object.test.ts +12 -10
- package/src/internal/Obj/create-object.ts +68 -22
- package/src/internal/Obj/index.ts +1 -1
- package/src/internal/Obj/inspect.ts +5 -3
- package/src/internal/Obj/json-serializer.test.ts +101 -22
- package/src/internal/Obj/json-serializer.ts +89 -33
- package/src/internal/Obj/set-value.test.ts +22 -45
- package/src/internal/Obj/set-value.ts +12 -19
- package/src/internal/Obj/snapshot.ts +13 -4
- package/src/internal/Obj/typed-object.test.ts +9 -11
- package/src/internal/Obj/typed-object.ts +1 -1
- package/src/internal/Query/index.ts +5 -0
- package/src/internal/{Query.ts → Query/pretty.ts} +40 -12
- package/src/internal/Ref/atoms.ts +20 -0
- package/src/internal/Ref/ref-array.ts +3 -3
- package/src/internal/Ref/ref.test.ts +18 -27
- package/src/internal/Ref/ref.ts +137 -59
- package/src/internal/Ref/utils.ts +45 -0
- package/src/internal/Type/compose.test.ts +3 -1
- package/src/internal/Type/index.ts +1 -2
- package/src/internal/Type/manipulation.ts +0 -25
- package/src/internal/Type/type-schema.ts +60 -0
- package/src/internal/common/README.md +2 -2
- package/src/internal/common/api/meta.ts +19 -17
- package/src/internal/common/proxy/change-context.ts +1 -1
- package/src/internal/common/proxy/change.test.ts +91 -83
- package/src/internal/common/proxy/errors.ts +2 -2
- package/src/internal/common/proxy/handler.test.ts +1 -1
- package/src/internal/common/proxy/json-serializer.ts +27 -16
- package/src/internal/common/proxy/make-object.ts +44 -20
- package/src/internal/common/proxy/ownership.ts +2 -2
- package/src/internal/common/proxy/reactive-array.ts +1 -1
- package/src/internal/common/proxy/reactive.test.ts +54 -0
- package/src/internal/common/proxy/reactive.ts +11 -2
- package/src/internal/common/proxy/schema.test.ts +48 -86
- package/src/internal/common/proxy/typed-handler.test.ts +12 -11
- package/src/internal/common/proxy/typed-handler.ts +78 -16
- package/src/internal/common/proxy/typed-object.test.ts +16 -28
- package/src/internal/common/types/base.ts +4 -4
- package/src/internal/common/types/entity.ts +80 -1
- package/src/internal/common/types/index.ts +6 -1
- package/src/internal/common/types/meta.ts +62 -20
- package/src/internal/common/types/model-symbols.ts +24 -4
- package/src/internal/common/types/typename.ts +39 -3
- package/src/internal/common/types/well-known-types.ts +15 -0
- package/src/internal/index.ts +6 -4
- package/src/testing/api.test.ts +15 -9
- package/src/testing/index.ts +1 -0
- package/src/testing/registry.ts +44 -0
- package/src/testing/test-data.ts +159 -99
- package/src/testing/test-schema.ts +22 -58
- package/src/testing/util.ts +14 -11
- package/dist/lib/neutral/Extension.mjs +0 -18
- package/dist/lib/neutral/SchemaRegistry.mjs +0 -2
- package/dist/lib/neutral/chunk-2KHZ36F5.mjs +0 -361
- package/dist/lib/neutral/chunk-2KHZ36F5.mjs.map +0 -7
- package/dist/lib/neutral/chunk-4OIBYSXE.mjs.map +0 -7
- package/dist/lib/neutral/chunk-4P3IXBLT.mjs +0 -45
- package/dist/lib/neutral/chunk-4P3IXBLT.mjs.map +0 -7
- package/dist/lib/neutral/chunk-ANHVGJI4.mjs.map +0 -7
- package/dist/lib/neutral/chunk-B4BASU6W.mjs.map +0 -7
- package/dist/lib/neutral/chunk-BNCCGLJN.mjs +0 -7
- package/dist/lib/neutral/chunk-BNCCGLJN.mjs.map +0 -7
- package/dist/lib/neutral/chunk-BVOFLCVF.mjs.map +0 -7
- package/dist/lib/neutral/chunk-DQYLD2RB.mjs.map +0 -7
- package/dist/lib/neutral/chunk-EAMSSLZC.mjs.map +0 -7
- package/dist/lib/neutral/chunk-G3IQMKF7.mjs.map +0 -7
- package/dist/lib/neutral/chunk-GZQTCRJB.mjs.map +0 -7
- package/dist/lib/neutral/chunk-HBUZJNZO.mjs.map +0 -7
- package/dist/lib/neutral/chunk-JUXPFOEI.mjs.map +0 -7
- package/dist/lib/neutral/chunk-MOR5ERFM.mjs.map +0 -7
- package/dist/lib/neutral/chunk-OMUPQMLR.mjs.map +0 -7
- package/dist/lib/neutral/chunk-PHU22NLC.mjs +0 -136
- package/dist/lib/neutral/chunk-PHU22NLC.mjs.map +0 -7
- package/dist/lib/neutral/chunk-ROG4RXXL.mjs +0 -97
- package/dist/lib/neutral/chunk-ROG4RXXL.mjs.map +0 -7
- package/dist/lib/neutral/chunk-T6W2LEZU.mjs.map +0 -7
- package/dist/lib/neutral/chunk-TBKX6JQO.mjs.map +0 -7
- package/dist/lib/neutral/chunk-TU3GW67D.mjs.map +0 -7
- package/dist/lib/neutral/chunk-UBEZSGXY.mjs.map +0 -7
- package/dist/lib/neutral/chunk-UI6MWK5W.mjs.map +0 -7
- package/dist/lib/neutral/chunk-V36VO5SS.mjs.map +0 -7
- package/dist/lib/neutral/chunk-WAK4DMFV.mjs.map +0 -7
- package/dist/lib/neutral/chunk-YAHXAYOW.mjs +0 -56
- package/dist/lib/neutral/chunk-YAHXAYOW.mjs.map +0 -7
- package/dist/lib/neutral/chunk-YS6Q3XAD.mjs +0 -50
- package/dist/lib/neutral/chunk-YS6Q3XAD.mjs.map +0 -7
- package/dist/types/src/Extension.d.ts +0 -80
- package/dist/types/src/Extension.d.ts.map +0 -1
- package/dist/types/src/Extension.test.d.ts +0 -2
- package/dist/types/src/Extension.test.d.ts.map +0 -1
- package/dist/types/src/SchemaRegistry.d.ts +0 -84
- package/dist/types/src/SchemaRegistry.d.ts.map +0 -1
- package/dist/types/src/internal/Obj/ids.d.ts +0 -6
- package/dist/types/src/internal/Obj/ids.d.ts.map +0 -1
- package/dist/types/src/internal/Query.d.ts.map +0 -1
- package/dist/types/src/internal/Type/echo-schema.d.ts +0 -181
- package/dist/types/src/internal/Type/echo-schema.d.ts.map +0 -1
- package/dist/types/src/internal/Type/persistent-schema.d.ts +0 -20
- package/dist/types/src/internal/Type/persistent-schema.d.ts.map +0 -1
- package/src/Extension.test.ts +0 -235
- package/src/Extension.ts +0 -122
- package/src/SchemaRegistry.ts +0 -106
- package/src/internal/Obj/ids.ts +0 -12
- package/src/internal/Type/echo-schema.ts +0 -423
- package/src/internal/Type/persistent-schema.ts +0 -33
- /package/dist/lib/neutral/{Extension.mjs.map → Registry.mjs.map} +0 -0
- /package/dist/lib/neutral/{SchemaRegistry.mjs.map → Scope.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-7RO7CPBZ.mjs.map → chunk-IGK6FN65.mjs.map} +0 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Option from 'effect/Option';
|
|
6
|
+
|
|
7
|
+
import { deepMapValues } from '@dxos/util';
|
|
8
|
+
|
|
9
|
+
import type * as Annotation from '../../Annotation';
|
|
10
|
+
import type * as Entity from '../../Entity';
|
|
11
|
+
import { getMetaChecked } from '../common/api/meta';
|
|
12
|
+
import { type Mutable } from '../common/proxy/reactive';
|
|
13
|
+
import { getDatabase } from '../Entity/api';
|
|
14
|
+
import { isEntity, isSnapshot } from '../Entity/guard';
|
|
15
|
+
import { Ref, getRefSavedTarget } from '../Ref';
|
|
16
|
+
import { getDictionary, setDictionary } from './dictionary';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Get the value of an annotation from an entity instance or snapshot.
|
|
20
|
+
*/
|
|
21
|
+
export const get = <T>(
|
|
22
|
+
target: Entity.Unknown | Entity.Snapshot,
|
|
23
|
+
annotation: Annotation.Annotation<T>,
|
|
24
|
+
): Option.Option<T> => {
|
|
25
|
+
if (isEntity(target) || isSnapshot(target)) {
|
|
26
|
+
const meta = getMetaChecked(target);
|
|
27
|
+
return getDictionary(meta.annotations, annotation);
|
|
28
|
+
} else {
|
|
29
|
+
throw new TypeError('Target is not an annotation target.');
|
|
30
|
+
}
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Set the value of an annotation on an entity instance.
|
|
35
|
+
* Must be called with a mutable entity — i.e. inside an `Obj.update` callback.
|
|
36
|
+
*/
|
|
37
|
+
export const set = <T>(target: Mutable<Entity.Unknown>, annotation: Annotation.Annotation<T>, value: T): void => {
|
|
38
|
+
if (isEntity(target)) {
|
|
39
|
+
const meta = getMetaChecked(target);
|
|
40
|
+
// Persist any unsaved Ref targets in the value into the entity's database so
|
|
41
|
+
// the encoded DXN resolves on read. This mirrors normal property assignment,
|
|
42
|
+
// where the reactive proxy links unsaved ref targets via `createRef` →
|
|
43
|
+
// `database.add`. `setDictionary` pre-encodes the value (`Schema.encodeSync`),
|
|
44
|
+
// so the live Ref never reaches the proxy's link handling and would otherwise
|
|
45
|
+
// be stored as a dangling reference.
|
|
46
|
+
persistRefTargets(target, value);
|
|
47
|
+
setDictionary(meta.annotations, annotation, value);
|
|
48
|
+
} else {
|
|
49
|
+
throw new TypeError('Target is not an annotation target.');
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Add any unsaved Ref targets found in `value` to the host entity's database, matching the
|
|
55
|
+
* auto-persistence applied to refs assigned to ordinary entity properties. Refs whose target
|
|
56
|
+
* already lives in a database (the host's or a foreign one) are left untouched.
|
|
57
|
+
*/
|
|
58
|
+
const persistRefTargets = (host: Entity.Unknown, value: unknown): void => {
|
|
59
|
+
const database = getDatabase(host);
|
|
60
|
+
if (database == null) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
deepMapValues(value, (current, recurse) => {
|
|
65
|
+
if (Ref.isRef(current)) {
|
|
66
|
+
const refTarget = getRefSavedTarget(current);
|
|
67
|
+
if (refTarget != null && isEntity(refTarget) && getDatabase(refTarget) == null) {
|
|
68
|
+
database.add(refTarget);
|
|
69
|
+
}
|
|
70
|
+
return current;
|
|
71
|
+
}
|
|
72
|
+
return recurse(current);
|
|
73
|
+
});
|
|
74
|
+
};
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import * as Option from 'effect/Option';
|
|
6
6
|
import type * as Schema from 'effect/Schema';
|
|
7
7
|
import * as SchemaAST from 'effect/SchemaAST';
|
|
8
8
|
|
|
@@ -13,7 +13,12 @@ import { EntityKind } from '../common/types';
|
|
|
13
13
|
|
|
14
14
|
export interface AnnotationHelper<T> {
|
|
15
15
|
/**
|
|
16
|
-
* Get the annotation value from
|
|
16
|
+
* Get the annotation value from an Effect schema.
|
|
17
|
+
*
|
|
18
|
+
* Only accepts `Schema.Schema.Any` — to read an annotation off a `Type.Type`
|
|
19
|
+
* entity, unwrap it first with `Type.getSchema(entity)`. This keeps the
|
|
20
|
+
* annotation pipeline single-shaped and forces annotations to live on the
|
|
21
|
+
* source schema, not on the post-construction Type entity.
|
|
17
22
|
*/
|
|
18
23
|
get: (schema: Schema.Schema.Any) => Option.Option<T>;
|
|
19
24
|
/**
|
|
@@ -21,7 +26,11 @@ export interface AnnotationHelper<T> {
|
|
|
21
26
|
*/
|
|
22
27
|
getFromAst: (ast: SchemaAST.AST) => Option.Option<T>;
|
|
23
28
|
/**
|
|
24
|
-
* Set the annotation
|
|
29
|
+
* Set the annotation on an Effect schema.
|
|
30
|
+
*
|
|
31
|
+
* Only accepts `Schema.Schema.Any` — annotations must be applied to the
|
|
32
|
+
* source schema BEFORE wrapping it with `Type.makeObject` / `Type.makeRelation`.
|
|
33
|
+
* In a pipe, place every `Annotation.X.set(...)` before the `Type.make...` step.
|
|
25
34
|
*/
|
|
26
35
|
set: (value: T) => <S extends Schema.Schema.Any>(schema: S) => S;
|
|
27
36
|
}
|
|
@@ -30,13 +39,14 @@ export interface AnnotationHelper<T> {
|
|
|
30
39
|
* Note: only for system annotations.
|
|
31
40
|
*/
|
|
32
41
|
// TODO(dmaretskyi): Rename to createSystemAnnotationHelper.
|
|
42
|
+
// TODO(dmaretskyi): REconcile with Annotation.make.
|
|
33
43
|
export const createAnnotationHelper = <T>(id: symbol): AnnotationHelper<T> => {
|
|
34
44
|
return {
|
|
35
45
|
get: (schema) => SchemaAST.getAnnotation(schema.ast, id),
|
|
36
46
|
getFromAst: (ast) => SchemaAST.getAnnotation(ast, id),
|
|
37
47
|
set:
|
|
38
48
|
(value) =>
|
|
39
|
-
<S extends Schema.Schema.Any>(schema: S) =>
|
|
49
|
+
<S extends Schema.Schema.Any>(schema: S): S =>
|
|
40
50
|
schema.annotations({ [id]: value }) as S,
|
|
41
51
|
};
|
|
42
52
|
};
|
|
@@ -69,13 +79,12 @@ export const makeTypeJsonSchemaAnnotation = (options: {
|
|
|
69
79
|
assertArgument(!!options.relationSource === (options.kind === EntityKind.Relation), 'relationSource');
|
|
70
80
|
assertArgument(!!options.relationTarget === (options.kind === EntityKind.Relation), 'relationTarget');
|
|
71
81
|
|
|
72
|
-
const obj = {
|
|
73
|
-
|
|
74
|
-
$id: options.identifier ?? DXN.fromTypename(options.typename).toString(),
|
|
82
|
+
const obj: Record<string, unknown> = {
|
|
83
|
+
$id: options.identifier ?? DXN.make(options.typename, options.version),
|
|
75
84
|
entityKind: options.kind,
|
|
76
85
|
version: options.version,
|
|
77
86
|
typename: options.typename,
|
|
78
|
-
}
|
|
87
|
+
};
|
|
79
88
|
if (options.kind === EntityKind.Relation) {
|
|
80
89
|
obj.relationSource = { $ref: options.relationSource };
|
|
81
90
|
obj.relationTarget = { $ref: options.relationTarget };
|
|
@@ -3,21 +3,68 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import { invariant } from '@dxos/invariant';
|
|
6
|
-
import { type
|
|
6
|
+
import { DXN, EID, URI, type SpaceId } from '@dxos/keys';
|
|
7
7
|
import { assumeType } from '@dxos/util';
|
|
8
8
|
|
|
9
9
|
import type { AnyEntity } from '../common/types';
|
|
10
|
+
import { MetaId } from '../common/types/model-symbols';
|
|
10
11
|
import { type InternalObjectProps, ObjectDatabaseId } from './model';
|
|
11
|
-
import {
|
|
12
|
+
import { getObjectEchoUri } from './util';
|
|
12
13
|
|
|
13
14
|
/**
|
|
14
|
-
*
|
|
15
|
+
* Controls the URI form returned by `getUri` and the public `*.getURI` helpers.
|
|
16
|
+
*
|
|
17
|
+
* - `'named'` — Registry key URI (`dxn:<meta.key>`) when the entity has a key in its meta;
|
|
18
|
+
* falls back to the default EID.
|
|
19
|
+
* - `'absolute'` — Fully-qualified EID with space id (`echo://<spaceId>/<entityId>`);
|
|
20
|
+
* falls back when no space is available.
|
|
21
|
+
* - `'relative'` — Local EID without space id (`echo:/<entityId>`).
|
|
22
|
+
*
|
|
23
|
+
* Omitting `prefer` preserves the existing behaviour.
|
|
24
|
+
*/
|
|
25
|
+
export type GetURIOptions = {
|
|
26
|
+
prefer?: 'named' | 'absolute' | 'relative';
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Get the URI of an entity.
|
|
15
31
|
* Accepts both reactive entities and snapshots.
|
|
16
32
|
*/
|
|
17
|
-
export const
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
33
|
+
export const getUri = (entity: AnyEntity, options?: GetURIOptions): URI.URI => {
|
|
34
|
+
const prefer = options?.prefer;
|
|
35
|
+
|
|
36
|
+
if (prefer === 'named') {
|
|
37
|
+
const key = (entity as any)[MetaId]?.key;
|
|
38
|
+
if (key) {
|
|
39
|
+
return (DXN.tryMake(`dxn:${key}`) ?? URI.make(key)) as URI.URI;
|
|
40
|
+
}
|
|
41
|
+
const uri = getObjectEchoUri(entity);
|
|
42
|
+
invariant(uri != null, 'Invalid entity.');
|
|
43
|
+
return uri;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
if (prefer === 'relative') {
|
|
47
|
+
const eid = getObjectEchoUri(entity);
|
|
48
|
+
invariant(eid != null, 'Invalid entity.');
|
|
49
|
+
const entityId = EID.getEntityId(eid);
|
|
50
|
+
return entityId ? EID.make({ entityId }) : eid;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
if (prefer === 'absolute') {
|
|
54
|
+
const eid = getObjectEchoUri(entity);
|
|
55
|
+
invariant(eid != null, 'Invalid entity.');
|
|
56
|
+
const entityId = EID.getEntityId(eid);
|
|
57
|
+
if (!entityId) {
|
|
58
|
+
return eid;
|
|
59
|
+
}
|
|
60
|
+
assumeType<InternalObjectProps>(entity);
|
|
61
|
+
const spaceId: SpaceId | undefined = entity[ObjectDatabaseId]?.spaceId ?? EID.getSpaceId(eid);
|
|
62
|
+
return spaceId ? EID.make({ spaceId, entityId }) : eid;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
const uri = getObjectEchoUri(entity);
|
|
66
|
+
invariant(uri != null, 'Invalid entity.');
|
|
67
|
+
return uri;
|
|
21
68
|
};
|
|
22
69
|
|
|
23
70
|
/**
|
|
@@ -3,47 +3,119 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import * as Schema from 'effect/Schema';
|
|
6
|
-
import
|
|
6
|
+
import * as SchemaAST from 'effect/SchemaAST';
|
|
7
7
|
import type * as Types from 'effect/Types';
|
|
8
8
|
|
|
9
|
+
import { DXN, EntityId } from '@dxos/keys';
|
|
9
10
|
import { type ToMutable } from '@dxos/util';
|
|
10
11
|
|
|
11
|
-
import { type
|
|
12
|
-
import {
|
|
12
|
+
import { type TypeAnnotation, TypeAnnotationId } from '../Annotation/annotations';
|
|
13
|
+
import { makeTypeJsonSchemaAnnotation } from '../Annotation/util';
|
|
14
|
+
import { defineHiddenProperty } from '../common/proxy/define-hidden-property';
|
|
15
|
+
import { makeObject } from '../common/proxy/make-object';
|
|
16
|
+
import { getProxyTarget } from '../common/proxy/proxy-utils';
|
|
17
|
+
import {
|
|
18
|
+
type AnyEntity,
|
|
19
|
+
EntityKind,
|
|
20
|
+
InstancePhantomId,
|
|
21
|
+
KindId,
|
|
22
|
+
SchemaKindId,
|
|
23
|
+
StaticTypeSchemaSlot,
|
|
24
|
+
} from '../common/types';
|
|
25
|
+
import { type EntityMeta } from '../common/types/meta';
|
|
26
|
+
import { JsonSchemaType } from '../JsonSchema/json-schema-type';
|
|
13
27
|
|
|
14
28
|
// TODO(burdon): Define Schema type for `typename` and use consistently for all DXN-like properties.
|
|
15
29
|
|
|
16
30
|
// type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
|
|
17
31
|
export type EchoTypeSchemaProps<T, ExtraFields = {}> = Types.Simplify<AnyEntity & ToMutable<T> & ExtraFields>;
|
|
18
32
|
|
|
33
|
+
/**
|
|
34
|
+
* Options accepted by every `Type.makeObject` / `Type.makeRelation` / type-kind
|
|
35
|
+
* factory. Defaults are derived from `(typename, version)` so callers normally
|
|
36
|
+
* pass nothing.
|
|
37
|
+
*/
|
|
38
|
+
export type EchoTypeOptions = {
|
|
39
|
+
/**
|
|
40
|
+
* Override the entity id stamped on the in-memory `Type.Type` value.
|
|
41
|
+
*
|
|
42
|
+
* Defaults to `EntityId.deterministic(typename, version)` — stable across processes
|
|
43
|
+
* and workerd-safe (no `crypto.getRandomValues()` at module-evaluation time).
|
|
44
|
+
* Pass an explicit id (typically `EntityId.random()`) to opt out of the
|
|
45
|
+
* deterministic default.
|
|
46
|
+
*/
|
|
47
|
+
id?: EntityId;
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* In-memory `Type.Type` entity shape produced by `Type.makeObject(dxn)` /
|
|
52
|
+
* `Type.makeRelation({...})`. A live reactive `TypeSchema` instance —
|
|
53
|
+
* identical to a persisted `Type.Type` except for database attachment.
|
|
54
|
+
*
|
|
55
|
+
* NOT a `Schema.Schema`. The underlying Effect Schema is cached on the hidden
|
|
56
|
+
* `StaticTypeSchemaSlot` slot — retrieve it via `Type.getSchema(...)`.
|
|
57
|
+
*/
|
|
19
58
|
// TODO(burdon): Rename EchoEntitySchema.
|
|
20
59
|
export interface EchoTypeSchema<
|
|
21
60
|
Self extends Schema.Schema.Any,
|
|
22
61
|
ExtraFields = {},
|
|
23
62
|
K extends EntityKind = EntityKind,
|
|
24
63
|
Fields extends Schema.Struct.Fields = Schema.Struct.Fields,
|
|
25
|
-
>
|
|
26
|
-
extends
|
|
27
|
-
TypeMeta,
|
|
28
|
-
Schema.AnnotableClass<
|
|
29
|
-
EchoTypeSchema<Self, ExtraFields, K, Fields>,
|
|
30
|
-
EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields>,
|
|
31
|
-
EchoTypeSchemaProps<Schema.Schema.Encoded<Self>, ExtraFields>,
|
|
32
|
-
Schema.Schema.Context<Self>
|
|
33
|
-
> {
|
|
64
|
+
> {
|
|
34
65
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
66
|
+
* Entity-kind brand. Type entities are their own kind (`Type`) regardless of
|
|
67
|
+
* the kind of instance they describe — `[SchemaKindId]` carries the latter.
|
|
68
|
+
* This lets predicates like `Obj.isObject` / `Relation.isRelation` cleanly
|
|
69
|
+
* reject type entities without also having to inspect `[SchemaKindId]`.
|
|
37
70
|
*/
|
|
71
|
+
readonly [KindId]: EntityKind.Type;
|
|
72
|
+
|
|
73
|
+
/** Schema-kind brand indicating what kind of instance this type describes. */
|
|
38
74
|
readonly [SchemaKindId]: K;
|
|
39
75
|
|
|
40
76
|
/**
|
|
41
|
-
*
|
|
42
|
-
*
|
|
77
|
+
* Entity id. Always present — stamped at construction — but NOT the type's
|
|
78
|
+
* identity while in-memory: an unattached type resolves its URI to the typename
|
|
79
|
+
* DXN, switching to `echo:/<id>` only once attached to a database (see
|
|
80
|
+
* `getTypeURIFromSpecifier`, which discriminates by database attachment).
|
|
43
81
|
*/
|
|
82
|
+
readonly id: EntityId;
|
|
83
|
+
|
|
84
|
+
/** Source Effect Schema (kept on a hidden slot for `Type.getSchema`). */
|
|
85
|
+
readonly [StaticTypeSchemaSlot]: Schema.Schema.AnyNoContext;
|
|
86
|
+
|
|
87
|
+
// NOTE: `typename` / `version` are intentionally NOT fields. They live in
|
|
88
|
+
// `EntityMeta` (`key` / `version`); read via `Type.getTypename(self)` /
|
|
89
|
+
// `Type.getVersion(self)`.
|
|
90
|
+
readonly jsonSchema: JsonSchemaType;
|
|
91
|
+
|
|
92
|
+
/** Struct fields for introspection. */
|
|
44
93
|
readonly fields: Fields;
|
|
45
94
|
|
|
46
|
-
|
|
95
|
+
/** Phantom — instance type produced by `Obj.make(self, ...)`. */
|
|
96
|
+
readonly _instance?: EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields>;
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* Phantom slot mirroring `Type<A>` so internal helpers (`makeObject`,
|
|
100
|
+
* `createObject`, `Ref.make`) infer the instance type uniformly whether
|
|
101
|
+
* the caller passes an `EchoTypeSchema` or a top-level `Type.Type` entity.
|
|
102
|
+
*
|
|
103
|
+
* Includes the instance-kind brand (`[KindId]`) so the phantom is assignable
|
|
104
|
+
* to the matching public-side interface in `Type.ts` (`Type.Obj` /
|
|
105
|
+
* `Type.Relation` / `Type.Type`). Each kind projects identity: instances of
|
|
106
|
+
* an object-kind schema are object-kind entities, type-kind schemas produce
|
|
107
|
+
* type-kind (persisted Type.Type) entities — the latter additionally carry
|
|
108
|
+
* the `[SchemaKindId]` / `[StaticTypeSchemaSlot]` brands the echo-handler
|
|
109
|
+
* proxy exposes on persisted Type entities.
|
|
110
|
+
*/
|
|
111
|
+
readonly [InstancePhantomId]?: EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields> & {
|
|
112
|
+
readonly [KindId]: K;
|
|
113
|
+
} & (K extends EntityKind.Type
|
|
114
|
+
? {
|
|
115
|
+
readonly [SchemaKindId]: EntityKind.Type;
|
|
116
|
+
readonly [StaticTypeSchemaSlot]: Schema.Schema.AnyNoContext;
|
|
117
|
+
}
|
|
118
|
+
: {});
|
|
47
119
|
}
|
|
48
120
|
|
|
49
121
|
// type MakeProps =
|
|
@@ -77,8 +149,60 @@ export interface EchoTypeSchema<
|
|
|
77
149
|
// const _getDisableValidationMakeOption = (options: MakeProps | undefined): boolean =>
|
|
78
150
|
// Predicate.isBoolean(options) ? options : options?.disableValidation ?? false;
|
|
79
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Identity (typename + version) of the type meta-schema — the `Type.Type` that
|
|
154
|
+
* every ECHO type entity is itself an instance of. Shared by the materialisation
|
|
155
|
+
* vehicle ({@link persistentEntitySchema}) and `TypeSchema` so the two cannot
|
|
156
|
+
* drift on identity.
|
|
157
|
+
*/
|
|
158
|
+
export const TypeMetaSchemaDXN = DXN.make('org.dxos.type.schema', '0.1.0');
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Effect Schema that every `Type.Type` entity is an instance of: the meta-schema
|
|
162
|
+
* struct `{ name?, jsonSchema, id }` branded as a type-kind ECHO entity. This is
|
|
163
|
+
* the materialisation vehicle for `makeObject` below — the canonical user-facing
|
|
164
|
+
* entity is `Type/type-schema.ts`'s `TypeSchema`, which carries the same shape
|
|
165
|
+
* plus UI annotations.
|
|
166
|
+
*
|
|
167
|
+
* Kept self-contained (no import of `TypeSchema`) to avoid a bootstrap cycle:
|
|
168
|
+
* `TypeSchema` is itself produced via `makeEchoTypeSchema`, so this builder must
|
|
169
|
+
* not depend on it. `jsonSchema` is declared optional here (only on the
|
|
170
|
+
* materialisation vehicle — the canonical `TypeSchema` keeps it required) so the
|
|
171
|
+
* construction-time `Schema.asserts` does not force the field before it is
|
|
172
|
+
* attached; it is populated immediately after via a lazy accessor (see
|
|
173
|
+
* `makeEchoTypeSchema`).
|
|
174
|
+
*/
|
|
175
|
+
// TODO(wittjosiah): Reconcile with `TypeSchema` (`Type/type-schema.ts`).
|
|
176
|
+
// Both describe the same `org.dxos.type.schema` shape.
|
|
177
|
+
const persistentEntitySchema: Schema.Schema.AnyNoContext = (() => {
|
|
178
|
+
const typename = DXN.getName(TypeMetaSchemaDXN);
|
|
179
|
+
const version = DXN.getVersion(TypeMetaSchemaDXN)!;
|
|
180
|
+
const struct = Schema.Struct({
|
|
181
|
+
name: Schema.optional(Schema.String),
|
|
182
|
+
jsonSchema: JsonSchemaType.pipe(Schema.optional),
|
|
183
|
+
id: EntityId,
|
|
184
|
+
});
|
|
185
|
+
const ast = SchemaAST.annotations(struct.ast, {
|
|
186
|
+
[TypeAnnotationId]: { kind: EntityKind.Type, typename, version } satisfies TypeAnnotation,
|
|
187
|
+
[SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({ kind: EntityKind.Type, typename, version }),
|
|
188
|
+
});
|
|
189
|
+
return Schema.make(ast);
|
|
190
|
+
})();
|
|
191
|
+
|
|
80
192
|
/**
|
|
81
193
|
* @internal
|
|
194
|
+
*
|
|
195
|
+
* Build an in-memory `Type.Type` entity (the value returned by `Type.makeObject`
|
|
196
|
+
* / `Type.makeRelation`). The result is a LIVE reactive `TypeSchema`
|
|
197
|
+
* instance — identical in every respect to a persisted `Type.Type` except that
|
|
198
|
+
* it is not yet attached to a database. It is mutable via `Type.update`, can be
|
|
199
|
+
* passed to `db.add(...)` (which keeps the same proxy and swaps the handler),
|
|
200
|
+
* and round-trips through `jsonSchema`.
|
|
201
|
+
*
|
|
202
|
+
* The source Effect Schema describing the user's type is cached on
|
|
203
|
+
* `[StaticTypeSchemaSlot]` so `Type.getSchema(...)` returns it without a
|
|
204
|
+
* jsonSchema round-trip; the cache is invalidated by the proxy set-trap when
|
|
205
|
+
* `jsonSchema` is mutated (see `typed-handler.ts`).
|
|
82
206
|
*/
|
|
83
207
|
export const makeEchoTypeSchema = <
|
|
84
208
|
Self extends Schema.Schema.Any,
|
|
@@ -91,38 +215,63 @@ export const makeEchoTypeSchema = <
|
|
|
91
215
|
typename: string,
|
|
92
216
|
version: string,
|
|
93
217
|
kind: K,
|
|
218
|
+
computeJsonSchema: () => JsonSchemaType,
|
|
219
|
+
explicitId?: EntityId,
|
|
94
220
|
): EchoTypeSchema<Self, {}, K, Fields> => {
|
|
95
|
-
|
|
221
|
+
// Source Effect Schema describing the user's type — cached for `Type.getSchema`.
|
|
222
|
+
const sourceSchema = Schema.make<
|
|
96
223
|
EchoTypeSchemaProps<Schema.Schema.Type<Self>>,
|
|
97
224
|
EchoTypeSchemaProps<Schema.Schema.Encoded<Self>>,
|
|
98
225
|
Schema.Schema.Context<Self>
|
|
99
|
-
>(ast)
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
226
|
+
>(ast);
|
|
227
|
+
|
|
228
|
+
// `typename` / `version` route through `EntityMeta` (`key` / `version`) — the
|
|
229
|
+
// canonical registry-provenance pair — not data fields. `keys` is empty for
|
|
230
|
+
// in-memory declarations until persisted.
|
|
231
|
+
const meta: Partial<EntityMeta> = { keys: [], key: typename, version };
|
|
232
|
+
|
|
233
|
+
// Default to a deterministic id derived from `(typename, version)` so that
|
|
234
|
+
// constructing a `Type.Type` entity never reaches `crypto.getRandomValues()`.
|
|
235
|
+
// Cloudflare workerd forbids RNG calls in global scope, and the ~hundreds of
|
|
236
|
+
// `Type.makeObject(...)` call sites across the monorepo execute at module top.
|
|
237
|
+
// `setIdOnTarget` (see `proxy/make-object.ts`) short-circuits on a pre-supplied
|
|
238
|
+
// valid id, so this also bypasses the `EntityId.random()` path inside `makeObject`.
|
|
239
|
+
// Callers can override via `Type.makeObject(dxn, { id })` when they want a fresh
|
|
240
|
+
// random id (e.g. inside a request handler where workerd does allow RNG).
|
|
241
|
+
const id = explicitId ?? EntityId.deterministic(typename, version);
|
|
242
|
+
|
|
243
|
+
// Materialise as a live reactive meta-schema instance. `jsonSchema` is attached
|
|
244
|
+
// below as a getter (not passed here as data) for two reasons; see that accessor.
|
|
245
|
+
const entity = makeObject(persistentEntitySchema, { id } as any, meta);
|
|
246
|
+
|
|
247
|
+
const target = getProxyTarget(entity)!;
|
|
248
|
+
// `jsonSchema` is always available, but computed once on first read rather than at
|
|
249
|
+
// construction: serializing the AST walks `Schema.suspend(...)` thunks, and for a
|
|
250
|
+
// self-referential type (`Schema.suspend(() => Self)`) that thunk hits `Self`'s TDZ
|
|
251
|
+
// while we're still inside its `const` initializer. A getter also lets reads return
|
|
252
|
+
// the raw object instead of a child reactive proxy.
|
|
253
|
+
let memoizedJsonSchema: JsonSchemaType | undefined;
|
|
254
|
+
Object.defineProperty(target, 'jsonSchema', {
|
|
255
|
+
configurable: true,
|
|
256
|
+
enumerable: true,
|
|
257
|
+
get() {
|
|
258
|
+
return (memoizedJsonSchema ??= computeJsonSchema());
|
|
259
|
+
},
|
|
260
|
+
set(value: JsonSchemaType) {
|
|
261
|
+
memoizedJsonSchema = value;
|
|
262
|
+
},
|
|
263
|
+
});
|
|
264
|
+
// Cache the source Effect Schema (read by `Type.getSchema` via the proxy's
|
|
265
|
+
// `[StaticTypeSchemaSlot]` get-trap; invalidated on `jsonSchema` mutation).
|
|
266
|
+
defineHiddenProperty(target, StaticTypeSchemaSlot, sourceSchema);
|
|
267
|
+
// Schema-kind brand: what kind of instance this type describes. There is no
|
|
268
|
+
// database handler to derive it for in-memory entities, so stamp it directly.
|
|
269
|
+
defineHiddenProperty(target, SchemaKindId, kind);
|
|
270
|
+
// Struct fields for introspection. A getter (not a data property) so reads return
|
|
271
|
+
// the raw fields object rather than a child reactive proxy.
|
|
272
|
+
Object.defineProperty(target, 'fields', { configurable: true, enumerable: false, get: () => fields });
|
|
273
|
+
|
|
274
|
+
return entity as unknown as EchoTypeSchema<Self, {}, K, Fields>;
|
|
128
275
|
};
|
|
276
|
+
|
|
277
|
+
export { isEntity } from './guard';
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import type * as Entity from '../../Entity';
|
|
6
|
+
import { KindId, SnapshotKindId } from '../common/types';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Returns true if the value is an ECHO entity instance (object or relation).
|
|
10
|
+
*/
|
|
11
|
+
export const isEntity = (value: unknown): value is Entity.Unknown => {
|
|
12
|
+
if (typeof value !== 'object' || value === null) {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return (value as any)[KindId] !== undefined;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Returns true if the value is an ECHO entity snapshot.
|
|
20
|
+
*/
|
|
21
|
+
export const isSnapshot = (value: unknown): value is Entity.Snapshot => {
|
|
22
|
+
if (typeof value !== 'object' || value === null) {
|
|
23
|
+
return false;
|
|
24
|
+
}
|
|
25
|
+
return (value as any)[SnapshotKindId] !== undefined;
|
|
26
|
+
};
|