ngx-signal-query 1.4.0 → 1.5.0-dev.2

package/index.d.ts

@@ -105,6 +105,20 @@ type QueryOptions<TData, TError = Error> = {
      * interval changes. See {@link RefetchIntervalValue}.
      */
     refetchInterval?: RefetchIntervalValue<TData, TError>;
+    /**
+     * Whether the query refetches when the user comes back to the page, as the
+     * tab or window turns visible again: `true` refetches stale data (see
+     * `staleTime`), `'always'` fresh data too, `false` never. Default `true`.
+     * However many components show the query, it refetches once.
+     */
+    refetchOnWindowFocus?: boolean | 'always';
+    /**
+     * Whether the query refetches when the network comes back (the browser's
+     * `online` event): `true` refetches stale data (see `staleTime`), so a
+     * query that failed while offline loads again; `'always'` refetches fresh
+     * data too, `false` never. Default `true`.
+     */
+    refetchOnReconnect?: boolean | 'always';
     /**
      * Seed data to render immediately (treated as already-resolved). A
      * function runs only while the query has no data yet; returning `undefined`
@@ -140,6 +154,8 @@ type DefaultedQueryOptions<TData, TError = Error> = QueryOptions<TData, TError>
     retry: RetryValue<TError>;
     retryDelay: RetryDelayValue<TError>;
     structuralSharing: StructuralSharingValue<TData>;
+    refetchOnWindowFocus: boolean | 'always';
+    refetchOnReconnect: boolean | 'always';
 };
 /** Reactive result returned by {@link injectQuery}; every field is a signal. */
 type QueryResult<TData, TError = Error> = {
@@ -183,6 +199,10 @@ interface DefaultQueryOptions {
     retryDelay?: RetryDelayValue<unknown>;
     /** Whether new data keeps the parts of the cached data that didn't change. Defaults to `true`. */
     structuralSharing?: StructuralSharingValue<unknown>;
+    /** Whether queries refetch when the user comes back to the page. Defaults to `true`. */
+    refetchOnWindowFocus?: boolean | 'always';
+    /** Whether queries refetch when the network comes back. Defaults to `true`. */
+    refetchOnReconnect?: boolean | 'always';
 }
 /**
  * Default mutation options applied to every mutation. A mutation's own value
@@ -215,18 +235,19 @@ interface DefaultOptions {
 
 /**
  * An observer of a query, as the query sees it: the query asks its observers
- * how to fetch it when it refetches on their behalf (after invalidation), and
- * how data written into it by hand merges.
+ * how to fetch it when it refetches on their behalf (after invalidation, on
+ * window focus or reconnect), and how data written into it by hand merges.
  *
  * @internal
  */
 interface QuerySubscriber<TData, TError = Error> {
     /**
-     * How this observer would fetch the query right now, read from its live
-     * options; `null` while it doesn't want the query fetched: it is disabled,
-     * or its key has already moved on to another query.
+     * How this observer would fetch the query right now, and when it wants it
+     * refetched, read from its live options; `null` while it doesn't want the
+     * query fetched: it is disabled, or its key has already moved on to another
+     * query.
      */
-    fetchOptions(): Pick<DefaultedQueryOptions<TData, TError>, 'queryFn' | 'retry' | 'retryDelay' | 'structuralSharing'> | null;
+    fetchOptions(): Pick<DefaultedQueryOptions<TData, TError>, 'queryFn' | 'retry' | 'retryDelay' | 'structuralSharing' | 'staleTime' | 'refetchOnWindowFocus' | 'refetchOnReconnect'> | null;
     /**
      * How this observer merges data written into the query by hand, read from
      * its live options, whether it's enabled or not.
@@ -245,10 +266,12 @@ declare class Query<TData, TError = Error> {
     addObserver(observer: QuerySubscriber<TData, TError>): void;
     removeObserver(observer: QuerySubscriber<TData, TError>): void;
     activeFetchOptions(): ReturnType<QuerySubscriber<TData, TError>['fetchOptions']>;
+    onFocus(): void;
+    onOnline(): void;
     structuralSharing(): StructuralSharingValue<TData> | undefined;
     fetch({ queryFn, retry, retryDelay, structuralSharing, }: Pick<QueryOptions<TData, TError>, 'queryFn' | 'retry' | 'retryDelay' | 'structuralSharing'>, { cancelRefetch }?: {
         cancelRefetch?: boolean;
-    }): void;
+    }): Promise<TData>;
     setData(data: TData, { updatedAt, structuralSharing, }?: {
         updatedAt?: number;
         structuralSharing?: StructuralSharingValue<TData>;
@@ -423,8 +446,9 @@ declare class QueryClient {
     getMutationCache(): MutationCache;
     /**
      * Merges per-query options with the configured defaults, filling in
-     * `staleTime`, `gcTime`, `retry`, `retryDelay` and `structuralSharing`.
-     * Used internally by {@link injectQuery}.
+     * `staleTime`, `gcTime`, `retry`, `retryDelay`, `structuralSharing`,
+     * `refetchOnWindowFocus` and `refetchOnReconnect`. Used internally by
+     * {@link injectQuery}.
      */
     defaultQueryOptions<TData, TError = Error>(options: QueryOptions<TData, TError>): DefaultedQueryOptions<TData, TError>;
     /**

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "ngx-signal-query",
-  "version": "1.4.0",
-  "description": "Signal-first data fetching, caching, and mutations for Angular — inspired by TanStack Query.",
+  "version": "1.5.0-dev.2",
+  "description": "Data fetching, caching and mutations for Angular, built on signals and RxJS. Observables end to end, TanStack Query concepts.",
   "keywords": [
     "angular",
     "signals",
+    "rxjs",
+    "observable",
+    "httpclient",
     "query",
     "tanstack",
     "tanstack-query",
     "data-fetching",
+    "server-state",
     "cache",
     "mutations",
     "async-state"
@@ -25,6 +29,7 @@
     "url": "https://github.com/dhutaryan/ngx-signal-query/issues"
   },
   "peerDependencies": {
+    "@angular/common": ">=19.0.0",
     "@angular/core": ">=19.0.0",
     "rxjs": "^7.4.0"
   },