drizzle-cube 0.9.0 → 0.9.2

package/dist/client/components/charts/MarkdownChart.helpers.d.ts

@@ -0,0 +1,156 @@
+import { CSSProperties } from 'react';
+import { CubeQuery } from '../../types.js';
+import { MarkdownTemplateDiagnostic } from './markdownTemplate.js';
+/** Body text size class for a fontSize setting. */
+export declare function bodySizeClass(fontSize: string): string;
+/** Text alignment class for an alignment setting. */
+export declare function alignmentClass(alignment: string): string;
+/**
+ * markdown-to-jsx options for the chart's themed elements.
+ *
+ * The `sanitizer` is markdown-to-jsx's own, named rather than left implicit:
+ * template output can carry warehouse values into link and image destinations,
+ * so the protocol policy should be visible in our code.
+ */
+export declare function buildMarkdownOptions(accentColor: string, fontSize: string): {
+    sanitizer: (value: string) => string | null;
+    overrides: {
+        h1: {
+            props: {
+                className: string;
+                style: {
+                    color: string;
+                };
+            };
+        };
+        h2: {
+            props: {
+                className: string;
+                style: {
+                    color: string;
+                };
+            };
+        };
+        h3: {
+            props: {
+                className: string;
+                style: {
+                    color: string;
+                };
+            };
+        };
+        p: {
+            props: {
+                className: string;
+            };
+        };
+        strong: {
+            props: {
+                className: string;
+            };
+        };
+        em: {
+            props: {
+                className: string;
+            };
+        };
+        a: {
+            props: {
+                className: string;
+                target: string;
+                rel: string;
+                style: {
+                    color: string;
+                };
+            };
+        };
+        code: {
+            props: {
+                className: string;
+            };
+        };
+        pre: {
+            props: {
+                className: string;
+            };
+        };
+        ul: {
+            props: {
+                className: string;
+            };
+        };
+        ol: {
+            props: {
+                className: string;
+            };
+        };
+        li: {
+            props: {
+                className: string;
+            };
+        };
+        blockquote: {
+            props: {
+                className: string;
+            };
+        };
+        hr: {
+            props: {
+                className: string;
+                style: {
+                    height: string;
+                    backgroundColor: string;
+                    opacity: number;
+                };
+            };
+        };
+        table: {
+            props: {
+                className: string;
+            };
+        };
+        thead: {
+            props: {
+                className: string;
+            };
+        };
+        th: {
+            props: {
+                className: string;
+            };
+        };
+        td: {
+            props: {
+                className: string;
+            };
+        };
+        tr: {
+            props: {
+                className: string;
+            };
+        };
+    };
+};
+/** The accent stripe, on whichever side the config names. */
+export declare function buildAccentBorderStyle(accentBorder: string, accentColor: string, transparentBackground: boolean): CSSProperties;
+/** The palette colour at `index`, or the chart default. */
+export declare function resolveAccentColor(colors: string[] | undefined, index: number): string;
+/** Rows arrive as `unknown[]`; only plain objects can become template variables. */
+export declare function toTemplateRows(data: unknown): Record<string, unknown>[];
+export interface MarkdownTemplateState {
+    /** Whether the content is a template rather than literal markdown. */
+    isTemplate: boolean;
+    /** The rendered body, or null before the first async render lands. */
+    output: string | null;
+    errors: MarkdownTemplateDiagnostic[];
+    /** References that resolved to nothing, reported alongside the output. */
+    warnings: MarkdownTemplateDiagnostic[];
+}
+/**
+ * Render the chart's content as a Knap template when a query is attached.
+ *
+ * A real query is what distinguishes the two modes, and it has to be the
+ * members rather than the object: several callers pass `{}` for "no query", and
+ * treating that as a template would silently reinterpret every text block.
+ */
+export declare function useMarkdownTemplate(content: string, data: unknown, queryObject: CubeQuery | undefined): MarkdownTemplateState;

package/dist/client/components/charts/markdownTemplate.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Knap template support for the markdown chart.
+ *
+ * A markdown portlet with a query renders its content as a Knap template rather
+ * than as literal markdown, so a dashboard can carry a written summary that is
+ * computed from live data instead of typed by hand.
+ *
+ * Knap resolves `a.b` as nested member access, so a cube-qualified result key
+ * such as `Employees.avgSalary` is unreachable from a `for` loop or from the
+ * `map` / `where` filters — those see a missing `Employees` object and yield
+ * nothing. Every row is therefore offered three ways:
+ *
+ *   rows      aliased keys (`employees_avg_salary`) — loops and arithmetic
+ *   labelled  human field labels as keys — `{{ labelled | table }}` headers
+ *   data      the raw dotted keys — `{{ data[0]["Employees.avgSalary"] }}`
+ *
+ * `first` and `last` exist because Knap's filters stringify on assignment:
+ * `{% set top = rows | sort:"x" %}` makes `top` a string, so a template cannot
+ * sort and then index. The query's own ordering has to be surfaced directly.
+ */
+/** One result field, in the three namings a template can address it by. */
+export interface MarkdownTemplateField {
+    /** The raw cube-qualified key, e.g. `Employees.avgSalary`. */
+    key: string;
+    /** The template-safe alias, e.g. `employees_avg_salary`. */
+    alias: string;
+    /** The human-readable label, e.g. `Avg Salary`. */
+    label: string;
+}
+/** The variables a markdown template is rendered against. */
+export interface MarkdownTemplateContext {
+    rows: Record<string, unknown>[];
+    labelled: Record<string, unknown>[];
+    data: Record<string, unknown>[];
+    rowCount: number;
+    first: Record<string, unknown> | null;
+    last: Record<string, unknown> | null;
+    fields: MarkdownTemplateField[];
+}
+/** A rendered template, or the diagnostics explaining why it did not render. */
+export interface MarkdownTemplateResult {
+    output: string;
+    errors: MarkdownTemplateDiagnostic[];
+    /**
+     * References the template makes that resolve to nothing. Knap renders an
+     * unknown name as an empty string, so a misspelt field produces a blank
+     * heading rather than any complaint — the failure is invisible at exactly the
+     * moment the author needs to see it.
+     */
+    warnings: MarkdownTemplateDiagnostic[];
+}
+export interface MarkdownTemplateDiagnostic {
+    message: string;
+    line: number;
+    column: number;
+}
+/**
+ * Derive the template alias for a cube-qualified field key.
+ *
+ * `Employees.avgSalary` becomes `employees_avg_salary`. A key that would start
+ * with a digit is prefixed, since Knap identifiers cannot.
+ */
+export declare function aliasForField(key: string): string;
+/**
+ * Build the template variables for a set of result rows.
+ *
+ * @param rows - raw result rows, as `resultSet.rawData()` returns them
+ * @param getFieldLabel - resolves a field key to its human label; pass the
+ *   value of `useCubeFieldLabel()` so labels match the rest of the app
+ */
+export declare function buildTemplateContext(rows: Record<string, unknown>[], getFieldLabel?: (key: string) => string): MarkdownTemplateContext;
+/**
+ * Find references that will silently render as nothing.
+ *
+ * Two mistakes account for nearly all of them: naming a variable the context
+ * does not provide, and reading a field off a row under a name that is not its
+ * alias. Both look identical in the output — a blank space where a value should
+ * be — so they are reported with the names that would have worked.
+ */
+export declare function findUnknownReferences(template: string, context: MarkdownTemplateContext): MarkdownTemplateDiagnostic[];
+/**
+ * Check a template for syntax errors and unknown filters without rendering it.
+ * Synchronous, so an editor can show diagnostics as the author types.
+ */
+export declare function validateTemplate(template: string): MarkdownTemplateDiagnostic[];
+/**
+ * Render a markdown template against result rows.
+ *
+ * Never throws. A broken template reports its diagnostics so the portlet can
+ * show them in place, rather than taking the dashboard down with it.
+ */
+export declare function renderMarkdownTemplate(template: string, context: MarkdownTemplateContext): Promise<MarkdownTemplateResult>;

package/dist/client/components.js

@@ -1,3 +1,3 @@
-import { D as e, O as t, X as n, a as r, h as i, i as a, m as o, n as s, p as c, r as l, s as u, t as d, w as f } from "./chunks/DashboardEditModal-DjMGNTUa.js";
+import { O as e, T as t, Z as n, a as r, g as i, h as a, i as o, k as s, m as c, n as l, r as u, s as d, t as f } from "./chunks/DashboardEditModal-B8zIH0ja.js";
 import { a as p, n as m, o as h, r as g, s as _, t as v } from "./chunks/utils-CToHkuhU.js";
-export { u as AnalysisDisplayConfigPanel, l as AnalyticsDashboard, n as AnalyticsPortlet, d as DashboardEditModal, i as DashboardFilterBar, a as DashboardGrid, o as DashboardGridSurface, r as DashboardModals, e as DashboardProvider, f as DashboardToolbar, c as Modal, s as PortletContainer, v as createDashboardLayout, m as createSamplePortlet, g as findNextPosition, p as generatePortletId, h as generateResponsiveLayouts, t as useDashboardContext, _ as validateCubeQuery };
+export { d as AnalysisDisplayConfigPanel, u as AnalyticsDashboard, n as AnalyticsPortlet, f as DashboardEditModal, i as DashboardFilterBar, o as DashboardGrid, a as DashboardGridSurface, r as DashboardModals, e as DashboardProvider, t as DashboardToolbar, c as Modal, l as PortletContainer, v as createDashboardLayout, m as createSamplePortlet, g as findNextPosition, p as generatePortletId, h as generateResponsiveLayouts, s as useDashboardContext, _ as validateCubeQuery };

package/dist/client/hooks.js

@@ -1,5 +1,5 @@
-import { z as e } from "./chunks/chart-data-table-CCvvgeG_.js";
-import { S as t, a as n, c as r, d as i, i as a, l as o, n as s, o as c, r as l, s as u, t as d } from "./chunks/useDirtyStateTracking-BQupC3wJ.js";
-import { a as f, i as p, n as m, o as h, r as g, t as _ } from "./chunks/useExplainAI-DORnTynt.js";
+import { z as e } from "./chunks/chart-data-table-Dfup1JpL.js";
+import { S as t, a as n, c as r, d as i, i as a, l as o, n as s, o as c, r as l, s as u, t as d } from "./chunks/useDirtyStateTracking-BUk23Wbh.js";
+import { a as f, i as p, n as m, o as h, r as g, t as _ } from "./chunks/useExplainAI-CGLroDBD.js";
 import { t as v } from "./chunks/useNotebookLayout-Ck3Z3uzg.js";
 export { m as createExplainQueryKey, c as createFlowQueryKey, r as createFunnelQueryKey, t as useCubeLoadQuery, t as useCubeQuery, e as useCubeMetaQuery, s as useDebounce, d as useDirtyStateTracking, p as useDryRunQueries, f as useDryRunQuery, _ as useExplainAI, g as useExplainQuery, l as useFilterValues, u as useFlowQuery, o as useFunnelQuery, i as useMultiCubeLoadQuery, h as useMultiDryRunQueries, v as useNotebookLayout, a as useResponsiveDashboard, n as useRetentionQuery };

package/dist/client/icons.js

@@ -1,2 +1,2 @@
-import { C as e, D as t, E as n, S as r, T as i, _ as a, b as o, v as s, w as c, x as l, y as u } from "./chunks/chart-data-table-CCvvgeG_.js";
+import { C as e, D as t, E as n, S as r, T as i, _ as a, b as o, v as s, w as c, x as l, y as u } from "./chunks/chart-data-table-Dfup1JpL.js";
 export { t as DEFAULT_ICONS, a as getChartTypeIcon, s as getFieldTypeIcon, u as getIcon, o as getIconData, l as getIconRegistry, r as getIconsByCategory, e as getMeasureTypeIcon, c as registerIcons, i as resetIcons, n as setIcon };