56 Commits

Author SHA1 Message Date
Gitea OpenCode Agent
b47bbb4cab Fix issue #65: Item selecting icon
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 16:01:36 +00:00
cdafd1f53a Merge pull request 'Fix #57: Sync foundry folder colors' (#66) from ai/issue-57 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 1m6s
Reviewed-on: #66
2026-10-15 14:00:08 +00:00
2e2fb97e5d Merge branch 'master' into ai/issue-57
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 14:00:02 +00:00
Gitea OpenCode Agent
d03cc1eb59 Fix issue #57: Sync foundry folder colors
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:58:42 +00:00
20128d195b Merge pull request 'Fix #55: Split character sheet in tabs' (#62) from ai/issue-55 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 51s
Reviewed-on: #62
2026-10-15 13:33:28 +00:00
d901385900 Merge branch 'master' into ai/issue-55
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:33:20 +00:00
Gitea OpenCode Agent
2add9e7cb8 Fix issue #55: Split character sheet in tabs
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:26:16 +00:00
fe63bd15f3 Merge pull request 'Fix #54: Adding a background to an actor bug' (#60) from ai/issue-54 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 1m5s
Reviewed-on: #60
2026-10-15 13:18:07 +00:00
733e7ef193 Merge branch 'master' into ai/issue-54
Some checks failed
Test / test (push) Failing after 1s
2026-10-15 13:17:59 +00:00
d566388fc6 Merge pull request 'Fix #53: Item modifications' (#59) from ai/issue-53 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Has been cancelled
Reviewed-on: #59
2026-10-15 13:17:40 +00:00
86e1d34beb Merge branch 'master' into ai/issue-53
Some checks failed
Test / test (push) Failing after 3s
2026-10-15 13:17:34 +00:00
cd741880ac Merge pull request 'Fix #51: Error when opening manage acconuts' (#58) from ai/issue-51 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Has been cancelled
Reviewed-on: #58
2026-10-15 13:17:22 +00:00
378e28f703 Merge branch 'master' into ai/issue-51
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:17:16 +00:00
Gitea OpenCode Agent
7e1ed4475e Fix issue #54: Adding a background to an actor bug
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:14:36 +00:00
Gitea OpenCode Agent
0c6026aea8 Fix issue #53: Item modifications
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 12:46:36 +00:00
Gitea OpenCode Agent
844ed006cc Fix issue #51: Error when opening manage acconuts
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 12:36:28 +00:00
4b6200960f Merge pull request 'Fix #49: Unify folder system' (#56) from ai/issue-49 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 1m6s
Reviewed-on: #56
2026-10-15 12:30:20 +00:00
1e0d81ecc4 Merge branch 'master' into ai/issue-49
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 12:30:09 +00:00
Gitea OpenCode Agent
cd92a2d112 Fix issue #49: Unify folder system
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 12:11:19 +00:00
a314b935bd Merge pull request 'Fix #48: "Remember me" checkbox on login' (#52) from ai/issue-48 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 1m7s
Reviewed-on: #52
2026-10-15 11:14:47 +00:00
42027ff3fa Merge branch 'master' into ai/issue-48
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 11:14:37 +00:00
Gitea OpenCode Agent
adb29d3ef6 Fix issue #48: "Remember me" checkbox on login
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 11:11:17 +00:00
0106c13835 Merge pull request 'Fix #47: Settings menu' (#50) from ai/issue-47 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 51s
Reviewed-on: #50
2026-10-15 11:08:57 +00:00
a42a11cf53 Merge branch 'master' into ai/issue-47
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 11:08:48 +00:00
Gitea OpenCode Agent
8c4310e771 Fix issue #47: Settings menu
All checks were successful
Test / test (push) Successful in 2s
2026-10-15 11:03:08 +00:00
4faa585874 Merge pull request 'Fix #44: Sync item folders' (#46) from ai/issue-44 into master
Some checks failed
Test / test (push) Failing after 2s
Build and Deploy Nuxt / build (push) Successful in 1m6s
Reviewed-on: #46
2026-10-15 10:39:47 +00:00
69e0181b66 Merge branch 'master' into ai/issue-44
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 10:39:41 +00:00
f29bbd45a3 Merge pull request 'Fix #42: Improve search' (#45) from ai/issue-42 into master
All checks were successful
Test / test (push) Successful in 2s
Build and Deploy Nuxt / build (push) Successful in 54s
Reviewed-on: #45
2026-10-15 09:16:57 +00:00
5643031a70 Merge branch 'master' into ai/issue-42
All checks were successful
Test / test (push) Successful in 2s
2026-10-15 09:16:51 +00:00
Gitea OpenCode Agent
1f9ab330b9 Fix issue #44: Sync item folders
Some checks failed
Test / test (push) Failing after 2s
2026-10-14 23:39:26 +00:00
Gitea OpenCode Agent
c6656fad3a Fix issue #42: Improve search
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 22:39:24 +00:00
c7d20dd1f7 Merge pull request 'Fix #41: Clicking button of actors on sidebar not change map or notes' (#43) from ai/issue-41 into master
All checks were successful
Test / test (push) Successful in 2s
Build and Deploy Nuxt / build (push) Successful in 52s
Reviewed-on: #43
2026-10-14 22:33:19 +00:00
Gitea OpenCode Agent
8348936122 Fix issue #41: Clicking button of actors on sidebar not change map or notes
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 22:30:17 +00:00
4d532d10ae Merge pull request 'Fix #38: Implement tokens on maps' (#40) from ai/issue-38 into master
All checks were successful
Test / test (push) Successful in 2s
Build and Deploy Nuxt / build (push) Successful in 1m11s
Reviewed-on: #40
2026-10-14 22:24:00 +00:00
af7bf9fa27 Merge branch 'master' into ai/issue-38
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 22:23:52 +00:00
3b897da390 Merge pull request 'Fix #35: Dragonroll frontend: item modifications' (#39) from ai/issue-35 into master
Some checks failed
Test / test (push) Successful in 2s
Build and Deploy Nuxt / build (push) Has been cancelled
Reviewed-on: #39
2026-10-14 22:23:48 +00:00
278d25b294 Merge branch 'master' into ai/issue-35
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 22:23:41 +00:00
Gitea OpenCode Agent
d567b5d171 Fix issue #38: Implement tokens on maps
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 18:41:17 +00:00
Gitea OpenCode Agent
22c6403736 Fix issue #35: Dragonroll frontend: item modifications
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 18:08:19 +00:00
ef343dbdd8 Merge pull request 'Fix #34: Motion error' (#37) from ai/issue-34 into master
All checks were successful
Test / test (push) Successful in 2s
Build and Deploy Nuxt / build (push) Successful in 57s
Reviewed-on: #37
2026-10-14 17:56:20 +00:00
909d403435 Merge branch 'master' into ai/issue-34
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 17:56:13 +00:00
Gitea OpenCode Agent
4505365f21 Fix issue #34: Motion error
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 17:52:37 +00:00
2c78ad039a Merge pull request 'Fix #33: Try to remove ecosystem' (#36) from ai/issue-33 into master
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 1m2s
Reviewed-on: #36
2026-10-14 17:52:18 +00:00
Gitea OpenCode Agent
1d3d978cda Fix issue #33: Try to remove ecosystem
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 17:50:31 +00:00
e11c6fc4f3 jkdsjkdjs
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 51s
2026-10-14 19:13:14 +02:00
8fa852d859 Merge pull request 'Fix #29: Migrate from npm to pnpm workspace' (#31) from ai/issue-29 into master
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 1m37s
Reviewed-on: #31
2026-10-14 17:09:51 +00:00
4e15b28bf6 Merge branch 'master' into ai/issue-29
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 17:09:45 +00:00
Gitea OpenCode Agent
4355986bd1 Fix issue #30: Make AGENTS.md smaller
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 17:07:28 +00:00
Gitea OpenCode Agent
9820a375dc Fix issue #29: Migrate from npm to pnpm workspace
All checks were successful
Test / test (push) Successful in 2s
2026-10-14 17:01:02 +00:00
a6ad14a1b5 Added skills
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 54s
(cherry picked from commit bb4b3c4553)
2026-10-14 18:46:17 +02:00
b02ecca7d4 Merge pull request 'Fix #27: Add frontend testing' (#28) from ai/issue-27 into master
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 48s
Reviewed-on: #28
2026-10-14 16:32:02 +00:00
26c0a0b0a1 Merge branch 'master' into ai/issue-27
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 16:31:53 +00:00
Gitea OpenCode Agent
59a4c1dd0c Fix issue #27: Add frontend testing
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 16:30:59 +00:00
e3248ac4dc Merge pull request 'Fix #20: Add notes to a map' (#23) from ai/issue-20 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m5s
Reviewed-on: #23
2026-10-14 16:30:54 +00:00
969e559c57 Merge branch 'master' into ai/issue-20 2026-10-14 16:30:48 +00:00
Gitea OpenCode Agent
ba84e10525 Fix issue #20: Add notes to a map 2026-10-14 14:46:58 +00:00
101 changed files with 20733 additions and 16059 deletions

View File

@@ -0,0 +1,440 @@
---
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

@@ -0,0 +1,233 @@
# 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

@@ -0,0 +1,191 @@
# 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

@@ -0,0 +1,167 @@
---
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

@@ -0,0 +1,177 @@
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

@@ -0,0 +1,42 @@
---
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

@@ -0,0 +1,639 @@
---
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

@@ -0,0 +1,430 @@
# 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

@@ -0,0 +1,343 @@
---
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.

513
.agents/skills/seo/SKILL.md Normal file
View File

@@ -0,0 +1,513 @@
---
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)

9
.dockerignore Normal file
View File

@@ -0,0 +1,9 @@
# Images are built from the repository root (see .gitea/workflows/deploy.yml:
# `docker build -f <package>/Dockerfile .`), so this is the ignore file that counts.
.git
**/node_modules
**/*.log
**/.env
frontend/.nuxt
frontend/.output
frontend/dist

View File

@@ -32,24 +32,28 @@ jobs:
run: | run: |
echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login git.aranroig.com -u "${{ secrets.REGISTRY_USER }}" --password-stdin echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login git.aranroig.com -u "${{ secrets.REGISTRY_USER }}" --password-stdin
# pnpm workspace: every image is built from the repository root so the
# Dockerfiles can read pnpm-workspace.yaml, pnpm-lock.yaml and the other
# package.json files of the workspace.
- name: Build frontend - name: Build frontend
run: | run: |
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-frontend:latest \ docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-frontend:latest \
--build-arg NUXT_PUBLIC_GIT_COMMIT=$(git rev-parse --short HEAD) \ --build-arg NUXT_PUBLIC_GIT_COMMIT=$(git rev-parse --short HEAD) \
--build-arg NUXT_PUBLIC_GIT_TAG=$(git describe --tags --abbrev=0) \ --build-arg NUXT_PUBLIC_GIT_TAG=$(git describe --tags --abbrev=0) \
--build-arg NUXT_PUBLIC_GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD) \ --build-arg NUXT_PUBLIC_GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD) \
./frontend -f ./frontend/Dockerfile .
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-frontend:latest docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-frontend:latest
- name: Build backend - name: Build backend
run: | run: |
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest ./backend docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest \
-f ./backend/Dockerfile .
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest
- name: Build discord bot - name: Build discord bot
run: | run: |
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \ docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \
./discord-bot -f ./discord-bot/Dockerfile .
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest
- name: Copy files - name: Copy files

35
.gitea/workflows/test.yml Normal file
View File

@@ -0,0 +1,35 @@
name: Test
on:
push:
branches: ['**']
jobs:
test:
runs-on: docker
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
run: |
# The suite runs on Node's built-in test runner and needs Node 18+. The container the
# docker runner starts jobs in is not guaranteed to ship one, so fall back to the
# official LTS tarball. The tests themselves install no dependencies.
if node -e 'process.exit(Number(process.versions.node.split(".")[0]) >= 18 ? 0 : 1)' 2>/dev/null; then
node --version
else
apt-get update -y && apt-get install -y curl ca-certificates xz-utils
curl -fsSL https://nodejs.org/dist/v22.12.0/node-v22.12.0-linux-x64.tar.xz -o /tmp/node.tar.xz
tar -xJf /tmp/node.tar.xz -C /usr/local --strip-components=1
node --version
fi
- name: Run tests
# The repository is a pnpm workspace: run the root script through corepack,
# which picks the pnpm version pinned by "packageManager" in package.json.
run: corepack pnpm test
env:
COREPACK_ENABLE_DOWNLOAD_PROMPT: '0'

691
AGENTS.md
View File

@@ -1,580 +1,235 @@
# AGENTS.md — Dragonroll # AGENTS.md — Dragonroll
Read this file before touching the code. It is a complete map of the project: layout, architecture, Orientation map, kept short on purpose. Read the file you are about to change: this tells you where to
data model, API, conventions and known landmines. You should not need to explore the rest of the repo look and what will bite you, it does not replace the code. Longer docs: `dragonroll-foundry/README.md`,
to make a correct change. `discord-bot/README.md`, `obsidian-plugin/README.md`.
## 1. What this is ## 1. What this is
**Dragonroll** is a free/open-source helper for tabletop RPG campaigns (notes, campaigns, folders, Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, folders, characters,
dice widgets, shared markdown, sounds). It is a two-app monorepo: items, maps, dice widgets, sounds).
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS. - `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion. - `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. No routed pages (§5.1).
- `discord-bot/` — Discord bot (slash commands) that talks to the backend with a shared service secret, no login.
- `dragonroll-foundry/` — Foundry VTT module (`scripts/api.js`) + optional read-only snapshot bridge.
- `obsidian-plugin/` — plain JavaScript Obsidian plugin that imports/pushes campaign notes.
- `tests/` — `npm test` (`node --test`, no dependencies installed): Foundry sync toggle and pairing status, map pins and tokens, sidebar entries.
There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). The only automated tests self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
are `tests/*.test.js` (`npm test`, Node's built-in runner), which exercise the Foundry module's sync `.gitea/workflows/test.yml` runs `npm test` on every branch.
logic against stubbed Foundry globals.
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`). ## 2. Commands
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 `pnpm` comes from corepack (`packageManager` in `package.json`); `COREPACK_ENABLE_DOWNLOAD_PROMPT=0`
keeps corepack from asking in non-interactive shells.
```
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 ```bash
npm install # root: installs `concurrently` only pnpm install # whole workspace, one lockfile (`-r` / `--filter <pkg>` for a single one)
npm install --prefix backend pnpm dev # backend :5000 + frontend :3000 + discord-bot + scripts/run-foundry.js
npm install --prefix frontend # runs `nuxt prepare` via postinstall pnpm dev:backend # or dev:frontend | dev:discord-bot
pnpm --filter ./frontend run build # or preview
npm run dev # both apps: backend (nodemon, :5000) + frontend (nuxt dev, :3000) pnpm test
# 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. No `start` script in backend/frontend and no lint command. Verification = run the dev server and
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello); exercise the flow (`GET /api/test` returns a JSON hello).
`npm test` covers the Foundry character/item sync toggle and per-actor force sync.
### Environment files There is no PM2 and no `ecosystem.config.js`: `pnpm dev` starts every dev process at the same time
through the workspace (`concurrently` only labels them and kills them together), and production runs
from the compose images (`CMD` of each `Dockerfile`).
| File | Contents | Notes | Env: `backend/.env` (`PORT` is read but ignored, `DB_URI`), `frontend/.env` (`NUXT_PUBLIC_API_BASE_URL`),
|---|---|---| both gitignored; the `.env.production` files are committed. `backend/src/index.js` loads `.env.$NODE_ENV`
| `.env` (root) | `FOUNDRY_START_SCRIPT=<path to Foundry VTT start.sh>` | gitignored; consumed by `scripts/run-foundry.js` during `npm run dev` | when `NODE_ENV` is set, otherwise `.env`. The server always listens on **5000**.
| `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`. ## 3. Backend
`PORT` is read from env but **ignored**: the server always listens on 5000.
## 4. Backend `src/models/` one Mongoose schema per file · `src/routes/` thin Express routers · `src/services/`
shared infra (`keys.js` JWT secret, `passport.js` JwtStrategy, `storage.js` multer → `src/uploads/`
served publicly at `/api/public`, `rate-limiter.js` 150 req/60 min, `service-links.js` the service
pairing in §4, `*-foundry.js` Foundry document → Dragonroll field mappers).
``` **Auth chain, order matters** (`src/index.js`): `/api/public/*` static → `/api/user`, `/api/discord`,
backend/src/ `/api/link`, `/api/foundry` (link + sync, token-authenticated) are mounted **before**
├── index.js app bootstrap: dotenv, static uploads, json limits (50mb), `checkAuth = passport.authenticate('jwt', {session:false})`; everything after it
│ passport init, CORS, route mounting, listen(5000) (`/api/campaign|note|folder|actor|item|map|foundry`) is JWT-protected. `checkAuth` is assigned without
├── db.js connectDB() -> mongoose.connect(process.env.DB_URI) `const` (implicit global). New user routes are public unless the handler calls
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js Map.js `passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
│ FoundryLinkRequest.js DiscordLinkRequest.js DiscordGuildLink.js `/get-settings`). JWT: payload `{_id, username, name, email, admin, settings}`, 48h; `req.user` is the
├── routes/ user.js campaign.js note.js folder.js actor.js item.js map.js Mongoose document, so routes use `req.user.id`.
│ 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`) CORS allows any origin for the service link/sync paths only; the app-wide CORS whitelists
`http://localhost:3000` and nothing else (production hides behind the nginx same-origin proxy).
1. `/api/public/*` → static file serving of `src/uploads` (no auth). **Response envelope** — always HTTP 200, no real status codes:
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 ```jsonc
{ "status": "ok", ...payload } { "status": "ok", ...payload }
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose { "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
``` ```
Common `msg` keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`, Common keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. The frontend checks `login.errors.invalid-credentials`, `register.errors.email-username-exists`. `GET /user/has-admin`
`response.data.status !== 'ok'`. `GET /user/has-admin` uses a special `status: "init"` to mean returns `status: 'init'` when no admin exists yet (→ first-run registration).
"no admin exists yet → show first-run registration".
### Authorization model **Authorization** — single-tenant: a campaign belongs to `createdBy`, everything else hangs off a
campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, userId)` helper that is
*duplicated per router file* (match that unless you refactor all at once). `settings`, `color`,
`description` are free-form fields.
Single-tenant per user: a campaign belongs to `createdBy`, everything else hangs off a campaign. **Models** (`*` = required; notes and folders are always ordered `date: -1`):
`note.js` and `folder.js` define a local helper:
```js - `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
async function userOwnsCampaign(campaignId, userId) { ... } // duplicated in both files - `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
``` - `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`)
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
Ownership is enforced per handler. `settings`, `color`, `description` and `User.settings` are schemaless **API surface** (all under `/api`, all `{status,msg}`):
`Object`/free-form fields.
### Data model - `user` — `register`, `verify-setup?code=`, `setup?code=`, `login` (`{usermail,password}`, accepts username or email → `{token}`), `upload-avatar` (multipart `image`, JWT) / `retrieve-avatar?username=`, `has-admin`, `update-settings` / `get-settings`. Files fetched from `/api/public/<filename>`.
- `campaign` — `create`, `update`, `list`, `retrieve/:id`, `services` + `service-unlink` (what is linked to a campaign)
- `note` — `list?campaign=` (root notes + folders with `parentFolder`), `subfolder/list?campaign=&folder=`, `all?campaign=` (titles only, for the map pin picker), `retrieve/:id`, `create`, `update` (partial), `delete`
- `folder` — `list`, `create`, `update`, `rename`, `delete` (recursive: inner notes go to `folder: null`, subfolders re-parent then delete)
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
- `item` — `list`, `create`, `update` (partial), `delete`
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`), `place-token` (`{id,actor,x,y}`, snapped to a cell centre, re-placing moves the token), `remove-token` (`{id,token}`)
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`; `/icons?campaign=&dir=&offset=` lists one folder of the world's core `icons/` library (the bridge reads it from `DRAGONROLL_FOUNDRY_DATA_PATH`) and answers `{dir, parent, folders, files[{path,name,url}], next}`, the icons paged so the library stays lazy to load
``` ## 4. Service integrations (Foundry, Discord, Obsidian)
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 | Every external service links to a campaign the same way, **never with a Dragonroll login**: it calls
|---|---|---| `POST /api/link/start`, shows the returned sign-up link, and the user opens it in the frontend
| `User` | `models/User.js` | `name*`, `username*` (unique), `email*` (unique), `password` (bcrypt hash, 10 salt rounds), `date`, `admin` (bool, default false), `image`, `setupCode`, `settings` (Object) | (`/link/authorize`, handled by `views/ServiceLinkAuthorize.vue` outside the window app), signs in and
| `Campaign` | `models/Campaign.js` | `name*`, `description`, `color`, `createdBy*` → User, `date`, `settings` (Object), `foundryWorldId` (unique, sparse), `foundryWorldTitle`, `foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId` | picks a campaign at `POST /api/link/complete`; the service then redeems its credential once at
| `Note` | `models/Note.js` | `title`, `content` (markdown source string), `campaign*` → Campaign, `folder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` | `POST /api/link/pickup` (one-time; losing it means a new link). Proofs differ per service
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` | (`services/service-links.js`): the Discord bot proves itself with the shared secret header, Foundry and
| `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` | Obsidian only hold their link code, so what a link grants is decided by the user. Codes are hashed at
| `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` | rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
| `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), `campaign*` → Campaign, `date` |
`*` = required. Notes and folders are ordered by `date: -1` everywhere. Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
### API reference - **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
`POST /api/user/register` — body `{username,email,name,password}`. First registered user becomes - **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
`admin: true`. (Currently broken: see §9.) - **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
`GET /api/user/verify-setup?code=` — `{status:'ok',code}` | `{status:'error',msg:'not-exists'}` - `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge.
`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}`
`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)
`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}`
### 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 ## 5. Frontend
``` ### 5.1 Not a routed app
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 shell of managers (`Window`, `Content`, `Toast`,
`Tooltip`, `ContextMenu`) and boots: `GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open
`main_menu`; no user → `HasAdmin() ? 'login' : 'register' {firstTime:true}`. The one real URL is
`/link/authorize` (and the legacy `/discord/authorize`), which renders the service link screen instead
of the app.
There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Screens" are either: Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
`Campaign` becomes non-null. The note column shows the open notes, or the anchored map
(`ActivePane` / `AnchoredMap` / `AnchorMap` in `services/Content.js`); `viewer/map/MapViewerPane.vue`
renders it both there and in the detached `map_viewer` window. Right-clicking that map pins a campaign
note at the spot (`services/MapPins.js` translates image px ↔ screen), clicking the marker opens
`pinned_note`. Dragging an actor row out of the sidebar onto the map makes it stand on that grid cell
as a token (`services/MapTokens.js` snaps to cell centres and sizes the token by its cell); the token
drags on with the pointer, steps over the grid with the arrow keys, and Delete takes it off.
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or ### 5.2 The window system
- **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).
Boot sequence (`app.vue` → `start()`): `services/WindowDefinitions.js` is the registry (`{ title: 'i18n.key', component: () => import(...), movable, close?, back? }`)
and `services/Windows.js` the runtime: `CreateWindow(type, data)` (one instance per type),
`CreateChildWindow(parentId, ...)`, `ClearWindow({type}|{id})`, `GetWindowWithId`, `GetFirstWindowId`,
`CallWindow(id, fn, arg)`, `SetSize/SetPosition/ResetPosition(id,'center')/SetMinSize/SetMaxSize/Top`,
`getComponent(type)`, `SetupHandle(id, handleRef)`. Adding a window = registry entry + component in
`components/windows/`; copy `ExampleWindow.vue`: props `['data']` (merged window object, `props.data.id`),
and in `onMounted` call `Top(wrapper)`, `SetupHandle(id, handle)`, `SetSize`, `ResetPosition`.
``` DOM ids these services depend on — **do not rename**: `window-wrapper-{id}`, `window-handle-{id}`,
GetUser() (JWT in localStorage, un-expired)? `window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
├─ 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) ### 5.3 Services are the state layer
`app/services/WindowDefinitions.js` is the **registry**: key = window type, value = `app/services/` are plain ES modules with module-scope `ref()`s — no DI, no store, singleton by import.
`{ title: 'i18n.key', component: () => import('~/components/windows/X.vue'), movable, close?, back?, ... }`. `Server.js` (axios factory: `Server().get(...)`, interceptor adds `Authorization: Bearer <localStorage.token>`,
Adding a window = add an entry here **and** a component in `app/components/windows/`. `initApi()` from `plugins/api.ts`), `User.js` (`GetUser/SetUser/LogoutUser/HasAdmin`, `GetUserSetting`/
`SetUserSetting` server-backed in `User.settings`), `Campaign.js` (`useCampaignService()`, `SetCampaign`
writes `localStorage.selectedCampaignId`, `RestoreCampaign`), `Content.js` (§5.1), `Emitter.js`
(`mitt()` bus), `Toaster.js`, `Tooltip.js`, `ContextMenu.js`, `Sound.js` (`AddSound` binds
`snap.wav` to `.sound-click`), `Marker.js` (marked + widgets), `ActionRegistry.js` (command palette:
`register/unregister/search/execute`), `Windows.js` / `WindowDefinitions.js`, `MapPins.js`, `MapTokens.js`,
`widgets/DiceParser.js`.
`app/services/Windows.js` is the runtime. Module-level state: `windows = ref([])`, auto-incrementing ### 5.4 Markdown → widgets
`currentId`, `currentIndex` z-index counter. Key exports:
`CreateWindow(type, data)` (one instance per type — duplicates are ignored), `Marker.js` turns `@name\n…\n@end` (block), `@name[text]` (inline) and `[[target]]` (wiki link) into
`CreateChildWindow(parentId, type, data)` (child dies with parent), `ClearWindow({type}|{id})` placeholder divs/spans; `Note.vue` renders with `v-html` and then mounts each placeholder with its own
(recursive over `children`), `ClearAll()`, `GetWindowWithId(id)`, `GetFirstWindowId(type)`, `createApp(GetWidget(kind, name), {content})` (and unmounts them on re-render). So widgets are isolated
`CallWindow(id, callableName, arg)`, `SetSize/SetPosition/SetMinSize/SetMaxSize/SetResizable/ mini-apps: they get only the `content` string and must not rely on the parent app's provides/injection.
SetMovable/ResetPosition(id,'center')/SetOnTop/Top`, `getComponent(type)` (cached `defineAsyncComponent`), Register one in `widget_map` in `Marker.js`, component in `components/viewer/widgets/{inline,display}/`.
and `SetupHandle(id, handleRef)` which wires raw DOM mouse listeners for drag/resize. `DiceParser.js` evaluates `\d*d\d+` with `adv|dis|kh<N>|kl<N>`, `+ - * / ( )`, unary minus, floor
division, and returns `{total, steps[]}` that `RollWidgetDisplay.vue` draws.
Contract a window component must fulfil (copy `ExampleWindow.vue`): ### 5.5 Event bus
```vue Events in use: `toast`, `push-note`, `close-note` (removes from the open column only), `delete-note`
<script setup> (closes **and** removes from the sidebar, and drops map pins — the note's close button must not use it),
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows'; `title-updated`, `campaign-entry-created` / `campaign-entry-updated`, `note-created`, `note-renamed`,
import WindowHandle from './partials/WindowHandle.vue'; `folder-saved`, `folder-deleted`, `status-bar-update`. Payloads are API documents; the UI note shape is
const handle = ref(null), wrapper = ref(null); `{key, title, text, date}`, mapped at the boundary as `ContentSidebar.fetchCampaignNotes` does. Always
const props = defineProps(['data']); // 'data' = merged {type,id,...WindowDefinitions entry,...CreateWindow data} `import { emitter } from '~/services/Emitter'` — `composables/useEmitter.ts` is broken (§8).
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: ### 5.6 Styling, i18n
`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 `colors.scss` Sass maps (`dark`/`light`, accents `katlum`/`solus`/`silang`) become `--color-*` CSS
object, exposes `setupHandle()`, and plays `/sounds/close.wav` when closed. variables: always style with `var(--color-…)`, never hardcode hex, and add a new key to **both** maps.
`useTheme.ts` persists theme/accent and sets `data-theme`/`data-accent` on `<html>`; `app.vue` forces
`setTheme('dark')`. Icons are white SVGs with `.icon` (inverted via `--color-icon-invert`), from
`/icons/...` or the `pixelarticons` package. Fonts (`fonts.scss`, 5e-style families) and sounds
(`/sounds/*.wav`) live in `public/`.
### 5.3 Services (`app/services/`) — the state layer i18n: `frontend/i18n/locales/<lang>/<namespace>.json` for `en` (default), `es`, `ca`; `plugins/i18n.ts`
nests each file under its filename, so the key is `<file>.<path>` (`$t('windows.login')`). **Add every
Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Singleton by import. new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`.
| 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) |
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue` |
| `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 ## 6. Conventions
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/` - Backend: CommonJS; every handler `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
are thin Express routers, `models/` one Mongoose schema per file exporting `mongoose.model(...)`. - Frontend: Vue 3 `<script setup>`, PascalCase exported service functions (`CreateWindow`, `GetUser`), PascalCase component filenames, kebab-case DOM ids. Both `~/` and `@/` resolve to `app/` — use what the neighbouring file uses.
Every handler is `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`. - Components call `Server()` directly (no api layer); `await` and `.then` both appear.
Route logic helpers (like `userOwnsCampaign`) are duplicated per router file today — match that - Comments mix English and Catalan ("Moure aixo") — do not translate unrelated comments while editing.
style unless you refactor both at once. - No formatter: keep diffs minimal and local, the codebase is deliberately rough.
- **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 ## 7. Recipes
**New API resource**: add `models/X.js`, `routes/x.js` (with `userOwnsCampaign`-style ownership checks - **New API resource**: `models/X.js` + `routes/x.js` (ownership check + `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js` **after** `checkAuth` if it needs auth.
and the `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js` - **New window**: `WindowDefinitions.js` entry + `components/windows/X.vue` (§5.2) + strings in `i18n/locales/*/windows.json` (all three locales).
**after** the `checkAuth` line if it needs auth. - **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
- **New palette action**: `register({id, label, description, execute, isActive?})` from `~/services/ActionRegistry` (palette: `Ctrl/Cmd+K` or `/`).
- **New theme color**: key in *both* `dark` and `light` maps in `colors.scss`, then `var(--color-<key>)`.
**New window**: entry in `WindowDefinitions.js` → component in `app/components/windows/` following ## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
§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 1. `README.md` says run `./install.sh` / `./start.sh`; **neither exists**. `frontend/README.md` says the frontend is **React**; it is Nuxt/Vue.
`widget_map` in `Marker.js`, consume the `content` prop. 2. `services/keys.js` ships the JWT secret `"putyoursecrethere"`, used in production.
3. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not in scope → caught → the first-run registration actually returns `errors.internal`. The register UI (`RegisterWindow.vue`) drives that flow; fix carefully.
4. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id); the other `note.js` handlers and `folder.js` do check.
5. `/api/user/*` is mounted before the JWT guard: new routes there are public unless they authenticate inline (`/api/discord` is also before it, but every route there is gated by `requireBot`, the shared bot-secret header). `services/middleware.js`'s `isAdmin` is imported but applied to no route.
6. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()` and no plugin provides it — use `~/services/Emitter`.
7. App-wide CORS only whitelists `http://localhost:3000`; `.env.production` files are committed with internal hosts.
8. `Windows.js`: `getComponent` caches `defineAsyncComponent` per type for the whole process (restart the dev server if a new window misbehaves), `SetupHandle` attaches `document` mouse listeners per window and never removes them, and `ClearAll()` iterates `Object.keys(windows)` instead of `windows.value`.
9. The frontend treats the JWT as the user cache: `settings` changes need `GetUserSetting`/`SetUserSetting` round-trips, the token payload goes stale.
**New command-palette action**: `register({id,label,description,execute,isActive?})` from ## 9. Ports
`~/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 `frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` in compose,
`var(--color-<key>)`. proxying `/` → frontend, `/api/` → backend.
## 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

@@ -1,23 +1,29 @@
# Use official Node.js runtime # Use official Node.js runtime
FROM node:20-alpine FROM node:20-alpine
# pnpm is served by corepack and pinned by "packageManager" in the root package.json
RUN corepack enable
# Create app directory # Create app directory
WORKDIR /usr/src/app WORKDIR /usr/src/app
# Copy package files first (better caching) # Copy the workspace manifests first (better caching)
COPY package*.json ./ COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
COPY backend/package.json ./backend/
COPY frontend/package.json ./frontend/
COPY discord-bot/package.json ./discord-bot/
# Install dependencies # Install the production dependencies of the backend package
RUN npm ci --only=production RUN pnpm install --frozen-lockfile --prod --filter ./backend...
# Copy application source # Copy application source
COPY . . COPY backend ./backend
# Expose the app port
# EXPOSE 3000
# Environment variable # Environment variable
ENV NODE_ENV=production ENV NODE_ENV=production
# The app reads .env.production from its working directory
WORKDIR /usr/src/app/backend
# Start the application # Start the application
CMD ["node", "src/index.js"] CMD ["node", "src/index.js"]

1770
backend/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -35,6 +35,13 @@ const ActorSchema = new Schema({
ref: 'Campaign', ref: 'Campaign',
required: true required: true
}, },
// The folder this actor stands in: a Folder of the same campaign whose target is
// 'actor' (null = the root of the actor list).
folder: {
type: Schema.Types.ObjectId,
ref: 'Folder',
default: null
},
foundryActorId: { type: String }, foundryActorId: { type: String },
date: { type: Date, default: Date.now } date: { type: Date, default: Date.now }
}); });

View File

@@ -1,6 +1,12 @@
const mongoose = require('mongoose'); const mongoose = require('mongoose');
const Schema = mongoose.Schema; const Schema = mongoose.Schema;
// Which campaign list a folder belongs to. Every sidebar section files its rows into
// folders of its own, and all of them share this model: note folders are what it has
// always held, and their rows carry no target at all, so anything reading the note tree
// asks with `filterForTarget('note')` and keeps finding them.
const FOLDER_TARGETS = ['note', 'actor', 'item', 'map'];
const FolderSchema = new Schema({ const FolderSchema = new Schema({
name: { type: String, required: true }, name: { type: String, required: true },
campaign: { campaign: {
@@ -12,8 +18,46 @@ const FolderSchema = new Schema({
type: Schema.Types.ObjectId, type: Schema.Types.ObjectId,
ref: 'Folder' ref: 'Folder'
}, },
target: { type: String, enum: FOLDER_TARGETS, default: 'note' },
// The Foundry item folder this row mirrors, set by the item sync only
// (see routes/foundry-link.js).
foundryFolderId: { type: String },
color: { type: String }, color: { type: String },
date: { type: Date, default: Date.now } date: { type: Date, default: Date.now }
}); });
FolderSchema.index(
{ campaign: 1, foundryFolderId: 1 },
{ unique: true, partialFilterExpression: { foundryFolderId: { $type: 'string' } } }
);
// The sections a folder can file rows of, and whether a request names one of them.
FolderSchema.statics.isTarget = function isTarget(target) {
return FOLDER_TARGETS.includes(target);
};
// The filter matching one section's folders, to spread into a `find` along with whatever
// else the listing asks for. The notes ask for "none of the other sections" because the
// rows saved before `target` existed carry none at all and are all note folders.
FolderSchema.statics.filterForTarget = function filterForTarget(target) {
if (target === 'note') {
return { target: { $nin: FOLDER_TARGETS.filter((other) => other !== 'note') } };
}
return { target };
};
// The folder an entry of a section may stand in: `null` is the root of that list, and
// anything else has to be a folder of the same campaign *and* the same section, so a
// move never files an entry where its own list would not show it again. Answers whether
// it does — an id that is none of those says `false` rather than throwing.
FolderSchema.statics.belongsToSection = async function belongsToSection(folderId, campaignId, target) {
if (folderId === null || folderId === undefined || folderId === '') return true;
if (!mongoose.isValidObjectId(folderId)) return false;
const folder = await this
.findOne({ _id: folderId, campaign: campaignId, ...this.filterForTarget(target) })
.lean();
return Boolean(folder);
};
module.exports = mongoose.model('Folder', FolderSchema); module.exports = mongoose.model('Folder', FolderSchema);

View File

@@ -17,11 +17,24 @@ const ItemSchema = new Schema({
weight: { type: Number, min: 0 }, weight: { type: Number, min: 0 },
properties: { type: String, default: '' }, properties: { type: String, default: '' },
description: { type: String, default: '' }, description: { type: String, default: '' },
// Item icon: an uploaded filename served from /api/public, or a full URL
// (Foundry sends its own icon as one).
image: { type: String, default: '' },
// The icon Foundry last sent for this item, kept even after the user picks
// their own so Dragonroll can still offer Foundry's back.
foundryImage: { type: String, default: '' },
campaign: { campaign: {
type: Schema.Types.ObjectId, type: Schema.Types.ObjectId,
ref: 'Campaign', ref: 'Campaign',
required: true required: true
}, },
// The folder this item stands in: a Folder of the same campaign whose target is
// 'item' (null = the root of the item list).
folder: {
type: Schema.Types.ObjectId,
ref: 'Folder',
default: null
},
foundryItemId: { type: String }, foundryItemId: { type: String },
// Names Foundry uses for this item. Dragonroll may rename it, and the copies // 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 // Foundry keeps sending still have to fold into this row instead of

View File

@@ -12,11 +12,33 @@ const MapSchema = new Schema({
offsetY: { type: Number, default: 0 }, offsetY: { type: Number, default: 0 },
// Distance each grid cell stands for (feet, metres...) // Distance each grid cell stands for (feet, metres...)
scale: { type: Number, min: 0.01, default: 5 }, 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 }
}],
// Actors dragged onto the map to stand on it as tokens. x/y are image pixels of the centre of the
// token, like a pin, and the viewer keeps them snapped onto a grid cell so a token sits where the
// square it stands in is.
tokens: [{
actor: { type: Schema.Types.ObjectId, ref: 'Actor', required: true },
x: { type: Number, default: 0 },
y: { type: Number, default: 0 }
}],
campaign: { campaign: {
type: Schema.Types.ObjectId, type: Schema.Types.ObjectId,
ref: 'Campaign', ref: 'Campaign',
required: true required: true
}, },
// The folder this map stands in: a Folder of the same campaign whose target is
// 'map' (null = the root of the map list).
folder: {
type: Schema.Types.ObjectId,
ref: 'Folder',
default: null
},
date: { type: Date, default: Date.now } date: { type: Date, default: Date.now }
}); });

View File

@@ -5,12 +5,23 @@ const upload = require('../services/storage');
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor'); const Actor = require('../models/Actor');
const Folder = require('../models/Folder');
const Map = require('../models/Map');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign); return Boolean(campaign);
} }
// Folders the campaign's actors are grouped into, in the shape the sidebar groups by
// (the notes, items and maps each keep a tree of their own, see models/Folder.js).
async function actorFolders(campaignId) {
return Folder.find({ campaign: campaignId, target: 'actor' })
.select('_id name parentFolder date color')
.sort({ date: -1 })
.lean();
}
router.get('/list', async (req, res) => { router.get('/list', async (req, res) => {
try { try {
const { campaign } = req.query; const { campaign } = req.query;
@@ -18,7 +29,7 @@ router.get('/list', async (req, res) => {
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' }); if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean(); const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', actors }); res.json({ status: 'ok', actors, folders: await actorFolders(campaign) });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });
@@ -45,13 +56,22 @@ router.post('/create', async (req, res) => {
router.post('/update', async (req, res) => { router.post('/update', async (req, res) => {
try { try {
const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, proficiencies, inventory, traits, spells, image } = req.body; const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, proficiencies, inventory, traits, spells, image, folder } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' }); if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const actor = await Actor.findById(id); const actor = await Actor.findById(id);
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' }); 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 (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// `null` moves the actor to the root of the actor list, an id files it in one of
// this campaign's actor folders; anything else is refused.
if (folder !== undefined) {
if (!(await Folder.belongsToSection(folder || null, actor.campaign, 'actor'))) {
return res.json({ status: 'error', msg: 'errors.notfound' });
}
actor.folder = folder || null;
}
if (name !== undefined) actor.name = String(name).trim(); if (name !== undefined) actor.name = String(name).trim();
if (species !== undefined) actor.species = species; if (species !== undefined) actor.species = species;
if (className !== undefined) actor.className = className; if (className !== undefined) actor.className = className;
@@ -101,6 +121,11 @@ router.post('/delete', async (req, res) => {
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' }); 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 (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
await actor.deleteOne(); await actor.deleteOne();
// A token pointing at an actor that is gone would stand on the maps for nothing: drop those
// along with the actor, like the pins of a deleted note.
await Map.updateMany({ 'tokens.actor': id }, { $pull: { tokens: { actor: id } } });
res.json({ status: 'ok' }); res.json({ status: 'ok' });
} catch (err) { } catch (err) {
console.error(err); console.error(err);

View File

@@ -2,8 +2,11 @@ const express = require('express');
const router = express.Router(); const router = express.Router();
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor');
const Folder = require('../models/Folder'); const Folder = require('../models/Folder');
const Map = require('../models/Map');
const Note = require('../models/Note'); const Note = require('../models/Note');
const Item = require('../models/Item');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
@@ -12,14 +15,16 @@ async function userOwnsCampaign(campaignId, userId) {
router.get('/list', async (req, res) => { router.get('/list', async (req, res) => {
try { try {
const { campaign } = req.query; // Every sidebar section has its own folders; a request that names none means the
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' }); // notes, like every caller of this route has until the other sections got theirs.
const { campaign, target = 'note' } = req.query;
if (!campaign || !Folder.isTarget(target)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id); 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 folders = await Folder.find({ campaign }) const folders = await Folder.find({ campaign, ...Folder.filterForTarget(target) })
.select('_id name date color') .select('_id name parentFolder date color')
.sort({ date: -1 }) .sort({ date: -1 })
.lean(); .lean();
@@ -32,15 +37,16 @@ router.get('/list', async (req, res) => {
router.post('/create', async (req, res) => { router.post('/create', async (req, res) => {
try { try {
const { name, campaign } = req.body; const { name, campaign, target = 'note' } = req.body;
if (!name || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' }); if (!name || !campaign || !Folder.isTarget(target)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id); 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 newFolder = new Folder({ const newFolder = new Folder({
name: name.trim(), name: name.trim(),
campaign campaign,
target
}); });
await newFolder.save(); await newFolder.save();
res.json({ status: 'ok', folder: newFolder }); res.json({ status: 'ok', folder: newFolder });
@@ -50,6 +56,7 @@ router.post('/create', async (req, res) => {
} }
}); });
// Renaming and colouring works the same for the folders of every campaign section.
router.post('/update', async (req, res) => { router.post('/update', async (req, res) => {
try { try {
const { id, name, color } = req.body; const { id, name, color } = req.body;
@@ -85,10 +92,25 @@ router.post('/delete', async (req, res) => {
async function moveRecursive(folderId) { async function moveRecursive(folderId) {
const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean(); const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean();
// Every section files rows into a folder of its own, so each of them moves what
// stands in this one to the root of its own list instead of leaving it pointing
// at a folder that is gone.
await Note.updateMany( await Note.updateMany(
{ folder: folderId }, { folder: folderId },
{ $set: { folder: null, date: Date.now() } } { $set: { folder: null, date: Date.now() } }
); );
await Actor.updateMany(
{ folder: folderId },
{ $set: { folder: null } }
);
await Item.updateMany(
{ folder: folderId },
{ $set: { folder: null } }
);
await Map.updateMany(
{ folder: folderId },
{ $set: { folder: null } }
);
await Folder.deleteOne({ _id: folderId }); await Folder.deleteOne({ _id: folderId });
for (const sub of subfolders) { for (const sub of subfolders) {
await moveRecursive(sub._id); await moveRecursive(sub._id);

View File

@@ -6,6 +6,7 @@ const router = express.Router();
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor'); const Actor = require('../models/Actor');
const Item = require('../models/Item'); const Item = require('../models/Item');
const Folder = require('../models/Folder');
const { foundryActorToCharacter } = require('../services/actor-foundry'); const { foundryActorToCharacter } = require('../services/actor-foundry');
const { foundryItemToItemData } = require('../services/item-foundry'); const { foundryItemToItemData } = require('../services/item-foundry');
@@ -81,7 +82,7 @@ function snapshotItemSources(body) {
return sources; return sources;
} }
async function saveFoundryItem(campaign, source, fullSync = false) { async function saveFoundryItem(campaign, source, fullSync = false, folders = null) {
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120); const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
const fields = foundryItemToItemData(source || {}); const fields = foundryItemToItemData(source || {});
if (!foundryItemId || !fields) return null; if (!foundryItemId || !fields) return null;
@@ -109,22 +110,138 @@ async function saveFoundryItem(campaign, source, fullSync = false) {
item.foundryItemId = foundryItemId; item.foundryItemId = foundryItemId;
if (!fullSync || item.isNew) Object.assign(item, fields); if (!fullSync || item.isNew) Object.assign(item, fields);
// Foundry's own icon is kept on every save, not only when the edits above
// land: the item window offers it back after the user picked their own.
if (fields.image) item.foundryImage = fields.image;
if (!item.foundryNames.includes(fields.name)) { if (!item.foundryNames.includes(fields.name)) {
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES); item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
} }
// Which folder of the campaign's item tree the world says this item stands in.
// `undefined` means the push says nothing about folders — an item embedded in an
// actor, or a module that knows nothing about them — and the item stays where it
// is. The world owns the folder of its own directory, so a move it reports lands on
// a full snapshot too and wins over one a campaign made from its item list.
const folder = resolveFoundryItemFolder(source, folders);
if (folder !== undefined) item.folder = folder;
await item.save(); await item.save();
return { foundryItemId, itemId: item.id }; return { foundryItemId, itemId: item.id };
} }
async function syncFoundryItems(campaign, sources, fullSync = false) { async function syncFoundryItems(campaign, sources, fullSync = false, folders = null) {
const items = []; const items = [];
for (const source of sources) { for (const source of sources) {
const mapping = await saveFoundryItem(campaign, source, fullSync); const mapping = await saveFoundryItem(campaign, source, fullSync, folders);
if (mapping) items.push(mapping); if (mapping) items.push(mapping);
} }
return items; return items;
} }
// --- Item folders ------------------------------------------------------------
// A Foundry world groups its item directory into folders; the campaign mirrors that
// tree as Folders of target 'item' so its item list reads like the world's. Every
// push from a module that knows about folders carries the whole world tree, and
// names the folder each world item it sends stands in. Items embedded in an actor
// say nothing: the folders they carry belong to that actor's own inventory, and
// Dragonroll keeps one item per piece of gear anyway.
// The colour a pushed folder carries. `undefined` means the push says nothing about
// colours — an older module, which knows nothing about them — and the colour the
// campaign has stays; `null` is the world leaving a folder uncoloured, which takes
// the campaign's colour off along with it. Anything else is the colour to show.
function foundryFolderColor(source) {
if (source?.color === undefined) return undefined;
const color = typeof source.color === 'string' ? source.color.trim() : '';
return color || null;
}
// Parents before children, so a folder is mapped before the one nested in it.
// A folder whose parent is missing, or caught in a cycle, becomes a root.
function orderFoundryFolderSources(sources) {
const byId = new Map();
for (const source of sources) {
const id = String(source?.id || '').trim().slice(0, 120);
const name = String(source?.name || '').trim();
if (!id || !name) continue;
byId.set(id, {
id,
name,
parent: String(source?.parent || '').trim().slice(0, 120),
color: foundryFolderColor(source)
});
}
const ordered = [];
const placed = new Set();
const visiting = new Set();
function place(id) {
if (!byId.has(id) || placed.has(id) || visiting.has(id)) return;
visiting.add(id);
place(byId.get(id).parent);
visiting.delete(id);
placed.add(id);
ordered.push(byId.get(id));
}
for (const id of byId.keys()) place(id);
return ordered;
}
// The campaign folders mirroring the world's item folder tree, keyed by the Foundry
// folder id so pushing the same tree again neither doubles a folder nor loses the
// items filed in it. Rows the campaign made for its own items (no foundryFolderId)
// are left alone: the world does not know them.
async function syncFoundryItemFolders(campaign, folderSources) {
const folders = new Map();
for (const folder of await Folder.find({ campaign: campaign._id, target: 'item' })) {
if (folder.foundryFolderId) folders.set(String(folder.foundryFolderId), folder);
}
const ordered = orderFoundryFolderSources(folderSources);
const inTree = new Set(ordered.map((source) => source.id));
for (const source of ordered) {
let folder = folders.get(source.id);
if (!folder) {
folder = new Folder({
campaign: campaign._id,
target: 'item',
foundryFolderId: source.id,
name: source.name
});
}
// The world owns this tree, so unlike an item's fields a rename or a move
// lands whatever kind of push carried it: the whole tree arrives with each.
folder.name = source.name;
// Its colour is the one part of the tree the campaign colours too: what the
// world shows arrives here, and what the campaign picks travels back to the
// world with the folder list `/sync/items` answers with.
if (source.color !== undefined) folder.color = source.color;
const parent = inTree.has(source.parent) ? folders.get(source.parent) : null;
folder.parentFolder = parent ? parent._id : null;
await folder.save();
folders.set(source.id, folder);
}
// Folders the world no longer has go with it, and the items standing in them
// move to the root instead of pointing at a folder that is not there.
const staleIds = [...folders.values()]
.filter((folder) => folder.foundryFolderId && !inTree.has(String(folder.foundryFolderId)))
.map((folder) => folder._id);
if (staleIds.length) {
await Item.updateMany({ campaign: campaign._id, folder: { $in: staleIds } }, { $set: { folder: null } });
await Folder.deleteMany({ campaign: campaign._id, _id: { $in: staleIds } });
}
return folders;
}
// The folder of a pushed item: undefined when the push says nothing about folders,
// null for the root of the item directory, and the campaign folder otherwise. An
// id the tree does not know puts the item at the root rather than nowhere.
function resolveFoundryItemFolder(source, folders) {
const foundryFolderId = source?.dragonroll?.folder;
if (!folders || typeof foundryFolderId !== 'string') return undefined;
return folders.get(foundryFolderId.trim())?._id || null;
}
// Linking a world to a campaign happens through the sign-up link every service // Linking a world to a campaign happens through the sign-up link every service
// uses (routes/service-link.js); what stays here is the sync that world keeps up // uses (routes/service-link.js); what stays here is the sync that world keeps up
// with the campaign once that link has handed it its token. // with the campaign once that link has handed it its token.
@@ -160,12 +277,16 @@ router.post('/sync/snapshot', async (req, res) => {
} }
const fullSync = req.body.fullSync === true; const fullSync = req.body.fullSync === true;
// A module that knows nothing about item folders sends neither the tree
// nor the folder of an item, and then nothing here touches the folders.
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
const actors = []; const actors = [];
for (const source of actorSources || []) { for (const source of actorSources || []) {
const mapping = await saveFoundryActor(campaign, source, fullSync); const mapping = await saveFoundryActor(campaign, source, fullSync);
if (mapping) actors.push(mapping); if (mapping) actors.push(mapping);
} }
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync); const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync, itemFolders);
if (fullSync && actorSources) { if (fullSync && actorSources) {
const currentIds = actorSources const currentIds = actorSources
@@ -194,17 +315,21 @@ router.post('/sync/snapshot', async (req, res) => {
} }
}); });
// Live Foundry item edits: upserts only, never prunes. Removing items that no // Live Foundry item edits: upserts only, never prunes items. Removing items that no
// longer exist is left to the full snapshot sent with the actors. // longer exist is left to the full snapshot sent with the actors. Item folders are
// the exception: every request carries the world's whole folder tree, so a folder
// the world dropped is dropped here too, and a push may carry folders only.
router.post('/sync/item-snapshot', async (req, res) => { router.post('/sync/item-snapshot', async (req, res) => {
try { try {
const campaign = await syncCampaign(req, res); const campaign = await syncCampaign(req, res);
if (!campaign) return; if (!campaign) return;
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.items)) { if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.items)) {
return res.json({ status: 'error', msg: 'errors.missing-data' }); return res.json({ status: 'error', msg: 'errors.missing-data' });
} }
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items) }); const folders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items, false, folders) });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });
@@ -282,12 +407,20 @@ router.post('/sync/item-delete', async (req, res) => {
} }
}); });
// The item list the world reconciles against, together with the folders its rows are
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
// travel back for their colour: the world owns the tree's name and nesting, while whoever
// colours a folder on either side expects to see it coloured on the other.
router.get('/sync/items', async (req, res) => { router.get('/sync/items', async (req, res) => {
try { try {
const campaign = await syncCampaign(req, res); const campaign = await syncCampaign(req, res);
if (!campaign) return; if (!campaign) return;
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean(); const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
res.json({ status: 'ok', items }); const folders = await Folder.find({ campaign: campaign._id, target: 'item' })
.select('_id name color foundryFolderId')
.sort({ name: 1 })
.lean();
res.json({ status: 'ok', items, folders });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });

View File

@@ -1,6 +1,16 @@
const express = require('express'); const express = require('express');
const router = express.Router(); const router = express.Router();
const { requestFoundry } = require('../services/foundry'); const { requestFoundry } = require('../services/foundry');
const { normalizeIconDirectory, readIconListingPage, shapeIconListing } = require('../services/foundry-icons');
const Campaign = require('../models/Campaign');
// The world address the icons are loaded from is kept on the campaign, so an icon
// listing is always asked for one of the caller's own campaigns.
async function findOwnedCampaign(campaignId, userId) {
if (!campaignId) return null;
return Campaign.findOne({ _id: campaignId, createdBy: userId }).select('settings').lean();
}
async function proxy(path, res) { async function proxy(path, res) {
try { try {
@@ -24,4 +34,38 @@ router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURICompo
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, 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)); router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
// Foundry's core icon library: the `icons/` folder of the world's data directory.
// One folder per request, and the icons inside it paged, because that library runs
// into the thousands and the window only ever shows where the user is standing.
// The bridge reads it on the Foundry host; the images themselves are loaded by the
// browser from the campaign's world address, the same way a synced item's icon is.
router.get('/icons', async (req, res) => {
try {
const campaign = await findOwnedCampaign(req.query.campaign, req.user.id);
if (!campaign) return res.status(404).json({ status: 'error', msg: 'errors.notfound' });
const base = campaign.settings?.integrations?.foundryUrl || '';
if (!base) return res.status(400).json({ status: 'error', msg: 'foundry.errors.icons-no-world-url' });
const dir = normalizeIconDirectory(req.query.dir);
if (!dir) return res.status(400).json({ status: 'error', msg: 'errors.missing-data' });
const { limit, offset } = readIconListingPage(req.query);
const query = new URLSearchParams({ dir, offset: String(offset), limit: String(limit) });
const result = await requestFoundry(`api/icons?${query}`);
if (result.status !== 200 || result.data?.status !== 'ok') {
return res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
}
res.json({ status: 'ok', ...shapeIconListing({ base, dir, listing: result.data }) });
} catch (err) {
if (err.code === 'FOUNDRY_NOT_CONFIGURED') {
return res.status(503).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
}
console.error(err);
res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
}
});
module.exports = router; module.exports = router;

View File

@@ -1,14 +1,26 @@
const express = require('express'); const express = require('express');
const router = express.Router(); const router = express.Router();
const upload = require('../services/storage');
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Item = require('../models/Item'); const Item = require('../models/Item');
const Folder = require('../models/Folder');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign); return Boolean(campaign);
} }
// Folders the campaign's items are grouped into, in the shape the sidebar groups by
// (the world's own item folders arrive through the sync, see routes/foundry-link.js).
async function itemFolders(campaignId) {
return Folder.find({ campaign: campaignId, target: 'item' })
.select('_id name parentFolder date color')
.sort({ date: -1 })
.lean();
}
router.get('/list', async (req, res) => { router.get('/list', async (req, res) => {
try { try {
const { campaign } = req.query; const { campaign } = req.query;
@@ -16,7 +28,7 @@ router.get('/list', async (req, res) => {
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' }); if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const items = await Item.find({ campaign }).sort({ name: 1 }).lean(); const items = await Item.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', items }); res.json({ status: 'ok', items, folders: await itemFolders(campaign) });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });
@@ -44,13 +56,23 @@ router.post('/create', async (req, res) => {
router.post('/update', async (req, res) => { router.post('/update', async (req, res) => {
try { try {
const { id, name, category, rarity, quantity, weight, properties, description } = req.body; const { id, name, category, rarity, quantity, weight, properties, description, image, folder } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' }); if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const item = await Item.findById(id); const item = await Item.findById(id);
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' }); 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 (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// `null` moves the item to the root of the item list, an id files it in one of
// this campaign's item folders; anything else is refused. The linked world owns
// its own folder tree, so a move it reports later wins over one made here.
if (folder !== undefined) {
if (!(await Folder.belongsToSection(folder || null, item.campaign, 'item'))) {
return res.json({ status: 'error', msg: 'errors.notfound' });
}
item.folder = folder || null;
}
if (name !== undefined) item.name = String(name).trim(); if (name !== undefined) item.name = String(name).trim();
if (category !== undefined) item.category = category; if (category !== undefined) item.category = category;
if (rarity !== undefined) item.rarity = rarity; if (rarity !== undefined) item.rarity = rarity;
@@ -58,6 +80,7 @@ router.post('/update', async (req, res) => {
if (weight !== undefined && weight !== '') item.weight = Number(weight); if (weight !== undefined && weight !== '') item.weight = Number(weight);
if (properties !== undefined) item.properties = properties; if (properties !== undefined) item.properties = properties;
if (description !== undefined) item.description = description; if (description !== undefined) item.description = description;
if (image !== undefined) item.image = String(image);
await item.save(); await item.save();
res.json({ status: 'ok', item }); res.json({ status: 'ok', item });
@@ -67,6 +90,25 @@ router.post('/update', async (req, res) => {
} }
}); });
// Upload item image post
router.post("/upload-image", upload.single("image"), async (req, res) => {
try {
const itemId = req.query.item || req.body.item;
if (!itemId || !req.file) return res.json({ status: 'error', msg: 'errors.missing-data' });
const item = await Item.findById(itemId);
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' });
item.image = req.file.filename;
await item.save();
res.json({ status: "ok", msg: "uploaded", item });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "internal" });
}
});
router.post('/delete', async (req, res) => { router.post('/delete', async (req, res) => {
try { try {
const { id } = req.body; const { id } = req.body;

View File

@@ -5,12 +5,24 @@ const upload = require('../services/storage');
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Map = require('../models/Map'); const Map = require('../models/Map');
const Folder = require('../models/Folder');
const Note = require('../models/Note');
const Actor = require('../models/Actor');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
return Boolean(campaign); return Boolean(campaign);
} }
// Folders the campaign's maps are grouped into, in the shape the sidebar groups by
// (the notes, actors and items each keep a tree of their own, see models/Folder.js).
async function mapFolders(campaignId) {
return Folder.find({ campaign: campaignId, target: 'map' })
.select('_id name parentFolder date color')
.sort({ date: -1 })
.lean();
}
// Grid values arrive as strings when the request is a multipart form upload. // Grid values arrive as strings when the request is a multipart form upload.
function toNumber(value, fallback) { function toNumber(value, fallback) {
if (value === undefined || value === null || value === '') return fallback; if (value === undefined || value === null || value === '') return fallback;
@@ -25,7 +37,7 @@ router.get('/list', async (req, res) => {
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' }); if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean(); const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
res.json({ status: 'ok', maps }); res.json({ status: 'ok', maps, folders: await mapFolders(campaign) });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });
@@ -55,13 +67,22 @@ router.post('/create', upload.single('image'), async (req, res) => {
router.post('/update', upload.single('image'), async (req, res) => { router.post('/update', upload.single('image'), async (req, res) => {
try { try {
const { id, name, gridSize, offsetX, offsetY, scale } = req.body; const { id, name, gridSize, offsetX, offsetY, scale, folder } = req.body;
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' }); if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id); const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' }); 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 (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// `null` moves the map to the root of the map list, an id files it in one of this
// campaign's map folders; anything else is refused.
if (folder !== undefined) {
if (!(await Folder.belongsToSection(folder || null, map.campaign, 'map'))) {
return res.json({ status: 'error', msg: 'errors.notfound' });
}
map.folder = folder || null;
}
if (name !== undefined) map.name = String(name).trim(); if (name !== undefined) map.name = String(name).trim();
if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize); if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX); if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
@@ -92,4 +113,129 @@ router.post('/delete', async (req, res) => {
} }
}); });
// A pin is a note placed at a spot of the map, in image pixels, and so is the centre of a token.
// 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' });
}
});
// A token is an actor standing on the map, at the middle of a grid cell. Anywhere it is dropped in a
// cell lands it in that cell, whatever the grid is drawn from: same rounding as the viewer does while
// it drags, so the token does not jump when the move is saved.
function toCellCoordinate(value, size, offset) {
const grid = Math.max(1, Number(size) || 50);
const origin = Number(offset) || 0;
const cell = Math.floor((toCoordinate(value) - origin) / grid);
return Math.max(0, Math.round(origin + (cell + 0.5) * grid));
}
router.post('/place-token', async (req, res) => {
try {
const { id, actor, x, y } = req.body;
if (!id || !actor) 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 an actor of the same campaign can stand on one of its maps.
const actorDoc = await Actor.findOne({ _id: actor, campaign: map.campaign }).select('_id').lean();
if (!actorDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
// An actor stands on a map once: placing it again moves its token instead of adding a twin.
const token = map.tokens.find((current) => String(current.actor) === String(actor));
const spot = {
x: toCellCoordinate(x, map.gridSize, map.offsetX),
y: toCellCoordinate(y, map.gridSize, map.offsetY)
};
if (token) {
token.x = spot.x;
token.y = spot.y;
} else {
map.tokens.push({ actor, ...spot });
}
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/remove-token', async (req, res) => {
try {
const { id, token } = req.body;
if (!id || !token) 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 tokens that remain, the same way the pins are removed.
map.tokens = map.tokens
.filter((current) => String(current._id) !== String(token))
.map((current) => ({ _id: current._id, actor: current.actor, 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; module.exports = router;

View File

@@ -4,6 +4,7 @@ const router = express.Router();
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Note = require('../models/Note'); const Note = require('../models/Note');
const Folder = require('../models/Folder'); const Folder = require('../models/Folder');
const Map = require('../models/Map');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
@@ -18,7 +19,9 @@ router.get('/list', async (req, res) => {
const hasAccess = await userOwnsCampaign(campaign, req.user.id); 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 folders = await Folder.find({ campaign }) // The note tree only: the folders of the actors, items and maps share this model
// and would otherwise turn up as empty folders between the notes.
const folders = await Folder.find({ campaign, ...Folder.filterForTarget('note') })
.select('_id name parentFolder date color') .select('_id name parentFolder date color')
.sort({ date: -1 }) .sort({ date: -1 })
.lean(); .lean();
@@ -47,7 +50,7 @@ router.get('/subfolder/list', async (req, res) => {
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean(); const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' }); if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
const subfolders = await Folder.find({ campaign, parentFolder: folder }) const subfolders = await Folder.find({ campaign, parentFolder: folder, ...Folder.filterForTarget('note') })
.select('_id name date color') .select('_id name date color')
.sort({ date: -1 }) .sort({ date: -1 })
.lean(); .lean();
@@ -64,6 +67,49 @@ router.get('/subfolder/list', async (req, res) => {
} }
}); });
// 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' });
const notes = await Note.find({ campaign })
.select('_id title folder date')
.sort({ title: 1 })
.lean();
const folders = await Folder.find({ campaign, ...Folder.filterForTarget('note') })
.select('_id name parentFolder')
.lean();
res.json({ status: 'ok', notes, folders });
} 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' });
}
});
router.post('/create', async (req, res) => { router.post('/create', async (req, res) => {
try { try {
const { title, content, campaign, folder } = req.body; const { title, content, campaign, folder } = req.body;
@@ -119,6 +165,9 @@ router.post('/delete', async (req, res) => {
const result = await Note.deleteOne({ _id: id }); const result = await Note.deleteOne({ _id: id });
if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' }); 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' }); res.json({ status: 'ok' });
} catch (err) { } catch (err) {
console.error(err); console.error(err);

View File

@@ -105,7 +105,7 @@ router.post('/setup', rateLimitMiddleware, async (req, res) => {
// Login post // Login post
router.post('/login', rateLimitMiddleware, async (req, res) => { router.post('/login', rateLimitMiddleware, async (req, res) => {
const { usermail, password } = req.body; const { usermail, password, remember } = req.body;
if (!(usermail && password)) { if (!(usermail && password)) {
return res.json({ status: "error", msg: "login.errors.params" }); return res.json({ status: "error", msg: "login.errors.params" });
@@ -132,7 +132,8 @@ router.post('/login', rateLimitMiddleware, async (req, res) => {
}; };
const token = await new Promise((resolve, reject) => { const token = await new Promise((resolve, reject) => {
jwt.sign(payload, secret, { expiresIn: 172800 }, (err, token) => { // "Remember me" keeps the session alive on the device for 30 days, a plain login lasts 48 h
jwt.sign(payload, secret, { expiresIn: remember ? 2592000 : 172800 }, (err, token) => {
if (err) reject(err); if (err) reject(err);
else resolve(token); else resolve(token);
}); });
@@ -192,4 +193,113 @@ router.get('/get-settings', passport.authenticate('jwt', {session: false}), asyn
} }
}); });
// -- Account management (the "Manage accounts" window of the site settings) ----
// /api/user is mounted before the JWT guard, so every route below authenticates
// inline; and only an administrator gets past isAdmin (services/middleware.js).
router.get('/list', passport.authenticate('jwt', {session: false}), isAdmin, async (req, res) => {
try {
// No account gets out with its password or an unfinished setup code.
const users = await User.find().select('-password -setupCode').sort({ date: 1 });
res.json({ status: "ok", users });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "errors.internal" });
}
});
// The admin creates the account with the password its user logs in with; the
// setupCode flow above stays as it is, nothing on the frontend completes it.
router.post('/create', passport.authenticate('jwt', {session: false}), isAdmin, async (req, res) => {
try {
const { name, username, email, password } = req.body;
if (!(name && username && email && password)) {
return res.json({ status: "error", msg: "errors.missing-data" });
}
const existingUser = await User.findOne({
$or: [
{ email: email },
{ username: username }
]
});
if (existingUser) {
return res.json({
status: "error",
msg: "register.errors.email-username-exists"
});
}
const salt = await bcrypt.genSalt(10);
let user = new User({
name: name,
username: username,
email: email,
password: await bcrypt.hash(password, salt)
});
await user.save();
res.json({
status: "ok",
user: {
_id: user._id,
name: user.name,
username: user.username,
email: user.email,
admin: user.admin,
date: user.date
}
});
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "errors.internal" });
}
});
router.post('/set-admin', passport.authenticate('jwt', {session: false}), isAdmin, async (req, res) => {
try {
const { id, admin } = req.body;
if (!id || typeof admin !== 'boolean') {
return res.json({ status: "error", msg: "errors.missing-data" });
}
// Switching one's own rights off could leave an instance with nobody who
// can manage accounts at all, so the row for yourself stays closed.
if (String(req.user._id) === String(id)) {
return res.json({ status: "error", msg: "settings.site-administration.accounts.errors.self-admin" });
}
const user = await User.findOne({ _id: id });
if (!user) return res.json({ status: "error", msg: "errors.notfound" });
user.admin = admin;
await user.save();
res.json({ status: "ok", user: { _id: user._id, admin: user.admin } });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "errors.internal" });
}
});
// Only the account itself goes; what it created stays as it is.
router.post('/delete', passport.authenticate('jwt', {session: false}), isAdmin, async (req, res) => {
try {
const { id } = req.body;
if (!id) return res.json({ status: "error", msg: "errors.missing-data" });
// Same guard as the admin switch: nobody locks themselves out on the way out.
if (String(req.user._id) === String(id)) {
return res.json({ status: "error", msg: "settings.site-administration.accounts.errors.self-delete" });
}
const user = await User.findOne({ _id: id });
if (!user) return res.json({ status: "error", msg: "errors.notfound" });
await user.deleteOne();
res.json({ status: "ok" });
} catch (err) {
console.error(err);
res.json({ status: "error", msg: "errors.internal" });
}
});
module.exports = router; module.exports = router;

View File

@@ -1,5 +1,28 @@
const { numberOr, asText, plainText, stringList } = require('./foundry-fields'); const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
// D&D 5e keeps an actor's background, species, class and subclass as a reference to an
// embedded item: `system.details.background` and friends hold that item's id, and the
// field's `fallback` option hands back the bare id when the item is gone. Dragonroll
// holds names, so a reference is read through the actor's items and an id that resolves
// to nothing is dropped. An id travelling back as a name is how Foundry ends up with a
// background item — and a details reference — that does not exist (Syndria98/dragonroll#54).
const FOUNDRY_DOCUMENT_ID = /^[A-Za-z0-9_-]{16}$/;
function looksLikeFoundryId(value) {
// Sixteen plain letters is a name; the ids Foundry generates carry a digit.
return FOUNDRY_DOCUMENT_ID.test(value) && /[0-9]/.test(value) && /[A-Za-z]/.test(value);
}
// The name a `system.details` entry stands for: an embedded item's id resolves to that
// item's name, and plain text (older system releases store the name here) is the name.
function detailsName(value, items) {
const text = asText(value).trim();
if (!text) return '';
const referenced = items.find((item) => asText(item?._id ?? item?.id).trim() === text);
if (referenced) return asText(referenced.name).trim();
return looksLikeFoundryId(text) ? '' : text;
}
function foundryActorToCharacter(foundryActor) { function foundryActorToCharacter(foundryActor) {
const system = foundryActor.system || {}; const system = foundryActor.system || {};
const details = system.details || {}; const details = system.details || {};
@@ -25,11 +48,11 @@ function foundryActorToCharacter(foundryActor) {
type: ['character', 'npc', 'creature'].includes(savedDragonrollType) type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
? savedDragonrollType ? savedDragonrollType
: (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'), : (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'),
species: asText(details.race || details.species), species: detailsName(details.race || details.species, items),
className: asText(details.class || classItem?.name), className: detailsName(details.class, items) || asText(classItem?.name),
subclass: asText(details.subclass || subclassItem?.name), subclass: detailsName(details.subclass, items) || asText(subclassItem?.name),
level: numberOr(details.level ?? classItem?.system?.levels, 1), level: numberOr(details.level ?? classItem?.system?.levels, 1),
background: asText(details.background || backgroundItem?.name), background: detailsName(details.background, items) || asText(backgroundItem?.name),
challengeRating: String(details.cr ?? ''), challengeRating: String(details.cr ?? ''),
description: plainText(details.biography?.value || details.biography), description: plainText(details.biography?.value || details.biography),
image: asText(foundryActor.img || foundryActor.image), image: asText(foundryActor.img || foundryActor.image),

View File

@@ -0,0 +1,110 @@
// Foundry's core icon library is the `icons/` folder of its data directory: a few
// thousand images spread over its own folder tree. Dragonroll never reads that
// tree itself — the bridge on the Foundry host lists one folder per request (see
// dragonroll-foundry/bridge/server.js) — but everything that goes over the wire is
// normalised here first, so a caller cannot ask for a folder outside the icon root.
const ICON_ROOT = 'icons';
// Image formats Foundry's own file picker offers.
const ICON_EXTENSIONS = ['.svg', '.png', '.webp', '.jpg', '.jpeg', '.gif', '.avif'];
// How many icons one request lists. The window asks again for the next page, so a
// folder with hundreds of them is never sent or rendered all at once.
const DEFAULT_ICON_PAGE_SIZE = 120;
const MAX_ICON_PAGE_SIZE = 500;
// The folder a listing request asks for, inside the icon root: `icons`, `icons/svg`,
// ... Empty asks for the root. Anything that tries to leave the root is invalid.
function normalizeIconDirectory(input) {
const raw = String(input ?? '').trim().replace(/\\/g, '/').replace(/^\/+|\/+$/g, '');
if (!raw || raw === '.') return ICON_ROOT;
const segments = raw.split('/').filter((segment) => segment && segment !== '.');
if (!segments.length || segments.includes('..')) return null;
if (segments[0] !== ICON_ROOT) return null;
return segments.join('/');
}
// The folder above an icon folder, or null at the root.
function parentIconDirectory(dir) {
const normalized = normalizeIconDirectory(dir);
if (!normalized || normalized === ICON_ROOT) return null;
return normalized.slice(0, normalized.lastIndexOf('/'));
}
function iconName(filePath) {
const path = String(filePath ?? '');
return path.slice(path.lastIndexOf('/') + 1);
}
function isIconFile(filePath) {
const lower = String(filePath ?? '').toLowerCase();
return ICON_EXTENSIONS.some((extension) => lower.endsWith(extension));
}
// Where the browser loads a Foundry data file from: Foundry serves its data
// directory over the world's own address, which is the one the campaign keeps
// (settings.integrations.foundryUrl). Items store icons as these absolute URLs,
// the same way a synced Foundry item's icon arrives as one.
function joinFoundryAssetUrl(baseUrl, filePath) {
const base = String(baseUrl ?? '').trim();
const file = String(filePath ?? '').trim().replace(/^\/+/, '');
if (!base || !file) return '';
return `${base.replace(/\/+$/, '')}/${encodeURI(file)}`;
}
// The page a request asks for. Directories are always listed whole — the window
// needs every subfolder to navigate — so paging only ever covers the icons.
function readIconListingPage(query) {
const requestedLimit = Number(query?.limit);
const limit = Number.isFinite(requestedLimit)
? Math.min(MAX_ICON_PAGE_SIZE, Math.max(1, Math.trunc(requestedLimit)))
: DEFAULT_ICON_PAGE_SIZE;
const requestedOffset = Number(query?.offset);
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
return { limit, offset };
}
// The bridge answers with plain relative paths; this is the shape the icon window
// works with: the folder it shows, the one above it, its subfolders, and its icons
// with a url to load. `next` is the offset of the next page, null once it is all
// listed, which is what keeps a big library lazy to load.
function shapeIconListing({ base = '', dir, listing = {} } = {}) {
const current = normalizeIconDirectory(dir ?? listing.dir) || ICON_ROOT;
const folders = [];
const seenFolders = new Set();
for (const entry of Array.isArray(listing.directories) ? listing.directories : []) {
const path = normalizeIconDirectory(typeof entry === 'string' ? entry : entry?.path);
if (!path || path === current || seenFolders.has(path)) continue;
seenFolders.add(path);
folders.push({ path, name: iconName(path) });
}
const files = (Array.isArray(listing.files) ? listing.files : [])
.map((entry) => String(typeof entry === 'string' ? entry : entry?.path ?? '').trim().replace(/^\/+/, ''))
.filter((entry) => entry.startsWith(`${ICON_ROOT}/`) && isIconFile(entry))
.map((entry) => ({ path: entry, name: iconName(entry), url: joinFoundryAssetUrl(base, entry) }));
const offset = Number.isFinite(Number(listing.offset)) ? Math.max(0, Math.trunc(Number(listing.offset))) : 0;
const next = Number.isFinite(Number(listing.next)) && Number(listing.next) > offset
? Math.trunc(Number(listing.next))
: null;
return { dir: current, parent: parentIconDirectory(current), folders, files, offset, next };
}
module.exports = {
ICON_ROOT,
ICON_EXTENSIONS,
DEFAULT_ICON_PAGE_SIZE,
MAX_ICON_PAGE_SIZE,
normalizeIconDirectory,
parentIconDirectory,
iconName,
isIconFile,
joinFoundryAssetUrl,
readIconListingPage,
shapeIconListing
};

View File

@@ -101,7 +101,9 @@ function foundryItemToItemData(foundryItem) {
quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))), quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))),
weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)), weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)),
properties: foundryItemProperties(foundryItem), properties: foundryItemProperties(foundryItem),
description: plainText(system.description?.value ?? system.description) description: plainText(system.description?.value ?? system.description),
// The module sends Foundry's icon as an absolute URL, like actors do.
image: asText(foundryItem.img || foundryItem.image)
}; };
} }

View File

@@ -1,21 +1,30 @@
# Use official Node.js runtime # Use official Node.js runtime
FROM node:20-alpine FROM node:20-alpine
# pnpm is served by corepack and pinned by "packageManager" in the root package.json
RUN corepack enable
# Create app directory # Create app directory
WORKDIR /usr/src/app WORKDIR /usr/src/app
# Copy package files first (better caching) # Copy the workspace manifests first (better caching)
COPY package*.json ./ COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
COPY backend/package.json ./backend/
COPY frontend/package.json ./frontend/
COPY discord-bot/package.json ./discord-bot/
# Install dependencies # Install the production dependencies of the bot package
RUN npm ci --only=production RUN pnpm install --frozen-lockfile --prod --filter ./discord-bot...
# Copy application source # Copy application source
COPY . . COPY discord-bot ./discord-bot
# Environment variable # Environment variable
ENV NODE_ENV=production ENV NODE_ENV=production
# The bot reads .env from its working directory
WORKDIR /usr/src/app/discord-bot
# The bot only makes outbound connections (Discord gateway + Dragonroll API), # The bot only makes outbound connections (Discord gateway + Dragonroll API),
# it does not listen on a port. # it does not listen on a port.
# Start the application # Start the application

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

@@ -96,6 +96,10 @@ The campaign's Item list is synchronized with the world's gear, both ways:
properties, description). An item made by hand in Dragonroll is created in the world's item 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 directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
document. document.
- The folders grouping the world's item directory arrive in the campaign as its own item folders, tree
and nesting included, and the items are filed in them. A folder's **colour** goes the other way too:
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is - 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 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 Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's
@@ -110,14 +114,15 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only | | `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
| `POST /api/foundry/sync/item-delete` | A world item was deleted | | `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/characters` | Characters to apply back in Foundry |
| `GET /api/foundry/sync/items` | Items to apply back in Foundry | | `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status | | `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/map` / `map-item` | Store an id mapping after creating a document |
| `POST /api/foundry/sync/delete` | An actor was deleted | | `POST /api/foundry/sync/delete` | An actor was deleted |
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId` 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 flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
the write is not echoed back. the write is not echoed back. A folder colour is written with that folder held in the client's set of
folders being synced, for the same reason.
## 2. Run the bridge on the Foundry host ## 2. Run the bridge on the Foundry host
@@ -130,6 +135,9 @@ export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publi
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com' export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0' export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
export DRAGONROLL_FOUNDRY_PORT='8787' export DRAGONROLL_FOUNDRY_PORT='8787'
# Optional: the Foundry Data directory. With it the bridge can list the core
# `icons/` library Dragonroll's item icon browser shows.
export DRAGONROLL_FOUNDRY_DATA_PATH='/home/foundry/Foundry Data'
npm start --prefix foundry/bridge npm start --prefix foundry/bridge
``` ```
@@ -165,6 +173,7 @@ The backend exposes these JWT-protected routes when the optional snapshot bridge
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor | | `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
| `GET /api/foundry/items` | World-level items | | `GET /api/foundry/items` | World-level items |
| `GET /api/foundry/items/:id` | One world-level item | | `GET /api/foundry/items/:id` | One world-level item |
| `GET /api/foundry/icons?campaign=&dir=&offset=` | One folder of Foundry's core icon library |
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require 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, `Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
@@ -172,6 +181,13 @@ ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when th
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a 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. configured GM client has published its first snapshot.
The icon library is the one route that reads the disk instead of the snapshot: with
`DRAGONROLL_FOUNDRY_DATA_PATH` set, `GET /api/icons?dir=icons/svg&offset=120&limit=120` answers one
folder at a time — `{ status: "ok", dir, directories, files, offset, next }` of paths relative to the
data directory — and never reads outside `icons/`. `next` is the offset of the next page of icons, or
null once the folder is listed, which is how the campaign's icon browser keeps a library of thousands
lazy to load. Without that variable the route answers `503 foundry.errors.icons-unavailable`.
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded 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 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. does not create or update Foundry documents, and it does not persist the bridge cache across restarts.

View File

@@ -1,4 +1,6 @@
const http = require("node:http"); const http = require("node:http");
const fs = require("node:fs");
const path = require("node:path");
const { timingSafeEqual } = require("node:crypto"); const { timingSafeEqual } = require("node:crypto");
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0"; const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
@@ -12,6 +14,9 @@ const allowedOrigins = new Set(
.filter(Boolean), .filter(Boolean),
); );
const maxBodySize = 50 * 1024 * 1024; const maxBodySize = 50 * 1024 * 1024;
// The Foundry Data directory, for listing the core `icons/` library. Optional:
// without it the bridge simply cannot answer icon listing requests.
const dataPath = (process.env.DRAGONROLL_FOUNDRY_DATA_PATH || "").trim();
if (!readToken || !pushToken) { if (!readToken || !pushToken) {
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge."); throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
@@ -106,6 +111,80 @@ function decodePathSegment(segment) {
} }
} }
// --- Core icon library -----------------------------------------------------
// Foundry keeps the icons it ships in the `icons/` folder of its data directory:
// thousands of images over a folder tree of their own. The campaign's icon window
// browses that tree, so the bridge lists one folder per request and pages the
// icons inside it. It never reads outside `icons/`.
const iconRoot = "icons";
const iconExtensions = new Set([".svg", ".png", ".webp", ".jpg", ".jpeg", ".gif", ".avif"]);
const defaultIconPageSize = 120;
const maxIconPageSize = 500;
function normalizeIconDirectory(input) {
const raw = String(input ?? "").trim().replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
if (!raw || raw === ".") return iconRoot;
const segments = raw.split("/").filter((segment) => segment && segment !== ".");
if (!segments.length || segments.includes("..") || segments[0] !== iconRoot) return null;
return segments.join("/");
}
function readIconDirectory(dir, offset, limit) {
const root = path.resolve(dataPath, iconRoot);
const target = path.resolve(dataPath, dir);
if (target !== root && !target.startsWith(root + path.sep)) return null;
const directories = [];
const files = [];
for (const entry of fs.readdirSync(target, { withFileTypes: true })) {
const entryPath = path.posix.join(dir, entry.name);
if (entry.isDirectory()) directories.push(entryPath);
else if (entry.isFile() && iconExtensions.has(path.extname(entry.name).toLowerCase())) files.push(entryPath);
}
directories.sort((a, b) => a.localeCompare(b));
files.sort((a, b) => a.localeCompare(b));
const page = files.slice(offset, offset + limit);
return {
// Subfolders always come back whole: the window needs every one of them to
// navigate, and there are never many. Paging covers the icons.
directories,
files: page,
offset,
next: offset + page.length < files.length ? offset + page.length : null,
};
}
function sendIconListing(request, response) {
if (!dataPath) return sendJson(response, 503, { status: "error", msg: "foundry.errors.icons-unavailable" });
const params = new URL(request.url, "http://localhost").searchParams;
const dir = normalizeIconDirectory(params.get("dir"));
if (!dir) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
const requestedLimit = Number(params.get("limit"));
const limit = Number.isFinite(requestedLimit)
? Math.min(maxIconPageSize, Math.max(1, Math.trunc(requestedLimit)))
: defaultIconPageSize;
const requestedOffset = Number(params.get("offset"));
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
try {
const listing = readIconDirectory(dir, offset, limit);
if (!listing) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
sendJson(response, 200, { status: "ok", dir, ...listing });
} catch (error) {
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
return;
}
console.error(`Could not list the Foundry icon folder ${dir}.`, error);
sendJson(response, 500, { status: "error", msg: "foundry.errors.icons-unavailable" });
}
}
const server = http.createServer(async (request, response) => { const server = http.createServer(async (request, response) => {
if (!setCorsHeaders(request, response)) { if (!setCorsHeaders(request, response)) {
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" }); sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
@@ -188,6 +267,10 @@ const server = http.createServer(async (request, response) => {
return; return;
} }
// The icon library is on disk, not in the world snapshot, so it answers whether
// or not a GM client has published one yet.
if (pathname === "/api/icons") return sendIconListing(request, response);
const current = currentSnapshot(response); const current = currentSnapshot(response);
if (!current) return; if (!current) return;

View File

@@ -30,7 +30,10 @@ const queuedActorChanges = new Map();
let itemSyncTimeout; let itemSyncTimeout;
let itemSyncRunning = false; let itemSyncRunning = false;
let itemSyncErrorLogged = false; let itemSyncErrorLogged = false;
let folderSyncTimeout;
let folderSyncRunning = false;
const syncingItemIds = new Set(); const syncingItemIds = new Set();
const syncingFolderIds = new Set();
const queuedItemChanges = new Map(); const queuedItemChanges = new Map();
function getCollectionContents(collection, collectionName) { function getCollectionContents(collection, collectionName) {
@@ -436,6 +439,7 @@ function handleAutoSyncChange(value) {
if (value === false) { if (value === false) {
clearTimeout(actorSyncTimeout); clearTimeout(actorSyncTimeout);
clearTimeout(itemSyncTimeout); clearTimeout(itemSyncTimeout);
clearTimeout(folderSyncTimeout);
return; return;
} }
if (!game.user?.isGM || !getSyncToken()) return; if (!game.user?.isGM || !getSyncToken()) return;
@@ -444,6 +448,7 @@ function handleAutoSyncChange(value) {
// while autosync was off are pushed so this world's state wins over them. // while autosync was off are pushed so this world's state wins over them.
initializeCharacterSync(); initializeCharacterSync();
reconcileDragonrollItems(); reconcileDragonrollItems();
queueFoundryItemFolders(400);
if (queuedActorChanges.size) { if (queuedActorChanges.size) {
clearTimeout(actorSyncTimeout); clearTimeout(actorSyncTimeout);
actorSyncTimeout = setTimeout(flushActorChanges, 400); actorSyncTimeout = setTimeout(flushActorChanges, 400);
@@ -461,7 +466,9 @@ function dragonrollActorId(actor) {
function serializeFoundryActor(actor) { function serializeFoundryActor(actor) {
const data = { const data = {
...toPlainData(actor), ...toPlainData(actor),
items: actor.items?.contents?.map(toPlainData) || [], // Embedded items go through serializeFoundryItem so their icons become
// absolute URLs too: Dragonroll renders them outside of Foundry.
items: (actor.items?.contents?.map(serializeFoundryItem) || []).filter(Boolean),
}; };
if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) { if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
data.img = new URL(data.img, window.location.origin).toString(); data.img = new URL(data.img, window.location.origin).toString();
@@ -525,6 +532,8 @@ async function pushFoundryActors(actors, fullSync = false) {
// Dragonroll deduplicates by name, so sending the world directory next to // Dragonroll deduplicates by name, so sending the world directory next to
// the actor copies keeps a single Item per piece of gear. // the actor copies keeps a single Item per piece of gear.
items: getWorldItemSnapshots(), items: getWorldItemSnapshots(),
// The folder tree those world items stand in (see worldItemFolderSnapshots).
folders: worldItemFolderSnapshots(),
fullSync, fullSync,
}, token); }, token);
@@ -642,8 +651,102 @@ function serializeFoundryItem(item) {
return data; return data;
} }
// --- Item folders ------------------------------------------------------------
// Dragonroll mirrors the folders the world's item directory is grouped into, so its
// item list reads like Foundry's. `game.folders` also holds the folders an actor
// keeps for its own inventory: those hang off the actor instead of the world, and
// the campaign has no use for them, so only folders rooted in the world go over.
// The folder a folder is nested in, or null when it is not nested in a folder.
function itemFolderParent(folder) {
const parent = typeof folder.parent === "string" ? game.folders?.get(folder.parent) : folder.parent;
return parent?.documentName === "Folder" ? parent : null;
}
// Whether a folder belongs to the world's item directory: its whole ancestry has
// to be folders, ending in one that nothing is above.
function isWorldItemFolder(folder, seen = new Set()) {
if (folder.type !== "Item" || seen.has(folder.id)) return false;
seen.add(folder.id);
const rawParent = folder.parent;
const rawParentId = typeof rawParent === "string" ? rawParent : rawParent?.id;
if (!rawParentId) return true;
const parent = typeof rawParent === "string" ? game.folders?.get(rawParentId) : rawParent;
if (parent?.documentName !== "Folder") return false;
return isWorldItemFolder(parent, seen);
}
// A Foundry folder's colour, or null for one the GM left uncoloured. Null travels as null:
// it tells Dragonroll to take a colour off the folder it was given before, whereas a module
// that says nothing about colours at all leaves the campaign's own choice alone.
function itemFolderColor(folder) {
const color = typeof folder?.color === "string" ? folder.color.trim() : "";
return color || null;
}
function worldItemFolderSnapshots() {
return (game.folders?.contents || [])
.filter((folder) => isWorldItemFolder(folder))
.map((folder) => ({
id: folder.id,
name: folder.name,
parent: itemFolderParent(folder)?.id || null,
color: itemFolderColor(folder),
}));
}
// A world item travels with the folder it stands in, so Dragonroll can file it the
// same way; `""` says the world keeps it at the root of the item directory. Items
// embedded in an actor use serializeFoundryItem instead: their folders are the
// actor's own, and the campaign's item list is deduplicated by name anyway.
function serializeFoundryWorldItem(item) {
const data = serializeFoundryItem(item);
if (!data) return null;
data.dragonroll = { ...data.dragonroll, folder: worldItemFolderId(item) };
return data;
}
// The folder id an item data carries is either the id or the Folder document
// itself, depending on the Foundry version.
function worldItemFolderId(item) {
const folder = item?.folder;
if (!folder) return "";
if (typeof folder === "string") return game.folders?.get(folder)?.documentName === "Folder" ? folder : "";
return folder.documentName === "Folder" ? String(folder.id || "") : "";
}
function getWorldItemSnapshots() { function getWorldItemSnapshots() {
return (game.items?.contents || []).map(serializeFoundryItem).filter(Boolean); return (game.items?.contents || []).map(serializeFoundryWorldItem).filter(Boolean);
}
// --- Folder colours ----------------------------------------------------------
// Colouring a folder is the one thing about the tree the campaign gets to do on its
// own: the world owns what the folders are called and how they nest, and Dragonroll
// owns the colour its user picks for one. So the colour travels back with the folder
// list the item reconcile reads, and lands on the world's folder — marked, like every
// Dragonroll write, so the world does not echo it straight back to the campaign.
async function withFolderSyncSuppressed(folder, callback) {
if (!folder?.id) return callback();
syncingFolderIds.add(folder.id);
try {
return await callback();
} finally {
syncingFolderIds.delete(folder.id);
}
}
async function applyDragonrollFolderColors(entries) {
for (const entry of entries || []) {
const folder = entry?.foundryFolderId ? game.folders?.get(entry.foundryFolderId) : null;
// Only the world's item directories: a Dragonroll folder the world has no document
// for is the campaign's business alone, and making one there is not ours to do.
if (!folder || folder.documentName !== "Folder" || !isWorldItemFolder(folder)) continue;
const color = entry.color || null;
if (itemFolderColor(folder) === color) continue;
await withFolderSyncSuppressed(folder, () => folder.update({ color }));
}
} }
function dragonrollItemIdOf(item) { function dragonrollItemIdOf(item) {
@@ -691,7 +794,10 @@ async function pushFoundryItems(items) {
const result = await postDragonroll("foundry/sync/item-snapshot", { const result = await postDragonroll("foundry/sync/item-snapshot", {
worldId: game.world.id, worldId: game.world.id,
items: items.map(serializeFoundryItem).filter(Boolean), items: items.map(serializeFoundryWorldItem).filter(Boolean),
// The folder tree goes along, so an item that moved into or out of a folder
// arrives with the folder it names.
folders: worldItemFolderSnapshots(),
}, token); }, token);
await rememberItemMappings(result.items); await rememberItemMappings(result.items);
itemSyncErrorLogged = false; itemSyncErrorLogged = false;
@@ -715,6 +821,34 @@ function queueFoundryItemChange(kind, item) {
itemSyncTimeout = setTimeout(flushItemChanges, 400); itemSyncTimeout = setTimeout(flushItemChanges, 400);
} }
// A folder the GM made, renamed or nested has to reach the campaign even though no
// item changed, so the tree goes over on its own without pushing the items in it.
function queueFoundryItemFolders(delay = 400) {
clearTimeout(folderSyncTimeout);
folderSyncTimeout = setTimeout(pushFoundryItemFolders, delay);
}
async function pushFoundryItemFolders() {
// Autosync off: folder changes wait, like the item edits do.
if (!isAutoSyncEnabled()) return;
const token = getSyncToken();
if (!token || !game.user?.isGM || !game.world || folderSyncRunning) return;
folderSyncRunning = true;
try {
await postDragonroll("foundry/sync/item-snapshot", {
worldId: game.world.id,
items: [],
folders: worldItemFolderSnapshots(),
}, token);
itemSyncErrorLogged = false;
} catch (error) {
reportItemSyncError(error);
queueFoundryItemFolders(5000);
} finally {
folderSyncRunning = false;
}
}
async function flushItemChanges() { async function flushItemChanges() {
// Autosync off: the queued edits wait here, like the actor changes do. // Autosync off: the queued edits wait here, like the actor changes do.
if (!isAutoSyncEnabled()) return; if (!isAutoSyncEnabled()) return;
@@ -760,6 +894,7 @@ function makeFoundryItemData(entry) {
const data = { const data = {
name: String(entry.name || "").trim(), name: String(entry.name || "").trim(),
type, type,
img: getDragonrollImageUrl(entry.image) || undefined,
system: { system: {
quantity: Number(entry.quantity) || 1, quantity: Number(entry.quantity) || 1,
weight: Number(entry.weight) || 0, weight: Number(entry.weight) || 0,
@@ -773,13 +908,18 @@ function makeFoundryItemData(entry) {
} }
function foundryItemUpdateData(entry) { function foundryItemUpdateData(entry) {
return { const updates = {
name: String(entry.name || "").trim(), name: String(entry.name || "").trim(),
"system.quantity": Number(entry.quantity) || 1, "system.quantity": Number(entry.quantity) || 1,
"system.weight": Number(entry.weight) || 0, "system.weight": Number(entry.weight) || 0,
"system.rarity": RARITY_TO_FOUNDRY_VALUE[entry.rarity] || "common", "system.rarity": RARITY_TO_FOUNDRY_VALUE[entry.rarity] || "common",
"system.description.value": entry.description || "", "system.description.value": entry.description || "",
}; };
// An icon the campaign picked in Dragonroll travels back to Foundry; no icon
// there means leave the world's own choice alone, not erase it.
const image = getDragonrollImageUrl(entry.image);
if (image) updates.img = image;
return updates;
} }
async function applyDragonrollItem(item, entry) { async function applyDragonrollItem(item, entry) {
@@ -819,10 +959,13 @@ async function reconcileDragonrollItems() {
if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return; if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return;
itemSyncRunning = true; itemSyncRunning = true;
try { try {
const result = await getDragonroll("foundry/sync/items", token);
// The folder colours are applied first, and whatever system this world runs: a
// colour is the same on every one of them, while writing an item is what needs D&D 5e.
await applyDragonrollFolderColors(result.folders);
if (game.system.id !== "dnd5e") { if (game.system.id !== "dnd5e") {
throw new Error("Item sync currently requires the D&D 5e Foundry system."); throw new Error("Item sync currently requires the D&D 5e Foundry system.");
} }
const result = await getDragonroll("foundry/sync/items", token);
const remoteItems = result.items || []; const remoteItems = result.items || [];
const remoteById = new Map(remoteItems.map((entry) => [String(entry._id), entry])); const remoteById = new Map(remoteItems.map((entry) => [String(entry._id), entry]));
const localByRemoteId = new Map(game.items.contents const localByRemoteId = new Map(game.items.contents
@@ -903,10 +1046,10 @@ function makeFoundryCharacterData(entry) {
type: entry.type === "character" ? "character" : "npc", type: entry.type === "character" ? "character" : "npc",
img: getDragonrollImageUrl(entry.image) || undefined, img: getDragonrollImageUrl(entry.image) || undefined,
system: { system: {
// `details.race` and `details.background` are left out on purpose: they reference
// embedded items and are linked once the actor stands with its items made.
details: { details: {
race: entry.species || "",
level: Number(entry.level) || 1, level: Number(entry.level) || 1,
background: entry.background || "",
biography: { value: entry.description || "" }, biography: { value: entry.description || "" },
cr: entry.challengeRating || "", cr: entry.challengeRating || "",
}, },
@@ -939,9 +1082,7 @@ function characterUpdateData(entry) {
const updates = { const updates = {
name: entry.name, name: entry.name,
img: getDragonrollImageUrl(entry.image) || "icons/svg/mystery-man.svg", img: getDragonrollImageUrl(entry.image) || "icons/svg/mystery-man.svg",
"system.details.race": entry.species || "",
"system.details.level": Number(entry.level) || 1, "system.details.level": Number(entry.level) || 1,
"system.details.background": entry.background || "",
"system.details.biography.value": entry.description || "", "system.details.biography.value": entry.description || "",
"system.details.cr": entry.challengeRating || "", "system.details.cr": entry.challengeRating || "",
[`flags.${MODULE_ID}.traits`]: entry.traits || "", [`flags.${MODULE_ID}.traits`]: entry.traits || "",
@@ -955,6 +1096,40 @@ function characterUpdateData(entry) {
return updates; return updates;
} }
// `system.details.background` and `system.details.race` are LocalDocumentFields in
// D&D 5e: they hold the id of an item embedded in the actor, never its name. A name
// written into one is a reference that resolves to nothing, and adding that item in
// Foundry then fails, so each of these follows the actor's own item for it instead.
const EMBEDDED_DETAILS = [
// Dragonroll owns the background item it lists, so its reference follows it always and
// a background taken off in the campaign leaves no reference behind.
{ field: "background", path: "system.details.background", types: ["background"], clearWhenMissing: true },
// The species item belongs to the world: point at it when it carries the name, and
// leave the reference to the GM when it does not.
{ field: "species", path: "system.details.race", types: ["race", "species"] },
];
function localDocumentId(value) {
// The field resolves to the referenced document when it can and to the stored id
// when the document is gone (its `fallback` option).
if (typeof value === "string") return value;
return value?._id || "";
}
function embeddedDetailReferenceData(actor, entry) {
const updates = {};
for (const detail of EMBEDDED_DETAILS) {
const wanted = String(entry[detail.field] || "").trim();
const item = wanted
? actor.items?.contents?.find((candidate) => detail.types.includes(candidate.type) && candidate.name === wanted)
: null;
const reference = item?.id || "";
if (!reference && !detail.clearWhenMissing) continue;
if (localDocumentId(documentValue(actor, detail.path)) !== reference) updates[detail.path] = reference;
}
return updates;
}
async function reconcileEmbeddedItems(actor, entry) { async function reconcileEmbeddedItems(actor, entry) {
const desired = []; const desired = [];
if (entry.className) desired.push({ type: "class", name: entry.className, system: { levels: Number(entry.level) || 1 } }); if (entry.className) desired.push({ type: "class", name: entry.className, system: { levels: Number(entry.level) || 1 } });
@@ -1013,6 +1188,9 @@ async function applyDragonrollCharacter(actor, entry) {
await withActorSyncSuppressed(actor, async () => { await withActorSyncSuppressed(actor, async () => {
if (changed) await actor.update(updates); if (changed) await actor.update(updates);
await reconcileEmbeddedItems(actor, entry); await reconcileEmbeddedItems(actor, entry);
// The item references are written after the reconcile that makes the items they point at.
const references = embeddedDetailReferenceData(actor, entry);
if (Object.keys(references).length) await actor.update(references);
if (dragonrollActorId(actor) !== String(entry._id) if (dragonrollActorId(actor) !== String(entry._id)
|| actor.getFlag?.(MODULE_ID, "actorType") !== entry.type) { || actor.getFlag?.(MODULE_ID, "actorType") !== entry.type) {
await actor.update({ await actor.update({
@@ -1040,7 +1218,12 @@ async function createFoundryCharacter(entry) {
if (!actor) return; if (!actor) return;
await withActorSyncSuppressed(actor, async () => { await withActorSyncSuppressed(actor, async () => {
await actor.update({ [`flags.${MODULE_ID}.syncMutation`]: false }); await actor.update({
// The actor was made with its items, so its background and species references
// can point at them right away.
...embeddedDetailReferenceData(actor, entry),
[`flags.${MODULE_ID}.syncMutation`]: false,
});
}); });
await mapDragonrollActor(entry._id, actor.id); await mapDragonrollActor(entry._id, actor.id);
} }
@@ -1198,6 +1381,7 @@ Hooks.once("ready", () => {
for (const event of [ for (const event of [
"createActor", "updateActor", "deleteActor", "createActor", "updateActor", "deleteActor",
"createItem", "updateItem", "deleteItem", "createItem", "updateItem", "deleteItem",
"createFolder", "updateFolder", "deleteFolder",
]) { ]) {
Hooks.on(event, (document) => { Hooks.on(event, (document) => {
scheduleSnapshotSync(); scheduleSnapshotSync();
@@ -1207,6 +1391,14 @@ Hooks.once("ready", () => {
queueFoundryActorChange(isDelete ? "delete" : "upsert", document); queueFoundryActorChange(isDelete ? "delete" : "upsert", document);
return; return;
} }
// An item folder the GM made, renamed or nested changes the tree the campaign
// mirrors; nothing about the items themselves changed, so only the tree goes.
// A colour Dragonroll has just written into the folder is not the GM changing it.
if (document.documentName === "Folder") {
if (syncingFolderIds.has(document.id)) return;
if (document.type === "Item" && isWorldItemFolder(document)) queueFoundryItemFolders();
return;
}
if (document.documentName !== "Item") return; if (document.documentName !== "Item") return;
// Items embedded in an actor travel with that actor's snapshot: adding or // Items embedded in an actor travel with that actor's snapshot: adding or

View File

@@ -1,22 +0,0 @@
module.exports = {
apps: [
{
name: "backend",
cwd: "./backend",
script: "npm",
args: "start",
env: {
NODE_ENV: "production"
}
},
{
name: "frontend",
cwd: "./frontend",
script: "npm",
args: "start",
env: {
NODE_ENV: "production"
}
}
]
};

View File

@@ -1,6 +1,9 @@
# ---------- Build Stage ---------- # ---------- Build Stage ----------
FROM node:20-alpine AS builder FROM node:20-alpine AS builder
# pnpm is served by corepack and pinned by "packageManager" in the root package.json
RUN corepack enable
ARG NUXT_PUBLIC_GIT_COMMIT ARG NUXT_PUBLIC_GIT_COMMIT
ARG NUXT_PUBLIC_GIT_TAG ARG NUXT_PUBLIC_GIT_TAG
ARG NUXT_PUBLIC_GIT_BRANCH ARG NUXT_PUBLIC_GIT_BRANCH
@@ -11,18 +14,21 @@ ENV NUXT_PUBLIC_GIT_BRANCH=$NUXT_PUBLIC_GIT_BRANCH
WORKDIR /app WORKDIR /app
# Copy package files # Copy the workspace manifests (pnpm needs every package.json of the workspace)
COPY package*.json ./ COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
COPY backend/package.json ./backend/
COPY frontend/package.json ./frontend/
COPY discord-bot/package.json ./discord-bot/
# Install dependencies # Install the dependencies of the frontend package
RUN npm install RUN pnpm install --frozen-lockfile --filter ./frontend...
# Copy project files # Copy project files
ARG CACHEBUST=1 ARG CACHEBUST=1
COPY . . COPY frontend ./frontend
# Build the Nuxt app # Build the Nuxt app
RUN npm run build RUN pnpm --filter ./frontend run build
# ---------- Production Stage ---------- # ---------- Production Stage ----------
FROM node:20-alpine FROM node:20-alpine
@@ -30,7 +36,7 @@ FROM node:20-alpine
WORKDIR /app WORKDIR /app
# Copy built output # Copy built output
COPY --from=builder /app/.output ./.output COPY --from=builder /app/frontend/.output ./.output
# Expose Nuxt port # Expose Nuxt port
EXPOSE 3000 EXPOSE 3000

View File

@@ -5,9 +5,13 @@ import { useI18n } from 'vue-i18n';
import { useCampaignService } from '~/services/Campaign.js'; import { useCampaignService } from '~/services/Campaign.js';
import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js'; import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import Server from '~/services/Server'; import { BuildColorMenu } from '~/services/EntryColors';
import { BuildItemRows } from '~/services/ItemFolders';
import Server, { getBaseUrl } from '~/services/Server';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows'; import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu'; import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import { ACTOR_DRAG_TYPE } from '~/services/MapTokens';
import EntryFolderRow from './EntryFolderRow.vue';
import NestedNoteList from './NestedNoteList.vue'; import NestedNoteList from './NestedNoteList.vue';
const { Campaign } = useCampaignService(); const { Campaign } = useCampaignService();
@@ -18,6 +22,11 @@ const actors = ref([]);
const items = ref([]); const items = ref([]);
const maps = ref([]); const maps = ref([]);
const entryLists = { actor: actors, item: items, map: maps }; const entryLists = { actor: actors, item: items, map: maps };
// Every sidebar section files its rows into folders of its own (see models/Folder.js), so
// each entry list keeps the tree `/actor|item|map/list` sends along. Folders are open by
// default: a folder synced from Foundry should show what stands in it, not hide it.
const entryFolders = { actor: ref([]), item: ref([]), map: ref([]) };
const collapsedFolderIds = ref([]);
const loadingNotes = ref(false); const loadingNotes = ref(false);
const loadingEntries = ref(false); const loadingEntries = ref(false);
const notesError = ref(''); const notesError = ref('');
@@ -26,7 +35,6 @@ const sidebarCollapsed = ref(false);
const activeSection = ref('notes'); const activeSection = ref('notes');
const isDragOverSidebar = ref(false); const isDragOverSidebar = ref(false);
const expandedFolderIds = ref([]); const expandedFolderIds = ref([]);
const expandedEntryIds = ref([]);
const nestedNoteListRef = ref(null); const nestedNoteListRef = ref(null);
let entryRefreshInterval; let entryRefreshInterval;
@@ -44,6 +52,14 @@ async function handleSidebarDrop(event) {
} catch (e) {} } catch (e) {}
} }
// An actor row is dragged out of the sidebar onto a map, where it stands as a token. The map viewer
// reads that type back on its drop (see MapViewerPane.vue); a note drag carries 'text/plain'
// instead, so the two never land where the other belongs.
function startActorDrag(event, actor) {
event.dataTransfer.setData(ACTOR_DRAG_TYPE, String(actor._id));
event.dataTransfer.effectAllowed = 'copyMove';
}
function toggleExpandedFolder(folderId) { function toggleExpandedFolder(folderId) {
const arr = expandedFolderIds.value; const arr = expandedFolderIds.value;
const idx = arr.indexOf(folderId); const idx = arr.indexOf(folderId);
@@ -98,12 +114,27 @@ function handleNoteDeleted(noteKey) {
notes.value = notes.value.filter(n => n.key !== noteKey); notes.value = notes.value.filter(n => n.key !== noteKey);
} }
function handleFolderSaved() { function sectionForTarget(target) {
if (target === 'actor') return 'actors';
if (target === 'item') return 'items';
if (target === 'map') return 'maps';
return null;
}
function handleFolderSaved(folder) {
// A folder only shows up once the list it belongs to reads it back: the notes refetch
// their tree, an entry list refetches its own (silently, its rows are already there).
const section = sectionForTarget(folder?.target ?? 'note');
if (!section) {
fetchCampaignNotes(); fetchCampaignNotes();
return;
}
fetchCampaignEntries(section, true);
} }
function handleFolderDeleted(folderId) { function handleFolderDeleted(folderId) {
expandedFolderIds.value = expandedFolderIds.value.filter((id) => id !== folderId); expandedFolderIds.value = expandedFolderIds.value.filter((id) => id !== folderId);
collapsedFolderIds.value = collapsedFolderIds.value.filter((id) => id !== folderId);
} }
function handleCampaignEntryCreated({ entityType, entry }) { function handleCampaignEntryCreated({ entityType, entry }) {
@@ -120,6 +151,9 @@ function handleCampaignEntryUpdated({ entityType, entry }) {
if (!list) return; if (!list) return;
list.value = list.value.map((current) => current._id === entry._id ? entry : current) list.value = list.value.map((current) => current._id === entry._id ? entry : current)
.sort((a, b) => a.name.localeCompare(b.name)); .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(() => { const campaignId = computed(() => {
@@ -191,6 +225,10 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
const previousById = new Map(list.value.map((entry) => [entry._id, entry])); const previousById = new Map(list.value.map((entry) => [entry._id, entry]));
list.value = response.data[entityType] ?? []; list.value = response.data[entityType] ?? [];
// Every entry list comes with the folders its rows stand in, so the sidebar can
// group them the way the note tree does (and the way the Foundry item directory
// arrives for items).
entryFolders[kind].value = response.data.folders ?? [];
// Tell open windows about Foundry changes landing behind them. // Tell open windows about Foundry changes landing behind them.
for (const entry of list.value) { for (const entry of list.value) {
const previous = previousById.get(entry._id); const previous = previousById.get(entry._id);
@@ -208,9 +246,11 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
function selectSection(section) { function selectSection(section) {
activeSection.value = section; activeSection.value = section;
if (isEntrySection(section)) fetchCampaignEntries(section); if (isEntrySection(section)) fetchCampaignEntries(section);
// The content area follows the sidebar: maps shows the anchored map, everything else the // Only the notes and maps buttons say something about the note container: they switch it between
// notes that are currently open. // the notes that are open and the anchored map. Actors and items open windows of their own, so
SetActivePane(section === 'maps' && AnchoredMap.value ? 'map' : 'notes'); // their buttons leave whatever the note container was showing untouched.
if (section === 'notes') SetActivePane('notes');
else if (section === 'maps' && AnchoredMap.value) SetActivePane('map');
} }
function createEntry(entityType) { function createEntry(entityType) {
@@ -222,6 +262,14 @@ function createEntry(entityType) {
CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value }); CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value });
} }
// Every section files its rows into folders of its own: the window passes along which
// list the folder belongs to, so the notes, the actors, the items and the maps each keep
// a tree the others never show.
function createFolder(target = 'note') {
if (!campaignId.value) return;
CreateWindow('new_folder', { campaign: campaignId.value, target });
}
function entrySummary(actor) { function entrySummary(actor) {
const bits = [t(`campaigns.actor.types.${actor.type}`)]; const bits = [t(`campaigns.actor.types.${actor.type}`)];
if (actor.species) bits.push(actor.species); if (actor.species) bits.push(actor.species);
@@ -235,6 +283,13 @@ function itemSummary(item) {
return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`; return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`;
} }
// An item's icon in the sidebar: an uploaded filename served from /api/public, or a full URL
// (Foundry sends its own icon as one) — the same rule the item window uses.
function itemImageUrl(image) {
if (!image) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
}
function mapSummary(map) { function mapSummary(map) {
return t('campaigns.map.summary', { size: map.gridSize, scale: map.scale }); return t('campaigns.map.summary', { size: map.gridSize, scale: map.scale });
} }
@@ -268,6 +323,14 @@ function showEntryMenu(entry, entityType) {
}); });
} }
// Rows of every section can be filed into a folder of their own list, like a note
// into a folder of the note tree.
menuItems.push({
name: t('campaigns.folders.move-to'),
icon: '/icons/iconoir/regular/folder.svg',
context: moveToFolderMenu(entityType, entry)
});
menuItems.push({ menuItems.push({
name: t('campaigns.actions.delete'), name: t('campaigns.actions.delete'),
icon: '/icons/iconoir/regular/trash.svg', icon: '/icons/iconoir/regular/trash.svg',
@@ -284,10 +347,72 @@ function showEntryMenu(entry, entityType) {
ShowContextMenu(menuItems); ShowContextMenu(menuItems);
} }
function toggleEntryDetails(entryId) { // The menu of a folder row: rename it, colour it, delete it. The notes' folders are
expandedEntryIds.value = expandedEntryIds.value.includes(entryId) // renamed and coloured the same way, through the same `/folder/*` routes.
? expandedEntryIds.value.filter((id) => id !== entryId) function folderMenuItems(folder) {
: [...expandedEntryIds.value, entryId]; return [
{
name: t('campaigns.folders.rename'), icon: '/icons/iconoir/regular/edit-pencil.svg',
action: () => {
HideContextMenu();
CreateWindow('new_folder', { folderId: folder._id, campaign: campaignId.value, name: folder.name });
}
},
{
name: t('campaigns.folders.color'), icon: '/icons/iconoir/regular/palette.svg',
context: BuildColorMenu((color) => setFolderColor(folder, color), { defaultLabel: t('campaigns.folders.default') })
},
{ divider: true },
{ name: t('campaigns.folders.delete'), icon: '/icons/iconoir/regular/trash.svg', action: () => deleteEntryFolder(folder) }
];
}
async function setFolderColor(folder, color) {
try {
const response = await Server().post('/folder/update', { id: folder._id, color });
if (response.data.status === 'ok') folder.color = color;
} catch (error) {} finally {
HideContextMenu();
}
}
async function deleteEntryFolder(folder) {
try {
const response = await Server().post('/folder/delete', { id: folder._id });
if (response.data.status !== 'ok') return;
collapsedFolderIds.value = collapsedFolderIds.value.filter((id) => id !== folder._id);
// Whatever stood in the folder moved to the root of the list along with it.
await fetchCampaignEntries(activeSection.value, true);
} catch (error) {} finally {
HideContextMenu();
}
}
// The 'move to folder' submenu of an entry: the folders of its own list and its root.
function moveToFolderMenu(entityType, entry) {
const menuItems = entryFolders[entityType].value.map((folder) => ({
name: folder.name, icon: '/icons/iconoir/regular/folder.svg',
action: () => moveEntryToFolder(entityType, entry, folder._id)
}));
if (menuItems.length > 0) menuItems.push({ divider: true });
menuItems.push({
name: t('campaigns.folders.root'), icon: '/icons/iconoir/regular/xmark-circle.svg',
action: () => moveEntryToFolder(entityType, entry, null)
});
return menuItems;
}
async function moveEntryToFolder(entityType, entry, folderId) {
try {
const response = await Server().post(`/${entityType}/update`, { id: entry._id, folder: folderId });
if (response.data.status !== 'ok') return;
// The row walks over to its new folder. This is the event a Foundry sync of the
// entry sends, so the list regroups and a window open on it sees the change.
emitter.emit('campaign-entry-updated', { entityType, entry: response.data[entityType] });
} catch (error) {} finally {
HideContextMenu();
}
} }
async function openCharacterSheet(actor) { async function openCharacterSheet(actor) {
@@ -299,6 +424,16 @@ async function openCharacterSheet(actor) {
CreateWindow('character_sheet', { actor }); CreateWindow('character_sheet', { actor });
} }
// Clicking an item opens its window, like a character does with its sheet.
async function openItemSheet(item) {
const existingWindowId = GetFirstWindowId('item_sheet');
if (existingWindowId !== undefined) {
ClearWindow({ id: existingWindowId });
await nextTick();
}
CreateWindow('item_sheet', { item });
}
// Maps are anchored on the note container instead of opening a window: the notes that were open // 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. // stay open, and the sidebar's notes/maps buttons switch between the two.
function openMapViewer(map) { function openMapViewer(map) {
@@ -318,21 +453,41 @@ function createNote() {
CreateWindow('new_note', { campaign: campaignId.value }); CreateWindow('new_note', { campaign: campaignId.value });
} }
function createFolder() {
CreateWindow('new_folder', { campaign: campaignId.value });
}
function toggleSidebar() { function toggleSidebar() {
sidebarCollapsed.value = !sidebarCollapsed.value; sidebarCollapsed.value = !sidebarCollapsed.value;
} }
const rootNotes = computed(() => notes.value.filter(n => !n._folder)); const rootNotes = computed(() => notes.value.filter(n => !n._folder));
// The rows of each entry list: every folder followed by what stands in it, deeper and
// deeper, the way the item list has done since its folders arrived from the linked world
// (services/ItemFolders.js builds them from the list and the folders the API sends).
// Without any folder this is the plain list, and `row.item` is the entry of the section
// the row belongs to: its actor, item or map.
const entryRows = {
actor: computed(() => BuildItemRows(actors.value, entryFolders.actor.value, collapsedFolderIds.value)),
item: computed(() => BuildItemRows(items.value, entryFolders.item.value, collapsedFolderIds.value)),
map: computed(() => BuildItemRows(maps.value, entryFolders.map.value, collapsedFolderIds.value))
};
// Rows one step deeper per folder level; the sidebar list's own padding is the base.
function rowIndent(depth) {
return { paddingLeft: `${10 + depth * 14}px` };
}
function toggleFolder(folderId) {
collapsedFolderIds.value = collapsedFolderIds.value.includes(folderId)
? collapsedFolderIds.value.filter((id) => id !== folderId)
: [...collapsedFolderIds.value, folderId];
}
watch(campaignId, (newVal) => { watch(campaignId, (newVal) => {
if (newVal) { if (newVal) {
actors.value = []; actors.value = [];
items.value = []; items.value = [];
maps.value = []; maps.value = [];
for (const sectionFolders of Object.values(entryFolders)) sectionFolders.value = [];
collapsedFolderIds.value = [];
ClearAnchoredMap(); ClearAnchoredMap();
fetchCampaignNotes(); fetchCampaignNotes();
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value); if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
@@ -342,6 +497,8 @@ watch(campaignId, (newVal) => {
actors.value = []; actors.value = [];
items.value = []; items.value = [];
maps.value = []; maps.value = [];
for (const sectionFolders of Object.values(entryFolders)) sectionFolders.value = [];
collapsedFolderIds.value = [];
notesError.value = ''; notesError.value = '';
entriesError.value = ''; entriesError.value = '';
ClearAnchoredMap(); ClearAnchoredMap();
@@ -452,7 +609,7 @@ onBeforeUnmount(() => {
<button class="sidebar-action" type="button" @click="createNote" :disabled="!Campaign" :title="t('campaigns.actions.new-note')" :aria-label="t('campaigns.actions.new-note')"> <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"> <img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button> </button>
<button class="sidebar-action" type="button" @click="createFolder" :disabled="!Campaign" :title="t('campaigns.actions.new-folder')" :aria-label="t('campaigns.actions.new-folder')"> <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"> <img class="sidebar-action-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
</button> </button>
<button class="sidebar-action" type="button" @click="fetchCampaignNotes" :disabled="!Campaign || loadingNotes" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')"> <button class="sidebar-action" type="button" @click="fetchCampaignNotes" :disabled="!Campaign || loadingNotes" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
@@ -463,6 +620,9 @@ onBeforeUnmount(() => {
<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() })"> <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"> <img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button> </button>
<button class="sidebar-action" type="button" @click="createFolder(entryEntityType(activeSection))" :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="fetchCampaignEntries(activeSection)" :disabled="!Campaign || loadingEntries" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')"> <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"> <img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
</button> </button>
@@ -484,44 +644,74 @@ onBeforeUnmount(() => {
<template v-else-if="activeSection === 'actors'"> <template v-else-if="activeSection === 'actors'">
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div> <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="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-else-if="actors.length === 0 && entryFolders.actor.value.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')"> <template v-for="row in entryRows.actor.value" :key="row.key">
<span class="entity-entry-name">{{ actor.name }}</span> <EntryFolderRow
<span class="entity-entry-meta">{{ entrySummary(actor) }}</span> v-if="row.kind === 'folder'"
:folder="row.folder"
:collapsed="collapsedFolderIds.includes(row.folder._id)"
:indent="rowIndent(row.depth)"
:menu="folderMenuItems(row.folder)"
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
@toggle="toggleFolder(row.folder._id)"
/>
<div v-else class="entity-entry" :style="rowIndent(row.depth)" role="button" tabindex="0" draggable="true" :title="t('campaigns.map.tokens.drag')" @click="openCharacterSheet(row.item)" @keydown.enter="openCharacterSheet(row.item)" @keydown.space.prevent="openCharacterSheet(row.item)" @dragstart="startActorDrag($event, row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'actor')">
<span class="entity-entry-name">{{ row.item.name }}</span>
<span class="entity-entry-meta">{{ entrySummary(row.item) }}</span>
</div> </div>
</template> </template>
</template>
<template v-else-if="activeSection === 'items'"> <template v-else-if="activeSection === 'items'">
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div> <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="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-else-if="items.length === 0 && entryFolders.item.value.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')"> <template v-for="row in entryRows.item.value" :key="row.key">
<span class="entity-entry-name-row"> <EntryFolderRow
<span class="entity-entry-name">{{ item.name }}</span> v-if="row.kind === 'folder'"
<span v-if="item.foundryItemId" class="entity-entry-sync">{{ t('campaigns.synced') }}</span> :folder="row.folder"
:collapsed="collapsedFolderIds.includes(row.folder._id)"
:indent="rowIndent(row.depth)"
:menu="folderMenuItems(row.folder)"
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
@toggle="toggleFolder(row.folder._id)"
/>
<div v-else class="entity-entry" :style="rowIndent(row.depth)" role="button" tabindex="0" @click="openItemSheet(row.item)" @keydown.enter="openItemSheet(row.item)" @keydown.space.prevent="openItemSheet(row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'item')">
<span class="entity-entry-title">
<span v-if="row.item.image" class="entity-entry-image" aria-hidden="true">
<img :src="itemImageUrl(row.item.image)" alt="">
</span> </span>
<span class="entity-entry-meta">{{ itemSummary(item) }}</span> <span class="entity-entry-name">{{ row.item.name }}</span>
<template v-if="expandedEntryIds.includes(item._id)"> </span>
<span v-if="item.weight !== undefined" class="entity-entry-description">{{ item.weight }} lb</span> <span class="entity-entry-meta">{{ itemSummary(row.item) }}</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> </div>
</template> </template>
</template>
<template v-else> <template v-else>
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div> <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="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-else-if="maps.length === 0 && entryFolders.map.value.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')"> <template v-for="row in entryRows.map.value" :key="row.key">
<EntryFolderRow
v-if="row.kind === 'folder'"
:folder="row.folder"
:collapsed="collapsedFolderIds.includes(row.folder._id)"
:indent="rowIndent(row.depth)"
:menu="folderMenuItems(row.folder)"
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
@toggle="toggleFolder(row.folder._id)"
/>
<div v-else class="entity-entry" :style="rowIndent(row.depth)" :class="{ anchored: isAnchoredMap(row.item) }" role="button" tabindex="0" @click="openMapViewer(row.item)" @keydown.enter="openMapViewer(row.item)" @keydown.space.prevent="openMapViewer(row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'map')">
<span class="entity-entry-name-row"> <span class="entity-entry-name-row">
<span class="entity-entry-name">{{ map.name }}</span> <span class="entity-entry-name">{{ row.item.name }}</span>
<span v-if="isAnchoredMap(map)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span> <span v-if="isAnchoredMap(row.item)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span>
</span> </span>
<span class="entity-entry-meta">{{ mapSummary(map) }}</span> <span class="entity-entry-meta">{{ mapSummary(row.item) }}</span>
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span> <span v-if="!row.item.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
</div> </div>
</template> </template>
</template>
</div> </div>
</aside> </aside>
</div> </div>
@@ -684,6 +874,15 @@ onBeforeUnmount(() => {
} }
.entity-entry-meta, .entity-entry-description { font-size: 12px; opacity: 0.72; } .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; } .entity-entry-description { display: -webkit-box; -webkit-box-orient: vertical; -webkit-line-clamp: 2; overflow: hidden; }
/* An item row leads with the item's own icon on the left of its name, standing in for the
"SYNCED" text it used to show (Syndria98/dragonroll#53). */
.entity-entry-title { display: flex; align-items: center; gap: 9px; min-width: 0; }
.entity-entry-image {
flex: 0 0 30px; width: 30px; height: 30px; box-sizing: border-box;
display: grid; place-items: center; overflow: hidden;
border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft);
}
.entity-entry-image img { width: 100%; height: 100%; object-fit: contain; }
@media (max-width: 900px) { @media (max-width: 900px) {
.notes-sidebar { .notes-sidebar {

View File

@@ -0,0 +1,57 @@
<script setup>
// One folder row of a campaign entry list (actors, items or maps), nested by the depth the
// folder stands at. Toggling it collapses what is inside; its context menu renames the
// folder, colours it, and deletes it. Note folders have their own tree (NestedNoteList),
// which loads its contents one folder at a time.
import { ShowContextMenu } from '~/services/ContextMenu';
const props = defineProps({
folder: { type: Object, required: true },
collapsed: { type: Boolean, default: false },
// The padding of the level this folder stands at, from the sidebar's `rowIndent`.
indent: { type: Object, default: () => ({}) },
menu: { type: Array, default: () => [] },
toggleLabel: { type: String, default: '' }
});
const emit = defineEmits(['toggle']);
</script>
<template>
<button
class="entry-folder-row"
:class="{ 'has-color': !!folder.color }"
:style="[indent, folder.color ? { '--entry-color': folder.color } : null]"
type="button"
:aria-expanded="(!collapsed).toString()"
:aria-label="toggleLabel"
@click="emit('toggle')"
@contextmenu.prevent="ShowContextMenu(menu)"
>
<img
class="entry-folder-arrow"
:src="collapsed ? '/icons/iconoir/regular/nav-arrow-right.svg' : '/icons/iconoir/regular/nav-arrow-down.svg'"
alt=""
aria-hidden="true"
>
<img class="entry-folder-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
<span class="entry-folder-name">{{ folder.name }}</span>
</button>
</template>
<style scoped>
/* The same row box as an entry, since folders and entries share the sidebar list and its
width rules. */
.entry-folder-row {
width: 100%; min-width: 0; box-sizing: border-box; margin: 0; padding: 8px 10px; border: 1px solid transparent;
border-radius: 8px; background: transparent; color: var(--color-text); text-align: left; display: flex;
align-items: center; gap: 6px; cursor: pointer; font: inherit;
}
.entry-folder-row:hover { background: var(--color-background-soft); }
.entry-folder-row:focus-visible { outline: 1px solid var(--color-link); }
.entry-folder-row.has-color { background: color-mix(in srgb, var(--entry-color) 32%, transparent); }
.entry-folder-row.has-color:hover { background: color-mix(in srgb, var(--entry-color) 50%, transparent); }
.entry-folder-arrow { width: 12px; height: 12px; flex: 0 0 12px; filter: invert(var(--color-icon-invert)); opacity: 0.6; }
.entry-folder-icon { width: 15px; height: 15px; flex: 0 0 15px; filter: invert(var(--color-icon-invert)); }
.entry-folder-name { min-width: 0; font-weight: bold; word-break: break-word; }
</style>

View File

@@ -1,6 +1,7 @@
<script setup> <script setup>
import { ref, onBeforeUnmount, onMounted, watch } from 'vue'; import { ref, onBeforeUnmount, onMounted, watch } from 'vue';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import { BuildColorMenu } from '~/services/EntryColors';
import Server from '~/services/Server'; import Server from '~/services/Server';
import { CreateWindow } from '~/services/Windows'; import { CreateWindow } from '~/services/Windows';
import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu'; import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu';
@@ -20,18 +21,6 @@ const emit = defineEmits(['open-note', 'reload-notes']);
const loadingFolders = new Set(); const loadingFolders = new Set();
const dragHoveredFolderId = ref(null); 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 // Cache of loaded folder contents — persists across reloads until cleared
// Each entry: { [folderId]: { notes: [], subfolders: [] } } // Each entry: { [folderId]: { notes: [], subfolders: [] } }
const folderContentCache = ref({}); const folderContentCache = ref({});
@@ -216,13 +205,7 @@ function buildFolderContextMenu(folder) {
} }
function buildColorMenu(kind, item) { function buildColorMenu(kind, item) {
const colorItems = entryColors.map((color) => ({ return BuildColorMenu((color) => setEntryColor(kind, item, 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) { async function setEntryColor(kind, item, color) {

View File

@@ -1,7 +1,12 @@
<script setup> <script setup>
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue'; import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { CreateWindow } from '@/services/Windows'; import { useI18n } from 'vue-i18n';
import { getBaseUrl } from '~/services/Server'; import { ClearWindow, CreateWindow, GetFirstWindowId } from '@/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
import { ActorDragId, CellCentre, IsActorDrag, MoveByCells, TokenSize } from '~/services/MapTokens';
import { DisplayToast } from '~/services/Toaster';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import { useCampaignService } from '~/services/Campaign.js'; import { useCampaignService } from '~/services/Campaign.js';
@@ -141,19 +146,385 @@ function handleMapUpdated({ entityType, entry }) {
if (imageChanged) imageSize.value = { width: 0, height: 0 }; 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 updateMap('/map/pin', { id: map.value?._id, note: noteId, x: spot.x, y: spot.y }, t('campaigns.map.pins.error'));
}
async function removePin(pin) {
await updateMap('/map/unpin', { id: map.value?._id, pin: pin?._id }, t('campaigns.map.pins.error'));
}
// Every pin and token change answers with the whole map, which keeps the sidebar entry and the
// anchored map in step with what is on screen.
async function updateMap(route, body, failure) {
if (!body.id) return false;
try {
const response = await Server().post(route, body);
if (response.data.status !== 'ok') {
DisplayToast('red', failure, 3000);
return false;
}
map.value = { ...response.data.map };
emitter.emit('campaign-entry-updated', { entityType: 'map', entry: response.data.map });
return true;
} catch (error) {
DisplayToast('red', failure, 3000);
return false;
}
}
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);
}
// --- Actors standing on the map as tokens ---
// An actor dragged out of the sidebar lands on the cell it is dropped on, and its token can then be
// dragged (or nudged with the arrow keys) from cell to cell. Tokens are kept in image pixels like the
// pins, so moving one only writes the middle of the cell it moved to.
const actors = ref([]);
const actorsById = computed(() => new Map(actors.value.map((actor) => [String(actor._id), actor])));
// Actor portraits that will not load (a Foundry path, say) fall back to the initials of the actor.
const brokenImages = ref(new Set());
const draggingActor = ref(false);
// The token a pointer is holding, and the cell centre it is held at: the move stays local until the
// pointer lets go, so a drag across the map is one save and not one per mouse move.
const movingToken = ref(null);
const grid = computed(() => ({
gridSize: map.value?.gridSize,
offsetX: map.value?.offsetX,
offsetY: map.value?.offsetY
}));
const tokens = computed(() => map.value?.tokens ?? []);
// The actor names and portraits the tokens are drawn from. An actor that is not (or no longer) in the
// campaign is not dropped from the map here: the backend does that, and the next read of the map is
// the one that shows it gone.
async function fetchTokenActors() {
if (!campaignId.value) {
actors.value = [];
return;
}
try {
const response = await Server().get('/actor/list', { params: { campaign: campaignId.value } });
actors.value = response.data.status === 'ok' ? (response.data.actors ?? []) : [];
} catch (error) {
actors.value = [];
}
}
function tokenActor(token) {
return actorsById.value.get(String(token?.actor)) ?? null;
}
function tokenLabel(token) {
return tokenActor(token)?.name ?? '';
}
function tokenInitials(token) {
const name = String(tokenLabel(token) ?? '').trim();
if (!name) return '?';
return name.split(/\s+/).slice(0, 2).map((part) => part.charAt(0).toUpperCase()).join('');
}
function tokenImage(token) {
const image = tokenActor(token)?.image;
if (!image || brokenImages.value.has(String(token?.actor))) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
}
function onTokenImageError(token) {
brokenImages.value = new Set(brokenImages.value).add(String(token?.actor));
}
// Tokens are drawn in screen space too, but they are sized by the cell they stand on: unlike a pin, a
// token covers ground, so it grows and shrinks with the map.
function tokenStyle(token) {
const held = movingToken.value && String(movingToken.value.token?._id) === String(token?._id)
? movingToken.value
: token;
const point = ToScreenPoint(held, viewState());
const size = TokenSize(grid.value, zoom.value);
return {
left: `${point.x}px`,
top: `${point.y}px`,
width: `${size}px`,
height: `${size}px`,
// The initials of an actor with no portrait are read at the size of its token.
fontSize: `${Math.min(18, Math.max(9, Math.round(size * 0.36)))}px`
};
}
// The spot of the viewport a drop or a drag is over, in image pixels, or null outside of the image.
function imagePointOf(event) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return null;
return ToImagePoint({ x: event.clientX - bounds.left, y: event.clientY - bounds.top }, viewState());
}
function onMapDragOver(event) {
if (!imageUrl.value || !IsActorDrag(event)) return;
// Saying so is what lets the browser deliver the drop at all.
event.preventDefault();
draggingActor.value = true;
}
function onMapDragLeave(event) {
// Crossing into a child of the viewport is not leaving it.
if (event.relatedTarget && viewport.value?.contains(event.relatedTarget)) return;
draggingActor.value = false;
}
async function onMapDrop(event) {
draggingActor.value = false;
const actorId = ActorDragId(event);
if (!actorId || !imageUrl.value || !map.value?._id) return;
const spot = imagePointOf(event);
if (!spot) return;
await placeToken(actorId, spot);
}
// An actor stands on the map once: dropping it again on a map it already occupies moves it there, the
// same way re-pinning a note moves its marker.
async function placeToken(actorId, spot) {
const centre = CellCentre(spot, grid.value);
if (!centre) return false;
return updateMap('/map/place-token', {
id: map.value?._id, actor: actorId, x: centre.x, y: centre.y
}, t('campaigns.map.tokens.error'));
}
async function removeToken(token) {
await updateMap('/map/remove-token', { id: map.value?._id, token: token?._id }, t('campaigns.map.tokens.error'));
}
let tokenPointerId = null;
function onTokenPointerDown(event, token) {
// The token is what is being held here: the map must not start panning under the pointer.
event.stopPropagation();
if (event.button !== 0) return;
tokenPointerId = event.pointerId;
event.currentTarget.setPointerCapture?.(event.pointerId);
movingToken.value = { token: { ...token }, x: Number(token.x) || 0, y: Number(token.y) || 0 };
}
function onTokenPointerMove(event) {
if (!movingToken.value || event.pointerId !== tokenPointerId) return;
const spot = imagePointOf(event);
// Dragged off the image, the token keeps the cell it had: an actor is never lost over the edge.
if (!spot) return;
const centre = CellCentre(spot, grid.value);
if (!centre) return;
movingToken.value = { ...movingToken.value, x: centre.x, y: centre.y };
}
async function onTokenPointerUp(event) {
if (!movingToken.value || event.pointerId !== tokenPointerId) return;
const { token, x, y } = movingToken.value;
tokenPointerId = null;
movingToken.value = null;
event.currentTarget?.releasePointerCapture?.(event.pointerId);
if (x === Number(token.x) && y === Number(token.y)) return;
await placeToken(token.actor, { x, y });
}
const CELL_STEPS = {
ArrowLeft: [-1, 0],
ArrowRight: [1, 0],
ArrowUp: [0, -1],
ArrowDown: [0, 1]
};
// A focused token answers to the keyboard too: arrows walk it over the grid, Delete takes it off.
async function onTokenKeydown(event, token) {
const step = CELL_STEPS[event.key];
if (step) {
event.preventDefault();
const centre = MoveByCells(token, grid.value, step[0], step[1]);
if (centre) await placeToken(token.actor, centre);
return;
}
if (event.key === 'Delete' || event.key === 'Backspace') {
event.preventDefault();
await removeToken(token);
}
}
function onTokenContextMenu(token) {
const actor = tokenActor(token);
const menuItems = [];
if (actor) {
menuItems.push({
name: t('campaigns.map.tokens.open'),
icon: '/icons/iconoir/regular/user.svg',
action: () => { HideContextMenu(); openActorSheet(actor); }
});
menuItems.push({ divider: true });
}
menuItems.push({
name: t('campaigns.map.tokens.remove'),
icon: '/icons/iconoir/regular/xmark-circle.svg',
action: () => { HideContextMenu(); removeToken(token); }
});
ShowContextMenu(menuItems);
}
async function openActorSheet(actor) {
// One sheet at a time, like the sidebar opens it.
const existingWindowId = GetFirstWindowId('character_sheet');
if (existingWindowId !== undefined) ClearWindow({ id: existingWindowId });
await nextTick();
CreateWindow('character_sheet', { actor });
}
function handleActorEntry({ entityType, entry }) {
if (entityType !== 'actor' || !entry?._id) return;
if (entry.campaign && String(entry.campaign) !== String(campaignId.value)) return;
actors.value = [entry, ...actors.value.filter((current) => String(current._id) !== String(entry._id))];
}
// A different map was anchored while this pane was already mounted. // A different map was anchored while this pane was already mounted.
watch(() => props.map, (incoming, previous) => { watch(() => props.map, (incoming, previous) => {
if (incoming === previous) return; if (incoming === previous) return;
map.value = incoming ? { ...incoming } : null; map.value = incoming ? { ...incoming } : null;
imageSize.value = { width: 0, height: 0 }; imageSize.value = { width: 0, height: 0 };
movingToken.value = null;
draggingActor.value = false;
});
watch(campaignId, () => {
noteOptions.value = [];
fetchPinnableNotes();
actors.value = [];
fetchTokenActors();
}); });
onMounted(() => { onMounted(() => {
emitter.on('campaign-entry-updated', handleMapUpdated); emitter.on('campaign-entry-updated', handleMapUpdated);
emitter.on('campaign-entry-created', handleActorEntry);
emitter.on('campaign-entry-updated', handleActorEntry);
emitter.on('delete-note', handlePinnedNoteDeleted);
emitter.on('title-updated', handlePinnedNoteRenamed);
fetchPinnableNotes();
fetchTokenActors();
}); });
onBeforeUnmount(() => { onBeforeUnmount(() => {
emitter.off('campaign-entry-updated', handleMapUpdated); emitter.off('campaign-entry-updated', handleMapUpdated);
emitter.off('campaign-entry-created', handleActorEntry);
emitter.off('campaign-entry-updated', handleActorEntry);
emitter.off('delete-note', handlePinnedNoteDeleted);
emitter.off('title-updated', handlePinnedNoteRenamed);
}); });
</script> </script>
@@ -198,10 +569,55 @@ onBeforeUnmount(() => {
@pointermove="onPointerMove" @pointermove="onPointerMove"
@pointerup="onPointerUp" @pointerup="onPointerUp"
@pointercancel="onPointerUp" @pointercancel="onPointerUp"
@contextmenu.prevent="onMapContextMenu"
@dragover="onMapDragOver"
@dragleave="onMapDragLeave"
@drop.prevent="onMapDrop"
> >
<template v-if="imageUrl"> <template v-if="imageUrl">
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded"> <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-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>
<div class="map-tokens">
<button
v-for="token in tokens"
:key="token._id"
class="map-token"
:class="{ moving: movingToken && String(movingToken.token?._id) === String(token._id) }"
type="button"
:style="tokenStyle(token)"
:title="tokenLabel(token) || $t('campaigns.map.tokens.token')"
:aria-label="tokenLabel(token) || $t('campaigns.map.tokens.token')"
draggable="false"
@pointerdown="onTokenPointerDown($event, token)"
@pointermove="onTokenPointerMove"
@pointerup="onTokenPointerUp"
@pointercancel="onTokenPointerUp"
@contextmenu.stop.prevent="onTokenContextMenu(token)"
@keydown="onTokenKeydown($event, token)"
>
<span class="token-initials" aria-hidden="true">{{ tokenInitials(token) }}</span>
<img v-if="tokenImage(token)" class="token-image" :src="tokenImage(token)" alt="" draggable="false" @error="onTokenImageError(token)">
<span class="token-label">{{ tokenLabel(token) }}</span>
</button>
</div>
<div v-if="draggingActor" class="map-drop-hint">{{ $t('campaigns.map.tokens.drop-hint') }}</div>
</template> </template>
<div v-else class="map-empty"> <div v-else class="map-empty">
{{ $t('campaigns.map.no-image') }} {{ $t('campaigns.map.no-image') }}
@@ -227,6 +643,51 @@ onBeforeUnmount(() => {
.map-viewport.dragging { cursor: grabbing; } .map-viewport.dragging { cursor: grabbing; }
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; } .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; } .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; }
/* Tokens are the actors standing on the map: drawn in screen space like the pins, but sized by the
grid cell they occupy, so a token covers its square whatever the zoom is (see TokenSize). */
.map-tokens { position: absolute; inset: 0; pointer-events: none; }
.map-token {
position: absolute; transform: translate(-50%, -50%); pointer-events: auto;
display: flex; align-items: center; justify-content: center; margin: 0; padding: 0;
border: 2px solid var(--color-link); border-radius: 50%;
background: var(--color-background-soft); color: var(--color-text);
cursor: grab; user-select: none; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
}
.map-token:hover { border-color: var(--color-text); }
.map-token:focus-visible { outline: 1px solid var(--color-link); outline-offset: 2px; }
.map-token.moving { cursor: grabbing; }
.token-image { position: absolute; inset: 0; box-sizing: border-box; width: 100%; height: 100%; object-fit: cover; border-radius: 50%; }
/* No portrait (or one that will not load): the token shows the initials of its actor instead. */
.token-initials { opacity: .8; white-space: nowrap; }
.token-label {
display: none; position: absolute; top: 100%; left: 50%; transform: translateX(-50%); margin-top: 3px;
max-width: 160px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap;
font-size: 11px; text-shadow: 0px 0px 4px rgba(0,0,0,0.8);
}
.map-token:hover .token-label, .map-token:focus-visible .token-label { display: block; }
/* Shown while an actor is carried over the map from the sidebar, so the spot to let go of it has. */
.map-drop-hint {
position: absolute; top: 10px; left: 50%; transform: translateX(-50%);
padding: 5px 10px; border: 1px dashed var(--color-link); border-radius: 7px;
background: var(--color-background-soft); color: var(--color-text); font-size: 12px;
pointer-events: none; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
}
.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-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 { 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); } .map-edit:hover { background: var(--color-button-hover); }

View File

@@ -1,5 +1,5 @@
<script setup> <script setup>
defineProps({ const props = defineProps({
title: { type: String, default: '' }, title: { type: String, default: '' },
subtitle: { type: String, default: '' }, subtitle: { type: String, default: '' },
link: { type: String, default: '' }, link: { type: String, default: '' },

View File

@@ -1,24 +1,42 @@
<script setup> <script setup>
import { ref, onMounted, onUnmounted } from 'vue'; import { computed, nextTick, onMounted, onUnmounted, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import SearchIcon from 'pixelarticons/svg/search.svg' import SearchIcon from 'pixelarticons/svg/search.svg'
import PlusIcon from 'pixelarticons/svg/plus.svg' import PlusIcon from 'pixelarticons/svg/plus.svg'
import NoteSearchResult from './SearchResult.vue'; import NoteSearchResult from './SearchResult.vue';
import Server from '~/services/Server'; import Server from '~/services/Server';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import { CreateWindow } from '~/services/Windows'; import { AnchorMap } from '~/services/Content.js';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
import { register, search as searchActions, execute as executeAction } from '~/services/ActionRegistry'; import { register, search as searchActions, execute as executeAction } from '~/services/ActionRegistry';
import { useCampaignService } from '~/services/Campaign.js'; import { useCampaignService } from '~/services/Campaign.js';
const { Campaign } = useCampaignService(); const { Campaign } = useCampaignService();
const { t } = useI18n();
const inputText = ref(''); const inputText = ref('');
// Everything the palette searches: the campaign's notes, actors, items and maps.
const notes = ref([]); const notes = ref([]);
const actors = ref([]);
const items = ref([]);
const maps = ref([]);
const showResults = ref(false); const showResults = ref(false);
const selectedIndex = ref(-1); const selectedIndex = ref(-1);
const focusInput = ref(null); const focusInput = ref(null);
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
// The lists belong to one campaign; when another one opens they are dropped and refetched.
watch(campaignId, () => {
notes.value = [];
actors.value = [];
items.value = [];
maps.value = [];
});
// ---- Keyboard shortcut to open search ---- // ---- Keyboard shortcut to open search ----
function globalKeydown(e) { function globalKeydown(e) {
const modKey = e.metaKey || e.ctrlKey; const modKey = e.metaKey || e.ctrlKey;
@@ -51,100 +69,166 @@ function registerCreateNoteAction() {
register(action); register(action);
} }
// ---- Note search ---- // ---- Campaign entries to search ----
async function fetchNotes() { // The same accent- and case-insensitive normalisation the action filter uses, so a match is
if (!Campaign.value) return; // never hidden by how the name was written.
function normalize(text) {
return (text || '').normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().trim();
}
const campaignId = Campaign.value?._id ?? Campaign.value?.id; async function fetchList(path, key) {
try { try {
const response = await Server().get('/note/list', { params: { campaign: campaignId } }); const response = await Server().get(path, { params: { campaign: campaignId.value } });
if (response.data.status !== 'ok') { if (response.data.status !== 'ok') return [];
notes.value = []; return response.data[key] ?? [];
return; } catch (err) {
return [];
} }
notes.value = response.data.notes.map(n => ({ }
async function fetchSearchEntries() {
if (!campaignId.value) return;
// /note/all covers notes nested in folders too, unlike the sidebar's /note/list.
const [allNotes, fetchedActors, fetchedItems, fetchedMaps] = await Promise.all([
fetchList('/note/all', 'notes'),
fetchList('/actor/list', 'actors'),
fetchList('/item/list', 'items'),
fetchList('/map/list', 'maps')
]);
notes.value = allNotes.map(n => ({
key: n._id, key: n._id,
title: n.title || 'Untitled', title: n.title || 'Untitled',
date: n.date date: n.date
})); }));
} catch (err) { actors.value = fetchedActors;
notes.value = []; items.value = fetchedItems;
} maps.value = fetchedMaps;
} }
function openNote(note) { // ---- Unified results: notes, actors, items, maps + command actions ----
emitter.emit('push-note', note);
closeResults();
}
// ---- Unified results: notes + command actions ----
function getCombinedResults(query) { function getCombinedResults(query) {
const combined = []; const combined = [];
const q = normalize(query);
if (query && query.trim().length > 0) { function pushMatches(list, type, getName) {
const q = query.normalize("NFD").replace(/[\u036f]/g, "").toLowerCase().trim(); for (const data of list) {
if (q && !normalize(getName(data)).includes(q)) continue;
// Filter notes that match the query text combined.push({ type, data });
const matchingNotes = notes.value.filter(note => { }
const title = (note.title || '').normalize("NFD").replace(/[\u036f]/g, "").toLowerCase();
return title.includes(q);
});
for (const note of matchingNotes) {
combined.push({ type: 'note', data: note });
} }
// Search command actions pushMatches(notes.value, 'note', n => n.title);
const matchedActions = searchActions(query); pushMatches(actors.value, 'actor', a => a.name);
for (const action of matchedActions) { pushMatches(items.value, 'item', i => i.name);
pushMatches(maps.value, 'map', m => m.name);
// Command actions match on their label and description themselves.
for (const action of searchActions(query ?? '')) {
combined.push({ type: 'action', data: action }); 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; return combined;
} }
// Each result type renders like the sidebar row of that entry: the section's icon and name.
const resultIcons = {
note: '/icons/iconoir/regular/book.svg',
actor: '/icons/iconoir/regular/user.svg',
item: '/icons/iconoir/regular/box.svg',
map: '/icons/iconoir/regular/map.svg'
};
function resultTitle(item) {
if (item.type === 'action') return item.data.label;
return item.data.title || item.data.name || 'Untitled';
}
function resultSubtitle(item) {
if (item.type === 'action') return item.data.description;
return t(`campaigns.sections.${item.type}s`);
}
function resultIcon(item) {
return item.type === 'action' ? PlusIcon : resultIcons[item.type];
}
// ---- Opening a result, the way the sidebar opens that kind of entry ----
async function openNote(note) {
closeResults();
// /note/all never carries content; retrieve the note to open it with its text.
try {
const response = await Server().get(`/note/retrieve/${note.key}`);
if (response.data.status !== 'ok' || !response.data.note) return;
const full = response.data.note;
emitter.emit('push-note', { key: full._id, title: full.title, text: full.content ?? '', date: full.date });
} catch (err) {}
}
// A character or an item replaces the sheet window that is already open.
async function openActor(actor) {
closeResults();
const existingWindowId = GetFirstWindowId('character_sheet');
if (existingWindowId !== undefined) {
ClearWindow({ id: existingWindowId });
await nextTick();
}
CreateWindow('character_sheet', { actor });
}
async function openItem(item) {
closeResults();
const existingWindowId = GetFirstWindowId('item_sheet');
if (existingWindowId !== undefined) {
ClearWindow({ id: existingWindowId });
await nextTick();
}
CreateWindow('item_sheet', { item });
}
// Maps anchor on the note container instead of opening a window, like from the sidebar.
function openMap(map) {
closeResults();
const floatingViewer = GetFirstWindowId('map_viewer');
if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
AnchorMap(map);
}
function openResult(item) {
if (!item) return;
if (item.type === 'note') openNote(item.data);
else if (item.type === 'actor') openActor(item.data);
else if (item.type === 'item') openItem(item.data);
else if (item.type === 'map') openMap(item.data);
else {
executeAction(item.data.id);
closeResults();
}
}
// ---- Input handling ---- // ---- Input handling ----
function onInput(event) { function onInput(event) {
const query = event.target.value; inputText.value = event.target.value;
inputText.value = query;
selectedIndex.value = -1; selectedIndex.value = -1;
if (!query || query.trim() === '') {
showResults.value = false;
return;
}
showResults.value = true; showResults.value = true;
} }
function onFocus() { function onFocus() {
if (notes.value.length === 0) {
fetchNotes().then(() => {
showResults.value = true; showResults.value = true;
}); // Foundry keeps syncing entries into the campaign in the background: refresh every time the
} else { // palette is opened so it never offers stale results.
showResults.value = true; if (campaignId.value) fetchSearchEntries();
}
} }
function onBlur(event) { function onBlur() {
// Delay closing to allow click on results // Delay closing to allow click on results
setTimeout(() => { setTimeout(() => {
closeResults(); closeResults();
}, 150); }, 150);
} }
async function onKeydown(event) { function onKeydown(event) {
const combined = getCombinedResults(inputText.value); const combined = getCombinedResults(inputText.value);
if (event.key === 'ArrowDown') { if (event.key === 'ArrowDown') {
@@ -162,16 +246,9 @@ async function onKeydown(event) {
if (event.key === 'Enter') { if (event.key === 'Enter') {
event.preventDefault(); event.preventDefault();
if (selectedIndex.value >= 0) { if (selectedIndex.value >= 0) {
const item = combined[selectedIndex.value]; openResult(combined[selectedIndex.value]);
if (!item) return;
if (item.type === 'note') {
openNote(item.data);
} else if (item.type === 'action') {
executeAction(item.data.id);
closeResults();
}
} }
return;
} }
if (event.key === 'Escape') { if (event.key === 'Escape') {
@@ -179,21 +256,6 @@ async function onKeydown(event) {
} }
} }
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() { function closeResults() {
showResults.value = false; showResults.value = false;
selectedIndex.value = -1; selectedIndex.value = -1;
@@ -231,21 +293,19 @@ onUnmounted(() => {
</div> </div>
<div class="search-container" v-if="showResults"> <div class="search-container" v-if="showResults">
<template v-if="getCombinedResults(inputText).length === 0 && inputText.trim()"> <template v-if="getCombinedResults(inputText).length === 0">
<div class="search-empty">No results found</div> <div class="search-empty">No results found</div>
</template> </template>
<div class="search-container-list"> <div class="search-container-list">
<NoteSearchResult <NoteSearchResult
v-for="(item, index) in getCombinedResults(inputText)" v-for="(item, index) in getCombinedResults(inputText)"
:key="(item.data.key || item.data.id) + '-' + index" :key="item.type + '-' + (item.data.key || item.data._id || item.data.id) + '-' + index"
:title="item.type === 'note' ? item.data.title : item.data.label" :title="resultTitle(item)"
:subtitle="item.type === 'action' ? item.data.description : ''" :subtitle="resultSubtitle(item)"
:link="item.type === 'note' ? item.data.key : null" :icon="resultIcon(item)"
:icon="item.type === 'action' ? PlusIcon : ''"
:class="{ selected: index === selectedIndex }" :class="{ selected: index === selectedIndex }"
@select="onSelect" @click.stop.prevent="openResult(item)"
@click.stop.prevent="() => { if (item.type === 'note') openNote(item.data); else handleActionSelect(item.data); }"
/> />
</div> </div>
</div> </div>

View File

@@ -89,9 +89,11 @@ onMounted(() => {
.steps { .steps {
margin-left: 8px; margin-left: 8px;
height: 22px; height: 22px;
> { }
/* No nested `> {}` here: the scoped style transform turns it into a dangling
combinator, which the current CSS minifier rejects. */
.steps > * {
font-size: 12px; font-size: 12px;
}
} }
.steps :deep(.roll-val){ .steps :deep(.roll-val){
display: inline-flex; display: inline-flex;

View File

@@ -115,7 +115,7 @@ async function SignIn() {
} }
// El token passa al servei d'usuari perquè el client el reutilitzi en connectar. // El token passa al servei d'usuari perquè el client el reutilitzi en connectar.
SetUser(response.data.token); SetUser(response.data.token, true);
password.value = ''; password.value = '';
AskForLogin(); AskForLogin();
} catch { } catch {

View File

@@ -0,0 +1,289 @@
<script setup>
import { onMounted, ref } from 'vue';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { DisplayToast } from '~/services/Toaster';
import { GetUser } from '@/services/User';
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
const handle = ref(null);
const wrapper = ref(null);
const props = defineProps(['data']);
const data = props.data;
const id = data.id;
// The admin standing in front of the window: their own row keeps the switches closed,
// the server answers the same to anybody who still tries (routes/user.js).
const currentUserId = GetUser()?._id;
const users = ref([]);
const busy = ref("");
const creating = ref(false);
const name = ref("");
const username = ref("");
const email = ref("");
const password = ref("");
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {width: 620, height: 520});
ResetPosition(id, "center");
SetResizable(id, true);
SetMinSize(id, {width: 460, height: 360});
LoadUsers();
});
async function LoadUsers(){
try {
const response = await Server().get('/user/list');
if(response.data.status !== 'ok') return;
users.value = response.data.users || [];
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
}
}
function ClearForm(){
name.value = "";
username.value = "";
email.value = "";
password.value = "";
}
async function CreateAccount(){
// The checks the register window makes before it asks the server for an account
if(username.value.length < 3){
DisplayToast('red', $t('settings.site-administration.accounts.errors.username-empty'), 3000);
return;
}
if(email.value.length < 5 || !email.value.includes('@')){
DisplayToast('red', $t('settings.site-administration.accounts.errors.email-empty'), 3000);
return;
}
if(name.value.length == 0){
DisplayToast('red', $t('settings.site-administration.accounts.errors.name-empty'), 3000);
return;
}
if(password.value.length == 0){
DisplayToast('red', $t('settings.site-administration.accounts.errors.password-empty'), 3000);
return;
}
creating.value = true;
try {
const response = await Server().post('/user/create', {
name: name.value,
username: username.value,
email: email.value,
password: password.value
});
if(response.data.status !== 'ok'){
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
users.value.push(response.data.user);
ClearForm();
DisplayToast('green', $t('settings.site-administration.accounts.created'), 3000);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
creating.value = false;
}
}
async function ToggleAdmin(user){
busy.value = user._id;
try {
const response = await Server().post('/user/set-admin', { id: user._id, admin: !user.admin });
if(response.data.status !== 'ok'){
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
user.admin = response.data.user.admin;
DisplayToast('green', $t('settings.site-administration.accounts.updated'), 3000);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
busy.value = "";
}
}
async function DeleteAccount(user){
busy.value = user._id;
try {
const response = await Server().post('/user/delete', { id: user._id });
if(response.data.status !== 'ok'){
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return;
}
users.value = users.value.filter((account) => account._id !== user._id);
DisplayToast('green', $t('settings.site-administration.accounts.deleted'), 3000);
} catch {
DisplayToast('red', $t('errors.internal'), 3000);
} finally {
busy.value = "";
}
}
function IsSelf(user){
return user._id === currentUserId;
}
</script>
<template>
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle"></WindowHandle>
<!-- Body -->
<div class="accounts-body">
<div class="accounts-list">
<div v-for="user in users" :key="user._id" class="account-row">
<div class="account-info">
<span class="account-name">{{ user.name }} <span v-if="IsSelf(user)" class="account-self">({{ $t('settings.site-administration.accounts.you') }})</span></span>
<span class="account-line">@{{ user.username }}</span>
<span class="account-line">{{ user.email }}</span>
<span v-if="user.admin" class="account-admin">{{ $t('settings.site-administration.accounts.admin') }}</span>
</div>
<div class="account-actions" v-if="!IsSelf(user)">
<button class="btn-primary button-small sound-click" type="button" :disabled="busy !== ''" v-on:click.prevent="ToggleAdmin(user)">
{{ user.admin ? $t('settings.site-administration.accounts.remove-admin') : $t('settings.site-administration.accounts.make-admin') }}
</button>
<button class="btn-primary button-small danger sound-click" type="button" :disabled="busy !== ''" v-on:click.prevent="DeleteAccount(user)">
{{ $t('settings.site-administration.accounts.delete') }}
</button>
</div>
</div>
</div>
<form class="new-account" v-on:submit.prevent="CreateAccount">
<h3>{{ $t('settings.site-administration.accounts.new-account') }}</h3>
<div class="form-field">
<label for="account-name-field">{{$t('settings.site-administration.accounts.name')}}</label>
<input id="account-name-field" type="text" name="name" v-model="name" autocomplete="off">
</div>
<div class="form-field">
<label for="account-username-field">{{$t('settings.site-administration.accounts.username')}}</label>
<input id="account-username-field" type="text" name="username" v-model="username" autocomplete="off">
</div>
<div class="form-field">
<label for="account-email-field">{{$t('settings.site-administration.accounts.email')}}</label>
<input id="account-email-field" type="email" name="email" v-model="email" autocomplete="off">
</div>
<div class="form-field">
<label for="account-password-field">{{$t('settings.site-administration.accounts.password')}}</label>
<input id="account-password-field" type="password" name="password" v-model="password" autocomplete="off">
</div>
<div class="form-field">
<button class="btn-primary sound-click" type="submit" :disabled="creating">
{{ $t('settings.site-administration.accounts.create') }}
</button>
</div>
</form>
</div>
</div>
</template>
<style scoped>
.window-wrapper {
display: flex;
flex-direction: column;
align-items: center;
user-select: none;
}
.accounts-body {
display: flex;
flex-direction: column;
flex: 1;
width: 100%;
min-height: 0;
}
.accounts-list {
flex: 1;
overflow-y: auto;
display: flex;
flex-direction: column;
gap: 8px;
padding: 16px;
}
.account-row {
display: flex;
justify-content: space-between;
align-items: center;
gap: 10px;
padding: 10px 12px;
border: 1px solid var(--color-border);
border-radius: 6px;
background-color: var(--color-background-soft);
}
.account-info {
display: flex;
flex-direction: column;
min-width: 0;
}
.account-name {
font-weight: bold;
}
.account-line {
font-size: 13px;
opacity: 0.75;
overflow-wrap: anywhere;
}
.account-self {
font-weight: normal;
opacity: 0.75;
}
.account-admin {
color: var(--color-green);
font-size: 13px;
}
.account-actions {
display: flex;
gap: 8px;
}
.danger {
color: var(--color-red);
}
.new-account {
padding: 0 16px 16px 16px;
border-top: 1px solid var(--color-border);
}
.new-account h3 {
font-family: MrEavesRemake;
}
.form-field {
display: flex;
flex-direction: column;
gap: 4px;
margin-bottom: 10px;
}
.form-field input {
width: 100%;
box-sizing: border-box;
}
label {
text-align: left;
}
</style>

View File

@@ -24,6 +24,16 @@ const abilityStats = [
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' } { key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
]; ];
// Les pestanyes del lateral dret reparteixen la fitxa: característiques i combat,
// inventari, trets i conjurs. Són pestanyes de marcadors, no una pàgina nova.
const tabs = [
{ key: 'abilities', label: 'campaigns.character-sheet.tabs.abilities' },
{ key: 'inventory', label: 'campaigns.character-sheet.tabs.inventory' },
{ key: 'traits', label: 'campaigns.character-sheet.tabs.traits' },
{ key: 'spells', label: 'campaigns.character-sheet.tabs.spells' }
];
const activeTab = ref('abilities');
function normalizeActor(actor) { function normalizeActor(actor) {
return { return {
name: actor?.name ?? '', name: actor?.name ?? '',
@@ -207,7 +217,9 @@ async function saveSheet() {
<div v-if="error" class="sheet-error">{{ error }}</div> <div v-if="error" class="sheet-error">{{ error }}</div>
<main class="sheet-grid"> <div class="sheet-layout">
<div class="sheet-content">
<main v-show="activeTab === 'abilities'" class="sheet-grid">
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }"> <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')"> <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"> <button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
@@ -256,19 +268,9 @@ async function saveSheet() {
<textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" /> <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> <p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
</section> </section>
</main>
<section class="sheet-panel traits-panel"> <main v-show="activeTab === 'inventory'" class="sheet-tab-body">
<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"> <section class="sheet-panel inventory-panel">
<div class="panel-title-row"> <div class="panel-title-row">
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2> <h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
@@ -302,6 +304,37 @@ async function saveSheet() {
</div> </div>
</section> </section>
</main> </main>
<main v-show="activeTab === 'traits'" class="sheet-tab-body">
<section class="sheet-panel traits-panel">
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
<textarea v-if="editing" v-model="form.traits" rows="12" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
</section>
</main>
<main v-show="activeTab === 'spells'" class="sheet-tab-body">
<section class="sheet-panel spells-panel">
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
<textarea v-if="editing" v-model="form.spells" rows="12" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
</section>
</main>
</div>
<nav class="sheet-tabs" role="tablist" aria-orientation="vertical">
<button
v-for="tab in tabs"
:key="tab.key"
class="sheet-tab"
:class="{ active: activeTab === tab.key }"
type="button"
role="tab"
:aria-selected="activeTab === tab.key"
@click="activeTab = tab.key"
>{{ $t(tab.label) }}</button>
</nav>
</div>
</div> </div>
</div> </div>
</template> </template>
@@ -325,7 +358,27 @@ async function saveSheet() {
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); } .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:disabled { opacity: .55; cursor: wait; }
.sheet-button.compact { padding: 5px 9px; font-size: 12px; } .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-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto; gap: 11px; align-items: start; }
.sheet-layout { display: flex; align-items: flex-start; gap: 10px; }
.sheet-content { flex: 1 1 auto; min-width: 0; }
.sheet-tab-body { display: block; }
.sheet-tabs { flex: 0 0 auto; display: flex; flex-direction: column; gap: 6px; position: sticky; top: 0; align-self: flex-start; }
.sheet-tab {
text-align: left;
padding: 9px 14px 9px 11px;
border: 1px solid var(--color-border);
border-left-width: 3px;
border-radius: 0 9px 9px 0;
background: var(--color-background-soft);
color: var(--color-text);
font: 13px MrEavesRemake;
letter-spacing: .02em;
white-space: nowrap;
cursor: pointer;
transition: background .15s ease, border-color .15s ease, color .15s ease;
}
.sheet-tab:hover { background: var(--color-button-hover); }
.sheet-tab.active { background: var(--color-background-light); color: var(--color-link); border-left-color: var(--color-link); box-shadow: 0 3px 12px var(--color-window-shadow); }
.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 { 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 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-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
@@ -340,9 +393,7 @@ async function saveSheet() {
.portrait-controls button:disabled { opacity: .55; cursor: wait; } .portrait-controls button:disabled { opacity: .55; cursor: wait; }
.photo-input { display: none; } .photo-input { display: none; }
.abilities-panel { grid-column: 2 / -1; grid-row: 1; } .abilities-panel { grid-column: 2 / -1; grid-row: 1; }
.combat-panel { grid-column: 2; grid-row: 2; } .combat-panel { grid-column: 2 / -1; 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-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-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-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
@@ -369,7 +420,6 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
.weight-summary strong { white-space: nowrap; } .weight-summary strong { white-space: nowrap; }
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); } .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; } .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-wrap { overflow-x: auto; }
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; } .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 th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
@@ -383,17 +433,17 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; } .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; } .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) { @media (max-width: 760px) {
.sheet-grid { grid-template-columns: 1fr 1fr; grid-template-rows: none; } .sheet-grid { grid-template-columns: 1fr; grid-template-rows: none; }
.sheet-portrait { grid-column: 1 / -1; grid-row: auto; } .sheet-portrait, .abilities-panel, .combat-panel { 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) { @media (max-width: 520px) {
.sheet-body { padding: 10px; } .sheet-body { padding: 10px; }
.sheet-hero { align-items: flex-start; flex-wrap: wrap; } .sheet-hero { align-items: flex-start; flex-wrap: wrap; }
.sheet-actions { margin-left: auto; } .sheet-actions { margin-left: auto; }
.sheet-grid { grid-template-columns: 1fr; }
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); } .ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
.sheet-layout { flex-direction: column; }
.sheet-tabs { flex-direction: row; flex-wrap: wrap; order: -1; }
.sheet-tab { flex: 1 1 auto; text-align: center; border-radius: 7px; border-left-width: 1px; border-top-width: 3px; }
.sheet-tab.active { border-left-color: var(--color-border); border-top-color: var(--color-link); }
} }
</style> </style>

View File

@@ -0,0 +1,166 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
import { useI18n } from 'vue-i18n';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, SetResizable, SetMinSize } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server from '~/services/Server';
import { emitter } from '~/services/Emitter';
const props = defineProps(['data']);
const id = props.data.id;
const itemId = props.data.item?._id;
const campaign = props.data.campaign || '';
const ICON_ROOT = 'icons';
const handle = ref(null);
const wrapper = ref(null);
const loading = ref(false);
const error = ref('');
const applying = ref('');
// What the window is standing on: one folder of Foundry's icon library at a time.
const listing = ref({ dir: ICON_ROOT, parent: null, folders: [], files: [], next: null });
const { t } = useI18n();
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 560, height: 540 });
ResetPosition(id, 'center');
SetResizable(id, true);
SetMinSize(id, { width: 420, height: 340 });
Load(ICON_ROOT);
});
onBeforeUnmount(() => ClearWindow({ type: 'foundry_icons' }));
// One request per folder, and the icons inside it a page at a time: that library
// runs into the thousands, so the window only ever asks for what it shows.
async function Load(dir, offset = 0) {
if (loading.value) return;
if (!campaign) {
error.value = t('foundry.errors.icons-no-world-url');
return;
}
loading.value = true;
error.value = '';
try {
const params = new URLSearchParams({ campaign, dir });
if (offset) params.set('offset', String(offset));
const response = await Server().get(`/foundry/icons?${params.toString()}`);
if (response.data.status !== 'ok') {
error.value = t(response.data.msg || 'foundry.errors.icons-unavailable');
return;
}
const page = {
dir: response.data.dir || dir,
parent: response.data.parent ?? null,
folders: response.data.folders || [],
files: response.data.files || [],
next: response.data.next ?? null,
};
listing.value = offset
? { ...page, files: [...listing.value.files, ...page.files] }
: page;
} catch (requestError) {
error.value = t('foundry.errors.icons-unavailable');
} finally {
loading.value = false;
}
}
const trail = computed(() => {
const parts = String(listing.value.dir || ICON_ROOT).split('/').filter(Boolean);
return parts.map((name, index) => ({ name, path: parts.slice(0, index + 1).join('/') }));
});
const empty = computed(() => !loading.value && !listing.value.folders.length && !listing.value.files.length);
function GoUp() {
Load(listing.value.parent || ICON_ROOT);
}
// The icon is stored as the url the browser loads it from, the same shape a synced
// Foundry item's icon has; the item window follows the event this leaves behind.
async function Choose(icon) {
if (applying.value) return;
applying.value = icon.path;
error.value = '';
try {
const response = await Server().post('/item/update', { id: itemId, image: icon.url });
if (response.data.status !== 'ok') {
error.value = t('campaigns.item.sheet.save-error');
return;
}
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
ClearWindow({ type: 'foundry_icons' });
ClearWindow({ type: 'item_icon_source' });
} catch (requestError) {
error.value = t('campaigns.item.sheet.save-error');
} finally {
applying.value = '';
}
}
</script>
<template>
<div class="window-wrapper foundry-icons-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="icons-body">
<nav class="icons-trail" :aria-label="$t('foundry.icons.path')">
<button class="trail-up" type="button" :disabled="loading || !listing.parent" :aria-label="$t('foundry.icons.up')" @click="GoUp">
<img class="icon" src="/icons/iconoir/regular/arrow-up.svg" alt="" aria-hidden="true">
</button>
<template v-for="crumb in trail" :key="crumb.path">
<span class="trail-separator" aria-hidden="true">/</span>
<button class="trail-crumb" type="button" :disabled="loading" @click="Load(crumb.path)">{{ crumb.name }}</button>
</template>
</nav>
<div v-if="error" class="icons-error">{{ error }}</div>
<p v-if="loading" class="icons-state">{{ $t('foundry.icons.loading') }}</p>
<p v-else-if="empty" class="icons-state">{{ $t('foundry.icons.empty') }}</p>
<div v-if="listing.folders.length" class="icon-tiles">
<button v-for="folder in listing.folders" :key="folder.path" class="icon-tile folder" type="button" :disabled="loading" @click="Load(folder.path)">
<img class="icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
<span class="tile-name">{{ folder.name }}</span>
</button>
</div>
<div v-if="listing.files.length" class="icon-tiles">
<button v-for="icon in listing.files" :key="icon.path" class="icon-tile" type="button"
:disabled="applying !== ''" :title="icon.name" @click="Choose(icon)">
<img class="tile-image" :src="icon.url" :alt="icon.name" loading="lazy">
<span class="tile-name">{{ icon.name }}</span>
</button>
</div>
<button v-if="listing.next" class="icons-more sheet-button" type="button" :disabled="loading" @click="Load(listing.dir, listing.next)">
{{ $t('foundry.icons.load-more') }}
</button>
</div>
</div>
</template>
<style scoped>
.foundry-icons-window { min-width: 0; min-height: 0; }
.icons-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 12px 14px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 10px; }
.icons-trail { display: flex; align-items: center; flex-wrap: wrap; gap: 4px; position: sticky; top: 0; padding-bottom: 8px; background: var(--color-window-background); font-size: 12px; }
.trail-up, .trail-crumb { display: inline-flex; align-items: center; padding: 4px 7px; border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; font-size: 12px; }
.trail-up:hover, .trail-crumb:hover { background: var(--color-button-hover); }
.trail-up:disabled, .trail-crumb:disabled { opacity: .5; cursor: wait; }
.trail-separator { opacity: .45; }
.icons-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.icons-state { margin: 0; font-size: 12px; opacity: .7; }
.icon-tiles { display: grid; grid-template-columns: repeat(auto-fill, minmax(78px, 1fr)); gap: 8px; }
.icon-tile { display: flex; flex-direction: column; align-items: center; gap: 5px; padding: 8px 6px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
.icon-tile:hover { background: var(--color-button-hover); border-color: var(--color-link); }
.icon-tile:disabled { opacity: .55; cursor: wait; }
.icon-tile.folder { justify-content: center; }
.icon-tile .icon { width: 22px; height: 22px; }
.tile-image { width: 40px; height: 40px; object-fit: contain; }
.tile-name { max-width: 100%; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; font-size: 10px; opacity: .75; }
.icons-more { align-self: center; 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; font-size: 13px; }
.icons-more:hover { background: var(--color-button-hover); }
.icons-more:disabled { opacity: .55; cursor: wait; }
</style>

View File

@@ -0,0 +1,128 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
import { useI18n } from 'vue-i18n';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
const props = defineProps(['data']);
const id = props.data.id;
const item = props.data.item || {};
const itemId = item._id;
const campaign = props.data.campaign || '';
const handle = ref(null);
const wrapper = ref(null);
const error = ref('');
const uploading = ref(false);
const photoInput = ref(null);
const image = ref(item.image || '');
const { t } = useI18n();
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 430, height: 320 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => ClearWindow({ type: 'item_icon_source' }));
// An uploaded icon is a file of the backend's uploads folder and a Foundry one an
// absolute url of the world; both are drawn the way the item window draws them.
const imageUrl = computed(() => {
if (!image.value) return '';
return /^(https?:|data:|\/\/)/i.test(image.value)
? image.value
: `${getBaseUrl()}/public/${image.value}`;
});
function pickLocalIcon() {
photoInput.value?.click();
}
// The icon browser opens on top of this window, as its child: closing the chooser
// takes the browser with it, like every other child window here.
function openFoundryIcons() {
CreateChildWindow(id, 'foundry_icons', { item: { _id: itemId, name: item.name }, campaign });
}
async function onIconSelected(event) {
const file = event.target.files?.[0];
event.target.value = '';
if (!file || uploading.value) return;
uploading.value = true;
error.value = '';
try {
const formData = new FormData();
formData.append('image', file);
const response = await Server().post(`/item/upload-image?item=${itemId}`, formData, {
headers: { "Content-Type": "multipart/form-data" }
});
if (response.data.status !== 'ok') {
error.value = t('campaigns.item.sheet.upload-error');
return;
}
// The item window follows this event and shows the new icon.
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
ClearWindow({ id });
} catch (requestError) {
error.value = t('campaigns.item.sheet.upload-error');
} finally {
uploading.value = false;
}
}
</script>
<template>
<div class="window-wrapper icon-source-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="source-body">
<header class="source-hero">
<div class="source-icon" :class="{ empty: !image }">
<img v-if="imageUrl" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
<span v-else aria-hidden="true">{{ (item.name || '?').slice(0, 1).toUpperCase() }}</span>
</div>
<p class="source-intro">{{ $t('campaigns.item.icon-picker.intro') }}</p>
</header>
<div v-if="error" class="source-error">{{ error }}</div>
<div class="source-options">
<button class="source-option" type="button" :disabled="uploading" @click="pickLocalIcon">
<img class="icon" src="/icons/iconoir/regular/cloud-upload.svg" alt="" aria-hidden="true">
<span class="source-option-title">{{ uploading
? $t('campaigns.item.sheet.uploading')
: $t('campaigns.item.icon-picker.upload') }}</span>
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.upload-hint') }}</span>
</button>
<button class="source-option" type="button" @click="openFoundryIcons">
<img class="icon" src="/icons/iconoir/regular/media-image.svg" alt="" aria-hidden="true">
<span class="source-option-title">{{ $t('campaigns.item.icon-picker.foundry') }}</span>
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.foundry-hint') }}</span>
</button>
</div>
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onIconSelected">
</div>
</div>
</template>
<style scoped>
.icon-source-window { min-width: 0; min-height: 0; }
.source-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 12px; }
.source-hero { display: flex; align-items: center; gap: 13px; padding-bottom: 12px; border-bottom: 1px solid var(--color-border); }
.source-icon { width: 56px; height: 56px; flex: 0 0 56px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 26px MrEavesRemake; }
.source-icon.empty { border-style: dashed; }
.source-icon img { width: 100%; height: 100%; object-fit: contain; }
.source-intro { margin: 0; font-size: 13px; opacity: .85; }
.source-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.source-options { display: flex; flex-direction: column; gap: 10px; }
.source-option { display: grid; grid-template-columns: 26px 1fr; align-items: center; gap: 4px 10px; padding: 12px 14px; text-align: left; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
.source-option:hover { background: var(--color-button-hover); }
.source-option:disabled { opacity: .55; cursor: wait; }
.source-option .icon { width: 20px; height: 20px; grid-row: span 2; }
.source-option-title { font: 15px MrEavesRemake; }
.source-option-hint { font-size: 12px; opacity: .7; }
.photo-input { display: none; }
</style>

View File

@@ -0,0 +1,200 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
import { useI18n } from 'vue-i18n';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import Server, { getBaseUrl } from '~/services/Server';
import { useCampaignService } from '~/services/Campaign.js';
import { emitter } from '~/services/Emitter';
const props = defineProps(['data']);
const id = props.data.id;
const itemId = props.data.item?._id;
const handle = ref(null);
const wrapper = ref(null);
const error = ref('');
// Set while this window writes the item's icon, so a Foundry sync landing behind
// the window does not rewrite the form under the change being made.
const applyingIcon = ref(false);
const { Campaign } = useCampaignService();
const { t } = useI18n();
function normalizeItem(item) {
return {
name: item?.name ?? '',
category: item?.category ?? 'adventuring-gear',
rarity: item?.rarity ?? 'common',
quantity: Number(item?.quantity ?? 1),
weight: item?.weight ?? '',
properties: item?.properties ?? '',
description: item?.description ?? '',
image: item?.image ?? '',
foundryItemId: item?.foundryItemId ?? '',
foundryImage: item?.foundryImage ?? ''
};
}
const form = ref(normalizeItem(props.data.item));
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, { width: 460, height: 560 });
ResetPosition(id, 'center');
});
onBeforeUnmount(() => ClearWindow({ type: 'item_sheet' }));
// The sidebar keeps this entry fresh (Foundry sync lands in the background);
// follow along unless this window is mid-icon-change. The icon windows leave
// their result here, on the same event.
function handleItemSync({ entityType, entry }) {
if (entityType !== 'item' || entry?._id !== itemId || applyingIcon.value) return;
form.value = normalizeItem(entry);
}
onMounted(() => emitter.on('campaign-entry-updated', handleItemSync));
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleItemSync));
const imageUrl = computed(() => {
if (!form.value.image) return '';
return /^(https?:|data:|\/\/)/i.test(form.value.image)
? form.value.image
: `${getBaseUrl()}/public/${form.value.image}`;
});
const canUseFoundryIcon = computed(() => Boolean(form.value.foundryImage) && form.value.foundryImage !== form.value.image);
async function updateItem(payload) {
const response = await Server().post('/item/update', { id: itemId, ...payload });
if (response.data.status !== 'ok') return false;
form.value = normalizeItem(response.data.item);
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
return true;
}
// Choosing an icon is a window of its own: upload one from this device, or browse
// the icon library of the linked Foundry world. Both leave their result on the
// `campaign-entry-updated` event, which this window follows.
function chooseIcon() {
CreateChildWindow(id, 'item_icon_source', {
item: { _id: itemId, name: form.value.name, image: form.value.image },
campaign: Campaign.value?._id || ''
});
}
// The world's own icon for this item: the module keeps it on the item, so this
// just switches back to it. Picking one of the world's other icons is what the
// icon browser is for.
async function useFoundryIcon() {
if (!canUseFoundryIcon.value || applyingIcon.value) return;
applyingIcon.value = true;
error.value = '';
try {
const done = await updateItem({ image: form.value.foundryImage });
if (!done) error.value = t('campaigns.item.sheet.save-error');
} catch (requestError) {
error.value = t('campaigns.item.sheet.save-error');
} finally {
applyingIcon.value = false;
}
}
async function removeIcon() {
if (!form.value.image || applyingIcon.value) return;
applyingIcon.value = true;
error.value = '';
try {
const done = await updateItem({ image: '' });
if (!done) error.value = t('campaigns.item.sheet.save-error');
} catch (requestError) {
error.value = t('campaigns.item.sheet.save-error');
} finally {
applyingIcon.value = false;
}
}
</script>
<template>
<div class="window-wrapper item-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="item-body">
<header class="item-hero">
<button class="item-icon" :class="{ empty: !form.image }" type="button"
:aria-label="$t(form.image ? 'campaigns.item.sheet.change-icon' : 'campaigns.item.sheet.choose-icon')"
@click="chooseIcon">
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
<span v-else aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</span>
</button>
<div class="item-identity">
<h1>{{ form.name }}</h1>
<div class="item-tags">
<span class="item-tag">{{ $t(`campaigns.item.categories.${form.category}`) }}</span>
<span class="item-tag">{{ $t(`campaigns.item.rarities.${form.rarity}`) }}</span>
<span v-if="form.foundryItemId" class="item-tag synced">{{ $t('campaigns.synced') }}</span>
</div>
</div>
</header>
<div v-if="error" class="item-error">{{ error }}</div>
<div class="icon-controls">
<button class="sheet-button" type="button" @click="chooseIcon">
{{ form.image ? $t('campaigns.item.sheet.change-icon') : $t('campaigns.item.sheet.choose-icon') }}
</button>
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingIcon" @click="useFoundryIcon">
{{ $t('campaigns.item.sheet.foundry-icon') }}
</button>
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="applyingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
</div>
<dl class="item-facts">
<div class="item-fact">
<dt>{{ $t('campaigns.item.quantity') }}</dt>
<dd>{{ form.quantity }}</dd>
</div>
<div v-if="form.weight !== '' && form.weight !== undefined" class="item-fact">
<dt>{{ $t('campaigns.item.weight') }}</dt>
<dd>{{ Number(form.weight).toFixed(1) }} lb</dd>
</div>
</dl>
<section v-if="form.properties" class="item-section">
<h2>{{ $t('campaigns.item.properties') }}</h2>
<p class="item-copy">{{ form.properties }}</p>
</section>
<section class="item-section">
<h2>{{ $t('campaigns.fields.description') }}</h2>
<p class="item-copy">{{ form.description || $t('campaigns.item.sheet.no-description') }}</p>
</section>
</div>
</div>
</template>
<style scoped>
.item-window { min-width: 0; min-height: 0; }
.item-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; }
.item-hero { display: flex; align-items: center; gap: 13px; padding: 2px 2px 13px; margin-bottom: 11px; border-bottom: 1px solid var(--color-border); }
.item-icon { width: 64px; height: 64px; flex: 0 0 64px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 30px MrEavesRemake; padding: 0; cursor: pointer; }
.item-icon:hover { border-color: var(--color-link); }
.item-icon.empty { border-style: dashed; }
.item-icon img { width: 100%; height: 100%; object-fit: contain; }
.item-identity { min-width: 0; }
.item-identity h1 { margin: 0 0 6px; font: 24px MrEavesRemake; overflow-wrap: anywhere; }
.item-tags { display: flex; align-items: center; flex-wrap: wrap; gap: 6px; }
.item-tag { padding: 3px 9px; border: 1px solid var(--color-border); border-radius: 999px; background: var(--color-background-soft); font-size: 12px; opacity: .9; }
.item-tag.synced { font-size: 10px; letter-spacing: .04em; text-transform: uppercase; opacity: .6; }
.item-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.icon-controls { display: flex; align-items: center; flex-wrap: wrap; gap: 7px; margin-bottom: 13px; }
.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; font-size: 13px; }
.sheet-button:hover { background: var(--color-button-hover); }
.sheet-button:disabled { opacity: .55; cursor: wait; }
.item-facts { display: flex; flex-wrap: wrap; gap: 8px; margin: 0 0 13px; }
.item-fact { flex: 1 1 120px; min-width: 0; padding: 9px 11px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
.item-fact dt { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
.item-fact dd { margin: 3px 0 0; font: 17px MrEavesRemake; }
.item-section { padding: 11px 13px; margin: 0 0 10px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); }
.item-section h2 { margin: 0 0 8px; padding-bottom: 6px; border-bottom: 1px solid var(--color-border); font: 15px MrEavesRemake; letter-spacing: .03em; }
.item-copy { margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
</style>

View File

@@ -26,6 +26,7 @@ let id = data.id;
const username = ref(""); const username = ref("");
const password = ref(""); const password = ref("");
const remember = ref(true);
const loading = ref(false); const loading = ref(false);
@@ -44,14 +45,14 @@ function ShowMainMenu(){
function login() { function login() {
loading.value = true; loading.value = true;
Server().post('/user/login', { usermail: username.value, password: password.value }).then((response) => { Server().post('/user/login', { usermail: username.value, password: password.value, remember: remember.value }).then((response) => {
loading.value = false; loading.value = false;
const data = response.data; const data = response.data;
if(data.status == "error"){ if(data.status == "error"){
DisplayToast('red', $t(data.msg), 3000) DisplayToast('red', $t(data.msg), 3000)
} else { } else {
SetUser(data.token); SetUser(data.token, remember.value);
DisplayToast('green', $t('login.success'), 3000); DisplayToast('green', $t('login.success'), 3000);
ShowMainMenu(); ShowMainMenu();
} }
@@ -89,6 +90,12 @@ function toRegister(){
<label for="password">{{$t('login.password')}}</label> <label for="password">{{$t('login.password')}}</label>
<input id="password-field" type="password" :placeholder="$t('login.password-placeholder')" name="password" v-model="password" autocomplete="off" > <input id="password-field" type="password" :placeholder="$t('login.password-placeholder')" name="password" v-model="password" autocomplete="off" >
</div> </div>
<div class="form-field">
<label class="remember-me-label">
<input type="checkbox" name="remember" v-model="remember">
<span>{{$t('login.remember-me')}}</span>
</label>
</div>
<div class="form-field"> <div class="form-field">
<button class="btn-primary sound-click"> <button class="btn-primary sound-click">
<span v-if="loading"> <span v-if="loading">
@@ -146,6 +153,14 @@ label {
text-align: center; text-align: center;
} }
.remember-me-label {
display: flex;
flex-direction: row;
align-items: center;
gap: 8px;
cursor: pointer;
}
</style> </style>

View File

@@ -40,6 +40,10 @@ function confirmSave() {
const url = creating ? '/folder/rename' : '/folder/create'; const url = creating ? '/folder/rename' : '/folder/create';
if (creating) { if (creating) {
folderData.id = data.folderId; folderData.id = data.folderId;
} else {
// Which campaign list the folder belongs to: the notes when the caller says
// nothing, one of the entry lists when their sidebar button opens this window.
folderData.target = data.target ?? 'note';
} }
Server().post(url, folderData).then((response) => { Server().post(url, folderData).then((response) => {

View File

@@ -0,0 +1,122 @@
<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

@@ -16,13 +16,6 @@ const data = props.data;
const { locale } = useI18n(); const { locale } = useI18n();
const changeLocale = (lang) => {
console.log(lang);
locale.value = lang.code;
SetUserSetting('lang', lang.code);
}
const id = data.id; const id = data.id;
const rows = ref([{id: "account-settings", value: "settings.tabs.account-settings"}]); const rows = ref([{id: "account-settings", value: "settings.tabs.account-settings"}]);
@@ -37,13 +30,40 @@ function getLocaleFromCode(code){
} }
} }
const selectedLocale = ref(""); // The language to show in the dropdown: always one Dragonroll offers, because a
// user that never picked one has none stored.
function localeToShow(code){
return getLocaleFromCode(code) || locales[0];
}
// vue-i18n answers every translation with `SyntaxError: cannot support locale type`
// once it is given a locale it has no messages for, and the locale is global: putting
// a language that is not stored (the server answers `settings: undefined` for a user
// that never picked one) or one no longer offered took the settings window and the
// main menu behind it down (issue #47). Only known codes go into `locale`.
function applyLanguage(code){
const stored = getLocaleFromCode(code);
if(!stored) return false;
locale.value = stored.code;
selectedLocale.value = stored;
return true;
}
const selectedLocale = ref(localeToShow(locale.value));
const changeLocale = (lang) => {
if(!applyLanguage(lang?.code)) return;
SetUserSetting('lang', lang.code);
}
onBeforeMount(() => { onBeforeMount(() => {
GetUserSetting('lang').then(value => { // Set selected in dropdown. Without settings to read from the server the language
locale.value = value; // Dragonroll is already showing stays the one on screen.
selectedLocale.value = getLocaleFromCode(value); // Set selected in dropdown GetUserSetting('lang')
}); .then((value) => applyLanguage(value))
if(GetUser().admin) rows.value.push({ .catch(() => {});
if(GetUser()?.admin) rows.value.push({
id: "site-administration", id: "site-administration",
value: "settings.tabs.site-administration" value: "settings.tabs.site-administration"
}); });
@@ -60,25 +80,19 @@ onMounted(() => {
}); });
function OpenManageAccounts(){ function OpenManageAccounts(){
ClearWindow('settings'); ClearWindow({ type: 'settings' });
CreateWindow('account_management', { CreateWindow('account_management', {
type: 'account_management', // Back returns to the settings tab this button sits on; CreateWindow leaves
title: 'settings.site-administration.manage-accounts.title', // a window that is already open alone.
id: 'account-management',
back: () => { back: () => {
ClearWindow('account-management') ClearWindow({ type: 'account_management' });
CreateWindow('settings', { CreateWindow('settings');
id: 'settings',
type: 'settings',
title: 'settings.title',
back: () => { ClearWindow('settings'); CreateWindow('main_menu'); }
});
} }
}) });
} }
const getLocaleName = (locale) => { const getLocaleName = (locale) => {
return locale.name; return locale ? locale.name : "";
} }
</script> </script>

View File

@@ -0,0 +1,27 @@
// The colours a note, a folder or an entry row can be given, and shown as swatches in the
// sidebar's colour menus. The list lives here because every campaign section colours its
// rows the same way; nothing in it talks to the API or holds state.
const ENTRY_COLORS = [
{ 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' }
];
// The 'Color' submenu: one swatch per preset colour, and a way back to no colour at all.
// `pick` is called with the colour, or null for the default.
function BuildColorMenu(pick, { defaultLabel = 'Default' } = {}) {
const items = ENTRY_COLORS.map((color) => ({
name: color.name, color: color.value, action: () => pick(color.value)
}));
items.push({ divider: true });
items.push({ name: defaultLabel, icon: '/icons/iconoir/regular/xmark-circle.svg', action: () => pick(null) });
return items;
}
export { ENTRY_COLORS, BuildColorMenu };

View File

@@ -0,0 +1,68 @@
// The rules behind grouping the campaign's items under the folders they stand in.
// Item folders arrive from the linked Foundry world (routes/foundry-link.js mirrors
// its item directory), so the campaign only reads this tree: the helper holds no
// state, talks to no API and builds rows from what `/item/list` already returns.
function ByName(a, b) {
return String(a?.name ?? '').localeCompare(String(b?.name ?? ''));
}
// The folder a folder hangs under. A parent the campaign does not know puts it at
// the root, and so does a parent chain that leads back to the folder itself: a
// broken tree must not hide everything below it.
function ParentKey(folder, knownFolders) {
let parentKey = String(folder.parentFolder ?? '');
if (!parentKey || !knownFolders.has(parentKey)) return '';
const seen = new Set([String(folder._id)]);
while (parentKey) {
if (seen.has(parentKey)) return '';
seen.add(parentKey);
const parent = knownFolders.get(parentKey);
parentKey = knownFolders.has(String(parent?.parentFolder ?? '')) ? String(parent.parentFolder) : '';
}
return String(folder.parentFolder);
}
// The rows of the item list in the order they are shown: every folder followed by
// what stands in it, deeper and deeper, with the items standing at that level last.
// `collapsedFolderIds` hides a folder's whole subtree; folders start open so a
// synced item is never hidden behind a click. Rows are `{ kind: 'folder', key,
// depth, folder }` or `{ kind: 'item', key, depth, item }`. An item whose folder the
// campaign does not know reads as a root item instead of vanishing from the list.
function BuildItemRows(items, folders, collapsedFolderIds = []) {
const knownFolders = new Map((folders ?? []).map((folder) => [String(folder._id), folder]));
const collapsed = new Set((collapsedFolderIds ?? []).map(String));
const childFolders = new Map([['', []]]);
const itemsByFolder = new Map([['', []]]);
for (const folder of knownFolders.values()) {
const parentKey = ParentKey(folder, knownFolders);
if (!childFolders.has(parentKey)) childFolders.set(parentKey, []);
childFolders.get(parentKey).push(folder);
}
for (const item of items ?? []) {
const folderKey = item?.folder && knownFolders.has(String(item.folder)) ? String(item.folder) : '';
if (!itemsByFolder.has(folderKey)) itemsByFolder.set(folderKey, []);
itemsByFolder.get(folderKey).push(item);
}
const rows = [];
const visitedFolders = new Set();
function walk(folderKey, depth) {
for (const folder of (childFolders.get(folderKey) ?? []).slice().sort(ByName)) {
if (visitedFolders.has(String(folder._id))) continue;
visitedFolders.add(String(folder._id));
rows.push({ kind: 'folder', key: `folder-${folder._id}`, depth, folder });
if (!collapsed.has(String(folder._id))) walk(String(folder._id), depth + 1);
}
for (const item of (itemsByFolder.get(folderKey) ?? []).slice().sort(ByName)) {
rows.push({ kind: 'item', key: `item-${item._id}`, depth, item });
}
}
walk('', 0);
return rows;
}
export { BuildItemRows };

View File

@@ -0,0 +1,77 @@
// 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

@@ -0,0 +1,69 @@
// The rules behind the actor tokens of a map (drag an actor from the sidebar onto a map, move the
// token from cell to cell). Like the pins, a token is stored in image pixels, so these helpers only
// translate and snap: they hold no state and talk to no API.
// What the sidebar puts into a drag when an actor row is pulled out of it, so the map knows an actor
// is on its way and nothing else dropped on it (a note, a file) is taken for one.
const ACTOR_DRAG_TYPE = 'application/x-dragonroll-actor';
// The actor id carried by a drag event, or null when the drag carries no actor. `types` is what a
// dragover can see: the data itself is protected until the drop.
function IsActorDrag(event) {
return Array.from(event?.dataTransfer?.types ?? []).includes(ACTOR_DRAG_TYPE);
}
function ActorDragId(event) {
return String(event?.dataTransfer?.getData?.(ACTOR_DRAG_TYPE) ?? '').trim() || null;
}
// The middle of the grid cell a point of the image stands in, in image pixels: this is what a token
// is stored at, so it always stands in a square of the grid. The backend snaps the same way, so a
// token does not move when a drag lands.
function CellCentre(point, grid) {
const size = Math.max(1, Number(grid?.gridSize) || 50);
const offsetX = Number(grid?.offsetX) || 0;
const offsetY = Number(grid?.offsetY) || 0;
const x = Number(point?.x);
const y = Number(point?.y);
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
// Spots off the top left corner count from the corner itself, and only whole pixels count: both
// the way the route reads a coordinate, so the token a drag shows is the token that gets saved.
const column = Math.floor((Math.max(0, Math.round(x)) - offsetX) / size);
const row = Math.floor((Math.max(0, Math.round(y)) - offsetY) / size);
return {
x: Math.max(0, Math.round(offsetX + (column + 0.5) * size)),
y: Math.max(0, Math.round(offsetY + (row + 0.5) * size))
};
}
// A token moved by whole cells (the arrow keys of a focused token): the same cell width the grid is
// drawn with, so a token steps from one square to the next and never in between.
function MoveByCells(centre, grid, columns, rows) {
const size = Math.max(1, Number(grid?.gridSize) || 50);
const x = Number(centre?.x);
const y = Number(centre?.y);
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
return {
x: Math.max(0, Math.round(x + Number(columns) * size)),
y: Math.max(0, Math.round(y + Number(rows) * size))
};
}
// The side of a token in screen pixels: one grid cell, so a token covers the square it stands in at
// every zoom. Never smaller than an icon, or a zoomed-out map would hide its actors.
function TokenSize(grid, zoom) {
const cell = Math.max(1, Number(grid?.gridSize) || 50) * (Number(zoom) || 1);
return Math.round(Math.max(18, cell));
}
export {
ACTOR_DRAG_TYPE,
ActorDragId,
CellCentre,
IsActorDrag,
MoveByCells,
TokenSize
};

View File

@@ -1,4 +1,5 @@
import axios from 'axios'; import axios from 'axios';
import { GetToken } from './TokenStore';
const server = axios.create({ const server = axios.create({
baseURL: 'http://localhost:5000/api', // fallback only baseURL: 'http://localhost:5000/api', // fallback only
@@ -12,7 +13,7 @@ export const initApi = (baseURL) => {
}; };
server.interceptors.request.use((config) => { server.interceptors.request.use((config) => {
const token = localStorage.getItem('token'); const token = GetToken();
if (token) { if (token) {
config.headers.Authorization = `Bearer ${token}`; config.headers.Authorization = `Bearer ${token}`;
} }

View File

@@ -0,0 +1,24 @@
// The login token lives in one of two browser stores: a "remember me" login keeps it in localStorage
// so the session survives on this device, a plain login keeps it in sessionStorage so it ends with the
// browser. Everything that reads the token (Server.js, User.js) goes through GetToken.
function GetToken() {
return sessionStorage.getItem('token') ?? localStorage.getItem('token');
}
function SetToken(token, remember) {
ClearToken();
if (remember) localStorage.setItem('token', token);
else sessionStorage.setItem('token', token);
}
function ClearToken() {
localStorage.removeItem('token');
sessionStorage.removeItem('token');
}
export {
GetToken,
SetToken,
ClearToken
}

View File

@@ -19,7 +19,7 @@ function ShowTooltip(){
animate(tooltip, { animate(tooltip, {
opacity: [0, 1], opacity: [0, 1],
translateY: [20, 0] translateY: [20, 0]
}, {duration: 0.1, ease: 'ease-out'}); }, {duration: 0.1, ease: 'easeOut'});
showed = true; showed = true;
hided = false; hided = false;
} }
@@ -33,7 +33,7 @@ function HideTooltip(){
animate(tooltip, { animate(tooltip, {
opacity: [1, 0], opacity: [1, 0],
translateY: [0, 20] translateY: [0, 20]
}, {duration: 0.1, ease: 'ease-in'}).finished.then(() => tooltip.style.display = "none") }, {duration: 0.1, ease: 'easeIn'}).finished.then(() => tooltip.style.display = "none")
hided = true; hided = true;
showed = false; showed = false;
} }

View File

@@ -1,5 +1,6 @@
import { ref } from 'vue'; import { ref } from 'vue';
import Server from './Server'; import Server from './Server';
import { GetToken, SetToken, ClearToken } from './TokenStore';
const UserStatus = ref(0); const UserStatus = ref(0);
@@ -7,8 +8,8 @@ function parseJwt(token) {
return JSON.parse(atob(token.split('.')[1])); return JSON.parse(atob(token.split('.')[1]));
} }
function SetUser(token){ function SetUser(token, remember){
localStorage.setItem('token', token); SetToken(token, remember);
UserStatus.value = 1; UserStatus.value = 1;
} }
@@ -33,7 +34,7 @@ async function GetUserSetting(key){
} }
function GetUser(){ function GetUser(){
const token = localStorage.getItem('token'); const token = GetToken();
if(token){ if(token){
const data = parseJwt(token); const data = parseJwt(token);
@@ -58,12 +59,11 @@ function IsAdmin(){
} }
function LoadUser(){ function LoadUser(){
const token = localStorage.getItem('token'); if(GetToken()) UserStatus.value = 1;
if(token) UserStatus.value = 1;
} }
function LogoutUser(){ function LogoutUser(){
localStorage.removeItem("token"); ClearToken();
localStorage.removeItem("selectedCampaignId"); localStorage.removeItem("selectedCampaignId");
UserStatus.value = 0; UserStatus.value = 0;
} }

View File

@@ -1,4 +1,4 @@
import { ClearWindow, GetFirstWindowId } from './Windows' import { ClearWindow, CreateWindow, GetFirstWindowId } from './Windows'
/* /*
Put here all dragonroll windows Put here all dragonroll windows
@@ -26,7 +26,18 @@ const defWindows = {
settings: { settings: {
title: "windows.settings", title: "windows.settings",
component: () => import('~/components/windows/SettingsWindow.vue'), component: () => import('~/components/windows/SettingsWindow.vue'),
close: () => ClearWindow({type: 'settings'}), // The settings window is only opened from the main menu, so closing it goes back
// there: CreateWindow leaves a window that is already open alone.
close: () => {
ClearWindow({ type: 'settings' });
CreateWindow('main_menu');
},
movable: true
},
account_management: {
title: 'windows.account-management',
component: () => import('~/components/windows/AccountManagementWindow.vue'),
close: () => ClearWindow({type: 'account_management'}),
movable: true movable: true
}, },
create_campaign: { create_campaign: {
@@ -71,6 +82,27 @@ const defWindows = {
close: () => ClearWindow({type: 'character_sheet'}), close: () => ClearWindow({type: 'character_sheet'}),
movable: true movable: true
}, },
item_sheet: {
title: 'windows.item-sheet',
component: () => import('~/components/windows/ItemSheetWindow.vue'),
close: () => ClearWindow({type: 'item_sheet'}),
movable: true
},
item_icon_source: {
title: 'windows.icon-source',
component: () => import('~/components/windows/ItemIconSourceWindow.vue'),
close: () => ClearWindow({ type: 'item_icon_source' }),
movable: true
},
foundry_icons: {
title: 'windows.foundry-icons',
component: () => import('~/components/windows/FoundryIconPickerWindow.vue'),
// Back closes the icon browser and leaves the chooser it was opened from,
// which is still open behind it.
back: () => ClearWindow({ type: 'foundry_icons' }),
close: () => ClearWindow({ type: 'foundry_icons' }),
movable: true
},
create_map: { create_map: {
title: 'windows.create-map', title: 'windows.create-map',
component: () => import('~/components/windows/CreateMapWindow.vue'), component: () => import('~/components/windows/CreateMapWindow.vue'),
@@ -82,6 +114,12 @@ const defWindows = {
component: () => import('~/components/windows/MapViewerWindow.vue'), component: () => import('~/components/windows/MapViewerWindow.vue'),
close: () => ClearWindow({type: 'map_viewer'}), close: () => ClearWindow({type: 'map_viewer'}),
movable: true movable: true
},
pinned_note: {
title: 'windows.pinned-note',
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
close: () => ClearWindow({type: 'pinned_note'}),
movable: true
} }
} }

View File

@@ -44,6 +44,11 @@
"create": "Crea {section}", "submit": "Crea", "edit": "Edita", "save": "Desa", "delete": "Suprimeix", "saving": "Desant...", "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" "collapse-sidebar": "Redueix la barra lateral", "expand-sidebar": "Expandeix la barra lateral"
}, },
"folders": {
"toggle": "Mostra o amaga la carpeta {name}",
"rename": "Canvia el nom", "color": "Color", "default": "Per defecte", "delete": "Suprimeix la carpeta",
"move-to": "Mou a carpeta...", "root": "Arrel"
},
"states": { "states": {
"loading": "Carregant...", "loading-notes": "Carregant notes...", "empty-notes": "Encara no hi ha notes en aquesta campanya.", "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-actors": "Encara no hi ha actors ni personatges.", "empty-items": "Encara no hi ha objectes en aquesta campanya.",
@@ -62,6 +67,17 @@
"new": "Objecte nou", "edit": "Edita l'objecte", "foundry-sync-note": "Els canvis en aquest objecte també s'apliquen al món del Foundry vinculat.", "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", "category": "Categoria", "rarity": "Raresa", "quantity": "Quantitat",
"quantity-short": "Quant.", "weight": "Pes (lb)", "properties": "Propietats", "properties-placeholder": "Per exemple, versàtil, subtil", "quantity-short": "Quant.", "weight": "Pes (lb)", "properties": "Propietats", "properties-placeholder": "Per exemple, versàtil, subtil",
"sheet": {
"icon": "Icona de l'objecte", "choose-icon": "Tria la teva pròpia icona", "change-icon": "Canvia la icona",
"uploading": "Pujant...", "upload-error": "No s'ha pogut pujar aquesta icona.",
"foundry-icon": "Fes servir la icona del Foundry", "remove-icon": "Treu la icona", "save-error": "No s'ha pogut desar aquest objecte.",
"no-description": "Sense descripció afegida."
},
"icon-picker": {
"intro": "D'on ha de sortir la icona d'aquest objecte?",
"upload": "Pujar una icona", "upload-hint": "Tria una imatge d'aquest dispositiu.",
"foundry": "Carregar del Foundry", "foundry-hint": "Recorre les icones que inclou el teu món del Foundry."
},
"categories": { "categories": {
"weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura", "weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura",
"magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre" "magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre"
@@ -78,10 +94,23 @@
"save-error": "No s'ha pogut desar aquest mapa.", "save-error": "No s'ha pogut desar aquest mapa.",
"no-image": "Aquest mapa encara no té imatge.", "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", "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" "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."
},
"tokens": {
"token": "Fitxa", "drag": "Arrossega aquest actor sobre un mapa per posar-lo",
"drop-hint": "Deixa anar per posar l'actor en aquest mapa",
"open": "Obre la fitxa de personatge", "remove": "Treu la fitxa",
"error": "No s'han pogut canviar les fitxes d'aquest mapa."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir", "title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
"tabs": { "abilities": "Característiques", "inventory": "Inventari", "traits": "Trets", "spells": "Conjurs" },
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la", "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", "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", "combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "proficiencies": "Competències",

View File

@@ -3,6 +3,15 @@
"link-expired": "El codi d'enllaç de Foundry no és vàlid, ha caducat o ja s'ha utilitzat.", "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.", "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.", "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." "item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry.",
"icons-unavailable": "Les icones del Foundry no són disponibles: el seu bridge no està configurat o ara mateix no hi arriba.",
"icons-no-world-url": "Aquesta campanya no té adreça del món del Foundry. Definiu-la als ajustos de la campanya, a la pestanya d'integracions."
},
"icons": {
"path": "Carpeta d'icones",
"up": "Una carpeta amunt",
"loading": "Carregant icones...",
"empty": "No hi ha icones per triar en aquesta carpeta.",
"load-more": "Carregar més icones"
} }
} }

View File

@@ -3,6 +3,7 @@
"username-placeholder": "Introdueix el teu usuari o correu electrònic...", "username-placeholder": "Introdueix el teu usuari o correu electrònic...",
"password": "Contrasenya", "password": "Contrasenya",
"password-placeholder": "Introdueix la teva contrasenya...", "password-placeholder": "Introdueix la teva contrasenya...",
"remember-me": "Recorda'm en aquest dispositiu",
"log-in": "Inicia sessió", "log-in": "Inicia sessió",
"no-account": "No tens un compte?", "no-account": "No tens un compte?",
"register": "Registra't", "register": "Registra't",

View File

@@ -8,6 +8,30 @@
"language": "Idioma" "language": "Idioma"
}, },
"site-administration": { "site-administration": {
"manage-accounts": "Gestiona els comptes" "manage-accounts": "Gestiona els comptes",
"accounts": {
"you": "tu",
"admin": "Administrador",
"make-admin": "Fes-lo administrador",
"remove-admin": "Treu-li l'administrador",
"delete": "Elimina",
"new-account": "Nou compte",
"name": "Nom",
"username": "Nom d'usuari",
"email": "Correu electrònic",
"password": "Contrasenya",
"create": "Crea el compte",
"created": "Compte creat",
"updated": "Compte actualitzat",
"deleted": "Compte eliminat",
"errors": {
"name-empty": "Si us plau, introdueix un nom.",
"username-empty": "Si us plau, introdueix un nom d'usuari.",
"email-empty": "Si us plau, introdueix un correu electrònic vàlid.",
"password-empty": "Si us plau, introdueix una contrasenya.",
"self-admin": "No pots canviar els teus propis privilegis d'administrador.",
"self-delete": "No pots eliminar el teu propi compte."
}
}
} }
} }

View File

@@ -5,7 +5,12 @@
"example": "Finestra d'exemple", "example": "Finestra d'exemple",
"edit-profile": "Editar perfil", "edit-profile": "Editar perfil",
"settings": "Configuració", "settings": "Configuració",
"account-management": "Gestió dels comptes",
"create-campaign": "Crear campanya", "create-campaign": "Crear campanya",
"create-map": "Crear mapa", "create-map": "Crear mapa",
"map-viewer": "Mapa" "map-viewer": "Mapa",
"pinned-note": "Nota fixada",
"item-sheet": "Objecte",
"icon-source": "Tria una icona",
"foundry-icons": "Icones del Foundry"
} }

View File

@@ -48,6 +48,11 @@
"create": "Create {section}", "submit": "Create", "edit": "Edit", "save": "Save", "delete": "Delete", "saving": "Saving...", "create": "Create {section}", "submit": "Create", "edit": "Edit", "save": "Save", "delete": "Delete", "saving": "Saving...",
"collapse-sidebar": "Collapse sidebar", "expand-sidebar": "Expand sidebar" "collapse-sidebar": "Collapse sidebar", "expand-sidebar": "Expand sidebar"
}, },
"folders": {
"toggle": "Toggle the {name} folder",
"rename": "Rename", "color": "Color", "default": "Default", "delete": "Delete folder",
"move-to": "Move to folder...", "root": "Root"
},
"states": { "states": {
"loading": "Loading...", "loading-notes": "Loading notes...", "empty-notes": "No notes in this campaign yet.", "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-actors": "No actors or characters yet.", "empty-items": "No items in this campaign yet.",
@@ -66,6 +71,17 @@
"new": "New item", "edit": "Edit item", "foundry-sync-note": "Changes to this item are also applied in the linked Foundry world.", "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", "category": "Category", "rarity": "Rarity", "quantity": "Quantity",
"quantity-short": "Qty", "weight": "Weight (lb)", "properties": "Properties", "properties-placeholder": "For example, versatile, finesse", "quantity-short": "Qty", "weight": "Weight (lb)", "properties": "Properties", "properties-placeholder": "For example, versatile, finesse",
"sheet": {
"icon": "Item icon", "choose-icon": "Choose your own icon", "change-icon": "Change icon",
"uploading": "Uploading...", "upload-error": "Unable to upload this icon.",
"foundry-icon": "Use Foundry icon", "remove-icon": "Remove icon", "save-error": "Unable to save this item.",
"no-description": "No description added."
},
"icon-picker": {
"intro": "Where should this item's icon come from?",
"upload": "Upload icon", "upload-hint": "Choose an image from this device.",
"foundry": "Load from Foundry", "foundry-hint": "Browse the icons your Foundry world ships with."
},
"categories": { "categories": {
"weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear", "weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear",
"magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other" "magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other"
@@ -82,10 +98,23 @@
"save-error": "Unable to save this map.", "save-error": "Unable to save this map.",
"no-image": "This map has no image yet.", "no-image": "This map has no image yet.",
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid", "zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid",
"open-window": "Open in window", "anchored": "Anchored" "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."
},
"tokens": {
"token": "Token", "drag": "Drag this actor onto a map to place it there",
"drop-hint": "Drop to place the actor on this map",
"open": "Open character sheet", "remove": "Remove token",
"error": "Unable to change the tokens of this map."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set", "title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
"tabs": { "abilities": "Ability Scores", "inventory": "Inventory", "traits": "Traits", "spells": "Spells" },
"level": "Level", "species": "Species", "unset-species": "Species not set", "edit": "Edit sheet", "cancel": "Cancel", "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.", "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", "photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo",

View File

@@ -3,6 +3,15 @@
"link-expired": "This Foundry pairing code is invalid, expired, or already used.", "link-expired": "This Foundry pairing code is invalid, expired, or already used.",
"world-already-linked": "This Foundry world is already linked to another campaign.", "world-already-linked": "This Foundry world is already linked to another campaign.",
"actor-already-synced": "Another actor in this campaign is already synced with that Foundry actor.", "actor-already-synced": "Another actor in this campaign is already synced with that Foundry actor.",
"item-already-synced": "Another item in this campaign is already synced with that Foundry item." "item-already-synced": "Another item in this campaign is already synced with that Foundry item.",
"icons-unavailable": "Foundry's icons are not available: its bridge is not set up, or it cannot be reached right now.",
"icons-no-world-url": "This campaign has no Foundry world address. Set it under campaign settings, in the Integrations tab."
},
"icons": {
"path": "Icon folder",
"up": "One folder up",
"loading": "Loading icons...",
"empty": "No icons to pick in this folder.",
"load-more": "Load more icons"
} }
} }

View File

@@ -4,6 +4,7 @@
"username-placeholder": "Enter your username or email here...", "username-placeholder": "Enter your username or email here...",
"password": "Password", "password": "Password",
"password-placeholder": "Enter your password...", "password-placeholder": "Enter your password...",
"remember-me": "Remember me on this device",
"log-in": "Log in", "log-in": "Log in",
"no-account": "You don't have an account?", "no-account": "You don't have an account?",
"register": "Register", "register": "Register",

View File

@@ -8,6 +8,30 @@
"language": "Language" "language": "Language"
}, },
"site-administration": { "site-administration": {
"manage-accounts": "Manage accounts" "manage-accounts": "Manage accounts",
"accounts": {
"you": "you",
"admin": "Administrator",
"make-admin": "Make administrator",
"remove-admin": "Remove administrator",
"delete": "Delete",
"new-account": "New account",
"name": "Name",
"username": "Username",
"email": "Email",
"password": "Password",
"create": "Create account",
"created": "Account created",
"updated": "Account updated",
"deleted": "Account deleted",
"errors": {
"name-empty": "Please enter a name.",
"username-empty": "Please enter a username.",
"email-empty": "Please enter a valid email address.",
"password-empty": "Please enter a password.",
"self-admin": "You cannot change your own administrator rights.",
"self-delete": "You cannot delete your own account."
}
}
} }
} }

View File

@@ -5,7 +5,12 @@
"example": "Example Window", "example": "Example Window",
"edit-profile": "Edit Profile", "edit-profile": "Edit Profile",
"settings": "Settings", "settings": "Settings",
"account-management": "Manage accounts",
"create-campaign": "Create Campaign", "create-campaign": "Create Campaign",
"create-map": "Create Map", "create-map": "Create Map",
"map-viewer": "Map" "map-viewer": "Map",
"pinned-note": "Pinned note",
"item-sheet": "Item",
"icon-source": "Choose an icon",
"foundry-icons": "Foundry icons"
} }

View File

@@ -44,6 +44,11 @@
"create": "Crear {section}", "submit": "Crear", "edit": "Editar", "save": "Guardar", "delete": "Eliminar", "saving": "Guardando...", "create": "Crear {section}", "submit": "Crear", "edit": "Editar", "save": "Guardar", "delete": "Eliminar", "saving": "Guardando...",
"collapse-sidebar": "Contraer barra lateral", "expand-sidebar": "Expandir barra lateral" "collapse-sidebar": "Contraer barra lateral", "expand-sidebar": "Expandir barra lateral"
}, },
"folders": {
"toggle": "Muestra o oculta la carpeta {name}",
"rename": "Renombrar", "color": "Color", "default": "Por defecto", "delete": "Eliminar carpeta",
"move-to": "Mover a carpeta...", "root": "Raíz"
},
"states": { "states": {
"loading": "Cargando...", "loading-notes": "Cargando notas...", "empty-notes": "Aún no hay notas en esta campaña.", "loading": "Cargando...", "loading-notes": "Cargando notas...", "empty-notes": "Aún no hay notas en esta campaña.",
"empty-actors": "Aún no hay actores ni personajes.", "empty-items": "Aún no hay objetos en esta campaña.", "empty-actors": "Aún no hay actores ni personajes.", "empty-items": "Aún no hay objetos en esta campaña.",
@@ -62,6 +67,17 @@
"new": "Nuevo objeto", "edit": "Editar objeto", "foundry-sync-note": "Los cambios en este objeto también se aplican al mundo de Foundry vinculado.", "new": "Nuevo objeto", "edit": "Editar objeto", "foundry-sync-note": "Los cambios en este objeto también se aplican al mundo de Foundry vinculado.",
"category": "Categoría", "rarity": "Rareza", "quantity": "Cantidad", "category": "Categoría", "rarity": "Rareza", "quantity": "Cantidad",
"quantity-short": "Cant.", "weight": "Peso (lb)", "properties": "Propiedades", "properties-placeholder": "Por ejemplo, versátil, sutil", "quantity-short": "Cant.", "weight": "Peso (lb)", "properties": "Propiedades", "properties-placeholder": "Por ejemplo, versátil, sutil",
"sheet": {
"icon": "Icono del objeto", "choose-icon": "Elegir tu propio icono", "change-icon": "Cambiar icono",
"uploading": "Subiendo...", "upload-error": "No se pudo subir este icono.",
"foundry-icon": "Usar el icono de Foundry", "remove-icon": "Quitar el icono", "save-error": "No se pudo guardar este objeto.",
"no-description": "Sin descripción añadida."
},
"icon-picker": {
"intro": "¿De dónde debe salir el icono de este objeto?",
"upload": "Subir icono", "upload-hint": "Elige una imagen de este dispositivo.",
"foundry": "Cargar desde Foundry", "foundry-hint": "Recorre los iconos que incluye tu mundo de Foundry."
},
"categories": { "categories": {
"weapon": "Arma", "armor": "Armadura", "shield": "Escudo", "adventuring-gear": "Equipo de aventura", "weapon": "Arma", "armor": "Armadura", "shield": "Escudo", "adventuring-gear": "Equipo de aventura",
"magic-item": "Objeto mágico", "consumable": "Consumible", "tool": "Herramienta", "treasure": "Tesoro", "other": "Otro" "magic-item": "Objeto mágico", "consumable": "Consumible", "tool": "Herramienta", "treasure": "Tesoro", "other": "Otro"
@@ -78,10 +94,23 @@
"save-error": "No se pudo guardar este mapa.", "save-error": "No se pudo guardar este mapa.",
"no-image": "Este mapa aún no tiene imagen.", "no-image": "Este mapa aún no tiene imagen.",
"zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula", "zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula",
"open-window": "Abrir en una ventana", "anchored": "Anclado" "open-window": "Abrir en una ventana", "anchored": "Anclado",
"pins": {
"add": "Fija una nota aquí", "none": "Aún no hay notas que fijar",
"open": "Abrir nota", "remove": "Quitar el marcador",
"error": "No se pudieron cambiar los marcadores de este mapa.",
"note-error": "No se pudo leer esta nota. Puede que se haya eliminado."
},
"tokens": {
"token": "Ficha", "drag": "Arrastra este actor sobre un mapa para colocarlo",
"drop-hint": "Suelta para colocar al actor en este mapa",
"open": "Abrir hoja de personaje", "remove": "Quitar la ficha",
"error": "No se pudieron cambiar las fichas de este mapa."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir", "title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",
"tabs": { "abilities": "Características", "inventory": "Inventario", "traits": "Rasgos", "spells": "Conjuros" },
"level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar", "level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar",
"saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia", "saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia",
"combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "proficiencies": "Competencias", "combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "proficiencies": "Competencias",

View File

@@ -3,6 +3,15 @@
"link-expired": "El código de vinculación de Foundry no es válido, ha caducado o ya se ha usado.", "link-expired": "El código de vinculación de Foundry no es válido, ha caducado o ya se ha usado.",
"world-already-linked": "Este mundo de Foundry ya está vinculado a otra campaña.", "world-already-linked": "Este mundo de Foundry ya está vinculado a otra campaña.",
"actor-already-synced": "Otro actor de esta campaña ya está sincronizado con ese actor de Foundry.", "actor-already-synced": "Otro actor de esta campaña ya está sincronizado con ese actor de Foundry.",
"item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry." "item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry.",
"icons-unavailable": "Los iconos de Foundry no están disponibles: su bridge no está configurado o no es accesible ahora.",
"icons-no-world-url": "Esta campaña no tiene dirección del mundo de Foundry. Defínala en los ajustes de la campaña, en la pestaña de integraciones."
},
"icons": {
"path": "Carpeta de iconos",
"up": "Una carpeta arriba",
"loading": "Cargando iconos...",
"empty": "No hay iconos para elegir en esta carpeta.",
"load-more": "Cargar más iconos"
} }
} }

View File

@@ -3,6 +3,7 @@
"username-placeholder": "Introduce tu usuario o correo electrónico...", "username-placeholder": "Introduce tu usuario o correo electrónico...",
"password": "Contraseña", "password": "Contraseña",
"password-placeholder": "Introduce tu contraseña...", "password-placeholder": "Introduce tu contraseña...",
"remember-me": "Recordarme en este dispositivo",
"log-in": "Iniciar sesión", "log-in": "Iniciar sesión",
"no-account": "¿No tienes una cuenta?", "no-account": "¿No tienes una cuenta?",
"register": "Registrarse", "register": "Registrarse",

View File

@@ -8,6 +8,30 @@
"language": "Idioma" "language": "Idioma"
}, },
"site-administration": { "site-administration": {
"manage-accounts": "Gestionar cuentas" "manage-accounts": "Gestionar cuentas",
"accounts": {
"you": "tú",
"admin": "Administrador",
"make-admin": "Nombrar administrador",
"remove-admin": "Quitar administrador",
"delete": "Eliminar",
"new-account": "Nueva cuenta",
"name": "Nombre",
"username": "Nombre de usuario",
"email": "Correo electrónico",
"password": "Contraseña",
"create": "Crear cuenta",
"created": "Cuenta creada",
"updated": "Cuenta actualizada",
"deleted": "Cuenta eliminada",
"errors": {
"name-empty": "Por favor, introduce un nombre.",
"username-empty": "Por favor, introduce un nombre de usuario.",
"email-empty": "Por favor, introduce un correo electrónico válido.",
"password-empty": "Por favor, introduce una contraseña.",
"self-admin": "No puedes cambiar tus propios privilegios de administrador.",
"self-delete": "No puedes eliminar tu propia cuenta."
}
}
} }
} }

View File

@@ -5,7 +5,12 @@
"example": "Ventana de ejemplo", "example": "Ventana de ejemplo",
"edit-profile": "Editar perfil", "edit-profile": "Editar perfil",
"settings": "Configuración", "settings": "Configuración",
"account-management": "Gestionar cuentas",
"create-campaign": "Crear campanya", "create-campaign": "Crear campanya",
"create-map": "Crear mapa", "create-map": "Crear mapa",
"map-viewer": "Mapa" "map-viewer": "Mapa",
"pinned-note": "Nota fijada",
"item-sheet": "Objeto",
"icon-source": "Elegir icono",
"foundry-icons": "Iconos de Foundry"
} }

12707
frontend/package-lock.json generated

File diff suppressed because it is too large Load Diff

326
package-lock.json generated
View File

@@ -1,326 +0,0 @@
{
"name": "dragonroll",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"devDependencies": {
"concurrently": "^9.2.1"
}
},
"node_modules/ansi-regex": {
"version": "5.0.1",
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=8"
}
},
"node_modules/ansi-styles": {
"version": "4.3.0",
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
"integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
"dev": true,
"license": "MIT",
"dependencies": {
"color-convert": "^2.0.1"
},
"engines": {
"node": ">=8"
},
"funding": {
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
}
},
"node_modules/chalk": {
"version": "4.1.2",
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
"integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
"dev": true,
"license": "MIT",
"dependencies": {
"ansi-styles": "^4.1.0",
"supports-color": "^7.1.0"
},
"engines": {
"node": ">=10"
},
"funding": {
"url": "https://github.com/chalk/chalk?sponsor=1"
}
},
"node_modules/chalk/node_modules/supports-color": {
"version": "7.2.0",
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
"integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
"dev": true,
"license": "MIT",
"dependencies": {
"has-flag": "^4.0.0"
},
"engines": {
"node": ">=8"
}
},
"node_modules/cliui": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
"integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
"dev": true,
"license": "ISC",
"dependencies": {
"string-width": "^4.2.0",
"strip-ansi": "^6.0.1",
"wrap-ansi": "^7.0.0"
},
"engines": {
"node": ">=12"
}
},
"node_modules/color-convert": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
"integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
"dev": true,
"license": "MIT",
"dependencies": {
"color-name": "~1.1.4"
},
"engines": {
"node": ">=7.0.0"
}
},
"node_modules/color-name": {
"version": "1.1.4",
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
"dev": true,
"license": "MIT"
},
"node_modules/concurrently": {
"version": "9.2.1",
"resolved": "https://registry.npmjs.org/concurrently/-/concurrently-9.2.1.tgz",
"integrity": "sha512-fsfrO0MxV64Znoy8/l1vVIjjHa29SZyyqPgQBwhiDcaW8wJc2W3XWVOGx4M3oJBnv/zdUZIIp1gDeS98GzP8Ng==",
"dev": true,
"license": "MIT",
"dependencies": {
"chalk": "4.1.2",
"rxjs": "7.8.2",
"shell-quote": "1.8.3",
"supports-color": "8.1.1",
"tree-kill": "1.2.2",
"yargs": "17.7.2"
},
"bin": {
"conc": "dist/bin/concurrently.js",
"concurrently": "dist/bin/concurrently.js"
},
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/open-cli-tools/concurrently?sponsor=1"
}
},
"node_modules/emoji-regex": {
"version": "8.0.0",
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
"integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
"dev": true,
"license": "MIT"
},
"node_modules/escalade": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
"integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=6"
}
},
"node_modules/get-caller-file": {
"version": "2.0.5",
"resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
"integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
"dev": true,
"license": "ISC",
"engines": {
"node": "6.* || 8.* || >= 10.*"
}
},
"node_modules/has-flag": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
"integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=8"
}
},
"node_modules/is-fullwidth-code-point": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
"integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=8"
}
},
"node_modules/require-directory": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
"integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/rxjs": {
"version": "7.8.2",
"resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz",
"integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
"tslib": "^2.1.0"
}
},
"node_modules/shell-quote": {
"version": "1.8.3",
"resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz",
"integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">= 0.4"
},
"funding": {
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/string-width": {
"version": "4.2.3",
"resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
"integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
"dev": true,
"license": "MIT",
"dependencies": {
"emoji-regex": "^8.0.0",
"is-fullwidth-code-point": "^3.0.0",
"strip-ansi": "^6.0.1"
},
"engines": {
"node": ">=8"
}
},
"node_modules/strip-ansi": {
"version": "6.0.1",
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
"integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
"dev": true,
"license": "MIT",
"dependencies": {
"ansi-regex": "^5.0.1"
},
"engines": {
"node": ">=8"
}
},
"node_modules/supports-color": {
"version": "8.1.1",
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz",
"integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==",
"dev": true,
"license": "MIT",
"dependencies": {
"has-flag": "^4.0.0"
},
"engines": {
"node": ">=10"
},
"funding": {
"url": "https://github.com/chalk/supports-color?sponsor=1"
}
},
"node_modules/tree-kill": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz",
"integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==",
"dev": true,
"license": "MIT",
"bin": {
"tree-kill": "cli.js"
}
},
"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==",
"dev": true,
"license": "0BSD"
},
"node_modules/wrap-ansi": {
"version": "7.0.0",
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
"integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
"dev": true,
"license": "MIT",
"dependencies": {
"ansi-styles": "^4.0.0",
"string-width": "^4.1.0",
"strip-ansi": "^6.0.0"
},
"engines": {
"node": ">=10"
},
"funding": {
"url": "https://github.com/chalk/wrap-ansi?sponsor=1"
}
},
"node_modules/y18n": {
"version": "5.0.8",
"resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
"integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
"dev": true,
"license": "ISC",
"engines": {
"node": ">=10"
}
},
"node_modules/yargs": {
"version": "17.7.2",
"resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
"integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==",
"dev": true,
"license": "MIT",
"dependencies": {
"cliui": "^8.0.1",
"escalade": "^3.1.1",
"get-caller-file": "^2.0.5",
"require-directory": "^2.1.1",
"string-width": "^4.2.3",
"y18n": "^5.0.5",
"yargs-parser": "^21.1.1"
},
"engines": {
"node": ">=12"
}
},
"node_modules/yargs-parser": {
"version": "21.1.1",
"resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
"integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
"dev": true,
"license": "ISC",
"engines": {
"node": ">=12"
}
}
}
}

View File

@@ -1,9 +1,15 @@
{ {
"name": "dragonroll-workspace",
"private": true,
"packageManager": "pnpm@10.28.2",
"devDependencies": { "devDependencies": {
"concurrently": "^9.2.1" "concurrently": "^9.2.1"
}, },
"scripts": { "scripts": {
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\"", "dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* pnpm --filter ./backend run dev\" \"pnpm --filter ./frontend run dev\" \"pnpm --filter ./discord-bot run start\" \"node scripts/run-foundry.js\"",
"dev:backend": "DEBUG=* pnpm --filter ./backend run dev",
"dev:frontend": "pnpm --filter ./frontend run dev",
"dev:discord-bot": "pnpm --filter ./discord-bot run start",
"test": "node --test tests/" "test": "node --test tests/"
} }
} }

9814
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

10
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,10 @@
packages:
- backend
- frontend
- discord-bot
# pnpm blocks install scripts of dependencies by default; these two place their
# native binaries through theirs and have to be allowed to run them.
onlyBuiltDependencies:
- '@parcel/watcher'
- esbuild

View File

@@ -1,5 +1,5 @@
// Runs the Foundry Virtual Tabletop start script defined by FOUNDRY_START_SCRIPT // Runs the Foundry Virtual Tabletop start script defined by FOUNDRY_START_SCRIPT
// in the root .env file. Used by `npm run dev` via concurrently. // in the root .env file. Used by `pnpm dev` via concurrently.
const { spawn } = require('node:child_process'); const { spawn } = require('node:child_process');
const fs = require('node:fs'); const fs = require('node:fs');
const path = require('node:path'); const path = require('node:path');

View File

@@ -0,0 +1,89 @@
// Tests for Syndria98/dragonroll#55: the character sheet splits its contents across bookmarks down
// the right edge (ability scores, inventory, traits, spells) instead of stacking every panel on one
// long page.
//
// The repository root installs no dependencies, so the window wiring is read from the sources the way
// tests/item-sheet-window.test.js and tests/settings-window.test.js do it.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
const script = /<script setup>([\s\S]*?)<\/script>/.exec(sheetSource)?.[1] ?? "";
const template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
// The four bookmarks the issue asks for, in order.
test("the sheet declares the four tabs the issue splits the contents into", () => {
const array = /const tabs = \[([\s\S]*?)\];/.exec(script)?.[1] ?? "";
const keys = [...array.matchAll(/key:\s*['"](\w+)['"]/g)].map((m) => m[1]);
assert.deepEqual(keys, ["abilities", "inventory", "traits", "spells"]);
for (const key of keys) {
assert.ok(
new RegExp(`label:\\s*['"]campaigns\\.character-sheet\\.tabs\\.${key}['"]`).test(array),
`the ${key} tab must point at its own i18n key`
);
}
assert.match(script, /const activeTab = ref\(['"]abilities['"]\)/, "the sheet opens on the ability scores tab");
});
test("the tabs sit on the right as a vertical bookmark rail", () => {
assert.match(template, /<nav class="sheet-tabs"[^>]*role="tablist"[^>]*aria-orientation="vertical"/);
assert.match(template, /v-for="tab in tabs"[\s\S]*?:aria-selected="activeTab === tab\.key"/);
const rail = /\.sheet-tabs\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
assert.match(rail, /flex-direction:\s*column/, "the bookmarks stack down the right edge");
// content column and rail sit side by side, the rail hugging the right
assert.match(sheetSource, /\.sheet-layout\s*\{[^}]*display:\s*flex[^}]*\}/, "content and rail share a row");
assert.match(sheetSource, /\.sheet-content\s*\{[^}]*flex:\s*1[^}]*\}/, "the content takes the room, the rail stays slim");
});
// Each tab shows only its own panels; the rest are hidden with v-show so an in-progress edit is
// not thrown away when hopping between tabs.
function tabBody(key) {
const block = new RegExp(`<main v-show="activeTab === '${key}'"[\\s\\S]*?</main>`).exec(template)?.[0];
assert.ok(block, `expected a body for the ${key} tab`);
return block;
}
test("every tab shows only its own content and hides the others", () => {
const abilities = tabBody("abilities");
assert.match(abilities, /class="sheet-portrait"/, "the portrait stays with ability scores");
assert.match(abilities, /class="sheet-panel abilities-panel"/);
assert.match(abilities, /class="sheet-panel combat-panel"/, "combat rides with the ability scores");
for (const other of ["inventory-panel", "traits-panel", "spells-panel"]) {
assert.doesNotMatch(abilities, new RegExp(other));
}
for (const [key, panel] of [["inventory", "inventory-panel"], ["traits", "traits-panel"], ["spells", "spells-panel"]]) {
const body = tabBody(key);
assert.ok(body.includes(panel), `the ${key} tab shows the ${panel}`);
assert.doesNotMatch(body, /class="sheet-portrait"/);
}
// the panels are toggled, not unmounted, so editing on one tab and flipping away keeps the draft
assert.match(template, /v-show="activeTab === 'inventory'"/);
assert.match(template, /v-show="activeTab === 'traits'"/);
assert.match(template, /v-show="activeTab === 'spells'"/);
});
test("the tabs still edit and save through the existing sheet form", () => {
assert.match(tabBody("inventory"), /@click="addInventoryItem"/);
assert.match(tabBody("inventory"), /removeInventoryItem\(index\)/);
assert.match(tabBody("traits"), /v-model="form\.traits"/);
assert.match(tabBody("spells"), /v-model="form\.spells"/);
assert.match(tabBody("abilities"), /v-model\.number="form\.abilityScores\[stat\.key\]"/);
});
test("every locale names the four tabs", () => {
for (const locale of ["en", "es", "ca"]) {
const sheet = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"))["character-sheet"];
for (const key of ["abilities", "inventory", "traits", "spells"]) {
assert.ok(sheet.tabs?.[key], `${locale} is missing campaigns.character-sheet.tabs.${key}`);
}
}
});

444
tests/entry-folders.test.js Normal file
View File

@@ -0,0 +1,444 @@
// Tests for the folder system shared by every campaign list (Syndria98/dragonroll#49):
// folders are created, renamed, coloured and deleted for the actors, the items and the
// maps as well as for the notes, and each list only ever shows the folders of its own.
//
// The repository root installs no dependencies, so each side is loaded the way the other
// tests do it. The routes run against a stubbed `require` (express and the models answer
// with plain objects and a small filter matcher) — except the Folder model's own logic,
// which is read out of the real model file so its target filter is the one under test. The
// frontend services are plain ES modules and are read as text, and the sidebar is read as
// text too, the way tests/sidebar-entity-entry.test.js reads it.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
// --- Enough of the query language the folder routes use --------------------------
function matches(document, filter = {}) {
return Object.entries(filter).every(([key, expected]) => {
if (key === "$or") return expected.some((part) => matches(document, part));
const value = document?.[key];
if (expected && typeof expected === "object" && !Array.isArray(expected) && !(expected instanceof Date)) {
return Object.entries(expected).every(([operator, wanted]) => {
// A row without the field at all counts as "not one of these", which is
// how MongoDB's $nin keeps the note folders saved before `target` existed.
if (operator === "$ne") return String(value ?? "") !== String(wanted ?? "");
if (operator === "$in") return wanted.some((entry) => String(value ?? "") === String(entry ?? ""));
if (operator === "$nin") return !wanted.some((entry) => String(value ?? "") === String(entry ?? ""));
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
});
}
return String(value ?? "") === String(expected ?? "");
});
}
function mongooseQuery(rows) {
const result = {
select: () => result,
sort: () => result,
limit: (count) => mongooseQuery(rows.slice(0, count)),
lean: () => Promise.resolve(rows),
then: (onFulfilled, onRejected) => Promise.resolve(rows).then(onFulfilled, onRejected),
};
return result;
}
function fakeCollection(name, seed = []) {
const rows = [];
let counter = 0;
function Document(data = {}) {
counter += 1;
this._id = `${name}-${counter}`;
this.isNew = true;
Object.assign(this, data);
}
Document.prototype.save = async function save() {
if (this.isNew) rows.push(this);
this.isNew = false;
return this;
};
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
function seedRow(data) {
const row = new Document(data);
row.isNew = false;
rows.push(row);
return row;
}
for (const data of seed) seedRow(data);
const model = function Model(data) { return new Document(data); };
model.rows = rows;
model.seed = seedRow;
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
// A row that answers both when awaited and through `.lean()`, because the routes read
// some of their lookups one way and some the other.
const one = (row) => Object.assign(Promise.resolve(row ?? null), { lean: () => Promise.resolve(row ?? null) });
model.findOne = (filter) => one(rows.find((document) => matches(document, filter)));
model.findById = (id) => one(rows.find((document) => String(document._id) === String(id)));
model.deleteOne = async (filter) => {
const hit = rows.filter((row) => matches(row, filter));
for (const row of hit) rows.splice(rows.indexOf(row), 1);
return { deletedCount: hit.length };
};
model.updateMany = async (filter, update) => {
const hit = rows.filter((row) => matches(row, filter));
for (const row of hit) Object.assign(row, update.$set ?? {});
return { modifiedCount: hit.length };
};
return model;
}
// --- The real Folder model's own logic, over a stubbed mongoose -------------------
// The model file's statics (`filterForTarget`, `isTarget`, `belongsToSection`) and the
// `target` enum, read out of the file with a mongoose that only builds a schema. What the
// routes ask for is therefore the code under test, not a copy of it.
function realFolderModel(seed = []) {
let definition = null;
function Schema(schemaDefinition) {
definition = schemaDefinition;
this.statics = {};
}
Schema.prototype.index = function index() {};
Schema.Types = { ObjectId: "ObjectId" };
const mongoose = {
Schema,
isValidObjectId: (value) => typeof value === "string" && value.length > 0,
model: (name, schema) => Object.assign(function Model() {}, schema.statics),
};
const moduleStub = { exports: {} };
vm.compileFunction(read("backend", "src", "models", "Folder.js"), ["require", "module"])(
(id) => {
if (id === "mongoose") return mongoose;
throw new Error(`require("${id}") is not stubbed`);
},
moduleStub
);
const collection = fakeCollection("folder", seed);
const model = Object.assign(collection, moduleStub.exports);
model.definition = () => definition;
return model;
}
// --- Routes against stubbed models ----------------------------------------------
function loadRoute(file, models) {
const routes = new Map();
const router = {
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
};
const requireStub = (id) => {
if (id === "express") return { Router: () => router };
// The image upload middleware: the folder routes never see a file.
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
if (models[id]) return models[id];
throw new Error(`require("${id}") is not stubbed`);
};
const moduleStub = { exports: {} };
vm.compileFunction(read("backend", "src", "routes", file), ["require", "module", "exports"])(
requireStub, moduleStub, moduleStub.exports
);
return async function call(route, { body = {}, query = {} } = {}) {
const handlers = routes.get(route);
assert.ok(handlers, `${route} is not mounted`);
const res = { payload: null, json(payload) { this.payload = payload; } };
await handlers[handlers.length - 1]({ body, query, user: { id: "user-1" } }, res);
return res.payload;
};
}
// The routes share one set of tables, the way the API does: a folder deleted through
// `/folder/delete` has to empty the rows pointing at it in each of them.
function campaign({ folders = [], notes = [], actors = [], items = [], maps = [] } = {}) {
const campaignDoc = { _id: "campaign-1", id: "campaign-1", createdBy: "user-1" };
const collections = {
// Folders belong to the campaign the tests run their requests against unless a
// seed says otherwise.
Folder: realFolderModel(folders.map((folder) => ({ campaign: "campaign-1", ...folder }))),
Note: fakeCollection("note", notes),
Actor: fakeCollection("actor", actors),
Item: fakeCollection("item", items),
Map: fakeCollection("map", maps),
};
const models = {
// `userOwnsCampaign` reads the campaign through `findOne(...).lean()`.
"../models/Campaign": { findOne: () => ({ lean: async () => campaignDoc }) },
"../models/Folder": collections.Folder,
"../models/Note": collections.Note,
"../models/Actor": collections.Actor,
"../models/Item": collections.Item,
"../models/Map": collections.Map,
};
return { call: (file) => loadRoute(file, models), collections };
}
// --- Every list gets a folder of its own ----------------------------------------
test("a folder is made for the campaign list the sidebar names", async () => {
const { collections, call } = campaign();
const create = await call("folder.js");
for (const target of ["actor", "item", "map"]) {
const response = await create("POST /create", { body: { name: `${target} folder`, campaign: "campaign-1", target } });
assert.equal(response.status, "ok");
assert.equal(response.folder.target, target, `${target} folders are filed as such`);
}
assert.deepEqual(collections.Folder.rows.map((folder) => folder.target), ["actor", "item", "map"]);
});
test("a folder made without a target belongs to the notes, as it always did", async () => {
const { collections, call } = campaign();
const response = await call("folder.js")("POST /create", { body: { name: "Lore", campaign: "campaign-1" } });
assert.equal(response.status, "ok");
assert.equal(collections.Folder.rows[0].target, "note");
});
test("the notes keep the folders saved before the model knew about targets", async () => {
const legacy = { _id: "folder-legacy", name: "Old lore" };
const { collections, call } = campaign({
folders: [legacy, { _id: "folder-actors", name: "Adventurers", target: "actor" }],
});
const notes = await call("note.js")("GET /list", { query: { campaign: "campaign-1" } });
const listed = await call("folder.js")("GET /list", { query: { campaign: "campaign-1" } });
assert.equal(notes.status, "ok");
assert.deepEqual(notes.folders.map((folder) => folder._id), ["folder-legacy"], "the notes tree shows its own folders only");
assert.deepEqual(listed.folders.map((folder) => folder._id), ["folder-legacy"], "and a request naming no target means the notes");
assert.deepEqual(collections.Folder.rows.length, 2, "the actor folder is left alone, it is another list's");
});
test("a list answers with the folders of its own section", async () => {
const { call } = campaign({
folders: [
{ _id: "folder-note", name: "Lore", target: "note" },
{ _id: "folder-actor", name: "Adventurers", target: "actor" },
{ _id: "folder-item", name: "Gear", target: "item" },
{ _id: "folder-map", name: "Regions", target: "map" },
],
});
for (const [target, ids] of [["note", ["folder-note"]], ["actor", ["folder-actor"]], ["item", ["folder-item"]], ["map", ["folder-map"]]]) {
const response = await call("folder.js")("GET /list", { query: { campaign: "campaign-1", target } });
assert.deepEqual(response.folders.map((folder) => folder._id), ids, `${target} folders only`);
}
});
test("a folder is not made for a list that does not exist", async () => {
const { collections, call } = campaign();
const response = await call("folder.js")("POST /create", { body: { name: "Nowhere", campaign: "campaign-1", target: "spell" } });
assert.equal(response.status, "error");
assert.equal(response.msg, "errors.missing-data");
assert.deepEqual(collections.Folder.rows, []);
});
test("the actor, item and map lists send the tree their rows stand in", async () => {
const { call } = campaign({
folders: [{ _id: "folder-actor", name: "Adventurers", target: "actor", color: "#e74c3c" }],
actors: [{ _id: "actor-1", name: "Thalia", campaign: "campaign-1" }],
items: [{ _id: "item-1", name: "Longsword", campaign: "campaign-1" }],
maps: [{ _id: "map-1", name: "Crossroads", campaign: "campaign-1" }],
});
for (const [file, key] of [["actor.js", "actors"], ["item.js", "items"], ["map.js", "maps"]]) {
const response = await call(file)("GET /list", { query: { campaign: "campaign-1" } });
assert.equal(response.status, "ok");
assert.equal(response[key].length, 1);
assert.ok(Array.isArray(response.folders), `${file} sends its folders along`);
}
});
// --- Filing rows, and emptying a folder that goes away ---------------------------
test("an actor, an item and a map each move into a folder of their own list", async () => {
const { collections, call } = campaign({
folders: [
{ _id: "folder-actor", name: "Adventurers", target: "actor" },
{ _id: "folder-item", name: "Gear", target: "item" },
{ _id: "folder-map", name: "Regions", target: "map" },
],
actors: [{ _id: "actor-1", name: "Thalia", campaign: "campaign-1" }],
items: [{ _id: "item-1", name: "Longsword", campaign: "campaign-1" }],
maps: [{ _id: "map-1", name: "Crossroads", campaign: "campaign-1" }],
});
const actor = await call("actor.js")("POST /update", { body: { id: "actor-1", folder: "folder-actor" } });
const item = await call("item.js")("POST /update", { body: { id: "item-1", folder: "folder-item" } });
const map = await call("map.js")("POST /update", { body: { id: "map-1", folder: "folder-map" } });
assert.equal(actor.status, "ok");
assert.equal(String(actor.actor.folder), "folder-actor");
assert.equal(String(collections.Actor.rows[0].folder), "folder-actor");
assert.equal(String(item.item.folder), "folder-item");
assert.equal(String(map.map.folder), "folder-map");
});
test("a move refuses a folder of another list, or of another campaign", async () => {
const { collections, call } = campaign({
folders: [
{ _id: "folder-actor", name: "Adventurers", target: "actor" },
{ _id: "folder-item", name: "Gear", target: "item" },
{ _id: "folder-other", name: "Somebody else's", target: "actor", campaign: "campaign-2" },
],
actors: [{ _id: "actor-1", name: "Thalia", campaign: "campaign-1" }],
});
const update = await call("actor.js");
const wrongList = await update("POST /update", { body: { id: "actor-1", folder: "folder-item" } });
const wrongCampaign = await update("POST /update", { body: { id: "actor-1", folder: "folder-other" } });
assert.equal(wrongList.status, "error");
assert.equal(wrongList.msg, "errors.notfound");
assert.equal(wrongCampaign.status, "error");
assert.equal(collections.Actor.rows[0].folder, undefined, "the actor stays where it was");
const toRoot = await update("POST /update", { body: { id: "actor-1", folder: null } });
assert.equal(toRoot.status, "ok");
assert.equal(toRoot.actor.folder, null, "and the root of the list is always a valid target");
});
test("updating an entry that says nothing about folders leaves it where it stands", async () => {
const { collections, call } = campaign({
folders: [{ _id: "folder-actor", name: "Adventurers", target: "actor" }],
actors: [{ _id: "actor-1", name: "Thalia", campaign: "campaign-1", folder: "folder-actor" }],
});
const response = await call("actor.js")("POST /update", { body: { id: "actor-1", level: 3 } });
assert.equal(response.status, "ok");
assert.equal(String(collections.Actor.rows[0].folder), "folder-actor", "a sheet save does not file the actor away");
});
test("deleting a folder moves what stood in it to the root of every list", async () => {
const { collections, call } = campaign({
folders: [
{ _id: "folder-actor", name: "Adventurers", target: "actor" },
{ _id: "folder-actor-sub", name: "Family", target: "actor", parentFolder: "folder-actor" },
],
notes: [{ _id: "note-1", title: "Lore", campaign: "campaign-1", folder: "folder-actor-sub" }],
actors: [{ _id: "actor-1", name: "Thalia", campaign: "campaign-1", folder: "folder-actor" }],
items: [{ _id: "item-1", name: "Longsword", campaign: "campaign-1", folder: "folder-actor" }],
maps: [{ _id: "map-1", name: "Crossroads", campaign: "campaign-1", folder: "folder-actor-sub" }],
});
const response = await call("folder.js")("POST /delete", { body: { id: "folder-actor" } });
assert.equal(response.status, "ok");
assert.deepEqual(collections.Folder.rows, [], "the folder and the one nested in it are gone");
assert.equal(collections.Actor.rows[0].folder, null);
assert.equal(collections.Item.rows[0].folder, null);
assert.equal(collections.Map.rows[0].folder, null);
assert.equal(collections.Note.rows[0].folder, null);
});
// --- The frontend: one folder row, and a menu that works everywhere --------------
function loadEntryColorsService() {
const source = read("frontend", "app", "services", "EntryColors.js").replace(
"export { ENTRY_COLORS, BuildColorMenu };", "return { ENTRY_COLORS, BuildColorMenu };"
);
return vm.compileFunction(source)();
}
test("the colour menu offers the palette once, to every section", () => {
const { ENTRY_COLORS, BuildColorMenu } = loadEntryColorsService();
const picked = [];
const menu = BuildColorMenu((color) => picked.push(color), { defaultLabel: "No colour" });
assert.equal(menu.filter((item) => item.color).length, ENTRY_COLORS.length, "one swatch per preset colour");
assert.deepEqual(menu.at(-1).name, "No colour");
menu.at(-1).action();
assert.deepEqual(picked, [null], "and the last item takes the colour off");
menu[0].action();
assert.deepEqual(picked, [null, ENTRY_COLORS[0].value]);
// The notes' tree shares the palette instead of keeping its own copy.
const noteTree = read("frontend", "app", "components", "partials", "NestedNoteList.vue");
assert.match(noteTree, /import \{ BuildColorMenu \} from '~\/services\/EntryColors'/);
assert.doesNotMatch(noteTree, /const entryColors = /, "the note tree has no palette of its own");
});
test("every entry section files its rows under folder rows", () => {
const sidebar = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
// The three entry lists are each built from their own folders and rendered with the
// folder row, which is how the item list already did it.
for (const kind of ["actor", "item", "map"]) {
assert.match(sidebar, new RegExp(`${kind}: computed\\(\\(\\) => BuildItemRows\\(${kind}s\\.value, entryFolders\\.${kind}\\.value, collapsedFolderIds\\.value\\)\\)`));
}
assert.equal(sidebar.match(/<EntryFolderRow/g)?.length, 3, "each entry section renders folder rows");
assert.match(sidebar, /entryFolders\[kind\]\.value = response\.data\.folders/, "each list reads the tree it is sent");
});
test("every entry section can create, rename, colour and delete a folder", () => {
const sidebar = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
// The header's folder button names the list the folder belongs to; the notes ask for
// their own, and a click event must not slip in as the target.
assert.match(sidebar, /@click="createFolder\(\)"/);
assert.match(sidebar, /@click="createFolder\(entryEntityType\(activeSection\)\)"/);
assert.match(sidebar, /function createFolder\(target = 'note'\)/);
assert.match(sidebar, /CreateWindow\('new_folder', \{ campaign: campaignId\.value, target \}\)/);
// Rename, colour, delete: the same routes the note tree uses, so the same window and
// the same `/folder/*` calls serve every section.
assert.match(sidebar, /CreateWindow\('new_folder', \{ folderId: folder\._id, campaign: campaignId\.value, name: folder\.name \}\)/);
assert.match(sidebar, /Server\(\)\.post\('\/folder\/update', \{ id: folder\._id, color \}\)/);
assert.match(sidebar, /Server\(\)\.post\('\/folder\/delete', \{ id: folder\._id \}\)/);
// And an entry of any list can be filed into a folder, or back to the root.
assert.match(sidebar, /Server\(\)\.post\(`\/\$\{entityType\}\/update`, \{ id: entry\._id, folder: folderId \}\)/);
// The window hands the target to the API when making a folder.
const window = read("frontend", "app", "components", "windows", "NewFolderWindow.vue");
assert.match(window, /folderData\.target = data\.target \?\? 'note'/);
// A saved folder only appears in the list it belongs to.
assert.match(sidebar, /fetchCampaignEntries\(section, true\)/);
});
test("a folder row says what it is and shows the colour it was given", () => {
const row = read("frontend", "app", "components", "partials", "EntryFolderRow.vue");
assert.match(row, /:aria-expanded="\(!collapsed\)\.toString\(\)"/);
assert.match(row, /@click="emit\('toggle'\)"/);
assert.match(row, /@contextmenu\.prevent="ShowContextMenu\(menu\)"/);
assert.match(row, /folder\.color \? \{ '--entry-color': folder\.color \} : null/);
// The colour tints the row instead of replacing its text colours, the way notes and
// note folders do.
assert.match(row, /\.entry-folder-row\.has-color \{ background: color-mix\(in srgb, var\(--entry-color\)/);
});
test("every locale says what the folder menus do", () => {
const keys = ["toggle", "rename", "color", "default", "delete", "move-to", "root"];
for (const locale of ["en", "es", "ca"]) {
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
for (const key of keys) {
assert.ok(campaigns.folders?.[key], `${locale} is missing campaigns.folders.${key}`);
}
}
});

View File

@@ -0,0 +1,417 @@
// Tests for the D&D 5e details the system keeps as a reference to an embedded item
// (Syndria98/dragonroll#54). `system.details.background` and `system.details.race` are
// LocalDocumentFields: they hold the id of the actor's background / race item and never
// its name, and their `fallback` option hands the bare id back when that item is gone.
// Dragonroll holds names, so reading the id as a name and writing it back gave Foundry a
// background item that does not exist and a details reference resolving to nothing —
// adding a background in Foundry then failed.
//
// The backend mapper is plain CommonJS and is required directly. The Foundry module is
// loaded into a `node:vm` context holding stubbed Foundry globals with fake timers, like
// tests/foundry-sync-toggle.test.js: the characters Dragonroll answers with are applied
// to a stubbed actor, so the references it writes are observable.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const MODULE_ID = "dragonroll-foundry";
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
// Foundry generates document ids as sixteen characters of its alphabet, digits included.
const ID_GONE = "aB3cD9eF1gH2iJ4k";
const ID_SOLDIER = "Kx7pQ2mR9vT4wZ8n";
const ID_HUMAN = "7QcL2fYh5Bd0Mn3s";
function foundryActor(details = {}, items = []) {
return { _id: "actor-1", name: "Thalia", type: "character", system: { details }, items };
}
test("a background carried as an item arrives by its name, not its id", () => {
const character = foundryActor(
{ background: ID_SOLDIER },
[{ _id: ID_SOLDIER, name: "Soldier", type: "background" }],
);
assert.equal(foundryActorToCharacter(character).background, "Soldier");
});
test("a background reference whose item is gone does not become a background", () => {
// The item was deleted, and `fallback: true` gives the id back instead.
const character = foundryActor({ background: ID_GONE }, []);
assert.equal(foundryActorToCharacter(character).background, "");
});
test("a background item takes the place of a reference that resolves to nothing", () => {
const character = foundryActor(
{ background: ID_GONE },
[{ _id: ID_SOLDIER, name: "Soldier", type: "background" }],
);
assert.equal(foundryActorToCharacter(character).background, "Soldier");
});
test("a plain-text background from an older system release is still a name", () => {
const character = foundryActor({ background: "Sailor" }, []);
assert.equal(foundryActorToCharacter(character).background, "Sailor");
});
test("the class, subclass and species references resolve the same way", () => {
const items = [
{ _id: ID_HUMAN, name: "Human", type: "race" },
{ _id: "cls1Id00000000", name: "Fighter", type: "class" },
{ _id: "sub1Id00000000", name: "Oracle", type: "subclass" },
];
const character = foundryActor(
{ race: ID_HUMAN, class: "cls1Id00000000", subclass: "sub1Id00000000" },
items,
);
const fields = foundryActorToCharacter(character);
assert.equal(fields.species, "Human");
assert.equal(fields.className, "Fighter");
assert.equal(fields.subclass, "Oracle");
});
test("a class reference that resolves to nothing falls back to the class item", () => {
const character = foundryActor(
{ class: ID_GONE, race: ID_GONE },
[{ _id: "cls1Id00000000", name: "Fighter", type: "class" }],
);
const fields = foundryActorToCharacter(character);
assert.equal(fields.className, "Fighter", "the class the actor carries, not the id");
assert.equal(fields.species, "", "and nothing to name the species from");
});
// --- The Foundry module applies Dragonroll's character --------------------------
// A reference is either the id this sync wrote or the document the field resolves to.
function referenceId(actor, field) {
const value = actor.system.details?.[field];
return typeof value === "string" ? value : value?._id || "";
}
function makeStubItem(id, { name, type, system = {}, flags = {} }) {
return {
_id: id,
id,
name,
type,
system,
flags,
parent: { documentName: "Actor" },
getFlag(module, key) { return this.flags?.[module]?.[key]; },
toObject() {
return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: this.flags };
},
};
}
function writeDotted(target, data) {
for (const [key, value] of Object.entries(data)) {
const parts = key.split(".");
const last = parts.pop();
let node = target;
for (const part of parts) node = node[part] ??= {};
node[last] = value;
}
}
let stubCounter = 0;
function makeStubActor(name, { type = "character", system = {}, flags = {}, items = [] } = {}) {
stubCounter += 1;
const id = `actor-${stubCounter}`;
const contents = items.map((item, index) => makeStubItem(item._id || `embedded-${stubCounter}-${index}`, item));
const actor = {
id,
name,
type,
documentName: "Actor",
img: "icons/svg/mystery-man.svg",
system,
flags,
items: { contents },
getFlag(module, key) { return this.flags?.[module]?.[key]; },
async update(data) {
writeDotted(this, data);
return this;
},
async updateEmbeddedDocuments(documentName, updates) {
for (const update of updates) {
const item = contents.find((candidate) => candidate.id === update._id);
if (item) writeDotted(item, update);
}
return updates.map((update) => contents.find((candidate) => candidate.id === update._id));
},
async createEmbeddedDocuments(documentName, datas) {
const created = datas.map((data) => {
const item = makeStubItem(`embedded-${stubCounter}-${contents.length}`, data);
item.name = data.name;
item.type = data.type;
contents.push(item);
return item;
});
return created;
},
async deleteEmbeddedDocuments(documentName, ids) {
for (const id of ids) {
const index = contents.findIndex((item) => item.id === id);
if (index >= 0) contents.splice(index, 1);
}
return ids;
},
toObject() {
return {
_id: this.id,
name: this.name,
type: this.type,
img: this.img,
flags: this.flags,
system: this.system,
};
},
};
return actor;
}
// A linked world with the actors it holds, answering `foundry/sync/characters` with the
// campaign's characters. Each one is applied to its Foundry actor on the next reconcile.
function makeWorld({ actors = [], remoteActors = [] } = {}) {
const state = {
hooks: new Map(),
registered: new Map(),
requests: [],
timers: new Map(),
nextTimerId: 1,
logs: [],
};
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
const sandbox = {
console: {
log() {},
info() {},
warn: (...args) => state.logs.push(args.map(String).join(" ")),
error: (...args) => state.logs.push(args.map(String).join(" ")),
},
URL,
CONFIG: {},
window: { location: { origin: "http://vtt.test" } },
ui: { notifications: { info() {}, warn() {}, error() {} } },
Hooks: {
once(name, fn) { state.hooks.set(name, [fn]); },
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
},
setTimeout: (fn, delay = 0) => {
const timerId = state.nextTimerId++;
state.timers.set(timerId, { fn, delay });
return timerId;
},
clearTimeout: (timerId) => state.timers.delete(timerId),
setInterval: () => 0,
clearInterval: () => {},
fetch: async (url, options = {}) => {
const href = String(url);
state.requests.push({ href, method: options.method, body: options.body ? JSON.parse(options.body) : null });
if (href.includes("foundry/sync/characters")) return { ok: true, status: 200, json: async () => ({ status: "ok", actors: remoteActors }) };
if (href.includes("foundry/sync/items")) return { ok: true, status: 200, json: async () => ({ status: "ok", items: [] }) };
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
},
Item: { async create() { return null; } },
Actor: {
async create(data) {
const actor = makeStubActor(data.name, {
type: data.type,
system: structuredClone(data.system || {}),
flags: structuredClone(data.flags || {}),
items: (data.items || []).map((item) => ({ name: item.name, type: item.type, system: item.system })),
});
actors.push(actor);
return actor;
},
},
};
sandbox.game = {
user: { isGM: true },
world: { id: "world-1", title: "Test World" },
system: { id: "dnd5e" },
modules: { get: () => ({}) },
actors: { contents: actors, get: (actorId) => actors.find((actor) => actor.id === actorId) },
items: { contents: [], get: () => null },
folders: { contents: [], get: () => null },
settings: {
register(module, key, definition) {
state.registered.set(key, definition);
if (!(key in settingsStore)) settingsStore[key] = definition.default;
},
get(module, key) { return settingsStore[key]; },
async set(module, key, value) {
settingsStore[key] = value;
await state.registered.get(key)?.onChange?.(value);
},
},
};
vm.createContext(sandbox);
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
state.game = sandbox.game;
state.actor = (actorId) => actors.find((actor) => actor.id === actorId);
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
// World start: the actors are pushed, then the campaign's characters are applied.
state.start = async () => {
await state.fire("init");
await state.fire("ready");
await state.runTimers();
return state;
};
state.fire = async (name, ...args) => {
for (const handler of state.hooks.get(name) || []) await handler(...args);
await drain();
};
state.runTimers = async () => {
for (let round = 0; round < 6; round += 1) {
if (!state.timers.size && round > 2) break;
const due = [...state.timers.values()];
state.timers.clear();
for (const timer of due) await timer.fn();
await drain();
}
};
state.itemNames = (actor) => actor.items.contents.map((item) => [item.type, item.name]);
return state;
}
// The campaign's character for `actor`, holding what Dragonroll keeps for it.
function campaignCharacter(actor, over = {}) {
return {
_id: "dr-actor-1",
name: "Thalia",
type: "character",
species: "",
className: "",
subclass: "",
level: 1,
background: "",
challengeRating: "",
description: "",
image: "",
abilityScores: {},
armorClass: 10,
speed: 30,
traits: "",
proficiencies: "",
spells: "",
inventory: [],
foundryActorId: actor?.id ?? null,
...over,
};
}
test("Dragonroll's background becomes the actor's background item, referenced by id", async () => {
const actor = makeStubActor("Thalia", {
system: { details: { background: "" } },
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
});
const world = await makeWorld({
actors: [actor],
remoteActors: [campaignCharacter(actor, { background: "Soldier" })],
}).start();
const background = actor.items.contents.find((item) => item.type === "background");
assert.ok(background, "the character's background stands in Foundry as an item");
assert.equal(background.name, "Soldier");
assert.equal(referenceId(actor, "background"), background.id, "its details reference points at the item");
assert.equal(actor.system.details.background, background.id);
assert.deepEqual(world.logs, [], "applying the character did not warn");
});
test("the background an earlier sync invented is taken back out", async () => {
// What the bug left behind: an item named after the id the details field held, next to
// the real background, and a reference the old sync overwrote with that id.
const actor = makeStubActor("Thalia", {
system: { details: { background: ID_GONE } },
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
items: [
{ _id: ID_SOLDIER, name: "Soldier", type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
{ _id: "item-bogus", name: ID_GONE, type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
],
});
const world = await makeWorld({
actors: [actor],
remoteActors: [campaignCharacter(actor, { background: "Soldier" })],
}).start();
assert.deepEqual(world.itemNames(actor), [["background", "Soldier"]], "only the real background is left");
assert.equal(referenceId(actor, "background"), ID_SOLDIER, "and the reference resolves to it");
});
test("a background taken off in Dragonroll clears the reference", async () => {
const actor = makeStubActor("Thalia", {
system: { details: { background: ID_SOLDIER } },
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
items: [
{ _id: ID_SOLDIER, name: "Soldier", type: "background", flags: { [MODULE_ID]: { syncedItem: true } } },
],
});
const world = await makeWorld({ actors: [actor], remoteActors: [campaignCharacter(actor)] }).start();
assert.deepEqual(world.itemNames(actor), [], "the background item went with it");
assert.equal(referenceId(actor, "background"), "", "and no reference is left pointing at nothing");
});
test("a species never lands in the details reference as a name", async () => {
const actor = makeStubActor("Thalia", {
// A species picked in the sheet: dnd5e made the race item and referenced it by id.
system: { details: { race: ID_HUMAN } },
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
items: [{ _id: ID_HUMAN, name: "Human", type: "race", flags: { [MODULE_ID]: { syncedItem: true } } }],
});
await makeWorld({
actors: [actor],
remoteActors: [campaignCharacter(actor, { species: "Human", background: "Soldier" })],
}).start();
assert.equal(referenceId(actor, "race"), ID_HUMAN, "the species reference still points at the race item");
assert.notEqual(actor.system.details.race, "Human", "a name in it would resolve to nothing");
});
test("a species the world keeps as plain text is left to the world", async () => {
// An actor migrated from an older system release: no race item, the name is what the
// field holds, and Dragonroll has nothing to reference.
const actor = makeStubActor("Thalia", {
system: { details: { race: "Human" } },
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
});
await makeWorld({
actors: [actor],
remoteActors: [campaignCharacter(actor, { species: "Human" })],
}).start();
assert.equal(actor.system.details.race, "Human", "the text the sheet reads is kept as it was");
});
test("a character made in Dragonroll references the background it is created with", async () => {
const world = await makeWorld({ actors: [], remoteActors: [campaignCharacter(null, { background: "Soldier" })] }).start();
const [actor] = world.game.actors.contents;
assert.ok(actor, "the campaign's character was made in this world");
const background = actor.items.contents.find((item) => item.type === "background");
assert.ok(background, "created together with its background item");
assert.equal(background.name, "Soldier");
assert.equal(referenceId(actor, "background"), background.id, "referenced by that item's id, never its name");
});

View File

@@ -0,0 +1,170 @@
// Tests for Syndria98/dragonroll#65: picking an item's icon opens a window that asks
// where the icon comes from — upload one from this device, or load one from the icon
// library the linked Foundry world ships in its data directory's `icons/` folder.
// That library runs into the thousands, so it is listed one folder per request, with
// its icons paged and its thumbnails lazy to load.
//
// The icon listing helpers are a pure CommonJS service, so they are required and called
// directly. The windows and the bridge live in files this repository installs no
// dependencies for, so those checks read the sources, like tests/map-viewer.test.js does.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const iconService = require(path.join(__dirname, "..", "backend", "src", "services", "foundry-icons"));
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
const itemWindowSource = read("frontend", "app", "components", "windows", "ItemSheetWindow.vue");
const sourceWindowSource = read("frontend", "app", "components", "windows", "ItemIconSourceWindow.vue");
const foundryIconsSource = read("frontend", "app", "components", "windows", "FoundryIconPickerWindow.vue");
const foundryRouteSource = read("backend", "src", "routes", "foundry.js");
const bridgeSource = read("dragonroll-foundry", "bridge", "server.js");
// --- The listing service: what the browser may ask for, and what it gets back ------
test("icon listings always stay inside Foundry's icon root", () => {
assert.equal(iconService.ICON_ROOT, "icons");
assert.equal(iconService.normalizeIconDirectory(""), "icons");
assert.equal(iconService.normalizeIconDirectory(undefined), "icons");
assert.equal(iconService.normalizeIconDirectory("/icons/svg/"), "icons/svg");
assert.equal(iconService.normalizeIconDirectory("icons/sfdcc/axes"), "icons/sfdcc/axes");
assert.equal(iconService.normalizeIconDirectory("icons/./svg"), "icons/svg");
// nothing that leaves `icons/` is a folder this route will list
assert.equal(iconService.normalizeIconDirectory("icons/../secret"), null);
assert.equal(iconService.normalizeIconDirectory("../etc"), null);
assert.equal(iconService.normalizeIconDirectory("systems/dnd5e/icons"), null);
assert.equal(iconService.parentIconDirectory("icons/svg/axes"), "icons/svg");
assert.equal(iconService.parentIconDirectory("icons"), null);
});
test("icons are listed a page at a time, bounded", () => {
assert.deepEqual(iconService.readIconListingPage({}), { limit: iconService.DEFAULT_ICON_PAGE_SIZE, offset: 0 });
assert.deepEqual(iconService.readIconListingPage({ limit: "20", offset: "240" }), { limit: 20, offset: 240 });
// a caller cannot ask for the whole library at once, or for a page before the first
assert.equal(iconService.readIconListingPage({ limit: "99999" }).limit, iconService.MAX_ICON_PAGE_SIZE);
assert.equal(iconService.readIconListingPage({ offset: "-10" }).offset, 0);
});
test("only image files become icons, and they load from the world's own address", () => {
const listing = iconService.shapeIconListing({
base: "https://vtt.example.com/",
dir: "icons/svg",
listing: {
directories: ["icons/svg/creature", "icons/svg/creature", "icons/svg"],
files: ["icons/svg/dice.svg", "icons/svg/sword.png", "icons/svg/readme.txt", "stray.md"],
offset: 0,
next: 120,
},
});
assert.equal(listing.dir, "icons/svg");
assert.equal(listing.parent, "icons");
assert.deepEqual(listing.folders.map((folder) => folder.path), ["icons/svg/creature"]);
assert.deepEqual(listing.folders.map((folder) => folder.name), ["creature"]);
assert.deepEqual(listing.files.map((icon) => icon.path), ["icons/svg/dice.svg", "icons/svg/sword.png"]);
assert.equal(listing.files[0].name, "dice.svg");
assert.equal(listing.files[0].url, "https://vtt.example.com/icons/svg/dice.svg");
assert.equal(listing.next, 120);
});
test("an icon path with spaces still gives the browser a loadable url", () => {
assert.equal(
iconService.joinFoundryAssetUrl("http://vtt.test:30000", "icons/sfdcc/axes/halberd sword.svg"),
"http://vtt.test:30000/icons/sfdcc/axes/halberd%20sword.svg"
);
assert.equal(iconService.joinFoundryAssetUrl("", "icons/svg/dice.svg"), "");
});
// --- The backend route ------------------------------------------------------------
test("the foundry proxy lists one icon folder for one of the caller's campaigns", () => {
assert.match(foundryRouteSource, /router\.get\(["']\/icons["'], async \(req, res\)/);
const route = /router\.get\(["']\/icons[\s\S]*?module\.exports/.exec(foundryRouteSource)?.[0] ?? foundryRouteSource;
// the campaign is where the world address is kept, so it has to be the caller's own
assert.match(route, /findOwnedCampaign\(req\.query\.campaign, req\.user\.id\)/);
assert.match(foundryRouteSource, /Campaign\.findOne\(\{\s*_id:\s*campaignId,\s*createdBy:\s*userId\s*\}\)/);
assert.match(route, /campaign\.settings\?\.integrations\?\.foundryUrl/);
assert.match(route, /requestFoundry\(`api\/icons\?\$\{query\}`\)/);
// a folder outside the icon root is refused before it reaches the Foundry host
assert.match(route, /const dir = normalizeIconDirectory\(req\.query\.dir\);/);
});
// --- The bridge on the Foundry host ------------------------------------------------
test("the bridge lists a core icon folder and never leaves the icon root", () => {
assert.match(bridgeSource, /const dataPath = \(process\.env\.DRAGONROLL_FOUNDRY_DATA_PATH \|\| ""\)\.trim\(\);/);
assert.match(bridgeSource, /if \(pathname === "\/api\/icons"\) return sendIconListing\(request, response\);/);
assert.match(bridgeSource, /if \(!dataPath\) return sendJson\(response, 503, \{ status: "error", msg: "foundry\.errors\.icons-unavailable" \}\);/);
const normalize = /function normalizeIconDirectory\(input\) \{[\s\S]*?\n\}/.exec(bridgeSource)?.[0] ?? "";
assert.match(normalize, /segments\.includes\("\.\."\) \|\| segments\[0\] !== iconRoot/);
// the answer is one folder plus the offset of the next page of its icons
assert.match(bridgeSource, /directories\.sort\(\(a, b\) => a\.localeCompare\(b\)\);/);
assert.match(bridgeSource, /const page = files\.slice\(offset, offset \+ limit\);/);
assert.match(bridgeSource, /next: offset \+ page\.length < files\.length \? offset \+ page\.length : null,/);
});
// --- The windows -------------------------------------------------------------------
test("choosing an icon opens its own window from the item sheet", () => {
assert.match(windowDefsSource, /item_icon_source:\s*{\s*title:[^}]*ItemIconSourceWindow\.vue/s);
assert.match(windowDefsSource, /foundry_icons:\s*{\s*title:[^}]*FoundryIconPickerWindow\.vue/s);
// the item window asks where the icon comes from instead of opening a file dialog
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
assert.doesNotMatch(itemWindowSource, /type="file"/);
});
test("the icon source window offers uploading and Foundry, and uploads the local file", () => {
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.upload['"]\)/);
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.foundry['"]\)/);
// upload: a local file, sent through the item route like the character sheet does its photo
assert.match(sourceWindowSource, /type="file" accept="image\/\*"/);
assert.match(sourceWindowSource, /\/item\/upload-image\?item=\$\{itemId\}/);
assert.match(sourceWindowSource, /formData\.append\(['"]image['"], file\)/);
// and it hands the item over to the icon browser, as its child window
assert.match(sourceWindowSource, /CreateChildWindow\(id, ['"]foundry_icons['"]/);
});
test("the icon browser browses the world's icons folder by folder", () => {
assert.match(foundryIconsSource, /\/foundry\/icons\?\$\{params\.toString\(\)\}/);
// one folder per request: navigating a folder asks for it, and going up asks for its parent
assert.match(foundryIconsSource, /Load\(ICON_ROOT\)/);
assert.match(foundryIconsSource, /@click="Load\(folder\.path\)"/);
assert.match(foundryIconsSource, /Load\(listing\.value\.parent \|\| ICON_ROOT\)/);
// lazy in every way that matters: a page of icons at a time, thumbnails fetched when seen
assert.match(foundryIconsSource, /if \(offset\) params\.set\(['"]offset['"], String\(offset\)\)/);
assert.match(foundryIconsSource, /@click="Load\(listing\.dir, listing\.next\)"/);
assert.match(foundryIconsSource, /loading="lazy"/);
// picking an icon stores the world's url and tells the item window about it
assert.match(foundryIconsSource, /Server\(\)\.post\(['"]\/item\/update['"], \{ id: itemId, image: icon\.url \}\)/);
assert.match(foundryIconsSource, /emitter\.emit\(['"]campaign-entry-updated['"], \{ entityType: ['"]item['"], entry: response\.data\.item \}\)/);
assert.match(foundryIconsSource, /ClearWindow\(\{ type: ['"]item_icon_source['"] \}\)/);
});
// --- Strings -----------------------------------------------------------------------
test("every locale names the icon windows and their controls", () => {
for (const locale of ["en", "es", "ca"]) {
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
for (const key of ["icon-source", "foundry-icons"]) {
assert.ok(windows[key], `${locale} is missing the ${key} window title`);
}
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
for (const key of ["intro", "upload", "upload-hint", "foundry", "foundry-hint"]) {
assert.ok(campaigns.item?.["icon-picker"]?.[key], `${locale} is missing campaigns.item.icon-picker.${key}`);
}
const foundry = JSON.parse(read("frontend", "i18n", "locales", locale, "foundry.json"));
for (const key of ["loading", "empty", "load-more", "up"]) {
assert.ok(foundry.icons?.[key], `${locale} is missing foundry.icons.${key}`);
}
for (const key of ["icons-unavailable", "icons-no-world-url"]) {
assert.ok(foundry.errors?.[key], `${locale} is missing foundry.errors.${key}`);
}
}
});

View File

@@ -0,0 +1,69 @@
// Tests for Syndria98/dragonroll#53: the item row in the campaign sidebar dropped its "SYNCED"
// text badge and now leads with the item's own icon on the left of the entry.
//
// The repository root installs no dependencies, so these read the sidebar component the way
// tests/sidebar-entity-entry.test.js does — the checks are about the markup and style of the row.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const source = fs.readFileSync(
path.join(__dirname, "..", "frontend", "app", "components", "partials", "ContentSidebar.vue"),
"utf8"
);
// The block that renders the item rows, from the items section down to its closing template. The
// items section is followed by the maps section (`v-else`), so the first `</template>` that leads
// there ends it; the inner `v-for` close is followed by another close, not by `v-else`.
const itemSection =
/<template v-else-if="activeSection === 'items'">([\s\S]*?)<\/template>\s*\n\s*<template v-else>/.exec(source)?.[1] ?? "";
// `selector` is inserted verbatim, so escape the `.` of a class combination. Comments are dropped:
// they explain a rule, they are not part of it.
function ruleFor(selector) {
const rule = new RegExp(`\\.${selector}\\s*\\{([^}]*)\\}`).exec(source)?.[0];
return rule?.replace(/\/\*[\s\S]*?\*\//g, "");
}
test("the item entry no longer shows the SYNCED text", () => {
assert.ok(itemSection, "expected to find the items section of the sidebar");
assert.doesNotMatch(itemSection, /campaigns\.synced/, "the item row must not render the synced text");
assert.doesNotMatch(itemSection, /entity-entry-sync/, "the item row must not render the synced badge");
});
test("the item entry shows the item's image on the left when it has one", () => {
// the icon renders only for an item that carries an image, resolved through the helper...
assert.match(
itemSection,
/<span v-if="row\.item\.image" class="entity-entry-image"[\s\S]*?<img :src="itemImageUrl\(row\.item\.image\)"/
);
// ...and on the left: it stands before the name in the row markup.
assert.ok(
itemSection.indexOf("entity-entry-image") < itemSection.indexOf("entity-entry-name"),
"the item image must stand to the left of the name"
);
});
test("the item entry lays the icon out beside the name", () => {
const title = ruleFor("entity-entry-title");
assert.ok(title, "expected a .entity-entry-title style rule");
assert.match(title, /display:\s*flex/, "the icon and the name sit side by side");
const image = ruleFor("entity-entry-image");
assert.ok(image, "expected a .entity-entry-image style rule");
assert.match(image, /overflow:\s*hidden/, "the icon is clipped to its box");
});
test("an item image resolves like the item window: uploads from /public, full URLs as they are", () => {
assert.match(source, /import Server, \{ getBaseUrl \} from ['"]~\/services\/Server['"]/);
const resolver = /function itemImageUrl\(image\)\s*\{[\s\S]*?\n\}/.exec(source)?.[0] ?? "";
assert.ok(resolver, "expected an itemImageUrl helper");
assert.match(resolver, /https\?:/, "a full http(s) URL loads as it is");
assert.match(resolver, /data:/, "a data URI loads as it is");
assert.match(resolver, /\$\{getBaseUrl\(\)\}\/public\//, "an uploaded filename resolves as a /public file");
});

View File

@@ -0,0 +1,771 @@
// Tests for item folders following the Foundry world into the campaign
// (Syndria98/dragonroll#44): the world's item directory is grouped into folders, and
// Dragonroll mirrors that tree as Folders of target 'item' and files the synced items
// in them, so its item list reads like the world's. And for those folders' colours
// going both ways (Syndria98/dragonroll#57): the world's colour arrives with its tree,
// and the one the campaign picks travels back on the folder list the module reads.
//
// The repository root installs no dependencies, so each side is loaded the way the
// other tests do it. The sync route runs against a stubbed `require` (express,
// mongoose and the models answer with plain objects and a small filter matcher):
// that keeps the tree, the filing and the pruning observable without a database. The
// Foundry module is loaded into a `node:vm` context holding stubbed Foundry globals
// (`game.folders` included) with fake timers, like tests/foundry-sync-toggle.test.js.
// The grouping of the sidebar list lives in a plain ES module and is read as text.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
// --- The sync route against stubbed models -------------------------------------
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
// lets `select()`, `sort()` and `limit()` sit in between.
function mongooseQuery(value) {
const result = {
select: () => result,
sort: () => result,
limit: (count) => mongooseQuery(value.slice(0, count)),
lean: () => Promise.resolve(value),
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
};
return result;
}
// Enough of the query language the item folder sync uses: equality, $or, $in, $nin,
// $exists. Anything else is a filter this test did not expect and says so.
function matches(document, filter = {}) {
return Object.entries(filter).every(([key, expected]) => {
if (key === "$or") return expected.some((part) => matches(document, part));
const value = document?.[key];
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
return Object.entries(expected).every(([operator, wanted]) => {
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
});
}
return String(value ?? "") === String(expected ?? "");
});
}
function fakeModel(table, seed = []) {
const rows = [];
let counter = 0;
function Document(data = {}) {
counter += 1;
this._id = `${table}-${counter}`;
this.isNew = true;
this.foundryNames = [];
Object.assign(this, data);
}
Document.prototype.save = async function save() {
if (this.isNew) rows.push(this);
this.isNew = false;
return this;
};
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
for (const data of seed) {
const row = new Document({ [table === "folder" ? "target" : "name"]: undefined, ...data });
row.isNew = false;
rows.push(row);
}
const model = function Model(data) { return new Document(data); };
model.rows = rows;
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
model.deleteOne = async (filter) => {
const hit = rows.filter((row) => matches(row, filter));
for (const row of hit) rows.splice(rows.indexOf(row), 1);
return { deletedCount: hit.length };
};
model.deleteMany = async (filter) => {
const hit = rows.filter((row) => matches(row, filter));
for (const row of hit) rows.splice(rows.indexOf(row), 1);
return { deletedCount: hit.length };
};
model.updateMany = async (filter, update) => {
const hit = rows.filter((row) => matches(row, filter));
for (const row of hit) Object.assign(row, update.$set ?? {});
return { modifiedCount: hit.length };
};
return model;
}
function worldItem(over = {}) {
return {
_id: "item-1",
name: "Longsword",
type: "weapon",
system: { quantity: 1, weight: 3, rarity: "common" },
...over,
};
}
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the
// tables with documents the campaign already holds.
function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
const routes = new Map();
const router = {
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
};
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
// Every row belongs to the campaign the sync token belongs to, like every real row
// does: the sync looks its rows up by campaign, so a seeded row without one would be
// invisible to it and a test would pass without touching what it means to check.
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
const models = {
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
"../models/Item": fakeModel("item", seeded(seed.items)),
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
};
const requireStub = (id) => {
if (id === "express") return { Router: () => router };
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
if (id === "../models/Campaign") return { findOne: async () => campaign };
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
if (models[id]) return models[id];
throw new Error(`require("${id}") is not stubbed`);
};
const moduleStub = { exports: {} };
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
requireStub, moduleStub, moduleStub.exports
);
async function call(route, body = {}) {
const handlers = routes.get(route);
assert.ok(handlers, `${route} is not mounted`);
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
await handlers[handlers.length - 1](req, res);
return res.payload;
}
return { call, models, campaign };
}
const FOLDER_TREE = [
{ id: "folder-melee", name: "Melee Weapons", parent: null },
{ id: "folder-ranged", name: "Ranged Weapons", parent: null },
{ id: "folder-powder", name: "Powder Weapons", parent: "folder-ranged" },
];
test("a synced world item arrives in the folder the world keeps it in", async () => {
const sync = loadSyncRoute();
const response = await sync.call("POST /sync/snapshot", {
worldId: "world-1",
actors: [],
folders: FOLDER_TREE,
items: [worldItem({ dragonroll: { folder: "folder-melee" } })],
});
assert.equal(response.status, "ok");
const [folder] = sync.models["../models/Folder"].rows;
assert.equal(folder.name, "Melee Weapons");
assert.equal(folder.target, "item", "a synced folder belongs to the item list, not the notes");
assert.equal(folder.foundryFolderId, "folder-melee");
assert.equal(sync.models["../models/Item"].rows[0].folder, folder._id);
});
test("a nested Foundry folder becomes a nested campaign folder", async () => {
const sync = loadSyncRoute();
await sync.call("POST /sync/item-snapshot", { worldId: "world-1", items: [], folders: FOLDER_TREE });
const folders = sync.models["../models/Folder"].rows;
const ranged = folders.find((folder) => folder.name === "Ranged Weapons");
const powder = folders.find((folder) => folder.name === "Powder Weapons");
assert.equal(powder.parentFolder, ranged._id, "the subfolder hangs under the folder nesting it");
assert.equal(folders.find((folder) => folder.name === "Melee Weapons").parentFolder, null);
});
test("the same world folder is never made twice, and keeps its items", async () => {
const sync = loadSyncRoute();
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1", items: [worldItem({ dragonroll: { folder: "folder-melee" } })], folders: FOLDER_TREE,
});
const filed = sync.models["../models/Item"].rows[0].folder;
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1", items: [worldItem({ dragonroll: { folder: "folder-melee" } })], folders: FOLDER_TREE,
});
assert.equal(sync.models["../models/Folder"].rows.length, FOLDER_TREE.length, "the tree was mirrored once");
assert.equal(sync.models["../models/Item"].rows[0].folder, filed, "the item stays in the folder it was filed in");
});
test("a folder renamed in the world is renamed in the campaign", async () => {
const sync = loadSyncRoute({
seed: { folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Old name", parentFolder: null }] },
});
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1", items: [], folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null }],
});
assert.equal(sync.models["../models/Folder"].rows.length, 1);
assert.equal(sync.models["../models/Folder"].rows[0].name, "Melee Weapons");
});
test("a folder the world dropped goes, and its items move to the root", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons" }],
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
},
});
await sync.call("POST /sync/item-snapshot", { worldId: "world-1", items: [], folders: [] });
assert.deepEqual(sync.models["../models/Folder"].rows, [], "the empty folder row is gone with the world's folder");
assert.equal(sync.models["../models/Item"].rows[0].folder, null, "the item moves to the root instead of nowhere");
});
test("a campaign folder the world does not know is left alone", async () => {
const sync = loadSyncRoute({
seed: { folders: [{ _id: "folder-1", target: "item", name: "Homebrew", parentFolder: null }] },
});
await sync.call("POST /sync/item-snapshot", { worldId: "world-1", items: [], folders: [] });
assert.equal(sync.models["../models/Folder"].rows.length, 1, "only folders mirrored from the world are pruned");
});
test("an item embedded in an actor leaves the folder of its world copy alone", async () => {
const sync = loadSyncRoute({
seed: { items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }] },
});
// The actor's copy carries no folder of its own: the inventory folders an actor
// keeps say nothing about the campaign's item list.
await sync.call("POST /sync/snapshot", {
worldId: "world-1",
actors: [{ _id: "actor-1", name: "Thalia", items: [worldItem({ _id: "item-1" })] }],
items: [],
folders: FOLDER_TREE,
});
assert.equal(sync.models["../models/Item"].rows[0].folder, "folder-1");
});
test("a module that knows nothing about folders leaves them untouched", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons" }],
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
},
});
await sync.call("POST /sync/snapshot", { worldId: "world-1", actors: [], items: [worldItem()] });
await sync.call("POST /sync/item-snapshot", { worldId: "world-1", items: [worldItem()] });
assert.equal(sync.models["../models/Folder"].rows.length, 1, "no tree was sent, so nothing was pruned");
assert.equal(sync.models["../models/Item"].rows[0].folder, "folder-1", "and the item stays filed where it was");
});
test("an item the world moved out of a folder follows it to the root", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons" }],
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
},
});
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1",
items: [worldItem({ dragonroll: { folder: "" } })],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null }],
});
assert.equal(sync.models["../models/Item"].rows[0].folder, null);
});
test("a folder coloured in the world is coloured in the campaign", async () => {
const sync = loadSyncRoute();
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1",
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: "#7f00ff" }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
});
test("a folder the world leaves uncoloured takes the campaign's colour off", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
},
});
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1",
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: null }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, null, "the world has no colour to show, so neither does the campaign");
});
test("a module that says nothing about colours leaves the campaign's colour alone", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
},
});
// A tree pushed by a module that knows folders but not their colours: no colour at all.
await sync.call("POST /sync/snapshot", {
worldId: "world-1",
actors: [],
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
});
test("the folder list the world reads back carries the colours the campaign picked", async () => {
const sync = loadSyncRoute({
seed: {
folders: [
{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#0080ff" },
{ _id: "folder-2", target: "item", name: "Homebrew" },
{ _id: "folder-3", name: "Chapter 1" },
],
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
},
});
const response = await sync.call("GET /sync/items");
assert.equal(response.status, "ok");
assert.equal(response.items.length, 1);
const coloured = response.folders.find((folder) => folder._id === "folder-1");
assert.equal(coloured.foundryFolderId, "folder-melee", "the world's folder to write the colour back to");
assert.equal(coloured.color, "#0080ff");
assert.ok(!response.folders.some((folder) => folder._id === "folder-3"), "only the item list's folders travel back");
});
test("every folder listing says which campaign list it belongs to", () => {
// The sidebar's four lists share the Folder model, so a listing that names no target
// would show folders of the other lists between its own rows. The note routes and
// `/folder/list` ask through `Folder.filterForTarget`, which for the notes names every
// other section instead of the notes' own target: note folders made before the target
// field existed carry none at all. tests/entry-folders.test.js runs these routes.
for (const route of ["note.js", "folder.js"]) {
const source = read("backend", "src", "routes", route);
const listings = source.match(/Folder\.find\(/g) ?? [];
assert.ok(listings.length, `${route} lists folders`);
const filtered = source.match(/Folder\.find\(\{[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`);
}
});
test("the item list comes with the folders it groups into, and items carry theirs", () => {
assert.match(read("backend", "src", "models", "Item.js"), /folder:\s*{\s*type:\s*Schema\.Types\.ObjectId,\s*ref:\s*'Folder'/);
const itemRoute = read("backend", "src", "routes", "item.js");
assert.match(itemRoute, /res\.json\(\{\s*status:\s*'ok',\s*items,\s*folders:/);
assert.match(itemRoute, /Folder\.find\(\{\s*campaign:\s*campaignId,\s*target:\s*'item'\s*\}/);
});
// --- The Foundry module sends its folder tree ------------------------------------
function makeWorld() {
const state = {
hooks: new Map(),
registered: new Map(),
requests: [],
timers: new Map(),
intervals: new Map(),
// What Dragonroll answers a folder reconcile with: the campaign's folders and the
// colours its user gave them.
remoteFolders: [],
nextTimerId: 1,
};
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.itemId"); an
// embedded update names the row to write them on, so `_id` is not a path to set.
function writeFoundryPaths(target, data) {
for (const [key, value] of Object.entries(data)) {
if (key === "_id") continue;
const parts = key.split(".");
const last = parts.pop();
let node = target;
for (const part of parts) node = node[part] ??= {};
node[last] = value;
}
return target;
}
// A Folder document, plain data and the `update` both the GM and Dragonroll write with.
const makeFolder = (id, name, over = {}) => ({
id, name, type: "Item", parent: null, color: null, documentName: "Folder",
async update(data) { return writeFoundryPaths(this, data); },
...over,
});
const folders = [
makeFolder("folder-melee", "Melee Weapons", { color: "#8b0000" }),
makeFolder("folder-ranged", "Ranged Weapons", { parent: "folder-melee" }),
// An actor's own inventory folder: it hangs off the actor, not the world.
makeFolder("folder-carried", "Carried", { parent: { id: "actor-1", documentName: "Actor" } }),
makeFolder("folder-journal", "Lore", { type: "JournalEntry" }),
];
const items = [
{
id: "item-1", name: "Longsword", type: "weapon", documentName: "Item", parent: null,
folder: "folder-melee",
system: { properties: { value: [] }, quantity: 1, weight: 3, rarity: "common" },
toObject() { return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: {} }; },
},
{
id: "item-2", name: "Torch", type: "loot", documentName: "Item", parent: null, folder: "",
system: { properties: { value: [] }, quantity: 1, weight: 1, rarity: "common" },
toObject() { return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: {} }; },
},
];
const carriedItem = {
id: "item-3", name: "Caltrops", type: "loot", documentName: "Item", parent: { documentName: "Actor" },
folder: "folder-carried",
system: { properties: { value: [] }, quantity: 4, weight: 0, rarity: "common" },
toObject() { return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: {} }; },
};
const actors = [
{
id: "actor-1", name: "Thalia", type: "character", documentName: "Actor", flags: {},
items: { contents: [carriedItem] },
getFlag() { return undefined; },
async update(data) { return writeFoundryPaths(this, data); },
// Embedded documents are written through the document holding them, and each
// update names the row it belongs to.
async updateEmbeddedDocuments(_kind, updates) {
for (const update of updates) {
if (carriedItem.id === update._id) writeFoundryPaths(carriedItem, update);
}
return [];
},
toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags }; },
},
];
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
const sandbox = {
console: { log() {}, info() {}, warn() {}, error() {} },
URL,
CONFIG: {},
window: { location: { origin: "http://vtt.test" } },
ui: { notifications: { info() {}, warn() {}, error() {} } },
Hooks: {
once(name, fn) { state.hooks.set(name, [fn]); },
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
},
setTimeout: (fn, delay = 0) => {
const id = state.nextTimerId++;
state.timers.set(id, { fn, delay });
return id;
},
clearTimeout: (id) => state.timers.delete(id),
setInterval: (fn, delay = 0) => {
// Recorded, never run by itself: tests ask for a periodic reconcile with
// `runIntervals`, so the ones watching single pushes stay on their own.
const id = state.nextTimerId++;
state.intervals.set(id, { fn, delay });
return id;
},
clearInterval: (id) => state.intervals.delete(id),
fetch: async (url, options = {}) => {
const href = String(url);
state.requests.push({
href,
method: options.method,
body: options.body ? JSON.parse(options.body) : null,
});
const payload = { status: "ok", actors: [], items: [] };
if (href.includes("foundry/sync/items")) payload.folders = state.remoteFolders;
return { ok: true, status: 200, json: async () => payload };
},
Actor: { async create() { return null; } },
Item: { async create() { return null; } },
};
sandbox.game = {
user: { isGM: true },
world: { id: "world-1", title: "Test World" },
system: { id: "dnd5e" },
modules: { get: () => ({}) },
actors: { contents: actors, get: (id) => actors.find((actor) => actor.id === id) },
items: { contents: items, get: (id) => items.find((item) => item.id === id) },
folders: { contents: folders, get: (id) => folders.find((folder) => folder.id === id) },
settings: {
register(module, key, definition) {
state.registered.set(key, definition);
if (!(key in settingsStore)) settingsStore[key] = definition.default;
},
get(module, key) { return settingsStore[key]; },
async set(module, key, value) {
settingsStore[key] = value;
await state.registered.get(key)?.onChange?.(value);
},
},
};
vm.createContext(sandbox);
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
state.game = sandbox.game;
state.folder = (id) => folders.find((folder) => folder.id === id);
state.item = (id) => items.find((item) => item.id === id);
state.syncRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync")
&& !request.href.includes("foundry/sync/status"));
state.pushes = (route) => state.syncRequests().filter((request) => request.href.includes(route));
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
state.fire = async (name, ...args) => {
for (const handler of state.hooks.get(name) || []) await handler(...args);
await drain();
};
state.runTimers = async () => {
for (let round = 0; round < 6; round += 1) {
if (!state.timers.size && round > 2) break;
const due = [...state.timers.values()];
state.timers.clear();
for (const timer of due) await timer.fn();
await drain();
}
};
// The reconciles `setInterval` registered: what runs every few seconds on a world
// that is linked, and so what carries Dragonroll's folder colours back into the world.
state.runIntervals = async () => {
for (const interval of [...state.intervals.values()]) await interval.fn();
await drain();
};
state.linkedSetup = async () => {
await state.fire("init");
await state.fire("ready");
await state.runTimers();
state.requests.length = 0;
return state;
};
return state;
}
test("the world sends its item folder tree with a snapshot", async () => {
const world = await makeWorld().linkedSetup();
await world.fire("updateActor", world.game.actors.contents[0]);
await world.runTimers();
const [push] = world.pushes("foundry/sync/snapshot");
assert.ok(push, "the actor change pushed a snapshot");
assert.deepEqual(push.body.folders, [
{ id: "folder-melee", name: "Melee Weapons", parent: null, color: "#8b0000" },
{ id: "folder-ranged", name: "Ranged Weapons", parent: "folder-melee", color: null },
], "the item directory tree, nested and coloured, without the actor's own or another type's folders");
const longsword = push.body.items.find((item) => item._id === "item-1");
assert.equal(longsword.dragonroll.folder, "folder-melee", "a world item says which folder it stands in");
const torch = push.body.items.find((item) => item._id === "item-2");
assert.equal(torch.dragonroll.folder, "", "and which one stands at the root");
});
test("an item embedded in an actor does not report the actor's inventory folders", async () => {
const world = await makeWorld().linkedSetup();
await world.fire("updateActor", world.game.actors.contents[0]);
await world.runTimers();
const [push] = world.pushes("foundry/sync/snapshot");
const carried = push.body.actors[0].items.find((item) => item._id === "item-3");
assert.equal(carried.dragonroll?.folder, undefined, "the actor copy carries no folder for the campaign");
});
test("a live item edit carries the folder tree too", async () => {
const world = await makeWorld().linkedSetup();
await world.fire("updateItem", world.item("item-1"));
await world.runTimers();
const [push] = world.pushes("foundry/sync/item-snapshot");
assert.deepEqual(push.body.folders.map((folder) => folder.id), ["folder-melee", "folder-ranged"]);
assert.equal(push.body.items[0].dragonroll.folder, "folder-melee");
});
test("a folder change reaches Dragonroll without pushing the items in it", async () => {
const world = await makeWorld().linkedSetup();
const melee = world.folder("folder-melee");
melee.name = "Close Weapons";
await world.fire("updateFolder", melee);
await world.runTimers();
const [push] = world.pushes("foundry/sync/item-snapshot");
assert.deepEqual(push.body.items, [], "the items themselves are left alone");
assert.deepEqual(push.body.folders.map((folder) => [folder.id, folder.name]), [
["folder-melee", "Close Weapons"],
["folder-ranged", "Ranged Weapons"],
]);
});
test("a folder the GM colours sends its colour with the tree", async () => {
const world = await makeWorld().linkedSetup();
const ranged = world.folder("folder-ranged");
ranged.color = "#123456";
await world.fire("updateFolder", ranged);
await world.runTimers();
const [push] = world.pushes("foundry/sync/item-snapshot");
assert.deepEqual(push.body.folders.map((folder) => [folder.id, folder.color]), [
["folder-melee", "#8b0000"],
["folder-ranged", "#123456"],
], "every folder reports the colour the world shows for it, `null` for one it left uncoloured");
});
test("a folder of another document type does not touch the item list", async () => {
const world = await makeWorld().linkedSetup();
await world.fire("updateFolder", world.folder("folder-journal"));
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
});
test("autosync off: folder changes stop syncing", async () => {
const world = await makeWorld().linkedSetup();
await world.game.settings.set("dragonroll-foundry", "autoSync", false);
await world.fire("updateFolder", world.folder("folder-melee"));
await world.fire("updateItem", world.item("item-1"));
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
});
// --- The colours the campaign gives those folders travel back to the world ---------
test("a folder coloured in the Dragonroll campaign is coloured in the world", async () => {
const world = await makeWorld().linkedSetup();
world.remoteFolders = [
{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" },
// A folder the campaign made for its own items: there is no world document to colour.
{ _id: "db-homebrew", name: "Homebrew", color: "#00ff00" },
];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, "#0080ff");
assert.equal(world.folder("folder-ranged").color, null, "a folder the campaign says nothing about keeps what the world shows");
assert.deepEqual(world.requests.filter((request) => request.method === "POST"), [],
"Dragonroll's own write is not pushed back to the campaign as a world change");
});
test("a colour taken off in the campaign comes off the world's folder", async () => {
const world = await makeWorld().linkedSetup();
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: null }];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, null, "uncoloured in the campaign is uncoloured in the world");
});
test("autosync off: the campaign's folder colours are not written into the world", async () => {
const world = await makeWorld().linkedSetup();
await world.game.settings.set("dragonroll-foundry", "autoSync", false);
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" }];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, "#8b0000", "the world keeps what it shows while autosync is off");
});
// --- The sidebar groups its items under those folders ----------------------------
// `vm.compileFunction` is synchronous, so the service is ready right away. Loading it with
// a top-level `await` instead makes Node read this whole file as an ES module, where
// `require` is not defined and none of these tests run at all.
function loadItemFoldersService() {
const source = read("frontend", "app", "services", "ItemFolders.js").replace("export { BuildItemRows };", "return { BuildItemRows };");
return vm.compileFunction(source)();
}
const { BuildItemRows } = loadItemFoldersService();
const SIDEBAR_FOLDERS = [
{ _id: "f-melee", name: "Melee Weapons" },
{ _id: "f-ranged", name: "Ranged Weapons" },
{ _id: "f-powder", name: "Powder Weapons", parentFolder: "f-ranged" },
];
const SIDEBAR_ITEMS = [
{ _id: "i-sword", name: "Longsword", folder: "f-melee" },
{ _id: "i-pistol", name: "Pistol", folder: "f-powder" },
{ _id: "i-torch", name: "Torch" },
];
test("items are grouped under the folder they stand in, nested", () => {
const shape = BuildItemRows(SIDEBAR_ITEMS, SIDEBAR_FOLDERS).map((row) => [
row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth,
]);
assert.deepEqual(shape, [
["folder", "Melee Weapons", 0],
["folder", "Ranged Weapons", 0],
["folder", "Powder Weapons", 1],
["item", "Pistol", 1],
["item", "Torch", 0],
["item", "Longsword", 1],
]);
});
test("a collapsed folder hides its whole subtree", () => {
const rows = BuildItemRows(SIDEBAR_ITEMS, SIDEBAR_FOLDERS, ["f-ranged"]);
assert.ok(rows.some((row) => row.kind === "folder" && row.folder.name === "Ranged Weapons"));
assert.ok(!rows.some((row) => row.kind === "item" && row.item.name === "Pistol"), "the nested item is hidden too");
});
test("without any folder the list is the plain item list", () => {
const rows = BuildItemRows([{ _id: "i-1", name: "Torch" }, { _id: "i-2", name: "Longsword" }], []);
assert.deepEqual(rows.map((row) => [row.kind, row.item.name, row.depth]), [
["item", "Longsword", 0],
["item", "Torch", 0],
]);
});
test("an item whose folder is gone, or a folder nested in itself, reads as a root item", () => {
const rows = BuildItemRows(
[{ _id: "i-1", name: "Torch", folder: "f-gone" }],
[{ _id: "f-a", name: "A", parentFolder: "f-b" }, { _id: "f-b", name: "B", parentFolder: "f-a" }],
);
const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]);
assert.ok(shape.includes(["item", "Torch"]), "the item is not lost with the folder that was removed");
assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"]));
assert.equal(rows.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
});
test("every locale labels the folder row", () => {
for (const locale of ["en", "es", "ca"]) {
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
assert.ok(campaigns.folders?.["toggle"], `${locale} is missing campaigns.folders.toggle`);
}
});

View File

@@ -0,0 +1,108 @@
// Tests for Syndria98/dragonroll#35: clicking an item in the campaign sidebar opens a window with
// the item's info, and that window can pick the item's icon — Foundry's own when the item is synced,
// or an uploaded one.
//
// The mapper from a Foundry item to Dragonroll item fields is a pure CommonJS service, so it is
// required and called directly. The window wiring lives in files this repository installs no
// dependencies for, so those checks read the sources, like tests/map-viewer.test.js does.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const { foundryItemToItemData } = require(path.join(__dirname, "..", "backend", "src", "services", "item-foundry"));
const sidebarSource = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
const itemWindowSource = read("frontend", "app", "components", "windows", "ItemSheetWindow.vue");
const itemRouteSource = read("backend", "src", "routes", "item.js");
const itemModelSource = read("backend", "src", "models", "Item.js");
const foundryLinkSource = read("backend", "src", "routes", "foundry-link.js");
const moduleSource = read("dragonroll-foundry", "scripts", "api.js");
test("a synced Foundry item carries its icon over to the Dragonroll item", () => {
const fields = foundryItemToItemData({
name: "Longsword",
type: "weapon",
img: "http://vtt.test/icons/svg/sword.svg",
system: { quantity: 1, weight: 3, rarity: "common" },
});
assert.equal(fields.image, "http://vtt.test/icons/svg/sword.svg");
});
test("a Foundry item without an icon maps to an empty one", () => {
const fields = foundryItemToItemData({ name: "Torch", type: "loot", system: { quantity: 1 } });
assert.equal(fields.image, "");
});
test("the Item model stores the icon and the icon Foundry last sent", () => {
assert.match(itemModelSource, /image:\s*{\s*type:\s*String/);
assert.match(itemModelSource, /foundryImage:\s*{\s*type:\s*String/);
});
test("Foundry sync keeps foundryImage even when the save preserves Dragonroll edits", () => {
// The preserve-edits rule must not cover foundryImage: it is Foundry's state,
// and the item window offers it back after the user picked their own icon.
const keep = /if \(!fullSync \|\| item\.isNew\) Object\.assign\(item, fields\);([\s\S]{0,220}?)if \(!item\.foundryNames/.exec(foundryLinkSource);
assert.ok(keep, "expected the foundryImage keep between the guarded assign and the name bookkeeping");
assert.match(keep[1], /if \(fields\.image\) item\.foundryImage = fields\.image;/);
});
test("the item routes accept the icon and upload one", () => {
assert.match(itemRouteSource, /router\.post\(["']\/upload-image["'], upload\.single\(["']image["']\)/);
assert.match(itemRouteSource, /req\.query\.item \|\| req\.body\.item/);
assert.match(itemRouteSource, /item\.image = req\.file\.filename/);
// the upload checks ownership like every other item handler
const uploadRoute = /router\.post\(["']\/upload-image[\s\S]*?module\.exports/.exec(itemRouteSource)?.[0] ?? itemRouteSource;
assert.match(uploadRoute, /userOwnsCampaign\(item\.campaign, req\.user\.id\)/);
// /update accepts the icon so the window can switch between own and Foundry's
assert.match(itemRouteSource, /if \(image !== undefined\) item\.image = String\(image\);/);
});
test("the item info window is registered and opens on a sidebar click", () => {
assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s);
// clicking (or Enter/Space on) an item row opens the window instead of expanding inline.
// Since #44 the rows come from the folder tree the world synced, so the row holds the item.
assert.match(sidebarSource, /v-for="row in itemRows"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/);
assert.doesNotMatch(sidebarSource, /toggleEntryDetails/);
});
test("the item window shows the info and offers both icon sources", () => {
// info: name, category, rarity, quantity, weight, properties, description
for (const key of ["form.name", "form.category", "form.rarity", "form.quantity", "form.weight", "form.properties", "form.description"]) {
assert.ok(itemWindowSource.includes(key), `expected the window to render ${key}`);
}
// own icon: #65 moved picking one into a window of its own, which uploads through
// the item route (see tests/foundry-icon-picker.test.js); the sheet opens it and
// follows whatever the choice leaves behind.
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
// Foundry icon: switch the item image back to the one the world sent
assert.match(itemWindowSource, /form\.value\.foundryImage/);
assert.match(itemWindowSource, /updateItem\(\{ image: form\.value\.foundryImage \}\)/);
// uploads resolve as backend /public files, world URLs load as they are
assert.match(itemWindowSource, /\$\{getBaseUrl\(\)\}\/public\//);
});
test("the Foundry module sends item icons as URLs Dragonroll can load", () => {
// actor-embedded items go through the same serializer as world items
assert.match(moduleSource, /items:\s*\(actor\.items\?\.contents\?\.map\(serializeFoundryItem\)/);
// the icon chosen in Dragonroll travels back into the linked world
assert.match(moduleSource, /const image = getDragonrollImageUrl\(entry\.image\);\s*if \(image\) updates\.img = image;/);
assert.match(moduleSource, /img: getDragonrollImageUrl\(entry\.image\) \|\| undefined,\s*system:/);
});
test("every locale names the item window and its icon controls", () => {
for (const locale of ["en", "es", "ca"]) {
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
assert.ok(windows["item-sheet"], `${locale} is missing the item window title`);
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
for (const key of ["choose-icon", "change-icon", "foundry-icon", "remove-icon", "upload-error"]) {
assert.ok(campaigns.item?.sheet?.[key], `${locale} is missing campaigns.item.sheet.${key}`);
}
}
});

View File

@@ -0,0 +1,217 @@
// Tests for "Manage accounts" of Syndria98/dragonroll#51: the button on the settings window's site
// administration tab opened a window type (`account_management`) that was never registered in
// `WindowDefinitions.js`, so `getComponent` dereferenced `defWindows[type].component` on `undefined` —
// `can't access property "component", (intermediate value)[type] is undefined` — instead of opening
// anything. The window is the site administration screen now (list accounts, create one, grant or
// take administrator rights, delete one), guarded on the backend by the `isAdmin` middleware.
//
// Like tests/settings-window.test.js, the window wiring is read from the sources; the window registry
// is also checked against every window type the frontend opens, which is what catches this class of
// bug before the click does.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const frontendApp = path.join(__dirname, "..", "frontend", "app");
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
const settingsWindowSource = read("frontend", "app", "components", "windows", "SettingsWindow.vue");
const accountsWindowSource = read("frontend", "app", "components", "windows", "AccountManagementWindow.vue");
const userRouteSource = read("backend", "src", "routes", "user.js");
// -- the window registry -------------------------------------------------------
// Top-level entries of `defWindows`: every entry sits at 2 spaces, its contents at 4+.
function registryEntries() {
const header = /^ {2}([A-Za-z_]\w*):\s*\{/gm;
const marks = [];
let match;
while ((match = header.exec(windowDefsSource))) marks.push({ type: match[1], index: match.index });
assert.ok(marks.length > 0, "expected window definitions to register windows");
const entries = {};
marks.forEach((mark, i) => {
const end = i + 1 < marks.length ? marks[i + 1].index : windowDefsSource.length;
entries[mark.type] = windowDefsSource.slice(mark.index, end);
});
return entries;
}
function* sourceFiles(dir) {
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const full = path.join(dir, entry.name);
if (entry.isDirectory()) yield* sourceFiles(full);
else if (/\.(vue|js|ts)$/.test(entry.name)) yield full;
}
}
test("account_management is a registered window with a component on disk", () => {
const entries = registryEntries();
const definition = entries["account_management"];
assert.ok(definition, "account_management must be registered or getComponent opens undefined");
assert.match(definition, /AccountManagementWindow\.vue/);
const component = path.join(frontendApp, "components", "windows", "AccountManagementWindow.vue");
assert.ok(fs.existsSync(component), "the window component file must exist");
});
test("no window is opened with a type that is not registered", () => {
const registered = registryEntries();
// The type is the first string argument of CreateWindow; CreateChildWindow takes a parent
// (GetFirstWindowId('main_menu')-style, a registered type itself) before the type. Data
// objects after it hold strings that mean nothing to the registry, so they stay unmatched.
const createWindow = /CreateWindow\(\s*['"]([a-z_]+)['"]/g;
const createChildWindow = /CreateChildWindow\(\s*(?:GetFirstWindowId\(\s*['"]([a-z_]+)['"]\s*\)|[a-z_]+)\s*,\s*['"]([a-z_]+)['"]/g;
for (const file of sourceFiles(frontendApp)) {
const source = fs.readFileSync(file, "utf8");
const found = [...source.matchAll(createWindow), ...source.matchAll(createChildWindow)];
for (const match of found) {
for (const type of match.slice(1)) {
if (!type) continue;
assert.ok(
registered[type],
`${path.relative(frontendApp, file)} opens '${type}', which WindowDefinitions.js does not define`
);
}
}
}
});
test("every registered window points at a component file that exists", () => {
for (const [type, definition] of Object.entries(registryEntries())) {
const imported = /import\(['"]([^'"]+)['"]\)/.exec(definition)?.[1];
assert.ok(imported, `${type} must import a component`);
const file = path.join(frontendApp, imported.replace(/^~\//, ""));
assert.ok(fs.existsSync(file), `${type} points at ${imported}, which is not there`);
}
});
// -- opening it from the settings window ----------------------------------------
const openManageAccounts = /function OpenManageAccounts\(\)\s*\{[\s\S]*?\n\}/.exec(settingsWindowSource)?.[0];
test("the settings tab opens the account window and can come back", () => {
assert.ok(openManageAccounts, "expected an OpenManageAccounts in the settings window");
assert.match(openManageAccounts, /CreateWindow\(\s*'account_management'/);
// ClearWindow takes a selector object; a bare string matched neither `selector.type` nor
// `selector.id` and closed nothing, leaving both windows stacked.
assert.match(openManageAccounts, /ClearWindow\(\s*\{\s*type:\s*'settings'\s*\}\s*\)/);
assert.match(openManageAccounts, /ClearWindow\(\s*\{\s*type:\s*'account_management'\s*\}\s*\)/);
assert.match(openManageAccounts, /CreateWindow\(\s*'settings'/, "back returns to the settings window");
assert.doesNotMatch(settingsWindowSource, /ClearWindow\(\s*['"]/g, "no ClearWindow call may pass a bare string");
});
// -- the account management window ------------------------------------------------
test("the account window talks to the account management endpoints", () => {
assert.match(accountsWindowSource, /Server\(\)\.get\(['"]\/user\/list['"]/);
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/create['"]/);
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/set-admin['"]/);
assert.match(accountsWindowSource, /Server\(\)\.post\(['"]\/user\/delete['"]/);
});
test("the window closes the switches on the row of the admin using it", () => {
// The server answers the same way to anybody who still posts it (see below); the row just
// does not invite the attempt.
assert.match(accountsWindowSource, /v-if="!IsSelf\(user\)"/);
assert.match(accountsWindowSource, /GetUser\(\)\?\._id/);
});
// -- the backend routes -----------------------------------------------------------
function routeDeclaration(method, route) {
const declaration = new RegExp(`router\\.${method}\\(['"]${route}['"][^\\n]*`).exec(userRouteSource)?.[0];
assert.ok(declaration, `expected a ${method.toUpperCase()} ${route} route`);
// /api/user is mounted before the JWT guard: without inline authentication the route would
// be public to any request (landmine 5 of AGENTS.md), and only an admin may manage accounts.
assert.match(declaration, /passport\.authenticate\(['"]jwt['"]/);
assert.match(declaration, /isAdmin/, `${route} may only be answered for an administrator`);
return declaration;
}
function routeBlock(method, route) {
const start = userRouteSource.indexOf(`router.${method}('${route}'`);
assert.ok(start !== -1, `expected a ${method.toUpperCase()} ${route} route`);
const next = userRouteSource.indexOf(`\nrouter.`, start + 1);
return userRouteSource.slice(start, next === -1 ? userRouteSource.length : next);
}
test("GET /user/list answers the accounts without passwords or setup codes", () => {
routeDeclaration("get", "/list");
assert.match(routeBlock("get", "/list"), /select\(['"]-password -setupCode['"]\)/);
});
test("POST /user/create stores a hashed password and refuses duplicates", () => {
const block = routeBlock("post", "/create");
assert.match(block, /bcrypt\.hash\(password/, "the password must not go in as it came");
assert.match(block, /register\.errors\.email-username-exists/, "duplicates answer with the register message");
assert.doesNotMatch(block, /setupCode/, "no half-finished setup account is invented here");
});
for (const route of ["/set-admin", "/delete"]) {
test(`POST /user${route} refuses to act on the admin that is asking`, () => {
routeDeclaration("post", route);
const block = routeBlock("post", route);
assert.match(block, /String\(req\.user\._id\) === String\(id\)/, "an admin keeps their own account closed");
assert.match(block, /errors\.internal/);
});
}
// -- i18n --------------------------------------------------------------------------
test("every locale titles the account window and names its strings", () => {
const required = [
"accounts.you",
"accounts.admin",
"accounts.make-admin",
"accounts.remove-admin",
"accounts.delete",
"accounts.new-account",
"accounts.name",
"accounts.username",
"accounts.email",
"accounts.password",
"accounts.create",
"accounts.created",
"accounts.updated",
"accounts.deleted",
"accounts.errors.self-admin",
"accounts.errors.self-delete",
];
for (const locale of ["en", "es", "ca"]) {
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
assert.ok(windows["account-management"]?.trim(), `${locale} is missing the account window title`);
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
assert.ok(settings["site-administration"]?.["manage-accounts"]?.trim(), `${locale} is missing manage accounts`);
for (const key of required) {
const value = key.split(".").reduce((node, part) => node?.[part], settings["site-administration"]);
assert.ok(value?.trim(), `${locale} is missing settings.site-administration.${key}`);
}
}
});
test("every accounts string the window translates exists in every locale", () => {
// $t keys with nothing to translate fall back to the key itself, so every accounts key the
// window uses has to be carried by every locale. (`errors.internal` is the envelope fallback
// every window toasts the same way and stays out of it.)
const used = [...new Set(
[...accountsWindowSource.matchAll(/\$t\(\s*['"](settings\.site-administration\.accounts\.[\w.-]+)['"]/g)]
.map((key) => key[1])
)];
assert.ok(used.length >= 14, `expected the window's translated strings, found ${used.length}`);
for (const locale of ["en", "es", "ca"]) {
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
for (const key of used) {
const value = key.split(".").slice(1).reduce((node, part) => node?.[part], settings);
assert.ok(typeof value === "string" && value.trim(), `${locale} is missing ${key}`);
}
}
});

381
tests/map-pins.test.js Normal file
View File

@@ -0,0 +1,381 @@
// Tests for the notes pinned onto a map (Syndria98/dragonroll#20): right clicking a map pins one of
// the campaign notes at that spot, and clicking the marker reads the linked note in a window.
//
// The repository root installs no dependencies, so both sides are loaded into `node:vm` contexts.
// The express routers run against a stubbed `require` (express itself, multer and the mongoose
// models) answering with plain objects: that keeps the ownership, same-campaign and dedup rules of
// POST /map/pin observable without a database. `frontend/app/services/MapPins.js` holds the image ↔
// screen translation and the note picker labels, and is loaded the way map-viewer.test.js loads
// Content.js. The last checks read the template of the map viewer, because there the wiring itself
// is what has to stay right.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
function readRepoFile(...parts) {
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
}
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and lets `select()`
// and `sort()` sit in between.
function mongooseQuery(value) {
const result = {
select: () => result,
sort: () => result,
lean: () => Promise.resolve(value),
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
};
return result;
}
// Loads an express router file with every module it requires stubbed out: `stubs` maps a require
// path ("../models/Map") to the module the route should see.
function loadRouter(relativeParts, stubs) {
const routes = new Map();
const router = {
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
};
const requireStub = (id) => {
if (id === "express") return { Router: () => router };
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
if (!(id in stubs)) throw new Error(`require("${id}") is not stubbed`);
return stubs[id];
};
// Both files only need `require`, `module` and `exports`, so they are compiled as functions in
// the realm of the tests: the objects the routes build are then plain host objects to assert on.
const moduleStub = { exports: {} };
vm.compileFunction(readRepoFile(...relativeParts), ["require", "module", "exports"])(
requireStub, moduleStub, moduleStub.exports
);
async function call(route, { body = {}, query = {}, params = {}, user = { id: "user-1" } } = {}) {
const handlers = routes.get(route);
assert.ok(handlers, `${route} is not mounted`);
const res = { payload: null, json(payload) { this.payload = payload; } };
// The multer middleware the routes mount is stubbed away, so the handler is the last one.
await handlers[handlers.length - 1]({ body, query, params, user }, res);
return res.payload;
}
return { routes, call };
}
function makeMap(pins = []) {
return { _id: "map-1", campaign: "campaign-1", pins, save: async () => {} };
}
function loadMapRoutes({ ownsCampaign = true, maps = [], notes = [] } = {}) {
return loadRouter(["backend", "src", "routes", "map.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Map": { findById: (id) => mongooseQuery(maps.find((map) => map._id === id) ?? null) },
"../models/Note": {
findOne: (filter) => mongooseQuery(
notes.some((note) => note._id === String(filter._id) && String(note.campaign) === String(filter.campaign))
? { _id: String(filter._id) }
: null
),
},
// The pins do not ask after actors, only the token routes below do.
"../models/Actor": { findOne: () => mongooseQuery(null) },
});
}
function mapPinRouteTests() {
test("pinning a note stores it at the spot that was clicked", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 420, y: 96 } });
assert.equal(response.status, "ok");
assert.deepEqual(map.pins, [{ note: "note-1", x: 420, y: 96 }]);
});
test("a pin keeps whole image pixels and never goes off the top left corner", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
// Coordinates arrive as strings from a multipart form, and a drag can leave the image.
await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: "120.6", y: -8 } });
assert.deepEqual(map.pins, [{ note: "note-1", x: 121, y: 0 }]);
});
test("a note of another campaign cannot be pinned onto a map", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-2", campaign: "campaign-2" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-2", x: 10, y: 10 } });
assert.equal(response.msg, "errors.notfound");
assert.deepEqual(map.pins, []);
});
test("a map of somebody else's campaign answers unauthorized", async () => {
const map = makeMap();
const api = loadMapRoutes({ ownsCampaign: false, maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 10, y: 10 } });
assert.equal(response.msg, "unauthorized");
assert.deepEqual(map.pins, []);
});
test("pinning a note again moves its marker instead of adding a twin", async () => {
const map = makeMap([{ _id: "pin-1", note: "note-1", x: 10, y: 10 }]);
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 300, y: 220 } });
assert.equal(map.pins.length, 1);
assert.deepEqual({ ...map.pins[0] }, { _id: "pin-1", note: "note-1", x: 300, y: 220 });
});
test("pinning needs both a map and a note", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
assert.equal((await api.call("POST /pin", { body: { note: "note-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.equal((await api.call("POST /pin", { body: { id: "map-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.deepEqual(map.pins, []);
});
test("unpin removes the pin it is given and keeps the others", async () => {
const map = makeMap([
{ _id: "pin-1", note: "note-1", x: 10, y: 10 },
{ _id: "pin-2", note: "note-2", x: 20, y: 20 },
]);
const api = loadMapRoutes({ maps: [map], notes: [] });
const response = await api.call("POST /unpin", { body: { id: "map-1", pin: "pin-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(map.pins.map((pin) => pin._id), ["pin-2"]);
});
test("unpin of a map of somebody else keeps its pins", async () => {
const map = makeMap([{ _id: "pin-1", note: "note-1", x: 10, y: 10 }]);
const api = loadMapRoutes({ ownsCampaign: false, maps: [map] });
const response = await api.call("POST /unpin", { body: { id: "map-1", pin: "pin-1" } });
assert.equal(response.msg, "unauthorized");
assert.equal(map.pins.length, 1);
});
}
function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deletedCount = 1 } = {}) {
const pinsPulled = [];
const api = loadRouter(["backend", "src", "routes", "note.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Note": {
find: () => mongooseQuery(notes),
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
deleteOne: () => mongooseQuery({ deletedCount }),
},
"../models/Folder": { find: () => mongooseQuery(folders) },
"../models/Map": {
// The driver drops the pins of the note from every map holding one; what is worth
// keeping here is the filter it is asked to do that with.
updateMany: async (filter, update) => {
pinsPulled.push({ filter, update });
return { modifiedCount: 1 };
},
},
});
return { api, pinsPulled };
}
function campaignNotesTests() {
const notes = [
{ _id: "note-1", title: "The Altar", folder: "folder-2" },
{ _id: "note-2", title: "The Inn", folder: null },
];
const folders = [
{ _id: "folder-1", name: "Undercity" },
{ _id: "folder-2", name: "Temple", parentFolder: "folder-1" },
];
test("the note picker answers with every note and the folders they live in", async () => {
const { api } = loadNoteRoutes({ notes, folders });
const response = await api.call("GET /all", { query: { campaign: "campaign-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(response.notes.map((note) => note.title), ["The Altar", "The Inn"]);
assert.deepEqual(response.folders.map((folder) => folder.name), ["Undercity", "Temple"]);
});
test("the note picker needs a campaign, and only of one's own", async () => {
const { api } = loadNoteRoutes({ notes, folders });
const { api: foreignCampaign } = loadNoteRoutes({ ownsCampaign: false, notes, folders });
assert.equal((await api.call("GET /all")).msg, "errors.missing-data");
assert.equal((await foreignCampaign.call("GET /all", { query: { campaign: "campaign-1" } })).msg, "unauthorized");
});
test("a note can be read on its own, the way a map pin asks for it", async () => {
const { api } = loadNoteRoutes({ notes: [{ _id: "note-1", title: "The Altar", content: "## The altar" }] });
const response = await api.call("GET /retrieve/:id", { params: { id: "note-1" } });
assert.equal(response.status, "ok");
assert.equal(response.note.content, "## The altar");
});
test("a note of a campaign the user does not own cannot be read", async () => {
const { api } = loadNoteRoutes({ ownsCampaign: false, notes: [{ _id: "note-1", title: "The Altar" }] });
const response = await api.call("GET /retrieve/:id", { params: { id: "note-1" } });
assert.equal(response.msg, "unauthorized");
});
test("deleting a note pulls the pins pointing at it", async () => {
const { api, pinsPulled } = loadNoteRoutes({ notes: [{ _id: "note-1", title: "The Altar" }] });
const response = await api.call("POST /delete", { body: { id: "note-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(pinsPulled, [{ filter: { "pins.note": "note-1" }, update: { $pull: { pins: { note: "note-1" } } } }]);
});
test("deleting a note that is not there does not touch any map", async () => {
const { api, pinsPulled } = loadNoteRoutes({ notes: [], deletedCount: 0 });
const response = await api.call("POST /delete", { body: { id: "note-9" } });
assert.equal(response.msg, "errors.notfound");
assert.deepEqual(pinsPulled, []);
});
}
function loadMapPinsService() {
const source = readRepoFile("frontend", "app", "services", "MapPins.js");
const body = source
.replace(/import\s*\{[^}]*\}\s*from\s*['"]vue['"];?/, "")
.replace(/export\s*\{/, "return {")
.concat("\n;");
return vm.compileFunction(body, [])();
}
function mapPinsServiceTests() {
const service = loadMapPinsService();
// 800x600 image, shown at 200% and panned so its top left corner sits at (20, 10) of the viewport.
const view = { zoom: 2, pan: { x: 20, y: 10 }, width: 800, height: 600 };
test("a spot of the viewport becomes the pixel of the image it stands for", () => {
assert.deepEqual(service.ToImagePoint({ x: 100, y: 50 }, view), { x: 40, y: 20 });
});
test("spots outside the image pin nothing", () => {
assert.equal(service.ToImagePoint({ x: 10, y: 50 }, view), null);
assert.equal(service.ToImagePoint({ x: 100, y: -5 }, view), null);
assert.equal(service.ToImagePoint({ x: 1700, y: 50 }, view), null);
});
test("without a loaded image there is no spot to pin", () => {
assert.equal(service.ToImagePoint({ x: 100, y: 50 }, { zoom: 1, pan: { x: 0, y: 0 }, width: 0, height: 0 }), null);
assert.equal(service.ToImagePoint({ x: 100, y: 50 }, undefined), null);
});
test("a pin lands on the same spot of the screen it was placed at", () => {
// An even spot: the image pixels of a pin are rounded, so the round trip is exact there.
const spot = service.ToImagePoint({ x: 370, y: 124 }, view);
assert.deepEqual(spot, { x: 175, y: 57 });
assert.deepEqual(service.ToScreenPoint(spot, view), { x: 370, y: 124 });
});
test("pins follow the map but keep their own size", () => {
// Only the position scales: the marker itself is drawn outside of the scaled stage.
assert.deepEqual(service.ToScreenPoint({ x: 40, y: 20 }, { ...view, zoom: 4 }), { x: 180, y: 90 });
assert.deepEqual(service.ToScreenPoint({ x: 40, y: 20 }, { ...view, pan: { x: -40, y: 0 } }), { x: 40, y: 40 });
});
test("notes of a folder are labelled with where they live", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "The Altar", folder: "folder-2" }, { _id: "note-2", title: "The Inn", folder: null }],
[{ _id: "folder-1", name: "Undercity" }, { _id: "folder-2", name: "Temple", parentFolder: "folder-1" }]
);
assert.deepEqual(options.map((option) => option.label), ["The Inn", "Undercity / Temple / The Altar"]);
assert.equal(options.find((option) => option.value === "note-1").path, "Undercity / Temple");
});
test("the picker is sorted by the label it shows, not by the bare title", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "Bridge", folder: null }, { _id: "note-2", title: "Altar", folder: "folder-1" }],
[{ _id: "folder-1", name: "Cave" }]
);
// "Altar" would lead the menu by title, but it is nowhere near it once its folder is named.
assert.deepEqual(options.map((option) => option.value), ["note-1", "note-2"]);
});
test("a note without a title is left out of the picker", () => {
const options = service.BuildNoteOptions([{ _id: "note-1", title: " " }], []);
assert.deepEqual(options, []);
});
test("a broken folder chain cannot loop the picker", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "The Altar", folder: "folder-1" }],
[{ _id: "folder-1", name: "One", parentFolder: "folder-2" }, { _id: "folder-2", name: "Two", parentFolder: "folder-1" }]
);
assert.equal(options[0].label, "Two / One / The Altar");
});
test("renaming a note keeps the folder path of its label", () => {
const option = { value: "note-1", title: "The Altar", path: "Undercity / Temple" };
option.title = "The Ruined Altar";
assert.equal(service.OptionLabel(option), "Undercity / Temple / The Ruined Altar");
});
}
function mapViewerWiringTests() {
const pane = readRepoFile("frontend", "app", "components", "viewer", "map", "MapViewerPane.vue");
const definitions = readRepoFile("frontend", "app", "services", "WindowDefinitions.js");
const windowSource = readRepoFile("frontend", "app", "components", "windows", "PinnedNoteWindow.vue");
test("right clicking the map opens the pin menu", () => {
const viewport = /<div[^>]*ref="viewport"[^>]*>/.exec(pane)?.[0];
assert.ok(viewport, "expected the map viewport element");
assert.match(viewport, /@contextmenu\.prevent="onMapContextMenu"/);
});
test("pins are drawn in screen space and only they catch the mouse", () => {
// Inside the scaled stage the markers would shrink and grow with the map instead of staying
// where they were placed; the overlay must not take the mouse away from panning.
assert.match(pane, /class="map-pin"[^>]*:style="pinStyle\(pin\)"/);
assert.match(pane, /\.map-pins\s*\{[^}]*pointer-events:\s*none/);
assert.match(pane, /\.map-pin\s*\{[^}]*pointer-events:\s*auto/);
});
test("a pin opens the linked note and does not start a pan", () => {
assert.match(pane, /@pointerdown\.stop/);
assert.match(pane, /@click="openPinnedNote\(pin\)"/);
assert.match(pane, /CreateWindow\('pinned_note'/);
});
test("the pinned note window is registered and reads the note from the server", () => {
assert.match(definitions, /pinned_note:\s*\{[^}]*windows\.pinned-note[^}]*PinnedNoteWindow\.vue/s);
assert.match(windowSource, /get\(`\/note\/retrieve\/\$\{noteId\}`\)/);
});
}
mapPinRouteTests();
campaignNotesTests();
mapPinsServiceTests();
mapViewerWiringTests();

344
tests/map-tokens.test.js Normal file
View File

@@ -0,0 +1,344 @@
// Tests for the actor tokens of a map (Syndria98/dragonroll#38): an actor dragged out of the campaign
// sidebar lands on the map as a token, and that token is then moved from cell to cell of the grid.
//
// Same set-up as tests/map-pins.test.js, which the repository root runs without installing anything:
// the express routers are loaded into `node:vm` with their models stubbed, `MapTokens.js` is loaded as
// a plain function, and the last checks read the templates, where the drag and drop wiring itself is
// what has to stay right.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
function readRepoFile(...parts) {
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
}
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and lets `select()`
// and `sort()` sit in between.
function mongooseQuery(value) {
const result = {
select: () => result,
sort: () => result,
lean: () => Promise.resolve(value),
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
};
return result;
}
// Loads an express router file with every module it requires stubbed out.
function loadRouter(relativeParts, stubs) {
const routes = new Map();
const router = {
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
};
const requireStub = (id) => {
if (id === "express") return { Router: () => router };
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
if (!(id in stubs)) throw new Error(`require("${id}") is not stubbed`);
return stubs[id];
};
const moduleStub = { exports: {} };
vm.compileFunction(readRepoFile(...relativeParts), ["require", "module", "exports"])(
requireStub, moduleStub, moduleStub.exports
);
async function call(route, { body = {}, query = {}, params = {}, user = { id: "user-1" } } = {}) {
const handlers = routes.get(route);
assert.ok(handlers, `${route} is not mounted`);
const res = { payload: null, json(payload) { this.payload = payload; } };
await handlers[handlers.length - 1]({ body, query, params, user }, res);
return res.payload;
}
return { routes, call };
}
function makeMap(tokens = [], grid = {}) {
return {
_id: "map-1", campaign: "campaign-1", tokens,
gridSize: 50, offsetX: 0, offsetY: 0,
...grid,
save: async () => {}
};
}
function loadMapRoutes({ ownsCampaign = true, maps = [], actors = [] } = {}) {
return loadRouter(["backend", "src", "routes", "map.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Map": { findById: (id) => mongooseQuery(maps.find((map) => map._id === id) ?? null) },
"../models/Note": { findOne: () => mongooseQuery(null) },
"../models/Actor": {
findOne: (filter) => mongooseQuery(
actors.some((actor) => actor._id === String(filter._id) && String(actor.campaign) === String(filter.campaign))
? { _id: String(filter._id) }
: null
),
},
});
}
function placeTokenRouteTests() {
test("an actor dropped on the map stands in the middle of the cell it landed on", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
const response = await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-1", x: 124, y: 76 } });
assert.equal(response.status, "ok");
// 50 px cells: 124 falls in the column centred on 125, 76 in the row centred on 75.
assert.deepEqual(map.tokens, [{ actor: "actor-1", x: 125, y: 75 }]);
});
test("a token lands in the cell of a grid that does not start at the corner of the image", async () => {
const map = makeMap([], { gridSize: 40, offsetX: 10, offsetY: 4 });
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-1", x: 55, y: 20 } });
assert.deepEqual(map.tokens, [{ actor: "actor-1", x: 70, y: 24 }]);
});
test("an actor of another campaign cannot be made to stand on a map", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-2", campaign: "campaign-2" }] });
const response = await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-2", x: 10, y: 10 } });
assert.equal(response.msg, "errors.notfound");
assert.deepEqual(map.tokens, []);
});
test("a map of somebody else's campaign answers unauthorized", async () => {
const map = makeMap();
const api = loadMapRoutes({ ownsCampaign: false, maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
const response = await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-1", x: 10, y: 10 } });
assert.equal(response.msg, "unauthorized");
assert.deepEqual(map.tokens, []);
});
test("placing an actor again moves its token instead of adding a twin", async () => {
const map = makeMap([{ _id: "token-1", actor: "actor-1", x: 25, y: 25 }]);
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-1", x: 300, y: 224 } });
assert.equal(map.tokens.length, 1);
assert.deepEqual({ ...map.tokens[0] }, { _id: "token-1", actor: "actor-1", x: 325, y: 225 });
});
test("placing a token needs both a map and an actor", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
assert.equal((await api.call("POST /place-token", { body: { actor: "actor-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.equal((await api.call("POST /place-token", { body: { id: "map-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.deepEqual(map.tokens, []);
});
test("removing a token takes the one it is given and keeps the others", async () => {
const map = makeMap([
{ _id: "token-1", actor: "actor-1", x: 25, y: 25 },
{ _id: "token-2", actor: "actor-2", x: 75, y: 25 },
]);
const api = loadMapRoutes({ maps: [map] });
const response = await api.call("POST /remove-token", { body: { id: "map-1", token: "token-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(map.tokens.map((token) => token._id), ["token-2"]);
});
test("removing a token of a map of somebody else keeps its tokens", async () => {
const map = makeMap([{ _id: "token-1", actor: "actor-1", x: 25, y: 25 }]);
const api = loadMapRoutes({ ownsCampaign: false, maps: [map] });
const response = await api.call("POST /remove-token", { body: { id: "map-1", token: "token-1" } });
assert.equal(response.msg, "unauthorized");
assert.equal(map.tokens.length, 1);
});
}
function loadActorRoutes({ ownsCampaign = true, actors = [], deletedCount = 1 } = {}) {
const tokensPulled = [];
const api = loadRouter(["backend", "src", "routes", "actor.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Actor": {
findById: (id) => mongooseQuery(
actors.find((actor) => actor._id === id)
? { ...actors.find((actor) => actor._id === id), deleteOne: async () => ({ deletedCount }) }
: null
),
},
"../models/Map": {
// The driver drops the tokens of the actor from every map holding one; what is worth
// keeping here is the filter it is asked to do that with.
updateMany: async (filter, update) => {
tokensPulled.push({ filter, update });
return { modifiedCount: 1 };
},
},
});
return { api, tokensPulled };
}
function actorDeletionTests() {
test("deleting an actor takes its tokens off the maps", async () => {
const { api, tokensPulled } = loadActorRoutes({ actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
const response = await api.call("POST /delete", { body: { id: "actor-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(tokensPulled, [{ filter: { "tokens.actor": "actor-1" }, update: { $pull: { tokens: { actor: "actor-1" } } } }]);
});
test("a token is not left behind by an actor that could not be deleted", async () => {
const { api, tokensPulled } = loadActorRoutes({ ownsCampaign: false, actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
const response = await api.call("POST /delete", { body: { id: "actor-1" } });
assert.equal(response.msg, "unauthorized");
assert.deepEqual(tokensPulled, []);
});
}
function loadMapTokensService() {
const source = readRepoFile("frontend", "app", "services", "MapTokens.js");
const body = source
.replace(/import\s*\{[^}]*\}\s*from\s*['"]vue['"];?/, "")
.replace(/export\s*\{/, "return {")
.concat("\n;");
return vm.compileFunction(body, [])();
}
function mapTokensServiceTests() {
const service = loadMapTokensService();
const grid = { gridSize: 50, offsetX: 0, offsetY: 0 };
test("a spot of the image becomes the middle of the cell it stands in", () => {
assert.deepEqual(service.CellCentre({ x: 124, y: 76 }, grid), { x: 125, y: 75 });
assert.deepEqual(service.CellCentre({ x: 125, y: 75 }, grid), { x: 125, y: 75 });
});
test("cells are counted from the grid origin, not from the corner of the image", () => {
const shifted = { gridSize: 40, offsetX: 10, offsetY: 4 };
assert.deepEqual(service.CellCentre({ x: 55, y: 20 }, shifted), { x: 70, y: 24 });
});
test("a token never stands off the top left corner of the map", () => {
assert.deepEqual(service.CellCentre({ x: -8, y: -1 }, grid), { x: 25, y: 25 });
// A grid starting off the image still cannot put a token at a negative pixel.
assert.deepEqual(service.CellCentre({ x: -8, y: -1 }, { gridSize: 40, offsetX: -30, offsetY: 0 }), { x: 0, y: 20 });
});
test("a grid with nothing set is the 50 px grid the backend defaults to", () => {
assert.deepEqual(service.CellCentre({ x: 10, y: 10 }, {}), { x: 25, y: 25 });
assert.deepEqual(service.CellCentre({ x: 10, y: 10 }, undefined), { x: 25, y: 25 });
});
test("a spot that is not a spot centres on nothing", () => {
assert.equal(service.CellCentre({ x: NaN, y: 10 }, grid), null);
assert.equal(service.CellCentre({}, grid), null);
assert.equal(service.CellCentre(undefined, grid), null);
});
test("the arrow keys walk a token over whole cells", () => {
assert.deepEqual(service.MoveByCells({ x: 125, y: 75 }, grid, -1, 2), { x: 75, y: 175 });
assert.deepEqual(service.MoveByCells({ x: 25, y: 25 }, grid, -3, -1), { x: 0, y: 0 });
assert.equal(service.MoveByCells({ x: 25 }, grid, 1, 0), null);
});
test("a token covers the cell it stands on and never shrinks below an icon", () => {
assert.equal(service.TokenSize(grid, 1), 50);
assert.equal(service.TokenSize(grid, 0.2), 18);
assert.equal(service.TokenSize({ gridSize: 80 }, 2), 160);
});
test("the map tells an actor drag from any other drag dropped on it", () => {
const actorDrag = {
dataTransfer: {
types: [service.ACTOR_DRAG_TYPE],
getData: (type) => (type === service.ACTOR_DRAG_TYPE ? "actor-1" : "")
}
};
const noteDrag = { dataTransfer: { types: ["text/plain"], getData: (type) => (type === "text/plain" ? "note-1" : "") } };
assert.equal(service.IsActorDrag(actorDrag), true);
assert.equal(service.ActorDragId(actorDrag), "actor-1");
assert.equal(service.IsActorDrag(noteDrag), false);
assert.equal(service.ActorDragId(noteDrag), null);
assert.equal(service.IsActorDrag(undefined), false);
assert.equal(service.ActorDragId(undefined), null);
});
test("the viewer and the route agree on where a token stands", async () => {
// A drop is snapped while it is dragged and again when it is saved: the token must not jump.
const map = makeMap([], { gridSize: 40, offsetX: 10, offsetY: 4 });
const api = loadMapRoutes({ maps: [map], actors: [{ _id: "actor-1", campaign: "campaign-1" }] });
const spot = { x: 300, y: 220 };
await api.call("POST /place-token", { body: { id: "map-1", actor: "actor-1", ...spot } });
assert.deepEqual({ x: map.tokens[0].x, y: map.tokens[0].y }, service.CellCentre(spot, map));
});
}
function mapViewerTokenWiringTests() {
const pane = readRepoFile("frontend", "app", "components", "viewer", "map", "MapViewerPane.vue");
const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue");
test("an actor row of the sidebar can be dragged out of it", () => {
const actorRow = /<div v-for="actor in actors"[^>]*>/.exec(sidebar)?.[0];
assert.ok(actorRow, "expected the actor rows of the sidebar");
assert.match(actorRow, /draggable="true"/);
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, actor\)"/);
assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/);
});
test("the map viewport takes the actor drag and places it", () => {
const viewport = /<div[^>]*ref="viewport"[\s\S]*?>/.exec(pane)?.[0];
assert.ok(viewport, "expected the map viewport element");
assert.match(viewport, /@dragover="onMapDragOver"/);
assert.match(viewport, /@drop\.prevent="onMapDrop"/);
});
test("tokens are drawn in screen space, sized by their cell, and only they catch the mouse", () => {
assert.match(pane, /class="map-token"[^>]*:style="tokenStyle\(token\)"/);
assert.match(pane, /\.map-tokens\s*\{[^}]*pointer-events:\s*none/);
assert.match(pane, /\.map-token\s*\{[^}]*pointer-events:\s*auto/);
});
test("dragging a token moves it and does not pan the map", () => {
assert.match(pane, /@pointerdown="onTokenPointerDown\(\$event, token\)"/);
assert.match(pane, /@pointermove="onTokenPointerMove"/);
assert.match(pane, /@pointerup="onTokenPointerUp"/);
// The pane stops the pointer before the viewport ever sees it, so holding a token never pans.
assert.match(pane, /function onTokenPointerDown\(event, token\) \{[^}]*?event\.stopPropagation\(\)/);
});
test("a token answers to the keyboard and its own menu", () => {
assert.match(pane, /@keydown="onTokenKeydown\(\$event, token\)"/);
assert.match(pane, /@contextmenu\.stop\.prevent="onTokenContextMenu\(token\)"/);
});
test("tokens are saved and taken off through the map routes", () => {
assert.match(pane, /['"]\/map\/place-token['"]/);
assert.match(pane, /['"]\/map\/remove-token['"]/);
});
}
placeTokenRouteTests();
actorDeletionTests();
mapTokensServiceTests();
mapViewerTokenWiringTests();

View File

@@ -0,0 +1,75 @@
// Tests for the motion error of Syndria98/dragonroll#34: the tooltip animated itself with
// `ease: 'ease-in'`, and motion throws `Invalid easing type 'ease-in'` on that. Motion's easing
// options are its own names (`easeIn`, `easeOut`, ...), not the CSS keywords, so every string ease
// option in the frontend has to be one of the names motion accepts.
//
// `frontend/app/services/Tooltip.js` imports `vue` and `motion` and the repository root installs no
// dependencies, so the checks read the sources the way `tests/map-viewer.test.js` reads them.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
// The strings motion accepts for `ease` (https://motion.dev/troubleshooting/invalid-easing-type).
const VALID_EASINGS = [
"linear",
"easeIn",
"easeInOut",
"easeOut",
"circIn",
"circInOut",
"circOut",
"backIn",
"backInOut",
"backOut",
"anticipate",
];
function frontendSources(dir = path.join(__dirname, "..", "frontend", "app")) {
const found = [];
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const full = path.join(dir, entry.name);
if (entry.isDirectory()) found.push(...frontendSources(full));
else if (/\.(js|ts|vue)$/.test(entry.name)) found.push({ file: full, source: fs.readFileSync(full, "utf8") });
}
return found;
}
// An ease option is the `ease` key of a JS object (motion's options), so it is always quoted. CSS
// `transition: ... ease` declarations have no colon after `ease` and never match.
function easeOptions(source) {
return [...source.matchAll(/\bease:\s*(['"])([^'"]*)\1/g)].map((match) => match[2]);
}
function readTooltip() {
return fs.readFileSync(
path.join(__dirname, "..", "frontend", "app", "services", "Tooltip.js"),
"utf8"
);
}
test("the tooltip keeps animating itself in and out", () => {
const ease = easeOptions(readTooltip());
// Guards the checks below against silently matching nothing.
assert.equal(ease.length, 2, `expected the show and the hide ease option, found ${ease.length}`);
});
test("the tooltip options use easing names motion accepts", () => {
for (const value of easeOptions(readTooltip())) {
assert.ok(VALID_EASINGS.includes(value), `invalid easing type '${value}'`);
}
});
test("no frontend animation uses a CSS keyword as motion easing", () => {
for (const { file, source } of frontendSources()) {
for (const value of easeOptions(source)) {
assert.ok(
VALID_EASINGS.includes(value),
`${path.relative(path.join(__dirname, ".."), file)} uses invalid easing type '${value}'`
);
}
}
});

View File

@@ -0,0 +1,154 @@
// Tests for Syndria98/dragonroll#29: the monorepo is a pnpm workspace, so running or installing it
// goes through pnpm (`pnpm install`, `pnpm dev`, `pnpm test`) and the images are built with the
// workspace manifests instead of one npm lockfile per package.
//
// These checks only read the manifests, the Dockerfiles and the workflows, so they need no installed
// dependencies. They fail when a package is added to the repository without joining the workspace, or
// when a build step slips back to npm and its deleted `package-lock.json`.
//
// Run with `pnpm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const root = path.join(__dirname, "..");
const read = (...parts) => fs.readFileSync(path.join(root, ...parts), "utf8");
const workspace = read("pnpm-workspace.yaml");
const rootManifest = JSON.parse(read("package.json"));
// `dragonroll-foundry/bridge` is deliberately left out: it depends on nothing but Node built-ins, it
// is not part of `pnpm dev`, and its README runs it with `npm start --prefix foundry/bridge`.
const apps = ["backend", "frontend", "discord-bot"];
function packageJsonOf(pkg) {
return JSON.parse(read(pkg, "package.json"));
}
// The items of a top-level `key:` list of pnpm-workspace.yaml, quotes dropped.
function yamlList(key) {
const block = new RegExp(`${key}\\n((?:\\s+-.*\\n?)+)`).exec(workspace)?.[1] ?? "";
return [...block.matchAll(/^\s+-\s+'?([^'\s]+)'?\s*$/gm)].map((match) => match[1]);
}
test("every app package of the monorepo belongs to the pnpm workspace", () => {
const listed = yamlList("packages:");
for (const pkg of apps) {
assert.ok(listed.includes(pkg), `${pkg} must be listed in pnpm-workspace.yaml`);
assert.ok(fs.existsSync(path.join(root, pkg, "package.json")), `${pkg} must have a package.json`);
}
});
test("the workspace root is private and pins one pnpm version for corepack", () => {
assert.equal(rootManifest.private, true, "the workspace root must not be publishable");
assert.match(rootManifest.packageManager, /^pnpm@\d+\.\d+\.\d+$/, "packageManager must pin pnpm");
});
test("npm lockfiles stay gone and pnpm-lock.yaml is the only lockfile", () => {
const lockfiles = ["", ...apps].flatMap((pkg) => [
path.join(root, pkg, "package-lock.json"),
path.join(root, pkg, "yarn.lock"),
]);
const present = lockfiles.filter((lockfile) => fs.existsSync(lockfile));
assert.deepEqual(present, [], `only pnpm-lock.yaml may exist, found ${present.join(", ")}`);
assert.ok(fs.existsSync(path.join(root, "pnpm-lock.yaml")), "pnpm-lock.yaml must be committed");
});
test("`pnpm dev` runs the whole monorepo through the workspace instead of npm --prefix", () => {
const dev = rootManifest.scripts.dev;
assert.match(dev, /^concurrently -k/, "the dev script keeps running every app together");
assert.ok(!/\bnpm\b/.test(dev), "the dev script must not call npm");
for (const pkg of apps) {
assert.ok(
dev.includes(`pnpm --filter ./${pkg}`),
`the dev script must run ${pkg} through the workspace: ${dev}`
);
}
// The Foundry launcher is not a package, so concurrently keeps driving it.
assert.match(dev, /node scripts\/run-foundry\.js/);
});
test("every app package can be started on its own", () => {
// `pnpm dev:<package>`; building stays `pnpm --filter ./frontend run build`.
for (const pkg of apps) {
const script = rootManifest.scripts[`dev:${pkg}`];
assert.ok(script, `the root needs a dev:${pkg} script`);
assert.match(script, new RegExp(`pnpm --filter ./${pkg} run \\w+`));
const packageScript = packageJsonOf(pkg).scripts[/run (\w+)$/.exec(script)[1]];
assert.ok(packageScript, `${pkg} must define the script dev:${pkg} runs`);
}
});
test("the Dockerfiles install with pnpm from the workspace root", () => {
for (const pkg of apps) {
const dockerfile = read(pkg, "Dockerfile");
assert.match(dockerfile, /corepack enable/, `${pkg}: pnpm must come from corepack`);
assert.match(
dockerfile,
/COPY pnpm-workspace\.yaml pnpm-lock\.yaml package.json/,
`${pkg}: the workspace manifests must be copied before installing`
);
assert.match(
dockerfile,
new RegExp(`pnpm install --frozen-lockfile[^\\n]*--filter \\./${pkg}`),
`${pkg}: dependencies must be installed from the lockfile, filtered to this package`
);
assert.ok(!/\bnpm (ci|install)\b/.test(dockerfile), `${pkg}: must not fall back to npm install`);
}
// The images are built from the repository root, so the manifests are in the context.
const deploy = read(".gitea", "workflows", "deploy.yml");
for (const pkg of apps) {
assert.ok(
deploy.includes(`-f ./${pkg}/Dockerfile .`),
`${pkg} must be built with the repository root as build context`
);
}
});
test("the test workflow runs the suite through pnpm", () => {
assert.match(read(".gitea", "workflows", "test.yml"), /corepack pnpm test/);
});
// Syndria98/dragonroll#33: PM2 and its `ecosystem.config.js` are gone. It started backend and frontend
// with `npm start`, a script neither package defines; production runs from the compose images (the `CMD`
// of each Dockerfile) and every dev process is started together by `pnpm dev`, checked above. These
// checks keep the PM2 ecosystem from creeping back in.
test("PM2 plays no part in running the monorepo", () => {
const ecosystems = [
"ecosystem.config.js",
"ecosystem.config.cjs",
"ecosystem.config.json",
"ecosystem.json",
].filter((file) => fs.existsSync(path.join(root, file)));
assert.deepEqual(ecosystems, [], `no PM2 ecosystem file may exist, found ${ecosystems.join(", ")}`);
const manifests = [[null, rootManifest], ...apps.map((pkg) => [pkg, packageJsonOf(pkg)])];
for (const [pkg, manifest] of manifests) {
const dependencies = { ...manifest.dependencies, ...manifest.devDependencies, ...manifest.optionalDependencies };
assert.ok(!dependencies.pm2, `${pkg ?? "the workspace root"} must not depend on pm2`);
}
// Neither the images nor the workflows nor compose may fall back to PM2.
const runbooks = [
".gitea/workflows/deploy.yml",
".gitea/workflows/test.yml",
"docker-compose.yml",
...apps.map((pkg) => `${pkg}/Dockerfile`),
];
for (const file of runbooks) {
const text = read(...file.split("/"));
assert.ok(!/\bpm2\b|ecosystem\.config/i.test(text), `${file} must not mention PM2`);
}
});
test("the workspace allows the dependencies that build native binaries to run their scripts", () => {
// pnpm skips install scripts of dependencies by default; the frontend build needs these two to
// place their native binary.
const allowed = yamlList("onlyBuiltDependencies:");
for (const dependency of ["esbuild", "@parcel/watcher"]) {
assert.ok(allowed.includes(dependency), `${dependency} must be listed in onlyBuiltDependencies`);
}
});

136
tests/remember-me.test.js Normal file
View File

@@ -0,0 +1,136 @@
// Tests for the "remember me" checkbox of Syndria98/dragonroll#48: the login form lets the user keep
// the session on the device, and a login without it ends when the browser does.
//
// `frontend/app/services/TokenStore.js` is dependency-free ESM, so it is imported for real against
// stubbed browser storages; the flow around it is checked in the sources the same way
// `tests/sidebar-entity-entry.test.js` reads its component.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const { pathToFileURL } = require("node:url");
function readSource(...parts) {
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
}
const loginWindow = readSource("frontend", "app", "components", "windows", "LoginWindow.vue");
const serviceLink = readSource("frontend", "app", "components", "views", "ServiceLinkAuthorize.vue");
const user = readSource("frontend", "app", "services", "User.js");
const server = readSource("frontend", "app", "services", "Server.js");
const backendUser = readSource("backend", "src", "routes", "user.js");
// -- the token store, for real ------------------------------------------------
function fakeStorage() {
const entries = new Map();
return {
getItem: (key) => (entries.has(key) ? entries.get(key) : null),
setItem: (key, value) => entries.set(key, String(value)),
removeItem: (key) => entries.delete(key),
};
}
async function loadTokenStore() {
const store = await import(
pathToFileURL(path.join(__dirname, "..", "frontend", "app", "services", "TokenStore.js")).href
);
// The module only touches the storages inside its functions, so fresh stubs per test are enough.
globalThis.localStorage = fakeStorage();
globalThis.sessionStorage = fakeStorage();
return store;
}
test("a remembered login keeps the token in localStorage", async () => {
const { GetToken, SetToken } = await loadTokenStore();
SetToken("tok", true);
assert.equal(GetToken(), "tok");
assert.equal(globalThis.localStorage.getItem("token"), "tok");
assert.equal(globalThis.sessionStorage.getItem("token"), null);
});
test("a login without remember keeps the token only for the browser session", async () => {
const { GetToken, SetToken } = await loadTokenStore();
SetToken("tok", false);
assert.equal(GetToken(), "tok");
assert.equal(globalThis.sessionStorage.getItem("token"), "tok");
// Closing the browser clears sessionStorage, so the session ends with it.
assert.equal(globalThis.localStorage.getItem("token"), null);
});
test("a new login replaces the token instead of leaving it in the other store", async () => {
const { GetToken, SetToken, ClearToken } = await loadTokenStore();
SetToken("remembered", true);
SetToken("session", false);
assert.equal(globalThis.localStorage.getItem("token"), null);
assert.equal(GetToken(), "session");
ClearToken();
SetToken("remembered", true);
SetToken("session", false);
SetToken("remembered-again", true);
assert.equal(globalThis.sessionStorage.getItem("token"), null);
assert.equal(GetToken(), "remembered-again");
});
test("clearing the token empties both stores", async () => {
const { GetToken, ClearToken } = await loadTokenStore();
globalThis.localStorage.setItem("token", "leftover-remembered");
globalThis.sessionStorage.setItem("token", "leftover-session");
ClearToken();
assert.equal(globalThis.localStorage.getItem("token"), null);
assert.equal(globalThis.sessionStorage.getItem("token"), null);
assert.equal(GetToken(), null);
});
// -- the login form ------------------------------------------------------------
test("the login form has a remember-me checkbox wired to the login", () => {
assert.match(loginWindow, /type="checkbox"[^>]*v-model="remember"/, "expected a checkbox bound to `remember`");
assert.match(loginWindow, /\$t\('login\.remember-me'\)/, "the checkbox label must be translated");
assert.match(loginWindow, /post\('\/user\/login',\s*\{[^}]*remember:\s*remember\.value/, "the login request must carry the flag");
assert.match(loginWindow, /SetUser\(\s*data\.token,\s*remember\.value\s*\)/, "the token must be stored per the flag");
});
test("every place that reads the token goes through the token store", () => {
for (const [name, source] of [["User.js", user], ["Server.js", server]]) {
assert.doesNotMatch(source, /Storage\.getItem\(\s*['"]token['"]/, `${name} must not pick a store on its own`);
assert.match(source, /from ['"]\.\/TokenStore['"]/, `${name} must import the token store`);
assert.match(source, /GetToken\(\)/, `${name} must read the token through GetToken`);
}
const logout = /function LogoutUser\(\)\s*\{([\s\S]*?)\n\}/.exec(user)?.[1];
assert.ok(logout, "expected a LogoutUser function");
assert.match(logout, /ClearToken\(\)/, "logging out must clear the token from both stores");
});
test("the service link sign-in keeps its persistent session", () => {
// That flow has no checkbox; passing remember explicitly keeps the token in localStorage as before.
assert.match(serviceLink, /SetUser\(\s*response\.data\.token,\s*true\s*\)/);
});
// -- the backend lifetime ------------------------------------------------------
test("a remembered login signs a longer-lived token", () => {
assert.match(backendUser, /const\s*\{[^}]*remember[^}]*\}\s*=\s*req\.body/, "the login must read the flag");
const expiresIn = /expiresIn:\s*([^,})]+)/.exec(backendUser)?.[1];
assert.ok(expiresIn, "expected jwt.sign to set an expiresIn");
const [long, short] = expiresIn.match(/\d+/g).map(Number);
assert.ok(long > short, `a remembered session (${long}s) must outlive a plain one (${short}s)`);
assert.equal(short, 172800, "a plain login keeps the 48 h lifetime");
});
// -- i18n ----------------------------------------------------------------------
test("the remember-me label exists in every locale", () => {
for (const lang of ["en", "es", "ca"]) {
const strings = JSON.parse(readSource("frontend", "i18n", "locales", lang, "login.json"));
assert.ok(strings["remember-me"]?.trim(), `locales/${lang}/login.json needs a remember-me string`);
}
});

View File

@@ -0,0 +1,97 @@
// Tests for Syndria98/dragonroll#42: the Ctrl+K search only looked at notes; it now searches the
// whole campaign — notes (nested in folders included), actors, items and maps — and selecting a
// result opens that entry the same way the campaign sidebar opens it.
//
// The repository root installs no dependencies, so these checks read the search component's
// source, like tests/map-viewer.test.js reads its window.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const searchSource = read("frontend", "app", "components", "viewer", "topbar", "TopSearchBar.vue");
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
test("the search fetches notes, actors, items and maps of the campaign", () => {
for (const [route, key] of [
["/note/all", "notes"],
["/actor/list", "actors"],
["/item/list", "items"],
["/map/list", "maps"],
]) {
assert.ok(searchSource.includes(`'${route}'`), `expected the search to fetch ${route}`);
assert.ok(searchSource.includes(`'${key}'`), `expected the ${route} response key '${key}' to be read`);
}
// every list is fetched scoped to the current campaign
assert.match(searchSource, /params:\s*\{\s*campaign:\s*campaignId\.value\s*\}/);
});
test("every entry list is matched against the query, accent- and case-insensitively", () => {
// one shared normalisation like the action registry's own filter uses
assert.match(searchSource, /normalize\("NFD"\)\.replace\(\/\[\\u0300-\\u036f\]\/g,\s*""\)\.toLowerCase\(\)/);
// notes by title, actors / items / maps by name
for (const call of [
String.raw`pushMatches\(notes\.value,\s*'note',\s*n => n\.title\)`,
String.raw`pushMatches\(actors\.value,\s*'actor',\s*a => a\.name\)`,
String.raw`pushMatches\(items\.value,\s*'item',\s*i => i\.name\)`,
String.raw`pushMatches\(maps\.value,\s*'map',\s*m => m\.name\)`,
]) {
assert.match(searchSource, new RegExp(call));
}
// command actions keep matching through the registry
assert.match(searchSource, /searchActions\(query \?\? ''\)/);
});
test("selecting a result opens each entry type the way the sidebar opens it", () => {
// a note opens in the note column, with its content retrieved (/note/all never carries it)
assert.match(searchSource, /get\(`\/note\/retrieve\/\$\{note\.key\}`\)/);
assert.match(searchSource, /emitter\.emit\('push-note',\s*\{ key: full\._id, title: full\.title, text: full\.content \?\? ''/);
// a character replaces the open sheet window
assert.match(searchSource, /GetFirstWindowId\('character_sheet'\)/);
assert.match(searchSource, /CreateWindow\('character_sheet',\s*\{ actor \}\)/);
// an item replaces the open item window
assert.match(searchSource, /GetFirstWindowId\('item_sheet'\)/);
assert.match(searchSource, /CreateWindow\('item_sheet',\s*\{ item \}\)/);
// a map anchors on the note container, clearing a floating viewer first
assert.match(searchSource, /GetFirstWindowId\('map_viewer'\)/);
assert.match(searchSource, /AnchorMap\(map\)/);
// a command action still executes
assert.match(searchSource, /executeAction\(item\.data\.id\)/);
// the windows these opens use are all registered
for (const type of ["character_sheet", "item_sheet"]) {
assert.match(windowDefsSource, new RegExp(`${type}:\\s*\\{`));
}
});
test("keyboard Enter and clicking share one dispatcher over the combined results", () => {
// a single openResult handles every type, keyed off the result's type tag
assert.match(searchSource, /function openResult\(item\)[\s\S]*item\.type === 'note'[\s\S]*item\.type === 'actor'[\s\S]*item\.type === 'item'[\s\S]*item\.type === 'map'/);
// Enter on the selected row and a click on a row both go through it
assert.match(searchSource, /if \(event\.key === 'Enter'\)[\s\S]*?openResult\(combined\[selectedIndex\.value\]\)/);
assert.match(searchSource, /@click\.stop\.prevent="openResult\(item\)"/);
});
test("the palette shows what each result is and stays fresh", () => {
// every result carries its section's icon and label
for (const icon of ["book.svg", "user.svg", "box.svg", "map.svg"]) {
assert.ok(searchSource.includes(`/icons/iconoir/regular/${icon}`), `expected an icon per entry type (${icon})`);
}
assert.match(searchSource, /t\(`campaigns\.sections\.\$\{item\.type\}s`\)/);
// the section labels come from i18n: they exist in every locale
for (const locale of ["en", "es", "ca"]) {
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
for (const key of ["notes", "actors", "items", "maps"]) {
assert.ok(campaigns.sections?.[key], `${locale} is missing campaigns.sections.${key}`);
}
}
// refetched when the palette opens (Foundry syncs entries in the background)...
assert.match(searchSource, /function onFocus\(\)[\s\S]*?fetchSearchEntries\(\)/);
// ...and dropped when another campaign becomes the current one
assert.match(searchSource, /watch\(campaignId,\s*\(\)\s*=>\s*\{[^}]*notes\.value = \[\][^}]*actors\.value = \[\][^}]*items\.value = \[\][^}]*maps\.value = \[\]/);
});

View File

@@ -0,0 +1,170 @@
// Tests for the settings menu opened from the main menu (Syndria98/dragonroll#47): it used to show a
// "Syntax Error" instead of the menu, and the main menu did not come back after closing it.
//
// vue-i18n answers every translation with `SyntaxError: cannot support locale type` from the moment the
// locale it holds is something it has no messages for. The settings window put `GetUserSetting('lang')`
// straight into that locale, and for a user that never picked a language that is `undefined`: the server
// answers GET /user/get-settings with `settings: undefined`. The locale is global, so the one bad write
// broke every window on screen — the settings window and the main menu behind it.
//
// The repository root installs no dependencies, so the window's script is lifted out of its `<script setup>`
// block and run in a `node:vm` context with `locale` and `selectedLocale` as plain refs, the way
// tests/sidebar-section-pane.test.js loads the sidebar script. The window wiring (coming back to the main
// menu on close, the strings the menu draws) is read from the sources like tests/item-sheet-window.test.js.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const windowSource = read("frontend", "app", "components", "windows", "SettingsWindow.vue");
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
const userRouteSource = read("backend", "src", "routes", "user.js");
const script = /<script setup>([\s\S]*?)<\/script>/.exec(windowSource)?.[1];
// Top-level `function name(){...}` or `const name = (...) => {...}` of the script block: their bodies are
// indented, so the first `}` in column 0 closes them.
function declarationSource(name) {
assert.ok(script, "expected the settings window to have a <script setup> block");
const decl = new RegExp(`(function ${name}\\s*\\(|const ${name}\\s*=)[\\s\\S]*?\\n\\}`).exec(script)?.[0];
assert.ok(decl, `expected a top-level ${name} in the settings window script`);
return decl;
}
// The languages Dragonroll offers (frontend/i18n/locales.ts).
const LOCALES = [
{ code: "en", name: "English" },
{ code: "es", name: "Español" },
{ code: "ca", name: "Català" },
];
// The settings window with the language it is showing. `saved` collects every language the window asks the
// server to store, so a test can tell a language that was applied from one that was merely answered with.
function settingsWindow({ locale = "en" } = {}) {
const body = [
declarationSource("getLocaleFromCode"),
declarationSource("localeToShow"),
declarationSource("applyLanguage"),
declarationSource("getLocaleName"),
declarationSource("changeLocale"),
"return { localeToShow, applyLanguage, getLocaleName, changeLocale };",
].join("\n\n");
const state = {
locale: { value: locale },
selectedLocale: { value: null },
saved: [],
};
const api = vm.compileFunction(body, ["locale", "selectedLocale", "locales", "SetUserSetting"], {
parsingContext: vm.createContext({}),
})(
state.locale,
state.selectedLocale,
LOCALES,
(key, value) => state.saved.push([key, value])
);
return Object.assign(state, api);
}
test("a user without a stored language keeps the one on screen", () => {
const settings = settingsWindow({ locale: "en" });
// What GetUserSetting('lang') answers for a user that never picked a language: the server has no
// settings for them at all.
settings.applyLanguage(undefined);
assert.equal(settings.locale.value, "en", "the language on screen must not be replaced by nothing");
assert.equal(typeof settings.locale.value, "string", "vue-i18n only takes a locale it knows a type for");
});
test("a stored language Dragonroll does not offer is not applied either", () => {
for (const stored of ["", null, "fr", "en-US", 0, {}]) {
const settings = settingsWindow({ locale: "en" });
settings.applyLanguage(stored);
assert.equal(settings.locale.value, "en", `${String(stored)} is no language vue-i18n takes`);
}
});
test("the stored language is applied when it is one of the offered ones", () => {
for (const [code, name] of [["es", "Español"], ["ca", "Català"]]) {
const settings = settingsWindow({ locale: "en" });
assert.equal(settings.applyLanguage(code), true, `${code} must be applied`);
assert.equal(settings.locale.value, code);
assert.equal(settings.selectedLocale.value.name, name, "the dropdown shows the language applied");
}
});
test("the dropdown always shows a language, and never one the window has not got", () => {
const settings = settingsWindow({ locale: "en" });
assert.deepEqual(settings.localeToShow(undefined), LOCALES[0], "no language stored: the first one is shown");
assert.deepEqual(settings.localeToShow("de"), LOCALES[0], "an unknown code shows the same language");
assert.deepEqual(settings.localeToShow("ca"), LOCALES[2]);
assert.match(
script,
/const selectedLocale = ref\(localeToShow\(locale\.value\)\)/,
"the dropdown starts on the language being shown instead of on an empty row"
);
});
test("the dropdown label survives a language that is not there", () => {
const settings = settingsWindow();
assert.equal(settings.getLocaleName(undefined), "");
assert.equal(settings.getLocaleName(LOCALES[1]), "Español");
});
test("picking a language saves it, and picking nothing saves nothing", () => {
const settings = settingsWindow();
settings.changeLocale(LOCALES[2]);
assert.deepEqual(settings.saved, [["lang", "ca"]]);
assert.equal(settings.locale.value, "ca");
const nothing = settingsWindow();
nothing.changeLocale(undefined);
assert.deepEqual(nothing.saved, [], "a language that was not applied is not saved either");
assert.equal(nothing.locale.value, "en");
});
test("the window never hands the server's answer to vue-i18n directly", () => {
assert.match(script, /GetUserSetting\(['"]lang['"]\)/, "the stored language is still read from the server");
assert.match(
script,
/GetUserSetting\(['"]lang['"]\)\s*\.then\(\s*\(value\) => applyLanguage\(value\)\s*\)/,
"it goes through applyLanguage, which only accepts a language Dragonroll offers"
);
const writes = [...script.matchAll(/locale\.value\s*=\s*([^;]+);/g)].map((write) => write[1].trim());
assert.deepEqual(writes, ["stored.code"], "only a language looked up in the offered list reaches vue-i18n");
assert.match(script, /\.catch\(/, "a settings request that fails leaves the language alone");
});
test("GET /user/get-settings answers without a settings object for a user that saved none", () => {
// The window has to cope with what this answers: the reason #47 shows up for every fresh account.
assert.match(userRouteSource, /router\.get\(['"]\/get-settings['"]/);
assert.match(userRouteSource, /settings: data\.settings/);
});
test("closing the settings window goes back to the main menu", () => {
const definition = /^\s{2}settings:\s*\{[\s\S]*?\n \},/m.exec(windowDefsSource)?.[0];
assert.ok(definition, "expected the settings window to be registered");
assert.match(definition, /SettingsWindow\.vue/);
assert.match(definition, /ClearWindow\(\s*\{\s*type:\s*['"]settings['"]\s*\}\s*\)/);
assert.match(definition, /CreateWindow\(\s*['"]main_menu['"]\s*\)/);
});
test("every locale names the settings menu and its tabs", () => {
for (const locale of ["en", "es", "ca"]) {
const settings = JSON.parse(read("frontend", "i18n", "locales", locale, "settings.json"));
assert.ok(settings.tabs?.["account-settings"], `${locale} is missing the account settings tab`);
assert.ok(settings.tabs?.["site-administration"], `${locale} is missing the site administration tab`);
assert.ok(settings["account-settings"]?.language, `${locale} is missing the language label`);
assert.ok(settings["site-administration"]?.["manage-accounts"], `${locale} is missing manage accounts`);
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
assert.ok(windows.settings, `${locale} is missing the settings window title`);
}
});

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