523 lines
14 KiB
TypeScript
523 lines
14 KiB
TypeScript
/*
|
||
* Tencent is pleased to support the open source community by making TMagicEditor available.
|
||
*
|
||
* Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
import { reactive, toRaw } from 'vue';
|
||
import { cloneDeep } from 'lodash-es';
|
||
import serialize from 'serialize-javascript';
|
||
|
||
import type { Id, MApp, MComponent, MContainer, MNode, MPage } from '@tmagic/schema';
|
||
import type StageCore from '@tmagic/stage';
|
||
import { getNodePath, isPop } from '@tmagic/utils';
|
||
|
||
import historyService, { StepValue } from '@editor/services/history';
|
||
import propsService from '@editor/services/props';
|
||
import type { AddMNode, EditorNodeInfo, StoreState } from '@editor/type';
|
||
import { LayerOffset, Layout } from '@editor/type';
|
||
import {
|
||
change2Fixed,
|
||
COPY_STORAGE_KEY,
|
||
defaults,
|
||
Fixed2Other,
|
||
getNodeIndex,
|
||
initPosition,
|
||
isFixed,
|
||
setLayout,
|
||
setNewItemId,
|
||
} from '@editor/utils/editor';
|
||
import { log } from '@editor/utils/logger';
|
||
|
||
import BaseService from './BaseService';
|
||
|
||
class Editor extends BaseService {
|
||
private isHistoryStateChange = false;
|
||
|
||
private state = reactive<StoreState>({
|
||
root: null,
|
||
page: null,
|
||
parent: null,
|
||
node: null,
|
||
stage: null,
|
||
modifiedNodeIds: new Map(),
|
||
});
|
||
|
||
constructor() {
|
||
super([
|
||
'getLayout',
|
||
'select',
|
||
'add',
|
||
'remove',
|
||
'update',
|
||
'sort',
|
||
'copy',
|
||
'paste',
|
||
'alignCenter',
|
||
'moveLayer',
|
||
'undo',
|
||
'redo',
|
||
]);
|
||
}
|
||
|
||
/**
|
||
* 设置当前指点节点配置
|
||
* @param name 'root' | 'page' | 'parent' | 'node'
|
||
* @param value MNode
|
||
* @returns MNode
|
||
*/
|
||
public set<T = MNode>(name: keyof StoreState, value: T) {
|
||
this.state[name] = value as any;
|
||
log('store set ', name, ' ', value);
|
||
|
||
if (name === 'root') {
|
||
this.emit('root-change', value);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 获取当前指点节点配置
|
||
* @param name 'root' | 'page' | 'parent' | 'node'
|
||
* @returns MNode
|
||
*/
|
||
public get<T = MNode>(name: keyof StoreState): T {
|
||
return (this.state as any)[name];
|
||
}
|
||
|
||
/**
|
||
* 根据id获取组件、组件的父组件以及组件所属的页面节点
|
||
* @param {number | string} id 组件id
|
||
* @returns {EditorNodeInfo}
|
||
*/
|
||
public getNodeInfo(id: Id): EditorNodeInfo {
|
||
const root = this.get<MApp | null>('root');
|
||
if (!root) return {};
|
||
|
||
if (id === root.id) {
|
||
return { node: root };
|
||
}
|
||
|
||
const path = getNodePath(id, root.items);
|
||
|
||
if (!path.length) return {};
|
||
|
||
path.unshift(root);
|
||
const info: EditorNodeInfo = {};
|
||
|
||
info.node = path[path.length - 1] as MComponent;
|
||
info.parent = path[path.length - 2] as MContainer;
|
||
|
||
path.forEach((item) => {
|
||
if (item.type === 'page') {
|
||
info.page = item as MPage;
|
||
return;
|
||
}
|
||
});
|
||
|
||
return info;
|
||
}
|
||
|
||
/**
|
||
* 根据ID获取指点节点配置
|
||
* @param id 组件ID
|
||
* @returns 组件节点配置
|
||
*/
|
||
public getNodeById(id: Id): MNode | undefined {
|
||
const { node } = this.getNodeInfo(id);
|
||
return node;
|
||
}
|
||
|
||
/**
|
||
* 根据ID获取指点节点的父节点配置
|
||
* @param id 组件ID
|
||
* @returns 指点组件的父节点配置
|
||
*/
|
||
public getParentById(id: Id): MContainer | undefined {
|
||
if (!this.get<MApp | null>('root')) return;
|
||
const { parent } = this.getNodeInfo(id);
|
||
return parent;
|
||
}
|
||
|
||
/**
|
||
* 只有容器拥有布局
|
||
*/
|
||
public async getLayout(node: MNode): Promise<Layout> {
|
||
if (node.layout) {
|
||
return node.layout;
|
||
}
|
||
|
||
// 如果该节点没有设置position，则认为是流式布局，例如获取root的布局时
|
||
if (!node.style?.position) {
|
||
return Layout.RELATIVE;
|
||
}
|
||
|
||
return Layout.ABSOLUTE;
|
||
}
|
||
|
||
/**
|
||
* 选中指点节点（将指点节点设置成当前选中状态）
|
||
* @param config 指点节点配置或者ID
|
||
* @returns 当前选中的节点配置
|
||
*/
|
||
public async select(config: MNode | Id): Promise<MNode> {
|
||
let id: Id;
|
||
if (typeof config === 'string' || typeof config === 'number') {
|
||
id = config;
|
||
} else {
|
||
id = config.id;
|
||
}
|
||
if (!id) {
|
||
throw new Error('没有ID，无法选中');
|
||
}
|
||
|
||
const { node, parent, page } = this.getNodeInfo(id);
|
||
if (!node) throw new Error('获取不到组件信息');
|
||
|
||
this.set('node', node);
|
||
this.set('page', page || null);
|
||
this.set('parent', parent || null);
|
||
|
||
if (page) {
|
||
historyService.changePage(toRaw(page));
|
||
} else {
|
||
historyService.empty();
|
||
}
|
||
|
||
return node;
|
||
}
|
||
|
||
/**
|
||
* 向指点容器添加组件节点
|
||
* @param addConfig 将要添加的组件节点配置
|
||
* @param parent 要添加到的容器组件节点配置，如果不设置，默认为当前选中的组件的父节点
|
||
* @returns 添加后的节点
|
||
*/
|
||
public async add({ type, ...config }: AddMNode, parent?: MContainer | null): Promise<MNode> {
|
||
const curNode = this.get<MContainer>('node');
|
||
|
||
let parentNode: MNode | undefined;
|
||
|
||
if (type === 'page') {
|
||
parentNode = this.get<MApp>('root');
|
||
// 由于支持中间件扩展，在parent参数为undefined时，parent会变成next函数
|
||
} else if (parent && typeof parent !== 'function') {
|
||
parentNode = parent;
|
||
} else if (curNode.items) {
|
||
parentNode = curNode;
|
||
} else {
|
||
parentNode = this.getParentById(curNode.id);
|
||
}
|
||
|
||
if (!parentNode) throw new Error('未找到父元素');
|
||
|
||
const layout = await this.getLayout(parentNode);
|
||
const newNode = initPosition({ ...toRaw(await propsService.getPropsValue(type)), ...config }, layout);
|
||
|
||
if ((parentNode?.type === 'app' || curNode.type === 'app') && newNode.type !== 'page') {
|
||
throw new Error('app下不能添加组件');
|
||
}
|
||
|
||
parentNode?.items?.push(newNode);
|
||
|
||
await this.get<StageCore>('stage')?.add({ config: cloneDeep(newNode), root: cloneDeep(this.get('root')) });
|
||
|
||
await this.select(newNode);
|
||
|
||
this.addModifiedNodeId(newNode.id);
|
||
this.pushHistoryState();
|
||
|
||
return newNode;
|
||
}
|
||
|
||
/**
|
||
* 删除组件
|
||
* @param {Object} node
|
||
* @return {Object} 删除的组件配置
|
||
*/
|
||
public async remove(node: MNode): Promise<MNode | void> {
|
||
if (!node?.id) return;
|
||
|
||
const root = this.get<MApp | null>('root');
|
||
|
||
if (!root) throw new Error('没有root');
|
||
|
||
const { parent, node: curNode } = this.getNodeInfo(node.id);
|
||
|
||
if (!parent || !curNode) throw new Error('找不要删除的节点');
|
||
|
||
const index = getNodeIndex(curNode, parent);
|
||
|
||
if (typeof index !== 'number' || index === -1) throw new Error('找不要删除的节点');
|
||
|
||
parent.items?.splice(index, 1);
|
||
this.get<StageCore>('stage')?.remove({ id: node.id, root: this.get('root') });
|
||
|
||
if (node.type === 'page') {
|
||
await this.select(root.items[0] || root);
|
||
} else {
|
||
await this.select(parent);
|
||
}
|
||
|
||
this.addModifiedNodeId(parent.id);
|
||
this.pushHistoryState();
|
||
|
||
return node;
|
||
}
|
||
|
||
/**
|
||
* 更新节点
|
||
* @param config 新的节点配置，配置中需要有id信息
|
||
* @returns 更新后的节点配置
|
||
*/
|
||
public async update(config: MNode): Promise<MNode> {
|
||
if (!config?.id) throw new Error('没有配置或者配置缺少id值');
|
||
|
||
const info = this.getNodeInfo(config.id);
|
||
|
||
if (!info.node) throw new Error(`获取不到id为${config.id}的节点`);
|
||
|
||
const node = cloneDeep(toRaw(info.node));
|
||
|
||
let newConfig = await this.toggleFixedPosition(toRaw(config), node, this.get<MApp>('root'));
|
||
|
||
defaults(newConfig, node);
|
||
|
||
if (!newConfig.type) throw new Error('配置缺少type值');
|
||
|
||
if (newConfig.type === 'app') {
|
||
this.set('root', newConfig);
|
||
return newConfig;
|
||
}
|
||
|
||
const { parent } = info;
|
||
if (!parent) throw new Error('获取不到父级节点');
|
||
|
||
const parentNodeItems = parent.items;
|
||
const index = getNodeIndex(newConfig, parent);
|
||
|
||
if (!parentNodeItems || typeof index === 'undefined' || index === -1) throw new Error('更新的节点未找到');
|
||
|
||
const newLayout = await this.getLayout(newConfig);
|
||
const layout = await this.getLayout(node);
|
||
if (newLayout !== layout) {
|
||
newConfig = setLayout(newConfig, newLayout);
|
||
}
|
||
|
||
parentNodeItems[index] = newConfig;
|
||
|
||
if (newConfig.id === this.get('node').id) {
|
||
this.set('node', newConfig);
|
||
}
|
||
|
||
this.get<StageCore>('stage')?.update({ config: cloneDeep(newConfig), root: this.get('root') });
|
||
|
||
if (newConfig.type === 'page') {
|
||
this.set('page', newConfig);
|
||
}
|
||
|
||
this.addModifiedNodeId(newConfig.id);
|
||
this.pushHistoryState();
|
||
|
||
return newConfig;
|
||
}
|
||
|
||
/**
|
||
* 将id为id1的组件移动到id为id2的组件位置上，例如：[1,2,3,4] -> sort(1,3) -> [2,1,3,4]
|
||
* @param id1 组件ID
|
||
* @param id2 组件ID
|
||
* @returns void
|
||
*/
|
||
public async sort(id1: Id, id2: Id): Promise<void> {
|
||
const node = this.get<MNode>('node');
|
||
const parent = cloneDeep(toRaw(this.get<MContainer>('parent')));
|
||
const index2 = parent.items.findIndex((node: MNode) => `${node.id}` === `${id2}`);
|
||
// 在 id1 的兄弟组件中若无 id2 则直接 return
|
||
if (index2 < 0) return;
|
||
const index1 = parent.items.findIndex((node: MNode) => `${node.id}` === `${id1}`);
|
||
|
||
parent.items.splice(index2, 0, ...parent.items.splice(index1, 1));
|
||
|
||
await this.update(parent);
|
||
await this.select(node);
|
||
|
||
this.addModifiedNodeId(parent.id);
|
||
this.pushHistoryState();
|
||
}
|
||
|
||
/**
|
||
* 将组将节点配置转化成string，然后存储到localStorage中
|
||
* @param config 组件节点配置
|
||
* @returns 组件节点配置
|
||
*/
|
||
public async copy(config: MNode): Promise<void> {
|
||
globalThis.localStorage.setItem(COPY_STORAGE_KEY, serialize(config));
|
||
}
|
||
|
||
/**
|
||
* 从localStorage中获取节点，然后添加到当前容器中
|
||
* @param position 如果设置，指定组件位置
|
||
* @returns 添加后的组件节点配置
|
||
*/
|
||
public async paste(position: { left?: number; top?: number } = {}): Promise<MNode | void> {
|
||
const configStr = globalThis.localStorage.getItem(COPY_STORAGE_KEY);
|
||
// eslint-disable-next-line prefer-const
|
||
let config: any = {};
|
||
if (!configStr) {
|
||
return;
|
||
}
|
||
|
||
try {
|
||
// eslint-disable-next-line no-eval
|
||
eval(`config = ${configStr}`);
|
||
} catch (e) {
|
||
console.error(e);
|
||
return;
|
||
}
|
||
|
||
setNewItemId(config, this.get('root'));
|
||
if (config.style) {
|
||
config.style = {
|
||
...config.style,
|
||
...position,
|
||
};
|
||
}
|
||
|
||
return await this.add(config);
|
||
}
|
||
|
||
/**
|
||
* 将指点节点设置居中
|
||
* @param config 组件节点配置
|
||
* @returns 当前组件节点配置
|
||
*/
|
||
public async alignCenter(config: MNode): Promise<MNode | void> {
|
||
const parent = this.get<MContainer>('parent');
|
||
const node = this.get<MNode>('node');
|
||
const layout = await this.getLayout(parent);
|
||
if (layout === Layout.RELATIVE) {
|
||
return;
|
||
}
|
||
|
||
if (parent.style?.width && node.style?.width) {
|
||
node.style.left = (parent.style.width - node.style.width) / 2;
|
||
}
|
||
|
||
await this.update(node);
|
||
this.get<StageCore>('stage')?.update({ config: cloneDeep(toRaw(node)), root: this.get('root') });
|
||
this.addModifiedNodeId(config.id);
|
||
this.pushHistoryState();
|
||
|
||
return config;
|
||
}
|
||
|
||
/**
|
||
* 移动当前选中节点位置
|
||
* @param offset 偏移量
|
||
*/
|
||
public async moveLayer(offset: number | LayerOffset): Promise<void> {
|
||
const parent = this.get<MContainer>('parent');
|
||
const node = this.get('node');
|
||
const brothers: MNode[] = parent?.items || [];
|
||
const index = brothers.findIndex((item) => `${item.id}` === `${node?.id}`);
|
||
|
||
if (offset === LayerOffset.BOTTOM) {
|
||
brothers.splice(brothers.length - 1, 0, brothers.splice(index, 1)[0]);
|
||
} else if (offset === LayerOffset.TOP) {
|
||
brothers.splice(0, 0, brothers.splice(index, 1)[0]);
|
||
} else {
|
||
brothers.splice(index + parseInt(`${offset}`, 10), 0, brothers.splice(index, 1)[0]);
|
||
}
|
||
|
||
this.get<StageCore>('stage')?.update({ config: cloneDeep(toRaw(parent)), root: this.get('root') });
|
||
}
|
||
|
||
/**
|
||
* 撤销当前操作
|
||
* @returns 上一次数据
|
||
*/
|
||
public async undo(): Promise<StepValue | null> {
|
||
const value = historyService.undo();
|
||
await this.changeHistoryState(value);
|
||
return value;
|
||
}
|
||
|
||
/**
|
||
* 恢复到下一步
|
||
* @returns 下一步数据
|
||
*/
|
||
public async redo(): Promise<StepValue | null> {
|
||
const value = historyService.redo();
|
||
await this.changeHistoryState(value);
|
||
return value;
|
||
}
|
||
|
||
public destroy() {
|
||
this.removeAllListeners();
|
||
this.set('root', null);
|
||
this.set('node', null);
|
||
this.set('page', null);
|
||
this.set('parent', null);
|
||
}
|
||
|
||
public resetModifiedNodeId() {
|
||
this.get<Map<Id, Id>>('modifiedNodeIds').clear();
|
||
}
|
||
|
||
private addModifiedNodeId(id: Id) {
|
||
if (!this.isHistoryStateChange) {
|
||
this.get<Map<Id, Id>>('modifiedNodeIds').set(id, id);
|
||
}
|
||
}
|
||
|
||
private pushHistoryState() {
|
||
const curNode = cloneDeep(toRaw(this.get('node')));
|
||
if (!this.isHistoryStateChange) {
|
||
historyService.push({
|
||
data: cloneDeep(toRaw(this.get('page'))),
|
||
modifiedNodeIds: this.get<Map<Id, Id>>('modifiedNodeIds'),
|
||
nodeId: curNode.id,
|
||
});
|
||
}
|
||
this.isHistoryStateChange = false;
|
||
}
|
||
|
||
private async changeHistoryState(value: StepValue | null) {
|
||
if (!value) return;
|
||
|
||
this.isHistoryStateChange = true;
|
||
await this.update(value.data);
|
||
this.set('modifiedNodeIds', value.modifiedNodeIds);
|
||
setTimeout(() => value.nodeId && this.select(value.nodeId), 0);
|
||
}
|
||
|
||
private async toggleFixedPosition(dist: MNode, src: MNode, root: MApp) {
|
||
let newConfig = cloneDeep(dist);
|
||
|
||
if (!isPop(src) && newConfig.style?.position) {
|
||
if (isFixed(newConfig) && !isFixed(src)) {
|
||
newConfig = change2Fixed(newConfig, root);
|
||
} else if (!isFixed(newConfig) && isFixed(src)) {
|
||
newConfig = await Fixed2Other(newConfig, root, this.getLayout);
|
||
}
|
||
}
|
||
|
||
return newConfig;
|
||
}
|
||
}
|
||
|
||
export type EditorService = Editor;
|
||
|
||
export default new Editor();
|