orbcafe-ui 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -5
- package/dist/index.d.mts +105 -2
- package/dist/index.d.ts +105 -2
- package/dist/index.js +14 -14
- package/dist/index.mjs +12 -12
- package/package.json +14 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
- 组件可直接通过 NPM 安装并使用。
|
|
8
8
|
- 组件 API 稳定、类型完整、目录结构一致。
|
|
9
|
-
-
|
|
9
|
+
- 组件公共 API、类型契约与回调契约稳定,文档与 examples 可追踪。
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
@@ -24,12 +24,13 @@
|
|
|
24
24
|
| `CustomizeAgent` | AI 参数与 Prompt 模板设置弹窗 | `src/components/CustomizeAgent` | `src/components/CustomizeAgent/README.md` |
|
|
25
25
|
| `DetailInfo` | 标准详情页容器(信息块 + Tabs + 底部表格 + AI/搜索) | `src/components/DetailInfo` | `src/components/DetailInfo/README.md` |
|
|
26
26
|
| `PageLayout` | 页面壳层(Header + Navigation + Content) | `src/components/PageLayout` | `src/components/PageLayout/README.md` |
|
|
27
|
+
| `AgentUI` | 聊天 UI 与 Copilot UI(StdChat / CopilotChat / AgentPanel) | `src/components/AgentUI` | `src/components/AgentUI/README.md` |
|
|
27
28
|
|
|
28
29
|
### 文档查阅顺序(推荐)
|
|
29
30
|
|
|
30
31
|
1. 先看模块根 README:了解能力边界、最小接入示例。
|
|
31
|
-
2.
|
|
32
|
-
3.
|
|
32
|
+
2. 如果该模块公开导出 hooks,再看模块 `Hooks/README.md`:确认状态管理、参数、返回值与联动方式。
|
|
33
|
+
3. 最后看模块详细设计文档或 AI 契约索引:理解内部结构、标准案例与扩展点。
|
|
33
34
|
|
|
34
35
|
### 常用文档索引
|
|
35
36
|
|
|
@@ -38,6 +39,76 @@
|
|
|
38
39
|
- `StdReport Hooks`:`src/components/StdReport/Hooks/README.md`
|
|
39
40
|
- `PageLayout Hooks`:`src/components/PageLayout/Hooks/README.md`
|
|
40
41
|
- `DetailInfo` 模块文档:`src/components/DetailInfo/README.md`
|
|
42
|
+
- `AgentUI` 模块文档:`src/components/AgentUI/README.md`
|
|
43
|
+
- `AI 模块契约索引`:`skills/orbcafe-ui-component-usage/references/module-contracts.md`
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## AgentUI(聊天与 Copilot)
|
|
48
|
+
|
|
49
|
+
`AgentUI` 是库里负责聊天类交互的标准模块,当前建议直接使用以下公共 API:
|
|
50
|
+
|
|
51
|
+
- `AgentPanel`: 带头部的标准聊天容器。
|
|
52
|
+
- `StdChat`: 适合整页、弹窗、工作台内嵌聊天。
|
|
53
|
+
- `CopilotChat`: 适合右下角 Copilot 浮窗内容层。
|
|
54
|
+
- `AgentUICardHooks` / `AgentUICardHookEvent`: 卡片交互事件回调类型。
|
|
55
|
+
|
|
56
|
+
### Import
|
|
57
|
+
|
|
58
|
+
```tsx
|
|
59
|
+
import {
|
|
60
|
+
AgentPanel,
|
|
61
|
+
StdChat,
|
|
62
|
+
CopilotChat,
|
|
63
|
+
type ChatMessage,
|
|
64
|
+
type AgentUICardHooks
|
|
65
|
+
} from 'orbcafe-ui'
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### 使用约定
|
|
69
|
+
|
|
70
|
+
- `AgentUI` 当前没有独立导出的自定义 hooks,对外稳定接口是组件 props 和回调契约。
|
|
71
|
+
- 标准消息状态以 `messages + isResponding` 为主。
|
|
72
|
+
- 卡片交互统一通过 `cardHooks.onCardEvent` 承接。
|
|
73
|
+
- `StdChat` 负责标准聊天布局,`CopilotChat` 只负责 Copilot 面板内容层,不负责浮窗壳、拖拽和缩放。
|
|
74
|
+
|
|
75
|
+
详细接入方式、example 拆解和封装边界说明见 `src/components/AgentUI/README.md`。
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## AI-First Integration
|
|
80
|
+
|
|
81
|
+
如果目标是让 AI 在 vibe coding 场景里稳定使用 ORBCAFE UI,推荐遵循这条顺序:
|
|
82
|
+
|
|
83
|
+
1. 先用 `skills/orbcafe-ui-component-usage` 判定目标模块。
|
|
84
|
+
2. 再看 `skills/orbcafe-ui-component-usage/references/module-contracts.md`,确认:
|
|
85
|
+
- 公共导出入口
|
|
86
|
+
- 推荐标准组件
|
|
87
|
+
- 是否公开 hooks
|
|
88
|
+
- 最小状态结构
|
|
89
|
+
- 标准 example
|
|
90
|
+
- 验证与排障清单
|
|
91
|
+
3. 最后才看具体模块 README 和官方 examples。
|
|
92
|
+
|
|
93
|
+
### 当前标准化原则
|
|
94
|
+
|
|
95
|
+
- 只使用 `src/index.ts` 可达的公共导出。
|
|
96
|
+
- 优先走 canonical example,不从内部组件自由拼装。
|
|
97
|
+
- 每个模块都要回答 5 个问题:
|
|
98
|
+
- 用哪个公共入口组件或 hook
|
|
99
|
+
- 最小状态是什么
|
|
100
|
+
- 必须回调有哪些
|
|
101
|
+
- 标准 example 是哪个
|
|
102
|
+
- 怎么验证“真的生效了”
|
|
103
|
+
|
|
104
|
+
### 关于 Hooks
|
|
105
|
+
|
|
106
|
+
不是所有模块都以 hooks 为主入口。
|
|
107
|
+
|
|
108
|
+
- `StdReport`、`DetailInfo`、`PivotTable`、`AINav`、`PageLayout` 明确公开了 hooks。
|
|
109
|
+
- `AgentUI` 当前不公开自定义 hook,稳定入口是组件 props 和回调契约。
|
|
110
|
+
|
|
111
|
+
这条规则对 AI 很重要,因为它决定了应该生成“hook 驱动代码”还是“组件 + callbacks 驱动代码”。
|
|
41
112
|
|
|
42
113
|
---
|
|
43
114
|
|
|
@@ -186,15 +257,24 @@ Hydration mismatch 常见来源:
|
|
|
186
257
|
提交前建议至少执行:
|
|
187
258
|
|
|
188
259
|
```bash
|
|
189
|
-
# 1)
|
|
260
|
+
# 1) 校验 AI 契约与公开导出一致
|
|
261
|
+
npm run check:ai-contracts
|
|
262
|
+
|
|
263
|
+
# 2) 构建组件库
|
|
190
264
|
npm run build
|
|
191
265
|
|
|
192
|
-
#
|
|
266
|
+
# 3) 校验 examples
|
|
193
267
|
cd examples
|
|
194
268
|
npm run lint
|
|
195
269
|
npx tsc --noEmit
|
|
196
270
|
```
|
|
197
271
|
|
|
272
|
+
如果要做一轮更完整的发布前检查:
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
npm run release:check
|
|
276
|
+
```
|
|
277
|
+
|
|
198
278
|
如果只想快速看运行效果:
|
|
199
279
|
|
|
200
280
|
```bash
|
|
@@ -202,6 +282,16 @@ cd examples
|
|
|
202
282
|
npm run dev
|
|
203
283
|
```
|
|
204
284
|
|
|
285
|
+
### 发布前 AI 契约清单
|
|
286
|
+
|
|
287
|
+
每次发布前至少确认:
|
|
288
|
+
|
|
289
|
+
1. `src/index.ts` 的公共导出与 skill 文档一致。
|
|
290
|
+
2. `skills/orbcafe-ui-component-usage/references/module-contracts.md` 和 `.json` 已同步更新。
|
|
291
|
+
3. 新模块已声明 `Hook-first` / `Component-first`。
|
|
292
|
+
4. 每个模块至少有一个 canonical example。
|
|
293
|
+
5. router skill 已能把新模块正确分流。
|
|
294
|
+
|
|
205
295
|
---
|
|
206
296
|
|
|
207
297
|
## Internationalization (i18n)
|
package/dist/index.d.mts
CHANGED
|
@@ -772,8 +772,12 @@ interface UseStandardReportOptions {
|
|
|
772
772
|
fetchData?: (params: any) => Promise<any>;
|
|
773
773
|
initialRowsPerPage?: number;
|
|
774
774
|
rowsPerPageOptions?: number[];
|
|
775
|
+
tableKey?: string;
|
|
776
|
+
mode?: CStandardPageProps['mode'];
|
|
777
|
+
serviceUrl?: string;
|
|
778
|
+
variantService?: IVariantService;
|
|
775
779
|
}
|
|
776
|
-
declare const useStandardReport: ({ metadata, fetchData, initialRowsPerPage, rowsPerPageOptions, }: UseStandardReportOptions) => {
|
|
780
|
+
declare const useStandardReport: ({ metadata, fetchData, initialRowsPerPage, rowsPerPageOptions, tableKey, mode, serviceUrl, variantService, }: UseStandardReportOptions) => {
|
|
777
781
|
pageProps: CStandardPageProps;
|
|
778
782
|
filters: Record<string, any>;
|
|
779
783
|
rows: any[];
|
|
@@ -1533,6 +1537,105 @@ interface COrbCanvasProps {
|
|
|
1533
1537
|
}
|
|
1534
1538
|
declare function COrbCanvas({ hue, hoverIntensity, rotateOnHover, forceHoverState, backgroundColor }: COrbCanvasProps): react_jsx_runtime.JSX.Element;
|
|
1535
1539
|
|
|
1540
|
+
interface TableTypeContent {
|
|
1541
|
+
type: 'table';
|
|
1542
|
+
data: any;
|
|
1543
|
+
}
|
|
1544
|
+
interface ChartCardTypeContent {
|
|
1545
|
+
type: 'bar-chart-card' | 'line-chart-card' | 'pie-chart-card' | 'combo-chart-card' | 'heatmap-chart-card' | 'fishbone-chart-card' | 'waterfall-chart-card' | 'google-map-card' | 'amap-card';
|
|
1546
|
+
title: string;
|
|
1547
|
+
subtitle?: string;
|
|
1548
|
+
data: any[];
|
|
1549
|
+
config?: any;
|
|
1550
|
+
}
|
|
1551
|
+
interface SAPCardTypeContent {
|
|
1552
|
+
type: 'sap-analytical-card' | 'sap-list-card' | 'sap-object-card' | 'sap-component-card';
|
|
1553
|
+
manifest: any;
|
|
1554
|
+
}
|
|
1555
|
+
interface AgentUICardTypeContent {
|
|
1556
|
+
type: 'error-card' | 'warning-card' | 'suggestions-card' | 'tool-result-card';
|
|
1557
|
+
[key: string]: any;
|
|
1558
|
+
}
|
|
1559
|
+
type ParsedCardData = TableTypeContent | ChartCardTypeContent | SAPCardTypeContent | AgentUICardTypeContent;
|
|
1560
|
+
type AgentUICardType = ParsedCardData['type'];
|
|
1561
|
+
type AgentUICardAction = 'render' | 'close' | 'retry' | 'confirm' | 'action' | 'suggestion-click';
|
|
1562
|
+
interface AgentUICardHookEvent {
|
|
1563
|
+
messageId?: string;
|
|
1564
|
+
cardType: AgentUICardType;
|
|
1565
|
+
action: AgentUICardAction;
|
|
1566
|
+
title?: string;
|
|
1567
|
+
payload?: unknown;
|
|
1568
|
+
rawData?: unknown;
|
|
1569
|
+
}
|
|
1570
|
+
interface AgentUICardHooks {
|
|
1571
|
+
onCardEvent?: (event: AgentUICardHookEvent) => void;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
interface AssistantActionContext {
|
|
1575
|
+
isLatestAssistant: boolean;
|
|
1576
|
+
onRegenerate?: () => Promise<void>;
|
|
1577
|
+
}
|
|
1578
|
+
interface ChatMessageProps {
|
|
1579
|
+
message: ChatMessage;
|
|
1580
|
+
onStreamingComplete?: () => void;
|
|
1581
|
+
assistantActions?: AssistantActionContext;
|
|
1582
|
+
streamIntervalMs?: number;
|
|
1583
|
+
streamChunkSize?: number;
|
|
1584
|
+
cardHooks?: AgentUICardHooks;
|
|
1585
|
+
}
|
|
1586
|
+
interface ChatMessage {
|
|
1587
|
+
id: string;
|
|
1588
|
+
type: 'user' | 'assistant';
|
|
1589
|
+
content: string;
|
|
1590
|
+
timestamp: Date;
|
|
1591
|
+
isStreaming?: boolean;
|
|
1592
|
+
}
|
|
1593
|
+
declare const ChatMessage: React__default.FC<ChatMessageProps>;
|
|
1594
|
+
|
|
1595
|
+
interface StdChatProps {
|
|
1596
|
+
messages: ChatMessage[];
|
|
1597
|
+
onSend: (content: string, files?: File[]) => Promise<void>;
|
|
1598
|
+
onStop?: () => void;
|
|
1599
|
+
onRegenerate?: (messageId: string) => Promise<void>;
|
|
1600
|
+
isResponding?: boolean;
|
|
1601
|
+
className?: string;
|
|
1602
|
+
placeholder?: string;
|
|
1603
|
+
streamIntervalMs?: number;
|
|
1604
|
+
streamChunkSize?: number;
|
|
1605
|
+
onMessageStreamingComplete?: (messageId: string) => void;
|
|
1606
|
+
cardHooks?: AgentUICardHooks;
|
|
1607
|
+
}
|
|
1608
|
+
declare const StdChat: React__default.FC<StdChatProps>;
|
|
1609
|
+
|
|
1610
|
+
interface AgentPanelProps extends StdChatProps {
|
|
1611
|
+
title?: string;
|
|
1612
|
+
description?: string;
|
|
1613
|
+
headerActions?: React__default.ReactNode;
|
|
1614
|
+
}
|
|
1615
|
+
declare const AgentPanel: React__default.FC<AgentPanelProps>;
|
|
1616
|
+
|
|
1617
|
+
type CopilotCorner = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
1618
|
+
interface CopilotChatProps {
|
|
1619
|
+
messages: ChatMessage[];
|
|
1620
|
+
onSend: (content: string, files?: File[]) => Promise<void>;
|
|
1621
|
+
onStop?: () => void;
|
|
1622
|
+
onRegenerate?: (messageId: string) => Promise<void>;
|
|
1623
|
+
isResponding?: boolean;
|
|
1624
|
+
className?: string;
|
|
1625
|
+
placeholder?: string;
|
|
1626
|
+
title?: string;
|
|
1627
|
+
corner?: CopilotCorner;
|
|
1628
|
+
onCollapse?: () => void;
|
|
1629
|
+
onHeaderPointerDown?: (e: React__default.PointerEvent<HTMLDivElement>) => void;
|
|
1630
|
+
onPlusClick?: () => void;
|
|
1631
|
+
onMicClick?: () => void;
|
|
1632
|
+
streamIntervalMs?: number;
|
|
1633
|
+
streamChunkSize?: number;
|
|
1634
|
+
onMessageStreamingComplete?: (messageId: string) => void;
|
|
1635
|
+
cardHooks?: AgentUICardHooks;
|
|
1636
|
+
}
|
|
1637
|
+
declare const CopilotChat: React__default.FC<CopilotChatProps>;
|
|
1638
|
+
|
|
1536
1639
|
interface MarkdownRendererProps {
|
|
1537
1640
|
markdown?: string;
|
|
1538
1641
|
content?: string;
|
|
@@ -1627,4 +1730,4 @@ declare const PAGE_TRANSITION_PRESETS: {
|
|
|
1627
1730
|
};
|
|
1628
1731
|
};
|
|
1629
1732
|
|
|
1630
|
-
export { type AINavContextValue, type AmapEmbedOptions, Button, type ButtonProps, CAINavProvider, type CAINavProviderProps, CAmapChart, type CAmapChartProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, type CAppHeaderUserMenuItem, CAppPageLayout, type CAppPageLayoutProps, CBarChart, type CBarChartProps, CChartCard, type CChartCardProps, CComboChart, type CComboChartProps, CCustomizeAgent, type CCustomizeAgentProps, CDetailInfoPage, type CDetailInfoPageProps, CDetailSearchAiBar, type CDetailSearchAiBarProps, CDetailSectionCard, type CDetailSectionCardProps, CFishboneChart, type CFishboneChartProps, CGoogleMapChart, type CGoogleMapChartProps, CGraphCharts, CGraphKpiCards, CGraphReport, type CGraphReportProps, CHeatmapChart, type CHeatmapChartProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CLineChart, type CLineChartProps, CMessageBox, type CMessageBoxProps, type CMessageBoxType, COrbCanvas, type COrbCanvasProps, CPageLayout, type CPageLayoutProps, CPageTransition, type CPageTransitionProps, CPieChart, type CPieChartProps, CPivotTable, type CPivotTableProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, type CTableQuickCreateConfig, type CTableQuickDeleteConfig, type CTableQuickEditConfig, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, CVoiceWaveOverlay, type CVoiceWaveOverlayProps, CWaterfallChart, type CWaterfallChartProps, CodeBlock, type CodeBlockProps, type CustomizeAgentSavePayload, type CustomizeAgentSettings, type CustomizeAgentTemplateOption, type DateOperator, type DetailInfoAiConfig, type DetailInfoField, type DetailInfoSearchHit, type DetailInfoSearchMode, type DetailInfoSection, type DetailInfoTab, type DetailInfoTableConfig, type FilterField, type FilterOperator, type FilterType, type FilterValue, GlobalMessage, type GoogleMapEmbedOptions, type GraphBarDatum, type GraphComboDatum, type GraphFishboneBranch, type GraphHeatmapDatum, type GraphLineDatum, type GraphMapLocation, type GraphPieDatum, type GraphReportConfig, type GraphReportFieldMapping, type GraphReportInteractionState, type GraphReportKpis, type GraphReportModel, type GraphRow, type GraphTableColumn, type GraphWaterfallDatum, type IVariantService, type LayoutMetadata, MarkdownRenderer, type MarkdownRendererProps, MathBlock, type MathBlockProps, MermaidBlock, type MermaidBlockProps, type MessageContent, type MessageEvent, type MessageOptions, NavigationIsland, type NavigationIslandProps, type NumberOperator, ORBCAFE_I18N_MESSAGES, type OrbcafeI18nContextValue, OrbcafeI18nProvider, type OrbcafeI18nProviderProps, type OrbcafeLocale, type OrbcafeLocaleMessages, type OrbcafeMessageKey, type OrbcafeMessageParams, PAGE_TRANSITION_PRESETS, type PageTransitionVariant, type ParsedMarkdownTable, type PivotAggregation, type PivotFieldDefinition, type PivotFieldType, type PivotFilterSelections, type PivotLayoutConfig, type PivotTableModel, type PivotTablePreset, type PivotValueFieldConfig, type PivotValueFieldState, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, type TableAlign, TableBlock, type TableBlockProps, type TextOperator, ThinkBlock, type ThinkBlockProps, TreeMenu, type TreeMenuItem, type UseAmapEmbedUrlOptions, type UseDetailInfoOptions, type UseDetailInfoResult, type UseGoogleMapEmbedUrlOptions, type UseGraphChartDataOptions, type UseGraphChartDataResult, type UseGraphInteractionResult, type UseGraphReportOptions, type UseGraphReportResult, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UsePivotTableOptions, type UsePivotTableResult, type UseStandardReportOptions, type UseVoiceInputOptions, type UseVoiceInputResult, type VariantMetadata, type VoiceNavigatorContextValue, VoiceNavigatorProvider, type VoiceNavigatorProviderProps, VoiceWaveOverlay, type VoiceWaveOverlayProps, buildAmapEmbedUrl, buildGoogleMapEmbedUrl, buildGoogleMapIframe, buttonVariants, message, messageManager, parseMarkdownTable, renderMarkdown, resolveVariantFilters, resolveVariantLayout, useAINav, useAmapEmbedUrl, useDetailInfo, useGoogleMapEmbedUrl, useGraphChartData, useGraphInteraction, useGraphReport, useNavigationIsland, useOrbcafeI18n, usePageLayout, usePivotTable, useStandardReport, useVoiceInput, useVoiceNavigator };
|
|
1733
|
+
export { type AINavContextValue, AgentPanel, type AgentPanelProps, type AgentUICardAction, type AgentUICardHookEvent, type AgentUICardHooks, type AgentUICardType, type AmapEmbedOptions, Button, type ButtonProps, CAINavProvider, type CAINavProviderProps, CAmapChart, type CAmapChartProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, type CAppHeaderUserMenuItem, CAppPageLayout, type CAppPageLayoutProps, CBarChart, type CBarChartProps, CChartCard, type CChartCardProps, CComboChart, type CComboChartProps, CCustomizeAgent, type CCustomizeAgentProps, CDetailInfoPage, type CDetailInfoPageProps, CDetailSearchAiBar, type CDetailSearchAiBarProps, CDetailSectionCard, type CDetailSectionCardProps, CFishboneChart, type CFishboneChartProps, CGoogleMapChart, type CGoogleMapChartProps, CGraphCharts, CGraphKpiCards, CGraphReport, type CGraphReportProps, CHeatmapChart, type CHeatmapChartProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CLineChart, type CLineChartProps, CMessageBox, type CMessageBoxProps, type CMessageBoxType, COrbCanvas, type COrbCanvasProps, CPageLayout, type CPageLayoutProps, CPageTransition, type CPageTransitionProps, CPieChart, type CPieChartProps, CPivotTable, type CPivotTableProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, type CTableQuickCreateConfig, type CTableQuickDeleteConfig, type CTableQuickEditConfig, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, CVoiceWaveOverlay, type CVoiceWaveOverlayProps, CWaterfallChart, type CWaterfallChartProps, ChatMessage, CodeBlock, type CodeBlockProps, CopilotChat, type CopilotChatProps, type CustomizeAgentSavePayload, type CustomizeAgentSettings, type CustomizeAgentTemplateOption, type DateOperator, type DetailInfoAiConfig, type DetailInfoField, type DetailInfoSearchHit, type DetailInfoSearchMode, type DetailInfoSection, type DetailInfoTab, type DetailInfoTableConfig, type FilterField, type FilterOperator, type FilterType, type FilterValue, GlobalMessage, type GoogleMapEmbedOptions, type GraphBarDatum, type GraphComboDatum, type GraphFishboneBranch, type GraphHeatmapDatum, type GraphLineDatum, type GraphMapLocation, type GraphPieDatum, type GraphReportConfig, type GraphReportFieldMapping, type GraphReportInteractionState, type GraphReportKpis, type GraphReportModel, type GraphRow, type GraphTableColumn, type GraphWaterfallDatum, type IVariantService, type LayoutMetadata, MarkdownRenderer, type MarkdownRendererProps, MathBlock, type MathBlockProps, MermaidBlock, type MermaidBlockProps, type MessageContent, type MessageEvent, type MessageOptions, NavigationIsland, type NavigationIslandProps, type NumberOperator, ORBCAFE_I18N_MESSAGES, type OrbcafeI18nContextValue, OrbcafeI18nProvider, type OrbcafeI18nProviderProps, type OrbcafeLocale, type OrbcafeLocaleMessages, type OrbcafeMessageKey, type OrbcafeMessageParams, PAGE_TRANSITION_PRESETS, type PageTransitionVariant, type ParsedMarkdownTable, type PivotAggregation, type PivotFieldDefinition, type PivotFieldType, type PivotFilterSelections, type PivotLayoutConfig, type PivotTableModel, type PivotTablePreset, type PivotValueFieldConfig, type PivotValueFieldState, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, StdChat, type StdChatProps, type TableAlign, TableBlock, type TableBlockProps, type TextOperator, ThinkBlock, type ThinkBlockProps, TreeMenu, type TreeMenuItem, type UseAmapEmbedUrlOptions, type UseDetailInfoOptions, type UseDetailInfoResult, type UseGoogleMapEmbedUrlOptions, type UseGraphChartDataOptions, type UseGraphChartDataResult, type UseGraphInteractionResult, type UseGraphReportOptions, type UseGraphReportResult, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UsePivotTableOptions, type UsePivotTableResult, type UseStandardReportOptions, type UseVoiceInputOptions, type UseVoiceInputResult, type VariantMetadata, type VoiceNavigatorContextValue, VoiceNavigatorProvider, type VoiceNavigatorProviderProps, VoiceWaveOverlay, type VoiceWaveOverlayProps, buildAmapEmbedUrl, buildGoogleMapEmbedUrl, buildGoogleMapIframe, buttonVariants, message, messageManager, parseMarkdownTable, renderMarkdown, resolveVariantFilters, resolveVariantLayout, useAINav, useAmapEmbedUrl, useDetailInfo, useGoogleMapEmbedUrl, useGraphChartData, useGraphInteraction, useGraphReport, useNavigationIsland, useOrbcafeI18n, usePageLayout, usePivotTable, useStandardReport, useVoiceInput, useVoiceNavigator };
|
package/dist/index.d.ts
CHANGED
|
@@ -772,8 +772,12 @@ interface UseStandardReportOptions {
|
|
|
772
772
|
fetchData?: (params: any) => Promise<any>;
|
|
773
773
|
initialRowsPerPage?: number;
|
|
774
774
|
rowsPerPageOptions?: number[];
|
|
775
|
+
tableKey?: string;
|
|
776
|
+
mode?: CStandardPageProps['mode'];
|
|
777
|
+
serviceUrl?: string;
|
|
778
|
+
variantService?: IVariantService;
|
|
775
779
|
}
|
|
776
|
-
declare const useStandardReport: ({ metadata, fetchData, initialRowsPerPage, rowsPerPageOptions, }: UseStandardReportOptions) => {
|
|
780
|
+
declare const useStandardReport: ({ metadata, fetchData, initialRowsPerPage, rowsPerPageOptions, tableKey, mode, serviceUrl, variantService, }: UseStandardReportOptions) => {
|
|
777
781
|
pageProps: CStandardPageProps;
|
|
778
782
|
filters: Record<string, any>;
|
|
779
783
|
rows: any[];
|
|
@@ -1533,6 +1537,105 @@ interface COrbCanvasProps {
|
|
|
1533
1537
|
}
|
|
1534
1538
|
declare function COrbCanvas({ hue, hoverIntensity, rotateOnHover, forceHoverState, backgroundColor }: COrbCanvasProps): react_jsx_runtime.JSX.Element;
|
|
1535
1539
|
|
|
1540
|
+
interface TableTypeContent {
|
|
1541
|
+
type: 'table';
|
|
1542
|
+
data: any;
|
|
1543
|
+
}
|
|
1544
|
+
interface ChartCardTypeContent {
|
|
1545
|
+
type: 'bar-chart-card' | 'line-chart-card' | 'pie-chart-card' | 'combo-chart-card' | 'heatmap-chart-card' | 'fishbone-chart-card' | 'waterfall-chart-card' | 'google-map-card' | 'amap-card';
|
|
1546
|
+
title: string;
|
|
1547
|
+
subtitle?: string;
|
|
1548
|
+
data: any[];
|
|
1549
|
+
config?: any;
|
|
1550
|
+
}
|
|
1551
|
+
interface SAPCardTypeContent {
|
|
1552
|
+
type: 'sap-analytical-card' | 'sap-list-card' | 'sap-object-card' | 'sap-component-card';
|
|
1553
|
+
manifest: any;
|
|
1554
|
+
}
|
|
1555
|
+
interface AgentUICardTypeContent {
|
|
1556
|
+
type: 'error-card' | 'warning-card' | 'suggestions-card' | 'tool-result-card';
|
|
1557
|
+
[key: string]: any;
|
|
1558
|
+
}
|
|
1559
|
+
type ParsedCardData = TableTypeContent | ChartCardTypeContent | SAPCardTypeContent | AgentUICardTypeContent;
|
|
1560
|
+
type AgentUICardType = ParsedCardData['type'];
|
|
1561
|
+
type AgentUICardAction = 'render' | 'close' | 'retry' | 'confirm' | 'action' | 'suggestion-click';
|
|
1562
|
+
interface AgentUICardHookEvent {
|
|
1563
|
+
messageId?: string;
|
|
1564
|
+
cardType: AgentUICardType;
|
|
1565
|
+
action: AgentUICardAction;
|
|
1566
|
+
title?: string;
|
|
1567
|
+
payload?: unknown;
|
|
1568
|
+
rawData?: unknown;
|
|
1569
|
+
}
|
|
1570
|
+
interface AgentUICardHooks {
|
|
1571
|
+
onCardEvent?: (event: AgentUICardHookEvent) => void;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
interface AssistantActionContext {
|
|
1575
|
+
isLatestAssistant: boolean;
|
|
1576
|
+
onRegenerate?: () => Promise<void>;
|
|
1577
|
+
}
|
|
1578
|
+
interface ChatMessageProps {
|
|
1579
|
+
message: ChatMessage;
|
|
1580
|
+
onStreamingComplete?: () => void;
|
|
1581
|
+
assistantActions?: AssistantActionContext;
|
|
1582
|
+
streamIntervalMs?: number;
|
|
1583
|
+
streamChunkSize?: number;
|
|
1584
|
+
cardHooks?: AgentUICardHooks;
|
|
1585
|
+
}
|
|
1586
|
+
interface ChatMessage {
|
|
1587
|
+
id: string;
|
|
1588
|
+
type: 'user' | 'assistant';
|
|
1589
|
+
content: string;
|
|
1590
|
+
timestamp: Date;
|
|
1591
|
+
isStreaming?: boolean;
|
|
1592
|
+
}
|
|
1593
|
+
declare const ChatMessage: React__default.FC<ChatMessageProps>;
|
|
1594
|
+
|
|
1595
|
+
interface StdChatProps {
|
|
1596
|
+
messages: ChatMessage[];
|
|
1597
|
+
onSend: (content: string, files?: File[]) => Promise<void>;
|
|
1598
|
+
onStop?: () => void;
|
|
1599
|
+
onRegenerate?: (messageId: string) => Promise<void>;
|
|
1600
|
+
isResponding?: boolean;
|
|
1601
|
+
className?: string;
|
|
1602
|
+
placeholder?: string;
|
|
1603
|
+
streamIntervalMs?: number;
|
|
1604
|
+
streamChunkSize?: number;
|
|
1605
|
+
onMessageStreamingComplete?: (messageId: string) => void;
|
|
1606
|
+
cardHooks?: AgentUICardHooks;
|
|
1607
|
+
}
|
|
1608
|
+
declare const StdChat: React__default.FC<StdChatProps>;
|
|
1609
|
+
|
|
1610
|
+
interface AgentPanelProps extends StdChatProps {
|
|
1611
|
+
title?: string;
|
|
1612
|
+
description?: string;
|
|
1613
|
+
headerActions?: React__default.ReactNode;
|
|
1614
|
+
}
|
|
1615
|
+
declare const AgentPanel: React__default.FC<AgentPanelProps>;
|
|
1616
|
+
|
|
1617
|
+
type CopilotCorner = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
1618
|
+
interface CopilotChatProps {
|
|
1619
|
+
messages: ChatMessage[];
|
|
1620
|
+
onSend: (content: string, files?: File[]) => Promise<void>;
|
|
1621
|
+
onStop?: () => void;
|
|
1622
|
+
onRegenerate?: (messageId: string) => Promise<void>;
|
|
1623
|
+
isResponding?: boolean;
|
|
1624
|
+
className?: string;
|
|
1625
|
+
placeholder?: string;
|
|
1626
|
+
title?: string;
|
|
1627
|
+
corner?: CopilotCorner;
|
|
1628
|
+
onCollapse?: () => void;
|
|
1629
|
+
onHeaderPointerDown?: (e: React__default.PointerEvent<HTMLDivElement>) => void;
|
|
1630
|
+
onPlusClick?: () => void;
|
|
1631
|
+
onMicClick?: () => void;
|
|
1632
|
+
streamIntervalMs?: number;
|
|
1633
|
+
streamChunkSize?: number;
|
|
1634
|
+
onMessageStreamingComplete?: (messageId: string) => void;
|
|
1635
|
+
cardHooks?: AgentUICardHooks;
|
|
1636
|
+
}
|
|
1637
|
+
declare const CopilotChat: React__default.FC<CopilotChatProps>;
|
|
1638
|
+
|
|
1536
1639
|
interface MarkdownRendererProps {
|
|
1537
1640
|
markdown?: string;
|
|
1538
1641
|
content?: string;
|
|
@@ -1627,4 +1730,4 @@ declare const PAGE_TRANSITION_PRESETS: {
|
|
|
1627
1730
|
};
|
|
1628
1731
|
};
|
|
1629
1732
|
|
|
1630
|
-
export { type AINavContextValue, type AmapEmbedOptions, Button, type ButtonProps, CAINavProvider, type CAINavProviderProps, CAmapChart, type CAmapChartProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, type CAppHeaderUserMenuItem, CAppPageLayout, type CAppPageLayoutProps, CBarChart, type CBarChartProps, CChartCard, type CChartCardProps, CComboChart, type CComboChartProps, CCustomizeAgent, type CCustomizeAgentProps, CDetailInfoPage, type CDetailInfoPageProps, CDetailSearchAiBar, type CDetailSearchAiBarProps, CDetailSectionCard, type CDetailSectionCardProps, CFishboneChart, type CFishboneChartProps, CGoogleMapChart, type CGoogleMapChartProps, CGraphCharts, CGraphKpiCards, CGraphReport, type CGraphReportProps, CHeatmapChart, type CHeatmapChartProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CLineChart, type CLineChartProps, CMessageBox, type CMessageBoxProps, type CMessageBoxType, COrbCanvas, type COrbCanvasProps, CPageLayout, type CPageLayoutProps, CPageTransition, type CPageTransitionProps, CPieChart, type CPieChartProps, CPivotTable, type CPivotTableProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, type CTableQuickCreateConfig, type CTableQuickDeleteConfig, type CTableQuickEditConfig, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, CVoiceWaveOverlay, type CVoiceWaveOverlayProps, CWaterfallChart, type CWaterfallChartProps, CodeBlock, type CodeBlockProps, type CustomizeAgentSavePayload, type CustomizeAgentSettings, type CustomizeAgentTemplateOption, type DateOperator, type DetailInfoAiConfig, type DetailInfoField, type DetailInfoSearchHit, type DetailInfoSearchMode, type DetailInfoSection, type DetailInfoTab, type DetailInfoTableConfig, type FilterField, type FilterOperator, type FilterType, type FilterValue, GlobalMessage, type GoogleMapEmbedOptions, type GraphBarDatum, type GraphComboDatum, type GraphFishboneBranch, type GraphHeatmapDatum, type GraphLineDatum, type GraphMapLocation, type GraphPieDatum, type GraphReportConfig, type GraphReportFieldMapping, type GraphReportInteractionState, type GraphReportKpis, type GraphReportModel, type GraphRow, type GraphTableColumn, type GraphWaterfallDatum, type IVariantService, type LayoutMetadata, MarkdownRenderer, type MarkdownRendererProps, MathBlock, type MathBlockProps, MermaidBlock, type MermaidBlockProps, type MessageContent, type MessageEvent, type MessageOptions, NavigationIsland, type NavigationIslandProps, type NumberOperator, ORBCAFE_I18N_MESSAGES, type OrbcafeI18nContextValue, OrbcafeI18nProvider, type OrbcafeI18nProviderProps, type OrbcafeLocale, type OrbcafeLocaleMessages, type OrbcafeMessageKey, type OrbcafeMessageParams, PAGE_TRANSITION_PRESETS, type PageTransitionVariant, type ParsedMarkdownTable, type PivotAggregation, type PivotFieldDefinition, type PivotFieldType, type PivotFilterSelections, type PivotLayoutConfig, type PivotTableModel, type PivotTablePreset, type PivotValueFieldConfig, type PivotValueFieldState, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, type TableAlign, TableBlock, type TableBlockProps, type TextOperator, ThinkBlock, type ThinkBlockProps, TreeMenu, type TreeMenuItem, type UseAmapEmbedUrlOptions, type UseDetailInfoOptions, type UseDetailInfoResult, type UseGoogleMapEmbedUrlOptions, type UseGraphChartDataOptions, type UseGraphChartDataResult, type UseGraphInteractionResult, type UseGraphReportOptions, type UseGraphReportResult, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UsePivotTableOptions, type UsePivotTableResult, type UseStandardReportOptions, type UseVoiceInputOptions, type UseVoiceInputResult, type VariantMetadata, type VoiceNavigatorContextValue, VoiceNavigatorProvider, type VoiceNavigatorProviderProps, VoiceWaveOverlay, type VoiceWaveOverlayProps, buildAmapEmbedUrl, buildGoogleMapEmbedUrl, buildGoogleMapIframe, buttonVariants, message, messageManager, parseMarkdownTable, renderMarkdown, resolveVariantFilters, resolveVariantLayout, useAINav, useAmapEmbedUrl, useDetailInfo, useGoogleMapEmbedUrl, useGraphChartData, useGraphInteraction, useGraphReport, useNavigationIsland, useOrbcafeI18n, usePageLayout, usePivotTable, useStandardReport, useVoiceInput, useVoiceNavigator };
|
|
1733
|
+
export { type AINavContextValue, AgentPanel, type AgentPanelProps, type AgentUICardAction, type AgentUICardHookEvent, type AgentUICardHooks, type AgentUICardType, type AmapEmbedOptions, Button, type ButtonProps, CAINavProvider, type CAINavProviderProps, CAmapChart, type CAmapChartProps, CAppHeader, type CAppHeaderProps, type CAppHeaderUser, type CAppHeaderUserMenuItem, CAppPageLayout, type CAppPageLayoutProps, CBarChart, type CBarChartProps, CChartCard, type CChartCardProps, CComboChart, type CComboChartProps, CCustomizeAgent, type CCustomizeAgentProps, CDetailInfoPage, type CDetailInfoPageProps, CDetailSearchAiBar, type CDetailSearchAiBarProps, CDetailSectionCard, type CDetailSectionCardProps, CFishboneChart, type CFishboneChartProps, CGoogleMapChart, type CGoogleMapChartProps, CGraphCharts, CGraphKpiCards, CGraphReport, type CGraphReportProps, CHeatmapChart, type CHeatmapChartProps, CLayoutManagement, type CLayoutManagementProps, CLayoutManager, type CLayoutManagerProps, CLineChart, type CLineChartProps, CMessageBox, type CMessageBoxProps, type CMessageBoxType, COrbCanvas, type COrbCanvasProps, CPageLayout, type CPageLayoutProps, CPageTransition, type CPageTransitionProps, CPieChart, type CPieChartProps, CPivotTable, type CPivotTableProps, CSmartFilter, type CSmartFilterProps, CSmartTable, CStandardPage, type CStandardPageProps, CTable, CTableBody, type CTableBodyProps, CTableCell, type CTableCellProps, CTableContainer, type CTableContainerProps, CTableHead, type CTableHeadProps, type CTableProps, type CTableQuickCreateConfig, type CTableQuickDeleteConfig, type CTableQuickEditConfig, CTableRow, type CTableRowProps, CVariantManagement, type CVariantManagementProps, CVariantManager, CVoiceWaveOverlay, type CVoiceWaveOverlayProps, CWaterfallChart, type CWaterfallChartProps, ChatMessage, CodeBlock, type CodeBlockProps, CopilotChat, type CopilotChatProps, type CustomizeAgentSavePayload, type CustomizeAgentSettings, type CustomizeAgentTemplateOption, type DateOperator, type DetailInfoAiConfig, type DetailInfoField, type DetailInfoSearchHit, type DetailInfoSearchMode, type DetailInfoSection, type DetailInfoTab, type DetailInfoTableConfig, type FilterField, type FilterOperator, type FilterType, type FilterValue, GlobalMessage, type GoogleMapEmbedOptions, type GraphBarDatum, type GraphComboDatum, type GraphFishboneBranch, type GraphHeatmapDatum, type GraphLineDatum, type GraphMapLocation, type GraphPieDatum, type GraphReportConfig, type GraphReportFieldMapping, type GraphReportInteractionState, type GraphReportKpis, type GraphReportModel, type GraphRow, type GraphTableColumn, type GraphWaterfallDatum, type IVariantService, type LayoutMetadata, MarkdownRenderer, type MarkdownRendererProps, MathBlock, type MathBlockProps, MermaidBlock, type MermaidBlockProps, type MessageContent, type MessageEvent, type MessageOptions, NavigationIsland, type NavigationIslandProps, type NumberOperator, ORBCAFE_I18N_MESSAGES, type OrbcafeI18nContextValue, OrbcafeI18nProvider, type OrbcafeI18nProviderProps, type OrbcafeLocale, type OrbcafeLocaleMessages, type OrbcafeMessageKey, type OrbcafeMessageParams, PAGE_TRANSITION_PRESETS, type PageTransitionVariant, type ParsedMarkdownTable, type PivotAggregation, type PivotFieldDefinition, type PivotFieldType, type PivotFilterSelections, type PivotLayoutConfig, type PivotTableModel, type PivotTablePreset, type PivotValueFieldConfig, type PivotValueFieldState, type ReportColumn, type ReportFilter, type ReportMetadata, type SelectOperator, StdChat, type StdChatProps, type TableAlign, TableBlock, type TableBlockProps, type TextOperator, ThinkBlock, type ThinkBlockProps, TreeMenu, type TreeMenuItem, type UseAmapEmbedUrlOptions, type UseDetailInfoOptions, type UseDetailInfoResult, type UseGoogleMapEmbedUrlOptions, type UseGraphChartDataOptions, type UseGraphChartDataResult, type UseGraphInteractionResult, type UseGraphReportOptions, type UseGraphReportResult, type UseNavigationIslandOptions, type UseNavigationIslandResult, type UsePageLayoutOptions, type UsePivotTableOptions, type UsePivotTableResult, type UseStandardReportOptions, type UseVoiceInputOptions, type UseVoiceInputResult, type VariantMetadata, type VoiceNavigatorContextValue, VoiceNavigatorProvider, type VoiceNavigatorProviderProps, VoiceWaveOverlay, type VoiceWaveOverlayProps, buildAmapEmbedUrl, buildGoogleMapEmbedUrl, buildGoogleMapIframe, buttonVariants, message, messageManager, parseMarkdownTable, renderMarkdown, resolveVariantFilters, resolveVariantLayout, useAINav, useAmapEmbedUrl, useDetailInfo, useGoogleMapEmbedUrl, useGraphChartData, useGraphInteraction, useGraphReport, useNavigationIsland, useOrbcafeI18n, usePageLayout, usePivotTable, useStandardReport, useVoiceInput, useVoiceNavigator };
|