Files
docmost/apps/client/src/ee/page-verification/components/setup-verification-form.tsx
T
Philip Okugbe bd68e47e03 feat(ee): page verification workflow (#2102)
* feat: page verification workflow

* feat: refactor page-verification

* sync

* fix type

* fix

* fix

* notification icon

* use full word

* accept .license file

* - update templates
- update migration and notification

* fix copy

* update audit labels

* sync

* add space name
2026-04-13 20:20:34 +01:00

336 lines
9.7 KiB
TypeScript

import { useEffect, useRef, useState } from "react";
import {
Button,
Checkbox,
Divider,
Group,
Stack,
Text,
UnstyledButton,
} from "@mantine/core";
import {
IconArrowLeft,
IconArrowRight,
IconCertificate2,
IconCheck,
IconRefresh,
} from "@tabler/icons-react";
import { useTranslation } from "react-i18next";
import { useAtom } from "jotai";
import classes from "./page-verification-modal.module.css";
import { currentUserAtom } from "@/features/user/atoms/current-user-atom";
import { useSetupVerificationMutation } from "@/ee/page-verification/queries/page-verification-query";
import {
ExpirationMode,
PeriodUnit,
VerificationType,
} from "@/ee/page-verification/types/page-verification.types";
import {
ExpirationFields,
PERIOD_AMOUNT_MIN,
PERIOD_UNIT_MAX_AMOUNT,
} from "./expiration-fields";
import { VerifierPicker } from "./verifier-picker";
import { VerifierList } from "./verifier-list";
import { MAX_VERIFIERS, UserOptionItem } from "./user-option";
type WorkflowChooserProps = {
onSelect: (type: VerificationType) => void;
};
function WorkflowChooser({ onSelect }: WorkflowChooserProps) {
const { t } = useTranslation();
return (
<Stack gap="md">
<Text className={classes.subhead}>
{t("Choose how this page should stay accurate.")}
</Text>
<div className={classes.chooser}>
<UnstyledButton
component="button"
type="button"
className={classes.card}
onClick={() => onSelect("expiring" as VerificationType)}
>
<div className={classes.titleRow}>
<span className={classes.iconStamp}>
<IconRefresh size={15} stroke={1.7} />
</span>
<h3 className={classes.title}>{t("Recurring verification")}</h3>
</div>
<p className={classes.description}>
{t("Verifiers re-confirm this page on a schedule.")}
</p>
<div className={classes.rule} />
<div className={classes.meta}>
<div className={classes.metaItem}>
<IconCheck size={13} stroke={2.4} className={classes.metaIcon} />
{t("Re-verify on a schedule (e.g every 30 days )")}
</div>
</div>
<div className={classes.cardFooter}>
<span className={classes.bestFor}>
{t("Best for runbooks, FAQs, living documentation")}
</span>
<span className={classes.arrow}>
<IconArrowRight size={16} stroke={1.8} />
</span>
</div>
</UnstyledButton>
<UnstyledButton
component="button"
type="button"
className={classes.card}
onClick={() => onSelect("qms" as VerificationType)}
>
<div className={classes.titleRow}>
<span className={classes.iconStamp}>
<IconCertificate2 size={15} stroke={1.7} />
</span>
<h3 className={classes.title}>{t("Approval workflow")}</h3>
</div>
<p className={classes.description}>
{t("Formal document lifecycle with named approvers.")}
</p>
<div className={classes.rule} />
<div className={classes.meta}>
<div className={classes.metaItem}>
<IconCheck size={13} stroke={2.4} className={classes.metaIcon} />
{t("Draft → In approval → Approved → Obsolete")}
</div>
<div className={classes.metaItem}>
<IconCheck size={13} stroke={2.4} className={classes.metaIcon} />
{t("Designed for ISO 9001, ISO 13485, and FDA")}
</div>
</div>
<div className={classes.cardFooter}>
<span className={classes.bestFor}>
{t("Best for SOPs and controlled documents")}
</span>
<span className={classes.arrow}>
<IconArrowRight size={16} stroke={1.8} />
</span>
</div>
</UnstyledButton>
</div>
</Stack>
);
}
type SetupVerificationFormProps = {
pageId: string;
onClose: () => void;
};
export function SetupVerificationForm({
pageId,
onClose,
}: SetupVerificationFormProps) {
const { t } = useTranslation();
const setupMutation = useSetupVerificationMutation();
const [currentUser] = useAtom(currentUserAtom);
const [type, setType] = useState<VerificationType | null>(null);
const [mode, setMode] = useState<ExpirationMode>("period");
const [periodAmount, setPeriodAmount] = useState<number>(1);
const [periodUnit, setPeriodUnit] = useState<PeriodUnit>("month");
const [fixedDate, setFixedDate] = useState<string>("");
const [confirmed, setConfirmed] = useState(false);
const [selectedVerifiers, setSelectedVerifiers] = useState<UserOptionItem[]>(
[],
);
const didInitCurrentUser = useRef(false);
useEffect(() => {
if (!didInitCurrentUser.current && currentUser?.user) {
didInitCurrentUser.current = true;
const u = currentUser.user;
setSelectedVerifiers([
{
value: u.id,
label: u.name,
email: u.email,
avatarUrl: u.avatarUrl,
},
]);
}
}, [currentUser]);
const isQms = type === "qms";
const canAddMore = selectedVerifiers.length < MAX_VERIFIERS;
if (type === null) {
return <WorkflowChooser onSelect={setType} />;
}
const handleAddVerifier = (user: UserOptionItem) => {
setSelectedVerifiers((prev) =>
prev.some((v) => v.value === user.value) ? prev : [...prev, user],
);
};
const handleRemoveVerifier = (userId: string) => {
setSelectedVerifiers((prev) => prev.filter((v) => v.value !== userId));
};
const handleSetup = () => {
if (selectedVerifiers.length === 0) return;
setupMutation.mutate(
{
pageId,
type,
...(!isQms && {
mode,
...(mode === "period" && {
periodAmount,
periodUnit,
}),
...(mode === "fixed" &&
fixedDate && {
fixedExpiresAt: new Date(fixedDate).toISOString(),
}),
}),
verifierIds: selectedVerifiers.map((v) => v.value),
},
{
onSuccess: () => {
if (!isQms) {
onClose();
}
},
},
);
};
const periodValid =
mode !== "period" ||
(Number.isInteger(periodAmount) &&
periodAmount >= PERIOD_AMOUNT_MIN &&
periodAmount <= PERIOD_UNIT_MAX_AMOUNT[periodUnit]);
const fixedDateValid =
mode !== "fixed" ||
(!!fixedDate && new Date(fixedDate).getTime() > Date.now());
const hasVerifiers = selectedVerifiers.length > 0;
const canSubmit = isQms
? hasVerifiers
: hasVerifiers && confirmed && periodValid && fixedDateValid;
return (
<Stack>
<div>
<button
type="button"
className={classes.backButton}
onClick={() => setType(null)}
>
<IconArrowLeft size={12} stroke={2.2} />
{t("Back")}
</button>
<div className={classes.configureHeader}>
<span className={classes.iconStamp}>
{isQms ? (
<IconCertificate2 size={16} stroke={1.6} />
) : (
<IconRefresh size={16} stroke={1.6} />
)}
</span>
<div>
<span className={classes.configureEyebrow}>
{isQms ? t("Quality management") : t("Recurring")}
</span>
<Text size="sm" c="dimmed" mt={2}>
{isQms
? t("Pages move through draft, approval, and approved stages.")
: t(
"Assigned verifiers must periodically re-verify this page.",
)}
</Text>
</div>
</div>
</div>
<div>
<Text size="sm" fw={600} tt="uppercase" c="dimmed" mb={4}>
{t("Verifiers")}
</Text>
{selectedVerifiers.length > 0 && (
<div style={{ marginBottom: "var(--mantine-spacing-xs)" }}>
<VerifierList
verifiers={selectedVerifiers.map((v) => ({
id: v.value,
name: v.label,
email: v.email,
avatarUrl: v.avatarUrl,
}))}
canManage
onRemove={handleRemoveVerifier}
/>
</div>
)}
{canAddMore && (
<VerifierPicker
excludeIds={selectedVerifiers.map((v) => v.value)}
onSelect={handleAddVerifier}
/>
)}
</div>
{!isQms && (
<>
<Divider />
<div>
<Text size="sm" fw={600} mb={6}>
{t("Expiration")}
</Text>
<ExpirationFields
mode={mode}
periodAmount={periodAmount}
periodUnit={periodUnit}
fixedDate={fixedDate}
onModeChange={setMode}
onPeriodAmountChange={setPeriodAmount}
onPeriodUnitChange={setPeriodUnit}
onFixedDateChange={setFixedDate}
/>
</div>
<Divider />
<div>
<Text size="sm" fw={600} mb={4}>
{t("Confirm")}
</Text>
<Checkbox
label={t("I've reviewed this page for accuracy")}
checked={confirmed}
onChange={(event) => setConfirmed(event.currentTarget.checked)}
color="dark"
/>
</div>
</>
)}
<Group justify="flex-end">
<Button
onClick={handleSetup}
disabled={!canSubmit}
loading={setupMutation.isPending}
color="dark"
>
{isQms ? t("Set up") : t("Verify")}
</Button>
</Group>
</Stack>
);
}