@cleverbrush/schema 0.0.17 → 1.0.0-beta.0

package/src/schemaRegistry.ts

@@ -0,0 +1,532 @@
+import { ISchemaRegistry as ISchemaRegistry, Unfold } from './index.js';
+import { validateNumber } from './validators/validateNumber.js';
+import { validateBoolean } from './validators/validateBoolean.js';
+import { validateString } from './validators/validateString.js';
+import { validateArray } from './validators/validateArray.js';
+import { validateObject } from './validators/validateObject.js';
+import { validateUnion } from './validators/validateUnion.js';
+import { validateFunction } from './validators/validateFunction.js';
+import {
+    ArraySchema,
+    BooleanSchema,
+    DefaultSchemaType,
+    NumberSchema,
+    ObjectSchema,
+    Schema,
+    ReduceSchemaBuilder,
+    SchemaSpecification,
+    StringSchema,
+    ValidationResult,
+    ValidationResultRaw,
+    InferType,
+    ExpandSchemaBuilder,
+    FunctionSchema
+} from './schema.js';
+
+import { number } from './builders/NumberSchemaBuilder.js';
+import { union } from './builders/UnionSchemaBuilder.js';
+import { object } from './builders/ObjectSchemaBuilder.js';
+import { string } from './builders/StringSchemaBuilder.js';
+import { boolean } from './builders/BooleanSchemaBuilder.js';
+import { array } from './builders/ArraySchemaBuilder.js';
+import {
+    alias,
+    externalAlias,
+    IAliasSchemaBuilder
+} from './builders/AliasSchemaBuilder.js';
+import { func } from './builders/FunctionSchemaBuilder.js';
+import { defaultSchemas } from './defaultSchemas.js';
+import { ISchemaBuilder, SchemaBuilder } from './builders/SchemaBuilder.js';
+
+const defaultSchemaNames = ['string', 'boolean', 'number', 'array', 'function'];
+
+const defaultSchemasValidationStrategies = {
+    number: (obj: any, schema: NumberSchema): Promise<ValidationResult> =>
+        validateNumber(obj, schema),
+    boolean: (obj: any, schema: BooleanSchema): Promise<ValidationResult> =>
+        validateBoolean(obj, schema),
+    string: (obj: any, schema: StringSchema): Promise<ValidationResult> =>
+        validateString(obj, schema),
+    array: (
+        obj: any,
+        schema: ArraySchema<any>,
+        validator: SchemaRegistry<any>
+    ): Promise<ValidationResult> => validateArray(obj, schema, validator),
+    function: (obj: any, schema: FunctionSchema): Promise<ValidationResult> =>
+        validateFunction(obj, schema)
+};
+
+const isDefaultType = (name: string): boolean =>
+    defaultSchemaNames.indexOf(name) !== -1;
+
+export default class SchemaRegistry<T extends Record<string, Schema> = {}>
+    implements ISchemaRegistry<T>
+{
+    private _schemasMap = new Map<string, Schema>();
+    private _schemasCache: Unfold<T> = null;
+    private _preprocessorsMap = new Map<
+        string,
+        (value: unknown) => unknown | Promise<unknown> | undefined
+    >();
+
+    public get preprocessors(): Map<string, (value: unknown) => unknown> {
+        return this._preprocessorsMap;
+    }
+
+    public addPreprocessor(
+        name: string,
+        preprocessor: (value: unknown) => unknown | Promise<unknown>
+    ): SchemaRegistry<T> {
+        if (this._preprocessorsMap.has(name))
+            throw new Error(`Preprocessor '${name}' is already registered`);
+        if (typeof preprocessor !== 'function') {
+            throw new Error('preprocessor must be a function');
+        }
+        this._preprocessorsMap.set(name, preprocessor);
+        return this;
+    }
+
+    public addSchemaFrom<
+        TOldName extends keyof T,
+        TName extends string,
+        TParam extends
+            | Record<string, any>
+            | ((params: {
+                  schema: ExpandSchemaBuilder<T[TOldName]>;
+                  boolean: typeof boolean;
+                  func: typeof func;
+                  array: typeof array;
+                  string: typeof string;
+                  number: typeof number;
+                  union: typeof union;
+                  object: typeof object;
+                  alias: <
+                      TSchemaName extends keyof T,
+                      TCompiledType = InferType<
+                          ExpandSchemaBuilder<T[TSchemaName]>
+                      >
+                  >(
+                      schemaName: TSchemaName
+                  ) => IAliasSchemaBuilder<
+                      TSchemaName,
+                      true,
+                      false,
+                      {
+                          [k in keyof T]: TSchemaName extends k ? T[k] : never;
+                      },
+                      TCompiledType
+                  >;
+              }) => TSchema),
+        TSchema extends Schema | ISchemaBuilder
+    >(
+        oldName: TOldName,
+        name: TName,
+        param: TParam
+    ): SchemaRegistry<
+        T & {
+            [key in TName]: TParam extends (...args: any[]) => any
+                ? ReduceSchemaBuilder<ReturnType<TParam>>
+                : TParam;
+        }
+    > {
+        if (!this._schemasMap.has(oldName.toString())) {
+            throw new Error(`unknown schema name ${oldName.toString()}`);
+        }
+
+        const oldSchema = this._schemasMap.get(oldName.toString());
+
+        const schema =
+            typeof param === 'function'
+                ? param({
+                      schema: oldSchema,
+                      alias,
+                      array,
+                      boolean,
+                      func,
+                      number,
+                      object,
+                      string,
+                      union
+                  })
+                : param;
+
+        if (Array.isArray(schema)) {
+            this._schemasMap.set(name.toString(), schema as Schema);
+            this._schemasCache = null;
+            return this as any;
+        }
+
+        if (typeof schema !== 'object')
+            throw new Error('Array or Object is required');
+        this._schemasMap.set(name.toString(), {
+            ...(schema instanceof SchemaBuilder
+                ? schema._schema
+                : (schema as any))
+        } as any as Schema);
+
+        this._schemasCache = null;
+        return this as any;
+    }
+
+    public addSchema<
+        TName extends string,
+        TParam extends
+            | Record<string, any>
+            | ((params: {
+                  boolean: typeof boolean;
+                  array: typeof array;
+                  string: typeof string;
+                  number: typeof number;
+                  union: typeof union;
+                  object: typeof object;
+                  func: typeof func;
+                  alias: <
+                      TSchemaName extends keyof T,
+                      TCompiledType = InferType<
+                          ExpandSchemaBuilder<T[TSchemaName]>
+                      >
+                  >(
+                      schemaName: TSchemaName
+                  ) => IAliasSchemaBuilder<
+                      TSchemaName,
+                      true,
+                      false,
+                      {
+                          [k in keyof T]: TSchemaName extends k ? T[k] : never;
+                      },
+                      TCompiledType
+                  >;
+                  external: <
+                      TRegistryKeys extends Record<string, any>,
+                      TSchemaName extends keyof TRegistryKeys,
+                      TCompiledType = InferType<
+                          ExpandSchemaBuilder<TRegistryKeys[TSchemaName]>
+                      >
+                  >(
+                      registry: ISchemaRegistry<TRegistryKeys>,
+                      schemaName: TSchemaName
+                  ) => IAliasSchemaBuilder<
+                      TSchemaName,
+                      true,
+                      false,
+                      {
+                          [k in keyof TRegistryKeys]: TSchemaName extends k
+                              ? TRegistryKeys[k]
+                              : never;
+                      },
+                      TCompiledType
+                  >;
+              }) => TSchema),
+        TSchema extends Schema | ISchemaBuilder
+    >(
+        name: TName,
+        param: TParam
+    ): SchemaRegistry<
+        T & {
+            [key in TName]: TParam extends (...args: any[]) => any
+                ? ReduceSchemaBuilder<ReturnType<TParam>>
+                : TParam;
+        }
+    > {
+        if (typeof name !== 'string' || !name)
+            throw new Error('Name is required');
+
+        if (isDefaultType(name.toString()))
+            throw new Error(
+                `You can't add a schema named "${name}" because it's a name of a default schema, please consider another name to be used`
+            );
+        if (this._schemasMap.has(name.toString())) {
+            throw new Error(`Schema "${name}" already exists`);
+        }
+
+        const schema =
+            typeof param === 'function'
+                ? param({
+                      alias,
+                      external: externalAlias,
+                      array,
+                      boolean,
+                      number,
+                      object,
+                      string,
+                      union,
+                      func
+                  })
+                : param;
+
+        if (Array.isArray(schema)) {
+            this._schemasMap.set(name.toString(), schema as Schema);
+            this._schemasCache = null;
+            return this as any;
+        }
+
+        if (typeof schema !== 'object')
+            throw new Error('Array or Object is required');
+        this._schemasMap.set(
+            name.toString(),
+            schema instanceof SchemaBuilder ? schema.clone() : schema
+        );
+
+        this._schemasCache = null;
+        return this as any;
+    }
+
+    public get schemas(): Unfold<T> {
+        if (this._schemasCache) return this._schemasCache;
+        const res = {};
+        for (const key of this._schemasMap.keys()) {
+            const parts = key.split('.');
+            let curr = res;
+            for (let i = 0; i < parts.length; i++) {
+                if (i === parts.length - 1) {
+                    curr[parts[i]] = {
+                        validate: async (value: any): Promise<any> => {
+                            const result = await this.validate(
+                                this._schemasMap.get(key),
+                                value
+                            );
+                            if (!result.valid) {
+                                return result;
+                            }
+                            return {
+                                ...result,
+                                object: value
+                            };
+                        },
+                        schema: this._schemasMap.get(key)
+                    };
+                } else {
+                    if (typeof curr[parts[i]] === 'undefined') {
+                        curr[parts[i]] = {};
+                    }
+                }
+                curr = curr[parts[i]];
+            }
+        }
+        this._schemasCache = res as Unfold<T>;
+        return this._schemasCache;
+    }
+
+    private async validateDefaultType(
+        name: DefaultSchemaType,
+        value: any,
+        mergeSchema?: Schema
+    ): Promise<ValidationResult> {
+        const strategy = defaultSchemasValidationStrategies[name] as (
+            obj: any,
+            schema: Schema,
+            validator: SchemaRegistry<any>
+        ) => ValidationResult;
+        let finalSchema = defaultSchemas[name] as SchemaSpecification;
+        if (strategy) {
+            if (typeof mergeSchema === 'object' && mergeSchema) {
+                finalSchema = Object.assign({}, finalSchema, mergeSchema);
+            }
+            if (typeof mergeSchema === 'number') {
+                finalSchema = {
+                    ...finalSchema,
+                    equals: mergeSchema
+                } as NumberSchema;
+                mergeSchema;
+            }
+
+            let preliminaryResult = await strategy(
+                value,
+                finalSchema,
+                this as any
+            );
+            if (!preliminaryResult.valid) return preliminaryResult;
+
+            preliminaryResult = await this.checkValidators(finalSchema, value);
+
+            return preliminaryResult;
+        }
+        throw new Error('not implemented');
+    }
+
+    private async checkValidators(
+        schema: SchemaSpecification,
+        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)))
+            );
+            const rejections = validatorsResults
+                .filter((f) => f.status === 'rejected')
+                .map((f: PromiseRejectedResult) => f.reason);
+            const errors = validatorsResults
+                .filter(
+                    (f) =>
+                        f.status === 'fulfilled' &&
+                        typeof f.value !== 'boolean' &&
+                        f.value.valid === false
+                )
+                .map(
+                    (f: PromiseFulfilledResult<ValidationResultRaw>) => f.value
+                )
+                .map((f: ValidationResultRaw) => f.errors);
+
+            if (rejections.length === 0 && errors.length === 0) {
+                return {
+                    valid: true
+                };
+            }
+            return {
+                valid: false,
+                errors: [...rejections, ...errors]
+            };
+        }
+        return {
+            valid: true
+        };
+    }
+
+    public async validate(
+        schemaToValidate: keyof T | Schema,
+        obj: any
+    ): Promise<ValidationResult> {
+        if (!schemaToValidate) throw new Error('schemaName is required');
+        const schema =
+            schemaToValidate instanceof SchemaBuilder
+                ? schemaToValidate._schema
+                : schemaToValidate;
+        if (typeof schema === 'string') {
+            if (isDefaultType(schema)) {
+                return await this.validateDefaultType(
+                    schema as DefaultSchemaType,
+                    obj
+                );
+            } else if (typeof this._schemasMap.get(schema) !== 'undefined') {
+                if (Array.isArray(this._schemasMap.get(schema))) {
+                    return this.validate(this._schemasMap.get(schema), obj);
+                }
+                const objSchema = Object.assign(
+                    {},
+                    defaultSchemas.object,
+                    this._schemasMap.get(schema)
+                ) as ObjectSchema;
+                const res = await validateObject(
+                    obj,
+                    objSchema as any,
+                    this as any
+                );
+                if (!res.valid) return res;
+                return await this.checkValidators(objSchema, obj);
+            } else {
+                return await this.validateDefaultType('string', obj, {
+                    type: 'string',
+                    equals: schema
+                });
+            }
+        }
+
+        if (Array.isArray(schema)) {
+            for (let i = 0; i < schema.length; i++) {
+                const res = await this.validate(schema[i], obj);
+                if (res.valid) {
+                    return res;
+                }
+            }
+            return {
+                valid: false,
+                errors: ['object does not match any schema']
+            };
+        }
+
+        if (typeof schema === 'number') {
+            return await this.validateDefaultType('number', obj, schema);
+        }
+
+        if (typeof schema === 'object') {
+            const spec = schema as SchemaSpecification;
+            if (typeof spec.type !== 'string')
+                throw new Error('Schema has no type');
+
+            if (isDefaultType(spec.type)) {
+                return await this.validateDefaultType(
+                    spec.type as DefaultSchemaType,
+                    obj,
+                    schema
+                );
+            } else if (spec.type === 'alias') {
+                if (spec.isRequired === false && typeof obj === 'undefined') {
+                    return {
+                        valid: true
+                    };
+                }
+                if (spec.isNullable === true && obj === null) {
+                    return {
+                        valid: true
+                    };
+                }
+
+                const registry = (spec.externalRegistry ||
+                    this) as ISchemaRegistry<any>;
+                const alias = (registry as any)._schemasMap.get(
+                    spec.schemaName
+                );
+                if (typeof alias === 'undefined') {
+                    throw new Error(
+                        `Unknown schema alias - ${spec.schemaName}`
+                    );
+                }
+                if (Array.isArray(alias)) {
+                    if (
+                        (!spec.isRequired && typeof obj === 'undefined') ||
+                        (spec.isNullable && obj === null)
+                    ) {
+                        return {
+                            valid: true
+                        };
+                    }
+                    return await (registry as any).validate(alias as any, obj);
+                }
+                if (typeof alias !== 'object')
+                    throw new Error(
+                        'it is only possible to use a full schema schema definition as alias'
+                    );
+
+                let schemaToValidate = alias;
+
+                if (alias instanceof SchemaBuilder) {
+                    if (typeof schema.isRequired === 'boolean') {
+                        schemaToValidate = (schemaToValidate as any)[
+                            schema.isRequired ? 'required' : 'optional'
+                        ]();
+                    }
+                    if (typeof schema.isNullable === 'boolean') {
+                        schemaToValidate = (schemaToValidate as any)[
+                            schema.isNullable ? 'nullable' : 'notNullable'
+                        ]();
+                    }
+                }
+
+                return await (registry as any).validate(schemaToValidate, obj);
+            } else if (spec.type === 'union') {
+                return await validateUnion(obj, spec, this as any);
+            } else if (spec.type === 'object') {
+                const preliminaryResult = await validateObject(
+                    obj,
+                    schema as ObjectSchema<any>,
+                    this as any
+                );
+                if (!preliminaryResult.valid) return preliminaryResult;
+
+                return await this.checkValidators(
+                    schema as SchemaSpecification,
+                    obj
+                );
+            } else if (spec.type === 'function') {
+                return await validateFunction(obj, spec);
+            }
+        }
+
+        throw new Error("Couldn't understand the Schema provided");
+    }
+}

package/src/validators/validateArray.ts

@@ -1,13 +1,10 @@
-import {
-    ValidationResult,
-    ArraySchemaDefinition,
-    ISchemaValidator
-} from '../index';
+import { ArraySchema, ValidationResult } from '../schema.js';
+import SchemaRegistry from '../schemaRegistry.js';
 
 export const validateArray = async (
     obj: any,
-    schema: ArraySchemaDefinition<any>,
-    validator: ISchemaValidator<any>
+    schema: ArraySchema<any>,
+    validator: SchemaRegistry<any>
 ): Promise<ValidationResult> => {
     if (
         typeof obj === 'undefined' &&

package/src/validators/validateBoolean.ts

@@ -1,13 +1,8 @@
-import {
-    ValidationResult,
-    BooleanSchemaDefinition,
-    ISchemaValidator
-} from '../index';
+import { BooleanSchema, ValidationResult } from '../schema.js';
 
 export const validateBoolean = async (
     obj: any,
-    schema: BooleanSchemaDefinition<any>,
-    validator: ISchemaValidator<any>
+    schema: BooleanSchema
 ): Promise<ValidationResult> => {
     if (
         typeof obj === 'undefined' &&
@@ -24,10 +19,6 @@ export const validateBoolean = async (
             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') {

package/src/validators/validateFunction.ts

@@ -0,0 +1,25 @@
+import { FunctionSchema, ValidationResult } from '../schema.js';
+
+export const validateFunction = async (
+    obj: any,
+    schema: FunctionSchema
+): Promise<ValidationResult> => {
+    if (
+        typeof obj === 'undefined' &&
+        typeof schema === 'object' &&
+        schema.isRequired === false
+    ) {
+        return {
+            valid: true
+        };
+    }
+    if (typeof obj !== 'function')
+        return {
+            valid: false,
+            errors: [`expected type function, but saw ${typeof obj}`]
+        };
+
+    return {
+        valid: true
+    };
+};

package/src/validators/validateNumber.ts

@@ -1,13 +1,8 @@
-import {
-    ValidationResult,
-    NumberSchemaDefinition,
-    ISchemaValidator
-} from '../index';
+import { NumberSchema, ValidationResult } from '../schema.js';
 
 export const validateNumber = async (
     obj: any,
-    schema: NumberSchemaDefinition<any>,
-    validator: ISchemaValidator<any>
+    schema: NumberSchema
 ): Promise<ValidationResult> => {
     if (
         typeof obj === 'undefined' &&