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

package/dist/es/index.js

@@ -1,7 +1,7 @@
 
 /**
 * MIT License
-* Copyright (c) 2024 Lark Technologies Pte. Ltd.
+* Copyright (c) 2025 Lark Technologies Pte. Ltd.
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice, shall be included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -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.2";
 
 // 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 ComponentScheduleScene = /* @__PURE__ */ ((ComponentScheduleScene2) => {
+  ComponentScheduleScene2[ComponentScheduleScene2["ALL"] = 0] = "ALL";
+  ComponentScheduleScene2[ComponentScheduleScene2["workItemNode"] = 1] = "workItemNode";
+  ComponentScheduleScene2[ComponentScheduleScene2["scheduleTable"] = 2] = "scheduleTable";
+  return ComponentScheduleScene2;
+})(ComponentScheduleScene || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -768,10 +788,13 @@ export {
   Button,
   ButtonScene,
   Clipboard,
+  ComponentScheduleScene,
   Configuration,
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/lib/index.js

@@ -1,7 +1,7 @@
 
 /**
 * MIT License
-* Copyright (c) 2024 Lark Technologies Pte. Ltd.
+* Copyright (c) 2025 Lark Technologies Pte. Ltd.
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice, shall be included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -53,10 +53,13 @@ __export(src_exports, {
   Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
+  ComponentScheduleScene: () => ComponentScheduleScene,
   Configuration: () => Configuration,
   ContainerModal: () => ContainerModal,
   Context: () => Context,
   Control: () => Control,
+  CustomComponent: () => CustomComponent,
+  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.2";
 
 // 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 ComponentScheduleScene = /* @__PURE__ */ ((ComponentScheduleScene2) => {
+  ComponentScheduleScene2[ComponentScheduleScene2["ALL"] = 0] = "ALL";
+  ComponentScheduleScene2[ComponentScheduleScene2["workItemNode"] = 1] = "workItemNode";
+  ComponentScheduleScene2[ComponentScheduleScene2["scheduleTable"] = 2] = "scheduleTable";
+  return ComponentScheduleScene2;
+})(ComponentScheduleScene || {});
+var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
+  CustomComponentType2["Schedule"] = "schedule";
+  return CustomComponentType2;
+})(CustomComponentType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -831,10 +854,13 @@ var src_default = SDKClient;
   Button,
   ButtonScene,
   Clipboard,
+  ComponentScheduleScene,
   Configuration,
   ContainerModal,
   Context,
   Control,
+  CustomComponent,
+  CustomComponentType,
   Field,
   FieldType,
   FlowMode,

package/dist/types/index.d.ts

@@ -522,6 +522,113 @@ interface InterceptFeatureContext<T> {
     }>;
     customData: T;
 }
+/** ----------------------- 拓展组件-排期组件特化属性 ----------------------- */
+/**
+ * 排期组件位置
+ */
+declare enum ComponentScheduleScene {
+    /**
+     * 全部
+     */
+    ALL = 0,
+    /**
+     * 工作项节点/子任务
+     */
+    workItemNode = 1,
+    /**
+     * 计划表
+     */
+    scheduleTable = 2
+}
+declare enum WorkItemNodeType {
+    Node = "node",
+    SubTask = "sub_task",
+    SubWorkItem = "sub_workitem",
+    SuInstance = "sub_instance"
+}
+interface WorkItemInfo {
+    spaceId: string;
+    workObjectId: string;
+    workItemId: string;
+}
+type ComponentScheduleIdentity = WorkItemInfo & {
+    type: WorkItemNodeType;
+    nodeId: string;
+    taskId: string;
+};
+interface WbsStatus {
+    wbsStatus: string;
+}
+interface UserInfo {
+    role: string;
+    userName: string;
+    id: string;
+}
+type ScheduleCompValueType = string[];
+/**
+ *  schedule 组件类型校验返回值
+ */
+interface ScheduleCompValidateMsg {
+    code: 200 | number;
+    msg: string;
+}
+/** ----------------------- 拓展点位通用类型 ----------------------- */
+/**
+ * 自定义组件构成
+ * 支持的定义组件类型
+ */
+declare enum CustomComponentType {
+    Schedule = "schedule"
+}
+/**
+ * 自定义组件构成
+ * 允许用户定制指定业务组件类型的UI
+ */
+interface CustomComponentFeatureContext<I extends {
+    /**
+     * 组件节点标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单/计划表内，该字段才有数据
+     */
+    nodeId?: string;
+    /**
+     * 组件子任务标识
+     * 适用场景：详情页为节点流时，且当前控件位于节点表单/计划表内，该字段才有数据
+     */
+    taskId?: string;
+}, S extends ComponentScheduleScene> {
+    /**
+     * 组件所处场景
+     */
+    scene: S;
+    /**
+     * 组件当前所属空间标识
+     */
+    spaceId: string;
+    /**
+     * 组件当前所属工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 组件当前所属工作项实例标识
+     * 新建页表单内该值为空
+     */
+    workItemId?: number;
+    /**
+     * 组件唯一标识
+     * 组件所属节点的所属空间/工作项/工作项实例以及节点任务标识
+     */
+    identity?: I;
+}
+/**
+ * 自定义组件构成
+ * 各业务组件类型拥有的 props
+ */
+interface CustomComponentProps {
+    [CustomComponentType.Schedule]: {
+        value: ScheduleCompValueType;
+        disabled?: boolean;
+    };
+}
 
 /**
  * @internal
@@ -1133,9 +1240,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 +1473,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 +1646,31 @@ 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]: {
+        getProps: () => 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 CustomComponentProps[CustomComponentType.Schedule])[]) => Off;
+        getContext: () => Promise<CustomComponentFeatureContext<ComponentScheduleIdentity, ComponentScheduleScene>>;
+        getWbsStatus?: () => Promise<WbsStatus>;
+        getOwnersInfo?: () => Promise<UserInfo[]>;
+        handleSubmit: (value: ScheduleCompValueType) => Promise<ScheduleCompValidateMsg>;
+    };
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -1753,4 +1884,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, ComponentScheduleIdentity, ComponentScheduleScene, Configuration, ConfigurationFeatureContext, ContainerModal, Context, Control, ControlFeatureContext, CreateButtonFeatureContext, CustomComponent, CustomComponentFeatureContext, CustomComponentProps, 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, 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.4-dev.0",
+  "version": "2.0.4-dev.2",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"