@isograph/react 0.1.1 → 0.3.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 (160) hide show
  1. package/dist/core/FragmentReference.d.ts +25 -0
  2. package/dist/core/FragmentReference.d.ts.map +1 -0
  3. package/dist/core/FragmentReference.js +16 -0
  4. package/dist/core/IsographEnvironment.d.ts +89 -0
  5. package/dist/core/IsographEnvironment.d.ts.map +1 -0
  6. package/dist/core/IsographEnvironment.js +65 -0
  7. package/dist/core/PromiseWrapper.d.ts +28 -0
  8. package/dist/core/PromiseWrapper.d.ts.map +1 -0
  9. package/dist/core/PromiseWrapper.js +57 -0
  10. package/dist/core/areEqualWithDeepComparison.d.ts +5 -0
  11. package/dist/core/areEqualWithDeepComparison.d.ts.map +1 -0
  12. package/dist/core/areEqualWithDeepComparison.js +95 -0
  13. package/dist/core/cache.d.ts +44 -0
  14. package/dist/core/cache.d.ts.map +1 -0
  15. package/dist/core/cache.js +514 -0
  16. package/dist/core/check.d.ts +18 -0
  17. package/dist/core/check.d.ts.map +1 -0
  18. package/dist/core/check.js +127 -0
  19. package/dist/core/componentCache.d.ts +5 -0
  20. package/dist/core/componentCache.d.ts.map +1 -0
  21. package/dist/core/componentCache.js +38 -0
  22. package/dist/core/entrypoint.d.ts +69 -0
  23. package/dist/core/entrypoint.d.ts.map +1 -0
  24. package/dist/core/entrypoint.js +7 -0
  25. package/dist/core/garbageCollection.d.ts +13 -0
  26. package/dist/core/garbageCollection.d.ts.map +1 -0
  27. package/dist/core/garbageCollection.js +107 -0
  28. package/dist/core/logging.d.ts +69 -0
  29. package/dist/core/logging.d.ts.map +1 -0
  30. package/dist/core/logging.js +19 -0
  31. package/dist/core/makeNetworkRequest.d.ts +9 -0
  32. package/dist/core/makeNetworkRequest.d.ts.map +1 -0
  33. package/dist/core/makeNetworkRequest.js +118 -0
  34. package/dist/core/read.d.ts +27 -0
  35. package/dist/core/read.d.ts.map +1 -0
  36. package/dist/core/read.js +478 -0
  37. package/dist/core/reader.d.ts +87 -0
  38. package/dist/core/reader.d.ts.map +1 -0
  39. package/dist/core/reader.js +2 -0
  40. package/dist/core/util.d.ts +19 -0
  41. package/dist/core/util.d.ts.map +1 -0
  42. package/dist/core/util.js +2 -0
  43. package/dist/index.d.ts +26 -120
  44. package/dist/index.d.ts.map +1 -0
  45. package/dist/index.js +57 -306
  46. package/dist/loadable-hooks/useClientSideDefer.d.ts +16 -0
  47. package/dist/loadable-hooks/useClientSideDefer.d.ts.map +1 -0
  48. package/dist/loadable-hooks/useClientSideDefer.js +13 -0
  49. package/dist/loadable-hooks/useConnectionSpecPagination.d.ts +34 -0
  50. package/dist/loadable-hooks/useConnectionSpecPagination.d.ts.map +1 -0
  51. package/dist/loadable-hooks/useConnectionSpecPagination.js +160 -0
  52. package/dist/loadable-hooks/useImperativeExposedMutationField.d.ts +6 -0
  53. package/dist/loadable-hooks/useImperativeExposedMutationField.d.ts.map +1 -0
  54. package/dist/loadable-hooks/useImperativeExposedMutationField.js +14 -0
  55. package/dist/loadable-hooks/useImperativeLoadableField.d.ts +17 -0
  56. package/dist/loadable-hooks/useImperativeLoadableField.d.ts.map +1 -0
  57. package/dist/loadable-hooks/useImperativeLoadableField.js +14 -0
  58. package/dist/loadable-hooks/useSkipLimitPagination.d.ts +27 -0
  59. package/dist/loadable-hooks/useSkipLimitPagination.d.ts.map +1 -0
  60. package/dist/loadable-hooks/useSkipLimitPagination.js +162 -0
  61. package/dist/react/FragmentReader.d.ts +16 -0
  62. package/dist/react/FragmentReader.d.ts.map +1 -0
  63. package/dist/{EntrypointReader.js → react/FragmentReader.js} +7 -5
  64. package/dist/react/IsographEnvironmentProvider.d.ts +11 -0
  65. package/dist/react/IsographEnvironmentProvider.d.ts.map +1 -0
  66. package/dist/{IsographEnvironment.js → react/IsographEnvironmentProvider.js} +4 -22
  67. package/dist/react/RenderAfterCommit__DO_NOT_USE.d.ts +10 -0
  68. package/dist/react/RenderAfterCommit__DO_NOT_USE.d.ts.map +1 -0
  69. package/dist/react/RenderAfterCommit__DO_NOT_USE.js +15 -0
  70. package/dist/react/useImperativeReference.d.ts +12 -0
  71. package/dist/react/useImperativeReference.d.ts.map +1 -0
  72. package/dist/react/useImperativeReference.js +35 -0
  73. package/dist/react/useLazyReference.d.ts +10 -0
  74. package/dist/react/useLazyReference.d.ts.map +1 -0
  75. package/dist/react/useLazyReference.js +21 -0
  76. package/dist/react/useReadAndSubscribe.d.ts +20 -0
  77. package/dist/react/useReadAndSubscribe.d.ts.map +1 -0
  78. package/dist/react/useReadAndSubscribe.js +40 -0
  79. package/dist/react/useRerenderOnChange.d.ts +8 -0
  80. package/dist/react/useRerenderOnChange.d.ts.map +1 -0
  81. package/dist/react/useRerenderOnChange.js +22 -0
  82. package/dist/react/useResult.d.ts +9 -0
  83. package/dist/react/useResult.d.ts.map +1 -0
  84. package/dist/react/useResult.js +39 -0
  85. package/docs/how-useLazyReference-works.md +117 -0
  86. package/isograph.config.json +7 -0
  87. package/package.json +18 -9
  88. package/schema.graphql +17 -0
  89. package/src/core/FragmentReference.ts +49 -0
  90. package/src/core/IsographEnvironment.ts +192 -0
  91. package/src/core/PromiseWrapper.ts +86 -0
  92. package/src/core/areEqualWithDeepComparison.ts +112 -0
  93. package/src/core/cache.ts +835 -0
  94. package/src/core/check.ts +207 -0
  95. package/src/core/componentCache.ts +62 -0
  96. package/src/core/entrypoint.ts +106 -0
  97. package/src/core/garbageCollection.ts +173 -0
  98. package/src/core/logging.ts +116 -0
  99. package/src/core/makeNetworkRequest.ts +175 -0
  100. package/src/core/read.ts +722 -0
  101. package/src/core/reader.ts +160 -0
  102. package/src/core/util.ts +27 -0
  103. package/src/index.ts +99 -0
  104. package/src/loadable-hooks/useClientSideDefer.ts +58 -0
  105. package/src/loadable-hooks/useConnectionSpecPagination.ts +331 -0
  106. package/src/loadable-hooks/useImperativeExposedMutationField.ts +17 -0
  107. package/src/loadable-hooks/useImperativeLoadableField.ts +52 -0
  108. package/src/loadable-hooks/useSkipLimitPagination.ts +352 -0
  109. package/src/react/FragmentReader.tsx +43 -0
  110. package/src/react/IsographEnvironmentProvider.tsx +33 -0
  111. package/src/react/RenderAfterCommit__DO_NOT_USE.tsx +17 -0
  112. package/src/react/useImperativeReference.ts +68 -0
  113. package/src/react/useLazyReference.ts +42 -0
  114. package/src/react/useReadAndSubscribe.ts +81 -0
  115. package/src/react/useRerenderOnChange.ts +38 -0
  116. package/src/react/useResult.ts +73 -0
  117. package/src/tests/__isograph/Query/meName/entrypoint.ts +52 -0
  118. package/src/tests/__isograph/Query/meName/output_type.ts +3 -0
  119. package/src/tests/__isograph/Query/meName/param_type.ts +9 -0
  120. package/src/tests/__isograph/Query/meName/resolver_reader.ts +33 -0
  121. package/src/tests/__isograph/Query/meNameSuccessor/entrypoint.ts +90 -0
  122. package/src/tests/__isograph/Query/meNameSuccessor/output_type.ts +3 -0
  123. package/src/tests/__isograph/Query/meNameSuccessor/param_type.ts +14 -0
  124. package/src/tests/__isograph/Query/meNameSuccessor/resolver_reader.ts +57 -0
  125. package/src/tests/__isograph/Query/nodeField/entrypoint.ts +57 -0
  126. package/src/tests/__isograph/Query/nodeField/output_type.ts +3 -0
  127. package/src/tests/__isograph/Query/nodeField/param_type.ts +10 -0
  128. package/src/tests/__isograph/Query/nodeField/parameters_type.ts +3 -0
  129. package/src/tests/__isograph/Query/nodeField/resolver_reader.ts +38 -0
  130. package/src/tests/__isograph/Query/subquery/entrypoint.ts +67 -0
  131. package/src/tests/__isograph/Query/subquery/output_type.ts +3 -0
  132. package/src/tests/__isograph/Query/subquery/param_type.ts +12 -0
  133. package/src/tests/__isograph/Query/subquery/parameters_type.ts +3 -0
  134. package/src/tests/__isograph/Query/subquery/resolver_reader.ts +47 -0
  135. package/src/tests/__isograph/iso.ts +99 -0
  136. package/src/tests/garbageCollection.test.ts +142 -0
  137. package/src/tests/meNameSuccessor.ts +25 -0
  138. package/src/tests/nodeQuery.ts +19 -0
  139. package/src/tests/normalizeData.test.ts +120 -0
  140. package/src/tests/tsconfig.json +21 -0
  141. package/tsconfig.json +6 -0
  142. package/tsconfig.pkg.json +7 -1
  143. package/vitest.config.ts +20 -0
  144. package/dist/EntrypointReader.d.ts +0 -6
  145. package/dist/IsographEnvironment.d.ts +0 -56
  146. package/dist/PromiseWrapper.d.ts +0 -13
  147. package/dist/PromiseWrapper.js +0 -22
  148. package/dist/cache.d.ts +0 -26
  149. package/dist/cache.js +0 -274
  150. package/dist/componentCache.d.ts +0 -6
  151. package/dist/componentCache.js +0 -31
  152. package/dist/useImperativeReference.d.ts +0 -8
  153. package/dist/useImperativeReference.js +0 -28
  154. package/src/EntrypointReader.tsx +0 -20
  155. package/src/IsographEnvironment.tsx +0 -120
  156. package/src/PromiseWrapper.ts +0 -29
  157. package/src/cache.tsx +0 -484
  158. package/src/componentCache.ts +0 -41
  159. package/src/index.tsx +0 -617
  160. package/src/useImperativeReference.ts +0 -58
@@ -0,0 +1,175 @@
1
+ import { ItemCleanupPair } from '@isograph/disposable-types';
2
+ import {
3
+ IsographEntrypoint,
4
+ RefetchQueryNormalizationArtifact,
5
+ } from './entrypoint';
6
+ import { Variables } from './FragmentReference';
7
+ import {
8
+ garbageCollectEnvironment,
9
+ RetainedQuery,
10
+ retainQuery,
11
+ unretainQuery,
12
+ } from './garbageCollection';
13
+ import { IsographEnvironment, ROOT_ID } from './IsographEnvironment';
14
+ import {
15
+ AnyError,
16
+ PromiseWrapper,
17
+ wrapPromise,
18
+ wrapResolvedValue,
19
+ } from './PromiseWrapper';
20
+ import { normalizeData } from './cache';
21
+ import { logMessage } from './logging';
22
+ import { check, DEFAULT_SHOULD_FETCH_VALUE, FetchOptions } from './check';
23
+
24
+ let networkRequestId = 0;
25
+
26
+ export function maybeMakeNetworkRequest(
27
+ environment: IsographEnvironment,
28
+ artifact: RefetchQueryNormalizationArtifact | IsographEntrypoint<any, any>,
29
+ variables: Variables,
30
+ fetchOptions?: FetchOptions,
31
+ ): ItemCleanupPair<PromiseWrapper<void, AnyError>> {
32
+ switch (fetchOptions?.shouldFetch ?? DEFAULT_SHOULD_FETCH_VALUE) {
33
+ case 'Yes': {
34
+ return makeNetworkRequest(environment, artifact, variables, fetchOptions);
35
+ }
36
+ case 'No': {
37
+ return [wrapResolvedValue(undefined), () => {}];
38
+ }
39
+ case 'IfNecessary': {
40
+ const result = check(
41
+ environment,
42
+ artifact.networkRequestInfo.normalizationAst,
43
+ variables,
44
+ {
45
+ __link: ROOT_ID,
46
+ __typename: artifact.concreteType,
47
+ },
48
+ );
49
+ if (result.kind === 'EnoughData') {
50
+ return [wrapResolvedValue(undefined), () => {}];
51
+ } else {
52
+ return makeNetworkRequest(
53
+ environment,
54
+ artifact,
55
+ variables,
56
+ fetchOptions,
57
+ );
58
+ }
59
+ }
60
+ }
61
+ }
62
+
63
+ export function makeNetworkRequest(
64
+ environment: IsographEnvironment,
65
+ artifact: RefetchQueryNormalizationArtifact | IsographEntrypoint<any, any>,
66
+ variables: Variables,
67
+ fetchOptions?: FetchOptions,
68
+ ): ItemCleanupPair<PromiseWrapper<void, AnyError>> {
69
+ // TODO this should be a DataId and stored in the store
70
+ const myNetworkRequestId = networkRequestId + '';
71
+ networkRequestId++;
72
+
73
+ logMessage(environment, {
74
+ kind: 'MakeNetworkRequest',
75
+ artifact,
76
+ variables,
77
+ networkRequestId: myNetworkRequestId,
78
+ });
79
+
80
+ let status: NetworkRequestStatus = {
81
+ kind: 'UndisposedIncomplete',
82
+ };
83
+ // This should be an observable, not a promise
84
+ const promise = environment
85
+ .networkFunction(artifact.networkRequestInfo.queryText, variables)
86
+ .then((networkResponse) => {
87
+ logMessage(environment, {
88
+ kind: 'ReceivedNetworkResponse',
89
+ networkResponse,
90
+ networkRequestId: myNetworkRequestId,
91
+ });
92
+
93
+ if (networkResponse.errors != null) {
94
+ try {
95
+ fetchOptions?.onError?.();
96
+ } catch {}
97
+ // @ts-expect-error Why are we getting the wrong constructor here?
98
+ throw new Error('GraphQL network response had errors', {
99
+ cause: networkResponse,
100
+ });
101
+ }
102
+
103
+ if (status.kind === 'UndisposedIncomplete') {
104
+ const root = { __link: ROOT_ID, __typename: artifact.concreteType };
105
+ normalizeData(
106
+ environment,
107
+ artifact.networkRequestInfo.normalizationAst,
108
+ networkResponse.data ?? {},
109
+ variables,
110
+ artifact.kind === 'Entrypoint'
111
+ ? artifact.readerWithRefetchQueries.nestedRefetchQueries
112
+ : [],
113
+ root,
114
+ );
115
+ const retainedQuery = {
116
+ normalizationAst: artifact.networkRequestInfo.normalizationAst,
117
+ variables,
118
+ root,
119
+ };
120
+ status = {
121
+ kind: 'UndisposedComplete',
122
+ retainedQuery,
123
+ };
124
+ retainQuery(environment, retainedQuery);
125
+ }
126
+
127
+ try {
128
+ fetchOptions?.onComplete?.();
129
+ } catch {}
130
+ })
131
+ .catch((e) => {
132
+ logMessage(environment, {
133
+ kind: 'ReceivedNetworkError',
134
+ networkRequestId: myNetworkRequestId,
135
+ error: e,
136
+ });
137
+ try {
138
+ fetchOptions?.onError?.();
139
+ } catch {}
140
+ throw e;
141
+ });
142
+
143
+ const wrapper = wrapPromise(promise);
144
+
145
+ const response: ItemCleanupPair<PromiseWrapper<void, AnyError>> = [
146
+ wrapper,
147
+ () => {
148
+ if (status.kind === 'UndisposedComplete') {
149
+ const didUnretainSomeQuery = unretainQuery(
150
+ environment,
151
+ status.retainedQuery,
152
+ );
153
+ if (didUnretainSomeQuery) {
154
+ garbageCollectEnvironment(environment);
155
+ }
156
+ }
157
+ status = {
158
+ kind: 'Disposed',
159
+ };
160
+ },
161
+ ];
162
+ return response;
163
+ }
164
+
165
+ type NetworkRequestStatus =
166
+ | {
167
+ readonly kind: 'UndisposedIncomplete';
168
+ }
169
+ | {
170
+ readonly kind: 'Disposed';
171
+ }
172
+ | {
173
+ readonly kind: 'UndisposedComplete';
174
+ readonly retainedQuery: RetainedQuery;
175
+ };