@lark-project/js-sdk 2.0.1-alpha.9 → 2.0.1-dev.21

package/CHANGELOG.md

@@ -1,4 +1,17 @@
 # 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

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,10 +274,26 @@ _a13 = IMPL_KEY;
 /**
  * @internal
  */
-Utils[_a13] = "utils";
+WorkItemFinder[_a13] = "workItemFinder";
 
-// src/features/ContainerModal.ts
+// 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 {
   /**
    * 加载数据
@@ -286,14 +302,14 @@ var ContainerModal = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a14 = IMPL_KEY;
+_a15 = IMPL_KEY;
 /**
  * @internal
  */
-ContainerModal[_a14] = "ContainerModal";
+ContainerModal[_a15] = "ContainerModal";
 
 // src/features/Intercept.ts
-var _a15;
+var _a16;
 var Intercept = class extends BaseModel {
   /**
    * 加载数据
@@ -302,14 +318,14 @@ var Intercept = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a15 = IMPL_KEY;
+_a16 = IMPL_KEY;
 /**
  * @internal
  */
-Intercept[_a15] = "Intercept";
+Intercept[_a16] = "Intercept";
 
 // src/features/Control.ts
-var _a16;
+var _a17;
 var Control = class extends BaseModel {
   /**
    * 加载数据
@@ -318,11 +334,27 @@ var Control = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a16 = IMPL_KEY;
+_a17 = IMPL_KEY;
 /**
  * @internal
  */
-Control[_a16] = "Control";
+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) {
@@ -353,6 +385,13 @@ var _SDKClient = class {
   get control() {
     return getImplValue(Control, this._meegoBizHub);
   }
+  /**
+   * 按钮点位容器特有能力
+   * only 2.0
+   */
+  get button() {
+    return getImplValue(Button, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -384,6 +423,13 @@ var _SDKClient = class {
   get richTextEditor() {
     return getImplValue(RichTextEditor, this._meegoBizHub);
   }
+  /**
+   * 工作项实例筛选器
+   * only web 2.0
+   */
+  get workItemFinder() {
+    return getImplValue(WorkItemFinder, this._meegoBizHub);
+  }
   /**
    * 模态框
    */
@@ -459,7 +505,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.9";
+SDKClient.version = "2.0.1-dev.21";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -593,11 +639,23 @@ 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,
@@ -617,6 +675,7 @@ export {
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  NotSupportedError,
   OutOfLimitError,
   RichTextEditor,
   SDKClient,
@@ -625,6 +684,7 @@ export {
   Toast,
   Utils,
   WorkItem,
+  WorkItemFinder,
   WorkObject,
   src_default as default
 };

package/dist/lib/index.js

@@ -50,6 +50,7 @@ var src_exports = {};
 __export(src_exports, {
   ActionSheet: () => ActionSheet,
   AttributeType: () => AttributeType,
+  Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
   ContainerModal: () => ContainerModal,
@@ -69,6 +70,7 @@ __export(src_exports, {
   NoAuthError: () => NoAuthError,
   NodeStatus: () => NodeStatus,
   NotFoundError: () => NotFoundError,
+  NotSupportedError: () => NotSupportedError,
   OutOfLimitError: () => OutOfLimitError,
   RichTextEditor: () => RichTextEditor,
   SDKClient: () => SDKClient,
@@ -77,6 +79,7 @@ __export(src_exports, {
   Toast: () => Toast,
   Utils: () => Utils,
   WorkItem: () => WorkItem,
+  WorkItemFinder: () => WorkItemFinder,
   WorkObject: () => WorkObject,
   default: () => src_default
 });
@@ -314,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
    */
@@ -328,10 +331,26 @@ _a13 = IMPL_KEY;
 /**
  * @internal
  */
-Utils[_a13] = "utils";
+WorkItemFinder[_a13] = "workItemFinder";
 
-// src/features/ContainerModal.ts
+// 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 {
   /**
    * 加载数据
@@ -340,14 +359,14 @@ var ContainerModal = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a14 = IMPL_KEY;
+_a15 = IMPL_KEY;
 /**
  * @internal
  */
-ContainerModal[_a14] = "ContainerModal";
+ContainerModal[_a15] = "ContainerModal";
 
 // src/features/Intercept.ts
-var _a15;
+var _a16;
 var Intercept = class extends BaseModel {
   /**
    * 加载数据
@@ -356,14 +375,14 @@ var Intercept = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a15 = IMPL_KEY;
+_a16 = IMPL_KEY;
 /**
  * @internal
  */
-Intercept[_a15] = "Intercept";
+Intercept[_a16] = "Intercept";
 
 // src/features/Control.ts
-var _a16;
+var _a17;
 var Control = class extends BaseModel {
   /**
    * 加载数据
@@ -372,11 +391,27 @@ var Control = class extends BaseModel {
     throw new Error("not implemented");
   }
 };
-_a16 = IMPL_KEY;
+_a17 = IMPL_KEY;
 /**
  * @internal
  */
-Control[_a16] = "Control";
+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) {
@@ -407,6 +442,13 @@ var _SDKClient = class {
   get control() {
     return getImplValue(Control, this._meegoBizHub);
   }
+  /**
+   * 按钮点位容器特有能力
+   * only 2.0
+   */
+  get button() {
+    return getImplValue(Button, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -438,6 +480,13 @@ var _SDKClient = class {
   get richTextEditor() {
     return getImplValue(RichTextEditor, this._meegoBizHub);
   }
+  /**
+   * 工作项实例筛选器
+   * only web 2.0
+   */
+  get workItemFinder() {
+    return getImplValue(WorkItemFinder, this._meegoBizHub);
+  }
   /**
    * 模态框
    */
@@ -513,7 +562,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-alpha.9";
+SDKClient.version = "2.0.1-dev.21";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -647,12 +696,24 @@ 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,
@@ -672,6 +733,7 @@ var src_default = SDKClient;
   NoAuthError,
   NodeStatus,
   NotFoundError,
+  NotSupportedError,
   OutOfLimitError,
   RichTextEditor,
   SDKClient,
@@ -680,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;
 /**
  * 内嵌页面构成
  * 一个单独的导航入口+内嵌页面
@@ -461,9 +475,20 @@ interface InterceptFeatureContext<T> {
     eventType: InterceptEvent;
     workItems: Array<BriefWorkItem & {
         /**
-         * 当前触发事件
+         * 当前触发事件，不同事件类型对应不同的 changedValue
          */
-        changedValue?: any;
+        changedValue?: {
+            fieldInfo?: Array<{
+                fieldKey: string;
+                fieldType?: string;
+                alias?: string;
+                beforeFieldValue?: unknown;
+                afterFieldValue?: unknown;
+            }>;
+            nodeInfo?: any;
+            subTaskInfo?: any;
+            transitionInfo?: any;
+        };
     }>;
     customData: T;
 }
@@ -545,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>;
 }
 
 /**
@@ -982,9 +1013,9 @@ declare abstract class ActionSheet extends BaseModel {
 }
 
 /**
- * Modal 展示配置
+ * Modal confirm 展示配置
  */
-interface ModalOptions {
+interface ModalConfirmOptions {
     /**
      * 标题
      * title 和 content 不可同时为空
@@ -1011,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 用于等待用户响应、告知用户重要信息或在不丢失上下文的情况下展示更多信息
@@ -1025,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;
+    }>;
 }
 
 /**
@@ -1106,7 +1180,62 @@ declare abstract class RichTextEditor extends BaseModel {
     abstract show(options: RichTextEditorOptions, callback: (result: {
         confirmed: boolean;
         canceled: boolean;
-        content?: RichTextEditorContent;
+        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>;
 }
 
@@ -1156,10 +1285,16 @@ declare abstract class ContainerModal extends BaseModel {
      * 加载数据
      */
     static load(): Promise<ContainerModal>;
+    /**
+     * only web 2.0
+     * 只存在于 modal.open 打开的容器内
+     * submit 调用的是 sdk.modal.open 传入的 onSubmit 方法
+     */
+    abstract submit?: <Params, Result>(params: Params) => Promise<Result>;
     /**
      * 关闭插件当前激活的容器模态框
      */
-    abstract closeModal: Promise<void>;
+    abstract close(): Promise<void>;
 }
 
 /**
@@ -1178,7 +1313,7 @@ declare abstract class Intercept extends BaseModel {
     /**
      * 获取当前触发的拦截事件上下文
      */
-    abstract getEventCtx<T = any>(): Promise<InterceptFeatureContext<T>>;
+    abstract getContext<T = any>(): Promise<InterceptFeatureContext<T>>;
 }
 
 /**
@@ -1200,6 +1335,25 @@ declare abstract class Control extends BaseModel {
     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 的配置项
@@ -1232,6 +1386,11 @@ declare class SDKClient {
      * only 2.0
      */
     get control(): Control;
+    /**
+     * 按钮点位容器特有能力
+     * only 2.0
+     */
+    get button(): Button;
     /**
      * 应用导航
      */
@@ -1253,6 +1412,11 @@ declare class SDKClient {
      * only 2.0
      */
     get richTextEditor(): RichTextEditor;
+    /**
+     * 工作项实例筛选器
+     * only web 2.0
+     */
+    get workItemFinder(): WorkItemFinder;
     /**
      * 模态框
      */
@@ -1359,6 +1523,16 @@ declare class InvalidParamsError extends CustomError {
     });
 }
 
+/**
+ * @public
+ * API 在当前环境不支持
+ */
+declare class NotSupportedError extends CustomError {
+    constructor(options: {
+        originMessage: string;
+    });
+}
+
 /**
  * 用于飞书项目插件读取系统数据的 JSSDK
  *
@@ -1368,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, ContainerModal, Context, Control, ControlFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, OutOfLimitError, PageFeatureContext, RichTextEditor, RichTextEditorContent, 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.9",
+  "version": "2.0.1-dev.21",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"