@bakku/validation

v4.0.2

Published

a year ago

## 1.1 Install

Downloads

0High
0Medium
0Low

binle

1 Install & Use

1.1 Install

npm install @bakku/validation

1.2 Use

Recommended use `asyncValidate` function for all validation.

Return an error if it is failed the validation, return correct value of data if it passed the validation

Refer: use asyncValidate

asyncValidate = async <T = any>(
  schema?: ISchemaCore<T>,
  data?: T,
  name?: string
): Promise<IValidationError | TypeOptional<T>> => {

1.2.1 asyncValidateString

Return an error if it is failed the validation, return string (as inputted data) if it passed the validation Refer: use asyncValidateString

asyncValidateString = async (
  schema: IStringSchema,
  data?: any,
  name?: string
): Promise<IValidationError | string>

1.2.2 asyncValidateNumber

Return an error if it is failed the validation, return number (as inputted data or converted data) if it passed the validation Refer: use asyncValidateNumber

asyncValidateNumber = async (
  schema: INumberSchema,
  data?: any,
  name?: string
): Promise<IValidationError | number> => {

1.2.3 asyncValidateInteger

Return an error if it is failed the validation, return integer (as inputted data or converted data) if it passed the validation Refer: use asyncValidateInteger

asyncValidateInteger = async (
  schema: IIntegerSchema,
  data?: any,
  name?: string
): Promise<IValidationError | number> => {

1.2.4 asyncValidateFile

Note: file type is Express.Multer.File Return an error if it is failed the validation, return file (as inputted data) if it passed the validation Refer: use asyncValidateFile

asyncValidateFile = async (
  schema: IFileSchema,
  data?: any,
  name?: string
): Promise<IValidationError | Express.Multer.File> => {

1.2.5 asyncValidateDate

Return an error if it is failed the validation, return Date (as inputted data or converted data) if it passed the validation Refer: use asyncValidateDate

Note: we convert to moment data for validation, so the format base on moment rules.

asyncValidateDate = async (
  schema: IDateSchema,
  data?: any,
  name?: string
): Promise<IValidationError | Date> => {

1.2.6 asyncValidateBoolean

Return an error if it is failed the validation, return Boolean (as inputted data or converted data) if it passed the validation Refer: use asyncValidateBoolean

asyncValidateBoolean = async (
  schema: IBooleanSchema,
  data?: any,
  name?: string
): Promise<IValidationError | boolean> => {

1.2.7 asyncValidateEnum

Return an error if it is failed the validation, return Enum Value (as inputted data) if it passed the validation Refer: use asyncValidateEnum

asyncValidateEnum = async (
  schema: IEnumSchema,
  data?: any,
  name?: string
): Promise<IValidationError | any> => {

1.2.8 asyncValidateArray

Return an error if it is failed the validation, return Array (as inputted data with corrected items ) if it passed the validation Refer: use asyncValidateArray

asyncValidateArray = async <T>(
  schema: IArraySchema<T>,
  data?: any,
  name?: string
): Promise<IValidationError | Array<T>> => {

1.2.9 asyncValidateObject

Return an error if it is failed the validation, return Object (as inputted data with corrected properties ) if it passed the validation Refer: use asyncValidateObject

asyncValidateObject = async <T = unknown>(
  schema: IObjectSchema<T>,
  data?: T,
  name?: string
): Promise<IValidationError | TypeOptional<T>> => {

2 Schemas

ISchemaGeneral is a common type, It can be understand as all schema has in the library.

export type ISchemaGeneral =  ISchemaCore | IBooleanSchema | IStringSchema | INumberSchema | IIntegerSchema | IFileSchema | IDateSchema | IEnumSchema | IArraySchema | IObjectSchema;

2.1 ISchemaCore.

Core schema with validation is extends IValidationCore

| Property | Type | Required | Default | Description | | :----------- | :----------------------------------------------------------------------- | -------- | ---------------- | ---------------------------------------------------------- | | type | enum: SchemaType | | default object | type of schema which we base on that to validate | | propertyType | Class name, Function object name | | | use for validation an object class (type is object) | | description | String | | | Description for schema | | validation | Object: Instance of object extend IValidationCore | | | Detail the validation rules, custom the validation if need |

2.2 IStringSchema.

String schema extend ISchemaCore with validation is IValidationString

2.3 INumberSchema.

Number schema extend ISchemaCore with validation is IValidationNumber

2.4 IIntegerSchema.

Integer schema extend ISchemaCore with validation is IValidationInteger

2.5 IFileSchema.

File schema extend ISchemaCore with validation is IValidationFile

2.6 IDateSchema.

Array schema extend ISchemaCore with validation is IValidationDate with extra properties:

| Property | Type | Required | Default | Description | | :------------------ | :-------------------------- | -------- | ------- | ------------------------------------------ | | format | string | | | moment format | | convertToDateMoment | (originData: any) => Moment | | | convert data to moment date for validation |

let dateSchema: IDateSchema = {
  type: 'date',
  dateFormat: 'YYYY-MM-DD',
  validation: {...},
};
// **Note: when you use convertToDateMoment, dateFormat will be ignored.**
dateSchema = {
  type: 'date',
  convertToDateMoment: (date) => moment(date, 'YYYY-MM-DD'),
  validation: {...},
};

// convert to local timezone
dateSchema = {
  type: 'date',
  convertToDateMoment: (data: string) => {
    const currentOffset = moment().utcOffset();
    return moment.utc(data, 'YYYY-MM-DD').utcOffset(currentOffset);
  },
  validation: {...},
};

2.6 IEnumSchema.

Enum schema extend ISchemaCore with validation is IValidationEnum with extra properties:

| Property | Type | Required | Default | Description | | :------- | :--------------------------------- | -------- | ------- | ------------------------- | | enumData | {[key: string]:(string or number)} | true | | all data can have of enum | | enumName | string | | | name of enum |

enum TempEnum {
  active = 'active',
  inactive = 'inactive',
  normal = 'normal',
}
const enumSchema: IEnumSchema = {
  type: 'enum',
  enumData: getEnumData(TempEnum),
  enumName: 'TempEnum'
  validation: {...},
};

2.6 IArraySchema.

Array schema extend ISchemaCore with validation is IValidationArray with extra properties:

| Property | Type | Required | Default | Description | | :--------- | :--------------------------- | -------- | ------- | --------------------------------------------------- | | itemSchema | ISchemaGeneral | | | schema use to verify(if needed) each item in array, |

2.6 IObjectSchema.

Object schema extend ISchemaCore with validation is IValidationObject with extra properties:

| Property | Type | Required | Default | Description | | :--------- | :------------------------------------ | -------- | ------- | -------------------------------------------------------------------- | | properties | {[key]: ISchemaGeneral} | | | each property will have a schema which use for validation it's value |

#3 . Data

3.1 SchemaType


Types of schema which library support for validation:
'boolean' |'string' |'number' |'integer' |'enum' |'date' |'file' |'array' |'object'

3.2 IValidationCore

| Property | Type | Required | Default | Description | | :--------- | :------- | -------- | ------- | ------------------------------------------------------------------ | | isRequired | Boolean | | false | mark for validation, item is required or not, default is false | | validation | Function | | | custom the added validation with data of item and item's path name |

NOTE: validation: (data, pathName) => (IValidationError | undefined) | Promise<IValidationError | undefined>