@cleverbrush/schema 0.0.7 → 0.0.8

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;
@@ -24,6 +24,10 @@ export declare type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'>
         [S in keyof T]: Schema<PropType<T, S>>;
     }>;
 };
+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> = {
     [S in keyof Parameters<TFunc>]: SingleSchema<Parameters<TFunc>[S]>;
@@ -53,7 +57,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> {

package/dist/schemaValidator.js

@@ -95,6 +95,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 +171,19 @@ 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))
+                    throw new Error('it is impossible to use alternative schema alias as "type" field');
+                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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cleverbrush/schema",
-    "version": "0.0.7",
+    "version": "0.0.8",
     "keywords": [
         "object schema validator",
         "schema",
@@ -19,7 +19,7 @@
         "build": "tsc"
     },
     "dependencies": {
-        "@cleverbrush/deep": "0.0.7"
+        "@cleverbrush/deep": "0.0.8"
     },
     "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];
 
@@ -40,6 +41,11 @@ export type ObjectSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
     }>;
 };
 
+export type AliasSchemaDefinition<T> = Omit<SchemaDefintion<T>, 'type'> & {
+    type: 'alias';
+    schemaName: string;
+};
+
 export type ObjectSchemaDefinitionParam<T> = Omit<
     ObjectSchemaDefinition<T>,
     'type'
@@ -100,7 +106,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

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,35 @@ 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);
+});

package/src/schemaValidator.ts

@@ -156,6 +156,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 +256,26 @@ 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))
+                    throw new Error(
+                        'it is impossible to use alternative schema alias as "type" field'
+                    );
+                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,