AI Implementation feature(888): Admin Area General Settings and Categories 1.06 (#28)
This commit was merged in pull request #28.
This commit is contained in:
@@ -1,9 +1,9 @@
|
||||
---
|
||||
type: guide
|
||||
title: Admin — General Settings
|
||||
description: How an admin edits global platform settings (page title, logo, theme, event window, default challenge IP, registrations, welcome Markdown) from the /admin/general page.
|
||||
description: How an admin edits required platform-wide settings, including the validated event window, from the /admin/general page.
|
||||
tags: [guide, admin, settings, general, tester, datetime, validation]
|
||||
timestamp: 2026-07-22T14:07:58Z
|
||||
timestamp: 2026-07-22T14:24:08Z
|
||||
---
|
||||
|
||||
# When this view is available
|
||||
@@ -42,8 +42,8 @@ The page is a single reactive form with these controls (every
|
||||
| Logo (file picker) | `general-logo-file` | `logo` (public URL) | Uploads via `POST /api/v1/uploads/logo`; the returned `publicUrl` is bound to a hidden input `general-logo`. |
|
||||
| Logo upload status | `general-logo-uploading` / `general-logo-error` / `general-logo-current` | — | Inline status text under the file picker. |
|
||||
| Global theme | `general-themeKey` | `themeKey` | `<select>` populated from `/themes`. Value is one of `THEME_IDS`. |
|
||||
| Event start (UTC) | `general-eventStart` | `eventStartUtc` | `datetime-local` input. Empty string is allowed; any non-empty value must be a valid ISO-8601 datetime — invalid input renders `general-eventStart-error`. |
|
||||
| Event end (UTC) | `general-eventEnd` | `eventEndUtc` | `datetime-local` input. Empty string is allowed; any non-empty value must be a valid ISO-8601 datetime — invalid input renders `general-eventEnd-error`. Must also be strictly after Event start (`general-endBeforeStart`). |
|
||||
| Event start (UTC) | `general-eventStart` | `eventStartUtc` | Required valid ISO-8601 datetime. Empty or malformed input renders `general-eventStart-error` and disables Save. |
|
||||
| Event end (UTC) | `general-eventEnd` | `eventEndUtc` | Required valid ISO-8601 datetime. Empty or malformed input renders `general-eventEnd-error`; it must also be strictly after Event start (`general-endBeforeStart`). |
|
||||
| Default challenge IP | `general-defaultIp` | `defaultChallengeIp` | Required, max 255 chars. |
|
||||
| Enable registrations | `general-registrations` | `registrationsEnabled` | Boolean checkbox. When `false`, the public register endpoint returns `REGISTRATIONS_DISABLED`. |
|
||||
| Welcome description | `general-welcome` | `welcomeMarkdown` | Multi-line textarea; a live preview is rendered into `general-welcome-preview`. |
|
||||
@@ -74,15 +74,12 @@ The page is a single reactive form with these controls (every
|
||||
strictly after the start, the form becomes invalid and
|
||||
`general-endBeforeStart` appears under the end input. Save remains
|
||||
disabled.
|
||||
* **Per-field datetime validation:** if the user types (or leaves) a value
|
||||
that is not parseable as an ISO-8601 datetime in either the Event start
|
||||
or Event end input, the affected input flips `aria-invalid="true"` and
|
||||
its inline error element (`general-eventStart-error` or
|
||||
`general-eventEnd-error`) renders the message
|
||||
`"<Field> must be a valid ISO-8601 datetime."`. Empty strings are
|
||||
considered valid (the event window may be unconfigured), so clearing
|
||||
both inputs removes the error. Save remains disabled while either input
|
||||
is invalid.
|
||||
* **Per-field datetime validation:** clearing a field or supplying a value
|
||||
that cannot be parsed as an ISO-8601 datetime makes that control invalid.
|
||||
The affected input receives `aria-invalid="true"`, references its inline
|
||||
error through `aria-describedby`, and renders
|
||||
`"<Field> must be a valid ISO-8601 datetime."`. Save remains disabled
|
||||
until both timestamps are valid and ordered correctly.
|
||||
* **Save:** clicking Save sends `PUT /api/v1/admin/general/settings`
|
||||
with all fields. The Page title input is validated client-side for
|
||||
non-blank content; an empty or whitespace-only Page title disables the
|
||||
@@ -134,13 +131,11 @@ two pure helpers exported from
|
||||
`frontend/src/app/features/admin/general.pure.ts`:
|
||||
|
||||
* `isoDatetimeValidator(ctrl)` — an Angular reactive-forms validator
|
||||
that returns `null` for an empty value and `{ invalidDatetime: true }`
|
||||
for any non-empty value that `Date.parse` cannot parse. Empty is
|
||||
intentionally valid so the event window can be cleared.
|
||||
that returns `null` only when `Date.parse` accepts the value. Empty and
|
||||
malformed values return `{ invalidDatetime: true }`.
|
||||
* `datetimeMessage(fieldLabel, value, controlErrors)` — renders the
|
||||
human-readable message `"<Field> must be a valid ISO-8601 datetime."`
|
||||
either when `controlErrors.invalidDatetime` is set, or as a fallback
|
||||
when the raw value itself is non-empty and unparseable.
|
||||
when `invalidDatetime` is set or when the raw value is unparseable.
|
||||
|
||||
The component wires both controls (`eventStartUtc`, `eventEndUtc`) with
|
||||
this validator and keeps three local `signal`s per field — `Value`,
|
||||
@@ -156,19 +151,20 @@ The `computed` signals `showEventStartError` / `showEventEndError` and
|
||||
|
||||
| Condition | Message |
|
||||
|------------------------------------------------------------|--------------------------------------------------------|
|
||||
| Empty value (`''`) | `null` (no error; the event window may be unconfigured). |
|
||||
| Non-empty value that `Date.parse` accepts | `null` (no error). |
|
||||
| Non-empty value that `Date.parse` rejects | `"<Field> must be a valid ISO-8601 datetime."` |
|
||||
| Control carries `invalidDatetime` error | Same message (covered by the validator path). |
|
||||
| Empty value (`''`) | `"<Field> must be a valid ISO-8601 datetime."` |
|
||||
| Value that `Date.parse` accepts | `null` (no error). |
|
||||
| Non-empty value that `Date.parse` rejects | `"<Field> must be a valid ISO-8601 datetime."` |
|
||||
| Control carries `invalidDatetime` error | Same message (covered by the validator path). |
|
||||
|
||||
The error is shown only when the control is both `touched || dirty`
|
||||
AND `invalid`, so the inputs do not flash errors on initial load. After
|
||||
a successful Save, both controls are reset to untouched/pristine via
|
||||
`resetTouchedState()` and their `TouchedOrDirty` signals are cleared.
|
||||
The cross-field `endBeforeStart` error (`general-endBeforeStart`) is
|
||||
still emitted from the form-level `superRefine`/validator chain and is
|
||||
unchanged — it now sits next to the new per-field messages when the
|
||||
user supplies two non-empty values that are out of order.
|
||||
emitted by the form-level validator whenever both valid timestamps are
|
||||
present and end is not strictly after start. The Event end input also
|
||||
receives `aria-invalid="true"`, references both possible error elements,
|
||||
and exposes `Event end must be after event start.` as its title.
|
||||
|
||||
# Visual elements
|
||||
|
||||
@@ -193,7 +189,7 @@ user supplies two non-empty values that are out of order.
|
||||
| 3 | `frontend/src/app/core/services/admin.service.ts` | `getGeneralSettings()` → `GET /api/v1/admin/general/settings`; `listAdminThemes()` → `GET /api/v1/admin/general/themes`; `updateGeneralSettings()` → `PUT .../settings`; `uploadLogo()` → `POST /api/v1/uploads/logo`. |
|
||||
| 4 | `backend/src/modules/admin/admin-general.controller.ts` | `AdminGuard` + `@Roles('admin')` on every handler. |
|
||||
| 5 | `backend/src/modules/admin/general.service.ts` | `getSettings` reads 8 keys via `SettingsService`; `updateSettings` writes all 8, emits `{ topic: 'general', themeKey }` via `SseHubService`. |
|
||||
| 6 | `backend/src/modules/admin/dto/general.dto.ts` | `GeneralSettingsSchema` enforces string lengths, `themeKey` enum, per-field ISO-8601 datetime check on `eventStartUtc`/`eventEndUtc` (empty string allowed), and `eventEndUtc > eventStartUtc` via `superRefine`. |
|
||||
| 6 | `backend/src/modules/admin/dto/general.dto.ts` | `GeneralSettingsSchema` requires ISO-8601 values for both event-window fields and enforces `eventEndUtc > eventStartUtc` via `superRefine`. |
|
||||
|
||||
# Notes
|
||||
|
||||
@@ -202,8 +198,11 @@ user supplies two non-empty values that are out of order.
|
||||
without polling. Other tabs do not auto-refresh settings values.
|
||||
* The "Event controls" toggle is intentionally a derived display, not
|
||||
an editable control — adjust the UTC timestamps to change state.
|
||||
* All timestamps are stored as ISO-8601 UTC strings in the `setting`
|
||||
* All valid timestamps are stored as ISO-8601 UTC strings in the `setting`
|
||||
table; the UI converts to/from `datetime-local` for display.
|
||||
* Both timestamps are required by the General Settings form and API.
|
||||
The `UNCONFIGURED` derived display remains a defensive state for missing
|
||||
or invalid data, but clearing either input makes the form unsavable.
|
||||
* Saving the form requires the page title and default challenge IP to
|
||||
be non-empty; the form is `invalid` and Save stays disabled until
|
||||
they are.
|
||||
|
||||
Reference in New Issue
Block a user