@lark-project/js-sdk 2.0.1-alpha.16 → 2.0.1-alpha.19

package/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Change Log
+## 2.0.6 (2024/09/12)
+- 「Add」新增 Fullscreen Modal
+
 ## 2.0.5 (2024/08/13)
 - 「Add」新增 Button Context
 

package/dist/es/index.js

@@ -505,7 +505,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.16";
+SDKClient.version = "2.0.1-alpha.19";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/lib/index.js

@@ -562,7 +562,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.16";
+SDKClient.version = "2.0.1-alpha.19";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/types/index.d.ts

@@ -480,10 +480,10 @@ interface InterceptFeatureContext<T> {
         changedValue?: {
             fieldInfo?: Array<{
                 fieldKey: string;
-                fieldType: string;
-                alias: string;
-                beforeFieldValue: unknown;
-                afterFieldValue: unknown;
+                fieldType?: string;
+                alias?: string;
+                beforeFieldValue?: unknown;
+                afterFieldValue?: unknown;
             }>;
             nodeInfo?: any;
             subTaskInfo?: any;
@@ -570,6 +570,11 @@ declare abstract class Context extends BaseModel {
      * @param callback
      */
     abstract watch(callback: (nextValue: Context) => void): unwatch;
+    /**
+     * 用于获取插件内自定义传入的上下文数据 context
+     * 例如：在 Modal.open 时传入的 context，可以通过 getCustomContext 来获取
+     */
+    abstract getCustomContext: <Context>() => Promise<Context>;
 }
 
 /**
@@ -1007,9 +1012,9 @@ declare abstract class ActionSheet extends BaseModel {
 }
 
 /**
- * Modal 展示配置
+ * Modal confirm 展示配置
  */
-interface ModalOptions {
+interface ModalConfirmOptions {
     /**
      * 标题
      * title 和 content 不可同时为空
@@ -1036,6 +1041,40 @@ interface ModalOptions {
      */
     cancelText?: string;
 }
+/**
+ * Modal 展示配置
+ */
+interface ModalOptions<Context extends any> {
+    /**
+     * 宽度
+     * 默认: 448
+     */
+    width?: number;
+    /**
+     * 高度
+     */
+    height?: number;
+    /**
+     * 是否全屏
+     * 对话是否是全屏（会覆盖 width ）
+     */
+    fullScreen?: boolean;
+    /**
+     * 是否允许通过点击遮罩来关闭对话框
+     */
+    maskClosable?: boolean;
+    /**
+     * 传入 Modal 内的上下文数据
+     * 注：传入的数据在 Modal 内是通过 sdk.containerModal.getContext() 来获取的
+     */
+    context?: Context;
+    /**
+     * 弹窗内部调用的submit的方法 - 传递外部使用
+     * @param params 弹窗内部调用的 ContainerModal.submit 的方法时传入的参数 - 自定义
+     * @returns 调用 ContainerModal.submit 返回的值 - 自定义
+     */
+    onSubmit?: <Params, Result>(params: Params) => Promise<Result>;
+}
 /**
  * @public
  * Modal 用于等待用户响应、告知用户重要信息或在不丢失上下文的情况下展示更多信息
@@ -1050,16 +1089,24 @@ declare abstract class Modal extends BaseModel {
      */
     private static load;
     /**
-     * 打开模态框
-     * @param options
-     * @param callback
-     *    confirmed 点击了确认
-     *    canceled  点击了取消
-     */
-    abstract show(options: string | ModalOptions, callback: (result: {
+       * 使用模态框 confirm
+       * @param options
+       * @param callback
+       *    confirmed 点击了确认
+       *    canceled  点击了取消
+       */
+    abstract confirm(options: string | ModalConfirmOptions, callback: (result: {
         confirmed: boolean;
         canceled: boolean;
     }) => void): Promise<void>;
+    /**
+     * 打开模态框 open
+     * @param options
+     * @returns 当前打开的 Modal 的 close 方法
+     */
+    abstract open<Context>(options: ModalOptions<Context>): Promise<{
+        close: () => void;
+    }>;
 }
 
 /**
@@ -1131,7 +1178,7 @@ declare abstract class RichTextEditor extends BaseModel {
     abstract show(options: RichTextEditorOptions, callback: (result: {
         confirmed: boolean;
         canceled: boolean;
-        content?: RichTextEditorContent;
+        nextValue?: RichTextEditorContent;
     }) => void): Promise<void>;
 }
 
@@ -1239,7 +1286,12 @@ declare abstract class ContainerModal extends BaseModel {
     /**
      * 关闭插件当前激活的容器模态框
      */
-    abstract closeModal(): Promise<void>;
+    abstract close(): Promise<void>;
+    /**
+     * 只存在于 modal.open 打开的容器内
+     * 对 modal 内 submit 对应的是 Modal.open 传入的 onSubmit 方法，以此让打开 modal 的地方 modal 传入的数据
+     */
+    abstract submit?: <Params, Result>(params: Params) => Promise<Result>;
 }
 
 /**
@@ -1487,4 +1539,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-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, ModalOptions, 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 };
+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.16",
+  "version": "2.0.1-alpha.19",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"