@hachej/boring-bi-dashboard 0.1.60
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/LICENSE +21 -0
- package/README.md +83 -0
- package/dist/front/index.d.ts +28 -0
- package/dist/front/index.js +831 -0
- package/dist/shared/index.d.ts +16 -0
- package/dist/shared/index.js +131 -0
- package/dist/types-BGZKL9Rs.d.ts +146 -0
- package/docs/issues/bi-dashboard-plugin/README.md +349 -0
- package/docs/issues/bi-dashboard-plugin/data-access-unification.md +638 -0
- package/docs/issues/bi-dashboard-plugin/data-bridge.md +425 -0
- package/example/.gitignore +16 -0
- package/example/.pi/extensions/bi-dashboard/front/index.ts +1 -0
- package/example/.pi/extensions/bi-dashboard/package.json +11 -0
- package/example/README.md +10 -0
- package/example/dashboards/people.dashboard.json +178 -0
- package/example/data/people.csv +13 -0
- package/example/eval/bi-dashboard.yaml +31 -0
- package/package.json +85 -0
- package/playground/README.md +25 -0
- package/playground/run-eval.ts +100 -0
- package/playground/smoke-dashboard.ts +101 -0
- package/skills/bi-dashboard-authoring/SKILL.md +78 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 boringdata
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# @hachej/boring-bi-dashboard
|
|
2
|
+
|
|
3
|
+
BI dashboard plugin primitives for Boring workspace.
|
|
4
|
+
|
|
5
|
+
This package is the host-side home for the BSL dashboard UX:
|
|
6
|
+
|
|
7
|
+
- prompt/agent output should target a neutral `boring.generated-pane` JSON contract with `profile: "bi-dashboard"`
|
|
8
|
+
- the plugin renders approved dashboard components in boring-ui
|
|
9
|
+
- BSL owns semantic queries and artifacts
|
|
10
|
+
- the plugin maps components to ECharts/Perspective/json-render runtimes
|
|
11
|
+
|
|
12
|
+
Current scope is an initial plugin shell and typed dashboard contract. The actual BSL server bridge, Perspective viewer runtime, ECharts runtime, and json-render adapter should be layered behind the same component schema.
|
|
13
|
+
|
|
14
|
+
## Panel
|
|
15
|
+
|
|
16
|
+
The plugin registers:
|
|
17
|
+
|
|
18
|
+
- panel: `bi-dashboard.panel`
|
|
19
|
+
- command: `bi-dashboard.open`
|
|
20
|
+
|
|
21
|
+
## Dashboard contract
|
|
22
|
+
|
|
23
|
+
Agents should generate specs shaped like:
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"kind": "boring.generated-pane",
|
|
28
|
+
"profile": "bi-dashboard",
|
|
29
|
+
"version": 1,
|
|
30
|
+
"title": "Revenue Overview",
|
|
31
|
+
"queries": {
|
|
32
|
+
"revenue_by_month": {
|
|
33
|
+
"id": "revenue_by_month",
|
|
34
|
+
"model": "orders",
|
|
35
|
+
"query": "sm.group_by(\"month\").aggregate(\"revenue\").order_by(\"month\")"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"root": "dashboard",
|
|
39
|
+
"elements": {
|
|
40
|
+
"dashboard": {
|
|
41
|
+
"type": "DashboardGrid",
|
|
42
|
+
"props": { "columns": 12 },
|
|
43
|
+
"children": ["revenue-line"]
|
|
44
|
+
},
|
|
45
|
+
"revenue-line": {
|
|
46
|
+
"type": "BSLChart",
|
|
47
|
+
"props": {
|
|
48
|
+
"queryId": "revenue_by_month",
|
|
49
|
+
"renderer": "echarts",
|
|
50
|
+
"chartType": "line",
|
|
51
|
+
"x": "month",
|
|
52
|
+
"y": "revenue"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Example and playground
|
|
60
|
+
|
|
61
|
+
Example workspace fixtures live in `example/`:
|
|
62
|
+
|
|
63
|
+
- `example/data/people.csv`
|
|
64
|
+
- `example/dashboards/people.dashboard.json`
|
|
65
|
+
- `example/eval/bi-dashboard.yaml`
|
|
66
|
+
|
|
67
|
+
Run the plugin through the existing workspace playground without making it a default playground plugin:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
BORING_EXTERNAL_PLUGINS=1 \
|
|
71
|
+
BORING_AGENT_WORKSPACE_ROOT="$PWD/plugins/bi-dashboard/example" \
|
|
72
|
+
pnpm --filter workspace-playground dev
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Run the authoring eval through the plugin-local playground runner:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
pnpm --filter @hachej/boring-bi-dashboard playground:eval
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
The runner checks that the agent writes a dashboard file and validates the generated JSON with `parseDashboardSpec`.
|
|
82
|
+
|
|
83
|
+
See `playground/README.md` for full playground commands.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import * as _hachej_boring_workspace_plugin from '@hachej/boring-workspace/plugin';
|
|
2
|
+
import { PaneProps, BoringFrontSurfaceResolverRegistration } from '@hachej/boring-workspace/plugin';
|
|
3
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
+
import { B as BslDashboardSpec } from '../types-BGZKL9Rs.js';
|
|
5
|
+
export { a as BslChartSpec, b as BslDashboardComponentSpec, c as BslDashboardQuerySpec, d as BslPerspectiveViewerSpec } from '../types-BGZKL9Rs.js';
|
|
6
|
+
import '@hachej/boring-generated-pane/shared';
|
|
7
|
+
import 'zod';
|
|
8
|
+
|
|
9
|
+
interface BiDashboardPaneParams {
|
|
10
|
+
path?: string;
|
|
11
|
+
spec?: BslDashboardSpec;
|
|
12
|
+
}
|
|
13
|
+
declare function BiDashboardPane({ params }: PaneProps<BiDashboardPaneParams>): react_jsx_runtime.JSX.Element;
|
|
14
|
+
|
|
15
|
+
declare const sampleBiDashboardSpec: BslDashboardSpec;
|
|
16
|
+
|
|
17
|
+
declare const BI_DASHBOARD_PANEL_ID = "bi-dashboard.panel";
|
|
18
|
+
declare const BI_DASHBOARD_LEFT_TAB_ID = "bi-dashboard.dashboards";
|
|
19
|
+
|
|
20
|
+
declare function DashboardFilesPane({ params, containerApi }: PaneProps<{
|
|
21
|
+
searchQuery?: string;
|
|
22
|
+
}>): react_jsx_runtime.JSX.Element;
|
|
23
|
+
|
|
24
|
+
declare const biDashboardSurfaceResolver: BoringFrontSurfaceResolverRegistration;
|
|
25
|
+
|
|
26
|
+
declare const biDashboardPlugin: _hachej_boring_workspace_plugin.BoringFrontFactoryWithId;
|
|
27
|
+
|
|
28
|
+
export { BI_DASHBOARD_LEFT_TAB_ID, BI_DASHBOARD_PANEL_ID, BiDashboardPane, type BiDashboardPaneParams, BslDashboardSpec, DashboardFilesPane, biDashboardPlugin, biDashboardSurfaceResolver, biDashboardPlugin as default, sampleBiDashboardSpec };
|