@tanstack/angular-query-experimental 5.84.0 → 5.84.1

package/src/query-options.ts

@@ -1,178 +0,0 @@
-import type {
-  DataTag,
-  DefaultError,
-  InitialDataFunction,
-  NonUndefinedGuard,
-  OmitKeyof,
-  QueryFunction,
-  QueryKey,
-  SkipToken,
-} from '@tanstack/query-core'
-import type { CreateQueryOptions } from './types'
-
-export type UndefinedInitialDataOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  initialData?:
-    | undefined
-    | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
-    | NonUndefinedGuard<TQueryFnData>
-}
-
-export type UnusedSkipTokenOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = OmitKeyof<
-  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  'queryFn'
-> & {
-  queryFn?: Exclude<
-    CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
-    SkipToken | undefined
-  >
-}
-
-export type DefinedInitialDataOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> = Omit<
-  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  'queryFn'
-> & {
-  initialData:
-    | NonUndefinedGuard<TQueryFnData>
-    | (() => NonUndefinedGuard<TQueryFnData>)
-  queryFn?: QueryFunction<TQueryFnData, TQueryKey>
-}
-
-/**
- * Allows to share and re-use query options in a type-safe way.
- *
- * The `queryKey` will be tagged with the type from `queryFn`.
- *
- * **Example**
- *
- * ```ts
- *  const { queryKey } = queryOptions({
- *     queryKey: ['key'],
- *     queryFn: () => Promise.resolve(5),
- *     //  ^?  Promise<number>
- *   })
- *
- *   const queryClient = new QueryClient()
- *   const data = queryClient.getQueryData(queryKey)
- *   //    ^?  number | undefined
- * ```
- * @param options - The query options to tag with the type from `queryFn`.
- * @returns The tagged query options.
- * @public
- */
-export function queryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  queryKey: DataTag<TQueryKey, TQueryFnData, TError>
-}
-
-/**
- * Allows to share and re-use query options in a type-safe way.
- *
- * The `queryKey` will be tagged with the type from `queryFn`.
- *
- * **Example**
- *
- * ```ts
- *  const { queryKey } = queryOptions({
- *     queryKey: ['key'],
- *     queryFn: () => Promise.resolve(5),
- *     //  ^?  Promise<number>
- *   })
- *
- *   const queryClient = new QueryClient()
- *   const data = queryClient.getQueryData(queryKey)
- *   //    ^?  number | undefined
- * ```
- * @param options - The query options to tag with the type from `queryFn`.
- * @returns The tagged query options.
- * @public
- */
-export function queryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>,
-): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  queryKey: DataTag<TQueryKey, TQueryFnData, TError>
-}
-
-/**
- * Allows to share and re-use query options in a type-safe way.
- *
- * The `queryKey` will be tagged with the type from `queryFn`.
- *
- * **Example**
- *
- * ```ts
- *  const { queryKey } = queryOptions({
- *     queryKey: ['key'],
- *     queryFn: () => Promise.resolve(5),
- *     //  ^?  Promise<number>
- *   })
- *
- *   const queryClient = new QueryClient()
- *   const data = queryClient.getQueryData(queryKey)
- *   //    ^?  number | undefined
- * ```
- * @param options - The query options to tag with the type from `queryFn`.
- * @returns The tagged query options.
- * @public
- */
-export function queryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
->(
-  options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
-): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  queryKey: DataTag<TQueryKey, TQueryFnData, TError>
-}
-
-/**
- * Allows to share and re-use query options in a type-safe way.
- *
- * The `queryKey` will be tagged with the type from `queryFn`.
- *
- * **Example**
- *
- * ```ts
- *  const { queryKey } = queryOptions({
- *     queryKey: ['key'],
- *     queryFn: () => Promise.resolve(5),
- *     //  ^?  Promise<number>
- *   })
- *
- *   const queryClient = new QueryClient()
- *   const data = queryClient.getQueryData(queryKey)
- *   //    ^?  number | undefined
- * ```
- * @param options - The query options to tag with the type from `queryFn`.
- * @returns The tagged query options.
- * @public
- */
-export function queryOptions(options: unknown) {
-  return options
-}

package/src/signal-proxy.ts

@@ -1,46 +0,0 @@
-import { computed, untracked } from '@angular/core'
-import type { Signal } from '@angular/core'
-
-export type MapToSignals<T> = {
-  [K in keyof T]: T[K] extends Function ? T[K] : Signal<T[K]>
-}
-
-/**
- * Exposes fields of an object passed via an Angular `Signal` as `Computed` signals.
- * Functions on the object are passed through as-is.
- * @param inputSignal - `Signal` that must return an object.
- * @returns A proxy object with the same fields as the input object, but with each field wrapped in a `Computed` signal.
- */
-export function signalProxy<TInput extends Record<string | symbol, any>>(
-  inputSignal: Signal<TInput>,
-) {
-  const internalState = {} as MapToSignals<TInput>
-
-  return new Proxy<MapToSignals<TInput>>(internalState, {
-    get(target, prop) {
-      // first check if we have it in our internal state and return it
-      const computedField = target[prop]
-      if (computedField) return computedField
-
-      // then, check if it's a function on the resultState and return it
-      const targetField = untracked(inputSignal)[prop]
-      if (typeof targetField === 'function') return targetField
-
-      // finally, create a computed field, store it and return it
-      // @ts-expect-error
-      return (target[prop] = computed(() => inputSignal()[prop]))
-    },
-    has(_, prop) {
-      return !!untracked(inputSignal)[prop]
-    },
-    ownKeys() {
-      return Reflect.ownKeys(untracked(inputSignal))
-    },
-    getOwnPropertyDescriptor() {
-      return {
-        enumerable: true,
-        configurable: true,
-      }
-    },
-  })
-}

package/src/types.ts

@@ -1,309 +0,0 @@
-/* istanbul ignore file */
-
-import type {
-  DefaultError,
-  DefinedInfiniteQueryObserverResult,
-  DefinedQueryObserverResult,
-  InfiniteQueryObserverOptions,
-  InfiniteQueryObserverResult,
-  MutateFunction,
-  MutationObserverResult,
-  OmitKeyof,
-  Override,
-  QueryKey,
-  QueryObserverOptions,
-  QueryObserverResult,
-} from '@tanstack/query-core'
-import type { Signal } from '@angular/core'
-import type { MapToSignals } from './signal-proxy'
-
-/**
- * @public
- */
-export interface CreateBaseQueryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> extends QueryObserverOptions<
-    TQueryFnData,
-    TError,
-    TData,
-    TQueryData,
-    TQueryKey
-  > {}
-
-/**
- * @public
- */
-export interface CreateQueryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-> extends OmitKeyof<
-    CreateBaseQueryOptions<
-      TQueryFnData,
-      TError,
-      TData,
-      TQueryFnData,
-      TQueryKey
-    >,
-    'suspense'
-  > {}
-
-/**
- * @public
- */
-type CreateStatusBasedQueryResult<
-  TStatus extends QueryObserverResult['status'],
-  TData = unknown,
-  TError = DefaultError,
-> = Extract<QueryObserverResult<TData, TError>, { status: TStatus }>
-
-/**
- * @public
- */
-export interface BaseQueryNarrowing<TData = unknown, TError = DefaultError> {
-  isSuccess: (
-    this: CreateBaseQueryResult<TData, TError>,
-  ) => this is CreateBaseQueryResult<
-    TData,
-    TError,
-    CreateStatusBasedQueryResult<'success', TData, TError>
-  >
-  isError: (
-    this: CreateBaseQueryResult<TData, TError>,
-  ) => this is CreateBaseQueryResult<
-    TData,
-    TError,
-    CreateStatusBasedQueryResult<'error', TData, TError>
-  >
-  isPending: (
-    this: CreateBaseQueryResult<TData, TError>,
-  ) => this is CreateBaseQueryResult<
-    TData,
-    TError,
-    CreateStatusBasedQueryResult<'pending', TData, TError>
-  >
-}
-
-/**
- * @public
- */
-export interface CreateInfiniteQueryOptions<
-  TQueryFnData = unknown,
-  TError = DefaultError,
-  TData = TQueryFnData,
-  TQueryKey extends QueryKey = QueryKey,
-  TPageParam = unknown,
-> extends OmitKeyof<
-    InfiniteQueryObserverOptions<
-      TQueryFnData,
-      TError,
-      TData,
-      TQueryKey,
-      TPageParam
-    >,
-    'suspense'
-  > {}
-
-/**
- * @public
- */
-export type CreateBaseQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-  TState = QueryObserverResult<TData, TError>,
-> = BaseQueryNarrowing<TData, TError> &
-  MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>
-
-/**
- * @public
- */
-export type CreateQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-> = CreateBaseQueryResult<TData, TError>
-
-/**
- * @public
- */
-export type DefinedCreateQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-  TState = DefinedQueryObserverResult<TData, TError>,
-> = BaseQueryNarrowing<TData, TError> &
-  MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>
-
-/**
- * @public
- */
-export type CreateInfiniteQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-> = BaseQueryNarrowing<TData, TError> &
-  MapToSignals<InfiniteQueryObserverResult<TData, TError>>
-
-/**
- * @public
- */
-export type DefinedCreateInfiniteQueryResult<
-  TData = unknown,
-  TError = DefaultError,
-  TDefinedInfiniteQueryObserver = DefinedInfiniteQueryObserverResult<
-    TData,
-    TError
-  >,
-> = MapToSignals<TDefinedInfiniteQueryObserver>
-
-/**
- * @public
- */
-export type CreateMutateFunction<
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = void,
-  TContext = unknown,
-> = (
-  ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
-) => void
-
-/**
- * @public
- */
-export type CreateMutateAsyncFunction<
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = void,
-  TContext = unknown,
-> = MutateFunction<TData, TError, TVariables, TContext>
-
-/**
- * @public
- */
-export type CreateBaseMutationResult<
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = unknown,
-  TContext = unknown,
-> = Override<
-  MutationObserverResult<TData, TError, TVariables, TContext>,
-  { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
-> & {
-  mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
-}
-
-/**
- * @public
- */
-type CreateStatusBasedMutationResult<
-  TStatus extends CreateBaseMutationResult['status'],
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = unknown,
-  TContext = unknown,
-> = Extract<
-  CreateBaseMutationResult<TData, TError, TVariables, TContext>,
-  { status: TStatus }
->
-
-type SignalFunction<T extends () => any> = T & Signal<ReturnType<T>>
-
-/**
- * @public
- */
-export interface BaseMutationNarrowing<
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = unknown,
-  TContext = unknown,
-> {
-  isSuccess: SignalFunction<
-    (
-      this: CreateMutationResult<TData, TError, TVariables, TContext>,
-    ) => this is CreateMutationResult<
-      TData,
-      TError,
-      TVariables,
-      TContext,
-      CreateStatusBasedMutationResult<
-        'success',
-        TData,
-        TError,
-        TVariables,
-        TContext
-      >
-    >
-  >
-  isError: SignalFunction<
-    (
-      this: CreateMutationResult<TData, TError, TVariables, TContext>,
-    ) => this is CreateMutationResult<
-      TData,
-      TError,
-      TVariables,
-      TContext,
-      CreateStatusBasedMutationResult<
-        'error',
-        TData,
-        TError,
-        TVariables,
-        TContext
-      >
-    >
-  >
-  isPending: SignalFunction<
-    (
-      this: CreateMutationResult<TData, TError, TVariables, TContext>,
-    ) => this is CreateMutationResult<
-      TData,
-      TError,
-      TVariables,
-      TContext,
-      CreateStatusBasedMutationResult<
-        'pending',
-        TData,
-        TError,
-        TVariables,
-        TContext
-      >
-    >
-  >
-  isIdle: SignalFunction<
-    (
-      this: CreateMutationResult<TData, TError, TVariables, TContext>,
-    ) => this is CreateMutationResult<
-      TData,
-      TError,
-      TVariables,
-      TContext,
-      CreateStatusBasedMutationResult<
-        'idle',
-        TData,
-        TError,
-        TVariables,
-        TContext
-      >
-    >
-  >
-}
-
-/**
- * @public
- */
-export type CreateMutationResult<
-  TData = unknown,
-  TError = DefaultError,
-  TVariables = unknown,
-  TContext = unknown,
-  TState = CreateStatusBasedMutationResult<
-    CreateBaseMutationResult['status'],
-    TData,
-    TError,
-    TVariables,
-    TContext
-  >,
-> = BaseMutationNarrowing<TData, TError, TVariables, TContext> &
-  MapToSignals<OmitKeyof<TState, keyof BaseMutationNarrowing, 'safely'>>

package/src/util/is-dev-mode/is-dev-mode.ts

@@ -1,3 +0,0 @@
-// Re-export for mocking in tests
-
-export { isDevMode } from '@angular/core'