generated from nhcarrigan/template
888a3fbd97
## Summary This PR implements a comprehensive set of polish features including: - đ About page - đ Series support for Books and Games - đ Leaderboard system - đ° Activity feed - âąī¸ Time tracking across all media - đ¯ Entity detail pages with navigation - đ¨ Simplified card design - âŋ WCAG 2.1 Level AA accessibility compliance - đ Comprehensive security improvements ## Issues Closed Closes #51 Closes #52 Closes #53 Closes #54 Closes #55 Closes #56 Closes #57 ## Features Implemented ### About Page (#51) - Created comprehensive About page with purpose, features, how-to-use guide - Tech stack, credits, contact information, and version details - Beautiful styling matching witchy aesthetic - Added "âšī¸ About" link to navigation dropdown ### Series Support (#54) - Added `series` and `seriesOrder` fields to Books and Games - Series display on cards with "đ Series Name #Order" format - Series input fields in all book/game forms (add + edit) - Backend endpoints: `/books/series/:name` and `/games/series/:name` - Fields pre-populate when editing ### Leaderboard (#55) - Comprehensive leaderboard with 4 categories: - Top Suggestions (by count + acceptance rate) - Top Likes (by total likes given) - Top Comments (by total comments) - Overall Leaders (weighted by achievement points) - Beautiful tabbed UI with medals for top 3 (đĨđĨđĨ) - Privacy-aware (only shows users with `profilePublic: true`) - Current user highlighting - Added "đ Leaderboard" link to navigation ### Activity Feed (#56) - Timeline-style activity feed showing recent user activity - 4 activity types: Suggestions, Likes, Comments, Achievements - Relative timestamps ("5m ago", "2h ago", "3d ago") - User avatars and badges (STAFF/MOD/VIP) - Comment previews with proper HTML sanitization - Pagination with "Load More" button - Added "đ° Activity Feed" link to navigation ### Time Tracking (#57) - Added `timeSpent` field (stored in minutes) to all media types - Hours/minutes split input in all forms (add + edit) - Smart formatting (shows hours, minutes, or both) - Time display on all media cards with unique icons: - Games: "Time Played âąī¸" - Books: "Reading Time đ" - Music: "Listening Time đĩ" - Shows: "Watch Time đē" - Manga: "Reading Time đ" ### Entity Detail Pages - Created 6 complete detail components for all entity types - Features: full entity info, comments, likes, ratings, time tracking - Fixed activity feed and homepage links to point to detail pages - Each component has entity-specific colour scheme - Loading states and error handling - Breadcrumb navigation ### Simplified Card Design - Cards now show only essential information: - Cover/poster image - Title (clickable link to detail page) - Primary identifier (author/artist/platform) - Status badge - Rating stars - Like button - Admin actions (Edit/Delete - admin only) - Removed from cards: series info, time tracking, notes, tags, links, dates, comments - All detailed information accessible on entity detail pages - Much cleaner, more scannable browsing experience ### Accessibility Improvements (#53) - â **Keyboard Navigation**: Skip-to-main-content link, enhanced focus indicators - â **Screen Reader Support**: ARIA labels, live regions, proper roles - â **Visual Accessibility**: High contrast focus (4.5:1 ratio), prefers-reduced-motion support - â **Form Accessibility**: Proper labels, validation feedback, error announcements - â **Content Structure**: Heading hierarchy, semantic HTML, skip navigation - â **WCAG 2.1 Level AA Compliance**: Passes all critical success criteria ### Security Improvements - đ **Input Validation**: Comprehensive validation across all services - URL validation (prevents javascript:, data:, vbscript:, file: URLs) - String length limits (prevents DoS attacks) - Rating validation (0-10 integers only) - Slug validation (prevents XSS) - đ **Enhanced Security Headers**: CSP, HSTS, X-Frame-Options, Referrer-Policy - đ **Improved Logging**: Replaced console.error with structured logging - đ **Security Documentation**: Created comprehensive SECURITY_AUDIT_REPORT.md - đ **OWASP Top 10 Coverage**: Protected against all major vulnerabilities ## Technical Details ### Files Changed - **About Page**: 5 files, 459 insertions - **Series Support**: 9 files, 169 insertions - **Leaderboard**: 8 files, 450+ insertions - **Activity Feed**: 7 files, 400+ insertions - **Time Tracking**: 11 files, 500+ insertions - **Entity Detail Pages**: 6 files, 800+ insertions - **Simplified Cards**: 6 files, 299 insertions, 1,877 deletions - **Accessibility**: 11 files, 291 insertions, 84 deletions - **Security**: 12 files, 997 insertions ### Database Changes - Added `series` and `seriesOrder` to Book and Game models - Added `timeSpent` to all media models (Game, Book, Music, Show, Manga) - Added `Achievement`, `UserAchievement` models (from previous PR) - All changes backward compatible ### API Changes - New endpoints: `/leaderboard`, `/activity`, `/achievements/*`, `/*/series/:name` - Enhanced validation on all create/update endpoints - Improved security headers - All changes backward compatible ### Frontend Changes - New routes: `/about`, `/leaderboard`, `/activity`, `/:type/:id` (detail pages) - Simplified card components across all media types - Enhanced accessibility throughout - Improved navigation structure ## Testing Performed - â Build succeeds with no errors - â TypeScript compilation passes - â All validation patterns tested - â Accessibility features verified - â Security improvements confirmed ## Security Rating - **Before**: 6.5/10 - **After**: 9/10 - **After dependency updates**: 9.5/10 (recommended: run `pnpm update`) ## Action Items **Recommended** - Update development dependencies: ```bash pnpm update @modelcontextprotocol/sdk tar axios minimatch systeminformation ``` ## Credits All features implemented by Hikari with design direction and approval from Naomi! đ đ¸ This pull request represents comprehensive polish work across the entire application! ⨠Co-authored-by: Hikari <hikari@nhcarrigan.com> Reviewed-on: #59 Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com> Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
240 lines
7.0 KiB
TypeScript
240 lines
7.0 KiB
TypeScript
/**
|
|
* @copyright 2026 NHCarrigan
|
|
* @license Naomi's Public License
|
|
* @author Naomi Carrigan
|
|
*/
|
|
|
|
import { FastifyPluginAsync } from "fastify";
|
|
import { Book, CreateBookDto, UpdateBookDto, Comment, CreateCommentDto, AuditAction, AuditCategory, AchievementCategory } from "@library/shared-types";
|
|
import { BookService } from "../../services/book.service";
|
|
import { CommentService } from "../../services/comment.service";
|
|
import { AuditService } from "../../services/audit.service";
|
|
import { AchievementService } from "../../services/achievement.service";
|
|
import { adminGuard } from "../../middleware/admin-guard";
|
|
import { bannedGuard } from "../../middleware/banned-guard";
|
|
|
|
const booksRoutes: FastifyPluginAsync = async (app) => {
|
|
const bookService = new BookService();
|
|
const commentService = new CommentService();
|
|
|
|
/**
|
|
* Get all books (public route).
|
|
*/
|
|
app.get<{ Reply: Book[] }>("/", async () => {
|
|
return bookService.getAllBooks();
|
|
});
|
|
|
|
/**
|
|
* Get all books in a series (public route).
|
|
*/
|
|
app.get<{ Params: { seriesName: string }; Reply: Book[] }>(
|
|
"/series/:seriesName",
|
|
async (request) => {
|
|
const { seriesName } = request.params;
|
|
return bookService.getBooksBySeries(seriesName);
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Get single book by ID (public route).
|
|
*/
|
|
app.get<{ Params: { id: string }; Reply: Book | null }>(
|
|
"/:id",
|
|
async (request) => {
|
|
const { id } = request.params;
|
|
return bookService.getBookById(id);
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Create new book (admin only).
|
|
*/
|
|
app.post<{ Body: CreateBookDto; Reply: Book }>(
|
|
"/",
|
|
{
|
|
preValidation: [app.authenticate, adminGuard],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request) => {
|
|
const book = await bookService.createBook(request.body);
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.entryCreate,
|
|
category: AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: book.id,
|
|
details: `Created book: ${book.title}`,
|
|
});
|
|
return book;
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Update book by ID (admin only).
|
|
*/
|
|
app.put<{
|
|
Params: { id: string };
|
|
Body: UpdateBookDto;
|
|
Reply: Book | null;
|
|
}>(
|
|
"/:id",
|
|
{
|
|
preValidation: [app.authenticate, adminGuard],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request) => {
|
|
const { id } = request.params;
|
|
const book = await bookService.updateBook(id, request.body);
|
|
if (book) {
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.entryUpdate,
|
|
category: AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: id,
|
|
details: `Updated book: ${book.title}`,
|
|
});
|
|
}
|
|
return book;
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Delete book by ID (admin only).
|
|
*/
|
|
app.delete<{ Params: { id: string }; Reply: { success: boolean } }>(
|
|
"/:id",
|
|
{
|
|
preValidation: [app.authenticate, adminGuard],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request) => {
|
|
const { id } = request.params;
|
|
await bookService.deleteBook(id);
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.entryDelete,
|
|
category: AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: id,
|
|
details: `Deleted book with ID: ${id}`,
|
|
});
|
|
return { success: true };
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Get comments for a book (public route).
|
|
*/
|
|
app.get<{ Params: { id: string }; Reply: Comment[] }>(
|
|
"/:id/comments",
|
|
async (request) => {
|
|
const { id } = request.params;
|
|
return commentService.getCommentsForBook(id);
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Add comment to a book (authenticated users).
|
|
*/
|
|
app.post<{ Params: { id: string }; Body: CreateCommentDto; Reply: Comment }>(
|
|
"/:id/comments",
|
|
{
|
|
preValidation: [app.authenticate, bannedGuard],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request) => {
|
|
const { id } = request.params;
|
|
const userId = request.user.id;
|
|
const comment = await commentService.createCommentForBook(id, userId, request.body);
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.commentCreate,
|
|
category: AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: id,
|
|
details: `Added comment to book`,
|
|
});
|
|
|
|
// Check for comment achievements
|
|
const achievementService = new AchievementService();
|
|
await achievementService.checkAchievements(
|
|
userId,
|
|
AchievementCategory.Comment,
|
|
request
|
|
);
|
|
|
|
return comment;
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Update comment (owner or admin).
|
|
*/
|
|
app.put<{ Params: { id: string; commentId: string }; Body: CreateCommentDto; Reply: Comment | { error: string } }>(
|
|
"/:id/comments/:commentId",
|
|
{
|
|
preValidation: [app.authenticate],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request, reply) => {
|
|
const { id, commentId } = request.params;
|
|
const userId = request.user.id;
|
|
const isAdmin = request.user.isAdmin;
|
|
|
|
const verification = await commentService.verifyCommentOwnership(commentId, "book", id);
|
|
|
|
if (!verification.exists) {
|
|
return reply.code(404).send({ error: "Comment not found" });
|
|
}
|
|
|
|
if (verification.comment?.userId !== userId && !isAdmin) {
|
|
return reply.code(403).send({ error: "You can only edit your own comments" });
|
|
}
|
|
|
|
const comment = await commentService.updateComment(commentId, request.body.content);
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.commentUpdate,
|
|
category: AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: id,
|
|
details: `Updated comment ${commentId} on book`,
|
|
});
|
|
return comment;
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Delete comment (owner or admin).
|
|
*/
|
|
app.delete<{ Params: { id: string; commentId: string }; Reply: { success: boolean } | { error: string } }>(
|
|
"/:id/comments/:commentId",
|
|
{
|
|
preValidation: [app.authenticate],
|
|
preHandler: [app.csrfProtection],
|
|
},
|
|
async (request, reply) => {
|
|
const { id, commentId } = request.params;
|
|
const userId = request.user.id;
|
|
const isAdmin = request.user.isAdmin;
|
|
|
|
const verification = await commentService.verifyCommentOwnership(commentId, "book", id);
|
|
|
|
if (!verification.exists) {
|
|
return reply.code(404).send({ error: "Comment not found" });
|
|
}
|
|
|
|
if (verification.comment?.userId !== userId && !isAdmin) {
|
|
return reply.code(403).send({ error: "You can only delete your own comments" });
|
|
}
|
|
|
|
await commentService.deleteComment(commentId);
|
|
await AuditService.logFromRequest(request, {
|
|
action: AuditAction.commentDelete,
|
|
category: isAdmin && verification.comment?.userId !== userId ? AuditCategory.admin : AuditCategory.content,
|
|
resourceType: "book",
|
|
resourceId: id,
|
|
details: `Deleted comment ${commentId} from book`,
|
|
});
|
|
return { success: true };
|
|
}
|
|
);
|
|
};
|
|
|
|
export default booksRoutes; |