@openapi-qraft/tanstack-query-react-plugin 2.0.0-next.9 → 2.0.1-beta.0

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

@@ -1,8 +1,8 @@
-import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
 import camelcase from 'camelcase';
 import ts from 'typescript';
 import { astToString } from '../astToString.js';
-import { createOperationMethodExampleNodes } from './lib/createOperationMethodExampleNodes.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseInfiniteQueryOperationTSDocExample = (
@@ -19,38 +19,14 @@ export const createUseInfiniteQueryOperationTSDocExample = (
     '',
   ];
 
-  if (!operation.parameters?.length) {
-    return [
-      ...commonTSDoc,
-      '@example Infinite Query without parameters',
-      '```ts',
-      ...(
-        'const { data, isLoading } = ' +
-        astToString(
-          createOperationMethodExampleNodes(
-            operation,
-            {
-              serviceVariableName,
-              operationMethodName: 'useInfiniteQuery',
-            },
-            undefined
-          )
-        )
-      )
-        .trim()
-        .split('\n'),
-      '```',
-    ];
-  }
-
   return [
     ...commonTSDoc,
-    '@example Infinite Query with parameters',
+    '@example Infinite Query',
     '```ts',
     ...(
-      'const { data, isLoading } = ' +
+      'const { data, isLoading, fetchNextPage } = ' +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,
@@ -58,89 +34,102 @@ export const createUseInfiniteQueryOperationTSDocExample = (
           },
           [
             factory.createObjectLiteralExpression(
-              createOperationMethodParametersExampleNodes(operation),
+              createOperationMethodParametersExampleNodes({
+                ...operation,
+                parameters: operation.parameters?.filter((parameter) =>
+                  parameter.in === 'query' ? parameter.required : true
+                ),
+              }),
+              true
+            ),
+            factory.createObjectLiteralExpression(
+              createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(
+                operation
+              ),
               true
             ),
-            createInfiniteQueryOptionsArgumentExampleNodes(operation),
           ]
         )
       )
     )
       .trim()
       .split('\n'),
+    '',
+    'console.log(data);',
+    'fetchNextPage(); // Fetch the next page',
     '```',
   ];
 };
 
-function createInfiniteQueryOptionsArgumentExampleNodes(
+export function createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(
   operation: ServiceOperation
-): ts.ObjectLiteralExpression {
+): ts.PropertyAssignment[] {
   const factory = ts.factory;
 
-  return factory.createObjectLiteralExpression(
-    [
-      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
+  return [
+    factory.createPropertyAssignment(
+      factory.createIdentifier('initialPageParam'),
+      factory.createObjectLiteralExpression(
+        createOperationMethodParametersExampleNodes(
+          {
+            ...operation,
+            parameters: operation.parameters?.filter(
+              (parameter) => parameter.in === 'query'
             ),
-          ],
-          undefined,
-          factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
-          factory.createCallExpression(
-            factory.createIdentifier('getNextPageParams'),
+          },
+          (operationParameter) =>
+            camelcase(`initial-${operationParameter.name}`)
+        ),
+        true
+      )
+    ),
+    factory.createPropertyAssignment(
+      factory.createIdentifier('getNextPageParam'),
+      factory.createArrowFunction(
+        undefined,
+        undefined,
+        [
+          factory.createParameterDeclaration(
             undefined,
-            [factory.createIdentifier('lastPage')]
-          )
-        )
-      ),
-      factory.createPropertyAssignment(
-        factory.createIdentifier('initialPageParam'),
-        factory.createObjectLiteralExpression(
-          createOperationMethodParametersExampleNodes(
-            operation,
-            (operationParameter) =>
-              operationParameter.in === 'query'
-                ? camelcase(`initial-${operationParameter.name}`)
-                : camelcase(operationParameter.name)
+            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
           ),
-          true
+          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')]
         )
-      ),
-    ],
-    true
-  );
+      )
+    ),
+  ];
 }

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

@@ -1,8 +1,8 @@
-import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
 import camelcase from 'camelcase';
 import ts from 'typescript';
 import { astToString } from '../astToString.js';
-import { createOperationMethodExampleNodes } from './lib/createOperationMethodExampleNodes.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseIsFetchingOperationTSDocExample = (
@@ -20,7 +20,7 @@ export const createUseIsFetchingOperationTSDocExample = (
     ...(
       `const ${camelcase(operation.name + '-total')} = ` +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,
@@ -44,7 +44,7 @@ export const createUseIsFetchingOperationTSDocExample = (
       ...(
         `const ${camelcase(operation.name + '-by-parameters-total')} = ` +
         astToString(
-          createOperationMethodExampleNodes(
+          createOperationMethodCallExpressionExampleNode(
             operation,
             {
               serviceVariableName,

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

@@ -1,9 +1,9 @@
-import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
 import camelcase from 'camelcase';
 import ts from 'typescript';
 import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
 import { astToString } from '../astToString.js';
-import { createOperationMethodExampleNodes } from './lib/createOperationMethodExampleNodes.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseIsMutatingOperationTSDocExample = (
@@ -23,7 +23,7 @@ export const createUseIsMutatingOperationTSDocExample = (
     ...(
       `const ${camelcase(operation.name + '-total')} = ` +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,
@@ -42,7 +42,7 @@ export const createUseIsMutatingOperationTSDocExample = (
     ...(
       `const ${camelcase(operation.name + '-total')} = ` +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,

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

@@ -1,7 +1,7 @@
-import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
 import ts from 'typescript';
 import { astToString } from '../astToString.js';
-import { createOperationMethodExampleNodes } from './lib/createOperationMethodExampleNodes.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
 import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
 
 export const createUseMutationOperationTSDocExample = (
@@ -20,7 +20,7 @@ export const createUseMutationOperationTSDocExample = (
     ...(
       'const { mutate, isPending } = ' +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,
@@ -47,7 +47,7 @@ export const createUseMutationOperationTSDocExample = (
     ...(
       'const { mutate, isPending } = ' +
       astToString(
-        createOperationMethodExampleNodes(
+        createOperationMethodCallExpressionExampleNode(
           operation,
           {
             serviceVariableName,

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

@@ -0,0 +1,154 @@
+import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
+import camelcase from 'camelcase';
+import ts from 'typescript';
+import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
+import { astToString } from '../astToString.js';
+import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
+import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
+
+export const createUseMutationStateOperationTSDocExample = (
+  operation: ServiceOperation,
+  serviceVariableName: string
+) => {
+  const factory = ts.factory;
+
+  const example: string[] = [
+    'Provides access to the current state of a mutation, including its status, any resulting data, and associated errors.',
+    '',
+    ...createOperationCommonTSDoc(operation),
+    '@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation}',
+
+    '@example Get all variables of all running mutations.',
+    '```ts',
+    ...(
+      `const ${camelcase(operation.name + '-pending-mutation-variables')} = ` +
+      astToString(
+        createOperationMethodCallExpressionExampleNode(
+          operation,
+          {
+            serviceVariableName,
+            operationMethodName: 'useMutationState',
+          },
+          [
+            factory.createObjectLiteralExpression(
+              [
+                factory.createPropertyAssignment(
+                  factory.createIdentifier('filters'),
+                  factory.createObjectLiteralExpression(
+                    [
+                      factory.createPropertyAssignment(
+                        factory.createIdentifier('status'),
+                        factory.createStringLiteral('pending')
+                      ),
+                    ],
+                    true
+                  )
+                ),
+                factory.createPropertyAssignment(
+                  factory.createIdentifier('select'),
+                  factory.createArrowFunction(
+                    undefined,
+                    undefined,
+                    [
+                      factory.createParameterDeclaration(
+                        undefined,
+                        undefined,
+                        factory.createIdentifier('mutation'),
+                        undefined,
+                        undefined,
+                        undefined
+                      ),
+                    ],
+                    undefined,
+                    factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
+                    factory.createPropertyAccessExpression(
+                      factory.createPropertyAccessExpression(
+                        factory.createIdentifier('mutation'),
+                        factory.createIdentifier('state')
+                      ),
+                      factory.createIdentifier('variables')
+                    )
+                  )
+                ),
+              ],
+              true
+            ),
+          ]
+        )
+      )
+    )
+      .trim()
+      .split('\n'),
+    '```',
+
+    '@example Get all data for specific mutations via the `parameters`.',
+    '```ts',
+    ...(
+      `const ${camelcase(operation.name + '-mutation-data')} = ` +
+      astToString(
+        createOperationMethodCallExpressionExampleNode(
+          operation,
+          {
+            serviceVariableName,
+            operationMethodName: 'useMutationState',
+          },
+          [
+            factory.createObjectLiteralExpression(
+              [
+                factory.createPropertyAssignment(
+                  factory.createIdentifier('filters'),
+                  factory.createObjectLiteralExpression(
+                    [
+                      factory.createPropertyAssignment(
+                        factory.createIdentifier('parameters'),
+                        factory.createObjectLiteralExpression(
+                          createOperationMethodParametersExampleNodes(
+                            operation
+                          ),
+                          true
+                        )
+                      ),
+                    ],
+                    true
+                  )
+                ),
+                factory.createPropertyAssignment(
+                  factory.createIdentifier('select'),
+                  factory.createArrowFunction(
+                    undefined,
+                    undefined,
+                    [
+                      factory.createParameterDeclaration(
+                        undefined,
+                        undefined,
+                        factory.createIdentifier('mutation'),
+                        undefined,
+                        undefined,
+                        undefined
+                      ),
+                    ],
+                    undefined,
+                    factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken),
+                    factory.createPropertyAccessExpression(
+                      factory.createPropertyAccessExpression(
+                        factory.createIdentifier('mutation'),
+                        factory.createIdentifier('state')
+                      ),
+                      factory.createIdentifier('data')
+                    )
+                  )
+                ),
+              ],
+              true
+            ),
+          ]
+        )
+      )
+    )
+      .trim()
+      .split('\n'),
+    '```',
+  ];
+
+  return example;
+};