@tanstack/svelte-query 5.0.0-alpha.37 → 5.0.0-alpha.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/lib/HydrationBoundary.svelte.d.ts +3 -3
- package/build/lib/QueryClientProvider.svelte.d.ts +3 -3
- package/build/lib/__tests__/CreateMutation.svelte.d.ts +3 -3
- package/build/lib/__tests__/CreateQueries.svelte.d.ts +3 -3
- package/build/lib/__tests__/CreateQuery.svelte.d.ts +3 -3
- package/build/lib/__tests__/utils.d.ts +2 -2
- package/build/lib/createQueries.d.ts +6 -6
- package/build/lib/createQuery.d.ts +2 -2
- package/build/lib/types.d.ts +15 -15
- package/package.json +9 -9
|
@@ -13,9 +13,9 @@ declare const __propDef: {
|
|
|
13
13
|
default: {};
|
|
14
14
|
};
|
|
15
15
|
};
|
|
16
|
-
export
|
|
17
|
-
export
|
|
18
|
-
export
|
|
16
|
+
export type HydrationBoundaryProps = typeof __propDef.props;
|
|
17
|
+
export type HydrationBoundaryEvents = typeof __propDef.events;
|
|
18
|
+
export type HydrationBoundarySlots = typeof __propDef.slots;
|
|
19
19
|
export default class HydrationBoundary extends SvelteComponentTyped<HydrationBoundaryProps, HydrationBoundaryEvents, HydrationBoundarySlots> {
|
|
20
20
|
}
|
|
21
21
|
export {};
|
|
@@ -11,9 +11,9 @@ declare const __propDef: {
|
|
|
11
11
|
default: {};
|
|
12
12
|
};
|
|
13
13
|
};
|
|
14
|
-
export
|
|
15
|
-
export
|
|
16
|
-
export
|
|
14
|
+
export type QueryClientProviderProps = typeof __propDef.props;
|
|
15
|
+
export type QueryClientProviderEvents = typeof __propDef.events;
|
|
16
|
+
export type QueryClientProviderSlots = typeof __propDef.slots;
|
|
17
17
|
export default class QueryClientProvider extends SvelteComponentTyped<QueryClientProviderProps, QueryClientProviderEvents, QueryClientProviderSlots> {
|
|
18
18
|
}
|
|
19
19
|
export {};
|
|
@@ -9,9 +9,9 @@ declare const __propDef: {
|
|
|
9
9
|
};
|
|
10
10
|
slots: {};
|
|
11
11
|
};
|
|
12
|
-
export
|
|
13
|
-
export
|
|
14
|
-
export
|
|
12
|
+
export type CreateMutationProps = typeof __propDef.props;
|
|
13
|
+
export type CreateMutationEvents = typeof __propDef.events;
|
|
14
|
+
export type CreateMutationSlots = typeof __propDef.slots;
|
|
15
15
|
export default class CreateMutation extends SvelteComponentTyped<CreateMutationProps, CreateMutationEvents, CreateMutationSlots> {
|
|
16
16
|
}
|
|
17
17
|
export {};
|
|
@@ -11,9 +11,9 @@ declare const __propDef: {
|
|
|
11
11
|
};
|
|
12
12
|
slots: {};
|
|
13
13
|
};
|
|
14
|
-
export
|
|
15
|
-
export
|
|
16
|
-
export
|
|
14
|
+
export type CreateQueriesProps = typeof __propDef.props;
|
|
15
|
+
export type CreateQueriesEvents = typeof __propDef.events;
|
|
16
|
+
export type CreateQueriesSlots = typeof __propDef.slots;
|
|
17
17
|
export default class CreateQueries extends SvelteComponentTyped<CreateQueriesProps, CreateQueriesEvents, CreateQueriesSlots> {
|
|
18
18
|
}
|
|
19
19
|
export {};
|
|
@@ -9,9 +9,9 @@ declare const __propDef: {
|
|
|
9
9
|
};
|
|
10
10
|
slots: {};
|
|
11
11
|
};
|
|
12
|
-
export
|
|
13
|
-
export
|
|
14
|
-
export
|
|
12
|
+
export type CreateQueryProps = typeof __propDef.props;
|
|
13
|
+
export type CreateQueryEvents = typeof __propDef.events;
|
|
14
|
+
export type CreateQuerySlots = typeof __propDef.slots;
|
|
15
15
|
export default class CreateQuery extends SvelteComponentTyped<CreateQueryProps, CreateQueryEvents, CreateQuerySlots> {
|
|
16
16
|
}
|
|
17
17
|
export {};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { QueryClient, type QueryClientConfig } from '../index';
|
|
3
3
|
export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
|
|
4
|
-
export declare function mockVisibilityState(value: DocumentVisibilityState): import("vitest/dist/index-
|
|
5
|
-
export declare function mockNavigatorOnLine(value: boolean): import("vitest/dist/index-
|
|
4
|
+
export declare function mockVisibilityState(value: DocumentVisibilityState): import("vitest/dist/index-2dd51af4").S<[], DocumentVisibilityState>;
|
|
5
|
+
export declare function mockNavigatorOnLine(value: boolean): import("vitest/dist/index-2dd51af4").S<[], boolean>;
|
|
6
6
|
export declare function queryKey(): Array<string>;
|
|
7
7
|
export declare function sleep(timeout: number): Promise<void>;
|
|
8
8
|
export declare function simplefetcher(): Promise<string>;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { QueryKey, QueryFunction, QueryClient, QueriesPlaceholderDataFunction, QueryObserverResult, DefaultError, QueryObserverOptions } from '@tanstack/query-core';
|
|
2
2
|
import { type Readable } from 'svelte/store';
|
|
3
3
|
import type { WritableOrVal } from './types';
|
|
4
|
-
|
|
4
|
+
type QueryObserverOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'placeholderData'> & {
|
|
5
5
|
placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
|
|
6
6
|
};
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
type MAXIMUM_DEPTH = 20;
|
|
8
|
+
type GetOptions<T> = T extends {
|
|
9
9
|
queryFnData: infer TQueryFnData;
|
|
10
10
|
error?: infer TError;
|
|
11
11
|
data: infer TData;
|
|
@@ -21,7 +21,7 @@ declare type GetOptions<T> = T extends {
|
|
|
21
21
|
} ? QueryObserverOptionsForCreateQueries<TQueryFnData, Error, TData, TQueryKey> : T extends {
|
|
22
22
|
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
23
23
|
} ? QueryObserverOptionsForCreateQueries<TQueryFnData, Error, TQueryFnData, TQueryKey> : QueryObserverOptionsForCreateQueries;
|
|
24
|
-
|
|
24
|
+
type GetResults<T> = T extends {
|
|
25
25
|
queryFnData: any;
|
|
26
26
|
error?: infer TError;
|
|
27
27
|
data: infer TData;
|
|
@@ -40,11 +40,11 @@ declare type GetResults<T> = T extends {
|
|
|
40
40
|
/**
|
|
41
41
|
* QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
42
42
|
*/
|
|
43
|
-
export
|
|
43
|
+
export type QueriesOptions<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries[];
|
|
44
44
|
/**
|
|
45
45
|
* QueriesResults reducer recursively maps type param to results
|
|
46
46
|
*/
|
|
47
|
-
export
|
|
47
|
+
export type QueriesResults<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends QueryObserverOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, any>[] ? QueryObserverResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError>[] : QueryObserverResult[];
|
|
48
48
|
export declare function createQueries<T extends any[], TCombinedResult = QueriesResults<T>>({ queries, ...options }: {
|
|
49
49
|
queries: WritableOrVal<[...QueriesOptions<T>]>;
|
|
50
50
|
combine?: (result: QueriesResults<T>) => TCombinedResult;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { QueryKey, QueryClient, DefaultError } from '@tanstack/query-core';
|
|
2
2
|
import type { DefinedCreateQueryResult, CreateQueryOptions, CreateQueryResult } from './types';
|
|
3
|
-
|
|
3
|
+
type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
4
4
|
initialData?: undefined;
|
|
5
5
|
};
|
|
6
|
-
|
|
6
|
+
type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
7
7
|
initialData: TQueryFnData | (() => TQueryFnData);
|
|
8
8
|
};
|
|
9
9
|
export declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): CreateQueryResult<TData, TError>;
|
package/build/lib/types.d.ts
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
import type { InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutationObserverResult, QueryObserverOptions, QueryObserverResult, QueryKey, MutationObserverOptions, MutateFunction, DefinedQueryObserverResult, DefaultError } from '@tanstack/query-core';
|
|
2
2
|
import type { Readable, Writable } from 'svelte/store';
|
|
3
3
|
/** Allows a type to be either the base object or a store of that object */
|
|
4
|
-
export
|
|
4
|
+
export type WritableOrVal<T> = T | Writable<T>;
|
|
5
5
|
/** Options for createBaseQuery */
|
|
6
|
-
export
|
|
6
|
+
export type CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WritableOrVal<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>;
|
|
7
7
|
/** Result from createBaseQuery */
|
|
8
|
-
export
|
|
8
|
+
export type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = Readable<QueryObserverResult<TData, TError>>;
|
|
9
9
|
/** Options for createQuery */
|
|
10
|
-
export
|
|
10
|
+
export type CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>;
|
|
11
11
|
/** Result from createQuery */
|
|
12
|
-
export
|
|
12
|
+
export type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
|
|
13
13
|
/** Options for createInfiniteQuery */
|
|
14
|
-
export
|
|
14
|
+
export type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = WritableOrVal<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>>;
|
|
15
15
|
/** Result from createInfiniteQuery */
|
|
16
|
-
export
|
|
16
|
+
export type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = Readable<InfiniteQueryObserverResult<TData, TError>>;
|
|
17
17
|
/** Options for createBaseQuery with initialData */
|
|
18
|
-
export
|
|
18
|
+
export type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError> = Readable<DefinedQueryObserverResult<TData, TError>>;
|
|
19
19
|
/** Options for createQuery with initialData */
|
|
20
|
-
export
|
|
20
|
+
export type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
|
|
21
21
|
/** Options for createMutation */
|
|
22
|
-
export
|
|
23
|
-
export
|
|
24
|
-
export
|
|
25
|
-
export
|
|
22
|
+
export type CreateMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = WritableOrVal<Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'>>;
|
|
23
|
+
export type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
|
|
24
|
+
export type CreateMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
|
|
25
|
+
export type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
|
|
26
26
|
mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
|
|
27
27
|
}> & {
|
|
28
28
|
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
|
|
29
29
|
};
|
|
30
30
|
/** Result from createMutation */
|
|
31
|
-
export
|
|
32
|
-
|
|
31
|
+
export type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Readable<CreateBaseMutationResult<TData, TError, TVariables, TContext>>;
|
|
32
|
+
type Override<A, B> = {
|
|
33
33
|
[K in keyof A]: K extends keyof B ? B[K] : A[K];
|
|
34
34
|
};
|
|
35
35
|
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/svelte-query",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.38",
|
|
4
4
|
"description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
|
|
5
5
|
"author": "Lachlan Collins",
|
|
6
6
|
"license": "MIT",
|
|
@@ -31,18 +31,18 @@
|
|
|
31
31
|
],
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@sveltejs/package": "^2.0.2",
|
|
34
|
-
"@sveltejs/vite-plugin-svelte": "^2.0
|
|
34
|
+
"@sveltejs/vite-plugin-svelte": "^2.3.0",
|
|
35
35
|
"@testing-library/svelte": "^3.2.2",
|
|
36
|
-
"eslint-plugin-svelte": "^2.
|
|
37
|
-
"jsdom": "^
|
|
36
|
+
"eslint-plugin-svelte": "^2.29.0",
|
|
37
|
+
"jsdom": "^22.0.0",
|
|
38
38
|
"svelte": "^3.54.0",
|
|
39
|
-
"svelte-check": "^
|
|
40
|
-
"tslib": "^2.
|
|
41
|
-
"typescript": "^
|
|
42
|
-
"vite": "^4.
|
|
39
|
+
"svelte-check": "^3.3.2",
|
|
40
|
+
"tslib": "^2.5.0",
|
|
41
|
+
"typescript": "^5.0.4",
|
|
42
|
+
"vite": "^4.2.0"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@tanstack/query-core": "5.0.0-alpha.
|
|
45
|
+
"@tanstack/query-core": "5.0.0-alpha.38"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
48
|
"svelte": "^3.54.0"
|