Add helper type QueryRef.ForQuery<TypedDocumentNode> (#13012)

* Add helper type `QueryRef.ForQuery<TypedDocumentNode>`

* chores

Author: phryneas

.api-reports/api-report-react_internal.api.md

@@ -8,11 +8,14 @@ import type { ApolloClient } from '@apollo/client';
 import type { DataState } from '@apollo/client';
 import type { DecoratedPromise } from '@apollo/client/utilities/internal';
 import type { DocumentNode } from 'graphql';
+import type { DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 import type { InternalTypes } from '@apollo/client/react';
 import type { MaybeMasked } from '@apollo/client/masking';
 import type { MaybeMasked as MaybeMasked_2 } from '@apollo/client';
 import type { ObservableQuery } from '@apollo/client';
 import type { OperationVariables } from '@apollo/client';
+import type { ResultOf } from '@graphql-typed-document-node/core';
+import type { VariablesOf } from '@graphql-typed-document-node/core';
 
 // Warning: (ae-forgotten-export) The symbol "WrappedQueryRef" needs to be exported by the entry point index.d.ts
 //
@@ -186,6 +189,12 @@ export interface QueryRef<TData = unknown, TVariables extends OperationVariables
     };
 }
 
+// @public (undocumented)
+export namespace QueryRef {
+    // (undocumented)
+    export type ForQuery<Document extends DocumentTypeDecoration<any, any>, TStates extends DataState<ResultOf<Document>>["dataState"] = "complete" | "streaming"> = QueryRef<ResultOf<Document>, VariablesOf<Document>, TStates>;
+}
+
 // @public (undocumented)
 type QueryRefPromise<TData, TStates extends DataState<TData>["dataState"]> = DecoratedPromise<ObservableQuery.Result<MaybeMasked<TData>, TStates>>;
 

.changeset/rare-pigs-play.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Add helper type `QueryRef.ForQuery<TypedDocumentNode>`

src/react/internal/cache/QueryReference.ts

@@ -1,3 +1,8 @@
+import type {
+  DocumentTypeDecoration,
+  ResultOf,
+  VariablesOf,
+} from "@graphql-typed-document-node/core";
 import { equal } from "@wry/equality";
 import type { Subscription } from "rxjs";
 import { filter } from "rxjs";
@@ -48,6 +53,15 @@ export interface QueryRef<
   [QUERY_REF_BRAND]?(variables: TVariables): { data: TData; states: TStates };
 }
 
+export declare namespace QueryRef {
+  export type ForQuery<
+    Document extends DocumentTypeDecoration<any, any>,
+    TStates extends DataState<ResultOf<Document>>["dataState"] =
+      | "complete"
+      | "streaming",
+  > = QueryRef<ResultOf<Document>, VariablesOf<Document>, TStates>;
+}
+
 /**
  * @internal
  * For usage in internal helpers only.

src/react/internal/cache/__tests__/QueryReference.test.tsx

@@ -1,7 +1,12 @@
+import { expectTypeOf } from "expect-type";
 import React from "react";
 import { of } from "rxjs";
 
-import type { DataState, OperationVariables } from "@apollo/client";
+import type {
+  DataState,
+  OperationVariables,
+  TypedDocumentNode,
+} from "@apollo/client";
 import { ApolloClient, ApolloLink, InMemoryCache } from "@apollo/client";
 import { InternalQueryReference } from "@apollo/client/react/internal";
 import { setupSimpleCase } from "@apollo/client/testing/internal";
@@ -240,4 +245,28 @@ test.skip("type tests", () => {
       </>;
     }
   });
+
+  test("QueryRef.ForQuery", () => {
+    const ANY: any = {};
+
+    interface Data {
+      foo: string;
+    }
+    type Vars = {
+      bar: string;
+    };
+    const query: TypedDocumentNode<Data, Vars> = ANY;
+
+    expectTypeOf<QueryRef.ForQuery<typeof query>>().toEqualTypeOf<
+      QueryRef<Data, Vars>
+    >();
+
+    expectTypeOf<QueryRef.ForQuery<typeof query, "complete">>().toEqualTypeOf<
+      QueryRef<Data, Vars, "complete">
+    >();
+
+    expectTypeOf<
+      QueryRef.ForQuery<typeof query, "empty" | "partial" | "complete">
+    >().toEqualTypeOf<QueryRef<Data, Vars, "empty" | "partial" | "complete">>();
+  });
 });