Support exactOptionalPropertyTypes

[seivan]

A key being optional is different than the value being optional. Former indicates missing keys, while latter indicate, required key but missing value.

When defining a type like this, we're explicitly stating that the key must exists, but its value could be undefined.

export type OpenAPIConfig = { myKey: string | undefined; };

Valid
const invalid: OpenAPIConfig = {myKey: undefined}

Invalid
const invalid: OpenAPIConfig = {}

Which is different from following that says, key could be missing - which translates into the value being missing as well. Which is why with exactOptionalPropertyTypes all optional keys need to explicitly state undefined as value type.

export type OpenAPIConfig = { myKey?: string | undefined; };

Valid
const invalid: OpenAPIConfig = {myKey: undefined}

Valid
const invalid: OpenAPIConfig = {}

Now, you might actually want the user to be explicit with the keys, in which case can change it, but I'm inferring from context that it's not important.

In any case, in that scenario, dropping the optional keyword on the key would change that. But that might break for users who are currently not passing explicit keys. This maintains backwards compatibility.

[CemYil03]

This is a great suggestion. Facing the exact same problem right now.

[ferdikoomen]

@seivan thanks!

[Mr-Jami]

@ferdikoomen I am using the current versione (0.24.0)
I generated my api client with the client option "angular".

However the fix you added to the project does not appear in my project. I still get the older version without the optional type of undefined.

Is it possible that your fix is not applied to the current NPM package?

OpenAPI.ts

/* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ import type { ApiRequestOptions } from './ApiRequestOptions'; type Resolver<T> = (options: ApiRequestOptions) => Promise<T>; type Headers = Record<string, string>; export type OpenAPIConfig = { BASE: string; VERSION: string; WITH_CREDENTIALS: boolean; CREDENTIALS: 'include' | 'omit' | 'same-origin'; TOKEN?: string | Resolver<string>; USERNAME?: string | Resolver<string>; PASSWORD?: string | Resolver<string>; HEADERS?: Headers | Resolver<Headers>; ENCODE_PATH?: (path: string) => string; }; export const OpenAPI: OpenAPIConfig = { BASE: '', VERSION: '1.0', WITH_CREDENTIALS: false, CREDENTIALS: 'include', TOKEN: undefined, USERNAME: undefined, PASSWORD: undefined, HEADERS: undefined, ENCODE_PATH: undefined, };