dataffy/themis

Themis is a validation and processing library that helps you always make sure your data is correct.

themis's Issues

Make the Validator constructor public, so we don't need to override it in the child class

Make the Validator constructor public instead of protected.

Current implementation

The validator constructor is protected, and we always need to override it in the child validator

class MyValidator extends Validator<string> {
  constructor() {
    super();
  }
}
.
class MySchema extends Schema {
  @StringField({ validators: [new TimeZoneValidator()]})
  myField: string
}

We are forced by typescript to override the constructor, because we cannot use new TimeZoneValidator(), if the constructor is protected

Proposed solution

Make the constructor public, so we don't need to override it.

Remove ValidationError from the Processor level

Improve error throwing

The package has 3 levels of validations:

• Validator level - throws ValidateError which has a message
• Processor level - validates the field by applying all the validators. At this level, an array with all the ValidateError messages must be constructed and an ProcessorValidateError is thrown with the array
• Schema validate - validates all the fields and constructs an object containing as keys the properties and as value the array of errors. The thrown error must be ValidateError

Add EnumField & EnumProccessor

Description
Add the EnumField decorator and create the processor for the field.

The field's toInternalValue will transform the input string into the the Enum type and check if it is a valid value for the enum.

Configuration:
enum - The enum that you want the string to be checked against.

Add Polymorphic Schema

We should have a class PolymorphicSchema which should have the following:

• a lookup field which by default should have the value type
• an object field which will store a key value. The value will be a schema and the key should be used to determine which schema we are using.

Inherit fields from parent classes

Description

Inherit the fields from all parent classes.

e.g:

class BaseSchema extends Schema<BasePayload> {
  @StringField()
  parentField: string;
}

class ChildSchema extends Schema<ChildPayload> {
  @IntegerField()
  extraField: string;
}

When the ChildSchema is validated, it should also validate the parentField

Add toInternalValue method on Schema

We need a function that saves the values that will we processed by Schema.

class Schema {
  protected toInternalValue(date: T): C {
  }
}

Replace Nested Field any with type

The nested fields configuration should stop using any.

export type NestedFieldConfiguration<T> = {
  validator: any; //TODO: Update type
};

Nested validation not working correctly

Nested validation does not call validate function from nested schema.

Add fromField config for the decorator config

The field decorators need to allow the possibility to specify from where that field gets the value from the input data.

Example usage:

@StringField({fromField: 'last_name'})
lastName: string;

Add ArrayField & ArrayProcessor

Description
Add the ArrayField decorator and create the processor for the field.

The field should allow specifying what is the child value that is going to be validated. It is either a primitive value (another field) or another schema.

Add ability input custom validators for the fields

Add the ability to input custom validators for fields that will not override the default preset validators but will be both applied.

const isValidString = (value: string) => !value.isEmpty()
@StringField({validators: [isValidString]})

Ad github actions initial CI/CD

Required property from Fields is not working for Schemas

IntegerProcessor and FloatProcessor not returning number

Currently the processor are not converting the values from string to number.

Support multiple values validation

Add EmailField & EmailFieldProcessor

Description

Add the EmailField decorator and create the processor for the field.

Add JsonField & JsonFieldProcessor

Schema nested field validation incorrect

Add DateField & DateProcessor

Description

Add the DateField decorator and create the processor for the field.

The field's toInternalValue will transform the input string to a date format and check the formats allowed. If the value is a date, it doesn't need transforming anymore.

For working with date functions, add date-fns package

Configuration:

• formats - An array of allowed formats (e.g: MM/dd/yyyy)