feat: add support for --default-client-callbacks option for the createAPIOperationClient()

Author: radist2s

packages/react-client/package.json

@@ -10,7 +10,7 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint",
     "clean": "rimraf dist/",
-    "codegen": "openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript ../test-fixtures/openapi.json -rm -o src/tests/fixtures/api --openapi-types-file-name openapi.ts --explicit-import-extensions --filter-services '/approval_policies/**,/entities/**,/files/**,!/internal/**' --operation-predefined-parameters '/approval_policies/{approval_policy_id}/**:header.x-monite-entity-id' '/entities/{entity_id}/documents:header.x-monite-version' --operation-name-modifier '/files/list:[a-zA-Z]+List ==> findAll' && yarn _prettify-api",
+    "codegen": "openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript ../test-fixtures/openapi.json -rm -o src/tests/fixtures/api --openapi-types-file-name openapi.ts --explicit-import-extensions --filter-services '/approval_policies/**,/entities/**,/files/**,!/internal/**' --default-client-callbacks all --operation-predefined-parameters '/approval_policies/{approval_policy_id}/**:header.x-monite-entity-id' '/entities/{entity_id}/documents:header.x-monite-version' --operation-name-modifier '/files/list:[a-zA-Z]+List ==> findAll' && yarn _prettify-api",
     "_prettify-api": "prettier --write src/tests/fixtures/api/**/*.ts"
   },
   "sideEffects": false,

packages/tanstack-query-react-plugin/src/generateCode.ts

@@ -23,6 +23,7 @@ interface OutputOptions extends OutputOptionsBase {
   explicitImportExtensions: '.js' | '.ts' | undefined;
   exportSchemaTypes: boolean | undefined;
   operationPredefinedParameters: Array<PredefinedParametersGlob> | undefined;
+  defaultClientCallbacks: string[] | ['all'] | ['none'] | undefined;
 }
 
 export const generateCode = async ({
@@ -184,7 +185,11 @@ const generateOperationClient = async (spinner: Ora, output: OutputOptions) => {
   const operationClientFiles: GeneratorFile[] = [];
 
   try {
-    const code = astToString(getOperationClientFactory());
+    const code = astToString(
+      getOperationClientFactory({
+        defaultClientCallbacks: output.defaultClientCallbacks,
+      })
+    );
 
     operationClientFiles.push({
       file: new URL('create-api-operation-client.ts', output.dir),

packages/tanstack-query-react-plugin/src/plugin.ts

@@ -1,3 +1,5 @@
+import type { Ora } from 'ora';
+import process from 'node:process';
 import { fileHeader } from '@openapi-qraft/plugin/lib/fileHeader';
 import {
   createPredefinedParametersGlobs,
@@ -7,6 +9,7 @@ import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
 import { QraftCommandPlugin } from '@openapi-qraft/plugin/lib/QraftCommandPlugin';
 import { Option } from 'commander';
 import { generateCode } from './generateCode.js';
+import { getAllAvailableCallbackNames } from './ts-factory/getCallbackNames.js';
 
 export const plugin: QraftCommandPlugin = {
   setupCommand(command: QraftCommand) {
@@ -31,7 +34,17 @@ export const plugin: QraftCommandPlugin = {
           return arg?.toLowerCase() !== 'false';
         }
       )
+      .addOption(
+        new Option(
+          '--default-client-callbacks <callbacks...>',
+          'List of default API client methods and hooks that will be available by default. These can be overridden at runtime if needed..'
+        )
+          .choices(['all', 'none', ...getAllAvailableCallbackNames()])
+          .default(['all'])
+      )
       .action(async ({ spinner, output, args, services, schema }, resolve) => {
+        validateDefaultCallbacks(args.defaultClientCallbacks, spinner);
+
         return void (await generateCode({
           spinner,
           services,
@@ -44,6 +57,9 @@ export const plugin: QraftCommandPlugin = {
             explicitImportExtensions: args.explicitImportExtensions,
             servicesDirName: 'services',
             exportSchemaTypes: args.exportOpenapiTypes,
+            defaultClientCallbacks: args.defaultClientCallbacks
+              .map((callbackName: string) => callbackName.trim())
+              .filter(Boolean),
             operationPredefinedParameters: args.operationPredefinedParameters
               ? createPredefinedParametersGlobs(
                   schema,
@@ -57,3 +73,20 @@ export const plugin: QraftCommandPlugin = {
       });
   },
 };
+
+function validateDefaultCallbacks(
+  defaultCallbacks: string[],
+  spinner: Ora
+): asserts defaultCallbacks is string[] | ['all'] | ['none'] {
+  if (!defaultCallbacks || defaultCallbacks.length === 0) return;
+
+  const hasSpecialValue = defaultCallbacks.some(
+    (cb) => cb === 'all' || cb === 'none'
+  );
+  if (hasSpecialValue && defaultCallbacks.length > 1) {
+    spinner.fail(
+      `When using "all" or "none" as a callback value, no other callbacks should be specified.`
+    );
+    process.exit(1);
+  }
+}

packages/tanstack-query-react-plugin/src/ts-factory/getCallbackNames.ts

@@ -0,0 +1,43 @@
+import ts from 'typescript';
+import {
+  createServicesMutationOperationNodes,
+  createServicesQueryOperationNodes,
+} from './serviceOperationNodes.js';
+
+/**
+ * Extracts method names from interfaces in AST nodes
+ */
+function extractMethodNamesFromInterfaces(nodes: ts.Node[]): string[] {
+  const methodNames: string[] = [];
+
+  // Recursive traversal to find interfaces
+  function visitNode(node: ts.Node) {
+    if (ts.isInterfaceDeclaration(node)) {
+      // Extract method names from interface members
+      node.members.forEach((member) => {
+        if (ts.isMethodSignature(member) && ts.isIdentifier(member.name)) {
+          methodNames.push(member.name.text);
+        }
+      });
+    }
+
+    ts.forEachChild(node, visitNode);
+  }
+
+  nodes.forEach(visitNode);
+
+  return [...new Set(methodNames)]; // Remove duplicates
+}
+
+/**
+ * Returns a list of all available callback function names
+ */
+export function getAllAvailableCallbackNames(): string[] {
+  const queryNodes = createServicesQueryOperationNodes();
+  const mutationNodes = createServicesMutationOperationNodes();
+
+  const queryMethodNames = extractMethodNamesFromInterfaces(queryNodes);
+  const mutationMethodNames = extractMethodNamesFromInterfaces(mutationNodes);
+
+  return [...new Set([...queryMethodNames, ...mutationMethodNames])].sort();
+}