john-okeefe
935b867219
This major update implements a complete user annotation system: ## 🎯 New Features - User notes with position tracking for media items - Text highlighting with customizable colors - Highlight-note associations for detailed annotations - Full CRUD API for both notes and highlights - Backward compatibility with existing ebook endpoints ## 📊 Database Changes - Add media_notes table (id, media_item_id, user_id, content, position, timestamps) - Add media_highlights table (id, media_item_id, user_id, selection_text, start/end_position, color, optional note_id) - Add foreign key relationships with CASCADE deletes - Add proper indexes for performance - Add database schema views for ebook backward compatibility ## 🔧 API Implementation - Complete REST API endpoints for notes and highlights - JWT authentication with proper middleware bypass - Request validation with meaningful error responses - UUID validation and type safety - Support for hex color codes in highlights ## 🧪 Testing & Documentation - Comprehensive test suite covering authentication scenarios - Bruno API collection for manual testing - Detailed testing guide with troubleshooting - Updated documentation in README and TESTING.md ## 📁 Backward Compatibility - Existing ebook endpoints continue working - Database views maintain API contracts - No breaking changes for existing integrations The annotation system is now fully functional and ready for production use.
236 lines
10 KiB
SQL
236 lines
10 KiB
SQL
-- Consolidated Bookmann Database Schema
|
|
-- This file contains the complete current schema for the Bookmann media library management system
|
|
|
|
-- Create library types table
|
|
CREATE TABLE library_types (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
name VARCHAR(50) UNIQUE NOT NULL,
|
|
description TEXT,
|
|
allowed_extensions TEXT[] NOT NULL, -- Array of allowed file extensions for this type
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Insert default library types
|
|
INSERT INTO library_types (name, description, allowed_extensions) VALUES
|
|
('ebooks', 'Ebook files including EPUB, PDF, MOBI, etc.', ARRAY['.epub', '.pdf', '.mobi', '.azw', '.azw3', '.txt', '.rtf', '.doc', '.docx', '.lit', '.fb2', '.pdb']),
|
|
('comics', 'Comic book archives and image formats', ARRAY['.cbz', '.cbr', '.cb7', '.cbt', '.pdf']),
|
|
('manga', 'Manga files including archives and image folders', ARRAY['.cbz', '.cbr', '.png', '.jpg', '.jpeg', '.gif', '.bmp', '.webp']);
|
|
|
|
-- Create users table
|
|
CREATE TABLE users (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
email VARCHAR(255) UNIQUE NOT NULL,
|
|
username VARCHAR(255) UNIQUE NOT NULL,
|
|
password_hash VARCHAR(255) NOT NULL,
|
|
first_name VARCHAR(255),
|
|
last_name VARCHAR(255),
|
|
role VARCHAR(20) NOT NULL DEFAULT 'user' CHECK (role IN ('admin', 'user')),
|
|
theme VARCHAR(50) DEFAULT 'tokyo-night',
|
|
scan_frequency_minutes INTEGER DEFAULT 60,
|
|
auto_scan_enabled BOOLEAN DEFAULT true,
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Create libraries table
|
|
CREATE TABLE libraries (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
name VARCHAR(255) NOT NULL,
|
|
description TEXT,
|
|
library_type_id UUID NOT NULL REFERENCES library_types(id) ON DELETE RESTRICT,
|
|
created_by_admin_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Create library_folders table for multiple folders per library
|
|
CREATE TABLE library_folders (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
library_id UUID NOT NULL REFERENCES libraries(id) ON DELETE CASCADE,
|
|
folder_path VARCHAR(500) NOT NULL,
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
UNIQUE(library_id, folder_path)
|
|
);
|
|
|
|
-- Create library_visibility table for user-specific library visibility
|
|
CREATE TABLE library_visibility (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
library_id UUID NOT NULL REFERENCES libraries(id) ON DELETE CASCADE,
|
|
is_visible BOOLEAN NOT NULL DEFAULT true,
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
UNIQUE(user_id, library_id)
|
|
);
|
|
|
|
-- Create media_items table (replaces ebooks table for broader media support)
|
|
CREATE TABLE media_items (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
library_id UUID NOT NULL REFERENCES libraries(id) ON DELETE CASCADE,
|
|
title VARCHAR(255) NOT NULL,
|
|
author VARCHAR(255),
|
|
isbn VARCHAR(13), -- Still relevant for ebooks
|
|
description TEXT,
|
|
file_path VARCHAR(500) NOT NULL,
|
|
file_size BIGINT,
|
|
mime_type VARCHAR(100),
|
|
cover_image_path VARCHAR(500),
|
|
series VARCHAR(255),
|
|
series_number INTEGER,
|
|
tags TEXT,
|
|
asin VARCHAR(20), -- Still relevant for ebooks
|
|
date_published DATE,
|
|
publisher VARCHAR(255),
|
|
contributors TEXT,
|
|
added_by_admin_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Create ebooks view for backward compatibility
|
|
CREATE VIEW ebooks AS
|
|
SELECT mi.*
|
|
FROM media_items mi
|
|
JOIN libraries l ON mi.library_id = l.id
|
|
JOIN library_types lt ON l.library_type_id = lt.id
|
|
WHERE lt.name = 'ebooks';
|
|
|
|
-- Create reading_progress table
|
|
CREATE TABLE reading_progress (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
media_item_id UUID NOT NULL REFERENCES media_items(id) ON DELETE CASCADE,
|
|
user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
current_page INTEGER DEFAULT 0,
|
|
total_pages INTEGER,
|
|
last_read_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
UNIQUE(media_item_id, user_id)
|
|
);
|
|
|
|
-- Create reading_progress view for backward compatibility
|
|
CREATE VIEW ebook_reading_progress AS
|
|
SELECT rp.*,
|
|
mi.id as ebook_id -- Map media_item_id to ebook_id for compatibility
|
|
FROM reading_progress rp
|
|
JOIN media_items mi ON rp.media_item_id = mi.id
|
|
JOIN libraries l ON mi.library_id = l.id
|
|
JOIN library_types lt ON l.library_type_id = lt.id
|
|
WHERE lt.name = 'ebooks';
|
|
|
|
-- Create media_ratings table (replaces ebook_ratings)
|
|
CREATE TABLE media_ratings (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
media_item_id UUID NOT NULL REFERENCES media_items(id) ON DELETE CASCADE,
|
|
user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
rating INTEGER NOT NULL CHECK (rating >= 1 AND rating <= 10), -- 10-point scale for half-star precision
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
UNIQUE(media_item_id, user_id)
|
|
);
|
|
|
|
-- Create media_notes table for user notes on media items
|
|
CREATE TABLE media_notes (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
media_item_id UUID NOT NULL REFERENCES media_items(id) ON DELETE CASCADE,
|
|
user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
content TEXT NOT NULL,
|
|
position VARCHAR(100), -- optional position (page:offset or CFI) for standalone notes
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Create media_highlights table for user highlights on media items
|
|
CREATE TABLE media_highlights (
|
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
media_item_id UUID NOT NULL REFERENCES media_items(id) ON DELETE CASCADE,
|
|
user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
|
|
selection_text TEXT NOT NULL,
|
|
start_position VARCHAR(100), -- position (page:offset or CFI) where highlight starts
|
|
end_position VARCHAR(100), -- position (page:offset or CFI) where highlight ends
|
|
color VARCHAR(7) DEFAULT '#ffff00', -- hex color code for highlight
|
|
note_id UUID REFERENCES media_notes(id) ON DELETE SET NULL, -- optional associated note
|
|
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
|
|
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
|
|
);
|
|
|
|
-- Create ebook_ratings view for backward compatibility
|
|
CREATE VIEW ebook_ratings AS
|
|
SELECT mr.*,
|
|
mi.id as ebook_id -- Map media_item_id to ebook_id for compatibility
|
|
FROM media_ratings mr
|
|
JOIN media_items mi ON mr.media_item_id = mi.id
|
|
JOIN libraries l ON mi.library_id = l.id
|
|
JOIN library_types lt ON l.library_type_id = lt.id
|
|
WHERE lt.name = 'ebooks';
|
|
|
|
-- Create ebook_notes view for backward compatibility
|
|
CREATE VIEW ebook_notes AS
|
|
SELECT mn.*,
|
|
mi.id as ebook_id -- Map media_item_id to ebook_id for compatibility
|
|
FROM media_notes mn
|
|
JOIN media_items mi ON mn.media_item_id = mi.id
|
|
JOIN libraries l ON mi.library_id = l.id
|
|
JOIN library_types lt ON l.library_type_id = lt.id
|
|
WHERE lt.name = 'ebooks';
|
|
|
|
-- Create ebook_highlights view for backward compatibility
|
|
CREATE VIEW ebook_highlights AS
|
|
SELECT mh.*,
|
|
mi.id as ebook_id -- Map media_item_id to ebook_id for compatibility
|
|
FROM media_highlights mh
|
|
JOIN media_items mi ON mh.media_item_id = mi.id
|
|
JOIN libraries l ON mi.library_id = l.id
|
|
JOIN library_types lt ON l.library_type_id = lt.id
|
|
WHERE lt.name = 'ebooks';
|
|
|
|
-- Note: user_ebook_folders table is replaced by library_folders table
|
|
-- Libraries now handle folder management instead of individual users
|
|
|
|
-- Create indexes for better query performance
|
|
CREATE INDEX idx_users_email ON users(email);
|
|
CREATE INDEX idx_users_username ON users(username);
|
|
CREATE INDEX idx_library_types_name ON library_types(name);
|
|
|
|
-- Library indexes
|
|
CREATE INDEX idx_libraries_name ON libraries(name);
|
|
CREATE INDEX idx_libraries_library_type_id ON libraries(library_type_id);
|
|
CREATE INDEX idx_libraries_created_by_admin_id ON libraries(created_by_admin_id);
|
|
CREATE INDEX idx_library_folders_library_id ON library_folders(library_id);
|
|
CREATE INDEX idx_library_visibility_user_id ON library_visibility(user_id);
|
|
CREATE INDEX idx_library_visibility_library_id ON library_visibility(library_id);
|
|
|
|
-- Media items indexes
|
|
CREATE INDEX idx_media_items_title ON media_items(title);
|
|
CREATE INDEX idx_media_items_author ON media_items(author);
|
|
CREATE INDEX idx_media_items_library_id ON media_items(library_id);
|
|
CREATE INDEX idx_media_items_added_by_admin_id ON media_items(added_by_admin_id);
|
|
|
|
-- Progress and ratings indexes
|
|
CREATE INDEX idx_reading_progress_media_item_id ON reading_progress(media_item_id);
|
|
CREATE INDEX idx_reading_progress_user_id ON reading_progress(user_id);
|
|
CREATE INDEX idx_media_ratings_media_item_id ON media_ratings(media_item_id);
|
|
CREATE INDEX idx_media_ratings_user_id ON media_ratings(user_id);
|
|
|
|
-- Notes and highlights indexes
|
|
CREATE INDEX idx_media_notes_media_item_id ON media_notes(media_item_id);
|
|
CREATE INDEX idx_media_notes_user_id ON media_notes(user_id);
|
|
CREATE INDEX idx_media_highlights_media_item_id ON media_highlights(media_item_id);
|
|
CREATE INDEX idx_media_highlights_user_id ON media_highlights(user_id);
|
|
CREATE INDEX idx_media_highlights_note_id ON media_highlights(note_id);
|
|
|
|
-- Add comment explaining the rating system
|
|
COMMENT ON COLUMN media_ratings.rating IS 'Rating scale 1-10 (odd numbers = half-stars: 1,3,5,7,9 = 0.5,1.5,2.5,3.5,4.5 stars)';
|
|
|
|
-- Library Type File Extensions Notes:
|
|
-- - Ebooks: .epub, .pdf, .mobi, .azw, .azw3, .txt, .rtf, .doc, .docx, .lit, .fb2, .pdb
|
|
-- - Comics: .cbz, .cbr, .cb7, .cbt, .pdf
|
|
-- - Manga: .cbz, .cbr, .png, .jpg, .jpeg, .gif, .bmp, .webp (note: manga includes image folders)
|
|
|
|
-- Role System Notes:
|
|
-- - All users default to 'user' role
|
|
-- - Admin users can: create/manage libraries and folders, scan media, modify media metadata, delete media, control library visibility
|
|
-- - Regular users can: view visible libraries, rate media, track reading progress, create notes and highlights, manage their profile
|
|
-- - To create first admin: UPDATE users SET role = 'admin' WHERE email = 'your-admin-email';
|
|
-- - Library visibility is controlled through library_visibility table - admins can hide/show libraries per user
|
|
-- - Notes and highlights support position data (page:offset or CFI format) for precise location tracking
|
|
-- - Highlights can have associated notes for detailed annotations
|
|
-- - Backward compatibility views (ebooks, ebook_ratings, ebook_reading_progress, ebook_notes, ebook_highlights) maintain existing API contracts |