@cleverbrush/schema 0.0.7 → 0.0.10

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import SchemaValidator from './schemaValidator';
-export declare type DefaultSchemaType = 'object' | 'function' | 'number' | 'string' | 'array';
+export declare type DefaultSchemaType = 'object' | 'function' | 'number' | 'string' | 'array' | 'alias';
 export declare type PropType<TObj, TProp extends keyof TObj> = TObj[TProp];
 export declare type DefaultPropertyDefinition = {
     isRequired: boolean;
@@ -23,6 +23,13 @@ export declare type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'>
     properties?: Partial<{
         [S in keyof T]: Schema<PropType<T, S>>;
     }>;
+    preprocessors?: Partial<{
+        [S in keyof T]: ((value: unknown) => PropType<T, S> | Promise<PropType<T, S>>) | string;
+    }>;
+};
+export declare type AliasSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
+    type: 'alias';
+    schemaName: string;
 };
 export declare type ObjectSchemaDefinitionParam<T> = Omit<ObjectSchemaDefinition<T>, 'type'>;
 export declare type ParamsValidators<TFunc extends (...args: any) => any> = {
@@ -53,7 +60,7 @@ export declare type ArraySchemaDefinition<TObj> = Omit<SchemaDefintion<TObj>, 't
     minLength?: number;
     maxLength?: number;
 };
-export declare type CompositeSchema<TObj> = TObj extends (...args: any) => any ? FunctionSchemaDefinition<TObj> : TObj extends number ? NumberSchemaDefinition<TObj> : TObj extends string ? StringSchemaDefinition<TObj> | 'string' : NumberSchemaDefinition<TObj> | StringSchemaDefinition<TObj> | ArraySchemaDefinition<TObj> | ObjectSchemaDefinition<TObj>;
+export declare type CompositeSchema<TObj> = TObj extends (...args: any) => any ? FunctionSchemaDefinition<TObj> : TObj extends number ? NumberSchemaDefinition<TObj> : TObj extends string ? StringSchemaDefinition<TObj> | 'string' : NumberSchemaDefinition<TObj> | StringSchemaDefinition<TObj> | ArraySchemaDefinition<TObj> | ObjectSchemaDefinition<TObj> | AliasSchemaDefinition<TObj>;
 export declare type SingleSchema<TObj = Record<string, never>> = number | string | DefaultSchemaType | CompositeSchema<TObj>;
 export declare type Schema<TObj> = SingleSchema<TObj> | Array<SingleSchema<TObj>>;
 export interface ISchemaActions<K, T extends keyof K> {
@@ -66,6 +73,8 @@ export interface ISchemasProvider<T = Record<string, never>> {
     };
 }
 export interface ISchemaValidator<T = Record<string, never>> {
+    get preprocessors(): Map<string, (value: unknown) => unknown | Promise<unknown>>;
+    addPreprocessor(name: string, preprocessor: (value: unknown) => unknown | Promise<unknown>): SchemaValidator<T>;
     addSchemaType<K, L extends ObjectSchemaDefinitionParam<M>, M = any>(name: keyof K, schema: L | Array<Schema<any>>): SchemaValidator<T & {
         [key in keyof K]: typeof schema;
     }>;

package/dist/schemaValidator.d.ts

@@ -2,6 +2,9 @@ import { ISchemasProvider, Schema, ISchemaActions, ObjectSchemaDefinitionParam,
 export default class SchemaValidator<T = Record<string, never>> implements ISchemasProvider<T>, ISchemaValidator<T> {
     private _schemasMap;
     private _schemasCache;
+    private _preprocessorsMap;
+    get preprocessors(): Map<string, (value: unknown) => unknown>;
+    addPreprocessor(name: string, preprocessor: (value: unknown) => unknown | Promise<unknown>): SchemaValidator<T>;
     addSchemaType<K, L extends ObjectSchemaDefinitionParam<M>, M = any>(name: keyof K, schema: L | Array<Schema<any>>): SchemaValidator<T & {
         [key in keyof K]: L;
     }>;

package/dist/schemaValidator.js

@@ -37,6 +37,16 @@ const isDefaultType = (name) => defaultSchemaNames.indexOf(name) !== -1;
 class SchemaValidator {
     _schemasMap = new Map();
     _schemasCache = null;
+    _preprocessorsMap = new Map();
+    get preprocessors() {
+        return this._preprocessorsMap;
+    }
+    addPreprocessor(name, preprocessor) {
+        if (this._preprocessorsMap.has(name))
+            throw new Error(`Preprocessor '${name}' is already registered`);
+        this._preprocessorsMap.set(name, preprocessor);
+        return this;
+    }
     addSchemaType(name, schema) {
         if (typeof name !== 'string' || !name)
             throw new Error('Name is required');
@@ -95,6 +105,11 @@ class SchemaValidator {
         throw new Error('not implemented');
     }
     async checkValidators(schema, value) {
+        if (!schema.isRequired && typeof value === 'undefined') {
+            return {
+                valid: true
+            };
+        }
         if (Array.isArray(schema.validators)) {
             const validatorsResults = await Promise.allSettled(schema.validators.map((v) => Promise.resolve(v(value))));
             const rejections = validatorsResults
@@ -166,6 +181,26 @@ class SchemaValidator {
             if (isDefaultType(schema.type)) {
                 return await this.validateDefaultType(schema.type, obj, schema);
             }
+            else if (schema.type === 'alias') {
+                const alias = this.schemas[schema.schemaName]
+                    .schema;
+                if (Array.isArray(alias)) {
+                    if ((!schema.isRequired && typeof obj === 'undefined') ||
+                        (schema.isNullable && obj === null)) {
+                        return {
+                            valid: true
+                        };
+                    }
+                    return await this.validate(alias, obj);
+                }
+                if (typeof alias !== 'object')
+                    throw new Error('it is only possible to use a full schema schema definition as alias');
+                const schemaToMerge = { ...schema };
+                delete schemaToMerge.type;
+                delete schemaToMerge.schemaName;
+                const finalSchema = (0, deep_1.deepExtend)(alias, schemaToMerge);
+                return await this.validate(finalSchema, obj);
+            }
             else if (schema.type === 'object') {
                 const preliminaryResult = await (0, validateObject_1.validateObject)(obj, schema, this);
                 if (!preliminaryResult.valid)

package/dist/validators/validateObject.js

@@ -17,6 +17,20 @@ const validateObject = async (obj, schema, validator) => {
             ]
         };
     }
+    if (typeof schema.preprocessors === 'object' && schema.preprocessors) {
+        await Promise.all(Object.keys(schema.preprocessors).map(async (key) => {
+            if (typeof schema.preprocessors[key] === 'function') {
+                obj[key] = await Promise.resolve(schema.preprocessors[key](obj[key]));
+            }
+            else {
+                const preprocessor = validator.preprocessors.get(schema.preprocessors[key]);
+                if (typeof preprocessor !== 'function') {
+                    throw new Error(`preprocessor '${schema.preprocessors[key]}' is unknown`);
+                }
+                obj[key] = await Promise.resolve(preprocessor(obj[key]));
+            }
+        }));
+    }
     if (typeof schema.properties === 'object' && schema.properties) {
         const errors = (await Promise.all(Object.entries(schema.properties).map(async ([name, schema]) => {
             const result = await validator.validate(schema, obj[name]);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cleverbrush/schema",
-    "version": "0.0.7",
+    "version": "0.0.10",
     "keywords": [
         "object schema validator",
         "schema",
@@ -19,7 +19,7 @@
         "build": "tsc"
     },
     "dependencies": {
-        "@cleverbrush/deep": "0.0.7"
+        "@cleverbrush/deep": "0.0.10"
     },
     "types": "./dist/index.d.ts"
 }

package/src/index.ts

@@ -5,7 +5,8 @@ export type DefaultSchemaType =
     | 'function'
     | 'number'
     | 'string'
-    | 'array';
+    | 'array'
+    | 'alias';
 
 export type PropType<TObj, TProp extends keyof TObj> = TObj[TProp];
 
@@ -38,6 +39,16 @@ export type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
     properties?: Partial<{
         [S in keyof T]: Schema<PropType<T, S>>;
     }>;
+    preprocessors?: Partial<{
+        [S in keyof T]:
+            | ((value: unknown) => PropType<T, S> | Promise<PropType<T, S>>)
+            | string;
+    }>;
+};
+
+export type AliasSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
+    type: 'alias';
+    schemaName: string;
 };
 
 export type ObjectSchemaDefinitionParam<T> = Omit<
@@ -100,7 +111,8 @@ export type CompositeSchema<TObj> = TObj extends (...args: any) => any
           | NumberSchemaDefinition<TObj>
           | StringSchemaDefinition<TObj>
           | ArraySchemaDefinition<TObj>
-          | ObjectSchemaDefinition<TObj>;
+          | ObjectSchemaDefinition<TObj>
+          | AliasSchemaDefinition<TObj>;
 
 export type SingleSchema<TObj = Record<string, never>> =
     | number
@@ -122,6 +134,15 @@ export interface ISchemasProvider<T = Record<string, never>> {
 }
 
 export interface ISchemaValidator<T = Record<string, never>> {
+    get preprocessors(): Map<
+        string,
+        (value: unknown) => unknown | Promise<unknown>
+    >;
+    addPreprocessor(
+        name: string,
+        preprocessor: (value: unknown) => unknown | Promise<unknown>
+    ): SchemaValidator<T>;
+
     addSchemaType<K, L extends ObjectSchemaDefinitionParam<M>, M = any>(
         name: keyof K,
         schema: L | Array<Schema<any>>

package/src/schemaValidator.test.ts

@@ -913,7 +913,7 @@ test('Validate - one of - 1', async () => {
     expect(result).toHaveProperty('valid', true);
 });
 
-test('Validate schema', async () => {
+test('Validate schema - 1', async () => {
     const authorsReportSpecificationSchema = {
         properties: {
             type: {
@@ -1120,3 +1120,182 @@ test('Validate schema', async () => {
 
     expect(result).toHaveProperty('valid', true);
 });
+
+test('Validate schema - 2', async () => {
+    const validator = new SchemaValidator().addSchemaType('Date', {
+        validators: [
+            (value) =>
+                value instanceof Date && !Number.isNaN(value)
+                    ? {
+                          valid: true
+                      }
+                    : {
+                          valid: false,
+                          errors: ['should be a valid Date object']
+                      }
+        ]
+    });
+
+    const result = await validator.validate(
+        {
+            type: 'object',
+            properties: {
+                date: {
+                    type: 'alias',
+                    schemaName: 'Date',
+                    isRequired: false
+                }
+            }
+        },
+        {}
+    );
+
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Not required alternative schema alias', async () => {
+    const validator = new SchemaValidator()
+        .addSchemaType('Alternate1', {
+            properties: {
+                a1: 'string'
+            }
+        })
+        .addSchemaType('Alternate2', {
+            properties: {
+                a2: 'string'
+            }
+        })
+        .addSchemaType('Alternate', ['Alternate1', 'Alternate2']);
+
+    let result = await validator.validate(
+        {
+            type: 'alias',
+            isRequired: false,
+            schemaName: 'Alternate'
+        },
+        undefined
+    );
+
+    expect(result).toHaveProperty('valid', true);
+
+    result = await validator.validate(
+        {
+            type: 'alias',
+            isRequired: false,
+            schemaName: 'Alternate'
+        },
+        {
+            a2: 'something'
+        }
+    );
+
+    expect(result).toHaveProperty('valid', true);
+
+    result = await validator.validate(
+        {
+            type: 'alias',
+            isRequired: false,
+            schemaName: 'Alternate'
+        },
+        'invalid'
+    );
+
+    expect(result).toHaveProperty('valid', false);
+});
+
+test('Preprocessors - 1', async () => {
+    const validator = new SchemaValidator().addSchemaType('Date', {
+        validators: [
+            (value) =>
+                value instanceof Date && !Number.isNaN(value)
+                    ? {
+                          valid: true
+                      }
+                    : {
+                          valid: false,
+                          errors: ['should be a valid Date object']
+                      }
+        ]
+    });
+
+    const schema: Schema<{ bornAt: Date }> = {
+        type: 'object',
+        properties: {
+            bornAt: 'Date'
+        },
+        preprocessors: {
+            bornAt: (value: unknown): Date => {
+                const time = Date.parse(value.toString());
+                if (Number.isNaN(time)) return undefined;
+                return new Date(time);
+            }
+        }
+    };
+
+    const result = await validator.validate(schema, {
+        bornAt: new Date().toJSON()
+    });
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Preprocessors - 2', async () => {
+    const validator = new SchemaValidator().addSchemaType('Date', {
+        validators: [
+            (value) =>
+                value instanceof Date && !Number.isNaN(value)
+                    ? {
+                          valid: true
+                      }
+                    : {
+                          valid: false,
+                          errors: ['should be a valid Date object']
+                      }
+        ]
+    });
+
+    let schema: Schema<{ bornAt: Date; diedAt?: Date }> = {
+        type: 'object',
+        properties: {
+            bornAt: 'Date'
+        },
+        preprocessors: {
+            bornAt: 'StringToDate'
+        }
+    };
+
+    validator.addPreprocessor('StringToDate', (value: unknown): Date => {
+        const time = Date.parse(value.toString());
+        if (Number.isNaN(time)) return undefined;
+        return new Date(time);
+    });
+
+    expect(() =>
+        validator.addPreprocessor('StringToDate', (value: unknown): Date => {
+            const time = Date.parse(value.toString());
+            if (Number.isNaN(time)) return undefined;
+            return new Date(time);
+        })
+    ).toThrow();
+
+    const result = await validator.validate(schema, {
+        bornAt: new Date().toJSON()
+    });
+    expect(result).toHaveProperty('valid', true);
+
+    schema = {
+        type: 'object',
+        properties: {
+            bornAt: 'Date',
+            diedAt: 'Date'
+        },
+        preprocessors: {
+            bornAt: 'StringToDate',
+            diedAt: 'Unregistered'
+        }
+    };
+    expect(async () => {
+        await validator.validate(schema, {
+            bornAt: new Date().toJSON()
+        });
+    }).rejects.toBeInstanceOf(Error);
+});

package/src/schemaValidator.ts

@@ -70,6 +70,24 @@ export default class SchemaValidator<T = Record<string, never>>
 {
     private _schemasMap = new Map<string, Schema<any>>();
     private _schemasCache: { [K in keyof T]: ISchemaActions<T, K> } = null;
+    private _preprocessorsMap = new Map<
+        string,
+        (value: unknown) => unknown | Promise<unknown>
+    >();
+
+    public get preprocessors(): Map<string, (value: unknown) => unknown> {
+        return this._preprocessorsMap;
+    }
+
+    public addPreprocessor(
+        name: string,
+        preprocessor: (value: unknown) => unknown | Promise<unknown>
+    ): SchemaValidator<T> {
+        if (this._preprocessorsMap.has(name))
+            throw new Error(`Preprocessor '${name}' is already registered`);
+        this._preprocessorsMap.set(name, preprocessor);
+        return this;
+    }
 
     public addSchemaType<K, L extends ObjectSchemaDefinitionParam<M>, M = any>(
         name: keyof K,
@@ -156,6 +174,11 @@ export default class SchemaValidator<T = Record<string, never>>
         schema: CompositeSchema<Record<string, never>>,
         value: any
     ): Promise<ValidationResult> {
+        if (!schema.isRequired && typeof value === 'undefined') {
+            return {
+                valid: true
+            };
+        }
         if (Array.isArray(schema.validators)) {
             const validatorsResults = await Promise.allSettled(
                 schema.validators.map((v) => Promise.resolve(v(value)))
@@ -251,6 +274,33 @@ export default class SchemaValidator<T = Record<string, never>>
                     obj,
                     schema
                 );
+            } else if (schema.type === 'alias') {
+                const alias = this.schemas[schema.schemaName]
+                    .schema as Schema<any>;
+                if (Array.isArray(alias)) {
+                    if (
+                        (!schema.isRequired && typeof obj === 'undefined') ||
+                        (schema.isNullable && obj === null)
+                    ) {
+                        return {
+                            valid: true
+                        };
+                    }
+                    return await this.validate(alias, obj);
+                }
+                if (typeof alias !== 'object')
+                    throw new Error(
+                        'it is only possible to use a full schema schema definition as alias'
+                    );
+
+                const schemaToMerge = { ...schema };
+                delete schemaToMerge.type;
+                delete schemaToMerge.schemaName;
+                const finalSchema: Schema<any> = deepExtend(
+                    alias,
+                    schemaToMerge
+                );
+                return await this.validate(finalSchema, obj);
             } else if (schema.type === 'object') {
                 const preliminaryResult = await validateObject(
                     obj,

package/src/validators/validateObject.ts

@@ -28,6 +28,30 @@ export const validateObject = async (
         };
     }
 
+    if (typeof schema.preprocessors === 'object' && schema.preprocessors) {
+        await Promise.all(
+            Object.keys(schema.preprocessors).map(async (key: string) => {
+                if (typeof schema.preprocessors[key] === 'function') {
+                    obj[key] = await Promise.resolve(
+                        (schema.preprocessors[key] as (unknown) => unknown)(
+                            obj[key]
+                        )
+                    );
+                } else {
+                    const preprocessor = validator.preprocessors.get(
+                        schema.preprocessors[key] as string
+                    );
+                    if (typeof preprocessor !== 'function') {
+                        throw new Error(
+                            `preprocessor '${schema.preprocessors[key]}' is unknown`
+                        );
+                    }
+                    obj[key] = await Promise.resolve(preprocessor(obj[key]));
+                }
+            })
+        );
+    }
+
     if (typeof schema.properties === 'object' && schema.properties) {
         const errors = (
             await Promise.all(