amis-editor 5.2.0 → 5.2.1-beta.19

package/dist/plugin.d.ts

@@ -1,637 +0,0 @@
-/**
- * @file 定义插件的 interface，以及提供一个 BasePlugin 基类，把一些通用的方法放在这。
- */
-import { RegionWrapperProps } from './component/RegionWrapper';
-import { EditorManager } from './manager';
-import { EditorStoreType } from './store/editor';
-import { EditorNodeType } from './store/node';
-import { DNDModeInterface } from './dnd/interface';
-import { EditorDNDManager } from './dnd';
-import React from 'react';
-import { DiffChange } from './util';
-import { RendererAction, RendererEvent } from './event-action';
-import type { RendererConfig } from 'amis-core/lib/factory';
-import type { MenuDivider, MenuItem } from 'amis-ui/lib/components/ContextMenu';
-import type { BaseSchema } from 'amis/lib/Schema';
-/**
- * 区域的定义，容器渲染器都需要定义区域信息。
- */
-export interface RegionConfig {
-    /**
-     * 简单情况，如果区域直接用的 render('region', subSchema)
-     * 这种只需要配置 key 就能简单插入 Region 节点。
-     */
-    key: string;
-    /**
-     * 区域用来显示的名字。
-     */
-    label: string;
-    /**
-     * 区域占位字符，用于提示
-     */
-    placeholder?: string;
-    /**
-     * 对于复杂的控件需要用到这个配置。
-     * 如果配置了，则遍历 react dom 直到目标节点调换成 Region 节点
-     *
-     * 如果没有配置这个，但是又配置了 renderMethod 方法，
-     * 那就直接将 renderMethod 里面返回的 react dom 直接包一层 Region
-     */
-    matchRegion?: (elem: JSX.Element | undefined | null, component: JSX.Element) => boolean;
-    /**
-     * 指定要覆盖哪个方法。
-     */
-    renderMethod?: string;
-    /**
-     * 通常是hack 当前渲染器，单有时候当前渲染器其实是组合的别的渲染器。
-     */
-    rendererName?: string;
-    /**
-     * 当配置 renderMethod 的时候会自动把 Region 插入进去。
-     * 默认是 outter 模式，有时候可能需要配置成 inner，
-     * 比如 renderMethod 为 render 的时候。
-     */
-    insertPosition?: 'outter' | 'inner';
-    /**
-     * 是否为可选容器，如果是可选容器，不会强制自动创建成员
-     */
-    optional?: boolean;
-    /**
-     * 有时候有些包括是需要其他条件的，所以要自己写包裹逻辑。
-     * 比如 Panel 里面的 renderBody
-     */
-    renderMethodOverride?: (regions: Array<RegionConfig>, insertRegion: (component: JSX.Element, dom: JSX.Element, regions: Array<RegionConfig>, info: RendererInfo, manager: EditorManager) => JSX.Element) => Function;
-    /**
-     * 偏好什么类型的组件？比如表单里面，controls 容器偏向表单项。
-     */
-    preferTag?: string;
-    /**
-     * 用来指定用什么组件包裹，默认是 RegionWrapper
-     */
-    wrapper?: React.ComponentType<RegionWrapperProps>;
-    /**
-     * 返回需要添加 data-region 的 dom 节点。
-     */
-    wrapperResolve?: (dom: HTMLElement) => HTMLElement;
-    /**
-     * 当拖入到这个容器时，是否需要修改一下 ghost 结构？
-     */
-    modifyGhost?: (ghost: HTMLElement, schema?: any) => void;
-    /**
-     * dnd 拖拽模式。比如 table 那种需要配置成 position-h
-     */
-    dndMode?: 'default' | 'position-h' | 'position-v' | (new (dnd: EditorDNDManager) => DNDModeInterface);
-    /**
-     * 可以用来判断是否允许拖入当前节点。
-     */
-    accept?: (json: any) => boolean;
-}
-export interface VRendererConfig {
-    /**
-     * 配置了这些会自动创建编辑面板。
-     */
-    panelIcon?: string;
-    panelTitle?: string;
-    /**
-     * @deprecated 用 panelBody 代替
-     */
-    panelControls?: Array<any>;
-    panelDefinitions?: any;
-    /**
-     * 配置面板两端对齐布局
-     */
-    panelJustify?: boolean;
-    /**
-     * @deprecated 用panelBodyCreator 代替
-     */
-    panelControlsCreator?: (context: BaseEventContext) => Array<any>;
-    panelBody?: Array<any>;
-    panelBodyCreator?: (context: BaseEventContext) => Array<any>;
-    /**
-     * 配置了，要是不在 overides 里面使用也是没用的。
-     */
-    regions?: {
-        [propName: string]: RegionConfig;
-    };
-}
-export interface RendererScaffoldInfo {
-    /**
-     * 组件名称
-     */
-    name: string;
-    icon?: string;
-    searchKeywords?: string;
-    description?: string;
-    docLink?: string;
-    previewSchema?: any;
-    tags?: string | Array<string>;
-    type?: string;
-    scaffold?: any;
-}
-/**
- * 渲染器信息。
- */
-export interface RendererInfo extends RendererScaffoldInfo {
-    scaffolds?: Array<Partial<RendererScaffoldInfo>>;
-    rendererName?: string;
-    /**
-     * json schema 协议
-     */
-    $schema?: string;
-    isBaseComponent?: boolean;
-    disabledRendererPlugin?: boolean;
-    /**
-     * 配置区域。
-     */
-    regions?: Array<RegionConfig>;
-    /**
-     * 哪些容器属性需要自动转成数组的。如果不配置默认就从 regions 里面读取。
-     */
-    patchContainers?: Array<string>;
-    /**
-     * 覆盖的目标渲染器名称
-     */
-    overrideTargetRendererName?: string;
-    /**
-     * 覆写某些方法，一般用来插入虚拟的渲染器编辑器。
-     */
-    overrides?: {
-        [propName: string]: Function;
-    };
-    /**
-     * 虚拟渲染器的配置项，有时候需要给那些并不是渲染器的组件添加点选编辑功能。
-     * 比如： Tabs 下面的 Tab, 这个并不是个渲染器，但是需要可以点选修改内容。
-     */
-    vRendererConfig?: VRendererConfig;
-    /**
-     * 默认为 BaseWrapper, 容器类的指定为 BaseContainerWrapper 或者再实现一个
-     * 暂时没有需要配置的所以注释掉。
-     * wrapper?: React.ComponentType<NodeWrapperProps>;
-     *
-     * 返回哪些 dom 节点，需要自动加上 data-editor-id 属性
-     * 目前只有 TableCell 里面用到了，就它需要同时给某一列下所有 td 都加上那个属性。
-     */
-    wrapperResolve?: (dom: HTMLElement) => HTMLElement | Array<HTMLElement>;
-    /**
-     * 默认下发哪些属性，如果要动态下发，请使用 filterProps
-     */
-    wrapperProps?: any;
-    /**
-     * 修改一些属性，一般用来干掉 $$id
-     * 这样它的孩子节点就不能直接点选编辑了，比如 Combo。
-     */
-    filterProps?: (props: any, node: EditorNodeType) => any;
-    /**
-     * 有些没有视图的组件，可以自己输出点内容，否则没办法点选编辑。
-     */
-    renderRenderer?: (props: any, info: RendererInfo) => JSX.Element;
-    /**
-     * 是否有多重身份？
-     * 比如 CRUD 即是 CRUD 又可能是 Table
-     *
-     * 表格的列，即是表格列，也可能是其他文本框。
-     *
-     * 配置了这个后会自动添加多个 Panel 面板来编辑。
-     */
-    multifactor?: boolean;
-    /**
-     * 右键的时候是否出现重新构建，靠这个。
-     */
-    scaffoldForm?: ScaffoldForm;
-    id: string;
-    type: string;
-    plugin: PluginInterface;
-    extraPlugin?: PluginInterface;
-    renderer: RendererConfig;
-    schemaPath: string;
-    editable?: boolean;
-    removable?: boolean;
-    draggable?: boolean;
-    movable?: boolean;
-    replaceable?: boolean;
-    duplicatable?: boolean;
-    memberImmutable?: boolean | Array<string>;
-    typeMutable?: boolean;
-    hostId?: string;
-    memberIndex?: number;
-}
-export declare type BasicRendererInfo = Omit<RendererInfo, 'id' | 'type' | 'plugin' | 'renderer' | 'schemaPath'>;
-export interface PopOverForm {
-    title?: string;
-    /**
-     * 脚手架配置项。
-     */
-    body: Array<any>;
-    /**
-     * @deprecated 改用 body 代替
-     */
-    controls?: Array<any>;
-}
-export interface ScaffoldForm extends PopOverForm {
-    mode?: 'normal' | 'horizontal' | 'inline';
-    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
-    initApi?: any;
-    api?: any;
-    /**
-     * 整体验证脚手架配置，如果有错误返回错误对象。
-     * key 是配置的字段名。
-     * value 是具体错误信息。
-     */
-    validate?: (values: any) => void | {
-        [propName: string]: string;
-    } | Promise<void | {
-        [propName: string]: string;
-    }>;
-    /**
-     * schema 配置转脚手架配置
-     */
-    pipeIn?: (value: any) => any;
-    /**
-     * 脚手架配置转 schema 配置。
-     */
-    pipeOut?: (value: any) => any;
-    /**
-     * 是否允许重新构建；
-     */
-    canRebuild?: boolean;
-}
-/**
- * 子渲染器信息
- */
-export interface SubRendererInfo extends RendererScaffoldInfo {
-    /**
-     * 用于判断是否是平台预置组件，平台预置组件为true。
-     */
-    isBaseComponent?: boolean;
-    rendererName?: string;
-    /**
-     * 首次拖入的时候可以用来配置个表单。
-     */
-    scaffoldForm?: ScaffoldForm;
-    /**
-     * 新增属性，用于判断是否出现在组件面板中，默认为false，为ture则不展示
-     */
-    disabledRendererPlugin?: boolean;
-    plugin: PluginInterface;
-    parent: RendererInfo;
-    id: string;
-    order: number;
-}
-export declare type BasicSubRenderInfo = Omit<SubRendererInfo, 'plugin' | 'parent' | 'id' | 'order'> & Partial<Pick<SubRendererInfo, 'order'>>;
-/**
- * 工具按钮信息。
- */
-export interface ToolbarItem {
-    label?: string;
-    id?: string;
-    order: number;
-    level?: 'primary' | 'secondary' | 'special';
-    className?: string;
-    draggable?: boolean;
-    onDragStart?: (e: any) => void;
-    icon?: string;
-    iconSvg?: string;
-    onClick?: (e: any) => void;
-    tooltip?: string;
-    placement?: 'top' | 'bottom' | 'right' | 'left';
-}
-export declare type BasicToolbarItem = Partial<ToolbarItem>;
-export declare type ContextMenuItem = MenuItem | MenuDivider;
-/**
- * 面板的属性定义
- */
-export interface PanelProps {
-    id?: string;
-    info?: RendererInfo;
-    path?: string;
-    node?: EditorNodeType;
-    value: BaseSchema;
-    onChange: (value: BaseSchema, diff?: Array<DiffChange>) => void;
-    store: EditorStoreType;
-    manager: EditorManager;
-    popOverContainer?: () => HTMLElement | void;
-}
-/**
- * 面板信息定义
- */
-export interface PanelItem {
-    nodeId?: string;
-    key: string;
-    icon: string;
-    title: string | JSX.Element;
-    component?: React.ComponentType<PanelProps | any>;
-    order: number;
-    position?: 'left' | 'right';
-    render?: (props: PanelProps) => JSX.Element;
-    menus?: Array<any>;
-    isNotConfigPanel?: boolean;
-}
-export declare type BasicPanelItem = Omit<PanelItem, 'order'> & Partial<Pick<PanelItem, 'order'>>;
-export interface EventContext {
-    data?: any;
-    [propName: string]: any;
-}
-/**
- * 事件上下文
- */
-export interface BaseEventContext extends EventContext {
-    node: EditorNodeType;
-    id: string;
-    info: RendererInfo;
-    path: string;
-    schema: any;
-    schemaPath: string;
-    secondFactor?: boolean;
-}
-export interface RendererInfoResolveEventContext extends EventContext {
-    renderer: RendererConfig;
-    path: string;
-    schema: any;
-    schemaPath: string;
-    data?: RendererInfo;
-}
-export interface RendererJSONSchemaResolveEventContext extends BaseEventContext {
-    data: string;
-}
-/**
- * 右键菜单事件的上下文。
- */
-export interface ContextMenuEventContext extends BaseEventContext {
-    region: string;
-    selections: Array<BaseEventContext>;
-    data: Array<ContextMenuItem>;
-}
-export interface SelectionEventContext extends BaseEventContext {
-    selections: Array<BaseEventContext>;
-    data: Array<string>;
-}
-export interface RendererEventContext extends BaseEventContext {
-    region?: string;
-}
-export interface ActiveEventContext extends Partial<BaseEventContext> {
-    active?: boolean;
-}
-export interface DeleteEventContext extends BaseEventContext {
-    data?: Array<string>;
-}
-/**
- * 插入节点的事件上下文信息
- */
-export interface InsertEventContext extends BaseEventContext {
-    region: string;
-    beforeId?: string;
-    index: number;
-    data: any;
-    subRenderer?: SubRendererInfo;
-    dragInfo?: {
-        id: string;
-        type: string;
-        data: any;
-    };
-}
-export interface ReplaceEventContext extends BaseEventContext {
-    data: any;
-    subRenderer?: SubRendererInfo;
-    region?: string;
-}
-export interface MoveEventContext extends BaseEventContext {
-    region: string;
-    sourceId: string;
-    beforeId?: string;
-    direction?: 'up' | 'down';
-}
-/**
- * 更新节点的事件上下文
- */
-export interface ChangeEventContext extends BaseEventContext {
-    value: any;
-    readonly diff: Array<DiffChange>;
-}
-export interface DragEventContext extends EventContext {
-    mode: 'move' | 'copy';
-    sourceType: 'schema' | 'subrenderer' | string;
-    sourceId: string;
-    data: any;
-    targetId?: string;
-    targetRegion?: string;
-}
-export interface BuildPanelEventContext extends BaseEventContext {
-    data: Array<BasicPanelItem>;
-    selections: Array<BaseEventContext>;
-}
-export interface PreventClickEventContext extends EventContext {
-    data: MouseEvent;
-}
-export interface ResizeMoveEventContext extends EventContext {
-    data: Object;
-    nativeEvent: MouseEvent;
-    dom: HTMLElement;
-    resizer: HTMLElement;
-    node: EditorNodeType;
-}
-/**
- * 将事件上下文转成事件对象。
- */
-export declare type PluginEvent<T, P = any> = {
-    context: T;
-    type: string;
-    preventDefault: () => void;
-    stopPropagation: () => void;
-    setData: (data: P) => void;
-    prevented?: boolean;
-    stoped?: boolean;
-    pending?: Promise<any>;
-    data?: P;
-};
-export declare type PluginEventFn = (e: PluginEvent<EventContext>) => false | void;
-/**
- * 创建事件。
- * @param type
- * @param context
- */
-export declare function createEvent<T extends EventContext>(type: string, context: T): PluginEvent<T>;
-export interface PluginEventListener {
-    onActive?: (event: PluginEvent<ActiveEventContext>) => void;
-    /**
-     * 事件，当有配置项插入前调用。通过 event.preventDefault() 可以干预。
-     */
-    beforeInsert?: (event: PluginEvent<InsertEventContext>) => false | void;
-    afterInsert?: (event: PluginEvent<InsertEventContext>) => void;
-    /**
-     * 面板里面编辑修改的事件。
-     */
-    beforeUpdate?: (event: PluginEvent<ChangeEventContext>) => false | void;
-    afterUpdate?: (event: PluginEvent<ChangeEventContext>) => void;
-    /**
-     * 更新渲染器，或者右键粘贴配置。
-     */
-    beforeReplace?: (event: PluginEvent<ReplaceEventContext>) => false | void;
-    afterReplace?: (event: PluginEvent<ReplaceEventContext>) => void;
-    /**
-     * 移动节点的时候触发，包括上移，下移
-     */
-    beforeMove?: (event: PluginEvent<MoveEventContext>) => false | void;
-    aftterMove?: (event: PluginEvent<MoveEventContext>) => void;
-    /**
-     * 删除的时候触发
-     */
-    beforeDelete?: (event: PluginEvent<DeleteEventContext>) => false | void;
-    afterDelete?: (event: PluginEvent<DeleteEventContext>) => void;
-    beforeResolveEditorInfo?: (event: PluginEvent<RendererInfoResolveEventContext>) => false | void;
-    afterResolveEditorInfo?: (event: PluginEvent<RendererInfoResolveEventContext>) => void;
-    beforeResolveJsonSchema?: (event: PluginEvent<RendererJSONSchemaResolveEventContext>) => false | void;
-    afterResolveJsonSchema?: (event: PluginEvent<RendererJSONSchemaResolveEventContext>) => void;
-    onDndAccept?: (event: PluginEvent<DragEventContext>) => false | void;
-    onBuildPanels?: (event: PluginEvent<BuildPanelEventContext>) => void;
-    onBuildContextMenus?: (event: PluginEvent<ContextMenuEventContext>) => void;
-    onBuildToolbars?: (event: PluginEvent<BaseEventContext>) => void;
-    onSelectionChange?: (event: PluginEvent<SelectionEventContext>) => void;
-    onPreventClick?: (event: PluginEvent<PreventClickEventContext>) => false | void;
-    onWidthChangeStart?: (event: PluginEvent<ResizeMoveEventContext, {
-        onMove(e: MouseEvent): void;
-        onEnd(e: MouseEvent): void;
-    }>) => void;
-    onHeightChangeStart?: (event: PluginEvent<ResizeMoveEventContext, {
-        onMove(e: MouseEvent): void;
-        onEnd(e: MouseEvent): void;
-    }>) => void;
-    onSizeChangeStart?: (event: PluginEvent<ResizeMoveEventContext, {
-        onMove(e: MouseEvent): void;
-        onEnd(e: MouseEvent): void;
-    }>) => void;
-}
-/**
- * 插件的 interface 定义
- */
-export interface PluginInterface extends Partial<BasicRendererInfo>, Partial<BasicSubRenderInfo>, PluginEventListener {
-    readonly manager: EditorManager;
-    order?: number;
-    /**
-     * 渲染器的名字，关联后不用自己实现 getRendererInfo 了。
-     */
-    rendererName?: string;
-    /**
-     * 默认的配置面板信息
-     */
-    panelIcon?: string;
-    panelTitle?: string;
-    /**
-     * 新增属性，用于判断是否出现在组件面板中，默认为false，为ture则不展示
-     */
-    disabledRendererPlugin?: boolean;
-    /**
-     * @deprecated 用 panelBody
-     */
-    panelControls?: Array<any>;
-    panelBody?: Array<any>;
-    panelDefinitions?: any;
-    panelApi?: any;
-    panelSubmitOnChange?: boolean;
-    /**
-     * 隐藏右侧面板表单项Tab
-     * TODO: 正式上线后要干掉这个属性
-     */
-    notRenderFormZone?: boolean;
-    /**
-     *
-     * 事件定义集合
-     */
-    events?: RendererEvent[];
-    /**
-     *
-     * 专有动作定义集合
-     */
-    actions?: RendererAction[];
-    /**
-     * 右侧面板是否需要两端对齐布局
-     */
-    panelJustify?: boolean;
-    /**
-     * @deprecated 用 panelBodyCreator
-     */
-    panelControlsCreator?: (context: BaseEventContext) => Array<any>;
-    panelBodyCreator?: (context: BaseEventContext) => Array<any>;
-    popOverBody?: Array<any>;
-    popOverBodyCreator?: (context: BaseEventContext) => Array<any>;
-    /**
-     * 返回渲染器信息。不是每个插件都需要。
-     */
-    getRendererInfo?: (context: RendererInfoResolveEventContext) => BasicRendererInfo | void;
-    /**
-     * 生成节点的 JSON Schema 的 uri 地址。
-     */
-    buildJSONSchema?: (context: RendererJSONSchemaResolveEventContext) => void | string;
-    /**
-     * 构建右上角功能按钮集合
-     */
-    buildEditorToolbar?: (context: BaseEventContext, toolbars: Array<BasicToolbarItem>) => void;
-    /**
-     * 构建右键菜单项
-     */
-    buildEditorContextMenu?: (context: ContextMenuEventContext, menus: Array<ContextMenuItem>) => void;
-    /**
-     * 构建编辑器面板。
-     */
-    buildEditorPanel?: (context: BuildPanelEventContext, panels: Array<BasicPanelItem>) => void;
-    /**
-     * 构建子渲染器信息集合。
-     */
-    buildSubRenderers?: (context: RendererEventContext, subRenderers: Array<SubRendererInfo>, renderers: Array<RendererConfig>) => BasicSubRenderInfo | Array<BasicSubRenderInfo> | void;
-    /**
-     * 更新NPM自定义组件分类和排序[异步方法]
-     * 备注：目前主要在npm自定义组件的分类和排序更新中使用
-     */
-    asyncUpdateCustomSubRenderersInfo?: (context: RendererEventContext, subRenderers: Array<SubRendererInfo>, renderers: Array<RendererConfig>) => void;
-    markDom?: (dom: HTMLElement | Array<HTMLElement>, props: any) => void;
-    /**
-     * 获取上下文数据结构
-     *
-     * @param node 当前容器节点
-     * @param region 所属容器节点
-     */
-    buildDataSchemas?: (node: EditorNodeType, region?: EditorNodeType) => any | Promise<any>;
-    rendererBeforeDispatchEvent?: (node: EditorNodeType, e: any, data: any) => void;
-}
-/**
- * 基类，所有插件都继承这个好了，可以少写些逻辑。
- */
-export declare abstract class BasePlugin implements PluginInterface {
-    readonly manager: EditorManager;
-    constructor(manager: EditorManager);
-    /**
-     * 如果配置里面有 rendererName 自动返回渲染器信息。
-     * @param renderer
-     */
-    getRendererInfo({ renderer, schema }: RendererInfoResolveEventContext): BasicRendererInfo | void;
-    /**
-     * 配置了 panelControls 自动生成配置面板
-     * @param context
-     * @param panels
-     */
-    buildEditorPanel(context: BuildPanelEventContext, panels: Array<BasicPanelItem>): void;
-    /**
-     * 默认什么组件都加入的子组件里面，子类里面可以复写这个改变行为。
-     * @param context
-     * @param subRenderers
-     */
-    buildSubRenderers(context: RendererEventContext, subRenderers: Array<SubRendererInfo>, renderers: Array<RendererConfig>): BasicSubRenderInfo | Array<BasicSubRenderInfo> | void;
-    /**
-     * 构建当前选中组件的右键菜单
-     * @param id
-     * @param schema
-     * @param region
-     * @param info
-     * @param menus
-     */
-    buildEditorContextMenu({ id, schema, region, info, selections }: ContextMenuEventContext, menus: Array<ContextMenuItem>): void;
-    buildEditorToolbar({ id, schema, info }: BaseEventContext, toolbars: Array<BasicToolbarItem>): void;
-    renderPlaceholder(text: string, key?: any): React.DetailedReactHTMLElement<{
-        key: any;
-        className: string;
-        children: React.DetailedReactHTMLElement<{
-            className: string;
-            children: string;
-        }, HTMLElement>;
-    }, HTMLElement>;
-    getPlugin(rendererNameOrKlass: string | typeof BasePlugin): PluginInterface | undefined;
-}