fix(angular-query): align types to React Query (TanStack#6654)

Author: arnoud-dv

packages/angular-query-experimental/src/create-base-query.ts

@@ -13,7 +13,6 @@ import type { CreateBaseQueryOptions, CreateBaseQueryResult } from './types'
 
 /**
  * Base implementation for `injectQuery` and `injectInfiniteQuery`.
- * @internal
  */
 export function createBaseQuery<
   TQueryFnData,
@@ -60,9 +59,7 @@ export function createBaseQuery<
   >(queryClient, defaultedOptionsSignal())
 
   const resultSignal = signal(
-    observer.getOptimisticResult(
-      queryClient.defaultQueryOptions(defaultedOptionsSignal()),
-    ),
+    observer.getOptimisticResult(defaultedOptionsSignal()),
   )
 
   effect(

packages/angular-query-experimental/src/inject-query.ts

@@ -14,11 +14,6 @@ import type {
   UndefinedInitialDataOptions,
 } from './query-options'
 
-/**
- * Create a Query.
- * @param options
- * @param injector
- */
 export function injectQuery<
   TQueryFnData = unknown,
   TError = DefaultError,
@@ -44,7 +39,7 @@ export function injectQuery<
 ): DefinedCreateQueryResult<TData, TError>
 
 export function injectQuery<
-  TQueryFnData,
+  TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
@@ -53,6 +48,11 @@ export function injectQuery<
     client: QueryClient,
   ) => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
   injector?: Injector,
+): CreateQueryResult<TData, TError>
+
+export function injectQuery(
+  options: (client: QueryClient) => CreateQueryOptions,
+  injector?: Injector,
 ) {
   return assertInjector(injectQuery, injector, () => {
     const queryClient = injectQueryClient()

packages/angular-query-experimental/src/query-options.ts

@@ -1,4 +1,4 @@
-import type { DefaultError, QueryKey } from '@tanstack/query-core'
+import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
 import type { CreateQueryOptions } from './types'
 
 export type UndefinedInitialDataOptions<
@@ -30,7 +30,9 @@ export function queryOptions<
   TQueryKey extends QueryKey = QueryKey,
 >(
   options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
+): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  queryKey: DataTag<TQueryKey, TData>
+}
 
 export function queryOptions<
   TQueryFnData = unknown,
@@ -39,7 +41,9 @@ export function queryOptions<
   TQueryKey extends QueryKey = QueryKey,
 >(
   options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
+): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
+  queryKey: DataTag<TQueryKey, TData>
+}
 
 export function queryOptions(options: unknown) {
   return options

packages/angular-query-experimental/src/types.ts

@@ -11,35 +11,46 @@ import type {
   QueryKey,
   QueryObserverOptions,
   QueryObserverResult,
+  WithRequired,
 } from '@tanstack/query-core'
 import type { MapToSignals } from './signal-proxy'
 
-/** Options for createBaseQuery */
-export type CreateBaseQueryOptions<
+export interface CreateBaseQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
-> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
+> extends WithRequired<
+    QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
+    'queryKey'
+  > {}
 
-/** Result from createBaseQuery */
 export type CreateBaseQueryResult<
   TData = unknown,
   TError = DefaultError,
   State = QueryObserverResult<TData, TError>,
 > = MapToSignals<State>
-/** Result from createBaseQuery */
 
-/** Options for createQuery */
-export type CreateQueryOptions<
+export interface CreateQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
-> = CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
+> extends Omit<
+    WithRequired<
+      CreateBaseQueryOptions<
+        TQueryFnData,
+        TError,
+        TData,
+        TQueryFnData,
+        TQueryKey
+      >,
+      'queryKey'
+    >,
+    'suspense'
+  > {}
 
-/** Result from createQuery */
 export type CreateQueryResult<
   TData = unknown,
   TError = DefaultError,
@@ -62,26 +73,17 @@ export type CreateInfiniteQueryOptions<
   TPageParam
 >
 
-/** Result from createInfiniteQuery */
 export type CreateInfiniteQueryResult<
   TData = unknown,
   TError = DefaultError,
 > = Signal<InfiniteQueryObserverResult<TData, TError>>
 
-/** Options for createBaseQuery with initialData */
-export type DefinedCreateBaseQueryResult<
+export type DefinedCreateQueryResult<
   TData = unknown,
   TError = DefaultError,
   DefinedQueryObserver = DefinedQueryObserverResult<TData, TError>,
 > = MapToSignals<DefinedQueryObserver>
 
-/** Options for createQuery with initialData */
-export type DefinedCreateQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-> = DefinedCreateBaseQueryResult<TData, TError>
-
-/** Options for createMutation */
 export type CreateMutationOptions<
   TData = unknown,
   TError = DefaultError,