@quickbi/bi-types 3.1.3-beta.12 → 3.1.3-beta.13

package/cjs/index.d.ts

@@ -1,6 +1,6 @@
 // Generated by dts-bundle v0.7.3
 // Dependencies for this module:
-//   ../../../../../react
+//   ../../../../../../../../../../react
 
 declare module '@quickbi/bi-types' {
     export { CommonCompInputAreaTypeEnum, DataConfig, DataConfigAreaItemColumn, DataPanelDataSchema, DataSchemaAreaItem, OperationMenuItem, DropdownMenuItem, OperationTypes, Aggregators, FieldConfigTypes, ContrastTypes, AdvanceCalTypes, AdvanceCalcDateTypes, NumberFormats, AlignTypes, VerticalAlignTypes, AlignmentCategory, SortTypes, FieldChartTypes, ImageSizes, CUSTOM_FIELD_TYPES, FieldType, QueryAxisType, DropDownMenuType, SecondFieldType, ChartStatus, StackedSortType, ResultMode, RetainAreaId, ConfigCellType, ConfigColumnType, CheckBoxState, FieldGroupType, DataSchemaRule, TableType, TableDirection, ProportionType, AccumulateCalcType, FieldCollectionType, LnglatGroupChildFlags, FieldGroupSelectorType, VirtualFieldOperation, NumberValueType, ContrastType, } from '@quickbi/bi-types/data-panel';
@@ -15,7 +15,7 @@ declare module '@quickbi/bi-types' {
     export { CustomEventType } from '@quickbi/bi-types/open/events/event-props';
     export type { CustomEventModalPayload, CustomEventPageConfig, CustomEventPropsDispatch, CustomEventProps, } from '@quickbi/bi-types/open/events/event-props';
     export type { CustomEventMeta } from '@quickbi/bi-types/open/events/event-schema';
-    export type { ComponentErrorType, ComponentProps, ComponentPropsColorSeries, ComponentPropsCubeConfig, ComponentPropsDispatch, ComponentPropsGlobalConfig, ComponentPropsSkin, ComponentPropsViewConfig, DimGranularity, } from '@quickbi/bi-types/open/components/component-props';
+    export type { ComponentError, ComponentConfigError, ComponentNoPermissionError, ComponentDataMaskError, ComponentNoDataError, ComponentRenderError, ComponentProps, ComponentPropsColorSeries, ComponentPropsCubeConfig, ComponentPropsDispatch, ComponentPropsGlobalConfig, ComponentPropsSkin, ComponentPropsViewConfig, DimGranularity, } from '@quickbi/bi-types/open/components/component-props';
     export type { ComponentMeta, ComponentMetaPropsSchema } from '@quickbi/bi-types/open/components/component-meta';
     export type { Lifecycle, LifecycleBootstrap, LifecycleMount, LifecycleProps, LifecycleUnmount, LifecycleUpdate, } from '@quickbi/bi-types/open/components/component-lifecycle';
     export * from '@quickbi/bi-types/open/components/style-schema';
@@ -26,6 +26,7 @@ declare module '@quickbi/bi-types' {
     export * from '@quickbi/bi-types/open/components/style-schema';
     export type { MenuMeta, MenuProps, MenuSchema, MenuSchemaBase, MenuSchemaItem } from '@quickbi/bi-types/open/menus/menu-schema';
     export * from '@quickbi/bi-types/open/menus/menu-props';
+    export type { CustomPageConfig, CustomPageProps } from '@quickbi/bi-types/open/custom-page/pages-props';
     export type { EmbedBaseSrc, EmbedBaseFeature, EmbedBaseEventMessageDTO, EmbedBaseEventMessageContent, EmbedBaseEventListener, EmbedBaseEventListenerReturn, } from '@quickbi/bi-types/open/embed/core';
     export { OpenPageTypeEnum } from '@quickbi/bi-types/open/common/page-types';
     export { OpenEventTypeEnum } from '@quickbi/bi-types/open/common/event-types';
@@ -1014,20 +1015,26 @@ declare module '@quickbi/bi-types/open/components/component-props' {
         */
     export type DimGranularity = 'year' | 'fiscal-year' | 'fiscal-year-quarter' | 'year-quarter' | 'year-month' | 'year-week' | 'year-month-day' | 'hour' | 'hour-minute' | 'hour-minute-second' | 'datetime';
     export type ComponentPageConfig = CommonPageConfig;
-    /** 对外图表组件错误类型 */
-    export type ComponentErrorType = 
+    /**
+        * 组件错误类型（泛型）
+        * @template T - 错误名称，默认为 'ComponentError' 表示未知错误
+        */
+    export interface ComponentError<T extends string = 'ComponentError'> {
+            /** 错误名称，用于类型判断 */
+            name: T;
+            /** 错误信息 */
+            message?: string;
+    }
     /** 图表配置错误 */
-    'ConfigurationError'
+    export type ComponentConfigError = ComponentError<'ComponentConfigError'>;
     /** 权限错误 */
-     | 'NoPermission'
+    export type ComponentNoPermissionError = ComponentError<'ComponentNoPermissionError'>;
     /** 数据脱敏错误 */
-     | 'DataMaskError'
-    /** 数据为空 */
-     | 'NoData'
+    export type ComponentDataMaskError = ComponentError<'ComponentDataMaskError'>;
+    /** 数据为空错误 */
+    export type ComponentNoDataError = ComponentError<'ComponentNoDataError'>;
     /** 渲染错误 */
-     | 'RenderError'
-    /** 未知错误 */
-     | 'Unknown';
+    export type ComponentRenderError = ComponentError<'ComponentRenderError'>;
     /**
         * bi 组件通用属性模型
         */
@@ -1035,12 +1042,7 @@ declare module '@quickbi/bi-types/open/components/component-props' {
             /** 组件状态（是否正常渲染） */
             status?: 'success' | 'error';
             /** 错误信息 */
-            error?: {
-                    /** 错误类型 */
-                    type: ComponentErrorType;
-                    /** 错误信息 */
-                    message?: string;
-            };
+            error?: ComponentError | ComponentConfigError | ComponentNoPermissionError | ComponentDataMaskError | ComponentNoDataError | ComponentRenderError;
             /** 组件类型 */
             componentType: ComponentType;
             /** 自定义组件实例 id */
@@ -1526,6 +1528,13 @@ declare module '@quickbi/bi-types/chart-config' {
             /** 空 */
             empty = ""
     }
+    /** 图例显示百分比位置 */
+    export enum LegendDisplayPercentPositionValue {
+            /** 默认值为'-' */
+            Bottom = "bottom",
+            /** 空 */
+            Right = "right"
+    }
     /** 钻取 面包屑的文字样式 */
     export interface DrillBreadcrumbTextStyle {
             fontSize: number;
@@ -2323,6 +2332,7 @@ declare module '@quickbi/bi-types/open/menus/menu-props' {
     import type { EnumAsUnion } from '@quickbi/bi-types/open/common/tools';
     import type { OpenPageTypeEnum } from '@quickbi/bi-types/open/common/page-types';
     import type { OpenDeviceTypeEnum } from '@quickbi/bi-types/open/common/misc';
+    import type { RouteKey } from '@quickbi/bi-types/router/route-key';
     /**
         * 事件/菜单通用的页面信息
         */
@@ -2347,8 +2357,10 @@ declare module '@quickbi/bi-types/open/menus/menu-props' {
             ownerUserName: string;
             /** 页面标题 */
             title: string;
-            /** 页面类型 */
-            pageType: EnumAsUnion<typeof OpenPageTypeEnum>;
+            /** @deprecated 页面类型, 已废弃, 后续请用routeKey判断页面类型  */
+            pageType?: EnumAsUnion<typeof OpenPageTypeEnum>;
+            /** 页面路由 key */
+            routeKey?: RouteKey;
     }
     /**
         * 事件/菜单通用的工具方法
@@ -2496,6 +2508,19 @@ declare module '@quickbi/bi-types/open/menus/menu-props' {
     }
 }
 
+declare module '@quickbi/bi-types/open/custom-page/pages-props' {
+    import type { CommonPageConfig } from '@quickbi/bi-types/open/menus/menu-props';
+    /** 自定义页面的页面信息 */
+    export type CustomPageConfig = Pick<CommonPageConfig, 'userId' | 'userName' | 'routeKey'>;
+    /**
+        * 自定义页面 props 接口
+        */
+    export interface CustomPageProps {
+            /** 页面信息 */
+            pageConfig: CustomPageConfig;
+    }
+}
+
 declare module '@quickbi/bi-types/open/embed/core' {
     /**
       * @author 海狸
@@ -2566,7 +2591,7 @@ declare module '@quickbi/bi-types/open/embed/core' {
 
 declare module '@quickbi/bi-types/open/common/page-types' {
     /**
-        * @deprecated 开放相关页面类型枚举, 注意要和 routerKkey 做区分, 这个 key 后续要废弃
+        * @deprecated 开放相关页面类型枚举, 注意要和 routerKey 做区分, 这个 key 后续要废弃
         * */
     export enum OpenPageTypeEnum {
             /** 仪表板 */
@@ -6832,7 +6857,9 @@ declare module '@quickbi/bi-types/cube/data-source' {
             /** 达梦 */
             dm = "dm",
             /** 日志服务SLS */
-            sls = "sls"
+            sls = "sls",
+            /** RDS MySQL DuckDB */
+            mysql_duckdb = "mysql_duckdb"
     }
     export enum AcrossDsType {
             UN_SET,
@@ -6855,7 +6882,9 @@ declare module '@quickbi/bi-types/cube/data-source' {
             /** 端口号为8242 此后所有注释 皆为表明 变量代表的端口号码 */
             eight_two_four_two = "8242",
             three_three_zero_six_zero = "33060",
-            three_zero_zero_six_zero = "30060"
+            three_zero_zero_six_zero = "30060",
+            three_three_zero_six = "33306",
+            one_zero_zero_zero_zero = "10000"
     }
     /** 数据源 - 根据类型 - 排序 */
     export enum DataSourceSort {
@@ -6891,8 +6920,6 @@ declare module '@quickbi/bi-types/cube/data-source' {
             google = "google",
             customDs = "customDs"
     }
-    /** 数据库数据源类型 */
-    export const dataBaseType: DataSourcesConfigId[];
     /** 文档数据源 */
     export const SHEET_TABLE: DsType[];
 }