@quickbi/bi-types 3.0.41-beta.9 → 3.0.41

package/cjs/cube/cube-model.d.ts

@@ -0,0 +1,611 @@
+/**
+ * @author 无愚
+ * @description 数据集接口模型
+ */
+import type { DsCreateOriginEnum, DsType, DataLoadMode } from './data-source';
+export declare enum CustomAreaType {
+    /** 自定义地理信息 */
+    CUSTOM_AREA = "CUSTOM_AREA",
+    /** 自定义geojson */
+    CUSTOM_GEOJSON = "CUSTOM_GEOJSON",
+    /** 自定义层级 */
+    CUSTOM_TREE = "CUSTOM_TREE",
+    /** 自定义图片 */
+    CUSTOM_PICTURE = "CUSTOM_PICTURE"
+}
+/** 自定义图片底图信息 */
+export declare enum PictureCoordinateType {
+    /** 纵坐标 */
+    HORIZONTAL = "CUSTOM_PICTURE_HORIZONTAL",
+    /** 横坐标 */
+    VERTICAL = "CUSTOM_PICTURE_VERTICAL"
+}
+/** 自定义地理信息 */
+export interface ExtraInfo {
+    /** 自定义层级Id */
+    customGeoLevel?: number;
+    /** 自定义图片类型 */
+    pictureCoordinateType?: PictureCoordinateType;
+}
+/**
+ * 关联字段
+ * 数据混合blend和数据集物理表关联physical均使用该字段
+ */
+export type JoinKey = {
+    /** 源表字段（blend模式为数据集字段id，physical模式为物理字段名） */
+    sourceKey: string;
+    /**
+     * @deprecated
+     * 源表关联物理字段类型(QBI目前没在用，保留)
+     */
+    sourceType?: string;
+    /** 目标表字段（blend模式为数据集字段id，physical模式为物理字段名） */
+    targetKey: string;
+    /**
+     * @deprecated
+     * 标表关联物理字段类型(QBI目前没在用，保留)
+     */
+    targetType?: string;
+    /**
+     * @deprecated
+     * 条件（目前QBI只支持这个equal-to）
+     */
+    condition: JoinCondition;
+    /**
+     * 目前仅physical模式使用
+     */
+    targetCalculateMember?: boolean;
+    /**
+     * 目前仅physical模式使用
+     */
+    sourceCalculateMember?: boolean;
+};
+/** 表模型 */
+export interface PhysicalTable {
+    /** 唯一标识 */
+    uniqueId: string;
+    /** 表展示名称 */
+    caption?: string;
+    /** 表id */
+    tableName: string;
+    /** 物理表所属数据源ID */
+    datasourceId: string;
+    /** 是否为事实表（中心表标识） */
+    factTable: boolean;
+    dsType: DsType;
+}
+/** 表模型 */
+export interface VirtualTable {
+    /** 唯一标识 */
+    uniqueId: string;
+    /** 表展示名称 */
+    caption: string;
+    /** 表名 */
+    tableName: string;
+    /** 物理表所属数据源ID */
+    datasourceId: string;
+    /** 是否为事实表（中心表标识） */
+    factTable: boolean;
+    dsType: DsType;
+    sqlId: string;
+    sql: string;
+}
+export interface Link {
+    /** 源表id（blend模式为数据集id，physical模式为物理表id） */
+    source: string;
+    /** 关联表id（blend模式为数据集id，physical模式为物理表id） */
+    target: string;
+    /** 关联类型 */
+    joinType: TableJoinType;
+    /**
+     * @deprecated
+     * 目前只有many-to-one
+     */
+    relation?: TableRelation;
+    joinKeys: JoinKey[];
+}
+/** 物理表关联模型 */
+export type PhysicalLink = Link;
+export declare class PhysicalSchema {
+    tables: PhysicalTable[];
+    /** 自定义sql、view */
+    virtualTables: VirtualTable[];
+    /** 表关联关系 */
+    links: PhysicalLink[];
+    /** odps表是否开启全表扫描 */
+    sqlHintTypes?: string[];
+    sqlHints?: HintModal[];
+}
+/** 数据集层级结构/文件夹/属性的嵌套关系 */
+export type FieldTree = AttributeNode | FolderAndHierarchyNode;
+export type AttributeMapValue = {
+    attribute: FieldAttribute;
+    type: 'Dimension' | 'Measure';
+};
+/** 数据集逻辑模型 */
+export declare class CubeSchema {
+    /** 唯一标识，无业务逻辑，不要使用 */
+    uniqueId: string;
+    /** 数据集ID */
+    cubeId: string;
+    /** 数据源ID */
+    datasourceId: string;
+    /** 数据集名称 */
+    caption: string;
+    /** 字段列表 */
+    fields: Field[];
+    /** 普通字段、层系、文件夹树形结构 */
+    fieldTree: FieldTree[];
+    /** 过滤条件 */
+    filter?: FilterAttr[];
+    /** 全局参数 */
+    params: ParamType[];
+    /** 占位符 */
+    sqlPlaceholders: ParamType[];
+}
+/** 数据集额外信息 */
+export declare class SchemaExtraInfo {
+    /** 数据集所在工作空间的文件夹位置 */
+    aimDirId: string;
+    hasAuthorizedUse?: boolean;
+    /** 权限列表 */
+    permissionList?: string[];
+    /** 行级权限，列级权限字段id */
+    dataLevelAttributeIds: string[];
+    /** 无列级权限的字段 */
+    withoutColumnLevelPermissionFields: string[];
+    /** 聚合方式 */
+    aggFunctions?: string[];
+    /** 是否开启数据脱敏 */
+    isDataMaskOpen?: number;
+    /** 是否开启列级权限 1=开启 0=未开启 */
+    isOpenColumnLevelPermission?: number;
+    /** 是否开启了行级权限 1=开启 0=未开启 */
+    isOpenRowLevelPermission?: number;
+    /** 当前数据集来自的类型 */
+    dsCreateOrigin?: DsCreateOriginEnum;
+    /** 跨源模式 */
+    dataLoadMode?: DataLoadMode;
+    /** 是否为etl 生成的数据集 */
+    etlGenerateCube?: boolean;
+    /** 数据集类型 */
+    cubeType?: 'upload' | 'upload_static';
+    /** 数据集owner */
+    creatorId?: string;
+}
+/** 数据集模型 */
+export declare class CubeModel {
+    /** 物理表 */
+    physicalSchema: PhysicalSchema;
+    /** 数据集逻辑模型 */
+    cubeSchema: CubeSchema;
+    /** 数据集结构版本 */
+    metaModelVersion: string;
+    /** 数据集订正版本（前端使用） */
+    userDefineVersion: string;
+    /** 数据集额外信息 */
+    schemaExtraInfo: SchemaExtraInfo;
+}
+/** 数据集影子模型 */
+export type CubeShadow = CubeSchema;
+/** 表关联类型 */
+export declare enum TableJoinType {
+    LEFT_OUTER_JOIN = "LEFT_OUTER_JOIN",
+    INNER_JOIN = "INNER_JOIN",
+    FULL_OUTER_JOIN = "FULL_OUTER_JOIN",
+    JOIN_ERROR = "JOIN_ERROR"
+}
+export declare enum TableRelation {
+    MANY_TO_ONE = "many-to-one"
+}
+export declare enum JoinCondition {
+    EQUAL_TO = "equal-to",
+    UNEQUAL_TO = "unequal-to",
+    GREATER_THAN = "greater-than",
+    LESS_THAN = "less-than"
+}
+/** 字段列表定义，包含维度、度量 */
+export interface Field {
+    /** 唯一标识 */
+    uniqueId: string;
+    /** 字段名称 */
+    caption: string;
+    type: 'Dimension' | 'Measure';
+    /** 标记数据面板上的字段、文件夹，和数据集原有的字段、文件夹区别开来 */
+    fromPanel?: boolean;
+    /** 老接口保留字段（计算字段expression中作为唯一标识使用）,新数据跟uniqueId值相同 */
+    name?: string;
+    /** 引用表id */
+    table: string;
+    /** 物理字段 */
+    column: string;
+    /** 是否为衍生字段，分组字段和计算字段都为true */
+    calculateMember: boolean;
+    /** 字段描述，仅日期类型会使用 */
+    comments?: string;
+    attributes: FieldAttribute[];
+}
+/** 当前数据类型，如果没有进行过类型切换，则和OriginDataType一致 影响sql生成 (原colType) */
+export declare enum DataType {
+    number = "number",
+    string = "string",
+    date = "date",
+    datetime = "datetime",
+    time = "time"
+}
+/** 二级数据类型：不影响sql生成，影响内存处理及前端icon展示（如：地理维度、） */
+export declare enum SecondDataType {
+    number = "number",
+    string = "string",
+    geographic = "geographic",
+    imageUrl = "imageUrl",
+    imageFileId = "imageFileId",
+    date = "date",
+    datetime = "datetime",
+    time = "time",
+    multiValue = "multi_value"
+}
+/** 物理数据类型：第一次初始化时填写，后续不会修改 */
+export type OriginDataType = DataType;
+/** 年粒度日期类型 */
+export declare enum CalendarTypeEnum {
+    /** 公历年 */
+    GregorianYear = "gregorian-year",
+    /** 财年 */
+    FiscalYear = "fiscal-year",
+    /** 农历年 */
+    LunarYear = "lunar-year"
+}
+/** 日期维度支持的粒度 */
+export declare enum DateGranularity {
+    year = "year",
+    fiscalYear = "fiscal-year",
+    quarter = "year-quarter",
+    fiscalYearQuarter = "fiscal-year-quarter",
+    month = "year-month",
+    week = "year-week",
+    day = "year-month-day",
+    hour = "hour",
+    minute = "hour-minute",
+    second = "hour-minute-second",
+    datetime = "datetime"
+}
+/** 地理维度支持的粒度 */
+export declare enum RegionGranularity {
+    /** 洲 */
+    continent = "CONTINENT",
+    /** 国家 */
+    country = "COUNTRY",
+    /** 区域 */
+    region = "REGION",
+    /** 省 */
+    province = "PROVINCE",
+    /** 市 */
+    city = "CITY",
+    /** 区 */
+    xian = "XIAN",
+    /** 街道 */
+    street = "STREET",
+    /** 经度 */
+    lng = "LNG",
+    /** 纬度 */
+    lat = "LAT",
+    /** 自定义区域 */
+    custom_region = "CUSTOM_REGION"
+}
+/** 多值分隔符 */
+export declare enum MultiSeparator {
+    comma = ",",
+    semicolon = ";",
+    space = " "
+}
+/**
+ * 维度树结构类型
+ * Normal: 正常层级结构
+ * Date: 日期类型层级结构
+ * Linked: 关联类型文件夹
+ */
+export type DimensionTreeFlags = 'DimensionNormal' | 'DimensionDate' | 'DimensionLinked' | null;
+/**
+ * 度量树结构类型
+ * Normal: 正常层级结构
+ * Linked: 关联类型文件夹
+ */
+export type MeasureTreeFlags = 'MeasureNormal' | 'MeasureLinked' | null;
+/**
+ * 树节点类型
+ * folder: 文件夹
+ * hierarchy: 层级结构
+ * attribute: 普通节点
+ * dimensionGroup: 维度组
+ * measureGroup: 度量组
+ * lnglatGroup: 经纬度组
+ * */
+export type TreeNodeTypes = 'folder' | 'hierarchy' | 'attribute' | 'dimensionGroup' | 'measureGroup' | 'lnglatGroup';
+/** 分组字段类型 */
+export type GroupType = 'NormalGroup' | 'ListGroup' | 'CustomizedGroup';
+/** 数值-自定义分组类型 */
+export type CustomizedGroup = {
+    /** 是否是默认分组字段 */
+    groupName: string;
+    defaultGroup: boolean;
+    lower: string;
+    upper: string;
+    lowerOperator: 'greaterThan' | 'greaterThanOrEqualTo';
+    upperOperator: 'lessThan' | 'lessThanOrEqualTo';
+    groupNameType: any;
+};
+/** 枚举-列表分组类型 */
+export type ListGrouping = {
+    groupName: string;
+    groupElementList: string[];
+    defaultGroup: boolean;
+};
+/** 日期类型-自定义区间分组 */
+export type NormalGroup = {
+    groupName: string;
+    defaultGroup: boolean;
+    lower: string;
+    upper: string;
+    lowerOperator: 'greaterThanOrEqualTo';
+    upperOperator: 'lessThanOrEqualTo';
+};
+/** 分组字段 */
+export type Groups = CustomizedGroup[] | ListGrouping[] | NormalGroup[];
+/** 空值展示配置类型 */
+export declare enum EmptyValueType {
+    /** 空值 */
+    EmptyValue = "EmptyValue",
+    /** 空字符串 */
+    EmptyString = "EmptyString"
+}
+/** 空值展示配置枚举 */
+export declare enum EmptyValueDisplayType {
+    /** 展示为'-' */
+    Hyphen = "hyphen",
+    /** 展示为{空}/{空字符串} */
+    Braces = "braces",
+    /** 展示为"null" */
+    Null = "null",
+    /** 不展示 */
+    NotDisplay = "notDisplay",
+    /** 自定义 */
+    Custom = "custom"
+}
+export declare class EmptyStringOrNullDisplayConfig {
+    /** 展示类型 */
+    formatType: EmptyValueDisplayType;
+    /** 自定义展示内容 */
+    customFormat: string;
+    /** 是否是自动（继承数据集） */
+    isAuto?: boolean;
+}
+/** 空值展示配置 */
+export declare class EmptyValueDisplayConfig {
+    /** 空值展示配置 */
+    emptyValueConfig: EmptyStringOrNullDisplayConfig;
+    /** 空字符串展示配置 */
+    emptyStringConfig: EmptyStringOrNullDisplayConfig;
+    static getDefaultConfigForQuickReport(): EmptyValueDisplayConfig;
+    static convertAttrEmptyValueDisplayConfig(attr: FieldAttribute, isAuto?: boolean): EmptyValueDisplayConfig;
+    /** 根据fieldSettingMap中存储的配置转换成空值展示配置模型 */
+    static getConfigByFieldSettingMap(fieldSetting: any, defaultValue?: any): EmptyValueDisplayConfig;
+}
+/** 字段属性 */
+export interface FieldAttribute {
+    /** 唯一标识 */
+    uniqueId: string;
+    /** 显示名称 */
+    caption: string;
+    /** 一级数据类型（分析类型）：影响sql生成 */
+    dataType: DataType;
+    /** 二级数据类型：不影响sql生成，影响内存处理及前端icon展示（如：地理维度、） */
+    secondDataType: SecondDataType | null;
+    /** 原始物理数据类型 */
+    originDataType: OriginDataType | null;
+    /** 格式化格式 */
+    format: string | null;
+    /** 表数据物理存储格式(暂未使用2021-03) */
+    dataFormat: string | null;
+    /** 聚合方式 */
+    aggregator: Aggregator | null;
+    /** 是否支持做聚合, 维度=null, 普通度量/非聚合的扩展度量=true, 聚合扩展度量=false */
+    supportAggregation: boolean | null;
+    /** 自定义周的开始时间，只在周类型时间维度有效, 从 1-7 代表周一到周日 */
+    firstDayOfWeek: number | null;
+    /** 财年开始的月份 只有year和quarter粒度有 从1-12代表1月份到12月份 */
+    firstMonthOfYear?: number | null;
+    /** 年日期类型 */
+    calendarType?: CalendarTypeEnum;
+    /** 是否隐藏 */
+    isHidden: boolean;
+    /** 倍率 */
+    mult: string | null;
+    /** 维度、粒度 */
+    granularity: DateGranularity | RegionGranularity | null;
+    /** 计算字段、分组字段 */
+    expression?: Expression;
+    /** 标记数据面板上的字段、文件夹，和数据集原有的字段、文件夹区别开来 */
+    fromPanel?: boolean;
+    /** 老接口保留字段（计算字段expression中作为唯一标识使用）,新数据跟uniqueId值相同 */
+    name?: string;
+    /** 字段描述 */
+    comments?: string;
+    /** 字段自定义排序设置 */
+    sortModel?: {
+        sortType: 'ASC' | 'DESC' | 'CUSTOM';
+        customOrder: string;
+        orderByList?: any;
+    };
+    /** 多值分隔符 */
+    separator?: MultiSeparator | string;
+    /** 空值展示格式类型 */
+    nullValueFormatType: EmptyValueDisplayType;
+    /** 空值自定义展示格式 */
+    nullValueCustomFormat: string;
+    /** 空字符串展示格式类型 */
+    emptyStringFormatType?: EmptyValueDisplayType;
+    /** 空字符串自定义展示格式 */
+    emptyStringCustomFormat?: string;
+    /** TODO: 将自定义区域收拢到一个字段信息中，而不是散落在 attribute  */
+    /** 自定义区域id */
+    refCustomRegion?: string;
+    /** 自定义地理类型 */
+    customAreaType?: CustomAreaType;
+    /** 数据集属性额外信息 */
+    extraInfo?: ExtraInfo;
+}
+/** 度量类型聚合方式 */
+export declare enum Aggregator {
+    'sum' = "sum",
+    'count' = "count",
+    'distinct-count' = "distinct-count",
+    'max' = "max",
+    'min' = "min",
+    'avg' = "avg"
+}
+export interface Expression {
+    type: 'dataGroup' | 'udf' | 'system';
+    value?: string;
+    /** 分组字段配置 */
+    dataGroup: {
+        /** 唯一标识 */
+        uniqueId: string;
+        /** 分组名称 */
+        caption: string;
+        /** 分组类型 */
+        groupType: GroupType;
+        refUniqueId: string;
+        /** qa中使用。qbi目前用不到 */
+        refSql?: string;
+        /** qa中使用。qbi目前用不到 */
+        refFunction?: string;
+        /** 数值类型分组字段 */
+        customizedGroups?: CustomizedGroup[];
+        /** 字符串类型分组字段 */
+        listGroupings?: ListGrouping[];
+        /** 日期类型分组字段 */
+        normalGroups?: NormalGroup[];
+    };
+}
+export declare class FilterAttr {
+    logicalOperator: 'and' | 'or';
+    /** 过滤值 */
+    filterElements: FilterElement[];
+    /** 嵌套过滤条件 */
+    filters: FilterAttr[];
+    beforeJoin?: boolean;
+    tableId?: string;
+}
+export interface FilterElement {
+    /** 过滤条件引用的字段uid */
+    resourceId: string;
+    /** 过滤条件比较运算符：> < =, 和查询控件所用保持一致 */
+    functionalOperator: string;
+    values: {
+        type?: 'absolute' | 'relative' | null;
+        value: string;
+    }[];
+    /** 前端是否隐藏掉 */
+    hidden?: boolean;
+}
+/** 普通字段 */
+export interface AttributeNode {
+    /** 字段ID */
+    id: string;
+    /** 节点类型 */
+    type: TreeNodeTypes;
+    /** 标记数据面板上的字段、文件夹，和数据集原有的字段、文件夹区别开来 */
+    fromPanel?: boolean;
+    /** 节点名称,attribute类型为null */
+    name?: null;
+    caption?: string;
+    children?: (AttributeNode | FolderAndHierarchyNode)[];
+    flag: null;
+    /** 所引用的关联表的id，仅flag为DimensionLinked和MeasureLinked时存在 */
+    refUniqueId?: null;
+}
+/** 文件夹和层级字段 */
+export interface FolderAndHierarchyNode {
+    /** 字段ID */
+    id?: string;
+    /** 节点类型 */
+    type: TreeNodeTypes;
+    /** 标记数据面板上的字段、文件夹，和数据集原有的字段、文件夹区别开来 */
+    fromPanel?: boolean;
+    /** 节点名称 */
+    name?: string;
+    /** 节点名称,attribute类型为null */
+    caption?: string;
+    /** 所引用的关联表的id，仅flag为DimensionLinked和MeasureLinked时存在 */
+    refUniqueId?: string;
+    children?: (AttributeNode | FolderAndHierarchyNode)[];
+    /** 文件夹和层级结构类型 */
+    flag: DimensionTreeFlags | MeasureTreeFlags;
+}
+/**
+ * 日期占位符的类型（单个/范围）
+ */
+export declare enum OriginDateType {
+    /** 单个日期 */
+    SingleDate = "singleDate",
+    /** 日期区间 */
+    DateRange = "dateRange"
+}
+export interface ParamType {
+    /** sql参数id */
+    uniqueId?: string;
+    /** 是否启用此参数 */
+    /** 占位符名称 */
+    name: string;
+    /** 类型 */
+    style: 'condition' | 'placeholder' | 'param';
+    /** 占位符格式化类型 */
+    type: ParamDataType;
+    table: string;
+    format: string;
+    firstDayOfWeek: number;
+    /** 是否是影子数据集的占位符 */
+    fromPanel?: boolean;
+    /** condition条件参数时，才会有该属性 */
+    conditionPlaceHolderFields?: {
+        uniqueId: string;
+        name: string;
+        column: string;
+        table: string;
+    }[];
+    /** sql 占位符的原始类型 */
+    originalType: 'dateRange';
+    /** sql 参数，占位符默认值 */
+    defaultValue?: (string | number)[];
+    /** 默认值是否全局生效，true: 生效范围与过滤器一致。false: 默认值仅在数据集生效 */
+    useInGlobal?: boolean;
+}
+/** 占位符参数 */
+export declare enum ParamDataType {
+    string = "string",
+    number = "number",
+    dateRegion = "dateRegion",
+    quarterRegion = "quarterRegion",
+    monthRegion = "monthRegion",
+    weekRegion = "weekRegion",
+    yearRegion = "yearRegion",
+    ymdHmsRegion = "ymdHmsRegion"
+}
+/** 返回值cellset中的dimType */
+export declare enum CellsetDimTypes {
+    StandardDimension = "StandardDimension",
+    StrDateTypeDimension = "StrDateTypeDimension",
+    StarDimension = "StarDimension",
+    GeographicDimension = "GeographicDimension",
+    /** 上面为维度字段，measureCol代表度量 */
+    measureCol = "measureCol"
+}
+export declare class HintModal {
+    dsType: DsType;
+    head: `set`;
+    key: string;
+    connector: `=`;
+    value: string;
+    support: boolean;
+}