@openapi-qraft/tanstack-query-react-plugin 2.0.0-next.8 → 2.0.0

package/src/ts-factory/service-operation.generated/ServiceOperationMutationFn.ts

@@ -73,24 +73,7 @@ export const createServiceOperationMutationFnNodes = () => [
     ],
     undefined,
     [factory.createCallSignature(
-      [factory.createTypeParameterDeclaration(
-        undefined,
-        factory.createIdentifier("TOptions"),
-        factory.createTypeReferenceNode(
-          factory.createIdentifier("ServiceOperationMutationFnOptions"),
-          [
-            factory.createTypeReferenceNode(
-              factory.createIdentifier("TBody"),
-              undefined
-            ),
-            factory.createTypeReferenceNode(
-              factory.createIdentifier("TParams"),
-              undefined
-            )
-          ]
-        ),
-        undefined
-      )],
+      undefined,
       [
         factory.createParameterDeclaration(
           undefined,
@@ -98,8 +81,17 @@ export const createServiceOperationMutationFnNodes = () => [
           factory.createIdentifier("options"),
           undefined,
           factory.createTypeReferenceNode(
-            factory.createIdentifier("TOptions"),
-            undefined
+            factory.createIdentifier("ServiceOperationMutationFnOptions"),
+            [
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TBody"),
+                undefined
+              ),
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TParams"),
+                undefined
+              )
+            ]
           ),
           undefined
         ),
@@ -128,8 +120,17 @@ export const createServiceOperationMutationFnNodes = () => [
                 factory.createIdentifier("options"),
                 undefined,
                 factory.createTypeReferenceNode(
-                  factory.createIdentifier("TOptions"),
-                  undefined
+                  factory.createIdentifier("ServiceOperationMutationFnOptions"),
+                  [
+                    factory.createTypeReferenceNode(
+                      factory.createIdentifier("TBody"),
+                      undefined
+                    ),
+                    factory.createTypeReferenceNode(
+                      factory.createIdentifier("TParams"),
+                      undefined
+                    )
+                  ]
                 ),
                 undefined
               )

package/src/ts-factory/service-operation.generated/ServiceOperationQueryFn.ts

@@ -109,57 +109,57 @@ export const createServiceOperationQueryFnNodes = () => [
           undefined,
           factory.createIdentifier("options"),
           undefined,
-          factory.createConditionalTypeNode(
+          factory.createUnionTypeNode([
             factory.createTypeReferenceNode(
-              factory.createIdentifier("AreAllOptional"),
-              [factory.createTypeReferenceNode(
-                factory.createIdentifier("TParams"),
-                undefined
-              )]
+              factory.createIdentifier("QueryFnOptionsByQueryKey"),
+              [
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TSchema"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TMeta"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TSignal"),
+                  undefined
+                )
+              ]
             ),
-            factory.createLiteralTypeNode(factory.createTrue()),
-            factory.createUnionTypeNode([
-              factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword),
+            factory.createParenthesizedType(factory.createConditionalTypeNode(
               factory.createTypeReferenceNode(
-                factory.createIdentifier("QueryFnOptionsByParameters"),
-                [
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TParams"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TMeta"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TSignal"),
-                    undefined
-                  )
-                ]
+                factory.createIdentifier("AreAllOptional"),
+                [factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                )]
               ),
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("QueryFnOptionsByQueryKey"),
-                [
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TSchema"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TParams"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TMeta"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TSignal"),
-                    undefined
-                  )
-                ]
-              )
-            ]),
-            factory.createUnionTypeNode([
+              factory.createLiteralTypeNode(factory.createTrue()),
+              factory.createUnionTypeNode([
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("QueryFnOptionsByParameters"),
+                  [
+                    factory.createTypeReferenceNode(
+                      factory.createIdentifier("TParams"),
+                      undefined
+                    ),
+                    factory.createTypeReferenceNode(
+                      factory.createIdentifier("TMeta"),
+                      undefined
+                    ),
+                    factory.createTypeReferenceNode(
+                      factory.createIdentifier("TSignal"),
+                      undefined
+                    )
+                  ]
+                ),
+                factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword)
+              ]),
               factory.createTypeReferenceNode(
                 factory.createIdentifier("QueryFnOptionsByParameters"),
                 [
@@ -176,30 +176,9 @@ export const createServiceOperationQueryFnNodes = () => [
                     undefined
                   )
                 ]
-              ),
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("QueryFnOptionsByQueryKey"),
-                [
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TSchema"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TParams"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TMeta"),
-                    undefined
-                  ),
-                  factory.createTypeReferenceNode(
-                    factory.createIdentifier("TSignal"),
-                    undefined
-                  )
-                ]
               )
-            ])
-          ),
+            ))
+          ]),
           undefined
         ),
         factory.createParameterDeclaration(

package/src/ts-factory/service-operation.generated/ServiceOperationSetQueryData.ts

@@ -7,11 +7,18 @@ export const createServiceOperationSetQueryDataNodes = () => [
     factory.createImportClause(
       true,
       undefined,
-      factory.createNamedImports([factory.createImportSpecifier(
-        false,
-        undefined,
-        factory.createIdentifier("ServiceOperationQueryKey")
-      )])
+      factory.createNamedImports([
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("AreAllOptional")
+        ),
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("ServiceOperationQueryKey")
+        )
+      ])
     ),
     factory.createStringLiteral("@openapi-qraft/tanstack-query-react-types"),
     undefined
@@ -75,7 +82,7 @@ export const createServiceOperationSetQueryDataNodes = () => [
         undefined,
         factory.createIdentifier("TParams"),
         undefined,
-        factory.createTypeLiteralNode([])
+        undefined
       )
     ],
     undefined,
@@ -91,10 +98,27 @@ export const createServiceOperationSetQueryDataNodes = () => [
           factory.createIdentifier("parameters"),
           undefined,
           factory.createUnionTypeNode([
-            factory.createTypeReferenceNode(
-              factory.createIdentifier("TParams"),
-              undefined
-            ),
+            factory.createParenthesizedType(factory.createConditionalTypeNode(
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("AreAllOptional"),
+                [factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                )]
+              ),
+              factory.createLiteralTypeNode(factory.createTrue()),
+              factory.createUnionTypeNode([
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                ),
+                factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword)
+              ]),
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TParams"),
+                undefined
+              )
+            )),
             factory.createTypeReferenceNode(
               factory.createIdentifier("ServiceOperationQueryKey"),
               [

package/src/ts-factory/service-operation.generated/ServiceOperationUseMutation.ts

@@ -139,17 +139,8 @@ export const createServiceOperationUseMutationNodes = () => [
             undefined,
             factory.createIdentifier("TVariables"),
             factory.createTypeReferenceNode(
-              factory.createIdentifier("MutationVariables"),
-              [
-                factory.createTypeReferenceNode(
-                  factory.createIdentifier("TBody"),
-                  undefined
-                ),
-                factory.createTypeReferenceNode(
-                  factory.createIdentifier("TParams"),
-                  undefined
-                )
-              ]
+              factory.createIdentifier("TBody"),
+              undefined
             ),
             undefined
           ),
@@ -165,8 +156,11 @@ export const createServiceOperationUseMutationNodes = () => [
             undefined,
             undefined,
             factory.createIdentifier("parameters"),
-            factory.createToken(ts.SyntaxKind.QuestionToken),
-            factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword),
+            undefined,
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("TParams"),
+              undefined
+            ),
             undefined
           ),
           factory.createParameterDeclaration(
@@ -223,9 +217,26 @@ export const createServiceOperationUseMutationNodes = () => [
                 undefined
               )
             ]),
-            factory.createTypeReferenceNode(
-              factory.createIdentifier("TVariables"),
-              undefined
+            factory.createConditionalTypeNode(
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("AreAllOptional"),
+                [factory.createTypeReferenceNode(
+                  factory.createIdentifier("TVariables"),
+                  undefined
+                )]
+              ),
+              factory.createLiteralTypeNode(factory.createTrue()),
+              factory.createUnionTypeNode([
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TVariables"),
+                  undefined
+                ),
+                factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword)
+              ]),
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TVariables"),
+                undefined
+              )
             ),
             factory.createTypeReferenceNode(
               factory.createIdentifier("TContext"),
@@ -243,8 +254,17 @@ export const createServiceOperationUseMutationNodes = () => [
             undefined,
             factory.createIdentifier("TVariables"),
             factory.createTypeReferenceNode(
-              factory.createIdentifier("TBody"),
-              undefined
+              factory.createIdentifier("MutationVariables"),
+              [
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TBody"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                )
+              ]
             ),
             undefined
           ),
@@ -261,27 +281,7 @@ export const createServiceOperationUseMutationNodes = () => [
             undefined,
             factory.createIdentifier("parameters"),
             undefined,
-            factory.createConditionalTypeNode(
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("AreAllOptional"),
-                [factory.createTypeReferenceNode(
-                  factory.createIdentifier("TParams"),
-                  undefined
-                )]
-              ),
-              factory.createLiteralTypeNode(factory.createTrue()),
-              factory.createUnionTypeNode([
-                factory.createTypeReferenceNode(
-                  factory.createIdentifier("TParams"),
-                  undefined
-                ),
-                factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword)
-              ]),
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("TParams"),
-                undefined
-              )
-            ),
+            factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword),
             undefined
           ),
           factory.createParameterDeclaration(
@@ -338,26 +338,9 @@ export const createServiceOperationUseMutationNodes = () => [
                 undefined
               )
             ]),
-            factory.createConditionalTypeNode(
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("AreAllOptional"),
-                [factory.createTypeReferenceNode(
-                  factory.createIdentifier("TVariables"),
-                  undefined
-                )]
-              ),
-              factory.createLiteralTypeNode(factory.createTrue()),
-              factory.createUnionTypeNode([
-                factory.createTypeReferenceNode(
-                  factory.createIdentifier("TVariables"),
-                  undefined
-                ),
-                factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword)
-              ]),
-              factory.createTypeReferenceNode(
-                factory.createIdentifier("TVariables"),
-                undefined
-              )
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("TVariables"),
+              undefined
             ),
             factory.createTypeReferenceNode(
               factory.createIdentifier("TContext"),

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

@@ -0,0 +1,65 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
+import { createUseInfiniteQueryOperationTSDocExample } from './createUseInfiniteQueryOperationTSDocExample.js';
+import { createUseIsFetchingOperationTSDocExample } from './createUseIsFetchingOperationTSDocExample.js';
+import { createUseIsMutatingOperationTSDocExample } from './createUseIsMutatingOperationTSDocExample.js';
+import { createUseMutationOperationTSDocExample } from './createUseMutationOperationTSDocExample.js';
+import { createUseMutationStateOperationTSDocExample } from './createUseMutationStateOperationTSDocExample.js';
+import { createUseQueriesOperationTSDocExample } from './createUseQueriesOperationTSDocExample.js';
+import { createUseQueryOperationTSDocExample } from './createUseQueryOperationTSDocExample.js';
+import { createUseSuspenseInfiniteQueryOperationTSDocExample } from './createUseSuspenseInfiniteQueryOperationTSDocExample.js';
+
+export const createOperationMethodTSDocExample = (
+  operation: ServiceOperation,
+  {
+    serviceVariableName,
+    operationMethodName,
+  }: {
+    serviceVariableName: string;
+    operationMethodName: string;
+  }
+) => {
+  switch (operationMethodName) {
+    case 'useQuery':
+      return createUseQueryOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useMutation':
+      return createUseMutationOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useInfiniteQuery':
+      return createUseInfiniteQueryOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useIsFetching':
+      return createUseIsFetchingOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useIsMutating':
+      return createUseIsMutatingOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useMutationState':
+      return createUseMutationStateOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useQueries':
+      return createUseQueriesOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    case 'useSuspenseInfiniteQuery':
+      return createUseSuspenseInfiniteQueryOperationTSDocExample(
+        operation,
+        serviceVariableName
+      );
+    default:
+      return undefined;
+  }
+};

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

@@ -0,0 +1,135 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
+import camelcase from 'camelcase';
+import ts from 'typescript';
+import { astToString } from '../astToString.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
+import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
+
+export const createUseInfiniteQueryOperationTSDocExample = (
+  operation: ServiceOperation,
+  serviceVariableName: string
+): string[] => {
+  const factory = ts.factory;
+
+  const commonTSDoc = [
+    'Performs asynchronous data fetching with support for infinite scrolling scenarios.',
+    'Manages paginated data and provides utilities for fetching additional pages.',
+    '',
+    '@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation}',
+    '',
+  ];
+
+  return [
+    ...commonTSDoc,
+    '@example Infinite Query',
+    '```ts',
+    ...(
+      'const { data, isLoading, fetchNextPage } = ' +
+      astToString(
+        createOperationMethodCallExpressionExampleNode(
+          operation,
+          {
+            serviceVariableName,
+            operationMethodName: 'useInfiniteQuery',
+          },
+          [
+            factory.createObjectLiteralExpression(
+              createOperationMethodParametersExampleNodes({
+                ...operation,
+                parameters: operation.parameters?.filter((parameter) =>
+                  parameter.in === 'query' ? parameter.required : true
+                ),
+              }),
+              true
+            ),
+            factory.createObjectLiteralExpression(
+              createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(
+                operation
+              ),
+              true
+            ),
+          ]
+        )
+      )
+    )
+      .trim()
+      .split('\n'),
+    '',
+    'console.log(data);',
+    'fetchNextPage(); // Fetch the next page',
+    '```',
+  ];
+};
+
+export function createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(
+  operation: ServiceOperation
+): ts.PropertyAssignment[] {
+  const factory = ts.factory;
+
+  return [
+    factory.createPropertyAssignment(
+      factory.createIdentifier('initialPageParam'),
+      factory.createObjectLiteralExpression(
+        createOperationMethodParametersExampleNodes(
+          {
+            ...operation,
+            parameters: operation.parameters?.filter(
+              (parameter) => parameter.in === 'query'
+            ),
+          },
+          (operationParameter) =>
+            camelcase(`initial-${operationParameter.name}`)
+        ),
+        true
+      )
+    ),
+    factory.createPropertyAssignment(
+      factory.createIdentifier('getNextPageParam'),
+      factory.createArrowFunction(
+        undefined,
+        undefined,
+        [
+          factory.createParameterDeclaration(
+            undefined,
+            undefined,
+            factory.createIdentifier('lastPage'),
+            undefined,
+            undefined,
+            undefined
+          ),
+          factory.createParameterDeclaration(
+            undefined,
+            undefined,
+            factory.createIdentifier('allPages'),
+            undefined,
+            undefined,
+            undefined
+          ),
+          factory.createParameterDeclaration(
+            undefined,
+            undefined,
+            factory.createIdentifier('lastPageParam'),
+            undefined,
+            undefined,
+            undefined
+          ),
+          factory.createParameterDeclaration(
+            undefined,
+            undefined,
+            factory.createIdentifier('allPageParams'),
+            undefined,
+            undefined,
+            undefined
+          ),
+        ],
+        undefined,
+        factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
+        factory.createCallExpression(
+          factory.createIdentifier('getNextPageParams'),
+          undefined,
+          [factory.createIdentifier('lastPage')]
+        )
+      )
+    ),
+  ];
+}