@quickbi/bi-types 3.0.49 → 3.0.50

package/esm/data-panel/data-schema.d.ts

@@ -1,101 +0,0 @@
-/**
- * @author 忘悠
- * @description 数据面板图表接入模型
- */
-import type { AreaMap, DataSchemaAreaItem, ValidateResult, OnFreshComponentType } from './data-schema-item';
-import type { Platform } from '../open/components/data-schema';
-import type { FieldConfigRow } from './base';
-export declare class ResultDisplay {
-    /** 上下限 */
-    upLimit?: number;
-    downLimit?: number;
-    /** 是否展示全量选择按钮 */
-    isShowAll?: boolean;
-    /** 是否隐藏展示结果设置 */
-    hide?: boolean;
-    /** hover在数值输入框的tooltip */
-    inputTooltip?: React.ReactNode;
-}
-export declare class DataPanelDataSchema {
-    /** 禁用调整面板大小以及收起展开功能 */
-    disableResize?: boolean;
-    /** 禁用收起展开功能 */
-    disableCollapse?: boolean;
-    /** 隐藏数据面板更新按钮 */
-    disableUpdate?: boolean;
-    /** 高级查询控件采用之前面板的模式，比较特殊 */
-    advanceQueryMode?: boolean;
-    areas?: DataSchemaAreaItem[];
-    /** 结果展示 */
-    resultDisplay?: ResultDisplay;
-    /** 是否需要 */
-    alwaysFresh?: boolean;
-    hooks?: {
-        /** 点击更新按钮之前的钩子 */
-        beforeUpdateComponent?: (component: any, platform?: Platform) => {
-            component: any;
-        };
-        /** 替换点击更新按钮的逻辑，返回点击更新成功与失败状态,成功的时候必须返回最新的component */
-        handleClickUpdate?: (p: {
-            component: any;
-            onFreshComponent: OnFreshComponentType;
-        }) => {
-            /** success true意味着更新成功，触发取数 */
-            success: boolean;
-            component?: any;
-        };
-        /** 点击聚合明细按钮的钩子，点击之后会更新component */
-        onClickQueryDetailBtns?: (component: any) => {
-            component: any;
-        };
-        /** 点击更新按钮时的自定义校验 */
-        beforeUpdateComponentValidate?: (areaMap: AreaMap, component: any) => ValidateResult;
-        /** 转换为component inputquery模型时调用 */
-        reviseWhenConvertToQueryInput?: (input: any) => any;
-        /** 动态更新dataSchema */
-        reviseDataSchemaByComponent?: (dataSchema: DataPanelDataSchema, options?: {
-            /** 是否是组件创建初始化,若为true,此时 attribute等参数不起作用，可以省略 */
-            isInit?: boolean;
-            /** 根据组件attribute动态更新dataSchema */
-            attribute?: any;
-            /** component信息,for 大屏 */
-            component?: any;
-        }) => DataPanelDataSchema;
-        /** 其他图表切换到当前图表订正input */
-        reviseInputWhenSwitchComponent?: {
-            /** 来源图表类型，如果没命中，则走默认订正逻辑 */
-            fromList: any[];
-            reviser: (fromInput: any, dftToInput: any, from: any, to: any) => any;
-        };
-        /** 指标树管理，趋势分析表用到 */
-        indicatorTreeManager?: {
-            setter: (component: any, newHierarchicalData?: any[]) => any;
-            getter: (component: any) => any[];
-        };
-        /** 自定义是否支持自动刷新的hook */
-        getSupportAutoRefresh?: (component: any) => boolean;
-    };
-    /** 批量字段配置相关 */
-    batchFieldSettingConfig?: {
-        /** 自定义批量字段设置表头 */
-        customFiledConfigRow?: (headerRow: FieldConfigRow) => FieldConfigRow;
-    };
-    /** 开启聚合明细按钮组 */
-    showQueryDetailBtns?: boolean;
-    /** 关闭度量重复校验 */
-    allowMeasureRepeat?: boolean;
-    /** 是否支持数据混合 */
-    supportCubeBlend?: boolean | ((component: any) => boolean);
-    /** 是否允许在同个area中，出现相同的维度字段 */
-    allowDimRepeatInOneArea?: boolean;
-    isShowCube?: (component: any) => boolean;
-    /** 面板插槽，主要用来自定义一些图表的特殊配置组件
-     */
-    slot?: Partial<{
-        /** area配置区域包裹层插槽 */
-        areasWrapper: (props: {
-            component: any;
-            onFreshComponent: OnFreshComponentType;
-        }) => React.ReactElement;
-    }>;
-}

package/esm/data-panel/index.d.ts

@@ -1,9 +0,0 @@
-import type { CommonCompInputAreaType, ConfigCellOption, FieldConfigRow } from './base';
-import { CommonCompInputAreaTypeEnum, QueryAxisType, FieldType, CUSTOM_FIELD_TYPES, SecondFieldType, ChartStatus, StackedSortType, ResultMode, RetainAreaId, ConfigCellType, ConfigColumnType, CheckBoxState, FieldGroupType, FieldCollectionType, LnglatGroupChildFlags } from './base';
-import type { CommonCompInputComplexFilter, TimeTypeFilter, CommonCompInputComplexFilterItem, TableCalculateParam, CalcOrder, TopNParams } from './data-config';
-import { DataConfig, DataConfigAreaItemColumn, TableType, TableDirection, ProportionType, AccumulateCalcType } from './data-config';
-import type { FieldConfigs, FieldInfo, ChildFieldInfo, DropDownMenuFieldConfig, AlignConfig, AggregationConfig, AdvancedCalculationConfig, ContrastConfig, NumberFormatConfig, FieldRuntime, CompFieldConfig, LabelConfig, AreaMapItem, AreaMap, VirtualFieldInfo, ResetFieldConfigType, ResetMenuType, SortConfig, Message, OnFreshComponentType, OnFreshComponentOptions, OnChangeCubeOptions, FieldMenuConfig, ChangeFieldMenuConfigs, ColumnFieldInfo, FieldCollectionInfo, ValidateResult, AuxiliaryFieldConfig, EmptyValueDisplayFieldConfig } from './data-schema-item';
-import { DataSchemaAreaItem, OperationMenuItem, DropdownMenuItem, OperationTypes, Aggregators, FieldConfigTypes, ContrastTypes, AdvanceCalTypes, AdvanceCalcDateTypes, NumberFormats, AlignTypes, VerticalAlignTypes, AlignmentCategory, SortTypes, FieldChartTypes, ImageSizes, DropDownMenuType, DataSchemaRule, FieldGroupSelectorType } from './data-schema-item';
-import { DataPanelDataSchema, ResultDisplay } from './data-schema';
-export { DataSchemaRule, CommonCompInputAreaTypeEnum, DataConfig, DataConfigAreaItemColumn, TableType, TableDirection, DataPanelDataSchema, DataSchemaAreaItem, OperationMenuItem, DropdownMenuItem, OperationTypes, Aggregators, FieldConfigTypes, ContrastTypes, AdvanceCalTypes, AdvanceCalcDateTypes, NumberFormats, AlignTypes, VerticalAlignTypes, AlignmentCategory, SortTypes, FieldGroupSelectorType, FieldChartTypes, ImageSizes, CUSTOM_FIELD_TYPES, FieldType, QueryAxisType, DropDownMenuType, SecondFieldType, ChartStatus, StackedSortType, ResultMode, RetainAreaId, ConfigCellType, ConfigColumnType, CheckBoxState, ResultDisplay, FieldGroupType, ProportionType, AccumulateCalcType, FieldCollectionType, LnglatGroupChildFlags, };
-export type { CommonCompInputAreaType, FieldInfo, ChildFieldInfo, FieldConfigs, DropDownMenuFieldConfig, AlignConfig, AggregationConfig, AdvancedCalculationConfig, ContrastConfig, NumberFormatConfig, FieldRuntime, CompFieldConfig, LabelConfig, TimeTypeFilter, CommonCompInputComplexFilter, ResetFieldConfigType, CommonCompInputComplexFilterItem, AreaMapItem, AreaMap, VirtualFieldInfo, ResetMenuType, SortConfig, Message, OnFreshComponentType, OnFreshComponentOptions, OnChangeCubeOptions, ConfigCellOption, FieldConfigRow, FieldMenuConfig, ChangeFieldMenuConfigs, ColumnFieldInfo, FieldCollectionInfo, AuxiliaryFieldConfig, ValidateResult, TableCalculateParam, CalcOrder, TopNParams, EmptyValueDisplayFieldConfig, };

package/esm/etl.d.ts

@@ -1,76 +0,0 @@
-/** etl发布状态 */
-export declare enum EtlPublishStatus {
-    /** 未发布 */
-    unPublisHed = 0,
-    /** 已发布 */
-    published = 1,
-    /** 已发布并且编辑保存正确 */
-    publishedEditOK = 2,
-    /** 下线 */
-    offline = 3,
-    /** 已发布但编辑有错误 */
-    publishedEditError = 4
-}
-/** etl 调度状态 */
-/**
- *    NOT_RUN(-1, "未运行"),
-    READY_TO_RUN(1, "调度中待运行"),
-    RUNNING(2, "运行中"),
-    RUN_SUCCESS(3, "执行成功"),
-    RUN_FAILED(4, "执行失败"),
-    MANUAL_TERMINATED(5, "手动终止"),
- */
-export declare enum EtlScheduleStatus {
-    /** 未运行 */
-    NotRun = -1,
-    /** 调度中待运行 */
-    ReadyToRun = 1,
-    /** 运行中 */
-    Running = 2,
-    /** 执行成功 */
-    RunSuccess = 3,
-    /** 执行失败 */
-    RunFailed = 4,
-    /** 手动终止 */
-    ManualTerminated = 5
-}
-/** elt 产物状态 */
-export declare enum EtlProductStatus {
-    /**
-     * 正常输出中
-     */
-    Running = 1,
-    /** 已解绑 */
-    UnBind = 2,
-    /** 已删除 */
-    Deleted = 3
-}
-/** etl 产物信息 */
-export interface IEtlMeta {
-    /** etl 信息 */
-    etlId: string;
-    /** etl name */
-    etlName: string;
-    /** elt 发布状态 */
-    etlPublishStatus: EtlPublishStatus;
-    /** 是否停止调度了 */
-    etlSchedulePaused: boolean;
-    /** 创建时间 */
-    gmtCreate: string;
-    /** 修改时间 */
-    gmtModified: string;
-    /** 作品id */
-    productId: string;
-    /** 产物名称 */
-    productName: string;
-    /** 作品地址，数据源id或者文件夹id */
-    productAimDirId: string;
-    /** 文件夹名称或者数据源名称 */
-    productAimDirName: string;
-    /** 产物状态 已删除等 */
-    productStatus: EtlProductStatus;
-    /**  产物类型，数据表或数据集 */
-    productType: string;
-    /** 最后一次调度状态 */
-    lastScheduleStatus: EtlScheduleStatus;
-}

package/esm/open/common/event-types.d.ts

@@ -1,22 +0,0 @@
-/**
- * @author 海狸
- * @description 开放事件类型定义
- */
-import type { EnumAsUnion } from './tools';
-/** 开放相关事件枚举, 取值固定为 before-xxx-event, after-xxx-event */
-export declare enum OpenEventTypeEnum {
-    /** 嵌入事件-页面跳转前 */
-    'before-page-change-event' = "before-page-change-event",
-    /** 自定义事件-下载前 */
-    'before-download-event' = "before-download-event",
-    /** 自定义事件-页面加载前 */
-    'before-page-loaded-event' = "before-page-loaded-event",
-    /** 自定义事件-发布前 */
-    'before-publish-event' = "before-publish-event"
-}
-/** 开放相关事件取值固定为 before-xxx-event, after-xxx-event  */
-export type OpenEventTypeValue = `before-${string}-event` | `after-${string}-event`;
-/** 开放事件名类型校验器 */
-export type CreateOpenEventTypeUnion<T extends OpenEventTypeValue> = T extends OpenEventTypeValue ? T : never;
-/** 开放相关页面类型值联合类型 */
-export type OpenEventTypeUnion = CreateOpenEventTypeUnion<EnumAsUnion<typeof OpenEventTypeEnum>>;

package/esm/open/common/misc.d.ts

@@ -1,11 +0,0 @@
-/**
- * @author 海狸
- * @description 开放通类型定义
- */
-/** 开放相关设备类型 */
-export declare enum OpenDeviceTypeEnum {
-    /** 桌面端 */
-    pc = "pc",
-    /** 移动端 */
-    mobile = "mobile"
-}

package/esm/open/common/page-types.d.ts

@@ -1,19 +0,0 @@
-/**
- * @author 海狸
- * @description 开放页面类型定义
- */
-/**
- * @deprecated 开放相关页面类型枚举, 注意要和 routerKkey 做区分, 这个 key 后续要废弃
- * */
-export declare enum OpenPageTypeEnum {
-    /** 仪表板 */
-    dashboard = "dashboard",
-    /** 电子表格 */
-    webExcel = "webExcel",
-    /** 数据大屏 */
-    screen = "screen",
-    /** 自助取数 */
-    offline = "offline",
-    /** 即席分析 */
-    analysis = "analysis"
-}

package/esm/open/common/tools.d.ts

@@ -1,23 +0,0 @@
-/**
- * @author 海狸
- * @description 开放工具类型定义
- */
-type StringValues<T> = {
-    [K in keyof T]: T[K] extends string ? T[K] : never;
-}[keyof T];
-type NumberValues<T> = {
-    [K in keyof T]: T[K] extends number ? T[K] : never;
-}[keyof T];
-/** 类型实现接口 */
-export type Implements<T, U extends keyof U extends keyof T ? T : never> = U;
-/**
- * 将 enum 的 value 值转为 union
- * @usage EnumAsUnion<typeof MyEnum>
- */
-export type EnumAsUnion<T> = `${StringValues<T>}` | NumberValues<T>;
-/**
- * 字符串中划线类型
- * @usage Kebab<'aaa-bbb'>
- */
-export type KebabCase<T extends string, A extends string = ''> = T extends `${infer F}${infer R}` ? KebabCase<R, `${A}${F extends Lowercase<F> ? '' : '-'}${Lowercase<F>}`> : A;
-export {};

package/esm/open/components/component-lifecycle.d.ts

@@ -1,36 +0,0 @@
-/**
- * @author 海狸
- * @description 组件生命周期
- */
-/**
- * 开放组件生命周期属性
- */
-export interface LifecycleProps<T = object> {
-    container?: HTMLElement;
-    customProps?: T;
-}
-/**
- * 开机阶段钩子
- */
-export type LifecycleBootstrap<T = object, P = any> = (props?: LifecycleProps<T>) => void | Promise<P>;
-/**
- * 渲染阶段钩子
- */
-export type LifecycleMount<T = object, P = any> = (props?: LifecycleProps<T>) => void | Promise<P>;
-/**
- * 卸载阶段钩子
- */
-export type LifecycleUnmount<T = object, P = any> = (props?: LifecycleProps<T>) => void | Promise<P>;
-/**
- * 更新阶段钩子
- */
-export type LifecycleUpdate<T = object, P = any> = (props?: LifecycleProps<T>) => void | Promise<P>;
-/**
- * 开放组件生命周期
- */
-export interface Lifecycle {
-    bootstrap?: LifecycleBootstrap;
-    mount?: LifecycleMount;
-    unmount?: LifecycleUnmount;
-    update?: LifecycleUpdate;
-}

package/esm/open/components/component-meta.d.ts

@@ -1,27 +0,0 @@
-/**
- * @author 海狸
- * @description 组件元信息接口
- */
-import type { ComponentProps } from './component-props';
-import type { DataSchema } from './data-schema';
-import type { MenuSchema } from '../menus/menu-schema';
-import type { StyleSchema } from './style-schema';
-/**
- * 面板配置
- */
-export interface ComponentMetaPropsSchema {
-    /** 数据面板配置 */
-    dataSchema?: DataSchema;
-    /** 样式面板配置 */
-    styleSchema?: StyleSchema | ((componentProps: ComponentProps) => StyleSchema);
-    /** 高级面板配置 */
-    advancedSchema?: StyleSchema | ((componentProps: ComponentProps) => StyleSchema);
-    /** 自定义菜单配置 */
-    menuSchema?: MenuSchema;
-}
-/**
- * 组件元信息
- */
-export interface ComponentMeta {
-    propsSchema?: ComponentMetaPropsSchema;
-}

package/esm/open/components/component-props.d.ts

@@ -1,148 +0,0 @@
-/**
- * @author 海狸
- * @description 组件 props 接口
- */
-import type { NumberFormat } from '../../chart-config';
-import type { DataCell, AreaModel, GlobalConfig } from '../../standard-model';
-export interface ComponentPropsGlobalConfig extends GlobalConfig {
-    /**
-     * @deprecated
-     * 预览态 编辑态
-     * */
-    renderMode?: 'render' | 'edit';
-}
-/**
- * 图表关联数据集 配置
- * */
-export interface ComponentPropsCubeConfig {
-    /** 数据集ID */
-    cubeId: string;
-    /** 数据集名称 */
-    cubeName: string;
-}
-/**
- * 图表选中, 包含下钻/联动/跳转
- */
-interface ComponentPropsActionSelect {
-    type: 'select';
-    payload: {
-        dataIndex: number;
-    };
-}
-/**
- * 图表取消选中, 包含下钻/联动/跳转
- */
-interface ComponentPropsActionCancelSelect {
-    type: 'cancelSelect';
-}
-/**
- * 修改 viewConfig 的值
- */
-interface ComponentPropsActionChangeViewConfig {
-    type: 'changeViewConfig';
-    payload: {
-        [key: string]: any;
-    };
-}
-/**
- * 取消下钻
- */
-interface ComponentPropsActionCancelDrill {
-    type: 'cancelDrill';
-}
-/**
- * 取消联动
- */
-interface ComponentPropsActionCancelLinkage {
-    type: 'cancelLinkage';
-}
-export type ComponentPropsDispatch = (param: ComponentPropsActionSelect | ComponentPropsActionCancelSelect | ComponentPropsActionChangeViewConfig | ComponentPropsActionCancelDrill | ComponentPropsActionCancelLinkage) => void;
-interface ComponentPropsFieldSettingConfig {
-    /** 字段别名 */
-    aliasName: string;
-    /** 是否有更改 */
-    nameChangedFlag: boolean;
-    /** 数值显示格式 */
-    numberFormat: NumberFormat;
-    [key: string]: any;
-}
-export interface ComponentPropsColorSeries {
-    /** 色系key */
-    key: string;
-    /** 色系名称 */
-    name: string;
-    /** 色系颜色 */
-    colors: string[];
-}
-export interface ComponentPropsSkin {
-    /** 色系key */
-    key: 'black' | 'default';
-}
-export interface ComponentPropsViewConfig {
-    /** 标题 */
-    caption?: string;
-    /** 主题 */
-    chartColorSeries?: ComponentPropsColorSeries;
-    /** 皮肤 */
-    chartSkin?: ComponentPropsSkin;
-    /** 展示标题 */
-    title?: {
-        /** 展示主标题/备注 */
-        show: boolean;
-        /** 标题备注 */
-        viceName?: string;
-        /** 标题颜色 */
-        color?: string;
-        /** 展示链接跳转 */
-        showLink?: boolean;
-        /** 链接地址 */
-        link?: string;
-        /** 链接文案 */
-        linkName?: string;
-        /** 链接打开方式 */
-        linkOpen?: 'window' | 'modal';
-    };
-    /** 列设置 */
-    fieldSettingMap?: {
-        [fieldId: string]: ComponentPropsFieldSettingConfig;
-    };
-    /** 宽度 */
-    width?: number;
-    /** 高度 */
-    height?: number;
-    [key: string]: any;
-}
-/**
- * formatAllGranularityTime dimGranularity 枚举值
- */
-export type DimGranularity = 'year' | 'year-quarter' | 'year-month' | 'year-week' | 'year-month-day' | 'hour' | 'hour-minute' | 'hour-minute-second' | 'datetime';
-/**
- * bi 组件通用属性模型
- */
-export interface ComponentProps {
-    /** 自定义组件实例 id */
-    id: string;
-    /** 样式面板配置 */
-    viewConfig: ComponentPropsViewConfig;
-    /** 数据面板配置 */
-    dataConfig: AreaModel[];
-    /** 高级面板配置 */
-    advancedConfig: object;
-    /** 图表全局配置 */
-    globalConfig: ComponentPropsGlobalConfig;
-    /** 数据 */
-    data: Pick<DataCell, 'fieldId' | 'geoInfo' | 'originValue' | 'value'>[][];
-    /** 操作 */
-    dispatch?: ComponentPropsDispatch;
-    /** 工具类方法 */
-    utils?: {
-        formatNumberWithConfig: (num: number | string, config: any) => void;
-        formatAllGranularityTime: (dimGranularity: DimGranularity, formatType: string, raw: string) => void;
-        [key: string]: any;
-    };
-    /** 数据集配置 */
-    cubeConfig?: ComponentPropsCubeConfig[];
-    /** 查询SQL */
-    sql?: string[];
-}
-export {};

package/esm/open/components/data-schema.d.ts

@@ -1,53 +0,0 @@
-/**
- * @author 墨辞
- * @description 自定义组件数据面板的配置接口定义
- */
-import type { DataPanelDataSchema, DataSchemaAreaItem, QueryAxisType, DataSchemaRule, FieldType, FieldGroupType, FieldCollectionType } from '../../data-panel';
-/**
- * platform 环境
- */
-export declare enum Platform {
-    /** 仪表板 */
-    dashboard = "dashboard",
-    /** 电子表格 */
-    excel = "excel",
-    /** 大屏 */
-    screen = "screen"
-}
-/**
- * 区块id枚举
- * - area_column: 列id
- * - area_row: 行id
- * - drill: 下钻id
- * - filters: 过滤器id
- * */
-export type DataSchemaAreaId = 'area_column' | 'area_row' | 'drill' | 'filters';
-/**
- * 自定义组件的数据面板配置项
- */
-export interface DataSchemaArea extends Pick<DataSchemaAreaItem, 'id' | 'name' | 'nameTip'> {
-    /** 字段类型 */
-    queryAxis: keyof typeof QueryAxisType;
-    /** 规则配置 */
-    rule: DataSchemaAreaRule;
-}
-/**
- * 自定义组件的字段规则
- */
-export interface DataSchemaAreaRule extends Pick<DataSchemaRule, 'placeholder' | 'maxColNum' | 'required'> {
-    /** 允许拖拽的字段类型 */
-    fieldTypes?: (keyof typeof FieldType)[];
-    /** 允许拖入的字段组类型 */
-    fieldGroupTypes?: (keyof typeof FieldGroupType)[];
-    /** 允许拖入的字段集合类型 */
-    fieldCollectionTypes?: (keyof typeof FieldCollectionType)[];
-}
-/**
- * 自定义组件的 data-schema
- */
-export interface DataSchema {
-    /** 字段设置 */
-    areas: DataSchemaArea[];
-    /** 结果展示 */
-    resultDisplay: DataPanelDataSchema['resultDisplay'];
-}