Combining enum parameters does not export type for parameter

[sanjsharma]

Orval version: "7.8.0"

OAS:

openapi: 3.0.2
paths:
  "/animals":
    get:
      parameters:
        - $ref: '#/components/parameters/AnimalParam'

components:
  parameters:   
    AnimalParam:
      name: animal
      in: query
      schema:
        oneOf:
          - $ref: "#/components/schemas/Foo"
          - type: string
            enum:
              - mouse
      required: false
  schemas:
    Foo:
      type: string
      nullable: true
      enum:
        - cat
        - dog

Generated types:

import { Foo } from './foo'

// eslint-disable-next-line @typescript-eslint/no-redeclare
export const AnimalParamParameter = { ...Foo, mouse: 'mouse' } as const

It does not export type for AnimalParamParameter

Workaround:

components:
  parameters:   
    AnimalParam:
      name: animal
      in: query
      schema:
        oneOf:
          - $ref: "#/components/schemas/Bar"

  schemas:
    Foo:
      nullable: true
      type: string
      enum:
        - cat
        - dog
    Bar:
      nullable: true
      oneOf:
        - $ref: "#/components/schemas/Foo"
        - type: string
          enum:
            - mouse

It exports the type as needed

import { Foo } from './foo'

// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Bar = { ...Foo, mouse: 'mouse' } as const
export type Bar = (typeof Bar)[keyof typeof Bar]

import type { Bar } from './bar'

export type AnimalParamParameter = Bar

Without the oneOf workaround on AnimalParams which it should not need, I do not get the type exported

AnimalParam:
  name: animal
  in: query
  schema:
    $ref: "#/components/schemas/Bar"

[AllieJonsson]

#2057 will fix this

[melloware]

i think this is fixed in 8.0.0-RC5 here is what it generates

/**
 * @nullable
 */
export type Foo = (typeof Foo)[keyof typeof Foo] | null;

// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Foo = {
  cat: "cat",
  dog: "dog",
} as const;

export type AnimalParamParameter = Foo | null | "mouse";

Full export here...

/**
 * Generated by orval v8.0.0-rc.5 🍺
 * Do not edit manually.
 * My OpenAPI schema
 * My description.
 * OpenAPI spec version: 1.0.0
 */
import { useQuery } from "@tanstack/react-query";
import type {
  DataTag,
  DefinedInitialDataOptions,
  DefinedUseQueryResult,
  QueryClient,
  QueryFunction,
  QueryKey,
  UndefinedInitialDataOptions,
  UseQueryOptions,
  UseQueryResult,
} from "@tanstack/react-query";

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

/**
 * @nullable
 */
export type Foo = (typeof Foo)[keyof typeof Foo] | null;

// eslint-disable-next-line @typescript-eslint/no-redeclare
export const Foo = {
  cat: "cat",
  dog: "dog",
} as const;

export type AnimalParamParameter = Foo | null | "mouse";

export type GetDownloadParams = {
  animal?: AnimalParamParameter;
};

type AwaitedInput<T> = PromiseLike<T> | T;

type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;

export const getDownload = (
  params?: GetDownloadParams,
  options?: AxiosRequestConfig,
): Promise<AxiosResponse<Blob>> => {
  return axios.get(`/download`, {
    responseType: "blob",
    ...options,
    params: { ...params, ...options?.params },
  });
};

export const getGetDownloadQueryKey = (params?: GetDownloadParams) => {
  return [`/download`, ...(params ? [params] : [])] as const;
};

export const getGetDownloadQueryOptions = <
  TData = Awaited<ReturnType<typeof getDownload>>,
  TError = AxiosError<unknown>,
>(
  params?: GetDownloadParams,
  options?: {
    query?: Partial<
      UseQueryOptions<Awaited<ReturnType<typeof getDownload>>, TError, TData>
    >;
    axios?: AxiosRequestConfig;
  },
) => {
  const { query: queryOptions, axios: axiosOptions } = options ?? {};

  const queryKey = queryOptions?.queryKey ?? getGetDownloadQueryKey(params);

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

  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
    Awaited<ReturnType<typeof getDownload>>,
    TError,
    TData
  > & { queryKey: DataTag<QueryKey, TData, TError> };
};

export type GetDownloadQueryResult = NonNullable<
  Awaited<ReturnType<typeof getDownload>>
>;
export type GetDownloadQueryError = AxiosError<unknown>;

export function useGetDownload<
  TData = Awaited<ReturnType<typeof getDownload>>,
  TError = AxiosError<unknown>,
>(
  params: undefined | GetDownloadParams,
  options: {
    query: Partial<
      UseQueryOptions<Awaited<ReturnType<typeof getDownload>>, TError, TData>
    > &
      Pick<
        DefinedInitialDataOptions<
          Awaited<ReturnType<typeof getDownload>>,
          TError,
          Awaited<ReturnType<typeof getDownload>>
        >,
        "initialData"
      >;
    axios?: AxiosRequestConfig;
  },
  queryClient?: QueryClient,
): DefinedUseQueryResult<TData, TError> & {
  queryKey: DataTag<QueryKey, TData, TError>;
};
export function useGetDownload<
  TData = Awaited<ReturnType<typeof getDownload>>,
  TError = AxiosError<unknown>,
>(
  params?: GetDownloadParams,
  options?: {
    query?: Partial<
      UseQueryOptions<Awaited<ReturnType<typeof getDownload>>, TError, TData>
    > &
      Pick<
        UndefinedInitialDataOptions<
          Awaited<ReturnType<typeof getDownload>>,
          TError,
          Awaited<ReturnType<typeof getDownload>>
        >,
        "initialData"
      >;
    axios?: AxiosRequestConfig;
  },
  queryClient?: QueryClient,
): UseQueryResult<TData, TError> & {
  queryKey: DataTag<QueryKey, TData, TError>;
};
export function useGetDownload<
  TData = Awaited<ReturnType<typeof getDownload>>,
  TError = AxiosError<unknown>,
>(
  params?: GetDownloadParams,
  options?: {
    query?: Partial<
      UseQueryOptions<Awaited<ReturnType<typeof getDownload>>, TError, TData>
    >;
    axios?: AxiosRequestConfig;
  },
  queryClient?: QueryClient,
): UseQueryResult<TData, TError> & {
  queryKey: DataTag<QueryKey, TData, TError>;
};

export function useGetDownload<
  TData = Awaited<ReturnType<typeof getDownload>>,
  TError = AxiosError<unknown>,
>(
  params?: GetDownloadParams,
  options?: {
    query?: Partial<
      UseQueryOptions<Awaited<ReturnType<typeof getDownload>>, TError, TData>
    >;
    axios?: AxiosRequestConfig;
  },
  queryClient?: QueryClient,
): UseQueryResult<TData, TError> & {
  queryKey: DataTag<QueryKey, TData, TError>;
} {
  const queryOptions = getGetDownloadQueryOptions(params, options);

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

  query.queryKey = queryOptions.queryKey;

  return query;
}

[o-alexandrov]

Yes, it’s fixed. Thank you