@isograph/react 0.4.3 → 0.5.0

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.
Files changed (137) hide show
  1. package/.turbo/turbo-compile-libs.log +2 -2
  2. package/dist/core/FragmentReference.d.ts +4 -2
  3. package/dist/core/FragmentReference.d.ts.map +1 -1
  4. package/dist/core/FragmentReference.js +2 -2
  5. package/dist/core/IsographEnvironment.d.ts +19 -11
  6. package/dist/core/IsographEnvironment.d.ts.map +1 -1
  7. package/dist/core/IsographEnvironment.js +27 -2
  8. package/dist/core/PromiseWrapper.d.ts +13 -7
  9. package/dist/core/PromiseWrapper.d.ts.map +1 -1
  10. package/dist/core/brand.d.ts +17 -0
  11. package/dist/core/brand.d.ts.map +1 -1
  12. package/dist/core/cache.d.ts +10 -7
  13. package/dist/core/cache.d.ts.map +1 -1
  14. package/dist/core/cache.js +102 -74
  15. package/dist/core/check.d.ts +8 -4
  16. package/dist/core/check.d.ts.map +1 -1
  17. package/dist/core/check.js +10 -7
  18. package/dist/core/componentCache.d.ts +1 -1
  19. package/dist/core/componentCache.d.ts.map +1 -1
  20. package/dist/core/componentCache.js +6 -4
  21. package/dist/core/entrypoint.d.ts +17 -7
  22. package/dist/core/entrypoint.d.ts.map +1 -1
  23. package/dist/core/garbageCollection.d.ts +8 -2
  24. package/dist/core/garbageCollection.d.ts.map +1 -1
  25. package/dist/core/garbageCollection.js +36 -14
  26. package/dist/core/logging.d.ts +16 -3
  27. package/dist/core/logging.d.ts.map +1 -1
  28. package/dist/core/makeNetworkRequest.d.ts +4 -2
  29. package/dist/core/makeNetworkRequest.d.ts.map +1 -1
  30. package/dist/core/makeNetworkRequest.js +115 -38
  31. package/dist/core/optimisticProxy.d.ts +59 -0
  32. package/dist/core/optimisticProxy.d.ts.map +1 -0
  33. package/dist/core/optimisticProxy.js +399 -0
  34. package/dist/core/read.d.ts +3 -2
  35. package/dist/core/read.d.ts.map +1 -1
  36. package/dist/core/read.js +158 -123
  37. package/dist/core/reader.d.ts +7 -4
  38. package/dist/core/reader.d.ts.map +1 -1
  39. package/dist/core/startUpdate.d.ts +3 -2
  40. package/dist/core/startUpdate.d.ts.map +1 -1
  41. package/dist/core/startUpdate.js +33 -34
  42. package/dist/index.d.ts +2 -2
  43. package/dist/index.d.ts.map +1 -1
  44. package/dist/index.js +2 -1
  45. package/dist/loadable-hooks/useClientSideDefer.d.ts +9 -4
  46. package/dist/loadable-hooks/useClientSideDefer.d.ts.map +1 -1
  47. package/dist/loadable-hooks/useClientSideDefer.js +34 -1
  48. package/dist/loadable-hooks/useConnectionSpecPagination.d.ts +5 -3
  49. package/dist/loadable-hooks/useConnectionSpecPagination.d.ts.map +1 -1
  50. package/dist/loadable-hooks/useConnectionSpecPagination.js +27 -13
  51. package/dist/loadable-hooks/useImperativeLoadableField.d.ts +1 -1
  52. package/dist/loadable-hooks/useImperativeLoadableField.d.ts.map +1 -1
  53. package/dist/loadable-hooks/useSkipLimitPagination.d.ts +1 -1
  54. package/dist/loadable-hooks/useSkipLimitPagination.d.ts.map +1 -1
  55. package/dist/loadable-hooks/useSkipLimitPagination.js +1 -1
  56. package/dist/react/FragmentReader.d.ts +2 -1
  57. package/dist/react/FragmentReader.d.ts.map +1 -1
  58. package/dist/react/FragmentRenderer.d.ts +2 -1
  59. package/dist/react/FragmentRenderer.d.ts.map +1 -1
  60. package/dist/react/LoadableFieldReader.d.ts +9 -3
  61. package/dist/react/LoadableFieldReader.d.ts.map +1 -1
  62. package/dist/react/LoadableFieldReader.js +40 -1
  63. package/dist/react/LoadableFieldRenderer.d.ts +9 -3
  64. package/dist/react/LoadableFieldRenderer.d.ts.map +1 -1
  65. package/dist/react/LoadableFieldRenderer.js +36 -1
  66. package/dist/react/useImperativeReference.d.ts +4 -3
  67. package/dist/react/useImperativeReference.d.ts.map +1 -1
  68. package/dist/react/useImperativeReference.js +3 -5
  69. package/dist/react/useLazyReference.d.ts +2 -1
  70. package/dist/react/useLazyReference.d.ts.map +1 -1
  71. package/dist/react/useReadAndSubscribe.d.ts.map +1 -1
  72. package/dist/react/useReadAndSubscribe.js +1 -3
  73. package/dist/react/useResult.d.ts.map +1 -1
  74. package/dist/react/useResult.js +6 -5
  75. package/package.json +16 -17
  76. package/src/core/FragmentReference.ts +10 -4
  77. package/src/core/IsographEnvironment.ts +59 -13
  78. package/src/core/PromiseWrapper.ts +14 -7
  79. package/src/core/brand.ts +18 -0
  80. package/src/core/cache.ts +186 -91
  81. package/src/core/check.ts +21 -10
  82. package/src/core/componentCache.ts +8 -4
  83. package/src/core/entrypoint.ts +35 -6
  84. package/src/core/garbageCollection.ts +61 -19
  85. package/src/core/logging.ts +15 -3
  86. package/src/core/makeNetworkRequest.ts +307 -74
  87. package/src/core/optimisticProxy.ts +563 -0
  88. package/src/core/read.ts +233 -163
  89. package/src/core/reader.ts +10 -6
  90. package/src/core/startUpdate.ts +45 -30
  91. package/src/index.ts +2 -1
  92. package/src/loadable-hooks/useClientSideDefer.ts +76 -26
  93. package/src/loadable-hooks/useConnectionSpecPagination.ts +34 -17
  94. package/src/loadable-hooks/useImperativeLoadableField.ts +2 -2
  95. package/src/loadable-hooks/useSkipLimitPagination.ts +2 -3
  96. package/src/react/FragmentReader.tsx +3 -1
  97. package/src/react/FragmentRenderer.tsx +8 -1
  98. package/src/react/LoadableFieldReader.tsx +123 -12
  99. package/src/react/LoadableFieldRenderer.tsx +122 -12
  100. package/src/react/useImperativeReference.ts +20 -11
  101. package/src/react/useLazyReference.ts +17 -6
  102. package/src/react/useReadAndSubscribe.ts +1 -8
  103. package/src/react/useResult.ts +9 -11
  104. package/src/tests/__isograph/Node/asEconomist/resolver_reader.ts +1 -1
  105. package/src/tests/__isograph/Query/linkedUpdate/entrypoint.ts +3 -1
  106. package/src/tests/__isograph/Query/linkedUpdate/raw_response_type.ts +13 -0
  107. package/src/tests/__isograph/Query/linkedUpdate/resolver_reader.ts +1 -1
  108. package/src/tests/__isograph/Query/meName/entrypoint.ts +3 -1
  109. package/src/tests/__isograph/Query/meName/raw_response_type.ts +7 -0
  110. package/src/tests/__isograph/Query/meName/resolver_reader.ts +1 -1
  111. package/src/tests/__isograph/Query/meNameSuccessor/entrypoint.ts +3 -1
  112. package/src/tests/__isograph/Query/meNameSuccessor/raw_response_type.ts +14 -0
  113. package/src/tests/__isograph/Query/meNameSuccessor/resolver_reader.ts +1 -1
  114. package/src/tests/__isograph/Query/nodeField/entrypoint.ts +3 -1
  115. package/src/tests/__isograph/Query/nodeField/raw_response_type.ts +7 -0
  116. package/src/tests/__isograph/Query/nodeField/resolver_reader.ts +1 -1
  117. package/src/tests/__isograph/Query/normalizeUndefinedField/entrypoint.ts +33 -0
  118. package/src/tests/__isograph/Query/normalizeUndefinedField/normalization_ast.ts +25 -0
  119. package/src/tests/__isograph/Query/normalizeUndefinedField/output_type.ts +3 -0
  120. package/src/tests/__isograph/Query/normalizeUndefinedField/param_type.ts +9 -0
  121. package/src/tests/__isograph/Query/normalizeUndefinedField/query_text.ts +6 -0
  122. package/src/tests/__isograph/Query/normalizeUndefinedField/raw_response_type.ts +7 -0
  123. package/src/tests/__isograph/Query/normalizeUndefinedField/resolver_reader.ts +38 -0
  124. package/src/tests/__isograph/Query/startUpdate/entrypoint.ts +3 -1
  125. package/src/tests/__isograph/Query/startUpdate/raw_response_type.ts +8 -0
  126. package/src/tests/__isograph/Query/startUpdate/resolver_reader.ts +1 -1
  127. package/src/tests/__isograph/Query/subquery/entrypoint.ts +3 -1
  128. package/src/tests/__isograph/Query/subquery/raw_response_type.ts +9 -0
  129. package/src/tests/__isograph/Query/subquery/resolver_reader.ts +1 -1
  130. package/src/tests/__isograph/iso.ts +11 -1
  131. package/src/tests/garbageCollection.test.ts +8 -5
  132. package/src/tests/meNameSuccessor.ts +6 -3
  133. package/src/tests/nodeQuery.ts +4 -2
  134. package/src/tests/normalizeData.test.ts +89 -15
  135. package/src/tests/optimisticProxy.test.ts +860 -0
  136. package/src/tests/startUpdate.test.ts +7 -5
  137. package/src/tests/__isograph/Economist/__link/output_type.ts +0 -2
@@ -0,0 +1,399 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getOrInsertRecord = getOrInsertRecord;
4
+ exports.getStoreRecordProxy = getStoreRecordProxy;
5
+ exports.getMutableStoreRecordProxy = getMutableStoreRecordProxy;
6
+ exports.addNetworkResponseStoreLayer = addNetworkResponseStoreLayer;
7
+ exports.addStartUpdateStoreLayer = addStartUpdateStoreLayer;
8
+ exports.addOptimisticUpdaterStoreLayer = addOptimisticUpdaterStoreLayer;
9
+ exports.addOptimisticNetworkResponseStoreLayer = addOptimisticNetworkResponseStoreLayer;
10
+ exports.revertOptimisticStoreLayerAndMaybeReplace = revertOptimisticStoreLayerAndMaybeReplace;
11
+ const cache_1 = require("./cache");
12
+ function getOrInsertRecord(dataLayer, link) {
13
+ var _a, _b;
14
+ var _c, _d;
15
+ const recordsById = ((_a = dataLayer[_c = link.__typename]) !== null && _a !== void 0 ? _a : (dataLayer[_c] = {}));
16
+ return ((_b = recordsById[_d = link.__link]) !== null && _b !== void 0 ? _b : (recordsById[_d] = {}));
17
+ }
18
+ /**
19
+ * Given the child-most store layer (i.e. environment.store) and a link (identifying a
20
+ * store record), create a proxy object that attempts to read through each successive
21
+ * store layer until a value (i.e. field name) is found. If found, return that value.
22
+ */
23
+ function getStoreRecordProxy(storeLayer, link) {
24
+ var _a;
25
+ let startNode = storeLayer;
26
+ while (startNode !== null) {
27
+ const storeRecord = (_a = startNode.data[link.__typename]) === null || _a === void 0 ? void 0 : _a[link.__link];
28
+ if (storeRecord === null) {
29
+ return null;
30
+ }
31
+ if (storeRecord != null) {
32
+ return getMutableStoreRecordProxy(startNode, link);
33
+ }
34
+ startNode = startNode.parentStoreLayer;
35
+ }
36
+ return undefined;
37
+ }
38
+ function getMutableStoreRecordProxy(childMostStoreLayer, link) {
39
+ return new Proxy({}, {
40
+ get(_, propertyName) {
41
+ var _a;
42
+ let currentStoreLayer = childMostStoreLayer;
43
+ while (currentStoreLayer !== null) {
44
+ const storeRecord = (_a = currentStoreLayer.data[link.__typename]) === null || _a === void 0 ? void 0 : _a[link.__link];
45
+ if (storeRecord === null) {
46
+ return undefined;
47
+ }
48
+ if (storeRecord != null) {
49
+ const value = Reflect.get(storeRecord, propertyName);
50
+ if (value !== undefined) {
51
+ return value;
52
+ }
53
+ }
54
+ currentStoreLayer = currentStoreLayer.parentStoreLayer;
55
+ }
56
+ },
57
+ has(_, propertyName) {
58
+ var _a;
59
+ let currentStoreLayer = childMostStoreLayer;
60
+ while (currentStoreLayer !== null) {
61
+ const storeRecord = (_a = currentStoreLayer.data[link.__typename]) === null || _a === void 0 ? void 0 : _a[link.__link];
62
+ if (storeRecord === null) {
63
+ return false;
64
+ }
65
+ if (storeRecord != null) {
66
+ const value = Reflect.has(storeRecord, propertyName);
67
+ if (value !== undefined) {
68
+ return true;
69
+ }
70
+ }
71
+ currentStoreLayer = currentStoreLayer.parentStoreLayer;
72
+ }
73
+ return false;
74
+ },
75
+ set(_, p, newValue) {
76
+ return Reflect.set(getOrInsertRecord(childMostStoreLayer.data, link), p, newValue);
77
+ },
78
+ });
79
+ }
80
+ function addNetworkResponseStoreLayer(parent) {
81
+ switch (parent.kind) {
82
+ case 'NetworkResponseStoreLayer':
83
+ case 'BaseStoreLayer': {
84
+ return parent;
85
+ }
86
+ case 'StartUpdateStoreLayer':
87
+ case 'OptimisticNetworkResponseStoreLayer':
88
+ case 'OptimisticUpdaterStoreLayer': {
89
+ const node = {
90
+ kind: 'NetworkResponseStoreLayer',
91
+ parentStoreLayer: parent,
92
+ childStoreLayer: null,
93
+ data: {},
94
+ };
95
+ parent.childStoreLayer = node;
96
+ return node;
97
+ }
98
+ default: {
99
+ parent;
100
+ throw new Error('Unreachable. This is a bug in Isograph.');
101
+ }
102
+ }
103
+ }
104
+ function mergeDataLayer(target, source) {
105
+ var _a, _b;
106
+ for (const [typeName, sourceById] of Object.entries(source)) {
107
+ if (sourceById == null) {
108
+ target[typeName] = sourceById;
109
+ continue;
110
+ }
111
+ const targetRecordById = ((_a = target[typeName]) !== null && _a !== void 0 ? _a : (target[typeName] = {}));
112
+ for (const [id, sourceRecord] of Object.entries(sourceById)) {
113
+ if (sourceRecord === null) {
114
+ targetRecordById[id] = null;
115
+ continue;
116
+ }
117
+ const targetRecord = ((_b = targetRecordById[id]) !== null && _b !== void 0 ? _b : (targetRecordById[id] = {}));
118
+ Object.assign(targetRecord, sourceRecord);
119
+ }
120
+ }
121
+ }
122
+ function addStartUpdateStoreLayer(parent, startUpdate) {
123
+ switch (parent.kind) {
124
+ case 'BaseStoreLayer': {
125
+ startUpdate(parent);
126
+ return parent;
127
+ }
128
+ case 'StartUpdateStoreLayer': {
129
+ const node = parent;
130
+ const prevStartUpdate = node.startUpdate;
131
+ node.startUpdate = () => {
132
+ prevStartUpdate(node);
133
+ startUpdate(node);
134
+ };
135
+ startUpdate(node);
136
+ return node;
137
+ }
138
+ case 'NetworkResponseStoreLayer':
139
+ case 'OptimisticNetworkResponseStoreLayer':
140
+ case 'OptimisticUpdaterStoreLayer': {
141
+ const node = {
142
+ kind: 'StartUpdateStoreLayer',
143
+ parentStoreLayer: parent,
144
+ childStoreLayer: null,
145
+ data: {},
146
+ startUpdate: startUpdate,
147
+ };
148
+ parent.childStoreLayer = node;
149
+ startUpdate(node);
150
+ return node;
151
+ }
152
+ default: {
153
+ parent;
154
+ throw new Error('Unreachable. This is a bug in Isograph.');
155
+ }
156
+ }
157
+ }
158
+ function addOptimisticUpdaterStoreLayer(parent, startUpdate) {
159
+ switch (parent.kind) {
160
+ case 'BaseStoreLayer':
161
+ case 'StartUpdateStoreLayer':
162
+ case 'NetworkResponseStoreLayer':
163
+ case 'OptimisticNetworkResponseStoreLayer':
164
+ case 'OptimisticUpdaterStoreLayer': {
165
+ const node = {
166
+ kind: 'OptimisticUpdaterStoreLayer',
167
+ parentStoreLayer: parent,
168
+ childStoreLayer: null,
169
+ data: {},
170
+ startUpdate: startUpdate,
171
+ };
172
+ startUpdate(node);
173
+ parent.childStoreLayer = node;
174
+ return node;
175
+ }
176
+ default: {
177
+ parent;
178
+ throw new Error('Unreachable. This is a bug in Isograph.');
179
+ }
180
+ }
181
+ }
182
+ function addOptimisticNetworkResponseStoreLayer(parent) {
183
+ switch (parent.kind) {
184
+ case 'BaseStoreLayer':
185
+ case 'StartUpdateStoreLayer':
186
+ case 'NetworkResponseStoreLayer':
187
+ case 'OptimisticNetworkResponseStoreLayer':
188
+ case 'OptimisticUpdaterStoreLayer': {
189
+ const node = {
190
+ kind: 'OptimisticNetworkResponseStoreLayer',
191
+ parentStoreLayer: parent,
192
+ childStoreLayer: null,
193
+ data: {},
194
+ };
195
+ parent.childStoreLayer = node;
196
+ return node;
197
+ }
198
+ default: {
199
+ parent;
200
+ throw new Error('Unreachable. This is a bug in Isograph.');
201
+ }
202
+ }
203
+ }
204
+ /**
205
+ * Merge storeLayerToMerge, and its children, into baseStoreLayer.
206
+ * We can merge until we reach a revertible layer (i.e. an optimistic layer).
207
+ * All other layers cannot be reverted, so for housekeeping + perf, we merge
208
+ * them into a single layer.
209
+ *
210
+ * Note that BaseStoreLayer.childStoreLayer has type OptimisticStoreLayer | null.
211
+ * So, the state of the stack is never e.g. base <- network response. Instead,
212
+ * we have a base + a child that we would like to attach to the base. So, we merge
213
+ * (flatten) until we reach an optimistic layer or null, at which point, we can
214
+ * set baseStoreLayer.childStoreLayer = storeLayerToMerge (via setChildOfNode).
215
+ */
216
+ function mergeLayersWithDataIntoBaseLayer(environment, storeLayerToMerge, baseStoreLayer) {
217
+ while (storeLayerToMerge &&
218
+ storeLayerToMerge.kind !== 'OptimisticUpdaterStoreLayer') {
219
+ mergeDataLayer(baseStoreLayer.data, storeLayerToMerge.data);
220
+ storeLayerToMerge = storeLayerToMerge.childStoreLayer;
221
+ }
222
+ setChildOfNode(environment, baseStoreLayer, storeLayerToMerge);
223
+ }
224
+ /**
225
+ * Now that we have replaced the optimistic layer with a network response layer, we need
226
+ * to
227
+ * - re-execute startUpdate and optimistic nodes, in light of the replaced data, and
228
+ * - create two objects containing the old merged data (from the optimistic update layer
229
+ * onward) and the new merged data (from the network response layer onward).
230
+ * - we will compare the new and old merged data in order to determine the changed records
231
+ * and trigger subscriptions.
232
+ *
233
+ * Here, "merged data" means all of the records + fields that were modified, starting at
234
+ * storeLayer, e.g. in BaseLayer <- OptimisticLayer <- StartUpdateLayer, if we
235
+ * are replacing Optimistic, then oldData will contain the records + fields modified by
236
+ * OptimisticLayer + StartUpdateLayer.
237
+ */
238
+ function reexecuteUpdatesAndMergeData(storeLayer,
239
+ // reflects the (now reverted) optimistic layer
240
+ oldMergedData,
241
+ // reflects whatever replaced the optimistic layer
242
+ newMergedData) {
243
+ while (storeLayer !== null) {
244
+ mergeDataLayer(oldMergedData, storeLayer.data);
245
+ switch (storeLayer.kind) {
246
+ case 'OptimisticNetworkResponseStoreLayer':
247
+ case 'NetworkResponseStoreLayer':
248
+ break;
249
+ case 'StartUpdateStoreLayer': {
250
+ storeLayer.data = {};
251
+ storeLayer.startUpdate(storeLayer);
252
+ break;
253
+ }
254
+ case 'OptimisticUpdaterStoreLayer': {
255
+ storeLayer.data = {};
256
+ storeLayer.startUpdate(storeLayer);
257
+ break;
258
+ }
259
+ default: {
260
+ storeLayer;
261
+ throw new Error('Unreachable. This is a bug in Isograph.');
262
+ }
263
+ }
264
+ mergeDataLayer(newMergedData, storeLayer.data);
265
+ storeLayer = storeLayer.childStoreLayer;
266
+ }
267
+ }
268
+ /**
269
+ * Set storeLayerToModify's child to a given layer. This may be null!
270
+ * If it is null, set the environment.store to storeLayerToModify.
271
+ * If it is not null, then the existing environment.store value remains
272
+ * valid.
273
+ */
274
+ function setChildOfNode(environment, storeLayerToModify, newChildStoreLayer) {
275
+ storeLayerToModify.childStoreLayer = newChildStoreLayer;
276
+ if (newChildStoreLayer !== null) {
277
+ newChildStoreLayer.parentStoreLayer = storeLayerToModify;
278
+ }
279
+ else {
280
+ environment.store = storeLayerToModify;
281
+ }
282
+ }
283
+ /**
284
+ * Remove an optimistic store layer from the stack, potentially replacing it
285
+ * with a network response.
286
+ *
287
+ * After we do this, we must re-execute all child startUpdate and optimistic
288
+ * layers (since their data may have changed.) We also keep track of changed
289
+ * records, in order to call affected subscriptions.
290
+ */
291
+ function revertOptimisticStoreLayerAndMaybeReplace(environment, optimisticNode, normalizeData) {
292
+ var _a;
293
+ // We cannot just replace the optimistic node with the network response node,
294
+ // because (e.g.) the types allow Base <- Opt, but not Base <- NetworkResponse.
295
+ // We also may be removing the optimistic layer without replacing it with
296
+ // anything, which would also be disallowed if the original stack was
297
+ // Base <- Opt <- NetworkResponse.
298
+ //
299
+ // Thus, instead, we will (1) replace the optimistic node's data with an empty object
300
+ // and attach the network response as a child.
301
+ const oldMergedData = optimisticNode.data;
302
+ optimisticNode.data = {};
303
+ let newMergedData = {};
304
+ let childNode = optimisticNode.childStoreLayer;
305
+ if (normalizeData !== null) {
306
+ const networkResponseStoreLayer = {
307
+ kind: 'NetworkResponseStoreLayer',
308
+ data: {},
309
+ parentStoreLayer: optimisticNode,
310
+ childStoreLayer: null,
311
+ };
312
+ normalizeData(networkResponseStoreLayer);
313
+ if ((childNode === null || childNode === void 0 ? void 0 : childNode.kind) === 'NetworkResponseStoreLayer') {
314
+ // (2) if the optimistic layer's child was a network response, and we are
315
+ // replacing it with a network response, we must merge the replacement
316
+ // and the child.
317
+ mergeDataLayer(networkResponseStoreLayer.data, childNode.data);
318
+ mergeDataLayer(oldMergedData, childNode.data);
319
+ childNode = childNode.childStoreLayer;
320
+ }
321
+ newMergedData = structuredClone(networkResponseStoreLayer.data);
322
+ setChildOfNode(environment, networkResponseStoreLayer, childNode);
323
+ optimisticNode.childStoreLayer = networkResponseStoreLayer;
324
+ }
325
+ // (3) Re-execute all updates, accumulating all changed values into newMergedData.
326
+ // Since we have already written the network response into newMergedData, we
327
+ // can proceed from the child of the (potentially merged) network response layer.
328
+ //
329
+ // Note that it is important that reexecuteUpdatesAndMergeData is called here!
330
+ // That is because we created newMergedData from the network response layer's data,
331
+ // and later, we may merge that network response into the parent layer (if it is
332
+ // a base layer). That merged layer will contain many extraneous records (unless the
333
+ // base layer is empty).
334
+ //
335
+ // This would cause us to re-execute subscriptions unnecessarily, as these records
336
+ // do not represent changes between the optimistic and network response layers.
337
+ reexecuteUpdatesAndMergeData(childNode, oldMergedData, newMergedData);
338
+ // (4) Now, we can finally remove the optimistic layer, i.e. do
339
+ // optimistic.parent.child = optimistic.child.
340
+ // But the types don't line up, so we handle the cases differently, based on the
341
+ // parent layer type.
342
+ if (optimisticNode.parentStoreLayer.kind === 'BaseStoreLayer') {
343
+ // (4a) If the optimistic parent is the base layer, then we have a problem: base.child
344
+ // must be an optimistic layer or null. So, we merge the optimistic children into the
345
+ // base layer until we reach an optimistic layer.
346
+ mergeLayersWithDataIntoBaseLayer(environment, optimisticNode.childStoreLayer, optimisticNode.parentStoreLayer);
347
+ }
348
+ else if (optimisticNode.parentStoreLayer.kind === 'NetworkResponseStoreLayer' &&
349
+ ((_a = optimisticNode.childStoreLayer) === null || _a === void 0 ? void 0 : _a.kind) === 'NetworkResponseStoreLayer') {
350
+ // (4b) if the parent is a network response layer, simply merge those. (We do not
351
+ // attempt to merge other layers, e.g. startUpdate layers, because there is some
352
+ // optimistic layer between this layer and the base, and the startUpdate will need
353
+ // to be recalculated if the optimistic layer is reverted.)
354
+ mergeDataLayer(optimisticNode.parentStoreLayer.data, optimisticNode.childStoreLayer.data);
355
+ setChildOfNode(environment, optimisticNode.parentStoreLayer, optimisticNode.childStoreLayer.childStoreLayer);
356
+ }
357
+ else {
358
+ // (4c) Otherwise, the parent is an optimistic or start update layer, and we can
359
+ // set optimistic.parent.child = optimistic.child.
360
+ setChildOfNode(environment, optimisticNode.parentStoreLayer, optimisticNode.childStoreLayer);
361
+ }
362
+ // (5) finally, compare the oldMergedData and newMergedData objects, in order to extract
363
+ // the modified IDs, and re-execute subscriptions.
364
+ let encounteredIds = new Map();
365
+ compareData(oldMergedData, newMergedData, encounteredIds);
366
+ (0, cache_1.callSubscriptions)(environment, encounteredIds);
367
+ }
368
+ function compareData(oldData, newData, encounteredIds) {
369
+ var _a;
370
+ const oldDataTypeNames = new Set(Object.keys(oldData));
371
+ const newDataTypeNames = new Set(Object.keys(newData));
372
+ for (const oldTypeName of oldDataTypeNames.difference(newDataTypeNames)) {
373
+ const set = (0, cache_1.insertEmptySetIfMissing)(encounteredIds, oldTypeName);
374
+ for (const id in oldData[oldTypeName]) {
375
+ set.add(id);
376
+ }
377
+ }
378
+ for (const [typeName, newRecords] of Object.entries(newData)) {
379
+ if (newRecords == null) {
380
+ continue;
381
+ }
382
+ const oldRecords = oldData[typeName];
383
+ outer: for (const [id, newRecord] of Object.entries(newRecords)) {
384
+ if (newRecord == null) {
385
+ continue;
386
+ }
387
+ const oldRecord = oldRecords === null || oldRecords === void 0 ? void 0 : oldRecords[id];
388
+ for (const [recordKey, newRecordValue] of Object.entries(newRecord)) {
389
+ // TODO: compare links, compare arrays
390
+ if (newRecordValue !== (oldRecord === null || oldRecord === void 0 ? void 0 : oldRecord[recordKey])) {
391
+ const set = (0, cache_1.insertEmptySetIfMissing)(encounteredIds, typeName);
392
+ set.add(id);
393
+ continue outer;
394
+ }
395
+ }
396
+ (_a = encounteredIds.get(typeName)) === null || _a === void 0 ? void 0 : _a.delete(id);
397
+ }
398
+ }
399
+ }
@@ -3,7 +3,7 @@ import { RefetchQueryNormalizationArtifactWrapper } from './entrypoint';
3
3
  import { ExtractData, FragmentReference, Variables, type UnknownTReadFromStore } from './FragmentReference';
4
4
  import { IsographEnvironment, type DataTypeValue, type StoreLink, type StoreRecord } from './IsographEnvironment';
5
5
  import { PromiseWrapper } from './PromiseWrapper';
6
- import { ReaderAst, type LoadablySelectedField, type ReaderImperativelyLoadedField, type ReaderLinkedField, type ReaderNonLoadableResolverField, type ReaderScalarField } from './reader';
6
+ import { ReaderAst, type LoadablySelectedField, type ReaderClientPointer, type ReaderImperativelyLoadedField, type ReaderLinkedField, type ReaderNonLoadableResolverField, type ReaderScalarField } from './reader';
7
7
  export type WithEncounteredRecords<T> = {
8
8
  readonly encounteredRecords: EncounteredIds;
9
9
  readonly item: ExtractData<T>;
@@ -21,8 +21,9 @@ export type ReadDataResult<Data> = ReadDataResultSuccess<Data> | {
21
21
  };
22
22
  export declare function readLoadablySelectedFieldData(environment: IsographEnvironment, field: LoadablySelectedField, root: StoreLink, variables: Variables, networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, mutableEncounteredRecords: EncounteredIds): ReadDataResult<unknown>;
23
23
  export declare function readResolverFieldData(environment: IsographEnvironment, field: ReaderNonLoadableResolverField, root: StoreLink, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, mutableEncounteredRecords: EncounteredIds): ReadDataResult<unknown>;
24
- export declare function readScalarFieldData(field: ReaderScalarField, storeRecord: StoreRecord, root: StoreLink, variables: Variables): ReadDataResult<string | number | boolean | StoreLink | DataTypeValue[] | null>;
24
+ export declare function readScalarFieldData(field: ReaderScalarField, storeRecord: StoreRecord, root: StoreLink, variables: Variables): ReadDataResult<string | number | boolean | StoreLink | readonly DataTypeValue[] | null>;
25
25
  export declare function readLinkedFieldData(environment: IsographEnvironment, field: ReaderLinkedField, storeRecord: StoreRecord, root: StoreLink, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, readData: <TReadFromStore>(ast: ReaderAst<TReadFromStore>, root: StoreLink) => ReadDataResult<object>): ReadDataResult<unknown>;
26
+ export declare function readClientPointerData(environment: IsographEnvironment, field: ReaderClientPointer, root: StoreLink, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], readData: <TReadFromStore>(ast: ReaderAst<TReadFromStore>, root: StoreLink) => ReadDataResult<object>): ReadDataResult<unknown>;
26
27
  export type NetworkRequestReaderOptions = {
27
28
  suspendIfInFlight: boolean;
28
29
  throwOnNetworkError: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../src/core/read.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAEL,wCAAwC,EAEzC,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,KAAK,qBAAqB,EAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGL,mBAAmB,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,WAAW,EACjB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAGL,cAAc,EAIf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,KAAK,qBAAqB,EAC1B,KAAK,6BAA6B,EAClC,KAAK,iBAAiB,EACtB,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACvB,MAAM,UAAU,CAAC;AAIlB,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IACtC,QAAQ,CAAC,kBAAkB,EAAE,cAAc,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,cAAc,SAAS,qBAAqB,EAE5C,WAAW,EAAE,mBAAmB,EAChC,iBAAiB,EAAE,iBAAiB,CAAC,cAAc,EAAE,OAAO,CAAC,EAC7D,qBAAqB,EAAE,2BAA2B,GACjD,sBAAsB,CAAC,cAAc,CAAC,CA+DxC;AAED,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI;IACxC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,IAAI,IAC3B,qBAAqB,CAAC,IAAI,CAAC,GAC3B;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC;CAChC,CAAC;AA+IN,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,qBAAqB,EAC5B,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAiKzB;AAoFD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,8BAA8B,EACrC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAgFzB;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,GACnB,cAAc,CACf,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,aAAa,EAAE,GAAG,IAAI,CAC/D,CAaA;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,QAAQ,EAAE,CAAC,cAAc,EACvB,GAAG,EAAE,SAAS,CAAC,cAAc,CAAC,EAC9B,IAAI,EAAE,SAAS,KACZ,cAAc,CAAC,MAAM,CAAC,GAC1B,cAAc,CAAC,OAAO,CAAC,CA+PzB;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,wBAAgB,oCAAoC,CAClD,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAAG,IAAI,GAClE,2BAA2B,CAK7B;AAiBD,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,6BAA6B,EACpC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAuDzB"}
1
+ {"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../src/core/read.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAEL,wCAAwC,EAEzC,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,KAAK,qBAAqB,EAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAIL,mBAAmB,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,EACd,KAAK,WAAW,EACjB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,EAGL,cAAc,EAIf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,6BAA6B,EAClC,KAAK,iBAAiB,EACtB,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACvB,MAAM,UAAU,CAAC;AAIlB,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IACtC,QAAQ,CAAC,kBAAkB,EAAE,cAAc,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,cAAc,SAAS,qBAAqB,EAE5C,WAAW,EAAE,mBAAmB,EAChC,iBAAiB,EAAE,iBAAiB,CAAC,cAAc,EAAE,OAAO,CAAC,EAC7D,qBAAqB,EAAE,2BAA2B,GACjD,sBAAsB,CAAC,cAAc,CAAC,CA+DxC;AAED,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI;IACxC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,IAAI,IAC3B,qBAAqB,CAAC,IAAI,CAAC,GAC3B;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC;CAChC,CAAC;AA+IN,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,qBAAqB,EAC5B,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAoKzB;AAoFD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,8BAA8B,EACrC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAgFzB;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,GACnB,cAAc,CACf,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,aAAa,EAAE,GAAG,IAAI,CACxE,CAaA;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,QAAQ,EAAE,CAAC,cAAc,EACvB,GAAG,EAAE,SAAS,CAAC,cAAc,CAAC,EAC9B,IAAI,EAAE,SAAS,KACZ,cAAc,CAAC,MAAM,CAAC,GAC1B,cAAc,CAAC,OAAO,CAAC,CAyMzB;AAQD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,mBAAmB,EAC1B,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,QAAQ,EAAE,CAAC,cAAc,EACvB,GAAG,EAAE,SAAS,CAAC,cAAc,CAAC,EAC9B,IAAI,EAAE,SAAS,KACZ,cAAc,CAAC,MAAM,CAAC,GAC1B,cAAc,CAAC,OAAO,CAAC,CAoGzB;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,wBAAgB,oCAAoC,CAClD,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAAG,IAAI,GAClE,2BAA2B,CAK7B;AAiBD,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,6BAA6B,EACpC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAuDzB"}