@lark-project/js-sdk 2.0.8-dev.3 → 2.0.8-dev.5

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 ## 2.0.8 (2025/03/20)
 - 「Add」新增 Button 计划表单元按钮 Context
 - 「Add」新增 Button 视图批量按钮 Context
+- 「Add」新增 ContainerModal 关闭时配置二次确认弹窗
+- 「Deprecated」弃用 Context activeWorkItem
 ## 2.0.7 (2025/01/23)
 - 「Add」新增 Control onWorkItemFormValueChanged / getDisplayInfo / openFullScreenPlugin
 - 「Add」新增 Button onWorkItemFormValueChanged

package/dist/es/index.js

@@ -440,16 +440,6 @@ _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]];
@@ -634,7 +624,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.8-dev.3";
+SDKClient.version = "2.0.8-dev.5";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -715,19 +705,11 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
   CustomComponentType2["Schedule"] = "schedule";
   return CustomComponentType2;
 })(CustomComponentType || {});
-var SubFieldType = /* @__PURE__ */ ((SubFieldType2) => {
-  SubFieldType2["FieldNumber"] = "number";
-  SubFieldType2["FieldMultiText"] = "text";
-  SubFieldType2["FieldTreeSelect"] = "tree-multi-select";
-  SubFieldType2["FieldDatePrecise"] = "date";
-  SubFieldType2["FieldMultiUser"] = "multi-user";
-  return SubFieldType2;
-})(SubFieldType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
   constructor(options) {
-    super(options.message);
+    super(`${options.message}, ${options.originMessage}`);
     this.originMessage = options.originMessage;
   }
 };
@@ -783,19 +765,7 @@ var InvalidParamsError = class extends CustomError {
       message: "invalid params error",
       originMessage: options.originMessage
     });
-    this.errCode = -1;
-    this.errMsg = "unkown error";
     this.name = "InvalidParamsError";
-    this._parseErrorCode();
-  }
-  _parseErrorCode() {
-    try {
-      const { errCode, errMsg } = JSON.parse(this.originMessage);
-      this.errCode = errCode;
-      this.errMsg = errMsg;
-    } catch (e) {
-      this.errMsg = this.originMessage;
-    }
   }
 };
 
@@ -825,7 +795,6 @@ export {
   Control,
   CustomComponent,
   CustomComponentType,
-  ExField,
   Field,
   FieldType,
   FlowMode,
@@ -848,7 +817,6 @@ export {
   Shared,
   Space,
   Storage,
-  SubFieldType,
   Tab,
   Toast,
   Utils,

package/dist/lib/index.js

@@ -60,7 +60,6 @@ __export(src_exports, {
   Control: () => Control,
   CustomComponent: () => CustomComponent,
   CustomComponentType: () => CustomComponentType,
-  ExField: () => ExField,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
@@ -83,7 +82,6 @@ __export(src_exports, {
   Shared: () => Shared,
   Space: () => Space,
   Storage: () => Storage,
-  SubFieldType: () => SubFieldType,
   Tab: () => Tab,
   Toast: () => Toast,
   Utils: () => Utils,
@@ -507,16 +505,6 @@ _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]];
@@ -701,7 +689,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.8-dev.3";
+SDKClient.version = "2.0.8-dev.5";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -782,19 +770,11 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
   CustomComponentType2["Schedule"] = "schedule";
   return CustomComponentType2;
 })(CustomComponentType || {});
-var SubFieldType = /* @__PURE__ */ ((SubFieldType2) => {
-  SubFieldType2["FieldNumber"] = "number";
-  SubFieldType2["FieldMultiText"] = "text";
-  SubFieldType2["FieldTreeSelect"] = "tree-multi-select";
-  SubFieldType2["FieldDatePrecise"] = "date";
-  SubFieldType2["FieldMultiUser"] = "multi-user";
-  return SubFieldType2;
-})(SubFieldType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
   constructor(options) {
-    super(options.message);
+    super(`${options.message}, ${options.originMessage}`);
     this.originMessage = options.originMessage;
   }
 };
@@ -850,19 +830,7 @@ var InvalidParamsError = class extends CustomError {
       message: "invalid params error",
       originMessage: options.originMessage
     });
-    this.errCode = -1;
-    this.errMsg = "unkown error";
     this.name = "InvalidParamsError";
-    this._parseErrorCode();
-  }
-  _parseErrorCode() {
-    try {
-      const { errCode, errMsg } = JSON.parse(this.originMessage);
-      this.errCode = errCode;
-      this.errMsg = errMsg;
-    } catch (e) {
-      this.errMsg = this.originMessage;
-    }
   }
 };
 
@@ -893,7 +861,6 @@ var src_default = SDKClient;
   Control,
   CustomComponent,
   CustomComponentType,
-  ExField,
   Field,
   FieldType,
   FlowMode,
@@ -916,7 +883,6 @@ var src_default = SDKClient;
   Shared,
   Space,
   Storage,
-  SubFieldType,
   Tab,
   Toast,
   Utils,

package/dist/types/index.d.ts

@@ -697,70 +697,23 @@ 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: string;
-    name: string;
-    children?: ExFieldConfig[];
-}
-interface ExFieldValidateMsg {
-    code: 200 | number;
-    msg: string;
-}
-declare enum SubFieldType {
-    FieldNumber = "number",
-    /**
-     * 开发者后台使用 multi-pure-text 作为 type，
-     * 工作项后端会转为 text + { multi: true }
-     */
-    FieldMultiText = "text",
-    FieldTreeSelect = "tree-multi-select",
+/**
+ * 构成弹窗配置
+ */
+interface ContainerModalConfigureOptions {
     /**
-     * 开发者后台使用 precise_date 作为 type，
-     * 工作项后端会转为 date + format "YYYY-MM-DD HH:mm:ss"
-     * （普通为 YYYY-MM-DD）
+     * 关闭前确认
      */
-    FieldDatePrecise = "date",
-    FieldMultiUser = "multi-user"
+    confirmBeforeClose?: {
+        /**
+         * 弹窗标题，仅支持字符串
+         */
+        title: string;
+        /**
+         * 弹窗内容，仅支持字符串
+         */
+        content: string;
+    };
 }
 
 /**
@@ -823,6 +776,7 @@ declare abstract class Context extends BaseModel {
      */
     abstract loginUser: User;
     /**
+     * @deprecated 请使用各功能构成的上下文读取当前的工作项信息，如 JSSDK.Button.getContext()
      * 当前打开的工作项（仅工作项详情页可用）
      */
     abstract activeWorkItem?: BriefWorkItem;
@@ -1092,6 +1046,13 @@ declare abstract class Navigation extends BaseModel {
      */
     private static load;
     /**
+     * @public
+     * only web 2.0
+     * 读取当前页面地址的 origin
+     */
+    abstract getOrigin(): Promise<string>;
+    /**
+     *
      * 读取当前完整的页面地址
      */
     abstract getHref(): Promise<string>;
@@ -1633,6 +1594,11 @@ declare abstract class ContainerModal extends BaseModel {
      * 关闭插件当前激活的容器模态框
      */
     abstract close(): Promise<void>;
+    /**
+     * only web 2.0
+     * 配置当前弹窗，如点击关闭时是否需要确认
+     */
+    abstract configure(options: ContainerModalConfigureOptions): Promise<void>;
 }
 
 /**
@@ -1874,70 +1840,6 @@ 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)[]) => 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 的配置项
@@ -2127,12 +2029,9 @@ declare class OutOfLimitError extends CustomError {
  * 请求参数异常
  */
 declare class InvalidParamsError extends CustomError {
-    errCode: number;
-    errMsg: string;
     constructor(options: {
         originMessage: string;
     });
-    _parseErrorCode(): void;
 }
 
 /**
@@ -2154,4 +2053,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, 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 };
+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, 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, ScheduleUnitButtonFeatureContext, 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.8-dev.3",
+  "version": "2.0.8-dev.5",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"