@lark-project/js-sdk 2.0.4-dev.0 → 2.0.4-dev.1

package/dist/es/index.js

@@ -430,6 +430,16 @@ _a23 = IMPL_KEY;
  */
 View[_a23] = "view";
 
+// src/features/CustomComponent.ts
+var _a24;
+var CustomComponent = class extends BaseModel {
+};
+_a24 = IMPL_KEY;
+/**
+ * @internal
+ */
+CustomComponent[_a24] = "customComponent";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -614,7 +624,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.4-dev.0";
+SDKClient.version = "2.0.4-dev.1";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -685,6 +695,16 @@ var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
   InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
   return InterceptEvent2;
 })(InterceptEvent || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
+var CustomComponentScene = /* @__PURE__ */ ((CustomComponentScene2) => {
+  CustomComponentScene2[CustomComponentScene2["ALL"] = 0] = "ALL";
+  CustomComponentScene2[CustomComponentScene2["workItemNode"] = 1] = "workItemNode";
+  CustomComponentScene2[CustomComponentScene2["scheduleTable"] = 2] = "scheduleTable";
+  return CustomComponentScene2;
+})(CustomComponentScene || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -772,6 +792,9 @@ export {
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentScene,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/lib/index.js

@@ -57,6 +57,9 @@ __export(src_exports, {
   ContainerModal: () => ContainerModal,
   Context: () => Context,
   Control: () => Control,
+  CustomComponent: () => CustomComponent,
+  CustomComponentScene: () => CustomComponentScene,
+  CustomComponentType: () => CustomComponentType,
   Field: () => Field,
   FieldType: () => FieldType,
   FlowMode: () => FlowMode,
@@ -492,6 +495,16 @@ _a23 = IMPL_KEY;
  */
 View[_a23] = "view";
 
+// src/features/CustomComponent.ts
+var _a24;
+var CustomComponent = class extends BaseModel {
+};
+_a24 = IMPL_KEY;
+/**
+ * @internal
+ */
+CustomComponent[_a24] = "customComponent";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -676,7 +689,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.4-dev.0";
+SDKClient.version = "2.0.4-dev.1";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -747,6 +760,16 @@ var InterceptEvent = /* @__PURE__ */ ((InterceptEvent2) => {
   InterceptEvent2[InterceptEvent2["UpdateState"] = 3001] = "UpdateState";
   return InterceptEvent2;
 })(InterceptEvent || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
+var CustomComponentScene = /* @__PURE__ */ ((CustomComponentScene2) => {
+  CustomComponentScene2[CustomComponentScene2["ALL"] = 0] = "ALL";
+  CustomComponentScene2[CustomComponentScene2["workItemNode"] = 1] = "workItemNode";
+  CustomComponentScene2[CustomComponentScene2["scheduleTable"] = 2] = "scheduleTable";
+  return CustomComponentScene2;
+})(CustomComponentScene || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -835,6 +858,9 @@ var src_default = SDKClient;
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentScene,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/types/index.d.ts

@@ -522,6 +522,85 @@ interface InterceptFeatureContext<T> {
     }>;
     customData: T;
 }
+/**
+ * 自定义组件构成
+ * 支持的定义组件类型
+ */
+declare enum CustomComponentType {
+    Schedule = "schedule"
+}
+/**
+ * 自定义组件构成
+ * 允许用户定制指定业务组件类型的UI
+ */
+interface CustomComponentFeatureContext {
+    /**
+     * 组件当前所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 组件当前所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 组件当前所属工作项实例标识
+     * 新建页表单内该值为空
+     */
+    workItemId?: number;
+    /**
+     * 组件唯一标识
+     * 新建场景结合 webhook 用于关联自有数据
+     * 详情页可能为空，不推荐强依赖 UUID 读取自有数据
+     */
+    UUID?: string;
+    /**
+     * 组件节点标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单内，该字段才有数据
+     */
+    nodeId?: string;
+    /**
+     * 组件子任务标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单内，该字段才有数据
+     */
+    taskId?: string;
+}
+/**
+ * 排期组件位置
+ */
+declare enum CustomComponentScene {
+    /**
+     * 全部
+     */
+    ALL = 0,
+    /**
+     * 工作项节点/子任务
+     */
+    workItemNode = 1,
+    /**
+     * 计划表
+     */
+    scheduleTable = 2
+}
+/**
+ *  schedule 组件类型校验返回值
+ */
+type ScheduleCompValueType = string[];
+interface ScheduleCompValidateMsg {
+    code: 200 | 403;
+    msg: string;
+}
+/**
+ * 自定义组件构成
+ * 各业务组件类型拥有的 props
+ */
+interface CustomComponentProps {
+    [CustomComponentType.Schedule]: {
+        value: ScheduleCompValueType;
+        disabled?: boolean;
+        getContext: () => Promise<CustomComponentFeatureContext>;
+        handleSubmit: (value: ScheduleCompValueType) => ScheduleCompValidateMsg;
+    };
+}
 
 /**
  * @internal
@@ -1133,9 +1212,8 @@ interface ModalOptions<Context> {
     /**
      * 响应弹窗内调用的 sdk.containerModal.submit 方法
      * @param params 弹窗内调用的 sdk.containerModal.submit 的方法时传入的自定义参数
-     * @returns 调用 sdk.containerModal.submit 返回的自定义值
      */
-    onSubmit?: (params: unknown) => Promise<unknown>;
+    onSubmit?: (params: unknown) => void;
 }
 /**
  * @public
@@ -1367,7 +1445,7 @@ declare abstract class ContainerModal extends BaseModel {
      * 只存在于 modal.open 打开的容器内
      * submit 调用的是 sdk.modal.open 传入的 onSubmit 方法
      */
-    abstract submit?: <Params, Result>(params: Params) => Promise<Result>;
+    abstract submit?: <Params>(params: Params) => Promise<void>;
     /**
      * mobile version ≥ 7.22.0
      * 关闭插件当前激活的容器模态框
@@ -1540,6 +1618,29 @@ declare abstract class View extends BaseModel {
     abstract getContext(): Promise<ViewFeatureContext>;
 }
 
+/**
+ * @public
+ * 自定义组件构成
+ */
+declare abstract class CustomComponent extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    abstract [CustomComponentType.Schedule]: {
+        load: () => Promise<CustomComponentProps[CustomComponentType.Schedule]>;
+        /**
+         * 用于监听 props 变更
+         * @param callback 返回 schedule 组件新的 props
+         * @param watchKeys 监听的 key，只能监听属性的 key（不能监听 api key），不传默认监听所有 key。监听的 key 对应的值变更会触发回调
+         * @returns
+         */
+        watch: (callback: (next: CustomComponentProps[CustomComponentType.Schedule]) => void, watchKeys?: keyof Omit<CustomComponentProps[CustomComponentType.Schedule], 'getContext' | 'handleSubmit'>[]) => Off;
+        getContext: () => Promise<CustomComponentFeatureContext>;
+        handleSubmit: (value: ScheduleCompValueType) => Promise<ScheduleCompValidateMsg>;
+    };
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1753,4 +1854,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-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, Shared, Space, Storage, Tab, TabFeatureContext, Toast, ToastOptions, User, Utils, View, 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, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, CustomComponentScene, CustomComponentType, 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, ScheduleCompValidateMsg, ScheduleCompValueType, Shared, 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.4-dev.0",
+  "version": "2.0.4-dev.1",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"