reactjrx 2.1.1 → 2.2.0

package/dist/lib/queries/createObservableQueryFn.d.ts

@@ -5,14 +5,13 @@ export type ObservableQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey
  * Bridges an Observable-based `queryFn` to the Promise-based `queryFn`
  * expected by TanStack Query. Shared by `useQuery$` and `useQueries$`.
  *
- * Every value is written into the query as soon as the stream emits it. A
- * fetch TanStack starts (mount, `refetch()`, `invalidateQueries()`...) ends
- * once the stream has a value in the cache, like a regular query, so awaiting
- * it settles. Right after it, the bridge starts a fetch that follows the
- * stream: it keeps the query `fetching` while the stream runs and ends when
- * the stream completes or errors. A refetch takes over a running stream and
- * settles with its current value. Cancelling the fetch in progress (the last
- * observer unmounting, `cancelQueries`, the query leaving the cache) stops
- * the stream.
+ * Every value is written into the query as soon as the stream emits it. Each
+ * fetch TanStack starts (mount, `refetch()`, `invalidateQueries()`...) runs
+ * the `queryFn` and ends once the stream has a value in the cache, like a
+ * regular query, so awaiting it settles. Right after it, the bridge starts a
+ * fetch that follows the stream: it keeps the query `fetching` while the
+ * stream runs and ends when the stream completes or errors. Cancelling the
+ * fetch in progress (a refetch replacing it, the last observer unmounting,
+ * `cancelQueries`, the query leaving the cache) stops the stream.
  */
 export declare function createObservableQueryFn<TQueryFnData = unknown, TQueryKey extends QueryKey = QueryKey>(queryFn: ObservableQueryFn<TQueryFnData, TQueryKey> | undefined): typeof skipToken | ((context: QueryFunctionContext<TQueryKey>) => Promise<TQueryFnData>) | undefined;

package/dist/lib/queries/lockedLiveQueryOptions.d.ts

@@ -0,0 +1,11 @@
+/**
+ * What `useLiveQuery$` and `useLiveQueries$` lock, so that no default of the
+ * `QueryClient` keeps a live query from reopening its stream: its data is
+ * stale as soon as no stream backs it, and every mount fetches, which joins a
+ * running stream or reopens a stopped one.
+ */
+export declare const lockedLiveQueryOptions: {
+    readonly staleTime: 0;
+    readonly refetchOnMount: "always";
+};
+export type LockedLiveQueryOption = keyof typeof lockedLiveQueryOptions;

package/dist/lib/queries/useLiveQueries$.d.ts

@@ -0,0 +1,12 @@
+import { QueryClient } from '@tanstack/react-query';
+import { LockedLiveQueryOption } from './lockedLiveQueryOptions';
+import { QueriesOptions$, QueriesResults$ } from './useQueries$';
+/**
+ * `useQueries$` for streams that stay open. Like `useLiveQuery$`, it locks
+ * each query's `staleTime` to 0 and `refetchOnMount` to `"always"`.
+ */
+export declare function useLiveQueries$<T extends Array<any>, TCombinedResult = QueriesResults$<T>>({ queries, ...options }: {
+    queries: readonly [...QueriesOptions$<T, [], [], LockedLiveQueryOption>];
+    combine?: (result: QueriesResults$<T>) => TCombinedResult;
+    subscribed?: boolean;
+}, queryClient?: QueryClient): TCombinedResult;

package/dist/lib/queries/useLiveQuery$.d.ts

@@ -0,0 +1,15 @@
+import { DefaultError, QueryClient, QueryKey } from '@tanstack/react-query';
+import { LockedLiveQueryOption } from './lockedLiveQueryOptions';
+import { UseQuery$Options } from './useQuery$';
+/**
+ * The options of `useLiveQuery$`: those of `useQuery$`, without the ones it
+ * locks.
+ */
+export type UseLiveQuery$Options<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQuery$Options<TQueryFnData, TError, TData, TQueryKey>, LockedLiveQueryOption>;
+/**
+ * `useQuery$` for a stream that stays open, such as a live database query or
+ * a socket. It locks `staleTime` to 0 and `refetchOnMount` to `"always"`, so
+ * whatever the `QueryClient`'s defaults, the query reopens its stream
+ * whenever a component needs it again.
+ */
+export declare function useLiveQuery$<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseLiveQuery$Options<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): import('@tanstack/react-query').UseQueryResult<TData, TError>;

package/dist/lib/queries/useLiveQuery$.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/queries/useQueries$.d.ts

@@ -1,14 +1,14 @@
 import { DefaultError, QueriesPlaceholderDataFunction, QueryClient, QueryKey, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import { ObservableQueryFn } from './createObservableQueryFn';
 type MAXIMUM_DEPTH = 20;
-type UseQuery$OptionsForUseQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn" | "placeholderData"> & {
+type UseQuery$OptionsForUseQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TOmitted extends PropertyKey = never> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn" | "placeholderData" | TOmitted> & {
     queryFn?: ObservableQueryFn<TQueryFnData, TQueryKey>;
     placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
 };
-type GetUseQuery$Options<T> = T extends {
+type GetUseQuery$Options<T, TOmitted extends PropertyKey> = T extends {
     queryFn?: ObservableQueryFn<infer TQueryFnData, infer TQueryKey>;
     select?: (data: any) => infer TData;
-} ? UseQuery$OptionsForUseQueries<TQueryFnData, DefaultError, unknown extends TData ? TQueryFnData : TData, TQueryKey extends QueryKey ? TQueryKey : QueryKey> : UseQuery$OptionsForUseQueries;
+} ? UseQuery$OptionsForUseQueries<TQueryFnData, DefaultError, unknown extends TData ? TQueryFnData : TData, TQueryKey extends QueryKey ? TQueryKey : QueryKey, TOmitted> : UseQuery$OptionsForUseQueries<unknown, DefaultError, unknown, QueryKey, TOmitted>;
 type GetUseQuery$Result<T> = T extends {
     queryFn?: ObservableQueryFn<infer TQueryFnData, any>;
     select?: (data: any) => infer TData;
@@ -17,16 +17,17 @@ type GetUseQuery$Result<T> = T extends {
  * Mirrors TanStack's `QueriesOptions`, but each query takes an Observable-based
  * `queryFn` (see {@link ObservableQueryFn}) instead of a Promise-based one. The
  * recursion preserves per-element tuple inference at the call site.
+ * `TOmitted` leaves options out of every query.
  */
-export type QueriesOptions$<T extends Array<any>, TResults extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth["length"] extends MAXIMUM_DEPTH ? Array<UseQuery$OptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQuery$Options<Head>] : T extends [infer Head, ...infer Tails] ? QueriesOptions$<[
+export type QueriesOptions$<T extends Array<any>, TResults extends Array<any> = [], TDepth extends ReadonlyArray<number> = [], TOmitted extends PropertyKey = never> = TDepth["length"] extends MAXIMUM_DEPTH ? Array<UseQuery$OptionsForUseQueries<unknown, DefaultError, unknown, QueryKey, TOmitted>> : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQuery$Options<Head, TOmitted>] : T extends [infer Head, ...infer Tails] ? QueriesOptions$<[
     ...Tails
 ], [
     ...TResults,
-    GetUseQuery$Options<Head>
+    GetUseQuery$Options<Head, TOmitted>
 ], [
     ...TDepth,
     1
-]> : ReadonlyArray<unknown> extends T ? T : Array<UseQuery$OptionsForUseQueries>;
+], TOmitted> : ReadonlyArray<unknown> extends T ? T : Array<UseQuery$OptionsForUseQueries<unknown, DefaultError, unknown, QueryKey, TOmitted>>;
 /**
  * Mirrors TanStack's `QueriesResults`, mapping each Observable-based query
  * option to its `UseQueryResult`.

package/dist/lib/queries/useQuery$.d.ts

@@ -1,5 +1,10 @@
 import { DefaultError, QueryClient, QueryKey, UseQueryOptions } from '@tanstack/react-query';
 import { ObservableQueryFn } from './createObservableQueryFn';
-export declare function useQuery$<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>({ queryFn, ...options }: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & {
+/**
+ * TanStack's `UseQueryOptions`, with an Observable-based `queryFn` (see
+ * {@link ObservableQueryFn}).
+ */
+export type UseQuery$Options<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & {
     queryFn: ObservableQueryFn<TQueryFnData, TQueryKey>;
-}, queryClient?: QueryClient): import('@tanstack/react-query').UseQueryResult<TData, TError>;
+};
+export declare function useQuery$<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>({ queryFn, ...options }: UseQuery$Options<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): import('@tanstack/react-query').UseQueryResult<TData, TError>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "reactjrx",
   "private": false,
-  "version": "2.1.1",
+  "version": "2.2.0",
   "type": "module",
   "files": [
     "dist"