|
|
dcf613446e
|
docs: final 1.0.0 documentation pass
Build and Push Docker Image / build (push) Successful in 28s
CI / Security audit (push) Successful in 50s
CI / Tests & coverage (push) Successful in 1m3s
README.md:
- Node prerequisite: v12+ → v22+
- Real-Time Updates: describe SSE push, remove polling/refresh-selector wording
- On-demand mode: update for SSE connect triggering poll
- API Endpoints: add /stream, /me, /csrf, /user-summary, /status, /cover-art
- Remove stale /api/qbittorrent proxy entry
- Docker tags: update to 1.0.x
SECURITY.md:
- Supported versions: add 1.0.x, retire 0.2.x
- CSP header: add style-src-attr 'unsafe-inline'
- Nginx example: add proxy_buffering off / proxy_read_timeout for SSE
Diagrams:
- seq-dashboard.puml: rewrite as SSE stream sequence (connect,
initial payload, pushed updates, heartbeat, disconnect)
- seq-polling.puml: add SSE subscriber notification step after
cache population
- state-ui.puml: replace Refresh Rate sub-state with SSE Connection
state machine; update splash loading and logout transitions
- state-poller.puml: add Notifying SSE subscribers step in Polling state
package.json: bump to 1.0.0
|
2026-05-17 09:19:35 +01:00 |
|
|
|
6675e5dcfe
|
docs: update architecture docs and diagrams for recent changes
Build and Push Docker Image / build (push) Successful in 24s
ARCHITECTURE.md:
- Directory structure: add middleware/requireAuth.js and favicon assets
- §4.1: remove CORS from middleware list
- §4.2: all proxy routes now auth-required via requireAuth; add
middleware description
- §6: cookie payload corrected (no token); document secure+sameSite
- §7: add emby:users cache key (60s TTL)
- §8: Download Object table: userTag → allTags/matchedUserTag/tagBadges
- §9 POST /login: document cookie security attributes
- §10: add Tag Badge Rendering section; remove hardcoded line count
Diagrams:
- class-server.puml: add requireAuth middleware module; update
dashboard.js methods (extractAllTags, extractUserTag w/ username,
buildTagBadges, getEmbyUsers); add TagBadge value class; add auth
relationships for all proxy routes
- class-data.puml: Download Object userTag → allTags/matchedUserTag/
tagBadges; add TagBadge class; remove token from Session Cookie
- seq-auth.puml: cookie payload no longer contains token; add
secure/sameSite note
- component.puml: remove CORS component; add requireAuth; consolidate
Emby connection to show tag badge + user-summary usage
- activity-matching.puml: update to extractAllTags/extractUserTag
(with username); showAll uses hasAnyTag; tagBadges built from
embyUserMap; add Emby user fetch step; update legend
- seq-dashboard.puml: add emby:users cache lookup / Emby fetch for
showAll; update matching groups to show tag classification; add
tag badge rendering note on renderDownloads()
|
2026-05-16 15:41:23 +01:00 |
|
|
|
e97bd3c67b
|
docs: comprehensive architecture documentation with PlantUML diagrams
- docs/ARCHITECTURE.md: full system overview, technology stack, directory
structure, component architecture, data flow, auth, polling/caching,
download matching pipeline, API reference, frontend architecture,
configuration, deployment guide
- docs/diagrams/component.puml: system component diagram
- docs/diagrams/seq-auth.puml: authentication sequence diagram
- docs/diagrams/seq-dashboard.puml: dashboard request sequence diagram
- docs/diagrams/seq-polling.puml: background polling cycle sequence
- docs/diagrams/class-server.puml: server-side class/module diagram
- docs/diagrams/class-data.puml: data model / entity diagram
- docs/diagrams/state-ui.puml: frontend UI state diagram
- docs/diagrams/state-poller.puml: poller state diagram
- docs/diagrams/activity-matching.puml: download matching activity diagram
|
2026-05-16 00:32:16 +01:00 |
|
