import { Link, LoaderFunctionArgs, useLoaderData } from "react-router"; import { useSearchParams } from "react-router"; import { useAppData } from "~/utils/data/useAppData"; import { DashboardLoaderData, loadDashboardData } from "~/utils/data/useDashboardData"; import { getTranslations } from "~/locale/i18next.server"; import { getAppDashboardStats } from "~/utils/services/appDashboardService"; import ProfileBanner from "~/components/app/ProfileBanner"; import { DashboardStats } from "~/components/ui/stats/DashboardStats"; import { getTenantIdFromUrl } from "~/utils/services/.server/urlService"; import { Stat } from "~/application/dtos/stats/Stat"; import InputSelect from "~/components/ui/input/InputSelect"; import PeriodHelper, { defaultPeriodFilter, PeriodFilters } from "~/utils/helpers/PeriodHelper"; import { useTranslation } from "react-i18next"; import ServerError from "~/components/ui/errors/ServerError"; import { serverTimingHeaders } from "~/modules/metrics/utils/defaultHeaders"; import { createMetrics } from "~/modules/metrics/services/.server/MetricTracker"; import { promiseHash } from "~/utils/promises/promiseHash"; import { getTenant } from "~/utils/db/tenants.db.server"; import { Fragment } from "react"; import { loadAppData } from "~/utils/data/.server/appData"; import { getUserHasPermission } from "~/utils/helpers/PermissionsHelper"; import { requireAuth } from "~/utils/loaders.middleware"; import { v2MetaFunction } from "~/utils/compat/v2MetaFunction"; import { appTenantPlanRequiredPath } from "~/utils/app/AppTenantStatusPaths"; import { evaluateDashboardModuleGates, getDashboardModuleDiagnostics, getVisibleDashboardModules, type DashboardModuleGateDiagnostic, } from "~/services/dashboard-registry/gating.server"; import type { DashboardModuleDefinition, DashboardModuleId } from "~/services/dashboard-registry/registry.server"; import { loadDashboardVM, type DashboardVM, type DashboardWidgetVM } from "~/services/dashboard/dashboard.server"; import { getFirstStepsChecklist } from "~/utils/services/.server/akP20OnboardingService"; export { serverTimingHeaders as headers }; const DASHBOARD_READ_PERMISSION = "dashboard.read"; const LEGACY_DASHBOARD_PERMISSION = "app.dashboard.view"; export const meta: v2MetaFunction = ({ data }) => [{ title: data?.title }]; type LoaderData = DashboardLoaderData & { title: string; stats: Stat[]; modules: DashboardModuleDefinition[]; moduleDiagnostics: DashboardModuleGateDiagnostic[]; dashboard: DashboardVM; firstStepsChecklist: Awaited>; }; function isDashboardModuleVisible(modules: readonly DashboardModuleDefinition[], moduleId: DashboardModuleId) { return modules.some((module) => module.id === moduleId); } function getSafeModuleNoticePath(diagnostic: DashboardModuleGateDiagnostic) { if (diagnostic.source === "plan") { return diagnostic.redirectPath?.startsWith("/") ? diagnostic.redirectPath : "/plan-required"; } return diagnostic.redirectPath?.startsWith("/") ? diagnostic.redirectPath : "/feature-disabled"; } export const loader = async ({ request, params }: LoaderFunctionArgs) => { const userInfo = await requireAuth({ request, params }); const { time, getServerTimingHeader } = await createMetrics({ request, params }, "app.$tenant.dashboard"); let { t } = await getTranslations(request); const { tenantId, appData } = await time( promiseHash({ tenantId: getTenantIdFromUrl(params), appData: loadAppData({ request, params, t, time }), }), "app.$tenant.dashboard.context" ); const tenant = await time(getTenant(tenantId), "getTenant"); if (!tenant) { throw Response.json({ error: t("app.dashboard.errors.tenantNotFound") }, { status: 404 }); } const { stats, dashboardData, dashboard, firstStepsChecklist, moduleDecisions } = await time( promiseHash({ stats: getAppDashboardStats({ t, tenant, gte: PeriodHelper.getGreaterThanOrEqualsFromRequest({ request }) }), dashboardData: loadDashboardData({ request, params }), dashboard: loadDashboardVM({ request, params }), firstStepsChecklist: getFirstStepsChecklist({ tenantId, userId: userInfo.userId }), moduleDecisions: evaluateDashboardModuleGates({ request, params, subscription: appData.mySubscription, redirectPaths: { "feature-flag": `/feature-disabled?tenant=${encodeURIComponent(tenant.slug)}`, plan: appTenantPlanRequiredPath({ tenant: tenant.slug }), }, }), }), "app.$tenant.dashboard.details" ); const data: LoaderData = { title: `${t("app.sidebar.dashboard")} | ${process.env.APP_NAME}`, ...dashboardData, stats, modules: getVisibleDashboardModules(moduleDecisions), moduleDiagnostics: getDashboardModuleDiagnostics(moduleDecisions), dashboard, firstStepsChecklist, }; return Response.json(data, { headers: getServerTimingHeader() }); }; export default function DashboardRoute() { const { t } = useTranslation(); const appData = useAppData(); const data = useLoaderData(); const [searchParams, setSearchParams] = useSearchParams(); const canViewSummary = isDashboardModuleVisible(data.modules, "summary-stats"); const canViewDashboard = getUserHasPermission(appData, DASHBOARD_READ_PERMISSION) || getUserHasPermission(appData, LEGACY_DASHBOARD_PERMISSION); const activeRole = data.dashboard.roles.find((role) => role.role === data.dashboard.activeRole) ?? data.dashboard.roles[0]; return (
{/*Page header */}
{canViewDashboard ? ( {activeRole ? (

{t("app.dashboard.title")}

{t(activeRole.descriptionKey)}

{data.dashboard.roles.map((role) => ( {t(role.nameKey)} ))}
{t("app.dashboard.live.enabled")} {t("app.dashboard.live.lastUpdated", { at: data.dashboard.generatedAt })} {data.dashboard.canCustomize ? {t("app.dashboard.customize.available")} : null}
{activeRole.widgets.map((widget) => ( ))}
) : null} {canViewSummary && data.stats.length > 0 && (

{t("app.dashboard.summary")}

{ return { value: f.value, name: t(f.name), }; })} setValue={(value) => { if (value) { searchParams.set("period", value?.toString() ?? ""); } else { searchParams.delete("period"); } setSearchParams(searchParams); }} />
)} {data.moduleDiagnostics.length > 0 && (
{data.moduleDiagnostics.map((diagnostic) => (
{diagnostic.reason === "plan-required" ? t("app.dashboard.moduleDiagnostics.planRequiredTitle") : t("app.dashboard.moduleDiagnostics.unavailableTitle")}
{diagnostic.reason === "plan-required" ? t("app.dashboard.moduleDiagnostics.planRequiredDescription") : t("app.dashboard.moduleDiagnostics.unavailableDescription")}
{diagnostic.reason === "plan-required" ? t("app.dashboard.moduleDiagnostics.viewPlanOptions") : t("app.dashboard.moduleDiagnostics.learnMore")}
))}
)} {!data.firstStepsChecklist.dismissed && (

{t("onboarding.firstSteps.dashboardTitle")}

{data.firstStepsChecklist.percentComplete === 100 ? t("onboarding.firstSteps.dashboardComplete") : t("onboarding.firstSteps.dashboardProgress", { completed: data.firstStepsChecklist.completedCount, total: data.firstStepsChecklist.totalCount, })}

{t("onboarding.firstSteps.open")}
)}
) : (
{t("app.dashboard.noPermission")}
)}
); } function DashboardWidgetCard({ widget }: { widget: DashboardWidgetVM }) { const { t } = useTranslation(); return (

{t(widget.titleKey)}

{t(widget.descriptionKey)}

{!widget.visible ? (

{t("app.dashboard.widgets.permissionHidden")}

) : widget.metrics.length > 0 ? (
{widget.metrics.map((metric) => (
{t(metric.labelKey)}
{metric.value}
))}
) : widget.items.length > 0 ? (
    {widget.items.map((item) => (
  • {item.href ? ( {item.labelKey ? t(item.labelKey) : item.label} ) : ( {item.labelKey ? t(item.labelKey) : item.label} )} {item.meta ? {item.meta} : null}
  • ))}
) : (

{t("app.dashboard.widgets.empty")}

)}
); } export function ErrorBoundary() { return ; }