feat: make all params optional #858

docs/src/pages/guides/custom-client.md

@@ -31,7 +31,7 @@ export const customInstance = async <T>({
   data,
 }: {
   url: string;
-  method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
   params?: any;
   data?: BodyType<unknown>;
   responseType?: string;

package.json

@@ -19,8 +19,9 @@
     "update-samples": "zx ./scripts/update-samples.mjs",
     "build": "turbo run build",
     "test": "turbo run test",
-    "test:ci": "yarn test -- -- --run && yarn test:vue-query --run",
+    "test:ci": "yarn test -- -- --run && yarn test:vue-query",
     "test:vue-query": "cd ./samples/vue-query && yarn && yarn test",
+    "test:react-query:custom-client": "cd ./samples/react-query/custom-client && yarn && yarn test",
     "lint": "turbo run lint",
     "dev": "turbo run dev"
   },

packages/core/src/generators/verbs-options.ts

@@ -124,6 +124,7 @@ const generateVerbOptions = async ({
     pathParams: parameters.path,
     operationId: operationId!,
     context,
+    output,
   });
 
   const props = getProps({

packages/core/src/getters/params.ts

@@ -1,5 +1,10 @@
 import { resolveValue } from '../resolvers';
-import { ContextSpecs, GetterParameters, GetterParams } from '../types';
+import {
+  ContextSpecs,
+  GetterParameters,
+  GetterParams,
+  NormalizedOutputOptions,
+} from '../types';
 import { camel, sanitize, stringify } from '../utils';
 
 /**
@@ -29,11 +34,13 @@ export const getParams = ({
   pathParams = [],
   operationId,
   context,
+  output,
 }: {
   route: string;
   pathParams?: GetterParameters['query'];
   operationId: string;
   context: ContextSpecs;
+  output: NormalizedOutputOptions;
 }): GetterParams => {
   const params = getParamsInPath(route);
   return params.map((p) => {
@@ -83,6 +90,11 @@ export const getParams = ({
       },
     });
 
+    let paramType = resolvedValue.value;
+    if (output.allParamsOptional) {
+      paramType = `${paramType} | undefined | null`; // TODO: maybe check that `paramType` isn't already undefined or null
+    }
+
     const definition = `${name}${
       !required || resolvedValue.originalSchema!.default ? '?' : ''
     }: ${resolvedValue.value}`;
@@ -91,8 +103,8 @@ export const getParams = ({
       !required && !resolvedValue.originalSchema!.default ? '?' : ''
     }${
       !resolvedValue.originalSchema!.default
-        ? `: ${resolvedValue.value}`
-        : `= ${stringify(resolvedValue.originalSchema!.default)}`
+        ? `: ${paramType}`
+        : `: ${paramType} = ${stringify(resolvedValue.originalSchema!.default)}` // FIXME: in Vue if we have `version: MaybeRef<number | undefined | null> = 1` and we don't pass version, the unref(version) will be `undefined` and not `1`, so we need to handle default value somewhere in implementation and not in the definition
     }`;
 
     return {

packages/core/src/getters/props.ts

@@ -75,7 +75,9 @@ export const getProps = ({
 
     const implementation = `{ ${params
       .map((property) =>
-        property.default ? property.implementation : property.name,
+        property.default
+          ? `${property.name} = ${property.default}` // if we use property.implementation, we will get `{ version: number = 1 }: ListPetsPathParameters = {}` which isn't valid
+          : property.name,
       )
       .join(', ')} }: ${parameterTypeName}${isOptional ? ' = {}' : ''}`;
 

packages/core/src/types.ts

@@ -54,6 +54,7 @@ export type NormalizedOutputOptions = {
   headers: boolean;
   indexFiles: boolean;
   baseUrl?: string;
+  allParamsOptional: boolean;
 };
 
 export type NormalizedParamsSerializerOptions = {
@@ -170,6 +171,7 @@ export type OutputOptions = {
   headers?: boolean;
   indexFiles?: boolean;
   baseUrl?: string;
+  allParamsOptional?: boolean;
 };
 
 export type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
@@ -194,6 +196,7 @@ export const OutputClient = {
   REACT_QUERY: 'react-query',
   SVELTE_QUERY: 'svelte-query',
   VUE_QUERY: 'vue-query',
+  SWR: 'swr',
 } as const;
 
 export type OutputClient = typeof OutputClient[keyof typeof OutputClient];

packages/orval/src/utils/options.ts

@@ -214,6 +214,7 @@ export const normalizeOptions = async (
           outputOptions.override?.useDeprecatedOperations ?? true,
         useNativeEnums: outputOptions.override?.useNativeEnums ?? false,
       },
+      allParamsOptional: outputOptions.allParamsOptional ?? false,
     },
     hooks: options.hooks ? normalizeHooks(options.hooks) : {},
   };

samples/angular-app/src/api/endpoints/pets/pets.service.ts

@@ -43,7 +43,7 @@ export class PetsService {
   /**
    * @summary List all pets
    */
-  listPets<TData = Pets>(params?: ListPetsParams, version = 1) {
+  listPets<TData = Pets>(params?: ListPetsParams, version: number = 1) {
     return listPetsMutator<TData>(
       { url: `/v${version}/pets`, method: 'GET', params },
       this.http,
@@ -54,7 +54,7 @@ export class PetsService {
    */
   createPets<TData = void>(
     createPetsBody: CreatePetsBody,
-    version = 1,
+    version: number = 1,
     options?: HttpClientOptions,
   ): Observable<TData> {
     return this.http.post<TData>(`/v${version}/pets`, createPetsBody, options);
@@ -64,7 +64,7 @@ export class PetsService {
    */
   showPetById<TData = Pet>(
     petId: string,
-    version = 1,
+    version: number = 1,
     options?: HttpClientOptions,
   ): Observable<TData> {
     return this.http.get<TData>(`/v${version}/pets/${petId}`, options);

samples/basic/api/endpoints/petstoreFromFileSpecWithTransformer.ts

@@ -14,7 +14,7 @@ import listPetsMutator from '../mutator/response-type';
 /**
  * @summary List all pets
  */
-export const listPets = (params?: ListPetsParams, version = 1) => {
+export const listPets = (params?: ListPetsParams, version: number = 1) => {
   return listPetsMutator<Pets>({
     url: `/v${version}/pets`,
     method: 'GET',
@@ -27,7 +27,7 @@ export const listPets = (params?: ListPetsParams, version = 1) => {
  */
 export const createPets = <TData = AxiosResponse<void>>(
   createPetsBody: CreatePetsBody,
-  version = 1,
+  version: number = 1,
   options?: AxiosRequestConfig,
 ): Promise<TData> => {
   return axios.post(`/v${version}/pets`, createPetsBody, options);
@@ -38,7 +38,7 @@ export const createPets = <TData = AxiosResponse<void>>(
  */
 export const showPetById = <TData = AxiosResponse<Pet>>(
   petId: string,
-  version = 1,
+  version: number = 1,
   options?: AxiosRequestConfig,
 ): Promise<TData> => {
   return axios.get(`/v${version}/pets/${petId}`, options);

samples/react-app-with-swr/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts

@@ -22,15 +22,15 @@ type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 /**
  * @summary List all pets
  */
-export const listPets = (params?: ListPetsParams, version = 1) => {
+export const listPets = (params?: ListPetsParams, version: number = 1) => {
   return customInstance<Pets>({
     url: `/v${version}/pets`,
     method: 'GET',
     params,
   });
 };
 
-export const getListPetsKey = (params?: ListPetsParams, version = 1) =>
+export const getListPetsKey = (params?: ListPetsParams, version: number = 1) =>
   [`/v${version}/pets`, ...(params ? [params] : [])] as const;
 
 export type ListPetsQueryResult = NonNullable<
@@ -43,7 +43,7 @@ export type ListPetsQueryError = Error;
  */
 export const useListPets = <TError = Error>(
   params?: ListPetsParams,
-  version = 1,
+  version: number = 1,
   options?: {
     swr?: SWRConfiguration<Awaited<ReturnType<typeof listPets>>, TError> & {
       swrKey?: Key;
@@ -74,7 +74,10 @@ export const useListPets = <TError = Error>(
 /**
  * @summary Create a pet
  */
-export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
+export const createPets = (
+  createPetsBody: CreatePetsBody,
+  version: number = 1,
+) => {
   return customInstance<Pet>({
     url: `/v${version}/pets`,
     method: 'POST',
@@ -86,14 +89,14 @@ export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
 /**
  * @summary Info for a specific pet
  */
-export const showPetById = (petId: string, version = 1) => {
+export const showPetById = (petId: string, version: number = 1) => {
   return customInstance<Pet>({
     url: `/v${version}/pets/${petId}`,
     method: 'GET',
   });
 };
 
-export const getShowPetByIdKey = (petId: string, version = 1) =>
+export const getShowPetByIdKey = (petId: string, version: number = 1) =>
   [`/v${version}/pets/${petId}`] as const;
 
 export type ShowPetByIdQueryResult = NonNullable<
@@ -106,7 +109,7 @@ export type ShowPetByIdQueryError = Error;
  */
 export const useShowPetById = <TError = Error>(
   petId: string,
-  version = 1,
+  version: number = 1,
   options?: {
     swr?: SWRConfiguration<Awaited<ReturnType<typeof showPetById>>, TError> & {
       swrKey?: Key;

samples/react-app/src/api/endpoints/petstoreFromFileSpecWithTransformer.ts

@@ -10,7 +10,7 @@ import { customInstance } from '../mutator/custom-instance';
 /**
  * @summary List all pets
  */
-export const listPets = (params?: ListPetsParams, version = 1) => {
+export const listPets = (params?: ListPetsParams, version: number = 1) => {
   return customInstance<Pets>({
     url: `/v${version}/pets`,
     method: 'GET',
@@ -21,7 +21,10 @@ export const listPets = (params?: ListPetsParams, version = 1) => {
 /**
  * @summary Create a pet
  */
-export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
+export const createPets = (
+  createPetsBody: CreatePetsBody,
+  version: number = 1,
+) => {
   return customInstance<void>({
     url: `/v${version}/pets`,
     method: 'POST',
@@ -33,7 +36,7 @@ export const createPets = (createPetsBody: CreatePetsBody, version = 1) => {
 /**
  * @summary Info for a specific pet
  */
-export const showPetById = (petId: string, version = 1) => {
+export const showPetById = (petId: string, version: number = 1) => {
   return customInstance<Pet>({
     url: `/v${version}/pets/${petId}`,
     method: 'GET',