amis-editor-core 5.5.0 → 5.6.1

package/lib/manager.d.ts

@@ -26,7 +26,8 @@ export interface PluginClass {
  */
 export declare function autoPreRegisterEditorCustomPlugins(): void;
 /**
- * 注册Editor插件。
+ * 注册Editor插件
+ * 备注: 支持覆盖原有组件，注册新的组件时需配置 priority。
  * @param editor
  */
 export declare function registerEditorPlugin(klass: PluginClass): void;
@@ -45,7 +46,6 @@ export declare function unRegisterEditorPlugin(id: string): void;
 export declare class EditorManager {
     readonly config: EditorManagerConfig;
     readonly store: EditorStoreType;
-    readonly parent?: EditorManager | undefined;
     readonly plugins: Array<PluginInterface>;
     readonly env: RenderOptions;
     toDispose: Array<() => void>;
@@ -58,10 +58,9 @@ export declare class EditorManager {
     readonly pluginEvents: PluginEvents;
     readonly pluginActions: PluginActions;
     dataSchema: DataSchema;
-    readonly isInFrame: boolean;
     /** 变量管理 */
     readonly variableManager: VariableManager;
-    constructor(config: EditorManagerConfig, store: EditorStoreType, parent?: EditorManager | undefined);
+    constructor(config: EditorManagerConfig, store: EditorStoreType);
     normalizeScene(plugins?: Array<PluginClass | [PluginClass, Record<string, any> | (() => Record<string, any>)]>): (PluginClass | [PluginClass, Record<string, any> | (() => Record<string, any>)])[];
     dynamicAddPlugin(pluginName: string): void;
     buildRenderersAndPanels(): void;
@@ -88,6 +87,8 @@ export declare class EditorManager {
             y: number;
             w: number;
             h: number;
+            dialogTitle: string;
+            dialogType: string;
             children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
         } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
             getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -147,6 +148,8 @@ export declare class EditorManager {
                 y: number;
                 w: number;
                 h: number;
+                dialogTitle: string;
+                dialogType: string;
                 children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
             } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -205,6 +208,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }, {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -264,6 +269,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }>>) => Boolean) => {
                 parentId: string;
@@ -287,6 +294,8 @@ export declare class EditorManager {
                 y: number;
                 w: number;
                 h: number;
+                dialogTitle: string;
+                dialogType: string;
                 children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
             } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -345,6 +354,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }, {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -394,6 +405,8 @@ export declare class EditorManager {
                 getData?: (() => any) | undefined;
                 preferTag?: string | undefined;
                 schemaPath?: string | undefined;
+                dialogTitle?: string | undefined;
+                dialogType?: string | undefined;
                 regionInfo?: RegionConfig | undefined;
                 widthMutable?: boolean | undefined;
                 memberIndex?: number | undefined;
@@ -432,6 +445,8 @@ export declare class EditorManager {
             y: import("mobx-state-tree").IType<number | undefined, number, number>;
             w: import("mobx-state-tree").IType<number | undefined, number, number>;
             h: import("mobx-state-tree").IType<number | undefined, number, number>;
+            dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+            dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
             children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
         }, {
             getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -491,6 +506,8 @@ export declare class EditorManager {
                 y: number;
                 w: number;
                 h: number;
+                dialogTitle: string;
+                dialogType: string;
                 children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
             } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -549,6 +566,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }, {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -608,6 +627,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }>>) => Boolean) => {
                 parentId: string;
@@ -631,6 +652,8 @@ export declare class EditorManager {
                 y: number;
                 w: number;
                 h: number;
+                dialogTitle: string;
+                dialogType: string;
                 children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
             } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -689,6 +712,8 @@ export declare class EditorManager {
                 y: import("mobx-state-tree").IType<number | undefined, number, number>;
                 w: import("mobx-state-tree").IType<number | undefined, number, number>;
                 h: import("mobx-state-tree").IType<number | undefined, number, number>;
+                dialogTitle: import("mobx-state-tree").IType<string | undefined, string, string>;
+                dialogType: import("mobx-state-tree").IType<string | undefined, string, string>;
                 children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
             }, {
                 getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
@@ -738,6 +763,8 @@ export declare class EditorManager {
                 getData?: (() => any) | undefined;
                 preferTag?: string | undefined;
                 schemaPath?: string | undefined;
+                dialogTitle?: string | undefined;
+                dialogType?: string | undefined;
                 regionInfo?: RegionConfig | undefined;
                 widthMutable?: boolean | undefined;
                 memberIndex?: number | undefined;
@@ -817,6 +844,10 @@ export declare class EditorManager {
      * 备注：可以根据渲染器ID添加新元素，也可以根据现有schema片段添加新元素
      */
     addElem(rendererIdOrSchema: string | any): Promise<void>;
+    /**
+     * 判断当前节点是否可以添加同级节点
+     */
+    canAppendSiblings(): boolean;
     /**
      * 在当前选中元素追加新的schema
      * 备注：目前主要用在复制&粘贴快捷功能键中
@@ -995,7 +1026,7 @@ export declare class EditorManager {
         formKey?: string;
         pipeIn?: (value: any) => any;
         pipeOut?: (value: any) => any;
-    }): ({ value, onChange, popOverContainer, id, store, node }: import("./plugin").PanelProps) => JSX.Element;
+    }): ({ value, onChange, popOverContainer, id, store, node }: import("./plugin").PanelProps) => import("react").JSX.Element;
     onWidthChangeStart(e: MouseEvent, ctx: {
         dom: HTMLElement;
         node: EditorNodeType;

package/lib/plugin/DataDebug.d.ts

@@ -1,4 +1,6 @@
 import { BaseEventContext, BasePlugin, BasicToolbarItem } from '../plugin';
+import React from 'react';
+export declare const JsonView: React.LazyExoticComponent<React.ComponentType<import("react-json-view").ReactJsonViewProps>>;
 /**
  * 添加调试功能
  */
@@ -11,11 +13,9 @@ export declare class DataDebugPlugin extends BasePlugin {
         name: string;
         asFormItem: boolean;
         className: string;
-        component: ({ value, onChange, readOnly }: {
+        component: ({ value }: {
             value: any;
-            onChange: (value: any) => void;
-            readOnly?: boolean | undefined;
-        }) => JSX.Element;
+        }) => React.JSX.Element;
     };
-    openDebugForm(data: any, callback?: (values: any) => void): Promise<void>;
+    openDebugForm(data: any): Promise<void>;
 }

package/lib/plugin.d.ts

@@ -9,9 +9,10 @@ import { DNDModeInterface } from './dnd/interface';
 import { EditorDNDManager } from './dnd';
 import React from 'react';
 import { DiffChange } from './util';
-import type { RendererConfig } from 'amis-core';
+import type { RendererConfig, Schema } from 'amis-core';
 import type { MenuDivider, MenuItem } from 'amis-ui/lib/components/ContextMenu';
 import type { BaseSchema, SchemaCollection } from 'amis';
+import type { AsyncLayerOptions } from './component/AsyncLayer';
 /**
  * 区域的定义，容器渲染器都需要定义区域信息。
  */
@@ -28,7 +29,7 @@ export interface RegionConfig {
     /**
      * 区域占位字符，用于提示
      */
-    placeholder?: string;
+    placeholder?: string | JSX.Element;
     /**
      * 对于复杂的控件需要用到这个配置。
      * 如果配置了，则遍历 react dom 直到目标节点调换成 Region 节点
@@ -139,6 +140,11 @@ export interface RendererInfo extends RendererScaffoldInfo {
      */
     $schema?: string;
     isBaseComponent?: boolean;
+    /**
+     * 是否列表类型组件，自身没数据但是绑定了数据源里面的数组字段
+     * 子组件需要能获取到单项字段，如list、each、cards
+     */
+    isListComponent?: boolean;
     disabledRendererPlugin?: boolean;
     /**
      * 配置区域。
@@ -217,6 +223,8 @@ export interface RendererInfo extends RendererScaffoldInfo {
     tipName?: string;
     /** 共享上下文 */
     sharedContext?: Record<string, any>;
+    dialogTitle?: string;
+    dialogType?: string;
 }
 export type BasicRendererInfo = Omit<RendererInfo, 'id' | 'type' | 'plugin' | 'renderer' | 'schemaPath'>;
 export interface PopOverForm {
@@ -248,7 +256,7 @@ export interface ScaffoldForm extends PopOverForm {
      * key 是配置的字段名。
      * value 是具体错误信息。
      */
-    validate?: (values: any) => void | {
+    validate?: (values: any, formStore: any) => void | {
         [propName: string]: string;
     } | Promise<void | {
         [propName: string]: string;
@@ -572,15 +580,25 @@ export interface PluginInterface extends Partial<BasicRendererInfo>, Partial<Bas
      * 右侧面板是否需要两端对齐布局
      */
     panelJustify?: boolean;
+    /**
+     * panelBodyAsyncCreator设置后异步加载层的配置项
+     */
+    async?: AsyncLayerOptions;
     /**
      * 有数据域的容器，可以为子组件提供读取的字段绑定页面
      */
     getAvailableContextFields?: (scopeNode: EditorNodeType, target: EditorNodeType, region?: EditorNodeType) => Promise<SchemaCollection | void>;
+    /** 配置面板表单的 pipeOut function */
+    panelFormPipeOut?: (value: any) => any;
     /**
      * @deprecated 用 panelBodyCreator
      */
     panelControlsCreator?: (context: BaseEventContext) => Array<any>;
     panelBodyCreator?: (context: BaseEventContext) => SchemaCollection;
+    /**
+     * 配置面板内容区的异步加载方法，设置后优先级大于panelBodyCreator
+     */
+    panelBodyAsyncCreator?: (context: BaseEventContext) => Promise<SchemaCollection>;
     popOverBody?: Array<any>;
     popOverBodyCreator?: (context: BaseEventContext) => Array<any>;
     /**
@@ -619,9 +637,23 @@ export interface PluginInterface extends Partial<BasicRendererInfo>, Partial<Bas
      * @param node 当前容器节点
      * @param region 所属容器节点
      */
-    buildDataSchemas?: (node: EditorNodeType, region?: EditorNodeType, trigger?: EditorNodeType) => any | Promise<any>;
+    buildDataSchemas?: (node: EditorNodeType, region?: EditorNodeType, trigger?: EditorNodeType, parent?: EditorNodeType) => any | Promise<any>;
     rendererBeforeDispatchEvent?: (node: EditorNodeType, e: any, data: any) => void;
+    /**
+     * 给 schema 打补丁，纠正一下 schema 配置。
+     * @param schema
+     * @param renderer
+     * @param props
+     * @returns
+     */
+    patchSchema?: (schema: Schema, renderer: RendererConfig, props?: any) => Schema | void;
     dispose?: () => void;
+    /**
+     * 组件 ref 回调，mount 和 unmount 的时候都会调用
+     * @param ref
+     * @returns
+     */
+    componentRef?: (node: EditorNodeType, ref: any) => void;
 }
 export interface RendererPluginEvent {
     eventName: string;
@@ -687,6 +719,7 @@ export declare abstract class BasePlugin implements PluginInterface {
         }, HTMLElement>;
     }, HTMLElement>;
     getPlugin(rendererNameOrKlass: string | typeof BasePlugin): PluginInterface | undefined;
+    buildDataSchemas(node: EditorNodeType, region?: EditorNodeType, trigger?: EditorNodeType, parent?: EditorNodeType): any;
 }
 /**
  * 布局相关组件基类，带宽高可拖拽功能。