Compare commits
1 Commits
ai/issue-1
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
| caeff595da |
@@ -1,440 +0,0 @@
|
|||||||
---
|
|
||||||
name: accessibility
|
|
||||||
description: Audit and improve web accessibility following WCAG 2.2 guidelines. Use when asked to "improve accessibility", "a11y audit", "WCAG compliance", "screen reader support", "keyboard navigation", or "make accessible".
|
|
||||||
license: MIT
|
|
||||||
metadata:
|
|
||||||
author: web-quality-skills
|
|
||||||
version: "1.1"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Accessibility (a11y)
|
|
||||||
|
|
||||||
Comprehensive accessibility guidelines based on WCAG 2.2 and Lighthouse accessibility audits. Goal: make content usable by everyone, including people with disabilities.
|
|
||||||
|
|
||||||
## WCAG Principles: POUR
|
|
||||||
|
|
||||||
| Principle | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| **P**erceivable | Content can be perceived through different senses |
|
|
||||||
| **O**perable | Interface can be operated by all users |
|
|
||||||
| **U**nderstandable | Content and interface are understandable |
|
|
||||||
| **R**obust | Content works with assistive technologies |
|
|
||||||
|
|
||||||
## Conformance levels
|
|
||||||
|
|
||||||
| Level | Requirement | Target |
|
|
||||||
|-------|-------------|--------|
|
|
||||||
| **A** | Minimum accessibility | Must pass |
|
|
||||||
| **AA** | Standard compliance | Should pass (legal requirement in many jurisdictions) |
|
|
||||||
| **AAA** | Enhanced accessibility | Nice to have |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Perceivable
|
|
||||||
|
|
||||||
### Text alternatives (1.1)
|
|
||||||
|
|
||||||
**Images require alt text:**
|
|
||||||
```html
|
|
||||||
<!-- ❌ Missing alt -->
|
|
||||||
<img src="chart.png">
|
|
||||||
|
|
||||||
<!-- ✅ Descriptive alt -->
|
|
||||||
<img src="chart.png" alt="Bar chart showing 40% increase in Q3 sales">
|
|
||||||
|
|
||||||
<!-- ✅ Decorative image (empty alt) -->
|
|
||||||
<img src="decorative-border.png" alt="" role="presentation">
|
|
||||||
|
|
||||||
<!-- ✅ Complex image with longer description -->
|
|
||||||
<figure>
|
|
||||||
<img src="infographic.png" alt="2024 market trends infographic"
|
|
||||||
aria-describedby="infographic-desc">
|
|
||||||
<figcaption id="infographic-desc">
|
|
||||||
<!-- Detailed description -->
|
|
||||||
</figcaption>
|
|
||||||
</figure>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Icon buttons need accessible names:**
|
|
||||||
```html
|
|
||||||
<!-- ❌ No accessible name -->
|
|
||||||
<button><svg><!-- menu icon --></svg></button>
|
|
||||||
|
|
||||||
<!-- ✅ Using aria-label -->
|
|
||||||
<button aria-label="Open menu">
|
|
||||||
<svg aria-hidden="true"><!-- menu icon --></svg>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<!-- ✅ Using visually hidden text -->
|
|
||||||
<button>
|
|
||||||
<svg aria-hidden="true"><!-- menu icon --></svg>
|
|
||||||
<span class="visually-hidden">Open menu</span>
|
|
||||||
</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Visually hidden class:**
|
|
||||||
```css
|
|
||||||
.visually-hidden {
|
|
||||||
position: absolute;
|
|
||||||
width: 1px;
|
|
||||||
height: 1px;
|
|
||||||
padding: 0;
|
|
||||||
margin: -1px;
|
|
||||||
overflow: hidden;
|
|
||||||
clip: rect(0, 0, 0, 0);
|
|
||||||
white-space: nowrap;
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Color contrast (1.4.3, 1.4.6)
|
|
||||||
|
|
||||||
| Text Size | AA minimum | AAA enhanced |
|
|
||||||
|-----------|------------|--------------|
|
|
||||||
| Normal text (< 18px / < 14px bold) | 4.5:1 | 7:1 |
|
|
||||||
| Large text (≥ 18px / ≥ 14px bold) | 3:1 | 4.5:1 |
|
|
||||||
| UI components & graphics | 3:1 | 3:1 |
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ❌ Low contrast (2.5:1) */
|
|
||||||
.low-contrast {
|
|
||||||
color: #999;
|
|
||||||
background: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Sufficient contrast (7:1) */
|
|
||||||
.high-contrast {
|
|
||||||
color: #333;
|
|
||||||
background: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Focus states need contrast too */
|
|
||||||
:focus-visible {
|
|
||||||
outline: 2px solid #005fcc;
|
|
||||||
outline-offset: 2px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Don't rely on color alone:**
|
|
||||||
```html
|
|
||||||
<!-- ❌ Only color indicates error -->
|
|
||||||
<input class="error-border">
|
|
||||||
<style>.error-border { border-color: red; }</style>
|
|
||||||
|
|
||||||
<!-- ✅ Color + icon + text -->
|
|
||||||
<div class="field-error">
|
|
||||||
<input aria-invalid="true" aria-describedby="email-error">
|
|
||||||
<span id="email-error" class="error-message">
|
|
||||||
<svg aria-hidden="true"><!-- error icon --></svg>
|
|
||||||
Please enter a valid email address
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Media alternatives (1.2)
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- Video with captions -->
|
|
||||||
<video controls>
|
|
||||||
<source src="video.mp4" type="video/mp4">
|
|
||||||
<track kind="captions" src="captions.vtt" srclang="en" label="English" default>
|
|
||||||
<track kind="descriptions" src="descriptions.vtt" srclang="en" label="Descriptions">
|
|
||||||
</video>
|
|
||||||
|
|
||||||
<!-- Audio with transcript -->
|
|
||||||
<audio controls>
|
|
||||||
<source src="podcast.mp3" type="audio/mp3">
|
|
||||||
</audio>
|
|
||||||
<details>
|
|
||||||
<summary>Transcript</summary>
|
|
||||||
<p>Full transcript text...</p>
|
|
||||||
</details>
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Operable
|
|
||||||
|
|
||||||
### Keyboard accessible (2.1)
|
|
||||||
|
|
||||||
**All functionality must be keyboard accessible:**
|
|
||||||
```javascript
|
|
||||||
// ❌ Only handles click
|
|
||||||
element.addEventListener('click', handleAction);
|
|
||||||
|
|
||||||
// ✅ Handles both click and keyboard
|
|
||||||
element.addEventListener('click', handleAction);
|
|
||||||
element.addEventListener('keydown', (e) => {
|
|
||||||
if (e.key === 'Enter' || e.key === ' ') {
|
|
||||||
e.preventDefault();
|
|
||||||
handleAction();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**No keyboard traps.** Users must be able to Tab into and out of every component. Use the [modal focus trap pattern](references/A11Y-PATTERNS.md#modal-focus-trap) for dialogs—the native `<dialog>` element handles this automatically.
|
|
||||||
|
|
||||||
### Focus visible (2.4.7)
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ❌ Never remove focus outlines */
|
|
||||||
*:focus { outline: none; }
|
|
||||||
|
|
||||||
/* ✅ Use :focus-visible for keyboard-only focus */
|
|
||||||
:focus {
|
|
||||||
outline: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
:focus-visible {
|
|
||||||
outline: 2px solid #005fcc;
|
|
||||||
outline-offset: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Or custom focus styles */
|
|
||||||
button:focus-visible {
|
|
||||||
box-shadow: 0 0 0 3px rgba(0, 95, 204, 0.5);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Focus not obscured (2.4.11) — new in 2.2
|
|
||||||
|
|
||||||
When an element receives keyboard focus, it must not be entirely hidden by other author-created content such as sticky headers, footers, or overlapping panels. At Level AAA (2.4.12), no part of the focused element may be hidden.
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ✅ Account for sticky headers when scrolling to focused elements */
|
|
||||||
:target {
|
|
||||||
scroll-margin-top: 80px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Ensure focused items clear fixed/sticky bars */
|
|
||||||
:focus {
|
|
||||||
scroll-margin-top: 80px;
|
|
||||||
scroll-margin-bottom: 60px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Skip links (2.4.1)
|
|
||||||
|
|
||||||
Provide a skip link so keyboard users can bypass repetitive navigation. See the [skip link pattern](references/A11Y-PATTERNS.md#skip-link) for full markup and styles.
|
|
||||||
|
|
||||||
### Target size (2.5.8) — new in 2.2
|
|
||||||
|
|
||||||
Interactive targets must be at least **24 × 24 CSS pixels** (AA). Exceptions: inline text links, elements where the browser controls the size, and targets where a 24px circle centered on the bounding box does not overlap another target.
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ✅ Minimum target size */
|
|
||||||
button,
|
|
||||||
[role="button"],
|
|
||||||
input[type="checkbox"] + label,
|
|
||||||
input[type="radio"] + label {
|
|
||||||
min-width: 24px;
|
|
||||||
min-height: 24px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Comfortable target size (recommended 44×44) */
|
|
||||||
.touch-target {
|
|
||||||
min-width: 44px;
|
|
||||||
min-height: 44px;
|
|
||||||
display: inline-flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Dragging movements (2.5.7) — new in 2.2
|
|
||||||
|
|
||||||
Any action that requires dragging must have a single-pointer alternative (e.g., buttons, inputs). See the [dragging movements pattern](references/A11Y-PATTERNS.md#dragging-movements) for a sortable-list example.
|
|
||||||
|
|
||||||
### Timing (2.2)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
// Allow users to extend time limits
|
|
||||||
function showSessionWarning() {
|
|
||||||
const modal = createModal({
|
|
||||||
title: 'Session Expiring',
|
|
||||||
content: 'Your session will expire in 2 minutes.',
|
|
||||||
actions: [
|
|
||||||
{ label: 'Extend session', action: extendSession },
|
|
||||||
{ label: 'Log out', action: logout }
|
|
||||||
],
|
|
||||||
timeout: 120000
|
|
||||||
});
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Motion (2.3)
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* Respect reduced motion preference */
|
|
||||||
@media (prefers-reduced-motion: reduce) {
|
|
||||||
*,
|
|
||||||
*::before,
|
|
||||||
*::after {
|
|
||||||
animation-duration: 0.01ms !important;
|
|
||||||
animation-iteration-count: 1 !important;
|
|
||||||
transition-duration: 0.01ms !important;
|
|
||||||
scroll-behavior: auto !important;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Understandable
|
|
||||||
|
|
||||||
### Page language (3.1.1)
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ No language specified -->
|
|
||||||
<html>
|
|
||||||
|
|
||||||
<!-- ✅ Language specified -->
|
|
||||||
<html lang="en">
|
|
||||||
|
|
||||||
<!-- ✅ Language changes within page -->
|
|
||||||
<p>The French word for hello is <span lang="fr">bonjour</span>.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Consistent navigation (3.2.3)
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- Navigation should be consistent across pages -->
|
|
||||||
<nav aria-label="Main">
|
|
||||||
<ul>
|
|
||||||
<li><a href="/" aria-current="page">Home</a></li>
|
|
||||||
<li><a href="/products">Products</a></li>
|
|
||||||
<li><a href="/about">About</a></li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Consistent help (3.2.6) — new in 2.2
|
|
||||||
|
|
||||||
If a help mechanism (contact info, chat widget, FAQ link, self-help option) is repeated across multiple pages, it must appear in the **same relative order** each time. Users who rely on consistent placement shouldn't have to hunt for help on every page.
|
|
||||||
|
|
||||||
### Form labels (3.3.2)
|
|
||||||
|
|
||||||
Every input needs a programmatically associated label. See the [form labels pattern](references/A11Y-PATTERNS.md#form-labels) for explicit, implicit, and instructional examples.
|
|
||||||
|
|
||||||
### Error handling (3.3.1, 3.3.3)
|
|
||||||
|
|
||||||
Announce errors to screen readers with `role="alert"` or `aria-live`, set `aria-invalid="true"` on invalid fields, and focus the first error on submit. See the [error handling pattern](references/A11Y-PATTERNS.md#error-handling) for full markup and JS.
|
|
||||||
|
|
||||||
### Redundant entry (3.3.7) — new in 2.2
|
|
||||||
|
|
||||||
Don't force users to re-enter information they already provided in the same session. Auto-populate from earlier steps, or let users select from previously entered values. Exceptions: security re-confirmation and content that has expired.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ✅ Auto-fill shipping address from billing -->
|
|
||||||
<fieldset>
|
|
||||||
<legend>Shipping address</legend>
|
|
||||||
<label>
|
|
||||||
<input type="checkbox" id="same-as-billing" checked>
|
|
||||||
Same as billing address
|
|
||||||
</label>
|
|
||||||
<!-- Fields auto-populated when checked -->
|
|
||||||
</fieldset>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Accessible authentication (3.3.8) — new in 2.2
|
|
||||||
|
|
||||||
Login flows must not rely on cognitive function tests (e.g., remembering a password, solving a puzzle) unless at least one of:
|
|
||||||
- A copy-paste or autofill mechanism is available
|
|
||||||
- An alternative method exists (e.g., passkey, SSO, email link)
|
|
||||||
- The test uses object recognition or personal content (AA only; AAA removes this exception)
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ✅ Allow paste in password fields -->
|
|
||||||
<input type="password" id="password" autocomplete="current-password">
|
|
||||||
|
|
||||||
<!-- ✅ Offer passwordless alternatives -->
|
|
||||||
<button type="button">Sign in with passkey</button>
|
|
||||||
<button type="button">Email me a login link</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Robust
|
|
||||||
|
|
||||||
### ARIA usage (4.1.2)
|
|
||||||
|
|
||||||
**Prefer native elements:**
|
|
||||||
```html
|
|
||||||
<!-- ❌ ARIA role on div -->
|
|
||||||
<div role="button" tabindex="0">Click me</div>
|
|
||||||
|
|
||||||
<!-- ✅ Native button -->
|
|
||||||
<button>Click me</button>
|
|
||||||
|
|
||||||
<!-- ❌ ARIA checkbox -->
|
|
||||||
<div role="checkbox" aria-checked="false">Option</div>
|
|
||||||
|
|
||||||
<!-- ✅ Native checkbox -->
|
|
||||||
<label><input type="checkbox"> Option</label>
|
|
||||||
```
|
|
||||||
|
|
||||||
**When ARIA is needed,** use the correct roles and states. See the [ARIA tabs pattern](references/A11Y-PATTERNS.md#aria-tabs) for a complete tablist example.
|
|
||||||
|
|
||||||
### Live regions (4.1.3)
|
|
||||||
|
|
||||||
Use `aria-live` regions to announce dynamic content changes without moving focus. See the [live regions pattern](references/A11Y-PATTERNS.md#live-regions-and-notifications) for markup and a `showNotification()` helper.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing checklist
|
|
||||||
|
|
||||||
### Automated testing
|
|
||||||
```bash
|
|
||||||
# Lighthouse accessibility audit
|
|
||||||
npx lighthouse https://example.com --only-categories=accessibility
|
|
||||||
|
|
||||||
# axe-core
|
|
||||||
npm install @axe-core/cli -g
|
|
||||||
axe https://example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manual testing
|
|
||||||
|
|
||||||
- [ ] **Keyboard navigation:** Tab through entire page, use Enter/Space to activate
|
|
||||||
- [ ] **Screen reader:** Test with VoiceOver (Mac), NVDA (Windows), or TalkBack (Android)
|
|
||||||
- [ ] **Zoom:** Content usable at 200% zoom
|
|
||||||
- [ ] **High contrast:** Test with Windows High Contrast Mode
|
|
||||||
- [ ] **Reduced motion:** Test with `prefers-reduced-motion: reduce`
|
|
||||||
- [ ] **Focus order:** Logical and follows visual order
|
|
||||||
- [ ] **Target size:** Interactive elements meet 24×24px minimum
|
|
||||||
|
|
||||||
See the [screen reader commands reference](references/A11Y-PATTERNS.md#screen-reader-commands) for VoiceOver and NVDA shortcuts.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common issues by impact
|
|
||||||
|
|
||||||
### Critical (fix immediately)
|
|
||||||
1. Missing form labels
|
|
||||||
2. Missing image alt text
|
|
||||||
3. Insufficient color contrast
|
|
||||||
4. Keyboard traps
|
|
||||||
5. No focus indicators
|
|
||||||
|
|
||||||
### Serious (fix before launch)
|
|
||||||
1. Missing page language
|
|
||||||
2. Missing heading structure
|
|
||||||
3. Non-descriptive link text
|
|
||||||
4. Auto-playing media
|
|
||||||
5. Missing skip links
|
|
||||||
|
|
||||||
### Moderate (fix soon)
|
|
||||||
1. Missing ARIA labels on icons
|
|
||||||
2. Inconsistent navigation
|
|
||||||
3. Missing error identification
|
|
||||||
4. Timing without controls
|
|
||||||
5. Missing landmark regions
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
- [WCAG 2.2 Quick Reference](https://www.w3.org/WAI/WCAG22/quickref/)
|
|
||||||
- [WAI-ARIA Authoring Practices](https://www.w3.org/WAI/ARIA/apg/)
|
|
||||||
- [Deque axe Rules](https://dequeuniversity.com/rules/axe/)
|
|
||||||
- [Web Quality Audit](../web-quality-audit/SKILL.md)
|
|
||||||
- [WCAG criteria reference](references/WCAG.md)
|
|
||||||
- [Accessibility code patterns](references/A11Y-PATTERNS.md)
|
|
||||||
@@ -1,233 +0,0 @@
|
|||||||
# Accessibility Code Patterns
|
|
||||||
|
|
||||||
Practical, copy-paste-ready patterns for common accessibility requirements. Each pattern is self-contained and linked from the main [SKILL.md](../SKILL.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Modal focus trap
|
|
||||||
|
|
||||||
Trap keyboard focus inside a modal dialog so Tab/Shift+Tab cycle through its focusable elements and Escape closes it.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
function openModal(modal) {
|
|
||||||
const focusableElements = modal.querySelectorAll(
|
|
||||||
'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])'
|
|
||||||
);
|
|
||||||
const firstElement = focusableElements[0];
|
|
||||||
const lastElement = focusableElements[focusableElements.length - 1];
|
|
||||||
|
|
||||||
modal.addEventListener('keydown', (e) => {
|
|
||||||
if (e.key === 'Tab') {
|
|
||||||
if (e.shiftKey && document.activeElement === firstElement) {
|
|
||||||
e.preventDefault();
|
|
||||||
lastElement.focus();
|
|
||||||
} else if (!e.shiftKey && document.activeElement === lastElement) {
|
|
||||||
e.preventDefault();
|
|
||||||
firstElement.focus();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (e.key === 'Escape') {
|
|
||||||
closeModal();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
firstElement.focus();
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The native `<dialog>` element handles focus trapping automatically—prefer it when browser support allows.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Skip link
|
|
||||||
|
|
||||||
Allows keyboard users to bypass repetitive navigation and jump straight to main content.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<body>
|
|
||||||
<a href="#main-content" class="skip-link">Skip to main content</a>
|
|
||||||
<header><!-- navigation --></header>
|
|
||||||
<main id="main-content" tabindex="-1">
|
|
||||||
<!-- main content -->
|
|
||||||
</main>
|
|
||||||
</body>
|
|
||||||
```
|
|
||||||
|
|
||||||
```css
|
|
||||||
.skip-link {
|
|
||||||
position: absolute;
|
|
||||||
top: -40px;
|
|
||||||
left: 0;
|
|
||||||
background: #000;
|
|
||||||
color: #fff;
|
|
||||||
padding: 8px 16px;
|
|
||||||
z-index: 100;
|
|
||||||
}
|
|
||||||
|
|
||||||
.skip-link:focus {
|
|
||||||
top: 0;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Error handling
|
|
||||||
|
|
||||||
Announce errors to screen readers and focus the first invalid field on submit.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<form novalidate>
|
|
||||||
<div class="field" aria-live="polite">
|
|
||||||
<label for="email">Email</label>
|
|
||||||
<input type="email" id="email"
|
|
||||||
aria-invalid="true"
|
|
||||||
aria-describedby="email-error">
|
|
||||||
<p id="email-error" class="error" role="alert">
|
|
||||||
Please enter a valid email address (e.g., name@example.com)
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</form>
|
|
||||||
```
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
form.addEventListener('submit', (e) => {
|
|
||||||
const firstError = form.querySelector('[aria-invalid="true"]');
|
|
||||||
if (firstError) {
|
|
||||||
e.preventDefault();
|
|
||||||
firstError.focus();
|
|
||||||
|
|
||||||
const errorSummary = document.getElementById('error-summary');
|
|
||||||
errorSummary.textContent =
|
|
||||||
`${errors.length} errors found. Please fix them and try again.`;
|
|
||||||
errorSummary.focus();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Form labels
|
|
||||||
|
|
||||||
Every input needs an associated label—either explicit (`for`/`id`) or implicit (wrapping `<label>`).
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ No label association -->
|
|
||||||
<input type="email" placeholder="Email">
|
|
||||||
|
|
||||||
<!-- ✅ Explicit label -->
|
|
||||||
<label for="email">Email address</label>
|
|
||||||
<input type="email" id="email" name="email"
|
|
||||||
autocomplete="email" required>
|
|
||||||
|
|
||||||
<!-- ✅ Implicit label -->
|
|
||||||
<label>
|
|
||||||
Email address
|
|
||||||
<input type="email" name="email" autocomplete="email" required>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<!-- ✅ With instructions -->
|
|
||||||
<label for="password">Password</label>
|
|
||||||
<input type="password" id="password"
|
|
||||||
aria-describedby="password-requirements">
|
|
||||||
<p id="password-requirements">
|
|
||||||
Must be at least 8 characters with one number.
|
|
||||||
</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Dragging movements
|
|
||||||
|
|
||||||
Any action triggered by dragging must offer a single-pointer alternative (WCAG 2.5.7).
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Drag-only reorder -->
|
|
||||||
<ul class="sortable-list" draggable="true">
|
|
||||||
<li>Item 1</li>
|
|
||||||
<li>Item 2</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<!-- ✅ Drag + button alternatives -->
|
|
||||||
<ul class="sortable-list">
|
|
||||||
<li>
|
|
||||||
<span>Item 1</span>
|
|
||||||
<button aria-label="Move Item 1 up">↑</button>
|
|
||||||
<button aria-label="Move Item 1 down">↓</button>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<span>Item 2</span>
|
|
||||||
<button aria-label="Move Item 2 up">↑</button>
|
|
||||||
<button aria-label="Move Item 2 down">↓</button>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
```
|
|
||||||
|
|
||||||
Also applies to sliders, map panning, colour pickers, and similar drag-based widgets—always provide an equivalent click/tap or keyboard path.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ARIA tabs
|
|
||||||
|
|
||||||
Tabs require `role="tablist"`, `role="tab"`, and `role="tabpanel"` with proper `aria-selected`, `aria-controls`, and keyboard support.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<div role="tablist" aria-label="Product information">
|
|
||||||
<button role="tab" id="tab-1" aria-selected="true"
|
|
||||||
aria-controls="panel-1">Description</button>
|
|
||||||
<button role="tab" id="tab-2" aria-selected="false"
|
|
||||||
aria-controls="panel-2" tabindex="-1">Reviews</button>
|
|
||||||
</div>
|
|
||||||
<div role="tabpanel" id="panel-1" aria-labelledby="tab-1">
|
|
||||||
<!-- Panel content -->
|
|
||||||
</div>
|
|
||||||
<div role="tabpanel" id="panel-2" aria-labelledby="tab-2" hidden>
|
|
||||||
<!-- Panel content -->
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
Arrow keys should move focus between tabs; the active tab receives `tabindex="0"` while inactive tabs use `tabindex="-1"`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Live regions and notifications
|
|
||||||
|
|
||||||
Use `aria-live` to announce dynamic content changes to screen readers without moving focus.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- Status updates (polite — waits for pause in speech) -->
|
|
||||||
<div aria-live="polite" aria-atomic="true" class="status">
|
|
||||||
<!-- Content updates announced to screen readers -->
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Urgent alerts (assertive — interrupts) -->
|
|
||||||
<div role="alert" aria-live="assertive">
|
|
||||||
<!-- Interrupts current announcement -->
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
function showNotification(message, type = 'polite') {
|
|
||||||
const container = document.getElementById(`${type}-announcer`);
|
|
||||||
container.textContent = '';
|
|
||||||
requestAnimationFrame(() => {
|
|
||||||
container.textContent = message;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Clear the container before writing to ensure the same message triggers a new announcement.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Screen reader commands
|
|
||||||
|
|
||||||
Quick reference for the most common screen reader shortcuts.
|
|
||||||
|
|
||||||
| Action | VoiceOver (Mac) | NVDA (Windows) |
|
|
||||||
|--------|-----------------|----------------|
|
|
||||||
| Start/Stop | ⌘ + F5 | Ctrl + Alt + N |
|
|
||||||
| Next item | VO + → | ↓ |
|
|
||||||
| Previous item | VO + ← | ↑ |
|
|
||||||
| Activate | VO + Space | Enter |
|
|
||||||
| Headings list | VO + U, then arrows | H / Shift + H |
|
|
||||||
| Links list | VO + U | K / Shift + K |
|
|
||||||
@@ -1,191 +0,0 @@
|
|||||||
# WCAG 2.2 Quick Reference
|
|
||||||
|
|
||||||
## Success criteria by level
|
|
||||||
|
|
||||||
### Level A (minimum)
|
|
||||||
|
|
||||||
| Criterion | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| **1.1.1** Non-text Content | All images, icons have text alternatives |
|
|
||||||
| **1.2.1** Audio-only/Video-only | Provide transcript or audio description |
|
|
||||||
| **1.2.2** Captions | Video with audio has captions |
|
|
||||||
| **1.2.3** Audio Description | Video has audio description |
|
|
||||||
| **1.3.1** Info and Relationships | Information conveyed through presentation is available programmatically |
|
|
||||||
| **1.3.2** Meaningful Sequence | Reading order is logical |
|
|
||||||
| **1.3.3** Sensory Characteristics | Instructions don't rely solely on shape, color, size, location, orientation, or sound |
|
|
||||||
| **1.4.1** Use of Color | Color is not the only visual means of conveying information |
|
|
||||||
| **1.4.2** Audio Control | Audio playing automatically can be paused/stopped |
|
|
||||||
| **2.1.1** Keyboard | All functionality available via keyboard |
|
|
||||||
| **2.1.2** No Keyboard Trap | Keyboard focus can be moved away from any component |
|
|
||||||
| **2.1.4** Character Key Shortcuts | Single-key shortcuts can be turned off or remapped |
|
|
||||||
| **2.2.1** Timing Adjustable | Time limits can be extended |
|
|
||||||
| **2.2.2** Pause, Stop, Hide | Moving/blinking content can be paused |
|
|
||||||
| **2.3.1** Three Flashes | Nothing flashes more than 3 times per second |
|
|
||||||
| **2.4.1** Bypass Blocks | Skip link or landmark navigation available |
|
|
||||||
| **2.4.2** Page Titled | Pages have descriptive titles |
|
|
||||||
| **2.4.3** Focus Order | Focus order preserves meaning |
|
|
||||||
| **2.4.4** Link Purpose | Link purpose clear from link text or context |
|
|
||||||
| **2.5.1** Pointer Gestures | Multi-point gestures have single-pointer alternatives |
|
|
||||||
| **2.5.2** Pointer Cancellation | Down-event doesn't trigger action (use up-event or click) |
|
|
||||||
| **2.5.3** Label in Name | Accessible name contains visible label text |
|
|
||||||
| **2.5.4** Motion Actuation | Motion-triggered functions have alternatives |
|
|
||||||
| **3.1.1** Language of Page | Default language specified in HTML |
|
|
||||||
| **3.2.1** On Focus | Focus doesn't trigger unexpected changes |
|
|
||||||
| **3.2.2** On Input | Input doesn't trigger unexpected changes |
|
|
||||||
| **3.2.6** Consistent Help | Help mechanisms appear in the same relative order across pages |
|
|
||||||
| **3.3.1** Error Identification | Input errors clearly described |
|
|
||||||
| **3.3.2** Labels or Instructions | Form inputs have labels or instructions |
|
|
||||||
| **3.3.7** Redundant Entry | Information previously entered is auto-populated or available to select |
|
|
||||||
| **4.1.2** Name, Role, Value | UI components have accessible names and correct roles |
|
|
||||||
|
|
||||||
### Level AA (standard)
|
|
||||||
|
|
||||||
| Criterion | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| **1.2.4** Captions (Live) | Live audio has captions |
|
|
||||||
| **1.2.5** Audio Description | Pre-recorded video has audio description |
|
|
||||||
| **1.3.4** Orientation | Content doesn't restrict orientation |
|
|
||||||
| **1.3.5** Identify Input Purpose | Input purpose can be programmatically determined |
|
|
||||||
| **1.4.3** Contrast (Minimum) | 4.5:1 for normal text, 3:1 for large text |
|
|
||||||
| **1.4.4** Resize Text | Text can be resized to 200% without loss of functionality |
|
|
||||||
| **1.4.5** Images of Text | Text used instead of images of text |
|
|
||||||
| **1.4.10** Reflow | Content reflows at 320px width without horizontal scroll |
|
|
||||||
| **1.4.11** Non-text Contrast | UI components have 3:1 contrast |
|
|
||||||
| **1.4.12** Text Spacing | Content adapts to text spacing changes |
|
|
||||||
| **1.4.13** Content on Hover/Focus | Additional content is dismissible, hoverable, persistent |
|
|
||||||
| **2.4.5** Multiple Ways | Multiple ways to find pages |
|
|
||||||
| **2.4.6** Headings and Labels | Headings and labels are descriptive |
|
|
||||||
| **2.4.7** Focus Visible | Focus indicator is visible |
|
|
||||||
| **2.4.11** Focus Not Obscured (Minimum) | Focused element is not entirely hidden by author-created content |
|
|
||||||
| **2.5.7** Dragging Movements | Dragging actions have single-pointer alternatives |
|
|
||||||
| **2.5.8** Target Size (Minimum) | Interactive targets are at least 24×24 CSS pixels (with exceptions) |
|
|
||||||
| **3.1.2** Language of Parts | Language changes are marked |
|
|
||||||
| **3.2.3** Consistent Navigation | Navigation is consistent across pages |
|
|
||||||
| **3.2.4** Consistent Identification | Same functionality uses same labels |
|
|
||||||
| **3.3.3** Error Suggestion | Error corrections suggested when known |
|
|
||||||
| **3.3.4** Error Prevention (Legal) | Actions can be reversed or confirmed |
|
|
||||||
| **3.3.8** Accessible Authentication (Minimum) | No cognitive function test for login unless an alternative or assistance is provided |
|
|
||||||
| **4.1.3** Status Messages | Status messages announced to screen readers |
|
|
||||||
|
|
||||||
### Level AAA (enhanced)
|
|
||||||
|
|
||||||
| Criterion | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| **1.4.6** Contrast (Enhanced) | 7:1 for normal text, 4.5:1 for large text |
|
|
||||||
| **1.4.8** Visual Presentation | Foreground/background colors can be selected |
|
|
||||||
| **1.4.9** Images of Text (No Exception) | No images of text |
|
|
||||||
| **2.1.3** Keyboard (No Exception) | All functionality keyboard accessible |
|
|
||||||
| **2.2.3** No Timing | No time limits |
|
|
||||||
| **2.2.4** Interruptions | Interruptions can be postponed |
|
|
||||||
| **2.2.5** Re-authenticating | Data preserved on re-authentication |
|
|
||||||
| **2.2.6** Timeouts | Users warned about data loss from inactivity |
|
|
||||||
| **2.3.2** Three Flashes | No content flashes more than 3 times |
|
|
||||||
| **2.3.3** Animation from Interactions | Motion animation can be disabled |
|
|
||||||
| **2.4.8** Location | User location within site is available |
|
|
||||||
| **2.4.9** Link Purpose (Link Only) | Link purpose clear from link text alone |
|
|
||||||
| **2.4.10** Section Headings | Sections have headings |
|
|
||||||
| **2.4.12** Focus Not Obscured (Enhanced) | No part of the focused element is hidden by author-created content |
|
|
||||||
| **2.4.13** Focus Appearance | Focus indicator has sufficient area, contrast, and is not obscured |
|
|
||||||
| **3.1.3** Unusual Words | Definitions available for unusual words |
|
|
||||||
| **3.1.4** Abbreviations | Abbreviations expanded |
|
|
||||||
| **3.1.5** Reading Level | Alternative content for complex text |
|
|
||||||
| **3.1.6** Pronunciation | Pronunciation available where needed |
|
|
||||||
| **3.2.5** Change on Request | Changes initiated only by user |
|
|
||||||
| **3.3.5** Help | Context-sensitive help available |
|
|
||||||
| **3.3.6** Error Prevention (All) | All form submissions can be reviewed |
|
|
||||||
| **3.3.9** Accessible Authentication (Enhanced) | No cognitive function test for login (no object or personal content recognition exceptions) |
|
|
||||||
|
|
||||||
## Common ARIA patterns
|
|
||||||
|
|
||||||
### Buttons
|
|
||||||
```html
|
|
||||||
<button>Label</button>
|
|
||||||
<!-- or -->
|
|
||||||
<button aria-label="Close dialog">×</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Links
|
|
||||||
```html
|
|
||||||
<a href="/page">Descriptive link text</a>
|
|
||||||
<!-- External links -->
|
|
||||||
<a href="https://external.com" target="_blank" rel="noopener">
|
|
||||||
External site
|
|
||||||
<span class="visually-hidden">(opens in new tab)</span>
|
|
||||||
</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Form fields
|
|
||||||
```html
|
|
||||||
<label for="email">Email address</label>
|
|
||||||
<input type="email" id="email" aria-describedby="email-hint">
|
|
||||||
<p id="email-hint">We'll never share your email.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Error states
|
|
||||||
```html
|
|
||||||
<label for="email">Email</label>
|
|
||||||
<input type="email" id="email" aria-invalid="true" aria-describedby="email-error">
|
|
||||||
<p id="email-error" role="alert">Please enter a valid email address.</p>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Navigation
|
|
||||||
```html
|
|
||||||
<nav aria-label="Main">
|
|
||||||
<ul>
|
|
||||||
<li><a href="/" aria-current="page">Home</a></li>
|
|
||||||
<li><a href="/about">About</a></li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Modals
|
|
||||||
```html
|
|
||||||
<div role="dialog" aria-modal="true" aria-labelledby="dialog-title">
|
|
||||||
<h2 id="dialog-title">Confirm Action</h2>
|
|
||||||
<!-- content -->
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Live regions
|
|
||||||
```html
|
|
||||||
<!-- Polite (waits for pause in speech) -->
|
|
||||||
<div aria-live="polite">Status update here</div>
|
|
||||||
|
|
||||||
<!-- Assertive (interrupts immediately) -->
|
|
||||||
<div aria-live="assertive" role="alert">Error message here</div>
|
|
||||||
|
|
||||||
<!-- Status (polite, implicit) -->
|
|
||||||
<div role="status">Loading complete</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
## What changed from 2.1 to 2.2
|
|
||||||
|
|
||||||
| Change | Criterion | Level |
|
|
||||||
|--------|-----------|-------|
|
|
||||||
| **Removed** | 4.1.1 Parsing | A |
|
|
||||||
| **Added** | 2.4.11 Focus Not Obscured (Minimum) | AA |
|
|
||||||
| **Added** | 2.4.12 Focus Not Obscured (Enhanced) | AAA |
|
|
||||||
| **Added** | 2.4.13 Focus Appearance | AAA |
|
|
||||||
| **Added** | 2.5.7 Dragging Movements | AA |
|
|
||||||
| **Added** | 2.5.8 Target Size (Minimum) | AA |
|
|
||||||
| **Added** | 3.2.6 Consistent Help | A |
|
|
||||||
| **Added** | 3.3.7 Redundant Entry | A |
|
|
||||||
| **Added** | 3.3.8 Accessible Authentication (Minimum) | AA |
|
|
||||||
| **Added** | 3.3.9 Accessible Authentication (Enhanced) | AAA |
|
|
||||||
|
|
||||||
## Testing tools
|
|
||||||
|
|
||||||
| Tool | Type | URL |
|
|
||||||
|------|------|-----|
|
|
||||||
| axe DevTools | Browser extension | [deque.com/axe](https://www.deque.com/axe/) |
|
|
||||||
| WAVE | Browser extension | [wave.webaim.org](https://wave.webaim.org/) |
|
|
||||||
| Lighthouse | Built into Chrome | DevTools → Lighthouse |
|
|
||||||
| NVDA | Screen reader (Windows) | [nvaccess.org](https://www.nvaccess.org/) |
|
|
||||||
| VoiceOver | Screen reader (Mac) | Built into macOS |
|
|
||||||
| Colour Contrast Analyser | Desktop app | [tpgi.com](https://www.tpgi.com/color-contrast-checker/) |
|
|
||||||
|
|
||||||
## Sources
|
|
||||||
|
|
||||||
- [WCAG 2.2 W3C Recommendation](https://www.w3.org/TR/WCAG22/)
|
|
||||||
- [WCAG 2.2 Quick Reference](https://www.w3.org/WAI/WCAG22/quickref/)
|
|
||||||
- [What's New in WCAG 2.2](https://www.w3.org/WAI/standards-guidelines/wcag/new-in-22/)
|
|
||||||
@@ -1,167 +0,0 @@
|
|||||||
---
|
|
||||||
name: discord-bot
|
|
||||||
description: Discord bot development on Cloudflare Workers — Discord API, Developer Portal, slash commands, Gateway WebSocket, Interactions Endpoint, bot permissions, intents, and Ed25519 verification.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Discord Bot Development
|
|
||||||
|
|
||||||
Use this skill when working on Discord bots, Discord API integration, bot setup/configuration, or slash command registration. Triggered by mentions of Discord bots, Discord Developer Portal, Discord API, slash commands, Gateway, or Interactions Endpoint.
|
|
||||||
|
|
||||||
## Search before giving portal instructions
|
|
||||||
|
|
||||||
The Discord Developer Portal UI changes often, so web-search current instructions before describing:
|
|
||||||
* Where settings are located in the Developer Portal
|
|
||||||
* OAuth2 flow steps
|
|
||||||
* Bot permission configuration
|
|
||||||
* Interactions Endpoint setup
|
|
||||||
* Install link generation
|
|
||||||
|
|
||||||
Useful queries:
|
|
||||||
* `Discord Developer Portal [specific task] <current year>`
|
|
||||||
* `Discord bot setup [specific feature] latest`
|
|
||||||
|
|
||||||
If search results are older than 6 months, note this to the user and suggest they verify in the portal.
|
|
||||||
|
|
||||||
## Discord Bot Architecture on Cloudflare Workers
|
|
||||||
|
|
||||||
Two models for receiving Discord events:
|
|
||||||
|
|
||||||
### Interactions Endpoint (HTTP)
|
|
||||||
* Discord POSTs slash commands and component interactions to your Worker URL
|
|
||||||
* No persistent connection needed — pure request/response
|
|
||||||
* Set the URL in Developer Portal → General Information → Interactions Endpoint URL
|
|
||||||
* Requires Ed25519 signature verification on every request (`discord-interactions` npm package)
|
|
||||||
* Supports: slash commands, buttons, select menus, modals, autocomplete
|
|
||||||
|
|
||||||
### Gateway (WebSocket)
|
|
||||||
* Persistent WebSocket connection to `wss://gateway.discord.gg`
|
|
||||||
* Required for: reaction events, message events, presence, voice state, typing indicators
|
|
||||||
* On Cloudflare Workers: use a **Durable Object** with `new WebSocket(url)` for the outbound connection
|
|
||||||
* NOT `fetch()` with `Upgrade: websocket` — that doesn't work for `wss://` URLs
|
|
||||||
* DO won't hibernate while outbound WS is open — use alarm-based keepalive (30s interval)
|
|
||||||
* Deploys evict the DO; alarm reconnects within ~30 seconds
|
|
||||||
|
|
||||||
### Which Do You Need?
|
|
||||||
|
|
||||||
| Feature | Interactions Endpoint | Gateway |
|
|
||||||
|---------|----------------------|---------|
|
|
||||||
| Slash commands | Yes | Not needed |
|
|
||||||
| Message reactions | No | Required |
|
|
||||||
| Message content | No | Required (with intent) |
|
|
||||||
| Typing indicators | No | Required |
|
|
||||||
| Presence updates | No | Required |
|
|
||||||
| Voice state | No | Required |
|
|
||||||
|
|
||||||
Most bots need both: Interactions Endpoint for slash commands, Gateway for real-time events.
|
|
||||||
|
|
||||||
## Setting Up a New Discord Bot
|
|
||||||
|
|
||||||
### 1. Create Application
|
|
||||||
* Go to https://discord.com/developers/applications
|
|
||||||
* Click **New Application**, name it, click Create
|
|
||||||
* Copy **Application ID** and **Public Key** from General Information page
|
|
||||||
|
|
||||||
### 2. Get Bot Token
|
|
||||||
* Sidebar → **Bot**
|
|
||||||
* Click **Reset Token**, copy immediately (shown once)
|
|
||||||
* Toggle privileged intents as needed (see Intents section below)
|
|
||||||
|
|
||||||
### 3. Configure Installation
|
|
||||||
* Sidebar → **Installation**
|
|
||||||
* Enable **Guild Install**
|
|
||||||
* Select **Discord Provided Link**
|
|
||||||
* Under Default Install Settings → Guild Install:
|
|
||||||
* **Scopes:** `bot`, `applications.commands`
|
|
||||||
* **Permissions:** Select based on your bot's needs (see Permissions section)
|
|
||||||
|
|
||||||
### 4. Set Interactions Endpoint
|
|
||||||
* Sidebar → **General Information**
|
|
||||||
* Set **Interactions Endpoint URL** to your Worker's `/interactions` path
|
|
||||||
* Discord sends a PING to verify — your code must handle it (return Pong)
|
|
||||||
* Save — if verification fails, your endpoint isn't working
|
|
||||||
|
|
||||||
### 5. Register Slash Commands
|
|
||||||
* Use `PUT https://discord.com/api/v10/applications/{app_id}/commands`
|
|
||||||
* Global commands can take up to an hour to propagate
|
|
||||||
* Guild-specific commands update instantly (useful for testing)
|
|
||||||
|
|
||||||
### 6. Install to Server
|
|
||||||
* Copy the Install Link from the Installation page
|
|
||||||
* Paste in browser, select server, authorize
|
|
||||||
|
|
||||||
## Intents
|
|
||||||
|
|
||||||
Gateway intents control which events Discord sends to your bot.
|
|
||||||
|
|
||||||
**Standard intents** (no approval needed):
|
|
||||||
* `GUILDS` (1 << 0) — guild create/update/delete, role changes
|
|
||||||
* `GUILD_MESSAGES` (1 << 9) — message create/update/delete in guilds
|
|
||||||
* `GUILD_MESSAGE_REACTIONS` (1 << 10) — reaction add/remove
|
|
||||||
|
|
||||||
**Privileged intents** (must be enabled in Developer Portal → Bot):
|
|
||||||
* `MESSAGE_CONTENT` (1 << 15) — access to message content via Gateway AND REST API. Without this, `message.content` is empty for messages the bot didn't send or wasn't mentioned in.
|
|
||||||
* `GUILD_MEMBERS` (1 << 1) — member join/leave/update events
|
|
||||||
* `GUILD_PRESENCES` (1 << 8) — presence (online/offline) updates
|
|
||||||
|
|
||||||
**No approval needed for bots in <100 servers.** Over 100 servers requires Discord review.
|
|
||||||
|
|
||||||
## Common Permissions
|
|
||||||
|
|
||||||
| Permission | Bit | When needed |
|
|
||||||
|-----------|-----|-------------|
|
|
||||||
| View Channels | 1 << 10 | See channels and receive events from them |
|
|
||||||
| Send Messages | 1 << 11 | Send messages (DMs, channel messages) |
|
|
||||||
| Read Message History | 1 << 16 | Fetch messages via REST API |
|
|
||||||
| Use Slash Commands | 1 << 31 | Use application commands |
|
|
||||||
| Manage Roles | 1 << 28 | Assign/remove roles from members |
|
|
||||||
| Add Reactions | 1 << 6 | Add reactions to messages |
|
|
||||||
|
|
||||||
## Common Gotchas
|
|
||||||
|
|
||||||
### Bot doesn't receive reaction events
|
|
||||||
* **Missing intent:** Must request `GUILD_MESSAGE_REACTIONS` in Gateway IDENTIFY
|
|
||||||
* **Missing VIEW_CHANNEL:** The bot's role needs View Channels permission. Public channels inherit from @everyone, but **private channels require the bot role to be explicitly added** to the channel's permissions
|
|
||||||
|
|
||||||
### Empty message.content from REST API
|
|
||||||
* **Missing MESSAGE_CONTENT intent:** Must be enabled in Developer Portal → Bot → Privileged Gateway Intents. Also include `MESSAGE_CONTENT` (1 << 15) in the Gateway IDENTIFY intents value
|
|
||||||
|
|
||||||
### Slash command not visible
|
|
||||||
* **Propagation delay:** Global commands take up to an hour. Use guild-specific commands for testing
|
|
||||||
* **Permission restriction:** `default_member_permissions` hides commands from users without the specified permission
|
|
||||||
* **Subcommand required:** If a command has subcommands defined, the base command can't be run alone — Discord requires picking a subcommand
|
|
||||||
|
|
||||||
### "The application did not respond" on a slash command that actually worked
|
|
||||||
* Discord gives an interaction **3 seconds** to receive a response. A handler that runs its side effects synchronously before responding (REST calls, role changes, D1 writes) blows the deadline — Discord shows the error, but the Worker invocation keeps running, so the side effects still complete. Looks like a failure, is usually a success with a lost reply.
|
|
||||||
* For any command doing more than ~1 REST round trip: immediately return type 5 (`DeferredChannelMessageWithSource`, keep the ephemeral flag if needed), run the work in `ctx.waitUntil()`, then PATCH the result to `/webhooks/{application_id}/{interaction_token}/messages/@original`.
|
|
||||||
|
|
||||||
### WebSocket connection drops on Cloudflare Workers
|
|
||||||
* **DO eviction:** Use alarm-based keepalive (30s interval) to prevent idle eviction
|
|
||||||
* **Deploy:** Deploys always evict the DO. Alarm reconnects within ~30s. Use `/gateway/reconnect` for immediate recovery
|
|
||||||
* **Use `new WebSocket(url)` not `fetch()` with Upgrade header** for `wss://` URLs
|
|
||||||
|
|
||||||
### Discord rate limits
|
|
||||||
* REST API returns 429 with `retry_after` field (seconds). Wait and retry.
|
|
||||||
* Gateway has identify rate limits (1 per 5 seconds). Don't reconnect in a tight loop.
|
|
||||||
|
|
||||||
## Verification Checklist
|
|
||||||
|
|
||||||
When setting up or debugging a Discord bot:
|
|
||||||
|
|
||||||
- [ ] Bot token is set and valid (test with `GET /api/v10/users/@me`)
|
|
||||||
- [ ] Interactions Endpoint URL is set and verified (Developer Portal shows success)
|
|
||||||
- [ ] Slash commands are registered (`PUT .../commands` returns 200)
|
|
||||||
- [ ] Bot is installed to the target server (visible in member list)
|
|
||||||
- [ ] Bot role has necessary permissions (check via REST API `GET /guilds/{id}/members/{bot_id}`)
|
|
||||||
- [ ] Privileged intents are enabled in Developer Portal if needed
|
|
||||||
- [ ] Gateway intents in IDENTIFY include all needed flags
|
|
||||||
- [ ] VIEW_CHANNEL permission is set for private channels
|
|
||||||
- [ ] Gateway connection is alive (`/gateway/status` returns `connected: true`)
|
|
||||||
|
|
||||||
## Reference: Elereada v2
|
|
||||||
|
|
||||||
Working example of a Discord bot on Cloudflare Workers: `github.com/rianvdm/elereada-v2`
|
|
||||||
* Durable Object outbound WebSocket for Gateway
|
|
||||||
* Hono for HTTP routing + Interactions Endpoint
|
|
||||||
* D1 for storage
|
|
||||||
* Alarm-based keepalive for DO persistence
|
|
||||||
* Ed25519 verification via `discord-interactions` package
|
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
---
|
|
||||||
name: frontend-design
|
|
||||||
description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
|
|
||||||
license: Complete terms in LICENSE.txt
|
|
||||||
---
|
|
||||||
|
|
||||||
This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices.
|
|
||||||
|
|
||||||
The user provides frontend requirements: a component, page, application, or interface to build. They may include context about the purpose, audience, or technical constraints.
|
|
||||||
|
|
||||||
## Design Thinking
|
|
||||||
|
|
||||||
Before coding, understand the context and commit to a BOLD aesthetic direction:
|
|
||||||
- **Purpose**: What problem does this interface solve? Who uses it?
|
|
||||||
- **Tone**: Pick an extreme: brutally minimal, maximalist chaos, retro-futuristic, organic/natural, luxury/refined, playful/toy-like, editorial/magazine, brutalist/raw, art deco/geometric, soft/pastel, industrial/utilitarian, etc. There are so many flavors to choose from. Use these for inspiration but design one that is true to the aesthetic direction.
|
|
||||||
- **Constraints**: Technical requirements (framework, performance, accessibility).
|
|
||||||
- **Differentiation**: What makes this UNFORGETTABLE? What's the one thing someone will remember?
|
|
||||||
|
|
||||||
**CRITICAL**: Choose a clear conceptual direction and execute it with precision. Bold maximalism and refined minimalism both work - the key is intentionality, not intensity.
|
|
||||||
|
|
||||||
Then implement working code (HTML/CSS/JS, React, Vue, etc.) that is:
|
|
||||||
- Production-grade and functional
|
|
||||||
- Visually striking and memorable
|
|
||||||
- Cohesive with a clear aesthetic point-of-view
|
|
||||||
- Meticulously refined in every detail
|
|
||||||
|
|
||||||
## Frontend Aesthetics Guidelines
|
|
||||||
|
|
||||||
Focus on:
|
|
||||||
- **Typography**: Choose fonts that are beautiful, unique, and interesting. Avoid generic fonts like Arial and Inter; opt instead for distinctive choices that elevate the frontend's aesthetics; unexpected, characterful font choices. Pair a distinctive display font with a refined body font.
|
|
||||||
- **Color & Theme**: Commit to a cohesive aesthetic. Use CSS variables for consistency. Dominant colors with sharp accents outperform timid, evenly-distributed palettes.
|
|
||||||
- **Motion**: Use animations for effects and micro-interactions. Prioritize CSS-only solutions for HTML. Use Motion library for React when available. Focus on high-impact moments: one well-orchestrated page load with staggered reveals (animation-delay) creates more delight than scattered micro-interactions. Use scroll-triggering and hover states that surprise.
|
|
||||||
- **Spatial Composition**: Unexpected layouts. Asymmetry. Overlap. Diagonal flow. Grid-breaking elements. Generous negative space OR controlled density.
|
|
||||||
- **Backgrounds & Visual Details**: Create atmosphere and depth rather than defaulting to solid colors. Add contextual effects and textures that match the overall aesthetic. Apply creative forms like gradient meshes, noise textures, geometric patterns, layered transparencies, dramatic shadows, decorative borders, custom cursors, and grain overlays.
|
|
||||||
|
|
||||||
NEVER use generic AI-generated aesthetics like overused font families (Inter, Roboto, Arial, system fonts), cliched color schemes (particularly purple gradients on white backgrounds), predictable layouts and component patterns, and cookie-cutter design that lacks context-specific character.
|
|
||||||
|
|
||||||
Interpret creatively and make unexpected choices that feel genuinely designed for the context. No design should be the same. Vary between light and dark themes, different fonts, different aesthetics. NEVER converge on common choices (Space Grotesk, for example) across generations.
|
|
||||||
|
|
||||||
**IMPORTANT**: Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate code with extensive animations and effects. Minimalist or refined designs need restraint, precision, and careful attention to spacing, typography, and subtle details. Elegance comes from executing the vision well.
|
|
||||||
|
|
||||||
Remember: Claude is capable of extraordinary creative work. Don't hold back, show what can truly be created when thinking outside the box and committing fully to a distinctive vision.
|
|
||||||
@@ -1,639 +0,0 @@
|
|||||||
---
|
|
||||||
name: nodejs-backend-patterns
|
|
||||||
description: Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices. Use when creating Node.js servers, REST APIs, GraphQL backends, or microservices architectures.
|
|
||||||
---
|
|
||||||
|
|
||||||
# Node.js Backend Patterns
|
|
||||||
|
|
||||||
Comprehensive guidance for building scalable, maintainable, and production-ready Node.js backend applications with modern frameworks, architectural patterns, and best practices.
|
|
||||||
|
|
||||||
## When to Use This Skill
|
|
||||||
|
|
||||||
- Building REST APIs or GraphQL servers
|
|
||||||
- Creating microservices with Node.js
|
|
||||||
- Implementing authentication and authorization
|
|
||||||
- Designing scalable backend architectures
|
|
||||||
- Setting up middleware and error handling
|
|
||||||
- Integrating databases (SQL and NoSQL)
|
|
||||||
- Building real-time applications with WebSockets
|
|
||||||
- Implementing background job processing
|
|
||||||
|
|
||||||
## Core Frameworks
|
|
||||||
|
|
||||||
### Express.js - Minimalist Framework
|
|
||||||
|
|
||||||
**Basic Setup:**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import express, { Request, Response, NextFunction } from "express";
|
|
||||||
import helmet from "helmet";
|
|
||||||
import cors from "cors";
|
|
||||||
import compression from "compression";
|
|
||||||
|
|
||||||
const app = express();
|
|
||||||
|
|
||||||
// Security middleware
|
|
||||||
app.use(helmet());
|
|
||||||
app.use(cors({ origin: process.env.ALLOWED_ORIGINS?.split(",") }));
|
|
||||||
app.use(compression());
|
|
||||||
|
|
||||||
// Body parsing
|
|
||||||
app.use(express.json({ limit: "10mb" }));
|
|
||||||
app.use(express.urlencoded({ extended: true, limit: "10mb" }));
|
|
||||||
|
|
||||||
// Request logging
|
|
||||||
app.use((req: Request, res: Response, next: NextFunction) => {
|
|
||||||
console.log(`${req.method} ${req.path}`);
|
|
||||||
next();
|
|
||||||
});
|
|
||||||
|
|
||||||
const PORT = process.env.PORT || 3000;
|
|
||||||
app.listen(PORT, () => {
|
|
||||||
console.log(`Server running on port ${PORT}`);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Fastify - High Performance Framework
|
|
||||||
|
|
||||||
**Basic Setup:**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import Fastify from "fastify";
|
|
||||||
import helmet from "@fastify/helmet";
|
|
||||||
import cors from "@fastify/cors";
|
|
||||||
import compress from "@fastify/compress";
|
|
||||||
|
|
||||||
const fastify = Fastify({
|
|
||||||
logger: {
|
|
||||||
level: process.env.LOG_LEVEL || "info",
|
|
||||||
transport: {
|
|
||||||
target: "pino-pretty",
|
|
||||||
options: { colorize: true },
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// Plugins
|
|
||||||
await fastify.register(helmet);
|
|
||||||
await fastify.register(cors, { origin: true });
|
|
||||||
await fastify.register(compress);
|
|
||||||
|
|
||||||
// Type-safe routes with schema validation
|
|
||||||
fastify.post<{
|
|
||||||
Body: { name: string; email: string };
|
|
||||||
Reply: { id: string; name: string };
|
|
||||||
}>(
|
|
||||||
"/users",
|
|
||||||
{
|
|
||||||
schema: {
|
|
||||||
body: {
|
|
||||||
type: "object",
|
|
||||||
required: ["name", "email"],
|
|
||||||
properties: {
|
|
||||||
name: { type: "string", minLength: 1 },
|
|
||||||
email: { type: "string", format: "email" },
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
async (request, reply) => {
|
|
||||||
const { name, email } = request.body;
|
|
||||||
return { id: "123", name };
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
await fastify.listen({ port: 3000, host: "0.0.0.0" });
|
|
||||||
```
|
|
||||||
|
|
||||||
## Architectural Patterns
|
|
||||||
|
|
||||||
### Pattern 1: Layered Architecture
|
|
||||||
|
|
||||||
**Structure:**
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
├── controllers/ # Handle HTTP requests/responses
|
|
||||||
├── services/ # Business logic
|
|
||||||
├── repositories/ # Data access layer
|
|
||||||
├── models/ # Data models
|
|
||||||
├── middleware/ # Express/Fastify middleware
|
|
||||||
├── routes/ # Route definitions
|
|
||||||
├── utils/ # Helper functions
|
|
||||||
├── config/ # Configuration
|
|
||||||
└── types/ # TypeScript types
|
|
||||||
```
|
|
||||||
|
|
||||||
**Controller Layer:**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// controllers/user.controller.ts
|
|
||||||
import { Request, Response, NextFunction } from "express";
|
|
||||||
import { UserService } from "../services/user.service";
|
|
||||||
import { CreateUserDTO, UpdateUserDTO } from "../types/user.types";
|
|
||||||
|
|
||||||
export class UserController {
|
|
||||||
constructor(private userService: UserService) {}
|
|
||||||
|
|
||||||
async createUser(req: Request, res: Response, next: NextFunction) {
|
|
||||||
try {
|
|
||||||
const userData: CreateUserDTO = req.body;
|
|
||||||
const user = await this.userService.createUser(userData);
|
|
||||||
res.status(201).json(user);
|
|
||||||
} catch (error) {
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async getUser(req: Request, res: Response, next: NextFunction) {
|
|
||||||
try {
|
|
||||||
const { id } = req.params;
|
|
||||||
const user = await this.userService.getUserById(id);
|
|
||||||
res.json(user);
|
|
||||||
} catch (error) {
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async updateUser(req: Request, res: Response, next: NextFunction) {
|
|
||||||
try {
|
|
||||||
const { id } = req.params;
|
|
||||||
const updates: UpdateUserDTO = req.body;
|
|
||||||
const user = await this.userService.updateUser(id, updates);
|
|
||||||
res.json(user);
|
|
||||||
} catch (error) {
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteUser(req: Request, res: Response, next: NextFunction) {
|
|
||||||
try {
|
|
||||||
const { id } = req.params;
|
|
||||||
await this.userService.deleteUser(id);
|
|
||||||
res.status(204).send();
|
|
||||||
} catch (error) {
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Service Layer:**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// services/user.service.ts
|
|
||||||
import { UserRepository } from "../repositories/user.repository";
|
|
||||||
import { CreateUserDTO, UpdateUserDTO, User } from "../types/user.types";
|
|
||||||
import { NotFoundError, ValidationError } from "../utils/errors";
|
|
||||||
import bcrypt from "bcrypt";
|
|
||||||
|
|
||||||
export class UserService {
|
|
||||||
constructor(private userRepository: UserRepository) {}
|
|
||||||
|
|
||||||
async createUser(userData: CreateUserDTO): Promise<User> {
|
|
||||||
// Validation
|
|
||||||
const existingUser = await this.userRepository.findByEmail(userData.email);
|
|
||||||
if (existingUser) {
|
|
||||||
throw new ValidationError("Email already exists");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password
|
|
||||||
const hashedPassword = await bcrypt.hash(userData.password, 10);
|
|
||||||
|
|
||||||
// Create user
|
|
||||||
const user = await this.userRepository.create({
|
|
||||||
...userData,
|
|
||||||
password: hashedPassword,
|
|
||||||
});
|
|
||||||
|
|
||||||
// Remove password from response
|
|
||||||
const { password, ...userWithoutPassword } = user;
|
|
||||||
return userWithoutPassword as User;
|
|
||||||
}
|
|
||||||
|
|
||||||
async getUserById(id: string): Promise<User> {
|
|
||||||
const user = await this.userRepository.findById(id);
|
|
||||||
if (!user) {
|
|
||||||
throw new NotFoundError("User not found");
|
|
||||||
}
|
|
||||||
const { password, ...userWithoutPassword } = user;
|
|
||||||
return userWithoutPassword as User;
|
|
||||||
}
|
|
||||||
|
|
||||||
async updateUser(id: string, updates: UpdateUserDTO): Promise<User> {
|
|
||||||
const user = await this.userRepository.update(id, updates);
|
|
||||||
if (!user) {
|
|
||||||
throw new NotFoundError("User not found");
|
|
||||||
}
|
|
||||||
const { password, ...userWithoutPassword } = user;
|
|
||||||
return userWithoutPassword as User;
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteUser(id: string): Promise<void> {
|
|
||||||
const deleted = await this.userRepository.delete(id);
|
|
||||||
if (!deleted) {
|
|
||||||
throw new NotFoundError("User not found");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Repository Layer:**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// repositories/user.repository.ts
|
|
||||||
import { Pool } from "pg";
|
|
||||||
import { CreateUserDTO, UpdateUserDTO, UserEntity } from "../types/user.types";
|
|
||||||
|
|
||||||
export class UserRepository {
|
|
||||||
constructor(private db: Pool) {}
|
|
||||||
|
|
||||||
async create(
|
|
||||||
userData: CreateUserDTO & { password: string },
|
|
||||||
): Promise<UserEntity> {
|
|
||||||
const query = `
|
|
||||||
INSERT INTO users (name, email, password)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
RETURNING id, name, email, password, created_at, updated_at
|
|
||||||
`;
|
|
||||||
const { rows } = await this.db.query(query, [
|
|
||||||
userData.name,
|
|
||||||
userData.email,
|
|
||||||
userData.password,
|
|
||||||
]);
|
|
||||||
return rows[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
async findById(id: string): Promise<UserEntity | null> {
|
|
||||||
const query = "SELECT * FROM users WHERE id = $1";
|
|
||||||
const { rows } = await this.db.query(query, [id]);
|
|
||||||
return rows[0] || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async findByEmail(email: string): Promise<UserEntity | null> {
|
|
||||||
const query = "SELECT * FROM users WHERE email = $1";
|
|
||||||
const { rows } = await this.db.query(query, [email]);
|
|
||||||
return rows[0] || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async update(id: string, updates: UpdateUserDTO): Promise<UserEntity | null> {
|
|
||||||
const fields = Object.keys(updates);
|
|
||||||
const values = Object.values(updates);
|
|
||||||
|
|
||||||
const setClause = fields
|
|
||||||
.map((field, idx) => `${field} = $${idx + 2}`)
|
|
||||||
.join(", ");
|
|
||||||
|
|
||||||
const query = `
|
|
||||||
UPDATE users
|
|
||||||
SET ${setClause}, updated_at = CURRENT_TIMESTAMP
|
|
||||||
WHERE id = $1
|
|
||||||
RETURNING *
|
|
||||||
`;
|
|
||||||
|
|
||||||
const { rows } = await this.db.query(query, [id, ...values]);
|
|
||||||
return rows[0] || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async delete(id: string): Promise<boolean> {
|
|
||||||
const query = "DELETE FROM users WHERE id = $1";
|
|
||||||
const { rowCount } = await this.db.query(query, [id]);
|
|
||||||
return rowCount > 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Pattern 2: Dependency Injection
|
|
||||||
|
|
||||||
Use a DI container to wire up repositories, services, and controllers. For a full container implementation, see [references/advanced-patterns.md](references/advanced-patterns.md).
|
|
||||||
|
|
||||||
## Middleware Patterns
|
|
||||||
|
|
||||||
### Authentication Middleware
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// middleware/auth.middleware.ts
|
|
||||||
import { Request, Response, NextFunction } from "express";
|
|
||||||
import jwt from "jsonwebtoken";
|
|
||||||
import { UnauthorizedError } from "../utils/errors";
|
|
||||||
|
|
||||||
interface JWTPayload {
|
|
||||||
userId: string;
|
|
||||||
email: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
declare global {
|
|
||||||
namespace Express {
|
|
||||||
interface Request {
|
|
||||||
user?: JWTPayload;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const authenticate = async (
|
|
||||||
req: Request,
|
|
||||||
res: Response,
|
|
||||||
next: NextFunction,
|
|
||||||
) => {
|
|
||||||
try {
|
|
||||||
const token = req.headers.authorization?.replace("Bearer ", "");
|
|
||||||
|
|
||||||
if (!token) {
|
|
||||||
throw new UnauthorizedError("No token provided");
|
|
||||||
}
|
|
||||||
|
|
||||||
const payload = jwt.verify(token, process.env.JWT_SECRET!) as JWTPayload;
|
|
||||||
|
|
||||||
req.user = payload;
|
|
||||||
next();
|
|
||||||
} catch (error) {
|
|
||||||
next(new UnauthorizedError("Invalid token"));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export const authorize = (...roles: string[]) => {
|
|
||||||
return async (req: Request, res: Response, next: NextFunction) => {
|
|
||||||
if (!req.user) {
|
|
||||||
return next(new UnauthorizedError("Not authenticated"));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if user has required role
|
|
||||||
const hasRole = roles.some((role) => req.user?.roles?.includes(role));
|
|
||||||
|
|
||||||
if (!hasRole) {
|
|
||||||
return next(new UnauthorizedError("Insufficient permissions"));
|
|
||||||
}
|
|
||||||
|
|
||||||
next();
|
|
||||||
};
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
### Validation Middleware
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// middleware/validation.middleware.ts
|
|
||||||
import { Request, Response, NextFunction } from "express";
|
|
||||||
import { AnyZodObject, ZodError } from "zod";
|
|
||||||
import { ValidationError } from "../utils/errors";
|
|
||||||
|
|
||||||
export const validate = (schema: AnyZodObject) => {
|
|
||||||
return async (req: Request, res: Response, next: NextFunction) => {
|
|
||||||
try {
|
|
||||||
await schema.parseAsync({
|
|
||||||
body: req.body,
|
|
||||||
query: req.query,
|
|
||||||
params: req.params,
|
|
||||||
});
|
|
||||||
next();
|
|
||||||
} catch (error) {
|
|
||||||
if (error instanceof ZodError) {
|
|
||||||
const errors = error.errors.map((err) => ({
|
|
||||||
field: err.path.join("."),
|
|
||||||
message: err.message,
|
|
||||||
}));
|
|
||||||
next(new ValidationError("Validation failed", errors));
|
|
||||||
} else {
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
// Usage with Zod
|
|
||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
const createUserSchema = z.object({
|
|
||||||
body: z.object({
|
|
||||||
name: z.string().min(1),
|
|
||||||
email: z.string().email(),
|
|
||||||
password: z.string().min(8),
|
|
||||||
}),
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post("/users", validate(createUserSchema), userController.createUser);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Rate Limiting Middleware
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// middleware/rate-limit.middleware.ts
|
|
||||||
import rateLimit from "express-rate-limit";
|
|
||||||
import RedisStore from "rate-limit-redis";
|
|
||||||
import Redis from "ioredis";
|
|
||||||
|
|
||||||
const redis = new Redis({
|
|
||||||
host: process.env.REDIS_HOST,
|
|
||||||
port: parseInt(process.env.REDIS_PORT || "6379"),
|
|
||||||
});
|
|
||||||
|
|
||||||
export const apiLimiter = rateLimit({
|
|
||||||
store: new RedisStore({
|
|
||||||
client: redis,
|
|
||||||
prefix: "rl:",
|
|
||||||
}),
|
|
||||||
windowMs: 15 * 60 * 1000, // 15 minutes
|
|
||||||
max: 100, // Limit each IP to 100 requests per windowMs
|
|
||||||
message: "Too many requests from this IP, please try again later",
|
|
||||||
standardHeaders: true,
|
|
||||||
legacyHeaders: false,
|
|
||||||
});
|
|
||||||
|
|
||||||
export const authLimiter = rateLimit({
|
|
||||||
store: new RedisStore({
|
|
||||||
client: redis,
|
|
||||||
prefix: "rl:auth:",
|
|
||||||
}),
|
|
||||||
windowMs: 15 * 60 * 1000,
|
|
||||||
max: 5, // Stricter limit for auth endpoints
|
|
||||||
skipSuccessfulRequests: true,
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Request Logging Middleware
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// middleware/logger.middleware.ts
|
|
||||||
import { Request, Response, NextFunction } from "express";
|
|
||||||
import pino from "pino";
|
|
||||||
|
|
||||||
const logger = pino({
|
|
||||||
level: process.env.LOG_LEVEL || "info",
|
|
||||||
transport: {
|
|
||||||
target: "pino-pretty",
|
|
||||||
options: { colorize: true },
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export const requestLogger = (
|
|
||||||
req: Request,
|
|
||||||
res: Response,
|
|
||||||
next: NextFunction,
|
|
||||||
) => {
|
|
||||||
const start = Date.now();
|
|
||||||
|
|
||||||
// Log response when finished
|
|
||||||
res.on("finish", () => {
|
|
||||||
const duration = Date.now() - start;
|
|
||||||
logger.info({
|
|
||||||
method: req.method,
|
|
||||||
url: req.url,
|
|
||||||
status: res.statusCode,
|
|
||||||
duration: `${duration}ms`,
|
|
||||||
userAgent: req.headers["user-agent"],
|
|
||||||
ip: req.ip,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
next();
|
|
||||||
};
|
|
||||||
|
|
||||||
export { logger };
|
|
||||||
```
|
|
||||||
|
|
||||||
## Error Handling
|
|
||||||
|
|
||||||
### Custom Error Classes
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// utils/errors.ts
|
|
||||||
export class AppError extends Error {
|
|
||||||
constructor(
|
|
||||||
public message: string,
|
|
||||||
public statusCode: number = 500,
|
|
||||||
public isOperational: boolean = true,
|
|
||||||
) {
|
|
||||||
super(message);
|
|
||||||
Object.setPrototypeOf(this, AppError.prototype);
|
|
||||||
Error.captureStackTrace(this, this.constructor);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class ValidationError extends AppError {
|
|
||||||
constructor(
|
|
||||||
message: string,
|
|
||||||
public errors?: any[],
|
|
||||||
) {
|
|
||||||
super(message, 400);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class NotFoundError extends AppError {
|
|
||||||
constructor(message: string = "Resource not found") {
|
|
||||||
super(message, 404);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class UnauthorizedError extends AppError {
|
|
||||||
constructor(message: string = "Unauthorized") {
|
|
||||||
super(message, 401);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class ForbiddenError extends AppError {
|
|
||||||
constructor(message: string = "Forbidden") {
|
|
||||||
super(message, 403);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class ConflictError extends AppError {
|
|
||||||
constructor(message: string) {
|
|
||||||
super(message, 409);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Global Error Handler
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// middleware/error-handler.ts
|
|
||||||
import { Request, Response, NextFunction } from "express";
|
|
||||||
import { AppError } from "../utils/errors";
|
|
||||||
import { logger } from "./logger.middleware";
|
|
||||||
|
|
||||||
export const errorHandler = (
|
|
||||||
err: Error,
|
|
||||||
req: Request,
|
|
||||||
res: Response,
|
|
||||||
next: NextFunction,
|
|
||||||
) => {
|
|
||||||
if (err instanceof AppError) {
|
|
||||||
return res.status(err.statusCode).json({
|
|
||||||
status: "error",
|
|
||||||
message: err.message,
|
|
||||||
...(err instanceof ValidationError && { errors: err.errors }),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log unexpected errors
|
|
||||||
logger.error({
|
|
||||||
error: err.message,
|
|
||||||
stack: err.stack,
|
|
||||||
url: req.url,
|
|
||||||
method: req.method,
|
|
||||||
});
|
|
||||||
|
|
||||||
// Don't leak error details in production
|
|
||||||
const message =
|
|
||||||
process.env.NODE_ENV === "production"
|
|
||||||
? "Internal server error"
|
|
||||||
: err.message;
|
|
||||||
|
|
||||||
res.status(500).json({
|
|
||||||
status: "error",
|
|
||||||
message,
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
// Async error wrapper
|
|
||||||
export const asyncHandler = (
|
|
||||||
fn: (req: Request, res: Response, next: NextFunction) => Promise<any>,
|
|
||||||
) => {
|
|
||||||
return (req: Request, res: Response, next: NextFunction) => {
|
|
||||||
Promise.resolve(fn(req, res, next)).catch(next);
|
|
||||||
};
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Database Patterns
|
|
||||||
|
|
||||||
Node.js supports both SQL and NoSQL databases. Use connection pooling for all production databases.
|
|
||||||
|
|
||||||
Key patterns covered in [references/advanced-patterns.md](references/advanced-patterns.md):
|
|
||||||
- **PostgreSQL with connection pool** — `pg` Pool configuration and graceful shutdown
|
|
||||||
- **MongoDB with Mongoose** — connection management and schema definition
|
|
||||||
- **Transaction pattern** — `BEGIN`/`COMMIT`/`ROLLBACK` with `pg` client
|
|
||||||
|
|
||||||
## Authentication & Authorization
|
|
||||||
|
|
||||||
JWT-based auth with access tokens (short-lived, 15m) and refresh tokens (7d). Full `AuthService` implementation with `bcrypt` password comparison in [references/advanced-patterns.md](references/advanced-patterns.md).
|
|
||||||
|
|
||||||
## Caching Strategies
|
|
||||||
|
|
||||||
Redis-backed `CacheService` with get/set/delete/invalidatePattern, plus a `@Cacheable` decorator for method-level caching. See [references/advanced-patterns.md](references/advanced-patterns.md).
|
|
||||||
|
|
||||||
## API Response Format
|
|
||||||
|
|
||||||
Standardized `ApiResponse` helper with `success`, `error`, and `paginated` static methods. See [references/advanced-patterns.md](references/advanced-patterns.md).
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **Use TypeScript**: Type safety prevents runtime errors
|
|
||||||
2. **Implement proper error handling**: Use custom error classes
|
|
||||||
3. **Validate input**: Use libraries like Zod or Joi
|
|
||||||
4. **Use environment variables**: Never hardcode secrets
|
|
||||||
5. **Implement logging**: Use structured logging (Pino, Winston)
|
|
||||||
6. **Add rate limiting**: Prevent abuse
|
|
||||||
7. **Use HTTPS**: Always in production
|
|
||||||
8. **Implement CORS properly**: Don't use `*` in production
|
|
||||||
9. **Use dependency injection**: Easier testing and maintenance
|
|
||||||
10. **Write tests**: Unit, integration, and E2E tests
|
|
||||||
11. **Handle graceful shutdown**: Clean up resources
|
|
||||||
12. **Use connection pooling**: For databases
|
|
||||||
13. **Implement health checks**: For monitoring
|
|
||||||
14. **Use compression**: Reduce response size
|
|
||||||
15. **Monitor performance**: Use APM tools
|
|
||||||
|
|
||||||
## Testing Patterns
|
|
||||||
|
|
||||||
See `javascript-testing-patterns` skill for comprehensive testing guidance.
|
|
||||||
@@ -1,430 +0,0 @@
|
|||||||
# Node.js Advanced Patterns
|
|
||||||
|
|
||||||
Advanced patterns for dependency injection, database integration, authentication, caching, and API response formatting.
|
|
||||||
|
|
||||||
## Dependency Injection
|
|
||||||
|
|
||||||
### DI Container
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// di-container.ts
|
|
||||||
import { Pool } from "pg";
|
|
||||||
import { UserRepository } from "./repositories/user.repository";
|
|
||||||
import { UserService } from "./services/user.service";
|
|
||||||
import { UserController } from "./controllers/user.controller";
|
|
||||||
import { AuthService } from "./services/auth.service";
|
|
||||||
|
|
||||||
class Container {
|
|
||||||
private instances = new Map<string, any>();
|
|
||||||
|
|
||||||
register<T>(key: string, factory: () => T): void {
|
|
||||||
this.instances.set(key, factory);
|
|
||||||
}
|
|
||||||
|
|
||||||
resolve<T>(key: string): T {
|
|
||||||
const factory = this.instances.get(key);
|
|
||||||
if (!factory) {
|
|
||||||
throw new Error(`No factory registered for ${key}`);
|
|
||||||
}
|
|
||||||
return factory();
|
|
||||||
}
|
|
||||||
|
|
||||||
singleton<T>(key: string, factory: () => T): void {
|
|
||||||
let instance: T;
|
|
||||||
this.instances.set(key, () => {
|
|
||||||
if (!instance) {
|
|
||||||
instance = factory();
|
|
||||||
}
|
|
||||||
return instance;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const container = new Container();
|
|
||||||
|
|
||||||
// Register dependencies
|
|
||||||
container.singleton(
|
|
||||||
"db",
|
|
||||||
() =>
|
|
||||||
new Pool({
|
|
||||||
host: process.env.DB_HOST,
|
|
||||||
port: parseInt(process.env.DB_PORT || "5432"),
|
|
||||||
database: process.env.DB_NAME,
|
|
||||||
user: process.env.DB_USER,
|
|
||||||
password: process.env.DB_PASSWORD,
|
|
||||||
max: 20,
|
|
||||||
idleTimeoutMillis: 30000,
|
|
||||||
connectionTimeoutMillis: 2000,
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
container.singleton(
|
|
||||||
"userRepository",
|
|
||||||
() => new UserRepository(container.resolve("db")),
|
|
||||||
);
|
|
||||||
|
|
||||||
container.singleton(
|
|
||||||
"userService",
|
|
||||||
() => new UserService(container.resolve("userRepository")),
|
|
||||||
);
|
|
||||||
|
|
||||||
container.register(
|
|
||||||
"userController",
|
|
||||||
() => new UserController(container.resolve("userService")),
|
|
||||||
);
|
|
||||||
|
|
||||||
container.singleton(
|
|
||||||
"authService",
|
|
||||||
() => new AuthService(container.resolve("userRepository")),
|
|
||||||
);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Database Patterns
|
|
||||||
|
|
||||||
### PostgreSQL with Connection Pool
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// config/database.ts
|
|
||||||
import { Pool, PoolConfig } from "pg";
|
|
||||||
|
|
||||||
const poolConfig: PoolConfig = {
|
|
||||||
host: process.env.DB_HOST,
|
|
||||||
port: parseInt(process.env.DB_PORT || "5432"),
|
|
||||||
database: process.env.DB_NAME,
|
|
||||||
user: process.env.DB_USER,
|
|
||||||
password: process.env.DB_PASSWORD,
|
|
||||||
max: 20,
|
|
||||||
idleTimeoutMillis: 30000,
|
|
||||||
connectionTimeoutMillis: 2000,
|
|
||||||
};
|
|
||||||
|
|
||||||
export const pool = new Pool(poolConfig);
|
|
||||||
|
|
||||||
// Test connection
|
|
||||||
pool.on("connect", () => {
|
|
||||||
console.log("Database connected");
|
|
||||||
});
|
|
||||||
|
|
||||||
pool.on("error", (err) => {
|
|
||||||
console.error("Unexpected database error", err);
|
|
||||||
process.exit(-1);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Graceful shutdown
|
|
||||||
export const closeDatabase = async () => {
|
|
||||||
await pool.end();
|
|
||||||
console.log("Database connection closed");
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
### MongoDB with Mongoose
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// config/mongoose.ts
|
|
||||||
import mongoose from "mongoose";
|
|
||||||
|
|
||||||
const connectDB = async () => {
|
|
||||||
try {
|
|
||||||
await mongoose.connect(process.env.MONGODB_URI!, {
|
|
||||||
maxPoolSize: 10,
|
|
||||||
serverSelectionTimeoutMS: 5000,
|
|
||||||
socketTimeoutMS: 45000,
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log("MongoDB connected");
|
|
||||||
} catch (error) {
|
|
||||||
console.error("MongoDB connection error:", error);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
mongoose.connection.on("disconnected", () => {
|
|
||||||
console.log("MongoDB disconnected");
|
|
||||||
});
|
|
||||||
|
|
||||||
mongoose.connection.on("error", (err) => {
|
|
||||||
console.error("MongoDB error:", err);
|
|
||||||
});
|
|
||||||
|
|
||||||
export { connectDB };
|
|
||||||
|
|
||||||
// Model example
|
|
||||||
import { Schema, model, Document } from "mongoose";
|
|
||||||
|
|
||||||
interface IUser extends Document {
|
|
||||||
name: string;
|
|
||||||
email: string;
|
|
||||||
password: string;
|
|
||||||
createdAt: Date;
|
|
||||||
updatedAt: Date;
|
|
||||||
}
|
|
||||||
|
|
||||||
const userSchema = new Schema<IUser>(
|
|
||||||
{
|
|
||||||
name: { type: String, required: true },
|
|
||||||
email: { type: String, required: true, unique: true },
|
|
||||||
password: { type: String, required: true },
|
|
||||||
},
|
|
||||||
{
|
|
||||||
timestamps: true,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
// Indexes
|
|
||||||
userSchema.index({ email: 1 });
|
|
||||||
|
|
||||||
export const User = model<IUser>("User", userSchema);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Transaction Pattern
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// services/order.service.ts
|
|
||||||
import { Pool } from "pg";
|
|
||||||
|
|
||||||
export class OrderService {
|
|
||||||
constructor(private db: Pool) {}
|
|
||||||
|
|
||||||
async createOrder(userId: string, items: any[]) {
|
|
||||||
const client = await this.db.connect();
|
|
||||||
|
|
||||||
try {
|
|
||||||
await client.query("BEGIN");
|
|
||||||
|
|
||||||
// Create order
|
|
||||||
const orderResult = await client.query(
|
|
||||||
"INSERT INTO orders (user_id, total) VALUES ($1, $2) RETURNING id",
|
|
||||||
[userId, calculateTotal(items)],
|
|
||||||
);
|
|
||||||
const orderId = orderResult.rows[0].id;
|
|
||||||
|
|
||||||
// Create order items
|
|
||||||
for (const item of items) {
|
|
||||||
await client.query(
|
|
||||||
"INSERT INTO order_items (order_id, product_id, quantity, price) VALUES ($1, $2, $3, $4)",
|
|
||||||
[orderId, item.productId, item.quantity, item.price],
|
|
||||||
);
|
|
||||||
|
|
||||||
// Update inventory
|
|
||||||
await client.query(
|
|
||||||
"UPDATE products SET stock = stock - $1 WHERE id = $2",
|
|
||||||
[item.quantity, item.productId],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
await client.query("COMMIT");
|
|
||||||
return orderId;
|
|
||||||
} catch (error) {
|
|
||||||
await client.query("ROLLBACK");
|
|
||||||
throw error;
|
|
||||||
} finally {
|
|
||||||
client.release();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Authentication & Authorization
|
|
||||||
|
|
||||||
### JWT Authentication
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// services/auth.service.ts
|
|
||||||
import jwt from "jsonwebtoken";
|
|
||||||
import bcrypt from "bcrypt";
|
|
||||||
import { UserRepository } from "../repositories/user.repository";
|
|
||||||
import { UnauthorizedError } from "../utils/errors";
|
|
||||||
|
|
||||||
export class AuthService {
|
|
||||||
constructor(private userRepository: UserRepository) {}
|
|
||||||
|
|
||||||
async login(email: string, password: string) {
|
|
||||||
const user = await this.userRepository.findByEmail(email);
|
|
||||||
|
|
||||||
if (!user) {
|
|
||||||
throw new UnauthorizedError("Invalid credentials");
|
|
||||||
}
|
|
||||||
|
|
||||||
const isValid = await bcrypt.compare(password, user.password);
|
|
||||||
|
|
||||||
if (!isValid) {
|
|
||||||
throw new UnauthorizedError("Invalid credentials");
|
|
||||||
}
|
|
||||||
|
|
||||||
const token = this.generateToken({
|
|
||||||
userId: user.id,
|
|
||||||
email: user.email,
|
|
||||||
});
|
|
||||||
|
|
||||||
const refreshToken = this.generateRefreshToken({
|
|
||||||
userId: user.id,
|
|
||||||
});
|
|
||||||
|
|
||||||
return {
|
|
||||||
token,
|
|
||||||
refreshToken,
|
|
||||||
user: {
|
|
||||||
id: user.id,
|
|
||||||
name: user.name,
|
|
||||||
email: user.email,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async refreshToken(refreshToken: string) {
|
|
||||||
try {
|
|
||||||
const payload = jwt.verify(
|
|
||||||
refreshToken,
|
|
||||||
process.env.REFRESH_TOKEN_SECRET!,
|
|
||||||
) as { userId: string };
|
|
||||||
|
|
||||||
const user = await this.userRepository.findById(payload.userId);
|
|
||||||
|
|
||||||
if (!user) {
|
|
||||||
throw new UnauthorizedError("User not found");
|
|
||||||
}
|
|
||||||
|
|
||||||
const token = this.generateToken({
|
|
||||||
userId: user.id,
|
|
||||||
email: user.email,
|
|
||||||
});
|
|
||||||
|
|
||||||
return { token };
|
|
||||||
} catch (error) {
|
|
||||||
throw new UnauthorizedError("Invalid refresh token");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private generateToken(payload: any): string {
|
|
||||||
return jwt.sign(payload, process.env.JWT_SECRET!, {
|
|
||||||
expiresIn: "15m",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
private generateRefreshToken(payload: any): string {
|
|
||||||
return jwt.sign(payload, process.env.REFRESH_TOKEN_SECRET!, {
|
|
||||||
expiresIn: "7d",
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Caching Strategies
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// utils/cache.ts
|
|
||||||
import Redis from "ioredis";
|
|
||||||
|
|
||||||
const redis = new Redis({
|
|
||||||
host: process.env.REDIS_HOST,
|
|
||||||
port: parseInt(process.env.REDIS_PORT || "6379"),
|
|
||||||
retryStrategy: (times) => {
|
|
||||||
const delay = Math.min(times * 50, 2000);
|
|
||||||
return delay;
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export class CacheService {
|
|
||||||
async get<T>(key: string): Promise<T | null> {
|
|
||||||
const data = await redis.get(key);
|
|
||||||
return data ? JSON.parse(data) : null;
|
|
||||||
}
|
|
||||||
|
|
||||||
async set(key: string, value: any, ttl?: number): Promise<void> {
|
|
||||||
const serialized = JSON.stringify(value);
|
|
||||||
if (ttl) {
|
|
||||||
await redis.setex(key, ttl, serialized);
|
|
||||||
} else {
|
|
||||||
await redis.set(key, serialized);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async delete(key: string): Promise<void> {
|
|
||||||
await redis.del(key);
|
|
||||||
}
|
|
||||||
|
|
||||||
async invalidatePattern(pattern: string): Promise<void> {
|
|
||||||
const keys = await redis.keys(pattern);
|
|
||||||
if (keys.length > 0) {
|
|
||||||
await redis.del(...keys);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cache decorator
|
|
||||||
export function Cacheable(ttl: number = 300) {
|
|
||||||
return function (
|
|
||||||
target: any,
|
|
||||||
propertyKey: string,
|
|
||||||
descriptor: PropertyDescriptor,
|
|
||||||
) {
|
|
||||||
const originalMethod = descriptor.value;
|
|
||||||
|
|
||||||
descriptor.value = async function (...args: any[]) {
|
|
||||||
const cache = new CacheService();
|
|
||||||
const cacheKey = `${propertyKey}:${JSON.stringify(args)}`;
|
|
||||||
|
|
||||||
const cached = await cache.get(cacheKey);
|
|
||||||
if (cached) {
|
|
||||||
return cached;
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = await originalMethod.apply(this, args);
|
|
||||||
await cache.set(cacheKey, result, ttl);
|
|
||||||
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
|
|
||||||
return descriptor;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## API Response Format
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// utils/response.ts
|
|
||||||
import { Response } from "express";
|
|
||||||
|
|
||||||
export class ApiResponse {
|
|
||||||
static success<T>(
|
|
||||||
res: Response,
|
|
||||||
data: T,
|
|
||||||
message?: string,
|
|
||||||
statusCode = 200,
|
|
||||||
) {
|
|
||||||
return res.status(statusCode).json({
|
|
||||||
status: "success",
|
|
||||||
message,
|
|
||||||
data,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
static error(res: Response, message: string, statusCode = 500, errors?: any) {
|
|
||||||
return res.status(statusCode).json({
|
|
||||||
status: "error",
|
|
||||||
message,
|
|
||||||
...(errors && { errors }),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
static paginated<T>(
|
|
||||||
res: Response,
|
|
||||||
data: T[],
|
|
||||||
page: number,
|
|
||||||
limit: number,
|
|
||||||
total: number,
|
|
||||||
) {
|
|
||||||
return res.json({
|
|
||||||
status: "success",
|
|
||||||
data,
|
|
||||||
pagination: {
|
|
||||||
page,
|
|
||||||
limit,
|
|
||||||
total,
|
|
||||||
pages: Math.ceil(total / limit),
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,343 +0,0 @@
|
|||||||
---
|
|
||||||
name: nodejs-best-practices
|
|
||||||
description: "Node.js development principles and decision-making. Framework selection, async patterns, security, and architecture. Teaches thinking, not copying."
|
|
||||||
risk: unknown
|
|
||||||
source: community
|
|
||||||
date_added: "2026-02-27"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Node.js Best Practices
|
|
||||||
|
|
||||||
> Principles and decision-making for Node.js development in 2025.
|
|
||||||
> **Learn to THINK, not memorize code patterns.**
|
|
||||||
|
|
||||||
## When to Use
|
|
||||||
Use this skill when making Node.js architecture decisions, choosing frameworks, designing async patterns, or applying security and deployment best practices.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ⚠️ How to Use This Skill
|
|
||||||
|
|
||||||
This skill teaches **decision-making principles**, not fixed code to copy.
|
|
||||||
|
|
||||||
- ASK user for preferences when unclear
|
|
||||||
- Choose framework/pattern based on CONTEXT
|
|
||||||
- Don't default to same solution every time
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. Framework Selection (2025)
|
|
||||||
|
|
||||||
### Decision Tree
|
|
||||||
|
|
||||||
```
|
|
||||||
What are you building?
|
|
||||||
│
|
|
||||||
├── Edge/Serverless (Cloudflare, Vercel)
|
|
||||||
│ └── Hono (zero-dependency, ultra-fast cold starts)
|
|
||||||
│
|
|
||||||
├── High Performance API
|
|
||||||
│ └── Fastify (2-3x faster than Express)
|
|
||||||
│
|
|
||||||
├── Enterprise/Team familiarity
|
|
||||||
│ └── NestJS (structured, DI, decorators)
|
|
||||||
│
|
|
||||||
├── Legacy/Stable/Maximum ecosystem
|
|
||||||
│ └── Express (mature, most middleware)
|
|
||||||
│
|
|
||||||
└── Full-stack with frontend
|
|
||||||
└── Next.js API Routes or tRPC
|
|
||||||
```
|
|
||||||
|
|
||||||
### Comparison Principles
|
|
||||||
|
|
||||||
| Factor | Hono | Fastify | Express |
|
|
||||||
|--------|------|---------|---------|
|
|
||||||
| **Best for** | Edge, serverless | Performance | Legacy, learning |
|
|
||||||
| **Cold start** | Fastest | Fast | Moderate |
|
|
||||||
| **Ecosystem** | Growing | Good | Largest |
|
|
||||||
| **TypeScript** | Native | Excellent | Good |
|
|
||||||
| **Learning curve** | Low | Medium | Low |
|
|
||||||
|
|
||||||
### Selection Questions to Ask:
|
|
||||||
1. What's the deployment target?
|
|
||||||
2. Is cold start time critical?
|
|
||||||
3. Does team have existing experience?
|
|
||||||
4. Is there legacy code to maintain?
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Runtime Considerations (2025)
|
|
||||||
|
|
||||||
### Native TypeScript
|
|
||||||
|
|
||||||
```
|
|
||||||
Node.js 22+: --experimental-strip-types
|
|
||||||
├── Run .ts files directly
|
|
||||||
├── No build step needed for simple projects
|
|
||||||
└── Consider for: scripts, simple APIs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Module System Decision
|
|
||||||
|
|
||||||
```
|
|
||||||
ESM (import/export)
|
|
||||||
├── Modern standard
|
|
||||||
├── Better tree-shaking
|
|
||||||
├── Async module loading
|
|
||||||
└── Use for: new projects
|
|
||||||
|
|
||||||
CommonJS (require)
|
|
||||||
├── Legacy compatibility
|
|
||||||
├── More npm packages support
|
|
||||||
└── Use for: existing codebases, some edge cases
|
|
||||||
```
|
|
||||||
|
|
||||||
### Runtime Selection
|
|
||||||
|
|
||||||
| Runtime | Best For |
|
|
||||||
|---------|----------|
|
|
||||||
| **Node.js** | General purpose, largest ecosystem |
|
|
||||||
| **Bun** | Performance, built-in bundler |
|
|
||||||
| **Deno** | Security-first, built-in TypeScript |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Architecture Principles
|
|
||||||
|
|
||||||
### Layered Structure Concept
|
|
||||||
|
|
||||||
```
|
|
||||||
Request Flow:
|
|
||||||
│
|
|
||||||
├── Controller/Route Layer
|
|
||||||
│ ├── Handles HTTP specifics
|
|
||||||
│ ├── Input validation at boundary
|
|
||||||
│ └── Calls service layer
|
|
||||||
│
|
|
||||||
├── Service Layer
|
|
||||||
│ ├── Business logic
|
|
||||||
│ ├── Framework-agnostic
|
|
||||||
│ └── Calls repository layer
|
|
||||||
│
|
|
||||||
└── Repository Layer
|
|
||||||
├── Data access only
|
|
||||||
├── Database queries
|
|
||||||
└── ORM interactions
|
|
||||||
```
|
|
||||||
|
|
||||||
### Why This Matters:
|
|
||||||
- **Testability**: Mock layers independently
|
|
||||||
- **Flexibility**: Swap database without touching business logic
|
|
||||||
- **Clarity**: Each layer has single responsibility
|
|
||||||
|
|
||||||
### When to Simplify:
|
|
||||||
- Small scripts → Single file OK
|
|
||||||
- Prototypes → Less structure acceptable
|
|
||||||
- Always ask: "Will this grow?"
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. Error Handling Principles
|
|
||||||
|
|
||||||
### Centralized Error Handling
|
|
||||||
|
|
||||||
```
|
|
||||||
Pattern:
|
|
||||||
├── Create custom error classes
|
|
||||||
├── Throw from any layer
|
|
||||||
├── Catch at top level (middleware)
|
|
||||||
└── Format consistent response
|
|
||||||
```
|
|
||||||
|
|
||||||
### Error Response Philosophy
|
|
||||||
|
|
||||||
```
|
|
||||||
Client gets:
|
|
||||||
├── Appropriate HTTP status
|
|
||||||
├── Error code for programmatic handling
|
|
||||||
├── User-friendly message
|
|
||||||
└── NO internal details (security!)
|
|
||||||
|
|
||||||
Logs get:
|
|
||||||
├── Full stack trace
|
|
||||||
├── Request context
|
|
||||||
├── User ID (if applicable)
|
|
||||||
└── Timestamp
|
|
||||||
```
|
|
||||||
|
|
||||||
### Status Code Selection
|
|
||||||
|
|
||||||
| Situation | Status | When |
|
|
||||||
|-----------|--------|------|
|
|
||||||
| Bad input | 400 | Client sent invalid data |
|
|
||||||
| No auth | 401 | Missing or invalid credentials |
|
|
||||||
| No permission | 403 | Valid auth, but not allowed |
|
|
||||||
| Not found | 404 | Resource doesn't exist |
|
|
||||||
| Conflict | 409 | Duplicate or state conflict |
|
|
||||||
| Validation | 422 | Schema valid but business rules fail |
|
|
||||||
| Server error | 500 | Our fault, log everything |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 5. Async Patterns Principles
|
|
||||||
|
|
||||||
### When to Use Each
|
|
||||||
|
|
||||||
| Pattern | Use When |
|
|
||||||
|---------|----------|
|
|
||||||
| `async/await` | Sequential async operations |
|
|
||||||
| `Promise.all` | Parallel independent operations |
|
|
||||||
| `Promise.allSettled` | Parallel where some can fail |
|
|
||||||
| `Promise.race` | Timeout or first response wins |
|
|
||||||
|
|
||||||
### Event Loop Awareness
|
|
||||||
|
|
||||||
```
|
|
||||||
I/O-bound (async helps):
|
|
||||||
├── Database queries
|
|
||||||
├── HTTP requests
|
|
||||||
├── File system
|
|
||||||
└── Network operations
|
|
||||||
|
|
||||||
CPU-bound (async doesn't help):
|
|
||||||
├── Crypto operations
|
|
||||||
├── Image processing
|
|
||||||
├── Complex calculations
|
|
||||||
└── → Use worker threads or offload
|
|
||||||
```
|
|
||||||
|
|
||||||
### Avoiding Event Loop Blocking
|
|
||||||
|
|
||||||
- Never use sync methods in production (fs.readFileSync, etc.)
|
|
||||||
- Offload CPU-intensive work
|
|
||||||
- Use streaming for large data
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Validation Principles
|
|
||||||
|
|
||||||
### Validate at Boundaries
|
|
||||||
|
|
||||||
```
|
|
||||||
Where to validate:
|
|
||||||
├── API entry point (request body/params)
|
|
||||||
├── Before database operations
|
|
||||||
├── External data (API responses, file uploads)
|
|
||||||
└── Environment variables (startup)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Validation Library Selection
|
|
||||||
|
|
||||||
| Library | Best For |
|
|
||||||
|---------|----------|
|
|
||||||
| **Zod** | TypeScript first, inference |
|
|
||||||
| **Valibot** | Smaller bundle (tree-shakeable) |
|
|
||||||
| **ArkType** | Performance critical |
|
|
||||||
| **Yup** | Existing React Form usage |
|
|
||||||
|
|
||||||
### Validation Philosophy
|
|
||||||
|
|
||||||
- Fail fast: Validate early
|
|
||||||
- Be specific: Clear error messages
|
|
||||||
- Don't trust: Even "internal" data
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 7. Security Principles
|
|
||||||
|
|
||||||
### Security Checklist (Not Code)
|
|
||||||
|
|
||||||
- [ ] **Input validation**: All inputs validated
|
|
||||||
- [ ] **Parameterized queries**: No string concatenation for SQL
|
|
||||||
- [ ] **Password hashing**: bcrypt or argon2
|
|
||||||
- [ ] **JWT verification**: Always verify signature and expiry
|
|
||||||
- [ ] **Rate limiting**: Protect from abuse
|
|
||||||
- [ ] **Security headers**: Helmet.js or equivalent
|
|
||||||
- [ ] **HTTPS**: Everywhere in production
|
|
||||||
- [ ] **CORS**: Properly configured
|
|
||||||
- [ ] **Secrets**: Environment variables only
|
|
||||||
- [ ] **Dependencies**: Regularly audited
|
|
||||||
|
|
||||||
### Security Mindset
|
|
||||||
|
|
||||||
```
|
|
||||||
Trust nothing:
|
|
||||||
├── Query params → validate
|
|
||||||
├── Request body → validate
|
|
||||||
├── Headers → verify
|
|
||||||
├── Cookies → validate
|
|
||||||
├── File uploads → scan
|
|
||||||
└── External APIs → validate response
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 8. Testing Principles
|
|
||||||
|
|
||||||
### Test Strategy Selection
|
|
||||||
|
|
||||||
| Type | Purpose | Tools |
|
|
||||||
|------|---------|-------|
|
|
||||||
| **Unit** | Business logic | node:test, Vitest |
|
|
||||||
| **Integration** | API endpoints | Supertest |
|
|
||||||
| **E2E** | Full flows | Playwright |
|
|
||||||
|
|
||||||
### What to Test (Priorities)
|
|
||||||
|
|
||||||
1. **Critical paths**: Auth, payments, core business
|
|
||||||
2. **Edge cases**: Empty inputs, boundaries
|
|
||||||
3. **Error handling**: What happens when things fail?
|
|
||||||
4. **Not worth testing**: Framework code, trivial getters
|
|
||||||
|
|
||||||
### Built-in Test Runner (Node.js 22+)
|
|
||||||
|
|
||||||
```
|
|
||||||
node --test src/**/*.test.ts
|
|
||||||
├── No external dependency
|
|
||||||
├── Good coverage reporting
|
|
||||||
└── Watch mode available
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 9. Anti-Patterns to Avoid
|
|
||||||
|
|
||||||
### ❌ DON'T:
|
|
||||||
- Use Express for new edge projects (use Hono)
|
|
||||||
- Use sync methods in production code
|
|
||||||
- Put business logic in controllers
|
|
||||||
- Skip input validation
|
|
||||||
- Hardcode secrets
|
|
||||||
- Trust external data without validation
|
|
||||||
- Block event loop with CPU work
|
|
||||||
|
|
||||||
### ✅ DO:
|
|
||||||
- Choose framework based on context
|
|
||||||
- Ask user for preferences when unclear
|
|
||||||
- Use layered architecture for growing projects
|
|
||||||
- Validate all inputs
|
|
||||||
- Use environment variables for secrets
|
|
||||||
- Profile before optimizing
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 10. Decision Checklist
|
|
||||||
|
|
||||||
Before implementing:
|
|
||||||
|
|
||||||
- [ ] **Asked user about stack preference?**
|
|
||||||
- [ ] **Chosen framework for THIS context?** (not just default)
|
|
||||||
- [ ] **Considered deployment target?**
|
|
||||||
- [ ] **Planned error handling strategy?**
|
|
||||||
- [ ] **Identified validation points?**
|
|
||||||
- [ ] **Considered security requirements?**
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
> **Remember**: Node.js best practices are about decision-making, not memorizing patterns. Every project deserves fresh consideration based on its requirements.
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
- Use this skill only when the task clearly matches the scope described above.
|
|
||||||
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
|
|
||||||
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
|
|
||||||
@@ -1,513 +0,0 @@
|
|||||||
---
|
|
||||||
name: seo
|
|
||||||
description: Optimize for search engine visibility and ranking. Use when asked to "improve SEO", "optimize for search", "fix meta tags", "add structured data", "sitemap optimization", or "search engine optimization".
|
|
||||||
license: MIT
|
|
||||||
metadata:
|
|
||||||
author: web-quality-skills
|
|
||||||
version: "1.0"
|
|
||||||
---
|
|
||||||
|
|
||||||
# SEO optimization
|
|
||||||
|
|
||||||
Search engine optimization based on Lighthouse SEO audits and Google Search guidelines. Focus on technical SEO, on-page optimization, and structured data.
|
|
||||||
|
|
||||||
## SEO fundamentals
|
|
||||||
|
|
||||||
Search ranking factors (approximate influence):
|
|
||||||
|
|
||||||
| Factor | Influence | This Skill |
|
|
||||||
|--------|-----------|------------|
|
|
||||||
| Content quality & relevance | ~40% | Partial (structure) |
|
|
||||||
| Backlinks & authority | ~25% | ✗ |
|
|
||||||
| Technical SEO | ~15% | ✓ |
|
|
||||||
| Page experience (Core Web Vitals) | ~10% | See [Core Web Vitals](../core-web-vitals/SKILL.md) |
|
|
||||||
| On-page SEO | ~10% | ✓ |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technical SEO
|
|
||||||
|
|
||||||
### Crawlability
|
|
||||||
|
|
||||||
**robots.txt:**
|
|
||||||
```text
|
|
||||||
# /robots.txt
|
|
||||||
User-agent: *
|
|
||||||
Allow: /
|
|
||||||
|
|
||||||
# Block admin/private areas
|
|
||||||
Disallow: /admin/
|
|
||||||
Disallow: /api/
|
|
||||||
Disallow: /private/
|
|
||||||
|
|
||||||
# Don't block resources needed for rendering
|
|
||||||
# ❌ Disallow: /static/
|
|
||||||
|
|
||||||
Sitemap: https://example.com/sitemap.xml
|
|
||||||
```
|
|
||||||
|
|
||||||
**Meta robots:**
|
|
||||||
```html
|
|
||||||
<!-- Default: indexable, followable -->
|
|
||||||
<meta name="robots" content="index, follow">
|
|
||||||
|
|
||||||
<!-- Noindex specific pages -->
|
|
||||||
<meta name="robots" content="noindex, nofollow">
|
|
||||||
|
|
||||||
<!-- Indexable but don't follow links -->
|
|
||||||
<meta name="robots" content="index, nofollow">
|
|
||||||
|
|
||||||
<!-- Control snippets -->
|
|
||||||
<meta name="robots" content="max-snippet:150, max-image-preview:large">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Canonical URLs:**
|
|
||||||
```html
|
|
||||||
<!-- Prevent duplicate content issues -->
|
|
||||||
<link rel="canonical" href="https://example.com/page">
|
|
||||||
|
|
||||||
<!-- Self-referencing canonical (recommended) -->
|
|
||||||
<link rel="canonical" href="https://example.com/current-page">
|
|
||||||
|
|
||||||
<!-- For paginated content -->
|
|
||||||
<link rel="canonical" href="https://example.com/products">
|
|
||||||
<!-- Or use rel="prev" / rel="next" for explicit pagination -->
|
|
||||||
```
|
|
||||||
|
|
||||||
### XML sitemap
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
||||||
<url>
|
|
||||||
<loc>https://example.com/</loc>
|
|
||||||
<lastmod>2024-01-15</lastmod>
|
|
||||||
<changefreq>daily</changefreq>
|
|
||||||
<priority>1.0</priority>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://example.com/products</loc>
|
|
||||||
<lastmod>2024-01-14</lastmod>
|
|
||||||
<changefreq>weekly</changefreq>
|
|
||||||
<priority>0.8</priority>
|
|
||||||
</url>
|
|
||||||
</urlset>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Sitemap best practices:**
|
|
||||||
- Maximum 50,000 URLs or 50MB per sitemap
|
|
||||||
- Use sitemap index for larger sites
|
|
||||||
- Include only canonical, indexable URLs
|
|
||||||
- Update `lastmod` when content changes
|
|
||||||
- Submit to Google Search Console
|
|
||||||
|
|
||||||
### URL structure
|
|
||||||
|
|
||||||
```
|
|
||||||
✅ Good URLs:
|
|
||||||
https://example.com/products/blue-widget
|
|
||||||
https://example.com/blog/how-to-use-widgets
|
|
||||||
|
|
||||||
❌ Poor URLs:
|
|
||||||
https://example.com/p?id=12345
|
|
||||||
https://example.com/products/item/category/subcategory/blue-widget-2024-sale-discount
|
|
||||||
```
|
|
||||||
|
|
||||||
**URL guidelines:**
|
|
||||||
- Use hyphens, not underscores
|
|
||||||
- Lowercase only
|
|
||||||
- Keep short (< 75 characters)
|
|
||||||
- Include target keywords naturally
|
|
||||||
- Avoid parameters when possible
|
|
||||||
- Use HTTPS always
|
|
||||||
|
|
||||||
### HTTPS & security
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- Ensure all resources use HTTPS -->
|
|
||||||
<img src="https://example.com/image.jpg">
|
|
||||||
|
|
||||||
<!-- Not: -->
|
|
||||||
<img src="http://example.com/image.jpg">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Security headers for SEO trust signals:**
|
|
||||||
```
|
|
||||||
Strict-Transport-Security: max-age=31536000; includeSubDomains
|
|
||||||
X-Content-Type-Options: nosniff
|
|
||||||
X-Frame-Options: DENY
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## On-page SEO
|
|
||||||
|
|
||||||
### Title tags
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Missing or generic -->
|
|
||||||
<title>Page</title>
|
|
||||||
<title>Home</title>
|
|
||||||
|
|
||||||
<!-- ✅ Descriptive with primary keyword -->
|
|
||||||
<title>Blue Widgets for Sale | Premium Quality | Example Store</title>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Title tag guidelines:**
|
|
||||||
- 50-60 characters (Google truncates ~60)
|
|
||||||
- Primary keyword near the beginning
|
|
||||||
- Unique for every page
|
|
||||||
- Brand name at end (unless homepage)
|
|
||||||
- Action-oriented when appropriate
|
|
||||||
|
|
||||||
### Meta descriptions
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Missing or duplicate -->
|
|
||||||
<meta name="description" content="">
|
|
||||||
|
|
||||||
<!-- ✅ Compelling and unique -->
|
|
||||||
<meta name="description" content="Shop premium blue widgets with free shipping. 30-day returns. Rated 4.9/5 by 10,000+ customers. Order today and save 20%.">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Meta description guidelines:**
|
|
||||||
- 150-160 characters
|
|
||||||
- Include primary keyword naturally
|
|
||||||
- Compelling call-to-action
|
|
||||||
- Unique for every page
|
|
||||||
- Matches page content
|
|
||||||
|
|
||||||
### Heading structure
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Poor structure -->
|
|
||||||
<h2>Welcome to Our Store</h2>
|
|
||||||
<h4>Products</h4>
|
|
||||||
<h1>Contact Us</h1>
|
|
||||||
|
|
||||||
<!-- ✅ Proper hierarchy -->
|
|
||||||
<h1>Blue Widgets - Premium Quality</h1>
|
|
||||||
<h2>Product Features</h2>
|
|
||||||
<h3>Durability</h3>
|
|
||||||
<h3>Design</h3>
|
|
||||||
<h2>Customer Reviews</h2>
|
|
||||||
<h2>Pricing</h2>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Heading guidelines:**
|
|
||||||
- Single `<h1>` per page (the main topic)
|
|
||||||
- Logical hierarchy (don't skip levels)
|
|
||||||
- Include keywords naturally
|
|
||||||
- Descriptive, not generic
|
|
||||||
|
|
||||||
### Image SEO
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Poor image SEO -->
|
|
||||||
<img src="IMG_12345.jpg">
|
|
||||||
|
|
||||||
<!-- ✅ Optimized image -->
|
|
||||||
<img src="blue-widget-product-photo.webp"
|
|
||||||
alt="Blue widget with chrome finish, side view showing control panel"
|
|
||||||
width="800"
|
|
||||||
height="600"
|
|
||||||
loading="lazy">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Image guidelines:**
|
|
||||||
- Descriptive filenames with keywords
|
|
||||||
- Alt text describes the image content
|
|
||||||
- Compressed and properly sized
|
|
||||||
- WebP/AVIF with fallbacks
|
|
||||||
- Lazy load below-fold images
|
|
||||||
|
|
||||||
### Internal linking
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Non-descriptive -->
|
|
||||||
<a href="/products">Click here</a>
|
|
||||||
<a href="/widgets">Read more</a>
|
|
||||||
|
|
||||||
<!-- ✅ Descriptive anchor text -->
|
|
||||||
<a href="/products/blue-widgets">Browse our blue widget collection</a>
|
|
||||||
<a href="/guides/widget-maintenance">Learn how to maintain your widgets</a>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Linking guidelines:**
|
|
||||||
- Descriptive anchor text with keywords
|
|
||||||
- Link to relevant internal pages
|
|
||||||
- Reasonable number of links per page
|
|
||||||
- Fix broken links promptly
|
|
||||||
- Use breadcrumbs for hierarchy
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Structured data (JSON-LD)
|
|
||||||
|
|
||||||
### Organization
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="application/ld+json">
|
|
||||||
{
|
|
||||||
"@context": "https://schema.org",
|
|
||||||
"@type": "Organization",
|
|
||||||
"name": "Example Company",
|
|
||||||
"url": "https://example.com",
|
|
||||||
"logo": "https://example.com/logo.png",
|
|
||||||
"sameAs": [
|
|
||||||
"https://twitter.com/example",
|
|
||||||
"https://linkedin.com/company/example"
|
|
||||||
],
|
|
||||||
"contactPoint": {
|
|
||||||
"@type": "ContactPoint",
|
|
||||||
"telephone": "+1-555-123-4567",
|
|
||||||
"contactType": "customer service"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Article
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="application/ld+json">
|
|
||||||
{
|
|
||||||
"@context": "https://schema.org",
|
|
||||||
"@type": "Article",
|
|
||||||
"headline": "How to Choose the Right Widget",
|
|
||||||
"description": "Complete guide to selecting widgets for your needs.",
|
|
||||||
"image": "https://example.com/article-image.jpg",
|
|
||||||
"author": {
|
|
||||||
"@type": "Person",
|
|
||||||
"name": "Jane Smith",
|
|
||||||
"url": "https://example.com/authors/jane-smith"
|
|
||||||
},
|
|
||||||
"publisher": {
|
|
||||||
"@type": "Organization",
|
|
||||||
"name": "Example Blog",
|
|
||||||
"logo": {
|
|
||||||
"@type": "ImageObject",
|
|
||||||
"url": "https://example.com/logo.png"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"datePublished": "2024-01-15",
|
|
||||||
"dateModified": "2024-01-20"
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Product
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="application/ld+json">
|
|
||||||
{
|
|
||||||
"@context": "https://schema.org",
|
|
||||||
"@type": "Product",
|
|
||||||
"name": "Blue Widget Pro",
|
|
||||||
"image": "https://example.com/blue-widget.jpg",
|
|
||||||
"description": "Premium blue widget with advanced features.",
|
|
||||||
"brand": {
|
|
||||||
"@type": "Brand",
|
|
||||||
"name": "WidgetCo"
|
|
||||||
},
|
|
||||||
"offers": {
|
|
||||||
"@type": "Offer",
|
|
||||||
"price": "49.99",
|
|
||||||
"priceCurrency": "USD",
|
|
||||||
"availability": "https://schema.org/InStock",
|
|
||||||
"url": "https://example.com/products/blue-widget"
|
|
||||||
},
|
|
||||||
"aggregateRating": {
|
|
||||||
"@type": "AggregateRating",
|
|
||||||
"ratingValue": "4.8",
|
|
||||||
"reviewCount": "1250"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### FAQ
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="application/ld+json">
|
|
||||||
{
|
|
||||||
"@context": "https://schema.org",
|
|
||||||
"@type": "FAQPage",
|
|
||||||
"mainEntity": [
|
|
||||||
{
|
|
||||||
"@type": "Question",
|
|
||||||
"name": "What colors are available?",
|
|
||||||
"acceptedAnswer": {
|
|
||||||
"@type": "Answer",
|
|
||||||
"text": "Our widgets come in blue, red, and green."
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"@type": "Question",
|
|
||||||
"name": "What is the warranty?",
|
|
||||||
"acceptedAnswer": {
|
|
||||||
"@type": "Answer",
|
|
||||||
"text": "All widgets include a 2-year warranty."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Breadcrumbs
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script type="application/ld+json">
|
|
||||||
{
|
|
||||||
"@context": "https://schema.org",
|
|
||||||
"@type": "BreadcrumbList",
|
|
||||||
"itemListElement": [
|
|
||||||
{
|
|
||||||
"@type": "ListItem",
|
|
||||||
"position": 1,
|
|
||||||
"name": "Home",
|
|
||||||
"item": "https://example.com"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"@type": "ListItem",
|
|
||||||
"position": 2,
|
|
||||||
"name": "Products",
|
|
||||||
"item": "https://example.com/products"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"@type": "ListItem",
|
|
||||||
"position": 3,
|
|
||||||
"name": "Blue Widgets",
|
|
||||||
"item": "https://example.com/products/blue-widgets"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Validation
|
|
||||||
|
|
||||||
Test structured data at:
|
|
||||||
- [Google Rich Results Test](https://search.google.com/test/rich-results)
|
|
||||||
- [Schema.org Validator](https://validator.schema.org/)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Mobile SEO
|
|
||||||
|
|
||||||
### Responsive design
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- ❌ Not mobile-friendly -->
|
|
||||||
<meta name="viewport" content="width=1024">
|
|
||||||
|
|
||||||
<!-- ✅ Responsive viewport -->
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tap targets
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ❌ Too small for mobile */
|
|
||||||
.small-link {
|
|
||||||
padding: 4px;
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Adequate tap target */
|
|
||||||
.mobile-friendly-link {
|
|
||||||
padding: 12px;
|
|
||||||
font-size: 16px;
|
|
||||||
min-height: 48px;
|
|
||||||
min-width: 48px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Font sizes
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* ❌ Too small on mobile */
|
|
||||||
body {
|
|
||||||
font-size: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* ✅ Readable without zooming */
|
|
||||||
body {
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.5;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## International SEO
|
|
||||||
|
|
||||||
### Hreflang tags
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!-- For multi-language sites -->
|
|
||||||
<link rel="alternate" hreflang="en" href="https://example.com/page">
|
|
||||||
<link rel="alternate" hreflang="es" href="https://example.com/es/page">
|
|
||||||
<link rel="alternate" hreflang="fr" href="https://example.com/fr/page">
|
|
||||||
<link rel="alternate" hreflang="x-default" href="https://example.com/page">
|
|
||||||
```
|
|
||||||
|
|
||||||
### Language declaration
|
|
||||||
|
|
||||||
```html
|
|
||||||
<html lang="en">
|
|
||||||
<!-- or -->
|
|
||||||
<html lang="es-MX">
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## SEO audit checklist
|
|
||||||
|
|
||||||
### Critical
|
|
||||||
- [ ] HTTPS enabled
|
|
||||||
- [ ] robots.txt allows crawling
|
|
||||||
- [ ] No `noindex` on important pages
|
|
||||||
- [ ] Title tags present and unique
|
|
||||||
- [ ] Single `<h1>` per page
|
|
||||||
|
|
||||||
### High priority
|
|
||||||
- [ ] Meta descriptions present
|
|
||||||
- [ ] Sitemap submitted
|
|
||||||
- [ ] Canonical URLs set
|
|
||||||
- [ ] Mobile-responsive
|
|
||||||
- [ ] Core Web Vitals passing
|
|
||||||
|
|
||||||
### Medium priority
|
|
||||||
- [ ] Structured data implemented
|
|
||||||
- [ ] Internal linking strategy
|
|
||||||
- [ ] Image alt text
|
|
||||||
- [ ] Descriptive URLs
|
|
||||||
- [ ] Breadcrumb navigation
|
|
||||||
|
|
||||||
### Ongoing
|
|
||||||
- [ ] Fix crawl errors in Search Console
|
|
||||||
- [ ] Update sitemap when content changes
|
|
||||||
- [ ] Monitor ranking changes
|
|
||||||
- [ ] Check for broken links
|
|
||||||
- [ ] Review Search Console insights
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tools
|
|
||||||
|
|
||||||
| Tool | Use |
|
|
||||||
|------|-----|
|
|
||||||
| Google Search Console | Monitor indexing, fix issues |
|
|
||||||
| Google PageSpeed Insights | Performance + Core Web Vitals |
|
|
||||||
| Rich Results Test | Validate structured data |
|
|
||||||
| Lighthouse | Full SEO audit |
|
|
||||||
| Screaming Frog | Crawl analysis |
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
- [Google Search Central](https://developers.google.com/search)
|
|
||||||
- [Schema.org](https://schema.org/)
|
|
||||||
- [Core Web Vitals](../core-web-vitals/SKILL.md)
|
|
||||||
- [Web Quality Audit](../web-quality-audit/SKILL.md)
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# 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,28 +32,24 @@ 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) \
|
||||||
-f ./frontend/Dockerfile .
|
./frontend
|
||||||
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 \
|
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest ./backend
|
||||||
-f ./backend/Dockerfile .
|
|
||||||
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest
|
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-backend:latest
|
||||||
|
|
||||||
- name: Build discord bot
|
- name: Build discord bot
|
||||||
run: |
|
run: |
|
||||||
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \
|
docker build -t git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest \
|
||||||
-f ./discord-bot/Dockerfile .
|
./discord-bot
|
||||||
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest
|
docker push git.aranroig.com/${{ secrets.REGISTRY_USER }}/dragonroll-discord-bot:latest
|
||||||
|
|
||||||
- name: Copy files
|
- name: Copy files
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
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'
|
|
||||||
693
AGENTS.md
693
AGENTS.md
@@ -1,252 +1,563 @@
|
|||||||
# AGENTS.md — Dragonroll
|
# AGENTS.md — Dragonroll
|
||||||
|
|
||||||
Orientation map, kept short on purpose. Read the file you are about to change: this tells you where to
|
Read this file before touching the code. It is a complete map of the project: layout, architecture,
|
||||||
look and what will bite you, it does not replace the code. Longer docs: `dragonroll-foundry/README.md`,
|
data model, API, conventions and known landmines. You should not need to explore the rest of the repo
|
||||||
`discord-bot/README.md`, `obsidian-plugin/README.md`.
|
to make a correct change.
|
||||||
|
|
||||||
## 1. What this is
|
## 1. What this is
|
||||||
|
|
||||||
Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, folders, characters,
|
**Dragonroll** is a free/open-source helper for tabletop RPG campaigns (notes, campaigns, folders,
|
||||||
items, maps, dice widgets, sounds).
|
dice widgets, shared markdown, sounds). It is a two-app monorepo:
|
||||||
|
|
||||||
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS.
|
||||||
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. Two pages: the app and `/docs` (§5.1).
|
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion.
|
||||||
- `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
|
There is **no** database seeding, no ORM migrations, no test suite, no linter/formatter config, no
|
||||||
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
Pinia/Vuex, and no Vue Router pages (see §5.1 — the UI is a window manager, not routed pages).
|
||||||
`.gitea/workflows/test.yml` runs `npm test` on every branch.
|
|
||||||
|
|
||||||
## 2. Commands
|
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`).
|
||||||
|
CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `master`, pushes them to
|
||||||
|
`git.aranroig.com/<user>/dragonroll-{frontend,backend}:latest`, copies `docker-compose.yml` +
|
||||||
|
`nginx.conf` to the deploy host and runs `docker compose pull && up -d`.
|
||||||
|
|
||||||
`pnpm` comes from corepack (`packageManager` in `package.json`); `COREPACK_ENABLE_DOWNLOAD_PROMPT=0`
|
## 2. Root layout
|
||||||
keeps corepack from asking in non-interactive shells.
|
|
||||||
|
|
||||||
```bash
|
```
|
||||||
pnpm install # whole workspace, one lockfile (`-r` / `--filter <pkg>` for a single one)
|
dragonroll/
|
||||||
pnpm dev # backend :5000 + frontend :3000 + discord-bot + scripts/run-foundry.js
|
├── backend/ Express API (CommonJS, entry: src/index.js)
|
||||||
pnpm dev:backend # or dev:frontend | dev:discord-bot
|
├── frontend/ Nuxt 4 app (entry: app/app.vue)
|
||||||
pnpm --filter ./frontend run build # or preview
|
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
|
||||||
pnpm test
|
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
|
||||||
|
├── nginx.conf reverse proxy rules for the compose stack
|
||||||
|
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
||||||
|
├── .gitea/workflows/deploy.yml
|
||||||
|
├── static/media/ README logo images only
|
||||||
|
├── package.json root: only `concurrently`, used by `npm run dev`
|
||||||
|
└── README.md install/run instructions are STALE (see §9)
|
||||||
```
|
```
|
||||||
|
|
||||||
No `start` script in backend/frontend and no lint command. Verification = run the dev server and
|
## 3. Commands
|
||||||
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
|
```bash
|
||||||
through the workspace (`concurrently` only labels them and kills them together), and production runs
|
npm install # root: installs `concurrently` only
|
||||||
from the compose images (`CMD` of each `Dockerfile`).
|
npm install --prefix backend
|
||||||
|
npm install --prefix frontend # runs `nuxt prepare` via postinstall
|
||||||
|
|
||||||
Env: `backend/.env` (`PORT` is read but ignored, `DB_URI`), `frontend/.env` (`NUXT_PUBLIC_API_BASE_URL`),
|
npm run dev # both apps: backend (nodemon, :5000) + frontend (nuxt dev, :3000)
|
||||||
both gitignored; the `.env.production` files are committed. `backend/src/index.js` loads `.env.$NODE_ENV`
|
# also runs the Foundry VTT start script from root .env
|
||||||
when `NODE_ENV` is set, otherwise `.env`. The server always listens on **5000**.
|
# (FOUNDRY_START_SCRIPT, via scripts/run-foundry.js)
|
||||||
|
npm --prefix backend run dev # backend only
|
||||||
|
npm --prefix frontend run dev # frontend only
|
||||||
|
npm --prefix frontend run build # nuxt build --dotenv .env.production
|
||||||
|
npm --prefix frontend run preview
|
||||||
|
```
|
||||||
|
|
||||||
## 3. Backend
|
There is no `start` script in either package, no test command, and no lint command.
|
||||||
|
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello).
|
||||||
|
|
||||||
`src/models/` one Mongoose schema per file · `src/routes/` thin Express routers · `src/services/`
|
### Environment files
|
||||||
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`,
|
| File | Contents | Notes |
|
||||||
`/api/link`, `/api/foundry` (link + sync, token-authenticated) are mounted **before**
|
|---|---|---|
|
||||||
`checkAuth = passport.authenticate('jwt', {session:false})`; everything after it
|
| `.env` (root) | `FOUNDRY_START_SCRIPT=<path to Foundry VTT start.sh>` | gitignored; consumed by `scripts/run-foundry.js` during `npm run dev` |
|
||||||
(`/api/campaign|note|folder|actor|item|map|foundry`) is JWT-protected. `checkAuth` is assigned without
|
| `backend/.env` | `PORT=5000`, `DB_URI=mongodb://localhost:27017/dragonroll`, `NODE_ENV=development` | gitignored |
|
||||||
`const` (implicit global). New user routes are public unless the handler calls
|
| `backend/.env.production` | same shape, `DB_URI=mongodb://192.168.1.7:27017/dragonroll` | **committed** |
|
||||||
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
| `frontend/.env` | `NUXT_PUBLIC_API_BASE_URL=http://localhost:5000/api` | gitignored |
|
||||||
`/get-settings`). JWT: payload `{_id, username, name, email, admin, settings}`, 48h; `req.user` is the
|
| `frontend/.env.production` | `NUXT_PUBLIC_API_BASE_URL=https://dragonroll.aranroig.com/api` | **committed** |
|
||||||
Mongoose document, so routes use `req.user.id`.
|
|
||||||
|
|
||||||
CORS allows any origin for the service link/sync paths only; the app-wide CORS whitelists
|
`backend/src/index.js` loads `.env.$NODE_ENV` when `NODE_ENV` is set, otherwise plain `.env`.
|
||||||
`http://localhost:3000` and nothing else (production hides behind the nginx same-origin proxy).
|
`PORT` is read from env but **ignored**: the server always listens on 5000.
|
||||||
|
|
||||||
**Response envelope** — always HTTP 200, no real status codes:
|
## 4. Backend
|
||||||
|
|
||||||
|
```
|
||||||
|
backend/src/
|
||||||
|
├── index.js app bootstrap: dotenv, static uploads, json limits (50mb),
|
||||||
|
│ passport init, CORS, route mounting, listen(5000)
|
||||||
|
├── db.js connectDB() -> mongoose.connect(process.env.DB_URI)
|
||||||
|
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js Map.js
|
||||||
|
│ FoundryLinkRequest.js DiscordLinkRequest.js DiscordGuildLink.js
|
||||||
|
├── routes/ user.js campaign.js note.js folder.js actor.js item.js map.js
|
||||||
|
│ foundry-link.js (token sync, mounted BEFORE auth) foundry.js (bridge proxy)
|
||||||
|
│ discord.js
|
||||||
|
├── services/
|
||||||
|
│ ├── keys.js { secret: "putyoursecrethere" } <- JWT secret, hardcoded
|
||||||
|
│ ├── passport.js JwtStrategy: Bearer token -> User.findById(jwt_payload._id)
|
||||||
|
│ ├── middleware.js isAdmin — imported by routes/user.js but applied to no route yet
|
||||||
|
│ ├── rate-limiter.js express-rate-limit: 150 req / 60 min, applied to /user/login and /user/setup
|
||||||
|
│ ├── storage.js multer diskStorage -> backend/src/uploads/, filename `<field>-<timestamp><ext>`
|
||||||
|
│ ├── foundry.js requestFoundry(): reads the optional snapshot bridge
|
||||||
|
│ ├── foundry-fields.js shared asText/numberOr/plainText/stringList for the mappers
|
||||||
|
│ ├── actor-foundry.js foundryActorToCharacter(): Foundry actor document -> Actor fields
|
||||||
|
│ └── item-foundry.js foundryItemToItemData(): Foundry item document -> Item fields
|
||||||
|
└── uploads/ created on demand, gitignored, served PUBLICLY at /api/public
|
||||||
|
```
|
||||||
|
|
||||||
|
### Auth chain (order matters, `src/index.js`)
|
||||||
|
|
||||||
|
1. `/api/public/*` → static file serving of `src/uploads` (no auth).
|
||||||
|
2. `app.use('/api/user', routes/user)` → **mounted before the JWT guard**, so the whole user router is
|
||||||
|
reachable unauthenticated. Individual handlers that need a user call
|
||||||
|
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
||||||
|
`/get-settings`).
|
||||||
|
3. `checkAuth = passport.authenticate('jwt', { session: false })` — note the **missing declaration**
|
||||||
|
(implicit global). Everything mounted after this is JWT-protected.
|
||||||
|
4. `/api/campaign`, `/api/note`, `/api/folder`, `/api/actor`, `/api/item` and `/api/foundry`
|
||||||
|
(the read-only bridge proxy). `routes/foundry-link.js` is deliberately mounted **before** step 3 —
|
||||||
|
it authenticates with the per-campaign sync token instead of a Dragonroll login (see §4.1).
|
||||||
|
|
||||||
|
JWT: signed in `POST /api/user/login` with payload `{ _id, username, name, email, admin, settings }`,
|
||||||
|
`expiresIn: 172800` (48h). `req.user` is the Mongoose `User` document, so routes use `req.user.id`.
|
||||||
|
|
||||||
|
### Response convention
|
||||||
|
|
||||||
|
Every endpoint returns HTTP 200 with a JSON envelope; there is almost no real status-code usage:
|
||||||
|
|
||||||
```jsonc
|
```jsonc
|
||||||
{ "status": "ok", ...payload }
|
{ "status": "ok", ...payload }
|
||||||
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
|
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
|
||||||
```
|
```
|
||||||
|
|
||||||
Common keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
Common `msg` keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
||||||
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. `GET /user/has-admin`
|
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. The frontend checks
|
||||||
returns `status: 'init'` when no admin exists yet (→ first-run registration).
|
`response.data.status !== 'ok'`. `GET /user/has-admin` uses a special `status: "init"` to mean
|
||||||
|
"no admin exists yet → show first-run registration".
|
||||||
|
|
||||||
**Authorization** — single-tenant: a campaign belongs to `createdBy`, everything else hangs off a
|
### Authorization model
|
||||||
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`):
|
Single-tenant per user: a campaign belongs to `createdBy`, everything else hangs off a campaign.
|
||||||
|
`note.js` and `folder.js` define a local helper:
|
||||||
|
|
||||||
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
```js
|
||||||
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
async function userOwnsCampaign(campaignId, userId) { ... } // duplicated in both files
|
||||||
- `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}`):
|
Ownership is enforced per handler. `settings`, `color`, `description` and `User.settings` are schemaless
|
||||||
|
`Object`/free-form fields.
|
||||||
|
|
||||||
- `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>`.
|
### Data model
|
||||||
- `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)
|
```
|
||||||
|
User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder, self-ref)
|
||||||
|
└───────< Folder
|
||||||
|
└───────< Actor (Foundry actors, when linked)
|
||||||
|
└───────< Item (Foundry gear + hand-made items)
|
||||||
|
└───────< Map (uploaded images + their grid settings)
|
||||||
|
```
|
||||||
|
|
||||||
Every external service links to a campaign the same way, **never with a Dragonroll login**: it calls
|
| Model | File | Fields |
|
||||||
`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
|
| `User` | `models/User.js` | `name*`, `username*` (unique), `email*` (unique), `password` (bcrypt hash, 10 salt rounds), `date`, `admin` (bool, default false), `image`, `setupCode`, `settings` (Object) |
|
||||||
picks a campaign at `POST /api/link/complete`; the service then redeems its credential once at
|
| `Campaign` | `models/Campaign.js` | `name*`, `description`, `color`, `createdBy*` → User, `date`, `settings` (Object), `foundryWorldId` (unique, sparse), `foundryWorldTitle`, `foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId` |
|
||||||
`POST /api/link/pickup` (one-time; losing it means a new link). Proofs differ per service
|
| `Note` | `models/Note.js` | `title`, `content` (markdown source string), `campaign*` → Campaign, `folder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
|
||||||
(`services/service-links.js`): the Discord bot proves itself with the shared secret header, Foundry and
|
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
|
||||||
Obsidian only hold their link code, so what a link grants is decided by the user. Codes are hashed at
|
| `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` |
|
||||||
rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
| `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` |
|
||||||
|
| `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `campaign*` → Campaign, `date` |
|
||||||
|
|
||||||
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
`*` = required. Notes and folders are ordered by `date: -1` everywhere.
|
||||||
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.
|
### API reference
|
||||||
- **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.
|
`POST /api/user/register` — body `{username,email,name,password}`. First registered user becomes
|
||||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
`admin: true`. (Currently broken: see §9.)
|
||||||
- **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.
|
`GET /api/user/verify-setup?code=` — `{status:'ok',code}` | `{status:'error',msg:'not-exists'}`
|
||||||
|
|
||||||
|
`POST /api/user/setup?code=` — rate limited. Body `{name,username,email,password}` completes an
|
||||||
|
invited account (`setupCode` is cleared).
|
||||||
|
|
||||||
|
`POST /api/user/login` — rate limited. Body `{usermail,password}` (accepts username **or** email) →
|
||||||
|
`{status:'ok', token, msg:'success'}`.
|
||||||
|
|
||||||
|
`POST /api/user/upload-avatar` — multipart field `image`, JWT required → stores filename on `User.image`.
|
||||||
|
Fetch the file from `/api/public/<filename>`.
|
||||||
|
|
||||||
|
`GET /api/user/retrieve-avatar?username=` → `{status:'ok', image}`
|
||||||
|
|
||||||
|
`GET /api/user/has-admin` → `status: 'ok' | 'init' | 'error'`
|
||||||
|
|
||||||
|
`POST /api/user/update-settings` — JWT inline. Body `{ settings: {...} }` (whole object replaced).
|
||||||
|
`GET /api/user/get-settings` — JWT inline → `{status:'ok', settings}`
|
||||||
|
|
||||||
|
`POST /api/campaign/create` — `{name,description,color,settings}` → `{status:'ok',campaign}`
|
||||||
|
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
||||||
|
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
|
||||||
|
|
||||||
|
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
|
||||||
|
folder entries include `parentFolder` so clients can rebuild nested folder paths
|
||||||
|
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
|
||||||
|
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
|
||||||
|
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
||||||
|
`POST /api/note/delete` — `{id}` — **no ownership check** (§9)
|
||||||
|
|
||||||
|
`GET /api/folder/list?campaign=` → `{status:'ok',folders}`
|
||||||
|
`POST /api/folder/create` — `{name*,campaign*}`
|
||||||
|
`POST /api/folder/rename` — `{id*,name*}`
|
||||||
|
`POST /api/folder/update` — `{id*, name?, color?}` — partial, ownership checked
|
||||||
|
`POST /api/folder/delete` — `{id}` — recursive: notes inside are moved to root (`folder: null`),
|
||||||
|
subfolders re-parented to null then deleted.
|
||||||
|
|
||||||
|
`GET /api/test` — health check.
|
||||||
|
|
||||||
|
`GET /api/actor/list?campaign=` → `{status:'ok',actors}`
|
||||||
|
`POST /api/actor/create` — `{name*,campaign*,type?,species?,className?,subclass?,level?,background?,challengeRating?,description?}`
|
||||||
|
`POST /api/actor/update` — `{id*, name?, species?, className?, subclass?, level?, abilityScores?, armorClass?, speed?, proficiencies?, inventory?, traits?, spells?, image?}` — partial, ownership checked
|
||||||
|
`POST /api/actor/upload-image?actor=` — multipart field `image`
|
||||||
|
`POST /api/actor/delete` — `{id}`
|
||||||
|
|
||||||
|
`GET /api/item/list?campaign=` → `{status:'ok',items}`
|
||||||
|
`POST /api/item/create` — `{name*,campaign*,category?,rarity?,quantity?,weight?,properties?,description?}`
|
||||||
|
`POST /api/item/update` — `{id*, name?, category?, rarity?, quantity?, weight?, properties?, description?}` — partial, ownership checked. `''` for `quantity`/`weight` is ignored, like `/item/create`.
|
||||||
|
`POST /api/item/delete` — `{id}`
|
||||||
|
|
||||||
|
`GET /api/map/list?campaign=` → `{status:'ok',maps}`
|
||||||
|
`POST /api/map/create` — multipart (`image`) or JSON `{name*,campaign*,gridSize?,offsetX?,offsetY?,scale?}` → `{status:'ok',map}`
|
||||||
|
`POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as
|
||||||
|
multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too).
|
||||||
|
`POST /api/map/delete` — `{id}`
|
||||||
|
|
||||||
|
### 4.1 Foundry integration (actors, items)
|
||||||
|
|
||||||
|
`dragonroll-foundry/` holds the Foundry VTT module (`scripts/api.js`, loaded by `module.json`) and an
|
||||||
|
optional read-only snapshot bridge (`bridge/server.js`). The module talks to Dragonroll with a
|
||||||
|
per-campaign bearer token, **not** a Dragonroll login: `POST /api/foundry/link/complete` redeems a
|
||||||
|
pairing code, stores its hash on `Campaign.foundrySyncTokenHash` and hands the plain token to Foundry
|
||||||
|
once. Every sync route re-reads the campaign from that hash and rejects payloads whose `worldId` is
|
||||||
|
not `Campaign.foundryWorldId` (`syncCampaign` / `requestMatchesWorld`). CORS is opened for
|
||||||
|
`/api/foundry/sync*` and `/foundry/link/complete` in `src/index.js`, before the app-wide CORS.
|
||||||
|
`dragonroll-foundry/README.md` documents pairing, the bridge and its environment variables.
|
||||||
|
|
||||||
|
| Sync route (token) | Meaning |
|
||||||
|
|---|---|
|
||||||
|
| `POST /sync/snapshot` | `{worldId, actors[], items[], fullSync}` — upserts actors, world items and every item embedded in those actors; a `fullSync` also deletes actors/items that are gone |
|
||||||
|
| `POST /sync/item-snapshot` | `{worldId, items[]}` — live world-item edits, upsert only (never prunes) |
|
||||||
|
| `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted |
|
||||||
|
| `GET /sync/characters` | Actors the module applies back into Foundry |
|
||||||
|
| `GET /sync/items` | Items the module applies back into Foundry (creates world items for Dragonroll-authored ones) |
|
||||||
|
| `POST /sync/map` / `POST /sync/map-item` | Store the id mapping after the module creates a document |
|
||||||
|
| `POST /sync/delete` | `{worldId, foundryActorId}` |
|
||||||
|
|
||||||
|
Rules worth knowing before editing this:
|
||||||
|
|
||||||
|
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index so local
|
||||||
|
documents can leave it unset). A document carrying the `dragonroll-foundry.actorId` /
|
||||||
|
`dragonroll-foundry.itemId` flag adopts the matching Dragonroll row.
|
||||||
|
- **Items are deduplicated by name.** Foundry keeps the same gear once per carrier, so one Dragonroll
|
||||||
|
`Item` per name: the first document to claim it keeps the mapping, later copies just return it.
|
||||||
|
`foundryNames` remembers Foundry's names so a Dragonroll rename does not resurrect a duplicate.
|
||||||
|
`services/item-foundry.js` returns `null` for non-gear types (spells, classes, feats, species…),
|
||||||
|
which the sync skips.
|
||||||
|
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events
|
||||||
|
overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies.
|
||||||
|
- `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`.
|
||||||
|
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only
|
||||||
|
bridge, only useful when `FOUNDRY_API_URL` is configured.
|
||||||
|
|
||||||
## 5. Frontend
|
## 5. Frontend
|
||||||
|
|
||||||
### 5.1 Two pages: the app and the documentation
|
```
|
||||||
|
frontend/
|
||||||
|
├── nuxt.config.ts css order (colors, fonts, main, callouts), runtimeConfig.public
|
||||||
|
│ {apiBaseUrl, gitCommit, gitTag, gitBranch, buildDate}, @nuxtjs/i18n module,
|
||||||
|
│ vite.optimizeDeps; git info harvested at build time via execSync
|
||||||
|
├── 18n.config.ts vue-i18n fallbackLocale 'en'
|
||||||
|
├── i18n/locales/ en/ es/ ca/ (+ empty en.json, es.json, ca.json for the nuxt module)
|
||||||
|
├── public/ img/ icons/{iconoir/{regular,solid},Pixelarticons,ui} sounds/ fonts/{5e,amiri,...}
|
||||||
|
│ → served at /img, /icons, /sounds, /fonts
|
||||||
|
└── app/ Nuxt 4 source root (`~/` and `@/` both alias here)
|
||||||
|
├── app.vue real entry: theme setup + start() boot logic + 5 managers
|
||||||
|
├── assets/css/ colors.scss (theme maps → CSS vars), fonts.scss (5e-style font families),
|
||||||
|
│ main.scss (globals, scrollbars, .icon), callouts.scss (Obsidian-like callouts)
|
||||||
|
├── components/
|
||||||
|
│ ├── managers/ WindowManager, ContentManager, ToastManager, TooltipManager, ContextMenuManager
|
||||||
|
│ ├── windows/ ExampleWindow (template to copy), Login, Register, MainMenu, Settings,
|
||||||
|
│ │ CreateCampaign, RenameNote, NewFolder + partials/{WindowHandle,
|
||||||
|
│ │ FixedBottomButtons, BigIconTemplate}
|
||||||
|
│ ├── partials/ ContentSidebar, NestedNoteList, CampaignEntry, EditUserPartial, Spinner,
|
||||||
|
│ │ VersionRender
|
||||||
|
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
|
||||||
|
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
|
||||||
|
│ content/{Content,NoteContainer,Note}, widgets/{TableWidget,TestWidget,
|
||||||
|
│ inline/RollWidgetInline,display/RollWidgetDisplay}
|
||||||
|
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
|
||||||
|
│ useEmitter.ts (BROKEN, see §9)
|
||||||
|
├── plugins/ api.ts (inject runtimeConfig apiBaseUrl into the axios instance), i18n.ts
|
||||||
|
└── services/ plain ES modules holding reactive module state (the app has no store)
|
||||||
|
```
|
||||||
|
|
||||||
`app/pages/` routes the only two things the frontend is. `index.vue` and the `[...all].vue` catch-all
|
### 5.1 It is not a routed app
|
||||||
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
|
There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Screens" are either:
|
||||||
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
|
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
|
||||||
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
|
||||||
`Campaign` becomes non-null. The note column shows the open notes, or the anchored map
|
shown when `Campaign` state is non-null.
|
||||||
(`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
|
Boot sequence (`app.vue` → `start()`):
|
||||||
|
|
||||||
`services/WindowDefinitions.js` is the registry (`{ title: 'i18n.key', component: () => import(...), movable, close?, back? }`)
|
```
|
||||||
and `services/Windows.js` the runtime: `CreateWindow(type, data)` (one instance per type),
|
GetUser() (JWT in localStorage, un-expired)?
|
||||||
`CreateChildWindow(parentId, ...)`, `ClearWindow({type}|{id})`, `GetWindowWithId`, `GetFirstWindowId`,
|
├─ yes → RestoreCampaign() (localStorage.selectedCampaignId) → on failure open 'main_menu'
|
||||||
`CallWindow(id, fn, arg)`, `SetSize/SetPosition/ResetPosition(id,'center')/SetMinSize/SetMaxSize/Top`,
|
└─ no → HasAdmin() ? open 'login' : open 'register' {firstTime:true}
|
||||||
`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}`,
|
### 5.2 The window system (most important thing to understand)
|
||||||
`window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
|
||||||
|
|
||||||
### 5.3 Services are the state layer
|
`app/services/WindowDefinitions.js` is the **registry**: key = window type, value =
|
||||||
|
`{ title: 'i18n.key', component: () => import('~/components/windows/X.vue'), movable, close?, back?, ... }`.
|
||||||
|
Adding a window = add an entry here **and** a component in `app/components/windows/`.
|
||||||
|
|
||||||
`app/services/` are plain ES modules with module-scope `ref()`s — no DI, no store, singleton by import.
|
`app/services/Windows.js` is the runtime. Module-level state: `windows = ref([])`, auto-incrementing
|
||||||
`Server.js` (axios factory: `Server().get(...)`, interceptor adds `Authorization: Bearer <localStorage.token>`,
|
`currentId`, `currentIndex` z-index counter. Key exports:
|
||||||
`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
|
`CreateWindow(type, data)` (one instance per type — duplicates are ignored),
|
||||||
|
`CreateChildWindow(parentId, type, data)` (child dies with parent), `ClearWindow({type}|{id})`
|
||||||
|
(recursive over `children`), `ClearAll()`, `GetWindowWithId(id)`, `GetFirstWindowId(type)`,
|
||||||
|
`CallWindow(id, callableName, arg)`, `SetSize/SetPosition/SetMinSize/SetMaxSize/SetResizable/
|
||||||
|
SetMovable/ResetPosition(id,'center')/SetOnTop/Top`, `getComponent(type)` (cached `defineAsyncComponent`),
|
||||||
|
and `SetupHandle(id, handleRef)` which wires raw DOM mouse listeners for drag/resize.
|
||||||
|
|
||||||
`Marker.js` turns `@name\n…\n@end` (block), `@name[text]` (inline) and `[[target]]` (wiki link) into
|
Contract a window component must fulfil (copy `ExampleWindow.vue`):
|
||||||
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
|
```vue
|
||||||
|
<script setup>
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
const handle = ref(null), wrapper = ref(null);
|
||||||
|
const props = defineProps(['data']); // 'data' = merged {type,id,...WindowDefinitions entry,...CreateWindow data}
|
||||||
|
const id = props.data.id;
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper); SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 500, height: 380 }); ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
<!-- body -->
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
Events in use: `toast`, `push-note`, `close-note` (removes from the open column only), `delete-note`
|
DOM id conventions that `Windows.js`, `WindowHandle.vue` and drag/resize depend on — do not rename:
|
||||||
(closes **and** removes from the sidebar, and drops map pins — the note's close button must not use it),
|
`window-wrapper-{id}`, `window-handle-{id}`, `window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
||||||
`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
|
`WindowHandle.vue` reads `title` (translated at mount via `$t`), `close` and `back` off the window
|
||||||
|
object, exposes `setupHandle()`, and plays `/sounds/close.wav` when closed.
|
||||||
|
|
||||||
`colors.scss` Sass maps (`dark`/`light`, accents `katlum`/`solus`/`silang`) become `--color-*` CSS
|
### 5.3 Services (`app/services/`) — the state layer
|
||||||
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`
|
Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Singleton by import.
|
||||||
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`,
|
| Service | Provides |
|
||||||
`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 /
|
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
|
||||||
next — is translated.)
|
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
|
||||||
|
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
|
||||||
|
| `Content.js` | `ShowContent` ref (drives the campaign workspace). `SetShowContent` is exported but unused — `ContentManager.vue` sets it from a `watch(Campaign)` and never turns it back off |
|
||||||
|
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
|
||||||
|
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
|
||||||
|
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
|
||||||
|
| `ContextMenu.js` | `SetupContextMenu()`, `AddContextMenu(el, items, {dropdown:true})`, `ShowContextMenu(items)`, `HideContextMenu()`. Items: `{name, icon?, action?, divider?}` or `{name, context:[...]}` for a submenu; built imperatively into `#context-menu` with `motion` animations |
|
||||||
|
| `Sound.js` | `AddSound(rootEl)` binds `/sounds/snap.wav` to every `.sound-click` inside `rootEl` |
|
||||||
|
| `Marker.js` | marked `Marked` instance + custom extensions, `ParseMarkdown(src)`, `GetWidget(kind,name)` (§5.4) |
|
||||||
|
| `ActionRegistry.js` | `register({id,label,description,execute,isActive?})`, `unregister`, `search(q)` (diacritic-insensitive, prefix-first sort), `execute(id,params)` — powers the command palette |
|
||||||
|
| `Windows.js` / `WindowDefinitions.js` | §5.2 |
|
||||||
|
| `widgets/DiceParser.js` | recursive-descent dice evaluator (§5.5) |
|
||||||
|
|
||||||
|
### 5.4 Markdown → Vue widgets
|
||||||
|
|
||||||
|
`Marker.js` registers three marked extensions:
|
||||||
|
|
||||||
|
| Syntax | Level | Output |
|
||||||
|
|---|---|---|
|
||||||
|
| `@name\n<content>\n@end` | block | `<div class="vue-component-display" data-component data-content>` |
|
||||||
|
| `@name[text]` | inline | `<span class="vue-component-inline" data-component data-content>` |
|
||||||
|
| `[[target]]` | inline | `<span class="vue-link" data-href>` (renders the literal text `Link`) |
|
||||||
|
|
||||||
|
`Note.vue` renders the HTML with `v-html`, then in a `setTimeout(...,0)` calls `mountComponents()`,
|
||||||
|
which `querySelectorAll('.vue-component-display'|'.vue-component-inline')` and mounts each node with a
|
||||||
|
**separate** `createApp(GetWidget(kind, el.dataset.component), { content: el.dataset.content })`.
|
||||||
|
Widgets are therefore isolated mini-apps: they receive only `content` (a string) and must not rely on
|
||||||
|
the parent app's provides/injection.
|
||||||
|
|
||||||
|
Registering a widget = add an entry to `widget_map` in `Marker.js`:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const widget_map = {
|
||||||
|
inline: { roll: () => import("~/components/viewer/widgets/inline/RollWidgetInline.vue") },
|
||||||
|
display: { roll: () => import("~/components/viewer/widgets/display/RollWidgetDisplay.vue") },
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
`Note.vue` also: handles `Ctrl/Cmd+E` (toggle edit/preview, saves on exit) and `Ctrl/Cmd+S` (save via
|
||||||
|
`POST /note/update`), tracks dirty state (white dot in the vertical title strip), and wires
|
||||||
|
Obsidian-style collapsible callouts (`setupCallout()`/`toggleCallout()` + `callouts.scss`).
|
||||||
|
|
||||||
|
### 5.5 Dice grammar (`DiceParser.js`)
|
||||||
|
|
||||||
|
`parse(expr) -> { total, steps[] }`. Tokens: `\d*d\d+` with optional `adv|dis|kh<N>|kl<N>`, integers,
|
||||||
|
`+ - * / ( )`, unary minus. `adv`/`dis` roll 2dN and keep max/min; `kh`/`kl` keep highest/lowest N.
|
||||||
|
Division is `Math.floor`. Guards: count 1–1000, sides 2–10000. `steps` are `{type:'op'|'const'|'dice'}`
|
||||||
|
and `RollWidgetDisplay.vue` turns them into the visual breakdown (kept/dropped/max/min classes).
|
||||||
|
|
||||||
|
### 5.6 Event bus contract
|
||||||
|
|
||||||
|
Every listener in the app (there are only these six `emitter.on` call sites):
|
||||||
|
|
||||||
|
| Event | Payload | Listened by |
|
||||||
|
|---|---|---|
|
||||||
|
| `toast` | `{color,text,duration}` | `ToastManager.vue` |
|
||||||
|
| `push-note` | `{key,title,text,date}` | `NoteContainer.vue` |
|
||||||
|
| `close-note` | note key (string) | `NoteContainer.vue` (removes the note from the open column only) |
|
||||||
|
| `delete-note` | note key (string) | `NoteContainer.vue`, `ContentSidebar.vue`, `NestedNoteList.vue` (real deletion: closes the note **and** removes it from the sidebar) |
|
||||||
|
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue` |
|
||||||
|
| `status-bar-update` | `{text,icon}` | `FetchStatus.vue` |
|
||||||
|
|
||||||
|
Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue`
|
||||||
|
(`close-note` — the close button must not use `delete-note` or the sidebar entry disappears),
|
||||||
|
`NestedNoteList.vue` (`delete-note`, after `POST /note/delete`), `ContentSidebar` (`title-updated`),
|
||||||
|
`FetchStatus` (self-test emit).
|
||||||
|
|
||||||
|
**Orphan events** — emitted, never subscribed to anywhere (the matching handlers `handleNoteCreated` /
|
||||||
|
`handleNoteRenamed` exist in `ContentSidebar.vue` but were never wired with `emitter.on`; see §9.17):
|
||||||
|
|
||||||
|
| Event | Emitted by | Intended handler |
|
||||||
|
|---|---|---|
|
||||||
|
| `note-created` | `ContentSidebar.createNote`, `TopSearchBar` | `ContentSidebar.handleNoteCreated` (dead) |
|
||||||
|
| `note-renamed` | `RenameNoteWindow.vue` | `ContentSidebar.handleNoteRenamed` (dead) |
|
||||||
|
| `folder-saved` | `NewFolderWindow.vue` | none — sidebar refreshes only via `@reload-notes` from `NestedNoteList` |
|
||||||
|
|
||||||
|
So "create note" currently works because the sidebar mutates its own list, and folder changes need an
|
||||||
|
explicit `fetchCampaignNotes()`. If you rely on an event, check a listener exists.
|
||||||
|
|
||||||
|
Note object shape in the UI layer is `{ key, title, text, date }` (mapped from the API's
|
||||||
|
`{_id,title,content,date}`); convert at the boundary as `ContentSidebar.fetchCampaignNotes` does.
|
||||||
|
|
||||||
|
### 5.7 Theming, fonts, icons, sounds
|
||||||
|
|
||||||
|
- `useTheme.ts` owns `theme` (`'light'|'dark'`) and `accent` (`'katlum'`, type currently narrow) as
|
||||||
|
module singletons, persists to `localStorage`, and sets `data-theme` / `data-accent` on `<html>`.
|
||||||
|
`app.vue` calls `setupTheme()` then forces `setTheme('dark')` on mount.
|
||||||
|
- `colors.scss` holds Sass maps `dark`/`light` (and accents `katlum`/`solus`/`silang`) emitted as
|
||||||
|
**`--color-*` CSS variables**. Always style with `var(--color-...)` (`background`,
|
||||||
|
`window-background`, `button-hover`, `text`, `border`, `icon-invert`, …), never hardcode hex.
|
||||||
|
- Icons are inverted via `filter: invert(var(--color-icon-invert))` — white SVGs + `.icon` class.
|
||||||
|
Reference either as public assets (`/icons/iconoir/regular/xmark.svg`, `/icons/ui/...`,
|
||||||
|
`/icons/Pixelarticons/white/close.svg`) or from the `pixelarticons` npm package
|
||||||
|
(`import SearchIcon from 'pixelarticons/svg/search.svg'`).
|
||||||
|
- Fonts (`fonts.scss` + `public/fonts/5e`): `BookInsanityRemake` (body default), `MrEavesRemake`
|
||||||
|
(headings/window titles), `ScalySansRemake`, `NodestoCapsCondensed`, `SolberaImitationRemake`, etc.
|
||||||
|
- Sounds in `public/sounds/`: `snap.wav` (the `.sound-click` default), `close.wav`, `click.wav`,
|
||||||
|
`dice.wav`, `roll1.wav`, `roll2.wav`, `notify.wav`, `drums.wav`, `lock.wav`, `doors/`.
|
||||||
|
|
||||||
|
### 5.8 i18n
|
||||||
|
|
||||||
|
Locales: `en` (default), `es`, `ca`. Files live at `frontend/i18n/locales/<lang>/<namespace>.json`, and
|
||||||
|
`app/plugins/i18n.ts` globs them and nests each under its **filename** — so the key is
|
||||||
|
`<file>.<path>`, e.g. `i18n/locales/en/main-menu.json` → `$t('main-menu.create-campaign')`.
|
||||||
|
Namespaces in use: `general`, `login`, `register`, `main-menu`, `settings`, `windows`, `campaigns`
|
||||||
|
(`campaigns` currently only exists for `en`). Call it as `$t(...)` in templates or via `useI18n()` in
|
||||||
|
script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `WindowHandle` translates them.
|
||||||
|
|
||||||
|
**Adding a string = add it to all three locales** (`en`, `es`, `ca`); the Nuxt i18n module is also
|
||||||
|
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
|
||||||
|
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
|
||||||
|
|
||||||
|
### 5.9 Obsidian plugin
|
||||||
|
|
||||||
|
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
|
||||||
|
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
|
||||||
|
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
|
||||||
|
The user selects a campaign from `GET /api/campaign/list`.
|
||||||
|
|
||||||
|
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
|
||||||
|
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
|
||||||
|
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
|
||||||
|
frontmatter.
|
||||||
|
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
|
||||||
|
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
|
||||||
|
imports preserve modified local files, and push is explicit.
|
||||||
|
|
||||||
|
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
|
||||||
|
|
||||||
## 6. Conventions
|
## 6. Conventions
|
||||||
|
|
||||||
- Backend: CommonJS; every handler `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
||||||
- 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.
|
are thin Express routers, `models/` one Mongoose schema per file exporting `mongoose.model(...)`.
|
||||||
- Components call `Server()` directly (no api layer); `await` and `.then` both appear.
|
Every handler is `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
||||||
- Comments mix English and Catalan ("Moure aixo") — do not translate unrelated comments while editing.
|
Route logic helpers (like `userOwnsCampaign`) are duplicated per router file today — match that
|
||||||
- No formatter: keep diffs minimal and local, the codebase is deliberately rough.
|
style unless you refactor both at once.
|
||||||
|
- **Frontend**: Vue 3 `<script setup>`; PascalCase exported functions in `services/` (`CreateWindow`,
|
||||||
|
`GetUser`), camelCase locals; PascalCase component filenames; `kebab-case` DOM ids that services
|
||||||
|
depend on. Both `~/` and `@/` aliases appear in imports (both resolve to `app/`) — follow whatever
|
||||||
|
the neighbouring file uses.
|
||||||
|
- Components talk to the API through `Server()` directly (there is no api-layer abstraction); `await`
|
||||||
|
or `.then` both appear.
|
||||||
|
- Code comments are mixed English and Catalan ("Moure aixo", "Programar un resizer mitjanament
|
||||||
|
competent") — do not "translate" unrelated comments while editing.
|
||||||
|
- No formatter: keep diffs minimal and local; the codebase is deliberately rough.
|
||||||
|
|
||||||
## 7. Recipes
|
## 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 API resource**: add `models/X.js`, `routes/x.js` (with `userOwnsCampaign`-style ownership checks
|
||||||
- **New window**: `WindowDefinitions.js` entry + `components/windows/X.vue` (§5.2) + strings in `i18n/locales/*/windows.json` (all three locales).
|
and the `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js`
|
||||||
- **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
|
**after** the `checkAuth` line if it needs auth.
|
||||||
- **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)
|
**New window**: entry in `WindowDefinitions.js` → component in `app/components/windows/` following
|
||||||
|
§5.2 → open with `CreateWindow('type', data)` or `CreateChildWindow(parentId, 'type', data)` → strings
|
||||||
|
in `i18n/locales/*/windows.json`.
|
||||||
|
|
||||||
1. `README.md` says run `./install.sh` / `./start.sh`; **neither exists**. `frontend/README.md` says the frontend is **React**; it is Nuxt/Vue.
|
**New markdown widget**: component in `app/components/viewer/widgets/{inline|display}/`, register in
|
||||||
2. `services/keys.js` ships the JWT secret `"putyoursecrethere"`, used in production.
|
`widget_map` in `Marker.js`, consume the `content` prop.
|
||||||
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
|
**New command-palette action**: `register({id,label,description,execute,isActive?})` from
|
||||||
|
`~/services/ActionRegistry` (see `registerCreateNoteAction` in `TopSearchBar.vue`); palette opens with
|
||||||
|
`Ctrl/Cmd+K` or `/`.
|
||||||
|
|
||||||
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` in compose,
|
**New theme color**: add the key to *both* `dark` and `light` maps in `colors.scss`, use
|
||||||
proxying `/` → frontend, `/api/` → backend.
|
`var(--color-<key>)`.
|
||||||
|
|
||||||
|
## 8. Port map
|
||||||
|
|
||||||
|
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` inside
|
||||||
|
compose, proxying `/` → `frontend:3000`, `/api/` → `backend:5000`.
|
||||||
|
|
||||||
|
## 9. Known landmines (verified in code — do not "fix" silently, but never make them worse)
|
||||||
|
|
||||||
|
1. `README.md` tells you to run `./install.sh` and `./start.sh`; **neither script exists** in the repo.
|
||||||
|
2. `frontend/README.md` says the frontend is **React**. It is Nuxt/Vue 3.
|
||||||
|
3. `services/keys.js` ships a hardcoded JWT secret `"putyoursecrethere"`, used in prod.
|
||||||
|
4. `src/index.js` sets CORS `origin: 'http://localhost:3000'` only — the production origin
|
||||||
|
(`https://dragonroll.aranroig.com`) is not whitelisted; in production the nginx same-origin proxy
|
||||||
|
is what hides this.
|
||||||
|
5. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not defined
|
||||||
|
in that scope → ReferenceError → caught → the first-run registration actually returns
|
||||||
|
`errors.internal`. Fix carefully: the register UI (`RegisterWindow.vue`) drives the first-admin flow.
|
||||||
|
6. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id).
|
||||||
|
`folder.js` and the other `note.js` handlers do check.
|
||||||
|
7. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()`, but **no plugin provides it** —
|
||||||
|
always import `{ emitter }` from `~/services/Emitter` instead.
|
||||||
|
8. `ecosystem.config.js` runs `npm start` in both apps; neither package defines a `start` script → PM2
|
||||||
|
would fail. Compose/nginx is the real deployment path.
|
||||||
|
9. `/api/user/*` is entirely mounted before the JWT guard (see §4); new user routes are public unless
|
||||||
|
they call `passport.authenticate('jwt', {session:false})` inline.
|
||||||
|
10. `checkAuth` in `src/index.js` is assigned without `const` (implicit global).
|
||||||
|
11. `ClearAll()` in `Windows.js` iterates `Object.keys(windows)` (the ref object, not `.value`) — it
|
||||||
|
does not behave like the name suggests.
|
||||||
|
12. `GetWidget`/`getComponent` caches are process-global and never invalidated; new widget/window types
|
||||||
|
need a dev-server restart if HMR misbehaves.
|
||||||
|
13. `Windows.js` `SetupHandle` attaches `mousemove`/`mouseup` listeners on `document` for **every**
|
||||||
|
window and never removes them; they early-return on `win.movable` but still accumulate.
|
||||||
|
14. `Note.vue` mounts widgets with `createApp` and never unmounts them — leaked apps remain when note
|
||||||
|
content is re-rendered.
|
||||||
|
15. `User.js` (frontend) treats the JWT as the user cache: `settings` changes require
|
||||||
|
`SetUserSetting`/`GetUserSetting` round-trips, the token payload goes stale.
|
||||||
|
16. `.env.production` files (both apps) are committed and contain internal hosts.
|
||||||
|
17. `note-created`, `note-renamed` and `folder-saved` are emitted with **no subscribers**; the sidebar's
|
||||||
|
`handleNoteCreated` / `handleNoteRenamed` are unwired dead code (§5.6). The sidebar refreshes its
|
||||||
|
tree only on `campaignId` change, on mount, on the manual refresh button, or on `@reload-notes`
|
||||||
|
from `NestedNoteList.vue`.
|
||||||
|
18. `SetShowContent` (`services/Content.js`) and `services/middleware.js`'s `isAdmin` are exported /
|
||||||
|
imported but never used; `ContentManager.vue` never hides the workspace again once shown.
|
||||||
|
|||||||
@@ -1,29 +1,23 @@
|
|||||||
# 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 the workspace manifests first (better caching)
|
# Copy package files first (better caching)
|
||||||
COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
|
COPY 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 backend package
|
# Install dependencies
|
||||||
RUN pnpm install --frozen-lockfile --prod --filter ./backend...
|
RUN npm ci --only=production
|
||||||
|
|
||||||
# Copy application source
|
# Copy application source
|
||||||
COPY backend ./backend
|
COPY . .
|
||||||
|
|
||||||
|
# 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
Normal file
1770
backend/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -40,40 +40,32 @@ require('./services/passport')(passport);
|
|||||||
// CORS
|
// CORS
|
||||||
app.use(cookieParser());
|
app.use(cookieParser());
|
||||||
|
|
||||||
// Services talk to Dragonroll from their own application (a Foundry world, an
|
const foundryCorsPaths = [
|
||||||
// Obsidian vault, the Discord bot), so their link routes cannot be limited to
|
'/api/foundry/link/complete', '/foundry/link/complete',
|
||||||
// one origin. What they may do is decided by the link code each of them holds.
|
|
||||||
const openCorsPaths = [
|
|
||||||
'/api/foundry/sync', '/foundry/sync',
|
'/api/foundry/sync', '/foundry/sync',
|
||||||
'/api/link/start', '/link/start',
|
|
||||||
'/api/link/pickup', '/link/pickup',
|
|
||||||
];
|
];
|
||||||
const openCors = cors({
|
const foundryCors = cors({
|
||||||
origin: true,
|
origin: true,
|
||||||
methods: ['GET', 'POST', 'OPTIONS'],
|
methods: ['GET', 'POST', 'OPTIONS'],
|
||||||
allowedHeaders: ['Authorization', 'Content-Type', 'X-Dragonroll-Discord-Bot-Secret'],
|
allowedHeaders: ['Authorization', 'Content-Type'],
|
||||||
});
|
});
|
||||||
for (const path of openCorsPaths) {
|
app.use('/api/foundry/link/complete', foundryCors);
|
||||||
app.use(path, openCors);
|
app.use('/foundry/link/complete', foundryCors);
|
||||||
}
|
app.use('/api/foundry/sync', foundryCors);
|
||||||
|
app.use('/foundry/sync', foundryCors);
|
||||||
|
|
||||||
const appCors = cors({
|
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) => {
|
app.use((req, res, next) => {
|
||||||
if (openCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next();
|
if (foundryCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next();
|
||||||
appCors(req, res, 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'));
|
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('/api/foundry', require('./routes/foundry-link'));
|
||||||
app.use('/foundry', require('./routes/foundry-link'));
|
app.use('/foundry', require('./routes/foundry-link'));
|
||||||
|
|
||||||
|
|||||||
@@ -22,69 +22,11 @@ const ActorSchema = new Schema({
|
|||||||
},
|
},
|
||||||
armorClass: { type: Number, min: 0, default: 10 },
|
armorClass: { type: Number, min: 0, default: 10 },
|
||||||
speed: { type: Number, min: 0, default: 30 },
|
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: '' },
|
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: [{
|
inventory: [{
|
||||||
name: { type: String, trim: true, default: '' },
|
name: { type: String, trim: true, default: '' },
|
||||||
quantity: { type: Number, min: 1, default: 1 },
|
quantity: { type: Number, min: 1, default: 1 },
|
||||||
weight: { type: Number, min: 0, default: 0 },
|
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: '' },
|
traits: { type: String, default: '' },
|
||||||
spells: { type: String, default: '' },
|
spells: { type: String, default: '' },
|
||||||
@@ -93,18 +35,7 @@ const ActorSchema = new Schema({
|
|||||||
ref: 'Campaign',
|
ref: 'Campaign',
|
||||||
required: true
|
required: true
|
||||||
},
|
},
|
||||||
// The folder this actor stands in: a Folder of the same campaign whose target is
|
|
||||||
// 'actor' (null = the root of the actor list).
|
|
||||||
folder: {
|
|
||||||
type: Schema.Types.ObjectId,
|
|
||||||
ref: 'Folder',
|
|
||||||
default: null
|
|
||||||
},
|
|
||||||
foundryActorId: { type: String },
|
foundryActorId: { type: String },
|
||||||
// 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 }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -113,10 +44,4 @@ ActorSchema.index(
|
|||||||
{ unique: true, partialFilterExpression: { foundryActorId: { $type: 'string' } } }
|
{ 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);
|
module.exports = mongoose.model('Actor', ActorSchema);
|
||||||
|
|||||||
20
backend/src/models/DiscordLinkRequest.js
Normal file
20
backend/src/models/DiscordLinkRequest.js
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const DiscordLinkRequestSchema = new Schema({
|
||||||
|
codeHash: { type: String, required: true, unique: true },
|
||||||
|
guildId: { type: String, required: true },
|
||||||
|
guildName: { type: String, required: true },
|
||||||
|
discordUserId: { type: String, required: true },
|
||||||
|
discordUserName: { type: String, required: true },
|
||||||
|
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User' },
|
||||||
|
createdAt: { type: Date, default: Date.now },
|
||||||
|
expiresAt: { type: Date, required: true },
|
||||||
|
completedAt: { type: Date },
|
||||||
|
// Quan el bot ja ha confirmat a Discord que aquesta autoritzacio s'ha fet.
|
||||||
|
notifiedAt: { type: Date }
|
||||||
|
});
|
||||||
|
|
||||||
|
DiscordLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
|
||||||
|
|
||||||
|
module.exports = mongoose.model('DiscordLinkRequest', DiscordLinkRequestSchema);
|
||||||
@@ -1,12 +1,6 @@
|
|||||||
const mongoose = require('mongoose');
|
const mongoose = require('mongoose');
|
||||||
const Schema = mongoose.Schema;
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
// Which campaign list a folder belongs to. Every sidebar section files its rows into
|
|
||||||
// folders of its own, and all of them share this model: note folders are what it has
|
|
||||||
// always held, and their rows carry no target at all, so anything reading the note tree
|
|
||||||
// asks with `filterForTarget('note')` and keeps finding them.
|
|
||||||
const FOLDER_TARGETS = ['note', 'actor', 'item', 'map'];
|
|
||||||
|
|
||||||
const FolderSchema = new Schema({
|
const FolderSchema = new Schema({
|
||||||
name: { type: String, required: true },
|
name: { type: String, required: true },
|
||||||
campaign: {
|
campaign: {
|
||||||
@@ -18,46 +12,8 @@ const FolderSchema = new Schema({
|
|||||||
type: Schema.Types.ObjectId,
|
type: Schema.Types.ObjectId,
|
||||||
ref: 'Folder'
|
ref: 'Folder'
|
||||||
},
|
},
|
||||||
target: { type: String, enum: FOLDER_TARGETS, default: 'note' },
|
|
||||||
// The Foundry item folder this row mirrors, set by the item sync only
|
|
||||||
// (see routes/foundry-link.js).
|
|
||||||
foundryFolderId: { type: String },
|
|
||||||
color: { type: String },
|
color: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
FolderSchema.index(
|
|
||||||
{ campaign: 1, foundryFolderId: 1 },
|
|
||||||
{ unique: true, partialFilterExpression: { foundryFolderId: { $type: 'string' } } }
|
|
||||||
);
|
|
||||||
|
|
||||||
// The sections a folder can file rows of, and whether a request names one of them.
|
|
||||||
FolderSchema.statics.isTarget = function isTarget(target) {
|
|
||||||
return FOLDER_TARGETS.includes(target);
|
|
||||||
};
|
|
||||||
|
|
||||||
// The filter matching one section's folders, to spread into a `find` along with whatever
|
|
||||||
// else the listing asks for. The notes ask for "none of the other sections" because the
|
|
||||||
// rows saved before `target` existed carry none at all and are all note folders.
|
|
||||||
FolderSchema.statics.filterForTarget = function filterForTarget(target) {
|
|
||||||
if (target === 'note') {
|
|
||||||
return { target: { $nin: FOLDER_TARGETS.filter((other) => other !== 'note') } };
|
|
||||||
}
|
|
||||||
return { target };
|
|
||||||
};
|
|
||||||
|
|
||||||
// The folder an entry of a section may stand in: `null` is the root of that list, and
|
|
||||||
// anything else has to be a folder of the same campaign *and* the same section, so a
|
|
||||||
// move never files an entry where its own list would not show it again. Answers whether
|
|
||||||
// it does — an id that is none of those says `false` rather than throwing.
|
|
||||||
FolderSchema.statics.belongsToSection = async function belongsToSection(folderId, campaignId, target) {
|
|
||||||
if (folderId === null || folderId === undefined || folderId === '') return true;
|
|
||||||
if (!mongoose.isValidObjectId(folderId)) return false;
|
|
||||||
|
|
||||||
const folder = await this
|
|
||||||
.findOne({ _id: folderId, campaign: campaignId, ...this.filterForTarget(target) })
|
|
||||||
.lean();
|
|
||||||
return Boolean(folder);
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports = mongoose.model('Folder', FolderSchema);
|
module.exports = mongoose.model('Folder', FolderSchema);
|
||||||
|
|||||||
24
backend/src/models/FoundryLinkRequest.js
Normal file
24
backend/src/models/FoundryLinkRequest.js
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
const mongoose = require('mongoose');
|
||||||
|
const Schema = mongoose.Schema;
|
||||||
|
|
||||||
|
const FoundryLinkRequestSchema = new Schema({
|
||||||
|
codeHash: { type: String, required: true, unique: true },
|
||||||
|
// Kept in clear text so the campaign settings screen can re-display a pending
|
||||||
|
// pairing code after a reload or a backend restart. It is only ever returned
|
||||||
|
// to the user who created the request and is cleared once the link completes.
|
||||||
|
code: { type: String },
|
||||||
|
source: { type: String, enum: ['dragonroll'], required: true },
|
||||||
|
campaign: { type: Schema.Types.ObjectId, ref: 'Campaign' },
|
||||||
|
createdBy: { type: Schema.Types.ObjectId, ref: 'User' },
|
||||||
|
worldId: { type: String },
|
||||||
|
worldTitle: { type: String },
|
||||||
|
system: { type: String },
|
||||||
|
foundryUrl: { type: String },
|
||||||
|
createdAt: { type: Date, default: Date.now },
|
||||||
|
expiresAt: { type: Date, required: true },
|
||||||
|
completedAt: { type: Date }
|
||||||
|
});
|
||||||
|
|
||||||
|
FoundryLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
|
||||||
|
|
||||||
|
module.exports = mongoose.model('FoundryLinkRequest', FoundryLinkRequestSchema);
|
||||||
@@ -17,24 +17,11 @@ const ItemSchema = new Schema({
|
|||||||
weight: { type: Number, min: 0 },
|
weight: { type: Number, min: 0 },
|
||||||
properties: { type: String, default: '' },
|
properties: { type: String, default: '' },
|
||||||
description: { type: String, default: '' },
|
description: { type: String, default: '' },
|
||||||
// Item icon: an uploaded filename served from /api/public, or a full URL
|
|
||||||
// (Foundry sends its own icon as one).
|
|
||||||
image: { type: String, default: '' },
|
|
||||||
// The icon Foundry last sent for this item, kept even after the user picks
|
|
||||||
// their own so Dragonroll can still offer Foundry's back.
|
|
||||||
foundryImage: { type: String, default: '' },
|
|
||||||
campaign: {
|
campaign: {
|
||||||
type: Schema.Types.ObjectId,
|
type: Schema.Types.ObjectId,
|
||||||
ref: 'Campaign',
|
ref: 'Campaign',
|
||||||
required: true
|
required: true
|
||||||
},
|
},
|
||||||
// The folder this item stands in: a Folder of the same campaign whose target is
|
|
||||||
// 'item' (null = the root of the item list).
|
|
||||||
folder: {
|
|
||||||
type: Schema.Types.ObjectId,
|
|
||||||
ref: 'Folder',
|
|
||||||
default: null
|
|
||||||
},
|
|
||||||
foundryItemId: { type: String },
|
foundryItemId: { type: String },
|
||||||
// Names Foundry uses for this item. Dragonroll may rename it, and the copies
|
// Names Foundry uses for this item. Dragonroll may rename it, and the copies
|
||||||
// Foundry keeps sending still have to fold into this row instead of
|
// Foundry keeps sending still have to fold into this row instead of
|
||||||
|
|||||||
@@ -12,62 +12,11 @@ const MapSchema = new Schema({
|
|||||||
offsetY: { type: Number, default: 0 },
|
offsetY: { type: Number, default: 0 },
|
||||||
// Distance each grid cell stands for (feet, metres...)
|
// Distance each grid cell stands for (feet, metres...)
|
||||||
scale: { type: Number, min: 0.01, default: 5 },
|
scale: { type: Number, min: 0.01, default: 5 },
|
||||||
// Notes pinned onto the map like markers. x/y are image pixels from the top left corner of the
|
|
||||||
// image, so a pin keeps its place whatever the zoom or the grid settings are.
|
|
||||||
pins: [{
|
|
||||||
note: { type: Schema.Types.ObjectId, ref: 'Note', required: true },
|
|
||||||
x: { type: Number, default: 0 },
|
|
||||||
y: { type: Number, default: 0 }
|
|
||||||
}],
|
|
||||||
// Actors dragged onto the map to stand on it as tokens. x/y are image pixels of the centre of the
|
|
||||||
// token, like a pin, and the viewer keeps them snapped onto a grid cell so a token sits where the
|
|
||||||
// square it stands in is.
|
|
||||||
tokens: [{
|
|
||||||
actor: { type: Schema.Types.ObjectId, ref: 'Actor', required: true },
|
|
||||||
x: { type: Number, default: 0 },
|
|
||||||
y: { type: Number, default: 0 }
|
|
||||||
}],
|
|
||||||
// Lights placed on the map. x/y are image pixels like a pin — a light is not tied to a cell — and
|
|
||||||
// `radius` is how far it reaches in image pixels, of which `bright` is the part that is bright
|
|
||||||
// light and the rest dim light. The walls below are what stops one, see the viewer's
|
|
||||||
// services/MapLighting.js.
|
|
||||||
lights: [{
|
|
||||||
x: { type: Number, default: 0 },
|
|
||||||
y: { type: Number, default: 0 },
|
|
||||||
radius: { type: Number, min: 1, default: 150 },
|
|
||||||
bright: { type: Number, min: 0, default: 75 },
|
|
||||||
// Tint of the light, like '#ffc46b'; empty for a plain white light.
|
|
||||||
color: { type: String, default: '' },
|
|
||||||
// The Foundry AmbientLight document this light mirrors, when the world sent it (see
|
|
||||||
// routes/foundry-link.js). Empty for a light the campaign placed itself.
|
|
||||||
foundryLightId: { type: String, default: '' }
|
|
||||||
}],
|
|
||||||
// The line segments that block the lights above. Endpoints are image pixels, and the app draws
|
|
||||||
// them from corner to corner of the grid so a wall follows its lines.
|
|
||||||
walls: [{
|
|
||||||
x1: { type: Number, default: 0 },
|
|
||||||
y1: { type: Number, default: 0 },
|
|
||||||
x2: { type: Number, default: 0 },
|
|
||||||
y2: { type: Number, default: 0 },
|
|
||||||
// The Foundry Wall document this segment came from, when the world sent it. The world owns its
|
|
||||||
// walls, so a synced one is drawn back over by the next push of that scene.
|
|
||||||
foundryWallId: { type: String, default: '' }
|
|
||||||
}],
|
|
||||||
campaign: {
|
campaign: {
|
||||||
type: Schema.Types.ObjectId,
|
type: Schema.Types.ObjectId,
|
||||||
ref: 'Campaign',
|
ref: 'Campaign',
|
||||||
required: true
|
required: true
|
||||||
},
|
},
|
||||||
// The folder this map stands in: a Folder of the same campaign whose target is
|
|
||||||
// 'map' (null = the root of the map list).
|
|
||||||
folder: {
|
|
||||||
type: Schema.Types.ObjectId,
|
|
||||||
ref: 'Folder',
|
|
||||||
default: null
|
|
||||||
},
|
|
||||||
// The Foundry scene whose lights and walls this map mirrors (see routes/foundry-link.js). Empty for
|
|
||||||
// a map the campaign made for itself, which is the one kind of light a world never hears about.
|
|
||||||
foundrySceneId: { type: String, default: '' },
|
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
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);
|
|
||||||
@@ -5,39 +5,12 @@ const upload = require('../services/storage');
|
|||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Actor = require('../models/Actor');
|
const Actor = require('../models/Actor');
|
||||||
const Folder = require('../models/Folder');
|
|
||||||
const Map = require('../models/Map');
|
|
||||||
|
|
||||||
async function userOwnsCampaign(campaignId, userId) {
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
return Boolean(campaign);
|
return Boolean(campaign);
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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) => {
|
router.get('/list', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { campaign } = req.query;
|
const { campaign } = req.query;
|
||||||
@@ -45,7 +18,7 @@ router.get('/list', async (req, res) => {
|
|||||||
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean();
|
const actors = await Actor.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
res.json({ status: 'ok', actors, folders: await actorFolders(campaign) });
|
res.json({ status: 'ok', actors });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
@@ -72,25 +45,13 @@ router.post('/create', async (req, res) => {
|
|||||||
|
|
||||||
router.post('/update', async (req, res) => {
|
router.post('/update', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const {
|
const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, proficiencies, inventory, traits, spells, image } = req.body;
|
||||||
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' });
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
const actor = await Actor.findById(id);
|
const actor = await Actor.findById(id);
|
||||||
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
// `null` moves the actor to the root of the actor list, an id files it in one of
|
|
||||||
// this campaign's actor folders; anything else is refused.
|
|
||||||
if (folder !== undefined) {
|
|
||||||
if (!(await Folder.belongsToSection(folder || null, actor.campaign, 'actor'))) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
}
|
|
||||||
actor.folder = folder || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (name !== undefined) actor.name = String(name).trim();
|
if (name !== undefined) actor.name = String(name).trim();
|
||||||
if (species !== undefined) actor.species = species;
|
if (species !== undefined) actor.species = species;
|
||||||
if (className !== undefined) actor.className = className;
|
if (className !== undefined) actor.className = className;
|
||||||
@@ -99,17 +60,7 @@ router.post('/update', async (req, res) => {
|
|||||||
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
|
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
|
||||||
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
|
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
|
||||||
if (speed !== undefined) actor.speed = Number(speed);
|
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;
|
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 (inventory !== undefined) actor.inventory = inventory;
|
||||||
if (traits !== undefined) actor.traits = traits;
|
if (traits !== undefined) actor.traits = traits;
|
||||||
if (spells !== undefined) actor.spells = spells;
|
if (spells !== undefined) actor.spells = spells;
|
||||||
@@ -150,11 +101,6 @@ router.post('/delete', async (req, res) => {
|
|||||||
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(actor.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
await actor.deleteOne();
|
await actor.deleteOne();
|
||||||
|
|
||||||
// A token pointing at an actor that is gone would stand on the maps for nothing: drop those
|
|
||||||
// along with the actor, like the pins of a deleted note.
|
|
||||||
await Map.updateMany({ 'tokens.actor': id }, { $pull: { tokens: { actor: id } } });
|
|
||||||
|
|
||||||
res.json({ status: 'ok' });
|
res.json({ status: 'ok' });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
|
|||||||
@@ -1,28 +1,24 @@
|
|||||||
const express = require('express')
|
const express = require('express')
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
const crypto = require('node:crypto');
|
||||||
|
|
||||||
const Campaign = require("../models/Campaign");
|
const Campaign = require("../models/Campaign");
|
||||||
const User = require('../models/User');
|
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
|
||||||
const serviceLinks = require('../services/service-links');
|
|
||||||
|
|
||||||
// Every service links to a campaign through the same sign-up link
|
const FOUNDRY_LINK_TTL_MS = 10 * 60 * 1000;
|
||||||
// (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();
|
function foundryCodeHash(code) {
|
||||||
// A link a service still holds becomes invalid, and it finds that out the
|
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
|
||||||
// next time it asks where its link stands.
|
}
|
||||||
await serviceLinks.revokeServiceLink(service, campaign._id);
|
|
||||||
|
async function expirePendingFoundryLinks(campaignId, userId) {
|
||||||
|
const filter = {
|
||||||
|
source: 'dragonroll',
|
||||||
|
campaign: campaignId,
|
||||||
|
createdBy: userId,
|
||||||
|
completedAt: null
|
||||||
|
};
|
||||||
|
await FoundryLinkRequest.updateMany(filter, { $set: { expiresAt: new Date() } });
|
||||||
}
|
}
|
||||||
|
|
||||||
router.post('/create', async (req, res) => {
|
router.post('/create', async (req, res) => {
|
||||||
@@ -78,26 +74,73 @@ router.post('/update', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Which services a campaign has connected, and the account each of them was
|
router.post('/foundry-link/start', async (req, res) => {
|
||||||
// authorized with.
|
try {
|
||||||
router.get('/services', async (req, res) => {
|
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
await expirePendingFoundryLinks(campaign._id, req.user.id);
|
||||||
|
const code = crypto.randomBytes(24).toString('base64url');
|
||||||
|
const expiresAt = new Date(Date.now() + FOUNDRY_LINK_TTL_MS);
|
||||||
|
const request = await FoundryLinkRequest.create({
|
||||||
|
codeHash: foundryCodeHash(code),
|
||||||
|
code,
|
||||||
|
source: 'dragonroll',
|
||||||
|
campaign: campaign._id,
|
||||||
|
createdBy: req.user.id,
|
||||||
|
expiresAt
|
||||||
|
});
|
||||||
|
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
res.json({ status: 'ok', code, requestId: request.id, expiresAt });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.get('/foundry-link/status/:requestId', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const request = await FoundryLinkRequest.findOne({
|
||||||
|
_id: req.params.requestId,
|
||||||
|
source: 'dragonroll',
|
||||||
|
createdBy: req.user.id
|
||||||
|
});
|
||||||
|
if (!request) return res.json({ status: 'ok', state: 'expired' });
|
||||||
|
if (!request.completedAt && request.expiresAt <= new Date()) {
|
||||||
|
return res.json({ status: 'ok', state: 'expired' });
|
||||||
|
}
|
||||||
|
if (!request.completedAt) return res.json({ status: 'ok', state: 'pending' });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: req.user.id });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
res.json({ status: 'ok', state: 'complete', campaign });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Returns the still-valid pending pairing request for a campaign, so the
|
||||||
|
// settings window can restore its pairing code across reloads and restarts.
|
||||||
|
router.get('/foundry-link/pending', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
|
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
|
||||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
const links = await serviceLinks.listLinkedServices(campaign._id);
|
const request = await FoundryLinkRequest.findOne({
|
||||||
const userIds = [...new Set(links.map((link) => String(link.dragonrollUser ?? '')).filter(Boolean))];
|
source: 'dragonroll',
|
||||||
const users = userIds.length
|
campaign: campaign._id,
|
||||||
? await User.find({ _id: { $in: userIds } }).select('username name').lean()
|
createdBy: req.user.id,
|
||||||
: [];
|
completedAt: null,
|
||||||
const names = new Map(users.map((user) => [String(user._id), user.username || user.name]));
|
expiresAt: { $gt: new Date() }
|
||||||
|
}).sort({ createdAt: -1 });
|
||||||
|
if (!request) return res.json({ status: 'ok', request: null });
|
||||||
|
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
res.json({
|
res.json({
|
||||||
status: 'ok',
|
status: 'ok',
|
||||||
services: links.map((link) => ({
|
request: { requestId: request.id, code: request.code, expiresAt: request.expiresAt }
|
||||||
...link,
|
|
||||||
dragonrollUserName: names.get(String(link.dragonrollUser ?? '')) || null
|
|
||||||
}))
|
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
@@ -105,16 +148,18 @@ router.get('/services', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
router.post('/service-unlink', async (req, res) => {
|
router.post('/foundry-unlink', async (req, res) => {
|
||||||
try {
|
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 });
|
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
|
||||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
await unlinkService(campaign, service);
|
campaign.foundryWorldId = undefined;
|
||||||
res.json({ status: 'ok', campaign, services: await serviceLinks.listLinkedServices(campaign._id) });
|
campaign.foundryWorldTitle = undefined;
|
||||||
|
campaign.foundrySystem = undefined;
|
||||||
|
campaign.set('foundrySyncTokenHash', undefined);
|
||||||
|
await campaign.save();
|
||||||
|
await expirePendingFoundryLinks(campaign._id, req.user.id);
|
||||||
|
res.json({ status: 'ok', campaign });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
|||||||
@@ -1,30 +1,124 @@
|
|||||||
|
const crypto = require('node:crypto');
|
||||||
const express = require('express');
|
const express = require('express');
|
||||||
|
const passport = require('passport');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
const Actor = require('../models/Actor');
|
const Actor = require('../models/Actor');
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const DiscordGuildLink = require('../models/DiscordGuildLink');
|
const DiscordGuildLink = require('../models/DiscordGuildLink');
|
||||||
const ServiceLinkRequest = require('../models/ServiceLinkRequest');
|
const DiscordLinkRequest = require('../models/DiscordLinkRequest');
|
||||||
const User = require('../models/User');
|
const User = require('../models/User');
|
||||||
const serviceLinks = require('../services/service-links');
|
|
||||||
|
|
||||||
|
const LINK_TTL_MS = 10 * 60 * 1000;
|
||||||
|
const NOTIFICATION_WINDOW_MS = 15 * 60 * 1000;
|
||||||
const NOTIFICATION_LIMIT = 10;
|
const NOTIFICATION_LIMIT = 10;
|
||||||
|
|
||||||
const requireBot = serviceLinks.requireDiscordBot;
|
|
||||||
|
|
||||||
function validGuildId(value) {
|
function validGuildId(value) {
|
||||||
return /^\d{5,25}$/.test(String(value ?? ''));
|
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||||
}
|
}
|
||||||
|
|
||||||
// Discord ids are snowflakes the same shape as guild ids.
|
function codeHash(code) {
|
||||||
function validUserId(value) {
|
return crypto.createHash('sha256').update(String(code ?? '')).digest('hex');
|
||||||
return /^\d{5,25}$/.test(String(value ?? ''));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Connecting a Discord server is the service link of issue: the bot asks
|
function requireBot(req, res, next) {
|
||||||
// /api/link/start for a sign-up link, and whoever opens it signs in and picks the
|
const configuredSecret = process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '';
|
||||||
// campaign this server may read. What is left here is what the bot needs once
|
const suppliedSecret = req.get('x-dragonroll-discord-bot-secret') || '';
|
||||||
// that link exists: confirming it in Discord and working with its campaign.
|
const expected = Buffer.from(configuredSecret);
|
||||||
|
const supplied = Buffer.from(suppliedSecret);
|
||||||
|
|
||||||
|
if (!expected.length || expected.length !== supplied.length || !crypto.timingSafeEqual(expected, supplied)) {
|
||||||
|
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
|
||||||
|
}
|
||||||
|
return next();
|
||||||
|
}
|
||||||
|
|
||||||
|
function frontendAuthorizeUrl() {
|
||||||
|
const frontendUrl = (process.env.DRAGONROLL_FRONTEND_URL || 'http://localhost:3000').trim().replace(/\/+$/, '');
|
||||||
|
return `${frontendUrl}/discord/authorize`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// La pantalla d'autorització l'serveix el frontend. El codi viatja al fragment de la URL i el
|
||||||
|
// navegador no l'envia mai al servidor, així que els enllaços antics del bot arriben a la
|
||||||
|
// pantalla sense codi i demanen de tornar a executar /dragonroll connect.
|
||||||
|
router.get('/authorize', (req, res) => {
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
res.set('Referrer-Policy', 'no-referrer');
|
||||||
|
res.set('X-Content-Type-Options', 'nosniff');
|
||||||
|
res.redirect(302, frontendAuthorizeUrl());
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/link/start', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { guildId, guildName, discordUserId, discordUserName } = req.body;
|
||||||
|
if (!validGuildId(guildId) || !/^\d{5,25}$/.test(String(discordUserId ?? '')) || !guildName || !discordUserName) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const code = crypto.randomBytes(32).toString('base64url');
|
||||||
|
await DiscordLinkRequest.create({
|
||||||
|
codeHash: codeHash(code),
|
||||||
|
guildId: String(guildId),
|
||||||
|
guildName: String(guildName).slice(0, 100),
|
||||||
|
discordUserId: String(discordUserId),
|
||||||
|
discordUserName: String(discordUserName).slice(0, 100),
|
||||||
|
expiresAt: new Date(Date.now() + LINK_TTL_MS)
|
||||||
|
});
|
||||||
|
|
||||||
|
res.json({ status: 'ok', code, expiresAt: new Date(Date.now() + LINK_TTL_MS) });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/link/details', async (req, res) => {
|
||||||
|
try {
|
||||||
|
res.set('Cache-Control', 'no-store');
|
||||||
|
const request = await DiscordLinkRequest.findOne({
|
||||||
|
codeHash: codeHash(req.body.code),
|
||||||
|
expiresAt: { $gt: new Date() },
|
||||||
|
completedAt: null
|
||||||
|
}).lean();
|
||||||
|
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
|
||||||
|
|
||||||
|
res.json({ status: 'ok', guildName: request.guildName, discordUserName: request.discordUserName });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/link/complete', passport.authenticate('jwt', { session: false }), async (req, res) => {
|
||||||
|
try {
|
||||||
|
const request = await DiscordLinkRequest.findOneAndUpdate({
|
||||||
|
codeHash: codeHash(req.body.code),
|
||||||
|
expiresAt: { $gt: new Date() },
|
||||||
|
completedAt: null
|
||||||
|
}, {
|
||||||
|
$set: { completedAt: new Date(), dragonrollUser: req.user.id }
|
||||||
|
}, { new: true });
|
||||||
|
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
|
||||||
|
|
||||||
|
await Campaign.updateMany(
|
||||||
|
{ discordGuildId: request.guildId, createdBy: { $ne: req.user.id } },
|
||||||
|
{ $unset: { discordGuildId: 1 } }
|
||||||
|
);
|
||||||
|
|
||||||
|
await DiscordGuildLink.findOneAndUpdate({ guildId: request.guildId }, {
|
||||||
|
$set: {
|
||||||
|
discordUserId: request.discordUserId,
|
||||||
|
dragonrollUser: req.user.id,
|
||||||
|
connectedAt: new Date()
|
||||||
|
}
|
||||||
|
}, { new: true, upsert: true, setDefaultsOnInsert: true });
|
||||||
|
|
||||||
|
res.json({ status: 'ok', guildName: request.guildName });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
async function dragonrollUserNames(requests) {
|
async function dragonrollUserNames(requests) {
|
||||||
const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))];
|
const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))];
|
||||||
@@ -38,18 +132,16 @@ async function dragonrollUserNames(requests) {
|
|||||||
// mateix evita que dos processos del bot confirmïn la mateixa vegada.
|
// mateix evita que dos processos del bot confirmïn la mateixa vegada.
|
||||||
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
|
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const pending = await ServiceLinkRequest.find({
|
const pending = await DiscordLinkRequest.find({
|
||||||
service: 'discord',
|
completedAt: { $gte: new Date(Date.now() - NOTIFICATION_WINDOW_MS) },
|
||||||
state: 'linked',
|
|
||||||
linkedAt: { $gte: new Date(Date.now() - serviceLinks.NOTIFICATION_WINDOW_MS) },
|
|
||||||
notifiedAt: null
|
notifiedAt: null
|
||||||
}).select('_id targetId targetName targetUser targetMeta dragonrollUser campaign')
|
}).select('_id guildId guildName discordUserId discordUserName dragonrollUser')
|
||||||
.limit(NOTIFICATION_LIMIT)
|
.limit(NOTIFICATION_LIMIT)
|
||||||
.lean();
|
.lean();
|
||||||
|
|
||||||
const claimed = [];
|
const claimed = [];
|
||||||
for (const request of pending) {
|
for (const request of pending) {
|
||||||
const taken = await ServiceLinkRequest.findOneAndUpdate(
|
const taken = await DiscordLinkRequest.findOneAndUpdate(
|
||||||
{ _id: request._id, notifiedAt: null },
|
{ _id: request._id, notifiedAt: null },
|
||||||
{ $set: { notifiedAt: new Date() } },
|
{ $set: { notifiedAt: new Date() } },
|
||||||
{ new: true }
|
{ new: true }
|
||||||
@@ -58,22 +150,15 @@ router.post('/bot/link-requests/notifications', requireBot, async (req, res) =>
|
|||||||
}
|
}
|
||||||
|
|
||||||
const names = await dragonrollUserNames(claimed);
|
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({
|
res.json({
|
||||||
status: 'ok',
|
status: 'ok',
|
||||||
notifications: claimed.map((request) => ({
|
notifications: claimed.map((request) => ({
|
||||||
id: String(request._id),
|
id: String(request._id),
|
||||||
guildId: request.targetId,
|
guildId: request.guildId,
|
||||||
guildName: request.targetName,
|
guildName: request.guildName,
|
||||||
discordUserId: request.targetMeta?.userId || '',
|
discordUserId: request.discordUserId,
|
||||||
discordUserName: request.targetUser,
|
discordUserName: request.discordUserName,
|
||||||
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null,
|
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null
|
||||||
campaignName: campaignNames.get(String(request.campaign ?? '')) || null
|
|
||||||
}))
|
}))
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -184,92 +269,4 @@ router.get('/bot/guild/:guildId/actors', requireBot, async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// 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;
|
module.exports = router;
|
||||||
|
|||||||
@@ -2,11 +2,8 @@ const express = require('express');
|
|||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Actor = require('../models/Actor');
|
|
||||||
const Folder = require('../models/Folder');
|
const Folder = require('../models/Folder');
|
||||||
const Map = require('../models/Map');
|
|
||||||
const Note = require('../models/Note');
|
const Note = require('../models/Note');
|
||||||
const Item = require('../models/Item');
|
|
||||||
|
|
||||||
async function userOwnsCampaign(campaignId, userId) {
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
@@ -15,16 +12,14 @@ async function userOwnsCampaign(campaignId, userId) {
|
|||||||
|
|
||||||
router.get('/list', async (req, res) => {
|
router.get('/list', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
// Every sidebar section has its own folders; a request that names none means the
|
const { campaign } = req.query;
|
||||||
// notes, like every caller of this route has until the other sections got theirs.
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
const { campaign, target = 'note' } = req.query;
|
|
||||||
if (!campaign || !Folder.isTarget(target)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const folders = await Folder.find({ campaign, ...Folder.filterForTarget(target) })
|
const folders = await Folder.find({ campaign })
|
||||||
.select('_id name parentFolder date color')
|
.select('_id name date color')
|
||||||
.sort({ date: -1 })
|
.sort({ date: -1 })
|
||||||
.lean();
|
.lean();
|
||||||
|
|
||||||
@@ -37,16 +32,15 @@ router.get('/list', async (req, res) => {
|
|||||||
|
|
||||||
router.post('/create', async (req, res) => {
|
router.post('/create', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { name, campaign, target = 'note' } = req.body;
|
const { name, campaign } = req.body;
|
||||||
if (!name || !campaign || !Folder.isTarget(target)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
if (!name || !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 newFolder = new Folder({
|
const newFolder = new Folder({
|
||||||
name: name.trim(),
|
name: name.trim(),
|
||||||
campaign,
|
campaign
|
||||||
target
|
|
||||||
});
|
});
|
||||||
await newFolder.save();
|
await newFolder.save();
|
||||||
res.json({ status: 'ok', folder: newFolder });
|
res.json({ status: 'ok', folder: newFolder });
|
||||||
@@ -56,7 +50,6 @@ router.post('/create', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Renaming and colouring works the same for the folders of every campaign section.
|
|
||||||
router.post('/update', async (req, res) => {
|
router.post('/update', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id, name, color } = req.body;
|
const { id, name, color } = req.body;
|
||||||
@@ -92,25 +85,10 @@ router.post('/delete', async (req, res) => {
|
|||||||
|
|
||||||
async function moveRecursive(folderId) {
|
async function moveRecursive(folderId) {
|
||||||
const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean();
|
const subfolders = await Folder.find({ parentFolder: folderId }).select('_id').lean();
|
||||||
// Every section files rows into a folder of its own, so each of them moves what
|
|
||||||
// stands in this one to the root of its own list instead of leaving it pointing
|
|
||||||
// at a folder that is gone.
|
|
||||||
await Note.updateMany(
|
await Note.updateMany(
|
||||||
{ folder: folderId },
|
{ folder: folderId },
|
||||||
{ $set: { folder: null, date: Date.now() } }
|
{ $set: { folder: null, date: Date.now() } }
|
||||||
);
|
);
|
||||||
await Actor.updateMany(
|
|
||||||
{ folder: folderId },
|
|
||||||
{ $set: { folder: null } }
|
|
||||||
);
|
|
||||||
await Item.updateMany(
|
|
||||||
{ folder: folderId },
|
|
||||||
{ $set: { folder: null } }
|
|
||||||
);
|
|
||||||
await Map.updateMany(
|
|
||||||
{ folder: folderId },
|
|
||||||
{ $set: { folder: null } }
|
|
||||||
);
|
|
||||||
await Folder.deleteOne({ _id: folderId });
|
await Folder.deleteOne({ _id: folderId });
|
||||||
for (const sub of subfolders) {
|
for (const sub of subfolders) {
|
||||||
await moveRecursive(sub._id);
|
await moveRecursive(sub._id);
|
||||||
|
|||||||
@@ -1,18 +1,17 @@
|
|||||||
const crypto = require('node:crypto');
|
const crypto = require('node:crypto');
|
||||||
const express = require('express');
|
const express = require('express');
|
||||||
|
const rateLimit = require('express-rate-limit');
|
||||||
const mongoose = require('mongoose');
|
const mongoose = require('mongoose');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Actor = require('../models/Actor');
|
const Actor = require('../models/Actor');
|
||||||
const Item = require('../models/Item');
|
const Item = require('../models/Item');
|
||||||
const Folder = require('../models/Folder');
|
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
|
||||||
// Named for what it is: the plain `Map` of this module's own scope would hide the built-in `Map` the
|
|
||||||
// item folder sync below builds its trees out of.
|
|
||||||
const MapModel = require('../models/Map');
|
|
||||||
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
||||||
const { foundryItemToItemData } = require('../services/item-foundry');
|
const { foundryItemToItemData } = require('../services/item-foundry');
|
||||||
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
|
||||||
|
const linkRateLimit = rateLimit({ windowMs: 15 * 60 * 1000, max: 20 });
|
||||||
|
|
||||||
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
||||||
const MAX_FOUNDRY_NAMES = 20;
|
const MAX_FOUNDRY_NAMES = 20;
|
||||||
@@ -45,33 +44,10 @@ function requestMatchesWorld(campaign, worldId) {
|
|||||||
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
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) {
|
async function saveFoundryActor(campaign, source, fullSync = false) {
|
||||||
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
const fields = foundryActorToCharacter(source || {});
|
const fields = foundryActorToCharacter(source || {});
|
||||||
if (!foundryActorId || !fields.name) return null;
|
if (!foundryActorId || !fields.name) return null;
|
||||||
resolveWorldAssets(fields, campaign);
|
|
||||||
|
|
||||||
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
||||||
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
||||||
@@ -89,30 +65,30 @@ async function saveFoundryActor(campaign, source, fullSync = false) {
|
|||||||
: new Actor({ campaign: campaign._id });
|
: new Actor({ campaign: campaign._id });
|
||||||
}
|
}
|
||||||
actor.foundryActorId = foundryActorId;
|
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
|
// A full snapshot runs when a GM reconnects. Preserve existing Dragonroll
|
||||||
// edits then; live Foundry change events continue to overwrite normally.
|
// edits then; live Foundry change events continue to overwrite normally.
|
||||||
if (!fullSync || actor.isNew) Object.assign(actor, fields);
|
if (!fullSync || actor.isNew) Object.assign(actor, fields);
|
||||||
await actor.save();
|
await actor.save();
|
||||||
return { foundryActorId, actorId: actor.id, created };
|
return { foundryActorId, actorId: actor.id };
|
||||||
}
|
}
|
||||||
|
|
||||||
// The campaign's item list mirrors the world's item directory and nothing else
|
// A snapshot carries world-level items plus the items embedded in every actor it
|
||||||
// (Syndria98/dragonroll#67). The items embedded in an actor are that character's own
|
// sends. World items are listed first so they own a name before its copies.
|
||||||
// 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) {
|
function snapshotItemSources(body) {
|
||||||
return Array.isArray(body.items) ? body.items : [];
|
const sources = [];
|
||||||
|
if (Array.isArray(body.items)) sources.push(...body.items);
|
||||||
|
if (Array.isArray(body.actors)) {
|
||||||
|
for (const actor of body.actors) {
|
||||||
|
if (Array.isArray(actor?.items)) sources.push(...actor.items);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return sources;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveFoundryItem(campaign, source, fullSync = false, folders = null) {
|
async function saveFoundryItem(campaign, source, fullSync = false) {
|
||||||
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
const fields = foundryItemToItemData(source || {});
|
const fields = foundryItemToItemData(source || {});
|
||||||
if (!foundryItemId || !fields) return null;
|
if (!foundryItemId || !fields) return null;
|
||||||
resolveWorldAssets(fields, campaign);
|
|
||||||
|
|
||||||
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
||||||
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
||||||
@@ -122,9 +98,9 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
|
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
|
||||||
}
|
}
|
||||||
if (!item) {
|
if (!item) {
|
||||||
// A world item can share its name with a Dragonroll row the campaign made by
|
// The same gear exists more than once in Foundry: once in the world
|
||||||
// hand, or with one it renamed away from. Keep a single item per name so a
|
// directory and once inside each actor carrying it. Keep a single
|
||||||
// piece of gear the world sends folds into that row instead of doubling it.
|
// Dragonroll item per name so inventories do not flood the Item list.
|
||||||
const sameName = await Item.find({
|
const sameName = await Item.find({
|
||||||
campaign: campaign._id,
|
campaign: campaign._id,
|
||||||
$or: [{ name: fields.name }, { foundryNames: fields.name }]
|
$or: [{ name: fields.name }, { foundryNames: fields.name }]
|
||||||
@@ -136,343 +112,126 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
}
|
}
|
||||||
|
|
||||||
item.foundryItemId = foundryItemId;
|
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);
|
if (!fullSync || item.isNew) Object.assign(item, fields);
|
||||||
// Foundry's own icon is kept on every save, not only when the edits above
|
|
||||||
// land: the item window offers it back after the user picked their own.
|
|
||||||
if (fields.image) item.foundryImage = fields.image;
|
|
||||||
if (!item.foundryNames.includes(fields.name)) {
|
if (!item.foundryNames.includes(fields.name)) {
|
||||||
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
|
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
|
||||||
}
|
}
|
||||||
// Which folder of the campaign's item tree the world says this item stands in.
|
|
||||||
// `undefined` means the push says nothing about folders — an 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();
|
await item.save();
|
||||||
return { foundryItemId, itemId: item.id, created };
|
return { foundryItemId, itemId: item.id };
|
||||||
}
|
}
|
||||||
|
|
||||||
async function syncFoundryItems(campaign, sources, fullSync = false, folders = null) {
|
async function syncFoundryItems(campaign, sources, fullSync = false) {
|
||||||
const items = [];
|
const items = [];
|
||||||
for (const source of sources) {
|
for (const source of sources) {
|
||||||
const mapping = await saveFoundryItem(campaign, source, fullSync, folders);
|
const mapping = await saveFoundryItem(campaign, source, fullSync);
|
||||||
if (mapping) items.push(mapping);
|
if (mapping) items.push(mapping);
|
||||||
}
|
}
|
||||||
return items;
|
return items;
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Item folders ------------------------------------------------------------
|
function readWorld(body) {
|
||||||
// A Foundry world groups its item directory into folders; the campaign mirrors that
|
const world = body?.world;
|
||||||
// tree as Folders of target 'item' so its item list reads like the world's. Every
|
if (!world || typeof world.id !== 'string' || !world.id.trim()) return null;
|
||||||
// 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
|
let foundryUrl = '';
|
||||||
// colours — an older module, which knows nothing about them — and the colour the
|
if (typeof world.url === 'string') {
|
||||||
// campaign has stays; `null` is the world leaving a folder uncoloured, which takes
|
try {
|
||||||
// the campaign's colour off along with it. Anything else is the colour to show.
|
const url = new URL(world.url);
|
||||||
function foundryFolderColor(source) {
|
if (url.protocol === 'http:' || url.protocol === 'https:') foundryUrl = url.origin;
|
||||||
if (source?.color === undefined) return undefined;
|
} catch {}
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Scene lighting ------------------------------------------------------------
|
|
||||||
// A Foundry scene lights its own ground, and the campaign mirrors that onto the map standing for that
|
|
||||||
// scene: the world's ambient lights and the walls that stop them arrive there, so a torch lit in the
|
|
||||||
// world is a torch on the map the campaign reads, and the dark behind its walls is the same dark.
|
|
||||||
//
|
|
||||||
// The module sends its coordinates as pixels of the scene's background image at the size that image
|
|
||||||
// has on disk, and its reaches likewise. The campaign keeps everything as pixels of its own map image,
|
|
||||||
// so the grid cell is the unit the two agree on: one scene pixel is worth as many map pixels as that
|
|
||||||
// map's cell is wider or narrower than the scene's.
|
|
||||||
|
|
||||||
function sceneNumber(value, fallback = 0) {
|
|
||||||
const number = Number(value);
|
|
||||||
return Number.isFinite(number) ? number : fallback;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The scene a push describes: enough of it to mirror a map after it, and to scale its lighting onto
|
|
||||||
// the grid of whichever map that turns out to be.
|
|
||||||
function readSceneSource(source) {
|
|
||||||
const id = String(source?.id || '').trim().slice(0, 120);
|
|
||||||
if (!id) return null;
|
|
||||||
return {
|
return {
|
||||||
id,
|
worldId: world.id.trim().slice(0, 120),
|
||||||
title: String(source?.title || '').trim().slice(0, 200),
|
worldTitle: typeof world.title === 'string' ? world.title.trim().slice(0, 200) : '',
|
||||||
// How wide one of the scene's cells is in its image pixels, and how much distance it stands
|
system: typeof world.system === 'string' ? world.system.trim().slice(0, 120) : '',
|
||||||
// for: the map the scene is mirrored onto keeps both of these under the same names.
|
foundryUrl
|
||||||
grid: Math.max(1, Math.round(sceneNumber(source?.grid, 50))),
|
|
||||||
gridDistance: Math.max(0.01, sceneNumber(source?.gridDistance, 5)),
|
|
||||||
image: typeof source?.image === 'string' ? source.image.trim() : ''
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// The map a scene's lighting belongs to: the one already mirroring that scene, or the campaign's own
|
async function attachWorldToCampaign(campaign, world) {
|
||||||
// map of the same name — the same courtesy the item sync extends a hand-written row, so whoever drew
|
const linkedElsewhere = await Campaign.findOne({
|
||||||
// the map by hand is not made to start over — and, when the scene has lighting of its own and the
|
foundryWorldId: world.worldId,
|
||||||
// campaign has no map for it yet, a new map mirroring the scene. A scene with nothing to send never
|
_id: { $ne: campaign._id }
|
||||||
// invents a map nobody asked for.
|
}).select('_id');
|
||||||
async function sceneMap(campaign, scene, create) {
|
if (linkedElsewhere) return false;
|
||||||
const mapped = await MapModel.findOne({ campaign: campaign._id, foundrySceneId: scene.id });
|
|
||||||
if (mapped) return mapped;
|
|
||||||
|
|
||||||
if (scene.title) {
|
campaign.foundryWorldId = world.worldId;
|
||||||
const namesakes = await MapModel.find({ campaign: campaign._id, name: scene.title }).limit(4);
|
campaign.foundryWorldTitle = world.worldTitle;
|
||||||
const claiming = namesakes.filter((map) => !map.foundrySceneId);
|
campaign.foundrySystem = world.system;
|
||||||
// Only a name the campaign uses once claims the scene; two maps of that name would make it a
|
if (world.foundryUrl) {
|
||||||
// guess which of them the world is talking about.
|
const settings = campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {};
|
||||||
if (claiming.length === 1) {
|
const integrations = settings.integrations && typeof settings.integrations === 'object'
|
||||||
const map = claiming[0];
|
? settings.integrations
|
||||||
map.foundrySceneId = scene.id;
|
: {};
|
||||||
return map;
|
campaign.settings = {
|
||||||
}
|
...settings,
|
||||||
}
|
integrations: {
|
||||||
if (!create) return null;
|
...integrations,
|
||||||
|
foundryUrl: integrations.foundryUrl || world.foundryUrl
|
||||||
return new MapModel({
|
}
|
||||||
campaign: campaign._id,
|
|
||||||
name: scene.title || 'Foundry scene',
|
|
||||||
// The scene's own artwork, read against its world like every other Foundry image (see
|
|
||||||
// worldAssetUrl), so the campaign is looking at the same picture the players are.
|
|
||||||
image: worldAssetUrl(scene.image, campaign?.settings?.integrations?.foundryUrl),
|
|
||||||
gridSize: scene.grid,
|
|
||||||
scale: scene.gridDistance,
|
|
||||||
foundrySceneId: scene.id
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// A scene pixel as a coordinate of the campaign's map: whole pixels, never negative, and scaled by the
|
|
||||||
// two grids' difference in cell width.
|
|
||||||
function scenePixelToMap(value, ratio) {
|
|
||||||
const number = sceneNumber(value, 0) * ratio;
|
|
||||||
return Math.max(0, Math.round(number));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The tint of a light, or none: the viewer paints with it, so anything that is not a hex colour is
|
|
||||||
// dropped rather than trusted.
|
|
||||||
function sceneLightColor(value) {
|
|
||||||
const color = typeof value === 'string' ? value.trim().toLowerCase() : '';
|
|
||||||
return /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/.test(color) ? color : '';
|
|
||||||
}
|
|
||||||
|
|
||||||
// A wall of the map is kept at its corners of the grid, the way a wall drawn in Dragonroll is, so the
|
|
||||||
// lines a scene sends and the lines a campaign draws follow the same grid.
|
|
||||||
function toMapGridVertex(value, offset, size) {
|
|
||||||
const steps = Math.round((Math.max(0, Math.round(value)) - offset) / size);
|
|
||||||
return Math.max(0, Math.round(offset + steps * size));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The lights of a scene written onto its map. A light the world sent before is written over — the
|
|
||||||
// world owns its own lighting, so unlike an actor's fields a move lands on every push — one it never
|
|
||||||
// sent is added, and one it has let go of goes. A light the campaign placed itself (no foundryLightId)
|
|
||||||
// is none of the world's business and stays.
|
|
||||||
function writeSceneLights(map, scene, sources) {
|
|
||||||
const ratio = map.gridSize / scene.grid;
|
|
||||||
const kept = new Set();
|
|
||||||
let changed = false;
|
|
||||||
|
|
||||||
for (const source of sources) {
|
|
||||||
const id = String(source?.id || '').trim().slice(0, 120);
|
|
||||||
if (!id || kept.has(id)) continue;
|
|
||||||
kept.add(id);
|
|
||||||
|
|
||||||
const radius = Math.max(1, scenePixelToMap(source?.radius, ratio));
|
|
||||||
const spot = {
|
|
||||||
x: scenePixelToMap(source?.x, ratio),
|
|
||||||
y: scenePixelToMap(source?.y, ratio),
|
|
||||||
radius,
|
|
||||||
bright: Math.max(0, Math.min(radius, scenePixelToMap(source?.bright, ratio))),
|
|
||||||
color: sceneLightColor(source?.color)
|
|
||||||
};
|
};
|
||||||
const light = map.lights.find((entry) => entry.foundryLightId && String(entry.foundryLightId) === id);
|
|
||||||
if (light) {
|
|
||||||
Object.assign(light, spot);
|
|
||||||
} else {
|
|
||||||
map.lights.push({ ...spot, foundryLightId: id });
|
|
||||||
}
|
|
||||||
changed = true;
|
|
||||||
}
|
}
|
||||||
|
await campaign.save();
|
||||||
// Only the world's own lights are pruned, and only by a push that speaks of lights at all.
|
return true;
|
||||||
const remaining = map.lights.filter((entry) => !entry.foundryLightId || kept.has(String(entry.foundryLightId)));
|
|
||||||
if (remaining.length !== map.lights.length) changed = true;
|
|
||||||
map.lights = remaining;
|
|
||||||
return changed;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// The walls of a scene, likewise: the world drew them, so its own walls arrive whole with every push.
|
async function expireOtherPendingLinks(campaignId, userId, requestId) {
|
||||||
function writeSceneWalls(map, scene, sources) {
|
await FoundryLinkRequest.updateMany({
|
||||||
const ratio = map.gridSize / scene.grid;
|
source: 'dragonroll',
|
||||||
const kept = new Set();
|
campaign: campaignId,
|
||||||
let changed = false;
|
createdBy: userId,
|
||||||
|
completedAt: null,
|
||||||
for (const source of sources) {
|
_id: { $ne: requestId }
|
||||||
const id = String(source?.id || '').trim().slice(0, 120);
|
}, { $set: { expiresAt: new Date() } });
|
||||||
if (!id || kept.has(id)) continue;
|
|
||||||
kept.add(id);
|
|
||||||
|
|
||||||
const corner = {
|
|
||||||
x1: toMapGridVertex(scenePixelToMap(source?.x1, ratio), map.offsetX, map.gridSize),
|
|
||||||
y1: toMapGridVertex(scenePixelToMap(source?.y1, ratio), map.offsetY, map.gridSize),
|
|
||||||
x2: toMapGridVertex(scenePixelToMap(source?.x2, ratio), map.offsetX, map.gridSize),
|
|
||||||
y2: toMapGridVertex(scenePixelToMap(source?.y2, ratio), map.offsetY, map.gridSize)
|
|
||||||
};
|
|
||||||
// A wall from a corner to itself blocks nothing, and neither does its twin drawn backwards.
|
|
||||||
if (corner.x1 === corner.x2 && corner.y1 === corner.y2) continue;
|
|
||||||
|
|
||||||
const wall = map.walls.find((entry) => entry.foundryWallId && String(entry.foundryWallId) === id);
|
|
||||||
if (wall) Object.assign(wall, corner);
|
|
||||||
else map.walls.push({ ...corner, foundryWallId: id });
|
|
||||||
changed = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
const remaining = map.walls.filter((entry) => !entry.foundryWallId || kept.has(String(entry.foundryWallId)));
|
|
||||||
if (remaining.length !== map.walls.length) changed = true;
|
|
||||||
map.walls = remaining;
|
|
||||||
return changed;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// The maps the module reconciles its scenes against: which campaign lights belong in which world
|
router.post('/link/complete', linkRateLimit, async (req, res) => {
|
||||||
// scene, and how far a pixel of that map is worth. Only the maps that speak of lighting are sent, and
|
|
||||||
// a map mirroring a scene is sent even empty of lights, because that is what tells the world its
|
|
||||||
// campaign has put every one of its lights out.
|
|
||||||
function sceneLightingList(maps) {
|
|
||||||
return maps
|
|
||||||
.filter((map) => (map.lights?.length ?? 0) > 0 || map.foundrySceneId)
|
|
||||||
.map((map) => ({
|
|
||||||
_id: map._id,
|
|
||||||
name: map.name,
|
|
||||||
foundrySceneId: map.foundrySceneId || '',
|
|
||||||
gridSize: map.gridSize,
|
|
||||||
scale: map.scale,
|
|
||||||
lights: (map.lights ?? []).map((light) => ({
|
|
||||||
_id: light._id,
|
|
||||||
x: light.x,
|
|
||||||
y: light.y,
|
|
||||||
radius: light.radius,
|
|
||||||
bright: light.bright,
|
|
||||||
color: light.color || '',
|
|
||||||
foundryLightId: light.foundryLightId || ''
|
|
||||||
}))
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// 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 {
|
try {
|
||||||
const campaign = await syncCampaign(req, res);
|
const world = readWorld(req.body);
|
||||||
if (!campaign) return;
|
if (!world || typeof req.body.code !== 'string' || !req.body.code.trim()) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const request = await FoundryLinkRequest.findOne({
|
||||||
|
codeHash: codeHash(req.body.code),
|
||||||
|
source: 'dragonroll',
|
||||||
|
expiresAt: { $gt: new Date() },
|
||||||
|
completedAt: null
|
||||||
|
});
|
||||||
|
if (!request) return res.json({ status: 'error', msg: 'foundry.errors.link-expired' });
|
||||||
|
|
||||||
|
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: request.createdBy });
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const attached = await attachWorldToCampaign(campaign, world);
|
||||||
|
if (!attached) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
|
||||||
|
|
||||||
|
const syncToken = crypto.randomBytes(32).toString('base64url');
|
||||||
|
campaign.foundrySyncTokenHash = codeHash(syncToken);
|
||||||
|
await campaign.save();
|
||||||
|
|
||||||
|
request.worldId = world.worldId;
|
||||||
|
request.worldTitle = world.worldTitle;
|
||||||
|
request.system = world.system;
|
||||||
|
request.foundryUrl = world.foundryUrl;
|
||||||
|
request.completedAt = new Date();
|
||||||
|
request.code = undefined; // Redeemed: keep only the hash from now on.
|
||||||
|
await request.save();
|
||||||
|
await expireOtherPendingLinks(campaign._id, request.createdBy, request._id);
|
||||||
|
|
||||||
|
const bridgeUrl = process.env.FOUNDRY_API_CLIENT_URL || process.env.FOUNDRY_API_URL;
|
||||||
|
const pushToken = process.env.FOUNDRY_API_PUSH_TOKEN;
|
||||||
res.set('Cache-Control', 'no-store');
|
res.set('Cache-Control', 'no-store');
|
||||||
res.json({
|
res.json({
|
||||||
status: 'ok',
|
status: 'ok',
|
||||||
campaign: { id: campaign.id, name: campaign.name },
|
world: { id: world.worldId, title: world.worldTitle, system: world.system },
|
||||||
worldId: campaign.foundryWorldId
|
syncToken,
|
||||||
|
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(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' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -488,16 +247,12 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const fullSync = req.body.fullSync === true;
|
const fullSync = req.body.fullSync === true;
|
||||||
// A module that knows nothing about item folders sends neither the tree
|
|
||||||
// nor the folder of an item, and then nothing here touches the folders.
|
|
||||||
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
|
||||||
const actors = [];
|
const actors = [];
|
||||||
for (const source of actorSources || []) {
|
for (const source of actorSources || []) {
|
||||||
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
||||||
if (mapping) actors.push(mapping);
|
if (mapping) actors.push(mapping);
|
||||||
}
|
}
|
||||||
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync);
|
||||||
const items = await syncFoundryItems(campaign, snapshotItemSources(req.body), fullSync, itemFolders);
|
|
||||||
|
|
||||||
if (fullSync && actorSources) {
|
if (fullSync && actorSources) {
|
||||||
const currentIds = actorSources
|
const currentIds = actorSources
|
||||||
@@ -508,8 +263,8 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
foundryActorId: { $exists: true, $nin: currentIds }
|
foundryActorId: { $exists: true, $nin: currentIds }
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
// Pruning needs a full snapshot: only that request sees the whole world
|
// Pruning needs a full snapshot: only that request sees the world
|
||||||
// directory, so it alone knows which synced rows the world has let go of.
|
// directory and every actor's copies at the same time.
|
||||||
if (fullSync && itemSources) {
|
if (fullSync && itemSources) {
|
||||||
const currentIds = snapshotItemSources(req.body)
|
const currentIds = snapshotItemSources(req.body)
|
||||||
.map((source) => String(source?._id || source?.id || '').trim())
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
@@ -526,21 +281,17 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Live Foundry item edits: upserts only, never prunes items. Removing items that no
|
// Live Foundry item edits: upserts only, never prunes. Removing items that no
|
||||||
// longer exist is left to the full snapshot sent with the actors. Item folders are
|
// longer exist is left to the full snapshot sent with the actors.
|
||||||
// the exception: every request carries the world's whole folder tree, so a folder
|
|
||||||
// the world dropped is dropped here too, and a push may carry folders only.
|
|
||||||
router.post('/sync/item-snapshot', async (req, res) => {
|
router.post('/sync/item-snapshot', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const campaign = await syncCampaign(req, res);
|
const campaign = await syncCampaign(req, res);
|
||||||
if (!campaign) return;
|
if (!campaign) return;
|
||||||
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
|
||||||
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.items)) {
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.items)) {
|
||||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
}
|
}
|
||||||
|
|
||||||
const folders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items) });
|
||||||
res.json({ status: 'ok', items: await syncFoundryItems(campaign, req.body.items, false, folders) });
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
@@ -618,20 +369,12 @@ router.post('/sync/item-delete', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// The item list the world reconciles against, together with the folders its rows are
|
|
||||||
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
|
||||||
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
|
||||||
// colours a folder on either side expects to see it coloured on the other.
|
|
||||||
router.get('/sync/items', async (req, res) => {
|
router.get('/sync/items', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const campaign = await syncCampaign(req, res);
|
const campaign = await syncCampaign(req, res);
|
||||||
if (!campaign) return;
|
if (!campaign) return;
|
||||||
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
||||||
const folders = await Folder.find({ campaign: campaign._id, target: 'item' })
|
res.json({ status: 'ok', items });
|
||||||
.select('_id name color foundryFolderId')
|
|
||||||
.sort({ name: 1 })
|
|
||||||
.lean();
|
|
||||||
res.json({ status: 'ok', items, folders });
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
@@ -661,86 +404,4 @@ router.post('/sync/map-item', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// The lighting of one of the world's scenes: its ambient lights and the walls that stop them, sent
|
|
||||||
// whole so the campaign's map of that scene reads like the ground the players are standing on.
|
|
||||||
router.post('/sync/scene', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const campaign = await syncCampaign(req, res);
|
|
||||||
if (!campaign) return;
|
|
||||||
|
|
||||||
const scene = readSceneSource(req.body.scene);
|
|
||||||
const lights = Array.isArray(req.body.lights) ? req.body.lights : null;
|
|
||||||
const walls = Array.isArray(req.body.walls) ? req.body.walls : null;
|
|
||||||
if (!requestMatchesWorld(campaign, req.body.worldId) || !scene || (!lights && !walls)) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
}
|
|
||||||
|
|
||||||
const map = await sceneMap(campaign, scene, (lights?.length ?? 0) + (walls?.length ?? 0) > 0);
|
|
||||||
// A world pushing a scene empty of lighting onto a campaign that has no map for it: there is
|
|
||||||
// nothing here to remember, so nothing is remembered.
|
|
||||||
if (!map) return res.json({ status: 'ok', map: null, lights: 0, walls: 0 });
|
|
||||||
|
|
||||||
// A push owns the lighting it carries and nothing else: not the map's name, not its picture,
|
|
||||||
// not the grid whoever lined it up by hand settled on.
|
|
||||||
if (lights) writeSceneLights(map, scene, lights);
|
|
||||||
if (walls) writeSceneWalls(map, scene, walls);
|
|
||||||
await map.save();
|
|
||||||
|
|
||||||
res.json({
|
|
||||||
status: 'ok',
|
|
||||||
map: { _id: map.id, name: map.name, gridSize: map.gridSize, scale: map.scale, foundrySceneId: map.foundrySceneId },
|
|
||||||
lights: map.lights.filter((entry) => entry.foundryLightId).length,
|
|
||||||
walls: map.walls.filter((entry) => entry.foundryWallId).length
|
|
||||||
});
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// The campaign's lighting as the world reads it: which of its lights stand in which scene, at the map
|
|
||||||
// pixels the module scales back onto the world's own grid.
|
|
||||||
router.get('/sync/scenes', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const campaign = await syncCampaign(req, res);
|
|
||||||
if (!campaign) return;
|
|
||||||
const maps = await MapModel.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
|
||||||
res.json({ status: 'ok', scenes: sceneLightingList(maps) });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// A light the campaign placed and the world has taken on: the AmbientLight document standing for it, so
|
|
||||||
// the next write of that light knows which document to move instead of adding a second one.
|
|
||||||
router.post('/sync/map-scene-light', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const campaign = await syncCampaign(req, res);
|
|
||||||
if (!campaign) return;
|
|
||||||
const { map, light, foundryLightId, worldId } = req.body;
|
|
||||||
if (!requestMatchesWorld(campaign, worldId) || !map || !light || !foundryLightId) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
}
|
|
||||||
|
|
||||||
const mapDoc = await MapModel.findOne({ _id: map, campaign: campaign._id });
|
|
||||||
if (!mapDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
const entry = mapDoc.lights.find((current) => String(current._id) === String(light));
|
|
||||||
if (!entry) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
|
|
||||||
entry.foundryLightId = String(foundryLightId).trim().slice(0, 120);
|
|
||||||
await mapDoc.save();
|
|
||||||
res.json({ status: 'ok', light: { _id: entry._id, foundryLightId: entry.foundryLightId } });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
module.exports = router;
|
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;
|
|
||||||
|
|||||||
@@ -1,21 +1,6 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
const { requestFoundry } = require('../services/foundry');
|
const { requestFoundry } = require('../services/foundry');
|
||||||
const { normalizeIconDirectory, readIconListingPage, shapeIconListing } = require('../services/foundry-icons');
|
|
||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
|
||||||
// The 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) {
|
async function proxy(path, res) {
|
||||||
try {
|
try {
|
||||||
@@ -39,95 +24,4 @@ router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURICompo
|
|||||||
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
||||||
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
||||||
|
|
||||||
// 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;
|
module.exports = router;
|
||||||
|
|||||||
@@ -1,26 +1,14 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
const upload = require('../services/storage');
|
|
||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Item = require('../models/Item');
|
const Item = require('../models/Item');
|
||||||
const Folder = require('../models/Folder');
|
|
||||||
|
|
||||||
async function userOwnsCampaign(campaignId, userId) {
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
return Boolean(campaign);
|
return Boolean(campaign);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Folders the campaign's items are grouped into, in the shape the sidebar groups by
|
|
||||||
// (the world's own item folders arrive through the sync, see routes/foundry-link.js).
|
|
||||||
async function itemFolders(campaignId) {
|
|
||||||
return Folder.find({ campaign: campaignId, target: 'item' })
|
|
||||||
.select('_id name parentFolder date color')
|
|
||||||
.sort({ date: -1 })
|
|
||||||
.lean();
|
|
||||||
}
|
|
||||||
|
|
||||||
router.get('/list', async (req, res) => {
|
router.get('/list', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { campaign } = req.query;
|
const { campaign } = req.query;
|
||||||
@@ -28,7 +16,7 @@ router.get('/list', async (req, res) => {
|
|||||||
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const items = await Item.find({ campaign }).sort({ name: 1 }).lean();
|
const items = await Item.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
res.json({ status: 'ok', items, folders: await itemFolders(campaign) });
|
res.json({ status: 'ok', items });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
@@ -56,23 +44,13 @@ router.post('/create', async (req, res) => {
|
|||||||
|
|
||||||
router.post('/update', async (req, res) => {
|
router.post('/update', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id, name, category, rarity, quantity, weight, properties, description, image, folder } = req.body;
|
const { id, name, category, rarity, quantity, weight, properties, description } = req.body;
|
||||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
const item = await Item.findById(id);
|
const item = await Item.findById(id);
|
||||||
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
// `null` moves the item to the root of the item list, an id files it in one of
|
|
||||||
// this campaign's item folders; anything else is refused. The linked world owns
|
|
||||||
// its own folder tree, so a move it reports later wins over one made here.
|
|
||||||
if (folder !== undefined) {
|
|
||||||
if (!(await Folder.belongsToSection(folder || null, item.campaign, 'item'))) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
}
|
|
||||||
item.folder = folder || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (name !== undefined) item.name = String(name).trim();
|
if (name !== undefined) item.name = String(name).trim();
|
||||||
if (category !== undefined) item.category = category;
|
if (category !== undefined) item.category = category;
|
||||||
if (rarity !== undefined) item.rarity = rarity;
|
if (rarity !== undefined) item.rarity = rarity;
|
||||||
@@ -80,7 +58,6 @@ router.post('/update', async (req, res) => {
|
|||||||
if (weight !== undefined && weight !== '') item.weight = Number(weight);
|
if (weight !== undefined && weight !== '') item.weight = Number(weight);
|
||||||
if (properties !== undefined) item.properties = properties;
|
if (properties !== undefined) item.properties = properties;
|
||||||
if (description !== undefined) item.description = description;
|
if (description !== undefined) item.description = description;
|
||||||
if (image !== undefined) item.image = String(image);
|
|
||||||
|
|
||||||
await item.save();
|
await item.save();
|
||||||
res.json({ status: 'ok', item });
|
res.json({ status: 'ok', item });
|
||||||
@@ -90,25 +67,6 @@ router.post('/update', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Upload item image post
|
|
||||||
router.post("/upload-image", upload.single("image"), async (req, res) => {
|
|
||||||
try {
|
|
||||||
const itemId = req.query.item || req.body.item;
|
|
||||||
if (!itemId || !req.file) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const item = await Item.findById(itemId);
|
|
||||||
if (!item) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
if (!(await userOwnsCampaign(item.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
item.image = req.file.filename;
|
|
||||||
await item.save();
|
|
||||||
res.json({ status: "ok", msg: "uploaded", item });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: "error", msg: "internal" });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/delete', async (req, res) => {
|
router.post('/delete', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id } = req.body;
|
const { id } = req.body;
|
||||||
|
|||||||
@@ -5,24 +5,12 @@ const upload = require('../services/storage');
|
|||||||
|
|
||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Map = require('../models/Map');
|
const Map = require('../models/Map');
|
||||||
const Folder = require('../models/Folder');
|
|
||||||
const Note = require('../models/Note');
|
|
||||||
const Actor = require('../models/Actor');
|
|
||||||
|
|
||||||
async function userOwnsCampaign(campaignId, userId) {
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
return Boolean(campaign);
|
return Boolean(campaign);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Folders the campaign's maps are grouped into, in the shape the sidebar groups by
|
|
||||||
// (the notes, actors and items each keep a tree of their own, see models/Folder.js).
|
|
||||||
async function mapFolders(campaignId) {
|
|
||||||
return Folder.find({ campaign: campaignId, target: 'map' })
|
|
||||||
.select('_id name parentFolder date color')
|
|
||||||
.sort({ date: -1 })
|
|
||||||
.lean();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Grid values arrive as strings when the request is a multipart form upload.
|
// Grid values arrive as strings when the request is a multipart form upload.
|
||||||
function toNumber(value, fallback) {
|
function toNumber(value, fallback) {
|
||||||
if (value === undefined || value === null || value === '') return fallback;
|
if (value === undefined || value === null || value === '') return fallback;
|
||||||
@@ -37,7 +25,7 @@ router.get('/list', async (req, res) => {
|
|||||||
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
|
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
|
||||||
res.json({ status: 'ok', maps, folders: await mapFolders(campaign) });
|
res.json({ status: 'ok', maps });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
@@ -67,22 +55,13 @@ router.post('/create', upload.single('image'), async (req, res) => {
|
|||||||
|
|
||||||
router.post('/update', upload.single('image'), async (req, res) => {
|
router.post('/update', upload.single('image'), async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id, name, gridSize, offsetX, offsetY, scale, folder } = req.body;
|
const { id, name, gridSize, offsetX, offsetY, scale } = req.body;
|
||||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
const map = await Map.findById(id);
|
const map = await Map.findById(id);
|
||||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
// `null` moves the map to the root of the map list, an id files it in one of this
|
|
||||||
// campaign's map folders; anything else is refused.
|
|
||||||
if (folder !== undefined) {
|
|
||||||
if (!(await Folder.belongsToSection(folder || null, map.campaign, 'map'))) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
}
|
|
||||||
map.folder = folder || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (name !== undefined) map.name = String(name).trim();
|
if (name !== undefined) map.name = String(name).trim();
|
||||||
if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
|
if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
|
||||||
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
|
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
|
||||||
@@ -113,330 +92,4 @@ router.post('/delete', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// A pin is a note placed at a spot of the map, in image pixels, and so is the centre of a token.
|
|
||||||
// Coordinates arrive as strings with multipart requests and are never negative: the viewer clamps
|
|
||||||
// them to the image already.
|
|
||||||
function toCoordinate(value) {
|
|
||||||
const number = Number(value);
|
|
||||||
if (!Number.isFinite(number)) return 0;
|
|
||||||
return Math.max(0, Math.round(number));
|
|
||||||
}
|
|
||||||
|
|
||||||
router.post('/pin', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, note, x, y } = req.body;
|
|
||||||
if (!id || !note) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const map = await Map.findById(id);
|
|
||||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
// Only a note of the same campaign can be pinned onto one of its maps.
|
|
||||||
const noteDoc = await Note.findOne({ _id: note, campaign: map.campaign }).select('_id').lean();
|
|
||||||
if (!noteDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
|
|
||||||
// A note is pinned once per map: pinning it again moves the marker instead of adding a twin.
|
|
||||||
const pin = map.pins.find((current) => String(current.note) === String(note));
|
|
||||||
if (pin) {
|
|
||||||
pin.x = toCoordinate(x);
|
|
||||||
pin.y = toCoordinate(y);
|
|
||||||
} else {
|
|
||||||
map.pins.push({ note, x: toCoordinate(x), y: toCoordinate(y) });
|
|
||||||
}
|
|
||||||
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/unpin', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, pin } = req.body;
|
|
||||||
if (!id || !pin) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const map = await Map.findById(id);
|
|
||||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
// `_id` stays with the pins that remain: the viewer removes them by that id.
|
|
||||||
map.pins = map.pins
|
|
||||||
.filter((current) => String(current._id) !== String(pin))
|
|
||||||
.map((current) => ({ _id: current._id, note: current.note, x: current.x, y: current.y }));
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// A token is an actor standing on the map, at the middle of a grid cell. Anywhere it is dropped in a
|
|
||||||
// cell lands it in that cell, whatever the grid is drawn from: same rounding as the viewer does while
|
|
||||||
// it drags, so the token does not jump when the move is saved.
|
|
||||||
function toCellCoordinate(value, size, offset) {
|
|
||||||
const grid = Math.max(1, Number(size) || 50);
|
|
||||||
const origin = Number(offset) || 0;
|
|
||||||
const cell = Math.floor((toCoordinate(value) - origin) / grid);
|
|
||||||
return Math.max(0, Math.round(origin + (cell + 0.5) * grid));
|
|
||||||
}
|
|
||||||
|
|
||||||
router.post('/place-token', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, actor, x, y } = req.body;
|
|
||||||
if (!id || !actor) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const map = await Map.findById(id);
|
|
||||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
// Only an actor of the same campaign can stand on one of its maps.
|
|
||||||
const actorDoc = await Actor.findOne({ _id: actor, campaign: map.campaign }).select('_id').lean();
|
|
||||||
if (!actorDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
|
|
||||||
// An actor stands on a map once: placing it again moves its token instead of adding a twin.
|
|
||||||
const token = map.tokens.find((current) => String(current.actor) === String(actor));
|
|
||||||
const spot = {
|
|
||||||
x: toCellCoordinate(x, map.gridSize, map.offsetX),
|
|
||||||
y: toCellCoordinate(y, map.gridSize, map.offsetY)
|
|
||||||
};
|
|
||||||
if (token) {
|
|
||||||
token.x = spot.x;
|
|
||||||
token.y = spot.y;
|
|
||||||
} else {
|
|
||||||
map.tokens.push({ actor, ...spot });
|
|
||||||
}
|
|
||||||
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/remove-token', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, token } = req.body;
|
|
||||||
if (!id || !token) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const map = await Map.findById(id);
|
|
||||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
// `_id` stays with the tokens that remain, the same way the pins are removed.
|
|
||||||
map.tokens = map.tokens
|
|
||||||
.filter((current) => String(current._id) !== String(token))
|
|
||||||
.map((current) => ({ _id: current._id, actor: current.actor, x: current.x, y: current.y }));
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// --- Lights ---
|
|
||||||
// A light shines from one spot of the image and is as free as a pin: it is not tied to a cell, so it
|
|
||||||
// lands wherever it is placed. Its reach is measured in image pixels too, so it covers the same ground
|
|
||||||
// whatever the zoom is, and it is that reach the viewer cuts its shadow against the walls below with.
|
|
||||||
|
|
||||||
// How far a light of the map reaches when nothing is asked for: about three cells of the default grid.
|
|
||||||
const DEFAULT_LIGHT_RADIUS = 150;
|
|
||||||
|
|
||||||
function toReach(value, fallback) {
|
|
||||||
const number = Number(value);
|
|
||||||
if (!Number.isFinite(number) || number <= 0) return fallback;
|
|
||||||
return Math.max(1, Math.round(number));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The bright core of a light: never wider than the light itself, and never negative. A light with no
|
|
||||||
// core is still a light, so 0 is a value of its own here and not a missing one.
|
|
||||||
function toBright(value, radius, fallback) {
|
|
||||||
if (value === undefined || value === null || value === '') return Math.min(radius, Math.round(fallback));
|
|
||||||
const number = Number(value);
|
|
||||||
if (!Number.isFinite(number)) return Math.min(radius, Math.round(fallback));
|
|
||||||
return Math.max(0, Math.min(radius, Math.round(number)));
|
|
||||||
}
|
|
||||||
|
|
||||||
// A tint is a hex colour and nothing else: the viewer paints the light with it, so a value carrying
|
|
||||||
// more than colour codes is dropped instead of trusted.
|
|
||||||
function toColor(value) {
|
|
||||||
const color = String(value ?? '').trim().toLowerCase();
|
|
||||||
return /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/.test(color) ? color : '';
|
|
||||||
}
|
|
||||||
|
|
||||||
router.post('/place-light', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, x, y, radius, bright, color } = 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' });
|
|
||||||
|
|
||||||
const reach = toReach(radius, DEFAULT_LIGHT_RADIUS);
|
|
||||||
map.lights.push({
|
|
||||||
x: toCoordinate(x),
|
|
||||||
y: toCoordinate(y),
|
|
||||||
radius: reach,
|
|
||||||
bright: toBright(bright, reach, reach / 2),
|
|
||||||
color: toColor(color)
|
|
||||||
});
|
|
||||||
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/update-light', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, light, x, y, radius, bright, color } = req.body;
|
|
||||||
if (!id || !light) 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 current = map.lights.find((entry) => String(entry._id) === String(light));
|
|
||||||
if (!current) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
|
|
||||||
if (x !== undefined) current.x = toCoordinate(x);
|
|
||||||
if (y !== undefined) current.y = toCoordinate(y);
|
|
||||||
if (color !== undefined) current.color = toColor(color);
|
|
||||||
if (radius !== undefined) {
|
|
||||||
current.radius = toReach(radius, current.radius);
|
|
||||||
// A light shrunk below its own core takes the core with it, unless this request is
|
|
||||||
// setting the core as well, which is clamped to the new reach below.
|
|
||||||
current.bright = Math.min(current.bright, current.radius);
|
|
||||||
}
|
|
||||||
if (bright !== undefined) current.bright = toBright(bright, current.radius, current.bright);
|
|
||||||
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/remove-light', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, light } = req.body;
|
|
||||||
if (!id || !light) 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 lights that remain, the same way the tokens are removed.
|
|
||||||
map.lights = map.lights
|
|
||||||
.filter((entry) => String(entry._id) !== String(light))
|
|
||||||
.map((entry) => ({
|
|
||||||
_id: entry._id,
|
|
||||||
x: entry.x,
|
|
||||||
y: entry.y,
|
|
||||||
radius: entry.radius,
|
|
||||||
bright: entry.bright,
|
|
||||||
color: entry.color,
|
|
||||||
foundryLightId: entry.foundryLightId
|
|
||||||
}));
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// --- Walls ---
|
|
||||||
// The segments that stop a light. They are drawn from one corner of the grid to another — the same
|
|
||||||
// corners the tokens' cells are counted from — so a wall lines up with the grid of the map it belongs
|
|
||||||
// to. A world's walls travel to the map they light (routes/foundry-link.js) and arrive at the corners
|
|
||||||
// of the grid the same way.
|
|
||||||
|
|
||||||
function toGridVertex(value, offset, size) {
|
|
||||||
const grid = Math.max(1, Number(size) || 50);
|
|
||||||
const origin = Number(offset) || 0;
|
|
||||||
const steps = Math.round((toCoordinate(value) - origin) / grid);
|
|
||||||
return Math.max(0, Math.round(origin + steps * grid));
|
|
||||||
}
|
|
||||||
|
|
||||||
// The two ends of a wall are corners of this map's grid, whatever the pointer asked for.
|
|
||||||
function wallCorners(body, map) {
|
|
||||||
return {
|
|
||||||
x1: toGridVertex(body.x1, map.offsetX, map.gridSize),
|
|
||||||
y1: toGridVertex(body.y1, map.offsetY, map.gridSize),
|
|
||||||
x2: toGridVertex(body.x2, map.offsetX, map.gridSize),
|
|
||||||
y2: toGridVertex(body.y2, map.offsetY, map.gridSize)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function isSameWall(wall, corner) {
|
|
||||||
return (String(wall.x1) === String(corner.x1) && String(wall.y1) === String(corner.y1)
|
|
||||||
&& String(wall.x2) === String(corner.x2) && String(wall.y2) === String(corner.y2))
|
|
||||||
// A wall drawn backwards is the same wall.
|
|
||||||
|| (String(wall.x1) === String(corner.x2) && String(wall.y1) === String(corner.y2)
|
|
||||||
&& String(wall.x2) === String(corner.x1) && String(wall.y2) === String(corner.y1));
|
|
||||||
}
|
|
||||||
|
|
||||||
router.post('/wall', 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' });
|
|
||||||
|
|
||||||
const corner = wallCorners(req.body, map);
|
|
||||||
// A wall from a corner to itself blocks nothing and cannot be clicked off again.
|
|
||||||
if (corner.x1 === corner.x2 && corner.y1 === corner.y2) {
|
|
||||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
}
|
|
||||||
// Drawing over a wall that is already there does not add a second one.
|
|
||||||
if (map.walls.some((wall) => isSameWall(wall, corner))) return res.json({ status: 'ok', map });
|
|
||||||
|
|
||||||
map.walls.push(corner);
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/remove-wall', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { id, wall } = req.body;
|
|
||||||
if (!id || !wall) 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 walls that remain, like everything else hanging off a map.
|
|
||||||
map.walls = map.walls
|
|
||||||
.filter((entry) => String(entry._id) !== String(wall))
|
|
||||||
.map((entry) => ({
|
|
||||||
_id: entry._id,
|
|
||||||
x1: entry.x1,
|
|
||||||
y1: entry.y1,
|
|
||||||
x2: entry.x2,
|
|
||||||
y2: entry.y2,
|
|
||||||
foundryWallId: entry.foundryWallId
|
|
||||||
}));
|
|
||||||
await map.save();
|
|
||||||
res.json({ status: 'ok', map });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
module.exports = router;
|
module.exports = router;
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ const router = express.Router();
|
|||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Note = require('../models/Note');
|
const Note = require('../models/Note');
|
||||||
const Folder = require('../models/Folder');
|
const Folder = require('../models/Folder');
|
||||||
const Map = require('../models/Map');
|
|
||||||
|
|
||||||
async function userOwnsCampaign(campaignId, userId) {
|
async function userOwnsCampaign(campaignId, userId) {
|
||||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||||
@@ -19,9 +18,7 @@ router.get('/list', async (req, res) => {
|
|||||||
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
||||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
// The note tree only: the folders of the actors, items and maps share this model
|
const folders = await Folder.find({ 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')
|
.select('_id name parentFolder date color')
|
||||||
.sort({ date: -1 })
|
.sort({ date: -1 })
|
||||||
.lean();
|
.lean();
|
||||||
@@ -50,7 +47,7 @@ router.get('/subfolder/list', async (req, res) => {
|
|||||||
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
|
const folderDoc = await Folder.findOne({ _id: folder, campaign }).lean();
|
||||||
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (!folderDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
const subfolders = await Folder.find({ campaign, parentFolder: folder, ...Folder.filterForTarget('note') })
|
const subfolders = await Folder.find({ campaign, parentFolder: folder })
|
||||||
.select('_id name date color')
|
.select('_id name date color')
|
||||||
.sort({ date: -1 })
|
.sort({ date: -1 })
|
||||||
.lean();
|
.lean();
|
||||||
@@ -67,49 +64,6 @@ router.get('/subfolder/list', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Every note of the campaign, folders included, without their content: enough to offer a note
|
|
||||||
// picker and to label the pins other screens put on a map.
|
|
||||||
router.get('/all', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const { campaign } = req.query;
|
|
||||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
|
||||||
|
|
||||||
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
|
|
||||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
const notes = await Note.find({ campaign })
|
|
||||||
.select('_id title folder date')
|
|
||||||
.sort({ title: 1 })
|
|
||||||
.lean();
|
|
||||||
|
|
||||||
const folders = await Folder.find({ campaign, ...Folder.filterForTarget('note') })
|
|
||||||
.select('_id name parentFolder')
|
|
||||||
.lean();
|
|
||||||
|
|
||||||
res.json({ status: 'ok', notes, folders });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// One note with its content, for the screens that show a note on their own (a map pin, for
|
|
||||||
// instance) instead of from the sidebar's note list.
|
|
||||||
router.get('/retrieve/:id', async (req, res) => {
|
|
||||||
try {
|
|
||||||
const note = await Note.findById(req.params.id).lean();
|
|
||||||
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
|
|
||||||
|
|
||||||
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
|
|
||||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
|
||||||
|
|
||||||
res.json({ status: 'ok', note });
|
|
||||||
} catch (err) {
|
|
||||||
console.error(err);
|
|
||||||
res.json({ status: 'error', msg: 'errors.internal' });
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
router.post('/create', async (req, res) => {
|
router.post('/create', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { title, content, campaign, folder } = req.body;
|
const { title, content, campaign, folder } = req.body;
|
||||||
@@ -165,9 +119,6 @@ router.post('/delete', async (req, res) => {
|
|||||||
const result = await Note.deleteOne({ _id: id });
|
const result = await Note.deleteOne({ _id: id });
|
||||||
if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' });
|
if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
// A pin pointing at a note that is gone would open nothing: drop those along with the note.
|
|
||||||
await Map.updateMany({ 'pins.note': id }, { $pull: { pins: { note: id } } });
|
|
||||||
|
|
||||||
res.json({ status: 'ok' });
|
res.json({ status: 'ok' });
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
|
|||||||
@@ -1,209 +0,0 @@
|
|||||||
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, remember } = req.body;
|
const { usermail, password } = 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,8 +132,7 @@ router.post('/login', rateLimitMiddleware, async (req, res) => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const token = await new Promise((resolve, reject) => {
|
const token = await new Promise((resolve, reject) => {
|
||||||
// "Remember me" keeps the session alive on the device for 30 days, a plain login lasts 48 h
|
jwt.sign(payload, secret, { expiresIn: 172800 }, (err, token) => {
|
||||||
jwt.sign(payload, secret, { expiresIn: remember ? 2592000 : 172800 }, (err, token) => {
|
|
||||||
if (err) reject(err);
|
if (err) reject(err);
|
||||||
else resolve(token);
|
else resolve(token);
|
||||||
});
|
});
|
||||||
@@ -193,113 +192,4 @@ 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;
|
||||||
@@ -1,134 +1,4 @@
|
|||||||
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
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) {
|
function foundryActorToCharacter(foundryActor) {
|
||||||
const system = foundryActor.system || {};
|
const system = foundryActor.system || {};
|
||||||
@@ -150,61 +20,37 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
...stringList(traits.tool?.value)
|
...stringList(traits.tool?.value)
|
||||||
].join(', ');
|
].join(', ');
|
||||||
|
|
||||||
const fields = {
|
return {
|
||||||
name: asText(foundryActor.name).trim(),
|
name: asText(foundryActor.name).trim(),
|
||||||
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
||||||
? savedDragonrollType
|
? savedDragonrollType
|
||||||
: (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'),
|
: (['character', 'npc', 'creature'].includes(foundryActor.type) ? foundryActor.type : 'character'),
|
||||||
species: detailsName(details.race || details.species, items),
|
species: asText(details.race || details.species),
|
||||||
className: detailsName(details.class, items) || asText(classItem?.name),
|
className: asText(details.class || classItem?.name),
|
||||||
subclass: detailsName(details.subclass, items) || asText(subclassItem?.name),
|
subclass: asText(details.subclass || subclassItem?.name),
|
||||||
level: numberOr(details.level ?? classItem?.system?.levels, 1),
|
level: numberOr(details.level ?? classItem?.system?.levels, 1),
|
||||||
background: detailsName(details.background, items) || asText(backgroundItem?.name),
|
background: asText(details.background || backgroundItem?.name),
|
||||||
challengeRating: String(details.cr ?? ''),
|
challengeRating: String(details.cr ?? ''),
|
||||||
description: plainText(details.biography?.value || details.biography),
|
description: plainText(details.biography?.value || details.biography),
|
||||||
image: asText(foundryActor.img || foundryActor.image),
|
image: asText(foundryActor.img || foundryActor.image),
|
||||||
abilityScores: Object.fromEntries(ABILITIES.map((key) => [
|
abilityScores: Object.fromEntries(['str', 'dex', 'con', 'int', 'wis', 'cha'].map((key) => [
|
||||||
key,
|
key,
|
||||||
numberOr(abilities[key]?.value, 10)
|
numberOr(abilities[key]?.value, 10)
|
||||||
])),
|
])),
|
||||||
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
||||||
speed: numberOr(movement.walk ?? movement.value, 30),
|
speed: numberOr(movement.walk ?? movement.value, 30),
|
||||||
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
||||||
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
traits: asText(savedDragonrollFields.traits),
|
||||||
// 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
|
inventory: items
|
||||||
.filter((item) => isFoundryGearType(item.type))
|
.filter((item) => !['class', 'subclass', 'background', 'spell'].includes(item.type))
|
||||||
.map((item) => ({
|
.map((item) => ({
|
||||||
name: asText(item.name).trim(),
|
name: asText(item.name).trim(),
|
||||||
quantity: numberOr(item.system?.quantity, 1),
|
quantity: numberOr(item.system?.quantity, 1),
|
||||||
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0),
|
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0)
|
||||||
icon: asText(item.img).trim()
|
|
||||||
}))
|
}))
|
||||||
.filter((item) => item.name),
|
.filter((item) => item.name),
|
||||||
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
|
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 };
|
module.exports = { foundryActorToCharacter };
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
// 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
|
|
||||||
};
|
|
||||||
@@ -1,11 +1,5 @@
|
|||||||
async function requestFoundry(path) {
|
async function requestFoundry(path) {
|
||||||
// The bridge a campaign's icon and world reads go to is the very one that
|
const baseUrl = process.env.FOUNDRY_API_URL;
|
||||||
// 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;
|
const token = process.env.FOUNDRY_API_TOKEN;
|
||||||
|
|
||||||
if (!baseUrl || !token) {
|
if (!baseUrl || !token) {
|
||||||
|
|||||||
@@ -23,14 +23,6 @@ const NON_GEAR_FOUNDRY_TYPES = new Set([
|
|||||||
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
|
'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.
|
// Item categories the Dragonroll Item model accepts.
|
||||||
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
||||||
|
|
||||||
@@ -109,10 +101,8 @@ function foundryItemToItemData(foundryItem) {
|
|||||||
quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))),
|
quantity: Math.max(1, Math.trunc(numberOr(system.quantity, 1))),
|
||||||
weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)),
|
weight: Math.max(0, numberOr(system.weight?.value ?? system.weight, 0)),
|
||||||
properties: foundryItemProperties(foundryItem),
|
properties: foundryItemProperties(foundryItem),
|
||||||
description: plainText(system.description?.value ?? system.description),
|
description: plainText(system.description?.value ?? system.description)
|
||||||
// The module sends Foundry's icon as an absolute URL, like actors do.
|
|
||||||
image: asText(foundryItem.img || foundryItem.image)
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { foundryItemToItemData, isFoundryGearType };
|
module.exports = { foundryItemToItemData };
|
||||||
|
|||||||
@@ -1,254 +0,0 @@
|
|||||||
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
|
|
||||||
};
|
|
||||||
@@ -1,30 +1,21 @@
|
|||||||
# 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 the workspace manifests first (better caching)
|
# Copy package files first (better caching)
|
||||||
COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
|
COPY 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
|
# Install dependencies
|
||||||
RUN pnpm install --frozen-lockfile --prod --filter ./discord-bot...
|
RUN npm ci --only=production
|
||||||
|
|
||||||
# Copy application source
|
# Copy application source
|
||||||
COPY discord-bot ./discord-bot
|
COPY . .
|
||||||
|
|
||||||
# Environment variable
|
# Environment variable
|
||||||
ENV NODE_ENV=production
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
# The bot reads .env from its working directory
|
|
||||||
WORKDIR /usr/src/app/discord-bot
|
|
||||||
|
|
||||||
# The bot only makes outbound connections (Discord gateway + Dragonroll API),
|
# The bot only makes outbound connections (Discord gateway + Dragonroll API),
|
||||||
# it does not listen on a port.
|
# it does not listen on a port.
|
||||||
# Start the application
|
# Start the application
|
||||||
|
|||||||
@@ -13,14 +13,12 @@ Discord server B ──link──▶ Dragonroll campaign "Silang" (account g
|
|||||||
|
|
||||||
## Commands
|
## 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.
|
- `/characters [type]` lists the linked campaign's actors, optionally filtered to characters, NPCs, or creatures.
|
||||||
- `/character name public:true` shows the matching actor's portrait (when one has been uploaded), profile, ability scores, combat stats, proficiencies, traits, spells, and inventory. Type part of a name to pick it from the campaign's current roster. Set `public` to `true` to show the reply to everyone in the channel.
|
- `/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 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 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 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 status` shows the campaign linked to this server.
|
||||||
- `/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.
|
- `/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.
|
Replies are private by default. `/character` can be made public with its `public` option, so everyone in the channel can see the character sheet.
|
||||||
|
|||||||
327
discord-bot/package-lock.json
generated
Normal file
327
discord-bot/package-lock.json
generated
Normal file
@@ -0,0 +1,327 @@
|
|||||||
|
{
|
||||||
|
"name": "dragonroll-discord-bot",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"name": "dragonroll-discord-bot",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"dependencies": {
|
||||||
|
"discord.js": "^14.27.0",
|
||||||
|
"dotenv": "^17.2.3"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=20"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/builders": {
|
||||||
|
"version": "1.14.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-1.14.1.tgz",
|
||||||
|
"integrity": "sha512-gSKkhXLqs96TCzk66VZuHHl8z2bQMJFGwrXC0f33ngK+FLNau4hU1PYny3DNJfNdSH+gVMzE85/d5FQ2BpcNwQ==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@discordjs/formatters": "^0.6.2",
|
||||||
|
"@discordjs/util": "^1.2.0",
|
||||||
|
"@sapphire/shapeshift": "^4.0.0",
|
||||||
|
"discord-api-types": "^0.38.40",
|
||||||
|
"fast-deep-equal": "^3.1.3",
|
||||||
|
"ts-mixer": "^6.0.4",
|
||||||
|
"tslib": "^2.6.3"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16.11.0"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/collection": {
|
||||||
|
"version": "1.5.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-1.5.3.tgz",
|
||||||
|
"integrity": "sha512-SVb428OMd3WO1paV3rm6tSjM4wC+Kecaa1EUGX7vc6/fddvw/6lg90z4QtCqm21zvVe92vMMDt9+DkIvjXImQQ==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16.11.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/formatters": {
|
||||||
|
"version": "0.6.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/formatters/-/formatters-0.6.2.tgz",
|
||||||
|
"integrity": "sha512-y4UPwWhH6vChKRkGdMB4odasUbHOUwy7KL+OVwF86PvT6QVOwElx+TiI1/6kcmcEe+g5YRXJFiXSXUdabqZOvQ==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"discord-api-types": "^0.38.33"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16.11.0"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/rest": {
|
||||||
|
"version": "2.6.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/rest/-/rest-2.6.3.tgz",
|
||||||
|
"integrity": "sha512-wvOylxNYJkwKjctS/Mn5GP1w9r3/rzyH+ThD1JlAca6zEdlHs8QWBBUQJpU5Q+W6DoIj/Ljh1IPlZs7hTU+UAg==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@discordjs/collection": "^2.1.1",
|
||||||
|
"@discordjs/util": "^1.2.0",
|
||||||
|
"@sapphire/async-queue": "^1.5.3",
|
||||||
|
"@sapphire/snowflake": "^3.5.5",
|
||||||
|
"@vladfrangu/async_event_emitter": "^2.4.6",
|
||||||
|
"discord-api-types": "^0.38.50",
|
||||||
|
"magic-bytes.js": "^1.13.0",
|
||||||
|
"tslib": "^2.6.3",
|
||||||
|
"undici": "^6.27.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/rest/node_modules/@discordjs/collection": {
|
||||||
|
"version": "2.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-2.1.1.tgz",
|
||||||
|
"integrity": "sha512-LiSusze9Tc7qF03sLCujF5iZp7K+vRNEDBZ86FT9aQAv3vxMLihUvKvpsCWiQ2DJq1tVckopKm1rxomgNUc9hg==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/util": {
|
||||||
|
"version": "1.2.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/util/-/util-1.2.0.tgz",
|
||||||
|
"integrity": "sha512-3LKP7F2+atl9vJFhaBjn4nOaSWahZ/yWjOvA4e5pnXkt2qyXRCHLxoBQy81GFtLGCq7K9lPm9R517M1U+/90Qg==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"discord-api-types": "^0.38.33"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/ws": {
|
||||||
|
"version": "1.2.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/ws/-/ws-1.2.3.tgz",
|
||||||
|
"integrity": "sha512-wPlQDxEmlDg5IxhJPuxXr3Vy9AjYq5xCvFWGJyD7w7Np8ZGu+Mc+97LCoEc/+AYCo2IDpKioiH0/c/mj5ZR9Uw==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@discordjs/collection": "^2.1.0",
|
||||||
|
"@discordjs/rest": "^2.5.1",
|
||||||
|
"@discordjs/util": "^1.1.0",
|
||||||
|
"@sapphire/async-queue": "^1.5.2",
|
||||||
|
"@types/ws": "^8.5.10",
|
||||||
|
"@vladfrangu/async_event_emitter": "^2.2.4",
|
||||||
|
"discord-api-types": "^0.38.1",
|
||||||
|
"tslib": "^2.6.2",
|
||||||
|
"ws": "^8.17.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=16.11.0"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@discordjs/ws/node_modules/@discordjs/collection": {
|
||||||
|
"version": "2.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-2.1.1.tgz",
|
||||||
|
"integrity": "sha512-LiSusze9Tc7qF03sLCujF5iZp7K+vRNEDBZ86FT9aQAv3vxMLihUvKvpsCWiQ2DJq1tVckopKm1rxomgNUc9hg==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@sapphire/async-queue": {
|
||||||
|
"version": "1.5.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/@sapphire/async-queue/-/async-queue-1.5.5.tgz",
|
||||||
|
"integrity": "sha512-cvGzxbba6sav2zZkH8GPf2oGk9yYoD5qrNWdu9fRehifgnFZJMV+nuy2nON2roRO4yQQ+v7MK/Pktl/HgfsUXg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=v14.0.0",
|
||||||
|
"npm": ">=7.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@sapphire/shapeshift": {
|
||||||
|
"version": "4.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@sapphire/shapeshift/-/shapeshift-4.0.0.tgz",
|
||||||
|
"integrity": "sha512-d9dUmWVA7MMiKobL3VpLF8P2aeanRTu6ypG2OIaEv/ZHH/SUQ2iHOVyi5wAPjQ+HmnMuL0whK9ez8I/raWbtIg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"fast-deep-equal": "^3.1.3",
|
||||||
|
"lodash": "^4.17.21"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=v16"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@sapphire/snowflake": {
|
||||||
|
"version": "3.5.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/@sapphire/snowflake/-/snowflake-3.5.5.tgz",
|
||||||
|
"integrity": "sha512-xzvBr1Q1c4lCe7i6sRnrofxeO1QTP/LKQ6A6qy0iB4x5yfiSfARMEQEghojzTNALDTcv8En04qYNIco9/K9eZQ==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=v14.0.0",
|
||||||
|
"npm": ">=7.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/node": {
|
||||||
|
"version": "26.6.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-26.6.5.tgz",
|
||||||
|
"integrity": "sha512-uMzsv9stDdofIZBx4UGh4Z9ZgXnGC9seRDscilBcTHAeOFk67MZg/k9bWVfO+bk4qZmG+l52hRnLwUiH2LnJTg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"undici-types": "~8.9.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/ws": {
|
||||||
|
"version": "8.18.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.2.tgz",
|
||||||
|
"integrity": "sha512-67MQl+fpWKVTT1NYdnmo3U4sc/xPo/zQBncVnI74qmQa0z/b+1g6iYqNmGCPbxO+zz2aklb08a0oHfegiVd0/w==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@types/node": "*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@vladfrangu/async_event_emitter": {
|
||||||
|
"version": "2.4.7",
|
||||||
|
"resolved": "https://registry.npmjs.org/@vladfrangu/async_event_emitter/-/async_event_emitter-2.4.7.tgz",
|
||||||
|
"integrity": "sha512-Xfe6rpCTxSxfbswi/W/Pz7zp1WWSNn4A0eW4mLkQUewCrXXtMj31lCg+iQyTkh/CkusZSq9eDflu7tjEDXUY6g==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=v14.0.0",
|
||||||
|
"npm": ">=7.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/discord-api-types": {
|
||||||
|
"version": "0.38.56",
|
||||||
|
"resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.38.56.tgz",
|
||||||
|
"integrity": "sha512-Hti4RZsGvF5C7SM8rF2MDHtIm0Hyfrlk84GpEA29nj91tvVVMvX+oQSCodu10t2ZcjFGofq8TX0YyC04B2E69Q==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/discord.js": {
|
||||||
|
"version": "14.27.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/discord.js/-/discord.js-14.27.0.tgz",
|
||||||
|
"integrity": "sha512-qHbFlFG2N7y3LjPySYsL6A1+BnX6bkTVgo842EX0CqVPk/KTMwZkojPHEXKsQUpWZNyz5BISNHK1cPpQw0+m4A==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@discordjs/builders": "^1.14.1",
|
||||||
|
"@discordjs/collection": "1.5.3",
|
||||||
|
"@discordjs/formatters": "^0.6.2",
|
||||||
|
"@discordjs/rest": "^2.6.2",
|
||||||
|
"@discordjs/util": "^1.2.0",
|
||||||
|
"@discordjs/ws": "^1.2.3",
|
||||||
|
"@sapphire/snowflake": "3.5.5",
|
||||||
|
"discord-api-types": "^0.38.49",
|
||||||
|
"fast-deep-equal": "3.1.3",
|
||||||
|
"lodash.snakecase": "4.1.1",
|
||||||
|
"magic-bytes.js": "^1.13.0",
|
||||||
|
"tslib": "^2.6.3",
|
||||||
|
"undici": "^6.27.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/discordjs/discord.js?sponsor"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/dotenv": {
|
||||||
|
"version": "17.4.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.4.2.tgz",
|
||||||
|
"integrity": "sha512-nI4U3TottKAcAD9LLud4Cb7b2QztQMUEfHbvhTH09bqXTxnSie8WnjPALV/WMCrJZ6UV/qHJ6L03OqO3LcdYZw==",
|
||||||
|
"license": "BSD-2-Clause",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=12"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://dotenvx.com"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/fast-deep-equal": {
|
||||||
|
"version": "3.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
|
||||||
|
"integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/lodash": {
|
||||||
|
"version": "4.18.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz",
|
||||||
|
"integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/lodash.snakecase": {
|
||||||
|
"version": "4.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash.snakecase/-/lodash.snakecase-4.1.1.tgz",
|
||||||
|
"integrity": "sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/magic-bytes.js": {
|
||||||
|
"version": "1.13.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/magic-bytes.js/-/magic-bytes.js-1.13.1.tgz",
|
||||||
|
"integrity": "sha512-x5sn4UX2k5gCWlcfmoFwG4TPie8+dctESyqOBdhB5p6MsgWXdBKGmt9nXPObj/JI50TTL928lc5Yt1WntMn1bw==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/ts-mixer": {
|
||||||
|
"version": "6.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/ts-mixer/-/ts-mixer-6.0.4.tgz",
|
||||||
|
"integrity": "sha512-ufKpbmrugz5Aou4wcr5Wc1UUFWOLhq+Fm6qa6P0w0K5Qw2yhaUoiWszhCVuNQyNwrlGiscHOmqYoAox1PtvgjA==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/tslib": {
|
||||||
|
"version": "2.8.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
|
||||||
|
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
|
||||||
|
"license": "0BSD"
|
||||||
|
},
|
||||||
|
"node_modules/undici": {
|
||||||
|
"version": "6.29.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/undici/-/undici-6.29.0.tgz",
|
||||||
|
"integrity": "sha512-R+RODBqp6i2pPflGdq+xIOUkl+RNfGgHwoinecKu/JCuf2uO06cOKoDbI2P7Dn6KcswdKwrczbU6IYJ6K8X+wg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.17"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/undici-types": {
|
||||||
|
"version": "8.9.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-8.9.0.tgz",
|
||||||
|
"integrity": "sha512-KTDyRTYX8sWmKXAikPHHSyc63CRPETMctyjKFupcC6OBLXT3xsN0e9aF7m+mIXutFWpUXuedtowG7iLOzp0kQg==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/ws": {
|
||||||
|
"version": "8.22.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/ws/-/ws-8.22.0.tgz",
|
||||||
|
"integrity": "sha512-Ydggc987+RO0AnWtZ/7Wq9FtNvcrL1b/RO0ud9mWjUPgDrsAAwQSF51sm2hm1XofbU/4jkpGEsLFsZZxU+1DOg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=10.0.0"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"bufferutil": "^4.0.1",
|
||||||
|
"utf-8-validate": ">=5.0.2"
|
||||||
|
},
|
||||||
|
"peerDependenciesMeta": {
|
||||||
|
"bufferutil": {
|
||||||
|
"optional": true
|
||||||
|
},
|
||||||
|
"utf-8-validate": {
|
||||||
|
"optional": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -51,24 +51,7 @@ const commands = [
|
|||||||
.setDescription('Show the campaign linked to this server.'))
|
.setDescription('Show the campaign linked to this server.'))
|
||||||
.addSubcommand((subcommand) => subcommand
|
.addSubcommand((subcommand) => subcommand
|
||||||
.setName('refresh')
|
.setName('refresh')
|
||||||
.setDescription('Refresh this server’s Dragonroll connection status.'))
|
.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;
|
module.exports = commands;
|
||||||
|
|||||||
@@ -47,23 +47,11 @@ function createDragonrollApi(config) {
|
|||||||
return payload;
|
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) {
|
async function startAuthorization(guildId, guildName, discordUserId, discordUserName) {
|
||||||
const payload = await request('/link/start', {
|
return request('/discord/link/start', {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
body: JSON.stringify({
|
body: JSON.stringify({ guildId, guildName, discordUserId, discordUserName })
|
||||||
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() {
|
async function claimLinkNotifications() {
|
||||||
@@ -123,32 +111,7 @@ function createDragonrollApi(config) {
|
|||||||
return { campaign, actors: payload.actors };
|
return { campaign, actors: payload.actors };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Linking players to characters (Syndria98/dragonroll#72). `admin` says
|
return { startAuthorization, claimLinkNotifications, getStatus, getCampaign, listCampaigns, linkCampaign, unlinkCampaign, listActors };
|
||||||
// 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 };
|
module.exports = { createDragonrollApi, CampaignNotLinkedError, DragonrollNotConnectedError };
|
||||||
|
|||||||
@@ -234,20 +234,6 @@ async function main() {
|
|||||||
: 'Not linked yet.' }
|
: '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) {
|
if (!status.connected) {
|
||||||
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
|
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
|
||||||
} else if (!status.campaign) {
|
} else if (!status.campaign) {
|
||||||
@@ -257,78 +243,6 @@ async function main() {
|
|||||||
await respond(interaction, { embeds: [embed] });
|
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) => {
|
client.once(Events.ClientReady, (readyClient) => {
|
||||||
console.log(`Dragonroll character bot is online as ${readyClient.user.tag}, in ${readyClient.guilds.cache.size} servers.`);
|
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
|
// Guild commands registered when the bot joined shadow global ones and
|
||||||
@@ -417,16 +331,9 @@ async function main() {
|
|||||||
await respondActorChoices(interaction, guildId);
|
await respondActorChoices(interaction, guildId);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (interaction.commandName === 'dragonroll') {
|
if (interaction.commandName === 'dragonroll' && interaction.options.getSubcommand() === 'link') {
|
||||||
const subcommand = interaction.options.getSubcommand();
|
await respondCampaignChoices(interaction, guildId);
|
||||||
if (subcommand === 'link') {
|
return;
|
||||||
await respondCampaignChoices(interaction, guildId);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (['assign', 'unassign'].includes(subcommand)) {
|
|
||||||
await respondActorChoices(interaction, guildId);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -505,34 +412,6 @@ async function main() {
|
|||||||
return;
|
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 interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
await showStatus(interaction, guildId);
|
await showStatus(interaction, guildId);
|
||||||
return;
|
return;
|
||||||
@@ -563,10 +442,7 @@ async function main() {
|
|||||||
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
|
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
|
||||||
.filter(Boolean)
|
.filter(Boolean)
|
||||||
.join(' · ');
|
.join(' · ');
|
||||||
// The player a character is linked to (#72); mentions never ping
|
return `• **${actor.name}**${details ? ` — ${details}` : ''}`;
|
||||||
// here, the replies parse no mentions.
|
|
||||||
const player = actor.discordUserId ? ` 🎮 <@${actor.discordUserId}>` : '';
|
|
||||||
return `• **${actor.name}**${details ? ` — ${details}` : ''}${player}`;
|
|
||||||
});
|
});
|
||||||
const embed = new EmbedBuilder()
|
const embed = new EmbedBuilder()
|
||||||
.setTitle(`Characters of ${campaign.name}`)
|
.setTitle(`Characters of ${campaign.name}`)
|
||||||
|
|||||||
@@ -41,14 +41,6 @@ For a local backend, use `http://localhost:5000`; the module omits `/api` and th
|
|||||||
the local pairing route at its root. Character synchronization works without the optional snapshot
|
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.
|
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
|
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
|
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.
|
client and uses the one-time code instead of a Dragonroll login token.
|
||||||
@@ -61,49 +53,27 @@ within about five seconds. The module currently creates Dragonroll characters in
|
|||||||
worlds. After updating an already-linked world to a version with character sync, create a fresh
|
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.
|
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
|
### Items
|
||||||
|
|
||||||
The campaign's Item list mirrors the world's item directory (Foundry's **items tab**) and nothing
|
The campaign's Item list is synchronized with the world's gear, both ways:
|
||||||
else (Syndria98/dragonroll#67):
|
|
||||||
|
|
||||||
- The GM sends the world item directory (`game.items`) with every snapshot, and world items created,
|
- 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
|
changed or deleted in Foundry are pushed as they happen. Items embedded in a character travel with
|
||||||
character's own inventory: they travel with its snapshot and stay on its sheet, so gear a character
|
that character's snapshot instead.
|
||||||
merely carries does not stand in the campaign's item list.
|
- Gear is deduplicated by name: the same sword in the world directory and in three characters'
|
||||||
- A world item folds into a Dragonroll row that already carries its name — one a campaign made by hand,
|
inventories becomes one Dragonroll item. Names Dragonroll renames away from are remembered on the
|
||||||
or one it renamed away from and remembers (`foundryNames`) — instead of doubling it. Spells, classes,
|
item (`foundryNames`), so Foundry's copies keep folding into it rather than coming back as a
|
||||||
subclasses, backgrounds, feats and species are not gear and are not imported.
|
duplicate. Spells, classes, subclasses, backgrounds, feats and species are not gear and are not
|
||||||
|
imported.
|
||||||
- Foundry owns the fields it sends (category from the item type, rarity, quantity, weight, weapon
|
- 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
|
properties, description). An item made by hand in Dragonroll is created in the world's item
|
||||||
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
||||||
document.
|
document.
|
||||||
- The folders grouping the world's item directory arrive in the campaign as its own item folders, tree
|
|
||||||
and nesting included, and the items are filed in them. A folder's **colour** goes the other way too:
|
|
||||||
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
|
|
||||||
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
|
|
||||||
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
|
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
|
||||||
pruned only by a full snapshot, so a live item push never deletes anything: only a full snapshot sees
|
pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in
|
||||||
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. Items that live only in an actor's
|
||||||
Dragonroll removes its Foundry world copy on the next reconcile.
|
inventory are owned by that actor's snapshot: editing such an item in Dragonroll does not rewrite the
|
||||||
|
actor's copy.
|
||||||
|
|
||||||
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
||||||
|
|
||||||
@@ -113,15 +83,13 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
|
|||||||
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
||||||
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
||||||
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
||||||
| `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
|
| `GET /api/foundry/sync/items` | Items to apply back in Foundry |
|
||||||
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
|
|
||||||
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
||||||
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
||||||
|
|
||||||
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
||||||
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
||||||
the write is not echoed back. A folder colour is written with that folder held in the client's set of
|
the write is not echoed back.
|
||||||
folders being synced, for the same reason.
|
|
||||||
|
|
||||||
## 2. Run the bridge on the Foundry host
|
## 2. Run the bridge on the Foundry host
|
||||||
|
|
||||||
@@ -134,9 +102,6 @@ export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publi
|
|||||||
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
||||||
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
||||||
export DRAGONROLL_FOUNDRY_PORT='8787'
|
export DRAGONROLL_FOUNDRY_PORT='8787'
|
||||||
# Optional: the Foundry Data directory. With it the bridge can list the core
|
|
||||||
# `icons/` library Dragonroll's item icon browser shows.
|
|
||||||
export DRAGONROLL_FOUNDRY_DATA_PATH='/home/foundry/Foundry Data'
|
|
||||||
npm start --prefix foundry/bridge
|
npm start --prefix foundry/bridge
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -172,7 +137,6 @@ The backend exposes these JWT-protected routes when the optional snapshot bridge
|
|||||||
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
||||||
| `GET /api/foundry/items` | World-level items |
|
| `GET /api/foundry/items` | World-level items |
|
||||||
| `GET /api/foundry/items/:id` | One world-level item |
|
| `GET /api/foundry/items/:id` | One world-level item |
|
||||||
| `GET /api/foundry/icons?campaign=&dir=&offset=` | One folder of Foundry's core icon library |
|
|
||||||
|
|
||||||
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
|
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
|
||||||
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
||||||
@@ -180,13 +144,6 @@ ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when th
|
|||||||
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
||||||
configured GM client has published its first snapshot.
|
configured GM client has published its first snapshot.
|
||||||
|
|
||||||
The icon library is the one route that reads the disk instead of the snapshot: with
|
|
||||||
`DRAGONROLL_FOUNDRY_DATA_PATH` set, `GET /api/icons?dir=icons/svg&offset=120&limit=120` answers one
|
|
||||||
folder at a time — `{ status: "ok", dir, directories, files, offset, next }` of paths relative to the
|
|
||||||
data directory — and never reads outside `icons/`. `next` is the offset of the next page of icons, or
|
|
||||||
null once the folder is listed, which is how the campaign's icon browser keeps a library of thousands
|
|
||||||
lazy to load. Without that variable the route answers `503 foundry.errors.icons-unavailable`.
|
|
||||||
|
|
||||||
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
|
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
|
||||||
items collection. The API returns plain document data snapshots. This is a read-only integration: it
|
items collection. The API returns plain document data snapshots. This is a read-only integration: it
|
||||||
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.
|
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
const http = require("node:http");
|
const http = require("node:http");
|
||||||
const fs = require("node:fs");
|
|
||||||
const path = require("node:path");
|
|
||||||
const { timingSafeEqual } = require("node:crypto");
|
const { timingSafeEqual } = require("node:crypto");
|
||||||
|
|
||||||
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
||||||
@@ -14,9 +12,6 @@ const allowedOrigins = new Set(
|
|||||||
.filter(Boolean),
|
.filter(Boolean),
|
||||||
);
|
);
|
||||||
const maxBodySize = 50 * 1024 * 1024;
|
const maxBodySize = 50 * 1024 * 1024;
|
||||||
// The Foundry Data directory, for listing the core `icons/` library. Optional:
|
|
||||||
// without it the bridge simply cannot answer icon listing requests.
|
|
||||||
const dataPath = (process.env.DRAGONROLL_FOUNDRY_DATA_PATH || "").trim();
|
|
||||||
|
|
||||||
if (!readToken || !pushToken) {
|
if (!readToken || !pushToken) {
|
||||||
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
||||||
@@ -111,80 +106,6 @@ function decodePathSegment(segment) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Core icon library -----------------------------------------------------
|
|
||||||
// Foundry keeps the icons it ships in the `icons/` folder of its data directory:
|
|
||||||
// thousands of images over a folder tree of their own. The campaign's icon window
|
|
||||||
// browses that tree, so the bridge lists one folder per request and pages the
|
|
||||||
// icons inside it. It never reads outside `icons/`.
|
|
||||||
|
|
||||||
const iconRoot = "icons";
|
|
||||||
const iconExtensions = new Set([".svg", ".png", ".webp", ".jpg", ".jpeg", ".gif", ".avif"]);
|
|
||||||
const defaultIconPageSize = 120;
|
|
||||||
const maxIconPageSize = 500;
|
|
||||||
|
|
||||||
function normalizeIconDirectory(input) {
|
|
||||||
const raw = String(input ?? "").trim().replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
|
|
||||||
if (!raw || raw === ".") return iconRoot;
|
|
||||||
|
|
||||||
const segments = raw.split("/").filter((segment) => segment && segment !== ".");
|
|
||||||
if (!segments.length || segments.includes("..") || segments[0] !== iconRoot) return null;
|
|
||||||
return segments.join("/");
|
|
||||||
}
|
|
||||||
|
|
||||||
function readIconDirectory(dir, offset, limit) {
|
|
||||||
const root = path.resolve(dataPath, iconRoot);
|
|
||||||
const target = path.resolve(dataPath, dir);
|
|
||||||
if (target !== root && !target.startsWith(root + path.sep)) return null;
|
|
||||||
|
|
||||||
const directories = [];
|
|
||||||
const files = [];
|
|
||||||
for (const entry of fs.readdirSync(target, { withFileTypes: true })) {
|
|
||||||
const entryPath = path.posix.join(dir, entry.name);
|
|
||||||
if (entry.isDirectory()) directories.push(entryPath);
|
|
||||||
else if (entry.isFile() && iconExtensions.has(path.extname(entry.name).toLowerCase())) files.push(entryPath);
|
|
||||||
}
|
|
||||||
directories.sort((a, b) => a.localeCompare(b));
|
|
||||||
files.sort((a, b) => a.localeCompare(b));
|
|
||||||
|
|
||||||
const page = files.slice(offset, offset + limit);
|
|
||||||
return {
|
|
||||||
// Subfolders always come back whole: the window needs every one of them to
|
|
||||||
// navigate, and there are never many. Paging covers the icons.
|
|
||||||
directories,
|
|
||||||
files: page,
|
|
||||||
offset,
|
|
||||||
next: offset + page.length < files.length ? offset + page.length : null,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function sendIconListing(request, response) {
|
|
||||||
if (!dataPath) return sendJson(response, 503, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
|
||||||
|
|
||||||
const params = new URL(request.url, "http://localhost").searchParams;
|
|
||||||
const dir = normalizeIconDirectory(params.get("dir"));
|
|
||||||
if (!dir) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
|
||||||
|
|
||||||
const requestedLimit = Number(params.get("limit"));
|
|
||||||
const limit = Number.isFinite(requestedLimit)
|
|
||||||
? Math.min(maxIconPageSize, Math.max(1, Math.trunc(requestedLimit)))
|
|
||||||
: defaultIconPageSize;
|
|
||||||
const requestedOffset = Number(params.get("offset"));
|
|
||||||
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const listing = readIconDirectory(dir, offset, limit);
|
|
||||||
if (!listing) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
|
||||||
sendJson(response, 200, { status: "ok", dir, ...listing });
|
|
||||||
} catch (error) {
|
|
||||||
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
|
|
||||||
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.error(`Could not list the Foundry icon folder ${dir}.`, error);
|
|
||||||
sendJson(response, 500, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const server = http.createServer(async (request, response) => {
|
const server = http.createServer(async (request, response) => {
|
||||||
if (!setCorsHeaders(request, response)) {
|
if (!setCorsHeaders(request, response)) {
|
||||||
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
||||||
@@ -267,10 +188,6 @@ const server = http.createServer(async (request, response) => {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// The icon library is on disk, not in the world snapshot, so it answers whether
|
|
||||||
// or not a GM client has published one yet.
|
|
||||||
if (pathname === "/api/icons") return sendIconListing(request, response);
|
|
||||||
|
|
||||||
const current = currentSnapshot(response);
|
const current = currentSnapshot(response);
|
||||||
if (!current) return;
|
if (!current) return;
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"id": "dragonroll-foundry",
|
"id": "dragonroll-foundry",
|
||||||
"title": "Dragonroll Foundry API",
|
"title": "Dragonroll Foundry API",
|
||||||
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||||
"version": "0.4.0",
|
"version": "0.3.0",
|
||||||
"library": true,
|
"library": true,
|
||||||
"compatibility": {
|
"compatibility": {
|
||||||
"minimum": "12",
|
"minimum": "12",
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
22
ecosystem.config.js
Normal file
22
ecosystem.config.js
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
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,9 +1,6 @@
|
|||||||
# ---------- 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
|
||||||
@@ -14,21 +11,18 @@ ENV NUXT_PUBLIC_GIT_BRANCH=$NUXT_PUBLIC_GIT_BRANCH
|
|||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# Copy the workspace manifests (pnpm needs every package.json of the workspace)
|
# Copy package files
|
||||||
COPY pnpm-workspace.yaml pnpm-lock.yaml package.json ./
|
COPY package*.json ./
|
||||||
COPY backend/package.json ./backend/
|
|
||||||
COPY frontend/package.json ./frontend/
|
|
||||||
COPY discord-bot/package.json ./discord-bot/
|
|
||||||
|
|
||||||
# Install the dependencies of the frontend package
|
# Install dependencies
|
||||||
RUN pnpm install --frozen-lockfile --filter ./frontend...
|
RUN npm install
|
||||||
|
|
||||||
# Copy project files
|
# Copy project files
|
||||||
ARG CACHEBUST=1
|
ARG CACHEBUST=1
|
||||||
COPY frontend ./frontend
|
COPY . .
|
||||||
|
|
||||||
# Build the Nuxt app
|
# Build the Nuxt app
|
||||||
RUN pnpm --filter ./frontend run build
|
RUN npm run build
|
||||||
|
|
||||||
# ---------- Production Stage ----------
|
# ---------- Production Stage ----------
|
||||||
FROM node:20-alpine
|
FROM node:20-alpine
|
||||||
@@ -36,7 +30,7 @@ FROM node:20-alpine
|
|||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# Copy built output
|
# Copy built output
|
||||||
COPY --from=builder /app/frontend/.output ./.output
|
COPY --from=builder /app/.output ./.output
|
||||||
|
|
||||||
# Expose Nuxt port
|
# Expose Nuxt port
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|||||||
@@ -1,6 +1,39 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
// El que es veu és la pàgina que toca (app/pages): /docs porta la documentació, i la
|
import ContentManager from './components/managers/ContentManager.vue';
|
||||||
// resta de rutes obren l'aplicació de finestres. Aquí només hi ha el que és de tot el lloc.
|
import ToastManager from './components/managers/ToastManager.vue';
|
||||||
|
import WindowManager from './components/managers/WindowManager.vue';
|
||||||
|
import DiscordAuthorize from './components/views/DiscordAuthorize.vue';
|
||||||
|
|
||||||
|
import { CreateWindow } from '@/services/Windows'
|
||||||
|
import { GetUser, HasAdmin } from './services/User';
|
||||||
|
import TooltipManager from './components/managers/TooltipManager.vue';
|
||||||
|
import ContextMenuManager from './components/managers/ContextMenuManager.vue';
|
||||||
|
import { useCampaignService } from './services/Campaign';
|
||||||
|
|
||||||
|
const { RestoreCampaign } = useCampaignService();
|
||||||
|
|
||||||
|
// El bot de Discord enllaça amb aquesta pantalla; no és part de l'aplicació i no ha d'arrencar
|
||||||
|
// les finestres normals.
|
||||||
|
const requestUrl = useRequestURL();
|
||||||
|
const isDiscordAuthorize = computed(() => requestUrl.pathname.replace(/\/+$/, '') === '/discord/authorize');
|
||||||
|
|
||||||
|
async function start(){
|
||||||
|
if(GetUser()){
|
||||||
|
const restoredCampaign = await RestoreCampaign();
|
||||||
|
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: [
|
||||||
@@ -13,9 +46,29 @@ useHead({
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
setupTheme();
|
setupTheme();
|
||||||
setTheme('dark');
|
setTheme('dark');
|
||||||
|
if(!isDiscordAuthorize.value){
|
||||||
|
start();
|
||||||
|
}
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<NuxtPage></NuxtPage>
|
<DiscordAuthorize v-if="isDiscordAuthorize"></DiscordAuthorize>
|
||||||
|
<div v-else class="viewer">
|
||||||
|
<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>
|
||||||
|
|||||||
@@ -22,11 +22,6 @@ $themes: (
|
|||||||
|
|
||||||
note-border: #202324,
|
note-border: #202324,
|
||||||
|
|
||||||
// A map's lighting: the dark the lights are carved out of, and the walls that cut them. The map
|
|
||||||
// canvas reads both off these variables (see components/viewer/map/MapViewerPane.vue).
|
|
||||||
map-darkness: #000000d9,
|
|
||||||
map-wall: #e06c75,
|
|
||||||
|
|
||||||
hover: #21262d,
|
hover: #21262d,
|
||||||
selected: #4a4a4b,
|
selected: #4a4a4b,
|
||||||
border-color: #819796,
|
border-color: #819796,
|
||||||
@@ -35,19 +30,9 @@ $themes: (
|
|||||||
container-shadow: #151d28,
|
container-shadow: #151d28,
|
||||||
sticky-header-bg: #20202077,
|
sticky-header-bg: #20202077,
|
||||||
|
|
||||||
// Quoted: red/green/gray are also Sass colour keywords, so unquoted they are parsed as
|
red: #e06c75,
|
||||||
// colour values, and interpolating one into `--color-#{$name}` warns
|
green: #98c379,
|
||||||
// (Syndria98/dragonroll#71).
|
gray: #cccccc,
|
||||||
"red": #e06c75,
|
|
||||||
"green": #98c379,
|
|
||||||
"gray": #cccccc,
|
|
||||||
|
|
||||||
// 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%,
|
icon-invert: 100%,
|
||||||
|
|
||||||
@@ -75,11 +60,6 @@ $themes: (
|
|||||||
|
|
||||||
note-border: #e0e0e0,
|
note-border: #e0e0e0,
|
||||||
|
|
||||||
// Same lighting keys as the dark map; the dark over a map is the dark of a room whichever theme
|
|
||||||
// the app is drawn in, and its walls are darkened to stay readable over a light image.
|
|
||||||
map-darkness: #000000d9,
|
|
||||||
map-wall: #c62828,
|
|
||||||
|
|
||||||
border-color: #e0e0e0,
|
border-color: #e0e0e0,
|
||||||
border: #f0f0f0,
|
border: #f0f0f0,
|
||||||
hover: #e9e9e9,
|
hover: #e9e9e9,
|
||||||
@@ -88,17 +68,9 @@ $themes: (
|
|||||||
container-shadow: #5f6774,
|
container-shadow: #5f6774,
|
||||||
sticky-header-bg: #fff,
|
sticky-header-bg: #fff,
|
||||||
|
|
||||||
// Quoted for the same reason as in the dark map.
|
red: #e06c75,
|
||||||
"red": #e06c75,
|
green: #98c379,
|
||||||
"green": #98c379,
|
gray: #cccccc,
|
||||||
"gray": #cccccc,
|
|
||||||
|
|
||||||
// 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%,
|
icon-invert: 0%,
|
||||||
|
|
||||||
|
|||||||
@@ -417,89 +417,4 @@ span.artifact {
|
|||||||
|
|
||||||
.fold.is-collapsed > .fold-body {
|
.fold.is-collapsed > .fold-body {
|
||||||
display: none;
|
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);
|
|
||||||
}
|
}
|
||||||
@@ -3,16 +3,10 @@ import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue'
|
|||||||
import { useI18n } from 'vue-i18n';
|
import { useI18n } from 'vue-i18n';
|
||||||
|
|
||||||
import { useCampaignService } from '~/services/Campaign.js';
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js';
|
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
import { BuildColorMenu } from '~/services/EntryColors';
|
import Server from '~/services/Server';
|
||||||
import { BuildItemRows } from '~/services/ItemFolders';
|
|
||||||
import Server, { getBaseUrl } from '~/services/Server';
|
|
||||||
import { DisplayToast } from '~/services/Toaster';
|
|
||||||
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
||||||
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
||||||
import { ACTOR_DRAG_TYPE } from '~/services/MapTokens';
|
|
||||||
import EntryFolderRow from './EntryFolderRow.vue';
|
|
||||||
import NestedNoteList from './NestedNoteList.vue';
|
import NestedNoteList from './NestedNoteList.vue';
|
||||||
|
|
||||||
const { Campaign } = useCampaignService();
|
const { Campaign } = useCampaignService();
|
||||||
@@ -23,22 +17,15 @@ const actors = ref([]);
|
|||||||
const items = ref([]);
|
const items = ref([]);
|
||||||
const maps = ref([]);
|
const maps = ref([]);
|
||||||
const entryLists = { actor: actors, item: items, map: maps };
|
const entryLists = { actor: actors, item: items, map: maps };
|
||||||
// Every sidebar section files its rows into folders of its own (see models/Folder.js), so
|
|
||||||
// each entry list keeps the tree `/actor|item|map/list` sends along. Folders are open by
|
|
||||||
// default: a folder synced from Foundry should show what stands in it, not hide it.
|
|
||||||
const entryFolders = { actor: ref([]), item: ref([]), map: ref([]) };
|
|
||||||
const collapsedFolderIds = ref([]);
|
|
||||||
const loadingNotes = ref(false);
|
const loadingNotes = ref(false);
|
||||||
const loadingEntries = ref(false);
|
const loadingEntries = ref(false);
|
||||||
// An import of the whole linked world takes a moment, and clicking the row again while
|
|
||||||
// it runs must not start a second one.
|
|
||||||
const importingFoundry = ref(false);
|
|
||||||
const notesError = ref('');
|
const notesError = ref('');
|
||||||
const entriesError = ref('');
|
const entriesError = ref('');
|
||||||
const sidebarCollapsed = ref(false);
|
const sidebarCollapsed = ref(false);
|
||||||
const activeSection = ref('notes');
|
const activeSection = ref('notes');
|
||||||
const isDragOverSidebar = ref(false);
|
const isDragOverSidebar = ref(false);
|
||||||
const expandedFolderIds = ref([]);
|
const expandedFolderIds = ref([]);
|
||||||
|
const expandedEntryIds = ref([]);
|
||||||
const nestedNoteListRef = ref(null);
|
const nestedNoteListRef = ref(null);
|
||||||
let entryRefreshInterval;
|
let entryRefreshInterval;
|
||||||
|
|
||||||
@@ -56,14 +43,6 @@ async function handleSidebarDrop(event) {
|
|||||||
} catch (e) {}
|
} catch (e) {}
|
||||||
}
|
}
|
||||||
|
|
||||||
// An actor row is dragged out of the sidebar onto a map, where it stands as a token. The map viewer
|
|
||||||
// reads that type back on its drop (see MapViewerPane.vue); a note drag carries 'text/plain'
|
|
||||||
// instead, so the two never land where the other belongs.
|
|
||||||
function startActorDrag(event, actor) {
|
|
||||||
event.dataTransfer.setData(ACTOR_DRAG_TYPE, String(actor._id));
|
|
||||||
event.dataTransfer.effectAllowed = 'copyMove';
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleExpandedFolder(folderId) {
|
function toggleExpandedFolder(folderId) {
|
||||||
const arr = expandedFolderIds.value;
|
const arr = expandedFolderIds.value;
|
||||||
const idx = arr.indexOf(folderId);
|
const idx = arr.indexOf(folderId);
|
||||||
@@ -118,27 +97,12 @@ function handleNoteDeleted(noteKey) {
|
|||||||
notes.value = notes.value.filter(n => n.key !== noteKey);
|
notes.value = notes.value.filter(n => n.key !== noteKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
function sectionForTarget(target) {
|
function handleFolderSaved() {
|
||||||
if (target === 'actor') return 'actors';
|
fetchCampaignNotes();
|
||||||
if (target === 'item') return 'items';
|
|
||||||
if (target === 'map') return 'maps';
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleFolderSaved(folder) {
|
|
||||||
// A folder only shows up once the list it belongs to reads it back: the notes refetch
|
|
||||||
// their tree, an entry list refetches its own (silently, its rows are already there).
|
|
||||||
const section = sectionForTarget(folder?.target ?? 'note');
|
|
||||||
if (!section) {
|
|
||||||
fetchCampaignNotes();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
fetchCampaignEntries(section, true);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function handleFolderDeleted(folderId) {
|
function handleFolderDeleted(folderId) {
|
||||||
expandedFolderIds.value = expandedFolderIds.value.filter((id) => id !== folderId);
|
expandedFolderIds.value = expandedFolderIds.value.filter((id) => id !== folderId);
|
||||||
collapsedFolderIds.value = collapsedFolderIds.value.filter((id) => id !== folderId);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function handleCampaignEntryCreated({ entityType, entry }) {
|
function handleCampaignEntryCreated({ entityType, entry }) {
|
||||||
@@ -155,9 +119,6 @@ function handleCampaignEntryUpdated({ entityType, entry }) {
|
|||||||
if (!list) return;
|
if (!list) return;
|
||||||
list.value = list.value.map((current) => current._id === entry._id ? entry : current)
|
list.value = list.value.map((current) => current._id === entry._id ? entry : current)
|
||||||
.sort((a, b) => a.name.localeCompare(b.name));
|
.sort((a, b) => a.name.localeCompare(b.name));
|
||||||
// The anchored map is this very entry (its pins changed, say): write it back without touching
|
|
||||||
// the pane, so switching back from the notes still shows what is on the map.
|
|
||||||
if (entityType === 'map' && AnchoredMap.value?._id === entry._id) AnchoredMap.value = entry;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const campaignId = computed(() => {
|
const campaignId = computed(() => {
|
||||||
@@ -229,10 +190,6 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
|
|||||||
|
|
||||||
const previousById = new Map(list.value.map((entry) => [entry._id, entry]));
|
const previousById = new Map(list.value.map((entry) => [entry._id, entry]));
|
||||||
list.value = response.data[entityType] ?? [];
|
list.value = response.data[entityType] ?? [];
|
||||||
// Every entry list comes with the folders its rows stand in, so the sidebar can
|
|
||||||
// group them the way the note tree does (and the way the Foundry item directory
|
|
||||||
// arrives for items).
|
|
||||||
entryFolders[kind].value = response.data.folders ?? [];
|
|
||||||
// Tell open windows about Foundry changes landing behind them.
|
// Tell open windows about Foundry changes landing behind them.
|
||||||
for (const entry of list.value) {
|
for (const entry of list.value) {
|
||||||
const previous = previousById.get(entry._id);
|
const previous = previousById.get(entry._id);
|
||||||
@@ -250,11 +207,6 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
|
|||||||
function selectSection(section) {
|
function selectSection(section) {
|
||||||
activeSection.value = section;
|
activeSection.value = section;
|
||||||
if (isEntrySection(section)) fetchCampaignEntries(section);
|
if (isEntrySection(section)) fetchCampaignEntries(section);
|
||||||
// Only the notes and maps buttons say something about the note container: they switch it between
|
|
||||||
// the notes that are open and the anchored map. Actors and items open windows of their own, so
|
|
||||||
// their buttons leave whatever the note container was showing untouched.
|
|
||||||
if (section === 'notes') SetActivePane('notes');
|
|
||||||
else if (section === 'maps' && AnchoredMap.value) SetActivePane('map');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function createEntry(entityType) {
|
function createEntry(entityType) {
|
||||||
@@ -266,14 +218,6 @@ function createEntry(entityType) {
|
|||||||
CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value });
|
CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Every section files its rows into folders of its own: the window passes along which
|
|
||||||
// list the folder belongs to, so the notes, the actors, the items and the maps each keep
|
|
||||||
// a tree the others never show.
|
|
||||||
function createFolder(target = 'note') {
|
|
||||||
if (!campaignId.value) return;
|
|
||||||
CreateWindow('new_folder', { campaign: campaignId.value, target });
|
|
||||||
}
|
|
||||||
|
|
||||||
function entrySummary(actor) {
|
function entrySummary(actor) {
|
||||||
const bits = [t(`campaigns.actor.types.${actor.type}`)];
|
const bits = [t(`campaigns.actor.types.${actor.type}`)];
|
||||||
if (actor.species) bits.push(actor.species);
|
if (actor.species) bits.push(actor.species);
|
||||||
@@ -283,20 +227,8 @@ function entrySummary(actor) {
|
|||||||
return bits.join(' · ');
|
return bits.join(' · ');
|
||||||
}
|
}
|
||||||
|
|
||||||
// The rarity of an item colours the text of its row instead of listing category, rarity and
|
function itemSummary(item) {
|
||||||
// quantity (Syndria98/dragonroll#63): common white, uncommon green, rare blue, very rare purple,
|
return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`;
|
||||||
// legendary orange. Anything else (artifact) keeps the default text colour.
|
|
||||||
function rarityClass(item) {
|
|
||||||
return ['common', 'uncommon', 'rare', 'very-rare', 'legendary'].includes(item.rarity)
|
|
||||||
? `rarity-${item.rarity}`
|
|
||||||
: '';
|
|
||||||
}
|
|
||||||
|
|
||||||
// An item's icon in the sidebar: an uploaded filename served from /api/public, or a full URL
|
|
||||||
// (Foundry sends its own icon as one) — the same rule the item window uses.
|
|
||||||
function itemImageUrl(image) {
|
|
||||||
if (!image) return '';
|
|
||||||
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function mapSummary(map) {
|
function mapSummary(map) {
|
||||||
@@ -313,35 +245,6 @@ function editMap(map) {
|
|||||||
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
|
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
|
||||||
}
|
}
|
||||||
|
|
||||||
// The one sidebar action that asks the linked world instead of the campaign's own rows
|
|
||||||
// (Syndria98/dragonroll#77): the backend reads what the Foundry bridge is showing and
|
|
||||||
// writes every actor or item of it through the writers a sync push uses, so the rows
|
|
||||||
// the campaign already has are written over and only the world's new ones are made.
|
|
||||||
// The list is read back once the answer is in, so whatever arrived is on screen, and
|
|
||||||
// the toast says how the world landed.
|
|
||||||
async function forceImportFromFoundry(entityType) {
|
|
||||||
const section = sectionForTarget(entityType);
|
|
||||||
if (!campaignId.value || !section || importingFoundry.value) return;
|
|
||||||
|
|
||||||
importingFoundry.value = true;
|
|
||||||
try {
|
|
||||||
const response = await Server().post('/foundry/import', { campaign: campaignId.value, kind: section });
|
|
||||||
if (response.data.status !== 'ok') {
|
|
||||||
DisplayToast('red', t(response.data.msg || 'campaigns.foundry-import.error'), 3000);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
DisplayToast('green', t('campaigns.foundry-import.done', {
|
|
||||||
imported: response.data.imported ?? 0,
|
|
||||||
updated: response.data.updated ?? 0
|
|
||||||
}), 3000);
|
|
||||||
await fetchCampaignEntries(section);
|
|
||||||
} catch (error) {
|
|
||||||
DisplayToast('red', t('campaigns.foundry-import.error'), 3000);
|
|
||||||
} finally {
|
|
||||||
importingFoundry.value = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function showEntryMenu(entry, entityType) {
|
function showEntryMenu(entry, entityType) {
|
||||||
const list = entryLists[entityType];
|
const list = entryLists[entityType];
|
||||||
const menuItems = [];
|
const menuItems = [];
|
||||||
@@ -361,26 +264,6 @@ function showEntryMenu(entry, entityType) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// The actor and item lists mirror a linked Foundry world, so their rows also offer
|
|
||||||
// to pull the whole world over: this row is not sent or fetched on its own, the
|
|
||||||
// section's whole list is imported and the rows already in it are only updated.
|
|
||||||
if (entityType === 'actor' || entityType === 'item') {
|
|
||||||
menuItems.push({ divider: true });
|
|
||||||
menuItems.push({
|
|
||||||
name: t('campaigns.foundry-import.run'),
|
|
||||||
icon: '/icons/iconoir/regular/import.svg',
|
|
||||||
action: () => { HideContextMenu(); forceImportFromFoundry(entityType); }
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rows of every section can be filed into a folder of their own list, like a note
|
|
||||||
// into a folder of the note tree.
|
|
||||||
menuItems.push({
|
|
||||||
name: t('campaigns.folders.move-to'),
|
|
||||||
icon: '/icons/iconoir/regular/folder.svg',
|
|
||||||
context: moveToFolderMenu(entityType, entry)
|
|
||||||
});
|
|
||||||
|
|
||||||
menuItems.push({
|
menuItems.push({
|
||||||
name: t('campaigns.actions.delete'),
|
name: t('campaigns.actions.delete'),
|
||||||
icon: '/icons/iconoir/regular/trash.svg',
|
icon: '/icons/iconoir/regular/trash.svg',
|
||||||
@@ -389,7 +272,6 @@ function showEntryMenu(entry, entityType) {
|
|||||||
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
|
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
|
||||||
if (response.data.status === 'ok' && list) {
|
if (response.data.status === 'ok' && list) {
|
||||||
list.value = list.value.filter((current) => current._id !== entry._id);
|
list.value = list.value.filter((current) => current._id !== entry._id);
|
||||||
if (entityType === 'map' && isAnchoredMap(entry)) ClearAnchoredMap();
|
|
||||||
}
|
}
|
||||||
} catch (error) {} finally { HideContextMenu(); }
|
} catch (error) {} finally { HideContextMenu(); }
|
||||||
}
|
}
|
||||||
@@ -397,72 +279,10 @@ function showEntryMenu(entry, entityType) {
|
|||||||
ShowContextMenu(menuItems);
|
ShowContextMenu(menuItems);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The menu of a folder row: rename it, colour it, delete it. The notes' folders are
|
function toggleEntryDetails(entryId) {
|
||||||
// renamed and coloured the same way, through the same `/folder/*` routes.
|
expandedEntryIds.value = expandedEntryIds.value.includes(entryId)
|
||||||
function folderMenuItems(folder) {
|
? expandedEntryIds.value.filter((id) => id !== entryId)
|
||||||
return [
|
: [...expandedEntryIds.value, entryId];
|
||||||
{
|
|
||||||
name: t('campaigns.folders.rename'), icon: '/icons/iconoir/regular/edit-pencil.svg',
|
|
||||||
action: () => {
|
|
||||||
HideContextMenu();
|
|
||||||
CreateWindow('new_folder', { folderId: folder._id, campaign: campaignId.value, name: folder.name });
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: t('campaigns.folders.color'), icon: '/icons/iconoir/regular/palette.svg',
|
|
||||||
context: BuildColorMenu((color) => setFolderColor(folder, color), { defaultLabel: t('campaigns.folders.default') })
|
|
||||||
},
|
|
||||||
{ divider: true },
|
|
||||||
{ name: t('campaigns.folders.delete'), icon: '/icons/iconoir/regular/trash.svg', action: () => deleteEntryFolder(folder) }
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
async function setFolderColor(folder, color) {
|
|
||||||
try {
|
|
||||||
const response = await Server().post('/folder/update', { id: folder._id, color });
|
|
||||||
if (response.data.status === 'ok') folder.color = color;
|
|
||||||
} catch (error) {} finally {
|
|
||||||
HideContextMenu();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function deleteEntryFolder(folder) {
|
|
||||||
try {
|
|
||||||
const response = await Server().post('/folder/delete', { id: folder._id });
|
|
||||||
if (response.data.status !== 'ok') return;
|
|
||||||
collapsedFolderIds.value = collapsedFolderIds.value.filter((id) => id !== folder._id);
|
|
||||||
// Whatever stood in the folder moved to the root of the list along with it.
|
|
||||||
await fetchCampaignEntries(activeSection.value, true);
|
|
||||||
} catch (error) {} finally {
|
|
||||||
HideContextMenu();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The 'move to folder' submenu of an entry: the folders of its own list and its root.
|
|
||||||
function moveToFolderMenu(entityType, entry) {
|
|
||||||
const menuItems = entryFolders[entityType].value.map((folder) => ({
|
|
||||||
name: folder.name, icon: '/icons/iconoir/regular/folder.svg',
|
|
||||||
action: () => moveEntryToFolder(entityType, entry, folder._id)
|
|
||||||
}));
|
|
||||||
|
|
||||||
if (menuItems.length > 0) menuItems.push({ divider: true });
|
|
||||||
menuItems.push({
|
|
||||||
name: t('campaigns.folders.root'), icon: '/icons/iconoir/regular/xmark-circle.svg',
|
|
||||||
action: () => moveEntryToFolder(entityType, entry, null)
|
|
||||||
});
|
|
||||||
return menuItems;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function moveEntryToFolder(entityType, entry, folderId) {
|
|
||||||
try {
|
|
||||||
const response = await Server().post(`/${entityType}/update`, { id: entry._id, folder: folderId });
|
|
||||||
if (response.data.status !== 'ok') return;
|
|
||||||
// The row walks over to its new folder. This is the event a Foundry sync of the
|
|
||||||
// entry sends, so the list regroups and a window open on it sees the change.
|
|
||||||
emitter.emit('campaign-entry-updated', { entityType, entry: response.data[entityType] });
|
|
||||||
} catch (error) {} finally {
|
|
||||||
HideContextMenu();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function openCharacterSheet(actor) {
|
async function openCharacterSheet(actor) {
|
||||||
@@ -474,27 +294,13 @@ async function openCharacterSheet(actor) {
|
|||||||
CreateWindow('character_sheet', { actor });
|
CreateWindow('character_sheet', { actor });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clicking an item opens its window, like a character does with its sheet.
|
async function openMapViewer(map) {
|
||||||
async function openItemSheet(item) {
|
const existingWindowId = GetFirstWindowId('map_viewer');
|
||||||
const existingWindowId = GetFirstWindowId('item_sheet');
|
|
||||||
if (existingWindowId !== undefined) {
|
if (existingWindowId !== undefined) {
|
||||||
ClearWindow({ id: existingWindowId });
|
ClearWindow({ id: existingWindowId });
|
||||||
await nextTick();
|
await nextTick();
|
||||||
}
|
}
|
||||||
CreateWindow('item_sheet', { item });
|
CreateWindow('map_viewer', { map, campaign: campaignId.value });
|
||||||
}
|
|
||||||
|
|
||||||
// Maps are anchored on the note container instead of opening a window: the notes that were open
|
|
||||||
// stay open, and the sidebar's notes/maps buttons switch between the two.
|
|
||||||
function openMapViewer(map) {
|
|
||||||
if (!map) return;
|
|
||||||
const floatingViewer = GetFirstWindowId('map_viewer');
|
|
||||||
if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
|
|
||||||
AnchorMap(map);
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAnchoredMap(map) {
|
|
||||||
return AnchoredMap.value?._id === map._id;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function createNote() {
|
function createNote() {
|
||||||
@@ -503,42 +309,21 @@ function createNote() {
|
|||||||
CreateWindow('new_note', { campaign: campaignId.value });
|
CreateWindow('new_note', { campaign: campaignId.value });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function createFolder() {
|
||||||
|
CreateWindow('new_folder', { campaign: campaignId.value });
|
||||||
|
}
|
||||||
|
|
||||||
function toggleSidebar() {
|
function toggleSidebar() {
|
||||||
sidebarCollapsed.value = !sidebarCollapsed.value;
|
sidebarCollapsed.value = !sidebarCollapsed.value;
|
||||||
}
|
}
|
||||||
|
|
||||||
const rootNotes = computed(() => notes.value.filter(n => !n._folder));
|
const rootNotes = computed(() => notes.value.filter(n => !n._folder));
|
||||||
|
|
||||||
// The rows of each entry list: every folder followed by what stands in it, deeper and
|
|
||||||
// deeper, the way the item list has done since its folders arrived from the linked world
|
|
||||||
// (services/ItemFolders.js builds them from the list and the folders the API sends).
|
|
||||||
// Without any folder this is the plain list, and `row.item` is the entry of the section
|
|
||||||
// the row belongs to: its actor, item or map.
|
|
||||||
const entryRows = {
|
|
||||||
actor: computed(() => BuildItemRows(actors.value, entryFolders.actor.value, collapsedFolderIds.value)),
|
|
||||||
item: computed(() => BuildItemRows(items.value, entryFolders.item.value, collapsedFolderIds.value)),
|
|
||||||
map: computed(() => BuildItemRows(maps.value, entryFolders.map.value, collapsedFolderIds.value))
|
|
||||||
};
|
|
||||||
|
|
||||||
// Rows one step deeper per folder level; the sidebar list's own padding is the base.
|
|
||||||
function rowIndent(depth) {
|
|
||||||
return { paddingLeft: `${10 + depth * 14}px` };
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleFolder(folderId) {
|
|
||||||
collapsedFolderIds.value = collapsedFolderIds.value.includes(folderId)
|
|
||||||
? collapsedFolderIds.value.filter((id) => id !== folderId)
|
|
||||||
: [...collapsedFolderIds.value, folderId];
|
|
||||||
}
|
|
||||||
|
|
||||||
watch(campaignId, (newVal) => {
|
watch(campaignId, (newVal) => {
|
||||||
if (newVal) {
|
if (newVal) {
|
||||||
actors.value = [];
|
actors.value = [];
|
||||||
items.value = [];
|
items.value = [];
|
||||||
maps.value = [];
|
maps.value = [];
|
||||||
for (const sectionFolders of Object.values(entryFolders)) sectionFolders.value = [];
|
|
||||||
collapsedFolderIds.value = [];
|
|
||||||
ClearAnchoredMap();
|
|
||||||
fetchCampaignNotes();
|
fetchCampaignNotes();
|
||||||
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
|
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
|
||||||
} else {
|
} else {
|
||||||
@@ -547,11 +332,8 @@ watch(campaignId, (newVal) => {
|
|||||||
actors.value = [];
|
actors.value = [];
|
||||||
items.value = [];
|
items.value = [];
|
||||||
maps.value = [];
|
maps.value = [];
|
||||||
for (const sectionFolders of Object.values(entryFolders)) sectionFolders.value = [];
|
|
||||||
collapsedFolderIds.value = [];
|
|
||||||
notesError.value = '';
|
notesError.value = '';
|
||||||
entriesError.value = '';
|
entriesError.value = '';
|
||||||
ClearAnchoredMap();
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -659,7 +441,7 @@ onBeforeUnmount(() => {
|
|||||||
<button class="sidebar-action" type="button" @click="createNote" :disabled="!Campaign" :title="t('campaigns.actions.new-note')" :aria-label="t('campaigns.actions.new-note')">
|
<button class="sidebar-action" type="button" @click="createNote" :disabled="!Campaign" :title="t('campaigns.actions.new-note')" :aria-label="t('campaigns.actions.new-note')">
|
||||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
<button class="sidebar-action" type="button" @click="createFolder()" :disabled="!Campaign" :title="t('campaigns.actions.new-folder')" :aria-label="t('campaigns.actions.new-folder')">
|
<button class="sidebar-action" type="button" @click="createFolder" :disabled="!Campaign" :title="t('campaigns.actions.new-folder')" :aria-label="t('campaigns.actions.new-folder')">
|
||||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
|
<img class="sidebar-action-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
<button class="sidebar-action" type="button" @click="fetchCampaignNotes" :disabled="!Campaign || loadingNotes" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
|
<button class="sidebar-action" type="button" @click="fetchCampaignNotes" :disabled="!Campaign || loadingNotes" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
|
||||||
@@ -670,9 +452,6 @@ onBeforeUnmount(() => {
|
|||||||
<button class="sidebar-action" type="button" @click="createEntry(entryEntityType(activeSection))" :disabled="!Campaign" :title="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })" :aria-label="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })">
|
<button class="sidebar-action" type="button" @click="createEntry(entryEntityType(activeSection))" :disabled="!Campaign" :title="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })" :aria-label="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })">
|
||||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
<button class="sidebar-action" type="button" @click="createFolder(entryEntityType(activeSection))" :disabled="!Campaign" :title="t('campaigns.actions.new-folder')" :aria-label="t('campaigns.actions.new-folder')">
|
|
||||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
<button class="sidebar-action" type="button" @click="fetchCampaignEntries(activeSection)" :disabled="!Campaign || loadingEntries" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
|
<button class="sidebar-action" type="button" @click="fetchCampaignEntries(activeSection)" :disabled="!Campaign || loadingEntries" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
|
||||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
|
<img class="sidebar-action-icon" src="/icons/iconoir/regular/refresh.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
@@ -694,72 +473,40 @@ onBeforeUnmount(() => {
|
|||||||
<template v-else-if="activeSection === 'actors'">
|
<template v-else-if="activeSection === 'actors'">
|
||||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||||
<div v-else-if="actors.length === 0 && entryFolders.actor.value.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-actors') }}</div>
|
<div v-else-if="actors.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-actors') }}</div>
|
||||||
<template v-for="row in entryRows.actor.value" :key="row.key">
|
<div v-for="actor in actors" :key="actor._id" class="entity-entry" role="button" tabindex="0" @click="openCharacterSheet(actor)" @keydown.enter="openCharacterSheet(actor)" @keydown.space.prevent="openCharacterSheet(actor)" @contextmenu.prevent="showEntryMenu(actor, 'actor')">
|
||||||
<EntryFolderRow
|
<span class="entity-entry-name">{{ actor.name }}</span>
|
||||||
v-if="row.kind === 'folder'"
|
<span class="entity-entry-meta">{{ entrySummary(actor) }}</span>
|
||||||
:folder="row.folder"
|
</div>
|
||||||
:collapsed="collapsedFolderIds.includes(row.folder._id)"
|
|
||||||
:indent="rowIndent(row.depth)"
|
|
||||||
:menu="folderMenuItems(row.folder)"
|
|
||||||
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
|
|
||||||
@toggle="toggleFolder(row.folder._id)"
|
|
||||||
/>
|
|
||||||
<div v-else class="entity-entry" :style="rowIndent(row.depth)" role="button" tabindex="0" draggable="true" :title="t('campaigns.map.tokens.drag')" @click="openCharacterSheet(row.item)" @keydown.enter="openCharacterSheet(row.item)" @keydown.space.prevent="openCharacterSheet(row.item)" @dragstart="startActorDrag($event, row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'actor')">
|
|
||||||
<span class="entity-entry-name">{{ row.item.name }}</span>
|
|
||||||
<span class="entity-entry-meta">{{ entrySummary(row.item) }}</span>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<template v-else-if="activeSection === 'items'">
|
<template v-else-if="activeSection === 'items'">
|
||||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||||
<div v-else-if="items.length === 0 && entryFolders.item.value.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-items') }}</div>
|
<div v-else-if="items.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-items') }}</div>
|
||||||
<template v-for="row in entryRows.item.value" :key="row.key">
|
<div v-for="item in items" :key="item._id" class="entity-entry" role="button" tabindex="0" :aria-expanded="expandedEntryIds.includes(item._id)" @click="toggleEntryDetails(item._id)" @keydown.enter="toggleEntryDetails(item._id)" @keydown.space.prevent="toggleEntryDetails(item._id)" @contextmenu.prevent="showEntryMenu(item, 'item')">
|
||||||
<EntryFolderRow
|
<span class="entity-entry-name-row">
|
||||||
v-if="row.kind === 'folder'"
|
<span class="entity-entry-name">{{ item.name }}</span>
|
||||||
:folder="row.folder"
|
<span v-if="item.foundryItemId" class="entity-entry-sync">{{ t('campaigns.synced') }}</span>
|
||||||
:collapsed="collapsedFolderIds.includes(row.folder._id)"
|
</span>
|
||||||
:indent="rowIndent(row.depth)"
|
<span class="entity-entry-meta">{{ itemSummary(item) }}</span>
|
||||||
:menu="folderMenuItems(row.folder)"
|
<template v-if="expandedEntryIds.includes(item._id)">
|
||||||
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
|
<span v-if="item.weight !== undefined" class="entity-entry-description">{{ item.weight }} lb</span>
|
||||||
@toggle="toggleFolder(row.folder._id)"
|
<span v-if="item.properties" class="entity-entry-description">{{ item.properties }}</span>
|
||||||
/>
|
<span v-if="item.description" class="entity-entry-description">{{ item.description }}</span>
|
||||||
<div v-else class="entity-entry" :style="rowIndent(row.depth)" role="button" tabindex="0" @click="openItemSheet(row.item)" @keydown.enter="openItemSheet(row.item)" @keydown.space.prevent="openItemSheet(row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'item')">
|
</template>
|
||||||
<span class="entity-entry-title">
|
</div>
|
||||||
<span v-if="row.item.image" class="entity-entry-image" aria-hidden="true">
|
|
||||||
<img :src="itemImageUrl(row.item.image)" alt="">
|
|
||||||
</span>
|
|
||||||
<span class="entity-entry-name" :class="rarityClass(row.item)">{{ row.item.name }}</span>
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<template v-else>
|
<template v-else>
|
||||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||||
<div v-else-if="maps.length === 0 && entryFolders.map.value.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
|
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
|
||||||
<template v-for="row in entryRows.map.value" :key="row.key">
|
<div v-for="map in maps" :key="map._id" class="entity-entry" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
|
||||||
<EntryFolderRow
|
<span class="entity-entry-name">{{ map.name }}</span>
|
||||||
v-if="row.kind === 'folder'"
|
<span class="entity-entry-meta">{{ mapSummary(map) }}</span>
|
||||||
:folder="row.folder"
|
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
|
||||||
:collapsed="collapsedFolderIds.includes(row.folder._id)"
|
</div>
|
||||||
:indent="rowIndent(row.depth)"
|
|
||||||
:menu="folderMenuItems(row.folder)"
|
|
||||||
:toggle-label="t('campaigns.folders.toggle', { name: row.folder.name })"
|
|
||||||
@toggle="toggleFolder(row.folder._id)"
|
|
||||||
/>
|
|
||||||
<div v-else class="entity-entry" :style="rowIndent(row.depth)" :class="{ anchored: isAnchoredMap(row.item) }" role="button" tabindex="0" @click="openMapViewer(row.item)" @keydown.enter="openMapViewer(row.item)" @keydown.space.prevent="openMapViewer(row.item)" @contextmenu.prevent="showEntryMenu(row.item, 'map')">
|
|
||||||
<span class="entity-entry-name-row">
|
|
||||||
<span class="entity-entry-name">{{ row.item.name }}</span>
|
|
||||||
<span v-if="isAnchoredMap(row.item)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span>
|
|
||||||
</span>
|
|
||||||
<span class="entity-entry-meta">{{ mapSummary(row.item) }}</span>
|
|
||||||
<span v-if="!row.item.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
</template>
|
</template>
|
||||||
</div>
|
</div>
|
||||||
</aside>
|
</aside>
|
||||||
@@ -901,20 +648,14 @@ onBeforeUnmount(() => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.entity-entry {
|
.entity-entry {
|
||||||
/* These rows are divs (the note and folder rows are buttons) and there is no global box-sizing
|
width: 100%; padding: 9px 10px; border: 1px solid transparent; border-radius: 8px;
|
||||||
reset, so without border-box the padding and border add onto the 100% width and the entry
|
|
||||||
sticks out of the sidebar. */
|
|
||||||
width: 100%; min-width: 0; box-sizing: border-box; padding: 9px 10px; border: 1px solid transparent;
|
|
||||||
border-radius: 8px;
|
|
||||||
background: transparent; color: var(--color-text); text-align: left; display: flex; flex-direction: column;
|
background: transparent; color: var(--color-text); text-align: left; display: flex; flex-direction: column;
|
||||||
gap: 3px; cursor: pointer;
|
gap: 3px; cursor: pointer;
|
||||||
}
|
}
|
||||||
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
|
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
|
||||||
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
|
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
|
||||||
/* The map currently anchored on the note container. */
|
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; }
|
||||||
.entity-entry.anchored { border-color: var(--color-link); background: var(--color-background-soft); }
|
.entity-entry-name { font-weight: bold; }
|
||||||
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; min-width: 0; }
|
|
||||||
.entity-entry-name { font-weight: bold; min-width: 0; word-break: break-word; }
|
|
||||||
.entity-entry-sync {
|
.entity-entry-sync {
|
||||||
font-size: 10px;
|
font-size: 10px;
|
||||||
letter-spacing: 0.04em;
|
letter-spacing: 0.04em;
|
||||||
@@ -923,22 +664,6 @@ onBeforeUnmount(() => {
|
|||||||
}
|
}
|
||||||
.entity-entry-meta, .entity-entry-description { font-size: 12px; opacity: 0.72; }
|
.entity-entry-meta, .entity-entry-description { font-size: 12px; opacity: 0.72; }
|
||||||
.entity-entry-description { display: -webkit-box; -webkit-box-orient: vertical; -webkit-line-clamp: 2; overflow: hidden; }
|
.entity-entry-description { display: -webkit-box; -webkit-box-orient: vertical; -webkit-line-clamp: 2; overflow: hidden; }
|
||||||
/* An item row leads with the item's own icon on the left of its name, standing in for the
|
|
||||||
"SYNCED" text it used to show (Syndria98/dragonroll#53). */
|
|
||||||
.entity-entry-title { display: flex; align-items: center; gap: 9px; min-width: 0; }
|
|
||||||
/* The rarity of an item colours the text of its row (Syndria98/dragonroll#63): common white,
|
|
||||||
uncommon green, rare blue, very rare purple, legendary orange. */
|
|
||||||
.entity-entry-name.rarity-common { color: var(--color-rarity-common); }
|
|
||||||
.entity-entry-name.rarity-uncommon { color: var(--color-rarity-uncommon); }
|
|
||||||
.entity-entry-name.rarity-rare { color: var(--color-rarity-rare); }
|
|
||||||
.entity-entry-name.rarity-very-rare { color: var(--color-rarity-very-rare); }
|
|
||||||
.entity-entry-name.rarity-legendary { color: var(--color-rarity-legendary); }
|
|
||||||
.entity-entry-image {
|
|
||||||
flex: 0 0 30px; width: 30px; height: 30px; box-sizing: border-box;
|
|
||||||
display: grid; place-items: center; overflow: hidden;
|
|
||||||
border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft);
|
|
||||||
}
|
|
||||||
.entity-entry-image img { width: 100%; height: 100%; object-fit: contain; }
|
|
||||||
|
|
||||||
@media (max-width: 900px) {
|
@media (max-width: 900px) {
|
||||||
.notes-sidebar {
|
.notes-sidebar {
|
||||||
|
|||||||
@@ -1,57 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { ref, onBeforeUnmount, onMounted, watch } from 'vue';
|
import { ref, onBeforeUnmount, onMounted, watch } from 'vue';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
import { BuildColorMenu } from '~/services/EntryColors';
|
|
||||||
import Server from '~/services/Server';
|
import Server from '~/services/Server';
|
||||||
import { CreateWindow } from '~/services/Windows';
|
import { CreateWindow } from '~/services/Windows';
|
||||||
import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu';
|
import { ShowContextMenu, HideContextMenu } from '~/services/ContextMenu';
|
||||||
@@ -21,6 +20,18 @@ const emit = defineEmits(['open-note', 'reload-notes']);
|
|||||||
const loadingFolders = new Set();
|
const loadingFolders = new Set();
|
||||||
const dragHoveredFolderId = ref(null);
|
const dragHoveredFolderId = ref(null);
|
||||||
|
|
||||||
|
// Preset colors for notes and folders (shown as swatches in the context menu)
|
||||||
|
const entryColors = [
|
||||||
|
{ name: 'Red', value: '#e74c3c' },
|
||||||
|
{ name: 'Orange', value: '#e67e22' },
|
||||||
|
{ name: 'Yellow', value: '#f1c40f' },
|
||||||
|
{ name: 'Green', value: '#2ecc71' },
|
||||||
|
{ name: 'Teal', value: '#1abc9c' },
|
||||||
|
{ name: 'Blue', value: '#3498db' },
|
||||||
|
{ name: 'Purple', value: '#9b59b6' },
|
||||||
|
{ name: 'Pink', value: '#fd79a8' }
|
||||||
|
];
|
||||||
|
|
||||||
// Cache of loaded folder contents — persists across reloads until cleared
|
// Cache of loaded folder contents — persists across reloads until cleared
|
||||||
// Each entry: { [folderId]: { notes: [], subfolders: [] } }
|
// Each entry: { [folderId]: { notes: [], subfolders: [] } }
|
||||||
const folderContentCache = ref({});
|
const folderContentCache = ref({});
|
||||||
@@ -205,7 +216,13 @@ function buildFolderContextMenu(folder) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function buildColorMenu(kind, item) {
|
function buildColorMenu(kind, item) {
|
||||||
return BuildColorMenu((color) => setEntryColor(kind, item, color));
|
const colorItems = entryColors.map((color) => ({
|
||||||
|
name: color.name, color: color.value, action: () => setEntryColor(kind, item, color.value)
|
||||||
|
}));
|
||||||
|
|
||||||
|
colorItems.push({ divider: true });
|
||||||
|
colorItems.push({ name: 'Default', icon: '/icons/iconoir/regular/xmark-circle.svg', action: () => setEntryColor(kind, item, null) });
|
||||||
|
return colorItems;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function setEntryColor(kind, item, color) {
|
async function setEntryColor(kind, item, color) {
|
||||||
|
|||||||
@@ -13,13 +13,6 @@ function OpenCampaignSettings() {
|
|||||||
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
||||||
}
|
}
|
||||||
|
|
||||||
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() {
|
function ExitCampaign() {
|
||||||
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
||||||
// l'espai de treball i reobre el menú
|
// l'espai de treball i reobre el menú
|
||||||
@@ -42,11 +35,6 @@ function ExitCampaign() {
|
|||||||
<TopSearchBar></TopSearchBar>
|
<TopSearchBar></TopSearchBar>
|
||||||
</div>
|
</div>
|
||||||
<div class="right">
|
<div class="right">
|
||||||
<!-- La documentació s'obre en una finestra seva, davant de la campanya: les notes
|
|
||||||
obertes no es perden i no cal obrir una pestanya nova. -->
|
|
||||||
<button class="btn-primary settings-button docs-button sound-click" type="button" @click="OpenDocumentation">
|
|
||||||
{{ $t('main-menu.documentation') }}
|
|
||||||
</button>
|
|
||||||
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
||||||
{{ $t('main-menu.settings') }}
|
{{ $t('main-menu.settings') }}
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
@@ -1,30 +1,13 @@
|
|||||||
<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 v-show="ActivePane !== 'map'">
|
<NoteContainer>
|
||||||
|
|
||||||
</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>
|
||||||
@@ -38,14 +21,4 @@ function DetachMap() {
|
|||||||
align-items: center;
|
align-items: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Hidden with v-show so the open notes stay mounted while the anchored map is displayed. */
|
</style>
|
||||||
.anchored-map {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
min-width: 0;
|
|
||||||
flex-grow: 1;
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
}
|
|
||||||
|
|
||||||
</style>
|
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
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([]);
|
||||||
|
|
||||||
@@ -35,9 +34,6 @@ 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);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,5 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
const props = defineProps({
|
defineProps({
|
||||||
title: { type: String, default: '' },
|
title: { type: String, default: '' },
|
||||||
subtitle: { type: String, default: '' },
|
subtitle: { type: String, default: '' },
|
||||||
link: { type: String, default: '' },
|
link: { type: String, default: '' },
|
||||||
|
|||||||
@@ -1,42 +1,24 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { computed, nextTick, onMounted, onUnmounted, ref, watch } from 'vue';
|
import { ref, onMounted, onUnmounted } from 'vue';
|
||||||
import { useI18n } from 'vue-i18n';
|
|
||||||
import SearchIcon from 'pixelarticons/svg/search.svg'
|
import SearchIcon from 'pixelarticons/svg/search.svg'
|
||||||
import PlusIcon from 'pixelarticons/svg/plus.svg'
|
import PlusIcon from 'pixelarticons/svg/plus.svg'
|
||||||
import NoteSearchResult from './SearchResult.vue';
|
import NoteSearchResult from './SearchResult.vue';
|
||||||
import Server from '~/services/Server';
|
import Server from '~/services/Server';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
import { AnchorMap } from '~/services/Content.js';
|
import { CreateWindow } from '~/services/Windows';
|
||||||
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
|
||||||
import { register, search as searchActions, execute as executeAction } from '~/services/ActionRegistry';
|
import { register, search as searchActions, execute as executeAction } from '~/services/ActionRegistry';
|
||||||
import { useCampaignService } from '~/services/Campaign.js';
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
|
||||||
const { Campaign } = useCampaignService();
|
const { Campaign } = useCampaignService();
|
||||||
const { t } = useI18n();
|
|
||||||
|
|
||||||
const inputText = ref('');
|
const inputText = ref('');
|
||||||
|
|
||||||
// Everything the palette searches: the campaign's notes, actors, items and maps.
|
|
||||||
const notes = ref([]);
|
const notes = ref([]);
|
||||||
const actors = ref([]);
|
|
||||||
const items = ref([]);
|
|
||||||
const maps = ref([]);
|
|
||||||
|
|
||||||
const showResults = ref(false);
|
const showResults = ref(false);
|
||||||
const selectedIndex = ref(-1);
|
const selectedIndex = ref(-1);
|
||||||
|
|
||||||
const focusInput = ref(null);
|
const focusInput = ref(null);
|
||||||
|
|
||||||
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
|
|
||||||
|
|
||||||
// The lists belong to one campaign; when another one opens they are dropped and refetched.
|
|
||||||
watch(campaignId, () => {
|
|
||||||
notes.value = [];
|
|
||||||
actors.value = [];
|
|
||||||
items.value = [];
|
|
||||||
maps.value = [];
|
|
||||||
});
|
|
||||||
|
|
||||||
// ---- Keyboard shortcut to open search ----
|
// ---- Keyboard shortcut to open search ----
|
||||||
function globalKeydown(e) {
|
function globalKeydown(e) {
|
||||||
const modKey = e.metaKey || e.ctrlKey;
|
const modKey = e.metaKey || e.ctrlKey;
|
||||||
@@ -69,166 +51,100 @@ function registerCreateNoteAction() {
|
|||||||
register(action);
|
register(action);
|
||||||
}
|
}
|
||||||
|
|
||||||
// ---- Campaign entries to search ----
|
// ---- Note search ----
|
||||||
// The same accent- and case-insensitive normalisation the action filter uses, so a match is
|
async function fetchNotes() {
|
||||||
// never hidden by how the name was written.
|
if (!Campaign.value) return;
|
||||||
function normalize(text) {
|
|
||||||
return (text || '').normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().trim();
|
const campaignId = Campaign.value?._id ?? Campaign.value?.id;
|
||||||
}
|
|
||||||
|
|
||||||
async function fetchList(path, key) {
|
|
||||||
try {
|
try {
|
||||||
const response = await Server().get(path, { params: { campaign: campaignId.value } });
|
const response = await Server().get('/note/list', { params: { campaign: campaignId } });
|
||||||
if (response.data.status !== 'ok') return [];
|
if (response.data.status !== 'ok') {
|
||||||
return response.data[key] ?? [];
|
notes.value = [];
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
notes.value = response.data.notes.map(n => ({
|
||||||
|
key: n._id,
|
||||||
|
title: n.title || 'Untitled',
|
||||||
|
date: n.date
|
||||||
|
}));
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return [];
|
notes.value = [];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function fetchSearchEntries() {
|
function openNote(note) {
|
||||||
if (!campaignId.value) return;
|
emitter.emit('push-note', note);
|
||||||
// /note/all covers notes nested in folders too, unlike the sidebar's /note/list.
|
closeResults();
|
||||||
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 ----
|
// ---- Unified results: notes + command actions ----
|
||||||
function getCombinedResults(query) {
|
function getCombinedResults(query) {
|
||||||
const combined = [];
|
const combined = [];
|
||||||
const q = normalize(query);
|
|
||||||
|
|
||||||
function pushMatches(list, type, getName) {
|
if (query && query.trim().length > 0) {
|
||||||
for (const data of list) {
|
const q = query.normalize("NFD").replace(/[\u036f]/g, "").toLowerCase().trim();
|
||||||
if (q && !normalize(getName(data)).includes(q)) continue;
|
|
||||||
combined.push({ type, data });
|
// Filter notes that match the query text
|
||||||
|
const matchingNotes = notes.value.filter(note => {
|
||||||
|
const title = (note.title || '').normalize("NFD").replace(/[\u036f]/g, "").toLowerCase();
|
||||||
|
return title.includes(q);
|
||||||
|
});
|
||||||
|
|
||||||
|
for (const note of matchingNotes) {
|
||||||
|
combined.push({ type: 'note', data: note });
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
pushMatches(notes.value, 'note', n => n.title);
|
// Search command actions
|
||||||
pushMatches(actors.value, 'actor', a => a.name);
|
const matchedActions = searchActions(query);
|
||||||
pushMatches(items.value, 'item', i => i.name);
|
for (const action of matchedActions) {
|
||||||
pushMatches(maps.value, 'map', m => m.name);
|
combined.push({ type: 'action', data: action });
|
||||||
|
}
|
||||||
// Command actions match on their label and description themselves.
|
} else if (query === '' || query === null) {
|
||||||
for (const action of searchActions(query ?? '')) {
|
// Empty query - show all notes + all actions
|
||||||
combined.push({ type: 'action', data: action });
|
for (const note of notes.value) {
|
||||||
|
combined.push({ type: 'note', data: note });
|
||||||
|
}
|
||||||
|
const allActions = searchActions('');
|
||||||
|
for (const action of allActions) {
|
||||||
|
combined.push({ type: 'action', data: action });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return combined;
|
return combined;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Each result type renders like the sidebar row of that entry: the section's icon and name.
|
|
||||||
const resultIcons = {
|
|
||||||
note: '/icons/iconoir/regular/book.svg',
|
|
||||||
actor: '/icons/iconoir/regular/user.svg',
|
|
||||||
item: '/icons/iconoir/regular/box.svg',
|
|
||||||
map: '/icons/iconoir/regular/map.svg'
|
|
||||||
};
|
|
||||||
|
|
||||||
function resultTitle(item) {
|
|
||||||
if (item.type === 'action') return item.data.label;
|
|
||||||
return item.data.title || item.data.name || 'Untitled';
|
|
||||||
}
|
|
||||||
|
|
||||||
function resultSubtitle(item) {
|
|
||||||
if (item.type === 'action') return item.data.description;
|
|
||||||
return t(`campaigns.sections.${item.type}s`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function resultIcon(item) {
|
|
||||||
return item.type === 'action' ? PlusIcon : resultIcons[item.type];
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---- Opening a result, the way the sidebar opens that kind of entry ----
|
|
||||||
async function openNote(note) {
|
|
||||||
closeResults();
|
|
||||||
// /note/all never carries content; retrieve the note to open it with its text.
|
|
||||||
try {
|
|
||||||
const response = await Server().get(`/note/retrieve/${note.key}`);
|
|
||||||
if (response.data.status !== 'ok' || !response.data.note) return;
|
|
||||||
const full = response.data.note;
|
|
||||||
emitter.emit('push-note', { key: full._id, title: full.title, text: full.content ?? '', date: full.date });
|
|
||||||
} catch (err) {}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A character or an item replaces the sheet window that is already open.
|
|
||||||
async function openActor(actor) {
|
|
||||||
closeResults();
|
|
||||||
const existingWindowId = GetFirstWindowId('character_sheet');
|
|
||||||
if (existingWindowId !== undefined) {
|
|
||||||
ClearWindow({ id: existingWindowId });
|
|
||||||
await nextTick();
|
|
||||||
}
|
|
||||||
CreateWindow('character_sheet', { actor });
|
|
||||||
}
|
|
||||||
|
|
||||||
async function openItem(item) {
|
|
||||||
closeResults();
|
|
||||||
const existingWindowId = GetFirstWindowId('item_sheet');
|
|
||||||
if (existingWindowId !== undefined) {
|
|
||||||
ClearWindow({ id: existingWindowId });
|
|
||||||
await nextTick();
|
|
||||||
}
|
|
||||||
CreateWindow('item_sheet', { item });
|
|
||||||
}
|
|
||||||
|
|
||||||
// Maps anchor on the note container instead of opening a window, like from the sidebar.
|
|
||||||
function openMap(map) {
|
|
||||||
closeResults();
|
|
||||||
const floatingViewer = GetFirstWindowId('map_viewer');
|
|
||||||
if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
|
|
||||||
AnchorMap(map);
|
|
||||||
}
|
|
||||||
|
|
||||||
function openResult(item) {
|
|
||||||
if (!item) return;
|
|
||||||
|
|
||||||
if (item.type === 'note') openNote(item.data);
|
|
||||||
else if (item.type === 'actor') openActor(item.data);
|
|
||||||
else if (item.type === 'item') openItem(item.data);
|
|
||||||
else if (item.type === 'map') openMap(item.data);
|
|
||||||
else {
|
|
||||||
executeAction(item.data.id);
|
|
||||||
closeResults();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---- Input handling ----
|
// ---- Input handling ----
|
||||||
function onInput(event) {
|
function onInput(event) {
|
||||||
inputText.value = event.target.value;
|
const query = event.target.value;
|
||||||
|
inputText.value = query;
|
||||||
selectedIndex.value = -1;
|
selectedIndex.value = -1;
|
||||||
|
|
||||||
|
if (!query || query.trim() === '') {
|
||||||
|
showResults.value = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
showResults.value = true;
|
showResults.value = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function onFocus() {
|
function onFocus() {
|
||||||
showResults.value = true;
|
if (notes.value.length === 0) {
|
||||||
// Foundry keeps syncing entries into the campaign in the background: refresh every time the
|
fetchNotes().then(() => {
|
||||||
// palette is opened so it never offers stale results.
|
showResults.value = true;
|
||||||
if (campaignId.value) fetchSearchEntries();
|
});
|
||||||
|
} else {
|
||||||
|
showResults.value = true;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function onBlur() {
|
function onBlur(event) {
|
||||||
// Delay closing to allow click on results
|
// Delay closing to allow click on results
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
closeResults();
|
closeResults();
|
||||||
}, 150);
|
}, 150);
|
||||||
}
|
}
|
||||||
|
|
||||||
function onKeydown(event) {
|
async function onKeydown(event) {
|
||||||
const combined = getCombinedResults(inputText.value);
|
const combined = getCombinedResults(inputText.value);
|
||||||
|
|
||||||
if (event.key === 'ArrowDown') {
|
if (event.key === 'ArrowDown') {
|
||||||
@@ -246,9 +162,16 @@ function onKeydown(event) {
|
|||||||
if (event.key === 'Enter') {
|
if (event.key === 'Enter') {
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
if (selectedIndex.value >= 0) {
|
if (selectedIndex.value >= 0) {
|
||||||
openResult(combined[selectedIndex.value]);
|
const item = combined[selectedIndex.value];
|
||||||
|
if (!item) return;
|
||||||
|
|
||||||
|
if (item.type === 'note') {
|
||||||
|
openNote(item.data);
|
||||||
|
} else if (item.type === 'action') {
|
||||||
|
executeAction(item.data.id);
|
||||||
|
closeResults();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (event.key === 'Escape') {
|
if (event.key === 'Escape') {
|
||||||
@@ -256,6 +179,21 @@ function onKeydown(event) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function onSelect(result) {
|
||||||
|
if (!result) return;
|
||||||
|
|
||||||
|
if (result.link) {
|
||||||
|
const note = notes.value.find(n => n.key === result.link);
|
||||||
|
if (note) openNote(note);
|
||||||
|
}
|
||||||
|
closeResults();
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleActionSelect(actionData) {
|
||||||
|
executeAction(actionData.id);
|
||||||
|
closeResults();
|
||||||
|
}
|
||||||
|
|
||||||
function closeResults() {
|
function closeResults() {
|
||||||
showResults.value = false;
|
showResults.value = false;
|
||||||
selectedIndex.value = -1;
|
selectedIndex.value = -1;
|
||||||
@@ -293,19 +231,21 @@ onUnmounted(() => {
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="search-container" v-if="showResults">
|
<div class="search-container" v-if="showResults">
|
||||||
<template v-if="getCombinedResults(inputText).length === 0">
|
<template v-if="getCombinedResults(inputText).length === 0 && inputText.trim()">
|
||||||
<div class="search-empty">No results found</div>
|
<div class="search-empty">No results found</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<div class="search-container-list">
|
<div class="search-container-list">
|
||||||
<NoteSearchResult
|
<NoteSearchResult
|
||||||
v-for="(item, index) in getCombinedResults(inputText)"
|
v-for="(item, index) in getCombinedResults(inputText)"
|
||||||
:key="item.type + '-' + (item.data.key || item.data._id || item.data.id) + '-' + index"
|
:key="(item.data.key || item.data.id) + '-' + index"
|
||||||
:title="resultTitle(item)"
|
:title="item.type === 'note' ? item.data.title : item.data.label"
|
||||||
:subtitle="resultSubtitle(item)"
|
:subtitle="item.type === 'action' ? item.data.description : ''"
|
||||||
:icon="resultIcon(item)"
|
:link="item.type === 'note' ? item.data.key : null"
|
||||||
|
:icon="item.type === 'action' ? PlusIcon : ''"
|
||||||
:class="{ selected: index === selectedIndex }"
|
:class="{ selected: index === selectedIndex }"
|
||||||
@click.stop.prevent="openResult(item)"
|
@select="onSelect"
|
||||||
|
@click.stop.prevent="() => { if (item.type === 'note') openNote(item.data); else handleActionSelect(item.data); }"
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -89,11 +89,9 @@ onMounted(() => {
|
|||||||
.steps {
|
.steps {
|
||||||
margin-left: 8px;
|
margin-left: 8px;
|
||||||
height: 22px;
|
height: 22px;
|
||||||
}
|
> {
|
||||||
/* No nested `> {}` here: the scoped style transform turns it into a dangling
|
font-size: 12px;
|
||||||
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;
|
||||||
|
|||||||
@@ -1,67 +0,0 @@
|
|||||||
<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>
|
|
||||||
260
frontend/app/components/views/DiscordAuthorize.vue
Normal file
260
frontend/app/components/views/DiscordAuthorize.vue
Normal file
@@ -0,0 +1,260 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onMounted, ref } from 'vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { GetUser, SetUser } from '~/services/User';
|
||||||
|
import { AddSound } from '~/services/Sound';
|
||||||
|
import Spinner from '../partials/Spinner.vue';
|
||||||
|
|
||||||
|
// Pantalla autònoma que el bot obre des de Discord: l'usuari s'identifica aquí
|
||||||
|
// i autoritza el servidor de Discord que s'ha rebut per la URL.
|
||||||
|
useHead({ title: 'Connect Dragonroll to Discord' });
|
||||||
|
|
||||||
|
const card = ref(null);
|
||||||
|
|
||||||
|
const code = ref('');
|
||||||
|
const guildName = ref('');
|
||||||
|
const discordUserName = ref('');
|
||||||
|
const signedInAs = ref('');
|
||||||
|
const connectedGuild = ref('');
|
||||||
|
|
||||||
|
// 'checking' | 'login' | 'approve' | 'connected' | 'error'
|
||||||
|
const status = ref('checking');
|
||||||
|
const messageKey = ref('');
|
||||||
|
|
||||||
|
const username = ref('');
|
||||||
|
const password = ref('');
|
||||||
|
const busy = ref(false);
|
||||||
|
|
||||||
|
function readCode() {
|
||||||
|
const hash = new URLSearchParams(window.location.hash.slice(1));
|
||||||
|
const search = new URLSearchParams(window.location.search);
|
||||||
|
return hash.get('code') || search.get('code') || '';
|
||||||
|
}
|
||||||
|
|
||||||
|
function ShowError(key) {
|
||||||
|
messageKey.value = key;
|
||||||
|
}
|
||||||
|
|
||||||
|
function PrepareApproval() {
|
||||||
|
const user = GetUser();
|
||||||
|
if (!user) {
|
||||||
|
status.value = 'login';
|
||||||
|
messageKey.value = '';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
signedInAs.value = user.username || user.name || user.email || 'Dragonroll';
|
||||||
|
status.value = 'approve';
|
||||||
|
messageKey.value = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
async function LoadRequest() {
|
||||||
|
const response = await Server().post('/discord/link/details', { code: code.value });
|
||||||
|
const details = response.data;
|
||||||
|
if (details.status !== 'ok') {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('discord.errors.link-expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
guildName.value = details.guildName;
|
||||||
|
discordUserName.value = details.discordUserName;
|
||||||
|
PrepareApproval();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function SignIn() {
|
||||||
|
busy.value = true;
|
||||||
|
messageKey.value = '';
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/user/login', {
|
||||||
|
usermail: username.value,
|
||||||
|
password: password.value
|
||||||
|
});
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok' || !response.data.token) {
|
||||||
|
ShowError(response.data.msg || 'discord.errors.sign-in-failed');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// El token passa al servei d'usuari perquè el client el reutilitzi en autoritzar.
|
||||||
|
SetUser(response.data.token);
|
||||||
|
password.value = '';
|
||||||
|
PrepareApproval();
|
||||||
|
} catch {
|
||||||
|
ShowError('discord.errors.sign-in-failed');
|
||||||
|
} finally {
|
||||||
|
busy.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function Authorize() {
|
||||||
|
busy.value = true;
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/discord/link/complete', { code: code.value });
|
||||||
|
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('discord.errors.link-expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
connectedGuild.value = response.data.guildName;
|
||||||
|
status.value = 'connected';
|
||||||
|
messageKey.value = '';
|
||||||
|
// El codi ja s'ha fet servir, treu-lo de la barra d'adreces.
|
||||||
|
window.history.replaceState(null, '', window.location.pathname);
|
||||||
|
} catch (error) {
|
||||||
|
if (error?.response?.status === 401) {
|
||||||
|
status.value = 'login';
|
||||||
|
ShowError('discord.errors.session-expired');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('discord.errors.link-expired');
|
||||||
|
} finally {
|
||||||
|
busy.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
AddSound(card.value);
|
||||||
|
code.value = readCode();
|
||||||
|
|
||||||
|
if (!code.value) {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('discord.errors.missing-code');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
LoadRequest().catch(() => {
|
||||||
|
status.value = 'error';
|
||||||
|
ShowError('discord.errors.internal');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="discord-authorize">
|
||||||
|
<main class="authorize-card" ref="card">
|
||||||
|
<h1>{{ $t('discord.title') }}</h1>
|
||||||
|
|
||||||
|
<p v-if="guildName" class="summary">
|
||||||
|
{{ $t('discord.summary', { guild: guildName, user: discordUserName }) }}
|
||||||
|
</p>
|
||||||
|
<p v-else-if="status !== 'error'" class="summary">
|
||||||
|
<Spinner v-if="status === 'checking'"></Spinner>
|
||||||
|
<span v-else>{{ $t('discord.checking') }}</span>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<form v-if="status === 'login'" v-on:submit.prevent="SignIn">
|
||||||
|
<p>{{ $t('discord.sign-in-lead') }}</p>
|
||||||
|
<div class="form-field">
|
||||||
|
<label for="discord-authorize-usermail">{{ $t('login.username') }}</label>
|
||||||
|
<input
|
||||||
|
id="discord-authorize-usermail"
|
||||||
|
type="text"
|
||||||
|
:placeholder="$t('login.username-placeholder')"
|
||||||
|
name="usermail"
|
||||||
|
autocomplete="username"
|
||||||
|
v-model="username"
|
||||||
|
required
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<div class="form-field">
|
||||||
|
<label for="discord-authorize-password">{{ $t('login.password') }}</label>
|
||||||
|
<input
|
||||||
|
id="discord-authorize-password"
|
||||||
|
type="password"
|
||||||
|
name="password"
|
||||||
|
autocomplete="current-password"
|
||||||
|
v-model="password"
|
||||||
|
required
|
||||||
|
>
|
||||||
|
</div>
|
||||||
|
<button class="btn-primary sound-click" type="submit" :disabled="busy">
|
||||||
|
<Spinner v-if="busy"></Spinner>
|
||||||
|
<span v-else>{{ $t('login.log-in') }}</span>
|
||||||
|
</button>
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<section v-if="status === 'approve'">
|
||||||
|
<p>{{ $t('discord.signed-in-as', { user: signedInAs }) }}</p>
|
||||||
|
<p class="hint">{{ $t('discord.next-step') }}</p>
|
||||||
|
<p class="hint">{{ $t('discord.replace-warning') }}</p>
|
||||||
|
<button class="btn-primary sound-click" type="button" :disabled="busy" v-on:click="Authorize">
|
||||||
|
<Spinner v-if="busy"></Spinner>
|
||||||
|
<span v-else>{{ $t('discord.approve') }}</span>
|
||||||
|
</button>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section v-if="status === 'connected'">
|
||||||
|
<p class="success">{{ $t('discord.connected', { guild: connectedGuild }) }}</p>
|
||||||
|
<p class="hint">{{ $t('discord.next-step') }}</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<p v-if="messageKey" class="error" role="status">
|
||||||
|
{{ $t(messageKey) }}
|
||||||
|
</p>
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.discord-authorize {
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
padding: 24px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.authorize-card {
|
||||||
|
width: min(100%, 460px);
|
||||||
|
padding: 28px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-window-background);
|
||||||
|
border: 1px solid var(--color-window-border);
|
||||||
|
border-radius: 12px;
|
||||||
|
box-shadow: 0 8px 24px var(--color-window-shadow);
|
||||||
|
text-align: center;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.authorize-card h1 {
|
||||||
|
margin-top: 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.authorize-card p {
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.summary {
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
form,
|
||||||
|
section {
|
||||||
|
margin-top: 18px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hint {
|
||||||
|
color: var(--color-gray);
|
||||||
|
font-size: 0.95rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.success {
|
||||||
|
color: var(--color-green);
|
||||||
|
}
|
||||||
|
|
||||||
|
.error {
|
||||||
|
color: var(--color-red);
|
||||||
|
}
|
||||||
|
|
||||||
|
button {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -1,343 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,395 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,289 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { onMounted, ref } from 'vue';
|
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
import Tabs from '../layouts/Tabs.vue';
|
import Tabs from '../layouts/Tabs.vue';
|
||||||
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||||
@@ -17,20 +17,18 @@ const name = ref(campaign.name || '');
|
|||||||
const color = ref(campaign.color || '#6b6b6b');
|
const color = ref(campaign.color || '#6b6b6b');
|
||||||
const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
|
const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
|
||||||
const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
|
const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
|
||||||
|
const pairingCode = ref('');
|
||||||
|
const requestId = ref('');
|
||||||
|
const linking = ref(false);
|
||||||
const id = data.id;
|
const id = data.id;
|
||||||
|
let statusPoll;
|
||||||
// Els serveis s'enllacen tots igual: ells mostren un enllaç de Dragonroll i aquí
|
let checkingStatus = false;
|
||||||
// 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 = [
|
const rows = [
|
||||||
{ id: 'basic', value: 'campaigns.settings.tabs.basic' },
|
{ id: 'basic', value: 'campaigns.settings.tabs.basic' },
|
||||||
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
|
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
|
||||||
];
|
];
|
||||||
|
|
||||||
const serviceKeys = ['foundry', 'discord', 'obsidian'];
|
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
Top(wrapper);
|
Top(wrapper);
|
||||||
SetupHandle(id, handle);
|
SetupHandle(id, handle);
|
||||||
@@ -38,7 +36,11 @@ onMounted(() => {
|
|||||||
ResetPosition(id, 'center');
|
ResetPosition(id, 'center');
|
||||||
SetResizable(id, true);
|
SetResizable(id, true);
|
||||||
SetMinSize(id, { width: 440, height: 340 });
|
SetMinSize(id, { width: 440, height: 340 });
|
||||||
LoadServices();
|
ResumePendingFoundryLink();
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
clearInterval(statusPoll);
|
||||||
});
|
});
|
||||||
|
|
||||||
function ApplyCampaignUpdate(updatedCampaign) {
|
function ApplyCampaignUpdate(updatedCampaign) {
|
||||||
@@ -98,56 +100,95 @@ async function SaveSettings() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function LoadServices() {
|
async function StartFoundryLink() {
|
||||||
|
linking.value = true;
|
||||||
try {
|
try {
|
||||||
const response = await Server().get(`/campaign/services?campaignId=${campaign._id}`);
|
const response = await Server().post('/campaign/foundry-link/start', { campaignId: campaign._id });
|
||||||
services.value = response.data.status === 'ok' && Array.isArray(response.data.services)
|
if (response.data.status !== 'ok') {
|
||||||
? response.data.services
|
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||||
: [];
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
pairingCode.value = response.data.code;
|
||||||
|
requestId.value = response.data.requestId;
|
||||||
|
clearInterval(statusPoll);
|
||||||
|
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
|
||||||
} catch {
|
} catch {
|
||||||
services.value = [];
|
DisplayToast('red', $t('errors.internal'), 3000);
|
||||||
|
} finally {
|
||||||
|
linking.value = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function LinkFor(service) {
|
// The pairing code lives server-side until it expires, so re-attach to it when
|
||||||
return services.value.find((link) => link.service === service) || null;
|
// the window opens again after a reload, restart or closing the window.
|
||||||
}
|
async function ResumePendingFoundryLink() {
|
||||||
|
|
||||||
// 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 {
|
try {
|
||||||
const response = await Server().post('/campaign/service-unlink', {
|
const response = await Server().get(`/campaign/foundry-link/pending?campaignId=${campaign._id}`);
|
||||||
campaignId: campaign._id,
|
if (response.data.status !== 'ok' || !response.data.request) return;
|
||||||
service
|
|
||||||
});
|
|
||||||
|
|
||||||
|
pairingCode.value = response.data.request.code || '';
|
||||||
|
requestId.value = response.data.request.requestId;
|
||||||
|
clearInterval(statusPoll);
|
||||||
|
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
|
||||||
|
} catch {
|
||||||
|
// Showing the stored pairing code is best-effort; ignore resume failures.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function CheckFoundryLinkStatus() {
|
||||||
|
if (!requestId.value || checkingStatus) return;
|
||||||
|
checkingStatus = true;
|
||||||
|
try {
|
||||||
|
const response = await Server().get(`/campaign/foundry-link/status/${requestId.value}`);
|
||||||
|
if (response.data.status !== 'ok' || response.data.state === 'expired') {
|
||||||
|
clearInterval(statusPoll);
|
||||||
|
pairingCode.value = '';
|
||||||
|
requestId.value = '';
|
||||||
|
const error = response.data.state === 'expired'
|
||||||
|
? 'campaigns.settings.errors.link-expired'
|
||||||
|
: response.data.msg || 'campaigns.settings.errors.link-expired';
|
||||||
|
DisplayToast('red', $t(error), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (response.data.state === 'complete') {
|
||||||
|
ApplyCampaignUpdate(response.data.campaign);
|
||||||
|
clearInterval(statusPoll);
|
||||||
|
pairingCode.value = '';
|
||||||
|
requestId.value = '';
|
||||||
|
DisplayToast('green', $t('campaigns.settings.linked'), 3000);
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// Keep polling while the Foundry module completes the pairing.
|
||||||
|
} finally {
|
||||||
|
checkingStatus = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function UnlinkFoundry() {
|
||||||
|
linking.value = true;
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/campaign/foundry-unlink', { campaignId: campaign._id });
|
||||||
if (response.data.status !== 'ok') {
|
if (response.data.status !== 'ok') {
|
||||||
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
ApplyCampaignUpdate(response.data.campaign);
|
ApplyCampaignUpdate(response.data.campaign);
|
||||||
services.value = Array.isArray(response.data.services) ? response.data.services : [];
|
DisplayToast('green', $t('campaigns.settings.unlinked'), 3000);
|
||||||
DisplayToast('green', $t('campaigns.settings.services.unlinked', {
|
|
||||||
service: $t(`campaigns.settings.services.${service}.name`)
|
|
||||||
}), 3000);
|
|
||||||
} catch {
|
} catch {
|
||||||
DisplayToast('red', $t('errors.internal'), 3000);
|
DisplayToast('red', $t('errors.internal'), 3000);
|
||||||
} finally {
|
} finally {
|
||||||
unlinked.value = '';
|
linking.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function CopyPairingCode() {
|
||||||
|
try {
|
||||||
|
await navigator.clipboard.writeText(pairingCode.value);
|
||||||
|
DisplayToast('green', $t('campaigns.settings.code-copied'), 2000);
|
||||||
|
} catch {
|
||||||
|
DisplayToast('red', $t('campaigns.settings.errors.copy-code'), 3000);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
@@ -171,33 +212,29 @@ async function Unlink(service) {
|
|||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
<template #integrations>
|
<template #integrations>
|
||||||
<p class="help-text standalone">{{ $t('campaigns.settings.services.help') }}</p>
|
|
||||||
<div class="settings-fields">
|
<div class="settings-fields">
|
||||||
<div v-for="service in serviceKeys" :key="service" class="service">
|
<div class="world-link">
|
||||||
<div class="service-head">
|
<div v-if="campaign.foundryWorldId" class="linked-world">
|
||||||
<strong>{{ $t(`campaigns.settings.services.${service}.name`) }}</strong>
|
<strong>{{ campaign.foundryWorldTitle || campaign.foundryWorldId }}</strong>
|
||||||
<button
|
<span v-if="campaign.foundrySystem">{{ campaign.foundrySystem }}</span>
|
||||||
v-if="LinkFor(service)"
|
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="UnlinkFoundry">
|
||||||
class="btn-primary sound-click"
|
{{ $t('campaigns.settings.unlink-foundry') }}
|
||||||
type="button"
|
</button>
|
||||||
:disabled="unlinked !== ''"
|
</div>
|
||||||
@click="Unlink(service)"
|
<p v-else class="help-text standalone">{{ $t('campaigns.settings.no-foundry-world') }}</p>
|
||||||
>
|
|
||||||
{{ $t('campaigns.settings.services.unlink') }}
|
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="StartFoundryLink">
|
||||||
|
{{ $t('campaigns.settings.start-foundry-link') }}
|
||||||
|
</button>
|
||||||
|
<p class="help-text standalone">{{ $t('campaigns.settings.start-foundry-link-help') }}</p>
|
||||||
|
<div v-if="pairingCode" class="pairing-code">
|
||||||
|
<code>{{ pairingCode }}</code>
|
||||||
|
<button class="btn-primary sound-click" type="button" @click="CopyPairingCode">
|
||||||
|
{{ $t('campaigns.settings.copy-code') }}
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</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>
|
|
||||||
<div class="settings-fields">
|
|
||||||
<label class="field">
|
<label class="field">
|
||||||
<span>{{ $t('campaigns.settings.foundry-url') }}</span>
|
<span>{{ $t('campaigns.settings.foundry-url') }}</span>
|
||||||
<input
|
<input
|
||||||
@@ -276,36 +313,40 @@ input {
|
|||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.service {
|
.world-link {
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
gap: 6px;
|
gap: 10px;
|
||||||
padding-bottom: 14px;
|
padding-bottom: 14px;
|
||||||
border-bottom: 1px solid var(--color-border);
|
border-bottom: 1px solid var(--color-border);
|
||||||
}
|
}
|
||||||
|
|
||||||
.service-head {
|
.linked-world {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.linked-world span {
|
||||||
|
opacity: 0.75;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pairing-code {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
justify-content: space-between;
|
justify-content: space-between;
|
||||||
gap: 10px;
|
gap: 10px;
|
||||||
|
padding: 10px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.service-state {
|
.pairing-code code {
|
||||||
margin: 0;
|
user-select: text;
|
||||||
font-size: 14px;
|
|
||||||
overflow-wrap: anywhere;
|
overflow-wrap: anywhere;
|
||||||
}
|
}
|
||||||
|
|
||||||
.service-state.linked {
|
|
||||||
color: var(--color-green);
|
|
||||||
}
|
|
||||||
|
|
||||||
.who {
|
|
||||||
opacity: 0.75;
|
|
||||||
font-size: 13px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.actions {
|
.actions {
|
||||||
display: flex;
|
display: flex;
|
||||||
justify-content: flex-end;
|
justify-content: flex-end;
|
||||||
|
|||||||
@@ -24,49 +24,6 @@ const abilityStats = [
|
|||||||
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
||||||
];
|
];
|
||||||
|
|
||||||
// Les 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) {
|
function normalizeActor(actor) {
|
||||||
return {
|
return {
|
||||||
name: actor?.name ?? '',
|
name: actor?.name ?? '',
|
||||||
@@ -77,28 +34,9 @@ function normalizeActor(actor) {
|
|||||||
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
|
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
|
||||||
armorClass: Number(actor?.armorClass ?? 10),
|
armorClass: Number(actor?.armorClass ?? 10),
|
||||||
speed: Number(actor?.speed ?? 30),
|
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 ?? '',
|
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) => ({
|
inventory: (actor?.inventory ?? []).map((item) => ({
|
||||||
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0),
|
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0)
|
||||||
icon: item.icon ?? ''
|
|
||||||
})),
|
})),
|
||||||
traits: actor?.traits ?? '',
|
traits: actor?.traits ?? '',
|
||||||
spells: actor?.spells ?? '',
|
spells: actor?.spells ?? '',
|
||||||
@@ -112,11 +50,8 @@ original.value = normalizeActor(props.data.actor);
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
Top(wrapper);
|
Top(wrapper);
|
||||||
SetupHandle(id, handle);
|
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, {
|
SetSize(id, {
|
||||||
width: Math.max(320, Math.min(900, window.innerWidth - 24 - railRoom)),
|
width: Math.max(320, Math.min(900, window.innerWidth - 24)),
|
||||||
height: Math.max(360, Math.min(700, window.innerHeight - 32))
|
height: Math.max(360, Math.min(700, window.innerHeight - 32))
|
||||||
});
|
});
|
||||||
ResetPosition(id, 'center');
|
ResetPosition(id, 'center');
|
||||||
@@ -134,50 +69,21 @@ onMounted(() => emitter.on('campaign-entry-updated', handleActorSync));
|
|||||||
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
|
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
|
||||||
|
|
||||||
const proficiencyBonus = computed(() => Math.ceil(form.value.level / 4) + 1);
|
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 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 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));
|
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
|
function abilityModifier(score) {
|
||||||
// salvació del personatge que hi està entrenat.
|
const modifier = Math.floor((Number(score) - 10) / 2);
|
||||||
function abilityModifier(score, bonus = 0) {
|
|
||||||
const modifier = Math.floor((Number(score) - 10) / 2) + (Number(bonus) || 0);
|
|
||||||
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
||||||
}
|
}
|
||||||
|
|
||||||
function skillModifier(skill) {
|
const imageUrl = computed(() => {
|
||||||
return abilityModifier(form.value.abilityScores[skill.ability], form.value.skills[skill.key] ? proficiencyBonus.value : 0);
|
if (!form.value.image) return '';
|
||||||
}
|
return /^(https?:|data:|\/\/)/i.test(form.value.image)
|
||||||
|
? form.value.image
|
||||||
function savingThrowModifier(stat) {
|
: `${getBaseUrl()}/public/${form.value.image}`;
|
||||||
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() {
|
function pickPhoto() {
|
||||||
photoInput.value?.click();
|
photoInput.value?.click();
|
||||||
@@ -241,9 +147,6 @@ async function saveSheet() {
|
|||||||
const payload = {
|
const payload = {
|
||||||
id: actorId,
|
id: actorId,
|
||||||
...form.value,
|
...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())
|
inventory: form.value.inventory.filter((item) => item.name.trim())
|
||||||
};
|
};
|
||||||
const response = await Server().post('/actor/update', payload);
|
const response = await Server().post('/actor/update', payload);
|
||||||
@@ -266,21 +169,6 @@ async function saveSheet() {
|
|||||||
<template>
|
<template>
|
||||||
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
|
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
<WindowHandle :window="id" ref="handle" />
|
<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">
|
<div class="sheet-body">
|
||||||
<header class="sheet-hero">
|
<header class="sheet-hero">
|
||||||
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
|
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
|
||||||
@@ -319,219 +207,101 @@ async function saveSheet() {
|
|||||||
|
|
||||||
<div v-if="error" class="sheet-error">{{ error }}</div>
|
<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
|
<main class="sheet-grid">
|
||||||
d'anada i tornada — classe d'armadura, velocitat, bonificadors i les barres de
|
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
|
||||||
cops — es queden a la vista des de qualsevol pestanya de la fitxa. -->
|
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
|
||||||
<div class="sheet-layout">
|
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
<div class="character-column">
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
|
||||||
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
|
</button>
|
||||||
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
|
<div v-if="editing && form.image" class="portrait-controls">
|
||||||
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
<button type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.change-photo') }}
|
||||||
</button>
|
</button>
|
||||||
<div v-if="editing && form.image" class="portrait-controls">
|
<button type="button" :disabled="uploadingPhoto" :aria-label="$t('campaigns.character-sheet.remove-photo')" @click="removePhoto">×</button>
|
||||||
<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>
|
</div>
|
||||||
|
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onPhotoSelected">
|
||||||
<!-- 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>
|
</div>
|
||||||
|
|
||||||
<main v-show="activeTab === 'abilities'" class="sheet-tab-body">
|
<section class="sheet-panel abilities-panel">
|
||||||
<section class="sheet-panel abilities-panel">
|
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||||
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
<div class="ability-grid">
|
||||||
<div class="ability-grid">
|
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
||||||
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
<span class="ability-label">{{ stat.label }}</span>
|
||||||
<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">
|
||||||
<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>
|
||||||
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
||||||
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="proficiency-badge">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.proficiency-bonus') }}</span>
|
||||||
|
<strong>+{{ proficiencyBonus }}</strong>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<!-- Les tirades de salvació van just a sota de les característiques, que
|
<section class="sheet-panel combat-panel">
|
||||||
són les que les manen: el cercle diu si el personatge hi està entrenat. -->
|
<h2>{{ $t('campaigns.character-sheet.combat') }}</h2>
|
||||||
<h3>{{ $t('campaigns.character-sheet.saving-throws') }}</h3>
|
<div class="combat-stats">
|
||||||
<div class="saving-throw-grid">
|
<div class="combat-stat">
|
||||||
<button
|
<span>{{ $t('campaigns.character-sheet.armor-class') }}</span>
|
||||||
v-for="stat in abilityStats"
|
<input v-if="editing" v-model.number="form.armorClass" type="number" min="0">
|
||||||
:key="stat.key"
|
<strong v-else>{{ form.armorClass }}</strong>
|
||||||
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>
|
</div>
|
||||||
</section>
|
<div class="combat-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.speed') }}</span>
|
||||||
<section class="sheet-panel skills-panel">
|
<label v-if="editing" class="number-with-unit"><input v-model.number="form.speed" type="number" min="0"><small>ft</small></label>
|
||||||
<h2>{{ $t('campaigns.character-sheet.skills') }}</h2>
|
<strong v-else>{{ form.speed }} <small>ft</small></strong>
|
||||||
<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>
|
</div>
|
||||||
</section>
|
</div>
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.proficiencies') }}</h3>
|
||||||
|
<textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section class="sheet-panel proficiencies-panel">
|
<section class="sheet-panel traits-panel">
|
||||||
<h2>{{ $t('campaigns.character-sheet.proficiencies') }}</h2>
|
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
|
||||||
<textarea v-if="editing" v-model="form.proficiencies" rows="7" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
<textarea v-if="editing" v-model="form.traits" rows="5" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
|
||||||
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
<!-- Les eines i els idiomes tenen llista pròpia; el text de dalt guarda
|
<section class="sheet-panel spells-panel">
|
||||||
el que no en té, com les armadures i les armes. -->
|
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
|
||||||
<div class="proficiency-lists">
|
<textarea v-if="editing" v-model="form.spells" rows="5" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
|
||||||
<div class="proficiency-list">
|
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
|
||||||
<h3>{{ $t('campaigns.character-sheet.tools') }}</h3>
|
</section>
|
||||||
<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">
|
||||||
<section class="sheet-panel inventory-panel">
|
<div class="panel-title-row">
|
||||||
<div class="panel-title-row">
|
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
||||||
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
||||||
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
</div>
|
||||||
</div>
|
<div class="weight-summary">
|
||||||
<div class="weight-summary">
|
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
||||||
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
||||||
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
</div>
|
||||||
</div>
|
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
||||||
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
<div class="inventory-table-wrap">
|
||||||
|
<table class="inventory-table">
|
||||||
<!-- La moneda que el personatge porta a sobre, en les cinc monedes del joc. -->
|
<thead><tr>
|
||||||
<h3>{{ $t('campaigns.character-sheet.currency') }}</h3>
|
<th>{{ $t('campaigns.character-sheet.item-name') }}</th>
|
||||||
<div class="currency-row">
|
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
||||||
<label v-for="unit in currencyUnits" :key="unit" class="currency-field">
|
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
||||||
<span>{{ $t(`campaigns.character-sheet.currency-units.${unit}`) }}</span>
|
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
||||||
<input v-if="editing" v-model.number="form.currency[unit]" type="number" min="0" :aria-label="$t(`campaigns.character-sheet.currency-units.${unit}`)">
|
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
||||||
<strong v-else>{{ form.currency[unit] }}</strong>
|
</tr></thead>
|
||||||
</label>
|
<tbody>
|
||||||
</div>
|
<tr v-for="(item, index) in form.inventory" :key="index">
|
||||||
<div class="inventory-table-wrap">
|
<td><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
||||||
<table class="inventory-table">
|
<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>
|
||||||
<thead><tr>
|
<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>
|
||||||
<th><span class="sr-only">{{ $t('campaigns.character-sheet.item-icon') }}</span></th>
|
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
||||||
<th class="item-name-cell">{{ $t('campaigns.character-sheet.item-name') }}</th>
|
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
||||||
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
</tr>
|
||||||
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 5 : 4" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
||||||
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
</tbody>
|
||||||
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
</table>
|
||||||
</tr></thead>
|
</div>
|
||||||
<tbody>
|
</section>
|
||||||
<tr v-for="(item, index) in form.inventory" :key="index">
|
</main>
|
||||||
<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>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
@@ -555,33 +325,11 @@ async function saveSheet() {
|
|||||||
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
|
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
|
||||||
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
||||||
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
|
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
|
||||||
/* El marc de la fitxa: la columna del personatge, sempre a la vista, i al seu costat el contingent
|
.sheet-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto auto auto; gap: 11px; align-items: start; }
|
||||||
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 { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); }
|
||||||
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
|
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
|
||||||
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
|
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
|
||||||
.sheet-portrait { position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
|
.sheet-portrait { grid-column: 1; grid-row: 1 / -1; position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
|
||||||
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
|
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
|
||||||
.sheet-portrait img { display: block; width: 100%; height: auto; }
|
.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-upload { border: 0; padding: 8px 10px; background: transparent; color: var(--color-link); font-size: 12px; cursor: pointer; }
|
||||||
@@ -591,46 +339,23 @@ async function saveSheet() {
|
|||||||
.portrait-controls button:hover { background: var(--color-button-hover); }
|
.portrait-controls button:hover { background: var(--color-button-hover); }
|
||||||
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
||||||
.photo-input { display: none; }
|
.photo-input { display: none; }
|
||||||
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
.abilities-panel { grid-column: 2 / -1; grid-row: 1; }
|
||||||
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. No penja de
|
.combat-panel { grid-column: 2; grid-row: 2; }
|
||||||
cap pestanya: es queda al seu lloc mentre se'n canvia. */
|
.traits-panel { grid-column: 3; grid-row: 2; }
|
||||||
.character-column { grid-column: 1; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
.spells-panel { grid-column: 2 / -1; grid-row: 3; }
|
||||||
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
|
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
|
||||||
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||||
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
||||||
.ability-score { font: 25px MrEavesRemake; }
|
.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-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; }
|
.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à
|
.proficiency-badge { display: flex; justify-content: space-between; align-items: center; margin-top: 9px; padding: 8px; border-radius: 8px; background: var(--color-background-soft); font-size: 12px; }
|
||||||
entrenat, al costat la característica que mana i la modificadora que tira. */
|
.proficiency-badge strong { font-size: 15px; color: var(--color-link); }
|
||||||
.saving-throw-grid { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 5px; }
|
.combat-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 8px; }
|
||||||
.skill-grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 5px; }
|
.combat-stat { min-height: 72px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 5px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||||
.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; }
|
.combat-stat > span { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
.proficiency-row:hover:not(:disabled) { border-color: var(--color-link); }
|
.combat-stat > strong { font: 25px MrEavesRemake; }
|
||||||
.proficiency-row:disabled { cursor: default; }
|
.combat-stat small { font-size: 11px; opacity: .7; }
|
||||||
.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 { display: flex; align-items: center; gap: 4px; }
|
||||||
.number-with-unit input { width: 57px; }
|
.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; }
|
.sheet-copy { min-height: 74px; margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
|
||||||
@@ -644,43 +369,31 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
|
|||||||
.weight-summary strong { white-space: nowrap; }
|
.weight-summary strong { white-space: nowrap; }
|
||||||
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
|
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
|
||||||
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
|
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
|
||||||
|
.inventory-panel { grid-column: 2 / -1; grid-row: 4; }
|
||||||
.inventory-table-wrap { overflow-x: auto; }
|
.inventory-table-wrap { overflow-x: auto; }
|
||||||
/* 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 { width: 100%; border-collapse: collapse; font-size: 12px; }
|
||||||
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
|
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
|
||||||
.inventory-table td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
|
.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 input { width: 100%; min-width: 54px; }
|
||||||
.inventory-table td.item-name-cell input { min-width: 100px; }
|
.inventory-table td:first-child input { min-width: 100px; }
|
||||||
/* La icona de cada objecte obre la filera; el nom continua alineat a l'esquerra i la
|
.inventory-table th:not(:first-child), .inventory-table td:not(:first-child) { text-align: center; }
|
||||||
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; }
|
.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 { 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); }
|
.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; }
|
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
|
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
|
||||||
@media (max-width: 760px) {
|
@media (max-width: 760px) {
|
||||||
.sheet-layout { grid-template-columns: 1fr; }
|
.sheet-grid { grid-template-columns: 1fr 1fr; grid-template-rows: none; }
|
||||||
.character-column, .sheet-tab-body { grid-column: 1 / -1; grid-row: auto; }
|
.sheet-portrait { grid-column: 1 / -1; grid-row: auto; }
|
||||||
/* El cantó dret no dona prou per penjar-hi les pestanyes: llavors es queden al marc, per
|
.abilities-panel { grid-column: 1 / -1; grid-row: auto; }
|
||||||
dins, en una filera sota la barra de la finestra. */
|
.combat-panel, .traits-panel { grid-column: auto; grid-row: auto; }
|
||||||
.sheet-tabs { position: static; align-self: stretch; flex-direction: row; flex-wrap: wrap; gap: 4px; padding: 6px 8px 0; }
|
.spells-panel, .inventory-panel { grid-column: 1 / -1; grid-row: auto; }
|
||||||
.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) {
|
@media (max-width: 520px) {
|
||||||
.sheet-body { padding: 10px; }
|
.sheet-body { padding: 10px; }
|
||||||
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
||||||
.sheet-actions { margin-left: auto; }
|
.sheet-actions { margin-left: auto; }
|
||||||
|
.sheet-grid { grid-template-columns: 1fr; }
|
||||||
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||||
.skill-grid, .saving-throw-grid, .proficiency-lists { grid-template-columns: 1fr; }
|
|
||||||
.currency-row { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -20,13 +20,13 @@ function initialForm() {
|
|||||||
if (!editing) {
|
if (!editing) {
|
||||||
return {
|
return {
|
||||||
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
category: 'adventuring-gear', rarity: 'common', weight: '', properties: '', description: ''
|
category: 'adventuring-gear', rarity: 'common', quantity: 1, weight: '', properties: '', description: ''
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
|
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
|
||||||
weight: editing.weight ?? '', properties: editing.properties ?? '',
|
quantity: editing.quantity ?? 1, weight: editing.weight ?? '', properties: editing.properties ?? '',
|
||||||
description: editing.description ?? ''
|
description: editing.description ?? ''
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -49,7 +49,7 @@ async function saveEntry() {
|
|||||||
? { name: form.value.name.trim(), campaign: data.campaign }
|
? { name: form.value.name.trim(), campaign: data.campaign }
|
||||||
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
|
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
|
||||||
if (!isActor) {
|
if (!isActor) {
|
||||||
for (const field of ['category', 'rarity', 'weight', 'properties', 'description']) {
|
for (const field of ['category', 'rarity', 'quantity', 'weight', 'properties', 'description']) {
|
||||||
payload[field] = form.value[field];
|
payload[field] = form.value[field];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -105,6 +105,10 @@ async function saveEntry() {
|
|||||||
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
|
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
|
||||||
</select>
|
</select>
|
||||||
</label>
|
</label>
|
||||||
|
<label class="form-field">
|
||||||
|
<span>{{ $t('campaigns.item.quantity') }}</span>
|
||||||
|
<input v-model.number="form.quantity" type="number" min="1" required>
|
||||||
|
</label>
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.item.weight') }}</span>
|
<span>{{ $t('campaigns.item.weight') }}</span>
|
||||||
<input v-model="form.weight" type="number" min="0" step="0.1">
|
<input v-model="form.weight" type="number" min="0" step="0.1">
|
||||||
|
|||||||
@@ -129,8 +129,7 @@ async function saveMap() {
|
|||||||
</label>
|
</label>
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.map.scale') }}</span>
|
<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="0.5">
|
||||||
<input v-model.number="form.scale" type="number" min="0.01" step="any" inputmode="decimal">
|
|
||||||
</label>
|
</label>
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
||||||
@@ -155,16 +154,7 @@ async function saveMap() {
|
|||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
||||||
/* Stretch so the outer margin insets the content instead of overflowing the window. */
|
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; }
|
||||||
.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; }
|
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
||||||
form { display: flex; flex-direction: column; gap: 10px; }
|
form { display: flex; flex-direction: column; gap: 10px; }
|
||||||
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
||||||
|
|||||||
@@ -1,261 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,128 +0,0 @@
|
|||||||
<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>
|
|
||||||
@@ -1,197 +0,0 @@
|
|||||||
<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,7 +26,6 @@ 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);
|
||||||
|
|
||||||
@@ -45,14 +44,14 @@ function ShowMainMenu(){
|
|||||||
|
|
||||||
function login() {
|
function login() {
|
||||||
loading.value = true;
|
loading.value = true;
|
||||||
Server().post('/user/login', { usermail: username.value, password: password.value, remember: remember.value }).then((response) => {
|
Server().post('/user/login', { usermail: username.value, password: password.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, remember.value);
|
SetUser(data.token);
|
||||||
DisplayToast('green', $t('login.success'), 3000);
|
DisplayToast('green', $t('login.success'), 3000);
|
||||||
ShowMainMenu();
|
ShowMainMenu();
|
||||||
}
|
}
|
||||||
@@ -90,12 +89,6 @@ 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">
|
||||||
@@ -153,14 +146,6 @@ 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,7 +76,6 @@ 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>
|
||||||
@@ -146,24 +145,6 @@ 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;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,139 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { onMounted, ref } from 'vue';
|
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateWindow } from '@/services/Windows';
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
import MapViewerPane from '../viewer/map/MapViewerPane.vue';
|
import { getBaseUrl } from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
const props = defineProps(['data']);
|
const props = defineProps(['data']);
|
||||||
const id = props.data.id;
|
const id = props.data.id;
|
||||||
|
const campaignId = props.data.campaign;
|
||||||
const handle = ref(null);
|
const handle = ref(null);
|
||||||
const wrapper = ref(null);
|
const wrapper = ref(null);
|
||||||
const map = props.data.map ? { ...props.data.map } : null;
|
|
||||||
|
const map = ref(props.data.map ? { ...props.data.map } : null);
|
||||||
|
const viewport = ref(null);
|
||||||
|
|
||||||
|
const zoom = ref(1);
|
||||||
|
const pan = ref({ x: 0, y: 0 });
|
||||||
|
const imageSize = ref({ width: 0, height: 0 });
|
||||||
|
const showGrid = ref(true);
|
||||||
|
const dragging = ref(false);
|
||||||
|
|
||||||
|
const minZoom = 0.05;
|
||||||
|
const maxZoom = 8;
|
||||||
|
|
||||||
|
const imageUrl = computed(() => {
|
||||||
|
const image = map.value?.image;
|
||||||
|
if (!image) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
||||||
|
});
|
||||||
|
|
||||||
|
const stageStyle = computed(() => ({
|
||||||
|
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
|
||||||
|
}));
|
||||||
|
|
||||||
|
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
|
||||||
|
const gridStyle = computed(() => {
|
||||||
|
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
|
||||||
|
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
|
||||||
|
return {
|
||||||
|
width: `${imageSize.value.width * zoom.value}px`,
|
||||||
|
height: `${imageSize.value.height * zoom.value}px`,
|
||||||
|
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
|
||||||
|
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
|
||||||
|
backgroundSize: `${cell} ${cell}`
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
|
||||||
|
|
||||||
|
function clampZoom(value) {
|
||||||
|
if (!Number.isFinite(value)) return minZoom;
|
||||||
|
return Math.min(maxZoom, Math.max(minZoom, value));
|
||||||
|
}
|
||||||
|
|
||||||
|
function fitToWindow() {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds || !imageSize.value.width) return;
|
||||||
|
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
|
||||||
|
centerOn();
|
||||||
|
}
|
||||||
|
|
||||||
|
function centerOn() {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds || !imageSize.value.width) return;
|
||||||
|
pan.value = {
|
||||||
|
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
|
||||||
|
y: (bounds.height - imageSize.value.height * zoom.value) / 2
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function onImageLoaded(event) {
|
||||||
|
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
|
||||||
|
fitToWindow();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zoom keeping the map point under `point` where it is.
|
||||||
|
function zoomAt(factor, point) {
|
||||||
|
const next = clampZoom(zoom.value * factor);
|
||||||
|
if (next === zoom.value) return;
|
||||||
|
const ratio = next / zoom.value;
|
||||||
|
pan.value = {
|
||||||
|
x: point.x - (point.x - pan.value.x) * ratio,
|
||||||
|
y: point.y - (point.y - pan.value.y) * ratio
|
||||||
|
};
|
||||||
|
zoom.value = next;
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWheel(event) {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds) return;
|
||||||
|
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
|
||||||
|
}
|
||||||
|
|
||||||
|
function zoomFromToolbar(incoming) {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds) return;
|
||||||
|
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
|
||||||
|
}
|
||||||
|
|
||||||
|
let pointerId = null;
|
||||||
|
let lastPointer = { x: 0, y: 0 };
|
||||||
|
|
||||||
|
function onPointerDown(event) {
|
||||||
|
if (event.button !== 0 || !viewport.value) return;
|
||||||
|
dragging.value = true;
|
||||||
|
pointerId = event.pointerId;
|
||||||
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
|
viewport.value.setPointerCapture?.(event.pointerId);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onPointerMove(event) {
|
||||||
|
if (!dragging.value || event.pointerId !== pointerId) return;
|
||||||
|
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
||||||
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
|
}
|
||||||
|
|
||||||
|
function onPointerUp(event) {
|
||||||
|
if (event.pointerId !== pointerId) return;
|
||||||
|
dragging.value = false;
|
||||||
|
pointerId = null;
|
||||||
|
viewport.value?.releasePointerCapture?.(event.pointerId);
|
||||||
|
}
|
||||||
|
|
||||||
|
function editMap() {
|
||||||
|
if (!map.value) return;
|
||||||
|
CreateWindow('create_map', { campaign: campaignId, entry: map.value });
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleMapUpdated({ entityType, entry }) {
|
||||||
|
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
|
||||||
|
const imageChanged = entry.image !== map.value.image;
|
||||||
|
map.value = { ...entry };
|
||||||
|
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
|
||||||
|
if (imageChanged) imageSize.value = { width: 0, height: 0 };
|
||||||
|
}
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
Top(wrapper);
|
Top(wrapper);
|
||||||
@@ -18,16 +143,82 @@ onMounted(() => {
|
|||||||
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
||||||
});
|
});
|
||||||
ResetPosition(id, 'center');
|
ResetPosition(id, 'center');
|
||||||
|
emitter.on('campaign-entry-updated', handleMapUpdated);
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
emitter.off('campaign-entry-updated', handleMapUpdated);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
<WindowHandle :window="id" ref="handle" />
|
<WindowHandle :window="id" ref="handle" />
|
||||||
<MapViewerPane :map="map" />
|
<div class="viewer-bar">
|
||||||
|
<div class="viewer-identity">
|
||||||
|
<strong>{{ map?.name }}</strong>
|
||||||
|
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
|
||||||
|
</div>
|
||||||
|
<div class="viewer-tools">
|
||||||
|
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
|
||||||
|
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<span class="zoom-readout">{{ zoomPercent }}</span>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
ref="viewport"
|
||||||
|
class="map-viewport"
|
||||||
|
:class="{ dragging }"
|
||||||
|
@wheel.prevent="onWheel"
|
||||||
|
@pointerdown="onPointerDown"
|
||||||
|
@pointermove="onPointerMove"
|
||||||
|
@pointerup="onPointerUp"
|
||||||
|
@pointercancel="onPointerUp"
|
||||||
|
>
|
||||||
|
<template v-if="imageUrl">
|
||||||
|
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
||||||
|
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
||||||
|
</template>
|
||||||
|
<div v-else class="map-empty">
|
||||||
|
{{ $t('campaigns.map.no-image') }}
|
||||||
|
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
.viewer-window { min-width: 320px; min-height: 0; }
|
.viewer-window { min-width: 320px; min-height: 0; }
|
||||||
|
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
|
||||||
|
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
|
||||||
|
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
|
||||||
|
.viewer-meta { font-size: 11px; opacity: .72; }
|
||||||
|
.viewer-tools { display: flex; align-items: center; gap: 4px; }
|
||||||
|
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
|
||||||
|
.viewer-tool:hover { background: var(--color-button-hover); }
|
||||||
|
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
|
||||||
|
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
|
||||||
|
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
|
||||||
|
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
|
||||||
|
.map-viewport.dragging { cursor: grabbing; }
|
||||||
|
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
|
||||||
|
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
|
||||||
|
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
||||||
|
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
||||||
|
.map-edit:hover { background: var(--color-button-hover); }
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -40,10 +40,6 @@ function confirmSave() {
|
|||||||
const url = creating ? '/folder/rename' : '/folder/create';
|
const url = creating ? '/folder/rename' : '/folder/create';
|
||||||
if (creating) {
|
if (creating) {
|
||||||
folderData.id = data.folderId;
|
folderData.id = data.folderId;
|
||||||
} else {
|
|
||||||
// Which campaign list the folder belongs to: the notes when the caller says
|
|
||||||
// nothing, one of the entry lists when their sidebar button opens this window.
|
|
||||||
folderData.target = data.target ?? 'note';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Server().post(url, folderData).then((response) => {
|
Server().post(url, folderData).then((response) => {
|
||||||
|
|||||||
@@ -1,122 +0,0 @@
|
|||||||
<script setup>
|
|
||||||
import { createApp, onBeforeUnmount, onMounted, ref } from 'vue';
|
|
||||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
|
||||||
import { GetWidget, ParseMarkdown } from '~/services/Marker';
|
|
||||||
import Server from '~/services/Server';
|
|
||||||
|
|
||||||
// The note a map pin points at (see MapViewerPane.vue). The note is fetched here instead of being
|
|
||||||
// carried over from the map, so a pin works whatever the note column shows and always reads fresh.
|
|
||||||
const props = defineProps(['data']);
|
|
||||||
const id = props.data.id;
|
|
||||||
const noteId = props.data.note;
|
|
||||||
const handle = ref(null);
|
|
||||||
const wrapper = ref(null);
|
|
||||||
const renderedContent = ref(null);
|
|
||||||
const note = ref(null);
|
|
||||||
const displayText = ref('');
|
|
||||||
const loading = ref(true);
|
|
||||||
const failed = ref(false);
|
|
||||||
|
|
||||||
// Widgets mounted over this note, kept to unmount them again the way Note.vue does: re-rendering
|
|
||||||
// would otherwise leave the apps of the nodes it replaced behind.
|
|
||||||
const mountedApps = [];
|
|
||||||
|
|
||||||
function unmountWidgets() {
|
|
||||||
for (const app of mountedApps) {
|
|
||||||
try {
|
|
||||||
app.unmount();
|
|
||||||
} catch (error) {
|
|
||||||
// The container may already be off the DOM; ignore and drop it all the same.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
mountedApps.length = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
function mountWidgets() {
|
|
||||||
const root = renderedContent.value;
|
|
||||||
if (!root) return;
|
|
||||||
|
|
||||||
['display', 'inline'].forEach((widgetType) => {
|
|
||||||
root.querySelectorAll('.vue-component-' + widgetType).forEach((el) => {
|
|
||||||
const widget = GetWidget(widgetType, el.dataset.component);
|
|
||||||
if (!widget) return;
|
|
||||||
try {
|
|
||||||
const app = createApp(widget, { content: el.dataset.content });
|
|
||||||
app.config.errorHandler = (error) => console.error('Widget error', el.dataset.component, error);
|
|
||||||
app.mount(el);
|
|
||||||
mountedApps.push(app);
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Failed to mount widget', el.dataset.component, error);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async function fetchNote() {
|
|
||||||
loading.value = true;
|
|
||||||
failed.value = false;
|
|
||||||
try {
|
|
||||||
const response = await Server().get(`/note/retrieve/${noteId}`);
|
|
||||||
if (response.data.status !== 'ok' || !response.data.note) {
|
|
||||||
failed.value = true;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
note.value = response.data.note;
|
|
||||||
unmountWidgets();
|
|
||||||
displayText.value = ParseMarkdown(response.data.note.content ?? '');
|
|
||||||
setTimeout(() => mountWidgets(), 0);
|
|
||||||
} catch (error) {
|
|
||||||
failed.value = true;
|
|
||||||
} finally {
|
|
||||||
loading.value = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
|
||||||
Top(wrapper);
|
|
||||||
SetupHandle(id, handle);
|
|
||||||
SetSize(id, {
|
|
||||||
width: Math.max(360, Math.min(720, window.innerWidth - 24)),
|
|
||||||
height: Math.max(360, Math.min(720, window.innerHeight - 32))
|
|
||||||
});
|
|
||||||
ResetPosition(id, 'center');
|
|
||||||
fetchNote();
|
|
||||||
});
|
|
||||||
|
|
||||||
onBeforeUnmount(() => {
|
|
||||||
unmountWidgets();
|
|
||||||
ClearWindow({ type: 'pinned_note' });
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<div class="window-wrapper pinned-note-window" :id="'window-wrapper-' + id" ref="wrapper">
|
|
||||||
<WindowHandle :window="id" ref="handle" />
|
|
||||||
<div class="body">
|
|
||||||
<div v-if="loading" class="note-state">{{ $t('campaigns.states.loading') }}</div>
|
|
||||||
<div v-else-if="failed" class="note-state">{{ $t('campaigns.map.pins.note-error') }}</div>
|
|
||||||
<template v-else>
|
|
||||||
<h1 v-if="note.title" class="note-title">{{ note.title }}</h1>
|
|
||||||
<div ref="renderedContent" class="note-content" v-html="displayText"></div>
|
|
||||||
</template>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<style scoped>
|
|
||||||
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
|
||||||
/* Stretch so the outer margin insets the content instead of overflowing the window. */
|
|
||||||
.body {
|
|
||||||
flex: 1;
|
|
||||||
min-height: 0;
|
|
||||||
align-self: stretch;
|
|
||||||
box-sizing: border-box;
|
|
||||||
margin: 10px;
|
|
||||||
padding: 8px;
|
|
||||||
overflow-y: auto;
|
|
||||||
}
|
|
||||||
.note-title { margin: 0 0 10px; font-family: MrEavesRemake; overflow-wrap: anywhere; }
|
|
||||||
.note-state { padding: 10px; font-size: 13px; opacity: .8; }
|
|
||||||
.note-content :deep(img) { max-width: 100%; height: auto; display: block; }
|
|
||||||
</style>
|
|
||||||
@@ -16,6 +16,13 @@ const data = props.data;
|
|||||||
|
|
||||||
const { locale } = useI18n();
|
const { locale } = useI18n();
|
||||||
|
|
||||||
|
|
||||||
|
const changeLocale = (lang) => {
|
||||||
|
console.log(lang);
|
||||||
|
locale.value = lang.code;
|
||||||
|
SetUserSetting('lang', lang.code);
|
||||||
|
}
|
||||||
|
|
||||||
const id = data.id;
|
const id = data.id;
|
||||||
|
|
||||||
const rows = ref([{id: "account-settings", value: "settings.tabs.account-settings"}]);
|
const rows = ref([{id: "account-settings", value: "settings.tabs.account-settings"}]);
|
||||||
@@ -30,40 +37,13 @@ function getLocaleFromCode(code){
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The language to show in the dropdown: always one Dragonroll offers, because a
|
const selectedLocale = ref("");
|
||||||
// user that never picked one has none stored.
|
|
||||||
function localeToShow(code){
|
|
||||||
return getLocaleFromCode(code) || locales[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
// vue-i18n answers every translation with `SyntaxError: cannot support locale type`
|
|
||||||
// once it is given a locale it has no messages for, and the locale is global: putting
|
|
||||||
// a language that is not stored (the server answers `settings: undefined` for a user
|
|
||||||
// that never picked one) or one no longer offered took the settings window and the
|
|
||||||
// main menu behind it down (issue #47). Only known codes go into `locale`.
|
|
||||||
function applyLanguage(code){
|
|
||||||
const stored = getLocaleFromCode(code);
|
|
||||||
if(!stored) return false;
|
|
||||||
locale.value = stored.code;
|
|
||||||
selectedLocale.value = stored;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
const selectedLocale = ref(localeToShow(locale.value));
|
|
||||||
|
|
||||||
const changeLocale = (lang) => {
|
|
||||||
if(!applyLanguage(lang?.code)) return;
|
|
||||||
SetUserSetting('lang', lang.code);
|
|
||||||
}
|
|
||||||
|
|
||||||
onBeforeMount(() => {
|
onBeforeMount(() => {
|
||||||
// Set selected in dropdown. Without settings to read from the server the language
|
GetUserSetting('lang').then(value => {
|
||||||
// Dragonroll is already showing stays the one on screen.
|
locale.value = value;
|
||||||
GetUserSetting('lang')
|
selectedLocale.value = getLocaleFromCode(value); // Set selected in dropdown
|
||||||
.then((value) => applyLanguage(value))
|
});
|
||||||
.catch(() => {});
|
if(GetUser().admin) rows.value.push({
|
||||||
|
|
||||||
if(GetUser()?.admin) rows.value.push({
|
|
||||||
id: "site-administration",
|
id: "site-administration",
|
||||||
value: "settings.tabs.site-administration"
|
value: "settings.tabs.site-administration"
|
||||||
});
|
});
|
||||||
@@ -80,19 +60,25 @@ onMounted(() => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
function OpenManageAccounts(){
|
function OpenManageAccounts(){
|
||||||
ClearWindow({ type: 'settings' });
|
ClearWindow('settings');
|
||||||
CreateWindow('account_management', {
|
CreateWindow('account_management', {
|
||||||
// Back returns to the settings tab this button sits on; CreateWindow leaves
|
type: 'account_management',
|
||||||
// a window that is already open alone.
|
title: 'settings.site-administration.manage-accounts.title',
|
||||||
|
id: 'account-management',
|
||||||
back: () => {
|
back: () => {
|
||||||
ClearWindow({ type: 'account_management' });
|
ClearWindow('account-management')
|
||||||
CreateWindow('settings');
|
CreateWindow('settings', {
|
||||||
|
id: 'settings',
|
||||||
|
type: 'settings',
|
||||||
|
title: 'settings.title',
|
||||||
|
back: () => { ClearWindow('settings'); CreateWindow('main_menu'); }
|
||||||
|
});
|
||||||
}
|
}
|
||||||
});
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
const getLocaleName = (locale) => {
|
const getLocaleName = (locale) => {
|
||||||
return locale ? locale.name : "";
|
return locale.name;
|
||||||
}
|
}
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -1,45 +0,0 @@
|
|||||||
# What is Dragonroll?
|
|
||||||
|
|
||||||
Dragonroll is a free and open-source helper for tabletop RPG campaigns. It keeps the things a group
|
|
||||||
carries around a table in one place — the campaign's notes, its characters, its items, its maps — and
|
|
||||||
lets the tools you already play with read and change them: Discord, Foundry VTT and Obsidian.
|
|
||||||
|
|
||||||
It is not a full virtual tabletop. There is no game loop, no combat tracker and no rule engine:
|
|
||||||
Dragonroll is the shared memory of a campaign, and the place its characters and items are written
|
|
||||||
down.
|
|
||||||
|
|
||||||
## What you get
|
|
||||||
|
|
||||||
- **Campaigns.** Every note, character, item and map belongs to one campaign, and each campaign has
|
|
||||||
its own colour, description and integrations. [Start one](/docs/your-first-campaign).
|
|
||||||
- **Notes in markdown.** The campaign's text lives in markdown notes, filed into folders that nest as
|
|
||||||
deep as you need. Notes can hold a [dice widget](/docs/notes-and-markdown) that rolls when you
|
|
||||||
look at it.
|
|
||||||
- **Characters and items.** Actors (characters, NPCs and creatures) have a sheet with ability scores,
|
|
||||||
combat stats, proficiencies, traits, spells and an inventory. Items have a category, a rarity and an
|
|
||||||
icon. See [characters and items](/docs/characters-and-items).
|
|
||||||
- **Maps.** Upload a map image with a grid, then pin notes onto the places they belong and stand your
|
|
||||||
characters on the grid as [tokens](/docs/maps).
|
|
||||||
- **Integrations.** Consult the campaign from [Discord](/docs/discord), keep a Foundry VTT world and
|
|
||||||
a campaign [in step](/docs/foundry), and write campaign notes in [Obsidian](/docs/obsidian).
|
|
||||||
|
|
||||||
## How it is put together
|
|
||||||
|
|
||||||
Three pieces work together, and you only ever see the first of them:
|
|
||||||
|
|
||||||
| Piece | What it does |
|
|
||||||
| --- | --- |
|
|
||||||
| The web app | What you open: campaigns, notes, characters, items, maps, and the documentation you are reading |
|
|
||||||
| The API | Stores everything the app shows and answers the integrations' requests |
|
|
||||||
| The integrations | The Discord bot, the Foundry VTT module and the Obsidian plugin |
|
|
||||||
|
|
||||||
You sign in to the app with one account, and everything you create belongs to you. Integrations never
|
|
||||||
hold a Dragonroll login: they ask you to authorize them for one campaign, which
|
|
||||||
[you can take back](/docs/connecting-a-service) at any time.
|
|
||||||
|
|
||||||
## Where to go next
|
|
||||||
|
|
||||||
- New here? [Create your first campaign](/docs/your-first-campaign).
|
|
||||||
- Writing the campaign down? [Notes and markdown](/docs/notes-and-markdown).
|
|
||||||
- Playing on a screen? [Maps, pins and tokens](/docs/maps).
|
|
||||||
- Connecting the tools you use? [Connecting a service](/docs/connecting-a-service).
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
# Your first campaign
|
|
||||||
|
|
||||||
## Signing in
|
|
||||||
|
|
||||||
The very first time you open a Dragonroll server there is no account yet, so the app asks you to
|
|
||||||
create one: that first account becomes the server's **administrator**, which is the account that can
|
|
||||||
later create or remove the other accounts. Everyone else is invited to register by whoever runs the
|
|
||||||
server.
|
|
||||||
|
|
||||||
Sign in with your username or your email and your password. Sessions last 48 hours, after which the
|
|
||||||
app asks you again. Under your name in the main menu you can change your profile — your name, your
|
|
||||||
email and the avatar that shows up beside your characters.
|
|
||||||
|
|
||||||
## The main menu
|
|
||||||
|
|
||||||
The main menu is where you pick up where you left off:
|
|
||||||
|
|
||||||
- your campaigns, ready to open,
|
|
||||||
- **Create campaign** to add one,
|
|
||||||
- **Settings**, with your own appearance and language, and an *Administration* tab for
|
|
||||||
administrators to manage the other accounts,
|
|
||||||
- **Log out**.
|
|
||||||
|
|
||||||
## Creating a campaign
|
|
||||||
|
|
||||||
**Create campaign** asks for three things: a name, a short description and an accent colour. The
|
|
||||||
colour follows the campaign wherever it shows up, so a group that runs two campaigns can tell them
|
|
||||||
apart at a glance. Nothing else about a campaign is fixed: you can change the name, description and
|
|
||||||
colour later in its settings.
|
|
||||||
|
|
||||||
## The campaign workspace
|
|
||||||
|
|
||||||
Opening a campaign replaces the menu with its workspace.
|
|
||||||
|
|
||||||
| Part | What it holds |
|
|
||||||
| --- | --- |
|
|
||||||
| Top bar | The campaign's name, the search, **Settings** and **Exit** |
|
|
||||||
| Sidebar | The campaign's contents, in four sections: **Notes**, **Actors & Characters**, **Items** and **Maps** |
|
|
||||||
| Note column | The notes you have open, side by side, or the map you have anchored |
|
|
||||||
| Status bar | What the app is doing: saving, syncing, and errors when something fails |
|
|
||||||
|
|
||||||
The sidebar is the heart of it. Each of its sections lists the entries of that kind, and each entry
|
|
||||||
can stand in a folder: folders nest, so a campaign can be organised however the group thinks of it.
|
|
||||||
The sidebar itself collapses to give the notes room when you are showing a screen at the table.
|
|
||||||
|
|
||||||
## Finding things
|
|
||||||
|
|
||||||
The search in the top bar looks through the notes, characters, items and maps of the campaign you are
|
|
||||||
in, and opens whatever you pick from the results. **Cmd+K** (or **Ctrl+K**) puts the cursor in it.
|
|
||||||
|
|
||||||
## Campaign settings
|
|
||||||
|
|
||||||
**Settings** in the top bar has two tabs:
|
|
||||||
|
|
||||||
- **Basic** — the campaign's name and colour.
|
|
||||||
- **Integrations** — which external services are connected to this campaign and how to
|
|
||||||
[connect one](/docs/connecting-a-service), plus the address of the Foundry VTT instance when the
|
|
||||||
campaign reads icons from a linked world.
|
|
||||||
|
|
||||||
**Exit** leaves the campaign and returns to the main menu. Nothing is lost: the notes you had open and
|
|
||||||
the campaign you were in are remembered for the next time you open the app.
|
|
||||||
|
|
||||||
## Next
|
|
||||||
|
|
||||||
- Write the campaign down in [notes and markdown](/docs/notes-and-markdown).
|
|
||||||
- Write its characters and items on [sheets](/docs/characters-and-items).
|
|
||||||
- Put it on a [map](/docs/maps).
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
# Notes and markdown
|
|
||||||
|
|
||||||
Notes are where a campaign is written down: sessions, NPCs, the lore of a city, the ritual the party
|
|
||||||
found in a dungeon. They are plain markdown, so anything you already know from README files and
|
|
||||||
Obsidian works as it is.
|
|
||||||
|
|
||||||
## Opening and editing a note
|
|
||||||
|
|
||||||
Clicking a note in the sidebar opens it in the note column, where you can have several open side by
|
|
||||||
side. A note opens in **display mode**, showing its formatted markdown. Press **Cmd+E** (**Ctrl+E**)
|
|
||||||
to edit its source, and **Cmd+S** (**Ctrl+S**) to save it; a dot in the note's title bar reminds you
|
|
||||||
that there is something to save. The cross in the title bar closes the note — it does not delete it.
|
|
||||||
|
|
||||||
## Folders
|
|
||||||
|
|
||||||
The sidebar's sections hold notes in folders, and folders hold folders, so a campaign can be nested as
|
|
||||||
deep as it needs. Right-clicking gives the commands:
|
|
||||||
|
|
||||||
| Right-click on… | You get |
|
|
||||||
| --- | --- |
|
|
||||||
| a note | Open, Rename, a colour, the folder to move it to, Delete |
|
|
||||||
| a folder | New note in it, Rename, a colour, Delete folder |
|
|
||||||
|
|
||||||
Dragging a note onto a folder moves it there, and dropping it at the bottom of the list takes it back
|
|
||||||
to the root. Colouring a note or a folder tints its row in the sidebar, which is a quick way to mark
|
|
||||||
what matters.
|
|
||||||
|
|
||||||
Deleting a folder does not delete your notes: the notes it held move up to its parent folder, its
|
|
||||||
sub-folders move up with them, and only the empty folders go away.
|
|
||||||
|
|
||||||
## Markdown
|
|
||||||
|
|
||||||
Headings, **bold**, *italic*, lists, quotes, tables, code and links all work:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## The Wreck of the Salt Gull
|
|
||||||
|
|
||||||
- [ ] Burn the manifest
|
|
||||||
- [x] Ask the harbourmaster
|
|
||||||
|
|
||||||
| Cargo | Worth |
|
|
||||||
| --- | --- |
|
|
||||||
| Salted fish | 20 gp |
|
|
||||||
```
|
|
||||||
|
|
||||||
Clicking a heading **folds** the section under it — handy when you are reading a long note on a
|
|
||||||
projector and only want the part you are talking about. Sub-headings fold with their parent.
|
|
||||||
|
|
||||||
## Rolling dice in a note
|
|
||||||
|
|
||||||
A note can hold a dice widget: a button that rolls and shows the result right there, so the book of a
|
|
||||||
spell does not need a second app next to it.
|
|
||||||
|
|
||||||
Write `@roll` and the expression in square brackets to drop it in the middle of a sentence:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
The goblin attacks with @roll[1d20+4].
|
|
||||||
```
|
|
||||||
|
|
||||||
Or in a block of its own, between `@roll` and `@end`, when the roll is worth showing on its own line:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
@roll
|
|
||||||
8d6
|
|
||||||
@end
|
|
||||||
```
|
|
||||||
|
|
||||||
Either way the widget shows the expression as a button: press it and the dice land, with every die and
|
|
||||||
the total spelled out. Press it again to roll again. Only the expression itself goes between `@roll`
|
|
||||||
and `@end` — write the note about the roll next to the widget, not inside it.
|
|
||||||
|
|
||||||
The expression understands:
|
|
||||||
|
|
||||||
| Written | Meaning |
|
|
||||||
| --- | --- |
|
|
||||||
| `d20`, `1d20` | one die; the number in front is how many, so `4d6` |
|
|
||||||
| `d20adv`, `d20dis` | roll twice and keep the higher / the lower |
|
|
||||||
| `4d6kh1`, `4d6kl1` | keep the highest / lowest one of four (any number after `kh` / `kl`) |
|
|
||||||
| `+`, `-`, `*`, `/` | arithmetic; `2d6+3`, `1d8/2` |
|
|
||||||
| `( )` | grouping, as in `(1d8+4)*2` |
|
|
||||||
| `-3` | a negative number |
|
|
||||||
|
|
||||||
Division rounds down, the way damage does. Spaces between the parts of an expression do not matter, but
|
|
||||||
a modifier belongs right after the dice: write `4d6kh1`, not `4d6 kh 1`.
|
|
||||||
|
|
||||||
## Next
|
|
||||||
|
|
||||||
- Put the people and things of your notes on [sheets](/docs/characters-and-items).
|
|
||||||
- Pin a note onto a spot on a [map](/docs/maps).
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
# Characters and items
|
|
||||||
|
|
||||||
The **Actors & Characters** and **Items** sections of the sidebar hold the people and things of a
|
|
||||||
campaign as entries of their own, with a sheet each. They can be written by hand, and they are also
|
|
||||||
what a linked [Foundry VTT](/docs/foundry) world keeps itself in step with.
|
|
||||||
|
|
||||||
## Actors
|
|
||||||
|
|
||||||
An actor is anyone the campaign can point at: a **Character**, an **NPC** or a **Creature**. Creating
|
|
||||||
one asks for the few fields that identify it — type, species, class, level, background, and a challenge
|
|
||||||
rating for the monsters — and the rest is filled in on its sheet.
|
|
||||||
|
|
||||||
Opening an actor opens its **character sheet**, in tabs:
|
|
||||||
|
|
||||||
| Tab | What it holds |
|
|
||||||
| --- | --- |
|
|
||||||
| Ability Scores | Strength, Dexterity, Constitution, Intelligence, Wisdom, Charisma, and the proficiency bonus. Under them the six saving throws and the eighteen skills, each with a circle that stands lit when the character is proficient with it, next to the modifier it rolls. The proficiencies follow: the character's tools, its languages, and whatever else it is proficient with as text |
|
|
||||||
| Inventory | What it carries: every item with its icon, quantity and weight each, the total carried weight added up, and the coins the character holds |
|
|
||||||
| Traits | Features, traits and other details, as text |
|
|
||||||
| Spells | The spells it knows, one per line |
|
|
||||||
|
|
||||||
Toggling a skill, a saving throw, or writing a tool or a language is done like everything else on the
|
|
||||||
sheet: **Edit**, change it, **Save sheet**.
|
|
||||||
|
|
||||||
Combat lives above the tabs: armor class, speed, initiative, current and maximum hit points, and hit
|
|
||||||
dice. The photo at the top of the sheet is what shows up next to the character everywhere else —
|
|
||||||
including in [Discord](/docs/discord), where players can read the sheet of the character they hold.
|
|
||||||
|
|
||||||
**Edit** turns the sheet into fields you can change; **Save sheet** writes them back. Characters are
|
|
||||||
filed in folders like notes are, so a campaign can keep its party, its villains and its bestiary
|
|
||||||
apart.
|
|
||||||
|
|
||||||
## Items
|
|
||||||
|
|
||||||
An item is anything the campaign names: a weapon, a potion, a piece of treasure. Its sheet holds a
|
|
||||||
name, a description, a **category** (weapon, armor, shield, adventuring gear, magic item, consumable,
|
|
||||||
tool, treasure, other), a **rarity** from common to artifact, a weight in pounds, and its properties
|
|
||||||
("finesse, versatile").
|
|
||||||
|
|
||||||
The rarity colours the item's row in the sidebar — common white, uncommon green, rare blue, very rare
|
|
||||||
purple, legendary orange — so what is worth something stands out while you scroll.
|
|
||||||
|
|
||||||
Every item can have an icon. Upload an image, or pick one out of the icon library your linked Foundry
|
|
||||||
world ships with, browsing its folders one at a time.
|
|
||||||
|
|
||||||
## Characters on the table
|
|
||||||
|
|
||||||
Drag an actor out of the sidebar and drop it on a map and it stands there as a
|
|
||||||
[token](/docs/maps), sized to the map's grid. Drag a note instead and it is filed into whatever folder
|
|
||||||
you drop it on.
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# Maps, pins and tokens
|
|
||||||
|
|
||||||
A map is a picture of a place — a dungeon floor, a town, a combat encounter — with a grid laid over
|
|
||||||
it. On top of the picture you can pin the notes that belong to a spot and stand the campaign's
|
|
||||||
characters on its cells.
|
|
||||||
|
|
||||||
## Creating a map
|
|
||||||
|
|
||||||
**Maps → New map** asks for an image and the grid that goes with it:
|
|
||||||
|
|
||||||
| Setting | What it is |
|
|
||||||
| --- | --- |
|
|
||||||
| Map image | A photo or scan of the map. Uploading a new one replaces it, and leaving it empty keeps the current image |
|
|
||||||
| Grid size (px) | How wide one grid cell is in the image, in image pixels |
|
|
||||||
| Offset X / Offset Y | Where the grid starts in the image, so the grid can be lined up with the drawing |
|
|
||||||
| Scale | How much distance one cell stands for, like 5 feet |
|
|
||||||
|
|
||||||
The grid size, offsets and scale are what let the app turn a point on the screen into a cell of the
|
|
||||||
map, so a token stands where it should and pins stay put when you zoom.
|
|
||||||
|
|
||||||
## Looking at a map
|
|
||||||
|
|
||||||
Clicking a map in the sidebar anchors it in the place the open notes occupy, and **Open in window**
|
|
||||||
puts it in a window of its own, which you can drag next to the notes. Once a map is on screen:
|
|
||||||
|
|
||||||
- scroll to zoom towards the cursor, or use the zoom buttons and **Fit to window**,
|
|
||||||
- drag to pan,
|
|
||||||
- **Show grid** turns the grid overlay on and off. The grid is drawn over the image, so its lines stay
|
|
||||||
crisp whatever the zoom.
|
|
||||||
|
|
||||||
## Pinning notes
|
|
||||||
|
|
||||||
Right-click anywhere on a map and pick **Pin a note here**, then choose the note: a marker appears on
|
|
||||||
that spot, and clicking the marker opens the note. A pinned note can be read straight off the map
|
|
||||||
without hunting for it in the sidebar, which is what makes a town map usable at the table.
|
|
||||||
|
|
||||||
**Remove pin** takes the marker off; the note itself is untouched. Deleting a note that is pinned drops
|
|
||||||
its pins.
|
|
||||||
|
|
||||||
## Tokens
|
|
||||||
|
|
||||||
Drag an actor from the sidebar onto a map and it stands there as a token: it snaps to the centre of the
|
|
||||||
cell you dropped it on and is sized by that cell, so a huge creature can be given more than one cell by
|
|
||||||
sizing it up on the map's settings.
|
|
||||||
|
|
||||||
Once a token is on the map you can drag it to another cell, step it across the grid one cell at a time
|
|
||||||
with the **arrow keys**, and take it off with **Delete**. Double-clicking a token opens the sheet of
|
|
||||||
the actor it stands for, and **Enter** does the same on a token focused with the keyboard.
|
|
||||||
|
|
||||||
Tokens belong to the map, not to the actor: the same character can stand on several maps, and taking a
|
|
||||||
token off does not remove the character from the campaign.
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# Connecting a service
|
|
||||||
|
|
||||||
Dragonroll talks to three services: [Discord](/docs/discord), [Foundry VTT](/docs/foundry) and
|
|
||||||
[Obsidian](/docs/obsidian). They all connect the same way, and none of them is given your Dragonroll
|
|
||||||
password.
|
|
||||||
|
|
||||||
## How a connection works
|
|
||||||
|
|
||||||
A service asks Dragonroll for a **sign-up link** and shows it to you. You open that link in your
|
|
||||||
browser, sign in if you are not signed in already, and pick which of your campaigns the service may
|
|
||||||
use. Only then does the service get its own credential, which lets it read and change that one
|
|
||||||
campaign and nothing else.
|
|
||||||
|
|
||||||
| You see | What it means |
|
|
||||||
| --- | --- |
|
|
||||||
| A link in Discord, in the Foundry module or in the Obsidian plugin | The service is waiting for you to pick a campaign |
|
|
||||||
| A campaign picker in your browser | Sign in and choose the campaign, and the service is connected |
|
|
||||||
| "Connected" in the service | It picked up its credential and can start working |
|
|
||||||
|
|
||||||
The link is short-lived — it expires after ten minutes — and can only be used once. If you close it
|
|
||||||
without choosing, ask the service for a new one. If a service loses the credential it was given, it
|
|
||||||
asks for a new link too: nothing is kept that would let it back in.
|
|
||||||
|
|
||||||
## What a connection allows
|
|
||||||
|
|
||||||
What a service may do is decided by the campaign you pick, so check the name before you confirm. The
|
|
||||||
screen tells you which service is asking, and what it wants:
|
|
||||||
|
|
||||||
- a **Discord server** reads the campaign's characters, so whoever is in that server can read them,
|
|
||||||
- a **Foundry world** keeps its actors and items in step with the campaign, which means it writes into
|
|
||||||
it, and Dragonroll writes into it,
|
|
||||||
- **Obsidian** reads the campaign's notes and pushes the ones you tell it to.
|
|
||||||
|
|
||||||
A campaign holds one link per service: linking a second Foundry world, or a second Discord server,
|
|
||||||
replaces the one it had. Authorizing a service with a different Dragonroll account replaces who the
|
|
||||||
service answers to.
|
|
||||||
|
|
||||||
## Seeing and undoing a connection
|
|
||||||
|
|
||||||
Open the campaign and look at **Settings → Integrations**. It lists the three services and, for each
|
|
||||||
one, whether it is connected, what is connected to it, and which Dragonroll account authorized it.
|
|
||||||
|
|
||||||
**Unlink** ends it. The service loses access the next time it asks — nothing it already wrote into the
|
|
||||||
campaign is deleted, and nothing about your campaign changes. To use the service again, start a new
|
|
||||||
link from its own side.
|
|
||||||
|
|
||||||
## Next
|
|
||||||
|
|
||||||
- [Discord](/docs/discord) — read characters and campaigns from a server.
|
|
||||||
- [Foundry VTT](/docs/foundry) — keep a world and a campaign in step.
|
|
||||||
- [Obsidian](/docs/obsidian) — write campaign notes in your vault.
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
# Discord
|
|
||||||
|
|
||||||
The Dragonroll Discord bot lets a server read the characters of a campaign without anyone leaving
|
|
||||||
Discord: the roster, a character's sheet with its portrait, and who plays whom. It is a read-only bot —
|
|
||||||
it never changes your campaign.
|
|
||||||
|
|
||||||
## Connecting a server
|
|
||||||
|
|
||||||
1. Invite the bot to the server with the `bot` and `applications.commands` scopes.
|
|
||||||
2. A Discord **administrator** runs `/dragonroll connect`. The bot answers with a *Sign in to
|
|
||||||
Dragonroll* button.
|
|
||||||
3. Whoever opens it signs in to the Dragonroll account that owns the campaign and picks that campaign.
|
|
||||||
The server is now linked to it, and the bot says so.
|
|
||||||
4. From then on anybody in the server can look the campaign's characters up.
|
|
||||||
|
|
||||||
The authorization link lasts ten minutes and works once. A campaign is linked to one Discord server at
|
|
||||||
a time, and a server to one campaign; authorizing the server with a different Dragonroll account takes
|
|
||||||
over the connection.
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
| Command | Who | What it does |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `/characters [type]` | everybody | Lists the characters of the campaign this server is linked to. `type` narrows the list to **Characters**, **NPCs** or **Creatures**. Every character a player has claimed shows up next to that player. |
|
|
||||||
| `/character name [public]` | everybody | Shows one actor's sheet: its portrait, description, race, class and level, background, armor class and speed, ability scores, proficiencies, traits, spells and inventory. Start typing a name and Discord offers the campaign's roster. Set `public` to `true` to show the sheet to the whole channel instead of only to you. |
|
|
||||||
| `/dragonroll connect` | administrators | Asks Dragonroll for the sign-up link that connects this server, and confirms here once somebody has authorized it. |
|
|
||||||
| `/dragonroll link campaign:` | administrators | Moves this server to another campaign of the connected Dragonroll account. Type part of a name to filter the choices. |
|
|
||||||
| `/dragonroll unlink` | administrators | Removes this server's campaign link. The campaign is untouched; the commands simply have nothing to read until one is linked again. |
|
|
||||||
| `/dragonroll status` | everybody | Shows which campaign this server reads, and which character your Discord account holds on it. |
|
|
||||||
| `/dragonroll refresh` | everybody | Asks Dragonroll again where the connection stands, and shows what it answered. |
|
|
||||||
| `/dragonroll assign character:` | everybody | Links a character of the campaign to your Discord account, so the bot knows it is yours and `/characters` says so. You can take a character nobody holds; a character somebody else holds can only be moved by an administrator. |
|
|
||||||
| `/dragonroll unassign [character]` | everybody | Drops a character link. Without the option you give up your own character; naming somebody else's takes it off them, which only an administrator can do. |
|
|
||||||
|
|
||||||
Replies are private: only you see them, so a player can look up their character in a busy channel. The
|
|
||||||
one exception is `/character` with `public:true`, which posts the sheet where everyone can read it — for
|
|
||||||
the villain the party is talking to, or the magic item they just found.
|
|
||||||
|
|
||||||
## Characters and their players
|
|
||||||
|
|
||||||
`/dragonroll assign` is how a player says *this one is mine*:
|
|
||||||
|
|
||||||
- each account holds one character, so claiming a second one frees the first,
|
|
||||||
- a free character can be taken by anybody,
|
|
||||||
- a character somebody holds can only be taken or freed by a server administrator,
|
|
||||||
- the pairing shows up in `/characters` and in `/dragonroll status`, which is what lets the table see
|
|
||||||
who is playing whom.
|
|
||||||
|
|
||||||
Assigning a character does not hide anything: the bot is read-only and every member of the server can
|
|
||||||
already read the campaign's characters with `/character`.
|
|
||||||
|
|
||||||
## When something goes wrong
|
|
||||||
|
|
||||||
| The bot says | What is going on |
|
|
||||||
| --- | --- |
|
|
||||||
| "Connect a Dragonroll account first with /dragonroll connect." | Nobody has authorized this server yet, or the authorization expired before anyone opened it. |
|
|
||||||
| "Only Discord server administrators can connect Dragonroll or change this campaign link." | The command changes the server's connection, so it needs the Discord Administrator permission. |
|
|
||||||
| "The bot API secret is missing or does not match the backend." | Whoever runs the bot has to set the same `DRAGONROLL_DISCORD_BOT_SECRET` in the bot and in the Dragonroll backend. |
|
|
||||||
| "This server does not have a linked campaign." | The link was removed; an administrator has to pick a campaign with `/dragonroll link`. |
|
|
||||||
|
|
||||||
Character portraits are read from Dragonroll's public upload folder, so the bot needs to be able to
|
|
||||||
reach the server Dragonroll runs on. Whoever hosts the bot finds its setup in `discord-bot/README.md`
|
|
||||||
in the source repository.
|
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
# Foundry VTT
|
|
||||||
|
|
||||||
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
|
||||||
characters and item directory arrive in the campaign, and what you change in Dragonroll goes back to
|
|
||||||
the world.
|
|
||||||
|
|
||||||
There are two separate parts, and you only need the first of them:
|
|
||||||
|
|
||||||
| Part | What it is |
|
|
||||||
| --- | --- |
|
|
||||||
| The **Dragonroll Foundry API** module | Installed in the world. Links it to a campaign and keeps its actors and items synced. Runs in the game client. |
|
|
||||||
| The optional **snapshot bridge** | A small process on the Foundry host that publishes a read-only snapshot of the world for Dragonroll to browse. Only for reading world data over the API. |
|
|
||||||
|
|
||||||
Character and item sync works without the bridge.
|
|
||||||
|
|
||||||
## Installing the module
|
|
||||||
|
|
||||||
Foundry VTT v12 to v14. Copy the `dragonroll-foundry` folder into
|
|
||||||
`{Foundry user data}/Data/modules/dragonroll-foundry/`, restart Foundry, and enable **Dragonroll
|
|
||||||
Foundry API** in the world's module settings.
|
|
||||||
|
|
||||||
The module's own settings hold two things you set: the **Dragonroll Endpoint** — the address of your
|
|
||||||
Dragonroll server, `https://dragonroll.aranroig.com` by default — and **Dragonroll Auto-sync**, which
|
|
||||||
is on.
|
|
||||||
|
|
||||||
## Linking a world
|
|
||||||
|
|
||||||
Open the world with a GM account. The module asks Dragonroll for a sign-up link and prints it in a
|
|
||||||
notification: open it, sign in, and pick the campaign this world belongs to. **Dragonroll Pairing
|
|
||||||
Status** in the module settings always says where things stand — waiting for a link, connected to a
|
|
||||||
named campaign, or why a link could not be used.
|
|
||||||
|
|
||||||
Worth knowing:
|
|
||||||
|
|
||||||
- The link expires after ten minutes and works once. If it goes unused, reload the world to get a new
|
|
||||||
one.
|
|
||||||
- A world links to one campaign, and a campaign to one Foundry world: linking a second world replaces
|
|
||||||
the first.
|
|
||||||
- The link, the sync token it hands back and the pairing status are all **client** settings: the
|
|
||||||
browser that completed the link is the one that syncs. Another browser on the same world reads as not
|
|
||||||
paired until it links too.
|
|
||||||
- **Dragonroll Pairing Status** is written by the module. It is not a field to fill in.
|
|
||||||
- The campaign shows the linked world's title and system under **Settings → Integrations**, where
|
|
||||||
**Unlink** ends the pairing.
|
|
||||||
|
|
||||||
## What syncs
|
|
||||||
|
|
||||||
| In Foundry | In the campaign |
|
|
||||||
| --- | --- |
|
|
||||||
| Character, NPC and creature actors | Actors with the same sheet: abilities, saving throws, skills, combat stats, proficiencies, tools, languages, traits, spells, carried gear with its icons, coins, portrait |
|
|
||||||
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
|
||||||
| The folders grouping that item directory | Item folders with the same names and nesting |
|
|
||||||
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
|
||||||
|
|
||||||
The item list is the world's item directory and nothing else. The gear a character carries is that
|
|
||||||
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
|
||||||
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
|
||||||
species are not gear and are not imported.
|
|
||||||
|
|
||||||
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
|
||||||
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
|
||||||
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
|
||||||
doubled, and renaming it in either place does not resurrect a duplicate.
|
|
||||||
|
|
||||||
Changes flow both ways as they happen, and Dragonroll's own edits are applied back in Foundry within a
|
|
||||||
few seconds. A **full** snapshot — the one taken when the world links, or forced from the actor
|
|
||||||
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
|
||||||
notice what is gone. Live edits never delete anything.
|
|
||||||
|
|
||||||
## Auto-sync, and sending one actor on purpose
|
|
||||||
|
|
||||||
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
|
||||||
delete are sent to the campaign, and both sides reconcile every few seconds. Turning it off stops all
|
|
||||||
of it — nothing is sent, and Dragonroll stops rewriting your Foundry documents, so the campaign keeps
|
|
||||||
whatever it already holds. Turn it back on and both sides reconcile again, including the edits queued
|
|
||||||
while it was off.
|
|
||||||
|
|
||||||
To send one character across right now, or to cross over while autosync is off, right-click the actor
|
|
||||||
(or several) in the Foundry actor directory and pick **Dragonroll: Force Sync**. Those actors, with the
|
|
||||||
gear inside them, are pushed immediately. It only upserts: it never prunes the campaign's other actors.
|
|
||||||
Actors Dragonroll does not import — anything that is not a character, NPC or creature — are refused with
|
|
||||||
a notification saying so.
|
|
||||||
|
|
||||||
## Foundry's icons in Dragonroll
|
|
||||||
|
|
||||||
With a world linked, Dragonroll's item icon browser can page through the icon library that world ships
|
|
||||||
with, one folder at a time. If it says the world has no address, set it under **Settings → Integrations
|
|
||||||
→ Foundry VTT URL** in the campaign.
|
|
||||||
|
|
||||||
## The optional snapshot bridge
|
|
||||||
|
|
||||||
The bridge is a small Node.js (18 or newer) process that runs beside Foundry. A GM client publishes the
|
|
||||||
world's actor and item snapshot to it, and Dragonroll reads that snapshot back through its own API, so
|
|
||||||
a server can ask what a world holds without touching the game. It is read-only, it keeps nothing across
|
|
||||||
restarts, and character sync does not depend on it.
|
|
||||||
|
|
||||||
It needs its own tokens — separate ones for publishing and for reading — and an origin allow-list for
|
|
||||||
the Foundry client:
|
|
||||||
|
|
||||||
| Variable | What it is |
|
|
||||||
| --- | --- |
|
|
||||||
| `DRAGONROLL_FOUNDRY_PUSH_TOKEN` | The token the Foundry client publishes with; the backend's `FOUNDRY_API_PUSH_TOKEN` must match it |
|
|
||||||
| `DRAGONROLL_FOUNDRY_READ_TOKEN` | The token reads with; the backend's `FOUNDRY_API_TOKEN` must match it |
|
|
||||||
| `DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS` | The browser origins allowed to publish, comma separated |
|
|
||||||
| `DRAGONROLL_FOUNDRY_HOST` / `DRAGONROLL_FOUNDRY_PORT` | Where the bridge listens; `0.0.0.0:8787` by default |
|
|
||||||
| `DRAGONROLL_FOUNDRY_DATA_PATH` | The Foundry Data directory, which lets the bridge list the core `icons/` library |
|
|
||||||
|
|
||||||
The backend points at it with `FOUNDRY_API_URL` (and `FOUNDRY_API_CLIENT_URL` when the Foundry clients
|
|
||||||
reach it under a different address than the backend does). Once it is set up, Dragonroll answers
|
|
||||||
`GET /api/foundry/world`, `/actors`, `/characters`, `/items`, one of each by id, an actor's embedded
|
|
||||||
items, and `/icons` — all for a signed-in Dragonroll user, and all read-only.
|
|
||||||
|
|
||||||
`dragonroll-foundry/README.md` in the source repository documents the bridge, its routes and its
|
|
||||||
heartbeat in full.
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
# Obsidian
|
|
||||||
|
|
||||||
The **Dragonroll Sync** plugin moves campaign notes between a Dragonroll campaign and an Obsidian
|
|
||||||
vault: import the campaign so you can read and write it with your own notes, and push the note you are
|
|
||||||
working on back to the campaign.
|
|
||||||
|
|
||||||
It is an explicit, you-ask-for-it workflow. Nothing happens in the background, and the plugin never
|
|
||||||
deletes a note.
|
|
||||||
|
|
||||||
## Installing
|
|
||||||
|
|
||||||
Copy `main.js` and `manifest.json` into your vault:
|
|
||||||
|
|
||||||
```text
|
|
||||||
<vault>/.obsidian/plugins/dragonroll-sync/
|
|
||||||
```
|
|
||||||
|
|
||||||
Then enable **Dragonroll Sync** under Settings → Community plugins. It is plain JavaScript, so there is
|
|
||||||
nothing to build, and it runs on desktop and mobile alike.
|
|
||||||
|
|
||||||
## Connecting
|
|
||||||
|
|
||||||
Under **Settings → Community plugins → Dragonroll Sync**:
|
|
||||||
|
|
||||||
1. Set the **Dragonroll API URL** — `https://dragonroll.aranroig.com/api` by default, or your own
|
|
||||||
server, such as `http://localhost:5000/api`.
|
|
||||||
2. **Sign in** with your Dragonroll username or email and your password. The password is used once to
|
|
||||||
sign in and is not saved; what the plugin keeps is the session token, in this vault, and it expires
|
|
||||||
after 48 hours like any other Dragonroll session.
|
|
||||||
3. Pick the **campaign**. Every import and push works against that campaign.
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
Both are in Obsidian's command palette:
|
|
||||||
|
|
||||||
| Command | What it does |
|
|
||||||
| --- | --- |
|
|
||||||
| **Import or refresh campaign notes** | Brings every note of the campaign into `Dragonroll/<Campaign>/`, folders and nesting included, and updates the ones already there. Imported notes keep their place in the campaign's folder tree. |
|
|
||||||
| **Push active note to Dragonroll** | Sends the note you are in to the campaign: a new root note if it is not linked yet, or an update of the note it is linked to. |
|
|
||||||
|
|
||||||
## How a note knows where it belongs
|
|
||||||
|
|
||||||
An imported note carries three properties in its frontmatter:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
dragonrollId: 665f1c…
|
|
||||||
dragonrollCampaign: 665f0a…
|
|
||||||
dragonrollTitle: The Salt Gull
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
They are what ties the file to its note in the campaign: they survive renames, and they are stripped
|
|
||||||
from the markdown the plugin sends back, so they never show up in Dragonroll. Pushing a brand new local
|
|
||||||
note adds them too, which is how the next push updates the same note instead of creating a copy.
|
|
||||||
|
|
||||||
Renaming the note's title in Dragonroll renames the imported file on the next import; renaming the file
|
|
||||||
in Obsidian renames the note in Dragonroll on the next push.
|
|
||||||
|
|
||||||
## Your edits are not overwritten
|
|
||||||
|
|
||||||
The plugin remembers how a note looked the last time it was imported or pushed, and uses that as the
|
|
||||||
baseline:
|
|
||||||
|
|
||||||
| Since the last sync | What the import does |
|
|
||||||
| --- | --- |
|
|
||||||
| Only the campaign's copy changed | The local file is updated |
|
|
||||||
| Only your local file changed | Your file is kept as it is, and reported for you to look at |
|
|
||||||
| Both changed | Your file is kept as it is, and reported for you to look at |
|
|
||||||
| Neither changed | Nothing is touched |
|
|
||||||
|
|
||||||
So a note you were rewriting in Obsidian is never quietly replaced: the plugin leaves it alone and tells
|
|
||||||
you it is waiting. Pushing is the deliberate direction — it writes the active note's current title and
|
|
||||||
content into Dragonroll.
|
|
||||||
|
|
||||||
A note that is linked to a different campaign cannot be pushed while another campaign is selected:
|
|
||||||
switch the campaign in the plugin settings first.
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
<script setup>
|
|
||||||
// L'aplicació de finestres no té rutes pròpies: qualsevol adreça que no sigui la
|
|
||||||
// documentació l'obre, i /link/authorize se n'encarrega dins d'AppShell.
|
|
||||||
import AppShell from '~/components/views/AppShell.vue';
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<AppShell></AppShell>
|
|
||||||
</template>
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
<script setup>
|
|
||||||
// `/docs/<slug>`, amb el slug del fitxer de markdown (mira ~/services/Docs.js).
|
|
||||||
import DocsView from '~/components/views/DocsView.vue';
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DocsView></DocsView>
|
|
||||||
</template>
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
<script setup>
|
|
||||||
import DocsView from '~/components/views/DocsView.vue';
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<DocsView></DocsView>
|
|
||||||
</template>
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
<script setup>
|
|
||||||
import AppShell from '~/components/views/AppShell.vue';
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<AppShell></AppShell>
|
|
||||||
</template>
|
|
||||||
@@ -2,38 +2,11 @@ import { ref } from 'vue';
|
|||||||
|
|
||||||
const ShowContent = ref(false);
|
const ShowContent = ref(false);
|
||||||
|
|
||||||
// What the campaign workspace shows where the notes live: the open notes, or the map the
|
|
||||||
// sidebar anchored on the note container. 'notes' | 'map'
|
|
||||||
const ActivePane = ref('notes');
|
|
||||||
|
|
||||||
// The map anchored on the note container (a campaign entry of the sidebar's maps section).
|
|
||||||
const AnchoredMap = ref(null);
|
|
||||||
|
|
||||||
function SetShowContent(value) {
|
function SetShowContent(value) {
|
||||||
ShowContent.value = value;
|
ShowContent.value = value;
|
||||||
}
|
}
|
||||||
|
|
||||||
function SetActivePane(value) {
|
|
||||||
ActivePane.value = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Anchoring shows the map where the open notes are; they stay open and come back on 'notes'.
|
|
||||||
function AnchorMap(map) {
|
|
||||||
AnchoredMap.value = map ?? null;
|
|
||||||
ActivePane.value = AnchoredMap.value ? 'map' : 'notes';
|
|
||||||
}
|
|
||||||
|
|
||||||
function ClearAnchoredMap() {
|
|
||||||
AnchoredMap.value = null;
|
|
||||||
if (ActivePane.value === 'map') ActivePane.value = 'notes';
|
|
||||||
}
|
|
||||||
|
|
||||||
export {
|
export {
|
||||||
ShowContent,
|
ShowContent,
|
||||||
SetShowContent,
|
SetShowContent
|
||||||
ActivePane,
|
}
|
||||||
AnchoredMap,
|
|
||||||
SetActivePane,
|
|
||||||
AnchorMap,
|
|
||||||
ClearAnchoredMap
|
|
||||||
}
|
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
import { Marked } from "marked";
|
|
||||||
import { CreateHeadingSlugger, HeadingsFromMarkdown, TitleFromMarkdown } from "./DocsMarkdown";
|
|
||||||
|
|
||||||
/*
|
|
||||||
The documentation served at /docs is markdown files under app/content/docs, so writing a page means
|
|
||||||
adding a file. The layout of a page's path says everything the sidebar needs:
|
|
||||||
|
|
||||||
app/content/docs/<group>/<NN>-<page>.md
|
|
||||||
|
|
||||||
The folder is the sidebar group and its own number orders the groups, the number in front of the file
|
|
||||||
orders the pages inside its group, and the rest of the file name is the page's slug (`02-discord.md`
|
|
||||||
is `/docs/discord`). A page's title is its first heading, and the first page of the first group is
|
|
||||||
served at `/docs` itself.
|
|
||||||
|
|
||||||
A group's label is looked up under `docs.groups.<folder>` in the locale files of
|
|
||||||
`i18n/locales/en/docs.json` and its siblings, so a new group needs that label in every locale.
|
|
||||||
*/
|
|
||||||
const markdownFiles = import.meta.glob("../content/docs/*/*.md", { query: "?raw", eager: true, import: "default" });
|
|
||||||
|
|
||||||
const Numbered = /^(\d+)-/;
|
|
||||||
const WithoutNumber = (name) => name.replace(Numbered, "");
|
|
||||||
// A name without a number in front sorts after every numbered one in its folder.
|
|
||||||
const OrderOf = (name) => {
|
|
||||||
const numbered = Numbered.exec(name);
|
|
||||||
return numbered ? Number(numbered[1]) : Number.MAX_SAFE_INTEGER;
|
|
||||||
};
|
|
||||||
|
|
||||||
const pages = Object.entries(markdownFiles)
|
|
||||||
.map(([file, source]) => {
|
|
||||||
const [folder, filename] = file.split("/").slice(-2);
|
|
||||||
const markdown = String(source ?? "");
|
|
||||||
|
|
||||||
return {
|
|
||||||
group: WithoutNumber(folder),
|
|
||||||
groupOrder: OrderOf(folder),
|
|
||||||
slug: WithoutNumber(filename).replace(/\.md$/, ""),
|
|
||||||
order: OrderOf(filename),
|
|
||||||
title: TitleFromMarkdown(markdown),
|
|
||||||
headings: HeadingsFromMarkdown(markdown),
|
|
||||||
markdown,
|
|
||||||
};
|
|
||||||
})
|
|
||||||
.sort((left, right) =>
|
|
||||||
left.groupOrder - right.groupOrder || left.order - right.order || left.slug.localeCompare(right.slug)
|
|
||||||
);
|
|
||||||
|
|
||||||
// `/docs` is the first page of the documentation, the rest hang under it by their slug.
|
|
||||||
function GetDocsHref(slug) {
|
|
||||||
return pages.length && slug === pages[0].slug ? "/docs" : `/docs/${slug}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
function GetDocsFirstSlug() {
|
|
||||||
return pages.length ? pages[0].slug : "";
|
|
||||||
}
|
|
||||||
|
|
||||||
// The sidebar: one entry per group folder, in reading order, holding its pages.
|
|
||||||
function GetDocsNav() {
|
|
||||||
const nav = [];
|
|
||||||
|
|
||||||
for (const page of pages) {
|
|
||||||
let group = nav.find((entry) => entry.key === page.group);
|
|
||||||
if (!group) {
|
|
||||||
group = { key: page.group, pages: [] };
|
|
||||||
nav.push(group);
|
|
||||||
}
|
|
||||||
group.pages.push({ slug: page.slug, title: page.title, href: GetDocsHref(page.slug) });
|
|
||||||
}
|
|
||||||
|
|
||||||
return nav;
|
|
||||||
}
|
|
||||||
|
|
||||||
const marked = new Marked();
|
|
||||||
|
|
||||||
// Every heading gets the anchor the sidebar and the "on this page" list link to. The slugger is
|
|
||||||
// replaced at the start of a parse so each page numbers its repeated headings on its own: marked
|
|
||||||
// parses one document at a time and does it synchronously, so no other parse can cut in.
|
|
||||||
let slugHeadings = CreateHeadingSlugger();
|
|
||||||
|
|
||||||
marked.use({
|
|
||||||
renderer: {
|
|
||||||
heading({ tokens, depth }) {
|
|
||||||
const content = this.parser.parseInline(tokens);
|
|
||||||
return `<h${depth} id="${slugHeadings(content)}">${content}</h${depth}>`;
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
function RenderDocsMarkdown(markdown) {
|
|
||||||
slugHeadings = CreateHeadingSlugger();
|
|
||||||
return String(marked.parse(markdown || ""));
|
|
||||||
}
|
|
||||||
|
|
||||||
// What the /docs page shows: a rendered page with the headings it holds and whichever pages come
|
|
||||||
// before and after it, or null when nothing is published under that slug.
|
|
||||||
function GetDocsPage(slug) {
|
|
||||||
const index = pages.findIndex((page) => page.slug === slug);
|
|
||||||
if (index === -1) return null;
|
|
||||||
|
|
||||||
const page = pages[index];
|
|
||||||
const neighbours = (page) => (page ? { slug: page.slug, title: page.title, href: GetDocsHref(page.slug) } : null);
|
|
||||||
|
|
||||||
return {
|
|
||||||
slug: page.slug,
|
|
||||||
group: page.group,
|
|
||||||
title: page.title,
|
|
||||||
// The page's own h1 is in the body already; the list is for its sections.
|
|
||||||
headings: page.headings.filter((heading) => heading.depth > 1 && heading.depth <= 3),
|
|
||||||
html: RenderDocsMarkdown(page.markdown),
|
|
||||||
previous: neighbours(pages[index - 1]),
|
|
||||||
next: neighbours(pages[index + 1]),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export { GetDocsFirstSlug, GetDocsHref, GetDocsNav, GetDocsPage, RenderDocsMarkdown };
|
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
/*
|
|
||||||
String helpers for the documentation under /docs: the words a heading shows, the anchor it gets, and
|
|
||||||
the headings the sidebar lists. They import nothing at all, not even marked, because the repository
|
|
||||||
root installs no dependencies and `tests/docs.test.js` loads this file straight from source.
|
|
||||||
*/
|
|
||||||
|
|
||||||
// What marked escapes, back to the character it stands for: an anchor has to be the same whether it
|
|
||||||
// was written as `'` or arrived as `'`.
|
|
||||||
const Entities = {
|
|
||||||
amp: "&",
|
|
||||||
lt: "<",
|
|
||||||
gt: ">",
|
|
||||||
quot: '"',
|
|
||||||
apos: "'",
|
|
||||||
nbsp: " ",
|
|
||||||
"#39": "'",
|
|
||||||
"#x27": "'",
|
|
||||||
};
|
|
||||||
|
|
||||||
function DecodeEntities(value) {
|
|
||||||
return value.replace(/&(#?[a-z0-9]+);/gi, (entity, body) => (Entities[body.toLowerCase()] ?? ""));
|
|
||||||
}
|
|
||||||
|
|
||||||
// A heading's anchor is built from its markdown source when the sidebar is built, and from the HTML
|
|
||||||
// marked has rendered when the page is. This drops everything the two forms disagree on — the tags
|
|
||||||
// marked adds, the entities it escapes, and the characters markdown uses for emphasis and links — so
|
|
||||||
// both keep the same words and land on the same anchor.
|
|
||||||
function HeadingText(value) {
|
|
||||||
return DecodeEntities(
|
|
||||||
String(value ?? "")
|
|
||||||
.replace(/<[^>]*>/g, "") // <code>, <em>, <a> … around the heading's words
|
|
||||||
.replace(/!?\[([^\]]*)\]\([^)]*\)/g, "$1") // a link keeps the label it shows, not its target
|
|
||||||
.replace(/[*_`~]/g, "") // emphasis
|
|
||||||
).trim();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Lower case letters, numbers and dashes: what a url fragment and a query selector both accept.
|
|
||||||
function Slugify(value) {
|
|
||||||
return HeadingText(value)
|
|
||||||
.toLowerCase()
|
|
||||||
.replace(/[^a-z0-9]+/g, "-")
|
|
||||||
.replace(/^-+|-+$/g, "");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Two headings with the same words cannot share an anchor: the second becomes `words-1`, the third
|
|
||||||
// `words-2`. The sidebar and the renderer both walk a page's headings in document order, so the
|
|
||||||
// numbers they hand out are the same.
|
|
||||||
function CreateHeadingSlugger() {
|
|
||||||
const seen = new Map();
|
|
||||||
|
|
||||||
return (value) => {
|
|
||||||
const base = Slugify(value) || "section";
|
|
||||||
const times = seen.get(base) || 0;
|
|
||||||
seen.set(base, times + 1);
|
|
||||||
return times === 0 ? base : `${base}-${times}`;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// The headings of a markdown document, in order, each with the anchor its renderer will give it:
|
|
||||||
// `{ depth: 2, text: "Link a world", slug: "link-a-world" }`. Lines inside a fenced code block are
|
|
||||||
// skipped — a `# comment` there is shell, not a heading.
|
|
||||||
function HeadingsFromMarkdown(source) {
|
|
||||||
const slug = CreateHeadingSlugger();
|
|
||||||
const headings = [];
|
|
||||||
let inFence = false;
|
|
||||||
|
|
||||||
for (const line of String(source ?? "").split(/\r?\n/)) {
|
|
||||||
if (/^ {0,3}(```|~~~)/.test(line)) {
|
|
||||||
inFence = !inFence;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (inFence) continue;
|
|
||||||
|
|
||||||
const heading = /^ {0,3}(#{1,6})\s+(.*?)\s*#*\s*$/.exec(line);
|
|
||||||
if (!heading) continue;
|
|
||||||
|
|
||||||
const text = HeadingText(heading[2]);
|
|
||||||
headings.push({ depth: heading[1].length, text, slug: slug(text) });
|
|
||||||
}
|
|
||||||
|
|
||||||
return headings;
|
|
||||||
}
|
|
||||||
|
|
||||||
// A documentation page's title is its first heading.
|
|
||||||
function TitleFromMarkdown(source) {
|
|
||||||
const [first] = HeadingsFromMarkdown(source);
|
|
||||||
return first ? first.text : "";
|
|
||||||
}
|
|
||||||
|
|
||||||
export { CreateHeadingSlugger, HeadingsFromMarkdown, HeadingText, Slugify, TitleFromMarkdown };
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user