@tanstack/vue-query 5.17.11 → 5.17.12

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 (11) hide show
  1. package/build/legacy/queryOptions.cjs.map +1 -1
  2. package/build/legacy/queryOptions.d.cts +2 -2
  3. package/build/legacy/queryOptions.d.ts +2 -2
  4. package/build/legacy/queryOptions.js.map +1 -1
  5. package/build/modern/queryOptions.cjs.map +1 -1
  6. package/build/modern/queryOptions.d.cts +2 -2
  7. package/build/modern/queryOptions.d.ts +2 -2
  8. package/build/modern/queryOptions.js.map +1 -1
  9. package/package.json +1 -1
  10. package/src/__tests__/queryOptions.types.test.ts +14 -0
  11. package/src/queryOptions.ts +2 -2
package/build/legacy/queryOptions.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
package/build/legacy/queryOptions.d.cts CHANGED
@@ -5,10 +5,10 @@ import './queryClient.cjs';
5
5
  import './types.cjs';
6
6
 
7
7
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
8
- queryKey: DataTag<TQueryKey, TData>;
8
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
9
9
  };
10
10
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11
- queryKey: DataTag<TQueryKey, TData>;
11
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
12
12
  };
13
13
 
14
14
  export { queryOptions };
package/build/legacy/queryOptions.d.ts CHANGED
@@ -5,10 +5,10 @@ import './queryClient.js';
5
5
  import './types.js';
6
6
 
7
7
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
8
- queryKey: DataTag<TQueryKey, TData>;
8
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
9
9
  };
10
10
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11
- queryKey: DataTag<TQueryKey, TData>;
11
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
12
12
  };
13
13
 
14
14
  export { queryOptions };
package/build/legacy/queryOptions.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
package/build/modern/queryOptions.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
package/build/modern/queryOptions.d.cts CHANGED
@@ -5,10 +5,10 @@ import './queryClient.cjs';
5
5
  import './types.cjs';
6
6
 
7
7
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
8
- queryKey: DataTag<TQueryKey, TData>;
8
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
9
9
  };
10
10
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11
- queryKey: DataTag<TQueryKey, TData>;
11
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
12
12
  };
13
13
 
14
14
  export { queryOptions };
package/build/modern/queryOptions.d.ts CHANGED
@@ -5,10 +5,10 @@ import './queryClient.js';
5
5
  import './types.js';
6
6
 
7
7
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
8
- queryKey: DataTag<TQueryKey, TData>;
8
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
9
9
  };
10
10
  declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11
- queryKey: DataTag<TQueryKey, TData>;
11
+ queryKey: DataTag<TQueryKey, TQueryFnData>;
12
12
  };
13
13
 
14
14
  export { queryOptions };
package/build/modern/queryOptions.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/queryOptions.ts"],"sourcesContent":["import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'\nimport type {\n DefinedInitialQueryOptions,\n UndefinedInitialQueryOptions,\n} from './useQuery'\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = DefaultError,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n queryKey: DataTag<TQueryKey, TQueryFnData>\n}\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";AA4BO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/vue-query",
3
- "version": "5.17.11",
3
+ "version": "5.17.12",
4
4
  "description": "Hooks for managing, caching and syncing asynchronous and remote data in Vue",
5
5
  "author": "Damian Osipiuk",
6
6
  "license": "MIT",
package/src/__tests__/queryOptions.types.test.ts CHANGED
@@ -83,6 +83,20 @@ describe('queryOptions', () => {
83
83
  return result
84
84
  })
85
85
  })
86
+ it('should tag the queryKey with the result type of the QueryFn if select is used', () => {
87
+ doNotExecute(() => {
88
+ const { queryKey } = queryOptions({
89
+ queryKey: ['key'],
90
+ queryFn: () => Promise.resolve(5),
91
+ select: (data) => data.toString(),
92
+ })
93
+
94
+ const result: Expect<
95
+ Equal<(typeof queryKey)[typeof dataTagSymbol], number>
96
+ > = true
97
+ return result
98
+ })
99
+ })
86
100
  it('should return the proper type when passed to getQueryData', () => {
87
101
  doNotExecute(() => {
88
102
  const { queryKey } = queryOptions({
package/src/queryOptions.ts CHANGED
@@ -12,7 +12,7 @@ export function queryOptions<
12
12
  >(
13
13
  options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
14
14
  ): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
15
- queryKey: DataTag<TQueryKey, TData>
15
+ queryKey: DataTag<TQueryKey, TQueryFnData>
16
16
  }
17
17
 
18
18
  export function queryOptions<
@@ -23,7 +23,7 @@ export function queryOptions<
23
23
  >(
24
24
  options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
25
25
  ): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
26
- queryKey: DataTag<TQueryKey, TData>
26
+ queryKey: DataTag<TQueryKey, TQueryFnData>
27
27
  }
28
28
 
29
29
  export function queryOptions(options: unknown) {