@tanstack/svelte-query 5.37.1 → 5.38.0

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { createQueries } from './createQueries';
 export { createInfiniteQuery } from './createInfiniteQuery';
 export { infiniteQueryOptions } from './infiniteQueryOptions';
 export { createMutation } from './createMutation';
+export { useMutationState } from './useMutationState';
 export { useQueryClient } from './useQueryClient';
 export { useIsFetching } from './useIsFetching';
 export { useIsMutating } from './useIsMutating';

package/dist/index.js

@@ -10,6 +10,7 @@ export { createQueries } from './createQueries';
 export { createInfiniteQuery } from './createInfiniteQuery';
 export { infiniteQueryOptions } from './infiniteQueryOptions';
 export { createMutation } from './createMutation';
+export { useMutationState } from './useMutationState';
 export { useQueryClient } from './useQueryClient';
 export { useIsFetching } from './useIsFetching';
 export { useIsMutating } from './useIsMutating';

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="svelte" />
-import type { DefaultError, DefinedQueryObserverResult, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, MutationObserverOptions, MutationObserverResult, OmitKeyof, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
+import type { DefaultError, DefinedQueryObserverResult, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, Mutation, MutationFilters, MutationObserverOptions, MutationObserverResult, MutationState, OmitKeyof, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
 import type { Readable } from 'svelte/store';
 /** Allows a type to be either the base object or a store of that object */
 export type StoreOrVal<T> = T | Readable<T>;
@@ -33,4 +33,9 @@ export type CreateMutationResult<TData = unknown, TError = DefaultError, TVariab
 type Override<TTargetA, TTargetB> = {
     [AKey in keyof TTargetA]: AKey extends keyof TTargetB ? TTargetB[AKey] : TTargetA[AKey];
 };
+/** Options for useMutationState */
+export type MutationStateOptions<TResult = MutationState> = {
+    filters?: MutationFilters;
+    select?: (mutation: Mutation<unknown, DefaultError, unknown, unknown>) => TResult;
+};
 export {};

package/dist/useMutationState.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="svelte" />
+import type { MutationState, QueryClient } from '@tanstack/query-core';
+import type { Readable } from 'svelte/store';
+import type { MutationStateOptions } from './types';
+export declare function useMutationState<TResult = MutationState>(options?: MutationStateOptions<TResult>, queryClient?: QueryClient): Readable<Array<TResult>>;

package/dist/useMutationState.js

@@ -0,0 +1,23 @@
+import { readable } from 'svelte/store';
+import { notifyManager, replaceEqualDeep } from '@tanstack/query-core';
+import { useQueryClient } from './useQueryClient';
+function getResult(mutationCache, options) {
+    return mutationCache
+        .findAll(options.filters)
+        .map((mutation) => (options.select ? options.select(mutation) : mutation.state));
+}
+export function useMutationState(options = {}, queryClient) {
+    const client = useQueryClient(queryClient);
+    const mutationCache = client.getMutationCache();
+    let result = getResult(mutationCache, options);
+    const { subscribe } = readable(result, (set) => {
+        return mutationCache.subscribe(notifyManager.batchCalls(() => {
+            const nextResult = replaceEqualDeep(result, getResult(mutationCache, options));
+            if (result !== nextResult) {
+                result = nextResult;
+                set(result);
+            }
+        }));
+    });
+    return { subscribe };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-query",
-  "version": "5.37.1",
+  "version": "5.38.0",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
   "author": "Lachlan Collins",
   "license": "MIT",
@@ -33,7 +33,7 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.36.1"
+    "@tanstack/query-core": "5.38.0"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.3.1",

package/src/index.ts

@@ -18,6 +18,7 @@ export { createQueries } from './createQueries'
 export { createInfiniteQuery } from './createInfiniteQuery'
 export { infiniteQueryOptions } from './infiniteQueryOptions'
 export { createMutation } from './createMutation'
+export { useMutationState } from './useMutationState'
 export { useQueryClient } from './useQueryClient'
 export { useIsFetching } from './useIsFetching'
 export { useIsMutating } from './useIsMutating'

package/src/types.ts

@@ -4,8 +4,11 @@ import type {
   InfiniteQueryObserverOptions,
   InfiniteQueryObserverResult,
   MutateFunction,
+  Mutation,
+  MutationFilters,
   MutationObserverOptions,
   MutationObserverResult,
+  MutationState,
   OmitKeyof,
   QueryKey,
   QueryObserverOptions,
@@ -134,3 +137,11 @@ type Override<TTargetA, TTargetB> = {
     ? TTargetB[AKey]
     : TTargetA[AKey]
 }
+
+/** Options for useMutationState */
+export type MutationStateOptions<TResult = MutationState> = {
+  filters?: MutationFilters
+  select?: (
+    mutation: Mutation<unknown, DefaultError, unknown, unknown>,
+  ) => TResult
+}

package/src/useMutationState.ts

@@ -0,0 +1,49 @@
+import { readable } from 'svelte/store'
+import { notifyManager, replaceEqualDeep } from '@tanstack/query-core'
+import { useQueryClient } from './useQueryClient'
+import type {
+  MutationCache,
+  MutationState,
+  QueryClient,
+} from '@tanstack/query-core'
+import type { Readable } from 'svelte/store'
+import type { MutationStateOptions } from './types'
+
+function getResult<TResult = MutationState>(
+  mutationCache: MutationCache,
+  options: MutationStateOptions<TResult>,
+): Array<TResult> {
+  return mutationCache
+    .findAll(options.filters)
+    .map(
+      (mutation): TResult =>
+        (options.select ? options.select(mutation) : mutation.state) as TResult,
+    )
+}
+
+export function useMutationState<TResult = MutationState>(
+  options: MutationStateOptions<TResult> = {},
+  queryClient?: QueryClient,
+): Readable<Array<TResult>> {
+  const client = useQueryClient(queryClient)
+  const mutationCache = client.getMutationCache()
+
+  let result = getResult(mutationCache, options)
+
+  const { subscribe } = readable(result, (set) => {
+    return mutationCache.subscribe(
+      notifyManager.batchCalls(() => {
+        const nextResult = replaceEqualDeep(
+          result,
+          getResult(mutationCache, options),
+        )
+        if (result !== nextResult) {
+          result = nextResult
+          set(result)
+        }
+      }),
+    )
+  })
+
+  return { subscribe }
+}