@lark-project/js-sdk 2.0.1-dev.21 → 2.0.2-alpha.0

package/dist/es/index.js

@@ -51,7 +51,7 @@ _a = IMPL_KEY;
 /**
  * @internal
  */
-Context[_a] = "Context";
+Context[_a] = "context";
 
 // src/model/Space.ts
 var _a2;
@@ -306,7 +306,7 @@ _a15 = IMPL_KEY;
 /**
  * @internal
  */
-ContainerModal[_a15] = "ContainerModal";
+ContainerModal[_a15] = "containerModal";
 
 // src/features/Intercept.ts
 var _a16;
@@ -322,7 +322,7 @@ _a16 = IMPL_KEY;
 /**
  * @internal
  */
-Intercept[_a16] = "Intercept";
+Intercept[_a16] = "intercept";
 
 // src/features/Control.ts
 var _a17;
@@ -338,7 +338,7 @@ _a17 = IMPL_KEY;
 /**
  * @internal
  */
-Control[_a17] = "Control";
+Control[_a17] = "control";
 
 // src/features/Button.ts
 var _a18;
@@ -354,7 +354,71 @@ _a18 = IMPL_KEY;
 /**
  * @internal
  */
-Button[_a18] = "Button";
+Button[_a18] = "button";
+
+// src/features/Configuration.ts
+var _a19;
+var Configuration = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a19 = IMPL_KEY;
+/**
+ * @internal
+ */
+Configuration[_a19] = "configuration";
+
+// src/features/Page.ts
+var _a20;
+var Page = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a20 = IMPL_KEY;
+/**
+ * @internal
+ */
+Page[_a20] = "page";
+
+// src/features/Tab.ts
+var _a21;
+var Tab = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a21 = IMPL_KEY;
+/**
+ * @internal
+ */
+Tab[_a21] = "tab";
+
+// src/features/View.ts
+var _a22;
+var View = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a22 = IMPL_KEY;
+/**
+ * @internal
+ */
+View[_a22] = "view";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -392,6 +456,34 @@ var _SDKClient = class {
   get button() {
     return getImplValue(Button, this._meegoBizHub);
   }
+  /**
+   * 配置点位容器特有能力
+   * only 2.0
+   */
+  get configuration() {
+    return getImplValue(Configuration, this._meegoBizHub);
+  }
+  /**
+   * 导航点位容器特有能力
+   * only 2.0
+   */
+  get page() {
+    return getImplValue(Page, this._meegoBizHub);
+  }
+  /**
+   * tab 点位容器特有能力
+   * only 2.0
+   */
+  get tab() {
+    return getImplValue(Tab, this._meegoBizHub);
+  }
+  /**
+   * 视图点位容器特有能力
+   * only 2.0
+   */
+  get view() {
+    return getImplValue(View, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -505,7 +597,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-dev.21";
+SDKClient.version = "2.0.2-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -515,6 +607,7 @@ var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
 })(AttributeType || {});
 var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["unknown"] = "unknown";
+  FieldType2["control"] = "control";
   FieldType2["text"] = "text";
   FieldType2["richText"] = "multi_text";
   FieldType2["select"] = "select";
@@ -658,6 +751,7 @@ export {
   Button,
   ButtonScene,
   Clipboard,
+  Configuration,
   ContainerModal,
   Context,
   Control,
@@ -677,12 +771,15 @@ export {
   NotFoundError,
   NotSupportedError,
   OutOfLimitError,
+  Page,
   RichTextEditor,
   SDKClient,
   Space,
   Storage,
+  Tab,
   Toast,
   Utils,
+  View,
   WorkItem,
   WorkItemFinder,
   WorkObject,

package/dist/lib/index.js

@@ -53,6 +53,7 @@ __export(src_exports, {
   Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
+  Configuration: () => Configuration,
   ContainerModal: () => ContainerModal,
   Context: () => Context,
   Control: () => Control,
@@ -72,12 +73,15 @@ __export(src_exports, {
   NotFoundError: () => NotFoundError,
   NotSupportedError: () => NotSupportedError,
   OutOfLimitError: () => OutOfLimitError,
+  Page: () => Page,
   RichTextEditor: () => RichTextEditor,
   SDKClient: () => SDKClient,
   Space: () => Space,
   Storage: () => Storage,
+  Tab: () => Tab,
   Toast: () => Toast,
   Utils: () => Utils,
+  View: () => View,
   WorkItem: () => WorkItem,
   WorkItemFinder: () => WorkItemFinder,
   WorkObject: () => WorkObject,
@@ -108,7 +112,7 @@ _a = IMPL_KEY;
 /**
  * @internal
  */
-Context[_a] = "Context";
+Context[_a] = "context";
 
 // src/model/Space.ts
 var _a2;
@@ -363,7 +367,7 @@ _a15 = IMPL_KEY;
 /**
  * @internal
  */
-ContainerModal[_a15] = "ContainerModal";
+ContainerModal[_a15] = "containerModal";
 
 // src/features/Intercept.ts
 var _a16;
@@ -379,7 +383,7 @@ _a16 = IMPL_KEY;
 /**
  * @internal
  */
-Intercept[_a16] = "Intercept";
+Intercept[_a16] = "intercept";
 
 // src/features/Control.ts
 var _a17;
@@ -395,7 +399,7 @@ _a17 = IMPL_KEY;
 /**
  * @internal
  */
-Control[_a17] = "Control";
+Control[_a17] = "control";
 
 // src/features/Button.ts
 var _a18;
@@ -411,7 +415,71 @@ _a18 = IMPL_KEY;
 /**
  * @internal
  */
-Button[_a18] = "Button";
+Button[_a18] = "button";
+
+// src/features/Configuration.ts
+var _a19;
+var Configuration = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a19 = IMPL_KEY;
+/**
+ * @internal
+ */
+Configuration[_a19] = "configuration";
+
+// src/features/Page.ts
+var _a20;
+var Page = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a20 = IMPL_KEY;
+/**
+ * @internal
+ */
+Page[_a20] = "page";
+
+// src/features/Tab.ts
+var _a21;
+var Tab = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a21 = IMPL_KEY;
+/**
+ * @internal
+ */
+Tab[_a21] = "tab";
+
+// src/features/View.ts
+var _a22;
+var View = class extends BaseModel {
+  /**
+   * 加载数据
+   */
+  static load() {
+    throw new Error("not implemented");
+  }
+};
+_a22 = IMPL_KEY;
+/**
+ * @internal
+ */
+View[_a22] = "view";
 
 // src/client.ts
 function getImplClass(decl, impls) {
@@ -449,6 +517,34 @@ var _SDKClient = class {
   get button() {
     return getImplValue(Button, this._meegoBizHub);
   }
+  /**
+   * 配置点位容器特有能力
+   * only 2.0
+   */
+  get configuration() {
+    return getImplValue(Configuration, this._meegoBizHub);
+  }
+  /**
+   * 导航点位容器特有能力
+   * only 2.0
+   */
+  get page() {
+    return getImplValue(Page, this._meegoBizHub);
+  }
+  /**
+   * tab 点位容器特有能力
+   * only 2.0
+   */
+  get tab() {
+    return getImplValue(Tab, this._meegoBizHub);
+  }
+  /**
+   * 视图点位容器特有能力
+   * only 2.0
+   */
+  get view() {
+    return getImplValue(View, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -562,7 +658,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.1-dev.21";
+SDKClient.version = "2.0.2-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -572,6 +668,7 @@ var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
 })(AttributeType || {});
 var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["unknown"] = "unknown";
+  FieldType2["control"] = "control";
   FieldType2["text"] = "text";
   FieldType2["richText"] = "multi_text";
   FieldType2["select"] = "select";
@@ -716,6 +813,7 @@ var src_default = SDKClient;
   Button,
   ButtonScene,
   Clipboard,
+  Configuration,
   ContainerModal,
   Context,
   Control,
@@ -735,12 +833,15 @@ var src_default = SDKClient;
   NotFoundError,
   NotSupportedError,
   OutOfLimitError,
+  Page,
   RichTextEditor,
   SDKClient,
   Space,
   Storage,
+  Tab,
   Toast,
   Utils,
+  View,
   WorkItem,
   WorkItemFinder,
   WorkObject

package/dist/types/index.d.ts

@@ -40,6 +40,11 @@ declare enum FieldType {
      * 未知字段类型
      */
     unknown = "unknown",
+    /**
+     * 平台控件
+     * e.g. 角色与人员
+     */
+    control = "control",
     /**
      * 文本（单行、多行）
      *
@@ -358,6 +363,16 @@ interface CreateButtonFeatureContext {
      * 空间标识
      */
     spaceId: string;
+    /**
+     * 工作项类型标识
+     * 适用场景：新建按钮出现在视图页时，该字段才有数据
+     */
+    workObjectId?: string;
+    /**
+     * 视图标识
+     * 适用场景：新建按钮出现在视图页时，该字段才有数据
+     */
+    viewId?: string;
 }
 /**
  * 按钮构成
@@ -373,6 +388,15 @@ interface PageFeatureContext {
      */
     spaceId: string;
 }
+/**
+ * 配置页面构成
+ */
+interface ConfigurationFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+}
 /**
  * 详情页 Tab 构成
  * 工作项详情页中的 Tab 页面
@@ -388,6 +412,7 @@ interface TabFeatureContext {
     workObjectId: string;
     /**
      * 工作项实例唯一标识
+     * 适用场景：仅在工作项实例场景下，该字段才有数据，在工作项配置侧该字段为空
      */
     workItemId: number;
 }
@@ -432,6 +457,11 @@ interface ControlFeatureContext {
      * 详情页可能为空，不推荐强依赖 UUID 读取自有数据
      */
     UUID?: string;
+    /**
+     * 当前节点标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单内，该字段才有数据
+     */
+    nodeId?: string;
 }
 /**
  * 拦截事件类型
@@ -497,6 +527,7 @@ interface InterceptFeatureContext<T> {
  * @internal
  */
 type unwatch = () => void;
+type Off = unwatch;
 
 type IIgnore = string | RegExp | ((value: string) => boolean);
 interface IPluginCustomBuildConfig {
@@ -1225,6 +1256,7 @@ declare abstract class WorkItemFinder extends BaseModel {
      */
     private static load;
     /**
+     * only web 2.0
      * 打开工作项实例筛选条件面板
      * @param options
      * @param callback
@@ -1292,6 +1324,7 @@ declare abstract class ContainerModal extends BaseModel {
      */
     abstract submit?: <Params, Result>(params: Params) => Promise<Result>;
     /**
+     * mobile version ≥ 7.22.0
      * 关闭插件当前激活的容器模态框
      */
     abstract close(): Promise<void>;
@@ -1311,6 +1344,7 @@ declare abstract class Intercept extends BaseModel {
      */
     static load(): Promise<Intercept>;
     /**
+     * mobile version ≥ 7.22.0
      * 获取当前触发的拦截事件上下文
      */
     abstract getContext<T = any>(): Promise<InterceptFeatureContext<T>>;
@@ -1330,9 +1364,39 @@ declare abstract class Control extends BaseModel {
      */
     static load(): Promise<Control>;
     /**
-     * 获取当前控件的上下文
+     * mobile version ≥ 7.25.0
+     * 获取当前控件所在的上下文
      */
     abstract getContext(): Promise<ControlFeatureContext>;
+    /**
+     * 获取新建工作项表单项的值
+     * 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>;
+    }>): Promise<Record<string | AttributeType, any>>;
+    /**
+     * only web 2.0
+     * 监听新建工作项表单项值变化
+     * @param options.watchKeys 需要监听的工作项属性 / 字段 ID 列表，一次限制读取 10 个 keys
+     * @param options.watchKeys.key 工作项属性 / 字段 ID
+     * @param options.watchKeys.type 类型
+     *        工作项属性 name 为 FieldType.text，工作项属性 template 为 FieldType.number
+     *        控件 role_owners 为 FieldType.control
+     * @param callback 当监听值发生变化时触发，changedKeys 为变化的 keys
+     */
+    abstract onCreateWorkItemFormValueChanged(options: {
+        watchKeys: Array<{
+            key: string | AttributeType;
+            type: Exclude<FieldType, FieldType.richText | FieldType.singleSignal | FieldType.multiSignal | FieldType.singleVoting | FieldType.multiVoting>;
+        }>;
+    }, callback: (changedKeys: Array<string | AttributeType>) => void): Off;
 }
 
 /**
@@ -1349,11 +1413,88 @@ declare abstract class Button extends BaseModel {
      */
     static load(): Promise<Button>;
     /**
+     * mobile version ≥ 7.24.0
      * 获取当前按钮的上下文
      */
     abstract getContext(): Promise<ButtonFeatureContext>;
 }
 
+/**
+ * @public
+ * 控件
+ */
+declare abstract class Configuration extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Configuration>;
+    /**
+     * 获取当前配置点位的上下文
+     */
+    abstract getContext(): Promise<ConfigurationFeatureContext>;
+}
+
+/**
+ * @public
+ * 控件
+ */
+declare abstract class Page extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Page>;
+    /**
+     * 获取当前内嵌页面的上下文
+     */
+    abstract getContext(): Promise<PageFeatureContext>;
+}
+
+/**
+ * @public
+ * 控件
+ */
+declare abstract class Tab extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<Tab>;
+    /**
+     * 获取当前详情页 Tab 的上下文
+     */
+    abstract getContext(): Promise<TabFeatureContext>;
+}
+
+/**
+ * @public
+ * 控件
+ */
+declare abstract class View extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载数据
+     */
+    static load(): Promise<View>;
+    /**
+     * 获取当前视图的上下文
+     */
+    abstract getContext(): Promise<ViewFeatureContext>;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1391,6 +1532,26 @@ declare class SDKClient {
      * only 2.0
      */
     get button(): Button;
+    /**
+     * 配置点位容器特有能力
+     * only 2.0
+     */
+    get configuration(): Configuration;
+    /**
+     * 导航点位容器特有能力
+     * only 2.0
+     */
+    get page(): Page;
+    /**
+     * tab 点位容器特有能力
+     * only 2.0
+     */
+    get tab(): Tab;
+    /**
+     * 视图点位容器特有能力
+     * only 2.0
+     */
+    get view(): View;
     /**
      * 应用导航
      */
@@ -1542,4 +1703,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, Button, ButtonFeatureContext, ButtonScene, Clipboard, ColorScheme, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalConfirmOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, NotSupportedError, OutOfLimitError, PageFeatureContext, RichTextEditor, RichTextEditorContent, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, TabFeatureContext, Toast, ToastOptions, User, Utils, 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, Configuration, ConfigurationFeatureContext, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, Field, FieldType, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, MEEGO_BIZ_HUB, Modal, ModalConfirmOptions, Navigation, NoAuthError, NodeStatus, NotFoundError, NotSupportedError, Off, OutOfLimitError, Page, PageFeatureContext, RichTextEditor, RichTextEditorContent, RichTextEditorOptions, Role, RoleOwners, SDKClient, SDKClientOptions, Space, Storage, Tab, TabFeatureContext, Toast, ToastOptions, User, Utils, View, ViewFeatureContext, 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.1-dev.21",
+  "version": "2.0.2-alpha.0",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"