@lark-project/js-sdk 2.0.6 → 2.0.7

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

@@ -430,6 +430,16 @@ _a23 = IMPL_KEY;
  */
 View[_a23] = "view";
 
+// src/features/CustomComponent.ts
+var _a24;
+var CustomComponent = class extends BaseModel {
+};
+_a24 = IMPL_KEY;
+/**
+ * @internal
+ */
+CustomComponent[_a24] = "customComponent";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -614,7 +624,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.6";
+SDKClient.version = "2.0.7";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -685,6 +695,16 @@ var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
   InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
   return InterceptEvent2;
 })(InterceptEvent || {});
+var ComponentScheduleScene = /* @__PURE__ */ ((ComponentScheduleScene2) => {
+  ComponentScheduleScene2[ComponentScheduleScene2["ALL"] = 0] = "ALL";
+  ComponentScheduleScene2[ComponentScheduleScene2["workItemNode"] = 1] = "workItemNode";
+  ComponentScheduleScene2[ComponentScheduleScene2["scheduleTable"] = 2] = "scheduleTable";
+  return ComponentScheduleScene2;
+})(ComponentScheduleScene || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -768,10 +788,13 @@ export {
   Button,
   ButtonScene,
   Clipboard,
+  ComponentScheduleScene,
   Configuration,
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/lib/index.js

@@ -53,10 +53,13 @@ __export(src_exports, {
   Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
+  ComponentScheduleScene: () => ComponentScheduleScene,
   Configuration: () => Configuration,
   ContainerModal: () => ContainerModal,
   Context: () => Context,
   Control: () => Control,
+  CustomComponent: () => CustomComponent,
+  CustomComponentType: () => CustomComponentType,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
@@ -492,6 +495,16 @@ _a23 = IMPL_KEY;
  */
 View[_a23] = "view";
 
+// src/features/CustomComponent.ts
+var _a24;
+var CustomComponent = class extends BaseModel {
+};
+_a24 = IMPL_KEY;
+/**
+ * @internal
+ */
+CustomComponent[_a24] = "customComponent";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -676,7 +689,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.6";
+SDKClient.version = "2.0.7";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -747,6 +760,16 @@ var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
   InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
   return InterceptEvent2;
 })(InterceptEvent || {});
+var ComponentScheduleScene = /* @__PURE__ */ ((ComponentScheduleScene2) => {
+  ComponentScheduleScene2[ComponentScheduleScene2["ALL"] = 0] = "ALL";
+  ComponentScheduleScene2[ComponentScheduleScene2["workItemNode"] = 1] = "workItemNode";
+  ComponentScheduleScene2[ComponentScheduleScene2["scheduleTable"] = 2] = "scheduleTable";
+  return ComponentScheduleScene2;
+})(ComponentScheduleScene || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -831,10 +854,13 @@ var src_default = SDKClient;
   Button,
   ButtonScene,
   Clipboard,
+  ComponentScheduleScene,
   Configuration,
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/types/index.d.ts

@@ -15,6 +15,11 @@ interface User {
      * 用户头像
      */
     avatar: string;
+    /**
+     * 所属租户
+     * @mobile_version >= 7.37
+     */
+    tenantId?: string;
 }
 /**
  * @public
@@ -522,6 +527,111 @@ interface InterceptFeatureContext<T> {
     }>;
     customData: T;
 }
+/** ----------------------- 拓展组件-排期组件特化属性 ----------------------- */
+/**
+ * 排期组件位置
+ */
+declare enum ComponentScheduleScene {
+    /**
+     * 全部
+     */
+    ALL = 0,
+    /**
+     * 工作项节点/子任务
+     */
+    workItemNode = 1,
+    /**
+     * 计划表
+     */
+    scheduleTable = 2
+}
+declare enum WorkItemNodeType {
+    Node = "node",
+    SubTask = "sub_task",
+    SubWorkItem = "sub_workitem",
+    SubInstance = "sub_instance"
+}
+interface WorkItemInfo {
+    spaceId: string;
+    workObjectId: string;
+    workItemId: number;
+}
+type ComponentScheduleIdentity = WorkItemInfo & {
+    type: WorkItemNodeType;
+    nodeId: string;
+    taskId: string;
+};
+interface WbsStatus {
+    wbsStatus: string;
+}
+interface UserInfo {
+    userKey: string;
+}
+type ScheduleCompValueType = string[];
+/**
+ *  schedule 组件类型校验返回值
+ */
+interface ScheduleCompValidateMsg {
+    code: 200 | number;
+    msg: string;
+}
+/** ----------------------- 拓展点位通用类型 ----------------------- */
+/**
+ * 自定义组件构成
+ * 支持的定义组件类型
+ */
+declare enum CustomComponentType {
+    Schedule = "schedule"
+}
+/**
+ * 自定义组件构成
+ * 允许用户定制指定业务组件类型的UI
+ */
+interface CustomComponentFeatureContext<I extends {
+    /**
+     * 组件节点标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单/计划表内，该字段才有数据
+     */
+    nodeId?: string;
+    /**
+     * 组件子任务标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单/计划表内，该字段才有数据
+     */
+    taskId?: string;
+}, S extends ComponentScheduleScene> {
+    /**
+     * 组件所处场景
+     */
+    scene: S;
+    /**
+     * 组件当前所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 组件当前所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 组件当前所属工作项实例标识
+     * 新建页表单内该值为空
+     */
+    workItemId?: number;
+    /**
+     * 组件唯一标识
+     * 组件所属节点的所属空间/工作项/工作项实例以及节点任务标识
+     */
+    identity?: I;
+}
+/**
+ * 自定义组件构成
+ * 各业务组件类型拥有的 props
+ */
+interface CustomComponentProps {
+    [CustomComponentType.Schedule]: {
+        value: ScheduleCompValueType;
+        disabled?: boolean;
+    };
+}
 
 /**
  * @internal
@@ -1444,7 +1554,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
@@ -1459,9 +1569,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;
 }
 
 /**
@@ -1482,11 +1615,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 {
     /**
@@ -1505,7 +1650,7 @@ declare abstract class Configuration extends BaseModel {
 
 /**
  * @public
- * 控件
+ * 内嵌页面
  */
 declare abstract class Page extends BaseModel {
     /**
@@ -1524,7 +1669,7 @@ declare abstract class Page extends BaseModel {
 
 /**
  * @public
- * 控件
+ * 详情页
  */
 declare abstract class Tab extends BaseModel {
     /**
@@ -1539,11 +1684,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 {
     /**
@@ -1560,6 +1717,33 @@ declare abstract class View extends BaseModel {
     abstract getContext(): Promise<ViewFeatureContext>;
 }
 
+/**
+ * @public
+ * 自定义组件构成
+ */
+declare abstract class CustomComponent extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    abstract [CustomComponentType.Schedule]: {
+        getProps: () => Promise<CustomComponentProps[CustomComponentType.Schedule]>;
+        /**
+         * 用于监听 props 变更
+         * @param callback 返回 schedule 组件新的 props
+         * @param watchKeys 监听的 key，只能监听属性的 key（不能监听 api key），不传默认监听所有 key。监听的 key 对应的值变更会触发回调
+         * @returns
+         */
+        watch: (callback: (next: CustomComponentProps[CustomComponentType.Schedule]) => void, watchKeys?: (keyof CustomComponentProps[CustomComponentType.Schedule])[]) => Off;
+        getContext: () => Promise<CustomComponentFeatureContext<ComponentScheduleIdentity, ComponentScheduleScene>>;
+        resizeContainer: (width?: number, height?: number) => Promise<undefined>;
+        getWbsStatus?: () => Promise<WbsStatus>;
+        getOwnersInfo?: () => Promise<UserInfo[]>;
+        handleSubmit: (value: ScheduleCompValueType) => Promise<ScheduleCompValidateMsg>;
+        handleCancel: () => Promise<void>;
+    };
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1773,4 +1957,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, Configuration, ConfigurationFeatureContext, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, 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, Shared, Space, Storage, Tab, TabFeatureContext, Toast, ToastOptions, User, Utils, View, 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, 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.6",
+  "version": "2.0.7",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"