@openapi-qraft/tanstack-query-react-plugin 2.4.1 → 2.5.0-beta.1

package/src/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.ts

@@ -3,12 +3,17 @@ import camelcase from 'camelcase';
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
+import { createOperationMethodBodyParametersExampleNode } from './lib/createOperationMethodBodyParametersExampleNode.js';
 import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseIsFetchingOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  {
+    queryableWriteOperations,
+  }: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ) => {
   const example: string[] = [
     'Monitors the number of queries currently fetching, matching the provided filters.',
@@ -37,7 +42,10 @@ export const createUseIsFetchingOperationTSDocExample = (
     '```',
   ];
 
-  if (operation.parameters?.length) {
+  if (
+    operation.parameters?.length ||
+    (queryableWriteOperations && operation.requestBody)
+  ) {
     const factory = ts.factory;
 
     example.push(
@@ -62,7 +70,15 @@ export const createUseIsFetchingOperationTSDocExample = (
                   factory.createPropertyAssignment(
                     factory.createIdentifier('parameters'),
                     factory.createObjectLiteralExpression(
-                      createOperationMethodParametersExampleNodes(operation),
+                      [
+                        queryableWriteOperations &&
+                          createOperationMethodBodyParametersExampleNode(
+                            operation
+                          ),
+                        ...createOperationMethodParametersExampleNodes(
+                          operation
+                        ),
+                      ].filter((node) => !!node),
                       true
                     )
                   ),

package/src/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.ts

@@ -3,12 +3,15 @@ import camelcase from 'camelcase';
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
+import { createOperationMethodBodyParametersExampleNode } from './lib/createOperationMethodBodyParametersExampleNode.js';
 import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseQueriesOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  options: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ) => {
   const factory = ts.factory;
 
@@ -40,7 +43,11 @@ export const createUseQueriesOperationTSDocExample = (
                     [
                       factory.createPropertyAssignment(
                         factory.createIdentifier('queries'),
-                        createQueriesArrayExpression(operation, factory)
+                        createQueriesArrayExpression(
+                          operation,
+                          factory,
+                          options
+                        )
                       ),
                     ],
                     true
@@ -89,7 +96,11 @@ export const createUseQueriesOperationTSDocExample = (
                       ),
                       factory.createPropertyAssignment(
                         factory.createIdentifier('queries'),
-                        createQueriesArrayExpression(operation, factory)
+                        createQueriesArrayExpression(
+                          operation,
+                          factory,
+                          options
+                        )
                       ),
                     ],
                     true
@@ -116,20 +127,39 @@ export const createUseQueriesOperationTSDocExample = (
 
 export const createQueriesArrayExpression = (
   operation: ServiceOperation,
-  factory: ts.NodeFactory
+  factory: ts.NodeFactory,
+  {
+    queryableWriteOperations,
+  }: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ): ts.ArrayLiteralExpression => {
   return factory.createArrayLiteralExpression(
     [
       factory.createObjectLiteralExpression(
-        createOperationMethodParametersExampleNodes(operation, (parameter) =>
-          camelcase(`${parameter.name}-1`)
-        ),
+        [
+          queryableWriteOperations &&
+            createOperationMethodBodyParametersExampleNode(
+              operation,
+              'queryBody1'
+            ),
+          ...createOperationMethodParametersExampleNodes(
+            operation,
+            (parameter) => camelcase(`${parameter.name}-1`)
+          ),
+        ].filter((node) => !!node),
         true
       ),
       factory.createObjectLiteralExpression(
-        createOperationMethodParametersExampleNodes(operation, (parameter) =>
-          camelcase(`${parameter.name}-2`)
-        ),
+        [
+          queryableWriteOperations &&
+            createOperationMethodBodyParametersExampleNode(
+              operation,
+              'queryBody2'
+            ),
+          ...createOperationMethodParametersExampleNodes(
+            operation,
+            (parameter) => camelcase(`${parameter.name}-2`)
+          ),
+        ].filter((node) => !!node),
         true
       ),
     ],

package/src/ts-factory/tsdoc/createUseQueryOperationTSDocExample.ts

@@ -2,12 +2,17 @@ import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIServ
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
+import { createOperationMethodBodyParametersExampleNode } from './lib/createOperationMethodBodyParametersExampleNode.js';
 import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseQueryOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  {
+    queryableWriteOperations,
+  }: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ) => {
   const example: string[] = [
     'Performs asynchronous data fetching, manages loading states and error handling.',
@@ -17,8 +22,8 @@ export const createUseQueryOperationTSDocExample = (
   ];
 
   if (
-    !operation.parameters?.length ||
-    operation.parameters.every((parameter) => !parameter.required)
+    !operation.parameters?.some((parameter) => parameter.required) &&
+    !(queryableWriteOperations && operation.requestBody?.required)
   ) {
     example.push(
       '@example Query without parameters',
@@ -42,7 +47,10 @@ export const createUseQueryOperationTSDocExample = (
     );
   }
 
-  if (operation.parameters?.length) {
+  if (
+    operation.parameters?.length ||
+    (queryableWriteOperations && operation.requestBody)
+  ) {
     const factory = ts.factory;
 
     example.push(
@@ -59,7 +67,11 @@ export const createUseQueryOperationTSDocExample = (
             },
             [
               factory.createObjectLiteralExpression(
-                createOperationMethodParametersExampleNodes(operation),
+                [
+                  queryableWriteOperations &&
+                    createOperationMethodBodyParametersExampleNode(operation),
+                  ...createOperationMethodParametersExampleNodes(operation),
+                ].filter((node) => !!node),
                 true
               ),
             ]

package/src/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.ts

@@ -2,13 +2,18 @@ import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIServ
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
 import { createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes } from './createUseInfiniteQueryOperationTSDocExample.js';
+import { createOperationMethodBodyParametersExampleNode } from './lib/createOperationMethodBodyParametersExampleNode.js';
 import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseSuspenseInfiniteQueryOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  {
+    queryableWriteOperations,
+  }: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ): string[] => {
   const factory = ts.factory;
 
@@ -37,12 +42,16 @@ export const createUseSuspenseInfiniteQueryOperationTSDocExample = (
           },
           [
             factory.createObjectLiteralExpression(
-              createOperationMethodParametersExampleNodes({
-                ...operation,
-                parameters: operation.parameters?.filter((parameter) =>
-                  parameter.in === 'query' ? parameter.required : true
-                ),
-              }),
+              [
+                queryableWriteOperations &&
+                  createOperationMethodBodyParametersExampleNode(operation),
+                ...createOperationMethodParametersExampleNodes({
+                  ...operation,
+                  parameters: operation.parameters?.filter((parameter) =>
+                    parameter.in === 'query' ? parameter.required : true
+                  ),
+                }),
+              ].filter((node) => !!node),
               true
             ),
             factory.createObjectLiteralExpression(

package/src/ts-factory/tsdoc/createUseSuspenseQueriesOperationTSDocExample.ts

@@ -3,6 +3,7 @@ import camelcase from 'camelcase';
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
 import {
   createCombinedResultsForEachExpression,
   createCombineFunction,
@@ -13,7 +14,8 @@ import { createOperationMethodCallExpressionExampleNode } from './lib/createOper
 
 export const createUseSuspenseQueriesOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  options: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ) => {
   const factory = ts.factory;
 
@@ -46,7 +48,11 @@ export const createUseSuspenseQueriesOperationTSDocExample = (
                     [
                       factory.createPropertyAssignment(
                         factory.createIdentifier('queries'),
-                        createQueriesArrayExpression(operation, factory)
+                        createQueriesArrayExpression(
+                          operation,
+                          factory,
+                          options
+                        )
                       ),
                     ],
                     true
@@ -95,7 +101,11 @@ export const createUseSuspenseQueriesOperationTSDocExample = (
                       ),
                       factory.createPropertyAssignment(
                         factory.createIdentifier('queries'),
-                        createQueriesArrayExpression(operation, factory)
+                        createQueriesArrayExpression(
+                          operation,
+                          factory,
+                          options
+                        )
                       ),
                     ],
                     true

package/src/ts-factory/tsdoc/createUseSuspenseQueryOperationTSDocExample.ts

@@ -2,12 +2,17 @@ import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIServ
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
+import { ServiceFactoryOptions } from '../getServiceFactory.js';
+import { createOperationMethodBodyParametersExampleNode } from './lib/createOperationMethodBodyParametersExampleNode.js';
 import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseSuspenseQueryOperationTSDocExample = (
   operation: ServiceOperation,
-  serviceVariableName: string
+  serviceVariableName: string,
+  {
+    queryableWriteOperations,
+  }: Pick<ServiceFactoryOptions, 'queryableWriteOperations'>
 ) => {
   const example: string[] = [
     'Performs asynchronous data fetching with Suspense support.',
@@ -18,8 +23,8 @@ export const createUseSuspenseQueryOperationTSDocExample = (
   ];
 
   if (
-    !operation.parameters?.length ||
-    operation.parameters.every((parameter) => !parameter.required)
+    !operation.parameters?.some((parameter) => parameter.required) &&
+    !(queryableWriteOperations && operation.requestBody?.required)
   ) {
     example.push(
       '@example Suspense Query without parameters',
@@ -43,7 +48,10 @@ export const createUseSuspenseQueryOperationTSDocExample = (
     );
   }
 
-  if (operation.parameters?.length) {
+  if (
+    operation.parameters?.length ||
+    (queryableWriteOperations && operation.requestBody)
+  ) {
     const factory = ts.factory;
 
     example.push(
@@ -60,7 +68,11 @@ export const createUseSuspenseQueryOperationTSDocExample = (
             },
             [
               factory.createObjectLiteralExpression(
-                createOperationMethodParametersExampleNodes(operation),
+                [
+                  queryableWriteOperations &&
+                    createOperationMethodBodyParametersExampleNode(operation),
+                  ...createOperationMethodParametersExampleNodes(operation),
+                ].filter((node) => !!node),
                 true
               ),
             ]

package/src/ts-factory/tsdoc/lib/createOperationMethodBodyParametersExampleNode.ts

@@ -0,0 +1,13 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
+import { factory } from 'typescript';
+
+export const createOperationMethodBodyParametersExampleNode = (
+  operation: ServiceOperation,
+  bodyVariableName = 'queryBody'
+) =>
+  operation.requestBody
+    ? factory.createPropertyAssignment(
+        factory.createIdentifier('body'),
+        factory.createIdentifier(bodyVariableName)
+      )
+    : undefined;