@quickbi/bi-types 3.0.49 → 3.0.50

package/cjs/open/components/style-schema.d.ts

@@ -1,161 +0,0 @@
-/**
- * @author 海狸
- * @description 样式面板配置
- */
-export type StyleSchemaDependId = number | string;
-/**  depend 类型 */
-interface ValueDepend {
-    id: StyleSchemaDependId;
-    value: any | any[];
-}
-interface PatternDepend {
-    id?: StyleSchemaDependId;
-    pattern?: string;
-}
-type StyleSchemaBaseDepend = ValueDepend | PatternDepend;
-interface StyleSchemaAndDepend {
-    $and?: StyleSchemaDepend[];
-}
-interface StyleSchemaOrDepend {
-    $or?: StyleSchemaDepend[];
-}
-export type StyleSchemaDepend = StyleSchemaBaseDepend & StyleSchemaAndDepend & StyleSchemaOrDepend;
-/**  校验规则配置项类型定义 */
-export interface StyleSchemaValidationRule {
-    /**  必要属性（除存在代理校验属性外的情况下 必须声明）：校验错误信息 */
-    message?: string;
-    /**  校验属性（除存在代理校验属性外的情况下 必须且仅可声明其中一个 参考 `async-validator`） */
-    [rule: string]: any;
-    /**  代理校验属性（当此属性有效时 其他属性无效 可不声明）：代理校验函数名 */
-    funcName?: string;
-}
-/** 校验结果类型定义（用于 `onChange` 函数） */
-export interface StyleSchemaValidationResult {
-    /** 是否通过校验 */
-    pass: boolean;
-    /** 不通过校验时 返回详细字段名和信息 若校验通过则空 */
-    details: {
-        field: string;
-        message: string;
-    }[];
-}
-export interface StyleSchemaValidation {
-    [validateFuncName: string]: (rule?: any, currentValue?: any, extras?: {
-        data?: any;
-        schema?: Schema;
-        keyPaths?: string[];
-    }) => string | Promise<any> | void;
-}
-export interface StyleSchema {
-    /** styleSchema 配置 */
-    schema: StyleSchemaBase;
-    /** 自定义编辑器 */
-    localEditors?: {
-        [key: string]: React.ComponentType<any>;
-    };
-    /** 自定义校验函数 */
-    validation?: StyleSchemaValidation;
-    /** 事件处理函数 */
-    onChange?: (data?: any, currentSchema?: Schema, keyPaths?: string[], validation?: StyleSchemaValidationResult) => void;
-}
-/**
- * `schema` 配置接口
- * */
-export interface StyleSchemaBase<P = any, T = string> {
-    /** 使用的子组件类型 */
-    type: T;
-    /** 标题文案 */
-    title?: string;
-    /** 标题后备注信息 */
-    info?: string;
-    /** 标题对齐方式 */
-    titleAlign?: 'left' | 'center' | 'right';
-    /** 子字段 */
-    properties?: StyleSchemaProperties;
-    /** 容器类名 */
-    className?: string;
-    /** 描述文案 */
-    description?: string;
-    /** 显示顺序 */
-    propertyOrder?: number;
-    /** 字段的 id 标识符 */
-    id?: StyleSchemaDependId;
-    /** 是否隐藏 */
-    hide?: boolean;
-    /** 显隐依赖 */
-    visibleDepends?: StyleSchemaDepend[];
-    /** 是否禁用 */
-    disabled?: boolean;
-    /** 禁用依赖 */
-    disableDepends?: StyleSchemaDepend[];
-    /** 依赖于自身的子节点 Id */
-    childrenIds?: string[];
-    /** 校验规则 */
-    validation?: StyleSchemaValidationRule[];
-    /** 是否显示必填星号标记 */
-    showRequiredMark?: boolean;
-    /** 是否显示校验错误信息 */
-    hideValidateTips?: boolean;
-    /** 自定义默认值 */
-    defaultValue?: any;
-    /**
-     * 【继承型属性】默认值继承清单（用于自动继承数据集配置:https://aone.alibaba-inc.com/v2/project/447571/req/43247438）
-     * 注：这里keyPaths是相对路径（相对于每个Schema配置），例如用于fieldSettingMap中则为：['test-field-id', 'aliasName']
-     */
-    defaultValueInheritProps?: {
-        keyPaths: (string | number)[];
-        isInherited: boolean;
-        propUuid: string;
-    }[];
-    /** 子组件的 `props` */
-    props?: P;
-    /** 字段重定向（点分字符串） */
-    redirect?: string;
-    /** 关联 data */
-    relatedToData?: boolean;
-    /** 后缀 比如 xx: [select/input 组件] 天  */
-    suffix?: string;
-    /** 布局属性 */
-    grid?: {
-        row: number;
-        col: number;
-    };
-    /** 表单布局 */
-    layout?: 'horizontal' | 'vertical' | 'inline';
-    /** 是否有重置功能 */
-    hasReset?: boolean;
-    /** 自定义 title 渲染, 优先级高于ui-schema整体props的labelRender */
-    labelRenderer?: (schema: StyleSchemaBase) => React.ReactNode;
-    /** 点击触发回调，对于 collapse 组件，可以获取到当前折叠状态 */
-    onClick?: (v?: any) => void;
-}
-/** type 为 object 的配置 */
-export interface StyleSchemaObject extends StyleSchemaBase {
-    type: 'object';
-    props?: {
-        /** 分组类型 */
-        mode?: 'tabs' | 'collapse';
-        /** 分组组件渲染的props */
-        modeRendererProps?: {
-            /** 默认展开的面板 */
-            defaultActiveKey?: string | number | (string | number)[];
-            /** 具有开关的 collapse 面板 key */
-            switchModeKeys?: string[];
-            [key: string]: any;
-        };
-    };
-    /** 分组提示气泡, 仅在 collapse 下生效 */
-    info?: string;
-}
-/** type 为 array 的配置 */
-export interface StyleSchemaArray extends StyleSchemaBase {
-    type: 'array';
-    /** 数组元素默认值 */
-    arrayItemDefaultValue?: any;
-}
-type Schema = StyleSchemaObject | StyleSchemaArray | StyleSchemaBase;
-/** properties 属性 */
-export type StyleSchemaProperties = {
-    [key: string]: Schema;
-} | string;
-export {};

package/cjs/open/embed/core.d.ts

@@ -1,65 +0,0 @@
-/**
- * @author 海狸
- * @description 嵌入通用类型定义
- */
-import type { RouteKey } from '../../router/route-key';
-/** 通用页面来源信息 */
-export type EmbedBaseSrc = {
-    /** 嵌入页面 */
-    page: RouteKey;
-    /** 域名信息 */
-    origin?: string;
-    /** 额外的 url 参数 */
-    search?: Record<string, string> & {
-        /** 空间 id */
-        workspaceId?: string;
-        /** 作品 id */
-        id?: string;
-        /** 嵌入 token */
-        accessTicket?: string;
-    };
-    /** 额外的路径参数 */
-    pathParams?: Record<string, string>;
-    /** 额外的哈希值 */
-    hash?: string;
-};
-/** 嵌入特性项取值类型, 只能是基本类型 */
-export type EmbedBaseFeatureValue = string | number | boolean | null | undefined;
-/** 嵌入特性配置项 */
-export interface EmbedBaseFeatureItem extends Record<string, EmbedBaseFeatureValue | EmbedBaseFeatureItem> {
-    /** 特性是否显示 */
-    show?: boolean;
-}
-/** 嵌入特性配置 */
-export type EmbedBaseFeature = Partial<Record<RouteKey, EmbedBaseFeatureItem>>;
-/** postMessage 事件 data 传参格式 */
-export type EmbedBaseEventMessageDTO<T extends EmbedBaseEventMessageContent = EmbedBaseEventMessageContent> = {
-    /** 事件会话 id */
-    sessionId: string;
-    /** 事件消息 id */
-    messageId: string;
-    /** 事件数据真实内容 */
-    content: T;
-};
-/** 嵌入消息统一格式 */
-export type EmbedBaseEventMessageContent<T = any, K = string> = {
-    /** 行为类型 */
-    type: K;
-    /** 行为传参, 必须能序列化 */
-    payload: T;
-};
-/** 页面事件对应的监听函数返回值 */
-export type EmbedBaseEventListenerReturn<T extends EmbedBaseEventMessageContent, R = any> = {
-    content: T;
-    return: R;
-};
-/** 页面事件对应的监听函数 */
-export type EmbedBaseEventListener<U extends EmbedBaseEventMessageContent, T extends EmbedBaseEventListenerReturn<U>> = {
-    [K in U['type']]: (payload: Extract<U, {
-        type: K;
-    }>) => Promise<T extends {
-        content: {
-            type: K;
-        };
-    } ? T['return'] : any>;
-};

package/cjs/open/events/event-props.d.ts

@@ -1,33 +0,0 @@
-/**
- * @author 唯毅
- * @description 自定义事件-props 类型定义
- */
-import type { CommonPageConfig, CommonModalPayload, CommonOpenModalAction, CommonCloseModalAction, CommonShowMessageAction, CommonUtils } from '../menus/menu-props';
-/** 自定义事件弹窗参数 */
-export type CustomEventModalPayload = CommonModalPayload;
-export type CustomEventPageConfig = CommonPageConfig;
-/**
- * 自定义事件 dispatch 属性
- */
-export type CustomEventPropsDispatch = (param: CommonOpenModalAction | CommonCloseModalAction | CommonShowMessageAction) => void;
-export declare enum CustomEventType {
-    /** 自定义事件-下载前 */
-    beforeDownloadEvent = "before-download-event",
-    /** 自定义事件-页面加载前 */
-    beforePageLoadEvent = "before-page-loaded-event",
-    /** 自定义事件-发布前 */
-    beforePublishEvent = "before-publish-event"
-}
-/**
- * 自定义事件 props 接口
- */
-export interface CustomEventProps {
-    /** 事件类型 */
-    type: CustomEventType;
-    /** 页面信息 */
-    pageConfig: CustomEventPageConfig;
-    /** 操作 */
-    dispatch?: CustomEventPropsDispatch;
-    /** 自定义菜单展示模式 */
-    utils?: CommonUtils;
-}

package/cjs/open/events/event-schema.d.ts

@@ -1,12 +0,0 @@
-/**
- * @author 唯毅
- * @description 自定义事件配置
- */
-import type { CustomEventProps } from './event-props';
-/**
- * 自定义事件 meta 配置
- */
-export interface CustomEventMeta {
-    /** 事件监听回调 */
-    listener: (props: CustomEventProps) => Promise<boolean>;
-}

package/cjs/open/menus/menu-props.d.ts

@@ -1,178 +0,0 @@
-/**
- * @author 海狸
- * @description 自定义菜单 props 接口
- */
-import type { ComponentProps } from '../components/component-props';
-import type { ChartType, ComponentType } from '../../component-type';
-import type { EnumAsUnion } from '../common/tools';
-import type { OpenPageTypeEnum } from '../common/page-types';
-import type { OpenDeviceTypeEnum } from '../common/misc';
-/**
- * 事件/菜单通用的页面信息
- */
-export interface CommonPageConfig {
-    /** 页面工作空间 id */
-    workspaceId: string;
-    /** 页面 id */
-    id: string;
-    /** 页面模式, 编辑态/预览态/截图态(仅仪表板和电子表格有)/公开态(数据大屏) */
-    mode: 'preview' | 'edit' | 'snapshot' | 'public';
-    /** 当前设备 */
-    device: EnumAsUnion<typeof OpenDeviceTypeEnum>;
-    /** 当前访问者 id */
-    userId: string;
-    /** 当前访问者 id */
-    userName: string;
-    /** 页面创建者 id */
-    ownerUserId: string;
-    /** 页面创建者 id */
-    ownerUserName: string;
-    /** 页面标题 */
-    title: string;
-    /** 页面类型 */
-    pageType: EnumAsUnion<typeof OpenPageTypeEnum>;
-}
-/**
- * 事件/菜单通用的工具方法
- */
-export interface CommonUtils {
-    /** 获取 cookie */
-    getCookie: (key: string) => string;
-}
-/**
- * 自定义菜单的页面信息
- */
-export type MenuPageConfig = CommonPageConfig;
-/**
- * 自定义菜单 props 接口
- */
-export interface MenuComponentProps {
-    /** 页面信息 */
-    pageConfig: MenuPageConfig;
-    /** 操作 */
-    dispatch?: MenuComponentPropsDispatch;
-    /** 自定义菜单展示模式 */
-    menuMode?: CustomMenuMode;
-    /** 自定义菜单展示模式 */
-    utils?: CommonUtils;
-}
-/** 事件/菜单通用的弹窗唤起方法 */
-export interface CommonModalPayload {
-    /** PC端弹窗宽度 */
-    width?: string | number;
-    /** PC端和移动端点击取消按钮时的回调 */
-    onCancel?: (...args: any[]) => any;
-    /** 弹窗关闭 icon */
-    closeIcon?: React.ReactNode;
-    /** 内容 */
-    content?: React.ReactNode;
-    /** 标题 */
-    title?: string;
-    /** PC端点击确定回调，返回 promise 可以延迟关闭。 */
-    onOk?: (...args: any[]) => any;
-    /** PC端确认按钮文字 */
-    okText?: React.ReactNode;
-    /** PC端取消按钮文字 */
-    cancelText?: React.ReactNode;
-    /** PC端确认按钮属性 */
-    okButtonProps?: {
-        style?: React.CSSProperties;
-        disabled?: boolean | undefined;
-    };
-    /** PC端取消按属性 */
-    cancelButtonProps?: {
-        style?: React.CSSProperties;
-        disabled?: boolean | undefined;
-    };
-    /** body 样式 */
-    bodyStyle?: React.CSSProperties;
-    /** 点击浮层关闭弹窗 */
-    maskClosable?: boolean;
-    /** 底部按钮 */
-    footer?: {
-        text?: string;
-        onClick?: React.MouseEventHandler<HTMLElement>;
-        type?: 'default' | 'primary';
-    }[];
-    /** 设置Modal的z-index */
-    zIndex?: number;
-    /** 是否展示遮罩 */
-    mask?: boolean;
-}
-/** 事件/菜单通用的 message 传参 */
-export interface CommonMessagePayload {
-    /** 内容 */
-    content?: React.ReactNode;
-    /** 类型 */
-    type: 'info' | 'success' | 'error' | 'warn';
-}
-/** 自定义菜单弹窗参数 */
-export type CustomMenuModalPayload = CommonModalPayload;
-/**
- * 唤起菜单弹窗
- */
-export interface CommonOpenModalAction<T = CustomMenuModalPayload> {
-    type: 'openModal';
-    payload: T;
-}
-/**
- * 手动关闭弹窗
- */
-export interface CommonCloseModalAction {
-    type: 'closeModal';
-}
-/**
- * 唤起 message 提示
- */
-export interface CommonShowMessageAction {
-    type: 'showMessage';
-    payload: CommonMessagePayload;
-}
-export type MenuComponentPropsDispatch = (param: CommonOpenModalAction | CommonCloseModalAction | CommonShowMessageAction) => void;
-/**
- * 自定义图表卡片菜单 props 接口
- */
-export interface MenuComponentChartProps extends MenuComponentProps {
-    /** 卡片菜单 */
-    chart: MenuChart;
-}
-/**
- * 仪表板图表自定义菜单接口
- */
-export interface MenuChart extends ComponentProps {
-    /** 图表类型 */
-    componentType: ComponentType;
-    /** 自定义组件类型, 当组件是自定义组件时传入  */
-    customComponentType?: ChartType;
-}
-/**
- * 电子表格自定义菜单
- */
-export interface MenuComponentExcelProps extends MenuComponentProps {
-    sheets: MenuSheet[];
-}
-/**
- * 仪表板自定义菜单
- */
-export type MenuComponentDashboardProps = MenuComponentProps;
-export interface MenuSheet {
-    /** 标签 id */
-    sheetId: string;
-    /** 标签名称 */
-    sheetName: string;
-    /** 标签顺序 */
-    sheetOrder: number;
-}
-/**
- * 自定义菜单展示模式
- */
-export declare enum CustomMenuMode {
-    /**
-     * 平铺,直接展示在界面上
-     */
-    tile = 1,
-    /**
-     * 收起,隐藏至 更多下拉框 中
-     */
-    pack = 2
-}

package/cjs/open/menus/menu-schema.d.ts

@@ -1,35 +0,0 @@
-/**
- * @author 海狸
- * @description 自定义菜单配置
- */
-import type { ComponentProps } from '../components/component-props';
-export interface MenuSchema {
-    schema: MenuSchemaBase;
-}
-/** styleSchema 配置, 仅供自定义组件内部使用 */
-export interface MenuSchemaBase {
-    [menuKey: string]: MenuSchemaItem;
-}
-/** styleSchema 配置, 仅供自定义组件内部使用 */
-export interface MenuSchemaItem {
-    /** 菜单项标题 */
-    title: string;
-    /** 菜单项图标 */
-    icon?: string;
-    /** 点击事件回调 */
-    onClick?: (props: ComponentProps) => void;
-    /** 是否禁用菜单项 */
-    disabled?: boolean | ((props: ComponentProps) => boolean);
-    /** 是否隐藏菜单项 */
-    hidden?: boolean | ((props: ComponentProps) => boolean);
-}
-export interface MenuProps {
-    customProps: ComponentProps;
-}
-/**
- * 自定义菜单配置, 供所有图标使用
- */
-export interface MenuMeta {
-    /** @deprecated[已废弃属性] 从上到下的顺序 */
-    order?: number;
-}