drizzle-cube 0.9.3 → 0.9.5

package/dist/cjs/client/types.d.ts

@@ -511,6 +511,15 @@ export interface AnalyticsPortletProps {
         };
     }) => void;
 }
+/**
+ * Host-owned dashboard record fields the library does not store in DashboardConfig.
+ * Supplied so the dashboard import/export feature can write them into the export
+ * file and derive a filename; the library never persists them itself.
+ */
+export interface DashboardMeta {
+    name?: string;
+    description?: string;
+}
 export interface AnalyticsDashboardProps {
     config: DashboardConfig;
     editable?: boolean;
@@ -520,6 +529,17 @@ export interface AnalyticsDashboardProps {
     onSave?: (config: DashboardConfig) => Promise<void> | void;
     onSaveThumbnail?: (thumbnailData: string) => Promise<string | void>;
     onDirtyStateChange?: (isDirty: boolean) => void;
+    /** Name/description of the host's dashboard record, written into dashboard exports (features.dashboardImportExport) */
+    dashboardMeta?: DashboardMeta;
+    /**
+     * Called after a dashboard import has replaced the config, when the imported file
+     * carries a name. Lets the host rename its dashboard record to match. Optional:
+     * without it an import only replaces the config.
+     */
+    onDashboardMetaChange?: (meta: {
+        name: string;
+        description?: string;
+    }) => Promise<void> | void;
 }
 export interface ChartProps {
     data: any[];
@@ -573,6 +593,11 @@ export interface XlsExportFeatureConfig {
     /** Optional prefix for exported filenames (default: portlet title) */
     filenamePrefix?: string;
 }
+export interface DashboardImportExportFeatureConfig {
+    enabled: boolean;
+    /** Optional prefix for exported filenames (default: none; the file is named after the dashboard) */
+    filenamePrefix?: string;
+}
 export interface FeaturesConfig {
     enableAI?: boolean;
     aiEndpoint?: string;
@@ -583,6 +608,7 @@ export interface FeaturesConfig {
     thumbnail?: ThumbnailFeatureConfig;
     manualRefresh?: boolean;
     xlsExport?: XlsExportFeatureConfig;
+    dashboardImportExport?: DashboardImportExportFeatureConfig;
 }
 export interface GridLayout {
     i: string;

package/dist/cjs/client/utils/dashboardExport.d.ts

@@ -0,0 +1,84 @@
+import { DashboardConfig, DashboardMeta } from '../types.js';
+/**
+ * The on-disk shape of a dashboard export: the config plus the host-owned name and
+ * description. Portlets carry their own `analysisConfig.version` and migrate on read.
+ */
+export interface DashboardExportFile {
+    /** ISO 8601 timestamp of when the file was created */
+    exportedAt: string;
+    name?: string;
+    description?: string;
+    config: DashboardConfig;
+}
+/**
+ * Why a file could not be imported. The check is structural only: the file has to
+ * have the shape of a dashboard config, and its contents are taken on trust from
+ * there. Codes, not sentences: the UI resolves them to translated text
+ * (`dashboard.import.error.<code>`).
+ */
+export type DashboardImportError = {
+    code: 'invalidJson';
+} | {
+    code: 'unknownFormat';
+} | {
+    code: 'invalidConfig';
+    path: string;
+} | {
+    code: 'invalidPortlet';
+    index: number;
+    path: string;
+};
+/**
+ * Non-fatal findings about an otherwise valid file.
+ */
+export type DashboardImportWarning = {
+    code: 'unknownFilterMapping';
+    portletId: string;
+    portletTitle: string;
+    filterId: string;
+};
+export type DashboardImportResult = {
+    ok: true;
+    config: DashboardConfig;
+    name?: string;
+    description?: string;
+    warnings: DashboardImportWarning[];
+} | {
+    ok: false;
+    errors: DashboardImportError[];
+};
+/**
+ * Prepare a config for export: canonical portlets, transient thumbnail fields removed,
+ * everything else untouched.
+ */
+export declare function normalizeDashboardConfigForExport(config: DashboardConfig): DashboardConfig;
+/**
+ * Build the export envelope for a dashboard.
+ */
+export declare function createDashboardExport(config: DashboardConfig, meta?: DashboardMeta, now?: Date): DashboardExportFile;
+/**
+ * Pretty-printed JSON for the file, so exports diff well in version control.
+ */
+export declare function serializeDashboardExport(file: DashboardExportFile): string;
+/**
+ * Filename for an export: `<prefix->?<dashboard-name|dashboard>-<yyyy-mm-dd>.json`.
+ * The name is lowercased with spaces turned into dashes — no slugification.
+ */
+export declare function dashboardExportFilename(name?: string, date?: Date, prefix?: string): string;
+/**
+ * Trigger a browser download of the export file. No-op outside a browser.
+ */
+export declare function downloadDashboardExport(file: DashboardExportFile, filename?: string): void;
+/**
+ * Parse a dashboard export. Accepts the JSON text or an already-parsed value.
+ *
+ * Two shapes are recognised: the envelope written by `createDashboardExport` (an
+ * object with a `config`), and a bare DashboardConfig (an object with a `portlets`
+ * array) so a row copied straight from the host's database imports too. Anything
+ * else is `unknownFormat`.
+ */
+export declare function parseDashboardExport(input: string | unknown): DashboardImportResult;
+/**
+ * Read and parse a File picked by the user (e.g. from an `<input type="file">`).
+ */
+export declare function readDashboardExportFile(file: File): Promise<DashboardImportResult>;

package/dist/cjs/client/utils/index.d.ts

@@ -8,6 +8,8 @@ export * from './syntaxHighlighting.js';
 export * from './comparisonUtils.js';
 export { captureThumbnail, isThumbnailCaptureAvailable } from './thumbnail.js';
 export { exportPortletToXlsx, isExportAvailable } from './exportXlsx.js';
+export { createDashboardExport, serializeDashboardExport, parseDashboardExport, readDashboardExportFile, downloadDashboardExport, dashboardExportFilename, normalizeDashboardConfigForExport, } from './dashboardExport.js';
+export type { DashboardExportFile, DashboardImportResult, DashboardImportError, DashboardImportWarning, } from './dashboardExport.js';
 /**
  * Create a dashboard layout from portlet configurations
  */

package/dist/client/charts/ChartLoader.d.ts

@@ -25,7 +25,7 @@ export interface LazyChartProps extends ChartProps {
  * />
  * ```
  */
-export declare function LazyChart({ chartType, fallback, height, ...chartProps }: LazyChartProps): import("react").JSX.Element;
+export declare function LazyChart({ chartType, fallback, height, ...chartProps }: LazyChartProps): import('react').JSX.Element;
 /**
  * Preload a chart type
  *

package/dist/client/charts.js

@@ -1,14 +1,14 @@
-import { dt as e, ft as t, gt as n, ht as r, lt as i, mt as a, pt as o, t as s, ut as c } from "./chunks/chart-data-table-Dfup1JpL.js";
-import { d as l, l as u, s as d, u as f } from "./chunks/chart-activity-grid-aIyjUpbJ.js";
-import { t as p } from "./chunks/chart-funnel-DqBD-oth.js";
-import { a as m, i as h, n as g, o as _, r as v, s as y, t as b } from "./chunks/charts-loader-B_ye_C5_.js";
-import { t as x } from "./chunks/chart-area-DCCvp06H.js";
+import { dt as e, ft as t, gt as n, ht as r, lt as i, mt as a, pt as o, t as s, ut as c } from "./chunks/chart-data-table-DkkQtuY6.js";
+import { d as l, l as u, s as d, u as f } from "./chunks/chart-activity-grid-cJI-MF_M.js";
+import { t as p } from "./chunks/chart-funnel-BtjUJRcf.js";
+import { a as m, i as h, n as g, o as _, r as v, s as y, t as b } from "./chunks/charts-loader-DuV9kYN8.js";
+import { t as x } from "./chunks/chart-area-11vKdaTE.js";
 import { i as S } from "./chunks/utils-CToHkuhU.js";
-import { t as C } from "./chunks/chart-bar-C8xQ15Aa.js";
-import { t as w } from "./chunks/chart-line-rl9q-vom.js";
-import { t as T } from "./chunks/chart-pie-W4Mk0WFB.js";
-import { t as E } from "./chunks/chart-scatter-BHp1yLvR.js";
-import { t as D } from "./chunks/chart-radar-BXkMOUVC.js";
-import { t as O } from "./chunks/chart-radial-bar-CSw1hCK2.js";
-import { t as k } from "./chunks/chart-tree-map-YBAOj00L.js";
+import { t as C } from "./chunks/chart-bar-ByOYTFZp.js";
+import { t as w } from "./chunks/chart-line-D6Xkq1eW.js";
+import { t as T } from "./chunks/chart-pie-X3wVYu9v.js";
+import { t as E } from "./chunks/chart-scatter-DSNgbnEu.js";
+import { t as D } from "./chunks/chart-radar-BExajFiU.js";
+import { t as O } from "./chunks/chart-radial-bar-CgGmC8WE.js";
+import { t as k } from "./chunks/chart-tree-map-DS5X1Wiw.js";
 export { d as CHART_COLORS, u as CHART_MARGINS, s as DataTable, p as FunnelChart, b as LazyChart, f as NEGATIVE_COLOR, l as POSITIVE_COLOR, x as RechartsAreaChart, C as RechartsBarChart, w as RechartsLineChart, T as RechartsPieChart, D as RechartsRadarChart, O as RechartsRadialBarChart, E as RechartsScatterChart, k as RechartsTreeMapChart, i as clearChartConfigCache, S as formatChartData, g as getAvailableChartTypes, c as getChartConfigAsync, e as getChartConfigSync, v as getUnavailableChartTypes, t as isChartConfigLoaded, h as isChartTypeAvailable, m as isValidChartType, o as loadAllChartConfigs, _ as preloadChart, a as preloadChartConfig, r as preloadChartConfigs, y as preloadCharts, n as useChartConfig };