@veltra/sheet 2.1.1 → 2.2.0

package/src/types/report-designer.ts

@@ -0,0 +1,36 @@
+import type { Workbook } from '@veltra/sheet-core/core/workbook'
+import type { DeconstructValue } from '@veltra/utils'
+
+import type { DataConnection, DataConnector, ReportTemplate } from '../report'
+
+/** 报表设计器组件属性（ADR-0003 决策 2） */
+export 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
+}
+
+/** 报表设计器组件定义的事件 */
+export interface ReportDesignerEmits {
+  (e: 'update:connections', value: DataConnection[]): void
+}
+
+/** 在组件内部引用 */
+export interface _ReportDesignerExposed {
+  /** 取回含 meta 绑定与内嵌数据集定义的可序列化 Report Template */
+  getTemplate: () => ReportTemplate
+}
+
+/** 报表设计器组件暴露的方法 */
+export type ReportDesignerExposed = DeconstructValue<_ReportDesignerExposed>

package/src/types/report-viewer.ts

@@ -0,0 +1,37 @@
+import type { Workbook } from '@veltra/sheet-core/core/workbook'
+import type { DeconstructValue } from '@veltra/utils'
+
+import type { DataConnector, ReportTemplate } from '../report'
+import type { ReportColWidthEntry } from '../report/export-xlsx'
+
+/** 报表查看器组件属性（ADR-0003 决策 2） */
+export 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>
+}
+
+/** 在组件内部引用 */
+export interface _ReportViewerExposed {
+  /** 重新取数并展开渲染（外部状态变化后主动刷新报表） */
+  refresh: () => Promise<void>
+  /**
+   * 导出填充报表为 XLSX（取数完成前拒绝；内部读取填充 sheet 与运行时列宽）。
+   * 不内置导出按钮，工具栏由下游决定。
+   */
+  exportXlsx: () => Promise<void>
+}
+
+/** 报表查看器组件暴露的方法 */
+export type ReportViewerExposed = DeconstructValue<_ReportViewerExposed>

package/src/types/sheet.ts

@@ -1,6 +1,11 @@
 import type { Sheet } from '@veltra/sheet-core/core/sheet'
 import type { Workbook } from '@veltra/sheet-core/core/workbook'
-import type { SheetGrid } from '@veltra/sheet-core/grid/sheet-grid'
+import type {
+  ResolveCellRenderer,
+  ResolveCellStyleHook,
+  ResolveDisplayValue,
+  SheetGrid
+} from '@veltra/sheet-core/grid/sheet-grid'
 import type { DeconstructValue } from '@veltra/utils'
 import type { ComputedRef } from 'vue'
 
@@ -14,12 +19,28 @@ export 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
 }
 
 export interface SheetEmits {