@graphql-codegen/typescript-react-query 5.0.0-alpha-20230524114330-5ff6385cd → 5.0.0-alpha-20230524165521-e9c8bb8f4

package/cjs/variables-generator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMutationKeyMaker = exports.generateMutationKey = exports.generateQueryKeyMaker = exports.generateQueryKey = exports.generateInfiniteQueryKeyMaker = exports.generateInfiniteQueryKey = exports.generateQueryVariablesSignature = void 0;
+exports.generateMutationKeyMaker = exports.generateMutationKey = exports.generateQueryRootKeyMaker = exports.generateQueryKeyMaker = exports.generateQueryKey = exports.generateInfiniteQueryRootKeyMaker = exports.generateInfiniteQueryKeyMaker = exports.generateInfiniteQueryKey = exports.generateQueryVariablesSignature = void 0;
 function generateQueryVariablesSignature(hasRequiredVariables, operationVariablesTypes) {
     return `variables${hasRequiredVariables ? '' : '?'}: ${operationVariablesTypes}`;
 }
@@ -16,6 +16,10 @@ function generateInfiniteQueryKeyMaker(node, operationName, operationVariablesTy
     return `\nuseInfinite${operationName}.getKey = (${signature}) => ${generateInfiniteQueryKey(node, hasRequiredVariables)};\n`;
 }
 exports.generateInfiniteQueryKeyMaker = generateInfiniteQueryKeyMaker;
+function generateInfiniteQueryRootKeyMaker(node, operationName) {
+    return `\nuseInfinite${operationName}.rootKey = '${node.name.value}.infinite';\n`;
+}
+exports.generateInfiniteQueryRootKeyMaker = generateInfiniteQueryRootKeyMaker;
 function generateQueryKey(node, hasRequiredVariables) {
     if (hasRequiredVariables)
         return `['${node.name.value}', variables]`;
@@ -27,6 +31,10 @@ function generateQueryKeyMaker(node, operationName, operationVariablesTypes, has
     return `\nuse${operationName}.getKey = (${signature}) => ${generateQueryKey(node, hasRequiredVariables)};\n`;
 }
 exports.generateQueryKeyMaker = generateQueryKeyMaker;
+function generateQueryRootKeyMaker(node, operationName) {
+    return `\nuse${operationName}.rootKey = '${node.name.value}';\n`;
+}
+exports.generateQueryRootKeyMaker = generateQueryRootKeyMaker;
 function generateMutationKey(node) {
     return `['${node.name.value}']`;
 }

package/cjs/visitor.js

@@ -17,6 +17,7 @@ class ReactQueryVisitor extends visitor_plugin_common_1.ClientSideBaseVisitor {
             errorType: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.errorType, 'unknown'),
             exposeDocument: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.exposeDocument, false),
             exposeQueryKeys: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.exposeQueryKeys, false),
+            exposeQueryRootKeys: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.exposeQueryRootKeys, false),
             exposeMutationKeys: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.exposeMutationKeys, false),
             exposeFetcher: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.exposeFetcher, false),
             addInfiniteQuery: (0, visitor_plugin_common_1.getConfigValue)(rawConfig.addInfiniteQuery, false),
@@ -110,11 +111,17 @@ class ReactQueryVisitor extends visitor_plugin_common_1.ClientSideBaseVisitor {
             if (this.config.exposeQueryKeys) {
                 query += `\n${(0, variables_generator_js_1.generateQueryKeyMaker)(node, operationName, operationVariablesTypes, hasRequiredVariables)};\n`;
             }
+            if (this.config.exposeQueryRootKeys) {
+                query += `\n${(0, variables_generator_js_1.generateQueryRootKeyMaker)(node, operationName)}`;
+            }
             if (this.config.addInfiniteQuery) {
                 query += `\n${this.fetcher.generateInfiniteQueryHook(node, documentVariableName, operationName, operationResultType, operationVariablesTypes, hasRequiredVariables)}\n`;
                 if (this.config.exposeQueryKeys) {
                     query += `\n${(0, variables_generator_js_1.generateInfiniteQueryKeyMaker)(node, operationName, operationVariablesTypes, hasRequiredVariables)};\n`;
                 }
+                if (this.config.exposeQueryRootKeys) {
+                    query += `\n${(0, variables_generator_js_1.generateInfiniteQueryRootKeyMaker)(node, operationName)}`;
+                }
             }
             // The reason we're looking at the private field of the CustomMapperFetcher to see if it's a react hook
             // is to prevent calling generateFetcherFetch for each query since all the queries won't be able to generate

package/esm/variables-generator.js

@@ -10,6 +10,9 @@ export function generateInfiniteQueryKeyMaker(node, operationName, operationVari
     const signature = generateQueryVariablesSignature(hasRequiredVariables, operationVariablesTypes);
     return `\nuseInfinite${operationName}.getKey = (${signature}) => ${generateInfiniteQueryKey(node, hasRequiredVariables)};\n`;
 }
+export function generateInfiniteQueryRootKeyMaker(node, operationName) {
+    return `\nuseInfinite${operationName}.rootKey = '${node.name.value}.infinite';\n`;
+}
 export function generateQueryKey(node, hasRequiredVariables) {
     if (hasRequiredVariables)
         return `['${node.name.value}', variables]`;
@@ -19,6 +22,9 @@ export function generateQueryKeyMaker(node, operationName, operationVariablesTyp
     const signature = generateQueryVariablesSignature(hasRequiredVariables, operationVariablesTypes);
     return `\nuse${operationName}.getKey = (${signature}) => ${generateQueryKey(node, hasRequiredVariables)};\n`;
 }
+export function generateQueryRootKeyMaker(node, operationName) {
+    return `\nuse${operationName}.rootKey = '${node.name.value}';\n`;
+}
 export function generateMutationKey(node) {
     return `['${node.name.value}']`;
 }

package/esm/visitor.js

@@ -5,7 +5,7 @@ import { CustomMapperFetcher } from './fetcher-custom-mapper.js';
 import { HardcodedFetchFetcher } from './fetcher-fetch-hardcoded.js';
 import { FetchFetcher } from './fetcher-fetch.js';
 import { GraphQLRequestClientFetcher } from './fetcher-graphql-request.js';
-import { generateInfiniteQueryKeyMaker, generateMutationKeyMaker, generateQueryKeyMaker, } from './variables-generator.js';
+import { generateInfiniteQueryKeyMaker, generateInfiniteQueryRootKeyMaker, generateMutationKeyMaker, generateQueryKeyMaker, generateQueryRootKeyMaker, } from './variables-generator.js';
 export class ReactQueryVisitor extends ClientSideBaseVisitor {
     constructor(schema, fragments, rawConfig, documents) {
         super(schema, fragments, rawConfig, {
@@ -13,6 +13,7 @@ export class ReactQueryVisitor extends ClientSideBaseVisitor {
             errorType: getConfigValue(rawConfig.errorType, 'unknown'),
             exposeDocument: getConfigValue(rawConfig.exposeDocument, false),
             exposeQueryKeys: getConfigValue(rawConfig.exposeQueryKeys, false),
+            exposeQueryRootKeys: getConfigValue(rawConfig.exposeQueryRootKeys, false),
             exposeMutationKeys: getConfigValue(rawConfig.exposeMutationKeys, false),
             exposeFetcher: getConfigValue(rawConfig.exposeFetcher, false),
             addInfiniteQuery: getConfigValue(rawConfig.addInfiniteQuery, false),
@@ -106,11 +107,17 @@ export class ReactQueryVisitor extends ClientSideBaseVisitor {
             if (this.config.exposeQueryKeys) {
                 query += `\n${generateQueryKeyMaker(node, operationName, operationVariablesTypes, hasRequiredVariables)};\n`;
             }
+            if (this.config.exposeQueryRootKeys) {
+                query += `\n${generateQueryRootKeyMaker(node, operationName)}`;
+            }
             if (this.config.addInfiniteQuery) {
                 query += `\n${this.fetcher.generateInfiniteQueryHook(node, documentVariableName, operationName, operationResultType, operationVariablesTypes, hasRequiredVariables)}\n`;
                 if (this.config.exposeQueryKeys) {
                     query += `\n${generateInfiniteQueryKeyMaker(node, operationName, operationVariablesTypes, hasRequiredVariables)};\n`;
                 }
+                if (this.config.exposeQueryRootKeys) {
+                    query += `\n${generateInfiniteQueryRootKeyMaker(node, operationName)}`;
+                }
             }
             // The reason we're looking at the private field of the CustomMapperFetcher to see if it's a react hook
             // is to prevent calling generateFetcherFetch for each query since all the queries won't be able to generate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/typescript-react-query",
-  "version": "5.0.0-alpha-20230524114330-5ff6385cd",
+  "version": "5.0.0-alpha-20230524165521-e9c8bb8f4",
   "description": "GraphQL Code Generator plugin for generating a ready-to-use React-Query 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"
@@ -10,7 +10,7 @@
     "@graphql-codegen/visitor-plugin-common": "2.13.1",
     "auto-bind": "~4.0.0",
     "change-case-all": "1.0.15",
-    "tslib": "~2.4.0"
+    "tslib": "~2.5.0"
   },
   "repository": {
     "type": "git",

package/typings/config.d.cts

@@ -51,6 +51,17 @@ export interface ReactQueryRawPluginConfig extends Omit<RawClientSideBasePluginC
      * ```
      */
     exposeQueryKeys?: boolean;
+    /**
+     * @default false
+     * @description For each generate query hook adds rootKey. Useful for cache updates.
+     * @exampleMarkdown
+     * ```ts
+     * const query = useUserDetailsQuery(...)
+     * const key = useUserDetailsQuery.rootKey
+     * // use key in a cache update after a mutation
+     * ```
+     */
+    exposeQueryRootKeys?: boolean;
     /**
      * @default false
      * @description For each generate mutation hook adds getKey() function. Useful for call outside of functional component.

package/typings/config.d.ts

@@ -51,6 +51,17 @@ export interface ReactQueryRawPluginConfig extends Omit<RawClientSideBasePluginC
      * ```
      */
     exposeQueryKeys?: boolean;
+    /**
+     * @default false
+     * @description For each generate query hook adds rootKey. Useful for cache updates.
+     * @exampleMarkdown
+     * ```ts
+     * const query = useUserDetailsQuery(...)
+     * const key = useUserDetailsQuery.rootKey
+     * // use key in a cache update after a mutation
+     * ```
+     */
+    exposeQueryRootKeys?: boolean;
     /**
      * @default false
      * @description For each generate mutation hook adds getKey() function. Useful for call outside of functional component.

package/typings/variables-generator.d.cts

@@ -2,7 +2,9 @@ import { OperationDefinitionNode } from 'graphql';
 export declare function generateQueryVariablesSignature(hasRequiredVariables: boolean, operationVariablesTypes: string): string;
 export declare function generateInfiniteQueryKey(node: OperationDefinitionNode, hasRequiredVariables: boolean): string;
 export declare function generateInfiniteQueryKeyMaker(node: OperationDefinitionNode, operationName: string, operationVariablesTypes: string, hasRequiredVariables: boolean): string;
+export declare function generateInfiniteQueryRootKeyMaker(node: OperationDefinitionNode, operationName: string): string;
 export declare function generateQueryKey(node: OperationDefinitionNode, hasRequiredVariables: boolean): string;
 export declare function generateQueryKeyMaker(node: OperationDefinitionNode, operationName: string, operationVariablesTypes: string, hasRequiredVariables: boolean): string;
+export declare function generateQueryRootKeyMaker(node: OperationDefinitionNode, operationName: string): string;
 export declare function generateMutationKey(node: OperationDefinitionNode): string;
 export declare function generateMutationKeyMaker(node: OperationDefinitionNode, operationName: string): string;

package/typings/variables-generator.d.ts

@@ -2,7 +2,9 @@ import { OperationDefinitionNode } from 'graphql';
 export declare function generateQueryVariablesSignature(hasRequiredVariables: boolean, operationVariablesTypes: string): string;
 export declare function generateInfiniteQueryKey(node: OperationDefinitionNode, hasRequiredVariables: boolean): string;
 export declare function generateInfiniteQueryKeyMaker(node: OperationDefinitionNode, operationName: string, operationVariablesTypes: string, hasRequiredVariables: boolean): string;
+export declare function generateInfiniteQueryRootKeyMaker(node: OperationDefinitionNode, operationName: string): string;
 export declare function generateQueryKey(node: OperationDefinitionNode, hasRequiredVariables: boolean): string;
 export declare function generateQueryKeyMaker(node: OperationDefinitionNode, operationName: string, operationVariablesTypes: string, hasRequiredVariables: boolean): string;
+export declare function generateQueryRootKeyMaker(node: OperationDefinitionNode, operationName: string): string;
 export declare function generateMutationKey(node: OperationDefinitionNode): string;
 export declare function generateMutationKeyMaker(node: OperationDefinitionNode, operationName: string): string;

package/typings/visitor.d.cts

@@ -7,6 +7,7 @@ export interface ReactQueryPluginConfig extends ClientSideBasePluginConfig {
     errorType: string;
     exposeDocument: boolean;
     exposeQueryKeys: boolean;
+    exposeQueryRootKeys: boolean;
     exposeMutationKeys: boolean;
     exposeFetcher: boolean;
     addInfiniteQuery: boolean;

package/typings/visitor.d.ts

@@ -7,6 +7,7 @@ export interface ReactQueryPluginConfig extends ClientSideBasePluginConfig {
     errorType: string;
     exposeDocument: boolean;
     exposeQueryKeys: boolean;
+    exposeQueryRootKeys: boolean;
     exposeMutationKeys: boolean;
     exposeFetcher: boolean;
     addInfiniteQuery: boolean;