fix: allow making second axios, etc., param required instead of `op…

…tional` (#1357) * initial commit * prettier fixes * Update docs/src/pages/reference/configuration/output.md Co-authored-by: Shodai Suzuki <[email protected]> * Update package.json * Update yarn.lock --------- Co-authored-by: Shodai Suzuki <[email protected]>
orval-labs · May 6, 2024 · b13dbb3 · b13dbb3
1 parent 9042d14
commit b13dbb3
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 4 deletions.
diff --git a/docs/src/pages/reference/configuration/output.md b/docs/src/pages/reference/configuration/output.md
@@ -1720,3 +1720,22 @@ module.exports = {
   },
 };
 ```
+
+### optionsParamRequired
+
+Type: `Boolean`
+
+Valid Values: `true` or `false`.
+
+Default Value: `false`.
+Use this property to make the second `options` parameter required (such as when using a custom axios instance)
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      optionsParamRequired: true,
+    },
+  },
+};
+```
diff --git a/packages/axios/src/index.ts b/packages/axios/src/index.ts
@@ -140,7 +140,7 @@ const generateAxiosImplementation = (
 
     return `const ${operationName} = (\n    ${propsImplementation}\n ${
       isRequestOptions && mutator.hasSecondArg
-        ? `options?: SecondParameter<typeof ${mutator.name}>,`
+        ? `options${context.output.optionsParamRequired ? '' : '?'}: SecondParameter<typeof ${mutator.name}>,`
         : ''
     }) => {${bodyForm}
       return ${mutator.name}<${response.definition.success || 'unknown'}>(

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -60,6 +60,7 @@ export type NormalizedOutputOptions = {
   allParamsOptional: boolean;
   urlEncodeParameters: boolean;
   unionAddMissingProperties: boolean;
+  optionsParamRequired: boolean;
 };
 
 export type NormalizedParamsSerializerOptions = {
@@ -182,6 +183,7 @@ export type OutputOptions = {
   allParamsOptional?: boolean;
   urlEncodeParameters?: boolean;
   unionAddMissingProperties?: boolean;
+  optionsParamRequired?: boolean;
 };
 
 export type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {

diff --git a/packages/orval/src/utils/options.ts b/packages/orval/src/utils/options.ts
@@ -253,6 +253,7 @@ export const normalizeOptions = async (
       },
       allParamsOptional: outputOptions.allParamsOptional ?? false,
       urlEncodeParameters: outputOptions.urlEncodeParameters ?? false,
+      optionsParamRequired: outputOptions.optionsParamRequired ?? false,
     },
     hooks: options.hooks ? normalizeHooks(options.hooks) : {},
   };

diff --git a/packages/query/src/index.ts b/packages/query/src/index.ts
@@ -453,7 +453,7 @@ const generateQueryRequestFunction = (
 
         return (\n    ${propsImplementation}\n ${
           isRequestOptions && mutator.hasSecondArg
-            ? `options?: SecondParameter<ReturnType<typeof ${mutator.name}>>,`
+            ? `options${context.output.optionsParamRequired ? '' : '?'}: SecondParameter<ReturnType<typeof ${mutator.name}>>,`
             : ''
         }${
           !isBodyVerb && hasSignal ? 'signal?: AbortSignal\n' : ''
@@ -468,7 +468,7 @@ const generateQueryRequestFunction = (
 
     return `${override.query.shouldExportHttpClient ? 'export ' : ''}const ${operationName} = (\n    ${propsImplementation}\n ${
       isRequestOptions && mutator.hasSecondArg
-        ? `options?: SecondParameter<typeof ${mutator.name}>,`
+        ? `options${context.output.optionsParamRequired ? '' : '?'}: SecondParameter<typeof ${mutator.name}>,`
         : ''
     }${!isBodyVerb && hasSignal ? 'signal?: AbortSignal\n' : ''}) => {
       ${isVue(outputClient) ? vueUnRefParams(props) : ''}

diff --git a/packages/swr/src/index.ts b/packages/swr/src/index.ts
@@ -171,7 +171,7 @@ const generateSwrRequestFunction = (
 
     return `export const ${operationName} = (\n    ${propsImplementation}\n ${
       isRequestOptions && mutator.hasSecondArg
-        ? `options?: SecondParameter<typeof ${mutator.name}>`
+        ? `options${context.output.optionsParamRequired ? '' : '?'}: SecondParameter<typeof ${mutator.name}>`
         : ''
     }) => {${bodyForm}
       return ${mutator.name}<${response.definition.success || 'unknown'}>(