@cleverbrush/schema 0.0.6 → 0.0.9

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
@@ -128,6 +133,10 @@ class SchemaValidator {
                 return await this.validateDefaultType(schema, obj);
             }
             else if (typeof this.schemas[schema] !== 'undefined') {
+                if (Array.isArray(this.schemas[schema].schema)) {
+                    return this.validate(this.schemas[schema]
+                        .schema, obj);
+                }
                 const objSchema = (0, deep_1.deepExtend)(defaultSchemas.object, this.schemas[schema].schema);
                 const res = await (0, validateObject_1.validateObject)(obj, objSchema, this);
                 if (!res.valid)
@@ -162,6 +171,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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cleverbrush/schema",
-    "version": "0.0.6",
+    "version": "0.0.9",
     "keywords": [
         "object schema validator",
         "schema",
@@ -19,7 +19,7 @@
         "build": "tsc"
     },
     "dependencies": {
-        "@cleverbrush/deep": "0.0.6"
+        "@cleverbrush/deep": "0.0.9"
     },
     "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

@@ -912,3 +912,293 @@ test('Validate - one of - 1', async () => {
     );
     expect(result).toHaveProperty('valid', true);
 });
+
+test('Validate schema - 1', async () => {
+    const authorsReportSpecificationSchema = {
+        properties: {
+            type: {
+                type: 'string',
+                equals: 'author'
+            },
+            start: 'Date',
+            end: 'Date',
+            selectionStart: 'Date',
+            selectionEnd: 'Date',
+            granularity: ['day', 'week', 'month'],
+            metrics: {
+                type: 'array',
+                ofType: [
+                    'articlesPublished',
+                    'searchReferrers',
+                    'socialReferrers',
+                    'views',
+                    'visitors',
+                    'newVisitors'
+                ]
+            },
+            filters: {
+                type: 'object',
+                properties: {
+                    author: 'AuthorFilter'
+                    // publication: 'PublicationFilter',
+                    // article: 'ArticleFilter'
+                }
+            }
+        },
+        validators: [
+            (value) =>
+                value.start <= value.end &&
+                value.selectionStart <= value.selectionEnd &&
+                value.selectionStart >= value.start &&
+                value.selectionStart <= value.end &&
+                value.selectionEnd >= value.start &&
+                value.selectionEnd <= value.end
+                    ? {
+                          valid: true
+                      }
+                    : {
+                          valid: false,
+                          errors: [
+                              'selectionStart <=> selectionEnd should be inside the start <=> end interval'
+                          ]
+                      }
+        ]
+    };
+
+    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']
+                          }
+            ]
+        })
+        .addSchemaType('EqualsFilterCondition', {
+            properties: {
+                operation: {
+                    type: 'string',
+                    equals: 'equals'
+                },
+                value: ['object', 'string', 'number']
+            }
+        })
+        .addSchemaType('GreaterThanFilterCondition', {
+            properties: {
+                operation: {
+                    type: 'string',
+                    equals: 'greater_than'
+                },
+                value: 'number'
+            }
+        })
+        .addSchemaType('LessThanFilterCondition', {
+            properties: {
+                operation: {
+                    type: 'string',
+                    equals: 'less_than'
+                },
+                value: 'number'
+            }
+        })
+        .addSchemaType('ContainsFilterCondition', {
+            properties: {
+                operation: {
+                    type: 'string',
+                    equals: 'contains'
+                },
+                value: [
+                    'string',
+                    'number',
+                    {
+                        type: 'array',
+                        ofType: ['string', 'number']
+                    }
+                ]
+            }
+        })
+        .addSchemaType('LikeFilterCondition', {
+            properties: {
+                operation: 'like',
+                value: 'string'
+            }
+        })
+        .addSchemaType('BetweenFilterCondition', {
+            properties: {
+                operation: 'between',
+                from: 'number',
+                to: 'number'
+            },
+            validators: [
+                (value) =>
+                    value.from <= value.to
+                        ? { valid: true }
+                        : { valid: false, error: ['from must be <= to'] }
+            ]
+        })
+        .addSchemaType('StringFilterCondition', [
+            'EqualsFilterCondition',
+            'LikeFilterCondition'
+        ])
+        .addSchemaType('AuthorFilter', {
+            properties: {
+                fullName: 'StringFilterCondition'
+            }
+        })
+        .addSchemaType(
+            'AuthorsReportSpecification',
+            authorsReportSpecificationSchema as ObjectSchemaDefinitionParam<any>
+        );
+
+    /**
+     * @type {import('smg-iq/editorial-analytics.reports').AuthorsReportSpecification}
+     */
+    let reportSpec = {
+        type: 'author',
+        start: new Date(2021, 0, 1),
+        end: new Date(),
+        selectionStart: new Date(2022, 0, 1),
+        selectionEnd: new Date(2022, 2, 1),
+        granularity: 'day',
+        metrics: [
+            'articlesPublished',
+            'searchReferrers',
+            'socialReferrers',
+            'views',
+            'visitors',
+            'newVisitors'
+        ],
+        filters: {
+            author: {
+                fullName: {
+                    operation: 'between',
+                    value: 'some name'
+                }
+            }
+        }
+    };
+
+    let result = await validator.schemas.AuthorsReportSpecification.validate(
+        reportSpec
+    );
+
+    expect(result).toHaveProperty('valid', false);
+
+    reportSpec = {
+        type: 'author',
+        start: new Date(2021, 0, 1),
+        end: new Date(),
+        selectionStart: new Date(2022, 0, 1),
+        selectionEnd: new Date(2022, 2, 1),
+        granularity: 'day',
+        metrics: [
+            'articlesPublished',
+            'searchReferrers',
+            'socialReferrers',
+            'views',
+            'visitors',
+            'newVisitors'
+        ],
+        filters: {
+            author: {
+                fullName: {
+                    operation: 'equals',
+                    value: 'some name'
+                }
+            }
+        }
+    };
+
+    result = await validator.schemas.AuthorsReportSpecification.validate(
+        reportSpec
+    );
+
+    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);
+});

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)))
@@ -202,6 +207,13 @@ export default class SchemaValidator<T = Record<string, never>>
                     obj
                 );
             } else if (typeof this.schemas[schema as keyof T] !== 'undefined') {
+                if (Array.isArray(this.schemas[schema as keyof T].schema)) {
+                    return this.validate(
+                        this.schemas[schema as keyof T]
+                            .schema as any as Schema<any>,
+                        obj
+                    );
+                }
                 const objSchema = deepExtend(
                     defaultSchemas.object,
                     this.schemas[schema as keyof T].schema
@@ -244,6 +256,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,