feat(i18n): implement dynamic system wording management

Add database schema and API endpoints for system wording keys and values
Replace hardcoded translations in frontend and backend with dynamic messages
Add System Wordings management interface to Admin view
This commit is contained in:
2026-05-02 11:48:11 +08:00
parent e8e20539c9
commit 976a2a2482
18 changed files with 2095 additions and 1087 deletions

View File

@@ -1,9 +1,11 @@
FROM node:22-alpine
WORKDIR /app
WORKDIR /app/backend
COPY backend/package.json ./
RUN corepack enable && pnpm install
COPY backend/. .
COPY data ./data
COPY data /app/data
COPY package.json /app/package.json
COPY system-wordings.ts /app/system-wordings.ts
EXPOSE 3001
CMD ["pnpm", "run", "start"]

View File

@@ -85,6 +85,39 @@ CREATE TABLE IF NOT EXISTS users (
CHECK (length(display_name) BETWEEN 1 AND 40)
);
CREATE TABLE IF NOT EXISTS system_wording_keys (
key text PRIMARY KEY,
module text NOT NULL,
surface text NOT NULL CHECK (surface IN ('frontend', 'backend', 'email')),
description text NOT NULL DEFAULT '',
placeholders jsonb NOT NULL DEFAULT '[]'::jsonb CHECK (jsonb_typeof(placeholders) = 'array'),
enabled boolean NOT NULL DEFAULT true,
created_at timestamptz NOT NULL DEFAULT now(),
updated_at timestamptz NOT NULL DEFAULT now(),
CHECK (key ~ '^[A-Za-z][A-Za-z0-9]*(\.[A-Za-z][A-Za-z0-9]*)+$'),
CHECK (length(module) BETWEEN 1 AND 80)
);
CREATE INDEX IF NOT EXISTS system_wording_keys_module_idx
ON system_wording_keys(module, key);
CREATE INDEX IF NOT EXISTS system_wording_keys_surface_idx
ON system_wording_keys(surface, key);
CREATE TABLE IF NOT EXISTS system_wording_values (
key text NOT NULL REFERENCES system_wording_keys(key) ON DELETE CASCADE,
locale text NOT NULL REFERENCES languages(code) ON DELETE CASCADE,
value text NOT NULL CHECK (length(value) > 0),
created_by_user_id integer REFERENCES users(id) ON DELETE SET NULL,
updated_by_user_id integer REFERENCES users(id) ON DELETE SET NULL,
created_at timestamptz NOT NULL DEFAULT now(),
updated_at timestamptz NOT NULL DEFAULT now(),
PRIMARY KEY (key, locale)
);
CREATE INDEX IF NOT EXISTS system_wording_values_locale_idx
ON system_wording_values(locale, key);
CREATE TABLE IF NOT EXISTS email_verification_tokens (
id integer GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
user_id integer NOT NULL REFERENCES users(id) ON DELETE CASCADE,

View File

@@ -2,6 +2,7 @@ import { createHash, randomBytes, scrypt as scryptCallback, timingSafeEqual } fr
import { promisify } from 'node:util';
import type { PoolClient, QueryResultRow } from 'pg';
import { pool, queryOne } from './db.ts';
import { systemMessage } from './systemWordingQueries.ts';
const scrypt = promisify(scryptCallback);
const passwordKeyLength = 64;
@@ -53,87 +54,64 @@ function statusError(message: string, statusCode: number): StatusError {
return error;
}
function authMessage(locale: string, key: AuthMessageKey, params: Record<string, string | number> = {}): string {
const messages: Record<string, Record<AuthMessageKey, string>> = {
en: {
emailRequired: 'Email is required',
invalidEmail: 'Email format is invalid',
displayNameRequired: 'Display name is required',
displayNameLength: 'Display name must be 1 to 40 characters',
passwordLength: 'Password must be at least 8 characters',
invalidToken: 'The verification link is invalid or expired',
emailAlreadyRegistered: 'This email is already registered',
checkVerificationEmail: 'Please check your verification email',
emailVerified: 'Email verified',
invalidCredentials: 'Email or password is incorrect',
verifyEmailFirst: 'Please complete email verification first',
emailSubject: 'Verify your Pokopia Wiki email',
emailHtml:
'<p>Open the link below to verify your email:</p><p><a href="{url}">Verify email</a></p><p>The link expires in {hours} hours.</p>',
emailText: 'Open this link to verify your Pokopia Wiki email: {url}\nThe link expires in {hours} hours.'
},
'zh-CN': {
emailRequired: '请输入邮箱',
invalidEmail: '邮箱格式不正确',
displayNameRequired: '请输入显示名',
displayNameLength: '显示名长度需为 1 到 40 个字符',
passwordLength: '密码至少需要 8 个字符',
invalidToken: '验证链接无效或已过期',
emailAlreadyRegistered: '该邮箱已注册',
checkVerificationEmail: '请查收验证邮件',
emailVerified: '邮箱已验证',
invalidCredentials: '邮箱或密码不正确',
verifyEmailFirst: '请先完成邮箱验证',
emailSubject: '验证你的 Pokopia Wiki 邮箱',
emailHtml: '<p>请点击下面的链接完成邮箱验证:</p><p><a href="{url}">验证邮箱</a></p><p>链接将在 {hours} 小时后失效。</p>',
emailText: '请打开以下链接完成 Pokopia Wiki 邮箱验证:{url}\n链接将在 {hours} 小时后失效。'
}
function authMessage(locale: string, key: AuthMessageKey, params: Record<string, string | number> = {}): Promise<string> {
const messageKeys: Record<AuthMessageKey, string> = {
emailRequired: 'server.auth.emailRequired',
invalidEmail: 'server.auth.invalidEmail',
displayNameRequired: 'server.auth.displayNameRequired',
displayNameLength: 'server.auth.displayNameLength',
passwordLength: 'server.auth.passwordLength',
invalidToken: 'server.auth.invalidToken',
emailAlreadyRegistered: 'server.auth.emailAlreadyRegistered',
checkVerificationEmail: 'server.auth.checkVerificationEmail',
emailVerified: 'server.auth.emailVerified',
invalidCredentials: 'server.auth.invalidCredentials',
verifyEmailFirst: 'server.auth.verifyEmailFirst',
emailSubject: 'email.auth.verificationSubject',
emailHtml: 'email.auth.verificationHtml',
emailText: 'email.auth.verificationText'
};
let message = messages[locale]?.[key] ?? messages[defaultLocale][key];
for (const [paramKey, paramValue] of Object.entries(params)) {
message = message.replaceAll(`{${paramKey}}`, String(paramValue));
}
return message;
return systemMessage(locale || defaultLocale, messageKeys[key], params);
}
function cleanEmail(value: unknown, locale: string): string {
async function cleanEmail(value: unknown, locale: string): Promise<string> {
if (typeof value !== 'string') {
throw statusError(authMessage(locale, 'emailRequired'), 400);
throw statusError(await authMessage(locale, 'emailRequired'), 400);
}
const email = value.trim().toLowerCase();
if (!/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email)) {
throw statusError(authMessage(locale, 'invalidEmail'), 400);
throw statusError(await authMessage(locale, 'invalidEmail'), 400);
}
return email;
}
function cleanDisplayName(value: unknown, locale: string): string {
async function cleanDisplayName(value: unknown, locale: string): Promise<string> {
if (typeof value !== 'string') {
throw statusError(authMessage(locale, 'displayNameRequired'), 400);
throw statusError(await authMessage(locale, 'displayNameRequired'), 400);
}
const displayName = value.trim();
if (displayName.length < 1 || displayName.length > 40) {
throw statusError(authMessage(locale, 'displayNameLength'), 400);
throw statusError(await authMessage(locale, 'displayNameLength'), 400);
}
return displayName;
}
function cleanPassword(value: unknown, locale: string): string {
async function cleanPassword(value: unknown, locale: string): Promise<string> {
if (typeof value !== 'string' || value.length < 8) {
throw statusError(authMessage(locale, 'passwordLength'), 400);
throw statusError(await authMessage(locale, 'passwordLength'), 400);
}
return value;
}
function cleanToken(value: unknown, locale: string): string {
async function cleanToken(value: unknown, locale: string): Promise<string> {
if (typeof value !== 'string' || value.trim().length < 32) {
throw statusError(authMessage(locale, 'invalidToken'), 400);
throw statusError(await authMessage(locale, 'invalidToken'), 400);
}
return value.trim();
@@ -219,6 +197,9 @@ function buildVerificationUrl(token: string): string {
async function sendVerificationEmail(email: string, token: string, locale: string): Promise<void> {
const { apiKey, from } = getEmailConfig();
const verificationUrl = buildVerificationUrl(token);
const subject = await authMessage(locale, 'emailSubject');
const html = await authMessage(locale, 'emailHtml', { url: verificationUrl, hours: verificationTokenHours });
const text = await authMessage(locale, 'emailText', { url: verificationUrl, hours: verificationTokenHours });
const response = await fetch('https://api.resend.com/emails', {
method: 'POST',
headers: {
@@ -228,9 +209,9 @@ async function sendVerificationEmail(email: string, token: string, locale: strin
body: JSON.stringify({
from,
to: [email],
subject: authMessage(locale, 'emailSubject'),
html: authMessage(locale, 'emailHtml', { url: verificationUrl, hours: verificationTokenHours }),
text: authMessage(locale, 'emailText', { url: verificationUrl, hours: verificationTokenHours })
subject,
html,
text
})
});
@@ -241,9 +222,9 @@ async function sendVerificationEmail(email: string, token: string, locale: strin
}
export async function registerUser(payload: Record<string, unknown>, locale = defaultLocale) {
const email = cleanEmail(payload.email, locale);
const displayName = cleanDisplayName(payload.displayName, locale);
const password = cleanPassword(payload.password, locale);
const email = await cleanEmail(payload.email, locale);
const displayName = await cleanDisplayName(payload.displayName, locale);
const password = await cleanPassword(payload.password, locale);
const passwordHash = await hashPassword(password);
const verificationToken = createPlainToken();
const verificationTokenHash = hashToken(verificationToken);
@@ -256,7 +237,7 @@ export async function registerUser(payload: Record<string, unknown>, locale = de
);
if (existingUser?.email_verified_at) {
throw statusError(authMessage(locale, 'emailAlreadyRegistered'), 409);
throw statusError(await authMessage(locale, 'emailAlreadyRegistered'), 409);
}
const user = existingUser
@@ -295,11 +276,11 @@ export async function registerUser(payload: Record<string, unknown>, locale = de
});
await sendVerificationEmail(email, verificationToken, locale);
return { message: authMessage(locale, 'checkVerificationEmail') };
return { message: await authMessage(locale, 'checkVerificationEmail') };
}
export async function verifyEmail(payload: Record<string, unknown>, locale = defaultLocale) {
const token = cleanToken(payload.token, locale);
const token = await cleanToken(payload.token, locale);
const tokenHash = hashToken(token);
return withTransaction(async (client) => {
@@ -317,7 +298,7 @@ export async function verifyEmail(payload: Record<string, unknown>, locale = def
);
if (!tokenRow) {
throw statusError(authMessage(locale, 'invalidToken'), 400);
throw statusError(await authMessage(locale, 'invalidToken'), 400);
}
const user = await clientQueryOne<UserRow>(
@@ -332,31 +313,31 @@ export async function verifyEmail(payload: Record<string, unknown>, locale = def
);
if (!user) {
throw statusError(authMessage(locale, 'invalidToken'), 400);
throw statusError(await authMessage(locale, 'invalidToken'), 400);
}
await client.query('UPDATE email_verification_tokens SET used_at = now() WHERE user_id = $1 AND used_at IS NULL', [
user.id
]);
return { message: authMessage(locale, 'emailVerified'), user: toPublicUser(user) };
return { message: await authMessage(locale, 'emailVerified'), user: toPublicUser(user) };
});
}
export async function loginUser(payload: Record<string, unknown>, locale = defaultLocale) {
const email = cleanEmail(payload.email, locale);
const password = cleanPassword(payload.password, locale);
const email = await cleanEmail(payload.email, locale);
const password = await cleanPassword(payload.password, locale);
const user = await queryOne<LoginUserRow>(
'SELECT id, email, display_name, email_verified_at, password_hash FROM users WHERE email = $1',
[email]
);
if (!user || !(await verifyPassword(password, user.password_hash))) {
throw statusError(authMessage(locale, 'invalidCredentials'), 401);
throw statusError(await authMessage(locale, 'invalidCredentials'), 401);
}
if (!user.email_verified_at) {
throw statusError(authMessage(locale, 'verifyEmailFirst'), 403);
throw statusError(await authMessage(locale, 'verifyEmailFirst'), 403);
}
const sessionToken = createPlainToken();

View File

@@ -62,6 +62,14 @@ import {
updatePokemon,
updateRecipe
} from './queries.ts';
import {
getSystemWordings,
listSystemWordingRows,
localizedStatusMessage,
syncSystemWordingCatalog,
systemMessage,
updateSystemWordingValue
} from './systemWordingQueries.ts';
const app = Fastify({
logger: true
@@ -78,23 +86,23 @@ app.setErrorHandler(async (error, _request, reply) => {
const locale = requestLocale(_request);
if (pgError.code === '23503') {
return reply.code(409).send({ message: serverMessage(locale, 'foreignKey') });
return reply.code(409).send({ message: await serverMessage(locale, 'foreignKey') });
}
if (pgError.code === '23505') {
return reply.code(409).send({ message: serverMessage(locale, 'duplicate') });
return reply.code(409).send({ message: await serverMessage(locale, 'duplicate') });
}
if (pgError.code === '23514') {
return reply.code(400).send({ message: serverMessage(locale, 'invalidField') });
return reply.code(400).send({ message: await serverMessage(locale, 'invalidField') });
}
if (pgError.statusCode && pgError.statusCode < 500) {
return reply.code(pgError.statusCode).send({ message: pgError.message });
return reply.code(pgError.statusCode).send({ message: await localizedStatusMessage(locale, pgError.message) });
}
app.log.error(error);
return reply.code(500).send({ message: serverMessage(locale, 'serverError') });
return reply.code(500).send({ message: await serverMessage(locale, 'serverError') });
});
app.get('/health', async () => ({ ok: true }));
@@ -111,27 +119,15 @@ function requestLocale(request: FastifyRequest): string {
return cleanLocale(queryLocale ?? (Array.isArray(headerLocale) ? headerLocale[0] : headerLocale));
}
function serverMessage(locale: string, key: 'foreignKey' | 'duplicate' | 'invalidField' | 'serverError' | 'loginRequired' | 'verifyEmailFirst'): string {
const messages = {
en: {
foreignKey: 'Referenced data does not exist or the record is currently in use',
duplicate: 'A record with the same name or ID already exists',
invalidField: 'Field value is invalid',
serverError: 'Server error',
loginRequired: 'Please log in first',
verifyEmailFirst: 'Please complete email verification first'
},
'zh-CN': {
foreignKey: '引用的数据不存在,或当前记录正在被使用',
duplicate: '同名或相同 ID 的记录已存在',
invalidField: '字段值不合法',
serverError: '服务器错误',
loginRequired: '请先登录',
verifyEmailFirst: '请先完成邮箱验证'
}
};
function serverMessage(
locale: string,
key: 'foreignKey' | 'duplicate' | 'invalidField' | 'serverError' | 'loginRequired' | 'verifyEmailFirst' | 'notFound'
): Promise<string> {
return systemMessage(locale, `server.errors.${key}`);
}
return messages[locale as keyof typeof messages]?.[key] ?? messages.en[key];
async function notFound(reply: FastifyReply, request: FastifyRequest) {
return reply.code(404).send({ message: await serverMessage(requestLocale(request), 'notFound') });
}
async function requireVerifiedUser(request: FastifyRequest, reply: FastifyReply): Promise<AuthUser | null> {
@@ -140,12 +136,12 @@ async function requireVerifiedUser(request: FastifyRequest, reply: FastifyReply)
const locale = requestLocale(request);
if (!user) {
reply.code(401).send({ message: serverMessage(locale, 'loginRequired') });
reply.code(401).send({ message: await serverMessage(locale, 'loginRequired') });
return null;
}
if (!user.emailVerified) {
reply.code(403).send({ message: serverMessage(locale, 'verifyEmailFirst') });
reply.code(403).send({ message: await serverMessage(locale, 'verifyEmailFirst') });
return null;
}
@@ -178,7 +174,7 @@ app.get('/api/auth/me', async (request, reply) => {
const user = token ? await getUserBySessionToken(token) : null;
if (!user) {
return reply.code(401).send({ message: serverMessage(requestLocale(request), 'loginRequired') });
return reply.code(401).send({ message: await serverMessage(requestLocale(request), 'loginRequired') });
}
return { user };
@@ -195,6 +191,8 @@ app.post('/api/auth/logout', async (request, reply) => {
app.get('/api/languages', async () => listLanguages());
app.get('/api/system-wordings', async (request) => getSystemWordings(requestLocale(request)));
app.get('/api/options', async (request) => getOptions(requestLocale(request)));
app.get('/api/daily-checklist', async (request) => listDailyChecklistItems(requestLocale(request)));
@@ -218,7 +216,7 @@ app.post('/api/life-posts/:postId/comments', async (request, reply) => {
}
const { postId } = request.params as { postId: string };
const comment = await createLifeComment(Number(postId), request.body as Record<string, unknown>, user.id);
return comment ? reply.code(201).send(comment) : reply.code(404).send({ message: 'Not found' });
return comment ? reply.code(201).send(comment) : notFound(reply, request);
});
app.post('/api/life-posts/:postId/comments/:commentId/replies', async (request, reply) => {
@@ -233,7 +231,7 @@ app.post('/api/life-posts/:postId/comments/:commentId/replies', async (request,
request.body as Record<string, unknown>,
user.id
);
return comment ? reply.code(201).send(comment) : reply.code(404).send({ message: 'Not found' });
return comment ? reply.code(201).send(comment) : notFound(reply, request);
});
app.put('/api/life-posts/:id', async (request, reply) => {
@@ -243,7 +241,7 @@ app.put('/api/life-posts/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const post = await updateLifePost(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
return post ? post : reply.code(404).send({ message: 'Not found' });
return post ? post : notFound(reply, request);
});
app.put('/api/life-posts/:id/reaction', async (request, reply) => {
@@ -253,7 +251,7 @@ app.put('/api/life-posts/:id/reaction', async (request, reply) => {
}
const { id } = request.params as { id: string };
const post = await setLifePostReaction(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
return post ? post : reply.code(404).send({ message: 'Not found' });
return post ? post : notFound(reply, request);
});
app.delete('/api/life-posts/:id/reaction', async (request, reply) => {
@@ -263,7 +261,7 @@ app.delete('/api/life-posts/:id/reaction', async (request, reply) => {
}
const { id } = request.params as { id: string };
const post = await deleteLifePostReaction(Number(id), user.id, requestLocale(request));
return post ? post : reply.code(404).send({ message: 'Not found' });
return post ? post : notFound(reply, request);
});
app.delete('/api/life-posts/:id', async (request, reply) => {
@@ -273,7 +271,7 @@ app.delete('/api/life-posts/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteLifePost(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.delete('/api/life-comments/:id', async (request, reply) => {
@@ -283,13 +281,13 @@ app.delete('/api/life-comments/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteLifeComment(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/discussions/:entityType/:entityId/comments', async (request, reply) => {
const { entityType, entityId } = request.params as { entityType: string; entityId: string };
const comments = await listEntityDiscussionComments(entityType, Number(entityId));
return comments ? comments : reply.code(404).send({ message: 'Not found' });
return comments ? comments : notFound(reply, request);
});
app.post('/api/discussions/:entityType/:entityId/comments', async (request, reply) => {
@@ -305,7 +303,7 @@ app.post('/api/discussions/:entityType/:entityId/comments', async (request, repl
request.body as Record<string, unknown>,
user.id
);
return comment ? reply.code(201).send(comment) : reply.code(404).send({ message: 'Not found' });
return comment ? reply.code(201).send(comment) : notFound(reply, request);
});
app.post('/api/discussions/:entityType/:entityId/comments/:commentId/replies', async (request, reply) => {
@@ -326,7 +324,7 @@ app.post('/api/discussions/:entityType/:entityId/comments/:commentId/replies', a
request.body as Record<string, unknown>,
user.id
);
return comment ? reply.code(201).send(comment) : reply.code(404).send({ message: 'Not found' });
return comment ? reply.code(201).send(comment) : notFound(reply, request);
});
app.delete('/api/discussions/comments/:id', async (request, reply) => {
@@ -337,7 +335,7 @@ app.delete('/api/discussions/comments/:id', async (request, reply) => {
const { id } = request.params as { id: string };
const deleted = await deleteEntityDiscussionComment(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/pokemon', async (request) =>
@@ -356,7 +354,7 @@ app.get('/api/pokemon/:id', async (request, reply) => {
const pokemon = await getPokemon(Number(id), requestLocale(request));
if (!pokemon) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return pokemon;
@@ -383,7 +381,7 @@ app.put('/api/pokemon/:id', async (request, reply) => {
const pokemon = await updatePokemon(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
if (!pokemon) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return pokemon;
@@ -396,7 +394,7 @@ app.delete('/api/pokemon/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deletePokemon(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/habitats', async (request) => listHabitats(requestLocale(request)));
@@ -406,7 +404,7 @@ app.get('/api/habitats/:id', async (request, reply) => {
const habitat = await getHabitat(Number(id), requestLocale(request));
if (!habitat) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return habitat;
@@ -428,7 +426,7 @@ app.put('/api/habitats/:id', async (request, reply) => {
const habitat = await updateHabitat(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
if (!habitat) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return habitat;
@@ -441,7 +439,7 @@ app.delete('/api/habitats/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteHabitat(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/items', async (request) =>
@@ -453,7 +451,7 @@ app.get('/api/items/:id', async (request, reply) => {
const item = await getItem(Number(id), requestLocale(request));
if (!item) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return item;
@@ -475,7 +473,7 @@ app.put('/api/items/:id', async (request, reply) => {
const item = await updateItem(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
if (!item) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return item;
@@ -488,7 +486,7 @@ app.delete('/api/items/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteItem(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/recipes', async (request) =>
@@ -500,7 +498,7 @@ app.get('/api/recipes/:id', async (request, reply) => {
const recipe = await getRecipe(Number(id), requestLocale(request));
if (!recipe) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return recipe;
@@ -522,7 +520,7 @@ app.put('/api/recipes/:id', async (request, reply) => {
const recipe = await updateRecipe(Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
if (!recipe) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return recipe;
@@ -535,7 +533,7 @@ app.delete('/api/recipes/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteRecipe(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.post('/api/admin/daily-checklist', async (request, reply) => {
@@ -564,7 +562,7 @@ app.put('/api/admin/daily-checklist/:id', async (request, reply) => {
user.id,
requestLocale(request)
);
return item ? item : reply.code(404).send({ message: 'Not found' });
return item ? item : notFound(reply, request);
});
app.delete('/api/admin/daily-checklist/:id', async (request, reply) => {
@@ -574,7 +572,7 @@ app.delete('/api/admin/daily-checklist/:id', async (request, reply) => {
}
const { id } = request.params as { id: string };
const deleted = await deleteDailyChecklistItem(Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.put('/api/admin/pokemon/order', async (request, reply) => {
@@ -628,7 +626,21 @@ app.delete('/api/admin/languages/:code', async (request, reply) => {
}
const { code } = request.params as { code: string };
const deleted = await deleteLanguage(code);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
app.get('/api/admin/system-wordings', async (request, reply) => {
const user = await requireVerifiedUser(request, reply);
return user ? listSystemWordingRows(request.query as Record<string, unknown>) : undefined;
});
app.put('/api/admin/system-wordings/:key', async (request, reply) => {
const user = await requireVerifiedUser(request, reply);
if (!user) {
return;
}
const { key } = request.params as { key: string };
return updateSystemWordingValue(key, request.body as Record<string, unknown>, user.id);
});
app.get('/api/admin/config/:type', async (request, reply) => {
@@ -638,7 +650,7 @@ app.get('/api/admin/config/:type', async (request, reply) => {
}
const { type } = request.params as { type: string };
if (!isConfigType(type)) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return listConfig(type, requestLocale(request));
});
@@ -650,7 +662,7 @@ app.post('/api/admin/config/:type', async (request, reply) => {
}
const { type } = request.params as { type: string };
if (!isConfigType(type)) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return reply
.code(201)
@@ -664,7 +676,7 @@ app.put('/api/admin/config/:type/order', async (request, reply) => {
}
const { type } = request.params as { type: string };
if (!isConfigType(type)) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
return reorderConfig(type, request.body as Record<string, unknown>, user.id, requestLocale(request));
});
@@ -676,10 +688,10 @@ app.put('/api/admin/config/:type/:id', async (request, reply) => {
}
const { type, id } = request.params as { type: string; id: string };
if (!isConfigType(type)) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
const config = await updateConfig(type, Number(id), request.body as Record<string, unknown>, user.id, requestLocale(request));
return config ? config : reply.code(404).send({ message: 'Not found' });
return config ? config : notFound(reply, request);
});
app.delete('/api/admin/config/:type/:id', async (request, reply) => {
@@ -689,16 +701,17 @@ app.delete('/api/admin/config/:type/:id', async (request, reply) => {
}
const { type, id } = request.params as { type: string; id: string };
if (!isConfigType(type)) {
return reply.code(404).send({ message: 'Not found' });
return notFound(reply, request);
}
const deleted = await deleteConfig(type, Number(id), user.id);
return deleted ? reply.code(204).send() : reply.code(404).send({ message: 'Not found' });
return deleted ? reply.code(204).send() : notFound(reply, request);
});
const port = Number(process.env.BACKEND_PORT ?? 3001);
try {
await initializeDatabase();
await syncSystemWordingCatalog();
await app.listen({ host: '0.0.0.0', port });
} catch (error) {
app.log.error(error);

View File

@@ -0,0 +1,348 @@
import { defaultLocale, systemWordingCatalogEntries, systemWordingFallback, type SystemWordingTree } from '../../system-wordings.ts';
import { pool, query } from './db.ts';
type SystemWordingSurface = 'frontend' | 'backend' | 'email';
type SystemWordingValueRow = {
key: string;
module: string;
surface: SystemWordingSurface;
description: string;
placeholders: unknown;
value: string;
defaultValue: string;
missing: boolean;
updatedAt: Date | null;
updatedBy: { id: number; displayName: string } | null;
};
type ValidationError = Error & { statusCode: number };
const localePattern = /^[a-z]{2}(-[A-Z]{2})?$/;
const wordingKeyPattern = /^[A-Za-z][A-Za-z0-9]*(\.[A-Za-z][A-Za-z0-9]*)+$/;
const placeholderPattern = /\{([A-Za-z0-9_]+)\}/g;
const surfaces = new Set<SystemWordingSurface>(['frontend', 'backend', 'email']);
const legacyMessageKeys = new Map<string, string>([
['Record does not exist', 'server.validation.recordMissing'],
['Language code is invalid', 'server.validation.languageCodeInvalid'],
['Language name is required', 'server.validation.languageNameRequired'],
['Default language must be English', 'server.validation.defaultLanguageMustBeEnglish'],
['Default language must be enabled', 'server.validation.defaultLanguageMustBeEnabled'],
['Language not found', 'server.validation.languageNotFound'],
['A default language is required', 'server.validation.defaultLanguageRequired'],
['Default language cannot be deleted', 'server.validation.defaultLanguageCannotBeDeleted'],
['Please select a language', 'server.validation.selectLanguage'],
['Language does not exist', 'server.validation.languageDoesNotExist'],
['Pokemon identifier is required', 'server.validation.pokemonIdentifierRequired'],
['Pokemon type data is unavailable', 'server.validation.pokemonTypeDataUnavailable'],
['Pokemon data was not found', 'server.validation.pokemonDataNotFound'],
['Please enter a task', 'server.validation.taskRequired'],
['Please select a task', 'server.validation.selectTask'],
['Task does not exist', 'server.validation.taskDoesNotExist'],
['Please enter a post', 'server.validation.postRequired'],
['Post is too long', 'server.validation.postTooLong'],
['Please enter a comment', 'server.validation.commentRequired'],
['Comment is too long', 'server.validation.commentTooLong'],
['Reaction is invalid', 'server.validation.reactionInvalid'],
['Cursor is invalid', 'server.validation.cursorInvalid'],
['Tag is invalid', 'server.validation.tagInvalid'],
['Entity type is invalid', 'server.validation.entityTypeInvalid'],
['Record is invalid', 'server.validation.recordInvalid'],
['Comment is invalid', 'server.validation.commentInvalid'],
['Please select a record', 'server.validation.selectRecord'],
['Choose at least 1 type', 'server.validation.typeMin'],
['Choose at most 2 types', 'server.validation.typeMax'],
['Choose at most 2 specialities', 'server.validation.skillMax'],
['Choose at most 6 favourites', 'server.validation.favoriteMax'],
['Drop items must be linked to selected specialities', 'server.validation.dropItemSelectedSkill'],
['Pokemon ID is required', 'server.validation.pokemonIdRequired'],
['Pokemon name is required', 'server.validation.pokemonNameRequired'],
['Height must be a non-negative number', 'server.validation.heightNonNegative'],
['Weight must be a non-negative number', 'server.validation.weightNonNegative'],
['Ideal Habitat is required', 'server.validation.environmentRequired'],
['This speciality cannot have a drop item', 'server.validation.skillNoDrop'],
['Habitat name is required', 'server.validation.habitatNameRequired'],
['Usage is required', 'server.validation.usageRequired'],
['Item name is required', 'server.validation.itemNameRequired'],
['Category is required', 'server.validation.categoryRequired'],
['An item with a recipe cannot be marked as recipe-free', 'server.validation.recipeFreeWithRecipe'],
['Item is required', 'server.validation.itemRequired'],
['This item is marked as recipe-free', 'server.validation.recipeFreeItem'],
['Name is required', 'server.validation.nameRequired']
]);
function validationError(message: string): ValidationError {
const error = new Error(message) as ValidationError;
error.statusCode = 400;
return error;
}
function cleanLocale(value: unknown): string {
const locale = typeof value === 'string' ? value.trim() : '';
return localePattern.test(locale) ? locale : defaultLocale;
}
function requireLocale(value: unknown): string {
const locale = typeof value === 'string' ? value.trim() : '';
if (!localePattern.test(locale)) {
throw validationError('server.wordings.localeRequired');
}
return locale;
}
function requireWordingKey(value: unknown): string {
const key = typeof value === 'string' ? value.trim() : '';
if (!wordingKeyPattern.test(key)) {
throw validationError('server.wordings.keyNotFound');
}
return key;
}
function cleanSurface(value: unknown): SystemWordingSurface | '' {
const surface = typeof value === 'string' ? value.trim() : '';
return surfaces.has(surface as SystemWordingSurface) ? (surface as SystemWordingSurface) : '';
}
function collectPlaceholders(value: string): string[] {
return [...new Set([...value.matchAll(placeholderPattern)].map((match) => match[1]))].sort();
}
function placeholdersMatch(first: string[], second: string[]): boolean {
return first.length === second.length && first.every((placeholder, index) => placeholder === second[index]);
}
function interpolate(message: string, params: Record<string, string | number>): string {
return Object.entries(params).reduce(
(nextMessage, [key, value]) => nextMessage.replaceAll(`{${key}}`, String(value)),
message
);
}
function setNestedMessage(target: SystemWordingTree, key: string, value: string): void {
const parts = key.split('.');
let node = target;
for (const part of parts.slice(0, -1)) {
const current = node[part];
if (typeof current !== 'object' || current === null) {
node[part] = {};
}
node = node[part] as SystemWordingTree;
}
node[parts[parts.length - 1]] = value;
}
function nestedMessages(rows: Array<{ key: string; value: string }>): SystemWordingTree {
const messages: SystemWordingTree = {};
for (const row of rows) {
setNestedMessage(messages, row.key, row.value);
}
return messages;
}
function normalizePlaceholders(value: unknown): string[] {
return Array.isArray(value) ? value.map((item) => String(item)).sort() : [];
}
function legacyMessageKey(message: string): string | null {
if (message.startsWith('server.') || message.startsWith('email.')) {
return message;
}
if (message.endsWith(' must be a non-negative integer')) {
return 'server.validation.statNonNegative';
}
if (message.endsWith(' is empty')) {
return 'server.validation.pokemonDataFileEmpty';
}
if (message.startsWith('Pokemon data file ') && message.endsWith(' is unavailable')) {
return 'server.validation.pokemonDataFileUnavailable';
}
return legacyMessageKeys.get(message) ?? null;
}
export async function syncSystemWordingCatalog(): Promise<void> {
const entries = systemWordingCatalogEntries();
const client = await pool.connect();
try {
await client.query('BEGIN');
for (const entry of entries) {
await client.query(
`
INSERT INTO system_wording_keys (key, module, surface, description, placeholders)
VALUES ($1, $2, $3, $4, $5::jsonb)
ON CONFLICT (key) DO UPDATE
SET module = EXCLUDED.module,
surface = EXCLUDED.surface,
description = EXCLUDED.description,
placeholders = EXCLUDED.placeholders,
updated_at = now()
`,
[entry.key, entry.module, entry.surface, entry.description, JSON.stringify(entry.placeholders)]
);
for (const [locale, value] of Object.entries(entry.values)) {
await client.query(
`
INSERT INTO system_wording_values (key, locale, value)
VALUES ($1, $2, $3)
ON CONFLICT (key, locale) DO NOTHING
`,
[entry.key, locale, value]
);
}
}
await client.query('COMMIT');
} catch (error) {
await client.query('ROLLBACK');
throw error;
} finally {
client.release();
}
}
export async function systemMessage(
locale: string,
key: string,
params: Record<string, string | number> = {}
): Promise<string> {
const requestedLocale = cleanLocale(locale);
try {
const result = await pool.query<{ value: string }>(
`
SELECT COALESCE(requested.value, fallback.value) AS value
FROM system_wording_keys k
LEFT JOIN system_wording_values requested
ON requested.key = k.key
AND requested.locale = $2
LEFT JOIN system_wording_values fallback
ON fallback.key = k.key
AND fallback.locale = $3
WHERE k.key = $1
`,
[key, requestedLocale, defaultLocale]
);
const message = result.rows[0]?.value ?? systemWordingFallback(key, requestedLocale) ?? key;
return interpolate(message, params);
} catch {
return interpolate(systemWordingFallback(key, requestedLocale) ?? key, params);
}
}
export async function localizedStatusMessage(locale: string, message: string): Promise<string> {
const key = legacyMessageKey(message);
return key ? systemMessage(locale, key) : message;
}
export async function getSystemWordings(locale: string) {
const requestedLocale = cleanLocale(locale);
const rows = await query<{ key: string; value: string; missing: boolean }>(
`
SELECT
k.key,
COALESCE(requested.value, fallback.value, '') AS value,
($1 <> $2 AND requested.value IS NULL) AS missing
FROM system_wording_keys k
LEFT JOIN system_wording_values requested
ON requested.key = k.key
AND requested.locale = $1
LEFT JOIN system_wording_values fallback
ON fallback.key = k.key
AND fallback.locale = $2
WHERE k.enabled = true
ORDER BY k.key
`,
[requestedLocale, defaultLocale]
);
return {
locale: requestedLocale,
fallbackLocale: defaultLocale,
messages: nestedMessages(rows),
missingKeys: rows.filter((row) => row.missing).map((row) => row.key)
};
}
export async function listSystemWordingRows(filters: Record<string, unknown>) {
const locale = cleanLocale(filters.locale);
const module = typeof filters.module === 'string' ? filters.module.trim() : '';
const surface = cleanSurface(filters.surface);
const missingOnly = filters.missing === 'true' || filters.missing === true;
return query<SystemWordingValueRow>(
`
SELECT
k.key,
k.module,
k.surface,
k.description,
k.placeholders,
COALESCE(requested.value, '') AS value,
COALESCE(fallback.value, '') AS "defaultValue",
($1 <> $2 AND requested.value IS NULL) AS missing,
requested.updated_at AS "updatedAt",
CASE
WHEN updated_user.id IS NULL THEN NULL
ELSE json_build_object('id', updated_user.id, 'displayName', updated_user.display_name)
END AS "updatedBy"
FROM system_wording_keys k
LEFT JOIN system_wording_values requested
ON requested.key = k.key
AND requested.locale = $1
LEFT JOIN system_wording_values fallback
ON fallback.key = k.key
AND fallback.locale = $2
LEFT JOIN users updated_user ON updated_user.id = requested.updated_by_user_id
WHERE k.enabled = true
AND ($3 = '' OR k.module = $3)
AND ($4 = '' OR k.surface = $4)
AND ($5 = false OR ($1 <> $2 AND requested.value IS NULL))
ORDER BY k.module, k.key
`,
[locale, defaultLocale, module, surface, missingOnly]
);
}
export async function updateSystemWordingValue(keyValue: string, payload: Record<string, unknown>, userId: number) {
const key = requireWordingKey(keyValue);
const locale = requireLocale(payload.locale);
const value = typeof payload.value === 'string' ? payload.value.trim() : '';
const keyRow = await pool.query<{ placeholders: unknown }>('SELECT placeholders FROM system_wording_keys WHERE key = $1', [key]);
const placeholders = normalizePlaceholders(keyRow.rows[0]?.placeholders);
if (keyRow.rowCount === 0) {
throw validationError('server.wordings.keyNotFound');
}
if (locale === defaultLocale && value === '') {
throw validationError('server.wordings.valueRequired');
}
if (value !== '' && !placeholdersMatch(placeholders, collectPlaceholders(value))) {
throw validationError('server.wordings.placeholderMismatch');
}
const result = await pool.query<{ code: string }>('SELECT code FROM languages WHERE code = $1', [locale]);
if (result.rowCount === 0) {
throw validationError('server.wordings.localeRequired');
}
if (value === '') {
await pool.query('DELETE FROM system_wording_values WHERE key = $1 AND locale = $2', [key, locale]);
} else {
await pool.query(
`
INSERT INTO system_wording_values (key, locale, value, created_by_user_id, updated_by_user_id)
VALUES ($1, $2, $3, $4, $4)
ON CONFLICT (key, locale) DO UPDATE
SET value = EXCLUDED.value,
updated_by_user_id = EXCLUDED.updated_by_user_id,
updated_at = now()
`,
[key, locale, value, userId]
);
}
return listSystemWordingRows({ locale });
}

View File

@@ -10,5 +10,5 @@
"forceConsistentCasingInFileNames": true,
"types": ["node"]
},
"include": ["src/**/*.ts", "tests/**/*.ts"]
"include": ["src/**/*.ts", "tests/**/*.ts", "../system-wordings.ts"]
}