@dxos/echo 0.8.4-main.3c1ae3b → 0.8.4-main.3eb6e50203
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/neutral/Annotation.mjs +35 -0
- package/dist/lib/neutral/Database.mjs +45 -0
- package/dist/lib/neutral/Entity.mjs +51 -0
- package/dist/lib/{browser → neutral}/Err.mjs +4 -3
- package/dist/lib/{browser → neutral}/Filter.mjs +9 -8
- package/dist/lib/{browser → neutral}/Format.mjs +4 -5
- package/dist/lib/neutral/JsonSchema.mjs +19 -0
- package/dist/lib/{browser → neutral}/Key.mjs +2 -3
- package/dist/lib/{node-esm → neutral}/Obj.mjs +40 -19
- package/dist/lib/neutral/Order.mjs +12 -0
- package/dist/lib/neutral/Query.mjs +26 -0
- package/dist/lib/neutral/QueryResult.mjs +2 -0
- package/dist/lib/neutral/Ref.mjs +22 -0
- package/dist/lib/neutral/Relation.mjs +84 -0
- package/dist/lib/neutral/SchemaRegistry.mjs +2 -0
- package/dist/lib/neutral/Tag.mjs +25 -0
- package/dist/lib/neutral/Type.mjs +47 -0
- package/dist/lib/{browser/chunk-FGFQWIZE.mjs → neutral/chunk-4L6DOFXP.mjs} +1 -3
- package/dist/lib/neutral/chunk-4L6DOFXP.mjs.map +7 -0
- package/dist/lib/{browser/chunk-RP4JV7FD.mjs → neutral/chunk-7WE7SBA2.mjs} +4 -5
- package/dist/lib/neutral/chunk-7WE7SBA2.mjs.map +7 -0
- package/dist/lib/neutral/chunk-7YWDDFPH.mjs +251 -0
- package/dist/lib/neutral/chunk-7YWDDFPH.mjs.map +7 -0
- package/dist/lib/{browser/chunk-INHXFXY5.mjs → neutral/chunk-ANHVGJI4.mjs} +2 -3
- package/dist/lib/{node-esm/chunk-AJEMYSIR.mjs.map → neutral/chunk-ANHVGJI4.mjs.map} +1 -1
- package/dist/lib/neutral/chunk-B4FLOYG7.mjs +130 -0
- package/dist/lib/neutral/chunk-B4FLOYG7.mjs.map +7 -0
- package/dist/lib/{browser/chunk-O6FOICWT.mjs → neutral/chunk-EXAYCLIM.mjs} +8 -9
- package/dist/lib/neutral/chunk-EXAYCLIM.mjs.map +7 -0
- package/dist/lib/{browser/chunk-V7TON6BX.mjs → neutral/chunk-F6BTBXL7.mjs} +28 -8
- package/dist/lib/neutral/chunk-F6BTBXL7.mjs.map +7 -0
- package/dist/lib/neutral/chunk-HQXQWXLH.mjs +269 -0
- package/dist/lib/neutral/chunk-HQXQWXLH.mjs.map +7 -0
- package/dist/lib/{browser/chunk-CGS2ULMK.mjs → neutral/chunk-J5LGTIGS.mjs} +1 -2
- package/dist/lib/{node-esm/chunk-NHYOREKX.mjs → neutral/chunk-KB7RIVLK.mjs} +11 -6
- package/dist/lib/neutral/chunk-KB7RIVLK.mjs.map +7 -0
- package/dist/lib/neutral/chunk-MXQJZCPY.mjs +51 -0
- package/dist/lib/neutral/chunk-MXQJZCPY.mjs.map +7 -0
- package/dist/lib/{browser/chunk-3B2G6BW4.mjs → neutral/chunk-N2QNHMT5.mjs} +3 -4
- package/dist/lib/{browser/chunk-3B2G6BW4.mjs.map → neutral/chunk-N2QNHMT5.mjs.map} +1 -1
- package/dist/lib/{browser/chunk-JG4GH6LN.mjs → neutral/chunk-OMUPQMLR.mjs} +1 -3
- package/dist/lib/neutral/chunk-OMUPQMLR.mjs.map +7 -0
- package/dist/lib/{browser/chunk-AGOWBKY6.mjs → neutral/chunk-RCBBZLVM.mjs} +61 -13
- package/dist/lib/neutral/chunk-RCBBZLVM.mjs.map +7 -0
- package/dist/lib/{node-esm/chunk-6OTQZKHX.mjs → neutral/chunk-RIMHNJ3E.mjs} +30 -37
- package/dist/lib/neutral/chunk-RIMHNJ3E.mjs.map +7 -0
- package/dist/lib/{node-esm/chunk-BYL2NPEA.mjs → neutral/chunk-ROKO4RKJ.mjs} +9 -4
- package/dist/lib/{node-esm/chunk-BYL2NPEA.mjs.map → neutral/chunk-ROKO4RKJ.mjs.map} +3 -3
- package/dist/lib/{browser/chunk-ESLW4N7S.mjs → neutral/chunk-TMLVKIMX.mjs} +3 -4
- package/dist/lib/neutral/chunk-TMLVKIMX.mjs.map +7 -0
- package/dist/lib/{browser/chunk-P2B4BASR.mjs → neutral/chunk-UMECVTXM.mjs} +4 -5
- package/dist/lib/{node-esm/chunk-LDXRA5TC.mjs.map → neutral/chunk-UMECVTXM.mjs.map} +1 -1
- package/dist/lib/{browser/chunk-6XVZF5VJ.mjs → neutral/chunk-VJ2H5MOJ.mjs} +1991 -1010
- package/dist/lib/neutral/chunk-VJ2H5MOJ.mjs.map +7 -0
- package/dist/lib/{browser/chunk-5IN7XBIQ.mjs → neutral/chunk-VYEWMV5U.mjs} +3 -4
- package/dist/lib/{browser/chunk-5IN7XBIQ.mjs.map → neutral/chunk-VYEWMV5U.mjs.map} +1 -1
- package/dist/lib/{browser/chunk-MYCCGG2T.mjs → neutral/chunk-X2MPMYYN.mjs} +1 -3
- package/dist/lib/{browser/chunk-MYCCGG2T.mjs.map → neutral/chunk-X2MPMYYN.mjs.map} +1 -1
- package/dist/lib/{browser/chunk-ZIM3Y4ZK.mjs → neutral/chunk-XAJMXQ4H.mjs} +17 -12
- package/dist/lib/neutral/chunk-XAJMXQ4H.mjs.map +7 -0
- package/dist/lib/neutral/chunk-YPIP3WGI.mjs +97 -0
- package/dist/lib/neutral/chunk-YPIP3WGI.mjs.map +7 -0
- package/dist/lib/{browser → neutral}/index.mjs +27 -28
- package/dist/lib/{node-esm → neutral}/internal/index.mjs +141 -26
- package/dist/lib/neutral/meta.json +1 -0
- package/dist/lib/{browser → neutral}/testing/index.mjs +67 -61
- package/dist/lib/neutral/testing/index.mjs.map +7 -0
- package/dist/types/src/Annotation.d.ts +23 -1
- package/dist/types/src/Annotation.d.ts.map +1 -1
- package/dist/types/src/Database.d.ts +90 -53
- 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/Err.d.ts +55 -16
- package/dist/types/src/Err.d.ts.map +1 -1
- package/dist/types/src/Obj.d.ts +348 -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 +5 -0
- package/dist/types/src/Order.d.ts.map +1 -1
- package/dist/types/src/Query.d.ts +21 -3
- package/dist/types/src/Query.d.ts.map +1 -1
- package/dist/types/src/QueryResult.d.ts +0 -4
- package/dist/types/src/QueryResult.d.ts.map +1 -1
- package/dist/types/src/Ref.d.ts +7 -7
- package/dist/types/src/Ref.d.ts.map +1 -1
- package/dist/types/src/Relation.d.ts +236 -19
- 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 +11 -0
- package/dist/types/src/SchemaRegistry.d.ts.map +1 -1
- 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/hierarchy.test.d.ts +2 -0
- package/dist/types/src/hierarchy.test.d.ts.map +1 -0
- package/dist/types/src/internal/annotations/annotations.d.ts +24 -26
- package/dist/types/src/internal/annotations/annotations.d.ts.map +1 -1
- package/dist/types/src/internal/annotations/util.d.ts +12 -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 +17 -8
- 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/select.d.ts +2 -2
- package/dist/types/src/internal/formats/select.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 +16 -12
- 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 +30 -8
- 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 +16 -3
- package/dist/types/src/internal/schema/echo-schema.d.ts.map +1 -1
- package/dist/types/src/internal/schema/index.d.ts +0 -1
- 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/internal/types/typename.d.ts +8 -0
- package/dist/types/src/internal/types/typename.d.ts.map +1 -1
- package/dist/types/src/testing/test-schema.d.ts +101 -205
- 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 +38 -115
- package/src/Annotation.ts +32 -4
- package/src/Database.ts +170 -125
- package/src/Entity.test.ts +22 -0
- package/src/Entity.ts +173 -7
- package/src/Err.ts +22 -2
- package/src/Obj.test.ts +442 -0
- package/src/Obj.ts +471 -254
- package/src/Order.ts +10 -0
- package/src/Query.test.ts +120 -1
- package/src/Query.ts +53 -8
- package/src/QueryResult.ts +1 -4
- package/src/Ref.ts +3 -3
- package/src/Relation.test.ts +82 -0
- package/src/Relation.ts +367 -28
- package/src/SchemaRegistry.ts +13 -0
- package/src/Tag.ts +1 -1
- package/src/Type.test.ts +52 -0
- package/src/Type.ts +322 -88
- package/src/hierarchy.test.ts +33 -0
- package/src/internal/README.md +31 -16
- package/src/internal/annotations/annotations.test.ts +6 -6
- package/src/internal/annotations/annotations.ts +48 -49
- package/src/internal/annotations/util.ts +13 -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 +21 -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/select.ts +1 -1
- package/src/internal/formats/types.ts +1 -1
- 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 +30 -31
- package/src/internal/json-schema/json-schema.test.ts +17 -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 +37 -70
- package/src/internal/object/schema-validator.test.ts +3 -7
- package/src/internal/object/schema-validator.ts +2 -240
- 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 +93 -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 +44 -51
- 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 +274 -57
- 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 +88 -41
- package/src/internal/schema/compose.test.ts +3 -3
- package/src/internal/schema/compose.ts +13 -9
- package/src/internal/schema/echo-schema.ts +51 -12
- package/src/internal/schema/index.ts +0 -1
- package/src/internal/schema/persistent-schema.ts +5 -5
- package/src/internal/types/base.ts +6 -20
- package/src/internal/types/entity.ts +35 -4
- package/src/internal/types/meta.ts +13 -24
- package/src/internal/types/typename.ts +10 -0
- package/src/testing/api.test.ts +31 -5
- package/src/testing/test-schema.ts +44 -30
- package/src/testing/util.ts +22 -15
- package/dist/lib/browser/Annotation.mjs +0 -31
- package/dist/lib/browser/Database.mjs +0 -14
- package/dist/lib/browser/Entity.mjs +0 -20
- package/dist/lib/browser/JsonSchema.mjs +0 -18
- package/dist/lib/browser/Obj.mjs +0 -83
- package/dist/lib/browser/Order.mjs +0 -11
- package/dist/lib/browser/Query.mjs +0 -25
- package/dist/lib/browser/QueryResult.mjs +0 -3
- package/dist/lib/browser/Ref.mjs +0 -21
- package/dist/lib/browser/Relation.mjs +0 -33
- package/dist/lib/browser/SchemaRegistry.mjs +0 -3
- package/dist/lib/browser/Tag.mjs +0 -25
- package/dist/lib/browser/Type.mjs +0 -38
- package/dist/lib/browser/chunk-6XVZF5VJ.mjs.map +0 -7
- package/dist/lib/browser/chunk-AGOWBKY6.mjs.map +0 -7
- package/dist/lib/browser/chunk-BD6MRI4M.mjs +0 -113
- package/dist/lib/browser/chunk-BD6MRI4M.mjs.map +0 -7
- package/dist/lib/browser/chunk-DOPKE2FQ.mjs +0 -32
- package/dist/lib/browser/chunk-DOPKE2FQ.mjs.map +0 -7
- package/dist/lib/browser/chunk-ESLW4N7S.mjs.map +0 -7
- package/dist/lib/browser/chunk-F4YF6C3O.mjs +0 -363
- package/dist/lib/browser/chunk-F4YF6C3O.mjs.map +0 -7
- package/dist/lib/browser/chunk-FGFQWIZE.mjs.map +0 -7
- package/dist/lib/browser/chunk-INHXFXY5.mjs.map +0 -7
- package/dist/lib/browser/chunk-JG4GH6LN.mjs.map +0 -7
- package/dist/lib/browser/chunk-NFH3POTD.mjs +0 -37
- package/dist/lib/browser/chunk-NFH3POTD.mjs.map +0 -7
- package/dist/lib/browser/chunk-O6FOICWT.mjs.map +0 -7
- package/dist/lib/browser/chunk-P2B4BASR.mjs.map +0 -7
- package/dist/lib/browser/chunk-QHC3ZYNC.mjs +0 -152
- package/dist/lib/browser/chunk-QHC3ZYNC.mjs.map +0 -7
- package/dist/lib/browser/chunk-QU7PWSZD.mjs +0 -62
- package/dist/lib/browser/chunk-QU7PWSZD.mjs.map +0 -7
- package/dist/lib/browser/chunk-RP4JV7FD.mjs.map +0 -7
- package/dist/lib/browser/chunk-V7TON6BX.mjs.map +0 -7
- package/dist/lib/browser/chunk-WABSVOOX.mjs +0 -303
- package/dist/lib/browser/chunk-WABSVOOX.mjs.map +0 -7
- package/dist/lib/browser/chunk-XRHHSMHJ.mjs +0 -39
- package/dist/lib/browser/chunk-XRHHSMHJ.mjs.map +0 -7
- package/dist/lib/browser/chunk-ZIM3Y4ZK.mjs.map +0 -7
- package/dist/lib/browser/internal/index.mjs +0 -347
- package/dist/lib/browser/meta.json +0 -1
- package/dist/lib/browser/testing/index.mjs.map +0 -7
- package/dist/lib/node-esm/Annotation.mjs +0 -31
- package/dist/lib/node-esm/Annotation.mjs.map +0 -7
- package/dist/lib/node-esm/Database.mjs +0 -14
- package/dist/lib/node-esm/Database.mjs.map +0 -7
- package/dist/lib/node-esm/Entity.mjs +0 -20
- package/dist/lib/node-esm/Entity.mjs.map +0 -7
- package/dist/lib/node-esm/Err.mjs +0 -11
- package/dist/lib/node-esm/Err.mjs.map +0 -7
- package/dist/lib/node-esm/Filter.mjs +0 -60
- package/dist/lib/node-esm/Filter.mjs.map +0 -7
- package/dist/lib/node-esm/Format.mjs +0 -67
- package/dist/lib/node-esm/Format.mjs.map +0 -7
- package/dist/lib/node-esm/JsonSchema.mjs +0 -18
- package/dist/lib/node-esm/JsonSchema.mjs.map +0 -7
- package/dist/lib/node-esm/Key.mjs +0 -13
- package/dist/lib/node-esm/Key.mjs.map +0 -7
- package/dist/lib/node-esm/Obj.mjs.map +0 -7
- package/dist/lib/node-esm/Order.mjs +0 -11
- package/dist/lib/node-esm/Order.mjs.map +0 -7
- package/dist/lib/node-esm/Query.mjs +0 -25
- package/dist/lib/node-esm/Query.mjs.map +0 -7
- package/dist/lib/node-esm/QueryResult.mjs +0 -3
- package/dist/lib/node-esm/QueryResult.mjs.map +0 -7
- package/dist/lib/node-esm/Ref.mjs +0 -21
- package/dist/lib/node-esm/Ref.mjs.map +0 -7
- package/dist/lib/node-esm/Relation.mjs +0 -33
- package/dist/lib/node-esm/Relation.mjs.map +0 -7
- package/dist/lib/node-esm/SchemaRegistry.mjs +0 -3
- package/dist/lib/node-esm/SchemaRegistry.mjs.map +0 -7
- package/dist/lib/node-esm/Tag.mjs +0 -25
- package/dist/lib/node-esm/Tag.mjs.map +0 -7
- package/dist/lib/node-esm/Type.mjs +0 -38
- package/dist/lib/node-esm/Type.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-5M5P2DCR.mjs +0 -32
- package/dist/lib/node-esm/chunk-5M5P2DCR.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-6OTQZKHX.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-76LEDWHO.mjs +0 -152
- package/dist/lib/node-esm/chunk-76LEDWHO.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-AGHZH33D.mjs +0 -9
- package/dist/lib/node-esm/chunk-AGHZH33D.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-AJEMYSIR.mjs +0 -22
- package/dist/lib/node-esm/chunk-BJACR7QG.mjs +0 -363
- package/dist/lib/node-esm/chunk-BJACR7QG.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-CCMFPJUT.mjs +0 -74
- package/dist/lib/node-esm/chunk-CCMFPJUT.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-D5BW7KHR.mjs +0 -39
- package/dist/lib/node-esm/chunk-D5BW7KHR.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-DJX53IQ3.mjs +0 -2924
- package/dist/lib/node-esm/chunk-DJX53IQ3.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-FWTPV5QD.mjs +0 -94
- package/dist/lib/node-esm/chunk-FWTPV5QD.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-HLUDHPFO.mjs +0 -403
- package/dist/lib/node-esm/chunk-HLUDHPFO.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +0 -11
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-JYZSF62S.mjs +0 -113
- package/dist/lib/node-esm/chunk-JYZSF62S.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-KUX5JEL2.mjs +0 -57
- package/dist/lib/node-esm/chunk-KUX5JEL2.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-LDXRA5TC.mjs +0 -288
- package/dist/lib/node-esm/chunk-MOWUEW5P.mjs +0 -15
- package/dist/lib/node-esm/chunk-MOWUEW5P.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-NHYOREKX.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-QVZZHCDS.mjs +0 -9
- package/dist/lib/node-esm/chunk-QVZZHCDS.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-W3OLV7MG.mjs +0 -41
- package/dist/lib/node-esm/chunk-W3OLV7MG.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-W5AQXKVF.mjs +0 -38
- package/dist/lib/node-esm/chunk-W5AQXKVF.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-YNBFXTDG.mjs +0 -24
- package/dist/lib/node-esm/chunk-YNBFXTDG.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-Z53QIBP2.mjs +0 -151
- package/dist/lib/node-esm/chunk-Z53QIBP2.mjs.map +0 -7
- package/dist/lib/node-esm/index.mjs +0 -85
- package/dist/lib/node-esm/index.mjs.map +0 -7
- package/dist/lib/node-esm/internal/index.mjs.map +0 -7
- package/dist/lib/node-esm/meta.json +0 -1
- package/dist/lib/node-esm/testing/index.mjs +0 -360
- package/dist/lib/node-esm/testing/index.mjs.map +0 -7
- 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/snapshot.d.ts +0 -6
- package/dist/types/src/internal/schema/snapshot.d.ts.map +0 -1
- package/src/internal/entities/expando.ts +0 -23
- package/src/internal/schema/snapshot.ts +0 -25
- /package/dist/lib/{browser → neutral}/Annotation.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Database.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Entity.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Err.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Filter.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Format.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/JsonSchema.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Key.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Obj.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Order.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Query.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/QueryResult.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Ref.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Relation.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/SchemaRegistry.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Tag.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/Type.mjs.map +0 -0
- /package/dist/lib/{browser/chunk-CGS2ULMK.mjs.map → neutral/chunk-J5LGTIGS.mjs.map} +0 -0
- /package/dist/lib/{browser → neutral}/index.mjs.map +0 -0
- /package/dist/lib/{browser → neutral}/internal/index.mjs.map +0 -0
package/src/Obj.ts
CHANGED
|
@@ -2,74 +2,125 @@
|
|
|
2
2
|
// Copyright 2025 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
+
import * as Effect from 'effect/Effect';
|
|
5
6
|
import * as Function from 'effect/Function';
|
|
7
|
+
import * as Option from 'effect/Option';
|
|
6
8
|
import * as Schema from 'effect/Schema';
|
|
7
9
|
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
+
import type { ForeignKey } from '@dxos/echo-protocol';
|
|
11
|
+
import { createJsonPath, getValue as getValue$ } from '@dxos/effect';
|
|
12
|
+
import { assertArgument } from '@dxos/invariant';
|
|
10
13
|
import { type DXN, ObjectId } from '@dxos/keys';
|
|
11
|
-
import {
|
|
12
|
-
import { assumeType, deepMapValues } from '@dxos/util';
|
|
14
|
+
import { assumeType } from '@dxos/util';
|
|
13
15
|
|
|
16
|
+
import type * as Database from './Database';
|
|
14
17
|
import * as Entity from './Entity';
|
|
18
|
+
import * as Err from './Err';
|
|
15
19
|
import {
|
|
16
|
-
type
|
|
20
|
+
type ObjectJSON as APIJSON,
|
|
21
|
+
type AnyEntity,
|
|
17
22
|
type AnyProperties,
|
|
23
|
+
type Comparator as ApiComparator,
|
|
24
|
+
type Meta as ApiMeta,
|
|
25
|
+
type ReadonlyMeta as ApiReadonlyMeta,
|
|
26
|
+
type EntityVersion as ApiVersion,
|
|
27
|
+
type ChangeCallback,
|
|
18
28
|
type InternalObjectProps,
|
|
29
|
+
type KindId,
|
|
19
30
|
MetaId,
|
|
20
|
-
type
|
|
31
|
+
type Mutable,
|
|
21
32
|
type ObjectMeta,
|
|
22
|
-
|
|
33
|
+
// TODO(dmaretskyi): Export ParentId?
|
|
34
|
+
ParentId,
|
|
35
|
+
SnapshotKindId,
|
|
36
|
+
type VersionCompareResult,
|
|
23
37
|
VersionTypeId,
|
|
38
|
+
addTag as addTag$,
|
|
39
|
+
change as change$,
|
|
40
|
+
clone as clone$,
|
|
41
|
+
compareVersions,
|
|
42
|
+
decodeVersion,
|
|
43
|
+
deleteKeys as deleteKeys$,
|
|
44
|
+
encodeVersion,
|
|
45
|
+
getDXN as getDXN$,
|
|
46
|
+
getDatabase as getDatabase$,
|
|
24
47
|
getDescription as getDescription$,
|
|
48
|
+
getKeys as getKeys$,
|
|
25
49
|
getLabel as getLabel$,
|
|
26
|
-
|
|
27
|
-
getObjectDXN,
|
|
50
|
+
getMetaChecked as getMeta$,
|
|
28
51
|
getSchema as getSchema$,
|
|
29
|
-
|
|
52
|
+
getSnapshot as getSnapshot$,
|
|
30
53
|
getTypeAnnotation,
|
|
31
54
|
getTypeDXN as getTypeDXN$,
|
|
55
|
+
getTypename as getTypename$,
|
|
32
56
|
isDeleted as isDeleted$,
|
|
33
57
|
isInstanceOf,
|
|
58
|
+
isVersion,
|
|
34
59
|
makeObject,
|
|
35
60
|
objectFromJSON,
|
|
36
|
-
|
|
61
|
+
removeTag as removeTag$,
|
|
37
62
|
setDescription as setDescription$,
|
|
38
63
|
setLabel as setLabel$,
|
|
64
|
+
setValue as setValue$,
|
|
65
|
+
sort as sort$,
|
|
66
|
+
sortByLabel as sortByLabel$,
|
|
67
|
+
sortByTypename as sortByTypename$,
|
|
68
|
+
subscribe as subscribe$,
|
|
69
|
+
objectToJSON as toJSON$,
|
|
70
|
+
version as version$,
|
|
71
|
+
versionValid,
|
|
39
72
|
} from './internal';
|
|
40
|
-
import * as Ref from './Ref';
|
|
41
|
-
import * as Type from './Type';
|
|
73
|
+
import type * as Ref from './Ref';
|
|
74
|
+
import type * as Type from './Type';
|
|
42
75
|
|
|
43
76
|
/**
|
|
44
77
|
* Base type for all ECHO objects.
|
|
45
|
-
* @private
|
|
46
78
|
*/
|
|
47
|
-
interface BaseObj extends
|
|
79
|
+
interface BaseObj extends AnyEntity, Entity.OfKind<typeof Entity.Kind.Object> {}
|
|
48
80
|
|
|
49
81
|
/**
|
|
50
|
-
*
|
|
82
|
+
* Object type with specific properties.
|
|
51
83
|
*/
|
|
52
|
-
export
|
|
53
|
-
|
|
54
|
-
export const Any = Schema.Struct({}).pipe(
|
|
55
|
-
Type.Obj({
|
|
56
|
-
typename: 'dxos.org/type/Any',
|
|
57
|
-
version: '0.1.0',
|
|
58
|
-
}),
|
|
59
|
-
);
|
|
84
|
+
export type Obj<Props> = BaseObj & Props;
|
|
60
85
|
|
|
61
86
|
/**
|
|
62
|
-
* Object
|
|
87
|
+
* Object with no known properties beyond id and kind.
|
|
88
|
+
* Use this when the object's schema/properties are not known.
|
|
89
|
+
* For objects with arbitrary properties, use `Obj.AnyProps`.
|
|
90
|
+
*
|
|
91
|
+
* NOTE: This is a TypeScript type only, not a schema.
|
|
92
|
+
* To validate that a value is an ECHO object, use `Schema.is(Type.Obj)`.
|
|
63
93
|
*/
|
|
64
|
-
export
|
|
94
|
+
export interface Unknown extends BaseObj {}
|
|
65
95
|
|
|
66
96
|
/**
|
|
67
97
|
* Object with arbitrary properties.
|
|
68
98
|
*
|
|
69
|
-
* NOTE: Due to how
|
|
99
|
+
* NOTE: Due to how TypeScript works, this type is not assignable to a specific schema type.
|
|
70
100
|
* In that case, use `Obj.instanceOf` to check if an object is of a specific type.
|
|
101
|
+
*
|
|
102
|
+
* Prefer using `Obj.Unknown` when you don't need to access arbitrary properties.
|
|
103
|
+
*/
|
|
104
|
+
export interface Any extends BaseObj, AnyProperties {}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Base type for snapshot objects (has SnapshotKindId instead of KindId).
|
|
108
|
+
*/
|
|
109
|
+
interface BaseSnapshot extends AnyEntity {
|
|
110
|
+
readonly [SnapshotKindId]: typeof Entity.Kind.Object;
|
|
111
|
+
readonly id: ObjectId;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Immutable snapshot of an ECHO object.
|
|
116
|
+
* Branded with SnapshotKindId (not KindId).
|
|
117
|
+
* Property values are frozen at the time the snapshot was created.
|
|
118
|
+
* Returned by getSnapshot() and hooks like useObject().
|
|
119
|
+
*
|
|
120
|
+
* Snapshots are structurally identical to reactive objects but have a different brand,
|
|
121
|
+
* making them distinguishable at the TypeScript level. Neither is assignable to the other.
|
|
71
122
|
*/
|
|
72
|
-
export
|
|
123
|
+
export type Snapshot<T extends Unknown = Unknown> = Omit<T, KindId> & BaseSnapshot;
|
|
73
124
|
|
|
74
125
|
const defaultMeta: ObjectMeta = {
|
|
75
126
|
keys: [],
|
|
@@ -81,13 +132,17 @@ type Props<T = any> = {
|
|
|
81
132
|
} & Type.Properties<T>;
|
|
82
133
|
|
|
83
134
|
// TODO(burdon): Should we allow the caller to set the id?
|
|
84
|
-
|
|
135
|
+
/**
|
|
136
|
+
* Props type for object creation with a given schema.
|
|
137
|
+
*/
|
|
138
|
+
export type MakeProps<S extends Schema.Schema.AnyNoContext> = {
|
|
85
139
|
id?: ObjectId;
|
|
86
140
|
[Meta]?: Partial<ObjectMeta>;
|
|
87
|
-
|
|
141
|
+
[Parent]?: Unknown;
|
|
142
|
+
} & NoInfer<Props<Schema.Schema.Type<S>>>;
|
|
88
143
|
|
|
89
144
|
/**
|
|
90
|
-
* Creates a new object of the given
|
|
145
|
+
* Creates a new echo object of the given schema.
|
|
91
146
|
* @param schema - Object schema.
|
|
92
147
|
* @param props - Object properties.
|
|
93
148
|
* @param meta - Object metadata (deprecated) -- pass with Obj.Meta.
|
|
@@ -98,8 +153,16 @@ export type MakeProps<T extends Schema.Schema.AnyNoContext> = {
|
|
|
98
153
|
* ```ts
|
|
99
154
|
* const obj = Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' });
|
|
100
155
|
* ```
|
|
156
|
+
*
|
|
157
|
+
* Note: Only accepts object schemas, not relation schemas. Use `Relation.make` for relations.
|
|
101
158
|
*/
|
|
102
|
-
export const make
|
|
159
|
+
export const make: {
|
|
160
|
+
<S extends Type.Obj.Any>(schema: S, props: MakeProps<S>): Obj<Schema.Schema.Type<S>>;
|
|
161
|
+
/**
|
|
162
|
+
* @deprecated Pass meta as in the example: `Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' })`.
|
|
163
|
+
*/
|
|
164
|
+
<S extends Type.Obj.Any>(schema: S, props: MakeProps<S>, meta: Partial<ObjectMeta>): Obj<Schema.Schema.Type<S>>;
|
|
165
|
+
} = <S extends Type.Obj.Any>(
|
|
103
166
|
schema: S,
|
|
104
167
|
props: MakeProps<S>,
|
|
105
168
|
meta?: Partial<ObjectMeta>,
|
|
@@ -112,8 +175,16 @@ export const make = <S extends Schema.Schema.AnyNoContext>(
|
|
|
112
175
|
delete props[MetaId];
|
|
113
176
|
}
|
|
114
177
|
|
|
115
|
-
// Filter undefined values.
|
|
116
|
-
const filterUndefined = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
|
|
178
|
+
// Filter undefined values (Object.entries only returns string-keyed properties).
|
|
179
|
+
const filterUndefined: any = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
|
|
180
|
+
|
|
181
|
+
// Copy symbol properties (like ParentId) that Object.entries doesn't include.
|
|
182
|
+
for (const sym of Object.getOwnPropertySymbols(props)) {
|
|
183
|
+
const value = (props as any)[sym];
|
|
184
|
+
if (value !== undefined) {
|
|
185
|
+
filterUndefined[sym] = value;
|
|
186
|
+
}
|
|
187
|
+
}
|
|
117
188
|
|
|
118
189
|
return makeObject<Schema.Schema.Type<S>>(schema, filterUndefined as any, {
|
|
119
190
|
...defaultMeta,
|
|
@@ -124,19 +195,85 @@ export const make = <S extends Schema.Schema.AnyNoContext>(
|
|
|
124
195
|
/**
|
|
125
196
|
* Determine if object is an ECHO object.
|
|
126
197
|
*/
|
|
127
|
-
export const isObject = (obj: unknown): obj is
|
|
198
|
+
export const isObject = (obj: unknown): obj is Unknown => {
|
|
128
199
|
assumeType<InternalObjectProps>(obj);
|
|
129
200
|
return typeof obj === 'object' && obj !== null && obj[Entity.KindId] === Entity.Kind.Object;
|
|
130
201
|
};
|
|
131
202
|
|
|
203
|
+
/**
|
|
204
|
+
* Subscribe to object updates.
|
|
205
|
+
* The callback is called synchronously when the object is modified.
|
|
206
|
+
* Only accepts reactive objects (not snapshots).
|
|
207
|
+
* @returns Unsubscribe function.
|
|
208
|
+
*/
|
|
209
|
+
export const subscribe = (obj: Unknown, callback: () => void): (() => void) => {
|
|
210
|
+
return subscribe$(obj, callback);
|
|
211
|
+
};
|
|
212
|
+
|
|
132
213
|
//
|
|
133
214
|
// Snapshot
|
|
134
215
|
//
|
|
135
216
|
|
|
136
217
|
/**
|
|
137
218
|
* Returns an immutable snapshot of an object.
|
|
219
|
+
* The snapshot is branded with SnapshotKindId instead of KindId,
|
|
220
|
+
* making it distinguishable from the reactive object at the type level.
|
|
138
221
|
*/
|
|
139
|
-
export const getSnapshot: <T extends
|
|
222
|
+
export const getSnapshot: <T extends Unknown>(obj: T) => Snapshot<T> = getSnapshot$ as any;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Returns the reactive version of an object from the database, given its snapshot.
|
|
226
|
+
* Inverse of `Obj.getSnapshot`.
|
|
227
|
+
*
|
|
228
|
+
* Uses `Obj.getDatabase` internally to get the database from the snapshot,
|
|
229
|
+
* then resolves the reactive object by ID.
|
|
230
|
+
*
|
|
231
|
+
* @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
|
|
232
|
+
* @returns Effect that succeeds with the reactive object, or fails with `GetReactiveError`.
|
|
233
|
+
* @example
|
|
234
|
+
* ```ts
|
|
235
|
+
* const snapshot = Obj.getSnapshot(obj);
|
|
236
|
+
* const reactive = Obj.getReactive(snapshot).pipe(
|
|
237
|
+
* Effect.runSync
|
|
238
|
+
* );
|
|
239
|
+
* ```
|
|
240
|
+
*/
|
|
241
|
+
export const getReactive = <T extends Unknown>(snapshot: Snapshot<T>): Effect.Effect<T, Err.GetReactiveError> =>
|
|
242
|
+
Effect.gen(function* () {
|
|
243
|
+
const db = getDatabase$(snapshot);
|
|
244
|
+
if (!db) {
|
|
245
|
+
return yield* Effect.fail(new Err.GetReactiveError({ reason: 'no-database', snapshotId: snapshot.id }));
|
|
246
|
+
}
|
|
247
|
+
const obj = db.getObjectById(snapshot.id);
|
|
248
|
+
if (!obj) {
|
|
249
|
+
return yield* Effect.fail(new Err.GetReactiveError({ reason: 'object-not-found', snapshotId: snapshot.id }));
|
|
250
|
+
}
|
|
251
|
+
return obj as T;
|
|
252
|
+
});
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Like `Obj.getReactive` but returns `Option.none()` instead of failing when the object
|
|
256
|
+
* cannot be resolved (no database, object not found).
|
|
257
|
+
*
|
|
258
|
+
* @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
|
|
259
|
+
* @returns Effect that succeeds with `Option.some(reactive)` or `Option.none()`.
|
|
260
|
+
*/
|
|
261
|
+
export const getReactiveOption = <T extends Unknown>(snapshot: Snapshot<T>): Effect.Effect<Option.Option<T>, never> =>
|
|
262
|
+
getReactive(snapshot).pipe(
|
|
263
|
+
Effect.map(Option.some),
|
|
264
|
+
Effect.catchAll(() => Effect.succeed(Option.none())),
|
|
265
|
+
);
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Synchronous version of `Obj.getReactive`. Returns the reactive object or throws
|
|
269
|
+
* `GetReactiveError` when the object cannot be resolved (no database, object not found).
|
|
270
|
+
*
|
|
271
|
+
* @param snapshot - A snapshot of the object (from `Obj.getSnapshot`).
|
|
272
|
+
* @returns The reactive object.
|
|
273
|
+
* @throws {Err.GetReactiveError} When the object cannot be resolved.
|
|
274
|
+
*/
|
|
275
|
+
export const getReactiveOrThrow = <T extends Unknown>(snapshot: Snapshot<T>): T =>
|
|
276
|
+
Effect.runSync(getReactive(snapshot));
|
|
140
277
|
|
|
141
278
|
export type CloneOptions = {
|
|
142
279
|
/**
|
|
@@ -144,6 +281,12 @@ export type CloneOptions = {
|
|
|
144
281
|
* @default false
|
|
145
282
|
*/
|
|
146
283
|
retainId?: boolean;
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Recursively clone referenced objects.
|
|
287
|
+
* @default false
|
|
288
|
+
*/
|
|
289
|
+
deep?: boolean;
|
|
147
290
|
};
|
|
148
291
|
|
|
149
292
|
/**
|
|
@@ -151,31 +294,107 @@ export type CloneOptions = {
|
|
|
151
294
|
* This does not clone referenced objects, only the properties in the object.
|
|
152
295
|
* @returns A new object with the same schema and properties.
|
|
153
296
|
*/
|
|
154
|
-
export const clone
|
|
155
|
-
const { id, ...data } = obj;
|
|
156
|
-
const schema = getSchema$(obj);
|
|
157
|
-
invariant(schema != null, 'Object should have a schema');
|
|
158
|
-
const props: any = deepMapValues(data, (value, recurse) => {
|
|
159
|
-
if (Ref.isRef(value)) {
|
|
160
|
-
return value;
|
|
161
|
-
}
|
|
162
|
-
return recurse(value);
|
|
163
|
-
});
|
|
297
|
+
export const clone: <T extends Unknown>(obj: T, opts?: CloneOptions) => T = clone$;
|
|
164
298
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
const meta = getMeta(obj);
|
|
169
|
-
props[MetaId] = deepMapValues(meta, (value, recurse) => {
|
|
170
|
-
if (Ref.isRef(value)) {
|
|
171
|
-
return value;
|
|
172
|
-
}
|
|
173
|
-
return recurse(value);
|
|
174
|
-
});
|
|
299
|
+
//
|
|
300
|
+
// Change
|
|
301
|
+
//
|
|
175
302
|
|
|
176
|
-
|
|
303
|
+
/**
|
|
304
|
+
* Makes all properties mutable recursively.
|
|
305
|
+
* Used to provide a mutable view of an object within `Obj.change`.
|
|
306
|
+
*/
|
|
307
|
+
export type { Mutable };
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Perform mutations on an echo object within a controlled context.
|
|
311
|
+
*
|
|
312
|
+
* All mutations within the callback are batched and trigger a single notification
|
|
313
|
+
* when the callback completes. Direct mutations outside of `Obj.change` will throw
|
|
314
|
+
* an error for echo objects.
|
|
315
|
+
*
|
|
316
|
+
* This function also works with nested objects within echo objects (e.g., Template structs)
|
|
317
|
+
* that are reactive at runtime.
|
|
318
|
+
*
|
|
319
|
+
* @param obj - The echo object to mutate. Use `Relation.change` for relations.
|
|
320
|
+
* @param callback - The callback that performs mutations on the object.
|
|
321
|
+
*
|
|
322
|
+
* @example
|
|
323
|
+
* ```ts
|
|
324
|
+
* const person = Obj.make(Person, { name: 'John', age: 25 });
|
|
325
|
+
*
|
|
326
|
+
* // Mutate within Obj.change
|
|
327
|
+
* Obj.change(person, (p) => {
|
|
328
|
+
* p.name = 'Jane';
|
|
329
|
+
* p.age = 30;
|
|
330
|
+
* });
|
|
331
|
+
* // ONE notification fires here
|
|
332
|
+
*
|
|
333
|
+
* // Direct mutation throws
|
|
334
|
+
* person.name = 'Bob'; // Error: Cannot modify outside Obj.change()
|
|
335
|
+
* ```
|
|
336
|
+
*
|
|
337
|
+
* Note: Only accepts objects. Use `Relation.change` for relations.
|
|
338
|
+
*/
|
|
339
|
+
export const change = <T extends Unknown>(obj: T, callback: ChangeCallback<T>): void => {
|
|
340
|
+
change$(obj, callback);
|
|
177
341
|
};
|
|
178
342
|
|
|
343
|
+
/**
|
|
344
|
+
* Get a deeply nested property from an object.
|
|
345
|
+
*
|
|
346
|
+
* Similar to lodash.get and getDeep from @dxos/util.
|
|
347
|
+
* This is the complementary function to setValue.
|
|
348
|
+
* Accepts both reactive objects and snapshots.
|
|
349
|
+
*
|
|
350
|
+
* @param obj - The ECHO object to get the property from.
|
|
351
|
+
* @param path - Path to the property (array of keys).
|
|
352
|
+
* @returns The value at the path, or undefined if not found.
|
|
353
|
+
*
|
|
354
|
+
* @example
|
|
355
|
+
* ```ts
|
|
356
|
+
* const person = Obj.make(Person, {
|
|
357
|
+
* name: 'John',
|
|
358
|
+
* addresses: [{ street: '123 Main St' }]
|
|
359
|
+
* });
|
|
360
|
+
*
|
|
361
|
+
* Obj.getValue(person, ['addresses', 0, 'street']); // '123 Main St'
|
|
362
|
+
* Obj.getValue(person, ['addresses', 1, 'street']); // undefined
|
|
363
|
+
* ```
|
|
364
|
+
*/
|
|
365
|
+
export const getValue = (obj: Unknown | Snapshot, path: readonly (string | number)[]): any => {
|
|
366
|
+
return getValue$(obj, createJsonPath(path));
|
|
367
|
+
};
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* Set a deeply nested property on an object, using the object's schema to determine
|
|
371
|
+
* whether to initialize nested data as an empty object or array.
|
|
372
|
+
*
|
|
373
|
+
* Similar to lodash.set and setDeep from @dxos/util, but schema-aware.
|
|
374
|
+
* Must be called within an `Obj.change` callback.
|
|
375
|
+
*
|
|
376
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
377
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
378
|
+
*
|
|
379
|
+
* @param obj - The mutable ECHO object to set the property on.
|
|
380
|
+
* @param path - Path to the property (array of keys).
|
|
381
|
+
* @param value - Value to set.
|
|
382
|
+
* @returns The value that was set.
|
|
383
|
+
*
|
|
384
|
+
* @example
|
|
385
|
+
* ```ts
|
|
386
|
+
* const person = Obj.make(Person, { name: 'John' });
|
|
387
|
+
* // Person schema has: addresses: Schema.Array(Address)
|
|
388
|
+
* Obj.change(person, (p) => {
|
|
389
|
+
* Obj.setValue(p, ['addresses', 0, 'street'], '123 Main St');
|
|
390
|
+
* });
|
|
391
|
+
* // Creates: person.addresses = [{ street: '123 Main St' }]
|
|
392
|
+
* ```
|
|
393
|
+
*/
|
|
394
|
+
// TODO(wittjosiah): Compute possible path values + type value based on generic object type.
|
|
395
|
+
export const setValue: (obj: Mutable<Unknown>, path: readonly (string | number)[], value: any) => void =
|
|
396
|
+
setValue$ as any;
|
|
397
|
+
|
|
179
398
|
//
|
|
180
399
|
// Type
|
|
181
400
|
//
|
|
@@ -206,39 +425,74 @@ export const instanceOf: {
|
|
|
206
425
|
return isInstanceOf(args[0], args[1]);
|
|
207
426
|
}) as any;
|
|
208
427
|
|
|
428
|
+
/**
|
|
429
|
+
* Test if a snapshot is an instance of a schema.
|
|
430
|
+
* Mirrors `instanceOf` but only accepts values branded with SnapshotKindId.
|
|
431
|
+
* Use when the value is known to be a snapshot (e.g. from `getSnapshot` or `useObject`).
|
|
432
|
+
*
|
|
433
|
+
* @example
|
|
434
|
+
* ```ts
|
|
435
|
+
* const snapshot = Obj.getSnapshot(person);
|
|
436
|
+
* if (Obj.snapshotOf(Person, snapshot)) {
|
|
437
|
+
* // snapshot is Obj.Snapshot<Person>
|
|
438
|
+
* }
|
|
439
|
+
* ```
|
|
440
|
+
*/
|
|
441
|
+
export const snapshotOf: {
|
|
442
|
+
<S extends Type.Entity.Any>(schema: S): (value: unknown) => value is Snapshot<Schema.Schema.Type<S>>;
|
|
443
|
+
<S extends Type.Entity.Any>(schema: S, value: unknown): value is Snapshot<Schema.Schema.Type<S>>;
|
|
444
|
+
} = ((...args: [schema: Type.Entity.Any, value: unknown] | [schema: Type.Entity.Any]) => {
|
|
445
|
+
const check = (entity: unknown) =>
|
|
446
|
+
entity != null && typeof entity === 'object' && SnapshotKindId in entity && isInstanceOf(args[0], entity);
|
|
447
|
+
|
|
448
|
+
if (args.length === 1) {
|
|
449
|
+
return (entity: unknown) => check(entity);
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
return check(args[1]);
|
|
453
|
+
}) as any;
|
|
454
|
+
|
|
209
455
|
// TODO(dmaretskyi): Allow returning undefined.
|
|
210
|
-
|
|
456
|
+
/**
|
|
457
|
+
* Get the DXN of the object.
|
|
458
|
+
* Accepts both reactive objects and snapshots.
|
|
459
|
+
*/
|
|
460
|
+
export const getDXN = (entity: Unknown | Snapshot): DXN => {
|
|
211
461
|
assertArgument(!Schema.isSchema(entity), 'obj', 'Object should not be a schema.');
|
|
212
|
-
|
|
213
|
-
invariant(dxn != null, 'Invalid object.');
|
|
214
|
-
return dxn;
|
|
462
|
+
return getDXN$(entity);
|
|
215
463
|
};
|
|
216
464
|
|
|
217
465
|
/**
|
|
218
466
|
* @returns The DXN of the object's type.
|
|
219
467
|
* @example dxn:example.com/type/Person:1.0.0
|
|
220
468
|
*/
|
|
221
|
-
// TODO(
|
|
222
|
-
export const getTypeDXN = getTypeDXN
|
|
469
|
+
// TODO(wittjosiah): Narrow types.
|
|
470
|
+
export const getTypeDXN: (obj: unknown | undefined) => DXN | undefined = getTypeDXN$ as any;
|
|
223
471
|
|
|
224
472
|
/**
|
|
225
473
|
* Get the schema of the object.
|
|
474
|
+
* Returns the branded ECHO schema used to create the object.
|
|
226
475
|
*/
|
|
227
|
-
|
|
476
|
+
// TODO(wittjosiah): Narrow types.
|
|
477
|
+
export const getSchema: (obj: unknown | undefined) => Type.Entity.Any | undefined = getSchema$ as any;
|
|
228
478
|
|
|
229
479
|
/**
|
|
230
480
|
* @returns The typename of the object's type.
|
|
481
|
+
* Accepts both reactive objects and snapshots.
|
|
231
482
|
* @example `example.com/type/Person`
|
|
232
483
|
*/
|
|
233
|
-
export const getTypename = (entity:
|
|
234
|
-
const schema = getSchema$(entity);
|
|
235
|
-
if (schema == null) {
|
|
236
|
-
// Try to extract typename from DXN.
|
|
237
|
-
return getTypeDXN$(entity)?.asTypeDXN()?.type;
|
|
238
|
-
}
|
|
484
|
+
export const getTypename = (entity: Unknown | Snapshot): string | undefined => getTypename$(entity);
|
|
239
485
|
|
|
240
|
-
|
|
241
|
-
|
|
486
|
+
//
|
|
487
|
+
// Database
|
|
488
|
+
//
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Get the database the object belongs to.
|
|
492
|
+
* Accepts both reactive objects and snapshots.
|
|
493
|
+
*/
|
|
494
|
+
export const getDatabase = (entity: Entity.Unknown | Entity.Snapshot): Database.Database | undefined =>
|
|
495
|
+
getDatabase$(entity);
|
|
242
496
|
|
|
243
497
|
//
|
|
244
498
|
// Meta
|
|
@@ -246,97 +500,157 @@ export const getTypename = (entity: Entity.Unknown): string | undefined => {
|
|
|
246
500
|
|
|
247
501
|
export const Meta: unique symbol = MetaId as any;
|
|
248
502
|
|
|
503
|
+
/**
|
|
504
|
+
* Deeply read-only version of ObjectMeta.
|
|
505
|
+
* Prevents mutation at all nesting levels (e.g., `meta.keys.push()` is a TypeScript error).
|
|
506
|
+
*/
|
|
507
|
+
export type ReadonlyMeta = ApiReadonlyMeta;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Mutable meta type returned by `Obj.getMeta` inside an `Obj.change` callback.
|
|
511
|
+
*/
|
|
512
|
+
export type Meta = ApiMeta;
|
|
513
|
+
|
|
249
514
|
// TODO(burdon): Narrow type.
|
|
250
515
|
// TODO(dmaretskyi): Allow returning undefined.
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
516
|
+
/**
|
|
517
|
+
* Get the metadata for an object.
|
|
518
|
+
* Returns mutable meta when passed a mutable object (inside `Obj.change` callback).
|
|
519
|
+
* Returns read-only meta when passed a regular object or snapshot.
|
|
520
|
+
*
|
|
521
|
+
* @example
|
|
522
|
+
* ```ts
|
|
523
|
+
* // Read-only access outside change callback
|
|
524
|
+
* const meta = Obj.getMeta(person); // ReadonlyMeta
|
|
525
|
+
*
|
|
526
|
+
* // Mutable access inside change callback
|
|
527
|
+
* Obj.change(person, (p) => {
|
|
528
|
+
* const meta = Obj.getMeta(p); // ObjectMeta (mutable)
|
|
529
|
+
* meta.tags ??= [];
|
|
530
|
+
* meta.tags.push('important');
|
|
531
|
+
* });
|
|
532
|
+
* ```
|
|
533
|
+
*/
|
|
534
|
+
// TODO(wittjosiah): When passed a Snapshot, should return a snapshot of meta, not the live meta proxy.
|
|
535
|
+
export function getMeta(entity: Mutable<Unknown>): Meta;
|
|
536
|
+
export function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
|
|
537
|
+
export function getMeta(entity: Unknown | Snapshot | Mutable<Unknown>): Meta | ReadonlyMeta {
|
|
538
|
+
return getMeta$(entity);
|
|
539
|
+
}
|
|
256
540
|
|
|
257
541
|
/**
|
|
258
542
|
* @returns Foreign keys for the object from the specified source.
|
|
543
|
+
* Accepts both reactive objects and snapshots.
|
|
259
544
|
*/
|
|
260
545
|
export const getKeys: {
|
|
261
|
-
(entity:
|
|
262
|
-
(source: string): (entity:
|
|
263
|
-
} = Function.dual(2, (entity:
|
|
264
|
-
const meta = getMeta(entity);
|
|
265
|
-
invariant(meta != null, 'Invalid object.');
|
|
266
|
-
return meta.keys.filter((key) => key.source === source);
|
|
267
|
-
});
|
|
546
|
+
(entity: Unknown | Snapshot, source: string): ForeignKey[];
|
|
547
|
+
(source: string): (entity: Unknown | Snapshot) => ForeignKey[];
|
|
548
|
+
} = Function.dual(2, (entity: Unknown | Snapshot, source?: string): ForeignKey[] => getKeys$(entity, source!));
|
|
268
549
|
|
|
269
550
|
/**
|
|
270
551
|
* Delete all keys from the object for the specified source.
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
if (meta.keys[i].source === source) {
|
|
278
|
-
meta.keys.splice(i, 1);
|
|
279
|
-
i--;
|
|
280
|
-
}
|
|
281
|
-
}
|
|
282
|
-
};
|
|
552
|
+
* Must be called within an `Obj.change` callback.
|
|
553
|
+
*
|
|
554
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
555
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
556
|
+
*/
|
|
557
|
+
export const deleteKeys = (entity: Mutable<Unknown>, source: string): void => deleteKeys$(entity, source);
|
|
283
558
|
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
559
|
+
/**
|
|
560
|
+
* Add a tag to the object.
|
|
561
|
+
* Must be called within an `Obj.change` callback.
|
|
562
|
+
*
|
|
563
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
564
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
565
|
+
*/
|
|
566
|
+
export const addTag = (entity: Mutable<Unknown>, tag: string): void => addTag$(entity, tag);
|
|
289
567
|
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
i--;
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
};
|
|
568
|
+
/**
|
|
569
|
+
* Remove a tag from the object.
|
|
570
|
+
* Must be called within an `Obj.change` callback.
|
|
571
|
+
*
|
|
572
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
573
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
574
|
+
*/
|
|
575
|
+
export const removeTag = (entity: Mutable<Unknown>, tag: string): void => removeTag$(entity, tag);
|
|
302
576
|
|
|
577
|
+
/**
|
|
578
|
+
* Check if the object is deleted.
|
|
579
|
+
* Accepts both reactive objects and snapshots.
|
|
580
|
+
*/
|
|
303
581
|
// TODO(dmaretskyi): Default to `false`.
|
|
304
|
-
export const isDeleted = (entity:
|
|
305
|
-
const deleted = isDeleted$(entity);
|
|
306
|
-
invariant(typeof deleted === 'boolean', 'Invalid object.');
|
|
307
|
-
return deleted;
|
|
308
|
-
};
|
|
582
|
+
export const isDeleted = (entity: Unknown | Snapshot): boolean => isDeleted$(entity);
|
|
309
583
|
|
|
310
584
|
//
|
|
311
585
|
// Annotations
|
|
312
586
|
//
|
|
313
587
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
};
|
|
588
|
+
/**
|
|
589
|
+
* Get the label of the object.
|
|
590
|
+
* Accepts both reactive objects and snapshots.
|
|
591
|
+
*/
|
|
592
|
+
export const getLabel = (entity: Unknown | Snapshot): string | undefined => getLabel$(entity);
|
|
320
593
|
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
594
|
+
/**
|
|
595
|
+
* Set the label of the object.
|
|
596
|
+
* Must be called within an `Obj.change` callback.
|
|
597
|
+
*
|
|
598
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
599
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
600
|
+
*/
|
|
601
|
+
export const setLabel = (entity: Mutable<Unknown>, label: string): void => setLabel$(entity, label);
|
|
327
602
|
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
603
|
+
/**
|
|
604
|
+
* Get the description of the object.
|
|
605
|
+
* Accepts both reactive objects and snapshots.
|
|
606
|
+
*/
|
|
607
|
+
export const getDescription = (entity: Unknown | Snapshot): string | undefined => getDescription$(entity);
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Set the description of the object.
|
|
611
|
+
* Must be called within an `Obj.change` callback.
|
|
612
|
+
*
|
|
613
|
+
* NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
|
|
614
|
+
* parameters, so there is no compile-time error. Enforcement is runtime-only.
|
|
615
|
+
*/
|
|
616
|
+
export const setDescription = (entity: Mutable<Unknown>, description: string): void =>
|
|
617
|
+
setDescription$(entity, description);
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* Symbol to set parent when creating objects with `Obj.make`.
|
|
621
|
+
* @example
|
|
622
|
+
* ```ts
|
|
623
|
+
* Obj.make(TestSchema.Person, {
|
|
624
|
+
* [Obj.Parent]: parentObject,
|
|
625
|
+
* name: 'John',
|
|
626
|
+
* })
|
|
627
|
+
* ```
|
|
628
|
+
*/
|
|
629
|
+
export const Parent: unique symbol = ParentId as any;
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* Get the parent of an object.
|
|
633
|
+
* The parent is always loaded together with the object.
|
|
634
|
+
* Only objects are allowed to have a parent
|
|
635
|
+
* @returns The parent object, or undefined if the object has no parent.
|
|
636
|
+
*/
|
|
637
|
+
export const getParent = (entity: Unknown | Snapshot): Unknown | undefined => {
|
|
638
|
+
assertArgument(isObject(entity), 'Expected an object');
|
|
639
|
+
assumeType<InternalObjectProps>(entity);
|
|
640
|
+
return entity[ParentId] as Unknown | undefined;
|
|
333
641
|
};
|
|
334
642
|
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
643
|
+
/**
|
|
644
|
+
* Sets the parent of an object.
|
|
645
|
+
* If a parent (or any transitive parent) is deleted, the object will be deleted.
|
|
646
|
+
* Only objects are allowed to have a parent.
|
|
647
|
+
*/
|
|
648
|
+
export const setParent = (entity: Unknown, parent: Any | undefined) => {
|
|
649
|
+
assertArgument(isObject(entity), 'Expected an object');
|
|
650
|
+
assertArgument(parent === undefined || isObject(parent), 'Expected an object');
|
|
651
|
+
assumeType<InternalObjectProps>(entity);
|
|
652
|
+
assumeType<InternalObjectProps | undefined>(parent);
|
|
653
|
+
entity[ParentId] = parent;
|
|
340
654
|
};
|
|
341
655
|
|
|
342
656
|
//
|
|
@@ -346,14 +660,15 @@ export const setDescription = (entity: Entity.Unknown, description: string) => {
|
|
|
346
660
|
/**
|
|
347
661
|
* JSON representation of an object.
|
|
348
662
|
*/
|
|
349
|
-
export type JSON =
|
|
663
|
+
export type JSON = APIJSON;
|
|
350
664
|
|
|
351
665
|
/**
|
|
352
666
|
* Converts object to its JSON representation.
|
|
667
|
+
* Accepts both reactive objects and snapshots.
|
|
353
668
|
*
|
|
354
669
|
* The same algorithm is used when calling the standard `JSON.stringify(obj)` function.
|
|
355
670
|
*/
|
|
356
|
-
export const toJSON = (entity:
|
|
671
|
+
export const toJSON = (entity: Unknown | Snapshot): JSON => toJSON$(entity);
|
|
357
672
|
|
|
358
673
|
/**
|
|
359
674
|
* Creates an object from its json representation, performing schema validation.
|
|
@@ -364,135 +679,37 @@ export const toJSON = (entity: Entity.Unknown): JSON => objectToJSON(entity);
|
|
|
364
679
|
* @param options.refResolver - Resolver for references. Produces hydrated references that can be resolved.
|
|
365
680
|
* @param options.dxn - Override object DXN. Changes the result of `Obj.getDXN`.
|
|
366
681
|
*/
|
|
367
|
-
export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver; dxn?: DXN }) => Promise<
|
|
682
|
+
export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver; dxn?: DXN }) => Promise<Unknown> =
|
|
368
683
|
objectFromJSON as any;
|
|
369
684
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
if (a == null) {
|
|
376
|
-
return b == null ? 0 : 1;
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
if (b == null) {
|
|
380
|
-
return -1;
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
return a.localeCompare(b);
|
|
384
|
-
};
|
|
385
|
-
|
|
386
|
-
export type Comparator = (a: Entity.Unknown, b: Entity.Unknown) => number;
|
|
387
|
-
|
|
388
|
-
export const sortByLabel: Comparator = (a: Entity.Unknown, b: Entity.Unknown) => compare(getLabel(a), getLabel(b));
|
|
389
|
-
export const sortByTypename: Comparator = (a: Entity.Unknown, b: Entity.Unknown) =>
|
|
390
|
-
compare(getTypename(a), getTypename(b));
|
|
391
|
-
export const sort = (...comparators: Comparator[]): Comparator => {
|
|
392
|
-
return (a: Entity.Unknown, b: Entity.Unknown) => {
|
|
393
|
-
for (const comparator of comparators) {
|
|
394
|
-
const result = comparator(a, b);
|
|
395
|
-
if (result !== 0) {
|
|
396
|
-
return result;
|
|
397
|
-
}
|
|
398
|
-
}
|
|
685
|
+
/**
|
|
686
|
+
* Comparator function type for sorting objects.
|
|
687
|
+
* Accepts both reactive objects and snapshots.
|
|
688
|
+
*/
|
|
689
|
+
export type Comparator = ApiComparator<Unknown | Snapshot>;
|
|
399
690
|
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
691
|
+
export const sortByLabel: Comparator = sortByLabel$ as Comparator;
|
|
692
|
+
export const sortByTypename: Comparator = sortByTypename$ as Comparator;
|
|
693
|
+
export const sort = (...comparators: Comparator[]): Comparator => sort$(...comparators) as Comparator;
|
|
403
694
|
|
|
404
695
|
//
|
|
405
696
|
// Version
|
|
406
697
|
//
|
|
407
698
|
|
|
408
|
-
/**
|
|
409
|
-
* Unique symbol for version type identification.
|
|
410
|
-
*/
|
|
411
699
|
export { VersionTypeId };
|
|
700
|
+
export type { VersionCompareResult };
|
|
412
701
|
|
|
413
702
|
/**
|
|
414
703
|
* Represent object version.
|
|
415
704
|
* May be backed by Automerge.
|
|
416
705
|
* Objects with no history are not versioned.
|
|
417
706
|
*/
|
|
418
|
-
export
|
|
419
|
-
[VersionTypeId]: {};
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* Whether the object is versioned.
|
|
423
|
-
*/
|
|
424
|
-
versioned: boolean;
|
|
425
|
-
|
|
426
|
-
/**
|
|
427
|
-
* Automerge heads.
|
|
428
|
-
*/
|
|
429
|
-
automergeHeads?: string[];
|
|
430
|
-
}
|
|
707
|
+
export type Version = ApiVersion;
|
|
431
708
|
|
|
432
|
-
|
|
433
|
-
[VersionTypeId]: {},
|
|
434
|
-
versioned: false,
|
|
435
|
-
};
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* Checks that `obj` is a version object.
|
|
439
|
-
*/
|
|
440
|
-
export const isVersion = (entity: unknown): entity is Version => {
|
|
441
|
-
return entity != null && typeof entity === 'object' && VersionTypeId in entity;
|
|
442
|
-
};
|
|
709
|
+
export { isVersion, versionValid, compareVersions, encodeVersion, decodeVersion };
|
|
443
710
|
|
|
444
711
|
/**
|
|
445
712
|
* Returns the version of the object.
|
|
713
|
+
* Accepts both reactive objects and snapshots.
|
|
446
714
|
*/
|
|
447
|
-
export const version = (entity:
|
|
448
|
-
const version = (entity as any)[ObjectVersionId];
|
|
449
|
-
if (version === undefined) {
|
|
450
|
-
return unversioned;
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
return version;
|
|
454
|
-
};
|
|
455
|
-
|
|
456
|
-
/**
|
|
457
|
-
* Checks that `version` is a valid version object.
|
|
458
|
-
*/
|
|
459
|
-
export const versionValid = (version: Version): boolean => {
|
|
460
|
-
assertArgument(isVersion(version), 'version', 'Invalid version object');
|
|
461
|
-
return !!version.versioned;
|
|
462
|
-
};
|
|
463
|
-
|
|
464
|
-
export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
|
|
465
|
-
|
|
466
|
-
/**
|
|
467
|
-
* Compares two versions.
|
|
468
|
-
* @param version1
|
|
469
|
-
* @param version2
|
|
470
|
-
* @returns 'unversioned' if either object is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
|
|
471
|
-
*/
|
|
472
|
-
export const compareVersions = (version1: Version, version2: Version): VersionCompareResult => {
|
|
473
|
-
assertArgument(isVersion(version1), 'version1', 'Invalid version object');
|
|
474
|
-
assertArgument(isVersion(version2), 'version2', 'Invalid version object');
|
|
475
|
-
|
|
476
|
-
if (!versionValid(version1) || !versionValid(version2)) {
|
|
477
|
-
return 'unversioned';
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
if (version1.automergeHeads?.length !== version2.automergeHeads?.length) {
|
|
481
|
-
return 'different';
|
|
482
|
-
}
|
|
483
|
-
if (version1.automergeHeads?.some((head) => !version2.automergeHeads?.includes(head))) {
|
|
484
|
-
return 'different';
|
|
485
|
-
}
|
|
486
|
-
|
|
487
|
-
return 'equal';
|
|
488
|
-
};
|
|
489
|
-
|
|
490
|
-
export const encodeVersion = (version: Version): string => {
|
|
491
|
-
return JSON.stringify(version);
|
|
492
|
-
};
|
|
493
|
-
|
|
494
|
-
export const decodeVersion = (version: string): Version => {
|
|
495
|
-
const parsed = JSON.parse(version);
|
|
496
|
-
parsed[VersionTypeId] = {};
|
|
497
|
-
return parsed;
|
|
498
|
-
};
|
|
715
|
+
export const version = (entity: Unknown | Snapshot): Version => version$(entity);
|