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

package/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Change Log
+## 2.0.8 (2025/03/20)
+- 「Add」新增 Button 计划表单元按钮 Context
+- 「Add」新增 Button 视图批量按钮 Context
+- 「Add」新增 ContainerModal 关闭时配置二次确认弹窗
+- 「Add」新增 Navigation.getHostname 获取当前域名
+- 「Deprecated」弃用 Context activeWorkItem
 ## 2.0.7 (2025/01/23)
 - 「Add」新增 Control onWorkItemFormValueChanged / getDisplayInfo / openFullScreenPlugin
 - 「Add」新增 Button onWorkItemFormValueChanged

package/dist/es/index.js

@@ -440,6 +440,16 @@ _a24 = IMPL_KEY;
  */
 CustomComponent[_a24] = "customComponent";
 
+// src/features/ExField.ts
+var _a25;
+var ExField = class extends BaseModel {
+};
+_a25 = IMPL_KEY;
+/**
+ * @internal
+ */
+ExField[_a25] = "exField";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -624,7 +634,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.8-dev.0";
+SDKClient.version = "2.0.8-dev.10";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -709,7 +719,7 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
   constructor(options) {
-    super(options.message);
+    super(`${options.message}, ${options.originMessage}`);
     this.originMessage = options.originMessage;
   }
 };
@@ -765,7 +775,19 @@ var InvalidParamsError = class extends CustomError {
       message: "invalid params error",
       originMessage: options.originMessage
     });
+    this.errCode = -1;
+    this.errMsg = "unkown error";
     this.name = "InvalidParamsError";
+    this.errMsg = this.originMessage;
+    this._parseErrorCode();
+  }
+  _parseErrorCode() {
+    try {
+      const { errCode, errMsg } = JSON.parse(this.originMessage);
+      errCode !== void 0 && (this.errCode = errCode);
+      errMsg !== void 0 && (this.errMsg = errMsg);
+    } catch (e) {
+    }
   }
 };
 
@@ -795,6 +817,7 @@ export {
   Control,
   CustomComponent,
   CustomComponentType,
+  ExField,
   Field,
   FieldType,
   FlowMode,

package/dist/lib/index.js

@@ -60,6 +60,7 @@ __export(src_exports, {
   Control: () => Control,
   CustomComponent: () => CustomComponent,
   CustomComponentType: () => CustomComponentType,
+  ExField: () => ExField,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
@@ -505,6 +506,16 @@ _a24 = IMPL_KEY;
  */
 CustomComponent[_a24] = "customComponent";
 
+// src/features/ExField.ts
+var _a25;
+var ExField = class extends BaseModel {
+};
+_a25 = IMPL_KEY;
+/**
+ * @internal
+ */
+ExField[_a25] = "exField";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -689,7 +700,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.8-dev.0";
+SDKClient.version = "2.0.8-dev.10";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -774,7 +785,7 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
   constructor(options) {
-    super(options.message);
+    super(`${options.message}, ${options.originMessage}`);
     this.originMessage = options.originMessage;
   }
 };
@@ -830,7 +841,19 @@ var InvalidParamsError = class extends CustomError {
       message: "invalid params error",
       originMessage: options.originMessage
     });
+    this.errCode = -1;
+    this.errMsg = "unkown error";
     this.name = "InvalidParamsError";
+    this.errMsg = this.originMessage;
+    this._parseErrorCode();
+  }
+  _parseErrorCode() {
+    try {
+      const { errCode, errMsg } = JSON.parse(this.originMessage);
+      errCode !== void 0 && (this.errCode = errCode);
+      errMsg !== void 0 && (this.errMsg = errMsg);
+    } catch (e) {
+    }
   }
 };
 
@@ -861,6 +884,7 @@ var src_default = SDKClient;
   Control,
   CustomComponent,
   CustomComponentType,
+  ExField,
   Field,
   FieldType,
   FlowMode,

package/dist/types/index.d.ts

@@ -379,6 +379,45 @@ interface CreateButtonFeatureContext {
      */
     viewId?: string;
 }
+interface ScheduleUnitButtonFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+    /**
+     * 工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 工作项实例唯一标识
+     */
+    workItemId: number;
+    /**
+     * 计划表单元上下文信息
+     */
+    scheduleUnitCtx: {
+        /**
+         * 计划表编辑草稿标识
+         */
+        draftId: string;
+        /**
+         * 计划表单元父节点标识
+         */
+        parentUUID: string;
+        /**
+         * 计划表单元标识
+         */
+        uuid: string;
+        /**
+         * 计划表单元类型
+         */
+        type: string;
+        /**
+         * 计划表单元值
+         */
+        value: Record<string, any>;
+    };
+}
 /**
  * 视图批量按钮上下文
  * 适用场景：普通视图、工作项主页视图、工作台视图组件
@@ -408,7 +447,7 @@ interface BatchButtonFeatureContext {
 /**
  * 按钮构成
  */
-type ButtonFeatureContext = WorkItemButtonFeatureContext | CreateButtonFeatureContext | BatchButtonFeatureContext;
+type ButtonFeatureContext = WorkItemButtonFeatureContext | CreateButtonFeatureContext | BatchButtonFeatureContext | ScheduleUnitButtonFeatureContext;
 /**
  * 内嵌页面构成
  * 一个单独的导航入口+内嵌页面
@@ -658,6 +697,106 @@ interface CustomComponentProps {
         disabled?: boolean;
     };
 }
+/** ----------------------- 拓展字段构成类型 ----------------------- */
+interface ExFieldFeatureContext {
+    /**
+     * 拓展字段当前所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 拓展字段当前所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 拓展字段当前所属工作项实例标识
+     * 新建页表单内该值为空
+     */
+    workItemId?: number;
+    /**
+     * 当前节点标识
+     * 适用场景：详情页为节点流时，且当前拓展字段位于节点表单内，该字段才有数据
+     */
+    nodeId?: string;
+}
+type FieldNumberValue = number;
+type FieldMultiTextValue = string;
+type FieldTreeSelectOptionValue = string[];
+type FieldDatePreciseValue = string | number;
+type FieldMultiUserValue = string[];
+type FieldValue = FieldNumberValue | FieldMultiTextValue | FieldTreeSelectOptionValue | FieldDatePreciseValue | FieldMultiUserValue;
+interface ExCompoundFieldValueType {
+    field_key: string;
+    field_value: {
+        field_key: string;
+        value?: FieldValue;
+    }[][];
+}
+type ExFieldValueType = ExCompoundFieldValueType;
+interface ExFieldProps {
+    value: ExFieldValueType;
+    disabled?: boolean;
+}
+interface ExFieldConfig {
+    key: string;
+    type: FieldType.compoundField | SubFieldType;
+    name: string;
+    children?: ExFieldConfig[];
+}
+interface ExFieldValidateMsg {
+    /**
+     * code 为 200 时 msg 按照正常成功数据返回外
+     * 401 | 402 | 403 | 404 | 405 | 406 按照 InvalidParams 类型异常返回，可以通过该异常的 errCode、errMsg 属性查看具体出错原因
+     * 其余执行过程异常按照 InternalError 异常抛出
+     * 具体的 code 和对应的 msg 信息及解释可参考开发者手册的详细介绍
+     */
+    code: 200 | 401 | 402 | 403 | 404 | 405 | 406;
+    msg: string;
+}
+type SubFieldType = 
+/**
+ * 数字类型
+ */
+FieldType.number
+/**
+ * 多行文本
+ * 字段类型为 text
+ * 在字段模型中和单行文本字段的区别为 multi = true
+ */
+ | FieldType.text
+/**
+ * 级联多选
+ * 如果写入不存在的选项可能导致接口报错/提示
+ */
+ | FieldType.treeMultiSelect
+/**
+ * 时间+日期
+ * 字段类型为 date
+ * 在字段模型中和普通日期字段的区别是本时间精确度为 "YYYY-MM-DD HH:mm:ss"（普通为 YYYY-MM-DD）
+ */
+ | FieldType.date
+/**
+ * 多选人员
+ * 如果写入不存在的人员可能导致接口报错/提示
+ */
+ | FieldType.multiUser;
+/**
+ * 构成弹窗配置
+ */
+interface ContainerModalConfigureOptions {
+    /**
+     * 关闭前确认
+     */
+    confirmBeforeClose?: {
+        /**
+         * 弹窗标题，仅支持字符串
+         */
+        title: string;
+        /**
+         * 弹窗内容，仅支持字符串
+         */
+        content: string;
+    };
+}
 
 /**
  * @internal
@@ -719,6 +858,7 @@ declare abstract class Context extends BaseModel {
      */
     abstract loginUser: User;
     /**
+     * @deprecated 请使用各功能构成的上下文读取当前的工作项信息，如 JSSDK.Button.getContext()
      * 当前打开的工作项（仅工作项详情页可用）
      */
     abstract activeWorkItem?: BriefWorkItem;
@@ -988,6 +1128,14 @@ declare abstract class Navigation extends BaseModel {
      */
     private static load;
     /**
+     * @public
+     * mobile version ≥ 7.41.0
+     * 读取当前页面地址的 hostname
+     */
+    abstract getHostname(): Promise<string>;
+    /**
+     * @public
+     * only web 2.0
      * 读取当前完整的页面地址
      */
     abstract getHref(): Promise<string>;
@@ -1529,6 +1677,11 @@ declare abstract class ContainerModal extends BaseModel {
      * 关闭插件当前激活的容器模态框
      */
     abstract close(): Promise<void>;
+    /**
+     * only web 2.0
+     * 配置当前弹窗，如点击关闭时是否需要确认
+     */
+    abstract configure(options: ContainerModalConfigureOptions): Promise<void>;
 }
 
 /**
@@ -1770,6 +1923,70 @@ declare abstract class CustomComponent extends BaseModel {
     };
 }
 
+/**
+ * @public
+ * 自定义组件构成
+ */
+declare abstract class ExField extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    abstract getContext: () => Promise<ExFieldFeatureContext>;
+    abstract getProps: () => Promise<ExFieldProps>;
+    /**
+     * only for form
+     * 用于监听 props 变更
+     * @param callback 返回插件字段新的 props
+     * @param watchKeys 监听的 key，只能监听属性的 key（不能监听 api key），不传默认监听所有 key。监听的 key 对应的值变更会触发回调
+     * @returns
+     */
+    abstract watch: (callback: (next: ExFieldProps | Record<string, never>) => void, watchKeys?: (keyof ExFieldProps)[]) => Promise<Off>;
+    abstract saveFieldValue: (value: ExFieldValueType) => Promise<ExFieldValidateMsg>;
+    abstract getFieldConfig: () => Promise<ExFieldConfig>;
+    /**
+     * 获取新建工作项表单项的值
+     * mobile version ≥ 7.29.0
+     * @param keys 需要获取的工作项属性 / 字段 ID 列表，一次限制读取 10 个 keys
+     * @param keys.key 工作项属性 / 字段 ID
+     * @param keys.type 类型
+     *        工作项属性 name 为 FieldType.text，工作项属性 template 为 FieldType.number
+     *        控件 role_owners 为 FieldType.control
+     */
+    abstract getCreateWorkItemFormItemValues(keys: Array<{
+        key: string | AttributeType;
+        type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting | FieldType.simpleVoting>;
+    }>): Promise<Record<string | AttributeType, any>>;
+    /**
+     * 监听工作项表单项值变化
+     * @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 web for table
+     * 打开全屏插件
+     */
+    abstract getTableCellInitProps(): Promise<ExFieldProps>;
+    /**
+     * only mobile 7.35.0+
+     * 获取插件的展示态信息
+     */
+    abstract getDisplayInfo(): Promise<{
+        display_height: number;
+    }>;
+    /**
+     * only mobile 7.35.0+
+     * 打开全屏插件
+     */
+    abstract openFullScreenPlugin(): void;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1959,9 +2176,12 @@ declare class OutOfLimitError extends CustomError {
  * 请求参数异常
  */
 declare class InvalidParamsError extends CustomError {
+    errCode: number;
+    errMsg: string;
     constructor(options: {
         originMessage: string;
     });
+    _parseErrorCode(): void;
 }
 
 /**
@@ -1983,4 +2203,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-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 };
+export { ActionSheet, ActionSheetOptions, AttributeType, BatchButtonFeatureContext, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, ComponentScheduleIdentity, ComponentScheduleScene, Configuration, ConfigurationFeatureContext, ContainerModal, ContainerModalConfigureOptions, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, CustomComponentType, ExCompoundFieldValueType, ExField, ExFieldConfig, ExFieldFeatureContext, ExFieldProps, ExFieldValidateMsg, ExFieldValueType, Field, FieldType, FieldValue, 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, ScheduleUnitButtonFeatureContext, Shared, Space, Storage, SubFieldType, 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.8-dev.0",
+  "version": "2.0.8-dev.10",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"