diff --git a/.changeset/five-lizards-camp.md b/.changeset/five-lizards-camp.md new file mode 100644 index 00000000000..7f96b1bdc0f --- /dev/null +++ b/.changeset/five-lizards-camp.md @@ -0,0 +1,5 @@ +--- +'@tanstack/solid-query': patch +--- + +refactor(solid-query): remove 'Solid' prefix from 'SolidQueryOptions', 'SolidInfiniteQueryOptions', and 'SolidMutationOptions' diff --git a/packages/solid-query/src/__tests__/mutationOptions.test-d.tsx b/packages/solid-query/src/__tests__/mutationOptions.test-d.tsx index 1649db1e019..58cb139bd98 100644 --- a/packages/solid-query/src/__tests__/mutationOptions.test-d.tsx +++ b/packages/solid-query/src/__tests__/mutationOptions.test-d.tsx @@ -9,7 +9,7 @@ import type { MutationState, WithRequired, } from '@tanstack/query-core' -import type { SolidMutationOptions, UseMutationResult } from '../types' +import type { MutationOptions, UseMutationResult } from '../types' describe('mutationOptions', () => { it('should not allow excess properties', () => { @@ -119,10 +119,7 @@ describe('mutationOptions', () => { }, }), ).toEqualTypeOf< - WithRequired< - SolidMutationOptions, - 'mutationKey' - > + WithRequired, 'mutationKey'> >() expectTypeOf( mutationOptions({ @@ -132,7 +129,7 @@ describe('mutationOptions', () => { }, }), ).toEqualTypeOf< - Omit, 'mutationKey'> + Omit, 'mutationKey'> >() }) diff --git a/packages/solid-query/src/__tests__/useQueries.test-d.tsx b/packages/solid-query/src/__tests__/useQueries.test-d.tsx index 3567f77bfc6..9526923872e 100644 --- a/packages/solid-query/src/__tests__/useQueries.test-d.tsx +++ b/packages/solid-query/src/__tests__/useQueries.test-d.tsx @@ -5,7 +5,7 @@ import { queryOptions, useQueries } from '..' import { QueryClient } from '../QueryClient' import type { OmitKeyof } from '@tanstack/query-core' import type { UseQueryResult } from '..' -import type { SolidQueryOptions } from '../types' +import type { QueryOptions } from '../types' describe('useQueries', () => { it('TData should have undefined in the union even when initialData is provided as an object', () => { @@ -164,11 +164,11 @@ describe('useQueries', () => { }) describe('custom hook', () => { - it('should allow custom hooks using SolidQueryOptions', () => { + it('should allow custom hooks using QueryOptions', () => { type Data = string const useCustomQueries = ( - options?: OmitKeyof, 'queryKey' | 'queryFn'>, + options?: OmitKeyof, 'queryKey' | 'queryFn'>, ) => { return useQueries(() => ({ queries: [ diff --git a/packages/solid-query/src/__tests__/useQueries.test.tsx b/packages/solid-query/src/__tests__/useQueries.test.tsx index 2f8e61a7402..2f683626690 100644 --- a/packages/solid-query/src/__tests__/useQueries.test.tsx +++ b/packages/solid-query/src/__tests__/useQueries.test.tsx @@ -22,7 +22,7 @@ import type { QueryFunction, QueryFunctionContext, QueryKey, - SolidQueryOptions, + QueryOptions, UseQueryResult, } from '..' @@ -585,9 +585,7 @@ describe('useQueries', () => { TError, TData, TQueryKey extends QueryKey, - >( - queries: Array>, - ) { + >(queries: Array>) { return useQueries(() => ({ queries: queries.map( // no need to type the mapped query diff --git a/packages/solid-query/src/index.ts b/packages/solid-query/src/index.ts index cc5cee0635a..4d4400f2abe 100644 --- a/packages/solid-query/src/index.ts +++ b/packages/solid-query/src/index.ts @@ -15,9 +15,9 @@ export type { DefinedUseBaseQueryResult, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, - SolidInfiniteQueryOptions, - SolidMutationOptions, - SolidQueryOptions, + InfiniteQueryOptions, + MutationOptions, + QueryOptions, UseBaseMutationResult, UseBaseQueryOptions, UseBaseQueryResult, diff --git a/packages/solid-query/src/infiniteQueryOptions.ts b/packages/solid-query/src/infiniteQueryOptions.ts index de4991d0b78..6f4885d999f 100644 --- a/packages/solid-query/src/infiniteQueryOptions.ts +++ b/packages/solid-query/src/infiniteQueryOptions.ts @@ -5,7 +5,7 @@ import type { NonUndefinedGuard, QueryKey, } from '@tanstack/query-core' -import type { SolidInfiniteQueryOptions } from './types' +import type { InfiniteQueryOptions } from './types' import type { Accessor } from 'solid-js' export type UndefinedInitialDataInfiniteOptions< @@ -15,13 +15,7 @@ export type UndefinedInitialDataInfiniteOptions< TQueryKey extends QueryKey = QueryKey, TPageParam = unknown, > = Accessor< - SolidInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam - > & { + InfiniteQueryOptions & { initialData?: undefined } > @@ -34,13 +28,7 @@ export type DefinedInitialDataInfiniteOptions< TQueryKey extends QueryKey = QueryKey, TPageParam = unknown, > = Accessor< - SolidInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam - > & { + InfiniteQueryOptions & { initialData: | NonUndefinedGuard> | (() => NonUndefinedGuard>) diff --git a/packages/solid-query/src/mutationOptions.ts b/packages/solid-query/src/mutationOptions.ts index d29ff290f46..91caa28d44e 100644 --- a/packages/solid-query/src/mutationOptions.ts +++ b/packages/solid-query/src/mutationOptions.ts @@ -1,5 +1,5 @@ import type { DefaultError, WithRequired } from '@tanstack/query-core' -import type { SolidMutationOptions } from './types' +import type { MutationOptions } from './types' export function mutationOptions< TData = unknown, @@ -8,11 +8,11 @@ export function mutationOptions< TOnMutateResult = unknown, >( options: WithRequired< - SolidMutationOptions, + MutationOptions, 'mutationKey' >, ): WithRequired< - SolidMutationOptions, + MutationOptions, 'mutationKey' > export function mutationOptions< @@ -22,11 +22,11 @@ export function mutationOptions< TOnMutateResult = unknown, >( options: Omit< - SolidMutationOptions, + MutationOptions, 'mutationKey' >, ): Omit< - SolidMutationOptions, + MutationOptions, 'mutationKey' > export function mutationOptions< @@ -35,7 +35,7 @@ export function mutationOptions< TVariables = void, TOnMutateResult = unknown, >( - options: SolidMutationOptions, -): SolidMutationOptions { + options: MutationOptions, +): MutationOptions { return options } diff --git a/packages/solid-query/src/queryOptions.ts b/packages/solid-query/src/queryOptions.ts index 04bd2b9c80b..fea9db1e1f3 100644 --- a/packages/solid-query/src/queryOptions.ts +++ b/packages/solid-query/src/queryOptions.ts @@ -1,5 +1,5 @@ import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core' -import type { SolidQueryOptions } from './types' +import type { QueryOptions } from './types' import type { Accessor } from 'solid-js' export type UndefinedInitialDataOptions< @@ -8,7 +8,7 @@ export type UndefinedInitialDataOptions< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = Accessor< - SolidQueryOptions & { + QueryOptions & { initialData?: undefined } > @@ -19,7 +19,7 @@ export type DefinedInitialDataOptions< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = Accessor< - SolidQueryOptions & { + QueryOptions & { initialData: TQueryFnData | (() => TQueryFnData) } > diff --git a/packages/solid-query/src/types.ts b/packages/solid-query/src/types.ts index 697177772cd..1c5bd10a24d 100644 --- a/packages/solid-query/src/types.ts +++ b/packages/solid-query/src/types.ts @@ -44,7 +44,7 @@ export interface UseBaseQueryOptions< suspense?: boolean } -export interface SolidQueryOptions< +export interface QueryOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, @@ -62,7 +62,7 @@ export type UseQueryOptions< TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, -> = Accessor> +> = Accessor> /* --- Create Query and Create Base Query Types --- */ @@ -87,7 +87,7 @@ export type DefinedUseQueryResult< > = DefinedUseBaseQueryResult /* --- Create Infinite Queries Types --- */ -export interface SolidInfiniteQueryOptions< +export interface InfiniteQueryOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, @@ -126,7 +126,7 @@ export type UseInfiniteQueryOptions< TQueryKey extends QueryKey = QueryKey, TPageParam = unknown, > = Accessor< - SolidInfiniteQueryOptions + InfiniteQueryOptions > export type UseInfiniteQueryResult< @@ -140,7 +140,7 @@ export type DefinedUseInfiniteQueryResult< > = DefinedInfiniteQueryObserverResult /* --- Create Mutation Types --- */ -export interface SolidMutationOptions< +export interface MutationOptions< TData = unknown, TError = DefaultError, TVariables = void, @@ -155,7 +155,7 @@ export type UseMutationOptions< TError = DefaultError, TVariables = void, TOnMutateResult = unknown, -> = Accessor> +> = Accessor> export type UseMutateFunction< TData = unknown, diff --git a/packages/solid-query/src/useQueries.ts b/packages/solid-query/src/useQueries.ts index 1e5592775db..bf0a17cd6ad 100644 --- a/packages/solid-query/src/useQueries.ts +++ b/packages/solid-query/src/useQueries.ts @@ -13,7 +13,7 @@ import { } from 'solid-js' import { useQueryClient } from './QueryClientProvider' import { useIsRestoring } from './isRestoring' -import type { SolidQueryOptions, UseQueryResult } from './types' +import type { QueryOptions, UseQueryResult } from './types' import type { Accessor } from 'solid-js' import type { QueryClient } from './QueryClient' import type { @@ -36,7 +36,7 @@ type UseQueryOptionsForUseQueries< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = OmitKeyof< - SolidQueryOptions, + QueryOptions, 'placeholderData' | 'suspense' > & { placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction