implement getQueryOptions at openapi-react-query

[barmaglot92]

Description

Hi, my architectural vision, as well as for example FSD, involves using entities and API slices, the implementation of which requires creating wrapper functions.

Proposal

I suggest implementing a getQueryOptions function that would return a function requiring init and options for the specified method and path.

/* ./entities/sequrity-object/api/query.ts */
export const getSequrityObjectOptions = $api.query.someservice.getQueryOptions('get', '/method');

const Component = () => {
  const { data, error, loading } = useQuery(
    getSequrityObjectOptions({ params: { testparam: 'test' } }, { enabled: true }),
  );
};

Extra

• I’m willing to open a PR (see CONTRIBUTING.md)

[jakiestfu]

@barmaglot92 I literally came here to ask about the same thing. We have a desire to create wrapper functions, but I'm unsure of how to produce types for parameter 3/4 (options/queryOptions) when provided with the method and path. In our case, our wrapper signature would look slightly different, but your signature/syntax would be preferred.

/* Not sure what or how to type options and query options for ["get", "/method"] */
export const getSequrityObjectOptions = (options: ?, queryOptions: ?) =>
    $api.query.someservice.getQueryOptions('get', '/method', options, queryOptions);

const Component = () => {
  const { data, error, loading } = useQuery(
    getSequrityObjectOptions({ params: { testparam: 'test' } }, { enabled: true }),
  );
};

My Typescript isn't the best and I'm unsure how best to attempt to use the generics provided.

type Client = OpenapiQueryClient<paths>;
type QueryOptions = Client["queryOptions"]

Edit @barmaglot92 Any idea how to produce those types needed for those parameters as a workaround?

[barmaglot92]

@jakiestfu
Hi, i created a draft today. #2390, but i think it could be implemented better.

Also, after a day of researching this web tools and libs i decide to use swagger-api-typescript tool, because it has more customization options and more suitable for complex architectures as for me.

The major problem of this library is functions type anywhere so its hard to simply get response type or request params type..

As for
/* Not sure what or how to type options and query options for ["get", "/method"] */
export const getSequrityObjectOptions = (options: ?, queryOptions: ?) =>
$api.query.someservice.getQueryOptions('get', '/method', options, queryOptions);

const Component = () => {
const { data, error, loading } = useQuery(
getSequrityObjectOptions({ params: { testparam: 'test' } }, { enabled: true }),
);
};

Its possible and i thought about it but will require some refactoring existing types, but now i switched to swagger-api-typescript