orval/tests/__snapshots__/vue-query/issue-1026/endpoints.ts at 33c650b3bf7da82a4902e093ce44ea9140ccdcdc · wadakatu/orval · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/**
 * Generated by orval v8.11.0 🍺
 * Do not edit manually.
 * Issue 1026 - Vue Query header parameters
 * OpenAPI spec version: 1.0.0
 */
import { useQuery } from '@tanstack/vue-query';
import type {
  DataTag,
  QueryClient,
  QueryFunction,
  QueryKey,
  UseQueryOptions,
  UseQueryReturnType,
} from '@tanstack/vue-query';

import axios from 'axios';
import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';

import { unref } from 'vue';
import type { MaybeRef } from 'vue';

import type { GetSomeEndpointHeaders, SomeEndpointResult } from './model';

/**
 * @summary Get something with header parameters
 */
export const getSomeEndpoint = (
  headers?: MaybeRef<GetSomeEndpointHeaders>,
  options?: AxiosRequestConfig,
): Promise<AxiosResponse<SomeEndpointResult>> => {
  headers = unref(headers);

  return axios.get(`/api/v1/someEndPoint`, {
    ...options,
    headers: { ...headers, ...options?.headers },
  });
};

export const getGetSomeEndpointQueryKey = () => {
  return ['api', 'v1', 'someEndPoint'] as const;
};

export const getGetSomeEndpointQueryOptions = <
  TData = Awaited<ReturnType<typeof getSomeEndpoint>>,
  TError = AxiosError<unknown>,
>(
  headers?: MaybeRef<GetSomeEndpointHeaders>,
  options?: {
    query?: Partial<
      UseQueryOptions<
        Awaited<ReturnType<typeof getSomeEndpoint>>,
        TError,
        TData
      >
    >;
    axios?: AxiosRequestConfig;
  },
) => {
  const { query: queryOptions, axios: axiosOptions } = options ?? {};

  const queryKey = getGetSomeEndpointQueryKey();

  const queryFn: QueryFunction<Awaited<ReturnType<typeof getSomeEndpoint>>> = ({
    signal,
  }) => getSomeEndpoint(headers, { signal, ...axiosOptions });

  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
    Awaited<ReturnType<typeof getSomeEndpoint>>,
    TError,
    TData
  >;
};

export type GetSomeEndpointQueryResult = NonNullable<
  Awaited<ReturnType<typeof getSomeEndpoint>>
>;
export type GetSomeEndpointQueryError = AxiosError<unknown>;

/**
 * @summary Get something with header parameters
 */

export function useGetSomeEndpoint<
  TData = Awaited<ReturnType<typeof getSomeEndpoint>>,
  TError = AxiosError<unknown>,
>(
  headers?: MaybeRef<GetSomeEndpointHeaders>,
  options?: {
    query?: Partial<
      UseQueryOptions<
        Awaited<ReturnType<typeof getSomeEndpoint>>,
        TError,
        TData
      >
    >;
    axios?: AxiosRequestConfig;
  },
  queryClient?: QueryClient,
): UseQueryReturnType<TData, TError> & {
  queryKey: DataTag<QueryKey, TData, TError>;
} {
  const queryOptions = getGetSomeEndpointQueryOptions(headers, options);

  const query = useQuery(queryOptions, queryClient) as UseQueryReturnType<
    TData,
    TError
  > & { queryKey: DataTag<QueryKey, TData, TError> };

  query.queryKey = unref(queryOptions).queryKey as DataTag<
    QueryKey,
    TData,
    TError
  >;

  return query;
}