Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"homepage": "https://github.com/DamianOsipiuk/vue-query#readme",
"dependencies": {
"match-sorter": "^6.3.1",
"react-query": "^3.30.0",
"react-query": "^3.34.5",
"vue-demi": "^0.10.1"
},
"peerDependencies": {
Expand Down
13 changes: 7 additions & 6 deletions src/vue/useBaseQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ import {
watchEffect,
} from "vue-demi";

import type { QueryObserver, QueryKey } from "react-query/core";
import type {
UseBaseQueryOptions as UBQO,
UseQueryResult,
} from "react-query/types/react/types";
QueryObserver,
QueryKey,
QueryObserverOptions,
QueryObserverResult,
} from "react-query/core";

import { useQueryClient } from "./useQueryClient";
import { updateState } from "./utils";
Expand All @@ -24,13 +25,13 @@ export type UseBaseQueryOptions<
TQueryData = unknown,
TQueryKey extends QueryKey = QueryKey
> = WithQueryClientKey<
UBQO<TQueryFnData, TError, TData, TQueryData, TQueryKey>
QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
>;

export type UseQueryReturnType<
TData,
TError,
Result = UseQueryResult<TData, TError>
Result = QueryObserverResult<TData, TError>
> = ToRefs<Readonly<Result>> & {
suspense: () => Promise<Result>;
};
Expand Down
57 changes: 40 additions & 17 deletions src/vue/useInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ import type {
QueryObserver,
QueryFunction,
QueryKey,
QueryObserverOptions,
InfiniteQueryObserverOptions,
InfiniteQueryObserverResult,
} from "react-query/types/core";
import type {
UseInfiniteQueryOptions as UIQO,
UseInfiniteQueryResult,
UseBaseQueryOptions,
} from "react-query/types/react/types";

import { useBaseQuery, UseQueryReturnType } from "./useBaseQuery";
import { parseQueryArgs } from "./utils";
Expand All @@ -22,7 +20,13 @@ export type UseInfiniteQueryOptions<
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> = WithQueryClientKey<
UIQO<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
TQueryKey
>
>;

export function useInfiniteQuery<
Expand All @@ -32,7 +36,11 @@ export function useInfiniteQuery<
TQueryKey extends QueryKey = QueryKey
>(
options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>
): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
): UseQueryReturnType<
TData,
TError,
InfiniteQueryObserverResult<TData, TError>
>;
export function useInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -44,7 +52,11 @@ export function useInfiniteQuery<
UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
"queryKey"
>
): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
): UseQueryReturnType<
TData,
TError,
InfiniteQueryObserverResult<TData, TError>
>;
export function useInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -57,7 +69,11 @@ export function useInfiniteQuery<
UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
"queryKey" | "queryFn"
>
): UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
): UseQueryReturnType<
TData,
TError,
InfiniteQueryObserverResult<TData, TError>
>;
export function useInfiniteQuery<
TQueryFnData,
TError,
Expand All @@ -71,15 +87,22 @@ export function useInfiniteQuery<
| 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) as UseBaseQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>;
): UseQueryReturnType<
TData,
TError,
InfiniteQueryObserverResult<TData, TError>
> {
const parsedOptions = parseQueryArgs(
arg1,
arg2,
arg3
) as QueryObserverOptions<TQueryFnData, TError, TData, TQueryKey>;
return useBaseQuery(
parsedOptions,
InfiniteQueryObserver as typeof QueryObserver
) as UseQueryReturnType<TData, TError, UseInfiniteQueryResult<TData, TError>>;
) as UseQueryReturnType<
TData,
TError,
InfiniteQueryObserverResult<TData, TError>
>;
}
29 changes: 20 additions & 9 deletions src/vue/useMutation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ import {
MutationObserver,
MutationObserverResult,
} from "react-query/core";
import { MutationFunction, MutationKey } from "react-query/types/core";
import type {
UseMutationOptions as UMO,
UseMutateFunction,
UseMutateAsyncFunction,
} from "react-query/types/react/types";
import {
MutationFunction,
MutationKey,
MutationObserverOptions,
MutateFunction,
} from "react-query/types/core";
import { parseMutationArgs, updateState } from "./utils";
import { useQueryClient } from "./useQueryClient";
import { WithQueryClientKey } from "./types";
Expand All @@ -27,7 +27,18 @@ type MutationResult<TData, TError, TVariables, TContext> = Omit<
>;

export type UseMutationOptions<TData, TError, TVariables, TContext> =
WithQueryClientKey<UMO<TData, TError, TVariables, TContext>>;
WithQueryClientKey<
MutationObserverOptions<TData, TError, TVariables, TContext>
>;

type MutateSyncFunction<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown
> = (
...options: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
) => void;

export type UseMutationReturnType<
TData,
Expand All @@ -36,8 +47,8 @@ export type UseMutationReturnType<
TContext,
Result = MutationResult<TData, TError, TVariables, TContext>
> = ToRefs<Readonly<Result>> & {
mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
mutate: MutateSyncFunction<TData, TError, TVariables, TContext>;
mutateAsync: MutateFunction<TData, TError, TVariables, TContext>;
};

export function useMutation<
Expand Down
30 changes: 16 additions & 14 deletions src/vue/useQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
import { QueriesObserver } from "react-query/core";
import { onUnmounted, reactive, readonly, set, watch } from "vue-demi";

import type { QueryFunction } from "react-query/types/core";
import type { UseQueryResult } from "react-query/types/react/types";
import type {
QueryFunction,
QueryObserverResult,
} from "react-query/types/core";

import { useQueryClient } from "./useQueryClient";
import { UseQueryOptions } from "./useQuery";
Expand Down Expand Up @@ -44,28 +46,28 @@ type GetOptions<T> =
type GetResults<T> =
// Part 1: responsible for mapping explicit type parameter to function result, if object
T extends { queryFnData: any; error?: infer TError; data: infer TData }
? UseQueryResult<TData, TError>
? QueryObserverResult<TData, TError>
: T extends { queryFnData: infer TQueryFnData; error?: infer TError }
? UseQueryResult<TQueryFnData, TError>
? QueryObserverResult<TQueryFnData, TError>
: T extends { data: infer TData; error?: infer TError }
? UseQueryResult<TData, TError>
? QueryObserverResult<TData, TError>
: // Part 2: responsible for mapping explicit type parameter to function result, if tuple
T extends [any, infer TError, infer TData]
? UseQueryResult<TData, TError>
? QueryObserverResult<TData, TError>
: T extends [infer TQueryFnData, infer TError]
? UseQueryResult<TQueryFnData, TError>
? QueryObserverResult<TQueryFnData, TError>
: T extends [infer TQueryFnData]
? UseQueryResult<TQueryFnData>
? QueryObserverResult<TQueryFnData>
: // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
T extends {
queryFn?: QueryFunction<any>;
select: (data: any) => infer TData;
}
? UseQueryResult<TData>
? QueryObserverResult<TData>
: T extends { queryFn?: QueryFunction<infer TQueryFnData> }
? UseQueryResult<TQueryFnData>
? QueryObserverResult<TQueryFnData>
: // Fallback
UseQueryResult;
QueryObserverResult;

/**
* QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
Expand Down Expand Up @@ -99,7 +101,7 @@ type QueriesResults<
Result extends any[] = [],
Depth extends ReadonlyArray<number> = []
> = Depth["length"] extends MAXIMUM_DEPTH
? UseQueryResult[]
? QueryObserverResult[]
: T extends []
? []
: T extends [infer Head]
Expand All @@ -108,9 +110,9 @@ type QueriesResults<
? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>
: T extends UseQueryOptions<infer TQueryFnData, infer TError, infer TData>[]
? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
UseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>[]
QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[]
: // Fallback
UseQueryResult[];
QueryObserverResult[];

export function useQueries<T extends any[]>(
queries: readonly [...QueriesOptions<T>]
Expand Down
19 changes: 13 additions & 6 deletions src/vue/useQuery.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { QueryObserver } from "react-query/core";

import type { QueryFunction, QueryKey } from "react-query/types/core";
import type {
UseQueryOptions as UQO,
UseBaseQueryOptions,
} from "react-query/types/react/types";
QueryFunction,
QueryKey,
QueryObserverOptions,
} from "react-query/types/core";

import { useBaseQuery, UseQueryReturnType } from "./useBaseQuery";
import { parseQueryArgs } from "./utils";
Expand All @@ -16,7 +16,9 @@ export type UseQueryOptions<
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> = WithQueryClientKey<UQO<TQueryFnData, TError, TData, TQueryKey>>;
> = WithQueryClientKey<
QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
>;

export function useQuery<
TQueryFnData = unknown,
Expand Down Expand Up @@ -63,10 +65,15 @@ export function useQuery<
| UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
arg3?: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
): UseQueryReturnType<TData, TError> {
const parsedOptions = parseQueryArgs(arg1, arg2, arg3) as UseBaseQueryOptions<
const parsedOptions = parseQueryArgs(
arg1,
arg2,
arg3
) as QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
TQueryKey
>;
return useBaseQuery(parsedOptions, QueryObserver);
Expand Down
10 changes: 8 additions & 2 deletions src/vue/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import type {
MutationOptions,
QueryFunction,
QueryKey,
QueryObserverOptions,
} from "react-query/types/core";
import type { UseBaseQueryOptions } from "react-query/types/react/types";
import { QueryFilters } from "./useIsFetching";
import { MutationFilters } from "./useIsMutating";

Expand All @@ -19,7 +19,13 @@ export function parseQueryArgs<
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions = UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
TOptions = QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
TQueryKey
>
>(
arg1: QueryKey | TOptions,
arg2: QueryFunction<TQueryFnData, TQueryKey> | TOptions = {} as TOptions,
Expand Down