3ed0d8ce88
Define the generic provider/event/variable system: - ServiceProvider ABC with connect, disconnect, poll, list_collections - ServiceProviderType enum (IMMICH first) - EventType enum (assets_added/removed, collection_renamed/deleted, sharing_changed) - MediaAsset, MediaCollection, CollectionState dataclasses - TemplateVariableDefinition and VariableRegistry with 11 base variables - All models use extra: dict for provider-specific data passthrough Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
3.3 KiB
3.3 KiB
Project Guidelines
Development Servers
IMPORTANT: When the user requests it OR when backend code changes are made (files in packages/server/), you MUST restart the standalone server using this one-liner:
PID=$(netstat -ano 2>/dev/null | grep ':8420.*LISTENING' | awk '{print $5}' | head -1) && [ -n "$PID" ] && taskkill //F //PID $PID 2>/dev/null; sleep 1 && cd packages/server && pip install -e . 2>&1 | tail -1 && cd ../.. && NOTIFY_BRIDGE_DATA_DIR=./test-data NOTIFY_BRIDGE_SECRET_KEY=test-secret-key-minimum-32chars nohup python -m uvicorn notify_bridge_server.main:app --host 0.0.0.0 --port 8420 > /dev/null 2>&1 & sleep 3 && curl -s http://localhost:8420/api/health
IMPORTANT: Overlays (modals, dropdowns, pickers) MUST use position: fixed with inline styles and z-index: 9999. Tailwind CSS v4 fixed/absolute classes do NOT work reliably inside flex/overflow containers in this project. Always calculate position from getBoundingClientRect() for dropdowns, or use top:0;left:0;right:0;bottom:0 for full-screen backdrops.
IMPORTANT: When the user requests it, restart the frontend dev server using this one-liner:
PID=$(netstat -ano 2>/dev/null | grep ':5173.*LISTENING' | awk '{print $5}' | head -1) && [ -n "$PID" ] && taskkill //F //PID $PID 2>/dev/null; sleep 1 && cd frontend && npx vite dev --port 5173 --host > /dev/null 2>&1 & sleep 4 && curl -s -o /dev/null -w "Frontend: %{http_code}" http://localhost:5173/
Frontend Architecture Notes
- i18n: Uses
$staterune in.svelte.tsfile. Locale auto-detects from localStorage.t()is reactive via$state.setLocale()updates immediately without page reload. - Svelte 5 runes:
$stateonly works in.svelteand.svelte.tsfiles. Regular.tsfiles cannot use runes -- use plain variables instead. - Static adapter: Frontend uses
@sveltejs/adapter-staticwith SPA fallback. API calls proxied via Vite dev server config. - Auth flow: After login/setup, use
window.location.href = '/'(hard redirect), NOTgoto('/'). - Tailwind CSS v4: Uses
@themedirective inapp.cssfor CSS variables.
Backend Architecture Notes
- SQLAlchemy async + aiohttp: Cannot nest
async with aiohttp.ClientSession()inside a route that has an active SQLAlchemy async session -- greenlet context breaks. Eagerly load all DB data before entering aiohttp context. - Jinja2 SandboxedEnvironment: All template rendering MUST use
from jinja2.sandbox import SandboxedEnvironment. - System-owned entities:
user_id=0means system-owned (e.g. default templates). - FastAPI route ordering: Static path routes MUST be registered BEFORE parameterized routes.
__pycache__: Add to.gitignore. Never commit.
Project Structure (Phase 1)
- packages/core (
notify_bridge_core): Shared library — providers, models, notifications, templates. No DB dependency. - packages/server (
notify_bridge_server): FastAPI REST API + SQLite. Depends on core. - frontend: SvelteKit 2 + Svelte 5 + Tailwind CSS v4. Static adapter with SPA fallback. Dev proxy to :8420.
- Environment vars:
NOTIFY_BRIDGE_DATA_DIR,NOTIFY_BRIDGE_SECRET_KEY,NOTIFY_BRIDGE_DATABASE_URL - Core package includes
jinja2dependency (template rendering lives in core, not server).