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

package/dist/i18n/es.d.ts

@@ -0,0 +1,83 @@
+export declare const es: {
+    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 es;

package/{src/index.tsx → dist/index.d.ts}

@@ -1,12 +1,3 @@
-/**
- * @dashadmin/dash-reports — the domain-agnostic reporting UI.
- *
- * Renders a report entirely from the spec app/ReportCore serves for it, so a
- * new report is a backend definition plus one resource entry, with no change
- * here.
- */
-
-// Core — framework-agnostic, no chart or MUI import.
 export * from './core/types';
 export { useReportSpec } from './core/useReportSpec';
 export { useReportSeries } from './core/useReportSeries';
@@ -16,37 +7,18 @@ export { useReportPreview } from './core/useReportPreview';
 export { useReportExport } from './core/useReportExport';
 export { toQueryParams } from './core/queryParams';
 export { formatBucket, formatBucketLong } from './core/formatBucket';
-export {
-  registerVisualization,
-  getVisualization,
-  registeredVisualizations,
-} from './core/visualizationRegistry';
+export { registerVisualization, getVisualization, registeredVisualizations, } from './core/visualizationRegistry';
 export type { VisualizationProps } from './core/visualizationRegistry';
-
-// MUI / Chart.js adapter. Importing it registers the default widget set.
 export * from './adapters/mui';
-
-// Composed UI.
 export { ReportPage } from './ReportPage';
 export type { ReportPageProps } from './ReportPage';
 export { ReportFilters } from './ReportFilters';
 export { ReportsModule } from './ReportsModule';
 export { ReportsDashboard } from './ReportsDashboard';
 export { TenantDashboard } from './TenantDashboard';
-export {
-  useDashboardTenants,
-  useTenantDashboard,
-  useTenantPeriods,
-} from './core/useDashboard';
-export type {
-  DashboardWidget,
-  DashboardTenant,
-  DashboardPeriod,
-  DashboardData,
-} from './core/useDashboard';
+export { useDashboardTenants, useTenantDashboard, useTenantPeriods, } from './core/useDashboard';
+export type { DashboardWidget, DashboardTenant, DashboardPeriod, DashboardData, } from './core/useDashboard';
 export { ReportsIndex } from './ReportsIndex';
 export { createReportsResource } from './createReportsResource';
 export type { CreateReportsResourceOptions } from './createReportsResource';
-
-// Strings, merged at app entry — see dash-admin's mergeTranslations.
 export { en as reportsEn, es as reportsEs } from './i18n';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dashadmin/dash-reports",
-	"version": "1.3.73",
+	"version": "1.3.74-srcfree.1",
 	"license": "MIT",
 	"main": "dist/index.js",
 	"devDependencies": {
@@ -12,11 +12,11 @@
 	"dependencies": {
 		"@mui/material": "^9.3.0",
 		"chart.js": "^4.5.0",
-		"@dashadmin/dash-axios-hook": "1.3.73",
+		"@dashadmin/dash-axios-hook": "1.3.74-srcfree.1",
 		"react-chartjs-2": "^5.3.1"
 	},
 	"module": "dist/index.js",
-	"types": "./src/index.tsx",
+	"types": "./dist/index.d.ts",
 	"exports": {
 		".": "./dist/index.js",
 		"./*": "./dist/*.js",
@@ -27,22 +27,25 @@
 		"registry": "https://registry.npmjs.org"
 	},
 	"scripts": {
-		"build": "tsup"
+		"build": "tsup && pnpm run build:types",
+		"build:types": "tsc -p tsconfig.json --declaration --emitDeclarationOnly --noEmit false --outDir dist --rootDir src --skipLibCheck || true"
 	},
 	"type": "module",
 	"files": [
-		"dist",
-		"src"
+		"dist"
 	],
 	"typesVersions": {
 		"*": {
+			"dist/*": [
+				"dist/*"
+			],
 			"src/*": [
-				"src/*",
-				"src/*/index"
+				"dist/*",
+				"dist/*/index"
 			],
 			"*": [
-				"src/*",
-				"src/*/index"
+				"dist/*",
+				"dist/*/index"
 			]
 		}
 	}

package/src/ReportFilters.tsx

@@ -1,145 +0,0 @@
-import {
-  Box, Chip, FormControl, InputLabel, MenuItem, OutlinedInput, Select, Stack, TextField,
-} from '@mui/material';
-import { label } from './core/label';
-import type { ReportFilterState, ReportSpec, TranslateFn } from './core/types';
-
-export interface ReportFiltersProps {
-  spec: ReportSpec;
-  value: ReportFilterState;
-  onChange: (next: ReportFilterState) => void;
-  translate: TranslateFn;
-}
-
-/**
- * The filter form.
- *
- * Laid out as a single column because it lives in a right-hand drawer — every
- * control gets full width, so long option labels (a restaurant name, a product)
- * are readable instead of truncated into a narrow inline slot.
- *
- * One filter set for the whole report, not per chart: every visualisation on
- * the page reads the same query, and per-chart filters would imply they can
- * disagree. Because the drawer hides that state while closed, ReportPage keeps
- * a summary of what is applied visible in the header — a filter nobody can see
- * is a filter they forget is on.
- */
-export function ReportFilters({ spec, value, onChange, translate }: ReportFiltersProps) {
-  const set = (patch: Partial<ReportFilterState>) => onChange({ ...value, ...patch });
-
-  const setDimension = (key: string, selected: Array<string | number | boolean>) =>
-    onChange({ ...value, dimensions: { ...value.dimensions, [key]: selected } });
-
-  return (
-    <Stack spacing={2.5} sx={{ p: 2.5, width: { xs: '86vw', sm: 360 } }}>
-      <TextField
-        type="date"
-        size="small"
-        fullWidth
-        label={translate('dash_reports.filters.start', { _: 'From' })}
-        slotProps={{ inputLabel: { shrink: true } }}
-        value={value.start}
-        onChange={(e) => set({ start: e.target.value })}
-      />
-
-      <TextField
-        type="date"
-        size="small"
-        fullWidth
-        label={translate('dash_reports.filters.end', { _: 'To' })}
-        slotProps={{ inputLabel: { shrink: true } }}
-        value={value.end}
-        onChange={(e) => set({ end: e.target.value })}
-      />
-
-      <FormControl size="small" fullWidth>
-        <InputLabel id="report-granularity">
-          {translate('dash_reports.filters.granularity', { _: 'Group by' })}
-        </InputLabel>
-        <Select
-          labelId="report-granularity"
-          label={translate('dash_reports.filters.granularity', { _: 'Group by' })}
-          value={value.granularity}
-          onChange={(e) => set({ granularity: e.target.value as ReportFilterState['granularity'] })}
-        >
-          {spec.granularities.map((g) => (
-            <MenuItem key={g} value={g}>
-              {translate(`dash_reports.granularity.${g}`, { _: g })}
-            </MenuItem>
-          ))}
-        </Select>
-      </FormControl>
-
-      {spec.dimensions.length > 0 && (
-        <FormControl size="small" fullWidth>
-          <InputLabel id="report-pivot">
-            {translate('dash_reports.filters.pivot', { _: 'Split by' })}
-          </InputLabel>
-          <Select
-            labelId="report-pivot"
-            label={translate('dash_reports.filters.pivot', { _: 'Split by' })}
-            value={value.pivot ?? ''}
-            onChange={(e) => set({ pivot: e.target.value || undefined })}
-          >
-            {/* No split is a real choice, not an absence — with none, the chart
-                shows one series per metric instead. */}
-            <MenuItem value="">
-              {translate('dash_reports.filters.no_pivot', { _: 'Nothing' })}
-            </MenuItem>
-            {spec.dimensions.map((d) => (
-              <MenuItem key={d.key} value={d.key}>
-                {label(translate, d.label, d.labelText)}
-              </MenuItem>
-            ))}
-          </Select>
-        </FormControl>
-      )}
-
-      {spec.dimensions
-        .filter((d) => (d.values?.length ?? 0) > 0)
-        .map((dimension) => {
-          const selected = value.dimensions[dimension.key] ?? [];
-
-          return (
-            <FormControl key={dimension.key} size="small" fullWidth>
-              <InputLabel id={`report-dim-${dimension.key}`}>
-                {label(translate, dimension.label, dimension.labelText)}
-              </InputLabel>
-              <Select
-                labelId={`report-dim-${dimension.key}`}
-                multiple={dimension.multiple !== false}
-                value={selected}
-                input={<OutlinedInput label={label(translate, dimension.label, dimension.labelText)} />}
-                onChange={(e) => {
-                  const next = e.target.value;
-                  setDimension(dimension.key, Array.isArray(next) ? next : [next]);
-                }}
-                renderValue={(picked) => (
-                  <Box sx={{ display: 'flex', flexWrap: 'wrap', gap: 0.5 }}>
-                    {(Array.isArray(picked) ? picked : [picked]).map((v) => {
-                      const option = dimension.values?.find((o) => String(o.value) === String(v));
-                      return (
-                        <Chip
-                          key={String(v)}
-                          size="small"
-                          label={option ? label(translate, option.label, option.labelText) : String(v)}
-                        />
-                      );
-                    })}
-                  </Box>
-                )}
-              >
-                {dimension.values?.map((option) => (
-                  <MenuItem key={String(option.value)} value={option.value as string}>
-                    {label(translate, option.label, option.labelText)}
-                  </MenuItem>
-                ))}
-              </Select>
-            </FormControl>
-          );
-        })}
-    </Stack>
-  );
-}
-
-export default ReportFilters;

package/src/ReportFiltersDrawer.tsx

@@ -1,73 +0,0 @@
-import { Box, Button, Divider, Drawer, IconButton, Stack, Typography, useTheme } from '@mui/material';
-import { ReportFilters } from './ReportFilters';
-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;
-}
-
-/**
- * The filter panel, anchored right.
- *
- * Changes apply live rather than behind an "Apply" button: the charts already
- * refetch on every filter change and keep the previous result visible while
- * loading, so there is nothing for a confirm step to protect against — it would
- * only add a click and a second source of truth for "what is currently applied".
- *
- * `keepMounted` because the drawer holds live form state; unmounting it on
- * close would reset every select the moment the user peeked at the chart.
- */
-export function ReportFiltersDrawer({
-  open, onClose, spec, value, onChange, onReset, translate,
-}: ReportFiltersDrawerProps) {
-  const theme = useTheme();
-
-  return (
-    <Drawer
-      anchor="right"
-      open={open}
-      onClose={onClose}
-      keepMounted
-      slotProps={{ paper: { sx: { backgroundImage: 'none' } } }}
-    >
-      <Stack sx={{ height: '100%' }}>
-        <Stack
-          direction="row"
-          sx={{ alignItems: 'center', justifyContent: 'space-between', px: 2.5, py: 2 }}
-        >
-          <Typography variant="h6" sx={{ color: theme.palette.text.primary }}>
-            {translate('dash_reports.filters.title', { _: 'Filters' })}
-          </Typography>
-          <IconButton onClick={onClose} size="small" aria-label={translate('ra.action.close', { _: 'Close' })}>
-            <Box component="span" sx={{ fontSize: 20, lineHeight: 1 }}>×</Box>
-          </IconButton>
-        </Stack>
-
-        <Divider />
-
-        <Box sx={{ flex: 1, overflowY: 'auto' }}>
-          <ReportFilters spec={spec} value={value} onChange={onChange} translate={translate} />
-        </Box>
-
-        <Divider />
-
-        <Stack direction="row" spacing={1} sx={{ p: 2 }}>
-          <Button fullWidth variant="outlined" onClick={onReset}>
-            {translate('dash_reports.filters.reset', { _: 'Reset' })}
-          </Button>
-          <Button fullWidth variant="contained" onClick={onClose}>
-            {translate('dash_reports.filters.done', { _: 'Done' })}
-          </Button>
-        </Stack>
-      </Stack>
-    </Drawer>
-  );
-}
-
-export default ReportFiltersDrawer;

package/src/ReportPage.tsx

@@ -1,280 +0,0 @@
-import { useEffect, useMemo, useState } from 'react';
-import {
-  Alert, Badge, Box, Button, Card, CardContent, Chip, Divider, LinearProgress, Stack, Tab, Tabs, Typography, useTheme,
-} from '@mui/material';
-import { useReportSpec } from './core/useReportSpec';
-import { label } from './core/label';
-import { visualizationBoxSx } from './core/visualizationLayout';
-import { useReportSeries } from './core/useReportSeries';
-import { useReportTable } from './core/useReportTable';
-import { getVisualization } from './core/visualizationRegistry';
-import { ReportFiltersDrawer } from './ReportFiltersDrawer';
-import { DetailTable } from './adapters/mui/TableWidget';
-import { useReportExport } from './core/useReportExport';
-import type { ReportFilterState, TranslateFn, VisualizationType } from './core/types';
-import './adapters/mui';
-
-export interface ReportPageProps {
-  reportKey: string;
-  translate: TranslateFn;
-  /** Optional heading override; defaults to the spec's translated title. */
-  title?: string;
-}
-
-function isoDaysAgo(days: number): string {
-  const d = new Date();
-  d.setDate(d.getDate() - days);
-  return d.toISOString().slice(0, 10);
-}
-
-/**
- * A whole report, rendered from its spec.
- *
- * Nothing here knows what the report contains — the filters, the available
- * chart types, the metric labels and the export formats all come from the
- * backend. Adding a report to a domain is a backend change plus one resource
- * entry; this component does not change.
- */
-export function ReportPage({ reportKey, translate, title }: ReportPageProps) {
-  const theme = useTheme();
-  const { spec, loading: specLoading, error: specError } = useReportSpec(reportKey);
-
-  const [filters, setFilters] = useState<ReportFilterState | null>(null);
-  const [activeViz, setActiveViz] = useState<VisualizationType | null>(null);
-  const [showDetail, setShowDetail] = useState(false);
-  const [filtersOpen, setFiltersOpen] = useState(false);
-
-  // One definition of "the default filters", used both to seed and to reset —
-  // two copies would drift and Reset would stop returning to the initial view.
-  const defaultFilters = useMemo<ReportFilterState | null>(
-    () =>
-      spec
-        ? {
-            start: isoDaysAgo(spec.defaultRangeDays ?? 30),
-            end: new Date().toISOString().slice(0, 10),
-            granularity: spec.defaultGranularity,
-            pivot: undefined,
-            dimensions: {},
-          }
-        : null,
-    [spec],
-  );
-
-  // Seed once the spec arrives — the default window and granularity are the
-  // report's to choose, not this component's.
-  useEffect(() => {
-    if (!defaultFilters || filters) return;
-
-    setFilters(defaultFilters);
-    // The report's declared default, not merely the first in the array —
-    // otherwise reordering visualizations silently changes what opens.
-    setActiveViz(
-      (spec?.defaultVisualization as VisualizationType | undefined)
-        ?? spec?.visualizations[0]?.type
-        ?? null,
-    );
-  }, [defaultFilters, filters, spec]);
-
-  /**
-   * What is currently narrowing the data, as readable chips.
-   *
-   * The drawer hides the filter state while closed, so this keeps it on screen:
-   * a filter someone cannot see is one they forget is applied, and then read the
-   * numbers as if it were not.
-   */
-  const activeChips = useMemo(() => {
-    if (!spec || !filters) return [];
-
-    const chips: string[] = [];
-
-    Object.entries(filters.dimensions ?? {}).forEach(([key, values]) => {
-      if (!Array.isArray(values) || values.length === 0) return;
-
-      const dimension = spec.dimensions.find((d) => d.key === key);
-      if (!dimension) return;
-
-      const labels = values.map((v) => {
-        const option = dimension.values?.find((o) => String(o.value) === String(v));
-        return option ? label(translate, option.label, option.labelText) : String(v);
-      });
-
-      chips.push(`${label(translate, dimension.label, dimension.labelText)}: ${labels.join(', ')}`);
-    });
-
-    if (filters.pivot) {
-      const dimension = spec.dimensions.find((d) => d.key === filters.pivot);
-      if (dimension) {
-        chips.push(
-          `${translate('dash_reports.filters.pivot', { _: 'Split by' })}: ${label(translate, dimension.label, dimension.labelText)}`,
-        );
-      }
-    }
-
-    return chips;
-  }, [spec, filters, translate]);
-
-  const { result, loading: seriesLoading, error: seriesError } = useReportSeries(reportKey, filters);
-  const table = useReportTable(reportKey, filters, showDetail);
-  const { exporting, exportReport } = useReportExport(reportKey);
-
-  const Visualization = useMemo(
-    () => (activeViz ? getVisualization(activeViz) : null),
-    [activeViz],
-  );
-
-  if (specLoading) return <LinearProgress />;
-
-  if (specError || !spec) {
-    return (
-      <Alert severity="error" sx={{ m: 2 }}>
-        {translate('dash_reports.errors.spec', { _: 'This report could not be loaded.' })}
-      </Alert>
-    );
-  }
-
-  return (
-    <Box sx={{ p: { xs: 2, md: 3 } }}>
-      <Stack direction="row" sx={{ alignItems: 'center', justifyContent: 'space-between', mb: 2, gap: 2, flexWrap: 'wrap' }}>
-        <Typography variant="h5" sx={{ color: theme.palette.text.primary }}>
-          {title ?? label(translate, spec.title, spec.titleText)}
-        </Typography>
-
-        <Stack direction="row" spacing={1}>
-          {spec.exporters.map((format) => (
-            <Button
-              key={format}
-              size="small"
-              variant="outlined"
-              disabled={exporting || !filters}
-              onClick={() => filters && exportReport(filters, format)}
-            >
-              {translate(`dash_reports.export.${format}`, { _: format.toUpperCase() })}
-            </Button>
-          ))}
-
-          <Badge badgeContent={activeChips.length} color="primary">
-            <Button size="small" variant="outlined" onClick={() => setFiltersOpen(true)}>
-              {translate('dash_reports.filters.title', { _: 'Filters' })}
-            </Button>
-          </Badge>
-        </Stack>
-      </Stack>
-
-      {/* The window is always narrowing the data, so it is always shown —
-          unlike the dimension chips, which appear only when something is set. */}
-      {filters && (
-        <Stack direction="row" sx={{ flexWrap: 'wrap', gap: 1, mb: 2, alignItems: 'center' }}>
-          <Chip
-            size="small"
-            variant="outlined"
-            label={`${filters.start} → ${filters.end}`}
-          />
-          <Chip
-            size="small"
-            variant="outlined"
-            label={translate(`dash_reports.granularity.${filters.granularity}`, { _: filters.granularity })}
-          />
-          {activeChips.map((chip) => (
-            <Chip
-              key={chip}
-              size="small"
-              label={chip}
-              onDelete={undefined}
-            />
-          ))}
-        </Stack>
-      )}
-
-      {seriesError && (
-        <Alert severity="warning" sx={{ mb: 2 }}>
-          {translate('dash_reports.errors.series', { _: 'This range could not be loaded.' })}
-        </Alert>
-      )}
-
-      <Card variant="outlined">
-        {spec.visualizations.length > 1 && (
-          <>
-            <Tabs
-              value={activeViz}
-              onChange={(_, next) => setActiveViz(next)}
-              variant="scrollable"
-              scrollButtons="auto"
-            >
-              {spec.visualizations.map((v) => (
-                <Tab
-                  key={v.type}
-                  value={v.type}
-                  label={translate(`dash_reports.viz.${v.type}`, { _: v.type })}
-                />
-              ))}
-            </Tabs>
-            <Divider />
-          </>
-        )}
-
-        {/* A refetch dims the existing chart rather than replacing it with a
-            skeleton — flashing an empty box on every filter change loses the
-            reader's place and reads as slower than it is. */}
-        <Box sx={{ position: 'relative', opacity: seriesLoading && result ? 0.55 : 1, transition: 'opacity 120ms' }}>
-          {seriesLoading && (
-            <LinearProgress sx={{ position: 'absolute', top: 0, left: 0, right: 0, zIndex: 1 }} />
-          )}
-
-          {/* A DEFINITE height for canvas charts. minHeight is a floor, not a
-              bound, and Chart.js with maintainAspectRatio:false grows to fill
-              its parent — which grows the parent, which resizes the canvas,
-              forever. */}
-          <CardContent>
-            {result && Visualization ? (
-              <Box sx={visualizationBoxSx(activeViz, 340)}>
-                <Visualization result={result} spec={spec} translate={translate} />
-              </Box>
-            ) : (
-              <Box sx={{ height: 340, display: 'grid', placeItems: 'center' }}>
-                <Typography variant="body2" sx={{ color: theme.palette.text.secondary }}>
-                  {seriesLoading
-                    ? translate('dash_reports.loading', { _: 'Loading…' })
-                    : translate('dash_reports.no_data', { _: 'No data for this range.' })}
-                </Typography>
-              </Box>
-            )}
-          </CardContent>
-        </Box>
-      </Card>
-
-      <Box sx={{ mt: 2 }}>
-        <Button size="small" onClick={() => setShowDetail((v) => !v)}>
-          {showDetail
-            ? translate('dash_reports.hide_detail', { _: 'Hide detail rows' })
-            : translate('dash_reports.show_detail', { _: 'Show detail rows' })}
-        </Button>
-      </Box>
-
-      {showDetail && (
-        <Card variant="outlined" sx={{ mt: 1 }}>
-          <DetailTable
-            page={table.page}
-            loading={table.loading}
-            currentPage={table.currentPage}
-            onPageChange={table.setPage}
-            translate={translate}
-          />
-        </Card>
-      )}
-
-      {filters && (
-        <ReportFiltersDrawer
-          open={filtersOpen}
-          onClose={() => setFiltersOpen(false)}
-          spec={spec}
-          value={filters}
-          onChange={setFilters}
-          onReset={() => defaultFilters && setFilters(defaultFilters)}
-          translate={translate}
-        />
-      )}
-    </Box>
-  );
-}
-
-export default ReportPage;