@dxos/echo 0.8.4-main.66e292d → 0.8.4-main.69d29f4
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/README.md +1 -2
- package/dist/lib/browser/Annotation.mjs +33 -0
- package/dist/lib/browser/Annotation.mjs.map +7 -0
- package/dist/lib/browser/Database.mjs +18 -0
- package/dist/lib/browser/Database.mjs.map +7 -0
- package/dist/lib/browser/Entity.mjs +52 -0
- package/dist/lib/browser/Entity.mjs.map +7 -0
- package/dist/lib/browser/Err.mjs +11 -0
- package/dist/lib/browser/Err.mjs.map +7 -0
- package/dist/lib/browser/Filter.mjs +62 -0
- package/dist/lib/browser/Filter.mjs.map +7 -0
- package/dist/lib/browser/Format.mjs +67 -0
- package/dist/lib/browser/Format.mjs.map +7 -0
- package/dist/lib/browser/JsonSchema.mjs +20 -0
- package/dist/lib/browser/JsonSchema.mjs.map +7 -0
- package/dist/lib/browser/Key.mjs +13 -0
- package/dist/lib/browser/Key.mjs.map +7 -0
- package/dist/lib/browser/Obj.mjs +91 -0
- package/dist/lib/browser/Obj.mjs.map +7 -0
- package/dist/lib/browser/Order.mjs +13 -0
- package/dist/lib/browser/Order.mjs.map +7 -0
- package/dist/lib/browser/Query.mjs +27 -0
- package/dist/lib/browser/Query.mjs.map +7 -0
- package/dist/lib/browser/QueryResult.mjs +3 -0
- package/dist/lib/browser/QueryResult.mjs.map +7 -0
- package/dist/lib/browser/Ref.mjs +23 -0
- package/dist/lib/browser/Ref.mjs.map +7 -0
- package/dist/lib/browser/Relation.mjs +85 -0
- package/dist/lib/browser/Relation.mjs.map +7 -0
- package/dist/lib/browser/SchemaRegistry.mjs +3 -0
- package/dist/lib/browser/SchemaRegistry.mjs.map +7 -0
- package/dist/lib/browser/Tag.mjs +26 -0
- package/dist/lib/browser/Tag.mjs.map +7 -0
- package/dist/lib/browser/Type.mjs +48 -0
- package/dist/lib/browser/Type.mjs.map +7 -0
- package/dist/lib/browser/chunk-2RMVRVOB.mjs +250 -0
- package/dist/lib/browser/chunk-2RMVRVOB.mjs.map +7 -0
- package/dist/lib/browser/chunk-5RDNDPMX.mjs +74 -0
- package/dist/lib/browser/chunk-5RDNDPMX.mjs.map +7 -0
- package/dist/lib/browser/chunk-73M2G455.mjs +98 -0
- package/dist/lib/browser/chunk-73M2G455.mjs.map +7 -0
- package/dist/lib/browser/chunk-7STIBCP7.mjs +133 -0
- package/dist/lib/browser/chunk-7STIBCP7.mjs.map +7 -0
- package/dist/lib/browser/chunk-AFGYYVVQ.mjs +57 -0
- package/dist/lib/browser/chunk-AFGYYVVQ.mjs.map +7 -0
- package/dist/lib/browser/chunk-BC6R4CAF.mjs +24 -0
- package/dist/lib/browser/chunk-BC6R4CAF.mjs.map +7 -0
- package/dist/lib/browser/chunk-BPYFLHWO.mjs +158 -0
- package/dist/lib/browser/chunk-BPYFLHWO.mjs.map +7 -0
- package/dist/lib/browser/chunk-CBPFF3ZO.mjs +204 -0
- package/dist/lib/browser/chunk-CBPFF3ZO.mjs.map +7 -0
- package/dist/lib/browser/chunk-CGS2ULMK.mjs +11 -0
- package/dist/lib/browser/chunk-CGS2ULMK.mjs.map +7 -0
- package/dist/lib/browser/chunk-CJ5YELTO.mjs +39 -0
- package/dist/lib/browser/chunk-CJ5YELTO.mjs.map +7 -0
- package/dist/lib/browser/chunk-FPOISFQK.mjs +40 -0
- package/dist/lib/browser/chunk-FPOISFQK.mjs.map +7 -0
- package/dist/lib/browser/chunk-INHXFXY5.mjs +22 -0
- package/dist/lib/browser/chunk-INHXFXY5.mjs.map +7 -0
- package/dist/lib/browser/chunk-IXVWLTG7.mjs +9 -0
- package/dist/lib/browser/chunk-IXVWLTG7.mjs.map +7 -0
- package/dist/lib/browser/chunk-JMKVF2YQ.mjs +43 -0
- package/dist/lib/browser/chunk-JMKVF2YQ.mjs.map +7 -0
- package/dist/lib/browser/chunk-L4RXUJHJ.mjs +143 -0
- package/dist/lib/browser/chunk-L4RXUJHJ.mjs.map +7 -0
- package/dist/lib/browser/chunk-MYCCGG2T.mjs +15 -0
- package/dist/lib/browser/chunk-MYCCGG2T.mjs.map +7 -0
- package/dist/lib/browser/{chunk-7GH6RXJ3.mjs → chunk-PAM4KEXE.mjs} +2005 -1841
- package/dist/lib/browser/chunk-PAM4KEXE.mjs.map +7 -0
- package/dist/lib/browser/chunk-QIWDIPLR.mjs +41 -0
- package/dist/lib/browser/chunk-QIWDIPLR.mjs.map +7 -0
- package/dist/lib/browser/chunk-R3S54KRI.mjs +403 -0
- package/dist/lib/browser/chunk-R3S54KRI.mjs.map +7 -0
- package/dist/lib/browser/chunk-RK4Z4JUZ.mjs +283 -0
- package/dist/lib/browser/chunk-RK4Z4JUZ.mjs.map +7 -0
- package/dist/lib/browser/chunk-TPIL3G6Y.mjs +288 -0
- package/dist/lib/browser/chunk-TPIL3G6Y.mjs.map +7 -0
- package/dist/lib/browser/chunk-YKTSSMDS.mjs +69 -0
- package/dist/lib/browser/chunk-YKTSSMDS.mjs.map +7 -0
- package/dist/lib/browser/chunk-ZHXZGIXD.mjs +9 -0
- package/dist/lib/browser/chunk-ZHXZGIXD.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +65 -25
- package/dist/lib/browser/internal/index.mjs +213 -92
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +80 -41
- package/dist/lib/browser/testing/index.mjs.map +3 -3
- package/dist/lib/node-esm/Annotation.mjs +33 -0
- package/dist/lib/node-esm/Annotation.mjs.map +7 -0
- package/dist/lib/node-esm/Database.mjs +18 -0
- package/dist/lib/node-esm/Database.mjs.map +7 -0
- package/dist/lib/node-esm/Entity.mjs +52 -0
- package/dist/lib/node-esm/Entity.mjs.map +7 -0
- package/dist/lib/node-esm/Err.mjs +11 -0
- package/dist/lib/node-esm/Err.mjs.map +7 -0
- package/dist/lib/node-esm/Filter.mjs +62 -0
- package/dist/lib/node-esm/Filter.mjs.map +7 -0
- package/dist/lib/node-esm/Format.mjs +67 -0
- package/dist/lib/node-esm/Format.mjs.map +7 -0
- package/dist/lib/node-esm/JsonSchema.mjs +20 -0
- package/dist/lib/node-esm/JsonSchema.mjs.map +7 -0
- package/dist/lib/node-esm/Key.mjs +13 -0
- package/dist/lib/node-esm/Key.mjs.map +7 -0
- package/dist/lib/node-esm/Obj.mjs +91 -0
- package/dist/lib/node-esm/Obj.mjs.map +7 -0
- package/dist/lib/node-esm/Order.mjs +13 -0
- package/dist/lib/node-esm/Order.mjs.map +7 -0
- package/dist/lib/node-esm/Query.mjs +27 -0
- package/dist/lib/node-esm/Query.mjs.map +7 -0
- package/dist/lib/node-esm/QueryResult.mjs +3 -0
- package/dist/lib/node-esm/QueryResult.mjs.map +7 -0
- package/dist/lib/node-esm/Ref.mjs +23 -0
- package/dist/lib/node-esm/Ref.mjs.map +7 -0
- package/dist/lib/node-esm/Relation.mjs +85 -0
- package/dist/lib/node-esm/Relation.mjs.map +7 -0
- package/dist/lib/node-esm/SchemaRegistry.mjs +3 -0
- package/dist/lib/node-esm/SchemaRegistry.mjs.map +7 -0
- package/dist/lib/node-esm/Tag.mjs +26 -0
- package/dist/lib/node-esm/Tag.mjs.map +7 -0
- package/dist/lib/node-esm/Type.mjs +48 -0
- package/dist/lib/node-esm/Type.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-2RIFBW3A.mjs +250 -0
- package/dist/lib/node-esm/chunk-2RIFBW3A.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-5CB2ZW74.mjs +57 -0
- package/dist/lib/node-esm/chunk-5CB2ZW74.mjs.map +7 -0
- package/dist/lib/node-esm/{chunk-M4B6BMD2.mjs → chunk-5U5F4AWK.mjs} +2005 -1841
- package/dist/lib/node-esm/chunk-5U5F4AWK.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-AJEMYSIR.mjs +22 -0
- package/dist/lib/node-esm/chunk-AJEMYSIR.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-BKYE5IW6.mjs +158 -0
- package/dist/lib/node-esm/chunk-BKYE5IW6.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-BYOD7EVP.mjs +98 -0
- package/dist/lib/node-esm/chunk-BYOD7EVP.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-FWTSPIFF.mjs +133 -0
- package/dist/lib/node-esm/chunk-FWTSPIFF.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-K37NA7PO.mjs +43 -0
- package/dist/lib/node-esm/chunk-K37NA7PO.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-LIXUCQJM.mjs +41 -0
- package/dist/lib/node-esm/chunk-LIXUCQJM.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-MOLNWFNL.mjs +9 -0
- package/dist/lib/node-esm/chunk-MOLNWFNL.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-MOWUEW5P.mjs +15 -0
- package/dist/lib/node-esm/chunk-MOWUEW5P.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-NBWL7UCZ.mjs +40 -0
- package/dist/lib/node-esm/chunk-NBWL7UCZ.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-OZEDKT4R.mjs +204 -0
- package/dist/lib/node-esm/chunk-OZEDKT4R.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-PW3VCWL5.mjs +24 -0
- package/dist/lib/node-esm/chunk-PW3VCWL5.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-TSTKBFST.mjs +403 -0
- package/dist/lib/node-esm/chunk-TSTKBFST.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-UKGVOINP.mjs +9 -0
- package/dist/lib/node-esm/chunk-UKGVOINP.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-UV63HEHQ.mjs +143 -0
- package/dist/lib/node-esm/chunk-UV63HEHQ.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-WXLVPCRJ.mjs +288 -0
- package/dist/lib/node-esm/chunk-WXLVPCRJ.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-WZ6YBELW.mjs +74 -0
- package/dist/lib/node-esm/chunk-WZ6YBELW.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-XHJRMQZD.mjs +69 -0
- package/dist/lib/node-esm/chunk-XHJRMQZD.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-YOLH5KS4.mjs +283 -0
- package/dist/lib/node-esm/chunk-YOLH5KS4.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-YQ2NWGL5.mjs +39 -0
- package/dist/lib/node-esm/chunk-YQ2NWGL5.mjs.map +7 -0
- package/dist/lib/node-esm/index.mjs +65 -25
- package/dist/lib/node-esm/internal/index.mjs +213 -92
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +80 -41
- package/dist/lib/node-esm/testing/index.mjs.map +3 -3
- package/dist/types/src/Annotation.d.ts +1 -1
- package/dist/types/src/Annotation.d.ts.map +1 -1
- package/dist/types/src/Database.d.ts +117 -60
- package/dist/types/src/Database.d.ts.map +1 -1
- package/dist/types/src/Entity.d.ts +111 -5
- package/dist/types/src/Entity.d.ts.map +1 -1
- package/dist/types/src/Entity.test.d.ts +2 -0
- package/dist/types/src/Entity.test.d.ts.map +1 -0
- package/dist/types/src/{errors.d.ts → Err.d.ts} +13 -17
- package/dist/types/src/Err.d.ts.map +1 -0
- package/dist/types/src/Filter.d.ts +120 -0
- package/dist/types/src/Filter.d.ts.map +1 -0
- package/dist/types/src/Format.d.ts.map +1 -1
- package/dist/types/src/Hypergraph.d.ts +60 -0
- package/dist/types/src/Hypergraph.d.ts.map +1 -0
- package/dist/types/src/Obj.d.ts +268 -76
- package/dist/types/src/Obj.d.ts.map +1 -1
- package/dist/types/src/Obj.test.d.ts +2 -0
- package/dist/types/src/Obj.test.d.ts.map +1 -0
- package/dist/types/src/Order.d.ts +16 -0
- package/dist/types/src/Order.d.ts.map +1 -0
- package/dist/types/src/{query/query.d.ts → Query.d.ts} +53 -50
- package/dist/types/src/Query.d.ts.map +1 -0
- package/dist/types/src/Query.test.d.ts +2 -0
- package/dist/types/src/Query.test.d.ts.map +1 -0
- package/dist/types/src/QueryResult.d.ts +80 -0
- package/dist/types/src/QueryResult.d.ts.map +1 -0
- package/dist/types/src/Ref.d.ts +9 -7
- package/dist/types/src/Ref.d.ts.map +1 -1
- package/dist/types/src/Relation.d.ts +235 -18
- package/dist/types/src/Relation.d.ts.map +1 -1
- package/dist/types/src/Relation.test.d.ts +2 -0
- package/dist/types/src/Relation.test.d.ts.map +1 -0
- package/dist/types/src/SchemaRegistry.d.ts +84 -0
- package/dist/types/src/SchemaRegistry.d.ts.map +1 -0
- package/dist/types/src/Tag.d.ts +6 -6
- package/dist/types/src/Tag.d.ts.map +1 -1
- package/dist/types/src/Type.d.ts +213 -50
- package/dist/types/src/Type.d.ts.map +1 -1
- package/dist/types/src/Type.test.d.ts +2 -0
- package/dist/types/src/Type.test.d.ts.map +1 -0
- package/dist/types/src/index.d.ts +8 -2
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/internal/annotations/annotations.d.ts +23 -27
- package/dist/types/src/internal/annotations/annotations.d.ts.map +1 -1
- package/dist/types/src/internal/annotations/util.d.ts +1 -0
- package/dist/types/src/internal/annotations/util.d.ts.map +1 -1
- package/dist/types/src/internal/api/annotations.d.ts +23 -0
- package/dist/types/src/internal/api/annotations.d.ts.map +1 -0
- package/dist/types/src/internal/api/entity.d.ts +13 -0
- package/dist/types/src/internal/api/entity.d.ts.map +1 -0
- package/dist/types/src/internal/api/index.d.ts +15 -0
- package/dist/types/src/internal/api/index.d.ts.map +1 -0
- package/dist/types/src/internal/api/meta.d.ts +42 -0
- package/dist/types/src/internal/api/meta.d.ts.map +1 -0
- package/dist/types/src/internal/api/sorting.d.ts +24 -0
- package/dist/types/src/internal/api/sorting.d.ts.map +1 -0
- package/dist/types/src/internal/api/version.d.ts +42 -0
- package/dist/types/src/internal/api/version.d.ts.map +1 -0
- package/dist/types/src/internal/entities/entity.d.ts +13 -3
- package/dist/types/src/internal/entities/entity.d.ts.map +1 -1
- package/dist/types/src/internal/entities/index.d.ts +1 -1
- package/dist/types/src/internal/entities/index.d.ts.map +1 -1
- package/dist/types/src/internal/entities/model.d.ts +14 -7
- package/dist/types/src/internal/entities/model.d.ts.map +1 -1
- package/dist/types/src/internal/entities/object.d.ts +8 -1
- package/dist/types/src/internal/entities/object.d.ts.map +1 -1
- package/dist/types/src/internal/entities/relation.d.ts +8 -1
- package/dist/types/src/internal/entities/relation.d.ts.map +1 -1
- package/dist/types/src/internal/formats/format.d.ts +4 -4
- package/dist/types/src/internal/formats/format.d.ts.map +1 -1
- package/dist/types/src/internal/formats/select.d.ts +6 -4
- package/dist/types/src/internal/formats/select.d.ts.map +1 -1
- package/dist/types/src/internal/formats/string.d.ts +4 -0
- package/dist/types/src/internal/formats/string.d.ts.map +1 -1
- package/dist/types/src/internal/formats/types.d.ts +6 -2
- package/dist/types/src/internal/formats/types.d.ts.map +1 -1
- package/dist/types/src/internal/index.d.ts +2 -1
- package/dist/types/src/internal/index.d.ts.map +1 -1
- package/dist/types/src/internal/json-schema/json-schema-normalize.d.ts.map +1 -1
- package/dist/types/src/internal/json-schema/json-schema-type.d.ts +130 -29
- package/dist/types/src/internal/json-schema/json-schema-type.d.ts.map +1 -1
- package/dist/types/src/internal/json-schema/json-schema.d.ts +2 -1
- package/dist/types/src/internal/json-schema/json-schema.d.ts.map +1 -1
- package/dist/types/src/internal/object/clone.d.ts +8 -0
- package/dist/types/src/internal/object/clone.d.ts.map +1 -0
- package/dist/types/src/internal/object/create-object.d.ts +1 -1
- package/dist/types/src/internal/object/index.d.ts +3 -0
- package/dist/types/src/internal/object/index.d.ts.map +1 -1
- package/dist/types/src/internal/object/json-serializer.d.ts +13 -7
- package/dist/types/src/internal/object/json-serializer.d.ts.map +1 -1
- package/dist/types/src/internal/object/schema-validator.d.ts +1 -14
- package/dist/types/src/internal/object/schema-validator.d.ts.map +1 -1
- package/dist/types/src/internal/object/set-value.d.ts +7 -0
- package/dist/types/src/internal/object/set-value.d.ts.map +1 -0
- package/dist/types/src/internal/object/set-value.test.d.ts +2 -0
- package/dist/types/src/internal/object/set-value.test.d.ts.map +1 -0
- package/dist/types/src/internal/object/snapshot.d.ts +6 -0
- package/dist/types/src/internal/object/snapshot.d.ts.map +1 -0
- package/dist/types/src/internal/object/typed-object.d.ts +7 -13
- package/dist/types/src/internal/object/typed-object.d.ts.map +1 -1
- package/dist/types/src/internal/proxy/change-context.d.ts +55 -0
- package/dist/types/src/internal/proxy/change-context.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/change.test.d.ts +2 -0
- package/dist/types/src/internal/proxy/change.test.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/define-hidden-property.d.ts +5 -0
- package/dist/types/src/internal/proxy/define-hidden-property.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/errors.d.ts +19 -0
- package/dist/types/src/internal/proxy/errors.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/event-batch.d.ts +10 -0
- package/dist/types/src/internal/proxy/event-batch.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/index.d.ts +11 -0
- package/dist/types/src/internal/proxy/index.d.ts.map +1 -1
- package/dist/types/src/internal/proxy/json-serializer.d.ts +6 -0
- package/dist/types/src/internal/proxy/json-serializer.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/make-object.d.ts +2 -4
- package/dist/types/src/internal/proxy/make-object.d.ts.map +1 -1
- package/dist/types/src/internal/proxy/ownership.d.ts +57 -0
- package/dist/types/src/internal/proxy/ownership.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/proxy-types.d.ts +18 -0
- package/dist/types/src/internal/proxy/proxy-types.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/proxy-utils.d.ts +47 -0
- package/dist/types/src/internal/proxy/proxy-utils.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/reactive-array.d.ts +8 -0
- package/dist/types/src/internal/proxy/reactive-array.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/reactive.d.ts +39 -0
- package/dist/types/src/internal/proxy/reactive.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/schema-validator.d.ts +15 -0
- package/dist/types/src/internal/proxy/schema-validator.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/symbols.d.ts +3 -0
- package/dist/types/src/internal/proxy/symbols.d.ts.map +1 -0
- package/dist/types/src/internal/proxy/typed-handler.d.ts +14 -11
- package/dist/types/src/internal/proxy/typed-handler.d.ts.map +1 -1
- package/dist/types/src/internal/ref/ref-array.d.ts +4 -4
- package/dist/types/src/internal/ref/ref-array.d.ts.map +1 -1
- package/dist/types/src/internal/ref/ref.d.ts +16 -7
- package/dist/types/src/internal/ref/ref.d.ts.map +1 -1
- package/dist/types/src/internal/schema/compose.d.ts +2 -1
- package/dist/types/src/internal/schema/compose.d.ts.map +1 -1
- package/dist/types/src/internal/schema/echo-schema.d.ts +15 -3
- package/dist/types/src/internal/schema/echo-schema.d.ts.map +1 -1
- package/dist/types/src/internal/schema/index.d.ts +0 -2
- package/dist/types/src/internal/schema/index.d.ts.map +1 -1
- package/dist/types/src/internal/schema/persistent-schema.d.ts +9 -7
- package/dist/types/src/internal/schema/persistent-schema.d.ts.map +1 -1
- package/dist/types/src/internal/types/base.d.ts +5 -16
- package/dist/types/src/internal/types/base.d.ts.map +1 -1
- package/dist/types/src/internal/types/entity.d.ts +27 -2
- package/dist/types/src/internal/types/entity.d.ts.map +1 -1
- package/dist/types/src/internal/types/meta.d.ts +6 -14
- package/dist/types/src/internal/types/meta.d.ts.map +1 -1
- package/dist/types/src/testing/test-schema.d.ts +141 -175
- package/dist/types/src/testing/test-schema.d.ts.map +1 -1
- package/dist/types/src/testing/util.d.ts +6 -1
- package/dist/types/src/testing/util.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +130 -23
- package/src/Annotation.ts +5 -4
- package/src/Database.ts +229 -82
- package/src/Entity.test.ts +22 -0
- package/src/Entity.ts +173 -7
- package/src/{errors.ts → Err.ts} +2 -2
- package/src/Filter.ts +376 -0
- package/src/Format.ts +0 -2
- package/src/Hypergraph.ts +74 -0
- package/src/Obj.test.ts +386 -0
- package/src/Obj.ts +338 -250
- package/src/{query/order.ts → Order.ts} +19 -9
- package/src/{query/query.test.ts → Query.test.ts} +180 -49
- package/src/{query/query.ts → Query.ts} +115 -122
- package/src/QueryResult.ts +106 -0
- package/src/Ref.ts +20 -3
- package/src/Relation.test.ts +82 -0
- package/src/Relation.ts +364 -27
- package/src/SchemaRegistry.ts +105 -0
- package/src/Tag.ts +1 -1
- package/src/Type.test.ts +52 -0
- package/src/Type.ts +322 -88
- package/src/index.ts +9 -5
- package/src/internal/README.md +36 -17
- package/src/internal/annotations/annotations.test.ts +6 -6
- package/src/internal/annotations/annotations.ts +73 -76
- package/src/internal/annotations/util.ts +2 -0
- package/src/internal/api/annotations.ts +60 -0
- package/src/internal/api/entity.ts +29 -0
- package/src/internal/api/index.ts +19 -0
- package/src/internal/api/meta.ts +88 -0
- package/src/internal/api/sorting.ts +53 -0
- package/src/internal/api/version.ts +96 -0
- package/src/internal/entities/entity.ts +36 -19
- package/src/internal/entities/index.ts +1 -1
- package/src/internal/entities/model.ts +17 -12
- package/src/internal/entities/object.ts +21 -8
- package/src/internal/entities/relation.ts +23 -7
- package/src/internal/formats/format.test.ts +1 -1
- package/src/internal/formats/format.ts +7 -8
- package/src/internal/formats/object.ts +2 -2
- package/src/internal/formats/select.ts +6 -4
- package/src/internal/formats/string.ts +5 -0
- package/src/internal/formats/types.ts +9 -3
- package/src/internal/index.ts +2 -1
- package/src/internal/json-schema/json-schema-normalize.ts +4 -2
- package/src/internal/json-schema/json-schema-type.ts +31 -32
- package/src/internal/json-schema/json-schema.test.ts +19 -17
- package/src/internal/json-schema/json-schema.ts +14 -10
- package/src/internal/object/clone.ts +48 -0
- package/src/internal/object/create-object.ts +2 -2
- package/src/internal/object/index.ts +3 -0
- package/src/internal/object/inspect.ts +3 -3
- package/src/internal/object/json-serializer.test.ts +6 -2
- package/src/internal/object/json-serializer.ts +28 -70
- package/src/internal/object/schema-validator.test.ts +3 -7
- package/src/internal/object/schema-validator.ts +2 -238
- package/src/internal/object/set-value.test.ts +281 -0
- package/src/internal/object/set-value.ts +165 -0
- package/src/internal/object/snapshot.ts +70 -0
- package/src/internal/object/typed-object.test.ts +11 -11
- package/src/internal/object/typed-object.ts +8 -72
- package/src/internal/proxy/change-context.ts +138 -0
- package/src/internal/proxy/change.test.ts +519 -0
- package/src/internal/proxy/define-hidden-property.ts +14 -0
- package/src/internal/proxy/errors.ts +42 -0
- package/src/internal/proxy/event-batch.ts +44 -0
- package/src/internal/proxy/handler.test.ts +30 -80
- package/src/internal/proxy/index.ts +11 -0
- package/src/internal/proxy/json-serializer.ts +87 -0
- package/src/internal/proxy/make-object.ts +33 -50
- package/src/internal/proxy/ownership.ts +253 -0
- package/src/internal/proxy/proxy-types.ts +23 -0
- package/src/internal/proxy/proxy-utils.ts +150 -0
- package/src/internal/proxy/reactive-array.ts +71 -0
- package/src/internal/proxy/reactive.ts +69 -0
- package/src/internal/proxy/schema-validator.ts +244 -0
- package/src/internal/proxy/schema.test.ts +23 -15
- package/src/internal/proxy/symbols.ts +7 -0
- package/src/internal/proxy/typed-handler.test.ts +247 -35
- package/src/internal/proxy/typed-handler.ts +265 -56
- package/src/internal/proxy/typed-object.test.ts +37 -26
- package/src/internal/ref/ref-array.ts +4 -4
- package/src/internal/ref/ref.test.ts +1 -1
- package/src/internal/ref/ref.ts +64 -40
- package/src/internal/schema/compose.test.ts +3 -3
- package/src/internal/schema/compose.ts +13 -9
- package/src/internal/schema/echo-schema.ts +49 -11
- package/src/internal/schema/index.ts +0 -2
- package/src/internal/schema/persistent-schema.ts +3 -4
- package/src/internal/types/base.ts +6 -21
- package/src/internal/types/entity.ts +35 -4
- package/src/internal/types/meta.ts +13 -24
- package/src/testing/api.test.ts +31 -5
- package/src/testing/test-schema.ts +55 -30
- package/src/testing/util.ts +22 -15
- package/dist/lib/browser/chunk-7GH6RXJ3.mjs.map +0 -7
- package/dist/lib/browser/chunk-E4UTVJNF.mjs +0 -1111
- package/dist/lib/browser/chunk-E4UTVJNF.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-JE5RXM2I.mjs +0 -1111
- package/dist/lib/node-esm/chunk-JE5RXM2I.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-M4B6BMD2.mjs.map +0 -7
- package/dist/types/src/errors.d.ts.map +0 -1
- package/dist/types/src/internal/entities/expando.d.ts +0 -16
- package/dist/types/src/internal/entities/expando.d.ts.map +0 -1
- package/dist/types/src/internal/schema/runtime-schema-registry.d.ts +0 -18
- package/dist/types/src/internal/schema/runtime-schema-registry.d.ts.map +0 -1
- package/dist/types/src/internal/schema/snapshot.d.ts +0 -6
- package/dist/types/src/internal/schema/snapshot.d.ts.map +0 -1
- package/dist/types/src/query/filter.d.ts +0 -167
- package/dist/types/src/query/filter.d.ts.map +0 -1
- package/dist/types/src/query/index.d.ts +0 -5
- package/dist/types/src/query/index.d.ts.map +0 -1
- package/dist/types/src/query/order.d.ts +0 -12
- package/dist/types/src/query/order.d.ts.map +0 -1
- package/dist/types/src/query/query.d.ts.map +0 -1
- package/dist/types/src/query/query.test.d.ts +0 -2
- package/dist/types/src/query/query.test.d.ts.map +0 -1
- package/dist/types/src/query/testing.d.ts +0 -51
- package/dist/types/src/query/testing.d.ts.map +0 -1
- package/dist/types/src/query/types.d.ts +0 -17
- package/dist/types/src/query/types.d.ts.map +0 -1
- package/dist/types/src/query/util.d.ts +0 -8
- package/dist/types/src/query/util.d.ts.map +0 -1
- package/src/internal/entities/expando.ts +0 -23
- package/src/internal/schema/runtime-schema-registry.ts +0 -78
- package/src/internal/schema/snapshot.ts +0 -25
- package/src/query/filter.ts +0 -455
- package/src/query/index.ts +0 -9
- package/src/query/testing.ts +0 -64
- package/src/query/types.ts +0 -23
- package/src/query/util.ts +0 -25
package/dist/types/src/Obj.d.ts
CHANGED
|
@@ -1,44 +1,70 @@
|
|
|
1
1
|
import * as Schema from 'effect/Schema';
|
|
2
|
-
import {
|
|
2
|
+
import type { ForeignKey } from '@dxos/echo-protocol';
|
|
3
3
|
import { type DXN, ObjectId } from '@dxos/keys';
|
|
4
|
+
import type * as Database from './Database';
|
|
4
5
|
import * as Entity from './Entity';
|
|
5
|
-
import { type
|
|
6
|
-
import * as Ref from './Ref';
|
|
7
|
-
import * as Type from './Type';
|
|
6
|
+
import { type ObjectJSON as APIJSON, type AnyEntity, type AnyProperties, type Comparator as ApiComparator, type Meta as ApiMeta, type ReadonlyMeta as ApiReadonlyMeta, type EntityVersion as ApiVersion, type ChangeCallback, type KindId, type Mutable, type ObjectMeta, type SnapshotKindId, type VersionCompareResult, VersionTypeId, compareVersions, decodeVersion, encodeVersion, isVersion, versionValid } from './internal';
|
|
7
|
+
import type * as Ref from './Ref';
|
|
8
|
+
import type * as Type from './Type';
|
|
8
9
|
/**
|
|
9
10
|
* Base type for all ECHO objects.
|
|
10
|
-
* @private
|
|
11
11
|
*/
|
|
12
|
-
interface BaseObj extends
|
|
12
|
+
interface BaseObj extends AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {
|
|
13
13
|
}
|
|
14
|
-
/**
|
|
15
|
-
* Base type for all Obj objects.
|
|
16
|
-
*/
|
|
17
|
-
export interface Any extends BaseObj {
|
|
18
|
-
}
|
|
19
|
-
export declare const Any: Type.obj<Schema.Struct<{}>>;
|
|
20
14
|
/**
|
|
21
15
|
* Object type with specific properties.
|
|
22
16
|
*/
|
|
23
17
|
export type Obj<Props> = BaseObj & Props;
|
|
18
|
+
/**
|
|
19
|
+
* Object with no known properties beyond id and kind.
|
|
20
|
+
* Use this when the object's schema/properties are not known.
|
|
21
|
+
* For objects with arbitrary properties, use `Obj.AnyProps`.
|
|
22
|
+
*
|
|
23
|
+
* NOTE: This is a TypeScript type only, not a schema.
|
|
24
|
+
* To validate that a value is an ECHO object, use `Schema.is(Type.Obj)`.
|
|
25
|
+
*/
|
|
26
|
+
export interface Unknown extends BaseObj {
|
|
27
|
+
}
|
|
24
28
|
/**
|
|
25
29
|
* Object with arbitrary properties.
|
|
26
30
|
*
|
|
27
|
-
* NOTE: Due to how
|
|
31
|
+
* NOTE: Due to how TypeScript works, this type is not assignable to a specific schema type.
|
|
28
32
|
* In that case, use `Obj.instanceOf` to check if an object is of a specific type.
|
|
33
|
+
*
|
|
34
|
+
* Prefer using `Obj.Unknown` when you don't need to access arbitrary properties.
|
|
35
|
+
*/
|
|
36
|
+
export interface Any extends BaseObj, AnyProperties {
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Base type for snapshot objects (has SnapshotKindId instead of KindId).
|
|
29
40
|
*/
|
|
30
|
-
|
|
41
|
+
interface BaseSnapshot extends AnyEntity {
|
|
42
|
+
readonly [SnapshotKindId]: typeof Entity.Kind.Object;
|
|
43
|
+
readonly id: ObjectId;
|
|
31
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* Immutable snapshot of an ECHO object.
|
|
47
|
+
* Branded with SnapshotKindId (not KindId).
|
|
48
|
+
* Property values are frozen at the time the snapshot was created.
|
|
49
|
+
* Returned by getSnapshot() and hooks like useObject().
|
|
50
|
+
*
|
|
51
|
+
* Snapshots are structurally identical to reactive objects but have a different brand,
|
|
52
|
+
* making them distinguishable at the TypeScript level. Neither is assignable to the other.
|
|
53
|
+
*/
|
|
54
|
+
export type Snapshot<T extends Unknown = Unknown> = Omit<T, KindId> & BaseSnapshot;
|
|
32
55
|
type Props<T = any> = {
|
|
33
56
|
id?: ObjectId;
|
|
34
57
|
[Meta]?: Partial<ObjectMeta>;
|
|
35
58
|
} & Type.Properties<T>;
|
|
36
|
-
|
|
59
|
+
/**
|
|
60
|
+
* Props type for object creation with a given schema.
|
|
61
|
+
*/
|
|
62
|
+
export type MakeProps<S extends Schema.Schema.AnyNoContext> = {
|
|
37
63
|
id?: ObjectId;
|
|
38
64
|
[Meta]?: Partial<ObjectMeta>;
|
|
39
|
-
} & NoInfer<Props<Schema.Schema.Type<
|
|
65
|
+
} & NoInfer<Props<Schema.Schema.Type<S>>>;
|
|
40
66
|
/**
|
|
41
|
-
* Creates a new object of the given
|
|
67
|
+
* Creates a new echo object of the given schema.
|
|
42
68
|
* @param schema - Object schema.
|
|
43
69
|
* @param props - Object properties.
|
|
44
70
|
* @param meta - Object metadata (deprecated) -- pass with Obj.Meta.
|
|
@@ -49,29 +75,136 @@ export type MakeProps<T extends Schema.Schema.AnyNoContext> = {
|
|
|
49
75
|
* ```ts
|
|
50
76
|
* const obj = Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' });
|
|
51
77
|
* ```
|
|
78
|
+
*
|
|
79
|
+
* Note: Only accepts object schemas, not relation schemas. Use `Relation.make` for relations.
|
|
52
80
|
*/
|
|
53
|
-
export declare const make:
|
|
81
|
+
export declare const make: {
|
|
82
|
+
<S extends Type.Obj.Any>(schema: S, props: MakeProps<S>): Obj<Schema.Schema.Type<S>>;
|
|
83
|
+
/**
|
|
84
|
+
* @deprecated Pass meta as in the example: `Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' })`.
|
|
85
|
+
*/
|
|
86
|
+
<S extends Type.Obj.Any>(schema: S, props: MakeProps<S>, meta: Partial<ObjectMeta>): Obj<Schema.Schema.Type<S>>;
|
|
87
|
+
};
|
|
54
88
|
/**
|
|
55
89
|
* Determine if object is an ECHO object.
|
|
56
90
|
*/
|
|
57
|
-
export declare const isObject: (obj: unknown) => obj is
|
|
91
|
+
export declare const isObject: (obj: unknown) => obj is Unknown;
|
|
92
|
+
/**
|
|
93
|
+
* Subscribe to object updates.
|
|
94
|
+
* The callback is called synchronously when the object is modified.
|
|
95
|
+
* Only accepts reactive objects (not snapshots).
|
|
96
|
+
* @returns Unsubscribe function.
|
|
97
|
+
*/
|
|
98
|
+
export declare const subscribe: (obj: Unknown, callback: () => void) => (() => void);
|
|
58
99
|
/**
|
|
59
100
|
* Returns an immutable snapshot of an object.
|
|
101
|
+
* The snapshot is branded with SnapshotKindId instead of KindId,
|
|
102
|
+
* making it distinguishable from the reactive object at the type level.
|
|
60
103
|
*/
|
|
61
|
-
export declare const getSnapshot: <T extends
|
|
104
|
+
export declare const getSnapshot: <T extends Unknown>(obj: T) => Snapshot<T>;
|
|
62
105
|
export type CloneOptions = {
|
|
63
106
|
/**
|
|
64
107
|
* Retain the original object's ID.
|
|
65
108
|
* @default false
|
|
66
109
|
*/
|
|
67
110
|
retainId?: boolean;
|
|
111
|
+
/**
|
|
112
|
+
* Recursively clone referenced objects.
|
|
113
|
+
* @default false
|
|
114
|
+
*/
|
|
115
|
+
deep?: boolean;
|
|
68
116
|
};
|
|
69
117
|
/**
|
|
70
118
|
* Clones an object or relation.
|
|
71
119
|
* This does not clone referenced objects, only the properties in the object.
|
|
72
120
|
* @returns A new object with the same schema and properties.
|
|
73
121
|
*/
|
|
74
|
-
export declare const clone: <T extends
|
|
122
|
+
export declare const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T;
|
|
123
|
+
/**
|
|
124
|
+
* Makes all properties mutable recursively.
|
|
125
|
+
* Used to provide a mutable view of an object within `Obj.change`.
|
|
126
|
+
*/
|
|
127
|
+
export type { Mutable };
|
|
128
|
+
/**
|
|
129
|
+
* Perform mutations on an echo object within a controlled context.
|
|
130
|
+
*
|
|
131
|
+
* All mutations within the callback are batched and trigger a single notification
|
|
132
|
+
* when the callback completes. Direct mutations outside of `Obj.change` will throw
|
|
133
|
+
* an error for echo objects.
|
|
134
|
+
*
|
|
135
|
+
* This function also works with nested objects within echo objects (e.g., Template structs)
|
|
136
|
+
* that are reactive at runtime.
|
|
137
|
+
*
|
|
138
|
+
* @param obj - The echo object to mutate. Use `Relation.change` for relations.
|
|
139
|
+
* @param callback - The callback that performs mutations on the object.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```ts
|
|
143
|
+
* const person = Obj.make(Person, { name: 'John', age: 25 });
|
|
144
|
+
*
|
|
145
|
+
* // Mutate within Obj.change
|
|
146
|
+
* Obj.change(person, (p) => {
|
|
147
|
+
* p.name = 'Jane';
|
|
148
|
+
* p.age = 30;
|
|
149
|
+
* });
|
|
150
|
+
* // ONE notification fires here
|
|
151
|
+
*
|
|
152
|
+
* // Direct mutation throws
|
|
153
|
+
* person.name = 'Bob'; // Error: Cannot modify outside Obj.change()
|
|
154
|
+
* ```
|
|
155
|
+
*
|
|
156
|
+
* Note: Only accepts objects. Use `Relation.change` for relations.
|
|
157
|
+
*/
|
|
158
|
+
export declare const change: <T extends Unknown>(obj: T, callback: ChangeCallback<T>) => void;
|
|
159
|
+
/**
|
|
160
|
+
* Get a deeply nested property from an object.
|
|
161
|
+
*
|
|
162
|
+
* Similar to lodash.get and getDeep from @dxos/util.
|
|
163
|
+
* This is the complementary function to setValue.
|
|
164
|
+
* Accepts both reactive objects and snapshots.
|
|
165
|
+
*
|
|
166
|
+
* @param obj - The ECHO object to get the property from.
|
|
167
|
+
* @param path - Path to the property (array of keys).
|
|
168
|
+
* @returns The value at the path, or undefined if not found.
|
|
169
|
+
*
|
|
170
|
+
* @example
|
|
171
|
+
* ```ts
|
|
172
|
+
* const person = Obj.make(Person, {
|
|
173
|
+
* name: 'John',
|
|
174
|
+
* addresses: [{ street: '123 Main St' }]
|
|
175
|
+
* });
|
|
176
|
+
*
|
|
177
|
+
* Obj.getValue(person, ['addresses', 0, 'street']); // '123 Main St'
|
|
178
|
+
* Obj.getValue(person, ['addresses', 1, 'street']); // undefined
|
|
179
|
+
* ```
|
|
180
|
+
*/
|
|
181
|
+
export declare const getValue: (obj: Unknown | Snapshot, path: readonly (string | number)[]) => any;
|
|
182
|
+
/**
|
|
183
|
+
* Set a deeply nested property on an object, using the object's schema to determine
|
|
184
|
+
* whether to initialize nested data as an empty object or array.
|
|
185
|
+
*
|
|
186
|
+
* Similar to lodash.set and setDeep from @dxos/util, but schema-aware.
|
|
187
|
+
* Must be called within an `Obj.change` callback.
|
|
188
|
+
*
|
|
189
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
190
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
191
|
+
*
|
|
192
|
+
* @param obj - The mutable ECHO object to set the property on.
|
|
193
|
+
* @param path - Path to the property (array of keys).
|
|
194
|
+
* @param value - Value to set.
|
|
195
|
+
* @returns The value that was set.
|
|
196
|
+
*
|
|
197
|
+
* @example
|
|
198
|
+
* ```ts
|
|
199
|
+
* const person = Obj.make(Person, { name: 'John' });
|
|
200
|
+
* // Person schema has: addresses: Schema.Array(Address)
|
|
201
|
+
* Obj.change(person, (p) => {
|
|
202
|
+
* Obj.setValue(p, ['addresses', 0, 'street'], '123 Main St');
|
|
203
|
+
* });
|
|
204
|
+
* // Creates: person.addresses = [{ street: '123 Main St' }]
|
|
205
|
+
* ```
|
|
206
|
+
*/
|
|
207
|
+
export declare const setValue: (obj: Mutable<Unknown>, path: readonly (string | number)[], value: any) => void;
|
|
75
208
|
export declare const ID: import("@dxos/keys").ObjectIdClass;
|
|
76
209
|
export type ID = ObjectId;
|
|
77
210
|
/**
|
|
@@ -89,53 +222,136 @@ export declare const instanceOf: {
|
|
|
89
222
|
<S extends Type.Entity.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
|
|
90
223
|
<S extends Type.Entity.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
|
|
91
224
|
};
|
|
92
|
-
|
|
225
|
+
/**
|
|
226
|
+
* Get the DXN of the object.
|
|
227
|
+
* Accepts both reactive objects and snapshots.
|
|
228
|
+
*/
|
|
229
|
+
export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
|
|
93
230
|
/**
|
|
94
231
|
* @returns The DXN of the object's type.
|
|
95
232
|
* @example dxn:example.com/type/Person:1.0.0
|
|
96
233
|
*/
|
|
97
|
-
export declare const getTypeDXN: (obj:
|
|
234
|
+
export declare const getTypeDXN: (obj: unknown | undefined) => DXN | undefined;
|
|
98
235
|
/**
|
|
99
236
|
* Get the schema of the object.
|
|
237
|
+
* Returns the branded ECHO schema used to create the object.
|
|
100
238
|
*/
|
|
101
|
-
export declare const getSchema: (obj: unknown | undefined) =>
|
|
239
|
+
export declare const getSchema: (obj: unknown | undefined) => Type.Entity.Any | undefined;
|
|
102
240
|
/**
|
|
103
241
|
* @returns The typename of the object's type.
|
|
242
|
+
* Accepts both reactive objects and snapshots.
|
|
104
243
|
* @example `example.com/type/Person`
|
|
105
244
|
*/
|
|
106
|
-
export declare const getTypename: (entity:
|
|
245
|
+
export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
|
|
246
|
+
/**
|
|
247
|
+
* Get the database the object belongs to.
|
|
248
|
+
* Accepts both reactive objects and snapshots.
|
|
249
|
+
*/
|
|
250
|
+
export declare const getDatabase: (entity: Unknown | Snapshot) => Database.Database | undefined;
|
|
107
251
|
export declare const Meta: unique symbol;
|
|
108
|
-
|
|
252
|
+
/**
|
|
253
|
+
* Deeply read-only version of ObjectMeta.
|
|
254
|
+
* Prevents mutation at all nesting levels (e.g., `meta.keys.push()` is a TypeScript error).
|
|
255
|
+
*/
|
|
256
|
+
export type ReadonlyMeta = ApiReadonlyMeta;
|
|
257
|
+
/**
|
|
258
|
+
* Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
|
|
259
|
+
*/
|
|
260
|
+
export type Meta = ApiMeta;
|
|
261
|
+
/**
|
|
262
|
+
* Get the metadata for an object.
|
|
263
|
+
* Returns mutable meta when passed a mutable object (inside `Obj.change` callback).
|
|
264
|
+
* Returns read-only meta when passed a regular object or snapshot.
|
|
265
|
+
*
|
|
266
|
+
* @example
|
|
267
|
+
* ```ts
|
|
268
|
+
* // Read-only access outside change callback
|
|
269
|
+
* const meta = Obj.getMeta(person); // ReadonlyMeta
|
|
270
|
+
*
|
|
271
|
+
* // Mutable access inside change callback
|
|
272
|
+
* Obj.change(person, (p) => {
|
|
273
|
+
* const meta = Obj.getMeta(p); // ObjectMeta (mutable)
|
|
274
|
+
* meta.tags ??= [];
|
|
275
|
+
* meta.tags.push('important');
|
|
276
|
+
* });
|
|
277
|
+
* ```
|
|
278
|
+
*/
|
|
279
|
+
export declare function getMeta(entity: Mutable<Unknown>): Meta;
|
|
280
|
+
export declare function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
|
|
109
281
|
/**
|
|
110
282
|
* @returns Foreign keys for the object from the specified source.
|
|
283
|
+
* Accepts both reactive objects and snapshots.
|
|
111
284
|
*/
|
|
112
285
|
export declare const getKeys: {
|
|
113
|
-
(entity:
|
|
114
|
-
(source: string): (entity:
|
|
286
|
+
(entity: Unknown | Snapshot, source: string): ForeignKey[];
|
|
287
|
+
(source: string): (entity: Unknown | Snapshot) => ForeignKey[];
|
|
115
288
|
};
|
|
116
289
|
/**
|
|
117
290
|
* Delete all keys from the object for the specified source.
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
export declare const
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
291
|
+
* Must be called within an `Obj.change` callback.
|
|
292
|
+
*
|
|
293
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
294
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
295
|
+
*/
|
|
296
|
+
export declare const deleteKeys: (entity: Mutable<Unknown>, source: string) => void;
|
|
297
|
+
/**
|
|
298
|
+
* Add a tag to the object.
|
|
299
|
+
* Must be called within an `Obj.change` callback.
|
|
300
|
+
*
|
|
301
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
302
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
303
|
+
*/
|
|
304
|
+
export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
|
|
305
|
+
/**
|
|
306
|
+
* Remove a tag from the object.
|
|
307
|
+
* Must be called within an `Obj.change` callback.
|
|
308
|
+
*
|
|
309
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
310
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
311
|
+
*/
|
|
312
|
+
export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
|
|
313
|
+
/**
|
|
314
|
+
* Check if the object is deleted.
|
|
315
|
+
* Accepts both reactive objects and snapshots.
|
|
316
|
+
*/
|
|
317
|
+
export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
|
|
318
|
+
/**
|
|
319
|
+
* Get the label of the object.
|
|
320
|
+
* Accepts both reactive objects and snapshots.
|
|
321
|
+
*/
|
|
322
|
+
export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
|
|
323
|
+
/**
|
|
324
|
+
* Set the label of the object.
|
|
325
|
+
* Must be called within an `Obj.change` callback.
|
|
326
|
+
*
|
|
327
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
328
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
329
|
+
*/
|
|
330
|
+
export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
|
|
331
|
+
/**
|
|
332
|
+
* Get the description of the object.
|
|
333
|
+
* Accepts both reactive objects and snapshots.
|
|
334
|
+
*/
|
|
335
|
+
export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* Set the description of the object.
|
|
338
|
+
* Must be called within an `Obj.change` callback.
|
|
339
|
+
*
|
|
340
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
341
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
342
|
+
*/
|
|
343
|
+
export declare const setDescription: (entity: Mutable<Unknown>, description: string) => void;
|
|
129
344
|
/**
|
|
130
345
|
* JSON representation of an object.
|
|
131
346
|
*/
|
|
132
|
-
export type JSON =
|
|
347
|
+
export type JSON = APIJSON;
|
|
133
348
|
/**
|
|
134
349
|
* Converts object to its JSON representation.
|
|
350
|
+
* Accepts both reactive objects and snapshots.
|
|
135
351
|
*
|
|
136
352
|
* The same algorithm is used when calling the standard `JSON.stringify(obj)` function.
|
|
137
353
|
*/
|
|
138
|
-
export declare const toJSON: (entity:
|
|
354
|
+
export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
|
|
139
355
|
/**
|
|
140
356
|
* Creates an object from its json representation, performing schema validation.
|
|
141
357
|
* References and schemas will be resolvable if the `refResolver` is provided.
|
|
@@ -148,51 +364,27 @@ export declare const toJSON: (entity: Entity.Unknown) => JSON;
|
|
|
148
364
|
export declare const fromJSON: (json: unknown, options?: {
|
|
149
365
|
refResolver?: Ref.Resolver;
|
|
150
366
|
dxn?: DXN;
|
|
151
|
-
}) => Promise<
|
|
152
|
-
|
|
367
|
+
}) => Promise<Unknown>;
|
|
368
|
+
/**
|
|
369
|
+
* Comparator function type for sorting objects.
|
|
370
|
+
* Accepts both reactive objects and snapshots.
|
|
371
|
+
*/
|
|
372
|
+
export type Comparator = ApiComparator<Unknown | Snapshot>;
|
|
153
373
|
export declare const sortByLabel: Comparator;
|
|
154
374
|
export declare const sortByTypename: Comparator;
|
|
155
375
|
export declare const sort: (...comparators: Comparator[]) => Comparator;
|
|
156
|
-
/**
|
|
157
|
-
* Unique symbol for version type identification.
|
|
158
|
-
*/
|
|
159
376
|
export { VersionTypeId };
|
|
377
|
+
export type { VersionCompareResult };
|
|
160
378
|
/**
|
|
161
379
|
* Represent object version.
|
|
162
380
|
* May be backed by Automerge.
|
|
163
381
|
* Objects with no history are not versioned.
|
|
164
382
|
*/
|
|
165
|
-
export
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
* Whether the object is versioned.
|
|
169
|
-
*/
|
|
170
|
-
versioned: boolean;
|
|
171
|
-
/**
|
|
172
|
-
* Automerge heads.
|
|
173
|
-
*/
|
|
174
|
-
automergeHeads?: string[];
|
|
175
|
-
}
|
|
176
|
-
/**
|
|
177
|
-
* Checks that `obj` is a version object.
|
|
178
|
-
*/
|
|
179
|
-
export declare const isVersion: (entity: unknown) => entity is Version;
|
|
383
|
+
export type Version = ApiVersion;
|
|
384
|
+
export { isVersion, versionValid, compareVersions, encodeVersion, decodeVersion };
|
|
180
385
|
/**
|
|
181
386
|
* Returns the version of the object.
|
|
387
|
+
* Accepts both reactive objects and snapshots.
|
|
182
388
|
*/
|
|
183
|
-
export declare const version: (entity:
|
|
184
|
-
/**
|
|
185
|
-
* Checks that `version` is a valid version object.
|
|
186
|
-
*/
|
|
187
|
-
export declare const versionValid: (version: Version) => boolean;
|
|
188
|
-
export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
|
|
189
|
-
/**
|
|
190
|
-
* Compares two versions.
|
|
191
|
-
* @param version1
|
|
192
|
-
* @param version2
|
|
193
|
-
* @returns 'unversioned' if either object is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
|
|
194
|
-
*/
|
|
195
|
-
export declare const compareVersions: (version1: Version, version2: Version) => VersionCompareResult;
|
|
196
|
-
export declare const encodeVersion: (version: Version) => string;
|
|
197
|
-
export declare const decodeVersion: (version: string) => Version;
|
|
389
|
+
export declare const version: (entity: Unknown | Snapshot) => Version;
|
|
198
390
|
//# sourceMappingURL=Obj.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Obj.d.ts","sourceRoot":"","sources":["../../../src/Obj.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"Obj.d.ts","sourceRoot":"","sources":["../../../src/Obj.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EACL,KAAK,UAAU,IAAI,OAAO,EAC1B,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,UAAU,IAAI,aAAa,EAChC,KAAK,IAAI,IAAI,OAAO,EACpB,KAAK,YAAY,IAAI,eAAe,EACpC,KAAK,aAAa,IAAI,UAAU,EAChC,KAAK,cAAc,EAEnB,KAAK,MAAM,EAEX,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,aAAa,EAIb,eAAe,EACf,aAAa,EAEb,aAAa,EAcb,SAAS,EAaT,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,UAAU,OAAQ,SAAQ,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,KAAK,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,WAAW,OAAQ,SAAQ,OAAO;CAAG;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,GAAI,SAAQ,OAAO,EAAE,aAAa;CAAG;AAEtD;;GAEG;AACH,UAAU,YAAa,SAAQ,SAAS;IACtC,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;IACrD,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;AAMnF,KAAK,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IACpB,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAGvB;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,IAAI;IAC5D,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB,CAAC,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF;;OAEG;IACH,CAAC,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAqBjH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,OAG9C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAEzE,CAAC;AAMF;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAuB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,YAAY,KAAK,CAAU,CAAC;AAMnF;;;GAGG;AACH,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,IAE/E,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,GAAG,QAAQ,EAAE,MAAM,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAG,GAEtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,eAAO,MAAM,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,IAChF,CAAC;AAOnB,eAAO,MAAM,EAAE,oCAAW,CAAC;AAC3B,MAAM,MAAM,EAAE,GAAG,QAAQ,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAOhF,CAAC;AAGV;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAGnD,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,KAAK,GAAG,GAAG,SAA8B,CAAC;AAE5F;;;GAGG;AAEH,eAAO,MAAM,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,SAA6B,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAiC,CAAC;AAMpG;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,QAAQ,CAAC,QAAQ,GAAG,SAAiC,CAAC;AAM/G,eAAO,MAAM,IAAI,EAAE,OAAO,MAAsB,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAI3B;;;;;;;;;;;;;;;;;GAiBG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;AACxD,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;AAKlE;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAC3D,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,KAAK,UAAU,EAAE,CAAC;CAC6C,CAAC;AAE/G;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,MAAM,KAAG,IAAmC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA4B,CAAC;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA+B,CAAC;AAElG;;;GAGG;AAEH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA6B,CAAC;AAMrF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA8B,CAAC;AAE9F;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,MAAM,KAAG,IAAgC,CAAC;AAEpG;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAoC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,MAAM,KAAG,IACzC,CAAC;AAMvC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,IAAuB,CAAC;AAE5E;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CACvF,CAAC;AAMxB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,CAAC;AAE3D,eAAO,MAAM,WAAW,EAAE,UAAuC,CAAC;AAClE,eAAO,MAAM,cAAc,EAAE,UAA0C,CAAC;AACxE,eAAO,MAAM,IAAI,GAAI,GAAG,aAAa,UAAU,EAAE,KAAG,UAAiD,CAAC;AAMtG,OAAO,EAAE,aAAa,EAAE,CAAC;AACzB,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC;AAEjC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA2B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Obj.test.d.ts","sourceRoot":"","sources":["../../../src/Obj.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { type QueryAST } from '@dxos/echo-protocol';
|
|
2
|
+
export interface Order<T> {
|
|
3
|
+
'~Order': {
|
|
4
|
+
value: T;
|
|
5
|
+
};
|
|
6
|
+
ast: QueryAST.Order;
|
|
7
|
+
}
|
|
8
|
+
export type Any = Order<any>;
|
|
9
|
+
export declare const natural: Order<any>;
|
|
10
|
+
export declare const property: <T>(property: keyof T & string, direction: QueryAST.OrderDirection) => Order<T>;
|
|
11
|
+
/**
|
|
12
|
+
* Order by relevance rank (for FTS/vector search results).
|
|
13
|
+
* Higher rank = better match. Default direction is 'desc' (best matches first).
|
|
14
|
+
*/
|
|
15
|
+
export declare const rank: <T>(direction?: QueryAST.OrderDirection) => Order<T>;
|
|
16
|
+
//# sourceMappingURL=Order.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Order.d.ts","sourceRoot":"","sources":["../../../src/Order.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,WAAW,KAAK,CAAC,CAAC;IAEtB,QAAQ,EAAE;QAAE,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAEvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;CACrB;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AAc7B,eAAO,MAAM,OAAO,EAAE,KAAK,CAAC,GAAG,CAAuC,CAAC;AACvE,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,UAAU,MAAM,CAAC,GAAG,MAAM,EAAE,WAAW,QAAQ,CAAC,cAAc,KAAG,KAAK,CAAC,CAAC,CAKhG,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,YAAW,QAAQ,CAAC,cAAuB,KAAG,KAAK,CAAC,CAAC,CAIzE,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type * as EffectArray from 'effect/Array';
|
|
2
2
|
import type * as Schema from 'effect/Schema';
|
|
3
3
|
import { type QueryAST } from '@dxos/echo-protocol';
|
|
4
|
-
import
|
|
5
|
-
import type * as
|
|
6
|
-
import
|
|
7
|
-
import
|
|
4
|
+
import * as Filter from './Filter';
|
|
5
|
+
import type * as Order from './Order';
|
|
6
|
+
import type * as Ref from './Ref';
|
|
7
|
+
import type * as Type$ from './Type';
|
|
8
8
|
/**
|
|
9
9
|
* All property paths inside T that are references.
|
|
10
10
|
*/
|
|
@@ -19,21 +19,23 @@ export interface Query<T> {
|
|
|
19
19
|
* @param filter - Filter to select the objects.
|
|
20
20
|
* @returns Query for the selected objects.
|
|
21
21
|
*/
|
|
22
|
-
select(filter: Filter<T>): Query<T>;
|
|
22
|
+
select(filter: Filter.Filter<T>): Query<T>;
|
|
23
23
|
select(props: Filter.Props<T>): Query<T>;
|
|
24
24
|
/**
|
|
25
25
|
* Traverse an outgoing reference.
|
|
26
26
|
* @param key - Property path inside T that is a reference or optional reference.
|
|
27
27
|
* @returns Query for the target of the reference.
|
|
28
28
|
*/
|
|
29
|
-
reference<K extends RefPropKey<T>>(key: K): Query<T[K] extends Ref.
|
|
29
|
+
reference<K extends RefPropKey<T>>(key: K): Query<T[K] extends Ref.Unknown ? Ref.Target<T[K]> : T[K] extends Ref.Unknown | undefined ? Ref.Target<Exclude<T[K], undefined>> : never>;
|
|
30
30
|
/**
|
|
31
31
|
* Find objects referencing this object.
|
|
32
|
-
* @param target - Schema of the referencing object.
|
|
33
|
-
* @param key - Property path inside the referencing object that is a reference.
|
|
32
|
+
* @param target - Schema of the referencing object. If not provided, matches any type.
|
|
33
|
+
* @param key - Property path inside the referencing object that is a reference. If not provided, matches any property.
|
|
34
34
|
* @returns Query for the referencing objects.
|
|
35
35
|
*/
|
|
36
36
|
referencedBy<S extends Schema.Schema.All>(target: S | string, key: RefPropKey<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
|
|
37
|
+
referencedBy<S extends Schema.Schema.All>(target: S | string): Query<Schema.Schema.Type<S>>;
|
|
38
|
+
referencedBy(): Query<any>;
|
|
37
39
|
/**
|
|
38
40
|
* Find relations where this object is the source.
|
|
39
41
|
* @returns Query for the relation objects.
|
|
@@ -52,61 +54,62 @@ export interface Query<T> {
|
|
|
52
54
|
* For a query for relations, get the source objects.
|
|
53
55
|
* @returns Query for the source objects.
|
|
54
56
|
*/
|
|
55
|
-
source(): Query<Type
|
|
57
|
+
source(): Query<Type$.Relation.Source<T>>;
|
|
56
58
|
/**
|
|
57
59
|
* For a query for relations, get the target objects.
|
|
58
60
|
* @returns Query for the target objects.
|
|
59
61
|
*/
|
|
60
|
-
target(): Query<Type
|
|
62
|
+
target(): Query<Type$.Relation.Target<T>>;
|
|
61
63
|
/**
|
|
62
64
|
* Order the query results.
|
|
63
65
|
* Orders are specified in priority order. The first order will be applied first, etc.
|
|
64
66
|
* @param order - Order to sort the results.
|
|
65
67
|
* @returns Query for the ordered results.
|
|
66
68
|
*/
|
|
67
|
-
orderBy(...order: EffectArray.NonEmptyArray<Order<T>>): Query<T>;
|
|
69
|
+
orderBy(...order: EffectArray.NonEmptyArray<Order.Order<T>>): Query<T>;
|
|
68
70
|
/**
|
|
69
|
-
*
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
}
|
|
73
|
-
interface QueryAPI {
|
|
74
|
-
is(value: unknown): value is Query.Any;
|
|
75
|
-
/** Construct a query from an ast. */
|
|
76
|
-
fromAst(ast: QueryAST.Query): Query<any>;
|
|
77
|
-
/**
|
|
78
|
-
* Select objects based on a filter.
|
|
79
|
-
* @param filter - Filter to select the objects.
|
|
80
|
-
* @returns Query for the selected objects.
|
|
81
|
-
*/
|
|
82
|
-
select<F extends Filter.Any>(filter: F): Query<Filter.Type<F>>;
|
|
83
|
-
/**
|
|
84
|
-
* Query for objects of a given schema.
|
|
85
|
-
* @param schema - Schema of the objects.
|
|
86
|
-
* @param predicates - Predicates to filter the objects.
|
|
87
|
-
* @returns Query for the objects.
|
|
88
|
-
*
|
|
89
|
-
* Shorthand for: `Query.select(Filter.type(schema, predicates))`.
|
|
90
|
-
*/
|
|
91
|
-
type<S extends Schema.Schema.All>(schema: S | string, predicates?: Filter.Props<Schema.Schema.Type<S>>): Query<Schema.Schema.Type<S>>;
|
|
92
|
-
/**
|
|
93
|
-
* Combine results of multiple queries.
|
|
94
|
-
* @param queries - Queries to combine.
|
|
95
|
-
* @returns Query for the combined results.
|
|
71
|
+
* Limit the number of results.
|
|
72
|
+
* @param limit - Maximum number of results to return.
|
|
73
|
+
* @returns Query for the limited results.
|
|
96
74
|
*/
|
|
97
|
-
|
|
75
|
+
limit(limit: number): Query<T>;
|
|
98
76
|
/**
|
|
99
|
-
*
|
|
100
|
-
* @param source - Query to subtract from.
|
|
101
|
-
* @param exclude - Query to subtract.
|
|
102
|
-
* @returns Query for the results of the source query minus the results of the exclude query.
|
|
77
|
+
* Add options to a query.
|
|
103
78
|
*/
|
|
104
|
-
|
|
105
|
-
}
|
|
106
|
-
export declare namespace Query {
|
|
107
|
-
type Any = Query<any>;
|
|
108
|
-
type Type<Q extends Any> = Q extends Query<infer T> ? T : never;
|
|
79
|
+
options(options: QueryAST.QueryOptions): Query<T>;
|
|
109
80
|
}
|
|
110
|
-
export
|
|
81
|
+
export type Any = Query<any>;
|
|
82
|
+
export type Type<Q extends Any> = Q extends Query<infer T> ? T : never;
|
|
83
|
+
export declare const is: (value: unknown) => value is Any;
|
|
84
|
+
/** Construct a query from an ast. */
|
|
85
|
+
export declare const fromAst: (ast: QueryAST.Query) => Any;
|
|
86
|
+
/**
|
|
87
|
+
* Select objects based on a filter.
|
|
88
|
+
* @param filter - Filter to select the objects.
|
|
89
|
+
* @returns Query for the selected objects.
|
|
90
|
+
*/
|
|
91
|
+
export declare const select: <F extends Filter.Any>(filter: F) => Query<Filter.Type<F>>;
|
|
92
|
+
/**
|
|
93
|
+
* Query for objects of a given schema.
|
|
94
|
+
* @param schema - Schema of the objects.
|
|
95
|
+
* @param predicates - Predicates to filter the objects.
|
|
96
|
+
* @returns Query for the objects.
|
|
97
|
+
*
|
|
98
|
+
* Shorthand for: `Query.select(Filter.type(schema, predicates))`.
|
|
99
|
+
*/
|
|
100
|
+
export declare const type: (schema: Schema.Schema.All | string, predicates?: Filter.Props<unknown>) => Any;
|
|
101
|
+
/**
|
|
102
|
+
* Combine results of multiple queries.
|
|
103
|
+
* @param queries - Queries to combine.
|
|
104
|
+
* @returns Query for the combined results.
|
|
105
|
+
*/
|
|
106
|
+
export declare const all: (...queries: Any[]) => Any;
|
|
107
|
+
/**
|
|
108
|
+
* Subtract one query from another.
|
|
109
|
+
* @param source - Query to subtract from.
|
|
110
|
+
* @param exclude - Query to subtract.
|
|
111
|
+
* @returns Query for the results of the source query minus the results of the exclude query.
|
|
112
|
+
*/
|
|
113
|
+
export declare const without: <T>(source: Query<T>, exclude: Query<T>) => Query<T>;
|
|
111
114
|
export {};
|
|
112
|
-
//# sourceMappingURL=
|
|
115
|
+
//# sourceMappingURL=Query.d.ts.map
|