feat: params of format date-time are now stringified using toISOString when useDates === true (#2213)

* feat: params of format date-time are now stringified using toISOString

* fix: removed non-fetch-related date stringification

* docs: added note about fetch client stringifying date parameters when useDates: true

Author: chcederquist

docs/src/pages/reference/configuration/output.md

@@ -2430,6 +2430,8 @@ export function handleDates(body: any) {
 }
 ```
 
+**Note:** If you are using the fetch client and useDates is set to true, query parameters of type Date will be stringified using toISOString()
+
 #### useBigInt
 
 Type: `Boolean`

packages/fetch/src/index.ts

@@ -73,13 +73,22 @@ export const generateRequestFunction = (
 
     return schema.name;
   });
+  const hasDateParams =
+    context.output.override.useDates &&
+    parameters.some(
+      (p) =>
+        'schema' in p &&
+        p.schema &&
+        'format' in p.schema &&
+        p.schema.format === 'date-time',
+    );
 
   const explodeArrayImplementation =
     explodeParameters.length > 0
       ? `const explodeParameters = ${JSON.stringify(explodeParametersNames)};
 
     if (Array.isArray(value) && explodeParameters.includes(key)) {
-      value.forEach((v) => normalizedParams.append(key, v === null ? 'null' : v.toString()));
+      value.forEach((v) => normalizedParams.append(key, v === null ? 'null' : ${hasDateParams ? 'v instanceof Date ? v.toISOString() : ' : ''}v.toString()));
       return;
     }
       `
@@ -89,7 +98,7 @@ export const generateRequestFunction = (
     explodeParameters.length === parameters.length;
 
   const nomalParamsImplementation = `if (value !== undefined) {
-      normalizedParams.append(key, value === null ? 'null' : value.toString())
+      normalizedParams.append(key, value === null ? 'null' : ${hasDateParams ? 'value instanceof Date ? value.toISOString() : ' : ''}value.toString())
     }`;
 
   const getUrlFnImplementation = `export const ${getUrlFnName} = (${getUrlFnProps}) => {

tests/configs/fetch.config.ts

@@ -243,4 +243,18 @@ export default defineConfig({
       target: '../specifications/petstore.yaml',
     },
   },
+  dateParams: {
+    output: {
+      target: '../generated/fetch/dateParams/endpoints.ts',
+      schemas: '../generated/fetch/dateParams/model',
+      client: 'fetch',
+      mode: 'tags-split',
+      override: {
+        useDates: true,
+      },
+    },
+    input: {
+      target: '../specifications/parameters.yaml',
+    },
+  },
 });

tests/specifications/parameters.yaml

@@ -120,6 +120,15 @@ paths:
           required: false
           schema:
             type: string
+        - name: latestBirthdate
+          in: query
+          description: |
+            Filter by latest birthdate.
+            Example: 2020-01-01T00:00:00Z
+          required: false
+          schema:
+            type: string
+            format: date-time
       responses:
         '200':
           description: A paged array of pets