@signal-tree/vue 15.0.0-rc.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/NOTICE +13 -0
- package/README.md +37 -0
- package/dist/index.js +1 -0
- package/dist/lib/vue-observation.js +117 -0
- package/llms.txt +177 -0
- package/package.json +42 -0
- package/src/index.d.ts +23 -0
- package/src/lib/carrier.d.ts +13 -0
- package/src/lib/vue-observation.d.ts +2 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2024-2026 Jonathan D Borgia and SignalTree contributors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
package/NOTICE
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
SignalTree
|
|
2
|
+
Copyright 2024-2026 Jonathan D Borgia and SignalTree contributors
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Jonathan D Borgia
|
|
5
|
+
and the SignalTree contributors (https://github.com/JBorgia/signaltree).
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0. See the LICENSE file
|
|
8
|
+
for the full terms.
|
|
9
|
+
|
|
10
|
+
"SignalTree" and the SignalTree name and logo are marks of the
|
|
11
|
+
copyright holder. The Apache License does not grant permission to use
|
|
12
|
+
them (LICENSE section 6); forks and derivative works must be
|
|
13
|
+
distributed under a different name.
|
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# `@signal-tree/vue`
|
|
2
|
+
|
|
3
|
+
Vue-native SignalTree realization. State remains owned by the framework-neutral
|
|
4
|
+
kernel; terminal leaves are Vue refs and derived values are computed refs.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install @signal-tree/vue
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Vue 3.5 or newer is required as a peer dependency.
|
|
13
|
+
|
|
14
|
+
The canonical v15 model and composition guidance ships with this package as
|
|
15
|
+
[llms.txt](llms.txt).
|
|
16
|
+
|
|
17
|
+
## Use
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import { signalTree } from '@signal-tree/vue';
|
|
21
|
+
|
|
22
|
+
const tree = signalTree(
|
|
23
|
+
{ profile: { name: 'Ada' } },
|
|
24
|
+
{
|
|
25
|
+
derived: ($) => ({
|
|
26
|
+
greeting: () => `Hello, ${$.profile.name.value}`,
|
|
27
|
+
}),
|
|
28
|
+
}
|
|
29
|
+
);
|
|
30
|
+
|
|
31
|
+
tree.$.profile.name.value = 'Grace';
|
|
32
|
+
console.log(tree.$.greeting.value); // Hello, Grace
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The ref can be passed directly to `watch()`, `computed()`, or `v-model`.
|
|
36
|
+
Object branches and the root `$` remain callable whole-value accessors. Vue owns
|
|
37
|
+
dependency tracking; the kernel remains the only state and write authority.
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{asReadonly as asReadonly$1}from"@signal-tree/kernel";export*from"@signal-tree/kernel";import{createSignalTreeFactory}from"@signal-tree/kernel/adapter";import{createVueObservationAdapter}from"./lib/vue-observation.js";const signalTree=(initialState,config)=>createSignalTreeFactory(createVueObservationAdapter())(initialState,config);const asReadonly=asReadonly$1;export{asReadonly,signalTree};
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { computed, shallowRef, triggerRef } from 'vue';
|
|
2
|
+
|
|
3
|
+
const wrapReadonlyCell = source => {
|
|
4
|
+
const cell = () => source.value;
|
|
5
|
+
Object.defineProperties(cell, {
|
|
6
|
+
__v_isRef: {
|
|
7
|
+
value: true
|
|
8
|
+
},
|
|
9
|
+
__v_isReadonly: {
|
|
10
|
+
value: true
|
|
11
|
+
},
|
|
12
|
+
effect: {
|
|
13
|
+
value: source.effect
|
|
14
|
+
},
|
|
15
|
+
value: {
|
|
16
|
+
get: () => source.value
|
|
17
|
+
}
|
|
18
|
+
});
|
|
19
|
+
return cell;
|
|
20
|
+
};
|
|
21
|
+
const createReadonlyCell = read => wrapReadonlyCell(computed(read));
|
|
22
|
+
const createWritableCell = read => {
|
|
23
|
+
const cell = () => read();
|
|
24
|
+
Object.defineProperties(cell, {
|
|
25
|
+
__v_isRef: {
|
|
26
|
+
value: true
|
|
27
|
+
},
|
|
28
|
+
value: {
|
|
29
|
+
get: read,
|
|
30
|
+
set: value => cell.set(value)
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
cell.set = () => undefined;
|
|
34
|
+
cell.update = update => cell.set(update(read()));
|
|
35
|
+
let readonly;
|
|
36
|
+
cell.asReadonly = () => readonly ??= createReadonlyCell(read);
|
|
37
|
+
return cell;
|
|
38
|
+
};
|
|
39
|
+
const createVueObservationAdapter = () => {
|
|
40
|
+
let invalidationGroupDepth = 0;
|
|
41
|
+
const pendingInvalidations = new Set();
|
|
42
|
+
const scheduleInvalidation = invalidate => {
|
|
43
|
+
if (invalidationGroupDepth > 0) {
|
|
44
|
+
pendingInvalidations.add(invalidate);
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
invalidate();
|
|
48
|
+
};
|
|
49
|
+
const createObservationToken = () => {
|
|
50
|
+
const revision = shallowRef(0);
|
|
51
|
+
const invalidate = () => triggerRef(revision);
|
|
52
|
+
return {
|
|
53
|
+
observe: () => void revision.value,
|
|
54
|
+
invalidate: () => scheduleInvalidation(invalidate)
|
|
55
|
+
};
|
|
56
|
+
};
|
|
57
|
+
return {
|
|
58
|
+
createToken: createObservationToken,
|
|
59
|
+
createWritableCell: read => {
|
|
60
|
+
let published = read();
|
|
61
|
+
const revision = shallowRef(0);
|
|
62
|
+
const invalidate = () => triggerRef(revision);
|
|
63
|
+
return {
|
|
64
|
+
cell: createWritableCell(() => {
|
|
65
|
+
void revision.value;
|
|
66
|
+
return published;
|
|
67
|
+
}),
|
|
68
|
+
peek: read,
|
|
69
|
+
token: {
|
|
70
|
+
observe: () => void revision.value,
|
|
71
|
+
invalidate: () => {
|
|
72
|
+
published = read();
|
|
73
|
+
scheduleInvalidation(invalidate);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
},
|
|
78
|
+
createWritableProjection: computeValue => ({
|
|
79
|
+
cell: createWritableCell(computeValue),
|
|
80
|
+
peek: computeValue
|
|
81
|
+
}),
|
|
82
|
+
createReadonlyCell: computeValue => {
|
|
83
|
+
const source = computed(computeValue);
|
|
84
|
+
return wrapReadonlyCell(source);
|
|
85
|
+
},
|
|
86
|
+
runInvalidationGroup(run) {
|
|
87
|
+
let failure;
|
|
88
|
+
let hasFailure = false;
|
|
89
|
+
invalidationGroupDepth += 1;
|
|
90
|
+
try {
|
|
91
|
+
run();
|
|
92
|
+
} catch (error) {
|
|
93
|
+
failure = error;
|
|
94
|
+
hasFailure = true;
|
|
95
|
+
} finally {
|
|
96
|
+
invalidationGroupDepth -= 1;
|
|
97
|
+
if (invalidationGroupDepth === 0 && pendingInvalidations.size > 0) {
|
|
98
|
+
const invalidations = [...pendingInvalidations];
|
|
99
|
+
pendingInvalidations.clear();
|
|
100
|
+
for (const invalidate of invalidations) {
|
|
101
|
+
try {
|
|
102
|
+
invalidate();
|
|
103
|
+
} catch (error) {
|
|
104
|
+
if (!hasFailure) {
|
|
105
|
+
failure = error;
|
|
106
|
+
hasFailure = true;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
if (hasFailure) throw failure;
|
|
113
|
+
}
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
export { createVueObservationAdapter };
|
package/llms.txt
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# SignalTree
|
|
2
|
+
|
|
3
|
+
SignalTree is framework-neutral reactive application state with causal
|
|
4
|
+
semantics. The public v15 construction model is
|
|
5
|
+
`signalTree(initialState, { derived, enhancers })`; state is read through
|
|
6
|
+
`tree.$`.
|
|
7
|
+
|
|
8
|
+
## What SignalTree is — and is not
|
|
9
|
+
|
|
10
|
+
```text
|
|
11
|
+
IS: framework-independent consequential application state, stable subject
|
|
12
|
+
identity, authored versus external authority, coherent operation
|
|
13
|
+
boundaries, causal/restoration semantics, and link-based relationships
|
|
14
|
+
|
|
15
|
+
IS NOT: primarily an undo library, event log, query library, sync engine, or
|
|
16
|
+
persistence framework
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Undo/redo, event replay, query composition, live synchronization, and
|
|
20
|
+
persistence are all things applications correctly BUILD on top of SignalTree's
|
|
21
|
+
causal model — see "Composition patterns" below — but none of them is what
|
|
22
|
+
SignalTree is FOR. Describe SignalTree by its primary job (consequential state
|
|
23
|
+
with a causal model an application can trust), not by one thing that model
|
|
24
|
+
happens to make easy.
|
|
25
|
+
|
|
26
|
+
v15 ships four packages under the hyphenated `@signal-tree/*` scope (the pre-15
|
|
27
|
+
`@signaltree/*` scope, no hyphen, stopped at 14.1.1):
|
|
28
|
+
|
|
29
|
+
- `@signal-tree/kernel` — framework-neutral tree, `entityMap()`, causal turns,
|
|
30
|
+
links, and the `restoration()` / `transactions()` / `batching()` / `devTools()`
|
|
31
|
+
enhancers. Also `@signal-tree/kernel/adapter`, the realization SDK.
|
|
32
|
+
- `@signal-tree/angular` — the complete Angular application facade. **Angular
|
|
33
|
+
code imports `signalTree` and all other SignalTree APIs from here**. Terminal
|
|
34
|
+
state leaves are native `WritableSignal<T>` values and derived leaves are
|
|
35
|
+
native `Signal<T>` values. Adds `defineStore()` and `toWritableSignal()` for
|
|
36
|
+
adapting callable object branches or designating form ingress.
|
|
37
|
+
- `@signal-tree/react` — the complete React application facade. **React code
|
|
38
|
+
imports `signalTree`, markers, enhancers, and `useSignalTree(owner, selector)`
|
|
39
|
+
from here**; React observes the canonical kernel tree without copying it.
|
|
40
|
+
- `@signal-tree/vue` — the complete Vue application facade. **Vue code imports
|
|
41
|
+
`signalTree` and all other SignalTree APIs from here**. Terminal state leaves
|
|
42
|
+
are native `Ref<T>` values and derived leaves are `ComputedRef<T>` values.
|
|
43
|
+
|
|
44
|
+
Use `@signal-tree/kernel` directly only for framework-neutral TypeScript,
|
|
45
|
+
including reusable domain libraries. Framework facades forward the neutral
|
|
46
|
+
kernel surface by canonical identity; they do not duplicate semantic authority.
|
|
47
|
+
|
|
48
|
+
## Accessor grammar and terminal values
|
|
49
|
+
|
|
50
|
+
The neutral kernel exposes callable locations:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
location(); // read
|
|
54
|
+
location(nextValue); // replace the complete value
|
|
55
|
+
location((current) => nextValue); // derive the next complete value
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
The root (`tree.$`) and object branches keep this callable whole-value grammar
|
|
59
|
+
in every facade. Terminal values use the framework's native carrier:
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
angularTree.$.count();
|
|
63
|
+
angularTree.$.count.set(5);
|
|
64
|
+
angularTree.$.count.update((count) => count + 1);
|
|
65
|
+
|
|
66
|
+
vueTree.$.count.value;
|
|
67
|
+
vueTree.$.count.value = 5;
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
React has no persistent signal primitive, so `@signal-tree/react` keeps neutral
|
|
71
|
+
locations and observes selected state through `useSignalTree(owner, selector)`.
|
|
72
|
+
EntityMap query and field leaves follow the same carrier rule; EntityMap command
|
|
73
|
+
methods such as `setAll()` and `updateOne()` do not change.
|
|
74
|
+
|
|
75
|
+
Plain objects normally become traversable branches. `leaf(value)` explicitly
|
|
76
|
+
ends topology so an object remains one atomic location. Callable values always
|
|
77
|
+
use `leaf()` because a bare function argument is the updater syntax:
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
const tree = signalTree({
|
|
81
|
+
range: leaf({ start: 0, end: 10 }),
|
|
82
|
+
callback: leaf((value: number) => console.log(value)),
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
angularTree.$.range.set({ start: 5, end: 15 });
|
|
86
|
+
angularTree.$.callback.set((value) => persist(value));
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The wrapper is consumed at construction or invocation and never enters state,
|
|
90
|
+
snapshots, persistence, restoration, links, or causal payloads.
|
|
91
|
+
|
|
92
|
+
There is no v15 forms, persistence, validation, events, or realtime package;
|
|
93
|
+
those are application-owned. `.with()`, positional `derived`, and the
|
|
94
|
+
`stored`/`asyncSource`/`asyncQuery`/`form`/`status` markers were all removed.
|
|
95
|
+
|
|
96
|
+
## Migration Rule
|
|
97
|
+
|
|
98
|
+
Never design SignalTree around a legacy application's intermediate state.
|
|
99
|
+
|
|
100
|
+
1. Determine the canonical greenfield v15 architecture.
|
|
101
|
+
2. Implement and validate that architecture independently.
|
|
102
|
+
3. Migrate applications toward that target.
|
|
103
|
+
4. Prefer deleting obsolete concepts over adapting them.
|
|
104
|
+
5. Never add compatibility APIs merely to reduce migration work.
|
|
105
|
+
6. A migration may falsify the target architecture, but legacy usage does not
|
|
106
|
+
define it.
|
|
107
|
+
|
|
108
|
+
Do not create intermediate APIs intended to be removed later. Do not add
|
|
109
|
+
compatibility layers because a migration is large. Do not preserve old
|
|
110
|
+
ownership because moving it is inconvenient. Do not design framework adapters
|
|
111
|
+
from legacy application idioms. Do not optimize for minimal migration diff.
|
|
112
|
+
Optimize for the architecture applications should use five years from now.
|
|
113
|
+
|
|
114
|
+
`@signal-tree/kernel/adapter` is the SDK for realization ownership, not a
|
|
115
|
+
compatibility layer. New exports must be framework-neutral semantic facts owned
|
|
116
|
+
by the kernel and required by correct realizations.
|
|
117
|
+
|
|
118
|
+
## Framework Realization Rule
|
|
119
|
+
|
|
120
|
+
Framework packages may realize SignalTree truth for their runtime. They must
|
|
121
|
+
not create another state authority.
|
|
122
|
+
|
|
123
|
+
Never use process-global mutable framework installation merely to make a legacy
|
|
124
|
+
integration work if construction-bound ownership can express the long-term
|
|
125
|
+
architecture. A migration cannot determine realization ownership.
|
|
126
|
+
|
|
127
|
+
## Framework Ownership Ratchet
|
|
128
|
+
|
|
129
|
+
`@signal-tree/kernel` owns framework-independent SignalTree semantics.
|
|
130
|
+
`@signal-tree/kernel/adapter` owns only neutral ports for semantic questions
|
|
131
|
+
the kernel owns. Framework packages own their implementations, lifecycle,
|
|
132
|
+
diagnostics, schedulers, rendering behavior, primitive identity rules, and
|
|
133
|
+
quirks. Neutral naming does not establish neutral ownership.
|
|
134
|
+
|
|
135
|
+
Every new realization contract must state its SignalTree semantic job, provide
|
|
136
|
+
a neutral implementation, be implementable by a tiny framework-free fake, and
|
|
137
|
+
name the kernel authority deciding when and why it runs. Reject contracts that
|
|
138
|
+
exist only for one framework. If Angular, React, and Vue disappeared, the
|
|
139
|
+
contract must remain meaningful to SignalTree or another reactive runtime.
|
|
140
|
+
|
|
141
|
+
## Composition patterns
|
|
142
|
+
|
|
143
|
+
Several capabilities that look like missing features are compositions of
|
|
144
|
+
primitives that already ship — see `docs/guides/composition-recipes.md` for
|
|
145
|
+
the full recipes with executable-spec citations. Do not propose a new marker
|
|
146
|
+
or kernel API for any of these before reading it:
|
|
147
|
+
|
|
148
|
+
- a standard enhancer policy, a reusable entity-CRUD Ops base, a selection
|
|
149
|
+
read-model
|
|
150
|
+
- optimistic writes with server reconciliation (`transactions()`'s
|
|
151
|
+
pending/confirm/rollback lifecycle)
|
|
152
|
+
- staged/draft editing (an application-owned draft, one authored commit — no
|
|
153
|
+
`beginStage()` session API)
|
|
154
|
+
- one-shot loading (`external()`, no `link()` needed for a single fetch) versus
|
|
155
|
+
a persistent relationship with an external authority (`link()`'s three
|
|
156
|
+
composable directions: PULL/PUSH-IN/PUSH-OUT)
|
|
157
|
+
- accepted external truth is distinct from authored application work, so an
|
|
158
|
+
external write is not automatically a retained causal-history turn
|
|
159
|
+
- a human-readable explanation projected from the causal record (the
|
|
160
|
+
explanation is a PROJECTION of causal truth — the kernel does not store
|
|
161
|
+
prose, actor names, or timestamps merely to make one convenient)
|
|
162
|
+
|
|
163
|
+
`docs/guides/persistence-guide.md` is the `link()`-as-storage specialization
|
|
164
|
+
of the same model.
|
|
165
|
+
|
|
166
|
+
## Canonical Sources
|
|
167
|
+
|
|
168
|
+
- `AGENTS.md` — contributor and consumer rules
|
|
169
|
+
- `RELEASE-1.0.md` — v15 release invariants and current release state
|
|
170
|
+
- `README.md` — public package overview
|
|
171
|
+
- `packages/kernel/README.md` — kernel API and examples
|
|
172
|
+
- `packages/angular/README.md` — Angular realization
|
|
173
|
+
- `packages/react/README.md` — React observation
|
|
174
|
+
- `docs/guides/composition-recipes.md` — patterns built from existing primitives, no new API
|
|
175
|
+
- `docs/guides/persistence-guide.md` — the `link()`-as-storage recipe
|
|
176
|
+
- `docs/guides/migration-v14-v15.md` — `@signaltree/*` → `@signal-tree/*` migration (rename, consolidation, removed APIs)
|
|
177
|
+
- `docs/migration/post-rc1-workstream.md` — greenfield-first post-RC program
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@signal-tree/vue",
|
|
3
|
+
"version": "15.0.0-rc.14",
|
|
4
|
+
"description": "Vue observation for SignalTree.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"sideEffects": false,
|
|
8
|
+
"main": "./dist/index.js",
|
|
9
|
+
"module": "./dist/index.js",
|
|
10
|
+
"types": "./src/index.d.ts",
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./src/index.d.ts",
|
|
14
|
+
"import": "./dist/index.js",
|
|
15
|
+
"default": "./dist/index.js"
|
|
16
|
+
},
|
|
17
|
+
"./package.json": "./package.json"
|
|
18
|
+
},
|
|
19
|
+
"files": [
|
|
20
|
+
"dist/**/*.js",
|
|
21
|
+
"src/**/*.d.ts",
|
|
22
|
+
"README.md",
|
|
23
|
+
"LICENSE",
|
|
24
|
+
"NOTICE",
|
|
25
|
+
"llms.txt"
|
|
26
|
+
],
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"@signal-tree/kernel": "15.0.0-rc.14"
|
|
29
|
+
},
|
|
30
|
+
"peerDependencies": {
|
|
31
|
+
"tslib": "^2.0.0",
|
|
32
|
+
"vue": "^3.5.0"
|
|
33
|
+
},
|
|
34
|
+
"publishConfig": {
|
|
35
|
+
"access": "public"
|
|
36
|
+
},
|
|
37
|
+
"repository": {
|
|
38
|
+
"type": "git",
|
|
39
|
+
"url": "git+https://github.com/JBorgia/signal-tree.git",
|
|
40
|
+
"directory": "packages/vue"
|
|
41
|
+
}
|
|
42
|
+
}
|
package/src/index.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@signal-tree/vue` provides Vue-native refs over kernel-owned state.
|
|
3
|
+
*
|
|
4
|
+
* Values, writes, equality, and causal semantics remain kernel-owned.
|
|
5
|
+
*
|
|
6
|
+
* @packageDocumentation
|
|
7
|
+
*/
|
|
8
|
+
import './lib/carrier.js';
|
|
9
|
+
import { type AccessibleNodeOf, type EntityNodeOf, type EntitySignalOf, type EntitySignalWithSlicesOf, type ISignalTreeOf, type LeafOf, type ReadonlyStoreOf, type ReadonlyViewOf, type SignalTreeFactoryOf, type TreeNodeOf } from '@signal-tree/kernel/adapter';
|
|
10
|
+
/** Construct a SignalTree whose leaves are native Vue refs. */
|
|
11
|
+
export declare const signalTree: SignalTreeFactoryOf<"vue">;
|
|
12
|
+
export type TreeNode<T> = TreeNodeOf<T, 'vue'>;
|
|
13
|
+
export type WritableLeaf<T> = LeafOf<T, 'vue'>;
|
|
14
|
+
export type AccessibleNode<T> = AccessibleNodeOf<T, 'vue'>;
|
|
15
|
+
export type ISignalTree<T, TAccum = TreeNode<T>> = ISignalTreeOf<T, 'vue', TAccum>;
|
|
16
|
+
export type SignalTree<T> = ISignalTree<T>;
|
|
17
|
+
export type EntityNode<E> = EntityNodeOf<E, 'vue'>;
|
|
18
|
+
export type EntitySignal<E, K extends string | number = string> = EntitySignalOf<E, K, 'vue'>;
|
|
19
|
+
export type EntitySignalWithSlices<E, K extends string | number, Slices extends Record<string, unknown>> = EntitySignalWithSlicesOf<E, K, Slices, 'vue'>;
|
|
20
|
+
export type ReadonlyView<T> = ReadonlyViewOf<T, 'vue'>;
|
|
21
|
+
export type ReadonlyStore<TSource, TAccum = TreeNode<TSource>> = ReadonlyStoreOf<TSource, TAccum, 'vue'>;
|
|
22
|
+
export declare const asReadonly: <TSource, TAccum>(tree: ISignalTreeOf<TSource, "vue", TAccum>) => ReadonlyStoreOf<TSource, TAccum, "vue">;
|
|
23
|
+
export * from '@signal-tree/kernel';
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { ComputedRef, Ref } from 'vue';
|
|
2
|
+
export type VueLeaf<T> = Ref<T>;
|
|
3
|
+
declare module '@signal-tree/kernel/adapter' {
|
|
4
|
+
interface LeafCarriers<T> {
|
|
5
|
+
vue: VueLeaf<T>;
|
|
6
|
+
}
|
|
7
|
+
interface ReadonlyLeafCarriers<T> {
|
|
8
|
+
vue: ComputedRef<T>;
|
|
9
|
+
}
|
|
10
|
+
interface ReadonlyViewLeafCarriers<T> {
|
|
11
|
+
vue: Readonly<Ref<T>>;
|
|
12
|
+
}
|
|
13
|
+
}
|