@tanstack/svelte-query 4.22.2 → 4.22.4

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.
Files changed (7) hide show
  1. package/build/lib/createMutation.d.ts +4 -4
  2. package/build/lib/types.d.ts +6 -6
  3. package/package.json +4 -4
  4. package/src/__tests__/CreateMutation.svelte +5 -3
  5. package/src/__tests__/createMutation.test.ts +3 -3
  6. package/src/createMutation.ts +7 -7
  7. package/src/types.ts +8 -6
package/build/lib/createMutation.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { type MutationFunction, type MutationKey } from '@tanstack/query-core';
2
2
  import type { CreateMutationOptions, CreateMutationResult } from './types';
3
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>): CreateMutationResult<TData, TError, TVariables, TContext>;
4
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
5
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationKey: MutationKey, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): CreateMutationResult<TData, TError, TVariables, TContext>;
6
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
3
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>): CreateMutationResult<TData, TError, TVariables, TContext>;
4
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
5
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): CreateMutationResult<TData, TError, TVariables, TContext>;
6
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
package/build/lib/types.d.ts CHANGED
@@ -22,14 +22,14 @@ export declare type DefinedCreateBaseQueryResult<TData = unknown, TError = unkno
22
22
  export declare type DefinedCreateQueryResult<TData = unknown, TError = unknown> = DefinedCreateBaseQueryResult<TData, TError>;
23
23
  export interface CreateMutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends ContextOptions, Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'> {
24
24
  }
25
- export declare type UseMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
26
- export declare type UseMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
27
- export declare type UseBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
28
- mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
25
+ export declare type CreateMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
26
+ export declare type CreateMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
27
+ export declare type CreateBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
28
+ mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
29
29
  }> & {
30
- mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
30
+ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
31
31
  };
32
- export interface CreateMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> extends Readable<UseBaseMutationResult<TData, TError, TVariables, TContext>> {
32
+ export interface CreateMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> extends Readable<CreateBaseMutationResult<TData, TError, TVariables, TContext>> {
33
33
  }
34
34
  declare type Override<A, B> = {
35
35
  [K in keyof A]: K extends keyof B ? B[K] : A[K];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/svelte-query",
3
- "version": "4.22.2",
3
+ "version": "4.22.4",
4
4
  "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
5
5
  "author": "Dre Johnson",
6
6
  "license": "MIT",
@@ -17,7 +17,7 @@
17
17
  "@sveltejs/package": "^1.0.0",
18
18
  "@sveltejs/vite-plugin-svelte": "^2.0.2",
19
19
  "@testing-library/svelte": "^3.2.2",
20
- "@vitest/coverage-istanbul": "^0.26.3",
20
+ "@vitest/coverage-istanbul": "^0.27.1",
21
21
  "eslint-plugin-svelte": "^2.14.1",
22
22
  "jsdom": "^20.0.3",
23
23
  "svelte": "^3.54.0",
@@ -25,10 +25,10 @@
25
25
  "tslib": "^2.4.1",
26
26
  "typescript": "^4.7.4",
27
27
  "vite": "^4.0.0",
28
- "vitest": "^0.26.3"
28
+ "vitest": "^0.27.1"
29
29
  },
30
30
  "dependencies": {
31
- "@tanstack/query-core": "4.22.0"
31
+ "@tanstack/query-core": "4.22.4"
32
32
  },
33
33
  "peerDependencies": {
34
34
  "svelte": "^3.54.0"
package/src/__tests__/CreateMutation.svelte CHANGED
@@ -2,12 +2,14 @@
2
2
  import { createMutation, QueryClient } from '../index'
3
3
  import { setQueryClientContext } from '../context'
4
4
 
5
- export let queryFn: () => Promise<string>
5
+ export let mutationFn: () => Promise<string>
6
6
 
7
7
  const queryClient = new QueryClient()
8
8
  setQueryClientContext(queryClient)
9
9
 
10
- const mutation = createMutation(queryFn)
10
+ const mutation = createMutation({
11
+ mutationFn,
12
+ })
11
13
  </script>
12
14
 
13
- <button on:click={$mutation.mutate}>Click</button>
15
+ <button on:click={() => $mutation.mutate()}>Click</button>
package/src/__tests__/createMutation.test.ts CHANGED
@@ -5,11 +5,11 @@ import { sleep } from './utils'
5
5
 
6
6
  describe('createMutation', () => {
7
7
  it('Call mutate and check function runs', async () => {
8
- const queryFn = vi.fn()
8
+ const mutationFn = vi.fn()
9
9
 
10
10
  render(CreateMutation, {
11
11
  props: {
12
- queryFn,
12
+ mutationFn,
13
13
  },
14
14
  })
15
15
 
@@ -17,6 +17,6 @@ describe('createMutation', () => {
17
17
 
18
18
  await sleep(200)
19
19
 
20
- expect(queryFn).toHaveBeenCalledTimes(1)
20
+ expect(mutationFn).toHaveBeenCalledTimes(1)
21
21
  })
22
22
  })
package/src/createMutation.ts CHANGED
@@ -7,7 +7,7 @@ import {
7
7
  parseMutationArgs,
8
8
  } from '@tanstack/query-core'
9
9
  import type {
10
- UseMutateFunction,
10
+ CreateMutateFunction,
11
11
  CreateMutationOptions,
12
12
  CreateMutationResult,
13
13
  } from './types'
@@ -16,7 +16,7 @@ import { useQueryClient } from './useQueryClient'
16
16
  export function createMutation<
17
17
  TData = unknown,
18
18
  TError = unknown,
19
- TVariables = unknown,
19
+ TVariables = void,
20
20
  TContext = unknown,
21
21
  >(
22
22
  options: CreateMutationOptions<TData, TError, TVariables, TContext>,
@@ -25,7 +25,7 @@ export function createMutation<
25
25
  export function createMutation<
26
26
  TData = unknown,
27
27
  TError = unknown,
28
- TVariables = unknown,
28
+ TVariables = void,
29
29
  TContext = unknown,
30
30
  >(
31
31
  mutationFn: MutationFunction<TData, TVariables>,
@@ -38,7 +38,7 @@ export function createMutation<
38
38
  export function createMutation<
39
39
  TData = unknown,
40
40
  TError = unknown,
41
- TVariables = unknown,
41
+ TVariables = void,
42
42
  TContext = unknown,
43
43
  >(
44
44
  mutationKey: MutationKey,
@@ -51,7 +51,7 @@ export function createMutation<
51
51
  export function createMutation<
52
52
  TData = unknown,
53
53
  TError = unknown,
54
- TVariables = unknown,
54
+ TVariables = void,
55
55
  TContext = unknown,
56
56
  >(
57
57
  mutationKey: MutationKey,
@@ -65,7 +65,7 @@ export function createMutation<
65
65
  export function createMutation<
66
66
  TData = unknown,
67
67
  TError = unknown,
68
- TVariables = unknown,
68
+ TVariables = void,
69
69
  TContext = unknown,
70
70
  >(
71
71
  arg1:
@@ -83,7 +83,7 @@ export function createMutation<
83
83
  queryClient,
84
84
  options,
85
85
  )
86
- let mutate: UseMutateFunction<TData, TError, TVariables, TContext>
86
+ let mutate: CreateMutateFunction<TData, TError, TVariables, TContext>
87
87
 
88
88
  readable(observer).subscribe(($observer) => {
89
89
  observer = $observer
package/src/types.ts CHANGED
@@ -87,7 +87,7 @@ export interface CreateMutationOptions<
87
87
  '_defaulted' | 'variables'
88
88
  > {}
89
89
 
90
- export type UseMutateFunction<
90
+ export type CreateMutateFunction<
91
91
  TData = unknown,
92
92
  TError = unknown,
93
93
  TVariables = void,
@@ -96,22 +96,24 @@ export type UseMutateFunction<
96
96
  ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
97
97
  ) => void
98
98
 
99
- export type UseMutateAsyncFunction<
99
+ export type CreateMutateAsyncFunction<
100
100
  TData = unknown,
101
101
  TError = unknown,
102
102
  TVariables = void,
103
103
  TContext = unknown,
104
104
  > = MutateFunction<TData, TError, TVariables, TContext>
105
105
 
106
- export type UseBaseMutationResult<
106
+ export type CreateBaseMutationResult<
107
107
  TData = unknown,
108
108
  TError = unknown,
109
109
  TVariables = unknown,
110
110
  TContext = unknown,
111
111
  > = Override<
112
112
  MutationObserverResult<TData, TError, TVariables, TContext>,
113
- { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
114
- > & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
113
+ { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
114
+ > & {
115
+ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
116
+ }
115
117
 
116
118
  export interface CreateMutationResult<
117
119
  TData = unknown,
@@ -119,7 +121,7 @@ export interface CreateMutationResult<
119
121
  TVariables = unknown,
120
122
  TContext = unknown,
121
123
  > extends Readable<
122
- UseBaseMutationResult<TData, TError, TVariables, TContext>
124
+ CreateBaseMutationResult<TData, TError, TVariables, TContext>
123
125
  > {}
124
126
 
125
127
  type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }