form-render-v3 3.0.0-alpha.1

package/es/models/transformProps.js

@@ -0,0 +1,80 @@
+import { __rest } from "tslib";
+var displayTypeEnum = {
+  column: 'vertical',
+  row: 'horizontal',
+  inline: 'inline'
+};
+var transformProps = function transformProps(props) {
+  var schema = props.schema,
+    beforeFinish = props.beforeFinish,
+    onMount = props.onMount,
+    _props$displayType = props.displayType,
+    displayType = _props$displayType === void 0 ? 'column' : _props$displayType,
+    watch = props.watch,
+    _props$removeHiddenDa = props.removeHiddenData,
+    removeHiddenData = _props$removeHiddenDa === void 0 ? true : _props$removeHiddenDa,
+    readOnly = props.readOnly,
+    _props$column = props.column,
+    column = _props$column === void 0 ? 1 : _props$column,
+    mapping = props.mapping,
+    debugCss = props.debugCss,
+    locale = props.locale,
+    configProvider = props.configProvider,
+    validateMessages = props.validateMessages,
+    debug = props.debug,
+    id = props.id,
+    labelWidth = props.labelWidth,
+    maxWidth = props.maxWidth,
+    form = props.form,
+    onFinish = props.onFinish,
+    onFinishFailed = props.onFinishFailed,
+    footer = props.footer,
+    operateExtra = props.operateExtra,
+    logOnMount = props.logOnMount,
+    logOnSubmit = props.logOnSubmit,
+    labelCol = props.labelCol,
+    fieldCol = props.fieldCol,
+    disabled = props.disabled,
+    className = props.className,
+    validateTrigger = props.validateTrigger,
+    antdVersion = props.antdVersion,
+    otherProps = __rest(props, ["schema", "beforeFinish", "onMount", "displayType", "watch", "removeHiddenData", "readOnly", "column", "mapping", "debugCss", "locale", "configProvider", "validateMessages", "debug", "id", "labelWidth", "maxWidth", "form", "onFinish", "onFinishFailed", "footer", "operateExtra", "logOnMount", "logOnSubmit", "labelCol", "fieldCol", "disabled", "className", "validateTrigger", "antdVersion"]);
+  var formProps = Object.assign({}, otherProps);
+  if (displayType) {
+    formProps.layout = displayTypeEnum[displayType] || 'horizontal';
+  }
+  return {
+    formProps: formProps,
+    schema: schema,
+    displayType: displayType,
+    onFinish: onFinish,
+    beforeFinish: beforeFinish,
+    onMount: onMount,
+    watch: watch,
+    readOnly: readOnly,
+    disabled: disabled,
+    column: column,
+    mapping: mapping,
+    debugCss: debugCss,
+    locale: locale,
+    configProvider: configProvider,
+    footer: footer,
+    form: form,
+    labelWidth: labelWidth,
+    validateMessages: validateMessages,
+    debug: debug,
+    id: id,
+    onFinishFailed: onFinishFailed,
+    removeHiddenData: removeHiddenData,
+    operateExtra: operateExtra,
+    logOnMount: logOnMount,
+    logOnSubmit: logOnSubmit,
+    labelCol: labelCol,
+    fieldCol: fieldCol,
+    maxWidth: maxWidth,
+    className: className,
+    validateTrigger: validateTrigger,
+    antdVersion: antdVersion
+  };
+};
+export default transformProps;

package/es/models/useForm.d.ts

@@ -0,0 +1,3 @@
+import type { FormInstance } from '../type';
+declare const useForm: () => FormInstance;
+export default useForm;

package/es/models/useForm.js

@@ -0,0 +1,322 @@
+import "antd/es/form/style";
+import _Form from "antd/es/form";
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+import { __rest } from "tslib";
+import { useRef } from 'react';
+import { cloneDeep } from 'lodash-es';
+import { transformFieldsData, getSchemaFullPath } from './formCoreUtils';
+import { parseBindToValues, parseValuesToBind } from './bindValues';
+import { _isMatch, _set, _get, isFunction, isObject, isArray, hasFuncProperty } from '../utils';
+import filterValuesUndefined from './filterValuesUndefined';
+import filterValuesHidden from './filterValuesHidden';
+import { flattenSchema as flatten } from './flattenSchema';
+var updateSchemaByPath = function updateSchemaByPath(_path, _newSchema, formSchema) {
+  var path = getSchemaFullPath(_path, formSchema);
+  var currSchema = _get(formSchema, path, {});
+  var newSchema = isFunction(_newSchema) ? _newSchema(currSchema) : _newSchema;
+  var result = Object.assign(Object.assign({}, currSchema), newSchema);
+  if (newSchema.props) {
+    result.props = Object.assign(Object.assign({}, currSchema === null || currSchema === void 0 ? void 0 : currSchema.props), newSchema.props);
+  }
+  _set(formSchema, path, result);
+};
+var getFieldName = function getFieldName(_path) {
+  if (!_path) {
+    return undefined;
+  }
+  if (typeof _path === 'boolean') {
+    return _path;
+  }
+  var result = [];
+  if (isArray(_path)) {
+    result = _path.map(function (item) {
+      return item.split('.').map(function (ite) {
+        if (!isNaN(Number(ite))) {
+          return ite * 1;
+        }
+        return ite;
+      });
+    });
+  }
+  result = _path.split('.').map(function (item) {
+    if (!isNaN(Number(item))) {
+      return item * 1;
+    }
+    return item;
+  });
+  result = result.map(function (item) {
+    if (typeof item === 'string' && (item === null || item === void 0 ? void 0 : item.indexOf('[')) === 0 && (item === null || item === void 0 ? void 0 : item.indexOf(']')) === (item === null || item === void 0 ? void 0 : item.length) - 1) {
+      return Number(item.substring(1, item.length - 1));
+    }
+    return item;
+  });
+  return result;
+};
+var useForm = function useForm() {
+  var _Form$useForm = _Form.useForm(),
+    _Form$useForm2 = _slicedToArray(_Form$useForm, 1),
+    form = _Form$useForm2[0];
+  var flattenSchemaRef = useRef({});
+  var storeRef = useRef(null);
+  var schemaRef = useRef({});
+  var fieldRefs = useRef({});
+  var getFieldError = form.getFieldError,
+    getFieldsError = form.getFieldsError,
+    getFieldInstance = form.getFieldInstance,
+    setFieldsValue = form.setFieldsValue,
+    setFields = form.setFields,
+    scrollToField = form.scrollToField,
+    isFieldsTouched = form.isFieldsTouched,
+    isFieldTouched = form.isFieldTouched,
+    isFieldValidating = form.isFieldValidating,
+    resetFields = form.resetFields,
+    validateFields = form.validateFields,
+    otherForm = __rest(form, ["getFieldError", "getFieldsError", "getFieldInstance", "setFieldsValue", "setFields", "scrollToField", "isFieldsTouched", "isFieldTouched", "isFieldValidating", "resetFields", "validateFields"]);
+  var xform = otherForm;
+  var setStoreData = function setStoreData(data) {
+    var setState = storeRef.current.setState;
+    if (!setState) {
+      setTimeout(function () {
+        setState({
+          schema: schemaRef.current,
+          flattenSchema: flattenSchemaRef.current
+        });
+      }, 0);
+    }
+    setState(data);
+  };
+  // 更新协议
+  var handleSchemaUpdate = function handleSchemaUpdate(newSchema) {
+    // form.__schema = Object.freeze(newSchema);
+    flattenSchemaRef.current = flatten(newSchema) || {};
+    schemaRef.current = newSchema;
+    setStoreData({
+      schema: newSchema,
+      flattenSchema: flattenSchemaRef.current
+    });
+  };
+  // 设置协议
+  xform.setSchema = function (obj) {
+    var cover = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    if (!isObject(obj)) {
+      return;
+    }
+    if (cover) {
+      handleSchemaUpdate(obj);
+      return;
+    }
+    var schema = cloneDeep(schemaRef.current);
+    Object.keys(obj || {}).forEach(function (path) {
+      updateSchemaByPath(path, obj[path], schema);
+    });
+    handleSchemaUpdate(schema);
+  };
+  // 设置某个字段的协议
+  xform.setSchemaByPath = function (_path, _newSchema) {
+    // diff 判断是否需要更新，存在函数跳过
+    if (!hasFuncProperty(_newSchema) && _isMatch(_newSchema, xform.getSchemaByPath(_path))) {
+      return;
+    }
+    var schema = cloneDeep(schemaRef.current);
+    updateSchemaByPath(_path, _newSchema, schema);
+    handleSchemaUpdate(schema);
+  };
+  // form.setSchemaByFullPath = (path: string, newSchema: any) => {
+  //   const schema = _cloneDeep(schemaRef.current);
+  //   const currSchema = _get(schema, path, {});
+  //   const result = _mergeWith(currSchema, newSchema, (objValue, srcValue, key) => {
+  //     return srcValue;
+  //   });
+  //   _set(schema, path, result);
+  //   handleSchemaUpdate(schema);
+  // }
+  // 设置表单数据
+  xform.setValues = function (_values) {
+    var values = parseBindToValues(_values, flattenSchemaRef.current);
+    setFieldsValue(values);
+  };
+  // 获取表单数据
+  xform.getValues = function (nameList, filterFunc, notFilterUndefined) {
+    var notFilterHideData = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
+    var _a;
+    var values = cloneDeep(form.getFieldsValue(getFieldName(nameList), filterFunc));
+    var _ref = ((_a = storeRef.current) === null || _a === void 0 ? void 0 : _a.getState()) || {},
+      removeHiddenData = _ref.removeHiddenData;
+    if (notFilterHideData && removeHiddenData) {
+      values = filterValuesHidden(values, flattenSchemaRef.current);
+    }
+    if (!notFilterUndefined) {
+      values = filterValuesUndefined(values);
+    }
+    return parseValuesToBind(values, flattenSchemaRef.current);
+  };
+  xform.getValueByPath = function (path) {
+    var name = getFieldName(path);
+    return form.getFieldValue(name);
+  };
+  // 设置某个字段的值
+  xform.setValueByPath = function (path, value) {
+    if (!form.setFieldValue) {
+      var values = form.getFieldsValue();
+      _set(values, path, value);
+      xform.setValues(values);
+      return;
+    }
+    var name = getFieldName(path);
+    form.setFieldValue(name, value);
+    try {
+      if (JSON.stringify(form.getFieldValue(name)) !== JSON.stringify(value)) {
+        form.setFieldValue(name, value);
+      }
+    } catch (error) {}
+  };
+  // 通过某个字段的 schema
+  xform.getSchemaByPath = function (_path) {
+    if (typeof _path !== 'string') {
+      console.warn('请输入正确的路径');
+    }
+    var path = getSchemaFullPath(_path, schemaRef.current);
+    return _get(schemaRef.current, path);
+  };
+  // 获取协议
+  xform.getSchema = function () {
+    return schemaRef.current;
+  };
+  // 设置一组字段错误
+  xform.setErrorFields = function (fieldsError) {
+    var fieldsData = transformFieldsData(fieldsError, getFieldName);
+    if (!fieldsData) {
+      return;
+    }
+    setFields(fieldsData);
+  };
+  // 清空某个字段的错误
+  xform.removeErrorField = function (path) {
+    setFields([{
+      name: getFieldName(path),
+      errors: []
+    }]);
+  };
+  // 获取对应字段名的错误信息
+  xform.getFieldError = function (path) {
+    var name = getFieldName(path);
+    return form.getFieldError(name);
+  };
+  // 获取一组字段名对应的错误信息，返回为数组形式
+  xform.getFieldsError = function (path) {
+    var name = getFieldName(path);
+    return getFieldsError(name);
+  };
+  // 获取对应字段实例
+  xform.getFieldInstance = function (path) {
+    var name = getFieldName(path);
+    return getFieldInstance(name);
+  };
+  // 获取隐藏字段数据
+  xform.getHiddenValues = function () {
+    var values = xform.getValues();
+    var allValues = xform.getValues(true);
+    var hiddenValues = {};
+    var _recursion = function recursion(obj1, obj2, path) {
+      Object.keys(obj1).forEach(function (key) {
+        var value = obj1[key];
+        var _path = path ? "".concat(path, ".").concat(key) : key;
+        if (!obj2.hasOwnProperty(key)) {
+          _set(hiddenValues, _path, value);
+          return;
+        }
+        if (isObject(value)) {
+          _recursion(value, obj2[key], _path);
+        }
+        if (isArray(value)) {
+          value.map(function (item, index) {
+            _recursion(item, _get(obj2, "".concat(key, "[").concat(index, "]"), []), "".concat(_path, "[").concat(index, "]"));
+          });
+        }
+      });
+    };
+    _recursion(allValues, values, null);
+    return hiddenValues;
+  };
+  // 设置一组字段状态
+  xform.setFields = function (nameList) {
+    var fieldsData = transformFieldsData(nameList, getFieldName);
+    if (!fieldsData) {
+      return;
+    }
+    setFields(fieldsData);
+  };
+  xform.__initStore = function (store) {
+    storeRef.current = store;
+  };
+  // 滚动到对应字段位置
+  xform.scrollToPath = function (path) {
+    var name = getFieldName(path);
+    for (var _len = arguments.length, rest = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      rest[_key - 1] = arguments[_key];
+    }
+    scrollToField.apply(void 0, [name].concat(rest));
+  };
+  // 检查一组字段是否被用户操作过，allTouched 为 true 时检查是否所有字段都被操作过
+  xform.isFieldsTouched = function (pathList, allTouched) {
+    var nameList = (pathList || []).map(function (path) {
+      return getFieldName(path);
+    });
+    return isFieldsTouched(nameList, allTouched);
+  };
+  // 检查对应字段是否被用户操作过
+  xform.isFieldTouched = function (path) {
+    var name = getFieldName(path);
+    return isFieldTouched(name);
+  };
+  // 检查对应字段是否被用户操作过
+  xform.isFieldValidating = function (path) {
+    var name = getFieldName(path);
+    return isFieldValidating(name);
+  };
+  xform.resetFields = function (pathList) {
+    var nameList = (pathList || []).map(function (path) {
+      return getFieldName(path);
+    });
+    if (nameList.length > 0) {
+      resetFields(nameList);
+    } else {
+      resetFields();
+    }
+  };
+  // 触发表单验证
+  xform.validateFields = function (pathList, config) {
+    var nameList = (pathList || []).map(function (path) {
+      return getFieldName(path);
+    });
+    if (nameList.length > 0) {
+      return validateFields(nameList, config);
+    }
+    return validateFields();
+  };
+  xform.getFlattenSchema = function (path) {
+    var _a;
+    if (!path) {
+      return flattenSchemaRef.current;
+    }
+    return (_a = flattenSchemaRef.current) === null || _a === void 0 ? void 0 : _a[path];
+  };
+  // 老 API 兼容
+  xform.onItemChange = xform.setValueByPath;
+  xform.setFieldRef = function (path, ref) {
+    if (!path) {
+      return;
+    }
+    fieldRefs.current[path] = ref;
+  };
+  xform.getFieldRef = function (path) {
+    return fieldRefs.current[path];
+  };
+  return xform;
+};
+export default useForm;

package/es/models/validateMessage.d.ts

@@ -0,0 +1,93 @@
+export declare const validateMessagesEN: {
+    default: string;
+    required: string;
+    enum: string;
+    whitespace: string;
+    date: {
+        format: string;
+        parse: string;
+        invalid: string;
+    };
+    types: {
+        string: string;
+        method: string;
+        array: string;
+        object: string;
+        number: string;
+        date: string;
+        boolean: string;
+        integer: string;
+        float: string;
+        regexp: string;
+        email: string;
+        url: string;
+        hex: string;
+    };
+    string: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    number: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    array: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    pattern: {
+        mismatch: string;
+    };
+};
+export declare const validateMessagesCN: {
+    default: string;
+    required: string;
+    whitespace: string;
+    date: {
+        format: string;
+        parse: string;
+        invalid: string;
+    };
+    types: {
+        string: string;
+        method: string;
+        array: string;
+        object: string;
+        number: string;
+        date: string;
+        boolean: string;
+        integer: string;
+        float: string;
+        regexp: string;
+        email: string;
+        url: string;
+        hex: string;
+    };
+    string: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    number: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    array: {
+        len: string;
+        min: string;
+        max: string;
+        range: string;
+    };
+    pattern: {
+        mismatch: string;
+    };
+};

package/es/models/validateMessage.js

@@ -0,0 +1,95 @@
+var typeTemplate = "'${label}' is not a valid ${type}";
+var typeTemplateCN = "数据类型必须是 ${type}";
+export var validateMessagesEN = {
+  default: "Validation error on field '${label}'",
+  required: "'${label}' is required",
+  enum: "'${label}' must be one of [${enum}]",
+  whitespace: "'${label}' cannot be empty",
+  date: {
+    format: "'${label}' is invalid for format date",
+    parse: "'${label}' could not be parsed as date",
+    invalid: "'${label}' is invalid date"
+  },
+  types: {
+    string: typeTemplate,
+    method: typeTemplate,
+    array: typeTemplate,
+    object: typeTemplate,
+    number: typeTemplate,
+    date: typeTemplate,
+    boolean: typeTemplate,
+    integer: typeTemplate,
+    float: typeTemplate,
+    regexp: typeTemplate,
+    email: typeTemplate,
+    url: typeTemplate,
+    hex: typeTemplate
+  },
+  string: {
+    len: "'${label}' must be exactly ${len} characters",
+    min: "'${label}' must be at least ${min} characters",
+    max: "'${label}' cannot be longer than ${max} characters",
+    range: "'${label}' must be between ${min} and ${max} characters"
+  },
+  number: {
+    len: "'${label}' must equal ${len}",
+    min: "'${label}' cannot be less than ${min}",
+    max: "'${label}' cannot be greater than ${max}",
+    range: "'${label}' must be between ${min} and ${max}"
+  },
+  array: {
+    len: "'${label}' must be exactly ${len} in length",
+    min: "'${label}' cannot be less than ${min} in length",
+    max: "'${label}' cannot be greater than ${max} in length",
+    range: "'${label}' must be between ${min} and ${max} in length"
+  },
+  pattern: {
+    mismatch: "'${label}' does not match pattern ${pattern}"
+  }
+};
+export var validateMessagesCN = {
+  default: '${label}未通过校验',
+  required: '${label}必填',
+  whitespace: '${label}不能为空',
+  date: {
+    format: '${label}的格式错误',
+    parse: '${label}无法被解析',
+    invalid: '${label}数据不合法'
+  },
+  types: {
+    string: typeTemplateCN,
+    method: typeTemplateCN,
+    array: typeTemplateCN,
+    object: typeTemplateCN,
+    number: typeTemplateCN,
+    date: typeTemplateCN,
+    boolean: typeTemplateCN,
+    integer: typeTemplateCN,
+    float: typeTemplateCN,
+    regexp: typeTemplateCN,
+    email: typeTemplateCN,
+    url: typeTemplateCN,
+    hex: typeTemplateCN
+  },
+  string: {
+    len: '${label}长度不是${len}',
+    min: '${label}长度不能小于${min}',
+    max: '${label}长度不能大于${max}',
+    range: '${label}长度需在${min}与${max}之间'
+  },
+  number: {
+    len: '${label}不等于${len}',
+    min: '${label}不能小于${min}',
+    max: '${label}不能大于${max}',
+    range: '${label}需在${min}与${max}之间'
+  },
+  array: {
+    len: '${label}长度不是${len}',
+    min: '${label}长度不能小于${min}',
+    max: '${label}长度不能大于${max}',
+    range: '${label}长度需在${min}与${max}之间'
+  },
+  pattern: {
+    mismatch: '${label}未通过正则判断${pattern}'
+  }
+};

package/es/models/validates.d.ts

@@ -0,0 +1,3 @@
+export declare const transformRules: (rules: any[], methods: any, form: any) => any[];
+declare const _default: (_schema: any, form: any, methods: any, fieldRef: any) => any[];
+export default _default;