Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

7.8 KB
Raw Blame
import type { IServiceEvent } from '@openpanel/core';
import type { ColumnDef } from '@tanstack/react-table';
import { useEventDrawer } from '../use-event-drawer';
import { ColumnCreatedAt } from '@/components/column-created-at';
import { EventIcon } from '@/components/events/event-icon';
import { ProjectLink } from '@/components/links';
import { ProfileAvatar } from '@/components/profiles/profile-avatar';
import { SerieIcon } from '@/components/report-chart/common/serie-icon';
import { KeyValueGrid } from '@/components/ui/key-value-grid';
import { useNumber } from '@/hooks/use-numer-formatter';
import { pushModal } from '@/modals';
import { getProfileName } from '@/utils/getters';

export function useColumns() {
  const { openEvent } = useEventDrawer();
  const number = useNumber();
  const columns: ColumnDef<IServiceEvent>[] = [
    {
      accessorKey: 'createdAt',
      header: 'Created at',
      size: ColumnCreatedAt.size,
      cell: ({ row }) => {
        const session = row.original;
        return <ColumnCreatedAt>{session.createdAt}</ColumnCreatedAt>;
      },
    },
    {
      size: 300,
      accessorKey: 'name',
      header: 'Name',
      cell({ row }) {
        const { name, path, revenue } = row.original;
        const fullTitle =
          name === 'screen_view'
            ? path
            : name === 'revenue' && revenue
              ? `${name} (${number.currency(revenue / 100)})`
              : name.replace(/_/g, ' ');

        const renderName = () => {
          if (name === 'screen_view') {
            if (path.includes('/')) {
              return path;
            }

            return (
              <>
                <span className="text-muted-foreground">Screen: </span>
                {path}
              </>
            );
          }

          if (name === 'revenue' && revenue) {
            return `${name} (${number.currency(revenue / 100)})`;
          }

          if (name.startsWith('ai_')) {
            const model = row.original.properties?.ai_model;
            return (
              <>
                {name.replace(/_/g, ' ')}
                {typeof model === 'string' && model && (
                  <span className="ml-2 text-muted-foreground">{model}</span>
                )}
              </>
            );
          }

          return name.replace(/_/g, ' ');
        };

        return (
          <div className="flex min-w-0 items-center gap-2">
            <button
              className="shrink-0 transition-transform hover:scale-105"
              onClick={() => {
                pushModal('EditEvent', {
                  id: row.original.id,
                });
              }}
              type="button"
            >
              <EventIcon
                meta={row.original.meta}
                name={row.original.name}
                size="sm"
              />
            </button>
            <span className="flex min-w-0 flex-1 gap-2">
              <button
                className="min-w-0 max-w-full truncate text-left font-medium hover:underline"
                onClick={() => {
                  openEvent({
                    id: row.original.id,
                    createdAt: row.original.createdAt,
                  });
                }}
                title={fullTitle}
                type="button"
              >
                <span className="block truncate">{renderName()}</span>
              </button>
            </span>
          </div>
        );
      },
    },
    {
      accessorKey: 'profileId',
      header: 'Profile',
      cell({ row }) {
        const { profile, profileId, deviceId } = row.original;
        if (profile) {
          return (
            <ProjectLink
              className="group row items-center gap-2 whitespace-nowrap font-medium hover:underline"
              params={{ profileId: profile.id }}
              to="/profiles/$profileId"
            >
              <ProfileAvatar size="sm" {...profile} />
              {getProfileName(profile)}
            </ProjectLink>
          );
        }

        if (profileId && profileId !== deviceId) {
          return (
            <ProjectLink
              className="whitespace-nowrap font-medium hover:underline"
              params={{ profileId }}
              to="/profiles/$profileId"
            >
              Unknown
            </ProjectLink>
          );
        }

        if (deviceId) {
          return (
            <ProjectLink
              className="whitespace-nowrap font-medium hover:underline"
              params={{ profileId: deviceId }}
              to="/profiles/$profileId"
            >
              Anonymous
            </ProjectLink>
          );
        }

        return null;
      },
    },
    {
      accessorKey: 'sessionId',
      header: 'Session ID',
      size: 100,
      meta: {
        hidden: true,
      },
      cell({ row }) {
        const { sessionId } = row.original;
        return (
          <ProjectLink
            className="whitespace-nowrap font-medium hover:underline"
            params={{ sessionId }}
            to="/sessions/$sessionId"
          >
            {sessionId.slice(0, 6)}
          </ProjectLink>
        );
      },
    },
    {
      accessorKey: 'deviceId',
      header: 'Device ID',
      size: 320,
      meta: {
        hidden: true,
      },
    },
    {
      accessorKey: 'country',
      header: 'Country',
      size: 150,
      cell({ row }) {
        const { country, city } = row.original;
        return (
          <div className="row min-w-0 items-center gap-2">
            <SerieIcon name={country} />
            <span className="truncate">{city}</span>
          </div>
        );
      },
    },
    {
      accessorKey: 'os',
      header: 'OS',
      size: 130,
      cell({ row }) {
        const { os } = row.original;
        return (
          <div className="row min-w-0 items-center gap-2">
            <SerieIcon name={os} />
            <span className="truncate">{os}</span>
          </div>
        );
      },
    },
    {
      accessorKey: 'browser',
      header: 'Browser',
      size: 110,
      cell({ row }) {
        const { browser } = row.original;
        return (
          <div className="row min-w-0 items-center gap-2">
            <SerieIcon name={browser} />
            <span className="truncate">{browser}</span>
          </div>
        );
      },
    },
    {
      accessorKey: 'groups',
      header: 'Groups',
      size: 200,
      meta: {
        hidden: true,
      },
      cell({ row }) {
        const { groups } = row.original;
        if (!groups?.length) {
          return null;
        }
        return (
          <div className="flex flex-wrap gap-1">
            {groups.map((g) => (
              <span
                className="rounded bg-muted px-1.5 py-0.5 text-xs tabular-nums"
                key={g}
              >
                {g}
              </span>
            ))}
          </div>
        );
      },
    },
    {
      accessorKey: 'properties',
      header: 'Properties',
      size: 400,
      meta: {
        hidden: true,
      },
      cell({ row }) {
        const { properties } = row.original;
        const filteredProperties = Object.fromEntries(
          Object.entries(properties || {}).filter(
            ([key]) => !key.startsWith('__')
          )
        );
        const items = Object.entries(filteredProperties);
        const limit = 2;
        const data = items.slice(0, limit).map(([key, value]) => ({
          name: key,
          value,
        }));
        if (items.length > limit) {
          data.push({
            name: '',
            value: `${items.length - limit} more item${items.length - limit === 1 ? '' : 's'}`,
          });
        }

        if (data.length === 0) {
          return null;
        }

        return <KeyValueGrid className="w-full" data={data} />;
      },
    },
  ];

  return columns;
}