fix(config): cast configuration values into proper types

[glowcloud]

Refs #9808
Supersedes #9722

[char0n]

TODO:

• align with the documentation
• align swagger-ui-react defaultProps

[glowcloud]

I went through the docs and code to check for types and default values, skipping functions. Compiled the places where we don't specify what the default is or where there are differences in types.

OPTION	DOCS	DEFAULT	REACT DEFAULT	REACT PROP TYPE	TYPE CASTER
dom_id	string	null			null or string
domNode	Element	null			null or value
spec	object	{}	“”	string or object	object
urls	array	null			null or array
layout	string	BaseLayout	BaseLayout	String
oauth2redirectUrl	string	string	undefined	string	undefined or string
withCredentials	boolean	undefined	undefined	boolean	undefined or boolean

• dom_id and domNode - we're not mentioning that they can be null, just that one of them is required if the other is not specified
• spec not sure if we should change the docs to allow string or React prop types to only allow object, or just leave them as is and create a type caster for it
• urls - we're just not mentioning that the default is null
• layout - not casting this as it's different in storeOptions:

  swagger-ui/src/core/config/factorization/store.js

  Lines 9 to 12 in 2720d76

  	layout: {
  	layout: options.layout,
  	filter: options.filter,
  	},

  so I think we would need to pass an additional flag on which options we're merging - otherwise we can't know if the layout can be an object or not
• oauth2redirectUrl - we're just not mentioning that it can be undefined
• withCredentials - we're not mentioning that the default is undefined and I'm also wondering if it shouldn't just be false. We have this in Swagger UI:

  const value = system.getConfigs().withCredentials

  if(value !== undefined) {
    system.fn.fetch.withCredentials = value
  }

and in Swagger Client:

const credentials = http && http.withCredentials ? 'include' : 'same-origin';

const credentials =
  this.getHttpClient().withCredentials || this.withCredentials ? 'include' : 'same-origin';

const credentials = http.withCredentials ? 'include' : 'same-origin';

But for each of them, it looks to me like if the value was false, it would work the same way. But perhaps we also check it somewhere else.

[glowcloud]

Compiled the places where we don't specify what the default

I think I understand now - the docs actually just simply don't mention the default value if the default is null, undefined or empty string.

[char0n]

I think I understand now - the docs actually just simply don't mention the default value if the default is null, undefined or empty string.

We'll accept and following this further.

[char0n]

layout - not casting this as it's different in storeOptions:

We'll use naked deep-extend here.

[char0n]

Looks good. Nicely done!