Added coercing system to field configuration, revised some of the data validation errors
This commit is contained in:
@@ -6,11 +6,26 @@ function mandatory_anything(value) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
const fc = new Field_Configuration('Some_Field', mandatory_anything, 'Anything defined');
|
function string_coercion_function(value) {
|
||||||
|
if (value === undefined) {
|
||||||
|
throw new Error('Undefined not allowed');
|
||||||
|
}
|
||||||
|
return String(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
const fc = new Field_Configuration('Some_Field', null, string_coercion_function, 'Anything that could be a string');
|
||||||
|
|
||||||
console.log(fc.check_validation(undefined));
|
console.log(fc.check_validation(undefined));
|
||||||
console.log(fc.check_validation(true));
|
console.log(fc.check_validation(true));
|
||||||
|
|
||||||
|
console.log([ fc.coerce(123) ]);
|
||||||
|
console.log([ fc.coerce(true) ]);
|
||||||
|
|
||||||
|
console.log([ fc.load(undefined, 'Some configuration') ]);
|
||||||
|
console.log([ fc.load(true) ]);
|
||||||
|
|
||||||
|
|
||||||
//fc.validate(undefined);
|
//fc.validate(undefined);
|
||||||
fc.validate(undefined, 'New thingamabob object');
|
console.log(fc.load(undefined, 'New thingamabob object'));
|
||||||
|
|||||||
@@ -1,24 +1,43 @@
|
|||||||
import { Invalid_Data } from '@efforting.tech/errors';
|
import { Data_Validation_Failed, Data_Coercion_Failed } from '@efforting.tech/errors';
|
||||||
|
|
||||||
export class Field_Configuration {
|
export class Field_Configuration {
|
||||||
constructor(name, validator=null, expected=undefined) {
|
constructor(name, validation_function=null, coercion_function=null, expected_description=undefined) {
|
||||||
Object.assign(this, { name, validator, expected });
|
Object.assign(this, { name, validation_function, coercion_function, expected_description });
|
||||||
}
|
}
|
||||||
|
|
||||||
check_validation(value) {
|
check_validation(value) {
|
||||||
const { validator } = this;
|
const { validation_function } = this;
|
||||||
|
return !validation_function || validation_function(value);
|
||||||
return !validator || validator(value);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
validate(value, target=undefined) {
|
validate(value, target=undefined) {
|
||||||
const { validator, name, expected } = this;
|
const { validation_function, name, expected_description } = this;
|
||||||
if (!this.check_validation(value)) {
|
if (!this.check_validation(value)) {
|
||||||
throw new Invalid_Data({
|
throw new Data_Validation_Failed({
|
||||||
name, validator, value,
|
name, validation_function, value,
|
||||||
target, expected,
|
target, expected_description,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
coerce(value, target=undefined) {
|
||||||
|
const { coercion_function, name, expected_description } = this;
|
||||||
|
try {
|
||||||
|
return coercion_function ? coercion_function(value) : value;
|
||||||
|
} catch (e) {
|
||||||
|
throw new Data_Coercion_Failed({
|
||||||
|
name, coercion_function, value,
|
||||||
|
target, expected_description,
|
||||||
|
upstream_error: e,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
load(value, target=undefined) {
|
||||||
|
const coerced_value = this.coerce(value, target);
|
||||||
|
this.validate(coerced_value, target);
|
||||||
|
return coerced_value;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,17 +2,29 @@ import { inspect } from 'node:util';
|
|||||||
|
|
||||||
// § GROUP: Configuration field errors
|
// § GROUP: Configuration field errors
|
||||||
|
|
||||||
export class Invalid_Data extends Error {
|
export class Data_Validation_Failed extends Error {
|
||||||
constructor(data) {
|
constructor(data) {
|
||||||
const { value, target, expected, validator, name } = data;
|
const { value, target, expected_description, validation_function, name, upstream_error } = data;
|
||||||
const type = value === null ? 'null' : typeof value;
|
const type = value === null ? 'null' : typeof value;
|
||||||
const target_info = target ? inspect(target) : 'unknown target';
|
const target_info = target ? inspect(target) : 'unknown target';
|
||||||
const expected_desc = expected ?? `data that would pass validation using ${validator}`;
|
const expected_desc = expected_description ?? `data that would pass validation using ${validation_function}`;
|
||||||
super(`Data validation failed for field "${name}" of ${target_info}. Encountered data of type "${type}" while expecting "${expected_desc}".`);
|
const upstream_error_description = upstream_error ? ` Upstream error was: ${upstream_error}` : '';
|
||||||
|
super(`Data validation failed for field "${name}" of ${target_info}. Encountered data of type "${type}" while expecting "${expected_desc}".${upstream_error_description}`);
|
||||||
this.data = data;
|
this.data = data;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export class Data_Coercion_Failed extends Error {
|
||||||
|
constructor(data) {
|
||||||
|
const { value, target, expected_description, coercion_function, name, upstream_error } = data;
|
||||||
|
const type = value === null ? 'null' : typeof value;
|
||||||
|
const target_info = target ? inspect(target) : 'unknown target';
|
||||||
|
const expected_desc = expected_description ?? `data that would be coerced using ${coercion_function}`;
|
||||||
|
const upstream_error_description = upstream_error ? ` Upstream error was: ${upstream_error}` : '';
|
||||||
|
super(`Data coercion failed for field "${name}" of ${target_info}. Encountered data of type "${type}" while expecting "${expected_desc}".${upstream_error_description}`);
|
||||||
|
this.data = data;
|
||||||
|
}
|
||||||
|
}
|
||||||
// § GROUP: Resolving errors
|
// § GROUP: Resolving errors
|
||||||
|
|
||||||
export class Item_Unresolvable extends Error {
|
export class Item_Unresolvable extends Error {
|
||||||
|
|||||||
Reference in New Issue
Block a user