@raf-query/core 0.10.3 → 0.10.4

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/CHANGELOG.md CHANGED
@@ -1,10 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.10.4](https://github.com/KATT/raf-query/compare/0.10.3...0.10.4) (2026-10-16)
4
+
5
+ ### Bug Fixes
6
+
7
+ * **core:** keep pages written during a paged refetch ([#215](https://github.com/KATT/raf-query/issues/215)) ([b6a5946](https://github.com/KATT/raf-query/commit/b6a5946e806e12e9b7df40e80ef0e532c0871b25)), references [#75](https://github.com/KATT/raf-query/issues/75)
8
+ * **react:** read promise queryFns as plain data on a client with a layer (1/2) ([#205](https://github.com/KATT/raf-query/issues/205)) ([a9b156e](https://github.com/KATT/raf-query/commit/a9b156edfa18b1e41e9ea929afc412252a61b83c))
9
+
3
10
  ## [0.10.3](https://github.com/KATT/raf-query/compare/0.10.2...0.10.3) (2026-10-16)
4
11
 
5
12
  ### Features
6
13
 
7
- * **core:** add QueryBinding, a framework-free useQuery for bindings ([#197](https://github.com/KATT/raf-query/issues/197)) ([4865802](https://github.com/KATT/raf-query/commit/48658024f4d21d43ce8274de379a19c8898b6173)), references [#194](https://github.com/KATT/raf-query/issues/194)
14
+ - **core:** add QueryBinding, a framework-free useQuery for bindings ([#197](https://github.com/KATT/raf-query/issues/197)) ([4865802](https://github.com/KATT/raf-query/commit/48658024f4d21d43ce8274de379a19c8898b6173)), references [#194](https://github.com/KATT/raf-query/issues/194)
8
15
 
9
16
  ## [0.10.2](https://github.com/KATT/raf-query/compare/0.10.1...0.10.2) (2026-10-16)
10
17
 
package/dist/client.d.mts CHANGED
@@ -17,7 +17,8 @@ export interface QueryClientConfig<TServices = never> extends Config {
17
17
  * When `false`, `useQuery` for an Effect `queryFn` (a typed `ErrorOf`)
18
18
  * returns a `Result` in the first tuple slot instead of a promise that
19
19
  * rejects. Defaults to `false` when `layer` is set, `true` otherwise.
20
- * Promise `queryFn`s always throw; this flag does not apply to them.
20
+ * Promise `queryFn`s always throw, whatever this flag says: reads tell
21
+ * them apart by what the `queryFn` returned ({@link Query.returnsEffectUnsafe}).
21
22
  */
22
23
  readonly throwOnError?: boolean;
23
24
  }
@@ -1,6 +1,7 @@
1
1
  import { QueryKey } from "./key.mjs";
2
2
  import { DataOf, ErrorOf, InputOf, IsPaged, QueryFactory } from "./options.mjs";
3
3
  import { Thenable } from "./thenable.mjs";
4
+ import { Query, query_d_exports } from "./query.mjs";
4
5
  import { Options, Result as Result$1, observer_d_exports } from "./observer.mjs";
5
6
  import { Result } from "effect";
6
7
  //#region src/controls.d.ts
@@ -65,6 +66,13 @@ export type HasTypedError<TFactory extends QueryFactory> = unknown extends Error
65
66
  * (Result), matching a client with a `layer`.
66
67
  */
67
68
  export type ThrowsOnError<TFactory extends QueryFactory, TThrow extends boolean | undefined> = HasTypedError<TFactory> extends false ? true : TThrow extends boolean ? TThrow : false;
69
+ /**
70
+ * {@link ThrowsOnError} at runtime, for bindings: a read of `query` throws
71
+ * when `throwOnError` (the call's, else the client's) is `true`, or when its
72
+ * `queryFn` returns a promise or plain value, whose error isn't typed. A
73
+ * query whose `queryFn` hasn't run yet follows `throwOnError`.
74
+ */
75
+ export declare function throwsOnError<TFactory extends QueryFactory>(query: Query<TFactory>, throwOnError: boolean): boolean;
68
76
  /** What a read settles with: the data, or a `Result` when it doesn't throw. */
69
77
  export type ReadValue<TFactory extends QueryFactory, TThrow extends boolean | undefined = undefined> = ThrowsOnError<TFactory, TThrow> extends true ? DataOf<TFactory> : Result.Result<DataOf<TFactory>, ErrorOf<TFactory>>;
70
78
  type Command = "fetchNextPage" | "fetchPreviousPage" | "refetch";
package/dist/controls.mjs CHANGED
@@ -1,4 +1,5 @@
1
1
  import { fulfilled, pending } from "./thenable.mjs";
2
+ import { returnsEffectUnsafe } from "./query.mjs";
2
3
  import { Effect, Result } from "effect";
3
4
  //#region src/controls.ts
4
5
  /**
@@ -6,6 +7,15 @@ import { Effect, Result } from "effect";
6
7
  * observer's result with Promise commands, and the types every binding
7
8
  * shares. The React, Svelte and Vue packages build their reads on this.
8
9
  */
10
+ /**
11
+ * {@link ThrowsOnError} at runtime, for bindings: a read of `query` throws
12
+ * when `throwOnError` (the call's, else the client's) is `true`, or when its
13
+ * `queryFn` returns a promise or plain value, whose error isn't typed. A
14
+ * query whose `queryFn` hasn't run yet follows `throwOnError`.
15
+ */
16
+ function throwsOnError(query, throwOnError) {
17
+ return throwOnError || returnsEffectUnsafe(query) === false;
18
+ }
9
19
  const commands = /* @__PURE__ */ new WeakMap();
10
20
  /** One stable Promise function per command Effect, so identities track the query's. */
11
21
  function commandFor(effect) {
@@ -56,4 +66,4 @@ function resultThenable(promise) {
56
66
  return next;
57
67
  }
58
68
  //#endregion
59
- export { promiseControls, resultThenable };
69
+ export { promiseControls, resultThenable, throwsOnError };
package/dist/entry.d.mts CHANGED
@@ -79,6 +79,12 @@ export interface Entry extends Query {
79
79
  pending: Pending<unknown> | undefined;
80
80
  /** The last reader left during the request in flight: it retries no more. */
81
81
  retriesStopped: boolean;
82
+ /**
83
+ * The last `queryFn` call returned an Effect (`true`) or a promise or
84
+ * plain value (`false`), here or on the cache it was hydrated from.
85
+ * `undefined` until one has run.
86
+ */
87
+ returnsEffect: boolean | undefined;
82
88
  /** Open while the entry is cached; owns its fibers. */
83
89
  readonly scope: Scope.Closeable;
84
90
  /**
package/dist/entry.mjs CHANGED
@@ -76,6 +76,7 @@ function make(cache, key, hash) {
76
76
  options: void 0,
77
77
  pending: first,
78
78
  retriesStopped: false,
79
+ returnsEffect: void 0,
79
80
  scope,
80
81
  services: cache.services,
81
82
  signalRead: false,
@@ -475,7 +476,8 @@ function attempt(entry, call) {
475
476
  entry.signalRead = true;
476
477
  return signal;
477
478
  });
478
- if (Effect.isEffect(result)) entry.signalRead = true;
479
+ entry.returnsEffect = Effect.isEffect(result);
480
+ if (entry.returnsEffect) entry.signalRead = true;
479
481
  return result;
480
482
  }).pipe(Effect.tapError(() => Effect.sync(() => set(entry, { failureCount: entry.state.failureCount + 1 }))));
481
483
  const schedule = retrySchedule({
@@ -18,6 +18,8 @@ export interface DehydratedResult {
18
18
  */
19
19
  export interface DehydratedQuery {
20
20
  readonly data?: unknown;
21
+ /** Whether the sender's `queryFn` returned an Effect, when it ran there. */
22
+ readonly effect?: boolean;
21
23
  readonly key: QueryKey;
22
24
  /** The query's `meta`, for receivers that haven't called its factory. */
23
25
  readonly meta?: QueryMeta;
@@ -1,5 +1,5 @@
1
1
  import { entryOf, isBrowserOnly, resume, revalidate, setData } from "./entry.mjs";
2
- import { getUnsafe, metaUnsafe } from "./query.mjs";
2
+ import { getUnsafe, metaUnsafe, returnsEffectUnsafe } from "./query.mjs";
3
3
  import { Data, Effect, Queue, Stream } from "effect";
4
4
  //#region src/hydration.ts
5
5
  /**
@@ -19,6 +19,15 @@ function canDehydrate(query) {
19
19
  return state.hasData || state.isFetching;
20
20
  }
21
21
  function dehydrateUnsafe(query, options) {
22
+ const sent = dehydrateState(query, options);
23
+ const effect = returnsEffectUnsafe(query);
24
+ return effect === void 0 ? sent : {
25
+ ...sent,
26
+ effect
27
+ };
28
+ }
29
+ /** {@link dehydrateUnsafe} without `effect`. */
30
+ function dehydrateState(query, options) {
22
31
  const state = getUnsafe(query);
23
32
  const serialize = options.serializeData ?? identity;
24
33
  const meta = metaUnsafe(query);
@@ -123,6 +132,7 @@ function hydrateEntries(entryFor, state, options) {
123
132
  for (const query of state.queries) {
124
133
  const entry = entryFor(query.key);
125
134
  if (!entry.options && query.meta !== void 0) entry.hydratedMeta = query.meta;
135
+ entry.returnsEffect ??= query.effect;
126
136
  if (query.updatedAt > 0) takeNewer(entry, deserialize(query.data), query.updatedAt);
127
137
  else if (query.promise) {
128
138
  const result = Promise.resolve(query.promise).then((sent) => ({
package/dist/index.d.mts CHANGED
@@ -8,6 +8,6 @@ import { DehydrateOptions, DehydratedQuery, DehydratedResult, DehydratedState, D
8
8
  import { cache_d_exports } from "./cache.mjs";
9
9
  import { QueryClient, QueryClientConfig, dehydrate, hydrate } from "./client.mjs";
10
10
  import { observer_d_exports } from "./observer.mjs";
11
- import { HasTypedError, PagingControls, PromiseControls, QueryControls, ReadValue, ThrowsOnError, UseQueryControls, UseQueryOptions, UseQueryThrowOptions, promiseControls, resultThenable } from "./controls.mjs";
11
+ import { HasTypedError, PagingControls, PromiseControls, QueryControls, ReadValue, ThrowsOnError, UseQueryControls, UseQueryOptions, UseQueryThrowOptions, promiseControls, resultThenable, throwsOnError } from "./controls.mjs";
12
12
  import { binding_d_exports } from "./binding.mjs";
13
- export { type AnyQueryOptions, type DataOf, type DehydrateOptions, type DehydratedQuery, type DehydratedResult, type DehydratedState, type DehydratedStream, type ErrorOf, type HasTypedError, type HydrateOptions, type InfiniteData, type InfiniteQueryOptions, type InfiniteQueryTypes, type InputArgs, type InputOf, type IsPaged, type LoadOptions, type PageFunctionContext, type PageOf, type PagedQueryFactory, type PagingControls, type Pending, platform_d_exports as Platform, type PromiseControls, query_d_exports as Query, type QueryBehavior, binding_d_exports as QueryBinding, cache_d_exports as QueryCache, QueryClient, type QueryClientConfig, type QueryControls, type QueryFactory, type QueryFnResult, type QueryFunctionContext, type QueryHandle, type QueryHandleWithData, type QueryKey, type QueryMeta, observer_d_exports as QueryObserver, type QueryOptions, type QueryTypes, type ReadValue, RedactedError, type Register, type RetryPolicy, type ServicesOf, type Settled, type Thenable, type ThrowsOnError, type UseQueryControls, type UseQueryOptions, type UseQueryThrowOptions, allKeyed, canDehydrate, dehydrate, dehydrateQuery, fulfilled, hashKey, hydrate, infiniteQueryOptions, matchesKey, pending, promiseControls, queryOptions, resultThenable };
13
+ export { type AnyQueryOptions, type DataOf, type DehydrateOptions, type DehydratedQuery, type DehydratedResult, type DehydratedState, type DehydratedStream, type ErrorOf, type HasTypedError, type HydrateOptions, type InfiniteData, type InfiniteQueryOptions, type InfiniteQueryTypes, type InputArgs, type InputOf, type IsPaged, type LoadOptions, type PageFunctionContext, type PageOf, type PagedQueryFactory, type PagingControls, type Pending, platform_d_exports as Platform, type PromiseControls, query_d_exports as Query, type QueryBehavior, binding_d_exports as QueryBinding, cache_d_exports as QueryCache, QueryClient, type QueryClientConfig, type QueryControls, type QueryFactory, type QueryFnResult, type QueryFunctionContext, type QueryHandle, type QueryHandleWithData, type QueryKey, type QueryMeta, observer_d_exports as QueryObserver, type QueryOptions, type QueryTypes, type ReadValue, RedactedError, type Register, type RetryPolicy, type ServicesOf, type Settled, type Thenable, type ThrowsOnError, type UseQueryControls, type UseQueryOptions, type UseQueryThrowOptions, allKeyed, canDehydrate, dehydrate, dehydrateQuery, fulfilled, hashKey, hydrate, infiniteQueryOptions, matchesKey, pending, promiseControls, queryOptions, resultThenable, throwsOnError };
package/dist/index.mjs CHANGED
@@ -7,7 +7,7 @@ import { RedactedError, canDehydrate, dehydrateQuery } from "./hydration.mjs";
7
7
  import { infiniteQueryOptions, queryOptions } from "./options.mjs";
8
8
  import { cache_exports } from "./cache.mjs";
9
9
  import { QueryClient, dehydrate, hydrate } from "./client.mjs";
10
- import { promiseControls, resultThenable } from "./controls.mjs";
10
+ import { promiseControls, resultThenable, throwsOnError } from "./controls.mjs";
11
11
  import { observer_exports } from "./observer.mjs";
12
12
  import { binding_exports } from "./binding.mjs";
13
- export { platform_exports as Platform, query_exports as Query, binding_exports as QueryBinding, cache_exports as QueryCache, QueryClient, observer_exports as QueryObserver, RedactedError, allKeyed, canDehydrate, dehydrate, dehydrateQuery, fulfilled, hashKey, hydrate, infiniteQueryOptions, matchesKey, pending, promiseControls, queryOptions, resultThenable };
13
+ export { platform_exports as Platform, query_exports as Query, binding_exports as QueryBinding, cache_exports as QueryCache, QueryClient, observer_exports as QueryObserver, RedactedError, allKeyed, canDehydrate, dehydrate, dehydrateQuery, fulfilled, hashKey, hydrate, infiniteQueryOptions, matchesKey, pending, promiseControls, queryOptions, resultThenable, throwsOnError };
package/dist/infinite.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  import { replaceEqualDeep } from "./share.mjs";
2
- import { Effect, Predicate } from "effect";
2
+ import { Effect, Option, Predicate } from "effect";
3
3
  //#region src/infinite.ts
4
4
  function isInfiniteData(data) {
5
5
  return Predicate.hasProperty(data, "pages") && Predicate.hasProperty(data, "pageParams") && Array.isArray(data.pages) && Array.isArray(data.pageParams);
@@ -31,6 +31,31 @@ function addPage(data, page, pageParam, direction, maxPages) {
31
31
  function edgeParam(data, direction) {
32
32
  return direction === "forward" ? data.pageParams.at(-1) : data.pageParams[0];
33
33
  }
34
+ /** The page `data` holds for `pageParam`, compared deeply. */
35
+ function pageFor(data, pageParam) {
36
+ const index = data?.pageParams.findIndex((param) => replaceEqualDeep(param, pageParam) === param) ?? -1;
37
+ return index === -1 ? Option.none() : Option.some(data?.pages[index]);
38
+ }
39
+ /**
40
+ * `data`, a full refetch's pages, with each page that `latest` replaced
41
+ * after the refetch started reading it: that write is newer than the read.
42
+ * A page written before its read started is read again, and the read wins.
43
+ */
44
+ function keepWrites(data, readFrom, latest) {
45
+ let changed = false;
46
+ const pages = data.pages.map((page, index) => {
47
+ const pageParam = data.pageParams[index];
48
+ const read = readFrom.find((entry) => replaceEqualDeep(entry.pageParam, pageParam) === entry.pageParam);
49
+ const now = pageFor(latest, pageParam);
50
+ if (!read || Option.isNone(now) || Option.isSome(read.seen) && read.seen.value === now.value) return page;
51
+ changed = true;
52
+ return now.value;
53
+ });
54
+ return changed ? {
55
+ pageParams: data.pageParams,
56
+ pages
57
+ } : data;
58
+ }
34
59
  /**
35
60
  * A paged query's request. With a `direction`, adds one page at that end of
36
61
  * the entry's data, read again with `latest` once the page loads, so data
@@ -38,7 +63,8 @@ function edgeParam(data, direction) {
38
63
  * longer ends at the page param the request started from, the write
39
64
  * replaced the list, and the page is dropped. Without a `direction`, loads
40
65
  * from the first page param again: as many pages as `current` has, or
41
- * `pages` if that's more, stopping at the last page.
66
+ * `pages` if that's more, stopping at the last page. A page written while
67
+ * the refetch was reading it, or after, stays as written ({@link keepWrites}).
42
68
  */
43
69
  const fetchPages = /*#__PURE__*/ Effect.fnUntraced(function* (options, current, request, fetchPage, latest) {
44
70
  const direction = request.direction;
@@ -56,6 +82,7 @@ const fetchPages = /*#__PURE__*/ Effect.fnUntraced(function* (options, current,
56
82
  pageParams: [],
57
83
  pages: []
58
84
  };
85
+ const readFrom = [];
59
86
  let pageParam = current && current.pageParams.length > 0 ? current.pageParams[0] : options.initialPageParam;
60
87
  for (let index = 0; index < count; index++) {
61
88
  if (index > 0) {
@@ -63,10 +90,14 @@ const fetchPages = /*#__PURE__*/ Effect.fnUntraced(function* (options, current,
63
90
  if (next == null) break;
64
91
  pageParam = next;
65
92
  }
93
+ readFrom.push({
94
+ pageParam,
95
+ seen: pageFor(latest(), pageParam)
96
+ });
66
97
  const page = yield* fetchPage(pageParam, "forward");
67
98
  data = addPage(data, page, pageParam, "forward", options.maxPages);
68
99
  }
69
- return data;
100
+ return keepWrites(data, readFrom, latest());
70
101
  });
71
102
  //#endregion
72
103
  export { fetchPages, isInfiniteData, nextPageParam, previousPageParam };
package/dist/query.d.mts CHANGED
@@ -5,7 +5,7 @@ import { Thenable } from "./thenable.mjs";
5
5
  import { BrowserOnlyError as BrowserOnlyError$1, CancelledError as CancelledError$1, TypeId as TypeId$1, entry_d_exports } from "./entry.mjs";
6
6
  import { Effect, Pipeable, Stream } from "effect";
7
7
  declare namespace query_d_exports {
8
- export { BrowserOnlyError, CancelledError, FetchRequest, Query, State, SubscribeOptions, TypeId, changes, fetch, fetchNextPage, fetchPreviousPage, get, getUnsafe, hasNextPageUnsafe, hasPreviousPageUnsafe, invalidate, isQuery, isStaleUnsafe, metaUnsafe, observerCountUnsafe, readUnsafe, refetch, reset, revalidateUnsafe, subscribeUnsafe };
8
+ export { BrowserOnlyError, CancelledError, FetchRequest, Query, State, SubscribeOptions, TypeId, changes, fetch, fetchNextPage, fetchPreviousPage, get, getUnsafe, hasNextPageUnsafe, hasPreviousPageUnsafe, invalidate, isQuery, isStaleUnsafe, metaUnsafe, observerCountUnsafe, readUnsafe, refetch, reset, returnsEffectUnsafe, revalidateUnsafe, subscribeUnsafe };
9
9
  }
10
10
  export declare const TypeId: typeof TypeId$1;
11
11
  export type TypeId = typeof TypeId;
@@ -98,6 +98,13 @@ export declare function reset<TFactory extends QueryFactory>(self: Query<TFactor
98
98
  * with, before any), else the cache default's.
99
99
  */
100
100
  export declare function metaUnsafe<TFactory extends QueryFactory>(self: Query<TFactory>): QueryMeta | undefined;
101
+ /**
102
+ * Whether the query's `queryFn` returns an Effect (`true`) or a promise or
103
+ * plain value (`false`), as of its last call, on this cache or the one its
104
+ * data was hydrated from. `undefined` until one has run. Bindings read typed
105
+ * errors as a `Result` only for Effects.
106
+ */
107
+ export declare function returnsEffectUnsafe<TFactory extends QueryFactory>(self: Query<TFactory>): boolean | undefined;
101
108
  /** The entry's current state. */
102
109
  export declare function get<TFactory extends QueryFactory>(self: Query<TFactory>): Effect.Effect<State<DataOf<TFactory>>>;
103
110
  /** {@link get}, synchronously. */
package/dist/query.mjs CHANGED
@@ -31,6 +31,7 @@ var query_exports = /* @__PURE__ */ __exportAll({
31
31
  readUnsafe: () => readUnsafe,
32
32
  refetch: () => refetch,
33
33
  reset: () => reset,
34
+ returnsEffectUnsafe: () => returnsEffectUnsafe,
34
35
  revalidateUnsafe: () => revalidateUnsafe,
35
36
  subscribeUnsafe: () => subscribeUnsafe
36
37
  });
@@ -85,6 +86,15 @@ function reset(self) {
85
86
  function metaUnsafe(self) {
86
87
  return metaOf(entryOf(self));
87
88
  }
89
+ /**
90
+ * Whether the query's `queryFn` returns an Effect (`true`) or a promise or
91
+ * plain value (`false`), as of its last call, on this cache or the one its
92
+ * data was hydrated from. `undefined` until one has run. Bindings read typed
93
+ * errors as a `Result` only for Effects.
94
+ */
95
+ function returnsEffectUnsafe(self) {
96
+ return entryOf(self).returnsEffect;
97
+ }
88
98
  /** The entry's current state. */
89
99
  function get(self) {
90
100
  return Effect.sync(() => getUnsafe(self));
@@ -134,4 +144,4 @@ function observerCountUnsafe(self) {
134
144
  return entryOf(self).listeners.size;
135
145
  }
136
146
  //#endregion
137
- export { BrowserOnlyError, CancelledError, TypeId, changes, fetch, fetchNextPage, fetchPreviousPage, get, getUnsafe, hasNextPageUnsafe, hasPreviousPageUnsafe, invalidate, isQuery, isStaleUnsafe, metaUnsafe, observerCountUnsafe, query_exports, readUnsafe, refetch, reset, revalidateUnsafe, subscribeUnsafe };
147
+ export { BrowserOnlyError, CancelledError, TypeId, changes, fetch, fetchNextPage, fetchPreviousPage, get, getUnsafe, hasNextPageUnsafe, hasPreviousPageUnsafe, invalidate, isQuery, isStaleUnsafe, metaUnsafe, observerCountUnsafe, query_exports, readUnsafe, refetch, reset, returnsEffectUnsafe, revalidateUnsafe, subscribeUnsafe };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@raf-query/core",
3
- "version": "0.10.3",
3
+ "version": "0.10.4",
4
4
  "description": "Framework-agnostic core of raf-query, a render-as-you-fetch query library",
5
5
  "keywords": [
6
6
  "query",