Skip to content

Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️

14.3 KB
Raw Blame
import {Button, Group, Select, Skeleton, Table as MantineTable} from '@mantine/core';
import {t} from '@lingui/macro';
import {DatePickerInput, DatesRangeValue} from "@mantine/dates";
import {IconArrowDown, IconArrowsSort, IconArrowUp, IconCalendar} from "@tabler/icons-react";
import React, {useMemo, useState} from "react";
import {PageTitle} from "../PageTitle";
import {DownloadCsvButton} from "../DownloadCsvButton";
import {Table, TableHead} from "../Table";
import '@mantine/dates/styles.css';
import {useGetEventReport} from "../../../queries/useGetEventReport.ts";
import {useParams} from "react-router";
import {Event, EventType, IdParam} from "../../../types.ts";
import dayjs from 'dayjs';
import utc from 'dayjs/plugin/utc';
import timezone from 'dayjs/plugin/timezone';
import {NoResultsSplash} from "../NoResultsSplash";
import {OccurrenceSelect} from "../OccurrenceSelect";
import {useGetAllEventOccurrences} from "../../../queries/useGetAllEventOccurrences.ts";
import classes from './ReportTable.module.scss';

dayjs.extend(utc);
dayjs.extend(timezone);

interface Column<T> {
    key: keyof T;
    label: string;
    render?: (value: any, row: T) => React.ReactNode;
    sortable?: boolean;
}

interface ReportProps<T> {
    title: string;
    columns: Column<T>[];
    event: Event
    isLoading?: boolean;
    showDateFilter?: boolean;
    showOccurrenceFilter?: boolean;
    defaultStartDate?: Date;
    defaultEndDate?: Date;
    onDateRangeChange?: (range: [Date | null, Date | null]) => void;
    enableDownload?: boolean;
    downloadFileName?: string;
    showCustomDatePicker?: boolean;
}

const getTimePeriods = () => [
    {value: '24h', label: t`Last 24 hours`},
    {value: '48h', label: t`Last 48 hours`},
    {value: '7d', label: t`Last 7 days`},
    {value: '14d', label: t`Last 14 days`},
    {value: '30d', label: t`Last 30 days`},
    {value: '90d', label: t`Last 90 days`},
    {value: '6m', label: t`Last 6 months`},
    {value: 'ytd', label: t`Year to date`},
    {value: '12m', label: t`Last 12 months`},
    {value: 'custom', label: t`Custom Range`}
];

const ReportTable = <T extends Record<string, any>>({
                                                        title,
                                                        columns,
                                                        showDateFilter = true,
                                                        showOccurrenceFilter = true,
                                                        defaultStartDate = new Date(new Date().setMonth(new Date().getMonth() - 3)),
                                                        defaultEndDate = new Date(),
                                                        onDateRangeChange,
                                                        enableDownload = true,
                                                        downloadFileName = 'report.csv',
                                                        showCustomDatePicker = false,
                                                        event
                                                    }: ReportProps<T>) => {
    const [dateRange, setDateRange] = useState<[Date | null, Date | null]>(() => [
        dayjs(defaultStartDate).tz(event.timezone).startOf('day').toDate(),
        dayjs(defaultEndDate).tz(event.timezone).endOf('day').toDate()
    ]);
    const [selectedPeriod, setSelectedPeriod] = useState('90d');
    const [showDatePickerInput, setShowDatePickerInput] = useState(showCustomDatePicker);
    const [sortField, setSortField] = useState<keyof T | null>(null);
    const [sortDirection, setSortDirection] = useState<'asc' | 'desc' | null>(null);
    const [selectedOccurrenceId, setSelectedOccurrenceId] = useState<IdParam | undefined>(undefined);
    const {reportType, eventId} = useParams();

    const isRecurring = event?.type === EventType.RECURRING;
    const occurrences = useGetAllEventOccurrences(eventId, isRecurring && showOccurrenceFilter).data ?? [];

    const reportQuery = useGetEventReport(eventId, reportType, dateRange[0], dateRange[1], selectedOccurrenceId);
    const data = (reportQuery.data || []) as T[];

    const calculateDateRange = (period: string): [Date | null, Date | null] => {
        if (period === 'custom') {
            setShowDatePickerInput(true);
            return dateRange;
        }
        setShowDatePickerInput(false);

        let end = dayjs().tz(event.timezone).endOf('day');
        let start = dayjs().tz(event.timezone);

        switch (period) {
            case '24h':
                start = start.startOf('day');
                end = start.endOf('day');
                break;
            case '48h':
                start = start.subtract(1, 'day').startOf('day');
                end = start.endOf('day').add(1, 'day');
                break;
            case '7d':
                start = start.subtract(6, 'day').startOf('day');
                break;
            case '14d':
                start = start.subtract(13, 'day').startOf('day');
                break;
            case '30d':
                start = start.subtract(29, 'day').startOf('day');
                break;
            case '90d':
                start = start.subtract(89, 'day').startOf('day');
                break;
            case '6m':
                start = start.subtract(6, 'month').startOf('day');
                break;
            case 'ytd':
                start = start.startOf('year');
                break;
            case '12m':
                start = start.subtract(12, 'month').startOf('day');
                break;
            default:
                return [null, null];
        }

        return [start.toDate(), end.toDate()];
    };

    const handlePeriodChange = (value: string | null) => {
        if (!value) return;
        setSelectedPeriod(value);
        const newRange = calculateDateRange(value);
        setDateRange(newRange);
        onDateRangeChange?.(newRange);
    };

    const handleDateRangeChange = (newRange: DatesRangeValue<string>) => {
        const [start, end] = newRange;
        const tzStart = start ? dayjs(start).tz(event.timezone) : null;
        const tzEnd = end ? dayjs(end).tz(event.timezone) : null;

        const tzRange: [Date | null, Date | null] = [
            tzStart?.toDate() || null,
            tzEnd?.toDate() || null
        ];

        setDateRange(tzRange);
        onDateRangeChange?.(tzRange);
    };

    const handleSort = (field: keyof T) => {
        if (sortField === field) {
            if (sortDirection === 'asc') setSortDirection('desc');
            else if (sortDirection === 'desc') {
                setSortDirection(null);
                setSortField(null);
            } else setSortDirection('asc');
        } else {
            setSortField(field);
            setSortDirection('asc');
        }
    };

    const getSortIcon = (field: keyof T) => {
        if (sortField !== field) return <IconArrowsSort size={16}/>;
        if (sortDirection === 'asc') return <IconArrowUp size={16}/>;
        if (sortDirection === 'desc') return <IconArrowDown size={16}/>;
        return <IconArrowsSort size={16} className="ml-2 text-gray-400"/>;
    };

    const sortedData = useMemo(() => {
        return [...data].sort((a, b) => {
            if (!sortField || !sortDirection) return 0;
            const aValue = a[sortField];
            const bValue = b[sortField];

            const aNum = Number(aValue);
            const bNum = Number(bValue);

            if (!isNaN(aNum) && !isNaN(bNum)) {
                return sortDirection === 'asc' ? aNum - bNum : bNum - aNum;
            }

            if (typeof aValue === 'string' && typeof bValue === 'string') {
                return sortDirection === 'asc'
                    ? aValue.toLowerCase().localeCompare(bValue.toLowerCase())
                    : bValue.toLowerCase().localeCompare(aValue.toLowerCase());
            }

            return 0;
        });
    }, [data, sortField, sortDirection]);

    const csvHeaders = columns.map(col => col.label);
    const csvData = sortedData.map(row =>
        columns.map(col => {
            const value = row[col.key];
            return typeof value === 'number' ? value.toString() : value;
        })
    );

    const loadingMessage = () => {
        const wrapper = (message: React.ReactNode) => (
            <MantineTable.Tr>
                <MantineTable.Td colSpan={columns.length} align="center">
                    {message}
                </MantineTable.Td>
            </MantineTable.Tr>
        );

        if (reportQuery.isLoading) {
            return wrapper(t`Loading...`);
        }

        if (showDateFilter && (!dateRange[0] || !dateRange[1])) {
            return wrapper(t`No data to show. Please select a date range`);
        }

        if (!showDateFilter && dateRange[0] && dateRange[1]) {
            return wrapper(t`No data available`);
        }
    };

    if (reportQuery.isLoading) {
        return (
            <>
                <Group justify="space-between" mb="xl">
                    <Skeleton height={32} width={200}/>
                    <Group gap="sm">
                        <Skeleton height={32} width={200}/>
                        <Skeleton height={32} width={130}/>
                    </Group>
                </Group>
                <Skeleton height={300} radius="md"/>
            </>
        );
    }

    if (reportQuery.isError && !reportQuery.data) {
        return (
            <NoResultsSplash
                heading={t`Couldn't load this report`}
                imageHref={'/blank-slate/reports.svg'}
                subHeading={<p>{t`Check your connection and try again.`}</p>}
            >
                <Button variant="default" loading={reportQuery.isFetching} onClick={() => reportQuery.refetch()}>
                    {t`Try again`}
                </Button>
            </NoResultsSplash>
        );
    }

    if (reportQuery.isFetched && !reportQuery.isLoading && !data.length) {
        return (
            <NoResultsSplash
                heading={t`Nothing to show yet`}
                imageHref={'/blank-slate/reports.svg'}
                subHeading={(
                    <>
                        <p>
                            {t`Once you start collecting data, you'll see it here.`}
                        </p>
                    </>
                )}
            />
        );
    }

    return (
        <>
            <Group justify="space-between" mb="md">
                <PageTitle>{title}</PageTitle>
                <Group justify="flex-end" align="center" gap="sm">
                    {isRecurring && showOccurrenceFilter && occurrences.length > 0 && event?.timezone && (
                        <OccurrenceSelect
                            occurrences={occurrences}
                            timezone={event.timezone}
                            value={selectedOccurrenceId ? String(selectedOccurrenceId) : null}
                            onChange={(value) => setSelectedOccurrenceId(value ? Number(value) : undefined)}
                            placeholder={t`All Occurrences`}
                            clearable
                        />
                    )}
                    {showDateFilter && (
                        <Select
                            style={{minWidth: '200px'}}
                            placeholder={t`Select time period`}
                            data={getTimePeriods()}
                            value={selectedPeriod}
                            onChange={handlePeriodChange}
                            leftSection={<IconCalendar stroke={1.5} size={20}/>}
                            mb="0"
                            className={classes.periodSelect}
                        />
                    )}
                    {showDateFilter && showDatePickerInput && (
                        <DatePickerInput
                            style={{minWidth: '305px', marginBottom: '0'}}
                            leftSection={<IconCalendar stroke={1.5} size={20}/>}
                            type="range"
                            placeholder="Pick dates range"
                            value={dateRange}
                            onChange={handleDateRangeChange}
                            minDate={dayjs().subtract(1, 'year').tz(event.timezone).toDate()}
                            maxDate={dayjs().tz(event.timezone).toDate()}
                            className={classes.datePicker}
                        />
                    )}
                    {enableDownload && (
                        <DownloadCsvButton
                            headers={csvHeaders}
                            data={csvData}
                            filename={downloadFileName}
                            className={classes.downloadButton}
                        />
                    )}
                </Group>
            </Group>
            <Table>
                <TableHead>
                    <MantineTable.Tr>
                        {columns.map((column) => (
                            <MantineTable.Th
                                key={String(column.key)}
                                onClick={column.sortable ? () => handleSort(column.key) : undefined}
                                style={{cursor: column.sortable ? 'pointer' : 'default', minWidth: '180px'}}
                            >
                                <Group gap="xs" wrap={'nowrap'}>
                                    {t`${column.label}`}
                                    {column.sortable && getSortIcon(column.key)}
                                </Group>
                            </MantineTable.Th>
                        ))}
                    </MantineTable.Tr>
                </TableHead>
                <MantineTable.Tbody>
                    {!sortedData.length && loadingMessage()}
                    {sortedData.map((row, index) => (
                        <MantineTable.Tr key={index}>
                            {columns.map((column) => (
                                <MantineTable.Td key={String(column.key)}>
                                    {column.render
                                        ? column.render(row[column.key], row)
                                        : row[column.key]
                                    }
                                </MantineTable.Td>
                            ))}
                        </MantineTable.Tr>
                    ))}
                </MantineTable.Tbody>
            </Table>
        </>
    );
};

export default ReportTable;