Files
T

194 lines
8.9 KiB
TypeScript

import type { LoaderFunctionArgs, MetaFunction } from "react-router";
import { Link, useLoaderData } from "react-router";
import { useTranslation } from "react-i18next";
import type { MetaTagsDto } from "~/application/dtos/seo/MetaTagsDto";
import { Badge } from "~/components/ui/badge";
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "~/components/ui/card";
import {
countAllKbsArticleDownvotes,
countAllKbsArticleUpvotes,
countAllKbsArticleViews,
countAllKbsViews,
} from "~/modules/knowledgeBase/db/kbAnalytics.db.server";
import { countKnowledgeBaseArticles } from "~/modules/knowledgeBase/db/kbArticles.db.server";
import { countKnowledgeBaseCategories } from "~/modules/knowledgeBase/db/kbCategories.db.server";
import { countKnowledgeBases } from "~/modules/knowledgeBase/db/knowledgeBase.db.server";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { useLocaleFormatters } from "~/locale/format";
import { getTranslations } from "~/locale/i18next.server";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
import { db } from "~/utils/db.server";
type LoaderData = {
metatags: MetaTagsDto;
summary: {
kbsTotal: number;
enabledBases: number;
articlesTotal: number;
publishedArticles: number;
draftArticles: number;
categoriesTotal: number;
kbsViews: number;
articlesViews: number;
articlesUpvotes: number;
articlesDownvotes: number;
};
recentArticles: {
id: string;
title: string;
language: string;
publishedAt: string | null;
updatedAt: string | null;
knowledgeBaseSlug: string;
knowledgeBaseTitle: string;
}[];
};
export const loader = async ({ request }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.kb.view");
const { t } = await getTranslations(request);
const [enabledBases, publishedArticles, draftArticles, recentArticles] = await Promise.all([
db.knowledgeBase.count({ where: { enabled: true } }),
db.knowledgeBaseArticle.count({ where: { publishedAt: { not: null } } }),
db.knowledgeBaseArticle.count({ where: { publishedAt: null } }),
db.knowledgeBaseArticle.findMany({
orderBy: { updatedAt: "desc" },
take: 8,
select: {
id: true,
title: true,
language: true,
publishedAt: true,
updatedAt: true,
knowledgeBase: { select: { slug: true, title: true } },
},
}),
]);
const data: LoaderData = {
metatags: [{ title: t("knowledgeBase.authoring.metaTitle") }],
summary: {
kbsTotal: await countKnowledgeBases(),
enabledBases,
articlesTotal: await countKnowledgeBaseArticles(),
publishedArticles,
draftArticles,
categoriesTotal: await countKnowledgeBaseCategories(),
kbsViews: await countAllKbsViews(),
articlesViews: await countAllKbsArticleViews(),
articlesUpvotes: await countAllKbsArticleUpvotes(),
articlesDownvotes: await countAllKbsArticleDownvotes(),
},
recentArticles: recentArticles.map((article) => ({
id: article.id,
title: article.title,
language: article.language,
publishedAt: article.publishedAt?.toISOString() ?? null,
updatedAt: article.updatedAt?.toISOString() ?? null,
knowledgeBaseSlug: article.knowledgeBase.slug,
knowledgeBaseTitle: article.knowledgeBase.title,
})),
};
return data;
};
export const meta: MetaFunction<typeof loader> = ({ data }) => data?.metatags || [];
export default function KnowledgeBaseOverviewRoute() {
const { t } = useTranslation();
const data = useLoaderData<LoaderData>();
const formatters = useLocaleFormatters();
const voteBalance = data.summary.articlesUpvotes - data.summary.articlesDownvotes;
return (
<div className="mx-auto mb-12 max-w-7xl space-y-5 px-4 py-4 sm:px-6 lg:px-8">
<div className="border-border flex flex-col gap-3 border-b pb-5 lg:flex-row lg:items-start lg:justify-between">
<div>
<h3 className="text-foreground text-lg leading-6 font-medium">{t("knowledgeBase.adminOverview.title")}</h3>
<p className="text-muted-foreground mt-1 text-sm">{t("admin.knowledgeOps.description")}</p>
</div>
<Badge color={data.summary.enabledBases > 0 ? "green" : "yellow"} withColorDot>
{data.summary.enabledBases > 0 ? t("admin.knowledgeOps.enabled") : t("admin.knowledgeOps.notEnabled")}
</Badge>
</div>
<dl className="grid gap-3 sm:grid-cols-2 xl:grid-cols-5">
<SummaryCard title={t("knowledgeBase.adminOverview.metrics.knowledgeBases")} value={data.summary.kbsTotal} />
<SummaryCard title={t("admin.knowledgeOps.metrics.enabledBases")} value={data.summary.enabledBases} />
<SummaryCard title={t("knowledgeBase.adminOverview.metrics.articles")} value={data.summary.articlesTotal} />
<SummaryCard title={t("admin.knowledgeOps.metrics.publishedArticles")} value={data.summary.publishedArticles} />
<SummaryCard title={t("admin.knowledgeOps.metrics.draftArticles")} value={data.summary.draftArticles} />
</dl>
<div className="grid gap-4 xl:grid-cols-[minmax(0,1fr)_minmax(320px,0.45fr)]">
<Card className="gap-4 rounded-lg py-5">
<CardHeader>
<div className="flex items-start justify-between gap-3">
<div>
<CardTitle>{t("admin.knowledgeOps.recent.title")}</CardTitle>
<CardDescription>{t("admin.knowledgeOps.recent.description")}</CardDescription>
</div>
<Link className="text-primary text-sm font-medium hover:underline" to={adminPath("knowledge-base/articles", { mode: "host-aware" })}>
{t("shared.viewAll")}
</Link>
</div>
</CardHeader>
<CardContent className="space-y-2">
{data.recentArticles.length === 0 ? <div className="text-muted-foreground text-sm">{t("admin.knowledgeOps.recent.empty")}</div> : null}
{data.recentArticles.map((article) => (
<div key={article.id} className="rounded-md border p-3 text-sm">
<div className="flex items-start justify-between gap-3">
<div className="min-w-0">
<div className="truncate font-medium">{article.title}</div>
<div className="text-muted-foreground mt-1 truncate">{article.knowledgeBaseTitle} · {article.language}</div>
<div className="text-muted-foreground mt-1 text-xs">
{article.updatedAt ? formatters.dateTime(article.updatedAt) : t("shared.notSet")}
</div>
</div>
<Badge color={article.publishedAt ? "green" : "yellow"} withColorDot>
{article.publishedAt ? t("admin.knowledgeOps.published") : t("admin.knowledgeOps.draft")}
</Badge>
</div>
</div>
))}
</CardContent>
</Card>
<Card className="gap-4 rounded-lg py-5">
<CardHeader>
<CardTitle>{t("admin.knowledgeOps.quality.title")}</CardTitle>
<CardDescription>{t("admin.knowledgeOps.quality.description")}</CardDescription>
</CardHeader>
<CardContent className="grid gap-3 text-sm">
<QualityRow label={t("knowledgeBase.adminOverview.metrics.articleViews")} value={formatters.number(data.summary.articlesViews)} />
<QualityRow label={t("admin.knowledgeOps.metrics.baseViews")} value={formatters.number(data.summary.kbsViews)} />
<QualityRow label={t("knowledgeBase.adminOverview.metrics.articleUpvotes")} value={formatters.number(data.summary.articlesUpvotes)} />
<QualityRow label={t("knowledgeBase.adminOverview.metrics.articleDownvotes")} value={formatters.number(data.summary.articlesDownvotes)} />
<QualityRow label={t("admin.knowledgeOps.metrics.voteBalance")} value={formatters.number(voteBalance)} tone={voteBalance < 0 ? "danger" : "success"} />
</CardContent>
</Card>
</div>
</div>
);
}
function SummaryCard({ title, value }: { title: string; value: number }) {
const formatters = useLocaleFormatters();
return (
<div className="bg-card border-border overflow-hidden rounded-lg border px-4 py-3 shadow-xs">
<dt className="text-muted-foreground truncate text-xs font-medium uppercase">
<div>{title}</div>
</dt>
<dd className="text-foreground mt-1 truncate text-2xl font-semibold">{formatters.number(value, { maximumFractionDigits: 0 })}</dd>
</div>
);
}
function QualityRow({ label, value, tone = "neutral" }: { label: string; value: string; tone?: "success" | "danger" | "neutral" }) {
return (
<div className="flex items-center justify-between gap-3 rounded-md border px-3 py-2">
<span className="text-muted-foreground">{label}</span>
<span className={tone === "danger" ? "font-medium text-red-700" : tone === "success" ? "font-medium text-green-700" : "font-medium"}>{value}</span>
</div>
);
}