Skip to content

Add more missing io-ts codec definitions #638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2023
Merged

Add more missing io-ts codec definitions #638

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/openapi-generator/src/knownImports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export const KNOWN_IMPORTS: KnownImports = {
boolean: () => E.right({ type: 'boolean' }),
null: () => E.right({ type: 'null' }),
undefined: () => E.right({ type: 'undefined' }),
unknown: () => E.right({ type: 'any' }),
Copy link
Contributor

@ericcrosson-bitgo ericcrosson-bitgo Dec 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cries in type-strictness 😭

Am I understanding correctly that the unknown in the LHS refers to TypeScript's unknown type, while the any on the RHS corresponds to OpenAPI's type?

If so, then I guess that's not as egregious as if both were TypeScript types!

Copy link
Contributor Author

@bitgopatmcl bitgopatmcl Dec 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the RHS is what eventually gets turned into an OpenAPI schema.

any: () => E.right({ type: 'any' }),
array: (_, innerSchema) => E.right({ type: 'array', items: innerSchema }),
readonlyArray: (_, innerSchema) => E.right({ type: 'array', items: innerSchema }),
type: (_, schema) => {
Expand Down Expand Up @@ -109,6 +111,7 @@ export const KNOWN_IMPORTS: KnownImports = {
});
},
brand: (_, arg) => E.right(arg),
UnknownRecord: () => E.right({ type: 'record', codomain: { type: 'any' } }),
},
'io-ts-types': {
BigIntFromString: () => E.right({ type: 'string' }),
Expand Down