Commit Graph
2 Commits
Author SHA1 Message Date
john-okeefe 72f053d179 docs: comprehensive implementation plan for collection detail fix
This implementation plan addresses multiple architectural improvements:

**Security Fix:**
- Add user-scoped WebSocket broadcasts to prevent cross-user data leaks
- Current broadcast sends ALL collection updates to ALL users
- New BroadcastToUser() method ensures privacy between users

**Features:**
- Add optional library_id filter to search API (partial + fuzzy)
- Add library filter toggle UI in Add Books modal
- Remove 265 lines of inline JavaScript from template
- Convert to proper TypeScript with type safety

**Architecture:**
- Full-stack task: backend, database, frontend, documentation
- User-scoped broadcasts follow JWT + device auth patterns
- Progressive enhancement maintained (SSR + JS enhancement)
- WebSocket real-time sync preserved for multi-device support

**Testing:**
- Integration tests using setupTestServer() helper
- Tests for library filtering (no filter, lib1, lib2, invalid)
- Tests for user-scoped WebSocket broadcasts
- Bruno API tests for new library_id parameter

**Documentation:**
- API docs at docs/developer/api/search.md
- Git strategy: 6 logical commits outlined
- Testing checklist for manual + automated verification

**Files Modified:**
- internal/sync/websocket.go: Add BroadcastToUser()
- internal/handlers/collections.go: Use user-scoped broadcasts
- internal/database/queries.sql: Add library_id filter
- internal/handlers/media.go: Accept library_id parameter
- templates/collections.templ: Remove inline JS, add toggle UI
- web/src/collections.ts: TypeScript with WebSocket support
- internal/router/frontend.go: Pass libraryID to template
- Tests, docs, Bruno tests

This plan follows all PROJECT_GUIDELINES.md requirements including
TypeScript conversion, TailwindCSS only, procedural style, proper
commit organization, and comprehensive testing.
2026-03-02 21:02:47 -05:00
john-okeefe 240b3247aa docs: Add implementation plan for collection detail page fix and library filtering
This document outlines the plan to fix the broken /collections/:id page
which has an inline JavaScript bug, and add library_id support to the
search API.

Key changes planned:
- Remove 265+ lines of inline JavaScript from collections.templ template
- Add minimal TypeScript module (~180 lines) in web/src/collections.ts
- Add optional library_id parameter to SearchMediaItems API endpoint
- Add library filter toggle UI to the Add Books modal
- Update template to accept libraryID parameter

The implementation uses a hybrid approach: minimal TypeScript for
client-only features while maintaining HTMX-like patterns for CRUD
operations. This reduces maintenance burden and improves code
organization.

Steps detailed:
1. Update Search API to accept optional library_id parameter
2. Add library_id filter to SQL query if not present
3. Remove inline JS from template, add data attributes
4. Add toggle UI for filtering books by library
5. Add TypeScript functions for modal, search, and book management
6. Update handler to pass libraryID to template
7. Update template function signature

Testing checklist included to verify:
- Page loads without JS errors
- Library filter toggle visibility
- Search results with/without library filtering
- Add/remove books functionality
- Client-side search filtering
2026-03-02 15:45:52 -05:00