Compare commits
133 Commits
test
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3c3df58d8d | ||
| c9ee16f2f2 | |||
|
|
abcec4d2ff | ||
| dcc6d7a14b | |||
| 227fff1351 | |||
| a64fe499e9 | |||
| b75ee05276 | |||
| bc7231a1da | |||
| 252ae2d6b2 | |||
|
|
30e23b643c | ||
|
|
8376acfc6b | ||
|
|
f8dae95563 | ||
| 98aa3be078 | |||
| 80c6b1b62f | |||
| 2cce19e032 | |||
| abacfeca40 | |||
| f925881a54 | |||
|
|
9aad484fe9 | ||
|
|
5ee7353123 | ||
|
|
f0ffa2f72b | ||
| 2c1cc970e6 | |||
| 72596c3d15 | |||
| d9d80c4eee | |||
| 4eda4a9d21 | |||
| b64d1e3089 | |||
| fefb1eba6e | |||
|
|
06144e1623 | ||
|
|
788f69efd3 | ||
|
|
f928f13544 | ||
| a8a1e0ca41 | |||
| fa82c933d6 | |||
|
|
299380d143 | ||
| 6df7d57376 | |||
| a8047e2814 | |||
|
|
37e6e44612 | ||
| b0cc98a452 | |||
| d35216c859 | |||
|
|
495e528124 | ||
|
|
dd4c9535d3 | ||
| 0caacf434f | |||
| d779d939f9 | |||
| eeaab7a910 | |||
| f9caff3100 | |||
|
|
0567096588 | ||
|
|
8418b5c254 | ||
|
|
09e9010729 | ||
| cdafd1f53a | |||
| 2e2fb97e5d | |||
|
|
d03cc1eb59 | ||
| 20128d195b | |||
| d901385900 | |||
|
|
2add9e7cb8 | ||
| fe63bd15f3 | |||
| 733e7ef193 | |||
| d566388fc6 | |||
| 86e1d34beb | |||
| cd741880ac | |||
| 378e28f703 | |||
|
|
7e1ed4475e | ||
|
|
0c6026aea8 | ||
|
|
844ed006cc | ||
| 4b6200960f | |||
| 1e0d81ecc4 | |||
|
|
cd92a2d112 | ||
| a314b935bd | |||
| 42027ff3fa | |||
|
|
adb29d3ef6 | ||
| 0106c13835 | |||
| a42a11cf53 | |||
|
|
8c4310e771 | ||
| 4faa585874 | |||
| 69e0181b66 | |||
| f29bbd45a3 | |||
| 5643031a70 | |||
|
|
1f9ab330b9 | ||
|
|
c6656fad3a | ||
| c7d20dd1f7 | |||
|
|
8348936122 | ||
| 4d532d10ae | |||
| af7bf9fa27 | |||
| 3b897da390 | |||
| 278d25b294 | |||
|
|
d567b5d171 | ||
|
|
22c6403736 | ||
| ef343dbdd8 | |||
| 909d403435 | |||
|
|
4505365f21 | ||
| 2c78ad039a | |||
|
|
1d3d978cda | ||
| e11c6fc4f3 | |||
| 8fa852d859 | |||
| 4e15b28bf6 | |||
|
|
4355986bd1 | ||
|
|
9820a375dc | ||
| a6ad14a1b5 | |||
| b02ecca7d4 | |||
| 26c0a0b0a1 | |||
|
|
59a4c1dd0c | ||
| e3248ac4dc | |||
| 969e559c57 | |||
| ae7d64a09a | |||
|
|
9d93e6f79b | ||
| 0541d82a85 | |||
| 35252e0d13 | |||
| 8260c588ac | |||
|
|
b0acd689bb | ||
|
|
ba84e10525 | ||
|
|
0a8452b3c8 | ||
| 9d9738b2b4 | |||
| ce03b0bfb9 | |||
|
|
ed0b9af00b | ||
| 9c6f59f937 | |||
| 5cd468ed24 | |||
|
|
4a5b17c77c | ||
| 67ca4b0210 | |||
| ff4090412c | |||
| 445e97f2f8 | |||
| dc6a04df8a | |||
| 0799dec5b3 | |||
|
|
8378e9b3e7 | ||
|
|
bcd173d133 | ||
|
|
7d19a22a4b | ||
| af76cf1050 | |||
| 50828af674 | |||
| f3bf48ae54 | |||
| d9ef18e82d | |||
| 9608582f9f | |||
| f3fb4ad534 | |||
| 1fab8ce20d | |||
| 1402045001 | |||
| a2b512699a | |||
| baee3c43b9 | |||
| 0fb4f01892 |
440
.agents/skills/accessibility/SKILL.md
Normal file
440
.agents/skills/accessibility/SKILL.md
Normal 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)
|
||||||
233
.agents/skills/accessibility/references/A11Y-PATTERNS.md
Normal file
233
.agents/skills/accessibility/references/A11Y-PATTERNS.md
Normal 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 |
|
||||||
191
.agents/skills/accessibility/references/WCAG.md
Normal file
191
.agents/skills/accessibility/references/WCAG.md
Normal 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/)
|
||||||
167
.agents/skills/discord-bot/SKILL.md
Normal file
167
.agents/skills/discord-bot/SKILL.md
Normal 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
|
||||||
177
.agents/skills/frontend-design/LICENSE.txt
Normal file
177
.agents/skills/frontend-design/LICENSE.txt
Normal 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
|
||||||
42
.agents/skills/frontend-design/SKILL.md
Normal file
42
.agents/skills/frontend-design/SKILL.md
Normal 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.
|
||||||
639
.agents/skills/nodejs-backend-patterns/SKILL.md
Normal file
639
.agents/skills/nodejs-backend-patterns/SKILL.md
Normal 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.
|
||||||
@@ -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),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
343
.agents/skills/nodejs-best-practices/SKILL.md
Normal file
343
.agents/skills/nodejs-best-practices/SKILL.md
Normal 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
513
.agents/skills/seo/SKILL.md
Normal 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
9
.dockerignore
Normal 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
|
||||||
@@ -32,20 +32,30 @@ 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
|
||||||
|
run: |
|
||||||
|
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \
|
||||||
|
-f ./discord-bot/Dockerfile .
|
||||||
|
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest
|
||||||
|
|
||||||
- name: Copy files
|
- name: Copy files
|
||||||
run: |
|
run: |
|
||||||
scp docker-compose.yml deploy@${{ secrets.DEPLOY_HOST}}:/var/www/app/
|
scp docker-compose.yml deploy@${{ secrets.DEPLOY_HOST}}:/var/www/app/
|
||||||
|
|||||||
35
.gitea/workflows/test.yml
Normal file
35
.gitea/workflows/test.yml
Normal 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'
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1 +1,2 @@
|
|||||||
node_modules
|
node_modules
|
||||||
|
.env
|
||||||
252
AGENTS.md
Normal file
252
AGENTS.md
Normal file
@@ -0,0 +1,252 @@
|
|||||||
|
# AGENTS.md — Dragonroll
|
||||||
|
|
||||||
|
Orientation map, kept short on purpose. Read the file you are about to change: this tells you where to
|
||||||
|
look and what will bite you, it does not replace the code. Longer docs: `dragonroll-foundry/README.md`,
|
||||||
|
`discord-bot/README.md`, `obsidian-plugin/README.md`.
|
||||||
|
|
||||||
|
## 1. What this is
|
||||||
|
|
||||||
|
Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, folders, characters,
|
||||||
|
items, maps, dice widgets, sounds).
|
||||||
|
|
||||||
|
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
||||||
|
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. Two pages: the app and `/docs` (§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, the `/docs` pages.
|
||||||
|
|
||||||
|
No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
|
||||||
|
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
||||||
|
`.gitea/workflows/test.yml` runs `npm test` on every branch.
|
||||||
|
|
||||||
|
## 2. Commands
|
||||||
|
|
||||||
|
`pnpm` comes from corepack (`packageManager` in `package.json`); `COREPACK_ENABLE_DOWNLOAD_PROMPT=0`
|
||||||
|
keeps corepack from asking in non-interactive shells.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm install # whole workspace, one lockfile (`-r` / `--filter <pkg>` for a single one)
|
||||||
|
pnpm dev # backend :5000 + frontend :3000 + discord-bot + scripts/run-foundry.js
|
||||||
|
pnpm dev:backend # or dev:frontend | dev:discord-bot
|
||||||
|
pnpm --filter ./frontend run build # or preview
|
||||||
|
pnpm test
|
||||||
|
```
|
||||||
|
|
||||||
|
No `start` script in backend/frontend and no lint command. Verification = run the dev server and
|
||||||
|
exercise the flow (`GET /api/test` returns a JSON hello).
|
||||||
|
|
||||||
|
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`).
|
||||||
|
|
||||||
|
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`
|
||||||
|
when `NODE_ENV` is set, otherwise `.env`. The server always listens on **5000**.
|
||||||
|
|
||||||
|
## 3. 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`,
|
||||||
|
`/api/link`, `/api/foundry` (link + sync, token-authenticated) are mounted **before**
|
||||||
|
`checkAuth = passport.authenticate('jwt', {session:false})`; everything after it
|
||||||
|
(`/api/campaign|note|folder|actor|item|map|foundry`) is JWT-protected. `checkAuth` is assigned without
|
||||||
|
`const` (implicit global). New user routes are public unless the handler calls
|
||||||
|
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
||||||
|
`/get-settings`). JWT: payload `{_id, username, name, email, admin, settings}`, 48h; `req.user` is the
|
||||||
|
Mongoose document, so routes use `req.user.id`.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
**Response envelope** — always HTTP 200, no real status codes:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{ "status": "ok", ...payload }
|
||||||
|
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
|
||||||
|
```
|
||||||
|
|
||||||
|
Common keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
||||||
|
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. `GET /user/has-admin`
|
||||||
|
returns `status: 'init'` when no admin exists yet (→ first-run registration).
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**Models** (`*` = required; notes and folders are always ordered `date: -1`):
|
||||||
|
|
||||||
|
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||||
|
- `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), `discordUserId` (the Discord player holding the character, unique per campaign — set only by `routes/discord.js`), 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
|
||||||
|
|
||||||
|
**API surface** (all under `/api`, all `{status,msg}`):
|
||||||
|
|
||||||
|
- `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`; `POST /import` (`{campaign, kind: 'actors'|'items'}`, the sidebar's "force import from Foundry") pulls that world's whole list off the bridge through the sync's writers, so rows the campaign already has are written over, and answers `{imported, updated}`; `/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)
|
||||||
|
|
||||||
|
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
|
||||||
|
(`/link/authorize`, handled by `views/ServiceLinkAuthorize.vue` outside the window app), signs in and
|
||||||
|
picks a campaign at `POST /api/link/complete`; the service then redeems its credential once at
|
||||||
|
`POST /api/link/pickup` (one-time; losing it means a new link). Proofs differ per service
|
||||||
|
(`services/service-links.js`): the Discord bot proves itself with the shared secret header, Foundry and
|
||||||
|
Obsidian only hold their link code, so what a link grants is decided by the user. Codes are hashed at
|
||||||
|
rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||||
|
- **Only the world's item directory reaches the item list** (Syndria98/dragonroll#67) — `snapshotItemSources` reads `body.items` (`game.items`) alone; gear embedded in a character is that actor's `inventory` (see the `Actor` model), not an `Item`. A world item still folds into a hand-made or renamed row it matches by name (`foundryNames`), so a rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||||
|
- **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.
|
||||||
|
- **`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/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. Its one write, `POST /import`, pulls the bridge's actors or world items into the campaign through the same writers as a sync push.
|
||||||
|
|
||||||
|
## 5. Frontend
|
||||||
|
|
||||||
|
### 5.1 Two pages: the app and the documentation
|
||||||
|
|
||||||
|
`app/pages/` routes the only two things the frontend is. `index.vue` and the `[...all].vue` catch-all
|
||||||
|
both render `components/views/AppShell.vue` — the window app, which has no routes of its own — and
|
||||||
|
`docs/index.vue` + `docs/[slug].vue` render `views/DocsView.vue`, the documentation at `/docs`.
|
||||||
|
`app.vue` holds only what is site-wide (the head, the theme) and `<NuxtPage>`. AppShell boots:
|
||||||
|
`GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open `main_menu`; no user →
|
||||||
|
`HasAdmin() ? 'login' : 'register' {firstTime:true}`. `/link/authorize` (and the legacy
|
||||||
|
`/discord/authorize`) is not a page either: AppShell checks the path and renders the service link
|
||||||
|
screen instead of the app.
|
||||||
|
|
||||||
|
The documentation is markdown files under `app/content/docs/<group>/<NN>-<page>.md`: the folder is the
|
||||||
|
sidebar group and its number orders the groups, the file's number orders its pages, the rest of its
|
||||||
|
name is the slug, and the first heading is the title. `services/Docs.js` reads them
|
||||||
|
(`import.meta.glob(..., {query:'?raw'})`), builds the sidebar and renders a page with marked;
|
||||||
|
`services/DocsMarkdown.js` holds the heading/slug helpers the sidebar and the anchors share and imports
|
||||||
|
nothing so `tests/docs.test.js` can load it. A new group's label goes in `docs.json` under
|
||||||
|
`groups.<folder>` **in all three locales**. The first page is served at `/docs` itself, and inside a
|
||||||
|
campaign the top bar opens the same pages in the `documentation` window
|
||||||
|
(`components/windows/DocumentationWindow.vue`), which holds the page it shows as its own state instead
|
||||||
|
of a route so the campaign stays behind it.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### 5.2 The window system
|
||||||
|
|
||||||
|
`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}`,
|
||||||
|
`window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
||||||
|
|
||||||
|
### 5.3 Services are the state layer
|
||||||
|
|
||||||
|
`app/services/` are plain ES modules with module-scope `ref()`s — no DI, no store, singleton by import.
|
||||||
|
`Server.js` (axios factory: `Server().get(...)`, interceptor adds `Authorization: Bearer <localStorage.token>`,
|
||||||
|
`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`,
|
||||||
|
`Docs.js` + `DocsMarkdown.js` (§5.1), `widgets/DiceParser.js`.
|
||||||
|
|
||||||
|
### 5.4 Markdown → widgets
|
||||||
|
|
||||||
|
`Marker.js` turns `@name\n…\n@end` (block), `@name[text]` (inline) and `[[target]]` (wiki link) into
|
||||||
|
placeholder divs/spans; `Note.vue` renders with `v-html` and then mounts each placeholder with its own
|
||||||
|
`createApp(GetWidget(kind, name), {content})` (and unmounts them on re-render). So widgets are isolated
|
||||||
|
mini-apps: they get only the `content` string and must not rely on the parent app's provides/injection.
|
||||||
|
Register one in `widget_map` in `Marker.js`, component in `components/viewer/widgets/{inline,display}/`.
|
||||||
|
`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.
|
||||||
|
|
||||||
|
### 5.5 Event bus
|
||||||
|
|
||||||
|
Events in use: `toast`, `push-note`, `close-note` (removes from the open column only), `delete-note`
|
||||||
|
(closes **and** removes from the sidebar, and drops map pins — the note's close button must not use it),
|
||||||
|
`title-updated`, `campaign-entry-created` / `campaign-entry-updated`, `note-created`, `note-renamed`,
|
||||||
|
`folder-saved`, `folder-deleted`, `status-bar-update`. Payloads are API documents; the UI note shape is
|
||||||
|
`{key, title, text, date}`, mapped at the boundary as `ContentSidebar.fetchCampaignNotes` does. Always
|
||||||
|
`import { emitter } from '~/services/Emitter'` — `composables/useEmitter.ts` is broken (§8).
|
||||||
|
|
||||||
|
### 5.6 Styling, i18n
|
||||||
|
|
||||||
|
`colors.scss` Sass maps (`dark`/`light`, accents `katlum`/`solus`/`silang`) become `--color-*` CSS
|
||||||
|
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/`.
|
||||||
|
|
||||||
|
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
|
||||||
|
new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
|
||||||
|
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`, `docs`. (The `/docs` *content* is
|
||||||
|
markdown under `app/content/docs` and is written in English; only its chrome — sidebar labels, prev /
|
||||||
|
next — is translated.)
|
||||||
|
|
||||||
|
## 6. Conventions
|
||||||
|
|
||||||
|
- Backend: CommonJS; every handler `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
||||||
|
- 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.
|
||||||
|
- Components call `Server()` directly (no api layer); `await` and `.then` both appear.
|
||||||
|
- Comments mix English and Catalan ("Moure aixo") — do not translate unrelated comments while editing.
|
||||||
|
- No formatter: keep diffs minimal and local, the codebase is deliberately rough.
|
||||||
|
|
||||||
|
## 7. Recipes
|
||||||
|
|
||||||
|
- **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.
|
||||||
|
- **New window**: `WindowDefinitions.js` entry + `components/windows/X.vue` (§5.2) + strings in `i18n/locales/*/windows.json` (all three locales).
|
||||||
|
- **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 documentation page**: `app/content/docs/<group>/NN-name.md` whose first heading is its title (§5.1); a brand-new group also needs `groups.<folder>` in `i18n/locales/*/docs.json` (all three locales).
|
||||||
|
|
||||||
|
## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
|
||||||
|
|
||||||
|
1. `README.md` says run `./install.sh` / `./start.sh`; **neither exists**. `frontend/README.md` says the frontend is **React**; it is Nuxt/Vue.
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 9. Ports
|
||||||
|
|
||||||
|
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` in compose,
|
||||||
|
proxying `/` → frontend, `/api/` → backend.
|
||||||
21
README.md
21
README.md
@@ -15,7 +15,7 @@ An open-source helper for role-playing games
|
|||||||
|
|
||||||
# Dragonroll
|
# Dragonroll
|
||||||
|
|
||||||
Dragonroll is an open source helper for role-playing games.
|
Dragonroll is an open source connector for role-playing games.
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
@@ -24,6 +24,7 @@ Dragonroll is an open source helper for role-playing games.
|
|||||||
- Play music during physical campaings
|
- Play music during physical campaings
|
||||||
- Plan different encounters
|
- Plan different encounters
|
||||||
- Manage different items and spells
|
- Manage different items and spells
|
||||||
|
- Import and edit campaign notes in Obsidian with the [Dragonroll Sync plugin](obsidian-plugin/README.md)
|
||||||
- And so much more!
|
- And so much more!
|
||||||
|
|
||||||
## Installation 🛠️
|
## Installation 🛠️
|
||||||
@@ -48,4 +49,20 @@ or
|
|||||||
./start-dev.sh
|
./start-dev.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
if you want to start the development environments
|
if you want to start the development environments
|
||||||
|
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
- Dragonroll <-> Foundry integration
|
||||||
|
- Dragonroll <-> Discord Bot integration
|
||||||
|
|
||||||
|
What to sync:
|
||||||
|
|
||||||
|
- Actors
|
||||||
|
- Monsters
|
||||||
|
- Items
|
||||||
|
- Notes
|
||||||
|
- Maps
|
||||||
|
- Music ?
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
PORT=5000
|
PORT=5000
|
||||||
DB_URI=mongodb://10.1.1.7:27017/dragonroll
|
DB_URI=mongodb://192.168.1.7:27017/dragonroll
|
||||||
NODE_ENV=production
|
NODE_ENV=production
|
||||||
|
DRAGONROLL_DISCORD_BOT_SECRET=test
|
||||||
|
DRAGONROLL_FRONTEND_URL=https://dragonroll.aranroig.com
|
||||||
|
|||||||
@@ -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
1770
backend/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -40,13 +40,42 @@ require('./services/passport')(passport);
|
|||||||
// CORS
|
// CORS
|
||||||
app.use(cookieParser());
|
app.use(cookieParser());
|
||||||
|
|
||||||
app.use(cors({
|
// Services talk to Dragonroll from their own application (a Foundry world, an
|
||||||
|
// Obsidian vault, the Discord bot), so their link routes cannot be limited to
|
||||||
|
// one origin. What they may do is decided by the link code each of them holds.
|
||||||
|
const openCorsPaths = [
|
||||||
|
'/api/foundry/sync', '/foundry/sync',
|
||||||
|
'/api/link/start', '/link/start',
|
||||||
|
'/api/link/pickup', '/link/pickup',
|
||||||
|
];
|
||||||
|
const openCors = cors({
|
||||||
|
origin: true,
|
||||||
|
methods: ['GET', 'POST', 'OPTIONS'],
|
||||||
|
allowedHeaders: ['Authorization', 'Content-Type', 'X-Dragonroll-Discord-Bot-Secret'],
|
||||||
|
});
|
||||||
|
for (const path of openCorsPaths) {
|
||||||
|
app.use(path, openCors);
|
||||||
|
}
|
||||||
|
|
||||||
|
const appCors = cors({
|
||||||
origin: 'http://localhost:3000',
|
origin: 'http://localhost:3000',
|
||||||
credentials: true, // if using cookies/auth
|
credentials: true, // if using cookies/auth
|
||||||
}));
|
});
|
||||||
|
app.use((req, res, next) => {
|
||||||
|
if (openCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next();
|
||||||
|
appCors(req, res, next);
|
||||||
|
});
|
||||||
|
|
||||||
// ROUTES (NO AUTH)
|
// ROUTES (NO AUTH)
|
||||||
app.use('/api/user', require('./routes/user'));
|
app.use('/api/user', require('./routes/user'));
|
||||||
|
app.use('/api/discord', require('./routes/discord'));
|
||||||
|
// The one way every service (Foundry, Discord, Obsidian) links itself to a
|
||||||
|
// campaign: it asks for a sign-up link, a user opens it and picks the campaign.
|
||||||
|
// Each service authenticates with its own proof: the Discord bot with its
|
||||||
|
// secret, Foundry and Obsidian with the link code they were handed.
|
||||||
|
app.use('/api/link', require('./routes/service-link'));
|
||||||
|
app.use('/api/foundry', require('./routes/foundry-link'));
|
||||||
|
app.use('/foundry', require('./routes/foundry-link'));
|
||||||
|
|
||||||
// AUTH
|
// AUTH
|
||||||
checkAuth = passport.authenticate('jwt', { session: false });
|
checkAuth = passport.authenticate('jwt', { session: false });
|
||||||
@@ -55,9 +84,13 @@ app.use(checkAuth);
|
|||||||
// ROUTES WITH AUTH
|
// ROUTES WITH AUTH
|
||||||
app.use('/api/campaign', require('./routes/campaign'));
|
app.use('/api/campaign', require('./routes/campaign'));
|
||||||
app.use('/api/note', require('./routes/note'));
|
app.use('/api/note', require('./routes/note'));
|
||||||
|
app.use('/api/folder', require('./routes/folder'));
|
||||||
|
app.use('/api/actor', require('./routes/actor'));
|
||||||
|
app.use('/api/item', require('./routes/item'));
|
||||||
|
app.use('/api/map', require('./routes/map'));
|
||||||
|
app.use('/api/foundry', require('./routes/foundry'));
|
||||||
/*
|
/*
|
||||||
app.use('/campaign', require('./routes/campaign'));
|
app.use('/campaign', require('./routes/campaign'));
|
||||||
app.use('/maps', require('./routes/map'));
|
|
||||||
app.use('/datagen', require('./routes/datagen'));
|
app.use('/datagen', require('./routes/datagen'));
|
||||||
app.use('/admin', require('./routes/admin'));
|
app.use('/admin', require('./routes/admin'));
|
||||||
*/
|
*/
|
||||||
@@ -69,4 +102,4 @@ app.get("/api/test", (req, res) => {
|
|||||||
|
|
||||||
app.listen(5000, () => {
|
app.listen(5000, () => {
|
||||||
console.log("Server running on port 5000");
|
console.log("Server running on port 5000");
|
||||||
});
|
});
|
||||||
|
|||||||
122
backend/src/models/Actor.js
Normal file
122
backend/src/models/Actor.js
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const ActorSchema = new Schema({
|
||||||
|
name: { type: String, required: true, trim: true },
|
||||||
|
type: { type: String, enum: ['character', 'npc', 'creature'], default: 'character' },
|
||||||
|
species: { type: String, default: '' },
|
||||||
|
className: { type: String, default: '' },
|
||||||
|
subclass: { type: String, default: '' },
|
||||||
|
level: { type: Number, min: 1, max: 20, default: 1 },
|
||||||
|
background: { type: String, default: '' },
|
||||||
|
challengeRating: { type: String, default: '' },
|
||||||
|
description: { type: String, default: '' },
|
||||||
|
image: { type: String, default: '' },
|
||||||
|
abilityScores: {
|
||||||
|
str: { type: Number, min: 1, max: 30, default: 10 },
|
||||||
|
dex: { type: Number, min: 1, max: 30, default: 10 },
|
||||||
|
con: { type: Number, min: 1, max: 30, default: 10 },
|
||||||
|
int: { type: Number, min: 1, max: 30, default: 10 },
|
||||||
|
wis: { type: Number, min: 1, max: 30, default: 10 },
|
||||||
|
cha: { type: Number, min: 1, max: 30, default: 10 }
|
||||||
|
},
|
||||||
|
armorClass: { type: Number, min: 0, default: 10 },
|
||||||
|
speed: { type: Number, min: 0, default: 30 },
|
||||||
|
// The two pools the sheet draws as bars under the portrait (Syndria98/dragonroll#64): the bar
|
||||||
|
// fills `current` of `max`, so both travel together. `current` is kept below `max` by whoever
|
||||||
|
// writes them (routes/actor.js), the same way the sheet clamps the bar.
|
||||||
|
hitPoints: {
|
||||||
|
current: { type: Number, min: 0, default: 10 },
|
||||||
|
max: { type: Number, min: 0, default: 10 }
|
||||||
|
},
|
||||||
|
hitDice: {
|
||||||
|
current: { type: Number, min: 0, default: 1 },
|
||||||
|
max: { type: Number, min: 0, default: 1 }
|
||||||
|
},
|
||||||
|
proficiencies: { type: String, default: '' },
|
||||||
|
// The skills the character is proficient with (Syndria98/dragonroll#83). Dragonroll holds
|
||||||
|
// whole names; services/actor-foundry.js translates the short keys a Foundry world uses.
|
||||||
|
skills: {
|
||||||
|
acrobatics: { type: Boolean, default: false },
|
||||||
|
animalHandling: { type: Boolean, default: false },
|
||||||
|
arcana: { type: Boolean, default: false },
|
||||||
|
athletics: { type: Boolean, default: false },
|
||||||
|
deception: { type: Boolean, default: false },
|
||||||
|
history: { type: Boolean, default: false },
|
||||||
|
insight: { type: Boolean, default: false },
|
||||||
|
intimidation: { type: Boolean, default: false },
|
||||||
|
investigation: { type: Boolean, default: false },
|
||||||
|
medicine: { type: Boolean, default: false },
|
||||||
|
nature: { type: Boolean, default: false },
|
||||||
|
perception: { type: Boolean, default: false },
|
||||||
|
performance: { type: Boolean, default: false },
|
||||||
|
persuasion: { type: Boolean, default: false },
|
||||||
|
religion: { type: Boolean, default: false },
|
||||||
|
sleightOfHand: { type: Boolean, default: false },
|
||||||
|
stealth: { type: Boolean, default: false },
|
||||||
|
survival: { type: Boolean, default: false }
|
||||||
|
},
|
||||||
|
// Which of the six saving throws the character adds its proficiency bonus to.
|
||||||
|
savingThrows: {
|
||||||
|
str: { type: Boolean, default: false },
|
||||||
|
dex: { type: Boolean, default: false },
|
||||||
|
con: { type: Boolean, default: false },
|
||||||
|
int: { type: Boolean, default: false },
|
||||||
|
wis: { type: Boolean, default: false },
|
||||||
|
cha: { type: Boolean, default: false }
|
||||||
|
},
|
||||||
|
// Tool and language proficiencies: plain names, one per entry. The free-form
|
||||||
|
// `proficiencies` text keeps whatever else the character is proficient with
|
||||||
|
// (armour and weapons, say), which has no list of its own.
|
||||||
|
tools: [{ type: String, trim: true }],
|
||||||
|
languages: [{ type: String, trim: true }],
|
||||||
|
// The coins the character holds, in the five D&D denominations.
|
||||||
|
currency: {
|
||||||
|
pp: { type: Number, min: 0, default: 0 },
|
||||||
|
gp: { type: Number, min: 0, default: 0 },
|
||||||
|
ep: { type: Number, min: 0, default: 0 },
|
||||||
|
sp: { type: Number, min: 0, default: 0 },
|
||||||
|
cp: { type: Number, min: 0, default: 0 }
|
||||||
|
},
|
||||||
|
inventory: [{
|
||||||
|
name: { type: String, trim: true, default: '' },
|
||||||
|
quantity: { type: Number, min: 1, default: 1 },
|
||||||
|
weight: { type: Number, min: 0, default: 0 },
|
||||||
|
// The gear's own picture: what a Foundry world sends with the item it stands
|
||||||
|
// for, shown on the left of the inventory row.
|
||||||
|
icon: { type: String, default: '' }
|
||||||
|
}],
|
||||||
|
traits: { type: String, default: '' },
|
||||||
|
spells: { type: String, default: '' },
|
||||||
|
campaign: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
ref: 'Campaign',
|
||||||
|
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 },
|
||||||
|
// The Discord player this character belongs to (Syndria98/dragonroll#72): each player
|
||||||
|
// of the server a campaign is linked to holds one character of it. Only
|
||||||
|
// routes/discord.js writes it, so the campaign keeps owning it whichever guild claimed it.
|
||||||
|
discordUserId: { type: String, default: null },
|
||||||
|
date: { type: Date, default: Date.now }
|
||||||
|
});
|
||||||
|
|
||||||
|
ActorSchema.index(
|
||||||
|
{ campaign: 1, foundryActorId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundryActorId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
|
// A player holds at most one character of a campaign: the id is unique within it.
|
||||||
|
ActorSchema.index(
|
||||||
|
{ campaign: 1, discordUserId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { discordUserId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
|
module.exports = mongoose.model('Actor', ActorSchema);
|
||||||
@@ -11,7 +11,14 @@ const CampaignSchema = new Schema({
|
|||||||
required: true
|
required: true
|
||||||
},
|
},
|
||||||
date: { type: Date, default: Date.now},
|
date: { type: Date, default: Date.now},
|
||||||
settings: { type: Object }
|
settings: { type: Object },
|
||||||
|
foundryWorldId: { type: String, unique: true, sparse: true },
|
||||||
|
foundryWorldTitle: { type: String },
|
||||||
|
foundrySystem: { type: String },
|
||||||
|
foundrySyncTokenHash: { type: String, select: false },
|
||||||
|
// Discord server ("guild") this campaign is linked to. A campaign serves
|
||||||
|
// at most one guild, and a guild selects one campaign.
|
||||||
|
discordGuildId: { type: String, index: true }
|
||||||
});
|
});
|
||||||
|
|
||||||
module.exports = mongoose.model('Campaign', CampaignSchema);
|
module.exports = mongoose.model('Campaign', CampaignSchema);
|
||||||
|
|||||||
11
backend/src/models/DiscordGuildLink.js
Normal file
11
backend/src/models/DiscordGuildLink.js
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const DiscordGuildLinkSchema = new Schema({
|
||||||
|
guildId: { type: String, required: true, unique: true, index: true },
|
||||||
|
discordUserId: { type: String, required: true },
|
||||||
|
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User', required: true },
|
||||||
|
connectedAt: { type: Date, default: Date.now }
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = mongoose.model('DiscordGuildLink', DiscordGuildLinkSchema);
|
||||||
63
backend/src/models/Folder.js
Normal file
63
backend/src/models/Folder.js
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
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({
|
||||||
|
name: { type: String, required: true },
|
||||||
|
campaign: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
ref: 'Campaign',
|
||||||
|
required: true
|
||||||
|
},
|
||||||
|
parentFolder: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
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 },
|
||||||
|
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);
|
||||||
51
backend/src/models/Item.js
Normal file
51
backend/src/models/Item.js
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const ItemSchema = new Schema({
|
||||||
|
name: { type: String, required: true, trim: true },
|
||||||
|
category: {
|
||||||
|
type: String,
|
||||||
|
enum: ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'],
|
||||||
|
default: 'adventuring-gear'
|
||||||
|
},
|
||||||
|
rarity: {
|
||||||
|
type: String,
|
||||||
|
enum: ['common', 'uncommon', 'rare', 'very-rare', 'legendary', 'artifact'],
|
||||||
|
default: 'common'
|
||||||
|
},
|
||||||
|
quantity: { type: Number, min: 1, default: 1 },
|
||||||
|
weight: { type: Number, min: 0 },
|
||||||
|
properties: { type: String, default: '' },
|
||||||
|
description: { type: String, default: '' },
|
||||||
|
// 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: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
ref: 'Campaign',
|
||||||
|
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 },
|
||||||
|
// Names Foundry uses for this item. Dragonroll may rename it, and the copies
|
||||||
|
// Foundry keeps sending still have to fold into this row instead of
|
||||||
|
// creating a second item under their original name.
|
||||||
|
foundryNames: { type: [String], default: [] },
|
||||||
|
date: { type: Date, default: Date.now }
|
||||||
|
});
|
||||||
|
|
||||||
|
ItemSchema.index(
|
||||||
|
{ campaign: 1, foundryItemId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundryItemId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
|
module.exports = mongoose.model('Item', ItemSchema);
|
||||||
67
backend/src/models/Map.js
Normal file
67
backend/src/models/Map.js
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const MapSchema = new Schema({
|
||||||
|
name: { type: String, required: true, trim: true },
|
||||||
|
// Uploaded image, served from /api/public/<filename>
|
||||||
|
image: { type: String, default: '' },
|
||||||
|
// Grid cell size in image pixels
|
||||||
|
gridSize: { type: Number, min: 1, default: 50 },
|
||||||
|
// Grid origin, in image pixels from the top left corner of the image
|
||||||
|
offsetX: { type: Number, default: 0 },
|
||||||
|
offsetY: { type: Number, default: 0 },
|
||||||
|
// Distance each grid cell stands for (feet, metres...)
|
||||||
|
scale: { type: Number, min: 0.01, default: 5 },
|
||||||
|
// Notes pinned onto the map like markers. x/y are image pixels from the top left corner of the
|
||||||
|
// image, so a pin keeps its place whatever the zoom or the grid settings are.
|
||||||
|
pins: [{
|
||||||
|
note: { type: Schema.Types.ObjectId, ref: 'Note', required: true },
|
||||||
|
x: { type: Number, default: 0 },
|
||||||
|
y: { type: Number, default: 0 }
|
||||||
|
}],
|
||||||
|
// 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 }
|
||||||
|
}],
|
||||||
|
// Segments that block the map like walls. The endpoints are image pixels from the top left corner
|
||||||
|
// of the image, like a pin — and the very space Foundry draws a scene's walls in, so a paired
|
||||||
|
// scene and map trade them as they stand. `move`/`sight` say what passes through the segment, and
|
||||||
|
// `door` is 0 (not a door), 1 (open) or 2 (closed), following Foundry's own wall values.
|
||||||
|
walls: [{
|
||||||
|
x1: { type: Number, default: 0 },
|
||||||
|
y1: { type: Number, default: 0 },
|
||||||
|
x2: { type: Number, default: 0 },
|
||||||
|
y2: { type: Number, default: 0 },
|
||||||
|
move: { type: Boolean, default: true },
|
||||||
|
sight: { type: Boolean, default: true },
|
||||||
|
door: { type: Number, min: 0, max: 2, default: 0 }
|
||||||
|
}],
|
||||||
|
campaign: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
ref: 'Campaign',
|
||||||
|
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
|
||||||
|
},
|
||||||
|
// The Foundry scene whose walls this map mirrors once the linked world has paired them (see
|
||||||
|
// routes/foundry-link.js): the whole wall set of one is the whole wall set of the other.
|
||||||
|
foundrySceneId: { type: String },
|
||||||
|
date: { type: Date, default: Date.now }
|
||||||
|
});
|
||||||
|
|
||||||
|
// A scene walls one map of a campaign at most, like a Foundry actor one actor row.
|
||||||
|
MapSchema.index(
|
||||||
|
{ campaign: 1, foundrySceneId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundrySceneId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
|
module.exports = mongoose.model('Map', MapSchema);
|
||||||
@@ -9,6 +9,11 @@ const NoteSchema = new Schema({
|
|||||||
ref: 'Campaign',
|
ref: 'Campaign',
|
||||||
required: true
|
required: true
|
||||||
},
|
},
|
||||||
|
folder: {
|
||||||
|
type: Schema.Types.ObjectId,
|
||||||
|
ref: 'Folder'
|
||||||
|
},
|
||||||
|
color: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
44
backend/src/models/ServiceLinkRequest.js
Normal file
44
backend/src/models/ServiceLinkRequest.js
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
// One row per service installation that wants to use a campaign: a Foundry
|
||||||
|
// world, a Discord server, an Obsidian vault. Asking for a link resets the row
|
||||||
|
// to a fresh pending request, so a service always has one row and that row is
|
||||||
|
// also the record of the link that is active right now.
|
||||||
|
//
|
||||||
|
// The service starts the request and shows the sign-up link it gets back; a
|
||||||
|
// Dragonroll user then signs in through that link and picks the campaign. The
|
||||||
|
// service picks its credential up with the same code it was given.
|
||||||
|
const ServiceLinkRequestSchema = new Schema({
|
||||||
|
service: { type: String, enum: ['foundry', 'discord', 'obsidian'], required: true },
|
||||||
|
// Who is asking, in its own terms: Foundry world id, Discord guild id, vault id.
|
||||||
|
targetId: { type: String },
|
||||||
|
targetName: { type: String },
|
||||||
|
// The person who asked, as far as the service knows: GM name, Discord user...
|
||||||
|
targetUser: { type: String },
|
||||||
|
// Whatever else the service describes itself with (Foundry system and URL).
|
||||||
|
targetMeta: { type: Object },
|
||||||
|
codeHash: { type: String, required: true, unique: true },
|
||||||
|
campaign: { type: Schema.Types.ObjectId, ref: 'Campaign' },
|
||||||
|
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User' },
|
||||||
|
// 'pending' until a Dragonroll user picks a campaign through the sign-up
|
||||||
|
// link, 'linked' while that choice stands, 'revoked' once the campaign
|
||||||
|
// unlinked the service again.
|
||||||
|
state: { type: String, enum: ['pending', 'linked', 'revoked'], default: 'pending' },
|
||||||
|
// What the service gets when it picks the link up: the Foundry sync token,
|
||||||
|
// the Obsidian session. Dropped as soon as it has been delivered.
|
||||||
|
credentials: { type: Object, select: false },
|
||||||
|
createdAt: { type: Date, default: Date.now },
|
||||||
|
// Only a request nobody answers expires: an empty value keeps the link.
|
||||||
|
expiresAt: { type: Date },
|
||||||
|
linkedAt: { type: Date },
|
||||||
|
pickedUpAt: { type: Date },
|
||||||
|
// The Discord bot has confirmed this authorization in Discord.
|
||||||
|
notifiedAt: { type: Date }
|
||||||
|
});
|
||||||
|
|
||||||
|
ServiceLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
|
||||||
|
ServiceLinkRequestSchema.index({ service: 1, targetId: 1 });
|
||||||
|
ServiceLinkRequestSchema.index({ campaign: 1, service: 1, state: 1 });
|
||||||
|
|
||||||
|
module.exports = mongoose.model('ServiceLinkRequest', ServiceLinkRequestSchema);
|
||||||
165
backend/src/routes/actor.js
Normal file
165
backend/src/routes/actor.js
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const upload = require('../services/storage');
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const Actor = require('../models/Actor');
|
||||||
|
const Folder = require('../models/Folder');
|
||||||
|
const Map = require('../models/Map');
|
||||||
|
|
||||||
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
|
return Boolean(campaign);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hit points and hit dice travel as a bar the sheet fills (`current` of `max`, see models/Actor.js).
|
||||||
|
// A partial update keeps whatever half of the pair it did not send, and `current` never passes the
|
||||||
|
// maximum it ends up with.
|
||||||
|
function barPool(existing, value) {
|
||||||
|
const max = Math.max(0, Number(value?.max ?? existing?.max) || 0);
|
||||||
|
const current = Math.max(0, Math.min(Number(value?.current ?? existing?.current) || 0, max));
|
||||||
|
return { current, max };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tool and language lists (Syndria98/dragonroll#83): plain names, blank ones and
|
||||||
|
// repeats dropped.
|
||||||
|
function textList(value) {
|
||||||
|
if (!Array.isArray(value)) return [];
|
||||||
|
return [...new Set(value.map((name) => String(name).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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) => {
|
||||||
|
try {
|
||||||
|
const { campaign } = req.query;
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
|
res.json({ status: 'ok', actors, folders: await actorFolders(campaign) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/create', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { name, campaign, type, species, className, subclass, level, background, challengeRating, description } = req.body;
|
||||||
|
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const actor = await Actor.create({
|
||||||
|
name: name.trim(), campaign, type, species, className, subclass,
|
||||||
|
level: level === '' || level === undefined ? undefined : Number(level),
|
||||||
|
background, challengeRating, description
|
||||||
|
});
|
||||||
|
res.json({ status: 'ok', actor });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/update', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const {
|
||||||
|
id, name, species, className, subclass, level, abilityScores, armorClass, speed, hitPoints, hitDice,
|
||||||
|
proficiencies, skills, savingThrows, tools, languages, currency, inventory, traits, spells, image, folder
|
||||||
|
} = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const actor = await Actor.findById(id);
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
// `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 (species !== undefined) actor.species = species;
|
||||||
|
if (className !== undefined) actor.className = className;
|
||||||
|
if (subclass !== undefined) actor.subclass = subclass;
|
||||||
|
if (level !== undefined) actor.level = Number(level);
|
||||||
|
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
|
||||||
|
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
|
||||||
|
if (speed !== undefined) actor.speed = Number(speed);
|
||||||
|
if (hitPoints !== undefined) actor.hitPoints = barPool(actor.hitPoints, hitPoints);
|
||||||
|
if (hitDice !== undefined) actor.hitDice = barPool(actor.hitDice, hitDice);
|
||||||
|
if (proficiencies !== undefined) actor.proficiencies = proficiencies;
|
||||||
|
// The lists the sheet toggles and fills in (Syndria98/dragonroll#83): which skills
|
||||||
|
// and saving throws the character is proficient with, its tools, its languages and
|
||||||
|
// the coins it carries.
|
||||||
|
if (skills !== undefined) actor.skills = skills;
|
||||||
|
if (savingThrows !== undefined) actor.savingThrows = savingThrows;
|
||||||
|
if (tools !== undefined) actor.tools = textList(tools);
|
||||||
|
if (languages !== undefined) actor.languages = textList(languages);
|
||||||
|
if (currency !== undefined) actor.currency = currency;
|
||||||
|
if (inventory !== undefined) actor.inventory = inventory;
|
||||||
|
if (traits !== undefined) actor.traits = traits;
|
||||||
|
if (spells !== undefined) actor.spells = spells;
|
||||||
|
if (image !== undefined) actor.image = String(image);
|
||||||
|
|
||||||
|
await actor.save();
|
||||||
|
res.json({ status: 'ok', actor });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Upload actor image post
|
||||||
|
router.post("/upload-image", upload.single("image"), async (req, res) => {
|
||||||
|
try {
|
||||||
|
const actorId = req.query.actor || req.body.actor;
|
||||||
|
if (!actorId || !req.file) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const actor = await Actor.findById(actorId);
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
actor.image = req.file.filename;
|
||||||
|
await actor.save();
|
||||||
|
res.json({ status: "ok", msg: "uploaded", actor });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: "error", msg: "internal" });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const actor = await Actor.findById(id);
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
await actor.deleteOne();
|
||||||
|
|
||||||
|
// 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' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
@@ -2,6 +2,28 @@ const express = require('express')
|
|||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
const Campaign = require("../models/Campaign");
|
const Campaign = require("../models/Campaign");
|
||||||
|
const User = require('../models/User');
|
||||||
|
const serviceLinks = require('../services/service-links');
|
||||||
|
|
||||||
|
// Every service links to a campaign through the same sign-up link
|
||||||
|
// (routes/service-link.js); a campaign only drops one of them again.
|
||||||
|
async function unlinkService(campaign, service) {
|
||||||
|
if (service === 'foundry') {
|
||||||
|
campaign.foundryWorldId = undefined;
|
||||||
|
campaign.foundryWorldTitle = undefined;
|
||||||
|
campaign.foundrySystem = undefined;
|
||||||
|
campaign.set('foundrySyncTokenHash', undefined);
|
||||||
|
} else if (service === 'discord') {
|
||||||
|
// The Discord account the bot answers to stays: the server is simply
|
||||||
|
// left without a campaign until somebody picks one again.
|
||||||
|
campaign.discordGuildId = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
await campaign.save();
|
||||||
|
// A link a service still holds becomes invalid, and it finds that out the
|
||||||
|
// next time it asks where its link stands.
|
||||||
|
await serviceLinks.revokeServiceLink(service, campaign._id);
|
||||||
|
}
|
||||||
|
|
||||||
router.post('/create', async (req, res) => {
|
router.post('/create', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
@@ -21,6 +43,84 @@ router.post('/create', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
router.post('/update', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, name, color, settings } = req.body;
|
||||||
|
if (!id) return res.json({ status: "error", msg: "errors.missing-data" });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: id, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: "error", msg: "errors.notfound" });
|
||||||
|
|
||||||
|
if (name !== undefined) {
|
||||||
|
if (typeof name !== 'string' || !name.trim()) {
|
||||||
|
return res.json({ status: "error", msg: "errors.missing-data" });
|
||||||
|
}
|
||||||
|
campaign.name = name.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (color !== undefined) {
|
||||||
|
if (typeof color !== 'string') return res.json({ status: "error", msg: "errors.missing-data" });
|
||||||
|
campaign.color = color;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (settings !== undefined) {
|
||||||
|
if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
|
||||||
|
return res.json({ status: "error", msg: "errors.missing-data" });
|
||||||
|
}
|
||||||
|
campaign.settings = settings;
|
||||||
|
}
|
||||||
|
|
||||||
|
await campaign.save();
|
||||||
|
res.json({ status: "ok", campaign });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: "error", msg: "errors.internal" });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Which services a campaign has connected, and the account each of them was
|
||||||
|
// authorized with.
|
||||||
|
router.get('/services', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const links = await serviceLinks.listLinkedServices(campaign._id);
|
||||||
|
const userIds = [...new Set(links.map((link) => String(link.dragonrollUser ?? '')).filter(Boolean))];
|
||||||
|
const users = userIds.length
|
||||||
|
? await User.find({ _id: { $in: userIds } }).select('username name').lean()
|
||||||
|
: [];
|
||||||
|
const names = new Map(users.map((user) => [String(user._id), user.username || user.name]));
|
||||||
|
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
services: links.map((link) => ({
|
||||||
|
...link,
|
||||||
|
dragonrollUserName: names.get(String(link.dragonrollUser ?? '')) || null
|
||||||
|
}))
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/service-unlink', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const service = String(req.body.service || '').trim();
|
||||||
|
if (!serviceLinks.isService(service)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
await unlinkService(campaign, service);
|
||||||
|
res.json({ status: 'ok', campaign, services: await serviceLinks.listLinkedServices(campaign._id) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
router.get('/list', async (req, res) => {
|
router.get('/list', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const campaigns = await Campaign.find({ createdBy: req.user.id });
|
const campaigns = await Campaign.find({ createdBy: req.user.id });
|
||||||
|
|||||||
275
backend/src/routes/discord.js
Normal file
275
backend/src/routes/discord.js
Normal file
@@ -0,0 +1,275 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const Actor = require('../models/Actor');
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const DiscordGuildLink = require('../models/DiscordGuildLink');
|
||||||
|
const ServiceLinkRequest = require('../models/ServiceLinkRequest');
|
||||||
|
const User = require('../models/User');
|
||||||
|
const serviceLinks = require('../services/service-links');
|
||||||
|
|
||||||
|
const NOTIFICATION_LIMIT = 10;
|
||||||
|
|
||||||
|
const requireBot = serviceLinks.requireDiscordBot;
|
||||||
|
|
||||||
|
function validGuildId(value) {
|
||||||
|
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Discord ids are snowflakes the same shape as guild ids.
|
||||||
|
function validUserId(value) {
|
||||||
|
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Connecting a Discord server is the service link of issue: the bot asks
|
||||||
|
// /api/link/start for a sign-up link, and whoever opens it signs in and picks the
|
||||||
|
// campaign this server may read. What is left here is what the bot needs once
|
||||||
|
// that link exists: confirming it in Discord and working with its campaign.
|
||||||
|
|
||||||
|
async function dragonrollUserNames(requests) {
|
||||||
|
const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))];
|
||||||
|
if (!userIds.length) return new Map();
|
||||||
|
|
||||||
|
const users = await User.find({ _id: { $in: userIds } }).select('username name').lean();
|
||||||
|
return new Map(users.map((user) => [String(user._id), user.username || user.name]));
|
||||||
|
}
|
||||||
|
|
||||||
|
// El bot reclama les autoritzacions ja fetes per confirmar-les a Discord. Marcar-les aqui
|
||||||
|
// mateix evita que dos processos del bot confirmïn la mateixa vegada.
|
||||||
|
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const pending = await ServiceLinkRequest.find({
|
||||||
|
service: 'discord',
|
||||||
|
state: 'linked',
|
||||||
|
linkedAt: { $gte: new Date(Date.now() - serviceLinks.NOTIFICATION_WINDOW_MS) },
|
||||||
|
notifiedAt: null
|
||||||
|
}).select('_id targetId targetName targetUser targetMeta dragonrollUser campaign')
|
||||||
|
.limit(NOTIFICATION_LIMIT)
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
const claimed = [];
|
||||||
|
for (const request of pending) {
|
||||||
|
const taken = await ServiceLinkRequest.findOneAndUpdate(
|
||||||
|
{ _id: request._id, notifiedAt: null },
|
||||||
|
{ $set: { notifiedAt: new Date() } },
|
||||||
|
{ new: true }
|
||||||
|
).lean();
|
||||||
|
if (taken) claimed.push(request);
|
||||||
|
}
|
||||||
|
|
||||||
|
const names = await dragonrollUserNames(claimed);
|
||||||
|
const campaignIds = [...new Set(claimed.map((request) => String(request.campaign ?? '')).filter(Boolean))];
|
||||||
|
const campaigns = campaignIds.length
|
||||||
|
? await Campaign.find({ _id: { $in: campaignIds } }).select('_id name').lean()
|
||||||
|
: [];
|
||||||
|
const campaignNames = new Map(campaigns.map((campaign) => [String(campaign._id), campaign.name]));
|
||||||
|
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
notifications: claimed.map((request) => ({
|
||||||
|
id: String(request._id),
|
||||||
|
guildId: request.targetId,
|
||||||
|
guildName: request.targetName,
|
||||||
|
discordUserId: request.targetMeta?.userId || '',
|
||||||
|
discordUserName: request.targetUser,
|
||||||
|
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null,
|
||||||
|
campaignName: campaignNames.get(String(request.campaign ?? '')) || null
|
||||||
|
}))
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/bot/guild/:guildId/status', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
if (!validGuildId(req.params.guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId: req.params.guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'ok', connected: false, campaign: null });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({
|
||||||
|
discordGuildId: req.params.guildId,
|
||||||
|
createdBy: link.dragonrollUser
|
||||||
|
}).select('_id name').lean();
|
||||||
|
res.json({ status: 'ok', connected: true, campaign });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/bot/guild/:guildId/campaigns', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
if (!validGuildId(req.params.guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId: req.params.guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
|
||||||
|
const campaigns = await Campaign.find({ createdBy: link.dragonrollUser })
|
||||||
|
.select('_id name discordGuildId')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
res.json({ status: 'ok', campaigns });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/bot/guild/:guildId/campaign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
if (!validGuildId(guildId) || !req.body.campaignId) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: link.dragonrollUser });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const conflict = await Campaign.findOne({ discordGuildId: guildId, _id: { $ne: campaign._id } }).lean();
|
||||||
|
if (conflict && String(conflict.createdBy) !== String(link.dragonrollUser)) {
|
||||||
|
return res.json({ status: 'error', msg: 'campaigns.errors.discord-guild-in-use' });
|
||||||
|
}
|
||||||
|
if (campaign.discordGuildId && campaign.discordGuildId !== guildId) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.campaign-already-linked' });
|
||||||
|
}
|
||||||
|
|
||||||
|
await Campaign.updateMany(
|
||||||
|
{ discordGuildId: guildId, createdBy: link.dragonrollUser, _id: { $ne: campaign._id } },
|
||||||
|
{ $unset: { discordGuildId: 1 } }
|
||||||
|
);
|
||||||
|
campaign.discordGuildId = guildId;
|
||||||
|
await campaign.save();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name } });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.delete('/bot/guild/:guildId/campaign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
if (!validGuildId(guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
campaign.discordGuildId = undefined;
|
||||||
|
await campaign.save();
|
||||||
|
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name } });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/bot/guild/:guildId/actors', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
if (!validGuildId(guildId)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const actors = await Actor.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
||||||
|
res.json({ status: 'ok', campaign: { id: String(campaign._id), name: campaign.name }, actors });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Who may take a character already held by somebody else is decided in Discord,
|
||||||
|
// where the server administrators are: the bot authenticates with the shared
|
||||||
|
// secret and says whether the person asking is one (`admin`). Everything else
|
||||||
|
// the backend still guards itself: only the guild's own campaign is reachable.
|
||||||
|
|
||||||
|
// One command per player link (Syndria98/dragonroll#72): assigning takes the
|
||||||
|
// character for `discordUserId`, and a player never holds two of them, so a
|
||||||
|
// second assign moves the player instead of doubling them up.
|
||||||
|
router.post('/bot/guild/:guildId/actors/assign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
const discordUserId = String(req.body.discordUserId ?? '');
|
||||||
|
if (!validGuildId(guildId) || !validUserId(discordUserId) || !req.body.actorId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const actor = await Actor.findOne({ _id: req.body.actorId, campaign: campaign._id });
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const holder = String(actor.discordUserId ?? '');
|
||||||
|
if (holder && holder !== discordUserId && !req.body.admin) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.actor-held' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// The character this player hands over to take the new one.
|
||||||
|
const previous = await Actor.findOne({ campaign: campaign._id, discordUserId, _id: { $ne: actor._id } }).lean();
|
||||||
|
if (previous) {
|
||||||
|
await Actor.updateMany(
|
||||||
|
{ campaign: campaign._id, discordUserId, _id: { $ne: actor._id } },
|
||||||
|
{ $set: { discordUserId: null } }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
actor.discordUserId = discordUserId;
|
||||||
|
await actor.save();
|
||||||
|
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
actor: { id: String(actor._id), name: actor.name, discordUserId },
|
||||||
|
previous: previous ? { id: String(previous._id), name: previous.name } : null
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Freeing a character: without `actorId` the player gives up their own, with
|
||||||
|
// one a server administrator frees anybody's.
|
||||||
|
router.post('/bot/guild/:guildId/actors/unassign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
const discordUserId = String(req.body.discordUserId ?? '');
|
||||||
|
if (!validGuildId(guildId) || !validUserId(discordUserId)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const filter = { campaign: campaign._id };
|
||||||
|
if (req.body.actorId) filter._id = req.body.actorId;
|
||||||
|
else filter.discordUserId = discordUserId;
|
||||||
|
const actor = await Actor.findOne(filter);
|
||||||
|
if (!actor || !actor.discordUserId) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const holder = String(actor.discordUserId);
|
||||||
|
if (holder !== discordUserId && !req.body.admin) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.actor-held' });
|
||||||
|
}
|
||||||
|
|
||||||
|
actor.discordUserId = null;
|
||||||
|
await actor.save();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', actor: { id: String(actor._id), name: actor.name }, wasYours: holder === discordUserId });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
150
backend/src/routes/folder.js
Normal file
150
backend/src/routes/folder.js
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const Actor = require('../models/Actor');
|
||||||
|
const Folder = require('../models/Folder');
|
||||||
|
const Map = require('../models/Map');
|
||||||
|
const Note = require('../models/Note');
|
||||||
|
const Item = require('../models/Item');
|
||||||
|
|
||||||
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
|
return Boolean(campaign);
|
||||||
|
}
|
||||||
|
|
||||||
|
router.get('/list', async (req, res) => {
|
||||||
|
try {
|
||||||
|
// Every sidebar section has its own folders; a request that names none means the
|
||||||
|
// 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);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const folders = await Folder.find({ campaign, ...Folder.filterForTarget(target) })
|
||||||
|
.select('_id name parentFolder date color')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', folders });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/create', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { name, campaign, target = 'note' } = req.body;
|
||||||
|
if (!name || !campaign || !Folder.isTarget(target)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const newFolder = new Folder({
|
||||||
|
name: name.trim(),
|
||||||
|
campaign,
|
||||||
|
target
|
||||||
|
});
|
||||||
|
await newFolder.save();
|
||||||
|
res.json({ status: 'ok', folder: newFolder });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Renaming and colouring works the same for the folders of every campaign section.
|
||||||
|
router.post('/update', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, name, color } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const folder = await Folder.findById(id);
|
||||||
|
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
if (name !== undefined) folder.name = String(name).trim();
|
||||||
|
if (color !== undefined) folder.color = color;
|
||||||
|
await folder.save();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', folder });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const folder = await Folder.findById(id);
|
||||||
|
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
async function moveRecursive(folderId) {
|
||||||
|
const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean();
|
||||||
|
// 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(
|
||||||
|
{ folder: folderId },
|
||||||
|
{ $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 });
|
||||||
|
for (const sub of subfolders) {
|
||||||
|
await moveRecursive(sub._id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await moveRecursive(id);
|
||||||
|
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/rename', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, name } = req.body;
|
||||||
|
if (!id || !name) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const folder = await Folder.findById(id);
|
||||||
|
if (!folder) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(folder.campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
folder.name = name.trim();
|
||||||
|
await folder.save();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', folder });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
585
backend/src/routes/foundry-link.js
Normal file
585
backend/src/routes/foundry-link.js
Normal file
@@ -0,0 +1,585 @@
|
|||||||
|
const crypto = require('node:crypto');
|
||||||
|
const express = require('express');
|
||||||
|
const mongoose = require('mongoose');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const Actor = require('../models/Actor');
|
||||||
|
const Item = require('../models/Item');
|
||||||
|
const Folder = require('../models/Folder');
|
||||||
|
// `MapModel`, not `Map`: this file uses the built-in `Map` for the item folder maps.
|
||||||
|
const MapModel = require('../models/Map');
|
||||||
|
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
||||||
|
const { foundryItemToItemData } = require('../services/item-foundry');
|
||||||
|
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
||||||
|
|
||||||
|
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
||||||
|
const MAX_FOUNDRY_NAMES = 20;
|
||||||
|
|
||||||
|
function codeHash(code) {
|
||||||
|
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
|
||||||
|
}
|
||||||
|
|
||||||
|
function readSyncToken(req) {
|
||||||
|
const match = /^Bearer\s+(.+)$/i.exec(req.get('authorization') || '');
|
||||||
|
return match?.[1] || '';
|
||||||
|
}
|
||||||
|
|
||||||
|
async function syncCampaign(req, res) {
|
||||||
|
const token = readSyncToken(req);
|
||||||
|
if (!token) {
|
||||||
|
res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ foundrySyncTokenHash: codeHash(token) });
|
||||||
|
if (!campaign?.foundryWorldId) {
|
||||||
|
res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return campaign;
|
||||||
|
}
|
||||||
|
|
||||||
|
function requestMatchesWorld(campaign, worldId) {
|
||||||
|
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Foundry serves its data directory from the world's own address, which is the one the
|
||||||
|
// campaign keeps under `settings.integrations.foundryUrl` — the icon window already loads
|
||||||
|
// the world's icons through it. The module sends the images it publishes as absolute URLs;
|
||||||
|
// the bridge's snapshot and older modules carry Foundry's relative paths, and a sheet
|
||||||
|
// reading one of those against Dragonroll's upload folder finds nothing, which is how the
|
||||||
|
// icons stopped loading (Syndria98/dragonroll#89). An absolute URL travels as it is, and so
|
||||||
|
// does a path when the campaign has no world address to read it against.
|
||||||
|
function worldAssetUrl(image, worldUrl) {
|
||||||
|
const value = String(image ?? '').trim();
|
||||||
|
if (!value || /^(https?:|data:|\/\/)/i.test(value)) return value;
|
||||||
|
return joinFoundryAssetUrl(worldUrl, value) || value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The images a world document arrives with, read against its world before they land.
|
||||||
|
function resolveWorldAssets(fields, campaign) {
|
||||||
|
const worldUrl = campaign?.settings?.integrations?.foundryUrl;
|
||||||
|
if (typeof fields.image === 'string') fields.image = worldAssetUrl(fields.image, worldUrl);
|
||||||
|
if (Array.isArray(fields.inventory)) {
|
||||||
|
for (const entry of fields.inventory) entry.icon = worldAssetUrl(entry.icon, worldUrl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveFoundryActor(campaign, source, fullSync = false) {
|
||||||
|
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
|
const fields = foundryActorToCharacter(source || {});
|
||||||
|
if (!foundryActorId || !fields.name) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
|
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
||||||
|
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
||||||
|
if (!actor && mongoose.isValidObjectId(dragonrollActorId)) {
|
||||||
|
actor = await Actor.findOne({ _id: dragonrollActorId, campaign: campaign._id });
|
||||||
|
}
|
||||||
|
if (!actor) {
|
||||||
|
const possibleMatches = await Actor.find({
|
||||||
|
campaign: campaign._id,
|
||||||
|
name: fields.name,
|
||||||
|
foundryActorId: { $exists: false }
|
||||||
|
}).limit(2);
|
||||||
|
actor = possibleMatches.length === 1
|
||||||
|
? possibleMatches[0]
|
||||||
|
: new Actor({ campaign: campaign._id });
|
||||||
|
}
|
||||||
|
actor.foundryActorId = foundryActorId;
|
||||||
|
// `created` says whether this row is new: whoever imports a whole world counts
|
||||||
|
// the rows it made apart from the ones it only wrote over.
|
||||||
|
const created = actor.isNew;
|
||||||
|
// A full snapshot runs when a GM reconnects. Preserve existing Dragonroll
|
||||||
|
// edits then; live Foundry change events continue to overwrite normally.
|
||||||
|
if (!fullSync || actor.isNew) Object.assign(actor, fields);
|
||||||
|
await actor.save();
|
||||||
|
return { foundryActorId, actorId: actor.id, created };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The campaign's item list mirrors the world's item directory and nothing else
|
||||||
|
// (Syndria98/dragonroll#67). The items embedded in an actor are that character's own
|
||||||
|
// inventory: they travel with the actor document (see services/actor-foundry.js), so a
|
||||||
|
// snapshot feeds Item rows from the world directory (`body.items`) alone and gear a
|
||||||
|
// character merely carries stays on its sheet instead of standing in the item list.
|
||||||
|
function snapshotItemSources(body) {
|
||||||
|
return Array.isArray(body.items) ? body.items : [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveFoundryItem(campaign, source, fullSync = false, folders = null) {
|
||||||
|
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
|
const fields = foundryItemToItemData(source || {});
|
||||||
|
if (!foundryItemId || !fields) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
|
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
||||||
|
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
||||||
|
if (!item && mongoose.isValidObjectId(dragonrollItemId)) {
|
||||||
|
const flagged = await Item.findOne({ _id: dragonrollItemId, campaign: campaign._id });
|
||||||
|
// Only adopt a flagged item while no other Foundry document owns its mapping.
|
||||||
|
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
|
||||||
|
}
|
||||||
|
if (!item) {
|
||||||
|
// A world item can share its name with a Dragonroll row the campaign made by
|
||||||
|
// hand, or with one it renamed away from. Keep a single item per name so a
|
||||||
|
// piece of gear the world sends folds into that row instead of doubling it.
|
||||||
|
const sameName = await Item.find({
|
||||||
|
campaign: campaign._id,
|
||||||
|
$or: [{ name: fields.name }, { foundryNames: fields.name }]
|
||||||
|
}).limit(4);
|
||||||
|
const represented = sameName.find((candidate) => candidate.foundryItemId);
|
||||||
|
if (represented) return { foundryItemId, itemId: represented.id };
|
||||||
|
const unclaimed = sameName.filter((candidate) => !candidate.foundryItemId);
|
||||||
|
item = unclaimed.length === 1 ? unclaimed[0] : new Item({ campaign: campaign._id, name: fields.name });
|
||||||
|
}
|
||||||
|
|
||||||
|
item.foundryItemId = foundryItemId;
|
||||||
|
// `created` says whether this row is new: whoever imports a whole world counts
|
||||||
|
// the rows it made apart from the ones it only wrote over.
|
||||||
|
const created = item.isNew;
|
||||||
|
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)) {
|
||||||
|
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 older 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();
|
||||||
|
return { foundryItemId, itemId: item.id, created };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function syncFoundryItems(campaign, sources, fullSync = false, folders = null) {
|
||||||
|
const items = [];
|
||||||
|
for (const source of sources) {
|
||||||
|
const mapping = await saveFoundryItem(campaign, source, fullSync, folders);
|
||||||
|
if (mapping) items.push(mapping);
|
||||||
|
}
|
||||||
|
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. Only the world's item
|
||||||
|
// directory reaches the campaign's item list, so only its folders are mirrored; the
|
||||||
|
// inventory folders an actor keeps for itself are none of the item list's business.
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
// The Foundry module shows this in its settings: the sync token alone only proves
|
||||||
|
// a link was made once, so the module asks which campaign it belongs to and hears
|
||||||
|
// back nothing but `unauthorized` once that campaign unlinks the world again.
|
||||||
|
router.get('/sync/status', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
campaign: { id: campaign.id, name: campaign.name },
|
||||||
|
worldId: campaign.foundryWorldId
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/snapshot', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const actorSources = Array.isArray(req.body.actors) ? req.body.actors : null;
|
||||||
|
const itemSources = Array.isArray(req.body.items) ? req.body.items : null;
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || (!actorSources && !itemSources)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const fullSync = req.body.fullSync === true;
|
||||||
|
// 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 = [];
|
||||||
|
for (const source of actorSources || []) {
|
||||||
|
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
||||||
|
if (mapping) actors.push(mapping);
|
||||||
|
}
|
||||||
|
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
||||||
|
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync, itemFolders);
|
||||||
|
|
||||||
|
if (fullSync && actorSources) {
|
||||||
|
const currentIds = actorSources
|
||||||
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
|
.filter(Boolean);
|
||||||
|
await Actor.deleteMany({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundryActorId: { $exists: true, $nin: currentIds }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
// Pruning needs a full snapshot: only that request sees the whole world
|
||||||
|
// directory, so it alone knows which synced rows the world has let go of.
|
||||||
|
if (fullSync && itemSources) {
|
||||||
|
const currentIds = snapshotItemSources(req.body)
|
||||||
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
|
.filter(Boolean);
|
||||||
|
await Item.deleteMany({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundryItemId: { $exists: true, $nin: currentIds }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
res.json({ status: 'ok', actors, items });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Live Foundry item edits: upserts only, never prunes items. Removing items that no
|
||||||
|
// 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) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
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)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const folders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
||||||
|
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items, false, folders) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const foundryActorId = String(req.body.foundryActorId || '').trim();
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundryActorId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
await Actor.deleteOne({ campaign: campaign._id, foundryActorId });
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/sync/characters', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const actors = await Actor.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
||||||
|
res.json({ status: 'ok', actors });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/map', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { actorId, foundryActorId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !actorId || !foundryActorId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const actor = await Actor.findOne({ _id: actorId, campaign: campaign._id });
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await Actor.findOne({ campaign: campaign._id, foundryActorId, _id: { $ne: actor._id } });
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.actor-already-synced' });
|
||||||
|
|
||||||
|
actor.foundryActorId = String(foundryActorId).trim().slice(0, 120);
|
||||||
|
await actor.save();
|
||||||
|
res.json({ status: 'ok', actor });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Only world-level Foundry items reach this route: an item dropped by an actor
|
||||||
|
// still exists in the world, and its actor snapshot overwrites the inventory.
|
||||||
|
router.post('/sync/item-delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const foundryItemId = String(req.body.foundryItemId || '').trim();
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundryItemId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
await Item.deleteOne({ campaign: campaign._id, foundryItemId });
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
||||||
|
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) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/map-item', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { itemId, foundryItemId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !itemId || !foundryItemId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const item = await Item.findOne({ _id: itemId, campaign: campaign._id });
|
||||||
|
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await Item.findOne({ campaign: campaign._id, foundryItemId, _id: { $ne: item._id } });
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.item-already-synced' });
|
||||||
|
|
||||||
|
item.foundryItemId = String(foundryItemId).trim().slice(0, 120);
|
||||||
|
await item.save();
|
||||||
|
res.json({ status: 'ok', item });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Scene walls -----------------------------------------------------------
|
||||||
|
// A campaign map can mirror the walls of a Foundry scene: the whole set travels whoever edits
|
||||||
|
// it, so the map's editor and the scene's wall tool see the same segments. A map is paired with
|
||||||
|
// a scene by name while the module reconciles its campaign — the way an unmapped item maps to
|
||||||
|
// the world document it shares its name with — and `POST /sync/map-scene` records that pairing.
|
||||||
|
// The endpoints are image pixels of the scene's background there too, so a segment crosses
|
||||||
|
// unchanged; `door` follows Foundry's own wall values (1 open, 2 closed), and locked doors
|
||||||
|
// arrive closed.
|
||||||
|
|
||||||
|
// Same shape the campaign's own `/map/walls` saves by: finite endpoints or nothing, whole pixels
|
||||||
|
// that never go off the top left corner, no segment without length.
|
||||||
|
function toSyncedWall(source) {
|
||||||
|
const corners = [source?.x1, source?.y1, source?.x2, source?.y2];
|
||||||
|
if (!corners.every((value) => Number.isFinite(Number(value)))) return null;
|
||||||
|
|
||||||
|
const toPixel = (value) => Math.max(0, Math.round(Number(value)));
|
||||||
|
const wall = {
|
||||||
|
x1: toPixel(source.x1),
|
||||||
|
y1: toPixel(source.y1),
|
||||||
|
x2: toPixel(source.x2),
|
||||||
|
y2: toPixel(source.y2),
|
||||||
|
move: source.move !== false,
|
||||||
|
sight: source.sight !== false,
|
||||||
|
door: [1, 2].includes(Math.round(Number(source.door))) ? Math.round(Number(source.door)) : 0
|
||||||
|
};
|
||||||
|
return wall.x1 === wall.x2 && wall.y1 === wall.y2 ? null : wall;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The maps the module pairs scenes with and reconciles walls against: what a wall set needs to
|
||||||
|
// land on a scene, and nothing the module has no use for.
|
||||||
|
router.get('/sync/maps', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
|
||||||
|
const maps = await MapModel.find({ campaign: campaign._id })
|
||||||
|
.select('_id name image foundrySceneId walls')
|
||||||
|
.sort({ name: 1 })
|
||||||
|
.lean();
|
||||||
|
res.json({ status: 'ok', maps });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/map-scene', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { mapId, foundrySceneId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !mapId || !foundrySceneId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const map = await MapModel.findOne({ _id: mapId, campaign: campaign._id });
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await MapModel.findOne({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundrySceneId: String(foundrySceneId).trim(),
|
||||||
|
_id: { $ne: map._id }
|
||||||
|
});
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.scene-already-synced' });
|
||||||
|
|
||||||
|
map.foundrySceneId = String(foundrySceneId).trim().slice(0, 120);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A scene's whole wall set, as the module draws it: the paired map takes it over, like the
|
||||||
|
// world's item folders take over the campaign's tree. A scene the campaign has no map paired
|
||||||
|
// with answers `notfound` — most scenes are none of the campaign's business.
|
||||||
|
router.post('/sync/map-walls', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { foundrySceneId, walls, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !foundrySceneId || !Array.isArray(walls)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const map = await MapModel.findOne({ campaign: campaign._id, foundrySceneId: String(foundrySceneId).trim() });
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
map.walls = walls.map(toSyncedWall).filter(Boolean);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map: { _id: map.id } });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
|
// The writers every Foundry document goes through: the sync pushes above, and the
|
||||||
|
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
||||||
|
// rules decides which campaign row a world document owns, so pulling a world over
|
||||||
|
// twice updates its rows instead of doubling them.
|
||||||
|
module.exports.saveFoundryActor = saveFoundryActor;
|
||||||
|
module.exports.saveFoundryItem = saveFoundryItem;
|
||||||
133
backend/src/routes/foundry.js
Normal file
133
backend/src/routes/foundry.js
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
const { requestFoundry } = require('../services/foundry');
|
||||||
|
const { normalizeIconDirectory, readIconListingPage, shapeIconListing } = require('../services/foundry-icons');
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
// The writers a Foundry document is stored through, shared with the sync pushes the
|
||||||
|
// linked module sends (routes/foundry-link.js) so both write a world's rows by the
|
||||||
|
// same rules.
|
||||||
|
const { saveFoundryActor, saveFoundryItem } = require('./foundry-link');
|
||||||
|
|
||||||
|
// 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. The linked world's
|
||||||
|
// id travels along: an import has to know whose data it is pulling over.
|
||||||
|
async function findOwnedCampaign(campaignId, userId) {
|
||||||
|
if (!campaignId) return null;
|
||||||
|
return Campaign.findOne({ _id: campaignId, createdBy: userId }).select('settings foundryWorldId').lean();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function proxy(path, res) {
|
||||||
|
try {
|
||||||
|
const result = await requestFoundry(path);
|
||||||
|
res.status(result.status).json(result.data);
|
||||||
|
} catch (err) {
|
||||||
|
if (err.code === 'FOUNDRY_NOT_CONFIGURED') {
|
||||||
|
return res.status(503).json({ status: 'error', msg: 'foundry.not-configured' });
|
||||||
|
}
|
||||||
|
|
||||||
|
console.error(err);
|
||||||
|
res.status(502).json({ status: 'error', msg: 'foundry.unavailable' });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
router.get('/world', (req, res) => proxy('api/world', res));
|
||||||
|
router.get('/actors', (req, res) => proxy('api/actors', res));
|
||||||
|
router.get('/characters', (req, res) => proxy('api/characters', res));
|
||||||
|
router.get('/items', (req, res) => proxy('api/items', res));
|
||||||
|
router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}/items`, res));
|
||||||
|
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
||||||
|
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
||||||
|
|
||||||
|
// Force import (Syndria98/dragonroll#77): the sidebar's "force import from Foundry"
|
||||||
|
// pulls the whole actor list or item directory of the world the bridge is showing
|
||||||
|
// right now. The documents go through the writers the module's own snapshot push
|
||||||
|
// uses, so a world document lands on the row it owns: what the campaign already has
|
||||||
|
// is written over, not imported a second time. Nothing is pruned here — only a full
|
||||||
|
// snapshot from the module sees the whole world, so dropping rows the world let go of
|
||||||
|
// stays that snapshot's job.
|
||||||
|
router.post('/import', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const kind = ['actors', 'items'].includes(req.body?.kind) ? req.body.kind : null;
|
||||||
|
if (!kind) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const campaign = await findOwnedCampaign(req.body.campaign, req.user.id);
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!campaign.foundryWorldId) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-not-linked' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// The bridge answers `{status, data, world}`: `data` holds the world's actors
|
||||||
|
// or its world-level items, in the shape the module published them in.
|
||||||
|
let snapshot;
|
||||||
|
try {
|
||||||
|
snapshot = await requestFoundry(`api/${kind}`);
|
||||||
|
} catch (err) {
|
||||||
|
if (err.code !== 'FOUNDRY_NOT_CONFIGURED') console.error(err);
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-unavailable' });
|
||||||
|
}
|
||||||
|
if (snapshot.status !== 200 || snapshot.data?.status !== 'ok' || !Array.isArray(snapshot.data.data)) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-unavailable' });
|
||||||
|
}
|
||||||
|
// The bridge keeps one world's snapshot at a time, so a campaign linked to
|
||||||
|
// another world must not be filled with it. A bridge that does not say whose
|
||||||
|
// world it holds is taken at its word: only a known mismatch stops the import.
|
||||||
|
if (snapshot.data.world?.id && snapshot.data.world.id !== campaign.foundryWorldId) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-world-mismatch' });
|
||||||
|
}
|
||||||
|
|
||||||
|
let imported = 0;
|
||||||
|
let updated = 0;
|
||||||
|
for (const source of snapshot.data.data) {
|
||||||
|
// An actor without a name, or a world document that is not gear, maps to
|
||||||
|
// nothing and is skipped exactly like a sync push skips it.
|
||||||
|
const mapping = kind === 'actors'
|
||||||
|
? await saveFoundryActor(campaign, source)
|
||||||
|
: await saveFoundryItem(campaign, source);
|
||||||
|
if (!mapping) continue;
|
||||||
|
if (mapping.created) imported += 1;
|
||||||
|
else updated += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
res.json({ status: 'ok', kind, imported, updated });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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;
|
||||||
127
backend/src/routes/item.js
Normal file
127
backend/src/routes/item.js
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const upload = require('../services/storage');
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const Item = require('../models/Item');
|
||||||
|
const Folder = require('../models/Folder');
|
||||||
|
|
||||||
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
|
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) => {
|
||||||
|
try {
|
||||||
|
const { campaign } = req.query;
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const items = await Item.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
|
res.json({ status: 'ok', items, folders: await itemFolders(campaign) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/create', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { name, campaign, category, rarity, quantity, weight, properties, description } = req.body;
|
||||||
|
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const item = await Item.create({
|
||||||
|
name: name.trim(), campaign, category, rarity,
|
||||||
|
quantity: quantity === '' || quantity === undefined ? 1 : Number(quantity),
|
||||||
|
weight: weight === '' || weight === undefined ? undefined : Number(weight),
|
||||||
|
properties, description
|
||||||
|
});
|
||||||
|
res.json({ status: 'ok', item });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/update', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, name, category, rarity, quantity, weight, properties, description, image, folder } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const item = await Item.findById(id);
|
||||||
|
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
// `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 (category !== undefined) item.category = category;
|
||||||
|
if (rarity !== undefined) item.rarity = rarity;
|
||||||
|
if (quantity !== undefined && quantity !== '') item.quantity = Number(quantity);
|
||||||
|
if (weight !== undefined && weight !== '') item.weight = Number(weight);
|
||||||
|
if (properties !== undefined) item.properties = properties;
|
||||||
|
if (description !== undefined) item.description = description;
|
||||||
|
if (image !== undefined) item.image = String(image);
|
||||||
|
|
||||||
|
await item.save();
|
||||||
|
res.json({ status: 'ok', item });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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) => {
|
||||||
|
try {
|
||||||
|
const { id } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const item = await Item.findById(id);
|
||||||
|
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
await item.deleteOne();
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
287
backend/src/routes/map.js
Normal file
287
backend/src/routes/map.js
Normal file
@@ -0,0 +1,287 @@
|
|||||||
|
const express = require('express');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const upload = require('../services/storage');
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
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) {
|
||||||
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
|
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.
|
||||||
|
function toNumber(value, fallback) {
|
||||||
|
if (value === undefined || value === null || value === '') return fallback;
|
||||||
|
const number = Number(value);
|
||||||
|
return Number.isFinite(number) ? number : fallback;
|
||||||
|
}
|
||||||
|
|
||||||
|
router.get('/list', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { campaign } = req.query;
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
|
res.json({ status: 'ok', maps, folders: await mapFolders(campaign) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/create', upload.single('image'), async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { name, campaign, gridSize, offsetX, offsetY, scale } = req.body;
|
||||||
|
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const map = await Map.create({
|
||||||
|
name: name.trim(), campaign,
|
||||||
|
image: req.file ? req.file.filename : '',
|
||||||
|
gridSize: toNumber(gridSize, 50),
|
||||||
|
offsetX: toNumber(offsetX, 0),
|
||||||
|
offsetY: toNumber(offsetY, 0),
|
||||||
|
scale: toNumber(scale, 5)
|
||||||
|
});
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/update', upload.single('image'), async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, name, gridSize, offsetX, offsetY, scale, folder } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const map = await Map.findById(id);
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
// `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 (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
|
||||||
|
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
|
||||||
|
if (offsetY !== undefined) map.offsetY = toNumber(offsetY, map.offsetY);
|
||||||
|
if (scale !== undefined) map.scale = toNumber(scale, map.scale);
|
||||||
|
if (req.file) map.image = req.file.filename;
|
||||||
|
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id } = req.body;
|
||||||
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
const map = await Map.findById(id);
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
await map.deleteOne();
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A pin is a note placed at a spot of the map, in image pixels, 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' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A wall is a segment of the map that blocks it like one does. The editor saves the whole set at
|
||||||
|
// once — drawing, moving, re-typing and taking off segments are all the same request — and a paired
|
||||||
|
// Foundry scene takes that set whole too, so the set is the contract on both sides. Endpoints are
|
||||||
|
// image pixels like a pin's, and a wall keeps the `_id` it is sent with when one of the current
|
||||||
|
// walls has it, so the markers on screen do not jump through a save. A segment with no length is
|
||||||
|
// dropped: it is a click that was not meant to draw anything.
|
||||||
|
function toStoredWall(source, currentWalls) {
|
||||||
|
const corners = [source?.x1, source?.y1, source?.x2, source?.y2];
|
||||||
|
if (!corners.every((value) => Number.isFinite(Number(value)))) return null;
|
||||||
|
|
||||||
|
const wall = {
|
||||||
|
x1: toCoordinate(source.x1),
|
||||||
|
y1: toCoordinate(source.y1),
|
||||||
|
x2: toCoordinate(source.x2),
|
||||||
|
y2: toCoordinate(source.y2),
|
||||||
|
// What the editor draws is a wall, not an opening: both stay out unless it says otherwise.
|
||||||
|
move: source.move !== false,
|
||||||
|
sight: source.sight !== false,
|
||||||
|
door: [1, 2].includes(Math.round(Number(source.door))) ? Math.round(Number(source.door)) : 0
|
||||||
|
};
|
||||||
|
if (wall.x1 === wall.x2 && wall.y1 === wall.y2) return null;
|
||||||
|
|
||||||
|
const id = String(source?._id ?? '').trim();
|
||||||
|
if (id && currentWalls.some((current) => String(current?._id) === id)) wall._id = id;
|
||||||
|
return wall;
|
||||||
|
}
|
||||||
|
|
||||||
|
router.post('/walls', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, walls } = req.body;
|
||||||
|
if (!id || !Array.isArray(walls)) 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' });
|
||||||
|
|
||||||
|
const currentWalls = Array.from(map.walls ?? []);
|
||||||
|
map.walls = walls.map((source) => toStoredWall(source, currentWalls)).filter(Boolean);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const router = express.Router();
|
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 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();
|
||||||
@@ -12,74 +14,164 @@ async function userOwnsCampaign(campaignId, userId) {
|
|||||||
router.get('/list', async (req, res) => {
|
router.get('/list', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { campaign } = req.query;
|
const { campaign } = req.query;
|
||||||
if (!campaign) return res.json({ status: "error", msg: "errors.missing-data" });
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const notes = await Note.find({ campaign })
|
// The note tree only: the folders of the actors, items and maps share this model
|
||||||
.select('_id title content date campaign')
|
// 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')
|
||||||
.sort({ date: -1 })
|
.sort({ date: -1 })
|
||||||
.lean();
|
.lean();
|
||||||
|
|
||||||
res.json({ status: "ok", notes });
|
const rootNotes = await Note.find({ campaign, folder: null })
|
||||||
|
.select('_id title content date color')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', folders, notes: rootNotes });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: "error", msg: "errors.internal" });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/subfolder/list', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { campaign, folder } = req.query;
|
||||||
|
if (!campaign || !folder) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
// Verify folder belongs to campaign
|
||||||
|
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
|
||||||
|
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const subfolders = await Folder.find({ campaign, parentFolder: folder, ...Folder.filterForTarget('note') })
|
||||||
|
.select('_id name date color')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
const notes = await Note.find({ campaign, folder: folder })
|
||||||
|
.select('_id title content date color')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', subfolders, notes });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Every note of the campaign, folders included, without their content: enough to offer a note
|
||||||
|
// picker and to label the pins other screens put on a map.
|
||||||
|
router.get('/all', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { campaign } = req.query;
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
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 } = req.body;
|
const { title, content, campaign, folder } = req.body;
|
||||||
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
if (!title || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
|
|
||||||
|
|
||||||
const newNote = new Note({
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
title,
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
content,
|
|
||||||
campaign
|
let effectiveFolder = null;
|
||||||
});
|
if (folder) {
|
||||||
|
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
|
||||||
|
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
effectiveFolder = folder;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newNote = new Note({ title, content, campaign, folder: effectiveFolder });
|
||||||
await newNote.save();
|
await newNote.save();
|
||||||
res.json({ status: "ok", note: newNote });
|
res.json({ status: 'ok', note: newNote });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: "error", msg: "errors.internal" });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
router.post('/update', async (req, res) => {
|
router.post('/update', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id, title, content } = req.body;
|
const { id, title, content, folder, color } = req.body;
|
||||||
const note = await Note.findById(id);
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
if (!note) return res.json({ status: "error", msg: "errors.notfound" });
|
|
||||||
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
|
|
||||||
if (!hasAccess) return res.json({ status: "error", msg: "unauthorized" });
|
|
||||||
|
|
||||||
if(title) note.title = title;
|
const note = await Note.findById(id);
|
||||||
note.content = content;
|
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
note.date = Date.now();
|
|
||||||
|
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
|
||||||
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
if (title !== undefined) note.title = title;
|
||||||
|
if (content !== undefined) note.content = content;
|
||||||
|
if (folder !== undefined) note.folder = folder;
|
||||||
|
if (color !== undefined) note.color = color;
|
||||||
await note.save();
|
await note.save();
|
||||||
res.json({ status: "ok", note });
|
res.json({ status: 'ok', note });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: "error", msg: "errors.internal" });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
router.post('/delete', async (req, res) => {
|
router.post('/delete', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id } = req.body;
|
const { id } = req.body;
|
||||||
const note = await Note.findById(id);
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
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" });
|
|
||||||
|
|
||||||
await note.remove();
|
const result = await Note.deleteOne({ _id: id });
|
||||||
res.json({ status: "ok" });
|
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' });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: "error", msg: "errors.internal" });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
209
backend/src/routes/service-link.js
Normal file
209
backend/src/routes/service-link.js
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
const crypto = require('node:crypto');
|
||||||
|
const express = require('express');
|
||||||
|
const jwt = require('jsonwebtoken');
|
||||||
|
const passport = require('passport');
|
||||||
|
const rateLimit = require('express-rate-limit');
|
||||||
|
const router = express.Router();
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const DiscordGuildLink = require('../models/DiscordGuildLink');
|
||||||
|
const secret = require('../services/keys').secret;
|
||||||
|
const serviceLinks = require('../services/service-links');
|
||||||
|
|
||||||
|
const linkRateLimit = rateLimit({ windowMs: 15 * 60 * 1000, max: 40 });
|
||||||
|
|
||||||
|
const GUILD_ID = /^\d{5,25}$/;
|
||||||
|
|
||||||
|
// What the sign-up screen shows about the request behind a code.
|
||||||
|
function publicRequest(request) {
|
||||||
|
return {
|
||||||
|
service: request.service,
|
||||||
|
serviceName: serviceLinks.serviceName(request.service),
|
||||||
|
targetName: request.targetName,
|
||||||
|
targetUser: request.targetUser,
|
||||||
|
system: request.targetMeta?.system || '',
|
||||||
|
expiresAt: request.expiresAt
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// A session for a service that keeps working once the browser which authorised
|
||||||
|
// it is gone: Obsidian gets the same kind of session signing in gives, so its
|
||||||
|
// notes keep travelling over the routes they always used.
|
||||||
|
function userSession(user) {
|
||||||
|
const payload = {
|
||||||
|
_id: user._id,
|
||||||
|
username: user.username,
|
||||||
|
name: user.name,
|
||||||
|
email: user.email,
|
||||||
|
admin: user.admin,
|
||||||
|
settings: user.settings
|
||||||
|
};
|
||||||
|
return jwt.sign(payload, secret, { expiresIn: 172800 });
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Foundry world tells Dragonroll who it is when it asks for its link, so the
|
||||||
|
// user only has to say which campaign the world may work on.
|
||||||
|
async function completeFoundryLink(campaign, request) {
|
||||||
|
const linkedElsewhere = await Campaign.findOne({
|
||||||
|
foundryWorldId: request.targetId,
|
||||||
|
_id: { $ne: campaign._id }
|
||||||
|
}).select('_id');
|
||||||
|
if (linkedElsewhere) return { msg: 'foundry.errors.world-already-linked' };
|
||||||
|
|
||||||
|
campaign.foundryWorldId = request.targetId;
|
||||||
|
campaign.foundryWorldTitle = request.targetName;
|
||||||
|
campaign.foundrySystem = request.targetMeta?.system || '';
|
||||||
|
|
||||||
|
const settings = campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {};
|
||||||
|
const integrations = settings.integrations && typeof settings.integrations === 'object' ? settings.integrations : {};
|
||||||
|
const foundryUrl = request.targetMeta?.url || '';
|
||||||
|
if (foundryUrl && !integrations.foundryUrl) {
|
||||||
|
campaign.settings = { ...settings, integrations: { ...integrations, foundryUrl } };
|
||||||
|
}
|
||||||
|
|
||||||
|
const syncToken = crypto.randomBytes(32).toString('base64url');
|
||||||
|
campaign.foundrySyncTokenHash = serviceLinks.codeHash(syncToken);
|
||||||
|
await campaign.save();
|
||||||
|
|
||||||
|
const bridgeUrl = process.env.FOUNDRY_API_CLIENT_URL || process.env.FOUNDRY_API_URL;
|
||||||
|
const pushToken = process.env.FOUNDRY_API_PUSH_TOKEN;
|
||||||
|
return {
|
||||||
|
credentials: {
|
||||||
|
syncToken,
|
||||||
|
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Discord account behind the request is the one the bot answers to; a new
|
||||||
|
// authorization takes the server over from whoever held it before.
|
||||||
|
async function completeDiscordLink(campaign, request, user) {
|
||||||
|
await Campaign.updateMany(
|
||||||
|
{ discordGuildId: request.targetId, createdBy: { $ne: user.id } },
|
||||||
|
{ $unset: { discordGuildId: 1 } }
|
||||||
|
);
|
||||||
|
|
||||||
|
await DiscordGuildLink.findOneAndUpdate({ guildId: request.targetId }, {
|
||||||
|
$set: {
|
||||||
|
discordUserId: request.targetMeta?.userId || request.targetId,
|
||||||
|
dragonrollUser: user.id,
|
||||||
|
connectedAt: new Date()
|
||||||
|
}
|
||||||
|
}, { new: true, upsert: true, setDefaultsOnInsert: true });
|
||||||
|
|
||||||
|
campaign.discordGuildId = request.targetId;
|
||||||
|
await campaign.save();
|
||||||
|
}
|
||||||
|
|
||||||
|
// A service asks for a sign-up link and shows it to whoever is sitting in front
|
||||||
|
// of it. Nothing is linked until a Dragonroll user opens that link, signs in and
|
||||||
|
// picks one of their campaigns.
|
||||||
|
router.post('/start', linkRateLimit, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const service = String(req.body.service || '').trim();
|
||||||
|
if (!serviceLinks.isService(service)) return res.json({ status: 'error', msg: 'link.errors.unknown-service' });
|
||||||
|
|
||||||
|
// A service that can prove who it is gets its link checked: a Discord
|
||||||
|
// server is claimed by whoever runs the bot, not by whoever knows its id.
|
||||||
|
if (serviceLinks.isBotOnly(service) && !serviceLinks.isDiscordBot(req)) {
|
||||||
|
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const target = serviceLinks.readTarget(req.body);
|
||||||
|
if (!target.targetId) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
if (service === 'discord' && (!GUILD_ID.test(target.targetId) || !target.targetName || !target.targetUser)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const link = await serviceLinks.startServiceLink(service, target);
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
res.json({ status: 'ok', service, code: link.code, linkUrl: link.url, expiresAt: link.expiresAt });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// What a sign-up link is about, so the screen can name the world, Discord server
|
||||||
|
// or vault that is waiting, and the person who asked.
|
||||||
|
router.post('/details', async (req, res) => {
|
||||||
|
try {
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
|
||||||
|
if (!request || serviceLinks.linkIsExpired(request)) {
|
||||||
|
return res.json({ status: 'error', msg: 'link.errors.expired' });
|
||||||
|
}
|
||||||
|
|
||||||
|
res.json({ status: 'ok', ...publicRequest(request) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The user who signs in through a link owns the campaigns listed there, so
|
||||||
|
// picking one of them is the whole authorization.
|
||||||
|
router.post('/complete', passport.authenticate('jwt', { session: false }), async (req, res) => {
|
||||||
|
try {
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
|
||||||
|
if (!request || serviceLinks.linkIsExpired(request)) {
|
||||||
|
return res.json({ status: 'error', msg: 'link.errors.expired' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (request.service === 'discord' && campaign.discordGuildId && campaign.discordGuildId !== request.targetId) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.campaign-already-linked' });
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.service === 'foundry') {
|
||||||
|
const linked = await completeFoundryLink(campaign, request);
|
||||||
|
if (linked.msg) return res.json({ status: 'error', msg: linked.msg });
|
||||||
|
await serviceLinks.completeServiceLink(request, campaign, req.user, linked.credentials);
|
||||||
|
} else if (request.service === 'discord') {
|
||||||
|
await completeDiscordLink(campaign, request, req.user);
|
||||||
|
await serviceLinks.completeServiceLink(request, campaign, req.user);
|
||||||
|
} else {
|
||||||
|
await serviceLinks.completeServiceLink(request, campaign, req.user, { token: userSession(req.user) });
|
||||||
|
}
|
||||||
|
|
||||||
|
res.json({ status: 'ok', service: request.service, campaign: { id: campaign.id, name: campaign.name } });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
if (err.code === 11000) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Where a link stands, and what the service that asked for it gets out of it.
|
||||||
|
// A credential is delivered once: a service that loses it asks for a new link.
|
||||||
|
router.post('/pickup', async (req, res) => {
|
||||||
|
try {
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
|
||||||
|
if (!request || serviceLinks.linkIsExpired(request)) {
|
||||||
|
return res.json({ status: 'ok', state: 'expired' });
|
||||||
|
}
|
||||||
|
if (request.state !== 'linked') {
|
||||||
|
return res.json({ status: 'ok', state: request.state, campaign: null });
|
||||||
|
}
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: request.campaign }).select('_id name').lean();
|
||||||
|
const credentials = await serviceLinks.takeServiceLinkCredentials(request);
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
state: 'linked',
|
||||||
|
service: request.service,
|
||||||
|
campaign: campaign ? { id: String(campaign._id), name: campaign.name } : null,
|
||||||
|
syncToken: credentials?.syncToken || '',
|
||||||
|
bridgeConfig: credentials?.bridgeConfig || null,
|
||||||
|
token: credentials?.token || ''
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = router;
|
||||||
@@ -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;
|
||||||
210
backend/src/services/actor-foundry.js
Normal file
210
backend/src/services/actor-foundry.js
Normal file
@@ -0,0 +1,210 @@
|
|||||||
|
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
||||||
|
const { isFoundryGearType } = require('./item-foundry');
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Skills, saving throws, tools, languages and coins (Syndria98/dragonroll#83) ---
|
||||||
|
|
||||||
|
// The eighteen skills a 5e character has, as the system keys them and as Dragonroll
|
||||||
|
// names them. The short keys mean nothing outside Foundry, and Dragonroll's sheet holds
|
||||||
|
// the names it shows a user.
|
||||||
|
const FOUNDRY_SKILLS = {
|
||||||
|
acr: 'acrobatics', ani: 'animalHandling', arc: 'arcana', ath: 'athletics', dec: 'deception',
|
||||||
|
his: 'history', ins: 'insight', itm: 'intimidation', inv: 'investigation', med: 'medicine',
|
||||||
|
nat: 'nature', prc: 'perception', perf: 'performance', prs: 'persuasion', rel: 'religion',
|
||||||
|
sle: 'sleightOfHand', stl: 'stealth', sur: 'survival'
|
||||||
|
};
|
||||||
|
const ABILITIES = ['str', 'dex', 'con', 'int', 'wis', 'cha'];
|
||||||
|
const CURRENCIES = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||||
|
|
||||||
|
// Whether one of the system's proficiency fields says the character has that
|
||||||
|
// proficiency. The system has held it several ways across its releases — a boolean, a
|
||||||
|
// number of proficiency steps, a list of proficiency modes ('prof', 'exp'), or one of
|
||||||
|
// those under `value`, `proficient` or `prof` — and worlds run different releases of
|
||||||
|
// it. Anything above nothing counts as proficient.
|
||||||
|
function isProficient(value, depth = 0) {
|
||||||
|
if (value === undefined || value === null || depth > 3) return false;
|
||||||
|
if (typeof value === 'boolean') return value;
|
||||||
|
if (typeof value === 'number') return value > 0;
|
||||||
|
if (typeof value === 'string') {
|
||||||
|
const text = value.trim();
|
||||||
|
if (!text) return false;
|
||||||
|
const number = Number(text);
|
||||||
|
return Number.isFinite(number) ? number > 0 : text.toLowerCase() !== 'none';
|
||||||
|
}
|
||||||
|
if (Array.isArray(value)) return value.some((entry) => isProficient(entry, depth + 1));
|
||||||
|
return ['value', 'proficient', 'prof'].some((key) => isProficient(value[key], depth + 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A toggled map (skill name or ability → proficient) from whatever the actor lists.
|
||||||
|
// `null` says the actor says nothing about them at all, which is what keeps a live
|
||||||
|
// Foundry edit from clearing the toggles the campaign set by hand.
|
||||||
|
function toggleMap(sources) {
|
||||||
|
const toggled = {};
|
||||||
|
for (const [name, value] of Object.entries(sources)) {
|
||||||
|
if (value !== undefined) toggled[name] = isProficient(value);
|
||||||
|
}
|
||||||
|
return Object.keys(toggled).length ? toggled : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundrySkills(system) {
|
||||||
|
const skills = system.skills && typeof system.skills === 'object' ? system.skills : {};
|
||||||
|
return toggleMap(Object.fromEntries(Object.entries(FOUNDRY_SKILLS)
|
||||||
|
.map(([key, name]) => [name, skills[key]])));
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundrySavingThrows(system) {
|
||||||
|
const saves = system.saves && typeof system.saves === 'object' ? system.saves : {};
|
||||||
|
return toggleMap(Object.fromEntries(ABILITIES.map((key) => [
|
||||||
|
key,
|
||||||
|
system.savingThrows?.[key] ?? system.abilities?.[key]?.save ?? saves[key]
|
||||||
|
])));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tools and languages: the module sends the labels its own CONFIG holds, because a
|
||||||
|
// world's proficiency lists are keys — and, since the third system release, language
|
||||||
|
// documents — that mean nothing outside Foundry. Without them the keys are the best
|
||||||
|
// there is to name a proficiency with, and a bare Foundry document id is worse than
|
||||||
|
// nothing at all. `null` says the actor says nothing about the kind, `[]` that it has
|
||||||
|
// none of it. Dragonroll names its lists in full; the world keeps its tools under
|
||||||
|
// `system.traits.tool` and its languages under `system.traits.languages`.
|
||||||
|
const TRAIT_FIELDS = { tools: 'tool', languages: 'languages' };
|
||||||
|
|
||||||
|
function foundryTraitNames(actor, kind) {
|
||||||
|
const labels = actor.dragonroll?.[kind];
|
||||||
|
if (Array.isArray(labels)) {
|
||||||
|
return [...new Set(labels.map((label) => asText(label).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind];
|
||||||
|
if (!trait || typeof trait !== 'object') return null;
|
||||||
|
const names = [
|
||||||
|
...stringList(trait.value),
|
||||||
|
...asText(trait.custom).split(',').map((name) => name.trim())
|
||||||
|
].filter((name) => name && !looksLikeFoundryId(name));
|
||||||
|
return [...new Set(names)];
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryCurrency(system) {
|
||||||
|
const coins = system.currency;
|
||||||
|
if (!coins || typeof coins !== 'object') return null;
|
||||||
|
return Object.fromEntries(CURRENCIES.map((key) => [key, Math.max(0, numberOr(coins[key], 0))]));
|
||||||
|
}
|
||||||
|
|
||||||
|
// The character's traits as the world writes them: the free-text details field some
|
||||||
|
// system releases keep, or its trait items, which are how a monster's traits and a
|
||||||
|
// character's racial and class features are written. `undefined` says the world holds
|
||||||
|
// no traits to show.
|
||||||
|
function foundryTraits(source, items) {
|
||||||
|
const text = plainText(source.system?.details?.trait);
|
||||||
|
if (text) return text;
|
||||||
|
const features = items
|
||||||
|
.filter((item) => item.type === 'feat' && stringList(item.system?.featType?.value ?? item.system?.featType)
|
||||||
|
.some((type) => asText(type).toLowerCase().startsWith('tr')))
|
||||||
|
.map((item) => {
|
||||||
|
const name = asText(item.name).trim();
|
||||||
|
const description = plainText(item.system?.description?.value ?? item.system?.description);
|
||||||
|
return name ? `${name}\n${description}`.trim() : '';
|
||||||
|
})
|
||||||
|
.filter(Boolean);
|
||||||
|
return features.length ? features.join('\n\n') : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryActorToCharacter(foundryActor) {
|
||||||
|
const system = foundryActor.system || {};
|
||||||
|
const details = system.details || {};
|
||||||
|
const abilities = system.abilities || {};
|
||||||
|
const attributes = system.attributes || {};
|
||||||
|
const movement = attributes.movement || {};
|
||||||
|
const items = Array.isArray(foundryActor.items) ? foundryActor.items : [];
|
||||||
|
const classItem = items.find((item) => item.type === 'class');
|
||||||
|
const subclassItem = items.find((item) => item.type === 'subclass');
|
||||||
|
const backgroundItem = items.find((item) => item.type === 'background');
|
||||||
|
const traits = system.traits || {};
|
||||||
|
const savedDragonrollFields = foundryActor.flags?.['dragonroll-foundry'] || {};
|
||||||
|
const savedDragonrollType = savedDragonrollFields.actorType;
|
||||||
|
const foundryProficiencies = [
|
||||||
|
...stringList(traits.languages?.value),
|
||||||
|
...stringList(traits.armor?.value),
|
||||||
|
...stringList(traits.weapon?.value),
|
||||||
|
...stringList(traits.tool?.value)
|
||||||
|
].join(', ');
|
||||||
|
|
||||||
|
const fields = {
|
||||||
|
name: asText(foundryActor.name).trim(),
|
||||||
|
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
||||||
|
? savedDragonrollType
|
||||||
|
: (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'),
|
||||||
|
species: detailsName(details.race || details.species, items),
|
||||||
|
className: detailsName(details.class, items) || asText(classItem?.name),
|
||||||
|
subclass: detailsName(details.subclass, items) || asText(subclassItem?.name),
|
||||||
|
level: numberOr(details.level ?? classItem?.system?.levels, 1),
|
||||||
|
background: detailsName(details.background, items) || asText(backgroundItem?.name),
|
||||||
|
challengeRating: String(details.cr ?? ''),
|
||||||
|
description: plainText(details.biography?.value || details.biography),
|
||||||
|
image: asText(foundryActor.img || foundryActor.image),
|
||||||
|
abilityScores: Object.fromEntries(ABILITIES.map((key) => [
|
||||||
|
key,
|
||||||
|
numberOr(abilities[key]?.value, 10)
|
||||||
|
])),
|
||||||
|
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
||||||
|
speed: numberOr(movement.walk ?? movement.value, 30),
|
||||||
|
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
||||||
|
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
||||||
|
// is a trait — its tab shows it — and a race is the species; standing them in the
|
||||||
|
// inventory next to the longswords is how traits and items got mixed up.
|
||||||
|
inventory: items
|
||||||
|
.filter((item) => isFoundryGearType(item.type))
|
||||||
|
.map((item) => ({
|
||||||
|
name: asText(item.name).trim(),
|
||||||
|
quantity: numberOr(item.system?.quantity, 1),
|
||||||
|
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0),
|
||||||
|
icon: asText(item.img).trim()
|
||||||
|
}))
|
||||||
|
.filter((item) => item.name),
|
||||||
|
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
|
||||||
|
};
|
||||||
|
|
||||||
|
// What the world says about each of these, when it says anything: leaving a field
|
||||||
|
// out of the character is what keeps a live Foundry edit from clearing what the
|
||||||
|
// campaign toggled or wrote for it. Traits lead from the world when it has them, the
|
||||||
|
// way the proficiencies do; the text the module carries back on its flag is what the
|
||||||
|
// tab shows for an actor the world says nothing about.
|
||||||
|
const skills = foundrySkills(system);
|
||||||
|
if (skills) fields.skills = skills;
|
||||||
|
const savingThrows = foundrySavingThrows(system);
|
||||||
|
if (savingThrows) fields.savingThrows = savingThrows;
|
||||||
|
const tools = foundryTraitNames(foundryActor, 'tools');
|
||||||
|
if (tools) fields.tools = tools;
|
||||||
|
const languages = foundryTraitNames(foundryActor, 'languages');
|
||||||
|
if (languages) fields.languages = languages;
|
||||||
|
const currency = foundryCurrency(system);
|
||||||
|
if (currency) fields.currency = currency;
|
||||||
|
const worldTraits = foundryTraits(foundryActor, items);
|
||||||
|
const campaignTraits = asText(savedDragonrollFields.traits);
|
||||||
|
if (worldTraits || campaignTraits) fields.traits = worldTraits || campaignTraits;
|
||||||
|
|
||||||
|
return fields;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { foundryActorToCharacter };
|
||||||
32
backend/src/services/foundry-fields.js
Normal file
32
backend/src/services/foundry-fields.js
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
// Small helpers shared by the Foundry -> Dragonroll document mappers
|
||||||
|
// (services/actor-foundry.js and services/item-foundry.js).
|
||||||
|
|
||||||
|
function numberOr(value, fallback) {
|
||||||
|
const number = Number(value);
|
||||||
|
return Number.isFinite(number) ? number : fallback;
|
||||||
|
}
|
||||||
|
|
||||||
|
function asText(value) {
|
||||||
|
return typeof value === 'string' ? value : '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function plainText(value) {
|
||||||
|
return asText(value)
|
||||||
|
.replace(/<br\s*\/?>/gi, '\n')
|
||||||
|
.replace(/<\/p\s*>/gi, '\n')
|
||||||
|
.replace(/<[^>]*>/g, ' ')
|
||||||
|
.replace(/ /gi, ' ')
|
||||||
|
.replace(/&/gi, '&')
|
||||||
|
.replace(/</gi, '<')
|
||||||
|
.replace(/>/gi, '>')
|
||||||
|
.replace(/\s+\n/g, '\n')
|
||||||
|
.trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
function stringList(value) {
|
||||||
|
if (Array.isArray(value)) return value.map(asText).filter(Boolean);
|
||||||
|
if (typeof value === 'string') return [value];
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { numberOr, asText, plainText, stringList };
|
||||||
110
backend/src/services/foundry-icons.js
Normal file
110
backend/src/services/foundry-icons.js
Normal 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
|
||||||
|
};
|
||||||
40
backend/src/services/foundry.js
Normal file
40
backend/src/services/foundry.js
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
async function requestFoundry(path) {
|
||||||
|
// The bridge a campaign's icon and world reads go to is the very one that
|
||||||
|
// world already pushes its snapshot to. It is often configured under
|
||||||
|
// FOUNDRY_API_CLIENT_URL alone — the address the Foundry client reaches —
|
||||||
|
// while FOUNDRY_API_URL is the optional private one the backend prefers.
|
||||||
|
// Falling back to it keeps a connected, syncing world's reads working
|
||||||
|
// instead of reporting its bridge as unset (Syndria98/dragonroll#74).
|
||||||
|
const baseUrl = process.env.FOUNDRY_API_URL || process.env.FOUNDRY_API_CLIENT_URL;
|
||||||
|
const token = process.env.FOUNDRY_API_TOKEN;
|
||||||
|
|
||||||
|
if (!baseUrl || !token) {
|
||||||
|
const error = new Error('Foundry API is not configured.');
|
||||||
|
error.code = 'FOUNDRY_NOT_CONFIGURED';
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalizedBase = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;
|
||||||
|
const url = new URL(path.replace(/^\/+/, ''), normalizedBase);
|
||||||
|
const response = await fetch(url, {
|
||||||
|
headers: {
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'Authorization': `Bearer ${token}`
|
||||||
|
},
|
||||||
|
signal: AbortSignal.timeout(10000)
|
||||||
|
});
|
||||||
|
|
||||||
|
const body = await response.text();
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = JSON.parse(body);
|
||||||
|
} catch {
|
||||||
|
const error = new Error('Foundry API returned an invalid response.');
|
||||||
|
error.code = 'FOUNDRY_INVALID_RESPONSE';
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { status: response.status, data };
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { requestFoundry };
|
||||||
118
backend/src/services/item-foundry.js
Normal file
118
backend/src/services/item-foundry.js
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
||||||
|
|
||||||
|
// Foundry item types that are gear, mapped to a Dragonroll Item category.
|
||||||
|
// `equipment` is resolved into armor / shield from its armor type.
|
||||||
|
const CATEGORY_BY_FOUNDRY_TYPE = {
|
||||||
|
weapon: 'weapon',
|
||||||
|
equipment: 'equipment',
|
||||||
|
consumable: 'consumable',
|
||||||
|
tool: 'tool',
|
||||||
|
container: 'adventuring-gear',
|
||||||
|
loot: 'treasure',
|
||||||
|
// Item types from older D&D 5e system releases.
|
||||||
|
ammo: 'weapon',
|
||||||
|
potion: 'consumable',
|
||||||
|
poison: 'consumable',
|
||||||
|
scroll: 'consumable',
|
||||||
|
trinket: 'magic-item',
|
||||||
|
backpack: 'adventuring-gear'
|
||||||
|
};
|
||||||
|
|
||||||
|
// Foundry item types that are not gear: they never become Dragonroll items.
|
||||||
|
const NON_GEAR_FOUNDRY_TYPES = new Set([
|
||||||
|
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
|
||||||
|
]);
|
||||||
|
|
||||||
|
// Whether a Foundry document of this type is gear: something a character carries. Traits,
|
||||||
|
// species, spells and the rest are documents of the world that mean something else on a
|
||||||
|
// Dragonroll sheet — a feat is a trait and a race is a species — so they stand in the
|
||||||
|
// character's own fields, never in its inventory (Syndria98/dragonroll#89).
|
||||||
|
function isFoundryGearType(type) {
|
||||||
|
return !NON_GEAR_FOUNDRY_TYPES.has(asText(type).toLowerCase().trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Item categories the Dragonroll Item model accepts.
|
||||||
|
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
||||||
|
|
||||||
|
const RARITY_BY_FOUNDRY_VALUE = {
|
||||||
|
common: 'common',
|
||||||
|
uncommon: 'uncommon',
|
||||||
|
rare: 'rare',
|
||||||
|
'very-rare': 'very-rare',
|
||||||
|
veryrare: 'very-rare',
|
||||||
|
'very rare': 'very-rare',
|
||||||
|
legendary: 'legendary',
|
||||||
|
artifact: 'artifact'
|
||||||
|
};
|
||||||
|
|
||||||
|
// Fallback labels for weapon properties when the Foundry client did not send the
|
||||||
|
// ones from its own CONFIG (see serializeFoundryItem in the module).
|
||||||
|
const WEAPON_PROPERTY_LABELS = {
|
||||||
|
amm: 'ammunition',
|
||||||
|
fin: 'finesse',
|
||||||
|
foc: 'focus',
|
||||||
|
hvy: 'heavy',
|
||||||
|
lrp: 'long range',
|
||||||
|
lod: 'loading',
|
||||||
|
nid: 'noisy',
|
||||||
|
rch: 'reach',
|
||||||
|
rel: 'reload',
|
||||||
|
ret: 'retractable',
|
||||||
|
slo: 'slow firing',
|
||||||
|
thr: 'thrown',
|
||||||
|
thv: 'thrown',
|
||||||
|
two: 'two-handed',
|
||||||
|
ver: 'versatile'
|
||||||
|
};
|
||||||
|
|
||||||
|
function foundryItemRarity(foundryItem) {
|
||||||
|
const rarity = asText(foundryItem.system?.rarity).toLowerCase().trim();
|
||||||
|
return RARITY_BY_FOUNDRY_VALUE[rarity] || 'common';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns null for Foundry documents that are not gear so the sync can skip them.
|
||||||
|
function foundryItemCategory(foundryItem, rarity) {
|
||||||
|
const type = asText(foundryItem.type).toLowerCase().trim();
|
||||||
|
if (NON_GEAR_FOUNDRY_TYPES.has(type)) return null;
|
||||||
|
if (type === 'equipment') {
|
||||||
|
return asText(foundryItem.system?.armor?.type).toLowerCase() === 'shield' ? 'shield' : 'armor';
|
||||||
|
}
|
||||||
|
|
||||||
|
const category = CATEGORY_BY_FOUNDRY_TYPE[type];
|
||||||
|
if (CATEGORIES.includes(category)) return category;
|
||||||
|
// Systems the module does not know about still get a usable Dragonroll item.
|
||||||
|
return rarity === 'common' ? 'other' : 'magic-item';
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryItemProperties(foundryItem) {
|
||||||
|
const provided = stringList(foundryItem.dragonroll?.properties);
|
||||||
|
if (provided.length) return provided.join(', ');
|
||||||
|
|
||||||
|
const properties = stringList(foundryItem.system?.properties?.value ?? foundryItem.system?.properties);
|
||||||
|
return properties.map((property) => {
|
||||||
|
const key = property.toLowerCase();
|
||||||
|
return Object.hasOwn(WEAPON_PROPERTY_LABELS, key) ? WEAPON_PROPERTY_LABELS[key] : property;
|
||||||
|
}).join(', ');
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryItemToItemData(foundryItem) {
|
||||||
|
const system = foundryItem.system || {};
|
||||||
|
const name = asText(foundryItem.name).trim();
|
||||||
|
const rarity = foundryItemRarity(foundryItem);
|
||||||
|
const category = foundryItemCategory(foundryItem, rarity);
|
||||||
|
if (!name || !category) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
name,
|
||||||
|
category,
|
||||||
|
rarity,
|
||||||
|
quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))),
|
||||||
|
weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)),
|
||||||
|
properties: foundryItemProperties(foundryItem),
|
||||||
|
description: plainText(system.description?.value ?? system.description),
|
||||||
|
// The module sends Foundry's icon as an absolute URL, like actors do.
|
||||||
|
image: asText(foundryItem.img || foundryItem.image)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { foundryItemToItemData, isFoundryGearType };
|
||||||
254
backend/src/services/service-links.js
Normal file
254
backend/src/services/service-links.js
Normal file
@@ -0,0 +1,254 @@
|
|||||||
|
const crypto = require('node:crypto');
|
||||||
|
const jwt = require('jsonwebtoken');
|
||||||
|
|
||||||
|
const ServiceLinkRequest = require('../models/ServiceLinkRequest');
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
const keys = require('./keys');
|
||||||
|
|
||||||
|
// How long a sign-up link waits for somebody to open it.
|
||||||
|
const LINK_TTL_MS = 10 * 60 * 1000;
|
||||||
|
// How long the Discord bot can still confirm an authorization it was away for.
|
||||||
|
const NOTIFICATION_WINDOW_MS = 15 * 60 * 1000;
|
||||||
|
// The token the Obsidian plugin gets back is its long-lived credential: a plugin cannot ask
|
||||||
|
// somebody to open the sign-up link again every 48 hours. It carries the id of the link so that
|
||||||
|
// revoking the link works right away — see services/passport.js.
|
||||||
|
const OBSIDIAN_TOKEN_TTL = '365d';
|
||||||
|
|
||||||
|
// Every service that connects to a campaign does it the same way: it asks the
|
||||||
|
// backend for a sign-up link, shows it to the person sitting in front of it,
|
||||||
|
// and picks its credential up once a Dragonroll user has signed in through that
|
||||||
|
// link and chosen a campaign. `botOnly` services are the ones that can prove
|
||||||
|
// who they are to the backend; the others can only be trusted with their own
|
||||||
|
// link, which is why what they get from a link is decided by the user.
|
||||||
|
const SERVICES = {
|
||||||
|
foundry: { name: 'Foundry VTT' },
|
||||||
|
discord: { name: 'Discord', botOnly: true },
|
||||||
|
obsidian: { name: 'Obsidian' },
|
||||||
|
};
|
||||||
|
|
||||||
|
function isService(value) {
|
||||||
|
return Object.prototype.hasOwnProperty.call(SERVICES, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function serviceName(service) {
|
||||||
|
return SERVICES[service]?.name || service;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isBotOnly(service) {
|
||||||
|
return SERVICES[service]?.botOnly === true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function codeHash(code) {
|
||||||
|
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
|
||||||
|
}
|
||||||
|
|
||||||
|
function newLinkCode() {
|
||||||
|
return crypto.randomBytes(32).toString('base64url');
|
||||||
|
}
|
||||||
|
|
||||||
|
function frontendBaseUrl() {
|
||||||
|
return (process.env.DRAGONROLL_FRONTEND_URL || 'http://localhost:3000').trim().replace(/\/+$/, '');
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sign-up link a service shows: it opens the Dragonroll page where somebody
|
||||||
|
// signs in and picks the campaign. The code travels in the fragment, so the
|
||||||
|
// browser never sends it to the server.
|
||||||
|
function signUpLinkUrl(service, code) {
|
||||||
|
return `${frontendBaseUrl()}/link/authorize?service=${encodeURIComponent(service)}#code=${encodeURIComponent(code)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The bot talks to the backend with a shared secret instead of a login, so a
|
||||||
|
// Discord server cannot be claimed by somebody who merely knows its id.
|
||||||
|
function isDiscordBot(req) {
|
||||||
|
const configuredSecret = process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '';
|
||||||
|
const suppliedSecret = req.get('x-dragonroll-discord-bot-secret') || '';
|
||||||
|
const expected = Buffer.from(configuredSecret);
|
||||||
|
const supplied = Buffer.from(suppliedSecret);
|
||||||
|
|
||||||
|
return !!expected.length
|
||||||
|
&& expected.length === supplied.length
|
||||||
|
&& crypto.timingSafeEqual(expected, supplied);
|
||||||
|
}
|
||||||
|
|
||||||
|
function requireDiscordBot(req, res, next) {
|
||||||
|
if (!isDiscordBot(req)) {
|
||||||
|
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
|
||||||
|
}
|
||||||
|
return next();
|
||||||
|
}
|
||||||
|
|
||||||
|
function readText(value, max) {
|
||||||
|
return typeof value === 'string' ? value.trim().slice(0, max) : '';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Whatever else a service says about itself: the Foundry system it runs, the
|
||||||
|
// Discord user id behind the person who asked... Values are kept short and
|
||||||
|
// plain, because they come from a service and end up shown to a user.
|
||||||
|
function readMeta(source) {
|
||||||
|
const meta = {};
|
||||||
|
for (const [key, value] of Object.entries(source).slice(0, MAX_META_ENTRIES)) {
|
||||||
|
if (value === null || value === undefined || typeof value === 'boolean') {
|
||||||
|
if (typeof value === 'boolean') meta[key] = value;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (typeof value !== 'string' && typeof value !== 'number') continue;
|
||||||
|
meta[key] = String(value).trim().slice(0, MAX_META_VALUE_LENGTH);
|
||||||
|
}
|
||||||
|
return meta;
|
||||||
|
}
|
||||||
|
|
||||||
|
// How a service describes itself: which world/server/vault is asking, on whose
|
||||||
|
// behalf, and the little that goes with it.
|
||||||
|
function readTarget(body) {
|
||||||
|
const source = body?.target && typeof body.target === 'object' ? body.target : {};
|
||||||
|
|
||||||
|
const target = {
|
||||||
|
targetId: readText(source.id, 120),
|
||||||
|
targetName: readText(source.name, 200),
|
||||||
|
targetUser: readText(source.user, 120),
|
||||||
|
targetMeta: source.meta && typeof source.meta === 'object' && !Array.isArray(source.meta)
|
||||||
|
? readMeta(source.meta)
|
||||||
|
: {}
|
||||||
|
};
|
||||||
|
|
||||||
|
if (typeof target.targetMeta.url === 'string') {
|
||||||
|
try {
|
||||||
|
const url = new URL(target.targetMeta.url);
|
||||||
|
target.targetMeta.url = url.protocol === 'http:' || url.protocol === 'https:' ? url.origin : '';
|
||||||
|
} catch {
|
||||||
|
target.targetMeta.url = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return target;
|
||||||
|
}
|
||||||
|
|
||||||
|
function linkIsExpired(request) {
|
||||||
|
return request?.state === 'pending' && (!request.expiresAt || request.expiresAt <= new Date());
|
||||||
|
}
|
||||||
|
|
||||||
|
// A service asking again reuses its own row: one world, one Discord server and
|
||||||
|
// one vault each have a single link, and asking for it replaces the last one.
|
||||||
|
async function startServiceLink(service, target) {
|
||||||
|
const code = newLinkCode();
|
||||||
|
const expiresAt = new Date(Date.now() + LINK_TTL_MS);
|
||||||
|
const request = await ServiceLinkRequest.findOneAndUpdate(
|
||||||
|
{ service: service, targetId: target.targetId },
|
||||||
|
{
|
||||||
|
$set: {
|
||||||
|
service: service,
|
||||||
|
targetId: target.targetId,
|
||||||
|
targetName: target.targetName,
|
||||||
|
targetUser: target.targetUser,
|
||||||
|
targetMeta: target.targetMeta,
|
||||||
|
codeHash: codeHash(code),
|
||||||
|
state: 'pending',
|
||||||
|
expiresAt: expiresAt
|
||||||
|
},
|
||||||
|
$unset: {
|
||||||
|
campaign: 1,
|
||||||
|
dragonrollUser: 1,
|
||||||
|
credentials: 1,
|
||||||
|
linkedAt: 1,
|
||||||
|
pickedUpAt: 1,
|
||||||
|
notifiedAt: 1
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{ new: true, upsert: true, setDefaultsOnInsert: true }
|
||||||
|
);
|
||||||
|
|
||||||
|
return { request, code, url: signUpLinkUrl(service, code), expiresAt };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function findServiceLinkByCode(code) {
|
||||||
|
if (!code) return null;
|
||||||
|
return ServiceLinkRequest.findOne({ codeHash: codeHash(code) }).select('+credentials').lean();
|
||||||
|
}
|
||||||
|
|
||||||
|
// The credential that belongs to a link is handed over once and then dropped:
|
||||||
|
// whoever loses it starts the link again from the service, which is where they
|
||||||
|
// got the link from in the first place.
|
||||||
|
async function takeServiceLinkCredentials(request) {
|
||||||
|
const credentials = request?.credentials || null;
|
||||||
|
if (!credentials) return null;
|
||||||
|
|
||||||
|
await ServiceLinkRequest.updateOne(
|
||||||
|
{ _id: request._id },
|
||||||
|
{ $set: { pickedUpAt: new Date() }, $unset: { credentials: 1 } }
|
||||||
|
);
|
||||||
|
return credentials;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The user who owns the campaign picked it for this link.
|
||||||
|
async function completeServiceLink(request, campaign, user, credentials = null) {
|
||||||
|
request.campaign = campaign._id;
|
||||||
|
request.dragonrollUser = user.id;
|
||||||
|
request.state = 'linked';
|
||||||
|
request.linkedAt = new Date();
|
||||||
|
request.pickedUpAt = null;
|
||||||
|
request.notifiedAt = null;
|
||||||
|
request.credentials = credentials || undefined;
|
||||||
|
// An answered link is the record of a live connection: it stays until the
|
||||||
|
// service re-links or the campaign unlinks it.
|
||||||
|
request.expiresAt = null;
|
||||||
|
await request.save();
|
||||||
|
return request;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A campaign dropping a service: the link stops being valid, and the service
|
||||||
|
// finds that out the next time it asks.
|
||||||
|
async function revokeServiceLink(service, campaignId) {
|
||||||
|
const result = await ServiceLinkRequest.updateMany(
|
||||||
|
{ service: service, campaign: campaignId, state: 'linked' },
|
||||||
|
{
|
||||||
|
$set: { state: 'revoked', campaign: null },
|
||||||
|
$unset: { credentials: 1, linkedAt: 1 }
|
||||||
|
}
|
||||||
|
);
|
||||||
|
return result.matchedCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
// What a campaign has connected to it, newest link first and one row per
|
||||||
|
// service, so the campaign settings can list its services together.
|
||||||
|
async function listLinkedServices(campaignId) {
|
||||||
|
const links = await ServiceLinkRequest.find({ campaign: campaignId, state: 'linked' })
|
||||||
|
.sort({ linkedAt: -1 })
|
||||||
|
.lean();
|
||||||
|
|
||||||
|
const seen = new Set();
|
||||||
|
const services = [];
|
||||||
|
for (const link of links) {
|
||||||
|
if (seen.has(link.service)) continue;
|
||||||
|
seen.add(link.service);
|
||||||
|
services.push({
|
||||||
|
service: link.service,
|
||||||
|
name: serviceName(link.service),
|
||||||
|
targetId: link.targetId || '',
|
||||||
|
targetName: link.targetName || '',
|
||||||
|
targetUser: link.targetUser || '',
|
||||||
|
dragonrollUser: link.dragonrollUser || null,
|
||||||
|
linkedAt: link.linkedAt
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return services;
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
LINK_TTL_MS,
|
||||||
|
NOTIFICATION_WINDOW_MS,
|
||||||
|
SERVICES,
|
||||||
|
codeHash,
|
||||||
|
completeServiceLink,
|
||||||
|
findServiceLinkByCode,
|
||||||
|
isBotOnly,
|
||||||
|
isDiscordBot,
|
||||||
|
isService,
|
||||||
|
linkIsExpired,
|
||||||
|
listLinkedServices,
|
||||||
|
readTarget,
|
||||||
|
requireDiscordBot,
|
||||||
|
revokeServiceLink,
|
||||||
|
serviceName,
|
||||||
|
signUpLinkUrl,
|
||||||
|
startServiceLink,
|
||||||
|
takeServiceLinkCredentials
|
||||||
|
};
|
||||||
7
discord-bot/.dockerignore
Normal file
7
discord-bot/.dockerignore
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
node_modules
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
!.env.example
|
||||||
|
npm-debug.log*
|
||||||
|
Dockerfile
|
||||||
|
.dockerignore
|
||||||
14
discord-bot/.env.example
Normal file
14
discord-bot/.env.example
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# Create a bot application at https://discord.com/developers/applications
|
||||||
|
DISCORD_TOKEN=
|
||||||
|
DISCORD_CLIENT_ID=
|
||||||
|
|
||||||
|
# Dragonroll API URL including /api. For local development:
|
||||||
|
DRAGONROLL_API_URL=http://localhost:5000/api
|
||||||
|
# Frontend address people open when they click the sign-in button in Discord. The
|
||||||
|
# frontend then talks to the API above. Set this when the frontend is not reachable
|
||||||
|
# at the API address.
|
||||||
|
DRAGONROLL_FRONTEND_URL=http://localhost:3000
|
||||||
|
|
||||||
|
# Generate a long random value and set the same value in the backend
|
||||||
|
# environment as DRAGONROLL_DISCORD_BOT_SECRET.
|
||||||
|
DRAGONROLL_DISCORD_BOT_SECRET=replace-with-a-long-random-secret
|
||||||
3
discord-bot/.gitignore
vendored
Normal file
3
discord-bot/.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
.env
|
||||||
|
node_modules/
|
||||||
|
npm-debug.log*
|
||||||
31
discord-bot/Dockerfile
Normal file
31
discord-bot/Dockerfile
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Use official Node.js runtime
|
||||||
|
FROM node:20-alpine
|
||||||
|
|
||||||
|
# pnpm is served by corepack and pinned by "packageManager" in the root package.json
|
||||||
|
RUN corepack enable
|
||||||
|
|
||||||
|
# Create app directory
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
|
||||||
|
# Copy the workspace manifests first (better caching)
|
||||||
|
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 the production dependencies of the bot package
|
||||||
|
RUN pnpm install --frozen-lockfile --prod --filter ./discord-bot...
|
||||||
|
|
||||||
|
# Copy application source
|
||||||
|
COPY discord-bot ./discord-bot
|
||||||
|
|
||||||
|
# Environment variable
|
||||||
|
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),
|
||||||
|
# it does not listen on a port.
|
||||||
|
# Start the application
|
||||||
|
CMD ["node", "src/index.js"]
|
||||||
50
discord-bot/README.md
Normal file
50
discord-bot/README.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# Dragonroll Discord bot
|
||||||
|
|
||||||
|
A read-only Discord bot for consulting actors (characters, NPCs, and creatures) from Dragonroll. It talks to Dragonroll through authenticated API endpoints; it does not connect to MongoDB directly.
|
||||||
|
|
||||||
|
## Configure one campaign per Discord server
|
||||||
|
|
||||||
|
The bot can sit in as many Discord servers as you like. A Discord **Administrator** connects their own Dragonroll account with `/dragonroll connect`, signs in on Dragonroll’s site, then chooses one of their campaigns with `/dragonroll link`. The bot posts an ephemeral confirmation in Discord as soon as the authorization goes through. Dragonroll remembers the account and campaign for that guild. The bot never stores the Dragonroll user's password or token.
|
||||||
|
|
||||||
|
```
|
||||||
|
Discord server A ──link──▶ Dragonroll campaign "Katlum" (account gm-a@example.com)
|
||||||
|
Discord server B ──link──▶ Dragonroll campaign "Silang" (account gm-b@example.com)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
- `/characters [type]` lists the linked campaign's actors, optionally filtered to characters, NPCs, or creatures. Each one that a player has claimed with `/dragonroll assign` shows that player next to it.
|
||||||
|
- `/character name public:true` shows the matching actor's portrait (when one has been uploaded), profile, ability scores, combat stats, proficiencies, traits, spells, and inventory. Type part of a name to pick it from the campaign's current roster. Set `public` to `true` to show the reply to everyone in the channel.
|
||||||
|
- `/dragonroll connect` starts a short-lived Dragonroll sign-in and authorization link, and confirms here once somebody authorizes the server.
|
||||||
|
- `/dragonroll link` lets a server administrator choose a campaign owned by the connected Dragonroll account. Type part of a campaign name to filter the choices.
|
||||||
|
- `/dragonroll unlink` removes this server’s campaign link.
|
||||||
|
- `/dragonroll status` shows the campaign linked to this server, and the character linked to your Discord account on it.
|
||||||
|
- `/dragonroll assign character` links that character of the campaign to your Discord account: each player holds one character, so claiming a second one frees the first. Anyone can take a free character; only a server administrator can take a character another player already holds.
|
||||||
|
- `/dragonroll unassign [character]` removes a character link. Without the option you give up your own character; naming somebody else’s character takes it off them, which only a server administrator can do.
|
||||||
|
- `/dragonroll refresh` rechecks the current connection and campaign in Dragonroll.
|
||||||
|
|
||||||
|
Replies are private by default. `/character` can be made public with its `public` option, so everyone in the channel can see the character sheet.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Create a Discord application and bot in the [Discord Developer Portal](https://discord.com/developers/applications). It only needs permission to use application commands and send replies.
|
||||||
|
2. Generate a long random shared secret. Set it as `DRAGONROLL_DISCORD_BOT_SECRET` in both the backend environment and the bot's `.env`. This authenticates the bot service; it is not a Dragonroll user account.
|
||||||
|
3. Copy `.env.example` to `.env` and enter the Discord token, application id, API URL, frontend URL, and shared secret. `DRAGONROLL_API_URL` must be reachable by the bot. `DRAGONROLL_FRONTEND_URL` is the address people open when they click the sign-in button, and it defaults to `http://localhost:3000`. Keep `.env` private.
|
||||||
|
4. Invite the bot to each server with the `bot` and `applications.commands` scopes. A Discord Administrator runs `/dragonroll connect`, opens the Dragonroll button, signs in and confirms the server link, then returns to Discord and runs `/dragonroll link` to select a campaign they own. Each campaign can be linked to one server at a time.
|
||||||
|
5. Install packages and register the slash commands:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
npm run deploy-commands
|
||||||
|
```
|
||||||
|
|
||||||
|
Commands are registered globally, so every server the bot is in can use them. Global registration can take up to an hour to propagate; the bot also registers the commands itself as soon as it joins a server, and refreshes them in every server on each start so command changes reach guild commands too. For quick testing on one server only: `npm run deploy-commands -- --guild <server id>` (note that those guild commands then shadow the global ones in that server).
|
||||||
|
6. From the repository root, start the backend, frontend, and Discord bot together:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
To run only the bot, start the backend first and use `npm start` from `discord-bot/`.
|
||||||
|
|
||||||
|
The bot can start without any Dragonroll user account. It uses the shared service secret for guild-scoped API calls, so configure the secret in both environments before using Dragonroll commands. Dragonroll user credentials are entered only on Dragonroll's site and are not sent through Discord. The bot needs outbound access to both the Dragonroll API and Discord.
|
||||||
18
discord-bot/package.json
Normal file
18
discord-bot/package.json
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"name": "dragonroll-discord-bot",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"private": true,
|
||||||
|
"description": "Discord slash commands for consulting Dragonroll campaign characters.",
|
||||||
|
"main": "src/index.js",
|
||||||
|
"scripts": {
|
||||||
|
"start": "node src/index.js",
|
||||||
|
"deploy-commands": "node src/deploy-commands.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=20"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"discord.js": "^14.27.0",
|
||||||
|
"dotenv": "^17.2.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
74
discord-bot/src/commands.js
Normal file
74
discord-bot/src/commands.js
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
const { InteractionContextType, SlashCommandBuilder } = require('discord.js');
|
||||||
|
|
||||||
|
// Every command needs a Dragonroll campaign, and campaigns are linked to
|
||||||
|
// Discord servers, so none of them make sense in a DM.
|
||||||
|
const guildOnly = (command) => command.setContexts(InteractionContextType.Guild);
|
||||||
|
|
||||||
|
const commands = [
|
||||||
|
guildOnly(new SlashCommandBuilder()
|
||||||
|
.setName('characters')
|
||||||
|
.setDescription('List the characters of the Dragonroll campaign linked to this server.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('type')
|
||||||
|
.setDescription('Filter by actor type.')
|
||||||
|
.addChoices(
|
||||||
|
{ name: 'All', value: 'all' },
|
||||||
|
{ name: 'Characters', value: 'character' },
|
||||||
|
{ name: 'NPCs', value: 'npc' },
|
||||||
|
{ name: 'Creatures', value: 'creature' }
|
||||||
|
))),
|
||||||
|
guildOnly(new SlashCommandBuilder()
|
||||||
|
.setName('character')
|
||||||
|
.setDescription('Consult a character sheet from the Dragonroll campaign linked to this server.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('name')
|
||||||
|
.setDescription('Character name (full or partial).')
|
||||||
|
.setRequired(true)
|
||||||
|
.setMaxLength(100)
|
||||||
|
.setAutocomplete(true))
|
||||||
|
.addBooleanOption((option) => option
|
||||||
|
.setName('public')
|
||||||
|
.setDescription('Show the character sheet to everyone in this channel.'))),
|
||||||
|
guildOnly(new SlashCommandBuilder()
|
||||||
|
.setName('dragonroll')
|
||||||
|
.setDescription('Configure or check this server’s Dragonroll campaign.')
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('connect')
|
||||||
|
.setDescription('Connect your Dragonroll account to this server.'))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('link')
|
||||||
|
.setDescription('Choose a campaign owned by the connected Dragonroll account.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('campaign')
|
||||||
|
.setDescription('Campaign to use in this server.')
|
||||||
|
.setRequired(true)
|
||||||
|
.setAutocomplete(true)))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('unlink')
|
||||||
|
.setDescription('Remove this server’s Dragonroll campaign link.'))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('status')
|
||||||
|
.setDescription('Show the campaign linked to this server.'))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('refresh')
|
||||||
|
.setDescription('Refresh this server’s Dragonroll connection status.'))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('assign')
|
||||||
|
.setDescription('Link one character of the campaign to your Discord account.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('character')
|
||||||
|
.setDescription('Character to play (pick it from the campaign roster).')
|
||||||
|
.setRequired(true)
|
||||||
|
.setMaxLength(100)
|
||||||
|
.setAutocomplete(true)))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('unassign')
|
||||||
|
.setDescription('Remove the link between a character and a Discord player.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('character')
|
||||||
|
.setDescription('Character to free (yours by default, anyone’s as a server administrator).')
|
||||||
|
.setMaxLength(100)
|
||||||
|
.setAutocomplete(true))))
|
||||||
|
];
|
||||||
|
|
||||||
|
module.exports = commands;
|
||||||
41
discord-bot/src/config.js
Normal file
41
discord-bot/src/config.js
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
const dotenv = require('dotenv');
|
||||||
|
|
||||||
|
dotenv.config();
|
||||||
|
|
||||||
|
function required(name) {
|
||||||
|
const value = process.env[name]?.trim();
|
||||||
|
if (!value) throw new Error(`Missing required environment variable: ${name}`);
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
function apiUrl(value, name) {
|
||||||
|
const url = value.trim().replace(/\/+$/, '');
|
||||||
|
if (!/^https?:\/\//i.test(url)) throw new Error(`${name} must start with http:// or https://`);
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Frontend address, not the API: the sign-in page people open from Discord lives there.
|
||||||
|
function frontendUrl(value, name) {
|
||||||
|
const url = apiUrl(value, name).replace(/\/api$/i, '');
|
||||||
|
if (!url) throw new Error(`${name} must be the Dragonroll frontend address, like http://localhost:3000`);
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getConfig() {
|
||||||
|
const apiUrlValue = process.env.DRAGONROLL_API_URL || 'http://localhost:5000/api';
|
||||||
|
const apiBaseUrl = apiUrl(apiUrlValue, 'DRAGONROLL_API_URL');
|
||||||
|
const frontendBaseUrl = frontendUrl(
|
||||||
|
process.env.DRAGONROLL_FRONTEND_URL || process.env.DRAGONROLL_PUBLIC_API_URL || 'http://localhost:3000',
|
||||||
|
'DRAGONROLL_FRONTEND_URL'
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
apiBaseUrl,
|
||||||
|
frontendBaseUrl,
|
||||||
|
discordBotSecret: process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '',
|
||||||
|
discordToken: required('DISCORD_TOKEN'),
|
||||||
|
discordClientId: required('DISCORD_CLIENT_ID')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { getConfig };
|
||||||
44
discord-bot/src/deploy-commands.js
Normal file
44
discord-bot/src/deploy-commands.js
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
const { REST, Routes } = require('discord.js');
|
||||||
|
const { getConfig } = require('./config');
|
||||||
|
const commands = require('./commands');
|
||||||
|
|
||||||
|
// Global by default: the bot can be invited to any number of servers, and the
|
||||||
|
// campaign it answers with is decided per server by Dragonroll.
|
||||||
|
// Pass "--guild <server id>" while developing to see changes in one server at once.
|
||||||
|
function routeFor(clientId, guildId) {
|
||||||
|
return guildId
|
||||||
|
? Routes.applicationGuildCommands(clientId, guildId)
|
||||||
|
: Routes.applicationCommands(clientId);
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseGuildArg(argv) {
|
||||||
|
const index = argv.indexOf('--guild');
|
||||||
|
if (index === -1) return null;
|
||||||
|
|
||||||
|
const guildId = argv[index + 1];
|
||||||
|
if (!guildId || guildId.startsWith('--')) {
|
||||||
|
throw new Error('Usage: npm run deploy-commands -- --guild <discord server id>');
|
||||||
|
}
|
||||||
|
return guildId;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function deploy() {
|
||||||
|
const config = getConfig();
|
||||||
|
const guildId = parseGuildArg(process.argv.slice(2));
|
||||||
|
const rest = new REST({ version: '10' }).setToken(config.discordToken);
|
||||||
|
|
||||||
|
await rest.put(routeFor(config.discordClientId, guildId), { body: commands.map((command) => command.toJSON()) });
|
||||||
|
|
||||||
|
if (guildId) {
|
||||||
|
console.log(`Registered ${commands.length} commands in Discord server ${guildId}.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`Registered ${commands.length} commands globally.`);
|
||||||
|
console.log('New servers can take up to an hour to see them; the bot also registers them when it joins a server.');
|
||||||
|
}
|
||||||
|
|
||||||
|
deploy().catch((error) => {
|
||||||
|
console.error('Could not register Discord commands:', error.message);
|
||||||
|
process.exitCode = 1;
|
||||||
|
});
|
||||||
154
discord-bot/src/dragonroll-api.js
Normal file
154
discord-bot/src/dragonroll-api.js
Normal file
@@ -0,0 +1,154 @@
|
|||||||
|
class CampaignNotLinkedError extends Error {
|
||||||
|
constructor(guildId) {
|
||||||
|
super(`No Dragonroll campaign is linked to Discord server ${guildId}.`);
|
||||||
|
this.name = 'CampaignNotLinkedError';
|
||||||
|
this.guildId = guildId;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class DragonrollNotConnectedError extends Error {
|
||||||
|
constructor(guildId) {
|
||||||
|
super(`No Dragonroll account is connected to Discord server ${guildId}.`);
|
||||||
|
this.name = 'DragonrollNotConnectedError';
|
||||||
|
this.guildId = guildId;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function createDragonrollApi(config) {
|
||||||
|
async function request(path, options = {}) {
|
||||||
|
if (!config.discordBotSecret) {
|
||||||
|
throw new Error('Set DRAGONROLL_DISCORD_BOT_SECRET in the bot and backend environments before using Dragonroll commands.');
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await fetch(`${config.apiBaseUrl}${path}`, {
|
||||||
|
...options,
|
||||||
|
headers: {
|
||||||
|
...(options.body ? { 'Content-Type': 'application/json' } : {}),
|
||||||
|
'X-Dragonroll-Discord-Bot-Secret': config.discordBotSecret,
|
||||||
|
...options.headers
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
let payload;
|
||||||
|
try {
|
||||||
|
payload = await response.json();
|
||||||
|
} catch {
|
||||||
|
const error = new Error(`Dragonroll API returned an unreadable response (${response.status}).`);
|
||||||
|
error.status = response.status;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!response.ok || payload.status === 'error') {
|
||||||
|
const error = new Error(payload.msg || `Dragonroll API request failed (${response.status}).`);
|
||||||
|
error.status = response.status;
|
||||||
|
error.code = payload.msg;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
return payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The backend hands out the sign-up link the person opens to pick a campaign,
|
||||||
|
// so the bot never builds one itself: every service shows the same link.
|
||||||
|
async function startAuthorization(guildId, guildName, discordUserId, discordUserName) {
|
||||||
|
const payload = await request('/link/start', {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({
|
||||||
|
service: 'discord',
|
||||||
|
target: {
|
||||||
|
id: String(guildId),
|
||||||
|
name: guildName,
|
||||||
|
user: discordUserName,
|
||||||
|
meta: { userId: String(discordUserId) }
|
||||||
|
}
|
||||||
|
})
|
||||||
|
});
|
||||||
|
if (!payload.linkUrl) throw new Error('Dragonroll did not provide a sign-up link. Update the Dragonroll backend.');
|
||||||
|
return payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function claimLinkNotifications() {
|
||||||
|
const payload = await request('/discord/bot/link-requests/notifications', { method: 'POST' });
|
||||||
|
return Array.isArray(payload.notifications) ? payload.notifications : [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function getStatus(guildId) { return request(`/discord/bot/guild/${encodeURIComponent(guildId)}/status`);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function listCampaigns(guildId) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaigns`);
|
||||||
|
if (!Array.isArray(payload.campaigns)) {
|
||||||
|
throw new Error(payload.msg || 'Dragonroll returned an invalid campaign list.');
|
||||||
|
}
|
||||||
|
return payload.campaigns;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function linkCampaign(guildId, campaignId) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaign`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({ campaignId })
|
||||||
|
});
|
||||||
|
if (!payload.campaign) throw new Error('Dragonroll returned an invalid campaign link.');
|
||||||
|
return payload.campaign;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function unlinkCampaign(guildId) {
|
||||||
|
const current = await getCampaign(guildId);
|
||||||
|
await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/campaign`, { method: 'DELETE' });
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function getCampaign(guildId) {
|
||||||
|
const key = String(guildId);
|
||||||
|
const status = await getStatus(key);
|
||||||
|
if (!status.connected) throw new DragonrollNotConnectedError(key);
|
||||||
|
if (!status.campaign) throw new CampaignNotLinkedError(key);
|
||||||
|
|
||||||
|
const campaign = {
|
||||||
|
id: String(status.campaign._id ?? status.campaign.id),
|
||||||
|
name: status.campaign.name || 'Untitled campaign'
|
||||||
|
};
|
||||||
|
if (!campaign.id || campaign.id === 'undefined') throw new Error('Dragonroll returned an invalid campaign.');
|
||||||
|
return campaign;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function listActors(guildId) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors`);
|
||||||
|
if (!Array.isArray(payload.actors) || !payload.campaign) {
|
||||||
|
throw new Error(payload.msg || 'Dragonroll returned an invalid actor list.');
|
||||||
|
}
|
||||||
|
const campaign = {
|
||||||
|
id: String(payload.campaign.id ?? payload.campaign._id),
|
||||||
|
name: payload.campaign.name || 'Untitled campaign'
|
||||||
|
};
|
||||||
|
return { campaign, actors: payload.actors };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Linking players to characters (Syndria98/dragonroll#72). `admin` says
|
||||||
|
// whether the Discord side already checked the person is a server
|
||||||
|
// administrator, who may move a character somebody else holds.
|
||||||
|
async function assignActor(guildId, { actorId, discordUserId, admin = false }) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors/assign`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({ actorId, discordUserId: String(discordUserId), admin })
|
||||||
|
});
|
||||||
|
if (!payload.actor) throw new Error('Dragonroll returned an invalid character link.');
|
||||||
|
return { actor: payload.actor, previous: payload.previous ?? null };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function unassignActor(guildId, { actorId, discordUserId, admin = false }) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors/unassign`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({
|
||||||
|
discordUserId: String(discordUserId),
|
||||||
|
...(actorId ? { actorId } : {}),
|
||||||
|
admin
|
||||||
|
})
|
||||||
|
});
|
||||||
|
if (!payload.actor) throw new Error('Dragonroll returned an invalid character link.');
|
||||||
|
return { actor: payload.actor, wasYours: payload.wasYours === true };
|
||||||
|
}
|
||||||
|
|
||||||
|
return { startAuthorization, claimLinkNotifications, getStatus, getCampaign, listCampaigns, linkCampaign, unlinkCampaign, listActors, assignActor, unassignActor };
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { createDragonrollApi, CampaignNotLinkedError, DragonrollNotConnectedError };
|
||||||
620
discord-bot/src/index.js
Normal file
620
discord-bot/src/index.js
Normal file
@@ -0,0 +1,620 @@
|
|||||||
|
const {
|
||||||
|
ActionRowBuilder,
|
||||||
|
ButtonBuilder,
|
||||||
|
ButtonStyle,
|
||||||
|
Client,
|
||||||
|
EmbedBuilder,
|
||||||
|
Events,
|
||||||
|
GatewayIntentBits,
|
||||||
|
MessageFlags,
|
||||||
|
PermissionFlagsBits,
|
||||||
|
REST,
|
||||||
|
Routes
|
||||||
|
} = require('discord.js');
|
||||||
|
const { getConfig } = require('./config');
|
||||||
|
const {
|
||||||
|
createDragonrollApi,
|
||||||
|
CampaignNotLinkedError,
|
||||||
|
DragonrollNotConnectedError
|
||||||
|
} = require('./dragonroll-api');
|
||||||
|
const commands = require('./commands');
|
||||||
|
|
||||||
|
// Same lifetime as the authorization link on the backend.
|
||||||
|
const LINK_REQUEST_TTL_MS = 10 * 60 * 1000;
|
||||||
|
const LINK_NOTIFICATION_POLL_MS = 4000;
|
||||||
|
|
||||||
|
function abilityModifier(score) {
|
||||||
|
const modifier = Math.floor((Number(score || 10) - 10) / 2);
|
||||||
|
return `${modifier >= 0 ? '+' : ''}${modifier}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function safeField(value, limit = 600) {
|
||||||
|
const text = String(value || '').trim();
|
||||||
|
if (!text) return '—';
|
||||||
|
return text.length > limit ? `${text.slice(0, limit - 1)}…` : text;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Actor images are stored as a bare filename and served publicly at
|
||||||
|
// `<api>/public/<filename>`, the same way the frontend renders them. An
|
||||||
|
// absolute URL is used as-is if one ever gets saved.
|
||||||
|
function actorImageUrl(image, publicBaseUrl) {
|
||||||
|
const value = String(image || '').trim();
|
||||||
|
if (!value) return null;
|
||||||
|
if (/^https?:\/\//i.test(value)) return value;
|
||||||
|
return `${publicBaseUrl.replace(/\/+$/, '')}/${encodeURIComponent(value)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function actorEmbed(actor, campaign, publicImageBaseUrl) {
|
||||||
|
const abilities = actor.abilityScores || {};
|
||||||
|
const abilityFields = [
|
||||||
|
['💪 STR', 'str'], ['🏹 DEX', 'dex'], ['🛡️ CON', 'con'],
|
||||||
|
['📚 INT', 'int'], ['👁️ WIS', 'wis'], ['✨ CHA', 'cha']
|
||||||
|
].map(([name, key]) => {
|
||||||
|
const score = abilities[key] ?? 10;
|
||||||
|
return { name, value: `**${score}** · _${abilityModifier(score)}_`, inline: true };
|
||||||
|
});
|
||||||
|
const className = String(actor.className || actor.class || '').trim();
|
||||||
|
const race = actor.species || actor.race;
|
||||||
|
|
||||||
|
const embed = new EmbedBuilder()
|
||||||
|
.setTitle(safeField(actor.name, 256))
|
||||||
|
.setColor(0x8c6bb1)
|
||||||
|
.setDescription(safeField(actor.description, 1200))
|
||||||
|
.setFooter({ text: safeField(`Campaign: ${campaign.name}`, 600) });
|
||||||
|
|
||||||
|
const imageUrl = actorImageUrl(actor.image, publicImageBaseUrl);
|
||||||
|
if (imageUrl) embed.setImage(imageUrl);
|
||||||
|
|
||||||
|
embed.addFields(
|
||||||
|
{ name: '🧬 Race', value: safeField(race), inline: true },
|
||||||
|
{ name: '⚔️ Class', value: safeField([className, actor.level ? `Level ${actor.level}` : null].filter(Boolean).join(' · ')), inline: true }
|
||||||
|
);
|
||||||
|
if (actor.subclass) embed.addFields({ name: '✨ Subclass', value: safeField(actor.subclass), inline: true });
|
||||||
|
embed.addFields(
|
||||||
|
{ name: '📜 Background', value: safeField(actor.background), inline: true },
|
||||||
|
{ name: '🛡️ Combat', value: `AC ${actor.armorClass ?? 10} · Speed ${actor.speed ?? 30} ft.`, inline: true },
|
||||||
|
{ name: 'Ability scores', value: '\u200b' },
|
||||||
|
...abilityFields
|
||||||
|
);
|
||||||
|
|
||||||
|
if (actor.proficiencies) embed.addFields({ name: 'Proficiencies', value: safeField(actor.proficiencies) });
|
||||||
|
if (actor.traits) embed.addFields({ name: 'Traits', value: safeField(actor.traits) });
|
||||||
|
if (actor.spells) embed.addFields({ name: 'Spells', value: safeField(actor.spells) });
|
||||||
|
|
||||||
|
if (Array.isArray(actor.inventory) && actor.inventory.length) {
|
||||||
|
const inventory = actor.inventory
|
||||||
|
.map((item) => `${item.name || 'Item'} ×${item.quantity || 1}`)
|
||||||
|
.join('\n');
|
||||||
|
embed.addFields({ name: 'Inventory', value: safeField(inventory) });
|
||||||
|
}
|
||||||
|
|
||||||
|
return embed;
|
||||||
|
}
|
||||||
|
|
||||||
|
function findActor(actors, input) {
|
||||||
|
const query = input.trim().toLocaleLowerCase();
|
||||||
|
const exact = actors.find((actor) => actor.name.toLocaleLowerCase() === query);
|
||||||
|
if (exact) return { actor: exact };
|
||||||
|
|
||||||
|
const matches = actors.filter((actor) => actor.name.toLocaleLowerCase().includes(query));
|
||||||
|
if (matches.length === 1) return { actor: matches[0] };
|
||||||
|
return { matches };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const config = getConfig();
|
||||||
|
if (!config.discordBotSecret) {
|
||||||
|
console.warn('DRAGONROLL_DISCORD_BOT_SECRET is not set; the bot will start, but Dragonroll commands will need it.');
|
||||||
|
}
|
||||||
|
const dragonroll = createDragonrollApi(config);
|
||||||
|
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
|
||||||
|
const rest = new REST({ version: '10' }).setToken(config.discordToken);
|
||||||
|
// Discord downloads character portraits itself, so they need to be absolute
|
||||||
|
// URLs pointing at the backend's public uploads folder.
|
||||||
|
const publicImageBaseUrl = `${config.apiBaseUrl}/public`;
|
||||||
|
|
||||||
|
// Reply, or edit the deferred reply, always without pinging anybody.
|
||||||
|
async function respond(interaction, payload) {
|
||||||
|
const body = { allowedMentions: { parse: [] }, ...payload };
|
||||||
|
if (interaction.deferred || interaction.replied) return interaction.editReply(body);
|
||||||
|
return interaction.reply({ ...body, flags: MessageFlags.Ephemeral });
|
||||||
|
}
|
||||||
|
|
||||||
|
async function explainMissingCampaign(interaction, guildId) {
|
||||||
|
await respond(interaction, {
|
||||||
|
content: safeField([
|
||||||
|
'This Discord server is not linked to a Dragonroll campaign yet.',
|
||||||
|
`A server administrator can connect Dragonroll with \`/dragonroll connect\`, then choose a campaign with \`/dragonroll link\`. Server ID: \`${guildId}\`.`
|
||||||
|
].join('\n'), 1800)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function explainNotConnected(interaction, guildId) {
|
||||||
|
await respond(interaction, {
|
||||||
|
content: safeField([
|
||||||
|
'No Dragonroll account is connected to this Discord server yet.',
|
||||||
|
`A server administrator can run \`/dragonroll connect\` to sign in. Server ID: \`${guildId}\`.`
|
||||||
|
].join('\n'), 1800)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// The /dragonroll connect interactions waiting for somebody to authorize on Dragonroll.
|
||||||
|
// Their tokens stay usable for 15 minutes, longer than the authorization link lasts.
|
||||||
|
const pendingLinkRequests = new Map();
|
||||||
|
let linkNotificationTimer = null;
|
||||||
|
|
||||||
|
function linkRequestKey(guildId, discordUserId) {
|
||||||
|
return `${guildId}:${discordUserId}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function rememberLinkRequest(interaction) {
|
||||||
|
for (const [key, pending] of pendingLinkRequests) {
|
||||||
|
if (Date.now() - pending.requestedAt > LINK_REQUEST_TTL_MS) pendingLinkRequests.delete(key);
|
||||||
|
}
|
||||||
|
pendingLinkRequests.set(linkRequestKey(interaction.guildId, interaction.user.id), {
|
||||||
|
interaction,
|
||||||
|
requestedAt: Date.now()
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!linkNotificationTimer) {
|
||||||
|
linkNotificationTimer = setInterval(() => {
|
||||||
|
deliverLinkNotifications().catch((error) => {
|
||||||
|
console.error('Could not confirm a Dragonroll authorization:', error.message);
|
||||||
|
});
|
||||||
|
}, LINK_NOTIFICATION_POLL_MS);
|
||||||
|
linkNotificationTimer.unref();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function confirmLinkRequest(interaction, notification) {
|
||||||
|
const account = notification.dragonrollUserName ? ` \`${safeField(notification.dragonrollUserName, 40)}\`` : '';
|
||||||
|
await interaction.followUp({
|
||||||
|
content: safeField([
|
||||||
|
`Your Dragonroll account${account} is now connected to **${safeField(notification.guildName, 100)}**.`,
|
||||||
|
'Run `/dragonroll link` to choose which campaign this server can read.'
|
||||||
|
].join('\n'), 1800),
|
||||||
|
flags: MessageFlags.Ephemeral,
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function deliverLinkNotifications() {
|
||||||
|
if (!config.discordBotSecret || !pendingLinkRequests.size) return;
|
||||||
|
|
||||||
|
const notifications = await dragonroll.claimLinkNotifications();
|
||||||
|
for (const notification of notifications) {
|
||||||
|
const key = linkRequestKey(notification.guildId, notification.discordUserId);
|
||||||
|
const pending = pendingLinkRequests.get(key);
|
||||||
|
pendingLinkRequests.delete(key);
|
||||||
|
// Without the interaction that asked for this authorization there is nothing to
|
||||||
|
// answer: the bot was restarted, and Dragonroll's own web page already told the
|
||||||
|
// person what to do next.
|
||||||
|
if (!pending) continue;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await confirmLinkRequest(pending.interaction, notification);
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`Could not confirm the Dragonroll authorization for Discord user ${notification.discordUserId}:`, error.message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Commands live on every server the bot joins: guild-scoped registration is
|
||||||
|
// instant, unlike the global registration done by deploy-commands.
|
||||||
|
async function registerCommandsIn(guildId) {
|
||||||
|
try {
|
||||||
|
await rest.put(Routes.applicationGuildCommands(config.discordClientId, guildId), {
|
||||||
|
body: commands.map((command) => command.toJSON())
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`Could not register commands in Discord server ${guildId}:`, error.message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function showStatus(interaction, guildId) {
|
||||||
|
const embed = new EmbedBuilder()
|
||||||
|
.setTitle('Dragonroll link')
|
||||||
|
.setColor(0x8c6bb1)
|
||||||
|
.addFields({ name: 'This server', value: `${interaction.guild?.name || 'Unknown'} · \`${guildId}\`` });
|
||||||
|
|
||||||
|
let status;
|
||||||
|
try {
|
||||||
|
status = await dragonroll.getStatus(guildId);
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Could not read the Dragonroll connection for this server:', error.message);
|
||||||
|
embed.addFields({ name: 'Dragonroll account', value: 'Dragonroll could not be reached right now.' });
|
||||||
|
await respond(interaction, { embeds: [embed] });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
embed.addFields(
|
||||||
|
{ name: 'Dragonroll account', value: status.connected ? 'Connected' : 'Not connected.' },
|
||||||
|
{ name: 'Campaign', value: status.campaign
|
||||||
|
? `${status.campaign.name} · \`${status.campaign._id ?? status.campaign.id}\``
|
||||||
|
: 'Not linked yet.' }
|
||||||
|
);
|
||||||
|
|
||||||
|
// The campaign's character linked to this Discord account (#72), when there is one.
|
||||||
|
if (status.campaign) {
|
||||||
|
try {
|
||||||
|
const { actors } = await dragonroll.listActors(guildId);
|
||||||
|
const yours = actors.find((actor) => String(actor.discordUserId ?? '') === interaction.user.id);
|
||||||
|
embed.addFields({
|
||||||
|
name: 'Your character',
|
||||||
|
value: yours ? safeField(yours.name, 100) : 'None. Run /dragonroll assign to link one to your Discord account.'
|
||||||
|
});
|
||||||
|
} catch {
|
||||||
|
// The roster is a bonus of this card, which stays useful without it.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!status.connected) {
|
||||||
|
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
|
||||||
|
} else if (!status.campaign) {
|
||||||
|
embed.setDescription('A server administrator can run /dragonroll link to choose a campaign.');
|
||||||
|
}
|
||||||
|
|
||||||
|
await respond(interaction, { embeds: [embed] });
|
||||||
|
}
|
||||||
|
|
||||||
|
// /dragonroll assign and unassign (Syndria98/dragonroll#72): each player of the
|
||||||
|
// server holds one character of the linked campaign. Anyone claims a free
|
||||||
|
// character for themselves; server administrators also move and free the ones
|
||||||
|
// somebody else holds.
|
||||||
|
async function handleActorAssignment(interaction, guildId, subcommand) {
|
||||||
|
const isAdmin = interaction.memberPermissions?.has(PermissionFlagsBits.Administrator) === true;
|
||||||
|
const name = interaction.options.getString('character');
|
||||||
|
const { actors } = await dragonroll.listActors(guildId);
|
||||||
|
|
||||||
|
// Unassign without a character gives up the one linked to you.
|
||||||
|
if (subcommand === 'unassign' && !name) {
|
||||||
|
const mine = actors.find((actor) => String(actor.discordUserId ?? '') === interaction.user.id);
|
||||||
|
if (!mine) {
|
||||||
|
await respond(interaction, { content: 'You do not have a character linked to your Discord account here. Run `/dragonroll assign` to claim one.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await dragonroll.unassignActor(guildId, { discordUserId: interaction.user.id });
|
||||||
|
await respond(interaction, { content: `You are no longer linked to **${safeField(mine.name, 100)}**.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = findActor(actors, name);
|
||||||
|
if (!result.actor) {
|
||||||
|
await respond(interaction, {
|
||||||
|
content: result.matches?.length
|
||||||
|
? safeField(`Several characters match **${name}**: ${result.matches.slice(0, 15).map((actor) => actor.name).join(', ')}. Try a more specific name.`, 1800)
|
||||||
|
: safeField(`I couldn't find a character named **${name}**. Try \`/characters\` to see the campaign roster.`, 1800)
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const actor = result.actor;
|
||||||
|
const holder = String(actor.discordUserId ?? '');
|
||||||
|
|
||||||
|
if (subcommand === 'assign') {
|
||||||
|
if (holder === interaction.user.id) {
|
||||||
|
await respond(interaction, { content: `You are already linked to **${safeField(actor.name, 100)}**.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (holder && !isAdmin) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** is already linked to <@${holder}>. A server administrator can give it away and take it with the same command.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const { previous } = await dragonroll.assignActor(guildId, {
|
||||||
|
actorId: String(actor._id),
|
||||||
|
discordUserId: interaction.user.id,
|
||||||
|
admin: isAdmin
|
||||||
|
});
|
||||||
|
const lines = [`You are now linked to **${safeField(actor.name, 100)}**.`];
|
||||||
|
if (holder) lines.push(`That character was linked to <@${holder}>; the link is removed.`);
|
||||||
|
if (previous) lines.push(`Your previous character, **${safeField(previous.name, 100)}**, is free again.`);
|
||||||
|
await respond(interaction, { content: safeField(lines.join('\n'), 1800) });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unassign with a character named: your own, or anybody's as an administrator.
|
||||||
|
if (!holder) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** does not have a linked Discord player.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (holder !== interaction.user.id && !isAdmin) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** is linked to <@${holder}>. Only a server administrator can unlink it.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await dragonroll.unassignActor(guildId, { actorId: String(actor._id), discordUserId: interaction.user.id, admin: isAdmin });
|
||||||
|
await respond(interaction, {
|
||||||
|
content: holder === interaction.user.id
|
||||||
|
? `You are no longer linked to **${safeField(actor.name, 100)}**.`
|
||||||
|
: `**${safeField(actor.name, 100)}** is no longer linked to <@${holder}>.`
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
client.once(Events.ClientReady, (readyClient) => {
|
||||||
|
console.log(`Dragonroll character bot is online as ${readyClient.user.tag}, in ${readyClient.guilds.cache.size} servers.`);
|
||||||
|
// Guild commands registered when the bot joined shadow global ones and
|
||||||
|
// keep their old definition forever, so refresh them on every start to
|
||||||
|
// propagate command changes (new options, autocomplete) to all servers.
|
||||||
|
for (const guild of readyClient.guilds.cache.values()) registerCommandsIn(guild.id);
|
||||||
|
});
|
||||||
|
|
||||||
|
client.on(Events.GuildCreate, (guild) => {
|
||||||
|
console.log(`Added to Discord server ${guild.id} (${guild.name}).`);
|
||||||
|
registerCommandsIn(guild.id);
|
||||||
|
});
|
||||||
|
|
||||||
|
client.on(Events.InteractionCreate, (interaction) => {
|
||||||
|
// One broken command should not take the bot down for every other server.
|
||||||
|
handleInteraction(interaction).catch((error) => {
|
||||||
|
console.error(`Could not answer ${interaction.commandName}:`, error.message);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
async function respondCampaignChoices(interaction, guildId) {
|
||||||
|
if (!interaction.memberPermissions?.has(PermissionFlagsBits.Administrator)) {
|
||||||
|
await interaction.respond([]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const query = interaction.options.getFocused().toLocaleLowerCase();
|
||||||
|
const campaigns = await dragonroll.listCampaigns(guildId);
|
||||||
|
const choices = campaigns
|
||||||
|
.filter((campaign) => !campaign.discordGuildId || String(campaign.discordGuildId) === String(guildId))
|
||||||
|
.filter((campaign) => String(campaign.name || '').toLocaleLowerCase().includes(query))
|
||||||
|
.slice(0, 25)
|
||||||
|
.map((campaign) => ({
|
||||||
|
name: safeField(campaign.name, 100),
|
||||||
|
value: String(campaign._id ?? campaign.id)
|
||||||
|
}))
|
||||||
|
.filter((choice) => choice.value && choice.value !== 'undefined');
|
||||||
|
await interaction.respond(choices);
|
||||||
|
} catch (error) {
|
||||||
|
if (error.status !== 401 && error.code !== 'discord.errors.not-connected') {
|
||||||
|
console.error('Could not list campaigns for Discord configuration:', error.message);
|
||||||
|
}
|
||||||
|
await interaction.respond([]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Character names for /character. Anyone who may read the campaign may use
|
||||||
|
// the suggestions; when nothing is linked we answer with an empty list, as
|
||||||
|
// autocomplete replies cannot carry an error message.
|
||||||
|
async function respondActorChoices(interaction, guildId) {
|
||||||
|
try {
|
||||||
|
const query = interaction.options.getFocused().trim().toLocaleLowerCase();
|
||||||
|
const { actors } = await dragonroll.listActors(guildId);
|
||||||
|
const seen = new Set();
|
||||||
|
const choices = actors
|
||||||
|
.filter((actor) => String(actor.name || '').trim() && actor.name.length <= 100)
|
||||||
|
.filter((actor) => actor.name.toLocaleLowerCase().includes(query))
|
||||||
|
.map((actor) => ({
|
||||||
|
name: safeField(actor.name, 100),
|
||||||
|
value: actor.name
|
||||||
|
}))
|
||||||
|
.filter((choice) => !seen.has(choice.value) && seen.add(choice.value))
|
||||||
|
.slice(0, 25);
|
||||||
|
await interaction.respond(choices);
|
||||||
|
} catch (error) {
|
||||||
|
if (!(error instanceof DragonrollNotConnectedError)
|
||||||
|
&& !(error instanceof CampaignNotLinkedError)
|
||||||
|
&& error.status !== 401
|
||||||
|
&& error.code !== 'discord.errors.not-connected') {
|
||||||
|
console.error('Could not list characters for Discord autocomplete:', error.message);
|
||||||
|
}
|
||||||
|
await interaction.respond([]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function handleInteraction(interaction) {
|
||||||
|
if (interaction.isAutocomplete()) {
|
||||||
|
const guildId = interaction.guildId;
|
||||||
|
if (!guildId) {
|
||||||
|
await interaction.respond([]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (interaction.commandName === 'character') {
|
||||||
|
await respondActorChoices(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (interaction.commandName === 'dragonroll') {
|
||||||
|
const subcommand = interaction.options.getSubcommand();
|
||||||
|
if (subcommand === 'link') {
|
||||||
|
await respondCampaignChoices(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (['assign', 'unassign'].includes(subcommand)) {
|
||||||
|
await respondActorChoices(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!interaction.isChatInputCommand()) return;
|
||||||
|
if (!['characters', 'character', 'dragonroll'].includes(interaction.commandName)) return;
|
||||||
|
|
||||||
|
const guildId = interaction.guildId;
|
||||||
|
if (!guildId) {
|
||||||
|
await respond(interaction, { content: 'These commands only work inside a Discord server.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (interaction.commandName === 'dragonroll') {
|
||||||
|
const subcommand = interaction.options.getSubcommand();
|
||||||
|
if (['connect', 'link', 'unlink'].includes(subcommand)) {
|
||||||
|
if (!interaction.memberPermissions?.has(PermissionFlagsBits.Administrator)) {
|
||||||
|
await respond(interaction, { content: 'Only Discord server administrators can connect Dragonroll or change this campaign link.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
|
try {
|
||||||
|
if (subcommand === 'connect') {
|
||||||
|
const request = await dragonroll.startAuthorization(
|
||||||
|
guildId,
|
||||||
|
interaction.guild?.name || 'Discord server',
|
||||||
|
interaction.user.id,
|
||||||
|
interaction.user.username
|
||||||
|
);
|
||||||
|
const authorizationUrl = `${config.frontendBaseUrl}/discord/authorize#code=${encodeURIComponent(request.code)}`;
|
||||||
|
const button = new ButtonBuilder()
|
||||||
|
.setLabel('Sign in to Dragonroll')
|
||||||
|
.setStyle(ButtonStyle.Link)
|
||||||
|
.setURL(authorizationUrl);
|
||||||
|
await respond(interaction, {
|
||||||
|
content: 'Open Dragonroll to sign in and authorize this server. The link expires in 10 minutes.',
|
||||||
|
components: [new ActionRowBuilder().addComponents(button)]
|
||||||
|
});
|
||||||
|
rememberLinkRequest(interaction);
|
||||||
|
return;
|
||||||
|
} else if (subcommand === 'link') {
|
||||||
|
const campaignId = interaction.options.getString('campaign', true);
|
||||||
|
const campaign = await dragonroll.linkCampaign(guildId, campaignId);
|
||||||
|
await respond(interaction, {
|
||||||
|
content: `This server is now linked to **${safeField(campaign.name, 180)}**.`,
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
try {
|
||||||
|
const campaign = await dragonroll.unlinkCampaign(guildId);
|
||||||
|
await respond(interaction, {
|
||||||
|
content: `Removed this server’s link to **${safeField(campaign.name, 180)}**.`,
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
if (error instanceof CampaignNotLinkedError) {
|
||||||
|
await respond(interaction, { content: 'This server does not have a linked campaign.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`Could not ${subcommand} the campaign for Discord server ${guildId}:`, error.message);
|
||||||
|
let message = `I could not ${subcommand} this campaign link. Please try again.`;
|
||||||
|
if (error instanceof DragonrollNotConnectedError || error.code === 'discord.errors.not-connected') {
|
||||||
|
message = 'Connect a Dragonroll account first with /dragonroll connect.';
|
||||||
|
} else if (error.status === 401 || error.message.includes('DRAGONROLL_DISCORD_BOT_SECRET')) {
|
||||||
|
message = 'The bot API secret is missing or does not match the backend. Contact the bot operator.';
|
||||||
|
} else if (error.code === 'campaigns.errors.discord-guild-in-use' || error.code === 'discord.errors.campaign-already-linked') {
|
||||||
|
message = 'That campaign is already linked to another Discord server.';
|
||||||
|
}
|
||||||
|
await respond(interaction, { content: message });
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Players link themselves to a character of the campaign (Syndria98/dragonroll#72).
|
||||||
|
if (['assign', 'unassign'].includes(subcommand)) {
|
||||||
|
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
|
try {
|
||||||
|
await handleActorAssignment(interaction, guildId, subcommand);
|
||||||
|
} catch (error) {
|
||||||
|
if (error instanceof DragonrollNotConnectedError) {
|
||||||
|
await explainNotConnected(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error instanceof CampaignNotLinkedError) {
|
||||||
|
await explainMissingCampaign(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error.code === 'discord.errors.actor-held') {
|
||||||
|
await respond(interaction, { content: 'That character is already linked to another player. A server administrator can give it away and take it with the same command.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error.status === 401 || error.message.includes('DRAGONROLL_DISCORD_BOT_SECRET')) {
|
||||||
|
await respond(interaction, { content: 'The bot API secret is missing or does not match the backend. Contact the bot operator.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.error(`Could not ${subcommand} a character link in Discord server ${guildId}:`, error.message);
|
||||||
|
await respond(interaction, { content: 'I could not change that character link right now. Please try again.' });
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
|
await showStatus(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const showCharacterPublicly = interaction.commandName === 'character'
|
||||||
|
&& interaction.options.getBoolean('public');
|
||||||
|
await interaction.deferReply(showCharacterPublicly ? {} : { flags: MessageFlags.Ephemeral });
|
||||||
|
|
||||||
|
try {
|
||||||
|
const { campaign, actors } = await dragonroll.listActors(guildId);
|
||||||
|
|
||||||
|
if (interaction.commandName === 'characters') {
|
||||||
|
const type = interaction.options.getString('type') || 'all';
|
||||||
|
const filtered = type === 'all' ? actors : actors.filter((actor) => actor.type === type);
|
||||||
|
if (!filtered.length) {
|
||||||
|
await interaction.editReply({
|
||||||
|
content: type === 'all'
|
||||||
|
? `There are no characters in **${campaign.name}** yet.`
|
||||||
|
: `There are no ${type === 'npc' ? 'NPCs' : `${type}s`} in **${campaign.name}**.`,
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const shown = filtered.slice(0, 40);
|
||||||
|
const lines = shown.map((actor) => {
|
||||||
|
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
|
||||||
|
.filter(Boolean)
|
||||||
|
.join(' · ');
|
||||||
|
// The player a character is linked to (#72); mentions never ping
|
||||||
|
// here, the replies parse no mentions.
|
||||||
|
const player = actor.discordUserId ? ` 🎮 <@${actor.discordUserId}>` : '';
|
||||||
|
return `• **${actor.name}**${details ? ` — ${details}` : ''}${player}`;
|
||||||
|
});
|
||||||
|
const embed = new EmbedBuilder()
|
||||||
|
.setTitle(`Characters of ${campaign.name}`)
|
||||||
|
.setColor(0x8c6bb1)
|
||||||
|
.setDescription(safeField(lines.join('\n'), 4000))
|
||||||
|
.setFooter({ text: filtered.length > shown.length
|
||||||
|
? `Showing ${shown.length} of ${filtered.length}; use /character to look up a specific sheet.`
|
||||||
|
: `${filtered.length} ${filtered.length === 1 ? 'entry' : 'entries'} · Use /character to inspect a sheet.` });
|
||||||
|
await interaction.editReply({ embeds: [embed], allowedMentions: { parse: [] } });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const name = interaction.options.getString('name', true);
|
||||||
|
const result = findActor(actors, name);
|
||||||
|
if (result.actor) {
|
||||||
|
await interaction.editReply({ embeds: [actorEmbed(result.actor, campaign, publicImageBaseUrl)], allowedMentions: { parse: [] } });
|
||||||
|
} else if (result.matches?.length > 1) {
|
||||||
|
await interaction.editReply({
|
||||||
|
content: safeField(`Several characters match **${name}**: ${result.matches.slice(0, 15).map((actor) => actor.name).join(', ')}. Try a more specific name.`, 1800),
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
await interaction.editReply({
|
||||||
|
content: `I couldn't find a character named **${name}**. Try \`/characters\` to see the campaign roster.`,
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
if (error instanceof DragonrollNotConnectedError) {
|
||||||
|
await explainNotConnected(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error instanceof CampaignNotLinkedError) {
|
||||||
|
await explainMissingCampaign(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.error('Character lookup failed:', error.message);
|
||||||
|
await interaction.editReply({
|
||||||
|
content: 'I could not reach the Dragonroll campaign right now. Please try again in a moment.',
|
||||||
|
allowedMentions: { parse: [] }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await client.login(config.discordToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch((error) => {
|
||||||
|
console.error('Could not start Dragonroll Discord bot:', error.message);
|
||||||
|
process.exitCode = 1;
|
||||||
|
});
|
||||||
@@ -18,4 +18,26 @@ services:
|
|||||||
|
|
||||||
backend:
|
backend:
|
||||||
image: git.aranroig.com/syndria98/dragonroll-backend:latest
|
image: git.aranroig.com/syndria98/dragonroll-backend:latest
|
||||||
restart: always
|
environment:
|
||||||
|
# Shared service secret the Discord bot authenticates with
|
||||||
|
# (header x-dragonroll-discord-bot-secret). Must match the bot's value.
|
||||||
|
DRAGONROLL_DISCORD_BOT_SECRET: ${DRAGONROLL_DISCORD_BOT_SECRET}
|
||||||
|
# Public address of the frontend: the /discord/authorize link people
|
||||||
|
# open from Discord is built from this.
|
||||||
|
DRAGONROLL_FRONTEND_URL: ${DRAGONROLL_FRONTEND_URL:-https://dragonroll.aranroig.com}
|
||||||
|
restart: always
|
||||||
|
|
||||||
|
discord-bot:
|
||||||
|
image: git.aranroig.com/syndria98/dragonroll-discord-bot:latest
|
||||||
|
environment:
|
||||||
|
DISCORD_TOKEN: ${DISCORD_TOKEN}
|
||||||
|
DISCORD_CLIENT_ID: ${DISCORD_CLIENT_ID}
|
||||||
|
DRAGONROLL_DISCORD_BOT_SECRET: ${DRAGONROLL_DISCORD_BOT_SECRET}
|
||||||
|
# Must stay the public https address (through nginx) and not
|
||||||
|
# http://backend:5000/api: character portraits are rendered in Discord
|
||||||
|
# from <DRAGONROLL_API_URL>/public/<filename>.
|
||||||
|
DRAGONROLL_API_URL: ${DRAGONROLL_API_URL:-https://dragonroll.aranroig.com/api}
|
||||||
|
DRAGONROLL_FRONTEND_URL: ${DRAGONROLL_FRONTEND_URL:-https://dragonroll.aranroig.com}
|
||||||
|
depends_on:
|
||||||
|
- backend
|
||||||
|
restart: always
|
||||||
|
|||||||
192
dragonroll-foundry/README.md
Normal file
192
dragonroll-foundry/README.md
Normal file
@@ -0,0 +1,192 @@
|
|||||||
|
# Dragonroll Foundry integration
|
||||||
|
|
||||||
|
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
||||||
|
This integration uses a small companion bridge process on that host:
|
||||||
|
|
||||||
|
1. A linked GM client syncs character Actors and world Items directly with the Dragonroll campaign.
|
||||||
|
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
||||||
|
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
||||||
|
|
||||||
|
The Foundry module uses the client-side package API and hooks documented by Foundry: [module development](https://foundryvtt.com/article/module-development/).
|
||||||
|
|
||||||
|
## 1. Install the Foundry module
|
||||||
|
|
||||||
|
Copy the contents of this directory into
|
||||||
|
`{Foundry user data}/Data/modules/dragonroll-foundry/`. Restart Foundry, then enable **Dragonroll
|
||||||
|
Foundry API** in the world's module settings.
|
||||||
|
|
||||||
|
After linking a campaign, the module stores a client-only token for character synchronization that
|
||||||
|
persists across Foundry restarts. If the optional bridge is configured, Dragonroll also sends its
|
||||||
|
connection settings to the module.
|
||||||
|
Existing clients continue using their saved bridge URL and publish token automatically. The module
|
||||||
|
publishes at world startup and after actor or item changes, and sends a lightweight heartbeat once a
|
||||||
|
minute. Its local JavaScript API remains available at
|
||||||
|
`game.modules.get("dragonroll-foundry").api`.
|
||||||
|
|
||||||
|
## Link a Foundry world to a Dragonroll campaign
|
||||||
|
|
||||||
|
Open the campaign's **Settings → Integrations** tab in Dragonroll and create a pairing code. In the
|
||||||
|
Foundry module settings, set **Dragonroll Endpoint** if you use a different Dragonroll server; it
|
||||||
|
defaults to `https://dragonroll.aranroig.com` and the module adds `/api` automatically. Paste the
|
||||||
|
code into **Dragonroll Campaign Pairing Code** and save. Codes expire after ten minutes and can only
|
||||||
|
be used once.
|
||||||
|
|
||||||
|
Both sides of the pairing survive restarts: Dragonroll keeps a pending code on the campaign so the
|
||||||
|
settings screen re-displays it after a page reload, the window being closed, or a server restart
|
||||||
|
(until it expires or is used), and the Foundry module keeps a code it could not redeem yet — for
|
||||||
|
example one pasted while Dragonroll was restarting — retrying it at world startup and once a minute
|
||||||
|
until the world finishes linking.
|
||||||
|
|
||||||
|
For a local backend, use `http://localhost:5000`; the module omits `/api` and the backend accepts
|
||||||
|
the local pairing route at its root. Character synchronization works without the optional snapshot
|
||||||
|
bridge. Configure that bridge only if you also need the read-only world snapshot API described below.
|
||||||
|
|
||||||
|
**Dragonroll Pairing Status** in the module settings always says whether this browser holds a pairing
|
||||||
|
and, once Dragonroll has answered `GET /api/foundry/sync/status`, which campaign the world is
|
||||||
|
connected to. It is written by the module, not by the GM: it appears as not connected until the world
|
||||||
|
is paired, names the campaign after a pairing or a check on world start and every minute afterwards,
|
||||||
|
gives the reason when a pairing code can never be redeemed, and says the world is no longer linked
|
||||||
|
once the campaign unlinks it. Because both the pairing code and the sync token are client settings,
|
||||||
|
another browser of the same world reads as not paired.
|
||||||
|
|
||||||
|
The campaign settings show the linked world's title and system. A Foundry world can be linked to
|
||||||
|
only one campaign at a time. The pairing endpoint accepts cross-origin requests from the Foundry
|
||||||
|
client and uses the one-time code instead of a Dragonroll login token.
|
||||||
|
|
||||||
|
## Character and item synchronization
|
||||||
|
|
||||||
|
After linking, the GM client imports Foundry character, NPC, and creature Actors into the campaign.
|
||||||
|
Creates, updates, and deletes sync in either direction; Dragonroll changes are applied in Foundry
|
||||||
|
within about five seconds. The module currently creates Dragonroll characters in D&D 5e Foundry
|
||||||
|
worlds. After updating an already-linked world to a version with character sync, create a fresh
|
||||||
|
pairing code and enter it in Foundry once to issue the sync token.
|
||||||
|
|
||||||
|
### Auto-sync, and sending one actor on purpose
|
||||||
|
|
||||||
|
**Dragonroll Auto-sync** in the module settings (on by default) is what keeps the campaign and this
|
||||||
|
world in step: actors and world items the GM creates, updates or deletes are sent to Dragonroll, and
|
||||||
|
both sides reconcile every few seconds. Turn it off to stop synchronizing altogether — nothing is
|
||||||
|
sent to the campaign, and Dragonroll stops rewriting those documents in Foundry, so the campaign
|
||||||
|
keeps whatever it already holds. Turn it back on to reconcile both sides again; the Foundry edits
|
||||||
|
queued while it was off are sent as the world catches up.
|
||||||
|
|
||||||
|
With autosync off — or any time a single character needs to cross over right now — right-click an
|
||||||
|
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
|
||||||
|
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
|
||||||
|
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
|
||||||
|
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
|
||||||
|
not a character, NPC or creature) are refused with a notification.
|
||||||
|
|
||||||
|
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
|
||||||
|
`/api/foundry/*`, which is never written into the campaign.
|
||||||
|
|
||||||
|
### Items
|
||||||
|
|
||||||
|
The campaign's Item list mirrors the world's item directory (Foundry's **items tab**) and nothing
|
||||||
|
else (Syndria98/dragonroll#67):
|
||||||
|
|
||||||
|
- The GM sends the world item directory (`game.items`) with every snapshot, and world items created,
|
||||||
|
changed or deleted in Foundry are pushed as they happen. The items embedded in a character are that
|
||||||
|
character's own inventory: they travel with its snapshot and stay on its sheet, so gear a character
|
||||||
|
merely carries does not stand in the campaign's item list.
|
||||||
|
- A world item folds into a Dragonroll row that already carries its name — one a campaign made by hand,
|
||||||
|
or one it renamed away from and remembers (`foundryNames`) — instead of doubling it. Spells, classes,
|
||||||
|
subclasses, backgrounds, feats and species are not gear and are not imported.
|
||||||
|
- Foundry owns the fields it sends (category from the item type, rarity, quantity, weight, weapon
|
||||||
|
properties, description). An item made by hand in Dragonroll is created in the world's item
|
||||||
|
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
||||||
|
document.
|
||||||
|
- 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
|
||||||
|
pruned only by a full snapshot, so a live item push never deletes anything: only a full snapshot sees
|
||||||
|
the whole world directory and can tell which synced rows it has let go of. Deleting a synced item in
|
||||||
|
Dragonroll removes its Foundry world copy on the next reconcile.
|
||||||
|
|
||||||
|
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
||||||
|
|
||||||
|
| Route | Use |
|
||||||
|
|---|---|
|
||||||
|
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
||||||
|
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
||||||
|
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
||||||
|
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
||||||
|
| `GET /api/foundry/sync/items` | Items, 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 |
|
||||||
|
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
||||||
|
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
||||||
|
|
||||||
|
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
||||||
|
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
||||||
|
the write is not echoed back. 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
|
||||||
|
|
||||||
|
The bridge uses only Node.js built-in modules and requires Node 18 or newer. Set separate random
|
||||||
|
tokens for backend reads and Foundry snapshot publishing, then start it:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export DRAGONROLL_FOUNDRY_READ_TOKEN='replace-with-a-long-random-read-token'
|
||||||
|
export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publish-token'
|
||||||
|
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
||||||
|
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
||||||
|
export DRAGONROLL_FOUNDRY_PORT='8787'
|
||||||
|
# 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
|
||||||
|
```
|
||||||
|
|
||||||
|
Put the bridge behind HTTPS when it is reachable outside a trusted private network. The Foundry
|
||||||
|
browser origin must be listed in `DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS`; separate multiple origins with
|
||||||
|
commas. The bridge binds to `0.0.0.0` by default so Dragonroll can reach it on another host. Restrict
|
||||||
|
network access to the bridge port to Dragonroll and Foundry clients. If the reverse proxy serves the
|
||||||
|
bridge under a path prefix, configure it to strip that prefix before forwarding requests to port 8787.
|
||||||
|
|
||||||
|
## 3. Configure Dragonroll's backend
|
||||||
|
|
||||||
|
Set these variables in the backend environment. `FOUNDRY_API_URL` is the bridge base URL reachable
|
||||||
|
by the backend, without an API path. `FOUNDRY_API_CLIENT_URL` is optional and overrides the bridge
|
||||||
|
URL sent to Foundry clients when they cannot reach the backend's bridge URL (for example, when the
|
||||||
|
backend uses a private network address). `FOUNDRY_API_PUSH_TOKEN` must match the bridge's
|
||||||
|
`DRAGONROLL_FOUNDRY_PUSH_TOKEN`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
FOUNDRY_API_URL='https://vtt.example.com/dragonroll-bridge/'
|
||||||
|
FOUNDRY_API_CLIENT_URL='https://vtt.example.com/dragonroll-bridge/'
|
||||||
|
FOUNDRY_API_TOKEN='replace-with-the-bridge-read-token'
|
||||||
|
FOUNDRY_API_PUSH_TOKEN='replace-with-the-bridge-publish-token'
|
||||||
|
```
|
||||||
|
|
||||||
|
The backend exposes these JWT-protected routes when the optional snapshot bridge is configured:
|
||||||
|
|
||||||
|
| Dragonroll route | Data |
|
||||||
|
|---|---|
|
||||||
|
| `GET /api/foundry/world` | Active Foundry world metadata |
|
||||||
|
| `GET /api/foundry/actors` | All world actors |
|
||||||
|
| `GET /api/foundry/characters` | Actors with type `character` |
|
||||||
|
| `GET /api/foundry/actors/:id` | One actor |
|
||||||
|
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
||||||
|
| `GET /api/foundry/items` | World-level items |
|
||||||
|
| `GET /api/foundry/items/:id` | One world-level item |
|
||||||
|
| `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
|
||||||
|
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
||||||
|
ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when the bridge has not
|
||||||
|
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
||||||
|
configured GM client has published its first snapshot.
|
||||||
|
|
||||||
|
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
|
||||||
|
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.
|
||||||
12
dragonroll-foundry/bridge/package.json
Normal file
12
dragonroll-foundry/bridge/package.json
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"name": "dragonroll-foundry-bridge",
|
||||||
|
"private": true,
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Authenticated HTTP bridge between a Foundry client module and Dragonroll.",
|
||||||
|
"scripts": {
|
||||||
|
"start": "node server.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
}
|
||||||
|
}
|
||||||
316
dragonroll-foundry/bridge/server.js
Normal file
316
dragonroll-foundry/bridge/server.js
Normal file
@@ -0,0 +1,316 @@
|
|||||||
|
const http = require("node:http");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const path = require("node:path");
|
||||||
|
const { timingSafeEqual } = require("node:crypto");
|
||||||
|
|
||||||
|
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
||||||
|
const port = Number(process.env.DRAGONROLL_FOUNDRY_PORT || 8787);
|
||||||
|
const readToken = process.env.DRAGONROLL_FOUNDRY_READ_TOKEN;
|
||||||
|
const pushToken = process.env.DRAGONROLL_FOUNDRY_PUSH_TOKEN;
|
||||||
|
const allowedOrigins = new Set(
|
||||||
|
(process.env.DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS || "http://localhost:30000")
|
||||||
|
.split(",")
|
||||||
|
.map((origin) => origin.trim())
|
||||||
|
.filter(Boolean),
|
||||||
|
);
|
||||||
|
const maxBodySize = 50 * 1024 * 1024;
|
||||||
|
// 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) {
|
||||||
|
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
||||||
|
}
|
||||||
|
|
||||||
|
let snapshot = null;
|
||||||
|
|
||||||
|
function sendJson(response, status, body) {
|
||||||
|
response.writeHead(status, { "Content-Type": "application/json; charset=utf-8" });
|
||||||
|
response.end(JSON.stringify(body));
|
||||||
|
}
|
||||||
|
|
||||||
|
function setCorsHeaders(request, response) {
|
||||||
|
const origin = request.headers.origin;
|
||||||
|
if (!origin) return true;
|
||||||
|
if (!allowedOrigins.has(origin)) return false;
|
||||||
|
|
||||||
|
response.setHeader("Access-Control-Allow-Origin", origin);
|
||||||
|
response.setHeader("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
|
||||||
|
response.setHeader("Access-Control-Allow-Headers", "Authorization, Content-Type");
|
||||||
|
response.setHeader("Vary", "Origin");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function hasBearerToken(request, expectedToken) {
|
||||||
|
const match = /^Bearer\s+(.+)$/i.exec(request.headers.authorization || "");
|
||||||
|
if (!match) return false;
|
||||||
|
|
||||||
|
const actual = Buffer.from(match[1]);
|
||||||
|
const expected = Buffer.from(expectedToken);
|
||||||
|
return actual.length === expected.length && timingSafeEqual(actual, expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
function readJson(request) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const chunks = [];
|
||||||
|
let bytes = 0;
|
||||||
|
let tooLarge = false;
|
||||||
|
|
||||||
|
request.on("data", (chunk) => {
|
||||||
|
bytes += chunk.length;
|
||||||
|
if (bytes > maxBodySize) {
|
||||||
|
tooLarge = true;
|
||||||
|
chunks.length = 0;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (!tooLarge) chunks.push(chunk);
|
||||||
|
});
|
||||||
|
|
||||||
|
request.on("end", () => {
|
||||||
|
if (tooLarge) {
|
||||||
|
reject(Object.assign(new Error("Snapshot is too large."), { status: 413 }));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
resolve(JSON.parse(Buffer.concat(chunks).toString("utf8")));
|
||||||
|
} catch {
|
||||||
|
reject(Object.assign(new Error("Request body must be valid JSON."), { status: 400 }));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
request.on("error", reject);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function currentSnapshot(response) {
|
||||||
|
if (!snapshot) {
|
||||||
|
sendJson(response, 503, { status: "error", msg: "foundry.not-ready" });
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return snapshot;
|
||||||
|
}
|
||||||
|
|
||||||
|
function sendData(response, data, current) {
|
||||||
|
const ageMs = Date.now() - current.syncedAtMs;
|
||||||
|
sendJson(response, 200, {
|
||||||
|
status: "ok",
|
||||||
|
data,
|
||||||
|
world: current.world,
|
||||||
|
syncedAt: new Date(current.syncedAtMs).toISOString(),
|
||||||
|
ageSeconds: Math.floor(ageMs / 1000),
|
||||||
|
stale: ageMs > 120000,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function decodePathSegment(segment) {
|
||||||
|
try {
|
||||||
|
return decodeURIComponent(segment);
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- 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) => {
|
||||||
|
if (!setCorsHeaders(request, response)) {
|
||||||
|
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.method === "OPTIONS") {
|
||||||
|
response.writeHead(204);
|
||||||
|
response.end();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const pathname = new URL(request.url, "http://localhost").pathname;
|
||||||
|
|
||||||
|
if (request.method === "GET" && pathname === "/health") {
|
||||||
|
sendJson(response, 200, {
|
||||||
|
status: "ok",
|
||||||
|
ready: Boolean(snapshot),
|
||||||
|
syncedAt: snapshot ? new Date(snapshot.syncedAtMs).toISOString() : null,
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.method === "POST" && pathname === "/internal/snapshot") {
|
||||||
|
if (!hasBearerToken(request, pushToken)) {
|
||||||
|
sendJson(response, 401, { status: "error", msg: "unauthorized" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const body = await readJson(request);
|
||||||
|
if (!body.world?.id || !Array.isArray(body.actors) || !Array.isArray(body.items)
|
||||||
|
|| !body.actorItems || typeof body.actorItems !== "object" || Array.isArray(body.actorItems)) {
|
||||||
|
sendJson(response, 400, { status: "error", msg: "foundry.invalid-snapshot" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
snapshot = {
|
||||||
|
world: body.world,
|
||||||
|
actors: body.actors,
|
||||||
|
items: body.items,
|
||||||
|
actorItems: body.actorItems,
|
||||||
|
syncedAtMs: Date.now(),
|
||||||
|
};
|
||||||
|
sendJson(response, 200, { status: "ok", syncedAt: new Date(snapshot.syncedAtMs).toISOString() });
|
||||||
|
} catch (error) {
|
||||||
|
sendJson(response, error.status || 400, { status: "error", msg: "foundry.invalid-snapshot" });
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.method === "POST" && pathname === "/internal/heartbeat") {
|
||||||
|
if (!hasBearerToken(request, pushToken)) {
|
||||||
|
sendJson(response, 401, { status: "error", msg: "unauthorized" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const body = await readJson(request);
|
||||||
|
if (!snapshot || !body.worldId || snapshot.world.id !== body.worldId) {
|
||||||
|
sendJson(response, 409, { status: "error", msg: "foundry.not-ready" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
snapshot.syncedAtMs = Date.now();
|
||||||
|
sendJson(response, 200, { status: "ok", syncedAt: new Date(snapshot.syncedAtMs).toISOString() });
|
||||||
|
} catch (error) {
|
||||||
|
sendJson(response, error.status || 400, { status: "error", msg: "foundry.invalid-heartbeat" });
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request.method !== "GET" || !pathname.startsWith("/api/")) {
|
||||||
|
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!hasBearerToken(request, readToken)) {
|
||||||
|
sendJson(response, 401, { status: "error", msg: "unauthorized" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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);
|
||||||
|
if (!current) return;
|
||||||
|
|
||||||
|
if (pathname === "/api/world") return sendData(response, current.world, current);
|
||||||
|
if (pathname === "/api/actors") return sendData(response, current.actors, current);
|
||||||
|
if (pathname === "/api/characters") {
|
||||||
|
return sendData(response, current.actors.filter((actor) => actor.type === "character"), current);
|
||||||
|
}
|
||||||
|
if (pathname === "/api/items") return sendData(response, current.items, current);
|
||||||
|
|
||||||
|
const actorItemsMatch = /^\/api\/actors\/([^/]+)\/items$/.exec(pathname);
|
||||||
|
if (actorItemsMatch) {
|
||||||
|
const actorId = decodePathSegment(actorItemsMatch[1]);
|
||||||
|
if (!actorId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||||
|
const actor = current.actors.find((entry) => entry._id === actorId || entry.id === actorId);
|
||||||
|
if (!actor) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
return sendData(response, current.actorItems[actorId] || [], current);
|
||||||
|
}
|
||||||
|
|
||||||
|
const actorMatch = /^\/api\/actors\/([^/]+)$/.exec(pathname);
|
||||||
|
if (actorMatch) {
|
||||||
|
const actorId = decodePathSegment(actorMatch[1]);
|
||||||
|
if (!actorId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||||
|
const actor = current.actors.find((entry) => entry._id === actorId || entry.id === actorId);
|
||||||
|
if (!actor) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
return sendData(response, actor, current);
|
||||||
|
}
|
||||||
|
|
||||||
|
const itemMatch = /^\/api\/items\/([^/]+)$/.exec(pathname);
|
||||||
|
if (itemMatch) {
|
||||||
|
const itemId = decodePathSegment(itemMatch[1]);
|
||||||
|
if (!itemId) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||||
|
const item = current.items.find((entry) => entry._id === itemId || entry.id === itemId);
|
||||||
|
if (!item) return sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
return sendData(response, item, current);
|
||||||
|
}
|
||||||
|
|
||||||
|
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
});
|
||||||
|
|
||||||
|
server.listen(port, host, () => {
|
||||||
|
console.info(`Dragonroll Foundry bridge listening on ${host}:${port}`);
|
||||||
|
});
|
||||||
14
dragonroll-foundry/module.json
Normal file
14
dragonroll-foundry/module.json
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"id": "dragonroll-foundry",
|
||||||
|
"title": "Dragonroll Foundry API",
|
||||||
|
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||||
|
"version": "0.4.0",
|
||||||
|
"library": true,
|
||||||
|
"compatibility": {
|
||||||
|
"minimum": "12",
|
||||||
|
"verified": "14"
|
||||||
|
},
|
||||||
|
"esmodules": [
|
||||||
|
"scripts/api.js"
|
||||||
|
]
|
||||||
|
}
|
||||||
1756
dragonroll-foundry/scripts/api.js
Normal file
1756
dragonroll-foundry/scripts/api.js
Normal file
File diff suppressed because it is too large
Load Diff
@@ -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"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
};
|
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -1,33 +1,6 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import ContentManager from './components/managers/ContentManager.vue';
|
// El que es veu és la pàgina que toca (app/pages): /docs porta la documentació, i la
|
||||||
import ToastManager from './components/managers/ToastManager.vue';
|
// resta de rutes obren l'aplicació de finestres. Aquí només hi ha el que és de tot el lloc.
|
||||||
import WindowManager from './components/managers/WindowManager.vue';
|
|
||||||
|
|
||||||
import { CreateWindow } from '@/services/Windows'
|
|
||||||
import { GetUser, HasAdmin } from './services/User';
|
|
||||||
import TooltipManager from './components/managers/TooltipManager.vue';
|
|
||||||
import ContextMenuManager from './components/managers/ContextMenuManager.vue';
|
|
||||||
import { useCampaignService } from './services/Campaign';
|
|
||||||
|
|
||||||
const { RestoreCampaign } = useCampaignService();
|
|
||||||
|
|
||||||
async function start(){
|
|
||||||
if(GetUser()){
|
|
||||||
const restoredCampaign = await RestoreCampaign();
|
|
||||||
if (!restoredCampaign) {
|
|
||||||
CreateWindow('main_menu');
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(await HasAdmin()){
|
|
||||||
CreateWindow('login');
|
|
||||||
} else {
|
|
||||||
CreateWindow('register', {firstTime: true});
|
|
||||||
}
|
|
||||||
// DisplayToast('aqua', 'All plugins loaded successfully');
|
|
||||||
}
|
|
||||||
|
|
||||||
useHead({
|
useHead({
|
||||||
title: 'Dragonroll',
|
title: 'Dragonroll',
|
||||||
meta: [
|
meta: [
|
||||||
@@ -40,26 +13,9 @@ useHead({
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
setupTheme();
|
setupTheme();
|
||||||
setTheme('dark');
|
setTheme('dark');
|
||||||
start();
|
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="viewer">
|
<NuxtPage></NuxtPage>
|
||||||
<ToastManager></ToastManager>
|
|
||||||
<TooltipManager></TooltipManager>
|
|
||||||
<ContextMenuManager></ContextMenuManager>
|
|
||||||
<WindowManager></WindowManager>
|
|
||||||
<ContentManager></ContentManager>
|
|
||||||
<!-- Managers -->
|
|
||||||
</div>
|
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
|
||||||
.viewer {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
width: 100%;
|
|
||||||
height: 100vh;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ $themes: (
|
|||||||
button-active: #202020cc,
|
button-active: #202020cc,
|
||||||
|
|
||||||
toast-background: #202020,
|
toast-background: #202020,
|
||||||
|
tooltip-background: #2a2a2a,
|
||||||
|
|
||||||
note-border: #202324,
|
note-border: #202324,
|
||||||
|
|
||||||
@@ -29,11 +30,25 @@ $themes: (
|
|||||||
container-shadow: #151d28,
|
container-shadow: #151d28,
|
||||||
sticky-header-bg: #20202077,
|
sticky-header-bg: #20202077,
|
||||||
|
|
||||||
red: #e06c75,
|
// Quoted: red/green/gray are also Sass colour keywords, so unquoted they are parsed as
|
||||||
green: #98c379,
|
// colour values, and interpolating one into `--color-#{$name}` warns
|
||||||
gray: #cccccc,
|
// (Syndria98/dragonroll#71).
|
||||||
|
"red": #e06c75,
|
||||||
|
"green": #98c379,
|
||||||
|
"gray": #cccccc,
|
||||||
|
|
||||||
icon-invert: 100%
|
// The rarity of an item colours its row in the sidebar (Syndria98/dragonroll#63).
|
||||||
|
rarity-common: #ffffff,
|
||||||
|
rarity-uncommon: #1eff00,
|
||||||
|
rarity-rare: #2f81f7,
|
||||||
|
rarity-very-rare: #a855f7,
|
||||||
|
rarity-legendary: #ff8000,
|
||||||
|
|
||||||
|
icon-invert: 100%,
|
||||||
|
|
||||||
|
search-background: #20202077,
|
||||||
|
search-background-container: #202020ee,
|
||||||
|
search-hover: #2a2a2a,
|
||||||
),
|
),
|
||||||
light: (
|
light: (
|
||||||
background: #ffffff,
|
background: #ffffff,
|
||||||
@@ -51,6 +66,7 @@ $themes: (
|
|||||||
button-active: #d4d4d4,
|
button-active: #d4d4d4,
|
||||||
|
|
||||||
toast-background: #f0f0f0,
|
toast-background: #f0f0f0,
|
||||||
|
tooltip-background: #f5f5f5,
|
||||||
|
|
||||||
note-border: #e0e0e0,
|
note-border: #e0e0e0,
|
||||||
|
|
||||||
@@ -62,11 +78,23 @@ $themes: (
|
|||||||
container-shadow: #5f6774,
|
container-shadow: #5f6774,
|
||||||
sticky-header-bg: #fff,
|
sticky-header-bg: #fff,
|
||||||
|
|
||||||
red: #e06c75,
|
// Quoted for the same reason as in the dark map.
|
||||||
green: #98c379,
|
"red": #e06c75,
|
||||||
gray: #cccccc,
|
"green": #98c379,
|
||||||
|
"gray": #cccccc,
|
||||||
|
|
||||||
icon-invert: 0%
|
// Same rarities as the dark map, darkened to stay readable on a light background.
|
||||||
|
rarity-common: #1e1e1e,
|
||||||
|
rarity-uncommon: #157f2b,
|
||||||
|
rarity-rare: #1d4ed8,
|
||||||
|
rarity-very-rare: #7e22ce,
|
||||||
|
rarity-legendary: #c05621,
|
||||||
|
|
||||||
|
icon-invert: 0%,
|
||||||
|
|
||||||
|
search-background: #f0f0f0aa,
|
||||||
|
search-background-container: #ffffffee,
|
||||||
|
search-hover: #e8e8e8,
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -225,6 +225,23 @@ button:active {
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Cites (> ...) a la vista prèvia d'una nota */
|
||||||
|
blockquote {
|
||||||
|
margin: 1em 0;
|
||||||
|
padding: 2px 0 2px 14px;
|
||||||
|
border-left: 3px solid var(--color-border-color);
|
||||||
|
font-style: italic;
|
||||||
|
opacity: 0.85;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote blockquote {
|
||||||
|
margin: 0.5em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote p {
|
||||||
|
margin: 0.3em 0;
|
||||||
|
}
|
||||||
|
|
||||||
.text-icon {
|
.text-icon {
|
||||||
height: 18px;
|
height: 18px;
|
||||||
width: 18px;
|
width: 18px;
|
||||||
@@ -363,4 +380,126 @@ span.artifact {
|
|||||||
|
|
||||||
.green {
|
.green {
|
||||||
color: var(--color-green);
|
color: var(--color-green);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Seccions col·lapsables (h1/h2/h3) a la vista prèvia d'una nota */
|
||||||
|
.fold-handle {
|
||||||
|
position: relative;
|
||||||
|
cursor: pointer;
|
||||||
|
user-select: none;
|
||||||
|
padding-left: 0.95em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fold-handle::before {
|
||||||
|
content: "";
|
||||||
|
position: absolute;
|
||||||
|
left: 0.1em;
|
||||||
|
top: 0.55em;
|
||||||
|
width: 0.3em;
|
||||||
|
height: 0.3em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
border-right: 1px solid currentColor;
|
||||||
|
border-bottom: 1px solid currentColor;
|
||||||
|
opacity: 0;
|
||||||
|
transition: transform 0.15s ease, opacity 0.15s ease;
|
||||||
|
transform: rotate(45deg);
|
||||||
|
transform-origin: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fold-handle:hover::before {
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fold.is-collapsed > .fold-handle::before {
|
||||||
|
opacity: 0.7;
|
||||||
|
transform: rotate(-45deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.fold.is-collapsed > .fold-body {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* El markdown renderitzat de la documentació: tot dins de .docs-markdown, que ve de v-html.
|
||||||
|
Va aquí perquè la pàgina de /docs (views/DocsView.vue) i la finestra de documentació
|
||||||
|
(windows/DocumentationWindow.vue) se'l serveixen plegades. */
|
||||||
|
.docs-markdown h1 {
|
||||||
|
margin: 0 0 14px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 2rem;
|
||||||
|
font-weight: normal;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown h2 {
|
||||||
|
margin: 30px 0 10px 0;
|
||||||
|
padding-bottom: 4px;
|
||||||
|
border-bottom: 1px solid var(--color-border);
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.35rem;
|
||||||
|
font-weight: normal;
|
||||||
|
scroll-margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown h3 {
|
||||||
|
margin: 22px 0 8px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.1rem;
|
||||||
|
font-weight: normal;
|
||||||
|
scroll-margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown p,
|
||||||
|
.docs-markdown li {
|
||||||
|
line-height: 1.65;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown ul,
|
||||||
|
.docs-markdown ol {
|
||||||
|
margin: 10px 0;
|
||||||
|
padding-left: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown a {
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown code {
|
||||||
|
padding: 1px 5px;
|
||||||
|
border-radius: 4px;
|
||||||
|
background-color: var(--color-background-light);
|
||||||
|
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
|
||||||
|
font-size: 0.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown pre {
|
||||||
|
margin: 14px 0;
|
||||||
|
padding: 12px 14px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
background-color: var(--color-background-light);
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown pre code {
|
||||||
|
padding: 0;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown table {
|
||||||
|
margin: 14px 0;
|
||||||
|
border-collapse: collapse;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown th,
|
||||||
|
.docs-markdown td {
|
||||||
|
padding: 7px 10px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
text-align: left;
|
||||||
|
vertical-align: top;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown th {
|
||||||
|
background-color: var(--color-background-light);
|
||||||
}
|
}
|
||||||
@@ -34,19 +34,28 @@ onMounted(() => {
|
|||||||
z-index: 214748363;
|
z-index: 214748363;
|
||||||
|
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
|
background-color: var(--color-tooltip-background);
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
overflow: visible;
|
||||||
|
|
||||||
|
.context-menu-divider {
|
||||||
|
height: 1px;
|
||||||
|
margin: 4px 0;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
background-color: transparent;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
.context-menu-element {
|
.context-menu-element {
|
||||||
|
|
||||||
&:last-child {
|
&:last-child {
|
||||||
border-width: 1px 1px 1px 1px;
|
border-width: 1px 1px 1px 1px;
|
||||||
}
|
}
|
||||||
border: solid 1px var(--color-border);
|
border: solid 1px var(--color-border);
|
||||||
border-width: 1px 1px 0px 1px;
|
border-width: 1px 1px 0px 1px;
|
||||||
padding: 3px 5px 3px 5px;
|
padding: 6px 10px 6px 8px;
|
||||||
cursor: default;
|
cursor: default;
|
||||||
user-select: none;
|
user-select: none;
|
||||||
background-color: var(--tooltip-background);
|
background-color: var(--color-tooltip-background);
|
||||||
transition: background-color 100ms;
|
transition: background-color 100ms;
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
@@ -54,19 +63,37 @@ onMounted(() => {
|
|||||||
|
|
||||||
span {
|
span {
|
||||||
flex-grow: 1;
|
flex-grow: 1;
|
||||||
padding-right: 20px;
|
padding-right: 24px;
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
img {
|
img {
|
||||||
filter: invert(1);
|
filter: invert(1);
|
||||||
width: 18px;
|
width: 16px;
|
||||||
height: 18px;
|
height: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.context-menu-swatch {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
flex-grow: 0;
|
||||||
|
padding-right: 0;
|
||||||
|
border-radius: 4px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
flex-shrink: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
&:hover {
|
&:hover {
|
||||||
background-color: var(--color-background-softest);
|
background-color: var(--color-background-softest);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
> .context-menu {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:hover > .context-menu {
|
||||||
|
display: flex !important;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
@@ -1,25 +1,23 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
|
|
||||||
import { onMounted, ref } from 'vue';
|
import { computed, onMounted, ref } from 'vue';
|
||||||
|
|
||||||
import { AddSound } from '../../services/Sound';
|
import { AddSound } from '../../services/Sound';
|
||||||
import { useCampaignService } from '~/services/Campaign';
|
import { useCampaignService } from '~/services/Campaign';
|
||||||
import { ClearWindow } from '~/services/Windows';
|
import { ClearWindow, CreateChildWindow, GetFirstWindowId } from '~/services/Windows';
|
||||||
const { SetCampaign } = useCampaignService();
|
const { SetCampaign } = useCampaignService();
|
||||||
|
|
||||||
const props = defineProps(['data']);
|
const props = defineProps(['data']);
|
||||||
const data = props.data;
|
const data = props.data;
|
||||||
|
|
||||||
const title = ref("");
|
const title = computed(() => data.name);
|
||||||
|
const campaignStyle = computed(() => data.color
|
||||||
|
? { background: `linear-gradient(90deg, ${data.color}, ${data.color}44)` }
|
||||||
|
: {});
|
||||||
|
|
||||||
const container = ref(null);
|
const container = ref(null);
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
title.value = data.name;
|
|
||||||
if (data.color && container.value) {
|
|
||||||
container.value.style.background = `linear-gradient(90deg, ${data.color}, ${data.color}44)`;
|
|
||||||
}
|
|
||||||
|
|
||||||
AddSound(container.value)
|
AddSound(container.value)
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -27,11 +25,16 @@ function ViewCampaign(){
|
|||||||
SetCampaign(data);
|
SetCampaign(data);
|
||||||
ClearWindow({type: "main_menu"});
|
ClearWindow({type: "main_menu"});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function OpenSettings(){
|
||||||
|
ClearWindow({type: 'campaign_settings'});
|
||||||
|
CreateChildWindow(GetFirstWindowId('main_menu'), 'campaign_settings', { campaign: data });
|
||||||
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="campaign-entry-container" ref="container">
|
<div class="campaign-entry-container" ref="container" :style="campaignStyle">
|
||||||
<div class="main-campaign-entry-container-inner">
|
<div class="main-campaign-entry-container-inner">
|
||||||
<img class="campaign-icon" src="/img/def-avatar.jpg" draggable="false">
|
<img class="campaign-icon" src="/img/def-avatar.jpg" draggable="false">
|
||||||
<div class="campaign-info">
|
<div class="campaign-info">
|
||||||
@@ -39,6 +42,7 @@ function ViewCampaign(){
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="campaign-user-actions">
|
<div class="campaign-user-actions">
|
||||||
|
<button class="btn-primary button-small sound-click" v-on:click.prevent="OpenSettings">{{ $t('main-menu.settings') }}</button>
|
||||||
<button class="btn-primary button-small sound-click" v-on:click.prevent="ViewCampaign">{{ $t('general.open')}}</button>
|
<button class="btn-primary button-small sound-click" v-on:click.prevent="ViewCampaign">{{ $t('general.open')}}</button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -47,7 +51,6 @@ function ViewCampaign(){
|
|||||||
|
|
||||||
<style lang="scss" scoped>
|
<style lang="scss" scoped>
|
||||||
.button-small {
|
.button-small {
|
||||||
height: 32px;
|
|
||||||
padding: 10px;
|
padding: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -82,5 +85,7 @@ function ViewCampaign(){
|
|||||||
|
|
||||||
.campaign-user-actions {
|
.campaign-user-actions {
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
|
display: flex;
|
||||||
|
gap: 6px;
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -109,7 +109,6 @@ onMounted(() => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.button-small {
|
.button-small {
|
||||||
height: 32px;
|
|
||||||
padding: 10px;
|
padding: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
57
frontend/app/components/partials/EntryFolderRow.vue
Normal file
57
frontend/app/components/partials/EntryFolderRow.vue
Normal 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>
|
||||||
365
frontend/app/components/partials/NestedNoteList.vue
Normal file
365
frontend/app/components/partials/NestedNoteList.vue
Normal file
@@ -0,0 +1,365 @@
|
|||||||
|
<script setup>
|
||||||
|
import { ref, onBeforeUnmount, onMounted, watch } from 'vue';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
import { BuildColorMenu } from '~/services/EntryColors';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { CreateWindow } from '~/services/Windows';
|
||||||
|
import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu';
|
||||||
|
|
||||||
|
const props = defineProps({
|
||||||
|
folders: Array,
|
||||||
|
notes: Array,
|
||||||
|
campaignId: String,
|
||||||
|
level: { type: Number, default: 0 },
|
||||||
|
parentFolderId: String,
|
||||||
|
expandedFolderIds: { type: Array, default: () => [] }
|
||||||
|
});
|
||||||
|
|
||||||
|
const emit = defineEmits(['open-note', 'reload-notes']);
|
||||||
|
|
||||||
|
// Track which folder IDs have been requested to avoid duplicate requests
|
||||||
|
const loadingFolders = new Set();
|
||||||
|
const dragHoveredFolderId = ref(null);
|
||||||
|
|
||||||
|
// Cache of loaded folder contents — persists across reloads until cleared
|
||||||
|
// Each entry: { [folderId]: { notes: [], subfolders: [] } }
|
||||||
|
const folderContentCache = ref({});
|
||||||
|
|
||||||
|
function toggleExpanded(folderId) {
|
||||||
|
emit('toggle-expanded-folder', folderId);
|
||||||
|
}
|
||||||
|
|
||||||
|
watch(
|
||||||
|
() => props.expandedFolderIds,
|
||||||
|
() => {
|
||||||
|
if (props.level === 0) {
|
||||||
|
loadExpandedFolders();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{ deep: true }
|
||||||
|
);
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
loadExpandedFolders();
|
||||||
|
emitter.on('note-created', handleNoteCreated);
|
||||||
|
emitter.on('note-renamed', handleNoteRenamed);
|
||||||
|
emitter.on('delete-note', handleNoteDeleted);
|
||||||
|
emitter.on('folder-saved', handleFolderSaved);
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
emitter.off('note-created', handleNoteCreated);
|
||||||
|
emitter.off('note-renamed', handleNoteRenamed);
|
||||||
|
emitter.off('delete-note', handleNoteDeleted);
|
||||||
|
emitter.off('folder-saved', handleFolderSaved);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Keep this instance's folder content cache in sync with changes made anywhere in the app.
|
||||||
|
// The cache entry for a folder only lives on the instance that renders it, so every
|
||||||
|
// instance listens and updates whichever entries it owns.
|
||||||
|
function handleNoteCreated(note) {
|
||||||
|
if (!note) return;
|
||||||
|
const folderId = note.folder?._id ?? note.folder ?? null;
|
||||||
|
const entry = folderId ? folderContentCache.value[folderId] : null;
|
||||||
|
if (entry) {
|
||||||
|
entry.notes.unshift({ key: note._id, title: note.title, text: note.content || '' });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleNoteRenamed(data) {
|
||||||
|
if (!data) return;
|
||||||
|
for (const entry of Object.values(folderContentCache.value)) {
|
||||||
|
const note = entry.notes.find((n) => n.key === data.key);
|
||||||
|
if (note) note.title = data.title;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleNoteDeleted(noteKey) {
|
||||||
|
for (const entry of Object.values(folderContentCache.value)) {
|
||||||
|
entry.notes = entry.notes.filter((n) => n.key !== noteKey);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleFolderSaved(folder) {
|
||||||
|
const folderId = folder?._id ?? folder?.id;
|
||||||
|
if (!folderId) return;
|
||||||
|
for (const entry of Object.values(folderContentCache.value)) {
|
||||||
|
const subfolder = entry.subfolders.find((f) => (f._id ?? f.id) === folderId);
|
||||||
|
if (subfolder) subfolder.name = folder.name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadFolderContents(folderId) {
|
||||||
|
if (loadingFolders.has(folderId)) return;
|
||||||
|
loadingFolders.add(folderId);
|
||||||
|
|
||||||
|
Server().get('/note/subfolder/list', { params: { campaign: props.campaignId, folder: folderId } })
|
||||||
|
.then(res => {
|
||||||
|
if (res.data.status !== 'ok') return;
|
||||||
|
folderContentCache.value[folderId] = {
|
||||||
|
notes: res.data.notes.map(n => ({ key: n._id, title: n.title, text: n.content || '', color: n.color })),
|
||||||
|
subfolders: res.data.subfolders || []
|
||||||
|
};
|
||||||
|
}).catch(() => {}).finally(() => {
|
||||||
|
loadingFolders.delete(folderId);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function getFolderNotes(folderId) {
|
||||||
|
return folderContentCache.value[folderId]?.notes || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
function getFolderSubfolders(folderId) {
|
||||||
|
return folderContentCache.value[folderId]?.subfolders || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load contents for all currently-expanded folders
|
||||||
|
function loadExpandedFolders() {
|
||||||
|
const idsToLoad = props.level === 0
|
||||||
|
? props.expandedFolderIds
|
||||||
|
: (props.parentFolderId && props.expandedFolderIds.includes(props.parentFolderId) ? [props.parentFolderId] : []);
|
||||||
|
|
||||||
|
for (const id of idsToLoad) {
|
||||||
|
if (folderContentCache.value[id]) continue;
|
||||||
|
loadFolderContents(id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function handleDropNoteOnFolder(folderId, event) {
|
||||||
|
const noteKey = event.dataTransfer.getData('text/plain');
|
||||||
|
if (!noteKey || !folderId) return;
|
||||||
|
|
||||||
|
dragHoveredFolderId.value = null;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await Server().post('/note/update', { id: noteKey, folder: folderId });
|
||||||
|
clearCacheAndReloadExpanded();
|
||||||
|
} catch (e) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function handleDropNoteOnRoot(event) {
|
||||||
|
const noteKey = event.dataTransfer.getData('text/plain');
|
||||||
|
if (!noteKey) return;
|
||||||
|
|
||||||
|
dragHoveredFolderId.value = null;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await Server().post('/note/update', { id: noteKey, folder: null });
|
||||||
|
clearCacheAndReloadExpanded();
|
||||||
|
} catch (e) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Called on reload — clears cache and refetches what this instance is responsible for,
|
||||||
|
// then bubbles the reload up so ancestors (and eventually the sidebar) refresh too
|
||||||
|
function clearCacheAndReloadExpanded() {
|
||||||
|
const loadedIds = Object.keys(folderContentCache.value);
|
||||||
|
|
||||||
|
// Force reactivity by creating a new object
|
||||||
|
folderContentCache.value = {};
|
||||||
|
|
||||||
|
for (const id of loadedIds) {
|
||||||
|
loadFolderContents(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
emit('reload-notes');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exposed to parent components
|
||||||
|
defineExpose({ clearCacheAndReloadExpanded });
|
||||||
|
|
||||||
|
function startDragNote(event, note) {
|
||||||
|
event.dataTransfer.setData('text/plain', note.key);
|
||||||
|
event.dataTransfer.effectAllowed = 'move';
|
||||||
|
}
|
||||||
|
|
||||||
|
function setDragHover(id) {
|
||||||
|
dragHoveredFolderId.value = id;
|
||||||
|
}
|
||||||
|
|
||||||
|
function clearDragHover() {
|
||||||
|
dragHoveredFolderId.value = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildNoteContextMenu(note) {
|
||||||
|
return [
|
||||||
|
{ name: 'Open', icon: '/icons/iconoir/regular/book.svg', action: () => emit('open-note', note) },
|
||||||
|
{ name: 'Rename', icon: '/icons/iconoir/regular/edit-pencil.svg', action: () => renameNote(note) },
|
||||||
|
{ name: 'Color', icon: '/icons/iconoir/regular/palette.svg', context: buildColorMenu('note', note) },
|
||||||
|
{
|
||||||
|
name: 'Move to Folder...', icon: '/icons/iconoir/regular/folder.svg',
|
||||||
|
context: buildMoveToMenu(note)
|
||||||
|
},
|
||||||
|
{ divider: true },
|
||||||
|
{ name: 'Delete', icon: '/icons/iconoir/regular/trash.svg', action: () => deleteNote(note) }
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildFolderContextMenu(folder) {
|
||||||
|
if (!folder || !folder._id) return [];
|
||||||
|
return [
|
||||||
|
{ name: 'New Note Here', icon: '/icons/iconoir/regular/plus.svg', action: () => createNoteInFolder(folder._id) },
|
||||||
|
{ name: 'Rename', icon: '/icons/iconoir/regular/edit-pencil.svg', action: () => renameFolder(folder._id, folder.name) },
|
||||||
|
{ name: 'Color', icon: '/icons/iconoir/regular/palette.svg', context: buildColorMenu('folder', folder) },
|
||||||
|
{ name: 'Delete Folder', icon: '/icons/iconoir/regular/trash.svg', action: () => deleteFolder(folder._id) }
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildColorMenu(kind, item) {
|
||||||
|
return BuildColorMenu((color) => setEntryColor(kind, item, color));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function setEntryColor(kind, item, color) {
|
||||||
|
const isNote = kind === 'note';
|
||||||
|
try {
|
||||||
|
const response = await Server().post(isNote ? '/note/update' : '/folder/update', {
|
||||||
|
id: isNote ? item.key : item._id,
|
||||||
|
color
|
||||||
|
});
|
||||||
|
if (response.data.status !== 'ok') return;
|
||||||
|
item.color = color;
|
||||||
|
} catch (e) {} finally {
|
||||||
|
HideContextMenu();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function entryColorStyle(item) {
|
||||||
|
return item.color ? { '--entry-color': item.color } : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
let selectedNoteForMove = {};
|
||||||
|
|
||||||
|
function buildMoveToMenu(note) {
|
||||||
|
selectedNoteForMove = note;
|
||||||
|
const moveItems = (props.folders || []).map(folder => ({
|
||||||
|
name: folder.name, icon: '/icons/iconoir/regular/folder.svg', action: () => moveNoteToFolder(note, folder._id)
|
||||||
|
}));
|
||||||
|
|
||||||
|
if (moveItems.length > 0) moveItems.push({ divider: true });
|
||||||
|
|
||||||
|
moveItems.push({ name: '(Root)', icon: '/icons/iconoir/regular/book.svg', action: () => moveNoteToFolder(note, null) });
|
||||||
|
return moveItems;
|
||||||
|
}
|
||||||
|
|
||||||
|
function renameNote(note) { CreateWindow('rename_note', { title: note.title, key: note.key }); }
|
||||||
|
|
||||||
|
async function deleteNote(note) {
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/note/delete', { id: note.key });
|
||||||
|
if (response.data.status === 'ok') emitter.emit('delete-note', note.key);
|
||||||
|
} catch (error) {} finally {
|
||||||
|
HideContextMenu();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function renameFolder(folderId, name) { CreateWindow('new_folder', { folderId, campaign: props.campaignId, name }); }
|
||||||
|
|
||||||
|
async function deleteFolder(folderId) {
|
||||||
|
const response = await Server().post('/folder/delete', { id: folderId });
|
||||||
|
if (response.data.status === 'ok') {
|
||||||
|
emitter.emit('folder-deleted', folderId);
|
||||||
|
clearCacheAndReloadExpanded();
|
||||||
|
}
|
||||||
|
HideContextMenu();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function moveNoteToFolder(note, folderId) {
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/note/update', { id: note.key, folder: folderId || null });
|
||||||
|
if (response.data.status !== 'ok') return;
|
||||||
|
clearCacheAndReloadExpanded();
|
||||||
|
} catch (e) {}
|
||||||
|
HideContextMenu();
|
||||||
|
}
|
||||||
|
|
||||||
|
function createNoteInFolder(folderId) {
|
||||||
|
CreateWindow('new_note', { campaign: props.campaignId, folder: folderId });
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="nested-list" :class="'level-' + level">
|
||||||
|
<!-- Folders at this level -->
|
||||||
|
<template v-for="folder in folders" :key="folder._id">
|
||||||
|
<div class="folder-item" :class="{ 'drag-over': dragHoveredFolderId === folder._id }"
|
||||||
|
@dragover.prevent="setDragHover(folder._id)"
|
||||||
|
@dragleave.self="clearDragHover"
|
||||||
|
@drop.stop="handleDropNoteOnFolder(folder._id, $event)">
|
||||||
|
<button type="button" class="folder-toggle" :class="{ 'has-color': !!folder.color }" :style="entryColorStyle(folder)" @click="toggleExpanded(folder._id)" @contextmenu.prevent="ShowContextMenu(buildFolderContextMenu(folder))">
|
||||||
|
<img
|
||||||
|
class="folder-arrow"
|
||||||
|
:src="expandedFolderIds.includes(folder._id) ? '/icons/iconoir/regular/nav-arrow-down.svg' : '/icons/iconoir/regular/nav-arrow-right.svg'"
|
||||||
|
alt="" aria-hidden="true"
|
||||||
|
>
|
||||||
|
<img class="folder-icon" src="/icons/iconoir/regular/folder.svg" alt="">
|
||||||
|
<span class="folder-name">{{ folder.name }}</span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
<div v-show="expandedFolderIds.includes(folder._id)"
|
||||||
|
class="folder-children" :class="{ 'drag-over': dragHoveredFolderId === folder._id }"
|
||||||
|
@dragover.prevent="setDragHover(folder._id)" @dragleave.self="clearDragHover"
|
||||||
|
@drop.stop="handleDropNoteOnFolder(folder._id, $event)">
|
||||||
|
|
||||||
|
<!-- Load contents now — cache will be populated on demand -->
|
||||||
|
<template v-if="expandedFolderIds.includes(folder._id) && !folderContentCache[folder._id]">
|
||||||
|
<div class="sidebar-state" style="font-size:13px;opacity:0.6;">Loading...</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<NestedNoteList
|
||||||
|
v-if="expandedFolderIds.includes(folder._id)"
|
||||||
|
:folders="getFolderSubfolders(folder._id)"
|
||||||
|
:notes="getFolderNotes(folder._id)"
|
||||||
|
:campaign-id="campaignId"
|
||||||
|
:level="level + 1"
|
||||||
|
:parent-folder-id="folder._id"
|
||||||
|
:expanded-folder-ids="expandedFolderIds"
|
||||||
|
@open-note="$emit('open-note', $event)"
|
||||||
|
@reload-notes="clearCacheAndReloadExpanded"
|
||||||
|
@toggle-expanded-folder="toggleExpanded"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<!-- Notes at this level -->
|
||||||
|
<template v-for="note in notes" :key="note.key">
|
||||||
|
<button type="button" class="note-link" :class="{ 'has-color': !!note.color }" :style="entryColorStyle(note)" draggable="true" @dragstart="startDragNote($event, note)" @click.stop="$emit('open-note', note)" @contextmenu.prevent="ShowContextMenu(buildNoteContextMenu(note))">
|
||||||
|
<span class="note-link-title">{{ note.title }}</span>
|
||||||
|
</button>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<!-- Drop zone for root-level notes -->
|
||||||
|
<div v-if="level === 0" class="root-drop-zone" :class="{ 'drag-over': dragHoveredFolderId === 'root' }" @drop.stop="handleDropNoteOnRoot($event)">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div v-if="folders.length === 0 && (!notes || notes.length === 0) && level === 0" class="sidebar-state">Empty</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.nested-list { display: flex; flex-direction: column; gap: 2px; }
|
||||||
|
|
||||||
|
.folder-item { display: flex; flex-direction: column; cursor: default; border-radius: 10px; }
|
||||||
|
.folder-item.drag-over { background: var(--color-button-hover); }
|
||||||
|
|
||||||
|
.folder-toggle { width: 100%; padding: 6px 8px; margin: 0; border: none; background: transparent; display: flex; align-items: center; gap: 6px; cursor: grab; border-radius: 10px; color: var(--color-text); font-size: inherit; transition: background-color 0.15s ease; }
|
||||||
|
.folder-toggle:hover { background: var(--color-background-soft); }
|
||||||
|
.folder-toggle.has-color { background: color-mix(in srgb, var(--entry-color) 32%, transparent); }
|
||||||
|
.folder-toggle.has-color:hover { background: color-mix(in srgb, var(--entry-color) 50%, transparent); }
|
||||||
|
|
||||||
|
.folder-arrow { width: 14px; height: 14px; filter: invert(var(--color-icon-invert)); opacity: 0.5; }
|
||||||
|
.folder-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
|
||||||
|
.folder-name { font-weight: 500; flex: 1; text-align: left; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
|
||||||
|
|
||||||
|
.folder-children { padding-left: 20px; margin-top: 2px; cursor: default; }
|
||||||
|
.folder-children.drag-over { background: #ffffff22; border-radius: 10px; }
|
||||||
|
|
||||||
|
.note-link { width: 100%; padding: 6px; margin: 0; box-shadow: none; border: none; display: flex; flex-direction: column; align-items: flex-start; text-align: left; cursor: grab; border-radius: 8px; }
|
||||||
|
.note-link.has-color { background: color-mix(in srgb, var(--entry-color) 32%, transparent); }
|
||||||
|
.note-link.has-color:hover { background: color-mix(in srgb, var(--entry-color) 50%, transparent); }
|
||||||
|
.note-link-title { font-weight: 600; word-break: break-word; }
|
||||||
|
|
||||||
|
.sidebar-state { padding: 12px; border-radius: 10px; background: var(--color-background-soft); font-size: 14px; }
|
||||||
|
|
||||||
|
.root-drop-zone { min-height: 24px; position: relative; transition: background-color 0.15s ease, border-color 0.15s ease; border-radius: 10px; }
|
||||||
|
.root-drop-zone.drag-over { background: var(--color-button-hover); }
|
||||||
|
</style>
|
||||||
@@ -1,47 +1,33 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import TopSearchBar from './topbar/TopSearchBar.vue';
|
import TopSearchBar from './topbar/TopSearchBar.vue';
|
||||||
import { useCampaignService } from '~/services/Campaign';
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
import { CreateWindow } from '~/services/Windows';
|
import { SetShowContent } from '~/services/Content.js';
|
||||||
import { SetShowContent } from '~/services/Content';
|
import { ClearWindow, CreateWindow } from '~/services/Windows';
|
||||||
|
|
||||||
const { Campaign, SetCampaign } = useCampaignService();
|
const { Campaign, SetCampaign } = useCampaignService();
|
||||||
|
const campaignName = computed(() => Campaign.value?.name || 'Campaign');
|
||||||
|
|
||||||
const campaignName = computed(() => {
|
function OpenCampaignSettings() {
|
||||||
return Campaign.value?.name ?? 'Campaign';
|
if (!Campaign.value) return;
|
||||||
});
|
ClearWindow({ type: 'campaign_settings' });
|
||||||
|
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
||||||
async function createNote() {
|
|
||||||
if (!Campaign.value) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const campaignId = Campaign.value?._id
|
|
||||||
|
|
||||||
try {
|
|
||||||
const response = await Server().post('/note/create', {
|
|
||||||
title: 'New note',
|
|
||||||
content: content.value,
|
|
||||||
campaign: campaignId
|
|
||||||
});
|
|
||||||
|
|
||||||
if (response.data.status !== 'ok') {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
emitter.emit('note-created', response.data.note);
|
|
||||||
} catch (err) {
|
|
||||||
error.value = 'Unable to create note.';
|
|
||||||
} finally {
|
|
||||||
isSaving.value = false;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function exitToMainMenu() {
|
function OpenDocumentation() {
|
||||||
|
// La documentació és una finestra que va davant de l'espai de treball, així que les notes
|
||||||
|
// obertes no es perden. CreateWindow deixa sola una finestra que ja és oberta: tornar a
|
||||||
|
// prémer el botó no la torna a la primera pàgina.
|
||||||
|
CreateWindow('documentation');
|
||||||
|
}
|
||||||
|
|
||||||
|
function ExitCampaign() {
|
||||||
|
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
||||||
|
// l'espai de treball i reobre el menú
|
||||||
|
ClearWindow({ type: 'campaign_settings' });
|
||||||
SetCampaign(null);
|
SetCampaign(null);
|
||||||
SetShowContent(false);
|
SetShowContent(false);
|
||||||
CreateWindow('main_menu');
|
CreateWindow('main_menu');
|
||||||
}
|
}
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
@@ -56,13 +42,16 @@ function exitToMainMenu() {
|
|||||||
<TopSearchBar></TopSearchBar>
|
<TopSearchBar></TopSearchBar>
|
||||||
</div>
|
</div>
|
||||||
<div class="right">
|
<div class="right">
|
||||||
<button class="top-bar-button sound-click" type="button" @click="exitToMainMenu">
|
<!-- La documentació s'obre en una finestra seva, davant de la campanya: les notes
|
||||||
<img class="top-bar-button-icon" src="/icons/iconoir/regular/nav-arrow-left.svg" alt="" aria-hidden="true">
|
obertes no es perden i no cal obrir una pestanya nova. -->
|
||||||
<span>Main Menu</span>
|
<button class="btn-primary settings-button docs-button sound-click" type="button" @click="OpenDocumentation">
|
||||||
|
{{ $t('main-menu.documentation') }}
|
||||||
</button>
|
</button>
|
||||||
<button class="note-button sound-click" type="button" @click="createNote" :disabled="!Campaign">
|
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
||||||
<img class="note-button-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
{{ $t('main-menu.settings') }}
|
||||||
<span>New Note</span>
|
</button>
|
||||||
|
<button class="btn-primary settings-button exit-button sound-click" type="button" @click="ExitCampaign">
|
||||||
|
{{ $t('main-menu.exit') }}
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -86,16 +75,26 @@ function exitToMainMenu() {
|
|||||||
left: 6px;
|
left: 6px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.left, .right {
|
.left {
|
||||||
flex: 1;
|
flex: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.center {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
.right {
|
.right {
|
||||||
display: flex;
|
display: flex;
|
||||||
justify-content: flex-end;
|
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
justify-content: flex-end;
|
||||||
|
flex: 1;
|
||||||
|
padding: 0 10px;
|
||||||
gap: 8px;
|
gap: 8px;
|
||||||
padding-right: 10px;
|
}
|
||||||
|
|
||||||
|
.settings-button {
|
||||||
|
padding: 5px 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.top-bar-title {
|
.top-bar-title {
|
||||||
@@ -105,27 +104,5 @@ function exitToMainMenu() {
|
|||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
.top-bar-button,
|
|
||||||
.note-button {
|
|
||||||
height: 30px;
|
|
||||||
padding: 0 12px;
|
|
||||||
border: 1px solid var(--color-border);
|
|
||||||
border-radius: 8px;
|
|
||||||
background: var(--color-background-soft);
|
|
||||||
display: inline-flex;
|
|
||||||
align-items: center;
|
|
||||||
gap: 8px;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
.note-button:disabled {
|
|
||||||
opacity: 0.5;
|
|
||||||
cursor: not-allowed;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar-button-icon,
|
|
||||||
.note-button-icon {
|
|
||||||
width: 16px;
|
|
||||||
height: 16px;
|
|
||||||
}
|
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -1,13 +1,30 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import NoteContainer from './NoteContainer.vue';
|
import NoteContainer from './NoteContainer.vue';
|
||||||
|
import MapViewerPane from '../map/MapViewerPane.vue';
|
||||||
|
|
||||||
|
import { ActivePane, AnchoredMap, ClearAnchoredMap } from '~/services/Content.js';
|
||||||
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
import { CreateWindow } from '~/services/Windows';
|
||||||
|
|
||||||
|
const { Campaign } = useCampaignService();
|
||||||
|
|
||||||
|
// Detaching gives the map back a floating window and shows the open notes again.
|
||||||
|
function DetachMap() {
|
||||||
|
const map = AnchoredMap.value;
|
||||||
|
if (!map) return;
|
||||||
|
ClearAnchoredMap();
|
||||||
|
CreateWindow('map_viewer', { map, campaign: Campaign.value?._id ?? null });
|
||||||
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<NoteContainer>
|
<NoteContainer v-show="ActivePane !== 'map'">
|
||||||
|
|
||||||
</NoteContainer>
|
</NoteContainer>
|
||||||
|
<div v-if="AnchoredMap" v-show="ActivePane === 'map'" class="anchored-map">
|
||||||
|
<MapViewerPane :map="AnchoredMap" anchored @detach="DetachMap"></MapViewerPane>
|
||||||
|
</div>
|
||||||
<!-- PowerMod -->
|
<!-- PowerMod -->
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
@@ -21,4 +38,14 @@ import NoteContainer from './NoteContainer.vue';
|
|||||||
align-items: center;
|
align-items: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
</style>
|
/* Hidden with v-show so the open notes stay mounted while the anchored map is displayed. */
|
||||||
|
.anchored-map {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
min-width: 0;
|
||||||
|
flex-grow: 1;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
|||||||
@@ -5,64 +5,122 @@ import { emitter } from '~/services/Emitter';
|
|||||||
import { GetWidget, ParseMarkdown } from '~/services/Marker';
|
import { GetWidget, ParseMarkdown } from '~/services/Marker';
|
||||||
import Server from '~/services/Server';
|
import Server from '~/services/Server';
|
||||||
import { DisplayToast } from '~/services/Toaster';
|
import { DisplayToast } from '~/services/Toaster';
|
||||||
|
import { useI18n } from 'vue-i18n';
|
||||||
import TestWidget from '../widgets/TestWidget.vue';
|
import TestWidget from '../widgets/TestWidget.vue';
|
||||||
|
|
||||||
// import { GetNote, GetContent } from '@/services/Content';
|
// import { GetNote, GetContent } from '@/services/Content';
|
||||||
const props = defineProps(['text', 'title', 'noteKey']);
|
const props = defineProps(['text', 'title', 'noteKey']);
|
||||||
|
const { t } = useI18n();
|
||||||
const noteContent = ref(null); // Markdown text
|
const noteContent = ref(null); // Markdown text
|
||||||
|
const renderedContent = ref(null); // Container holding the compiled HTML (v-html)
|
||||||
|
|
||||||
const sourceText = ref(''); // Original markdown source, used for editing
|
const sourceText = ref(''); // Original markdown source, used for editing
|
||||||
const displayText = ref(''); // Compiled HTML from markdown
|
const displayText = ref(''); // Compiled HTML from markdown
|
||||||
|
|
||||||
const editingMode = ref(false);
|
const editingMode = ref(false);
|
||||||
const editableTitle = ref(null);
|
|
||||||
const title = ref(props.title);
|
const title = ref(props.title);
|
||||||
const displayTitle = ref('');
|
const isDirty = ref(false);
|
||||||
|
const showClose = ref(false);
|
||||||
|
|
||||||
|
let savedState = { text: '', title: '' };
|
||||||
|
|
||||||
|
function markDirty() {
|
||||||
|
isDirty.value = sourceText.value !== savedState.text || title.value !== savedState.title;
|
||||||
|
}
|
||||||
|
|
||||||
function closeNote(){
|
function closeNote(){
|
||||||
emitter.emit('delete-note', props.noteKey);
|
// 'close-note' only closes the opened note; 'delete-note' is reserved for
|
||||||
|
// actual deletions (sidebar removal happens on that event instead)
|
||||||
|
emitter.emit('close-note', props.noteKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
const compiledMarkdown = computed(() => {
|
const compiledMarkdown = computed(() => {
|
||||||
return ParseMarkdown(sourceText.value);
|
return ParseMarkdown(sourceText.value);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Apps de widget muntades sobre aquest node. Les guardem per desmuntar-les
|
||||||
|
// abans de re-renderitzar o en desmuntar la nota (evita instancies orfes i
|
||||||
|
// que Vue intenti parchar nodes ja eliminats).
|
||||||
|
const mountedApps = [];
|
||||||
|
|
||||||
|
function unmountComponents() {
|
||||||
|
for (const app of mountedApps) {
|
||||||
|
try {
|
||||||
|
app.unmount();
|
||||||
|
} catch (err) {
|
||||||
|
// El contenidor pot ja no ser al DOM; ignorem i netegim igualment.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
mountedApps.length = 0;
|
||||||
|
}
|
||||||
|
|
||||||
function mountComponents() {
|
function mountComponents() {
|
||||||
// Should no need more
|
// Només dins d'aquesta nota: evitar muntar (o tornari a muntar) widgets
|
||||||
|
// d'altres notes obertes, que ja tenen la seva app.
|
||||||
|
const root = renderedContent.value;
|
||||||
|
if (!root) return;
|
||||||
|
|
||||||
const widget_types = ['display', 'inline'];
|
const widget_types = ['display', 'inline'];
|
||||||
widget_types.forEach((widget_type) => {
|
widget_types.forEach((widget_type) => {
|
||||||
const nodes = document.querySelectorAll('.vue-component-' + widget_type);
|
const nodes = root.querySelectorAll('.vue-component-' + widget_type);
|
||||||
nodes.forEach(el => {
|
nodes.forEach(el => {
|
||||||
const app = createApp(GetWidget(widget_type, el.dataset.component), { content: el.dataset.content });
|
const widget = GetWidget(widget_type, el.dataset.component);
|
||||||
app.mount(el);
|
if (!widget) return; // widget desconegut: saltem en comptes de petar
|
||||||
|
try {
|
||||||
|
const app = createApp(widget, { content: el.dataset.content });
|
||||||
|
// Evita que un error dins del widget (p. ex. el parser de daus amb una
|
||||||
|
// expressio malformada) es converteixi en un error no controlat.
|
||||||
|
app.config.errorHandler = (err) => {
|
||||||
|
console.error('Widget error', el.dataset.component, err);
|
||||||
|
};
|
||||||
|
app.mount(el);
|
||||||
|
mountedApps.push(app);
|
||||||
|
} catch (err) {
|
||||||
|
console.error('Failed to mount widget', el.dataset.component, err);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
///
|
///
|
||||||
|
|
||||||
function update(){
|
function update(){
|
||||||
|
// Desmuntem les apps anteriors mentre els seus nodes encara son al DOM;
|
||||||
|
// la reassignacio de displayText (v-html) eliminaria els contenidors i
|
||||||
|
// desmuntar-les despres fallaria sobre nodes desaccelats.
|
||||||
|
unmountComponents();
|
||||||
displayText.value = compiledMarkdown.value;
|
displayText.value = compiledMarkdown.value;
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
|
setupHeadings();
|
||||||
setupCallout()
|
setupCallout()
|
||||||
mountComponents();
|
mountComponents();
|
||||||
}, 0);
|
}, 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
watch(sourceText, (newText) => {
|
watch(sourceText, markDirty);
|
||||||
// update();
|
|
||||||
});
|
watch(title, markDirty);
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
sourceText.value = props.text;
|
sourceText.value = props.text;
|
||||||
title.value = props.title;
|
title.value = props.title;
|
||||||
displayTitle.value = props.title;
|
|
||||||
|
savedState = { text: props.text, title: props.title };
|
||||||
|
emitter.on('title-updated', handleTitleUpdate);
|
||||||
// window.addEventListener('keydown', handleKeydown);
|
// window.addEventListener('keydown', handleKeydown);
|
||||||
setTimeout(() => setupCallout(), 0);
|
setTimeout(() => setupCallout(), 0);
|
||||||
update();
|
update();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
function handleTitleUpdate(data) {
|
||||||
|
if (data.key !== props.noteKey) return;
|
||||||
|
title.value = data.title;
|
||||||
|
savedState.title = data.title;
|
||||||
|
}
|
||||||
|
|
||||||
onUnmounted(() => {
|
onUnmounted(() => {
|
||||||
|
emitter.off('title-updated', handleTitleUpdate);
|
||||||
// window.removeEventListener('keydown', handleKeydown);
|
// window.removeEventListener('keydown', handleKeydown);
|
||||||
|
unmountComponents();
|
||||||
});
|
});
|
||||||
|
|
||||||
function handleKeydown(e) {
|
function handleKeydown(e) {
|
||||||
@@ -73,6 +131,10 @@ function handleKeydown(e) {
|
|||||||
if(!editingMode.value){
|
if(!editingMode.value){
|
||||||
update();
|
update();
|
||||||
SaveNote(); // Save when switching to display mode
|
SaveNote(); // Save when switching to display mode
|
||||||
|
} else {
|
||||||
|
// Entrant en mode edicio, la vista prèvia (v-else) es destrueix;
|
||||||
|
// desmuntem els widgets per no deixar apps orfes.
|
||||||
|
unmountComponents();
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -92,12 +154,17 @@ function SaveNote(){
|
|||||||
title: title.value,
|
title: title.value,
|
||||||
}).then((response) => {
|
}).then((response) => {
|
||||||
if(response.data.status !== 'ok'){
|
if(response.data.status !== 'ok'){
|
||||||
// Handle error (e.g., show a notification)
|
// El contingut no s'ha guardat: mantenem el punt de "no desar" i
|
||||||
|
// avisem en lloc d'empassar-nos l'error silenciosament.
|
||||||
|
isDirty.value = true;
|
||||||
|
DisplayToast('red', t(response.data.msg || 'general.notes.save-error'), 3000);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// DisplayToast('green', "Note saved successfully.", 500);
|
savedState = { text: sourceText.value, title: title.value };
|
||||||
|
isDirty.value = false;
|
||||||
}).catch((error) => {
|
}).catch((error) => {
|
||||||
// Handle error (e.g., show a notification)
|
isDirty.value = true;
|
||||||
|
DisplayToast('red', t('general.notes.save-error'), 3000);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -146,17 +213,113 @@ function setupCallout() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Col·lapse de seccions (h1, h2, h3) a la vista prèvia ---
|
||||||
const editTitle = (e) => {
|
// Agrupa el contingut sota cada capçalera fins la seguent del mateix nivell o
|
||||||
title.value = e.target.innerText;
|
// superior, de manera que en fer clic sobre la capçalera es plegui tota la seva
|
||||||
|
// secció (les sub-seccions s'hi inclouen, estil Obsidian).
|
||||||
|
function headingLevel(el) {
|
||||||
|
const tag = el && el.tagName;
|
||||||
|
if (tag === 'H1') return 1;
|
||||||
|
if (tag === 'H2') return 2;
|
||||||
|
if (tag === 'H3') return 3;
|
||||||
|
return 0; // h4+ i la resta es tracten com a contingut normal
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function buildFoldTree(nodes) {
|
||||||
|
const pos = { i: 0 };
|
||||||
|
|
||||||
|
function parseSection(level) {
|
||||||
|
const heading = nodes[pos.i];
|
||||||
|
pos.i++;
|
||||||
|
const body = [];
|
||||||
|
while (pos.i < nodes.length) {
|
||||||
|
const lvl = headingLevel(nodes[pos.i]);
|
||||||
|
if (lvl && lvl <= level) break; // seguent secció del mateix nivell o superior
|
||||||
|
if (lvl) {
|
||||||
|
body.push(parseSection(lvl)); // sub-secció més profunda
|
||||||
|
} else {
|
||||||
|
body.push({ node: nodes[pos.i] });
|
||||||
|
pos.i++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { heading, body, level };
|
||||||
|
}
|
||||||
|
|
||||||
|
const top = [];
|
||||||
|
while (pos.i < nodes.length) {
|
||||||
|
const lvl = headingLevel(nodes[pos.i]);
|
||||||
|
if (lvl) {
|
||||||
|
top.push(parseSection(lvl));
|
||||||
|
} else {
|
||||||
|
top.push({ node: nodes[pos.i] });
|
||||||
|
pos.i++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return top;
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderFoldTree(items, target) {
|
||||||
|
for (const item of items) {
|
||||||
|
if (item.node) {
|
||||||
|
target.appendChild(item.node);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const wrapper = document.createElement('div');
|
||||||
|
wrapper.className = 'fold fold-h' + item.level;
|
||||||
|
item.heading.classList.add('fold-handle');
|
||||||
|
wrapper.appendChild(item.heading);
|
||||||
|
|
||||||
|
const body = document.createElement('div');
|
||||||
|
body.className = 'fold-body';
|
||||||
|
renderFoldTree(item.body, body);
|
||||||
|
wrapper.appendChild(body);
|
||||||
|
|
||||||
|
target.appendChild(wrapper);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleFoldClick(e) {
|
||||||
|
// No plegar quan es fa clic en un enllaç o se selecciona text
|
||||||
|
if (e.target.closest('a')) return;
|
||||||
|
const selection = window.getSelection();
|
||||||
|
if (selection && selection.toString()) return;
|
||||||
|
|
||||||
|
const handle = e.target.closest('.fold-handle');
|
||||||
|
if (!handle) return;
|
||||||
|
const wrapper = handle.parentElement;
|
||||||
|
if (!wrapper || !wrapper.classList.contains('fold')) return;
|
||||||
|
wrapper.classList.toggle('is-collapsed');
|
||||||
|
}
|
||||||
|
|
||||||
|
function setupHeadings() {
|
||||||
|
const container = renderedContent.value;
|
||||||
|
if (!container) return;
|
||||||
|
|
||||||
|
const nodes = Array.from(container.children);
|
||||||
|
if (!nodes.some((el) => headingLevel(el))) return;
|
||||||
|
|
||||||
|
const tree = buildFoldTree(nodes);
|
||||||
|
renderFoldTree(tree, container);
|
||||||
|
|
||||||
|
if (!container._foldBound) {
|
||||||
|
container.addEventListener('click', handleFoldClick);
|
||||||
|
container._foldBound = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="note" @keydown="handleKeydown" tabindex="0">
|
<div class="note" @keydown="handleKeydown" tabindex="0">
|
||||||
<div class="note-stunt">
|
<div class="note-stunt">
|
||||||
<div class="close-button" v-on:click="closeNote">
|
<div class="unsaved-wrapper" v-if="isDirty">
|
||||||
|
<div class="unsaved-dot"></div>
|
||||||
|
<div class="close-button close-hidden" v-on:click="closeNote">
|
||||||
|
<img class="icon" src="/icons/Pixelarticons/white/close.svg" alt="My Happy SVG"/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="close-button" v-else v-on:click="closeNote">
|
||||||
<img class="icon" src="/icons/Pixelarticons/white/close.svg" alt="My Happy SVG"/>
|
<img class="icon" src="/icons/Pixelarticons/white/close.svg" alt="My Happy SVG"/>
|
||||||
</div>
|
</div>
|
||||||
<span>{{ title }}</span>
|
<span>{{ title }}</span>
|
||||||
@@ -164,8 +327,8 @@ const editTitle = (e) => {
|
|||||||
<div class="note-content-container">
|
<div class="note-content-container">
|
||||||
<textarea v-model="sourceText" class="full-editor" v-if="editingMode"></textarea>
|
<textarea v-model="sourceText" class="full-editor" v-if="editingMode"></textarea>
|
||||||
<div v-else class="note-content" ref="noteContent">
|
<div v-else class="note-content" ref="noteContent">
|
||||||
<h1 contenteditable="true" ref="editableTitle" @input="editTitle">{{ displayTitle }}</h1>
|
<h1>{{ title }}</h1>
|
||||||
<div ref="noteContent" v-html="displayText"></div>
|
<div ref="renderedContent" v-html="displayText"></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -184,6 +347,46 @@ const editTitle = (e) => {
|
|||||||
user-select: none;
|
user-select: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.unsaved-wrapper {
|
||||||
|
position: relative;
|
||||||
|
margin-bottom: 5px;
|
||||||
|
width: 20px;
|
||||||
|
height: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.unsaved-dot {
|
||||||
|
width: 10px;
|
||||||
|
height: 10px;
|
||||||
|
border-radius: 50%;
|
||||||
|
background-color: #ffffff;
|
||||||
|
position: absolute;
|
||||||
|
top: 50%;
|
||||||
|
left: 50%;
|
||||||
|
transform: translate(-50%, -50%);
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.close-hidden {
|
||||||
|
opacity: 0;
|
||||||
|
visibility: hidden;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
width: 20px;
|
||||||
|
height: 20px;
|
||||||
|
margin-bottom: 0;
|
||||||
|
transition: opacity 0.15s ease, visibility 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.unsaved-wrapper:hover .close-hidden {
|
||||||
|
opacity: 1;
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
.unsaved-wrapper:hover .unsaved-dot {
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
.full-editor {
|
.full-editor {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
height: 100%;
|
height: 100%;
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
import { onMounted, onUnmounted, ref } from 'vue';
|
import { onMounted, onUnmounted, ref } from 'vue';
|
||||||
import Note from './Note.vue';
|
import Note from './Note.vue';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
|
import { SetActivePane } from '~/services/Content.js';
|
||||||
|
|
||||||
let noteData = ref([]);
|
let noteData = ref([]);
|
||||||
|
|
||||||
@@ -34,6 +35,9 @@ function pushNote(note){
|
|||||||
}
|
}
|
||||||
|
|
||||||
function handlePushNote(note) {
|
function handlePushNote(note) {
|
||||||
|
// A note opened from the sidebar or the search palette always comes to the front, even when
|
||||||
|
// the content area is showing an anchored map.
|
||||||
|
SetActivePane('notes');
|
||||||
pushNote(note);
|
pushNote(note);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -47,12 +51,23 @@ function handleDeleteNote(key) {
|
|||||||
// Moure aixo
|
// Moure aixo
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
emitter.on("push-note", handlePushNote);
|
emitter.on("push-note", handlePushNote);
|
||||||
|
emitter.on("close-note", handleDeleteNote);
|
||||||
emitter.on("delete-note", handleDeleteNote);
|
emitter.on("delete-note", handleDeleteNote);
|
||||||
|
emitter.on("title-updated", handleTitleUpdated);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
function handleTitleUpdated(data) {
|
||||||
|
const note = noteData.value.find(n => n.key === data.key);
|
||||||
|
if (note) {
|
||||||
|
note.title = data.title;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
onUnmounted(() => {
|
onUnmounted(() => {
|
||||||
emitter.off("push-note", handlePushNote);
|
emitter.off("push-note", handlePushNote);
|
||||||
|
emitter.off("close-note", handleDeleteNote);
|
||||||
emitter.off("delete-note", handleDeleteNote);
|
emitter.off("delete-note", handleDeleteNote);
|
||||||
|
emitter.off("title-updated", handleTitleUpdated);
|
||||||
});
|
});
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
1010
frontend/app/components/viewer/map/MapViewerPane.vue
Normal file
1010
frontend/app/components/viewer/map/MapViewerPane.vue
Normal file
File diff suppressed because it is too large
Load Diff
75
frontend/app/components/viewer/topbar/SearchResult.vue
Normal file
75
frontend/app/components/viewer/topbar/SearchResult.vue
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
<script setup>
|
||||||
|
const props = defineProps({
|
||||||
|
title: { type: String, default: '' },
|
||||||
|
subtitle: { type: String, default: '' },
|
||||||
|
link: { type: String, default: '' },
|
||||||
|
icon: { type: String, default: '' }
|
||||||
|
});
|
||||||
|
|
||||||
|
const emit = defineEmits(['select']);
|
||||||
|
|
||||||
|
function handleSelect() {
|
||||||
|
emit('select', { title: props.title, subtitle: props.subtitle, link: props.link });
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<button class="search-result" @click="handleSelect">
|
||||||
|
<div class="search-result-left">
|
||||||
|
<img v-if="icon" class="result-icon" :src="icon" alt="">
|
||||||
|
<span class="result-title">{{ title }}</span>
|
||||||
|
</div>
|
||||||
|
<span v-if="subtitle" class="result-subtitle">{{ subtitle }}</span>
|
||||||
|
</button>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.search-result {
|
||||||
|
width: 100%;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
padding: 8px 12px;
|
||||||
|
background: none;
|
||||||
|
border: none;
|
||||||
|
border-radius: 4px;
|
||||||
|
cursor: pointer;
|
||||||
|
color: inherit;
|
||||||
|
text-align: left;
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: 14px;
|
||||||
|
transition: background-color 0.1s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result:hover,
|
||||||
|
.search-result.selected {
|
||||||
|
background-color: var(--color-search-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-left {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.result-icon {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
filter: invert(var(--color-icon-invert));
|
||||||
|
opacity: 0.6;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.result-title {
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.result-subtitle {
|
||||||
|
font-size: 12px;
|
||||||
|
opacity: 0.5;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -1,110 +1,382 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
|
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 { ref, onMounted } from 'vue';
|
import NoteSearchResult from './SearchResult.vue';
|
||||||
import { GetArrayContent, GetContent } from '@/services/Content';
|
import Server from '~/services/Server';
|
||||||
import useEmitter from '@/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
|
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 { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
|
||||||
const emitter = useEmitter();
|
const { Campaign } = useCampaignService();
|
||||||
|
const { t } = useI18n();
|
||||||
|
|
||||||
import NoteSearchElement from "@/components/topbar/NoteSearchElement.vue";
|
const inputText = ref('');
|
||||||
|
|
||||||
let noteLinks = ref([]);
|
// Everything the palette searches: the campaign's notes, actors, items and maps.
|
||||||
let searchContainer = ref(null);
|
const notes = ref([]);
|
||||||
|
const actors = ref([]);
|
||||||
|
const items = ref([]);
|
||||||
|
const maps = ref([]);
|
||||||
|
|
||||||
emitter.on("hide-search-container", () => {
|
const showResults = ref(false);
|
||||||
searchContainer.value.style.display = "none";
|
const selectedIndex = ref(-1);
|
||||||
})
|
|
||||||
|
|
||||||
function updateList(event){
|
const focusInput = ref(null);
|
||||||
let content = GetArrayContent();
|
|
||||||
let query = "";
|
|
||||||
if(event !== undefined) query = event.target.value;
|
|
||||||
let filter = query.normalize("NFD").replace(/[\u0300-\u036f]/g, "").toUpperCase().trim();
|
|
||||||
|
|
||||||
noteLinks.value = content.filter((noteInfo) => {
|
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
|
||||||
return noteInfo["title"].normalize("NFD").replace(/[\u0300-\u036f]/g, "").toUpperCase().indexOf(filter) > -1;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function searchFocus(event){
|
// The lists belong to one campaign; when another one opens they are dropped and refetched.
|
||||||
if(GetContent() === undefined) return;
|
watch(campaignId, () => {
|
||||||
|
notes.value = [];
|
||||||
searchContainer.value.style.display = "";
|
actors.value = [];
|
||||||
updateList(undefined);
|
items.value = [];
|
||||||
}
|
maps.value = [];
|
||||||
|
});
|
||||||
onMounted(() => {
|
|
||||||
|
// ---- Keyboard shortcut to open search ----
|
||||||
|
function globalKeydown(e) {
|
||||||
|
const modKey = e.metaKey || e.ctrlKey;
|
||||||
|
if ((modKey && e.key === 'k') || (e.key === '/' && !isInputFocused())) {
|
||||||
|
e.preventDefault();
|
||||||
|
focusInput.value?.focus();
|
||||||
|
}
|
||||||
|
if (e.key === 'Escape' && showResults.value) {
|
||||||
|
closeResults();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function isInputFocused() {
|
||||||
|
const tag = document.activeElement?.tagName.toLowerCase();
|
||||||
|
return tag === 'input' || tag === 'textarea' || document.activeElement?.isContentEditable;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Registration of create-note action (extensibile for future commands) ----
|
||||||
|
function registerCreateNoteAction() {
|
||||||
|
const action = {
|
||||||
|
id: 'create_note',
|
||||||
|
label: 'New note',
|
||||||
|
description: 'Create a new note in the current campaign',
|
||||||
|
execute: () => {
|
||||||
|
if (!Campaign.value) return;
|
||||||
|
const campaignId = Campaign.value?._id ?? Campaign.value?.id;
|
||||||
|
CreateWindow('new_note', { campaign: campaignId });
|
||||||
|
}
|
||||||
|
};
|
||||||
|
register(action);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Campaign entries to search ----
|
||||||
|
// The same accent- and case-insensitive normalisation the action filter uses, so a match is
|
||||||
|
// never hidden by how the name was written.
|
||||||
|
function normalize(text) {
|
||||||
|
return (text || '').normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function fetchList(path, key) {
|
||||||
|
try {
|
||||||
|
const response = await Server().get(path, { params: { campaign: campaignId.value } });
|
||||||
|
if (response.data.status !== 'ok') return [];
|
||||||
|
return response.data[key] ?? [];
|
||||||
|
} catch (err) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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,
|
||||||
|
title: n.title || 'Untitled',
|
||||||
|
date: n.date
|
||||||
|
}));
|
||||||
|
actors.value = fetchedActors;
|
||||||
|
items.value = fetchedItems;
|
||||||
|
maps.value = fetchedMaps;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Unified results: notes, actors, items, maps + command actions ----
|
||||||
|
function getCombinedResults(query) {
|
||||||
|
const combined = [];
|
||||||
|
const q = normalize(query);
|
||||||
|
|
||||||
|
function pushMatches(list, type, getName) {
|
||||||
|
for (const data of list) {
|
||||||
|
if (q && !normalize(getName(data)).includes(q)) continue;
|
||||||
|
combined.push({ type, data });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pushMatches(notes.value, 'note', n => n.title);
|
||||||
|
pushMatches(actors.value, 'actor', a => a.name);
|
||||||
|
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 });
|
||||||
|
}
|
||||||
|
|
||||||
|
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 ----
|
||||||
|
function onInput(event) {
|
||||||
|
inputText.value = event.target.value;
|
||||||
|
selectedIndex.value = -1;
|
||||||
|
showResults.value = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function onFocus() {
|
||||||
|
showResults.value = true;
|
||||||
|
// Foundry keeps syncing entries into the campaign in the background: refresh every time the
|
||||||
|
// palette is opened so it never offers stale results.
|
||||||
|
if (campaignId.value) fetchSearchEntries();
|
||||||
|
}
|
||||||
|
|
||||||
|
function onBlur() {
|
||||||
|
// Delay closing to allow click on results
|
||||||
|
setTimeout(() => {
|
||||||
|
closeResults();
|
||||||
|
}, 150);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onKeydown(event) {
|
||||||
|
const combined = getCombinedResults(inputText.value);
|
||||||
|
|
||||||
|
if (event.key === 'ArrowDown') {
|
||||||
|
event.preventDefault();
|
||||||
|
selectedIndex.value = Math.min(selectedIndex.value + 1, combined.length - 1);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event.key === 'ArrowUp') {
|
||||||
|
event.preventDefault();
|
||||||
|
selectedIndex.value = Math.max(selectedIndex.value - 1, 0);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event.key === 'Enter') {
|
||||||
|
event.preventDefault();
|
||||||
|
if (selectedIndex.value >= 0) {
|
||||||
|
openResult(combined[selectedIndex.value]);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event.key === 'Escape') {
|
||||||
|
closeResults();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function closeResults() {
|
||||||
|
showResults.value = false;
|
||||||
|
selectedIndex.value = -1;
|
||||||
|
inputText.value = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Clean up register action on mount/unmount ----
|
||||||
|
onMounted(() => {
|
||||||
|
document.addEventListener('keydown', globalKeydown);
|
||||||
|
registerCreateNoteAction();
|
||||||
|
});
|
||||||
|
|
||||||
|
onUnmounted(() => {
|
||||||
|
document.removeEventListener('keydown', globalKeydown);
|
||||||
});
|
});
|
||||||
*/
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="top-search-container">
|
<div class="top-search-container">
|
||||||
<div class="top-search-box">
|
<div class="top-search-box">
|
||||||
<img class="icon search-icon" :src="SearchIcon" alt="My Happy SVG"/>
|
<img class="icon search-icon" :src="SearchIcon" alt="" aria-hidden="true">
|
||||||
<!-- <input type="text" v-on:input="updateList" v-on:focus="searchFocus" class="search-prompt" placeholder="Buscar...">-->
|
<input
|
||||||
<input type="text" class="search-prompt" placeholder="Buscar...">
|
ref="focusInput"
|
||||||
</div>
|
type="text"
|
||||||
|
class="search-prompt"
|
||||||
<!-- <div class="search-container" ref="searchContainer" v-on:focusout="searchFocusout" style="display: none;">-->
|
placeholder="Search or press Cmd+K..."
|
||||||
<div class="search-container" style="display: none;">
|
v-model="inputText"
|
||||||
<div class="search-container-list">
|
@input="onInput"
|
||||||
<!--
|
@focus="onFocus"
|
||||||
<NoteSearchElement v-for="element in noteLinks" :key="element.key" :title="element.title" :link="element.key"></NoteSearchElement>
|
@blur="onBlur"
|
||||||
-->
|
@keydown="onKeydown"
|
||||||
</div>
|
autocomplete="off"
|
||||||
</div>
|
spellcheck="false"
|
||||||
|
>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="search-container" v-if="showResults">
|
||||||
|
<template v-if="getCombinedResults(inputText).length === 0">
|
||||||
|
<div class="search-empty">No results found</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<div class="search-container-list">
|
||||||
|
<NoteSearchResult
|
||||||
|
v-for="(item, index) in getCombinedResults(inputText)"
|
||||||
|
:key="item.type + '-' + (item.data.key || item.data._id || item.data.id) + '-' + index"
|
||||||
|
:title="resultTitle(item)"
|
||||||
|
:subtitle="resultSubtitle(item)"
|
||||||
|
:icon="resultIcon(item)"
|
||||||
|
:class="{ selected: index === selectedIndex }"
|
||||||
|
@click.stop.prevent="openResult(item)"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
.top-search-container {
|
.top-search-container {
|
||||||
height: 100%;
|
height: 100%;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
display: flex;
|
display: flex;
|
||||||
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
.top-search-box {
|
.top-search-box {
|
||||||
align-items: center;
|
align-items: center;
|
||||||
display: flex;
|
display: flex;
|
||||||
background-color: var(--search-background);
|
background-color: var(--color-search-background);
|
||||||
padding: 2px;
|
padding: 2px;
|
||||||
border-radius: 5px;
|
border-radius: 5px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-prompt {
|
.search-prompt {
|
||||||
border: none;
|
border: none;
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
width: 30vw;
|
width: 30vw;
|
||||||
max-width: 400px;
|
max-width: 400px;
|
||||||
background: none;
|
background: none;
|
||||||
margin-left: -5px;
|
margin-left: -5px;
|
||||||
|
font-family: inherit;
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-prompt:focus {
|
.search-prompt:focus {
|
||||||
outline: none;
|
outline: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-icon {
|
.search-icon {
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
|
filter: invert(var(--color-icon-invert));
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-container {
|
.search-container {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
background-color: var(--search-background-container);
|
background-color: var(--color-search-background-container);
|
||||||
top: 45px;
|
top: 45px;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
max-width: 800px;
|
max-width: 600px;
|
||||||
max-height: 500px;
|
max-height: 400px;
|
||||||
overflow-y: scroll;
|
overflow-y: auto;
|
||||||
left: 0;
|
left: 0;
|
||||||
right: 0;
|
right: 0;
|
||||||
backdrop-filter: blur(15px);
|
backdrop-filter: blur(15px);
|
||||||
border-radius: 10px;
|
border-radius: 10px;
|
||||||
min-width: 400px;
|
width: calc(30vw + 400px);
|
||||||
min-height: 500px;
|
min-width: 320px;
|
||||||
z-index: 99999;
|
z-index: 99999;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
}
|
}
|
||||||
</style>
|
|
||||||
|
.search-container-list {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
padding: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-empty {
|
||||||
|
padding: 16px;
|
||||||
|
text-align: center;
|
||||||
|
opacity: 0.5;
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|||||||
@@ -10,9 +10,14 @@ const steps = ref(null);
|
|||||||
const stepsHtml = ref("");
|
const stepsHtml = ref("");
|
||||||
|
|
||||||
const rollDice = () => {
|
const rollDice = () => {
|
||||||
const result = parse(props.content);
|
try {
|
||||||
resultText.value = result.total;
|
const result = parse(props.content);
|
||||||
stepsHtml.value = result.steps.map(renderStep).join('');
|
resultText.value = result.total;
|
||||||
|
stepsHtml.value = result.steps.map(renderStep).join('');
|
||||||
|
} catch (err) {
|
||||||
|
// Expressio de daus malformada: no fem petar el widget, nomes ho registrem.
|
||||||
|
console.error('Invalid roll expression', props.content, err);
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
const renderStep = (s) => {
|
const renderStep = (s) => {
|
||||||
@@ -84,9 +89,11 @@ onMounted(() => {
|
|||||||
.steps {
|
.steps {
|
||||||
margin-left: 8px;
|
margin-left: 8px;
|
||||||
height: 22px;
|
height: 22px;
|
||||||
> {
|
}
|
||||||
font-size: 12px;
|
/* No nested `> {}` here: the scoped style transform turns it into a dangling
|
||||||
}
|
combinator, which the current CSS minifier rejects. */
|
||||||
|
.steps > * {
|
||||||
|
font-size: 12px;
|
||||||
}
|
}
|
||||||
.steps :deep(.roll-val){
|
.steps :deep(.roll-val){
|
||||||
display: inline-flex;
|
display: inline-flex;
|
||||||
|
|||||||
@@ -8,10 +8,13 @@ const container = ref(null);
|
|||||||
const resultText = ref("");
|
const resultText = ref("");
|
||||||
|
|
||||||
const rollDice = () => {
|
const rollDice = () => {
|
||||||
console.log(props.content);
|
try {
|
||||||
const result = parse(props.content);
|
const result = parse(props.content);
|
||||||
console.log(result);
|
resultText.value = result.total;
|
||||||
resultText.value = result.total;
|
} catch (err) {
|
||||||
|
// Expressio de daus malformada: no fem petar el widget, nomes ho registrem.
|
||||||
|
console.error('Invalid roll expression', props.content, err);
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
|
|||||||
67
frontend/app/components/views/AppShell.vue
Normal file
67
frontend/app/components/views/AppShell.vue
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
<script setup>
|
||||||
|
import ContentManager from '../managers/ContentManager.vue';
|
||||||
|
import ToastManager from '../managers/ToastManager.vue';
|
||||||
|
import WindowManager from '../managers/WindowManager.vue';
|
||||||
|
import ServiceLinkAuthorize from './ServiceLinkAuthorize.vue';
|
||||||
|
|
||||||
|
import { CreateWindow } from '@/services/Windows'
|
||||||
|
import { GetUser, HasAdmin } from '@/services/User';
|
||||||
|
import TooltipManager from '../managers/TooltipManager.vue';
|
||||||
|
import ContextMenuManager from '../managers/ContextMenuManager.vue';
|
||||||
|
import { useCampaignService } from '@/services/Campaign';
|
||||||
|
|
||||||
|
const { RestoreCampaign } = useCampaignService();
|
||||||
|
|
||||||
|
// Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
|
||||||
|
// de l'aplicació i no han d'arrencar les finestres normals. La ruta antiga de Discord també
|
||||||
|
// hi porta, perquè els enllaços que ja corren per Discord no queden morts.
|
||||||
|
const requestUrl = useRequestURL();
|
||||||
|
const isServiceLink = computed(() => {
|
||||||
|
const path = requestUrl.pathname.replace(/\/+$/, '');
|
||||||
|
return path === '/link/authorize' || path === '/discord/authorize';
|
||||||
|
});
|
||||||
|
|
||||||
|
async function start(){
|
||||||
|
if(GetUser()){
|
||||||
|
const restoredCampaign = await RestoreCampaign();
|
||||||
|
if (!restoredCampaign) {
|
||||||
|
CreateWindow('main_menu');
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(await HasAdmin()){
|
||||||
|
CreateWindow('login');
|
||||||
|
} else {
|
||||||
|
CreateWindow('register', {firstTime: true});
|
||||||
|
}
|
||||||
|
// DisplayToast('aqua', 'All plugins loaded successfully');
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
if(!isServiceLink.value){
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
|
||||||
|
<div v-else class="viewer">
|
||||||
|
<ToastManager></ToastManager>
|
||||||
|
<TooltipManager></TooltipManager>
|
||||||
|
<ContextMenuManager></ContextMenuManager>
|
||||||
|
<WindowManager></WindowManager>
|
||||||
|
<ContentManager></ContentManager>
|
||||||
|
<!-- Managers -->
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.viewer {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
width: 100%;
|
||||||
|
height: 100vh;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
343
frontend/app/components/views/DocsView.vue
Normal file
343
frontend/app/components/views/DocsView.vue
Normal file
@@ -0,0 +1,343 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed } from 'vue';
|
||||||
|
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
|
||||||
|
|
||||||
|
// La documentació pública, a /docs: el sumari a l'esquerra, la pàgina al centre i els
|
||||||
|
// apartats d'aquesta pàgina a la dreta. Tot el que hi ha escrit ve dels markdown de
|
||||||
|
// app/content/docs (mira ~/services/Docs.js), i cada enllaç del sumari és una ruta,
|
||||||
|
// així que moure-s'hi no recarrega la pàgina.
|
||||||
|
const route = useRoute();
|
||||||
|
|
||||||
|
const slug = computed(() => String(route.params.slug || GetDocsFirstSlug()));
|
||||||
|
const page = computed(() => GetDocsPage(slug.value));
|
||||||
|
const nav = GetDocsNav();
|
||||||
|
|
||||||
|
useHead({
|
||||||
|
title: computed(() => `${page.value?.title || 'Documentation'} · Dragonroll`)
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="docs">
|
||||||
|
<aside class="docs-sidebar">
|
||||||
|
<NuxtLink class="docs-brand" to="/">
|
||||||
|
<img src="/img/logo.png" alt="Dragonroll logo" class="docs-logo" draggable="false">
|
||||||
|
<span>{{ $t('docs.title') }}</span>
|
||||||
|
</NuxtLink>
|
||||||
|
|
||||||
|
<nav class="docs-contents" :aria-label="$t('docs.contents')">
|
||||||
|
<section v-for="group in nav" :key="group.key" class="docs-group">
|
||||||
|
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li v-for="entry in group.pages" :key="entry.slug">
|
||||||
|
<NuxtLink
|
||||||
|
:to="entry.href"
|
||||||
|
class="docs-nav-link"
|
||||||
|
:class="{ active: entry.slug === slug }"
|
||||||
|
>{{ entry.title }}</NuxtLink>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<NuxtLink class="docs-open" to="/">{{ $t('docs.open-app') }}</NuxtLink>
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
<main class="docs-main">
|
||||||
|
<template v-if="page">
|
||||||
|
<article class="docs-article">
|
||||||
|
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
|
||||||
|
<!-- El contingut és markdown nostre, de app/content/docs -->
|
||||||
|
<div class="docs-markdown" v-html="page.html"></div>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<nav class="docs-pager">
|
||||||
|
<NuxtLink
|
||||||
|
v-if="page.previous"
|
||||||
|
:to="page.previous.href"
|
||||||
|
class="docs-pager-link"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
|
||||||
|
<strong>{{ page.previous.title }}</strong>
|
||||||
|
</NuxtLink>
|
||||||
|
<NuxtLink
|
||||||
|
v-if="page.next"
|
||||||
|
:to="page.next.href"
|
||||||
|
class="docs-pager-link next"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
|
||||||
|
<strong>{{ page.next.title }}</strong>
|
||||||
|
</NuxtLink>
|
||||||
|
</nav>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<article v-else class="docs-article">
|
||||||
|
<h1>{{ $t('docs.title') }}</h1>
|
||||||
|
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
|
||||||
|
<p><NuxtLink to="/docs">{{ $t('docs.back-to-docs') }}</NuxtLink></p>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<aside
|
||||||
|
v-if="page && page.headings.length"
|
||||||
|
class="docs-sections"
|
||||||
|
:aria-label="$t('docs.on-this-page')"
|
||||||
|
>
|
||||||
|
<h2>{{ $t('docs.on-this-page') }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li
|
||||||
|
v-for="heading in page.headings"
|
||||||
|
:key="heading.slug"
|
||||||
|
:class="`depth-${heading.depth}`"
|
||||||
|
>
|
||||||
|
<a :href="`#${heading.slug}`">{{ heading.text }}</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
.docs {
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Els dos aside fan la pàgina sencera avall: amb alçada d'una pantalla i enganxats a
|
||||||
|
dalt, el fons i la vora arriben sempre fins a baix, per molt llarg que sigui el text. */
|
||||||
|
.docs-sidebar,
|
||||||
|
.docs-sections {
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
height: 100vh;
|
||||||
|
overflow-y: auto;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 18px 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sidebar {
|
||||||
|
flex: 0 0 268px;
|
||||||
|
width: 268px;
|
||||||
|
border-right: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-brand {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.15rem;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-logo {
|
||||||
|
width: 30px;
|
||||||
|
height: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-group-title {
|
||||||
|
margin: 0 0 6px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link {
|
||||||
|
display: block;
|
||||||
|
padding: 6px 9px;
|
||||||
|
border-radius: 6px;
|
||||||
|
font-size: 0.97rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
color: var(--color-text);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link.active {
|
||||||
|
background-color: var(--color-background-soft);
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-open {
|
||||||
|
margin-top: auto;
|
||||||
|
padding: 8px 9px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
|
background-color: var(--color-button-background);
|
||||||
|
font-size: 0.95rem;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-open:hover {
|
||||||
|
background-color: var(--color-button-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 26px 34px 60px 34px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* La columna de lectura, centrada dins l'espai que deixa la barra lateral: en una finestra
|
||||||
|
ampla el text queda al mig, no enganxat a l'esquerra. */
|
||||||
|
.docs-article,
|
||||||
|
.docs-pager {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 760px;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-kicker {
|
||||||
|
margin: 0 0 4px 0;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager {
|
||||||
|
margin-top: 34px;
|
||||||
|
padding-top: 18px;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link {
|
||||||
|
flex: 1 1 0;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 10px 12px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
color: var(--color-text);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link.next {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-label {
|
||||||
|
display: block;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
letter-spacing: 0.06em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections {
|
||||||
|
flex: 0 0 240px;
|
||||||
|
width: 240px;
|
||||||
|
/* Més aire al voltant dels apartats, que ara mateix van clavats a la vora. */
|
||||||
|
padding: 26px 22px 26px 18px;
|
||||||
|
border-left: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections h2 {
|
||||||
|
margin: 0 0 8px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections li.depth-3 {
|
||||||
|
padding-left: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections a {
|
||||||
|
display: block;
|
||||||
|
padding: 3px 0;
|
||||||
|
font-size: 0.9rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
color: var(--color-gray);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections a:hover {
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* El markdown renderitzat ve estilat a assets/css/main.scss, sota .docs-markdown, perquè la
|
||||||
|
finestra de documentació (windows/DocumentationWindow.vue) se'l serveix igualment. */
|
||||||
|
|
||||||
|
/* Finestra molt ampla: tot el conjunt va al mig, així els apartats queden a prop del
|
||||||
|
text en lloc d'estirats cap al cantó dret de la pantalla. */
|
||||||
|
@media (min-width: 1440px) {
|
||||||
|
.docs {
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
flex: 0 1 860px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 1200px) {
|
||||||
|
.docs-sections {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 900px) {
|
||||||
|
.docs {
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sidebar,
|
||||||
|
.docs-sections {
|
||||||
|
position: static;
|
||||||
|
height: auto;
|
||||||
|
width: 100%;
|
||||||
|
border-left: none;
|
||||||
|
border-right: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
padding: 20px 18px 40px 18px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
395
frontend/app/components/views/ServiceLinkAuthorize.vue
Normal file
395
frontend/app/components/views/ServiceLinkAuthorize.vue
Normal file
@@ -0,0 +1,395 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, onMounted, ref } from 'vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { GetUser, SetUser } from '~/services/User';
|
||||||
|
import { AddSound } from '~/services/Sound';
|
||||||
|
import Spinner from '../partials/Spinner.vue';
|
||||||
|
|
||||||
|
// Pantalla única d'enllaç de serveis (Discord, Foundry, Obsidian): el servei demana
|
||||||
|
// l'enllaç al backend, l'usuari hi entra, s'identifica i tria la campanya que el
|
||||||
|
// servei podrà fer servir. Abans cada servei tenia la seva pròpia pantalla.
|
||||||
|
const card = ref(null);
|
||||||
|
|
||||||
|
const service = ref('');
|
||||||
|
const serviceName = ref('Dragonroll');
|
||||||
|
const code = ref('');
|
||||||
|
const targetName = ref('');
|
||||||
|
const targetUser = ref('');
|
||||||
|
const system = ref('');
|
||||||
|
const signedInAs = ref('');
|
||||||
|
|
||||||
|
const campaigns = ref([]);
|
||||||
|
const selectedCampaign = ref('');
|
||||||
|
const connectedCampaign = ref('');
|
||||||
|
|
||||||
|
// 'checking' | 'login' | 'pick' | 'connected' | 'error'
|
||||||
|
const status = ref('checking');
|
||||||
|
const messageKey = ref('');
|
||||||
|
|
||||||
|
const username = ref('');
|
||||||
|
const password = ref('');
|
||||||
|
const busy = ref(false);
|
||||||
|
|
||||||
|
// El nom propi del servei és l'últim recurs: el backend el dona amb la petició.
|
||||||
|
const serviceLabel = computed(() => serviceName.value || serviceNameOf(service.value));
|
||||||
|
// Cada servei explica d'una manera què és el que demana i què cal fer després.
|
||||||
|
const targetKey = computed(() => `link.target.${service.value || 'other'}`);
|
||||||
|
const nextKey = computed(() => `link.next.${service.value || 'other'}`);
|
||||||
|
|
||||||
|
function serviceNameOf(value) {
|
||||||
|
if (value === 'discord') return 'Discord';
|
||||||
|
if (value === 'foundry') return 'Foundry VTT';
|
||||||
|
if (value === 'obsidian') return 'Obsidian';
|
||||||
|
return 'Dragonroll';
|
||||||
|
}
|
||||||
|
|
||||||
|
// El codi viatja al fragment de la URL, així que el navegador no l'envia mai al
|
||||||
|
// servidor. El servei, que és qui demana l'enllaç, hi posa també el seu nom.
|
||||||
|
function readLinkParams() {
|
||||||
|
const hash = new URLSearchParams(window.location.hash.slice(1));
|
||||||
|
const search = new URLSearchParams(window.location.search);
|
||||||
|
return {
|
||||||
|
code: hash.get('code') || search.get('code') || '',
|
||||||
|
service: hash.get('service') || search.get('service') || ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function ShowError(key) {
|
||||||
|
messageKey.value = key;
|
||||||
|
}
|
||||||
|
|
||||||
|
function AskForLogin() {
|
||||||
|
const user = GetUser();
|
||||||
|
if (!user) {
|
||||||
|
status.value = 'login';
|
||||||
|
messageKey.value = '';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
signedInAs.value = user.username || user.name || user.email || 'Dragonroll';
|
||||||
|
status.value = 'pick';
|
||||||
|
messageKey.value = '';
|
||||||
|
LoadCampaigns();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function LoadLinkDetails() {
|
||||||
|
const response = await Server().post('/link/details', { code: code.value });
|
||||||
|
const details = response.data;
|
||||||
|
if (details.status !== 'ok') {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('link.errors.expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
service.value = details.service || service.value;
|
||||||
|
serviceName.value = details.serviceName || serviceNameOf(service.value);
|
||||||
|
targetName.value = details.targetName || '';
|
||||||
|
targetUser.value = details.targetUser || '';
|
||||||
|
system.value = details.system || '';
|
||||||
|
AskForLogin();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function LoadCampaigns() {
|
||||||
|
try {
|
||||||
|
const response = await Server().get('/campaign/list');
|
||||||
|
campaigns.value = (response.data.status === 'ok' && Array.isArray(response.data.campaigns))
|
||||||
|
? response.data.campaigns
|
||||||
|
: [];
|
||||||
|
if (campaigns.value.length === 1) selectedCampaign.value = String(campaigns.value[0]._id);
|
||||||
|
} catch {
|
||||||
|
campaigns.value = [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function SignIn() {
|
||||||
|
busy.value = true;
|
||||||
|
messageKey.value = '';
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/user/login', {
|
||||||
|
usermail: username.value,
|
||||||
|
password: password.value
|
||||||
|
});
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok' || !response.data.token) {
|
||||||
|
ShowError(response.data.msg || 'link.errors.sign-in-failed');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// El token passa al servei d'usuari perquè el client el reutilitzi en connectar.
|
||||||
|
SetUser(response.data.token, true);
|
||||||
|
password.value = '';
|
||||||
|
AskForLogin();
|
||||||
|
} catch {
|
||||||
|
ShowError('link.errors.sign-in-failed');
|
||||||
|
} finally {
|
||||||
|
busy.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A campaign that already has this very service on it is being re-connected, and
|
||||||
|
// saying so is what keeps the picker honest.
|
||||||
|
function AlreadyLinked(campaign) {
|
||||||
|
if (service.value === 'foundry') return !!campaign.foundryWorldId;
|
||||||
|
if (service.value === 'discord') return !!campaign.discordGuildId;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function Connect() {
|
||||||
|
if (!selectedCampaign.value) {
|
||||||
|
ShowError('link.errors.no-campaign');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
busy.value = true;
|
||||||
|
messageKey.value = '';
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/link/complete', {
|
||||||
|
code: code.value,
|
||||||
|
campaignId: selectedCampaign.value
|
||||||
|
});
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
ShowError(response.data.msg || 'link.errors.expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
connectedCampaign.value = response.data.campaign?.name || '';
|
||||||
|
status.value = 'connected';
|
||||||
|
// El codi ja s'ha fet servir, treu-lo de la barra d'adreces.
|
||||||
|
window.history.replaceState(null, '', window.location.pathname);
|
||||||
|
} catch (error) {
|
||||||
|
if (error?.response?.status === 401) {
|
||||||
|
status.value = 'login';
|
||||||
|
ShowError('link.errors.session-expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
ShowError('link.errors.internal');
|
||||||
|
} finally {
|
||||||
|
busy.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
useHead({
|
||||||
|
title: computed(() => `Connect ${serviceLabel.value} to Dragonroll`)
|
||||||
|
});
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
AddSound(card.value);
|
||||||
|
const params = readLinkParams();
|
||||||
|
code.value = params.code;
|
||||||
|
service.value = params.service || (window.location.pathname.startsWith('/discord') ? 'discord' : '');
|
||||||
|
|
||||||
|
if (!code.value) {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('link.errors.missing-code');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
LoadLinkDetails().catch(() => {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('link.errors.internal');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="service-link">
|
||||||
|
<main class="link-card" ref="card">
|
||||||
|
<h1>{{ $t('link.title', { service: serviceLabel }) }}</h1>
|
||||||
|
|
||||||
|
<p v-if="targetName" class="summary">
|
||||||
|
{{ $t(targetKey, {
|
||||||
|
target: targetName,
|
||||||
|
user: targetUser,
|
||||||
|
system: system ? $t('link.system', { system }) : ''
|
||||||
|
}) }}
|
||||||
|
</p>
|
||||||
|
<p v-else-if="status !== 'error'" class="summary">
|
||||||
|
<Spinner v-if="status === 'checking'"></Spinner>
|
||||||
|
<span v-else>{{ $t('link.checking') }}</span>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<form v-if="status === 'login'" v-on:submit.prevent="SignIn">
|
||||||
|
<p>{{ $t('link.sign-in-lead', { service: serviceLabel }) }}</p>
|
||||||
|
<div class="form-field">
|
||||||
|
<label for="service-link-usermail">{{ $t('login.username') }}</label>
|
||||||
|
<input
|
||||||
|
id="service-link-usermail"
|
||||||
|
type="text"
|
||||||
|
:placeholder="$t('login.username-placeholder')"
|
||||||
|
name="usermail"
|
||||||
|
autocomplete="username"
|
||||||
|
v-model="username"
|
||||||
|
required
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<div class="form-field">
|
||||||
|
<label for="service-link-password">{{ $t('login.password') }}</label>
|
||||||
|
<input
|
||||||
|
id="service-link-password"
|
||||||
|
type="password"
|
||||||
|
name="password"
|
||||||
|
autocomplete="current-password"
|
||||||
|
v-model="password"
|
||||||
|
required
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<button class="btn-primary sound-click" type="submit" :disabled="busy">
|
||||||
|
<Spinner v-if="busy"></Spinner>
|
||||||
|
<span v-else>{{ $t('login.log-in') }}</span>
|
||||||
|
</button>
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<section v-if="status === 'pick'">
|
||||||
|
<p>{{ $t('link.signed-in-as', { user: signedInAs }) }}</p>
|
||||||
|
<p class="question">{{ $t('link.pick-campaign', { service: serviceLabel }) }}</p>
|
||||||
|
|
||||||
|
<p v-if="!campaigns.length" class="hint">{{ $t('link.no-campaigns') }}</p>
|
||||||
|
<ul v-else class="campaigns">
|
||||||
|
<li v-for="campaign in campaigns" :key="campaign._id">
|
||||||
|
<label class="campaign" :class="{ selected: selectedCampaign === String(campaign._id) }">
|
||||||
|
<input
|
||||||
|
type="radio"
|
||||||
|
name="campaign"
|
||||||
|
:value="String(campaign._id)"
|
||||||
|
v-model="selectedCampaign"
|
||||||
|
>
|
||||||
|
<span class="swatch" :style="{ backgroundColor: campaign.color || 'var(--color-accent)' }"></span>
|
||||||
|
<span class="campaign-name">{{ campaign.name }}</span>
|
||||||
|
<span v-if="AlreadyLinked(campaign)" class="badge">
|
||||||
|
{{ $t('link.already-linked', { service: serviceLabel }) }}
|
||||||
|
</span>
|
||||||
|
</label>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p class="hint">{{ $t('link.trust-warning', { service: serviceLabel }) }}</p>
|
||||||
|
<p class="hint">{{ $t('link.replace-warning') }}</p>
|
||||||
|
<button
|
||||||
|
class="btn-primary sound-click"
|
||||||
|
type="button"
|
||||||
|
:disabled="busy || !selectedCampaign"
|
||||||
|
v-on:click="Connect"
|
||||||
|
>
|
||||||
|
<Spinner v-if="busy"></Spinner>
|
||||||
|
<span v-else>{{ $t('link.connect', { service: serviceLabel }) }}</span>
|
||||||
|
</button>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section v-if="status === 'connected'">
|
||||||
|
<p class="success">{{ $t('link.connected', { campaign: connectedCampaign }) }}</p>
|
||||||
|
<p class="hint">{{ $t(nextKey, { service: serviceLabel }) }}</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<p v-if="messageKey" class="error" role="status">
|
||||||
|
{{ $t(messageKey) }}
|
||||||
|
</p>
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.service-link {
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
padding: 24px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-card {
|
||||||
|
width: min(100%, 460px);
|
||||||
|
padding: 28px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-window-background);
|
||||||
|
border: 1px solid var(--color-window-border);
|
||||||
|
border-radius: 12px;
|
||||||
|
box-shadow: 0 8px 24px var(--color-window-shadow);
|
||||||
|
text-align: center;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-card h1 {
|
||||||
|
margin-top: 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-card p {
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.summary {
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
form,
|
||||||
|
section {
|
||||||
|
margin-top: 18px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.question {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.campaigns {
|
||||||
|
list-style: none;
|
||||||
|
margin: 0 0 14px 0;
|
||||||
|
padding: 0;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 8px;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.campaign {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
padding: 10px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.campaign.selected {
|
||||||
|
border-color: var(--color-accent);
|
||||||
|
background-color: var(--color-background-soft);
|
||||||
|
}
|
||||||
|
|
||||||
|
.swatch {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
border-radius: 4px;
|
||||||
|
flex: 0 0 auto;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.campaign-name {
|
||||||
|
flex: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.badge {
|
||||||
|
font-size: 0.8rem;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.hint {
|
||||||
|
color: var(--color-gray);
|
||||||
|
font-size: 0.95rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.success {
|
||||||
|
color: var(--color-green);
|
||||||
|
}
|
||||||
|
|
||||||
|
.error {
|
||||||
|
color: var(--color-red);
|
||||||
|
}
|
||||||
|
|
||||||
|
button {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
289
frontend/app/components/windows/AccountManagementWindow.vue
Normal file
289
frontend/app/components/windows/AccountManagementWindow.vue
Normal 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>
|
||||||
315
frontend/app/components/windows/CampaignSettingsWindow.vue
Normal file
315
frontend/app/components/windows/CampaignSettingsWindow.vue
Normal file
@@ -0,0 +1,315 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onMounted, ref } from 'vue';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Tabs from '../layouts/Tabs.vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { DisplayToast } from '~/services/Toaster';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const data = props.data;
|
||||||
|
const campaign = data.campaign;
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const saving = ref(false);
|
||||||
|
const name = ref(campaign.name || '');
|
||||||
|
const color = ref(campaign.color || '#6b6b6b');
|
||||||
|
const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
|
||||||
|
const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
|
||||||
|
const id = data.id;
|
||||||
|
|
||||||
|
// Els serveis s'enllacen tots igual: ells mostren un enllaç de Dragonroll i aquí
|
||||||
|
// només es mira què té connectat la campanya i se'n desenllaça el que calgui.
|
||||||
|
const services = ref([]);
|
||||||
|
const unlinked = ref('');
|
||||||
|
|
||||||
|
const rows = [
|
||||||
|
{ id: 'basic', value: 'campaigns.settings.tabs.basic' },
|
||||||
|
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
|
||||||
|
];
|
||||||
|
|
||||||
|
const serviceKeys = ['foundry', 'discord', 'obsidian'];
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 560, height: 430 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
SetResizable(id, true);
|
||||||
|
SetMinSize(id, { width: 440, height: 340 });
|
||||||
|
LoadServices();
|
||||||
|
});
|
||||||
|
|
||||||
|
function ApplyCampaignUpdate(updatedCampaign) {
|
||||||
|
Object.assign(campaign, updatedCampaign);
|
||||||
|
settings.value = updatedCampaign.settings || {};
|
||||||
|
foundryUrl.value = settings.value.integrations?.foundryUrl || foundryUrl.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
function validFoundryUrl(value) {
|
||||||
|
if (!value.trim()) return true;
|
||||||
|
try {
|
||||||
|
const url = new URL(value.trim());
|
||||||
|
return url.protocol === 'http:' || url.protocol === 'https:';
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function SaveSettings() {
|
||||||
|
if (!name.value.trim()) {
|
||||||
|
DisplayToast('red', $t('campaigns.settings.errors.name-required'), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (!validFoundryUrl(foundryUrl.value)) {
|
||||||
|
DisplayToast('red', $t('campaigns.settings.errors.invalid-foundry-url'), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
saving.value = true;
|
||||||
|
const updatedSettings = {
|
||||||
|
...settings.value,
|
||||||
|
integrations: {
|
||||||
|
...(settings.value.integrations || {}),
|
||||||
|
foundryUrl: foundryUrl.value.trim()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/campaign/update', {
|
||||||
|
id: campaign._id,
|
||||||
|
name: name.value.trim(),
|
||||||
|
color: color.value,
|
||||||
|
settings: updatedSettings
|
||||||
|
});
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
ApplyCampaignUpdate(response.data.campaign);
|
||||||
|
DisplayToast('green', $t('campaigns.settings.saved'), 3000);
|
||||||
|
} catch {
|
||||||
|
DisplayToast('red', $t('errors.internal'), 3000);
|
||||||
|
} finally {
|
||||||
|
saving.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function LoadServices() {
|
||||||
|
try {
|
||||||
|
const response = await Server().get(`/campaign/services?campaignId=${campaign._id}`);
|
||||||
|
services.value = response.data.status === 'ok' && Array.isArray(response.data.services)
|
||||||
|
? response.data.services
|
||||||
|
: [];
|
||||||
|
} catch {
|
||||||
|
services.value = [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function LinkFor(service) {
|
||||||
|
return services.value.find((link) => link.service === service) || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// El món de Foundry es descriu amb el que la campanya ja en sap, per si el món
|
||||||
|
// es va enllaçar abans que els serveis tinguessin un registre comú.
|
||||||
|
function ServiceTarget(service, link) {
|
||||||
|
if (link?.targetName) return link.targetName;
|
||||||
|
if (service === 'foundry' && campaign.foundryWorldTitle) return campaign.foundryWorldTitle;
|
||||||
|
if (service === 'discord' && campaign.discordGuildId) return campaign.discordGuildId;
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function WhoConnected(link) {
|
||||||
|
return link?.dragonrollUserName ? $t('campaigns.settings.services.connected-by', { user: link.dragonrollUserName }) : '';
|
||||||
|
}
|
||||||
|
|
||||||
|
async function Unlink(service) {
|
||||||
|
unlinked.value = service;
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/campaign/service-unlink', {
|
||||||
|
campaignId: campaign._id,
|
||||||
|
service
|
||||||
|
});
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
ApplyCampaignUpdate(response.data.campaign);
|
||||||
|
services.value = Array.isArray(response.data.services) ? response.data.services : [];
|
||||||
|
DisplayToast('green', $t('campaigns.settings.services.unlinked', {
|
||||||
|
service: $t(`campaigns.settings.services.${service}.name`)
|
||||||
|
}), 3000);
|
||||||
|
} catch {
|
||||||
|
DisplayToast('red', $t('errors.internal'), 3000);
|
||||||
|
} finally {
|
||||||
|
unlinked.value = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
|
||||||
|
<div class="settings-body">
|
||||||
|
<Tabs :rows="rows">
|
||||||
|
<template #basic>
|
||||||
|
<div class="settings-fields">
|
||||||
|
<label class="field">
|
||||||
|
<span>{{ $t('campaigns.settings.name') }}</span>
|
||||||
|
<input v-model="name" type="text" maxlength="120" autocomplete="off">
|
||||||
|
</label>
|
||||||
|
<label class="field color-field">
|
||||||
|
<span>{{ $t('campaigns.settings.color') }}</span>
|
||||||
|
<input v-model="color" type="color">
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
<template #integrations>
|
||||||
|
<p class="help-text standalone">{{ $t('campaigns.settings.services.help') }}</p>
|
||||||
|
<div class="settings-fields">
|
||||||
|
<div v-for="service in serviceKeys" :key="service" class="service">
|
||||||
|
<div class="service-head">
|
||||||
|
<strong>{{ $t(`campaigns.settings.services.${service}.name`) }}</strong>
|
||||||
|
<button
|
||||||
|
v-if="LinkFor(service)"
|
||||||
|
class="btn-primary sound-click"
|
||||||
|
type="button"
|
||||||
|
:disabled="unlinked !== ''"
|
||||||
|
@click="Unlink(service)"
|
||||||
|
>
|
||||||
|
{{ $t('campaigns.settings.services.unlink') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<p class="service-state" :class="{ linked: LinkFor(service) }">
|
||||||
|
{{ ServiceTarget(service, LinkFor(service)) || $t('campaigns.settings.services.not-connected') }}
|
||||||
|
<span v-if="WhoConnected(LinkFor(service))" class="who">
|
||||||
|
{{ WhoConnected(LinkFor(service)) }}
|
||||||
|
</span>
|
||||||
|
</p>
|
||||||
|
<p class="help-text standalone">
|
||||||
|
{{ $t(`campaigns.settings.services.${service}.how`) }}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="settings-fields">
|
||||||
|
<label class="field">
|
||||||
|
<span>{{ $t('campaigns.settings.foundry-url') }}</span>
|
||||||
|
<input
|
||||||
|
v-model="foundryUrl"
|
||||||
|
type="url"
|
||||||
|
placeholder="https://foundry.example.com"
|
||||||
|
autocomplete="url"
|
||||||
|
>
|
||||||
|
</label>
|
||||||
|
<p class="help-text">{{ $t('campaigns.settings.foundry-url-help') }}</p>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
</Tabs>
|
||||||
|
<div class="actions">
|
||||||
|
<button class="btn-primary sound-click" type="button" :disabled="saving" @click="SaveSettings">
|
||||||
|
{{ saving ? $t('campaigns.settings.saving') : $t('general.save') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
.window-wrapper {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.settings-body {
|
||||||
|
display: flex;
|
||||||
|
flex: 1;
|
||||||
|
flex-direction: column;
|
||||||
|
min-height: 0;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.settings-fields {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 18px;
|
||||||
|
padding: 22px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
input {
|
||||||
|
width: 100%;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 8px 10px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
|
background: var(--color-background-soft);
|
||||||
|
color: var(--color-text);
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.color-field input {
|
||||||
|
width: 72px;
|
||||||
|
height: 38px;
|
||||||
|
padding: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.help-text {
|
||||||
|
margin: -10px 22px 0;
|
||||||
|
color: var(--color-text);
|
||||||
|
font-size: 13px;
|
||||||
|
opacity: 0.75;
|
||||||
|
}
|
||||||
|
|
||||||
|
.help-text.standalone {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.service {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 6px;
|
||||||
|
padding-bottom: 14px;
|
||||||
|
border-bottom: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.service-head {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.service-state {
|
||||||
|
margin: 0;
|
||||||
|
font-size: 14px;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
|
||||||
|
.service-state.linked {
|
||||||
|
color: var(--color-green);
|
||||||
|
}
|
||||||
|
|
||||||
|
.who {
|
||||||
|
opacity: 0.75;
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actions {
|
||||||
|
display: flex;
|
||||||
|
justify-content: flex-end;
|
||||||
|
padding: 12px 18px;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
</style>
|
||||||
686
frontend/app/components/windows/CharacterSheetWindow.vue
Normal file
686
frontend/app/components/windows/CharacterSheetWindow.vue
Normal file
@@ -0,0 +1,686 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
import { useI18n } from 'vue-i18n';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
const actorId = props.data.actor?._id;
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const editing = ref(false);
|
||||||
|
const saving = ref(false);
|
||||||
|
const error = ref('');
|
||||||
|
const original = ref(null);
|
||||||
|
const photoInput = ref(null);
|
||||||
|
const uploadingPhoto = ref(false);
|
||||||
|
const { t } = useI18n();
|
||||||
|
|
||||||
|
const abilityStats = [
|
||||||
|
{ key: 'str', label: 'STR' }, { key: 'dex', label: 'DEX' }, { key: 'con', label: 'CON' },
|
||||||
|
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
||||||
|
];
|
||||||
|
|
||||||
|
// Les habilitats del 5e. Cada una té un cercle que s'encén quan el personatge hi és
|
||||||
|
// proficient, i la modificadora que tira és la de la característica que mana.
|
||||||
|
const skillList = [
|
||||||
|
{ key: 'acrobatics', ability: 'dex' }, { key: 'animalHandling', ability: 'wis' },
|
||||||
|
{ key: 'arcana', ability: 'int' }, { key: 'athletics', ability: 'str' },
|
||||||
|
{ key: 'deception', ability: 'cha' }, { key: 'history', ability: 'int' },
|
||||||
|
{ key: 'insight', ability: 'wis' }, { key: 'intimidation', ability: 'cha' },
|
||||||
|
{ key: 'investigation', ability: 'int' }, { key: 'medicine', ability: 'wis' },
|
||||||
|
{ key: 'nature', ability: 'int' }, { key: 'perception', ability: 'wis' },
|
||||||
|
{ key: 'performance', ability: 'cha' }, { key: 'persuasion', ability: 'cha' },
|
||||||
|
{ key: 'religion', ability: 'int' }, { key: 'sleightOfHand', ability: 'dex' },
|
||||||
|
{ key: 'stealth', ability: 'dex' }, { key: 'survival', ability: 'wis' }
|
||||||
|
];
|
||||||
|
|
||||||
|
// Les cinc monedes que un personatge porta al damunt.
|
||||||
|
const currencyUnits = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||||
|
|
||||||
|
// 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');
|
||||||
|
|
||||||
|
// Les pestanyes pengen del marc de la finestra, per fora del contingent (vegeu .sheet-tabs). La
|
||||||
|
// finestra es fa més estreta perquè el marge que la centra sigui prou ample per aguantar-les;
|
||||||
|
// per sota de 760px el marc les fa estar a dins i el marge deixa de fer falta.
|
||||||
|
const TAB_RAIL_WIDTH = 150;
|
||||||
|
|
||||||
|
// Les eines i els idiomes viatgen com a llista i el formulari els edita com un quadre
|
||||||
|
// de text: un nom per línia. Les comes també separen, que és com s'escriuen en una frase.
|
||||||
|
function proficiencyText(value) {
|
||||||
|
const names = Array.isArray(value) ? value : String(value ?? '').split(/[\n,]/);
|
||||||
|
return [...new Set(names.map((name) => String(name).trim()).filter(Boolean))].join('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
function proficiencyList(text) {
|
||||||
|
return [...new Set(String(text ?? '').split(/[\n,]/).map((name) => String(name).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
|
||||||
|
function normalizeActor(actor) {
|
||||||
|
return {
|
||||||
|
name: actor?.name ?? '',
|
||||||
|
species: actor?.species ?? '',
|
||||||
|
className: actor?.className ?? '',
|
||||||
|
subclass: actor?.subclass ?? '',
|
||||||
|
level: Number(actor?.level ?? 1),
|
||||||
|
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
|
||||||
|
armorClass: Number(actor?.armorClass ?? 10),
|
||||||
|
speed: Number(actor?.speed ?? 30),
|
||||||
|
// Les barres sota la imatge: `current` de `max`. Un personatge que encara no en té
|
||||||
|
// rep un dau de cop per nivell, que és el que D&D compta.
|
||||||
|
hitPoints: {
|
||||||
|
current: Number(actor?.hitPoints?.current ?? actor?.hitPoints?.max ?? 10),
|
||||||
|
max: Number(actor?.hitPoints?.max ?? actor?.hitPoints?.current ?? 10)
|
||||||
|
},
|
||||||
|
hitDice: {
|
||||||
|
current: Number(actor?.hitDice?.current ?? actor?.level ?? 1),
|
||||||
|
max: Number(actor?.hitDice?.max ?? actor?.level ?? 1)
|
||||||
|
},
|
||||||
|
proficiencies: actor?.proficiencies ?? '',
|
||||||
|
// El que el personatge sap fer i el que porta: les habilitats i les tirades de
|
||||||
|
// salvació són cercles que s'encenen, les eines i els idiomes són noms que el
|
||||||
|
// formulari edita com un text d'una línia per nom, i la moneda són cinc xifres.
|
||||||
|
skills: Object.fromEntries(skillList.map(({ key }) => [key, Boolean(actor?.skills?.[key])])),
|
||||||
|
savingThrows: Object.fromEntries(abilityStats.map(({ key }) => [key, Boolean(actor?.savingThrows?.[key])])),
|
||||||
|
tools: proficiencyText(actor?.tools),
|
||||||
|
languages: proficiencyText(actor?.languages),
|
||||||
|
currency: Object.fromEntries(currencyUnits.map((unit) => [unit, Number(actor?.currency?.[unit] ?? 0) || 0])),
|
||||||
|
inventory: (actor?.inventory ?? []).map((item) => ({
|
||||||
|
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0),
|
||||||
|
icon: item.icon ?? ''
|
||||||
|
})),
|
||||||
|
traits: actor?.traits ?? '',
|
||||||
|
spells: actor?.spells ?? '',
|
||||||
|
image: actor?.image ?? ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const form = ref(normalizeActor(props.data.actor));
|
||||||
|
original.value = normalizeActor(props.data.actor);
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
// Les pestanyes pengen del marc per fora del cos: com que la finestra es centra, el marge que
|
||||||
|
// li queda a la dreta és la meitat del que li sobra, i cal reservar-nos el doble.
|
||||||
|
const railRoom = window.innerWidth > 760 ? 2 * TAB_RAIL_WIDTH : 0;
|
||||||
|
SetSize(id, {
|
||||||
|
width: Math.max(320, Math.min(900, window.innerWidth - 24 - railRoom)),
|
||||||
|
height: Math.max(360, Math.min(700, window.innerHeight - 32))
|
||||||
|
});
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => ClearWindow({ type: 'character_sheet' }));
|
||||||
|
|
||||||
|
function handleActorSync({ entityType, entry }) {
|
||||||
|
if (entityType !== 'actor' || entry?._id !== actorId || editing.value) return;
|
||||||
|
form.value = normalizeActor(entry);
|
||||||
|
original.value = normalizeActor(entry);
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => emitter.on('campaign-entry-updated', handleActorSync));
|
||||||
|
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
|
||||||
|
|
||||||
|
const proficiencyBonus = computed(() => Math.ceil(form.value.level / 4) + 1);
|
||||||
|
// La iniciativa és el modificador de DESTÀ, que és el que D&D compta quan el personatge no
|
||||||
|
// porta cap do extra que l'augmenti.
|
||||||
|
const initiativeBonus = computed(() => abilityModifier(form.value.abilityScores.dex));
|
||||||
|
// Quina part del màxim representa la barra; buida (màxim 0) o per sobre, tot tallat.
|
||||||
|
function barPercent(current, max) {
|
||||||
|
return max > 0 ? Math.min(100, Math.max(0, ((Number(current) || 0) / max) * 100)) : 0;
|
||||||
|
}
|
||||||
|
const hitPointsPercent = computed(() => barPercent(form.value.hitPoints.current, form.value.hitPoints.max));
|
||||||
|
const hitDicePercent = computed(() => barPercent(form.value.hitDice.current, form.value.hitDice.max));
|
||||||
|
const carryingCapacity = computed(() => form.value.abilityScores.str * 15);
|
||||||
|
const carriedWeight = computed(() => form.value.inventory.reduce((total, item) => total + (Number(item.quantity) || 0) * (Number(item.weight) || 0), 0));
|
||||||
|
const carryPercent = computed(() => Math.min(100, carryingCapacity.value ? (carriedWeight.value / carryingCapacity.value) * 100 : 0));
|
||||||
|
|
||||||
|
// `bonus` és el bonificador de proficiència, per a les habilitats i les tirades de
|
||||||
|
// salvació del personatge que hi està entrenat.
|
||||||
|
function abilityModifier(score, bonus = 0) {
|
||||||
|
const modifier = Math.floor((Number(score) - 10) / 2) + (Number(bonus) || 0);
|
||||||
|
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
||||||
|
}
|
||||||
|
|
||||||
|
function skillModifier(skill) {
|
||||||
|
return abilityModifier(form.value.abilityScores[skill.ability], form.value.skills[skill.key] ? proficiencyBonus.value : 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function savingThrowModifier(stat) {
|
||||||
|
return abilityModifier(form.value.abilityScores[stat.key], form.value.savingThrows[stat.key] ? proficiencyBonus.value : 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
// El cercle d'una habilitat o d'una salvació: s'encén i s'apaga, i es desa amb tota la
|
||||||
|
// fitxa, com la resta del que s'edita.
|
||||||
|
function toggleProficiency(group, key) {
|
||||||
|
form.value[group][key] = !form.value[group][key];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Una imatge pot ser una adreça sencera (la que Foundry dona a un objecte, per
|
||||||
|
// exemple) o un fitxer pujat aquí, que es serveix per `/api/public`.
|
||||||
|
function resolveImage(image) {
|
||||||
|
if (!image) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image)
|
||||||
|
? image
|
||||||
|
: `${getBaseUrl()}/public/${image}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
const imageUrl = computed(() => resolveImage(form.value.image));
|
||||||
|
|
||||||
|
function pickPhoto() {
|
||||||
|
photoInput.value?.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function onPhotoSelected(event) {
|
||||||
|
const file = event.target.files?.[0];
|
||||||
|
event.target.value = '';
|
||||||
|
if (!file || uploadingPhoto.value) return;
|
||||||
|
uploadingPhoto.value = true;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const formData = new FormData();
|
||||||
|
formData.append('image', file);
|
||||||
|
const response = await Server().post(`/actor/upload-image?actor=${actorId}`, formData, {
|
||||||
|
headers: { "Content-Type": "multipart/form-data" }
|
||||||
|
});
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t('campaigns.character-sheet.photo-error');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// La foto es desa immediatament: manté original intacte perquè cancel·lar no la perdi
|
||||||
|
form.value.image = response.data.actor?.image ?? form.value.image;
|
||||||
|
original.value.image = form.value.image;
|
||||||
|
emitter.emit('campaign-entry-updated', { entityType: 'actor', entry: response.data.actor });
|
||||||
|
} catch (requestError) {
|
||||||
|
error.value = t('campaigns.character-sheet.photo-error');
|
||||||
|
} finally {
|
||||||
|
uploadingPhoto.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function removePhoto() {
|
||||||
|
form.value.image = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function startEditing() {
|
||||||
|
editing.value = true;
|
||||||
|
error.value = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function cancelEditing() {
|
||||||
|
form.value = normalizeActor(original.value);
|
||||||
|
editing.value = false;
|
||||||
|
error.value = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function addInventoryItem() {
|
||||||
|
form.value.inventory.push({ name: '', quantity: 1, weight: 0 });
|
||||||
|
}
|
||||||
|
|
||||||
|
function removeInventoryItem(index) {
|
||||||
|
form.value.inventory.splice(index, 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveSheet() {
|
||||||
|
if (!form.value.name.trim() || saving.value) return;
|
||||||
|
saving.value = true;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const payload = {
|
||||||
|
id: actorId,
|
||||||
|
...form.value,
|
||||||
|
// Les eines i els idiomes van a l'API com a llista, que és com està desats.
|
||||||
|
tools: proficiencyList(form.value.tools),
|
||||||
|
languages: proficiencyList(form.value.languages),
|
||||||
|
inventory: form.value.inventory.filter((item) => item.name.trim())
|
||||||
|
};
|
||||||
|
const response = await Server().post('/actor/update', payload);
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t('campaigns.character-sheet.save-error');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
original.value = normalizeActor(response.data.actor);
|
||||||
|
form.value = normalizeActor(response.data.actor);
|
||||||
|
editing.value = false;
|
||||||
|
emitter.emit('campaign-entry-updated', { entityType: 'actor', entry: response.data.actor });
|
||||||
|
} catch (requestError) {
|
||||||
|
error.value = t('campaigns.character-sheet.save-error');
|
||||||
|
} finally {
|
||||||
|
saving.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
|
||||||
|
<!-- Pestilletes del marc de la finestra: pengen del cantó dret, per fora del
|
||||||
|
contingent, i no s'enrolen quan la fitxa desfila. -->
|
||||||
|
<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 class="sheet-body">
|
||||||
|
<header class="sheet-hero">
|
||||||
|
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
|
||||||
|
<div class="character-identity">
|
||||||
|
<input v-if="editing" v-model="form.name" class="character-name-input" required :aria-label="$t('campaigns.character-sheet.name')">
|
||||||
|
<h1 v-else>{{ form.name }}</h1>
|
||||||
|
<div class="identity-fields">
|
||||||
|
<label v-if="editing" class="identity-field">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.class') }}</span><input v-model="form.className">
|
||||||
|
</label>
|
||||||
|
<span v-else class="identity-tag">{{ form.className || $t('campaigns.character-sheet.unset-class') }}</span>
|
||||||
|
<label v-if="editing" class="identity-field">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.subclass') }}</span><input v-model="form.subclass">
|
||||||
|
</label>
|
||||||
|
<span v-else-if="form.subclass" class="identity-tag">{{ form.subclass }}</span>
|
||||||
|
<label v-if="editing" class="identity-field level-field">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.level') }}</span><input v-model.number="form.level" type="number" min="1" max="20">
|
||||||
|
</label>
|
||||||
|
<span v-else class="identity-tag">{{ $t('campaigns.character-sheet.level') }} {{ form.level }}</span>
|
||||||
|
<label v-if="editing" class="identity-field">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.species') }}</span><input v-model="form.species">
|
||||||
|
</label>
|
||||||
|
<span v-else class="identity-tag">{{ form.species || $t('campaigns.character-sheet.unset-species') }}</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="sheet-actions">
|
||||||
|
<button v-if="!editing" class="sheet-button" type="button" @click="startEditing">{{ $t('campaigns.character-sheet.edit') }}</button>
|
||||||
|
<template v-else>
|
||||||
|
<button class="sheet-button secondary" type="button" @click="cancelEditing">{{ $t('campaigns.character-sheet.cancel') }}</button>
|
||||||
|
<button class="sheet-button primary" type="button" :disabled="saving" @click="saveSheet">
|
||||||
|
{{ saving ? $t('campaigns.character-sheet.saving') : $t('campaigns.character-sheet.save') }}
|
||||||
|
</button>
|
||||||
|
</template>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div v-if="error" class="sheet-error">{{ error }}</div>
|
||||||
|
|
||||||
|
<!-- La columna del personatge no penja de cap pestanya: la imatge i el que es mira
|
||||||
|
d'anada i tornada — classe d'armadura, velocitat, bonificadors i les barres de
|
||||||
|
cops — es queden a la vista des de qualsevol pestanya de la fitxa. -->
|
||||||
|
<div class="sheet-layout">
|
||||||
|
<div class="character-column">
|
||||||
|
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
|
||||||
|
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
|
||||||
|
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
|
||||||
|
</button>
|
||||||
|
<div v-if="editing && form.image" class="portrait-controls">
|
||||||
|
<button type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.change-photo') }}
|
||||||
|
</button>
|
||||||
|
<button type="button" :disabled="uploadingPhoto" :aria-label="$t('campaigns.character-sheet.remove-photo')" @click="removePhoto">×</button>
|
||||||
|
</div>
|
||||||
|
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onPhotoSelected">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- El que es mira primer: classe d'armadura, velocitat i els bonificadors
|
||||||
|
que acompanyen els cops, tot just sota la imatge. -->
|
||||||
|
<section class="sheet-panel vitals-panel">
|
||||||
|
<div class="vital-stats">
|
||||||
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.armor-class') }}</span>
|
||||||
|
<input v-if="editing" v-model.number="form.armorClass" type="number" min="0" :aria-label="$t('campaigns.character-sheet.armor-class')">
|
||||||
|
<strong v-else>{{ form.armorClass }}</strong>
|
||||||
|
</div>
|
||||||
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.speed') }}</span>
|
||||||
|
<label v-if="editing" class="number-with-unit"><input v-model.number="form.speed" type="number" min="0" :aria-label="$t('campaigns.character-sheet.speed')"><small>ft</small></label>
|
||||||
|
<strong v-else>{{ form.speed }} <small>ft</small></strong>
|
||||||
|
</div>
|
||||||
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.proficiency-bonus') }}</span>
|
||||||
|
<strong>+{{ proficiencyBonus }}</strong>
|
||||||
|
</div>
|
||||||
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.initiative') }}</span>
|
||||||
|
<strong>{{ initiativeBonus }}</strong>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="vital-bar hit-points-bar">
|
||||||
|
<div class="vital-bar-head">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.hit-points') }}</span>
|
||||||
|
<strong v-if="!editing">{{ form.hitPoints.current }} / {{ form.hitPoints.max }}</strong>
|
||||||
|
<label v-else class="vital-bar-inputs">
|
||||||
|
<input v-model.number="form.hitPoints.current" type="number" min="0" :aria-label="$t('campaigns.character-sheet.hit-points')">
|
||||||
|
<span>/</span>
|
||||||
|
<input v-model.number="form.hitPoints.max" type="number" min="0" :aria-label="$t('campaigns.character-sheet.max-hit-points')">
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="vital-bar-track"><div class="vital-bar-fill" :style="{ width: `${hitPointsPercent}%` }" /></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="vital-bar hit-dice-bar">
|
||||||
|
<div class="vital-bar-head">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.hit-dice') }}</span>
|
||||||
|
<strong v-if="!editing">{{ form.hitDice.current }} / {{ form.hitDice.max }}</strong>
|
||||||
|
<label v-else class="vital-bar-inputs">
|
||||||
|
<input v-model.number="form.hitDice.current" type="number" min="0" :aria-label="$t('campaigns.character-sheet.hit-dice')">
|
||||||
|
<span>/</span>
|
||||||
|
<input v-model.number="form.hitDice.max" type="number" min="0" :aria-label="$t('campaigns.character-sheet.max-hit-dice')">
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="vital-bar-track"><div class="vital-bar-fill" :style="{ width: `${hitDicePercent}%` }" /></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'abilities'" class="sheet-tab-body">
|
||||||
|
<section class="sheet-panel abilities-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||||
|
<div class="ability-grid">
|
||||||
|
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
||||||
|
<span class="ability-label">{{ stat.label }}</span>
|
||||||
|
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
|
||||||
|
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
||||||
|
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Les tirades de salvació van just a sota de les característiques, que
|
||||||
|
són les que les manen: el cercle diu si el personatge hi està entrenat. -->
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.saving-throws') }}</h3>
|
||||||
|
<div class="saving-throw-grid">
|
||||||
|
<button
|
||||||
|
v-for="stat in abilityStats"
|
||||||
|
:key="stat.key"
|
||||||
|
class="proficiency-row"
|
||||||
|
type="button"
|
||||||
|
role="switch"
|
||||||
|
:aria-checked="form.savingThrows[stat.key]"
|
||||||
|
:disabled="!editing"
|
||||||
|
@click="toggleProficiency('savingThrows', stat.key)"
|
||||||
|
>
|
||||||
|
<span class="proficiency-dot" :class="{ proficient: form.savingThrows[stat.key] }" aria-hidden="true" />
|
||||||
|
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.abilities.${stat.key}`) }}</span>
|
||||||
|
<span class="proficiency-modifier">{{ savingThrowModifier(stat) }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="sheet-panel skills-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.skills') }}</h2>
|
||||||
|
<div class="skill-grid">
|
||||||
|
<button
|
||||||
|
v-for="skill in skillList"
|
||||||
|
:key="skill.key"
|
||||||
|
class="proficiency-row"
|
||||||
|
type="button"
|
||||||
|
role="switch"
|
||||||
|
:aria-checked="form.skills[skill.key]"
|
||||||
|
:disabled="!editing"
|
||||||
|
@click="toggleProficiency('skills', skill.key)"
|
||||||
|
>
|
||||||
|
<span class="proficiency-dot" :class="{ proficient: form.skills[skill.key] }" aria-hidden="true" />
|
||||||
|
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.skill-names.${skill.key}`) }}</span>
|
||||||
|
<span class="proficiency-ability">{{ skill.ability.toUpperCase() }}</span>
|
||||||
|
<span class="proficiency-modifier">{{ skillModifier(skill) }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="sheet-panel proficiencies-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.proficiencies') }}</h2>
|
||||||
|
<textarea v-if="editing" v-model="form.proficiencies" rows="7" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
||||||
|
|
||||||
|
<!-- Les eines i els idiomes tenen llista pròpia; el text de dalt guarda
|
||||||
|
el que no en té, com les armadures i les armes. -->
|
||||||
|
<div class="proficiency-lists">
|
||||||
|
<div class="proficiency-list">
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.tools') }}</h3>
|
||||||
|
<textarea v-if="editing" v-model="form.tools" rows="4" :placeholder="$t('campaigns.character-sheet.tools-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.tools || $t('campaigns.character-sheet.empty-tools') }}</p>
|
||||||
|
</div>
|
||||||
|
<div class="proficiency-list">
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.languages') }}</h3>
|
||||||
|
<textarea v-if="editing" v-model="form.languages" rows="4" :placeholder="$t('campaigns.character-sheet.languages-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.languages || $t('campaigns.character-sheet.empty-languages') }}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'inventory'" class="sheet-tab-body">
|
||||||
|
<section class="sheet-panel inventory-panel">
|
||||||
|
<div class="panel-title-row">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
||||||
|
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
||||||
|
</div>
|
||||||
|
<div class="weight-summary">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
||||||
|
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
||||||
|
</div>
|
||||||
|
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
||||||
|
|
||||||
|
<!-- La moneda que el personatge porta a sobre, en les cinc monedes del joc. -->
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.currency') }}</h3>
|
||||||
|
<div class="currency-row">
|
||||||
|
<label v-for="unit in currencyUnits" :key="unit" class="currency-field">
|
||||||
|
<span>{{ $t(`campaigns.character-sheet.currency-units.${unit}`) }}</span>
|
||||||
|
<input v-if="editing" v-model.number="form.currency[unit]" type="number" min="0" :aria-label="$t(`campaigns.character-sheet.currency-units.${unit}`)">
|
||||||
|
<strong v-else>{{ form.currency[unit] }}</strong>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="inventory-table-wrap">
|
||||||
|
<table class="inventory-table">
|
||||||
|
<thead><tr>
|
||||||
|
<th><span class="sr-only">{{ $t('campaigns.character-sheet.item-icon') }}</span></th>
|
||||||
|
<th class="item-name-cell">{{ $t('campaigns.character-sheet.item-name') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
||||||
|
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
||||||
|
</tr></thead>
|
||||||
|
<tbody>
|
||||||
|
<tr v-for="(item, index) in form.inventory" :key="index">
|
||||||
|
<td class="item-icon-cell">
|
||||||
|
<img v-if="item.icon" :src="resolveImage(item.icon)" :alt="$t('campaigns.character-sheet.item-icon')">
|
||||||
|
<span v-else class="item-icon-blank" aria-hidden="true" />
|
||||||
|
</td>
|
||||||
|
<td class="item-name-cell"><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
||||||
|
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
|
||||||
|
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
|
||||||
|
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
||||||
|
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
||||||
|
</tr>
|
||||||
|
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 6 : 5" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</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>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.sheet-window { min-width: 0; min-height: 0; }
|
||||||
|
.sheet-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 16px; box-sizing: border-box; }
|
||||||
|
.sheet-hero { display: flex; align-items: center; gap: 14px; padding: 4px 2px 16px; margin-bottom: 12px; border-bottom: 1px solid var(--color-border); }
|
||||||
|
.character-mark { width: 56px; height: 56px; flex: 0 0 56px; display: grid; place-items: center; border-radius: 12px; background: var(--color-background-soft); color: var(--color-link); border: 1px solid var(--color-border); font: 28px MrEavesRemake; }
|
||||||
|
.character-identity { flex: 1; min-width: 0; }
|
||||||
|
.character-identity h1 { margin: 0 0 7px; font: 28px MrEavesRemake; overflow-wrap: anywhere; }
|
||||||
|
.character-name-input { width: min(100%, 440px); font-size: 24px !important; font-family: MrEavesRemake !important; }
|
||||||
|
.identity-fields { display: flex; align-items: center; flex-wrap: wrap; gap: 7px; }
|
||||||
|
.identity-tag { padding: 4px 9px; border: 1px solid var(--color-border); border-radius: 999px; background: var(--color-background-soft); font-size: 12px; opacity: .9; }
|
||||||
|
.identity-field { display: flex; align-items: center; gap: 5px; font-size: 11px; opacity: .8; }
|
||||||
|
.identity-field input { width: 106px; }
|
||||||
|
.identity-field.level-field input { width: 58px; }
|
||||||
|
.sheet-actions { display: flex; align-items: center; gap: 7px; }
|
||||||
|
.sheet-button { border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; }
|
||||||
|
.sheet-button:hover { background: var(--color-button-hover); }
|
||||||
|
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
|
||||||
|
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
||||||
|
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
|
||||||
|
/* El marc de la fitxa: la columna del personatge, sempre a la vista, i al seu costat el contingent
|
||||||
|
de la pestanya oberta. */
|
||||||
|
.sheet-layout { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr); gap: 11px; align-items: start; }
|
||||||
|
.sheet-tab-body { grid-column: 2; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
|
/* Pestilletes del marc: arrencen del cantó dret de la finestra, per fora del cos, i queden
|
||||||
|
fora del contingent que desfila. Per sota de 760px no hi ha lloc fora (vegeu a sota). */
|
||||||
|
.sheet-tabs { position: absolute; left: 100%; top: 34px; display: flex; flex-direction: column; align-items: flex-start; gap: 5px; padding-top: 6px; }
|
||||||
|
.sheet-tab {
|
||||||
|
text-align: left;
|
||||||
|
padding: 9px 14px 9px 11px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-left: 0;
|
||||||
|
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-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 h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
|
||||||
|
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
|
||||||
|
.sheet-portrait { position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
|
||||||
|
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
|
||||||
|
.sheet-portrait img { display: block; width: 100%; height: auto; }
|
||||||
|
.portrait-upload { border: 0; padding: 8px 10px; background: transparent; color: var(--color-link); font-size: 12px; cursor: pointer; }
|
||||||
|
.portrait-controls { position: absolute; inset: auto 0 0 0; display: flex; align-items: center; justify-content: space-between; gap: 6px; padding: 6px 7px; background: var(--color-background-soft); border-top: 1px solid var(--color-border); }
|
||||||
|
.portrait-controls button { border: 1px solid var(--color-border); border-radius: 6px; padding: 4px 9px; background: var(--color-background-light); color: var(--color-text); font-size: 11px; cursor: pointer; }
|
||||||
|
.portrait-controls button:last-child { flex: 0 0 auto; padding: 3px 8px; font-size: 15px; line-height: 1; }
|
||||||
|
.portrait-controls button:hover { background: var(--color-button-hover); }
|
||||||
|
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
||||||
|
.photo-input { display: none; }
|
||||||
|
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
||||||
|
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. No penja de
|
||||||
|
cap pestanya: es queda al seu lloc mentre se'n canvia. */
|
||||||
|
.character-column { grid-column: 1; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
|
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
|
||||||
|
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||||
|
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
||||||
|
.ability-score { font: 25px MrEavesRemake; }
|
||||||
|
.ability-modifier { min-width: 33px; text-align: center; padding: 2px 5px; border-radius: 999px; background: var(--color-background); font-size: 12px; }
|
||||||
|
.ability-card input { width: 55px; text-align: center; font-size: 21px; }
|
||||||
|
/* Les habilitats i les tirades de salvació: el cercle diu si el personatge hi està
|
||||||
|
entrenat, al costat la característica que mana i la modificadora que tira. */
|
||||||
|
.saving-throw-grid { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 5px; }
|
||||||
|
.skill-grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 5px; }
|
||||||
|
.proficiency-row { display: flex; align-items: center; gap: 6px; min-width: 0; padding: 5px 7px; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); color: var(--color-text); font: inherit; font-size: 12px; text-align: left; cursor: pointer; }
|
||||||
|
.proficiency-row:hover:not(:disabled) { border-color: var(--color-link); }
|
||||||
|
.proficiency-row:disabled { cursor: default; }
|
||||||
|
.proficiency-dot { width: 14px; height: 14px; flex: 0 0 14px; border: 2px solid var(--color-border); border-radius: 50%; }
|
||||||
|
.proficiency-dot.proficient { border-color: var(--color-link); background: var(--color-link); box-shadow: inset 0 0 0 2px var(--color-background-soft); }
|
||||||
|
.proficiency-name { flex: 1; min-width: 0; overflow-wrap: anywhere; }
|
||||||
|
.proficiency-ability { font-size: 10px; letter-spacing: .06em; opacity: .6; }
|
||||||
|
.proficiency-modifier { font-size: 11px; opacity: .8; }
|
||||||
|
.proficiency-lists { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 11px; }
|
||||||
|
.vitals-panel { display: flex; flex-direction: column; gap: 11px; }
|
||||||
|
.vital-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 7px; }
|
||||||
|
.vital-stat { min-height: 68px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 4px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||||
|
.vital-stat > span { font-size: 10px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.vital-stat > strong { font: 25px MrEavesRemake; }
|
||||||
|
.vital-stat small { font-size: 11px; opacity: .7; }
|
||||||
|
.vital-stat input { width: 57px; text-align: center; }
|
||||||
|
/* Les dues barres: punts de cop i daus de cop, plenes fins on arriben. */
|
||||||
|
.vital-bar-head { display: flex; justify-content: space-between; align-items: center; gap: 8px; }
|
||||||
|
.vital-bar-head > span { font-size: 10px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.vital-bar-head > strong { font: 15px MrEavesRemake; white-space: nowrap; }
|
||||||
|
.vital-bar-inputs { display: flex; align-items: center; gap: 4px; }
|
||||||
|
.vital-bar-inputs input { width: 52px; text-align: center; }
|
||||||
|
.vital-bar-track { height: 8px; margin-top: 5px; overflow: hidden; border-radius: 999px; background: var(--color-background); }
|
||||||
|
.vital-bar-fill { height: 100%; border-radius: inherit; transition: width .2s ease; }
|
||||||
|
.hit-points-bar .vital-bar-fill { background: var(--color-red); }
|
||||||
|
.hit-dice-bar .vital-bar-fill { background: var(--color-link); }
|
||||||
|
.number-with-unit { display: flex; align-items: center; gap: 4px; }
|
||||||
|
.number-with-unit input { width: 57px; }
|
||||||
|
.sheet-copy { min-height: 74px; margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
|
||||||
|
input, textarea { box-sizing: border-box; max-width: 100%; padding: 6px 7px; border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit; }
|
||||||
|
input:focus, textarea:focus { outline: none; border-color: var(--color-link); }
|
||||||
|
textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
|
||||||
|
.traits-panel, .spells-panel { min-height: 175px; }
|
||||||
|
.panel-title-row { display: flex; justify-content: space-between; align-items: center; gap: 8px; }
|
||||||
|
.panel-title-row h2 { flex: 1; }
|
||||||
|
.weight-summary { display: flex; justify-content: space-between; align-items: center; gap: 8px; margin: 1px 0 7px; font-size: 12px; }
|
||||||
|
.weight-summary strong { white-space: nowrap; }
|
||||||
|
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
|
||||||
|
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
|
||||||
|
.inventory-table-wrap { overflow-x: auto; }
|
||||||
|
/* La moneda que el personatge porta a sobre, en les cinc del joc. */
|
||||||
|
.currency-row { display: grid; grid-template-columns: repeat(5, minmax(0, 1fr)); gap: 7px; margin-bottom: 11px; }
|
||||||
|
.currency-field { display: flex; flex-direction: column; align-items: center; gap: 3px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||||
|
.currency-field > span { font-size: 10px; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.currency-field > strong { font: 15px MrEavesRemake; }
|
||||||
|
.currency-field input { width: 58px; text-align: center; }
|
||||||
|
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; }
|
||||||
|
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
|
||||||
|
.inventory-table td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
|
||||||
|
.inventory-table td input { width: 100%; min-width: 54px; }
|
||||||
|
.inventory-table td.item-name-cell input { min-width: 100px; }
|
||||||
|
/* La icona de cada objecte obre la filera; el nom continua alineat a l'esquerra i la
|
||||||
|
quantitat i els pesos van al centre. */
|
||||||
|
.inventory-table .item-icon-cell { width: 40px; padding-right: 0; }
|
||||||
|
.item-icon-cell img { display: block; width: 26px; height: 26px; object-fit: contain; border-radius: 5px; }
|
||||||
|
.item-icon-blank { display: block; width: 26px; height: 26px; border: 1px dashed var(--color-border); border-radius: 5px; opacity: .35; }
|
||||||
|
.inventory-table th:not(:first-child):not(.item-name-cell), .inventory-table td:not(:first-child):not(.item-name-cell) { text-align: center; }
|
||||||
|
.empty-inventory { text-align: center !important; opacity: .65; }
|
||||||
|
.remove-item { width: 24px; height: 24px; border: 0; border-radius: 5px; background: transparent; color: var(--color-text); font-size: 20px; cursor: pointer; }
|
||||||
|
.remove-item:hover { background: var(--color-button-hover); }
|
||||||
|
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
|
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
|
||||||
|
@media (max-width: 760px) {
|
||||||
|
.sheet-layout { grid-template-columns: 1fr; }
|
||||||
|
.character-column, .sheet-tab-body { grid-column: 1 / -1; grid-row: auto; }
|
||||||
|
/* El cantó dret no dona prou per penjar-hi les pestanyes: llavors es queden al marc, per
|
||||||
|
dins, en una filera sota la barra de la finestra. */
|
||||||
|
.sheet-tabs { position: static; align-self: stretch; flex-direction: row; flex-wrap: wrap; gap: 4px; padding: 6px 8px 0; }
|
||||||
|
.sheet-tab { flex: 1 1 auto; text-align: center; border-left: 1px solid var(--color-border); border-radius: 8px 8px 0 0; }
|
||||||
|
}
|
||||||
|
@media (max-width: 520px) {
|
||||||
|
.sheet-body { padding: 10px; }
|
||||||
|
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
||||||
|
.sheet-actions { margin-left: auto; }
|
||||||
|
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||||
|
.skill-grid, .saving-throw-grid, .proficiency-lists { grid-template-columns: 1fr; }
|
||||||
|
.currency-row { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||||
|
}
|
||||||
|
</style>
|
||||||
149
frontend/app/components/windows/CreateCampaignEntryWindow.vue
Normal file
149
frontend/app/components/windows/CreateCampaignEntryWindow.vue
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const data = props.data;
|
||||||
|
const id = data.id;
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const saving = ref(false);
|
||||||
|
// The window edits items when the sidebar passes one in; actors have their sheet.
|
||||||
|
const editing = data.entry || null;
|
||||||
|
const isActor = data.entityType === 'actor';
|
||||||
|
const endpoint = isActor ? '/actor/create' : (editing ? '/item/update' : '/item/create');
|
||||||
|
|
||||||
|
function initialForm() {
|
||||||
|
if (!editing) {
|
||||||
|
return {
|
||||||
|
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
|
category: 'adventuring-gear', rarity: 'common', weight: '', properties: '', description: ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
|
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
|
||||||
|
weight: editing.weight ?? '', properties: editing.properties ?? '',
|
||||||
|
description: editing.description ?? ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const form = ref(initialForm());
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, isActor ? { width: 420, height: 220 } : { width: 500, height: 560 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => ClearWindow({ type: 'create_campaign_entry' }));
|
||||||
|
|
||||||
|
async function saveEntry() {
|
||||||
|
if (!form.value.name.trim() || saving.value) return;
|
||||||
|
saving.value = true;
|
||||||
|
try {
|
||||||
|
const payload = isActor
|
||||||
|
? { name: form.value.name.trim(), campaign: data.campaign }
|
||||||
|
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
|
||||||
|
if (!isActor) {
|
||||||
|
for (const field of ['category', 'rarity', 'weight', 'properties', 'description']) {
|
||||||
|
payload[field] = form.value[field];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const response = await Server().post(endpoint, payload);
|
||||||
|
if (response.data.status === 'ok') {
|
||||||
|
emitter.emit(editing ? 'campaign-entry-updated' : 'campaign-entry-created', { entityType: data.entityType, entry: response.data[isActor ? 'actor' : 'item'] });
|
||||||
|
ClearWindow({ id });
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// Keep the form open so the user can retry.
|
||||||
|
} finally {
|
||||||
|
saving.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
<div class="body">
|
||||||
|
<h3>{{ $t(editing ? 'campaigns.item.edit' : (isActor ? 'campaigns.actor.new' : 'campaigns.item.new')) }}</h3>
|
||||||
|
<p v-if="!isActor && editing?.foundryItemId" class="sync-note">{{ $t('campaigns.item.foundry-sync-note') }}</p>
|
||||||
|
<form @submit.prevent="saveEntry">
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.fields.name') }}</span>
|
||||||
|
<input v-model="form.name" required autofocus autocomplete="off">
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<template v-if="!isActor">
|
||||||
|
<div class="form-grid">
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.item.category') }}</span>
|
||||||
|
<select v-model="form.category">
|
||||||
|
<option value="weapon">{{ $t('campaigns.item.categories.weapon') }}</option>
|
||||||
|
<option value="armor">{{ $t('campaigns.item.categories.armor') }}</option>
|
||||||
|
<option value="shield">{{ $t('campaigns.item.categories.shield') }}</option>
|
||||||
|
<option value="adventuring-gear">{{ $t('campaigns.item.categories.adventuring-gear') }}</option>
|
||||||
|
<option value="magic-item">{{ $t('campaigns.item.categories.magic-item') }}</option>
|
||||||
|
<option value="consumable">{{ $t('campaigns.item.categories.consumable') }}</option>
|
||||||
|
<option value="tool">{{ $t('campaigns.item.categories.tool') }}</option>
|
||||||
|
<option value="treasure">{{ $t('campaigns.item.categories.treasure') }}</option>
|
||||||
|
<option value="other">{{ $t('campaigns.item.categories.other') }}</option>
|
||||||
|
</select>
|
||||||
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.item.rarity') }}</span>
|
||||||
|
<select v-model="form.rarity">
|
||||||
|
<option value="common">{{ $t('campaigns.item.rarities.common') }}</option>
|
||||||
|
<option value="uncommon">{{ $t('campaigns.item.rarities.uncommon') }}</option>
|
||||||
|
<option value="rare">{{ $t('campaigns.item.rarities.rare') }}</option>
|
||||||
|
<option value="very-rare">{{ $t('campaigns.item.rarities.very-rare') }}</option>
|
||||||
|
<option value="legendary">{{ $t('campaigns.item.rarities.legendary') }}</option>
|
||||||
|
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
|
||||||
|
</select>
|
||||||
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.item.weight') }}</span>
|
||||||
|
<input v-model="form.weight" type="number" min="0" step="0.1">
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.item.properties') }}</span>
|
||||||
|
<input v-model="form.properties" :placeholder="$t('campaigns.item.properties-placeholder')">
|
||||||
|
</label>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<label v-if="!isActor" class="form-field">
|
||||||
|
<span>{{ $t('campaigns.fields.description') }}</span>
|
||||||
|
<textarea v-model="form.description" rows="3" />
|
||||||
|
</label>
|
||||||
|
<div class="form-actions">
|
||||||
|
<button class="btn-primary sound-click" type="submit" :disabled="saving">
|
||||||
|
{{ saving ? $t('campaigns.actions.saving') : $t(editing ? 'campaigns.actions.save' : 'campaigns.actions.submit') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
||||||
|
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; }
|
||||||
|
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
||||||
|
.sync-note { margin: -8px 0 12px; font-size: 12px; opacity: 0.72; }
|
||||||
|
form { display: flex; flex-direction: column; gap: 10px; }
|
||||||
|
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
||||||
|
.form-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }
|
||||||
|
input, select, textarea {
|
||||||
|
box-sizing: border-box; width: 100%; padding: 7px 8px; border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit;
|
||||||
|
}
|
||||||
|
textarea { resize: vertical; }
|
||||||
|
input:focus, select:focus, textarea:focus { outline: none; border-color: var(--color-link); }
|
||||||
|
.form-actions { display: flex; justify-content: center; margin-top: 2px; }
|
||||||
|
.form-actions button { width: 100%; max-width: 220px; }
|
||||||
|
</style>
|
||||||
194
frontend/app/components/windows/CreateMapWindow.vue
Normal file
194
frontend/app/components/windows/CreateMapWindow.vue
Normal file
@@ -0,0 +1,194 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { useI18n } from 'vue-i18n';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const { t } = useI18n();
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const data = props.data;
|
||||||
|
const id = data.id;
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const saving = ref(false);
|
||||||
|
const error = ref('');
|
||||||
|
const imageInput = ref(null);
|
||||||
|
// Passing an entry edits an existing map; otherwise this window creates one.
|
||||||
|
const editing = data.entry || null;
|
||||||
|
|
||||||
|
function initialForm() {
|
||||||
|
return {
|
||||||
|
name: editing?.name ?? '',
|
||||||
|
gridSize: Number(editing?.gridSize ?? 50),
|
||||||
|
offsetX: Number(editing?.offsetX ?? 0),
|
||||||
|
offsetY: Number(editing?.offsetY ?? 0),
|
||||||
|
scale: Number(editing?.scale ?? 5)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const form = ref(initialForm());
|
||||||
|
const selectedImage = ref(null);
|
||||||
|
let previewObjectUrl = null;
|
||||||
|
|
||||||
|
function serverImageUrl(image) {
|
||||||
|
if (!image) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
const previewUrl = ref(serverImageUrl(editing?.image));
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 500, height: 600 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
ClearWindow({ type: 'create_map' });
|
||||||
|
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
|
||||||
|
});
|
||||||
|
|
||||||
|
function pickImage() {
|
||||||
|
imageInput.value?.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
function onImageSelected(event) {
|
||||||
|
const file = event.target.files?.[0];
|
||||||
|
event.target.value = '';
|
||||||
|
if (!file) return;
|
||||||
|
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
|
||||||
|
previewObjectUrl = URL.createObjectURL(file);
|
||||||
|
selectedImage.value = file;
|
||||||
|
previewUrl.value = previewObjectUrl;
|
||||||
|
}
|
||||||
|
|
||||||
|
const numberFields = ['gridSize', 'offsetX', 'offsetY', 'scale'];
|
||||||
|
|
||||||
|
async function saveMap() {
|
||||||
|
if (!form.value.name.trim() || saving.value) return;
|
||||||
|
saving.value = true;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const body = new FormData();
|
||||||
|
body.append('name', form.value.name.trim());
|
||||||
|
if (editing) body.append('id', editing._id);
|
||||||
|
else body.append('campaign', data.campaign);
|
||||||
|
for (const field of numberFields) {
|
||||||
|
if (Number.isFinite(form.value[field])) body.append(field, String(form.value[field]));
|
||||||
|
}
|
||||||
|
if (selectedImage.value) body.append('image', selectedImage.value);
|
||||||
|
|
||||||
|
const response = await Server().post(editing ? '/map/update' : '/map/create', body, {
|
||||||
|
headers: { "Content-Type": "multipart/form-data" }
|
||||||
|
});
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t('campaigns.map.save-error');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
emitter.emit(editing ? 'campaign-entry-updated' : 'campaign-entry-created', { entityType: 'map', entry: response.data.map });
|
||||||
|
ClearWindow({ id });
|
||||||
|
} catch (requestError) {
|
||||||
|
error.value = t('campaigns.map.save-error');
|
||||||
|
} finally {
|
||||||
|
saving.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
<div class="body">
|
||||||
|
<h3>{{ $t(editing ? 'campaigns.map.edit' : 'campaigns.map.new') }}</h3>
|
||||||
|
<div v-if="error" class="form-error">{{ error }}</div>
|
||||||
|
<form @submit.prevent="saveMap">
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.fields.name') }}</span>
|
||||||
|
<input v-model="form.name" required autofocus autocomplete="off">
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<div class="form-field">
|
||||||
|
<span>{{ $t('campaigns.map.photo') }}</span>
|
||||||
|
<div class="image-picker" :class="{ empty: !previewUrl }">
|
||||||
|
<img v-if="previewUrl" :src="previewUrl" :alt="$t('campaigns.map.photo')">
|
||||||
|
<button class="pick-image sound-click" type="button" :disabled="saving" @click="pickImage">
|
||||||
|
{{ $t(previewUrl ? 'campaigns.map.change-photo' : 'campaigns.map.upload-photo') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<small class="field-help">{{ $t('campaigns.map.photo-hint') }}</small>
|
||||||
|
<input ref="imageInput" class="image-input" type="file" accept="image/*" @change="onImageSelected">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-grid">
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.map.grid-size') }}</span>
|
||||||
|
<input v-model.number="form.gridSize" type="number" min="1" step="1">
|
||||||
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.map.scale') }}</span>
|
||||||
|
<!-- step="any": any decimal works, the 0.01 minimum alone keeps it positive -->
|
||||||
|
<input v-model.number="form.scale" type="number" min="0.01" step="any" inputmode="decimal">
|
||||||
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
||||||
|
<input v-model.number="form.offsetX" type="number" step="1">
|
||||||
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.map.offset-y') }}</span>
|
||||||
|
<input v-model.number="form.offsetY" type="number" step="1">
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<small class="field-help">{{ $t('campaigns.map.scale-help') }}</small>
|
||||||
|
|
||||||
|
<div class="form-actions">
|
||||||
|
<button class="btn-primary sound-click" type="submit" :disabled="saving">
|
||||||
|
{{ saving ? $t('campaigns.actions.saving') : $t('campaigns.actions.save') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
||||||
|
/* Stretch so the outer margin insets the content instead of overflowing the window. */
|
||||||
|
.body {
|
||||||
|
flex: 1;
|
||||||
|
min-height: 0;
|
||||||
|
align-self: stretch;
|
||||||
|
box-sizing: border-box;
|
||||||
|
margin: 10px;
|
||||||
|
padding: 8px;
|
||||||
|
overflow-y: auto;
|
||||||
|
}
|
||||||
|
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
||||||
|
form { display: flex; flex-direction: column; gap: 10px; }
|
||||||
|
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
||||||
|
.form-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }
|
||||||
|
input {
|
||||||
|
box-sizing: border-box; width: 100%; padding: 7px 8px; border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit;
|
||||||
|
}
|
||||||
|
input:focus { outline: none; border-color: var(--color-link); }
|
||||||
|
.image-picker {
|
||||||
|
min-height: 96px; display: flex; align-items: center; justify-content: center; overflow: hidden;
|
||||||
|
border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft);
|
||||||
|
}
|
||||||
|
.image-picker.empty { border-style: dashed; }
|
||||||
|
.image-picker img { max-width: 100%; max-height: 180px; object-fit: contain; }
|
||||||
|
.pick-image {
|
||||||
|
border: 1px solid var(--color-border); border-radius: 6px; padding: 5px 10px; margin: 6px;
|
||||||
|
background: var(--color-background-light); color: var(--color-text); font-size: 12px; cursor: pointer;
|
||||||
|
}
|
||||||
|
.pick-image:hover { background: var(--color-button-hover); }
|
||||||
|
.pick-image:disabled { opacity: .55; cursor: wait; }
|
||||||
|
.image-input { display: none; }
|
||||||
|
.field-help { font-size: 11px; opacity: .72; }
|
||||||
|
.form-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
|
.form-actions { display: flex; justify-content: center; margin-top: 2px; }
|
||||||
|
.form-actions button { width: 100%; max-width: 220px; }
|
||||||
|
</style>
|
||||||
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, nextTick, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||||
|
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
|
||||||
|
|
||||||
|
// La documentació dins d'una finestra: el sumari a l'esquerra i la pàgina al centre, amb el
|
||||||
|
// mateix contingut de app/content/docs que la pàgina pública de /docs (mira ~/services/Docs.js).
|
||||||
|
// El sumari no porta enlloc amb rutes sinó amb estat propi, així obrir la documentació dins
|
||||||
|
// d'una campanya no deixa les notes obertes enrere.
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const reading = ref(null);
|
||||||
|
|
||||||
|
const nav = GetDocsNav();
|
||||||
|
const slug = ref(GetDocsFirstSlug());
|
||||||
|
const page = computed(() => GetDocsPage(slug.value));
|
||||||
|
|
||||||
|
function GoTo(target) {
|
||||||
|
if (!GetDocsPage(target)) return;
|
||||||
|
slug.value = target;
|
||||||
|
// Cada pàgina es comença a dalt, com faria el navegador.
|
||||||
|
nextTick(() => { if (reading.value) reading.value.scrollTop = 0; });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Els enllaços que el markdown porta a dins (`[Foundry](/docs/foundry)`) i els seus apartats
|
||||||
|
// s'han de seguir dins la finestra: sortir-ne per via d'una ruta deixaria la campanya enrere.
|
||||||
|
function OnContentClick(event) {
|
||||||
|
const link = event.target?.closest?.('a');
|
||||||
|
if (!link) return;
|
||||||
|
|
||||||
|
const href = link.getAttribute('href') || '';
|
||||||
|
|
||||||
|
// Un apartat de la pàgina: el que fila és la columna de lectura, no la pantalla.
|
||||||
|
if (href.startsWith('#')) {
|
||||||
|
if (href.length < 2) return;
|
||||||
|
const heading = reading.value?.querySelector('#' + CSS.escape(href.slice(1)));
|
||||||
|
if (!heading) return;
|
||||||
|
event.preventDefault();
|
||||||
|
heading.scrollIntoView({ block: 'start' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const inside = /^\/docs\/?([a-z0-9-]*)$/.exec(href);
|
||||||
|
if (inside) {
|
||||||
|
event.preventDefault();
|
||||||
|
GoTo(inside[1] || GetDocsFirstSlug());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fora de la documentació: una pestanya nova, que la campanya no es mou d'aquí.
|
||||||
|
if (href && !href.startsWith('/')) {
|
||||||
|
event.preventDefault();
|
||||||
|
window.open(href, '_blank', 'noopener');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, {
|
||||||
|
width: Math.max(620, Math.min(1000, window.innerWidth - 24)),
|
||||||
|
height: Math.max(420, Math.min(780, window.innerHeight - 32))
|
||||||
|
});
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
SetResizable(id, true);
|
||||||
|
SetMinSize(id, { width: 620, height: 420 });
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
|
||||||
|
<!-- Body -->
|
||||||
|
<div class="docs-body">
|
||||||
|
<aside class="docs-contents" :aria-label="$t('docs.contents')">
|
||||||
|
<section v-for="group in nav" :key="group.key" class="docs-group">
|
||||||
|
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li v-for="entry in group.pages" :key="entry.slug">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="docs-nav-link sound-click"
|
||||||
|
:class="{ active: entry.slug === slug }"
|
||||||
|
v-on:click="GoTo(entry.slug)"
|
||||||
|
>{{ entry.title }}</button>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
<div class="docs-reading" ref="reading">
|
||||||
|
<template v-if="page">
|
||||||
|
<article class="docs-article" v-on:click="OnContentClick">
|
||||||
|
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
|
||||||
|
<!-- El contingut és markdown nostre, de app/content/docs -->
|
||||||
|
<div class="docs-markdown" v-html="page.html"></div>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<nav class="docs-pager">
|
||||||
|
<button
|
||||||
|
v-if="page.previous"
|
||||||
|
type="button"
|
||||||
|
class="docs-pager-link sound-click"
|
||||||
|
v-on:click="GoTo(page.previous.slug)"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
|
||||||
|
<strong>{{ page.previous.title }}</strong>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
v-if="page.next"
|
||||||
|
type="button"
|
||||||
|
class="docs-pager-link next sound-click"
|
||||||
|
v-on:click="GoTo(page.next.slug)"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
|
||||||
|
<strong>{{ page.next.title }}</strong>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<article v-else class="docs-article">
|
||||||
|
<h1>{{ $t('docs.title') }}</h1>
|
||||||
|
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
/* El sumari i la lectura són les dues columnes d'una finestra: cada una fila per la seva,
|
||||||
|
res d'una pantalla d'alçada ni de sticky, que la finestra ja és el que es mou. */
|
||||||
|
.docs-body {
|
||||||
|
display: flex;
|
||||||
|
flex: 1;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents {
|
||||||
|
flex: 0 0 212px;
|
||||||
|
min-width: 0;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 14px 10px;
|
||||||
|
border-right: 1px solid var(--color-border);
|
||||||
|
overflow-y: auto;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-group-title {
|
||||||
|
margin: 0 0 6px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Les pàgines del sumari són botons: una finestra no té rutes a seguir. */
|
||||||
|
.docs-nav-link {
|
||||||
|
width: 100%;
|
||||||
|
margin: 0;
|
||||||
|
padding: 6px 9px;
|
||||||
|
border: none;
|
||||||
|
border-radius: 6px;
|
||||||
|
box-shadow: none;
|
||||||
|
background-color: transparent;
|
||||||
|
font-size: 0.95rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
text-align: left;
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link.active {
|
||||||
|
background-color: var(--color-background-soft);
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-reading {
|
||||||
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 20px 26px 40px 26px;
|
||||||
|
overflow-y: auto;
|
||||||
|
/* El que es llegeix es pot seleccionar, encara que una finestra no ho permeti per defecte. */
|
||||||
|
user-select: text;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* La columna de lectura, centrada dins l'espai que deixa el sumari. */
|
||||||
|
.docs-article,
|
||||||
|
.docs-pager {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 720px;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-kicker {
|
||||||
|
margin: 0 0 4px 0;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager {
|
||||||
|
margin-top: 30px;
|
||||||
|
padding-top: 16px;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Són els botons d'abans i després, no botons d'un formulari: van plans, com a /docs. */
|
||||||
|
.docs-pager-link {
|
||||||
|
flex: 1 1 0;
|
||||||
|
min-width: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 10px 12px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
box-shadow: none;
|
||||||
|
text-align: left;
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link.next {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-label {
|
||||||
|
display: block;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
letter-spacing: 0.06em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
</style>
|
||||||
171
frontend/app/components/windows/FoundryIconPickerWindow.vue
Normal file
171
frontend/app/components/windows/FoundryIconPickerWindow.vue
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
<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) {
|
||||||
|
// The route answers every real failure with an i18n key in `msg`, but
|
||||||
|
// axios rejects a non-2xx response, so this catch would otherwise blame
|
||||||
|
// the bridge for anything at all — a campaign without a world address,
|
||||||
|
// a folder that went missing. Read the reason off the response and say
|
||||||
|
// that instead (Syndria98/dragonroll#74).
|
||||||
|
error.value = t(requestError.response?.data?.msg || '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>
|
||||||
128
frontend/app/components/windows/ItemIconSourceWindow.vue
Normal file
128
frontend/app/components/windows/ItemIconSourceWindow.vue
Normal 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>
|
||||||
197
frontend/app/components/windows/ItemSheetWindow.vue
Normal file
197
frontend/app/components/windows/ItemSheetWindow.vue
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
<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',
|
||||||
|
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>
|
||||||
|
|
||||||
|
<!-- Quantity is the actor inventory's business (Syndria98/dragonroll#63); the item
|
||||||
|
sheet only states what the item itself is. -->
|
||||||
|
<dl class="item-facts">
|
||||||
|
<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>
|
||||||
@@ -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>
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -76,6 +76,7 @@ onMounted(() => {
|
|||||||
<div class="vert bot">
|
<div class="vert bot">
|
||||||
<div class="button-container">
|
<div class="button-container">
|
||||||
<button class="btn-primary button-expand sound-click" v-on:click="CreateCampaignWindow" ref="campaignButton">{{ $t("main-menu.create-campaign") }}</button>
|
<button class="btn-primary button-expand sound-click" v-on:click="CreateCampaignWindow" ref="campaignButton">{{ $t("main-menu.create-campaign") }}</button>
|
||||||
|
<a class="btn-primary button-expand docs-link" href="/docs">{{ $t("main-menu.documentation") }}</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -145,6 +146,24 @@ h2, h3 {
|
|||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* L'enllaç a la documentació és un `<a>` i els botons estan estilats per element, així
|
||||||
|
que li toca portar el mateix look. */
|
||||||
|
.docs-link {
|
||||||
|
display: block;
|
||||||
|
padding: 14px;
|
||||||
|
border-radius: 6px;
|
||||||
|
border: solid 1px var(--color-border);
|
||||||
|
background-color: var(--color-button-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
transition: 300ms background-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-link:hover {
|
||||||
|
background-color: var(--color-button-hover);
|
||||||
|
}
|
||||||
|
|
||||||
p {
|
p {
|
||||||
user-select: none;
|
user-select: none;
|
||||||
}
|
}
|
||||||
|
|||||||
33
frontend/app/components/windows/MapViewerWindow.vue
Normal file
33
frontend/app/components/windows/MapViewerWindow.vue
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import MapViewerPane from '../viewer/map/MapViewerPane.vue';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const map = props.data.map ? { ...props.data.map } : null;
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, {
|
||||||
|
width: Math.max(480, Math.min(1100, window.innerWidth - 24)),
|
||||||
|
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
||||||
|
});
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
<MapViewerPane :map="map" />
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.viewer-window { min-width: 320px; min-height: 0; }
|
||||||
|
</style>
|
||||||
140
frontend/app/components/windows/NewFolderWindow.vue
Normal file
140
frontend/app/components/windows/NewFolderWindow.vue
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const data = props.data;
|
||||||
|
|
||||||
|
let id = data.id;
|
||||||
|
|
||||||
|
const newName = ref('');
|
||||||
|
const creating = !!data.name;
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
newName.value = data.name || '';
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 420, height: 200 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
ClearWindow({ type: 'new_folder' });
|
||||||
|
});
|
||||||
|
|
||||||
|
function confirmSave() {
|
||||||
|
if (!newName.value.trim()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const folderData = {
|
||||||
|
name: newName.value.trim(),
|
||||||
|
campaign: data.campaign
|
||||||
|
};
|
||||||
|
|
||||||
|
const url = creating ? '/folder/rename' : '/folder/create';
|
||||||
|
if (creating) {
|
||||||
|
folderData.id = data.folderId;
|
||||||
|
} 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) => {
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
emitter.emit('folder-saved', response.data.folder);
|
||||||
|
ClearWindow({ id });
|
||||||
|
}).catch(() => {});
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
|
||||||
|
<div class="body">
|
||||||
|
<h3>{{ creating ? 'Rename Folder' : 'New Folder' }}</h3>
|
||||||
|
<form v-on:submit.prevent="confirmSave">
|
||||||
|
<div class="form-field">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
v-model="newName"
|
||||||
|
placeholder="Folder name"
|
||||||
|
autofocus
|
||||||
|
autocomplete="off"
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<div class="form-actions">
|
||||||
|
<button class="btn-primary sound-click" type="submit">{{ creating ? 'Save' : 'Create' }}</button>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.window-wrapper {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.body {
|
||||||
|
width: 100%;
|
||||||
|
padding: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
margin: 0 0 10px 10px;
|
||||||
|
font-family: MrEavesRemake;
|
||||||
|
}
|
||||||
|
|
||||||
|
form {
|
||||||
|
margin-left: 10px;
|
||||||
|
margin-right: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-field {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: row;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-field > * {
|
||||||
|
flex-grow: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
input {
|
||||||
|
width: 100%;
|
||||||
|
padding: 6px 8px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
|
background: var(--color-background-soft);
|
||||||
|
color: var(--color-text);
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
input:focus {
|
||||||
|
outline: none;
|
||||||
|
border-color: var(--color-accent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-actions {
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-actions button {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 200px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
130
frontend/app/components/windows/NewNoteWindow.vue
Normal file
130
frontend/app/components/windows/NewNoteWindow.vue
Normal file
@@ -0,0 +1,130 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const data = props.data;
|
||||||
|
|
||||||
|
let id = data.id;
|
||||||
|
|
||||||
|
const newName = ref('');
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 420, height: 200 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
ClearWindow({ type: 'new_note' });
|
||||||
|
});
|
||||||
|
|
||||||
|
function confirmCreate() {
|
||||||
|
if (!newName.value.trim()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
Server().post('/note/create', {
|
||||||
|
title: newName.value.trim(),
|
||||||
|
content: '',
|
||||||
|
campaign: data.campaign,
|
||||||
|
folder: data.folder ?? null
|
||||||
|
}).then((response) => {
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
emitter.emit('note-created', response.data.note);
|
||||||
|
ClearWindow({ id });
|
||||||
|
}).catch(() => {});
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
|
||||||
|
<div class="body">
|
||||||
|
<h3>New Note</h3>
|
||||||
|
<form v-on:submit.prevent="confirmCreate">
|
||||||
|
<div class="form-field">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
v-model="newName"
|
||||||
|
placeholder="Note title"
|
||||||
|
autofocus
|
||||||
|
autocomplete="off"
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<div class="form-actions">
|
||||||
|
<button class="btn-primary sound-click" type="submit">Create</button>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.window-wrapper {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.body {
|
||||||
|
width: 100%;
|
||||||
|
padding: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
margin: 0 0 10px 10px;
|
||||||
|
font-family: MrEavesRemake;
|
||||||
|
}
|
||||||
|
|
||||||
|
form {
|
||||||
|
margin-left: 10px;
|
||||||
|
margin-right: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-field {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: row;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-field > * {
|
||||||
|
flex-grow: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
input {
|
||||||
|
width: 100%;
|
||||||
|
padding: 6px 8px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
|
background: var(--color-background-soft);
|
||||||
|
color: var(--color-text);
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
input:focus {
|
||||||
|
outline: none;
|
||||||
|
border-color: var(--color-accent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-actions {
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-actions button {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 200px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
122
frontend/app/components/windows/PinnedNoteWindow.vue
Normal file
122
frontend/app/components/windows/PinnedNoteWindow.vue
Normal 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>
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user