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

package/dist/es/index.js

@@ -450,6 +450,16 @@ _a25 = IMPL_KEY;
  */
 CustomField[_a25] = "customField";
 
+// src/features/BuilderComponent.ts
+var _a26;
+var BuilderComponent = class extends BaseModel {
+};
+_a26 = IMPL_KEY;
+/**
+ * @internal
+ */
+BuilderComponent[_a26] = "builderComp";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -529,6 +539,13 @@ var _SDKClient = class {
   get customField() {
     return getImplValue(CustomField, this._meegoBizHub);
   }
+  /**
+   * 应用主页组件点位容器特有能力
+   * only 2.0
+   */
+  get builderComponent() {
+    return getImplValue(BuilderComponent, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -649,7 +666,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.16-dev.0";
+SDKClient.version = "2.0.16-dev.builder.1";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -730,6 +747,21 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
   CustomComponentType2["Schedule"] = "schedule";
   return CustomComponentType2;
 })(CustomComponentType || {});
+var BuilderPropTemplateType = /* @__PURE__ */ ((BuilderPropTemplateType2) => {
+  BuilderPropTemplateType2["Text"] = "text";
+  BuilderPropTemplateType2["Number"] = "number";
+  BuilderPropTemplateType2["Select"] = "select";
+  BuilderPropTemplateType2["Boolean"] = "boolean";
+  BuilderPropTemplateType2["MultiSelect"] = "multiSelect";
+  BuilderPropTemplateType2["DatePrecise"] = "dateWithTime";
+  BuilderPropTemplateType2["DateRange"] = "dateRange";
+  BuilderPropTemplateType2["WorkItemInstance"] = "workItemInstance";
+  BuilderPropTemplateType2["WorkItemTypeSelect"] = "workItemTypeSelect";
+  BuilderPropTemplateType2["ViewSelect"] = "viewSelect";
+  BuilderPropTemplateType2["workItemInstanceWithField"] = "workItemInstanceWithField";
+  BuilderPropTemplateType2["workItemTypeWithField"] = "workItemTypeWithField";
+  return BuilderPropTemplateType2;
+})(BuilderPropTemplateType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -822,6 +854,8 @@ var src_default = SDKClient;
 export {
   ActionSheet,
   AttributeType,
+  BuilderComponent,
+  BuilderPropTemplateType,
   Button,
   ButtonScene,
   Clipboard,

package/dist/lib/index.js

@@ -50,6 +50,8 @@ var src_exports = {};
 __export(src_exports, {
   ActionSheet: () => ActionSheet,
   AttributeType: () => AttributeType,
+  BuilderComponent: () => BuilderComponent,
+  BuilderPropTemplateType: () => BuilderPropTemplateType,
   Button: () => Button,
   ButtonScene: () => ButtonScene,
   Clipboard: () => Clipboard,
@@ -516,6 +518,16 @@ _a25 = IMPL_KEY;
  */
 CustomField[_a25] = "customField";
 
+// src/features/BuilderComponent.ts
+var _a26;
+var BuilderComponent = class extends BaseModel {
+};
+_a26 = IMPL_KEY;
+/**
+ * @internal
+ */
+BuilderComponent[_a26] = "builderComp";
+
 // src/client.ts
 function getImplClass(decl, impls) {
   return impls == null ? void 0 : impls[decl[IMPL_KEY]];
@@ -595,6 +607,13 @@ var _SDKClient = class {
   get customField() {
     return getImplValue(CustomField, this._meegoBizHub);
   }
+  /**
+   * 应用主页组件点位容器特有能力
+   * only 2.0
+   */
+  get builderComponent() {
+    return getImplValue(BuilderComponent, this._meegoBizHub);
+  }
   /**
    * 应用导航
    */
@@ -715,7 +734,7 @@ var SDKClient = _SDKClient;
 /**
  * SDK 版本号
  */
-SDKClient.version = "2.0.16-dev.0";
+SDKClient.version = "2.0.16-dev.builder.1";
 
 // src/types/biz.ts
 var AttributeType = /* @__PURE__ */ ((AttributeType2) => {
@@ -796,6 +815,21 @@ var CustomComponentType = /* @__PURE__ */ ((CustomComponentType2) => {
   CustomComponentType2["Schedule"] = "schedule";
   return CustomComponentType2;
 })(CustomComponentType || {});
+var BuilderPropTemplateType = /* @__PURE__ */ ((BuilderPropTemplateType2) => {
+  BuilderPropTemplateType2["Text"] = "text";
+  BuilderPropTemplateType2["Number"] = "number";
+  BuilderPropTemplateType2["Select"] = "select";
+  BuilderPropTemplateType2["Boolean"] = "boolean";
+  BuilderPropTemplateType2["MultiSelect"] = "multiSelect";
+  BuilderPropTemplateType2["DatePrecise"] = "dateWithTime";
+  BuilderPropTemplateType2["DateRange"] = "dateRange";
+  BuilderPropTemplateType2["WorkItemInstance"] = "workItemInstance";
+  BuilderPropTemplateType2["WorkItemTypeSelect"] = "workItemTypeSelect";
+  BuilderPropTemplateType2["ViewSelect"] = "viewSelect";
+  BuilderPropTemplateType2["workItemInstanceWithField"] = "workItemInstanceWithField";
+  BuilderPropTemplateType2["workItemTypeWithField"] = "workItemTypeWithField";
+  return BuilderPropTemplateType2;
+})(BuilderPropTemplateType || {});
 
 // src/errors/CustomError.ts
 var CustomError = class extends Error {
@@ -889,6 +923,8 @@ var src_default = SDKClient;
 0 && (module.exports = {
   ActionSheet,
   AttributeType,
+  BuilderComponent,
+  BuilderPropTemplateType,
   Button,
   ButtonScene,
   Clipboard,

package/dist/types/index.d.ts

@@ -797,6 +797,131 @@ interface ContainerModalConfigureOptions {
         content: string;
     };
 }
+/** ----------------------- builder 组件构成类型 ----------------------- */
+interface BuilderComponentFeatureContext {
+    /**
+     * builder 组件当前所属空间标识
+     */
+    spaceId: string;
+}
+/**
+ * builder 组件属性值类型
+ */
+type BuilderPropLayout = {
+    width: number;
+    height: number;
+    positionX: number;
+    positionY: number;
+};
+declare enum BuilderPropTemplateType {
+    Text = "text",
+    Number = "number",
+    Select = "select",
+    Boolean = "boolean",
+    MultiSelect = "multiSelect",
+    DatePrecise = "dateWithTime",
+    DateRange = "dateRange",
+    WorkItemInstance = "workItemInstance",
+    WorkItemTypeSelect = "workItemTypeSelect",
+    ViewSelect = "viewSelect",
+    workItemInstanceWithField = "workItemInstanceWithField",
+    workItemTypeWithField = "workItemTypeWithField"
+}
+type BuilderPropText = string;
+type BuilderPropNumber = number;
+type BuilderPropSelect = string;
+type BuilderPropBoolean = boolean;
+type BuilderPropMultiSelect = string[];
+type BuilderPropDateWithTime = number;
+type BuilderPropDateRange = {
+    start: number;
+    end: number;
+};
+type BuilderPropWorkItemType = {
+    spaceId: string;
+    workObjectId: string;
+};
+type BuilderPropWorkItemInstance = {
+    spaceId: string;
+    workObjectId: string;
+    workItemId: number;
+};
+type BuilderPropField = {
+    spaceId: string;
+    workObjectId: string;
+    fieldClass: 'field' | 'role';
+    fieldKey: string;
+    roleId: string;
+};
+type BuilderPropWorkItemTypeWithField = BuilderPropWorkItemType & {
+    fieldList: BuilderPropField[];
+};
+type BuilderPropWorkItemInsWithField = BuilderPropWorkItemInstance & {
+    fieldList: BuilderPropField[];
+};
+type BuilderPropView = {
+    viewId: string;
+};
+type BuilderPropWorkItemListAfterFilter = BuilderPropWorkItemInstance[];
+type BuilderPropWorkItemListAfterSort = BuilderPropWorkItemInstance[];
+type BuilderCompPropValueType = BuilderPropText | BuilderPropNumber | BuilderPropSelect | BuilderPropBoolean | BuilderPropMultiSelect | BuilderPropDateWithTime | BuilderPropDateRange | BuilderPropWorkItemType | BuilderPropWorkItemInstance | BuilderPropWorkItemTypeWithField | BuilderPropWorkItemInsWithField | BuilderPropView | BuilderPropWorkItemListAfterFilter | BuilderPropWorkItemListAfterSort;
+/**
+ * builder 组件不同的属性类型对应的可读配置
+ */
+type I18nTitleConfig = {
+    zh?: string;
+    en?: string;
+    ja?: string;
+    raw?: string;
+};
+type BuilderCompPropSelectConfig = {
+    title: I18nTitleConfig;
+    propType: BuilderPropTemplateType.Select | BuilderPropTemplateType.MultiSelect;
+    options: {
+        label: I18nTitleConfig;
+        value: string;
+    }[];
+};
+type BuilderCompPropBriefConfig = {
+    title: I18nTitleConfig;
+    propType: BuilderPropTemplateType;
+};
+type BuilderCompPropFullConfig = BuilderCompPropBriefConfig | BuilderCompPropSelectConfig;
+/**
+ * builder 组件入参定义
+ */
+type BuilderComponentProps = {
+    instanceId: string;
+    layout?: BuilderPropLayout;
+} & {
+    [propName: string]: BuilderCompPropValueType;
+};
+type BuilderCompLayoutConfig = 
+/** 定高模式 */
+{
+    mode: 0;
+    staticHeight: number;
+}
+/** 栅格模式 */
+ | {
+    mode: 1;
+    minWidth: number;
+    minHeight: number;
+    maxWidth: number;
+    maxHeight: number;
+};
+type BuilderComponentConfig = {
+    id: string;
+    layout: BuilderCompLayoutConfig;
+} & {
+    [keyOfProp: string]: BuilderCompPropBriefConfig;
+};
+interface BuilderComponentPreset {
+    layout?: {
+        width: number;
+        height: number;
+    };
+}
 
 /**
  * @internal
@@ -2013,6 +2138,59 @@ declare abstract class CustomField extends BaseModel {
     abstract openFullScreenPlugin(): void;
 }
 
+/**
+ * @public
+ * 自定义组件构成
+ */
+declare abstract class BuilderComponent extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 获取 builder 组件上下文信息
+     */
+    abstract getContext: () => Promise<BuilderComponentFeatureContext>;
+    /**
+     * 获取 builder 组件入参
+     * 每个 builder 组件一共有 3种数据：
+     * * 组件实例数据（流入的属性值、组件当前的系统属性值）
+     * * 组件配置数据（属于开发者后台的配置，用于描述组件所具有的属性）
+     * * 组件预设值/默认值（属于开发者后台配置，只不过用于给组件提供默认值）
+     * getProps 获取的即第一种数据 - 组件实例数据：
+     * * 系统内置的所有组件通用属性值
+     * * 开发者后台申明的组件入参特化属性值
+     * 不同类型属性的数据结构可参考 JSSDK 包中的类型定义或开发者手册
+     */
+    abstract getProps: () => Promise<BuilderComponentProps>;
+    /**
+     * 用于监听 props 变更
+     * @param callback 返回组件新的 props
+     * @param watchKeys 监听的 key，只能监听属性的 key（不能监听 api key），不传默认监听所有 key。监听的 key 对应的值变更会触发回调
+     * @returns
+     */
+    abstract watch: (callback: (next: BuilderComponentProps | Record<string, never>) => void, watchKeys?: keyof BuilderComponentProps | (keyof BuilderComponentProps)[]) => Promise<Off>;
+    /**
+     * 获取 builder 组件配置：
+     * - 名称
+     * - icon 地址
+     * - layout
+     * - 属性对应的配置
+     */
+    abstract getConfig: (propKeys?: string | string[]) => Promise<BuilderComponentConfig>;
+    /**
+     * 根据属性 key 点查属性的完整配置
+     * - 单选多选类型的选项列表
+     */
+    abstract getPropFullConfig: (propKey: string) => Promise<BuilderCompPropFullConfig>;
+    /**
+     * 获取 builder 组件预设值：
+     * - layout
+     * 暂时不支持指定多组预设值/指定预设id（统一走 default），未来视诉求开放
+     */
+    abstract getPreset: (propKeys?: string[]) => Promise<BuilderComponentPreset>;
+}
+
 /**
  * @public
  * SDKClient 的配置项
@@ -2081,6 +2259,11 @@ declare class SDKClient {
      * only 2.0
      */
     get customField(): CustomField;
+    /**
+     * 应用主页组件点位容器特有能力
+     * only 2.0
+     */
+    get builderComponent(): BuilderComponent;
     /**
      * 应用导航
      */
@@ -2240,4 +2423,4 @@ declare class NotSupportedError extends CustomError {
  * @packageDocumentation
  */
 
-export { ActionSheet, ActionSheetOptions, AttributeType, BatchButtonFeatureContext, BizLine, BriefField, BriefNode, BriefSpace, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, 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, ExCompoundFieldValueType, Field, FieldType, FieldValue, FlowMode, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, 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, Shared, Space, Storage, SubFieldType, 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, BuilderCompLayoutConfig, BuilderCompPropBriefConfig, BuilderCompPropFullConfig, BuilderCompPropSelectConfig, BuilderCompPropValueType, BuilderComponent, BuilderComponentConfig, BuilderComponentFeatureContext, BuilderComponentPreset, BuilderComponentProps, BuilderPropBoolean, BuilderPropDateRange, BuilderPropDateWithTime, BuilderPropField, BuilderPropLayout, BuilderPropMultiSelect, BuilderPropNumber, BuilderPropSelect, BuilderPropTemplateType, BuilderPropText, BuilderPropView, BuilderPropWorkItemInsWithField, BuilderPropWorkItemInstance, BuilderPropWorkItemListAfterFilter, BuilderPropWorkItemListAfterSort, BuilderPropWorkItemType, BuilderPropWorkItemTypeWithField, 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, ExCompoundFieldValueType, Field, FieldType, FieldValue, FlowMode, I18nTitleConfig, IMPL_KEY, IPluginCustomBuildConfig, IRichTextEditorImageUploadComplete, IntegrationFeatureContext, Intercept, InterceptEvent, InterceptFeatureContext, InternalError, InvalidParamsError, Language, 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, Shared, Space, Storage, SubFieldType, 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.16-dev.0",
+  "version": "2.0.16-dev.builder.1",
   "runtimeMinVersions": {
     "web": "2.1.0",
     "mobile": "1.1.0"