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

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

@@ -0,0 +1,204 @@
+/** This file was auto-generated by "@openapi-qraft/tanstack-query-react-plugin" codegen script. */
+import ts from "typescript";
+const factory = ts.factory;
+export const createServiceOperationUseSuspenseQueriesNodes = () => [
+  factory.createImportDeclaration(
+    undefined,
+    factory.createImportClause(
+      true,
+      undefined,
+      factory.createNamedImports([
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("UseQueryOptionsForUseSuspenseQuery")
+        ),
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("WithOptional")
+        )
+      ])
+    ),
+    factory.createStringLiteral("@openapi-qraft/tanstack-query-react-types"),
+    undefined
+  ),
+  factory.createImportDeclaration(
+    undefined,
+    factory.createImportClause(
+      true,
+      undefined,
+      factory.createNamedImports([factory.createImportSpecifier(
+        false,
+        undefined,
+        factory.createIdentifier("UseSuspenseQueryResult")
+      )])
+    ),
+    factory.createStringLiteral("@tanstack/react-query"),
+    undefined
+  ),
+  factory.createInterfaceDeclaration(
+    [factory.createToken(ts.SyntaxKind.ExportKeyword)],
+    factory.createIdentifier("ServiceOperationUseSuspenseQueries"),
+    [
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TSchema"),
+        factory.createTypeLiteralNode([
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("url"),
+            undefined,
+            factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+          ),
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("method"),
+            undefined,
+            factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+          )
+        ]),
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TQueryFnData"),
+        undefined,
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TParams"),
+        undefined,
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TError"),
+        undefined,
+        undefined
+      )
+    ],
+    undefined,
+    [factory.createMethodSignature(
+      undefined,
+      factory.createIdentifier("useSuspenseQueries"),
+      undefined,
+      [
+        factory.createTypeParameterDeclaration(
+          undefined,
+          factory.createIdentifier("T"),
+          factory.createTypeReferenceNode(
+            factory.createIdentifier("Array"),
+            [factory.createTypeReferenceNode(
+              factory.createIdentifier("UseQueryOptionsForUseSuspenseQuery"),
+              [
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TSchema"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TParams"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TQueryFnData"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TError"),
+                  undefined
+                )
+              ]
+            )]
+          ),
+          undefined
+        ),
+        factory.createTypeParameterDeclaration(
+          undefined,
+          factory.createIdentifier("TCombinedResult"),
+          undefined,
+          factory.createTypeReferenceNode(
+            factory.createIdentifier("Array"),
+            [factory.createTypeReferenceNode(
+              factory.createIdentifier("UseSuspenseQueryResult"),
+              [
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TQueryFnData"),
+                  undefined
+                ),
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TError"),
+                  undefined
+                )
+              ]
+            )]
+          )
+        )
+      ],
+      [factory.createParameterDeclaration(
+        undefined,
+        undefined,
+        factory.createIdentifier("options"),
+        undefined,
+        factory.createTypeLiteralNode([
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("queries"),
+            undefined,
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("T"),
+              undefined
+            )
+          ),
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("combine"),
+            factory.createToken(ts.SyntaxKind.QuestionToken),
+            factory.createFunctionTypeNode(
+              undefined,
+              [factory.createParameterDeclaration(
+                undefined,
+                undefined,
+                factory.createIdentifier("results"),
+                undefined,
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("Array"),
+                  [factory.createTypeReferenceNode(
+                    factory.createIdentifier("WithOptional"),
+                    [
+                      factory.createTypeReferenceNode(
+                        factory.createIdentifier("UseSuspenseQueryResult"),
+                        [
+                          factory.createTypeReferenceNode(
+                            factory.createIdentifier("TQueryFnData"),
+                            undefined
+                          ),
+                          factory.createTypeReferenceNode(
+                            factory.createIdentifier("TError"),
+                            undefined
+                          )
+                        ]
+                      ),
+                      factory.createLiteralTypeNode(factory.createStringLiteral("data"))
+                    ]
+                  )]
+                ),
+                undefined
+              )],
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TCombinedResult"),
+                undefined
+              )
+            )
+          )
+        ]),
+        undefined
+      )],
+      factory.createTypeReferenceNode(
+        factory.createIdentifier("TCombinedResult"),
+        undefined
+      )
+    )]
+  )
+];

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

@@ -0,0 +1,212 @@
+/** This file was auto-generated by "@openapi-qraft/tanstack-query-react-plugin" codegen script. */
+import ts from "typescript";
+const factory = ts.factory;
+export const createServiceOperationUseSuspenseQueryNodes = () => [
+  factory.createImportDeclaration(
+    undefined,
+    factory.createImportClause(
+      true,
+      undefined,
+      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
+  ),
+  factory.createImportDeclaration(
+    undefined,
+    factory.createImportClause(
+      true,
+      undefined,
+      factory.createNamedImports([
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("UseSuspenseQueryOptions")
+        ),
+        factory.createImportSpecifier(
+          false,
+          undefined,
+          factory.createIdentifier("UseSuspenseQueryResult")
+        )
+      ])
+    ),
+    factory.createStringLiteral("@tanstack/react-query"),
+    undefined
+  ),
+  factory.createInterfaceDeclaration(
+    [factory.createToken(ts.SyntaxKind.ExportKeyword)],
+    factory.createIdentifier("ServiceOperationUseSuspenseQuery"),
+    [
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TSchema"),
+        factory.createTypeLiteralNode([
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("url"),
+            undefined,
+            factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+          ),
+          factory.createPropertySignature(
+            undefined,
+            factory.createIdentifier("method"),
+            undefined,
+            factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+          )
+        ]),
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TQueryFnData"),
+        undefined,
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TParams"),
+        undefined,
+        undefined
+      ),
+      factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TError"),
+        undefined,
+        undefined
+      )
+    ],
+    undefined,
+    [factory.createMethodSignature(
+      undefined,
+      factory.createIdentifier("useSuspenseQuery"),
+      undefined,
+      [factory.createTypeParameterDeclaration(
+        undefined,
+        factory.createIdentifier("TData"),
+        undefined,
+        factory.createTypeReferenceNode(
+          factory.createIdentifier("TQueryFnData"),
+          undefined
+        )
+      )],
+      [
+        factory.createParameterDeclaration(
+          undefined,
+          undefined,
+          factory.createIdentifier("parameters"),
+          undefined,
+          factory.createUnionTypeNode([
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("ServiceOperationQueryKey"),
+              [
+                factory.createTypeReferenceNode(
+                  factory.createIdentifier("TSchema"),
+                  undefined
+                ),
+                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.VoidKeyword)
+              ]),
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("TParams"),
+                undefined
+              )
+            ))
+          ]),
+          undefined
+        ),
+        factory.createParameterDeclaration(
+          undefined,
+          undefined,
+          factory.createIdentifier("options"),
+          factory.createToken(ts.SyntaxKind.QuestionToken),
+          factory.createTypeReferenceNode(
+            factory.createIdentifier("Omit"),
+            [
+              factory.createTypeReferenceNode(
+                factory.createIdentifier("UseSuspenseQueryOptions"),
+                [
+                  factory.createTypeReferenceNode(
+                    factory.createIdentifier("TQueryFnData"),
+                    undefined
+                  ),
+                  factory.createTypeReferenceNode(
+                    factory.createIdentifier("TError"),
+                    undefined
+                  ),
+                  factory.createTypeReferenceNode(
+                    factory.createIdentifier("TData"),
+                    undefined
+                  ),
+                  factory.createTypeReferenceNode(
+                    factory.createIdentifier("ServiceOperationQueryKey"),
+                    [
+                      factory.createTypeReferenceNode(
+                        factory.createIdentifier("TSchema"),
+                        undefined
+                      ),
+                      factory.createTypeReferenceNode(
+                        factory.createIdentifier("TParams"),
+                        undefined
+                      )
+                    ]
+                  )
+                ]
+              ),
+              factory.createLiteralTypeNode(factory.createStringLiteral("queryKey"))
+            ]
+          ),
+          undefined
+        )
+      ],
+      factory.createTypeReferenceNode(
+        factory.createIdentifier("UseSuspenseQueryResult"),
+        [
+          factory.createTypeReferenceNode(
+            factory.createIdentifier("TData"),
+            undefined
+          ),
+          factory.createUnionTypeNode([
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("TError"),
+              undefined
+            ),
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("Error"),
+              undefined
+            )
+          ])
+        ]
+      )
+    )]
+  )
+];

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

@@ -0,0 +1,65 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+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/getServices';
+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')]
+        )
+      )
+    ),
+  ];
+}

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

@@ -0,0 +1,81 @@
+import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/getServices';
+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 createUseIsFetchingOperationTSDocExample = (
+  operation: ServiceOperation,
+  serviceVariableName: string
+) => {
+  const example: string[] = [
+    'Monitors the number of queries currently fetching, matching the provided filters.',
+    'Useful for creating loading indicators or performing actions based on active requests.',
+    '',
+    '@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation}',
+    '@example Checks the total number of queries fetching from the specified service method,',
+    'both normal and infinite. If no parameters are provided, no filtering is applied.',
+    '```ts',
+    ...(
+      `const ${camelcase(operation.name + '-total')} = ` +
+      astToString(
+        createOperationMethodCallExpressionExampleNode(
+          operation,
+          {
+            serviceVariableName,
+            operationMethodName: 'useIsFetching',
+          },
+          undefined
+        )
+      )
+    )
+      .trim()
+      .split('\n'),
+    '```',
+  ];
+
+  if (operation.parameters?.length) {
+    const factory = ts.factory;
+
+    example.push(
+      '@example Checks the number of normal queries fetching with the specified parameters.',
+      '```ts',
+      ...(
+        `const ${camelcase(operation.name + '-by-parameters-total')} = ` +
+        astToString(
+          createOperationMethodCallExpressionExampleNode(
+            operation,
+            {
+              serviceVariableName,
+              operationMethodName: 'useIsFetching',
+            },
+            [
+              factory.createObjectLiteralExpression(
+                [
+                  factory.createPropertyAssignment(
+                    factory.createIdentifier('infinite'),
+                    factory.createFalse()
+                  ),
+                  factory.createPropertyAssignment(
+                    factory.createIdentifier('parameters'),
+                    factory.createObjectLiteralExpression(
+                      createOperationMethodParametersExampleNodes(operation),
+                      true
+                    )
+                  ),
+                ],
+                true
+              ),
+            ]
+          )
+        )
+      )
+        .trim()
+        .split('\n'),
+      '```'
+    );
+  }
+
+  return example;
+};