@lark-project/js-sdk 0.0.29 → 0.0.30

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 0.0.30（2023/06/27）
+- 「Refactor」FieldType 枚举值与 OpenAPI 对齐
+
 ## 0.0.29 (2023/06/27)
 - 「Add」Space 新增 simpleName 空间域名
 - 「Add」Space BriefWorkObject 新增 apiName 系统标识

package/dist/es/index.js

@@ -242,34 +242,34 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.0.29";
+SDKClient.version = "0.0.30";
 
 // src/types/biz.ts
 var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["unknown"] = "unknown";
   FieldType2["text"] = "text";
-  FieldType2["richText"] = "multi-text";
+  FieldType2["richText"] = "multi_text";
   FieldType2["select"] = "select";
-  FieldType2["multiSelect"] = "multi-select";
-  FieldType2["treeSelect"] = "treeSelect";
-  FieldType2["treeMultiSelect"] = "tree-multi-select";
+  FieldType2["multiSelect"] = "multi_select";
+  FieldType2["treeSelect"] = "tree_select";
+  FieldType2["treeMultiSelect"] = "tree_multi_select";
   FieldType2["radio"] = "radio";
   FieldType2["user"] = "user";
-  FieldType2["multiUser"] = "multi-user";
+  FieldType2["multiUser"] = "multi_user";
   FieldType2["date"] = "date";
   FieldType2["dateRange"] = "schedule";
-  FieldType2["simpleVoting"] = "vote-boolean";
-  FieldType2["singleVoting"] = "vote-option";
-  FieldType2["multiVoting"] = "vote-option-multi";
+  FieldType2["simpleVoting"] = "vote_boolean";
+  FieldType2["singleVoting"] = "vote_option";
+  FieldType2["multiVoting"] = "vote_option_multi";
   FieldType2["link"] = "link";
   FieldType2["number"] = "number";
-  FieldType2["attachment"] = "multi-file";
+  FieldType2["attachment"] = "multi_file";
   FieldType2["bool"] = "bool";
   FieldType2["singleSignal"] = "signal";
-  FieldType2["multiSignal"] = "multi-signal";
+  FieldType2["multiSignal"] = "multi_signal";
   FieldType2["compoundField"] = "compound_field";
-  FieldType2["workitemRelatedSelect"] = "workitem_related_select";
-  FieldType2["workitemRelatedMultiSelect"] = "workitem_related_multi_select";
+  FieldType2["workItemRelatedSelect"] = "work_item_related_select";
+  FieldType2["workItemRelatedMultiSelect"] = "work_item_related_multi_select";
   return FieldType2;
 })(FieldType || {});
 var FlowMode = /* @__PURE__ */ ((FlowMode2) => {

package/dist/lib/index.js

@@ -283,34 +283,34 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "0.0.29";
+SDKClient.version = "0.0.30";
 
 // src/types/biz.ts
 var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["unknown"] = "unknown";
   FieldType2["text"] = "text";
-  FieldType2["richText"] = "multi-text";
+  FieldType2["richText"] = "multi_text";
   FieldType2["select"] = "select";
-  FieldType2["multiSelect"] = "multi-select";
-  FieldType2["treeSelect"] = "treeSelect";
-  FieldType2["treeMultiSelect"] = "tree-multi-select";
+  FieldType2["multiSelect"] = "multi_select";
+  FieldType2["treeSelect"] = "tree_select";
+  FieldType2["treeMultiSelect"] = "tree_multi_select";
   FieldType2["radio"] = "radio";
   FieldType2["user"] = "user";
-  FieldType2["multiUser"] = "multi-user";
+  FieldType2["multiUser"] = "multi_user";
   FieldType2["date"] = "date";
   FieldType2["dateRange"] = "schedule";
-  FieldType2["simpleVoting"] = "vote-boolean";
-  FieldType2["singleVoting"] = "vote-option";
-  FieldType2["multiVoting"] = "vote-option-multi";
+  FieldType2["simpleVoting"] = "vote_boolean";
+  FieldType2["singleVoting"] = "vote_option";
+  FieldType2["multiVoting"] = "vote_option_multi";
   FieldType2["link"] = "link";
   FieldType2["number"] = "number";
-  FieldType2["attachment"] = "multi-file";
+  FieldType2["attachment"] = "multi_file";
   FieldType2["bool"] = "bool";
   FieldType2["singleSignal"] = "signal";
-  FieldType2["multiSignal"] = "multi-signal";
+  FieldType2["multiSignal"] = "multi_signal";
   FieldType2["compoundField"] = "compound_field";
-  FieldType2["workitemRelatedSelect"] = "workitem_related_select";
-  FieldType2["workitemRelatedMultiSelect"] = "workitem_related_multi_select";
+  FieldType2["workItemRelatedSelect"] = "work_item_related_select";
+  FieldType2["workItemRelatedMultiSelect"] = "work_item_related_multi_select";
   return FieldType2;
 })(FieldType || {});
 var FlowMode = /* @__PURE__ */ ((FlowMode2) => {

package/dist/types/index.d.ts

@@ -59,9 +59,7 @@ interface User {
 /**
  * @public
  * 字段类型枚举
- *
- * @privateRemarks
- * 仅枚举产品功能上允许用户新建的字段类型
+ * 仅包含字段管理模块支持新建的字段类型
  */
 declare enum FieldType {
     /**
@@ -78,7 +76,7 @@ declare enum FieldType {
     /**
      * 富文本
      */
-    richText = "multi-text",
+    richText = "multi_text",
     /**
      * 单项选择
      */
@@ -86,15 +84,15 @@ declare enum FieldType {
     /**
      * 多项选择
      */
-    multiSelect = "multi-select",
+    multiSelect = "multi_select",
     /**
      * 级联单选
      */
-    treeSelect = "treeSelect",
+    treeSelect = "tree_select",
     /**
      * 级联多选
      */
-    treeMultiSelect = "tree-multi-select",
+    treeMultiSelect = "tree_multi_select",
     /**
      * 单选按钮
      */
@@ -106,7 +104,7 @@ declare enum FieldType {
     /**
      * 多选人员
      */
-    multiUser = "multi-user",
+    multiUser = "multi_user",
     /**
      * 日期（日期 + 时间）
      *
@@ -119,17 +117,17 @@ declare enum FieldType {
      */
     dateRange = "schedule",
     /**
-     * 简单投票
+     * 表态投票
      */
-    simpleVoting = "vote-boolean",
+    simpleVoting = "vote_boolean",
     /**
      * 单选投票
      */
-    singleVoting = "vote-option",
+    singleVoting = "vote_option",
     /**
      * 多选投票
      */
-    multiVoting = "vote-option-multi",
+    multiVoting = "vote_option_multi",
     /**
      * 超链接
      */
@@ -141,19 +139,19 @@ declare enum FieldType {
     /**
      * 附件
      */
-    attachment = "multi-file",
+    attachment = "multi_file",
     /**
      * 开关
      */
     bool = "bool",
     /**
-     * 单信号
+     * 系统外信号
      */
     singleSignal = "signal",
     /**
-     * 多信号
+     * 多值系统外信号
      */
-    multiSignal = "multi-signal",
+    multiSignal = "multi_signal",
     /**
      * 复合字段
      */
@@ -161,11 +159,11 @@ declare enum FieldType {
     /**
      * 单选关联工作项
      */
-    workitemRelatedSelect = "workitem_related_select",
+    workItemRelatedSelect = "work_item_related_select",
     /**
      * 多选关联工作项
      */
-    workitemRelatedMultiSelect = "workitem_related_multi_select"
+    workItemRelatedMultiSelect = "work_item_related_multi_select"
 }
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-project/js-sdk",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"