@tmagic/editor 1.4.15 → 1.5.0-beta.0

package/types/services/editor.d.ts

@@ -1,180 +0,0 @@
-import { Writable } from 'type-fest';
-import { type TargetOptions } from '@tmagic/dep';
-import type { Id, MContainer, MNode, MPage, MPageFragment } from '@tmagic/schema';
-import BaseService from '../services/BaseService';
-import type { AddMNode, AsyncHookPlugin, EditorNodeInfo, PastePosition, StepValue, StoreState, StoreStateKey } from '../type';
-import { LayerOffset, Layout } from '../type';
-export interface EditorEvents {
-    'root-change': [value: StoreState['root'], preValue?: StoreState['root']];
-    select: [node: MNode | null];
-    add: [nodes: MNode[]];
-    remove: [nodes: MNode[]];
-    update: [nodes: MNode[]];
-    'move-layer': [offset: number | LayerOffset];
-    'drag-to': [data: {
-        targetIndex: number;
-        configs: MNode | MNode[];
-        targetParent: MContainer;
-    }];
-    'history-change': [data: MPage | MPageFragment];
-}
-declare const canUsePluginMethods: {
-    async: readonly ["getLayout", "highlight", "select", "multiSelect", "doAdd", "add", "doRemove", "remove", "doUpdate", "update", "sort", "copy", "paste", "doPaste", "doAlignCenter", "alignCenter", "moveLayer", "moveToContainer", "dragTo", "undo", "redo", "move"];
-    sync: never[];
-};
-type AsyncMethodName = Writable<(typeof canUsePluginMethods)['async']>;
-declare class Editor extends BaseService {
-    state: StoreState;
-    private isHistoryStateChange;
-    constructor();
-    /**
-     * 设置当前指点节点配置
-     * @param name 'root' | 'page' | 'parent' | 'node' | 'highlightNode' | 'nodes' | 'stage' | 'modifiedNodeIds' | 'pageLength' | 'pageFragmentLength
-     * @param value MNode
-     */
-    set<K extends StoreStateKey, T extends StoreState[K]>(name: K, value: T): void;
-    /**
-     * 获取当前指点节点配置
-     * @param name  'root' | 'page' | 'parent' | 'node' | 'highlightNode' | 'nodes' | 'stage' | 'modifiedNodeIds' | 'pageLength' | 'pageFragmentLength'
-     * @returns MNode
-     */
-    get<K extends StoreStateKey>(name: K): StoreState[K];
-    /**
-     * 根据id获取组件、组件的父组件以及组件所属的页面节点
-     * @param {number | string} id 组件id
-     * @param {boolean} raw 是否使用toRaw
-     * @returns {EditorNodeInfo}
-     */
-    getNodeInfo(id: Id, raw?: boolean): EditorNodeInfo;
-    /**
-     * 根据ID获取指点节点配置
-     * @param id 组件ID
-     * @param {boolean} raw 是否使用toRaw
-     * @returns 组件节点配置
-     */
-    getNodeById(id: Id, raw?: boolean): MNode | null;
-    /**
-     * 根据ID获取指点节点的父节点配置
-     * @param id 组件ID
-     * @param {boolean} raw 是否使用toRaw
-     * @returns 指点组件的父节点配置
-     */
-    getParentById(id: Id, raw?: boolean): MContainer | null;
-    /**
-     * 只有容器拥有布局
-     */
-    getLayout(parent: MNode, node?: MNode | null): Promise<Layout>;
-    /**
-     * 选中指定节点（将指定节点设置成当前选中状态）
-     * @param config 指定节点配置或者ID
-     * @returns 当前选中的节点配置
-     */
-    select(config: MNode | Id): Promise<MNode> | never;
-    selectNextNode(): Promise<MNode | null> | never;
-    selectNextPage(): Promise<MNode> | never;
-    /**
-     * 高亮指定节点
-     * @param config 指定节点配置或者ID
-     * @returns 当前高亮的节点配置
-     */
-    highlight(config: MNode | Id): void;
-    /**
-     * 多选
-     * @param ids 指定节点ID
-     * @returns 加入多选的节点配置
-     */
-    multiSelect(ids: Id[]): void;
-    selectRoot(): void;
-    doAdd(node: MNode, parent: MContainer): Promise<MNode>;
-    /**
-     * 向指点容器添加组件节点
-     * @param addConfig 将要添加的组件节点配置
-     * @param parent 要添加到的容器组件节点配置，如果不设置，默认为当前选中的组件的父节点
-     * @returns 添加后的节点
-     */
-    add(addNode: AddMNode | MNode[], parent?: MContainer | null): Promise<MNode | MNode[]>;
-    doRemove(node: MNode): Promise<void>;
-    /**
-     * 删除组件
-     * @param {Object} node
-     */
-    remove(nodeOrNodeList: MNode | MNode[]): Promise<void>;
-    doUpdate(config: MNode): Promise<MNode>;
-    /**
-     * 更新节点
-     * @param config 新的节点配置，配置中需要有id信息
-     * @returns 更新后的节点配置
-     */
-    update(config: MNode | MNode[]): Promise<MNode | MNode[]>;
-    /**
-     * 将id为id1的组件移动到id为id2的组件位置上，例如：[1,2,3,4] -> sort(1,3) -> [2,1,3,4]
-     * @param id1 组件ID
-     * @param id2 组件ID
-     * @returns void
-     */
-    sort(id1: Id, id2: Id): Promise<void>;
-    /**
-     * 将组件节点配置存储到localStorage中
-     * @param config 组件节点配置
-     * @returns
-     */
-    copy(config: MNode | MNode[]): void;
-    /**
-     * 复制时会带上组件关联的依赖
-     * @param config 组件节点配置
-     * @returns
-     */
-    copyWithRelated(config: MNode | MNode[], collectorOptions?: TargetOptions): void;
-    /**
-     * 从localStorage中获取节点，然后添加到当前容器中
-     * @param position 粘贴的坐标
-     * @returns 添加后的组件节点配置
-     */
-    paste(position?: PastePosition, collectorOptions?: TargetOptions): Promise<MNode | MNode[] | void>;
-    doPaste(config: MNode[], position?: PastePosition): Promise<MNode[]>;
-    doAlignCenter(config: MNode): Promise<MNode>;
-    /**
-     * 将指点节点设置居中
-     * @param config 组件节点配置
-     * @returns 当前组件节点配置
-     */
-    alignCenter(config: MNode | MNode[]): Promise<MNode | MNode[]>;
-    /**
-     * 移动当前选中节点位置
-     * @param offset 偏移量
-     */
-    moveLayer(offset: number | LayerOffset): Promise<void>;
-    /**
-     * 移动到指定容器中
-     * @param config 需要移动的节点
-     * @param targetId 容器ID
-     */
-    moveToContainer(config: MNode, targetId: Id): Promise<MNode | undefined>;
-    dragTo(config: MNode | MNode[], targetParent: MContainer, targetIndex: number): Promise<void>;
-    /**
-     * 撤销当前操作
-     * @returns 上一次数据
-     */
-    undo(): Promise<StepValue | null>;
-    /**
-     * 恢复到下一步
-     * @returns 下一步数据
-     */
-    redo(): Promise<StepValue | null>;
-    move(left: number, top: number): Promise<void>;
-    resetState(): void;
-    destroy(): void;
-    resetModifiedNodeId(): void;
-    usePlugin(options: AsyncHookPlugin<AsyncMethodName, Editor>): void;
-    on<Name extends keyof EditorEvents, Param extends EditorEvents[Name]>(eventName: Name, listener: (...args: Param) => void | Promise<void>): this;
-    once<Name extends keyof EditorEvents, Param extends EditorEvents[Name]>(eventName: Name, listener: (...args: Param) => void | Promise<void>): this;
-    emit<Name extends keyof EditorEvents, Param extends EditorEvents[Name]>(eventName: Name, ...args: Param): boolean;
-    private addModifiedNodeId;
-    private pushHistoryState;
-    private changeHistoryState;
-    private toggleFixedPosition;
-    private selectedConfigExceptionHandler;
-}
-export type EditorService = Editor;
-declare const _default: Editor;
-export default _default;

package/types/services/events.d.ts

@@ -1,18 +0,0 @@
-import { EventOption } from '@tmagic/core';
-import type { ComponentGroup } from '../type';
-import BaseService from './BaseService';
-declare class Events extends BaseService {
-    constructor();
-    init(componentGroupList: ComponentGroup[]): void;
-    setEvents(events: Record<string, EventOption[]>): void;
-    setEvent(type: string, events: EventOption[]): void;
-    getEvent(type: string): EventOption[];
-    setMethods(methods: Record<string, EventOption[]>): void;
-    setMethod(type: string, method: EventOption[]): void;
-    getMethod(type: string): EventOption[];
-    resetState(): void;
-    destroy(): void;
-}
-export type EventsService = Events;
-declare const _default: Events;
-export default _default;

package/types/services/history.d.ts

@@ -1,26 +0,0 @@
-import type { MPage, MPageFragment } from '@tmagic/schema';
-import type { StepValue } from '../type';
-import { UndoRedo } from '../utils/undo-redo';
-import BaseService from './BaseService';
-declare class History extends BaseService {
-    state: {
-        pageId?: import("@tmagic/schema").Id | undefined;
-        pageSteps: Record<import("@tmagic/schema").Id, UndoRedo<StepValue>>;
-        canRedo: boolean;
-        canUndo: boolean;
-    };
-    constructor();
-    reset(): void;
-    resetPage(): void;
-    changePage(page: MPage | MPageFragment): void;
-    resetState(): void;
-    push(state: StepValue): StepValue | null;
-    undo(): StepValue | null;
-    redo(): StepValue | null;
-    destroy(): void;
-    private getUndoRedo;
-    private setCanUndoRedo;
-}
-export type HistoryService = History;
-declare const _default: History;
-export default _default;

package/types/services/keybinding.d.ts

@@ -1,40 +0,0 @@
-import { KeyBindingItem } from '../type';
-import BaseService from './BaseService';
-declare class Keybinding extends BaseService {
-    ctrlKey: string;
-    private controllers;
-    private bindingList;
-    private commands;
-    registerCommand(command: string, handler: (e: KeyboardEvent) => void | Promise<void>): void;
-    /**
-     * @deprecated
-     */
-    registeCommand(command: string, handler: (e: KeyboardEvent) => void | Promise<void>): void;
-    unregisterCommand(command: string): void;
-    /**
-     * @deprecated
-     */
-    unregisteCommand(command: string): void;
-    registerEl(name: string, el?: HTMLElement): void;
-    /**
-     * @deprecated
-     */
-    registeEl(name: string, el?: HTMLElement): void;
-    unregisterEl(name: string): void;
-    /**
-     * @deprecated
-     */
-    unregisteEl(name: string): void;
-    register(maps: KeyBindingItem[]): void;
-    /**
-     * @deprecated
-     */
-    registe(map: KeyBindingItem[]): void;
-    reset(): void;
-    destroy(): void;
-    private bind;
-    private getKeyconKeys;
-}
-export type KeybindingService = Keybinding;
-declare const _default: Keybinding;
-export default _default;

package/types/services/props.d.ts

@@ -1,92 +0,0 @@
-import { Writable } from 'type-fest';
-import { type TargetOptions } from '@tmagic/dep';
-import type { FormConfig } from '@tmagic/form';
-import type { MNode } from '@tmagic/schema';
-import type { AsyncHookPlugin, PropsFormConfigFunction, PropsFormValueFunction, SyncHookPlugin } from '../type';
-import BaseService from './BaseService';
-declare const canUsePluginMethods: {
-    async: readonly ["setPropsConfig", "getPropsConfig", "setPropsValue", "getPropsValue", "fillConfig", "getDefaultPropsValue"];
-    sync: readonly ["createId", "setNewItemId"];
-};
-type AsyncMethodName = Writable<(typeof canUsePluginMethods)['async']>;
-type SyncMethodName = Writable<(typeof canUsePluginMethods)['sync']>;
-declare class Props extends BaseService {
-    private state;
-    constructor();
-    setPropsConfigs(configs: Record<string, FormConfig | PropsFormConfigFunction>): void;
-    fillConfig(config: FormConfig, labelWidth?: string): Promise<FormConfig>;
-    setPropsConfig(type: string, config: FormConfig | PropsFormConfigFunction): Promise<void>;
-    /**
-     * 获取指点类型的组件属性表单配置
-     * @param type 组件类型
-     * @returns 组件属性表单配置
-     */
-    getPropsConfig(type: string): Promise<FormConfig>;
-    setPropsValues(values: Record<string, Partial<MNode> | PropsFormValueFunction>): void;
-    /**
-     * 为指点类型组件设置组件初始值
-     * @param type 组件类型
-     * @param value 组件初始值
-     */
-    setPropsValue(type: string, value: Partial<MNode> | PropsFormValueFunction): Promise<void>;
-    /**
-     * 获取指定类型的组件初始值
-     * @param type 组件类型
-     * @returns 组件初始值
-     */
-    getPropsValue(componentType: string, { inputEvent, ...defaultValue }?: Record<string, any>): Promise<any>;
-    createId(type: string | number): string;
-    /**
-     * 将组件与组件的子元素配置中的id都设置成一个新的ID
-     * 如果没有相同ID并且force为false则保持不变
-     * @param {Object} config 组件配置
-     * @param {Boolean} force 是否强制设置新的ID
-     */
-    setNewItemId(config: MNode, force?: boolean): MNode;
-    /**
-     * 获取默认属性配置
-     * @param type 组件类型
-     * @returns Object
-     */
-    getDefaultPropsValue(type: string): {
-        type: string;
-        layout: string;
-        style: {};
-        name: string;
-        items: never[];
-    } | {
-        type: string;
-        style: {};
-        name: string;
-        layout?: undefined;
-        items?: undefined;
-    };
-    resetState(): void;
-    /**
-     * 替换关联ID
-     * @param originConfigs 原组件配置
-     * @param targetConfigs 待替换的组件配置
-     */
-    replaceRelateId(originConfigs: MNode[], targetConfigs: MNode[], collectorOptions: TargetOptions): void;
-    /**
-     * 清除setNewItemId前后映射关系
-     */
-    clearRelateId(): void;
-    destroy(): void;
-    usePlugin(options: AsyncHookPlugin<AsyncMethodName, Props> & SyncHookPlugin<SyncMethodName, Props>): void;
-    /**
-     * 获取setNewItemId前后映射关系
-     * @param oldId 原组件ID
-     * @returns 新旧ID映射
-     */
-    private getRelateIdMap;
-    /**
-     * 记录setNewItemId前后映射关系
-     * @param oldId 原组件ID
-     * @param newId 分配的新ID
-     */
-    private setRelateId;
-}
-export type PropsService = Props;
-declare const _default: Props;
-export default _default;

package/types/services/stageOverlay.d.ts

@@ -1,30 +0,0 @@
-import type { Writable } from 'type-fest';
-import StageCore from '@tmagic/stage';
-import BaseService from '../services/BaseService';
-import type { StageOptions, StageOverlayState, SyncHookPlugin } from '../type';
-declare const canUsePluginMethods: {
-    async: never[];
-    sync: readonly ["openOverlay", "closeOverlay", "updateOverlay", "createStage"];
-};
-type SyncMethodName = Writable<(typeof canUsePluginMethods)['sync']>;
-declare class StageOverlay extends BaseService {
-    private state;
-    constructor();
-    get<K extends keyof StageOverlayState>(name: K): StageOverlayState[K];
-    set<K extends keyof StageOverlayState, T extends StageOverlayState[K]>(name: K, value: T): void;
-    openOverlay(el: HTMLElement | null): void;
-    closeOverlay(): void;
-    updateOverlay(): void;
-    createStage(stageOptions?: StageOptions): StageCore;
-    usePlugin(options: SyncHookPlugin<SyncMethodName, StageOverlay>): void;
-    private createContentEl;
-    private copyDocumentElement;
-    private render;
-    private updateHandler;
-    private addHandler;
-    private removeHandler;
-    private updateSelectStatus;
-}
-export type StageOverlayService = StageOverlay;
-declare const _default: StageOverlay;
-export default _default;

package/types/services/storage.d.ts

@@ -1,65 +0,0 @@
-import type { Writable } from 'type-fest';
-import type { SyncHookPlugin } from '../type';
-import BaseService from './BaseService';
-interface Options {
-    namespace?: string;
-    protocol?: Protocol;
-}
-export declare enum Protocol {
-    OBJECT = "object",
-    JSON = "json",
-    STRING = "string",
-    NUMBER = "number",
-    BOOLEAN = "boolean"
-}
-declare const canUsePluginMethods: {
-    async: never[];
-    sync: readonly ["getStorage", "getNamespace", "clear", "getItem", "removeItem", "setItem"];
-};
-type SyncMethodName = Writable<(typeof canUsePluginMethods)['sync']>;
-/**
- * 数据存储服务
- */
-export declare class WebStorage extends BaseService {
-    private storage;
-    private namespace;
-    constructor();
-    /**
-     * 获取数据存储对象，可以通过
-     * const storageService = new StorageService();
-     * storageService.usePlugin({
-     *    // 替换存储对象为 sessionStorage
-     *    async afterGetStorage(): Promise<Storage> {
-     *      return window.sessionStorage;
-     *    },
-     * });
-     */
-    getStorage(): Storage;
-    getNamespace(): string;
-    /**
-     * 清理，支持storageService.usePlugin
-     */
-    clear(): void;
-    /**
-     * 获取存储项，支持storageService.usePlugin
-     */
-    getItem(key: string, options?: Options): any;
-    /**
-     * 获取指定索引位置的key
-     */
-    key(index: number): string | null;
-    /**
-     * 移除存储项，支持storageService.usePlugin
-     */
-    removeItem(key: string, options?: Options): void;
-    /**
-     * 设置存储项，支持storageService.usePlugin
-     */
-    setItem(key: string, value: any, options?: Options): void;
-    destroy(): void;
-    usePlugin(options: SyncHookPlugin<SyncMethodName, WebStorage>): void;
-    private getValueAndProtocol;
-}
-export type StorageService = WebStorage;
-declare const _default: WebStorage;
-export default _default;

package/types/services/ui.d.ts

@@ -1,77 +0,0 @@
-import type { Writable } from 'type-fest';
-import type { AsyncHookPlugin, UiState } from '../type';
-import BaseService from './BaseService';
-declare const canUsePluginMethods: {
-    async: readonly ["zoom", "calcZoom"];
-    sync: readonly [];
-};
-type AsyncMethodName = Writable<(typeof canUsePluginMethods)['async']>;
-declare class Ui extends BaseService {
-    constructor();
-    set<K extends keyof UiState, T extends UiState[K]>(name: K, value: T): void;
-    get<K extends keyof UiState>(name: K): {
-        uiSelectMode: boolean;
-        showSrc: boolean;
-        zoom: number;
-        stageContainerRect: {
-            width: number;
-            height: number;
-        };
-        stageRect: {
-            width: string | number;
-            height: string | number;
-        };
-        columnWidth: {
-            left: number;
-            center: number;
-            right: number;
-        };
-        showGuides: boolean;
-        showRule: boolean;
-        propsPanelSize: "default" | "small" | "large";
-        showAddPageButton: boolean;
-        showPageListButton: boolean;
-        hideSlideBar: boolean;
-        sideBarItems: {
-            [x: string]: any;
-            text: string;
-            tabStyle?: string | Record<string, any> | undefined;
-            icon?: any;
-            $key: string;
-            draggable?: boolean | undefined;
-            beforeClick?: ((config: import("../type").SideComponent) => boolean | Promise<boolean>) | undefined;
-            boxComponentConfig?: {
-                component?: any;
-                props?: Record<string, any> | undefined;
-            } | undefined;
-            type: "component";
-            component: any;
-            props?: Record<string, any> | undefined;
-            listeners?: Record<string, Function> | undefined;
-            slots?: Record<string, any> | undefined;
-            className?: string | undefined;
-            display?: boolean | ((data?: import("../type").Services | undefined) => boolean | Promise<boolean>) | undefined;
-        }[];
-        navMenuRect: {
-            left: number;
-            top: number;
-            width: number;
-            height: number;
-        };
-        frameworkRect: {
-            left: number;
-            top: number;
-            width: number;
-            height: number;
-        };
-    }[K];
-    zoom(zoom: number): Promise<void>;
-    calcZoom(): Promise<number>;
-    resetState(): void;
-    destroy(): void;
-    usePlugin(options: AsyncHookPlugin<AsyncMethodName, Ui>): void;
-    private setStageRect;
-}
-export type UiService = Ui;
-declare const _default: Ui;
-export default _default;