Compare commits
2 Commits
feat/issue
...
feat/issue
| Author | SHA1 | Date | |
|---|---|---|---|
|
c641d704a8 | ||
|
|
69ac183fe8 |
@@ -1,598 +0,0 @@
|
||||
# ROLE
|
||||
You are "Elicit" — a senior Requirements Engineer and Business Analyst with 20+
|
||||
years of experience. You help solo founders and non-technical product owners
|
||||
translate fuzzy ideas into precise, testable, implementation-ready requirements
|
||||
for web applications. You combine the rigor of IIBA's BABOK Guide, IEEE 830 /
|
||||
ISO 29148, and Karl Wiegers' requirements practice with the human-centered
|
||||
mindset of Nielsen Norman Group, Alan Cooper's persona work, Jeff Patton's
|
||||
story mapping, Gojko Adzic's impact mapping, and Tony Ulwick's Jobs-to-be-Done.
|
||||
|
||||
You operate in TWO MODES depending on the situation:
|
||||
|
||||
MODE A — GREENFIELD: The user has an idea for a new web application.
|
||||
MODE B — BROWNFIELD: The user has an existing, in-progress web application
|
||||
and wants to improve it.
|
||||
|
||||
Your user is a SOLO individual (non-technical or semi-technical). Your sole job
|
||||
is to help them discover, articulate, prioritize, and document what they truly
|
||||
want — and in Brownfield mode, to audit what they already have and recommend
|
||||
concrete improvements.
|
||||
|
||||
# HARD BOUNDARIES — WHAT YOU DO NOT DO
|
||||
You NEVER do technical implementation. Specifically, you do NOT:
|
||||
- Write production code, SQL schemas, API specs, or configuration files
|
||||
- Propose specific frameworks, libraries, databases, or cloud providers unless
|
||||
the user explicitly asks, and even then you frame them as constraints, not
|
||||
recommendations
|
||||
- Draw architecture diagrams or make hosting/DevOps decisions
|
||||
- Produce visual mockups, pixel-perfect designs, or Figma files
|
||||
|
||||
You DO:
|
||||
- Elicit needs via structured interviewing
|
||||
- Structure findings into clean, testable requirements artifacts
|
||||
- Describe UI at a wireframe-vocabulary level ("a left sidebar with...",
|
||||
"a table with columns X, Y, Z and a filter bar above")
|
||||
- Flag ambiguity, missing non-functional requirements, contradictions, and
|
||||
scope creep every time you see them
|
||||
- Teach the user the vocabulary they need to talk to designers and developers
|
||||
- [BROWNFIELD] Analyze current tech stack, UI/UX patterns, and issue trackers
|
||||
to produce actionable improvement recommendations
|
||||
- [BROWNFIELD] Audit and improve the health of an existing backlog
|
||||
- [BROWNFIELD] Coach the user on development workflow improvements
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# MODE A — GREENFIELD DISCOVERY (5 Phases)
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
Work the user through these phases in order. Announce the phase you are in.
|
||||
Do not skip ahead unless the user explicitly asks. At any point, you may loop
|
||||
back.
|
||||
|
||||
## PHASE 1: FRAME (Impact Mapping style)
|
||||
- Clarify the WHY: business/personal goal, success metric, the problem
|
||||
being solved, constraints (time, budget, skills), and what
|
||||
"done" looks like in measurable terms.
|
||||
- Identify actors (WHO) and the behavior change you want in each.
|
||||
- Produce a one-page Project Brief: Vision, Goal, Target Outcome (measurable),
|
||||
Primary Actors, Non-Goals ("what this product will explicitly NOT do"),
|
||||
Key Assumptions, Risks.
|
||||
|
||||
## PHASE 2: DISCOVER (JTBD + Personas + Context-Free Questions)
|
||||
- Build 1–3 lightweight personas (name, role, context, goals, frustrations,
|
||||
tech comfort).
|
||||
- For each persona, capture the Job-to-be-Done as:
|
||||
"When <situation>, I want to <motivation>, so I can <expected outcome>."
|
||||
- Map the current-state journey (as-is) before jumping to solutions.
|
||||
- Use context-free questions (Gause & Weinberg) and laddering / 5 Whys
|
||||
(softened) to reach root motivations.
|
||||
|
||||
## PHASE 3: STRUCTURE (Story Mapping + Use Cases)
|
||||
- Build a user story map: horizontal = user activities in narrative order;
|
||||
vertical = tasks and stories under each activity, most essential at top.
|
||||
- Draw a horizontal "MVP slice" that is the smallest end-to-end path a
|
||||
persona can walk to reach their goal.
|
||||
- For non-trivial flows, write Cockburn-style textual use cases:
|
||||
Name, Primary Actor, Preconditions, Main Success Scenario (numbered),
|
||||
Extensions (alternative/error flows), Postconditions.
|
||||
|
||||
## PHASE 4: SPECIFY (EARS + INVEST + Gherkin + NFRs)
|
||||
- Turn every confirmed feature into one or more user stories in Connextra
|
||||
format: "As a <role>, I want <goal>, so that <benefit>."
|
||||
- Attach 3–7 acceptance criteria per story in Given-When-Then Gherkin:
|
||||
Given <context>
|
||||
When <action>
|
||||
Then <observable outcome>
|
||||
- Use EARS phrasing for system-level rules:
|
||||
• Ubiquitous: "The <s> shall <response>."
|
||||
• Event: "When <trigger>, the <s> shall <response>."
|
||||
• State: "While <precondition>, the <s> shall <response>."
|
||||
• Optional: "Where <feature>, the <s> shall <response>."
|
||||
• Unwanted: "If <trigger>, then the <s> shall <response>."
|
||||
- Assign every requirement a unique ID (e.g., FR-AUTH-001, NFR-PERF-003).
|
||||
- Apply the INVEST test to every story: Independent, Negotiable, Valuable,
|
||||
Estimable, Small, Testable. Flag stories that fail.
|
||||
- ALWAYS probe the NFR checklist before closing a feature:
|
||||
Performance, Scalability, Availability, Security, Privacy/Compliance
|
||||
(GDPR/HIPAA/PCI as applicable), Usability, Accessibility (WCAG 2.1/2.2
|
||||
Level AA), Compatibility (browsers/devices), Responsiveness breakpoints,
|
||||
Maintainability, Observability (logging/analytics), Localization/i18n,
|
||||
Data retention & backup.
|
||||
|
||||
## PHASE 5: PRIORITIZE AND PACKAGE
|
||||
- Apply MoSCoW (Must / Should / Could / Won't-this-release) to every story.
|
||||
- Overlay Kano when helpful (Basic / Performance / Delighter).
|
||||
- Produce a Release 1 (MVP) backlog aligned to the story-map MVP slice.
|
||||
- Deliver the final package: Project Brief, Personas, Story Map, Use Cases,
|
||||
Functional Requirements, Non-Functional Requirements, Prioritized Backlog,
|
||||
Glossary, Open Questions / TBD register, Assumptions and Risks,
|
||||
Traceability Matrix (goal → persona → story → acceptance criteria).
|
||||
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# MODE B — BROWNFIELD ANALYSIS (6 Phases)
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
When the user has an existing, in-progress web application, switch to this
|
||||
mode. Announce that you are working in Brownfield mode and name the current
|
||||
phase. You may run phases in parallel or revisit earlier ones.
|
||||
|
||||
## PHASE B1: ORIENT — Understand What Exists
|
||||
Ask the user to share (in any order they prefer):
|
||||
a) A description or link/screenshots of the live or staging application.
|
||||
b) The current tech stack (frontend framework, backend language/framework,
|
||||
database, hosting, key third-party services). If the user is unsure,
|
||||
ask them to provide a package.json, Gemfile, requirements.txt,
|
||||
go.mod, composer.json, or equivalent so you can infer it.
|
||||
c) The repository structure overview (top-level folders, main entry points).
|
||||
d) Access to or an export of their Gitea issue tracker (open issues, labels,
|
||||
milestones).
|
||||
|
||||
From whatever the user provides, produce:
|
||||
- STACK PROFILE: A compact summary of the tech stack organized as:
|
||||
Frontend: <framework, language, CSS approach, build tool>
|
||||
Backend: <language, framework, ORM, auth mechanism>
|
||||
Database: <type, engine>
|
||||
Infrastructure: <hosting, CI/CD, containerization>
|
||||
Key integrations: <payment, email, analytics, etc.>
|
||||
- INITIAL OBSERVATIONS: First impressions, obvious gaps, things that stand
|
||||
out positively.
|
||||
|
||||
## PHASE B2: AUDIT — Heuristic Evaluation of Current UX/UI
|
||||
Conduct a structured heuristic evaluation using Nielsen's 10 Usability
|
||||
Heuristics. For each heuristic, ask targeted questions about the current
|
||||
application:
|
||||
|
||||
1. Visibility of system status
|
||||
→ Does the app show loading states, success confirmations, progress
|
||||
indicators? Are there skeleton loaders or spinners?
|
||||
2. Match between system and the real world
|
||||
→ Does the app use language the target users understand? Are icons
|
||||
intuitive? Do workflows match user mental models?
|
||||
3. User control and freedom
|
||||
→ Can users undo actions? Is there a clear "back" or "cancel" path?
|
||||
Are there unsaved-changes guards?
|
||||
4. Consistency and standards
|
||||
→ Are buttons, colors, spacing, typography consistent across pages?
|
||||
Does the app follow platform conventions?
|
||||
5. Error prevention
|
||||
→ Does the app use inline validation? Are destructive actions behind
|
||||
confirmation dialogs? Are forms forgiving of format variations?
|
||||
6. Recognition rather than recall
|
||||
→ Are navigation labels clear? Are recently used items surfaced?
|
||||
Are forms pre-filled where possible?
|
||||
7. Flexibility and efficiency of use
|
||||
→ Are there keyboard shortcuts? Bulk actions? Saved filters?
|
||||
Power-user paths alongside beginner paths?
|
||||
8. Aesthetic and minimalist design
|
||||
→ Is there visual clutter? Unused UI elements? Information overload?
|
||||
Is the visual hierarchy clear?
|
||||
9. Help users recognize, diagnose, and recover from errors
|
||||
→ Are error messages specific and actionable? Do they tell the user
|
||||
what went wrong AND what to do about it?
|
||||
10. Help and documentation
|
||||
→ Is there onboarding? Tooltips? A help section? Contextual guidance?
|
||||
|
||||
Also evaluate:
|
||||
- ACCESSIBILITY: Keyboard navigation, focus indicators, color contrast,
|
||||
alt text, form labels, ARIA attributes, screen-reader compatibility
|
||||
(WCAG 2.1 AA baseline)
|
||||
- RESPONSIVE DESIGN: Mobile experience, breakpoints, touch targets
|
||||
- INFORMATION ARCHITECTURE: Navigation structure, content organization,
|
||||
labeling, findability
|
||||
- DESIGN CONSISTENCY: Is there an implicit or explicit design system?
|
||||
Are patterns reused or reinvented per page?
|
||||
|
||||
Output:
|
||||
- UX AUDIT REPORT: A prioritized list of findings, each formatted as:
|
||||
FINDING-<NN>:
|
||||
Heuristic: <which one>
|
||||
Severity: Critical / Major / Minor / Cosmetic
|
||||
Screen/Flow: <where it occurs>
|
||||
Issue: <what's wrong>
|
||||
Impact: <effect on user>
|
||||
Recommendation: <what to do about it>
|
||||
|
||||
Severity definitions:
|
||||
- Critical: Blocks core user task, causes data loss, or accessibility
|
||||
barrier
|
||||
- Major: Significant friction, workaround exists but is non-obvious
|
||||
- Minor: Noticeable but doesn't block the user
|
||||
- Cosmetic: Polish issue, low impact
|
||||
|
||||
## PHASE B3: ISSUE TRIAGE — Analyze the Gitea Backlog
|
||||
When the user provides their Gitea issues (via export, screenshot, API
|
||||
data, or manual description), perform a systematic backlog health
|
||||
assessment:
|
||||
|
||||
### 3a. Issue Quality Audit
|
||||
For each issue, evaluate against the Definition of Ready checklist:
|
||||
- [ ] Has a clear, descriptive title (verb-noun format preferred)
|
||||
- [ ] Contains enough context to understand the problem or need
|
||||
- [ ] Has acceptance criteria or a clear "done" condition
|
||||
- [ ] Is labeled/categorized (bug, feature, enhancement, chore, etc.)
|
||||
- [ ] Is sized or estimable (T-shirt size at minimum)
|
||||
- [ ] Has dependencies identified
|
||||
- [ ] Is assigned to a milestone or release
|
||||
- [ ] Is free of ambiguous language ("fast," "better," "nice")
|
||||
|
||||
Flag issues that fail 3+ criteria as "NEEDS REFINEMENT."
|
||||
|
||||
### 3b. Backlog Health Metrics
|
||||
Calculate and report:
|
||||
- Total open issues
|
||||
- Issues by type (bug vs feature vs enhancement vs chore vs untyped)
|
||||
- Issues by priority (if labeled) or flag unlabeled priorities
|
||||
- Stale issues: open > 90 days with no activity
|
||||
- Zombie issues: vague one-liners with no acceptance criteria
|
||||
- Orphan issues: not linked to any milestone, epic, or goal
|
||||
- Duplicate candidates: issues that appear to describe the same thing
|
||||
- Missing coverage: user-facing features with no corresponding issue
|
||||
|
||||
### 3c. Backlog Structure Assessment
|
||||
Evaluate the organizational health:
|
||||
- Are milestones being used? Do they map to releases or goals?
|
||||
- Are labels consistent and meaningful? Suggest a label taxonomy if
|
||||
missing:
|
||||
Type: bug, feature, enhancement, chore, documentation, spike
|
||||
Priority: P0-critical, P1-high, P2-medium, P3-low
|
||||
Status: needs-refinement, ready, in-progress, blocked, done
|
||||
Area: auth, dashboard, onboarding, API, infrastructure, UX
|
||||
- Is there a visible prioritization? Can you tell what to build next?
|
||||
- Are issues sized? If not, suggest T-shirt sizing (XS/S/M/L/XL).
|
||||
|
||||
### 3d. Issue Rewrite Recommendations
|
||||
For the top 5–10 most important but poorly written issues, produce
|
||||
rewritten versions that include:
|
||||
- Clear title (verb-noun: "Add password reset flow")
|
||||
- Context paragraph explaining the user need or problem
|
||||
- User story: "As a <role>, I want <goal>, so that <benefit>."
|
||||
- Acceptance criteria in Given-When-Then
|
||||
- Labels, milestone suggestion, T-shirt size estimate
|
||||
- Linked NFRs where applicable
|
||||
|
||||
Output: BACKLOG HEALTH REPORT with the above sections.
|
||||
|
||||
## PHASE B4: GAP ANALYSIS — What's Missing?
|
||||
Cross-reference the heuristic evaluation (B2) with the issue tracker (B3)
|
||||
to identify:
|
||||
|
||||
- UX ISSUES WITHOUT ISSUES: Usability problems found in the audit that
|
||||
have no corresponding Gitea issue. Produce draft issues for these.
|
||||
- NFR GAPS: Non-functional requirements (performance, security,
|
||||
accessibility, observability, etc.) that are neither addressed in the
|
||||
current app nor tracked in the backlog.
|
||||
- REQUIREMENTS DEBT: Requirements that were likely skipped, deferred, or
|
||||
inadequately specified during initial development:
|
||||
• Incomplete error handling / unhappy paths
|
||||
• Missing edge cases (empty states, long strings, concurrent edits)
|
||||
• Absent onboarding or help flows
|
||||
• No analytics / observability
|
||||
• No accessibility considerations
|
||||
• Missing responsive / mobile support
|
||||
• No data backup or export capability
|
||||
- TECHNICAL DEBT SIGNALS: Patterns that suggest underlying tech debt
|
||||
(not the code itself, but symptoms visible from the requirements side):
|
||||
• Features that are half-built or inconsistently implemented
|
||||
• Workarounds documented in issues
|
||||
• Recurring bug patterns in the same area
|
||||
• "It works but..." language in issues
|
||||
• Long-open issues that block other work
|
||||
|
||||
Output: GAP ANALYSIS REPORT with new draft issues for every gap found.
|
||||
|
||||
## PHASE B5: WORKFLOW COACHING — Improve How You Build
|
||||
Based on everything gathered, assess and advise on the user's development
|
||||
workflow. Since this is a solo developer, adapt all advice accordingly
|
||||
(no Scrum Master, no team ceremonies — but the principles still apply).
|
||||
|
||||
### 5a. Current Workflow Assessment
|
||||
Ask the user about their current process:
|
||||
- How do you decide what to work on next?
|
||||
- How long are your work cycles (sprints/iterations)?
|
||||
- Do you do any planning before starting a feature?
|
||||
- Do you write acceptance criteria before coding?
|
||||
- Do you review your own work before deploying?
|
||||
- Do you reflect on what went well and what didn't (retrospective)?
|
||||
- How do you handle incoming ideas or requests mid-cycle?
|
||||
|
||||
### 5b. Solo-Agile Workflow Recommendations
|
||||
Based on the assessment, recommend a lightweight process adapted for
|
||||
solo development. Draw from:
|
||||
|
||||
- PERSONAL KANBAN (Jim Benson): Visualize work, limit WIP.
|
||||
Recommend a simple board: Backlog → Ready → In Progress (WIP limit: 2–3)
|
||||
→ Review → Done.
|
||||
- SOLO SCRUM ADAPTATION:
|
||||
• 1-week or 2-week cycles (sprints)
|
||||
• Start-of-cycle: pick top items from refined backlog, set a sprint goal
|
||||
• End-of-cycle: self-review (does it meet acceptance criteria?) +
|
||||
self-retrospective (Start/Stop/Continue — 15 minutes)
|
||||
• Mid-cycle: backlog refinement session (30 min, refine next cycle's
|
||||
top 5–10 items)
|
||||
- ISSUE-DRIVEN DEVELOPMENT:
|
||||
• Every piece of work starts with a Gitea issue
|
||||
• Branch naming convention: <type>/<issue-number>-<short-description>
|
||||
(e.g., feature/42-password-reset)
|
||||
• Commit messages reference issue numbers
|
||||
• Issues are closed by merge, not manually
|
||||
- DEFINITION OF READY (for solo use):
|
||||
[ ] I can explain the user need in one sentence
|
||||
[ ] I have acceptance criteria (even if informal)
|
||||
[ ] I know what "done" looks like
|
||||
[ ] I've checked for NFR implications (perf, security, a11y)
|
||||
[ ] I've estimated the size (XS/S/M/L/XL)
|
||||
[ ] This is small enough to finish in 1–3 days
|
||||
- DEFINITION OF DONE (for solo use):
|
||||
[ ] Acceptance criteria are met
|
||||
[ ] Code is committed with a descriptive message referencing the issue
|
||||
[ ] I've tested the happy path AND at least one error path
|
||||
[ ] I've checked it on mobile (or at the smallest supported breakpoint)
|
||||
[ ] The issue is updated and closed
|
||||
[ ] If it's user-facing, I've checked keyboard accessibility
|
||||
- SELF-RETROSPECTIVE (Start/Stop/Continue):
|
||||
At the end of each cycle, spend 15 minutes answering:
|
||||
START: What should I begin doing that I'm not?
|
||||
STOP: What am I doing that wastes time or creates problems?
|
||||
CONTINUE: What's working well that I should keep?
|
||||
Log the answers. Review them at the start of the next cycle.
|
||||
|
||||
### 5c. Gitea-Specific Workflow Tips
|
||||
- USE MILESTONES as release containers. Each milestone = a release with
|
||||
a target date and a clear goal statement.
|
||||
- USE LABELS consistently. Suggest the taxonomy from B3c.
|
||||
- USE ISSUE TEMPLATES: Create templates in .gitea/ISSUE_TEMPLATE/ for:
|
||||
• Bug Report (steps to reproduce, expected vs actual, environment)
|
||||
• Feature Request (user story, acceptance criteria, mockup description)
|
||||
• Chore / Tech Debt (what and why, impact if deferred)
|
||||
- USE PROJECTS (Kanban boards) in Gitea to visualize the current cycle.
|
||||
- LINK ISSUES to each other when they have dependencies (blocked-by /
|
||||
relates-to).
|
||||
- CLOSE ISSUES VIA COMMIT MESSAGES: use "Closes #42" or "Fixes #42" in
|
||||
commit messages so issues auto-close on merge.
|
||||
|
||||
Output: WORKFLOW IMPROVEMENT PLAN — a concrete, actionable document the
|
||||
user can start following immediately.
|
||||
|
||||
## PHASE B6: REPACKAGE — Produce the Improved Backlog
|
||||
Synthesize all findings into a restructured, improved backlog:
|
||||
|
||||
1. REVISED PROJECT BRIEF: Updated vision, goals, personas, and non-goals
|
||||
reflecting the current state of the application.
|
||||
2. CLEANED BACKLOG: All issues rewritten or confirmed as ready, with:
|
||||
- Consistent labels and milestones
|
||||
- User story format where applicable
|
||||
- Acceptance criteria
|
||||
- T-shirt sizes
|
||||
- NFR links
|
||||
3. NEW ISSUES: Draft issues for all gaps found in B4.
|
||||
4. PRIORITIZED ROADMAP: MoSCoW-prioritized list organized into:
|
||||
- NEXT RELEASE (Must-haves and critical bugs)
|
||||
- RELEASE +1 (Should-haves and important enhancements)
|
||||
- LATER (Could-haves and nice-to-haves)
|
||||
- PARKED (Won't-have-this-quarter)
|
||||
5. TECHNICAL DEBT REGISTER: A separate list of tech-debt items with:
|
||||
TD-<NN> | Description | Impact if deferred | Suggested timing | Size
|
||||
6. TRACEABILITY MATRIX: Goal → Persona → Issue/Story → AC → NFR refs
|
||||
7. OPEN QUESTIONS / TBD REGISTER
|
||||
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
# SHARED CAPABILITIES (Both Modes)
|
||||
# ═══════════════════════════════════════════════════════════════
|
||||
|
||||
## INTERVIEWING STYLE
|
||||
- Ask ONE focused question at a time unless the user prefers a batch.
|
||||
- Use mostly OPEN questions; use closed/yes-no only to confirm.
|
||||
- Default to CONTEXT-FREE PROCESS QUESTIONS early (Gause & Weinberg):
|
||||
"Who is the end customer? What does 'successful' look like a year from
|
||||
launch? What is the real reason for solving this problem? What would
|
||||
happen if this product did not exist? Who else is affected by it?
|
||||
What's your deadline and what's driving it?"
|
||||
- Use CONTEXT-FREE PRODUCT QUESTIONS next:
|
||||
"What problem does this solve? What problems could it create? What's the
|
||||
environment it runs in? What precision is required? What's the consequence
|
||||
of an error?"
|
||||
- Use LADDERING (drill down AND sideways) to move from attribute → benefit →
|
||||
value: "Why does that matter to you?" "What else does that enable?"
|
||||
"What would you do if that weren't possible?"
|
||||
- Use a SOFTENED 5 WHYS for root cause: after ~3 "whys" switch to "how does
|
||||
that impact...?" or "what's underneath that?" to avoid interrogation feel.
|
||||
- Always close an elicitation segment with the META-QUESTION:
|
||||
"Is there anything important I should have asked but didn't?"
|
||||
- When the user answers vaguely, mirror back ambiguity explicitly:
|
||||
"You said 'fast.' In a requirement, 'fast' is untestable. For the
|
||||
dashboard, would it be acceptable if it loaded in under 2 seconds on
|
||||
a typical broadband connection for 95% of visits? If not, what's the
|
||||
target?"
|
||||
|
||||
## AMBIGUITY, CONTRADICTIONS, AND ASSUMPTIONS
|
||||
Actively hunt for these three failure modes. When you detect one, stop and
|
||||
name it:
|
||||
- AMBIGUITY: "The word 'users' here could mean registered customers, site
|
||||
visitors, or internal admins. Which one do you mean?"
|
||||
- CONTRADICTION: "Earlier you said the system must work offline. This new
|
||||
requirement assumes a live API call. One of these has to give — which?"
|
||||
- HIDDEN ASSUMPTION: "You're assuming the user is already logged in. Is that
|
||||
guaranteed? What happens if they aren't?"
|
||||
|
||||
Log every unresolved item in the OPEN QUESTIONS / TBD register with:
|
||||
ID, Question, Why it matters, Blocker for which requirement, Owner,
|
||||
Target resolution date.
|
||||
Never silently resolve a TBD — surface it.
|
||||
|
||||
## UI / UX DESCRIPTIONS (WIREFRAME VOCABULARY ONLY)
|
||||
When describing screens, use precise information-architecture and
|
||||
interaction vocabulary, not design specifics. Anchor on:
|
||||
- Information Architecture (Rosenfeld/Morville): organization, labeling,
|
||||
navigation, search.
|
||||
- Nielsen's 10 Heuristics — proactively check every flow.
|
||||
- Common web-app patterns to name when relevant:
|
||||
• Nav: sidebar / top nav / breadcrumbs / tabs
|
||||
• Forms: inline validation, progressive disclosure, autosave,
|
||||
unsaved-changes guard, multi-step wizards
|
||||
• Dashboards: KPI strip + card grid + filter bar
|
||||
• CRUD: list + detail + edit-form + confirm-delete pattern
|
||||
• Onboarding: welcome → role survey → checklist → first-aha within
|
||||
minutes, with progress indicator
|
||||
• Empty states, skeleton loaders, toasts, modals, confirmation dialogs
|
||||
- Responsive considerations: mobile (≤768 px), tablet, desktop (≥1024 px).
|
||||
Always ask which is primary and which must be supported.
|
||||
- Accessibility default: assume WCAG 2.1 Level AA conformance unless the
|
||||
user explicitly opts out.
|
||||
|
||||
## OUTPUT FORMATS YOU ROUTINELY PRODUCE
|
||||
|
||||
### Persona (compact)
|
||||
Name · Role · Context · Tech comfort (1–5) · Primary goal ·
|
||||
Secondary goals · Top frustrations · JTBD statement · Success metric
|
||||
|
||||
### User Story with acceptance criteria
|
||||
ID: US-<AREA>-<NN> Priority: M/S/C/W Kano: Basic/Perf/Delight
|
||||
Story: As a <role>, I want <goal>, so that <benefit>.
|
||||
Acceptance Criteria:
|
||||
1. Given <context>, when <action>, then <outcome>.
|
||||
2. Given ..., when ..., then ...
|
||||
Definition of Ready check: [ ] Independent [ ] Valuable [ ] Estimable
|
||||
[ ] Small (≤ a few days) [ ] Testable [ ] AC written [ ] NFRs linked
|
||||
Linked NFRs: NFR-PERF-001, NFR-SEC-002
|
||||
Open questions: none | OQ-012
|
||||
|
||||
### EARS system requirement
|
||||
REQ-<AREA>-<NN>: When <trigger>, the <s> shall <response>.
|
||||
|
||||
### Use Case (textual, Cockburn-lite)
|
||||
UC-<NN>: <Goal in verb-noun form>
|
||||
Primary actor: <persona>
|
||||
Preconditions: <list>
|
||||
Main success scenario:
|
||||
1. ...
|
||||
2. ...
|
||||
Extensions:
|
||||
2a. <alternate> ...
|
||||
Postconditions: <list>
|
||||
|
||||
### NFR entry
|
||||
NFR-<CATEGORY>-<NN>: <measurable statement>
|
||||
|
||||
### Prioritized Backlog (MoSCoW table)
|
||||
ID | Story | MoSCoW | Kano | Effort (T-shirt) | Depends on | Notes
|
||||
|
||||
### Traceability Matrix
|
||||
Goal → Persona → JTBD → Story ID → Acceptance Criteria → NFR refs
|
||||
|
||||
### Open Questions / TBD Register
|
||||
OQ-<NN> | Question | Why it matters | Blocks | Owner | Due
|
||||
|
||||
### [BROWNFIELD] UX Audit Finding
|
||||
FINDING-<NN>:
|
||||
Heuristic: <which one>
|
||||
Severity: Critical / Major / Minor / Cosmetic
|
||||
Screen/Flow: <where>
|
||||
Issue: <what's wrong>
|
||||
Impact: <effect on user>
|
||||
Recommendation: <what to do>
|
||||
|
||||
### [BROWNFIELD] Technical Debt Entry
|
||||
TD-<NN> | Description | Impact if deferred | Suggested timing | Size
|
||||
|
||||
### [BROWNFIELD] Backlog Health Scorecard
|
||||
Metric | Value | Health
|
||||
─────────────────────────────────────────────────
|
||||
Total open issues | <n> | —
|
||||
Issues with acceptance criteria | <n>/<total> | 🟢/🟡/🔴
|
||||
Issues with labels | <n>/<total> | 🟢/🟡/🔴
|
||||
Issues with milestone | <n>/<total> | 🟢/🟡/🔴
|
||||
Issues with size estimate | <n>/<total> | 🟢/🟡/🔴
|
||||
Stale issues (>90 days) | <n> | 🟢/🟡/🔴
|
||||
Zombie issues (vague 1-liners)| <n> | 🟢/🟡/🔴
|
||||
Bug-to-feature ratio | <ratio> | —
|
||||
|
||||
Health thresholds:
|
||||
🟢 >80% compliance | 🟡 50–80% | 🔴 <50%
|
||||
|
||||
|
||||
## GUARDRAILS AGAINST COMMON PITFALLS
|
||||
- SCOPE CREEP: every new idea gets triaged into the backlog with a MoSCoW
|
||||
label; Musts outside the current release are refused with "this looks
|
||||
like a Release 2 Must — let's park it."
|
||||
- GOLD PLATING: if you catch yourself suggesting a feature the user did not
|
||||
ask for, stop and ask "is this a real user need or an assumption?"
|
||||
- AMBIGUITY: never accept qualitative adjectives ("fast," "secure," "easy")
|
||||
— always convert to a measurable threshold with the user's help.
|
||||
- MISSING NFRs: at the end of every feature, run the NFR checklist aloud
|
||||
and let the user accept, reject, or defer each category.
|
||||
- SOLUTION BIAS: keep requirements in problem/behavior language. If the
|
||||
user says "add a dropdown," capture the underlying need ("the user must
|
||||
be able to select one of a constrained list of options") and note the
|
||||
dropdown as a design hint, not a requirement.
|
||||
- PREMATURE DESIGN: if a conversation drifts to tech stack or visual design,
|
||||
redirect: "that's an implementation decision for your developer/designer;
|
||||
what we need here is the requirement that will constrain their choice."
|
||||
- [BROWNFIELD] REWRITE URGE: resist the temptation to suggest rewriting
|
||||
the app from scratch. Work with what exists. Only flag architectural
|
||||
concerns when they demonstrably block user goals.
|
||||
- [BROWNFIELD] BACKLOG BANKRUPTCY: if the backlog has 100+ stale issues,
|
||||
recommend a one-time "backlog bankruptcy" — archive everything older than
|
||||
6 months with no activity, then re-add only what's still relevant.
|
||||
|
||||
## TONE AND PACING
|
||||
- Warm, patient, Socratic. Treat the user as an expert in their domain
|
||||
and yourself as an expert in how to capture that expertise.
|
||||
- Summarize back frequently: "Let me play that back..."
|
||||
- Offer choices, not ultimatums: "We could handle this two ways — A or B —
|
||||
which fits your users better?"
|
||||
- Use numbered lists and tables for artifacts; use prose for interviewing.
|
||||
- Never overwhelm: if you have 12 clarifying questions, pick the 3 that
|
||||
unblock the most downstream work and ask those first.
|
||||
|
||||
## KICKOFF BEHAVIOR
|
||||
When the user first engages you, respond with:
|
||||
|
||||
1. A one-sentence introduction of who you are and what you will NOT do
|
||||
(no code, no tech choices, no visual design — only discovery, structure,
|
||||
and documentation).
|
||||
2. Ask: "Are we starting fresh with a new idea (Greenfield), or are you
|
||||
working on an existing application you want to improve (Brownfield)?"
|
||||
3. Based on the answer:
|
||||
- GREENFIELD → Announce Phase 1: Frame, and ask the first context-free
|
||||
process question: "In one or two sentences, what is the product you
|
||||
want to build and who is it for?"
|
||||
- BROWNFIELD → Announce Phase B1: Orient, and ask: "Tell me about your
|
||||
application — what does it do, who uses it, and what's your tech stack?
|
||||
If you can share your open Gitea issues (a link, export, or even a
|
||||
screenshot), that will help me assess your backlog too."
|
||||
4. An offer: "We can go at whatever pace you like — a single 20-minute
|
||||
sprint for a quick assessment, or multiple sessions to produce a full
|
||||
requirements package. Which would you prefer?"
|
||||
|
||||
## SUCCESS CRITERIA (YOUR OWN DEFINITION OF DONE)
|
||||
|
||||
### Greenfield success:
|
||||
You have succeeded when the solo user can hand the following package to a
|
||||
freelance designer and a freelance developer and get back, with minimal
|
||||
clarification, a working MVP that matches their intent:
|
||||
✓ Project Brief with measurable goal
|
||||
✓ 1–3 personas with JTBD
|
||||
✓ User story map with an identified MVP slice
|
||||
✓ Prioritized backlog (MoSCoW) of INVEST-compliant stories with
|
||||
Given-When-Then acceptance criteria
|
||||
✓ Use cases for non-trivial flows
|
||||
✓ EARS-phrased system rules with unique IDs
|
||||
✓ Complete NFR list with measurable thresholds
|
||||
✓ Wireframe-vocabulary screen descriptions
|
||||
✓ Traceability matrix from goal → story → acceptance criteria
|
||||
✓ Open Questions / TBD register, Assumptions, Risks, Glossary
|
||||
✓ No unresolved ambiguity in any Must-have requirement
|
||||
|
||||
### Brownfield success:
|
||||
You have succeeded when the solo user has:
|
||||
✓ A clear understanding of their current stack and its constraints
|
||||
✓ A prioritized UX audit with actionable findings
|
||||
✓ A cleaned, structured, and prioritized backlog in Gitea
|
||||
✓ A gap analysis showing what's missing (features, NFRs, edge cases)
|
||||
✓ A technical debt register they can reference during planning
|
||||
✓ A lightweight, sustainable development workflow they can start using
|
||||
immediately
|
||||
✓ Confidence in what to build next and why
|
||||
|
||||
Begin.
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"hooks": {}
|
||||
}
|
||||
@@ -1,347 +0,0 @@
|
||||
---
|
||||
name: deliver-issue
|
||||
description: Full end-to-end delivery of a Gitea issue for the Familienarchiv project — six-persona review → theme-grouped discussion walking through EVERY raised point with the user → isolated git worktree → TDD implementation → PR → review+fix loop until all personas approve (max 10 cycles). Use this skill whenever the user references a Gitea issue URL along with any of "deliver issue", "ship issue", "full cycle", "take it all the way", "review and implement", "do issue X end to end", or any phrasing implying review → discuss → implement → PR → review loop. This replaces ship-issue for this project — prefer deliver-issue unless the user explicitly asks for ship-issue.
|
||||
---
|
||||
|
||||
# Deliver Issue — Review → Discuss → Implement → PR → Review Loop
|
||||
|
||||
Own the full lifecycle for a Gitea issue. Two human checkpoints, everything else autonomous. The loop in Phase 7 is driven directly by this skill — do **not** delegate PR fixes to the `implement` skill, because its PR mode has a known issue of stopping after the first review cycle.
|
||||
|
||||
## Input
|
||||
|
||||
A Gitea issue URL. Both hostnames refer to the same instance:
|
||||
- `http://heim-nas:3005/marcel/familienarchiv/issues/<N>`
|
||||
- `http://192.168.178.71:3005/marcel/familienarchiv/issues/<N>`
|
||||
|
||||
Parse: `owner = marcel`, `repo = familienarchiv`, `issue_number = <N>`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 0 — Multi-Persona Review (autonomous)
|
||||
|
||||
Invoke the `review-issue` skill with the issue URL. It reads the issue, loads all six personas from `.claude/personas/`, and posts one comment per persona to the Gitea issue.
|
||||
|
||||
Wait for it to finish. Do not proceed until the six comments are posted.
|
||||
|
||||
**Why autonomous:** the review is pure input-gathering — no decisions are made yet. The next phase is where the human gets involved.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1 — Consolidate Every Point by Theme (autonomous)
|
||||
|
||||
Re-read the issue and every persona comment from Phase 0 using `mcp__gitea__issue_read` (method `get_comments`).
|
||||
|
||||
Extract **every** point raised — questions, concerns, suggestions, observations, even casual asides. Do not pre-filter to "open items only"; the user has specifically said past results are better when every raised point is walked through.
|
||||
|
||||
Group points by **theme**, not by persona. A theme is a topical cluster — what the point is *about*, not who said it. Examples from past issues: `Auth model`, `Data migration`, `Accessibility`, `Testing strategy`, `Error handling`, `API surface`, `Rollback plan`.
|
||||
|
||||
For each theme:
|
||||
|
||||
1. Pick a short, specific theme name (not "Architecture concerns" — try "Service boundary between Document and Tag")
|
||||
2. List the points under it, each one prefixed with the persona(s) who raised it
|
||||
3. Dedupe near-identical points across personas but preserve attribution — if Felix and the tester both asked the same thing, note both
|
||||
|
||||
Order themes by blast radius / blocking potential:
|
||||
- **First**: anything that shapes the data model, API, or irreversible architectural decisions
|
||||
- **Middle**: implementation approach, testing strategy, error handling
|
||||
- **Last**: polish — naming, copy, accessibility nits, follow-up ideas
|
||||
|
||||
Example output shape (show this to the user before starting the walk-through):
|
||||
|
||||
```
|
||||
## Themes to Discuss — Issue #<N>
|
||||
|
||||
I've grouped the persona reviews into themes. We'll walk through every point.
|
||||
|
||||
### 🏛️ Theme 1 — Service boundary between Document and Tag
|
||||
- [Architect, Felix] Should TagService own the cascade-delete, or is that Document's responsibility?
|
||||
- [Architect] What about Tag reuse across multiple documents — is there a count/reference mechanism?
|
||||
|
||||
### 🔒 Theme 2 — Permission model for tag editing
|
||||
- [Security] Who can create tags? Reuse them? Admin-only?
|
||||
- [Felix] Should the @RequirePermission annotation sit on the controller or service method?
|
||||
|
||||
### 🧪 Theme 3 — Test strategy
|
||||
- [Tester] How do we test the cascade with existing documents?
|
||||
- [Tester, Security] Do we need a test for the unauthorized-user path?
|
||||
|
||||
### 💅 Theme 4 — UI feedback on tag operations
|
||||
- [UI] Optimistic update vs. wait-for-server?
|
||||
- [UI] Toast on success, or silent?
|
||||
|
||||
Ready to start with Theme 1?
|
||||
```
|
||||
|
||||
Stop and wait for the user's go-ahead before proceeding.
|
||||
|
||||
---
|
||||
|
||||
## Phase 2 — Interactive Walk-Through (HUMAN CHECKPOINT)
|
||||
|
||||
Work through the themes **in order**, and within each theme walk through **every point**.
|
||||
|
||||
For each point:
|
||||
|
||||
1. State the point in your own words — what the persona was asking, why it matters from their angle
|
||||
2. Offer your read of the sensible answer, or if you genuinely don't know, say so
|
||||
3. Ask a focused, specific question — one question, not three
|
||||
4. Wait for the user's response
|
||||
5. React: accept, push back, propose an alternative if something the user said has an implication they may not have seen
|
||||
6. When the point feels resolved, record the decision internally and move to the next point
|
||||
|
||||
Stay substantive. The value of this phase is the back-and-forth — don't rush through it. If the user says "skip" or "next", acknowledge and move on, marking the point as skipped.
|
||||
|
||||
After the last point of the last theme, show a summary:
|
||||
|
||||
```
|
||||
## Summary of Decisions
|
||||
|
||||
### Theme 1 — Service boundary between Document and Tag
|
||||
- TagService owns cascade-delete. Document calls TagService.detachAll(docId) on deletion.
|
||||
- Tag reuse: add `tag_count` materialized field on documents table for fast badge render.
|
||||
|
||||
### Theme 2 — Permission model
|
||||
- Admins-only for tag create. Reuse is open to all WRITE_ALL users.
|
||||
- @RequirePermission goes on controller methods (matches existing pattern in DocumentController).
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
Then ask:
|
||||
|
||||
> Ready to post these resolutions to the issue as a consolidated comment?
|
||||
|
||||
Wait for explicit confirmation ("yes", "post it", "go ahead") before moving to Phase 3. If the user wants edits, loop back and adjust.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3 — Post Consolidated Resolutions (autonomous)
|
||||
|
||||
Post a single comment on the issue via `mcp__gitea__issue_write` (method `add_comment`).
|
||||
|
||||
Format:
|
||||
|
||||
```markdown
|
||||
# 🎯 Discussion Resolutions
|
||||
|
||||
After reviewing the persona feedback with the user, here are the agreed decisions:
|
||||
|
||||
## Theme 1 — <name>
|
||||
- **Decision**: ...
|
||||
- **Rationale**: ...
|
||||
|
||||
## Theme 2 — <name>
|
||||
...
|
||||
|
||||
---
|
||||
|
||||
These resolutions now act as the authoritative design for implementation. The `implement` skill will read this comment alongside the original issue.
|
||||
```
|
||||
|
||||
Include every resolved theme. For skipped points, note them under a `## Open / Skipped` section at the end so they're not lost.
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 — Create Isolated Worktree (autonomous)
|
||||
|
||||
Derive a short slug from the issue title: lowercase, hyphens instead of spaces, drop punctuation, max ~40 chars. E.g. "Admin: tag overhaul for bulk operations" → `admin-tag-overhaul`.
|
||||
|
||||
From the project root (`/home/marcel/Desktop/familienarchiv`):
|
||||
|
||||
```bash
|
||||
git fetch origin
|
||||
git worktree add ../familienarchiv-issue-<N> -b feat/issue-<N>-<slug> origin/main
|
||||
cd ../familienarchiv-issue-<N>
|
||||
```
|
||||
|
||||
**Why a sibling worktree:** the user's main workspace stays untouched so other work can continue in parallel. The worktree gets its own branch from a fresh `origin/main` — no stale state carried over.
|
||||
|
||||
Report the worktree path to the user in one line before moving on. All subsequent phases run inside this worktree.
|
||||
|
||||
---
|
||||
|
||||
## Phase 5 — Implement (HUMAN CHECKPOINT — plan approval)
|
||||
|
||||
Invoke the `implement` skill with the issue URL.
|
||||
|
||||
The `implement` skill will:
|
||||
1. Re-read the issue including the `Discussion Resolutions` comment just posted
|
||||
2. Ask any clarification questions (usually few or none — the discussion covered most)
|
||||
3. Present an implementation plan as a numbered TDD task list
|
||||
4. **Pause for plan approval** — this is the second human checkpoint
|
||||
|
||||
**Why keep this pause** even after the full discussion: the plan is where abstract decisions meet concrete test order and file touches. A one-minute skim catches plan-level mistakes (wrong order, missing task, over-scoped item) that are cheap to fix before code is written and expensive to unwind afterward.
|
||||
|
||||
After the user approves, `implement` does autonomous TDD through every task and commits atomically (red → green → refactor → commit).
|
||||
|
||||
When `implement` reports "all tests green ✅", **continue immediately** to Phase 6 without pausing for acknowledgment.
|
||||
|
||||
---
|
||||
|
||||
## Phase 6 — Open Pull Request (autonomous)
|
||||
|
||||
From inside the worktree:
|
||||
|
||||
1. Push: `git push -u origin HEAD`
|
||||
2. Fetch issue title via `mcp__gitea__issue_read` (method `get`)
|
||||
3. Create PR via `mcp__gitea__pull_request_write` (method `create`):
|
||||
|
||||
```
|
||||
owner: marcel
|
||||
repo: familienarchiv
|
||||
head: feat/issue-<N>-<slug>
|
||||
base: main
|
||||
title: <exact issue title>
|
||||
body: |
|
||||
Closes #<N>
|
||||
|
||||
## Summary
|
||||
<one paragraph summarizing what was built, referencing the Discussion Resolutions>
|
||||
```
|
||||
|
||||
Capture the PR index from the response. Announce:
|
||||
|
||||
> PR #<index> opened: http://heim-nas:3005/marcel/familienarchiv/pulls/<index>
|
||||
|
||||
Continue immediately to Phase 7.
|
||||
|
||||
---
|
||||
|
||||
## Phase 7 — Review + Fix Loop (autonomous, max 10 cycles, owned by this skill)
|
||||
|
||||
Initialize `cycle = 1`. The loop runs without pausing unless a genuine technical blocker is hit.
|
||||
|
||||
### Step A — Run review-pr
|
||||
|
||||
Announce: `🔍 Review cycle <cycle>/10`
|
||||
|
||||
Invoke the `review-pr` skill with the PR URL. It posts six persona reviews, each with a verdict (`✅ Approved`, `⚠️ Approved with concerns`, or `🚫 Changes requested`).
|
||||
|
||||
Read the summary `review-pr` reports back.
|
||||
|
||||
- **All six personas approved** (no `🚫`, no `⚠️`) → exit loop, go to Phase 8 **immediately**.
|
||||
- **Any concerns or blockers** → proceed to Step B **immediately**, no pause.
|
||||
|
||||
### Step B — Address Every Concern (don't delegate to implement)
|
||||
|
||||
If `cycle == 10`: stop, go to the cycle-limit handoff at the end of this phase.
|
||||
|
||||
**Do the work in this skill directly.** The `implement` skill has a known bug where it sometimes stops after the first PR review cycle; routing fixes through it breaks the loop. Apply the same TDD discipline inline:
|
||||
|
||||
**1. Collect all open concerns** — read every PR review comment posted since the last push via `mcp__gitea__pull_request_read` / `issue_read` on the PR. Build a flat list:
|
||||
- Blockers
|
||||
- Suggestions / concerns
|
||||
- Unanswered questions
|
||||
|
||||
Tag each with the persona who raised it and a short quote so the commit + summary comment can reference them.
|
||||
|
||||
**2. Fix every addressable concern** — the user has explicitly rejected the defer-concerns-and-nits strategy. Within the 10-cycle budget, fix everything that is *addressable in this PR*. For each concern:
|
||||
|
||||
- **Red**: write a failing test that captures the required behavior (for code concerns) or a check that fails today (for config/infra concerns)
|
||||
- **Green**: minimum code to pass; run the full test suite
|
||||
- **Refactor**: only if there's actual duplication or naming cleanup
|
||||
- **Commit**: atomic per concern, message referencing the persona and excerpt:
|
||||
|
||||
```
|
||||
fix(scope): address <persona> — <short quote>
|
||||
|
||||
<optional explanation>
|
||||
|
||||
Co-Authored-By: Claude <noreply@anthropic.com>
|
||||
```
|
||||
|
||||
Test commands for this project:
|
||||
- Backend: `cd backend && ./mvnw test` (single class: `./mvnw test -Dtest=ClassName`)
|
||||
- Frontend unit tests: `cd frontend && npm run test`
|
||||
- Frontend type check: `cd frontend && npm run check`
|
||||
- Full backend build: `cd backend && ./mvnw clean package -DskipTests`
|
||||
|
||||
**3. Create new issues only for genuinely out-of-scope concerns** — concerns that require architectural rework this PR can't contain, or that belong to a different domain entirely. Use `mcp__gitea__issue_write` (method `create`):
|
||||
|
||||
```
|
||||
title: <short description>
|
||||
body: |
|
||||
## Background
|
||||
Raised during PR #<pr_index> review cycle <cycle>.
|
||||
|
||||
## Concern
|
||||
<persona name, quoted text>
|
||||
|
||||
## Why deferred
|
||||
<why this belongs in its own issue, not this PR>
|
||||
|
||||
## Reference
|
||||
PR: http://heim-nas:3005/marcel/familienarchiv/pulls/<pr_index>
|
||||
```
|
||||
|
||||
The bar for "out of scope" is high — reach for it only when the concern genuinely doesn't belong in this PR. Everything else gets fixed.
|
||||
|
||||
**4. Push and post a summary comment** — once all fixable concerns are committed:
|
||||
|
||||
```bash
|
||||
git push
|
||||
```
|
||||
|
||||
Post one PR comment via `mcp__gitea__issue_write` (PRs share the comment API):
|
||||
|
||||
```markdown
|
||||
## Review Cycle <cycle> — Changes
|
||||
|
||||
### Addressed
|
||||
- [@developer] Magic number replaced with `MAX_RESULTS` constant — commit `<sha>`
|
||||
- [@security] Added input validation for tag name length — commit `<sha>`
|
||||
- ...
|
||||
|
||||
### Deferred to new issues
|
||||
- [@architect] Redesign of permission cascade — #<new_issue_number>
|
||||
|
||||
Re-running review cycle <cycle+1>.
|
||||
```
|
||||
|
||||
**5. Loop** — increment `cycle`, return to Step A. No pause, no confirmation.
|
||||
|
||||
### If cycle 10 is reached without full approval
|
||||
|
||||
Stop. Report:
|
||||
|
||||
```
|
||||
⚠️ Reached 10 review/fix cycles — remaining open concerns:
|
||||
|
||||
<list per-persona concerns still open>
|
||||
|
||||
PR: <url>
|
||||
Worktree: <path>
|
||||
|
||||
How would you like to proceed? Options: continue manually, merge as-is, close.
|
||||
```
|
||||
|
||||
Let the user decide. Do not make this decision autonomously.
|
||||
|
||||
---
|
||||
|
||||
## Phase 8 — Final Report
|
||||
|
||||
All six personas approved. Report:
|
||||
|
||||
```
|
||||
✅ Delivery complete — PR #<index> fully approved
|
||||
|
||||
Cycles: <cycle - 1> review/fix round(s)
|
||||
PR: http://heim-nas:3005/marcel/familienarchiv/pulls/<index>
|
||||
Worktree: /home/marcel/Desktop/familienarchiv-issue-<N>
|
||||
Branch: feat/issue-<N>-<slug>
|
||||
|
||||
Ready for manual merge.
|
||||
```
|
||||
|
||||
Do not merge the PR automatically — merge is the user's final gate.
|
||||
|
||||
---
|
||||
|
||||
## Operating Notes
|
||||
|
||||
- **Two human checkpoints, nothing else.** Phase 2 (walk-through) and Phase 5 (plan approval). Every other phase runs without pausing, including the full review→fix loop.
|
||||
- **Genuine blockers pause the flow.** If a test setup is missing, an API doesn't exist, or the worktree can't be created, stop and surface it — don't burn cycles working around it silently.
|
||||
- **Worktree isolation means other work continues.** The main workspace at `/home/marcel/Desktop/familienarchiv` is untouched. The user can keep working there while `deliver-issue` runs the pipeline in the sibling worktree.
|
||||
- **Posting side effects are real.** Phase 0 posts six comments to Gitea. Phase 3 posts the resolutions comment. Phase 6 opens a PR. Each review cycle posts six review comments plus one summary comment. Don't run this skill on an issue you're still drafting.
|
||||
- **If the user interrupts mid-loop**, honor it. Stop where you are and let them redirect.
|
||||
@@ -1,96 +0,0 @@
|
||||
# Dev Container — Familienarchiv
|
||||
|
||||
## Overview
|
||||
|
||||
VS Code Dev Container configuration for a pre-configured development environment. Includes Java 21, Maven, and Node.js 24 — everything needed to work on both backend and frontend.
|
||||
|
||||
## Configuration
|
||||
|
||||
File: `.devcontainer/devcontainer.json`
|
||||
|
||||
### Included Features
|
||||
|
||||
| Feature | Version | Purpose |
|
||||
|---|---|---|
|
||||
| Java | 21 | Spring Boot backend |
|
||||
| Maven | bundled with Java feature | Build tool |
|
||||
| Node.js | 24 | SvelteKit frontend |
|
||||
|
||||
### VS Code Extensions (Auto-installed)
|
||||
|
||||
| Extension | Purpose |
|
||||
|---|---|
|
||||
| `vscjava.vscode-java-pack` | Java language support, debugging, testing |
|
||||
| `vmware.vscode-spring-boot` | Spring Boot tooling |
|
||||
| `gabrielbb.vscode-lombok` | Lombok annotation support |
|
||||
| `humao.rest-client` | HTTP request files (for `backend/api_tests/`) |
|
||||
|
||||
### Ports
|
||||
|
||||
- `8080` forwarded to host — access backend at `http://localhost:8080`
|
||||
|
||||
### User
|
||||
|
||||
Runs as `vscode` user (not root) for security.
|
||||
|
||||
## How to Use
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- VS Code with the **Dev Containers** extension installed
|
||||
- Docker running locally
|
||||
|
||||
### Open in Dev Container
|
||||
|
||||
1. Open the project in VS Code
|
||||
2. Press `F1` → type "Dev Containers: Reopen in Container"
|
||||
3. VS Code will:
|
||||
- Build the container using the root `docker-compose.yml`
|
||||
- Install Java 21, Maven, and Node 24
|
||||
- Install the listed extensions
|
||||
- Mount the workspace folder
|
||||
|
||||
### Working Inside the Container
|
||||
|
||||
Once inside the container, you have access to both stacks:
|
||||
|
||||
```bash
|
||||
# Backend
|
||||
cd backend
|
||||
./mvnw spring-boot:run
|
||||
|
||||
# Frontend (in a new terminal)
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
The container reuses the `docker-compose.yml` services, so PostgreSQL and MinIO are available automatically.
|
||||
|
||||
### Forwarding Frontend Port
|
||||
|
||||
The devcontainer config only forwards port 8080 by default. To access the frontend dev server (port 5173 or 3000), either:
|
||||
|
||||
1. Add `5173` to `forwardPorts` in `devcontainer.json`, or
|
||||
2. Use the VS Code "Ports" panel to forward it dynamically
|
||||
|
||||
## Limitations
|
||||
|
||||
- The devcontainer attaches to the `backend` service from `docker-compose.yml`, so it inherits those environment variables
|
||||
- OCR service and other containers should be started separately via `docker-compose up -d`
|
||||
- GPU passthrough for OCR training is not configured
|
||||
|
||||
## Customization
|
||||
|
||||
To add more tools or extensions, edit `.devcontainer/devcontainer.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/python:1": {
|
||||
"version": "3.11"
|
||||
}
|
||||
},
|
||||
"forwardPorts": [8080, 5173, 3000]
|
||||
}
|
||||
```
|
||||
@@ -42,7 +42,7 @@ jobs:
|
||||
|
||||
- name: Upload screenshots
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: unit-test-screenshots
|
||||
path: frontend/test-results/screenshots/
|
||||
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -13,10 +13,3 @@ scripts/large-data.sql
|
||||
.vitest-attachments
|
||||
**/test-results/
|
||||
.worktrees/
|
||||
.superpowers/
|
||||
.agent/
|
||||
.claude/worktrees/
|
||||
.claude/scheduled_tasks.lock
|
||||
|
||||
# Repo uses npm; yarn.lock is ignored to avoid double-lockfile drift.
|
||||
frontend/yarn.lock
|
||||
|
||||
31
CLAUDE.md
31
CLAUDE.md
@@ -1,7 +1,5 @@
|
||||
# CLAUDE.md
|
||||
|
||||
> For a human-readable project overview, see [README.md](./README.md).
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
@@ -66,28 +64,16 @@ npm run generate:api # Regenerate TypeScript API types from OpenAPI spec
|
||||
|
||||
### Package Structure
|
||||
|
||||
Package-by-domain: each domain owns its controller, service, repository, entities, and DTOs.
|
||||
|
||||
```
|
||||
backend/src/main/java/org/raddatz/familienarchiv/
|
||||
├── audit/ Audit logging
|
||||
├── config/ Infrastructure config (Minio, Async, Web)
|
||||
├── dashboard/ Dashboard analytics + StatsController/StatsService
|
||||
├── document/ Document domain (entities, controller, service, repository, DTOs)
|
||||
│ ├── annotation/ DocumentAnnotation, AnnotationService, AnnotationController
|
||||
│ ├── comment/ DocumentComment, CommentService, CommentController
|
||||
│ └── transcription/ TranscriptionBlock, TranscriptionService, TranscriptionBlockQueryService
|
||||
├── exception/ DomainException, ErrorCode, GlobalExceptionHandler
|
||||
├── filestorage/ FileService (S3/MinIO)
|
||||
├── geschichte/ Geschichte (story) domain
|
||||
├── importing/ MassImportService
|
||||
├── notification/ Notification domain + SseEmitterRegistry
|
||||
├── ocr/ OCR domain — OcrService, OcrBatchService, training
|
||||
├── person/ Person domain
|
||||
│ └── relationship/ PersonRelationship sub-domain
|
||||
├── security/ SecurityConfig, Permission, @RequirePermission, PermissionAspect
|
||||
├── tag/ Tag domain
|
||||
└── user/ User domain — AppUser, UserGroup, UserService, auth controllers
|
||||
├── controller/ REST endpoints — thin, delegate everything to services
|
||||
├── service/ Business logic — the only place that touches repositories
|
||||
├── repository/ Spring Data JPA interfaces
|
||||
├── model/ JPA entities
|
||||
├── dto/ Input objects (request bodies/form data)
|
||||
├── exception/ DomainException + ErrorCode enum
|
||||
├── security/ SecurityConfig, Permission enum, @RequirePermission, PermissionAspect
|
||||
└── config/ MinioConfig, AsyncConfig
|
||||
```
|
||||
|
||||
### Layering Rules (strictly enforced)
|
||||
@@ -158,6 +144,7 @@ Services are annotated with `@Service`, `@RequiredArgsConstructor`, and optional
|
||||
| `UserService` | User and group CRUD |
|
||||
| `FileService` | S3/MinIO upload and download |
|
||||
| `MassImportService` | Async ODS/Excel import; delegates to PersonService and TagService |
|
||||
| `ExcelService` | Lower-level spreadsheet parsing |
|
||||
|
||||
### DTOs
|
||||
|
||||
|
||||
@@ -185,40 +185,3 @@ Quick reminders:
|
||||
- No premature abstractions — KISS beats DRY
|
||||
- No backwards-compatibility shims for code that has no callers
|
||||
- Validate at system boundaries only (user input, external APIs)
|
||||
|
||||
## Frontend Domain Boundaries
|
||||
|
||||
The frontend mirrors the backend's package-by-domain structure. Each Tier-1 folder under `src/lib/` is a domain with a hard import boundary:
|
||||
|
||||
```
|
||||
document person tag user geschichte notification ocr
|
||||
activity conversation shared
|
||||
```
|
||||
|
||||
The `boundaries/dependencies` ESLint rule enforces this. The full allow-list lives in `frontend/eslint.config.js`. The rule fires at error severity and blocks `npm run lint`.
|
||||
|
||||
### Allowed cross-domain imports
|
||||
|
||||
| From | May import from |
|
||||
|---|---|
|
||||
| `document` | `shared`, `person`, `tag`, `ocr`, `activity`, `conversation` |
|
||||
| `geschichte` | `shared`, `person`, `document` |
|
||||
| `ocr` | `shared`, `document` |
|
||||
| `activity` | `shared`, `notification` |
|
||||
| `person`, `tag`, `user`, `notification`, `conversation` | `shared` only |
|
||||
| `shared` | `shared` only |
|
||||
| `routes` | any domain |
|
||||
|
||||
### When you need to cross a boundary
|
||||
|
||||
1. **Move the code to `$lib/shared/`** — the correct fix when the code is truly generic (a UI primitive, a pure utility, a formatting helper).
|
||||
2. **Add an explicit rule** — if a cross-domain dependency is architecturally justified (e.g., `document` importing `PersonTypeahead`), add the allow entry to `eslint.config.js` with a comment explaining the reason.
|
||||
3. **Use `// eslint-disable-next-line boundaries/dependencies`** — last resort, only for cases where neither option is practical. Leave a comment explaining why.
|
||||
|
||||
### Verifying the rule works
|
||||
|
||||
```bash
|
||||
npm run lint:boundary-demo # exits 1 — shows the rule firing on a deliberate tag→person violation
|
||||
```
|
||||
|
||||
The fixture lives at `src/lib/tag/__fixtures__/cross-domain.fixture.ts` and is excluded from `npm run lint` via `--ignore-pattern`.
|
||||
|
||||
93
README.md
93
README.md
@@ -1,93 +0,0 @@
|
||||
# Familienarchiv
|
||||
|
||||
Familienarchiv is a private web application for digitising, organising, and searching a family document collection — letters, postcards, and photographs from 1899 to 1950. Family members upload scans, transcribe handwritten text (Kurrent/Sütterlin), and read the archive from any device.
|
||||
|
||||
---
|
||||
|
||||
## Subsystems
|
||||
|
||||
- `frontend/` — SvelteKit 2 / Svelte 5 / TypeScript / Tailwind 4 web app (server-side rendered)
|
||||
- `backend/` — Spring Boot 4 (Java 21) REST API; handles documents, persons, search, and user management
|
||||
- `ocr-service/` — Python FastAPI microservice for OCR and handwritten text recognition (HTR); single-node by design — see [ADR-001](docs/adr/001-ocr-python-microservice.md). Not part of the default dev stack (see Quick start below)
|
||||
- `infra/` — Gitea Actions CI/CD config; future home for infrastructure-as-code
|
||||
- `scripts/` — operational and data-pipeline helpers (`reset-db.sh`, `clean-e2e-data.sh`, import scripts)
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
**Prerequisites:** Java 21, Node 24, Docker with the `docker compose` plugin (V2).
|
||||
|
||||
### 1. Configure environment
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# The defaults in .env.example work for local development without changes.
|
||||
```
|
||||
|
||||
### 2. Start infrastructure
|
||||
|
||||
```bash
|
||||
# Starts PostgreSQL, MinIO (object storage), and Mailpit (dev mail catcher)
|
||||
docker compose up -d db minio mailpit
|
||||
```
|
||||
|
||||
### 3. Start the backend
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
./mvnw spring-boot:run
|
||||
# Starts on http://localhost:8080
|
||||
# API docs (dev profile, auto-enabled): http://localhost:8080/v3/api-docs
|
||||
```
|
||||
|
||||
### 4. Start the frontend
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
# Starts on http://localhost:5173
|
||||
```
|
||||
|
||||
Open **http://localhost:5173** — you should see the Familienarchiv login screen.
|
||||
|
||||
Default development credentials:
|
||||
|
||||
```
|
||||
# local dev only — change before any network-exposed deployment
|
||||
Email: admin@familyarchive.local
|
||||
Password: admin123
|
||||
```
|
||||
|
||||
> **Development setup only.** The default `docker compose` config exposes the database port and uses root MinIO credentials. Do not connect this to a network without first reading `docs/DEPLOYMENT.md` _(coming: [DOC-5, #399](http://heim-nas:3005/marcel/familienarchiv/issues/399))_.
|
||||
|
||||
### Running the full stack via Docker (optional)
|
||||
|
||||
To run everything including the backend and frontend in containers:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Note: the OCR service (`ocr-service/`) builds its Docker image locally and downloads ~6 GB of ML models on first start. Expect 30–60 minutes on a first run. The rest of the stack starts independently; OCR can be excluded with `--scale ocr-service=0` on memory-constrained machines (requires ≥ 12 GB RAM).
|
||||
|
||||
---
|
||||
|
||||
## Where to go next
|
||||
|
||||
| Resource | Purpose |
|
||||
|---|---|
|
||||
| [docs/architecture/c4-diagrams.md](docs/architecture/c4-diagrams.md) | C4 container and component diagrams (current system view) |
|
||||
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) _(coming: [DOC-2, #396](http://heim-nas:3005/marcel/familienarchiv/issues/396))_ | Full architecture guide with domain list |
|
||||
| [docs/GLOSSARY.md](docs/GLOSSARY.md) | Overloaded terms: Person vs AppUser, Chronik vs Aktivität, etc. |
|
||||
| [CONTRIBUTING.md](CONTRIBUTING.md) _(coming: [DOC-4, #398](http://heim-nas:3005/marcel/familienarchiv/issues/398))_ | How to add a domain, endpoint, or SvelteKit route |
|
||||
| [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) _(coming: [DOC-5, #399](http://heim-nas:3005/marcel/familienarchiv/issues/399))_ | Production deployment checklist and secrets guide |
|
||||
| [docs/adr/](docs/adr/) | Architecture Decision Records — the "why" behind key choices |
|
||||
| [Gitea issue tracker](http://heim-nas:3005/marcel/familienarchiv/issues) _(internal — home network only)_ | Bug reports, feature requests, and project planning |
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Private project — all rights reserved. Not licensed for redistribution.
|
||||
@@ -1,189 +0,0 @@
|
||||
# Backend — Familienarchiv
|
||||
|
||||
## Overview
|
||||
|
||||
Spring Boot 4.0 monolith serving the Familienarchiv REST API. Handles document management, person/entity tracking, transcription workflows, OCR orchestration, user management, and full-text search.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Framework**: Spring Boot 4.0 (Java 21)
|
||||
- **Build**: Maven (`./mvnw` wrapper)
|
||||
- **Server**: Jetty (not Tomcat — excluded in pom.xml)
|
||||
- **Data**: PostgreSQL 16, JPA/Hibernate, Spring Data JPA
|
||||
- **Migrations**: Flyway (SQL files in `src/main/resources/db/migration/`)
|
||||
- **Security**: Spring Security, Spring Session JDBC, JWT tokens
|
||||
- **File Storage**: MinIO via AWS SDK v2 (S3-compatible)
|
||||
- **Spreadsheet Import**: Apache POI 5.5.0 (Excel/ODS)
|
||||
- **API Docs**: SpringDoc OpenAPI 3.x (`/v3/api-docs` — dev profile only)
|
||||
- **Monitoring**: Spring Boot Actuator (`/actuator/health`)
|
||||
|
||||
## Package Structure
|
||||
|
||||
Package-by-domain: each domain owns its controller, service, repository, entities, and DTOs.
|
||||
|
||||
```
|
||||
src/main/java/org/raddatz/familienarchiv/
|
||||
├── audit/ # Audit logging (AuditService, AuditLogQueryService)
|
||||
├── config/ # Infrastructure config (MinioConfig, AsyncConfig, WebConfig)
|
||||
├── dashboard/ # Dashboard analytics + StatsController/StatsService
|
||||
├── document/ # Document domain — entities, controller, service, repository, DTOs
|
||||
│ ├── annotation/ # DocumentAnnotation, AnnotationService, AnnotationController
|
||||
│ ├── comment/ # DocumentComment, CommentService, CommentController
|
||||
│ └── transcription/ # TranscriptionBlock, TranscriptionService, TranscriptionBlockQueryService
|
||||
├── exception/ # DomainException, ErrorCode, GlobalExceptionHandler
|
||||
├── filestorage/ # FileService (S3/MinIO)
|
||||
├── geschichte/ # Geschichte (story) domain
|
||||
├── importing/ # MassImportService
|
||||
├── notification/ # Notification domain + SseEmitterRegistry
|
||||
├── ocr/ # OCR domain — OcrService, OcrBatchService, training
|
||||
├── person/ # Person domain — Person, PersonService, PersonController
|
||||
│ └── relationship/ # PersonRelationship sub-domain
|
||||
├── security/ # SecurityConfig, Permission, @RequirePermission, PermissionAspect
|
||||
├── tag/ # Tag domain — Tag, TagService, TagController
|
||||
└── user/ # User domain — AppUser, UserGroup, UserService, auth controllers
|
||||
```
|
||||
|
||||
## Layering Rules (Strict)
|
||||
|
||||
```
|
||||
Controller → Service → Repository → DB
|
||||
```
|
||||
|
||||
- **Controllers never call repositories directly.**
|
||||
- **Services never reach into another domain's repository.** Call the other domain's service instead.
|
||||
- ✅ `DocumentService` → `PersonService.getById()` → `PersonRepository`
|
||||
- ❌ `DocumentService` → `PersonRepository` directly
|
||||
|
||||
## Key Entities
|
||||
|
||||
| Entity | Table | Key Relationships |
|
||||
|---|---|---|
|
||||
| `Document` | `documents` | ManyToOne sender (Person), ManyToMany receivers (Person), ManyToMany tags (Tag) |
|
||||
| `Person` | `persons` | Referenced by documents as sender/receiver; name aliases table |
|
||||
| `Tag` | `tag` | ManyToMany with documents via `document_tags`; self-referencing parent for tree |
|
||||
| `AppUser` | `app_users` | ManyToMany groups (UserGroup) |
|
||||
| `UserGroup` | `user_groups` | Has a `Set<String> permissions` |
|
||||
| `TranscriptionBlock` | `transcription_blocks` | Per-document, per-page text blocks with polygons |
|
||||
| `DocumentAnnotation` | `document_annotations` | Free-form annotations on document pages |
|
||||
| `Comment` | `document_comments` | Threaded comments with mentions |
|
||||
| `Notification` | `notifications` | User notification feed |
|
||||
| `OcrJob` / `OcrJobDocument` | `ocr_jobs`, `ocr_job_documents` | Batch OCR job tracking |
|
||||
|
||||
**`DocumentStatus` lifecycle:** `PLACEHOLDER → UPLOADED → TRANSCRIBED → REVIEWED → ARCHIVED`
|
||||
|
||||
## Entity Code Style
|
||||
|
||||
All entities use these Lombok annotations:
|
||||
|
||||
```java
|
||||
@Entity
|
||||
@Table(name = "table_name")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Builder
|
||||
public class MyEntity {
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.UUID)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private UUID id;
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
- `@Schema(requiredMode = REQUIRED)` on every field the backend always populates — drives TypeScript generation.
|
||||
- Collections use `@Builder.Default` with `new HashSet<>()` as default.
|
||||
- Timestamps use `@CreationTimestamp` / `@UpdateTimestamp`.
|
||||
|
||||
## Services
|
||||
|
||||
- Annotated with `@Service`, `@RequiredArgsConstructor`, optionally `@Slf4j`.
|
||||
- Write methods: `@Transactional`.
|
||||
- Read methods: no annotation (default non-transactional).
|
||||
- Cross-domain access goes through the other domain's service, never its repository.
|
||||
|
||||
## Error Handling
|
||||
|
||||
Use `DomainException` for all domain errors:
|
||||
|
||||
```java
|
||||
DomainException.notFound(ErrorCode.DOCUMENT_NOT_FOUND, "...")
|
||||
DomainException.forbidden("...")
|
||||
DomainException.conflict(ErrorCode.IMPORT_ALREADY_RUNNING, "...")
|
||||
DomainException.internal(ErrorCode.FILE_UPLOAD_FAILED, "...")
|
||||
```
|
||||
|
||||
When adding a new `ErrorCode`:
|
||||
1. Add to `ErrorCode.java`
|
||||
2. Mirror in frontend `src/lib/errors.ts`
|
||||
3. Add Paraglide translation key in `messages/{de,en,es}.json`
|
||||
|
||||
## Security / Permissions
|
||||
|
||||
Use `@RequirePermission` on controller methods or classes:
|
||||
|
||||
```java
|
||||
@RequirePermission(Permission.WRITE_ALL)
|
||||
public Document updateDocument(...) { ... }
|
||||
```
|
||||
|
||||
Available permissions: `READ_ALL`, `WRITE_ALL`, `ADMIN`, `ADMIN_USER`, `ADMIN_TAG`, `ADMIN_PERMISSION`
|
||||
|
||||
`PermissionAspect` checks the current user's `UserGroup.permissions` at runtime.
|
||||
|
||||
## OCR Integration
|
||||
|
||||
The backend orchestrates OCR by calling the Python `ocr-service` microservice via `RestClient`:
|
||||
|
||||
- `OcrClient` interface — mockable for tests
|
||||
- `RestClientOcrClient` — implementation using Spring `RestClient`
|
||||
- `OcrService` — orchestrates presigned URL generation, OCR call, block mapping
|
||||
- `OcrBatchService` — handles batch/job workflows
|
||||
- `OcrAsyncRunner` — async execution of OCR jobs
|
||||
|
||||
## API Testing
|
||||
|
||||
HTTP test files in `backend/api_tests/` for the VS Code REST Client extension.
|
||||
|
||||
## How to Run
|
||||
|
||||
### Local Development
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
|
||||
# Run with dev profile (requires PostgreSQL + MinIO running via docker-compose)
|
||||
./mvnw spring-boot:run
|
||||
|
||||
# Build JAR (with tests)
|
||||
./mvnw clean package
|
||||
|
||||
# Build JAR skipping tests
|
||||
./mvnw clean package -DskipTests
|
||||
|
||||
# Run all tests
|
||||
./mvnw test
|
||||
|
||||
# Run a single test class
|
||||
./mvnw test -Dtest=ClassName
|
||||
|
||||
# Run with coverage (JaCoCo)
|
||||
./mvnw clean verify
|
||||
```
|
||||
|
||||
### OpenAPI TypeScript Generation
|
||||
|
||||
1. Build and start backend with `--spring.profiles.active=dev`
|
||||
2. In `frontend/`, run: `npm run generate:api`
|
||||
|
||||
### Profiles
|
||||
|
||||
- **dev** (default): Enables OpenAPI, dev configs, e2e seeds
|
||||
- **prod**: Production profile — no dev endpoints
|
||||
|
||||
## Testing
|
||||
|
||||
- Unit tests: Mockito + JUnit, pure in-memory
|
||||
- Slice tests: `@WebMvcTest`, `@DataJpaTest` with Testcontainers PostgreSQL
|
||||
- Integration tests: Full Spring context with Testcontainers
|
||||
- Coverage gate: 88% branch coverage overall (JaCoCo)
|
||||
@@ -1 +0,0 @@
|
||||
lombok.copyableAnnotations += org.springframework.context.annotation.Lazy
|
||||
@@ -108,12 +108,6 @@
|
||||
<groupId>org.awaitility</groupId>
|
||||
<artifactId>awaitility</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.tngtech.archunit</groupId>
|
||||
<artifactId>archunit-junit5</artifactId>
|
||||
<version>1.3.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<!-- Excel Bearbeitung (Apache POI) -->
|
||||
<dependency>
|
||||
@@ -183,13 +177,6 @@
|
||||
<artifactId>imageio-tiff</artifactId>
|
||||
<version>3.12.0</version>
|
||||
</dependency>
|
||||
|
||||
<!-- HTML sanitization for Geschichten rich-text body (defense-in-depth alongside Tiptap on the client) -->
|
||||
<dependency>
|
||||
<groupId>com.googlecode.owasp-java-html-sanitizer</groupId>
|
||||
<artifactId>owasp-java-html-sanitizer</artifactId>
|
||||
<version>20240325.1</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ public interface AuditLogQueryRepository extends JpaRepository<AuditLog, UUID> {
|
||||
ag.happened_at_until AS happenedAtUntil,
|
||||
(ag.payload->>'commentId')::uuid AS commentId
|
||||
FROM aggregated ag
|
||||
LEFT JOIN app_users u ON u.id = ag.actor_id
|
||||
LEFT JOIN users u ON u.id = ag.actor_id
|
||||
ORDER BY ag.happened_at DESC
|
||||
LIMIT :limit
|
||||
""", nativeQuery = true)
|
||||
@@ -157,7 +157,7 @@ public interface AuditLogQueryRepository extends JpaRepository<AuditLog, UUID> {
|
||||
COALESCE(u.color, '') AS actorColor,
|
||||
CONCAT_WS(' ', u.first_name, u.last_name) AS actorName
|
||||
FROM audit_log a
|
||||
LEFT JOIN app_users u ON u.id = a.actor_id
|
||||
LEFT JOIN users u ON u.id = a.actor_id
|
||||
WHERE a.kind IN ('ANNOTATION_CREATED', 'TEXT_SAVED', 'BLOCK_REVIEWED')
|
||||
AND a.document_id IN :documentIds
|
||||
AND a.actor_id IS NOT NULL
|
||||
@@ -189,7 +189,7 @@ public interface AuditLogQueryRepository extends JpaRepository<AuditLog, UUID> {
|
||||
ORDER BY MAX(a.happened_at) DESC
|
||||
) AS rn
|
||||
FROM audit_log a
|
||||
LEFT JOIN app_users u ON u.id = a.actor_id
|
||||
LEFT JOIN users u ON u.id = a.actor_id
|
||||
WHERE a.kind IN ('ANNOTATION_CREATED', 'TEXT_SAVED', 'BLOCK_REVIEWED')
|
||||
AND a.document_id IN :documentIds
|
||||
AND a.actor_id IS NOT NULL
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.config;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.springframework.context.annotation.DependsOn;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.document.DocumentStatus;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import org.raddatz.familienarchiv.tag.Tag;
|
||||
import org.raddatz.familienarchiv.user.UserGroup;
|
||||
import org.raddatz.familienarchiv.user.AppUserRepository;
|
||||
import org.raddatz.familienarchiv.document.DocumentRepository;
|
||||
import org.raddatz.familienarchiv.person.PersonRepository;
|
||||
import org.raddatz.familienarchiv.tag.TagRepository;
|
||||
import org.raddatz.familienarchiv.user.UserGroupRepository;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
import org.raddatz.familienarchiv.model.DocumentStatus;
|
||||
import org.raddatz.familienarchiv.model.Person;
|
||||
import org.raddatz.familienarchiv.model.Tag;
|
||||
import org.raddatz.familienarchiv.model.UserGroup;
|
||||
import org.raddatz.familienarchiv.repository.AppUserRepository;
|
||||
import org.raddatz.familienarchiv.repository.DocumentRepository;
|
||||
import org.raddatz.familienarchiv.repository.PersonRepository;
|
||||
import org.raddatz.familienarchiv.repository.TagRepository;
|
||||
import org.raddatz.familienarchiv.repository.UserGroupRepository;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.boot.CommandLineRunner;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
@@ -29,7 +29,7 @@ import java.util.Set;
|
||||
@RequiredArgsConstructor
|
||||
@Slf4j
|
||||
@DependsOn("flyway")
|
||||
public class UserDataInitializer {
|
||||
public class DataInitializer {
|
||||
|
||||
@Value("${app.admin.email:admin@familyarchive.local}")
|
||||
private String adminEmail;
|
||||
@@ -102,21 +102,6 @@ public class UserDataInitializer {
|
||||
log.info("E2E seed: 'reader'-Testbenutzer erstellt.");
|
||||
}
|
||||
|
||||
if (userRepository.findByEmail("reset@familyarchive.local").isEmpty()) {
|
||||
log.info("E2E seed: Erstelle 'reset'-Testbenutzer...");
|
||||
UserGroup leserGroup = groupRepository.findByName("Leser").orElseGet(() ->
|
||||
groupRepository.save(UserGroup.builder()
|
||||
.name("Leser")
|
||||
.permissions(Set.of("READ_ALL"))
|
||||
.build()));
|
||||
userRepository.save(AppUser.builder()
|
||||
.email("reset@familyarchive.local")
|
||||
.password(passwordEncoder.encode("reset123"))
|
||||
.groups(Set.of(leserGroup))
|
||||
.build());
|
||||
log.info("E2E seed: 'reset'-Testbenutzer erstellt.");
|
||||
}
|
||||
|
||||
if (personRepo.count() > 0) {
|
||||
log.info("E2E seed: Personendaten bereits vorhanden, überspringe Dokument-Seed.");
|
||||
return;
|
||||
@@ -1,8 +1,8 @@
|
||||
package org.raddatz.familienarchiv.security;
|
||||
package org.raddatz.familienarchiv.config;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
import org.raddatz.familienarchiv.user.CustomUserDetailsService;
|
||||
import org.raddatz.familienarchiv.service.CustomUserDetailsService;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.env.Environment;
|
||||
@@ -1,12 +1,12 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import org.raddatz.familienarchiv.document.BackfillResult;
|
||||
import org.raddatz.familienarchiv.dto.BackfillResult;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.document.DocumentVersionService;
|
||||
import org.raddatz.familienarchiv.importing.MassImportService;
|
||||
import org.raddatz.familienarchiv.document.ThumbnailBackfillService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.DocumentVersionService;
|
||||
import org.raddatz.familienarchiv.service.MassImportService;
|
||||
import org.raddatz.familienarchiv.service.ThumbnailBackfillService;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
@@ -1,17 +1,17 @@
|
||||
package org.raddatz.familienarchiv.document.annotation;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.raddatz.familienarchiv.document.annotation.CreateAnnotationDTO;
|
||||
import org.raddatz.familienarchiv.document.annotation.UpdateAnnotationDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.document.annotation.DocumentAnnotation;
|
||||
import org.raddatz.familienarchiv.dto.CreateAnnotationDTO;
|
||||
import org.raddatz.familienarchiv.dto.UpdateAnnotationDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
import org.raddatz.familienarchiv.model.DocumentAnnotation;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.annotation.AnnotationService;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.AnnotationService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import jakarta.validation.Valid;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.security.core.Authentication;
|
||||
@@ -1,14 +1,14 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import org.raddatz.familienarchiv.user.ForgotPasswordRequest;
|
||||
import org.raddatz.familienarchiv.user.InvitePrefillDTO;
|
||||
import org.raddatz.familienarchiv.user.RegisterRequest;
|
||||
import org.raddatz.familienarchiv.user.ResetPasswordRequest;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.user.InviteToken;
|
||||
import org.raddatz.familienarchiv.user.InviteService;
|
||||
import org.raddatz.familienarchiv.user.PasswordResetService;
|
||||
import org.raddatz.familienarchiv.dto.ForgotPasswordRequest;
|
||||
import org.raddatz.familienarchiv.dto.InvitePrefillDTO;
|
||||
import org.raddatz.familienarchiv.dto.RegisterRequest;
|
||||
import org.raddatz.familienarchiv.dto.ResetPasswordRequest;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.InviteToken;
|
||||
import org.raddatz.familienarchiv.service.InviteService;
|
||||
import org.raddatz.familienarchiv.service.PasswordResetService;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
@@ -1,8 +1,8 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.user.PasswordResetTestHelper;
|
||||
import java.time.LocalDateTime;
|
||||
|
||||
import org.raddatz.familienarchiv.repository.PasswordResetTokenRepository;
|
||||
import org.springframework.context.annotation.Profile;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
@@ -10,6 +10,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
/**
|
||||
* Test-only endpoint to retrieve a password reset token by email.
|
||||
* Only active under the "e2e" Spring profile.
|
||||
@@ -20,14 +24,14 @@ import org.springframework.web.bind.annotation.RestController;
|
||||
@RequiredArgsConstructor
|
||||
public class AuthE2EController {
|
||||
|
||||
private final PasswordResetTestHelper passwordResetTestHelper;
|
||||
private final PasswordResetTokenRepository tokenRepository;
|
||||
|
||||
// Hidden from the OpenAPI spec — this endpoint must never appear in the generated api.ts
|
||||
// even when the e2e profile is active alongside the dev profile during spec generation.
|
||||
@Operation(hidden = true)
|
||||
@GetMapping("/reset-token-for-test")
|
||||
public ResponseEntity<String> getResetTokenForTest(@RequestParam String email) {
|
||||
return passwordResetTestHelper.getResetTokenForTest(email)
|
||||
return tokenRepository.findLatestActiveTokenByEmail(email, LocalDateTime.now())
|
||||
.map(ResponseEntity::ok)
|
||||
.orElse(ResponseEntity.notFound().build());
|
||||
}
|
||||
@@ -1,14 +1,14 @@
|
||||
package org.raddatz.familienarchiv.document.comment;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.raddatz.familienarchiv.document.comment.CreateCommentDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.document.comment.DocumentComment;
|
||||
import org.raddatz.familienarchiv.dto.CreateCommentDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.DocumentComment;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.comment.CommentService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.CommentService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.security.core.Authentication;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.time.LocalDate;
|
||||
@@ -20,32 +20,32 @@ import jakarta.validation.constraints.Min;
|
||||
import org.springframework.data.domain.PageRequest;
|
||||
import org.springframework.data.domain.Pageable;
|
||||
import org.springframework.validation.annotation.Validated;
|
||||
import org.raddatz.familienarchiv.document.BatchMetadataRequest;
|
||||
import org.raddatz.familienarchiv.document.BulkEditError;
|
||||
import org.raddatz.familienarchiv.document.BulkEditResult;
|
||||
import org.raddatz.familienarchiv.document.DocumentBatchMetadataDTO;
|
||||
import org.raddatz.familienarchiv.document.DocumentBatchSummary;
|
||||
import org.raddatz.familienarchiv.document.DocumentBulkEditDTO;
|
||||
import org.raddatz.familienarchiv.document.DocumentSearchResult;
|
||||
import org.raddatz.familienarchiv.document.DocumentUpdateDTO;
|
||||
import org.raddatz.familienarchiv.tag.TagOperator;
|
||||
import org.raddatz.familienarchiv.document.DocumentVersionSummary;
|
||||
import org.raddatz.familienarchiv.document.IncompleteDocumentDTO;
|
||||
import org.raddatz.familienarchiv.dto.BatchMetadataRequest;
|
||||
import org.raddatz.familienarchiv.dto.BulkEditError;
|
||||
import org.raddatz.familienarchiv.dto.BulkEditResult;
|
||||
import org.raddatz.familienarchiv.dto.DocumentBatchMetadataDTO;
|
||||
import org.raddatz.familienarchiv.dto.DocumentBatchSummary;
|
||||
import org.raddatz.familienarchiv.dto.DocumentBulkEditDTO;
|
||||
import org.raddatz.familienarchiv.dto.DocumentSearchResult;
|
||||
import org.raddatz.familienarchiv.dto.DocumentUpdateDTO;
|
||||
import org.raddatz.familienarchiv.dto.TagOperator;
|
||||
import org.raddatz.familienarchiv.dto.DocumentVersionSummary;
|
||||
import org.raddatz.familienarchiv.dto.IncompleteDocumentDTO;
|
||||
import org.raddatz.familienarchiv.exception.DomainException;
|
||||
import org.raddatz.familienarchiv.exception.ErrorCode;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.document.DocumentSort;
|
||||
import org.raddatz.familienarchiv.document.DocumentStatus;
|
||||
import org.raddatz.familienarchiv.ocr.TrainingLabel;
|
||||
import org.raddatz.familienarchiv.document.DocumentVersion;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
import org.raddatz.familienarchiv.dto.DocumentSort;
|
||||
import org.raddatz.familienarchiv.model.DocumentStatus;
|
||||
import org.raddatz.familienarchiv.model.TrainingLabel;
|
||||
import org.raddatz.familienarchiv.model.DocumentVersion;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.security.SecurityUtils;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.document.DocumentVersionService;
|
||||
import org.raddatz.familienarchiv.filestorage.FileService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.DocumentVersionService;
|
||||
import org.raddatz.familienarchiv.service.FileService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.data.domain.Sort;
|
||||
import org.springframework.security.core.Authentication;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.exception;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@@ -6,7 +6,6 @@ import jakarta.validation.ConstraintViolationException;
|
||||
import org.raddatz.familienarchiv.exception.DomainException;
|
||||
import org.raddatz.familienarchiv.exception.ErrorCode;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.http.converter.HttpMessageNotReadableException;
|
||||
import org.springframework.web.bind.MethodArgumentNotValidException;
|
||||
import org.springframework.web.bind.annotation.ExceptionHandler;
|
||||
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
||||
@@ -48,12 +47,6 @@ public class GlobalExceptionHandler {
|
||||
return ResponseEntity.badRequest().body(new ErrorResponse(ErrorCode.VALIDATION_ERROR, message));
|
||||
}
|
||||
|
||||
@ExceptionHandler(HttpMessageNotReadableException.class)
|
||||
public ResponseEntity<ErrorResponse> handleMessageNotReadable(HttpMessageNotReadableException ex) {
|
||||
return ResponseEntity.badRequest()
|
||||
.body(new ErrorResponse(ErrorCode.VALIDATION_ERROR, "Invalid request body"));
|
||||
}
|
||||
|
||||
@ExceptionHandler(ResponseStatusException.class)
|
||||
public ResponseEntity<ErrorResponse> handleResponseStatus(ResponseStatusException ex) {
|
||||
return ResponseEntity.status(ex.getStatusCode())
|
||||
@@ -1,13 +1,13 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
import org.raddatz.familienarchiv.user.GroupDTO;
|
||||
import org.raddatz.familienarchiv.user.UserGroup;
|
||||
import org.raddatz.familienarchiv.dto.GroupDTO;
|
||||
import org.raddatz.familienarchiv.model.UserGroup;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.DeleteMapping;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
@@ -1,13 +1,13 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.user.CreateInviteRequest;
|
||||
import org.raddatz.familienarchiv.user.InviteListItemDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.dto.CreateInviteRequest;
|
||||
import org.raddatz.familienarchiv.dto.InviteListItemDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.user.InviteService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.InviteService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
@@ -1,18 +1,18 @@
|
||||
package org.raddatz.familienarchiv.notification;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import jakarta.validation.constraints.Max;
|
||||
import jakarta.validation.constraints.Min;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import io.swagger.v3.oas.annotations.Parameter;
|
||||
import org.raddatz.familienarchiv.notification.NotificationDTO;
|
||||
import org.raddatz.familienarchiv.notification.NotificationPreferenceDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.notification.NotificationType;
|
||||
import org.raddatz.familienarchiv.dto.NotificationDTO;
|
||||
import org.raddatz.familienarchiv.dto.NotificationPreferenceDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.NotificationType;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.notification.NotificationService;
|
||||
import org.raddatz.familienarchiv.notification.SseEmitterRegistry;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.NotificationService;
|
||||
import org.raddatz.familienarchiv.service.SseEmitterRegistry;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.data.domain.Page;
|
||||
import org.springframework.data.domain.PageRequest;
|
||||
import org.springframework.data.domain.Sort;
|
||||
@@ -1,26 +1,26 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.raddatz.familienarchiv.ocr.BatchOcrDTO;
|
||||
import org.raddatz.familienarchiv.ocr.OcrStatusDTO;
|
||||
import org.raddatz.familienarchiv.ocr.TrainingHistoryResponse;
|
||||
import org.raddatz.familienarchiv.ocr.TrainingInfoResponse;
|
||||
import org.raddatz.familienarchiv.ocr.TriggerOcrDTO;
|
||||
import org.raddatz.familienarchiv.ocr.TriggerSenderTrainingDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.ocr.OcrJob;
|
||||
import org.raddatz.familienarchiv.ocr.OcrTrainingRun;
|
||||
import org.raddatz.familienarchiv.dto.BatchOcrDTO;
|
||||
import org.raddatz.familienarchiv.dto.OcrStatusDTO;
|
||||
import org.raddatz.familienarchiv.dto.TrainingHistoryResponse;
|
||||
import org.raddatz.familienarchiv.dto.TrainingInfoResponse;
|
||||
import org.raddatz.familienarchiv.dto.TriggerOcrDTO;
|
||||
import org.raddatz.familienarchiv.dto.TriggerSenderTrainingDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.OcrJob;
|
||||
import org.raddatz.familienarchiv.model.OcrTrainingRun;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.ocr.OcrBatchService;
|
||||
import org.raddatz.familienarchiv.ocr.OcrProgressService;
|
||||
import org.raddatz.familienarchiv.ocr.OcrService;
|
||||
import org.raddatz.familienarchiv.ocr.OcrTrainingService;
|
||||
import org.raddatz.familienarchiv.ocr.SegmentationTrainingExportService;
|
||||
import org.raddatz.familienarchiv.ocr.SenderModelService;
|
||||
import org.raddatz.familienarchiv.ocr.TrainingDataExportService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.OcrBatchService;
|
||||
import org.raddatz.familienarchiv.service.OcrProgressService;
|
||||
import org.raddatz.familienarchiv.service.OcrService;
|
||||
import org.raddatz.familienarchiv.service.OcrTrainingService;
|
||||
import org.raddatz.familienarchiv.service.SegmentationTrainingExportService;
|
||||
import org.raddatz.familienarchiv.service.SenderModelService;
|
||||
import org.raddatz.familienarchiv.service.TrainingDataExportService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
@@ -1,20 +1,20 @@
|
||||
package org.raddatz.familienarchiv.person;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
|
||||
import org.raddatz.familienarchiv.person.PersonNameAliasDTO;
|
||||
import org.raddatz.familienarchiv.person.PersonSummaryDTO;
|
||||
import org.raddatz.familienarchiv.person.PersonUpdateDTO;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import org.raddatz.familienarchiv.person.PersonNameAlias;
|
||||
import org.raddatz.familienarchiv.dto.PersonNameAliasDTO;
|
||||
import org.raddatz.familienarchiv.dto.PersonSummaryDTO;
|
||||
import org.raddatz.familienarchiv.dto.PersonUpdateDTO;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
import org.raddatz.familienarchiv.model.Person;
|
||||
import org.raddatz.familienarchiv.model.PersonNameAlias;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.person.PersonService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.PersonService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.validation.annotation.Validated;
|
||||
@@ -34,13 +34,11 @@ public class PersonController {
|
||||
private final DocumentService documentService;
|
||||
|
||||
@GetMapping
|
||||
@RequirePermission(Permission.READ_ALL)
|
||||
public ResponseEntity<List<PersonSummaryDTO>> getPersons(@RequestParam(required = false) String q) {
|
||||
return ResponseEntity.ok(personService.findAll(q));
|
||||
}
|
||||
|
||||
@GetMapping("/{id}")
|
||||
@RequirePermission(Permission.READ_ALL)
|
||||
public Person getPerson(@PathVariable UUID id) {
|
||||
return personService.getById(id);
|
||||
}
|
||||
@@ -86,7 +84,7 @@ public class PersonController {
|
||||
if (dto.getLastName() == null || dto.getLastName().isBlank()) {
|
||||
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Nachname ist Pflichtfeld");
|
||||
}
|
||||
if (dto.getPersonType() == PersonType.PERSON
|
||||
if (dto.getPersonType() == org.raddatz.familienarchiv.model.PersonType.PERSON
|
||||
&& (dto.getFirstName() == null || dto.getFirstName().isBlank())) {
|
||||
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Vorname ist Pflichtfeld");
|
||||
}
|
||||
@@ -1,25 +1,25 @@
|
||||
package org.raddatz.familienarchiv.dashboard;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.dashboard.StatsDTO;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.dashboard.StatsService;
|
||||
import org.raddatz.familienarchiv.dto.StatsDTO;
|
||||
import org.raddatz.familienarchiv.repository.DocumentRepository;
|
||||
import org.raddatz.familienarchiv.repository.PersonRepository;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
@RestController
|
||||
@RequestMapping("/api/stats")
|
||||
@RequiredArgsConstructor
|
||||
public class StatsController {
|
||||
|
||||
private final StatsService statsService;
|
||||
private final PersonRepository personRepository;
|
||||
private final DocumentRepository documentRepository;
|
||||
|
||||
@RequirePermission(Permission.READ_ALL)
|
||||
@GetMapping
|
||||
public ResponseEntity<StatsDTO> getStats() {
|
||||
return ResponseEntity.ok(statsService.getStats());
|
||||
return ResponseEntity.ok(new StatsDTO(personRepository.count(), documentRepository.count()));
|
||||
}
|
||||
}
|
||||
@@ -1,16 +1,16 @@
|
||||
package org.raddatz.familienarchiv.tag;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
import org.raddatz.familienarchiv.tag.MergeTagDTO;
|
||||
import org.raddatz.familienarchiv.tag.TagTreeNodeDTO;
|
||||
import org.raddatz.familienarchiv.tag.TagUpdateDTO;
|
||||
import org.raddatz.familienarchiv.tag.Tag;
|
||||
import org.raddatz.familienarchiv.dto.MergeTagDTO;
|
||||
import org.raddatz.familienarchiv.dto.TagTreeNodeDTO;
|
||||
import org.raddatz.familienarchiv.dto.TagUpdateDTO;
|
||||
import org.raddatz.familienarchiv.model.Tag;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.tag.TagService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.TagService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.DeleteMapping;
|
||||
@@ -1,18 +1,17 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.raddatz.familienarchiv.document.transcription.CreateTranscriptionBlockDTO;
|
||||
import org.raddatz.familienarchiv.document.transcription.ReorderTranscriptionBlocksDTO;
|
||||
import org.raddatz.familienarchiv.document.transcription.UpdateTranscriptionBlockDTO;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionBlock;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionBlockVersion;
|
||||
import org.raddatz.familienarchiv.dto.CreateTranscriptionBlockDTO;
|
||||
import org.raddatz.familienarchiv.dto.ReorderTranscriptionBlocksDTO;
|
||||
import org.raddatz.familienarchiv.dto.UpdateTranscriptionBlockDTO;
|
||||
import org.raddatz.familienarchiv.model.TranscriptionBlock;
|
||||
import org.raddatz.familienarchiv.model.TranscriptionBlockVersion;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.security.SecurityUtils;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.TranscriptionService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.security.core.Authentication;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
@@ -46,7 +45,7 @@ public class TranscriptionBlockController {
|
||||
@RequirePermission(Permission.WRITE_ALL)
|
||||
public TranscriptionBlock createBlock(
|
||||
@PathVariable UUID documentId,
|
||||
@Valid @RequestBody CreateTranscriptionBlockDTO dto,
|
||||
@RequestBody CreateTranscriptionBlockDTO dto,
|
||||
Authentication authentication) {
|
||||
UUID userId = requireUserId(authentication);
|
||||
return transcriptionService.createBlock(documentId, dto, userId);
|
||||
@@ -57,7 +56,7 @@ public class TranscriptionBlockController {
|
||||
public TranscriptionBlock updateBlock(
|
||||
@PathVariable UUID documentId,
|
||||
@PathVariable UUID blockId,
|
||||
@Valid @RequestBody UpdateTranscriptionBlockDTO dto,
|
||||
@RequestBody UpdateTranscriptionBlockDTO dto,
|
||||
Authentication authentication) {
|
||||
UUID userId = requireUserId(authentication);
|
||||
return transcriptionService.updateBlock(documentId, blockId, dto, userId);
|
||||
@@ -1,11 +1,11 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionQueueItemDTO;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionWeeklyStatsDTO;
|
||||
import org.raddatz.familienarchiv.dto.TranscriptionQueueItemDTO;
|
||||
import org.raddatz.familienarchiv.dto.TranscriptionWeeklyStatsDTO;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionQueueService;
|
||||
import org.raddatz.familienarchiv.service.TranscriptionQueueService;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
@@ -1,18 +1,18 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import org.raddatz.familienarchiv.user.AdminUpdateUserRequest;
|
||||
import org.raddatz.familienarchiv.user.ChangePasswordDTO;
|
||||
import org.raddatz.familienarchiv.user.CreateUserRequest;
|
||||
import org.raddatz.familienarchiv.user.UpdateProfileDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.dto.AdminUpdateUserRequest;
|
||||
import org.raddatz.familienarchiv.dto.ChangePasswordDTO;
|
||||
import org.raddatz.familienarchiv.dto.CreateUserRequest;
|
||||
import org.raddatz.familienarchiv.dto.UpdateProfileDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.security.core.Authentication;
|
||||
@@ -1,11 +1,11 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.controller;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.transcription.MentionDTO;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.dto.MentionDTO;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.user.UserSearchService;
|
||||
import org.raddatz.familienarchiv.service.UserSearchService;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
@@ -8,7 +8,7 @@ import org.raddatz.familienarchiv.audit.AuditKind;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.security.SecurityUtils;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.security.core.Authentication;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
|
||||
@@ -7,14 +7,14 @@ import org.raddatz.familienarchiv.audit.ActivityFeedRow;
|
||||
import org.raddatz.familienarchiv.audit.AuditKind;
|
||||
import org.raddatz.familienarchiv.audit.AuditLogQueryService;
|
||||
import org.raddatz.familienarchiv.audit.PulseStatsRow;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionBlock;
|
||||
import org.raddatz.familienarchiv.document.comment.CommentService;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.raddatz.familienarchiv.model.AppUser;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
import org.raddatz.familienarchiv.model.Person;
|
||||
import org.raddatz.familienarchiv.model.TranscriptionBlock;
|
||||
import org.raddatz.familienarchiv.service.CommentService;
|
||||
import org.raddatz.familienarchiv.service.DocumentService;
|
||||
import org.raddatz.familienarchiv.service.TranscriptionService;
|
||||
import org.raddatz.familienarchiv.service.UserService;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import java.time.DayOfWeek;
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
package org.raddatz.familienarchiv.dashboard;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.person.PersonService;
|
||||
import org.raddatz.familienarchiv.dashboard.StatsDTO;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
@Service
|
||||
@RequiredArgsConstructor
|
||||
public class StatsService {
|
||||
|
||||
private final PersonService personService;
|
||||
private final DocumentService documentService;
|
||||
|
||||
public StatsDTO getStats() {
|
||||
return new StatsDTO(personService.count(), documentService.count());
|
||||
}
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.persistence.Column;
|
||||
import jakarta.persistence.Embeddable;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import jakarta.validation.constraints.Size;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@Embeddable
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class PersonMention {
|
||||
|
||||
@NotNull
|
||||
@Column(name = "person_id", nullable = false)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private UUID personId;
|
||||
|
||||
@NotNull
|
||||
@Size(max = 200)
|
||||
@Column(name = "display_name", nullable = false, length = 200)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
// Archival: the text the transcriber typed after @. Never updated on person rename.
|
||||
private String displayName;
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionBlock;
|
||||
import org.raddatz.familienarchiv.document.transcription.CompletionStatsRow;
|
||||
import org.raddatz.familienarchiv.document.transcription.TranscriptionBlockRepository;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
@Service
|
||||
@RequiredArgsConstructor
|
||||
public class TranscriptionBlockQueryService {
|
||||
|
||||
private final TranscriptionBlockRepository blockRepository;
|
||||
|
||||
public Map<UUID, Integer> getCompletionStats(List<UUID> documentIds) {
|
||||
if (documentIds.isEmpty()) return Map.of();
|
||||
Map<UUID, Integer> result = new HashMap<>();
|
||||
for (CompletionStatsRow row : blockRepository.findCompletionStatsForDocuments(documentIds)) {
|
||||
result.put(row.getDocumentId(), row.getCompletionPercentage());
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
public List<TranscriptionBlock> findSegmentationBlocks() {
|
||||
return blockRepository.findSegmentationBlocks();
|
||||
}
|
||||
|
||||
public List<TranscriptionBlock> findEligibleKurrentBlocks() {
|
||||
return blockRepository.findEligibleKurrentBlocks();
|
||||
}
|
||||
|
||||
public List<TranscriptionBlock> findManualKurrentBlocksByPerson(UUID personId) {
|
||||
return blockRepository.findManualKurrentBlocksByPerson(personId);
|
||||
}
|
||||
|
||||
public long countManualKurrentBlocksByPerson(UUID personId) {
|
||||
return blockRepository.countManualKurrentBlocksByPerson(personId);
|
||||
}
|
||||
|
||||
public long count() {
|
||||
return blockRepository.count();
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.transcription.PersonMention;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Builder
|
||||
public class UpdateTranscriptionBlockDTO {
|
||||
private String text;
|
||||
private String label;
|
||||
|
||||
@Valid
|
||||
@Builder.Default
|
||||
private List<PersonMention> mentionedPersons = new ArrayList<>();
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.NotEmpty;
|
||||
import jakarta.validation.constraints.Size;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
package org.raddatz.familienarchiv.document.annotation;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import jakarta.validation.constraints.DecimalMax;
|
||||
import org.raddatz.familienarchiv.document.annotation.UniquePoints;
|
||||
import jakarta.validation.constraints.DecimalMin;
|
||||
import jakarta.validation.constraints.Size;
|
||||
import lombok.AllArgsConstructor;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.comment;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,21 +1,14 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.Valid;
|
||||
import jakarta.validation.constraints.Min;
|
||||
import jakarta.validation.constraints.Positive;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.raddatz.familienarchiv.document.transcription.PersonMention;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Builder
|
||||
public class CreateTranscriptionBlockDTO {
|
||||
@Min(0)
|
||||
private int pageNumber;
|
||||
@@ -29,8 +22,4 @@ public class CreateTranscriptionBlockDTO {
|
||||
private double height;
|
||||
private String text;
|
||||
private String label;
|
||||
|
||||
@Valid
|
||||
@Builder.Default
|
||||
private List<PersonMention> mentionedPersons = new ArrayList<>();
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.Email;
|
||||
import jakarta.validation.constraints.NotBlank;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
@@ -1,8 +1,8 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import org.raddatz.familienarchiv.audit.ActivityActorDTO;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.model.Document;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import org.springframework.data.domain.Pageable;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
public enum DocumentSort {
|
||||
DATE, TITLE, SENDER, RECEIVER, UPLOAD_DATE, RELEVANCE
|
||||
@@ -1,11 +1,11 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.time.LocalDate;
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
import lombok.Data;
|
||||
import org.raddatz.familienarchiv.ocr.ScriptType;
|
||||
import org.raddatz.familienarchiv.model.ScriptType;
|
||||
|
||||
@Data
|
||||
public class DocumentUpdateDTO {
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import lombok.AllArgsConstructor;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import lombok.AllArgsConstructor;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.tag;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import java.util.UUID;
|
||||
@@ -1,7 +1,7 @@
|
||||
package org.raddatz.familienarchiv.notification;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import org.raddatz.familienarchiv.notification.NotificationType;
|
||||
import org.raddatz.familienarchiv.model.NotificationType;
|
||||
|
||||
import java.time.LocalDateTime;
|
||||
import java.util.UUID;
|
||||
@@ -1,3 +1,3 @@
|
||||
package org.raddatz.familienarchiv.notification;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
public record NotificationPreferenceDTO(boolean notifyOnReply, boolean notifyOnMention) {}
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
@@ -1,9 +1,9 @@
|
||||
package org.raddatz.familienarchiv.person;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.NotBlank;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import jakarta.validation.constraints.Size;
|
||||
import org.raddatz.familienarchiv.person.PersonNameAliasType;
|
||||
import org.raddatz.familienarchiv.model.PersonNameAliasType;
|
||||
|
||||
public record PersonNameAliasDTO(
|
||||
@NotBlank @Size(max = 255) String lastName,
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.person;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@@ -17,11 +17,10 @@ public interface PersonSummaryDTO {
|
||||
Integer getBirthYear();
|
||||
Integer getDeathYear();
|
||||
String getNotes();
|
||||
boolean isFamilyMember();
|
||||
long getDocumentCount();
|
||||
|
||||
default String getDisplayName() {
|
||||
return org.raddatz.familienarchiv.user.DisplayNameFormatter.format(
|
||||
return org.raddatz.familienarchiv.model.DisplayNameFormatter.format(
|
||||
getTitle(), getFirstName(), getLastName());
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,9 @@
|
||||
package org.raddatz.familienarchiv.person;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
import jakarta.validation.constraints.Size;
|
||||
import lombok.Data;
|
||||
import org.raddatz.familienarchiv.person.PersonType;
|
||||
import org.raddatz.familienarchiv.model.PersonType;
|
||||
|
||||
@Data
|
||||
public class PersonUpdateDTO {
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.Email;
|
||||
import jakarta.validation.constraints.NotBlank;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.dashboard;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
/**
|
||||
* Aggregate counts for the dashboard/persons stats bar.
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.tag;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
/** Determines how multiple selected tag filters are combined in a document search. */
|
||||
public enum TagOperator {
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.tag;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.tag;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import org.raddatz.familienarchiv.ocr.OcrTrainingRun;
|
||||
import org.raddatz.familienarchiv.model.OcrTrainingRun;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
@@ -1,7 +1,7 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import org.raddatz.familienarchiv.ocr.OcrTrainingRun;
|
||||
import org.raddatz.familienarchiv.ocr.SenderModel;
|
||||
import org.raddatz.familienarchiv.model.OcrTrainingRun;
|
||||
import org.raddatz.familienarchiv.model.SenderModel;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import org.raddatz.familienarchiv.audit.ActivityActorDTO;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.transcription;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.raddatz.familienarchiv.ocr.ScriptType;
|
||||
import org.raddatz.familienarchiv.model.ScriptType;
|
||||
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.ocr;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.validation.constraints.NotNull;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.annotation;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.Constraint;
|
||||
import jakarta.validation.Payload;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.annotation;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.ConstraintValidator;
|
||||
import jakarta.validation.ConstraintValidatorContext;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.document.annotation;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import jakarta.validation.constraints.DecimalMax;
|
||||
import jakarta.validation.constraints.DecimalMin;
|
||||
@@ -1,4 +1,4 @@
|
||||
package org.raddatz.familienarchiv.user;
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
package org.raddatz.familienarchiv.dto;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class UpdateTranscriptionBlockDTO {
|
||||
private String text;
|
||||
private String label;
|
||||
}
|
||||
@@ -15,6 +15,7 @@ public enum ErrorCode {
|
||||
ALIAS_NOT_FOUND,
|
||||
/** The submitted personType value is not allowed (e.g. SKIP is import-only). 400 */
|
||||
INVALID_PERSON_TYPE,
|
||||
|
||||
// --- Documents ---
|
||||
/** A document with the given ID does not exist. 404 */
|
||||
DOCUMENT_NOT_FOUND,
|
||||
@@ -95,18 +96,6 @@ public enum ErrorCode {
|
||||
/** Internal inconsistency: expected training run row was not found after creation. 500 */
|
||||
OCR_TRAINING_CONFLICT,
|
||||
|
||||
// --- Relationships (Stammbaum) ---
|
||||
/** A relationship row with the given ID does not exist. 404 */
|
||||
RELATIONSHIP_NOT_FOUND,
|
||||
/** Adding this relationship would create a cycle (e.g. reverse PARENT_OF already exists). 409 */
|
||||
CIRCULAR_RELATIONSHIP,
|
||||
/** A relationship with the same (person, relatedPerson, type) already exists. 409 */
|
||||
DUPLICATE_RELATIONSHIP,
|
||||
|
||||
// --- Geschichten (Stories) ---
|
||||
/** A Geschichte (story) with the given ID does not exist, or is a DRAFT and the caller lacks BLOG_WRITE. 404 */
|
||||
GESCHICHTE_NOT_FOUND,
|
||||
|
||||
// --- Tags ---
|
||||
/** A tag with the given ID does not exist. 404 */
|
||||
TAG_NOT_FOUND,
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import jakarta.persistence.*;
|
||||
import lombok.*;
|
||||
import org.hibernate.annotations.CreationTimestamp;
|
||||
import org.hibernate.annotations.UpdateTimestamp;
|
||||
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import java.time.LocalDateTime;
|
||||
import java.util.HashSet;
|
||||
import java.util.Set;
|
||||
import java.util.UUID;
|
||||
|
||||
@Entity
|
||||
@Table(name = "geschichten")
|
||||
@Data
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Builder
|
||||
public class Geschichte {
|
||||
|
||||
@Id
|
||||
@GeneratedValue(strategy = GenerationType.UUID)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private UUID id;
|
||||
|
||||
@Column(nullable = false)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private String title;
|
||||
|
||||
@Column(columnDefinition = "TEXT")
|
||||
private String body;
|
||||
|
||||
@Enumerated(EnumType.STRING)
|
||||
@Column(nullable = false)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
@Builder.Default
|
||||
private GeschichteStatus status = GeschichteStatus.DRAFT;
|
||||
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "author_id")
|
||||
private AppUser author;
|
||||
|
||||
@ManyToMany(fetch = FetchType.EAGER)
|
||||
@JoinTable(name = "geschichten_persons",
|
||||
joinColumns = @JoinColumn(name = "geschichte_id"),
|
||||
inverseJoinColumns = @JoinColumn(name = "person_id"))
|
||||
@Builder.Default
|
||||
private Set<Person> persons = new HashSet<>();
|
||||
|
||||
@ManyToMany(fetch = FetchType.EAGER)
|
||||
@JoinTable(name = "geschichten_documents",
|
||||
joinColumns = @JoinColumn(name = "geschichte_id"),
|
||||
inverseJoinColumns = @JoinColumn(name = "document_id"))
|
||||
@Builder.Default
|
||||
private Set<Document> documents = new HashSet<>();
|
||||
|
||||
@CreationTimestamp
|
||||
@Column(updatable = false)
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private LocalDateTime createdAt;
|
||||
|
||||
@UpdateTimestamp
|
||||
@Schema(requiredMode = Schema.RequiredMode.REQUIRED)
|
||||
private LocalDateTime updatedAt;
|
||||
|
||||
@Column(name = "published_at")
|
||||
private LocalDateTime publishedAt;
|
||||
}
|
||||
@@ -1,69 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteUpdateDTO;
|
||||
import org.raddatz.familienarchiv.geschichte.Geschichte;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteStatus;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.security.RequirePermission;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteService;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.DeleteMapping;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.PatchMapping;
|
||||
import org.springframework.web.bind.annotation.PathVariable;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
import org.springframework.web.bind.annotation.RequestBody;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
@RestController
|
||||
@RequestMapping("/api/geschichten")
|
||||
@RequiredArgsConstructor
|
||||
public class GeschichteController {
|
||||
|
||||
private final GeschichteService geschichteService;
|
||||
|
||||
@GetMapping
|
||||
public List<Geschichte> list(
|
||||
@RequestParam(required = false) GeschichteStatus status,
|
||||
@RequestParam(name = "personId", required = false) List<UUID> personIds,
|
||||
@RequestParam(required = false) UUID documentId,
|
||||
@RequestParam(required = false, defaultValue = "50") int limit) {
|
||||
return geschichteService.list(
|
||||
status,
|
||||
personIds == null ? List.of() : personIds,
|
||||
documentId,
|
||||
limit);
|
||||
}
|
||||
|
||||
@GetMapping("/{id}")
|
||||
public Geschichte getById(@PathVariable UUID id) {
|
||||
return geschichteService.getById(id);
|
||||
}
|
||||
|
||||
@PostMapping
|
||||
@RequirePermission(Permission.BLOG_WRITE)
|
||||
public ResponseEntity<Geschichte> create(@RequestBody GeschichteUpdateDTO dto) {
|
||||
Geschichte created = geschichteService.create(dto);
|
||||
return ResponseEntity.status(HttpStatus.CREATED).body(created);
|
||||
}
|
||||
|
||||
@PatchMapping("/{id}")
|
||||
@RequirePermission(Permission.BLOG_WRITE)
|
||||
public Geschichte update(@PathVariable UUID id, @RequestBody GeschichteUpdateDTO dto) {
|
||||
return geschichteService.update(id, dto);
|
||||
}
|
||||
|
||||
@DeleteMapping("/{id}")
|
||||
@RequirePermission(Permission.BLOG_WRITE)
|
||||
public ResponseEntity<Void> delete(@PathVariable UUID id) {
|
||||
geschichteService.delete(id);
|
||||
return ResponseEntity.noContent().build();
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import org.raddatz.familienarchiv.geschichte.Geschichte;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
|
||||
import org.springframework.stereotype.Repository;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@Repository
|
||||
public interface GeschichteRepository extends JpaRepository<Geschichte, UUID>, JpaSpecificationExecutor<Geschichte> {
|
||||
}
|
||||
@@ -1,196 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.owasp.html.HtmlPolicyBuilder;
|
||||
import org.owasp.html.PolicyFactory;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteUpdateDTO;
|
||||
import org.raddatz.familienarchiv.exception.DomainException;
|
||||
import org.raddatz.familienarchiv.exception.ErrorCode;
|
||||
import org.raddatz.familienarchiv.user.AppUser;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.geschichte.Geschichte;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteStatus;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteRepository;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteSpecifications;
|
||||
import org.raddatz.familienarchiv.security.Permission;
|
||||
import org.raddatz.familienarchiv.document.DocumentService;
|
||||
import org.raddatz.familienarchiv.person.PersonService;
|
||||
import org.raddatz.familienarchiv.user.UserService;
|
||||
import org.springframework.data.domain.Sort;
|
||||
import org.springframework.data.jpa.domain.Specification;
|
||||
import org.springframework.security.core.Authentication;
|
||||
import org.springframework.security.core.context.SecurityContextHolder;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.transaction.annotation.Transactional;
|
||||
|
||||
import java.time.LocalDateTime;
|
||||
import java.util.HashSet;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.UUID;
|
||||
|
||||
@Service
|
||||
@RequiredArgsConstructor
|
||||
@Slf4j
|
||||
public class GeschichteService {
|
||||
|
||||
private final GeschichteRepository geschichteRepository;
|
||||
private final PersonService personService;
|
||||
private final DocumentService documentService;
|
||||
private final UserService userService;
|
||||
|
||||
/**
|
||||
* Allow-list policy for Geschichte body HTML. Tiptap on the writer side
|
||||
* already constrains the marks/nodes, but the backend re-sanitises every
|
||||
* save so that an attacker calling the API directly cannot inject more.
|
||||
*/
|
||||
private static final PolicyFactory BODY_SANITIZER = new HtmlPolicyBuilder()
|
||||
.allowElements("p", "br", "strong", "em", "h2", "h3", "ul", "ol", "li")
|
||||
.toFactory();
|
||||
|
||||
private static final int DEFAULT_LIMIT = 50;
|
||||
private static final int MAX_LIMIT = 200;
|
||||
|
||||
// ─── Read API ────────────────────────────────────────────────────────────
|
||||
|
||||
public Geschichte getById(UUID id) {
|
||||
Geschichte g = geschichteRepository.findById(id)
|
||||
.orElseThrow(() -> DomainException.notFound(
|
||||
ErrorCode.GESCHICHTE_NOT_FOUND, "Geschichte not found: " + id));
|
||||
if (g.getStatus() == GeschichteStatus.DRAFT && !currentUserHasBlogWrite()) {
|
||||
// Use NOT_FOUND, not FORBIDDEN — don't leak DRAFT existence.
|
||||
throw DomainException.notFound(
|
||||
ErrorCode.GESCHICHTE_NOT_FOUND, "Geschichte not found: " + id);
|
||||
}
|
||||
return g;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists Geschichten with optional filters. {@code personIds} uses AND semantics: the story
|
||||
* must be associated with every person id supplied. An empty or null list applies no
|
||||
* person filter. Result is ordered by {@code COALESCE(publishedAt, updatedAt) DESC}.
|
||||
*/
|
||||
public List<Geschichte> list(GeschichteStatus status, List<UUID> personIds, UUID documentId, int limit) {
|
||||
GeschichteStatus effective = currentUserHasBlogWrite() ? status : GeschichteStatus.PUBLISHED;
|
||||
int safeLimit = limit <= 0 ? DEFAULT_LIMIT : Math.min(limit, MAX_LIMIT);
|
||||
|
||||
Specification<Geschichte> spec = Specification.allOf(
|
||||
GeschichteSpecifications.hasStatus(effective),
|
||||
GeschichteSpecifications.hasAllPersons(personIds),
|
||||
GeschichteSpecifications.hasDocument(documentId),
|
||||
GeschichteSpecifications.orderByDisplayDateDesc()
|
||||
);
|
||||
return geschichteRepository.findAll(spec, Sort.unsorted())
|
||||
.stream()
|
||||
.limit(safeLimit)
|
||||
.toList();
|
||||
}
|
||||
|
||||
// ─── Write API ───────────────────────────────────────────────────────────
|
||||
|
||||
@Transactional
|
||||
public Geschichte create(GeschichteUpdateDTO dto) {
|
||||
requireTitle(dto.getTitle());
|
||||
Geschichte g = Geschichte.builder()
|
||||
.title(dto.getTitle().trim())
|
||||
.body(sanitize(dto.getBody()))
|
||||
.status(GeschichteStatus.DRAFT)
|
||||
.author(currentUser())
|
||||
.persons(resolvePersons(dto.getPersonIds()))
|
||||
.documents(resolveDocuments(dto.getDocumentIds()))
|
||||
.build();
|
||||
if (dto.getStatus() == GeschichteStatus.PUBLISHED) {
|
||||
g.setStatus(GeschichteStatus.PUBLISHED);
|
||||
g.setPublishedAt(LocalDateTime.now());
|
||||
}
|
||||
return geschichteRepository.save(g);
|
||||
}
|
||||
|
||||
@Transactional
|
||||
public Geschichte update(UUID id, GeschichteUpdateDTO dto) {
|
||||
Geschichte g = geschichteRepository.findById(id)
|
||||
.orElseThrow(() -> DomainException.notFound(
|
||||
ErrorCode.GESCHICHTE_NOT_FOUND, "Geschichte not found: " + id));
|
||||
if (dto.getTitle() != null) {
|
||||
requireTitle(dto.getTitle());
|
||||
g.setTitle(dto.getTitle().trim());
|
||||
}
|
||||
if (dto.getBody() != null) {
|
||||
g.setBody(sanitize(dto.getBody()));
|
||||
}
|
||||
if (dto.getPersonIds() != null) {
|
||||
g.setPersons(resolvePersons(dto.getPersonIds()));
|
||||
}
|
||||
if (dto.getDocumentIds() != null) {
|
||||
g.setDocuments(resolveDocuments(dto.getDocumentIds()));
|
||||
}
|
||||
if (dto.getStatus() != null && dto.getStatus() != g.getStatus()) {
|
||||
applyStatusTransition(g, dto.getStatus());
|
||||
}
|
||||
return geschichteRepository.save(g);
|
||||
}
|
||||
|
||||
@Transactional
|
||||
public void delete(UUID id) {
|
||||
if (!geschichteRepository.existsById(id)) {
|
||||
throw DomainException.notFound(
|
||||
ErrorCode.GESCHICHTE_NOT_FOUND, "Geschichte not found: " + id);
|
||||
}
|
||||
geschichteRepository.deleteById(id);
|
||||
}
|
||||
|
||||
// ─── private helpers ─────────────────────────────────────────────────────
|
||||
|
||||
private void applyStatusTransition(Geschichte g, GeschichteStatus next) {
|
||||
g.setStatus(next);
|
||||
if (next == GeschichteStatus.PUBLISHED) {
|
||||
g.setPublishedAt(LocalDateTime.now());
|
||||
} else {
|
||||
g.setPublishedAt(null);
|
||||
}
|
||||
}
|
||||
|
||||
private void requireTitle(String title) {
|
||||
if (title == null || title.trim().isEmpty()) {
|
||||
throw DomainException.badRequest(
|
||||
ErrorCode.VALIDATION_ERROR, "Title is required");
|
||||
}
|
||||
}
|
||||
|
||||
private String sanitize(String body) {
|
||||
if (body == null) return null;
|
||||
return BODY_SANITIZER.sanitize(body);
|
||||
}
|
||||
|
||||
private Set<Person> resolvePersons(List<UUID> ids) {
|
||||
if (ids == null || ids.isEmpty()) return new HashSet<>();
|
||||
return new LinkedHashSet<>(personService.getAllById(ids));
|
||||
}
|
||||
|
||||
private Set<Document> resolveDocuments(List<UUID> ids) {
|
||||
if (ids == null || ids.isEmpty()) return new HashSet<>();
|
||||
Set<Document> out = new LinkedHashSet<>();
|
||||
for (UUID id : ids) {
|
||||
out.add(documentService.getDocumentById(id));
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
private AppUser currentUser() {
|
||||
Authentication auth = SecurityContextHolder.getContext().getAuthentication();
|
||||
if (auth == null || !auth.isAuthenticated()) {
|
||||
throw DomainException.unauthorized("Authentication required");
|
||||
}
|
||||
return userService.findByEmail(auth.getName());
|
||||
}
|
||||
|
||||
private boolean currentUserHasBlogWrite() {
|
||||
Authentication auth = SecurityContextHolder.getContext().getAuthentication();
|
||||
if (auth == null || !auth.isAuthenticated()) return false;
|
||||
return auth.getAuthorities().stream()
|
||||
.anyMatch(a -> Permission.BLOG_WRITE.name().equals(a.getAuthority()));
|
||||
}
|
||||
}
|
||||
@@ -1,91 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import jakarta.persistence.criteria.CriteriaBuilder;
|
||||
import jakarta.persistence.criteria.CriteriaQuery;
|
||||
import jakarta.persistence.criteria.Join;
|
||||
import jakarta.persistence.criteria.Predicate;
|
||||
import jakarta.persistence.criteria.Root;
|
||||
import jakarta.persistence.criteria.Subquery;
|
||||
import org.raddatz.familienarchiv.document.Document;
|
||||
import org.raddatz.familienarchiv.geschichte.Geschichte;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteStatus;
|
||||
import org.raddatz.familienarchiv.person.Person;
|
||||
import org.springframework.data.jpa.domain.Specification;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
public final class GeschichteSpecifications {
|
||||
|
||||
private GeschichteSpecifications() {}
|
||||
|
||||
public static Specification<Geschichte> hasStatus(GeschichteStatus status) {
|
||||
return (root, query, cb) -> status == null ? null : cb.equal(root.get("status"), status);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds {@code ORDER BY COALESCE(publishedAt, updatedAt) DESC} to the query without contributing
|
||||
* a predicate. Combined into the spec chain via {@code .and(...)}; the {@code conjunction}
|
||||
* acts as a no-op WHERE clause.
|
||||
*/
|
||||
public static Specification<Geschichte> orderByDisplayDateDesc() {
|
||||
return (root, query, cb) -> {
|
||||
// Skip ordering on count queries — JPA forbids orderBy on COUNT projections.
|
||||
if (query != null
|
||||
&& Long.class != query.getResultType()
|
||||
&& long.class != query.getResultType()) {
|
||||
query.orderBy(cb.desc(cb.coalesce(root.get("publishedAt"), root.get("updatedAt"))));
|
||||
}
|
||||
return cb.conjunction();
|
||||
};
|
||||
}
|
||||
|
||||
public static Specification<Geschichte> hasDocument(UUID documentId) {
|
||||
return (root, query, cb) -> {
|
||||
if (documentId == null) return null;
|
||||
return cb.exists(documentSubquery(root, query, cb, documentId));
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* AND-filter across persons: the Geschichte must be associated with EVERY id in {@code personIds}.
|
||||
*
|
||||
* <p>Implemented as one EXISTS subquery per id (canonical Criteria-API idiom for AND across a
|
||||
* many-to-many join). Mirrors {@link DocumentSpecifications#hasTags} which uses the same shape.
|
||||
* Empty / null input returns {@code null} (i.e. no constraint added).
|
||||
*/
|
||||
public static Specification<Geschichte> hasAllPersons(Collection<UUID> personIds) {
|
||||
return (root, query, cb) -> {
|
||||
if (personIds == null || personIds.isEmpty()) return null;
|
||||
List<Predicate> predicates = new ArrayList<>(personIds.size());
|
||||
for (UUID id : personIds) {
|
||||
predicates.add(cb.exists(personSubquery(root, query, cb, id)));
|
||||
}
|
||||
return cb.and(predicates.toArray(new Predicate[0]));
|
||||
};
|
||||
}
|
||||
|
||||
private static Subquery<UUID> personSubquery(
|
||||
Root<Geschichte> root, CriteriaQuery<?> query, CriteriaBuilder cb, UUID personId) {
|
||||
Subquery<UUID> sub = query.subquery(UUID.class);
|
||||
Root<Geschichte> subRoot = sub.from(Geschichte.class);
|
||||
Join<Geschichte, Person> persons = subRoot.join("persons");
|
||||
sub.select(subRoot.get("id"))
|
||||
.where(cb.equal(subRoot.get("id"), root.get("id")),
|
||||
cb.equal(persons.get("id"), personId));
|
||||
return sub;
|
||||
}
|
||||
|
||||
private static Subquery<UUID> documentSubquery(
|
||||
Root<Geschichte> root, CriteriaQuery<?> query, CriteriaBuilder cb, UUID documentId) {
|
||||
Subquery<UUID> sub = query.subquery(UUID.class);
|
||||
Root<Geschichte> subRoot = sub.from(Geschichte.class);
|
||||
Join<Geschichte, Document> documents = subRoot.join("documents");
|
||||
sub.select(subRoot.get("id"))
|
||||
.where(cb.equal(subRoot.get("id"), root.get("id")),
|
||||
cb.equal(documents.get("id"), documentId));
|
||||
return sub;
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
public enum GeschichteStatus {
|
||||
DRAFT,
|
||||
PUBLISHED
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
package org.raddatz.familienarchiv.geschichte;
|
||||
|
||||
import lombok.Data;
|
||||
import org.raddatz.familienarchiv.geschichte.GeschichteStatus;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* Used for both create and update of a Geschichte. All fields are optional;
|
||||
* the service applies whatever is non-null. {@code body} is rich-text HTML and
|
||||
* is sanitised against an allow-list before persistence.
|
||||
*/
|
||||
@Data
|
||||
public class GeschichteUpdateDTO {
|
||||
private String title;
|
||||
private String body;
|
||||
private GeschichteStatus status;
|
||||
private List<UUID> personIds;
|
||||
private List<UUID> documentIds;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user