@bluemarble/bi

中文文档
0.9.6发布于 2026/11/07MITTypeScriptES Module零依赖近 30 天下载 3428

Camada semântica (defineModel) + componentes de dashboard e devtools para substituir o Power BI

原始使用文档
文档目录4 节
  1. Desenvolvimento
  2. Playground
  3. Testar no app antes de publicar
  4. Publicar

bm-bi (@bluemarble/bi)

Camada semântica para dashboards em React, no lugar do Power BI: o modelo (tabelas, relacionamentos, dimensões e medidas) é um objeto TS (defineModel), o servidor compila as consultas para SQL (MySQL/MariaDB) e os componentes de filtro e gráfico consultam o modelo pelo nome. Vem com um devtools (diagrama do modelo, editor de layout, playground, regressão).

import { defineModel, formula, sum } from '@bluemarble/bi/server'

export const vendas = defineModel({
  name: 'vendas',
  tables: {
    pedidos: { key: 'id', sql: 'SELECT id, loja, criado_em FROM pedidos' },
    itens: { sql: 'SELECT pedido_id, valor FROM itens' }
  },
  relationships: [{ from: 'itens.pedido_id', to: 'pedidos.id' }],
  dimensions: { loja: { sql: 'pedidos.loja', type: 'string' } },
  measures: { valor: sum('itens.valor', { format: 'currency' }) }
})
ImportOnde roda
@bluemarble/bi/serversó no servidor
@bluemarble/bi/clientbrowser
@bluemarble/bi/typesambos
npm install @bluemarble/bi   # peer: react 19, @mui/material 7, recharts 3

Publicado no npm já compilado (dist/, ESM + .d.ts), sem precisar de transpilePackages. Conceitos, API, devtools e configuração do app estão em docs/dashboard-substituicao-powerbi.md.

Desenvolvimento

Projeto Vite+ com bun.

vp install        # dependências
vp test           # testes (vitest, sem banco)
vp run typecheck  # tsc
vp check          # formatação (oxfmt) + lint (oxlint)
vp run playground # dashboard + devtools em http://localhost:5180 (precisa do .env)

Playground

playground/ é uma página Vite com o dashboard e o devtools ligados direto ao src/ (sem passar pelo app). O endpoint /api/dashboard/query roda no próprio servidor do Vite e consulta o MySQL do DATABASE_URL do .env na raiz (modelo em .env.example; o .env não é versionado).

  • playground/models/ — modelos (defineModel), registrados em models/index.ts;
  • playground/layouts/ — layouts JSON dos gráficos/filtros;
  • playground/dashboards.ts — lista do seletor no topo (modelo + layout + filtros iniciais) e formatters.

O "Salvar no arquivo" do devtools grava nessas pastas (formatando com vp fmt) e os snapshots vão para playground/snapshots/. Mudanças em modelos valem na consulta seguinte, sem reiniciar.

Testar no app antes de publicar

Para usar a versão local num app (ex.: o custo do rocha-pr), aponte a dependência para esta pasta ("@bluemarble/bi": "file:../../../bm-bi" + npm install) e deixe vp run dev rodando (vp pack --watch): o app lê o dist/. Com o link, o Next precisa de turbopack.root e turbopack.resolveAlias — o next.config.js do custo liga isso sozinho quando detecta o link.

Publicar

vp run verify     # o mesmo que o CI roda: check, typecheck, testes e build
vp run release    # bumpp: escolhe a versão, commita, cria a tag vX.Y.Z e faz push

A tag dispara .github/workflows/publish.yml, que confere tag x package.json, roda o verify e publica com bun publish (secret NPM_TOKEN). Depois, no app: npm install @bluemarble/[email protected].

版本与发布记录

@bluemarble/bi 共发布 33 个版本,首次发布于 2026/10/14;过去 12 个月发布了 33 个版本。

版本发布日期距今
0.9.6latest2026/11/071 天前
0.9.52026/11/071 天前
0.9.32026/11/043 天前
0.9.42026/11/043 天前
0.9.22026/11/044 天前
0.9.12026/10/308 天前

关于 @bluemarble/bi 的常见问题

@bluemarble/bi 是什么?

Camada semântica (defineModel) + componentes de dashboard e devtools para substituir o Power BI

如何安装 @bluemarble/bi?

在项目目录运行 npm install @bluemarble/bi,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19)、recharts(^3)、react-dom(^19)、@mui/material(^7)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 bm-bi,可以用 npx bm-bi 直接运行。

@bluemarble/bi 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@bluemarble/bi 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@bluemarble/bi 可以商用吗?

@bluemarble/bi 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@bluemarble/bi 的下载量有多少?

根据 npm 官方下载统计,@bluemarble/bi 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,428 次,日均约 114 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@bluemarble/bi 还在维护吗?

最新版本 0.9.6 发布于 2026/11/07(1 天前);至今共发布 33 个版本,其中过去 12 个月发布了 33 个;首次发布于 2026/10/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。