Merge pull request #2569 from hey-api/fix/tanstack-query-hooks

feat(tanstack-query): add hooks options

Author: mrlubos

.changeset/changelog.js

@@ -23,12 +23,7 @@ export default {
 
     return ['### Updated Dependencies:', ...list].join('\n');
   },
-  getReleaseLine: async (changeset, type, changelogOpts) => {
-    console.warn('----🐍🐍🐍🐍🐍🐍🐍');
-    console.warn(changeset);
-    console.warn(type);
-    console.warn(changelogOpts);
-    console.warn('----🐍🐍🐍🐍🐍🐍🐍');
+  getReleaseLine: async (changeset) => {
     const repo = getRepo();
 
     /** @type number | undefined */
@@ -73,10 +68,7 @@ export default {
       }
       const commitToFetchFrom = commitFromSummary || changeset.commit;
       if (commitToFetchFrom) {
-        const { links } = await getInfo({
-          commit: commitToFetchFrom,
-          repo,
-        });
+        const { links } = await getInfo({ commit: commitToFetchFrom, repo });
         return links;
       }
       return {

packages/openapi-ts-tests/main/test/openapi-ts.config.ts

@@ -81,7 +81,7 @@ export default defineConfig(() => {
         // deprecated: false,
         operations: {
           include: [
-            'GET /event',
+            // 'GET /event',
             // '/^[A-Z]+ /v1//',
           ],
         },
@@ -212,9 +212,11 @@ export default defineConfig(() => {
         // queryKeys: {
         //   name: '{{name}}QK',
         // },
+        queryOptions: false,
         // queryOptions: {
         //   name: '{{name}}QO',
         // },
+        useQuery: true,
         '~hooks': {
           operations: {
             getKind: (op) => {

packages/openapi-ts/README.md

@@ -205,7 +205,9 @@ The above script can be executed by running `npm run openapi-ts` or equivalent c
 
 ### Node.js
 
-You can also generate output programmatically by importing `@hey-api/openapi-ts` in a TypeScript file.
+You can also generate output programmatically by calling `createClient()` in a JavaScript/TypeScript file.
+
+#### `script.ts`
 
 ```ts
 import { createClient } from '@hey-api/openapi-ts';

packages/openapi-ts/src/plugins/@pinia/colada/queryOptions.ts

@@ -5,6 +5,7 @@ import type { IR } from '../../../ir/types';
 import { tsc } from '../../../tsc';
 import {
   createOperationComment,
+  hasOperationSse,
   isOperationOptionsRequired,
 } from '../../shared/utils/operation';
 import { handleMeta } from './meta';
@@ -35,7 +36,8 @@ export const createQueryOptions = ({
 }): void => {
   if (
     !plugin.config.queryOptions.enabled ||
-    !plugin.hooks.operation.isQuery(operation)
+    !plugin.hooks.operation.isQuery(operation) ||
+    hasOperationSse({ operation })
   ) {
     return;
   }

packages/openapi-ts/src/plugins/@tanstack/angular-query-experimental/config.ts

@@ -77,6 +77,7 @@ export const defaultConfig: TanStackAngularQueryPlugin['Config'] = {
       defaultValue: {
         case: plugin.config.case ?? 'camelCase',
         enabled: true,
+        exported: true,
         name: '{{name}}Options',
       },
       mappers: {

packages/openapi-ts/src/plugins/@tanstack/angular-query-experimental/types.d.ts

@@ -267,6 +267,12 @@ export type UserConfig = Plugin.Name<'@tanstack/angular-query-experimental'> &
            * @default true
            */
           enabled?: boolean;
+          /**
+           * Whether to export generated symbols.
+           *
+           * @default true
+           */
+          exported?: boolean;
           /**
            * Custom function to generate metadata for the operation.
            * Can return any valid meta object that will be included in the generated query options.
@@ -510,6 +516,12 @@ export type Config = Plugin.Name<'@tanstack/angular-query-experimental'> &
        * @default true
        */
       enabled: boolean;
+      /**
+       * Whether to export generated symbols.
+       *
+       * @default true
+       */
+      exported: boolean;
       /**
        * Custom function to generate metadata for the operation.
        * Can return any valid meta object that will be included in the generated query options.

packages/openapi-ts/src/plugins/@tanstack/query-core/infiniteQueryOptions.ts

@@ -234,21 +234,14 @@ export const createInfiniteQueryOptions = ({
   plugin: PluginInstance;
   queryFn: string;
   state: PluginState;
-}) => {
-  if (
-    !plugin.config.infiniteQueryOptions.enabled ||
-    !plugin.hooks.operation.isQuery(operation)
-  ) {
-    return state;
-  }
-
+}): void => {
   const pagination = operationPagination({
     context: plugin.context,
     operation,
   });
 
   if (!pagination) {
-    return state;
+    return;
   }
 
   const file = plugin.context.file({ id: plugin.name })!;

packages/openapi-ts/src/plugins/@tanstack/query-core/mutationOptions.ts

@@ -19,14 +19,7 @@ export const createMutationOptions = ({
   plugin: PluginInstance;
   queryFn: string;
   state: PluginState;
-}) => {
-  if (
-    !plugin.config.mutationOptions.enabled ||
-    !plugin.hooks.operation.isMutation(operation)
-  ) {
-    return state;
-  }
-
+}): void => {
   const mutationsType =
     plugin.name === '@tanstack/angular-query-experimental' ||
     plugin.name === '@tanstack/svelte-query' ||
@@ -165,6 +158,4 @@ export const createMutationOptions = ({
     name: identifier.name || '',
   });
   file.add(statement);
-
-  return state;
 };

packages/openapi-ts/src/plugins/@tanstack/query-core/plugin.ts

@@ -8,6 +8,7 @@ import { createInfiniteQueryOptions } from './infiniteQueryOptions';
 import { createMutationOptions } from './mutationOptions';
 import { createQueryOptions } from './queryOptions';
 import type { PluginHandler, PluginState } from './types';
+import { createUseQuery } from './useQuery';
 
 export const handler = ({ plugin }: Parameters<PluginHandler>[0]) => {
   const file = plugin.createFile({
@@ -68,26 +69,40 @@ export const handler = ({ plugin }: Parameters<PluginHandler>[0]) => {
             ]
       ).join('.');
 
-    createQueryOptions({
-      operation,
-      plugin,
-      queryFn,
-      state,
-    });
+    if (plugin.hooks.operation.isQuery(operation)) {
+      if (plugin.config.queryOptions.enabled) {
+        createQueryOptions({
+          operation,
+          plugin,
+          queryFn,
+          state,
+        });
+      }
 
-    createInfiniteQueryOptions({
-      operation,
-      plugin,
-      queryFn,
-      state,
-    });
+      if (plugin.config.infiniteQueryOptions.enabled) {
+        createInfiniteQueryOptions({
+          operation,
+          plugin,
+          queryFn,
+          state,
+        });
+      }
 
-    createMutationOptions({
-      operation,
-      plugin,
-      queryFn,
-      state,
-    });
+      if ('useQuery' in plugin.config && plugin.config.useQuery.enabled) {
+        createUseQuery({ operation, plugin, state });
+      }
+    }
+
+    if (plugin.hooks.operation.isMutation(operation)) {
+      if (plugin.config.mutationOptions.enabled) {
+        createMutationOptions({
+          operation,
+          plugin,
+          queryFn,
+          state,
+        });
+      }
+    }
 
     if (state.hasUsedQueryFn) {
       file.import({

packages/openapi-ts/src/plugins/@tanstack/query-core/queryOptions.ts

@@ -4,6 +4,7 @@ import type { IR } from '../../../ir/types';
 import { tsc } from '../../../tsc';
 import {
   createOperationComment,
+  hasOperationSse,
   isOperationOptionsRequired,
 } from '../../shared/utils/operation';
 import { handleMeta } from './meta';
@@ -28,12 +29,9 @@ export const createQueryOptions = ({
   plugin: PluginInstance;
   queryFn: string;
   state: PluginState;
-}) => {
-  if (
-    !plugin.config.queryOptions.enabled ||
-    !plugin.hooks.operation.isQuery(operation)
-  ) {
-    return state;
+}): void => {
+  if (hasOperationSse({ operation })) {
+    return;
   }
 
   const file = plugin.context.file({ id: plugin.name })!;
@@ -179,7 +177,7 @@ export const createQueryOptions = ({
     comment: plugin.config.comments
       ? createOperationComment({ operation })
       : undefined,
-    exportConst: true,
+    exportConst: plugin.config.queryOptions.exported,
     expression: tsc.arrowFunction({
       parameters: [
         {
@@ -200,6 +198,4 @@ export const createQueryOptions = ({
     // TODO: AxiosError<PutSubmissionMetaError>
   });
   file.add(statement);
-
-  return state;
 };