Files
HiveGrid-Wireframes/hivegrid-cloud/apps/web/app/routes/admin/knowledge-base/bases.$slug/articles.$lang.tsx
T

404 lines
16 KiB
TypeScript

import { ActionFunctionArgs, LoaderFunctionArgs, redirect, useActionData, useLoaderData } from "react-router";
import { Link, useNavigate, useOutlet, useParams, useSubmit } from "react-router";
import { useTranslation } from "react-i18next";
import { FilterablePropertyDto } from "~/application/dtos/data/FilterablePropertyDto";
import { PaginationDto } from "~/application/dtos/data/PaginationDto";
import { Colors } from "~/application/enums/shared/Colors";
import SimpleBadge from "~/components/ui/badges/SimpleBadge";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import DateCell from "~/components/ui/dates/DateCell";
import PlusIcon from "~/components/ui/icons/PlusIcon";
import InputCheckbox from "~/components/ui/input/InputCheckbox";
import InputFilters from "~/components/ui/input/InputFilters";
import EditPageLayout from "~/components/ui/layouts/EditPageLayout";
import ActionResultModal from "~/components/ui/modals/ActionResultModal";
import SlideOverWideEmpty from "~/components/ui/slideOvers/SlideOverWideEmpty";
import TableSimple from "~/components/ui/tables/TableSimple";
import { useLocaleFormatters } from "~/locale/format";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
import { getTranslations } from "~/locale/i18next.server";
import {
KnowledgeBaseArticleWithDetails,
getAllKnowledgeBaseArticlesWithPagination,
getKbArticleByIdInKnowledgeBase,
updateKnowledgeBaseArticleInKnowledgeBase,
} from "~/modules/knowledgeBase/db/kbArticles.db.server";
import { getAllKnowledgeBaseCategories, updateKnowledgeBaseCategoryOrderInKnowledgeBase } from "~/modules/knowledgeBase/db/kbCategories.db.server";
import { updateKnowledgeBaseCategorySectionOrderInKnowledgeBase } from "~/modules/knowledgeBase/db/kbCategorySections.db.server";
import { KnowledgeBaseDto } from "~/modules/knowledgeBase/dtos/KnowledgeBaseDto";
import KnowledgeBaseService, { getKnowledgeBaseActionErrorKey } from "~/modules/knowledgeBase/service/KnowledgeBaseService.server";
import KnowledgeBaseUtils from "~/modules/knowledgeBase/utils/KnowledgeBaseUtils";
import { verifyUserHasPermission } from "~/utils/helpers/.server/PermissionsService";
import { getFiltersFromCurrentUrl, getPaginationFromCurrentUrl } from "~/utils/helpers/RowPaginationHelper";
import { getUserInfo, validateCSRFToken } from "~/utils/session.server";
import { appendCSRFToken } from "~/utils/csrf";
import type { TFunction } from "i18next";
type LoaderData = {
knowledgeBase: KnowledgeBaseDto;
items: KnowledgeBaseArticleWithDetails[];
pagination: PaginationDto;
filterableProperties: FilterablePropertyDto[];
};
export const loader = async ({ request, params }: LoaderFunctionArgs) => {
await verifyUserHasPermission(request, "admin.kb.view");
const { t } = await getTranslations(request);
const knowledgeBase = await KnowledgeBaseService.get({
slug: params.slug!,
request,
});
if (!knowledgeBase) {
return redirect(adminPath("knowledge-base/bases", { mode: "host-aware" }));
}
const urlSearchParams = new URL(request.url).searchParams;
const currentPagination = getPaginationFromCurrentUrl(urlSearchParams);
const filterableProperties: FilterablePropertyDto[] = [
{
name: "title",
title: t("knowledgeBase.adminArticles.fields.title"),
},
{
name: "description",
title: t("knowledgeBase.adminArticles.fields.description"),
},
{
name: "categoryId",
title: t("knowledgeBase.adminArticles.fields.category"),
options: [
{ value: "null", name: t("knowledgeBase.adminArticles.filters.noCategoryValue") },
...(await getAllKnowledgeBaseCategories({ knowledgeBaseSlug: knowledgeBase.slug, language: params.lang! })).map((item) => {
return {
value: item.id,
name: item.title,
};
}),
],
},
{
name: "content",
title: t("knowledgeBase.adminArticles.fields.content"),
},
];
const filters = getFiltersFromCurrentUrl(request, filterableProperties);
const filtered = {
title: filters.properties.find((f) => f.name === "title")?.value ?? filters.query ?? undefined,
description: filters.properties.find((f) => f.name === "description")?.value ?? filters.query ?? undefined,
categoryId: filters.properties.find((f) => f.name === "categoryId")?.value ?? undefined,
content: filters.properties.find((f) => f.name === "content")?.value ?? filters.query ?? undefined,
};
const { items, pagination } = await getAllKnowledgeBaseArticlesWithPagination({
knowledgeBaseSlug: params.slug!,
language: params.lang!,
pagination: currentPagination,
filters: {
title: filtered.title,
description: filtered.description,
categoryId: filtered.categoryId === "null" ? null : filtered.categoryId,
content: filtered.content,
},
});
const data: LoaderData = {
knowledgeBase,
items,
pagination,
filterableProperties,
};
return data;
};
type ActionData = {
error?: string;
};
function formatLanguageName(language: string, locale: string, t: TFunction) {
try {
return (new Intl.DisplayNames([locale], { type: "language" }).of(language) ?? KnowledgeBaseUtils.getLanguageName(language, t)) || language;
} catch {
return KnowledgeBaseUtils.getLanguageName(language, t) || language;
}
}
export const action = async ({ request, params }: ActionFunctionArgs) => {
await verifyUserHasPermission(request, "admin.kb.update");
const userInfo = await getUserInfo(request);
await validateCSRFToken(request);
const { t } = await getTranslations(request);
const form = await request.formData();
const action = form.get("action")?.toString() ?? "";
const kb = await KnowledgeBaseService.get({ slug: params.slug!, request });
if (action === "new") {
await verifyUserHasPermission(request, "admin.kb.create");
const created = await KnowledgeBaseService.newArticle({
kb,
params,
userId: userInfo.userId,
position: "last",
});
return redirect(adminPath(`knowledge-base/bases/${kb.slug}/articles/${params.lang}/${created.id}/edit`, { mode: "host-aware" }));
} else if (action === "set-orders") {
const items: { id: string; order: number }[] = form.getAll("orders[]").map((f: FormDataEntryValue) => {
return JSON.parse(f.toString());
});
await Promise.all(
items.map(async ({ id, order }) => {
await updateKnowledgeBaseCategoryOrderInKnowledgeBase({ id, knowledgeBaseId: kb.id, language: params.lang!, order: Number(order) });
})
);
return Response.json({ updated: true });
} else if (action === "set-section-orders") {
const items: { id: string; order: number }[] = form.getAll("orders[]").map((f: FormDataEntryValue) => {
return JSON.parse(f.toString());
});
await Promise.all(
items.map(async ({ id, order }) => {
await updateKnowledgeBaseCategorySectionOrderInKnowledgeBase({ id, knowledgeBaseId: kb.id, language: params.lang!, order: Number(order) });
})
);
return Response.json({ updated: true });
} else if (action === "duplicate") {
await verifyUserHasPermission(request, "admin.kb.create");
try {
const id = form.get("id")?.toString() ?? "";
const item = await KnowledgeBaseService.duplicateArticle({ kb, language: params.lang!, articleId: id });
return redirect(adminPath(`knowledge-base/bases/${kb.slug}/articles/${params.lang}/${item.id}`, { mode: "host-aware" }));
} catch (e: unknown) {
return Response.json({ error: t(getKnowledgeBaseActionErrorKey(e)) }, { status: 400 });
}
} else if (action === "toggle") {
const id = form.get("id")?.toString() ?? "";
const isFeatured = form.get("isFeatured")?.toString() === "true";
const item = await getKbArticleByIdInKnowledgeBase({ id, knowledgeBaseId: kb.id, language: params.lang! });
if (!item) {
return Response.json({ error: t("knowledgeBase.admin.errors.notFound") }, { status: 404 });
}
let featuredOrder = item.featuredOrder;
if (isFeatured) {
if (!item.featuredOrder) {
const featuredArticles = await KnowledgeBaseService.getFeaturedArticles({
kb,
params: {},
request,
});
let maxOrder = 0;
if (featuredArticles.length > 0) {
maxOrder = Math.max(...featuredArticles.map((p) => p.featuredOrder ?? 0));
}
featuredOrder = maxOrder + 1;
}
} else {
featuredOrder = null;
}
const result = await updateKnowledgeBaseArticleInKnowledgeBase(
{ id: item.id, knowledgeBaseId: kb.id, language: params.lang! },
{
featuredOrder,
}
);
if (result.count !== 1) {
return Response.json({ error: t("knowledgeBase.admin.errors.notFound") }, { status: 404 });
}
return Response.json({ success: t("knowledgeBase.admin.success.updated") });
}
return Response.json({ error: t("knowledgeBase.admin.errors.invalidAction") }, { status: 400 });
};
export default function () {
const { t } = useTranslation();
const formatters = useLocaleFormatters();
const data = useLoaderData<LoaderData>();
const actionData = useActionData<ActionData>();
const params = useParams();
const languageName = formatLanguageName(params.lang!, formatters.locale, t);
const outlet = useOutlet();
const navigate = useNavigate();
const submit = useSubmit();
function onDuplicate(item: KnowledgeBaseArticleWithDetails) {
const form = new FormData();
appendCSRFToken(form);
form.set("action", "duplicate");
form.set("id", item.id);
submit(form, {
method: "post",
});
}
function onToggle(item: KnowledgeBaseArticleWithDetails, isFeatured: boolean) {
const form = new FormData();
appendCSRFToken(form);
form.set("action", "toggle");
form.set("isFeatured", isFeatured ? "true" : "false");
form.set("id", item.id.toString());
submit(form, {
method: "post",
});
}
return (
<EditPageLayout
title={t("knowledgeBase.adminArticles.titleWithLanguage", { language: languageName })}
withHome={false}
menu={[
{ title: t("knowledgeBase.adminArticles.breadcrumbs.knowledgeBases"), routePath: adminPath("knowledge-base/bases", { mode: "host-aware" }) },
{ title: data.knowledgeBase.title, routePath: adminPath(`knowledge-base/bases/${data.knowledgeBase.slug}`, { mode: "host-aware" }) },
{ title: t("knowledgeBase.article.plural"), routePath: adminPath(`knowledge-base/bases/${params.slug}/articles`, { mode: "host-aware" }) },
{ title: languageName, routePath: adminPath(`knowledge-base/bases/${params.slug}/articles/${params.lang}`, { mode: "host-aware" }) },
]}
buttons={
<>
<InputFilters filters={data.filterableProperties} />
<ButtonPrimary
onClick={() => {
const form = new FormData();
appendCSRFToken(form);
form.set("action", "new");
submit(form, {
method: "post",
});
}}
>
<div>{t("knowledgeBase.article.new")}</div>
<PlusIcon className="h-5 w-5" />
</ButtonPrimary>
</>
}
>
<div className="space-y-2">
<TableSimple
items={data.items}
pagination={data.pagination}
actions={[
{
title: t("knowledgeBase.adminArticles.actions.settings"),
onClickRoute: (_, item) => `${item.id}/settings`,
},
{
title: t("knowledgeBase.adminArticles.actions.duplicate"),
onClick: (_, item) => onDuplicate(item),
},
{
title: t("knowledgeBase.adminArticles.actions.edit"),
onClickRoute: (_, item) => `${item.id}`,
},
]}
headers={[
{
name: "status",
title: t("knowledgeBase.adminArticles.fields.status"),
value: (i) => (
<div>
{!i.publishedAt ? (
<SimpleBadge title={t("knowledgeBase.adminArticles.status.draft")} color={Colors.GRAY} />
) : (
<SimpleBadge title={t("knowledgeBase.adminArticles.status.published")} color={Colors.TEAL} />
)}
</div>
),
},
{
name: "title",
title: t("knowledgeBase.adminArticles.fields.title"),
className: "w-full",
value: (i) => (
<div className="space-y-1">
<Link to={i.id} className="font-medium hover:underline">
{i.title}
</Link>
{/* <div className="text-muted-foreground text-sm">{i.description}</div> */}
{/* <div className="text-sm text-muted-foreground">{i.slug}</div>
<div className="text-muted-foreground text-sm">{i.description}</div> */}
</div>
),
},
{
name: "category",
title: t("knowledgeBase.adminArticles.fields.category"),
value: (i) => (
<div>
{i.category ? (
<div className="flex flex-col">
<div>{i.category.title}</div>
{i.section && <div className="text-muted-foreground text-xs">{i.section.title}</div>}
</div>
) : (
<Link to={`${i.id}/settings`} className="text-muted-foreground text-xs italic hover:underline">
{t("knowledgeBase.adminArticles.empty.noCategory")}
</Link>
)}
</div>
),
},
{
name: "characters",
title: t("knowledgeBase.adminArticles.metrics.characters"),
value: (i) => formatters.number(i.contentPublishedAsText.length, { maximumFractionDigits: 0 }),
},
{
name: "views",
title: t("knowledgeBase.adminArticles.metrics.views"),
value: (i) => formatters.number(i._count.views, { maximumFractionDigits: 0 }),
},
{
name: "upvotes",
title: t("knowledgeBase.adminArticles.metrics.upvotes"),
value: (i) => formatters.number(i._count.upvotes, { maximumFractionDigits: 0 }),
},
{
name: "downvotes",
title: t("knowledgeBase.adminArticles.metrics.downvotes"),
value: (i) => formatters.number(i._count.downvotes, { maximumFractionDigits: 0 }),
},
{
name: "featured",
title: t("knowledgeBase.adminArticles.fields.featured"),
value: (i) => {
return <InputCheckbox asToggle value={i.featuredOrder ? true : false} setValue={(checked) => onToggle(i, Boolean(checked))} />;
},
},
{
name: "createdAt",
title: t("shared.createdAt"),
value: (i) => (
<div className="flex flex-col">
<DateCell date={i.createdAt} displays={["ymd"]} />
<div>
{i.createdByUser ? (
<div>
{i.createdByUser.firstName} {i.createdByUser.lastName}
</div>
) : (
<div className="text-muted-foreground text-xs italic hover:underline">{t("knowledgeBase.adminArticles.empty.noAuthor")}</div>
)}
</div>
</div>
),
},
]}
/>
</div>
<ActionResultModal actionData={actionData} showSuccess={false} />
<SlideOverWideEmpty
title={t("knowledgeBase.adminArticles.settingsTitle")}
open={!!outlet}
onClose={() => {
navigate(".", { replace: true });
}}
className="sm:max-w-sm"
overflowYScroll={true}
>
<div className="-mx-1 -mt-3">
<div className="space-y-4">{outlet}</div>
</div>
</SlideOverWideEmpty>
</EditPageLayout>
);
}