add infinite query option types to public api

TanStack · May 7, 2024 · da3eab4 · da3eab4
1 parent d62edad
commit da3eab4
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 15 deletions.
diff --git a/packages/angular-query-experimental/.prettierignore b/packages/angular-query-experimental/.prettierignore
@@ -1,2 +1,2 @@
 # API extractor
-*.api.md
+etc/**
diff --git a/packages/angular-query-experimental/etc/angular-query-experimental.api.md b/packages/angular-query-experimental/etc/angular-query-experimental.api.md
@@ -284,6 +284,26 @@ export type DefinedCreateQueryResult<
   TDefinedQueryObserver = DefinedQueryObserverResult<TData, TError>,
 > = MapToSignals<TDefinedQueryObserver>
 
+// @public (undocumented)
+export type DefinedInitialDataInfiniteOptions<
+  TQueryFnData,
+  TError = DefaultError,
+  TData = InfiniteData<TQueryFnData>,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> = CreateInfiniteQueryOptions<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryFnData,
+  TQueryKey,
+  TPageParam
+> & {
+  initialData:
+    | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
+    | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
+}
+
 // @public (undocumented)
 export type DefinedInitialDataOptions<
   TQueryFnData = unknown,
@@ -296,8 +316,6 @@ export type DefinedInitialDataOptions<
     | (() => NonUndefinedGuard<TQueryFnData>)
 }
 
-// Warning: (ae-forgotten-export) The symbol "UndefinedInitialDataInfiniteOptions" needs to be exported by the entry point index.d.ts
-//
 // @public
 export function infiniteQueryOptions<
   TQueryFnData,
@@ -323,8 +341,6 @@ export function infiniteQueryOptions<
   queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
 }
 
-// Warning: (ae-forgotten-export) The symbol "DefinedInitialDataInfiniteOptions" needs to be exported by the entry point index.d.ts
-//
 // @public
 export function infiniteQueryOptions<
   TQueryFnData,
@@ -521,6 +537,9 @@ export const injectQueryClient: {
   ): QueryClient
 }
 
+// @public (undocumented)
+export type NonUndefinedGuard<T> = T extends undefined ? never : T
+
 // @public
 export function provideAngularQuery(
   queryClient: QueryClient,
@@ -632,6 +651,24 @@ export function queryOptions<
   queryKey: DataTag<TQueryKey, TQueryFnData>
 }
 
+// @public (undocumented)
+export type UndefinedInitialDataInfiniteOptions<
+  TQueryFnData,
+  TError = DefaultError,
+  TData = InfiniteData<TQueryFnData>,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> = CreateInfiniteQueryOptions<
+  TQueryFnData,
+  TError,
+  TData,
+  TQueryFnData,
+  TQueryKey,
+  TPageParam
+> & {
+  initialData?: undefined
+}
+
 // @public (undocumented)
 export type UndefinedInitialDataOptions<
   TQueryFnData = unknown,
@@ -644,9 +681,5 @@ export type UndefinedInitialDataOptions<
 
 export * from '@tanstack/query-core'
 
-// Warnings were encountered during analysis:
-//
-// src/query-options.ts:27:3 - (ae-forgotten-export) The symbol "NonUndefinedGuard" needs to be exported by the entry point index.d.ts
-
 // (No @packageDocumentation comment for this package)
 ```
diff --git a/packages/angular-query-experimental/src/index.ts b/packages/angular-query-experimental/src/index.ts
@@ -11,6 +11,10 @@ export type {
 } from './query-options'
 export { queryOptions } from './query-options'
 
+export type {
+  DefinedInitialDataInfiniteOptions,
+  UndefinedInitialDataInfiniteOptions,
+} from './infinite-query-options'
 export { infiniteQueryOptions } from './infinite-query-options'
 
 export * from './inject-infinite-query'

diff --git a/packages/angular-query-experimental/src/infinite-query-options.ts b/packages/angular-query-experimental/src/infinite-query-options.ts
@@ -1,6 +1,6 @@
 import type { DataTag } from '@tanstack/query-core'
 import type { InfiniteData } from '@tanstack/query-core'
-import type { CreateInfiniteQueryOptions } from './types'
+import type { CreateInfiniteQueryOptions, NonUndefinedGuard } from './types'
 import type { DefaultError, QueryKey } from '@tanstack/query-core'
 
 /**
@@ -23,8 +23,6 @@ export type UndefinedInitialDataInfiniteOptions<
   initialData?: undefined
 }
 
-type NonUndefinedGuard<T> = T extends undefined ? never : T
-
 /**
  * @public
  */

diff --git a/packages/angular-query-experimental/src/query-options.ts b/packages/angular-query-experimental/src/query-options.ts
@@ -1,5 +1,5 @@
 import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
-import type { CreateQueryOptions } from './types'
+import type { CreateQueryOptions, NonUndefinedGuard } from './types'
 
 /**
  * @public
@@ -13,8 +13,6 @@ export type UndefinedInitialDataOptions<
   initialData?: undefined
 }
 
-type NonUndefinedGuard<T> = T extends undefined ? never : T
-
 /**
  * @public
  */

diff --git a/packages/angular-query-experimental/src/types.ts b/packages/angular-query-experimental/src/types.ts
@@ -309,3 +309,8 @@ type Override<TTargetA, TTargetB> = {
     ? TTargetB[AKey]
     : TTargetA[AKey]
 }
+
+/**
+ * @public
+ */
+export type NonUndefinedGuard<T> = T extends undefined ? never : T