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

package/dist/types/board-engine/types.d.ts

@@ -0,0 +1,147 @@
+/**
+ * 看板引擎的配置契约（设计端与运行端**共用同一份**）。
+ *
+ * 设计原则：这里只描述「配置长什么样」，不描述「怎么渲染」。
+ * 渲染细节（样式、模板）由两端各自的视图层负责 —— 但样式值必须由引擎算出来，
+ * 不许视图层自己再算一套（否则就是漂移）。
+ *
+ * 类型刻意保持"宽"：看板配置是自由 JSON（`config_json`），历史上有大量可选字段，
+ * 收紧类型只会逼着写一堆断言。**边界宽、内部严**是这里的取舍。
+ */
+/** 部件的盒模型（自由布局：像素；栅格布局：跨列数） */
+export interface BoardBox {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+/** 度量（聚合列） */
+export interface BoardMeasure {
+    field: string;
+    /** sum / avg / count / max / min / countDistinct（后端白名单） */
+    agg?: string;
+    alias?: string;
+    [key: string]: any;
+}
+/** 筛选条件 */
+export interface BoardFilter {
+    field: string;
+    /** eq / ne / gt / ge / lt / le / like / in / between …（后端 BoardQueryBuilder 认） */
+    op?: string;
+    value?: any;
+    values?: any[];
+    [key: string]: any;
+}
+/** 部件的数据绑定（指向平台数据集 + 维度/度量/筛选/参数） */
+export interface BoardPartData {
+    setId?: string | number;
+    dims?: string[];
+    measures?: BoardMeasure[];
+    filters?: BoardFilter[];
+    /** 部件级参数（优先级高于看板级参数） */
+    params?: Record<string, string>;
+    orderField?: string;
+    orderDesc?: boolean;
+    limit?: number;
+    [key: string]: any;
+}
+/** 一个部件（看板配置里最小的可视单元） */
+export interface BoardPart {
+    id: string;
+    /** chart / kpi / table / crossTable / text / image / border / container / tabContainer /
+     *  iframe / video / carousel / marquee / decoration / progress / button / nav / filter */
+    type: string;
+    name?: string;
+    hidden?: boolean;
+    /** 容器 / 页签容器里的子部件 */
+    parentId?: string;
+    tabIndex?: number;
+    box?: BoardBox;
+    /** 类型相关的展示配置（chart 图型、表格列宽、文本内容、边框编号…） */
+    view?: Record<string, any>;
+    data?: BoardPartData;
+    /** 多语覆盖：{ 'en-US': { 'view.content': 'Hello' } } */
+    i18n?: Record<string, Record<string, any>>;
+    [key: string]: any;
+}
+/** 页面级配置 */
+export interface BoardPage {
+    width: number;
+    height: number;
+    /** auto / ratio / none */
+    scaleMode?: string;
+    /** free / grid */
+    layoutMode?: string;
+    gridCols?: number;
+    gridGap?: number;
+    rowHeight?: number;
+    /** 视觉主题 code（[data-board-theme]） */
+    theme?: string;
+    /** 图表主题 code（与 theme 通常一起切） */
+    chartTheme?: string;
+    bgColor?: string;
+    bgImage?: string;
+    opacity?: number;
+    watermark?: string;
+    locale?: string;
+    /** scale / stack / auto */
+    mobileMode?: string;
+    [key: string]: any;
+}
+/** 整页看板配置（= 后端 `design_board_info.config_json` 解析结果） */
+export interface BoardConfig {
+    page: BoardPage;
+    parts: BoardPart[];
+    [key: string]: any;
+}
+/** 取数请求体（后端 `BoardDataQuery`，契约勿随意加字段） */
+export interface BoardDataQuery {
+    setId: string | number;
+    dims: string[];
+    measures: BoardMeasure[];
+    filters: BoardFilter[];
+    params: Record<string, string>;
+    orderField: string;
+    orderDesc: boolean;
+    limit: number;
+}
+/** 取数响应的列元数据 */
+export interface BoardDataColumn {
+    name: string;
+    alias?: string;
+    type?: string;
+    isDimension?: boolean;
+    numFormat?: any;
+    [key: string]: any;
+}
+/** 取数响应 */
+export interface BoardDataResult {
+    columns: BoardDataColumn[];
+    rows: Record<string, any>[];
+    total?: number;
+    limited?: boolean;
+    cached?: boolean;
+    [key: string]: any;
+}
+/** 数据集声明的参数（看板级参数目录的原料） */
+export interface BoardParamDecl {
+    paramCode: string;
+    paramName?: string;
+    /** input / select / date / year / period / org … */
+    paramType?: string;
+    defaultValue?: string;
+    /** 逗号/换行分隔的可选值，或单个"字典编码/机构类型"引用 */
+    valueSource?: string;
+    setId?: string | number;
+    [key: string]: any;
+}
+/** 参数目录里汇总后的一条（多个数据集声明同一参数时合并） */
+export interface BoardParamDeclEntry extends BoardParamDecl {
+    sets: (string | number)[];
+}
+/** 看板参数状态（框架中立：普通对象 + version 计数 + 订阅） */
+export interface BoardParamState {
+    values: Record<string, string>;
+    /** 任何变化 +1：视图层用它触发重算（Vue 里包一层 computed/ref 即可） */
+    version: number;
+}

package/dist/types/board-engine/version.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 看板配置的 **schema 版本**（引擎产出，两端必须一致）
+ *
+ * 用途：设计端（design-ui）与运行端（本库）各自跑一遍引擎时，先比这个号 ——
+ * 不同就**直接报错**，避免「设计端已经用了新字段、运行端还是旧引擎」这种最难查的错
+ * （症状是某个配置项"存了但不生效"，两边代码看起来都对）。
+ *
+ * 什么时候升：改语义 / 删字段 / 改默认值 → 升；纯加字段（旧配置仍然正确）→ 不升。
+ */
+export declare const BOARD_SCHEMA_VERSION = 1;

package/dist/types/host.d.ts

@@ -113,6 +113,23 @@ export interface DesignUploadOptions {
  * 未注入时：`file` / `image` 字段显示「上传不可用」提示并 warn 一次。
  */
 export type DesignHostUpload = (file: File, options?: DesignUploadOptions) => Promise<DesignUploadResult>;
+/**
+ * 看板（数据看板运行端）的宿主能力。
+ *
+ * 全部可缺省：缺省即"用主 http + 同源地址"，这是平台后端与宿主同域时的最常见情形。
+ * 需要单独指的时候（看板后端在另一个服务/域名）才注入 —— 这三个键就是为了不逼着库去猜。
+ */
+export interface DesignHostBoard {
+    /**
+     * 看板取数专用 http（`/design/board/**`）。
+     * 缺省用主 `http`：多数部署里看板接口与设计配置接口在同一个后端。
+     */
+    http?: DesignHttp;
+    /** 素材直链前缀（`asset:` 引用 → `${assetBaseUrl}/design/board/asset/file?path=`）；缺省 `''`（同源） */
+    assetBaseUrl?: string;
+    /** 主题 CSS 目录（`<code>.css` 与 `index.json` 在这里）；缺省 `/board/theme/` */
+    themeBaseUrl?: string;
+}
 export interface DesignHost {
     /**
      * 网络层。**必须**注入宿主自己的请求实例适配（见 http.ts 顶部说明），
@@ -133,6 +150,8 @@ export interface DesignHost {
     dict?: DesignHostDict;
     /** 业务后端能力（流程等） */
     workflow?: DesignHostWorkflow;
+    /** 数据看板运行端能力（看板取数 http / 素材前缀 / 主题目录），见 DesignHostBoard */
+    board?: DesignHostBoard;
     /**
      * 严格版本自检：为 true 时，若宿主的 vue / antdv-next 不在支持区间，**启动即抛错**。
      * 默认 false（只 console.error），避免一个版本提示把整个应用打挂；
@@ -163,6 +182,8 @@ export declare function getHostUi(): DesignHostUi;
 export declare function getHostDict(): DesignHostDict;
 /** 业务后端能力（可能为空对象；缺字段的功能直接不显示） */
 export declare function getHostWorkflow(): DesignHostWorkflow;
+/** 看板能力（可能为空对象；缺字段回落「主 http + 同源 + /board/theme/」） */
+export declare function getHostBoard(): DesignHostBoard;
 /**
  * 取 http：没注入就直接报错（这是**唯一**必须注入的能力，静默降级只会让问题更难查）
  */

package/dist/types/index.d.ts

@@ -5,12 +5,13 @@
  * 免得宿主依赖上不该依赖的细节，把库的版本升级空间锁死。
  */
 import './styles/index.css';
+import './board/theme-fallback.css';
 export { ApiSwitch, buildHostApi, DESIGN_POPUP_HOST_KEY, DesignTable, DesignTree, DesignTableFlowStatusCell, DesignTableInner, DesignComb, DesignDevModeToggle, DesignSearch, DesignDevStateButton, DesignForm, DesignFormInner, evalExpression, executeCommand, hostRequest, openComponent, pendingRowActionTypes, pendingToolTypes, platformMessage, resolveRowActionComponent, resolveToolComponent, rowActionComponentMap, rowActionTypes, setDevMode, useDevMode, toolComponentMap, toolTypes, usePopupHost, } from './components';
 export type { CommandContext, CommandHelpers, CommandNav, DesignHostApi, DesignHostSlot, DesignPopupHost, OpenComponentOptions, } from './components';
 export { checkDesignRuntimeCompat, satisfiesRange, SUPPORTED_VERSIONS, } from './compat';
 export type { CompatCheckItem, CompatReport } from './compat';
-export { getDesignHost, getHostDict, getHostPopup, getHostUi, getHostWorkflow, hostT, installDesignPlatform, requireHttp, requireVxeGrid, resetDesignHost, } from './host';
-export type { DesignAuthSnapshot, DesignHost, DesignHostUpload, DesignUploadOptions, DesignUploadResult, DesignHostDict, DesignHostMessage, DesignHostModal, DesignHostUi, DesignHostWorkflow, } from './host';
+export { getDesignHost, getHostBoard, getHostDict, getHostPopup, getHostUi, getHostWorkflow, hostT, installDesignPlatform, requireHttp, requireVxeGrid, resetDesignHost, } from './host';
+export type { DesignAuthSnapshot, DesignHost, DesignHostBoard, DesignHostUpload, DesignUploadOptions, DesignUploadResult, DesignHostDict, DesignHostMessage, DesignHostModal, DesignHostUi, DesignHostWorkflow, } from './host';
 export { createMemoryHttp } from './http';
 export type { DesignHttp, DesignRequestOptions, DesignRequestRecord, } from './http';
 export { buildComponentsManifest, clearDesignComponents, hasDesignComponent, listDesignComponents, registerComponents, requireDesignComponent, resolveDesignComponent, } from './registry';
@@ -39,3 +40,21 @@ export { createDeptTreeSource, normalizeDeptNode } from './org/dept-tree-source'
 export { buildSearchFormOptions, normalizeSearchCells } from './search/transformer';
 export type { DesignFormOptions, DesignFormSchema, } from './search/transformer';
 export { formatNow, resolveDefaultValue } from './utils/default-value';
+export { assetName, assetPath, ASSET_PREFIX, assetUrl, BOARD_SCHEMA_VERSION, buildPartQuery, catalogList, createBoardDataHub, createBoardParams, createParamCatalog, DATAV_BORDER_DEFAULT, DATAV_BORDER_META, DATAV_DECORATION_DEFAULT, DATAV_DECORATION_META, datavBorderLabel, datavDecorationLabel, datavDecorationSizeOf, declaredParam, DEFAULT_LOCALE, defaultBoardParams, defaultParamCatalog, effectiveFilter, effectiveFilterFor, fieldText, allParams, getParam, isAssetRef, loadParamCatalog, LOCALES, localizePart, parseOptions, resetParamCatalog, resetParams, setFieldText, setParam, toAssetRef, TRANSLATABLE, translatableFields, translatedCount, valueSourceReference, } from './board-engine';
+export type { BoardBox, BoardConfig, BoardDataColumn, BoardDataHub, BoardDataHubOptions, BoardDataHubStats, BoardDataQuery, BoardDataResult, BoardFilter, BoardLocale, BoardMeasure, BoardPage, BoardParamCatalog, BoardParamCatalogOptions, BoardParamCatalogState, BoardParamDecl, BoardParamDeclEntry, BoardParamSource, BoardParamState, BoardParams, BoardPart, BoardPartData, BoardTranslatableField, EffectiveFilter, } from './board-engine';
+export { AGG_LABELS, BORDER_PRESETS, CARD_TYPES, CHART_TYPES, childLayoutOf, childParts, CONTAINER_PAD, CONTAINER_TYPES, containerGrid, DEFAULT_THEME, defaultConfig, decorOf, borderPresetOf, descendantIds, fillPartDefaults, freeToGrid, gridAutoRows, gridPartStyle, gridSpanToSize, gridToFreeParts, GRID_DEFAULTS, createPart, isContainer, isMobileStack, layoutAuthority, measureLabel, mobileModeOf, newPartId, normalizeParts, paddingOf, parseConfig, PART_TYPES, partStyle, partTypeBadge, partVisible, partVisualStyle, reorderDepthFirst, resetThemeOverrides, setThemeTokens, sortedParts, sortSiblingsByVisual, stackMinHeight, stackPartStyle, STAGE_BG, stripConfigDefaults, stripPartDefaults, textStyle, THEMES, themeOf, TITLE_BAR_HEIGHT, titleInsetOf, titleOffsetOf, titleReserveOf, titleStyleOf, visualOrder, canHostChildren, basePartShape, deepMerge, } from './board-engine';
+export { buildChartOption, fmtNum } from './board-engine';
+export { containerChildrenStyle, partRenderModel, resolveLayout, } from './board-engine';
+export type { BoardPartDecorModel, BoardPartRenderModel, BoardPartRenderOptions, BoardPartTitleModel, BoardRenderLayout, } from './board-engine';
+export { parseManifest } from './board-engine';
+export type { BoardThemeEntry } from './board-engine';
+export { boardAssetBaseUrl, boardAssetUrl, boardHttp, fetchBoardData, fetchBoardInfo, fetchBoardParams, } from './board/api';
+export type { BoardInfo } from './board/api';
+export { datavBorderComponent, datavDecorationComponent, preloadDatav, resetDatavCache, } from './board/datav-map';
+export { DEFAULT_THEME_BASE, ensureTheme, ensureThemeCss, loadManifest, readThemeTokens, resetThemeFileCache, themeBaseUrl, } from './board/theme-host';
+export { default as BoardChart } from './board/board-chart.vue';
+export { default as DesignBoard } from './board/design-board.vue';
+export { default as PartNode } from './board/part-node.vue';
+export { default as PartRenderer } from './board/part-renderer.vue';
+export { DESIGN_BOARD_CTX, useBoardContext } from './board/context';
+export type { BoardContext } from './board/context';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jzg223/design-runtime",
-  "version": "0.0.1",
-  "description": "低代码设计平台运行端组件库：把设计端（design-ui）产出的配置，在 vben 基座上渲染成表格 / 表单 / 树 / 组合视图。位于「基座」与「业务项目」之间，版本化、可复用、不拷贝。",
+  "version": "0.1.0-rc.2",
+  "description": "低代码设计平台运行端组件库：把设计端（design-ui）产出的配置，在 vben 基座上渲染成表格 / 表单 / 树 / 组合视图 / 数据看板。位于「基座」与「业务项目」之间，版本化、可复用、不拷贝。",
   "keywords": [
     "lowcode",
     "design",
@@ -33,8 +33,12 @@
     "build": "npm run build:js && npm run build:types && npm run verify",
     "build:js": "vite build",
     "build:types": "vue-tsc -p tsconfig.build.json --emitDeclarationOnly",
-    "verify": "node scripts/assert-bundle.mjs",
-    "test": "npm run test:table && npm run test:host && npm run test:shared && npm run test:search && npm run test:form && npm run test:component",
+    "verify": "node scripts/assert-bundle.mjs && node scripts/assert-board-engine.mjs",
+    "test": "npm run test:table && npm run test:host && npm run test:shared && npm run test:search && npm run test:form && npm run test:component && npm run test:board && npm run test:board-render && npm run test:board-fingerprint && npm run test:board-chart",
+    "test:board": "node scripts/test-board-engine.mjs",
+    "test:board-chart": "node scripts/test-board-chart-registry.mjs",
+    "test:board-render": "node scripts/test-board-render.mjs",
+    "test:board-fingerprint": "node scripts/test-board-fingerprint.mjs",
     "test:component": "node scripts/test-components.mjs",
     "test:form": "node scripts/test-form.mjs",
     "test:host": "node scripts/test-host-api.mjs",
@@ -52,16 +56,29 @@
   "homepage": "https://gitee.com/honglian-delivery-center/design-runtime#readme",
   "peerDependencies": {
     "@antdv-next/icons": "^1.1.2",
+    "@kjgl77/datav-vue3": "^1.7.4",
     "antdv-next": "^1.5.2",
     "dayjs": "^1.11.0",
+    "echarts": "^6.1.0",
     "vue": "^3.5.0",
     "vue-router": "^5.0.4"
   },
+  "peerDependenciesMeta": {
+    "@kjgl77/datav-vue3": {
+      "optional": true
+    },
+    "echarts": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@antdv-next/icons": "^1.1.2",
+    "@kjgl77/datav-vue3": "^1.7.4",
     "@vitejs/plugin-vue": "^5.2.1",
     "antdv-next": "^1.5.2",
     "dayjs": "^1.11.0",
+    "echarts": "^6.1.0",
+    "less": "^4.9.1",
     "typescript": "^5.6.3",
     "vite": "^5.4.11",
     "vue": "^3.5.22",