@graphql-codegen/typescript-react-apollo 4.3.3 → 4.4.0

package/cjs/visitor.js

@@ -264,7 +264,10 @@ class ReactApolloVisitor extends visitor_plugin_common_1.ClientSideBaseVisitor {
                 suffix: (0, change_case_all_1.pascalCase)('SuspenseQuery'),
                 useTypesPrefix: false,
             }) + this.config.hooksSuffix;
-            hookFns.push(`export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>) {
+            hookFns.push(`// @ts-ignore
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>): ${this.getApolloReactHooksIdentifier()}.UseSuspenseQueryResult<${operationResultType}, ${operationVariablesTypes}>;
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>): ${this.getApolloReactHooksIdentifier()}.UseSuspenseQueryResult<${operationResultType} | undefined, ${operationVariablesTypes}>;
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>) {
           const options = baseOptions === ${this.getApolloReactHooksIdentifier()}.skipToken ? baseOptions : {...defaultOptions, ...baseOptions}
           return ${this.getApolloReactHooksIdentifier()}.useSuspenseQuery<${operationResultType}, ${operationVariablesTypes}>(${this.getDocumentNodeVariable(node, documentVariableName)}, options);
         }`);
@@ -326,8 +329,9 @@ class ReactApolloVisitor extends visitor_plugin_common_1.ClientSideBaseVisitor {
             suffix: this._getHookSuffix(nodeName, operationType),
             useTypesPrefix: false,
         }) + this.config.hooksSuffix;
+        const operationDocComment = 'description' in node ? (0, visitor_plugin_common_1.transformComment)(node.description) : '';
         const optional = hasRequiredVariables(node) ? '' : '?';
-        return `export function refetch${operationName}(variables${optional}: ${operationVariablesTypes}) {
+        return `${operationDocComment}export function refetch${operationName}(variables${optional}: ${operationVariablesTypes}) {
       return { query: ${this.getDocumentNodeVariable(node, documentVariableName)}, variables: variables }
     }`;
     }

package/esm/visitor.js

@@ -1,7 +1,7 @@
 import autoBind from 'auto-bind';
 import { camelCase, pascalCase } from 'change-case-all';
 import { Kind } from 'graphql';
-import { ClientSideBaseVisitor, DocumentMode, getConfigValue, OMIT_TYPE, } from '@graphql-codegen/visitor-plugin-common';
+import { ClientSideBaseVisitor, DocumentMode, getConfigValue, OMIT_TYPE, transformComment, } from '@graphql-codegen/visitor-plugin-common';
 const APOLLO_CLIENT_3_UNIFIED_PACKAGE = `@apollo/client`;
 const GROUPED_APOLLO_CLIENT_3_IDENTIFIER = 'Apollo';
 function hasRequiredVariables(node) {
@@ -260,7 +260,10 @@ export class ReactApolloVisitor extends ClientSideBaseVisitor {
                 suffix: pascalCase('SuspenseQuery'),
                 useTypesPrefix: false,
             }) + this.config.hooksSuffix;
-            hookFns.push(`export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>) {
+            hookFns.push(`// @ts-ignore
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>): ${this.getApolloReactHooksIdentifier()}.UseSuspenseQueryResult<${operationResultType}, ${operationVariablesTypes}>;
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>): ${this.getApolloReactHooksIdentifier()}.UseSuspenseQueryResult<${operationResultType} | undefined, ${operationVariablesTypes}>;
+export function use${suspenseOperationName}(baseOptions?: ${this.getApolloReactHooksIdentifier()}.SkipToken | ${this.getApolloReactHooksIdentifier()}.SuspenseQueryHookOptions<${operationResultType}, ${operationVariablesTypes}>) {
           const options = baseOptions === ${this.getApolloReactHooksIdentifier()}.skipToken ? baseOptions : {...defaultOptions, ...baseOptions}
           return ${this.getApolloReactHooksIdentifier()}.useSuspenseQuery<${operationResultType}, ${operationVariablesTypes}>(${this.getDocumentNodeVariable(node, documentVariableName)}, options);
         }`);
@@ -322,8 +325,9 @@ export class ReactApolloVisitor extends ClientSideBaseVisitor {
             suffix: this._getHookSuffix(nodeName, operationType),
             useTypesPrefix: false,
         }) + this.config.hooksSuffix;
+        const operationDocComment = 'description' in node ? transformComment(node.description) : '';
         const optional = hasRequiredVariables(node) ? '' : '?';
-        return `export function refetch${operationName}(variables${optional}: ${operationVariablesTypes}) {
+        return `${operationDocComment}export function refetch${operationName}(variables${optional}: ${operationVariablesTypes}) {
       return { query: ${this.getDocumentNodeVariable(node, documentVariableName)}, variables: variables }
     }`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/typescript-react-apollo",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "description": "GraphQL Code Generator plugin for generating a ready-to-use React Components/HOC/Hooks based on GraphQL operations",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"