feat: bump react-query (v3.23.2 - v3.30.0) (#90)

DamianOsipiuk · web-flow · commit 34f34cba5bfe · 2021-10-30T22:24:01.000+02:00
* chore: bump deps

* test: fix open handles

* refactor: change b to strong

* chore: prettier

* feat: bump react-query (v3.23.2 - v3.30.0), fix types

* fix: restore defaults for overloads

* fix: downgrade vue-demi
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+.gitignore
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -1 +1 @@
-module.exports = {extends: ['@commitlint/config-conventional']}
+module.exports = { extends: ["@commitlint/config-conventional"] };
diff --git a/examples/multi-client/src/Todos.vue b/examples/multi-client/src/Todos.vue
@@ -31,7 +31,9 @@ export default defineComponent({
 </script>
 
 <template>
-  <p>Turn on <b>network throttling</b> in dev-tools and press Refetch</p>
+  <p>
+    Turn on <strong>network throttling</strong> in dev-tools and press Refetch
+  </p>
   <button @click="refetch" :disabled="isFetching">
     {{ isFetching ? "Refetching..." : "Refetch" }}
   </button>
diff --git a/jest.config.ts b/jest.config.ts
@@ -3,12 +3,13 @@ import type { Config } from "@jest/types";
 const config: Config.InitialOptions = {
   preset: "ts-jest",
   transform: {
-    "^.+\\.vue$": "vue-jest",
+    "^.+\\.vue$": "@vue/vue3-jest",
   },
   moduleFileExtensions: ["js", "ts", "vue"],
   moduleNameMapper: {
     "^@/(.*)": "<rootDir>/src/$1",
   },
+  testPathIgnorePatterns: ["test-utils.ts"],
   collectCoverage: true,
   collectCoverageFrom: [
     "src/**/*.{ts,vue}",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "test": "npm run test:2 && npm run test:3",
     "test:2": "vue-demi-switch 2 vue2 && jest",
     "test:3": "vue-demi-switch 3 && jest",
+    "prettier": "prettier . --write",
     "verify": "npm run lint && npm run test && npm run build"
   },
   "repository": {
@@ -39,13 +40,13 @@
   },
   "homepage": "https://github.com/DamianOsipiuk/vue-query#readme",
   "dependencies": {
-    "match-sorter": "^6.3.0",
-    "react-query": "^3.23.2",
+    "match-sorter": "^6.3.1",
+    "react-query": "^3.30.0",
     "vue-demi": "^0.10.1"
   },
   "peerDependencies": {
     "@nuxtjs/composition-api": "^0.24.4",
-    "@vue/composition-api": "^1.0.0-rc.1",
+    "@vue/composition-api": "^1.0.0",
     "vue": "^2.0.0 || >=3.0.0"
   },
   "peerDependenciesMeta": {
@@ -57,34 +58,34 @@
     }
   },
   "devDependencies": {
-    "@commitlint/cli": "^13.1.0",
-    "@commitlint/config-conventional": "^13.1.0",
-    "@nuxtjs/composition-api": "^0.26.0",
-    "@rollup/plugin-node-resolve": "^13.0.4",
-    "@types/jest": "^26.0.21",
-    "@typescript-eslint/eslint-plugin": "^4.29.2",
-    "@typescript-eslint/parser": "^4.29.2",
-    "@vue/compiler-sfc": "^3.2.4",
-    "@vue/composition-api": "^1.1.1",
+    "@commitlint/cli": "^13.2.1",
+    "@commitlint/config-conventional": "^13.2.0",
+    "@nuxtjs/composition-api": "^0.29.3",
+    "@rollup/plugin-node-resolve": "^13.0.6",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.1.0",
+    "@typescript-eslint/parser": "^5.1.0",
+    "@vue/compiler-sfc": "^3.2.20",
+    "@vue/composition-api": "^1.2.4",
     "@vue/eslint-config-prettier": "^6.0.0",
-    "@vue/eslint-config-typescript": "^7.0.0",
-    "eslint": "^7.32.0",
+    "@vue/eslint-config-typescript": "^8.0.0",
+    "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-vue": "^7.16.0",
-    "husky": "^7.0.1",
-    "jest": "^26.6.3",
-    "prettier": "^2.3.2",
-    "rollup": "^2.56.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-vue": "^7.20.0",
+    "husky": "^7.0.4",
+    "jest": "^27.3.1",
+    "prettier": "^2.4.1",
+    "rollup": "^2.58.0",
     "rollup-plugin-auto-external": "^2.0.0",
     "rollup-plugin-postcss": "^4.0.1",
     "rollup-plugin-typescript2": "^0.30.0",
     "rollup-plugin-vue": "^6.0.0",
-    "ts-jest": "^26.5.4",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.3.5",
-    "vue": "^3.2.4",
-    "vue-jest": "^5.0.0-alpha.10",
+    "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4",
+    "vue": "^3.2.20",
+    "@vue/vue3-jest": "27.0.0-alpha.1",
     "vue2": "npm:vue@2"
   }
 }
diff --git a/src/vue/__mocks__/useQueryClient.ts b/src/vue/__mocks__/useQueryClient.ts
@@ -1,5 +1,9 @@
 import { QueryClient } from "react-query/core";
 
-const queryClient = new QueryClient();
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: { retry: 0, cacheTime: 10 },
+  },
+});
 
 export const useQueryClient = jest.fn(() => queryClient);
diff --git a/src/vue/__tests__/test-utils.ts b/src/vue/__tests__/test-utils.ts
diff --git a/src/vue/__tests__/useInfiniteQuery.test.ts b/src/vue/__tests__/useInfiniteQuery.test.ts
@@ -1,6 +1,6 @@
 import { setLogger } from "react-query/core";
 
-import { noop, infiniteFetcher, flushPromises } from "@/test-utils";
+import { noop, infiniteFetcher, flushPromises } from "./test-utils";
 import { useInfiniteQuery } from "../useInfiniteQuery";
 
 jest.mock("../useQueryClient");
diff --git a/src/vue/__tests__/useIsFetching.test.ts b/src/vue/__tests__/useIsFetching.test.ts
@@ -1,7 +1,7 @@
 import { onUnmounted } from "vue-demi";
 import { setLogger } from "react-query/core";
 
-import { flushPromises, simpleFetcher, noop } from "@/test-utils";
+import { flushPromises, simpleFetcher, noop } from "./test-utils";
 import { useQuery } from "../useQuery";
 import { useIsFetching } from "../useIsFetching";
 
diff --git a/src/vue/__tests__/useIsMutating.test.ts b/src/vue/__tests__/useIsMutating.test.ts
@@ -1,7 +1,7 @@
 import { onUnmounted } from "vue-demi";
 import { setLogger } from "react-query/core";
 
-import { flushPromises, noop, successMutator } from "@/test-utils";
+import { flushPromises, noop, successMutator } from "./test-utils";
 import { useMutation } from "../useMutation";
 import { useIsMutating } from "../useIsMutating";
 import { useQueryClient } from "../useQueryClient";
diff --git a/src/vue/__tests__/useMutation.test.ts b/src/vue/__tests__/useMutation.test.ts
@@ -5,7 +5,7 @@ import {
   flushPromises,
   noop,
   successMutator,
-} from "@/test-utils";
+} from "./test-utils";
 import { useMutation } from "../useMutation";
 
 jest.mock("../useQueryClient");
diff --git a/src/vue/__tests__/useQueries.test.ts b/src/vue/__tests__/useQueries.test.ts
@@ -6,7 +6,7 @@ import {
   rejectFetcher,
   simpleFetcher,
   noop,
-} from "@/test-utils";
+} from "./test-utils";
 import { useQueries } from "../useQueries";
 
 jest.mock("../useQueryClient");
@@ -85,7 +85,6 @@ describe("useQueries", () => {
       {
         queryKey: "key21",
         queryFn: rejectFetcher,
-        retry: false,
       },
       {
         queryKey: "key22",
@@ -170,7 +169,6 @@ describe("useQueries", () => {
       },
     ];
     const queriesState = useQueries(queries);
-
     await flushPromises();
 
     expect(queriesState).toMatchObject([
diff --git a/src/vue/__tests__/useQuery.test.ts b/src/vue/__tests__/useQuery.test.ts
@@ -12,7 +12,7 @@ import {
   rejectFetcher,
   simpleFetcher,
   noop,
-} from "@/test-utils";
+} from "./test-utils";
 import { useQuery } from "../useQuery";
 import { useBaseQuery } from "../useBaseQuery";
 
@@ -68,9 +68,7 @@ describe("useQuery", () => {
   });
 
   test("should reject and update reactive state", async () => {
-    const query = useQuery("key3", rejectFetcher, {
-      retry: false,
-    });
+    const query = useQuery("key3", rejectFetcher);
 
     await flushPromises();
 
diff --git a/src/vue/__tests__/utils.test.ts b/src/vue/__tests__/utils.test.ts
@@ -1,4 +1,4 @@
-import { successMutator, simpleFetcher } from "@/test-utils";
+import { successMutator, simpleFetcher } from "./test-utils";
 import {
   isQueryKey,
   parseFilterArgs,
diff --git a/src/vue/useBaseQuery.ts b/src/vue/useBaseQuery.ts
@@ -7,7 +7,7 @@ import {
   watchEffect,
 } from "vue-demi";
 
-import type { QueryObserver } from "react-query/core";
+import type { QueryObserver, QueryKey } from "react-query/core";
 import type {
   UseBaseQueryOptions as UBQO,
   UseQueryResult,
@@ -21,8 +21,11 @@ export type UseBaseQueryOptions<
   TQueryFnData = unknown,
   TError = unknown,
   TData = TQueryFnData,
-  TQueryData = unknown
-> = WithQueryClientKey<UBQO<TQueryFnData, TError, TData, TQueryData>>;
+  TQueryData = unknown,
+  TQueryKey extends QueryKey = QueryKey
+> = WithQueryClientKey<
+  UBQO<TQueryFnData, TError, TData, TQueryData, TQueryKey>
+>;
 
 export type UseQueryReturnType<
   TData,
@@ -32,8 +35,20 @@ export type UseQueryReturnType<
   suspense: () => Promise<Result>;
 };
 
-export function useBaseQuery<TQueryFnData, TError, TData, TQueryData>(
-  options: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData>,
+export function useBaseQuery<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryData,
+  TQueryKey extends QueryKey
+>(
+  options: UseBaseQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryData,
+    TQueryKey
+  >,
   Observer: typeof QueryObserver
 ): UseQueryReturnType<TData, TError> {
   const queryClient = useQueryClient(options.queryClientKey);
diff --git a/src/vue/useInfiniteQuery.ts b/src/vue/useInfiniteQuery.ts
@@ -8,6 +8,7 @@ import type {
 import type {
   UseInfiniteQueryOptions as UIQO,
   UseInfiniteQueryResult,
+  UseBaseQueryOptions,
 } from "react-query/types/react/types";
 
 import { useBaseQuery, UseQueryReturnType } from "./useBaseQuery";
@@ -18,41 +19,65 @@ import type { WithQueryClientKey } from "./types";
 export type UseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = unknown,
-  TData = TQueryFnData
-> = WithQueryClientKey<UIQO<TQueryFnData, TError, TData>>;
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
+> = WithQueryClientKey<
+  UIQO<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
+>;
 
 export function useInfiniteQuery<
   TQueryFnData = unknown,
   TError = unknown,
-  TData = TQueryFnData
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
 >(
-  options: UseInfiniteQueryOptions<TQueryFnData, TError, TData>
+  options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
 ): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
 export function useInfiniteQuery<
   TQueryFnData = unknown,
   TError = unknown,
-  TData = TQueryFnData
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
 >(
   queryKey: QueryKey,
-  options?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>
+  options?: Omit<
+    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    "queryKey"
+  >
 ): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
 export function useInfiniteQuery<
   TQueryFnData = unknown,
   TError = unknown,
-  TData = TQueryFnData
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
 >(
   queryKey: QueryKey,
-  queryFn: QueryFunction<TQueryFnData>,
-  options?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>
+  queryFn: QueryFunction<TQueryFnData, TQueryKey>,
+  options?: Omit<
+    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    "queryKey" | "queryFn"
+  >
 ): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
-export function useInfiniteQuery<TQueryFnData, TError, TData = TQueryFnData>(
-  arg1: QueryKey | UseInfiniteQueryOptions<TQueryFnData, TError, TData>,
+export function useInfiniteQuery<
+  TQueryFnData,
+  TError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
+>(
+  arg1:
+    | TQueryKey
+    | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
   arg2?:
-    | QueryFunction<TQueryFnData>
-    | UseInfiniteQueryOptions<TQueryFnData, TError, TData>,
-  arg3?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>
+    | QueryFunction<TQueryFnData, TQueryKey>
+    | UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+  arg3?: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
 ): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>> {
-  const parsedOptions = parseQueryArgs(arg1, arg2, arg3);
+  const parsedOptions = parseQueryArgs(arg1, arg2, arg3) as UseBaseQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryKey
+  >;
   return useBaseQuery(
     parsedOptions,
     InfiniteQueryObserver as typeof QueryObserver
diff --git a/src/vue/useMutation.ts b/src/vue/useMutation.ts
@@ -55,7 +55,10 @@ export function useMutation<
   TContext = unknown
 >(
   mutationFn: MutationFunction<TData, TVariables>,
-  options?: UseMutationOptions<TData, TError, TVariables, TContext>
+  options?: Omit<
+    UseMutationOptions<TData, TError, TVariables, TContext>,
+    "mutationFn"
+  >
 ): UseMutationReturnType<TData, TError, TVariables, TContext>;
 export function useMutation<
   TData = unknown,
@@ -64,7 +67,10 @@ export function useMutation<
   TContext = unknown
 >(
   mutationKey: MutationKey,
-  options?: UseMutationOptions<TData, TError, TVariables, TContext>
+  options?: Omit<
+    UseMutationOptions<TData, TError, TVariables, TContext>,
+    "mutationKey"
+  >
 ): UseMutationReturnType<TData, TError, TVariables, TContext>;
 export function useMutation<
   TData = unknown,
@@ -74,7 +80,10 @@ export function useMutation<
 >(
   mutationKey: MutationKey,
   mutationFn?: MutationFunction<TData, TVariables>,
-  options?: UseMutationOptions<TData, TError, TVariables, TContext>
+  options?: Omit<
+    UseMutationOptions<TData, TError, TVariables, TContext>,
+    "mutationKey" | "mutationFn"
+  >
 ): UseMutationReturnType<TData, TError, TVariables, TContext>;
 export function useMutation<
   TData = unknown,
diff --git a/src/vue/useQuery.ts b/src/vue/useQuery.ts
diff --git a/src/vue/utils.ts b/src/vue/utils.ts
diff --git a/types/broadcastQueryClient-experimental/index.d.ts b/types/broadcastQueryClient-experimental/index.d.ts
diff --git a/types/createWebStoragePersistor-experimental/index.d.ts b/types/createWebStoragePersistor-experimental/index.d.ts
diff --git a/types/index.d.ts b/types/index.d.ts
diff --git a/types/persistQueryClient-experimental/index.d.ts b/types/persistQueryClient-experimental/index.d.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-module.exports = {extends: ['@commitlint/config-conventional']}`
	`1`	`+module.exports = { extends: ["@commitlint/config-conventional"] };`