fix(angular-query): fix type of isSuccess, isError, isPending, isIdle

TanStack · Aug 20, 2024 · 081cba0 · 081cba0
1 parent 683c85e
commit 081cba0
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 14 deletions.
diff --git a/packages/angular-query-experimental/etc/angular-query-experimental.api.md b/packages/angular-query-experimental/etc/angular-query-experimental.api.md
@@ -36,15 +36,16 @@ import type { ThrowOnError } from '@tanstack/query-core';
 // @public (undocumented)
 export interface BaseMutationNarrowing<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> {
     // (undocumented)
-    isError: (this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'error', 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>>>;
     // (undocumented)
-    isIdle: (this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'idle', 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>>>;
     // (undocumented)
-    isPending: (this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'pending', 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>>>;
+    // Warning: (ae-forgotten-export) The symbol "SignalFunction" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "CreateStatusBasedMutationResult" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    isSuccess: (this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'success', TData, TError, TVariables, TContext>>;
+    isSuccess: SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'success', TData, TError, TVariables, TContext>>>;
 }
 
 // @public (undocumented)

diff --git a/packages/angular-query-experimental/src/__tests__/test-utils.ts b/packages/angular-query-experimental/src/__tests__/test-utils.ts
@@ -1,4 +1,4 @@
-import { type InputSignal, isSignal, untracked } from '@angular/core'
+import { type InputSignal, type Signal, isSignal, untracked } from '@angular/core'
 import { SIGNAL, signalSetFn } from '@angular/core/primitives/signals'
 import type { ComponentFixture } from '@angular/core/testing'
 
@@ -86,7 +86,7 @@ function evaluateSignals<T extends Record<string, any>>(
 
 export const expectSignals = <T extends Record<string, any>>(
   obj: T,
-  expected: Partial<{ [K in keyof T]: ReturnType<T[K]> }>,
+  expected: Partial<{ [K in keyof T]: T[K] extends Signal<any> ? ReturnType<T[K]> : never }>,
 ): void => {
   expect(evaluateSignals(obj)).toMatchObject(expected)
 }

diff --git a/packages/angular-query-experimental/src/types.ts b/packages/angular-query-experimental/src/types.ts
@@ -14,6 +14,7 @@ import type {
   QueryObserverOptions,
   QueryObserverResult,
 } from '@tanstack/query-core'
+import type { Signal } from '@angular/core'
 import type { MapToSignals } from './signal-proxy'
 
 /**
@@ -221,6 +222,8 @@ type CreateStatusBasedMutationResult<
   { status: TStatus }
 >
 
+type SignalFunction<T extends () => any> = T & Signal<ReturnType<T>>;
+
 /**
  * @public
  */
@@ -230,7 +233,7 @@ export interface BaseMutationNarrowing<
   TVariables = unknown,
   TContext = unknown,
 > {
-  isSuccess: (
+  isSuccess: SignalFunction<(
     this: CreateMutationResult<TData, TError, TVariables, TContext>,
   ) => this is CreateMutationResult<
     TData,
@@ -244,8 +247,8 @@ export interface BaseMutationNarrowing<
       TVariables,
       TContext
     >
-  >
-  isError: (
+  >>
+  isError: SignalFunction<(
     this: CreateMutationResult<TData, TError, TVariables, TContext>,
   ) => this is CreateMutationResult<
     TData,
@@ -259,8 +262,8 @@ export interface BaseMutationNarrowing<
       TVariables,
       TContext
     >
-  >
-  isPending: (
+  >>
+  isPending: SignalFunction<(
     this: CreateMutationResult<TData, TError, TVariables, TContext>,
   ) => this is CreateMutationResult<
     TData,
@@ -274,16 +277,16 @@ export interface BaseMutationNarrowing<
       TVariables,
       TContext
     >
-  >
-  isIdle: (
+  >>
+  isIdle: SignalFunction<(
     this: CreateMutationResult<TData, TError, TVariables, TContext>,
   ) => this is CreateMutationResult<
     TData,
     TError,
     TVariables,
     TContext,
     CreateStatusBasedMutationResult<'idle', TData, TError, TVariables, TContext>
-  >
+  >>
 }
 
 /**