@lark-project/js-sdk 2.0.1-alpha.2 → 2.0.1-alpha.20

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 # Change Log
+## 2.0.6 (2024/09/12)
+- 「Add」新增 Fullscreen Modal
+
+## 2.0.5 (2024/08/13)
+- 「Add」新增 Button Context
+
+## 2.0.4（2024/08/06）
+- 「Add」新增 WorkItemFinder
+
+## 2.0.3（2024/07/22）
+- 「Add」新增 Control Context
+- 「Add」新增 NotSupportedError
+
+## 2.0.2（2024/07/11）
+- 「Add」新增 ContainerModal
+- 「Add」新增 Intercept
+
+## 2.0.1（2024/05/22）
+- 「Add」新增 RichTextEditor
+
 ## 2.0.0（2024/03/27）
 - 「Add」新增 Modal / ActionSheet（mobile）/ Utils
 

package/dist/es/index.js

@@ -260,9 +260,9 @@ _a12 = IMPL_KEY;
  */
 RichTextEditor[_a12] = "richTextEditor";
 
-// src/biz/Utils.ts
+// src/biz/WorkItemFinder.ts
 var _a13;
-var Utils = class extends BaseModel {
+var WorkItemFinder = class extends BaseModel {
   /**
    * @internal
    */
@@ -274,7 +274,87 @@ _a13 = IMPL_KEY;
 /**
  * @internal
  */
-Utils[_a13] = "utils";
+WorkItemFinder[_a13] = "workItemFinder";
+
+// src/biz/Utils.ts
+var _a14;
+var Utils = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a14 = IMPL_KEY;
+/**
+ * @internal
+ */
+Utils[_a14] = "utils";
+
+// src/features/ContainerModal.ts
+var _a15;
+var ContainerModal = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a15 = IMPL_KEY;
+/**
+ * @internal
+ */
+ContainerModal[_a15] = "ContainerModal";
+
+// src/features/Intercept.ts
+var _a16;
+var Intercept = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a16 = IMPL_KEY;
+/**
+ * @internal
+ */
+Intercept[_a16] = "Intercept";
+
+// src/features/Control.ts
+var _a17;
+var Control = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a17 = IMPL_KEY;
+/**
+ * @internal
+ */
+Control[_a17] = "Control";
+
+// src/features/Button.ts
+var _a18;
+var Button = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a18 = IMPL_KEY;
+/**
+ * @internal
+ */
+Button[_a18] = "Button";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -284,6 +364,34 @@ function getImplValue(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
 }
 var _SDKClient = class {
+  /**
+   * 插件容器模态框
+   * only 2.0
+   */
+  get containerModal() {
+    return getImplValue(ContainerModal, this._meegoBizHub);
+  }
+  /**
+   * 拦截事件点位容器特有能力
+   * only 2.0
+   */
+  get intercept() {
+    return getImplValue(Intercept, this._meegoBizHub);
+  }
+  /**
+   * 控件点位容器特有能力
+   * only 2.0
+   */
+  get control() {
+    return getImplValue(Control, this._meegoBizHub);
+  }
+  /**
+   * 按钮点位容器特有能力
+   * only 2.0
+   */
+  get button() {
+    return getImplValue(Button, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -310,10 +418,18 @@ var _SDKClient = class {
   }
   /**
    * 富文本编辑器
+   * only 2.0
    */
   get richTextEditor() {
     return getImplValue(RichTextEditor, this._meegoBizHub);
   }
+  /**
+   * 工作项实例筛选器
+   * only web 2.0
+   */
+  get workItemFinder() {
+    return getImplValue(WorkItemFinder, this._meegoBizHub);
+  }
   /**
    * 模态框
    */
@@ -322,6 +438,7 @@ var _SDKClient = class {
   }
   /**
    * 操作菜单
+   * only mobile 2.0
    */
   get actionSheet() {
     return getImplValue(ActionSheet, this._meegoBizHub);
@@ -388,7 +505,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.2";
+SDKClient.version = "2.0.1-alpha.20";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -441,23 +558,23 @@ var ButtonScene = /* @__PURE__ */ ((ButtonScene2) => {
   ButtonScene2[ButtonScene2["workItemNode"] = 4] = "workItemNode";
   return ButtonScene2;
 })(ButtonScene || {});
-var InterceptionEvent = /* @__PURE__ */ ((InterceptionEvent2) => {
-  InterceptionEvent2[InterceptionEvent2["CreateWorkItem"] = 1001] = "CreateWorkItem";
-  InterceptionEvent2[InterceptionEvent2["DeleteWorkItem"] = 1002] = "DeleteWorkItem";
-  InterceptionEvent2[InterceptionEvent2["BatchDeleteWorkItem"] = 1003] = "BatchDeleteWorkItem";
-  InterceptionEvent2[InterceptionEvent2["RecoveryWorkItem"] = 1004] = "RecoveryWorkItem";
-  InterceptionEvent2[InterceptionEvent2["AbortWorkItem"] = 1005] = "AbortWorkItem";
-  InterceptionEvent2[InterceptionEvent2["UpgradeTemplate"] = 1006] = "UpgradeTemplate";
-  InterceptionEvent2[InterceptionEvent2["BatchUpgradeTemplate"] = 1007] = "BatchUpgradeTemplate";
-  InterceptionEvent2[InterceptionEvent2["ExportWorkItem"] = 1008] = "ExportWorkItem";
-  InterceptionEvent2[InterceptionEvent2["FinishNode"] = 2001] = "FinishNode";
-  InterceptionEvent2[InterceptionEvent2["DeleteNode"] = 2002] = "DeleteNode";
-  InterceptionEvent2[InterceptionEvent2["RecoveryNode"] = 2003] = "RecoveryNode";
-  InterceptionEvent2[InterceptionEvent2["RollBackNode"] = 2004] = "RollBackNode";
-  InterceptionEvent2[InterceptionEvent2["EditSchedule"] = 2005] = "EditSchedule";
-  InterceptionEvent2[InterceptionEvent2["UpdateState"] = 3001] = "UpdateState";
-  return InterceptionEvent2;
-})(InterceptionEvent || {});
+var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
+  InterceptEvent2[InterceptEvent2["CreateWorkItem"] = 1001] = "CreateWorkItem";
+  InterceptEvent2[InterceptEvent2["DeleteWorkItem"] = 1002] = "DeleteWorkItem";
+  InterceptEvent2[InterceptEvent2["BatchDeleteWorkItem"] = 1003] = "BatchDeleteWorkItem";
+  InterceptEvent2[InterceptEvent2["RecoveryWorkItem"] = 1004] = "RecoveryWorkItem";
+  InterceptEvent2[InterceptEvent2["AbortWorkItem"] = 1005] = "AbortWorkItem";
+  InterceptEvent2[InterceptEvent2["UpgradeTemplate"] = 1006] = "UpgradeTemplate";
+  InterceptEvent2[InterceptEvent2["BatchUpgradeTemplate"] = 1007] = "BatchUpgradeTemplate";
+  InterceptEvent2[InterceptEvent2["ExportWorkItem"] = 1008] = "ExportWorkItem";
+  InterceptEvent2[InterceptEvent2["FinishNode"] = 2001] = "FinishNode";
+  InterceptEvent2[InterceptEvent2["DeleteNode"] = 2002] = "DeleteNode";
+  InterceptEvent2[InterceptEvent2["RecoveryNode"] = 2003] = "RecoveryNode";
+  InterceptEvent2[InterceptEvent2["RollBackNode"] = 2004] = "RollBackNode";
+  InterceptEvent2[InterceptEvent2["EditSchedule"] = 2005] = "EditSchedule";
+  InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
+  return InterceptEvent2;
+})(InterceptEvent || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -522,19 +639,34 @@ var InvalidParamsError = class extends CustomError {
   }
 };
 
+// src/errors/NotSupportedError.ts
+var NotSupportedError = class extends CustomError {
+  constructor(options) {
+    super({
+      message: "the api is not supported",
+      originMessage: options.originMessage
+    });
+    this.name = "NotSupportedError";
+  }
+};
+
 // src/index.ts
 var src_default = SDKClient;
 export {
   ActionSheet,
   AttributeType,
+  Button,
   ButtonScene,
   Clipboard,
+  ContainerModal,
   Context,
+  Control,
   Field,
   FieldType,
   FlowMode,
   IMPL_KEY,
-  InterceptionEvent,
+  Intercept,
+  InterceptEvent,
   InternalError,
   InvalidParamsError,
   MEEGO_BIZ_HUB,
@@ -543,6 +675,7 @@ export {
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  NotSupportedError,
   OutOfLimitError,
   RichTextEditor,
   SDKClient,
@@ -551,6 +684,7 @@ export {
   Toast,
   Utils,
   WorkItem,
+  WorkItemFinder,
   WorkObject,
   src_default as default
 };

package/dist/lib/index.js

@@ -50,14 +50,18 @@ var src_exports = {};
 __export(src_exports, {
   ActionSheet: () => ActionSheet,
   AttributeType: () => AttributeType,
+  Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
+  ContainerModal: () => ContainerModal,
   Context: () => Context,
+  Control: () => Control,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
   IMPL_KEY: () => IMPL_KEY,
-  InterceptionEvent: () => InterceptionEvent,
+  Intercept: () => Intercept,
+  InterceptEvent: () => InterceptEvent,
   InternalError: () => InternalError,
   InvalidParamsError: () => InvalidParamsError,
   MEEGO_BIZ_HUB: () => MEEGO_BIZ_HUB,
@@ -66,6 +70,7 @@ __export(src_exports, {
   NoAuthError: () => NoAuthError,
   NodeStatus: () => NodeStatus,
   NotFoundError: () => NotFoundError,
+  NotSupportedError: () => NotSupportedError,
   OutOfLimitError: () => OutOfLimitError,
   RichTextEditor: () => RichTextEditor,
   SDKClient: () => SDKClient,
@@ -74,6 +79,7 @@ __export(src_exports, {
   Toast: () => Toast,
   Utils: () => Utils,
   WorkItem: () => WorkItem,
+  WorkItemFinder: () => WorkItemFinder,
   WorkObject: () => WorkObject,
   default: () => src_default
 });
@@ -311,9 +317,9 @@ _a12 = IMPL_KEY;
  */
 RichTextEditor[_a12] = "richTextEditor";
 
-// src/biz/Utils.ts
+// src/biz/WorkItemFinder.ts
 var _a13;
-var Utils = class extends BaseModel {
+var WorkItemFinder = class extends BaseModel {
   /**
    * @internal
    */
@@ -325,7 +331,87 @@ _a13 = IMPL_KEY;
 /**
  * @internal
  */
-Utils[_a13] = "utils";
+WorkItemFinder[_a13] = "workItemFinder";
+
+// src/biz/Utils.ts
+var _a14;
+var Utils = class extends BaseModel {
+  /**
+   * @internal
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a14 = IMPL_KEY;
+/**
+ * @internal
+ */
+Utils[_a14] = "utils";
+
+// src/features/ContainerModal.ts
+var _a15;
+var ContainerModal = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a15 = IMPL_KEY;
+/**
+ * @internal
+ */
+ContainerModal[_a15] = "ContainerModal";
+
+// src/features/Intercept.ts
+var _a16;
+var Intercept = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a16 = IMPL_KEY;
+/**
+ * @internal
+ */
+Intercept[_a16] = "Intercept";
+
+// src/features/Control.ts
+var _a17;
+var Control = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a17 = IMPL_KEY;
+/**
+ * @internal
+ */
+Control[_a17] = "Control";
+
+// src/features/Button.ts
+var _a18;
+var Button = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a18 = IMPL_KEY;
+/**
+ * @internal
+ */
+Button[_a18] = "Button";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -335,6 +421,34 @@ function getImplValue(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
 }
 var _SDKClient = class {
+  /**
+   * 插件容器模态框
+   * only 2.0
+   */
+  get containerModal() {
+    return getImplValue(ContainerModal, this._meegoBizHub);
+  }
+  /**
+   * 拦截事件点位容器特有能力
+   * only 2.0
+   */
+  get intercept() {
+    return getImplValue(Intercept, this._meegoBizHub);
+  }
+  /**
+   * 控件点位容器特有能力
+   * only 2.0
+   */
+  get control() {
+    return getImplValue(Control, this._meegoBizHub);
+  }
+  /**
+   * 按钮点位容器特有能力
+   * only 2.0
+   */
+  get button() {
+    return getImplValue(Button, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -361,10 +475,18 @@ var _SDKClient = class {
   }
   /**
    * 富文本编辑器
+   * only 2.0
    */
   get richTextEditor() {
     return getImplValue(RichTextEditor, this._meegoBizHub);
   }
+  /**
+   * 工作项实例筛选器
+   * only web 2.0
+   */
+  get workItemFinder() {
+    return getImplValue(WorkItemFinder, this._meegoBizHub);
+  }
   /**
    * 模态框
    */
@@ -373,6 +495,7 @@ var _SDKClient = class {
   }
   /**
    * 操作菜单
+   * only mobile 2.0
    */
   get actionSheet() {
     return getImplValue(ActionSheet, this._meegoBizHub);
@@ -439,7 +562,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.2";
+SDKClient.version = "2.0.1-alpha.20";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -492,23 +615,23 @@ var ButtonScene = /* @__PURE__ */ ((ButtonScene2) => {
   ButtonScene2[ButtonScene2["workItemNode"] = 4] = "workItemNode";
   return ButtonScene2;
 })(ButtonScene || {});
-var InterceptionEvent = /* @__PURE__ */ ((InterceptionEvent2) => {
-  InterceptionEvent2[InterceptionEvent2["CreateWorkItem"] = 1001] = "CreateWorkItem";
-  InterceptionEvent2[InterceptionEvent2["DeleteWorkItem"] = 1002] = "DeleteWorkItem";
-  InterceptionEvent2[InterceptionEvent2["BatchDeleteWorkItem"] = 1003] = "BatchDeleteWorkItem";
-  InterceptionEvent2[InterceptionEvent2["RecoveryWorkItem"] = 1004] = "RecoveryWorkItem";
-  InterceptionEvent2[InterceptionEvent2["AbortWorkItem"] = 1005] = "AbortWorkItem";
-  InterceptionEvent2[InterceptionEvent2["UpgradeTemplate"] = 1006] = "UpgradeTemplate";
-  InterceptionEvent2[InterceptionEvent2["BatchUpgradeTemplate"] = 1007] = "BatchUpgradeTemplate";
-  InterceptionEvent2[InterceptionEvent2["ExportWorkItem"] = 1008] = "ExportWorkItem";
-  InterceptionEvent2[InterceptionEvent2["FinishNode"] = 2001] = "FinishNode";
-  InterceptionEvent2[InterceptionEvent2["DeleteNode"] = 2002] = "DeleteNode";
-  InterceptionEvent2[InterceptionEvent2["RecoveryNode"] = 2003] = "RecoveryNode";
-  InterceptionEvent2[InterceptionEvent2["RollBackNode"] = 2004] = "RollBackNode";
-  InterceptionEvent2[InterceptionEvent2["EditSchedule"] = 2005] = "EditSchedule";
-  InterceptionEvent2[InterceptionEvent2["UpdateState"] = 3001] = "UpdateState";
-  return InterceptionEvent2;
-})(InterceptionEvent || {});
+var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
+  InterceptEvent2[InterceptEvent2["CreateWorkItem"] = 1001] = "CreateWorkItem";
+  InterceptEvent2[InterceptEvent2["DeleteWorkItem"] = 1002] = "DeleteWorkItem";
+  InterceptEvent2[InterceptEvent2["BatchDeleteWorkItem"] = 1003] = "BatchDeleteWorkItem";
+  InterceptEvent2[InterceptEvent2["RecoveryWorkItem"] = 1004] = "RecoveryWorkItem";
+  InterceptEvent2[InterceptEvent2["AbortWorkItem"] = 1005] = "AbortWorkItem";
+  InterceptEvent2[InterceptEvent2["UpgradeTemplate"] = 1006] = "UpgradeTemplate";
+  InterceptEvent2[InterceptEvent2["BatchUpgradeTemplate"] = 1007] = "BatchUpgradeTemplate";
+  InterceptEvent2[InterceptEvent2["ExportWorkItem"] = 1008] = "ExportWorkItem";
+  InterceptEvent2[InterceptEvent2["FinishNode"] = 2001] = "FinishNode";
+  InterceptEvent2[InterceptEvent2["DeleteNode"] = 2002] = "DeleteNode";
+  InterceptEvent2[InterceptEvent2["RecoveryNode"] = 2003] = "RecoveryNode";
+  InterceptEvent2[InterceptEvent2["RollBackNode"] = 2004] = "RollBackNode";
+  InterceptEvent2[InterceptEvent2["EditSchedule"] = 2005] = "EditSchedule";
+  InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
+  return InterceptEvent2;
+})(InterceptEvent || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -573,20 +696,35 @@ var InvalidParamsError = class extends CustomError {
   }
 };
 
+// src/errors/NotSupportedError.ts
+var NotSupportedError = class extends CustomError {
+  constructor(options) {
+    super({
+      message: "the api is not supported",
+      originMessage: options.originMessage
+    });
+    this.name = "NotSupportedError";
+  }
+};
+
 // src/index.ts
 var src_default = SDKClient;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ActionSheet,
   AttributeType,
+  Button,
   ButtonScene,
   Clipboard,
+  ContainerModal,
   Context,
+  Control,
   Field,
   FieldType,
   FlowMode,
   IMPL_KEY,
-  InterceptionEvent,
+  Intercept,
+  InterceptEvent,
   InternalError,
   InvalidParamsError,
   MEEGO_BIZ_HUB,
@@ -595,6 +733,7 @@ var src_default = SDKClient;
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  NotSupportedError,
   OutOfLimitError,
   RichTextEditor,
   SDKClient,
@@ -603,5 +742,6 @@ var src_default = SDKClient;
   Toast,
   Utils,
   WorkItem,
+  WorkItemFinder,
   WorkObject
 });

package/dist/types/index.d.ts

@@ -328,10 +328,10 @@ declare enum ButtonScene {
     workItemNode = 4
 }
 /**
- * 按钮构成
- * 可被配置于详情页工具栏，视图页、视图工具栏、用于操作单个或多个工作项
+ * 工作项实例按钮上下文
+ * 适用场景：工作项-更多 / 节点-更多 / 节点流转
  */
-interface ButtonFeatureContext {
+interface WorkItemButtonFeatureContext {
     /**
      * 空间标识
      */
@@ -345,10 +345,24 @@ interface ButtonFeatureContext {
      */
     workItemId: number;
     /**
-     * 按钮位置
+     * 按钮所属节点标识
+     * 适用场景：节点-更多 / 节点流转
      */
-    buttonScene: ButtonScene;
+    nodeId?: string;
 }
+/**
+ * 新建按钮上下文
+ */
+interface CreateButtonFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+}
+/**
+ * 按钮构成
+ */
+type ButtonFeatureContext = WorkItemButtonFeatureContext | CreateButtonFeatureContext;
 /**
  * 内嵌页面构成
  * 一个单独的导航入口+内嵌页面
@@ -397,15 +411,32 @@ interface ViewFeatureContext {
 }
 /**
  * 控件构成
- * 可被配置于详情页、节点流转、状态流转表单、表格页并可用于筛选和分组
  */
 interface ControlFeatureContext {
-    [key: string]: any;
+    /**
+     * 控件当前所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 控件当前所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 控件当前所属工作项实例标识
+     * 新建页表单内该值为空
+     */
+    workItemId?: number;
+    /**
+     * 控件唯一标识
+     * 新建场景结合 webhook 用于关联自有数据
+     * 详情页可能为空，不推荐强依赖 UUID 读取自有数据
+     */
+    UUID?: string;
 }
 /**
  * 拦截事件类型
  */
-declare enum InterceptionEvent {
+declare enum InterceptEvent {
     /** 创建工作项 */
     CreateWorkItem = 1001,
     /** 删除工作项 */
@@ -439,10 +470,27 @@ declare enum InterceptionEvent {
  * 拦截构成
  * 用于拦截用户行为，包括拦截位置、触发规则和提示等相关配置
  */
-interface InterceptionFeatureContext {
-    eventType: InterceptionEvent;
-    spaceId: string;
-    workItems: Array<BriefWorkItem>;
+interface InterceptFeatureContext<T> {
+    message: string;
+    eventType: InterceptEvent;
+    workItems: Array<BriefWorkItem & {
+        /**
+         * 当前触发事件，不同事件类型对应不同的 changedValue
+         */
+        changedValue?: {
+            fieldInfo?: Array<{
+                fieldKey: string;
+                fieldType?: string;
+                alias?: string;
+                beforeFieldValue?: unknown;
+                afterFieldValue?: unknown;
+            }>;
+            nodeInfo?: any;
+            subTaskInfo?: any;
+            transitionInfo?: any;
+        };
+    }>;
+    customData: T;
 }
 
 /**
@@ -522,6 +570,12 @@ declare abstract class Context extends BaseModel {
      * @param callback
      */
     abstract watch(callback: (nextValue: Context) => void): unwatch;
+    /**
+     * only web 2.0
+     * 用于获取插件内设置的上下文数据
+     * 例如：在 sdk.modal.open 时传入的 context，可以通过该方法来获取
+     */
+    abstract getCustomContext<Context>(): Promise<Context>;
 }
 
 /**
@@ -959,9 +1013,9 @@ declare abstract class ActionSheet extends BaseModel {
 }
 
 /**
- * Modal 展示配置
+ * Modal confirm 展示配置
  */
-interface ModalOptions {
+interface ModalConfirmOptions {
     /**
      * 标题
      * title 和 content 不可同时为空
@@ -988,6 +1042,40 @@ interface ModalOptions {
      */
     cancelText?: string;
 }
+/**
+ * Modal 展示配置
+ */
+interface ModalOptions<Context> {
+    /**
+     * 宽度
+     * 默认: 448
+     */
+    width?: number;
+    /**
+     * 高度
+     */
+    height?: number;
+    /**
+     * 是否全屏
+     * 全屏时 width / height 无效
+     */
+    fullScreen?: boolean;
+    /**
+     * 是否允许通过点击遮罩来关闭对话框
+     */
+    maskClosable?: boolean;
+    /**
+     * 传入 Modal 内的上下文数据
+     * 注：传入的数据在 Modal 内是通过 sdk.containerModal.getContext() 来获取的
+     */
+    context?: Context;
+    /**
+     * 响应弹窗内调用的 sdk.containerModal.submit 方法
+     * @param params 弹窗内调用的 sdk.containerModal.submit 的方法时传入的自定义参数
+     * @returns 调用 sdk.containerModal.submit 返回的自定义值
+     */
+    onSubmit?: (params: unknown) => Promise<unknown>;
+}
 /**
  * @public
  * Modal 用于等待用户响应、告知用户重要信息或在不丢失上下文的情况下展示更多信息
@@ -1002,16 +1090,25 @@ declare abstract class Modal extends BaseModel {
      */
     private static load;
     /**
-     * 打开模态框
+     * 使用模态框 confirm
      * @param options
      * @param callback
      *    confirmed 点击了确认
      *    canceled  点击了取消
      */
-    abstract show(options: string | ModalOptions, callback: (result: {
+    abstract confirm(options: string | ModalConfirmOptions, callback: (result: {
         confirmed: boolean;
         canceled: boolean;
     }) => void): Promise<void>;
+    /**
+     * only web 2.0
+     * 打开自定义内容的模态框
+     * @param options
+     * @returns 当前打开 Modal 的关闭方法
+     */
+    abstract open<Context>(options: ModalOptions<Context>): Promise<{
+        close: () => void;
+    }>;
 }
 
 /**
@@ -1023,7 +1120,7 @@ interface RichTextEditorOptions {
      */
     title?: string;
     /**
-     * 富文本内容
+     * 富文本默认内容，对应 RichTextEditorContent.doc
      */
     defaultValue?: string;
     /**
@@ -1038,6 +1135,27 @@ interface RichTextEditorOptions {
         spaceId: string;
     };
 }
+/**
+ * 富文本完整内容
+ */
+interface RichTextEditorContent {
+    /**
+     * 富文本结构化数据
+     */
+    doc?: string;
+    /**
+     * 富文本 HTML 版本
+     */
+    doc_html?: string;
+    /**
+     * 富文本的纯文本概要
+     */
+    doc_text?: string;
+    /**
+     * 是否为空
+     */
+    is_empty: boolean;
+}
 /**
  * @public
  * RichTextEditor 用于富文本的编辑
@@ -1062,7 +1180,62 @@ declare abstract class RichTextEditor extends BaseModel {
     abstract show(options: RichTextEditorOptions, callback: (result: {
         confirmed: boolean;
         canceled: boolean;
-        nextValue?: string;
+        nextValue?: RichTextEditorContent;
+    }) => void): Promise<void>;
+}
+
+/**
+ * WorkItemFinder 配置
+ */
+interface WorkItemFinderOptions {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+    /**
+     * 工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 筛选器标题，仅用于展示
+     */
+    title?: string;
+    /**
+     * 搜索条件标识
+     * 如为空则生成新 key，不为空则会覆写
+     * searchId 与 workObjectId | spaceId 不匹配则会异常
+     */
+    searchId?: string;
+    /**
+     * 默认 true，控制 searchId 的筛选条件是否回填到筛选器
+     */
+    backfill?: boolean;
+}
+/**
+ * @public
+ * WorkItemFinder 用于生成工作项实例筛选条件的面板
+ */
+declare abstract class WorkItemFinder extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * @internal
+     */
+    private static load;
+    /**
+     * 打开工作项实例筛选条件面板
+     * @param options
+     * @param callback
+     *    confirmed 点击了确认
+     *    canceled  点击了取消
+     *    searchId 当点击确认时，返回筛选条件标识 searchId
+     */
+    abstract open(options: WorkItemFinderOptions, callback: (result: {
+        confirmed: boolean;
+        canceled: boolean;
+        searchId?: string;
     }) => void): Promise<void>;
 }
 
@@ -1099,6 +1272,88 @@ declare abstract class Utils extends BaseModel {
     }>;
 }
 
+/**
+ * @public
+ * 插件容器模态框
+ */
+declare abstract class ContainerModal extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<ContainerModal>;
+    /**
+     * only web 2.0
+     * 只存在于 modal.open 打开的容器内
+     * submit 调用的是 sdk.modal.open 传入的 onSubmit 方法
+     */
+    abstract submit?: <Params, Result>(params: Params) => Promise<Result>;
+    /**
+     * 关闭插件当前激活的容器模态框
+     */
+    abstract close(): Promise<void>;
+}
+
+/**
+ * @public
+ * 拦截事件模态框
+ */
+declare abstract class Intercept extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Intercept>;
+    /**
+     * 获取当前触发的拦截事件上下文
+     */
+    abstract getContext<T = any>(): Promise<InterceptFeatureContext<T>>;
+}
+
+/**
+ * @public
+ * 控件
+ */
+declare abstract class Control extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Control>;
+    /**
+     * 获取当前控件的上下文
+     */
+    abstract getContext(): Promise<ControlFeatureContext>;
+}
+
+/**
+ * @public
+ * 按钮
+ */
+declare abstract class Button extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Button>;
+    /**
+     * 获取当前按钮的上下文
+     */
+    abstract getContext(): Promise<ButtonFeatureContext>;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1116,6 +1371,26 @@ declare class SDKClient {
      * SDK 版本号
      */
     static version: string;
+    /**
+     * 插件容器模态框
+     * only 2.0
+     */
+    get containerModal(): ContainerModal;
+    /**
+     * 拦截事件点位容器特有能力
+     * only 2.0
+     */
+    get intercept(): Intercept;
+    /**
+     * 控件点位容器特有能力
+     * only 2.0
+     */
+    get control(): Control;
+    /**
+     * 按钮点位容器特有能力
+     * only 2.0
+     */
+    get button(): Button;
     /**
      * 应用导航
      */
@@ -1134,14 +1409,21 @@ declare class SDKClient {
     get toast(): Toast;
     /**
      * 富文本编辑器
+     * only 2.0
      */
     get richTextEditor(): RichTextEditor;
+    /**
+     * 工作项实例筛选器
+     * only web 2.0
+     */
+    get workItemFinder(): WorkItemFinder;
     /**
      * 模态框
      */
     get modal(): Modal;
     /**
      * 操作菜单
+     * only mobile 2.0
      */
     get actionSheet(): ActionSheet;
     /**
@@ -1241,6 +1523,16 @@ declare class InvalidParamsError extends CustomError {
     });
 }
 
+/**
+ * @public
+ * API 在当前环境不支持
+ */
+declare class NotSupportedError extends CustomError {
+    constructor(options: {
+        originMessage: string;
+    });
+}
+
 /**
  * 用于飞书项目插件读取系统数据的 JSSDK
  *
@@ -1250,4 +1542,4 @@ declare class InvalidParamsError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, Context, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, OutOfLimitError, PageFeatureContext, RichTextEditor, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, Toast, ToastOptions, User, Utils, ViewFeatureContext, WorkItem, WorkItemCreateFormPreset, WorkObject, SDKClient as default, unwatch };
+export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalConfirmOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, NotSupportedError, OutOfLimitError, PageFeatureContext, RichTextEditor, RichTextEditorContent, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, Toast, ToastOptions, User, Utils, ViewFeatureContext, WorkItem, WorkItemButtonFeatureContext, WorkItemCreateFormPreset, WorkItemFinder, WorkItemFinderOptions, WorkObject, SDKClient as default, unwatch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-project/js-sdk",
-  "version": "2.0.1-alpha.2",
+  "version": "2.0.1-alpha.20",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"