@veltra/sheet 2.0.1 → 2.2.0

package/dist/types/report-designer.d.ts

@@ -0,0 +1,36 @@
+import { DataConnection, DataConnector } from "../report/connector.js";
+import { ReportTemplate } from "../report/template.js";
+import "../report/index.js";
+import { DeconstructValue } from "@veltra/utils";
+import { Workbook } from "@veltra/sheet-core/core/workbook";
+//#region src/types/report-designer.d.ts
+/** 报表设计器组件属性（ADR-0003 决策 2） */
+interface ReportDesignerProps {
+  /** 数据连接器（如 `createHttpConnector({ endpoint })`）：数据中枢的测试连接 / 字段解析 / 记录预览均经它 */
+  connector: DataConnector;
+  /**
+   * 数据连接列表（`v-model:connections`）：纯序列化对象，仅驻留内存；
+   * 凭据的持久化与安全存储完全由宿主掌控（ADR-0003 决策 4）
+   */
+  connections?: DataConnection[];
+  /**
+   * 载入既有 Report Template 继续设计：恢复网格绑定与设计态数据集；
+   * 内嵌连接按 id 合并进 `v-model:connections`（仅缺省时追加，宿主列表是单一事实源）
+   */
+  template?: ReportTemplate;
+  /** 承载设计态的工作簿（USheet 先例：缺省内部自建单 sheet 工作簿） */
+  workbook?: Workbook;
+}
+/** 报表设计器组件定义的事件 */
+interface ReportDesignerEmits {
+  (e: 'update:connections', value: DataConnection[]): void;
+}
+/** 在组件内部引用 */
+interface _ReportDesignerExposed {
+  /** 取回含 meta 绑定与内嵌数据集定义的可序列化 Report Template */
+  getTemplate: () => ReportTemplate;
+}
+/** 报表设计器组件暴露的方法 */
+type ReportDesignerExposed = DeconstructValue<_ReportDesignerExposed>;
+//#endregion
+export { ReportDesignerEmits, ReportDesignerExposed, ReportDesignerProps, _ReportDesignerExposed };

package/dist/types/report-viewer.d.ts

@@ -0,0 +1,38 @@
+import { ReportColWidthEntry } from "../report/export-xlsx.js";
+import { DataConnector } from "../report/connector.js";
+import { ReportTemplate } from "../report/template.js";
+import "../report/index.js";
+import { DeconstructValue } from "@veltra/utils";
+import { Workbook } from "@veltra/sheet-core/core/workbook";
+//#region src/types/report-viewer.d.ts
+/** 报表查看器组件属性（ADR-0003 决策 2） */
+interface ReportViewerProps {
+  /** 数据连接器（如 `createHttpConnector({ endpoint })`） */
+  connector: DataConnector;
+  /**
+   * 自包含 Report Template（SheetSnapshot + 内嵌数据集定义，见 `ReportTemplate`）：
+   * 查看器据此提取实际绑定数据集的查询参数并集生成 Filter Bar，并经连接器取数展开渲染
+   */
+  template: ReportTemplate;
+  /** 承载填充报表的工作簿（USheet 先例：缺省内部自建单 sheet 工作簿） */
+  workbook?: Workbook;
+  /**
+   * 列宽（sheet-core 列宽未进 SheetSnapshot）：载入填充结果后写入 VTable 运行时，
+   * 供 `exportXlsx()` 读取保真列宽（设计器预览态传入设计态捕获值）
+   */
+  colWidths?: ReadonlyArray<ReportColWidthEntry>;
+}
+/** 在组件内部引用 */
+interface _ReportViewerExposed {
+  /** 重新取数并展开渲染（外部状态变化后主动刷新报表） */
+  refresh: () => Promise<void>;
+  /**
+   * 导出填充报表为 XLSX（取数完成前拒绝；内部读取填充 sheet 与运行时列宽）。
+   * 不内置导出按钮，工具栏由下游决定。
+   */
+  exportXlsx: () => Promise<void>;
+}
+/** 报表查看器组件暴露的方法 */
+type ReportViewerExposed = DeconstructValue<_ReportViewerExposed>;
+//#endregion
+export { ReportViewerExposed, ReportViewerProps, _ReportViewerExposed };

package/dist/types/sheet.d.ts

@@ -1,9 +1,9 @@
-import { Sheet } from "../core/sheet.js";
-import { Workbook } from "../core/workbook.js";
-import { SheetGrid } from "../grid/sheet-grid.js";
 import { SheetContext } from "../tools/context.js";
 import { ComputedRef } from "vue";
 import { DeconstructValue } from "@veltra/utils";
+import { ResolveCellRenderer, ResolveCellStyleHook, ResolveDisplayValue, SheetGrid } from "@veltra/sheet-core/grid/sheet-grid";
+import { Workbook } from "@veltra/sheet-core/core/workbook";
+import { Sheet } from "@veltra/sheet-core/core/sheet";
 //#region src/types/sheet.d.ts
 /** 电子表格组件属性 */
 interface SheetProps {
@@ -13,10 +13,28 @@ interface SheetProps {
   rows?: number;
   /** 渲染列数，默认 26（A..Z） */
   cols?: number;
+  /**
+   * 显示值覆盖（设计态 Binding Placeholder 等）：覆盖 VTable record，不写 CellData.v
+   */
+  resolveDisplayValue?: ResolveDisplayValue;
+  /**
+   * 动态单元格样式：视口渲染时叠加条件样式补丁，不写 CellData.s / StylePool
+   */
+  resolveCellStyle?: ResolveCellStyleHook;
+  /**
+   * 动态单元格渲染（ADR-0004）：视口布局时按格自定义渲染形态（VTable
+   * customLayout，布局构建用 sheet-core 导出的 CustomLayout），返回 undefined
+   * 回落默认渲染；不写模型、不进快照
+   */
+  resolveCellRenderer?: ResolveCellRenderer;
   /** 是否显示工具栏，默认 true */
   showToolbar?: boolean;
+  /** 是否显示顶部公式栏（名称框 + fx 输入栏），默认 true */
+  showFormulaBar?: boolean;
   /** 是否显示底部 sheet 标签栏，默认 true */
   showTabs?: boolean;
+  /** 只读预览（关闭编辑回写、填充柄等写入口） */
+  readonly?: boolean;
 }
 interface SheetEmits {
   /** 激活 sheet 切换（点击 tab 或宿主调用 workbook.activateSheet） */
@@ -39,5 +57,4 @@ interface _SheetExposed {
 /** 电子表格组件暴露的属性和方法 */
 type SheetExposed = DeconstructValue<_SheetExposed>;
 //#endregion
-export { SheetEmits, SheetExposed, SheetProps, _SheetExposed };
-//# sourceMappingURL=sheet.d.ts.map
+export { SheetEmits, SheetExposed, SheetProps, _SheetExposed };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veltra/sheet",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "files": [
     "dist",
     "src"
@@ -25,14 +25,17 @@
     }
   },
   "dependencies": {
-    "@visactor/vtable": "^1.26.5",
-    "@visactor/vtable-editors": "^1.26.5"
+    "hucre": "^1.0.0"
   },
   "peerDependencies": {
     "@cat-kit/core": ">=1.1.8",
-    "@veltra/desktop": "1.4.0",
-    "@veltra/styles": "1.4.0",
-    "@veltra/utils": "1.4.0",
-    "vue": ">=3.5.40"
+    "@cat-kit/fe": ">=1.1.8",
+    "@veltra/compositions": "^1.5.0",
+    "@veltra/desktop": "^1.5.0",
+    "@veltra/icons": "^1.5.0",
+    "@veltra/sheet-core": "^2.2.0",
+    "@veltra/styles": "^1.5.0",
+    "@veltra/utils": "^1.5.0",
+    "vue": ">=3.5.41"
   }
 }

package/src/components/report/__test__/conditional-rules-helpers.test.ts

@@ -0,0 +1,87 @@
+import { describe, expect, it } from 'vitest'
+
+import type { ConditionalRule } from '../../../report/types'
+import {
+  cloneRulesFromDraft,
+  coerceValueForOperator,
+  createDraftItem,
+  defaultRuleValue,
+  initDraftFromRules,
+  operatorsForFieldType,
+  readBetweenValue,
+  resolveEvalFieldType,
+  ruleEvalFieldOptions,
+  RULE_SCOPE_OPTIONS,
+  writeBetweenValue
+} from '../designer/conditional-rules/helpers'
+
+describe('conditional-rules helpers', () => {
+  it('按字段类型返回运算符列表', () => {
+    expect(operatorsForFieldType('number').map((o) => o.value)).toEqual([
+      'gt',
+      'gte',
+      'lt',
+      'lte',
+      'eq',
+      'between'
+    ])
+    expect(operatorsForFieldType('string').map((o) => o.value)).toEqual(['eq', 'contains'])
+  })
+
+  it('运算符切换时重置比较值', () => {
+    expect(coerceValueForOperator('between', 'number', 42)).toEqual([0, 100])
+    expect(coerceValueForOperator('contains', 'string', 42)).toBe('')
+    expect(coerceValueForOperator('gt', 'number', '12')).toBe(12)
+  })
+
+  it('between 读写辅助', () => {
+    const value = defaultRuleValue('between', 'number')
+    expect(readBetweenValue(value, 0, 'number')).toBe(0)
+    expect(readBetweenValue(value, 1, 'number')).toBe(100)
+    expect(writeBetweenValue(value, 1, 250, 'number')).toEqual([0, 250])
+  })
+
+  it('草稿与规则互转保持深拷贝', () => {
+    const rules: ConditionalRule[] = [
+      { operator: 'gt', value: 10, style: { fill: { color: '#FFCCCC' }, font: { bold: true } } }
+    ]
+    const draft = initDraftFromRules(rules, 'number')
+    expect(draft).toHaveLength(1)
+
+    const cloned = cloneRulesFromDraft(draft)
+    expect(cloned[0]).toEqual(rules[0])
+    expect(cloned[0]).not.toBe(rules[0])
+
+    draft[0]!.rule.style.fill!.color = '#000000'
+    expect(rules[0]!.style.fill!.color).toBe('#FFCCCC')
+  })
+
+  it('新建草稿项带默认样式', () => {
+    const item = createDraftItem(undefined, 'string')
+    expect(item.rule.operator).toBe('eq')
+    expect(item.rule.value).toBe('')
+    expect(item.rule.style.fill?.color).toBeTruthy()
+  })
+
+  it('求值字段与作用范围选项', () => {
+    const fields = [
+      { name: 'amount', label: '金额', type: 'number' as const },
+      { name: 'region', label: '地区', type: 'string' as const }
+    ]
+    expect(ruleEvalFieldOptions('amount', fields).map((item) => item.label)).toEqual([
+      '本格字段',
+      '地区'
+    ])
+    expect(RULE_SCOPE_OPTIONS.map((item) => item.label)).toEqual(['本格', '整行'])
+    expect(resolveEvalFieldType({ operator: 'eq', value: '', style: {} }, 'amount', fields)).toBe(
+      'number'
+    )
+    expect(
+      resolveEvalFieldType(
+        { operator: 'eq', value: '', style: {}, field: 'region' },
+        'amount',
+        fields
+      )
+    ).toBe('string')
+  })
+})

package/src/components/report/__test__/field-panel-helpers.test.ts

@@ -0,0 +1,65 @@
+import { describe, expect, it } from 'vitest'
+
+import type { DatasetCatalogItem } from '../../../report/types'
+import {
+  fieldTypeGlyph,
+  filterDatasetsByQuery,
+  formatFieldDragPayload,
+  parseFieldDragPayload
+} from '../field-panel-helpers'
+
+// ---- 内联 fixtures ----
+
+const ORDERS: DatasetCatalogItem = {
+  id: 'orders',
+  label: '销售明细',
+  fields: [
+    { name: 'customer', label: '客户', type: 'string' },
+    { name: 'amount', label: '金额', type: 'number' }
+  ]
+}
+
+const INVENTORY: DatasetCatalogItem = {
+  id: 'inventory',
+  label: '库存',
+  fields: [
+    { name: 'sku', label: 'SKU', type: 'string' },
+    { name: 'qty', label: '数量', type: 'number' }
+  ]
+}
+
+describe('field-panel helpers', () => {
+  it('fieldTypeGlyph 按字段类型返回短标识', () => {
+    expect(fieldTypeGlyph('string')).toBe('文')
+    expect(fieldTypeGlyph('number')).toBe('#')
+    expect(fieldTypeGlyph('date')).toBe('日')
+  })
+
+  it('filterDatasetsByQuery 按中文名或英文字段名过滤', () => {
+    const datasets = [ORDERS, INVENTORY]
+
+    expect(filterDatasetsByQuery(datasets, '客户')).toEqual([
+      { ...ORDERS, fields: [ORDERS.fields[0]!] }
+    ])
+
+    expect(filterDatasetsByQuery(datasets, 'qty')).toEqual([
+      { ...INVENTORY, fields: [INVENTORY.fields[1]!] }
+    ])
+
+    expect(filterDatasetsByQuery(datasets, '  ')).toEqual(datasets)
+    expect(filterDatasetsByQuery(datasets, '不存在')).toEqual([])
+  })
+
+  it('字段拖拽负载编解码往返；非法负载返回 null', () => {
+    const payload = formatFieldDragPayload('orders', 'customer')
+    expect(payload).toBe('orders:customer')
+    expect(parseFieldDragPayload(payload)).toEqual({ datasetId: 'orders', fieldName: 'customer' })
+
+    // 字段名含冒号时按首个分隔符切分
+    expect(parseFieldDragPayload('orders:a:b')).toEqual({ datasetId: 'orders', fieldName: 'a:b' })
+
+    expect(parseFieldDragPayload('')).toBeNull()
+    expect(parseFieldDragPayload(':customer')).toBeNull()
+    expect(parseFieldDragPayload('orders:')).toBeNull()
+  })
+})

package/src/components/report/__test__/float-panel-position.test.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it } from 'vitest'
+
+import type { CellOverlayRect, GridOverlayLayout } from '../designer/cell-coords'
+import { resolveBindingFloatPanelPosition } from '../designer/use-grid-overlay'
+
+function cellRect(top: number, height = 24): CellOverlayRect {
+  const bottom = top + height
+  return {
+    left: 100,
+    top,
+    right: 180,
+    bottom,
+    width: 80,
+    height,
+    centerX: 140,
+    centerY: top + height / 2
+  }
+}
+
+const layout: GridOverlayLayout = { offsetX: 0, offsetY: 77, viewW: 640, viewH: 400 }
+
+describe('resolveBindingFloatPanelPosition', () => {
+  it('顶行格空间不足时改在单元格下方', () => {
+    const rect = cellRect(101)
+    const position = resolveBindingFloatPanelPosition(rect, layout, 320, 68, 640)
+
+    expect(position.placement).toBe('below')
+    expect(position.top).toBe(rect.bottom + 8)
+  })
+
+  it('中部格优先在单元格上方', () => {
+    const rect = cellRect(200)
+    const position = resolveBindingFloatPanelPosition(rect, layout, 320, 68, 640)
+
+    expect(position.placement).toBe('above')
+    expect(position.top).toBe(rect.top - 8)
+  })
+
+  it('水平居中并限制在宿主宽度内', () => {
+    const rect = cellRect(200)
+    const position = resolveBindingFloatPanelPosition(rect, layout, 320, 68, 340)
+
+    expect(position.left).toBe(170)
+  })
+})