@quickbi/bi-types 3.0.41-beta.0 → 3.0.41-beta.2

package/cjs/index.d.ts

@@ -1,5 +1,6 @@
 // Generated by dts-bundle v0.7.3
 // Dependencies for this module:
+//   ../../../../../@quickbi/bi-types
 //   ../../../../../react
 
 declare module '@quickbi/bi-types' {
@@ -24,13 +25,15 @@ 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 { EmbedBase, EmbedBaseSrc, EmbedBaseFeature, EmbedBaseAction, EmbedBaseListener, EmbedBaseEventHandler, } from '@quickbi/bi-types/open/embed/core';
+    export type { EmbedBaseSrc, EmbedBaseFeature, EmbedBaseAction, EmbedBaseEvents, EmbedBaseEventHandler, EmbedBaseEventMessageDTO, EmbedBaseEventMessageContent, } from '@quickbi/bi-types/open/embed/core';
     export { EmbedEnv } from '@quickbi/bi-types/open/embed/core';
-    export type { OpenPageTypeUnion, OpenPageTypeEnum } from '@quickbi/bi-types/open/common/page-types';
-    export type { OpenEventTypeEnum } from '@quickbi/bi-types/open/common/event-types';
+    export type { OpenPageTypeEnum } from '@quickbi/bi-types/open/common/page-types';
+    export { OpenEventTypeEnum } from '@quickbi/bi-types/open/common/event-types';
     export type { OpenDeviceTypeEnum } from '@quickbi/bi-types/open/common/misc';
     export type { EnumAsUnion, Implements } from '@quickbi/bi-types/open/common/tools';
-    export { RouterKey } from '@quickbi/bi-types/router/router-key';
+    export { RouteKey } from '@quickbi/bi-types/router/route-key';
+    export { ROUTE_TREE, ROUTE_PATH_MAP } from '@quickbi/bi-types/router/route-tree';
+    export type { RouteTreeNode } from '@quickbi/bi-types/router/route-tree';
 }
 
 declare module '@quickbi/bi-types/data-panel' {
@@ -2204,7 +2207,7 @@ declare module '@quickbi/bi-types/open/menus/menu-props' {
             /** 页面标题 */
             title: string;
             /** 页面类型 */
-            pageType: EnumAsUnion<Pick<typeof OpenPageTypeEnum, 'dashboard' | 'webExcel' | 'screen' | 'offline' | 'analysis'>>;
+            pageType: EnumAsUnion<typeof OpenPageTypeEnum>;
     }
     /**
         * 事件/菜单通用的工具方法
@@ -2357,28 +2360,26 @@ declare module '@quickbi/bi-types/open/embed/core' {
       * @author 海狸
       * @description 嵌入通用类型定义
       */
-    import type { OpenEventTypeEnum } from '@quickbi/bi-types/open/common/event-types';
-    import type { OpenDeviceTypeEnum } from '@quickbi/bi-types/open/common/misc';
-    import type { OpenPageTypeUnion } from '@quickbi/bi-types/open/common/page-types';
-    import type { EnumAsUnion } from '@quickbi/bi-types/open/common/tools';
+    import type { RouteKey } from '@quickbi/bi-types/router/route-key';
     /** 通用页面来源信息 */
     export type EmbedBaseSrc = {
         /** 嵌入页面 */
-        page: OpenPageTypeUnion;
-        /** 嵌入 token */
-        accessTicket?: string;
-        /** 空间 id */
-        workspaceId?: string;
-        /** 作品 id */
-        id?: string;
+        page: RouteKey;
         /** 域名信息 */
         origin?: string;
-        /** 页面模式 */
-        mode?: 'edit' | 'view';
-        /** 显示设备 */
-        device?: EnumAsUnion<typeof OpenDeviceTypeEnum>;
         /** 额外的 url 参数 */
-        search?: Record<string, string>;
+        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;
@@ -2388,75 +2389,54 @@ declare module '@quickbi/bi-types/open/embed/core' {
         show?: boolean;
     }
     /** 嵌入特性配置 */
-    export type EmbedBaseFeature = Partial<Record<OpenPageTypeUnion, EmbedBaseFeatureItem>>;
+    export type EmbedBaseFeature = Partial<Record<RouteKey, EmbedBaseFeatureItem>>;
+    /** 页面事件 message 传参格式 */
+    export type EmbedBaseEventMessageDTO<T extends EmbedBaseEventMessageContent> = {
+        /** 事件会话 id */
+        sessionId: string;
+        /** 事件消息 id */
+        messageId: string;
+        /** 事件数据真实内容 */
+        content: T;
+    };
     /** 页面事件接口校验 */
-    export type EmbedBaseEventHandler<P = any, T = any> = (param: P) => Promise<T>;
+    export type EmbedBaseEventHandler<P = any, T = any> = (data: EmbedBaseEventMessageContent<P>) => Promise<T>;
     /** 页面事件接口 */
-    export type EmbedBaseListener = Partial<Record<EnumAsUnion<Pick<typeof OpenEventTypeEnum, 'before-navigate-event'>>, EmbedBaseEventHandler>>;
-    /** 嵌入客户端行为 */
-    export type EmbedBaseAction<T = object> = {
+    export type EmbedBaseEvents<T extends string> = Partial<Record<T, EmbedBaseEventHandler<any>>>;
+    /** 嵌入消息统一格式 */
+    export type EmbedBaseEventMessageContent<T = any> = {
         /** 行为类型 */
         type: string;
         /** 行为传参, 必须能序列化 */
         payload: T;
     };
-    /** 生成嵌入基本类型 */
-    type CreateEmbed<S extends EmbedBaseSrc, F extends EmbedBaseFeature, E extends EmbedBaseListener> = {
-        /** 页面来源信息 */
-        src: S;
-        /** 特性配置 */
-        feature?: F;
-        /** 事件监听 */
-        listener?: E;
-    };
-    /** 嵌入基本类型 */
-    export type EmbedBase = CreateEmbed<EmbedBaseSrc, EmbedBaseFeature, EmbedBaseListener>;
+    /** 嵌入客户端行为 */
+    export type EmbedBaseAction<T = any> = EmbedBaseEventMessageContent<T>;
+    /** 嵌入环境 */
     export enum EmbedEnv {
+        /** sdk 嵌入 */
         sdk = "sdk",
+        /** sdk iframe 嵌入 */
         iframe = "iframe"
     }
-    export {};
 }
 
 declare module '@quickbi/bi-types/open/common/page-types' {
     /**
-      * @author 海狸
-      * @description 开放页面类型定义
-      */
-    import type { EnumAsUnion } from '@quickbi/bi-types/open/common/tools';
-    /** 开放相关页面类型枚举 */
+        * @deprecated 开放相关页面类型枚举, 注意要和 routerKkey 做区分, 这个 key 后续要废弃
+        * */
     export enum OpenPageTypeEnum {
-        /** 仪表板 */
-        dashboard = "dashboard",
-        /** 电子表格 */
-        webExcel = "webExcel",
-        /** 数据大屏 */
-        screen = "screen",
-        /** 自助取数 */
-        offline = "offline",
-        /** 即席分析 */
-        analysis = "analysis",
-        /** 工作台首页 */
-        workspace = "workspace",
-        /** 空间成员与信息 */
-        workspaceMember = "workspaceMember",
-        /** 资源授权 */
-        workspaceAuth = "workspaceAuth",
-        /** 智能问数首页 */
-        copilot = "copilot",
-        /** 模板市场首页 */
-        templateMarket = "templateMarket",
-        /** 开放平台首页 */
-        open = "open",
-        /** 开放平台-控制台 */
-        openHome = "openHome",
-        /** 我的看板首页 */
-        board = "board",
-        /** 我的看板首页 */
-        admin = "admin"
+            /** 仪表板 */
+            dashboard = "dashboard",
+            /** 电子表格 */
+            webExcel = "webExcel",
+            /** 数据大屏 */
+            screen = "screen",
+            /** 自助取数 */
+            offline = "offline",
+            /** 即席分析 */
+            analysis = "analysis"
     }
-    /** 开放相关页面类型值联合类型 */
-    export type OpenPageTypeUnion = EnumAsUnion<typeof OpenPageTypeEnum>;
 }
 
 declare module '@quickbi/bi-types/open/common/event-types' {
@@ -2468,11 +2448,9 @@ declare module '@quickbi/bi-types/open/common/event-types' {
     /** 开放相关事件枚举, 取值固定为 before-xxx-event, after-xxx-event */
     export enum OpenEventTypeEnum {
         /** 嵌入事件-路由跳转前 */
-        'before-navigate-event' = "before-navigate-event",
+        'before-page-change-event' = "before-page-change-event",
         /** 嵌入事件-页面渲染后 */
-        'after-mount-event' = "after-mount-event",
-        /** 嵌入事件-页面卸载前 */
-        'before-unmount-event' = "before-unmount-event",
+        'after-page-loaded-event' = "after-page-loaded-event",
         /** 自定义事件-下载前 */
         'before-download-event' = "before-download-event",
         /** 自定义事件-页面加载前 */
@@ -2520,16 +2498,13 @@ declare module '@quickbi/bi-types/open/common/tools' {
         * 字符串中划线类型
         * @usage Kebab<'aaa-bbb'>
         */
-    export type Kebab<T extends string, A extends string = ''> = T extends `${infer F}${infer R}` ? Kebab<R, `${A}${F extends Lowercase<F> ? '' : '-'}${Lowercase<F>}`> : A;
+    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 {};
 }
 
-declare module '@quickbi/bi-types/router/router-key' {
-    /**
-      * @author 唯毅
-      * @description QBI 全局路由key
-      */
-    export enum RouterKey {
+declare module '@quickbi/bi-types/router/route-key' {
+    /** 每个路由有一个单独的 key, 这个 key 会被客户的自定义组件/事件/嵌入使用, 因此不要随意更改!!! 起名的时候也要再三斟酌!!! */
+    export enum RouteKey {
         root = "root",
         /** home页根 */
         homeRoot = "homeRoot",
@@ -2543,20 +2518,20 @@ declare module '@quickbi/bi-types/router/router-key' {
         orgAdminOrgInfo = "orgAdminOrgInfo",
         /** 组织信息-超级管理员 */
         orgAdminInfoSuper = "orgAdminInfoSuper",
-        /** 组织管理-用户管理 */
+        /** 组织管理-用户管理 已落库勿改 */
         orgAdminUser = "orgAdminUser",
-        /** 组织管理-用户管理-成员管理 */
-        orgAdminMember = "orgAdminMember",
-        /** 组织管理-用户管理-用户组管理 */
-        orgAdminGroup = "orgAdminGroup",
-        /** 组织管理-用户管理-用户标签管理 */
+        /** 组织管理-用户管理-成员管理 已落库勿改 */
+        userMemberManage = "userMemberManage",
+        /** 组织管理-用户管理-用户组管理 已落库勿改 */
+        userGroupManage = "userGroupManage",
+        /** 组织管理-用户管理-用户标签管理 已落库勿改 */
         userTagManage = "userTagManage",
-        /** 组织管理-用户管理-用户标签管理-用户标签 */
+        /** 组织管理-用户管理-用户标签管理-用户标签 已落库勿改 */
         userTagDetailManage = "userTagDetailManage",
-        /** 组织管理-用户管理-用户标签管理-标签管理 */
+        /** 组织管理-用户管理-用户标签管理-标签管理 已落库勿改 */
         tagManage = "tagManage",
-        /** 组织管理-用户管理-角色管理 */
-        orgAdminRole = "orgAdminRole",
+        /** 组织管理-用户管理-角色管理 已落库勿改 */
+        userRoleManage = "userRoleManage",
         /** 组织管理-工作空间管理 */
         orgAdminSpace = "orgAdminSpace",
         /** 组织管理-工作空间管理-工作空间 */
@@ -2687,6 +2662,8 @@ declare module '@quickbi/bi-types/router/router-key' {
         orgAdminResourceRecord = "orgAdminResourceRecord",
         /** 功能介绍 */
         orgAdminResourceDesc = "orgAdminResourceDesc",
+        /** 企业应用 */
+        companyApply = "companyApply",
         /** 取数中心-下载任务 */
         offlineDownload = "offlineDownload",
         /** 创作区页面 */
@@ -2750,11 +2727,11 @@ declare module '@quickbi/bi-types/router/router-key' {
         apiStatisticCount = "apiStatisticCount",
         /** 标准版-账号管理页面 */
         standandUser = "standandUser",
-        /** 订阅管理 */
+        /** 订阅管理 已落库勿改 */
         subscriptionManage = "subscriptionManage",
-        /** 订阅任务 */
+        /** 订阅任务 已落库勿改 */
         subscriptionTask = "subscriptionTask",
-        /** 发送记录 */
+        /** 发送记录 已落库勿改 */
         sendRecord = "sendRecord",
         /** 模版市场 */
         templateMarket = "templateMarket",
@@ -2789,9 +2766,9 @@ declare module '@quickbi/bi-types/router/router-key' {
         /** 仪表板 列表页 */
         dashboardList = "dashboardList",
         /** 电子表格 列表页 */
-        reportList = "reportList",
+        workbookList = "workbookList",
         /** 电子表格试用 列表页 */
-        reportTrialList = "reportTrialList",
+        workbookListTrialList = "workbookTrialList",
         /** 大屏 列表页 */
         screenList = "screenList",
         /** 即席分析 列表页 */
@@ -2841,6 +2818,7 @@ declare module '@quickbi/bi-types/router/router-key' {
         /** --------------------------------------------------- 数据门户 --------------------------------------------------- */
         productRoot = "productRoot",
         productEdit = "productEdit",
+        productView = "productView",
         /** 表单填报系统 */
         formSystemRoot = "formSystemRoot",
         /** 表单填报系统 新建页 */
@@ -2856,15 +2834,15 @@ declare module '@quickbi/bi-types/router/router-key' {
         /** 仪表板预览 */
         dashboardView = "dashboardView",
         /** 仪表板编辑 */
-        dashboardPc = "dashboardPc",
+        dashboardEdit = "dashboardEdit",
         /** -------------------------------------------------- 电子表格 -------------------------------------------------- */
-        reportRoot = "reportRoot",
+        workbookRoot = "workbookRoot",
         /** 电子表格预览 */
-        reportView = "reportView",
+        workbookView = "workbookView",
         /** 电子表格入库审批列表页 */
-        reportFormTask = "reportFormTask",
-        /** excel */
-        reportIndex = "reportIndex",
+        workbookFormTask = "workbookFormTask",
+        /** 电子表格编辑 */
+        workbookEdit = "workbookEdit",
         /** -------------------------------------------------- etl -------------------------------------------------- */
         etlRoot = "etlRoot",
         /** etl编辑 */
@@ -2886,7 +2864,9 @@ declare module '@quickbi/bi-types/router/router-key' {
         /** ---------------------------------------------------- 自助取数 -------------------------------------------------- */
         offlineRoot = "offlineRoot",
         /** 自助取数 */
-        offlinePc = "offlinePc",
+        offlineEdit = "offlineEdit",
+        /** 自助取数预览 */
+        offlineView = "offlineView",
         /** --------------------------------------------------- 即席分析 -------------------------------------------------- */
         analysisRoot = "analysisRoot",
         /** 即席分析编辑 */
@@ -2896,6 +2876,24 @@ declare module '@quickbi/bi-types/router/router-key' {
     }
 }
 
+declare module '@quickbi/bi-types/router/route-tree' {
+    /**
+      * @author 非席  唯毅
+      * @description qbi 全局路由树
+      */
+    import { RouteKey } from '@quickbi/bi-types';
+    /** 全局路由树节点 */
+    export interface RouteTreeNode {
+        key: RouteKey;
+        path: string;
+        children?: RouteTreeNode[];
+    }
+    /** 全局路由树 */
+    export const ROUTE_TREE: RouteTreeNode;
+    /** 将整颗路径树打平，根据key索引 */
+    export const ROUTE_PATH_MAP: Record<RouteKey, string>;
+}
+
 declare module '@quickbi/bi-types/data-panel/base' {
     import type * as React from 'react';
     export type CommonCompInputAreaType = 'area_type' | 'area_dim' | 'area_row' | 'area_column' | 'area_value' | 'area_measure' | 'filters' | string;