123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258 |
- import { format, complementError, asyncMap, warning, deepMerge } from './util.js';
- import validators from './validator/index.js';
- import { messages as defaultMessages, newMessages } from './messages.js';
- /**
- * Encapsulates a validation schema.
- *
- * @param descriptor An object declaring validation rules
- * for this schema.
- */
- function Schema(descriptor) {
- this.rules = null;
- this._messages = defaultMessages;
- this.define(descriptor);
- }
- Schema.prototype = {
- messages(messages) {
- if (messages) {
- this._messages = deepMerge(newMessages(), messages);
- }
- return this._messages;
- },
- define(rules) {
- if (!rules) {
- throw new Error(
- 'Cannot configure a schema with no rules');
- }
- if (typeof rules !== 'object' || Array.isArray(rules)) {
- throw new Error('Rules must be an object');
- }
- this.rules = {};
- let z;
- let item;
- for (z in rules) {
- if (rules.hasOwnProperty(z)) {
- item = rules[z];
- this.rules[z] = Array.isArray(item) ? item : [item];
- }
- }
- },
- validate(source_, o = {}, oc) {
- let source = source_;
- let options = o;
- let callback = oc;
- if (typeof options === 'function') {
- callback = options;
- options = {};
- }
- if (!this.rules || Object.keys(this.rules).length === 0) {
- if (callback) {
- callback();
- }
- return;
- }
- function complete(results) {
- let i;
- let field;
- let errors = [];
- let fields = {};
- function add(e) {
- if (Array.isArray(e)) {
- errors = errors.concat.apply(errors, e);
- } else {
- errors.push(e);
- }
- }
- for (i = 0; i < results.length; i++) {
- add(results[i]);
- }
- if (!errors.length) {
- errors = null;
- fields = null;
- } else {
- for (i = 0; i < errors.length; i++) {
- field = errors[i].field;
- fields[field] = fields[field] || [];
- fields[field].push(errors[i]);
- }
- }
- callback(errors, fields);
- }
- if (options.messages) {
- let messages = this.messages();
- if (messages === defaultMessages) {
- messages = newMessages();
- }
- deepMerge(messages, options.messages);
- options.messages = messages;
- } else {
- options.messages = this.messages();
- }
- let arr;
- let value;
- const series = {};
- const keys = options.keys || Object.keys(this.rules);
- keys.forEach((z) => {
- arr = this.rules[z];
- value = source[z];
- arr.forEach((r) => {
- let rule = r;
- if (typeof (rule.transform) === 'function') {
- if (source === source_) {
- source = { ...source };
- }
- value = source[z] = rule.transform(value);
- }
- if (typeof (rule) === 'function') {
- rule = {
- validator: rule,
- };
- } else {
- rule = { ...rule };
- }
- rule.validator = this.getValidationMethod(rule);
- rule.field = z;
- rule.fullField = rule.fullField || z;
- rule.type = this.getType(rule);
- if (!rule.validator) {
- return;
- }
- series[z] = series[z] || [];
- series[z].push({
- rule,
- value,
- source,
- field: z,
- });
- });
- });
- const errorFields = {};
- asyncMap(series, options, (data, doIt) => {
- const rule = data.rule;
- let deep = (rule.type === 'object' || rule.type === 'array') &&
- (typeof (rule.fields) === 'object' || typeof (rule.defaultField) === 'object');
- deep = deep && (rule.required || (!rule.required && data.value));
- rule.field = data.field;
- function addFullfield(key, schema) {
- return {
- ...schema,
- fullField: `${rule.fullField}.${key}`,
- };
- }
- function cb(e = []) {
- let errors = e;
- if (!Array.isArray(errors)) {
- errors = [errors];
- }
- if (errors.length) {
- warning('async-validator:', errors);
- }
- if (errors.length && rule.message) {
- errors = [].concat(rule.message);
- }
- errors = errors.map(complementError(rule));
- if (options.first && errors.length) {
- errorFields[rule.field] = 1;
- return doIt(errors);
- }
- if (!deep) {
- doIt(errors);
- } else {
- // if rule is required but the target object
- // does not exist fail at the rule level and don't
- // go deeper
- if (rule.required && !data.value) {
- if (rule.message) {
- errors = [].concat(rule.message).map(complementError(rule));
- } else if (options.error) {
- errors = [options.error(rule, format(options.messages.required, rule.field))];
- } else {
- errors = [];
- }
- return doIt(errors);
- }
- let fieldsSchema = {};
- if (rule.defaultField) {
- for (const k in data.value) {
- if (data.value.hasOwnProperty(k)) {
- fieldsSchema[k] = rule.defaultField;
- }
- }
- }
- fieldsSchema = {
- ...fieldsSchema,
- ...data.rule.fields,
- };
- for (const f in fieldsSchema) {
- if (fieldsSchema.hasOwnProperty(f)) {
- const fieldSchema = Array.isArray(fieldsSchema[f]) ?
- fieldsSchema[f] : [fieldsSchema[f]];
- fieldsSchema[f] = fieldSchema.map(addFullfield.bind(null, f));
- }
- }
- const schema = new Schema(fieldsSchema);
- schema.messages(options.messages);
- if (data.rule.options) {
- data.rule.options.messages = options.messages;
- data.rule.options.error = options.error;
- }
- schema.validate(data.value, data.rule.options || options, (errs) => {
- doIt(errs && errs.length ? errors.concat(errs) : errs);
- });
- }
- }
- const res = rule.validator(
- rule, data.value, cb, data.source, options);
- if (res && res.then) {
- res.then(() => cb(), e => cb(e));
- }
- }, (results) => {
- complete(results);
- });
- },
- getType(rule) {
- if (rule.type === undefined && (rule.pattern instanceof RegExp)) {
- rule.type = 'pattern';
- }
- if (typeof (rule.validator) !== 'function' &&
- (rule.type && !validators.hasOwnProperty(rule.type))) {
- throw new Error(format('Unknown rule type %s', rule.type));
- }
- return rule.type || 'string';
- },
- getValidationMethod(rule) {
- if (typeof rule.validator === 'function') {
- return rule.validator;
- }
- const keys = Object.keys(rule);
- const messageIndex = keys.indexOf('message');
- if (messageIndex !== -1) {
- keys.splice(messageIndex, 1);
- }
- if (keys.length === 1 && keys[0] === 'required') {
- return validators.required;
- }
- return validators[this.getType(rule)] || false;
- },
- };
- Schema.register = function register(type, validator) {
- if (typeof validator !== 'function') {
- throw new Error('Cannot register a validator by type, validator is not a function');
- }
- validators[type] = validator;
- };
- Schema.messages = defaultMessages;
- export default Schema;
|