@cleverbrush/schema 0.0.11 → 0.0.14

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import SchemaValidator from './schemaValidator';
-export declare type DefaultSchemaType = 'object' | 'function' | 'number' | 'string' | 'array' | 'alias';
+export declare type DefaultSchemaType = 'object' | 'boolean' | 'function' | 'number' | 'string' | 'array' | 'alias';
 export declare type PropType<TObj, TProp extends keyof TObj> = TObj[TProp];
 export declare type DefaultPropertyDefinition = {
     isRequired: boolean;
@@ -24,7 +24,7 @@ export declare type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'>
         [S in keyof T]: Schema<PropType<T, S>>;
     }>;
     preprocessors?: Partial<{
-        [S in keyof T]: ((value: unknown) => PropType<T, S> | Promise<PropType<T, S>>) | string;
+        [S in keyof T | '*']: S extends keyof T ? ((value: unknown) => PropType<T, S> | Promise<PropType<T, S>>) | string : (value: T) => void | Promise<void>;
     }>;
 };
 export declare type AliasSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
@@ -39,6 +39,10 @@ export declare type FunctionSchemaDefinition<T extends (...args: any) => any> =
     type: 'function';
     params?: ParamsValidators<T>;
 };
+export declare type BooleanSchemaDefinition<TObj> = Omit<SchemaDefintion<TObj>, 'type'> & {
+    type: 'boolean';
+    equals?: boolean;
+};
 export declare type NumberSchemaDefinition<TObj> = Omit<SchemaDefintion<TObj>, 'type'> & {
     type: 'number';
     min?: number;
@@ -61,7 +65,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> | AliasSchemaDefinition<TObj>;
+export declare type CompositeSchema<TObj> = TObj extends (...args: any) => any ? FunctionSchemaDefinition<TObj> : TObj extends number ? NumberSchemaDefinition<TObj> : TObj extends string ? StringSchemaDefinition<TObj> | 'string' : BooleanSchemaDefinition<TObj> | 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> {

package/dist/schemaValidator.d.ts

@@ -13,5 +13,5 @@ export default class SchemaValidator<T = Record<string, never>> implements ISche
     };
     private validateDefaultType;
     private checkValidators;
-    validate(schema: keyof T | DefaultSchemaType | Schema<any>, obj: any): Promise<ValidationResult>;
+    validate<K>(schema: keyof T | DefaultSchemaType | Schema<K>, obj: any): Promise<ValidationResult>;
 }

package/dist/schemaValidator.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const deep_1 = require("@cleverbrush/deep");
 const validateNumber_1 = require("./validators/validateNumber");
+const validateBoolean_1 = require("./validators/validateBoolean");
 const validateString_1 = require("./validators/validateString");
 const validateArray_1 = require("./validators/validateArray");
 const validateObject_1 = require("./validators/validateObject");
-const defaultSchemaNames = ['string', 'number', 'date', 'array'];
+const defaultSchemaNames = ['string', 'boolean', 'number', 'date', 'array'];
 const defaultSchemas = {
     number: {
         type: 'number',
@@ -14,6 +15,11 @@ const defaultSchemas = {
         ensureNotNaN: true,
         ensureIsFinite: true
     },
+    boolean: {
+        type: 'boolean',
+        isRequired: true,
+        isNullable: false
+    },
     string: {
         type: 'string',
         isNullable: false,
@@ -30,6 +36,7 @@ const defaultSchemas = {
 };
 const defaultSchemasValidationStrategies = {
     number: (obj, schema, validator) => (0, validateNumber_1.validateNumber)(obj, schema, validator),
+    boolean: (obj, schema, validator) => (0, validateBoolean_1.validateBoolean)(obj, schema, validator),
     string: (obj, schema, validator) => (0, validateString_1.validateString)(obj, schema, validator),
     array: (obj, schema, validator) => (0, validateArray_1.validateArray)(obj, schema, validator)
 };

package/dist/validators/validateBoolean.d.ts

@@ -0,0 +1,2 @@
+import { ValidationResult, BooleanSchemaDefinition, ISchemaValidator } from '../index';
+export declare const validateBoolean: (obj: any, schema: BooleanSchemaDefinition<any>, validator: ISchemaValidator<any>) => Promise<ValidationResult>;

package/dist/validators/validateBoolean.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBoolean = void 0;
+const validateBoolean = async (obj, schema, validator) => {
+    if (typeof obj === 'undefined' &&
+        typeof schema === 'object' &&
+        schema.isRequired === false) {
+        return {
+            valid: true
+        };
+    }
+    if (typeof obj !== 'boolean')
+        return {
+            valid: false,
+            errors: [`expected type boolean, but saw ${typeof obj}`]
+        };
+    if (typeof schema === 'boolean') {
+        return { valid: true };
+    }
+    const bool = obj;
+    if (typeof schema.equals === 'boolean') {
+        return schema.equals === bool
+            ? { valid: true }
+            : {
+                valid: false,
+                errors: [`must be equal to ${schema.equals}`]
+            };
+    }
+    return {
+        valid: true
+    };
+};
+exports.validateBoolean = validateBoolean;

package/dist/validators/validateObject.js

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

package/package.json

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

package/src/index.ts

@@ -2,6 +2,7 @@ import SchemaValidator from './schemaValidator';
 
 export type DefaultSchemaType =
     | 'object'
+    | 'boolean'
     | 'function'
     | 'number'
     | 'string'
@@ -40,9 +41,13 @@ export type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
         [S in keyof T]: Schema<PropType<T, S>>;
     }>;
     preprocessors?: Partial<{
-        [S in keyof T]:
-            | ((value: unknown) => PropType<T, S> | Promise<PropType<T, S>>)
-            | string;
+        [S in keyof T | '*']: S extends keyof T
+            ?
+                  | ((
+                        value: unknown
+                    ) => PropType<T, S> | Promise<PropType<T, S>>)
+                  | string
+            : (value: T) => void | Promise<void>;
     }>;
 };
 
@@ -68,6 +73,14 @@ export type FunctionSchemaDefinition<T extends (...args: any) => any> = Omit<
     params?: ParamsValidators<T>;
 };
 
+export type BooleanSchemaDefinition<TObj> = Omit<
+    SchemaDefintion<TObj>,
+    'type'
+> & {
+    type: 'boolean';
+    equals?: boolean;
+};
+
 export type NumberSchemaDefinition<TObj> = Omit<
     SchemaDefintion<TObj>,
     'type'
@@ -109,6 +122,7 @@ export type CompositeSchema<TObj> = TObj extends (...args: any) => any
     : TObj extends string
     ? StringSchemaDefinition<TObj> | 'string'
     :
+          | BooleanSchemaDefinition<TObj>
           | NumberSchemaDefinition<TObj>
           | StringSchemaDefinition<TObj>
           | ArraySchemaDefinition<TObj>

package/src/schemaValidator.test.ts

@@ -4,6 +4,7 @@ import { ValidationResult } from '../dist/index.js';
 import {
     NumberSchemaDefinition,
     ObjectSchemaDefinitionParam,
+    ObjectSchemaDefinition,
     Schema
 } from './index';
 import SchemaValidator from './schemaValidator';
@@ -553,6 +554,82 @@ test('Validate - number by schema - custom validators - 2', async () => {
     expect(result).toHaveProperty('valid', false);
 });
 
+test('Validate - boolean - 1', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate(
+        {
+            type: 'boolean'
+        },
+        300
+    );
+
+    expect(result).toHaveProperty('valid', false);
+});
+
+test('Validate - boolean - 2', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate(
+        {
+            type: 'boolean'
+        },
+        true
+    );
+
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Validate - boolean - 3', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate(
+        {
+            type: 'boolean'
+        },
+        false
+    );
+
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Validate - boolean - 4', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate(
+        {
+            type: 'boolean',
+            equals: true
+        },
+        false
+    );
+
+    expect(result).toHaveProperty('valid', false);
+});
+
+test('Validate - boolean - 5', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate(
+        {
+            type: 'boolean',
+            equals: false
+        },
+        false
+    );
+
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Validate - boolean - 6', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate('boolean', false);
+
+    expect(result).toHaveProperty('valid', true);
+});
+
+test('Validate - boolean - 7', async () => {
+    const validator = new SchemaValidator();
+    const result = await validator.validate('boolean', '123');
+
+    expect(result).toHaveProperty('valid', false);
+});
+
 test('Validate - string - 1', async () => {
     const validator = new SchemaValidator();
     const result = await validator.validate('string', '12345');
@@ -829,7 +906,7 @@ test('Validate - object - 1', async () => {
                 b: 'number'
             },
             validators: [
-                (value) => {
+                (value: { a: number; b: number }) => {
                     if (value.a + value.b === 5) {
                         return {
                             valid: true
@@ -1363,3 +1440,96 @@ test('Preprocessors - 3', async () => {
     );
     expect(result).toHaveProperty('valid', false);
 });
+
+test('Preprocessors - 3', async () => {
+    const validator = new SchemaValidator();
+
+    type SomeType = { age: number; marriedAt: number };
+
+    const schema: ObjectSchemaDefinition<SomeType> = {
+        type: 'object',
+        properties: {
+            age: 'number',
+            marriedAt: 'number'
+        },
+        preprocessors: {
+            age: (value): number => 40,
+            '*': (value: SomeType): void => {
+                if (value.marriedAt > value.age) {
+                    value.marriedAt = value.age;
+                }
+            }
+        }
+    };
+
+    const obj = {
+        age: 50,
+        marriedAt: 80
+    };
+    await validator.validate(schema, obj);
+    expect(obj).toHaveProperty('marriedAt', 40);
+});
+
+test('Preprocessors - 4', 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']
+                      }
+        ]
+    });
+
+    validator.addPreprocessor('StringToDate', (value: unknown): Date => {
+        const time = Date.parse(value.toString());
+        if (Number.isNaN(time)) return undefined;
+        return new Date(time);
+    });
+
+    let obj = [new Date().toJSON()];
+
+    let result = await validator.validate(
+        {
+            preprocessor: 'StringToDate',
+            type: 'array',
+            ofType: 'Date'
+        },
+        obj
+    );
+    expect(result).toHaveProperty('valid', true);
+
+    obj = [new Date().toJSON()];
+    result = await validator.validate(
+        {
+            preprocessor: (value: unknown): Date => {
+                const time = Date.parse(value.toString());
+                if (Number.isNaN(time)) return undefined;
+                return new Date(time);
+            },
+            type: 'array',
+            ofType: 'Date'
+        },
+        obj
+    );
+    expect(result).toHaveProperty('valid', true);
+
+    obj = ['sdfsdf12', new Date().toJSON()];
+    result = await validator.validate(
+        {
+            preprocessor: (value: unknown): Date => {
+                const time = Date.parse(value.toString());
+                if (Number.isNaN(time)) return undefined;
+                return new Date(time);
+            },
+            type: 'array',
+            ofType: 'Date'
+        },
+        obj
+    );
+    expect(result).toHaveProperty('valid', false);
+});

package/src/schemaValidator.ts

@@ -12,14 +12,16 @@ import {
     ArraySchemaDefinition,
     ISchemaValidator,
     DefaultSchemaType,
-    ObjectSchemaDefinition
+    ObjectSchemaDefinition,
+    BooleanSchemaDefinition
 } from './index';
 import { validateNumber } from './validators/validateNumber';
+import { validateBoolean } from './validators/validateBoolean';
 import { validateString } from './validators/validateString';
 import { validateArray } from './validators/validateArray';
 import { validateObject } from './validators/validateObject';
 
-const defaultSchemaNames = ['string', 'number', 'date', 'array'];
+const defaultSchemaNames = ['string', 'boolean', 'number', 'date', 'array'];
 
 const defaultSchemas: { [key in DefaultSchemaType]?: Schema<any> } = {
     number: {
@@ -29,6 +31,11 @@ const defaultSchemas: { [key in DefaultSchemaType]?: Schema<any> } = {
         ensureNotNaN: true,
         ensureIsFinite: true
     },
+    boolean: {
+        type: 'boolean',
+        isRequired: true,
+        isNullable: false
+    },
     string: {
         type: 'string',
         isNullable: false,
@@ -50,6 +57,11 @@ const defaultSchemasValidationStrategies = {
         schema: NumberSchemaDefinition<any>,
         validator: ISchemaValidator<any>
     ): Promise<ValidationResult> => validateNumber(obj, schema, validator),
+    boolean: (
+        obj: any,
+        schema: BooleanSchemaDefinition<any>,
+        validator: ISchemaValidator<any>
+    ): Promise<ValidationResult> => validateBoolean(obj, schema, validator),
     string: (
         obj: any,
         schema: StringSchemaDefinition<any>,
@@ -213,8 +225,8 @@ export default class SchemaValidator<T = Record<string, never>>
         };
     }
 
-    public async validate(
-        schema: keyof T | DefaultSchemaType | Schema<any>,
+    public async validate<K>(
+        schema: keyof T | DefaultSchemaType | Schema<K>,
         obj: any
     ): Promise<ValidationResult> {
         if (!schema) throw new Error('schemaName is required');
@@ -293,7 +305,7 @@ export default class SchemaValidator<T = Record<string, never>>
                         'it is only possible to use a full schema schema definition as alias'
                     );
 
-                const schemaToMerge = { ...schema };
+                const schemaToMerge = { ...(schema as any) };
                 delete schemaToMerge.type;
                 delete schemaToMerge.schemaName;
                 const finalSchema: Schema<any> = deepExtend(

package/src/validators/validateBoolean.ts

@@ -0,0 +1,45 @@
+import {
+    ValidationResult,
+    BooleanSchemaDefinition,
+    ISchemaValidator
+} from '../index';
+
+export const validateBoolean = async (
+    obj: any,
+    schema: BooleanSchemaDefinition<any>,
+    validator: ISchemaValidator<any>
+): Promise<ValidationResult> => {
+    if (
+        typeof obj === 'undefined' &&
+        typeof schema === 'object' &&
+        schema.isRequired === false
+    ) {
+        return {
+            valid: true
+        };
+    }
+    if (typeof obj !== 'boolean')
+        return {
+            valid: false,
+            errors: [`expected type boolean, but saw ${typeof obj}`]
+        };
+
+    if (typeof schema === 'boolean') {
+        return { valid: true };
+    }
+
+    const bool = obj as boolean;
+
+    if (typeof schema.equals === 'boolean') {
+        return schema.equals === bool
+            ? { valid: true }
+            : {
+                  valid: false,
+                  errors: [`must be equal to ${schema.equals}`]
+              };
+    }
+
+    return {
+        valid: true
+    };
+};

package/src/validators/validateObject.ts

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