refactor(solid-query): remove 'Solid' prefix from 'SolidQueryOptions', 'SolidInfiniteQueryOptions', and 'SolidMutationOptions'

.changeset/five-lizards-camp.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/solid-query': patch
+---
+
+refactor(solid-query): remove 'Solid' prefix from 'SolidQueryOptions', 'SolidInfiniteQueryOptions', and 'SolidMutationOptions'

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<number, DefaultError, string>,
-        'mutationKey'
-      >
+      WithRequired<MutationOptions<number, DefaultError, string>, 'mutationKey'>
     >()
     expectTypeOf(
       mutationOptions({
@@ -132,7 +129,7 @@ describe('mutationOptions', () => {
         },
       }),
     ).toEqualTypeOf<
-      Omit<SolidMutationOptions<number, DefaultError, string>, 'mutationKey'>
+      Omit<MutationOptions<number, DefaultError, string>, 'mutationKey'>
     >()
   })
 

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<SolidQueryOptions<Data>, 'queryKey' | 'queryFn'>,
+        options?: OmitKeyof<QueryOptions<Data>, 'queryKey' | 'queryFn'>,
       ) => {
         return useQueries(() => ({
           queries: [

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<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
-    ) {
+    >(queries: Array<QueryOptions<TQueryFnData, TError, TData, TQueryKey>>) {
       return useQueries(() => ({
         queries: queries.map(
           // no need to type the mapped query

packages/solid-query/src/index.ts

@@ -15,9 +15,9 @@ export type {
   DefinedUseBaseQueryResult,
   DefinedUseInfiniteQueryResult,
   DefinedUseQueryResult,
-  SolidInfiniteQueryOptions,
-  SolidMutationOptions,
-  SolidQueryOptions,
+  InfiniteQueryOptions,
+  MutationOptions,
+  QueryOptions,
   UseBaseMutationResult,
   UseBaseQueryOptions,
   UseBaseQueryResult,

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<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
     initialData?: undefined
   }
 >
@@ -34,13 +28,7 @@ export type DefinedInitialDataInfiniteOptions<
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
 > = Accessor<
-  SolidInfiniteQueryOptions<
-    TQueryFnData,
-    TError,
-    TData,
-    TQueryKey,
-    TPageParam
-  > & {
+  InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
     initialData:
       | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
       | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)

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<TData, TError, TVariables, TOnMutateResult>,
+    MutationOptions<TData, TError, TVariables, TOnMutateResult>,
     'mutationKey'
   >,
 ): WithRequired<
-  SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
+  MutationOptions<TData, TError, TVariables, TOnMutateResult>,
   'mutationKey'
 >
 export function mutationOptions<
@@ -22,11 +22,11 @@ export function mutationOptions<
   TOnMutateResult = unknown,
 >(
   options: Omit<
-    SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
+    MutationOptions<TData, TError, TVariables, TOnMutateResult>,
     'mutationKey'
   >,
 ): Omit<
-  SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
+  MutationOptions<TData, TError, TVariables, TOnMutateResult>,
   'mutationKey'
 >
 export function mutationOptions<
@@ -35,7 +35,7 @@ export function mutationOptions<
   TVariables = void,
   TOnMutateResult = unknown,
 >(
-  options: SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
-): SolidMutationOptions<TData, TError, TVariables, TOnMutateResult> {
+  options: MutationOptions<TData, TError, TVariables, TOnMutateResult>,
+): MutationOptions<TData, TError, TVariables, TOnMutateResult> {
   return options
 }

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<TQueryFnData, TError, TData, TQueryKey> & {
+  QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
     initialData?: undefined
   }
 >
@@ -19,7 +19,7 @@ export type DefinedInitialDataOptions<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > = Accessor<
-  SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
     initialData: TQueryFnData | (() => TQueryFnData)
   }
 >

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<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>
+> = Accessor<QueryOptions<TQueryFnData, TError, TData, TQueryKey>>
 
 /* --- Create Query and Create Base Query  Types --- */
 
@@ -87,7 +87,7 @@ export type DefinedUseQueryResult<
 > = DefinedUseBaseQueryResult<TData, TError>
 
 /* --- 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<TQueryFnData, TError, TData, TQueryKey, TPageParam>
+  InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
 >
 
 export type UseInfiniteQueryResult<
@@ -140,7 +140,7 @@ export type DefinedUseInfiniteQueryResult<
 > = DefinedInfiniteQueryObserverResult<TData, TError>
 
 /* --- 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<SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>>
+> = Accessor<MutationOptions<TData, TError, TVariables, TOnMutateResult>>
 
 export type UseMutateFunction<
   TData = unknown,

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<TQueryFnData, TError, TData, TQueryKey>,
+  QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
   'placeholderData' | 'suspense'
 > & {
   placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>