Skip to content

IBX-10471: [Inputs] Inputs Validators Base #14

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
dew326 merged 6 commits into from
Aug 25, 2025
Merged

IBX-10471: [Inputs] Inputs Validators Base #14

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ffa8a2c
IBX-10471: [Inputs] Inputs Validators Base
GrabowskiM Aug 7, 2025
6f65e4d
copilot suggestion fixes
GrabowskiM Aug 18, 2025
2d26957
redo validators
GrabowskiM Aug 20, 2025
f31e969
after CR
GrabowskiM Aug 22, 2025
670a18f
linter
GrabowskiM Aug 22, 2025
da56241
removed _
GrabowskiM Aug 25, 2025
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
14 changes: 14 additions & 0 deletions packages/components/src/internal/shared/validators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import BaseValidator from '../../validators/BaseValidator';

export interface ValidateReturnType {
Copy link
Copy Markdown
Contributor

@tischsoic tischsoic Aug 20, 2025

Choose a reason for hiding this comment

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

I think we should avoid naming return types as ...ReturnType because this decreases flexibility. E.g. it may feel strange later to create something like:

const alwaysTrueValidation: ValidateReturnType = {...}

I think we should name it e.g. ValidationResult:

Suggested change
export interface ValidateReturnType {
export interface ValidationResult {

isValid: boolean;
messages: string[];
}

export const validateInput = <T>(value: T, validators: BaseValidator<T>[]): ValidateReturnType => {
const errors = validators
.filter((validator: BaseValidator<T>) => !validator.validate(value))
.map((validator: BaseValidator<T>) => validator.getErrorMessage());
Copy link
Copy Markdown
Contributor

@tischsoic tischsoic Aug 20, 2025

Choose a reason for hiding this comment

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

I guess this is somewhat fine, but it feels wrong to call filter first and then map to collect error messages :D

Suggested change
.filter((validator: BaseValidator<T>) => !validator.validate(value))
.map((validator: BaseValidator<T>) => validator.getErrorMessage());
.reduce((errors , validator) => {
const isValid = validator.validate(value);
if (isValid) {
continue;
}
return [...errors, validator.getErrorMessage()];
}, [])

this is longer but faster to read. :)


return { isValid: !errors.length, messages: errors };
};
13 changes: 13 additions & 0 deletions packages/components/src/validators/BaseValidator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { TranslatorType } from '@ids-context/Translator';

export default abstract class BaseValidator<T> {
protected _translator: TranslatorType;

constructor(translator: TranslatorType) {
this._translator = translator;
}

abstract getErrorMessage(): string;

abstract validate(_value: T): boolean;
}
13 changes: 13 additions & 0 deletions packages/components/src/validators/IsEmptyStringValidator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import BaseValidator from './BaseValidator';

export default class IsEmptyStringValidator extends BaseValidator<string> {
getErrorMessage(): string {
const Translator = this._translator;

return Translator.trans(/*@Desc("This field cannot be empty.")*/ 'ibexa.validators.is_empty_string');
}

validate(value: string): boolean {
return value.trim() !== '';
}
}