@dxos/echo 0.8.4-main.9be5663bfe → 0.8.4-main.abd8ff62ef
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/dist/lib/neutral/Annotation.mjs +3 -3
- package/dist/lib/neutral/Database.mjs +6 -4
- package/dist/lib/neutral/Entity.mjs +16 -14
- package/dist/lib/neutral/Err.mjs +1 -1
- package/dist/lib/neutral/Extension.mjs +1 -1
- package/dist/lib/neutral/Feed.mjs +19 -17
- package/dist/lib/neutral/Filter.mjs +11 -11
- package/dist/lib/neutral/Format.mjs +3 -3
- package/dist/lib/neutral/JsonSchema.mjs +8 -8
- package/dist/lib/neutral/Key.mjs +1 -1
- package/dist/lib/neutral/Migration.mjs +17 -0
- package/dist/lib/neutral/Migration.mjs.map +7 -0
- package/dist/lib/neutral/Obj.mjs +14 -14
- package/dist/lib/neutral/Order.mjs +1 -1
- package/dist/lib/neutral/Query.mjs +17 -17
- package/dist/lib/neutral/QueryResult.mjs +1 -1
- package/dist/lib/neutral/Ref.mjs +7 -7
- package/dist/lib/neutral/Relation.mjs +15 -15
- package/dist/lib/neutral/SchemaRegistry.mjs +1 -1
- package/dist/lib/neutral/Tag.mjs +14 -14
- package/dist/lib/neutral/Type.mjs +10 -10
- package/dist/lib/neutral/{chunk-7SQD3FRZ.mjs → chunk-2T22UGGN.mjs} +59 -12
- package/dist/lib/neutral/chunk-2T22UGGN.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-GZQTCRJB.mjs → chunk-44HT3MEC.mjs} +2 -2
- package/dist/lib/neutral/{chunk-WVLOCXB5.mjs → chunk-6VC3FI5E.mjs} +12 -8
- package/dist/lib/neutral/chunk-6VC3FI5E.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-HBJ7JT5A.mjs → chunk-7JFW72MX.mjs} +17 -5
- package/dist/lib/neutral/chunk-7JFW72MX.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-ANHVGJI4.mjs → chunk-7RVZT53K.mjs} +1 -1
- package/dist/lib/neutral/{chunk-BNCCGLJN.mjs → chunk-BICZKPQG.mjs} +1 -1
- package/dist/lib/neutral/chunk-CIWZ5MHQ.mjs +36 -0
- package/dist/lib/neutral/chunk-CIWZ5MHQ.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-OLFCVPOO.mjs → chunk-DUNXPKAC.mjs} +4 -4
- package/dist/lib/neutral/{chunk-R72KFH2X.mjs → chunk-FAW7PJRO.mjs} +2 -2
- package/dist/lib/neutral/{chunk-E5PBQJWV.mjs → chunk-FAYW32CW.mjs} +2 -2
- package/dist/lib/neutral/{chunk-YS6Q3XAD.mjs → chunk-GWFFC34K.mjs} +1 -1
- package/dist/lib/neutral/{chunk-YS6Q3XAD.mjs.map → chunk-GWFFC34K.mjs.map} +1 -1
- package/dist/lib/neutral/{chunk-T2JOLN37.mjs → chunk-I2MFJ76N.mjs} +6 -6
- package/dist/lib/neutral/chunk-I2MFJ76N.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-6URFBQJH.mjs → chunk-JALF2CVV.mjs} +5 -21
- package/dist/lib/neutral/chunk-JALF2CVV.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-EBVB5NOH.mjs → chunk-KQUQZ3CB.mjs} +15 -20
- package/dist/lib/neutral/chunk-KQUQZ3CB.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-ZGVZNBBJ.mjs → chunk-LOTZLYHB.mjs} +17 -12
- package/dist/lib/neutral/chunk-LOTZLYHB.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-TBKX6JQO.mjs → chunk-N4B7FHQT.mjs} +1 -1
- package/dist/lib/neutral/{chunk-UPWIIW2V.mjs → chunk-NKXEKBP5.mjs} +6 -22
- package/dist/lib/neutral/{chunk-UPWIIW2V.mjs.map → chunk-NKXEKBP5.mjs.map} +2 -2
- package/dist/lib/neutral/{chunk-YSLSJ7QS.mjs → chunk-NSMLBSFS.mjs} +17 -45
- package/dist/lib/neutral/chunk-NSMLBSFS.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-ZIXGDU6F.mjs → chunk-QBIGOSRF.mjs} +2 -2
- package/dist/lib/neutral/{chunk-FNEFSO2C.mjs → chunk-QBLYZ4IV.mjs} +12 -65
- package/dist/lib/neutral/{chunk-FNEFSO2C.mjs.map → chunk-QBLYZ4IV.mjs.map} +2 -2
- package/dist/lib/neutral/{chunk-5VKHCUDA.mjs → chunk-QEVM3JUP.mjs} +26 -7
- package/dist/lib/neutral/chunk-QEVM3JUP.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-QWAOTFCY.mjs → chunk-REP7WWAQ.mjs} +16 -66
- package/dist/lib/neutral/chunk-REP7WWAQ.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-DQYLD2RB.mjs → chunk-TRPZU2HV.mjs} +2 -2
- package/dist/lib/neutral/{chunk-UI6MWK5W.mjs → chunk-TTCSATUD.mjs} +1 -1
- package/dist/lib/neutral/{chunk-46QNGNTY.mjs → chunk-TW76K7H5.mjs} +3 -3
- package/dist/lib/neutral/{chunk-FW7UJX25.mjs → chunk-UYJYDSD7.mjs} +67 -465
- package/dist/lib/neutral/chunk-UYJYDSD7.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-OMUPQMLR.mjs → chunk-V72DY6LU.mjs} +1 -1
- package/dist/lib/neutral/{chunk-UBEZSGXY.mjs → chunk-ZISMEVKD.mjs} +1 -1
- package/dist/lib/neutral/{chunk-UBEZSGXY.mjs.map → chunk-ZISMEVKD.mjs.map} +2 -2
- package/dist/lib/neutral/index.mjs +33 -27
- package/dist/lib/neutral/internal/index.mjs +9 -9
- package/dist/lib/neutral/meta.json +1 -1
- package/dist/lib/neutral/testing/index.mjs +28 -27
- package/dist/lib/neutral/testing/index.mjs.map +1 -1
- package/dist/types/src/Collection.d.ts.map +1 -1
- package/dist/types/src/Database.d.ts +5 -0
- package/dist/types/src/Database.d.ts.map +1 -1
- package/dist/types/src/Dataset.d.ts +1 -1
- package/dist/types/src/Entity.d.ts +15 -9
- package/dist/types/src/Entity.d.ts.map +1 -1
- package/dist/types/src/Err.d.ts +18 -18
- package/dist/types/src/Err.d.ts.map +1 -1
- package/dist/types/src/Extension.d.ts +4 -4
- package/dist/types/src/Extension.d.ts.map +1 -1
- package/dist/types/src/Feed.d.ts +12 -1
- package/dist/types/src/Feed.d.ts.map +1 -1
- package/dist/types/src/Filter.d.ts +5 -3
- package/dist/types/src/Filter.d.ts.map +1 -1
- package/dist/types/src/Json.d.ts +33 -0
- package/dist/types/src/Json.d.ts.map +1 -0
- package/dist/types/src/Json.test.d.ts +2 -0
- package/dist/types/src/Json.test.d.ts.map +1 -0
- package/dist/types/src/JsonSchema.d.ts +1 -1
- package/dist/types/src/Migration.d.ts +57 -0
- package/dist/types/src/Migration.d.ts.map +1 -0
- package/dist/types/src/Obj.d.ts +22 -21
- package/dist/types/src/Obj.d.ts.map +1 -1
- package/dist/types/src/Order.d.ts.map +1 -1
- package/dist/types/src/Query.d.ts +5 -1
- package/dist/types/src/Query.d.ts.map +1 -1
- package/dist/types/src/Ref.d.ts.map +1 -1
- package/dist/types/src/Relation.d.ts +15 -15
- package/dist/types/src/Relation.d.ts.map +1 -1
- package/dist/types/src/Tag.d.ts +2 -2
- package/dist/types/src/Tag.d.ts.map +1 -1
- package/dist/types/src/Type.d.ts.map +1 -1
- package/dist/types/src/View.d.ts +1 -1
- package/dist/types/src/View.d.ts.map +1 -1
- package/dist/types/src/index.d.ts +2 -0
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/annotations.d.ts +2 -2
- package/dist/types/src/internal/Annotation/annotations.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/sorting.d.ts.map +1 -1
- package/dist/types/src/internal/Annotation/util.d.ts +1 -1
- package/dist/types/src/internal/Annotation/util.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/api.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/relation.d.ts.map +1 -1
- package/dist/types/src/internal/Entity/version.d.ts.map +1 -1
- package/dist/types/src/internal/Format/date.d.ts.map +1 -1
- package/dist/types/src/internal/Format/format.d.ts.map +1 -1
- package/dist/types/src/internal/Format/number.d.ts.map +1 -1
- package/dist/types/src/internal/Format/object.d.ts.map +1 -1
- package/dist/types/src/internal/Format/types.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema-normalize.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema-type.d.ts +28 -28
- package/dist/types/src/internal/JsonSchema/json-schema-type.d.ts.map +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema.d.ts +1 -1
- package/dist/types/src/internal/JsonSchema/json-schema.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/clone.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/common.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/create-object.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/deleted.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/ids.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/json-serializer.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/set-value.d.ts +1 -1
- package/dist/types/src/internal/Obj/set-value.d.ts.map +1 -1
- package/dist/types/src/internal/Obj/snapshot.d.ts.map +1 -1
- package/dist/types/src/internal/Query.d.ts.map +1 -1
- package/dist/types/src/internal/Ref/ref.d.ts +13 -0
- package/dist/types/src/internal/Ref/ref.d.ts.map +1 -1
- package/dist/types/src/internal/Type/compose.d.ts.map +1 -1
- package/dist/types/src/internal/Type/echo-schema.d.ts +1 -1
- package/dist/types/src/internal/Type/echo-schema.d.ts.map +1 -1
- package/dist/types/src/internal/Type/manipulation.d.ts.map +1 -1
- package/dist/types/src/internal/common/api/meta.d.ts +3 -3
- package/dist/types/src/internal/common/api/meta.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/change-context.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/change-context.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/define-hidden-property.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/errors.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/errors.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/event-batch.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/json-serializer.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/ownership.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/proxy-utils.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/reactive-array.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/reactive.d.ts +1 -1
- package/dist/types/src/internal/common/proxy/reactive.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/reactive.test.d.ts +2 -0
- package/dist/types/src/internal/common/proxy/reactive.test.d.ts.map +1 -0
- package/dist/types/src/internal/common/proxy/schema-validator.d.ts.map +1 -1
- package/dist/types/src/internal/common/proxy/typed-handler.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/base.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/entity.d.ts +3 -3
- package/dist/types/src/internal/common/types/meta.d.ts.map +1 -1
- package/dist/types/src/internal/common/types/version.d.ts +1 -1
- package/dist/types/src/testing/test-data.d.ts.map +1 -1
- package/dist/types/src/testing/test-schema.d.ts +53 -53
- package/dist/types/src/testing/test-schema.d.ts.map +1 -1
- package/dist/types/src/testing/util.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +18 -13
- package/src/Collection.ts +1 -1
- package/src/Database.ts +35 -13
- package/src/Entity.ts +16 -9
- package/src/Extension.ts +3 -3
- package/src/Feed.ts +22 -1
- package/src/Filter.ts +9 -5
- package/src/Json.test.ts +175 -0
- package/src/Json.ts +102 -0
- package/src/Migration.ts +94 -0
- package/src/Obj.test.ts +12 -12
- package/src/Obj.ts +27 -24
- package/src/Query.test.ts +44 -11
- package/src/Query.ts +20 -0
- package/src/Relation.ts +21 -17
- package/src/index.ts +3 -0
- package/src/internal/Annotation/annotations.ts +5 -6
- package/src/internal/Obj/json-serializer.test.ts +1 -1
- package/src/internal/Obj/set-value.test.ts +15 -15
- package/src/internal/Obj/set-value.ts +1 -1
- package/src/internal/Query.ts +3 -0
- package/src/internal/Ref/ref.ts +17 -0
- package/src/internal/Type/echo-schema.ts +1 -1
- package/src/internal/common/README.md +1 -1
- package/src/internal/common/api/meta.ts +3 -3
- package/src/internal/common/proxy/change-context.ts +1 -1
- package/src/internal/common/proxy/change.test.ts +59 -59
- package/src/internal/common/proxy/errors.ts +2 -2
- package/src/internal/common/proxy/reactive-array.ts +1 -1
- package/src/internal/common/proxy/reactive.test.ts +54 -0
- package/src/internal/common/proxy/reactive.ts +11 -2
- package/src/internal/common/proxy/typed-handler.ts +7 -7
- package/src/internal/common/proxy/typed-object.test.ts +1 -1
- package/dist/lib/neutral/chunk-5VKHCUDA.mjs.map +0 -7
- package/dist/lib/neutral/chunk-6URFBQJH.mjs.map +0 -7
- package/dist/lib/neutral/chunk-7SQD3FRZ.mjs.map +0 -7
- package/dist/lib/neutral/chunk-EBVB5NOH.mjs.map +0 -7
- package/dist/lib/neutral/chunk-FW7UJX25.mjs.map +0 -7
- package/dist/lib/neutral/chunk-HBJ7JT5A.mjs.map +0 -7
- package/dist/lib/neutral/chunk-QWAOTFCY.mjs.map +0 -7
- package/dist/lib/neutral/chunk-T2JOLN37.mjs.map +0 -7
- package/dist/lib/neutral/chunk-WVLOCXB5.mjs.map +0 -7
- package/dist/lib/neutral/chunk-YSLSJ7QS.mjs.map +0 -7
- package/dist/lib/neutral/chunk-ZGVZNBBJ.mjs.map +0 -7
- /package/dist/lib/neutral/{chunk-GZQTCRJB.mjs.map → chunk-44HT3MEC.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-ANHVGJI4.mjs.map → chunk-7RVZT53K.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-BNCCGLJN.mjs.map → chunk-BICZKPQG.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-OLFCVPOO.mjs.map → chunk-DUNXPKAC.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-R72KFH2X.mjs.map → chunk-FAW7PJRO.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-E5PBQJWV.mjs.map → chunk-FAYW32CW.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-TBKX6JQO.mjs.map → chunk-N4B7FHQT.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-ZIXGDU6F.mjs.map → chunk-QBIGOSRF.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-DQYLD2RB.mjs.map → chunk-TRPZU2HV.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-UI6MWK5W.mjs.map → chunk-TTCSATUD.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-46QNGNTY.mjs.map → chunk-TW76K7H5.mjs.map} +0 -0
- /package/dist/lib/neutral/{chunk-OMUPQMLR.mjs.map → chunk-V72DY6LU.mjs.map} +0 -0
|
@@ -9,17 +9,17 @@ import * as Relation from '../../../Relation';
|
|
|
9
9
|
import { TestSchema } from '../../../testing';
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
* Tests for Obj.
|
|
12
|
+
* Tests for Obj.update context enforcement and mutator type safety.
|
|
13
13
|
*
|
|
14
14
|
* These tests verify:
|
|
15
15
|
* 1. Mutator functions require Mutable<T> at compile-time.
|
|
16
16
|
* 2. getMeta returns ReadonlyMeta outside change callbacks and ObjectMeta inside.
|
|
17
|
-
* 3. Mutations outside Obj.
|
|
17
|
+
* 3. Mutations outside Obj.update throw at runtime.
|
|
18
18
|
* 4. Nested object/property mutations work correctly.
|
|
19
19
|
* 5. Array mutations (push, pop, splice) require change context.
|
|
20
20
|
* 6. Property delete requires change context.
|
|
21
21
|
*/
|
|
22
|
-
describe('Obj.
|
|
22
|
+
describe('Obj.update enforcement', () => {
|
|
23
23
|
describe('compile-time and runtime safety', () => {
|
|
24
24
|
test('direct property mutation outside change throws', ({ expect }) => {
|
|
25
25
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
@@ -28,7 +28,7 @@ describe('Obj.change enforcement', () => {
|
|
|
28
28
|
expect(() => {
|
|
29
29
|
// @ts-expect-error Testing runtime error for readonly property mutation.
|
|
30
30
|
obj.name = 'New Name';
|
|
31
|
-
}).toThrow(/outside of Obj.
|
|
31
|
+
}).toThrow(/outside of Obj.update/);
|
|
32
32
|
});
|
|
33
33
|
|
|
34
34
|
test('Obj.setValue outside change throws', ({ expect }) => {
|
|
@@ -36,7 +36,7 @@ describe('Obj.change enforcement', () => {
|
|
|
36
36
|
|
|
37
37
|
// No compile-time error: TypeScript's structural typing allows readonly objects
|
|
38
38
|
// to be passed to Mutable<T> parameters. Enforcement is runtime-only.
|
|
39
|
-
expect(() => Obj.setValue(obj, ['name'], 'value')).toThrow(/outside of Obj.
|
|
39
|
+
expect(() => Obj.setValue(obj, ['name'], 'value')).toThrow(/outside of Obj.update/);
|
|
40
40
|
});
|
|
41
41
|
|
|
42
42
|
test('Obj.addTag outside change throws', ({ expect }) => {
|
|
@@ -44,7 +44,7 @@ describe('Obj.change enforcement', () => {
|
|
|
44
44
|
|
|
45
45
|
// No compile-time error: TypeScript's structural typing allows readonly objects
|
|
46
46
|
// to be passed to Mutable<T> parameters. Enforcement is runtime-only.
|
|
47
|
-
expect(() => Obj.addTag(obj, 'tag')).toThrow(/outside of Obj.
|
|
47
|
+
expect(() => Obj.addTag(obj, 'tag')).toThrow(/outside of Obj.update/);
|
|
48
48
|
});
|
|
49
49
|
|
|
50
50
|
test('getMeta mutation outside change throws', ({ expect }) => {
|
|
@@ -52,14 +52,14 @@ describe('Obj.change enforcement', () => {
|
|
|
52
52
|
const meta = Obj.getMeta(obj);
|
|
53
53
|
|
|
54
54
|
// Runtime errors for direct meta mutations.
|
|
55
|
-
expect(() => ((meta as any).keys = [])).toThrow(/outside of Obj.
|
|
56
|
-
expect(() => ((meta as any).tags = ['tag'])).toThrow(/outside of Obj.
|
|
55
|
+
expect(() => ((meta as any).keys = [])).toThrow(/outside of Obj.update/);
|
|
56
|
+
expect(() => ((meta as any).tags = ['tag'])).toThrow(/outside of Obj.update/);
|
|
57
57
|
});
|
|
58
58
|
|
|
59
59
|
test('getMeta returns mutable ObjectMeta inside change callback', ({ expect }) => {
|
|
60
60
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
61
61
|
|
|
62
|
-
Obj.
|
|
62
|
+
Obj.update(obj, (obj) => {
|
|
63
63
|
const meta = Obj.getMeta(obj);
|
|
64
64
|
|
|
65
65
|
// These should compile without errors because meta is ObjectMeta (mutable).
|
|
@@ -76,7 +76,7 @@ describe('Obj.change enforcement', () => {
|
|
|
76
76
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
77
77
|
|
|
78
78
|
// These should compile without errors inside change callback.
|
|
79
|
-
Obj.
|
|
79
|
+
Obj.update(obj, (obj) => {
|
|
80
80
|
Obj.addTag(obj, 'my-tag');
|
|
81
81
|
Obj.setValue(obj, ['name'], 'Updated');
|
|
82
82
|
});
|
|
@@ -97,7 +97,7 @@ describe('Obj.change enforcement', () => {
|
|
|
97
97
|
expect(() => {
|
|
98
98
|
// @ts-expect-error Testing runtime error for readonly property mutation.
|
|
99
99
|
rel.title = 'Manager';
|
|
100
|
-
}).toThrow(/outside of Obj.
|
|
100
|
+
}).toThrow(/outside of Obj.update/);
|
|
101
101
|
});
|
|
102
102
|
|
|
103
103
|
test('Relation.addTag outside change throws', ({ expect }) => {
|
|
@@ -110,7 +110,7 @@ describe('Obj.change enforcement', () => {
|
|
|
110
110
|
|
|
111
111
|
// No compile-time error: TypeScript's structural typing allows readonly objects
|
|
112
112
|
// to be passed to Mutable<T> parameters. Enforcement is runtime-only.
|
|
113
|
-
expect(() => Relation.addTag(rel, 'tag')).toThrow(/outside of Obj.
|
|
113
|
+
expect(() => Relation.addTag(rel, 'tag')).toThrow(/outside of Obj.update/);
|
|
114
114
|
});
|
|
115
115
|
});
|
|
116
116
|
|
|
@@ -122,7 +122,7 @@ describe('Obj.change enforcement', () => {
|
|
|
122
122
|
// Person schema uses 'name' as label field.
|
|
123
123
|
expect(Obj.getLabel(obj)).toBe('John');
|
|
124
124
|
|
|
125
|
-
Obj.
|
|
125
|
+
Obj.update(obj, (obj) => {
|
|
126
126
|
Obj.setLabel(obj, 'Jane');
|
|
127
127
|
});
|
|
128
128
|
|
|
@@ -140,7 +140,7 @@ describe('Obj.change enforcement', () => {
|
|
|
140
140
|
|
|
141
141
|
// setDescription only works if schema has description annotation.
|
|
142
142
|
// For schemas without it, this is a no-op.
|
|
143
|
-
Obj.
|
|
143
|
+
Obj.update(obj, (obj) => {
|
|
144
144
|
Obj.setDescription(obj, 'My Description');
|
|
145
145
|
});
|
|
146
146
|
|
|
@@ -153,14 +153,14 @@ describe('Obj.change enforcement', () => {
|
|
|
153
153
|
|
|
154
154
|
expect(Obj.getMeta(obj).tags).toBeUndefined();
|
|
155
155
|
|
|
156
|
-
Obj.
|
|
156
|
+
Obj.update(obj, (obj) => {
|
|
157
157
|
Obj.addTag(obj, 'tag-1');
|
|
158
158
|
Obj.addTag(obj, 'tag-2');
|
|
159
159
|
});
|
|
160
160
|
|
|
161
161
|
expect(Obj.getMeta(obj).tags).toEqual(['tag-1', 'tag-2']);
|
|
162
162
|
|
|
163
|
-
Obj.
|
|
163
|
+
Obj.update(obj, (obj) => {
|
|
164
164
|
Obj.removeTag(obj, 'tag-1');
|
|
165
165
|
});
|
|
166
166
|
|
|
@@ -170,7 +170,7 @@ describe('Obj.change enforcement', () => {
|
|
|
170
170
|
test('deleteKeys removes foreign keys by source', ({ expect }) => {
|
|
171
171
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
172
172
|
|
|
173
|
-
Obj.
|
|
173
|
+
Obj.update(obj, (obj) => {
|
|
174
174
|
const meta = Obj.getMeta(obj);
|
|
175
175
|
meta.keys.push({ source: 'source-a', id: '1' });
|
|
176
176
|
meta.keys.push({ source: 'source-a', id: '2' });
|
|
@@ -179,7 +179,7 @@ describe('Obj.change enforcement', () => {
|
|
|
179
179
|
|
|
180
180
|
expect(Obj.getMeta(obj).keys).toHaveLength(3);
|
|
181
181
|
|
|
182
|
-
Obj.
|
|
182
|
+
Obj.update(obj, (obj) => {
|
|
183
183
|
Obj.deleteKeys(obj, 'source-a');
|
|
184
184
|
});
|
|
185
185
|
|
|
@@ -190,7 +190,7 @@ describe('Obj.change enforcement', () => {
|
|
|
190
190
|
test('setValue sets nested properties', ({ expect }) => {
|
|
191
191
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
192
192
|
|
|
193
|
-
Obj.
|
|
193
|
+
Obj.update(obj, (obj) => {
|
|
194
194
|
Obj.setValue(obj, ['name'], 'Updated Name');
|
|
195
195
|
});
|
|
196
196
|
|
|
@@ -200,7 +200,7 @@ describe('Obj.change enforcement', () => {
|
|
|
200
200
|
test('getMeta is mutable inside change and changes persist', ({ expect }) => {
|
|
201
201
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
202
202
|
|
|
203
|
-
Obj.
|
|
203
|
+
Obj.update(obj, (obj) => {
|
|
204
204
|
const meta = Obj.getMeta(obj);
|
|
205
205
|
meta.tags = ['tag-1', 'tag-2'];
|
|
206
206
|
meta.keys.push({ source: 'external', id: '123' });
|
|
@@ -214,7 +214,7 @@ describe('Obj.change enforcement', () => {
|
|
|
214
214
|
test('multiple mutations in single change all persist', ({ expect }) => {
|
|
215
215
|
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
216
216
|
|
|
217
|
-
Obj.
|
|
217
|
+
Obj.update(obj, (obj) => {
|
|
218
218
|
obj.name = 'Name 1';
|
|
219
219
|
obj.name = 'Name 2';
|
|
220
220
|
obj.name = 'Name 3';
|
|
@@ -229,7 +229,7 @@ describe('Obj.change enforcement', () => {
|
|
|
229
229
|
});
|
|
230
230
|
|
|
231
231
|
describe('notifications', () => {
|
|
232
|
-
test('batched notifications - only one per Obj.
|
|
232
|
+
test('batched notifications - only one per Obj.update', ({ expect }) => {
|
|
233
233
|
const obj = Obj.make(TestSchema.Person, { name: 'John' });
|
|
234
234
|
|
|
235
235
|
let notificationCount = 0;
|
|
@@ -237,7 +237,7 @@ describe('Obj.change enforcement', () => {
|
|
|
237
237
|
notificationCount++;
|
|
238
238
|
});
|
|
239
239
|
|
|
240
|
-
Obj.
|
|
240
|
+
Obj.update(obj, (obj) => {
|
|
241
241
|
obj.name = 'Jane';
|
|
242
242
|
obj.age = 30;
|
|
243
243
|
});
|
|
@@ -250,13 +250,13 @@ describe('Obj.change enforcement', () => {
|
|
|
250
250
|
});
|
|
251
251
|
|
|
252
252
|
describe('nested mutations', () => {
|
|
253
|
-
test('nested object property mutation within Obj.
|
|
253
|
+
test('nested object property mutation within Obj.update', ({ expect }) => {
|
|
254
254
|
const obj = Obj.make(TestSchema.Person, {
|
|
255
255
|
name: 'John',
|
|
256
256
|
address: { city: 'NYC', coordinates: {} },
|
|
257
257
|
});
|
|
258
258
|
|
|
259
|
-
Obj.
|
|
259
|
+
Obj.update(obj, (obj) => {
|
|
260
260
|
obj.address!.state = 'NY';
|
|
261
261
|
});
|
|
262
262
|
|
|
@@ -264,13 +264,13 @@ describe('Obj.change enforcement', () => {
|
|
|
264
264
|
expect(obj.address?.city).toBe('NYC');
|
|
265
265
|
});
|
|
266
266
|
|
|
267
|
-
test('deeply nested property mutation within Obj.
|
|
267
|
+
test('deeply nested property mutation within Obj.update (2 levels)', ({ expect }) => {
|
|
268
268
|
const obj = Obj.make(TestSchema.Person, {
|
|
269
269
|
name: 'John',
|
|
270
270
|
address: { city: 'NYC', coordinates: { lat: 40.7128, lng: -74.006 } },
|
|
271
271
|
});
|
|
272
272
|
|
|
273
|
-
Obj.
|
|
273
|
+
Obj.update(obj, (obj) => {
|
|
274
274
|
obj.address!.coordinates!.lat = 51.5074;
|
|
275
275
|
obj.address!.coordinates!.lng = -0.1278;
|
|
276
276
|
});
|
|
@@ -279,7 +279,7 @@ describe('Obj.change enforcement', () => {
|
|
|
279
279
|
expect(obj.address?.coordinates?.lng).toBe(-0.1278);
|
|
280
280
|
});
|
|
281
281
|
|
|
282
|
-
test('nested object mutation outside Obj.
|
|
282
|
+
test('nested object mutation outside Obj.update throws (1 level deep)', ({ expect }) => {
|
|
283
283
|
const obj = Obj.make(TestSchema.Person, {
|
|
284
284
|
name: 'John',
|
|
285
285
|
address: { city: 'NYC', coordinates: {} },
|
|
@@ -288,10 +288,10 @@ describe('Obj.change enforcement', () => {
|
|
|
288
288
|
expect(() => {
|
|
289
289
|
// @ts-expect-error - nested property assignment is readonly.
|
|
290
290
|
obj.address!.city = 'LA';
|
|
291
|
-
}).toThrow(/outside of Obj.
|
|
291
|
+
}).toThrow(/outside of Obj.update/);
|
|
292
292
|
});
|
|
293
293
|
|
|
294
|
-
test('deeply nested mutation outside Obj.
|
|
294
|
+
test('deeply nested mutation outside Obj.update throws (2 levels deep)', ({ expect }) => {
|
|
295
295
|
const obj = Obj.make(TestSchema.Person, {
|
|
296
296
|
name: 'John',
|
|
297
297
|
address: { city: 'NYC', coordinates: { lat: 40.7128, lng: -74.006 } },
|
|
@@ -300,17 +300,17 @@ describe('Obj.change enforcement', () => {
|
|
|
300
300
|
expect(() => {
|
|
301
301
|
// @ts-expect-error - deeply nested property assignment should be caught.
|
|
302
302
|
obj.address!.coordinates!.lat = 0;
|
|
303
|
-
}).toThrow(/outside of Obj.
|
|
303
|
+
}).toThrow(/outside of Obj.update/);
|
|
304
304
|
});
|
|
305
305
|
|
|
306
|
-
test('nested Obj.
|
|
306
|
+
test('nested Obj.update calls work correctly', ({ expect }) => {
|
|
307
307
|
const obj = Obj.make(TestSchema.Person, { name: 'John' });
|
|
308
308
|
|
|
309
|
-
Obj.
|
|
309
|
+
Obj.update(obj, (obj) => {
|
|
310
310
|
obj.name = 'Jane';
|
|
311
311
|
|
|
312
312
|
// Nested change should work (already in change context).
|
|
313
|
-
Obj.
|
|
313
|
+
Obj.update(obj, (obj) => {
|
|
314
314
|
obj.age = 30;
|
|
315
315
|
});
|
|
316
316
|
});
|
|
@@ -323,7 +323,7 @@ describe('Obj.change enforcement', () => {
|
|
|
323
323
|
const obj = Obj.make(TestSchema.Person, { name: 'John' });
|
|
324
324
|
|
|
325
325
|
expect(() => {
|
|
326
|
-
Obj.
|
|
326
|
+
Obj.update(obj, (obj) => {
|
|
327
327
|
obj.name = 'Jane';
|
|
328
328
|
throw new Error('Test error');
|
|
329
329
|
});
|
|
@@ -333,18 +333,18 @@ describe('Obj.change enforcement', () => {
|
|
|
333
333
|
expect(() => {
|
|
334
334
|
// @ts-expect-error Testing runtime error for readonly property mutation.
|
|
335
335
|
obj.name = 'Bob';
|
|
336
|
-
}).toThrow(/outside of Obj.
|
|
336
|
+
}).toThrow(/outside of Obj.update/);
|
|
337
337
|
});
|
|
338
338
|
});
|
|
339
339
|
|
|
340
340
|
describe('array mutations', () => {
|
|
341
|
-
test('array push within Obj.
|
|
341
|
+
test('array push within Obj.update', ({ expect }) => {
|
|
342
342
|
const obj = Obj.make(TestSchema.Person, {
|
|
343
343
|
name: 'John',
|
|
344
344
|
fields: [{ label: 'tag1', value: 'val1' }],
|
|
345
345
|
});
|
|
346
346
|
|
|
347
|
-
Obj.
|
|
347
|
+
Obj.update(obj, (obj) => {
|
|
348
348
|
obj.fields!.push({ label: 'tag2', value: 'val2' });
|
|
349
349
|
});
|
|
350
350
|
|
|
@@ -352,7 +352,7 @@ describe('Obj.change enforcement', () => {
|
|
|
352
352
|
expect(obj.fields![1].label).toBe('tag2');
|
|
353
353
|
});
|
|
354
354
|
|
|
355
|
-
test('array pop within Obj.
|
|
355
|
+
test('array pop within Obj.update', ({ expect }) => {
|
|
356
356
|
const obj = Obj.make(TestSchema.Person, {
|
|
357
357
|
name: 'John',
|
|
358
358
|
fields: [
|
|
@@ -362,7 +362,7 @@ describe('Obj.change enforcement', () => {
|
|
|
362
362
|
});
|
|
363
363
|
|
|
364
364
|
let popped: any;
|
|
365
|
-
Obj.
|
|
365
|
+
Obj.update(obj, (obj) => {
|
|
366
366
|
popped = obj.fields!.pop();
|
|
367
367
|
});
|
|
368
368
|
|
|
@@ -370,7 +370,7 @@ describe('Obj.change enforcement', () => {
|
|
|
370
370
|
expect(obj.fields).toHaveLength(1);
|
|
371
371
|
});
|
|
372
372
|
|
|
373
|
-
test('array splice within Obj.
|
|
373
|
+
test('array splice within Obj.update', ({ expect }) => {
|
|
374
374
|
const obj = Obj.make(TestSchema.Person, {
|
|
375
375
|
name: 'John',
|
|
376
376
|
fields: [
|
|
@@ -380,7 +380,7 @@ describe('Obj.change enforcement', () => {
|
|
|
380
380
|
],
|
|
381
381
|
});
|
|
382
382
|
|
|
383
|
-
Obj.
|
|
383
|
+
Obj.update(obj, (obj) => {
|
|
384
384
|
obj.fields!.splice(1, 1, { label: 'x', value: 'x' });
|
|
385
385
|
});
|
|
386
386
|
|
|
@@ -388,7 +388,7 @@ describe('Obj.change enforcement', () => {
|
|
|
388
388
|
expect(obj.fields![1].label).toBe('x');
|
|
389
389
|
});
|
|
390
390
|
|
|
391
|
-
test('array push outside Obj.
|
|
391
|
+
test('array push outside Obj.update throws', ({ expect }) => {
|
|
392
392
|
const obj = Obj.make(TestSchema.Person, {
|
|
393
393
|
name: 'John',
|
|
394
394
|
fields: [{ label: 'tag1', value: 'val1' }],
|
|
@@ -397,10 +397,10 @@ describe('Obj.change enforcement', () => {
|
|
|
397
397
|
expect(() => {
|
|
398
398
|
// @ts-expect-error Testing runtime error for readonly array mutation.
|
|
399
399
|
obj.fields!.push({ label: 'tag2', value: 'val2' });
|
|
400
|
-
}).toThrow(/array\.push\(\).*outside of Obj\.
|
|
400
|
+
}).toThrow(/array\.push\(\).*outside of Obj\.update/);
|
|
401
401
|
});
|
|
402
402
|
|
|
403
|
-
test('array pop outside Obj.
|
|
403
|
+
test('array pop outside Obj.update throws', ({ expect }) => {
|
|
404
404
|
const obj = Obj.make(TestSchema.Person, {
|
|
405
405
|
name: 'John',
|
|
406
406
|
fields: [{ label: 'tag1', value: 'val1' }],
|
|
@@ -409,10 +409,10 @@ describe('Obj.change enforcement', () => {
|
|
|
409
409
|
expect(() => {
|
|
410
410
|
// @ts-expect-error Testing runtime error for readonly array mutation.
|
|
411
411
|
obj.fields!.pop();
|
|
412
|
-
}).toThrow(/array\.pop\(\).*outside of Obj\.
|
|
412
|
+
}).toThrow(/array\.pop\(\).*outside of Obj\.update/);
|
|
413
413
|
});
|
|
414
414
|
|
|
415
|
-
test('array splice outside Obj.
|
|
415
|
+
test('array splice outside Obj.update throws', ({ expect }) => {
|
|
416
416
|
const obj = Obj.make(TestSchema.Person, {
|
|
417
417
|
name: 'John',
|
|
418
418
|
fields: [{ label: 'tag1', value: 'val1' }],
|
|
@@ -421,33 +421,33 @@ describe('Obj.change enforcement', () => {
|
|
|
421
421
|
expect(() => {
|
|
422
422
|
// @ts-expect-error Testing runtime error for readonly array mutation.
|
|
423
423
|
obj.fields!.splice(0, 1);
|
|
424
|
-
}).toThrow(/array\.splice\(\).*outside of Obj\.
|
|
424
|
+
}).toThrow(/array\.splice\(\).*outside of Obj\.update/);
|
|
425
425
|
});
|
|
426
426
|
});
|
|
427
427
|
|
|
428
428
|
describe('property delete', () => {
|
|
429
|
-
test('delete property within Obj.
|
|
429
|
+
test('delete property within Obj.update', ({ expect }) => {
|
|
430
430
|
const obj = Obj.make(TestSchema.Person, { name: 'John', age: 25 });
|
|
431
431
|
|
|
432
|
-
Obj.
|
|
432
|
+
Obj.update(obj, (obj) => {
|
|
433
433
|
delete obj.age;
|
|
434
434
|
});
|
|
435
435
|
|
|
436
436
|
expect(obj.age).toBeUndefined();
|
|
437
437
|
});
|
|
438
438
|
|
|
439
|
-
test('delete property outside Obj.
|
|
439
|
+
test('delete property outside Obj.update throws', ({ expect }) => {
|
|
440
440
|
const obj = Obj.make(TestSchema.Person, { name: 'John', age: 25 });
|
|
441
441
|
|
|
442
442
|
expect(() => {
|
|
443
443
|
// @ts-expect-error Testing runtime error for readonly property delete.
|
|
444
444
|
delete obj.age;
|
|
445
|
-
}).toThrow(/delete object property.*outside of Obj\.
|
|
445
|
+
}).toThrow(/delete object property.*outside of Obj\.update/);
|
|
446
446
|
});
|
|
447
447
|
});
|
|
448
448
|
|
|
449
449
|
describe('Relation mutators', () => {
|
|
450
|
-
test('Relation.getMeta is mutable inside Relation.
|
|
450
|
+
test('Relation.getMeta is mutable inside Relation.update', ({ expect }) => {
|
|
451
451
|
const source = Obj.make(TestSchema.Person, { name: 'Alice' });
|
|
452
452
|
const target = Obj.make(TestSchema.Person, { name: 'Bob' });
|
|
453
453
|
const rel = Relation.make(TestSchema.HasManager, {
|
|
@@ -455,7 +455,7 @@ describe('Obj.change enforcement', () => {
|
|
|
455
455
|
[Relation.Target]: target,
|
|
456
456
|
});
|
|
457
457
|
|
|
458
|
-
Relation.
|
|
458
|
+
Relation.update(rel, (rel) => {
|
|
459
459
|
const meta = Relation.getMeta(rel);
|
|
460
460
|
meta.tags = ['rel-tag'];
|
|
461
461
|
meta.keys.push({ source: 'rel-source', id: 'rel-key' });
|
|
@@ -473,13 +473,13 @@ describe('Obj.change enforcement', () => {
|
|
|
473
473
|
[Relation.Target]: target,
|
|
474
474
|
});
|
|
475
475
|
|
|
476
|
-
Relation.
|
|
476
|
+
Relation.update(rel, (rel) => {
|
|
477
477
|
Relation.addTag(rel, 'important');
|
|
478
478
|
});
|
|
479
479
|
|
|
480
480
|
expect(Relation.getMeta(rel).tags).toContain('important');
|
|
481
481
|
|
|
482
|
-
Relation.
|
|
482
|
+
Relation.update(rel, (rel) => {
|
|
483
483
|
Relation.removeTag(rel, 'important');
|
|
484
484
|
});
|
|
485
485
|
|
|
@@ -494,7 +494,7 @@ describe('Obj.change enforcement', () => {
|
|
|
494
494
|
|
|
495
495
|
// Direct assignment of root ECHO objects (created with Obj.make) is not allowed.
|
|
496
496
|
expect(() => {
|
|
497
|
-
Obj.
|
|
497
|
+
Obj.update(obj, (obj) => {
|
|
498
498
|
obj.other = other;
|
|
499
499
|
});
|
|
500
500
|
}).toThrow(/Object references must be wrapped with `Ref\.make`/);
|
|
@@ -504,13 +504,13 @@ describe('Obj.change enforcement', () => {
|
|
|
504
504
|
const obj = Obj.make(TestSchema.Expando, {});
|
|
505
505
|
|
|
506
506
|
// Assign a plain object (not created with Obj.make).
|
|
507
|
-
Obj.
|
|
507
|
+
Obj.update(obj, (obj) => {
|
|
508
508
|
obj.nested = { value: 'initial' };
|
|
509
509
|
});
|
|
510
510
|
expect(obj.nested.value).toBe('initial');
|
|
511
511
|
|
|
512
512
|
// Modify plain nested object through parent's change context.
|
|
513
|
-
Obj.
|
|
513
|
+
Obj.update(obj, (obj) => {
|
|
514
514
|
obj.nested.value = 'modified';
|
|
515
515
|
});
|
|
516
516
|
expect(obj.nested.value).toBe('modified');
|
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* Error thrown when attempting to mutate an object outside of an Obj.
|
|
6
|
+
* Error thrown when attempting to mutate an object outside of an Obj.update() context.
|
|
7
7
|
*/
|
|
8
8
|
export class MutationOutsideChangeContextError extends Error {
|
|
9
9
|
constructor(operation: string, suggestion: string) {
|
|
10
10
|
super(
|
|
11
|
-
`Cannot ${operation} outside of Obj.
|
|
11
|
+
`Cannot ${operation} outside of Obj.update(). Use Obj.update(obj, (mutableObj) => { ${suggestion} }) instead.`,
|
|
12
12
|
);
|
|
13
13
|
this.name = 'MutationOutsideChangeContextError';
|
|
14
14
|
}
|
|
@@ -34,7 +34,7 @@ const checkArrayMutationAllowed = (arr: any, method: string): void => {
|
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
36
|
* Extends the native array to make sure that arrays methods are correctly reactive.
|
|
37
|
-
* Enforces that mutations only happen within Obj.
|
|
37
|
+
* Enforces that mutations only happen within Obj.update() context.
|
|
38
38
|
*/
|
|
39
39
|
export class ReactiveArray<T> extends Array<T> {
|
|
40
40
|
static override get [Symbol.species]() {
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { describe, expect, test } from 'vitest';
|
|
6
|
+
|
|
7
|
+
import * as Obj from '../../../Obj';
|
|
8
|
+
import { TestSchema } from '../../../testing';
|
|
9
|
+
|
|
10
|
+
describe('Obj.subscribe', () => {
|
|
11
|
+
test('subscribes and fires for reactive proxies', () => {
|
|
12
|
+
const obj = Obj.make(TestSchema.Person, { name: 'Test' });
|
|
13
|
+
let calls = 0;
|
|
14
|
+
const unsubscribe = Obj.subscribe(obj, () => {
|
|
15
|
+
calls++;
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
Obj.update(obj, (obj) => {
|
|
19
|
+
obj.name = 'Updated';
|
|
20
|
+
});
|
|
21
|
+
expect(calls).toBeGreaterThan(0);
|
|
22
|
+
|
|
23
|
+
unsubscribe();
|
|
24
|
+
const seen = calls;
|
|
25
|
+
Obj.update(obj, (obj) => {
|
|
26
|
+
obj.name = 'After unsubscribe';
|
|
27
|
+
});
|
|
28
|
+
expect(calls).toBe(seen);
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
// Regression: queue-stored typed objects (e.g. ContextBinding) and other Obj-shaped values
|
|
32
|
+
// satisfy `Obj.isObject` (KindId is set) but are not wrapped in a reactive Proxy. Earlier
|
|
33
|
+
// versions invariant'd inside `getProxyTarget` when an atom body did `Obj.subscribe(obj)` on
|
|
34
|
+
// such an input. The contract is "no-op for non-reactive inputs"; verify the function
|
|
35
|
+
// returns gracefully instead of throwing.
|
|
36
|
+
test('returns a no-op unsubscribe for non-proxy inputs', () => {
|
|
37
|
+
const queueShaped: any = {
|
|
38
|
+
id: '01KQ5NKXJWSKMRPVTVG2GHV8V3',
|
|
39
|
+
blueprints: { added: [], removed: [] },
|
|
40
|
+
objects: { added: [], removed: [] },
|
|
41
|
+
};
|
|
42
|
+
const unsubscribe = Obj.subscribe(queueShaped, () => {});
|
|
43
|
+
expect(typeof unsubscribe).toBe('function');
|
|
44
|
+
expect(() => unsubscribe()).not.toThrow();
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
test('returns a no-op unsubscribe for primitives, null, and undefined', () => {
|
|
48
|
+
for (const value of [null, undefined, 42, 'string', true]) {
|
|
49
|
+
const unsubscribe = Obj.subscribe(value as any, () => {});
|
|
50
|
+
expect(typeof unsubscribe).toBe('function');
|
|
51
|
+
expect(() => unsubscribe()).not.toThrow();
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
});
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import { type RefTypeId } from '../../Ref/ref';
|
|
6
|
-
import { getProxyTarget } from './proxy-utils';
|
|
6
|
+
import { getProxyTarget, isProxy } from './proxy-utils';
|
|
7
7
|
import { ChangeId, EventId } from './symbols';
|
|
8
8
|
|
|
9
9
|
/**
|
|
@@ -14,6 +14,15 @@ import { ChangeId, EventId } from './symbols';
|
|
|
14
14
|
*/
|
|
15
15
|
// TODO(wittjosiah): Consider throwing if obj doesn't have EventId instead of returning no-op.
|
|
16
16
|
export const subscribe = (obj: unknown, callback: () => void): (() => void) => {
|
|
17
|
+
// Guard against non-reactive inputs (queue-stored typed objects, snapshots, plain shapes
|
|
18
|
+
// with branded symbols) before `getProxyTarget`'s `ProxyHandlerSlot` invariant kicks in.
|
|
19
|
+
// `Obj.isObject` (KindId-based) is satisfied by these inputs, so callers like
|
|
20
|
+
// `Atom.family((obj) => Atom.make((get) => Obj.subscribe(obj, ...)))` legitimately reach
|
|
21
|
+
// here with a non-proxy. Falling back to a no-op preserves the documented contract that
|
|
22
|
+
// values without subscription support get a no-op unsubscribe.
|
|
23
|
+
if (!isProxy(obj)) {
|
|
24
|
+
return () => {};
|
|
25
|
+
}
|
|
17
26
|
const target = getProxyTarget(obj as any);
|
|
18
27
|
if (target && EventId in target) {
|
|
19
28
|
return (target as any)[EventId].on(callback);
|
|
@@ -23,7 +32,7 @@ export const subscribe = (obj: unknown, callback: () => void): (() => void) => {
|
|
|
23
32
|
|
|
24
33
|
/**
|
|
25
34
|
* Deeply removes readonly modifiers from all properties of T.
|
|
26
|
-
* Inside Obj.
|
|
35
|
+
* Inside Obj.update, all properties are fully mutable regardless of schema definition.
|
|
27
36
|
* Ref types are preserved as-is since they are value-like objects that are replaced, not mutated.
|
|
28
37
|
* Primitive types (including branded primitives) are preserved as-is.
|
|
29
38
|
*/
|
|
@@ -226,7 +226,7 @@ export class TypedReactiveHandler implements ReactiveHandler<ProxyTarget> {
|
|
|
226
226
|
set(target: ProxyTarget, prop: string | symbol, value: any, receiver: any): boolean {
|
|
227
227
|
const echoRoot = getEchoRoot(target);
|
|
228
228
|
|
|
229
|
-
// Check readonly enforcement - mutations only allowed within Obj.
|
|
229
|
+
// Check readonly enforcement - mutations only allowed within Obj.update().
|
|
230
230
|
// Skip check if the object is still being initialized (no ChangeId handler yet).
|
|
231
231
|
// Also skip for non-initialized root objects (those without EventId).
|
|
232
232
|
// Skip for symbol properties (internal infrastructure, not user data).
|
|
@@ -234,8 +234,8 @@ export class TypedReactiveHandler implements ReactiveHandler<ProxyTarget> {
|
|
|
234
234
|
const isSymbolProp = typeof prop === 'symbol';
|
|
235
235
|
if (isInitialized && !isSymbolProp && !isInChangeContext(echoRoot)) {
|
|
236
236
|
throw new Error(
|
|
237
|
-
`Cannot modify object property "${String(prop)}" outside of Obj.
|
|
238
|
-
'Use Obj.
|
|
237
|
+
`Cannot modify object property "${String(prop)}" outside of Obj.update(). ` +
|
|
238
|
+
'Use Obj.update(obj, (mutableObj) => { mutableObj.property = value; }) instead.',
|
|
239
239
|
);
|
|
240
240
|
}
|
|
241
241
|
|
|
@@ -265,7 +265,7 @@ export class TypedReactiveHandler implements ReactiveHandler<ProxyTarget> {
|
|
|
265
265
|
deleteProperty(target: ProxyTarget, property: string | symbol): boolean {
|
|
266
266
|
const echoRoot = getEchoRoot(target);
|
|
267
267
|
|
|
268
|
-
// Check readonly enforcement - mutations only allowed within Obj.
|
|
268
|
+
// Check readonly enforcement - mutations only allowed within Obj.update().
|
|
269
269
|
// Skip for symbol properties (internal infrastructure, not user data).
|
|
270
270
|
const isInitialized = (echoRoot as any)[ChangeId] === true || EventId in echoRoot;
|
|
271
271
|
const isSymbolProp = typeof property === 'symbol';
|
|
@@ -283,15 +283,15 @@ export class TypedReactiveHandler implements ReactiveHandler<ProxyTarget> {
|
|
|
283
283
|
defineProperty(target: ProxyTarget, property: string | symbol, attributes: PropertyDescriptor): boolean {
|
|
284
284
|
const echoRoot = getEchoRoot(target);
|
|
285
285
|
|
|
286
|
-
// Check readonly enforcement - mutations only allowed within Obj.
|
|
286
|
+
// Check readonly enforcement - mutations only allowed within Obj.update().
|
|
287
287
|
// Skip check if the object is still being initialized (no ChangeId handler yet).
|
|
288
288
|
// Skip for symbol properties (internal infrastructure, not user data).
|
|
289
289
|
const isInitialized = ChangeId in echoRoot || EventId in echoRoot;
|
|
290
290
|
const isSymbolProp = typeof property === 'symbol';
|
|
291
291
|
if (isInitialized && !isSymbolProp && !isInChangeContext(echoRoot)) {
|
|
292
292
|
throw new Error(
|
|
293
|
-
`Cannot modify object property "${String(property)}" outside of Obj.
|
|
294
|
-
'Use Obj.
|
|
293
|
+
`Cannot modify object property "${String(property)}" outside of Obj.update(). ` +
|
|
294
|
+
'Use Obj.update(obj, (mutableObj) => { mutableObj.property = value; }) instead.',
|
|
295
295
|
);
|
|
296
296
|
}
|
|
297
297
|
|
|
@@ -86,7 +86,7 @@ describe('EchoObjectSchema class DSL', () => {
|
|
|
86
86
|
}
|
|
87
87
|
|
|
88
88
|
{
|
|
89
|
-
// Plain object (not a reactive proxy) - doesn't need Obj.
|
|
89
|
+
// Plain object (not a reactive proxy) - doesn't need Obj.update.
|
|
90
90
|
// Note: Schema.Schema.Type generates readonly types, so we cast to mutable for plain objects.
|
|
91
91
|
type Test1 = Types.Mutable<Schema.Schema.Type<typeof schema>>;
|
|
92
92
|
|