RFC: feat(query): add shouldExportMutatorHooks option

[ezequiel]

Status

HOLD

Description

When client is set as react-query, 3 different functions are generated for each query/mutation. For example:

export const useCreateUserHook = () => {
  ... 
};

export const useCreateUserMutationOptions = <TError = ErrorType<unknown>, TContext = unknown>(...): ... => {
  ...
};


export const useCreateUser = <TError = ErrorType<unknown>, TContext = unknown>(...) => {
  ....
};

GOAL: I don't want to export useCreateUserHook. This causes confusion for my team and I on which function to use: useCreateUserHook, or useCreateUser? Ideally we always use the react-query version (useCreateUser), but it's easier if we just don't export it at all, so no one can make the mistake

(I arguably don't want useCreateUserMutationOptions exported either, but that one is less problematic)

I made this an option to preserve backwards compatibility, but let me know your thoughts

Steps to Test or Reproduce

orval.config.js

module.exports = {
  api: {
    input: {
      target: '../docs/swagger.json',
      override: {
        transformer,
      },
    },
    validation: true,
    output: {
      target: 'api.generated.ts',
      client: 'react-query',
      workspace: 'src/api',
      override: {
        query: {
          useQuery: false,
          useSuspenseQuery: true,
          shouldExportMutatorHooks: false,
        },
      },
    },
  },
};

Verified the mutator hook is no longer exported

[ezequiel]

Do we think this is an actual problem, and worth adding an option for?

Thinking a little more here, it'd be nice if there was a granular export configuration capability to control exactly how much gets exported (e.g. in my case, I don't want the mutator hook or MutationOptions exported), though that seems a little difficult here given all the different clients. Adding a one-off option for now might complicate things in the future, if we ever decide to go down that route

[melloware]

I like the idea can you add a matching Issue ticket so I can link this PR to a ticket please.