drizzle-cube 0.8.0 → 0.8.1

package/dist/client/components/analyticsPortlet/usePortletPagination.d.ts

@@ -0,0 +1,21 @@
+import { ChartPagination, ChartType, CubeQuery } from '../../types.js';
+/** Fixed page sizes, matching the records table's own `pageSize` option. */
+export declare const PAGE_SIZE_OPTIONS: number[];
+export interface UsePortletPaginationParams {
+    chartType: ChartType;
+    /** The query to paginate — the drilled query when one is active, else the base query. */
+    activeQuery: CubeQuery | null;
+    /** Authored page size from the portlet's display config. */
+    pageSize?: number;
+}
+export interface UsePortletPaginationResult {
+    /** `activeQuery` with limit/offset/order/total merged in, or it unchanged when paging is off. */
+    paginatedQuery: CubeQuery | null;
+    /**
+     * Passed to the chart as `ChartProps.pagination`; undefined when paging is
+     * off. `total` is left unset here — it arrives with the response, so the
+     * caller fills it in from the result set.
+     */
+    pagination?: Omit<ChartPagination, 'total'>;
+}
+export declare function usePortletPagination({ chartType, activeQuery, pageSize: authoredPageSize }: UsePortletPaginationParams): UsePortletPaginationResult;

package/dist/client/components/charts/RecordsTable.config.d.ts

@@ -0,0 +1,10 @@
+import { ChartTypeConfig } from '../../charts/chartConfigs.js';
+/**
+ * Configuration for the records table.
+ *
+ * Eager metadata (`label`, `description`, `useCase`, `isAvailable`) lives in the
+ * unified `chartRegistry` entry — see `src/client/charts/chartRegistry.ts`. This
+ * file owns the lazy-loaded shape: drop zones, display options, clickable
+ * elements, validation.
+ */
+export declare const recordsTableConfig: ChartTypeConfig;

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

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { ChartProps } from '../../types.js';
+declare const RecordsTable: React.MemoExoticComponent<({ data, chartConfig, displayConfig, queryObject, colorPalette, height, onDataPointClick, drillEnabled, pagination }: ChartProps) => React.JSX.Element>;
+export default RecordsTable;

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

@@ -0,0 +1,68 @@
+import { default as React } from 'react';
+import { ChartAxisConfig, ChartPagination, CubeQuery } from '../../types.js';
+export declare const DEFAULT_PAGE_SIZE = 25;
+/**
+ * Which columns to render, in which order.
+ *
+ * The author's arrangement comes from the Columns drop zone; a viewer can drag
+ * a header on top of it, and that order is remembered per column set. It is
+ * *reconciled* rather than substituted, so a column the author adds later still
+ * appears instead of being swallowed by a stale local order.
+ */
+export declare function useRecordsColumns(params: {
+    rows: Record<string, unknown>[];
+    chartConfig?: ChartAxisConfig;
+    queryObject?: CubeQuery;
+}): {
+    columns: string[];
+    storageKey: string;
+    draggedColumn: string | null;
+    didDragRef: React.MutableRefObject<boolean>;
+    startColumnDrag: (column: string) => void;
+    endColumnDrag: () => void;
+    dropColumn: (target: string) => void;
+};
+/**
+ * Drag-resizable column widths, remembered per column set.
+ *
+ * A chart has no portlet id and no write path back to `displayConfig`, so an
+ * authored `columnWidths` acts as the default a viewer's own drags layer over —
+ * the same arrangement the data browser uses.
+ */
+export declare function useColumnWidths(params: {
+    columns: string[];
+    storageKey: string;
+    authored?: Record<string, number>;
+}): {
+    columnWidths: Record<string, number>;
+    totalWidth: number | undefined;
+    tableRef: React.RefObject<HTMLTableElement>;
+    didResizeRef: React.MutableRefObject<boolean>;
+    startResize: (event: React.MouseEvent, column: string) => void;
+};
+/**
+ * Sorting and paging, server-side when the host offers it.
+ *
+ * With a `pagination` prop the host re-queries, so both must go through it:
+ * sorting only the loaded page would put the wrong rows on page 1. Without one
+ * — the AnalysisBuilder preview, the notebook, plugin hosts — the table sorts
+ * and pages over the rows it already has.
+ */
+export declare function useRecordsPaging(params: {
+    rows: Record<string, unknown>[];
+    pagination?: ChartPagination;
+    authoredPageSize?: number;
+}): {
+    sort: {
+        column: string;
+        direction: "asc" | "desc";
+    } | null;
+    toggleSort: (column: string) => void;
+    visibleRows: Record<string, unknown>[];
+    page: number;
+    pageSize: number;
+    pageCount: number;
+    rowCount: number;
+    goToPage: (next: number) => void;
+    showPager: boolean;
+};

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-9An5EDAz.js";
+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-_ZDMwaGX.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 };

package/dist/client/hooks.js

@@ -1,5 +1,5 @@
-import { R as e } from "./chunks/chart-data-table-DgiNBOWf.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-CSDg96Rw.js";
-import { a as f, i as p, n as m, o as h, r as g, t as _ } from "./chunks/useExplainAI-BnkoZ-zS.js";
+import { z as e } from "./chunks/chart-data-table-C_oHiK6N.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-BFJHiiVK.js";
+import { a as f, i as p, n as m, o as h, r as g, t as _ } from "./chunks/useExplainAI-_C4WQE5I.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/types.d.ts

@@ -80,6 +80,7 @@ export interface IconRegistry {
     chartRadialBar: IconDefinition;
     chartTreemap: IconDefinition;
     chartTable: IconDefinition;
+    chartRecordsTable: IconDefinition;
     chartActivityGrid: IconDefinition;
     chartKpiNumber: IconDefinition;
     chartKpiDelta: IconDefinition;

package/dist/client/icons.js

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

package/dist/client/index.d.ts

@@ -33,7 +33,7 @@ useCubeFeatures } from './providers/CubeProvider.js';
 export { ScrollContainerProvider, useScrollContainer } from './providers/ScrollContainerContext.js';
 export { useCubeFieldLabel } from './hooks/useCubeFieldLabel.js';
 export { createCubeClient } from './client/CubeClient.js';
-export { CubeClient } from './client/CubeClient.js';
+export { CubeClient, CubeQueryError } from './client/CubeClient.js';
 export { useCubeMetaQuery, useCubeLoadQuery, useCubeQuery, useMultiCubeLoadQuery, useDryRunQuery, useMultiDryRunQueries, useDryRunQueries, useExplainQuery, createExplainQueryKey, useExplainAI, useFunnelQuery, createFunnelQueryKey, useFlowQuery, createFlowQueryKey, } from './hooks/queries/index.js';
 export type { UseCubeMetaQueryOptions, UseCubeMetaQueryResult, UseCubeLoadQueryOptions, UseCubeLoadQueryResult, UseMultiCubeLoadQueryOptions, UseMultiCubeLoadQueryResult, DebugDataEntry, UseExplainQueryOptions, UseExplainQueryResult, UseExplainAIOptions, UseExplainAIResult, UseFlowQueryOptions, UseFlowQueryResult, } from './hooks/queries/index.js';
 export { useAnalysisBuilder } from './hooks/useAnalysisBuilderHook.js';
@@ -55,7 +55,7 @@ export { useTheme } from './hooks/useTheme.js';
 export { useScrollDetection } from './hooks/useScrollDetection.js';
 export { useElementVisibility } from './hooks/useElementVisibility.js';
 export { useDrillInteraction } from './hooks/useDrillInteraction.js';
-export type { PortletConfig, ChartType, BuiltInChartType, ChartAxisConfig, ChartDisplayConfig, ChartProps, ColorPalette, CubeQuery, CubeQueryOptions, CubeApiOptions, DashboardConfig, PortletGroup, PortletGroupCell, FeaturesConfig, XlsExportFeatureConfig, ThumbnailFeatureConfig, MultiQueryConfig, QueryMergeStrategy, FunnelBindingKey, FunnelBindingKeyMapping, FunnelStep, FunnelConfig, FunnelStepResult, FunnelExecutionResult, FunnelChartData, FunnelValidationError, FunnelValidationResult, UseFunnelQueryOptions, UseFunnelQueryResult, ServerFlowQuery, FlowQueryConfig, FlowChartData, FlowSliceState, SankeyNode, SankeyLink, FlowStartingStep, FlowResultRow, } from './types.js';
+export type { PortletConfig, ChartType, BuiltInChartType, ChartAxisConfig, ChartDisplayConfig, ChartProps, ColorPalette, CubeQuery, CubeQueryOptions, CubeApiOptions, CubeValidationIssue, ChartPagination, ColumnFormatConfig, ColumnFormatKind, RowLinkConfig, DashboardConfig, PortletGroup, PortletGroupCell, FeaturesConfig, XlsExportFeatureConfig, ThumbnailFeatureConfig, MultiQueryConfig, QueryMergeStrategy, FunnelBindingKey, FunnelBindingKeyMapping, FunnelStep, FunnelConfig, FunnelStepResult, FunnelExecutionResult, FunnelChartData, FunnelValidationError, FunnelValidationResult, UseFunnelQueryOptions, UseFunnelQueryResult, ServerFlowQuery, FlowQueryConfig, FlowChartData, FlowSliceState, SankeyNode, SankeyLink, FlowStartingStep, FlowResultRow, } from './types.js';
 export { isQueryConfig, isFunnelConfig, isFlowConfig, isRetentionConfig, isMultiQuery, isSingleQuery, isValidAnalysisConfig, createDefaultQueryConfig, createDefaultFunnelConfig, createDefaultFlowConfig, createDefaultRetentionConfig, createDefaultConfig, isValidAnalysisWorkspace, createDefaultWorkspace } from './types/analysisConfig.js';
 export type { AnalysisConfig, QueryAnalysisConfig, FunnelAnalysisConfig, FlowAnalysisConfig, RetentionAnalysisConfig, AnalysisWorkspace } from './types/analysisConfig.js';
 export { isMultiQueryConfig, isServerFunnelQuery, isServerFlowQuery, isSankeyData } from './types.js';