[BUG] [typescript-fetch] Invalid handling of date return type

[tomsontom]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator?
• Have you tested with the latest master to confirm the issue still exists?
• Have you searched for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Sponsorship to speed up the bug fix or feature request (example)

Description

If you define the response type of an API to return something of "type":"string" and "format":"date" the generated exposes the value as Date but looking at the source the JSON-Content is used as is and hence the returned value is of type "string".

openapi-generator version

7.22-SNAPSHOT

OpenAPI declaration file content or url

{
  "openapi": "3.0.1",
	"info": {
		"title": "RSD Test",
		"version": "1.0.0"
  },
  "paths": {
	"/api/date": {
      "get": {
        "description": "",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "format": "date"
                }
              }
            }
          }
        }
      }
    }
  }
}

Generation Details

I generated using

docker run --rm \ 
-v $PWD:/local openapitools/openapi-generator-cli:latest generate \
-i /local/openapi.json \
-g typescript-fetch --additional-properties=importFileExtension=.js \
-o /local/src

Steps to reproduce

• Run the generator
• Inspect the generated source

The relevant code part generated from above is

    async apiDateGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Date>> {
        const requestOptions = await this.apiDateGetRequestOpts();
        const response = await this.request(requestOptions, initOverrides);

        if (this.isJsonMime(response.headers.get('content-type'))) {
            return new runtime.JSONApiResponse<Date>(response);
        } else {
            return new runtime.TextApiResponse(response) as any;
        }
    }

Related issues/PRs

None I'm aware of

Suggest a fix

If the return value is a "Date" a transformer has to be passed so the line should look like

return new runtime.JSONApiResponse<Date>(response, isoDate => new Date(isoDate));

[sakshar2303]

Hi, I'd like to work on this — could it be assigned to me?

The reporter has already identified the fix clearly. The typescript-fetch generator emits JSONApiResponse<Date> without passing a transformer, so the raw ISO string is returned as-is instead of being converted to a Date object. The fix is to pass the transformer when the response type is date or date-time:

return new runtime.JSONApiResponse<Date>(response, isoDate => new Date(isoDate));

My plan:

1. Find the relevant Mustache template in modules/openapi-generator/src/main/resources/typescript-fetch/
2. Add a conditional so that when the response schema is type: string, format: date or date-time, the transformer is included in the JSONApiResponse call
3. Add a unit test covering a spec with a date response to prevent regressions

Happy to get a fix up for review!