@molecule/app-query-react 1.0.1 → 1.0.3

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 CHANGED
@@ -1,3 +1,4 @@
1
+
1
2
  Apache License
2
3
  Version 2.0, January 2004
3
4
  http://www.apache.org/licenses/
@@ -34,21 +35,33 @@
34
35
 
35
36
  "Work" shall mean the work of authorship, whether in Source or
36
37
  Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work.
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
38
40
 
39
41
  "Derivative Works" shall mean any work, whether in Source or Object
40
42
  form, that is based on (or derived from) the Work and for which the
41
43
  editorial revisions, annotations, elaborations, or other modifications
42
- represent, as a whole, an original work of authorship.
43
-
44
- "Contribution" shall mean any work of authorship, including the
45
- original version of the Work and any modifications or additions
46
- to that Work, that is intentionally submitted to the Licensor for
47
- inclusion in the Work by the copyright owner or by an individual or
48
- Legal Entity authorized to submit on behalf of the copyright owner.
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
49
62
 
50
63
  "Contributor" shall mean Licensor and any individual or Legal Entity
51
- on behalf of whom a Contribution has been received by the Licensor and
64
+ on behalf of whom a Contribution has been received by Licensor and
52
65
  subsequently incorporated within the Work.
53
66
 
54
67
  2. Grant of Copyright License. Subject to the terms and conditions of
@@ -61,8 +74,18 @@
61
74
  3. Grant of Patent License. Subject to the terms and conditions of
62
75
  this License, each Contributor hereby grants to You a perpetual,
63
76
  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
64
- patent license to make, have made, use, offer to sell, sell, import,
65
- and otherwise transfer the Work.
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
66
89
 
67
90
  4. Redistribution. You may reproduce and distribute copies of the
68
91
  Work or Derivative Works thereof in any medium, with or without
@@ -84,23 +107,87 @@
84
107
  (d) If the Work includes a "NOTICE" text file as part of its
85
108
  distribution, then any Derivative Works that You distribute must
86
109
  include a readable copy of the attribution notices contained
87
- within such NOTICE file.
88
-
89
- 5. Submission of Contributions.
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
90
138
 
91
139
  6. Trademarks. This License does not grant permission to use the trade
92
- names, trademarks, service marks, or product names of the Licensor.
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
93
143
 
94
144
  7. Disclaimer of Warranty. Unless required by applicable law or
95
- agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
96
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
97
-
98
- 8. Limitation of Liability. In no event and under no legal theory shall
99
- any Contributor be liable to You for damages.
100
-
101
- 9. Accepting Warranty or Additional Liability.
102
-
103
- Copyright 2026 Molecule Dev, Inc.
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
104
191
 
105
192
  Licensed under the Apache License, Version 2.0 (the "License");
106
193
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -3,22 +3,36 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
3
3
  Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
4
4
  Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
5
5
  To change this document, edit the module-level JSDoc in src/index.ts.
6
- Generated: 2026-09-28T07:09:02.750Z
6
+ Generated: 2026-10-21T17:39:17.642Z
7
7
  -->
8
8
 
9
9
  # @molecule/app-query-react
10
10
 
11
- > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
12
- > It is written to be read by coding agents as much as by people, and is generated from this
13
- > package's source — edit `src/index.ts` JSDoc, not this file.
14
-
15
11
  React hooks for `@molecule/app-query`.
16
12
 
13
+ **Load page data with {@link useQuery}, not `fetch` inside a `useEffect`.** A hand-written load
14
+ effect that cancels its request on cleanup (a `cancelled` flag, or an `AbortController`) re-runs
15
+ its cleanup on EVERY re-render whenever one of its dependencies is a function created inline each
16
+ render — `const [messages, setError] = useApiErrors()` returning arrow functions is the usual
17
+ source. The effect's own guard (`if (loaded.current === slug) return`) then returns without
18
+ refetching, so the response is discarded whenever it arrives after a re-render: always on a
19
+ remote server, never on localhost, which is why the page passes locally and fails on the live URL.
20
+ `useQuery` subscribes once per key, keeps its request stable across re-renders, and aborts it
21
+ only when the key changes or the page unmounts.
22
+
17
23
  {@link useQuery} observes one document from the app's shared cache and
18
24
  returns cached data on the first render; {@link usePrefetch} and
19
25
  {@link intentPrefetchProps} warm a document when a person is about to
20
26
  open it. Together they make a detail page open with no loading state.
21
27
 
28
+ This package needs a bonded client: install `@molecule/app-query` with a bond
29
+ (`@molecule/app-query-memory`, or `@molecule/app-query-tanstack`) and call the bond's
30
+ `setProvider(provider)` once at startup (the scaffold's `app/src/bonds/` does this).
31
+
32
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
33
+ > It is written to be read by coding agents as much as by people, and is generated from this
34
+ > package's source — edit `src/index.ts` JSDoc, not this file.
35
+
22
36
  ## Quick Start
23
37
 
24
38
  ```tsx
@@ -45,6 +59,54 @@ function PackagePage({ name }: { name: string }) {
45
59
  }
46
60
  ```
47
61
 
62
+ A mutation or a failed load has to change a page that is ALREADY mounted, and
63
+ the cache never starts that request by itself: `set()` paints a mutation's own
64
+ response, `invalidate()` marks what it affects for the next mount, and an
65
+ explicit `fetch()` retries into the mounted page.
66
+
67
+ ```tsx
68
+ import { getQueryClient } from '@molecule/app-query'
69
+
70
+ // The key names what the document actually depends on — here the signed-in
71
+ // principal, the filter and the page. Another principal's feed is a
72
+ // different document, so an invalidation scoped to this one leaves it alone.
73
+ const feedKey = (principal: string, filter: string, page: number) =>
74
+ ['feed', principal, filter, page] as const
75
+
76
+ const feedOptions = (principal: string, filter: string, page: number) => ({
77
+ key: feedKey(principal, filter, page),
78
+ fetch: (signal: AbortSignal) =>
79
+ fetch(`/api/feeds/${filter}?page=${page}`, { signal }).then((r) => r.json()),
80
+ })
81
+
82
+ async function setFollowing(principal: string, authorId: string, follow: boolean) {
83
+ const client = getQueryClient()
84
+ const res = await fetch(`/api/follows/${authorId}`, { method: follow ? 'POST' : 'DELETE' })
85
+ const body = await res.json()
86
+ // The response IS the document: paint it now, with no second round trip.
87
+ // (If it were only a count or a flag, skip set() and invalidate() instead.)
88
+ client.set(feedKey(principal, 'following', 1), body.feed)
89
+ // Future reads of every feed this principal owns are stale.
90
+ client.invalidate(['feed', principal])
91
+ }
92
+
93
+ function Retry({ principal }: { principal: string }) {
94
+ return (
95
+ <button
96
+ onClick={() => {
97
+ // invalidate() alone would leave the mounted page on its error;
98
+ // an explicit fetch retries into it. useQuery shows the outcome.
99
+ void getQueryClient()
100
+ .fetch(feedOptions(principal, 'following', 1))
101
+ .catch(() => {})
102
+ }}
103
+ >
104
+ Retry
105
+ </button>
106
+ )
107
+ }
108
+ ```
109
+
48
110
  ## Type
49
111
 
50
112
  `feature`
@@ -74,20 +136,6 @@ interface IntentPrefetchProps {
74
136
 
75
137
  ### Functions
76
138
 
77
- #### `intentPrefetchProps(options)`
78
-
79
- Event handlers that warm a document at the first sign of intent: the
80
- pointer arriving, keyboard focus, or a touch starting. Spread them onto a
81
- link: `<Link {...intentPrefetchProps(packageQuery(name))} />`.
82
-
83
- ```typescript
84
- function intentPrefetchProps(options: QueryOptions<T>): IntentPrefetchProps
85
- ```
86
-
87
- - `options` — Key, fetch, freshness.
88
-
89
- **Returns:** The handlers.
90
-
91
139
  #### `prefetchQuery(options)`
92
140
 
93
141
  Warms the cache for a document, when the connection can afford it (see
@@ -110,6 +158,20 @@ function usePrefetch(): <T>(options: QueryOptions<T>) => void
110
158
 
111
159
  **Returns:** The prefetch function.
112
160
 
161
+ #### `intentPrefetchProps(options)`
162
+
163
+ Event handlers that warm a document at the first sign of intent: the
164
+ pointer arriving, keyboard focus, or a touch starting. Spread them onto a
165
+ link: `<Link {...intentPrefetchProps(packageQuery(name))} />`.
166
+
167
+ ```typescript
168
+ function intentPrefetchProps(options: QueryOptions<T>): IntentPrefetchProps
169
+ ```
170
+
171
+ - `options` — Key, fetch, freshness.
172
+
173
+ **Returns:** The handlers.
174
+
113
175
  #### `useQuery(options)`
114
176
 
115
177
  The document for `options.key`, kept current: cached data is returned on
@@ -118,6 +180,14 @@ a stale or missing document is fetched, and every change re-renders.
118
180
  Pass `null` to observe nothing. A key change resets to that key's state;
119
181
  the hook never hands a caller another key's document.
120
182
 
183
+ The request is stable across re-renders — a parent state change neither
184
+ restarts it nor cancels it, so a response that arrives after one still
185
+ lands. It is aborted only when the key changes or the component unmounts
186
+ (the `signal` given to `options.fetch`). Use this instead of a hand-written
187
+ `useEffect` + `fetch`: an effect whose cleanup sets a `cancelled` flag, and
188
+ whose deps include a function rebuilt each render, cancels its own request
189
+ on every re-render and then skips the refetch.
190
+
121
191
  ```typescript
122
192
  function useQuery(options: QueryOptions<T> | null): QueryState<T>
123
193
  ```
@@ -153,5 +223,11 @@ Peer dependencies:
153
223
  connections (`shouldPrefetch()` in the core) — do not bypass that for
154
224
  "important" links; the person can still click.
155
225
  - Errors are not thrown from the hook; read `status === 'error'` and
156
- `error`. A refetch after an error is one more subscription (a re-mount
157
- or a key change) or a `client.invalidate()`.
226
+ `error`. `client.invalidate()` does NOT refetch a mounted page — it only
227
+ marks documents stale, so the page keeps its error (or its old document)
228
+ until the app retries with `client.fetch(options)` or the page subscribes
229
+ again (a key change or a re-mount).
230
+ - After a mutation, `client.set(key, response)` paints the server's own
231
+ answer at once, and `client.invalidate(prefix)` marks the affected reads
232
+ stale for their next mount. Which key and which scope is the app's
233
+ decision: the cache does not infer it from auth or form state.
package/dist/index.d.ts CHANGED
@@ -1,11 +1,25 @@
1
1
  /**
2
2
  * React hooks for `@molecule/app-query`.
3
3
  *
4
+ * **Load page data with {@link useQuery}, not `fetch` inside a `useEffect`.** A hand-written load
5
+ * effect that cancels its request on cleanup (a `cancelled` flag, or an `AbortController`) re-runs
6
+ * its cleanup on EVERY re-render whenever one of its dependencies is a function created inline each
7
+ * render — `const [messages, setError] = useApiErrors()` returning arrow functions is the usual
8
+ * source. The effect's own guard (`if (loaded.current === slug) return`) then returns without
9
+ * refetching, so the response is discarded whenever it arrives after a re-render: always on a
10
+ * remote server, never on localhost, which is why the page passes locally and fails on the live URL.
11
+ * `useQuery` subscribes once per key, keeps its request stable across re-renders, and aborts it
12
+ * only when the key changes or the page unmounts.
13
+ *
4
14
  * {@link useQuery} observes one document from the app's shared cache and
5
15
  * returns cached data on the first render; {@link usePrefetch} and
6
16
  * {@link intentPrefetchProps} warm a document when a person is about to
7
17
  * open it. Together they make a detail page open with no loading state.
8
18
  *
19
+ * This package needs a bonded client: install `@molecule/app-query` with a bond
20
+ * (`@molecule/app-query-memory`, or `@molecule/app-query-tanstack`) and call the bond's
21
+ * `setProvider(provider)` once at startup (the scaffold's `app/src/bonds/` does this).
22
+ *
9
23
  * @example
10
24
  * ```tsx
11
25
  * import { intentPrefetchProps, useQuery } from '@molecule/app-query-react'
@@ -27,6 +41,55 @@
27
41
  * }
28
42
  * ```
29
43
  *
44
+ * @example
45
+ * A mutation or a failed load has to change a page that is ALREADY mounted, and
46
+ * the cache never starts that request by itself: `set()` paints a mutation's own
47
+ * response, `invalidate()` marks what it affects for the next mount, and an
48
+ * explicit `fetch()` retries into the mounted page.
49
+ *
50
+ * ```tsx
51
+ * import { getQueryClient } from '@molecule/app-query'
52
+ *
53
+ * // The key names what the document actually depends on — here the signed-in
54
+ * // principal, the filter and the page. Another principal's feed is a
55
+ * // different document, so an invalidation scoped to this one leaves it alone.
56
+ * const feedKey = (principal: string, filter: string, page: number) =>
57
+ * ['feed', principal, filter, page] as const
58
+ *
59
+ * const feedOptions = (principal: string, filter: string, page: number) => ({
60
+ * key: feedKey(principal, filter, page),
61
+ * fetch: (signal: AbortSignal) =>
62
+ * fetch(`/api/feeds/${filter}?page=${page}`, { signal }).then((r) => r.json()),
63
+ * })
64
+ *
65
+ * async function setFollowing(principal: string, authorId: string, follow: boolean) {
66
+ * const client = getQueryClient()
67
+ * const res = await fetch(`/api/follows/${authorId}`, { method: follow ? 'POST' : 'DELETE' })
68
+ * const body = await res.json()
69
+ * // The response IS the document: paint it now, with no second round trip.
70
+ * // (If it were only a count or a flag, skip set() and invalidate() instead.)
71
+ * client.set(feedKey(principal, 'following', 1), body.feed)
72
+ * // Future reads of every feed this principal owns are stale.
73
+ * client.invalidate(['feed', principal])
74
+ * }
75
+ *
76
+ * function Retry({ principal }: { principal: string }) {
77
+ * return (
78
+ * <button
79
+ * onClick={() => {
80
+ * // invalidate() alone would leave the mounted page on its error;
81
+ * // an explicit fetch retries into it. useQuery shows the outcome.
82
+ * void getQueryClient()
83
+ * .fetch(feedOptions(principal, 'following', 1))
84
+ * .catch(() => {})
85
+ * }}
86
+ * >
87
+ * Retry
88
+ * </button>
89
+ * )
90
+ * }
91
+ * ```
92
+ *
30
93
  * @remarks
31
94
  * - **`useQuery` reads the cache synchronously on the first render.** A
32
95
  * document prefetched from a hovered link, or seeded with `client.set()`
@@ -41,8 +104,14 @@
41
104
  * connections (`shouldPrefetch()` in the core) — do not bypass that for
42
105
  * "important" links; the person can still click.
43
106
  * - Errors are not thrown from the hook; read `status === 'error'` and
44
- * `error`. A refetch after an error is one more subscription (a re-mount
45
- * or a key change) or a `client.invalidate()`.
107
+ * `error`. `client.invalidate()` does NOT refetch a mounted page — it only
108
+ * marks documents stale, so the page keeps its error (or its old document)
109
+ * until the app retries with `client.fetch(options)` or the page subscribes
110
+ * again (a key change or a re-mount).
111
+ * - After a mutation, `client.set(key, response)` paints the server's own
112
+ * answer at once, and `client.invalidate(prefix)` marks the affected reads
113
+ * stale for their next mount. Which key and which scope is the app's
114
+ * decision: the cache does not infer it from auth or form state.
46
115
  *
47
116
  * @module
48
117
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoHG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA"}
package/dist/index.js CHANGED
@@ -1,11 +1,25 @@
1
1
  /**
2
2
  * React hooks for `@molecule/app-query`.
3
3
  *
4
+ * **Load page data with {@link useQuery}, not `fetch` inside a `useEffect`.** A hand-written load
5
+ * effect that cancels its request on cleanup (a `cancelled` flag, or an `AbortController`) re-runs
6
+ * its cleanup on EVERY re-render whenever one of its dependencies is a function created inline each
7
+ * render — `const [messages, setError] = useApiErrors()` returning arrow functions is the usual
8
+ * source. The effect's own guard (`if (loaded.current === slug) return`) then returns without
9
+ * refetching, so the response is discarded whenever it arrives after a re-render: always on a
10
+ * remote server, never on localhost, which is why the page passes locally and fails on the live URL.
11
+ * `useQuery` subscribes once per key, keeps its request stable across re-renders, and aborts it
12
+ * only when the key changes or the page unmounts.
13
+ *
4
14
  * {@link useQuery} observes one document from the app's shared cache and
5
15
  * returns cached data on the first render; {@link usePrefetch} and
6
16
  * {@link intentPrefetchProps} warm a document when a person is about to
7
17
  * open it. Together they make a detail page open with no loading state.
8
18
  *
19
+ * This package needs a bonded client: install `@molecule/app-query` with a bond
20
+ * (`@molecule/app-query-memory`, or `@molecule/app-query-tanstack`) and call the bond's
21
+ * `setProvider(provider)` once at startup (the scaffold's `app/src/bonds/` does this).
22
+ *
9
23
  * @example
10
24
  * ```tsx
11
25
  * import { intentPrefetchProps, useQuery } from '@molecule/app-query-react'
@@ -27,6 +41,55 @@
27
41
  * }
28
42
  * ```
29
43
  *
44
+ * @example
45
+ * A mutation or a failed load has to change a page that is ALREADY mounted, and
46
+ * the cache never starts that request by itself: `set()` paints a mutation's own
47
+ * response, `invalidate()` marks what it affects for the next mount, and an
48
+ * explicit `fetch()` retries into the mounted page.
49
+ *
50
+ * ```tsx
51
+ * import { getQueryClient } from '@molecule/app-query'
52
+ *
53
+ * // The key names what the document actually depends on — here the signed-in
54
+ * // principal, the filter and the page. Another principal's feed is a
55
+ * // different document, so an invalidation scoped to this one leaves it alone.
56
+ * const feedKey = (principal: string, filter: string, page: number) =>
57
+ * ['feed', principal, filter, page] as const
58
+ *
59
+ * const feedOptions = (principal: string, filter: string, page: number) => ({
60
+ * key: feedKey(principal, filter, page),
61
+ * fetch: (signal: AbortSignal) =>
62
+ * fetch(`/api/feeds/${filter}?page=${page}`, { signal }).then((r) => r.json()),
63
+ * })
64
+ *
65
+ * async function setFollowing(principal: string, authorId: string, follow: boolean) {
66
+ * const client = getQueryClient()
67
+ * const res = await fetch(`/api/follows/${authorId}`, { method: follow ? 'POST' : 'DELETE' })
68
+ * const body = await res.json()
69
+ * // The response IS the document: paint it now, with no second round trip.
70
+ * // (If it were only a count or a flag, skip set() and invalidate() instead.)
71
+ * client.set(feedKey(principal, 'following', 1), body.feed)
72
+ * // Future reads of every feed this principal owns are stale.
73
+ * client.invalidate(['feed', principal])
74
+ * }
75
+ *
76
+ * function Retry({ principal }: { principal: string }) {
77
+ * return (
78
+ * <button
79
+ * onClick={() => {
80
+ * // invalidate() alone would leave the mounted page on its error;
81
+ * // an explicit fetch retries into it. useQuery shows the outcome.
82
+ * void getQueryClient()
83
+ * .fetch(feedOptions(principal, 'following', 1))
84
+ * .catch(() => {})
85
+ * }}
86
+ * >
87
+ * Retry
88
+ * </button>
89
+ * )
90
+ * }
91
+ * ```
92
+ *
30
93
  * @remarks
31
94
  * - **`useQuery` reads the cache synchronously on the first render.** A
32
95
  * document prefetched from a hovered link, or seeded with `client.set()`
@@ -41,8 +104,14 @@
41
104
  * connections (`shouldPrefetch()` in the core) — do not bypass that for
42
105
  * "important" links; the person can still click.
43
106
  * - Errors are not thrown from the hook; read `status === 'error'` and
44
- * `error`. A refetch after an error is one more subscription (a re-mount
45
- * or a key change) or a `client.invalidate()`.
107
+ * `error`. `client.invalidate()` does NOT refetch a mounted page — it only
108
+ * marks documents stale, so the page keeps its error (or its old document)
109
+ * until the app retries with `client.fetch(options)` or the page subscribes
110
+ * again (a key change or a re-mount).
111
+ * - After a mutation, `client.set(key, response)` paints the server's own
112
+ * answer at once, and `client.invalidate(prefix)` marks the affected reads
113
+ * stale for their next mount. Which key and which scope is the app's
114
+ * decision: the cache does not infer it from auth or form state.
46
115
  *
47
116
  * @module
48
117
  */
@@ -11,6 +11,14 @@ import type { QueryOptions, QueryState } from '@molecule/app-query';
11
11
  * Pass `null` to observe nothing. A key change resets to that key's state;
12
12
  * the hook never hands a caller another key's document.
13
13
  *
14
+ * The request is stable across re-renders — a parent state change neither
15
+ * restarts it nor cancels it, so a response that arrives after one still
16
+ * lands. It is aborted only when the key changes or the component unmounts
17
+ * (the `signal` given to `options.fetch`). Use this instead of a hand-written
18
+ * `useEffect` + `fetch`: an effect whose cleanup sets a `cancelled` flag, and
19
+ * whose deps include a function rebuilt each render, cancels its own request
20
+ * on every re-render and then skips the refetch.
21
+ *
14
22
  * @param options - Key, fetch, freshness; or `null`.
15
23
  * @returns The document's state.
16
24
  */
@@ -1 +1 @@
1
- {"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../src/useQuery.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAWnE;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAqB1E"}
1
+ {"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../src/useQuery.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAWnE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAqB1E"}
package/dist/useQuery.js CHANGED
@@ -19,6 +19,14 @@ const IDLE = {
19
19
  * Pass `null` to observe nothing. A key change resets to that key's state;
20
20
  * the hook never hands a caller another key's document.
21
21
  *
22
+ * The request is stable across re-renders — a parent state change neither
23
+ * restarts it nor cancels it, so a response that arrives after one still
24
+ * lands. It is aborted only when the key changes or the component unmounts
25
+ * (the `signal` given to `options.fetch`). Use this instead of a hand-written
26
+ * `useEffect` + `fetch`: an effect whose cleanup sets a `cancelled` flag, and
27
+ * whose deps include a function rebuilt each render, cancels its own request
28
+ * on every re-render and then skips the refetch.
29
+ *
22
30
  * @param options - Key, fetch, freshness; or `null`.
23
31
  * @returns The document's state.
24
32
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@molecule/app-query-react",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "React hooks for @molecule/app-query — read a cached document synchronously, observe it, and prefetch on intent",
5
5
  "homepage": "https://www.molecule.dev/packages/app-query-react",
6
6
  "type": "module",
@@ -40,8 +40,9 @@
40
40
  "react": "^18.0.0 || ^19.0.0"
41
41
  },
42
42
  "devDependencies": {
43
- "@molecule/app-query": "1.0.1",
44
- "@molecule/app-query-memory": "1.0.1",
43
+ "@molecule/app-query": "1.0.3",
44
+ "@molecule/app-query-memory": "1.0.2",
45
+ "@molecule/app-query-tanstack": "1.0.1",
45
46
  "@types/node": "26.1.2",
46
47
  "@types/react": "19.2.17",
47
48
  "@types/react-dom": "19.2.3",