xref: /misc/config_tools/configurator/packages/vue-json-schema-form/utils/schema/validate.js

import Ajv from 'ajv';
import i18n from '../i18n';
import retrieveSchema from './retriev';

import {
    isObject, deepEquals
} from '../utils';
import { getUserErrOptions } from '../formUtils';

let ajv = createAjvInstance();

let formerCustomFormats = null;
let formerMetaSchema = null;

// 创建实例
function createAjvInstance() {
    const ajvInstance = new Ajv({
        errorDataPath: 'property',
        allErrors: true,
        multipleOfPrecision: 8,
        schemaId: 'auto',
        unknownFormats: 'ignore',
    });

    // 添加base-64 format
    ajvInstance.addFormat(
        'data-url',
        /^data:([a-z]+\/[a-z0-9-+.]+)?;(?:name=(.*);)?base64,(.*)$/
    );

    // 添加color format
    ajvInstance.addFormat(
        'color',
        // eslint-disable-next-line max-len
        /^(#?([0-9A-Fa-f]{3}){1,2}\b|aqua|black|blue|fuchsia|gray|green|lime|maroon|navy|olive|orange|purple|red|silver|teal|white|yellow|(rgb\(\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*,\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*,\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*\))|(rgb\(\s*(\d?\d%|100%)+\s*,\s*(\d?\d%|100%)+\s*,\s*(\d?\d%|100%)+\s*\)))$/
    );
    return ajvInstance;
}

/**
 * 将错误输出从ajv转换为jsonschema使用的格式
 * At some point, components should be updated to support ajv.
 */
function transformAjvErrors(errors = []) {
    if (errors === null) {
        return [];
    }

    return errors.map((e) => {
        const {
            dataPath, keyword, message, params, schemaPath
        } = e;
        const property = `${dataPath}`;

        // put data in expected format
        return {
            name: keyword,
            property,
            message,
            params, // specific to ajv
            stack: `${property} ${message}`.trim(),
            schemaPath,
        };
    });
}

/**
 * 通过 schema校验formData并返回错误信息
 * @param formData 校验的数据
 * @param schema
 * @param transformErrors function - 转换错误, 如个性化的配置
 * @param additionalMetaSchemas 数组 添加 ajv metaSchema
 * @param customFormats 添加 ajv 自定义 formats
 * @returns {{errors: ([]|{stack: string, schemaPath: *, name: *, property: string, message: *, params: *}[])}}
 */
export function ajvValidateFormData({
    formData,
    schema,
    transformErrors,
    additionalMetaSchemas = [],
    customFormats = {}
} = {}) {
    const hasNewMetaSchemas = !deepEquals(formerMetaSchema, additionalMetaSchemas);
    const hasNewFormats = !deepEquals(formerCustomFormats, customFormats);

    // 变更了 Meta或者调整了format配置重置新的实例
    if (hasNewMetaSchemas || hasNewFormats) {
        ajv = createAjvInstance();
    }

    // 添加更多要验证的模式
    if (
        additionalMetaSchemas
        && hasNewMetaSchemas
        && Array.isArray(additionalMetaSchemas)
    ) {
        ajv.addMetaSchema(additionalMetaSchemas);
        formerMetaSchema = additionalMetaSchemas;
    }

    // 注册自定义的 formats - 没有变更只会注册一次 - 否则重新创建实例
    if (customFormats && hasNewFormats && isObject(customFormats)) {
        Object.keys(customFormats).forEach((formatName) => {
            ajv.addFormat(formatName, customFormats[formatName]);
        });

        formerCustomFormats = customFormats;
    }

    let validationError = null;
    try {
        ajv.validate(schema, formData);
    } catch (err) {
        validationError = err;
    }

    // ajv 默认多语言处理
    i18n.getCurrentLocalize()(ajv.errors);

    let errors = transformAjvErrors(ajv.errors);

    // 清除错误
    ajv.errors = null;

    // 处理异常
    const noProperMetaSchema = validationError
        && validationError.message
        && typeof validationError.message === 'string'
        && validationError.message.includes('no schema with key or ref ');

    if (noProperMetaSchema) {
        errors = [
            ...errors,
            {
                stack: validationError.message,
            },
        ];
    }

    // 转换错误, 如传入自定义的错误
    if (typeof transformErrors === 'function') {
        errors = transformErrors(errors);
    }

    return {
        errors
    };
}

// 校验formData 并转换错误信息
export function validateFormDataAndTransformMsg({
    formData,
    schema,
    uiSchema,
    transformErrors,
    additionalMetaSchemas = [],
    customFormats = {},
    errorSchema = {},
    required = false,
    propPath = '',
    isOnlyFirstError = true, // 只取第一条错误信息
} = {}) {
    // 是否过滤根节点错误 固定只能根
    const filterRootNodeError = true;

    // 校验required信息 isEmpty 校验
    // 如果数组类型针对配置了 format 的特殊处理
    const emptyArray = (schema.type === 'array' && Array.isArray(formData) && formData.length === 0);
    const isEmpty = formData === undefined || emptyArray;

    if (required) {
        if (isEmpty) {
            const requireErrObj = {
                keyword: 'required',
                params: {
                    missingProperty: propPath
                }
            };

            // 用户设置校验信息
            const errSchemaMsg = getUserErrOptions({
                schema,
                uiSchema,
                errorSchema
            }).required;
            if (errSchemaMsg) {
                requireErrObj.message = errSchemaMsg;
            } else {
                // 处理多语言require提示信息 （ajv 修改原引用）
                i18n.getCurrentLocalize()([requireErrObj]);
            }
            return [requireErrObj];
        }
    } else if (isEmpty && !emptyArray) {
        // 非required 为空 校验通过
        return [];
    }

    // 校验ajv错误信息
    let ajvErrors = ajvValidateFormData({
        formData,
        schema,
        transformErrors,
        additionalMetaSchemas,
        customFormats,
    }).errors;

    // 过滤顶级错误
    if (filterRootNodeError) {
        ajvErrors = ajvErrors.filter(
            item => (item.property === ''
                && (!item.schemaPath.includes('#/anyOf/') && !item.schemaPath.includes('#/oneOf/')))
            || item.name === 'additionalProperties'
        );
    }

    const userErrOptions = getUserErrOptions({
        schema,
        uiSchema,
        errorSchema
    });

    return (isOnlyFirstError && ajvErrors.length > 0 ? [ajvErrors[0]] : ajvErrors).reduce((preErrors, errorItem) => {
        // 优先获取 errorSchema 配置
        errorItem.message = userErrOptions[errorItem.name] !== undefined ? userErrOptions[errorItem.name] : errorItem.message;
        preErrors.push(errorItem);
        return preErrors;
    }, []);
}

/**
 * 根据模式验证数据，如果数据有效则返回true，否则返回* false。如果模式无效，那么这个函数将返回* false。
 * @param schema
 * @param data
 * @returns {boolean|PromiseLike<any>}
 */
export function isValid(schema, data) {
    try {
        return ajv.validate(schema, data);
    } catch (e) {
        return false;
    }
}

// ajv valida
export function ajvValid(schema, data) {
    return ajv.validate(schema, data);
}

// 如果查找不到
// return -1
export function getMatchingIndex(formData, options, rootSchema, haveAllFields = false) {
    // eslint-disable-next-line no-plusplus
    for (let i = 0; i < options.length; i++) {
        const option = retrieveSchema(options[i], rootSchema, formData);

        // If the schema describes an object then we need to add slightly more
        // strict matching to the schema, because unless the schema uses the
        // "requires" keyword, an object will match the schema as long as it
        // doesn't have matching keys with a conflicting type. To do this we use an
        // "anyOf" with an array of requires. This augmentation expresses that the
        // schema should match if any of the keys in the schema are present on the
        // object and pass validation.
        if (option.properties) {
            // Create an "anyOf" schema that requires at least one of the keys in the
            // "properties" object
            const requiresAnyOf = {
                // 如果后代节点存在 $ref 需要正常引用
                ...(rootSchema.definitions ? {
                    definitions: rootSchema.definitions
                } : {}),
                anyOf: Object.keys(option.properties).map(key => ({
                    required: [key],
                })),
            };

            let augmentedSchema;

            // If the "anyOf" keyword already exists, wrap the augmentation in an "allOf"
            if (option.anyOf) {
                // Create a shallow clone of the option
                const { ...shallowClone } = option;

                if (!shallowClone.allOf) {
                    shallowClone.allOf = [];
                } else {
                    // If "allOf" already exists, shallow clone the array
                    shallowClone.allOf = shallowClone.allOf.slice();
                }

                shallowClone.allOf.push(requiresAnyOf);

                augmentedSchema = shallowClone;
            } else {
                augmentedSchema = Object.assign({}, option, requiresAnyOf);
            }

            // Remove the "required" field as it's likely that not all fields have
            // been filled in yet, which will mean that the schema is not valid

            // 如果编辑回填数据的场景 可直接使用 required 判断
            if (!haveAllFields) delete augmentedSchema.required;


            if (isValid(augmentedSchema, formData)) {
                return i;
            }
        } else if (isValid(options[i], formData)) {
            return i;
        }
    }

    // 尝试查找const 配置
    if (options[0] && options[0].properties) {
        const constProperty = Object.keys(options[0].properties).find(k => options[0].properties[k].const);
        if (constProperty) {
            // eslint-disable-next-line no-plusplus
            for (let i = 0; i < options.length; i++) {
                if (
                    options[i].properties
                    && options[i].properties[constProperty]
                    && options[i].properties[constProperty].const === formData[constProperty]) {
                    return i;
                }
            }
        }
    }
    return -1;
}

// oneOf anyOf 通过formData的值来找到当前匹配项索引
export function getMatchingOption(formData, options, rootSchema, haveAllFields = false) {
    const index = getMatchingIndex(formData, options, rootSchema, haveAllFields);
    return index === -1 ? 0 : index;
}