@veltra/sheet 2.4.0 → 2.5.0

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

@@ -1,57 +0,0 @@
-import { ParamValues } from "../report/types.js";
-import { ReportColWidthEntry } from "../report/export-xlsx.js";
-import { DataConnector } from "../report/connector.js";
-import { ReportTemplate } from "../report/template.js";
-import { ResolveReportTemplate } from "../report/drill.js";
-import { ReportPrintOptions } from "../report/print.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;
-  /**
-   * 列宽显式覆盖（可选）：优先于模板 `colWidths` / 展开映射结果写入模型与网格。
-   * 列宽已进 `SheetSnapshot.colWidths`，通常无需再传。
-   */
-  colWidths?: ReadonlyArray<ReportColWidthEntry>;
-  /**
-   * 下钻目标模板解析契约（可选，内核共享类型）：单击配了下钻的绑定格时按 `target` 引用取目标模板。
-   * 解析失败（抛错 / reject，或宿主实现返回空值）时查看器给出可读提示并停留当前报。
-   * 缺省时下钻不生效（无点击行为与可点视觉提示）。
-   */
-  resolveTemplate?: ResolveReportTemplate;
-  /**
-   * Filter Bar 初值（可选）：与当前模板参数默认值合并，显式键覆盖默认值。
-   * 仅在根模板载入时播种（下钻弹框传入映射参数）；缺省则只用参数默认值。
-   */
-  initialValues?: ParamValues;
-}
-/** 在组件内部引用 */
-interface _ReportViewerExposed {
-  /** 重新取数并展开渲染（外部状态变化后主动刷新报表） */
-  refresh: () => Promise<void>;
-  /**
-   * 导出填充报表为 XLSX（取数完成前拒绝；内部读取填充 sheet 与运行时列宽）。
-   * 不内置导出按钮，工具栏由下游决定。
-   */
-  exportXlsx: () => Promise<void>;
-  /**
-   * 打印填充报表（纯前端：模型 → 打印 HTML → 隐藏 iframe 调起浏览器打印；
-   * 取数完成前拒绝）。不内置打印按钮，工具栏由下游决定。
-   */
-  print: (options?: ReportPrintOptions) => void;
-}
-/** 报表查看器组件暴露的方法 */
-type ReportViewerExposed = DeconstructValue<_ReportViewerExposed>;
-//#endregion
-export { ReportViewerExposed, ReportViewerProps, _ReportViewerExposed };

package/src/components/report/__test__/binding-badge.test.ts

@@ -1,92 +0,0 @@
-import { Sheet } from '@veltra/sheet-core'
-import type { CellAddress } from '@veltra/sheet-core'
-import { describe, expect, it } from 'vitest'
-
-import { REPORT_META_NAMESPACE, createReportBinding } from '../../../report/binding'
-import type { DatasetCatalogItem, ReportBinding } from '../../../report/types'
-import { badgeLayoutProps, createBindingBadgeRenderer } from '../binding-badge'
-
-// ---- 内联 fixtures ----
-
-const ORDERS_DATASET: DatasetCatalogItem = {
-  id: 'orders',
-  label: '销售明细',
-  fields: [
-    { name: 'customer', label: '客户', type: 'string' },
-    { name: 'amount', label: '金额', type: 'number' }
-  ]
-}
-
-const ADDR = { row: 1, col: 3 }
-
-function bindingMap(entries: Array<{ addr: CellAddress; binding: ReportBinding }>) {
-  const map = new Map<string, ReportBinding>()
-  for (const { addr, binding } of entries) map.set(`${addr.row},${addr.col}`, binding)
-  return (addr: CellAddress) => map.get(`${addr.row},${addr.col}`)
-}
-
-describe('badgeLayoutProps（单元格对齐 → 徽章容器 flex 映射）', () => {
-  it('缺省对齐 → 主轴起点 + 交叉轴居中（向后兼容）', () => {
-    expect(badgeLayoutProps(undefined)).toEqual({
-      justifyContent: 'flex-start',
-      alignItems: 'center'
-    })
-    expect(badgeLayoutProps({})).toEqual({ justifyContent: 'flex-start', alignItems: 'center' })
-  })
-
-  it('horizontal center / right / left → justifyContent', () => {
-    expect(badgeLayoutProps({ horizontal: 'center' }).justifyContent).toBe('center')
-    expect(badgeLayoutProps({ horizontal: 'right' }).justifyContent).toBe('flex-end')
-    expect(badgeLayoutProps({ horizontal: 'left' }).justifyContent).toBe('flex-start')
-  })
-
-  it('vertical bottom / top / middle → alignItems', () => {
-    expect(badgeLayoutProps({ vertical: 'bottom' }).alignItems).toBe('flex-end')
-    expect(badgeLayoutProps({ vertical: 'top' }).alignItems).toBe('flex-start')
-    expect(badgeLayoutProps({ vertical: 'middle' }).alignItems).toBe('center')
-  })
-})
-
-describe('createBindingBadgeRenderer', () => {
-  it('未绑定格返回 undefined 回落默认渲染', () => {
-    const renderer = createBindingBadgeRenderer(bindingMap([]))
-    expect(renderer(ADDR, undefined)).toBeUndefined()
-  })
-
-  it('绑定格不传 resolveAlign 保持左对齐徽章（向后兼容）', () => {
-    const binding = createReportBinding(ORDERS_DATASET, 'amount')
-    const renderer = createBindingBadgeRenderer(bindingMap([{ addr: ADDR, binding }]))
-    const layout = renderer(ADDR, undefined)
-    expect(layout?.renderDefault).toBe(false)
-    expect(layout?.rootContainer.attribute.justifyContent).toBe('flex-start')
-    expect(layout?.rootContainer.attribute.alignItems).toBe('center')
-  })
-
-  it('绑定格容器跟随 resolveAlign 的水平 / 垂直对齐', () => {
-    const binding = createReportBinding(ORDERS_DATASET, 'amount')
-    const renderer = createBindingBadgeRenderer(
-      bindingMap([{ addr: ADDR, binding }]),
-      undefined,
-      () => ({ horizontal: 'center', vertical: 'bottom' })
-    )
-    const layout = renderer(ADDR, undefined)
-    expect(layout?.rootContainer.attribute.justifyContent).toBe('center')
-    expect(layout?.rootContainer.attribute.alignItems).toBe('flex-end')
-  })
-
-  it('接线冒烟：经 Sheet.getEffectiveStyle 读取有效样式对齐（含行默认样式叠加）', () => {
-    const sheet = new Sheet()
-    sheet.setCellMeta(ADDR, REPORT_META_NAMESPACE, createReportBinding(ORDERS_DATASET, 'amount'))
-    sheet.setCellStyle({ start: ADDR, end: ADDR }, { align: { horizontal: 'center' } })
-    sheet.setRowStyle(ADDR.row, { align: { vertical: 'bottom' } })
-
-    const renderer = createBindingBadgeRenderer(
-      (addr) => sheet.getCellMeta<ReportBinding>(addr, REPORT_META_NAMESPACE),
-      undefined,
-      (addr) => sheet.getEffectiveStyle(addr)?.align
-    )
-    const layout = renderer(ADDR, undefined)
-    expect(layout?.rootContainer.attribute.justifyContent).toBe('center')
-    expect(layout?.rootContainer.attribute.alignItems).toBe('flex-end')
-  })
-})

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

@@ -1,88 +0,0 @@
-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(ruleEvalFieldOptions('amount', fields).map((item) => item.value)).toEqual(['', 'region'])
-    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

@@ -1,65 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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)
-  })
-})

package/src/components/report/__test__/preview-grid-size.test.ts

@@ -1,63 +0,0 @@
-import type { SheetSnapshot } from '@veltra/sheet-core'
-import { describe, expect, it } from 'vitest'
-
-import { previewGridSize } from '../preview-grid-size'
-
-function snap(
-  partial: Partial<SheetSnapshot> & Pick<SheetSnapshot, 'cells'>
-): Pick<SheetSnapshot, 'cells' | 'merges' | 'meta' | 'rows'> {
-  return { merges: [], rows: 0, ...partial }
-}
-
-describe('previewGridSize', () => {
-  it('template 模式用内容包围盒，忽略设计态 canvas 尺寸', () => {
-    expect(
-      previewGridSize(
-        snap({
-          cells: [
-            { row: 0, col: 0, v: '客户' },
-            { row: 0, col: 1, v: '金额' }
-          ],
-          rows: 24,
-          cols: 10
-        }),
-        'template'
-      )
-    ).toEqual({ rows: 1, cols: 2 })
-  })
-
-  it('filled 模式行保留展开布局尺寸，列按包围盒收敛（去掉设计态撑大的列）', () => {
-    expect(
-      previewGridSize(
-        snap({
-          cells: [
-            { row: 0, col: 0, v: '客户' },
-            { row: 3, col: 1, v: 300 }
-          ],
-          rows: 4,
-          cols: 10
-        }),
-        'filled'
-      )
-    ).toEqual({ rows: 4, cols: 2 })
-  })
-
-  it('空快照至少 1×1（VTable 需要非零网格）', () => {
-    expect(previewGridSize(snap({ cells: [] }), 'template')).toEqual({ rows: 1, cols: 1 })
-  })
-
-  it('包围盒计入合并区终点与 meta 绑定格', () => {
-    expect(
-      previewGridSize(
-        snap({
-          cells: [{ row: 0, col: 0, v: '标题' }],
-          merges: [{ start: { row: 0, col: 0 }, end: { row: 0, col: 2 } }],
-          meta: [{ row: 2, col: 1, namespace: 'report', payload: {} }],
-          rows: 24,
-          cols: 10
-        }),
-        'template'
-      )
-    ).toEqual({ rows: 3, cols: 3 })
-  })
-})