@bluemarble/bi 0.4.0 → 0.6.0

package/dist/{types-HXAn-3I1.d.ts → layout-B7eYgNyR.d.ts}

@@ -119,6 +119,183 @@ declare function modelMeta(model: ModelDef): ModelMeta;
  */
 declare function validateModel(model: ModelDef): string[];
 //#endregion
+//#region src/types.d.ts
+type FilterValue = string | number;
+/** Filtros por dimensão; lista vazia (ou ausente) = sem filtro ("Todos"). */
+type DashboardFilters = Record<string, FilterValue[]>;
+/**
+ * Pedidos do devtools. O servidor só aceita quando o `runQuery` recebe `devtools` (em dev); fora
+ * disso `debug` é ignorado e o resto é recusado com 400.
+ */
+type DashboardDevtoolsRequest = {
+  /** Devolve SQL compilado, parâmetros e tempos em `result.devtools.debug`. */
+  debug?: boolean;
+  /** Rascunho do modelo editado no devtools: substitui o modelo registrado só nesta consulta. */
+  model?: ModelDef;
+  /** Devolve a definição do modelo registrado e o que o servidor permite (`capabilities`). */
+  describe?: boolean;
+  /** Esvazia o cache de resultados do processo antes de executar. */
+  clearCache?: boolean;
+  /**
+   * Só compila: devolve o SQL e os parâmetros em `result.devtools.debug`, sem executar (o devtools
+   * usa para mostrar o SQL de uma consulta que deu erro).
+   */
+  compile?: boolean;
+  /** Devolve o `EXPLAIN` da consulta em vez das linhas. */
+  explain?: boolean;
+  /** Mede a agregação de cada fato usada pela consulta, isoladamente. */
+  profile?: boolean;
+  /** Tabelas e colunas do banco (`information_schema`), para o autocomplete do editor. */
+  schema?: boolean;
+  /** Colunas de cada tabela (uma linha de cada), para o diagrama do modelo. */
+  columns?: boolean;
+  /** Executa cada pedaço do modelo (`devtools.model` ou o registrado) contra o banco. */
+  validate?: boolean;
+  /** Grava o rascunho no arquivo do modelo (`preview` só devolve o conteúdo novo). */
+  save?: 'preview' | 'write';
+  /** Grava o layout de gráficos em `<layoutsDir>/<id>.json` (`preview` só devolve o conteúdo novo). */
+  saveLayout?: {
+    layout: ChartsLayout;
+    mode: 'preview' | 'write';
+  };
+  /** Grava o resultado da consulta (modelo registrado) como snapshot de regressão. */
+  snapshot?: {
+    name: string;
+    overwrite?: boolean;
+  };
+  /** Lista os snapshots salvos deste modelo. */
+  snapshots?: boolean;
+};
+type DashboardQuery = {
+  model: string;
+  /** Dimensões agrupadas (viram GROUP BY). */
+  dimensions?: string[];
+  /** Medidas calculadas para cada grupo. */
+  measures?: string[];
+  filters?: DashboardFilters;
+  /** Devolve só os metadados do modelo (rótulos, descrições, formatos; sem SQL) em `result.meta`. */
+  meta?: boolean;
+  devtools?: DashboardDevtoolsRequest;
+};
+type DashboardRow = Record<string, string | number | null>;
+type DashboardQueryDebug = {
+  sql: string;
+  params: (string | number)[];
+  /** Tempo da execução no banco (num cache hit, o da execução original). */
+  durationMs: number;
+  cached: boolean;
+  /** A consulta rodou contra o rascunho do devtools, não contra o modelo registrado. */
+  draft: boolean;
+};
+type ProfileStep = {
+  /** `fato:<tabela>` ou `consulta` (a consulta inteira). */
+  name: string;
+  durationMs: number;
+  /** Linhas da agregação da fato (grupos) com os filtros aplicados. */
+  rows: number | null;
+};
+type SchemaTable = {
+  name: string;
+  type: 'table' | 'view';
+  columns: {
+    name: string;
+    type: string;
+  }[];
+};
+/** Colunas devolvidas por cada pedaço do modelo (vazio quando não veio nenhuma linha). */
+type ModelColumns = {
+  /** Colunas de cada tabela. */
+  tables: Record<string, string[]>;
+  /** `tabela.coluna` com valor numérico na linha lida. */
+  numeric: string[];
+};
+type ModelValidation = {
+  /**
+   * Erro do banco por pedaço: `table:<nome>`, `relationship:<índice>`, `dimension:<nome>`,
+   * `measure:<nome>`.
+   */
+  errors: Record<string, string>;
+  warnings: Record<string, string>;
+  columns: ModelColumns;
+};
+type SaveModelResult = {
+  path: string;
+  previous: string;
+  content: string;
+  written: boolean;
+  warnings: string[];
+};
+type DashboardSnapshot = {
+  name: string;
+  createdAt: string;
+  query: Omit<DashboardQuery, 'devtools' | 'meta'>;
+  rows: DashboardRow[];
+};
+type DevtoolsCapabilities = {
+  /** O endpoint sabe onde ficam os arquivos dos modelos (`modelsDir`). */
+  saveModel: boolean;
+  /** O endpoint sabe onde gravar snapshots (`snapshotsDir`). */
+  snapshots: boolean;
+  /** O endpoint sabe onde ficam os arquivos de layout de gráficos (`layoutsDir`). */
+  saveLayout: boolean;
+  /** Tipos de gráfico do app que o endpoint conhece (`chartTypes`): só esses ele aceita salvar. */
+  chartTypes: string[];
+};
+type DashboardResult = {
+  rows: DashboardRow[];
+  meta?: ModelMeta;
+  devtools?: {
+    model?: ModelDef;
+    capabilities?: DevtoolsCapabilities;
+    debug?: DashboardQueryDebug;
+    explain?: DashboardRow[];
+    profile?: ProfileStep[];
+    schema?: SchemaTable[];
+    validation?: ModelValidation;
+    columns?: ModelColumns;
+    /** Pedaços que o banco recusou ao ler as colunas (mesmas chaves da validação). */
+    columnErrors?: Record<string, string>;
+    save?: SaveModelResult;
+    snapshot?: {
+      path: string;
+    };
+    snapshots?: DashboardSnapshot[];
+  };
+};
+//#endregion
+//#region src/formatRules.d.ts
+declare const COLUMN_ALIGNS: readonly ['left', 'center', 'right'];
+type ColumnAlign = (typeof COLUMN_ALIGNS)[number];
+declare const COLUMN_VERTICAL_ALIGNS: readonly ['top', 'middle', 'bottom'];
+type ColumnVerticalAlign = (typeof COLUMN_VERTICAL_ALIGNS)[number];
+declare const RULE_OPERATORS: readonly ['>', '>=', '<', '<=', '=', '!=', 'between', 'contains', 'empty', 'notEmpty'];
+type RuleOperator = (typeof RULE_OPERATORS)[number];
+type FormatRule = {
+  /**
+   * Dimensão ou medida avaliada. Pode estar fora da tabela: entra na consulta sem coluna (uma
+   * dimensão de fora divide as linhas se tiver mais de um valor por linha).
+   */
+  field: string;
+  operator: RuleOperator;
+  /** Valor comparado com o valor bruto (percentual como fração: 10% = 0.1). */
+  value?: number | string;
+  /** Fim do intervalo do `between` (inclusivo, como o `value`). */
+  to?: number;
+  /** `cell` (padrão) pinta uma célula; `row`, a linha inteira. */
+  target?: 'cell' | 'row';
+  /** Coluna pintada quando `target` é `cell`. Padrão: o próprio `field`. */
+  column?: string;
+  /** Cor do texto. */
+  color?: string;
+  /** Cor de fundo. */
+  background?: string;
+  bold?: boolean;
+  /** Alinhamento horizontal da célula (ou das células da linha). */
+  align?: ColumnAlign;
+  /** Alinhamento vertical da célula (ou das células da linha). */
+  verticalAlign?: ColumnVerticalAlign;
+};
+//#endregion
 //#region src/layout.d.ts
 declare const CHART_TYPES: readonly ['kpi', 'combo', 'bar', 'donut', 'table'];
 type ChartType = (typeof CHART_TYPES)[number];
@@ -206,14 +383,36 @@ type TableChartDef = BaseChartDef & ColumnsDisplay & {
   percentOf?: string[];
   /** Casas decimais das colunas de percentual. Padrão: 1. */
   percentDecimals?: number;
+  /**
+   * Ordem das colunas misturando dimensões, medidas e percentuais (`%:medida`), ex.: uma medida
+   * antes de uma dimensão. Ausente = dimensões e depois medidas; percentual fora da ordem vem logo
+   * depois da medida dele (ou no fim, se a medida não é coluna).
+   */
+  columnOrder?: string[];
   /** Formatter por dimensão (`{ mes: 'nomeMes' }`). */
   formatDimensions?: Record<string, string>;
   /** Linha de total, consultada sem as dimensões (razões saem certas, não somadas). */
   showTotal?: boolean;
-  /** Coluna (dimensão ou medida) da ordem inicial; o usuário reordena clicando no cabeçalho. */
+  /**
+   * Dimensão ou medida da ordem inicial; o usuário reordena clicando no cabeçalho. Pode estar fora
+   * da tabela (ex.: número do mês para ordenar o nome do mês): entra na consulta sem coluna.
+   */
   sortBy?: string;
   sortDirection?: 'asc' | 'desc';
   clickToFilter?: boolean;
+  /** Formatação condicional: cor do texto/fundo da célula ou da linha conforme uma regra. */
+  formatRules?: FormatRule[];
+  /** Bordas entre as células (grade). Padrão: só a linha embaixo de cada linha. */
+  cellBorders?: boolean;
+  /** Cor das bordas da grade. */
+  borderColor?: string;
+  /**
+   * Alinhamento horizontal por coluna (`{ coluna: 'center' }`, `%:medida` para o percentual), no
+   * cabeçalho, nas células e no total. Padrão: dimensão à esquerda, número à direita.
+   */
+  align?: Record<string, ColumnAlign>;
+  /** Alinhamento vertical por coluna (`top`, `middle`, `bottom`). Padrão: `middle`. */
+  verticalAlign?: Record<string, ColumnVerticalAlign>;
 };
 type KpiChartDef = Omit<BaseChartDef, 'height'> & ColumnsDisplay & {
   type: 'kpi';
@@ -287,7 +486,7 @@ type FieldSpec = {
   label: string;
   hint?: string;
   /** Agrupamento no formulário do devtools. */
-  section: 'Gráfico' | 'Dados' | 'Aparência' | 'Rótulos e formatos' | 'Filtro' | 'Tela' | 'Card';
+  section: 'Gráfico' | 'Dados' | 'Aparência' | 'Rótulos e formatos' | 'Formatação condicional' | 'Filtro' | 'Tela' | 'Card';
   required?: boolean;
   /** Valor que o componente usa quando o campo não está no JSON. */
   default?: unknown;
@@ -310,7 +509,15 @@ type FieldSpec = {
 {
   kind: 'dimension' | 'measure';
 } | {
-  kind: 'dimensions' | 'measures';
+  kind: 'dimensions';
+} |
+/**
+ * `percent`: cada medida vira uma coluna de % do total (`%:medida`), que entra no `columnOrder`
+ * como as outras colunas.
+ */
+{
+  kind: 'measures';
+  percent?: boolean;
 } |
 /** Nome de um formatter do `<DashboardCharts formatters>`. */
 {
@@ -320,9 +527,13 @@ type FieldSpec = {
 {
   kind: 'formatters';
 } |
-/** Uma das dimensões/medidas escolhidas no próprio gráfico. */
+/**
+ * Uma das dimensões/medidas escolhidas no próprio gráfico. `outside`: também qualquer dimensão ou
+ * medida do modelo (o componente consulta o que estiver fora do gráfico, sem mostrar).
+ */
 {
   kind: 'column';
+  outside?: boolean;
 } |
 /** `{ dimensãoOuMedida: rótulo }` das colunas do gráfico. */
 {
@@ -331,6 +542,25 @@ type FieldSpec = {
 /** `{ medida: ChartNumberFormat }` das medidas do gráfico. */
 {
   kind: 'formats';
+} |
+/** `{ coluna: 'left' | 'center' | 'right' }`: alinhamento horizontal de cada coluna. */
+{
+  kind: 'aligns';
+} |
+/** `{ coluna: 'top' | 'middle' | 'bottom' }`: alinhamento vertical de cada coluna. */
+{
+  kind: 'verticalAligns';
+} |
+/**
+ * Ordem das colunas (dimensões e medidas misturadas). O devtools junta os campos `dimensions` e
+ * `measures` da mesma seção numa lista só e grava a ordem aqui quando não é a padrão.
+ */
+{
+  kind: 'columnOrder';
+} |
+/** Regras de formatação condicional (`FormatRule[]`). */
+{
+  kind: 'formatRules';
 });
 /**
  * Tipo de gráfico: nome no devtools e campos do JSON. Para um tipo do app, `title`, `span` e
@@ -375,149 +605,5 @@ declare function validateLayout(layout: ChartsLayout, types?: ChartTypes): strin
  */
 declare function layoutModelWarnings(layout: ChartsLayout, model: Pick<ModelDef, 'dimensions' | 'measures'>, types?: ChartTypes): string[];
 //#endregion
-//#region src/types.d.ts
-type FilterValue = string | number;
-/** Filtros por dimensão; lista vazia (ou ausente) = sem filtro ("Todos"). */
-type DashboardFilters = Record<string, FilterValue[]>;
-/**
- * Pedidos do devtools. O servidor só aceita quando o `runQuery` recebe `devtools` (em dev); fora
- * disso `debug` é ignorado e o resto é recusado com 400.
- */
-type DashboardDevtoolsRequest = {
-  /** Devolve SQL compilado, parâmetros e tempos em `result.devtools.debug`. */
-  debug?: boolean;
-  /** Rascunho do modelo editado no devtools: substitui o modelo registrado só nesta consulta. */
-  model?: ModelDef;
-  /** Devolve a definição do modelo registrado e o que o servidor permite (`capabilities`). */
-  describe?: boolean;
-  /** Esvazia o cache de resultados do processo antes de executar. */
-  clearCache?: boolean;
-  /**
-   * Só compila: devolve o SQL e os parâmetros em `result.devtools.debug`, sem executar (o devtools
-   * usa para mostrar o SQL de uma consulta que deu erro).
-   */
-  compile?: boolean;
-  /** Devolve o `EXPLAIN` da consulta em vez das linhas. */
-  explain?: boolean;
-  /** Mede a agregação de cada fato usada pela consulta, isoladamente. */
-  profile?: boolean;
-  /** Tabelas e colunas do banco (`information_schema`), para o autocomplete do editor. */
-  schema?: boolean;
-  /** Colunas de cada tabela (uma linha de cada), para o diagrama do modelo. */
-  columns?: boolean;
-  /** Executa cada pedaço do modelo (`devtools.model` ou o registrado) contra o banco. */
-  validate?: boolean;
-  /** Grava o rascunho no arquivo do modelo (`preview` só devolve o conteúdo novo). */
-  save?: 'preview' | 'write';
-  /** Grava o layout de gráficos em `<layoutsDir>/<id>.json` (`preview` só devolve o conteúdo novo). */
-  saveLayout?: {
-    layout: ChartsLayout;
-    mode: 'preview' | 'write';
-  };
-  /** Grava o resultado da consulta (modelo registrado) como snapshot de regressão. */
-  snapshot?: {
-    name: string;
-    overwrite?: boolean;
-  };
-  /** Lista os snapshots salvos deste modelo. */
-  snapshots?: boolean;
-};
-type DashboardQuery = {
-  model: string;
-  /** Dimensões agrupadas (viram GROUP BY). */
-  dimensions?: string[];
-  /** Medidas calculadas para cada grupo. */
-  measures?: string[];
-  filters?: DashboardFilters;
-  /** Devolve só os metadados do modelo (rótulos, descrições, formatos; sem SQL) em `result.meta`. */
-  meta?: boolean;
-  devtools?: DashboardDevtoolsRequest;
-};
-type DashboardRow = Record<string, string | number | null>;
-type DashboardQueryDebug = {
-  sql: string;
-  params: (string | number)[];
-  /** Tempo da execução no banco (num cache hit, o da execução original). */
-  durationMs: number;
-  cached: boolean;
-  /** A consulta rodou contra o rascunho do devtools, não contra o modelo registrado. */
-  draft: boolean;
-};
-type ProfileStep = {
-  /** `fato:<tabela>` ou `consulta` (a consulta inteira). */
-  name: string;
-  durationMs: number;
-  /** Linhas da agregação da fato (grupos) com os filtros aplicados. */
-  rows: number | null;
-};
-type SchemaTable = {
-  name: string;
-  type: 'table' | 'view';
-  columns: {
-    name: string;
-    type: string;
-  }[];
-};
-/** Colunas devolvidas por cada pedaço do modelo (vazio quando não veio nenhuma linha). */
-type ModelColumns = {
-  /** Colunas de cada tabela. */
-  tables: Record<string, string[]>;
-  /** `tabela.coluna` com valor numérico na linha lida. */
-  numeric: string[];
-};
-type ModelValidation = {
-  /**
-   * Erro do banco por pedaço: `table:<nome>`, `relationship:<índice>`, `dimension:<nome>`,
-   * `measure:<nome>`.
-   */
-  errors: Record<string, string>;
-  warnings: Record<string, string>;
-  columns: ModelColumns;
-};
-type SaveModelResult = {
-  path: string;
-  previous: string;
-  content: string;
-  written: boolean;
-  warnings: string[];
-};
-type DashboardSnapshot = {
-  name: string;
-  createdAt: string;
-  query: Omit<DashboardQuery, 'devtools' | 'meta'>;
-  rows: DashboardRow[];
-};
-type DevtoolsCapabilities = {
-  /** O endpoint sabe onde ficam os arquivos dos modelos (`modelsDir`). */
-  saveModel: boolean;
-  /** O endpoint sabe onde gravar snapshots (`snapshotsDir`). */
-  snapshots: boolean;
-  /** O endpoint sabe onde ficam os arquivos de layout de gráficos (`layoutsDir`). */
-  saveLayout: boolean;
-  /** Tipos de gráfico do app que o endpoint conhece (`chartTypes`): só esses ele aceita salvar. */
-  chartTypes: string[];
-};
-type DashboardResult = {
-  rows: DashboardRow[];
-  meta?: ModelMeta;
-  devtools?: {
-    model?: ModelDef;
-    capabilities?: DevtoolsCapabilities;
-    debug?: DashboardQueryDebug;
-    explain?: DashboardRow[];
-    profile?: ProfileStep[];
-    schema?: SchemaTable[];
-    validation?: ModelValidation;
-    columns?: ModelColumns;
-    /** Pedaços que o banco recusou ao ler as colunas (mesmas chaves da validação). */
-    columnErrors?: Record<string, string>;
-    save?: SaveModelResult;
-    snapshot?: {
-      path: string;
-    };
-    snapshots?: DashboardSnapshot[];
-  };
-};
-//#endregion
-export { FilterDef as A, FormulaMeasure as B, ChartTypeSpec as C, CustomChartDef as D, ComboChartDef as E, validateLayout as F, RatioMeasure as G, MeasureMeta as H, AggregateMeasure as I, TableDef as J, RelationshipDef as K, Aggregation as L, TableChartDef as M, layoutModelWarnings as N, DonutChartDef as O, resolveChartTypes as P, DimensionDef as R, ChartType as S, ChartsLayout as T, ModelDef as U, MeasureDef as V, ModelMeta as W, modelMeta as X, ValueFormat as Y, validateModel as Z, CanvasDef as _, DashboardResult as a, ChartDef as b, DevtoolsCapabilities as c, ModelValidation as d, ProfileStep as f, BuiltinChartDef as g, BarChartDef as h, DashboardQueryDebug as i, KpiChartDef as j, FieldSpec as k, FilterValue as l, SchemaTable as m, DashboardFilters as n, DashboardRow as o, SaveModelResult as p, SumMeasure as q, DashboardQuery as r, DashboardSnapshot as s, DashboardDevtoolsRequest as t, ModelColumns as u, CardStyle as v, ChartTypes as w, ChartNumberFormat as x, CardsStyle as y, FieldMeta as z };
-//# sourceMappingURL=types-HXAn-3I1.d.ts.map
+export { modelMeta as $, DashboardRow as A, Aggregation as B, ColumnVerticalAlign as C, DashboardQuery as D, DashboardFilters as E, ModelValidation as F, MeasureMeta as G, FieldMeta as H, ProfileStep as I, RatioMeasure as J, ModelDef as K, SaveModelResult as L, DevtoolsCapabilities as M, FilterValue as N, DashboardQueryDebug as O, ModelColumns as P, ValueFormat as Q, SchemaTable as R, ColumnAlign as S, DashboardDevtoolsRequest as T, FormulaMeasure as U, DimensionDef as V, MeasureDef as W, SumMeasure as X, RelationshipDef as Y, TableDef as Z, KpiChartDef as _, CardsStyle as a, resolveChartTypes as b, ChartType as c, ChartsLayout as d, validateModel as et, ComboChartDef as f, FilterDef as g, FieldSpec as h, CardStyle as i, DashboardSnapshot as j, DashboardResult as k, ChartTypeSpec as l, DonutChartDef as m, BuiltinChartDef as n, ChartDef as o, CustomChartDef as p, ModelMeta as q, CanvasDef as r, ChartNumberFormat as s, BarChartDef as t, ChartTypes as u, TableChartDef as v, FormatRule as w, validateLayout as x, layoutModelWarnings as y, AggregateMeasure as z };
+//# sourceMappingURL=layout-B7eYgNyR.d.ts.map