@lark-project/js-sdk 2.0.9-dev.2 → 2.0.9

package/dist/es/index.js

@@ -440,15 +440,15 @@ _a24 = IMPL_KEY;
  */
 CustomComponent[_a24] = "customComponent";
 
-// src/features/CustomField.ts
+// src/features/ExField.ts
 var _a25;
-var CustomField = class extends BaseModel {
+var ExField = class extends BaseModel {
 };
 _a25 = IMPL_KEY;
 /**
  * @internal
  */
-CustomField[_a25] = "exField";
+ExField[_a25] = "exField";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -634,7 +634,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.9-dev.2";
+SDKClient.version = "2.0.9";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -715,6 +715,14 @@ 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 {
@@ -817,7 +825,7 @@ export {
   Control,
   CustomComponent,
   CustomComponentType,
-  CustomField,
+  ExField,
   Field,
   FieldType,
   FlowMode,
@@ -840,6 +848,7 @@ export {
   Shared,
   Space,
   Storage,
+  SubFieldType,
   Tab,
   Toast,
   Utils,

package/dist/lib/index.js

@@ -60,7 +60,7 @@ __export(src_exports, {
   Control: () => Control,
   CustomComponent: () => CustomComponent,
   CustomComponentType: () => CustomComponentType,
-  CustomField: () => CustomField,
+  ExField: () => ExField,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
@@ -83,6 +83,7 @@ __export(src_exports, {
   Shared: () => Shared,
   Space: () => Space,
   Storage: () => Storage,
+  SubFieldType: () => SubFieldType,
   Tab: () => Tab,
   Toast: () => Toast,
   Utils: () => Utils,
@@ -506,15 +507,15 @@ _a24 = IMPL_KEY;
  */
 CustomComponent[_a24] = "customComponent";
 
-// src/features/CustomField.ts
+// src/features/ExField.ts
 var _a25;
-var CustomField = class extends BaseModel {
+var ExField = class extends BaseModel {
 };
 _a25 = IMPL_KEY;
 /**
  * @internal
  */
-CustomField[_a25] = "exField";
+ExField[_a25] = "exField";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -700,7 +701,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.9-dev.2";
+SDKClient.version = "2.0.9";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -781,6 +782,14 @@ 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 {
@@ -884,7 +893,7 @@ var src_default = SDKClient;
   Control,
   CustomComponent,
   CustomComponentType,
-  CustomField,
+  ExField,
   Field,
   FieldType,
   FlowMode,
@@ -907,6 +916,7 @@ var src_default = SDKClient;
   Shared,
   Space,
   Storage,
+  SubFieldType,
   Tab,
   Toast,
   Utils,

package/dist/types/index.d.ts

@@ -698,7 +698,7 @@ interface CustomComponentProps {
     };
 }
 /** ----------------------- 拓展字段构成类型 ----------------------- */
-interface CustomFieldFeatureContext {
+interface ExFieldFeatureContext {
     /**
      * 拓展字段当前所属空间标识
      */
@@ -731,54 +731,55 @@ interface ExCompoundFieldValueType {
         value?: FieldValue;
     }[][];
 }
-type CustomFieldValueType = ExCompoundFieldValueType;
-interface CustomFieldProps {
-    value: CustomFieldValueType;
+type ExFieldValueType = ExCompoundFieldValueType;
+interface ExFieldProps {
+    value: ExFieldValueType;
     disabled?: boolean;
 }
-interface CustomFieldConfig {
+interface ExFieldConfig {
     key: string;
-    type: FieldType.compoundField | SubFieldType;
+    type: string;
     name: string;
-    children?: CustomFieldConfig[];
+    children?: ExFieldConfig[];
 }
-interface CustomFieldValidateMsg {
+interface ExFieldValidateMsg {
     /**
      * code 为 200 时 msg 按照正常成功数据返回外
-     * 401 | 402 | 403 | 404 | 405 | 406 按照 InvalidParams 类型异常返回，可以通过该异常的 errCode、errMsg 属性查看具体出错原因
+     * 401 | 401 | 403 | 404 | 405 | 406 按照 InvalidParams 类型异常返回，可以通过该异常的 errCode、errMsg 属性查看具体出错原因
      * 其余执行过程异常按照 InternalError 异常抛出
      * 具体的 code 和对应的 msg 信息及解释可参考开发者手册的详细介绍
      */
-    code: 200 | 401 | 402 | 403 | 404 | 405 | 406;
+    code: 200 | 401 | 401 | 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;
+declare enum SubFieldType {
+    /**
+     * 数字类型
+     */
+    FieldNumber = "number",
+    /**
+     * 多行文本
+     * 字段类型为 text
+     * 在字段模型中和单行文本字段的区别为 multi = true
+     */
+    FieldMultiText = "text",
+    /**
+     * 级联多选
+     * 如果写入不存在的选项可能导致接口报错/提示
+     */
+    FieldTreeSelect = "tree-multi-select",
+    /**
+     * 时间+日期
+     * 字段类型为 date
+     * 在字段模型中和普通日期字段的区别是本时间精确度为 "YYYY-MM-DD HH:mm:ss"（普通为 YYYY-MM-DD）
+     */
+    FieldDatePrecise = "date",
+    /**
+     * 多选人员
+     * 如果写入不存在的人员可能导致接口报错/提示
+     */
+    FieldMultiUser = "multi-user"
+}
 /**
  * 构成弹窗配置
  */
@@ -1148,14 +1149,19 @@ declare abstract class Navigation extends BaseModel {
     /**
      * 打开指定空间工作项新建页
      * @param options
-     * @param options.spaceSimpleName 空间标识，非空间唯一标识
+     * @param options.spaceId 空间唯一标识
+     * @param options.spaceSimpleName [废弃]空间标识，非空间唯一标识
      * @param options.workObjectId 工作项类型唯一标识，如 story、issue
      * @param options.supportedWorkObjectIds 新建页支持切换的工作项类型列表，默认所有都展示
      * @param options.formPreset 新建工作项表单预填值
      * @param callback 新建完成回调，当 err 为 undefined 时为新建成功，可以通过 result.workItemId 取新建工作项实例 id
      */
     abstract openWorkItemCreatePage(options: {
-        spaceSimpleName: string;
+        spaceId: string;
+        /**
+         * @deprecated
+         */
+        spaceSimpleName?: string;
         workObjectId: string;
         supportedWorkObjectIds?: string[];
         formPreset?: WorkItemCreateFormPreset;
@@ -1165,12 +1171,17 @@ declare abstract class Navigation extends BaseModel {
     /**
      * 打开指定空间工作项实例
      * @param options
-     * @param options.spaceSimpleName 空间标识，非空间唯一标识
+     * @param options.spaceId 空间唯一标识
+     * @param options.spaceSimpleName [废弃]空间标识，非空间唯一标识
      * @param options.workObjectId 工作项类型唯一标识，如 story、issue
      * @param options.workItemId 工作项实例唯一标识
      */
     abstract openWorkItemDetailPage(options: {
-        spaceSimpleName: string;
+        spaceId: string;
+        /**
+         * @deprecated
+         */
+        spaceSimpleName?: string;
         workObjectId: string;
         workItemId: number;
     }): void;
@@ -1927,13 +1938,13 @@ declare abstract class CustomComponent extends BaseModel {
  * @public
  * 自定义组件构成
  */
-declare abstract class CustomField extends BaseModel {
+declare abstract class ExField extends BaseModel {
     /**
      * @internal
      */
     protected static [IMPL_KEY]: string;
-    abstract getContext: () => Promise<CustomFieldFeatureContext>;
-    abstract getProps: () => Promise<CustomFieldProps>;
+    abstract getContext: () => Promise<ExFieldFeatureContext>;
+    abstract getProps: () => Promise<ExFieldProps>;
     /**
      * only for form
      * 用于监听 props 变更
@@ -1941,9 +1952,9 @@ declare abstract class CustomField extends BaseModel {
      * @param watchKeys 监听的 key，只能监听属性的 key（不能监听 api key），不传默认监听所有 key。监听的 key 对应的值变更会触发回调
      * @returns
      */
-    abstract watch: (callback: (next: CustomFieldProps | Record<string, never>) => void, watchKeys?: (keyof CustomFieldProps)[]) => Promise<Off>;
-    abstract saveFieldValue: (value: CustomFieldValueType) => Promise<CustomFieldValidateMsg>;
-    abstract getFieldConfig: () => Promise<CustomFieldConfig>;
+    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
@@ -1972,7 +1983,7 @@ declare abstract class CustomField extends BaseModel {
      * only web for table
      * 打开全屏插件
      */
-    abstract getTableCellInitProps(): Promise<CustomFieldProps>;
+    abstract getTableCellInitProps(): Promise<ExFieldProps>;
     /**
      * only mobile 7.35.0+
      * 获取插件的展示态信息
@@ -2203,4 +2214,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, ContainerModalConfigureOptions, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, CustomComponentType, CustomField, CustomFieldConfig, CustomFieldFeatureContext, CustomFieldProps, CustomFieldValidateMsg, CustomFieldValueType, ExCompoundFieldValueType, 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, 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.9-dev.2",
+  "version": "2.0.9",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"