Tria/emaui
1
0
Fork 0
mirror of https://github.com/Tria-plc/emaui.git synced 2026-09-06 12:25:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add multi-page support, improve template creation logic, and refine rank resolution in certificate designer

Browse Source
This commit is contained in:
estifanos
2026-09-02 10:43:26 +00:00
parent 92f2f16b80
commit 984dec0d6d
11 changed files with 224 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
apps/backoffice/src/app/features/certificate-designer/components/BlockPropertiesPanel.tsx
View File

@@ -135,6 +135,21 @@ export function BlockPropertiesPanel({
/>
</Group>
<NumberInput
label={t('designer.blockPage', 'Page')}
description={t('designer.blockPageHint', 'Which sheet of the document this block prints on')}
value={(block.page ?? 0) + 1}
onChange={(value) => {
const index = Math.max(0, Math.min(63, Math.floor(Number(value) || 1) - 1));
// Omitted on the first page so a single-page design stays as it was.
const { page: _page, ...rest } = block;
onChange(index > 0 ? { ...rest, page: index } : rest);
}}
min={1}
max={64}
disabled={disabled}
/>
<Group gap="xs" grow>
<NumberInput
label={t('designer.blockX', 'X (%)')}

5
apps/backoffice/src/app/features/certificate-designer/components/DesignerToolbar.tsx
View File

@@ -88,7 +88,10 @@ export function DesignerToolbar({
? t('designer.validityMonths', '{{count}} months', {
count: validityMonths,
})
: t('designer.validityNone', 'Does not expire')}
: // A zero-month term is not honoured at issuance — the
// renderer falls back to twelve months — so say what
// will actually be printed rather than "does not expire".
t('designer.validityNone', 'No term set — issues for 12 months')}
</Text>
<Text size="xs" c="dimmed">
{t('designer.validityEditedOn', '— set on Certificate Requirements → Behaviour')}

42
apps/backoffice/src/app/features/certificate-designer/components/TemplateCanvas.tsx
View File

@@ -1,8 +1,9 @@
import { useCallback, useEffect, useRef, useState } from 'react';
import { Box, Paper, Text } from '@mantine/core';
import { IconPhoto } from '@tabler/icons-react';
import { Box, Button, Group, Paper, Text } from '@mantine/core';
import { IconPhoto, IconPlus } from '@tabler/icons-react';
import { useTranslation } from 'react-i18next';
import type { TemplateFieldPlacement, TemplateLogoPlacement } from '@ema-platform/api';
import { pageIndexOf } from '../config/layout-compiler';
interface Props {
backgroundUrl: string;
@@ -16,6 +17,11 @@ interface Props {
onSelect: (id: string | null) => void;
onChange: (placements: TemplateFieldPlacement[]) => void;
disabled: boolean;
/** Zero-based page being shown; only that page's blocks are drawn. */
page: number;
pageCount: number;
onPageChange: (page: number) => void;
onAddPage: () => void;
}
/** A4 aspect ratio, the fallback for a version with no custom page size. */
@@ -71,9 +77,14 @@ export function TemplateCanvas({
onSelect,
onChange,
disabled,
page,
pageCount,
onPageChange,
onAddPage,
}: Props) {
const { t } = useTranslation();
const pageRef = useRef<HTMLDivElement>(null);
const visible = placements.filter((block) => pageIndexOf(block) === page);
const [drag, setDrag] = useState<DragState | null>(null);
// Held in a ref as well: the pointer handlers are bound to the window for the
@@ -214,6 +225,31 @@ export function TemplateCanvas({
)}
</Text>
{/* One tab per sheet. A single-page certificate shows only "Page 1" and
the add button; a booklet (the Seaman Book) switches between its
pages here, each positioning its own blocks. */}
<Group gap={6} mb="xs">
{Array.from({ length: pageCount }, (_, index) => (
<Button
key={index}
size="compact-xs"
variant={index === page ? 'filled' : 'default'}
onClick={() => onPageChange(index)}
>
{t('designer.pageTab', 'Page {{n}}', { n: index + 1 })}
</Button>
))}
<Button
size="compact-xs"
variant="subtle"
leftSection={<IconPlus size={12} />}
disabled={disabled}
onClick={onAddPage}
>
{t('designer.addPage', 'Add page')}
</Button>
</Group>
<Box
ref={pageRef}
onPointerDown={() => onSelect(null)}
@@ -256,7 +292,7 @@ export function TemplateCanvas({
/>
)}
{placements.map((block) => {
{visible.map((block) => {
const isSelected = block.id === selectedId;
const isImage = block.type === 'image';
return (

2
apps/backoffice/src/app/features/certificate-designer/components/TemplateEditor.tsx
View File

@@ -51,7 +51,7 @@ export function TemplateEditor({
<Text size="xs">
{t(
'designer.publishedLocked',
'This version is live and cannot be edited — certificates have been issued from it. Create a new version to make changes.',
'This version is live and cannot be edited — certificates are issued from it. Create a new version to make changes.',
)}
</Text>
</Paper>

40
apps/backoffice/src/app/features/certificate-designer/config/layout-compiler.ts
View File

@@ -102,7 +102,16 @@ export function compileLayoutToHbs(input: {
? ` <img class="ema-background" src="${escapeHtml(input.backgroundUrl)}" alt="" />\n`
: '';
const blocks = input.fieldPlacements.map(blockHtml).join('');
const logo = logoHtml(input.logoUrl, input.logoPlacement);
// Same grouping as the server: one page box per page index, each carrying
// the background and logo, so a booklet previews as the sheets it prints.
const body = groupByPage(input.fieldPlacements)
.map(
(blocks) =>
` <div class="ema-page">\n${background}${logo}${blocks.map(blockHtml).join('')} </div>\n`,
)
.join('');
return `<!doctype html>
<html>
@@ -113,6 +122,10 @@ export function compileLayoutToHbs(input: {
html, body { margin: 0; padding: 0; height: 100%; }
body { font-family: "Helvetica Neue", Arial, sans-serif; }
.ema-page { position: relative; width: 100%; height: 100vh; overflow: hidden; }
/* Every page but the last starts a new sheet. Applied to the element
rather than between them so a single-page design prints one sheet
with no trailing blank. */
.ema-page + .ema-page { page-break-before: always; break-before: page; }
.ema-background {
position: absolute; inset: 0;
width: 100%; height: 100%;
@@ -122,9 +135,28 @@ export function compileLayoutToHbs(input: {
</style>
</head>
<body>
<div class="ema-page">
${background}${logoHtml(input.logoUrl, input.logoPlacement)}${blocks} </div>
</body>
${body} </body>
</html>
`;
}
/** Upper bound on pages, matching the server, so a bad value cannot explode the preview. */
const MAX_PAGE_INDEX = 63;
/** A block's page, defaulting to the first and refusing a nonsense value. */
export function pageIndexOf(block: Pick<TemplateFieldPlacement, 'page'>): number {
const page = block.page;
if (typeof page !== 'number' || !Number.isFinite(page) || page < 0) return 0;
return Math.min(Math.floor(page), MAX_PAGE_INDEX);
}
/**
* Blocks split into pages, in page order, with no gaps — an empty page in
* the middle of a booklet is a deliberate blank verso and is kept.
*/
export function groupByPage(placements: TemplateFieldPlacement[]): TemplateFieldPlacement[][] {
const highest = placements.reduce((max, block) => Math.max(max, pageIndexOf(block)), 0);
const pages: TemplateFieldPlacement[][] = Array.from({ length: highest + 1 }, () => []);
for (const block of placements) pages[pageIndexOf(block)].push(block);
return pages;
}

27
apps/backoffice/src/app/features/certificate-designer/hooks/useTemplateDraft.ts
View File

@@ -4,6 +4,7 @@ import type {
TemplateFieldPlacement,
TemplateLogoPlacement,
} from '@ema-platform/api';
import { pageIndexOf } from '../config/layout-compiler';
/** Stable ids for new blocks; `crypto.randomUUID` is not in every test env. */
function blockId(): string {
@@ -32,6 +33,10 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
const [logoPlacement, setLogoPlacement] = useState<TemplateLogoPlacement>({});
const [placements, setPlacements] = useState<TemplateFieldPlacement[]>([]);
const [selectedBlockId, setSelectedBlockId] = useState<string | null>(null);
// The page the canvas is showing. Pages exist only through the blocks on
// them, so a freshly added page is held here until its first block lands.
const [currentPage, setCurrentPage] = useState(0);
const [extraPages, setExtraPages] = useState(0);
const editorRef = useRef<HTMLTextAreaElement>(null);
const selected = useMemo(
@@ -61,8 +66,19 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
setLogoPlacement(selected.logoPlacement ?? {});
setPlacements(selected.fieldPlacements ?? []);
setSelectedBlockId(null);
setCurrentPage(0);
setExtraPages(0);
}, [selected]);
/** Pages the design spans: the highest block page, plus any added and still empty. */
const pageCount =
placements.reduce((max, block) => Math.max(max, pageIndexOf(block)), 0) + 1 + extraPages;
const addPage = useCallback(() => {
setExtraPages((n) => n + 1);
setCurrentPage(pageCount);
}, [pageCount]);
const isPublished = selected?.status === 'PUBLISHED';
// Compared as JSON because both are plain data the server round-trips; a
@@ -101,12 +117,16 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
*/
const addBlock = useCallback(
(variable: string | null, text?: string, kind: 'text' | 'image' = 'text') => {
// Placed on the page being viewed; `page` is omitted on the first so a
// single-page design stays byte-for-byte what it was before booklets.
const page = currentPage > 0 ? { page: currentPage } : {};
const block: TemplateFieldPlacement =
kind === 'image'
? {
id: blockId(),
variable,
type: 'image',
...page,
xPct: 10,
yPct: 10,
widthPct: 15,
@@ -116,6 +136,7 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
variable,
text,
type: 'text',
...page,
xPct: 10,
yPct: 10,
widthPct: 30,
@@ -128,7 +149,7 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
setPlacements((prev) => [...prev, block]);
setSelectedBlockId(block.id);
},
[],
[currentPage],
);
const updateBlock = useCallback((next: TemplateFieldPlacement) => {
@@ -185,6 +206,10 @@ export function useTemplateDraft(templates: LicenseTemplate[]) {
setSelectedBlockId,
selectedBlock,
usesCanvas,
currentPage,
setCurrentPage,
pageCount,
addPage,
addBlock,
updateBlock,
deleteBlock,

101
apps/backoffice/src/app/features/certificate-designer/pages/CertificateDesignerPage.tsx
View File

@@ -4,6 +4,7 @@ import {
Button,
Container,
Group,
Modal,
Paper,
Stack,
Tabs,
@@ -23,7 +24,6 @@ import {
useArchiveLicenseTemplateMutation,
useCreateLicenseTemplateMutation,
useDeleteLicenseTemplateMutation,
useGetBuiltInTemplateQuery,
useGetLicenseTemplatesQuery,
useGetLicenseTypesQuery,
useGetRanksQuery,
@@ -31,7 +31,7 @@ import {
usePublishLicenseTemplateMutation,
useUpdateLicenseTemplateMutation,
} from '@ema-platform/api';
import { EmptyState, ErrorState, PageHeader, PdfPreviewModal } from '@ema-platform/ui';
import { EmptyState, ErrorState, ModalFooter, PageHeader, PdfPreviewModal } from '@ema-platform/ui';
import { usePermissions, LICENSE_PERMISSIONS as PERMISSIONS } from '@ema-platform/auth';
import { BlockPropertiesPanel } from '../components/BlockPropertiesPanel';
import { DesignerToolbar } from '../components/DesignerToolbar';
@@ -62,6 +62,9 @@ export function CertificateDesignerPage() {
const { can } = usePermissions();
const canEdit = can([PERMISSIONS.UPDATE_TEMPLATE]);
// Its own permission on the server, so the button follows it rather than
// showing to an editor who would only be refused on click.
const canCreate = can([PERMISSIONS.CREATE_TEMPLATE]);
const canPublish = can([PERMISSIONS.PUBLISH_TEMPLATE]);
const { data: licenseTypes } = useGetLicenseTypesQuery();
@@ -79,8 +82,10 @@ export function CertificateDesignerPage() {
// default both come back, so the version list is scoped to whichever the
// toolbar has selected.
const templates = allTemplates.filter((tpl) => (tpl.rankId ?? null) === rankId);
const { data: variables = [] } = useGetTemplateVariablesQuery();
const { data: builtIn } = useGetBuiltInTemplateQuery();
// Per type, so the palette also lists this form's own answers.
const { data: variables = [] } = useGetTemplateVariablesQuery(
typeId ? { licenseTypeId: typeId } : undefined,
);
const [createTemplate, { isLoading: creating }] = useCreateLicenseTemplateMutation();
const [updateTemplate, { isLoading: saving }] = useUpdateLicenseTemplateMutation();
@@ -94,25 +99,23 @@ export function CertificateDesignerPage() {
const [newOpen, setNewOpen] = useState(false);
const [newName, setNewName] = useState('');
const [deleteOpen, setDeleteOpen] = useState(false);
const [mode, setMode] = useState<'canvas' | 'source'>('canvas');
const selectedType = licenseTypes?.items?.find((type) => type.id === typeId);
// A rank ladder only exists for CoC/CoP — every other licence type designs
// one certificate for everyone who holds it. Keyed on `key`, not
// `certificateCategory`: that STCW-mapping column is unset on the seeded
// CoC/CoP rows (it's authored later, per StcwMappingPanel), while `key` is
// the stable identity CertificateEligibilityService itself branches on.
// CoC/CoP are each a single LicenseType spanning every department's ladder
// (the applicant's own department, not the type, decides which ladder they
// climb), so the picker offers every rank in the ladder across all
// departments rather than one department's.
// one certificate for everyone who holds it. Keyed on the configured
// `certificateCategory`, the same column the server's rank resolution reads,
// so a type an administrator marks as a CoC/CoP on the Behaviour tab gets a
// rank picker without a code change. CoC/CoP are each a single LicenseType
// spanning every department's ladder (the applicant's own department, not
// the type, decides which ladder they climb), so the picker offers every
// rank across all departments rather than one department's.
const rankCategory: 'COC' | 'COP' | null =
selectedType?.key === 'CERTIFICATE_OF_COMPETENCY'
? 'COC'
: selectedType?.key === 'CERTIFICATE_OF_PROFICIENCY'
? 'COP'
: null;
selectedType?.certificateCategory === 'COC' || selectedType?.certificateCategory === 'COP'
? selectedType.certificateCategory
: null;
const isRankScoped = rankCategory !== null;
const { data: allRanks } = useGetRanksQuery(undefined, { skip: !isRankScoped });
const ranks = (allRanks?.items ?? [])
@@ -164,7 +167,7 @@ export function CertificateDesignerPage() {
}}
validityMonths={selectedType?.validityMonths ?? 12}
validityDays={selectedType?.validityDays ?? null}
canEdit={canEdit}
canEdit={canCreate}
onNewVersion={startNewVersion}
/>
@@ -183,7 +186,7 @@ export function CertificateDesignerPage() {
'Certificates currently use the built-in layout. Create a version to take control of it.',
)}
action={
canEdit
canCreate
? { label: t('designer.newVersion', 'New version'), onClick: startNewVersion }
: undefined
}
@@ -228,10 +231,10 @@ export function CertificateDesignerPage() {
<Text size="sm">
{t(
'designer.liveDesignBody',
'Certificates have been issued from this version, so it cannot be changed. Create a new version to edit — it starts as a copy of this one, and only replaces it when you publish.',
'Certificates are issued from this version, so it cannot be changed. Create a new version to edit — it starts as a copy of this one, and only replaces it when you publish.',
)}
</Text>
{canEdit && (
{canCreate && (
<Button
size="xs"
leftSection={<IconPlus size={14} />}
@@ -274,6 +277,10 @@ export function CertificateDesignerPage() {
onSelect={draft.setSelectedBlockId}
onChange={draft.setPlacements}
disabled={editingLocked}
page={draft.currentPage}
pageCount={draft.pageCount}
onPageChange={draft.setCurrentPage}
onAddPage={draft.addPage}
/>
<BlockPropertiesPanel
block={draft.selectedBlock}
@@ -356,8 +363,10 @@ export function CertificateDesignerPage() {
? { width: draft.pageWidth, height: draft.pageHeight }
: undefined,
),
backgroundUrl: draft.backgroundUrl || undefined,
logoUrl: draft.logoUrl || undefined,
// Null, not undefined: undefined means "leave as stored",
// which is what made Remove look like it worked until reload.
backgroundUrl: draft.backgroundUrl.trim() || null,
logoUrl: draft.logoUrl.trim() || null,
logoPlacement: draft.logoPlacement,
fieldPlacements: draft.placements,
}).unwrap(),
@@ -376,12 +385,7 @@ export function CertificateDesignerPage() {
t('designer.archived', 'Design withdrawn'),
)
}
onDelete={() =>
run(
() => deleteTemplate(draft.selected!.id).unwrap(),
t('designer.deleted', 'Draft deleted'),
)
}
onDelete={() => setDeleteOpen(true)}
/>
</Stack>
@@ -404,11 +408,15 @@ export function CertificateDesignerPage() {
onClose={() => setNewOpen(false)}
onCreate={() =>
run(async () => {
// No source is sent on purpose: the server seeds the draft from
// the live design for this rank, then the type's default, then
// the built-in layout — and it copies that design's blocks and
// artwork along with the HTML, which sending a source here would
// have split apart.
const created = await createTemplate({
licenseTypeId: typeId as string,
rankId,
name: newName.trim(),
hbsSource: templates.length ? undefined : builtIn?.hbsSource,
}).unwrap();
draft.setSelectedId(created.id);
setNewOpen(false);
@@ -416,6 +424,39 @@ export function CertificateDesignerPage() {
}
/>
<Modal
opened={deleteOpen}
onClose={() => setDeleteOpen(false)}
title={t('designer.delete', 'Delete draft')}
size="sm"
>
<Stack gap="md">
<Text size="sm">
{t('designer.deleteConfirm', 'Delete "{{name}}" (v{{version}})? This cannot be undone.', {
name: draft.selected?.name ?? '',
version: draft.selected?.version ?? '',
})}
</Text>
<ModalFooter>
<Button variant="default" onClick={() => setDeleteOpen(false)}>
{t('common.cancel', 'Cancel')}
</Button>
<Button
color="red"
onClick={async () => {
setDeleteOpen(false);
await run(
() => deleteTemplate(draft.selected!.id).unwrap(),
t('designer.deleted', 'Draft deleted'),
);
}}
>
{t('designer.delete', 'Delete draft')}
</Button>
</ModalFooter>
</Stack>
</Modal>
<PdfPreviewModal
opened={Boolean(previewUrl)}
onClose={closePreview}

9
apps/backoffice/src/app/i18n/locales/am.ts
View File

@@ -1272,7 +1272,7 @@ export const am: Translations = {
validityMonths_other: "{{count}} ወራት",
validityDays_one: "{{count}} ቀን",
validityDays_other: "{{count}} ቀናት",
validityNone: "ጊዜው አያልፍም",
validityNone: "ጊዜ አልተቀመጠም — ለ12 ወራት ይሰጣል",
validityEditedOn: "— በምስክር ወረቀት መስፈርቶች → ባህሪ ውስጥ ይዘጋጃል",
newVersion: "አዲስ ስሪት",
versions: "ስሪቶች",
@@ -1290,7 +1290,12 @@ export const am: Translations = {
published: "ንድፉ ታትሟል",
publishHint: "ይህንን ቀጥታ የምስክር ወረቀት ንድፍ ያደርገዋል",
publishedLocked:
"ይህ ስሪት ቀጥታ ላይ ስለሆነ ማስተካከል አይቻልም — ከእሱ የምስክር ወረቀቶች ተሰጥተዋል። ለውጥ ለማድረግ አዲስ ስሪት ይፍጠሩ።",
"ይህ ስሪት ቀጥታ ላይ ስለሆነ ማስተካከል አይቻልም — የምስክር ወረቀቶች ከእሱ ይሰጣሉ። ለውጥ ለማድረግ አዲስ ስሪት ይፍጠሩ።",
deleteConfirm: '"{{name}}" (v{{version}}) ይሰረዝ? ይህ መቀልበስ አይቻልም።',
pageTab: "ገጽ {{n}}",
addPage: "ገጽ ጨምር",
blockPage: "ገጽ",
blockPageHint: "ይህ ብሎክ በየትኛው የሰነዱ ገጽ ላይ እንደሚታተም",
archive: "አንሳ",
archived: "ንድፉ ተነስቷል",
delete: "ረቂቅ ሰርዝ",

9
apps/backoffice/src/app/i18n/locales/en.ts
View File

@@ -1279,7 +1279,7 @@ export const en = {
validityMonths_other: '{{count}} months',
validityDays_one: '{{count}} day',
validityDays_other: '{{count}} days',
validityNone: 'Does not expire',
validityNone: 'No term set — issues for 12 months',
validityEditedOn: '— set on Certificate Requirements → Behaviour',
newVersion: 'New version',
versions: 'Versions',
@@ -1296,7 +1296,12 @@ export const en = {
publish: 'Publish',
published: 'Design published',
publishHint: 'Makes this the live certificate design',
publishedLocked: 'This version is live and cannot be edited — certificates have been issued from it. Create a new version to make changes.',
publishedLocked: 'This version is live and cannot be edited — certificates are issued from it. Create a new version to make changes.',
deleteConfirm: 'Delete "{{name}}" (v{{version}})? This cannot be undone.',
pageTab: 'Page {{n}}',
addPage: 'Add page',
blockPage: 'Page',
blockPageHint: 'Which sheet of the document this block prints on',
archive: 'Withdraw',
archived: 'Design withdrawn',
delete: 'Delete draft',