@tmagic/editor 1.8.0-manmanyu.8 → 1.8.0

package/dist/es/utils/type-match-rules.js

@@ -0,0 +1,356 @@
+import { arrayOptions, booleanOptions, eqOptions, getCondOpOptionsByFieldType, numberOptions } from "./props.js";
+import editor_default from "../services/editor.js";
+import { getFieldType, resolveFieldByPath } from "./data-source/index.js";
+import codeBlock_default from "../services/codeBlock.js";
+import dataSource_default from "../services/dataSource.js";
+import { DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX, DATA_SOURCE_SET_DATA_METHOD_NAME, dataSourceTemplateRegExp, getKeysArray, removeDataSourceFieldPrefix } from "@tmagic/utils";
+import { NodeType } from "@tmagic/core";
+import { appendValidateSuggestion } from "@tmagic/design/headless";
+import { MAX_SUGGESTION_OPTIONS, optionSuggestion, stringifyExampleValue, validateTypeMatch } from "@tmagic/form/headless";
+//#region packages/editor/src/utils/type-match-rules.ts
+/** 复用 form 的可选项建议文案；额外过滤 null / 空串，避免业务侧无效枚举污染提示。 */
+var listSuggestion = (values) => optionSuggestion(values.filter((item) => item !== null && item !== ""));
+/**
+* 列出当前可用数据源 id 的参考建议。
+*/
+var dataSourceIdSuggestion = () => listSuggestion(getDataSources().map((ds) => `${ds.id}`));
+var SUGGESTION_STRING = "请参考以下示例值：\"文本内容\"";
+var SUGGESTION_STRING_OR_NUMBER = "请参考以下示例值：\"文本内容\" 或 123";
+var SUGGESTION_OBJECT = "请参考以下示例值：{ \"key\": \"value\" }";
+var SUGGESTION_ARRAY = "请参考以下示例值：[]";
+var SUGGESTION_STRING_ARRAY = "请参考以下示例值：[\"字段1\", \"字段2\"]";
+var SUGGESTION_METHOD_TUPLE = "请参考以下示例值：[\"数据源ID\", \"方法名\"]";
+var SUGGESTION_DS_BINDING = "请参考以下示例值：\"${数据源ID.字段名}\"";
+var SUGGESTION_DS_BIND_OBJECT = "请参考以下示例值：{ \"isBindDataSource\": true, \"dataSourceId\": \"数据源ID\" }";
+var SUGGESTION_UI_ID = "请参考以下示例值：画布中已存在组件的 id";
+var SUGGESTION_FIELD_ITEM = "请参考以下示例值：{ \"name\": \"字段名\", \"type\": \"string\" }";
+var SUGGESTION_CODE_SELECT = "请参考以下示例值：{ \"hookData\": [{ \"codeId\": \"代码块ID\", \"params\": {} }] }";
+var SUGGESTION_HOOK_ITEM = "请参考以下示例值：{ \"codeId\": \"代码块ID\", \"params\": {} }";
+var SUGGESTION_MOCK_ITEM = "请参考以下示例值：{ \"title\": \"mock 名称\", \"enable\": true, \"useInEditor\": false, \"data\": {} }";
+var SUGGESTION_METHOD_ITEM = "请参考以下示例值：{ \"name\": \"方法名\", \"content\": \"() => {}\" }";
+var SUGGESTION_EVENT_ITEM = "请参考以下示例值：{ \"name\": \"事件名\", \"actions\": [] }";
+var SUGGESTION_DISPLAY_COND = "请参考以下示例值：[{ \"cond\": [{ \"field\": [\"数据源ID\", \"字段名\"], \"op\": \"==\" }] }]";
+/**
+* 返回最终错误文案。
+*
+* - 传入了自定义 `message` 时，直接使用自定义文案（不追加建议）；
+* - 否则使用默认文案 `fallback`，并在其后拼接「参考建议」。
+*   参考建议给出一个可参考的示例值（如可选项列表、示例数据），仅用于错误汇总展示；
+*   form-item 行内错误不展示建议（由 @tmagic/design FormItem 在渲染时截断建议）。
+*   主文案与建议的拼接/截断统一复用 @tmagic/design 的 `appendValidateSuggestion`。
+*/
+var defaultMessage = (message, fallback, suggestion) => {
+	if (message) return message;
+	return appendValidateSuggestion(fallback, suggestion);
+};
+var isPlainObject = (value) => Object.prototype.toString.call(value) === "[object Object]";
+var isId = (value) => typeof value === "string" || typeof value === "number";
+var DATA_SOURCE_FIELD_TYPES = /* @__PURE__ */ new Set([
+	"null",
+	"boolean",
+	"object",
+	"array",
+	"number",
+	"string",
+	"any"
+]);
+var ALL_COND_OPS = /* @__PURE__ */ new Set([
+	...arrayOptions.map((item) => item.value),
+	...eqOptions.map((item) => item.value),
+	...numberOptions.map((item) => item.value),
+	...booleanOptions.map((item) => item.value)
+]);
+var getCondOpsByFieldType = (type) => new Set(getCondOpOptionsByFieldType(type).map((item) => item.value));
+var getDataSources = () => dataSource_default.get("dataSources") || [];
+var findDataSource = (id) => getDataSources().find((ds) => `${ds.id}` === `${id}`);
+var getMethodNamesForDataSource = (ds) => {
+	const names = /* @__PURE__ */ new Set([DATA_SOURCE_SET_DATA_METHOD_NAME]);
+	(dataSource_default.getFormMethod(ds.type) || []).forEach((item) => {
+		if (item?.value) names.add(item.value);
+	});
+	(ds.methods || []).forEach((method) => {
+		if (method?.name) names.add(method.name);
+	});
+	return names;
+};
+/**
+* 递归收集画布中真实存在的组件 id。
+*/
+var collectNodeIds = (limit = MAX_SUGGESTION_OPTIONS) => {
+	const ids = [];
+	const walk = (nodes) => {
+		for (const node of nodes || []) {
+			if (typeof node?.id !== "undefined") {
+				ids.push(node.id);
+				if (ids.length >= limit) return true;
+			}
+			if (Array.isArray(node?.items) && walk(node.items)) return true;
+		}
+		return false;
+	};
+	walk(editor_default.get("root")?.items);
+	return ids;
+};
+/**
+* 取数据源的第一个字段名，用于拼接真实的字段路径示例。
+*/
+var firstDataSourceFieldName = (ds) => (ds?.fields || []).find((item) => typeof item?.name === "string")?.name;
+/**
+* 列出画布中真实存在的组件 id 作为参考建议；无组件时回退到通用示例。
+*/
+var uiIdSuggestion = () => listSuggestion(collectNodeIds().map((id) => `${id}`)) || SUGGESTION_UI_ID;
+/**
+* 用真实数据源 id、字段名拼接数据源绑定表达式示例；无数据源时回退到通用示例。
+*/
+var dataSourceBindingSuggestion = () => {
+	const ds = getDataSources()[0];
+	if (!ds) return SUGGESTION_DS_BINDING;
+	const field = firstDataSourceFieldName(ds);
+	return `请参考以下示例值："\${${field ? `${ds.id}.${field}` : `${ds.id}`}}"`;
+};
+/**
+* 用真实数据源 id 拼接数据源绑定对象示例；无数据源时回退到通用示例。
+*/
+var dataSourceBindObjectSuggestion = (dataSources = getDataSources()) => {
+	const ds = dataSources[0];
+	if (!ds) return SUGGESTION_DS_BIND_OBJECT;
+	return `请参考以下示例值：${stringifyExampleValue({
+		isBindDataSource: true,
+		dataSourceId: `${ds.id}`
+	})}`;
+};
+/**
+* 用真实数据源 id、字段名拼接字段路径数组示例；无数据源时回退到通用示例。
+*/
+var dataSourceFieldPathSuggestion = () => {
+	const ds = getDataSources()[0];
+	if (!ds) return SUGGESTION_STRING_ARRAY;
+	const field = firstDataSourceFieldName(ds);
+	return `请参考以下示例值：${stringifyExampleValue(field ? [`${ds.id}`, field] : [`${ds.id}`])}`;
+};
+/**
+* 用真实数据源 id、方法名拼接方法元组示例；无数据源时回退到通用示例。
+*/
+var methodTupleSuggestion = () => {
+	const ds = getDataSources()[0];
+	if (!ds) return SUGGESTION_METHOD_TUPLE;
+	const [methodName] = [...getMethodNamesForDataSource(ds)];
+	return `请参考以下示例值：${stringifyExampleValue([`${ds.id}`, methodName])}`;
+};
+/**
+* 用真实数据源 id、字段名拼接显示条件结构示例；无数据源时回退到通用示例。
+*/
+var displayCondSuggestion = () => {
+	const ds = getDataSources()[0];
+	if (!ds) return SUGGESTION_DISPLAY_COND;
+	const field = firstDataSourceFieldName(ds);
+	const fieldPath = field ? [`${ds.id}`, field] : [`${ds.id}`];
+	return `请参考以下示例值：${stringifyExampleValue([{ cond: [{
+		field: fieldPath,
+		op: "=="
+	}] }])}`;
+};
+var validateDataSourceFieldPath = (path, options = {}) => {
+	if (!getDataSources().length) return;
+	const dsId = options.dataSourceId;
+	if (!dsId) return defaultMessage(options.message, "数据源不存在", dataSourceIdSuggestion());
+	const ds = findDataSource(`${dsId}`);
+	if (!ds) return defaultMessage(options.message, `数据源(${dsId})不存在`, dataSourceIdSuggestion());
+	if (!path.length) return;
+	const { field, ok, fields, failedName } = resolveFieldByPath(ds.fields, path);
+	if (!ok) return defaultMessage(options.message, `数据源字段(${failedName})不存在`, listSuggestion(fields.map((item) => item.name)));
+	const allowedTypes = options.dataSourceFieldType || ["any"];
+	if (!allowedTypes.length || allowedTypes.includes("any")) return;
+	const leafType = field?.type || "any";
+	if (leafType !== "any" && !allowedTypes.includes(leafType)) {
+		const fieldName = field?.name || path[path.length - 1];
+		return defaultMessage(options.message, `请选择类型为${allowedTypes.join("或")}的字段，字段(${fieldName})的类型为${leafType}`);
+	}
+};
+var validateDataSourceMethodTuple = (value, message) => {
+	if (!Array.isArray(value) || value.length !== 2 || value.some((item) => typeof item !== "string")) return defaultMessage(message, `${value}类型应为长度为 2 的字符串数组`, methodTupleSuggestion());
+	if (!getDataSources().length) return;
+	const [dsId, methodName] = value;
+	const ds = findDataSource(dsId);
+	if (!ds) return defaultMessage(message, `数据源(${dsId})不存在`, dataSourceIdSuggestion());
+	if (!getMethodNamesForDataSource(ds).has(methodName)) return defaultMessage(message, `数据源方法(${methodName})不存在`, listSuggestion([...getMethodNamesForDataSource(ds)]));
+};
+var validateDataSourceTemplateBindings = (value, message) => {
+	if (!getDataSources().length) return;
+	const matches = value.matchAll(dataSourceTemplateRegExp);
+	for (const match of matches) {
+		const keys = getKeysArray(match[1]);
+		if (!keys.length) return defaultMessage(message, `数据源绑定(${value})不合法`, dataSourceBindingSuggestion());
+		const [dsId, ...fieldNames] = keys;
+		const ds = findDataSource(`${dsId}`);
+		if (!ds) return defaultMessage(message, `数据源绑定(${value})不合法`, dataSourceBindingSuggestion());
+		const { ok } = resolveFieldByPath(ds.fields, fieldNames, { skipNumberIndices: true });
+		if (!ok) return defaultMessage(message, `数据源绑定(${value})不合法`, dataSourceBindingSuggestion());
+	}
+};
+var validateDataSourceFieldsItem = (item, message) => {
+	if (!isPlainObject(item) || typeof item.name !== "string") return defaultMessage(message, "字段项结构不合法", SUGGESTION_FIELD_ITEM);
+	if (typeof item.type !== "undefined" && !DATA_SOURCE_FIELD_TYPES.has(item.type)) return defaultMessage(message, "字段类型不合法", listSuggestion([...DATA_SOURCE_FIELD_TYPES]));
+	if (typeof item.fields !== "undefined") {
+		if (!Array.isArray(item.fields)) return defaultMessage(message, "字段项结构不合法", SUGGESTION_FIELD_ITEM);
+		for (const child of item.fields) {
+			const error = validateDataSourceFieldsItem(child, message);
+			if (error) return error;
+		}
+	}
+};
+var validateKeyValue = (value, { message, props }) => {
+	if (props.config?.advanced && typeof value === "function") return;
+	if (!isPlainObject(value)) return defaultMessage(message, "值类型应为对象", SUGGESTION_OBJECT);
+};
+var validateStyleSetter = (value, { message }) => {
+	if (!isPlainObject(value)) return defaultMessage(message, "值类型应为对象", SUGGESTION_OBJECT);
+};
+var validateCondOpSelect = (value, { message, props }) => {
+	if (typeof value !== "string") return defaultMessage(message, "值类型应为字符串", SUGGESTION_STRING);
+	const parentFields = props.config?.parentFields || [];
+	const fieldPath = Array.isArray(props.model?.field) ? props.model.field : [];
+	const [id, ...fieldNames] = [...parentFields, ...fieldPath];
+	const ds = id ? findDataSource(removeDataSourceFieldPrefix(`${id}`)) : void 0;
+	const allowed = getCondOpsByFieldType(getFieldType(ds, fieldNames));
+	if (!allowed.has(value)) return defaultMessage(message, `${value} 不在可选项中`, listSuggestion([...allowed]));
+};
+var validateCodeSelectCol = (value, { message }) => {
+	if (typeof value !== "string") return defaultMessage(message, `${value}类型应为字符串`, SUGGESTION_STRING);
+	const codeDsl = codeBlock_default.getCodeDsl();
+	if (!codeDsl || !Object.keys(codeDsl).length) return;
+	if (!(value in codeDsl)) return defaultMessage(message, `代码块(${value})不存在`, listSuggestion(Object.keys(codeDsl)));
+};
+var validatePageFragmentSelect = (value, { message }) => {
+	if (!isId(value)) return defaultMessage(message, `${value}类型应为字符串或数字`, SUGGESTION_STRING_OR_NUMBER);
+	const items = editor_default.get("root")?.items;
+	if (!items?.length) return;
+	const fragments = items.filter((item) => item.type === NodeType.PAGE_FRAGMENT);
+	if (!fragments.some((item) => `${item.id}` === `${value}`)) return defaultMessage(message, `页面片段(${value})不存在`, listSuggestion(fragments.map((item) => `${item.id}`)));
+};
+var validateUiSelect = (value, { message }) => {
+	if (!isId(value)) return defaultMessage(message, `${value}类型应为字符串或数字`, SUGGESTION_STRING_OR_NUMBER);
+	if (!editor_default.get("root")) return;
+	if (!editor_default.getNodeById(value)) return defaultMessage(message, `组件(${value})不存在`, uiIdSuggestion());
+};
+var validateDataSourceInput = (value, { message }) => {
+	if (typeof value !== "string") return defaultMessage(message, `${value}类型应为字符串`, SUGGESTION_STRING);
+	return validateDataSourceTemplateBindings(value, message);
+};
+var validateDataSourceMethodSelect = (value, { message }) => validateDataSourceMethodTuple(value, message);
+var isDataSourceFieldPathValue = (value, config) => {
+	if (!Array.isArray(value) || !value.length || value.some((item) => typeof item !== "string")) return false;
+	if (config.dataSourceId) return true;
+	if (config.value === "key") return true;
+	return `${value[0]}`.startsWith(DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX);
+};
+/**
+* data-source-field-select 的 typeMatch 校验逻辑，可供自定义 rules.validator 复用。
+*/
+var validateDataSourceFieldSelect = (value, context, options) => {
+	const { mForm, message, props } = context;
+	const config = props.config || {};
+	if (!isDataSourceFieldPathValue(value, config)) {
+		if (options?.validatePlainValue) return options.validatePlainValue(value, context);
+		if (config.fieldConfig) return validateTypeMatch(value, mForm, {
+			...props,
+			config: {
+				name: config.name,
+				...config.fieldConfig
+			}
+		}, message);
+	}
+	if (!Array.isArray(value) || value.some((item) => typeof item !== "string")) return defaultMessage(message, `${value}类型应为字符串数组`, dataSourceFieldPathSuggestion());
+	let dataSourceId = config.dataSourceId ? `${config.dataSourceId}` : void 0;
+	let fieldNames = value;
+	if (!dataSourceId) {
+		dataSourceId = value.length ? removeDataSourceFieldPrefix(value[0]) : void 0;
+		fieldNames = value.slice(1);
+	}
+	return validateDataSourceFieldPath(fieldNames, {
+		dataSourceId,
+		dataSourceFieldType: config.dataSourceFieldType,
+		message
+	});
+};
+var validateDataSourceSelect = (value, { message, props }) => {
+	const config = props.config || {};
+	const dataSources = getDataSources();
+	const filtered = config.dataSourceType ? dataSources.filter((ds) => ds.type === config.dataSourceType) : dataSources;
+	if (config.value === "id") {
+		if (typeof value !== "string") return defaultMessage(message, `${value}类型应为字符串`, SUGGESTION_STRING);
+		if (!filtered.length) return;
+		if (!filtered.some((ds) => `${ds.id}` === `${value}`)) return defaultMessage(message, `${value}不在可选项中`, listSuggestion(filtered.map((ds) => `${ds.id}`)));
+		return;
+	}
+	if (!isPlainObject(value) || value.isBindDataSource !== true || typeof value.dataSourceId === "undefined") return defaultMessage(message, `${value}类型不合法`, dataSourceBindObjectSuggestion(filtered));
+	if (!filtered.length) return;
+	const ds = filtered.find((item) => `${item.id}` === `${value.dataSourceId}`);
+	if (!ds) return defaultMessage(message, `${value}不在可选项中`, listSuggestion(filtered.map((item) => `${item.id}`)));
+	if (typeof value.dataSourceType !== "undefined" && value.dataSourceType !== ds.type) return defaultMessage(message, `${value}不在可选项中`, listSuggestion(filtered.map((item) => `${item.id}`)));
+};
+var validateCodeSelect = (value, { message }) => {
+	if (!isPlainObject(value) || !Array.isArray(value.hookData)) return defaultMessage(message, `${value}类型不合法`, SUGGESTION_CODE_SELECT);
+	for (const item of value.hookData) {
+		if (!isPlainObject(item)) return defaultMessage(message, "钩子项结构不合法", SUGGESTION_HOOK_ITEM);
+		if (typeof item.params !== "undefined" && !isPlainObject(item.params)) return defaultMessage(message, "钩子项结构不合法", SUGGESTION_HOOK_ITEM);
+	}
+};
+var validateDataSourceFields = (value, { message }) => {
+	if (!Array.isArray(value)) return defaultMessage(message, `${value}类型应为数组`, SUGGESTION_ARRAY);
+	for (const item of value) {
+		const error = validateDataSourceFieldsItem(item, message);
+		if (error) return error;
+	}
+};
+var validateDataSourceMocks = (value, { message }) => {
+	if (!Array.isArray(value)) return defaultMessage(message, `${value}类型应为数组`, SUGGESTION_ARRAY);
+	for (const item of value) if (!isPlainObject(item) || typeof item.title !== "string" || typeof item.enable !== "boolean" || typeof item.useInEditor !== "boolean" || !isPlainObject(item.data)) return defaultMessage(message, "mock 项结构不合法", SUGGESTION_MOCK_ITEM);
+};
+var validateDataSourceMethods = (value, { message }) => {
+	if (!Array.isArray(value)) return defaultMessage(message, `${value}类型应为数组`, SUGGESTION_ARRAY);
+	for (const item of value) {
+		if (!isPlainObject(item) || typeof item.name !== "string") return defaultMessage(message, "方法项结构不合法", SUGGESTION_METHOD_ITEM);
+		if (typeof item.content !== "undefined" && typeof item.content !== "string" && typeof item.content !== "function") return defaultMessage(message, "方法项结构不合法", SUGGESTION_METHOD_ITEM);
+		if (typeof item.params !== "undefined" && !Array.isArray(item.params)) return defaultMessage(message, "方法项结构不合法", SUGGESTION_METHOD_ITEM);
+	}
+};
+var validateEventSelect = (value, { message }) => {
+	if (!Array.isArray(value)) return defaultMessage(message, `${value}类型应为数组`, SUGGESTION_ARRAY);
+	for (const item of value) {
+		if (!isPlainObject(item) || typeof item.name !== "string") return defaultMessage(message, "事件项结构不合法", SUGGESTION_EVENT_ITEM);
+		if (Array.isArray(item.actions)) {
+			for (const action of item.actions) if (!isPlainObject(action) || typeof action.actionType === "undefined") return defaultMessage(message, "事件项结构不合法", SUGGESTION_EVENT_ITEM);
+			continue;
+		}
+		if (typeof item.to === "undefined" || typeof item.method !== "string") return defaultMessage(message, "事件项结构不合法", SUGGESTION_EVENT_ITEM);
+	}
+};
+var validateDisplayConds = (value, { message }) => {
+	if (!Array.isArray(value)) return defaultMessage(message, `${value}类型应为数组`, SUGGESTION_ARRAY);
+	for (const item of value) {
+		if (!isPlainObject(item) || !Array.isArray(item.cond)) return defaultMessage(message, "显示条件结构不合法", displayCondSuggestion());
+		for (const cond of item.cond) if (!isPlainObject(cond) || !Array.isArray(cond.field) || cond.field.some((part) => typeof part !== "string") || typeof cond.op !== "string") return defaultMessage(message, "显示条件结构不合法", displayCondSuggestion());
+	}
+};
+var editorTypeMatchRules = {
+	"key-value": validateKeyValue,
+	"style-setter": validateStyleSetter,
+	"cond-op-select": validateCondOpSelect,
+	"code-select-col": validateCodeSelectCol,
+	"page-fragment-select": validatePageFragmentSelect,
+	"ui-select": validateUiSelect,
+	"data-source-input": validateDataSourceInput,
+	"data-source-method-select": validateDataSourceMethodSelect,
+	/** 注册进 typeMatch 规则表的入口，收窄为 TypeMatchValidator，避免调用方误传第三个参数 */
+	"data-source-field-select": (value, context) => validateDataSourceFieldSelect(value, context),
+	"data-source-select": validateDataSourceSelect,
+	"code-select": validateCodeSelect,
+	"data-source-fields": validateDataSourceFields,
+	"data-source-mocks": validateDataSourceMocks,
+	"data-source-methods": validateDataSourceMethods,
+	"event-select": validateEventSelect,
+	"display-conds": validateDisplayConds
+};
+//#endregion
+export { ALL_COND_OPS, editorTypeMatchRules, validateDataSourceFieldSelect };