@lark-project/js-sdk 0.0.23

package/dist/types/index.d.ts

@@ -0,0 +1,728 @@
+/**
+ * @internal
+ */
+declare const MEEGO_BIZ_HUB = "__MEEGO_BIZ_HUB__";
+/**
+ * @internal
+ * 每个声明的抽象类都必须实现这个属性，用于唯一标识
+ */
+declare const IMPL_KEY = "__MEEGO_SDK_IMPL_KEY__";
+
+/**
+ * @internal
+ */
+declare abstract class BaseModel {
+    protected static [IMPL_KEY]: string;
+}
+
+/**
+ * @public
+ * 语言
+ */
+type Language = 'zh_CN' | 'en_US';
+/**
+ * 区域
+ */
+/**
+ * @public
+ * 宿主环境信息
+ */
+declare abstract class HostEnv extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 当前语言
+     */
+    abstract language: Language;
+}
+
+/**
+ * @public
+ * 用户信息
+ */
+interface User {
+    /**
+     * 唯一标识
+     */
+    id: string;
+    /**
+     * 用户名
+     */
+    name: string;
+    /**
+     * 用户头像
+     */
+    avatar: string;
+}
+/**
+ * @public
+ * 字段类型枚举
+ *
+ * @privateRemarks
+ * 仅枚举产品功能上允许用户新建的字段类型
+ */
+declare enum FieldType {
+    /**
+     * 未知字段类型
+     */
+    unknown = "unknown",
+    /**
+     * 文本（单行、多行）
+     *
+     * @privateRemarks
+     * 字段新建提供了单行文本、多行文本，但实际对应的都是 text
+     */
+    text = "text",
+    /**
+     * 富文本
+     */
+    richText = "multi-text",
+    /**
+     * 单项选择
+     */
+    select = "select",
+    /**
+     * 多项选择
+     */
+    multiSelect = "multi-select",
+    /**
+     * 级联单选
+     */
+    treeSelect = "treeSelect",
+    /**
+     * 级联多选
+     */
+    treeMultiSelect = "tree-multi-select",
+    /**
+     * 单选按钮
+     */
+    radio = "radio",
+    /**
+     * 单选人员
+     */
+    user = "user",
+    /**
+     * 多选人员
+     */
+    multiUser = "multi-user",
+    /**
+     * 日期（日期 + 时间）
+     *
+     * @privateRemarks
+     * 字段新建提供了日期、日期 + 时间，但实际对应的都是 date
+     */
+    date = "date",
+    /**
+     * 日期区间
+     */
+    dateRange = "schedule",
+    /**
+     * 简单投票
+     */
+    simpleVoting = "vote-boolean",
+    /**
+     * 单选投票
+     */
+    singleVoting = "vote-option",
+    /**
+     * 多选投票
+     */
+    multiVoting = "vote-option-multi",
+    /**
+     * 超链接
+     */
+    link = "link",
+    /**
+     * 数字
+     */
+    number = "number",
+    /**
+     * 附件
+     */
+    attachment = "multi-file",
+    /**
+     * 开关
+     */
+    bool = "bool",
+    /**
+     * 单信号
+     */
+    singleSignal = "signal",
+    /**
+     * 多信号
+     */
+    multiSignal = "multi-signal",
+    /**
+     * 复合字段
+     */
+    compoundField = "compound_field",
+    /**
+     * 单选关联工作项
+     */
+    workitemRelatedSelect = "workitem_related_select",
+    /**
+     * 多选关联工作项
+     */
+    workitemRelatedMultiSelect = "workitem_related_multi_select"
+}
+/**
+ * @public
+ * 字段（仅含关键属性）
+ */
+interface BriefField {
+    /**
+     * 唯一标识
+     */
+    id: string;
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 字段类型
+     */
+    type: FieldType;
+}
+/**
+ * @public
+ * 工作项实例（仅含关键属性）
+ */
+type BriefWorkItem = {
+    id: number;
+    name: string;
+    spaceId: string;
+    workObjectId: string;
+};
+/**
+ * @public
+ * 模板（仅含关键属性）
+ */
+interface BriefTemplate {
+    id: number;
+    name: string;
+    flowMode: FlowMode;
+}
+/**
+ * @public
+ * 角色
+ */
+interface Role {
+    id: string;
+    name: string;
+}
+/**
+ * @public
+ * 角色与人员
+ */
+interface RoleOwners {
+    roleId: string;
+    owners: User[];
+}
+/**
+ * @public
+ * 工作流模式
+ */
+declare enum FlowMode {
+    /**
+     * 节点流，TODO: 需要给一些介绍
+     */
+    workFlow = "workflow",
+    /**
+     * 状态流，TODO: 同上
+     */
+    stateFlow = "stateflow"
+}
+/**
+ * @public
+ * 工作项基础信息
+ */
+interface BriefWorkObject {
+    id: string;
+    name: string;
+}
+/**
+ * @public
+ * 业务线
+ */
+interface BizLine {
+    id: string;
+    name: string;
+    isLeaf: boolean;
+    disabled: boolean;
+    children?: BizLine[];
+}
+/**
+ * @public
+ * 流程节点（仅含关键属性）
+ */
+interface BriefNode {
+    id: string;
+    name: string;
+}
+/**
+ * @public
+ * 视图（仅含关键属性）
+ */
+type BriefView = any;
+
+/**
+ * 集成构成
+ * 用于配置第三方平台&本平台的数据集成规则
+ */
+interface IntegrationFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+}
+/**
+ * 按钮位置
+ */
+declare enum ButtonScene {
+    /**
+     * 工作项-更多
+     */
+    workItem = 3,
+    /**
+     * 工作项节点-更多
+     */
+    workItemNode = 4
+}
+/**
+ * 按钮构成
+ * 可被配置于详情页工具栏，视图页、视图工具栏、用于操作单个或多个工作项
+ */
+interface ButtonFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+    /**
+     * 工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 工作项标识
+     */
+    workItemId: string;
+    /**
+     * 按钮位置
+     */
+    buttonScene: ButtonScene;
+}
+/**
+ * 内嵌页面构成
+ * 一个单独的导航入口+内嵌页面
+ */
+interface PageFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+}
+/**
+ * 详情页 Tab 构成
+ * 工作项详情页中的 Tab 页面
+ */
+interface TabFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+    /**
+     * 工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 工作项标识
+     */
+    workItemId: string;
+}
+/**
+ * 视图构成
+ * 工作项视图或者图表视图页面
+ */
+interface ViewFeatureContext {
+    /**
+     * 空间标识
+     */
+    spaceId: string;
+    /**
+     * 工作项类型标识
+     */
+    workObjectId: string;
+    /**
+     * 视图标识
+     */
+    viewId: string;
+}
+/**
+ * 控件构成
+ * 可被配置于详情页、节点流转、状态流转表单、表格页并可用于筛选和分组
+ */
+interface ControlFeatureContext {
+    [key: string]: any;
+}
+/**
+ * 拦截事件类型
+ */
+declare enum InterceptionEvent {
+    /** 创建工作项 */
+    CreateWorkItem = 1001,
+    /** 删除工作项 */
+    DeleteWorkItem = 1002,
+    /** 批量删除工作项 */
+    BatchDeleteWorkItem = 1003,
+    /** 恢复工作项 */
+    RecoveryWorkItem = 1004,
+    /** 终止工作项 */
+    AbortWorkItem = 1005,
+    /** 模板升级 */
+    UpgradeTemplate = 1006,
+    /** 批量模板升级 */
+    BatchUpgradeTemplate = 1007,
+    /** 导出工作项 */
+    ExportWorkItem = 1008,
+    /** 完成节点 */
+    FinishNode = 2001,
+    /** 删除节点 */
+    DeleteNode = 2002,
+    /** 恢复节点 */
+    RecoveryNode = 2003,
+    /** 回滚节点 */
+    RollBackNode = 2004,
+    /** 填写排期与估分 */
+    EditSchedule = 2005,
+    /** 变更状态 */
+    UpdateState = 3001
+}
+/**
+ * 拦截构成
+ * 用于拦截用户行为，包括拦截位置、触发规则和提示等相关配置
+ */
+interface InterceptionFeatureContext {
+    eventType: InterceptionEvent;
+    spaceId: string;
+    workItems: Array<BriefWorkItem>;
+}
+
+/**
+ * @internal
+ */
+type unwatch = () => void;
+
+/**
+ * @public
+ * 当前会话状态
+ */
+declare abstract class Session extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 当前登录用户信息
+     */
+    abstract user: User;
+}
+
+/**
+ * @public
+ * 当前页面状态集合
+ */
+declare abstract class Cursor extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 详情页的状态
+     */
+    abstract detailPage?: {
+        /**
+         * 激活工作项
+         */
+        activeWorkItem?: BriefWorkItem;
+        /**
+         * 当前选中的工作流节点
+         */
+        selectedWorkflowNode?: BriefNode;
+    };
+    /**
+     * 监听 Cursor 变化，目前仅在 Web 端 detailPage.activeWorkItem、detailPage.selectedWorkflowNode 变化时触发回调
+     * @param callback
+     */
+    abstract watch(callback: (nextValue: Cursor) => void): unwatch;
+}
+
+/**
+ * @public
+ * 项目空间
+ */
+declare abstract class Space extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载空间模型
+     * @param id 空间唯一标识
+     * @returns 空间实例（Promise）
+     */
+    static load(id: string): Promise<Space>;
+    /**
+     * 空间唯一标识
+     */
+    abstract id: string;
+    /**
+     * 空间名称
+     */
+    abstract name: string;
+    /**
+     * 所有工作项列表
+     */
+    abstract allWorkObjectList: BriefWorkObject[];
+    /**
+     * 启用的工作项列表
+     */
+    abstract enabledWorkObjectList: BriefWorkObject[];
+    /**
+     * 禁用的工作项列表
+     */
+    abstract disabledWorkObjectList: BriefWorkObject[];
+    /**
+     * 获取空间业务线列表
+     * @returns 空间业务线列表
+     */
+    abstract getBizLineList(): Promise<Array<BizLine> | undefined>;
+}
+
+/**
+ * @public
+ * 工作项对象
+ */
+declare abstract class WorkObject extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载工作项对象模型
+     * @param params
+     * spaceId 空间唯一标识
+     * workObjectId 工作项对象唯一标识
+     */
+    static load(params: {
+        spaceId: string;
+        workObjectId: string;
+    }): Promise<WorkObject>;
+    /**
+     * 唯一标识
+     */
+    abstract id: string;
+    /**
+     * 工作流模式
+     */
+    abstract flowMode: FlowMode;
+    /**
+     * 所属空间标识
+     */
+    abstract spaceId: string;
+    /**
+     * 名称
+     */
+    abstract name: string;
+    /**
+     * 描述
+     */
+    abstract description: string;
+    /**
+     * 字段列表
+     */
+    abstract fieldList: BriefField[];
+    /**
+     * 读流程模板列表
+     */
+    abstract getTemplateList(): Promise<BriefTemplate[]>;
+    /**
+     * 读取角色列表
+     */
+    abstract getRoleList(): Promise<Role[]>;
+}
+
+/**
+ * @public
+ * 工作项实例
+ */
+declare abstract class WorkItem extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载工作项实例模型
+     * @param params
+     * spaceId 空间唯一标识
+     * workObjectId 工作项对象唯一标识
+     * workItemId 工作项实例唯一标识
+     */
+    static load(params: {
+        spaceId: string;
+        workObjectId: string;
+        workItemId: number;
+    }): Promise<WorkItem>;
+    /**
+     * 唯一标识
+     */
+    abstract id: number;
+    /**
+     * 空间标识
+     */
+    abstract spaceId: string;
+    /**
+     * 所属工作项标识
+     */
+    abstract workObjectId: string;
+    /**
+     * 使用的工作项模板标识
+     */
+    abstract templateId: string;
+    /**
+     * 工作项实例名称
+     */
+    abstract name: string;
+    /**
+     * 角色与人员列表
+     */
+    abstract roleOwnersList: RoleOwners[];
+    /**
+     * 工作项实例已终止
+     */
+    abstract isAborted: boolean;
+    /**
+     * 工作项实例已删除
+     */
+    abstract isDeleted: boolean;
+    /**
+     * 获取工作项实例自定义字段相关数据
+     * TODO: 类型暂未定义
+     */
+    abstract getFieldValue(filedId: string): any;
+}
+
+/**
+ * @public
+ * 字段
+ */
+declare abstract class Field extends BaseModel {
+    /**
+     * @internal
+     */
+    protected static [IMPL_KEY]: string;
+    /**
+     * 加载字段模型
+     * @param id 字段唯一标识
+     * spaceId 空间唯一标识
+     * workObjectId 工作项对象唯一标识
+     * fieldId 字段唯一标识
+     */
+    static load(params: {
+        spaceId: string;
+        workObjectId: string;
+        fieldId: string;
+    }): Promise<Field>;
+    /**
+     * 字段唯一标识
+     */
+    abstract id: string;
+    /**
+     * 字段类型
+     */
+    abstract type: FieldType;
+    /**
+     * 字段名称
+     */
+    abstract name: string;
+    /**
+     * 属于系统字段（用户可编辑值）
+     */
+    abstract isSystemField: boolean;
+    /**
+     * 属于系统计算字段（用户不可编辑值，由系统自动计算）
+     */
+    abstract isSystemCalculateField: boolean;
+    /**
+     * 属于公式字段
+     */
+    abstract isFormulaField: boolean;
+}
+
+/**
+ * @public
+ * SDKClient 的配置项
+ */
+interface SDKClientOptions {
+    isDebug?: boolean;
+    pluginId: string;
+}
+/**
+ * @public
+ * SDKClient 是使用 SDK 的入口，需要通过 SDKClient 实例化并配置相关数据后才能调用 API
+ */
+declare class SDKClient {
+    /**
+     * SDK 版本号
+     */
+    static version: string;
+    /**
+     * 宿主环境
+     */
+    get hostEnv(): HostEnv;
+    /**
+     * 当前会话状态，如当前登录用户
+     */
+    get session(): Session;
+    /**
+     * 当前页面状态集合，如详情页选中的节点
+     */
+    get cursor(): Cursor;
+    /**
+     * 空间
+     */
+    get Space(): typeof Space;
+    /**
+     * 工作项配置
+     */
+    get WorkObject(): typeof WorkObject;
+    /**
+     * 工作项
+     */
+    get WorkItem(): typeof WorkItem;
+    /**
+     * 字段
+     */
+    get Field(): typeof Field;
+    /**
+     * @internal
+     */
+    private _meegoBizHub;
+    /**
+     * JSSDK 初始化配置
+     * @param options 配置项
+     * @returns sdk
+     */
+    config(options: SDKClientOptions): Promise<this>;
+}
+
+/**
+ * 用于飞书项目插件读取系统数据的 JSSDK
+ *
+ * @remarks
+ * 使用 SDK 之前请先初始化 {@link SDKClient}，并通过 config 配置
+ *
+ * @packageDocumentation
+ */
+
+export { BizLine, BriefField, BriefNode, BriefTemplate, BriefView, BriefWorkItem, BriefWorkObject, ButtonFeatureContext, ButtonScene, ControlFeatureContext, Cursor, Field, FieldType, FlowMode, HostEnv, IMPL_KEY, IntegrationFeatureContext, InterceptionEvent, InterceptionFeatureContext, Language, MEEGO_BIZ_HUB, PageFeatureContext, Role, RoleOwners, SDKClient, SDKClientOptions, Session, Space, TabFeatureContext, User, ViewFeatureContext, WorkItem, WorkObject, SDKClient as default, unwatch };