@jzg223/design-runtime 0.0.1 → 0.1.0-rc.2

package/dist/types/board/api.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 看板取数层（运行端只用这 4 个接口）
+ *
+ * 契约（见方案文档 §7）：
+ * | # | 方法/路径 | 用途 |
+ * | 1 | `GET  /design/board/info/queryByCode?code=` | 拿整页配置（configJson + 页宽高） |
+ * | 2 | `POST /design/board/data/query`             | 部件取数（BoardDataQuery → columns/rows） |
+ * | 3 | `GET  /design/board/dataset/paramsBySets?ids=` | 参数目录（数据集声明的参数） |
+ * | 4 | `GET  /design/board/asset/file?path=`        | 素材直链（**不经 http**，拼 URL 给 `<img src>`） |
+ *
+ * 三条口径（与库内其它取数一致，别改）：
+ * 1. **只走注入的 http**：默认用主 `http`，宿主需要指到别的服务时注入 `board.http`；
+ * 2. **一律 `silent: true`**：一个大屏会并发十几个部件请求，宿主逐条弹 toast 不可接受；
+ * 3. **响应按宿主契约已剥壳**（拦截器 resolve 业务数据）。为兼容"未剥壳"的实现（design-ui 那套 axios），
+ *    这里做**一处**显式的 `{code,data}` 解包，而不是到处判 `code === 200`。
+ */
+import type { BoardDataQuery, BoardDataResult, BoardParamDecl } from '../board-engine';
+import type { DesignHttp } from '../http';
+/** 看板信息（`design_board_info` 的运行端视图） */
+export interface BoardInfo {
+    boardCode: string;
+    boardName?: string;
+    /** 整页配置 JSON（字符串；用 `parseConfig` 解析） */
+    configJson: string;
+    /** 设计时页宽（配置里没有 width 时兜底用） */
+    pageWidth?: number;
+    /** 设计时页高 */
+    pageHeight?: number;
+    [key: string]: any;
+}
+/** 看板接口用哪个 http 实例（宿主可单独指） */
+export declare function boardHttp(): DesignHttp;
+/** 素材直链前缀（宿主注入；缺省同源） */
+export declare function boardAssetBaseUrl(): string;
+/** ① 按编码取整页配置 */
+export declare function fetchBoardInfo(code: string): Promise<BoardInfo | null>;
+/** ② 部件取数（失败返回 null —— 单个部件挂了不该让整页白掉） */
+export declare function fetchBoardData(body: BoardDataQuery): Promise<BoardDataResult | null>;
+/** ③ 参数声明（参数目录用；失败返回空数组，页面继续按部件自身配置工作） */
+export declare function fetchBoardParams(ids: string): Promise<BoardParamDecl[]>;
+/**
+ * ④ 素材地址：`asset:` 引用 → 可用的 `src`。
+ * 不是 `asset:` 引用（外部 URL / data: / 站内绝对路径）原样返回，交给 `assetUrl` 的规则。
+ */
+export declare function boardAssetUrl(value: unknown): string;

package/dist/types/board/board-chart.vue.d.ts

@@ -0,0 +1,15 @@
+type __VLS_Props = {
+    /** ECharts option（引擎算好的）；null/空对象表示"没有数据" */
+    option?: Record<string, any> | null;
+};
+declare function resize(): void;
+declare const _default: import("vue").DefineComponent<__VLS_Props, {
+    resize: typeof resize;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    "chart-click": (payload: any) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onChart-click"?: ((payload: any) => any) | undefined;
+}>, {
+    option: Record<string, any> | null;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/types/board/context.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 看板实例上下文（provide / inject）
+ *
+ * 为什么要这一层：看板的状态（参数 / 参数目录 / 取数缓存）**每个看板实例一份**。
+ * design-ui 那边是模块级单例（`Vue.observable`），因为一页只有一个看板；
+ * 但运行端可能一页放两个（大屏里嵌套、页签并列），单例会让两个看板串参数。
+ * 所以这里是 `DesignBoard` 创建 → provide → `PartNode` / `PartRenderer` inject。
+ *
+ * 顺带解决了另一个问题：`part-renderer` 是递归渲染的深层组件，靠 props 逐层透传
+ * 参数/取数会变成一条很长的 prop 链；用 inject 只传"一个对象"。
+ */
+import { type InjectionKey } from 'vue';
+import type { BoardDataHub, BoardParamCatalog, BoardParams } from '../board-engine';
+/** 看板运行时上下文 */
+export interface BoardContext {
+    /** 看板参数（筛选方案写、各部件读） */
+    params: BoardParams;
+    /** 数据集声明的参数目录（筛选控件的类型/可选值以它为准） */
+    catalog: BoardParamCatalog;
+    /** 部件取数（同查询合并 + 短 TTL 缓存） */
+    dataHub: BoardDataHub;
+    /** 素材直链前缀（`asset:` 引用解析用） */
+    assetBaseUrl: string;
+    /** 当前语言（`localizePart` 用） */
+    locale: string;
+}
+export declare const DESIGN_BOARD_CTX: InjectionKey<BoardContext>;
+/** 取上下文：没 provide 就抛错（静默降级只会让"数据不出来"更难查） */
+export declare function useBoardContext(): BoardContext;

package/dist/types/board/datav-map.d.ts

@@ -0,0 +1,24 @@
+/**
+ * DataV 边框 / 装饰的**组件映射**（运行端侧）
+ *
+ * 原来的实现用 `@jiaminghi/data-view`（Vue2 的 `.vue` 源码直引），Vue3 用不了。
+ * 现在换成社区 Vue3 移植版 `@kjgl77/datav-vue3`（peer，宿主装），
+ * **元数据**（编号 → 中文名 / 推荐尺寸）仍在引擎里（`board-engine/datav-meta.ts`），
+ * 这里只做"编号 → 组件"。
+ *
+ * 三条硬约束（体积与懒加载）：
+ * 1. 包是**单入口整包**（解包 720 KB，ESM 一个文件），没有按组件的子路径导出
+ *    ⇒ 用 `defineAsyncComponent` + 动态 `import()`，做到"配置里真用了边框/装饰才下载"；
+ * 2. 依赖它的 `style.css` 也**跟着组件一起懒加载**（不放进库的 `dist/style.css`，
+ *    否则每个用本库的宿主都白背 12 KB + 一个可能压根没装的 peer）；
+ * 3. 每个编号的组件对象**缓存一份**（同一页有 10 个边框也只创建一个异步组件）。
+ */
+import { type Component } from 'vue';
+/** 编号 → 边框组件（13 种；非法编号/未注册回落到默认 8） */
+export declare function datavBorderComponent(n: unknown, fallback?: number): Component;
+/** 编号 → 装饰组件（12 种；非法编号回落到默认 5） */
+export declare function datavDecorationComponent(n: unknown, fallback?: number): Component;
+/** 预加载 datav 整包（宿主想提前拉一遍时用；库内部按需加载，不需要调它） */
+export declare function preloadDatav(): Promise<Record<string, any>>;
+/** 仅测试用：清缓存 */
+export declare function resetDatavCache(): void;