feat: support gql tada closes #206

logaretm · Mar 1, 2024 · 0957b1b · 0957b1b
1 parent 0010e15
commit 0957b1b
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 11 deletions.
diff --git a/.changeset/twenty-mayflies-hug.md b/.changeset/twenty-mayflies-hug.md
@@ -0,0 +1,5 @@
+---
+'villus': major
+---
+
+feat: add support for gql.tada
diff --git a/packages/shared/src/types.ts b/packages/shared/src/types.ts
@@ -1,6 +1,23 @@
-import type { TypedDocumentNode, DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 import { DocumentNode } from 'graphql';
 
+export interface DocumentDecoration<
+  Result = {
+    [key: string]: any;
+  },
+  Variables = {
+    [key: string]: any;
+  },
+> {
+  /** Type to support `@graphql-typed-document-node/core`
+   * @internal
+   */
+  __apiType?: (variables: Variables) => Result;
+  /** Type to support `TypedQueryDocumentNode` from `graphql`
+   * @internal
+   */
+  __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
+}
+
 export interface GraphQLResponse<TData> {
   data: TData;
   errors: any;
@@ -20,7 +37,7 @@ export interface ParsedResponse<TData> {
 }
 
 export interface Operation<TData, TVars> {
-  query: string | DocumentNode | TypedDocumentNode<TData, TVars> | DocumentTypeDecoration<TData, TVars>;
+  query: string | DocumentNode | DocumentDecoration<TData, TVars>;
   variables?: TVars;
 }
 

diff --git a/packages/shared/src/utils.ts b/packages/shared/src/utils.ts
@@ -1,12 +1,10 @@
-import type { TypedDocumentNode, DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 import { DocumentNode, print } from 'graphql';
+import { DocumentDecoration } from './types';
 
 /**
  * Normalizes a query string or object to a string.
  */
-export function normalizeQuery(
-  query: string | DocumentNode | TypedDocumentNode | DocumentTypeDecoration<any, any>,
-): string | null {
+export function normalizeQuery(query: string | DocumentNode | DocumentDecoration<any, any>): string | null {
   if (typeof query === 'string') {
     return query;
   }

diff --git a/packages/villus/test/useQuery.spec.ts b/packages/villus/test/useQuery.spec.ts
@@ -6,7 +6,14 @@ import { server } from './mocks/server';
 import flushPromises from 'flush-promises';
 import waitForExpect from 'wait-for-expect';
 import { mount } from './helpers/mount';
-import { useClient, useQuery, cache as cachePlugin, fetch as fetchPlugin, CombinedError } from '../src/index';
+import {
+  useClient,
+  useQuery,
+  cache as cachePlugin,
+  fetch as fetchPlugin,
+  CombinedError,
+  DocumentDecoration,
+} from '../src/index';
 import {
   PostsQuery,
   QueryWithGqlError,
@@ -17,15 +24,14 @@ import {
   PostsQueryWithDescription,
 } from './mocks/queries';
 import { graphql } from 'msw';
-import { DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 
 interface Post {
   id: number;
   title: string;
 }
 
-class TypedDocumentString<TResult, TVariables> extends String implements DocumentTypeDecoration<TResult, TVariables> {
-  __apiType?: DocumentTypeDecoration<TResult, TVariables>['__apiType'];
+class TypedDocumentString<TResult, TVariables> extends String implements DocumentDecoration<TResult, TVariables> {
+  __apiType?: DocumentDecoration<TResult, TVariables>['__apiType'];
 
   constructor(
     private value: string,
@@ -34,7 +40,7 @@ class TypedDocumentString<TResult, TVariables> extends String implements Documen
     super(value);
   }
 
-  toString(): string & DocumentTypeDecoration<TResult, TVariables> {
+  toString(): string & DocumentDecoration<TResult, TVariables> {
     return this.value;
   }
 }