@tmagic/editor 1.8.0-beta.1 → 1.8.0-beta.11

package/dist/es/services/codeBlock.js

@@ -1,12 +1,15 @@
 import { CODE_DRAFT_STORAGE_KEY } from "../type.js";
-import BaseService_default from "./BaseService.js";
+import BaseService from "./BaseService.js";
 import { getEditorConfig } from "../utils/config.js";
+import { createStackStep, describeRevertStep, getLastPushedHistoryIds } from "../utils/history.js";
+import history_default from "./history.js";
 import storage_default, { Protocol } from "./storage.js";
 import { COPY_CODE_STORAGE_KEY } from "../utils/editor.js";
 import editor_default from "./editor.js";
+import { getValueByKeyPath, setValueByKeyPath } from "@tmagic/utils";
 import { Target, Watcher } from "@tmagic/core";
 import { reactive } from "vue";
-import { cloneDeep, get, keys, pick } from "lodash-es";
+import { cloneDeep as cloneDeep$1, get, keys, pick } from "lodash-es";
 //#region packages/editor/src/services/codeBlock.ts
 var canUsePluginMethods = {
 	async: [
@@ -18,7 +21,7 @@ var canUsePluginMethods = {
 	],
 	sync: ["setCodeDslByIdSync"]
 };
-var CodeBlock = class extends BaseService_default {
+var CodeBlock = class extends BaseService {
 	state = reactive({
 		codeDsl: null,
 		editable: true,
@@ -26,6 +29,16 @@ var CodeBlock = class extends BaseService_default {
 		undeletableList: [],
 		paramsColConfig: void 0
 	});
+	/**
+	* 最近一次写入历史栈的代码块历史记录 uuid（单条写入场景：新增 / 更新）。
+	* 供 setCodeDslById(Sync)AndGetHistoryId 取回，普通方法不读取它。
+	*/
+	lastPushedHistoryId = null;
+	/**
+	* deleteCodeDslByIds 一次删除多个代码块时，按写入顺序收集的历史记录 uuid 列表。
+	* 在 deleteCodeDslByIds 入口处重置，供 deleteCodeDslByIdsAndGetHistoryId 取回。
+	*/
+	lastDeletedHistoryIds = [];
 	constructor() {
 		super([...canUsePluginMethods.async.map((methodName) => ({
 			name: methodName,
@@ -43,6 +56,7 @@ var CodeBlock = class extends BaseService_default {
 	async setCodeDsl(codeDsl) {
 		this.state.codeDsl = codeDsl;
 		this.emit("code-dsl-change", this.state.codeDsl);
+		this.emit("change", this.state.codeDsl);
 	}
 	/**
 	* 获取活动的代码块dsl数据源（默认从dsl中的codeBlocks字段读取）
@@ -68,10 +82,18 @@ var CodeBlock = class extends BaseService_default {
 	* 设置代码块ID和代码内容到源dsl
 	* @param {Id} id 代码块id
 	* @param {CodeBlockContent} codeConfig 代码块内容配置信息
+	* @param options 可选配置
+	* @param options.changeRecords form 端 propPath/value 列表，用于历史记录的精细化撤销/重做
+	* @param options.doNotPushHistory 是否不写入历史记录（默认 false）
 	* @returns {void}
 	*/
-	async setCodeDslById(id, codeConfig) {
-		this.setCodeDslByIdSync(id, codeConfig, true);
+	async setCodeDslById(id, codeConfig, { changeRecords, doNotPushHistory = false, historyDescription, historySource } = {}) {
+		this.setCodeDslByIdSync(id, codeConfig, true, {
+			changeRecords,
+			doNotPushHistory,
+			historyDescription,
+			historySource
+		});
 	}
 	/**
 	* 为了兼容历史原因
@@ -79,22 +101,39 @@ var CodeBlock = class extends BaseService_default {
 	* @param {Id} id 代码块id
 	* @param {CodeBlockContent} codeConfig 代码块内容配置信息
 	* @param {boolean} force 是否强制写入，默认true
+	* @param options 可选配置
+	* @param options.changeRecords form 端 propPath/value 列表，用于历史记录的精细化撤销/重做
+	* @param options.doNotPushHistory 是否不写入历史记录（默认 false）
+	* @param options.historyDescription 入栈时附带的人类可读描述，用于历史面板展示
 	* @returns {void}
 	*/
-	setCodeDslByIdSync(id, codeConfig, force = true) {
+	setCodeDslByIdSync(id, codeConfig, force = true, { changeRecords, doNotPushHistory = false, historyDescription, historySource } = {}) {
 		const codeDsl = this.getCodeDsl();
 		if (!codeDsl) throw new Error("dsl中没有codeBlocks");
 		if (codeDsl[id] && !force) return;
-		const codeConfigProcessed = cloneDeep(codeConfig);
+		const codeConfigProcessed = cloneDeep$1(codeConfig);
 		if (codeConfigProcessed.content) {
 			const parseDSL = getEditorConfig("parseDSL");
 			if (typeof codeConfigProcessed.content === "string") codeConfigProcessed.content = parseDSL(codeConfigProcessed.content);
 		}
+		const oldContent = codeDsl[id] ? cloneDeep$1(codeDsl[id]) : null;
 		codeDsl[id] = {
 			...codeDsl[id] || {},
 			...codeConfigProcessed
 		};
+		const newContent = cloneDeep$1(codeDsl[id]);
+		if (!doNotPushHistory) {
+			const step = createStackStep(id, {
+				oldValue: oldContent,
+				newValue: newContent,
+				changeRecords,
+				historyDescription,
+				source: historySource
+			});
+			this.lastPushedHistoryId = (step ? history_default.push("codeBlock", step, id) : null)?.uuid ?? null;
+		}
 		this.emit("addOrUpdate", id, codeDsl[id]);
+		this.emit("change", this.getCodeDsl());
 	}
 	/**
 	* 根据代码块id数组获取代码dsl
@@ -170,14 +209,66 @@ var CodeBlock = class extends BaseService_default {
 	/**
 	* 在dsl数据源中删除指定id的代码块
 	* @param {Id[]} codeIds 需要删除的代码块id数组
+	* @param options 可选配置
+	* @param options.doNotPushHistory 是否不写入历史记录（默认 false）
 	*/
-	async deleteCodeDslByIds(codeIds) {
+	async deleteCodeDslByIds(codeIds, { doNotPushHistory = false, historyDescription, historySource } = {}) {
 		const currentDsl = await this.getCodeDsl();
 		if (!currentDsl) return;
+		this.lastDeletedHistoryIds = [];
 		codeIds.forEach((id) => {
+			const oldValue = currentDsl[id] ? cloneDeep$1(currentDsl[id]) : null;
 			delete currentDsl[id];
+			if (oldValue && !doNotPushHistory) {
+				const step = createStackStep(id, {
+					oldValue,
+					newValue: null,
+					historyDescription,
+					source: historySource
+				});
+				const uuid = step ? history_default.push("codeBlock", step, id)?.uuid : void 0;
+				if (uuid) this.lastDeletedHistoryIds.push(uuid);
+			}
 			this.emit("remove", id);
 		});
+		this.emit("change", this.getCodeDsl());
+	}
+	/**
+	* 下列 *AndGetHistoryId 方法与对应的写入方法行为完全一致，
+	* 返回值在 {@link DslOpWithHistoryIdsResult} 中同时包含原操作结果与本次写入的历史 uuid 列表，
+	* 可用于精确引用 / 定位该条历史记录（埋点、revert、跨端同步等）。
+	*
+	* 当本次操作未写入历史（doNotPushHistory 为 true、或无对应记录）时 historyIds 为 `[]`。
+	*/
+	/** 等价于 {@link setCodeDslById}，并额外返回本次写入历史记录的 uuid 列表（未入栈时 historyIds 为 `[]`）。 */
+	async setCodeDslByIdAndGetHistoryId(id, codeConfig, options = {}) {
+		this.lastPushedHistoryId = null;
+		await this.setCodeDslById(id, codeConfig, options);
+		return {
+			result: void 0,
+			historyIds: getLastPushedHistoryIds(this.lastPushedHistoryId)
+		};
+	}
+	/** 等价于 {@link setCodeDslByIdSync}，并额外返回本次写入历史记录的 uuid 列表（未入栈时 historyIds 为 `[]`）。 */
+	setCodeDslByIdSyncAndGetHistoryId(id, codeConfig, force = true, options = {}) {
+		this.lastPushedHistoryId = null;
+		this.setCodeDslByIdSync(id, codeConfig, force, options);
+		return {
+			result: void 0,
+			historyIds: getLastPushedHistoryIds(this.lastPushedHistoryId)
+		};
+	}
+	/**
+	* 等价于 {@link deleteCodeDslByIds}，并额外返回本次写入的全部历史记录 uuid（按删除顺序）。
+	* 一次删除多个代码块会产生多条历史记录；未写入任何历史时 historyIds 为 `[]`。
+	*/
+	async deleteCodeDslByIdsAndGetHistoryId(codeIds, options = {}) {
+		this.lastDeletedHistoryIds = [];
+		await this.deleteCodeDslByIds(codeIds, options);
+		return {
+			result: void 0,
+			historyIds: [...this.lastDeletedHistoryIds]
+		};
 	}
 	setParamsColConfig(config) {
 		this.state.paramsColConfig = config;
@@ -186,6 +277,95 @@ var CodeBlock = class extends BaseService_default {
 		return this.state.paramsColConfig;
 	}
 	/**
+	* 撤销指定代码块的最近一次变更。
+	*
+	* 内部走 setCodeDslByIdSync / deleteCodeDslByIds，因此会自动触发 codeBlockService 的
+	* `addOrUpdate` / `remove` 事件，由 initService 中的 handler 重新维护 dep target
+	* （DepTargetType.CODE_BLOCK 的 add / remove）。所有写回都带 `doNotPushHistory: true`，
+	* 确保不会在历史栈里产生新的记录。
+	*
+	* @param id 代码块 id
+	* @returns 撤销的 step；栈不存在或已无可撤销时返回 null
+	*/
+	async undo(id) {
+		const step = history_default.undo("codeBlock", id);
+		if (!step) return null;
+		await this.applyHistoryStep(step, true);
+		return step;
+	}
+	/**
+	* 重做指定代码块的下一次变更。
+	* @param id 代码块 id
+	* @returns 重做的 step；栈不存在或已无可重做时返回 null
+	*/
+	async redo(id) {
+		const step = history_default.redo("codeBlock", id);
+		if (!step) return null;
+		await this.applyHistoryStep(step, false);
+		return step;
+	}
+	/** 是否可对指定代码块撤销。 */
+	canUndo(id) {
+		return history_default.canUndo("codeBlock", id);
+	}
+	/** 是否可对指定代码块重做。 */
+	canRedo(id) {
+		return history_default.canRedo("codeBlock", id);
+	}
+	/**
+	* 跳转指定代码块的历史栈到目标游标。语义同 editor.gotoPageStep。
+	*
+	* @param id          代码块 id
+	* @param targetCursor 目标游标位置（已应用步骤数量）
+	* @returns 实际移动到的最终游标位置
+	*/
+	async goto(id, targetCursor) {
+		let cursor = history_default.getCursor("codeBlock", id);
+		const target = Math.max(0, targetCursor);
+		while (cursor > target) {
+			if (!await this.undo(id)) break;
+			cursor -= 1;
+		}
+		while (cursor < target) {
+			if (!await this.redo(id)) break;
+			cursor += 1;
+		}
+		return cursor;
+	}
+	/**
+	* 「回滚」指定代码块历史步骤（类 git revert 语义）：
+	* - 不动原始栈结构（不移动 cursor、不丢弃任何步骤）；
+	* - 把目标 step 的修改**反向应用**一次，并作为**新步骤**追加到栈顶；
+	* - 仅对已应用的步骤生效。
+	*
+	* @param id    代码块 id
+	* @param index 目标 step 在该栈中的索引（0 为最早），通常由历史面板传入
+	* @returns 反向后产生的新 step；目标不存在 / 未应用时返回 null
+	*/
+	async revert(id, index) {
+		const entry = history_default.getStepList("codeBlock", id)[index];
+		if (!entry?.applied) return null;
+		const { oldSchema, newSchema, changeRecords } = entry.step.diff?.[0] ?? {};
+		if (oldSchema && newSchema && !changeRecords?.length) return null;
+		const description = `回滚 #${index + 1}: ${describeRevertStep(entry.step.data.id, entry.step.diff?.[0], (s) => s.name)}`;
+		return await this.applyRevertStep(entry.step, description);
+	}
+	/**
+	* 通过历史记录 uuid 回滚代码块历史步骤，语义同 {@link revert}，
+	* 仅无需调用方再传 codeBlockId 与 index：内部会按 uuid 在全部代码块栈中定位对应步骤后再回滚。
+	* 按数组顺序依次回滚，返回与入参同序的结果列表（某项失败时为 `null`）。
+	*
+	* @param uuids 目标历史记录的 uuid 列表，通常由 {@link setCodeDslByIdAndGetHistoryId} 等方法返回的 `historyIds`
+	*/
+	async revertById(uuids) {
+		const results = [];
+		for (const uuid of uuids) {
+			const location = history_default.findStepLocationByUuid("codeBlock", uuid);
+			results.push(location ? await this.revert(location.id, location.index) : null);
+		}
+		return results;
+	}
+	/**
 	* 生成代码块唯一id
 	* @returns {Id} 代码块唯一id
 	*/
@@ -245,6 +425,104 @@ var CodeBlock = class extends BaseService_default {
 	usePlugin(options) {
 		super.usePlugin(options);
 	}
+	/**
+	* 反向应用一个 step 并以新 step 入栈。逻辑与 applyHistoryStep(reverse=true) 同构，
+	* 差异仅在于通过公开的 setCodeDslByIdSync / deleteCodeDslByIds 触发 push。
+	*/
+	async applyRevertStep(step, historyDescription) {
+		const { id } = step.data;
+		const { oldSchema, newSchema, changeRecords } = step.diff?.[0] ?? {};
+		if (!oldSchema && newSchema) {
+			await this.deleteCodeDslByIds([id], {
+				historyDescription,
+				historySource: "rollback"
+			});
+			return history_default.getStepList("codeBlock", id).slice(-1)[0]?.step ?? null;
+		}
+		if (oldSchema && !newSchema) {
+			this.setCodeDslByIdSync(id, cloneDeep$1(oldSchema), true, {
+				historyDescription,
+				historySource: "rollback"
+			});
+			return history_default.getStepList("codeBlock", id).slice(-1)[0]?.step ?? null;
+		}
+		if (!oldSchema || !newSchema) return null;
+		if (changeRecords?.length) {
+			const current = this.getCodeContentById(id);
+			if (!current) return null;
+			const patched = cloneDeep$1(current);
+			let fallbackToFullReplace = false;
+			for (const record of changeRecords) {
+				if (!record.propPath) {
+					fallbackToFullReplace = true;
+					break;
+				}
+				const value = cloneDeep$1(getValueByKeyPath(record.propPath, oldSchema));
+				setValueByKeyPath(record.propPath, value, patched);
+			}
+			this.setCodeDslByIdSync(id, fallbackToFullReplace ? cloneDeep$1(oldSchema) : patched, true, {
+				changeRecords,
+				historyDescription,
+				historySource: "rollback"
+			});
+			return history_default.getStepList("codeBlock", id).slice(-1)[0]?.step ?? null;
+		}
+		this.setCodeDslByIdSync(id, cloneDeep$1(oldSchema), true, {
+			historyDescription,
+			historySource: "rollback"
+		});
+		return history_default.getStepList("codeBlock", id).slice(-1)[0]?.step ?? null;
+	}
+	/**
+	* 把一条历史 step 应用到当前代码块服务上。
+	*
+	* 复用现有的 setCodeDslByIdSync / deleteCodeDslByIds，目的是借助它们发出的事件
+	* 触发 initService 中的 dep target 维护（CODE_BLOCK 的 add / remove）。
+	* 所有写回都带 `doNotPushHistory: true`，确保不会在历史栈里产生新的记录。
+	*
+	* - oldContent=null, newContent≠null：原始为新增 → undo 删除；redo 再次 setCodeDslByIdSync
+	* - oldContent≠null, newContent=null：原始为删除 → undo 还原写入；redo 再次删除
+	* - 两侧都有：原始为更新 → 按 changeRecords 局部 patch；缺省退化为整内容替换
+	*
+	* @param step 历史 step
+	* @param reverse true=撤销，false=重做
+	*/
+	async applyHistoryStep(step, reverse) {
+		const { id } = step.data;
+		const { oldSchema, newSchema, changeRecords } = step.diff?.[0] ?? {};
+		if (!oldSchema && newSchema) {
+			if (reverse) await this.deleteCodeDslByIds([id], { doNotPushHistory: true });
+			else this.setCodeDslByIdSync(id, cloneDeep$1(newSchema), true, { doNotPushHistory: true });
+			return;
+		}
+		if (oldSchema && !newSchema) {
+			if (reverse) this.setCodeDslByIdSync(id, cloneDeep$1(oldSchema), true, { doNotPushHistory: true });
+			else await this.deleteCodeDslByIds([id], { doNotPushHistory: true });
+			return;
+		}
+		if (!oldSchema || !newSchema) return;
+		const sourceForValues = reverse ? oldSchema : newSchema;
+		if (changeRecords?.length) {
+			const current = this.getCodeContentById(id);
+			if (!current) return;
+			const patched = cloneDeep$1(current);
+			let fallbackToFullReplace = false;
+			for (const record of changeRecords) {
+				if (!record.propPath) {
+					fallbackToFullReplace = true;
+					break;
+				}
+				const value = cloneDeep$1(getValueByKeyPath(record.propPath, sourceForValues));
+				setValueByKeyPath(record.propPath, value, patched);
+			}
+			this.setCodeDslByIdSync(id, fallbackToFullReplace ? cloneDeep$1(sourceForValues) : patched, true, {
+				changeRecords,
+				doNotPushHistory: true
+			});
+			return;
+		}
+		this.setCodeDslByIdSync(id, cloneDeep$1(sourceForValues), true, { doNotPushHistory: true });
+	}
 };
 var codeBlock_default = new CodeBlock();
 //#endregion

package/dist/es/services/componentList.js

@@ -1,7 +1,7 @@
-import BaseService_default from "./BaseService.js";
+import BaseService from "./BaseService.js";
 import { shallowReactive } from "vue";
 //#region packages/editor/src/services/componentList.ts
-var ComponentList = class extends BaseService_default {
+var ComponentList = class extends BaseService {
 	state = shallowReactive({ list: [] });
 	constructor() {
 		super([]);