From 1a2f82154b328eeaacb35adf5a6a942d32fe71da Mon Sep 17 00:00:00 2001
From: "humphry.hy" <humphry.hy@alibaba-inc.com>
Date: Mon, 13 Dec 2021 17:33:45 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E8=A1=A5=E5=85=85=E6=96=87=E6=A1=A3?=
 =?UTF-8?q?=E5=AE=9A=E4=B9=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 packages/types/src/assets.ts       | 36 ++++++++++++++++++++++--------
 packages/types/src/field-config.ts |  8 ++-----
 packages/types/src/metadata.ts     |  7 +++---
 3 files changed, 32 insertions(+), 19 deletions(-)

diff --git a/packages/types/src/assets.ts b/packages/types/src/assets.ts
index 082e85cf7..abd963d67 100644
--- a/packages/types/src/assets.ts
+++ b/packages/types/src/assets.ts
@@ -3,7 +3,7 @@ import { PropConfig } from './prop-config';
 import { Snippet, ComponentMetadata } from './metadata';
 
 /**
- * 应该被编辑器默认加载，定义组件大包及external资源的信息
+ * 定义组件大包及external资源的信息，应该被编辑器默认加载
  */
 export interface Package {
   /**
@@ -27,11 +27,11 @@ export interface Package {
    */
   library: string;
   /**
-   * 待补充文档
+   * todo 待补充文档
    */
   async?: boolean;
   /**
-   * 待补充文档
+   * 组件描述导出名字，可以通过 window[exportName] 获取到组件描述的 Object 内容；
    */
   exportName?: string;
 }
@@ -71,9 +71,21 @@ export interface ComponentItem {
    */
   icon?: string;
   /**
-   * 待补充文档
+   * 可用片段
    */
   snippets?: Snippet[];
+  /**
+   * 一级分组
+   */
+  group?: string;
+  /**
+   * 二级分组
+   */
+  category?: string;
+  /**
+   * 组件优先级排序
+   */
+  priority?: number;
 }
 
 /**
@@ -81,7 +93,7 @@ export interface ComponentItem {
  */
 export interface ComponentDescription extends ComponentMetadata {
   /**
-   * 待补充文档
+   * todo 待补充文档
    */
   keywords: string[];
 }
@@ -91,11 +103,17 @@ export interface ComponentDescription extends ComponentMetadata {
  */
 export interface RemoteComponentDescription {
   /**
-   * 待补充文档
+   * 组件描述导出名字，可以通过 window[exportName] 获取到组件描述的 Object 内容；
    */
-  exportName: string;
+  exportName?: string;
   /**
-   * 待补充文档
+   * 组件描述的资源链接；
    */
-  url: string;
+  url?: string;
+  /**
+   * 组件(库)的 npm 信息；
+   */
+  package?: {
+    npm?: string;
+  };
 }
diff --git a/packages/types/src/field-config.ts b/packages/types/src/field-config.ts
index 1474cb54b..c193a8ff0 100644
--- a/packages/types/src/field-config.ts
+++ b/packages/types/src/field-config.ts
@@ -52,10 +52,6 @@ export interface FieldExtraProps {
   display?: 'accordion' | 'inline' | 'block' | 'plain' | 'popup' | 'entry';
   // todo 这个 omit 是否合理？
   liveTextEditing?: Omit<LiveTextEditingConfig, 'propTarget'>;
-  /**
-   * 待文档定义
-   */
-  onChange?: (value: any, field: SettingTarget) => void;
 }
 
 export interface FieldConfig extends FieldExtraProps {
@@ -82,11 +78,11 @@ export interface FieldConfig extends FieldExtraProps {
    */
   extraProps?: FieldExtraProps;
   /**
-   * 待文档定义
+   * todo 待补充文档
    */
   description?: TitleContent;
   /**
-   * 待文档定义
+   * todo 待补充文档
    */
   isExtends?: boolean;
 }
diff --git a/packages/types/src/metadata.ts b/packages/types/src/metadata.ts
index d8fa1c18c..75164872a 100644
--- a/packages/types/src/metadata.ts
+++ b/packages/types/src/metadata.ts
@@ -120,15 +120,16 @@ export interface Experimental {
  */
 export interface LiveTextEditingConfig {
   /**
-   * 待补充文档
+   * todo 待补充文档
    */
   propTarget: string;
   /**
-   * 待补充文档
+   * todo 待补充文档
    */
   selector?: string;
   /**
    * 编辑模式 纯文本|段落编辑|文章编辑（默认纯文本，无跟随工具条）
+   * @default 'plaintext'
    */
   mode?: 'plaintext' | 'paragraph' | 'article';
   /**
@@ -247,8 +248,6 @@ export interface Callbacks {
   /**
    * hooks
    */
-
-
   onMouseDownHook?: (e: MouseEvent, currentNode: any) => any;
   onDblClickHook?: (e: MouseEvent, currentNode: any) => any;
   onClickHook?: (e: MouseEvent, currentNode: any) => any;