feat: support `domain` for `t.record` codec

anshchaturvedi commented 1 month ago

Problem:

Currently, openapi-generator only supports t.record with unrestricted domains. However, there can be codecs that use an enumerable (usually signified as a t.keyof) to specify that only certain keys are allowed and that all of these keys are required in the t.record.

Our dev-portal doesn't fully support rendering t.record that conforms to the OpenAPI specification, as the rendering code we ~copied~ adopted from @stoplight/json-schema-viewer is outdated and a few versions behind the current release.

Solution:

Although a dev-portal fix to render t.record better is in progress (though it won't be fully complete in its first iteration), we decided to circumvent the inadequate rendering by converting a t.record to a t.type. Both codecs expect all keys to exist in the object and all values of the keys to conform to the specified codec. With this PR, something like:

export const SomeCodec = t.record(t.keyof({ foo: "foo", bar: "bar" }), t.type({ baz: t.string }))

will have its keys "expanded" and inlined by openapi-generator when generated, and will be equivalent to:

export const SomeCodec = t.type({
  foo: t.type({ baz: t.string }),
  bar: t.type({ baz: t.string }),
})

[!IMPORTANT] Any t.record codecs with an unrestricted domain (e.g., t.string) will remain unchanged.

Ticket: DX-637