@lark-project/js-sdk 2.1.4 → 2.1.5-alpha.0

package/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Change Log
+# 2.1.4（2025/1/14）
+- 「Add」新增 LiteAppPropDataSource 类型相关定义
 
 ## 2.1.3（2025/12/19）
 - 「Add」新增 geolocation.getCurrentPosition

package/dist/es/index.js

@@ -722,7 +722,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.1.4";
+SDKClient.version = "2.1.5-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/lib/index.js

@@ -795,7 +795,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.1.4";
+SDKClient.version = "2.1.5-alpha.0";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {

package/dist/types/index.d.ts

@@ -844,12 +844,18 @@ interface LiteAppComponentFeatureContext {
 /**
  * liteapp 组件属性值类型
  */
+/**
+ * 系统内置的通用值类型
+ */
 type LiteAppPropLayout = {
     width: number;
     height: number;
     positionX: number;
     positionY: number;
 };
+/**
+ * 可配置的属性及值类型
+ */
 declare enum LiteAppPropTemplateType {
     Text = "text",
     Number = "number",
@@ -900,11 +906,38 @@ type LiteAppPropDataSource = {
 };
 type LiteAppPropView = {
     viewId: string;
+    /**
+     * 是否是全景视图
+     */
     isMultiProject: boolean;
 };
 type LiteAppPropWorkItemListAfterFilter = LiteAppPropWorkItemInstance[];
 type LiteAppPropWorkItemListAfterSort = LiteAppPropWorkItemInstance[];
 type LiteAppCompPropValueType = LiteAppPropText | LiteAppPropNumber | LiteAppPropSelect | LiteAppPropBoolean | LiteAppPropMultiSelect | LiteAppPropDateWithTime | LiteAppPropDateRange | LiteAppPropWorkItemType | LiteAppPropWorkItemInstance | LiteAppPropView | LiteAppPropWorkItemListAfterFilter | LiteAppPropWorkItemListAfterSort | LiteAppPropDataSource;
+type LiteAppSubscribedPropertyText = string;
+type LiteAppSubscribedPropertyNumber = number;
+type LiteAppSubscribedPropertyDatePrecise = number;
+type LiteAppSubscribedPropertyDateRange = {
+    start: number;
+    end: number;
+};
+type LiteAppSubscribedPropertyView = {
+    viewId: string;
+};
+type LiteAppSubscribedPropertyWorkItemInstance = {
+    spaceId: string;
+    workObjectId: string;
+    workItemId: number;
+};
+type LiteAppSubscribedPropertyWorkItemType = {
+    spaceId: string;
+    workObjectId: string;
+};
+type LiteAppSubscribedPropertyDataSource = {
+    spaceId: string;
+    moql: string;
+};
+type LiteAppSubscribedPropertyValueType = LiteAppSubscribedPropertyText | LiteAppSubscribedPropertyNumber | LiteAppSubscribedPropertyDatePrecise | LiteAppSubscribedPropertyDateRange | LiteAppSubscribedPropertyView | LiteAppSubscribedPropertyWorkItemInstance | LiteAppSubscribedPropertyWorkItemType | LiteAppSubscribedPropertyDataSource;
 /**
  * liteapp 组件不同的属性类型对应的可读配置
  */
@@ -931,11 +964,17 @@ type LiteAppCompPropFullConfig = LiteAppCompPropBriefConfig | LiteAppCompPropSel
  * liteapp 组件入参定义
  */
 type LiteAppComponentProps = {
+    /**
+     * 实例 ID
+     */
     instanceId: string;
     layout?: LiteAppPropLayout;
 } & {
     [propName: string]: LiteAppCompPropValueType;
 };
+/**
+ * liteapp 组件属性配置定义
+ */
 type LiteAppCompLayoutConfig = 
 /** 定高模式 */
 {
@@ -952,17 +991,38 @@ type LiteAppCompLayoutConfig =
     maxHeight: number;
 };
 type LiteAppComponentConfig = {
+    /**
+     * 组件 id（与实例 id 区分）
+     */
     id: string;
+    /**
+     * 组件名称
+     */
+    /**
+     * 组件 icon
+     */
+    /**
+     * layout 配置
+     */
     layout: LiteAppCompLayoutConfig;
 } & {
+    /**
+     * 属性配置
+     */
     [keyOfProp: string]: LiteAppCompPropBriefConfig;
 };
+/**
+ * liteapp 组件预设值（默认值）
+ */
 interface LiteAppComponentPreset {
     layout?: {
         width: number;
         height: number;
     };
 }
+/**
+ * liteapp 工作项实例定义
+ */
 type LiteAppWorkItemInstance = {
     /**
      * 唯一标识
@@ -1002,8 +1062,17 @@ type LiteAppWorkItemInstance = {
     fields?: Record<string, unknown>;
 };
 type LiteAppComponentDataSourceResult = {
+    /**
+     * 工作项实例列表
+     */
     data: LiteAppWorkItemInstance[];
+    /**
+     * 数据总数
+     */
     total: number;
+    /**
+     * 是否有更多数据
+     */
     hasMore: boolean;
 };
 
@@ -2386,6 +2455,7 @@ declare abstract class BuilderComponent extends BaseModel {
         pageNum: number;
         pageSize: number;
     }) => Promise<LiteAppComponentDataSourceResult>;
+    abstract notify: (key: string, value: LiteAppSubscribedPropertyValueType) => Promise<void>;
 }
 
 /**
@@ -2623,4 +2693,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BatchButtonFeatureContext, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, BuilderComponent, 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, Event, EventPayloadMap, EventType, ExCompoundFieldValueType, Field, FieldType, FieldValue, FlowMode, Geolocation, GeolocationCoordinates, GeolocationPosition, I18nTitleConfig, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, LiteAppCompLayoutConfig, LiteAppCompPropBriefConfig, LiteAppCompPropFullConfig, LiteAppCompPropSelectConfig, LiteAppCompPropValueType, LiteAppComponentConfig, LiteAppComponentDataSourceResult, LiteAppComponentFeatureContext, LiteAppComponentPreset, LiteAppComponentProps, LiteAppPropBoolean, LiteAppPropDataSource, LiteAppPropDateRange, LiteAppPropDateWithTime, LiteAppPropField, LiteAppPropLayout, LiteAppPropMultiSelect, LiteAppPropNumber, LiteAppPropSelect, LiteAppPropTemplateType, LiteAppPropText, LiteAppPropView, LiteAppPropWorkItemInstance, LiteAppPropWorkItemListAfterFilter, LiteAppPropWorkItemListAfterSort, LiteAppPropWorkItemType, LiteAppWorkItemInstance, 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, Script, ScriptFeatureContext, Shared, Space, Storage, SubFieldType, SystemPermissionDeniedError, 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, BuilderComponent, 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, Event, EventPayloadMap, EventType, ExCompoundFieldValueType, Field, FieldType, FieldValue, FlowMode, Geolocation, GeolocationCoordinates, GeolocationPosition, I18nTitleConfig, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, LiteAppCompLayoutConfig, LiteAppCompPropBriefConfig, LiteAppCompPropFullConfig, LiteAppCompPropSelectConfig, LiteAppCompPropValueType, LiteAppComponentConfig, LiteAppComponentDataSourceResult, LiteAppComponentFeatureContext, LiteAppComponentPreset, LiteAppComponentProps, LiteAppPropBoolean, LiteAppPropDataSource, LiteAppPropDateRange, LiteAppPropDateWithTime, LiteAppPropField, LiteAppPropLayout, LiteAppPropMultiSelect, LiteAppPropNumber, LiteAppPropSelect, LiteAppPropTemplateType, LiteAppPropText, LiteAppPropView, LiteAppPropWorkItemInstance, LiteAppPropWorkItemListAfterFilter, LiteAppPropWorkItemListAfterSort, LiteAppPropWorkItemType, LiteAppSubscribedPropertyValueType, LiteAppWorkItemInstance, 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, Script, ScriptFeatureContext, Shared, Space, Storage, SubFieldType, SystemPermissionDeniedError, 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.1.4",
+  "version": "2.1.5-alpha.0",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"