feat(queryKey): add optional tags parameter to query key functions

Author: ahmedrowaihi

packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts

@@ -59,6 +59,11 @@ export const createQueryKeyFunction = ({
             name: 'infinite',
             type: tsc.typeReferenceNode({ typeName: 'boolean' }),
           },
+          {
+            isRequired: false,
+            name: 'tags',
+            type: tsc.typeReferenceNode({ typeName: 'ReadonlyArray<string>' }),
+          },
         ],
         returnType: tsc.typeTupleNode({
           types: [returnType],
@@ -100,6 +105,22 @@ export const createQueryKeyFunction = ({
               ],
             }),
           }),
+          tsc.ifStatement({
+            expression: tsc.identifier({ text: 'tags' }),
+            thenStatement: tsc.block({
+              statements: [
+                tsc.expressionToStatement({
+                  expression: tsc.binaryExpression({
+                    left: tsc.propertyAccessExpression({
+                      expression: 'params',
+                      name: 'tags',
+                    }),
+                    right: tsc.identifier({ text: 'tags' }),
+                  }),
+                }),
+              ],
+            }),
+          }),
           tsc.ifStatement({
             expression: tsc.propertyAccessExpression({
               expression: optionsIdentifier,
@@ -218,10 +239,12 @@ export const createQueryKeyFunction = ({
 const createQueryKeyLiteral = ({
   id,
   isInfinite,
+  operation,
   plugin,
 }: {
   id: string;
   isInfinite?: boolean;
+  operation: IR.OperationObject;
   plugin: PluginInstance;
 }) => {
   const file = plugin.context.file({ id: plugin.name })!;
@@ -231,12 +254,23 @@ const createQueryKeyLiteral = ({
     case: plugin.config.case,
     namespace: 'value',
   });
+
+  const tagsExpression =
+    operation.tags && operation.tags.length > 0
+      ? tsc.arrayLiteralExpression({
+          elements: operation.tags.map((tag) =>
+            tsc.stringLiteral({ text: tag }),
+          ),
+        })
+      : undefined;
+
   const createQueryKeyCallExpression = tsc.callExpression({
     functionName: identifierCreateQueryKey.name || '',
     parameters: [
       tsc.ots.string(id),
       'options',
-      isInfinite ? tsc.ots.boolean(true) : undefined,
+      tsc.ots.boolean(!!isInfinite),
+      tagsExpression,
     ],
   });
   return createQueryKeyCallExpression;
@@ -259,6 +293,13 @@ export const createQueryKeyType = ({ plugin }: { plugin: PluginInstance }) => {
         keyword: 'boolean',
       }),
     },
+    {
+      isRequired: false,
+      name: 'tags',
+      type: tsc.typeReferenceNode({
+        typeName: 'ReadonlyArray<string>',
+      }),
+    },
   ];
 
   const queryKeyType = tsc.typeAliasDeclaration({
@@ -337,6 +378,7 @@ export const queryKeyStatement = ({
       statements: createQueryKeyLiteral({
         id: operation.id,
         isInfinite,
+        operation,
         plugin,
       }),
     }),