Skip to content

Add and export types with the Validation error string literal values #450

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

Open
joneubank wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add and export types with the Validation error string literal values #450

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions packages/validation/src/validateDictionary/DictionaryValidationError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,5 @@ export type DictionaryValidationErrorInvalidRecords = DictionaryValidationErrorB
export type DictionaryValidationError =
| DictionaryValidationErrorUnrecognizedSchema
| DictionaryValidationErrorInvalidRecords;

export type DictionaryValidationErrorReason = DictionaryValidationError['reason'];
2 changes: 2 additions & 0 deletions packages/validation/src/validateField/FieldValidationError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ export type FieldValidationErrorValueType = {
};

export type FieldValidationError = FieldValidationErrorRestrictions | FieldValidationErrorValueType;

export type FieldValidationErrorReason = FieldValidationError['reason'];

@justincorrigible justincorrigible Aug 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

None of the 4 new exports in the PR have a TSDoc comment, which looks like it breaks with this file's own existing convention, FieldValidationErrorValueType right next to this one has one.

do we want to add a brief one-liner to each stating what the type represents?

2 changes: 2 additions & 0 deletions packages/validation/src/validateRecord/RecordValidationError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ export type RecordValidationError =
| RecordValidationErrorInvalidValue
| RecordValidationErrorRestrictions
| RecordValidationErrorUnrecognizedField;

export type RecordValidationErrorReason = RecordValidationError['reason'];
2 changes: 2 additions & 0 deletions packages/validation/src/validateSchema/SchemaValidationError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ export type SchemaRecordError<ErrorDetails> = {
};

export type SchemaValidationError = SchemaRecordError<SchemaValidationRecordErrorDetails>;

export type SchemaValidationErrorReason = SchemaValidationRecordErrorDetails['reason'];

@justincorrigible justincorrigible Aug 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

worth a one-line comment here recording the deviation: the other three *Reason aliases all follow <X>Reason = X['reason'], but this one is derived from the nested SchemaValidationRecordErrorDetails instead, since SchemaValidationError itself has no top-level reason field... that's the right call, but undocumented it reads as an inconsistency rather than a deliberate exception, and a future contributor extending the pattern "by analogy" will likely hit some type error trying to do what "seems" obvious