@lark-project/js-sdk 2.0.7-dev.1 → 2.0.8-dev.0

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
+## 2.0.7 (2025/01/23)
+- 「Add」新增 Control onWorkItemFormValueChanged / getDisplayInfo / openFullScreenPlugin
+- 「Add」新增 Button onWorkItemFormValueChanged
+- 「Add」新增 Tab onWorkItemFormValueChanged
+- 「Add」新增 CustomComponent - schedule 点位
+
 ## 2.0.6 (2024/09/12)
 - 「Add」新增 Fullscreen Modal
+- 「Add」新增 Context loginUser tenantId
 
 ## 2.0.5 (2024/08/13)
 - 「Add」新增 Button Context

package/dist/es/index.js

@@ -624,7 +624,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.7-dev.1";
+SDKClient.version = "2.0.8-dev.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/lib/index.js

@@ -689,7 +689,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.7-dev.1";
+SDKClient.version = "2.0.8-dev.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/types/index.d.ts

@@ -15,6 +15,11 @@ interface User {
      * 用户头像
      */
     avatar: string;
+    /**
+     * 所属租户
+     * @mobile_version >= 7.37
+     */
+    tenantId?: string;
 }
 /**
  * @public
@@ -374,10 +379,36 @@ interface CreateButtonFeatureContext {
      */
     viewId?: string;
 }
+/**
+ * 视图批量按钮上下文
+ * 适用场景：普通视图、工作项主页视图、工作台视图组件
+ */
+interface BatchButtonFeatureContext {
+    /**
+     * 视图所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 视图所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 视图标识
+     */
+    viewId?: string;
+    /**
+     * 勾选的工作项实例
+     */
+    selectedWorkItems: Array<{
+        spaceId: string;
+        workObjectId: string;
+        workItemIds: number[];
+    }>;
+}
 /**
  * 按钮构成
  */
-type ButtonFeatureContext = WorkItemButtonFeatureContext | CreateButtonFeatureContext;
+type ButtonFeatureContext = WorkItemButtonFeatureContext | CreateButtonFeatureContext | BatchButtonFeatureContext;
 /**
  * 内嵌页面构成
  * 一个单独的导航入口+内嵌页面
@@ -544,7 +575,7 @@ declare enum WorkItemNodeType {
     Node = "node",
     SubTask = "sub_task",
     SubWorkItem = "sub_workitem",
-    SuInstance = "sub_instance"
+    SubInstance = "sub_instance"
 }
 interface WorkItemInfo {
     spaceId: string;
@@ -1549,7 +1580,7 @@ declare abstract class Control extends BaseModel {
      */
     abstract getCreateWorkItemFormItemValues(keys: Array<{
         key: string | AttributeType;
-        type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting>;
+        type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
     }>): Promise<Record<string | AttributeType, any>>;
     /**
      * only web 2.0
@@ -1564,9 +1595,32 @@ declare abstract class Control extends BaseModel {
     abstract onCreateWorkItemFormValueChanged(options: {
         watchKeys: Array<{
             key: string | AttributeType;
-            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting>;
+            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
         }>;
     }, callback: (changedKeys: Array<string | AttributeType>) => void): Off;
+    /**
+       * 监听工作项表单项值变化
+       * @param options.watchKeys 需要监听的工作项 字段 ID 列表
+       * @param callback 当监听值发生变化时触发，changedValue 为变化的 kv
+       */
+    abstract onWorkItemFormValueChanged(options: {
+        watchKeys: Array<{
+            key: string | AttributeType;
+            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
+        }>;
+    }, callback: (changedValue: Record<string, unknown>) => void): Promise<Off>;
+    /**
+     * only mobile 7.35.0+
+     * 获取插件的展示态信息
+     */
+    abstract getDisplayInfo(): Promise<{
+        display_height: number;
+    }>;
+    /**
+      * only mobile 7.35.0+
+      * 打开全屏插件
+      */
+    abstract openFullScreenPlugin(): void;
 }
 
 /**
@@ -1587,11 +1641,23 @@ declare abstract class Button extends BaseModel {
      * 获取当前按钮的上下文
      */
     abstract getContext(): Promise<ButtonFeatureContext>;
+    /**
+       * only web 2.0
+       * 监听工作项表单项值变化
+       * @param options.watchKeys 需要监听的工作项 字段 ID 列表
+       * @param callback 当监听值发生变化时触发，changedValue 为变化的 kv
+       */
+    abstract onWorkItemFormValueChanged(options: {
+        watchKeys: Array<{
+            key: string | AttributeType;
+            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
+        }>;
+    }, callback: (changedValue: Record<string, unknown>) => void): Promise<Off>;
 }
 
 /**
  * @public
- * 控件
+ * 插件配置
  */
 declare abstract class Configuration extends BaseModel {
     /**
@@ -1610,7 +1676,7 @@ declare abstract class Configuration extends BaseModel {
 
 /**
  * @public
- * 控件
+ * 内嵌页面
  */
 declare abstract class Page extends BaseModel {
     /**
@@ -1629,7 +1695,7 @@ declare abstract class Page extends BaseModel {
 
 /**
  * @public
- * 控件
+ * 详情页
  */
 declare abstract class Tab extends BaseModel {
     /**
@@ -1644,11 +1710,23 @@ declare abstract class Tab extends BaseModel {
      * 获取当前详情页 Tab 的上下文
      */
     abstract getContext(): Promise<TabFeatureContext>;
+    /**
+       * only web 2.0
+       * 监听工作项表单项值变化
+       * @param options.watchKeys 需要监听的工作项 字段 ID 列表
+       * @param callback 当监听值发生变化时触发，changedValue 为变化的 kv
+       */
+    abstract onWorkItemFormValueChanged(options: {
+        watchKeys: Array<{
+            key: string | AttributeType;
+            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
+        }>;
+    }, callback: (changedValue: Record<string, unknown>) => void): Promise<Off>;
 }
 
 /**
  * @public
- * 控件
+ * 视图
  */
 declare abstract class View extends BaseModel {
     /**
@@ -1905,4 +1983,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, ComponentScheduleIdentity, ComponentScheduleScene, Configuration, ConfigurationFeatureContext, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, CustomComponentType, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalConfirmOptions, ModalOpenOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, NotSupportedError, Off, OutOfLimitError, Page, PageFeatureContext, RichTextEditor, RichTextEditorContent, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, ScheduleCompValidateMsg, ScheduleCompValueType, Shared, Space, Storage, Tab, TabFeatureContext, Toast, ToastOptions, User, UserInfo, Utils, View, ViewFeatureContext, WbsStatus, WorkItem, WorkItemButtonFeatureContext, WorkItemCreateFormPreset, WorkItemFinder, WorkItemFinderOptions, WorkObject, SDKClient as default, unwatch };
+export { ActionSheet, ActionSheetOptions, AttributeType, BatchButtonFeatureContext, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, ComponentScheduleIdentity, ComponentScheduleScene, Configuration, ConfigurationFeatureContext, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, CustomComponentType, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalConfirmOptions, ModalOpenOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, NotSupportedError, Off, OutOfLimitError, Page, PageFeatureContext, RichTextEditor, RichTextEditorContent, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, ScheduleCompValidateMsg, ScheduleCompValueType, Shared, Space, Storage, Tab, TabFeatureContext, Toast, ToastOptions, User, UserInfo, Utils, View, ViewFeatureContext, WbsStatus, 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.7-dev.1",
+  "version": "2.0.8-dev.0",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"