Add possibility to change default request params

.changeset/default-request-params.md

@@ -0,0 +1,9 @@
+---
+"swagger-typescript-api": patch
+---
+
+Add possibility to change default request params
+
+Useful when overriding the http client, and you want to make sure the request params are set.
+
+Can be set to `""` in order to not make it optional.

index.ts

@@ -283,6 +283,11 @@ const generateCommand = defineCommand({
       description: "unwrap the data item from the response",
       default: codeGenBaseConfig.unwrapResponseData,
     },
+    "default-request-params": {
+      type: "string",
+      description: "request parameters for each API request",
+      default: codeGenBaseConfig.defaultRequestParams,
+    },
   },
   run: async ({ args }) => {
     const customConfig = await loadConfig<GenerateApiParams>({
@@ -298,6 +303,7 @@ const generateCommand = defineCommand({
       debug: args.debug,
       defaultResponseAsSuccess: args["default-as-success"],
       defaultResponseType: args["default-response"],
+      defaultRequestParams: args["default-request-params"],
       disableThrowOnError: args["disable-throw-on-error"],
       enumNamesAsValues: args["enum-names-as-values"],
       extractEnums: args["extract-enums"],

src/configuration.ts

@@ -111,6 +111,7 @@ export class CodeGenConfig {
     onFormatRouteName: (_routeInfo: unknown, _templateRouteName: unknown) => {},
   };
   defaultResponseType;
+  defaultRequestParams = "{}";
   singleHttpClient = false;
   httpClientType = CONSTANTS.HTTP_CLIENT.FETCH;
   unwrapResponseData = false;

templates/default/procedure-call.ejs

@@ -14,9 +14,9 @@ const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
 
 const requestConfigParam = {
     name: specificArgNameResolver.resolve(RESERVED_REQ_PARAMS_ARG_NAMES),
-    optional: true,
+    optional: !!config.defaultRequestParams,
     type: "RequestParams",
-    defaultValue: "{}",
+    defaultValue: config.defaultRequestParams ?? "{}",
 }
 
 const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!defaultValue && optional ? '?' : ''}: ${type}${defaultValue ? ` = ${defaultValue}` : ''}`;

templates/modular/procedure-call.ejs

@@ -14,9 +14,9 @@ const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
 
 const requestConfigParam = {
     name: specificArgNameResolver.resolve(RESERVED_REQ_PARAMS_ARG_NAMES),
-    optional: true,
+    optional: !!config.defaultRequestParams,
     type: "RequestParams",
-    defaultValue: "{}",
+    defaultValue: config.defaultRequestParams ?? "{}",
 }
 
 const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!defaultValue && optional ? '?' : ''}: ${type}${defaultValue ? ` = ${defaultValue}` : ''}`;