ngx-signal-query 1.8.0-dev.2 → 1.8.0-dev.3

package/index.d.ts

@@ -220,9 +220,10 @@ type QueryResult<TData, TError = Error> = {
     /**
      * When the data was last updated, as a timestamp in ms: when the last
      * response landed or `setQueryData` wrote it; for `initialData`, its
-     * `initialDataUpdatedAt`, or when it was seeded. A refetch that brings the
-     * same data moves it too; one that fails or is cancelled doesn't. `0` while
-     * there is no data, placeholder data included.
+     * `initialDataUpdatedAt`, or when it was seeded; for data a server render
+     * brought over (see {@link withHydration}), when the server fetched it. A
+     * refetch that brings the same data moves it too; one that fails or is
+     * cancelled doesn't. `0` while there is no data, placeholder data included.
      */
     dataUpdatedAt: Signal<number>;
     /** Current {@link QueryStatus}. */
@@ -386,7 +387,7 @@ declare class Query<TData, TError = Error> {
 declare class QueryCache extends Cache<Query<unknown, unknown>> {
     #private;
     constructor();
-    getOrCreate<TData, TError = Error>(key: QueryKey, gcTime: number): Query<TData, TError>;
+    getOrCreate<TData, TError = Error>(key: QueryKey, gcTime: number, queryHash?: string): Query<TData, TError>;
     get<TData, TError = Error>(key: QueryKey): Query<TData, TError> | undefined;
     /**
      * Like get(), but reactive, as findAll() is: a computed or an effect that
@@ -762,7 +763,8 @@ declare class QueryClient {
  * @internal
  */
 declare enum QueryClientFeatureKind {
-    DefaultOptions = 0
+    DefaultOptions = 0,
+    Hydration = 1
 }
 /**
  * An opaque feature passed to {@link provideQueryClient}. Create one with a
@@ -781,11 +783,12 @@ interface QueryClientFeature<K extends QueryClientFeatureKind = QueryClientFeatu
  * `bootstrapApplication`). A client provided by another environment injector
  * goes with it: once that injector is destroyed, its queries stop, and none
  * of their fetches keeps the app busy. Pass features such as
- * {@link withDefaultOptions} to configure defaults. Registering the same
- * feature twice throws.
+ * {@link withDefaultOptions} to configure defaults, or {@link withHydration}
+ * to bring the data of a server render over to the browser. Registering the
+ * same feature twice throws.
  *
  * @param features - Optional {@link QueryClientFeature}s (e.g.
- *   {@link withDefaultOptions}).
+ *   {@link withDefaultOptions}, {@link withHydration}).
  * @returns Environment providers to add to the app's provider list.
  *
  * @example
@@ -1139,5 +1142,42 @@ declare class CancelledError extends Error {
  */
 declare function withDefaultOptions(options: DefaultOptions): QueryClientFeature<QueryClientFeatureKind.DefaultOptions>;
 
-export { CancelledError, QueryClient, QueryClientFeatureKind, injectIsFetching, injectIsMutating, injectMutation, injectQueries, injectQuery, injectQueryClient, keepPreviousData, mutationOptions, provideQueryClient, queryOptions, withDefaultOptions };
+/**
+ * Feature for {@link provideQueryClient} that brings the data a server render
+ * fetched over to the browser, so the page shows it at once rather than a
+ * loading state. Add it to the providers the server and the browser share. It
+ * works with Angular's `provideClientHydration()` or without it.
+ *
+ * Only queries that succeeded go over, and only data JSON carries as is:
+ * strings, numbers, booleans, `null`, plain objects and arrays. A query whose
+ * data holds a `Date`, a `Map` or a class instance stays on the server, and
+ * the browser fetches it again; in development the server logs a warning
+ * naming it.
+ *
+ * In the browser the data counts as fetched when the server fetched it, and
+ * `staleTime` decides as for any data in the cache: with the default of `0`,
+ * a component refetches its query in the background as it appears, showing
+ * the server's data meanwhile. Set a `staleTime` to skip that request.
+ *
+ * Give it to one client per app: clients provided by other environment
+ * injectors would share one place in the page, and only one of them would get
+ * its data over.
+ *
+ * @returns A {@link QueryClientFeature} to pass to {@link provideQueryClient}.
+ *
+ * @example
+ * ```ts
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideQueryClient(
+ *       withDefaultOptions({ queries: { staleTime: 30_000 } }),
+ *       withHydration(),
+ *     ),
+ *   ],
+ * }
+ * ```
+ */
+declare function withHydration(): QueryClientFeature<QueryClientFeatureKind.Hydration>;
+
+export { CancelledError, QueryClient, QueryClientFeatureKind, injectIsFetching, injectIsMutating, injectMutation, injectQueries, injectQuery, injectQueryClient, keepPreviousData, mutationOptions, provideQueryClient, queryOptions, withDefaultOptions, withHydration };
 export type { DefaultMutationOptions, DefaultOptions, DefaultQueryOptions, DefaultedQueryOptions, InjectQueriesOptions, InvalidateQueryFilters, MutationFilters, MutationOptions, MutationResult, MutationState, MutationStatus, PlaceholderDataFunction, QueryClientFeature, QueryFilters, QueryKey, QueryOptions, QueryResult, QueryState, QueryStatus, RefetchIntervalValue, RetryDelayValue, RetryValue, StructuralSharingValue, Updater };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-signal-query",
-  "version": "1.8.0-dev.2",
+  "version": "1.8.0-dev.3",
   "description": "Data fetching, caching and mutations for Angular, built on signals and RxJS. Observables end to end, TanStack Query concepts.",
   "keywords": [
     "angular",