1 Commits

Author SHA1 Message Date
0b49ac4b48 kjdskjk 2026-05-09 20:40:27 +02:00
119 changed files with 488 additions and 14866 deletions

View File

@@ -1,440 +0,0 @@
---
name: accessibility
description: Audit and improve web accessibility following WCAG 2.2 guidelines. Use when asked to "improve accessibility", "a11y audit", "WCAG compliance", "screen reader support", "keyboard navigation", or "make accessible".
license: MIT
metadata:
author: web-quality-skills
version: "1.1"
---
# Accessibility (a11y)
Comprehensive accessibility guidelines based on WCAG 2.2 and Lighthouse accessibility audits. Goal: make content usable by everyone, including people with disabilities.
## WCAG Principles: POUR
| Principle | Description |
|-----------|-------------|
| **P**erceivable | Content can be perceived through different senses |
| **O**perable | Interface can be operated by all users |
| **U**nderstandable | Content and interface are understandable |
| **R**obust | Content works with assistive technologies |
## Conformance levels
| Level | Requirement | Target |
|-------|-------------|--------|
| **A** | Minimum accessibility | Must pass |
| **AA** | Standard compliance | Should pass (legal requirement in many jurisdictions) |
| **AAA** | Enhanced accessibility | Nice to have |
---
## Perceivable
### Text alternatives (1.1)
**Images require alt text:**
```html
<!-- ❌ Missing alt -->
<img src="chart.png">
<!-- ✅ Descriptive alt -->
<img src="chart.png" alt="Bar chart showing 40% increase in Q3 sales">
<!-- ✅ Decorative image (empty alt) -->
<img src="decorative-border.png" alt="" role="presentation">
<!-- ✅ Complex image with longer description -->
<figure>
<img src="infographic.png" alt="2024 market trends infographic"
aria-describedby="infographic-desc">
<figcaption id="infographic-desc">
<!-- Detailed description -->
</figcaption>
</figure>
```
**Icon buttons need accessible names:**
```html
<!-- ❌ No accessible name -->
<button><svg><!-- menu icon --></svg></button>
<!-- ✅ Using aria-label -->
<button aria-label="Open menu">
<svg aria-hidden="true"><!-- menu icon --></svg>
</button>
<!-- ✅ Using visually hidden text -->
<button>
<svg aria-hidden="true"><!-- menu icon --></svg>
<span class="visually-hidden">Open menu</span>
</button>
```
**Visually hidden class:**
```css
.visually-hidden {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border: 0;
}
```
### Color contrast (1.4.3, 1.4.6)
| Text Size | AA minimum | AAA enhanced |
|-----------|------------|--------------|
| Normal text (< 18px / < 14px bold) | 4.5:1 | 7:1 |
| Large text (≥ 18px / ≥ 14px bold) | 3:1 | 4.5:1 |
| UI components & graphics | 3:1 | 3:1 |
```css
/* ❌ Low contrast (2.5:1) */
.low-contrast {
color: #999;
background: #fff;
}
/* ✅ Sufficient contrast (7:1) */
.high-contrast {
color: #333;
background: #fff;
}
/* ✅ Focus states need contrast too */
:focus-visible {
outline: 2px solid #005fcc;
outline-offset: 2px;
}
```
**Don't rely on color alone:**
```html
<!-- ❌ Only color indicates error -->
<input class="error-border">
<style>.error-border { border-color: red; }</style>
<!-- ✅ Color + icon + text -->
<div class="field-error">
<input aria-invalid="true" aria-describedby="email-error">
<span id="email-error" class="error-message">
<svg aria-hidden="true"><!-- error icon --></svg>
Please enter a valid email address
</span>
</div>
```
### Media alternatives (1.2)
```html
<!-- Video with captions -->
<video controls>
<source src="video.mp4" type="video/mp4">
<track kind="captions" src="captions.vtt" srclang="en" label="English" default>
<track kind="descriptions" src="descriptions.vtt" srclang="en" label="Descriptions">
</video>
<!-- Audio with transcript -->
<audio controls>
<source src="podcast.mp3" type="audio/mp3">
</audio>
<details>
<summary>Transcript</summary>
<p>Full transcript text...</p>
</details>
```
---
## Operable
### Keyboard accessible (2.1)
**All functionality must be keyboard accessible:**
```javascript
// ❌ Only handles click
element.addEventListener('click', handleAction);
// ✅ Handles both click and keyboard
element.addEventListener('click', handleAction);
element.addEventListener('keydown', (e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault();
handleAction();
}
});
```
**No keyboard traps.** Users must be able to Tab into and out of every component. Use the [modal focus trap pattern](references/A11Y-PATTERNS.md#modal-focus-trap) for dialogs—the native `<dialog>` element handles this automatically.
### Focus visible (2.4.7)
```css
/* ❌ Never remove focus outlines */
*:focus { outline: none; }
/* ✅ Use :focus-visible for keyboard-only focus */
:focus {
outline: none;
}
:focus-visible {
outline: 2px solid #005fcc;
outline-offset: 2px;
}
/* ✅ Or custom focus styles */
button:focus-visible {
box-shadow: 0 0 0 3px rgba(0, 95, 204, 0.5);
}
```
### Focus not obscured (2.4.11) — new in 2.2
When an element receives keyboard focus, it must not be entirely hidden by other author-created content such as sticky headers, footers, or overlapping panels. At Level AAA (2.4.12), no part of the focused element may be hidden.
```css
/* ✅ Account for sticky headers when scrolling to focused elements */
:target {
scroll-margin-top: 80px;
}
/* ✅ Ensure focused items clear fixed/sticky bars */
:focus {
scroll-margin-top: 80px;
scroll-margin-bottom: 60px;
}
```
### Skip links (2.4.1)
Provide a skip link so keyboard users can bypass repetitive navigation. See the [skip link pattern](references/A11Y-PATTERNS.md#skip-link) for full markup and styles.
### Target size (2.5.8) — new in 2.2
Interactive targets must be at least **24 × 24 CSS pixels** (AA). Exceptions: inline text links, elements where the browser controls the size, and targets where a 24px circle centered on the bounding box does not overlap another target.
```css
/* ✅ Minimum target size */
button,
[role="button"],
input[type="checkbox"] + label,
input[type="radio"] + label {
min-width: 24px;
min-height: 24px;
}
/* ✅ Comfortable target size (recommended 44×44) */
.touch-target {
min-width: 44px;
min-height: 44px;
display: inline-flex;
align-items: center;
justify-content: center;
}
```
### Dragging movements (2.5.7) — new in 2.2
Any action that requires dragging must have a single-pointer alternative (e.g., buttons, inputs). See the [dragging movements pattern](references/A11Y-PATTERNS.md#dragging-movements) for a sortable-list example.
### Timing (2.2)
```javascript
// Allow users to extend time limits
function showSessionWarning() {
const modal = createModal({
title: 'Session Expiring',
content: 'Your session will expire in 2 minutes.',
actions: [
{ label: 'Extend session', action: extendSession },
{ label: 'Log out', action: logout }
],
timeout: 120000
});
}
```
### Motion (2.3)
```css
/* Respect reduced motion preference */
@media (prefers-reduced-motion: reduce) {
*,
*::before,
*::after {
animation-duration: 0.01ms !important;
animation-iteration-count: 1 !important;
transition-duration: 0.01ms !important;
scroll-behavior: auto !important;
}
}
```
---
## Understandable
### Page language (3.1.1)
```html
<!-- ❌ No language specified -->
<html>
<!-- ✅ Language specified -->
<html lang="en">
<!-- ✅ Language changes within page -->
<p>The French word for hello is <span lang="fr">bonjour</span>.</p>
```
### Consistent navigation (3.2.3)
```html
<!-- Navigation should be consistent across pages -->
<nav aria-label="Main">
<ul>
<li><a href="/" aria-current="page">Home</a></li>
<li><a href="/products">Products</a></li>
<li><a href="/about">About</a></li>
</ul>
</nav>
```
### Consistent help (3.2.6) — new in 2.2
If a help mechanism (contact info, chat widget, FAQ link, self-help option) is repeated across multiple pages, it must appear in the **same relative order** each time. Users who rely on consistent placement shouldn't have to hunt for help on every page.
### Form labels (3.3.2)
Every input needs a programmatically associated label. See the [form labels pattern](references/A11Y-PATTERNS.md#form-labels) for explicit, implicit, and instructional examples.
### Error handling (3.3.1, 3.3.3)
Announce errors to screen readers with `role="alert"` or `aria-live`, set `aria-invalid="true"` on invalid fields, and focus the first error on submit. See the [error handling pattern](references/A11Y-PATTERNS.md#error-handling) for full markup and JS.
### Redundant entry (3.3.7) — new in 2.2
Don't force users to re-enter information they already provided in the same session. Auto-populate from earlier steps, or let users select from previously entered values. Exceptions: security re-confirmation and content that has expired.
```html
<!-- ✅ Auto-fill shipping address from billing -->
<fieldset>
<legend>Shipping address</legend>
<label>
<input type="checkbox" id="same-as-billing" checked>
Same as billing address
</label>
<!-- Fields auto-populated when checked -->
</fieldset>
```
### Accessible authentication (3.3.8) — new in 2.2
Login flows must not rely on cognitive function tests (e.g., remembering a password, solving a puzzle) unless at least one of:
- A copy-paste or autofill mechanism is available
- An alternative method exists (e.g., passkey, SSO, email link)
- The test uses object recognition or personal content (AA only; AAA removes this exception)
```html
<!-- ✅ Allow paste in password fields -->
<input type="password" id="password" autocomplete="current-password">
<!-- ✅ Offer passwordless alternatives -->
<button type="button">Sign in with passkey</button>
<button type="button">Email me a login link</button>
```
---
## Robust
### ARIA usage (4.1.2)
**Prefer native elements:**
```html
<!-- ❌ ARIA role on div -->
<div role="button" tabindex="0">Click me</div>
<!-- ✅ Native button -->
<button>Click me</button>
<!-- ❌ ARIA checkbox -->
<div role="checkbox" aria-checked="false">Option</div>
<!-- ✅ Native checkbox -->
<label><input type="checkbox"> Option</label>
```
**When ARIA is needed,** use the correct roles and states. See the [ARIA tabs pattern](references/A11Y-PATTERNS.md#aria-tabs) for a complete tablist example.
### Live regions (4.1.3)
Use `aria-live` regions to announce dynamic content changes without moving focus. See the [live regions pattern](references/A11Y-PATTERNS.md#live-regions-and-notifications) for markup and a `showNotification()` helper.
---
## Testing checklist
### Automated testing
```bash
# Lighthouse accessibility audit
npx lighthouse https://example.com --only-categories=accessibility
# axe-core
npm install @axe-core/cli -g
axe https://example.com
```
### Manual testing
- [ ] **Keyboard navigation:** Tab through entire page, use Enter/Space to activate
- [ ] **Screen reader:** Test with VoiceOver (Mac), NVDA (Windows), or TalkBack (Android)
- [ ] **Zoom:** Content usable at 200% zoom
- [ ] **High contrast:** Test with Windows High Contrast Mode
- [ ] **Reduced motion:** Test with `prefers-reduced-motion: reduce`
- [ ] **Focus order:** Logical and follows visual order
- [ ] **Target size:** Interactive elements meet 24×24px minimum
See the [screen reader commands reference](references/A11Y-PATTERNS.md#screen-reader-commands) for VoiceOver and NVDA shortcuts.
---
## Common issues by impact
### Critical (fix immediately)
1. Missing form labels
2. Missing image alt text
3. Insufficient color contrast
4. Keyboard traps
5. No focus indicators
### Serious (fix before launch)
1. Missing page language
2. Missing heading structure
3. Non-descriptive link text
4. Auto-playing media
5. Missing skip links
### Moderate (fix soon)
1. Missing ARIA labels on icons
2. Inconsistent navigation
3. Missing error identification
4. Timing without controls
5. Missing landmark regions
## References
- [WCAG 2.2 Quick Reference](https://www.w3.org/WAI/WCAG22/quickref/)
- [WAI-ARIA Authoring Practices](https://www.w3.org/WAI/ARIA/apg/)
- [Deque axe Rules](https://dequeuniversity.com/rules/axe/)
- [Web Quality Audit](../web-quality-audit/SKILL.md)
- [WCAG criteria reference](references/WCAG.md)
- [Accessibility code patterns](references/A11Y-PATTERNS.md)

View File

@@ -1,233 +0,0 @@
# Accessibility Code Patterns
Practical, copy-paste-ready patterns for common accessibility requirements. Each pattern is self-contained and linked from the main [SKILL.md](../SKILL.md).
---
## Modal focus trap
Trap keyboard focus inside a modal dialog so Tab/Shift+Tab cycle through its focusable elements and Escape closes it.
```javascript
function openModal(modal) {
const focusableElements = modal.querySelectorAll(
'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])'
);
const firstElement = focusableElements[0];
const lastElement = focusableElements[focusableElements.length - 1];
modal.addEventListener('keydown', (e) => {
if (e.key === 'Tab') {
if (e.shiftKey && document.activeElement === firstElement) {
e.preventDefault();
lastElement.focus();
} else if (!e.shiftKey && document.activeElement === lastElement) {
e.preventDefault();
firstElement.focus();
}
}
if (e.key === 'Escape') {
closeModal();
}
});
firstElement.focus();
}
```
The native `<dialog>` element handles focus trapping automatically—prefer it when browser support allows.
---
## Skip link
Allows keyboard users to bypass repetitive navigation and jump straight to main content.
```html
<body>
<a href="#main-content" class="skip-link">Skip to main content</a>
<header><!-- navigation --></header>
<main id="main-content" tabindex="-1">
<!-- main content -->
</main>
</body>
```
```css
.skip-link {
position: absolute;
top: -40px;
left: 0;
background: #000;
color: #fff;
padding: 8px 16px;
z-index: 100;
}
.skip-link:focus {
top: 0;
}
```
---
## Error handling
Announce errors to screen readers and focus the first invalid field on submit.
```html
<form novalidate>
<div class="field" aria-live="polite">
<label for="email">Email</label>
<input type="email" id="email"
aria-invalid="true"
aria-describedby="email-error">
<p id="email-error" class="error" role="alert">
Please enter a valid email address (e.g., name@example.com)
</p>
</div>
</form>
```
```javascript
form.addEventListener('submit', (e) => {
const firstError = form.querySelector('[aria-invalid="true"]');
if (firstError) {
e.preventDefault();
firstError.focus();
const errorSummary = document.getElementById('error-summary');
errorSummary.textContent =
`${errors.length} errors found. Please fix them and try again.`;
errorSummary.focus();
}
});
```
---
## Form labels
Every input needs an associated label—either explicit (`for`/`id`) or implicit (wrapping `<label>`).
```html
<!-- ❌ No label association -->
<input type="email" placeholder="Email">
<!-- ✅ Explicit label -->
<label for="email">Email address</label>
<input type="email" id="email" name="email"
autocomplete="email" required>
<!-- ✅ Implicit label -->
<label>
Email address
<input type="email" name="email" autocomplete="email" required>
</label>
<!-- ✅ With instructions -->
<label for="password">Password</label>
<input type="password" id="password"
aria-describedby="password-requirements">
<p id="password-requirements">
Must be at least 8 characters with one number.
</p>
```
---
## Dragging movements
Any action triggered by dragging must offer a single-pointer alternative (WCAG 2.5.7).
```html
<!-- ❌ Drag-only reorder -->
<ul class="sortable-list" draggable="true">
<li>Item 1</li>
<li>Item 2</li>
</ul>
<!-- ✅ Drag + button alternatives -->
<ul class="sortable-list">
<li>
<span>Item 1</span>
<button aria-label="Move Item 1 up">↑</button>
<button aria-label="Move Item 1 down">↓</button>
</li>
<li>
<span>Item 2</span>
<button aria-label="Move Item 2 up">↑</button>
<button aria-label="Move Item 2 down">↓</button>
</li>
</ul>
```
Also applies to sliders, map panning, colour pickers, and similar drag-based widgets—always provide an equivalent click/tap or keyboard path.
---
## ARIA tabs
Tabs require `role="tablist"`, `role="tab"`, and `role="tabpanel"` with proper `aria-selected`, `aria-controls`, and keyboard support.
```html
<div role="tablist" aria-label="Product information">
<button role="tab" id="tab-1" aria-selected="true"
aria-controls="panel-1">Description</button>
<button role="tab" id="tab-2" aria-selected="false"
aria-controls="panel-2" tabindex="-1">Reviews</button>
</div>
<div role="tabpanel" id="panel-1" aria-labelledby="tab-1">
<!-- Panel content -->
</div>
<div role="tabpanel" id="panel-2" aria-labelledby="tab-2" hidden>
<!-- Panel content -->
</div>
```
Arrow keys should move focus between tabs; the active tab receives `tabindex="0"` while inactive tabs use `tabindex="-1"`.
---
## Live regions and notifications
Use `aria-live` to announce dynamic content changes to screen readers without moving focus.
```html
<!-- Status updates (polite — waits for pause in speech) -->
<div aria-live="polite" aria-atomic="true" class="status">
<!-- Content updates announced to screen readers -->
</div>
<!-- Urgent alerts (assertive — interrupts) -->
<div role="alert" aria-live="assertive">
<!-- Interrupts current announcement -->
</div>
```
```javascript
function showNotification(message, type = 'polite') {
const container = document.getElementById(`${type}-announcer`);
container.textContent = '';
requestAnimationFrame(() => {
container.textContent = message;
});
}
```
Clear the container before writing to ensure the same message triggers a new announcement.
---
## Screen reader commands
Quick reference for the most common screen reader shortcuts.
| Action | VoiceOver (Mac) | NVDA (Windows) |
|--------|-----------------|----------------|
| Start/Stop | ⌘ + F5 | Ctrl + Alt + N |
| Next item | VO + → | ↓ |
| Previous item | VO + ← | ↑ |
| Activate | VO + Space | Enter |
| Headings list | VO + U, then arrows | H / Shift + H |
| Links list | VO + U | K / Shift + K |

View File

@@ -1,191 +0,0 @@
# WCAG 2.2 Quick Reference
## Success criteria by level
### Level A (minimum)
| Criterion | Description |
|-----------|-------------|
| **1.1.1** Non-text Content | All images, icons have text alternatives |
| **1.2.1** Audio-only/Video-only | Provide transcript or audio description |
| **1.2.2** Captions | Video with audio has captions |
| **1.2.3** Audio Description | Video has audio description |
| **1.3.1** Info and Relationships | Information conveyed through presentation is available programmatically |
| **1.3.2** Meaningful Sequence | Reading order is logical |
| **1.3.3** Sensory Characteristics | Instructions don't rely solely on shape, color, size, location, orientation, or sound |
| **1.4.1** Use of Color | Color is not the only visual means of conveying information |
| **1.4.2** Audio Control | Audio playing automatically can be paused/stopped |
| **2.1.1** Keyboard | All functionality available via keyboard |
| **2.1.2** No Keyboard Trap | Keyboard focus can be moved away from any component |
| **2.1.4** Character Key Shortcuts | Single-key shortcuts can be turned off or remapped |
| **2.2.1** Timing Adjustable | Time limits can be extended |
| **2.2.2** Pause, Stop, Hide | Moving/blinking content can be paused |
| **2.3.1** Three Flashes | Nothing flashes more than 3 times per second |
| **2.4.1** Bypass Blocks | Skip link or landmark navigation available |
| **2.4.2** Page Titled | Pages have descriptive titles |
| **2.4.3** Focus Order | Focus order preserves meaning |
| **2.4.4** Link Purpose | Link purpose clear from link text or context |
| **2.5.1** Pointer Gestures | Multi-point gestures have single-pointer alternatives |
| **2.5.2** Pointer Cancellation | Down-event doesn't trigger action (use up-event or click) |
| **2.5.3** Label in Name | Accessible name contains visible label text |
| **2.5.4** Motion Actuation | Motion-triggered functions have alternatives |
| **3.1.1** Language of Page | Default language specified in HTML |
| **3.2.1** On Focus | Focus doesn't trigger unexpected changes |
| **3.2.2** On Input | Input doesn't trigger unexpected changes |
| **3.2.6** Consistent Help | Help mechanisms appear in the same relative order across pages |
| **3.3.1** Error Identification | Input errors clearly described |
| **3.3.2** Labels or Instructions | Form inputs have labels or instructions |
| **3.3.7** Redundant Entry | Information previously entered is auto-populated or available to select |
| **4.1.2** Name, Role, Value | UI components have accessible names and correct roles |
### Level AA (standard)
| Criterion | Description |
|-----------|-------------|
| **1.2.4** Captions (Live) | Live audio has captions |
| **1.2.5** Audio Description | Pre-recorded video has audio description |
| **1.3.4** Orientation | Content doesn't restrict orientation |
| **1.3.5** Identify Input Purpose | Input purpose can be programmatically determined |
| **1.4.3** Contrast (Minimum) | 4.5:1 for normal text, 3:1 for large text |
| **1.4.4** Resize Text | Text can be resized to 200% without loss of functionality |
| **1.4.5** Images of Text | Text used instead of images of text |
| **1.4.10** Reflow | Content reflows at 320px width without horizontal scroll |
| **1.4.11** Non-text Contrast | UI components have 3:1 contrast |
| **1.4.12** Text Spacing | Content adapts to text spacing changes |
| **1.4.13** Content on Hover/Focus | Additional content is dismissible, hoverable, persistent |
| **2.4.5** Multiple Ways | Multiple ways to find pages |
| **2.4.6** Headings and Labels | Headings and labels are descriptive |
| **2.4.7** Focus Visible | Focus indicator is visible |
| **2.4.11** Focus Not Obscured (Minimum) | Focused element is not entirely hidden by author-created content |
| **2.5.7** Dragging Movements | Dragging actions have single-pointer alternatives |
| **2.5.8** Target Size (Minimum) | Interactive targets are at least 24×24 CSS pixels (with exceptions) |
| **3.1.2** Language of Parts | Language changes are marked |
| **3.2.3** Consistent Navigation | Navigation is consistent across pages |
| **3.2.4** Consistent Identification | Same functionality uses same labels |
| **3.3.3** Error Suggestion | Error corrections suggested when known |
| **3.3.4** Error Prevention (Legal) | Actions can be reversed or confirmed |
| **3.3.8** Accessible Authentication (Minimum) | No cognitive function test for login unless an alternative or assistance is provided |
| **4.1.3** Status Messages | Status messages announced to screen readers |
### Level AAA (enhanced)
| Criterion | Description |
|-----------|-------------|
| **1.4.6** Contrast (Enhanced) | 7:1 for normal text, 4.5:1 for large text |
| **1.4.8** Visual Presentation | Foreground/background colors can be selected |
| **1.4.9** Images of Text (No Exception) | No images of text |
| **2.1.3** Keyboard (No Exception) | All functionality keyboard accessible |
| **2.2.3** No Timing | No time limits |
| **2.2.4** Interruptions | Interruptions can be postponed |
| **2.2.5** Re-authenticating | Data preserved on re-authentication |
| **2.2.6** Timeouts | Users warned about data loss from inactivity |
| **2.3.2** Three Flashes | No content flashes more than 3 times |
| **2.3.3** Animation from Interactions | Motion animation can be disabled |
| **2.4.8** Location | User location within site is available |
| **2.4.9** Link Purpose (Link Only) | Link purpose clear from link text alone |
| **2.4.10** Section Headings | Sections have headings |
| **2.4.12** Focus Not Obscured (Enhanced) | No part of the focused element is hidden by author-created content |
| **2.4.13** Focus Appearance | Focus indicator has sufficient area, contrast, and is not obscured |
| **3.1.3** Unusual Words | Definitions available for unusual words |
| **3.1.4** Abbreviations | Abbreviations expanded |
| **3.1.5** Reading Level | Alternative content for complex text |
| **3.1.6** Pronunciation | Pronunciation available where needed |
| **3.2.5** Change on Request | Changes initiated only by user |
| **3.3.5** Help | Context-sensitive help available |
| **3.3.6** Error Prevention (All) | All form submissions can be reviewed |
| **3.3.9** Accessible Authentication (Enhanced) | No cognitive function test for login (no object or personal content recognition exceptions) |
## Common ARIA patterns
### Buttons
```html
<button>Label</button>
<!-- or -->
<button aria-label="Close dialog">×</button>
```
### Links
```html
<a href="/page">Descriptive link text</a>
<!-- External links -->
<a href="https://external.com" target="_blank" rel="noopener">
External site
<span class="visually-hidden">(opens in new tab)</span>
</a>
```
### Form fields
```html
<label for="email">Email address</label>
<input type="email" id="email" aria-describedby="email-hint">
<p id="email-hint">We'll never share your email.</p>
```
### Error states
```html
<label for="email">Email</label>
<input type="email" id="email" aria-invalid="true" aria-describedby="email-error">
<p id="email-error" role="alert">Please enter a valid email address.</p>
```
### Navigation
```html
<nav aria-label="Main">
<ul>
<li><a href="/" aria-current="page">Home</a></li>
<li><a href="/about">About</a></li>
</ul>
</nav>
```
### Modals
```html
<div role="dialog" aria-modal="true" aria-labelledby="dialog-title">
<h2 id="dialog-title">Confirm Action</h2>
<!-- content -->
</div>
```
### Live regions
```html
<!-- Polite (waits for pause in speech) -->
<div aria-live="polite">Status update here</div>
<!-- Assertive (interrupts immediately) -->
<div aria-live="assertive" role="alert">Error message here</div>
<!-- Status (polite, implicit) -->
<div role="status">Loading complete</div>
```
## What changed from 2.1 to 2.2
| Change | Criterion | Level |
|--------|-----------|-------|
| **Removed** | 4.1.1 Parsing | A |
| **Added** | 2.4.11 Focus Not Obscured (Minimum) | AA |
| **Added** | 2.4.12 Focus Not Obscured (Enhanced) | AAA |
| **Added** | 2.4.13 Focus Appearance | AAA |
| **Added** | 2.5.7 Dragging Movements | AA |
| **Added** | 2.5.8 Target Size (Minimum) | AA |
| **Added** | 3.2.6 Consistent Help | A |
| **Added** | 3.3.7 Redundant Entry | A |
| **Added** | 3.3.8 Accessible Authentication (Minimum) | AA |
| **Added** | 3.3.9 Accessible Authentication (Enhanced) | AAA |
## Testing tools
| Tool | Type | URL |
|------|------|-----|
| axe DevTools | Browser extension | [deque.com/axe](https://www.deque.com/axe/) |
| WAVE | Browser extension | [wave.webaim.org](https://wave.webaim.org/) |
| Lighthouse | Built into Chrome | DevTools → Lighthouse |
| NVDA | Screen reader (Windows) | [nvaccess.org](https://www.nvaccess.org/) |
| VoiceOver | Screen reader (Mac) | Built into macOS |
| Colour Contrast Analyser | Desktop app | [tpgi.com](https://www.tpgi.com/color-contrast-checker/) |
## Sources
- [WCAG 2.2 W3C Recommendation](https://www.w3.org/TR/WCAG22/)
- [WCAG 2.2 Quick Reference](https://www.w3.org/WAI/WCAG22/quickref/)
- [What's New in WCAG 2.2](https://www.w3.org/WAI/standards-guidelines/wcag/new-in-22/)

View File

@@ -1,167 +0,0 @@
---
name: discord-bot
description: Discord bot development on Cloudflare Workers — Discord API, Developer Portal, slash commands, Gateway WebSocket, Interactions Endpoint, bot permissions, intents, and Ed25519 verification.
---
# Discord Bot Development
Use this skill when working on Discord bots, Discord API integration, bot setup/configuration, or slash command registration. Triggered by mentions of Discord bots, Discord Developer Portal, Discord API, slash commands, Gateway, or Interactions Endpoint.
## Search before giving portal instructions
The Discord Developer Portal UI changes often, so web-search current instructions before describing:
* Where settings are located in the Developer Portal
* OAuth2 flow steps
* Bot permission configuration
* Interactions Endpoint setup
* Install link generation
Useful queries:
* `Discord Developer Portal [specific task] <current year>`
* `Discord bot setup [specific feature] latest`
If search results are older than 6 months, note this to the user and suggest they verify in the portal.
## Discord Bot Architecture on Cloudflare Workers
Two models for receiving Discord events:
### Interactions Endpoint (HTTP)
* Discord POSTs slash commands and component interactions to your Worker URL
* No persistent connection needed — pure request/response
* Set the URL in Developer Portal → General Information → Interactions Endpoint URL
* Requires Ed25519 signature verification on every request (`discord-interactions` npm package)
* Supports: slash commands, buttons, select menus, modals, autocomplete
### Gateway (WebSocket)
* Persistent WebSocket connection to `wss://gateway.discord.gg`
* Required for: reaction events, message events, presence, voice state, typing indicators
* On Cloudflare Workers: use a **Durable Object** with `new WebSocket(url)` for the outbound connection
* NOT `fetch()` with `Upgrade: websocket` — that doesn't work for `wss://` URLs
* DO won't hibernate while outbound WS is open — use alarm-based keepalive (30s interval)
* Deploys evict the DO; alarm reconnects within ~30 seconds
### Which Do You Need?
| Feature | Interactions Endpoint | Gateway |
|---------|----------------------|---------|
| Slash commands | Yes | Not needed |
| Message reactions | No | Required |
| Message content | No | Required (with intent) |
| Typing indicators | No | Required |
| Presence updates | No | Required |
| Voice state | No | Required |
Most bots need both: Interactions Endpoint for slash commands, Gateway for real-time events.
## Setting Up a New Discord Bot
### 1. Create Application
* Go to https://discord.com/developers/applications
* Click **New Application**, name it, click Create
* Copy **Application ID** and **Public Key** from General Information page
### 2. Get Bot Token
* Sidebar → **Bot**
* Click **Reset Token**, copy immediately (shown once)
* Toggle privileged intents as needed (see Intents section below)
### 3. Configure Installation
* Sidebar → **Installation**
* Enable **Guild Install**
* Select **Discord Provided Link**
* Under Default Install Settings → Guild Install:
* **Scopes:** `bot`, `applications.commands`
* **Permissions:** Select based on your bot's needs (see Permissions section)
### 4. Set Interactions Endpoint
* Sidebar → **General Information**
* Set **Interactions Endpoint URL** to your Worker's `/interactions` path
* Discord sends a PING to verify — your code must handle it (return Pong)
* Save — if verification fails, your endpoint isn't working
### 5. Register Slash Commands
* Use `PUT https://discord.com/api/v10/applications/{app_id}/commands`
* Global commands can take up to an hour to propagate
* Guild-specific commands update instantly (useful for testing)
### 6. Install to Server
* Copy the Install Link from the Installation page
* Paste in browser, select server, authorize
## Intents
Gateway intents control which events Discord sends to your bot.
**Standard intents** (no approval needed):
* `GUILDS` (1 << 0) — guild create/update/delete, role changes
* `GUILD_MESSAGES` (1 << 9) — message create/update/delete in guilds
* `GUILD_MESSAGE_REACTIONS` (1 << 10) — reaction add/remove
**Privileged intents** (must be enabled in Developer Portal → Bot):
* `MESSAGE_CONTENT` (1 << 15) — access to message content via Gateway AND REST API. Without this, `message.content` is empty for messages the bot didn't send or wasn't mentioned in.
* `GUILD_MEMBERS` (1 << 1) — member join/leave/update events
* `GUILD_PRESENCES` (1 << 8) — presence (online/offline) updates
**No approval needed for bots in <100 servers.** Over 100 servers requires Discord review.
## Common Permissions
| Permission | Bit | When needed |
|-----------|-----|-------------|
| View Channels | 1 << 10 | See channels and receive events from them |
| Send Messages | 1 << 11 | Send messages (DMs, channel messages) |
| Read Message History | 1 << 16 | Fetch messages via REST API |
| Use Slash Commands | 1 << 31 | Use application commands |
| Manage Roles | 1 << 28 | Assign/remove roles from members |
| Add Reactions | 1 << 6 | Add reactions to messages |
## Common Gotchas
### Bot doesn't receive reaction events
* **Missing intent:** Must request `GUILD_MESSAGE_REACTIONS` in Gateway IDENTIFY
* **Missing VIEW_CHANNEL:** The bot's role needs View Channels permission. Public channels inherit from @everyone, but **private channels require the bot role to be explicitly added** to the channel's permissions
### Empty message.content from REST API
* **Missing MESSAGE_CONTENT intent:** Must be enabled in Developer Portal → Bot → Privileged Gateway Intents. Also include `MESSAGE_CONTENT` (1 << 15) in the Gateway IDENTIFY intents value
### Slash command not visible
* **Propagation delay:** Global commands take up to an hour. Use guild-specific commands for testing
* **Permission restriction:** `default_member_permissions` hides commands from users without the specified permission
* **Subcommand required:** If a command has subcommands defined, the base command can't be run alone — Discord requires picking a subcommand
### "The application did not respond" on a slash command that actually worked
* Discord gives an interaction **3 seconds** to receive a response. A handler that runs its side effects synchronously before responding (REST calls, role changes, D1 writes) blows the deadline — Discord shows the error, but the Worker invocation keeps running, so the side effects still complete. Looks like a failure, is usually a success with a lost reply.
* For any command doing more than ~1 REST round trip: immediately return type 5 (`DeferredChannelMessageWithSource`, keep the ephemeral flag if needed), run the work in `ctx.waitUntil()`, then PATCH the result to `/webhooks/{application_id}/{interaction_token}/messages/@original`.
### WebSocket connection drops on Cloudflare Workers
* **DO eviction:** Use alarm-based keepalive (30s interval) to prevent idle eviction
* **Deploy:** Deploys always evict the DO. Alarm reconnects within ~30s. Use `/gateway/reconnect` for immediate recovery
* **Use `new WebSocket(url)` not `fetch()` with Upgrade header** for `wss://` URLs
### Discord rate limits
* REST API returns 429 with `retry_after` field (seconds). Wait and retry.
* Gateway has identify rate limits (1 per 5 seconds). Don't reconnect in a tight loop.
## Verification Checklist
When setting up or debugging a Discord bot:
- [ ] Bot token is set and valid (test with `GET /api/v10/users/@me`)
- [ ] Interactions Endpoint URL is set and verified (Developer Portal shows success)
- [ ] Slash commands are registered (`PUT .../commands` returns 200)
- [ ] Bot is installed to the target server (visible in member list)
- [ ] Bot role has necessary permissions (check via REST API `GET /guilds/{id}/members/{bot_id}`)
- [ ] Privileged intents are enabled in Developer Portal if needed
- [ ] Gateway intents in IDENTIFY include all needed flags
- [ ] VIEW_CHANNEL permission is set for private channels
- [ ] Gateway connection is alive (`/gateway/status` returns `connected: true`)
## Reference: Elereada v2
Working example of a Discord bot on Cloudflare Workers: `github.com/rianvdm/elereada-v2`
* Durable Object outbound WebSocket for Gateway
* Hono for HTTP routing + Interactions Endpoint
* D1 for storage
* Alarm-based keepalive for DO persistence
* Ed25519 verification via `discord-interactions` package

View File

@@ -1,177 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS

View File

@@ -1,42 +0,0 @@
---
name: frontend-design
description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
license: Complete terms in LICENSE.txt
---
This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices.
The user provides frontend requirements: a component, page, application, or interface to build. They may include context about the purpose, audience, or technical constraints.
## Design Thinking
Before coding, understand the context and commit to a BOLD aesthetic direction:
- **Purpose**: What problem does this interface solve? Who uses it?
- **Tone**: Pick an extreme: brutally minimal, maximalist chaos, retro-futuristic, organic/natural, luxury/refined, playful/toy-like, editorial/magazine, brutalist/raw, art deco/geometric, soft/pastel, industrial/utilitarian, etc. There are so many flavors to choose from. Use these for inspiration but design one that is true to the aesthetic direction.
- **Constraints**: Technical requirements (framework, performance, accessibility).
- **Differentiation**: What makes this UNFORGETTABLE? What's the one thing someone will remember?
**CRITICAL**: Choose a clear conceptual direction and execute it with precision. Bold maximalism and refined minimalism both work - the key is intentionality, not intensity.
Then implement working code (HTML/CSS/JS, React, Vue, etc.) that is:
- Production-grade and functional
- Visually striking and memorable
- Cohesive with a clear aesthetic point-of-view
- Meticulously refined in every detail
## Frontend Aesthetics Guidelines
Focus on:
- **Typography**: Choose fonts that are beautiful, unique, and interesting. Avoid generic fonts like Arial and Inter; opt instead for distinctive choices that elevate the frontend's aesthetics; unexpected, characterful font choices. Pair a distinctive display font with a refined body font.
- **Color & Theme**: Commit to a cohesive aesthetic. Use CSS variables for consistency. Dominant colors with sharp accents outperform timid, evenly-distributed palettes.
- **Motion**: Use animations for effects and micro-interactions. Prioritize CSS-only solutions for HTML. Use Motion library for React when available. Focus on high-impact moments: one well-orchestrated page load with staggered reveals (animation-delay) creates more delight than scattered micro-interactions. Use scroll-triggering and hover states that surprise.
- **Spatial Composition**: Unexpected layouts. Asymmetry. Overlap. Diagonal flow. Grid-breaking elements. Generous negative space OR controlled density.
- **Backgrounds & Visual Details**: Create atmosphere and depth rather than defaulting to solid colors. Add contextual effects and textures that match the overall aesthetic. Apply creative forms like gradient meshes, noise textures, geometric patterns, layered transparencies, dramatic shadows, decorative borders, custom cursors, and grain overlays.
NEVER use generic AI-generated aesthetics like overused font families (Inter, Roboto, Arial, system fonts), cliched color schemes (particularly purple gradients on white backgrounds), predictable layouts and component patterns, and cookie-cutter design that lacks context-specific character.
Interpret creatively and make unexpected choices that feel genuinely designed for the context. No design should be the same. Vary between light and dark themes, different fonts, different aesthetics. NEVER converge on common choices (Space Grotesk, for example) across generations.
**IMPORTANT**: Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate code with extensive animations and effects. Minimalist or refined designs need restraint, precision, and careful attention to spacing, typography, and subtle details. Elegance comes from executing the vision well.
Remember: Claude is capable of extraordinary creative work. Don't hold back, show what can truly be created when thinking outside the box and committing fully to a distinctive vision.

View File

@@ -1,639 +0,0 @@
---
name: nodejs-backend-patterns
description: Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices. Use when creating Node.js servers, REST APIs, GraphQL backends, or microservices architectures.
---
# Node.js Backend Patterns
Comprehensive guidance for building scalable, maintainable, and production-ready Node.js backend applications with modern frameworks, architectural patterns, and best practices.
## When to Use This Skill
- Building REST APIs or GraphQL servers
- Creating microservices with Node.js
- Implementing authentication and authorization
- Designing scalable backend architectures
- Setting up middleware and error handling
- Integrating databases (SQL and NoSQL)
- Building real-time applications with WebSockets
- Implementing background job processing
## Core Frameworks
### Express.js - Minimalist Framework
**Basic Setup:**
```typescript
import express, { Request, Response, NextFunction } from "express";
import helmet from "helmet";
import cors from "cors";
import compression from "compression";
const app = express();
// Security middleware
app.use(helmet());
app.use(cors({ origin: process.env.ALLOWED_ORIGINS?.split(",") }));
app.use(compression());
// Body parsing
app.use(express.json({ limit: "10mb" }));
app.use(express.urlencoded({ extended: true, limit: "10mb" }));
// Request logging
app.use((req: Request, res: Response, next: NextFunction) => {
console.log(`${req.method} ${req.path}`);
next();
});
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Server running on port ${PORT}`);
});
```
### Fastify - High Performance Framework
**Basic Setup:**
```typescript
import Fastify from "fastify";
import helmet from "@fastify/helmet";
import cors from "@fastify/cors";
import compress from "@fastify/compress";
const fastify = Fastify({
logger: {
level: process.env.LOG_LEVEL || "info",
transport: {
target: "pino-pretty",
options: { colorize: true },
},
},
});
// Plugins
await fastify.register(helmet);
await fastify.register(cors, { origin: true });
await fastify.register(compress);
// Type-safe routes with schema validation
fastify.post<{
Body: { name: string; email: string };
Reply: { id: string; name: string };
}>(
"/users",
{
schema: {
body: {
type: "object",
required: ["name", "email"],
properties: {
name: { type: "string", minLength: 1 },
email: { type: "string", format: "email" },
},
},
},
},
async (request, reply) => {
const { name, email } = request.body;
return { id: "123", name };
},
);
await fastify.listen({ port: 3000, host: "0.0.0.0" });
```
## Architectural Patterns
### Pattern 1: Layered Architecture
**Structure:**
```
src/
├── controllers/ # Handle HTTP requests/responses
├── services/ # Business logic
├── repositories/ # Data access layer
├── models/ # Data models
├── middleware/ # Express/Fastify middleware
├── routes/ # Route definitions
├── utils/ # Helper functions
├── config/ # Configuration
└── types/ # TypeScript types
```
**Controller Layer:**
```typescript
// controllers/user.controller.ts
import { Request, Response, NextFunction } from "express";
import { UserService } from "../services/user.service";
import { CreateUserDTO, UpdateUserDTO } from "../types/user.types";
export class UserController {
constructor(private userService: UserService) {}
async createUser(req: Request, res: Response, next: NextFunction) {
try {
const userData: CreateUserDTO = req.body;
const user = await this.userService.createUser(userData);
res.status(201).json(user);
} catch (error) {
next(error);
}
}
async getUser(req: Request, res: Response, next: NextFunction) {
try {
const { id } = req.params;
const user = await this.userService.getUserById(id);
res.json(user);
} catch (error) {
next(error);
}
}
async updateUser(req: Request, res: Response, next: NextFunction) {
try {
const { id } = req.params;
const updates: UpdateUserDTO = req.body;
const user = await this.userService.updateUser(id, updates);
res.json(user);
} catch (error) {
next(error);
}
}
async deleteUser(req: Request, res: Response, next: NextFunction) {
try {
const { id } = req.params;
await this.userService.deleteUser(id);
res.status(204).send();
} catch (error) {
next(error);
}
}
}
```
**Service Layer:**
```typescript
// services/user.service.ts
import { UserRepository } from "../repositories/user.repository";
import { CreateUserDTO, UpdateUserDTO, User } from "../types/user.types";
import { NotFoundError, ValidationError } from "../utils/errors";
import bcrypt from "bcrypt";
export class UserService {
constructor(private userRepository: UserRepository) {}
async createUser(userData: CreateUserDTO): Promise<User> {
// Validation
const existingUser = await this.userRepository.findByEmail(userData.email);
if (existingUser) {
throw new ValidationError("Email already exists");
}
// Hash password
const hashedPassword = await bcrypt.hash(userData.password, 10);
// Create user
const user = await this.userRepository.create({
...userData,
password: hashedPassword,
});
// Remove password from response
const { password, ...userWithoutPassword } = user;
return userWithoutPassword as User;
}
async getUserById(id: string): Promise<User> {
const user = await this.userRepository.findById(id);
if (!user) {
throw new NotFoundError("User not found");
}
const { password, ...userWithoutPassword } = user;
return userWithoutPassword as User;
}
async updateUser(id: string, updates: UpdateUserDTO): Promise<User> {
const user = await this.userRepository.update(id, updates);
if (!user) {
throw new NotFoundError("User not found");
}
const { password, ...userWithoutPassword } = user;
return userWithoutPassword as User;
}
async deleteUser(id: string): Promise<void> {
const deleted = await this.userRepository.delete(id);
if (!deleted) {
throw new NotFoundError("User not found");
}
}
}
```
**Repository Layer:**
```typescript
// repositories/user.repository.ts
import { Pool } from "pg";
import { CreateUserDTO, UpdateUserDTO, UserEntity } from "../types/user.types";
export class UserRepository {
constructor(private db: Pool) {}
async create(
userData: CreateUserDTO & { password: string },
): Promise<UserEntity> {
const query = `
INSERT INTO users (name, email, password)
VALUES ($1, $2, $3)
RETURNING id, name, email, password, created_at, updated_at
`;
const { rows } = await this.db.query(query, [
userData.name,
userData.email,
userData.password,
]);
return rows[0];
}
async findById(id: string): Promise<UserEntity | null> {
const query = "SELECT * FROM users WHERE id = $1";
const { rows } = await this.db.query(query, [id]);
return rows[0] || null;
}
async findByEmail(email: string): Promise<UserEntity | null> {
const query = "SELECT * FROM users WHERE email = $1";
const { rows } = await this.db.query(query, [email]);
return rows[0] || null;
}
async update(id: string, updates: UpdateUserDTO): Promise<UserEntity | null> {
const fields = Object.keys(updates);
const values = Object.values(updates);
const setClause = fields
.map((field, idx) => `${field} = $${idx + 2}`)
.join(", ");
const query = `
UPDATE users
SET ${setClause}, updated_at = CURRENT_TIMESTAMP
WHERE id = $1
RETURNING *
`;
const { rows } = await this.db.query(query, [id, ...values]);
return rows[0] || null;
}
async delete(id: string): Promise<boolean> {
const query = "DELETE FROM users WHERE id = $1";
const { rowCount } = await this.db.query(query, [id]);
return rowCount > 0;
}
}
```
### Pattern 2: Dependency Injection
Use a DI container to wire up repositories, services, and controllers. For a full container implementation, see [references/advanced-patterns.md](references/advanced-patterns.md).
## Middleware Patterns
### Authentication Middleware
```typescript
// middleware/auth.middleware.ts
import { Request, Response, NextFunction } from "express";
import jwt from "jsonwebtoken";
import { UnauthorizedError } from "../utils/errors";
interface JWTPayload {
userId: string;
email: string;
}
declare global {
namespace Express {
interface Request {
user?: JWTPayload;
}
}
}
export const authenticate = async (
req: Request,
res: Response,
next: NextFunction,
) => {
try {
const token = req.headers.authorization?.replace("Bearer ", "");
if (!token) {
throw new UnauthorizedError("No token provided");
}
const payload = jwt.verify(token, process.env.JWT_SECRET!) as JWTPayload;
req.user = payload;
next();
} catch (error) {
next(new UnauthorizedError("Invalid token"));
}
};
export const authorize = (...roles: string[]) => {
return async (req: Request, res: Response, next: NextFunction) => {
if (!req.user) {
return next(new UnauthorizedError("Not authenticated"));
}
// Check if user has required role
const hasRole = roles.some((role) => req.user?.roles?.includes(role));
if (!hasRole) {
return next(new UnauthorizedError("Insufficient permissions"));
}
next();
};
};
```
### Validation Middleware
```typescript
// middleware/validation.middleware.ts
import { Request, Response, NextFunction } from "express";
import { AnyZodObject, ZodError } from "zod";
import { ValidationError } from "../utils/errors";
export const validate = (schema: AnyZodObject) => {
return async (req: Request, res: Response, next: NextFunction) => {
try {
await schema.parseAsync({
body: req.body,
query: req.query,
params: req.params,
});
next();
} catch (error) {
if (error instanceof ZodError) {
const errors = error.errors.map((err) => ({
field: err.path.join("."),
message: err.message,
}));
next(new ValidationError("Validation failed", errors));
} else {
next(error);
}
}
};
};
// Usage with Zod
import { z } from "zod";
const createUserSchema = z.object({
body: z.object({
name: z.string().min(1),
email: z.string().email(),
password: z.string().min(8),
}),
});
router.post("/users", validate(createUserSchema), userController.createUser);
```
### Rate Limiting Middleware
```typescript
// middleware/rate-limit.middleware.ts
import rateLimit from "express-rate-limit";
import RedisStore from "rate-limit-redis";
import Redis from "ioredis";
const redis = new Redis({
host: process.env.REDIS_HOST,
port: parseInt(process.env.REDIS_PORT || "6379"),
});
export const apiLimiter = rateLimit({
store: new RedisStore({
client: redis,
prefix: "rl:",
}),
windowMs: 15 * 60 * 1000, // 15 minutes
max: 100, // Limit each IP to 100 requests per windowMs
message: "Too many requests from this IP, please try again later",
standardHeaders: true,
legacyHeaders: false,
});
export const authLimiter = rateLimit({
store: new RedisStore({
client: redis,
prefix: "rl:auth:",
}),
windowMs: 15 * 60 * 1000,
max: 5, // Stricter limit for auth endpoints
skipSuccessfulRequests: true,
});
```
### Request Logging Middleware
```typescript
// middleware/logger.middleware.ts
import { Request, Response, NextFunction } from "express";
import pino from "pino";
const logger = pino({
level: process.env.LOG_LEVEL || "info",
transport: {
target: "pino-pretty",
options: { colorize: true },
},
});
export const requestLogger = (
req: Request,
res: Response,
next: NextFunction,
) => {
const start = Date.now();
// Log response when finished
res.on("finish", () => {
const duration = Date.now() - start;
logger.info({
method: req.method,
url: req.url,
status: res.statusCode,
duration: `${duration}ms`,
userAgent: req.headers["user-agent"],
ip: req.ip,
});
});
next();
};
export { logger };
```
## Error Handling
### Custom Error Classes
```typescript
// utils/errors.ts
export class AppError extends Error {
constructor(
public message: string,
public statusCode: number = 500,
public isOperational: boolean = true,
) {
super(message);
Object.setPrototypeOf(this, AppError.prototype);
Error.captureStackTrace(this, this.constructor);
}
}
export class ValidationError extends AppError {
constructor(
message: string,
public errors?: any[],
) {
super(message, 400);
}
}
export class NotFoundError extends AppError {
constructor(message: string = "Resource not found") {
super(message, 404);
}
}
export class UnauthorizedError extends AppError {
constructor(message: string = "Unauthorized") {
super(message, 401);
}
}
export class ForbiddenError extends AppError {
constructor(message: string = "Forbidden") {
super(message, 403);
}
}
export class ConflictError extends AppError {
constructor(message: string) {
super(message, 409);
}
}
```
### Global Error Handler
```typescript
// middleware/error-handler.ts
import { Request, Response, NextFunction } from "express";
import { AppError } from "../utils/errors";
import { logger } from "./logger.middleware";
export const errorHandler = (
err: Error,
req: Request,
res: Response,
next: NextFunction,
) => {
if (err instanceof AppError) {
return res.status(err.statusCode).json({
status: "error",
message: err.message,
...(err instanceof ValidationError && { errors: err.errors }),
});
}
// Log unexpected errors
logger.error({
error: err.message,
stack: err.stack,
url: req.url,
method: req.method,
});
// Don't leak error details in production
const message =
process.env.NODE_ENV === "production"
? "Internal server error"
: err.message;
res.status(500).json({
status: "error",
message,
});
};
// Async error wrapper
export const asyncHandler = (
fn: (req: Request, res: Response, next: NextFunction) => Promise<any>,
) => {
return (req: Request, res: Response, next: NextFunction) => {
Promise.resolve(fn(req, res, next)).catch(next);
};
};
```
## Database Patterns
Node.js supports both SQL and NoSQL databases. Use connection pooling for all production databases.
Key patterns covered in [references/advanced-patterns.md](references/advanced-patterns.md):
- **PostgreSQL with connection pool** — `pg` Pool configuration and graceful shutdown
- **MongoDB with Mongoose** — connection management and schema definition
- **Transaction pattern** — `BEGIN`/`COMMIT`/`ROLLBACK` with `pg` client
## Authentication & Authorization
JWT-based auth with access tokens (short-lived, 15m) and refresh tokens (7d). Full `AuthService` implementation with `bcrypt` password comparison in [references/advanced-patterns.md](references/advanced-patterns.md).
## Caching Strategies
Redis-backed `CacheService` with get/set/delete/invalidatePattern, plus a `@Cacheable` decorator for method-level caching. See [references/advanced-patterns.md](references/advanced-patterns.md).
## API Response Format
Standardized `ApiResponse` helper with `success`, `error`, and `paginated` static methods. See [references/advanced-patterns.md](references/advanced-patterns.md).
## Best Practices
1. **Use TypeScript**: Type safety prevents runtime errors
2. **Implement proper error handling**: Use custom error classes
3. **Validate input**: Use libraries like Zod or Joi
4. **Use environment variables**: Never hardcode secrets
5. **Implement logging**: Use structured logging (Pino, Winston)
6. **Add rate limiting**: Prevent abuse
7. **Use HTTPS**: Always in production
8. **Implement CORS properly**: Don't use `*` in production
9. **Use dependency injection**: Easier testing and maintenance
10. **Write tests**: Unit, integration, and E2E tests
11. **Handle graceful shutdown**: Clean up resources
12. **Use connection pooling**: For databases
13. **Implement health checks**: For monitoring
14. **Use compression**: Reduce response size
15. **Monitor performance**: Use APM tools
## Testing Patterns
See `javascript-testing-patterns` skill for comprehensive testing guidance.

View File

@@ -1,430 +0,0 @@
# Node.js Advanced Patterns
Advanced patterns for dependency injection, database integration, authentication, caching, and API response formatting.
## Dependency Injection
### DI Container
```typescript
// di-container.ts
import { Pool } from "pg";
import { UserRepository } from "./repositories/user.repository";
import { UserService } from "./services/user.service";
import { UserController } from "./controllers/user.controller";
import { AuthService } from "./services/auth.service";
class Container {
private instances = new Map<string, any>();
register<T>(key: string, factory: () => T): void {
this.instances.set(key, factory);
}
resolve<T>(key: string): T {
const factory = this.instances.get(key);
if (!factory) {
throw new Error(`No factory registered for ${key}`);
}
return factory();
}
singleton<T>(key: string, factory: () => T): void {
let instance: T;
this.instances.set(key, () => {
if (!instance) {
instance = factory();
}
return instance;
});
}
}
export const container = new Container();
// Register dependencies
container.singleton(
"db",
() =>
new Pool({
host: process.env.DB_HOST,
port: parseInt(process.env.DB_PORT || "5432"),
database: process.env.DB_NAME,
user: process.env.DB_USER,
password: process.env.DB_PASSWORD,
max: 20,
idleTimeoutMillis: 30000,
connectionTimeoutMillis: 2000,
}),
);
container.singleton(
"userRepository",
() => new UserRepository(container.resolve("db")),
);
container.singleton(
"userService",
() => new UserService(container.resolve("userRepository")),
);
container.register(
"userController",
() => new UserController(container.resolve("userService")),
);
container.singleton(
"authService",
() => new AuthService(container.resolve("userRepository")),
);
```
## Database Patterns
### PostgreSQL with Connection Pool
```typescript
// config/database.ts
import { Pool, PoolConfig } from "pg";
const poolConfig: PoolConfig = {
host: process.env.DB_HOST,
port: parseInt(process.env.DB_PORT || "5432"),
database: process.env.DB_NAME,
user: process.env.DB_USER,
password: process.env.DB_PASSWORD,
max: 20,
idleTimeoutMillis: 30000,
connectionTimeoutMillis: 2000,
};
export const pool = new Pool(poolConfig);
// Test connection
pool.on("connect", () => {
console.log("Database connected");
});
pool.on("error", (err) => {
console.error("Unexpected database error", err);
process.exit(-1);
});
// Graceful shutdown
export const closeDatabase = async () => {
await pool.end();
console.log("Database connection closed");
};
```
### MongoDB with Mongoose
```typescript
// config/mongoose.ts
import mongoose from "mongoose";
const connectDB = async () => {
try {
await mongoose.connect(process.env.MONGODB_URI!, {
maxPoolSize: 10,
serverSelectionTimeoutMS: 5000,
socketTimeoutMS: 45000,
});
console.log("MongoDB connected");
} catch (error) {
console.error("MongoDB connection error:", error);
process.exit(1);
}
};
mongoose.connection.on("disconnected", () => {
console.log("MongoDB disconnected");
});
mongoose.connection.on("error", (err) => {
console.error("MongoDB error:", err);
});
export { connectDB };
// Model example
import { Schema, model, Document } from "mongoose";
interface IUser extends Document {
name: string;
email: string;
password: string;
createdAt: Date;
updatedAt: Date;
}
const userSchema = new Schema<IUser>(
{
name: { type: String, required: true },
email: { type: String, required: true, unique: true },
password: { type: String, required: true },
},
{
timestamps: true,
},
);
// Indexes
userSchema.index({ email: 1 });
export const User = model<IUser>("User", userSchema);
```
### Transaction Pattern
```typescript
// services/order.service.ts
import { Pool } from "pg";
export class OrderService {
constructor(private db: Pool) {}
async createOrder(userId: string, items: any[]) {
const client = await this.db.connect();
try {
await client.query("BEGIN");
// Create order
const orderResult = await client.query(
"INSERT INTO orders (user_id, total) VALUES ($1, $2) RETURNING id",
[userId, calculateTotal(items)],
);
const orderId = orderResult.rows[0].id;
// Create order items
for (const item of items) {
await client.query(
"INSERT INTO order_items (order_id, product_id, quantity, price) VALUES ($1, $2, $3, $4)",
[orderId, item.productId, item.quantity, item.price],
);
// Update inventory
await client.query(
"UPDATE products SET stock = stock - $1 WHERE id = $2",
[item.quantity, item.productId],
);
}
await client.query("COMMIT");
return orderId;
} catch (error) {
await client.query("ROLLBACK");
throw error;
} finally {
client.release();
}
}
}
```
## Authentication & Authorization
### JWT Authentication
```typescript
// services/auth.service.ts
import jwt from "jsonwebtoken";
import bcrypt from "bcrypt";
import { UserRepository } from "../repositories/user.repository";
import { UnauthorizedError } from "../utils/errors";
export class AuthService {
constructor(private userRepository: UserRepository) {}
async login(email: string, password: string) {
const user = await this.userRepository.findByEmail(email);
if (!user) {
throw new UnauthorizedError("Invalid credentials");
}
const isValid = await bcrypt.compare(password, user.password);
if (!isValid) {
throw new UnauthorizedError("Invalid credentials");
}
const token = this.generateToken({
userId: user.id,
email: user.email,
});
const refreshToken = this.generateRefreshToken({
userId: user.id,
});
return {
token,
refreshToken,
user: {
id: user.id,
name: user.name,
email: user.email,
},
};
}
async refreshToken(refreshToken: string) {
try {
const payload = jwt.verify(
refreshToken,
process.env.REFRESH_TOKEN_SECRET!,
) as { userId: string };
const user = await this.userRepository.findById(payload.userId);
if (!user) {
throw new UnauthorizedError("User not found");
}
const token = this.generateToken({
userId: user.id,
email: user.email,
});
return { token };
} catch (error) {
throw new UnauthorizedError("Invalid refresh token");
}
}
private generateToken(payload: any): string {
return jwt.sign(payload, process.env.JWT_SECRET!, {
expiresIn: "15m",
});
}
private generateRefreshToken(payload: any): string {
return jwt.sign(payload, process.env.REFRESH_TOKEN_SECRET!, {
expiresIn: "7d",
});
}
}
```
## Caching Strategies
```typescript
// utils/cache.ts
import Redis from "ioredis";
const redis = new Redis({
host: process.env.REDIS_HOST,
port: parseInt(process.env.REDIS_PORT || "6379"),
retryStrategy: (times) => {
const delay = Math.min(times * 50, 2000);
return delay;
},
});
export class CacheService {
async get<T>(key: string): Promise<T | null> {
const data = await redis.get(key);
return data ? JSON.parse(data) : null;
}
async set(key: string, value: any, ttl?: number): Promise<void> {
const serialized = JSON.stringify(value);
if (ttl) {
await redis.setex(key, ttl, serialized);
} else {
await redis.set(key, serialized);
}
}
async delete(key: string): Promise<void> {
await redis.del(key);
}
async invalidatePattern(pattern: string): Promise<void> {
const keys = await redis.keys(pattern);
if (keys.length > 0) {
await redis.del(...keys);
}
}
}
// Cache decorator
export function Cacheable(ttl: number = 300) {
return function (
target: any,
propertyKey: string,
descriptor: PropertyDescriptor,
) {
const originalMethod = descriptor.value;
descriptor.value = async function (...args: any[]) {
const cache = new CacheService();
const cacheKey = `${propertyKey}:${JSON.stringify(args)}`;
const cached = await cache.get(cacheKey);
if (cached) {
return cached;
}
const result = await originalMethod.apply(this, args);
await cache.set(cacheKey, result, ttl);
return result;
};
return descriptor;
};
}
```
## API Response Format
```typescript
// utils/response.ts
import { Response } from "express";
export class ApiResponse {
static success<T>(
res: Response,
data: T,
message?: string,
statusCode = 200,
) {
return res.status(statusCode).json({
status: "success",
message,
data,
});
}
static error(res: Response, message: string, statusCode = 500, errors?: any) {
return res.status(statusCode).json({
status: "error",
message,
...(errors && { errors }),
});
}
static paginated<T>(
res: Response,
data: T[],
page: number,
limit: number,
total: number,
) {
return res.json({
status: "success",
data,
pagination: {
page,
limit,
total,
pages: Math.ceil(total / limit),
},
});
}
}
```

View File

@@ -1,343 +0,0 @@
---
name: nodejs-best-practices
description: "Node.js development principles and decision-making. Framework selection, async patterns, security, and architecture. Teaches thinking, not copying."
risk: unknown
source: community
date_added: "2026-02-27"
---
# Node.js Best Practices
> Principles and decision-making for Node.js development in 2025.
> **Learn to THINK, not memorize code patterns.**
## When to Use
Use this skill when making Node.js architecture decisions, choosing frameworks, designing async patterns, or applying security and deployment best practices.
---
## ⚠️ How to Use This Skill
This skill teaches **decision-making principles**, not fixed code to copy.
- ASK user for preferences when unclear
- Choose framework/pattern based on CONTEXT
- Don't default to same solution every time
---
## 1. Framework Selection (2025)
### Decision Tree
```
What are you building?
│
├── Edge/Serverless (Cloudflare, Vercel)
│ └── Hono (zero-dependency, ultra-fast cold starts)
│
├── High Performance API
│ └── Fastify (2-3x faster than Express)
│
├── Enterprise/Team familiarity
│ └── NestJS (structured, DI, decorators)
│
├── Legacy/Stable/Maximum ecosystem
│ └── Express (mature, most middleware)
│
└── Full-stack with frontend
└── Next.js API Routes or tRPC
```
### Comparison Principles
| Factor | Hono | Fastify | Express |
|--------|------|---------|---------|
| **Best for** | Edge, serverless | Performance | Legacy, learning |
| **Cold start** | Fastest | Fast | Moderate |
| **Ecosystem** | Growing | Good | Largest |
| **TypeScript** | Native | Excellent | Good |
| **Learning curve** | Low | Medium | Low |
### Selection Questions to Ask:
1. What's the deployment target?
2. Is cold start time critical?
3. Does team have existing experience?
4. Is there legacy code to maintain?
---
## 2. Runtime Considerations (2025)
### Native TypeScript
```
Node.js 22+: --experimental-strip-types
├── Run .ts files directly
├── No build step needed for simple projects
└── Consider for: scripts, simple APIs
```
### Module System Decision
```
ESM (import/export)
├── Modern standard
├── Better tree-shaking
├── Async module loading
└── Use for: new projects
CommonJS (require)
├── Legacy compatibility
├── More npm packages support
└── Use for: existing codebases, some edge cases
```
### Runtime Selection
| Runtime | Best For |
|---------|----------|
| **Node.js** | General purpose, largest ecosystem |
| **Bun** | Performance, built-in bundler |
| **Deno** | Security-first, built-in TypeScript |
---
## 3. Architecture Principles
### Layered Structure Concept
```
Request Flow:
│
├── Controller/Route Layer
│ ├── Handles HTTP specifics
│ ├── Input validation at boundary
│ └── Calls service layer
│
├── Service Layer
│ ├── Business logic
│ ├── Framework-agnostic
│ └── Calls repository layer
│
└── Repository Layer
├── Data access only
├── Database queries
└── ORM interactions
```
### Why This Matters:
- **Testability**: Mock layers independently
- **Flexibility**: Swap database without touching business logic
- **Clarity**: Each layer has single responsibility
### When to Simplify:
- Small scripts → Single file OK
- Prototypes → Less structure acceptable
- Always ask: "Will this grow?"
---
## 4. Error Handling Principles
### Centralized Error Handling
```
Pattern:
├── Create custom error classes
├── Throw from any layer
├── Catch at top level (middleware)
└── Format consistent response
```
### Error Response Philosophy
```
Client gets:
├── Appropriate HTTP status
├── Error code for programmatic handling
├── User-friendly message
└── NO internal details (security!)
Logs get:
├── Full stack trace
├── Request context
├── User ID (if applicable)
└── Timestamp
```
### Status Code Selection
| Situation | Status | When |
|-----------|--------|------|
| Bad input | 400 | Client sent invalid data |
| No auth | 401 | Missing or invalid credentials |
| No permission | 403 | Valid auth, but not allowed |
| Not found | 404 | Resource doesn't exist |
| Conflict | 409 | Duplicate or state conflict |
| Validation | 422 | Schema valid but business rules fail |
| Server error | 500 | Our fault, log everything |
---
## 5. Async Patterns Principles
### When to Use Each
| Pattern | Use When |
|---------|----------|
| `async/await` | Sequential async operations |
| `Promise.all` | Parallel independent operations |
| `Promise.allSettled` | Parallel where some can fail |
| `Promise.race` | Timeout or first response wins |
### Event Loop Awareness
```
I/O-bound (async helps):
├── Database queries
├── HTTP requests
├── File system
└── Network operations
CPU-bound (async doesn't help):
├── Crypto operations
├── Image processing
├── Complex calculations
└── → Use worker threads or offload
```
### Avoiding Event Loop Blocking
- Never use sync methods in production (fs.readFileSync, etc.)
- Offload CPU-intensive work
- Use streaming for large data
---
## 6. Validation Principles
### Validate at Boundaries
```
Where to validate:
├── API entry point (request body/params)
├── Before database operations
├── External data (API responses, file uploads)
└── Environment variables (startup)
```
### Validation Library Selection
| Library | Best For |
|---------|----------|
| **Zod** | TypeScript first, inference |
| **Valibot** | Smaller bundle (tree-shakeable) |
| **ArkType** | Performance critical |
| **Yup** | Existing React Form usage |
### Validation Philosophy
- Fail fast: Validate early
- Be specific: Clear error messages
- Don't trust: Even "internal" data
---
## 7. Security Principles
### Security Checklist (Not Code)
- [ ] **Input validation**: All inputs validated
- [ ] **Parameterized queries**: No string concatenation for SQL
- [ ] **Password hashing**: bcrypt or argon2
- [ ] **JWT verification**: Always verify signature and expiry
- [ ] **Rate limiting**: Protect from abuse
- [ ] **Security headers**: Helmet.js or equivalent
- [ ] **HTTPS**: Everywhere in production
- [ ] **CORS**: Properly configured
- [ ] **Secrets**: Environment variables only
- [ ] **Dependencies**: Regularly audited
### Security Mindset
```
Trust nothing:
├── Query params → validate
├── Request body → validate
├── Headers → verify
├── Cookies → validate
├── File uploads → scan
└── External APIs → validate response
```
---
## 8. Testing Principles
### Test Strategy Selection
| Type | Purpose | Tools |
|------|---------|-------|
| **Unit** | Business logic | node:test, Vitest |
| **Integration** | API endpoints | Supertest |
| **E2E** | Full flows | Playwright |
### What to Test (Priorities)
1. **Critical paths**: Auth, payments, core business
2. **Edge cases**: Empty inputs, boundaries
3. **Error handling**: What happens when things fail?
4. **Not worth testing**: Framework code, trivial getters
### Built-in Test Runner (Node.js 22+)
```
node --test src/**/*.test.ts
├── No external dependency
├── Good coverage reporting
└── Watch mode available
```
---
## 9. Anti-Patterns to Avoid
### ❌ DON'T:
- Use Express for new edge projects (use Hono)
- Use sync methods in production code
- Put business logic in controllers
- Skip input validation
- Hardcode secrets
- Trust external data without validation
- Block event loop with CPU work
### ✅ DO:
- Choose framework based on context
- Ask user for preferences when unclear
- Use layered architecture for growing projects
- Validate all inputs
- Use environment variables for secrets
- Profile before optimizing
---
## 10. Decision Checklist
Before implementing:
- [ ] **Asked user about stack preference?**
- [ ] **Chosen framework for THIS context?** (not just default)
- [ ] **Considered deployment target?**
- [ ] **Planned error handling strategy?**
- [ ] **Identified validation points?**
- [ ] **Considered security requirements?**
---
> **Remember**: Node.js best practices are about decision-making, not memorizing patterns. Every project deserves fresh consideration based on its requirements.
## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

View File

@@ -1,513 +0,0 @@
---
name: seo
description: Optimize for search engine visibility and ranking. Use when asked to "improve SEO", "optimize for search", "fix meta tags", "add structured data", "sitemap optimization", or "search engine optimization".
license: MIT
metadata:
author: web-quality-skills
version: "1.0"
---
# SEO optimization
Search engine optimization based on Lighthouse SEO audits and Google Search guidelines. Focus on technical SEO, on-page optimization, and structured data.
## SEO fundamentals
Search ranking factors (approximate influence):
| Factor | Influence | This Skill |
|--------|-----------|------------|
| Content quality & relevance | ~40% | Partial (structure) |
| Backlinks & authority | ~25% | ✗ |
| Technical SEO | ~15% | ✓ |
| Page experience (Core Web Vitals) | ~10% | See [Core Web Vitals](../core-web-vitals/SKILL.md) |
| On-page SEO | ~10% | ✓ |
---
## Technical SEO
### Crawlability
**robots.txt:**
```text
# /robots.txt
User-agent: *
Allow: /
# Block admin/private areas
Disallow: /admin/
Disallow: /api/
Disallow: /private/
# Don't block resources needed for rendering
# ❌ Disallow: /static/
Sitemap: https://example.com/sitemap.xml
```
**Meta robots:**
```html
<!-- Default: indexable, followable -->
<meta name="robots" content="index, follow">
<!-- Noindex specific pages -->
<meta name="robots" content="noindex, nofollow">
<!-- Indexable but don't follow links -->
<meta name="robots" content="index, nofollow">
<!-- Control snippets -->
<meta name="robots" content="max-snippet:150, max-image-preview:large">
```
**Canonical URLs:**
```html
<!-- Prevent duplicate content issues -->
<link rel="canonical" href="https://example.com/page">
<!-- Self-referencing canonical (recommended) -->
<link rel="canonical" href="https://example.com/current-page">
<!-- For paginated content -->
<link rel="canonical" href="https://example.com/products">
<!-- Or use rel="prev" / rel="next" for explicit pagination -->
```
### XML sitemap
```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://example.com/</loc>
<lastmod>2024-01-15</lastmod>
<changefreq>daily</changefreq>
<priority>1.0</priority>
</url>
<url>
<loc>https://example.com/products</loc>
<lastmod>2024-01-14</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>
</urlset>
```
**Sitemap best practices:**
- Maximum 50,000 URLs or 50MB per sitemap
- Use sitemap index for larger sites
- Include only canonical, indexable URLs
- Update `lastmod` when content changes
- Submit to Google Search Console
### URL structure
```
✅ Good URLs:
https://example.com/products/blue-widget
https://example.com/blog/how-to-use-widgets
❌ Poor URLs:
https://example.com/p?id=12345
https://example.com/products/item/category/subcategory/blue-widget-2024-sale-discount
```
**URL guidelines:**
- Use hyphens, not underscores
- Lowercase only
- Keep short (< 75 characters)
- Include target keywords naturally
- Avoid parameters when possible
- Use HTTPS always
### HTTPS & security
```html
<!-- Ensure all resources use HTTPS -->
<img src="https://example.com/image.jpg">
<!-- Not: -->
<img src="http://example.com/image.jpg">
```
**Security headers for SEO trust signals:**
```
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
```
---
## On-page SEO
### Title tags
```html
<!-- ❌ Missing or generic -->
<title>Page</title>
<title>Home</title>
<!-- ✅ Descriptive with primary keyword -->
<title>Blue Widgets for Sale | Premium Quality | Example Store</title>
```
**Title tag guidelines:**
- 50-60 characters (Google truncates ~60)
- Primary keyword near the beginning
- Unique for every page
- Brand name at end (unless homepage)
- Action-oriented when appropriate
### Meta descriptions
```html
<!-- ❌ Missing or duplicate -->
<meta name="description" content="">
<!-- ✅ Compelling and unique -->
<meta name="description" content="Shop premium blue widgets with free shipping. 30-day returns. Rated 4.9/5 by 10,000+ customers. Order today and save 20%.">
```
**Meta description guidelines:**
- 150-160 characters
- Include primary keyword naturally
- Compelling call-to-action
- Unique for every page
- Matches page content
### Heading structure
```html
<!-- ❌ Poor structure -->
<h2>Welcome to Our Store</h2>
<h4>Products</h4>
<h1>Contact Us</h1>
<!-- ✅ Proper hierarchy -->
<h1>Blue Widgets - Premium Quality</h1>
<h2>Product Features</h2>
<h3>Durability</h3>
<h3>Design</h3>
<h2>Customer Reviews</h2>
<h2>Pricing</h2>
```
**Heading guidelines:**
- Single `<h1>` per page (the main topic)
- Logical hierarchy (don't skip levels)
- Include keywords naturally
- Descriptive, not generic
### Image SEO
```html
<!-- ❌ Poor image SEO -->
<img src="IMG_12345.jpg">
<!-- ✅ Optimized image -->
<img src="blue-widget-product-photo.webp"
alt="Blue widget with chrome finish, side view showing control panel"
width="800"
height="600"
loading="lazy">
```
**Image guidelines:**
- Descriptive filenames with keywords
- Alt text describes the image content
- Compressed and properly sized
- WebP/AVIF with fallbacks
- Lazy load below-fold images
### Internal linking
```html
<!-- ❌ Non-descriptive -->
<a href="/products">Click here</a>
<a href="/widgets">Read more</a>
<!-- ✅ Descriptive anchor text -->
<a href="/products/blue-widgets">Browse our blue widget collection</a>
<a href="/guides/widget-maintenance">Learn how to maintain your widgets</a>
```
**Linking guidelines:**
- Descriptive anchor text with keywords
- Link to relevant internal pages
- Reasonable number of links per page
- Fix broken links promptly
- Use breadcrumbs for hierarchy
---
## Structured data (JSON-LD)
### Organization
```html
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "Organization",
"name": "Example Company",
"url": "https://example.com",
"logo": "https://example.com/logo.png",
"sameAs": [
"https://twitter.com/example",
"https://linkedin.com/company/example"
],
"contactPoint": {
"@type": "ContactPoint",
"telephone": "+1-555-123-4567",
"contactType": "customer service"
}
}
</script>
```
### Article
```html
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "Article",
"headline": "How to Choose the Right Widget",
"description": "Complete guide to selecting widgets for your needs.",
"image": "https://example.com/article-image.jpg",
"author": {
"@type": "Person",
"name": "Jane Smith",
"url": "https://example.com/authors/jane-smith"
},
"publisher": {
"@type": "Organization",
"name": "Example Blog",
"logo": {
"@type": "ImageObject",
"url": "https://example.com/logo.png"
}
},
"datePublished": "2024-01-15",
"dateModified": "2024-01-20"
}
</script>
```
### Product
```html
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "Product",
"name": "Blue Widget Pro",
"image": "https://example.com/blue-widget.jpg",
"description": "Premium blue widget with advanced features.",
"brand": {
"@type": "Brand",
"name": "WidgetCo"
},
"offers": {
"@type": "Offer",
"price": "49.99",
"priceCurrency": "USD",
"availability": "https://schema.org/InStock",
"url": "https://example.com/products/blue-widget"
},
"aggregateRating": {
"@type": "AggregateRating",
"ratingValue": "4.8",
"reviewCount": "1250"
}
}
</script>
```
### FAQ
```html
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "What colors are available?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Our widgets come in blue, red, and green."
}
},
{
"@type": "Question",
"name": "What is the warranty?",
"acceptedAnswer": {
"@type": "Answer",
"text": "All widgets include a 2-year warranty."
}
}
]
}
</script>
```
### Breadcrumbs
```html
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{
"@type": "ListItem",
"position": 1,
"name": "Home",
"item": "https://example.com"
},
{
"@type": "ListItem",
"position": 2,
"name": "Products",
"item": "https://example.com/products"
},
{
"@type": "ListItem",
"position": 3,
"name": "Blue Widgets",
"item": "https://example.com/products/blue-widgets"
}
]
}
</script>
```
### Validation
Test structured data at:
- [Google Rich Results Test](https://search.google.com/test/rich-results)
- [Schema.org Validator](https://validator.schema.org/)
---
## Mobile SEO
### Responsive design
```html
<!-- ❌ Not mobile-friendly -->
<meta name="viewport" content="width=1024">
<!-- ✅ Responsive viewport -->
<meta name="viewport" content="width=device-width, initial-scale=1">
```
### Tap targets
```css
/* ❌ Too small for mobile */
.small-link {
padding: 4px;
font-size: 12px;
}
/* ✅ Adequate tap target */
.mobile-friendly-link {
padding: 12px;
font-size: 16px;
min-height: 48px;
min-width: 48px;
}
```
### Font sizes
```css
/* ❌ Too small on mobile */
body {
font-size: 10px;
}
/* ✅ Readable without zooming */
body {
font-size: 16px;
line-height: 1.5;
}
```
---
## International SEO
### Hreflang tags
```html
<!-- For multi-language sites -->
<link rel="alternate" hreflang="en" href="https://example.com/page">
<link rel="alternate" hreflang="es" href="https://example.com/es/page">
<link rel="alternate" hreflang="fr" href="https://example.com/fr/page">
<link rel="alternate" hreflang="x-default" href="https://example.com/page">
```
### Language declaration
```html
<html lang="en">
<!-- or -->
<html lang="es-MX">
```
---
## SEO audit checklist
### Critical
- [ ] HTTPS enabled
- [ ] robots.txt allows crawling
- [ ] No `noindex` on important pages
- [ ] Title tags present and unique
- [ ] Single `<h1>` per page
### High priority
- [ ] Meta descriptions present
- [ ] Sitemap submitted
- [ ] Canonical URLs set
- [ ] Mobile-responsive
- [ ] Core Web Vitals passing
### Medium priority
- [ ] Structured data implemented
- [ ] Internal linking strategy
- [ ] Image alt text
- [ ] Descriptive URLs
- [ ] Breadcrumb navigation
### Ongoing
- [ ] Fix crawl errors in Search Console
- [ ] Update sitemap when content changes
- [ ] Monitor ranking changes
- [ ] Check for broken links
- [ ] Review Search Console insights
---
## Tools
| Tool | Use |
|------|-----|
| Google Search Console | Monitor indexing, fix issues |
| Google PageSpeed Insights | Performance + Core Web Vitals |
| Rich Results Test | Validate structured data |
| Lighthouse | Full SEO audit |
| Screaming Frog | Crawl analysis |
## References
- [Google Search Central](https://developers.google.com/search)
- [Schema.org](https://schema.org/)
- [Core Web Vitals](../core-web-vitals/SKILL.md)
- [Web Quality Audit](../web-quality-audit/SKILL.md)

View File

@@ -46,12 +46,6 @@ jobs:
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest ./backend
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest
- name: Build discord bot
run: |
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \
./discord-bot
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest
- name: Copy files
run: |
scp docker-compose.yml deploy@${{ secrets.DEPLOY_HOST}}:/var/www/app/

1
.gitignore vendored
View File

@@ -1,2 +1 @@
node_modules
.env

589
AGENTS.md
View File

@@ -1,589 +0,0 @@
# AGENTS.md — Dragonroll
Read this file before touching the code. It is a complete map of the project: layout, architecture,
data model, API, conventions and known landmines. You should not need to explore the rest of the repo
to make a correct change.
## 1. What this is
**Dragonroll** is a free/open-source helper for tabletop RPG campaigns (notes, campaigns, folders,
dice widgets, shared markdown, sounds). It is a two-app monorepo:
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS.
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion.
There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no
Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). The only automated tests
are `tests/*.test.js` (`npm test`, Node's built-in runner), which exercise the Foundry module's sync
logic against stubbed Foundry globals.
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`).
CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `master`, pushes them to
`git.aranroig.com/<user>/dragonroll-{frontend,backend}:latest`, copies `docker-compose.yml` +
`nginx.conf` to the deploy host and runs `docker compose pull && up -d`.
## 2. Root layout
```
dragonroll/
├── backend/ Express API (CommonJS, entry: src/index.js)
├── frontend/ Nuxt 4 app (entry: app/app.vue)
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
├── nginx.conf reverse proxy rules for the compose stack
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
├── .gitea/workflows/deploy.yml
├── static/media/ README logo images only
├── tests/ `node --test` tests (Foundry module sync toggle)
├── package.json root: only `concurrently`, used by `npm run dev`
└── README.md install/run instructions are STALE (see §9)
```
## 3. Commands
```bash
npm install # root: installs `concurrently` only
npm install --prefix backend
npm install --prefix frontend # runs `nuxt prepare` via postinstall
npm run dev # both apps: backend (nodemon, :5000) + frontend (nuxt dev, :3000)
# also runs the Foundry VTT start script from root .env
# (FOUNDRY_START_SCRIPT, via scripts/run-foundry.js)
npm --prefix backend run dev # backend only
npm --prefix frontend run dev # frontend only
npm --prefix frontend run build # nuxt build --dotenv .env.production
npm --prefix frontend run preview
npm test # node --test tests/ (Foundry module sync logic, no dependencies)
```
There is no `start` script in either package and no lint command.
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello);
`npm test` covers the Foundry character/item sync toggle and per-actor force sync.
### Environment files
| File | Contents | Notes |
|---|---|---|
| `.env` (root) | `FOUNDRY_START_SCRIPT=<path to Foundry VTT start.sh>` | gitignored; consumed by `scripts/run-foundry.js` during `npm run dev` |
| `backend/.env` | `PORT=5000`, `DB_URI=mongodb://localhost:27017/dragonroll`, `NODE_ENV=development` | gitignored |
| `backend/.env.production` | same shape, `DB_URI=mongodb://192.168.1.7:27017/dragonroll` | **committed** |
| `frontend/.env` | `NUXT_PUBLIC_API_BASE_URL=http://localhost:5000/api` | gitignored |
| `frontend/.env.production` | `NUXT_PUBLIC_API_BASE_URL=https://dragonroll.aranroig.com/api` | **committed** |
`backend/src/index.js` loads `.env.$NODE_ENV` when `NODE_ENV` is set, otherwise plain `.env`.
`PORT` is read from env but **ignored**: the server always listens on 5000.
## 4. Backend
```
backend/src/
├── index.js app bootstrap: dotenv, static uploads, json limits (50mb),
│ passport init, CORS, route mounting, listen(5000)
├── db.js connectDB() -> mongoose.connect(process.env.DB_URI)
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js Map.js
│ FoundryLinkRequest.js DiscordLinkRequest.js DiscordGuildLink.js
├── routes/ user.js campaign.js note.js folder.js actor.js item.js map.js
│ foundry-link.js (token sync, mounted BEFORE auth) foundry.js (bridge proxy)
│ discord.js
├── services/
│ ├── keys.js { secret: "putyoursecrethere" } <- JWT secret, hardcoded
│ ├── passport.js JwtStrategy: Bearer token -> User.findById(jwt_payload._id)
│ ├── middleware.js isAdmin — imported by routes/user.js but applied to no route yet
│ ├── rate-limiter.js express-rate-limit: 150 req / 60 min, applied to /user/login and /user/setup
│ ├── storage.js multer diskStorage -> backend/src/uploads/, filename `<field>-<timestamp><ext>`
│ ├── foundry.js requestFoundry(): reads the optional snapshot bridge
│ ├── foundry-fields.js shared asText/numberOr/plainText/stringList for the mappers
│ ├── actor-foundry.js foundryActorToCharacter(): Foundry actor document -> Actor fields
│ └── item-foundry.js foundryItemToItemData(): Foundry item document -> Item fields
└── uploads/ created on demand, gitignored, served PUBLICLY at /api/public
```
### Auth chain (order matters, `src/index.js`)
1. `/api/public/*` → static file serving of `src/uploads` (no auth).
2. `app.use('/api/user', routes/user)` → **mounted before the JWT guard**, so the whole user router is
reachable unauthenticated. Individual handlers that need a user call
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
`/get-settings`).
3. `checkAuth = passport.authenticate('jwt', { session: false })` — note the **missing declaration**
(implicit global). Everything mounted after this is JWT-protected.
4. `/api/campaign`, `/api/note`, `/api/folder`, `/api/actor`, `/api/item` and `/api/foundry`
(the read-only bridge proxy). `routes/foundry-link.js` is deliberately mounted **before** step 3 —
it authenticates with the per-campaign sync token instead of a Dragonroll login (see §4.1).
JWT: signed in `POST /api/user/login` with payload `{ _id, username, name, email, admin, settings }`,
`expiresIn: 172800` (48h). `req.user` is the Mongoose `User` document, so routes use `req.user.id`.
### Response convention
Every endpoint returns HTTP 200 with a JSON envelope; there is almost no real status-code usage:
```jsonc
{ "status": "ok", ...payload }
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
```
Common `msg` keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. The frontend checks
`response.data.status !== 'ok'`. `GET /user/has-admin` uses a special `status: "init"` to mean
"no admin exists yet → show first-run registration".
### Authorization model
Single-tenant per user: a campaign belongs to `createdBy`, everything else hangs off a campaign.
`note.js` and `folder.js` define a local helper:
```js
async function userOwnsCampaign(campaignId, userId) { ... } // duplicated in both files
```
Ownership is enforced per handler. `settings`, `color`, `description` and `User.settings` are schemaless
`Object`/free-form fields.
### Data model
```
User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder, self-ref)
└───────< Folder
└───────< Actor (Foundry actors, when linked)
└───────< Item (Foundry gear + hand-made items)
└───────< Map (uploaded images + their grid settings)
```
| Model | File | Fields |
|---|---|---|
| `User` | `models/User.js` | `name*`, `username*` (unique), `email*` (unique), `password` (bcrypt hash, 10 salt rounds), `date`, `admin` (bool, default false), `image`, `setupCode`, `settings` (Object) |
| `Campaign` | `models/Campaign.js` | `name*`, `description`, `color`, `createdBy*` → User, `date`, `settings` (Object), `foundryWorldId` (unique, sparse), `foundryWorldTitle`, `foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId` |
| `Note` | `models/Note.js` | `title`, `content` (markdown source string), `campaign*` → Campaign, `folder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
| `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` |
| `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` |
| `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `pins[{note → Note, x, y}]` (a note pinned at image px coordinates, addressed by its own `_id`), `campaign*` → Campaign, `date` |
`*` = required. Notes and folders are ordered by `date: -1` everywhere.
### API reference
`POST /api/user/register` — body `{username,email,name,password}`. First registered user becomes
`admin: true`. (Currently broken: see §9.)
`GET /api/user/verify-setup?code=` — `{status:'ok',code}` | `{status:'error',msg:'not-exists'}`
`POST /api/user/setup?code=` — rate limited. Body `{name,username,email,password}` completes an
invited account (`setupCode` is cleared).
`POST /api/user/login` — rate limited. Body `{usermail,password}` (accepts username **or** email) →
`{status:'ok', token, msg:'success'}`.
`POST /api/user/upload-avatar` — multipart field `image`, JWT required → stores filename on `User.image`.
Fetch the file from `/api/public/<filename>`.
`GET /api/user/retrieve-avatar?username=` → `{status:'ok', image}`
`GET /api/user/has-admin` → `status: 'ok' | 'init' | 'error'`
`POST /api/user/update-settings` — JWT inline. Body `{ settings: {...} }` (whole object replaced).
`GET /api/user/get-settings` — JWT inline → `{status:'ok', settings}`
`POST /api/campaign/create` — `{name,description,color,settings}` → `{status:'ok',campaign}`
`GET /api/campaign/list` → `{status:'ok',campaigns}`
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
folder entries include `parentFolder` so clients can rebuild nested folder paths
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
`GET /api/note/all?campaign=` → `{status:'ok', notes, folders}` — every note of the campaign, titles
only (no `content`); the map viewer's note picker and its pin labels
`GET /api/note/retrieve/:id` → `{status:'ok',note}` — one note with its content, ownership checked
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
`POST /api/note/delete` — `{id}` — **no ownership check** (§9); pulls the note off every map's `pins`
`GET /api/folder/list?campaign=` → `{status:'ok',folders}`
`POST /api/folder/create` — `{name*,campaign*}`
`POST /api/folder/rename` — `{id*,name*}`
`POST /api/folder/update` — `{id*, name?, color?}` — partial, ownership checked
`POST /api/folder/delete` — `{id}` — recursive: notes inside are moved to root (`folder: null`),
subfolders re-parented to null then deleted.
`GET /api/test` — health check.
`GET /api/actor/list?campaign=` → `{status:'ok',actors}`
`POST /api/actor/create` — `{name*,campaign*,type?,species?,className?,subclass?,level?,background?,challengeRating?,description?}`
`POST /api/actor/update` — `{id*, name?, species?, className?, subclass?, level?, abilityScores?, armorClass?, speed?, proficiencies?, inventory?, traits?, spells?, image?}` — partial, ownership checked
`POST /api/actor/upload-image?actor=` — multipart field `image`
`POST /api/actor/delete` — `{id}`
`GET /api/item/list?campaign=` → `{status:'ok',items}`
`POST /api/item/create` — `{name*,campaign*,category?,rarity?,quantity?,weight?,properties?,description?}`
`POST /api/item/update` — `{id*, name?, category?, rarity?, quantity?, weight?, properties?, description?}` — partial, ownership checked. `''` for `quantity`/`weight` is ignored, like `/item/create`.
`POST /api/item/delete` — `{id}`
`GET /api/map/list?campaign=` → `{status:'ok',maps}`
`POST /api/map/create` — multipart (`image`) or JSON `{name*,campaign*,gridSize?,offsetX?,offsetY?,scale?}` → `{status:'ok',map}`
`POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as
multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too).
`POST /api/map/delete` — `{id}`
`POST /api/map/pin` — `{id*, note*, x, y}` — pins a note of the same campaign at those image px;
pinning a note that is pinned already moves that marker → `{status:'ok',map}`
`POST /api/map/unpin` — `{id*, pin*}` (`pin` is the subdocument `_id`) → `{status:'ok',map}`
### 4.1 Foundry integration (actors, items)
`dragonroll-foundry/` holds the Foundry VTT module (`scripts/api.js`, loaded by `module.json`) and an
optional read-only snapshot bridge (`bridge/server.js`). The module talks to Dragonroll with a
per-campaign bearer token, **not** a Dragonroll login: `POST /api/foundry/link/complete` redeems a
pairing code, stores its hash on `Campaign.foundrySyncTokenHash` and hands the plain token to Foundry
once. Every sync route re-reads the campaign from that hash and rejects payloads whose `worldId` is
not `Campaign.foundryWorldId` (`syncCampaign` / `requestMatchesWorld`). CORS is opened for
`/api/foundry/sync*` and `/foundry/link/complete` in `src/index.js`, before the app-wide CORS.
`dragonroll-foundry/README.md` documents pairing, the bridge and its environment variables.
| Sync route (token) | Meaning |
|---|---|
| `POST /sync/snapshot` | `{worldId, actors[], items[], fullSync}` — upserts actors, world items and every item embedded in those actors; a `fullSync` also deletes actors/items that are gone |
| `POST /sync/item-snapshot` | `{worldId, items[]}` — live world-item edits, upsert only (never prunes) |
| `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted |
| `GET /sync/characters` | Actors the module applies back into Foundry |
| `GET /sync/items` | Items the module applies back into Foundry (creates world items for Dragonroll-authored ones) |
| `GET /sync/status` | The campaign a sync token belongs to; the module shows it in its **Dragonroll Pairing Status** setting and treats `unauthorized` as the campaign having unlinked the world |
| `POST /sync/map` / `POST /sync/map-item` | Store the id mapping after the module creates a document |
| `POST /sync/delete` | `{worldId, foundryActorId}` |
Rules worth knowing before editing this:
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index so local
documents can leave it unset). A document carrying the `dragonroll-foundry.actorId` /
`dragonroll-foundry.itemId` flag adopts the matching Dragonroll row.
- **Items are deduplicated by name.** Foundry keeps the same gear once per carrier, so one Dragonroll
`Item` per name: the first document to claim it keeps the mapping, later copies just return it.
`foundryNames` remembers Foundry's names so a Dragonroll rename does not resurrect a duplicate.
`services/item-foundry.js` returns `null` for non-gear types (spells, classes, feats, species…),
which the sync skips.
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events
overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies.
- **Autosync is a Foundry-side switch** (`autoSync` client setting, on by default): when off, the
module queues no CRUD push, runs no periodic reconcile and sends no startup snapshot; the actor
directory's `Dragonroll: Force Sync` entry still pushes the selected actors as an upsert
(`fullSync:false`, so it never prunes). The read-only bridge snapshot is not gated by it.
- **`pairingStatus` is a setting the module writes, not the GM**: the module settings sentence about
whether this world is connected comes from the stored sync token plus the answer from
`/sync/status` (checked at world start and every minute), and anything typed into it is replaced.
- `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`.
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only
bridge, only useful when `FOUNDRY_API_URL` is configured.
## 5. Frontend
```
frontend/
├── nuxt.config.ts css order (colors, fonts, main, callouts), runtimeConfig.public
│ {apiBaseUrl, gitCommit, gitTag, gitBranch, buildDate}, @nuxtjs/i18n module,
│ vite.optimizeDeps; git info harvested at build time via execSync
├── 18n.config.ts vue-i18n fallbackLocale 'en'
├── i18n/locales/ en/ es/ ca/ (+ empty en.json, es.json, ca.json for the nuxt module)
├── public/ img/ icons/{iconoir/{regular,solid},Pixelarticons,ui} sounds/ fonts/{5e,amiri,...}
│ → served at /img, /icons, /sounds, /fonts
└── app/ Nuxt 4 source root (`~/` and `@/` both alias here)
├── app.vue real entry: theme setup + start() boot logic + 5 managers
├── assets/css/ colors.scss (theme maps → CSS vars), fonts.scss (5e-style font families),
│ main.scss (globals, scrollbars, .icon), callouts.scss (Obsidian-like callouts)
├── components/
│ ├── managers/ WindowManager, ContentManager, ToastManager, TooltipManager, ContextMenuManager
│ ├── windows/ ExampleWindow (template to copy), Login, Register, MainMenu, Settings,
│ │ CreateCampaign, RenameNote, NewFolder + partials/{WindowHandle,
│ │ FixedBottomButtons, BigIconTemplate}
│ ├── partials/ ContentSidebar, NestedNoteList, CampaignEntry, EditUserPartial, Spinner,
│ │ VersionRender
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
│ content/{Content,NoteContainer,Note}, map/MapViewerPane, widgets/{TableWidget,TestWidget,
│ inline/RollWidgetInline,display/RollWidgetDisplay}
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
│ useEmitter.ts (BROKEN, see §9)
├── plugins/ api.ts (inject runtimeConfig apiBaseUrl into the axios instance), i18n.ts
└── services/ plain ES modules holding reactive module state (the app has no store)
```
### 5.1 It is not a routed app
There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Screens" are either:
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
shown when `Campaign` state is non-null. The note column shows the open notes, or the map anchored
on it (`AnchorMap` / `ActivePane` in `services/Content.js`); the sidebar's notes and maps buttons
switch between the two while both keep their state, and `viewer/map/MapViewerPane.vue` renders the
map there and inside the `map_viewer` window (a detached anchored map). Right clicking that map pins
one of the campaign notes at the spot (`services/MapPins.js` translates between image pixels and
the screen and labels the note picker); clicking the marker opens `pinned_note`
(`PinnedNoteWindow.vue`), which reads the note itself through `/note/retrieve/:id`.
Boot sequence (`app.vue` → `start()`):
```
GetUser() (JWT in localStorage, un-expired)?
├─ yes → RestoreCampaign() (localStorage.selectedCampaignId) → on failure open 'main_menu'
└─ no → HasAdmin() ? open 'login' : open 'register' {firstTime:true}
```
### 5.2 The window system (most important thing to understand)
`app/services/WindowDefinitions.js` is the **registry**: key = window type, value =
`{ title: 'i18n.key', component: () => import('~/components/windows/X.vue'), movable, close?, back?, ... }`.
Adding a window = add an entry here **and** a component in `app/components/windows/`.
`app/services/Windows.js` is the runtime. Module-level state: `windows = ref([])`, auto-incrementing
`currentId`, `currentIndex` z-index counter. Key exports:
`CreateWindow(type, data)` (one instance per type — duplicates are ignored),
`CreateChildWindow(parentId, type, data)` (child dies with parent), `ClearWindow({type}|{id})`
(recursive over `children`), `ClearAll()`, `GetWindowWithId(id)`, `GetFirstWindowId(type)`,
`CallWindow(id, callableName, arg)`, `SetSize/SetPosition/SetMinSize/SetMaxSize/SetResizable/
SetMovable/ResetPosition(id,'center')/SetOnTop/Top`, `getComponent(type)` (cached `defineAsyncComponent`),
and `SetupHandle(id, handleRef)` which wires raw DOM mouse listeners for drag/resize.
Contract a window component must fulfil (copy `ExampleWindow.vue`):
```vue
<script setup>
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
const handle = ref(null), wrapper = ref(null);
const props = defineProps(['data']); // 'data' = merged {type,id,...WindowDefinitions entry,...CreateWindow data}
const id = props.data.id;
onMounted(() => {
Top(wrapper); SetupHandle(id, handle);
SetSize(id, { width: 500, height: 380 }); ResetPosition(id, 'center');
});
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<!-- body -->
</div>
</template>
```
DOM id conventions that `Windows.js`, `WindowHandle.vue` and drag/resize depend on — do not rename:
`window-wrapper-{id}`, `window-handle-{id}`, `window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
`WindowHandle.vue` reads `title` (translated at mount via `$t`), `close` and `back` off the window
object, exposes `setupHandle()`, and plays `/sounds/close.wav` when closed.
### 5.3 Services (`app/services/`) — the state layer
Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Singleton by import.
| Service | Provides |
|---|---|
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
| `Content.js` | `ShowContent` ref (drives the campaign workspace: `ContentManager.vue` turns it on from a `watch(Campaign)`, `TopBar` off when leaving a campaign) and the anchored map: `ActivePane` (`'notes'`\|`'map'`), `AnchoredMap`, `SetActivePane`, `AnchorMap`, `ClearAnchoredMap` |
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
| `ContextMenu.js` | `SetupContextMenu()`, `AddContextMenu(el, items, {dropdown:true})`, `ShowContextMenu(items)`, `HideContextMenu()`. Items: `{name, icon?, action?, divider?}` or `{name, context:[...]}` for a submenu; built imperatively into `#context-menu` with `motion` animations |
| `Sound.js` | `AddSound(rootEl)` binds `/sounds/snap.wav` to every `.sound-click` inside `rootEl` |
| `Marker.js` | marked `Marked` instance + custom extensions, `ParseMarkdown(src)`, `GetWidget(kind,name)` (§5.4) |
| `ActionRegistry.js` | `register({id,label,description,execute,isActive?})`, `unregister`, `search(q)` (diacritic-insensitive, prefix-first sort), `execute(id,params)` — powers the command palette |
| `Windows.js` / `WindowDefinitions.js` | §5.2 |
| `widgets/DiceParser.js` | recursive-descent dice evaluator (§5.5) |
### 5.4 Markdown → Vue widgets
`Marker.js` registers three marked extensions:
| Syntax | Level | Output |
|---|---|---|
| `@name\n<content>\n@end` | block | `<div class="vue-component-display" data-component data-content>` |
| `@name[text]` | inline | `<span class="vue-component-inline" data-component data-content>` |
| `[[target]]` | inline | `<span class="vue-link" data-href>` (renders the literal text `Link`) |
`Note.vue` renders the HTML with `v-html`, then in a `setTimeout(...,0)` calls `mountComponents()`,
which `querySelectorAll('.vue-component-display'|'.vue-component-inline')` and mounts each node with a
**separate** `createApp(GetWidget(kind, el.dataset.component), { content: el.dataset.content })`.
Widgets are therefore isolated mini-apps: they receive only `content` (a string) and must not rely on
the parent app's provides/injection.
Registering a widget = add an entry to `widget_map` in `Marker.js`:
```js
const widget_map = {
inline: { roll: () => import("~/components/viewer/widgets/inline/RollWidgetInline.vue") },
display: { roll: () => import("~/components/viewer/widgets/display/RollWidgetDisplay.vue") },
};
```
`Note.vue` also: handles `Ctrl/Cmd+E` (toggle edit/preview, saves on exit) and `Ctrl/Cmd+S` (save via
`POST /note/update`), tracks dirty state (white dot in the vertical title strip), and wires
Obsidian-style collapsible callouts (`setupCallout()`/`toggleCallout()` + `callouts.scss`).
### 5.5 Dice grammar (`DiceParser.js`)
`parse(expr) -> { total, steps[] }`. Tokens: `\d*d\d+` with optional `adv|dis|kh<N>|kl<N>`, integers,
`+ - * / ( )`, unary minus. `adv`/`dis` roll 2dN and keep max/min; `kh`/`kl` keep highest/lowest N.
Division is `Math.floor`. Guards: count 1–1000, sides 2–10000. `steps` are `{type:'op'|'const'|'dice'}`
and `RollWidgetDisplay.vue` turns them into the visual breakdown (kept/dropped/max/min classes).
### 5.6 Event bus contract
Every listener in the app (there are only these six `emitter.on` call sites):
| Event | Payload | Listened by |
|---|---|---|
| `toast` | `{color,text,duration}` | `ToastManager.vue` |
| `push-note` | `{key,title,text,date}` | `NoteContainer.vue` |
| `close-note` | note key (string) | `NoteContainer.vue` (removes the note from the open column only) |
| `delete-note` | note key (string) | `NoteContainer.vue`, `ContentSidebar.vue`, `NestedNoteList.vue` (real deletion: closes the note **and** removes it from the sidebar), `MapViewerPane.vue` (drops the markers pinned to that note) |
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue`, `MapViewerPane.vue` (relabels the map pins of that note) |
| `status-bar-update` | `{text,icon}` | `FetchStatus.vue` |
Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue`
(`close-note` — the close button must not use `delete-note` or the sidebar entry disappears),
`NestedNoteList.vue` (`delete-note`, after `POST /note/delete`), `ContentSidebar` (`title-updated`),
`FetchStatus` (self-test emit).
**Orphan events** — emitted, never subscribed to anywhere (the matching handlers `handleNoteCreated` /
`handleNoteRenamed` exist in `ContentSidebar.vue` but were never wired with `emitter.on`; see §9.17):
| Event | Emitted by | Intended handler |
|---|---|---|
| `note-created` | `ContentSidebar.createNote`, `TopSearchBar` | `ContentSidebar.handleNoteCreated` (dead) |
| `note-renamed` | `RenameNoteWindow.vue` | `ContentSidebar.handleNoteRenamed` (dead) |
| `folder-saved` | `NewFolderWindow.vue` | none — sidebar refreshes only via `@reload-notes` from `NestedNoteList` |
So "create note" currently works because the sidebar mutates its own list, and folder changes need an
explicit `fetchCampaignNotes()`. If you rely on an event, check a listener exists.
Note object shape in the UI layer is `{ key, title, text, date }` (mapped from the API's
`{_id,title,content,date}`); convert at the boundary as `ContentSidebar.fetchCampaignNotes` does.
### 5.7 Theming, fonts, icons, sounds
- `useTheme.ts` owns `theme` (`'light'|'dark'`) and `accent` (`'katlum'`, type currently narrow) as
module singletons, persists to `localStorage`, and sets `data-theme` / `data-accent` on `<html>`.
`app.vue` calls `setupTheme()` then forces `setTheme('dark')` on mount.
- `colors.scss` holds Sass maps `dark`/`light` (and accents `katlum`/`solus`/`silang`) emitted as
**`--color-*` CSS variables**. Always style with `var(--color-...)` (`background`,
`window-background`, `button-hover`, `text`, `border`, `icon-invert`, …), never hardcode hex.
- Icons are inverted via `filter: invert(var(--color-icon-invert))` — white SVGs + `.icon` class.
Reference either as public assets (`/icons/iconoir/regular/xmark.svg`, `/icons/ui/...`,
`/icons/Pixelarticons/white/close.svg`) or from the `pixelarticons` npm package
(`import SearchIcon from 'pixelarticons/svg/search.svg'`).
- Fonts (`fonts.scss` + `public/fonts/5e`): `BookInsanityRemake` (body default), `MrEavesRemake`
(headings/window titles), `ScalySansRemake`, `NodestoCapsCondensed`, `SolberaImitationRemake`, etc.
- Sounds in `public/sounds/`: `snap.wav` (the `.sound-click` default), `close.wav`, `click.wav`,
`dice.wav`, `roll1.wav`, `roll2.wav`, `notify.wav`, `drums.wav`, `lock.wav`, `doors/`.
### 5.8 i18n
Locales: `en` (default), `es`, `ca`. Files live at `frontend/i18n/locales/<lang>/<namespace>.json`, and
`app/plugins/i18n.ts` globs them and nests each under its **filename** — so the key is
`<file>.<path>`, e.g. `i18n/locales/en/main-menu.json` → `$t('main-menu.create-campaign')`.
Namespaces in use: `general`, `login`, `register`, `main-menu`, `settings`, `windows`, `campaigns`
(`campaigns` currently only exists for `en`). Call it as `$t(...)` in templates or via `useI18n()` in
script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `WindowHandle` translates them.
**Adding a string = add it to all three locales** (`en`, `es`, `ca`); the Nuxt i18n module is also
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
### 5.9 Obsidian plugin
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
The user selects a campaign from `GET /api/campaign/list`.
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
frontmatter.
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
imports preserve modified local files, and push is explicit.
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
## 6. Conventions
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
are thin Express routers, `models/` one Mongoose schema per file exporting `mongoose.model(...)`.
Every handler is `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
Route logic helpers (like `userOwnsCampaign`) are duplicated per router file today — match that
style unless you refactor both at once.
- **Frontend**: Vue 3 `<script setup>`; PascalCase exported functions in `services/` (`CreateWindow`,
`GetUser`), camelCase locals; PascalCase component filenames; `kebab-case` DOM ids that services
depend on. Both `~/` and `@/` aliases appear in imports (both resolve to `app/`) — follow whatever
the neighbouring file uses.
- Components talk to the API through `Server()` directly (there is no api-layer abstraction); `await`
or `.then` both appear.
- Code comments are mixed English and Catalan ("Moure aixo", "Programar un resizer mitjanament
competent") — do not "translate" unrelated comments while editing.
- No formatter: keep diffs minimal and local; the codebase is deliberately rough.
## 7. Recipes
**New API resource**: add `models/X.js`, `routes/x.js` (with `userOwnsCampaign`-style ownership checks
and the `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js`
**after** the `checkAuth` line if it needs auth.
**New window**: entry in `WindowDefinitions.js` → component in `app/components/windows/` following
§5.2 → open with `CreateWindow('type', data)` or `CreateChildWindow(parentId, 'type', data)` → strings
in `i18n/locales/*/windows.json`.
**New markdown widget**: component in `app/components/viewer/widgets/{inline|display}/`, register in
`widget_map` in `Marker.js`, consume the `content` prop.
**New command-palette action**: `register({id,label,description,execute,isActive?})` from
`~/services/ActionRegistry` (see `registerCreateNoteAction` in `TopSearchBar.vue`); palette opens with
`Ctrl/Cmd+K` or `/`.
**New theme color**: add the key to *both* `dark` and `light` maps in `colors.scss`, use
`var(--color-<key>)`.
## 8. Port map
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` inside
compose, proxying `/` → `frontend:3000`, `/api/` → `backend:5000`.
## 9. Known landmines (verified in code — do not "fix" silently, but never make them worse)
1. `README.md` tells you to run `./install.sh` and `./start.sh`; **neither script exists** in the repo.
2. `frontend/README.md` says the frontend is **React**. It is Nuxt/Vue 3.
3. `services/keys.js` ships a hardcoded JWT secret `"putyoursecrethere"`, used in prod.
4. `src/index.js` sets CORS `origin: 'http://localhost:3000'` only — the production origin
(`https://dragonroll.aranroig.com`) is not whitelisted; in production the nginx same-origin proxy
is what hides this.
5. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not defined
in that scope → ReferenceError → caught → the first-run registration actually returns
`errors.internal`. Fix carefully: the register UI (`RegisterWindow.vue`) drives the first-admin flow.
6. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id).
`folder.js` and the other `note.js` handlers do check.
7. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()`, but **no plugin provides it** —
always import `{ emitter }` from `~/services/Emitter` instead.
8. `ecosystem.config.js` runs `npm start` in both apps; neither package defines a `start` script → PM2
would fail. Compose/nginx is the real deployment path.
9. `/api/user/*` is entirely mounted before the JWT guard (see §4); new user routes are public unless
they call `passport.authenticate('jwt', {session:false})` inline.
10. `checkAuth` in `src/index.js` is assigned without `const` (implicit global).
11. `ClearAll()` in `Windows.js` iterates `Object.keys(windows)` (the ref object, not `.value`) — it
does not behave like the name suggests.
12. `GetWidget`/`getComponent` caches are process-global and never invalidated; new widget/window types
need a dev-server restart if HMR misbehaves.
13. `Windows.js` `SetupHandle` attaches `mousemove`/`mouseup` listeners on `document` for **every**
window and never removes them; they early-return on `win.movable` but still accumulate.
14. `Note.vue` mounts widgets with `createApp` and never unmounts them — leaked apps remain when note
content is re-rendered.
15. `User.js` (frontend) treats the JWT as the user cache: `settings` changes require
`SetUserSetting`/`GetUserSetting` round-trips, the token payload goes stale.
16. `.env.production` files (both apps) are committed and contain internal hosts.
17. `note-created`, `note-renamed` and `folder-saved` are emitted with **no subscribers**; the sidebar's
`handleNoteCreated` / `handleNoteRenamed` are unwired dead code (§5.6). The sidebar refreshes its
tree only on `campaignId` change, on mount, on the manual refresh button, or on `@reload-notes`
from `NestedNoteList.vue`.
18. `SetShowContent` (`services/Content.js`) and `services/middleware.js`'s `isAdmin` are exported /
imported but never used; `ContentManager.vue` never hides the workspace again once shown.

View File

@@ -15,7 +15,7 @@ An open-source helper for role-playing games
# Dragonroll
Dragonroll is an open source connector for role-playing games.
Dragonroll is an open source helper for role-playing games.
## Features
@@ -24,7 +24,6 @@ Dragonroll is an open source connector for role-playing games.
- Play music during physical campaings
- Plan different encounters
- Manage different items and spells
- Import and edit campaign notes in Obsidian with the [Dragonroll Sync plugin](obsidian-plugin/README.md)
- And so much more!
## Installation 🛠️
@@ -50,19 +49,3 @@ or
```
if you want to start the development environments
## TODO
- Dragonroll <-> Foundry integration
- Dragonroll <-> Discord Bot integration
What to sync:
- Actors
- Monsters
- Items
- Notes
- Maps
- Music ?

View File

@@ -1,5 +1,3 @@
PORT=5000
DB_URI=mongodb://192.168.1.7:27017/dragonroll
DB_URI=mongodb://10.1.1.7:27017/dragonroll
NODE_ENV=production
DRAGONROLL_DISCORD_BOT_SECRET=test
DRAGONROLL_FRONTEND_URL=https://dragonroll.aranroig.com

View File

@@ -40,34 +40,13 @@ require('./services/passport')(passport);
// CORS
app.use(cookieParser());
const foundryCorsPaths = [
'/api/foundry/link/complete', '/foundry/link/complete',
'/api/foundry/sync', '/foundry/sync',
];
const foundryCors = cors({
origin: true,
methods: ['GET', 'POST', 'OPTIONS'],
allowedHeaders: ['Authorization', 'Content-Type'],
});
app.use('/api/foundry/link/complete', foundryCors);
app.use('/foundry/link/complete', foundryCors);
app.use('/api/foundry/sync', foundryCors);
app.use('/foundry/sync', foundryCors);
const appCors = cors({
app.use(cors({
origin: 'http://localhost:3000',
credentials: true, // if using cookies/auth
});
app.use((req, res, next) => {
if (foundryCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next();
appCors(req, res, next);
});
}));
// ROUTES (NO AUTH)
app.use('/api/user', require('./routes/user'));
app.use('/api/discord', require('./routes/discord'));
app.use('/api/foundry', require('./routes/foundry-link'));
app.use('/foundry', require('./routes/foundry-link'));
// AUTH
checkAuth = passport.authenticate('jwt', { session: false });
@@ -76,13 +55,9 @@ app.use(checkAuth);
// ROUTES WITH AUTH
app.use('/api/campaign', require('./routes/campaign'));
app.use('/api/note', require('./routes/note'));
app.use('/api/folder', require('./routes/folder'));
app.use('/api/actor', require('./routes/actor'));
app.use('/api/item', require('./routes/item'));
app.use('/api/map', require('./routes/map'));
app.use('/api/foundry', require('./routes/foundry'));
/*
app.use('/campaign', require('./routes/campaign'));
app.use('/maps', require('./routes/map'));
app.use('/datagen', require('./routes/datagen'));
app.use('/admin', require('./routes/admin'));
*/

View File

@@ -1,47 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const ActorSchema = new Schema({
name: { type: String, required: true, trim: true },
type: { type: String, enum: ['character', 'npc', 'creature'], default: 'character' },
species: { type: String, default: '' },
className: { type: String, default: '' },
subclass: { type: String, default: '' },
level: { type: Number, min: 1, max: 20, default: 1 },
background: { type: String, default: '' },
challengeRating: { type: String, default: '' },
description: { type: String, default: '' },
image: { type: String, default: '' },
abilityScores: {
str: { type: Number, min: 1, max: 30, default: 10 },
dex: { type: Number, min: 1, max: 30, default: 10 },
con: { type: Number, min: 1, max: 30, default: 10 },
int: { type: Number, min: 1, max: 30, default: 10 },
wis: { type: Number, min: 1, max: 30, default: 10 },
cha: { type: Number, min: 1, max: 30, default: 10 }
},
armorClass: { type: Number, min: 0, default: 10 },
speed: { type: Number, min: 0, default: 30 },
proficiencies: { type: String, default: '' },
inventory: [{
name: { type: String, trim: true, default: '' },
quantity: { type: Number, min: 1, default: 1 },
weight: { type: Number, min: 0, default: 0 }
}],
traits: { type: String, default: '' },
spells: { type: String, default: '' },
campaign: {
type: Schema.Types.ObjectId,
ref: 'Campaign',
required: true
},
foundryActorId: { type: String },
date: { type: Date, default: Date.now }
});
ActorSchema.index(
{ campaign: 1, foundryActorId: 1 },
{ unique: true, partialFilterExpression: { foundryActorId: { $type: 'string' } } }
);
module.exports = mongoose.model('Actor', ActorSchema);

View File

@@ -11,14 +11,7 @@ const CampaignSchema = new Schema({
required: true
},
date: { type: Date, default: Date.now},
settings: { type: Object },
foundryWorldId: { type: String, unique: true, sparse: true },
foundryWorldTitle: { type: String },
foundrySystem: { type: String },
foundrySyncTokenHash: { type: String, select: false },
// Discord server ("guild") this campaign is linked to. A campaign serves
// at most one guild, and a guild selects one campaign.
discordGuildId: { type: String, index: true }
settings: { type: Object }
});
module.exports = mongoose.model('Campaign', CampaignSchema);

View File

@@ -1,11 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const DiscordGuildLinkSchema = new Schema({
guildId: { type: String, required: true, unique: true, index: true },
discordUserId: { type: String, required: true },
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User', required: true },
connectedAt: { type: Date, default: Date.now }
});
module.exports = mongoose.model('DiscordGuildLink', DiscordGuildLinkSchema);

View File

@@ -1,20 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const DiscordLinkRequestSchema = new Schema({
codeHash: { type: String, required: true, unique: true },
guildId: { type: String, required: true },
guildName: { type: String, required: true },
discordUserId: { type: String, required: true },
discordUserName: { type: String, required: true },
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User' },
createdAt: { type: Date, default: Date.now },
expiresAt: { type: Date, required: true },
completedAt: { type: Date },
// Quan el bot ja ha confirmat a Discord que aquesta autoritzacio s'ha fet.
notifiedAt: { type: Date }
});
DiscordLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
module.exports = mongoose.model('DiscordLinkRequest', DiscordLinkRequestSchema);

View File

@@ -1,19 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const FolderSchema = new Schema({
name: { type: String, required: true },
campaign: {
type: Schema.Types.ObjectId,
ref: 'Campaign',
required: true
},
parentFolder: {
type: Schema.Types.ObjectId,
ref: 'Folder'
},
color: { type: String },
date: { type: Date, default: Date.now }
});
module.exports = mongoose.model('Folder', FolderSchema);

View File

@@ -1,24 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const FoundryLinkRequestSchema = new Schema({
codeHash: { type: String, required: true, unique: true },
// Kept in clear text so the campaign settings screen can re-display a pending
// pairing code after a reload or a backend restart. It is only ever returned
// to the user who created the request and is cleared once the link completes.
code: { type: String },
source: { type: String, enum: ['dragonroll'], required: true },
campaign: { type: Schema.Types.ObjectId, ref: 'Campaign' },
createdBy: { type: Schema.Types.ObjectId, ref: 'User' },
worldId: { type: String },
worldTitle: { type: String },
system: { type: String },
foundryUrl: { type: String },
createdAt: { type: Date, default: Date.now },
expiresAt: { type: Date, required: true },
completedAt: { type: Date }
});
FoundryLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
module.exports = mongoose.model('FoundryLinkRequest', FoundryLinkRequestSchema);

View File

@@ -1,38 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const ItemSchema = new Schema({
name: { type: String, required: true, trim: true },
category: {
type: String,
enum: ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'],
default: 'adventuring-gear'
},
rarity: {
type: String,
enum: ['common', 'uncommon', 'rare', 'very-rare', 'legendary', 'artifact'],
default: 'common'
},
quantity: { type: Number, min: 1, default: 1 },
weight: { type: Number, min: 0 },
properties: { type: String, default: '' },
description: { type: String, default: '' },
campaign: {
type: Schema.Types.ObjectId,
ref: 'Campaign',
required: true
},
foundryItemId: { type: String },
// Names Foundry uses for this item. Dragonroll may rename it, and the copies
// Foundry keeps sending still have to fold into this row instead of
// creating a second item under their original name.
foundryNames: { type: [String], default: [] },
date: { type: Date, default: Date.now }
});
ItemSchema.index(
{ campaign: 1, foundryItemId: 1 },
{ unique: true, partialFilterExpression: { foundryItemId: { $type: 'string' } } }
);
module.exports = mongoose.model('Item', ItemSchema);

View File

@@ -1,30 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const MapSchema = new Schema({
name: { type: String, required: true, trim: true },
// Uploaded image, served from /api/public/<filename>
image: { type: String, default: '' },
// Grid cell size in image pixels
gridSize: { type: Number, min: 1, default: 50 },
// Grid origin, in image pixels from the top left corner of the image
offsetX: { type: Number, default: 0 },
offsetY: { type: Number, default: 0 },
// Distance each grid cell stands for (feet, metres...)
scale: { type: Number, min: 0.01, default: 5 },
// Notes pinned onto the map like markers. x/y are image pixels from the top left corner of the
// image, so a pin keeps its place whatever the zoom or the grid settings are.
pins: [{
note: { type: Schema.Types.ObjectId, ref: 'Note', required: true },
x: { type: Number, default: 0 },
y: { type: Number, default: 0 }
}],
campaign: {
type: Schema.Types.ObjectId,
ref: 'Campaign',
required: true
},
date: { type: Date, default: Date.now }
});
module.exports = mongoose.model('Map', MapSchema);

View File

@@ -9,11 +9,6 @@ const NoteSchema = new Schema({
ref: 'Campaign',
required: true
},
folder: {
type: Schema.Types.ObjectId,
ref: 'Folder'
},
color: { type: String },
date: { type: Date, default: Date.now }
});

View File

@@ -1,111 +0,0 @@
const express = require('express');
const router = express.Router();
const upload = require('../services/storage');
const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor');
async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign);
}
router.get('/list', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', actors });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/create', async (req, res) => {
try {
const { name, campaign, type, species, className, subclass, level, background, challengeRating, description } = req.body;
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const actor = await Actor.create({
name: name.trim(), campaign, type, species, className, subclass,
level: level === '' || level === undefined ? undefined : Number(level),
background, challengeRating, description
});
res.json({ status: 'ok', actor });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/update', async (req, res) => {
try {
const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, proficiencies, inventory, traits, spells, image } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const actor = await Actor.findById(id);
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
if (name !== undefined) actor.name = String(name).trim();
if (species !== undefined) actor.species = species;
if (className !== undefined) actor.className = className;
if (subclass !== undefined) actor.subclass = subclass;
if (level !== undefined) actor.level = Number(level);
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
if (speed !== undefined) actor.speed = Number(speed);
if (proficiencies !== undefined) actor.proficiencies = proficiencies;
if (inventory !== undefined) actor.inventory = inventory;
if (traits !== undefined) actor.traits = traits;
if (spells !== undefined) actor.spells = spells;
if (image !== undefined) actor.image = String(image);
await actor.save();
res.json({ status: 'ok', actor });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Upload actor image post
router.post("/upload-image", upload.single("image"), async (req, res) => {
try {
const actorId = req.query.actor || req.body.actor;
if (!actorId || !req.file) return res.json({ status: 'error', msg: 'errors.missing-data' });
const actor = await Actor.findById(actorId);
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
actor.image = req.file.filename;
await actor.save();
res.json({ status: "ok", msg: "uploaded", actor });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "internal" });
}
});
router.post('/delete', async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const actor = await Actor.findById(id);
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
await actor.deleteOne();
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,25 +1,7 @@
const express = require('express')
const router = express.Router();
const crypto = require('node:crypto');
const Campaign = require("../models/Campaign");
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
const FOUNDRY_LINK_TTL_MS = 10 * 60 * 1000;
function foundryCodeHash(code) {
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
}
async function expirePendingFoundryLinks(campaignId, userId) {
const filter = {
source: 'dragonroll',
campaign: campaignId,
createdBy: userId,
completedAt: null
};
await FoundryLinkRequest.updateMany(filter, { $set: { expiresAt: new Date() } });
}
router.post('/create', async (req, res) => {
try {
@@ -39,133 +21,6 @@ router.post('/create', async (req, res) => {
}
});
router.post('/update', async (req, res) => {
try {
const { id, name, color, settings } = req.body;
if (!id) return res.json({ status: "error", msg: "errors.missing-data" });
const campaign = await Campaign.findOne({ _id: id, createdBy: req.user.id });
if (!campaign) return res.json({ status: "error", msg: "errors.notfound" });
if (name !== undefined) {
if (typeof name !== 'string' || !name.trim()) {
return res.json({ status: "error", msg: "errors.missing-data" });
}
campaign.name = name.trim();
}
if (color !== undefined) {
if (typeof color !== 'string') return res.json({ status: "error", msg: "errors.missing-data" });
campaign.color = color;
}
if (settings !== undefined) {
if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
return res.json({ status: "error", msg: "errors.missing-data" });
}
campaign.settings = settings;
}
await campaign.save();
res.json({ status: "ok", campaign });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "errors.internal" });
}
});
router.post('/foundry-link/start', async (req, res) => {
try {
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
await expirePendingFoundryLinks(campaign._id, req.user.id);
const code = crypto.randomBytes(24).toString('base64url');
const expiresAt = new Date(Date.now() + FOUNDRY_LINK_TTL_MS);
const request = await FoundryLinkRequest.create({
codeHash: foundryCodeHash(code),
code,
source: 'dragonroll',
campaign: campaign._id,
createdBy: req.user.id,
expiresAt
});
res.set('Cache-Control', 'no-store');
res.json({ status: 'ok', code, requestId: request.id, expiresAt });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/foundry-link/status/:requestId', async (req, res) => {
try {
const request = await FoundryLinkRequest.findOne({
_id: req.params.requestId,
source: 'dragonroll',
createdBy: req.user.id
});
if (!request) return res.json({ status: 'ok', state: 'expired' });
if (!request.completedAt && request.expiresAt <= new Date()) {
return res.json({ status: 'ok', state: 'expired' });
}
if (!request.completedAt) return res.json({ status: 'ok', state: 'pending' });
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
res.json({ status: 'ok', state: 'complete', campaign });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Returns the still-valid pending pairing request for a campaign, so the
// settings window can restore its pairing code across reloads and restarts.
router.get('/foundry-link/pending', async (req, res) => {
try {
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const request = await FoundryLinkRequest.findOne({
source: 'dragonroll',
campaign: campaign._id,
createdBy: req.user.id,
completedAt: null,
expiresAt: { $gt: new Date() }
}).sort({ createdAt: -1 });
if (!request) return res.json({ status: 'ok', request: null });
res.set('Cache-Control', 'no-store');
res.json({
status: 'ok',
request: { requestId: request.id, code: request.code, expiresAt: request.expiresAt }
});
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/foundry-unlink', async (req, res) => {
try {
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
campaign.foundryWorldId = undefined;
campaign.foundryWorldTitle = undefined;
campaign.foundrySystem = undefined;
campaign.set('foundrySyncTokenHash', undefined);
await campaign.save();
await expirePendingFoundryLinks(campaign._id, req.user.id);
res.json({ status: 'ok', campaign });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/list', async (req, res) => {
try {
const campaigns = await Campaign.find({ createdBy: req.user.id });

View File

@@ -1,272 +0,0 @@
const crypto = require('node:crypto');
const express = require('express');
const passport = require('passport');
const router = express.Router();
const Actor = require('../models/Actor');
const Campaign = require('../models/Campaign');
const DiscordGuildLink = require('../models/DiscordGuildLink');
const DiscordLinkRequest = require('../models/DiscordLinkRequest');
const User = require('../models/User');
const LINK_TTL_MS = 10 * 60 * 1000;
const NOTIFICATION_WINDOW_MS = 15 * 60 * 1000;
const NOTIFICATION_LIMIT = 10;
function validGuildId(value) {
return /^\d{5,25}$/.test(String(value ?? ''));
}
function codeHash(code) {
return crypto.createHash('sha256').update(String(code ?? '')).digest('hex');
}
function requireBot(req, res, next) {
const configuredSecret = process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '';
const suppliedSecret = req.get('x-dragonroll-discord-bot-secret') || '';
const expected = Buffer.from(configuredSecret);
const supplied = Buffer.from(suppliedSecret);
if (!expected.length || expected.length !== supplied.length || !crypto.timingSafeEqual(expected, supplied)) {
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
}
return next();
}
function frontendAuthorizeUrl() {
const frontendUrl = (process.env.DRAGONROLL_FRONTEND_URL || 'http://localhost:3000').trim().replace(/\/+$/, '');
return `${frontendUrl}/discord/authorize`;
}
// La pantalla d'autorització l'serveix el frontend. El codi viatja al fragment de la URL i el
// navegador no l'envia mai al servidor, així que els enllaços antics del bot arriben a la
// pantalla sense codi i demanen de tornar a executar /dragonroll connect.
router.get('/authorize', (req, res) => {
res.set('Cache-Control', 'no-store');
res.set('Referrer-Policy', 'no-referrer');
res.set('X-Content-Type-Options', 'nosniff');
res.redirect(302, frontendAuthorizeUrl());
});
router.post('/link/start', requireBot, async (req, res) => {
try {
const { guildId, guildName, discordUserId, discordUserName } = req.body;
if (!validGuildId(guildId) || !/^\d{5,25}$/.test(String(discordUserId ?? '')) || !guildName || !discordUserName) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const code = crypto.randomBytes(32).toString('base64url');
await DiscordLinkRequest.create({
codeHash: codeHash(code),
guildId: String(guildId),
guildName: String(guildName).slice(0, 100),
discordUserId: String(discordUserId),
discordUserName: String(discordUserName).slice(0, 100),
expiresAt: new Date(Date.now() + LINK_TTL_MS)
});
res.json({ status: 'ok', code, expiresAt: new Date(Date.now() + LINK_TTL_MS) });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/link/details', async (req, res) => {
try {
res.set('Cache-Control', 'no-store');
const request = await DiscordLinkRequest.findOne({
codeHash: codeHash(req.body.code),
expiresAt: { $gt: new Date() },
completedAt: null
}).lean();
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
res.json({ status: 'ok', guildName: request.guildName, discordUserName: request.discordUserName });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/link/complete', passport.authenticate('jwt', { session: false }), async (req, res) => {
try {
const request = await DiscordLinkRequest.findOneAndUpdate({
codeHash: codeHash(req.body.code),
expiresAt: { $gt: new Date() },
completedAt: null
}, {
$set: { completedAt: new Date(), dragonrollUser: req.user.id }
}, { new: true });
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
await Campaign.updateMany(
{ discordGuildId: request.guildId, createdBy: { $ne: req.user.id } },
{ $unset: { discordGuildId: 1 } }
);
await DiscordGuildLink.findOneAndUpdate({ guildId: request.guildId }, {
$set: {
discordUserId: request.discordUserId,
dragonrollUser: req.user.id,
connectedAt: new Date()
}
}, { new: true, upsert: true, setDefaultsOnInsert: true });
res.json({ status: 'ok', guildName: request.guildName });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
async function dragonrollUserNames(requests) {
const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))];
if (!userIds.length) return new Map();
const users = await User.find({ _id: { $in: userIds } }).select('username name').lean();
return new Map(users.map((user) => [String(user._id), user.username || user.name]));
}
// El bot reclama les autoritzacions ja fetes per confirmar-les a Discord. Marcar-les aqui
// mateix evita que dos processos del bot confirmïn la mateixa vegada.
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
try {
const pending = await DiscordLinkRequest.find({
completedAt: { $gte: new Date(Date.now() - NOTIFICATION_WINDOW_MS) },
notifiedAt: null
}).select('_id guildId guildName discordUserId discordUserName dragonrollUser')
.limit(NOTIFICATION_LIMIT)
.lean();
const claimed = [];
for (const request of pending) {
const taken = await DiscordLinkRequest.findOneAndUpdate(
{ _id: request._id, notifiedAt: null },
{ $set: { notifiedAt: new Date() } },
{ new: true }
).lean();
if (taken) claimed.push(request);
}
const names = await dragonrollUserNames(claimed);
res.json({
status: 'ok',
notifications: claimed.map((request) => ({
id: String(request._id),
guildId: request.guildId,
guildName: request.guildName,
discordUserId: request.discordUserId,
discordUserName: request.discordUserName,
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null
}))
});
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/bot/guild/:guildId/status', requireBot, async (req, res) => {
try {
if (!validGuildId(req.params.guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const link = await DiscordGuildLink.findOne({ guildId: req.params.guildId }).lean();
if (!link) return res.json({ status: 'ok', connected: false, campaign: null });
const campaign = await Campaign.findOne({
discordGuildId: req.params.guildId,
createdBy: link.dragonrollUser
}).select('_id name').lean();
res.json({ status: 'ok', connected: true, campaign });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/bot/guild/:guildId/campaigns', requireBot, async (req, res) => {
try {
if (!validGuildId(req.params.guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const link = await DiscordGuildLink.findOne({ guildId: req.params.guildId }).lean();
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
const campaigns = await Campaign.find({ createdBy: link.dragonrollUser })
.select('_id name discordGuildId')
.sort({ date: -1 })
.lean();
res.json({ status: 'ok', campaigns });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/bot/guild/:guildId/campaign', requireBot, async (req, res) => {
try {
const guildId = String(req.params.guildId);
if (!validGuildId(guildId) || !req.body.campaignId) return res.json({ status: 'error', msg: 'errors.missing-data' });
const link = await DiscordGuildLink.findOne({ guildId }).lean();
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: link.dragonrollUser });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const conflict = await Campaign.findOne({ discordGuildId: guildId, _id: { $ne: campaign._id } }).lean();
if (conflict && String(conflict.createdBy) !== String(link.dragonrollUser)) {
return res.json({ status: 'error', msg: 'campaigns.errors.discord-guild-in-use' });
}
if (campaign.discordGuildId && campaign.discordGuildId !== guildId) {
return res.json({ status: 'error', msg: 'discord.errors.campaign-already-linked' });
}
await Campaign.updateMany(
{ discordGuildId: guildId, createdBy: link.dragonrollUser, _id: { $ne: campaign._id } },
{ $unset: { discordGuildId: 1 } }
);
campaign.discordGuildId = guildId;
await campaign.save();
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name } });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.delete('/bot/guild/:guildId/campaign', requireBot, async (req, res) => {
try {
const guildId = String(req.params.guildId);
if (!validGuildId(guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const link = await DiscordGuildLink.findOne({ guildId }).lean();
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
campaign.discordGuildId = undefined;
await campaign.save();
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name } });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/bot/guild/:guildId/actors', requireBot, async (req, res) => {
try {
const guildId = String(req.params.guildId);
if (!validGuildId(guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const link = await DiscordGuildLink.findOne({ guildId }).lean();
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const actors = await Actor.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name }, actors });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,128 +0,0 @@
const express = require('express');
const router = express.Router();
const Campaign = require('../models/Campaign');
const Folder = require('../models/Folder');
const Note = require('../models/Note');
async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign);
}
router.get('/list', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
const folders = await Folder.find({ campaign })
.select('_id name date color')
.sort({ date: -1 })
.lean();
res.json({ status: 'ok', folders });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/create', async (req, res) => {
try {
const { name, campaign } = req.body;
if (!name || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
const newFolder = new Folder({
name: name.trim(),
campaign
});
await newFolder.save();
res.json({ status: 'ok', folder: newFolder });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/update', async (req, res) => {
try {
const { id, name, color } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const folder = await Folder.findById(id);
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
if (name !== undefined) folder.name = String(name).trim();
if (color !== undefined) folder.color = color;
await folder.save();
res.json({ status: 'ok', folder });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/delete', async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const folder = await Folder.findById(id);
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
async function moveRecursive(folderId) {
const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean();
await Note.updateMany(
{ folder: folderId },
{ $set: { folder: null, date: Date.now() } }
);
await Folder.deleteOne({ _id: folderId });
for (const sub of subfolders) {
await moveRecursive(sub._id);
}
}
await moveRecursive(id);
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/rename', async (req, res) => {
try {
const { id, name } = req.body;
if (!id || !name) return res.json({ status: 'error', msg: 'errors.missing-data' });
const folder = await Folder.findById(id);
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
folder.name = name.trim();
await folder.save();
res.json({ status: 'ok', folder });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,428 +0,0 @@
const crypto = require('node:crypto');
const express = require('express');
const rateLimit = require('express-rate-limit');
const mongoose = require('mongoose');
const router = express.Router();
const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor');
const Item = require('../models/Item');
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
const { foundryActorToCharacter } = require('../services/actor-foundry');
const { foundryItemToItemData } = require('../services/item-foundry');
const linkRateLimit = rateLimit({ windowMs: 15 * 60 * 1000, max: 20 });
// Upper bound for the Foundry names remembered per synced item (see Item model).
const MAX_FOUNDRY_NAMES = 20;
function codeHash(code) {
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
}
function readSyncToken(req) {
const match = /^Bearer\s+(.+)$/i.exec(req.get('authorization') || '');
return match?.[1] || '';
}
async function syncCampaign(req, res) {
const token = readSyncToken(req);
if (!token) {
res.json({ status: 'error', msg: 'unauthorized' });
return null;
}
const campaign = await Campaign.findOne({ foundrySyncTokenHash: codeHash(token) });
if (!campaign?.foundryWorldId) {
res.json({ status: 'error', msg: 'unauthorized' });
return null;
}
return campaign;
}
function requestMatchesWorld(campaign, worldId) {
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
}
async function saveFoundryActor(campaign, source, fullSync = false) {
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
const fields = foundryActorToCharacter(source || {});
if (!foundryActorId || !fields.name) return null;
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
if (!actor && mongoose.isValidObjectId(dragonrollActorId)) {
actor = await Actor.findOne({ _id: dragonrollActorId, campaign: campaign._id });
}
if (!actor) {
const possibleMatches = await Actor.find({
campaign: campaign._id,
name: fields.name,
foundryActorId: { $exists: false }
}).limit(2);
actor = possibleMatches.length === 1
? possibleMatches[0]
: new Actor({ campaign: campaign._id });
}
actor.foundryActorId = foundryActorId;
// A full snapshot runs when a GM reconnects. Preserve existing Dragonroll
// edits then; live Foundry change events continue to overwrite normally.
if (!fullSync || actor.isNew) Object.assign(actor, fields);
await actor.save();
return { foundryActorId, actorId: actor.id };
}
// A snapshot carries world-level items plus the items embedded in every actor it
// sends. World items are listed first so they own a name before its copies.
function snapshotItemSources(body) {
const sources = [];
if (Array.isArray(body.items)) sources.push(...body.items);
if (Array.isArray(body.actors)) {
for (const actor of body.actors) {
if (Array.isArray(actor?.items)) sources.push(...actor.items);
}
}
return sources;
}
async function saveFoundryItem(campaign, source, fullSync = false) {
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
const fields = foundryItemToItemData(source || {});
if (!foundryItemId || !fields) return null;
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
if (!item && mongoose.isValidObjectId(dragonrollItemId)) {
const flagged = await Item.findOne({ _id: dragonrollItemId, campaign: campaign._id });
// Only adopt a flagged item while no other Foundry document owns its mapping.
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
}
if (!item) {
// The same gear exists more than once in Foundry: once in the world
// directory and once inside each actor carrying it. Keep a single
// Dragonroll item per name so inventories do not flood the Item list.
const sameName = await Item.find({
campaign: campaign._id,
$or: [{ name: fields.name }, { foundryNames: fields.name }]
}).limit(4);
const represented = sameName.find((candidate) => candidate.foundryItemId);
if (represented) return { foundryItemId, itemId: represented.id };
const unclaimed = sameName.filter((candidate) => !candidate.foundryItemId);
item = unclaimed.length === 1 ? unclaimed[0] : new Item({ campaign: campaign._id, name: fields.name });
}
item.foundryItemId = foundryItemId;
if (!fullSync || item.isNew) Object.assign(item, fields);
if (!item.foundryNames.includes(fields.name)) {
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
}
await item.save();
return { foundryItemId, itemId: item.id };
}
async function syncFoundryItems(campaign, sources, fullSync = false) {
const items = [];
for (const source of sources) {
const mapping = await saveFoundryItem(campaign, source, fullSync);
if (mapping) items.push(mapping);
}
return items;
}
function readWorld(body) {
const world = body?.world;
if (!world || typeof world.id !== 'string' || !world.id.trim()) return null;
let foundryUrl = '';
if (typeof world.url === 'string') {
try {
const url = new URL(world.url);
if (url.protocol === 'http:' || url.protocol === 'https:') foundryUrl = url.origin;
} catch {}
}
return {
worldId: world.id.trim().slice(0, 120),
worldTitle: typeof world.title === 'string' ? world.title.trim().slice(0, 200) : '',
system: typeof world.system === 'string' ? world.system.trim().slice(0, 120) : '',
foundryUrl
};
}
async function attachWorldToCampaign(campaign, world) {
const linkedElsewhere = await Campaign.findOne({
foundryWorldId: world.worldId,
_id: { $ne: campaign._id }
}).select('_id');
if (linkedElsewhere) return false;
campaign.foundryWorldId = world.worldId;
campaign.foundryWorldTitle = world.worldTitle;
campaign.foundrySystem = world.system;
if (world.foundryUrl) {
const settings = campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {};
const integrations = settings.integrations && typeof settings.integrations === 'object'
? settings.integrations
: {};
campaign.settings = {
...settings,
integrations: {
...integrations,
foundryUrl: integrations.foundryUrl || world.foundryUrl
}
};
}
await campaign.save();
return true;
}
async function expireOtherPendingLinks(campaignId, userId, requestId) {
await FoundryLinkRequest.updateMany({
source: 'dragonroll',
campaign: campaignId,
createdBy: userId,
completedAt: null,
_id: { $ne: requestId }
}, { $set: { expiresAt: new Date() } });
}
router.post('/link/complete', linkRateLimit, async (req, res) => {
try {
const world = readWorld(req.body);
if (!world || typeof req.body.code !== 'string' || !req.body.code.trim()) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const request = await FoundryLinkRequest.findOne({
codeHash: codeHash(req.body.code),
source: 'dragonroll',
expiresAt: { $gt: new Date() },
completedAt: null
});
if (!request) return res.json({ status: 'error', msg: 'foundry.errors.link-expired' });
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: request.createdBy });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const attached = await attachWorldToCampaign(campaign, world);
if (!attached) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
const syncToken = crypto.randomBytes(32).toString('base64url');
campaign.foundrySyncTokenHash = codeHash(syncToken);
await campaign.save();
request.worldId = world.worldId;
request.worldTitle = world.worldTitle;
request.system = world.system;
request.foundryUrl = world.foundryUrl;
request.completedAt = new Date();
request.code = undefined; // Redeemed: keep only the hash from now on.
await request.save();
await expireOtherPendingLinks(campaign._id, request.createdBy, request._id);
const bridgeUrl = process.env.FOUNDRY_API_CLIENT_URL || process.env.FOUNDRY_API_URL;
const pushToken = process.env.FOUNDRY_API_PUSH_TOKEN;
res.set('Cache-Control', 'no-store');
res.json({
status: 'ok',
campaign: { id: campaign.id, name: campaign.name },
world: { id: world.worldId, title: world.worldTitle, system: world.system },
syncToken,
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
});
} catch (err) {
console.error(err);
if (err.code === 11000) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// The Foundry module shows this in its settings: the sync token alone only proves
// a link was made once, so the module asks which campaign it belongs to and hears
// back nothing but `unauthorized` once that campaign unlinks the world again.
router.get('/sync/status', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
res.set('Cache-Control', 'no-store');
res.json({
status: 'ok',
campaign: { id: campaign.id, name: campaign.name },
worldId: campaign.foundryWorldId
});
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/sync/snapshot', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const actorSources = Array.isArray(req.body.actors) ? req.body.actors : null;
const itemSources = Array.isArray(req.body.items) ? req.body.items : null;
if (!requestMatchesWorld(campaign, req.body.worldId) || (!actorSources && !itemSources)) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const fullSync = req.body.fullSync === true;
const actors = [];
for (const source of actorSources || []) {
const mapping = await saveFoundryActor(campaign, source, fullSync);
if (mapping) actors.push(mapping);
}
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync);
if (fullSync && actorSources) {
const currentIds = actorSources
.map((source) => String(source?._id || source?.id || '').trim())
.filter(Boolean);
await Actor.deleteMany({
campaign: campaign._id,
foundryActorId: { $exists: true, $nin: currentIds }
});
}
// Pruning needs a full snapshot: only that request sees the world
// directory and every actor's copies at the same time.
if (fullSync && itemSources) {
const currentIds = snapshotItemSources(req.body)
.map((source) => String(source?._id || source?.id || '').trim())
.filter(Boolean);
await Item.deleteMany({
campaign: campaign._id,
foundryItemId: { $exists: true, $nin: currentIds }
});
}
res.json({ status: 'ok', actors, items });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Live Foundry item edits: upserts only, never prunes. Removing items that no
// longer exist is left to the full snapshot sent with the actors.
router.post('/sync/item-snapshot', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.items)) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items) });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/sync/delete', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const foundryActorId = String(req.body.foundryActorId || '').trim();
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundryActorId) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
await Actor.deleteOne({ campaign: campaign._id, foundryActorId });
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/sync/characters', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const actors = await Actor.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
res.json({ status: 'ok', actors });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/sync/map', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const { actorId, foundryActorId, worldId } = req.body;
if (!requestMatchesWorld(campaign, worldId) || !actorId || !foundryActorId) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const actor = await Actor.findOne({ _id: actorId, campaign: campaign._id });
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
const existing = await Actor.findOne({ campaign: campaign._id, foundryActorId, _id: { $ne: actor._id } });
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.actor-already-synced' });
actor.foundryActorId = String(foundryActorId).trim().slice(0, 120);
await actor.save();
res.json({ status: 'ok', actor });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Only world-level Foundry items reach this route: an item dropped by an actor
// still exists in the world, and its actor snapshot overwrites the inventory.
router.post('/sync/item-delete', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const foundryItemId = String(req.body.foundryItemId || '').trim();
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundryItemId) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
await Item.deleteOne({ campaign: campaign._id, foundryItemId });
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/sync/items', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
res.json({ status: 'ok', items });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/sync/map-item', async (req, res) => {
try {
const campaign = await syncCampaign(req, res);
if (!campaign) return;
const { itemId, foundryItemId, worldId } = req.body;
if (!requestMatchesWorld(campaign, worldId) || !itemId || !foundryItemId) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const item = await Item.findOne({ _id: itemId, campaign: campaign._id });
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
const existing = await Item.findOne({ campaign: campaign._id, foundryItemId, _id: { $ne: item._id } });
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.item-already-synced' });
item.foundryItemId = String(foundryItemId).trim().slice(0, 120);
await item.save();
res.json({ status: 'ok', item });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,27 +0,0 @@
const express = require('express');
const router = express.Router();
const { requestFoundry } = require('../services/foundry');
async function proxy(path, res) {
try {
const result = await requestFoundry(path);
res.status(result.status).json(result.data);
} catch (err) {
if (err.code === 'FOUNDRY_NOT_CONFIGURED') {
return res.status(503).json({ status: 'error', msg: 'foundry.not-configured' });
}
console.error(err);
res.status(502).json({ status: 'error', msg: 'foundry.unavailable' });
}
}
router.get('/world', (req, res) => proxy('api/world', res));
router.get('/actors', (req, res) => proxy('api/actors', res));
router.get('/characters', (req, res) => proxy('api/characters', res));
router.get('/items', (req, res) => proxy('api/items', res));
router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}/items`, res));
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
module.exports = router;

View File

@@ -1,85 +0,0 @@
const express = require('express');
const router = express.Router();
const Campaign = require('../models/Campaign');
const Item = require('../models/Item');
async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign);
}
router.get('/list', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const items = await Item.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', items });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/create', async (req, res) => {
try {
const { name, campaign, category, rarity, quantity, weight, properties, description } = req.body;
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const item = await Item.create({
name: name.trim(), campaign, category, rarity,
quantity: quantity === '' || quantity === undefined ? 1 : Number(quantity),
weight: weight === '' || weight === undefined ? undefined : Number(weight),
properties, description
});
res.json({ status: 'ok', item });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/update', async (req, res) => {
try {
const { id, name, category, rarity, quantity, weight, properties, description } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const item = await Item.findById(id);
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
if (name !== undefined) item.name = String(name).trim();
if (category !== undefined) item.category = category;
if (rarity !== undefined) item.rarity = rarity;
if (quantity !== undefined && quantity !== '') item.quantity = Number(quantity);
if (weight !== undefined && weight !== '') item.weight = Number(weight);
if (properties !== undefined) item.properties = properties;
if (description !== undefined) item.description = description;
await item.save();
res.json({ status: 'ok', item });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/delete', async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const item = await Item.findById(id);
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
await item.deleteOne();
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,155 +0,0 @@
const express = require('express');
const router = express.Router();
const upload = require('../services/storage');
const Campaign = require('../models/Campaign');
const Map = require('../models/Map');
const Note = require('../models/Note');
async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign);
}
// Grid values arrive as strings when the request is a multipart form upload.
function toNumber(value, fallback) {
if (value === undefined || value === null || value === '') return fallback;
const number = Number(value);
return Number.isFinite(number) ? number : fallback;
}
router.get('/list', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', maps });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/create', upload.single('image'), async (req, res) => {
try {
const { name, campaign, gridSize, offsetX, offsetY, scale } = req.body;
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const map = await Map.create({
name: name.trim(), campaign,
image: req.file ? req.file.filename : '',
gridSize: toNumber(gridSize, 50),
offsetX: toNumber(offsetX, 0),
offsetY: toNumber(offsetY, 0),
scale: toNumber(scale, 5)
});
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/update', upload.single('image'), async (req, res) => {
try {
const { id, name, gridSize, offsetX, offsetY, scale } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
if (name !== undefined) map.name = String(name).trim();
if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
if (offsetY !== undefined) map.offsetY = toNumber(offsetY, map.offsetY);
if (scale !== undefined) map.scale = toNumber(scale, map.scale);
if (req.file) map.image = req.file.filename;
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/delete', async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
await map.deleteOne();
res.json({ status: 'ok' });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// A pin is a note placed at a spot of the map, in image pixels. Coordinates arrive as strings with
// multipart requests and are never negative: the viewer clamps them to the image already.
function toCoordinate(value) {
const number = Number(value);
if (!Number.isFinite(number)) return 0;
return Math.max(0, Math.round(number));
}
router.post('/pin', async (req, res) => {
try {
const { id, note, x, y } = req.body;
if (!id || !note) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// Only a note of the same campaign can be pinned onto one of its maps.
const noteDoc = await Note.findOne({ _id: note, campaign: map.campaign }).select('_id').lean();
if (!noteDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
// A note is pinned once per map: pinning it again moves the marker instead of adding a twin.
const pin = map.pins.find((current) => String(current.note) === String(note));
if (pin) {
pin.x = toCoordinate(x);
pin.y = toCoordinate(y);
} else {
map.pins.push({ note, x: toCoordinate(x), y: toCoordinate(y) });
}
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/unpin', async (req, res) => {
try {
const { id, pin } = req.body;
if (!id || !pin) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// `_id` stays with the pins that remain: the viewer removes them by that id.
map.pins = map.pins
.filter((current) => String(current._id) !== String(pin))
.map((current) => ({ _id: current._id, note: current.note, x: current.x, y: current.y }));
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -1,10 +1,8 @@
const express = require('express');
const router = express.Router();
const Campaign = require('../models/Campaign');
const Note = require('../models/Note');
const Folder = require('../models/Folder');
const Map = require('../models/Map');
const Campaign = require("../models/Campaign");
const Note = require("../models/Note");
async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
@@ -14,162 +12,74 @@ async function userOwnsCampaign(campaignId, userId) {
router.get('/list', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (!campaign) return res.json({ status: "error", msg: "errors.missing-data" });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
const folders = await Folder.find({ campaign })
.select('_id name parentFolder date color')
.sort({ date: -1 })
.lean();
const rootNotes = await Note.find({ campaign, folder: null })
.select('_id title content date color')
.sort({ date: -1 })
.lean();
res.json({ status: 'ok', folders, notes: rootNotes });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/subfolder/list', async (req, res) => {
try {
const { campaign, folder } = req.query;
if (!campaign || !folder) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
// Verify folder belongs to campaign
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
const subfolders = await Folder.find({ campaign, parentFolder: folder })
.select('_id name date color')
.sort({ date: -1 })
.lean();
const notes = await Note.find({ campaign, folder: folder })
.select('_id title content date color')
.sort({ date: -1 })
.lean();
res.json({ status: 'ok', subfolders, notes });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Every note of the campaign, folders included, without their content: enough to offer a note
// picker and to label the pins other screens put on a map.
router.get('/all', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
const notes = await Note.find({ campaign })
.select('_id title folder date')
.sort({ title: 1 })
.select('_id title content date campaign')
.sort({ date: -1 })
.lean();
const folders = await Folder.find({ campaign })
.select('_id name parentFolder')
.lean();
res.json({ status: 'ok', notes, folders });
res.json({ status: "ok", notes });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// One note with its content, for the screens that show a note on their own (a map pin, for
// instance) instead of from the sidebar's note list.
router.get('/retrieve/:id', async (req, res) => {
try {
const note = await Note.findById(req.params.id).lean();
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
res.json({ status: 'ok', note });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
res.json({ status: "error", msg: "errors.internal" });
}
});
router.post('/create', async (req, res) => {
try {
const { title, content, campaign, folder } = req.body;
if (!title || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
const { title, content, campaign } = req.body;
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
let effectiveFolder = null;
if (folder) {
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
effectiveFolder = folder;
}
const newNote = new Note({ title, content, campaign, folder: effectiveFolder });
const newNote = new Note({
title,
content,
campaign
});
await newNote.save();
res.json({ status: 'ok', note: newNote });
res.json({ status: "ok", note: newNote });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
res.json({ status: "error", msg: "errors.internal" });
}
});
router.post('/update', async (req, res) => {
try {
const { id, title, content, folder, color } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const { id, title, content } = req.body;
const note = await Note.findById(id);
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!note) return res.json({ status: "error", msg: "errors.notfound" });
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
if (title !== undefined) note.title = title;
if (content !== undefined) note.content = content;
if (folder !== undefined) note.folder = folder;
if (color !== undefined) note.color = color;
if(title) note.title = title;
note.content = content;
note.date = Date.now();
await note.save();
res.json({ status: 'ok', note });
res.json({ status: "ok", note });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
res.json({ status: "error", msg: "errors.internal" });
}
});
router.post('/delete', async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const note = await Note.findById(id);
if (!note) return res.json({ status: "error", msg: "errors.notfound" });
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
const result = await Note.deleteOne({ _id: id });
if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' });
// A pin pointing at a note that is gone would open nothing: drop those along with the note.
await Map.updateMany({ 'pins.note': id }, { $pull: { pins: { note: id } } });
res.json({ status: 'ok' });
await note.remove();
res.json({ status: "ok" });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
res.json({ status: "error", msg: "errors.internal" });
}
});

View File

@@ -1,56 +0,0 @@
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
function foundryActorToCharacter(foundryActor) {
const system = foundryActor.system || {};
const details = system.details || {};
const abilities = system.abilities || {};
const attributes = system.attributes || {};
const movement = attributes.movement || {};
const items = Array.isArray(foundryActor.items) ? foundryActor.items : [];
const classItem = items.find((item) => item.type === 'class');
const subclassItem = items.find((item) => item.type === 'subclass');
const backgroundItem = items.find((item) => item.type === 'background');
const traits = system.traits || {};
const savedDragonrollFields = foundryActor.flags?.['dragonroll-foundry'] || {};
const savedDragonrollType = savedDragonrollFields.actorType;
const foundryProficiencies = [
...stringList(traits.languages?.value),
...stringList(traits.armor?.value),
...stringList(traits.weapon?.value),
...stringList(traits.tool?.value)
].join(', ');
return {
name: asText(foundryActor.name).trim(),
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
? savedDragonrollType
: (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'),
species: asText(details.race || details.species),
className: asText(details.class || classItem?.name),
subclass: asText(details.subclass || subclassItem?.name),
level: numberOr(details.level ?? classItem?.system?.levels, 1),
background: asText(details.background || backgroundItem?.name),
challengeRating: String(details.cr ?? ''),
description: plainText(details.biography?.value || details.biography),
image: asText(foundryActor.img || foundryActor.image),
abilityScores: Object.fromEntries(['str', 'dex', 'con', 'int', 'wis', 'cha'].map((key) => [
key,
numberOr(abilities[key]?.value, 10)
])),
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
speed: numberOr(movement.walk ?? movement.value, 30),
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
traits: asText(savedDragonrollFields.traits),
inventory: items
.filter((item) => !['class', 'subclass', 'background', 'spell'].includes(item.type))
.map((item) => ({
name: asText(item.name).trim(),
quantity: numberOr(item.system?.quantity, 1),
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0)
}))
.filter((item) => item.name),
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
};
}
module.exports = { foundryActorToCharacter };

View File

@@ -1,32 +0,0 @@
// Small helpers shared by the Foundry -> Dragonroll document mappers
// (services/actor-foundry.js and services/item-foundry.js).
function numberOr(value, fallback) {
const number = Number(value);
return Number.isFinite(number) ? number : fallback;
}
function asText(value) {
return typeof value === 'string' ? value : '';
}
function plainText(value) {
return asText(value)
.replace(/<br\s*\/?>/gi, '\n')
.replace(/<\/p\s*>/gi, '\n')
.replace(/<[^>]*>/g, ' ')
.replace(/&nbsp;/gi, ' ')
.replace(/&amp;/gi, '&')
.replace(/&lt;/gi, '<')
.replace(/&gt;/gi, '>')
.replace(/\s+\n/g, '\n')
.trim();
}
function stringList(value) {
if (Array.isArray(value)) return value.map(asText).filter(Boolean);
if (typeof value === 'string') return [value];
return [];
}
module.exports = { numberOr, asText, plainText, stringList };

View File

@@ -1,34 +0,0 @@
async function requestFoundry(path) {
const baseUrl = process.env.FOUNDRY_API_URL;
const token = process.env.FOUNDRY_API_TOKEN;
if (!baseUrl || !token) {
const error = new Error('Foundry API is not configured.');
error.code = 'FOUNDRY_NOT_CONFIGURED';
throw error;
}
const normalizedBase = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;
const url = new URL(path.replace(/^\/+/, ''), normalizedBase);
const response = await fetch(url, {
headers: {
'Accept': 'application/json',
'Authorization': `Bearer ${token}`
},
signal: AbortSignal.timeout(10000)
});
const body = await response.text();
let data;
try {
data = JSON.parse(body);
} catch {
const error = new Error('Foundry API returned an invalid response.');
error.code = 'FOUNDRY_INVALID_RESPONSE';
throw error;
}
return { status: response.status, data };
}
module.exports = { requestFoundry };

View File

@@ -1,108 +0,0 @@
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
// Foundry item types that are gear, mapped to a Dragonroll Item category.
// `equipment` is resolved into armor / shield from its armor type.
const CATEGORY_BY_FOUNDRY_TYPE = {
weapon: 'weapon',
equipment: 'equipment',
consumable: 'consumable',
tool: 'tool',
container: 'adventuring-gear',
loot: 'treasure',
// Item types from older D&D 5e system releases.
ammo: 'weapon',
potion: 'consumable',
poison: 'consumable',
scroll: 'consumable',
trinket: 'magic-item',
backpack: 'adventuring-gear'
};
// Foundry item types that are not gear: they never become Dragonroll items.
const NON_GEAR_FOUNDRY_TYPES = new Set([
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
]);
// Item categories the Dragonroll Item model accepts.
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
const RARITY_BY_FOUNDRY_VALUE = {
common: 'common',
uncommon: 'uncommon',
rare: 'rare',
'very-rare': 'very-rare',
veryrare: 'very-rare',
'very rare': 'very-rare',
legendary: 'legendary',
artifact: 'artifact'
};
// Fallback labels for weapon properties when the Foundry client did not send the
// ones from its own CONFIG (see serializeFoundryItem in the module).
const WEAPON_PROPERTY_LABELS = {
amm: 'ammunition',
fin: 'finesse',
foc: 'focus',
hvy: 'heavy',
lrp: 'long range',
lod: 'loading',
nid: 'noisy',
rch: 'reach',
rel: 'reload',
ret: 'retractable',
slo: 'slow firing',
thr: 'thrown',
thv: 'thrown',
two: 'two-handed',
ver: 'versatile'
};
function foundryItemRarity(foundryItem) {
const rarity = asText(foundryItem.system?.rarity).toLowerCase().trim();
return RARITY_BY_FOUNDRY_VALUE[rarity] || 'common';
}
// Returns null for Foundry documents that are not gear so the sync can skip them.
function foundryItemCategory(foundryItem, rarity) {
const type = asText(foundryItem.type).toLowerCase().trim();
if (NON_GEAR_FOUNDRY_TYPES.has(type)) return null;
if (type === 'equipment') {
return asText(foundryItem.system?.armor?.type).toLowerCase() === 'shield' ? 'shield' : 'armor';
}
const category = CATEGORY_BY_FOUNDRY_TYPE[type];
if (CATEGORIES.includes(category)) return category;
// Systems the module does not know about still get a usable Dragonroll item.
return rarity === 'common' ? 'other' : 'magic-item';
}
function foundryItemProperties(foundryItem) {
const provided = stringList(foundryItem.dragonroll?.properties);
if (provided.length) return provided.join(', ');
const properties = stringList(foundryItem.system?.properties?.value ?? foundryItem.system?.properties);
return properties.map((property) => {
const key = property.toLowerCase();
return Object.hasOwn(WEAPON_PROPERTY_LABELS, key) ? WEAPON_PROPERTY_LABELS[key] : property;
}).join(', ');
}
function foundryItemToItemData(foundryItem) {
const system = foundryItem.system || {};
const name = asText(foundryItem.name).trim();
const rarity = foundryItemRarity(foundryItem);
const category = foundryItemCategory(foundryItem, rarity);
if (!name || !category) return null;
return {
name,
category,
rarity,
quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))),
weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)),
properties: foundryItemProperties(foundryItem),
description: plainText(system.description?.value ?? system.description)
};
}
module.exports = { foundryItemToItemData };

View File

@@ -1,7 +0,0 @@
node_modules
.env
.env.*
!.env.example
npm-debug.log*
Dockerfile
.dockerignore

View File

@@ -1,14 +0,0 @@
# Create a bot application at https://discord.com/developers/applications
DISCORD_TOKEN=
DISCORD_CLIENT_ID=
# Dragonroll API URL including /api. For local development:
DRAGONROLL_API_URL=http://localhost:5000/api
# Frontend address people open when they click the sign-in button in Discord. The
# frontend then talks to the API above. Set this when the frontend is not reachable
# at the API address.
DRAGONROLL_FRONTEND_URL=http://localhost:3000
# Generate a long random value and set the same value in the backend
# environment as DRAGONROLL_DISCORD_BOT_SECRET.
DRAGONROLL_DISCORD_BOT_SECRET=replace-with-a-long-random-secret

View File

@@ -1,3 +0,0 @@
.env
node_modules/
npm-debug.log*

View File

@@ -1,22 +0,0 @@
# Use official Node.js runtime
FROM node:20-alpine
# Create app directory
WORKDIR /usr/src/app
# Copy package files first (better caching)
COPY package*.json ./
# Install dependencies
RUN npm ci --only=production
# Copy application source
COPY . .
# Environment variable
ENV NODE_ENV=production
# The bot only makes outbound connections (Discord gateway + Dragonroll API),
# it does not listen on a port.
# Start the application
CMD ["node", "src/index.js"]

View File

@@ -1,48 +0,0 @@
# Dragonroll Discord bot
A read-only Discord bot for consulting actors (characters, NPCs, and creatures) from Dragonroll. It talks to Dragonroll through authenticated API endpoints; it does not connect to MongoDB directly.
## Configure one campaign per Discord server
The bot can sit in as many Discord servers as you like. A Discord **Administrator** connects their own Dragonroll account with `/dragonroll connect`, signs in on Dragonroll’s site, then chooses one of their campaigns with `/dragonroll link`. The bot posts an ephemeral confirmation in Discord as soon as the authorization goes through. Dragonroll remembers the account and campaign for that guild. The bot never stores the Dragonroll user's password or token.
```
Discord server A ──link──▶ Dragonroll campaign "Katlum" (account gm-a@example.com)
Discord server B ──link──▶ Dragonroll campaign "Silang" (account gm-b@example.com)
```
## Commands
- `/characters [type]` lists the linked campaign's actors, optionally filtered to characters, NPCs, or creatures.
- `/character name public:true` shows the matching actor's portrait (when one has been uploaded), profile, ability scores, combat stats, proficiencies, traits, spells, and inventory. Type part of a name to pick it from the campaign's current roster. Set `public` to `true` to show the reply to everyone in the channel.
- `/dragonroll connect` starts a short-lived Dragonroll sign-in and authorization link, and confirms here once somebody authorizes the server.
- `/dragonroll link` lets a server administrator choose a campaign owned by the connected Dragonroll account. Type part of a campaign name to filter the choices.
- `/dragonroll unlink` removes this server’s campaign link.
- `/dragonroll status` shows the campaign linked to this server.
- `/dragonroll refresh` rechecks the current connection and campaign in Dragonroll.
Replies are private by default. `/character` can be made public with its `public` option, so everyone in the channel can see the character sheet.
## Setup
1. Create a Discord application and bot in the [Discord Developer Portal](https://discord.com/developers/applications). It only needs permission to use application commands and send replies.
2. Generate a long random shared secret. Set it as `DRAGONROLL_DISCORD_BOT_SECRET` in both the backend environment and the bot's `.env`. This authenticates the bot service; it is not a Dragonroll user account.
3. Copy `.env.example` to `.env` and enter the Discord token, application id, API URL, frontend URL, and shared secret. `DRAGONROLL_API_URL` must be reachable by the bot. `DRAGONROLL_FRONTEND_URL` is the address people open when they click the sign-in button, and it defaults to `http://localhost:3000`. Keep `.env` private.
4. Invite the bot to each server with the `bot` and `applications.commands` scopes. A Discord Administrator runs `/dragonroll connect`, opens the Dragonroll button, signs in and confirms the server link, then returns to Discord and runs `/dragonroll link` to select a campaign they own. Each campaign can be linked to one server at a time.
5. Install packages and register the slash commands:
```sh
npm install
npm run deploy-commands
```
Commands are registered globally, so every server the bot is in can use them. Global registration can take up to an hour to propagate; the bot also registers the commands itself as soon as it joins a server, and refreshes them in every server on each start so command changes reach guild commands too. For quick testing on one server only: `npm run deploy-commands -- --guild <server id>` (note that those guild commands then shadow the global ones in that server).
6. From the repository root, start the backend, frontend, and Discord bot together:
```sh
npm run dev
```
To run only the bot, start the backend first and use `npm start` from `discord-bot/`.
The bot can start without any Dragonroll user account. It uses the shared service secret for guild-scoped API calls, so configure the secret in both environments before using Dragonroll commands. Dragonroll user credentials are entered only on Dragonroll's site and are not sent through Discord. The bot needs outbound access to both the Dragonroll API and Discord.

View File

@@ -1,327 +0,0 @@
{
"name": "dragonroll-discord-bot",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "dragonroll-discord-bot",
"version": "1.0.0",
"dependencies": {
"discord.js": "^14.27.0",
"dotenv": "^17.2.3"
},
"engines": {
"node": ">=20"
}
},
"node_modules/@discordjs/builders": {
"version": "1.14.1",
"resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-1.14.1.tgz",
"integrity": "sha512-gSKkhXLqs96TCzk66VZuHHl8z2bQMJFGwrXC0f33ngK+FLNau4hU1PYny3DNJfNdSH+gVMzE85/d5FQ2BpcNwQ==",
"license": "Apache-2.0",
"dependencies": {
"@discordjs/formatters": "^0.6.2",
"@discordjs/util": "^1.2.0",
"@sapphire/shapeshift": "^4.0.0",
"discord-api-types": "^0.38.40",
"fast-deep-equal": "^3.1.3",
"ts-mixer": "^6.0.4",
"tslib": "^2.6.3"
},
"engines": {
"node": ">=16.11.0"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/collection": {
"version": "1.5.3",
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-1.5.3.tgz",
"integrity": "sha512-SVb428OMd3WO1paV3rm6tSjM4wC+Kecaa1EUGX7vc6/fddvw/6lg90z4QtCqm21zvVe92vMMDt9+DkIvjXImQQ==",
"license": "Apache-2.0",
"engines": {
"node": ">=16.11.0"
}
},
"node_modules/@discordjs/formatters": {
"version": "0.6.2",
"resolved": "https://registry.npmjs.org/@discordjs/formatters/-/formatters-0.6.2.tgz",
"integrity": "sha512-y4UPwWhH6vChKRkGdMB4odasUbHOUwy7KL+OVwF86PvT6QVOwElx+TiI1/6kcmcEe+g5YRXJFiXSXUdabqZOvQ==",
"license": "Apache-2.0",
"dependencies": {
"discord-api-types": "^0.38.33"
},
"engines": {
"node": ">=16.11.0"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/rest": {
"version": "2.6.3",
"resolved": "https://registry.npmjs.org/@discordjs/rest/-/rest-2.6.3.tgz",
"integrity": "sha512-wvOylxNYJkwKjctS/Mn5GP1w9r3/rzyH+ThD1JlAca6zEdlHs8QWBBUQJpU5Q+W6DoIj/Ljh1IPlZs7hTU+UAg==",
"license": "Apache-2.0",
"dependencies": {
"@discordjs/collection": "^2.1.1",
"@discordjs/util": "^1.2.0",
"@sapphire/async-queue": "^1.5.3",
"@sapphire/snowflake": "^3.5.5",
"@vladfrangu/async_event_emitter": "^2.4.6",
"discord-api-types": "^0.38.50",
"magic-bytes.js": "^1.13.0",
"tslib": "^2.6.3",
"undici": "^6.27.0"
},
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/rest/node_modules/@discordjs/collection": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-2.1.1.tgz",
"integrity": "sha512-LiSusze9Tc7qF03sLCujF5iZp7K+vRNEDBZ86FT9aQAv3vxMLihUvKvpsCWiQ2DJq1tVckopKm1rxomgNUc9hg==",
"license": "Apache-2.0",
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/util": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/@discordjs/util/-/util-1.2.0.tgz",
"integrity": "sha512-3LKP7F2+atl9vJFhaBjn4nOaSWahZ/yWjOvA4e5pnXkt2qyXRCHLxoBQy81GFtLGCq7K9lPm9R517M1U+/90Qg==",
"license": "Apache-2.0",
"dependencies": {
"discord-api-types": "^0.38.33"
},
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/ws": {
"version": "1.2.3",
"resolved": "https://registry.npmjs.org/@discordjs/ws/-/ws-1.2.3.tgz",
"integrity": "sha512-wPlQDxEmlDg5IxhJPuxXr3Vy9AjYq5xCvFWGJyD7w7Np8ZGu+Mc+97LCoEc/+AYCo2IDpKioiH0/c/mj5ZR9Uw==",
"license": "Apache-2.0",
"dependencies": {
"@discordjs/collection": "^2.1.0",
"@discordjs/rest": "^2.5.1",
"@discordjs/util": "^1.1.0",
"@sapphire/async-queue": "^1.5.2",
"@types/ws": "^8.5.10",
"@vladfrangu/async_event_emitter": "^2.2.4",
"discord-api-types": "^0.38.1",
"tslib": "^2.6.2",
"ws": "^8.17.0"
},
"engines": {
"node": ">=16.11.0"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@discordjs/ws/node_modules/@discordjs/collection": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-2.1.1.tgz",
"integrity": "sha512-LiSusze9Tc7qF03sLCujF5iZp7K+vRNEDBZ86FT9aQAv3vxMLihUvKvpsCWiQ2DJq1tVckopKm1rxomgNUc9hg==",
"license": "Apache-2.0",
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/@sapphire/async-queue": {
"version": "1.5.5",
"resolved": "https://registry.npmjs.org/@sapphire/async-queue/-/async-queue-1.5.5.tgz",
"integrity": "sha512-cvGzxbba6sav2zZkH8GPf2oGk9yYoD5qrNWdu9fRehifgnFZJMV+nuy2nON2roRO4yQQ+v7MK/Pktl/HgfsUXg==",
"license": "MIT",
"engines": {
"node": ">=v14.0.0",
"npm": ">=7.0.0"
}
},
"node_modules/@sapphire/shapeshift": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/@sapphire/shapeshift/-/shapeshift-4.0.0.tgz",
"integrity": "sha512-d9dUmWVA7MMiKobL3VpLF8P2aeanRTu6ypG2OIaEv/ZHH/SUQ2iHOVyi5wAPjQ+HmnMuL0whK9ez8I/raWbtIg==",
"license": "MIT",
"dependencies": {
"fast-deep-equal": "^3.1.3",
"lodash": "^4.17.21"
},
"engines": {
"node": ">=v16"
}
},
"node_modules/@sapphire/snowflake": {
"version": "3.5.5",
"resolved": "https://registry.npmjs.org/@sapphire/snowflake/-/snowflake-3.5.5.tgz",
"integrity": "sha512-xzvBr1Q1c4lCe7i6sRnrofxeO1QTP/LKQ6A6qy0iB4x5yfiSfARMEQEghojzTNALDTcv8En04qYNIco9/K9eZQ==",
"license": "MIT",
"engines": {
"node": ">=v14.0.0",
"npm": ">=7.0.0"
}
},
"node_modules/@types/node": {
"version": "26.6.5",
"resolved": "https://registry.npmjs.org/@types/node/-/node-26.6.5.tgz",
"integrity": "sha512-uMzsv9stDdofIZBx4UGh4Z9ZgXnGC9seRDscilBcTHAeOFk67MZg/k9bWVfO+bk4qZmG+l52hRnLwUiH2LnJTg==",
"license": "MIT",
"dependencies": {
"undici-types": "~8.9.0"
}
},
"node_modules/@types/ws": {
"version": "8.18.2",
"resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.2.tgz",
"integrity": "sha512-67MQl+fpWKVTT1NYdnmo3U4sc/xPo/zQBncVnI74qmQa0z/b+1g6iYqNmGCPbxO+zz2aklb08a0oHfegiVd0/w==",
"license": "MIT",
"dependencies": {
"@types/node": "*"
}
},
"node_modules/@vladfrangu/async_event_emitter": {
"version": "2.4.7",
"resolved": "https://registry.npmjs.org/@vladfrangu/async_event_emitter/-/async_event_emitter-2.4.7.tgz",
"integrity": "sha512-Xfe6rpCTxSxfbswi/W/Pz7zp1WWSNn4A0eW4mLkQUewCrXXtMj31lCg+iQyTkh/CkusZSq9eDflu7tjEDXUY6g==",
"license": "MIT",
"engines": {
"node": ">=v14.0.0",
"npm": ">=7.0.0"
}
},
"node_modules/discord-api-types": {
"version": "0.38.56",
"resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.38.56.tgz",
"integrity": "sha512-Hti4RZsGvF5C7SM8rF2MDHtIm0Hyfrlk84GpEA29nj91tvVVMvX+oQSCodu10t2ZcjFGofq8TX0YyC04B2E69Q==",
"license": "MIT"
},
"node_modules/discord.js": {
"version": "14.27.0",
"resolved": "https://registry.npmjs.org/discord.js/-/discord.js-14.27.0.tgz",
"integrity": "sha512-qHbFlFG2N7y3LjPySYsL6A1+BnX6bkTVgo842EX0CqVPk/KTMwZkojPHEXKsQUpWZNyz5BISNHK1cPpQw0+m4A==",
"license": "Apache-2.0",
"dependencies": {
"@discordjs/builders": "^1.14.1",
"@discordjs/collection": "1.5.3",
"@discordjs/formatters": "^0.6.2",
"@discordjs/rest": "^2.6.2",
"@discordjs/util": "^1.2.0",
"@discordjs/ws": "^1.2.3",
"@sapphire/snowflake": "3.5.5",
"discord-api-types": "^0.38.49",
"fast-deep-equal": "3.1.3",
"lodash.snakecase": "4.1.1",
"magic-bytes.js": "^1.13.0",
"tslib": "^2.6.3",
"undici": "^6.27.0"
},
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/discordjs/discord.js?sponsor"
}
},
"node_modules/dotenv": {
"version": "17.4.2",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.4.2.tgz",
"integrity": "sha512-nI4U3TottKAcAD9LLud4Cb7b2QztQMUEfHbvhTH09bqXTxnSie8WnjPALV/WMCrJZ6UV/qHJ6L03OqO3LcdYZw==",
"license": "BSD-2-Clause",
"engines": {
"node": ">=12"
},
"funding": {
"url": "https://dotenvx.com"
}
},
"node_modules/fast-deep-equal": {
"version": "3.1.3",
"resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
"integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==",
"license": "MIT"
},
"node_modules/lodash": {
"version": "4.18.1",
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz",
"integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==",
"license": "MIT"
},
"node_modules/lodash.snakecase": {
"version": "4.1.1",
"resolved": "https://registry.npmjs.org/lodash.snakecase/-/lodash.snakecase-4.1.1.tgz",
"integrity": "sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==",
"license": "MIT"
},
"node_modules/magic-bytes.js": {
"version": "1.13.1",
"resolved": "https://registry.npmjs.org/magic-bytes.js/-/magic-bytes.js-1.13.1.tgz",
"integrity": "sha512-x5sn4UX2k5gCWlcfmoFwG4TPie8+dctESyqOBdhB5p6MsgWXdBKGmt9nXPObj/JI50TTL928lc5Yt1WntMn1bw==",
"license": "MIT"
},
"node_modules/ts-mixer": {
"version": "6.0.4",
"resolved": "https://registry.npmjs.org/ts-mixer/-/ts-mixer-6.0.4.tgz",
"integrity": "sha512-ufKpbmrugz5Aou4wcr5Wc1UUFWOLhq+Fm6qa6P0w0K5Qw2yhaUoiWszhCVuNQyNwrlGiscHOmqYoAox1PtvgjA==",
"license": "MIT"
},
"node_modules/tslib": {
"version": "2.8.1",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
"license": "0BSD"
},
"node_modules/undici": {
"version": "6.29.0",
"resolved": "https://registry.npmjs.org/undici/-/undici-6.29.0.tgz",
"integrity": "sha512-R+RODBqp6i2pPflGdq+xIOUkl+RNfGgHwoinecKu/JCuf2uO06cOKoDbI2P7Dn6KcswdKwrczbU6IYJ6K8X+wg==",
"license": "MIT",
"engines": {
"node": ">=18.17"
}
},
"node_modules/undici-types": {
"version": "8.9.0",
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-8.9.0.tgz",
"integrity": "sha512-KTDyRTYX8sWmKXAikPHHSyc63CRPETMctyjKFupcC6OBLXT3xsN0e9aF7m+mIXutFWpUXuedtowG7iLOzp0kQg==",
"license": "MIT"
},
"node_modules/ws": {
"version": "8.22.0",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.22.0.tgz",
"integrity": "sha512-Ydggc987+RO0AnWtZ/7Wq9FtNvcrL1b/RO0ud9mWjUPgDrsAAwQSF51sm2hm1XofbU/4jkpGEsLFsZZxU+1DOg==",
"license": "MIT",
"engines": {
"node": ">=10.0.0"
},
"peerDependencies": {
"bufferutil": "^4.0.1",
"utf-8-validate": ">=5.0.2"
},
"peerDependenciesMeta": {
"bufferutil": {
"optional": true
},
"utf-8-validate": {
"optional": true
}
}
}
}
}

View File

@@ -1,18 +0,0 @@
{
"name": "dragonroll-discord-bot",
"version": "1.0.0",
"private": true,
"description": "Discord slash commands for consulting Dragonroll campaign characters.",
"main": "src/index.js",
"scripts": {
"start": "node src/index.js",
"deploy-commands": "node src/deploy-commands.js"
},
"engines": {
"node": ">=20"
},
"dependencies": {
"discord.js": "^14.27.0",
"dotenv": "^17.2.3"
}
}

View File

@@ -1,57 +0,0 @@
const { InteractionContextType, SlashCommandBuilder } = require('discord.js');
// Every command needs a Dragonroll campaign, and campaigns are linked to
// Discord servers, so none of them make sense in a DM.
const guildOnly = (command) => command.setContexts(InteractionContextType.Guild);
const commands = [
guildOnly(new SlashCommandBuilder()
.setName('characters')
.setDescription('List the characters of the Dragonroll campaign linked to this server.')
.addStringOption((option) => option
.setName('type')
.setDescription('Filter by actor type.')
.addChoices(
{ name: 'All', value: 'all' },
{ name: 'Characters', value: 'character' },
{ name: 'NPCs', value: 'npc' },
{ name: 'Creatures', value: 'creature' }
))),
guildOnly(new SlashCommandBuilder()
.setName('character')
.setDescription('Consult a character sheet from the Dragonroll campaign linked to this server.')
.addStringOption((option) => option
.setName('name')
.setDescription('Character name (full or partial).')
.setRequired(true)
.setMaxLength(100)
.setAutocomplete(true))
.addBooleanOption((option) => option
.setName('public')
.setDescription('Show the character sheet to everyone in this channel.'))),
guildOnly(new SlashCommandBuilder()
.setName('dragonroll')
.setDescription('Configure or check this server’s Dragonroll campaign.')
.addSubcommand((subcommand) => subcommand
.setName('connect')
.setDescription('Connect your Dragonroll account to this server.'))
.addSubcommand((subcommand) => subcommand
.setName('link')
.setDescription('Choose a campaign owned by the connected Dragonroll account.')
.addStringOption((option) => option
.setName('campaign')
.setDescription('Campaign to use in this server.')
.setRequired(true)
.setAutocomplete(true)))
.addSubcommand((subcommand) => subcommand
.setName('unlink')
.setDescription('Remove this server’s Dragonroll campaign link.'))
.addSubcommand((subcommand) => subcommand
.setName('status')
.setDescription('Show the campaign linked to this server.'))
.addSubcommand((subcommand) => subcommand
.setName('refresh')
.setDescription('Refresh this server’s Dragonroll connection status.')))
];
module.exports = commands;

View File

@@ -1,41 +0,0 @@
const dotenv = require('dotenv');
dotenv.config();
function required(name) {
const value = process.env[name]?.trim();
if (!value) throw new Error(`Missing required environment variable: ${name}`);
return value;
}
function apiUrl(value, name) {
const url = value.trim().replace(/\/+$/, '');
if (!/^https?:\/\//i.test(url)) throw new Error(`${name} must start with http:// or https://`);
return url;
}
// Frontend address, not the API: the sign-in page people open from Discord lives there.
function frontendUrl(value, name) {
const url = apiUrl(value, name).replace(/\/api$/i, '');
if (!url) throw new Error(`${name} must be the Dragonroll frontend address, like http://localhost:3000`);
return url;
}
function getConfig() {
const apiUrlValue = process.env.DRAGONROLL_API_URL || 'http://localhost:5000/api';
const apiBaseUrl = apiUrl(apiUrlValue, 'DRAGONROLL_API_URL');
const frontendBaseUrl = frontendUrl(
process.env.DRAGONROLL_FRONTEND_URL || process.env.DRAGONROLL_PUBLIC_API_URL || 'http://localhost:3000',
'DRAGONROLL_FRONTEND_URL'
);
return {
apiBaseUrl,
frontendBaseUrl,
discordBotSecret: process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '',
discordToken: required('DISCORD_TOKEN'),
discordClientId: required('DISCORD_CLIENT_ID')
};
}
module.exports = { getConfig };

View File

@@ -1,44 +0,0 @@
const { REST, Routes } = require('discord.js');
const { getConfig } = require('./config');
const commands = require('./commands');
// Global by default: the bot can be invited to any number of servers, and the
// campaign it answers with is decided per server by Dragonroll.
// Pass "--guild <server id>" while developing to see changes in one server at once.
function routeFor(clientId, guildId) {
return guildId
? Routes.applicationGuildCommands(clientId, guildId)
: Routes.applicationCommands(clientId);
}
function parseGuildArg(argv) {
const index = argv.indexOf('--guild');
if (index === -1) return null;
const guildId = argv[index + 1];
if (!guildId || guildId.startsWith('--')) {
throw new Error('Usage: npm run deploy-commands -- --guild <discord server id>');
}
return guildId;
}
async function deploy() {
const config = getConfig();
const guildId = parseGuildArg(process.argv.slice(2));
const rest = new REST({ version: '10' }).setToken(config.discordToken);
await rest.put(routeFor(config.discordClientId, guildId), { body: commands.map((command) => command.toJSON()) });
if (guildId) {
console.log(`Registered ${commands.length} commands in Discord server ${guildId}.`);
return;
}
console.log(`Registered ${commands.length} commands globally.`);
console.log('New servers can take up to an hour to see them; the bot also registers them when it joins a server.');
}
deploy().catch((error) => {
console.error('Could not register Discord commands:', error.message);
process.exitCode = 1;
});

View File

@@ -1,117 +0,0 @@
class CampaignNotLinkedError extends Error {
constructor(guildId) {
super(`No Dragonroll campaign is linked to Discord server ${guildId}.`);
this.name = 'CampaignNotLinkedError';
this.guildId = guildId;
}
}
class DragonrollNotConnectedError extends Error {
constructor(guildId) {
super(`No Dragonroll account is connected to Discord server ${guildId}.`);
this.name = 'DragonrollNotConnectedError';
this.guildId = guildId;
}
}
function createDragonrollApi(config) {
async function request(path, options = {}) {
if (!config.discordBotSecret) {
throw new Error('Set DRAGONROLL_DISCORD_BOT_SECRET in the bot and backend environments before using Dragonroll commands.');
}
const response = await fetch(`${config.apiBaseUrl}${path}`, {
...options,
headers: {
...(options.body ? { 'Content-Type': 'application/json' } : {}),
'X-Dragonroll-Discord-Bot-Secret': config.discordBotSecret,
...options.headers
}
});
let payload;
try {
payload = await response.json();
} catch {
const error = new Error(`Dragonroll API returned an unreadable response (${response.status}).`);
error.status = response.status;
throw error;
}
if (!response.ok || payload.status === 'error') {
const error = new Error(payload.msg || `Dragonroll API request failed (${response.status}).`);
error.status = response.status;
error.code = payload.msg;
throw error;
}
return payload;
}
async function startAuthorization(guildId, guildName, discordUserId, discordUserName) {
return request('/discord/link/start', {
method: 'POST',
body: JSON.stringify({ guildId, guildName, discordUserId, discordUserName })
});
}
async function claimLinkNotifications() {
const payload = await request('/discord/bot/link-requests/notifications', { method: 'POST' });
return Array.isArray(payload.notifications) ? payload.notifications : [];
}
async function getStatus(guildId) { return request(`/discord/bot/guild/${encodeURIComponent(guildId)}/status`);
}
async function listCampaigns(guildId) {
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaigns`);
if (!Array.isArray(payload.campaigns)) {
throw new Error(payload.msg || 'Dragonroll returned an invalid campaign list.');
}
return payload.campaigns;
}
async function linkCampaign(guildId, campaignId) {
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaign`, {
method: 'POST',
body: JSON.stringify({ campaignId })
});
if (!payload.campaign) throw new Error('Dragonroll returned an invalid campaign link.');
return payload.campaign;
}
async function unlinkCampaign(guildId) {
const current = await getCampaign(guildId);
await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaign`, { method: 'DELETE' });
return current;
}
async function getCampaign(guildId) {
const key = String(guildId);
const status = await getStatus(key);
if (!status.connected) throw new DragonrollNotConnectedError(key);
if (!status.campaign) throw new CampaignNotLinkedError(key);
const campaign = {
id: String(status.campaign._id ?? status.campaign.id),
name: status.campaign.name || 'Untitled campaign'
};
if (!campaign.id || campaign.id === 'undefined') throw new Error('Dragonroll returned an invalid campaign.');
return campaign;
}
async function listActors(guildId) {
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors`);
if (!Array.isArray(payload.actors) || !payload.campaign) {
throw new Error(payload.msg || 'Dragonroll returned an invalid actor list.');
}
const campaign = {
id: String(payload.campaign.id ?? payload.campaign._id),
name: payload.campaign.name || 'Untitled campaign'
};
return { campaign, actors: payload.actors };
}
return { startAuthorization, claimLinkNotifications, getStatus, getCampaign, listCampaigns, linkCampaign, unlinkCampaign, listActors };
}
module.exports = { createDragonrollApi, CampaignNotLinkedError, DragonrollNotConnectedError };

View File

@@ -1,496 +0,0 @@
const {
ActionRowBuilder,
ButtonBuilder,
ButtonStyle,
Client,
EmbedBuilder,
Events,
GatewayIntentBits,
MessageFlags,
PermissionFlagsBits,
REST,
Routes
} = require('discord.js');
const { getConfig } = require('./config');
const {
createDragonrollApi,
CampaignNotLinkedError,
DragonrollNotConnectedError
} = require('./dragonroll-api');
const commands = require('./commands');
// Same lifetime as the authorization link on the backend.
const LINK_REQUEST_TTL_MS = 10 * 60 * 1000;
const LINK_NOTIFICATION_POLL_MS = 4000;
function abilityModifier(score) {
const modifier = Math.floor((Number(score || 10) - 10) / 2);
return `${modifier >= 0 ? '+' : ''}${modifier}`;
}
function safeField(value, limit = 600) {
const text = String(value || '').trim();
if (!text) return '—';
return text.length > limit ? `${text.slice(0, limit - 1)}…` : text;
}
// Actor images are stored as a bare filename and served publicly at
// `<api>/public/<filename>`, the same way the frontend renders them. An
// absolute URL is used as-is if one ever gets saved.
function actorImageUrl(image, publicBaseUrl) {
const value = String(image || '').trim();
if (!value) return null;
if (/^https?:\/\//i.test(value)) return value;
return `${publicBaseUrl.replace(/\/+$/, '')}/${encodeURIComponent(value)}`;
}
function actorEmbed(actor, campaign, publicImageBaseUrl) {
const abilities = actor.abilityScores || {};
const abilityFields = [
['💪 STR', 'str'], ['🏹 DEX', 'dex'], ['🛡️ CON', 'con'],
['📚 INT', 'int'], ['👁️ WIS', 'wis'], ['✨ CHA', 'cha']
].map(([name, key]) => {
const score = abilities[key] ?? 10;
return { name, value: `**${score}** · _${abilityModifier(score)}_`, inline: true };
});
const className = String(actor.className || actor.class || '').trim();
const race = actor.species || actor.race;
const embed = new EmbedBuilder()
.setTitle(safeField(actor.name, 256))
.setColor(0x8c6bb1)
.setDescription(safeField(actor.description, 1200))
.setFooter({ text: safeField(`Campaign: ${campaign.name}`, 600) });
const imageUrl = actorImageUrl(actor.image, publicImageBaseUrl);
if (imageUrl) embed.setImage(imageUrl);
embed.addFields(
{ name: '🧬 Race', value: safeField(race), inline: true },
{ name: '⚔️ Class', value: safeField([className, actor.level ? `Level ${actor.level}` : null].filter(Boolean).join(' · ')), inline: true }
);
if (actor.subclass) embed.addFields({ name: '✨ Subclass', value: safeField(actor.subclass), inline: true });
embed.addFields(
{ name: '📜 Background', value: safeField(actor.background), inline: true },
{ name: '🛡️ Combat', value: `AC ${actor.armorClass ?? 10} · Speed ${actor.speed ?? 30} ft.`, inline: true },
{ name: 'Ability scores', value: '\u200b' },
...abilityFields
);
if (actor.proficiencies) embed.addFields({ name: 'Proficiencies', value: safeField(actor.proficiencies) });
if (actor.traits) embed.addFields({ name: 'Traits', value: safeField(actor.traits) });
if (actor.spells) embed.addFields({ name: 'Spells', value: safeField(actor.spells) });
if (Array.isArray(actor.inventory) && actor.inventory.length) {
const inventory = actor.inventory
.map((item) => `${item.name || 'Item'} ×${item.quantity || 1}`)
.join('\n');
embed.addFields({ name: 'Inventory', value: safeField(inventory) });
}
return embed;
}
function findActor(actors, input) {
const query = input.trim().toLocaleLowerCase();
const exact = actors.find((actor) => actor.name.toLocaleLowerCase() === query);
if (exact) return { actor: exact };
const matches = actors.filter((actor) => actor.name.toLocaleLowerCase().includes(query));
if (matches.length === 1) return { actor: matches[0] };
return { matches };
}
async function main() {
const config = getConfig();
if (!config.discordBotSecret) {
console.warn('DRAGONROLL_DISCORD_BOT_SECRET is not set; the bot will start, but Dragonroll commands will need it.');
}
const dragonroll = createDragonrollApi(config);
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
const rest = new REST({ version: '10' }).setToken(config.discordToken);
// Discord downloads character portraits itself, so they need to be absolute
// URLs pointing at the backend's public uploads folder.
const publicImageBaseUrl = `${config.apiBaseUrl}/public`;
// Reply, or edit the deferred reply, always without pinging anybody.
async function respond(interaction, payload) {
const body = { allowedMentions: { parse: [] }, ...payload };
if (interaction.deferred || interaction.replied) return interaction.editReply(body);
return interaction.reply({ ...body, flags: MessageFlags.Ephemeral });
}
async function explainMissingCampaign(interaction, guildId) {
await respond(interaction, {
content: safeField([
'This Discord server is not linked to a Dragonroll campaign yet.',
`A server administrator can connect Dragonroll with \`/dragonroll connect\`, then choose a campaign with \`/dragonroll link\`. Server ID: \`${guildId}\`.`
].join('\n'), 1800)
});
}
async function explainNotConnected(interaction, guildId) {
await respond(interaction, {
content: safeField([
'No Dragonroll account is connected to this Discord server yet.',
`A server administrator can run \`/dragonroll connect\` to sign in. Server ID: \`${guildId}\`.`
].join('\n'), 1800)
});
}
// The /dragonroll connect interactions waiting for somebody to authorize on Dragonroll.
// Their tokens stay usable for 15 minutes, longer than the authorization link lasts.
const pendingLinkRequests = new Map();
let linkNotificationTimer = null;
function linkRequestKey(guildId, discordUserId) {
return `${guildId}:${discordUserId}`;
}
function rememberLinkRequest(interaction) {
for (const [key, pending] of pendingLinkRequests) {
if (Date.now() - pending.requestedAt > LINK_REQUEST_TTL_MS) pendingLinkRequests.delete(key);
}
pendingLinkRequests.set(linkRequestKey(interaction.guildId, interaction.user.id), {
interaction,
requestedAt: Date.now()
});
if (!linkNotificationTimer) {
linkNotificationTimer = setInterval(() => {
deliverLinkNotifications().catch((error) => {
console.error('Could not confirm a Dragonroll authorization:', error.message);
});
}, LINK_NOTIFICATION_POLL_MS);
linkNotificationTimer.unref();
}
}
async function confirmLinkRequest(interaction, notification) {
const account = notification.dragonrollUserName ? ` \`${safeField(notification.dragonrollUserName, 40)}\`` : '';
await interaction.followUp({
content: safeField([
`Your Dragonroll account${account} is now connected to **${safeField(notification.guildName, 100)}**.`,
'Run `/dragonroll link` to choose which campaign this server can read.'
].join('\n'), 1800),
flags: MessageFlags.Ephemeral,
allowedMentions: { parse: [] }
});
}
async function deliverLinkNotifications() {
if (!config.discordBotSecret || !pendingLinkRequests.size) return;
const notifications = await dragonroll.claimLinkNotifications();
for (const notification of notifications) {
const key = linkRequestKey(notification.guildId, notification.discordUserId);
const pending = pendingLinkRequests.get(key);
pendingLinkRequests.delete(key);
// Without the interaction that asked for this authorization there is nothing to
// answer: the bot was restarted, and Dragonroll's own web page already told the
// person what to do next.
if (!pending) continue;
try {
await confirmLinkRequest(pending.interaction, notification);
} catch (error) {
console.error(`Could not confirm the Dragonroll authorization for Discord user ${notification.discordUserId}:`, error.message);
}
}
}
// Commands live on every server the bot joins: guild-scoped registration is
// instant, unlike the global registration done by deploy-commands.
async function registerCommandsIn(guildId) {
try {
await rest.put(Routes.applicationGuildCommands(config.discordClientId, guildId), {
body: commands.map((command) => command.toJSON())
});
} catch (error) {
console.error(`Could not register commands in Discord server ${guildId}:`, error.message);
}
}
async function showStatus(interaction, guildId) {
const embed = new EmbedBuilder()
.setTitle('Dragonroll link')
.setColor(0x8c6bb1)
.addFields({ name: 'This server', value: `${interaction.guild?.name || 'Unknown'} · \`${guildId}\`` });
let status;
try {
status = await dragonroll.getStatus(guildId);
} catch (error) {
console.error('Could not read the Dragonroll connection for this server:', error.message);
embed.addFields({ name: 'Dragonroll account', value: 'Dragonroll could not be reached right now.' });
await respond(interaction, { embeds: [embed] });
return;
}
embed.addFields(
{ name: 'Dragonroll account', value: status.connected ? 'Connected' : 'Not connected.' },
{ name: 'Campaign', value: status.campaign
? `${status.campaign.name} · \`${status.campaign._id ?? status.campaign.id}\``
: 'Not linked yet.' }
);
if (!status.connected) {
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
} else if (!status.campaign) {
embed.setDescription('A server administrator can run /dragonroll link to choose a campaign.');
}
await respond(interaction, { embeds: [embed] });
}
client.once(Events.ClientReady, (readyClient) => {
console.log(`Dragonroll character bot is online as ${readyClient.user.tag}, in ${readyClient.guilds.cache.size} servers.`);
// Guild commands registered when the bot joined shadow global ones and
// keep their old definition forever, so refresh them on every start to
// propagate command changes (new options, autocomplete) to all servers.
for (const guild of readyClient.guilds.cache.values()) registerCommandsIn(guild.id);
});
client.on(Events.GuildCreate, (guild) => {
console.log(`Added to Discord server ${guild.id} (${guild.name}).`);
registerCommandsIn(guild.id);
});
client.on(Events.InteractionCreate, (interaction) => {
// One broken command should not take the bot down for every other server.
handleInteraction(interaction).catch((error) => {
console.error(`Could not answer ${interaction.commandName}:`, error.message);
});
});
async function respondCampaignChoices(interaction, guildId) {
if (!interaction.memberPermissions?.has(PermissionFlagsBits.Administrator)) {
await interaction.respond([]);
return;
}
try {
const query = interaction.options.getFocused().toLocaleLowerCase();
const campaigns = await dragonroll.listCampaigns(guildId);
const choices = campaigns
.filter((campaign) => !campaign.discordGuildId || String(campaign.discordGuildId) === String(guildId))
.filter((campaign) => String(campaign.name || '').toLocaleLowerCase().includes(query))
.slice(0, 25)
.map((campaign) => ({
name: safeField(campaign.name, 100),
value: String(campaign._id ?? campaign.id)
}))
.filter((choice) => choice.value && choice.value !== 'undefined');
await interaction.respond(choices);
} catch (error) {
if (error.status !== 401 && error.code !== 'discord.errors.not-connected') {
console.error('Could not list campaigns for Discord configuration:', error.message);
}
await interaction.respond([]);
}
}
// Character names for /character. Anyone who may read the campaign may use
// the suggestions; when nothing is linked we answer with an empty list, as
// autocomplete replies cannot carry an error message.
async function respondActorChoices(interaction, guildId) {
try {
const query = interaction.options.getFocused().trim().toLocaleLowerCase();
const { actors } = await dragonroll.listActors(guildId);
const seen = new Set();
const choices = actors
.filter((actor) => String(actor.name || '').trim() && actor.name.length <= 100)
.filter((actor) => actor.name.toLocaleLowerCase().includes(query))
.map((actor) => ({
name: safeField(actor.name, 100),
value: actor.name
}))
.filter((choice) => !seen.has(choice.value) && seen.add(choice.value))
.slice(0, 25);
await interaction.respond(choices);
} catch (error) {
if (!(error instanceof DragonrollNotConnectedError)
&& !(error instanceof CampaignNotLinkedError)
&& error.status !== 401
&& error.code !== 'discord.errors.not-connected') {
console.error('Could not list characters for Discord autocomplete:', error.message);
}
await interaction.respond([]);
}
}
async function handleInteraction(interaction) {
if (interaction.isAutocomplete()) {
const guildId = interaction.guildId;
if (!guildId) {
await interaction.respond([]);
return;
}
if (interaction.commandName === 'character') {
await respondActorChoices(interaction, guildId);
return;
}
if (interaction.commandName === 'dragonroll' && interaction.options.getSubcommand() === 'link') {
await respondCampaignChoices(interaction, guildId);
return;
}
return;
}
if (!interaction.isChatInputCommand()) return;
if (!['characters', 'character', 'dragonroll'].includes(interaction.commandName)) return;
const guildId = interaction.guildId;
if (!guildId) {
await respond(interaction, { content: 'These commands only work inside a Discord server.' });
return;
}
if (interaction.commandName === 'dragonroll') {
const subcommand = interaction.options.getSubcommand();
if (['connect', 'link', 'unlink'].includes(subcommand)) {
if (!interaction.memberPermissions?.has(PermissionFlagsBits.Administrator)) {
await respond(interaction, { content: 'Only Discord server administrators can connect Dragonroll or change this campaign link.' });
return;
}
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
try {
if (subcommand === 'connect') {
const request = await dragonroll.startAuthorization(
guildId,
interaction.guild?.name || 'Discord server',
interaction.user.id,
interaction.user.username
);
const authorizationUrl = `${config.frontendBaseUrl}/discord/authorize#code=${encodeURIComponent(request.code)}`;
const button = new ButtonBuilder()
.setLabel('Sign in to Dragonroll')
.setStyle(ButtonStyle.Link)
.setURL(authorizationUrl);
await respond(interaction, {
content: 'Open Dragonroll to sign in and authorize this server. The link expires in 10 minutes.',
components: [new ActionRowBuilder().addComponents(button)]
});
rememberLinkRequest(interaction);
return;
} else if (subcommand === 'link') {
const campaignId = interaction.options.getString('campaign', true);
const campaign = await dragonroll.linkCampaign(guildId, campaignId);
await respond(interaction, {
content: `This server is now linked to **${safeField(campaign.name, 180)}**.`,
allowedMentions: { parse: [] }
});
} else {
try {
const campaign = await dragonroll.unlinkCampaign(guildId);
await respond(interaction, {
content: `Removed this server’s link to **${safeField(campaign.name, 180)}**.`,
allowedMentions: { parse: [] }
});
} catch (error) {
if (error instanceof CampaignNotLinkedError) {
await respond(interaction, { content: 'This server does not have a linked campaign.' });
return;
}
throw error;
}
}
} catch (error) {
console.error(`Could not ${subcommand} the campaign for Discord server ${guildId}:`, error.message);
let message = `I could not ${subcommand} this campaign link. Please try again.`;
if (error instanceof DragonrollNotConnectedError || error.code === 'discord.errors.not-connected') {
message = 'Connect a Dragonroll account first with /dragonroll connect.';
} else if (error.status === 401 || error.message.includes('DRAGONROLL_DISCORD_BOT_SECRET')) {
message = 'The bot API secret is missing or does not match the backend. Contact the bot operator.';
} else if (error.code === 'campaigns.errors.discord-guild-in-use' || error.code === 'discord.errors.campaign-already-linked') {
message = 'That campaign is already linked to another Discord server.';
}
await respond(interaction, { content: message });
}
return;
}
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
await showStatus(interaction, guildId);
return;
}
const showCharacterPublicly = interaction.commandName === 'character'
&& interaction.options.getBoolean('public');
await interaction.deferReply(showCharacterPublicly ? {} : { flags: MessageFlags.Ephemeral });
try {
const { campaign, actors } = await dragonroll.listActors(guildId);
if (interaction.commandName === 'characters') {
const type = interaction.options.getString('type') || 'all';
const filtered = type === 'all' ? actors : actors.filter((actor) => actor.type === type);
if (!filtered.length) {
await interaction.editReply({
content: type === 'all'
? `There are no characters in **${campaign.name}** yet.`
: `There are no ${type === 'npc' ? 'NPCs' : `${type}s`} in **${campaign.name}**.`,
allowedMentions: { parse: [] }
});
return;
}
const shown = filtered.slice(0, 40);
const lines = shown.map((actor) => {
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
.filter(Boolean)
.join(' · ');
return `• **${actor.name}**${details ? ` — ${details}` : ''}`;
});
const embed = new EmbedBuilder()
.setTitle(`Characters of ${campaign.name}`)
.setColor(0x8c6bb1)
.setDescription(safeField(lines.join('\n'), 4000))
.setFooter({ text: filtered.length > shown.length
? `Showing ${shown.length} of ${filtered.length}; use /character to look up a specific sheet.`
: `${filtered.length} ${filtered.length === 1 ? 'entry' : 'entries'} · Use /character to inspect a sheet.` });
await interaction.editReply({ embeds: [embed], allowedMentions: { parse: [] } });
return;
}
const name = interaction.options.getString('name', true);
const result = findActor(actors, name);
if (result.actor) {
await interaction.editReply({ embeds: [actorEmbed(result.actor, campaign, publicImageBaseUrl)], allowedMentions: { parse: [] } });
} else if (result.matches?.length > 1) {
await interaction.editReply({
content: safeField(`Several characters match **${name}**: ${result.matches.slice(0, 15).map((actor) => actor.name).join(', ')}. Try a more specific name.`, 1800),
allowedMentions: { parse: [] }
});
} else {
await interaction.editReply({
content: `I couldn't find a character named **${name}**. Try \`/characters\` to see the campaign roster.`,
allowedMentions: { parse: [] }
});
}
} catch (error) {
if (error instanceof DragonrollNotConnectedError) {
await explainNotConnected(interaction, guildId);
return;
}
if (error instanceof CampaignNotLinkedError) {
await explainMissingCampaign(interaction, guildId);
return;
}
console.error('Character lookup failed:', error.message);
await interaction.editReply({
content: 'I could not reach the Dragonroll campaign right now. Please try again in a moment.',
allowedMentions: { parse: [] }
});
}
}
await client.login(config.discordToken);
}
main().catch((error) => {
console.error('Could not start Dragonroll Discord bot:', error.message);
process.exitCode = 1;
});

View File

@@ -18,26 +18,4 @@ services:
backend:
image: git.aranroig.com/syndria98/dragonroll-backend:latest
environment:
# Shared service secret the Discord bot authenticates with
# (header x-dragonroll-discord-bot-secret). Must match the bot's value.
DRAGONROLL_DISCORD_BOT_SECRET: ${DRAGONROLL_DISCORD_BOT_SECRET}
# Public address of the frontend: the /discord/authorize link people
# open from Discord is built from this.
DRAGONROLL_FRONTEND_URL: ${DRAGONROLL_FRONTEND_URL:-https://dragonroll.aranroig.com}
restart: always
discord-bot:
image: git.aranroig.com/syndria98/dragonroll-discord-bot:latest
environment:
DISCORD_TOKEN: ${DISCORD_TOKEN}
DISCORD_CLIENT_ID: ${DISCORD_CLIENT_ID}
DRAGONROLL_DISCORD_BOT_SECRET: ${DRAGONROLL_DISCORD_BOT_SECRET}
# Must stay the public https address (through nginx) and not
# http://backend:5000/api: character portraits are rendered in Discord
# from <DRAGONROLL_API_URL>/public/<filename>.
DRAGONROLL_API_URL: ${DRAGONROLL_API_URL:-https://dragonroll.aranroig.com/api}
DRAGONROLL_FRONTEND_URL: ${DRAGONROLL_FRONTEND_URL:-https://dragonroll.aranroig.com}
depends_on:
- backend
restart: always

View File

@@ -1,177 +0,0 @@
# Dragonroll Foundry integration
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
This integration uses a small companion bridge process on that host:
1. A linked GM client syncs character Actors and world Items directly with the Dragonroll campaign.
2. The module publishes the active world's actor and item snapshot to the optional bridge.
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
The Foundry module uses the client-side package API and hooks documented by Foundry: [module development](https://foundryvtt.com/article/module-development/).
## 1. Install the Foundry module
Copy the contents of this directory into
`{Foundry user data}/Data/modules/dragonroll-foundry/`. Restart Foundry, then enable **Dragonroll
Foundry API** in the world's module settings.
After linking a campaign, the module stores a client-only token for character synchronization that
persists across Foundry restarts. If the optional bridge is configured, Dragonroll also sends its
connection settings to the module.
Existing clients continue using their saved bridge URL and publish token automatically. The module
publishes at world startup and after actor or item changes, and sends a lightweight heartbeat once a
minute. Its local JavaScript API remains available at
`game.modules.get("dragonroll-foundry").api`.
## Link a Foundry world to a Dragonroll campaign
Open the campaign's **Settings → Integrations** tab in Dragonroll and create a pairing code. In the
Foundry module settings, set **Dragonroll Endpoint** if you use a different Dragonroll server; it
defaults to `https://dragonroll.aranroig.com` and the module adds `/api` automatically. Paste the
code into **Dragonroll Campaign Pairing Code** and save. Codes expire after ten minutes and can only
be used once.
Both sides of the pairing survive restarts: Dragonroll keeps a pending code on the campaign so the
settings screen re-displays it after a page reload, the window being closed, or a server restart
(until it expires or is used), and the Foundry module keeps a code it could not redeem yet — for
example one pasted while Dragonroll was restarting — retrying it at world startup and once a minute
until the world finishes linking.
For a local backend, use `http://localhost:5000`; the module omits `/api` and the backend accepts
the local pairing route at its root. Character synchronization works without the optional snapshot
bridge. Configure that bridge only if you also need the read-only world snapshot API described below.
**Dragonroll Pairing Status** in the module settings always says whether this browser holds a pairing
and, once Dragonroll has answered `GET /api/foundry/sync/status`, which campaign the world is
connected to. It is written by the module, not by the GM: it appears as not connected until the world
is paired, names the campaign after a pairing or a check on world start and every minute afterwards,
gives the reason when a pairing code can never be redeemed, and says the world is no longer linked
once the campaign unlinks it. Because both the pairing code and the sync token are client settings,
another browser of the same world reads as not paired.
The campaign settings show the linked world's title and system. A Foundry world can be linked to
only one campaign at a time. The pairing endpoint accepts cross-origin requests from the Foundry
client and uses the one-time code instead of a Dragonroll login token.
## Character and item synchronization
After linking, the GM client imports Foundry character, NPC, and creature Actors into the campaign.
Creates, updates, and deletes sync in either direction; Dragonroll changes are applied in Foundry
within about five seconds. The module currently creates Dragonroll characters in D&D 5e Foundry
worlds. After updating an already-linked world to a version with character sync, create a fresh
pairing code and enter it in Foundry once to issue the sync token.
### Auto-sync, and sending one actor on purpose
**Dragonroll Auto-sync** in the module settings (on by default) is what keeps the campaign and this
world in step: actors and world items the GM creates, updates or deletes are sent to Dragonroll, and
both sides reconcile every few seconds. Turn it off to stop synchronizing altogether — nothing is
sent to the campaign, and Dragonroll stops rewriting those documents in Foundry, so the campaign
keeps whatever it already holds. Turn it back on to reconcile both sides again; the Foundry edits
queued while it was off are sent as the world catches up.
With autosync off — or any time a single character needs to cross over right now — right-click an
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
not a character, NPC or creature) are refused with a notification.
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
`/api/foundry/*`, which is never written into the campaign.
### Items
The campaign's Item list is synchronized with the world's gear, both ways:
- The GM sends the world item directory (`game.items`) with every snapshot, and world items created,
changed or deleted in Foundry are pushed as they happen. Items embedded in a character travel with
that character's snapshot instead.
- Gear is deduplicated by name: the same sword in the world directory and in three characters'
inventories becomes one Dragonroll item. Names Dragonroll renames away from are remembered on the
item (`foundryNames`), so Foundry's copies keep folding into it rather than coming back as a
duplicate. Spells, classes, subclasses, backgrounds, feats and species are not gear and are not
imported.
- Foundry owns the fields it sends (category from the item type, rarity, quantity, weight, weapon
properties, description). An item made by hand in Dragonroll is created in the world's item
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
document.
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in
Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's
inventory are owned by that actor's snapshot: editing such an item in Dragonroll does not rewrite the
actor's copy.
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
| Route | Use |
|---|---|
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
| `GET /api/foundry/sync/items` | Items to apply back in Foundry |
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
| `POST /api/foundry/sync/delete` | An actor was deleted |
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
the write is not echoed back.
## 2. Run the bridge on the Foundry host
The bridge uses only Node.js built-in modules and requires Node 18 or newer. Set separate random
tokens for backend reads and Foundry snapshot publishing, then start it:
```sh
export DRAGONROLL_FOUNDRY_READ_TOKEN='replace-with-a-long-random-read-token'
export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publish-token'
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
export DRAGONROLL_FOUNDRY_PORT='8787'
npm start --prefix foundry/bridge
```
Put the bridge behind HTTPS when it is reachable outside a trusted private network. The Foundry
browser origin must be listed in `DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS`; separate multiple origins with
commas. The bridge binds to `0.0.0.0` by default so Dragonroll can reach it on another host. Restrict
network access to the bridge port to Dragonroll and Foundry clients. If the reverse proxy serves the
bridge under a path prefix, configure it to strip that prefix before forwarding requests to port 8787.
## 3. Configure Dragonroll's backend
Set these variables in the backend environment. `FOUNDRY_API_URL` is the bridge base URL reachable
by the backend, without an API path. `FOUNDRY_API_CLIENT_URL` is optional and overrides the bridge
URL sent to Foundry clients when they cannot reach the backend's bridge URL (for example, when the
backend uses a private network address). `FOUNDRY_API_PUSH_TOKEN` must match the bridge's
`DRAGONROLL_FOUNDRY_PUSH_TOKEN`:
```sh
FOUNDRY_API_URL='https://vtt.example.com/dragonroll-bridge/'
FOUNDRY_API_CLIENT_URL='https://vtt.example.com/dragonroll-bridge/'
FOUNDRY_API_TOKEN='replace-with-the-bridge-read-token'
FOUNDRY_API_PUSH_TOKEN='replace-with-the-bridge-publish-token'
```
The backend exposes these JWT-protected routes when the optional snapshot bridge is configured:
| Dragonroll route | Data |
|---|---|
| `GET /api/foundry/world` | Active Foundry world metadata |
| `GET /api/foundry/actors` | All world actors |
| `GET /api/foundry/characters` | Actors with type `character` |
| `GET /api/foundry/actors/:id` | One actor |
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
| `GET /api/foundry/items` | World-level items |
| `GET /api/foundry/items/:id` | One world-level item |
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when the bridge has not
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
configured GM client has published its first snapshot.
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
items collection. The API returns plain document data snapshots. This is a read-only integration: it
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.

View File

@@ -1,12 +0,0 @@
{
"name": "dragonroll-foundry-bridge",
"private": true,
"version": "0.1.0",
"description": "Authenticated HTTP bridge between a Foundry client module and Dragonroll.",
"scripts": {
"start": "node server.js"
},
"engines": {
"node": ">=18"
}
}

View File

@@ -1,233 +0,0 @@
const http = require("node:http");
const { timingSafeEqual } = require("node:crypto");
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
const port = Number(process.env.DRAGONROLL_FOUNDRY_PORT || 8787);
const readToken = process.env.DRAGONROLL_FOUNDRY_READ_TOKEN;
const pushToken = process.env.DRAGONROLL_FOUNDRY_PUSH_TOKEN;
const allowedOrigins = new Set(
(process.env.DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS || "http://localhost:30000")
.split(",")
.map((origin) => origin.trim())
.filter(Boolean),
);
const maxBodySize = 50 * 1024 * 1024;
if (!readToken || !pushToken) {
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
}
let snapshot = null;
function sendJson(response, status, body) {
response.writeHead(status, { "Content-Type": "application/json; charset=utf-8" });
response.end(JSON.stringify(body));
}
function setCorsHeaders(request, response) {
const origin = request.headers.origin;
if (!origin) return true;
if (!allowedOrigins.has(origin)) return false;
response.setHeader("Access-Control-Allow-Origin", origin);
response.setHeader("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
response.setHeader("Access-Control-Allow-Headers", "Authorization, Content-Type");
response.setHeader("Vary", "Origin");
return true;
}
function hasBearerToken(request, expectedToken) {
const match = /^Bearer\s+(.+)$/i.exec(request.headers.authorization || "");
if (!match) return false;
const actual = Buffer.from(match[1]);
const expected = Buffer.from(expectedToken);
return actual.length === expected.length && timingSafeEqual(actual, expected);
}
function readJson(request) {
return new Promise((resolve, reject) => {
const chunks = [];
let bytes = 0;
let tooLarge = false;
request.on("data", (chunk) => {
bytes += chunk.length;
if (bytes > maxBodySize) {
tooLarge = true;
chunks.length = 0;
return;
}
if (!tooLarge) chunks.push(chunk);
});
request.on("end", () => {
if (tooLarge) {
reject(Object.assign(new Error("Snapshot is too large."), { status: 413 }));
return;
}
try {
resolve(JSON.parse(Buffer.concat(chunks).toString("utf8")));
} catch {
reject(Object.assign(new Error("Request body must be valid JSON."), { status: 400 }));
}
});
request.on("error", reject);
});
}
function currentSnapshot(response) {
if (!snapshot) {
sendJson(response, 503, { status: "error", msg: "foundry.not-ready" });
return null;
}
return snapshot;
}
function sendData(response, data, current) {
const ageMs = Date.now() - current.syncedAtMs;
sendJson(response, 200, {
status: "ok",
data,
world: current.world,
syncedAt: new Date(current.syncedAtMs).toISOString(),
ageSeconds: Math.floor(ageMs / 1000),
stale: ageMs > 120000,
});
}
function decodePathSegment(segment) {
try {
return decodeURIComponent(segment);
} catch {
return null;
}
}
const server = http.createServer(async (request, response) => {
if (!setCorsHeaders(request, response)) {
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
return;
}
if (request.method === "OPTIONS") {
response.writeHead(204);
response.end();
return;
}
const pathname = new URL(request.url, "http://localhost").pathname;
if (request.method === "GET" && pathname === "/health") {
sendJson(response, 200, {
status: "ok",
ready: Boolean(snapshot),
syncedAt: snapshot ? new Date(snapshot.syncedAtMs).toISOString() : null,
});
return;
}
if (request.method === "POST" && pathname === "/internal/snapshot") {
if (!hasBearerToken(request, pushToken)) {
sendJson(response, 401, { status: "error", msg: "unauthorized" });
return;
}
try {
const body = await readJson(request);
if (!body.world?.id || !Array.isArray(body.actors) || !Array.isArray(body.items)
|| !body.actorItems || typeof body.actorItems !== "object" || Array.isArray(body.actorItems)) {
sendJson(response, 400, { status: "error", msg: "foundry.invalid-snapshot" });
return;
}
snapshot = {
world: body.world,
actors: body.actors,
items: body.items,
actorItems: body.actorItems,
syncedAtMs: Date.now(),
};
sendJson(response, 200, { status: "ok", syncedAt: new Date(snapshot.syncedAtMs).toISOString() });
} catch (error) {
sendJson(response, error.status || 400, { status: "error", msg: "foundry.invalid-snapshot" });
}
return;
}
if (request.method === "POST" && pathname === "/internal/heartbeat") {
if (!hasBearerToken(request, pushToken)) {
sendJson(response, 401, { status: "error", msg: "unauthorized" });
return;
}
try {
const body = await readJson(request);
if (!snapshot || !body.worldId || snapshot.world.id !== body.worldId) {
sendJson(response, 409, { status: "error", msg: "foundry.not-ready" });
return;
}
snapshot.syncedAtMs = Date.now();
sendJson(response, 200, { status: "ok", syncedAt: new Date(snapshot.syncedAtMs).toISOString() });
} catch (error) {
sendJson(response, error.status || 400, { status: "error", msg: "foundry.invalid-heartbeat" });
}
return;
}
if (request.method !== "GET" || !pathname.startsWith("/api/")) {
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
return;
}
if (!hasBearerToken(request, readToken)) {
sendJson(response, 401, { status: "error", msg: "unauthorized" });
return;
}
const current = currentSnapshot(response);
if (!current) return;
if (pathname === "/api/world") return sendData(response, current.world, current);
if (pathname === "/api/actors") return sendData(response, current.actors, current);
if (pathname === "/api/characters") {
return sendData(response, current.actors.filter((actor) => actor.type === "character"), current);
}
if (pathname === "/api/items") return sendData(response, current.items, current);
const actorItemsMatch = /^\/api\/actors\/([^/]+)\/items$/.exec(pathname);
if (actorItemsMatch) {
const actorId = decodePathSegment(actorItemsMatch[1]);
if (!actorId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
const actor = current.actors.find((entry) => entry._id === actorId || entry.id === actorId);
if (!actor) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
return sendData(response, current.actorItems[actorId] || [], current);
}
const actorMatch = /^\/api\/actors\/([^/]+)$/.exec(pathname);
if (actorMatch) {
const actorId = decodePathSegment(actorMatch[1]);
if (!actorId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
const actor = current.actors.find((entry) => entry._id === actorId || entry.id === actorId);
if (!actor) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
return sendData(response, actor, current);
}
const itemMatch = /^\/api\/items\/([^/]+)$/.exec(pathname);
if (itemMatch) {
const itemId = decodePathSegment(itemMatch[1]);
if (!itemId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
const item = current.items.find((entry) => entry._id === itemId || entry.id === itemId);
if (!item) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
return sendData(response, item, current);
}
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
});
server.listen(port, host, () => {
console.info(`Dragonroll Foundry bridge listening on ${host}:${port}`);
});

View File

@@ -1,14 +0,0 @@
{
"id": "dragonroll-foundry",
"title": "Dragonroll Foundry API",
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
"version": "0.4.0",
"library": true,
"compatibility": {
"minimum": "12",
"verified": "14"
},
"esmodules": [
"scripts/api.js"
]
}

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,6 @@
import ContentManager from './components/managers/ContentManager.vue';
import ToastManager from './components/managers/ToastManager.vue';
import WindowManager from './components/managers/WindowManager.vue';
import DiscordAuthorize from './components/views/DiscordAuthorize.vue';
import { CreateWindow } from '@/services/Windows'
import { GetUser, HasAdmin } from './services/User';
@@ -12,11 +11,6 @@ import { useCampaignService } from './services/Campaign';
const { RestoreCampaign } = useCampaignService();
// El bot de Discord enllaça amb aquesta pantalla; no és part de l'aplicació i no ha d'arrencar
// les finestres normals.
const requestUrl = useRequestURL();
const isDiscordAuthorize = computed(() => requestUrl.pathname.replace(/\/+$/, '') === '/discord/authorize');
async function start(){
if(GetUser()){
const restoredCampaign = await RestoreCampaign();
@@ -46,15 +40,12 @@ useHead({
onMounted(() => {
setupTheme();
setTheme('dark');
if(!isDiscordAuthorize.value){
start();
}
start();
})
</script>
<template>
<DiscordAuthorize v-if="isDiscordAuthorize"></DiscordAuthorize>
<div v-else class="viewer">
<div class="viewer">
<ToastManager></ToastManager>
<TooltipManager></TooltipManager>
<ContextMenuManager></ContextMenuManager>

View File

@@ -18,7 +18,6 @@ $themes: (
button-active: #202020cc,
toast-background: #202020,
tooltip-background: #2a2a2a,
note-border: #202324,
@@ -34,11 +33,7 @@ $themes: (
green: #98c379,
gray: #cccccc,
icon-invert: 100%,
search-background: #20202077,
search-background-container: #202020ee,
search-hover: #2a2a2a,
icon-invert: 100%
),
light: (
background: #ffffff,
@@ -56,7 +51,6 @@ $themes: (
button-active: #d4d4d4,
toast-background: #f0f0f0,
tooltip-background: #f5f5f5,
note-border: #e0e0e0,
@@ -72,11 +66,7 @@ $themes: (
green: #98c379,
gray: #cccccc,
icon-invert: 0%,
search-background: #f0f0f0aa,
search-background-container: #ffffffee,
search-hover: #e8e8e8,
icon-invert: 0%
)
);

View File

@@ -225,23 +225,6 @@ button:active {
font-weight: bold;
}
/* Cites (> ...) a la vista prèvia d'una nota */
blockquote {
margin: 1em 0;
padding: 2px 0 2px 14px;
border-left: 3px solid var(--color-border-color);
font-style: italic;
opacity: 0.85;
}
blockquote blockquote {
margin: 0.5em 0;
}
blockquote p {
margin: 0.3em 0;
}
.text-icon {
height: 18px;
width: 18px;
@@ -381,40 +364,3 @@ span.artifact {
.green {
color: var(--color-green);
}
/* Seccions col·lapsables (h1/h2/h3) a la vista prèvia d'una nota */
.fold-handle {
position: relative;
cursor: pointer;
user-select: none;
padding-left: 0.95em;
}
.fold-handle::before {
content: "";
position: absolute;
left: 0.1em;
top: 0.55em;
width: 0.3em;
height: 0.3em;
box-sizing: border-box;
border-right: 1px solid currentColor;
border-bottom: 1px solid currentColor;
opacity: 0;
transition: transform 0.15s ease, opacity 0.15s ease;
transform: rotate(45deg);
transform-origin: center;
}
.fold-handle:hover::before {
opacity: 0.7;
}
.fold.is-collapsed > .fold-handle::before {
opacity: 0.7;
transform: rotate(-45deg);
}
.fold.is-collapsed > .fold-body {
display: none;
}

View File

@@ -34,28 +34,19 @@ onMounted(() => {
z-index: 214748363;
flex-direction: column;
background-color: var(--color-tooltip-background);
border: 1px solid var(--color-border);
overflow: visible;
.context-menu-divider {
height: 1px;
margin: 4px 0;
border-top: 1px solid var(--color-border);
background-color: transparent;
border: none;
}
.context-menu-element {
&:last-child {
border-width: 1px 1px 1px 1px;
}
border: solid 1px var(--color-border);
border-width: 1px 1px 0px 1px;
padding: 6px 10px 6px 8px;
padding: 3px 5px 3px 5px;
cursor: default;
user-select: none;
background-color: var(--color-tooltip-background);
background-color: var(--tooltip-background);
transition: background-color 100ms;
display: flex;
align-items: center;
@@ -63,37 +54,19 @@ onMounted(() => {
span {
flex-grow: 1;
padding-right: 24px;
padding-right: 20px;
white-space: nowrap;
}
img {
filter: invert(1);
width: 16px;
height: 16px;
}
.context-menu-swatch {
width: 14px;
height: 14px;
flex-grow: 0;
padding-right: 0;
border-radius: 4px;
border: 1px solid var(--color-border);
flex-shrink: 0;
width: 18px;
height: 18px;
}
&:hover {
background-color: var(--color-background-softest);
}
> .context-menu {
display: none !important;
}
&:hover > .context-menu {
display: flex !important;
}
}
}
</style>

View File

@@ -1,23 +1,25 @@
<script setup>
import { computed, onMounted, ref } from 'vue';
import { onMounted, ref } from 'vue';
import { AddSound } from '../../services/Sound';
import { useCampaignService } from '~/services/Campaign';
import { ClearWindow, CreateChildWindow, GetFirstWindowId } from '~/services/Windows';
import { ClearWindow } from '~/services/Windows';
const { SetCampaign } = useCampaignService();
const props = defineProps(['data']);
const data = props.data;
const title = computed(() => data.name);
const campaignStyle = computed(() => data.color
? { background: `linear-gradient(90deg, ${data.color}, ${data.color}44)` }
: {});
const title = ref("");
const container = ref(null);
onMounted(() => {
title.value = data.name;
if (data.color && container.value) {
container.value.style.background = `linear-gradient(90deg, ${data.color}, ${data.color}44)`;
}
AddSound(container.value)
});
@@ -25,16 +27,11 @@ function ViewCampaign(){
SetCampaign(data);
ClearWindow({type: "main_menu"});
}
function OpenSettings(){
ClearWindow({type: 'campaign_settings'});
CreateChildWindow(GetFirstWindowId('main_menu'), 'campaign_settings', { campaign: data });
}
</script>
<template>
<div class="campaign-entry-container" ref="container" :style="campaignStyle">
<div class="campaign-entry-container" ref="container">
<div class="main-campaign-entry-container-inner">
<img class="campaign-icon" src="/img/def-avatar.jpg" draggable="false">
<div class="campaign-info">
@@ -42,7 +39,6 @@ function OpenSettings(){
</div>
<div class="campaign-user-actions">
<button class="btn-primary button-small sound-click" v-on:click.prevent="OpenSettings">{{ $t('main-menu.settings') }}</button>
<button class="btn-primary button-small sound-click" v-on:click.prevent="ViewCampaign">{{ $t('general.open')}}</button>
</div>
</div>
@@ -51,6 +47,7 @@ function OpenSettings(){
<style lang="scss" scoped>
.button-small {
height: 32px;
padding: 10px;
}
@@ -85,7 +82,5 @@ function OpenSettings(){
.campaign-user-actions {
margin-left: auto;
display: flex;
gap: 6px;
}
</style>

View File

@@ -1,72 +1,69 @@
<script setup>
import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { computed, onMounted, onUnmounted, ref, watch } from 'vue';
import { useCampaignService } from '~/services/Campaign.js';
import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js';
import { FetchCampaignNotes, PushNote, TotalNotes } from '~/services/Content';
import { emitter } from '~/services/Emitter';
import Server from '~/services/Server';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import NestedNoteList from './NestedNoteList.vue';
const { Campaign } = useCampaignService();
const { t } = useI18n();
const notes = ref([]);
const folders = ref([]);
const actors = ref([]);
const items = ref([]);
const maps = ref([]);
const entryLists = { actor: actors, item: items, map: maps };
const loadingNotes = ref(false);
const loadingEntries = ref(false);
const notesError = ref('');
const entriesError = ref('');
const sidebarCollapsed = ref(false);
const activeSection = ref('notes');
const isDragOverSidebar = ref(false);
const expandedFolderIds = ref([]);
const expandedEntryIds = ref([]);
const nestedNoteListRef = ref(null);
let entryRefreshInterval;
async function handleSidebarDrop(event) {
if (activeSection.value !== 'notes') return;
const noteKey = event.dataTransfer.getData('text/plain');
if (!noteKey) return;
try {
await Server().post('/note/update', { id: noteKey, folder: null });
if (nestedNoteListRef.value) {
nestedNoteListRef.value.clearCacheAndReloadExpanded();
} else {
fetchCampaignNotes();
}
} catch (e) {}
const selectedTool = ref('');
const campaignId = computed(() => {
return Campaign.value?._id ?? Campaign.value?.id ?? null;
});
const notesMeta = computed(() => {
const count = TotalNotes.value.length;
return `${count} ${count === 1 ? 'note' : 'notes'}`;
});
function toggleSidebar() {
sidebarCollapsed.value = !sidebarCollapsed.value;
}
function toggleExpandedFolder(folderId) {
const arr = expandedFolderIds.value;
const idx = arr.indexOf(folderId);
if (idx !== -1) {
arr.splice(idx, 1);
} else {
arr.push(folderId);
async function createNote() {
if (!Campaign.value) {
return;
}
const campaignId = Campaign.value?._id
try {
const response = await Server().post('/note/create', {
title: 'New note',
content: "",
campaign: campaignId
});
if (response.data.status !== 'ok') {
return;
}
emitter.emit('note-created', response.data.note);
} catch (err) {
console.log(err);
}
}
function isFolderExpanded(folderId) {
return expandedFolderIds.value.includes(folderId);
}
function openNote(note) {
emitter.emit('push-note', note);
PushNote(note);
}
function handleNoteCreated(note) {
if (!note) return;
if (!note) {
return;
}
const noteCampaignId = note.campaign?._id ?? note.campaign ?? null;
if (campaignId.value && noteCampaignId && noteCampaignId !== campaignId.value) return;
if (campaignId.value && noteCampaignId && noteCampaignId !== campaignId.value) {
return;
}
const createdNote = {
key: note._id,
@@ -75,325 +72,39 @@ function handleNoteCreated(note) {
date: note.date
};
notes.value = notes.value.filter((currentNote) => currentNote.key !== createdNote.key);
// Notes created inside a folder are added by NestedNoteList's own cache handler
const noteFolderId = note.folder?._id ?? note.folder ?? null;
if (!noteFolderId) {
notes.value.unshift(createdNote);
}
TotalNotes.value = TotalNotes.value.filter((currentNote) => {
return currentNote.key !== createdNote.key;
});
TotalNotes.value.unshift(createdNote);
openNote(createdNote);
}
function handleNoteRenamed(data) {
const note = notes.value.find(n => n.key === data.key);
if (note) {
note.title = data.title;
}
emitter.emit('title-updated', { key: data.key, title: data.title });
}
function handleNoteDeleted(noteKey) {
notes.value = notes.value.filter(n => n.key !== noteKey);
}
function handleFolderSaved() {
fetchCampaignNotes();
}
function handleFolderDeleted(folderId) {
expandedFolderIds.value = expandedFolderIds.value.filter((id) => id !== folderId);
}
function handleCampaignEntryCreated({ entityType, entry }) {
if (!entry || (entry.campaign && String(entry.campaign) !== String(campaignId.value))) return;
const list = entryLists[entityType];
if (!list) return;
list.value = [...list.value.filter((current) => current._id !== entry._id), entry]
.sort((a, b) => a.name.localeCompare(b.name));
}
function handleCampaignEntryUpdated({ entityType, entry }) {
if (!entry) return;
const list = entryLists[entityType];
if (!list) return;
list.value = list.value.map((current) => current._id === entry._id ? entry : current)
.sort((a, b) => a.name.localeCompare(b.name));
// The anchored map is this very entry (its pins changed, say): write it back without touching
// the pane, so switching back from the notes still shows what is on the map.
if (entityType === 'map' && AnchoredMap.value?._id === entry._id) AnchoredMap.value = entry;
}
const campaignId = computed(() => {
return Campaign.value?._id ?? Campaign.value?.id ?? null;
});
async function fetchCampaignNotes() {
if (!campaignId.value) {
notes.value = [];
folders.value = [];
notesError.value = '';
return;
}
loadingNotes.value = true;
notesError.value = '';
try {
const response = await Server().get('/note/list', { params: { campaign: campaignId.value } });
if (response.data.status !== 'ok') {
notes.value = [];
folders.value = [];
notesError.value = response.data.msg ?? 'Unable to load notes.';
return;
}
folders.value = response.data.folders.map((folder) => ({
_id: folder._id, name: folder.name, date: folder.date, color: folder.color
}));
notes.value = response.data.notes.map((note) => {
return { key: note._id, title: note.title, text: note.content ?? '', date: note.date, color: note.color };
});
} catch (error) {
notes.value = [];
folders.value = [];
notesError.value = 'Unable to load notes.';
} finally {
loadingNotes.value = false;
}
}
function entryEntityType(section) {
if (section === 'actors') return 'actor';
if (section === 'items') return 'item';
if (section === 'maps') return 'map';
return null;
}
function isEntrySection(section) {
return entryEntityType(section) !== null;
}
async function fetchCampaignEntries(entityType = activeSection.value, silent = false) {
const kind = entryEntityType(entityType);
const list = entryLists[kind];
if (!campaignId.value || !list) return;
if (!silent) {
loadingEntries.value = true;
entriesError.value = '';
}
try {
const response = await Server().get(`/${kind}/list`, { params: { campaign: campaignId.value } });
if (response.data.status !== 'ok') {
if (!silent) entriesError.value = response.data.msg ?? t('campaigns.errors.load');
return;
}
const previousById = new Map(list.value.map((entry) => [entry._id, entry]));
list.value = response.data[entityType] ?? [];
// Tell open windows about Foundry changes landing behind them.
for (const entry of list.value) {
const previous = previousById.get(entry._id);
if (previous && JSON.stringify(previous) !== JSON.stringify(entry)) {
emitter.emit('campaign-entry-updated', { entityType: kind, entry });
}
}
} catch (error) {
if (!silent) entriesError.value = t('campaigns.errors.load');
} finally {
if (!silent) loadingEntries.value = false;
}
}
function selectSection(section) {
activeSection.value = section;
if (isEntrySection(section)) fetchCampaignEntries(section);
// The content area follows the sidebar: maps shows the anchored map, everything else the
// notes that are currently open.
SetActivePane(section === 'maps' && AnchoredMap.value ? 'map' : 'notes');
}
function createEntry(entityType) {
if (!campaignId.value) return;
if (entityType === 'map') {
CreateWindow('create_map', { campaign: campaignId.value });
return;
}
CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value });
}
function entrySummary(actor) {
const bits = [t(`campaigns.actor.types.${actor.type}`)];
if (actor.species) bits.push(actor.species);
if (actor.className) bits.push(actor.className);
if (actor.level) bits.push(`${t('campaigns.actor.level-short')} ${actor.level}`);
if (actor.challengeRating) bits.push(`${t('campaigns.actor.cr-short')} ${actor.challengeRating}`);
return bits.join(' · ');
}
function itemSummary(item) {
return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`;
}
function mapSummary(map) {
return t('campaigns.map.summary', { size: map.gridSize, scale: map.scale });
}
function editItem(entry) {
if (!campaignId.value) return;
CreateWindow('create_campaign_entry', { entityType: 'item', campaign: campaignId.value, entry });
}
function editMap(map) {
if (!campaignId.value) return;
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
}
function showEntryMenu(entry, entityType) {
const list = entryLists[entityType];
const menuItems = [];
// Characters are edited in their sheet; items and maps get their window in edit mode.
if (entityType === 'item') {
menuItems.push({
name: t('campaigns.actions.edit'),
icon: '/icons/iconoir/regular/edit.svg',
action: () => { HideContextMenu(); editItem(entry); }
});
} else if (entityType === 'map') {
menuItems.push({
name: t('campaigns.actions.edit'),
icon: '/icons/iconoir/regular/edit.svg',
action: () => { HideContextMenu(); editMap(entry); }
});
}
menuItems.push({
name: t('campaigns.actions.delete'),
icon: '/icons/iconoir/regular/trash.svg',
action: async () => {
try {
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
if (response.data.status === 'ok' && list) {
list.value = list.value.filter((current) => current._id !== entry._id);
if (entityType === 'map' && isAnchoredMap(entry)) ClearAnchoredMap();
}
} catch (error) {} finally { HideContextMenu(); }
}
});
ShowContextMenu(menuItems);
}
function toggleEntryDetails(entryId) {
expandedEntryIds.value = expandedEntryIds.value.includes(entryId)
? expandedEntryIds.value.filter((id) => id !== entryId)
: [...expandedEntryIds.value, entryId];
}
async function openCharacterSheet(actor) {
const existingWindowId = GetFirstWindowId('character_sheet');
if (existingWindowId !== undefined) {
ClearWindow({ id: existingWindowId });
await nextTick();
}
CreateWindow('character_sheet', { actor });
}
// Maps are anchored on the note container instead of opening a window: the notes that were open
// stay open, and the sidebar's notes/maps buttons switch between the two.
function openMapViewer(map) {
if (!map) return;
const floatingViewer = GetFirstWindowId('map_viewer');
if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
AnchorMap(map);
}
function isAnchoredMap(map) {
return AnchoredMap.value?._id === map._id;
}
function createNote() {
if (!Campaign.value) return;
CreateWindow('new_note', { campaign: campaignId.value });
}
function createFolder() {
CreateWindow('new_folder', { campaign: campaignId.value });
}
function toggleSidebar() {
sidebarCollapsed.value = !sidebarCollapsed.value;
}
const rootNotes = computed(() => notes.value.filter(n => !n._folder));
watch(campaignId, (newVal) => {
if (newVal) {
actors.value = [];
items.value = [];
maps.value = [];
ClearAnchoredMap();
fetchCampaignNotes();
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
} else {
notes.value = [];
folders.value = [];
actors.value = [];
items.value = [];
maps.value = [];
notesError.value = '';
entriesError.value = '';
ClearAnchoredMap();
}
});
onMounted(() => {
selectedTool.value = 'notes';
FetchCampaignNotes();
emitter.on('note-created', handleNoteCreated);
emitter.on('note-renamed', handleNoteRenamed);
emitter.on('delete-note', handleNoteDeleted);
emitter.on('folder-saved', handleFolderSaved);
emitter.on('folder-deleted', handleFolderDeleted);
emitter.on('campaign-entry-created', handleCampaignEntryCreated);
emitter.on('campaign-entry-updated', handleCampaignEntryUpdated);
if (campaignId.value) {
fetchCampaignNotes();
}
entryRefreshInterval = setInterval(() => {
// Synced Foundry entries land in the background for both lists.
if ((activeSection.value === 'actors' || activeSection.value === 'items') && campaignId.value) {
fetchCampaignEntries(activeSection.value, true);
}
}, 5000);
});
onBeforeUnmount(() => {
clearInterval(entryRefreshInterval);
onUnmounted(() => {
emitter.off('note-created', handleNoteCreated);
emitter.off('note-renamed', handleNoteRenamed);
emitter.off('delete-note', handleNoteDeleted);
emitter.off('folder-saved', handleFolderSaved);
emitter.off('folder-deleted', handleFolderDeleted);
emitter.off('campaign-entry-created', handleCampaignEntryCreated);
emitter.off('campaign-entry-updated', handleCampaignEntryUpdated);
});
watch(Campaign, () => {
FetchCampaignNotes();
}, { immediate: true });
</script>
<template>
<div class="sidebar-shell">
<nav class="sidebar-actions" aria-label="Campaign tools">
<nav class="sidebar-tools" aria-label="Campaign tools">
<button
class="sidebar-action"
type="button"
@click="toggleSidebar"
:aria-expanded="(!sidebarCollapsed).toString()"
aria-controls="campaign-section-list"
:title="sidebarCollapsed ? t('campaigns.actions.expand-sidebar') : t('campaigns.actions.collapse-sidebar')"
:aria-label="sidebarCollapsed ? t('campaigns.actions.expand-sidebar') : t('campaigns.actions.collapse-sidebar')"
aria-controls="campaign-notes-list"
:title="sidebarCollapsed ? 'Expand notes' : 'Collapse notes'"
:aria-label="sidebarCollapsed ? 'Expand notes' : 'Collapse notes'"
>
<img
class="sidebar-action-icon"
@@ -405,125 +116,75 @@ onBeforeUnmount(() => {
<button
class="sidebar-action"
:class="{ selected: activeSection === 'notes' }"
type="button" @click="selectSection('notes')"
:title="t('campaigns.sections.notes')" :aria-label="t('campaigns.sections.notes')"
:aria-pressed="(activeSection === 'notes').toString()"
type="button"
@click="selectedTool = 'notes'"
:class="{ active: selectedTool === 'notes' }"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/book.svg" alt="" aria-hidden="true">
</button>
<button
class="sidebar-action"
:class="{ selected: activeSection === 'actors' }"
type="button" @click="selectSection('actors')"
:title="t('campaigns.sections.actors')" :aria-label="t('campaigns.sections.actors')"
:aria-pressed="(activeSection === 'actors').toString()"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/user.svg" alt="" aria-hidden="true">
</button>
<button
class="sidebar-action"
:class="{ selected: activeSection === 'items' }"
type="button" @click="selectSection('items')"
:title="t('campaigns.sections.items')" :aria-label="t('campaigns.sections.items')"
:aria-pressed="(activeSection === 'items').toString()"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/box.svg" alt="" aria-hidden="true">
</button>
<button
class="sidebar-action"
:class="{ selected: activeSection === 'maps' }"
type="button" @click="selectSection('maps')"
:title="t('campaigns.sections.maps')" :aria-label="t('campaigns.sections.maps')"
:aria-pressed="(activeSection === 'maps').toString()"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/map.svg" alt="" aria-hidden="true">
<img
class="sidebar-action-icon"
:src="'/icons/iconoir/regular/bookmark-book.svg'"
alt=""
aria-hidden="true"
>
</button>
</nav>
<aside class="notes-sidebar" :class="{ collapsed: sidebarCollapsed }">
<div class="sidebar-actions">
<button
class="sidebar-action"
type="button"
@click="createNote"
:disabled="!Campaign"
title="New note"
aria-label="New note"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button
class="sidebar-action"
type="button"
@click="fetchCampaignNotes"
:disabled="!Campaign || loadingNotes"
title="Refresh notes"
aria-label="Refresh notes"
>
<img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
</button>
</div>
<div class="sidebar-header">
<div class="sidebar-copy">
<span class="sidebar-eyebrow">{{ t('campaigns.sidebar-label') }}</span>
<strong class="sidebar-title">{{ t(`campaigns.sections.${activeSection}`) }}</strong>
</div>
<div class="sidebar-header-actions">
<template v-if="activeSection === 'notes'">
<button class="sidebar-action" type="button" @click="createNote" :disabled="!Campaign" :title="t('campaigns.actions.new-note')" :aria-label="t('campaigns.actions.new-note')">
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button class="sidebar-action" type="button" @click="createFolder" :disabled="!Campaign" :title="t('campaigns.actions.new-folder')" :aria-label="t('campaigns.actions.new-folder')">
<img class="sidebar-action-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
</button>
<button class="sidebar-action" type="button" @click="fetchCampaignNotes" :disabled="!Campaign || loadingNotes" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
<img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
</button>
</template>
<template v-else>
<button class="sidebar-action" type="button" @click="createEntry(entryEntityType(activeSection))" :disabled="!Campaign" :title="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })" :aria-label="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })">
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button class="sidebar-action" type="button" @click="fetchCampaignEntries(activeSection)" :disabled="!Campaign || loadingEntries" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
<img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
</button>
</template>
<span class="sidebar-eyebrow">Campaign</span>
<strong class="sidebar-title">Notes</strong>
<span class="sidebar-meta">{{ notesMeta }}</span>
</div>
</div>
<div class="sidebar-list-drop-wrap" :class="{ 'drag-over': activeSection === 'notes' && isDragOverSidebar }" id="campaign-section-list" @dragenter.self="isDragOverSidebar = true" @dragleave.self="isDragOverSidebar = false" @dragover.prevent @drop.stop="handleSidebarDrop">
<template v-if="activeSection === 'notes'">
<div v-if="loadingNotes" class="sidebar-state">{{ t('campaigns.states.loading-notes') }}</div>
<div v-else-if="notesError" class="sidebar-state error">{{ notesError }}</div>
<div v-else-if="folders.length === 0 && notes.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-notes') }}</div>
<NestedNoteList v-else ref="nestedNoteListRef"
:parent-folder-id="null" :folders="folders" :notes="rootNotes" :campaign-id="campaignId"
:expanded-folder-ids="expandedFolderIds" @open-note="openNote"
@reload-notes="fetchCampaignNotes" @toggle-expanded-folder="toggleExpandedFolder" />
</template>
<div id="campaign-notes-list" class="sidebar-list">
<div v-if="loadingNotes" class="sidebar-state">
Loading notes...
</div>
<template v-else-if="activeSection === 'actors'">
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
<div v-else-if="actors.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-actors') }}</div>
<div v-for="actor in actors" :key="actor._id" class="entity-entry" role="button" tabindex="0" @click="openCharacterSheet(actor)" @keydown.enter="openCharacterSheet(actor)" @keydown.space.prevent="openCharacterSheet(actor)" @contextmenu.prevent="showEntryMenu(actor, 'actor')">
<span class="entity-entry-name">{{ actor.name }}</span>
<span class="entity-entry-meta">{{ entrySummary(actor) }}</span>
</div>
</template>
<div v-else-if="notesError" class="sidebar-state error">
{{ notesError }}
</div>
<template v-else-if="activeSection === 'items'">
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
<div v-else-if="items.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-items') }}</div>
<div v-for="item in items" :key="item._id" class="entity-entry" role="button" tabindex="0" :aria-expanded="expandedEntryIds.includes(item._id)" @click="toggleEntryDetails(item._id)" @keydown.enter="toggleEntryDetails(item._id)" @keydown.space.prevent="toggleEntryDetails(item._id)" @contextmenu.prevent="showEntryMenu(item, 'item')">
<span class="entity-entry-name-row">
<span class="entity-entry-name">{{ item.name }}</span>
<span v-if="item.foundryItemId" class="entity-entry-sync">{{ t('campaigns.synced') }}</span>
</span>
<span class="entity-entry-meta">{{ itemSummary(item) }}</span>
<template v-if="expandedEntryIds.includes(item._id)">
<span v-if="item.weight !== undefined" class="entity-entry-description">{{ item.weight }} lb</span>
<span v-if="item.properties" class="entity-entry-description">{{ item.properties }}</span>
<span v-if="item.description" class="entity-entry-description">{{ item.description }}</span>
</template>
</div>
</template>
<div v-else-if="TotalNotes.length === 0" class="sidebar-state">
No notes in this campaign yet.
</div>
<template v-else>
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
<div v-for="map in maps" :key="map._id" class="entity-entry" :class="{ anchored: isAnchoredMap(map) }" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
<span class="entity-entry-name-row">
<span class="entity-entry-name">{{ map.name }}</span>
<span v-if="isAnchoredMap(map)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span>
</span>
<span class="entity-entry-meta">{{ mapSummary(map) }}</span>
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
</div>
<button
v-for="note in TotalNotes"
:key="note.key"
type="button"
class="note-link"
@click="openNote(note)"
>
<span class="note-link-title">{{ note.title }}</span>
</button>
</template>
</div>
</aside>
@@ -533,13 +194,13 @@ onBeforeUnmount(() => {
<style scoped>
.sidebar-shell {
min-height: 0;
flex-shrink: 0;
display: flex;
flex-direction: row;
}
.sidebar-actions {
width: 46px;
min-width: 46px;
.sidebar-tools {
width: 32px;
min-width: 32px;
padding: 8px 6px;
border-right: 1px solid var(--color-border);
background-color: var(--color-background-light);
@@ -549,6 +210,11 @@ onBeforeUnmount(() => {
gap: 4px;
}
.sidebar-actions {
display: flex;
justify-content: center;
}
.sidebar-action {
width: 34px;
height: 34px;
@@ -562,15 +228,18 @@ onBeforeUnmount(() => {
align-items: center;
justify-content: center;
cursor: pointer;
}
.sidebar-action.selected {
background: var(--color-button-hover);
border-color: var(--color-link);
&.active {
background-color: var(--color-selected);
}
}
.sidebar-action:hover {
background: var(--color-button-hover);
&.active {
background-color: var(--color-selected);
}
}
.sidebar-action:disabled {
@@ -585,8 +254,8 @@ onBeforeUnmount(() => {
}
.notes-sidebar {
min-width: 280px;
width: 280px;
min-width: 280px;
border-right: 1px solid var(--color-border);
background-color: var(--color-background-light);
display: flex;
@@ -607,16 +276,11 @@ onBeforeUnmount(() => {
box-sizing: border-box;
padding: 12px;
display: flex;
align-items: center;
justify-content: space-between;
gap: 8px;
align-items: flex-start;
gap: 10px;
border-bottom: 1px solid var(--color-border);
}
.sidebar-header-actions { display: flex; align-items: center; gap: 4px; }
.sidebar-header-actions .sidebar-action { width: 30px; height: 30px; }
.sidebar-header-actions .sidebar-action-icon { width: 16px; height: 16px; }
.sidebar-copy {
display: flex;
flex-direction: column;
@@ -635,7 +299,7 @@ onBeforeUnmount(() => {
word-break: break-word;
}
.sidebar-list-drop-wrap {
.sidebar-list {
width: 280px;
min-width: 280px;
box-sizing: border-box;
@@ -643,14 +307,6 @@ onBeforeUnmount(() => {
display: flex;
flex-direction: column;
overflow-y: auto;
gap: 2px;
transition: background-color 0.15s ease;
flex: 1;
min-height: 0;
}
.sidebar-list-drop-wrap.drag-over {
background: var(--color-button-hover);
}
.sidebar-state {
@@ -664,25 +320,34 @@ onBeforeUnmount(() => {
color: #9e2a2b;
}
.entity-entry {
width: 100%; padding: 9px 10px; border: 1px solid transparent; border-radius: 8px;
background: transparent; color: var(--color-text); text-align: left; display: flex; flex-direction: column;
gap: 3px; cursor: pointer;
.note-link {
width: 100%;
padding: 6px;
margin: 0;
box-shadow: none;
border: none;
display: flex;
flex-direction: column;
align-items: flex-start;
text-align: left;
cursor: pointer;
transition: transform 0.15s ease, background-color 0.15s ease;
}
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
/* The map currently anchored on the note container. */
.entity-entry.anchored { border-color: var(--color-link); background: var(--color-background-soft); }
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; }
.entity-entry-name { font-weight: bold; }
.entity-entry-sync {
font-size: 10px;
letter-spacing: 0.04em;
text-transform: uppercase;
opacity: 0.6;
.note-link:hover {
transform: translateX(2px);
background: var(--color-background-light);
}
.note-link-title {
font-weight: 600;
word-break: break-word;
}
.note-link-date {
font-size: 12px;
opacity: 0.7;
}
.entity-entry-meta, .entity-entry-description { font-size: 12px; opacity: 0.72; }
.entity-entry-description { display: -webkit-box; -webkit-box-orient: vertical; -webkit-line-clamp: 2; overflow: hidden; }
@media (max-width: 900px) {
.notes-sidebar {
@@ -691,7 +356,7 @@ onBeforeUnmount(() => {
}
.sidebar-header,
.sidebar-list-drop-wrap {
.sidebar-list {
width: 220px;
min-width: 220px;
}

View File

@@ -109,6 +109,7 @@ onMounted(() => {
}
.button-small {
height: 32px;
padding: 10px;
}

View File

@@ -1,382 +0,0 @@
<script setup>
import { ref, onBeforeUnmount, onMounted, watch } from 'vue';
import { emitter } from '~/services/Emitter';
import Server from '~/services/Server';
import { CreateWindow } from '~/services/Windows';
import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu';
const props = defineProps({
folders: Array,
notes: Array,
campaignId: String,
level: { type: Number, default: 0 },
parentFolderId: String,
expandedFolderIds: { type: Array, default: () => [] }
});
const emit = defineEmits(['open-note', 'reload-notes']);
// Track which folder IDs have been requested to avoid duplicate requests
const loadingFolders = new Set();
const dragHoveredFolderId = ref(null);
// Preset colors for notes and folders (shown as swatches in the context menu)
const entryColors = [
{ name: 'Red', value: '#e74c3c' },
{ name: 'Orange', value: '#e67e22' },
{ name: 'Yellow', value: '#f1c40f' },
{ name: 'Green', value: '#2ecc71' },
{ name: 'Teal', value: '#1abc9c' },
{ name: 'Blue', value: '#3498db' },
{ name: 'Purple', value: '#9b59b6' },
{ name: 'Pink', value: '#fd79a8' }
];
// Cache of loaded folder contents — persists across reloads until cleared
// Each entry: { [folderId]: { notes: [], subfolders: [] } }
const folderContentCache = ref({});
function toggleExpanded(folderId) {
emit('toggle-expanded-folder', folderId);
}
watch(
() => props.expandedFolderIds,
() => {
if (props.level === 0) {
loadExpandedFolders();
}
},
{ deep: true }
);
onMounted(() => {
loadExpandedFolders();
emitter.on('note-created', handleNoteCreated);
emitter.on('note-renamed', handleNoteRenamed);
emitter.on('delete-note', handleNoteDeleted);
emitter.on('folder-saved', handleFolderSaved);
});
onBeforeUnmount(() => {
emitter.off('note-created', handleNoteCreated);
emitter.off('note-renamed', handleNoteRenamed);
emitter.off('delete-note', handleNoteDeleted);
emitter.off('folder-saved', handleFolderSaved);
});
// Keep this instance's folder content cache in sync with changes made anywhere in the app.
// The cache entry for a folder only lives on the instance that renders it, so every
// instance listens and updates whichever entries it owns.
function handleNoteCreated(note) {
if (!note) return;
const folderId = note.folder?._id ?? note.folder ?? null;
const entry = folderId ? folderContentCache.value[folderId] : null;
if (entry) {
entry.notes.unshift({ key: note._id, title: note.title, text: note.content || '' });
}
}
function handleNoteRenamed(data) {
if (!data) return;
for (const entry of Object.values(folderContentCache.value)) {
const note = entry.notes.find((n) => n.key === data.key);
if (note) note.title = data.title;
}
}
function handleNoteDeleted(noteKey) {
for (const entry of Object.values(folderContentCache.value)) {
entry.notes = entry.notes.filter((n) => n.key !== noteKey);
}
}
function handleFolderSaved(folder) {
const folderId = folder?._id ?? folder?.id;
if (!folderId) return;
for (const entry of Object.values(folderContentCache.value)) {
const subfolder = entry.subfolders.find((f) => (f._id ?? f.id) === folderId);
if (subfolder) subfolder.name = folder.name;
}
}
function loadFolderContents(folderId) {
if (loadingFolders.has(folderId)) return;
loadingFolders.add(folderId);
Server().get('/note/subfolder/list', { params: { campaign: props.campaignId, folder: folderId } })
.then(res => {
if (res.data.status !== 'ok') return;
folderContentCache.value[folderId] = {
notes: res.data.notes.map(n => ({ key: n._id, title: n.title, text: n.content || '', color: n.color })),
subfolders: res.data.subfolders || []
};
}).catch(() => {}).finally(() => {
loadingFolders.delete(folderId);
});
}
function getFolderNotes(folderId) {
return folderContentCache.value[folderId]?.notes || [];
}
function getFolderSubfolders(folderId) {
return folderContentCache.value[folderId]?.subfolders || [];
}
// Load contents for all currently-expanded folders
function loadExpandedFolders() {
const idsToLoad = props.level === 0
? props.expandedFolderIds
: (props.parentFolderId && props.expandedFolderIds.includes(props.parentFolderId) ? [props.parentFolderId] : []);
for (const id of idsToLoad) {
if (folderContentCache.value[id]) continue;
loadFolderContents(id);
}
}
async function handleDropNoteOnFolder(folderId, event) {
const noteKey = event.dataTransfer.getData('text/plain');
if (!noteKey || !folderId) return;
dragHoveredFolderId.value = null;
try {
await Server().post('/note/update', { id: noteKey, folder: folderId });
clearCacheAndReloadExpanded();
} catch (e) {}
}
async function handleDropNoteOnRoot(event) {
const noteKey = event.dataTransfer.getData('text/plain');
if (!noteKey) return;
dragHoveredFolderId.value = null;
try {
await Server().post('/note/update', { id: noteKey, folder: null });
clearCacheAndReloadExpanded();
} catch (e) {}
}
// Called on reload — clears cache and refetches what this instance is responsible for,
// then bubbles the reload up so ancestors (and eventually the sidebar) refresh too
function clearCacheAndReloadExpanded() {
const loadedIds = Object.keys(folderContentCache.value);
// Force reactivity by creating a new object
folderContentCache.value = {};
for (const id of loadedIds) {
loadFolderContents(id);
}
emit('reload-notes');
}
// Exposed to parent components
defineExpose({ clearCacheAndReloadExpanded });
function startDragNote(event, note) {
event.dataTransfer.setData('text/plain', note.key);
event.dataTransfer.effectAllowed = 'move';
}
function setDragHover(id) {
dragHoveredFolderId.value = id;
}
function clearDragHover() {
dragHoveredFolderId.value = null;
}
function buildNoteContextMenu(note) {
return [
{ name: 'Open', icon: '/icons/iconoir/regular/book.svg', action: () => emit('open-note', note) },
{ name: 'Rename', icon: '/icons/iconoir/regular/edit-pencil.svg', action: () => renameNote(note) },
{ name: 'Color', icon: '/icons/iconoir/regular/palette.svg', context: buildColorMenu('note', note) },
{
name: 'Move to Folder...', icon: '/icons/iconoir/regular/folder.svg',
context: buildMoveToMenu(note)
},
{ divider: true },
{ name: 'Delete', icon: '/icons/iconoir/regular/trash.svg', action: () => deleteNote(note) }
];
}
function buildFolderContextMenu(folder) {
if (!folder || !folder._id) return [];
return [
{ name: 'New Note Here', icon: '/icons/iconoir/regular/plus.svg', action: () => createNoteInFolder(folder._id) },
{ name: 'Rename', icon: '/icons/iconoir/regular/edit-pencil.svg', action: () => renameFolder(folder._id, folder.name) },
{ name: 'Color', icon: '/icons/iconoir/regular/palette.svg', context: buildColorMenu('folder', folder) },
{ name: 'Delete Folder', icon: '/icons/iconoir/regular/trash.svg', action: () => deleteFolder(folder._id) }
];
}
function buildColorMenu(kind, item) {
const colorItems = entryColors.map((color) => ({
name: color.name, color: color.value, action: () => setEntryColor(kind, item, color.value)
}));
colorItems.push({ divider: true });
colorItems.push({ name: 'Default', icon: '/icons/iconoir/regular/xmark-circle.svg', action: () => setEntryColor(kind, item, null) });
return colorItems;
}
async function setEntryColor(kind, item, color) {
const isNote = kind === 'note';
try {
const response = await Server().post(isNote ? '/note/update' : '/folder/update', {
id: isNote ? item.key : item._id,
color
});
if (response.data.status !== 'ok') return;
item.color = color;
} catch (e) {} finally {
HideContextMenu();
}
}
function entryColorStyle(item) {
return item.color ? { '--entry-color': item.color } : null;
}
let selectedNoteForMove = {};
function buildMoveToMenu(note) {
selectedNoteForMove = note;
const moveItems = (props.folders || []).map(folder => ({
name: folder.name, icon: '/icons/iconoir/regular/folder.svg', action: () => moveNoteToFolder(note, folder._id)
}));
if (moveItems.length > 0) moveItems.push({ divider: true });
moveItems.push({ name: '(Root)', icon: '/icons/iconoir/regular/book.svg', action: () => moveNoteToFolder(note, null) });
return moveItems;
}
function renameNote(note) { CreateWindow('rename_note', { title: note.title, key: note.key }); }
async function deleteNote(note) {
try {
const response = await Server().post('/note/delete', { id: note.key });
if (response.data.status === 'ok') emitter.emit('delete-note', note.key);
} catch (error) {} finally {
HideContextMenu();
}
}
function renameFolder(folderId, name) { CreateWindow('new_folder', { folderId, campaign: props.campaignId, name }); }
async function deleteFolder(folderId) {
const response = await Server().post('/folder/delete', { id: folderId });
if (response.data.status === 'ok') {
emitter.emit('folder-deleted', folderId);
clearCacheAndReloadExpanded();
}
HideContextMenu();
}
async function moveNoteToFolder(note, folderId) {
try {
const response = await Server().post('/note/update', { id: note.key, folder: folderId || null });
if (response.data.status !== 'ok') return;
clearCacheAndReloadExpanded();
} catch (e) {}
HideContextMenu();
}
function createNoteInFolder(folderId) {
CreateWindow('new_note', { campaign: props.campaignId, folder: folderId });
}
</script>
<template>
<div class="nested-list" :class="'level-' + level">
<!-- Folders at this level -->
<template v-for="folder in folders" :key="folder._id">
<div class="folder-item" :class="{ 'drag-over': dragHoveredFolderId === folder._id }"
@dragover.prevent="setDragHover(folder._id)"
@dragleave.self="clearDragHover"
@drop.stop="handleDropNoteOnFolder(folder._id, $event)">
<button type="button" class="folder-toggle" :class="{ 'has-color': !!folder.color }" :style="entryColorStyle(folder)" @click="toggleExpanded(folder._id)" @contextmenu.prevent="ShowContextMenu(buildFolderContextMenu(folder))">
<img
class="folder-arrow"
:src="expandedFolderIds.includes(folder._id) ? '/icons/iconoir/regular/nav-arrow-down.svg' : '/icons/iconoir/regular/nav-arrow-right.svg'"
alt="" aria-hidden="true"
>
<img class="folder-icon" src="/icons/iconoir/regular/folder.svg" alt="">
<span class="folder-name">{{ folder.name }}</span>
</button>
<div v-show="expandedFolderIds.includes(folder._id)"
class="folder-children" :class="{ 'drag-over': dragHoveredFolderId === folder._id }"
@dragover.prevent="setDragHover(folder._id)" @dragleave.self="clearDragHover"
@drop.stop="handleDropNoteOnFolder(folder._id, $event)">
<!-- Load contents now — cache will be populated on demand -->
<template v-if="expandedFolderIds.includes(folder._id) && !folderContentCache[folder._id]">
<div class="sidebar-state" style="font-size:13px;opacity:0.6;">Loading...</div>
</template>
<NestedNoteList
v-if="expandedFolderIds.includes(folder._id)"
:folders="getFolderSubfolders(folder._id)"
:notes="getFolderNotes(folder._id)"
:campaign-id="campaignId"
:level="level + 1"
:parent-folder-id="folder._id"
:expanded-folder-ids="expandedFolderIds"
@open-note="$emit('open-note', $event)"
@reload-notes="clearCacheAndReloadExpanded"
@toggle-expanded-folder="toggleExpanded"
/>
</div>
</div>
</template>
<!-- Notes at this level -->
<template v-for="note in notes" :key="note.key">
<button type="button" class="note-link" :class="{ 'has-color': !!note.color }" :style="entryColorStyle(note)" draggable="true" @dragstart="startDragNote($event, note)" @click.stop="$emit('open-note', note)" @contextmenu.prevent="ShowContextMenu(buildNoteContextMenu(note))">
<span class="note-link-title">{{ note.title }}</span>
</button>
</template>
<!-- Drop zone for root-level notes -->
<div v-if="level === 0" class="root-drop-zone" :class="{ 'drag-over': dragHoveredFolderId === 'root' }" @drop.stop="handleDropNoteOnRoot($event)">
</div>
<div v-if="folders.length === 0 && (!notes || notes.length === 0) && level === 0" class="sidebar-state">Empty</div>
</div>
</template>
<style scoped>
.nested-list { display: flex; flex-direction: column; gap: 2px; }
.folder-item { display: flex; flex-direction: column; cursor: default; border-radius: 10px; }
.folder-item.drag-over { background: var(--color-button-hover); }
.folder-toggle { width: 100%; padding: 6px 8px; margin: 0; border: none; background: transparent; display: flex; align-items: center; gap: 6px; cursor: grab; border-radius: 10px; color: var(--color-text); font-size: inherit; transition: background-color 0.15s ease; }
.folder-toggle:hover { background: var(--color-background-soft); }
.folder-toggle.has-color { background: color-mix(in srgb, var(--entry-color) 32%, transparent); }
.folder-toggle.has-color:hover { background: color-mix(in srgb, var(--entry-color) 50%, transparent); }
.folder-arrow { width: 14px; height: 14px; filter: invert(var(--color-icon-invert)); opacity: 0.5; }
.folder-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
.folder-name { font-weight: 500; flex: 1; text-align: left; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
.folder-children { padding-left: 20px; margin-top: 2px; cursor: default; }
.folder-children.drag-over { background: #ffffff22; border-radius: 10px; }
.note-link { width: 100%; padding: 6px; margin: 0; box-shadow: none; border: none; display: flex; flex-direction: column; align-items: flex-start; text-align: left; cursor: grab; border-radius: 8px; }
.note-link.has-color { background: color-mix(in srgb, var(--entry-color) 32%, transparent); }
.note-link.has-color:hover { background: color-mix(in srgb, var(--entry-color) 50%, transparent); }
.note-link-title { font-weight: 600; word-break: break-word; }
.sidebar-state { padding: 12px; border-radius: 10px; background: var(--color-background-soft); font-size: 14px; }
.root-drop-zone { min-height: 24px; position: relative; transition: background-color 0.15s ease, border-color 0.15s ease; border-radius: 10px; }
.root-drop-zone.drag-over { background: var(--color-button-hover); }
</style>

View File

@@ -1,26 +1,21 @@
<script setup>
import TopSearchBar from './topbar/TopSearchBar.vue';
import { useCampaignService } from '~/services/Campaign.js';
import { SetShowContent } from '~/services/Content.js';
import { ClearWindow, CreateWindow } from '~/services/Windows';
import { useCampaignService } from '~/services/Campaign';
import { CreateWindow } from '~/services/Windows';
import { SetShowContent } from '~/services/Content';
const { Campaign, SetCampaign } = useCampaignService();
const campaignName = computed(() => Campaign.value?.name || 'Campaign');
function OpenCampaignSettings() {
if (!Campaign.value) return;
ClearWindow({ type: 'campaign_settings' });
CreateWindow('campaign_settings', { campaign: Campaign.value });
}
const campaignName = computed(() => {
return Campaign.value?.name ?? 'Campaign';
});
function ExitCampaign() {
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
// l'espai de treball i reobre el menú
ClearWindow({ type: 'campaign_settings' });
function exitToMainMenu() {
SetCampaign(null);
SetShowContent(false);
CreateWindow('main_menu');
}
</script>
<template>
@@ -35,11 +30,9 @@ function ExitCampaign() {
<TopSearchBar></TopSearchBar>
</div>
<div class="right">
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
{{ $t('main-menu.settings') }}
</button>
<button class="btn-primary settings-button exit-button sound-click" type="button" @click="ExitCampaign">
{{ $t('main-menu.exit') }}
<button class="top-bar-button sound-click" type="button" @click="exitToMainMenu">
<img class="top-bar-button-icon" src="/icons/iconoir/regular/nav-arrow-left.svg" alt="" aria-hidden="true">
<span>Main Menu</span>
</button>
</div>
</div>
@@ -63,26 +56,16 @@ function ExitCampaign() {
left: 6px;
}
.left {
.left, .right {
flex: 1;
}
.center {
display: flex;
align-items: center;
}
.right {
display: flex;
align-items: center;
justify-content: flex-end;
flex: 1;
padding: 0 10px;
align-items: center;
gap: 8px;
}
.settings-button {
padding: 5px 10px;
padding-right: 10px;
}
.top-bar-title {
@@ -92,5 +75,27 @@ function ExitCampaign() {
font-weight: bold;
}
.top-bar-button,
.note-button {
height: 30px;
padding: 0 12px;
border: 1px solid var(--color-border);
border-radius: 8px;
background: var(--color-background-soft);
display: inline-flex;
align-items: center;
gap: 8px;
cursor: pointer;
}
.note-button:disabled {
opacity: 0.5;
cursor: not-allowed;
}
.top-bar-button-icon,
.note-button-icon {
width: 16px;
height: 16px;
}
</style>

View File

@@ -1,30 +1,13 @@
<script setup>
import NoteContainer from './NoteContainer.vue';
import MapViewerPane from '../map/MapViewerPane.vue';
import { ActivePane, AnchoredMap, ClearAnchoredMap } from '~/services/Content.js';
import { useCampaignService } from '~/services/Campaign.js';
import { CreateWindow } from '~/services/Windows';
const { Campaign } = useCampaignService();
// Detaching gives the map back a floating window and shows the open notes again.
function DetachMap() {
const map = AnchoredMap.value;
if (!map) return;
ClearAnchoredMap();
CreateWindow('map_viewer', { map, campaign: Campaign.value?._id ?? null });
}
</script>
<template>
<div class="content">
<NoteContainer v-show="ActivePane !== 'map'">
<NoteContainer>
</NoteContainer>
<div v-if="AnchoredMap" v-show="ActivePane === 'map'" class="anchored-map">
<MapViewerPane :map="AnchoredMap" anchored @detach="DetachMap"></MapViewerPane>
</div>
<!-- PowerMod -->
</div>
</template>
@@ -38,14 +21,4 @@ function DetachMap() {
align-items: center;
}
/* Hidden with v-show so the open notes stay mounted while the anchored map is displayed. */
.anchored-map {
width: 100%;
height: 100%;
min-width: 0;
flex-grow: 1;
display: flex;
flex-direction: column;
}
</style>

View File

@@ -1,126 +1,64 @@
<script setup>
import { onMounted, onUnmounted, ref, createApp } from 'vue';
import ToastManager from '~/components/managers/ToastManager.vue';
import { emitter } from '~/services/Emitter';
import { GetWidget, ParseMarkdown } from '~/services/Marker';
import Server from '~/services/Server';
import { DisplayToast } from '~/services/Toaster';
import { useI18n } from 'vue-i18n';
import TestWidget from '../widgets/TestWidget.vue';
import { DeleteNote, FetchCampaignNotes } from '~/services/Content';
// import { GetNote, GetContent } from '@/services/Content';
const props = defineProps(['text', 'title', 'noteKey']);
const { t } = useI18n();
const noteContent = ref(null); // Markdown text
const renderedContent = ref(null); // Container holding the compiled HTML (v-html)
const sourceText = ref(''); // Original markdown source, used for editing
const displayText = ref(''); // Compiled HTML from markdown
const editingMode = ref(false);
const title = ref(props.title);
const isDirty = ref(false);
const showClose = ref(false);
let savedState = { text: '', title: '' };
function markDirty() {
isDirty.value = sourceText.value !== savedState.text || title.value !== savedState.title;
}
const displayTitle = ref('');
function closeNote(){
// 'close-note' only closes the opened note; 'delete-note' is reserved for
// actual deletions (sidebar removal happens on that event instead)
emitter.emit('close-note', props.noteKey);
DeleteNote(props.noteKey);
}
const compiledMarkdown = computed(() => {
return ParseMarkdown(sourceText.value);
});
// Apps de widget muntades sobre aquest node. Les guardem per desmuntar-les
// abans de re-renderitzar o en desmuntar la nota (evita instancies orfes i
// que Vue intenti parchar nodes ja eliminats).
const mountedApps = [];
function unmountComponents() {
for (const app of mountedApps) {
try {
app.unmount();
} catch (err) {
// El contenidor pot ja no ser al DOM; ignorem i netegim igualment.
}
}
mountedApps.length = 0;
}
function mountComponents() {
// Només dins d'aquesta nota: evitar muntar (o tornari a muntar) widgets
// d'altres notes obertes, que ja tenen la seva app.
const root = renderedContent.value;
if (!root) return;
const widget_types = ['display', 'inline'];
// Should no need more
const widget_types = ['display', 'inline', 'link'];
widget_types.forEach((widget_type) => {
const nodes = root.querySelectorAll('.vue-component-' + widget_type);
const nodes = document.querySelectorAll('.vue-component-' + widget_type);
nodes.forEach(el => {
const widget = GetWidget(widget_type, el.dataset.component);
if (!widget) return; // widget desconegut: saltem en comptes de petar
try {
const app = createApp(widget, { content: el.dataset.content });
// Evita que un error dins del widget (p. ex. el parser de daus amb una
// expressio malformada) es converteixi en un error no controlat.
app.config.errorHandler = (err) => {
console.error('Widget error', el.dataset.component, err);
};
app.mount(el);
mountedApps.push(app);
} catch (err) {
console.error('Failed to mount widget', el.dataset.component, err);
}
const app = createApp(GetWidget(widget_type, el.dataset.component), { content: el.dataset.content });
app.mount(el);
});
});
}
///
function update(){
// Desmuntem les apps anteriors mentre els seus nodes encara son al DOM;
// la reassignacio de displayText (v-html) eliminaria els contenidors i
// desmuntar-les despres fallaria sobre nodes desaccelats.
unmountComponents();
displayText.value = compiledMarkdown.value;
setTimeout(() => {
setupHeadings();
setupCallout()
mountComponents();
}, 0);
}
watch(sourceText, markDirty);
watch(title, markDirty);
watch(sourceText, (newText) => {
// update();
});
onMounted(() => {
sourceText.value = props.text;
title.value = props.title;
savedState = { text: props.text, title: props.title };
emitter.on('title-updated', handleTitleUpdate);
displayTitle.value = props.title;
// window.addEventListener('keydown', handleKeydown);
setTimeout(() => setupCallout(), 0);
update();
});
function handleTitleUpdate(data) {
if (data.key !== props.noteKey) return;
title.value = data.title;
savedState.title = data.title;
}
onUnmounted(() => {
emitter.off('title-updated', handleTitleUpdate);
// window.removeEventListener('keydown', handleKeydown);
unmountComponents();
});
function handleKeydown(e) {
@@ -131,10 +69,6 @@ function handleKeydown(e) {
if(!editingMode.value){
update();
SaveNote(); // Save when switching to display mode
} else {
// Entrant en mode edicio, la vista prèvia (v-else) es destrueix;
// desmuntem els widgets per no deixar apps orfes.
unmountComponents();
}
return;
}
@@ -154,17 +88,13 @@ function SaveNote(){
title: title.value,
}).then((response) => {
if(response.data.status !== 'ok'){
// El contingut no s'ha guardat: mantenem el punt de "no desar" i
// avisem en lloc d'empassar-nos l'error silenciosament.
isDirty.value = true;
DisplayToast('red', t(response.data.msg || 'general.notes.save-error'), 3000);
// Handle error (e.g., show a notification)
return;
}
savedState = { text: sourceText.value, title: title.value };
isDirty.value = false;
// DisplayToast('green', "Note saved successfully.", 500);
FetchCampaignNotes();
}).catch((error) => {
isDirty.value = true;
DisplayToast('red', t('general.notes.save-error'), 3000);
// Handle error (e.g., show a notification)
});
}
@@ -213,113 +143,18 @@ function setupCallout() {
}
}
// --- Col·lapse de seccions (h1, h2, h3) a la vista prèvia ---
// Agrupa el contingut sota cada capçalera fins la seguent del mateix nivell o
// superior, de manera que en fer clic sobre la capçalera es plegui tota la seva
// secció (les sub-seccions s'hi inclouen, estil Obsidian).
function headingLevel(el) {
const tag = el && el.tagName;
if (tag === 'H1') return 1;
if (tag === 'H2') return 2;
if (tag === 'H3') return 3;
return 0; // h4+ i la resta es tracten com a contingut normal
const editTitle = (e) => {
title.value = e.target.innerText;
SaveNote();
}
function buildFoldTree(nodes) {
const pos = { i: 0 };
function parseSection(level) {
const heading = nodes[pos.i];
pos.i++;
const body = [];
while (pos.i < nodes.length) {
const lvl = headingLevel(nodes[pos.i]);
if (lvl && lvl <= level) break; // seguent secció del mateix nivell o superior
if (lvl) {
body.push(parseSection(lvl)); // sub-secció més profunda
} else {
body.push({ node: nodes[pos.i] });
pos.i++;
}
}
return { heading, body, level };
}
const top = [];
while (pos.i < nodes.length) {
const lvl = headingLevel(nodes[pos.i]);
if (lvl) {
top.push(parseSection(lvl));
} else {
top.push({ node: nodes[pos.i] });
pos.i++;
}
}
return top;
}
function renderFoldTree(items, target) {
for (const item of items) {
if (item.node) {
target.appendChild(item.node);
continue;
}
const wrapper = document.createElement('div');
wrapper.className = 'fold fold-h' + item.level;
item.heading.classList.add('fold-handle');
wrapper.appendChild(item.heading);
const body = document.createElement('div');
body.className = 'fold-body';
renderFoldTree(item.body, body);
wrapper.appendChild(body);
target.appendChild(wrapper);
}
}
function handleFoldClick(e) {
// No plegar quan es fa clic en un enllaç o se selecciona text
if (e.target.closest('a')) return;
const selection = window.getSelection();
if (selection && selection.toString()) return;
const handle = e.target.closest('.fold-handle');
if (!handle) return;
const wrapper = handle.parentElement;
if (!wrapper || !wrapper.classList.contains('fold')) return;
wrapper.classList.toggle('is-collapsed');
}
function setupHeadings() {
const container = renderedContent.value;
if (!container) return;
const nodes = Array.from(container.children);
if (!nodes.some((el) => headingLevel(el))) return;
const tree = buildFoldTree(nodes);
renderFoldTree(tree, container);
if (!container._foldBound) {
container.addEventListener('click', handleFoldClick);
container._foldBound = true;
}
}
</script>
<template>
<div class="note" @keydown="handleKeydown" tabindex="0">
<div class="note-stunt">
<div class="unsaved-wrapper" v-if="isDirty">
<div class="unsaved-dot"></div>
<div class="close-button close-hidden" v-on:click="closeNote">
<img class="icon" src="/icons/Pixelarticons/white/close.svg" alt="My Happy SVG"/>
</div>
</div>
<div class="close-button" v-else v-on:click="closeNote">
<div class="close-button" v-on:click="closeNote">
<img class="icon" src="/icons/Pixelarticons/white/close.svg" alt="My Happy SVG"/>
</div>
<span>{{ title }}</span>
@@ -327,8 +162,8 @@ function setupHeadings() {
<div class="note-content-container">
<textarea v-model="sourceText" class="full-editor" v-if="editingMode"></textarea>
<div v-else class="note-content" ref="noteContent">
<h1>{{ title }}</h1>
<div ref="renderedContent" v-html="displayText"></div>
<h1 contenteditable="true" ref="editableTitle" @input="editTitle">{{ displayTitle }}</h1>
<div ref="noteContent" v-html="displayText"></div>
</div>
</div>
@@ -347,46 +182,6 @@ function setupHeadings() {
user-select: none;
}
.unsaved-wrapper {
position: relative;
margin-bottom: 5px;
width: 20px;
height: 20px;
}
.unsaved-dot {
width: 10px;
height: 10px;
border-radius: 50%;
background-color: #ffffff;
position: absolute;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
pointer-events: none;
}
.close-hidden {
opacity: 0;
visibility: hidden;
position: absolute;
top: 0;
left: 0;
width: 20px;
height: 20px;
margin-bottom: 0;
transition: opacity 0.15s ease, visibility 0.15s ease;
}
.unsaved-wrapper:hover .close-hidden {
opacity: 1;
visibility: visible;
}
.unsaved-wrapper:hover .unsaved-dot {
opacity: 0;
}
.full-editor {
width: 100%;
height: 100%;

View File

@@ -1,20 +1,23 @@
<script setup>
import { onMounted, onUnmounted, ref } from 'vue';
import { ref } from 'vue';
import Note from './Note.vue';
import { emitter } from '~/services/Emitter';
import { SetActivePane } from '~/services/Content.js';
let noteData = ref([]);
import { CurrentNotes, TotalNotes } from '~/services/Content';
const noteContainer = ref(null);
const computedCurrentNotes = computed(() => {
return CurrentNotes.value
.map(key => TotalNotes.value.find(note => note.key === key))
.filter(Boolean);
})
function calculateContainerWidth(){
let dom = noteContainer.value;
if (!dom) {
return;
}
dom.style.width = noteData.value.length * 701 + "px";
dom.style.width = CurrentNotes.value.length * 701 + "px";
setTimeout(() => {
for(let i = 0; i < dom.children.length; i++){
@@ -26,56 +29,14 @@ function calculateContainerWidth(){
}, 0);
}
function pushNote(note){
noteData.value = noteData.value.filter((currentNote) => {
return currentNote.key !== note.key;
});
noteData.value.push(note);
calculateContainerWidth();
}
function handlePushNote(note) {
// A note opened from the sidebar or the search palette always comes to the front, even when
// the content area is showing an anchored map.
SetActivePane('notes');
pushNote(note);
}
function handleDeleteNote(key) {
noteData.value = noteData.value.filter((note) => {
return note.key !== key;
});
calculateContainerWidth();
}
// Moure aixo
onMounted(() => {
emitter.on("push-note", handlePushNote);
emitter.on("close-note", handleDeleteNote);
emitter.on("delete-note", handleDeleteNote);
emitter.on("title-updated", handleTitleUpdated);
});
function handleTitleUpdated(data) {
const note = noteData.value.find(n => n.key === data.key);
if (note) {
note.title = data.title;
}
}
onUnmounted(() => {
emitter.off("push-note", handlePushNote);
emitter.off("close-note", handleDeleteNote);
emitter.off("delete-note", handleDeleteNote);
emitter.off("title-updated", handleTitleUpdated);
});
watch(CurrentNotes, calculateContainerWidth);
</script>
<template>
<div class="note-scrolling-container" id="note-scrolling-container">
<div class="note-container" ref="noteContainer" >
<Note v-for="element in noteData" :key="element.key" :text="element.text" :title="element.title" :noteKey="element.key"></Note>
<Note v-for="element in computedCurrentNotes" :key="element.key" :text="element.text" :title="element.title" :noteKey="element.key"></Note>
</div>
</div>
</template>

View File

@@ -1,410 +0,0 @@
<script setup>
import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '@/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
import { DisplayToast } from '~/services/Toaster';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
import { useCampaignService } from '~/services/Campaign.js';
// The map viewer without window chrome: it fills whatever flex column holds it, so the same
// component works inside MapViewerWindow.vue and anchored on the campaign content area.
const props = defineProps({
map: { type: Object, default: null },
// Anchored maps can be detached into a floating window; the window itself does not offer it.
anchored: { type: Boolean, default: false }
});
const emit = defineEmits(['detach']);
const { Campaign } = useCampaignService();
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
const map = ref(props.map ? { ...props.map } : null);
const viewport = ref(null);
const zoom = ref(1);
const pan = ref({ x: 0, y: 0 });
const imageSize = ref({ width: 0, height: 0 });
const showGrid = ref(true);
const dragging = ref(false);
const minZoom = 0.05;
const maxZoom = 8;
const imageUrl = computed(() => {
const image = map.value?.image;
if (!image) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
});
const stageStyle = computed(() => ({
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
}));
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
const gridStyle = computed(() => {
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
return {
width: `${imageSize.value.width * zoom.value}px`,
height: `${imageSize.value.height * zoom.value}px`,
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
backgroundSize: `${cell} ${cell}`
};
});
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
function clampZoom(value) {
if (!Number.isFinite(value)) return minZoom;
return Math.min(maxZoom, Math.max(minZoom, value));
}
function fitToWindow() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
centerOn();
}
function centerOn() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
pan.value = {
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
y: (bounds.height - imageSize.value.height * zoom.value) / 2
};
}
function onImageLoaded(event) {
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
fitToWindow();
}
// Zoom keeping the map point under `point` where it is.
function zoomAt(factor, point) {
const next = clampZoom(zoom.value * factor);
if (next === zoom.value) return;
const ratio = next / zoom.value;
pan.value = {
x: point.x - (point.x - pan.value.x) * ratio,
y: point.y - (point.y - pan.value.y) * ratio
};
zoom.value = next;
}
function onWheel(event) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
}
function zoomFromToolbar(incoming) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
}
let pointerId = null;
let lastPointer = { x: 0, y: 0 };
function onPointerDown(event) {
if (event.button !== 0 || !viewport.value) return;
dragging.value = true;
pointerId = event.pointerId;
lastPointer = { x: event.clientX, y: event.clientY };
viewport.value.setPointerCapture?.(event.pointerId);
}
function onPointerMove(event) {
if (!dragging.value || event.pointerId !== pointerId) return;
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
lastPointer = { x: event.clientX, y: event.clientY };
}
function onPointerUp(event) {
if (event.pointerId !== pointerId) return;
dragging.value = false;
pointerId = null;
viewport.value?.releasePointerCapture?.(event.pointerId);
}
function editMap() {
if (!map.value || !campaignId.value) return;
CreateWindow('create_map', { campaign: campaignId.value, entry: map.value });
}
function handleMapUpdated({ entityType, entry }) {
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
const imageChanged = entry.image !== map.value.image;
map.value = { ...entry };
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
if (imageChanged) imageSize.value = { width: 0, height: 0 };
}
// --- Notes pinned onto the map ---
// Right clicking the map pins one of the campaign notes at that spot, and clicking the marker reads
// it in a window of its own.
const { t } = useI18n();
const noteOptions = ref([]);
const pins = computed(() => map.value?.pins ?? []);
const labelByNoteId = computed(() => new Map(noteOptions.value.map((option) => [option.value, option.label])));
// What the pin helpers need to know about the current view to translate between image and screen.
function viewState() {
return { zoom: zoom.value, pan: pan.value, width: imageSize.value.width, height: imageSize.value.height };
}
function pinStyle(pin) {
const point = ToScreenPoint(pin, viewState());
return { left: `${point.x}px`, top: `${point.y}px` };
}
function pinLabel(pin) {
return labelByNoteId.value.get(String(pin?.note)) ?? '';
}
// Every note of the campaign, so notes living in a folder can be pinned too and every marker can
// say which note it is.
async function fetchPinnableNotes() {
if (!campaignId.value) {
noteOptions.value = [];
return;
}
try {
const response = await Server().get('/note/all', { params: { campaign: campaignId.value } });
noteOptions.value = response.data.status === 'ok'
? BuildNoteOptions(response.data.notes, response.data.folders)
: [];
} catch (error) {
noteOptions.value = [];
}
}
function onMapContextMenu(event) {
// A pin marks a spot on the image, so there is nothing to pin while the map has no image.
const bounds = viewport.value?.getBoundingClientRect();
if (!imageUrl.value || !bounds) return;
// Reaching a submenu moves the mouse away from the spot, so it is kept for the menu actions.
const spot = ToImagePoint({ x: event.clientX - bounds.left, y: event.clientY - bounds.top }, viewState());
if (!spot) return;
if (!noteOptions.value.length) {
ShowContextMenu([{ name: t('campaigns.map.pins.none'), action: () => HideContextMenu() }]);
return;
}
ShowContextMenu([{
name: t('campaigns.map.pins.add'),
icon: '/icons/iconoir/regular/map-pin-plus.svg',
context: noteOptions.value.map((option) => ({
name: option.label,
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); savePin(option.value, spot); }
}))
}]);
}
function onPinContextMenu(pin) {
ShowContextMenu([
{
name: t('campaigns.map.pins.open'),
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); openPinnedNote(pin); }
},
{ divider: true },
{
name: t('campaigns.map.pins.remove'),
icon: '/icons/iconoir/regular/map-pin-xmark.svg',
action: () => { HideContextMenu(); removePin(pin); }
}
]);
}
async function savePin(noteId, spot) {
await updatePins('/map/pin', { id: map.value?._id, note: noteId, x: spot.x, y: spot.y });
}
async function removePin(pin) {
await updatePins('/map/unpin', { id: map.value?._id, pin: pin?._id });
}
// Both pin changes answer with the whole map, which keeps the sidebar entry and the anchored map in
// step with what is on screen.
async function updatePins(route, body) {
if (!body.id) return;
try {
const response = await Server().post(route, body);
if (response.data.status !== 'ok') {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
return;
}
map.value = { ...response.data.map };
emitter.emit('campaign-entry-updated', { entityType: 'map', entry: response.data.map });
} catch (error) {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
}
}
async function openPinnedNote(pin) {
if (!pin?.note) return;
// One window reads the pinned notes; opening another one replaces it, like the character sheet.
const existingWindowId = GetFirstWindowId('pinned_note');
if (existingWindowId !== undefined) ClearWindow({ id: existingWindowId });
await nextTick();
CreateWindow('pinned_note', { note: pin.note });
}
// The backend drops the pins of a note along with it; the markers on this open map follow at once.
function handlePinnedNoteDeleted(noteKey) {
if (!pins.value.length) return;
const remaining = map.value.pins.filter((pin) => String(pin.note) !== String(noteKey));
if (remaining.length !== map.value.pins.length) map.value = { ...map.value, pins: remaining };
}
function handlePinnedNoteRenamed({ key, title }) {
const option = noteOptions.value.find((current) => current.value === String(key));
if (!option) return;
option.title = title;
option.label = OptionLabel(option);
}
// A different map was anchored while this pane was already mounted.
watch(() => props.map, (incoming, previous) => {
if (incoming === previous) return;
map.value = incoming ? { ...incoming } : null;
imageSize.value = { width: 0, height: 0 };
});
watch(campaignId, () => {
noteOptions.value = [];
fetchPinnableNotes();
});
onMounted(() => {
emitter.on('campaign-entry-updated', handleMapUpdated);
emitter.on('delete-note', handlePinnedNoteDeleted);
emitter.on('title-updated', handlePinnedNoteRenamed);
fetchPinnableNotes();
});
onBeforeUnmount(() => {
emitter.off('campaign-entry-updated', handleMapUpdated);
emitter.off('delete-note', handlePinnedNoteDeleted);
emitter.off('title-updated', handlePinnedNoteRenamed);
});
</script>
<template>
<div class="map-pane">
<div class="viewer-bar">
<div class="viewer-identity">
<strong>{{ map?.name }}</strong>
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
</div>
<div class="viewer-tools">
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
</button>
<span class="zoom-readout">{{ zoomPercent }}</span>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
</button>
<button v-if="anchored" class="viewer-tool" type="button" :title="$t('campaigns.map.open-window')" :aria-label="$t('campaigns.map.open-window')"
@click="emit('detach')">
<img class="tool-icon" src="/icons/iconoir/regular/open-in-window.svg" alt="" aria-hidden="true">
</button>
</div>
</div>
<div
ref="viewport"
class="map-viewport"
:class="{ dragging }"
@wheel.prevent="onWheel"
@pointerdown="onPointerDown"
@pointermove="onPointerMove"
@pointerup="onPointerUp"
@pointercancel="onPointerUp"
@contextmenu.prevent="onMapContextMenu"
>
<template v-if="imageUrl">
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
<div class="map-pins">
<button
v-for="pin in pins"
:key="pin._id"
class="map-pin"
type="button"
:style="pinStyle(pin)"
:title="pinLabel(pin) || $t('campaigns.map.pins.open')"
:aria-label="pinLabel(pin) || $t('campaigns.map.pins.open')"
@pointerdown.stop
@click="openPinnedNote(pin)"
@contextmenu.stop.prevent="onPinContextMenu(pin)"
>
<img class="pin-icon" src="/icons/iconoir/solid/pin.svg" alt="" aria-hidden="true">
<span class="pin-label">{{ pinLabel(pin) }}</span>
</button>
</div>
</template>
<div v-else class="map-empty">
{{ $t('campaigns.map.no-image') }}
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
</div>
</div>
</div>
</template>
<style scoped>
.map-pane { width: 100%; flex: 1; min-width: 0; min-height: 0; display: flex; flex-direction: column; overflow: hidden; }
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
.viewer-meta { font-size: 11px; opacity: .72; }
.viewer-tools { display: flex; align-items: center; gap: 4px; }
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
.viewer-tool:hover { background: var(--color-button-hover); }
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
.map-viewport.dragging { cursor: grabbing; }
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
/* Pins live in image pixels but are drawn in screen space (see ToScreenPoint), so the overlay stays
unscaled and their markers are readable at every zoom. Only the markers catch the mouse. */
.map-pins { position: absolute; inset: 0; pointer-events: none; }
.map-pin {
position: absolute; transform: translate(-50%, -100%); pointer-events: auto;
display: flex; align-items: center; gap: 4px; margin: 0; padding: 3px 6px;
border: 1px solid var(--color-link); border-radius: 7px;
background: var(--color-background-soft); color: var(--color-text);
font-size: 11px; cursor: pointer; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
}
.map-pin:hover { background: var(--color-button-hover); }
.map-pin:focus-visible { outline: 1px solid var(--color-link); }
.pin-icon { width: 12px; height: 12px; filter: invert(var(--color-icon-invert)); }
/* The note's name only when it is asked for: a map full of labels is a map nobody can read. */
.pin-label { display: none; max-width: 200px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
.map-pin:hover .pin-label, .map-pin:focus-visible .pin-label { display: inline; }
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
.map-edit:hover { background: var(--color-button-hover); }
</style>

View File

@@ -1,75 +0,0 @@
<script setup>
defineProps({
title: { type: String, default: '' },
subtitle: { type: String, default: '' },
link: { type: String, default: '' },
icon: { type: String, default: '' }
});
const emit = defineEmits(['select']);
function handleSelect() {
emit('select', { title: props.title, subtitle: props.subtitle, link: props.link });
}
</script>
<template>
<button class="search-result" @click="handleSelect">
<div class="search-result-left">
<img v-if="icon" class="result-icon" :src="icon" alt="">
<span class="result-title">{{ title }}</span>
</div>
<span v-if="subtitle" class="result-subtitle">{{ subtitle }}</span>
</button>
</template>
<style scoped>
.search-result {
width: 100%;
display: flex;
align-items: center;
justify-content: space-between;
padding: 8px 12px;
background: none;
border: none;
border-radius: 4px;
cursor: pointer;
color: inherit;
text-align: left;
font-family: inherit;
font-size: 14px;
transition: background-color 0.1s ease;
}
.search-result:hover,
.search-result.selected {
background-color: var(--color-search-hover);
}
.search-result-left {
display: flex;
align-items: center;
gap: 8px;
min-width: 0;
}
.result-icon {
width: 14px;
height: 14px;
filter: invert(var(--color-icon-invert));
opacity: 0.6;
flex-shrink: 0;
}
.result-title {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.result-subtitle {
font-size: 12px;
opacity: 0.5;
flex-shrink: 0;
}
</style>

View File

@@ -1,322 +1,110 @@
<script setup>
import { ref, onMounted, onUnmounted } from 'vue';
import SearchIcon from 'pixelarticons/svg/search.svg'
import PlusIcon from 'pixelarticons/svg/plus.svg'
import NoteSearchResult from './SearchResult.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
import { CreateWindow } from '~/services/Windows';
import { register, search as searchActions, execute as executeAction } from '~/services/ActionRegistry';
import { useCampaignService } from '~/services/Campaign.js';
/*
import { ref, onMounted } from 'vue';
import { GetArrayContent, GetContent } from '@/services/Content';
import useEmitter from '@/services/Emitter';
const { Campaign } = useCampaignService();
const emitter = useEmitter();
const inputText = ref('');
const notes = ref([]);
import NoteSearchElement from "@/components/topbar/NoteSearchElement.vue";
const showResults = ref(false);
const selectedIndex = ref(-1);
let noteLinks = ref([]);
let searchContainer = ref(null);
const focusInput = ref(null);
emitter.on("hide-search-container", () => {
searchContainer.value.style.display = "none";
})
// ---- Keyboard shortcut to open search ----
function globalKeydown(e) {
const modKey = e.metaKey || e.ctrlKey;
if ((modKey && e.key === 'k') || (e.key === '/' && !isInputFocused())) {
e.preventDefault();
focusInput.value?.focus();
}
if (e.key === 'Escape' && showResults.value) {
closeResults();
}
}
function updateList(event){
let content = GetArrayContent();
let query = "";
if(event !== undefined) query = event.target.value;
let filter = query.normalize("NFD").replace(/[\u0300-\u036f]/g, "").toUpperCase().trim();
function isInputFocused() {
const tag = document.activeElement?.tagName.toLowerCase();
return tag === 'input' || tag === 'textarea' || document.activeElement?.isContentEditable;
}
// ---- Registration of create-note action (extensibile for future commands) ----
function registerCreateNoteAction() {
const action = {
id: 'create_note',
label: 'New note',
description: 'Create a new note in the current campaign',
execute: () => {
if (!Campaign.value) return;
const campaignId = Campaign.value?._id ?? Campaign.value?.id;
CreateWindow('new_note', { campaign: campaignId });
}
};
register(action);
}
// ---- Note search ----
async function fetchNotes() {
if (!Campaign.value) return;
const campaignId = Campaign.value?._id ?? Campaign.value?.id;
try {
const response = await Server().get('/note/list', { params: { campaign: campaignId } });
if (response.data.status !== 'ok') {
notes.value = [];
return;
}
notes.value = response.data.notes.map(n => ({
key: n._id,
title: n.title || 'Untitled',
date: n.date
}));
} catch (err) {
notes.value = [];
}
}
function openNote(note) {
emitter.emit('push-note', note);
closeResults();
}
// ---- Unified results: notes + command actions ----
function getCombinedResults(query) {
const combined = [];
if (query && query.trim().length > 0) {
const q = query.normalize("NFD").replace(/[\u036f]/g, "").toLowerCase().trim();
// Filter notes that match the query text
const matchingNotes = notes.value.filter(note => {
const title = (note.title || '').normalize("NFD").replace(/[\u036f]/g, "").toLowerCase();
return title.includes(q);
noteLinks.value = content.filter((noteInfo) => {
return noteInfo["title"].normalize("NFD").replace(/[\u0300-\u036f]/g, "").toUpperCase().indexOf(filter) > -1;
});
for (const note of matchingNotes) {
combined.push({ type: 'note', data: note });
}
// Search command actions
const matchedActions = searchActions(query);
for (const action of matchedActions) {
combined.push({ type: 'action', data: action });
}
} else if (query === '' || query === null) {
// Empty query - show all notes + all actions
for (const note of notes.value) {
combined.push({ type: 'note', data: note });
}
const allActions = searchActions('');
for (const action of allActions) {
combined.push({ type: 'action', data: action });
}
}
return combined;
}
// ---- Input handling ----
function onInput(event) {
const query = event.target.value;
inputText.value = query;
selectedIndex.value = -1;
function searchFocus(event){
if(GetContent() === undefined) return;
if (!query || query.trim() === '') {
showResults.value = false;
return;
}
showResults.value = true;
searchContainer.value.style.display = "";
updateList(undefined);
}
function onFocus() {
if (notes.value.length === 0) {
fetchNotes().then(() => {
showResults.value = true;
});
} else {
showResults.value = true;
}
}
function onBlur(event) {
// Delay closing to allow click on results
setTimeout(() => {
closeResults();
}, 150);
}
async function onKeydown(event) {
const combined = getCombinedResults(inputText.value);
if (event.key === 'ArrowDown') {
event.preventDefault();
selectedIndex.value = Math.min(selectedIndex.value + 1, combined.length - 1);
return;
}
if (event.key === 'ArrowUp') {
event.preventDefault();
selectedIndex.value = Math.max(selectedIndex.value - 1, 0);
return;
}
if (event.key === 'Enter') {
event.preventDefault();
if (selectedIndex.value >= 0) {
const item = combined[selectedIndex.value];
if (!item) return;
if (item.type === 'note') {
openNote(item.data);
} else if (item.type === 'action') {
executeAction(item.data.id);
closeResults();
}
}
}
if (event.key === 'Escape') {
closeResults();
}
}
function onSelect(result) {
if (!result) return;
if (result.link) {
const note = notes.value.find(n => n.key === result.link);
if (note) openNote(note);
}
closeResults();
}
function handleActionSelect(actionData) {
executeAction(actionData.id);
closeResults();
}
function closeResults() {
showResults.value = false;
selectedIndex.value = -1;
inputText.value = '';
}
// ---- Clean up register action on mount/unmount ----
onMounted(() => {
document.addEventListener('keydown', globalKeydown);
registerCreateNoteAction();
});
onUnmounted(() => {
document.removeEventListener('keydown', globalKeydown);
});
*/
</script>
<template>
<div class="top-search-container">
<div class="top-search-box">
<img class="icon search-icon" :src="SearchIcon" alt="" aria-hidden="true">
<input
ref="focusInput"
type="text"
class="search-prompt"
placeholder="Search or press Cmd+K..."
v-model="inputText"
@input="onInput"
@focus="onFocus"
@blur="onBlur"
@keydown="onKeydown"
autocomplete="off"
spellcheck="false"
>
</div>
<div class="top-search-container">
<div class="top-search-box">
<img class="icon search-icon" :src="SearchIcon" alt="My Happy SVG"/>
<!-- <input type="text" v-on:input="updateList" v-on:focus="searchFocus" class="search-prompt" placeholder="Buscar...">-->
<input type="text" class="search-prompt" placeholder="Buscar...">
</div>
<div class="search-container" v-if="showResults">
<template v-if="getCombinedResults(inputText).length === 0 && inputText.trim()">
<div class="search-empty">No results found</div>
</template>
<div class="search-container-list">
<NoteSearchResult
v-for="(item, index) in getCombinedResults(inputText)"
:key="(item.data.key || item.data.id) + '-' + index"
:title="item.type === 'note' ? item.data.title : item.data.label"
:subtitle="item.type === 'action' ? item.data.description : ''"
:link="item.type === 'note' ? item.data.key : null"
:icon="item.type === 'action' ? PlusIcon : ''"
:class="{ selected: index === selectedIndex }"
@select="onSelect"
@click.stop.prevent="() => { if (item.type === 'note') openNote(item.data); else handleActionSelect(item.data); }"
/>
</div>
<!-- <div class="search-container" ref="searchContainer" v-on:focusout="searchFocusout" style="display: none;">-->
<div class="search-container" style="display: none;">
<div class="search-container-list">
<!--
<NoteSearchElement v-for="element in noteLinks" :key="element.key" :title="element.title" :link="element.key"></NoteSearchElement>
-->
</div>
</div>
</div>
</div>
</template>
<style scoped>
.top-search-container {
height: 100%;
align-items: center;
display: flex;
position: relative;
height: 100%;
align-items: center;
display: flex;
}
.top-search-box {
align-items: center;
display: flex;
background-color: var(--color-search-background);
padding: 2px;
border-radius: 5px;
align-items: center;
display: flex;
background-color: var(--search-background);
padding: 2px;
border-radius: 5px;
}
.search-prompt {
border: none;
padding: 5px;
width: 30vw;
max-width: 400px;
background: none;
margin-left: -5px;
font-family: inherit;
border: none;
padding: 5px;
width: 30vw;
max-width: 400px;
background: none;
margin-left: -5px;
}
.search-prompt:focus {
outline: none;
outline: none;
}
.search-icon {
padding: 5px;
filter: invert(var(--color-icon-invert));
padding: 5px;
}
.search-container {
position: absolute;
background-color: var(--color-search-background-container);
top: 45px;
margin-left: auto;
margin-right: auto;
max-width: 600px;
max-height: 400px;
overflow-y: auto;
left: 0;
right: 0;
backdrop-filter: blur(15px);
border-radius: 10px;
width: calc(30vw + 400px);
min-width: 320px;
z-index: 99999;
display: flex;
flex-direction: column;
}
.search-container-list {
display: flex;
flex-direction: column;
padding: 4px;
}
.search-empty {
padding: 16px;
text-align: center;
opacity: 0.5;
font-size: 14px;
position: absolute;
background-color: var(--search-background-container);
top: 45px;
margin-left: auto;
margin-right: auto;
max-width: 800px;
max-height: 500px;
overflow-y: scroll;
left: 0;
right: 0;
backdrop-filter: blur(15px);
border-radius: 10px;
min-width: 400px;
min-height: 500px;
z-index: 99999;
}
</style>

View File

@@ -10,14 +10,9 @@ const steps = ref(null);
const stepsHtml = ref("");
const rollDice = () => {
try {
const result = parse(props.content);
resultText.value = result.total;
stepsHtml.value = result.steps.map(renderStep).join('');
} catch (err) {
// Expressio de daus malformada: no fem petar el widget, nomes ho registrem.
console.error('Invalid roll expression', props.content, err);
}
const result = parse(props.content);
resultText.value = result.total;
stepsHtml.value = result.steps.map(renderStep).join('');
};
const renderStep = (s) => {

View File

@@ -8,13 +8,10 @@ const container = ref(null);
const resultText = ref("");
const rollDice = () => {
try {
const result = parse(props.content);
resultText.value = result.total;
} catch (err) {
// Expressio de daus malformada: no fem petar el widget, nomes ho registrem.
console.error('Invalid roll expression', props.content, err);
}
console.log(props.content);
const result = parse(props.content);
console.log(result);
resultText.value = result.total;
};
onMounted(() => {

View File

@@ -0,0 +1,25 @@
<script setup>
import { computed } from 'vue'
import { PushNote, GetNoteByName } from '~/services/Content';
const props = defineProps(['content'])
const parts = computed(() => props.content?.split('|') ?? [])
const href = computed(() => parts.value[0] || '')
const text = computed(() => parts.value[1] || parts.value[0] || '')
function handleClick() {
// your custom logic here
PushNote(GetNoteByName(href.value));
}
</script>
<template>
<a href="#" @click.prevent="handleClick">
{{ text }}
</a>
</template>

View File

@@ -1,260 +0,0 @@
<script setup>
import { onMounted, ref } from 'vue';
import Server from '~/services/Server';
import { GetUser, SetUser } from '~/services/User';
import { AddSound } from '~/services/Sound';
import Spinner from '../partials/Spinner.vue';
// Pantalla autònoma que el bot obre des de Discord: l'usuari s'identifica aquí
// i autoritza el servidor de Discord que s'ha rebut per la URL.
useHead({ title: 'Connect Dragonroll to Discord' });
const card = ref(null);
const code = ref('');
const guildName = ref('');
const discordUserName = ref('');
const signedInAs = ref('');
const connectedGuild = ref('');
// 'checking' | 'login' | 'approve' | 'connected' | 'error'
const status = ref('checking');
const messageKey = ref('');
const username = ref('');
const password = ref('');
const busy = ref(false);
function readCode() {
const hash = new URLSearchParams(window.location.hash.slice(1));
const search = new URLSearchParams(window.location.search);
return hash.get('code') || search.get('code') || '';
}
function ShowError(key) {
messageKey.value = key;
}
function PrepareApproval() {
const user = GetUser();
if (!user) {
status.value = 'login';
messageKey.value = '';
return;
}
signedInAs.value = user.username || user.name || user.email || 'Dragonroll';
status.value = 'approve';
messageKey.value = '';
}
async function LoadRequest() {
const response = await Server().post('/discord/link/details', { code: code.value });
const details = response.data;
if (details.status !== 'ok') {
status.value = 'error';
ShowError('discord.errors.link-expired');
return;
}
guildName.value = details.guildName;
discordUserName.value = details.discordUserName;
PrepareApproval();
}
async function SignIn() {
busy.value = true;
messageKey.value = '';
try {
const response = await Server().post('/user/login', {
usermail: username.value,
password: password.value
});
if (response.data.status !== 'ok' || !response.data.token) {
ShowError(response.data.msg || 'discord.errors.sign-in-failed');
return;
}
// El token passa al servei d'usuari perquè el client el reutilitzi en autoritzar.
SetUser(response.data.token);
password.value = '';
PrepareApproval();
} catch {
ShowError('discord.errors.sign-in-failed');
} finally {
busy.value = false;
}
}
async function Authorize() {
busy.value = true;
try {
const response = await Server().post('/discord/link/complete', { code: code.value });
if (response.data.status !== 'ok') {
status.value = 'error';
ShowError('discord.errors.link-expired');
return;
}
connectedGuild.value = response.data.guildName;
status.value = 'connected';
messageKey.value = '';
// El codi ja s'ha fet servir, treu-lo de la barra d'adreces.
window.history.replaceState(null, '', window.location.pathname);
} catch (error) {
if (error?.response?.status === 401) {
status.value = 'login';
ShowError('discord.errors.session-expired');
return;
}
status.value = 'error';
ShowError('discord.errors.link-expired');
} finally {
busy.value = false;
}
}
onMounted(() => {
AddSound(card.value);
code.value = readCode();
if (!code.value) {
status.value = 'error';
ShowError('discord.errors.missing-code');
return;
}
LoadRequest().catch(() => {
status.value = 'error';
ShowError('discord.errors.internal');
});
});
</script>
<template>
<div class="discord-authorize">
<main class="authorize-card" ref="card">
<h1>{{ $t('discord.title') }}</h1>
<p v-if="guildName" class="summary">
{{ $t('discord.summary', { guild: guildName, user: discordUserName }) }}
</p>
<p v-else-if="status !== 'error'" class="summary">
<Spinner v-if="status === 'checking'"></Spinner>
<span v-else>{{ $t('discord.checking') }}</span>
</p>
<form v-if="status === 'login'" v-on:submit.prevent="SignIn">
<p>{{ $t('discord.sign-in-lead') }}</p>
<div class="form-field">
<label for="discord-authorize-usermail">{{ $t('login.username') }}</label>
<input
id="discord-authorize-usermail"
type="text"
:placeholder="$t('login.username-placeholder')"
name="usermail"
autocomplete="username"
v-model="username"
required
>
</div>
<div class="form-field">
<label for="discord-authorize-password">{{ $t('login.password') }}</label>
<input
id="discord-authorize-password"
type="password"
name="password"
autocomplete="current-password"
v-model="password"
required
>
</div>
<button class="btn-primary sound-click" type="submit" :disabled="busy">
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('login.log-in') }}</span>
</button>
</form>
<section v-if="status === 'approve'">
<p>{{ $t('discord.signed-in-as', { user: signedInAs }) }}</p>
<p class="hint">{{ $t('discord.next-step') }}</p>
<p class="hint">{{ $t('discord.replace-warning') }}</p>
<button class="btn-primary sound-click" type="button" :disabled="busy" v-on:click="Authorize">
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('discord.approve') }}</span>
</button>
</section>
<section v-if="status === 'connected'">
<p class="success">{{ $t('discord.connected', { guild: connectedGuild }) }}</p>
<p class="hint">{{ $t('discord.next-step') }}</p>
</section>
<p v-if="messageKey" class="error" role="status">
{{ $t(messageKey) }}
</p>
</main>
</div>
</template>
<style scoped>
.discord-authorize {
display: grid;
place-items: center;
width: 100%;
min-height: 100vh;
padding: 24px;
box-sizing: border-box;
background-color: var(--color-background);
color: var(--color-text);
}
.authorize-card {
width: min(100%, 460px);
padding: 28px;
box-sizing: border-box;
background-color: var(--color-window-background);
border: 1px solid var(--color-window-border);
border-radius: 12px;
box-shadow: 0 8px 24px var(--color-window-shadow);
text-align: center;
user-select: none;
}
.authorize-card h1 {
margin-top: 0;
font-family: 'MrEavesRemake', serif;
font-size: 1.5rem;
}
.authorize-card p {
line-height: 1.5;
}
.summary {
color: var(--color-gray);
}
form,
section {
margin-top: 18px;
}
.hint {
color: var(--color-gray);
font-size: 0.95rem;
}
.success {
color: var(--color-green);
}
.error {
color: var(--color-red);
}
button {
width: 100%;
}
</style>

View File

@@ -1,356 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import WindowHandle from './partials/WindowHandle.vue';
import Tabs from '../layouts/Tabs.vue';
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
import Server from '~/services/Server';
import { DisplayToast } from '~/services/Toaster';
const props = defineProps(['data']);
const data = props.data;
const campaign = data.campaign;
const handle = ref(null);
const wrapper = ref(null);
const saving = ref(false);
const name = ref(campaign.name || '');
const color = ref(campaign.color || '#6b6b6b');
const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
const pairingCode = ref('');
const requestId = ref('');
const linking = ref(false);
const id = data.id;
let statusPoll;
let checkingStatus = false;
const rows = [
{ id: 'basic', value: 'campaigns.settings.tabs.basic' },
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
];
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 560, height: 430 });
ResetPosition(id, 'center');
SetResizable(id, true);
SetMinSize(id, { width: 440, height: 340 });
ResumePendingFoundryLink();
});
onBeforeUnmount(() => {
clearInterval(statusPoll);
});
function ApplyCampaignUpdate(updatedCampaign) {
Object.assign(campaign, updatedCampaign);
settings.value = updatedCampaign.settings || {};
foundryUrl.value = settings.value.integrations?.foundryUrl || foundryUrl.value;
}
function validFoundryUrl(value) {
if (!value.trim()) return true;
try {
const url = new URL(value.trim());
return url.protocol === 'http:' || url.protocol === 'https:';
} catch {
return false;
}
}
async function SaveSettings() {
if (!name.value.trim()) {
DisplayToast('red', $t('campaigns.settings.errors.name-required'), 3000);
return;
}
if (!validFoundryUrl(foundryUrl.value)) {
DisplayToast('red', $t('campaigns.settings.errors.invalid-foundry-url'), 3000);
return;
}
saving.value = true;
const updatedSettings = {
...settings.value,
integrations: {
...(settings.value.integrations || {}),
foundryUrl: foundryUrl.value.trim()
}
};
try {
const response = await Server().post('/campaign/update', {
id: campaign._id,
name: name.value.trim(),
color: color.value,
settings: updatedSettings
});
if (response.data.status !== 'ok') {
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
ApplyCampaignUpdate(response.data.campaign);
DisplayToast('green', $t('campaigns.settings.saved'), 3000);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
saving.value = false;
}
}
async function StartFoundryLink() {
linking.value = true;
try {
const response = await Server().post('/campaign/foundry-link/start', { campaignId: campaign._id });
if (response.data.status !== 'ok') {
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
pairingCode.value = response.data.code;
requestId.value = response.data.requestId;
clearInterval(statusPoll);
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
linking.value = false;
}
}
// The pairing code lives server-side until it expires, so re-attach to it when
// the window opens again after a reload, restart or closing the window.
async function ResumePendingFoundryLink() {
try {
const response = await Server().get(`/campaign/foundry-link/pending?campaignId=${campaign._id}`);
if (response.data.status !== 'ok' || !response.data.request) return;
pairingCode.value = response.data.request.code || '';
requestId.value = response.data.request.requestId;
clearInterval(statusPoll);
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
} catch {
// Showing the stored pairing code is best-effort; ignore resume failures.
}
}
async function CheckFoundryLinkStatus() {
if (!requestId.value || checkingStatus) return;
checkingStatus = true;
try {
const response = await Server().get(`/campaign/foundry-link/status/${requestId.value}`);
if (response.data.status !== 'ok' || response.data.state === 'expired') {
clearInterval(statusPoll);
pairingCode.value = '';
requestId.value = '';
const error = response.data.state === 'expired'
? 'campaigns.settings.errors.link-expired'
: response.data.msg || 'campaigns.settings.errors.link-expired';
DisplayToast('red', $t(error), 3000);
return;
}
if (response.data.state === 'complete') {
ApplyCampaignUpdate(response.data.campaign);
clearInterval(statusPoll);
pairingCode.value = '';
requestId.value = '';
DisplayToast('green', $t('campaigns.settings.linked'), 3000);
}
} catch {
// Keep polling while the Foundry module completes the pairing.
} finally {
checkingStatus = false;
}
}
async function UnlinkFoundry() {
linking.value = true;
try {
const response = await Server().post('/campaign/foundry-unlink', { campaignId: campaign._id });
if (response.data.status !== 'ok') {
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
ApplyCampaignUpdate(response.data.campaign);
DisplayToast('green', $t('campaigns.settings.unlinked'), 3000);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
linking.value = false;
}
}
async function CopyPairingCode() {
try {
await navigator.clipboard.writeText(pairingCode.value);
DisplayToast('green', $t('campaigns.settings.code-copied'), 2000);
} catch {
DisplayToast('red', $t('campaigns.settings.errors.copy-code'), 3000);
}
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<div class="settings-body">
<Tabs :rows="rows">
<template #basic>
<div class="settings-fields">
<label class="field">
<span>{{ $t('campaigns.settings.name') }}</span>
<input v-model="name" type="text" maxlength="120" autocomplete="off">
</label>
<label class="field color-field">
<span>{{ $t('campaigns.settings.color') }}</span>
<input v-model="color" type="color">
</label>
</div>
</template>
<template #integrations>
<div class="settings-fields">
<div class="world-link">
<div v-if="campaign.foundryWorldId" class="linked-world">
<strong>{{ campaign.foundryWorldTitle || campaign.foundryWorldId }}</strong>
<span v-if="campaign.foundrySystem">{{ campaign.foundrySystem }}</span>
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="UnlinkFoundry">
{{ $t('campaigns.settings.unlink-foundry') }}
</button>
</div>
<p v-else class="help-text standalone">{{ $t('campaigns.settings.no-foundry-world') }}</p>
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="StartFoundryLink">
{{ $t('campaigns.settings.start-foundry-link') }}
</button>
<p class="help-text standalone">{{ $t('campaigns.settings.start-foundry-link-help') }}</p>
<div v-if="pairingCode" class="pairing-code">
<code>{{ pairingCode }}</code>
<button class="btn-primary sound-click" type="button" @click="CopyPairingCode">
{{ $t('campaigns.settings.copy-code') }}
</button>
</div>
</div>
<label class="field">
<span>{{ $t('campaigns.settings.foundry-url') }}</span>
<input
v-model="foundryUrl"
type="url"
placeholder="https://foundry.example.com"
autocomplete="url"
>
</label>
<p class="help-text">{{ $t('campaigns.settings.foundry-url-help') }}</p>
</div>
</template>
</Tabs>
<div class="actions">
<button class="btn-primary sound-click" type="button" :disabled="saving" @click="SaveSettings">
{{ saving ? $t('campaigns.settings.saving') : $t('general.save') }}
</button>
</div>
</div>
</div>
</template>
<style scoped lang="scss">
.window-wrapper {
display: flex;
flex-direction: column;
align-items: center;
}
.settings-body {
display: flex;
flex: 1;
flex-direction: column;
min-height: 0;
width: 100%;
}
.settings-fields {
display: flex;
flex-direction: column;
gap: 18px;
padding: 22px;
}
.field {
display: flex;
flex-direction: column;
gap: 6px;
}
input {
width: 100%;
box-sizing: border-box;
padding: 8px 10px;
border: 1px solid var(--color-border);
border-radius: 6px;
background: var(--color-background-soft);
color: var(--color-text);
font-size: 14px;
}
.color-field input {
width: 72px;
height: 38px;
padding: 3px;
}
.help-text {
margin: -10px 22px 0;
color: var(--color-text);
font-size: 13px;
opacity: 0.75;
}
.help-text.standalone {
margin: 0;
}
.world-link {
display: flex;
flex-direction: column;
gap: 10px;
padding-bottom: 14px;
border-bottom: 1px solid var(--color-border);
}
.linked-world {
display: flex;
align-items: center;
gap: 10px;
flex-wrap: wrap;
}
.linked-world span {
opacity: 0.75;
}
.pairing-code {
display: flex;
align-items: center;
justify-content: space-between;
gap: 10px;
padding: 10px;
border: 1px solid var(--color-border);
border-radius: 6px;
}
.pairing-code code {
user-select: text;
overflow-wrap: anywhere;
}
.actions {
display: flex;
justify-content: flex-end;
padding: 12px 18px;
border-top: 1px solid var(--color-border);
}
</style>

View File

@@ -1,399 +0,0 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
import { useI18n } from 'vue-i18n';
const props = defineProps(['data']);
const id = props.data.id;
const actorId = props.data.actor?._id;
const handle = ref(null);
const wrapper = ref(null);
const editing = ref(false);
const saving = ref(false);
const error = ref('');
const original = ref(null);
const photoInput = ref(null);
const uploadingPhoto = ref(false);
const { t } = useI18n();
const abilityStats = [
{ key: 'str', label: 'STR' }, { key: 'dex', label: 'DEX' }, { key: 'con', label: 'CON' },
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
];
function normalizeActor(actor) {
return {
name: actor?.name ?? '',
species: actor?.species ?? '',
className: actor?.className ?? '',
subclass: actor?.subclass ?? '',
level: Number(actor?.level ?? 1),
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
armorClass: Number(actor?.armorClass ?? 10),
speed: Number(actor?.speed ?? 30),
proficiencies: actor?.proficiencies ?? '',
inventory: (actor?.inventory ?? []).map((item) => ({
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0)
})),
traits: actor?.traits ?? '',
spells: actor?.spells ?? '',
image: actor?.image ?? ''
};
}
const form = ref(normalizeActor(props.data.actor));
original.value = normalizeActor(props.data.actor);
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {
width: Math.max(320, Math.min(900, window.innerWidth - 24)),
height: Math.max(360, Math.min(700, window.innerHeight - 32))
});
ResetPosition(id, 'center');
});
onBeforeUnmount(() => ClearWindow({ type: 'character_sheet' }));
function handleActorSync({ entityType, entry }) {
if (entityType !== 'actor' || entry?._id !== actorId || editing.value) return;
form.value = normalizeActor(entry);
original.value = normalizeActor(entry);
}
onMounted(() => emitter.on('campaign-entry-updated', handleActorSync));
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
const proficiencyBonus = computed(() => Math.ceil(form.value.level / 4) + 1);
const carryingCapacity = computed(() => form.value.abilityScores.str * 15);
const carriedWeight = computed(() => form.value.inventory.reduce((total, item) => total + (Number(item.quantity) || 0) * (Number(item.weight) || 0), 0));
const carryPercent = computed(() => Math.min(100, carryingCapacity.value ? (carriedWeight.value / carryingCapacity.value) * 100 : 0));
function abilityModifier(score) {
const modifier = Math.floor((Number(score) - 10) / 2);
return modifier >= 0 ? `+${modifier}` : String(modifier);
}
const imageUrl = computed(() => {
if (!form.value.image) return '';
return /^(https?:|data:|\/\/)/i.test(form.value.image)
? form.value.image
: `${getBaseUrl()}/public/${form.value.image}`;
});
function pickPhoto() {
photoInput.value?.click();
}
async function onPhotoSelected(event) {
const file = event.target.files?.[0];
event.target.value = '';
if (!file || uploadingPhoto.value) return;
uploadingPhoto.value = true;
error.value = '';
try {
const formData = new FormData();
formData.append('image', file);
const response = await Server().post(`/actor/upload-image?actor=${actorId}`, formData, {
headers: { "Content-Type": "multipart/form-data" }
});
if (response.data.status !== 'ok') {
error.value = t('campaigns.character-sheet.photo-error');
return;
}
// La foto es desa immediatament: manté original intacte perquè cancel·lar no la perdi
form.value.image = response.data.actor?.image ?? form.value.image;
original.value.image = form.value.image;
emitter.emit('campaign-entry-updated', { entityType: 'actor', entry: response.data.actor });
} catch (requestError) {
error.value = t('campaigns.character-sheet.photo-error');
} finally {
uploadingPhoto.value = false;
}
}
function removePhoto() {
form.value.image = '';
}
function startEditing() {
editing.value = true;
error.value = '';
}
function cancelEditing() {
form.value = normalizeActor(original.value);
editing.value = false;
error.value = '';
}
function addInventoryItem() {
form.value.inventory.push({ name: '', quantity: 1, weight: 0 });
}
function removeInventoryItem(index) {
form.value.inventory.splice(index, 1);
}
async function saveSheet() {
if (!form.value.name.trim() || saving.value) return;
saving.value = true;
error.value = '';
try {
const payload = {
id: actorId,
...form.value,
inventory: form.value.inventory.filter((item) => item.name.trim())
};
const response = await Server().post('/actor/update', payload);
if (response.data.status !== 'ok') {
error.value = t('campaigns.character-sheet.save-error');
return;
}
original.value = normalizeActor(response.data.actor);
form.value = normalizeActor(response.data.actor);
editing.value = false;
emitter.emit('campaign-entry-updated', { entityType: 'actor', entry: response.data.actor });
} catch (requestError) {
error.value = t('campaigns.character-sheet.save-error');
} finally {
saving.value = false;
}
}
</script>
<template>
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="sheet-body">
<header class="sheet-hero">
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
<div class="character-identity">
<input v-if="editing" v-model="form.name" class="character-name-input" required :aria-label="$t('campaigns.character-sheet.name')">
<h1 v-else>{{ form.name }}</h1>
<div class="identity-fields">
<label v-if="editing" class="identity-field">
<span>{{ $t('campaigns.character-sheet.class') }}</span><input v-model="form.className">
</label>
<span v-else class="identity-tag">{{ form.className || $t('campaigns.character-sheet.unset-class') }}</span>
<label v-if="editing" class="identity-field">
<span>{{ $t('campaigns.character-sheet.subclass') }}</span><input v-model="form.subclass">
</label>
<span v-else-if="form.subclass" class="identity-tag">{{ form.subclass }}</span>
<label v-if="editing" class="identity-field level-field">
<span>{{ $t('campaigns.character-sheet.level') }}</span><input v-model.number="form.level" type="number" min="1" max="20">
</label>
<span v-else class="identity-tag">{{ $t('campaigns.character-sheet.level') }} {{ form.level }}</span>
<label v-if="editing" class="identity-field">
<span>{{ $t('campaigns.character-sheet.species') }}</span><input v-model="form.species">
</label>
<span v-else class="identity-tag">{{ form.species || $t('campaigns.character-sheet.unset-species') }}</span>
</div>
</div>
<div class="sheet-actions">
<button v-if="!editing" class="sheet-button" type="button" @click="startEditing">{{ $t('campaigns.character-sheet.edit') }}</button>
<template v-else>
<button class="sheet-button secondary" type="button" @click="cancelEditing">{{ $t('campaigns.character-sheet.cancel') }}</button>
<button class="sheet-button primary" type="button" :disabled="saving" @click="saveSheet">
{{ saving ? $t('campaigns.character-sheet.saving') : $t('campaigns.character-sheet.save') }}
</button>
</template>
</div>
</header>
<div v-if="error" class="sheet-error">{{ error }}</div>
<main class="sheet-grid">
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
</button>
<div v-if="editing && form.image" class="portrait-controls">
<button type="button" :disabled="uploadingPhoto" @click="pickPhoto">
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.change-photo') }}
</button>
<button type="button" :disabled="uploadingPhoto" :aria-label="$t('campaigns.character-sheet.remove-photo')" @click="removePhoto">×</button>
</div>
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onPhotoSelected">
</div>
<section class="sheet-panel abilities-panel">
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
<div class="ability-grid">
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
<span class="ability-label">{{ stat.label }}</span>
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
</div>
</div>
<div class="proficiency-badge">
<span>{{ $t('campaigns.character-sheet.proficiency-bonus') }}</span>
<strong>+{{ proficiencyBonus }}</strong>
</div>
</section>
<section class="sheet-panel combat-panel">
<h2>{{ $t('campaigns.character-sheet.combat') }}</h2>
<div class="combat-stats">
<div class="combat-stat">
<span>{{ $t('campaigns.character-sheet.armor-class') }}</span>
<input v-if="editing" v-model.number="form.armorClass" type="number" min="0">
<strong v-else>{{ form.armorClass }}</strong>
</div>
<div class="combat-stat">
<span>{{ $t('campaigns.character-sheet.speed') }}</span>
<label v-if="editing" class="number-with-unit"><input v-model.number="form.speed" type="number" min="0"><small>ft</small></label>
<strong v-else>{{ form.speed }} <small>ft</small></strong>
</div>
</div>
<h3>{{ $t('campaigns.character-sheet.proficiencies') }}</h3>
<textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
</section>
<section class="sheet-panel traits-panel">
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
<textarea v-if="editing" v-model="form.traits" rows="5" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
</section>
<section class="sheet-panel spells-panel">
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
<textarea v-if="editing" v-model="form.spells" rows="5" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
</section>
<section class="sheet-panel inventory-panel">
<div class="panel-title-row">
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
</div>
<div class="weight-summary">
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
</div>
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
<div class="inventory-table-wrap">
<table class="inventory-table">
<thead><tr>
<th>{{ $t('campaigns.character-sheet.item-name') }}</th>
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
</tr></thead>
<tbody>
<tr v-for="(item, index) in form.inventory" :key="index">
<td><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
</tr>
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 5 : 4" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
</tbody>
</table>
</div>
</section>
</main>
</div>
</div>
</template>
<style scoped>
.sheet-window { min-width: 0; min-height: 0; }
.sheet-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 16px; box-sizing: border-box; }
.sheet-hero { display: flex; align-items: center; gap: 14px; padding: 4px 2px 16px; margin-bottom: 12px; border-bottom: 1px solid var(--color-border); }
.character-mark { width: 56px; height: 56px; flex: 0 0 56px; display: grid; place-items: center; border-radius: 12px; background: var(--color-background-soft); color: var(--color-link); border: 1px solid var(--color-border); font: 28px MrEavesRemake; }
.character-identity { flex: 1; min-width: 0; }
.character-identity h1 { margin: 0 0 7px; font: 28px MrEavesRemake; overflow-wrap: anywhere; }
.character-name-input { width: min(100%, 440px); font-size: 24px !important; font-family: MrEavesRemake !important; }
.identity-fields { display: flex; align-items: center; flex-wrap: wrap; gap: 7px; }
.identity-tag { padding: 4px 9px; border: 1px solid var(--color-border); border-radius: 999px; background: var(--color-background-soft); font-size: 12px; opacity: .9; }
.identity-field { display: flex; align-items: center; gap: 5px; font-size: 11px; opacity: .8; }
.identity-field input { width: 106px; }
.identity-field.level-field input { width: 58px; }
.sheet-actions { display: flex; align-items: center; gap: 7px; }
.sheet-button { border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; }
.sheet-button:hover { background: var(--color-button-hover); }
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
.sheet-button:disabled { opacity: .55; cursor: wait; }
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
.sheet-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto auto auto; gap: 11px; align-items: start; }
.sheet-panel { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); }
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
.sheet-portrait { grid-column: 1; grid-row: 1 / -1; position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
.sheet-portrait img { display: block; width: 100%; height: auto; }
.portrait-upload { border: 0; padding: 8px 10px; background: transparent; color: var(--color-link); font-size: 12px; cursor: pointer; }
.portrait-controls { position: absolute; inset: auto 0 0 0; display: flex; align-items: center; justify-content: space-between; gap: 6px; padding: 6px 7px; background: var(--color-background-soft); border-top: 1px solid var(--color-border); }
.portrait-controls button { border: 1px solid var(--color-border); border-radius: 6px; padding: 4px 9px; background: var(--color-background-light); color: var(--color-text); font-size: 11px; cursor: pointer; }
.portrait-controls button:last-child { flex: 0 0 auto; padding: 3px 8px; font-size: 15px; line-height: 1; }
.portrait-controls button:hover { background: var(--color-button-hover); }
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
.photo-input { display: none; }
.abilities-panel { grid-column: 2 / -1; grid-row: 1; }
.combat-panel { grid-column: 2; grid-row: 2; }
.traits-panel { grid-column: 3; grid-row: 2; }
.spells-panel { grid-column: 2 / -1; grid-row: 3; }
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
.ability-score { font: 25px MrEavesRemake; }
.ability-modifier { min-width: 33px; text-align: center; padding: 2px 5px; border-radius: 999px; background: var(--color-background); font-size: 12px; }
.ability-card input { width: 55px; text-align: center; font-size: 21px; }
.proficiency-badge { display: flex; justify-content: space-between; align-items: center; margin-top: 9px; padding: 8px; border-radius: 8px; background: var(--color-background-soft); font-size: 12px; }
.proficiency-badge strong { font-size: 15px; color: var(--color-link); }
.combat-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 8px; }
.combat-stat { min-height: 72px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 5px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
.combat-stat > span { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
.combat-stat > strong { font: 25px MrEavesRemake; }
.combat-stat small { font-size: 11px; opacity: .7; }
.number-with-unit { display: flex; align-items: center; gap: 4px; }
.number-with-unit input { width: 57px; }
.sheet-copy { min-height: 74px; margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
input, textarea { box-sizing: border-box; max-width: 100%; padding: 6px 7px; border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit; }
input:focus, textarea:focus { outline: none; border-color: var(--color-link); }
textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
.traits-panel, .spells-panel { min-height: 175px; }
.panel-title-row { display: flex; justify-content: space-between; align-items: center; gap: 8px; }
.panel-title-row h2 { flex: 1; }
.weight-summary { display: flex; justify-content: space-between; align-items: center; gap: 8px; margin: 1px 0 7px; font-size: 12px; }
.weight-summary strong { white-space: nowrap; }
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
.inventory-panel { grid-column: 2 / -1; grid-row: 4; }
.inventory-table-wrap { overflow-x: auto; }
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; }
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
.inventory-table td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
.inventory-table td input { width: 100%; min-width: 54px; }
.inventory-table td:first-child input { min-width: 100px; }
.inventory-table th:not(:first-child), .inventory-table td:not(:first-child) { text-align: center; }
.empty-inventory { text-align: center !important; opacity: .65; }
.remove-item { width: 24px; height: 24px; border: 0; border-radius: 5px; background: transparent; color: var(--color-text); font-size: 20px; cursor: pointer; }
.remove-item:hover { background: var(--color-button-hover); }
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
@media (max-width: 760px) {
.sheet-grid { grid-template-columns: 1fr 1fr; grid-template-rows: none; }
.sheet-portrait { grid-column: 1 / -1; grid-row: auto; }
.abilities-panel { grid-column: 1 / -1; grid-row: auto; }
.combat-panel, .traits-panel { grid-column: auto; grid-row: auto; }
.spells-panel, .inventory-panel { grid-column: 1 / -1; grid-row: auto; }
}
@media (max-width: 520px) {
.sheet-body { padding: 10px; }
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
.sheet-actions { margin-left: auto; }
.sheet-grid { grid-template-columns: 1fr; }
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
}
</style>

View File

@@ -1,153 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
const props = defineProps(['data']);
const data = props.data;
const id = data.id;
const handle = ref(null);
const wrapper = ref(null);
const saving = ref(false);
// The window edits items when the sidebar passes one in; actors have their sheet.
const editing = data.entry || null;
const isActor = data.entityType === 'actor';
const endpoint = isActor ? '/actor/create' : (editing ? '/item/update' : '/item/create');
function initialForm() {
if (!editing) {
return {
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
category: 'adventuring-gear', rarity: 'common', quantity: 1, weight: '', properties: '', description: ''
};
}
return {
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
quantity: editing.quantity ?? 1, weight: editing.weight ?? '', properties: editing.properties ?? '',
description: editing.description ?? ''
};
}
const form = ref(initialForm());
onMounted(() => {
SetupHandle(id, handle);
SetSize(id, isActor ? { width: 420, height: 220 } : { width: 500, height: 560 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => ClearWindow({ type: 'create_campaign_entry' }));
async function saveEntry() {
if (!form.value.name.trim() || saving.value) return;
saving.value = true;
try {
const payload = isActor
? { name: form.value.name.trim(), campaign: data.campaign }
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
if (!isActor) {
for (const field of ['category', 'rarity', 'quantity', 'weight', 'properties', 'description']) {
payload[field] = form.value[field];
}
}
const response = await Server().post(endpoint, payload);
if (response.data.status === 'ok') {
emitter.emit(editing ? 'campaign-entry-updated' : 'campaign-entry-created', { entityType: data.entityType, entry: response.data[isActor ? 'actor' : 'item'] });
ClearWindow({ id });
}
} catch (error) {
// Keep the form open so the user can retry.
} finally {
saving.value = false;
}
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="body">
<h3>{{ $t(editing ? 'campaigns.item.edit' : (isActor ? 'campaigns.actor.new' : 'campaigns.item.new')) }}</h3>
<p v-if="!isActor && editing?.foundryItemId" class="sync-note">{{ $t('campaigns.item.foundry-sync-note') }}</p>
<form @submit.prevent="saveEntry">
<label class="form-field">
<span>{{ $t('campaigns.fields.name') }}</span>
<input v-model="form.name" required autofocus autocomplete="off">
</label>
<template v-if="!isActor">
<div class="form-grid">
<label class="form-field">
<span>{{ $t('campaigns.item.category') }}</span>
<select v-model="form.category">
<option value="weapon">{{ $t('campaigns.item.categories.weapon') }}</option>
<option value="armor">{{ $t('campaigns.item.categories.armor') }}</option>
<option value="shield">{{ $t('campaigns.item.categories.shield') }}</option>
<option value="adventuring-gear">{{ $t('campaigns.item.categories.adventuring-gear') }}</option>
<option value="magic-item">{{ $t('campaigns.item.categories.magic-item') }}</option>
<option value="consumable">{{ $t('campaigns.item.categories.consumable') }}</option>
<option value="tool">{{ $t('campaigns.item.categories.tool') }}</option>
<option value="treasure">{{ $t('campaigns.item.categories.treasure') }}</option>
<option value="other">{{ $t('campaigns.item.categories.other') }}</option>
</select>
</label>
<label class="form-field">
<span>{{ $t('campaigns.item.rarity') }}</span>
<select v-model="form.rarity">
<option value="common">{{ $t('campaigns.item.rarities.common') }}</option>
<option value="uncommon">{{ $t('campaigns.item.rarities.uncommon') }}</option>
<option value="rare">{{ $t('campaigns.item.rarities.rare') }}</option>
<option value="very-rare">{{ $t('campaigns.item.rarities.very-rare') }}</option>
<option value="legendary">{{ $t('campaigns.item.rarities.legendary') }}</option>
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
</select>
</label>
<label class="form-field">
<span>{{ $t('campaigns.item.quantity') }}</span>
<input v-model.number="form.quantity" type="number" min="1" required>
</label>
<label class="form-field">
<span>{{ $t('campaigns.item.weight') }}</span>
<input v-model="form.weight" type="number" min="0" step="0.1">
</label>
</div>
<label class="form-field">
<span>{{ $t('campaigns.item.properties') }}</span>
<input v-model="form.properties" :placeholder="$t('campaigns.item.properties-placeholder')">
</label>
</template>
<label v-if="!isActor" class="form-field">
<span>{{ $t('campaigns.fields.description') }}</span>
<textarea v-model="form.description" rows="3" />
</label>
<div class="form-actions">
<button class="btn-primary sound-click" type="submit" :disabled="saving">
{{ saving ? $t('campaigns.actions.saving') : $t(editing ? 'campaigns.actions.save' : 'campaigns.actions.submit') }}
</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; }
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
.sync-note { margin: -8px 0 12px; font-size: 12px; opacity: 0.72; }
form { display: flex; flex-direction: column; gap: 10px; }
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
.form-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }
input, select, textarea {
box-sizing: border-box; width: 100%; padding: 7px 8px; border: 1px solid var(--color-border);
border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit;
}
textarea { resize: vertical; }
input:focus, select:focus, textarea:focus { outline: none; border-color: var(--color-link); }
.form-actions { display: flex; justify-content: center; margin-top: 2px; }
.form-actions button { width: 100%; max-width: 220px; }
</style>

View File

@@ -1,194 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import { useI18n } from 'vue-i18n';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
const { t } = useI18n();
const props = defineProps(['data']);
const data = props.data;
const id = data.id;
const handle = ref(null);
const wrapper = ref(null);
const saving = ref(false);
const error = ref('');
const imageInput = ref(null);
// Passing an entry edits an existing map; otherwise this window creates one.
const editing = data.entry || null;
function initialForm() {
return {
name: editing?.name ?? '',
gridSize: Number(editing?.gridSize ?? 50),
offsetX: Number(editing?.offsetX ?? 0),
offsetY: Number(editing?.offsetY ?? 0),
scale: Number(editing?.scale ?? 5)
};
}
const form = ref(initialForm());
const selectedImage = ref(null);
let previewObjectUrl = null;
function serverImageUrl(image) {
if (!image) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
}
const previewUrl = ref(serverImageUrl(editing?.image));
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 500, height: 600 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => {
ClearWindow({ type: 'create_map' });
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
});
function pickImage() {
imageInput.value?.click();
}
function onImageSelected(event) {
const file = event.target.files?.[0];
event.target.value = '';
if (!file) return;
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
previewObjectUrl = URL.createObjectURL(file);
selectedImage.value = file;
previewUrl.value = previewObjectUrl;
}
const numberFields = ['gridSize', 'offsetX', 'offsetY', 'scale'];
async function saveMap() {
if (!form.value.name.trim() || saving.value) return;
saving.value = true;
error.value = '';
try {
const body = new FormData();
body.append('name', form.value.name.trim());
if (editing) body.append('id', editing._id);
else body.append('campaign', data.campaign);
for (const field of numberFields) {
if (Number.isFinite(form.value[field])) body.append(field, String(form.value[field]));
}
if (selectedImage.value) body.append('image', selectedImage.value);
const response = await Server().post(editing ? '/map/update' : '/map/create', body, {
headers: { "Content-Type": "multipart/form-data" }
});
if (response.data.status !== 'ok') {
error.value = t('campaigns.map.save-error');
return;
}
emitter.emit(editing ? 'campaign-entry-updated' : 'campaign-entry-created', { entityType: 'map', entry: response.data.map });
ClearWindow({ id });
} catch (requestError) {
error.value = t('campaigns.map.save-error');
} finally {
saving.value = false;
}
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="body">
<h3>{{ $t(editing ? 'campaigns.map.edit' : 'campaigns.map.new') }}</h3>
<div v-if="error" class="form-error">{{ error }}</div>
<form @submit.prevent="saveMap">
<label class="form-field">
<span>{{ $t('campaigns.fields.name') }}</span>
<input v-model="form.name" required autofocus autocomplete="off">
</label>
<div class="form-field">
<span>{{ $t('campaigns.map.photo') }}</span>
<div class="image-picker" :class="{ empty: !previewUrl }">
<img v-if="previewUrl" :src="previewUrl" :alt="$t('campaigns.map.photo')">
<button class="pick-image sound-click" type="button" :disabled="saving" @click="pickImage">
{{ $t(previewUrl ? 'campaigns.map.change-photo' : 'campaigns.map.upload-photo') }}
</button>
</div>
<small class="field-help">{{ $t('campaigns.map.photo-hint') }}</small>
<input ref="imageInput" class="image-input" type="file" accept="image/*" @change="onImageSelected">
</div>
<div class="form-grid">
<label class="form-field">
<span>{{ $t('campaigns.map.grid-size') }}</span>
<input v-model.number="form.gridSize" type="number" min="1" step="1">
</label>
<label class="form-field">
<span>{{ $t('campaigns.map.scale') }}</span>
<!-- step="any": any decimal works, the 0.01 minimum alone keeps it positive -->
<input v-model.number="form.scale" type="number" min="0.01" step="any" inputmode="decimal">
</label>
<label class="form-field">
<span>{{ $t('campaigns.map.offset-x') }}</span>
<input v-model.number="form.offsetX" type="number" step="1">
</label>
<label class="form-field">
<span>{{ $t('campaigns.map.offset-y') }}</span>
<input v-model.number="form.offsetY" type="number" step="1">
</label>
</div>
<small class="field-help">{{ $t('campaigns.map.scale-help') }}</small>
<div class="form-actions">
<button class="btn-primary sound-click" type="submit" :disabled="saving">
{{ saving ? $t('campaigns.actions.saving') : $t('campaigns.actions.save') }}
</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
/* Stretch so the outer margin insets the content instead of overflowing the window. */
.body {
flex: 1;
min-height: 0;
align-self: stretch;
box-sizing: border-box;
margin: 10px;
padding: 8px;
overflow-y: auto;
}
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
form { display: flex; flex-direction: column; gap: 10px; }
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
.form-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }
input {
box-sizing: border-box; width: 100%; padding: 7px 8px; border: 1px solid var(--color-border);
border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit;
}
input:focus { outline: none; border-color: var(--color-link); }
.image-picker {
min-height: 96px; display: flex; align-items: center; justify-content: center; overflow: hidden;
border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft);
}
.image-picker.empty { border-style: dashed; }
.image-picker img { max-width: 100%; max-height: 180px; object-fit: contain; }
.pick-image {
border: 1px solid var(--color-border); border-radius: 6px; padding: 5px 10px; margin: 6px;
background: var(--color-background-light); color: var(--color-text); font-size: 12px; cursor: pointer;
}
.pick-image:hover { background: var(--color-button-hover); }
.pick-image:disabled { opacity: .55; cursor: wait; }
.image-input { display: none; }
.field-help { font-size: 11px; opacity: .72; }
.form-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.form-actions { display: flex; justify-content: center; margin-top: 2px; }
.form-actions button { width: 100%; max-width: 220px; }
</style>

View File

@@ -1,33 +0,0 @@
<script setup>
import { onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import MapViewerPane from '../viewer/map/MapViewerPane.vue';
const props = defineProps(['data']);
const id = props.data.id;
const handle = ref(null);
const wrapper = ref(null);
const map = props.data.map ? { ...props.data.map } : null;
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {
width: Math.max(480, Math.min(1100, window.innerWidth - 24)),
height: Math.max(360, Math.min(760, window.innerHeight - 32))
});
ResetPosition(id, 'center');
});
</script>
<template>
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<MapViewerPane :map="map" />
</div>
</template>
<style scoped>
.viewer-window { min-width: 320px; min-height: 0; }
</style>

View File

@@ -1,136 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
const handle = ref(null);
const wrapper = ref(null);
const props = defineProps(['data']);
const data = props.data;
let id = data.id;
const newName = ref('');
const creating = !!data.name;
onMounted(() => {
newName.value = data.name || '';
SetupHandle(id, handle);
SetSize(id, { width: 420, height: 200 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => {
ClearWindow({ type: 'new_folder' });
});
function confirmSave() {
if (!newName.value.trim()) {
return;
}
const folderData = {
name: newName.value.trim(),
campaign: data.campaign
};
const url = creating ? '/folder/rename' : '/folder/create';
if (creating) {
folderData.id = data.folderId;
}
Server().post(url, folderData).then((response) => {
if (response.data.status !== 'ok') {
return;
}
emitter.emit('folder-saved', response.data.folder);
ClearWindow({ id });
}).catch(() => {});
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<div class="body">
<h3>{{ creating ? 'Rename Folder' : 'New Folder' }}</h3>
<form v-on:submit.prevent="confirmSave">
<div class="form-field">
<input
type="text"
v-model="newName"
placeholder="Folder name"
autofocus
autocomplete="off"
>
</div>
<div class="form-actions">
<button class="btn-primary sound-click" type="submit">{{ creating ? 'Save' : 'Create' }}</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper {
display: flex;
align-items: center;
flex-direction: column;
}
.body {
width: 100%;
padding: 10px;
}
h3 {
margin: 0 0 10px 10px;
font-family: MrEavesRemake;
}
form {
margin-left: 10px;
margin-right: 10px;
}
.form-field {
display: flex;
flex-direction: row;
width: 100%;
}
.form-field > * {
flex-grow: 1;
}
input {
width: 100%;
padding: 6px 8px;
border: 1px solid var(--color-border);
border-radius: 6px;
background: var(--color-background-soft);
color: var(--color-text);
font-size: 14px;
}
input:focus {
outline: none;
border-color: var(--color-accent);
}
.form-actions {
display: flex;
justify-content: center;
margin-top: 10px;
}
.form-actions button {
width: 100%;
max-width: 200px;
}
</style>

View File

@@ -1,130 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
const handle = ref(null);
const wrapper = ref(null);
const props = defineProps(['data']);
const data = props.data;
let id = data.id;
const newName = ref('');
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 420, height: 200 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => {
ClearWindow({ type: 'new_note' });
});
function confirmCreate() {
if (!newName.value.trim()) {
return;
}
Server().post('/note/create', {
title: newName.value.trim(),
content: '',
campaign: data.campaign,
folder: data.folder ?? null
}).then((response) => {
if (response.data.status !== 'ok') {
return;
}
emitter.emit('note-created', response.data.note);
ClearWindow({ id });
}).catch(() => {});
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<div class="body">
<h3>New Note</h3>
<form v-on:submit.prevent="confirmCreate">
<div class="form-field">
<input
type="text"
v-model="newName"
placeholder="Note title"
autofocus
autocomplete="off"
>
</div>
<div class="form-actions">
<button class="btn-primary sound-click" type="submit">Create</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper {
display: flex;
align-items: center;
flex-direction: column;
}
.body {
width: 100%;
padding: 10px;
}
h3 {
margin: 0 0 10px 10px;
font-family: MrEavesRemake;
}
form {
margin-left: 10px;
margin-right: 10px;
}
.form-field {
display: flex;
flex-direction: row;
width: 100%;
}
.form-field > * {
flex-grow: 1;
}
input {
width: 100%;
padding: 6px 8px;
border: 1px solid var(--color-border);
border-radius: 6px;
background: var(--color-background-soft);
color: var(--color-text);
font-size: 14px;
}
input:focus {
outline: none;
border-color: var(--color-accent);
}
.form-actions {
display: flex;
justify-content: center;
margin-top: 10px;
}
.form-actions button {
width: 100%;
max-width: 200px;
}
</style>

View File

@@ -1,122 +0,0 @@
<script setup>
import { createApp, onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import { GetWidget, ParseMarkdown } from '~/services/Marker';
import Server from '~/services/Server';
// The note a map pin points at (see MapViewerPane.vue). The note is fetched here instead of being
// carried over from the map, so a pin works whatever the note column shows and always reads fresh.
const props = defineProps(['data']);
const id = props.data.id;
const noteId = props.data.note;
const handle = ref(null);
const wrapper = ref(null);
const renderedContent = ref(null);
const note = ref(null);
const displayText = ref('');
const loading = ref(true);
const failed = ref(false);
// Widgets mounted over this note, kept to unmount them again the way Note.vue does: re-rendering
// would otherwise leave the apps of the nodes it replaced behind.
const mountedApps = [];
function unmountWidgets() {
for (const app of mountedApps) {
try {
app.unmount();
} catch (error) {
// The container may already be off the DOM; ignore and drop it all the same.
}
}
mountedApps.length = 0;
}
function mountWidgets() {
const root = renderedContent.value;
if (!root) return;
['display', 'inline'].forEach((widgetType) => {
root.querySelectorAll('.vue-component-' + widgetType).forEach((el) => {
const widget = GetWidget(widgetType, el.dataset.component);
if (!widget) return;
try {
const app = createApp(widget, { content: el.dataset.content });
app.config.errorHandler = (error) => console.error('Widget error', el.dataset.component, error);
app.mount(el);
mountedApps.push(app);
} catch (error) {
console.error('Failed to mount widget', el.dataset.component, error);
}
});
});
}
async function fetchNote() {
loading.value = true;
failed.value = false;
try {
const response = await Server().get(`/note/retrieve/${noteId}`);
if (response.data.status !== 'ok' || !response.data.note) {
failed.value = true;
return;
}
note.value = response.data.note;
unmountWidgets();
displayText.value = ParseMarkdown(response.data.note.content ?? '');
setTimeout(() => mountWidgets(), 0);
} catch (error) {
failed.value = true;
} finally {
loading.value = false;
}
}
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {
width: Math.max(360, Math.min(720, window.innerWidth - 24)),
height: Math.max(360, Math.min(720, window.innerHeight - 32))
});
ResetPosition(id, 'center');
fetchNote();
});
onBeforeUnmount(() => {
unmountWidgets();
ClearWindow({ type: 'pinned_note' });
});
</script>
<template>
<div class="window-wrapper pinned-note-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="body">
<div v-if="loading" class="note-state">{{ $t('campaigns.states.loading') }}</div>
<div v-else-if="failed" class="note-state">{{ $t('campaigns.map.pins.note-error') }}</div>
<template v-else>
<h1 v-if="note.title" class="note-title">{{ note.title }}</h1>
<div ref="renderedContent" class="note-content" v-html="displayText"></div>
</template>
</div>
</div>
</template>
<style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
/* Stretch so the outer margin insets the content instead of overflowing the window. */
.body {
flex: 1;
min-height: 0;
align-self: stretch;
box-sizing: border-box;
margin: 10px;
padding: 8px;
overflow-y: auto;
}
.note-title { margin: 0 0 10px; font-family: MrEavesRemake; overflow-wrap: anywhere; }
.note-state { padding: 10px; font-size: 13px; opacity: .8; }
.note-content :deep(img) { max-width: 100%; height: auto; display: block; }
</style>

View File

@@ -1,127 +0,0 @@
<script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
const handle = ref(null);
const wrapper = ref(null);
const props = defineProps(['data']);
const data = props.data;
let id = data.id;
const newName = ref('');
onMounted(() => {
newName.value = data.title || '';
SetupHandle(id, handle);
SetSize(id, { width: 420, height: 200 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => {
ClearWindow({ type: 'rename_note' });
});
function confirmRename() {
if (!newName.value.trim()) {
return;
}
Server().post('/note/update', {
id: data.key,
title: newName.value.trim(),
}).then((response) => {
if (response.data.status !== 'ok') {
return;
}
emitter.emit('note-renamed', { key: data.key, title: newName.value.trim() });
ClearWindow({ id });
}).catch(() => {});
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<div class="body">
<h3>Rename Note</h3>
<form v-on:submit.prevent="confirmRename">
<div class="form-field">
<input
type="text"
v-model="newName"
placeholder="Note title"
autofocus
autocomplete="off"
>
</div>
<div class="form-actions">
<button class="btn-primary sound-click" type="submit">Save</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper {
display: flex;
align-items: center;
flex-direction: column;
}
.body {
width: 100%;
padding: 10px;
}
h3 {
margin: 0 0 10px 10px;
font-family: MrEavesRemake;
}
form {
margin-left: 10px;
margin-right: 10px;
}
.form-field {
display: flex;
flex-direction: row;
width: 100%;
}
.form-field > * {
flex-grow: 1;
}
input {
width: 100%;
padding: 6px 8px;
border: 1px solid var(--color-border);
border-radius: 6px;
background: var(--color-background-soft);
color: var(--color-text);
font-size: 14px;
}
input:focus {
outline: none;
border-color: var(--color-accent);
}
.form-actions {
display: flex;
justify-content: center;
margin-top: 10px;
}
.form-actions button {
width: 100%;
max-width: 200px;
}
</style>

View File

@@ -1,54 +0,0 @@
import { ref } from 'vue';
const actions = ref([]);
function register(action) {
if (!action.id || !action.execute) {
console.warn('[ActionRegistry] Action missing id or execute:', action);
return;
}
const existingIndex = actions.value.findIndex(a => a.id === action.id);
if (existingIndex !== -1) {
actions.value[existingIndex] = action;
} else {
actions.value.push(action);
}
}
function unregister(id) {
actions.value = actions.value.filter(a => a.id !== id);
}
function search(query) {
if (!query || query.trim() === '') return [];
const q = query.normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().trim();
if (q === '') return [];
return actions.value.filter(action => {
if (typeof action.isActive === 'function' && !action.isActive()) {
return false;
}
const label = (action.label || '').normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase();
const description = (action.description || '').normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase();
return label.includes(q) || description.includes(q);
}).sort((a, b) => {
const aLabel = (a.label || '').toLowerCase();
const bLabel = (b.label || '').toLowerCase();
const qLower = q;
const aStarts = aLabel.startsWith(qLower) ? 0 : 1;
const bStarts = bLabel.startsWith(qLower) ? 0 : 1;
return aStarts - bStarts || aLabel.localeCompare(bLabel);
});
}
function execute(id, params = {}) {
const action = actions.value.find(a => a.id === id);
if (action && action.execute) {
action.execute(params);
}
}
export { register, unregister, search, execute };
export default { register, unregister, search, execute };

View File

@@ -1,39 +1,76 @@
import { ref } from 'vue';
import { useCampaignService } from '~/services/Campaign.js';
import Server from './Server';
const ShowContent = ref(false);
// What the campaign workspace shows where the notes live: the open notes, or the map the
// sidebar anchored on the note container. 'notes' | 'map'
const ActivePane = ref('notes');
// The map anchored on the note container (a campaign entry of the sidebar's maps section).
const AnchoredMap = ref(null);
const TotalNotes = ref([]); // Full note data
const CurrentNotes = ref([]); // Current opened note keys
function SetShowContent(value) {
ShowContent.value = value;
}
function SetActivePane(value) {
ActivePane.value = value;
function PushNote(note){
CurrentNotes.value = CurrentNotes.value.filter((currentNote) => {
return currentNote.key !== note.key;
});
CurrentNotes.value.push(note.key);
}
// Anchoring shows the map where the open notes are; they stay open and come back on 'notes'.
function AnchorMap(map) {
AnchoredMap.value = map ?? null;
ActivePane.value = AnchoredMap.value ? 'map' : 'notes';
function DeleteNote(key){
CurrentNotes.value = CurrentNotes.value.filter((k) => {
return k !== key;
});
}
function ClearAnchoredMap() {
AnchoredMap.value = null;
if (ActivePane.value === 'map') ActivePane.value = 'notes';
async function FetchCampaignNotes() {
// First we get campaign info
const { Campaign } = useCampaignService();
const campaignId = Campaign.value?._id ?? Campaign.value?.id ?? null;
if (!campaignId) {
TotalNotes.value = [];
return;
}
try {
const response = await Server().get('/note/list', {
params: {
campaign: campaignId
}
});
if (response.data.status !== 'ok') {
// TODO: ERROR
return;
}
TotalNotes.value = response.data.notes.map((note) => {
return {
key: note._id,
title: note.title,
text: note.content ?? '',
date: note.date
};
});
} catch (error) {
// TODO: ERROR
console.error(error);
return;
}
}
function GetNoteByName(name){
return TotalNotes.value.find(note => note.title == name);
}
export {
ShowContent,
SetShowContent,
ActivePane,
AnchoredMap,
SetActivePane,
AnchorMap,
ClearAnchoredMap
CurrentNotes,
FetchCampaignNotes,
TotalNotes,
PushNote,
DeleteNote,
GetNoteByName
}

View File

@@ -27,14 +27,6 @@ function PopulateContext(val){
let elementNum = 0;
val.forEach(element => {
// Handle divider elements
if (element.divider) {
let contextMenuElement = document.createElement('div');
contextMenuElement.classList.add("context-menu-divider");
children.push(contextMenuElement);
return;
}
let contextMenuElement = document.createElement('div');
contextMenuElement.classList.add("context-menu-element");
if(element.action)
@@ -44,13 +36,7 @@ function PopulateContext(val){
spanInfo.innerHTML = element.name;
contextMenuElement.appendChild(spanInfo);
if(element.color){
let swatch = document.createElement('span');
swatch.classList.add("context-menu-swatch");
swatch.style.backgroundColor = element.color;
contextMenuElement.appendChild(swatch);
}
else if(element.icon){
if(element.icon){
let iconContextElement = document.createElement('img');
iconContextElement.src = element.icon;
contextMenuElement.appendChild(iconContextElement);

View File

@@ -1,77 +0,0 @@
// The rules behind the note pins of a map (right click a map, pin one of the campaign notes at that
// spot, click the pin to read it). Pins are stored in image pixels, so these helpers only translate
// between the image and what the map viewer shows; they hold no state and talk to no API.
const PATH_SEPARATOR = ' / ';
// Screen pixels (relative to the top left corner of the map viewport) → image pixels, or null when
// the point is not over the image: nothing gets pinned outside of it.
function ToImagePoint(point, view) {
const zoom = Number(view?.zoom);
const width = Number(view?.width);
const height = Number(view?.height);
if (!zoom || !width || !height) return null;
const x = (Number(point?.x) - Number(view?.pan?.x ?? 0)) / zoom;
const y = (Number(point?.y) - Number(view?.pan?.y ?? 0)) / zoom;
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
if (x < 0 || y < 0 || x > width || y > height) return null;
return { x: Math.round(x), y: Math.round(y) };
}
// A pin (image pixels) → screen pixels of the map viewport. Pins are drawn in screen space instead
// of inside the scaled stage, so their marker keeps the same size whatever the zoom is.
function ToScreenPoint(pin, view) {
const zoom = Number(view?.zoom) || 0;
return {
x: Number(view?.pan?.x ?? 0) + Number(pin?.x ?? 0) * zoom,
y: Number(view?.pan?.y ?? 0) + Number(pin?.y ?? 0) * zoom
};
}
// The path of the folder a note lives in, so two notes sharing a name can still be told apart.
function FolderPath(folderId, folderById) {
const names = [];
const seen = new Set();
let folder = folderId ? folderById.get(String(folderId)) : null;
// Folder trees are acyclic by construction; `seen` only keeps a broken parent chain from
// looping forever.
while (folder && !seen.has(String(folder._id))) {
seen.add(String(folder._id));
if (folder.name) names.unshift(String(folder.name));
folder = folder.parentFolder ? folderById.get(String(folder.parentFolder)) : null;
}
return names.join(PATH_SEPARATOR);
}
// 'Folder / Subfolder / Note title' out of the picker option's folder path and title.
function OptionLabel(option) {
const path = option?.path ? `${option.path}${PATH_SEPARATOR}` : '';
return `${path}${option?.title ?? ''}`;
}
// The note picker of a campaign: `{ value, title, path, label }` per note, sorted by label. Notes
// without a title are left out, they would show as an empty menu entry.
function BuildNoteOptions(notes, folders) {
const folderById = new Map((folders ?? []).map((folder) => [String(folder._id), folder]));
return (notes ?? [])
.filter((note) => note?._id && String(note.title ?? '').trim())
.map((note) => {
const option = {
value: String(note._id),
title: String(note.title).trim(),
path: FolderPath(note.folder, folderById)
};
return { ...option, label: OptionLabel(option) };
})
.sort((a, b) => a.label.localeCompare(b.label));
}
export {
BuildNoteOptions,
OptionLabel,
ToImagePoint,
ToScreenPoint
};

View File

@@ -5,38 +5,28 @@ const widget_map = {
},
display: {
roll: () => import("~/components/viewer/widgets/display/RollWidgetDisplay.vue"),
},
link: {
link: () => import("~/components/viewer/widgets/link/NoteLink.vue")
}
};
const componentCache = {
inline: {},
display: {}
display: {},
link: {}
}
// Retorna null si el widget no està registrat (evita cridar
// defineAsyncComponent(undefined), que llençaria un TypeError i rebentaria
// tot el muntatge de notes).
const GetWidget = (type, name) => {
const loader = widget_map[type] && widget_map[type][name];
if (!loader) {
console.warn(`[Marker] Unknown widget "${name}" of type "${type}"; skipping.`);
return null;
}
if (!componentCache[type][name]) {
componentCache[type][name] = defineAsyncComponent(loader)
componentCache[type][name] = defineAsyncComponent(
widget_map[type][name]
)
}
return componentCache[type][name]
}
// Escapa valors per inserir-los de forma segura dins d'un atribut HTML.
const escapeAttr = (value) => String(value ?? "")
.replace(/&/g, "&amp;")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;")
.replace(/"/g, "&quot;");
const marker = new Marked();
@@ -59,7 +49,7 @@ const extension = {
},
renderer(token) {
return `<div class="vue-component-display" data-component="${escapeAttr(token.name)}" data-content="${escapeAttr(token.text)}"></div>`;
return `<div class="vue-component-display" data-component="${token.name}" data-content="${token.text}"></div>`;
},
};
@@ -84,7 +74,7 @@ const inlineExtension = {
},
renderer(token) {
return `<span class="vue-component-inline" data-component="${escapeAttr(token.name)}" data-content="${escapeAttr(token.text)}"></span>`;
return `<span class="vue-component-inline" data-component="${token.name}" data-content="${token.text}"></span>`;
},
};
@@ -108,7 +98,7 @@ const linkExtension = {
},
renderer(token) {
return `<span class="vue-link" data-href="${escapeAttr(token.link)}">Link</span>`;
return `<span class="vue-component-link" data-component="link" data-content="${token.link}"></span>`;
},
};

View File

@@ -0,0 +1,3 @@
import { ref } from 'vue';
const statusMessage = ref("")

View File

@@ -34,60 +34,6 @@ const defWindows = {
component: () => import('~/components/windows/CreateCampaignWindow.vue'),
close: () => ClearWindow({type: 'create_campaign'}),
movable: true
},
campaign_settings: {
title: 'campaigns.settings.title',
component: () => import('~/components/windows/CampaignSettingsWindow.vue'),
close: () => ClearWindow({type: 'campaign_settings'}),
movable: true
},
rename_note: {
title: "Rename Note",
component: () => import('~/components/windows/RenameNoteWindow.vue'),
close: () => ClearWindow({type: 'rename_note'}),
movable: true
},
new_folder: {
title: "New Folder",
component: () => import('~/components/windows/NewFolderWindow.vue'),
close: () => ClearWindow({type: 'new_folder'}),
movable: true
},
new_note: {
title: "New Note",
component: () => import('~/components/windows/NewNoteWindow.vue'),
close: () => ClearWindow({type: 'new_note'}),
movable: true
},
create_campaign_entry: {
title: 'campaigns.create-entry',
component: () => import('~/components/windows/CreateCampaignEntryWindow.vue'),
close: () => ClearWindow({type: 'create_campaign_entry'}),
movable: true
},
character_sheet: {
title: 'campaigns.character-sheet.title',
component: () => import('~/components/windows/CharacterSheetWindow.vue'),
close: () => ClearWindow({type: 'character_sheet'}),
movable: true
},
create_map: {
title: 'windows.create-map',
component: () => import('~/components/windows/CreateMapWindow.vue'),
close: () => ClearWindow({type: 'create_map'}),
movable: true
},
map_viewer: {
title: 'windows.map-viewer',
component: () => import('~/components/windows/MapViewerWindow.vue'),
close: () => ClearWindow({type: 'map_viewer'}),
movable: true
},
pinned_note: {
title: 'windows.pinned-note',
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
close: () => ClearWindow({type: 'pinned_note'}),
movable: true
}
}

View File

@@ -189,7 +189,6 @@ function GetPosition(id) {
function ResetPosition(id, pos) {
let win = GetWindowWithId(id);
if (!win) return;
let data = { x: win.x, y: win.y };
if (data.x && data.y) {

View File

@@ -1,91 +0,0 @@
{
"create": {
"name": "Nom", "description": "Descripció", "description-placeholder": "Escriu una breu descripció de la campanya...",
"enter": "Introdueix el nom de la campanya...", "color": "Color d'accent", "success": "Campanya creada correctament!"
},
"settings": {
"title": "Configuració de la campanya",
"tabs": { "basic": "Bàsic", "integrations": "Integracions" },
"name": "Nom de la campanya",
"color": "Color de la campanya",
"foundry-url": "URL de Foundry VTT",
"foundry-url-help": "Introdueix l'URL base de la instància de Foundry VTT que executa el mòdul Dragonroll Foundry.",
"no-foundry-world": "Aquesta campanya no té cap món de Foundry enllaçat.",
"start-foundry-link": "Crea un codi per a Foundry",
"start-foundry-link-help": "Copia aquest codi a l'opció Dragonroll Campaign Pairing Code del mòdul de Foundry. Dragonroll Endpoint utilitza https://dragonroll.aranroig.com de manera predeterminada. El codi caduca al cap de 10 minuts.",
"unlink-foundry": "Desenllaça",
"saved": "S'ha desat la configuració de la campanya.",
"linked": "S'ha enllaçat el món de Foundry amb aquesta campanya.",
"unlinked": "S'ha desenllaçat el món de Foundry d'aquesta campanya.",
"copy-code": "Copia el codi",
"code-copied": "S'ha copiat el codi d'enllaç.",
"saving": "Desant...",
"errors": {
"name-required": "Introdueix un nom per a la campanya.",
"invalid-foundry-url": "Introdueix una URL vàlida de Foundry VTT amb http o https.",
"link-expired": "El codi d'enllaç ha caducat. Crea'n un de nou.",
"copy-code": "No s'ha pogut copiar el codi d'enllaç."
}
},
"sidebar-label": "Campanya",
"synced": "Sincronitzat",
"sections": { "notes": "Notes", "actors": "Actors i personatges", "items": "Objectes", "maps": "Mapes" },
"actions": {
"new-note": "Nota nova", "new-folder": "Carpeta nova", "refresh": "Actualitza",
"create": "Crea {section}", "submit": "Crea", "edit": "Edita", "save": "Desa", "delete": "Suprimeix", "saving": "Desant...",
"collapse-sidebar": "Redueix la barra lateral", "expand-sidebar": "Expandeix la barra lateral"
},
"states": {
"loading": "Carregant...", "loading-notes": "Carregant notes...", "empty-notes": "Encara no hi ha notes en aquesta campanya.",
"empty-actors": "Encara no hi ha actors ni personatges.", "empty-items": "Encara no hi ha objectes en aquesta campanya.",
"empty-maps": "Encara no hi ha mapes en aquesta campanya."
},
"errors": { "load": "No s'han pogut carregar les entrades de la campanya." },
"create-entry": "Crea una entrada de campanya",
"fields": { "name": "Nom", "description": "Descripció" },
"actor": {
"new": "Actor o personatge nou", "type": "Tipus", "species": "Espècie", "class": "Classe",
"level": "Nivell", "level-short": "Nivell", "background": "Rerefons", "challenge-rating": "Grau de desafiament",
"challenge-rating-placeholder": "Per exemple, 1/4 o 3", "cr-short": "GD",
"types": { "character": "Personatge", "npc": "PNJ", "creature": "Criatura" }
},
"item": {
"new": "Objecte nou", "edit": "Edita l'objecte", "foundry-sync-note": "Els canvis en aquest objecte també s'apliquen al món del Foundry vinculat.",
"category": "Categoria", "rarity": "Raresa", "quantity": "Quantitat",
"quantity-short": "Quant.", "weight": "Pes (lb)", "properties": "Propietats", "properties-placeholder": "Per exemple, versàtil, subtil",
"categories": {
"weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura",
"magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre"
},
"rarities": { "common": "Comuna", "uncommon": "Poc comuna", "rare": "Rara", "very-rare": "Molt rara", "legendary": "Llegendària", "artifact": "Artefacte" }
},
"map": {
"new": "Mapa nou", "edit": "Edita el mapa",
"photo": "Imatge del mapa", "upload-photo": "Pujar imatge", "change-photo": "Canviar imatge",
"photo-hint": "Una foto o una digitalització del mapa. Es manté la imatge actual si no en tries una de nova.",
"grid-size": "Mida de la quadrícula (px)", "offset-x": "Desplaçament X (px)", "offset-y": "Desplaçament Y (px)",
"scale": "Escala (distància per cel·la)", "scale-help": "La distància que representa una cel·la de la quadrícula, com ara 5 peus.",
"summary": "Quadrícula de {size} px · {scale} per cel·la",
"save-error": "No s'ha pogut desar aquest mapa.",
"no-image": "Aquest mapa encara no té imatge.",
"zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula",
"open-window": "Obre en una finestra", "anchored": "Ancorat",
"pins": {
"add": "Fixa una nota aquí", "none": "Encara no hi ha notes per fixar",
"open": "Obre la nota", "remove": "Treu el marcador",
"error": "No s'han pogut canviar els marcadors d'aquest mapa.",
"note-error": "No s'ha pogut llegir aquesta nota. Potser s'ha suprimit."
}
},
"character-sheet": {
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la",
"saving": "Desant...", "save": "Desa la fitxa", "save-error": "No s'ha pogut desar aquesta fitxa de personatge.", "photo": "Foto", "upload-photo": "Pujar foto", "change-photo": "Canviar foto", "remove-photo": "Treure foto", "uploading-photo": "Pujant...", "photo-error": "No s'ha pogut pujar aquesta foto.", "ability-scores": "Característiques", "proficiency-bonus": "Bonificador de competència",
"combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "proficiencies": "Competències",
"proficiencies-placeholder": "Afegeix salvacions, habilitats, armadures, armes, eines i idiomes...", "empty-proficiencies": "No hi ha competències afegides.",
"traits": "Trets", "traits-placeholder": "Afegeix trets, capacitats i altres detalls...", "empty-traits": "No hi ha trets afegits.",
"spells": "Conjurs", "spells-placeholder": "Escriu els conjurs, un per línia...", "empty-spells": "No hi ha conjurs afegits.",
"inventory": "Inventari", "add-item": "Afegeix un objecte", "carried-weight": "Pes transportat", "item-name": "Objecte",
"quantity": "Quant.", "weight-each": "Unitat (lb)", "total-weight": "Total (lb)", "actions": "Accions", "empty-inventory": "L'inventari és buit."
}
}

View File

@@ -1,18 +0,0 @@
{
"title": "Connectar Dragonroll amb Discord",
"checking": "Comprovant aquesta sol·licitud d'autorització…",
"summary": "Servidor de Discord: {guild}. Sol·licitat per {user}. Inicia sessió i confirma-ho només si confies en aquesta sol·licitud.",
"sign-in-lead": "Inicia sessió amb el compte de Dragonroll que és propietari de la campanya que vols que utilitzi aquest servidor.",
"signed-in-as": "Has iniciat sessió com a {user}.",
"approve": "Autoritzar aquest servidor de Discord",
"connected": "Dragonroll s'ha connectat a {guild}.",
"next-step": "Torna a Discord i executa /dragonroll link per triar una campanya.",
"replace-warning": "Autoritzar un altre compte de Dragonroll reemplaça la connexió actual i l'enllaç de campanya d'aquest servidor.",
"errors": {
"missing-code": "A aquest enllaç d'autorització li falta el codi. Executa /dragonroll connect a Discord de nou.",
"link-expired": "Aquest enllaç d'autorització no és vàlid o ha caducat. Executa /dragonroll connect a Discord de nou.",
"sign-in-failed": "No s'ha pogut iniciar sessió a Dragonroll. Revisa l'usuari i la contrasenya.",
"session-expired": "La teva sessió de Dragonroll ha caducat. Inicia sessió de nou per continuar.",
"internal": "No s'ha pogut carregar aquesta sol·licitud d'autorització."
}
}

View File

@@ -1,8 +0,0 @@
{
"errors": {
"link-expired": "El codi d'enllaç de Foundry no és vàlid, ha caducat o ja s'ha utilitzat.",
"world-already-linked": "Aquest món de Foundry ja està enllaçat amb una altra campanya.",
"actor-already-synced": "Un altre actor d'aquesta campanya ja està sincronitzat amb aquell actor del Foundry.",
"item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry."
}
}

View File

@@ -1,7 +1 @@
{
"save": "Desa",
"notes": {
"saved": "Nota desada",
"save-error": "No s'ha pogut desar la nota"
}
}
{}

View File

@@ -3,6 +3,5 @@
"edit-profile": "Editar perfil",
"create-campaign": "Crear campanya",
"log-out": "Tanca la sessió",
"settings": "Configuració",
"exit": "Sortir"
"settings": "Configuració"
}

View File

@@ -5,8 +5,5 @@
"example": "Finestra d'exemple",
"edit-profile": "Editar perfil",
"settings": "Configuració",
"create-campaign": "Crear campanya",
"create-map": "Crear mapa",
"map-viewer": "Mapa",
"pinned-note": "Nota fixada"
"create-campaign": "Crear campanya"
}

View File

@@ -6,92 +6,5 @@
"enter": "Enter campaign name here...",
"color": "Accent color",
"success": "Campaign created successfully!"
},
"settings": {
"title": "Campaign settings",
"tabs": { "basic": "Basic", "integrations": "Integrations" },
"name": "Campaign name",
"color": "Campaign color",
"foundry-url": "Foundry VTT URL",
"foundry-url-help": "Enter the base URL of the Foundry VTT instance running the Dragonroll Foundry module.",
"no-foundry-world": "No Foundry world is linked to this campaign.",
"start-foundry-link": "Create a code for Foundry",
"start-foundry-link-help": "Copy this code into the Dragonroll Campaign Pairing Code setting in the Foundry module. The Dragonroll Endpoint defaults to https://dragonroll.aranroig.com. The code expires after 10 minutes.",
"unlink-foundry": "Unlink",
"saved": "Campaign settings saved.",
"linked": "Foundry world linked to this campaign.",
"unlinked": "Foundry world unlinked from this campaign.",
"copy-code": "Copy code",
"code-copied": "Pairing code copied.",
"saving": "Saving...",
"errors": {
"name-required": "Enter a campaign name.",
"invalid-foundry-url": "Enter a valid Foundry VTT URL using http or https.",
"link-expired": "This pairing code expired. Create a new one.",
"copy-code": "Unable to copy the pairing code."
}
},
"sidebar-label": "Campaign",
"synced": "Synced",
"sections": { "notes": "Notes", "actors": "Actors & Characters", "items": "Items", "maps": "Maps" },
"actions": {
"new-note": "New note", "new-folder": "New folder", "refresh": "Refresh",
"create": "Create {section}", "submit": "Create", "edit": "Edit", "save": "Save", "delete": "Delete", "saving": "Saving...",
"collapse-sidebar": "Collapse sidebar", "expand-sidebar": "Expand sidebar"
},
"states": {
"loading": "Loading...", "loading-notes": "Loading notes...", "empty-notes": "No notes in this campaign yet.",
"empty-actors": "No actors or characters yet.", "empty-items": "No items in this campaign yet.",
"empty-maps": "No maps in this campaign yet."
},
"errors": { "load": "Unable to load campaign entries." },
"create-entry": "Create campaign entry",
"fields": { "name": "Name", "description": "Description" },
"actor": {
"new": "New actor or character", "type": "Type", "species": "Species", "class": "Class",
"level": "Level", "level-short": "Level", "background": "Background", "challenge-rating": "Challenge rating",
"challenge-rating-placeholder": "For example, 1/4 or 3", "cr-short": "CR",
"types": { "character": "Character", "npc": "NPC", "creature": "Creature" }
},
"item": {
"new": "New item", "edit": "Edit item", "foundry-sync-note": "Changes to this item are also applied in the linked Foundry world.",
"category": "Category", "rarity": "Rarity", "quantity": "Quantity",
"quantity-short": "Qty", "weight": "Weight (lb)", "properties": "Properties", "properties-placeholder": "For example, versatile, finesse",
"categories": {
"weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear",
"magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other"
},
"rarities": { "common": "Common", "uncommon": "Uncommon", "rare": "Rare", "very-rare": "Very rare", "legendary": "Legendary", "artifact": "Artifact" }
},
"map": {
"new": "New map", "edit": "Edit map",
"photo": "Map image", "upload-photo": "Upload image", "change-photo": "Change image",
"photo-hint": "A photo or scan of the map. The current image is kept when you do not pick a new one.",
"grid-size": "Grid size (px)", "offset-x": "Offset X (px)", "offset-y": "Offset Y (px)",
"scale": "Scale (distance per cell)", "scale-help": "How much distance one grid cell stands for, like 5 feet.",
"summary": "{size} px grid · {scale} per cell",
"save-error": "Unable to save this map.",
"no-image": "This map has no image yet.",
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid",
"open-window": "Open in window", "anchored": "Anchored",
"pins": {
"add": "Pin a note here", "none": "No notes to pin yet",
"open": "Open note", "remove": "Remove pin",
"error": "Unable to change the pins of this map.",
"note-error": "This note could not be read. It may have been deleted."
}
},
"character-sheet": {
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
"level": "Level", "species": "Species", "unset-species": "Species not set", "edit": "Edit sheet", "cancel": "Cancel",
"saving": "Saving...", "save": "Save sheet", "save-error": "Unable to save this character sheet.",
"photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo",
"uploading-photo": "Uploading...", "photo-error": "Unable to upload this photo.", "ability-scores": "Ability Scores", "proficiency-bonus": "Proficiency Bonus",
"combat": "Combat", "armor-class": "Armor Class", "speed": "Speed", "proficiencies": "Proficiencies",
"proficiencies-placeholder": "Add saving throws, skills, armor, weapons, tools, and languages...", "empty-proficiencies": "No proficiencies added.",
"traits": "Traits", "traits-placeholder": "Add features, traits, and other character details...", "empty-traits": "No traits added.",
"spells": "Spells", "spells-placeholder": "List spells, one per line...", "empty-spells": "No spells added.",
"inventory": "Inventory", "add-item": "Add item", "carried-weight": "Carried weight", "item-name": "Item",
"quantity": "Qty", "weight-each": "Each (lb)", "total-weight": "Total (lb)", "actions": "Actions", "empty-inventory": "Inventory is empty."
}
}

View File

@@ -1,18 +0,0 @@
{
"title": "Connect Dragonroll to Discord",
"checking": "Checking this authorization request…",
"summary": "Discord server: {guild}. Requested by {user}. Sign in and confirm only if you trust this request.",
"sign-in-lead": "Sign in to the Dragonroll account that owns the campaign you want this server to use.",
"signed-in-as": "Signed in as {user}.",
"approve": "Authorize this Discord server",
"connected": "Dragonroll is connected to {guild}.",
"next-step": "Return to Discord and run /dragonroll link to choose a campaign.",
"replace-warning": "Authorizing a different Dragonroll account replaces this server's current connection and campaign link.",
"errors": {
"missing-code": "This authorization link is missing its code. Run /dragonroll connect in Discord again.",
"link-expired": "This authorization link is invalid or expired. Run /dragonroll connect in Discord again.",
"sign-in-failed": "Dragonroll sign in failed. Check your username and password.",
"session-expired": "Your Dragonroll session has expired. Sign in again to continue.",
"internal": "Could not load this authorization request."
}
}

Some files were not shown because too many files have changed in this diff Show More