feat: make all params optional #858

orval-labs · Jul 12, 2023 · d92c33c · d92c33c
1 parent 4937e2e
commit d92c33c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 16 deletions.
diff --git a/packages/query/src/utils.ts b/packages/query/src/utils.ts
@@ -87,7 +87,7 @@ export function vueWrapTypeWithMaybeRef(input: string): string {
     .map((param) => {
       const [paramName, paramType] = param.split(':');
       if (paramType) {
-        return `${paramName}: MaybeRef<${paramType.trim()}>,`;
+        return `${paramName}: MaybeRef<${paramType.trim()} | undefined | null>,`;
       } else {
         return `${param},`;
       }

diff --git a/samples/vue-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts b/samples/vue-query/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts
@@ -34,7 +34,7 @@ type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
  * @summary List all pets
  */
 export const listPets = (
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
   signal?: AbortSignal,
 ) => {
@@ -47,15 +47,15 @@ export const listPets = (
 };
 
 export const getListPetsQueryKey = (
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
 ) => ['v', version, 'pets', ...(params ? [params] : [])] as const;
 
 export const getListPetsInfiniteQueryOptions = <
   TData = Awaited<ReturnType<typeof listPets>>,
   TError = Error,
 >(
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
   options?: {
     query?: UseInfiniteQueryOptions<
@@ -93,7 +93,7 @@ export const useListPetsInfinite = <
   TData = Awaited<ReturnType<typeof listPets>>,
   TError = Error,
 >(
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
   options?: {
     query?: UseInfiniteQueryOptions<
@@ -123,7 +123,7 @@ export const getListPetsQueryOptions = <
   TData = Awaited<ReturnType<typeof listPets>>,
   TError = Error,
 >(
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
   options?: {
     query?: UseQueryOptions<
@@ -156,7 +156,7 @@ export const useListPets = <
   TData = Awaited<ReturnType<typeof listPets>>,
   TError = Error,
 >(
-  params?: MaybeRef<ListPetsParams>,
+  params?: MaybeRef<ListPetsParams | undefined | null>,
   version = 1,
   options?: {
     query?: UseQueryOptions<
@@ -181,7 +181,7 @@ export const useListPets = <
  * @summary Create a pet
  */
 export const createPets = (
-  createPetsBody: MaybeRef<CreatePetsBody>,
+  createPetsBody: MaybeRef<CreatePetsBody | undefined | null>,
   version = 1,
 ) => {
   return customInstance<Pet>({
@@ -248,7 +248,7 @@ export const useCreatePets = <TError = Error, TContext = unknown>(options?: {
  * @summary Info for a specific pet
  */
 export const showPetById = (
-  petId: MaybeRef<string>,
+  petId: MaybeRef<string | undefined | null>,
   version = 1,
   signal?: AbortSignal,
 ) => {
@@ -259,14 +259,16 @@ export const showPetById = (
   });
 };
 
-export const getShowPetByIdQueryKey = (petId: MaybeRef<string>, version = 1) =>
-  ['v', version, 'pets', petId] as const;
+export const getShowPetByIdQueryKey = (
+  petId: MaybeRef<string | undefined | null>,
+  version = 1,
+) => ['v', version, 'pets', petId] as const;
 
 export const getShowPetByIdInfiniteQueryOptions = <
   TData = Awaited<ReturnType<typeof showPetById>>,
   TError = Error,
 >(
-  petId: MaybeRef<string>,
+  petId: MaybeRef<string | undefined | null>,
   version = 1,
   options?: {
     query?: UseInfiniteQueryOptions<
@@ -303,7 +305,7 @@ export const useShowPetByIdInfinite = <
   TData = Awaited<ReturnType<typeof showPetById>>,
   TError = Error,
 >(
-  petId: MaybeRef<string>,
+  petId: MaybeRef<string | undefined | null>,
   version = 1,
   options?: {
     query?: UseInfiniteQueryOptions<
@@ -333,7 +335,7 @@ export const getShowPetByIdQueryOptions = <
   TData = Awaited<ReturnType<typeof showPetById>>,
   TError = Error,
 >(
-  petId: MaybeRef<string>,
+  petId: MaybeRef<string | undefined | null>,
   version = 1,
   options?: {
     query?: UseQueryOptions<
@@ -366,7 +368,7 @@ export const useShowPetById = <
   TData = Awaited<ReturnType<typeof showPetById>>,
   TError = Error,
 >(
-  petId: MaybeRef<string>,
+  petId: MaybeRef<string | undefined | null>,
   version = 1,
   options?: {
     query?: UseQueryOptions<

diff --git a/samples/vue-query/src/components/pet.vue b/samples/vue-query/src/components/pet.vue
@@ -9,7 +9,7 @@
 import { computed, unref } from 'vue';
 import { useShowPetById } from '../api/endpoints/petstoreFromFileSpecWithTransformer';
 
-const props = defineProps<{ petId: string }>();
+const props = defineProps({ petId: String });
 const petId = computed(() => props.petId);
 const petQuery = useShowPetById(petId);
 const pet = computed(() => unref(petQuery?.data));