@tanstack/vue-query - npm Package Compare versions

Comparing version 5.28.7 to 5.28.8

build/legacy/queryClient.d.ts

@@ -1,2 +0,2 @@
-import { QueryClient as QueryClient$1, QueryClientConfig, QueryFilters, MutationFilters, QueryKey, DataTag, DefaultError, EnsureQueryDataOptions, Updater, NoInfer, SetDataOptions, QueryState, ResetOptions, CancelOptions, InvalidateQueryFilters, InvalidateOptions, RefetchQueryFilters, RefetchOptions, FetchQueryOptions, FetchInfiniteQueryOptions, InfiniteData, DefaultOptions, QueryObserverOptions, MutationKey, MutationObserverOptions } from '@tanstack/query-core';
+import { QueryClient as QueryClient$1, QueryClientConfig, QueryFilters, MutationFilters, QueryKey, DataTag, DefaultError, EnsureQueryDataOptions, Updater, NoInfer, SetDataOptions, QueryState, ResetOptions, CancelOptions, InvalidateQueryFilters, InvalidateOptions, RefetchQueryFilters, RefetchOptions, FetchQueryOptions, FetchInfiniteQueryOptions, InfiniteData, DefaultOptions, OmitKeyof, QueryObserverOptions, MutationKey, MutationObserverOptions } from '@tanstack/query-core';
 import { Ref } from 'vue-demi';
@@ -33,4 +33,4 @@ import { MaybeRefDeep, NoUnknown } from './types.js';
     setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void;
-    setQueryDefaults(queryKey: MaybeRefDeep<QueryKey>, options: MaybeRefDeep<Omit<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
-    getQueryDefaults(queryKey: MaybeRefDeep<QueryKey>): Omit<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
+    setQueryDefaults(queryKey: MaybeRefDeep<QueryKey>, options: MaybeRefDeep<OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
+    getQueryDefaults(queryKey: MaybeRefDeep<QueryKey>): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
     setMutationDefaults(mutationKey: MaybeRefDeep<MutationKey>, options: MaybeRefDeep<MutationObserverOptions<any, any, any, any>>): void;
@@ -37,0 +37,0 @@ getMutationDefaults(mutationKey: MaybeRefDeep<MutationKey>): MutationObserverOptions<any, any, any, any>;

build/legacy/useQueries.d.ts

@@ -61,3 +61,3 @@ import { Ref } from 'vue-demi';
     1
-]> : Array<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
+]> : Readonly<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
 /**
@@ -64,0 +64,0 @@ * UseQueriesResults reducer recursively maps type param to results

build/legacy/useQueries.js

@@ -26,10 +26,12 @@ // src/useQueries.ts
   const defaultedQueries = computed(
-    () => cloneDeepUnref(queries).map((queryOptions) => {
-      if (typeof queryOptions.enabled === "function") {
-        queryOptions.enabled = queryOptions.enabled();
+    () => cloneDeepUnref(queries).map(
+      (queryOptions) => {
+        if (typeof queryOptions.enabled === "function") {
+          queryOptions.enabled = queryOptions.enabled();
+        }
+        const defaulted = client.defaultQueryOptions(queryOptions);
+        defaulted._optimisticResults = client.isRestoring.value ? "isRestoring" : "optimistic";
+        return defaulted;
       }
-      const defaulted = client.defaultQueryOptions(queryOptions);
-      defaulted._optimisticResults = client.isRestoring.value ? "isRestoring" : "optimistic";
-      return defaulted;
-    })
+    )
   );
@@ -36,0 +38,0 @@ const observer = new QueriesObserver(

build/modern/queryClient.d.ts

@@ -1,2 +0,2 @@
-import { QueryClient as QueryClient$1, QueryClientConfig, QueryFilters, MutationFilters, QueryKey, DataTag, DefaultError, EnsureQueryDataOptions, Updater, NoInfer, SetDataOptions, QueryState, ResetOptions, CancelOptions, InvalidateQueryFilters, InvalidateOptions, RefetchQueryFilters, RefetchOptions, FetchQueryOptions, FetchInfiniteQueryOptions, InfiniteData, DefaultOptions, QueryObserverOptions, MutationKey, MutationObserverOptions } from '@tanstack/query-core';
+import { QueryClient as QueryClient$1, QueryClientConfig, QueryFilters, MutationFilters, QueryKey, DataTag, DefaultError, EnsureQueryDataOptions, Updater, NoInfer, SetDataOptions, QueryState, ResetOptions, CancelOptions, InvalidateQueryFilters, InvalidateOptions, RefetchQueryFilters, RefetchOptions, FetchQueryOptions, FetchInfiniteQueryOptions, InfiniteData, DefaultOptions, OmitKeyof, QueryObserverOptions, MutationKey, MutationObserverOptions } from '@tanstack/query-core';
 import { Ref } from 'vue-demi';
@@ -33,4 +33,4 @@ import { MaybeRefDeep, NoUnknown } from './types.js';
     setDefaultOptions(options: MaybeRefDeep<DefaultOptions>): void;
-    setQueryDefaults(queryKey: MaybeRefDeep<QueryKey>, options: MaybeRefDeep<Omit<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
-    getQueryDefaults(queryKey: MaybeRefDeep<QueryKey>): Omit<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
+    setQueryDefaults(queryKey: MaybeRefDeep<QueryKey>, options: MaybeRefDeep<OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>>): void;
+    getQueryDefaults(queryKey: MaybeRefDeep<QueryKey>): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'>;
     setMutationDefaults(mutationKey: MaybeRefDeep<MutationKey>, options: MaybeRefDeep<MutationObserverOptions<any, any, any, any>>): void;
@@ -37,0 +37,0 @@ getMutationDefaults(mutationKey: MaybeRefDeep<MutationKey>): MutationObserverOptions<any, any, any, any>;

build/modern/useQueries.d.ts

@@ -61,3 +61,3 @@ import { Ref } from 'vue-demi';
     1
-]> : Array<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
+]> : Readonly<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
 /**
@@ -64,0 +64,0 @@ * UseQueriesResults reducer recursively maps type param to results

build/modern/useQueries.js

@@ -26,10 +26,12 @@ // src/useQueries.ts
   const defaultedQueries = computed(
-    () => cloneDeepUnref(queries).map((queryOptions) => {
-      if (typeof queryOptions.enabled === "function") {
-        queryOptions.enabled = queryOptions.enabled();
+    () => cloneDeepUnref(queries).map(
+      (queryOptions) => {
+        if (typeof queryOptions.enabled === "function") {
+          queryOptions.enabled = queryOptions.enabled();
+        }
+        const defaulted = client.defaultQueryOptions(queryOptions);
+        defaulted._optimisticResults = client.isRestoring.value ? "isRestoring" : "optimistic";
+        return defaulted;
       }
-      const defaulted = client.defaultQueryOptions(queryOptions);
-      defaulted._optimisticResults = client.isRestoring.value ? "isRestoring" : "optimistic";
-      return defaulted;
-    })
+    )
   );
@@ -36,0 +38,0 @@ const observer = new QueriesObserver(

package.json

 {
   "name": "@tanstack/vue-query",
-  "version": "5.28.7",
+  "version": "5.28.8",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in Vue",
@@ -52,3 +52,3 @@ "author": "Damian Osipiuk",
     "vue-demi": "^0.14.6",
-    "@tanstack/query-core": "5.28.6"
+    "@tanstack/query-core": "5.28.8"
   },
@@ -55,0 +55,0 @@ "devDependencies": {

src/__tests__/useQueries.types.test.ts

 import { describe, it } from 'vitest'
 import { reactive } from 'vue'
-import { useQueries } from '..'
+import { skipToken, useQueries } from '..'
 import { queryOptions } from '../queryOptions'
 import { doNotExecute } from './test-utils'
+import type { OmitKeyof } from '..'
 import type { UseQueryOptions } from '../useQuery'
@@ -126,2 +127,20 @@ import type { Equal, Expect } from './test-utils'
 
+  it('TData should have correct type when conditional skipToken is passed', () => {
+    doNotExecute(() => {
+      const { value: queriesState } = useQueries({
+        queries: [
+          {
+            queryKey: ['key'],
+            queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5),
+          },
+        ],
+      })
+
+      const data = queriesState[0].data
+
+      const result: Expect<Equal<number | undefined, typeof data>> = true
+      return result
+    })
+  })
+
   describe('custom hook', () => {
@@ -133,3 +152,7 @@ it('should allow custom hooks using UseQueryOptions', () => {
         const useCustomQueries = (
-          options?: Omit<UseQueryOptions<Data>, 'queryKey' | 'queryFn'>,
+          options?: OmitKeyof<
+            UseQueryOptions<Data>,
+            'queryKey' | 'queryFn',
+            'safely'
+          >,
         ) => {
@@ -136,0 +159,0 @@ return useQueries({

src/__tests__/useQuery.types.test.ts

@@ -6,2 +6,3 @@ import { describe, it } from 'vitest'
 import { doNotExecute, simpleFetcher } from './test-utils'
+import type { OmitKeyof } from '..'
 import type { UseQueryOptions } from '../useQuery'
@@ -163,3 +164,7 @@ import type { Equal, Expect } from './test-utils'
         const useCustomQuery = (
-          options?: Omit<UseQueryOptions<Data>, 'queryKey' | 'queryFn'>,
+          options?: OmitKeyof<
+            UseQueryOptions<Data>,
+            'queryKey' | 'queryFn',
+            'safely'
+          >,
         ) => {
@@ -166,0 +171,0 @@ return useQuery({

src/queryClient.ts

@@ -23,2 +23,3 @@ import { ref } from 'vue-demi'
   NoInfer,
+  OmitKeyof,
   QueryClientConfig,
@@ -383,3 +384,3 @@ QueryFilters,
     options: MaybeRefDeep<
-      Omit<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>
+      OmitKeyof<QueryObserverOptions<unknown, any, any, any>, 'queryKey'>
     >,
@@ -392,3 +393,3 @@ ): void {
     queryKey: MaybeRefDeep<QueryKey>,
-  ): Omit<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {
+  ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, 'queryKey'> {
     return super.getQueryDefaults(cloneDeepUnref(queryKey))
@@ -395,0 +396,0 @@ }

src/useQueries.ts

@@ -185,3 +185,3 @@ import { QueriesObserver } from '@tanstack/query-core'
           >
-        : Array<unknown> extends T
+        : Readonly<unknown> extends T
           ? T
@@ -274,14 +274,16 @@ : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
   const defaultedQueries = computed(() =>
-    cloneDeepUnref(queries).map((queryOptions) => {
-      if (typeof queryOptions.enabled === 'function') {
-        queryOptions.enabled = queryOptions.enabled()
-      }
+    cloneDeepUnref(queries as MaybeRefDeep<UseQueriesOptionsArg<any>>).map(
+      (queryOptions) => {
+        if (typeof queryOptions.enabled === 'function') {
+          queryOptions.enabled = queryOptions.enabled()
+        }
 
-      const defaulted = client.defaultQueryOptions(queryOptions)
-      defaulted._optimisticResults = client.isRestoring.value
-        ? 'isRestoring'
-        : 'optimistic'
+        const defaulted = client.defaultQueryOptions(queryOptions)
+        defaulted._optimisticResults = client.isRestoring.value
+          ? 'isRestoring'
+          : 'optimistic'
 
-      return defaulted
-    }),
+        return defaulted
+      },
+    ),
   )
@@ -288,0 +290,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

751957

increased by0.19%

Lines of code

10381

increased by0.35%

Dependency changes

• + Added@tanstack/query-core@5.28.8(transitive)

• - Removed@tanstack/query-core@5.28.6(transitive)

• Updated@tanstack/query-core@5.28.8