@rbxts/scribe 2.5.0 → 2.6.1

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.
@@ -1,201 +1,201 @@
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 [yyyy] [name of copyright owner]
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.
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 [yyyy] [name of copyright owner]
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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/scribe",
3
- "version": "2.5.0",
3
+ "version": "2.6.1",
4
4
  "description": "Persistent, schema-typed, automatically replicated Roblox data.",
5
5
  "main": "src/init.luau",
6
6
  "types": "types/index.d.ts",
@@ -133,7 +133,8 @@ function Client.new(options: any, compiled: Template.Compiled): any
133
133
  local purchaseRequestPending = false
134
134
 
135
135
  local tree = Node.NewTree({
136
- Compiled = compiled,
136
+ -- Decoding, defaults and Shared mirrors still use the full compile.
137
+ Compiled = if editMode then compiled else Template.ClientView(compiled),
137
138
  Stores = { Persist = mirror, Session = mirror },
138
139
  IsServer = false,
139
140
  Label = "LocalPlayer",
@@ -781,7 +782,7 @@ function Client.new(options: any, compiled: Template.Compiled): any
781
782
  Sched.Resume(thread)
782
783
  end
783
784
  end
784
- disconnect = tree.Accessor[Template.SESSION_ROOT].OwnsSynced.Changed(function(v)
785
+ disconnect = tree.ReservedSession.OwnsSynced.Changed(function(v)
785
786
  if v == true then
786
787
  wake()
787
788
  end
@@ -841,13 +842,11 @@ function Client.new(options: any, compiled: Template.Compiled): any
841
842
  ownsWatched = true
842
843
  waitForLoaded()
843
844
  scanOwnership(true) -- baseline: current ownership is not a "change"
844
- local accessor = tree.Accessor
845
- -- Through the privileged handle, not the public child: a public read of the
846
- -- reserved root hands back a detached deep copy (readOut in Node.luau).
845
+ -- Public reserved-root reads return copies; these handles keep live values.
847
846
  tree.Reserved.Perks.Changed(function()
848
847
  scanOwnership()
849
848
  end)
850
- accessor[Template.SESSION_ROOT].OwnsCache.Changed(function()
849
+ tree.ReservedSession.OwnsCache.Changed(function()
851
850
  scanOwnership()
852
851
  end)
853
852
  end
@@ -866,10 +865,8 @@ function Client.new(options: any, compiled: Template.Compiled): any
866
865
  Sched.Spawn(callback, owned)
867
866
  end
868
867
  end
869
- local accessor = tree.Accessor
870
- -- Privileged handle: see the note in ensureOwnershipWatched.
871
868
  local disconnectPerk = tree.Reserved.Perks.Changed(push)
872
- local disconnectCache = accessor[Template.SESSION_ROOT].OwnsCache.Changed(push)
869
+ local disconnectCache = tree.ReservedSession.OwnsCache.Changed(push)
873
870
  push()
874
871
  return function()
875
872
  disconnectPerk()
@@ -1362,7 +1359,7 @@ function Client.new(options: any, compiled: Template.Compiled): any
1362
1359
  local loadedConn = if loaded then nil else loadedSignal:Connect(push)
1363
1360
  table.insert(policyObservers, push)
1364
1361
  local disconnectPerk = tree.Reserved.Perks.Changed(push)
1365
- local disconnectCache = tree.Accessor[Template.SESSION_ROOT].OwnsCache.Changed(push)
1362
+ local disconnectCache = tree.ReservedSession.OwnsCache.Changed(push)
1366
1363
  push()
1367
1364
  return function()
1368
1365
  if loadedConn ~= nil then
@@ -1473,7 +1470,7 @@ function Client.new(options: any, compiled: Template.Compiled): any
1473
1470
  if values then
1474
1471
  for key, value in values do
1475
1472
  local current = mirror[key]
1476
- tree.Accessor[key].Set(deepMerge(current, value))
1473
+ tree.Accessor.Child(key).Set(deepMerge(current, value))
1477
1474
  end
1478
1475
  end
1479
1476
  if scribeState then
@@ -1482,7 +1479,7 @@ function Client.new(options: any, compiled: Template.Compiled): any
1482
1479
  local reservedAccessor = tree.Reserved
1483
1480
  if scribeState.Perks then
1484
1481
  for _, perk in scribeState.Perks :: { string } do
1485
- reservedAccessor.Perks[perk].Set(true)
1482
+ reservedAccessor.Perks.Child(perk).Set(true)
1486
1483
  end
1487
1484
  end
1488
1485
  if scribeState.GiftCredits then
@@ -600,12 +600,16 @@ codecs.PhysicalProperties = {
600
600
 
601
601
  --------------------------------------------------------------------------------
602
602
 
603
+ --[[
604
+ Returns whether Scribe has a codec for this datatype.
605
+ ]]
603
606
  function Datatypes.IsSupported(name: string): boolean
604
607
  return codecs[name] ~= nil
605
608
  end
606
609
 
607
- --- The Precision values `name` accepts, sorted, or nil when it accepts none.
608
- --- The template compiler reads this to refuse a bad declaration at startup.
610
+ --[[
611
+ Returns the supported precision options, or nil when none exist.
612
+ ]]
609
613
  function Datatypes.PrecisionValues(name: string): { string }?
610
614
  local codec = codecs[name]
611
615
  local accepted = codec and codec.Precisions
@@ -620,10 +624,9 @@ function Datatypes.PrecisionValues(name: string): { string }?
620
624
  return out
621
625
  end
622
626
 
623
- --- Packs `value` as `name`. `precision` is optional; omitted, every datatype packs its
624
- --- default form. Validated here rather than inside each codec so a codec with no
625
- --- Precision option gets the refusal for free, and so a typo is reported instead of
626
- --- quietly yielding the default form.
627
+ --[[
628
+ Encodes a supported Roblox datatype into a buffer.
629
+ ]]
627
630
  function Datatypes.Pack(name: string, value: any, precision: (string | number)?): buffer
628
631
  local codec = codecs[name]
629
632
  if not codec then
@@ -642,6 +645,9 @@ function Datatypes.Pack(name: string, value: any, precision: (string | number)?)
642
645
  return codec.Pack(value, precision)
643
646
  end
644
647
 
648
+ --[[
649
+ Decodes a packed buffer into its Roblox datatype.
650
+ ]]
645
651
  function Datatypes.Unpack(name: string, b: buffer): any
646
652
  local codec = codecs[name]
647
653
  if not codec then
@@ -108,14 +108,14 @@ end
108
108
  { Node, InputPaths (dotted strings), Compute }. `fail` is Template's compileError,
109
109
  passed in so the error text keeps one format.
110
110
 
111
- Returns the topologically ordered node list and the write index.
111
+ Returns the topologically ordered node list, the write index and the below index.
112
112
  ]]
113
113
  function Derived.Resolve(
114
114
  root: any,
115
115
  pending: { { Node: any, InputPaths: { string }, Compute: (...any) -> any } },
116
116
  reservedRoots: { [string]: boolean },
117
117
  fail: (path: { string }, message: string) -> ()
118
- ): ({ any }, { [string]: { any } })
118
+ ): ({ any }, { [string]: { any } }, { [string]: { any } })
119
119
  -- Resolve and validate every input before ordering: a cycle message is only
120
120
  -- useful once the edges it names are known to be real fields.
121
121
  for _, entry in pending do
@@ -197,6 +197,7 @@ function Derived.Resolve(
197
197
  InputPaths = inputPaths,
198
198
  Compute = entry.Compute,
199
199
  Transmit = false, -- decided below, once the graph is ordered
200
+ ClientComputes = false,
200
201
  OfflineComputable = false,
201
202
  Label = table.concat(node.Path, "."),
202
203
  }
@@ -256,6 +257,17 @@ function Derived.Resolve(
256
257
  end
257
258
  node.Derived.Transmit = transmit
258
259
 
260
+ -- Clients compute only visible fields with visible inputs. Transmitted inputs
261
+ -- arrive before their dependents recompute.
262
+ local clientComputes = node.Visibility ~= "ServerOnly"
263
+ for _, input in node.Derived.Inputs do
264
+ if input.Visibility == "ServerOnly" then
265
+ clientComputes = false
266
+ break
267
+ end
268
+ end
269
+ node.Derived.ClientComputes = clientComputes
270
+
259
271
  -- Offline reads see stored data only, so a root-level field whose every input
260
272
  -- persists can be computed over a snapshot. A derived input never persists but
261
273
  -- is filled in first (both passes run in topological order), so it counts as
@@ -273,11 +285,10 @@ function Derived.Resolve(
273
285
  node.Derived.OfflineComputable = offline
274
286
  end
275
287
 
276
- -- Write index: a write at path W must recompute a dependent on input I when
277
- -- W == I or W is an ancestor of I (a whole-root Set from an init snapshot, say).
278
- -- Inputs are leaves, so no other relationship exists and one exact lookup per
279
- -- write is complete.
288
+ -- Recompute on input writes or ancestor replacement. Exclude the output itself
289
+ -- to avoid recursion. `below` lists fields to carry across record replacements.
280
290
  local byWrite: { [string]: { any } } = {}
291
+ local below: { [string]: { any } } = {}
281
292
  for _, node in ordered do
282
293
  for _, segments in node.Derived.InputPaths do
283
294
  local prefix: { string | number } = {}
@@ -301,9 +312,28 @@ function Derived.Resolve(
301
312
  end
302
313
  end
303
314
  end
315
+ local outPrefix: { string | number } = {}
316
+ for i = 1, #node.Path - 1 do
317
+ table.insert(outPrefix, node.Path[i])
318
+ local key = Util.pathKey(outPrefix)
319
+ local list = byWrite[key]
320
+ if list == nil then
321
+ list = {}
322
+ byWrite[key] = list
323
+ end
324
+ if table.find(list, node) == nil then
325
+ table.insert(list, node)
326
+ end
327
+ local under = below[key]
328
+ if under == nil then
329
+ under = {}
330
+ below[key] = under
331
+ end
332
+ table.insert(under, node)
333
+ end
304
334
  end
305
335
 
306
- return ordered, byWrite
336
+ return ordered, byWrite, below
307
337
  end
308
338
 
309
339
  -- Validates a computed value against the output declarator, at the one place that