@dashadmin/dash-reports 1.3.73 → 1.3.74-srcfree.1

package/dist/ReportFilters.d.ts

@@ -0,0 +1,9 @@
+import type { ReportFilterState, ReportSpec, TranslateFn } from './core/types';
+export interface ReportFiltersProps {
+    spec: ReportSpec;
+    value: ReportFilterState;
+    onChange: (next: ReportFilterState) => void;
+    translate: TranslateFn;
+}
+export declare function ReportFilters({ spec, value, onChange, translate }: ReportFiltersProps): import("react").JSX.Element;
+export default ReportFilters;

package/dist/ReportFiltersDrawer.d.ts

@@ -0,0 +1,12 @@
+import type { ReportFilterState, ReportSpec, TranslateFn } from './core/types';
+export interface ReportFiltersDrawerProps {
+    open: boolean;
+    onClose: () => void;
+    spec: ReportSpec;
+    value: ReportFilterState;
+    onChange: (next: ReportFilterState) => void;
+    onReset: () => void;
+    translate: TranslateFn;
+}
+export declare function ReportFiltersDrawer({ open, onClose, spec, value, onChange, onReset, translate, }: ReportFiltersDrawerProps): import("react").JSX.Element;
+export default ReportFiltersDrawer;

package/dist/ReportPage.d.ts

@@ -0,0 +1,9 @@
+import type { TranslateFn } from './core/types';
+import './adapters/mui';
+export interface ReportPageProps {
+    reportKey: string;
+    translate: TranslateFn;
+    title?: string;
+}
+export declare function ReportPage({ reportKey, translate, title }: ReportPageProps): import("react").JSX.Element;
+export default ReportPage;

package/dist/ReportsDashboard.d.ts

@@ -0,0 +1,7 @@
+import type { TranslateFn } from './core/types';
+export interface ReportsDashboardProps {
+    translate: TranslateFn;
+    title?: string;
+}
+export declare function ReportsDashboard({ translate, title }: ReportsDashboardProps): import("react").JSX.Element;
+export default ReportsDashboard;

package/dist/ReportsIndex.d.ts

@@ -0,0 +1,7 @@
+import type { TranslateFn } from './core/types';
+export interface ReportsIndexProps {
+    translate: TranslateFn;
+    onOpen: (reportKey: string) => void;
+}
+export declare function ReportsIndex({ translate, onOpen }: ReportsIndexProps): import("react").JSX.Element;
+export default ReportsIndex;

package/dist/ReportsModule.d.ts

@@ -0,0 +1,7 @@
+import type { TranslateFn } from './core/types';
+export interface ReportsModuleProps {
+    translate: TranslateFn;
+    basePath: string;
+}
+export declare function ReportsModule({ translate, basePath }: ReportsModuleProps): import("react").JSX.Element;
+export default ReportsModule;

package/dist/TenantDashboard.d.ts

@@ -0,0 +1,12 @@
+import type { TranslateFn } from './core/types';
+import './adapters/mui';
+export interface TenantDashboardProps {
+    tenantId: string;
+    tenantName?: string;
+    translate: TranslateFn;
+    showHeading?: boolean;
+    period?: string;
+    hidePeriodPicker?: boolean;
+}
+export declare function TenantDashboard({ tenantId, tenantName, translate, showHeading, period: pinnedPeriod, hidePeriodPicker, }: TenantDashboardProps): import("react").JSX.Element;
+export default TenantDashboard;

package/dist/adapters/mui/BarWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function BarWidget(props: VisualizationProps): import("react").JSX.Element;
+export default BarWidget;

package/dist/adapters/mui/DoughnutWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function DoughnutWidget({ result, spec, translate, height }: VisualizationProps): import("react").JSX.Element;
+export default DoughnutWidget;

package/dist/adapters/mui/FunnelWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function FunnelWidget({ result, spec, translate }: VisualizationProps): import("react").JSX.Element;
+export default FunnelWidget;

package/dist/adapters/mui/KpiWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function KpiWidget({ result, spec, translate }: VisualizationProps): import("react").JSX.Element;
+export default KpiWidget;

package/dist/adapters/mui/LineWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function LineWidget(props: VisualizationProps): import("react").JSX.Element;
+export default LineWidget;

package/dist/adapters/mui/PieWidget.d.ts

@@ -0,0 +1,3 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function PieWidget(props: VisualizationProps): import("react").JSX.Element;
+export default PieWidget;

package/dist/adapters/mui/PreviewWidget.d.ts

@@ -0,0 +1,10 @@
+import type { ReportMetric, ReportResult, TranslateFn, VisualizationType } from '../../core/types';
+export interface PreviewWidgetProps {
+    result: ReportResult | null;
+    loading: boolean;
+    type: VisualizationType;
+    translate: TranslateFn;
+    metrics?: ReportMetric[];
+}
+export declare function PreviewWidget({ result, loading, type, translate, metrics }: PreviewWidgetProps): import("react").JSX.Element;
+export default PreviewWidget;

package/dist/adapters/mui/TableWidget.d.ts

@@ -0,0 +1,16 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function SeriesTableWidget({ result, translate }: VisualizationProps): import("react").JSX.Element;
+export interface DetailTableProps {
+    page: {
+        data: Array<Record<string, unknown>>;
+        total: number;
+        page: number;
+        perPage: number;
+    } | null;
+    loading: boolean;
+    currentPage: number;
+    onPageChange: (page: number) => void;
+    translate: (key: string, options?: Record<string, unknown>) => string;
+}
+export declare function DetailTable({ page, loading, currentPage, onPageChange, translate }: DetailTableProps): import("react").JSX.Element;
+export default SeriesTableWidget;

package/dist/adapters/mui/chartSetup.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureChartsRegistered(): void;
+export default ensureChartsRegistered;

package/dist/adapters/mui/chartTheme.d.ts

@@ -0,0 +1,71 @@
+import type { Theme } from '@mui/material';
+export interface ChartChrome {
+    dark: boolean;
+    grid: string;
+    axisText: string;
+    tooltipBg: string;
+    tooltipText: string;
+    surface: string;
+}
+export declare function chartChrome(theme: Theme): ChartChrome;
+export declare function baseChartOptions(chrome: ChartChrome, showLegend: boolean): {
+    responsive: boolean;
+    maintainAspectRatio: boolean;
+    interaction: {
+        mode: "index";
+        intersect: boolean;
+    };
+    plugins: {
+        legend: {
+            display: boolean;
+            position: "bottom";
+            labels: {
+                color: string;
+                usePointStyle: boolean;
+                pointStyle: "circle";
+                boxWidth: number;
+                boxHeight: number;
+                padding: number;
+            };
+        };
+        tooltip: {
+            backgroundColor: string;
+            titleColor: string;
+            bodyColor: string;
+            borderColor: string;
+            borderWidth: number;
+            padding: number;
+            cornerRadius: number;
+            displayColors: boolean;
+            usePointStyle: boolean;
+        };
+    };
+    scales: {
+        x: {
+            grid: {
+                display: boolean;
+            };
+            border: {
+                color: string;
+            };
+            ticks: {
+                color: string;
+                maxRotation: number;
+                autoSkipPadding: number;
+            };
+        };
+        y: {
+            beginAtZero: boolean;
+            grid: {
+                color: string;
+            };
+            border: {
+                display: boolean;
+            };
+            ticks: {
+                color: string;
+                precision: number;
+            };
+        };
+    };
+};

package/dist/adapters/mui/index.d.ts

@@ -0,0 +1,12 @@
+import { BarWidget } from './BarWidget';
+import { LineWidget } from './LineWidget';
+import { DoughnutWidget } from './DoughnutWidget';
+import { PieWidget } from './PieWidget';
+import { KpiWidget } from './KpiWidget';
+import { FunnelWidget } from './FunnelWidget';
+import { SeriesTableWidget } from './TableWidget';
+export { BarWidget, LineWidget, DoughnutWidget, PieWidget, KpiWidget, FunnelWidget, SeriesTableWidget };
+export { DetailTable } from './TableWidget';
+export { PreviewWidget } from './PreviewWidget';
+export * from './palette';
+export { chartChrome, baseChartOptions } from './chartTheme';

package/dist/adapters/mui/palette.d.ts

@@ -0,0 +1,9 @@
+import type { ReportSpec } from '../../core/types';
+export declare const SERIES_LIGHT: readonly ["#2a78d6", "#eb6834", "#1baf7a", "#eda100", "#e87ba4", "#008300", "#4a3aa7", "#e34948"];
+export declare const SERIES_DARK: readonly ["#3987e5", "#d95926", "#199e70", "#c98500", "#d55181", "#008300", "#9085e9", "#e66767"];
+export declare const OTHER_LIGHT = "#8a8a80";
+export declare const OTHER_DARK = "#6f6f66";
+export declare const MAX_SERIES: 8;
+export declare function seriesPalette(dark: boolean): readonly string[];
+export declare function buildSlotMap(spec: ReportSpec | null, pivotKey: string | undefined, seriesKeys: string[]): Map<string, number>;
+export declare function colorForSlot(slot: number, dark: boolean): string;

package/dist/adapters/mui/useChartData.d.ts

@@ -0,0 +1,14 @@
+import type { VisualizationProps } from '../../core/visualizationRegistry';
+export declare function useChartData({ result, spec, translate }: VisualizationProps): {
+    chrome: import("./chartTheme").ChartChrome;
+    datasets: {
+        key: string;
+        label: string;
+        data: number[];
+        color: string;
+    }[];
+    labels: string[];
+    longLabels: string[];
+    foldedCount: number;
+};
+export default useChartData;

package/dist/core/formatBucket.d.ts

@@ -0,0 +1,4 @@
+import type { Granularity, TranslateFn } from './types';
+export declare function formatBucket(bucket: string | number, granularity: Granularity, translate: TranslateFn): string;
+export declare function formatBucketLong(bucket: string | number, granularity: Granularity, translate: TranslateFn): string;
+export default formatBucket;

package/dist/core/label.d.ts

@@ -0,0 +1,3 @@
+import type { TranslateFn } from './types';
+export declare function label(translate: TranslateFn, key: string | undefined, text?: string): string;
+export default label;

package/dist/core/queryParams.d.ts

@@ -0,0 +1,3 @@
+import type { ReportFilterState } from './types';
+export declare function toQueryParams(filters: ReportFilterState): Record<string, unknown>;
+export default toQueryParams;

package/dist/core/types.d.ts

@@ -0,0 +1,94 @@
+export type Granularity = 'total' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'hourOfDay' | 'dayOfWeek';
+export type VisualizationType = 'Bar' | 'Line' | 'Pie' | 'Doughnut' | 'Kpi' | 'Funnel' | 'Table';
+export interface DimensionValue {
+    value: string | number | boolean;
+    label: string;
+    labelText?: string;
+    icon?: string;
+}
+export interface ReportDimension {
+    key: string;
+    label: string;
+    labelText?: string;
+    type: 'column' | 'jsonpath' | 'relation';
+    multiple?: boolean;
+    source?: string;
+    visibleTo?: string[];
+    values?: DimensionValue[];
+}
+export interface ReportMetric {
+    key: string;
+    label: string;
+    labelText?: string;
+    kind: 'count' | 'countNotNull' | 'countDistinct' | 'sum' | 'avg' | 'min' | 'max';
+    decimal: boolean;
+    unit?: string | null;
+}
+export interface ReportVisualization {
+    type: VisualizationType;
+    options?: Record<string, unknown>;
+}
+export interface ReportSpec {
+    key: string;
+    title: string;
+    titleText?: string;
+    granularities: Granularity[];
+    defaultGranularity: Granularity;
+    timezone: string;
+    dimensions: ReportDimension[];
+    metrics: ReportMetric[];
+    visualizations: ReportVisualization[];
+    defaultVisualization: VisualizationType;
+    previewGranularity: Granularity;
+    filters: Record<string, {
+        type: string;
+    }>;
+    exporters: string[];
+    defaultRangeDays: number;
+}
+export interface ReportSeries {
+    key: string;
+    label: string;
+    labelText?: string;
+    metric: string;
+    data: Array<number | null>;
+}
+export interface ReportResult {
+    key: string;
+    granularity: Granularity;
+    timezone: string;
+    buckets: Array<string | number>;
+    series: ReportSeries[];
+    totals: Record<string, number | null>;
+    meta?: {
+        start?: string;
+        end?: string;
+        pivot?: string | null;
+        scopedTenantIds?: string[] | null;
+    };
+}
+export interface ReportTablePage {
+    data: Array<Record<string, unknown>>;
+    total: number;
+    page: number;
+    perPage: number;
+    lastPage: number;
+}
+export interface ReportListEntry {
+    key: string;
+    title: string;
+    titleText?: string;
+    metrics?: ReportMetric[];
+    visualizations: ReportVisualization[];
+    defaultVisualization: VisualizationType;
+    previewGranularity: Granularity;
+    defaultRangeDays: number;
+}
+export interface ReportFilterState {
+    start: string;
+    end: string;
+    granularity: Granularity;
+    pivot?: string;
+    dimensions: Record<string, Array<string | number | boolean>>;
+}
+export type TranslateFn = (key: string, options?: Record<string, unknown>) => string;

package/dist/core/useDashboard.d.ts

@@ -0,0 +1,50 @@
+import type { ReportMetric, ReportResult, VisualizationType } from './types';
+export interface DashboardPeriod {
+    id: string;
+    label: string;
+    start: string;
+    end: string;
+    isOpen: boolean;
+}
+export interface DashboardWidget {
+    key: string;
+    reportKey: string;
+    title: string;
+    titleText?: string;
+    pivot?: string;
+    metrics?: string[];
+    visualization?: VisualizationType;
+    size?: 'sm' | 'md' | 'lg' | 'full';
+    result?: ReportResult & {
+        metrics?: ReportMetric[];
+    };
+    error?: string;
+}
+export interface DashboardTenant {
+    tenant: {
+        id: string;
+        name: string;
+    };
+    period: DashboardPeriod | null;
+}
+export declare function useDashboardTenants(): {
+    tenants: DashboardTenant[];
+    widgets: DashboardWidget[];
+    loading: boolean;
+    error: Error;
+};
+export interface DashboardData {
+    tenantId: string;
+    period: DashboardPeriod;
+    source: string;
+    widgets: DashboardWidget[];
+}
+export declare function useTenantDashboard(tenantId: string | null, period?: string): {
+    data: DashboardData;
+    loading: boolean;
+    error: Error;
+};
+export declare function useTenantPeriods(tenantId: string | null): {
+    periods: DashboardPeriod[];
+    loading: boolean;
+};

package/dist/core/useReportExport.d.ts

@@ -0,0 +1,7 @@
+import type { ReportFilterState } from './types';
+export declare function useReportExport(reportKey: string): {
+    exporting: boolean;
+    error: Error;
+    exportReport: (filters: ReportFilterState, format?: string) => Promise<void>;
+};
+export default useReportExport;

package/dist/core/useReportList.d.ts

@@ -0,0 +1,7 @@
+import type { ReportListEntry } from './types';
+export declare function useReportList(): {
+    reports: ReportListEntry[];
+    loading: boolean;
+    error: Error;
+};
+export default useReportList;

package/dist/core/useReportPreview.d.ts

@@ -0,0 +1,7 @@
+import type { Granularity, ReportResult } from './types';
+export declare function useReportPreview(reportKey: string, granularity: Granularity, rangeDays: number, enabled?: boolean): {
+    result: ReportResult;
+    loading: boolean;
+    error: Error;
+};
+export default useReportPreview;

package/dist/core/useReportSeries.d.ts

@@ -0,0 +1,8 @@
+import type { ReportFilterState, ReportResult } from './types';
+export interface UseReportSeriesResult {
+    result: ReportResult | null;
+    loading: boolean;
+    error: Error | null;
+}
+export declare function useReportSeries(reportKey: string, filters: ReportFilterState | null): UseReportSeriesResult;
+export default useReportSeries;

package/dist/core/useReportSpec.d.ts

@@ -0,0 +1,9 @@
+import type { ReportSpec } from './types';
+export interface UseReportSpecResult {
+    spec: ReportSpec | null;
+    loading: boolean;
+    error: Error | null;
+    reload: () => void;
+}
+export declare function useReportSpec(reportKey: string): UseReportSpecResult;
+export default useReportSpec;

package/dist/core/useReportTable.d.ts

@@ -0,0 +1,10 @@
+import type { ReportFilterState, ReportTablePage } from './types';
+export interface UseReportTableResult {
+    page: ReportTablePage | null;
+    loading: boolean;
+    error: Error | null;
+    setPage: (page: number) => void;
+    currentPage: number;
+}
+export declare function useReportTable(reportKey: string, filters: ReportFilterState | null, enabled?: boolean, perPage?: number): UseReportTableResult;
+export default useReportTable;

package/dist/core/visualizationLayout.d.ts

@@ -0,0 +1,13 @@
+export declare function isCanvasVisualization(type: string | null | undefined): boolean;
+export declare function visualizationBoxSx(type: string | null | undefined, height: number): {
+    height: number;
+    minHeight: number;
+    maxHeight: number;
+    overflow: string;
+} | {
+    minHeight: number;
+    height?: undefined;
+    maxHeight?: undefined;
+    overflow?: undefined;
+};
+export default isCanvasVisualization;

package/dist/core/visualizationRegistry.d.ts

@@ -0,0 +1,14 @@
+import type { ComponentType } from 'react';
+import type { ReportResult, ReportSpec, TranslateFn, VisualizationType } from './types';
+export interface VisualizationProps {
+    result: ReportResult;
+    spec: ReportSpec;
+    translate: TranslateFn;
+    options?: Record<string, unknown>;
+    height?: number;
+}
+declare const registry: Map<VisualizationType, ComponentType<VisualizationProps>>;
+export declare function registerVisualization(type: VisualizationType, component: ComponentType<VisualizationProps>): void;
+export declare function getVisualization(type: VisualizationType): ComponentType<VisualizationProps> | null;
+export declare function registeredVisualizations(): VisualizationType[];
+export default registry;

package/dist/createReportsResource.d.ts

@@ -0,0 +1,40 @@
+import type { ReactElement } from 'react';
+import type { TranslateFn } from './core/types';
+export interface CreateReportsResourceOptions {
+    model?: string;
+    label?: string;
+    group?: string;
+    icon?: ReactElement;
+    roles?: string[];
+    menuTitle?: string;
+    translate?: TranslateFn;
+    urlPrefix?: string;
+}
+export declare function createReportsResource(options?: CreateReportsResourceOptions): {
+    model: string;
+    label: string;
+    group: string;
+    icon: ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
+    roles: string[];
+    schema: any[];
+    list: boolean;
+    create: boolean;
+    edit: boolean;
+    view: boolean;
+    delete: boolean;
+    listViewButton: {
+        enabled: boolean;
+    };
+    listEditButton: {
+        enabled: boolean;
+    };
+    listDeleteButton: {
+        enabled: boolean;
+    };
+    customRoutes: () => import("react").JSX.Element;
+    menu: {
+        title: string;
+        redirect: string;
+    }[];
+};
+export default createReportsResource;

package/dist/i18n/en.d.ts

@@ -0,0 +1,83 @@
+export declare const en: {
+    dash_reports: {
+        title: string;
+        units: {
+            seconds: string;
+            minutes: string;
+            hours: string;
+        };
+        dashboard: {
+            title: string;
+        };
+        period: {
+            open: string;
+            closed: string;
+            current: string;
+        };
+        back_to_list: string;
+        no_reports: string;
+        loading: string;
+        no_data: string;
+        no_rows: string;
+        other: string;
+        show_detail: string;
+        hide_detail: string;
+        week_of: string;
+        filters: {
+            title: string;
+            reset: string;
+            done: string;
+            start: string;
+            end: string;
+            granularity: string;
+            pivot: string;
+            no_pivot: string;
+        };
+        granularity: {
+            daily: string;
+            weekly: string;
+            monthly: string;
+            yearly: string;
+            total: string;
+            hourOfDay: string;
+            dayOfWeek: string;
+        };
+        viz: {
+            Bar: string;
+            Line: string;
+            Pie: string;
+            Doughnut: string;
+            Kpi: string;
+            Funnel: string;
+            Table: string;
+        };
+        funnel: {
+            step: string;
+            skipped: string;
+        };
+        table: {
+            period: string;
+        };
+        weekdays: {
+            monday: string;
+            tuesday: string;
+            wednesday: string;
+            thursday: string;
+            friday: string;
+            saturday: string;
+            sunday: string;
+        };
+        export: {
+            xlsx: string;
+            csv: string;
+        };
+        errors: {
+            spec: string;
+            list: string;
+            series: string;
+            dashboard: string;
+            widget: string;
+        };
+    };
+};
+export default en;